Merge pull request #72 from commontk/launcherlib-add-pathsEnvVars

launcherlib: Add method "pathsEnvVars()"

Author: jcfr

Base/ctkAppLauncher.cpp

@@ -431,17 +431,10 @@ void ctkAppLauncherPrivate::buildEnvironment(QProcessEnvironment &env)
     }
 
   // Path environment variables
-  QHash<QString, QStringList> envPathsVars = q->additionalPathsVars();
-  // Add LibraryPaths and Paths to map
-#ifdef Q_OS_WIN32
-  envPathsVars["PATH"] = (q->paths() + q->libraryPaths());
-#else
-  envPathsVars[q->libraryPathVariableName()] = q->libraryPaths();
-  envPathsVars["PATH"] = q->paths();
-#endif
-  foreach(const QString& key, envPathsVars.keys())
+  QHash<QString, QStringList> pathsEnvVars = q->pathsEnvVars();
+  foreach(const QString& key, pathsEnvVars.keys())
     {
-    QString value = envPathsVars[key].join(this->PathSep);
+    QString value = pathsEnvVars[key].join(this->PathSep);
     this->reportInfo(QString("Setting env. variable [%1]:%2").arg(key, value));
     if (env.contains(key))
       {

Base/ctkAppLauncherSettings.cpp

@@ -394,6 +394,19 @@ QHash<QString, QString> ctkAppLauncherSettings::envVars(bool expand /* = true */
   return expand ? d->MapOfExpandedEnvVars : d->MapOfEnvVars;
 }
 
+// --------------------------------------------------------------------------
+QHash<QString, QStringList> ctkAppLauncherSettings::pathsEnvVars(bool expand /* = true */) const
+{
+  QHash<QString, QStringList> newVars = this->additionalPathsVars(expand);
+#ifdef Q_OS_WIN32
+  newVars["PATH"] = (this->paths(expand) + this->libraryPaths(expand));
+#else
+  newVars[this->libraryPathVariableName()] = this->libraryPaths(expand);
+  newVars["PATH"] = this->paths(expand);
+#endif
+  return newVars;
+}
+
 // --------------------------------------------------------------------------
 QStringList ctkAppLauncherSettings::additionalPaths(const QString& variableName, bool expand /* = true */) const
 {

Base/ctkAppLauncherSettings.h

@@ -118,6 +118,11 @@ class ctkAppLauncherSettingsPrivate;
 /// appLauncherSettings.readSettings("/path/to/AwesomeAppLauncherSetting.ini");
 ///
 /// // Get values (read from both the main settings file and the additional one).
+/// qDebug() << appLauncherSettings.pathsEnvVars().value("PATH");
+/// qDebug() << appLauncherSettings.pathsEnvVars().value("LD_LIBRARY_PATH");
+/// qDebug() << appLauncherSettings.pathsEnvVars().value("PYTHONPATH");
+/// qDebug() << appLauncherSettings.envVars().value("FOO");
+/// // or
 /// qDebug() << appLauncherSettings.paths();
 /// qDebug() << appLauncherSettings.libraryPaths();
 /// qDebug() << appLauncherSettings.additionalPathsVars().value("PYTHONPATH");
@@ -165,6 +170,32 @@ class ctkAppLauncherSettings : public QObject
   /// \sa envVar(const QString& variableName, bool expand)
   QHash<QString, QString> envVars(bool expand = true) const;
 
+  /// \brief Get dictionnary of all list of paths.
+  ///
+  /// These include list of paths associated with:
+  ///
+  /// * \c General/additionalPathVariables group (see additionalPathsVars()).
+  ///
+  /// * \c LibraryPaths group (see libraryPaths()).
+  ///
+  /// * \c Paths group (see paths()).
+  ///
+  /// Depending on the platform, list associated with the \c LibraryPaths and \c Paths
+  /// groups are mapped with different environment variable names:
+  ///
+  /// Variable name         | Linux           | MacOSX          | Windows
+  /// ----------------------|-----------------|-----------------|--------------------------|
+  /// `LD_LIBRARY_PATH`     | libraryPaths()  | NA              | NA                       |
+  /// `DYLD_LIBRARY_PATH`   | NA              | libraryPaths()  | NA                       |
+  /// `PATH`                | paths()         | paths()         | paths() + libraryPaths() |
+  ///
+  /// \sa additionalPathsVars(bool expand)
+  /// \sa libraryPaths(bool expand)
+  /// \sa paths(bool expand)
+  /// \sa libraryPathVariableName()
+  ///
+  QHash<QString, QStringList> pathsEnvVars(bool expand = true) const;
+
   /// \brief Get paths associated with \a variableName.
   ///
   /// The returned list corresponds to the path list identified by one of