Moved configurations directory from build\bin\Debug\configurations to build\bin\resources\configurations. This change update the build directory structure to match the installation directory structure making the source code and install more alike.

Author: end2endzone

CMakeLists.txt

@@ -378,6 +378,7 @@ install(FILES ${CMAKE_SOURCE_DIR}/resources/installer/bin/register.bat
               DESTINATION ${SHELLANYTHING_INSTALL_BIN_DIR})
 
 # Resources
+install(DIRECTORY "${CMAKE_SOURCE_DIR}/resources/configurations" DESTINATION ${SHELLANYTHING_INSTALL_RESOURCE_DIR})
 install(DIRECTORY "${CMAKE_SOURCE_DIR}/resources/Windows Icon Tables" DESTINATION ${SHELLANYTHING_INSTALL_RESOURCE_DIR})
 install(FILES ${CMAKE_SOURCE_DIR}/resources/icons/shellanything.ico
               ${CMAKE_SOURCE_DIR}/resources/icons/0.1.0.ico

resources/configurations/shellanything.xml

@@ -36,51 +36,51 @@
 
         <menu name="CONTRIBUTING">
           <menu name="markdown">
-            <visibility exists="${application.directory}\..\CONTRIBUTING.md" />
+            <visibility exists="${application.install.directory}\CONTRIBUTING.md" />
             <icon fileextension="md" />
             <actions>
-              <open path="${application.directory}\..\CONTRIBUTING.md" />
+              <open path="${application.install.directory}\CONTRIBUTING.md" />
             </actions>
           </menu>
           <menu name="html">
-            <visibility exists="${application.directory}\..\CONTRIBUTING.html" />
+            <visibility exists="${application.install.directory}\CONTRIBUTING.html" />
             <icon fileextension="html" />
             <actions>
-              <open path="${application.directory}\..\CONTRIBUTING.html" />
+              <open path="${application.install.directory}\CONTRIBUTING.html" />
             </actions>
           </menu>
         </menu>
 
         <menu name="README">
           <menu name="markdown">
-            <visibility exists="${application.directory}\..\README.md" />
+            <visibility exists="${application.install.directory}\README.md" />
             <icon fileextension="md" />
             <actions>
-              <open path="${application.directory}\..\README.md" />
+              <open path="${application.install.directory}\README.md" />
             </actions>
           </menu>
           <menu name="html">
-            <visibility exists="${application.directory}\..\README.html" />
+            <visibility exists="${application.install.directory}\README.html" />
             <icon fileextension="html" />
             <actions>
-              <open path="${application.directory}\..\README.html" />
+              <open path="${application.install.directory}\README.html" />
             </actions>
           </menu>
         </menu>
 
         <menu name="UserManual">
           <menu name="markdown">
-            <visibility exists="${application.directory}\..\UserManual.md" />
+            <visibility exists="${application.install.directory}\UserManual.md" />
             <icon fileextension="md" />
             <actions>
-              <open path="${application.directory}\..\UserManual.md" />
+              <open path="${application.install.directory}\UserManual.md" />
             </actions>
           </menu>
           <menu name="html">
-            <visibility exists="${application.directory}\..\UserManual.html" />
+            <visibility exists="${application.install.directory}\UserManual.html" />
             <icon fileextension="html" />
             <actions>
-              <open path="${application.directory}\..\UserManual.html" />
+              <open path="${application.install.directory}\UserManual.html" />
             </actions>
           </menu>
         </menu>
@@ -136,45 +136,45 @@
         <menu name="Windows 10 Home">
           <menu name="shell32.dll">
             <actions>
-              <open path="${application.directory}\..\resources\Windows Icon Tables\Win 10 Home - shell32.dll icons.png" />
+              <open path="${application.install.directory}\resources\Windows Icon Tables\Win 10 Home - shell32.dll icons.png" />
             </actions>
           </menu>
           <menu name="ieframe.dll">
             <actions>
-              <open path="${application.directory}\..\resources\Windows Icon Tables\Win 10 Home - ieframe.dll icons.png" />
+              <open path="${application.install.directory}\resources\Windows Icon Tables\Win 10 Home - ieframe.dll icons.png" />
             </actions>
           </menu>
           <menu name="imageres.dll">
             <actions>
-              <open path="${application.directory}\..\resources\Windows Icon Tables\Win 10 Home - imageres.dll icons.png" />
+              <open path="${application.install.directory}\resources\Windows Icon Tables\Win 10 Home - imageres.dll icons.png" />
             </actions>
           </menu>
           <menu name="netshell.dll">
             <actions>
-              <open path="${application.directory}\..\resources\Windows Icon Tables\Win 10 Home - netshell.dll icons.png" />
+              <open path="${application.install.directory}\resources\Windows Icon Tables\Win 10 Home - netshell.dll icons.png" />
             </actions>
           </menu>
         </menu>
 
         <menu name="Windows 11 Pro">
           <menu name="shell32.dll">
             <actions>
-              <open path="${application.directory}\..\resources\Windows Icon Tables\Win 11 Pro - shell32.dll icons.png" />
+              <open path="${application.install.directory}\resources\Windows Icon Tables\Win 11 Pro - shell32.dll icons.png" />
             </actions>
           </menu>
           <menu name="ieframe.dll">
             <actions>
-              <open path="${application.directory}\..\resources\Windows Icon Tables\Win 11 Pro - ieframe.dll icons.png" />
+              <open path="${application.install.directory}\resources\Windows Icon Tables\Win 11 Pro - ieframe.dll icons.png" />
             </actions>
           </menu>
           <menu name="imageres.dll">
             <actions>
-              <open path="${application.directory}\..\resources\Windows Icon Tables\Win 11 Pro - imageres.dll icons.png" />
+              <open path="${application.install.directory}\resources\Windows Icon Tables\Win 11 Pro - imageres.dll icons.png" />
             </actions>
           </menu>
           <menu name="netshell.dll">
             <actions>
-              <open path="${application.directory}\..\resources\Windows Icon Tables\Win 11 Pro - netshell.dll icons.png" />
+              <open path="${application.install.directory}\resources\Windows Icon Tables\Win 11 Pro - netshell.dll icons.png" />
             </actions>
           </menu>
         </menu>
@@ -183,7 +183,7 @@
       <menu name="More configurations files...">
         <icon path="C:\Windows\system32\shell32.dll" index="69" />
         <actions>
-          <open path="${application.directory}\configurations" />
+          <open path="${application.directory}\resources\configurations" />
         </actions>
       </menu>
 

src/CMakeLists.txt

@@ -48,10 +48,6 @@ add_custom_target(src_dummy_target
                           "${CMAKE_CURRENT_SOURCE_DIR}/version.rc.in"
 )
 
-install(DIRECTORY ${CMAKE_SOURCE_DIR}/resources/configurations
-        DESTINATION ${SHELLANYTHING_INSTALL_BIN_DIR}
-)
-
 install(FILES ${LIBMAGIC_MGC_DIR}/magic.mgc
               ${LIBMAGIC_MGC_DIR}/file.exe
               ${ZLIB_INCLUDE_DIRS}/../bin/zlib.dll

src/core/App.cpp

@@ -233,6 +233,20 @@ namespace shellanything
     return config_dir;
   }
 
+  std::string App::GetBinDirectory()
+  {
+    const std::string module_path = GetCurrentModulePathUtf8();
+    const std::string bin_dir = ra::filesystem::GetParentPath(module_path);
+    return bin_dir;
+  }
+
+  std::string App::GetInstallDirectory()
+  {
+    const std::string bin_dir = GetBinDirectory();
+    const std::string install_dir = ra::filesystem::GetParentPath(bin_dir);
+    return install_dir;
+  }
+
   bool App::Start()
   {
     SetupGlobalProperties();
@@ -289,8 +303,7 @@ namespace shellanything
 
   void App::InstallDefaultConfigurations(const std::string& dest_dir)
   {
-    std::string app_path = GetCurrentModulePathUtf8();
-    std::string app_dir = ra::filesystem::GetParentPath(app_path);
+    const std::string install_dir = shellanything::App::GetInstallDirectory();
 
     static const char* default_files[] = {
       "default.xml",
@@ -304,7 +317,7 @@ namespace shellanything
     for (size_t i = 0; i < num_files; i++)
     {
       const char* filename = default_files[i];
-      std::string source_path = app_dir + "\\configurations\\" + filename;
+      std::string source_path = install_dir + "\\resources\\configurations\\" + filename;
       std::string target_path = dest_dir + "\\" + filename;
 
       SA_LOG(INFO) << "Installing configuration file: " << target_path;

src/core/App.h

@@ -215,6 +215,19 @@ namespace shellanything
     /// <returns>Returns true if the directory is valid for reading configurations. Returns false otherwise.</returns>
     bool IsValidConfigDirectory(const std::string& path);
 
+    /// <summary>
+    /// Get the application's bin directory. The bin directory contains all ShellAnything's executables and binaries.
+    /// </summary>
+    /// <returns>Returns the path of the bin directory.</returns>
+    static std::string GetBinDirectory();
+
+    /// <summary>
+    /// Get the application's installation directory. The installation directory is the root directory selected when the application was installed.
+    /// When running in debug mode or within a development environment, the installation directory is set to the parent directory of `${CMAKE_BIN_DIR}\build\bin\Debug`.
+    /// </summary>
+    /// <returns>Returns the path of the installation directory.</returns>
+    static std::string GetInstallDirectory();
+
     /// <summary>
     /// Initialize and start the application ready for usage.
     /// </summary>

src/core/CMakeLists.txt

@@ -114,7 +114,7 @@ source_group("Default Configuration Files"          FILES ${CONFIGURATION_DEFAUL
 # Copy default configuration files database to target dir
 add_custom_command( TARGET sa.core POST_BUILD
                     COMMAND ${CMAKE_COMMAND} -E copy_directory
-                    ${CMAKE_SOURCE_DIR}/resources/configurations $<TARGET_FILE_DIR:sa.core>/configurations
+                    ${CMAKE_SOURCE_DIR}/resources/configurations $<TARGET_FILE_DIR:sa.core>/../resources/configurations
                     COMMENT "Copying default configurations files database.")
 
 # Copy registration and unregistration scripts to target dir

src/core/PropertyManager.cpp

@@ -648,9 +648,8 @@ namespace shellanything
     shellanything::App& app = shellanything::App::GetInstance();
 
     //define global properties
-    std::string prop_core_module_path = GetCurrentModulePathUtf8();
-    std::string prop_application_directory = ra::filesystem::GetParentPath(prop_core_module_path);
-    std::string prop_install_directory = ra::filesystem::GetParentPath(prop_application_directory);
+    std::string prop_application_directory = app.GetBinDirectory();
+    std::string prop_install_directory = app.GetInstallDirectory();
     std::string prop_path_separator = ra::filesystem::GetPathSeparatorStr();
     std::string prop_line_separator = ra::environment::GetLineSeparator();
 

src/tests/TestConfigManager.cpp

@@ -23,6 +23,7 @@
  *********************************************************************************/
 
 #include "TestConfigManager.h"
+#include "App.h"
 #include "Workspace.h"
 #include "QuickLoader.h"
 #include "ConfigManager.h"
@@ -338,7 +339,9 @@ namespace shellanything
     {
       ConfigManager& mgr = ConfigManager::GetInstance();
 
-      const std::string path = "configurations/default.xml";
+      const std::string install_dir = shellanything::App::GetInstallDirectory();
+
+      const std::string path = install_dir + "/resources/configurations/default.xml";
       std::string error_message = ra::testing::GetTestQualifiedName(); //init error message to an unexpected string
       ConfigFile* config = ConfigFile::LoadFile(path, error_message);
 

src/tests/TestConfiguration.cpp

@@ -23,11 +23,13 @@
  *********************************************************************************/
 
 #include "TestConfiguration.h"
+#include "App.h"
 #include "Workspace.h"
 #include "ConfigManager.h"
 #include "ConfigFile.h"
 #include "Menu.h"
 #include "ActionExecute.h"
+#include "SaUtils.h"
 
 #include "rapidassist/filesystem_utf8.h"
 #include "rapidassist/testing.h"
@@ -94,17 +96,17 @@ namespace shellanything
     TEST_F(TestConfiguration, testIsValidConfigFile)
     {
       static const char* files[] = {
-        //default configuration files
-        "configurations\\default.xml",
-        "configurations\\Microsoft Office 2003.xml",
-        "configurations\\Microsoft Office 2007.xml",
-        "configurations\\Microsoft Office 2010.xml",
-        "configurations\\Microsoft Office 2013.xml",
-        "configurations\\Microsoft Office 2016.xml",
-        "configurations\\shellanything.xml",
-        "configurations\\WinDirStat.xml",
-
-        //test configuration files
+        //default configuration files (relative to bin directory)
+        "..\\resources\\configurations\\default.xml",
+        "..\\resources\\configurations\\Microsoft Office 2003.xml",
+        "..\\resources\\configurations\\Microsoft Office 2007.xml",
+        "..\\resources\\configurations\\Microsoft Office 2010.xml",
+        "..\\resources\\configurations\\Microsoft Office 2013.xml",
+        "..\\resources\\configurations\\Microsoft Office 2016.xml",
+        "..\\resources\\configurations\\shellanything.xml",
+        "..\\resources\\configurations\\WinDirStat.xml",
+
+        //test configuration files (relative to bin directory)
         "test_files\\samples.xml",
         "test_files\\TestConfigManager.testAssignCommandId.1.xml",
         "test_files\\TestConfigManager.testAssignCommandId.2.xml",
@@ -129,10 +131,13 @@ namespace shellanything
       };
       const size_t num_files = sizeof(files) / sizeof(files[0]);
 
+      const std::string bin_dir = shellanything::App::GetBinDirectory();
+
       //for each test files
       for (size_t i = 0; i < num_files; i++)
       {
-        const std::string path = files[i];
+        const std::string relative_path = files[i];
+        const std::string path = bin_dir + "\\" + relative_path;
         ASSERT_TRUE(ra::filesystem::FileExists(path.c_str())) << "File '" << path.c_str() << "' is not found.";
         ASSERT_TRUE(shellanything::ConfigFile::IsValidConfigFile(path)) << "The file '" << path.c_str() << "' is not a valid configuration file.";
       }
@@ -141,7 +146,8 @@ namespace shellanything
     TEST_F(TestConfiguration, testIsValidConfigFileUtf8)
     {
       static const std::string separator = ra::filesystem::GetPathSeparatorStr();
-      const std::string source_path = "configurations/default.xml";
+      const std::string install_dir = shellanything::App::GetInstallDirectory();
+      const std::string source_path = install_dir + "/resources/configurations/default.xml";
       std::string target_path = ra::filesystem::GetTemporaryDirectory() + separator + ra::testing::GetTestQualifiedName() + ".psi_\xCE\xA8_psi.xml";
 
       //copy default config to the new utf-8 path
@@ -153,7 +159,8 @@ namespace shellanything
     //--------------------------------------------------------------------------------------------------
     TEST_F(TestConfiguration, testLoadFile)
     {
-      const std::string path = "configurations/default.xml";
+      const std::string install_dir = shellanything::App::GetInstallDirectory();
+      const std::string path = install_dir + "/resources/configurations/default.xml";
       std::string error_message = ra::testing::GetTestQualifiedName(); //init error message to an unexpected string
       ConfigFile* config = ConfigFile::LoadFile(path, error_message);
 
@@ -168,8 +175,9 @@ namespace shellanything
     {
       //This test validates that Configuration::LoadFile() supports filename with utf-8 characters.
 
+      const std::string install_dir = shellanything::App::GetInstallDirectory();
       static const std::string separator = ra::filesystem::GetPathSeparatorStr();
-      const std::string source_path = "configurations/default.xml";
+      const std::string source_path = install_dir + "/resources/configurations/default.xml";
       std::string target_path = ra::filesystem::GetTemporaryDirectory() + separator + ra::testing::GetTestQualifiedName() + ".psi_\xCE\xA8_psi.xml";
 
       //copy default config to the new utf-8 path

src/tests/TestSelectionContext.cpp

@@ -23,8 +23,11 @@
  *********************************************************************************/
 
 #include "TestSelectionContext.h"
+#include "App.h"
 #include "SelectionContext.h"
 #include "PropertyManager.h"
+#include "SaUtils.h"
+
 #include "rapidassist/process.h"
 #include "rapidassist/filesystem.h"
 #include "rapidassist/testing.h"
@@ -525,11 +528,13 @@ namespace shellanything
     {
       PropertyManager& pmgr = PropertyManager::GetInstance();
 
+      const std::string install_dir = shellanything::App::GetInstallDirectory();
+
       SelectionContext context;
 #ifdef _WIN32
       {
         StringList elements;
-        elements.push_back(ra::process::GetCurrentProcessDir() + "\\configurations\\default.xml");
+        elements.push_back(install_dir + "\\resources\\configurations\\default.xml");
         context.SetElements(elements);
       }
 #else