Show git version information

The original version has as features:
- getting the git version number for usage in doxygen
- making the doxygen version number inclusion dependent on the VERSION file

The disadvantage of the chosen methodology was that an extra correction step was necessary, by defining getter methods to retrieve the values this correction can be hidden.
The information is coming from different sources:
- the VERSION file
- the git "repository and build system (when present)

Furthermore there are a couple of places where the version information is used (a.o. doxygen and doxywizard executable, though the doxygenwizard was only done "half hearted")

The handling of the VERSION file has been made in such a way that it is comparable with the generation of the git version changes.

For a better abstraction the version handling is all done in a separate directory.

14 files changed, 38 insertions, 74 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 9539228..f4e1231 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -1,10 +1,9 @@
 # vim:ts=4:sw=4:expandtab:autoindent:
 
-include(${CMAKE_SOURCE_DIR}/cmake/git_watcher.cmake)
-
 include_directories(
     ${CMAKE_SOURCE_DIR}/qtools
     ${CMAKE_SOURCE_DIR}/libmd5
+    ${CMAKE_SOURCE_DIR}/libversion
     ${CMAKE_SOURCE_DIR}/vhdlparser/
     ${CMAKE_SOURCE_DIR}/src
     ${CLANG_INCLUDEDIR}
@@ -32,14 +31,6 @@ CONTENT "#ifndef SETTINGS_H
 set_source_files_properties(${GENERATED_SRC}/settings.h PROPERTIES GENERATED 1)
 
 
-# generate version.cpp
-add_custom_command(
-    COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_SOURCE_DIR}/src/version.py ${VERSION} > ${GENERATED_SRC}/version.cpp
-    DEPENDS ${CMAKE_SOURCE_DIR}/VERSION ${CMAKE_SOURCE_DIR}/src/version.py
-    OUTPUT ${GENERATED_SRC}/version.cpp
-)
-set_source_files_properties(${GENERATED_SRC}/version.cpp PROPERTIES GENERATED 1)
-
 # configvalues.h
 add_custom_command(
     COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_SOURCE_DIR}/src/configgen.py -maph ${CMAKE_SOURCE_DIR}/src/config.xml > ${GENERATED_SRC}/configvalues.h
@@ -140,8 +131,6 @@ add_library(_doxygen STATIC
     ${GENERATED_SRC}/lang_cfg.h
     ${GENERATED_SRC}/settings.h
     ${GENERATED_SRC}/layout_default.xml.h
-    ${GENERATED_SRC}/version.cpp
-    ${POST_CONFIGURE_GIT_VERSION_FILE}
     ${GENERATED_SRC}/ce_parse.h
     ${GENERATED_SRC}/configvalues.h
     ${GENERATED_SRC}/resources.cpp
@@ -245,7 +234,6 @@ add_library(_doxygen STATIC
     docbookvisitor.cpp
     docbookgen.cpp
 )
-add_dependencies( _doxygen check_git_repository )
 
 add_executable(doxygen main.cpp)
 
@@ -274,6 +262,7 @@ target_link_libraries(doxygen
     doxycfg
     qtools
     md5
+    version
     vhdlparser
     ${SQLITE3_LIBRARIES}
     ${ICONV_LIBRARIES}
diff --git a/src/configimpl.l b/src/configimpl.l
index 321ca5c..f07509a 100644
--- a/src/configimpl.l
+++ b/src/configimpl.l
@@ -943,7 +943,7 @@ void ConfigImpl::writeTemplate(FTextStream &t,bool sl,bool upd)
   {
     t << takeStartComment() << endl; 
   }
-  t << "# Doxyfile " << versionString << endl << endl;
+  t << "# Doxyfile " << getVersion() << endl << endl;
   if (!sl)
   {
     t << convertToComment(m_header,"");
@@ -964,10 +964,10 @@ void ConfigImpl::writeTemplate(FTextStream &t,bool sl,bool upd)
 
 void ConfigImpl::compareDoxyfile(FTextStream &t)
 {
-  t << "# Difference with default Doxyfile " << versionString;
-  if (strlen(gitVersionString))
+  t << "# Difference with default Doxyfile " << getVersion();
+  if (strlen(getGitVersion()))
   {
-    t << " (" << gitVersionString << ")";
+    t << " (" << getGitVersion() << ")";
   }
   t << endl;
   QListIterator<ConfigOption> it = iterator();
diff --git a/src/context.cpp b/src/context.cpp
index 7b7c725..e14907f 100644
--- a/src/context.cpp
+++ b/src/context.cpp
@@ -374,7 +374,7 @@ class DoxygenContext::Private
   public:
     TemplateVariant version() const
     {
-      return versionString;
+      return getVersion();
     }
     TemplateVariant date() const
     {
diff --git a/src/doxygen.cpp b/src/doxygen.cpp
index aabb688..9c98d8c 100644
--- a/src/doxygen.cpp
+++ b/src/doxygen.cpp
@@ -9927,13 +9927,13 @@ static void devUsage()
 
 static void usage(const char *name)
 {
-  if (strlen(gitVersionString))
+  if (strlen(getGitVersion()))
   {
-    msg("Doxygen version %s (%s)\nCopyright Dimitri van Heesch 1997-2015\n\n",versionString,gitVersionString);
+    msg("Doxygen version %s (%s)\nCopyright Dimitri van Heesch 1997-2015\n\n",getVersion(),getGitVersion());
   }
   else
   {
-    msg("Doxygen version %s\nCopyright Dimitri van Heesch 1997-2015\n\n",versionString);
+    msg("Doxygen version %s\nCopyright Dimitri van Heesch 1997-2015\n\n",getVersion());
   }
   msg("You can use doxygen in a number of ways:\n\n");
   msg("1) Use doxygen to generate a template configuration file:\n");
@@ -9989,8 +9989,6 @@ void initDoxygen()
   setlocale(LC_CTYPE,"C"); // to get isspace(0xA0)==0, needed for UTF-8
   setlocale(LC_NUMERIC,"C");
 
-  correctGitVersion();
-
   portable_correct_path();
 
   Doxygen::runningTime.start();
@@ -10396,13 +10394,13 @@ void readConfiguration(int argc, char **argv)
         g_dumpSymbolMap = TRUE;
         break;
       case 'v':
-        if (strlen(gitVersionString))
+        if (strlen(getGitVersion()))
         {
-          msg("%s (%s)\n",versionString,gitVersionString);
+          msg("%s (%s)\n",getVersion(),getGitVersion());
         }
         else
         {
-          msg("%s\n",versionString);
+          msg("%s\n",getVersion());
         }
         cleanUpDoxygen();
         exit(0);
@@ -10415,13 +10413,13 @@ void readConfiguration(int argc, char **argv)
         }
         else if (qstrcmp(&argv[optind][2],"version")==0)
         {
-          if (strlen(gitVersionString))
+          if (strlen(getGitVersion()))
           {
-            msg("%s (%s)\n",versionString,gitVersionString);
+            msg("%s (%s)\n",getVersion(),getGitVersion());
           }
           else
           {
-            msg("%s\n",versionString);
+            msg("%s\n",getVersion());
           }
           cleanUpDoxygen();
           exit(0);
diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp
index d89bb49..cd45e5f 100644
--- a/src/htmlgen.cpp
+++ b/src/htmlgen.cpp
@@ -858,7 +858,7 @@ void HtmlGenerator::writeSearchData(const char *dir)
     {
       searchCss = mgr.getAsString("search.css");
     }
-    searchCss = substitute(replaceColorMarkers(searchCss),"$doxygenversion",versionString);
+    searchCss = substitute(replaceColorMarkers(searchCss),"$doxygenversion",getVersion());
     t << searchCss;
     Doxygen::indexList->addStyleSheetFile("search/search.css");
   }
@@ -867,20 +867,20 @@ void HtmlGenerator::writeSearchData(const char *dir)
 void HtmlGenerator::writeStyleSheetFile(QFile &file)
 {
   FTextStream t(&file);
-  t << replaceColorMarkers(substitute(ResourceMgr::instance().getAsString("doxygen.css"),"$doxygenversion",versionString));
+  t << replaceColorMarkers(substitute(ResourceMgr::instance().getAsString("doxygen.css"),"$doxygenversion",getVersion()));
 }
 
 void HtmlGenerator::writeHeaderFile(QFile &file, const char * /*cssname*/)
 {
   FTextStream t(&file);
-  t << "<!-- HTML header for doxygen " << versionString << "-->" << endl;
+  t << "<!-- HTML header for doxygen " << getVersion() << "-->" << endl;
   t << ResourceMgr::instance().getAsString("header.html");
 }
 
 void HtmlGenerator::writeFooterFile(QFile &file)
 {
   FTextStream t(&file);
-  t << "<!-- HTML footer for doxygen " << versionString << "-->" <<  endl;
+  t << "<!-- HTML footer for doxygen " << getVersion() << "-->" <<  endl;
   t << ResourceMgr::instance().getAsString("footer.html");
 }
 
@@ -905,7 +905,7 @@ void HtmlGenerator::startFile(const char *name,const char *,
   t << substituteHtmlKeywords(g_header,convertToHtml(filterTitle(title)),relPath);
 
   t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
-    << versionString << " -->" << endl;
+    << getVersion() << " -->" << endl;
   //static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
   static bool searchEngine = Config_getBool(SEARCHENGINE);
   if (searchEngine /*&& !generateTreeView*/)
@@ -970,7 +970,7 @@ QCString HtmlGenerator::writeLogoAsString(const char *path)
             "<img class=\"footer\" src=\"";
   result += path;
   result += "doxygen.png\" alt=\"doxygen\"/></a> ";
-  result += versionString;
+  result += getVersion();
   result += " ";
   return result;
 }
@@ -1023,7 +1023,7 @@ void HtmlGenerator::writeStyleInfo(int part)
       //t << "H1 { text-align: center; border-width: thin none thin none;" << endl;
       //t << "     border-style : double; border-color : blue; padding-left : 1em; padding-right : 1em }" << endl;
 
-      t << replaceColorMarkers(substitute(ResourceMgr::instance().getAsString("doxygen.css"),"$doxygenversion",versionString));
+      t << replaceColorMarkers(substitute(ResourceMgr::instance().getAsString("doxygen.css"),"$doxygenversion",getVersion()));
       endPlainFile();
       Doxygen::indexList->addStyleSheetFile("doxygen.css");
     }
@@ -2441,7 +2441,7 @@ void HtmlGenerator::writeSearchPage()
     t << substituteHtmlKeywords(g_header,"Search","");
 
     t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
-      << versionString << " -->" << endl;
+      << getVersion() << " -->" << endl;
     t << "<script type=\"text/javascript\">\n";
 		t << "/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */\n";
 		t << "var searchBox = new SearchBox(\"searchBox\", \""
@@ -2495,7 +2495,7 @@ void HtmlGenerator::writeExternalSearchPage()
     t << substituteHtmlKeywords(g_header,"Search","");
 
     t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
-      << versionString << " -->" << endl;
+      << getVersion() << " -->" << endl;
     t << "<script type=\"text/javascript\">\n";
 		t << "/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */\n";
 		t << "var searchBox = new SearchBox(\"searchBox\", \""
diff --git a/src/latexgen.cpp b/src/latexgen.cpp
index de20e15..36109fe 100644
--- a/src/latexgen.cpp
+++ b/src/latexgen.cpp
@@ -763,7 +763,7 @@ static void writeDefaultHeaderPart3(FTextStream &t)
 {
   // part 3
   // Finalize project number
-  t << " Doxygen " << versionString << "}\\\\\n";
+  t << " Doxygen " << getVersion() << "}\\\\\n";
   if (Config_getBool(LATEX_TIMESTAMP))
     t << "\\vspace*{0.5cm}\n"
          "{\\small " << dateToString(TRUE) << "}\\\\\n";
@@ -832,7 +832,7 @@ static void writeDefaultFooter(FTextStream &t)
 void LatexGenerator::writeHeaderFile(QFile &f)
 {
   FTextStream t(&f);
-  t << "% Latex header for doxygen " << versionString << endl;
+  t << "% Latex header for doxygen " << getVersion() << endl;
   writeDefaultHeaderPart1(t);
   t << "Your title here";
   writeDefaultHeaderPart2(t);
@@ -843,14 +843,14 @@ void LatexGenerator::writeHeaderFile(QFile &f)
 void LatexGenerator::writeFooterFile(QFile &f)
 {
   FTextStream t(&f);
-  t << "% Latex footer for doxygen " << versionString << endl;
+  t << "% Latex footer for doxygen " << getVersion() << endl;
   writeDefaultFooter(t);
 }
 
 void LatexGenerator::writeStyleSheetFile(QFile &f)
 {
   FTextStream t(&f);
-  t << "% stylesheet for doxygen " << versionString << endl;
+  t << "% stylesheet for doxygen " << getVersion() << endl;
   writeDefaultStyleSheet(t);
 }
 
diff --git a/src/layout.cpp b/src/layout.cpp
index 393e05d..f9fe3b0 100644
--- a/src/layout.cpp
+++ b/src/layout.cpp
@@ -1560,7 +1560,7 @@ void writeDefaultLayoutFile(const char *fileName)
     return;
   }
   QTextStream t(&f);
-  t << substitute(layout_default,"$doxygenversion",versionString);
+  t << substitute(layout_default,"$doxygenversion",getVersion());
 }
 
 //----------------------------------------------------------------------------------
diff --git a/src/resourcemgr.cpp b/src/resourcemgr.cpp
index ab7422a..8cb831e 100644
--- a/src/resourcemgr.cpp
+++ b/src/resourcemgr.cpp
@@ -144,7 +144,7 @@ bool ResourceMgr::copyResourceAs(const char *name,const char *targetDir,const ch
             }
             else
             {
-              t << substitute(buf,"$doxygenversion",versionString);
+              t << substitute(buf,"$doxygenversion",getVersion());
             }
             return TRUE;
           }
diff --git a/src/rtfgen.cpp b/src/rtfgen.cpp
index b42780f..bb69898 100644
--- a/src/rtfgen.cpp
+++ b/src/rtfgen.cpp
@@ -96,7 +96,7 @@ RTFGenerator::~RTFGenerator()
 void RTFGenerator::writeStyleSheetFile(QFile &file)
 {
   FTextStream t(&file);
-  t << "# Generated by doxygen " << versionString << "\n\n";
+  t << "# Generated by doxygen " << getVersion() << "\n\n";
   t << "# This file describes styles used for generating RTF output.\n";
   t << "# All text after a hash (#) is considered a comment and will be ignored.\n";
   t << "# Remove a hash to activate a line.\n\n";
@@ -113,7 +113,7 @@ void RTFGenerator::writeStyleSheetFile(QFile &file)
 void RTFGenerator::writeExtensionsFile(QFile &file)
 {
   FTextStream t(&file);
-  t << "# Generated by doxygen " << versionString << "\n\n";
+  t << "# Generated by doxygen " << getVersion() << "\n\n";
   t << "# This file describes extensions used for generating RTF output.\n";
   t << "# All text after a hash (#) is considered a comment and will be ignored.\n";
   t << "# Remove a hash to activate a line.\n\n";
diff --git a/src/searchindex.cpp b/src/searchindex.cpp
index cfa8ed2..c9f8ec1 100644
--- a/src/searchindex.cpp
+++ b/src/searchindex.cpp
@@ -983,7 +983,7 @@ void writeJavascriptSearchIndex()
             " \"https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">" << endl;
           t << "<html><head><title></title>" << endl;
           t << "<meta http-equiv=\"Content-Type\" content=\"text/xhtml;charset=UTF-8\"/>" << endl;
-          t << "<meta name=\"generator\" content=\"Doxygen " << versionString << "\"/>" << endl;
+          t << "<meta name=\"generator\" content=\"Doxygen " << getVersion() << "\"/>" << endl;
           t << "<link rel=\"stylesheet\" type=\"text/css\" href=\"search.css\"/>" << endl;
           t << "<script type=\"text/javascript\" src=\"" << baseName << ".js\"></script>" << endl;
           t << "<script type=\"text/javascript\" src=\"search.js\"></script>" << endl;
diff --git a/src/sqlite3gen.cpp b/src/sqlite3gen.cpp
index eceea06..a1ea115 100644
--- a/src/sqlite3gen.cpp
+++ b/src/sqlite3gen.cpp
@@ -924,7 +924,7 @@ static int insertPath(QCString name, bool local=TRUE, bool found=TRUE, int type=
 
 static void recordMetadata()
 {
-  bindTextParameter(meta_insert,":doxygen_version",versionString);
+  bindTextParameter(meta_insert,":doxygen_version",getVersion());
   bindTextParameter(meta_insert,":schema_version","0.2.0"); //TODO: this should be a constant somewhere; not sure where
   bindTextParameter(meta_insert,":generated_at",dateToString(TRUE), FALSE);
   bindTextParameter(meta_insert,":generated_on",dateToString(FALSE), FALSE);
diff --git a/src/util.cpp b/src/util.cpp
index f92df68..507ced9 100644
--- a/src/util.cpp
+++ b/src/util.cpp
@@ -5327,7 +5327,7 @@ QCString substituteKeywords(const QCString &s,const char *title,
   result = substitute(result,"$datetime",dateToString(TRUE));
   result = substitute(result,"$date",dateToString(FALSE));
   result = substitute(result,"$year",yearToString());
-  result = substitute(result,"$doxygenversion",versionString);
+  result = substitute(result,"$doxygenversion",getVersion());
   result = substitute(result,"$projectname",projName);
   result = substitute(result,"$projectnumber",projNum);
   result = substitute(result,"$projectbrief",projBrief);
diff --git a/src/version.py b/src/version.py
deleted file mode 100644
index 4aedee0..0000000
--- a/src/version.py
+++ /dev/null
@@ -1,23 +0,0 @@
-#!/usr/bin/python
-# python script to generate version.cpp from first argument
-#
-# Copyright (C) 1997-2018 by Dimitri van Heesch.
-#
-# Permission to use, copy, modify, and distribute this software and its
-# documentation under the terms of the GNU General Public License is hereby
-# granted. No representations are made about the suitability of this software
-# for any purpose. It is provided "as is" without express or implied warranty.
-# See the GNU General Public License for more details.
-#
-# Documents produced by Doxygen are derivative works derived from the
-# input used in their production; they are not affected by this license.
-#
-import sys
-
-def main():
-    if len(sys.argv)<2:
-		sys.exit('Usage: %s <version>' % sys.argv[0])
-    print('char versionString[]="%s";' % sys.argv[1])
-
-if __name__ == '__main__':
-	main()
diff --git a/src/xmlgen.cpp b/src/xmlgen.cpp
index 251dfde..d3b8355 100644
--- a/src/xmlgen.cpp
+++ b/src/xmlgen.cpp
@@ -152,7 +152,7 @@ static void writeXMLHeader(FTextStream &t)
   t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>" << endl;;
   t << "<doxygen xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ";
   t << "xsi:noNamespaceSchemaLocation=\"compound.xsd\" ";
-  t << "version=\"" << versionString << "\">" << endl;
+  t << "version=\"" << getVersion() << "\">" << endl;
 }
 
 static void writeCombineScript()
@@ -1979,7 +1979,7 @@ void generateXML()
   t << "<?xml version='1.0' encoding='UTF-8' standalone='no'?>" << endl;;
   t << "<doxygenindex xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" ";
   t << "xsi:noNamespaceSchemaLocation=\"index.xsd\" ";
-  t << "version=\"" << versionString << "\">" << endl;
+  t << "version=\"" << getVersion() << "\">" << endl;
 
   {
     ClassSDict::Iterator cli(*Doxygen::classSDict);