Custom compilation database class. More...

Detailed Description

Custom compilation database class.

This class provides custom specialization of Clang's CompilationDatabase, which provides the possibility of adjusting the compilation flags after they have been loaded from the compile_commands.json file.

Definition at line 48 of file compilation_database.h.

#include <compilation_database.h>

Public Member Functions
	compilation_database (std::unique_ptr< clang::tooling::CompilationDatabase > base, const clanguml::config::config &cfg, bool is_fixed)

	~compilation_database () override=default

std::vector< clang::tooling::CompileCommand >	getCompileCommands (clang::StringRef FilePath) const override

std::vector< std::string >	getAllFiles () const override

std::vector< clang::tooling::CompileCommand >	getAllCompileCommands () const override

const clanguml::config::config &	config () const

const clang::tooling::CompilationDatabase &	base () const

std::string	guess_language_from_filename (const std::string &filename) const

size_t	count_matching_commands (const std::vector< std::string > &files) const

bool	is_fixed () const
	Determines whether this is a fixed or regular compilation database.

Static Public Member Functions
static std::unique_ptr< compilation_database >	auto_detect_from_directory (const clanguml::config::config &cfg)

Private Member Functions
bool	match_filename (const clang::tooling::CompileCommand &command, const std::string &file) const

void	adjust_compilation_database (std::vector< clang::tooling::CompileCommand > &commands) const

Private Attributes
std::unique_ptr< clang::tooling::CompilationDatabase >	base_

const clanguml::config::config &	config_

bool	is_fixed_

Constructor & Destructor Documentation

◆ compilation_database()

clanguml::common::compilation_database::compilation_database	(	std::unique_ptr< clang::tooling::CompilationDatabase >	base,
		const clanguml::config::config &	cfg,
		bool	is_fixed
	)

Definition at line 50 of file compilation_database.cc.

    : base_{std::move(base)}
    , config_{cfg}
    , is_fixed_{is_fixed}
{
}

◆ ~compilation_database()

clanguml::common::compilation_database::~compilation_database ( )

overridedefault

Member Function Documentation

◆ adjust_compilation_database()

void clanguml::common::compilation_database::adjust_compilation_database ( std::vector< clang::tooling::CompileCommand > & commands ) const

private

Definition at line 120 of file compilation_database.cc.

{
#if !defined(_WIN32)
    if (config().query_driver && !config().query_driver().empty()) {
        for (auto &compile_command : commands) {
            auto argv0 = config().query_driver() == "."
                ? compile_command.CommandLine.at(0)
                : config().query_driver();
 
            util::query_driver_output_extractor extractor{
                argv0, guess_language_from_filename(compile_command.Filename)};
 
            extractor.execute();
 
            std::vector<std::string> system_header_args;
            for (const auto &path : extractor.system_include_paths()) {
                system_header_args.emplace_back("-isystem");
                system_header_args.emplace_back(path);
            }
 
            compile_command.CommandLine.insert(
                compile_command.CommandLine.begin() + 1,
                system_header_args.begin(), system_header_args.end());
 
            if (!extractor.target().empty()) {
                compile_command.CommandLine.insert(
                    compile_command.CommandLine.begin() + 1,
                    fmt::format("--target={}", extractor.target()));
            }
        }
    }
#endif
 
    if (config().add_compile_flags && !config().add_compile_flags().empty()) {
        for (auto &compile_command : commands) {
            compile_command.CommandLine.insert(
                // Add flags after argv[0]
                compile_command.CommandLine.begin() + 1,
                config().add_compile_flags().begin(),
                config().add_compile_flags().end());
        }
    }
 
    if (config().remove_compile_flags &&
        !config().remove_compile_flags().empty()) {
        for (auto &compile_command : commands) {
            for (const auto &flag : config().remove_compile_flags()) {
                util::erase_if(compile_command.CommandLine,
                    [&flag](const auto &arg) { return flag == arg; });
            }
        }
    }
}

◆ auto_detect_from_directory()

std::unique_ptr< compilation_database > clanguml::common::compilation_database::auto_detect_from_directory ( const clanguml::config::config & cfg )

static

Loads the compilation database from directory specified on command line or in the configuration file.

Parameters

cfg	Reference to config instance

Returns: Instance of compilation_database.

Definition at line 26 of file compilation_database.cc.

{
    std::string error_message;
    auto res = clang::tooling::CompilationDatabase::autoDetectFromDirectory(
        cfg.compilation_database_dir(), error_message);
 
    if (!error_message.empty())
        throw error::compilation_database_error(error_message);
 
    if (res.get() == nullptr)
        throw error::compilation_database_error(fmt::format(
            "Autodetection of compilation database from directory '{}' failed",
            cfg.compilation_database_dir()));
 
    // This is a workaround to determine whether Clang loaded a fixed
    // compilation database or a proper one. This cannot be done with
    // dynamic_cast if RTTI was not enabled in the LLVM build
    bool is_fixed{res->getAllFiles().empty()};
 
    return std::make_unique<compilation_database>(
        std::move(res), cfg, is_fixed);
}

◆ base()

const clang::tooling::CompilationDatabase & clanguml::common::compilation_database::base ( ) const

Returns reference to CompilationDatabase as was loaded from file.

Returns: Reference to CompilationDatabase.

Definition at line 66 of file compilation_database.cc.

{
    return *base_;
}

◆ config()

const clanguml::config::config & clanguml::common::compilation_database::config ( ) const

Returns reference to clanguml's config instance.

Returns: Reference to config instance.

Definition at line 61 of file compilation_database.cc.

{
    return config_;
}

◆ count_matching_commands()

size_t clanguml::common::compilation_database::count_matching_commands ( const std::vector< std::string > & files ) const

Definition at line 105 of file compilation_database.cc.

{
    if (is_fixed())
        return files.size();
 
    auto result{0UL};
 
    for (const auto &f : files) {
        result += getCompileCommands(f).size();
    }
 
    return result;
}

◆ getAllCompileCommands()

std::vector< clang::tooling::CompileCommand > clanguml::common::compilation_database::getAllCompileCommands ( ) const

override

Retrieves and adjusts all compilation commands from the database.

Returns: List of adjusted compile commands.

Definition at line 87 of file compilation_database.cc.

{
    auto commands = base().getAllCompileCommands();
 
    adjust_compilation_database(commands);
 
    return commands;
}

◆ getAllFiles()

std::vector< std::string > clanguml::common::compilation_database::getAllFiles ( ) const

override

Returns all files in the database.

Returns: List of all files in compilation database.

Definition at line 71 of file compilation_database.cc.

{
    return base().getAllFiles();
}

◆ getCompileCommands()

std::vector< clang::tooling::CompileCommand > clanguml::common::compilation_database::getCompileCommands ( clang::StringRef FilePath ) const

override

Retrieves and adjusts compilation commands from the database, for a given translation unit.

Returns: List of adjusted compile commands.

Definition at line 77 of file compilation_database.cc.

{
    auto commands = base().getCompileCommands(FilePath);
 
    adjust_compilation_database(commands);
 
    return commands;
}

◆ guess_language_from_filename()

std::string clanguml::common::compilation_database::guess_language_from_filename ( const std::string & filename ) const

Definition at line 96 of file compilation_database.cc.

{
    if (util::ends_with(filename, std::string{".c"}))
        return "c";
 
    return "c++";
}

◆ is_fixed()

bool clanguml::common::compilation_database::is_fixed ( ) const

Determines whether this is a fixed or regular compilation database.

Fixed compilation database doesn't have any compilation commands attached to specific source files, just arguments that should be applied to any file.

Returns: True, if this is a fixed compilation database

Definition at line 59 of file compilation_database.cc.

59{ return is_fixed_; }

◆ match_filename()

bool clanguml::common::compilation_database::match_filename	(	const clang::tooling::CompileCommand &	command,
		const std::string &	file
	)		const

private

Definition at line 175 of file compilation_database.cc.

{
    auto command_filename = std::filesystem::path{command.Filename};
 
    if (!command_filename.is_absolute()) {
        command_filename = config().root_directory() / command_filename;
    }
 
    return (command_filename == file) ||
        (command_filename.lexically_normal().string() == file);
}

Member Data Documentation

◆ base_

std::unique_ptr<clang::tooling::CompilationDatabase> clanguml::common::compilation_database::base_

private

Pointer to the Clang's original compilation database.

Actual instance of the compilation database is stored in here. The inheritance is just to keep the interface.

Definition at line 132 of file compilation_database.h.

◆ config_

const clanguml::config::config& clanguml::common::compilation_database::config_

private

Reference to the instance of clanguml config.

Definition at line 137 of file compilation_database.h.

◆ is_fixed_

bool clanguml::common::compilation_database::is_fixed_

private

True, if this is a fixed compilation database, e.g. loaded from compile_flags.txt

Definition at line 143 of file compilation_database.h.

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

src/common/compilation_database.h
src/common/compilation_database.cc

Detailed Description

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ compilation_database()

◆ ~compilation_database()

Member Function Documentation

◆ adjust_compilation_database()

◆ auto_detect_from_directory()

◆ base()

◆ config()

◆ count_matching_commands()

◆ getAllCompileCommands()

◆ getAllFiles()

◆ getCompileCommands()

◆ guess_language_from_filename()

◆ is_fixed()

◆ match_filename()

Member Data Documentation

◆ base_

◆ config_

◆ is_fixed_