clang  6.0.0svn
Public Member Functions | List of all members
clang::PPChainedCallbacks Class Reference

Simple wrapper class for chaining callbacks. More...

#include "clang/Lex/PPCallbacks.h"

Inheritance diagram for clang::PPChainedCallbacks:
Inheritance graph
[legend]
Collaboration diagram for clang::PPChainedCallbacks:
Collaboration graph
[legend]

Public Member Functions

 PPChainedCallbacks (std::unique_ptr< PPCallbacks > _First, std::unique_ptr< PPCallbacks > _Second)
 
void FileChanged (SourceLocation Loc, FileChangeReason Reason, SrcMgr::CharacteristicKind FileType, FileID PrevFID) override
 Callback invoked whenever a source file is entered or exited. More...
 
void FileSkipped (const FileEntry &SkippedFile, const Token &FilenameTok, SrcMgr::CharacteristicKind FileType) override
 Callback invoked whenever a source file is skipped as the result of header guard optimization. More...
 
bool FileNotFound (StringRef FileName, SmallVectorImpl< char > &RecoveryPath) override
 Callback invoked whenever an inclusion directive results in a file-not-found error. More...
 
void InclusionDirective (SourceLocation HashLoc, const Token &IncludeTok, StringRef FileName, bool IsAngled, CharSourceRange FilenameRange, const FileEntry *File, StringRef SearchPath, StringRef RelativePath, const Module *Imported) override
 Callback invoked whenever an inclusion directive of any kind (#include, #import, etc.) has been processed, regardless of whether the inclusion will actually result in an inclusion. More...
 
void moduleImport (SourceLocation ImportLoc, ModuleIdPath Path, const Module *Imported) override
 Callback invoked whenever there was an explicit module-import syntax. More...
 
void EndOfMainFile () override
 Callback invoked when the end of the main file is reached. More...
 
void Ident (SourceLocation Loc, StringRef str) override
 Callback invoked when a #ident or #sccs directive is read. More...
 
void PragmaDirective (SourceLocation Loc, PragmaIntroducerKind Introducer) override
 Callback invoked when start reading any pragma directive. More...
 
void PragmaComment (SourceLocation Loc, const IdentifierInfo *Kind, StringRef Str) override
 Callback invoked when a #pragma comment directive is read. More...
 
void PragmaDetectMismatch (SourceLocation Loc, StringRef Name, StringRef Value) override
 Callback invoked when a #pragma detect_mismatch directive is read. More...
 
void PragmaMessage (SourceLocation Loc, StringRef Namespace, PragmaMessageKind Kind, StringRef Str) override
 Callback invoked when a #pragma message directive is read. More...
 
void PragmaDiagnosticPush (SourceLocation Loc, StringRef Namespace) override
 Callback invoked when a #pragma gcc diagnostic push directive is read. More...
 
void PragmaDiagnosticPop (SourceLocation Loc, StringRef Namespace) override
 Callback invoked when a #pragma gcc diagnostic pop directive is read. More...
 
void PragmaDiagnostic (SourceLocation Loc, StringRef Namespace, diag::Severity mapping, StringRef Str) override
 Callback invoked when a #pragma gcc diagnostic directive is read. More...
 
void PragmaOpenCLExtension (SourceLocation NameLoc, const IdentifierInfo *Name, SourceLocation StateLoc, unsigned State) override
 Called when an OpenCL extension is either disabled or enabled with a pragma. More...
 
void PragmaWarning (SourceLocation Loc, StringRef WarningSpec, ArrayRef< int > Ids) override
 Callback invoked when a #pragma warning directive is read. More...
 
void PragmaWarningPush (SourceLocation Loc, int Level) override
 Callback invoked when a #pragma warning(push) directive is read. More...
 
void PragmaWarningPop (SourceLocation Loc) override
 Callback invoked when a #pragma warning(pop) directive is read. More...
 
void PragmaAssumeNonNullBegin (SourceLocation Loc) override
 Callback invoked when a #pragma clang assume_nonnull begin directive is read. More...
 
void PragmaAssumeNonNullEnd (SourceLocation Loc) override
 Callback invoked when a #pragma clang assume_nonnull end directive is read. More...
 
void MacroExpands (const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range, const MacroArgs *Args) override
 Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found. More...
 
void MacroDefined (const Token &MacroNameTok, const MacroDirective *MD) override
 Hook called whenever a macro definition is seen. More...
 
void MacroUndefined (const Token &MacroNameTok, const MacroDefinition &MD, const MacroDirective *Undef) override
 Hook called whenever a macro #undef is seen. More...
 
void Defined (const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range) override
 Hook called whenever the 'defined' operator is seen. More...
 
void SourceRangeSkipped (SourceRange Range, SourceLocation EndifLoc) override
 Hook called when a source range is skipped. More...
 
void If (SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue) override
 Hook called whenever an #if is seen. More...
 
void Elif (SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue, SourceLocation IfLoc) override
 Hook called whenever an #elif is seen. More...
 
void Ifdef (SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) override
 Hook called whenever an #ifdef is seen. More...
 
void Ifndef (SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) override
 Hook called whenever an #ifndef is seen. More...
 
void Else (SourceLocation Loc, SourceLocation IfLoc) override
 Hook called whenever an #else is seen. More...
 
void Endif (SourceLocation Loc, SourceLocation IfLoc) override
 Hook called whenever an #endif is seen. More...
 
- Public Member Functions inherited from clang::PPCallbacks
virtual ~PPCallbacks ()
 
virtual void PragmaDebug (SourceLocation Loc, StringRef DebugType)
 Callback invoked when a #pragma clang __debug directive is read. More...
 

Additional Inherited Members

- Public Types inherited from clang::PPCallbacks
enum  FileChangeReason { EnterFile, ExitFile, SystemHeaderPragma, RenameFile }
 
enum  PragmaMessageKind { PMK_Message, PMK_Warning, PMK_Error }
 Determines the kind of #pragma invoking a call to PragmaMessage. More...
 
enum  ConditionValueKind { CVK_NotEvaluated, CVK_False, CVK_True }
 

Detailed Description

Simple wrapper class for chaining callbacks.

Definition at line 337 of file PPCallbacks.h.

Constructor & Destructor Documentation

◆ PPChainedCallbacks()

clang::PPChainedCallbacks::PPChainedCallbacks ( std::unique_ptr< PPCallbacks _First,
std::unique_ptr< PPCallbacks _Second 
)
inline

Definition at line 342 of file PPCallbacks.h.

Member Function Documentation

◆ Defined()

void clang::PPChainedCallbacks::Defined ( const Token MacroNameTok,
const MacroDefinition MD,
SourceRange  Range 
)
inlineoverridevirtual

Hook called whenever the 'defined' operator is seen.

Parameters
MDThe MacroDirective if the name was a macro, null otherwise.

Reimplemented from clang::PPCallbacks.

Definition at line 486 of file PPCallbacks.h.

◆ Elif()

void clang::PPChainedCallbacks::Elif ( SourceLocation  Loc,
SourceRange  ConditionRange,
ConditionValueKind  ConditionValue,
SourceLocation  IfLoc 
)
inlineoverridevirtual

Hook called whenever an #elif is seen.

Reimplemented from clang::PPCallbacks.

Definition at line 505 of file PPCallbacks.h.

◆ Else()

void clang::PPChainedCallbacks::Else ( SourceLocation  Loc,
SourceLocation  IfLoc 
)
inlineoverridevirtual

Hook called whenever an #else is seen.

Reimplemented from clang::PPCallbacks.

Definition at line 526 of file PPCallbacks.h.

◆ Endif()

void clang::PPChainedCallbacks::Endif ( SourceLocation  Loc,
SourceLocation  IfLoc 
)
inlineoverridevirtual

Hook called whenever an #endif is seen.

Reimplemented from clang::PPCallbacks.

Definition at line 532 of file PPCallbacks.h.

◆ EndOfMainFile()

void clang::PPChainedCallbacks::EndOfMainFile ( )
inlineoverridevirtual

Callback invoked when the end of the main file is reached.

No subsequent callbacks will be made.

Reimplemented from clang::PPCallbacks.

Definition at line 385 of file PPCallbacks.h.

◆ FileChanged()

void clang::PPChainedCallbacks::FileChanged ( SourceLocation  Loc,
FileChangeReason  Reason,
SrcMgr::CharacteristicKind  FileType,
FileID  PrevFID 
)
inlineoverridevirtual

Callback invoked whenever a source file is entered or exited.

Parameters
LocIndicates the new location.
PrevFIDthe file that was exited if Reason is ExitFile.

Reimplemented from clang::PPCallbacks.

Definition at line 346 of file PPCallbacks.h.

◆ FileNotFound()

bool clang::PPChainedCallbacks::FileNotFound ( StringRef  FileName,
SmallVectorImpl< char > &  RecoveryPath 
)
inlineoverridevirtual

Callback invoked whenever an inclusion directive results in a file-not-found error.

Parameters
FileNameThe name of the file being included, as written in the source code.
RecoveryPathIf this client indicates that it can recover from this missing file, the client should set this as an additional header search patch.
Returns
true to indicate that the preprocessor should attempt to recover by adding RecoveryPath as a header search path.

Reimplemented from clang::PPCallbacks.

Definition at line 360 of file PPCallbacks.h.

◆ FileSkipped()

void clang::PPChainedCallbacks::FileSkipped ( const FileEntry SkippedFile,
const Token FilenameTok,
SrcMgr::CharacteristicKind  FileType 
)
inlineoverridevirtual

Callback invoked whenever a source file is skipped as the result of header guard optimization.

Parameters
SkippedFileThe file that is skipped instead of entering #include
FilenameTokThe file name token in #include "FileName" directive or macro expanded file name token from #include MACRO(PARAMS) directive. Note that FilenameTok contains corresponding quotes/angles symbols.

Reimplemented from clang::PPCallbacks.

Definition at line 353 of file PPCallbacks.h.

◆ Ident()

void clang::PPChainedCallbacks::Ident ( SourceLocation  Loc,
StringRef  str 
)
inlineoverridevirtual

Callback invoked when a #ident or #sccs directive is read.

Parameters
LocThe location of the directive.
strThe text of the directive.

Reimplemented from clang::PPCallbacks.

Definition at line 390 of file PPCallbacks.h.

◆ If()

void clang::PPChainedCallbacks::If ( SourceLocation  Loc,
SourceRange  ConditionRange,
ConditionValueKind  ConditionValue 
)
inlineoverridevirtual

Hook called whenever an #if is seen.

Reimplemented from clang::PPCallbacks.

Definition at line 498 of file PPCallbacks.h.

◆ Ifdef()

void clang::PPChainedCallbacks::Ifdef ( SourceLocation  Loc,
const Token MacroNameTok,
const MacroDefinition MD 
)
inlineoverridevirtual

Hook called whenever an #ifdef is seen.

Reimplemented from clang::PPCallbacks.

Definition at line 512 of file PPCallbacks.h.

◆ Ifndef()

void clang::PPChainedCallbacks::Ifndef ( SourceLocation  Loc,
const Token MacroNameTok,
const MacroDefinition MD 
)
inlineoverridevirtual

Hook called whenever an #ifndef is seen.

Reimplemented from clang::PPCallbacks.

Definition at line 519 of file PPCallbacks.h.

◆ InclusionDirective()

void clang::PPChainedCallbacks::InclusionDirective ( SourceLocation  HashLoc,
const Token IncludeTok,
StringRef  FileName,
bool  IsAngled,
CharSourceRange  FilenameRange,
const FileEntry File,
StringRef  SearchPath,
StringRef  RelativePath,
const Module Imported 
)
inlineoverridevirtual

Callback invoked whenever an inclusion directive of any kind (#include, #import, etc.) has been processed, regardless of whether the inclusion will actually result in an inclusion.

Parameters
HashLocThe location of the '#' that starts the inclusion directive.
IncludeTokThe token that indicates the kind of inclusion directive, e.g., 'include' or 'import'.
FileNameThe name of the file being included, as written in the source code.
IsAngledWhether the file name was enclosed in angle brackets; otherwise, it was enclosed in quotes.
FilenameRangeThe character range of the quotes or angle brackets for the written file name.
FileThe actual file that may be included by this inclusion directive.
SearchPathContains the search path which was used to find the file in the file system. If the file was found via an absolute include path, SearchPath will be empty. For framework includes, the SearchPath and RelativePath will be split up. For example, if an include of "Some/Some.h" is found via the framework path "path/to/Frameworks/Some.framework/Headers/Some.h", SearchPath will be "path/to/Frameworks/Some.framework/Headers" and RelativePath will be "Some.h".
RelativePathThe path relative to SearchPath, at which the include file was found. This is equal to FileName except for framework includes.
ImportedThe module, whenever an inclusion directive was automatically turned into a module import or null otherwise.

Reimplemented from clang::PPCallbacks.

Definition at line 366 of file PPCallbacks.h.

◆ MacroDefined()

void clang::PPChainedCallbacks::MacroDefined ( const Token MacroNameTok,
const MacroDirective MD 
)
inlineoverridevirtual

Hook called whenever a macro definition is seen.

Reimplemented from clang::PPCallbacks.

Definition at line 473 of file PPCallbacks.h.

◆ MacroExpands()

void clang::PPChainedCallbacks::MacroExpands ( const Token MacroNameTok,
const MacroDefinition MD,
SourceRange  Range,
const MacroArgs Args 
)
inlineoverridevirtual

Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found.

Reimplemented from clang::PPCallbacks.

Definition at line 467 of file PPCallbacks.h.

◆ MacroUndefined()

void clang::PPChainedCallbacks::MacroUndefined ( const Token MacroNameTok,
const MacroDefinition MD,
const MacroDirective Undef 
)
inlineoverridevirtual

Hook called whenever a macro #undef is seen.

Parameters
MacroNameTokThe active Token
MDA MacroDefinition for the named macro.
UndefNew MacroDirective if the macro was defined, null otherwise.

MD is released immediately following this callback.

Reimplemented from clang::PPCallbacks.

Definition at line 479 of file PPCallbacks.h.

◆ moduleImport()

void clang::PPChainedCallbacks::moduleImport ( SourceLocation  ImportLoc,
ModuleIdPath  Path,
const Module Imported 
)
inlineoverridevirtual

Callback invoked whenever there was an explicit module-import syntax.

Parameters
ImportLocThe location of import directive token.
PathThe identifiers (and their locations) of the module "path", e.g., "std.vector" would be split into "std" and "vector".
ImportedThe imported module; can be null if importing failed.

Reimplemented from clang::PPCallbacks.

Definition at line 379 of file PPCallbacks.h.

◆ PragmaAssumeNonNullBegin()

void clang::PPChainedCallbacks::PragmaAssumeNonNullBegin ( SourceLocation  Loc)
inlineoverridevirtual

Callback invoked when a #pragma clang assume_nonnull begin directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 457 of file PPCallbacks.h.

◆ PragmaAssumeNonNullEnd()

void clang::PPChainedCallbacks::PragmaAssumeNonNullEnd ( SourceLocation  Loc)
inlineoverridevirtual

Callback invoked when a #pragma clang assume_nonnull end directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 462 of file PPCallbacks.h.

◆ PragmaComment()

void clang::PPChainedCallbacks::PragmaComment ( SourceLocation  Loc,
const IdentifierInfo Kind,
StringRef  Str 
)
inlineoverridevirtual

Callback invoked when a #pragma comment directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 401 of file PPCallbacks.h.

◆ PragmaDetectMismatch()

void clang::PPChainedCallbacks::PragmaDetectMismatch ( SourceLocation  Loc,
StringRef  Name,
StringRef  Value 
)
inlineoverridevirtual

Callback invoked when a #pragma detect_mismatch directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 407 of file PPCallbacks.h.

◆ PragmaDiagnostic()

void clang::PPChainedCallbacks::PragmaDiagnostic ( SourceLocation  Loc,
StringRef  Namespace,
diag::Severity  mapping,
StringRef  Str 
)
inlineoverridevirtual

Callback invoked when a #pragma gcc diagnostic directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 429 of file PPCallbacks.h.

◆ PragmaDiagnosticPop()

void clang::PPChainedCallbacks::PragmaDiagnosticPop ( SourceLocation  Loc,
StringRef  Namespace 
)
inlineoverridevirtual

Callback invoked when a #pragma gcc diagnostic pop directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 424 of file PPCallbacks.h.

◆ PragmaDiagnosticPush()

void clang::PPChainedCallbacks::PragmaDiagnosticPush ( SourceLocation  Loc,
StringRef  Namespace 
)
inlineoverridevirtual

Callback invoked when a #pragma gcc diagnostic push directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 419 of file PPCallbacks.h.

◆ PragmaDirective()

void clang::PPChainedCallbacks::PragmaDirective ( SourceLocation  Loc,
PragmaIntroducerKind  Introducer 
)
inlineoverridevirtual

Callback invoked when start reading any pragma directive.

Reimplemented from clang::PPCallbacks.

Definition at line 395 of file PPCallbacks.h.

◆ PragmaMessage()

void clang::PPChainedCallbacks::PragmaMessage ( SourceLocation  Loc,
StringRef  Namespace,
PragmaMessageKind  Kind,
StringRef  Str 
)
inlineoverridevirtual

Callback invoked when a #pragma message directive is read.

Parameters
LocThe location of the message directive.
NamespaceThe namespace of the message directive.
KindThe type of the message directive.
StrThe text of the message directive.

Reimplemented from clang::PPCallbacks.

Definition at line 413 of file PPCallbacks.h.

◆ PragmaOpenCLExtension()

void clang::PPChainedCallbacks::PragmaOpenCLExtension ( SourceLocation  NameLoc,
const IdentifierInfo Name,
SourceLocation  StateLoc,
unsigned  State 
)
inlineoverridevirtual

Called when an OpenCL extension is either disabled or enabled with a pragma.

Reimplemented from clang::PPCallbacks.

Definition at line 435 of file PPCallbacks.h.

◆ PragmaWarning()

void clang::PPChainedCallbacks::PragmaWarning ( SourceLocation  Loc,
StringRef  WarningSpec,
ArrayRef< int >  Ids 
)
inlineoverridevirtual

Callback invoked when a #pragma warning directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 441 of file PPCallbacks.h.

◆ PragmaWarningPop()

void clang::PPChainedCallbacks::PragmaWarningPop ( SourceLocation  Loc)
inlineoverridevirtual

Callback invoked when a #pragma warning(pop) directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 452 of file PPCallbacks.h.

◆ PragmaWarningPush()

void clang::PPChainedCallbacks::PragmaWarningPush ( SourceLocation  Loc,
int  Level 
)
inlineoverridevirtual

Callback invoked when a #pragma warning(push) directive is read.

Reimplemented from clang::PPCallbacks.

Definition at line 447 of file PPCallbacks.h.

◆ SourceRangeSkipped()

void clang::PPChainedCallbacks::SourceRangeSkipped ( SourceRange  Range,
SourceLocation  EndifLoc 
)
inlineoverridevirtual

Hook called when a source range is skipped.

Parameters
RangeThe SourceRange that was skipped. The range begins at the #if/#else directive and ends after the #endif/#else directive.
EndifLocThe end location of the 'endif' token, which may precede the range skipped by the directive (e.g excluding comments after an 'endif').

Reimplemented from clang::PPCallbacks.

Definition at line 492 of file PPCallbacks.h.


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