Merge pull request #75 from commontk/expand-placeholders

Expand placeholders

Author: jcfr

Base/ctkAppLauncherSettings.cpp

@@ -161,17 +161,9 @@ void ctkAppLauncherSettingsPrivate::readPathSettings(QSettings& settings)
 // --------------------------------------------------------------------------
 QString ctkAppLauncherSettingsPrivate::expandValue(const QString& value) const
 {
-  QHash<QString, QString> mapOfEnvVars = this->MapOfExpandedEnvVars;
-  QHash<QString, QString> keyValueMap;
-  keyValueMap["<APPLAUNCHER_DIR>"] = this->LauncherDir;
-  keyValueMap["<APPLAUNCHER_NAME>"] = this->LauncherName;
-  keyValueMap["<PATHSEP>"] = this->PathSep;
+  QString updatedValue = this->expandPlaceHolders(value);
 
-  QString updatedValue = value;
-  foreach(const QString& key, keyValueMap.keys())
-    {
-    updatedValue.replace(key, keyValueMap.value(key), Qt::CaseInsensitive);
-    }
+  QHash<QString, QString> mapOfEnvVars = this->MapOfExpandedEnvVars;
 
   // Consider environment expression
   QRegExp regex("\\<env\\:([a-zA-Z0-9\\-\\_]+)\\>");
@@ -195,6 +187,22 @@ QString ctkAppLauncherSettingsPrivate::expandValue(const QString& value) const
   return updatedValue;
 }
 
+// --------------------------------------------------------------------------
+QString ctkAppLauncherSettingsPrivate::expandPlaceHolders(const QString& value) const
+{
+  QHash<QString, QString> keyValueMap;
+  keyValueMap["<APPLAUNCHER_DIR>"] = this->LauncherDir;
+  keyValueMap["<APPLAUNCHER_NAME>"] = this->LauncherName;
+  keyValueMap["<PATHSEP>"] = this->PathSep;
+
+  QString updatedValue = value;
+  foreach(const QString& key, keyValueMap.keys())
+    {
+    updatedValue.replace(key, keyValueMap.value(key), Qt::CaseInsensitive);
+    }
+  return updatedValue;
+}
+
 // --------------------------------------------------------------------------
 void ctkAppLauncherSettingsPrivate::expandEnvVars()
 {
@@ -235,7 +243,7 @@ void ctkAppLauncherSettingsPrivate::expandEnvVars()
         }
       previousPos = pos;
       }
-    expanded[key] = value;
+    expanded[key] = this->expandPlaceHolders(value);
     }
   this->MapOfExpandedEnvVars = expanded;
 }

Base/ctkAppLauncherSettings_p.h

@@ -36,15 +36,20 @@ class ctkAppLauncherSettingsPrivate : public QObject
     };
 
   /// \brief Expand setting \a value
-  /// The following string will be updated:
+  ///
+  /// The following placeholder strings will be updated:
   /// <ul>
   ///  <li>&lt;APPLAUNCHER_DIR&gt; -> LauncherDir</li>
   ///  <li>&lt;APPLAUNCHER_NAME&gt; -> LauncherName</li>
   ///  <li>&lt;PATHSEP&gt; -> PathSep</li>
   ///  <li>&lt;env:VARNAME&gt; -> If any, expand to corresponding system environment variable</li>
   /// </ul>
+  ///
+  /// \sa expandPlaceHolders()
   QString expandValue(const QString& value) const;
 
+  QString expandPlaceHolders(const QString& value) const;
+
   void expandEnvVars();
   QHash<QString, QString> MapOfExpandedEnvVars;
 

Testing/Launcher/App4ConfigureLauncherTest-expected-buildtree-settings.cmake.in

@@ -7,6 +7,7 @@ set(CTKAPPLAUNCHER_PATHS "1\\path=<APPLAUNCHER_DIR>/dog
 2\\path=<APPLAUNCHER_DIR>/cat
 size=2")
 set(CTKAPPLAUNCHER_ENVVARS "BAR=NONE
+PLACEHOLDER=build-<APPLAUNCHER_DIR>-<APPLAUNCHER_NAME>
 ")
 set(CTKAPPLAUNCHER_ADDITIONAL_PATH_ENVVARS "PYTHONPATH,QT_PLUGIN_PATH")
 set(CTKAPPLAUNCHER_ADDITIONAL_PATHS "
@@ -18,4 +19,3 @@ size=1
 [QT_PLUGIN_PATH]
 1\\path=<APPLAUNCHER_DIR>/build/libexec/qt
 size=1")
-

Testing/Launcher/App4ConfigureLauncherTest-expected-installtree-settings.cmake.in

@@ -7,6 +7,7 @@ set(CTKAPPLAUNCHER_PATHS "1\\path=<APPLAUNCHER_DIR>/cow
 2\\path=<APPLAUNCHER_DIR>/pig
 size=2")
 set(CTKAPPLAUNCHER_ENVVARS "BAR=ASSOCIATION
+PLACEHOLDER=install-<APPLAUNCHER_DIR>-<APPLAUNCHER_NAME>
 ")
 set(CTKAPPLAUNCHER_ADDITIONAL_PATH_ENVVARS "PYTHONPATH,QT_PLUGIN_PATH")
 set(CTKAPPLAUNCHER_ADDITIONAL_PATHS "

Testing/Launcher/App4ConfigureLauncherTest/CMakeLists.txt

@@ -39,8 +39,8 @@ ctkAppLauncherConfigure(
   PATHS_INSTALLED "<APPLAUNCHER_DIR>/cow;<APPLAUNCHER_DIR>/pig"
   LIBRARY_PATHS_BUILD "<APPLAUNCHER_DIR>/build/lib"
   LIBRARY_PATHS_INSTALLED "<APPLAUNCHER_DIR>/lib"
-  ENVVARS_BUILD "BAR=NONE"
-  ENVVARS_INSTALLED "BAR=ASSOCIATION"
+  ENVVARS_BUILD "BAR=NONE" "PLACEHOLDER=build-<APPLAUNCHER_DIR>-<APPLAUNCHER_NAME>"
+  ENVVARS_INSTALLED "BAR=ASSOCIATION" "PLACEHOLDER=install-<APPLAUNCHER_DIR>-<APPLAUNCHER_NAME>"
   ADDITIONAL_PATH_ENVVARS_BUILD "PYTHONPATH;QT_PLUGIN_PATH"
   ADDITIONAL_PATH_ENVVARS_INSTALLED "PYTHONPATH;QT_PLUGIN_PATH"
   ADDITIONAL_PATH_ENVVARS_PREFIX TEST_

Testing/Launcher/App4ConfigureLauncherTestLauncherSettings.ini.expected.in

@@ -29,6 +29,7 @@ size=2
 
 [EnvironmentVariables]
 BAR=NONE
+PLACEHOLDER=build-<APPLAUNCHER_DIR>-<APPLAUNCHER_NAME>
 
 
 

Testing/Launcher/App4ConfigureLauncherTestLauncherSettingsToInstall.ini.expected.in

@@ -29,6 +29,7 @@ size=2
 
 [EnvironmentVariables]
 BAR=ASSOCIATION
+PLACEHOLDER=install-<APPLAUNCHER_DIR>-<APPLAUNCHER_NAME>
 
 
 

Testing/Launcher/ConfiguredAppLauncher-ConfigurationContents.cmake

@@ -9,7 +9,9 @@ function(compare_files ACTUAL EXPECTED)
   string(CONFIGURE "${expected}" expected @ONLY)
   string(STRIP "${expected}" expected)
   if(NOT "${actual}" STREQUAL "${expected}")
-    message(FATAL_ERROR "Content validation of '${ACTUAL}' failed:
+    message(FATAL_ERROR "Content validation failed:
+  ACTUAL: ${ACTUAL}
+EXPECTED: ${EXPECTED}
 
 --
 expected content:

Testing/LauncherLib/AppWithLauncherLib/launcher-settings.ini

@@ -14,7 +14,7 @@ organizationName=Kitware
 size=3
 
 [Paths]
-1\path=<APPLAUNCHER_DIR>/cow
+1\path=<APPLAUNCHER_DIR>/cow/<APPLAUNCHER_NAME>
 2\path=/path/to/pig-<env:BOTH>
 3\path=/path/to/<env:PET>
 size=3
@@ -23,6 +23,7 @@ size=3
 BAR=ASSOCIATION
 PET=dog
 BOTH=cat-and-<env:PET>
+PLACEHOLDER=<APPLAUNCHER_DIR>-<APPLAUNCHER_NAME>
 
 [PYTHONPATH]
 1\path=<APPLAUNCHER_DIR>/lib/python/site-packages

Testing/LauncherLib/AppWithLauncherLib/main.cpp

@@ -210,7 +210,7 @@ int checkReadSettingsWithoutExpand()
   CHECK_QSTRINGLIST(
         appLauncherSettings.paths(/* expand= */ false),
         QStringList()
-                << "<APPLAUNCHER_DIR>/cow"
+                << "<APPLAUNCHER_DIR>/cow/<APPLAUNCHER_NAME>"
                 << "/path/to/pig-<env:BOTH>"
                 << "/path/to/<env:PET>"
         );
@@ -238,6 +238,11 @@ int checkReadSettingsWithoutExpand()
         "cat-and-<env:PET>"
         );
 
+  CHECK_QSTRING(
+        appLauncherSettings.envVar("PLACEHOLDER", /* expand= */ false),
+        "<APPLAUNCHER_DIR>-<APPLAUNCHER_NAME>"
+        );
+
 #if defined(Q_OS_WIN32)
   CHECK_QSTRING(
         appLauncherSettings.envVar("PYTHONPATH", /* expand= */ false),
@@ -285,7 +290,7 @@ int checkReadSettingsWithoutExpand()
   CHECK_QSTRINGLIST(
         pathsEnvVars.value("PATH"),
         QStringList()
-                << "<APPLAUNCHER_DIR>/cow"
+                << "<APPLAUNCHER_DIR>/cow/<APPLAUNCHER_NAME>"
                 << "/path/to/pig-<env:BOTH>"
                 << "/path/to/<env:PET>"
                 << "/path/to/libA"
@@ -296,7 +301,7 @@ int checkReadSettingsWithoutExpand()
   CHECK_QSTRINGLIST(
         pathsEnvVars.value("PATH"),
         QStringList()
-                << "<APPLAUNCHER_DIR>/cow"
+                << "<APPLAUNCHER_DIR>/cow/<APPLAUNCHER_NAME>"
                 << "/path/to/pig-<env:BOTH>"
                 << "/path/to/<env:PET>"
         );
@@ -355,7 +360,7 @@ int checkReadSettingsWithExpand()
   CHECK_QSTRINGLIST(
         appLauncherSettings.paths(),
         QStringList()
-                << "/awesome/path/to/cow"
+                << "/awesome/path/to/cow/AwesomeApp"
                 << "/path/to/pig-cat-and-dog"
                 << "/path/to/dog"
         );
@@ -383,6 +388,11 @@ int checkReadSettingsWithExpand()
         "cat-and-dog"
         );
 
+  CHECK_QSTRING(
+        appLauncherSettings.envVar("PLACEHOLDER"),
+        "/awesome/path/to-AwesomeApp"
+        );
+
 #if defined(Q_OS_WIN32)
   CHECK_QSTRING(
         appLauncherSettings.envVar("PYTHONPATH"),
@@ -444,7 +454,7 @@ int checkReadSettingsWithExpand()
   CHECK_QSTRINGLIST(
         pathsEnvVars.value("PATH"),
         QStringList()
-                << "/awesome/path/to/cow"
+                << "/awesome/path/to/cow/AwesomeApp"
                 << "/path/to/pig-cat-and-dog"
                 << "/path/to/dog"
                 << "/path/to/libA"
@@ -455,7 +465,7 @@ int checkReadSettingsWithExpand()
   CHECK_QSTRINGLIST(
         pathsEnvVars.value("PATH"),
         QStringList()
-                << "/awesome/path/to/cow"
+                << "/awesome/path/to/cow/AwesomeApp"
                 << "/path/to/pig-cat-and-dog"
                 << "/path/to/dog"
         );
@@ -563,7 +573,7 @@ int checkReadAdditionalSettingsWithExpand()
                 << "/awesome/path/to/fawn"
                 << "/path/to/cat-and-dog"
                 << "/path/to/Klimt"
-                << "/awesome/path/to/cow"
+                << QString("/awesome/path/to/cow/%1").arg(appName)
                 << "/path/to/pig-cat-and-dog"
                 << "/path/to/dog"
         );