Utility to run a FrontendAction over a set of files. More...
#include <Tooling.h>
Public Member Functions | |
| ClangTool (const CompilationDatabase &Compilations, ArrayRef< std::string > SourcePaths) | |
| Constructs a clang tool to run over a list of files. | |
| ~ClangTool () | |
| void | setDiagnosticConsumer (DiagnosticConsumer *DiagConsumer) |
Set a DiagnosticConsumer to use during parsing. | |
| void | mapVirtualFile (StringRef FilePath, StringRef Content) |
| Map a virtual file to be used while running the tool. | |
| void | appendArgumentsAdjuster (ArgumentsAdjuster *Adjuster) |
| Append a command line arguments adjuster to the adjuster chain. | |
| void | clearArgumentsAdjusters () |
| Clear the command line arguments adjuster chain. | |
| int | run (ToolAction *Action) |
| int | buildASTs (std::vector< std::unique_ptr< ASTUnit >> &ASTs) |
| Create an AST for each file specified in the command line and append them to ASTs. | |
| FileManager & | getFiles () |
| Returns the file manager used in the tool. | |
Detailed Description
Utility to run a FrontendAction over a set of files.
This class is written to be usable for command line utilities. By default the class uses ClangSyntaxOnlyAdjuster to modify command line arguments before the arguments are used to run a frontend action. One could install an additional command line arguments adjuster by calling the appendArgumentsAdjuster() method.
Constructor & Destructor Documentation
| clang::tooling::ClangTool::ClangTool | ( | const CompilationDatabase & | Compilations, |
| ArrayRef< std::string > | SourcePaths | ||
| ) |
Constructs a clang tool to run over a list of files.
- Parameters:
-
Compilations The CompilationDatabase which contains the compile command lines for the given source paths. SourcePaths The source files to run over. If a source files is not found in Compilations, it is skipped.
Definition at line 270 of file Tooling.cpp.
References appendArgumentsAdjuster().
Definition at line 278 of file Tooling.cpp.
Member Function Documentation
| void clang::tooling::ClangTool::appendArgumentsAdjuster | ( | ArgumentsAdjuster * | Adjuster | ) |
Append a command line arguments adjuster to the adjuster chain.
- Parameters:
-
Adjuster An argument adjuster, which will be run on the output of previous argument adjusters.
Definition at line 284 of file Tooling.cpp.
Referenced by ClangTool().
| int clang::tooling::ClangTool::buildASTs | ( | std::vector< std::unique_ptr< ASTUnit >> & | ASTs | ) |
Create an AST for each file specified in the command line and append them to ASTs.
Definition at line 393 of file Tooling.cpp.
Clear the command line arguments adjuster chain.
Definition at line 288 of file Tooling.cpp.
| FileManager& clang::tooling::ClangTool::getFiles | ( | ) | [inline] |
Returns the file manager used in the tool.
The file manager is shared between all translation units.
Definition at line 289 of file Tooling.h.
Referenced by clang::tooling::RefactoringTool::runAndSave().
| void clang::tooling::ClangTool::mapVirtualFile | ( | StringRef | FilePath, |
| StringRef | Content | ||
| ) |
Map a virtual file to be used while running the tool.
- Parameters:
-
FilePath The path at which the content will be mapped. Content A null terminated buffer of the file's content.
Definition at line 280 of file Tooling.cpp.
| int clang::tooling::ClangTool::run | ( | ToolAction * | Action | ) |
Runs an action over all files specified in the command line.
- Parameters:
-
Action Tool action.
Definition at line 292 of file Tooling.cpp.
References clang::tooling::CompileCommand::CommandLine, CommandLine, clang::tooling::CompileCommand::Directory, clang::tooling::getAbsolutePath(), and clang::tooling::CompilationDatabase::getCompileCommands().
Referenced by buildASTs(), and clang::tooling::RefactoringTool::runAndSave().
| void clang::tooling::ClangTool::setDiagnosticConsumer | ( | DiagnosticConsumer * | DiagConsumer | ) | [inline] |
Set a DiagnosticConsumer to use during parsing.
The documentation for this class was generated from the following files: