make use of clang compilation database

See: https://clang.llvm.org/docs/JSONCompilationDatabase.html

3 files changed, 61 insertions, 1 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 08c8439..df76cb0 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -244,6 +244,19 @@ add_library(_doxygen STATIC
 )
 
 add_executable(doxygen main.cpp)
+
+if (use_libclang)
+    find_package(LLVM REQUIRED CONFIG)
+    find_package(Clang REQUIRED CONFIG)
+    target_compile_features(_doxygen PRIVATE cxx_alignof)
+    target_compile_options(_doxygen PRIVATE -stdlib=libc++ -std=c++11)
+    target_compile_features(doxygen PRIVATE cxx_alignof)
+    target_compile_options(doxygen PRIVATE -stdlib=libc++ -std=c++11)
+    llvm_map_components_to_libnames(llvm_libs support core option)
+    target_compile_definitions(doxygen PRIVATE ${LLVM_DEFINITIONS})
+    set(CLANG_LIBS ${llvm_libs} ${CLANG_LIBS} clangTooling)
+endif()
+
 target_link_libraries(doxygen
     _doxygen
     doxycfg
diff --git a/src/clangparser.cpp b/src/clangparser.cpp
index 67e754b..77151d6 100644
--- a/src/clangparser.cpp
+++ b/src/clangparser.cpp
@@ -4,6 +4,7 @@
 
 #if USE_LIBCLANG
 #include <clang-c/Index.h>
+#include "clang/Tooling/Tooling.h"
 #include <qfileinfo.h>
 #include <stdlib.h>
 #include "message.h"
@@ -160,15 +161,46 @@ void ClangParser::start(const char *fileName,QStrList &filesInTranslationUnit)
   static bool clangAssistedParsing = Config_getBool(CLANG_ASSISTED_PARSING);
   static QStrList &includePath = Config_getList(INCLUDE_PATH);
   static QStrList clangOptions = Config_getList(CLANG_OPTIONS);
+  static QCString clangCompileDatabase = Config_getList(CLANG_COMPILATION_DATABASE_PATH);
   if (!clangAssistedParsing) return;
   //printf("ClangParser::start(%s)\n",fileName);
   p->fileName = fileName;
   p->index    = clang_createIndex(0, 0);
   p->curLine  = 1;
   p->curToken = 0;
-  char **argv = (char**)malloc(sizeof(char*)*(4+Doxygen::inputPaths.count()+includePath.count()+clangOptions.count()));
   QDictIterator<void> di(Doxygen::inputPaths);
   int argc=0;
+  std::string error;
+  // load a clang compilation database (https://clang.llvm.org/docs/JSONCompilationDatabase.html)
+  // this only needs to be loaded once, and could be refactored to a higher level function
+  static std::unique_ptr<clang::tooling::CompilationDatabase> db =
+      clang::tooling::CompilationDatabase::loadFromDirectory(clangCompileDatabase.data(), error);
+  int clang_option_len = 0;
+  std::vector<clang::tooling::CompileCommand> command;
+  if (strcmp(clangCompileDatabase, "0") != 0) {
+      if (db == nullptr) {
+          // user specified a path, but DB file was not found
+          err("%s using clang compilation database path of: \"%s\"\n", error.c_str(),
+              clangCompileDatabase.data());
+      } else {
+          // check if the file we are parsing is in the DB
+          command = db->getCompileCommands(fileName);
+          if (!command.empty() ) {
+              // it's possible to have multiple entries for the same file, so use the last entry
+              clang_option_len = command[command.size()-1].CommandLine.size();
+          }
+      }
+  }
+  char **argv = (char**)malloc(sizeof(char*)*(4+Doxygen::inputPaths.count()+includePath.count()+clangOptions.count()+clang_option_len));
+  if (!command.empty() ) {
+      std::vector<std::string> options = command[command.size()-1].CommandLine;
+      // copy each compiler option used from the database. Skip the first which is compiler exe.
+      for (auto option = options.begin()+1; option != options.end(); option++) {
+          argv[argc++] = strdup(option->c_str());
+      }
+      // this extra addition to argv is accounted for as we are skipping the first entry in
+      argv[argc++]=strdup("-w"); // finally, turn off warnings.
+  } else {
   // add include paths for input files
   for (di.toFirst();di.current();++di,++argc)
   {
@@ -230,6 +262,7 @@ void ClangParser::start(const char *fileName,QStrList &filesInTranslationUnit)
   // provide the input and and its dependencies as unsaved files so we can
   // pass the filtered versions
   argv[argc++]=strdup(fileName);
+  }
   static bool filterSourceFiles = Config_getBool(FILTER_SOURCE_FILES);
   //printf("source %s ----------\n%s\n-------------\n\n",
   //    fileName,p->source.data());
diff --git a/src/config.xml b/src/config.xml
index 2a7cbeb..55ee0b1 100644
--- a/src/config.xml
+++ b/src/config.xml
@@ -1637,6 +1637,20 @@ to disable this feature.
 ]]>
       </docs>
     </option>
+    <option type='string' id='CLANG_COMPILATION_DATABASE_PATH' setting='USE_LIBCLANG' defval='0'>
+      <docs>
+<![CDATA[
+ If clang assisted parsing is enabled you can provide the clang parser with the
+ path to the <a href="http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html">
+ compilation database</a> used when the files were built. This is equivilent to
+ specifying the "-p" option to a clang tool, such as clang-check. These options
+ will then be pased to the parser.
+
+ @note The availability of this option depends on whether or not doxygen
+ was generated with the `-Duse-libclang=ON` option for CMake.
+ ]]>
+        </docs>
+    </option>
   </group>
   <group name='Index' docs='Configuration options related to the alphabetical class index'>
     <option type='bool' id='ALPHABETICAL_INDEX' defval='1'>