matthias/clang-uml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

WIP Refactoring alias template resolution based on clang canonical representation

Browse Source
This commit is contained in:
Bartek Kryza
2022-05-05 00:34:23 +02:00
parent 9399d80f6f
commit 468393ddb8
13 changed files with 235 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/class_diagram/generators/plantuml/class_diagram_generator.cc
View File

@@ -64,6 +64,8 @@ void generator::generate_alias(const class_ &c, std::ostream &ostr) const
else
full_name = c.full_name();
//util::replace_all(full_name, "std::basic_string<char>", "std::string");
if (full_name.empty())
full_name = "<<anonymous>>";

9
src/class_diagram/model/class.cc
View File

@@ -139,10 +139,13 @@ std::ostringstream &class_::render_template_params(
if (!templates_.empty()) {
std::vector<std::string> tnames;
std::vector<std::string> tnames_simplified;
std::transform(templates_.cbegin(), templates_.cend(),
std::back_inserter(tnames), [this](const auto &tmplt) {
return tmplt.to_string(using_namespace());
});
std::back_inserter(tnames),
[ns = using_namespace()](
const auto &tmplt) { return tmplt.to_string(ns); });
ostr << fmt::format("<{}>", fmt::join(tnames, ","));
}
return ostr;

5
src/class_diagram/model/class.h
View File

@@ -75,12 +75,17 @@ public:
bool is_abstract() const;
bool is_alias() const { return is_alias_; }
void is_alias(bool alias) { is_alias_ = alias; }
private:
std::ostringstream &render_template_params(std::ostringstream &ostr) const;
bool is_struct_{false};
bool is_template_{false};
bool is_template_instantiation_{false};
bool is_alias_{false};
std::vector<class_member> members_;
std::vector<class_method> methods_;
std::vector<class_parent> bases_;

16
src/class_diagram/model/class_template.cc
View File

@@ -24,16 +24,21 @@ namespace clanguml::class_diagram::model {
class_template::class_template(const std::string &type, const std::string &name,
const std::string &default_value, bool is_variadic)
: type_{type}
, name_{name}
: name_{name}
, default_value_{default_value}
, is_variadic_{is_variadic}
{
set_type(type);
if (is_variadic)
name_ = name_ + "...";
}
void class_template::set_type(const std::string &type) { type_ = type; }
void class_template::set_type(const std::string &type) {
type_ = type;
// TODO: Add a configurable mapping for simplifying non-interesting
// std templates
util::replace_all(type_, "std::basic_string<char>", "std::string");
}
std::string class_template::type() const { return type_; }
@@ -60,6 +65,11 @@ bool operator==(const class_template &l, const class_template &r)
return (l.name() == r.name()) && (l.type() == r.type());
}
bool operator!=(const class_template &l, const class_template &r)
{
return !(l == r);
}
std::string class_template::to_string(
const clanguml::common::model::namespace_ &using_namespace) const
{

9
src/class_diagram/model/class_template.h
View File

@@ -42,9 +42,17 @@ public:
bool is_variadic() const noexcept;
friend bool operator==(const class_template &l, const class_template &r);
friend bool operator!=(const class_template &l, const class_template &r);
std::vector<class_template> template_params_;
bool is_template_parameter() const { return is_template_parameter_; }
void is_template_parameter(bool is_template_parameter)
{
is_template_parameter_ = is_template_parameter;
}
std::string to_string(
const clanguml::common::model::namespace_ &using_namespace) const;
@@ -52,6 +60,7 @@ private:
std::string type_;
std::string name_;
std::string default_value_;
bool is_template_parameter_{false};
bool is_variadic_{false};
};
}

142
src/class_diagram/visitor/translation_unit_visitor.cc
View File

@@ -200,8 +200,9 @@ void translation_unit_visitor::process_type_alias_template(
const cppast::cpp_alias_template &at)
{
auto alias_kind = at.type_alias().underlying_type().kind();
if (alias_kind == cppast::cpp_type_kind::unexposed_t) {
LOG_DBG("Template alias has unexposed underlying type: {}",
LOG_DBG("Template alias has unexposed underlying type - ignoring: {}",
static_cast<const cppast::cpp_unexposed_type &>(
at.type_alias().underlying_type())
.name());
@@ -209,9 +210,16 @@ void translation_unit_visitor::process_type_alias_template(
else {
if (at.type_alias().underlying_type().kind() ==
cppast::cpp_type_kind::template_instantiation_t) {
found_relationships_t nested_relationships;
auto tinst = build_template_instantiation(
static_cast<const cppast::cpp_template_instantiation_type &>(
resolve_alias(at.type_alias().underlying_type())));
resolve_alias(at.type_alias().underlying_type())),
nested_relationships);
tinst->is_alias(true);
if (tinst->get_namespace().is_empty())
tinst->set_namespace(ctx.get_namespace());
ctx.add_type_alias_template(
cx::util::full_name(ctx.get_namespace(), at),
@@ -708,10 +716,20 @@ bool translation_unit_visitor::process_field_with_template_instantiation(
auto tr_unaliased_declaration = cppast::to_string(unaliased);
std::unique_ptr<class_> tinst_ptr;
if (util::contains(tr_declaration, "<"))
tinst_ptr = build_template_instantiation(template_instantiation_type);
// if (util::contains(tr_declaration, "<"))
// tinst_ptr = build_template_instantiation(template_instantiation_type);
// auto t_canon = cppast::to_string(tr.canonical());
//(void)t_canon;
// else
found_relationships_t nested_relationships;
if (tr_declaration == tr_unaliased_declaration)
tinst_ptr =
build_template_instantiation(unaliased, nested_relationships);
else
tinst_ptr = build_template_instantiation(unaliased);
tinst_ptr = build_template_instantiation(
static_cast<const cppast::cpp_template_instantiation_type &>(
tr.canonical()),
nested_relationships);
auto &tinst = *tinst_ptr;
@@ -739,6 +757,8 @@ bool translation_unit_visitor::process_field_with_template_instantiation(
}
}
// Add instantiation relationship from the generated template instantiation
// of the field type to its primary template
if (ctx.diagram().should_include(tinst.get_namespace(), tinst.name())) {
LOG_DBG("Adding field instantiation relationship {} {} {} : {}",
rr.destination(), clanguml::common::model::to_string(rr.type()),
@@ -746,18 +766,20 @@ bool translation_unit_visitor::process_field_with_template_instantiation(
c.add_relationship(std::move(rr));
if (tr_declaration != tr_unaliased_declaration) {
// Add template instantiation/specialization relationship;
tinst.add_relationship(
{relationship_t::kInstantiation, tr_unaliased_declaration});
}
res = true;
LOG_DBG("Created template instantiation: {}", tinst.full_name());
ctx.diagram().add_class(std::move(tinst_ptr));
}
else if (!nested_relationships.empty()) {
for (const auto &rel : nested_relationships) {
c.add_relationship({relationship_type, std::get<0>(rel),
detail::cpp_access_specifier_to_access(as), mv.name()});
}
res = true;
}
return res;
}
@@ -805,6 +827,8 @@ void translation_unit_visitor::process_field(
process_field_with_template_instantiation(mv, tr, c, m, as);
}
else if (tr.kind() == cppast::cpp_type_kind::template_instantiation_t) {
// This can be either template instantiation or an alias template
// instantiation
template_instantiation_added_as_aggregation =
process_field_with_template_instantiation(mv, tr, c, m, as);
}
@@ -1203,9 +1227,10 @@ void translation_unit_visitor::
c.add_relationship(std::move(rr));
}
else {
found_relationships_t nested_relationships;
// First check if tinst already exists
auto tinst_ptr =
build_template_instantiation(template_instantiation_type);
auto tinst_ptr = build_template_instantiation(
template_instantiation_type, nested_relationships);
auto &tinst = *tinst_ptr;
relationship rr{relationship_t::kDependency, tinst.full_name()};
@@ -1539,6 +1564,7 @@ bool translation_unit_visitor::find_relationships_in_unexposed_template_params(
std::unique_ptr<class_> translation_unit_visitor::build_template_instantiation(
const cppast::cpp_template_instantiation_type &t,
found_relationships_t &nested_relationships,
std::optional<clanguml::class_diagram::model::class_ *> parent)
{
// Create class_ instance to hold the template instantiation
@@ -1546,13 +1572,31 @@ std::unique_ptr<class_> translation_unit_visitor::build_template_instantiation(
auto &tinst = *tinst_ptr;
std::string full_template_name;
auto tr_declaration = cppast::to_string(t);
// If this is an alias - resolve the alias target
const auto &unaliased =
static_cast<const cppast::cpp_template_instantiation_type &>(
resolve_alias(t));
auto t_unaliased_declaration = cppast::to_string(unaliased);
bool t_is_alias = t_unaliased_declaration != tr_declaration;
// Here we'll hold the template base params to replace with the instantiated
// values
std::deque<std::tuple<std::string, int, bool>> template_base_params{};
tinst.set_namespace(ctx.get_namespace());
auto tinst_full_name = cppast::to_string(t);
// Typically, every template instantiation should have a primary_template()
// which should also be generated here if it doesn't exist yet in the model
// However if this is a template alias, then it does not have a primary
// template
if (t.primary_template().get(ctx.entity_index()).size()) {
auto size = t.primary_template().get(ctx.entity_index()).size();
(void)size;
build_template_instantiation_primary_template(
t, tinst, template_base_params, parent, full_template_name);
}
@@ -1573,11 +1617,8 @@ std::unique_ptr<class_> translation_unit_visitor::build_template_instantiation(
else
tinst.set_namespace(ns);
if (tinst_full_name.find('<') != std::string::npos) {
tinst.set_name(tinst_full_name.substr(0, tinst_full_name.find('<')));
}
tinst.is_template_instantiation(true);
tinst.is_alias(t_is_alias);
if (tinst.full_name().substr(0, tinst.full_name().find('<')).find("::") ==
std::string::npos) {
@@ -1596,7 +1637,7 @@ std::unique_ptr<class_> translation_unit_visitor::build_template_instantiation(
class_template ct;
if (targ.type()) {
build_template_instantiation_process_type_argument(
parent, tinst, targ, ct);
parent, tinst, targ, ct, nested_relationships);
}
else if (targ.expression()) {
build_template_instantiation_process_expression_argument(
@@ -1631,6 +1672,41 @@ std::unique_ptr<class_> translation_unit_visitor::build_template_instantiation(
destination = cppast::to_string(ctx.get_type_alias(fn).get());
}
else {
std::string tmp_destination{};
int best_match = 0;
// First try to find the best match for this template in partially
// specialized templates
for (const auto &c : ctx.diagram().classes()) {
if (c->name_and_ns() == full_template_name &&
// TODO: handle variadic templates
c->templates().size() == tinst.templates().size()) {
int tmp_match = 0;
for (int i = 0; i < c->templates().size(); i++) {
const auto& tinst_i = tinst.templates().at(i);
const auto& c_i = c->templates().at(i);
if ((c_i == tinst_i) && !c_i.is_template_parameter()) {
tmp_match++;
}
else if(c_i.is_template_parameter() || tinst_i.is_template_parameter()) {
// continue
}
else {
// Non-free types are not compatible
tmp_match = 0;
break;
}
}
if (tmp_match > best_match) {
best_match = tmp_match;
tmp_destination = c->full_name(false);
}
}
}
if (!tmp_destination.empty())
destination = tmp_destination;
else
// Otherwise point to the base template
destination = tinst.base_template();
}
@@ -1691,7 +1767,7 @@ void translation_unit_visitor::
build_template_instantiation_process_type_argument(
const std::optional<clanguml::class_diagram::model::class_ *> &parent,
class_ &tinst, const cppast::cpp_template_argument &targ,
class_template &ct)
class_template &ct, found_relationships_t &nested_relationships)
{
ct.set_type(cppast::to_string(targ.type().value()));
@@ -1702,7 +1778,10 @@ void translation_unit_visitor::
auto [fn_ns, fn_name] = cx::util::split_ns(fn);
if (targ.type().value().kind() ==
if(targ.type().value().kind() == cppast::cpp_type_kind::template_parameter_t) {
ct.is_template_parameter(true);
}
else if (targ.type().value().kind() ==
cppast::cpp_type_kind::template_instantiation_t) {
const auto &nested_template_parameter =
@@ -1716,8 +1795,8 @@ void translation_unit_visitor::
auto [tinst_ns, tinst_name] =
cx::util::split_ns(tinst.full_name(false));
auto nested_tinst =
build_template_instantiation(nested_template_parameter,
auto nested_tinst = build_template_instantiation(
nested_template_parameter, nested_relationships,
ctx.diagram().should_include(tinst_ns, tinst_name)
? std::make_optional(&tinst)
: parent);
@@ -1725,9 +1804,14 @@ void translation_unit_visitor::
relationship tinst_dependency{
relationship_t::kDependency, nested_tinst->full_name()};
auto nested_tinst_full_name = nested_tinst->full_name();
auto nested_tinst_full_name = nested_tinst->full_name(false);
if (ctx.diagram().should_include(fn_ns, fn_name)) {
auto [nested_tinst_ns, nested_tinst_name] =
cx::util::split_ns(nested_tinst_full_name);
if (ctx.diagram().should_include(nested_tinst_ns, nested_tinst_name)) {
nested_relationships.push_back(
{nested_tinst->full_name(false), relationship_t::kAggregation});
ctx.diagram().add_class(std::move(nested_tinst));
}
@@ -1769,6 +1853,8 @@ void translation_unit_visitor::
if (ctx.diagram().should_include(fn_ns, fn_name)) {
tinst.add_relationship(std::move(tinst_dependency));
nested_relationships.push_back(
{tinst_dependency.destination(), relationship_t::kAggregation});
}
else if (parent) {
(*parent)->add_relationship(std::move(tinst_dependency));
@@ -1870,9 +1956,17 @@ const cppast::cpp_type &translation_unit_visitor::resolve_alias(
if (util::contains(type_full_name, "<"))
type_full_name = util::split(type_full_name, "<")[0];
auto type_full_name_in_current_ns = ctx.get_namespace();
type_full_name_in_current_ns |= common::model::namespace_{type_full_name};
if (ctx.has_type_alias_template(type_full_name)) {
return ctx.get_type_alias(type_full_name).get();
}
else if (ctx.has_type_alias_template(
type_full_name_in_current_ns.to_string())) {
return ctx.get_type_alias(type_full_name_in_current_ns.to_string())
.get();
}
else if (ctx.has_type_alias(type_full_name)) {
return ctx.get_type_alias_final(raw_type).get();
}

9
src/class_diagram/visitor/translation_unit_visitor.h
View File

@@ -163,8 +163,15 @@ private:
std::unique_ptr<clanguml::class_diagram::model::class_>
build_template_instantiation(
const cppast::cpp_template_instantiation_type &t,
found_relationships_t &relationships,
std::optional<clanguml::class_diagram::model::class_ *> parent = {});
// std::vector<std::unique_ptr<clanguml::class_diagram::model::class_>>
std::unique_ptr<clanguml::class_diagram::model::class_>
build_alias_template_instantiation(
const cppast::cpp_template_instantiation_type &alias_templ,
std::optional<clanguml::class_diagram::model::class_ *> parent);
/**
* Try to resolve a type instance into a type referenced through an alias.
* If t does not represent an alias, returns t.
@@ -208,7 +215,7 @@ private:
void build_template_instantiation_process_type_argument(
const std::optional<clanguml::class_diagram::model::class_ *> &parent,
model::class_ &tinst, const cppast::cpp_template_argument &targ,
model::class_template &ct);
model::class_template &ct, found_relationships_t &relationships);
void build_template_instantiation_process_expression_argument(
const cppast::cpp_template_argument &targ,

2
src/common/generators/plantuml/generator.cc
View File

@@ -37,6 +37,8 @@ std::string to_plantuml(relationship_t r, std::string style)
return style.empty() ? "<.." : fmt::format("<.[{}].", style);
case relationship_t::kDependency:
return style.empty() ? "..>" : fmt::format(".[{}].>", style);
case relationship_t::kAlias:
return style.empty() ? ".." : fmt::format(".[{}].", style);
default:
return "";
}

2
src/common/model/enums.cc
View File

@@ -44,6 +44,8 @@ std::string to_string(relationship_t r)
return "friendship";
case relationship_t::kDependency:
return "dependency";
case relationship_t::kAlias:
return "alias";
default:
assert(false);
}

1
src/common/model/enums.h
View File

@@ -35,6 +35,7 @@ enum class relationship_t {
kAssociation,
kInstantiation,
kFriendship,
kAlias,
kDependency
};

5
src/cx/util.cc
View File

@@ -162,8 +162,9 @@ std::string ns(const cppast::cpp_type &t, const cppast::cpp_entity_index &idx)
.get(idx)[0]
.get());
}
else
return "";
else {
return {};
}
}
else {
auto canon = cppast::to_string(t.canonical());

20
tests/t00014/t00014.cc
View File

@@ -2,6 +2,7 @@
#include <functional>
#include <ios>
#include <map>
#include <memory>
#include <numeric>
#include <string>
#include <type_traits>
@@ -27,6 +28,13 @@ template <typename T, typename P> struct A {
};
template <typename T> using AString = A<T, std::string>;
template <typename T> using AStringPtr = A<T, std::unique_ptr<std::string>>;
template <class T> using VectorPtr = std::unique_ptr<std::vector<T>>;
template <class T> using APtr = std::unique_ptr<A<double, T>>;
template <class T> using ASharedPtr = std::shared_ptr<A<double,T>>;
template <class T, class U> using AAPtr =
std::unique_ptr<std::pair<A<double,T>, A<long,U>>>;
template <typename... T> using GeneralCallback = std::function<void(T..., int)>;
using VoidCallback = GeneralCallback<>;
@@ -42,12 +50,19 @@ using AIntString = AString<int>;
using AStringString = AString<std::string>;
using BStringString = AStringString;
template <typename T> using PairPairBA = std::pair<std::pair<B, A<long,T>>, long>;
class R {
// clang-uml: tinst A<T, std::string>
PairPairBA<bool> bapair;
APtr<bool> abool;
AAPtr<bool,float> aboolfloat;
ASharedPtr<float> afloat;
A<bool, std::string> boolstring;
AString<float> floatstring;
AStringPtr<float> floatstring;
AIntString intstring;
AStringString stringstring;
BStringString bstringstring;
protected:
BVector bs;
@@ -56,6 +71,7 @@ public:
BVector2 bs2;
GeneralCallback<AIntString> cb;
VoidCallback vcb;
VectorPtr<B> vps;
};
}
}

64
tests/t00014/test_case.h
View File

@@ -36,31 +36,53 @@ TEST_CASE("t00014", "[test-case][class]")
REQUIRE_THAT(puml, EndsWith("@enduml\n"));
REQUIRE_THAT(puml, IsClassTemplate("A", "T,P"));
REQUIRE_THAT(puml, IsClassTemplate("A", "T,std::string"));
REQUIRE_THAT(puml, IsClassTemplate("A", "T,std::unique_ptr<std::string>"));
REQUIRE_THAT(puml, IsClassTemplate("A", "double,T"));
REQUIRE_THAT(puml, IsClassTemplate("A", "long,U"));
REQUIRE_THAT(puml, IsClassTemplate("A", "long,T"));
REQUIRE_THAT(puml, IsClassTemplate("A", "long,bool"));
REQUIRE_THAT(puml, IsClassTemplate("A", "double,bool"));
REQUIRE_THAT(puml, IsClassTemplate("A", "long,float"));
REQUIRE_THAT(puml, IsClassTemplate("A", "double,float"));
REQUIRE_THAT(puml, IsClassTemplate("A", "bool,std::string"));
REQUIRE_THAT(puml, IsClassTemplate("AString", "float"));
REQUIRE_THAT(puml, IsClassTemplate("AString", "int"));
REQUIRE_THAT(puml, IsClassTemplate("AString", "std::string"));
REQUIRE_THAT(puml, IsClass(_A("B")));
REQUIRE_THAT(
puml, !IsClassTemplate("std::std::function", "void(T...,int),int)"));
REQUIRE_THAT(puml, IsInstantiation(_A("A<T,P>"), _A("A<T,std::string>")));
REQUIRE_THAT(
puml, IsInstantiation(_A("A<T,std::string>"), _A("AString<float>")));
REQUIRE_THAT(
puml, IsInstantiation(_A("A<T,std::string>"), _A("AString<int>")));
REQUIRE_THAT(
puml, !IsInstantiation(_A("AString<int>"), _A("AString<int>")));
REQUIRE_THAT(puml,
IsInstantiation(_A("A<T,std::string>"), _A("AString<std::string>")));
REQUIRE_THAT(puml,
!IsInstantiation(
_A("AString<std::string>"), _A("AString<std::string>")));
REQUIRE_THAT(
puml, IsAggregation(_A("R"), _A("A<bool,std::string>"), "-boolstring"));
REQUIRE_THAT(
puml, IsAggregation(_A("R"), _A("AString<float>"), "-floatstring"));
REQUIRE_THAT(puml, IsAggregation(_A("R"), _A("B"), "#bs"));
REQUIRE_THAT(puml, IsAggregation(_A("R"), _A("B"), "+bs2"));
// REQUIRE_THAT(puml, IsInstantiation(_A("A<T,P>"), _A("A<T,std::string>")));
// REQUIRE_THAT(
// puml, IsInstantiation(_A("A<T,std::string>"), _A("AString<float>")));
// REQUIRE_THAT(
// puml, IsInstantiation(_A("A<T,std::string>"), _A("AString<int>")));
// REQUIRE_THAT(
// puml, !IsInstantiation(_A("AString<int>"), _A("AString<int>")));
// REQUIRE_THAT(puml,
// IsInstantiation(_A("A<T,std::string>"), _A("AString<std::string>")));
// REQUIRE_THAT(
// puml, IsInstantiation(_A("A<T,std::string>"), _A("A<double,bool>")));
//
// REQUIRE_THAT(puml,
// !IsInstantiation(
// _A("AString<std::string>"), _A("AString<std::string>")));
REQUIRE_THAT(puml, IsAggregation(_A("R"), _A("B"), "+vps"));
REQUIRE_THAT(puml, IsAggregation(_A("R"), _A("B"), "-bapair"));
// REQUIRE_THAT(
// puml, IsAggregation(_A("R"), _A("A<bool,std::string>"), "-boolstring"));
//
//
//
// REQUIRE_THAT(
// puml, IsAggregation(_A("R"), _A("A<bool,std::string>"), "-boolstring"));
// REQUIRE_THAT(
// puml, IsAggregation(_A("R"), _A("AString<float>"), "-floatstring"));
// REQUIRE_THAT(puml, IsAggregation(_A("R"), _A("B"), "#bs"));
// REQUIRE_THAT(puml, IsAggregation(_A("R"), _A("B"), "+bs2"));
// REQUIRE_THAT(puml, IsAggregation(_A("R"), _A("B"), "+vsp"));
// REQUIRE_THAT(puml, IsAggregation(_A("R"), _A("A<double,bool>"), "+bvsp"));
save_puml(
"./" + config.output_directory() + "/" + diagram->name + ".puml", puml);