clanguml::util::query_driver_output_extractor Class Reference

Executed compiler frontend and extract default system paths. More...

Detailed Description

Executed compiler frontend and extract default system paths.

This class - inspired by the clangd language server - will invoke the provided compiler command and query it for its default system paths, which then will be added to each compile command in the database.

Definition at line 33 of file query_driver_output_extractor.h.

#include <query_driver_output_extractor.h>

Public Member Functions
	query_driver_output_extractor (std::string command, std::string language)
	Constructor.
	~query_driver_output_extractor ()=default
void	execute ()
	Execute the command and extract compiler flags and include paths.
void	extract_target (const std::string &output)
	Extract target name from the compiler output.
void	extract_system_include_paths (const std::string &output)
	Extract system include paths from the compiler output.
const std::string &	target () const
	Name of the target of the compiler command (e.g. x86_64-linux-gnu)
const std::vector< std::string > &	system_include_paths () const
	Return list of include system paths.

Private Attributes
std::string	command_
std::string	language_
std::string	target_
std::vector< std::string >	system_include_paths_

Constructor & Destructor Documentation

query_driver_output_extractor()

clanguml::util::query_driver_output_extractor::query_driver_output_extractor	(	std::string	command,
		std::string	language
	)

Constructor.

Parameters

command	Command to execute the compiler frontend
language	Language name to query for (C or C++)

Definition at line 29 of file query_driver_output_extractor.cc.

    : command_{std::move(command)}
    , language_{std::move(language)}
{
}

~query_driver_output_extractor()

clanguml::util::query_driver_output_extractor::~query_driver_output_extractor ( )

default

Member Function Documentation

execute()

void clanguml::util::query_driver_output_extractor::execute

(

)

Execute the command and extract compiler flags and include paths.

Definition at line 36 of file query_driver_output_extractor.cc.

{
    auto cmd =
        fmt::format("{} -E -v -x {} /dev/null 2>&1", command_, language_);
 
    LOG_DBG("Executing query driver command: {}", cmd);
 
    auto driver_output = get_process_output(cmd);
 
    system_include_paths_.clear();
    extract_system_include_paths(driver_output);
    extract_target(driver_output);
 
    if (system_include_paths_.empty()) {
        throw error::query_driver_no_paths(fmt::format(
            "Compiler driver {} did not report any system include paths "
            "in its output: {}",
            command_, driver_output));
    }
 
    LOG_DBG("Extracted the following paths from compiler driver: {}",
        fmt::join(system_include_paths_, ","));
}

extract_system_include_paths()

void clanguml::util::query_driver_output_extractor::extract_system_include_paths

(

const std::string &

output

)

Extract system include paths from the compiler output.

Parameters

output

Compiler query driver output

Definition at line 74 of file query_driver_output_extractor.cc.

{
    std::istringstream f(output);
    std::string line;
 
    bool in_include_paths_range{false};
    while (std::getline(f, line)) {
        line = trim(line);
        if (line == "#include <...> search starts here:") {
            in_include_paths_range = true;
            continue;
        }
        if (line == "End of search list.") {
            break;
        }
 
        if (in_include_paths_range) {
            system_include_paths_.emplace_back(line);
        }
    }
}

extract_target()

void clanguml::util::query_driver_output_extractor::extract_target

(

const std::string &

output

)

Extract target name from the compiler output.

Parameters

output

Compiler query driver output

Definition at line 60 of file query_driver_output_extractor.cc.

{
    std::istringstream f(output);
    std::string line;
 
    while (std::getline(f, line)) {
        line = trim(line);
        if (util::starts_with(line, std::string{"Target: "})) {
            target_ = line.substr(strlen("Target: "));
            break;
        }
    }
}

system_include_paths()

const std::vector< std::string > & clanguml::util::query_driver_output_extractor::system_include_paths

(

)

const

Return list of include system paths.

Returns

List of include system paths

Definition at line 98 of file query_driver_output_extractor.cc.

{
    return system_include_paths_;
}

target()

const std::string & clanguml::util::query_driver_output_extractor::target

(

)

const

Name of the target of the compiler command (e.g. x86_64-linux-gnu)

Returns

Target name

Definition at line 103 of file query_driver_output_extractor.cc.

{
    return target_;
}

Member Data Documentation

command_

std::string clanguml::util::query_driver_output_extractor::command_

private

Definition at line 79 of file query_driver_output_extractor.h.

language_

std::string clanguml::util::query_driver_output_extractor::language_

private

Definition at line 80 of file query_driver_output_extractor.h.

system_include_paths_

std::vector<std::string> clanguml::util::query_driver_output_extractor::system_include_paths_

private

Definition at line 82 of file query_driver_output_extractor.h.

target_

std::string clanguml::util::query_driver_output_extractor::target_

private

Definition at line 81 of file query_driver_output_extractor.h.

---

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

• src/util/query_driver_output_extractor.h
• src/util/query_driver_output_extractor.cc