Added initial support for MermaidJS sequence diagram

src/class_diagram/generators/mermaid/class_diagram_generator.cc

@@ -25,6 +25,7 @@
 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}
@@ -32,19 +33,6 @@ generator::generator(diagram_config &config, diagram_model &model)
 {
 }
 
-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
 {

src/class_diagram/generators/mermaid/class_diagram_generator.h

@@ -246,8 +246,6 @@ private:
     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
     {

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> {

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

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
  *

src/sequence_diagram/generators/mermaid/sequence_diagram_generator.h

@@ -0,0 +1,141 @@
+/**
+ * @file src/sequence_diagram/generators/mermaid/sequence_diagram_generator.h
+ *
+ * Copyright (c) 2021-2023 Bartek Kryza <bkryza@gmail.com>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#pragma once
+
+#include "common/generators/mermaid/generator.h"
+#include "config/config.h"
+#include "sequence_diagram/model/diagram.h"
+#include "sequence_diagram/visitor/translation_unit_visitor.h"
+#include "util/util.h"
+
+#include <glob/glob.hpp>
+
+#include <filesystem>
+#include <fstream>
+#include <iostream>
+#include <sstream>
+
+namespace clanguml {
+namespace sequence_diagram {
+namespace generators {
+namespace mermaid {
+
+using diagram_config = clanguml::config::sequence_diagram;
+using diagram_model = clanguml::sequence_diagram::model::diagram;
+
+template <typename C, typename D>
+using common_generator = clanguml::common::generators::mermaid::generator<C, D>;
+
+/**
+ * @brief Sequence diagram MermaidJS generator
+ */
+class generator : public common_generator<diagram_config, diagram_model> {
+public:
+    generator(diagram_config &config, diagram_model &model);
+
+    using common_generator<diagram_config, diagram_model>::generate;
+
+    /**
+     * @brief Main generator method.
+     *
+     * This method is called first and coordinates the entire diagram
+     * generation.
+     *
+     * @param ostr Output stream.
+     */
+    void generate_diagram(std::ostream &ostr) const override;
+
+    /**
+     * @brief Generate sequence diagram message.
+     *
+     * @param m Message model
+     * @param ostr Output stream
+     */
+    void generate_call(const clanguml::sequence_diagram::model::message &m,
+        std::ostream &ostr) const;
+
+    /**
+     * @brief Generate sequence diagram return message
+     *
+     * @param m Message model
+     * @param ostr Output stream
+     */
+    void generate_return(const clanguml::sequence_diagram::model::message &m,
+        std::ostream &ostr) const;
+
+    /**
+     * @brief Generate sequence diagram participant
+     *
+     * @param ostr Output stream
+     * @param id Participant id
+     * @param force If true, generate the participant even if its not in
+     *              the set of active participants
+     * @return Id of the generated participant
+     */
+    void generate_participant(
+        std::ostream &ostr, common::id_t id, bool force = false) const;
+
+    /**
+     * @brief Generate sequence diagram participant by name
+     *
+     * This is convenience wrapper over `generate_participant()` by id.
+     *
+     * @param ostr Output stream
+     * @param name Full participant name
+     */
+    void generate_participant(
+        std::ostream &ostr, const std::string &name) const;
+
+    /**
+     * @brief Generate sequence diagram activity.
+     *
+     * @param a Activity model
+     * @param ostr Output stream
+     * @param visited List of already visited participants, this is necessary
+     *                for breaking infinite recursion on recursive calls
+     */
+    void generate_activity(const clanguml::sequence_diagram::model::activity &a,
+        std::ostream &ostr,
+        std::vector<common::model::diagram_element::id_t> &visited) const;
+
+private:
+    /**
+     * @brief Check if specified participant has already been generated.
+     *
+     * @param id Participant id.
+     * @return True, if participant has already been generated.
+     */
+    bool is_participant_generated(common::id_t id) const;
+
+    /**
+     * @brief Generate MermaidJS alias for participant
+     *
+     * @param participant Sequence diagram participant model
+     * @return Particpant alias
+     */
+    std::string generate_alias(const model::participant &participant) const;
+
+    mutable std::set<common::id_t> generated_participants_;
+    model::function::message_render_mode
+    select_method_arguments_render_mode() const;
+};
+
+} // namespace mermaid
+} // namespace generators
+} // namespace sequence_diagram
+} // namespace clanguml

tests/t20001/test_case.h

@@ -66,4 +66,9 @@ TEST_CASE("t20001", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20002/test_case.h

@@ -60,4 +60,10 @@ TEST_CASE("t20002", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20003/test_case.h

@@ -55,4 +55,10 @@ TEST_CASE("t20003", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20004/test_case.h

@@ -82,4 +82,10 @@ TEST_CASE("t20004", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20005/test_case.h

@@ -56,4 +56,10 @@ TEST_CASE("t20005", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20007/test_case.h

@@ -66,4 +66,10 @@ TEST_CASE("t20007", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20008/test_case.h

@@ -76,4 +76,10 @@ TEST_CASE("t20008", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20009/test_case.h

@@ -68,4 +68,10 @@ TEST_CASE("t20009", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20010/test_case.h

@@ -70,4 +70,10 @@ TEST_CASE("t20010", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20011/test_case.h

@@ -63,4 +63,10 @@ TEST_CASE("t20011", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20013/test_case.h

@@ -67,4 +67,10 @@ TEST_CASE("t20013", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20014/test_case.h

@@ -66,4 +66,10 @@ TEST_CASE("t20014", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20015/test_case.h

@@ -61,4 +61,10 @@ TEST_CASE("t20015", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20016/test_case.h

@@ -59,4 +59,10 @@ TEST_CASE("t20016", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20017/test_case.h

@@ -73,4 +73,10 @@ TEST_CASE("t20017", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20018/test_case.h

@@ -76,4 +76,10 @@ TEST_CASE("t20018", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20019/test_case.h

@@ -59,4 +59,10 @@ TEST_CASE("t20019", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20020/test_case.h

@@ -79,4 +79,10 @@ TEST_CASE("t20020", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20021/test_case.h

@@ -85,4 +85,10 @@ TEST_CASE("t20021", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20022/test_case.h

@@ -53,4 +53,10 @@ TEST_CASE("t20022", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20023/test_case.h

@@ -57,4 +57,10 @@ TEST_CASE("t20023", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20024/test_case.h

@@ -63,4 +63,10 @@ TEST_CASE("t20024", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20025/test_case.h

@@ -57,4 +57,10 @@ TEST_CASE("t20025", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20026/test_case.h

@@ -51,4 +51,10 @@ TEST_CASE("t20026", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20027/test_case.h

@@ -53,4 +53,10 @@ TEST_CASE("t20027", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20028/test_case.h

@@ -59,4 +59,10 @@ TEST_CASE("t20028", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20029/test_case.h

@@ -83,4 +83,10 @@ TEST_CASE("t20029", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20030/test_case.h

@@ -62,4 +62,10 @@ TEST_CASE("t20030", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20031/test_case.h

@@ -65,4 +65,10 @@ TEST_CASE("t20031", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20032/test_case.h

@@ -75,4 +75,10 @@ TEST_CASE("t20032", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20033/test_case.h

@@ -54,4 +54,10 @@ TEST_CASE("t20033", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20034/test_case.h

@@ -73,4 +73,10 @@ TEST_CASE("t20034", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20035/test_case.h

@@ -53,4 +53,10 @@ TEST_CASE("t20035", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/t20036/test_case.h

@@ -69,4 +69,10 @@ TEST_CASE("t20036", "[test-case][sequence]")
 
         save_json(config.output_directory(), diagram->name + ".json", j);
     }
+
+    {
+        auto mmd = generate_sequence_mermaid(diagram, *model);
+
+        save_mermaid(config.output_directory(), diagram->name + ".mmd", mmd);
+    }
 }

tests/test_cases.cc

@@ -235,6 +235,14 @@ std::string generate_class_mermaid(
         config, model);
 }
 
+std::string generate_sequence_mermaid(
+    std::shared_ptr<clanguml::config::diagram> config,
+    clanguml::sequence_diagram::model::diagram &model)
+{
+    return detail::generate_diagram_mermaid<clanguml::config::sequence_diagram>(
+        config, model);
+}
+
 template <typename T>
 void save_diagram(const std::filesystem::path &path, const T &diagram)
 {

util/generate_mermaid.py

@@ -38,7 +38,7 @@ ok = 0
 for f in files:
     try:
         print(f'Generating Mermaid diagram from {f}')
-        f_svg = Path(f).with_suffix('.png')
+        f_svg = Path(f).with_suffix('.svg')
         subprocess.check_call(['mmdc',  '-i', f, '-o', f_svg])
     except subprocess.CalledProcessError:
         ok = 1