Merge pull request #381 from bkryza/add-support-for-compile-flags-txt

Added support for compile_flags.txt (#380)

README.md

@@ -84,9 +84,12 @@ Installation instructions for `Linux`, `macos` and `Windows` can be found
 
 `clang-uml` requires an up-to-date
 [compile_commands.json](https://clang.llvm.org/docs/JSONCompilationDatabase.html)
-file, containing the list of commands used for compiling the source code.
+file, containing the list of commands used for compiling the source code
+or alternatively a list of compilation flags in a file called
+`compile_flags.txt`
+(see [here](https://clang.llvm.org/docs/JSONCompilationDatabase.html#alternatives).
 
-See [here](https://blog.bkryza.com/posts/compile-commands-json-gallery/)
+See also [here](https://blog.bkryza.com/posts/compile-commands-json-gallery/)
 for instructions on how to generate `compile_commands.json` using some of the
 existing C++ build systems.
 

src/common/generators/display_adapters.h

@@ -130,7 +130,7 @@ template <typename T> class display_name_adapter {
             }
         }
 
-        return n;
+        return util::condense_whitespace(n);
     }
 
 private:

src/common/generators/generators.cc

@@ -46,7 +46,7 @@ void make_context_source_relative(
 void find_translation_units_for_diagrams(
     const std::vector<std::string> &diagram_names,
     clanguml::config::config &config,
-    const std::vector<std::string> &compilation_database_files,
+    const compilation_database &compilation_database,
     std::map<std::string, std::vector<std::string>> &translation_units_map)
 {
     for (const auto &[name, diagram] : config.diagrams) {
@@ -56,7 +56,8 @@ void find_translation_units_for_diagrams(
             continue;
 
         translation_units_map[name] =
-            diagram->glob_translation_units(compilation_database_files);
+            diagram->glob_translation_units(compilation_database.getAllFiles(),
+                compilation_database.is_fixed());
 
         LOG_DBG("Found {} translation units for diagram '{}'",
             translation_units_map.at(name).size(), name);

src/common/generators/generators.h

@@ -255,13 +255,13 @@ constexpr bool generator_supports_diagram_type(
  *
  * @param diagram_names List of diagram names, applies to all if empty
  * @param config Reference to config instance
- * @param compilation_database_files List of files found in compilation database
+ * @param compilation_database Reference to a compilation database
  * @param translation_units_map Resulting translation units map is stored here
  */
 void find_translation_units_for_diagrams(
     const std::vector<std::string> &diagram_names,
     clanguml::config::config &config,
-    const std::vector<std::string> &compilation_database_files,
+    const compilation_database &compilation_database,
     std::map<std::string, std::vector<std::string>> &translation_units_map);
 
 /**

src/config/config.cc

@@ -356,9 +356,9 @@ bool inheritable_diagram_options::generate_fully_qualified_name() const
 }
 
 std::vector<std::string> diagram::glob_translation_units(
-    const std::vector<std::string> &compilation_database_files) const
+    const std::vector<std::string> &compilation_database_files,
+    bool is_fixed) const
 {
-
     // Make sure that the paths are in preferred format for a given platform
     // before intersecting the matches with compliation database
     std::vector<std::string> compilation_database_paths;
@@ -471,7 +471,7 @@ std::vector<std::string> diagram::glob_translation_units(
     for (const auto &gm : glob_matches) {
         std::filesystem::path gm_path{gm};
         gm_path.make_preferred();
-        if (util::contains(compilation_database_paths, gm_path) ||
+        if (is_fixed || util::contains(compilation_database_paths, gm_path) ||
             util::contains(compilation_database_files, gm)) {
             result.emplace_back(gm_path.string());
         }

src/config/config.h

@@ -719,7 +719,8 @@ struct diagram : public inheritable_diagram_options {
      * @return List of translation unit paths
      */
     std::vector<std::string> glob_translation_units(
-        const std::vector<std::string> &compilation_database_files) const;
+        const std::vector<std::string> &compilation_database_files,
+        bool is_fixed = false) const;
 
     /**
      * @brief Make path relative to the `relative_to` config option

src/main.cc

@@ -75,8 +75,7 @@ int main(int argc, const char *argv[])
         // before scheduling tasks, because std::filesystem::current_path
         // cannot be trusted with multiple threads
         common::generators::find_translation_units_for_diagrams(
-            cli.diagram_names, cli.config, compilation_database_files,
-            translation_units_map);
+            cli.diagram_names, cli.config, *db, translation_units_map);
 
         if (cli.progress) {
             // llvm::errs() output stream mangles the stdout stream , we need