Diagram translation unit visitor base class. More...

Detailed Description

template<typename ConfigT, typename DiagramT>
class clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >

Diagram translation unit visitor base class.

This class provides common interface for diagram translation unit visitors.

Definition at line 54 of file translation_unit_visitor.h.

#include <translation_unit_visitor.h>

Public Types
using	config_t = ConfigT

using	diagram_t = DiagramT

Public Member Functions
	translation_unit_visitor (clang::SourceManager &sm, DiagramT &diagram, const ConfigT &config)
	Constructor.

virtual	~translation_unit_visitor ()=default

void	set_tu_path (const std::string &translation_unit_path)

const std::filesystem::path &	tu_path () const
	Return relative path to current translation unit.

common::visitor::ast_id_mapper &	id_mapper () const
	Get reference to Clang AST to clang-uml id mapper.

clang::SourceManager &	source_manager () const
	Get clang::SourceManager.

void	set_source_location (const clang::Decl &decl, clanguml::common::model::source_location &element)
	Set source location in diagram element.

void	set_source_location (const clang::Expr &expr, clanguml::common::model::source_location &element)
	Set source location in diagram element.

void	set_source_location (const clang::Stmt &stmt, clanguml::common::model::source_location &element)

void	set_qualified_name (const clang::NamedDecl &decl, clanguml::common::model::element &element)

void	set_source_location (const clang::SourceLocation &location, clanguml::common::model::source_location &element)
	Set source location in diagram element.

void	set_owning_module (const clang::Decl &decl, clanguml::common::model::element &element)

virtual void	add_diagram_element (std::unique_ptr< common::model::template_element > element)

void	process_comment (const clang::NamedDecl &decl, clanguml::common::model::decorated_element &e)
	Process comment directives in comment attached to a declaration.

std::string	process_comment (const clang::RawComment *comment, clang::DiagnosticsEngine &de, clanguml::common::model::decorated_element &e)
	Process comment directives in raw comment.

bool	skip_system_header_decl (const clang::NamedDecl *decl) const

bool	should_include (const clang::NamedDecl *decl) const
	Check if the diagram should include a declaration.

DiagramT &	diagram ()
	Get diagram model reference.

const DiagramT &	diagram () const
	Get diagram model reference.

const ConfigT &	config () const
	Get diagram config instance.

Protected Member Functions
std::set< const clang::RawComment * > &	processed_comments ()

Private Attributes
DiagramT &	diagram_

const ConfigT &	config_

clang::SourceManager &	source_manager_

std::unique_ptr< comment::comment_visitor >	comment_visitor_

std::filesystem::path	relative_to_path_

std::filesystem::path	translation_unit_path_

std::set< const clang::RawComment * >	processed_comments_

common::visitor::ast_id_mapper	id_mapper_

Member Typedef Documentation

◆ config_t

template<typename ConfigT , typename DiagramT >

using clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::config_t = ConfigT

Definition at line 56 of file translation_unit_visitor.h.

◆ diagram_t

template<typename ConfigT , typename DiagramT >

using clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::diagram_t = DiagramT

Definition at line 57 of file translation_unit_visitor.h.

Constructor & Destructor Documentation

◆ translation_unit_visitor()

template<typename ConfigT , typename DiagramT >

clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::translation_unit_visitor	(	clang::SourceManager &	sm,
		DiagramT &	diagram,
		const ConfigT &	config
	)

inlineexplicit

Constructor.

Parameters

sm	Reference to clang::SourceManager instance
config	Reference to clanguml::config::diagram configuration instance

Definition at line 66 of file translation_unit_visitor.h.

        : diagram_{diagram}
        , config_{config}
        , source_manager_{sm}
        , relative_to_path_{config.root_directory()}
    {
        if (config.comment_parser() == config::comment_parser_t::plain) {
            comment_visitor_ =
                std::make_unique<comment::plain_visitor>(source_manager_);
        }
        else if (config.comment_parser() == config::comment_parser_t::clang) {
            comment_visitor_ =
                std::make_unique<comment::clang_visitor>(source_manager_);
        }
    }

◆ ~translation_unit_visitor()

template<typename ConfigT , typename DiagramT >

virtual clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::~translation_unit_visitor ( )

virtualdefault

Reimplemented in clanguml::package_diagram::visitor::translation_unit_visitor, and clanguml::sequence_diagram::visitor::translation_unit_visitor.

Member Function Documentation

◆ add_diagram_element()

template<typename ConfigT , typename DiagramT >

virtual void clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::add_diagram_element ( std::unique_ptr< common::model::template_element > element )

inlinevirtual

Reimplemented in clanguml::class_diagram::visitor::translation_unit_visitor.

Definition at line 238 of file translation_unit_visitor.h.

240 {

241 }

◆ config()

template<typename ConfigT , typename DiagramT >

const ConfigT & clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::config ( ) const

inline

Get diagram config instance.

Returns: Reference to config instance

Definition at line 347 of file translation_unit_visitor.h.

347{ return config_; }

◆ diagram() [1/2]

template<typename ConfigT , typename DiagramT >

DiagramT & clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::diagram ( )

inline

Get diagram model reference.

Returns: Reference to diagram model created by the visitor

Definition at line 333 of file translation_unit_visitor.h.

333{ return diagram_; }

◆ diagram() [2/2]

template<typename ConfigT , typename DiagramT >

const DiagramT & clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::diagram ( ) const

inline

Get diagram model reference.

Returns: Reference to diagram model created by the visitor

Definition at line 340 of file translation_unit_visitor.h.

340{ return diagram_; }

◆ id_mapper()

template<typename ConfigT , typename DiagramT >

common::visitor::ast_id_mapper & clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::id_mapper ( ) const

inline

Get reference to Clang AST to clang-uml id mapper.

Returns: Reference to Clang AST to clang-uml id mapper

Definition at line 106 of file translation_unit_visitor.h.

106{ return id_mapper_; }

◆ process_comment() [1/2]

template<typename ConfigT , typename DiagramT >

void clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::process_comment	(	const clang::NamedDecl &	decl,
		clanguml::common::model::decorated_element &	e
	)

inline

Process comment directives in comment attached to a declaration.

Parameters

decl	Reference to clang::NamedDecl
element	Reference to element to be updated

Definition at line 249 of file translation_unit_visitor.h.

    {
        assert(comment_visitor_.get() != nullptr);
 
        comment_visitor_->visit(decl, e);
 
        auto *comment = decl.getASTContext().getRawCommentForDeclNoCache(&decl);
 
        process_comment(comment, decl.getASTContext().getDiagnostics(), e);
    }

◆ process_comment() [2/2]

template<typename ConfigT , typename DiagramT >

std::string clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::process_comment	(	const clang::RawComment *	comment,
		clang::DiagnosticsEngine &	de,
		clanguml::common::model::decorated_element &	e
	)

inline

Process comment directives in raw comment.

Parameters

comment	clang::RawComment pointer
de	Reference to clang::DiagnosticsEngine
element	Reference to element to be updated

Returns: Comment with uml directives stripped from it

Definition at line 269 of file translation_unit_visitor.h.

    {
        if (comment == nullptr)
            return {};
 
        auto [it, inserted] = processed_comments().emplace(comment);
 
        if (!inserted)
            return {};
 
        // Process clang-uml decorators in the comments
        // TODO: Refactor to use standard block comments processable by
        //       clang comments
        const auto &[decorators, stripped_comment] =
            decorators::parse(comment->getFormattedText(source_manager(), de));
 
        e.add_decorators(decorators);
 
        return stripped_comment;
    }

◆ processed_comments()

template<typename ConfigT , typename DiagramT >

std::set< const clang::RawComment * > & clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::processed_comments ( )

inlineprotected

Definition at line 350 of file translation_unit_visitor.h.

    {
        return processed_comments_;
    }

◆ set_owning_module()

template<typename ConfigT , typename DiagramT >

void clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::set_owning_module	(	const clang::Decl &	decl,
		clanguml::common::model::element &	element
	)

inline

Definition at line 216 of file translation_unit_visitor.h.

    {
        if (const clang::Module *module = decl.getOwningModule();
            module != nullptr) {
            std::string module_name = module->Name;
            bool is_private{false};
#if LLVM_VERSION_MAJOR < 15
            is_private = module->Kind ==
                clang::Module::ModuleKind::PrivateModuleFragment;
#else
            is_private = module->isPrivateModule();
#endif
            if (is_private) {
                // Clang just maps private modules names to "<private>"
                module_name = module->getTopLevelModule()->Name;
            }
            element.set_module(module_name);
            element.set_module_private(is_private);
        }
    }

◆ set_qualified_name()

template<typename ConfigT , typename DiagramT >

void clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::set_qualified_name	(	const clang::NamedDecl &	decl,
		clanguml::common::model::element &	element
	)

inline

Definition at line 145 of file translation_unit_visitor.h.

    {
        common::model::namespace_ ns{decl.getQualifiedNameAsString()};
        element.set_name(ns.name());
        ns.pop_back();
        element.set_namespace(ns);
    }

◆ set_source_location() [1/4]

template<typename ConfigT , typename DiagramT >

void clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::set_source_location	(	const clang::Decl &	decl,
		clanguml::common::model::source_location &	element
	)

inline

Set source location in diagram element.

Parameters

decl	Reference to clang::Decl
element	Reference to element to be updated

Definition at line 121 of file translation_unit_visitor.h.

    {
        set_source_location(decl.getLocation(), element);
    }

◆ set_source_location() [2/4]

template<typename ConfigT , typename DiagramT >

void clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::set_source_location	(	const clang::Expr &	expr,
		clanguml::common::model::source_location &	element
	)

inline

Set source location in diagram element.

Parameters

expr	Reference to clang::Expr
element	Reference to element to be updated

Definition at line 133 of file translation_unit_visitor.h.

    {
        set_source_location(expr.getBeginLoc(), element);
    }

◆ set_source_location() [3/4]

template<typename ConfigT , typename DiagramT >

void clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::set_source_location	(	const clang::SourceLocation &	location,
		clanguml::common::model::source_location &	element
	)

inline

Set source location in diagram element.

Parameters

location	Reference to clang::SourceLocation
element	Reference to element to be updated

Definition at line 160 of file translation_unit_visitor.h.

    {
        namespace fs = std::filesystem;
 
        std::string file;
        unsigned line{};
        unsigned column{};
 
        if (location.isValid()) {
            file = source_manager_.getFilename(location).str();
            line = source_manager_.getSpellingLineNumber(location);
            column = source_manager_.getSpellingColumnNumber(location);
 
            if (file.empty()) {
                // Why do I have to do this?
                parse_source_location(location.printToString(source_manager()),
                    file, line, column);
            }
        }
        else {
            auto success = parse_source_location(
                location.printToString(source_manager()), file, line, column);
            if (!success) {
                LOG_DBG("Failed to extract source location for element from {}",
                    location.printToString(source_manager_));
                return;
            }
        }
 
        // ensure the path is absolute
        fs::path file_path{file};
        if (!file_path.is_absolute()) {
            file_path = fs::absolute(file_path);
        }
 
        file_path = fs::weakly_canonical(file_path);
 
        file = file_path.string();
 
        element.set_file(file);
 
        if (util::is_relative_to(file_path, relative_to_path_)) {
            element.set_file_relative(util::path_to_url(
                fs::relative(element.file(), relative_to_path_).string()));
        }
        else {
            element.set_file_relative("");
        }
 
        element.set_translation_unit(tu_path().string());
        element.set_line(line);
        element.set_column(column);
        element.set_location_id(location.getHashValue());
    }

◆ set_source_location() [4/4]

template<typename ConfigT , typename DiagramT >

void clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::set_source_location	(	const clang::Stmt &	stmt,
		clanguml::common::model::source_location &	element
	)

inline

Definition at line 139 of file translation_unit_visitor.h.

    {
        set_source_location(stmt.getBeginLoc(), element);
    }

◆ set_tu_path()

template<typename ConfigT , typename DiagramT >

void clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::set_tu_path ( const std::string & translation_unit_path )

inline

Definition at line 85 of file translation_unit_visitor.h.

    {
        translation_unit_path_ = relative(
            std::filesystem::path{translation_unit_path}, relative_to_path_);
        translation_unit_path_.make_preferred();
    }

◆ should_include()

template<typename ConfigT , typename DiagramT >

bool clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::should_include ( const clang::NamedDecl * decl ) const

inline

Check if the diagram should include a declaration.

Parameters

decl	Clang declaration.

Returns: True, if the entity should be included in the diagram.

Definition at line 305 of file translation_unit_visitor.h.

    {
        if (decl == nullptr)
            return false;
 
        if (skip_system_header_decl(decl))
            return false;
 
        if (config().filter_mode() == config::filter_mode_t::advanced)
            return true;
 
        auto should_include_namespace = diagram().should_include(
            common::model::namespace_{decl->getQualifiedNameAsString()});
 
        const auto decl_file =
            decl->getLocation().printToString(source_manager());
 
        const auto should_include_decl_file =
            diagram().should_include(common::model::source_file{decl_file});
 
        return should_include_namespace && should_include_decl_file;
    }

◆ skip_system_header_decl()

template<typename ConfigT , typename DiagramT >

bool clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::skip_system_header_decl ( const clang::NamedDecl * decl ) const

inline

Definition at line 292 of file translation_unit_visitor.h.

    {
        return !config().include_system_headers() &&
            source_manager().isInSystemHeader(
                decl->getSourceRange().getBegin());
    }

◆ source_manager()

template<typename ConfigT , typename DiagramT >

clang::SourceManager & clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::source_manager ( ) const

inline

Get clang::SourceManager.

Returns: Reference to clang::SourceManager used by this translation unit visitor

Definition at line 113 of file translation_unit_visitor.h.

113{ return source_manager_; }

◆ tu_path()

template<typename ConfigT , typename DiagramT >

const std::filesystem::path & clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::tu_path ( ) const

inline

Return relative path to current translation unit.

Returns: Current translation unit path

Definition at line 96 of file translation_unit_visitor.h.

    {
        return translation_unit_path_;
    }

Member Data Documentation

◆ comment_visitor_

template<typename ConfigT , typename DiagramT >

std::unique_ptr<comment::comment_visitor> clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::comment_visitor_

private

Definition at line 364 of file translation_unit_visitor.h.

◆ config_

template<typename ConfigT , typename DiagramT >

const ConfigT& clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::config_

private

Definition at line 360 of file translation_unit_visitor.h.

◆ diagram_

template<typename ConfigT , typename DiagramT >

DiagramT& clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::diagram_

private

Definition at line 357 of file translation_unit_visitor.h.

◆ id_mapper_

template<typename ConfigT , typename DiagramT >

common::visitor::ast_id_mapper clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::id_mapper_

mutableprivate

Definition at line 372 of file translation_unit_visitor.h.

◆ processed_comments_

template<typename ConfigT , typename DiagramT >

std::set<const clang::RawComment *> clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::processed_comments_

private

Definition at line 370 of file translation_unit_visitor.h.

◆ relative_to_path_

template<typename ConfigT , typename DiagramT >

std::filesystem::path clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::relative_to_path_

private

Definition at line 366 of file translation_unit_visitor.h.

◆ source_manager_

template<typename ConfigT , typename DiagramT >

clang::SourceManager& clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::source_manager_

private

Definition at line 362 of file translation_unit_visitor.h.

◆ translation_unit_path_

template<typename ConfigT , typename DiagramT >

std::filesystem::path clanguml::common::visitor::translation_unit_visitor< ConfigT, DiagramT >::translation_unit_path_

private

Definition at line 368 of file translation_unit_visitor.h.

The documentation for this class was generated from the following file:

src/common/visitor/translation_unit_visitor.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Member Typedef Documentation

◆ config_t

◆ diagram_t

Constructor & Destructor Documentation

◆ translation_unit_visitor()

◆ ~translation_unit_visitor()

Member Function Documentation

◆ add_diagram_element()

◆ config()

◆ diagram() [1/2]

◆ diagram() [2/2]

◆ id_mapper()

◆ process_comment() [1/2]

◆ process_comment() [2/2]

◆ processed_comments()

◆ set_owning_module()

◆ set_qualified_name()

◆ set_source_location() [1/4]

◆ set_source_location() [2/4]

◆ set_source_location() [3/4]

◆ set_source_location() [4/4]

◆ set_tu_path()

◆ should_include()

◆ skip_system_header_decl()

◆ source_manager()

◆ tu_path()

Member Data Documentation

◆ comment_visitor_

◆ config_

◆ diagram_

◆ id_mapper_

◆ processed_comments_

◆ relative_to_path_

◆ source_manager_

◆ translation_unit_path_