14 #ifndef LLVM_CLANG_LEX_PPCALLBACKS_H 15 #define LLVM_CLANG_LEX_PPCALLBACKS_H 22 #include "llvm/ADT/StringRef.h" 27 class MacroDefinition;
61 const Token &FilenameTok,
124 const Token &IncludeTok,
129 StringRef SearchPath,
130 StringRef RelativePath,
231 StringRef Namespace) {
237 StringRef Namespace) {
378 virtual void anchor();
379 std::unique_ptr<PPCallbacks>
First, Second;
383 std::unique_ptr<PPCallbacks> _Second)
384 : First(
std::move(_First)), Second(
std::move(_Second)) {}
388 FileID PrevFID)
override {
389 First->FileChanged(Loc, Reason, FileType, PrevFID);
390 Second->FileChanged(Loc, Reason, FileType, PrevFID);
394 const Token &FilenameTok,
396 First->FileSkipped(SkippedFile, FilenameTok, FileType);
397 Second->FileSkipped(SkippedFile, FilenameTok, FileType);
402 return First->FileNotFound(FileName, RecoveryPath) ||
403 Second->FileNotFound(FileName, RecoveryPath);
407 StringRef FileName,
bool IsAngled,
409 StringRef SearchPath, StringRef RelativePath,
412 First->InclusionDirective(HashLoc, IncludeTok, FileName, IsAngled,
413 FilenameRange, File, SearchPath, RelativePath,
415 Second->InclusionDirective(HashLoc, IncludeTok, FileName, IsAngled,
416 FilenameRange, File, SearchPath, RelativePath,
421 bool ForPragma)
override {
422 First->EnteredSubmodule(M, ImportLoc, ForPragma);
423 Second->EnteredSubmodule(M, ImportLoc, ForPragma);
427 bool ForPragma)
override {
428 First->LeftSubmodule(M, ImportLoc, ForPragma);
429 Second->LeftSubmodule(M, ImportLoc, ForPragma);
433 const Module *Imported)
override {
434 First->moduleImport(ImportLoc, Path, Imported);
435 Second->moduleImport(ImportLoc, Path, Imported);
439 First->EndOfMainFile();
440 Second->EndOfMainFile();
444 First->Ident(Loc, str);
445 Second->Ident(Loc, str);
450 First->PragmaDirective(Loc, Introducer);
451 Second->PragmaDirective(Loc, Introducer);
455 StringRef Str)
override {
456 First->PragmaComment(Loc, Kind, Str);
457 Second->PragmaComment(Loc, Kind, Str);
461 StringRef
Value)
override {
462 First->PragmaDetectMismatch(Loc, Name, Value);
463 Second->PragmaDetectMismatch(Loc, Name, Value);
467 First->PragmaDebug(Loc, DebugType);
468 Second->PragmaDebug(Loc, DebugType);
473 First->PragmaMessage(Loc, Namespace, Kind, Str);
474 Second->PragmaMessage(Loc, Namespace, Kind, Str);
478 First->PragmaDiagnosticPush(Loc, Namespace);
479 Second->PragmaDiagnosticPush(Loc, Namespace);
483 First->PragmaDiagnosticPop(Loc, Namespace);
484 Second->PragmaDiagnosticPop(Loc, Namespace);
489 First->PragmaDiagnostic(Loc, Namespace, mapping, Str);
490 Second->PragmaDiagnostic(Loc, Namespace, mapping, Str);
496 First->HasInclude(Loc, FileName, IsAngled, File, FileType);
497 Second->HasInclude(Loc, FileName, IsAngled, File, FileType);
502 First->PragmaOpenCLExtension(NameLoc, Name, StateLoc, State);
503 Second->PragmaOpenCLExtension(NameLoc, Name, StateLoc, State);
508 First->PragmaWarning(Loc, WarningSpec, Ids);
509 Second->PragmaWarning(Loc, WarningSpec, Ids);
513 First->PragmaWarningPush(Loc, Level);
514 Second->PragmaWarningPush(Loc, Level);
518 First->PragmaWarningPop(Loc);
519 Second->PragmaWarningPop(Loc);
523 First->PragmaExecCharsetPush(Loc, Str);
524 Second->PragmaExecCharsetPush(Loc, Str);
528 First->PragmaExecCharsetPop(Loc);
529 Second->PragmaExecCharsetPop(Loc);
533 First->PragmaAssumeNonNullBegin(Loc);
534 Second->PragmaAssumeNonNullBegin(Loc);
538 First->PragmaAssumeNonNullEnd(Loc);
539 Second->PragmaAssumeNonNullEnd(Loc);
544 First->MacroExpands(MacroNameTok, MD, Range, Args);
545 Second->MacroExpands(MacroNameTok, MD, Range, Args);
550 First->MacroDefined(MacroNameTok, MD);
551 Second->MacroDefined(MacroNameTok, MD);
557 First->MacroUndefined(MacroNameTok, MD, Undef);
558 Second->MacroUndefined(MacroNameTok, MD, Undef);
563 First->Defined(MacroNameTok, MD, Range);
564 Second->Defined(MacroNameTok, MD, Range);
568 First->SourceRangeSkipped(Range, EndifLoc);
569 Second->SourceRangeSkipped(Range, EndifLoc);
575 First->If(Loc, ConditionRange, ConditionValue);
576 Second->If(Loc, ConditionRange, ConditionValue);
582 First->Elif(Loc, ConditionRange, ConditionValue, IfLoc);
583 Second->Elif(Loc, ConditionRange, ConditionValue, IfLoc);
589 First->Ifdef(Loc, MacroNameTok, MD);
590 Second->Ifdef(Loc, MacroNameTok, MD);
596 First->Ifndef(Loc, MacroNameTok, MD);
597 Second->Ifndef(Loc, MacroNameTok, MD);
602 First->Else(Loc, IfLoc);
603 Second->Else(Loc, IfLoc);
608 First->Endif(Loc, IfLoc);
609 Second->Endif(Loc, IfLoc);
void PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace) override
Callback invoked when a #pragma gcc diagnostic push directive is read.
virtual void Elif(SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue, SourceLocation IfLoc)
Hook called whenever an #elif is seen.
virtual void PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace)
Callback invoked when a #pragma gcc diagnostic pop directive is read.
void MacroUndefined(const Token &MacroNameTok, const MacroDefinition &MD, const MacroDirective *Undef) override
Hook called whenever a macro #undef is seen.
#pragma GCC error has been invoked.
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 EndOfMainFile()
Callback invoked when the end of the main file is reached.
Defines the SourceManager interface.
void PragmaWarning(SourceLocation Loc, StringRef WarningSpec, ArrayRef< int > Ids) override
Callback invoked when a #pragma warning directive is read.
virtual void MacroUndefined(const Token &MacroNameTok, const MacroDefinition &MD, const MacroDirective *Undef)
Hook called whenever a macro #undef is seen.
A description of the current definition of a macro.
void If(SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue) override
Hook called whenever an #if is seen.
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.
void PragmaWarningPop(SourceLocation Loc) override
Callback invoked when a #pragma warning(pop) directive is read.
Severity
Enum values that allow the client to map NOTEs, WARNINGs, and EXTENSIONs to either Ignore (nothing)...
void Ifdef(SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) override
Hook called whenever an #ifdef is seen.
CharacteristicKind
Indicates whether a file or directory holds normal user code, system code, or system code which is im...
This interface provides a way to observe the actions of the preprocessor as it does its thing...
virtual void MacroDefined(const Token &MacroNameTok, const MacroDirective *MD)
Hook called whenever a macro definition is seen.
virtual void Else(SourceLocation Loc, SourceLocation IfLoc)
Hook called whenever an #else is seen.
virtual void If(SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue)
Hook called whenever an #if is seen.
One of these records is kept for each identifier that is lexed.
virtual void PragmaDebug(SourceLocation Loc, StringRef DebugType)
Callback invoked when a #pragma clang __debug directive is read.
virtual void PragmaExecCharsetPop(SourceLocation Loc)
Callback invoked when a #pragma execution_character_set(pop) directive is read.
void EnteredSubmodule(Module *M, SourceLocation ImportLoc, bool ForPragma) override
Callback invoked whenever a submodule was entered.
Token - This structure provides full information about a lexed token.
virtual void Endif(SourceLocation Loc, SourceLocation IfLoc)
Hook called whenever an #endif is seen.
Describes a module or submodule.
PPChainedCallbacks(std::unique_ptr< PPCallbacks > _First, std::unique_ptr< PPCallbacks > _Second)
void LeftSubmodule(Module *M, SourceLocation ImportLoc, bool ForPragma) override
Callback invoked whenever a submodule was left.
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.
virtual void PragmaExecCharsetPush(SourceLocation Loc, StringRef Str)
Callback invoked when a #pragma execution_character_set(push) directive is read.
PragmaIntroducerKind
Describes how the pragma was introduced, e.g., with #pragma, _Pragma, or __pragma.
virtual void Defined(const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range)
Hook called whenever the 'defined' operator is seen.
void Ifndef(SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD) override
Hook called whenever an #ifndef is seen.
PragmaMessageKind
Determines the kind of #pragma invoking a call to PragmaMessage.
virtual void PragmaAssumeNonNullBegin(SourceLocation Loc)
Callback invoked when a #pragma clang assume_nonnull begin directive is read.
#pragma GCC warning has been invoked.
virtual void PragmaWarning(SourceLocation Loc, StringRef WarningSpec, ArrayRef< int > Ids)
Callback invoked when a #pragma warning directive is read.
bool FileNotFound(StringRef FileName, SmallVectorImpl< char > &RecoveryPath) override
Callback invoked whenever an inclusion directive results in a file-not-found error.
Represents a character-granular source range.
void Ident(SourceLocation Loc, StringRef str) override
Callback invoked when a #ident or #sccs directive is read.
void PragmaWarningPush(SourceLocation Loc, int Level) override
Callback invoked when a #pragma warning(push) directive is read.
void FileChanged(SourceLocation Loc, FileChangeReason Reason, SrcMgr::CharacteristicKind FileType, FileID PrevFID) override
Callback invoked whenever a source file is entered or exited.
MacroArgs - An instance of this class captures information about the formal arguments specified to a ...
void Elif(SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue, SourceLocation IfLoc) override
Hook called whenever an #elif is seen.
virtual void HasInclude(SourceLocation Loc, StringRef FileName, bool IsAngled, const FileEntry *File, SrcMgr::CharacteristicKind FileType)
Hook called when a '__has_include' or '__has_include_next' directive is read.
void PragmaAssumeNonNullBegin(SourceLocation Loc) override
Callback invoked when a #pragma clang assume_nonnull begin directive is read.
virtual void FileChanged(SourceLocation Loc, FileChangeReason Reason, SrcMgr::CharacteristicKind FileType, FileID PrevFID=FileID())
Callback invoked whenever a source file is entered or exited.
void PragmaMessage(SourceLocation Loc, StringRef Namespace, PragmaMessageKind Kind, StringRef Str) override
Callback invoked when a #pragma message directive is read.
virtual void EnteredSubmodule(Module *M, SourceLocation ImportLoc, bool ForPragma)
Callback invoked whenever a submodule was entered.
virtual void PragmaComment(SourceLocation Loc, const IdentifierInfo *Kind, StringRef Str)
Callback invoked when a #pragma comment directive is read.
virtual void PragmaDirective(SourceLocation Loc, PragmaIntroducerKind Introducer)
Callback invoked when start reading any pragma directive.
Simple wrapper class for chaining callbacks.
virtual void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok, StringRef FileName, bool IsAngled, CharSourceRange FilenameRange, const FileEntry *File, StringRef SearchPath, StringRef RelativePath, const Module *Imported, 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.
Encapsulates changes to the "macros namespace" (the location where the macro name became active...
virtual void Ident(SourceLocation Loc, StringRef str)
Callback invoked when a #ident or #sccs directive is read.
Encodes a location in the source.
void moduleImport(SourceLocation ImportLoc, ModuleIdPath Path, const Module *Imported) override
Callback invoked whenever there was an explicit module-import syntax.
virtual void MacroExpands(const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range, const MacroArgs *Args)
Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found.
#pragma message has been invoked.
void PragmaDebug(SourceLocation Loc, StringRef DebugType) override
Callback invoked when a #pragma clang __debug directive is read.
void PragmaAssumeNonNullEnd(SourceLocation Loc) override
Callback invoked when a #pragma clang assume_nonnull end directive is read.
Cached information about one file (either on disk or in the virtual file system). ...
virtual void moduleImport(SourceLocation ImportLoc, ModuleIdPath Path, const Module *Imported)
Callback invoked whenever there was an explicit module-import syntax.
void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok, StringRef FileName, bool IsAngled, CharSourceRange FilenameRange, const FileEntry *File, StringRef SearchPath, StringRef RelativePath, const Module *Imported, SrcMgr::CharacteristicKind FileType) 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.
virtual void Ifdef(SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD)
Hook called whenever an #ifdef is seen.
void PragmaDirective(SourceLocation Loc, PragmaIntroducerKind Introducer) override
Callback invoked when start reading any pragma directive.
void MacroExpands(const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range, const MacroArgs *Args) override
Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found.
void HasInclude(SourceLocation Loc, StringRef FileName, bool IsAngled, const FileEntry *File, SrcMgr::CharacteristicKind FileType) override
Hook called when a '__has_include' or '__has_include_next' directive is read.
virtual void PragmaMessage(SourceLocation Loc, StringRef Namespace, PragmaMessageKind Kind, StringRef Str)
Callback invoked when a #pragma message directive is read.
void PragmaComment(SourceLocation Loc, const IdentifierInfo *Kind, StringRef Str) override
Callback invoked when a #pragma comment directive is read.
void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace, diag::Severity mapping, StringRef Str) override
Callback invoked when a #pragma gcc diagnostic directive is read.
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
void Defined(const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range) override
Hook called whenever the 'defined' operator is seen.
void MacroDefined(const Token &MacroNameTok, const MacroDirective *MD) override
Hook called whenever a macro definition is seen.
Dataflow Directional Tag Classes.
void PragmaDiagnosticPop(SourceLocation Loc, StringRef Namespace) override
Callback invoked when a #pragma gcc diagnostic pop directive is read.
void PragmaDetectMismatch(SourceLocation Loc, StringRef Name, StringRef Value) override
Callback invoked when a #pragma detect_mismatch directive is read.
virtual void LeftSubmodule(Module *M, SourceLocation ImportLoc, bool ForPragma)
Callback invoked whenever a submodule was left.
virtual void PragmaDetectMismatch(SourceLocation Loc, StringRef Name, StringRef Value)
Callback invoked when a #pragma detect_mismatch directive is read.
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.
void EndOfMainFile() override
Callback invoked when the end of the main file is reached.
virtual bool FileNotFound(StringRef FileName, SmallVectorImpl< char > &RecoveryPath)
Callback invoked whenever an inclusion directive results in a file-not-found error.
virtual void Ifndef(SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD)
Hook called whenever an #ifndef is seen.
void PragmaExecCharsetPush(SourceLocation Loc, StringRef Str) override
Callback invoked when a #pragma execution_character_set(push) directive is read.
virtual void PragmaAssumeNonNullEnd(SourceLocation Loc)
Callback invoked when a #pragma clang assume_nonnull end directive is read.
Defines the clang::SourceLocation class and associated facilities.
void Endif(SourceLocation Loc, SourceLocation IfLoc) override
Hook called whenever an #endif is seen.
void PragmaExecCharsetPop(SourceLocation Loc) override
Callback invoked when a #pragma execution_character_set(pop) directive is read.
virtual void PragmaDiagnosticPush(SourceLocation Loc, StringRef Namespace)
Callback invoked when a #pragma gcc diagnostic push directive is read.
Defines the Diagnostic IDs-related interfaces.
virtual void PragmaDiagnostic(SourceLocation Loc, StringRef Namespace, diag::Severity mapping, StringRef Str)
Callback invoked when a #pragma gcc diagnostic directive is read.
void SourceRangeSkipped(SourceRange Range, SourceLocation EndifLoc) override
Hook called when a source range is skipped.
A trivial tuple used to represent a source range.
void Else(SourceLocation Loc, SourceLocation IfLoc) override
Hook called whenever an #else is seen.
virtual void FileSkipped(const FileEntry &SkippedFile, const Token &FilenameTok, SrcMgr::CharacteristicKind FileType)
Callback invoked whenever a source file is skipped as the result of header guard optimization.
virtual void SourceRangeSkipped(SourceRange Range, SourceLocation EndifLoc)
Hook called when a source range is skipped.