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

Added support for 'class' diagrams from C99/C11 translation units (#97)

Browse Source
This commit is contained in:
Bartek Kryza
2023-02-19 18:49:59 +01:00
parent 4afb1daef0
commit 6341a62857
17 changed files with 301 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -116,6 +116,10 @@ void generator::generate(const class_ &c, std::ostream &ostr) const
ostr << class_type << " " << c.alias();
if (c.is_union())
ostr << " "
<< "<<union>>";
if (m_config.generate_links) {
common_generator<diagram_config, diagram_model>::generate_link(ostr, c);
}

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

@@ -54,6 +54,12 @@ public:
bool is_template_instantiation() const;
void is_template_instantiation(bool is_template_instantiation);
bool is_alias() const { return is_alias_; }
void is_alias(bool alias) { is_alias_ = alias; }
bool is_union() const { return is_union_; }
void is_union(bool u) { is_union_ = u; }
void add_member(class_member &&member);
void add_method(class_method &&method);
void add_parent(class_parent &&parent);
@@ -73,10 +79,6 @@ public:
bool is_abstract() const;
bool is_alias() const { return is_alias_; }
void is_alias(bool alias) { is_alias_ = alias; }
void find_relationships(
std::vector<std::pair<std::string, common::model::relationship_t>>
&nested_relationships);
@@ -89,6 +91,7 @@ private:
bool is_template_{false};
bool is_template_instantiation_{false};
bool is_alias_{false};
bool is_union_{false};
std::vector<class_member> members_;
std::vector<class_method> methods_;
std::vector<class_parent> bases_;

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

@@ -310,6 +310,63 @@ bool translation_unit_visitor::VisitClassTemplateDecl(
return true;
}
bool translation_unit_visitor::VisitRecordDecl(clang::RecordDecl *rec)
{
// Skip system headers
if (source_manager().isInSystemHeader(rec->getSourceRange().getBegin()))
return true;
if (clang::dyn_cast_or_null<clang::CXXRecordDecl>(rec))
// This is handled by VisitCXXRecordDecl()
return true;
// It seems we are in a C (not C++) translation unit
if (!diagram().should_include(rec->getQualifiedNameAsString()))
return true;
LOG_DBG("= Visiting record declaration {} at {}",
rec->getQualifiedNameAsString(),
rec->getLocation().printToString(source_manager()));
auto record_ptr = create_record_declaration(rec);
if (!record_ptr)
return true;
const auto rec_id = record_ptr->id();
set_ast_local_id(rec->getID(), rec_id);
auto &record_model = diagram().get_class(rec_id).has_value()
? *diagram().get_class(rec_id).get()
: *record_ptr;
if (rec->isCompleteDefinition() && !record_model.complete()) {
process_record_members(rec, record_model);
record_model.complete(true);
}
auto id = record_model.id();
if (!rec->isCompleteDefinition()) {
forward_declarations_.emplace(id, std::move(record_ptr));
return true;
}
forward_declarations_.erase(id);
if (diagram_.should_include(record_model)) {
LOG_DBG("Adding struct/union {} with id {}",
record_model.full_name(false), record_model.id());
diagram_.add_class(std::move(record_ptr));
}
else {
LOG_DBG("Skipping struct/union {} with id {}", record_model.full_name(),
record_model.id());
}
return true;
}
bool translation_unit_visitor::VisitCXXRecordDecl(clang::CXXRecordDecl *cls)
{
// Skip system headers
@@ -383,6 +440,42 @@ bool translation_unit_visitor::VisitCXXRecordDecl(clang::CXXRecordDecl *cls)
return true;
}
std::unique_ptr<class_> translation_unit_visitor::create_record_declaration(
clang::RecordDecl *rec)
{
assert(rec != nullptr);
auto record_ptr{std::make_unique<class_>(config_.using_namespace())};
auto &record = *record_ptr;
auto qualified_name = rec->getQualifiedNameAsString();
if (!diagram().should_include(qualified_name))
return {};
process_record_parent(rec, record, namespace_{});
if (!record.is_nested()) {
record.set_name(common::get_tag_name(*rec));
record.set_id(common::to_id(record.full_name(false)));
}
process_comment(*rec, record);
set_source_location(*rec, record);
const auto record_full_name = record_ptr->full_name(false);
record.is_struct(rec->isStruct());
record.is_union(rec->isUnion());
if (record.skip())
return {};
record.set_style(record.style_spec());
return record_ptr;
}
std::unique_ptr<class_> translation_unit_visitor::create_class_declaration(
clang::CXXRecordDecl *cls)
{
@@ -392,14 +485,37 @@ std::unique_ptr<class_> translation_unit_visitor::create_class_declaration(
auto &c = *c_ptr;
// TODO: refactor to method get_qualified_name()
auto qualified_name =
cls->getQualifiedNameAsString(); // common::get_qualified_name(*cls);
auto qualified_name = cls->getQualifiedNameAsString();
if (!diagram().should_include(qualified_name))
return {};
auto ns = common::get_tag_namespace(*cls);
process_record_parent(cls, c, ns);
if (!c.is_nested()) {
c.set_name(common::get_tag_name(*cls));
c.set_namespace(ns);
c.set_id(common::to_id(c.full_name(false)));
}
c.is_struct(cls->isStruct());
process_comment(*cls, c);
set_source_location(*cls, c);
if (c.skip())
return {};
c.set_style(c.style_spec());
return c_ptr;
}
void translation_unit_visitor::process_record_parent(
clang::RecordDecl *cls, class_ &c, const namespace_ &ns)
{
const auto *parent = cls->getParent();
std::optional<common::model::diagram_element::id_t> id_opt;
@@ -435,7 +551,8 @@ std::unique_ptr<class_> translation_unit_visitor::create_class_declaration(
assert(parent_class);
c.set_namespace(ns);
if (cls->getNameAsString().empty()) {
const auto cls_name = cls->getNameAsString();
if (cls_name.empty()) {
// Nested structs can be anonymous
if (anonymous_struct_relationships_.count(cls->getID()) > 0) {
const auto &[label, hint, access] =
@@ -467,23 +584,6 @@ std::unique_ptr<class_> translation_unit_visitor::create_class_declaration(
c.nested(true);
}
else {
c.set_name(common::get_tag_name(*cls));
c.set_namespace(ns);
c.set_id(common::to_id(c.full_name(false)));
}
c.is_struct(cls->isStruct());
process_comment(*cls, c);
set_source_location(*cls, c);
if (c.skip())
return {};
c.set_style(c.style_spec());
return c_ptr;
}
void translation_unit_visitor::process_class_declaration(
@@ -715,6 +815,16 @@ void translation_unit_visitor::process_template_specialization_children(
}
}
void translation_unit_visitor::process_record_members(
const clang::RecordDecl *cls, class_ &c)
{
// Iterate over regular class fields
for (const auto *field : cls->fields()) {
if (field != nullptr)
process_field(*field, c);
}
}
void translation_unit_visitor::process_class_children(
const clang::CXXRecordDecl *cls, class_ &c)
{
@@ -1054,11 +1164,16 @@ bool translation_unit_visitor::find_relationships(const clang::QualType &type,
}
}
}
else {
else if (type->getAsCXXRecordDecl()) {
const auto target_id = common::to_id(*type->getAsCXXRecordDecl());
relationships.emplace_back(target_id, relationship_hint);
result = true;
}
else {
const auto target_id = common::to_id(*type->getAsRecordDecl());
relationships.emplace_back(target_id, relationship_hint);
result = true;
}
}
return result;
@@ -2092,6 +2207,9 @@ bool translation_unit_visitor::build_template_instantiation_add_base_classes(
void translation_unit_visitor::process_field(
const clang::FieldDecl &field_declaration, class_ &c)
{
LOG_DBG(
"== Visiting record member {}", field_declaration.getNameAsString());
// Default hint for relationship is aggregation
auto relationship_hint = relationship_t::kAggregation;
// If the first type of the template instantiation of this field type
@@ -2108,6 +2226,7 @@ void translation_unit_visitor::process_field(
auto field_type_str =
common::to_string(field_type, field_declaration.getASTContext(), false);
ensure_lambda_type_is_relative(field_type_str);
class_member field{
@@ -2239,11 +2358,11 @@ void translation_unit_visitor::process_field(
// Find relationship for the type if the type has not been added
// as aggregation
if (!template_instantiation_added_as_aggregation) {
if ((field_type->getAsCXXRecordDecl() != nullptr) &&
field_type->getAsCXXRecordDecl()->getNameAsString().empty()) {
if ((field_type->getAsRecordDecl() != nullptr) &&
field_type->getAsRecordDecl()->getNameAsString().empty()) {
// Relationships to fields whose type is an anonymous nested
// struct have to be handled separately here
anonymous_struct_relationships_[field_type->getAsCXXRecordDecl()
anonymous_struct_relationships_[field_type->getAsRecordDecl()
->getID()] =
std::make_tuple(
field.name(), relationship_hint, field.access());

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

@@ -69,6 +69,8 @@ public:
virtual bool VisitNamespaceDecl(clang::NamespaceDecl *ns);
virtual bool VisitRecordDecl(clang::RecordDecl *D);
virtual bool VisitCXXRecordDecl(clang::CXXRecordDecl *d);
virtual bool VisitEnumDecl(clang::EnumDecl *e);
@@ -109,6 +111,9 @@ private:
std::unique_ptr<clanguml::class_diagram::model::class_>
create_class_declaration(clang::CXXRecordDecl *cls);
std::unique_ptr<clanguml::class_diagram::model::class_>
create_record_declaration(clang::RecordDecl *rec);
void process_class_declaration(const clang::CXXRecordDecl &cls,
clanguml::class_diagram::model::class_ &c);
@@ -118,6 +123,8 @@ private:
void process_class_children(const clang::CXXRecordDecl *cls,
clanguml::class_diagram::model::class_ &c);
void process_record_members(const clang::RecordDecl *cls, class_ &c);
std::unique_ptr<clanguml::class_diagram::model::class_>
process_template_specialization(
clang::ClassTemplateSpecializationDecl *cls);
@@ -224,6 +231,9 @@ private:
void ensure_lambda_type_is_relative(std::string &parameter_type) const;
void process_record_parent(
clang::RecordDecl *cls, class_ &c, const namespace_ &ns);
void process_function_parameter_find_relatinoships_in_autotype(
model::class_ &c, const clang::AutoType *atsp);