Added diagram metadata to PlantUML and JSON generators

CHANGELOG.md

@@ -1,5 +1,6 @@
 # CHANGELOG
 
+  * Added diagram metadata to PlantUML and JSON generators (#27)
   * Improved template specialization matching for variadic and function 
     template parameters (#118)
   * Fixed compilation and tests on LLVM 16 (#108)

src/class_diagram/generators/json/class_diagram_generator.cc

@@ -126,6 +126,8 @@ void generator::generate(std::ostream &ostr) const
 
     generate_relationships(json_);
 
+    generate_metadata(json_);
+
     ostr << json_;
 }
 

src/class_diagram/generators/plantuml/class_diagram_generator.cc

@@ -765,6 +765,8 @@ void generator::generate(std::ostream &ostr) const
 
     generate_plantuml_directives(ostr, m_config.puml().after);
 
+    generate_metadata(ostr);
+
     ostr << "@enduml" << '\n';
 }
 

src/cli/cli_handler.cc

@@ -104,6 +104,8 @@ cli_flow_t cli_handler::parse(int argc, const char **argv)
     app.add_flag("--paths-relative-to-pwd", paths_relative_to_pwd,
         "If true, all paths in configuration files are relative to the $PWD "
         "instead of actual location of `.clang-uml` file.");
+    app.add_flag("--no-metadata", no_metadata,
+        "Skip metadata (e.g. clang-uml version) from diagrams");
 
     try {
         app.parse(argc, argv);
@@ -201,7 +203,8 @@ cli_flow_t cli_handler::handle_pre_config_options()
 cli_flow_t cli_handler::load_config()
 {
     try {
-        config = clanguml::config::load(config_path, paths_relative_to_pwd);
+        config = clanguml::config::load(
+            config_path, paths_relative_to_pwd, no_metadata);
         return cli_flow_t::kContinue;
     }
     catch (std::runtime_error &e) {

src/cli/cli_handler.h

@@ -130,6 +130,7 @@ public:
     std::optional<bool> paths_relative_to_pwd{};
     std::vector<std::string> template_variables{};
     bool list_templates{false};
+    std::optional<bool> no_metadata{};
     std::optional<std::string> show_template;
     std::vector<clanguml::common::generator_type_t> generators{
         clanguml::common::generator_type_t::plantuml};

src/common/generators/json/generator.cc

@@ -79,5 +79,4 @@ void to_json(nlohmann::json &j, const relationship &c)
     if (const auto &comment = c.comment(); comment)
         j["comment"] = comment.value();
 }
-
 } // namespace clanguml::common::model

src/common/generators/json/generator.h

@@ -21,7 +21,9 @@
 #include "config/config.h"
 #include "util/error.h"
 #include "util/util.h"
+#include "version.h"
 
+#include <clang/Basic/Version.h>
 #include <clang/Frontend/CompilerInstance.h>
 #include <clang/Tooling/CompilationDatabase.h>
 #include <clang/Tooling/Tooling.h>
@@ -81,6 +83,13 @@ public:
      */
     virtual void generate(std::ostream &ostr) const = 0;
 
+    /**
+     * @brief Generate metadata element with diagram metadata
+     *
+     * @param parent Root JSON object
+     */
+    void generate_metadata(nlohmann::json &parent) const;
+
 private:
 protected:
     ConfigType &m_config;
@@ -95,4 +104,16 @@ std::ostream &operator<<(
     return os;
 }
 
+template <typename C, typename D>
+void generator<C, D>::generate_metadata(nlohmann::json &parent) const
+{
+    if (m_config.generate_metadata()) {
+        parent["metadata"]["clang_uml_version"] =
+            clanguml::version::CLANG_UML_VERSION;
+        parent["metadata"]["schema_version"] =
+            clanguml::version::CLANG_UML_JSON_GENERATOR_SCHEMA_VERSION;
+        parent["metadata"]["llvm_version"] = clang::getClangFullVersion();
+    }
+}
+
 } // namespace clanguml::common::generators::json

src/common/generators/plantuml/generator.h

@@ -21,7 +21,9 @@
 #include "config/config.h"
 #include "util/error.h"
 #include "util/util.h"
+#include "version.h"
 
+#include <clang/Basic/Version.h>
 #include <clang/Frontend/CompilerInstance.h>
 #include <clang/Tooling/CompilationDatabase.h>
 #include <clang/Tooling/Tooling.h>
@@ -110,6 +112,13 @@ public:
     void generate_notes(
         std::ostream &ostr, const model::element &element) const;
 
+    /**
+     * @brief Generate comment with diagram metadata
+     *
+     * @param ostr Output stream
+     */
+    void generate_metadata(std::ostream &ostr) const;
+
     /**
      * @brief Generate hyper link to element
      *
@@ -375,6 +384,17 @@ void generator<C, D>::generate_notes(
     }
 }
 
+template <typename C, typename D>
+void generator<C, D>::generate_metadata(std::ostream &ostr) const
+{
+    if (m_config.generate_metadata()) {
+        ostr << '\n'
+             << "'Generated with clang-uml, version "
+             << clanguml::version::CLANG_UML_VERSION << '\n'
+             << "'LLVM version " << clang::getClangFullVersion() << '\n';
+    }
+}
+
 template <typename C, typename D>
 template <typename E>
 void generator<C, D>::generate_link(std::ostream &ostr, const E &e) const

src/config/config.cc

@@ -116,6 +116,7 @@ void inheritable_diagram_options::inherit(
     combine_free_functions_into_file_participants.override(
         combine_free_functions_into_file_participants);
     debug_mode.override(parent.debug_mode);
+    generate_metadata.override(parent.generate_metadata);
 }
 
 std::string inheritable_diagram_options::simplify_template_type(

src/config/config.h

@@ -170,6 +170,7 @@ struct inheritable_diagram_options {
         "combine_free_functions_into_file_participants", false};
     option<std::vector<std::string>> participants_order{"participants_order"};
     option<bool> debug_mode{"debug_mode", false};
+    option<bool> generate_metadata{"generate_metadata", true};
 
     void inherit(const inheritable_diagram_options &parent);
 
@@ -292,7 +293,8 @@ YAML::Emitter &operator<<(YAML::Emitter &out, const option<T> &o)
 }
 
 config load(const std::string &config_file,
-    std::optional<bool> paths_relative_to_pwd = {});
+    std::optional<bool> paths_relative_to_pwd = {},
+    std::optional<bool> no_metadata = {});
 
 config load_plain(const std::string &config_file);
 } // namespace config

src/config/yaml_decoders.cc

@@ -381,6 +381,7 @@ template <typename T> bool decode_diagram(const Node &node, T &rhs)
     get_option(node, rhs.type_aliases);
     get_option(node, rhs.comment_parser);
     get_option(node, rhs.debug_mode);
+    get_option(node, rhs.generate_metadata);
 
     return true;
 }
@@ -595,6 +596,7 @@ template <> struct convert<config> {
         get_option(node, rhs.generate_system_headers);
         get_option(node, rhs.git);
         get_option(node, rhs.debug_mode);
+        get_option(node, rhs.generate_metadata);
         rhs.base_directory.set(node["__parent_path"].as<std::string>());
         get_option(node, rhs.relative_to);
 
@@ -676,8 +678,8 @@ void resolve_option_path(YAML::Node &doc, const std::string &option)
 }
 } // namespace
 
-config load(
+config load(const std::string &config_file,
-    const std::string &config_file, std::optional<bool> paths_relative_to_pwd)
+    std::optional<bool> paths_relative_to_pwd, std::optional<bool> no_metadata)
 {
     try {
         YAML::Node doc;
@@ -727,6 +729,10 @@ config load(
                 doc["relative_to"] = std::filesystem::current_path().string();
         }
 
+        if (no_metadata.has_value()) {
+            doc["generate_metadata"] = !no_metadata.value();
+        }
+
         //
         // Resolve common path-like config options relative to `relative_to`
         //

src/include_diagram/generators/json/include_diagram_generator.cc

@@ -100,6 +100,8 @@ void generator::generate(std::ostream &ostr) const
         generate_relationships(dynamic_cast<source_file &>(*f), json_);
     });
 
+    generate_metadata(json_);
+
     ostr << json_;
 }
 } // namespace clanguml::include_diagram::generators::json

src/include_diagram/generators/plantuml/include_diagram_generator.cc

@@ -120,6 +120,8 @@ void generator::generate(std::ostream &ostr) const
     if (m_config.puml)
         generate_plantuml_directives(ostr, m_config.puml().after);
 
+    generate_metadata(ostr);
+
     ostr << "@enduml" << '\n';
 }
 } // namespace clanguml::include_diagram::generators::plantuml

src/package_diagram/generators/json/package_diagram_generator.cc

@@ -98,6 +98,8 @@ void generator::generate(std::ostream &ostr) const
             generate_relationships(dynamic_cast<package &>(*p), json_);
     }
 
+    generate_metadata(json_);
+
     ostr << json_;
 }
 

src/package_diagram/generators/plantuml/package_diagram_generator.cc

@@ -147,6 +147,8 @@ void generator::generate(std::ostream &ostr) const
 
     generate_plantuml_directives(ostr, m_config.puml().after);
 
+    generate_metadata(ostr);
+
     ostr << "@enduml" << '\n';
 }
 

src/sequence_diagram/generators/json/sequence_diagram_generator.cc

@@ -660,6 +660,8 @@ void generator::generate(std::ostream &ostr) const
         }
     }
 
+    generate_metadata(json_);
+
     ostr << json_;
 }
 } // namespace clanguml::sequence_diagram::generators::json

src/sequence_diagram/generators/plantuml/sequence_diagram_generator.cc

@@ -470,6 +470,8 @@ void generator::generate(std::ostream &ostr) const
 
     generate_plantuml_directives(ostr, m_config.puml().after);
 
+    generate_metadata(ostr);
+
     ostr << "@enduml" << std::endl;
 }
 

src/version.h.in

@@ -18,6 +18,7 @@
 #pragma once
 
 namespace clanguml::version {
+static constexpr auto CLANG_UML_JSON_GENERATOR_SCHEMA_VERSION = 1U;
 static constexpr auto CLANG_UML_VERSION = "@GIT_VERSION@";
 static constexpr auto CLANG_UML_LIBCLANG_VERSION = "@LIBCLANG_VERSION_STRING@";
 } // namespace clanguml::version