clang  14.0.0git
Public Member Functions | List of all members
clang::tooling::ToolInvocation Class Reference

Utility to run a FrontendAction in a single clang invocation. More...

#include "clang/Tooling/Tooling.h"

Public Member Functions

 ToolInvocation (std::vector< std::string > CommandLine, std::unique_ptr< FrontendAction > FAction, FileManager *Files, std::shared_ptr< PCHContainerOperations > PCHContainerOps=std::make_shared< PCHContainerOperations >())
 Create a tool invocation. More...
 
 ToolInvocation (std::vector< std::string > CommandLine, ToolAction *Action, FileManager *Files, std::shared_ptr< PCHContainerOperations > PCHContainerOps)
 Create a tool invocation. More...
 
 ~ToolInvocation ()
 
void setDiagnosticConsumer (DiagnosticConsumer *DiagConsumer)
 Set a DiagnosticConsumer to use during driver command-line parsing and the action invocation itself. More...
 
void setDiagnosticOptions (DiagnosticOptions *DiagOpts)
 Set a DiagnosticOptions to use during driver command-line parsing. More...
 
bool run ()
 Run the clang invocation. More...
 

Detailed Description

Utility to run a FrontendAction in a single clang invocation.

Definition at line 240 of file Tooling.h.

Constructor & Destructor Documentation

◆ ToolInvocation() [1/2]

clang::tooling::ToolInvocation::ToolInvocation ( std::vector< std::string CommandLine,
std::unique_ptr< FrontendAction FAction,
FileManager Files,
std::shared_ptr< PCHContainerOperations PCHContainerOps = std::make_shared< PCHContainerOperations >() 
)

Create a tool invocation.

Parameters
CommandLineThe command line arguments to clang. Note that clang uses its binary name (CommandLine[0]) to locate its builtin headers. Callers have to ensure that they are installed in a compatible location (see clang driver implementation) or mapped in via mapVirtualFile.
FActionThe action to be executed.
FilesThe FileManager used for the execution. Class does not take ownership.
PCHContainerOpsThe PCHContainerOperations for loading and creating clang modules.

◆ ToolInvocation() [2/2]

ToolInvocation::ToolInvocation ( std::vector< std::string CommandLine,
ToolAction Action,
FileManager Files,
std::shared_ptr< PCHContainerOperations PCHContainerOps 
)

Create a tool invocation.

Parameters
CommandLineThe command line arguments to clang.
ActionThe action to be executed.
FilesThe FileManager used for the execution.
PCHContainerOpsThe PCHContainerOperations for loading and creating clang modules.

Definition at line 321 of file Tooling.cpp.

◆ ~ToolInvocation()

ToolInvocation::~ToolInvocation ( )

Definition at line 336 of file Tooling.cpp.

Member Function Documentation

◆ run()

bool ToolInvocation::run ( )

◆ setDiagnosticConsumer()

void clang::tooling::ToolInvocation::setDiagnosticConsumer ( DiagnosticConsumer DiagConsumer)
inline

Set a DiagnosticConsumer to use during driver command-line parsing and the action invocation itself.

Definition at line 273 of file Tooling.h.

Referenced by clang::tooling::buildASTFromCodeWithArgs(), and clang::tooling::dependencies::DependencyScanningWorker::computeDependencies().

◆ setDiagnosticOptions()

void clang::tooling::ToolInvocation::setDiagnosticOptions ( DiagnosticOptions DiagOpts)
inline

Set a DiagnosticOptions to use during driver command-line parsing.

Definition at line 278 of file Tooling.h.

Referenced by clang::tooling::dependencies::DependencyScanningWorker::computeDependencies().


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