Added initial support for MermaidJS sequence diagram

bkryza · Sep 7, 2023 · 32fda88 · 32fda88
1 parent 084bb20
commit 32fda88
Show file tree

Hide file tree

Showing 43 changed files with 956 additions and 23 deletions.
diff --git a/src/class_diagram/generators/mermaid/class_diagram_generator.cc b/src/class_diagram/generators/mermaid/class_diagram_generator.cc
@@ -25,26 +25,14 @@
 namespace clanguml::class_diagram::generators::mermaid {
 
 using clanguml::common::generators::mermaid::indent;
+using clanguml::common::generators::mermaid::render_name;
 
 generator::generator(diagram_config &config, diagram_model &model)
     : common_generator<diagram_config, diagram_model>{config, model}
     , together_group_stack_{true}
 {
 }
 
-std::string generator::render_name(std::string name) const
-{
-    util::replace_all(name, "<", "&lt;");
-    util::replace_all(name, ">", "&gt;");
-    util::replace_all(name, "(", "&lpar;");
-    util::replace_all(name, ")", "&rpar;");
-    util::replace_all(name, "##", "::");
-    util::replace_all(name, "{", "&lbrace;");
-    util::replace_all(name, "}", "&rbrace;");
-
-    return name;
-}
-
 void generator::generate_alias(
     const common::model::element &c, std::ostream &ostr) const
 {

diff --git a/src/class_diagram/generators/mermaid/class_diagram_generator.h b/src/class_diagram/generators/mermaid/class_diagram_generator.h
@@ -246,8 +246,6 @@ class generator : public common_generator<diagram_config, diagram_model> {
     const std::vector<std::string> method_groups_{
         "constructors", "assignment", "operators", "other"};
 
-    std::string render_name(std::string name) const;
-
     template <typename T>
     void sort_class_elements(std::vector<T> &elements) const
     {

diff --git a/src/common/generators/generators.h b/src/common/generators/generators.h
@@ -31,6 +31,7 @@
 #include "package_diagram/generators/json/package_diagram_generator.h"
 #include "package_diagram/generators/plantuml/package_diagram_generator.h"
 #include "sequence_diagram/generators/json/sequence_diagram_generator.h"
+#include "sequence_diagram/generators/mermaid/sequence_diagram_generator.h"
 #include "sequence_diagram/generators/plantuml/sequence_diagram_generator.h"
 #include "util/util.h"
 #include "version.h"
@@ -168,11 +169,11 @@ struct diagram_generator_t<clanguml::config::class_diagram,
     mermaid_generator_tag> {
     using type = clanguml::class_diagram::generators::mermaid::generator;
 };
-// template <>
-// struct diagram_generator_t<clanguml::config::sequence_diagram,
-//     mermaid_generator_tag> {
-//     using type = clanguml::sequence_diagram::generators::mermaid::generator;
-// };
+template <>
+struct diagram_generator_t<clanguml::config::sequence_diagram,
+    mermaid_generator_tag> {
+    using type = clanguml::sequence_diagram::generators::mermaid::generator;
+};
 // template <>
 // struct diagram_generator_t<clanguml::config::package_diagram,
 //     mermaid_generator_tag> {

diff --git a/src/common/generators/mermaid/generator.cc b/src/common/generators/mermaid/generator.cc
@@ -64,9 +64,9 @@ std::string to_mermaid(message_t r)
 {
     switch (r) {
     case message_t::kCall:
-        return "->";
+        return "->>";
     case message_t::kReturn:
-        return "-->";
+        return "-->>";
     default:
         return "";
     }
@@ -78,4 +78,16 @@ std::string indent(const unsigned level)
     return std::string(level * kIndentWidth, ' ');
 }
 
+std::string render_name(std::string name)
+{
+    util::replace_all(name, "<", "&lt;");
+    util::replace_all(name, ">", "&gt;");
+    util::replace_all(name, "(", "&lpar;");
+    util::replace_all(name, ")", "&rpar;");
+    util::replace_all(name, "##", "::");
+    util::replace_all(name, "{", "&lbrace;");
+    util::replace_all(name, "}", "&rbrace;");
+
+    return name;
+}
 } // namespace clanguml::common::generators::mermaid
diff --git a/src/common/generators/mermaid/generator.h b/src/common/generators/mermaid/generator.h
@@ -44,6 +44,8 @@ std::string to_mermaid(message_t r);
 
 std::string indent(const unsigned level);
 
+std::string render_name(std::string name);
+
 /**
  * @brief Base class for diagram generators
  *