clanguml::common::generators::diagram_fronted_action< DiagramModel, DiagramConfig, DiagramVisitor > Class Template Reference

Specialization of clang::ASTFrontendAction More...

Detailed Description

template<typename DiagramModel, typename DiagramConfig, typename DiagramVisitor>
class clanguml::common::generators::diagram_fronted_action< DiagramModel, DiagramConfig, DiagramVisitor >

Specialization of clang::ASTFrontendAction

This class overrides the BeginSourceFileAction() and CreateASTConsumer() methods to create and setup an appropriate diagram_ast_consumer instance.

Template Parameters

DiagramModel	Type of diagram_model
DiagramConfig	Type of diagram_config
TranslationUnitVisitor	Type of translation_unit_visitor

Definition at line 313 of file generators.h.

#include <generators.h>

Public Member Functions
	diagram_fronted_action (DiagramModel &diagram, const DiagramConfig &config, std::function< void()> progress)
std::unique_ptr< clang::ASTConsumer >	CreateASTConsumer (clang::CompilerInstance &CI, clang::StringRef) override

Protected Member Functions
bool	BeginSourceFileAction (clang::CompilerInstance &ci) override

Private Attributes
DiagramModel &	diagram_
const DiagramConfig &	config_
std::function< void()>	progress_

Constructor & Destructor Documentation

diagram_fronted_action()

template<typename DiagramModel , typename DiagramConfig , typename DiagramVisitor >

clanguml::common::generators::diagram_fronted_action< DiagramModel, DiagramConfig, DiagramVisitor >::diagram_fronted_action ( DiagramModel &  diagram, const DiagramConfig &  config, std::function< void()>  progress  )

inlineexplicit

Definition at line 315 of file generators.h.

        : diagram_{diagram}
        , config_{config}
        , progress_{std::move(progress)}
    {
    }

Member Function Documentation

BeginSourceFileAction()

template<typename DiagramModel , typename DiagramConfig , typename DiagramVisitor >

bool clanguml::common::generators::diagram_fronted_action< DiagramModel, DiagramConfig, DiagramVisitor >::BeginSourceFileAction ( clang::CompilerInstance &  ci )

inlineoverrideprotected

Definition at line 339 of file generators.h.

    {
        LOG_DBG("Visiting source file: {}", getCurrentFile().str());
 
        // Update progress indicators, if enabled, on each translation
        // unit
        if (progress_)
            progress_();
 
        if constexpr (std::is_same_v<DiagramModel,
                          clanguml::include_diagram::model::diagram>) {
            auto find_includes_callback =
                std::make_unique<typename DiagramVisitor::include_visitor>(
                    ci.getSourceManager(), diagram_, config_);
 
            clang::Preprocessor &pp = ci.getPreprocessor();
 
            pp.addPPCallbacks(std::move(find_includes_callback));
        }
 
        return true;
    }

CreateASTConsumer()

template<typename DiagramModel , typename DiagramConfig , typename DiagramVisitor >

std::unique_ptr< clang::ASTConsumer > clanguml::common::generators::diagram_fronted_action< DiagramModel, DiagramConfig, DiagramVisitor >::CreateASTConsumer ( clang::CompilerInstance &  CI, clang::StringRef    )

inlineoverride

Definition at line 323 of file generators.h.

    {
        auto ast_consumer = std::make_unique<
            diagram_ast_consumer<DiagramModel, DiagramConfig, DiagramVisitor>>(
            CI, diagram_, config_);
 
        if constexpr (!std::is_same_v<DiagramModel,
                          clanguml::include_diagram::model::diagram>) {
            ast_consumer->visitor().set_tu_path(getCurrentFile().str());
        }
 
        return ast_consumer;
    }

Member Data Documentation

config_

template<typename DiagramModel , typename DiagramConfig , typename DiagramVisitor >

const DiagramConfig& clanguml::common::generators::diagram_fronted_action< DiagramModel, DiagramConfig, DiagramVisitor >::config_

private

Definition at line 364 of file generators.h.

diagram_

template<typename DiagramModel , typename DiagramConfig , typename DiagramVisitor >

DiagramModel& clanguml::common::generators::diagram_fronted_action< DiagramModel, DiagramConfig, DiagramVisitor >::diagram_

private

Definition at line 363 of file generators.h.

progress_

template<typename DiagramModel , typename DiagramConfig , typename DiagramVisitor >

std::function<void()> clanguml::common::generators::diagram_fronted_action< DiagramModel, DiagramConfig, DiagramVisitor >::progress_

private

Definition at line 365 of file generators.h.

---

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

• src/common/generators/generators.h