clanguml::generators::clang_tool Class Reference

Custom ClangTool implementation to enable better error handling. More...

Detailed Description

Custom ClangTool implementation to enable better error handling.

Definition at line 71 of file clang_tool.h.

#include <clang_tool.h>

Public Member Functions
	clang_tool (common::model::diagram_t diagram_type, std::string diagram_name, const clanguml::common::compilation_database &compilations, const std::vector< std::string > &source_paths, std::filesystem::path relative_to, bool quiet)
	~clang_tool ()
void	append_arguments_adjuster (clang::tooling::ArgumentsAdjuster Adjuster)
void	run (ToolAction *Action)

Private Attributes
const common::model::diagram_t	diagram_type_
const std::string	diagram_name_
const clanguml::common::compilation_database &	compilations_
std::vector< std::string >	source_paths_
bool	quiet_
std::shared_ptr< PCHContainerOperations >	pch_container_ops_
llvm::IntrusiveRefCntPtr< llvm::vfs::OverlayFileSystem >	overlay_fs_
llvm::IntrusiveRefCntPtr< llvm::vfs::InMemoryFileSystem >	inmemory_fs_
llvm::IntrusiveRefCntPtr< FileManager >	files_
std::vector< std::pair< StringRef, StringRef > >	memory_mapped_files_
llvm::StringSet	visited_working_directories_
ArgumentsAdjuster	args_adjuster_
std::unique_ptr< diagnostic_consumer >	diag_consumer_
llvm::IntrusiveRefCntPtr< clang::DiagnosticOptions >	diag_opts_

Constructor & Destructor Documentation

clang_tool()

clanguml::generators::clang_tool::clang_tool	(	common::model::diagram_t	diagram_type,
		std::string	diagram_name,
		const clanguml::common::compilation_database &	compilations,
		const std::vector< std::string > &	source_paths,
		std::filesystem::path	relative_to,
		bool	quiet
	)

Definition at line 108 of file clang_tool.cc.

    : diagram_type_{diagram_type}
    , diagram_name_{std::move(diagram_name)}
    , compilations_{compilation_database}
    , source_paths_{source_paths}
    , quiet_{quiet}
    , pch_container_ops_{std::make_shared<PCHContainerOperations>()}
    , overlay_fs_{new llvm::vfs::OverlayFileSystem(
          llvm::vfs::getRealFileSystem())}
    , inmemory_fs_{new llvm::vfs::InMemoryFileSystem}
    , files_{new FileManager(FileSystemOptions(), overlay_fs_)}
    , diag_consumer_{std::make_unique<diagnostic_consumer>(relative_to)}
    , diag_opts_{new clang::DiagnosticOptions}
{
    overlay_fs_->pushOverlay(inmemory_fs_);
 
    append_arguments_adjuster(getClangStripOutputAdjuster());
    append_arguments_adjuster(getClangSyntaxOnlyAdjuster());
    append_arguments_adjuster(getClangStripDependencyFileAdjuster());
}

~clang_tool()

clanguml::generators::clang_tool::~clang_tool ( )

default

Member Function Documentation

append_arguments_adjuster()

void clanguml::generators::clang_tool::append_arguments_adjuster

(

clang::tooling::ArgumentsAdjuster

Adjuster

)

Definition at line 135 of file clang_tool.cc.

{
    args_adjuster_ =
        combineAdjusters(std::move(args_adjuster_), std::move(Adjuster));
}

run()

void clanguml::generators::clang_tool::run

(

ToolAction *

Action

)

Definition at line 141 of file clang_tool.cc.

{
    static int static_symbol;
 
    std::vector<std::string> absolute_tu_paths;
    absolute_tu_paths.reserve(source_paths_.size());
    for (const auto &source_path : source_paths_) {
        auto absolute_tu_path =
            clang::tooling::getAbsolutePath(*overlay_fs_, source_path);
        if (!absolute_tu_path) {
            if (!quiet_) {
                LOG_WARN("Skipping file {} in diagram {}. Could not resolve "
                         "absolute path for translation unit: {}",
                    source_path, diagram_name_,
                    llvm::toString(absolute_tu_path.takeError()));
            }
            continue;
        }
        absolute_tu_paths.emplace_back(std::move(*absolute_tu_path));
    }
 
    // Remember the working directory in case we need to restore it.
    std::string initial_workdir;
    if (auto current_workdir = overlay_fs_->getCurrentWorkingDirectory()) {
        initial_workdir = std::move(*current_workdir);
    }
    else {
        if (!quiet_)
            LOG_ERROR("Could not get current working directory when generating "
                      "diagram '{}': {}",
                diagram_name_, current_workdir.getError().message());
    }
 
    for (const auto &file : absolute_tu_paths) {
        if (!quiet_)
            LOG_INFO("Processing diagram '{}' translation unit: {}",
                diagram_name_, file);
 
        auto compile_commands_for_file = compilations_.getCompileCommands(file);
 
        if (compile_commands_for_file.empty()) {
            if (!quiet_)
                LOG_WARN(
                    "Skipping file {} for diagram '{}'. Compilation command "
                    "not found.",
                    file, diagram_name_);
            continue;
        }
 
        if (compile_commands_for_file.size() > 1 &&
            diagram_type_ == common::model::diagram_t::kSequence) {
            LOG_WARN("Multiple compile commands detected for file '{}' in "
                     "diagram '{}' - using only the first one...",
                file, diagram_name_);
        }
 
        for (auto &compile_command : compile_commands_for_file) {
            if (overlay_fs_->setCurrentWorkingDirectory(
                    compile_command.Directory))
                llvm::report_fatal_error("Cannot chdir into \"" +
                    Twine(compile_command.Directory) + "\"!");
 
            // Now fill the in-memory VFS with the relative file mappings so it
            // will have the correct relative paths. We never remove mappings
            // but that should be fine.
            if (visited_working_directories_.insert(compile_command.Directory)
                    .second) {
                for (const auto &[file_name, file_content] :
                    memory_mapped_files_)
                    if (!llvm::sys::path::is_absolute(file_name))
                        inmemory_fs_->addFile(file_name, 0,
                            llvm::MemoryBuffer::getMemBuffer(file_content));
            }
 
            auto command_line = compile_command.CommandLine;
            if (args_adjuster_)
                command_line =
                    args_adjuster_(command_line, compile_command.Filename);
 
            assert(!command_line.empty());
 
            inject_resource_dir(command_line, "clang_tool", &static_symbol);
 
            ToolInvocation invocation(std::move(command_line), Action,
                files_.get(), pch_container_ops_);
            invocation.setDiagnosticConsumer(diag_consumer_.get());
#if LLVM_VERSION_MAJOR > 13
            invocation.setDiagnosticOptions(diag_opts_.get());
#endif
 
            if (!invocation.run() || diag_consumer_->failed) {
                if (!initial_workdir.empty()) {
                    if (const auto ec = overlay_fs_->setCurrentWorkingDirectory(
                            initial_workdir);
                        ec)
                        if (!quiet_)
                            LOG_ERROR("Error when trying to restore working "
                                      "directory: {}",
                                ec.message());
                }
 
                if (diag_consumer_ && diag_consumer_->failed) {
                    if (!(diag_consumer_->diagnostics.empty())) {
                        throw clang_tool_exception(diagram_type_, diagram_name_,
                            diag_consumer_->diagnostics,
                            to_string(diag_consumer_->diagnostics.back()));
                    }
 
                    throw clang_tool_exception(diagram_type_, diagram_name_,
                        diag_consumer_->diagnostics);
                }
 
                throw std::runtime_error(
                    fmt::format("Unknown error while processing {}", file));
            }
 
            if (diagram_type_ == common::model::diagram_t::kSequence)
                break;
        }
    }
 
    if (!initial_workdir.empty()) {
        if (const auto ec =
                overlay_fs_->setCurrentWorkingDirectory(initial_workdir))
            if (!quiet_)
                LOG_ERROR("Error when trying to restore working dir: {}",
                    ec.message());
    }
}

Member Data Documentation

args_adjuster_

ArgumentsAdjuster clanguml::generators::clang_tool::args_adjuster_

private

Definition at line 103 of file clang_tool.h.

compilations_

const clanguml::common::compilation_database& clanguml::generators::clang_tool::compilations_

private

Definition at line 87 of file clang_tool.h.

diag_consumer_

std::unique_ptr<diagnostic_consumer> clanguml::generators::clang_tool::diag_consumer_

private

Definition at line 105 of file clang_tool.h.

diag_opts_

llvm::IntrusiveRefCntPtr<clang::DiagnosticOptions> clanguml::generators::clang_tool::diag_opts_

private

Definition at line 106 of file clang_tool.h.

diagram_name_

const std::string clanguml::generators::clang_tool::diagram_name_

private

Definition at line 86 of file clang_tool.h.

diagram_type_

const common::model::diagram_t clanguml::generators::clang_tool::diagram_type_

private

Definition at line 85 of file clang_tool.h.

files_

llvm::IntrusiveRefCntPtr<FileManager> clanguml::generators::clang_tool::files_

private

Definition at line 95 of file clang_tool.h.

inmemory_fs_

llvm::IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> clanguml::generators::clang_tool::inmemory_fs_

private

Definition at line 94 of file clang_tool.h.

memory_mapped_files_

std::vector< std::pair<StringRef , StringRef > > clanguml::generators::clang_tool::memory_mapped_files_

private

Definition at line 99 of file clang_tool.h.

overlay_fs_

llvm::IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem> clanguml::generators::clang_tool::overlay_fs_

private

Definition at line 93 of file clang_tool.h.

pch_container_ops_

std::shared_ptr<PCHContainerOperations> clanguml::generators::clang_tool::pch_container_ops_

private

Definition at line 91 of file clang_tool.h.

quiet_

bool clanguml::generators::clang_tool::quiet_

private

Definition at line 89 of file clang_tool.h.

source_paths_

std::vector<std::string> clanguml::generators::clang_tool::source_paths_

private

Definition at line 88 of file clang_tool.h.

visited_working_directories_

llvm::StringSet clanguml::generators::clang_tool::visited_working_directories_

private

Definition at line 101 of file clang_tool.h.

---

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

• src/common/generators/clang_tool.h
• src/common/generators/clang_tool.cc