This interface provides a way to observe the actions of the preprocessor as it does its thing. More...

#include "clang/Lex/PPCallbacks.h"

Inheritance diagram for clang::PPCallbacks:

[legend]

Public Types
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 }

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. More...

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. More...

virtual bool	FileNotFound (StringRef FileName, SmallVectorImpl< char > &RecoveryPath)
	Callback invoked whenever an inclusion directive results in a file-not-found error. More...

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. More...

virtual void	moduleImport (SourceLocation ImportLoc, ModuleIdPath Path, const Module *Imported)
	Callback invoked whenever there was an explicit module-import syntax. More...

virtual void	EndOfMainFile ()
	Callback invoked when the end of the main file is reached. More...

virtual void	Ident (SourceLocation Loc, StringRef str)
	Callback invoked when a #ident or #sccs directive is read. More...

virtual void	PragmaDirective (SourceLocation Loc, PragmaIntroducerKind Introducer)
	Callback invoked when start reading any pragma directive. More...

virtual void	PragmaComment (SourceLocation Loc, const IdentifierInfo *Kind, StringRef Str)
	Callback invoked when a #pragma comment directive is read. More...

virtual void	PragmaDetectMismatch (SourceLocation Loc, StringRef Name, StringRef Value)
	Callback invoked when a #pragma detect_mismatch directive is read. More...

virtual void	PragmaDebug (SourceLocation Loc, StringRef DebugType)
	Callback invoked when a #pragma clang __debug directive is read. More...

virtual void	PragmaMessage (SourceLocation Loc, StringRef Namespace, PragmaMessageKind Kind, StringRef Str)
	Callback invoked when a #pragma message directive is read. More...

virtual void	PragmaDiagnosticPush (SourceLocation Loc, StringRef Namespace)
	Callback invoked when a #pragma gcc diagnostic push directive is read. More...

virtual void	PragmaDiagnosticPop (SourceLocation Loc, StringRef Namespace)
	Callback invoked when a #pragma gcc diagnostic pop directive is read. More...

virtual void	PragmaDiagnostic (SourceLocation Loc, StringRef Namespace, diag::Severity mapping, StringRef Str)
	Callback invoked when a #pragma gcc diagnostic directive is read. More...

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. More...

virtual void	PragmaWarning (SourceLocation Loc, StringRef WarningSpec, ArrayRef< int > Ids)
	Callback invoked when a #pragma warning directive is read. More...

virtual void	PragmaWarningPush (SourceLocation Loc, int Level)
	Callback invoked when a #pragma warning(push) directive is read. More...

virtual void	PragmaWarningPop (SourceLocation Loc)
	Callback invoked when a #pragma warning(pop) directive is read. More...

virtual void	PragmaAssumeNonNullBegin (SourceLocation Loc)
	Callback invoked when a #pragma clang assume_nonnull begin directive is read. More...

virtual void	PragmaAssumeNonNullEnd (SourceLocation Loc)
	Callback invoked when a #pragma clang assume_nonnull end directive is read. More...

virtual void	MacroExpands (const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range, const MacroArgs *Args)
	Called by Preprocessor::HandleMacroExpandedIdentifier when a macro invocation is found. More...

virtual void	MacroDefined (const Token &MacroNameTok, const MacroDirective *MD)
	Hook called whenever a macro definition is seen. More...

virtual void	MacroUndefined (const Token &MacroNameTok, const MacroDefinition &MD, const MacroDirective *Undef)
	Hook called whenever a macro #undef is seen. More...

virtual void	Defined (const Token &MacroNameTok, const MacroDefinition &MD, SourceRange Range)
	Hook called whenever the 'defined' operator is seen. More...

virtual void	SourceRangeSkipped (SourceRange Range, SourceLocation EndifLoc)
	Hook called when a source range is skipped. More...

virtual void	If (SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue)
	Hook called whenever an #if is seen. More...

virtual void	Elif (SourceLocation Loc, SourceRange ConditionRange, ConditionValueKind ConditionValue, SourceLocation IfLoc)
	Hook called whenever an #elif is seen. More...

virtual void	Ifdef (SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD)
	Hook called whenever an #ifdef is seen. More...

virtual void	Ifndef (SourceLocation Loc, const Token &MacroNameTok, const MacroDefinition &MD)
	Hook called whenever an #ifndef is seen. More...

virtual void	Else (SourceLocation Loc, SourceLocation IfLoc)
	Hook called whenever an #else is seen. More...

virtual void	Endif (SourceLocation Loc, SourceLocation IfLoc)
	Hook called whenever an #endif is seen. More...

Detailed Description

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 36 of file PPCallbacks.h.

Member Enumeration Documentation

◆ ConditionValueKind

enum clang::PPCallbacks::ConditionValueKind

Enumerator
CVK_NotEvaluated
CVK_False
CVK_True

Definition at line 283 of file PPCallbacks.h.

◆ FileChangeReason

enum clang::PPCallbacks::FileChangeReason

Enumerator
EnterFile
ExitFile
SystemHeaderPragma
RenameFile

Definition at line 40 of file PPCallbacks.h.

◆ PragmaMessageKind

enum clang::PPCallbacks::PragmaMessageKind

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 182 of file PPCallbacks.h.

Constructor & Destructor Documentation

◆ ~PPCallbacks()

PPCallbacks::~PPCallbacks ( )

virtual

Definition at line 28 of file PPLexerChange.cpp.

Member Function Documentation

◆ Defined()

virtual void clang::PPCallbacks::Defined	(	const Token &	MacroNameTok,
		const MacroDefinition &	MD,
		SourceRange	Range
	)

inlinevirtual

Hook called whenever the 'defined' operator is seen.

Parameters

MD	The MacroDirective if the name was a macro, null otherwise.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 270 of file PPCallbacks.h.

◆ Elif()

virtual void clang::PPCallbacks::Elif	(	SourceLocation	Loc,
		SourceRange	ConditionRange,
		ConditionValueKind	ConditionValue,
		SourceLocation	IfLoc
	)

inlinevirtual

Hook called whenever an #elif is seen.

Parameters

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 303 of file PPCallbacks.h.

◆ Else()

virtual void clang::PPCallbacks::Else	(	SourceLocation	Loc,
		SourceLocation	IfLoc
	)

inlinevirtual

Hook called whenever an #else is seen.

Parameters

Loc	the source location of the directive.
IfLoc	the source location of the #if/#ifdef/#ifndef directive.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 326 of file PPCallbacks.h.

◆ Endif()

virtual void clang::PPCallbacks::Endif	(	SourceLocation	Loc,
		SourceLocation	IfLoc
	)

inlinevirtual

Hook called whenever an #endif is seen.

Parameters

Loc	the source location of the directive.
IfLoc	the source location of the #if/#ifdef/#ifndef directive.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 332 of file PPCallbacks.h.

◆ EndOfMainFile()

virtual void clang::PPCallbacks::EndOfMainFile ( )

inlinevirtual

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

No subsequent callbacks will be made.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 149 of file PPCallbacks.h.

◆ FileChanged()

virtual void clang::PPCallbacks::FileChanged	(	SourceLocation	Loc,
		FileChangeReason	Reason,
		SrcMgr::CharacteristicKind	FileType,
		FileID	PrevFID = `FileID()`
	)

inlinevirtual

Callback invoked whenever a source file is entered or exited.

Parameters

Loc	Indicates the new location.
PrevFID	the file that was exited if `Reason` is ExitFile.

Reimplemented in clang::PPChainedCallbacks, clang::MacroPPCallbacks, and clang::sema::SemaPPCallbacks.

Definition at line 48 of file PPCallbacks.h.

◆ FileNotFound()

virtual bool clang::PPCallbacks::FileNotFound	(	StringRef	FileName,
		SmallVectorImpl< char > &	RecoveryPath
	)

inlinevirtual

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

Parameters

FileName	The name of the file being included, as written in the source code.
RecoveryPath	If 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 in clang::PPChainedCallbacks.

Definition at line 78 of file PPCallbacks.h.

◆ FileSkipped()

virtual void clang::PPCallbacks::FileSkipped	(	const FileEntry &	SkippedFile,
		const Token &	FilenameTok,
		SrcMgr::CharacteristicKind	FileType
	)

inlinevirtual

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

Parameters

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 61 of file PPCallbacks.h.

◆ Ident()

virtual void clang::PPCallbacks::Ident	(	SourceLocation	Loc,
		StringRef	str
	)

inlinevirtual

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

Parameters

Loc	The location of the directive.
str	The text of the directive.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 156 of file PPCallbacks.h.

◆ If()

virtual void clang::PPCallbacks::If	(	SourceLocation	Loc,
		SourceRange	ConditionRange,
		ConditionValueKind	ConditionValue
	)

inlinevirtual

Hook called whenever an #if is seen.

Parameters

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 293 of file PPCallbacks.h.

◆ Ifdef()

virtual void clang::PPCallbacks::Ifdef	(	SourceLocation	Loc,
		const Token &	MacroNameTok,
		const MacroDefinition &	MD
	)

inlinevirtual

Hook called whenever an #ifdef is seen.

Parameters

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 311 of file PPCallbacks.h.

◆ Ifndef()

virtual void clang::PPCallbacks::Ifndef	(	SourceLocation	Loc,
		const Token &	MacroNameTok,
		const MacroDefinition &	MD
	)

inlinevirtual

Hook called whenever an #ifndef is seen.

Parameters

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 319 of file PPCallbacks.h.

◆ InclusionDirective()

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

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.

Parameters

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.
Imported	The module, whenever an inclusion directive was automatically turned into a module import or null otherwise.

Reimplemented in clang::PPChainedCallbacks, and clang::MacroPPCallbacks.

Definition at line 120 of file PPCallbacks.h.

◆ MacroDefined()

virtual void clang::PPCallbacks::MacroDefined	(	const Token &	MacroNameTok,
		const MacroDirective *	MD
	)

inlinevirtual

Hook called whenever a macro definition is seen.

Reimplemented in clang::PPChainedCallbacks, and clang::MacroPPCallbacks.

Definition at line 253 of file PPCallbacks.h.

◆ MacroExpands()

virtual void clang::PPCallbacks::MacroExpands	(	const Token &	MacroNameTok,
		const MacroDefinition &	MD,
		SourceRange	Range,
		const MacroArgs *	Args
	)

inlinevirtual

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

Reimplemented in clang::PPChainedCallbacks.

Definition at line 248 of file PPCallbacks.h.

◆ MacroUndefined()

virtual void clang::PPCallbacks::MacroUndefined	(	const Token &	MacroNameTok,
		const MacroDefinition &	MD,
		const MacroDirective *	Undef
	)

inlinevirtual

Hook called whenever a macro #undef is seen.

Parameters

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 263 of file PPCallbacks.h.

◆ moduleImport()

virtual void clang::PPCallbacks::moduleImport	(	SourceLocation	ImportLoc,
		ModuleIdPath	Path,
		const Module *	Imported
	)

inlinevirtual

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

Parameters

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.

Definition at line 141 of file PPCallbacks.h.

◆ PragmaAssumeNonNullBegin()

virtual void clang::PPCallbacks::PragmaAssumeNonNullBegin ( SourceLocation Loc )

inlinevirtual

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

Reimplemented in clang::PPChainedCallbacks.

Definition at line 240 of file PPCallbacks.h.

◆ PragmaAssumeNonNullEnd()

virtual void clang::PPCallbacks::PragmaAssumeNonNullEnd ( SourceLocation Loc )

inlinevirtual

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

Reimplemented in clang::PPChainedCallbacks.

Definition at line 244 of file PPCallbacks.h.

◆ PragmaComment()

virtual void clang::PPCallbacks::PragmaComment	(	SourceLocation	Loc,
		const IdentifierInfo *	Kind,
		StringRef	Str
	)

inlinevirtual

Callback invoked when a #pragma comment directive is read.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 165 of file PPCallbacks.h.

Referenced by ParseAlignPragma().

◆ PragmaDebug()

virtual void clang::PPCallbacks::PragmaDebug	(	SourceLocation	Loc,
		StringRef	DebugType
	)

inlinevirtual

Callback invoked when a #pragma clang __debug directive is read.

Parameters

Loc	The location of the debug directive.
DebugType	The identifier following __debug.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 178 of file PPCallbacks.h.

Referenced by clang::Preprocessor::LexOnOffSwitch().

◆ PragmaDetectMismatch()

virtual void clang::PPCallbacks::PragmaDetectMismatch	(	SourceLocation	Loc,
		StringRef	Name,
		StringRef	Value
	)

inlinevirtual

Callback invoked when a #pragma detect_mismatch directive is read.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 171 of file PPCallbacks.h.

Referenced by ParseAlignPragma().

◆ PragmaDiagnostic()

virtual void clang::PPCallbacks::PragmaDiagnostic	(	SourceLocation	Loc,
		StringRef	Namespace,
		diag::Severity	mapping,
		StringRef	Str
	)

inlinevirtual

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

Reimplemented in clang::PPChainedCallbacks.

Definition at line 215 of file PPCallbacks.h.

Referenced by clang::Preprocessor::LexOnOffSwitch().

◆ PragmaDiagnosticPop()

virtual void clang::PPCallbacks::PragmaDiagnosticPop	(	SourceLocation	Loc,
		StringRef	Namespace
	)

inlinevirtual

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

Reimplemented in clang::PPChainedCallbacks.

Definition at line 210 of file PPCallbacks.h.

Referenced by clang::Preprocessor::LexOnOffSwitch().

◆ PragmaDiagnosticPush()

virtual void clang::PPCallbacks::PragmaDiagnosticPush	(	SourceLocation	Loc,
		StringRef	Namespace
	)

inlinevirtual

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

Reimplemented in clang::PPChainedCallbacks.

Definition at line 204 of file PPCallbacks.h.

Referenced by clang::Preprocessor::LexOnOffSwitch().

◆ PragmaDirective()

virtual void clang::PPCallbacks::PragmaDirective	(	SourceLocation	Loc,
		PragmaIntroducerKind	Introducer
	)

inlinevirtual

Callback invoked when start reading any pragma directive.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 160 of file PPCallbacks.h.

◆ PragmaMessage()

virtual void clang::PPCallbacks::PragmaMessage	(	SourceLocation	Loc,
		StringRef	Namespace,
		PragmaMessageKind	Kind,
		StringRef	Str
	)

inlinevirtual

Callback invoked when a #pragma message directive is read.

Parameters

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 198 of file PPCallbacks.h.

◆ PragmaOpenCLExtension()

virtual void clang::PPCallbacks::PragmaOpenCLExtension	(	SourceLocation	NameLoc,
		const IdentifierInfo *	Name,
		SourceLocation	StateLoc,
		unsigned	State
	)

inlinevirtual

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

Reimplemented in clang::PPChainedCallbacks.

Definition at line 220 of file PPCallbacks.h.

Referenced by ParseAlignPragma().

◆ PragmaWarning()

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

inlinevirtual

Callback invoked when a #pragma warning directive is read.

Reimplemented in clang::PPChainedCallbacks.

Definition at line 226 of file PPCallbacks.h.

Referenced by clang::Preprocessor::LexOnOffSwitch().

◆ PragmaWarningPop()

virtual void clang::PPCallbacks::PragmaWarningPop ( SourceLocation Loc )

inlinevirtual

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

Reimplemented in clang::PPChainedCallbacks.

Definition at line 235 of file PPCallbacks.h.

Referenced by clang::Preprocessor::LexOnOffSwitch().

◆ PragmaWarningPush()

virtual void clang::PPCallbacks::PragmaWarningPush	(	SourceLocation	Loc,
		int	Level
	)

inlinevirtual

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

Reimplemented in clang::PPChainedCallbacks.

Definition at line 231 of file PPCallbacks.h.

Referenced by clang::Preprocessor::LexOnOffSwitch().

◆ SourceRangeSkipped()

virtual void clang::PPCallbacks::SourceRangeSkipped	(	SourceRange	Range,
		SourceLocation	EndifLoc
	)

inlinevirtual

Hook called when a source range is skipped.

Parameters

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 280 of file PPCallbacks.h.

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

include/clang/Lex/PPCallbacks.h
lib/Lex/PPLexerChange.cpp

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ ConditionValueKind

◆ FileChangeReason

◆ PragmaMessageKind

Constructor & Destructor Documentation

◆ ~PPCallbacks()

Member Function Documentation

◆ Defined()

◆ Elif()

◆ Else()

◆ Endif()

◆ EndOfMainFile()

◆ FileChanged()

◆ FileNotFound()

◆ FileSkipped()

◆ Ident()

◆ If()

◆ Ifdef()

◆ Ifndef()

◆ InclusionDirective()

◆ MacroDefined()

◆ MacroExpands()

◆ MacroUndefined()

◆ moduleImport()

◆ PragmaAssumeNonNullBegin()

◆ PragmaAssumeNonNullEnd()

◆ PragmaComment()

◆ PragmaDebug()

◆ PragmaDetectMismatch()

◆ PragmaDiagnostic()

◆ PragmaDiagnosticPop()

◆ PragmaDiagnosticPush()

◆ PragmaDirective()

◆ PragmaMessage()

◆ PragmaOpenCLExtension()

◆ PragmaWarning()

◆ PragmaWarningPop()

◆ PragmaWarningPush()

◆ SourceRangeSkipped()