Refactoring

- Makes doxycfg library more self contained
- renames _doxygen library to doxymain
- Modernizes Debug implementation
- Moves Doxygen::runningTime into Debug
- Moves full version string to libversion
- Removed mentioning of file version in messages (when
  FILE_VERSION_FILTER is used)
- Move substitute functions into QCString

Author: doxygen

addon/doxyapp/CMakeLists.txt

@@ -18,7 +18,7 @@ if (use_libclang)
 endif()
 
 target_link_libraries(doxyapp
-_doxygen
+doxymain
 qtools
 md5
 lodepng

addon/doxyparse/CMakeLists.txt

@@ -18,7 +18,7 @@ if (use_libclang)
 endif()
 
 target_link_libraries(doxyparse
-_doxygen
+doxymain
 qtools
 md5
 lodepng

libversion/CMakeLists.txt

@@ -19,6 +19,7 @@ include_directories(
 add_library(doxygen_version STATIC
     ${POST_CONFIGURE_DOXYGEN_VERSION_FILE}
     ${POST_CONFIGURE_GIT_VERSION_FILE}
+    fullversion.cpp
 )
 
 add_dependencies( doxygen_version check_git_repository )

libversion/doxyversion.cpp.in

@@ -1,6 +1,6 @@
 #include "version.h"
 
-char *getDoxygenVersion(void)
+const char *getDoxygenVersion(void)
 {
   static char versionString[] = "@DOXYGEN_VERSION@";
   return versionString;

libversion/fullversion.cpp

@@ -0,0 +1,22 @@
+#include <string.h>
+#include <version.h>
+
+const char *getFullVersion(void)
+{
+#define BUF_SIZE 100
+  static char fullVersionString[BUF_SIZE];
+  static bool init = false;
+  if (!init)
+  {
+    strlcpy(fullVersionString,getDoxygenVersion(),BUF_SIZE);
+    if (strlen(getGitVersion())>0)
+    {
+      strlcat(fullVersionString," (",BUF_SIZE);
+      strlcat(fullVersionString,getGitVersion(),BUF_SIZE);
+      strlcat(fullVersionString,")",BUF_SIZE);
+    }
+    fullVersionString[BUF_SIZE-1]='\0';
+    init = true;
+  }
+  return fullVersionString;
+}

libversion/gitversion.cpp.in

@@ -6,11 +6,18 @@
  * - No git information is present (no .git directory)
  * in those cases clear the gitVersionString (would have string GIT-NOTFOUND).
  */
-char *getGitVersion(void)
+const char *getGitVersion(void)
 {
-  static char gitVersionString[100];
-  strcpy(gitVersionString,"@GIT_HEAD_SHA1@");
-  strcat(gitVersionString,!strcmp("@GIT_IS_DIRTY@","true")?"*":"");
-  if (!strcmp("@GIT_HEAD_SHA1@", "GIT-NOTFOUND")) gitVersionString[0] = '\0';
+#define BUF_SIZE 100
+  static char gitVersionString[BUF_SIZE];
+  static bool init = false;
+  if (!init)
+  {
+    strncpy(gitVersionString,"@GIT_HEAD_SHA1@",BUF_SIZE);
+    strncat(gitVersionString,!strcmp("@GIT_IS_DIRTY@","true")?"*":"",BUF_SIZE);
+    if (!strcmp("@GIT_HEAD_SHA1@", "GIT-NOTFOUND")) gitVersionString[0] = '\0';
+    gitVersionString[BUF_SIZE-1]='\0';
+    init = true;
+  }
   return gitVersionString;
 }

libversion/version.h

@@ -1,12 +1,10 @@
 /******************************************************************************
  *
- * 
- *
- * Copyright (C) 1997-2015 by Dimitri van Heesch.
+ * Copyright (C) 1997-2020 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 
+ * 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.
  *
@@ -17,6 +15,7 @@
 
 #ifndef VERSION_H
 #define VERSION_H
-char *getDoxygenVersion(void);
-char *getGitVersion(void);
+const char *getDoxygenVersion(void);
+const char *getGitVersion(void);
+const char *getFullVersion(void);
 #endif

qtools/qcstring.cpp

@@ -840,3 +840,113 @@ inline QCString operator+( const QGString &s1, const QCString &s2 )
     return tmp;
 }
 
+/// substitute all occurrences of \a src in \a s by \a dst
+QCString substitute(const QCString &s,const QCString &src,const QCString &dst)
+{
+  if (s.isEmpty() || src.isEmpty()) return s;
+  const char *p, *q;
+  int srcLen = src.length();
+  int dstLen = dst.length();
+  int resLen;
+  if (srcLen!=dstLen)
+  {
+    int count;
+    for (count=0, p=s.data(); (q=strstr(p,src))!=0; p=q+srcLen) count++;
+    resLen = s.length()+count*(dstLen-srcLen);
+  }
+  else // result has same size as s
+  {
+    resLen = s.length();
+  }
+  QCString result(resLen+1);
+  char *r;
+  for (r=result.rawData(), p=s; (q=strstr(p,src))!=0; p=q+srcLen)
+  {
+    int l = (int)(q-p);
+    memcpy(r,p,l);
+    r+=l;
+
+    if (dst) memcpy(r,dst,dstLen);
+    r+=dstLen;
+  }
+  qstrcpy(r,p);
+  //printf("substitute(%s,%s,%s)->%s\n",s,src,dst,result.data());
+  return result;
+}
+
+
+/// substitute all occurrences of \a src in \a s by \a dst, but skip
+/// each consecutive sequence of \a src where the number consecutive
+/// \a src matches \a skip_seq; if \a skip_seq is negative, skip any
+/// number of consecutive \a src
+QCString substitute(const QCString &s,const QCString &src,const QCString &dst,int skip_seq)
+{
+  if (s.isEmpty() || src.isEmpty()) return s;
+  const char *p, *q;
+  int srcLen = src.length();
+  int dstLen = dst.length();
+  int resLen;
+  if (srcLen!=dstLen)
+  {
+    int count;
+    for (count=0, p=s.data(); (q=strstr(p,src))!=0; p=q+srcLen) count++;
+    resLen = s.length()+count*(dstLen-srcLen);
+  }
+  else // result has same size as s
+  {
+    resLen = s.length();
+  }
+  QCString result(resLen+1);
+  char *r;
+  for (r=result.rawData(), p=s; (q=strstr(p,src))!=0; p=q+srcLen)
+  {
+    // search a consecutive sequence of src
+    int seq = 0, skip = 0;
+    if (skip_seq)
+    {
+      for (const char *n=q+srcLen; qstrncmp(n,src,srcLen)==0; seq=1+skip, n+=srcLen)
+        ++skip; // number of consecutive src after the current one
+
+      // verify the allowed number of consecutive src to skip
+      if (skip_seq > 0 && skip_seq != seq)
+        seq = skip = 0;
+    }
+
+    // skip a consecutive sequence of src when necessary
+    int l = (int)((q + seq * srcLen)-p);
+    memcpy(r,p,l);
+    r+=l;
+
+    if (skip)
+    {
+      // skip only the consecutive src found after the current one
+      q += skip * srcLen;
+      // the next loop will skip the current src, aka (p=q+srcLen)
+      continue;
+    }
+
+    if (dst) memcpy(r,dst,dstLen);
+    r+=dstLen;
+  }
+  qstrcpy(r,p);
+  result.resize((int)strlen(result.data())+1);
+  //printf("substitute(%s,%s,%s)->%s\n",s,src,dst,result.data());
+  return result;
+}
+
+/// substitute all occurrences of \a srcChar in \a s by \a dstChar
+QCString substitute(const QCString &s,char srcChar,char dstChar)
+{
+  int l=s.length();
+  QCString result(l+1);
+  char *q=result.rawData();
+  if (l>0)
+  {
+    const char *p=s.data();
+    char c;
+    while ((c=*p++)) *q++ = (c==srcChar) ? dstChar : c;
+  }
+  *q='\0';
+  return result;
+}
+

qtools/qcstring.h

@@ -812,4 +812,9 @@ inline std::string toStdString(const QCString &s)
   if (!s.isEmpty()) return std::string(s.data()); else return std::string();
 }
 
+// helper functions
+QCString substitute(const QCString &s,const QCString &src,const QCString &dst);
+QCString substitute(const QCString &s,const QCString &src,const QCString &dst,int skip_seq);
+QCString substitute(const QCString &s,char srcChar,char dstChar);
+
 #endif // QCSTRING_H

src/CMakeLists.txt

@@ -142,18 +142,22 @@ add_library(doxycfg STATIC
     ${GENERATED_SRC}/configimpl.l.h
     ${GENERATED_SRC}/configoptions.cpp
     ${GENERATED_SRC}/configvalues.cpp
+    ${GENERATED_SRC}/settings.h
     portable.cpp
     portable_c.c
+    ftextstream.cpp
+    message.cpp
+    debug.cpp
 )
 
-add_library(_doxygen STATIC
+add_library(doxymain STATIC
     # generated for/by flex/bison
     #${LEX_FILES_H} #unfortunately doesn't work in older versions of CMake (like 3.6.2)
     #${LEX_FILES_CPP} #unfortunately doesn't work in older versions of CMake (like 3.6.2)
     ${GENERATED_SRC}/code.l.h
     ${GENERATED_SRC}/commentcnv.l.h
     ${GENERATED_SRC}/commentscan.l.h
-    ${GENERATED_SRC}/configimpl.l.h
+    ${GENERATED_SRC}/constexp.cpp
     ${GENERATED_SRC}/constexp.l.h
     ${GENERATED_SRC}/declinfo.l.h
     ${GENERATED_SRC}/defargs.l.h
@@ -170,8 +174,6 @@ add_library(_doxygen STATIC
     ${GENERATED_SRC}/code.cpp
     ${GENERATED_SRC}/commentcnv.cpp
     ${GENERATED_SRC}/commentscan.cpp
-    ${GENERATED_SRC}/configimpl.cpp
-    ${GENERATED_SRC}/constexp.cpp
     ${GENERATED_SRC}/declinfo.cpp
     ${GENERATED_SRC}/defargs.cpp
     ${GENERATED_SRC}/doctokenizer.cpp
@@ -188,10 +190,8 @@ add_library(_doxygen STATIC
     ${GENERATED_SRC}/ce_parse.cpp
     # custom generated files
     ${GENERATED_SRC}/lang_cfg.h
-    ${GENERATED_SRC}/settings.h
     ${GENERATED_SRC}/layout_default.xml.h
     ${GENERATED_SRC}/ce_parse.h
-    ${GENERATED_SRC}/configvalues.h
     ${GENERATED_SRC}/resources.cpp
     #
     arguments.cpp
@@ -203,7 +203,6 @@ add_library(_doxygen STATIC
     condparser.cpp
     context.cpp
     cppvalue.cpp
-    debug.cpp
     defgen.cpp
     define.cpp
     definition.cpp
@@ -234,7 +233,6 @@ add_library(_doxygen STATIC
     filedef.cpp
     fileparser.cpp
     formula.cpp
-    ftextstream.cpp
     ftvhelp.cpp
     groupdef.cpp
     htags.cpp
@@ -254,7 +252,6 @@ add_library(_doxygen STATIC
     memberdef.cpp
     membergroup.cpp
     memberlist.cpp
-    message.cpp
     msc.cpp
     namespacedef.cpp
     outputgen.cpp
@@ -291,7 +288,7 @@ set_source_files_properties(clangparser.cpp PROPERTIES COMPILE_FLAGS "-Wno-shado
 endif()
 
 ##foreach(lex_file ${LEX_FILES})
-##add_library(_doxygen STATIC ${GENERATED_SRC}/${lex_file}.l.h)
+##add_library(doxymain STATIC ${GENERATED_SRC}/${lex_file}.l.h)
 ##endforeach()
 
 add_executable(doxygen main.cpp)
@@ -302,12 +299,12 @@ if (use_libclang)
     find_package(Clang REQUIRED CONFIG)
     if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
         cmake_minimum_required(VERSION 3.1)
-        target_compile_features(_doxygen PRIVATE cxx_alignof)
+        target_compile_features(doxymain PRIVATE cxx_alignof)
         target_compile_features(doxygen PRIVATE cxx_alignof)
-        target_compile_options(_doxygen PRIVATE -stdlib=libc++)
+        target_compile_options(doxymain PRIVATE -stdlib=libc++)
         target_compile_options(doxygen PRIVATE -stdlib=libc++)
     elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-        target_compile_options(_doxygen PRIVATE -std=c++11)
+        target_compile_options(doxymain PRIVATE -std=c++11)
         target_compile_options(doxygen PRIVATE -std=c++11)
     endif()
     include_directories(${LLVM_INCLUDE_DIRS})
@@ -318,8 +315,8 @@ if (use_libclang)
 endif()
 
 target_link_libraries(doxygen
-    _doxygen
     doxycfg
+    doxymain
     qtools
     md5
     lodepng
@@ -335,7 +332,7 @@ target_link_libraries(doxygen
 )
 
 set_project_warnings(doxycfg)
-set_project_warnings(_doxygen)
+set_project_warnings(doxymain)
 set_project_warnings(doxygen)
 
 install(TARGETS doxygen DESTINATION bin)