/** * @file tests/test_cases.h * * Copyright (c) 2021-2024 Bartek Kryza * * 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 #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_DEBUG #include "class_diagram/generators/mermaid/class_diagram_generator.h" #include "class_diagram/generators/plantuml/class_diagram_generator.h" #include "class_diagram/model/diagram.h" #include "class_diagram/visitor/translation_unit_visitor.h" #include "common/clang_utils.h" #include "common/compilation_database.h" #include "common/generators/generators.h" #include "config/config.h" #include "include_diagram/generators/plantuml/include_diagram_generator.h" #include "include_diagram/visitor/translation_unit_visitor.h" #include "package_diagram/generators/plantuml/package_diagram_generator.h" #include "package_diagram/visitor/translation_unit_visitor.h" #include "sequence_diagram/generators/plantuml/sequence_diagram_generator.h" #include "sequence_diagram/visitor/translation_unit_visitor.h" #include "util/util.h" #define DOCTEST_CONFIG_IMPLEMENT #include "doctest/doctest.h" #include #include #include #include #include #include using namespace clanguml::util; std::pair load_config(const std::string &test_name); namespace clanguml::test { template constexpr bool has_type() noexcept { return (std::is_same_v || ... || false); } struct Public { }; struct Protected { }; struct Private { }; struct Abstract { }; struct Static { }; struct Const { }; struct Constexpr { }; struct Consteval { }; struct Coroutine { }; struct Noexcept { }; struct Default { }; struct Deleted { }; struct Entrypoint { }; struct Exitpoint { }; struct CUDAKernel { }; struct CUDADevice { }; struct InControlCondition { }; struct Response { }; struct NamespacePackage { }; struct ModulePackage { }; struct DirectoryPackage { }; template std::string package_type_name(); template <> std::string package_type_name() { return "namespace"; } template <> std::string package_type_name() { return "module"; } template <> std::string package_type_name() { return "directory"; } template struct diagram_source_t { diagram_source_t(clanguml::common::model::diagram_t dt, T &&s) { diagram_type = dt; src = std::move(s); } bool contains(std::string name) const; virtual std::string get_alias(std::string name) const { return "__INVALID_ALIAS__"; } virtual std::string get_alias(std::string ns, std::string name) const { return get_alias(fmt::format("{}::{}", ns, name)); } bool search(const std::string &pattern) const; int64_t find(const std::string &pattern, int64_t offset = 0) const; std::string to_string() const; T src; clanguml::common::model::diagram_t diagram_type; bool generate_packages{false}; }; struct plantuml_t : public diagram_source_t { using diagram_source_t::diagram_source_t; using source_type = std::string; using generator_tag = clanguml::common::generators::plantuml_generator_tag; inline static const std::string diagram_type_name{"PlantUML"}; std::string get_alias(std::string name) const override { std::vector patterns; const std::string alias_regex("([A-Z]_[0-9]+)"); util::replace_all(name, "(", "\\("); util::replace_all(name, ")", "\\)"); util::replace_all(name, " ", "\\s"); util::replace_all(name, "*", "\\*"); util::replace_all(name, "[", "\\["); util::replace_all(name, "]", "\\]"); patterns.push_back( std::regex{"class\\s\"" + name + "\"\\sas\\s" + alias_regex}); patterns.push_back( std::regex{"abstract\\s\"" + name + "\"\\sas\\s" + alias_regex}); patterns.push_back( std::regex{"enum\\s\"" + name + "\"\\sas\\s" + alias_regex}); patterns.push_back( std::regex{"package\\s\"" + name + "\"\\sas\\s" + alias_regex}); patterns.push_back( std::regex{"package\\s\\[" + name + "\\]\\sas\\s" + alias_regex}); patterns.push_back( std::regex{"file\\s\"" + name + "\"\\sas\\s" + alias_regex}); patterns.push_back( std::regex{"folder\\s\"" + name + "\"\\sas\\s" + alias_regex}); patterns.push_back( std::regex{"participant\\s\"" + name + "\"\\sas\\s" + alias_regex}); std::smatch base_match; for (const auto &pattern : patterns) { if (std::regex_search(src, base_match, pattern) && base_match.size() == 2) { std::ssub_match base_sub_match = base_match[1]; std::string alias = base_sub_match.str(); return trim(alias); } } return fmt::format("__INVALID__ALIAS__({})", name); } }; struct mermaid_t : public diagram_source_t { using diagram_source_t::diagram_source_t; using source_type = std::string; using generator_tag = clanguml::common::generators::mermaid_generator_tag; inline static const std::string diagram_type_name{"MermaidJS"}; std::string get_alias_impl(std::string name) const { std::vector patterns; const std::string alias_regex("([A-Z]_[0-9]+)"); util::replace_all(name, "(", "("); util::replace_all(name, ")", ")"); util::replace_all(name, " ", "\\s"); util::replace_all(name, "*", "\\*"); util::replace_all(name, "[", "\\["); util::replace_all(name, "]", "\\]"); util::replace_all(name, "<", "<"); util::replace_all(name, ">", ">"); patterns.push_back( std::regex{"class\\s" + alias_regex + "\\[\"" + name + "\"\\]"}); patterns.push_back( std::regex{"subgraph\\s" + alias_regex + "\\[" + name + "\\]"}); patterns.push_back( std::regex{"\\s\\s" + alias_regex + "\\[" + name + "\\]"}); // file std::smatch base_match; for (const auto &pattern : patterns) { if (std::regex_search(src, base_match, pattern) && base_match.size() == 2) { std::ssub_match base_sub_match = base_match[1]; std::string alias = base_sub_match.str(); return trim(alias); } } return fmt::format("__INVALID__ALIAS__({})", name); } std::string get_alias_sequence_diagram_impl(std::string name) const { std::vector patterns; const std::string alias_regex("([A-Z]_[0-9]+)"); util::replace_all(name, "(", "\\("); util::replace_all(name, ")", "\\)"); util::replace_all(name, " ", "\\s"); util::replace_all(name, "*", "\\*"); util::replace_all(name, "[", "\\["); util::replace_all(name, "]", "\\]"); patterns.push_back(std::regex{ "participant\\s" + alias_regex + "\\sas\\s" + name + "\\n"}); patterns.push_back(std::regex{"participant\\s" + alias_regex + "\\sas\\s<< CUDA Kernel >>
" + name + "\\n"}); patterns.push_back(std::regex{"participant\\s" + alias_regex + "\\sas\\s<< CUDA Device >>
" + name + "\\n"}); std::smatch base_match; for (const auto &pattern : patterns) { if (std::regex_search(src, base_match, pattern) && base_match.size() == 2) { std::ssub_match base_sub_match = base_match[1]; std::string alias = base_sub_match.str(); return trim(alias); } } return fmt::format("__INVALID__ALIAS__({})", name); } std::string get_alias(std::string name) const override { if (diagram_type == common::model::diagram_t::kSequence) return get_alias_sequence_diagram_impl(name); return get_alias_impl(name); } }; struct json_t : public diagram_source_t { using diagram_source_t::diagram_source_t; using source_type = nlohmann::json; using generator_tag = clanguml::common::generators::json_generator_tag; inline static const std::string diagram_type_name{"JSON"}; }; std::optional get_element_by_id( const nlohmann::json &j, const std::string &id) { if (!j.contains("elements")) return {}; for (const nlohmann::json &e : j["elements"]) { if (e["id"] == id) return {e}; if (e["type"] == "namespace" || e["type"] == "folder") { auto maybe_e = get_element_by_id(e, id); if (maybe_e) return maybe_e; } } return {}; } std::optional get_element( const nlohmann::json &j, const std::string &name) { if (!j.contains("elements")) return {}; for (const nlohmann::json &e : j["elements"]) { if (e["display_name"] == name) return {e}; if (e["type"] == "namespace" || e["type"] == "folder" || e["type"] == "directory" || e["type"] == "module") { auto maybe_e = get_element(e, name); if (maybe_e) return maybe_e; } } return {}; } std::optional get_element( const json_t &src, const std::string &name) { return get_element(src.src, name); } std::optional get_participant( const nlohmann::json &j, const std::string &name) { if (!j.contains("participants")) return {}; for (const nlohmann::json &e : j.at("participants")) { if (e["display_name"] == name) return {e}; } return {}; } auto get_relationship(const nlohmann::json &j, const nlohmann::json &from, const nlohmann::json &to, const std::string &type, const std::string &label) { return std::find_if(j["relationships"].begin(), j["relationships"].end(), [&](const auto &it) { auto match = (it["source"] == from) && (it["destination"] == to) && (it["type"] == type); if (match && label.empty()) return true; if (match && (label == it["label"])) return true; return false; }); } auto get_relationship(const nlohmann::json &j, const std::string &from, const std::string &to, const std::string &type, const std::string &label = {}) { auto source = get_element(j, from); auto destination = get_element(j, to); if (!(source && destination)) return j["relationships"].end(); return get_relationship( j, source->at("id"), destination->at("id"), type, label); } std::string expand_name(const nlohmann::json &j, const std::string &name) { return name; } template <> bool diagram_source_t::contains(std::string name) const { return util::contains(src, name); } template <> int64_t diagram_source_t::find( const std::string &pattern, int64_t offset) const { std::regex pattern_regex{pattern}; std::smatch base_match; auto offset_it = src.begin(); std::advance(offset_it, offset); bool found = std::regex_search(offset_it, src.end(), base_match, pattern_regex); if (!found) return -1; return base_match.position(0); } template <> bool diagram_source_t::search(const std::string &pattern) const { return find(pattern) > -1; } template <> bool diagram_source_t::contains(std::string name) const { return false; } template <> std::string diagram_source_t::to_string() const { return src; } template <> std::string diagram_source_t::to_string() const { return src.dump(2); } struct QualifiedName { QualifiedName(const char *n) : name{n} { } QualifiedName(std::string_view n) : name{n} { } QualifiedName(std::string_view ns_, std::string_view n) : ns{ns_} , name{n} { } QualifiedName(const char *ns_, const char *n) : ns{ns_} , name{n} { } operator std::string() const { return str(); } std::string str(bool generate_packages = false) const { if (ns && !generate_packages) return fmt::format("{}::{}", ns.value(), name); return name; } std::optional ns; std::string name; }; struct Message { template Message(QualifiedName f, QualifiedName t, std::string m, Attrs &&...attrs) : from{std::move(f)} , to{std::move(t)} , message{std::move(m)} , is_static{has_type()} , is_incontrolcondition{has_type()} , is_response{has_type()} , is_cuda_kernel{has_type()} , is_cuda_device{has_type()} { } template Message(Entrypoint &&e, QualifiedName t, std::string m, Attrs &&...attrs) : Message(QualifiedName{""}, std::move(t), {}, std::forward(attrs)...) { is_entrypoint = true; } template Message(Exitpoint &&e, QualifiedName t, Attrs &&...attrs) : Message(QualifiedName{""}, std::move(t), {}, std::forward(attrs)...) { is_exitpoint = true; } QualifiedName from; QualifiedName to; std::string message; std::optional return_type; bool is_static{false}; bool is_entrypoint{false}; bool is_exitpoint{false}; bool is_incontrolcondition{false}; bool is_response{false}; bool is_cuda_kernel{false}; bool is_cuda_device{false}; }; /// /// The following functions declarations define various checks on generated /// diagrams. /// They must be specialized for each diagram format (DiagramType) separately. /// /// @defgroup Test Cases diagram checks /// @{ /// // Check if generated diagram source starts with pattern template bool StartsWith(const DiagramType &d, std::string pattern); // Check if generated diagram source ends with pattern template bool EndsWith(const DiagramType &d, std::string pattern); template bool HasTitle(const DiagramType &d, std::string const &str); // Check if generated diagram contains a specified enum template bool IsEnum(const DiagramType &d, QualifiedName name); // Check if generated diagram contains a specified union template bool IsUnion(const DiagramType &d, QualifiedName name); // Check if generated diagram contains a specified class template bool IsClass(const DiagramType &d, QualifiedName name); // Check if generated diagram contains a specified class template template bool IsClassTemplate(const DiagramType &d, QualifiedName name); template bool IsAbstractClassTemplate(const DiagramType &d, QualifiedName name); // Check if generated diagram contains a specified abstract class template bool IsAbstractClass(const DiagramType &d, QualifiedName name); // Check if generated diagram contains a specified class template bool IsBaseClass( const DiagramType &d, QualifiedName base, QualifiedName subclass); template bool IsInnerClass( const DiagramType &d, std::string const &parent, std::string const &inner); template bool IsMethod(const DiagramType &d, const std::string &cls, const std::string &name, const std::string &type = "void", const std::string ¶ms = ""); template bool IsField(const DiagramType &d, QualifiedName cls, std::string const &name, std::string type = "void"); template bool IsAssociation(const DiagramType &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = ""); template bool IsComposition(const DiagramType &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = ""); template bool IsAggregation(const DiagramType &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = ""); template bool IsInstantiation(const DiagramType &d, std::string const &from, std::string const &to, std::string style = ""); template bool IsDependency(const DiagramType &d, QualifiedName from, QualifiedName to, std::string style = ""); template bool IsFriend( const DiagramType &d, std::string const &from, std::string const &to); template bool IsPackageDependency( const DiagramType &d, std::string const &from, std::string const &to); template bool IsIncludeDependency( const DiagramType &d, std::string const &from, std::string const &to); template bool IsConstraint(const DiagramType &d, QualifiedName from, QualifiedName to, std::string label = {}, std::string style = ""); template bool IsConcept(const DiagramType &d, QualifiedName cpt); template bool IsConceptParameterList( const DiagramType &d, std::string const &cpt, std::string param); template bool IsConceptRequirement( const DiagramType &d, std::string const &cpt, std::string requirement); template bool IsLayoutHint(const DiagramType &d, std::string const &from, std::string const &hint, std::string const &to); template bool HasComment(const DiagramType &d, std::string const &comment); template bool HasNote(const DiagramType &d, std::string const &cls, std::string const &position, std::string const ¬e = ""); template bool HasPackageNote(const DiagramType &d, std::string const &cls, std::string const &position, std::string const ¬e = ""); template bool HasMessageComment( const DiagramType &d, std::string const &alias, std::string const ¬e); template bool HasMemberNote(const DiagramType &d, std::string const &cls, std::string const &member, std::string const &position, std::string const ¬e = ""); template bool HasLink(const DiagramType &d, std::string const &alias, std::string const &link, std::string const &tooltip); template bool HasMemberLink(const DiagramType &d, std::string const &method, std::string const &link, std::string const &tooltip); template bool IsFolder(const DiagramType &d, std::string const &path); template bool IsFile(const DiagramType &d, std::string const &str); template bool IsSystemHeader(const DiagramType &d, std::string const &str); template bool IsHeaderDependency(const DiagramType &d, std::string const &from, std::string const &to, std::string style = ""); template bool IsSystemHeaderDependency(const DiagramType &d, std::string const &from, std::string const &to, std::string style = ""); template bool IsNamespacePackage(const DiagramType &d, Args... args); template bool IsDirectoryPackage(const DiagramType &d, Args... args); template bool IsModulePackage(const DiagramType &d, Args... args); template bool IsDeprecated(const DiagramType &d, std::string const &str); template int64_t FindMessage(const DiagramType &d, const Message &msg, int64_t offset = 0, bool fail = true); template bool HasMessage(const DiagramType &d, const Message &msg) { return FindMessage(d, msg, 0, false) >= 0; } template bool MessageOrder(const DiagramType &d, std::vector messages) { std::vector order; int64_t offset{0}; order.reserve(messages.size()); std::transform(messages.begin(), messages.end(), std::back_inserter(order), [&d, &offset](const auto &m) { offset = FindMessage(d, m, offset); return offset; }); bool are_messages_in_order = std::is_sorted(order.begin(), order.end()); if (!are_messages_in_order) { FAIL(fmt::format( "Messages are not in order: \n[{}]", fmt::join(order, ",\n"))); return false; } return true; } template bool MessageChainsOrder( const DiagramType &d, std::vector> message_chains) { // Try to match each chain to each sequence - sequence order depends // on platform and LLVM version for (const auto &message_chain : message_chains) { if (!MessageOrder(d, message_chain)) return false; } return true; } template bool IsParticipant( const DiagramType &d, const std::string &name, const std::string &type); template bool IsFunctionParticipant(const DiagramType &d, const std::string &name) { return IsParticipant(d, name, "function"); } template bool IsFunctionTemplateParticipant( const DiagramType &d, const std::string &name) { return IsParticipant(d, name, "function_template"); } template bool IsClassParticipant(const DiagramType &d, const std::string &name) { return IsParticipant(d, name, "class"); } template bool IsFileParticipant(const DiagramType &d, const std::string &name) { return IsParticipant(d, name, "file"); } /// /// @} /// template <> bool StartsWith(const plantuml_t &d, std::string pattern) { return util::starts_with(d.src, pattern); } template <> bool EndsWith(const plantuml_t &d, std::string pattern) { return util::ends_with(d.src, pattern); } template <> bool HasTitle(const plantuml_t &d, std::string const &str) { return d.contains("title " + str); } template <> bool IsEnum(const plantuml_t &d, QualifiedName enm) { return d.contains( fmt::format("enum {}", d.get_alias(enm.str(d.generate_packages)))); } template <> bool IsUnion(const plantuml_t &d, QualifiedName cls) { return d.contains(fmt::format( "class {} <>", d.get_alias(cls.str(d.generate_packages)))); } template <> bool IsClass(const plantuml_t &d, QualifiedName cls) { return d.contains( fmt::format("class {}", d.get_alias(cls.str(d.generate_packages)))); } template <> bool IsClassTemplate(const plantuml_t &d, QualifiedName cls) { return d.contains( fmt::format("class \"{}\"", cls.str(d.generate_packages))); } template <> bool IsAbstractClassTemplate(const plantuml_t &d, QualifiedName cls) { return d.contains( fmt::format("abstract \"{}\"", cls.str(d.generate_packages))); } template <> bool IsAbstractClass(const plantuml_t &d, QualifiedName cls) { return d.contains( fmt::format("abstract {}", d.get_alias(cls.str(d.generate_packages)))); } template <> bool IsBaseClass( const plantuml_t &d, QualifiedName base, QualifiedName subclass) { return d.contains( fmt::format("{} <|-- {}", d.get_alias(base.str(d.generate_packages)), d.get_alias(subclass.str(d.generate_packages)))); } template <> bool IsInnerClass( const plantuml_t &d, std::string const &parent, std::string const &inner) { return d.contains(d.get_alias(inner) + " --+ " + d.get_alias(parent)); } template bool IsMethod(const plantuml_t &d, std::string const &cls, std::string const &name, std::string const &type = "void", std::string const ¶ms = "") { std::string pattern; if constexpr (has_type()) pattern += "{static} "; if constexpr (has_type()) pattern += "{abstract} "; if constexpr (has_type()) pattern = "+"; else if constexpr (has_type()) pattern = "#"; else pattern = "-"; pattern += name; pattern += "(" + params + ")"; if constexpr (has_type()) pattern += " constexpr"; if constexpr (has_type()) pattern += " consteval"; if constexpr (has_type()) pattern += " const"; if constexpr (has_type()) pattern += " = 0"; if constexpr (has_type()) pattern += " = default"; if constexpr (has_type()) pattern += " = deleted"; if constexpr (has_type()) pattern += " [coroutine]"; pattern += " : " + type; return d.contains(pattern); } template bool IsField(const plantuml_t &d, QualifiedName cls, std::string const &name, std::string type) { std::string pattern; if constexpr (has_type()) pattern += "{static} "; if constexpr (has_type()) pattern = "+"; else if constexpr (has_type()) pattern = "#"; else pattern = "-"; pattern += name; return d.contains(pattern + " : " + type); } template bool IsAssociation(const plantuml_t &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = "") { auto from_id = d.get_alias(from); auto to_id = d.get_alias(to); std::string format_string = "{}"; if (!multiplicity_source.empty()) format_string += " \"" + multiplicity_source + "\""; format_string += fmt::format(" -{}->", style); if (!multiplicity_dest.empty()) format_string += " \"" + multiplicity_dest + "\""; format_string += " {}"; if (!label.empty()) { std::string label_prefix; if constexpr (has_type()) label_prefix = "+"; else if constexpr (has_type()) label_prefix = "#"; else label_prefix = "-"; format_string += " : {}{}"; return d.contains(fmt::format( fmt::runtime(format_string), from_id, to_id, label_prefix, label)); } return d.contains(fmt::format(fmt::runtime(format_string), from_id, to_id)); } template bool IsComposition(const plantuml_t &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = "") { std::string label_prefix; if constexpr (has_type()) label_prefix = "+"; else if constexpr (has_type()) label_prefix = "#"; else label_prefix = "-"; std::string format_string = "{}"; if (!multiplicity_source.empty()) format_string += " \"" + multiplicity_source + "\""; format_string += fmt::format(" *-{}-", style); if (!multiplicity_dest.empty()) format_string += " \"" + multiplicity_dest + "\""; format_string += " {} : {}{}"; return d.contains(fmt::format(fmt::runtime(format_string), d.get_alias(from), d.get_alias(to), label_prefix, label)); } template bool IsAggregation(const plantuml_t &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = "") { std::string label_prefix; if constexpr (has_type()) label_prefix = "+"; else if constexpr (has_type()) label_prefix = "#"; else label_prefix = "-"; std::string format_string = "{}"; if (!multiplicity_source.empty()) format_string += " \"" + multiplicity_source + "\""; format_string += fmt::format(" o-{}-", style); if (!multiplicity_dest.empty()) format_string += " \"" + multiplicity_dest + "\""; format_string += " {} : {}{}"; return d.contains(fmt::format(fmt::runtime(format_string), d.get_alias(from), d.get_alias(to), label_prefix, label)); } template <> bool IsInstantiation(const plantuml_t &d, std::string const &from, std::string const &to, std::string style) { return d.contains( fmt::format("{} .{}.|> {}", d.get_alias(to), style, d.get_alias(from))); } template <> bool IsDependency(const plantuml_t &d, QualifiedName from, QualifiedName to, std::string style) { return d.contains(fmt::format( "{} .{}.> {}", d.get_alias(from), style, d.get_alias(to))) || d.contains(fmt::format("{} .{}.> {}", d.get_alias(from.name), style, d.get_alias(to.name))); } template bool IsFriend( const plantuml_t &d, std::string const &from, std::string const &to) { std::string pattern; if constexpr (has_type()) pattern = "+"; else if constexpr (has_type()) pattern = "#"; else pattern = "-"; return d.contains(fmt::format("{} <.. {} : {}<>", d.get_alias(from), d.get_alias(to), pattern)); } template <> bool IsPackageDependency( const plantuml_t &d, std::string const &from, std::string const &to) { return d.contains( fmt::format("{} .{}.> {}", d.get_alias(from), "", d.get_alias(to))); } template <> bool IsIncludeDependency( const plantuml_t &d, std::string const &from, std::string const &to) { return d.contains( fmt::format("{} .{}.> {}", d.get_alias(from), "", d.get_alias(to))); } template <> bool IsConstraint(const plantuml_t &d, QualifiedName from, QualifiedName to, std::string label, std::string style) { if (label.empty()) return d.contains(fmt::format("{} .{}.> {}", d.get_alias(from.name), style, d.get_alias(to.name))); return d.contains(fmt::format("{} .{}.> {} : {}", d.get_alias(from.name), style, d.get_alias(to.name), label)); } template <> bool IsConcept(const plantuml_t &d, QualifiedName cpt) { return d.contains("class " + d.get_alias(cpt) + " <>") || d.contains("class " + d.get_alias(cpt.name) + " <>"); } template <> bool IsConceptRequirement( const plantuml_t &d, std::string const &cpt, std::string requirement) { return d.contains(requirement); } template <> bool IsConceptParameterList( const plantuml_t &d, std::string const &cpt, std::string params) { return d.contains(params); } template <> bool IsLayoutHint(const plantuml_t &d, std::string const &from, std::string const &hint, std::string const &to) { return d.contains(fmt::format( "{} -[hidden]{}- {}", d.get_alias(from), hint, d.get_alias(to))); } template <> bool HasComment(const plantuml_t &d, std::string const &comment) { return d.contains(fmt::format("' {}", comment)); } template <> bool HasNote(const plantuml_t &d, std::string const &cls, std::string const &position, std::string const ¬e) { return d.contains(fmt::format("note {} of {}", position, d.get_alias(cls))); } template <> bool HasMemberNote(const plantuml_t &d, std::string const &cls, std::string const &member, std::string const &position, std::string const ¬e) { return d.contains( fmt::format("note {} of {}::{}", position, d.get_alias(cls), member)); } template <> bool HasPackageNote(const plantuml_t &d, std::string const &cls, std::string const &position, std::string const ¬e) { return d.contains(fmt::format("note {} of {}", position, d.get_alias(cls))); } template <> bool HasLink(const plantuml_t &d, std::string const &element, std::string const &link, std::string const &tooltip) { return d.contains( fmt::format("{} [[{}{{{}}}]]", d.get_alias(element), link, tooltip)); } template <> bool HasMemberLink(const plantuml_t &d, std::string const &method, std::string const &link, std::string const &tooltip) { return d.contains(fmt::format("{} [[[{}{{{}}}]]]", method, link, tooltip)); } template <> bool IsFolder(const plantuml_t &d, std::string const &path) { return d.contains("folder \"" + util::split(path, "/").back() + "\""); } template <> bool IsFile(const plantuml_t &d, std::string const &path) { return d.contains("file \"" + util::split(path, "/").back() + "\""); } template <> bool IsSystemHeader(const plantuml_t &d, std::string const &path) { return d.contains("file \"" + path + "\""); } template <> bool IsHeaderDependency(const plantuml_t &d, std::string const &from, std::string const &to, std::string style) { assert(d.diagram_type == common::model::diagram_t::kInclude); return d.contains( fmt::format("{} --> {}", d.get_alias(util::split(from, "/").back()), d.get_alias(util::split(to, "/").back()))); } template <> bool IsSystemHeaderDependency(const plantuml_t &d, std::string const &from, std::string const &to, std::string style) { assert(d.diagram_type == common::model::diagram_t::kInclude); return d.contains( fmt::format("{} ..> {}", d.get_alias(util::split(from, "/").back()), d.get_alias(util::split(to, "/").back()))); } template auto get_last(Args &&...args) { return std::get(std::forward_as_tuple(args...)); } template bool IsNamespacePackage(const plantuml_t &d, Args... args) { const auto &name = get_last(args...); return d.contains("package [" + name + "]"); } template bool IsDirectoryPackage(const plantuml_t &d, Args... args) { const auto &name = get_last(args...); return d.contains("package [" + name + "]"); } template bool IsModulePackage(const plantuml_t &d, Args... args) { const auto &name = get_last(args...); return d.contains("package [" + name + "]"); } template <> bool IsDeprecated(const plantuml_t &d, const std::string &name) { return d.contains(d.get_alias(name) + " <> "); } template <> int64_t FindMessage( const plantuml_t &d, const Message &msg, int64_t offset, bool fail) { auto msg_str = msg.message; util::replace_all(msg_str, "(", "\\("); util::replace_all(msg_str, ")", "\\)"); util::replace_all(msg_str, "*", "\\*"); util::replace_all(msg_str, "[", "\\["); util::replace_all(msg_str, "]", "\\]"); util::replace_all(msg_str, "+", "\\+"); if (msg.is_cuda_kernel) msg_str = fmt::format("<< CUDA Kernel >>\\\\n{}", msg_str); if (msg.is_cuda_device) msg_str = fmt::format("<< CUDA Device >>\\\\n{}", msg_str); std::string style; if (msg.is_static) style = "__"; std::string call_pattern{"__INVALID__"}; if (msg.is_entrypoint) { call_pattern = fmt::format("\\[-> {} : {}", d.get_alias(msg.to), msg_str); } else if (msg.is_exitpoint) { call_pattern = fmt::format("\\[<-- {}", d.get_alias(msg.to)); } else if (msg.is_incontrolcondition) { call_pattern = fmt::format( "{} {} {} " "(\\[\\[.*\\]\\] )?: \\*\\*\\[\\*\\*{}{}{}\\*\\*\\]\\*\\*", d.get_alias(msg.from), "->", d.get_alias(msg.to), style, msg_str, style); } else if (msg.is_response) { call_pattern = fmt::format("{} {} {} : //{}//", d.get_alias(msg.from), "-->", d.get_alias(msg.to), msg_str); } else { call_pattern = fmt::format("{} {} {} " "(\\[\\[.*\\]\\] )?: {}{}{}", d.get_alias(msg.from), "->", d.get_alias(msg.to), style, msg_str, style); } auto match_offset = d.find(call_pattern, offset); if (match_offset < 0) { if (fail) FAIL(fmt::format("Missing message: {} -> {} {} ({})", msg.from.str(), msg.to.str(), msg.message, call_pattern)); return -1; } return match_offset + offset; } template <> bool HasMessageComment(const plantuml_t &d, std::string const &participant, std::string const ¬e) { std::string note_escaped{note}; util::replace_all(note_escaped, "(", "\\("); util::replace_all(note_escaped, ")", "\\)"); return d.search(fmt::format("note over {}\\n{}\\nend note", d.get_alias(participant), note_escaped)); } template <> bool IsParticipant( const plantuml_t &d, const std::string &name, const std::string &type) { return d.contains( fmt::format("participant \"{}\" as ", name, d.get_alias(name))); } // // MermaidJS test helpers // template <> bool HasTitle(const mermaid_t &d, std::string const &str) { return d.contains("title: " + str); } template <> bool IsEnum(const mermaid_t &d, QualifiedName enm) { return d.search(std::string("class ") + d.get_alias(enm) + " \\{\\n\\s+<>"); } template <> bool IsUnion(const mermaid_t &d, QualifiedName cls) { return d.search( std::string("class ") + d.get_alias(cls) + " \\{\\n\\s+<>"); } template <> bool IsClass(const mermaid_t &d, QualifiedName cls) { return d.contains(fmt::format("class {}", d.get_alias(cls))); } template <> bool IsClassTemplate(const mermaid_t &d, QualifiedName cls) { return d.contains(fmt::format("class {}", d.get_alias(cls))); } template <> bool IsAbstractClassTemplate(const mermaid_t &d, QualifiedName cls) { return d.search( std::string("class ") + d.get_alias(cls) + " \\{\\n\\s+<>"); } template <> bool IsAbstractClass(const mermaid_t &d, QualifiedName name) { return d.search( std::string("class ") + d.get_alias(name) + " \\{\\n\\s+<>"); } template <> bool IsBaseClass(const mermaid_t &d, QualifiedName base, QualifiedName subclass) { return d.contains( fmt::format("{} <|-- {}", d.get_alias(base), d.get_alias(subclass))); } template <> bool IsInnerClass( const mermaid_t &d, std::string const &parent, std::string const &inner) { return d.contains(d.get_alias(parent) + " ()-- " + d.get_alias(inner)); } template bool IsMethod(const mermaid_t &d, std::string const &cls, std::string const &name, std::string type = "void", std::string const ¶ms = "") { std::string pattern; if constexpr (has_type()) pattern = "+"; else if constexpr (has_type()) pattern = "#"; else pattern = "-"; pattern += name; pattern += "(" + params + ")"; std::vector method_mods; if constexpr (has_type()) method_mods.push_back("default"); if constexpr (has_type()) method_mods.push_back("const"); if constexpr (has_type()) method_mods.push_back("constexpr"); if constexpr (has_type()) method_mods.push_back("consteval"); if constexpr (has_type()) method_mods.push_back("coroutine"); pattern += " : "; if (!method_mods.empty()) { pattern += fmt::format("[{}] ", fmt::join(method_mods, ",")); } util::replace_all(type, "<", "<"); util::replace_all(type, ">", ">"); util::replace_all(type, "(", "("); util::replace_all(type, ")", ")"); util::replace_all(type, "##", "::"); util::replace_all(type, "{", "{"); util::replace_all(type, "}", "}"); pattern += type; if constexpr (has_type()) pattern += "*"; if constexpr (has_type()) pattern += "$"; return d.contains(pattern); } template bool IsField(const mermaid_t &d, QualifiedName cls, std::string const &name, std::string type) { std::string pattern; if constexpr (has_type()) pattern += "{static} "; if constexpr (has_type()) pattern = "+"; else if constexpr (has_type()) pattern = "#"; else pattern = "-"; pattern += name; util::replace_all(type, "<", "<"); util::replace_all(type, ">", ">"); util::replace_all(type, "(", "("); util::replace_all(type, ")", ")"); util::replace_all(type, "##", "::"); util::replace_all(type, "{", "{"); util::replace_all(type, "}", "}"); return d.contains(pattern + " : " + type); } template bool IsAssociation(const mermaid_t &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = "") { auto from_id = d.get_alias(from); auto to_id = d.get_alias(to); std::string label_prefix; if constexpr (has_type()) label_prefix = "+"; else if constexpr (has_type()) label_prefix = "#"; else label_prefix = "-"; std::string format_string = "{}"; if (!multiplicity_source.empty()) format_string += " \"" + multiplicity_source + "\""; format_string += " -->"; if (!multiplicity_dest.empty()) format_string += " \"" + multiplicity_dest + "\""; format_string += " {}"; if (!label.empty()) { format_string += " : {}{}"; return d.contains(fmt::format( fmt::runtime(format_string), from_id, to_id, label_prefix, label)); } return d.contains(fmt::format(fmt::runtime(format_string), from_id, to_id)); } template bool IsComposition(const mermaid_t &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = "") { std::string label_prefix; if constexpr (has_type()) label_prefix = "+"; else if constexpr (has_type()) label_prefix = "#"; else label_prefix = "-"; std::string format_string = "{}"; if (!multiplicity_source.empty()) format_string += " \"" + multiplicity_source + "\""; format_string += fmt::format(" *--", style); if (!multiplicity_dest.empty()) format_string += " \"" + multiplicity_dest + "\""; format_string += " {} : {}{}"; return d.contains(fmt::format(fmt::runtime(format_string), d.get_alias(from), d.get_alias(to), label_prefix, label)); } template bool IsAggregation(const mermaid_t &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = "") { std::string label_prefix; if constexpr (has_type()) label_prefix = "+"; else if constexpr (has_type()) label_prefix = "#"; else label_prefix = "-"; std::string format_string = "{}"; if (!multiplicity_source.empty()) format_string += " \"" + multiplicity_source + "\""; format_string += " o--"; if (!multiplicity_dest.empty()) format_string += " \"" + multiplicity_dest + "\""; format_string += " {} : {}{}"; return d.contains(fmt::format(fmt::runtime(format_string), d.get_alias(from), d.get_alias(to), label_prefix, label)); } template <> bool IsInstantiation(const mermaid_t &d, std::string const &from, std::string const &to, std::string style) { return d.contains( fmt::format("{} ..|> {}", d.get_alias(to), d.get_alias(from))); } template <> bool IsDependency( const mermaid_t &d, QualifiedName from, QualifiedName to, std::string style) { if (d.diagram_type == common::model::diagram_t::kClass) { return d.contains( fmt::format("{} ..> {}", d.get_alias(from), d.get_alias(to))); } return d.contains( fmt::format("{} -.-> {}", d.get_alias(from), d.get_alias(to))); } template <> bool IsHeaderDependency(const mermaid_t &d, std::string const &from, std::string const &to, std::string style) { assert(d.diagram_type == common::model::diagram_t::kInclude); return d.contains( fmt::format("{} --> {}", d.get_alias(util::split(from, "/").back()), d.get_alias(util::split(to, "/").back()))); } template <> bool IsSystemHeaderDependency(const mermaid_t &d, std::string const &from, std::string const &to, std::string style) { assert(d.diagram_type == common::model::diagram_t::kInclude); return d.contains( fmt::format("{} -.-> {}", d.get_alias(util::split(from, "/").back()), d.get_alias(util::split(to, "/").back()))); } template bool IsFriend( const mermaid_t &d, std::string const &from, std::string const &to) { std::string pattern; if constexpr (has_type()) pattern = "+"; else if constexpr (has_type()) pattern = "#"; else pattern = "-"; return d.contains(fmt::format( "{} <.. {} : {}[friend]", d.get_alias(from), d.get_alias(to), pattern)); } template <> bool IsPackageDependency( const mermaid_t &d, std::string const &from, std::string const &to) { return d.contains( fmt::format("{} -.-> {}", d.get_alias(from), "", d.get_alias(to))); } template <> bool IsIncludeDependency( const mermaid_t &d, std::string const &from, std::string const &to) { return d.contains( fmt::format("{} -.-> {}", d.get_alias(from), "", d.get_alias(to))); } template <> bool IsConstraint(const mermaid_t &d, QualifiedName from, QualifiedName to, std::string label, std::string style) { auto from_id = d.get_alias(from); auto to_id = d.get_alias(to); if (label.empty()) return d.contains(fmt::format("{} ..> {}", from_id, "", to_id)); util::replace_all(label, "<", "<"); util::replace_all(label, ">", ">"); util::replace_all(label, "(", "("); util::replace_all(label, ")", ")"); util::replace_all(label, "##", "::"); util::replace_all(label, "{", "{"); util::replace_all(label, "}", "}"); if (label.empty()) return d.contains(fmt::format("{} ..> {}", from_id, to_id)); return d.contains(fmt::format("{} ..> {} : {}", from_id, to_id, label)); } template <> bool IsConcept(const mermaid_t &d, QualifiedName cpt) { return d.search( std::string("class ") + d.get_alias(cpt) + " \\{\\n\\s+<>"); } template <> bool IsConceptRequirement( const mermaid_t &d, std::string const &cpt, std::string requirement) { util::replace_all(requirement, "<", "<"); util::replace_all(requirement, ">", ">"); util::replace_all(requirement, "##", "::"); util::replace_all(requirement, "{", "{"); util::replace_all(requirement, "}", "}"); return d.contains(requirement); } template <> bool IsConceptParameterList( const mermaid_t &d, std::string const &cpt, std::string params) { util::replace_all(params, "<", "<"); util::replace_all(params, ">", ">"); util::replace_all(params, "##", "::"); util::replace_all(params, "{", "{"); util::replace_all(params, "}", "}"); return d.contains(params); } template <> bool IsLayoutHint(const mermaid_t &d, std::string const &from, std::string const &hint, std::string const &to) { return true; } template <> bool HasComment(const mermaid_t &d, std::string const &comment) { return d.contains(fmt::format("%% {}", comment)); } template <> bool HasNote(const mermaid_t &d, std::string const &cls, std::string const &position, std::string const ¬e) { if (d.diagram_type == common::model::diagram_t::kPackage) { return d.contains(fmt::format("-.- {}", d.get_alias(cls))); } return d.contains(fmt::format("note for {}", d.get_alias(cls))); } template <> bool HasMemberNote(const mermaid_t &d, std::string const &cls, std::string const &member, std::string const &position, std::string const ¬e) { return d.contains( fmt::format("note for {} \"{}\"", d.get_alias(cls), note)); } template <> bool HasPackageNote(const mermaid_t &d, std::string const &cls, std::string const &position, std::string const ¬e) { return d.contains(fmt::format("-.- {}", d.get_alias(cls))); } template <> bool HasLink(const mermaid_t &d, std::string const &element, std::string const &link, std::string const &tooltip) { return d.contains(fmt::format( "click {} href \"{}\" \"{}\"", d.get_alias(element), link, tooltip)); } template <> bool HasMemberLink(const mermaid_t &d, std::string const &method, std::string const &link, std::string const &tooltip) { return true; } template <> bool IsFolder(const mermaid_t &d, std::string const &path) { return d.contains("subgraph " + d.get_alias(util::split(path, "/").back())); } template <> bool IsFile(const mermaid_t &d, std::string const &path) { return d.contains(d.get_alias(util::split(path, "/").back()) + "["); } template <> bool IsSystemHeader(const mermaid_t &d, std::string const &path) { return d.contains(d.get_alias(path) + "["); } template bool IsNamespacePackage(const mermaid_t &d, Args... args) { if (d.diagram_type == class_diagram::model::diagram_t::kClass) { std::vector toks{{args...}}; return d.contains(fmt::format("[\"{}", fmt::join(toks, "::"))); } const auto &name = get_last(args...); return d.contains(fmt::format("subgraph {}", d.get_alias(name))); } template bool IsDirectoryPackage(const mermaid_t &d, Args... args) { if (d.diagram_type == class_diagram::model::diagram_t::kClass) { // MermaidJS does not support packages in class diagrams return true; } const auto &name = get_last(args...); return d.contains("subgraph " + d.get_alias(name)); } template bool IsModulePackage(const mermaid_t &d, Args... args) { if (d.diagram_type == class_diagram::model::diagram_t::kClass) { // MermaidJS does not support packages in class diagrams return true; } const auto &name = get_last(args...); return d.contains("subgraph " + d.get_alias(name)); } template <> bool IsDeprecated(const mermaid_t &d, const std::string &name) { return d.contains(d.get_alias(name)); } template <> int64_t FindMessage( const mermaid_t &d, const Message &msg, int64_t offset, bool fail) { auto msg_str = msg.message; util::replace_all(msg_str, "(", "\\("); util::replace_all(msg_str, ")", "\\)"); util::replace_all(msg_str, "*", "\\*"); util::replace_all(msg_str, "[", "\\["); util::replace_all(msg_str, "]", "\\]"); util::replace_all(msg_str, "+", "\\+"); if (msg.is_cuda_kernel) msg_str = fmt::format("<< CUDA Kernel >>
{}", msg_str); if (msg.is_cuda_device) msg_str = fmt::format("<< CUDA Device >>
{}", msg_str); std::string call_pattern{"__INVALID__"}; if (msg.is_entrypoint) { call_pattern = fmt::format("\\* ->> {} : {}", d.get_alias(msg.to), msg_str); } else if (msg.is_exitpoint) { call_pattern = fmt::format("{} -->> \\*", d.get_alias(msg.to), msg_str); } else if (msg.is_incontrolcondition) { call_pattern = fmt::format("{} {} {} : \\[{}\\]", d.get_alias(msg.from), "->>", d.get_alias(msg.to), msg_str); } else if (msg.is_response) { call_pattern = fmt::format("{} {} {} : {}", d.get_alias(msg.from), "-->>", d.get_alias(msg.to), msg_str); } else { call_pattern = fmt::format("{} {} {} : {}", d.get_alias(msg.from), "->>", d.get_alias(msg.to), msg_str); } auto match_offset = d.find(call_pattern, offset); if (match_offset < 0) { if (fail) FAIL(fmt::format("Missing message: {} -> {} {} ({})", msg.from.str(), msg.to.str(), msg.message, call_pattern)); return -1; } return match_offset + offset; } template <> bool HasMessageComment( const mermaid_t &d, std::string const &participant, std::string const ¬e) { std::string note_escaped{note}; util::replace_all(note_escaped, "\\n", "
"); return d.contains(std::string("note over ") + d.get_alias(participant) + ": " + note_escaped); } template <> bool IsParticipant( const mermaid_t &d, const std::string &name, const std::string &type) { return d.contains(fmt::format("participant {}", d.get_alias(name))); } // // JSON test helpers // struct File { explicit File(const std::string &f) : file{f} { } const std::string file; }; template <> bool HasTitle(const json_t &d, std::string const &str) { return d.src.contains("title") && d.src["title"] == str; } template <> bool IsAbstractClass(const json_t &d, QualifiedName cls) { auto e = get_element(d.src, expand_name(d.src, cls.str(d.generate_packages))); return e && e->at("type") == "class" && e->at("is_abstract"); } template <> bool IsEnum(const json_t &d, QualifiedName enm) { auto e = get_element(d.src, expand_name(d.src, enm.str(d.generate_packages))); return e && e->at("type") == "enum"; } template <> bool IsUnion(const json_t &d, QualifiedName enm) { auto e = get_element(d.src, expand_name(d.src, enm.str(d.generate_packages))); return e && e->at("type") == "class" && e->at("is_union"); } template <> bool IsClass(const json_t &d, QualifiedName cls) { auto e = get_element(d.src, expand_name(d.src, cls.str(d.generate_packages))); return e && e->at("type") == "class" && !e->at("is_abstract"); } template <> bool IsClassTemplate(const json_t &d, QualifiedName cls) { auto e = get_element(d.src, expand_name(d.src, cls.str(d.generate_packages))); return e && e->at("type") == "class"; } template <> bool IsAbstractClassTemplate(const json_t &d, QualifiedName cls) { auto e = get_element(d.src, expand_name(d.src, cls.str(d.generate_packages))); return e && e->at("type") == "class" && e->at("is_abstract"); } template <> bool IsBaseClass(const json_t &d, QualifiedName base, QualifiedName subclass) { const auto &j = d.src; auto base_el = get_element(j, expand_name(j, base.str(d.generate_packages))); auto subclass_el = get_element(j, expand_name(j, subclass.str(d.generate_packages))); if (!base_el || !subclass_el) return false; const nlohmann::json &bases = (*subclass_el)["bases"]; return std::find_if(bases.begin(), bases.end(), [&](const auto &it) { return it["id"] == base_el.value()["id"]; }) != bases.end(); } template <> bool IsInnerClass( const json_t &d, std::string const &parent, std::string const &inner) { const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, inner), expand_name(j, parent), "containment"); return rel != j["relationships"].end(); } template bool IsMethod(const json_t &d, const std::string &cls, std::string const &name, std::string type = "void", std::string const ¶ms = "") { const auto &j = d.src; auto sc = get_element(j, expand_name(j, cls)); if (!sc) return false; const nlohmann::json &methods = (*sc)["methods"]; return std::find_if(methods.begin(), methods.end(), [name](const auto &it) { return it["display_name"] == name; }) != methods.end(); } template bool IsField(const json_t &d, QualifiedName cls, std::string const &name, std::string type) { const auto &j = d.src; auto sc = get_element(j, expand_name(j, cls.str(d.generate_packages))); if (!sc) return false; const nlohmann::json &members = (*sc)["members"]; return std::find_if(members.begin(), members.end(), [&](const auto &it) { return it["name"] == name && it["type"] == type; }) != members.end(); } template bool IsAssociation(const json_t &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = "") { const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, from), expand_name(j, to), "association", label); if (rel == j["relationships"].end()) return false; if (!label.empty() && (label != rel->at("label"))) return false; std::string access; if constexpr (has_type()) access = "public"; else if constexpr (has_type()) access = "protected"; else access = "private"; if (access != rel->at("access")) return false; return true; } template bool IsComposition(const json_t &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = "") { const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, from), expand_name(j, to), "composition", label); if (rel == j["relationships"].end()) return false; if (!label.empty() && label != rel->at("label")) return false; std::string access; if constexpr (has_type()) access = "public"; else if constexpr (has_type()) access = "protected"; else access = "private"; if (access != rel->at("access")) return false; return true; } template bool IsAggregation(const json_t &d, std::string const &from, std::string const &to, std::string const &label = "", std::string multiplicity_source = "", std::string multiplicity_dest = "", std::string style = "") { const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, from), expand_name(j, to), "aggregation", label); if (rel == j["relationships"].end()) return false; if (!label.empty() && label != rel->at("label")) return false; std::string access; if constexpr (has_type()) access = "public"; else if constexpr (has_type()) access = "protected"; else access = "private"; if (access != rel->at("access")) return false; return true; } template <> bool IsInstantiation(const json_t &d, std::string const &from, std::string const &to, std::string style) { const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, to), expand_name(j, from), "instantiation"); if (rel == j["relationships"].end()) return false; return true; } template <> bool IsDependency( const json_t &d, QualifiedName from, QualifiedName to, std::string style) { const auto &j = d.src; auto rel = get_relationship(j, expand_name(j, from.str(d.generate_packages)), expand_name(j, to.str(d.generate_packages)), "dependency"); if (rel == j["relationships"].end()) return false; return true; } template bool IsFriend(const json_t &d, std::string const &from, std::string const &to) { std::string access; if constexpr (has_type()) access = "public"; else if constexpr (has_type()) access = "protected"; else access = "private"; const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, from), expand_name(j, to), "friendship"); return rel != j["relationships"].end() && rel->at("access") == access; } template <> bool IsPackageDependency( const json_t &d, std::string const &from, std::string const &to) { const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, from), expand_name(j, to), "dependency"); if (rel == j["relationships"].end()) return false; return true; } template <> bool IsIncludeDependency( const json_t &d, std::string const &from, std::string const &to) { const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, from), expand_name(j, to), "dependency"); if (rel == j["relationships"].end()) return false; return true; } template <> bool IsConcept(const json_t &d, QualifiedName cpt) { const auto &j = d.src; auto e = get_element(j, expand_name(j, cpt.str(d.generate_packages))); return e && e->at("type") == "concept"; } template <> bool IsConstraint(const json_t &d, QualifiedName from, QualifiedName to, std::string label, std::string style) { const auto &j = d.src; auto rel = get_relationship(j, expand_name(j, from.str(d.generate_packages)), expand_name(j, to.str(d.generate_packages)), "constraint", label); if (rel == j["relationships"].end()) return false; if ((*rel)["label"] != label) return false; return true; } template <> bool IsConceptRequirement( const json_t &d, std::string const &cpt, std::string requirement) { const auto &j = d.src; auto e = get_element(j, expand_name(j, cpt)); if (!e) return false; const nlohmann::json &statements = (*e)["statements"]; return std::find_if(statements.begin(), statements.end(), [requirement](const auto &it) { return it == requirement; }) != statements.end(); } template <> bool IsConceptParameterList( const json_t &d, std::string const &cpt, std::string parameter_list) { const auto &j = d.src; auto e = get_element(j, expand_name(j, cpt)); if (!e) return false; const nlohmann::json ¶meters = (*e)["parameters"]; std::vector params; for (const auto &it : parameters) { params.push_back(fmt::format("{} {}", it["type"], it["name"])); } return parameter_list == fmt::format("({})", fmt::join(params, ",")); } template <> bool IsLayoutHint(const json_t &d, std::string const &from, std::string const &hint, std::string const &to) { return true; } template <> bool HasComment(const json_t &d, std::string const &comment) { // Comments are not included in JSON return true; } template <> bool HasNote(const json_t &d, std::string const &cls, std::string const &position, std::string const ¬e) { const auto &j = d.src; auto sc = get_element(j, expand_name(j, cls)); if (!sc) return false; std::string formatted = (*sc)["comment"]["formatted"]; return util::contains(formatted, note); } template <> bool HasPackageNote(const json_t &d, std::string const &cls, std::string const &position, std::string const ¬e) { return true; } template <> bool HasMemberNote(const json_t &d, std::string const &cls, std::string const &member, std::string const &position, std::string const ¬e) { return true; } template <> bool HasLink(const json_t &d, std::string const &alias, std::string const &link, std::string const &tooltip) { return true; } template <> bool HasMemberLink(const json_t &d, std::string const &method, std::string const &link, std::string const &tooltip) { return true; } template <> bool IsFolder(const json_t &d, std::string const &path) { const auto &j = d.src; auto e = get_element(j, path); return e && e->at("type") == "folder"; } template <> bool IsFile(const json_t &d, std::string const &path) { const auto &j = d.src; auto e = get_element(j, path); return e && e->at("type") == "file"; } template <> bool IsSystemHeader(const json_t &d, std::string const &path) { const auto &j = d.src; auto e = get_element(j, path); return e && e->at("type") == "file" && e->at("file_kind") == "header" && e->at("is_system"); } template <> bool IsHeaderDependency(const json_t &d, std::string const &from, std::string const &to, std::string style) { assert(d.diagram_type == common::model::diagram_t::kInclude); const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, from), expand_name(j, to), "association"); if (rel == j["relationships"].end()) return false; return true; } template <> bool IsSystemHeaderDependency(const json_t &d, std::string const &from, std::string const &to, std::string style) { assert(d.diagram_type == common::model::diagram_t::kInclude); const auto &j = d.src; auto rel = get_relationship( j, expand_name(j, from), expand_name(j, to), "dependency"); if (rel == j["relationships"].end()) return false; return true; } template bool IsPackagePath( const nlohmann::json &j, const std::string &head, Args... args) { if constexpr (sizeof...(Args) == 0) { auto e = get_element(j, expand_name(j, head)); return e && e->at("type") == package_type_name(); } else { auto e = get_element(j, head); if (!e.has_value()) return false; return IsPackagePath(*e, args...); } } template bool IsNamespacePackage(const json_t &d, Args... args) { const auto &j = d.src; return IsPackagePath(j, std::forward(args)...); } template bool IsDirectoryPackage(const json_t &d, Args... args) { const auto &j = d.src; return IsPackagePath(j, std::forward(args)...); } template bool IsModulePackage(const json_t &d, Args... args) { const auto &j = d.src; return IsPackagePath(j, std::forward(args)...); } template <> bool IsDeprecated(const json_t &d, const std::string &name) { const auto &j = d.src; auto e = get_element(j, expand_name(j, name)); return e && e->at("is_deprecated") == true; } namespace json_helpers { int find_message_nested(const nlohmann::json &j, const std::string &from, const std::string &to, const std::string &msg, std::optional return_type, const nlohmann::json &from_p, const nlohmann::json &to_p, int &count, const int64_t offset, std::optional chain_index = {}) { if (!j.contains("messages") && !j.contains("message_chains")) return -1; const auto &messages = !chain_index.has_value() ? j["messages"] : j["message_chains"][chain_index.value()]["messages"]; int res{-1}; for (const auto &m : messages) { if (m.contains("branches")) { for (const auto &b : m["branches"]) { auto nested_res = find_message_nested( b, from, to, msg, return_type, from_p, to_p, count, offset); if (nested_res >= offset) return nested_res; } } else if (m.contains("messages")) { auto nested_res = find_message_nested( m, from, to, msg, return_type, from_p, to_p, count, offset); if (nested_res >= offset) return nested_res; } else { if (count >= offset && (m["from"]["participant_id"] == from_p["id"]) && (m["to"]["participant_id"] == to_p["id"]) && (m["name"] == msg) && (!return_type || m["return_type"] == *return_type)) return count; count++; } } return res; } int find_message_impl(const nlohmann::json &j, const std::string &from, const std::string &to, const std::string &msg, std::optional return_type, int64_t offset, std::optional chain_index = {}) { auto from_p = get_participant(j, from); auto to_p = get_participant(j, to); if (!from_p) throw std::runtime_error( fmt::format("Cannot find participant {}", from)); if (!to_p) throw std::runtime_error(fmt::format("Cannot find participant {}", to)); assert(from_p->is_object()); assert(to_p->is_object()); // TODO: support diagrams with multiple sequences... int count{0}; for (const auto &seq : j["sequences"]) { int64_t res{-1}; res = find_message_nested(seq, from, to, msg, return_type, *from_p, *to_p, count, offset, chain_index); if (res >= 0) return res; } throw std::runtime_error(fmt::format( "No such message {} {} {} after offset {}", from, to, msg, offset)); } int64_t find_message(const nlohmann::json &j, const File &from, const File &to, const std::string &msg, int64_t offset) { return find_message_impl(j, from.file, to.file, msg, {}, offset); } int64_t find_message(const nlohmann::json &j, const std::string &from, const std::string &to, const std::string &msg, std::optional return_type = {}, int64_t offset = 0) { return find_message_impl( j, expand_name(j, from), expand_name(j, to), msg, return_type, offset); } int64_t find_message_in_chain(const nlohmann::json &j, const std::string &from, const std::string &to, const std::string &msg, std::optional return_type = {}, int64_t offset = 0, uint32_t chain_index = 0) { return find_message_impl(j, expand_name(j, from), expand_name(j, to), msg, return_type, offset, chain_index); } } // namespace detail template <> int64_t FindMessage( const json_t &d, const Message &msg, int64_t offset, bool fail) { if (msg.is_response) { // TODO: Currently response are not generated as separate messages in // JSON format return offset; } if (msg.is_entrypoint || msg.is_exitpoint) return offset; try { return json_helpers::find_message(d.src, msg.from.str(), msg.to.str(), msg.message, msg.return_type, offset); } catch (std::exception &e) { if (!fail) return -1; std::cout << "FindMessage failed with error " << e.what() << "\n"; throw e; } } int64_t find_message_in_chain(const json_t &d, const Message &msg, int64_t offset, bool fail, uint32_t chain_index) { if (msg.is_response) { // TODO: Currently response are not generated as separate messages in // JSON format return offset; } if (msg.is_entrypoint || msg.is_exitpoint) return offset; try { return json_helpers::find_message_in_chain(d.src, msg.from.str(), msg.to.str(), msg.message, msg.return_type, offset, chain_index); } catch (std::exception &e) { if (!fail) return -1; std::cout << "find_message_in_chain failed with " << e.what() << "\n"; throw e; } } template <> bool MessageChainsOrder( const json_t &d, std::vector> message_chains) { const auto sequence_chains_count{ d.src["sequences"][0]["message_chains"].size()}; for (const auto &messages : message_chains) { for (uint32_t chain_index = 0; chain_index < sequence_chains_count; chain_index++) { int64_t offset{0}; std::vector order; order.reserve(messages.size()); std::transform(messages.begin(), messages.end(), std::back_inserter(order), [&d, &offset, chain_index](const auto &m) -> int64_t { try { offset = find_message_in_chain( d, m, offset, true, chain_index); return offset; } catch (...) { return 0; } }); bool are_messages_in_order = std::is_sorted(order.begin(), order.end()); if (are_messages_in_order) return true; } } FAIL(fmt::format("Messages are not in order")); return false; } template <> bool HasMessageComment( const json_t &d, std::string const &alias, std::string const ¬e) { return true; } template <> bool IsParticipant( const json_t &d, const std::string &name, const std::string &type) { const auto &j = d.src; auto p = get_participant(j, expand_name(j, name)); return p && (p->at("type") == type); } } // namespace clanguml::test