clang 19.0.0git
Public Member Functions | List of all members
clang::tooling::ArgumentsAdjustingCompilations Class Reference

#include "clang/Tooling/CommonOptionsParser.h"

Inheritance diagram for clang::tooling::ArgumentsAdjustingCompilations:
Inheritance graph
[legend]

Public Member Functions

 ArgumentsAdjustingCompilations (std::unique_ptr< CompilationDatabase > Compilations)
 
void appendArgumentsAdjuster (ArgumentsAdjuster Adjuster)
 
std::vector< CompileCommandgetCompileCommands (StringRef FilePath) const override
 Returns all compile commands in which the specified file was compiled.
 
std::vector< std::string > getAllFiles () const override
 Returns the list of all files available in the compilation database.
 
std::vector< CompileCommandgetAllCompileCommands () const override
 Returns all compile commands for all the files in the compilation database.
 
- Public Member Functions inherited from clang::tooling::CompilationDatabase
virtual ~CompilationDatabase ()
 
virtual std::vector< CompileCommandgetCompileCommands (StringRef FilePath) const =0
 Returns all compile commands in which the specified file was compiled.
 
virtual std::vector< std::string > getAllFiles () const
 Returns the list of all files available in the compilation database.
 
virtual std::vector< CompileCommandgetAllCompileCommands () const
 Returns all compile commands for all the files in the compilation database.
 

Additional Inherited Members

- Static Public Member Functions inherited from clang::tooling::CompilationDatabase
static std::unique_ptr< CompilationDatabaseloadFromDirectory (StringRef BuildDirectory, std::string &ErrorMessage)
 Loads a compilation database from a build directory.
 
static std::unique_ptr< CompilationDatabaseautoDetectFromSource (StringRef SourceFile, std::string &ErrorMessage)
 Tries to detect a compilation database location and load it.
 
static std::unique_ptr< CompilationDatabaseautoDetectFromDirectory (StringRef SourceDir, std::string &ErrorMessage)
 Tries to detect a compilation database location and load it.
 

Detailed Description

Definition at line 118 of file CommonOptionsParser.h.

Constructor & Destructor Documentation

◆ ArgumentsAdjustingCompilations()

clang::tooling::ArgumentsAdjustingCompilations::ArgumentsAdjustingCompilations ( std::unique_ptr< CompilationDatabase Compilations)
inline

Definition at line 120 of file CommonOptionsParser.h.

Member Function Documentation

◆ appendArgumentsAdjuster()

void ArgumentsAdjustingCompilations::appendArgumentsAdjuster ( ArgumentsAdjuster  Adjuster)

Definition at line 55 of file CommonOptionsParser.cpp.

◆ getAllCompileCommands()

std::vector< CompileCommand > ArgumentsAdjustingCompilations::getAllCompileCommands ( ) const
overridevirtual

Returns all compile commands for all the files in the compilation database.

FIXME: Add a layer in Tooling that provides an interface to run a tool over all files in a compilation database. Not all build systems have the ability to provide a feasible implementation for getAllCompileCommands.

By default, this is implemented in terms of getAllFiles() and getCompileCommands(). Subclasses may override this for efficiency.

Reimplemented from clang::tooling::CompilationDatabase.

Definition at line 71 of file CommonOptionsParser.cpp.

◆ getAllFiles()

std::vector< std::string > ArgumentsAdjustingCompilations::getAllFiles ( ) const
overridevirtual

Returns the list of all files available in the compilation database.

By default, returns nothing. Implementations should override this if they can enumerate their source files.

Reimplemented from clang::tooling::CompilationDatabase.

Definition at line 66 of file CommonOptionsParser.cpp.

◆ getCompileCommands()

std::vector< CompileCommand > ArgumentsAdjustingCompilations::getCompileCommands ( StringRef  FilePath) const
overridevirtual

Returns all compile commands in which the specified file was compiled.

This includes compile commands that span multiple source files. For example, consider a project with the following compilations: $ clang++ -o test a.cc b.cc t.cc $ clang++ -o production a.cc b.cc -DPRODUCTION A compilation database representing the project would return both command lines for a.cc and b.cc and only the first command line for t.cc.

Implements clang::tooling::CompilationDatabase.

Definition at line 60 of file CommonOptionsParser.cpp.


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