15 #ifndef LLVM_CLANG_LEX_PPCALLBACKS_H
16 #define LLVM_CLANG_LEX_PPCALLBACKS_H
23 #include "llvm/ADT/StringRef.h"
30 class MacroDefinition;
64 const Token &FilenameTok,
123 const Token &IncludeTok,
128 StringRef SearchPath,
129 StringRef RelativePath,
207 StringRef Namespace) {
213 StringRef Namespace) {
325 virtual void anchor();
326 std::unique_ptr<PPCallbacks> First, Second;
330 std::unique_ptr<PPCallbacks> _Second)
331 : First(std::move(_First)), Second(std::move(_Second)) {}
335 FileID PrevFID)
override {
336 First->FileChanged(Loc, Reason, FileType, PrevFID);
337 Second->FileChanged(Loc, Reason, FileType, PrevFID);
341 const Token &FilenameTok,
343 First->FileSkipped(SkippedFile, FilenameTok, FileType);
344 Second->FileSkipped(SkippedFile, FilenameTok, FileType);
349 return First->FileNotFound(FileName, RecoveryPath) ||
350 Second->FileNotFound(FileName, RecoveryPath);
356 StringRef SearchPath, StringRef RelativePath,
357 const Module *Imported)
override {
358 First->InclusionDirective(HashLoc, IncludeTok, FileName, IsAngled,
359 FilenameRange, File, SearchPath, RelativePath,
361 Second->InclusionDirective(HashLoc, IncludeTok, FileName, IsAngled,
362 FilenameRange, File, SearchPath, RelativePath,
367 const Module *Imported)
override {
368 First->moduleImport(ImportLoc, Path, Imported);
369 Second->moduleImport(ImportLoc, Path, Imported);
373 First->EndOfMainFile();
374 Second->EndOfMainFile();
378 First->Ident(Loc, str);
379 Second->Ident(Loc, str);
383 StringRef Str)
override {
384 First->PragmaComment(Loc, Kind, Str);
385 Second->PragmaComment(Loc, Kind, Str);
389 StringRef
Value)
override {
390 First->PragmaDetectMismatch(Loc, Name, Value);
391 Second->PragmaDetectMismatch(Loc, Name, Value);
396 First->PragmaMessage(Loc, Namespace, Kind, Str);
397 Second->PragmaMessage(Loc, Namespace, Kind, Str);
401 First->PragmaDiagnosticPush(Loc, Namespace);
402 Second->PragmaDiagnosticPush(Loc, Namespace);
406 First->PragmaDiagnosticPop(Loc, Namespace);
407 Second->PragmaDiagnosticPop(Loc, Namespace);
412 First->PragmaDiagnostic(Loc, Namespace, mapping, Str);
413 Second->PragmaDiagnostic(Loc, Namespace, mapping, Str);
418 First->PragmaOpenCLExtension(NameLoc, Name, StateLoc, State);
419 Second->PragmaOpenCLExtension(NameLoc, Name, StateLoc, State);
424 First->PragmaWarning(Loc, WarningSpec, Ids);
425 Second->PragmaWarning(Loc, WarningSpec, Ids);
429 First->PragmaWarningPush(Loc, Level);
430 Second->PragmaWarningPush(Loc, Level);
434 First->PragmaWarningPop(Loc);
435 Second->PragmaWarningPop(Loc);
440 First->MacroExpands(MacroNameTok, MD, Range, Args);
441 Second->MacroExpands(MacroNameTok, MD, Range, Args);
445 First->MacroDefined(MacroNameTok, MD);
446 Second->MacroDefined(MacroNameTok, MD);
451 First->MacroUndefined(MacroNameTok, MD);
452 Second->MacroUndefined(MacroNameTok, MD);
457 First->Defined(MacroNameTok, MD, Range);
458 Second->Defined(MacroNameTok, MD, Range);
462 First->SourceRangeSkipped(Range);
463 Second->SourceRangeSkipped(Range);
469 First->If(Loc, ConditionRange, ConditionValue);
470 Second->If(Loc, ConditionRange, ConditionValue);
476 First->Elif(Loc, ConditionRange, ConditionValue, IfLoc);
477 Second->Elif(Loc, ConditionRange, ConditionValue, IfLoc);
483 First->Ifdef(Loc, MacroNameTok, MD);
484 Second->Ifdef(Loc, MacroNameTok, MD);
490 First->Ifndef(Loc, MacroNameTok, MD);
491 Second->Ifndef(Loc, MacroNameTok, MD);
496 First->Else(Loc, IfLoc);
497 Second->Else(Loc, IfLoc);
502 First->Endif(Loc, IfLoc);
503 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.
#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.
void SourceRangeSkipped(SourceRange Range) override
Hook called when a source range is skipped.
void PragmaWarning(SourceLocation Loc, StringRef WarningSpec, ArrayRef< int > Ids) override
Callback invoked when a #pragma warning directive is read.
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.
class LLVM_ALIGNAS(8) DependentTemplateSpecializationType const IdentifierInfo * Name
Represents a template specialization type whose template cannot be resolved, e.g. ...
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 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 SourceRangeSkipped(SourceRange Range)
Hook called when a source range is skipped.
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.
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.
PragmaMessageKind
Determines the kind of #pragma invoking a call to PragmaMessage.
#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 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 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.
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.
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.
virtual void Ifdef(SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD)
Hook called whenever an #ifdef is seen.
void MacroExpands(const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range, const MacroArgs *Args) override
Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found.
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.
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 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 void MacroUndefined(const Token &MacroNameTok, const MacroDefinition &MD)
Hook called whenever a macro #undef is seen.
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.
Defines the clang::SourceLocation class and associated facilities.
void Endif(SourceLocation Loc, SourceLocation IfLoc) override
Hook called whenever an #endif is seen.
virtual void InclusionDirective(SourceLocation HashLoc, const Token &IncludeTok, StringRef FileName, bool IsAngled, CharSourceRange FilenameRange, const FileEntry *File, StringRef SearchPath, StringRef RelativePath, const Module *Imported)
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.
void MacroUndefined(const Token &MacroNameTok, const MacroDefinition &MD) override
Hook called whenever a macro #undef is seen.
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.
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.