issue doxygen#9187 doxygen -x_noenv option to not expand environment variables

Adding the possibility to retain the environment variables (`$(...)`) in the doxyfile when looking for differences with the default settings.

Author: albert-github

src/config.h

@@ -43,6 +43,7 @@
 //#endif
 //! @}
 
+enum class DoxyfileSettings { Full, Compressed, CompressedNoEnv };
 class TextStream;
 
 /** \brief Public function to deal with the configuration file. */
@@ -60,7 +61,7 @@ namespace Config
   /*! Writes a the differences between the current configuration and the
    *  template configuration to stream \a t.
    */
-  void compareDoxyfile(TextStream &t);
+  void compareDoxyfile(TextStream &t, DoxyfileSettings diffList);
 
   /*! Writes a the used settings of the current configuration as XML format
    *  to stream \a t.
@@ -76,10 +77,10 @@ namespace Config
   /*! Post processed the parsed data. Replaces raw string values by the actual values.
    *  and replaces environment variables.
    *  \param clearHeaderAndFooter set to TRUE when writing header and footer templates.
-   *  \param compare signals if we in Doxyfile compare (`-x`) mode are or not. Influences
-   *  setting of the default value.
+   *  \param compare signals if we in Doxyfile compare (`-x` or `-x_noenv`) mode are or not.
+   *   Influences setting of the default value and replacement of environment variables.
    */
-  void postProcess(bool clearHeaderAndFooter, bool compare = FALSE);
+  void postProcess(bool clearHeaderAndFooter, DoxyfileSettings compare = DoxyfileSettings::Full);
 
   /*! Check the validity of the parsed options and correct or warn the user where needed.
    * \param quiet setting for the QUIET option (can have been overruled by means of a command line option)

src/configimpl.l

@@ -2063,9 +2063,9 @@ void Config::writeTemplate(TextStream &t,bool shortList,bool update)
   ConfigImpl::instance()->writeTemplate(t,shortList,update);
 }
 
-void Config::compareDoxyfile(TextStream &t)
+void Config::compareDoxyfile(TextStream &t,DoxyfileSettings diffList)
 {
-  postProcess(FALSE, TRUE);
+  postProcess(FALSE, diffList);
   ConfigImpl::instance()->compareDoxyfile(t);
 }
 
@@ -2087,10 +2087,10 @@ bool Config::parse(const QCString &fileName,bool update)
   return parseRes;
 }
 
-void Config::postProcess(bool clearHeaderAndFooter, bool compare)
+void Config::postProcess(bool clearHeaderAndFooter, DoxyfileSettings diffList)
 {
-  ConfigImpl::instance()->substituteEnvironmentVars();
-  if (!compare)ConfigImpl::instance()->emptyValueToDefault();
+  if (diffList != DoxyfileSettings::CompressedNoEnv) ConfigImpl::instance()->substituteEnvironmentVars();
+  if (diffList == DoxyfileSettings::Full)ConfigImpl::instance()->emptyValueToDefault();
   ConfigImpl::instance()->convertStrToVal();
 
   // avoid bootstrapping issues when the g_config file already

src/doxygen.cpp

@@ -9627,14 +9627,14 @@ static void generateConfigFile(const QCString &configFile,bool shortList,
   }
 }
 
-static void compareDoxyfile()
+static void compareDoxyfile(DoxyfileSettings diffList)
 {
   std::ofstream f;
   bool fileOpened=openOutputFile("-",f);
   if (fileOpened)
   {
     TextStream t(&f);
-    Config::compareDoxyfile(t);
+    Config::compareDoxyfile(t,diffList);
   }
   else
   {
@@ -10640,6 +10640,9 @@ static void usage(const QCString &name,const QCString &versionString)
   msg("    If - is used for extensionsFile doxygen will write to standard output.\n\n");
   msg("7) Use doxygen to compare the used configuration file with the template configuration file\n");
   msg("    %s -x [configFile]\n\n",qPrint(name));
+  msg("   Use doxygen to compare the used configuration file with the template configuration file");
+  msg("   without replacing the environment variables\n");
+  msg("    %s -x_noenv [configFile]\n\n",qPrint(name));
   msg("8) Use doxygen to show a list of built-in emojis.\n");
   msg("    %s -f emoji outputFileName\n\n",qPrint(name));
   msg("    If - is used for outputFileName doxygen will write to standard output.\n\n");
@@ -10823,7 +10826,7 @@ void readConfiguration(int argc, char **argv)
   QCString listName;
   bool genConfig=FALSE;
   bool shortList=FALSE;
-  bool diffList=FALSE;
+  DoxyfileSettings diffList=DoxyfileSettings::Full;
   bool updateConfig=FALSE;
   int retVal;
   bool quiet = false;
@@ -10868,7 +10871,14 @@ void readConfiguration(int argc, char **argv)
         }
         break;
       case 'x':
-        diffList=TRUE;
+        if (!strcmp(argv[optInd]+1,"x_noenv")) diffList=DoxyfileSettings::CompressedNoEnv;
+        else if (!strcmp(argv[optInd]+1,"x")) diffList=DoxyfileSettings::Compressed;
+        else
+        {
+          err("option should be \"-x\" or \"-x_noenv\", found: \"%s\".\n",argv[optInd]);
+          cleanUpDoxygen();
+          exit(1);
+        }
         break;
       case 's':
         shortList=TRUE;
@@ -11187,10 +11197,10 @@ void readConfiguration(int argc, char **argv)
     exit(1);
   }
 
-  if (diffList)
+  if (diffList!=DoxyfileSettings::Full)
   {
     Config::updateObsolete();
-    compareDoxyfile();
+    compareDoxyfile(diffList);
     cleanUpDoxygen();
     exit(0);
   }