clang 19.0.0git
|
This interface provides a way to observe the actions of the preprocessor as it does its thing. More...
#include "clang/Lex/PPCallbacks.h"
Public Types | |
enum | FileChangeReason { EnterFile , ExitFile , SystemHeaderPragma , RenameFile } |
enum class | LexedFileChangeReason { EnterFile , ExitFile } |
enum | PragmaMessageKind { PMK_Message , PMK_Warning , PMK_Error } |
Determines the kind of #pragma invoking a call to PragmaMessage. More... | |
enum | PragmaWarningSpecifier { PWS_Default , PWS_Disable , PWS_Error , PWS_Once , PWS_Suppress , PWS_Level1 , PWS_Level2 , PWS_Level3 , PWS_Level4 } |
Callback invoked when a #pragma warning directive is read. More... | |
enum | ConditionValueKind { CVK_NotEvaluated , CVK_False , CVK_True } |
Public Member Functions | |
virtual | ~PPCallbacks () |
virtual void | FileChanged (SourceLocation Loc, FileChangeReason Reason, SrcMgr::CharacteristicKind FileType, FileID PrevFID=FileID()) |
Callback invoked whenever a source file is entered or exited. | |
virtual void | LexedFileChanged (FileID FID, LexedFileChangeReason Reason, SrcMgr::CharacteristicKind FileType, FileID PrevFID, SourceLocation Loc) |
Callback invoked whenever the Lexer moves to a different file for lexing. | |
virtual void | FileSkipped (const FileEntryRef &SkippedFile, const Token &FilenameTok, SrcMgr::CharacteristicKind FileType) |
Callback invoked whenever a source file is skipped as the result of header guard optimization. | |
virtual bool | FileNotFound (StringRef FileName) |
Callback invoked whenever the preprocessor cannot find a file for an inclusion directive. | |
virtual void | InclusionDirective (SourceLocation HashLoc, const Token &IncludeTok, StringRef FileName, bool IsAngled, CharSourceRange FilenameRange, OptionalFileEntryRef File, StringRef SearchPath, StringRef RelativePath, const Module *SuggestedModule, bool ModuleImported, SrcMgr::CharacteristicKind FileType) |
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. | |
virtual void | EnteredSubmodule (Module *M, SourceLocation ImportLoc, bool ForPragma) |
Callback invoked whenever a submodule was entered. | |
virtual void | LeftSubmodule (Module *M, SourceLocation ImportLoc, bool ForPragma) |
Callback invoked whenever a submodule was left. | |
virtual void | moduleImport (SourceLocation ImportLoc, ModuleIdPath Path, const Module *Imported) |
Callback invoked whenever there was an explicit module-import syntax. | |
virtual void | EndOfMainFile () |
Callback invoked when the end of the main file is reached. | |
virtual void | Ident (SourceLocation Loc, StringRef str) |
Callback invoked when a #ident or #sccs directive is read. | |
virtual void | PragmaDirective (SourceLocation Loc, PragmaIntroducerKind Introducer) |
Callback invoked when start reading any pragma directive. | |
virtual void | PragmaComment (SourceLocation Loc, const IdentifierInfo *Kind, StringRef Str) |
Callback invoked when a #pragma comment directive is read. | |
virtual void | PragmaMark (SourceLocation Loc, StringRef Trivia) |
Callback invoked when a #pragma mark comment is read. | |
virtual void | PragmaDetectMismatch (SourceLocation Loc, StringRef Name, StringRef Value) |
Callback invoked when a #pragma detect_mismatch directive is read. | |
virtual void | PragmaDebug (SourceLocation Loc, StringRef DebugType) |
Callback invoked when a #pragma clang __debug directive is read. | |
virtual void | PragmaMessage (SourceLocation Loc, StringRef Namespace, PragmaMessageKind Kind, StringRef Str) |
Callback invoked when a #pragma message directive is read. | |
virtual void | PragmaDiagnosticPush (SourceLocation Loc, StringRef Namespace) |
Callback invoked when a #pragma gcc diagnostic push directive is read. | |
virtual void | PragmaDiagnosticPop (SourceLocation Loc, StringRef Namespace) |
Callback invoked when a #pragma gcc diagnostic pop directive is read. | |
virtual void | PragmaDiagnostic (SourceLocation Loc, StringRef Namespace, diag::Severity mapping, StringRef Str) |
Callback invoked when a #pragma gcc diagnostic directive is read. | |
virtual void | PragmaOpenCLExtension (SourceLocation NameLoc, const IdentifierInfo *Name, SourceLocation StateLoc, unsigned State) |
Called when an OpenCL extension is either disabled or enabled with a pragma. | |
virtual void | PragmaWarning (SourceLocation Loc, PragmaWarningSpecifier WarningSpec, ArrayRef< int > Ids) |
virtual void | PragmaWarningPush (SourceLocation Loc, int Level) |
Callback invoked when a #pragma warning(push) directive is read. | |
virtual void | PragmaWarningPop (SourceLocation Loc) |
Callback invoked when a #pragma warning(pop) directive is read. | |
virtual void | PragmaExecCharsetPush (SourceLocation Loc, StringRef Str) |
Callback invoked when a #pragma execution_character_set(push) directive is read. | |
virtual void | PragmaExecCharsetPop (SourceLocation Loc) |
Callback invoked when a #pragma execution_character_set(pop) directive is read. | |
virtual void | PragmaAssumeNonNullBegin (SourceLocation Loc) |
Callback invoked when a #pragma clang assume_nonnull begin directive is read. | |
virtual void | PragmaAssumeNonNullEnd (SourceLocation Loc) |
Callback invoked when a #pragma clang assume_nonnull end directive is read. | |
virtual void | MacroExpands (const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range, const MacroArgs *Args) |
Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found. | |
virtual void | MacroDefined (const Token &MacroNameTok, const MacroDirective *MD) |
Hook called whenever a macro definition is seen. | |
virtual void | MacroUndefined (const Token &MacroNameTok, const MacroDefinition &MD, const MacroDirective *Undef) |
Hook called whenever a macro #undef is seen. | |
virtual void | Defined (const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range) |
Hook called whenever the 'defined' operator is seen. | |
virtual void | HasInclude (SourceLocation Loc, StringRef FileName, bool IsAngled, OptionalFileEntryRef File, SrcMgr::CharacteristicKind FileType) |
Hook called when a '__has_include' or '__has_include_next' directive is read. | |
virtual void | SourceRangeSkipped (SourceRange Range, SourceLocation EndifLoc) |
Hook called when a source range is skipped. | |
virtual void | If (SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue) |
Hook called whenever an #if is seen. | |
virtual void | Elif (SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue, SourceLocation IfLoc) |
Hook called whenever an #elif is seen. | |
virtual void | Ifdef (SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) |
Hook called whenever an #ifdef is seen. | |
virtual void | Elifdef (SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) |
Hook called whenever an #elifdef branch is taken. | |
virtual void | Elifdef (SourceLocation Loc, SourceRange ConditionRange, SourceLocation IfLoc) |
Hook called whenever an #elifdef is skipped. | |
virtual void | Ifndef (SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) |
Hook called whenever an #ifndef is seen. | |
virtual void | Elifndef (SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) |
Hook called whenever an #elifndef branch is taken. | |
virtual void | Elifndef (SourceLocation Loc, SourceRange ConditionRange, SourceLocation IfLoc) |
Hook called whenever an #elifndef is skipped. | |
virtual void | Else (SourceLocation Loc, SourceLocation IfLoc) |
Hook called whenever an #else is seen. | |
virtual void | Endif (SourceLocation Loc, SourceLocation IfLoc) |
Hook called whenever an #endif is seen. | |
This interface provides a way to observe the actions of the preprocessor as it does its thing.
Clients can define their hooks here to implement preprocessor level tools.
Definition at line 35 of file PPCallbacks.h.
Enumerator | |
---|---|
CVK_NotEvaluated | |
CVK_False | |
CVK_True |
Definition at line 351 of file PPCallbacks.h.
Enumerator | |
---|---|
EnterFile | |
ExitFile | |
SystemHeaderPragma | |
RenameFile |
Definition at line 39 of file PPCallbacks.h.
|
strong |
Enumerator | |
---|---|
EnterFile | |
ExitFile |
Definition at line 53 of file PPCallbacks.h.
Determines the kind of #pragma invoking a call to PragmaMessage.
Enumerator | |
---|---|
PMK_Message | #pragma message has been invoked. |
PMK_Warning | #pragma GCC warning has been invoked. |
PMK_Error | #pragma GCC error has been invoked. |
Definition at line 225 of file PPCallbacks.h.
Callback invoked when a #pragma warning directive is read.
Enumerator | |
---|---|
PWS_Default | |
PWS_Disable | |
PWS_Error | |
PWS_Once | |
PWS_Suppress | |
PWS_Level1 | |
PWS_Level2 | |
PWS_Level3 | |
PWS_Level4 |
Definition at line 269 of file PPCallbacks.h.
|
virtualdefault |
|
inlinevirtual |
Hook called whenever the 'defined' operator is seen.
MD | The MacroDirective if the name was a macro, null otherwise. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 332 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #elif is seen.
Loc | the source location of the directive. |
ConditionRange | The SourceRange of the expression being tested. |
ConditionValue | The evaluated value of the condition. |
IfLoc | the source location of the #if/#ifdef/#ifndef directive. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 371 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #elifdef branch is taken.
Loc | the source location of the directive. |
MacroNameTok | Information on the token being tested. |
MD | The MacroDefinition if the name was a macro, null otherwise. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 387 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #elifdef is skipped.
Loc | the source location of the directive. |
ConditionRange | The SourceRange of the expression being tested. |
IfLoc | the source location of the #if/#ifdef/#ifndef directive. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 395 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #elifndef branch is taken.
Loc | the source location of the directive. |
MacroNameTok | Information on the token being tested. |
MD | The MacroDefinition if the name was a macro, null otherwise. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 411 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #elifndef is skipped.
Loc | the source location of the directive. |
ConditionRange | The SourceRange of the expression being tested. |
IfLoc | the source location of the #if/#ifdef/#ifndef directive. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 419 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #else is seen.
Loc | the source location of the directive. |
IfLoc | the source location of the #if/#ifdef/#ifndef directive. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 426 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #endif is seen.
Loc | the source location of the directive. |
IfLoc | the source location of the #if/#ifdef/#ifndef directive. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 432 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when the end of the main file is reached.
No subsequent callbacks will be made.
Reimplemented in clang::PPChainedCallbacks, and clang::tooling::dependencies::ModuleDepCollectorPP.
Definition at line 188 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked whenever a submodule was entered.
M | The submodule we have entered. |
ImportLoc | The location of import directive token. |
ForPragma | If entering from pragma directive. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 156 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked whenever a source file is entered or exited.
Loc | Indicates the new location. |
PrevFID | the file that was exited if Reason is ExitFile or the the file before the new one entered for Reason EnterFile. |
Reimplemented in clang::PPChainedCallbacks, clang::sema::SemaPPCallbacks, and clang::MacroPPCallbacks.
Definition at line 48 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked whenever the preprocessor cannot find a file for an inclusion directive.
FileName | The name of the file being included, as written in the source code. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 94 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked whenever a source file is skipped as the result of header guard optimization.
SkippedFile | The file that is skipped instead of entering #include |
FilenameTok | The 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 in clang::PPChainedCallbacks.
Definition at line 82 of file PPCallbacks.h.
|
virtual |
Hook called when a '__has_include' or '__has_include_next' directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 17 of file PPCallbacks.cpp.
|
inlinevirtual |
Callback invoked when a #ident or #sccs directive is read.
Loc | The location of the directive. |
str | The text of the directive. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 195 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #if is seen.
Loc | the source location of the directive. |
ConditionRange | The SourceRange of the expression being tested. |
ConditionValue | The evaluated value of the condition. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 361 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #ifdef is seen.
Loc | the source location of the directive. |
MacroNameTok | Information on the token being tested. |
MD | The MacroDefinition if the name was a macro, null otherwise. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 379 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever an #ifndef is seen.
Loc | the source location of the directive. |
MacroNameTok | Information on the token being tested. |
MD | The MacroDefiniton if the name was a macro, null otherwise. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 403 of file PPCallbacks.h.
|
inlinevirtual |
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.
HashLoc | The location of the '#' that starts the inclusion directive. |
IncludeTok | The token that indicates the kind of inclusion directive, e.g., 'include' or 'import'. |
FileName | The name of the file being included, as written in the source code. |
IsAngled | Whether the file name was enclosed in angle brackets; otherwise, it was enclosed in quotes. |
FilenameRange | The character range of the quotes or angle brackets for the written file name. |
File | The actual file that may be included by this inclusion directive. |
SearchPath | Contains 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". |
RelativePath | The path relative to SearchPath, at which the include file was found. This is equal to FileName except for framework includes. |
SuggestedModule | The module suggested for this header, if any. |
ModuleImported | Whether this include was translated into import of SuggestedModule . |
FileType | The characteristic kind, indicates whether a file or directory holds normal user code, system code, or system code which is implicitly 'extern "C"' in C++ mode. |
Reimplemented in clang::PPChainedCallbacks, clang::tooling::dependencies::ModuleDepCollectorPP, and clang::MacroPPCallbacks.
Definition at line 139 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked whenever a submodule was left.
M | The submodule we have left. |
ImportLoc | The location of import directive token. |
ForPragma | If entering from pragma directive. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 167 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked whenever the Lexer
moves to a different file for lexing.
Unlike FileChanged
line number directives and other related pragmas do not trigger callbacks to LexedFileChanged
.
FID | The FileID that the Lexer moved to. |
Reason | Whether the Lexer entered a new file or exited one. |
FileType | The CharacteristicKind of the file the Lexer moved to. |
PrevFID | The FileID the Lexer was using before the change. |
Loc | The location where the Lexer entered a new file from or the location that the Lexer moved into after exiting a file. |
Reimplemented in clang::PPChainedCallbacks, and clang::tooling::dependencies::ModuleDepCollectorPP.
Definition at line 70 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever a macro definition is seen.
Reimplemented in clang::PPChainedCallbacks, and clang::MacroPPCallbacks.
Definition at line 315 of file PPCallbacks.h.
|
inlinevirtual |
Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found.
Reimplemented in TokenCollector::CollectPPExpansions, clang::detail::MacroExpansionRangeRecorder, and clang::PPChainedCallbacks.
Definition at line 310 of file PPCallbacks.h.
|
inlinevirtual |
Hook called whenever a macro #undef is seen.
MacroNameTok | The active Token |
MD | A MacroDefinition for the named macro. |
Undef | New MacroDirective if the macro was defined, null otherwise. |
MD is released immediately following this callback.
Reimplemented in clang::PPChainedCallbacks, and clang::MacroPPCallbacks.
Definition at line 325 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked whenever there was an explicit module-import syntax.
ImportLoc | The location of import directive token. |
Path | The identifiers (and their locations) of the module "path", e.g., "std.vector" would be split into "std" and "vector". |
Imported | The imported module; can be null if importing failed. |
Reimplemented in clang::PPChainedCallbacks, and clang::tooling::dependencies::ModuleDepCollectorPP.
Definition at line 180 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma clang assume_nonnull begin directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 302 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma clang assume_nonnull end directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 306 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma comment directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 204 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma clang __debug directive is read.
Loc | The location of the debug directive. |
DebugType | The identifier following __debug. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 221 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma detect_mismatch directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 214 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma gcc diagnostic directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 258 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma gcc diagnostic pop directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 253 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma gcc diagnostic push directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 247 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when start reading any pragma directive.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 199 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma execution_character_set(pop) directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 298 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma execution_character_set(push) directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 294 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma mark comment is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 209 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma message directive is read.
Loc | The location of the message directive. |
Namespace | The namespace of the message directive. |
Kind | The type of the message directive. |
Str | The text of the message directive. |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 241 of file PPCallbacks.h.
|
inlinevirtual |
Called when an OpenCL extension is either disabled or enabled with a pragma.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 263 of file PPCallbacks.h.
|
inlinevirtual |
Reimplemented in clang::PPChainedCallbacks.
Definition at line 280 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma warning(pop) directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 289 of file PPCallbacks.h.
|
inlinevirtual |
Callback invoked when a #pragma warning(push) directive is read.
Reimplemented in clang::PPChainedCallbacks.
Definition at line 285 of file PPCallbacks.h.
|
inlinevirtual |
Hook called when a source range is skipped.
Range | The SourceRange that was skipped. The range begins at the #if/#else directive and ends after the #endif/#else directive. |
EndifLoc | The end location of the 'endif' token, which may precede the range skipped by the directive (e.g excluding comments after an 'endif'). |
Reimplemented in clang::PPChainedCallbacks, and clang::CoverageSourceInfo.
Definition at line 348 of file PPCallbacks.h.