Engages in a tight little dance with the lexer to efficiently preprocess tokens. More...

#include "clang/Lex/Preprocessor.h"

Classes
struct	PreambleSkipInfo

class	ResetMacroExpansionHelper

Public Types
using	IncludedFilesSet = llvm::DenseSet< const FileEntry * >

Public Member Functions
const char *	getCheckPoint (FileID FID, const char *Start) const
	Returns a pointer into the given file's buffer that's guaranteed to be between tokens.

	Preprocessor (std::shared_ptr< PreprocessorOptions > PPOpts, DiagnosticsEngine &diags, const LangOptions &LangOpts, SourceManager &SM, HeaderSearch &Headers, ModuleLoader &TheModuleLoader, IdentifierInfoLookup *IILookup=nullptr, bool OwnsHeaderSearch=false, TranslationUnitKind TUKind=TU_Complete)

	~Preprocessor ()

void	Initialize (const TargetInfo &Target, const TargetInfo *AuxTarget=nullptr)
	Initialize the preprocessor using information about the target.

void	InitializeForModelFile ()
	Initialize the preprocessor to parse a model file.

void	FinalizeForModelFile ()
	Cleanup after model file parsing.

PreprocessorOptions &	getPreprocessorOpts () const
	Retrieve the preprocessor options used to initialize this preprocessor.

DiagnosticsEngine &	getDiagnostics () const

void	setDiagnostics (DiagnosticsEngine &D)

const LangOptions &	getLangOpts () const

const TargetInfo &	getTargetInfo () const

const TargetInfo *	getAuxTargetInfo () const

FileManager &	getFileManager () const

SourceManager &	getSourceManager () const

HeaderSearch &	getHeaderSearchInfo () const

IdentifierTable &	getIdentifierTable ()

const IdentifierTable &	getIdentifierTable () const

SelectorTable &	getSelectorTable ()

Builtin::Context &	getBuiltinInfo ()

llvm::BumpPtrAllocator &	getPreprocessorAllocator ()

void	setExternalSource (ExternalPreprocessorSource *Source)

ExternalPreprocessorSource *	getExternalSource () const

ModuleLoader &	getModuleLoader () const
	Retrieve the module loader associated with this preprocessor.

bool	hadModuleLoaderFatalFailure () const

unsigned	getNumDirectives () const
	Retrieve the number of Directives that have been processed by the Preprocessor.

bool	isParsingIfOrElifDirective () const
	True if we are currently preprocessing a if or #elif directive.

void	SetCommentRetentionState (bool KeepComments, bool KeepMacroComments)
	Control whether the preprocessor retains comments in output.

bool	getCommentRetentionState () const

void	setPragmasEnabled (bool Enabled)

bool	getPragmasEnabled () const

void	SetSuppressIncludeNotFoundError (bool Suppress)

bool	GetSuppressIncludeNotFoundError ()

void	setPreprocessedOutput (bool IsPreprocessedOutput)
	Sets whether the preprocessor is responsible for producing output or if it is producing tokens to be consumed by Parse and Sema.

bool	isPreprocessedOutput () const
	Returns true if the preprocessor is responsible for generating output, false if it is producing tokens to be consumed by Parse and Sema.

bool	isCurrentLexer (const PreprocessorLexer *L) const
	Return true if we are lexing directly from the specified lexer.

PreprocessorLexer *	getCurrentLexer () const
	Return the current lexer being lexed from.

PreprocessorLexer *	getCurrentFileLexer () const
	Return the current file lexer being lexed from.

Module *	getCurrentLexerSubmodule () const
	Return the submodule owning the file being lexed.

FileID	getPredefinesFileID () const
	Returns the FileID for the preprocessor predefines.

unsigned	getTokenCount () const
	Get the number of tokens processed so far.

unsigned	getMaxTokens () const
	Get the max number of tokens before issuing a -Wmax-tokens warning.

void	overrideMaxTokens (unsigned Value, SourceLocation Loc)

SourceLocation	getMaxTokensOverrideLoc () const

void	setTokenWatcher (llvm::unique_function< void(const clang::Token &)> F)
	Register a function that would be called on each token in the final expanded token stream.

void	setPreprocessToken (bool Preprocess)

bool	isMacroDefined (StringRef Id)

bool	isMacroDefined (const IdentifierInfo *II)

bool	isMacroDefinedInLocalModule (const IdentifierInfo II, Module M)
	Determine whether II is defined as a macro within the module M, if that is a module that we've already preprocessed.

MacroDefinition	getMacroDefinition (const IdentifierInfo *II)

MacroDefinition	getMacroDefinitionAtLoc (const IdentifierInfo *II, SourceLocation Loc)

MacroDirective *	getLocalMacroDirective (const IdentifierInfo *II) const
	Given an identifier, return its latest non-imported MacroDirective if it is #define'd and not #undef'd, or null if it isn't #define'd.

const MacroInfo *	getMacroInfo (const IdentifierInfo *II) const

MacroInfo *	getMacroInfo (const IdentifierInfo *II)

MacroDirective *	getLocalMacroDirectiveHistory (const IdentifierInfo *II) const
	Given an identifier, return the latest non-imported macro directive for that identifier.

void	appendMacroDirective (IdentifierInfo II, MacroDirective MD)
	Add a directive to the macro directive history for this identifier.

DefMacroDirective *	appendDefMacroDirective (IdentifierInfo II, MacroInfo MI, SourceLocation Loc)

DefMacroDirective *	appendDefMacroDirective (IdentifierInfo II, MacroInfo MI)

void	setLoadedMacroDirective (IdentifierInfo II, MacroDirective ED, MacroDirective *MD)
	Set a MacroDirective that was loaded from a PCH file.

ModuleMacro *	addModuleMacro (Module Mod, IdentifierInfo II, MacroInfo Macro, ArrayRef< ModuleMacro > Overrides, bool &IsNew)
	Register an exported macro for a module and identifier.

ModuleMacro *	getModuleMacro (Module Mod, const IdentifierInfo II)

ArrayRef< ModuleMacro * >	getLeafModuleMacros (const IdentifierInfo *II) const
	Get the list of leaf (non-overridden) module macros for a name.

ArrayRef< BuildingSubmoduleInfo >	getBuildingSubmodules () const
	Get the list of submodules that we're currently building.

void	markClangModuleAsAffecting (Module *M)
	Mark the given clang module as affecting the current clang module or translation unit.

const llvm::SmallSetVector< Module *, 2 > &	getAffectingClangModules () const
	Get the set of top-level clang modules that affected preprocessing, but were not imported.

bool	markIncluded (FileEntryRef File)
	Mark the file as included.

bool	alreadyIncluded (FileEntryRef File) const
	Return true if this header has already been included.

IncludedFilesSet &	getIncludedFiles ()
	Get the set of included files.

const IncludedFilesSet &	getIncludedFiles () const

StringRef	getLastMacroWithSpelling (SourceLocation Loc, ArrayRef< TokenValue > Tokens) const
	Return the name of the macro defined before `Loc` that has spelling `Tokens`.

const std::string &	getPredefines () const
	Get the predefines for this processor.

void	setPredefines (std::string P)
	Set the predefines for this Preprocessor.

IdentifierInfo *	getIdentifierInfo (StringRef Name) const
	Return information about the specified preprocessor identifier token.

void	AddPragmaHandler (StringRef Namespace, PragmaHandler *Handler)
	Add the specified pragma handler to this preprocessor.

void	AddPragmaHandler (PragmaHandler *Handler)

void	RemovePragmaHandler (StringRef Namespace, PragmaHandler *Handler)
	Remove the specific pragma handler from this preprocessor.

void	RemovePragmaHandler (PragmaHandler *Handler)

void	IgnorePragmas ()
	Install empty handlers for all pragmas (making them ignored).

void	setEmptylineHandler (EmptylineHandler *Handler)
	Set empty line handler.

EmptylineHandler *	getEmptylineHandler () const

void	addCommentHandler (CommentHandler *Handler)
	Add the specified comment handler to the preprocessor.

void	removeCommentHandler (CommentHandler *Handler)
	Remove the specified comment handler.

void	setCodeCompletionHandler (CodeCompletionHandler &Handler)
	Set the code completion handler to the given object.

CodeCompletionHandler *	getCodeCompletionHandler () const
	Retrieve the current code-completion handler.

void	clearCodeCompletionHandler ()
	Clear out the code completion handler.

void	CodeCompleteIncludedFile (llvm::StringRef Dir, bool IsAngled)
	Hook used by the lexer to invoke the "included file" code completion point.

void	CodeCompleteNaturalLanguage ()
	Hook used by the lexer to invoke the "natural language" code completion point.

void	setCodeCompletionIdentifierInfo (IdentifierInfo *Filter)
	Set the code completion token for filtering purposes.

void	setCodeCompletionTokenRange (const SourceLocation Start, const SourceLocation End)
	Set the code completion token range for detecting replacement range later on.

SourceRange	getCodeCompletionTokenRange () const

StringRef	getCodeCompletionFilter ()
	Get the code completion token for filtering purposes.

PreprocessingRecord *	getPreprocessingRecord () const
	Retrieve the preprocessing record, or NULL if there is no preprocessing record.

void	createPreprocessingRecord ()
	Create a new preprocessing record, which will keep track of all macro expansions, macro definitions, etc.

bool	isPCHThroughHeader (const FileEntry *FE)
	Returns true if the FileEntry is the PCH through header.

bool	creatingPCHWithThroughHeader ()
	True if creating a PCH with a through header.

bool	usingPCHWithThroughHeader ()
	True if using a PCH with a through header.

bool	creatingPCHWithPragmaHdrStop ()
	True if creating a PCH with a #pragma hdrstop.

bool	usingPCHWithPragmaHdrStop ()
	True if using a PCH with a #pragma hdrstop.

void	SkipTokensWhileUsingPCH ()
	Skip tokens until after the #include of the through header or until after a #pragma hdrstop.

void	HandleSkippedDirectiveWhileUsingPCH (Token &Result, SourceLocation HashLoc)
	Process directives while skipping until the through header or #pragma hdrstop is found.

void	EnterMainSourceFile ()
	Enter the specified FileID as the main source file, which implicitly adds the builtin defines etc.

void	EndSourceFile ()
	Inform the preprocessor callbacks that processing is complete.

bool	EnterSourceFile (FileID FID, ConstSearchDirIterator Dir, SourceLocation Loc, bool IsFirstIncludeOfFile=true)
	Add a source file to the top of the include stack and start lexing tokens from it instead of the current buffer.

void	EnterMacro (Token &Tok, SourceLocation ILEnd, MacroInfo Macro, MacroArgs Args)
	Add a Macro to the top of the include stack and start lexing tokens from it instead of the current buffer.

void	EnterTokenStream (std::unique_ptr< Token[]> Toks, unsigned NumToks, bool DisableMacroExpansion, bool IsReinject)

void	EnterTokenStream (ArrayRef< Token > Toks, bool DisableMacroExpansion, bool IsReinject)

void	RemoveTopOfLexerStack ()
	Pop the current lexer/macro exp off the top of the lexer stack.

void	EnableBacktrackAtThisPos (bool Unannotated=false)
	From the point that this method is called, and until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor keeps track of the lexed tokens so that a subsequent Backtrack() call will make the Preprocessor re-lex the same tokens.

void	CommitBacktrackedTokens ()
	Disable the last EnableBacktrackAtThisPos call.

void	Backtrack ()
	Make Preprocessor re-lex the tokens that were lexed since EnableBacktrackAtThisPos() was previously called.

bool	isBacktrackEnabled () const
	True if EnableBacktrackAtThisPos() was called and caching of tokens is on.

bool	isUnannotatedBacktrackEnabled () const
	True if EnableBacktrackAtThisPos() was called and caching of unannotated tokens is on.

void	Lex (Token &Result)
	Lex the next token for this preprocessor.

void	LexTokensUntilEOF (std::vector< Token > *Tokens=nullptr)
	Lex all tokens for this preprocessor until (and excluding) end of file.

bool	LexHeaderName (Token &Result, bool AllowMacroExpansion=true)
	Lex a token, forming a header-name token if possible.

std::optional< LexEmbedParametersResult >	LexEmbedParameters (Token &Current, bool ForHasEmbed)
	Lex the parameters for an #embed directive, returns nullopt on error.

bool	LexAfterModuleImport (Token &Result)
	Lex a token following the 'import' contextual keyword.

void	CollectPpImportSuffix (SmallVectorImpl< Token > &Toks)
	Collect the tokens of a C++20 pp-import-suffix.

void	makeModuleVisible (Module *M, SourceLocation Loc)

SourceLocation	getModuleImportLoc (Module *M) const

bool	LexStringLiteral (Token &Result, std::string &String, const char *DiagnosticTag, bool AllowMacroExpansion)
	Lex a string literal, which may be the concatenation of multiple string literals and may even come from macro expansion.

bool	FinishLexStringLiteral (Token &Result, std::string &String, const char *DiagnosticTag, bool AllowMacroExpansion)
	Complete the lexing of a string literal where the first token has already been lexed (see LexStringLiteral).

void	LexNonComment (Token &Result)
	Lex a token.

void	LexUnexpandedToken (Token &Result)
	Just like Lex, but disables macro expansion of identifier tokens.

void	LexUnexpandedNonComment (Token &Result)
	Like LexNonComment, but this disables macro expansion of identifier tokens.

bool	parseSimpleIntegerLiteral (Token &Tok, uint64_t &Value)
	Parses a simple integer literal to get its numeric value.

void	SetMacroExpansionOnlyInDirectives ()
	Disables macro expansion everywhere except for preprocessor directives.

const Token &	LookAhead (unsigned N)
	Peeks ahead N tokens and returns that token without consuming any tokens.

void	RevertCachedTokens (unsigned N)
	When backtracking is enabled and tokens are cached, this allows to revert a specific number of tokens.

void	EnterToken (const Token &Tok, bool IsReinject)
	Enters a token in the token stream to be lexed next.

void	AnnotateCachedTokens (const Token &Tok)
	We notify the Preprocessor that if it is caching tokens (because backtrack is enabled) it should replace the most recent cached tokens with the given annotation token.

SourceLocation	getLastCachedTokenLocation () const
	Get the location of the last cached token, suitable for setting the end location of an annotation token.

bool	IsPreviousCachedToken (const Token &Tok) const
	Whether `Tok` is the most recent token (`CachedLexPos - 1`) in CachedTokens.

void	ReplacePreviousCachedToken (ArrayRef< Token > NewToks)
	Replace token in `CachedLexPos - 1` in CachedTokens by the tokens in `NewToks`.

void	ReplaceLastTokenWithAnnotation (const Token &Tok)
	Replace the last token with an annotation token.

void	EnterAnnotationToken (SourceRange Range, tok::TokenKind Kind, void *AnnotationVal)
	Enter an annotation token into the token stream.

bool	mightHavePendingAnnotationTokens ()
	Determine whether it's possible for a future call to Lex to produce an annotation token created by a previous call to EnterAnnotationToken.

void	TypoCorrectToken (const Token &Tok)
	Update the current token to represent the provided identifier, in order to cache an action performed by typo correction.

void	recomputeCurLexerKind ()
	Recompute the current lexer kind based on the CurLexer/ CurTokenLexer pointers.

bool	isIncrementalProcessingEnabled () const
	Returns true if incremental processing is enabled.

void	enableIncrementalProcessing (bool value=true)
	Enables the incremental processing.

bool	SetCodeCompletionPoint (FileEntryRef File, unsigned Line, unsigned Column)
	Specify the point at which code-completion will be performed.

bool	isCodeCompletionEnabled () const
	Determine if we are performing code completion.

SourceLocation	getCodeCompletionLoc () const
	Returns the location of the code-completion point.

SourceLocation	getCodeCompletionFileLoc () const
	Returns the start location of the file of code-completion point.

bool	isCodeCompletionReached () const
	Returns true if code-completion is enabled and we have hit the code-completion point.

void	setCodeCompletionReached ()
	Note that we hit the code-completion point.

std::pair< IdentifierInfo *, SourceLocation >	getPragmaARCCFCodeAuditedInfo () const
	The location of the currently-active #pragma clang arc_cf_code_audited begin.

void	setPragmaARCCFCodeAuditedInfo (IdentifierInfo *Ident, SourceLocation Loc)
	Set the location of the currently-active #pragma clang arc_cf_code_audited begin.

SourceLocation	getPragmaAssumeNonNullLoc () const
	The location of the currently-active #pragma clang assume_nonnull begin.

void	setPragmaAssumeNonNullLoc (SourceLocation Loc)
	Set the location of the currently-active #pragma clang assume_nonnull begin.

SourceLocation	getPreambleRecordedPragmaAssumeNonNullLoc () const
	Get the location of the recorded unterminated #pragma clang assume_nonnull begin in the preamble, if one exists.

void	setPreambleRecordedPragmaAssumeNonNullLoc (SourceLocation Loc)
	Record the location of the unterminated #pragma clang assume_nonnull begin in the preamble.

void	setMainFileDir (DirectoryEntryRef Dir)
	Set the directory in which the main file should be considered to have been found, if it is not a real file.

void	setSkipMainFilePreamble (unsigned Bytes, bool StartOfLine)
	Instruct the preprocessor to skip part of the main source file.

DiagnosticBuilder	Diag (SourceLocation Loc, unsigned DiagID) const
	Forwarding function for diagnostics.

DiagnosticBuilder	Diag (const Token &Tok, unsigned DiagID) const

StringRef	getSpelling (SourceLocation loc, SmallVectorImpl< char > &buffer, bool *invalid=nullptr) const
	Return the 'spelling' of the token at the given location; does not go up to the spelling location or down to the expansion location.

std::string	getSpelling (const Token &Tok, bool *Invalid=nullptr) const
	Return the 'spelling' of the Tok token.

unsigned	getSpelling (const Token &Tok, const char &Buffer, bool Invalid=nullptr) const
	Get the spelling of a token into a preallocated buffer, instead of as an std::string.

StringRef	getSpelling (const Token &Tok, SmallVectorImpl< char > &Buffer, bool *Invalid=nullptr) const
	Get the spelling of a token into a SmallVector.

bool	getRawToken (SourceLocation Loc, Token &Result, bool IgnoreWhiteSpace=false)
	Relex the token at the specified location.

uint8_t	getSpellingOfSingleCharacterNumericConstant (const Token &Tok, bool *Invalid=nullptr) const
	Given a Token `Tok` that is a numeric constant with length 1, return the value of constant as an unsigned 8-bit integer.

StringRef	getImmediateMacroName (SourceLocation Loc)
	Retrieve the name of the immediate macro expansion.

void	CreateString (StringRef Str, Token &Tok, SourceLocation ExpansionLocStart=SourceLocation(), SourceLocation ExpansionLocEnd=SourceLocation())
	Plop the specified string into a scratch buffer and set the specified token's location and length to it.

SourceLocation	SplitToken (SourceLocation TokLoc, unsigned Length)
	Split the first Length characters out of the token starting at TokLoc and return a location pointing to the split token.

SourceLocation	getLocForEndOfToken (SourceLocation Loc, unsigned Offset=0)
	Computes the source location just past the end of the token at this source location.

bool	isAtStartOfMacroExpansion (SourceLocation loc, SourceLocation *MacroBegin=nullptr) const
	Returns true if the given MacroID location points at the first token of the macro expansion.

bool	isAtEndOfMacroExpansion (SourceLocation loc, SourceLocation *MacroEnd=nullptr) const
	Returns true if the given MacroID location points at the last token of the macro expansion.

void	DumpToken (const Token &Tok, bool DumpFlags=false) const
	Print the token to stderr, used for debugging.

void	DumpLocation (SourceLocation Loc) const

void	DumpMacro (const MacroInfo &MI) const

void	dumpMacroInfo (const IdentifierInfo *II)

SourceLocation	AdvanceToTokenCharacter (SourceLocation TokStart, unsigned Char) const
	Given a location that specifies the start of a token, return a new location that specifies a character within the token.

void	IncrementPasteCounter (bool isFast)
	Increment the counters for the number of token paste operations performed.

void	PrintStats ()

size_t	getTotalMemory () const

void	HandleMicrosoftCommentPaste (Token &Tok)
	When the macro expander pastes together a comment (/##/) in Microsoft mode, this method handles updating the current state, returning the token on the next source line.

IdentifierInfo *	LookUpIdentifierInfo (Token &Identifier) const
	Given a tok::raw_identifier token, look up the identifier information for the token and install it into the token, updating the token kind accordingly.

void	SetPoisonReason (IdentifierInfo *II, unsigned DiagID)
	Specifies the reason for poisoning an identifier.

void	HandlePoisonedIdentifier (Token &Identifier)
	Display reason for poisoned identifier.

void	MaybeHandlePoisonedIdentifier (Token &Identifier)

bool	isNextPPTokenLParen ()
	Determine whether the next preprocessor token to be lexed is a '('.

void	PoisonSEHIdentifiers (bool Poison=true)

bool	HandleIdentifier (Token &Identifier)
	Callback invoked when the lexer reads an identifier and has filled in the tokens IdentifierInfo member.

bool	HandleEndOfFile (Token &Result, bool isEndOfMacro=false)
	Callback invoked when the lexer hits the end of the current file.

bool	HandleEndOfTokenLexer (Token &Result)
	Callback invoked when the current TokenLexer hits the end of its token stream.

void	HandleDirective (Token &Result)
	Callback invoked when the lexer sees a # token at the start of a line.

SourceLocation	CheckEndOfDirective (const char *DirType, bool EnableMacros=false)
	Ensure that the next token is a tok::eod token.

SourceRange	DiscardUntilEndOfDirective ()
	Read and discard all tokens remaining on the current line until the tok::eod token is found.

SourceRange	DiscardUntilEndOfDirective (Token &Tok)
	Same as above except retains the token that was found.

bool	SawDateOrTime () const
	Returns true if the preprocessor has seen a use of DATE or TIME in the file so far.

unsigned	getCounterValue () const

void	setCounterValue (unsigned V)

LangOptions::FPEvalMethodKind	getCurrentFPEvalMethod () const

LangOptions::FPEvalMethodKind	getTUFPEvalMethod () const

SourceLocation	getLastFPEvalPragmaLocation () const

void	setCurrentFPEvalMethod (SourceLocation PragmaLoc, LangOptions::FPEvalMethodKind Val)

void	setTUFPEvalMethod (LangOptions::FPEvalMethodKind Val)

Module *	getCurrentModule ()
	Retrieves the module that we're currently building, if any.

Module *	getCurrentModuleImplementation ()
	Retrieves the module whose implementation we're current compiling, if any.

bool	isInNamedModule () const
	If we are preprocessing a named module.

bool	isInNamedInterfaceUnit () const
	If we are proprocessing a named interface unit.

StringRef	getNamedModuleName () const
	Get the named module name we're preprocessing.

bool	isInImplementationUnit () const
	If we are implementing an implementation module unit.

bool	isInImportingCXXNamedModules () const
	If we're importing a standard C++20 Named Modules.

MacroInfo *	AllocateMacroInfo (SourceLocation L)
	Allocate a new MacroInfo object with the provided SourceLocation.

bool	GetIncludeFilenameSpelling (SourceLocation Loc, StringRef &Buffer)
	Turn the specified lexer token into a fully checked and spelled filename, e.g.

OptionalFileEntryRef	LookupFile (SourceLocation FilenameLoc, StringRef Filename, bool isAngled, ConstSearchDirIterator FromDir, const FileEntry FromFile, ConstSearchDirIterator CurDir, SmallVectorImpl< char > SearchPath, SmallVectorImpl< char > RelativePath, ModuleMap::KnownHeader SuggestedModule, bool IsMapped, bool *IsFrameworkFound, bool SkipCache=false, bool OpenFile=true, bool CacheFailures=true)
	Given a "foo" or <foo> reference, look up the indicated file.

OptionalFileEntryRef	LookupEmbedFile (StringRef Filename, bool isAngled, bool OpenFile, const FileEntry *LookupFromFile=nullptr)
	Given a "Filename" or <Filename> reference, look up the indicated embed resource.

bool	isInPrimaryFile () const
	Return true if we're in the top-level file, not in a #include.

bool	LexOnOffSwitch (tok::OnOffSwitch &Result)
	Lex an on-off-switch (C99 6.10.6p2) and verify that it is followed by EOD.

bool	CheckMacroName (Token &MacroNameTok, MacroUse isDefineUndef, bool *ShadowFlag=nullptr)

void	EnterSubmodule (Module *M, SourceLocation ImportLoc, bool ForPragma)

Module *	LeaveSubmodule (bool ForPragma)

Module *	getModuleForLocation (SourceLocation Loc, bool AllowTextual)
	Find the module that owns the source or header file that `Loc` points to.

OptionalFileEntryRef	getHeaderToIncludeForDiagnostics (SourceLocation IncLoc, SourceLocation MLoc)
	We want to produce a diagnostic at location IncLoc concerning an unreachable effect at location MLoc (eg, where a desired entity was declared or defined).

bool	isRecordingPreamble () const

bool	hasRecordedPreamble () const

ArrayRef< PPConditionalInfo >	getPreambleConditionalStack () const

void	setRecordedPreambleConditionalStack (ArrayRef< PPConditionalInfo > s)

void	setReplayablePreambleConditionalStack (ArrayRef< PPConditionalInfo > s, std::optional< PreambleSkipInfo > SkipInfo)

std::optional< PreambleSkipInfo >	getPreambleSkipInfo () const

void	HandlePragmaOnce (Token &OnceTok)
	HandlePragmaOnce - Handle #pragma once. OnceTok is the 'once'.

void	HandlePragmaMark (Token &MarkTok)

void	HandlePragmaPoison ()
	HandlePragmaPoison - Handle #pragma GCC poison. PoisonTok is the 'poison'.

void	HandlePragmaSystemHeader (Token &SysHeaderTok)
	HandlePragmaSystemHeader - Implement #pragma GCC system_header.

void	HandlePragmaDependency (Token &DependencyTok)
	HandlePragmaDependency - Handle #pragma GCC dependency "foo" blah.

void	HandlePragmaPushMacro (Token &Tok)
	Handle #pragma push_macro.

void	HandlePragmaPopMacro (Token &Tok)
	Handle #pragma pop_macro.

void	HandlePragmaIncludeAlias (Token &Tok)

void	HandlePragmaModuleBuild (Token &Tok)

void	HandlePragmaHdrstop (Token &Tok)

IdentifierInfo *	ParsePragmaPushOrPopMacro (Token &Tok)
	ParsePragmaPushOrPopMacro - Handle parsing of pragma push_macro/pop_macro.

bool	HandleComment (Token &result, SourceRange Comment)

void	markMacroAsUsed (MacroInfo *MI)
	A macro is used, update information about macros that need unused warnings.

void	addMacroDeprecationMsg (const IdentifierInfo *II, std::string Msg, SourceLocation AnnotationLoc)

void	addRestrictExpansionMsg (const IdentifierInfo *II, std::string Msg, SourceLocation AnnotationLoc)

void	addFinalLoc (const IdentifierInfo *II, SourceLocation AnnotationLoc)

const MacroAnnotations &	getMacroAnnotations (const IdentifierInfo *II) const

void	emitMacroExpansionWarnings (const Token &Identifier, bool IsIfnDef=false) const

bool	isSafeBufferOptOut (const SourceManager &SourceMgr, const SourceLocation &Loc) const

bool	enterOrExitSafeBufferOptOutRegion (bool isEnter, const SourceLocation &Loc)
	Alter the state of whether this PP currently is in a "-Wunsafe-buffer-usage" opt-out region.

bool	isPPInSafeBufferOptOutRegion ()

bool	isPPInSafeBufferOptOutRegion (SourceLocation &StartLoc)

SmallVector< SourceLocation, 64 >	serializeSafeBufferOptOutMap () const

bool	setDeserializedSafeBufferOptOutMap (const SmallVectorImpl< SourceLocation > &SrcLocSeqs)


PPCallbacks *	getPPCallbacks () const

void	addPPCallbacks (std::unique_ptr< PPCallbacks > C)

Static Public Member Functions
static bool	checkModuleIsAvailable (const LangOptions &LangOpts, const TargetInfo &TargetInfo, const Module &M, DiagnosticsEngine &Diags)
	Check that the given module is available, producing a diagnostic if not.

static void	processPathForFileMacro (SmallVectorImpl< char > &Path, const LangOptions &LangOpts, const TargetInfo &TI)

static void	processPathToFileName (SmallVectorImpl< char > &FileName, const PresumedLoc &PLoc, const LangOptions &LangOpts, const TargetInfo &TI)

Public Attributes
const TranslationUnitKind	TUKind
	The kind of translation unit we are processing.

llvm::DenseMap< FileID, SafeBufferOptOutRegionsTy >	LoadedRegions

Friends
class	VAOptDefinitionContext

class	VariadicMacroScopeGuard

class	ASTReader

class	MacroArgs

void	TokenLexer::ExpandFunctionArguments ()

using	macro_iterator = MacroMap::const_iterator

macro_iterator	macro_begin (bool IncludeExternalMacros=true) const

macro_iterator	macro_end (bool IncludeExternalMacros=true) const

llvm::iterator_range< macro_iterator >	macros (bool IncludeExternalMacros=true) const

Detailed Description

Engages in a tight little dance with the lexer to efficiently preprocess tokens.

Lexers know only about tokens within a single source file, and don't know anything about preprocessor-level issues like the #include stack, token expansion, etc.

Definition at line 138 of file Preprocessor.h.

Member Typedef Documentation

◆ IncludedFilesSet

using clang::Preprocessor::IncludedFilesSet = llvm::DenseSet<const FileEntry *>

Definition at line 700 of file Preprocessor.h.

◆ macro_iterator

using clang::Preprocessor::macro_iterator = MacroMap::const_iterator

Iterators for the macro history table. Currently defined macros have IdentifierInfo::hasMacroDefinition() set and an empty MacroInfo::getUndefLoc() at the head of the list.

Definition at line 1459 of file Preprocessor.h.

Constructor & Destructor Documentation

◆ Preprocessor()

Preprocessor::Preprocessor	(	std::shared_ptr< PreprocessorOptions >	PPOpts,
		DiagnosticsEngine &	diags,
		const LangOptions &	LangOpts,
		SourceManager &	SM,
		HeaderSearch &	Headers,
		ModuleLoader &	TheModuleLoader,
		IdentifierInfoLookup *	IILookup = `nullptr`,
		bool	OwnsHeaderSearch = `false`,
		TranslationUnitKind	TUKind = `TU_Complete`
	)

Definition at line 80 of file Preprocessor.cpp.

References getIdentifierInfo(), SetPoisonReason(), and usingPCHWithPragmaHdrStop().

◆ ~Preprocessor()

Preprocessor::~Preprocessor ( )

Definition at line 169 of file Preprocessor.cpp.

References isBacktrackEnabled().

Member Function Documentation

◆ addCommentHandler()

void Preprocessor::addCommentHandler ( CommentHandler * Handler )

Add the specified comment handler to the preprocessor.

Definition at line 1412 of file Preprocessor.cpp.

Referenced by clang::Parser::Parser(), and clang::CodeGen::CoverageMappingModuleGen::setUpCoverageCallbacks().

◆ addFinalLoc()

void clang::Preprocessor::addFinalLoc	(	const IdentifierInfo *	II,
		SourceLocation	AnnotationLoc
	)

inline

Definition at line 2895 of file Preprocessor.h.

◆ addMacroDeprecationMsg()

void clang::Preprocessor::addMacroDeprecationMsg	(	const IdentifierInfo *	II,
		std::string	Msg,
		SourceLocation	AnnotationLoc
	)

inline

Definition at line 2883 of file Preprocessor.h.

◆ addModuleMacro()

ModuleMacro * Preprocessor::addModuleMacro	(	Module *	Mod,
		IdentifierInfo *	II,
		MacroInfo *	Macro,
		ArrayRef< ModuleMacro * >	Overrides,
		bool &	IsNew
	)

Register an exported macro for a module and identifier.

Definition at line 130 of file PPMacroExpansion.cpp.

References clang::ModuleMacro::create(), clang::ModuleMacro::Profile(), and clang::IdentifierInfo::setHasMacroDefinition().

Referenced by LeaveSubmodule().

◆ addPPCallbacks()

void clang::Preprocessor::addPPCallbacks ( std::unique_ptr< PPCallbacks > C )

inline

Definition at line 1303 of file Preprocessor.h.

References clang::C.

Referenced by clang::AttachDependencyGraphGen(), clang::AttachHeaderIncludeGen(), clang::DependencyCollector::attachToPreprocessor(), clang::ModuleDependencyCollector::attachToPreprocessor(), clang::tooling::dependencies::ModuleDepCollector::attachToPreprocessor(), clang::arcmt::MigrateSourceAction::CreateASTConsumer(), clang::arcmt::ObjCMigrateAction::CreateASTConsumer(), clang::CodeGenAction::CreateASTConsumer(), clang::ExtractAPIAction::CreateASTConsumer(), clang::WrappingExtractAPIAction::CreateASTConsumer(), createPreprocessingRecord(), clang::DoPrintPreprocessedInput(), clang::MacroExpansionContext::registerForPreprocessor(), clang::RewriteIncludesInInput(), clang::Sema::Sema(), clang::CodeGen::CoverageMappingModuleGen::setUpCoverageCallbacks(), and clang::syntax::TokenCollector::TokenCollector().

◆ AddPragmaHandler() [1/2]

void clang::Preprocessor::AddPragmaHandler ( PragmaHandler * Handler )

inline

Definition at line 1534 of file Preprocessor.h.

References AddPragmaHandler().

◆ AddPragmaHandler() [2/2]

void Preprocessor::AddPragmaHandler	(	StringRef	Namespace,
		PragmaHandler *	Handler
	)

Add the specified pragma handler to this preprocessor.

AddPragmaHandler - Add the specified pragma handler to the preprocessor.

If Namespace is non-null, then it is a token required to exist on the pragma line before the pragma string starts, e.g. "STDC" or "GCC".

If 'Namespace' is non-null, then it is a token required to exist on the pragma line before the pragma string starts, e.g. "STDC" or "GCC".

Definition at line 911 of file Pragma.cpp.

References clang::PragmaNamespace::AddPragma(), clang::PragmaNamespace::FindHandler(), clang::PragmaNamespace::getIfNamespace(), and clang::PragmaHandler::getName().

Referenced by AddPragmaHandler(), clang::DoPrintPreprocessedInput(), and IgnorePragmas().

◆ addRestrictExpansionMsg()

void clang::Preprocessor::addRestrictExpansionMsg	(	const IdentifierInfo *	II,
		std::string	Msg,
		SourceLocation	AnnotationLoc
	)

inline

Definition at line 2889 of file Preprocessor.h.

◆ AdvanceToTokenCharacter()

SourceLocation clang::Preprocessor::AdvanceToTokenCharacter	(	SourceLocation	TokStart,
		unsigned	Char
	)		const

inline

Given a location that specifies the start of a token, return a new location that specifies a character within the token.

Definition at line 2219 of file Preprocessor.h.

References clang::Lexer::AdvanceToTokenCharacter().

Referenced by GetLineValue().

◆ AllocateMacroInfo()

MacroInfo * Preprocessor::AllocateMacroInfo ( SourceLocation L )

Allocate a new MacroInfo object with the provided SourceLocation.

Definition at line 62 of file PPDirectives.cpp.

◆ alreadyIncluded()

bool clang::Preprocessor::alreadyIncluded ( FileEntryRef File ) const

inline

Return true if this header has already been included.

Definition at line 1498 of file Preprocessor.h.

References clang::File, and clang::HeaderSearch::getFileInfo().

Referenced by clang::HeaderSearch::ShouldEnterIncludeFile().

◆ AnnotateCachedTokens()

void clang::Preprocessor::AnnotateCachedTokens ( const Token & Tok )

inline

We notify the Preprocessor that if it is caching tokens (because backtrack is enabled) it should replace the most recent cached tokens with the given annotation token.

This function has no effect if backtracking is not enabled.

Note that the use of this function is just for optimization, so that the cached tokens doesn't get re-parsed and re-resolved after a backtrack is invoked.

Definition at line 1884 of file Preprocessor.h.

References clang::Token::isAnnotation(), and isBacktrackEnabled().

Referenced by clang::Parser::TryAnnotateTypeOrScopeToken(), and clang::Parser::TryAnnotateTypeOrScopeTokenAfterScopeSpec().

◆ appendDefMacroDirective() [1/2]

DefMacroDirective * clang::Preprocessor::appendDefMacroDirective	(	IdentifierInfo *	II,
		MacroInfo *	MI
	)

inline

Definition at line 1425 of file Preprocessor.h.

References appendDefMacroDirective(), and clang::MacroInfo::getDefinitionLoc().

◆ appendDefMacroDirective() [2/2]

DefMacroDirective * clang::Preprocessor::appendDefMacroDirective	(	IdentifierInfo *	II,
		MacroInfo *	MI,
		SourceLocation	Loc
	)

inline

Definition at line 1419 of file Preprocessor.h.

References appendMacroDirective(), and Loc.

Referenced by appendDefMacroDirective(), and HandlePragmaPopMacro().

◆ appendMacroDirective()

void Preprocessor::appendMacroDirective	(	IdentifierInfo *	II,
		MacroDirective *	MD
	)

Add a directive to the macro directive history for this identifier.

Definition at line 69 of file PPMacroExpansion.cpp.

References clang::MacroDirective::getPrevious(), clang::MacroDirective::isDefined(), clang::IdentifierInfo::isFromAST(), clang::IdentifierInfo::setChangedSinceDeserialization(), clang::IdentifierInfo::setHasMacroDefinition(), and clang::MacroDirective::setPrevious().

Referenced by appendDefMacroDirective(), and HandlePragmaPopMacro().

◆ Backtrack()

void Preprocessor::Backtrack ( )

Make Preprocessor re-lex the tokens that were lexed since EnableBacktrackAtThisPos() was previously called.

Definition at line 66 of file PPCaching.cpp.

References isBacktrackEnabled(), and recomputeCurLexerKind().

◆ CheckEndOfDirective()

SourceLocation Preprocessor::CheckEndOfDirective	(	const char *	DirType,
		bool	EnableMacros = `false`
	)

Ensure that the next token is a tok::eod token.

If not, emit a diagnostic and consume up until the eod. If EnableMacros is true, then we consider macros that expand to zero tokens as being ok.

Returns: The location of the end of the directive (the terminating newline).

If not, emit a diagnostic and consume up until the eod. If EnableMacros is true, then we consider macros that expand to zero tokens as being ok.

Returns the location of the end of the directive.

Definition at line 438 of file PPDirectives.cpp.

References clang::FixItHint::CreateInsertion(), Diag(), DiscardUntilEndOfDirective(), clang::SourceRange::getEnd(), clang::Token::getLocation(), clang::Token::is(), Lex(), and LexUnexpandedToken().

◆ CheckMacroName()

bool Preprocessor::CheckMacroName	(	Token &	MacroNameTok,
		MacroUse	isDefineUndef,
		bool *	ShadowFlag = `nullptr`
	)

◆ checkModuleIsAvailable()

bool Preprocessor::checkModuleIsAvailable	(	const LangOptions &	LangOpts,
		const TargetInfo &	TargetInfo,
		const Module &	M,
		DiagnosticsEngine &	Diags
	)

static

Check that the given module is available, producing a diagnostic if not.

Returns: true if the check failed (because the module is not available). false if the module appears to be usable.

Definition at line 1998 of file PPDirectives.cpp.

References clang::Module::DefinitionLoc, clang::Module::Requirement::FeatureName, clang::Module::UnresolvedHeaderDirective::FileName, clang::Module::UnresolvedHeaderDirective::FileNameLoc, clang::Module::getFullModuleName(), clang::Module::isAvailable(), clang::Module::UnresolvedHeaderDirective::IsUmbrella, clang::SourceLocation::isValid(), clang::Module::Name, clang::DiagnosticsEngine::Report(), and clang::Module::Requirement::RequiredState.

Referenced by clang::CompilerInstance::loadModule(), and prepareToBuildModule().

◆ clearCodeCompletionHandler()

void clang::Preprocessor::clearCodeCompletionHandler ( )

inline

Clear out the code completion handler.

Definition at line 1575 of file Preprocessor.h.

Referenced by clang::Parser::~Parser().

◆ CodeCompleteIncludedFile()

void Preprocessor::CodeCompleteIncludedFile	(	llvm::StringRef	Dir,
		bool	IsAngled
	)

Hook used by the lexer to invoke the "included file" code completion point.

Definition at line 450 of file Preprocessor.cpp.

References clang::CodeCompletionHandler::CodeCompleteIncludedFile(), and setCodeCompletionReached().

◆ CodeCompleteNaturalLanguage()

void Preprocessor::CodeCompleteNaturalLanguage ( )

Hook used by the lexer to invoke the "natural language" code completion point.

Definition at line 457 of file Preprocessor.cpp.

References clang::CodeCompletionHandler::CodeCompleteNaturalLanguage(), and setCodeCompletionReached().

Referenced by clang::Lexer::ReadToEndOfLine(), and clang::MacroArgs::StringifyArgument().

◆ CollectPpImportSuffix()

void Preprocessor::CollectPpImportSuffix ( SmallVectorImpl< Token > & Toks )

Collect the tokens of a C++20 pp-import-suffix.

Definition at line 1091 of file Preprocessor.cpp.

References Lex().

Referenced by LexAfterModuleImport().

◆ CommitBacktrackedTokens()

void Preprocessor::CommitBacktrackedTokens ( )

Disable the last EnableBacktrackAtThisPos call.

Definition at line 56 of file PPCaching.cpp.

References isBacktrackEnabled().

◆ createPreprocessingRecord()

void Preprocessor::createPreprocessingRecord ( )

Create a new preprocessing record, which will keep track of all macro expansions, macro definitions, etc.

Definition at line 1635 of file Preprocessor.cpp.

References addPPCallbacks(), and getSourceManager().

◆ CreateString()

void Preprocessor::CreateString	(	StringRef	Str,
		Token &	Tok,
		SourceLocation	ExpansionLocStart = `SourceLocation()`,
		SourceLocation	ExpansionLocEnd = `SourceLocation()`
	)

Plop the specified string into a scratch buffer and set the specified token's location and length to it.

CreateString - Plop the specified string into a scratch buffer and return a location for it.

If specified, the source location provides a location of the expansion point of the token.

If specified, the source location provides a source location for the token.

Definition at line 488 of file Preprocessor.cpp.

References clang::SourceManager::createExpansionLoc(), clang::Token::is(), clang::Token::isLiteral(), clang::SourceLocation::isValid(), Loc, clang::Token::setLength(), clang::Token::setLiteralData(), clang::Token::setLocation(), and clang::Token::setRawIdentifierData().

Referenced by ComputeDATE_TIME(), clang::Sema::ExpandFunctionLocalPredefinedMacros(), LexHeaderName(), ParsePragmaPushOrPopMacro(), and clang::MacroArgs::StringifyArgument().

◆ creatingPCHWithPragmaHdrStop()

bool Preprocessor::creatingPCHWithPragmaHdrStop ( )

True if creating a PCH with a #pragma hdrstop.

Definition at line 626 of file Preprocessor.cpp.

References clang::TU_Prefix, and TUKind.

Referenced by HandlePragmaHdrstop().

◆ creatingPCHWithThroughHeader()

bool Preprocessor::creatingPCHWithThroughHeader ( )

True if creating a PCH with a through header.

Definition at line 616 of file Preprocessor.cpp.

References clang::FileID::isValid(), clang::TU_Prefix, and TUKind.

Referenced by HandleEndOfFile().

◆ Diag() [1/2]

DiagnosticBuilder clang::Preprocessor::Diag	(	const Token &	Tok,
		unsigned	DiagID
	)		const

inline

Definition at line 2065 of file Preprocessor.h.

References clang::Token::getLocation(), and clang::DiagnosticsEngine::Report().

◆ Diag() [2/2]

DiagnosticBuilder clang::Preprocessor::Diag	(	SourceLocation	Loc,
		unsigned	DiagID
	)		const

inline

Forwarding function for diagnostics.

This emits a diagnostic at the specified Token's location, translating the token's start position in the current buffer into a SourcePosition object for rendering.

Definition at line 2061 of file Preprocessor.h.

References Loc, and clang::DiagnosticsEngine::Report().

Referenced by clang::Sema::ActOnNumericConstant(), buildMSAsmString(), clang::CharLiteralParser::CharLiteralParser(), checkConfigMacro(), CheckEndOfDirective(), CheckMacroName(), clang::Lexer::Diag(), diagnoseAutoModuleImport(), diagnoseUnexpectedOperator(), EnterMainSourceFile(), EnterSourceFile(), EvaluateDefined(), EvaluateDirectiveSubExpr(), EvaluateFeatureLikeBuiltinMacro(), EvaluateHasIncludeCommon(), EvaluateValue(), ExpectFeatureIdentifierInfo(), FinishLexStringLiteral(), GetIncludeFilenameSpelling(), GetLineValue(), HandleDirective(), HandleEndOfFile(), HandleIdentifier(), HandlePoisonedIdentifier(), clang::PragmaNamespace::HandlePragma(), HandlePragmaDependency(), HandlePragmaHdrstop(), HandlePragmaIncludeAlias(), HandlePragmaModuleBuild(), HandlePragmaOnce(), HandlePragmaPoison(), HandlePragmaPopMacro(), HandlePragmaSystemHeader(), LexAfterModuleImport(), LexEmbedParameters(), LexHeaderName(), LexModuleNameComponent(), LexOnOffSwitch(), makeModuleVisible(), ParseAlignPragma(), ParseLoopHintValue(), ParsePragmaPushOrPopMacro(), clang::Parser::ParseTopLevelDecl(), ReadLineMarkerFlags(), SkipTokensWhileUsingPCH(), and clang::MacroArgs::StringifyArgument().

◆ DiscardUntilEndOfDirective() [1/2]

SourceRange clang::Preprocessor::DiscardUntilEndOfDirective ( )

inline

Read and discard all tokens remaining on the current line until the tok::eod token is found.

Returns the range of the skipped tokens.

Definition at line 2342 of file Preprocessor.h.

References DiscardUntilEndOfDirective().

Referenced by CheckEndOfDirective(), DiscardUntilEndOfDirective(), GetLineValue(), HandleDirective(), HandlePragmaModuleBuild(), HandleSkippedDirectiveWhileUsingPCH(), LexEmbedParameters(), and ReadLineMarkerFlags().

◆ DiscardUntilEndOfDirective() [2/2]

SourceRange Preprocessor::DiscardUntilEndOfDirective ( Token & Tok )

Same as above except retains the token that was found.

Read and discard all tokens remaining on the current line until the tok::eod token is found.

Definition at line 85 of file PPDirectives.cpp.

References clang::Token::getLocation(), clang::Token::isNot(), LexUnexpandedToken(), clang::SourceRange::setBegin(), and clang::SourceRange::setEnd().

◆ DumpLocation()

void Preprocessor::DumpLocation ( SourceLocation Loc ) const

Definition at line 261 of file Preprocessor.cpp.

References Loc, and clang::SourceLocation::print().

Referenced by DumpToken().

◆ DumpMacro()

void Preprocessor::DumpMacro ( const MacroInfo & MI ) const

Definition at line 265 of file Preprocessor.cpp.

References DumpToken(), clang::MacroInfo::getNumTokens(), and clang::MacroInfo::getReplacementToken().

◆ dumpMacroInfo()

void Preprocessor::dumpMacroInfo ( const IdentifierInfo * II )

Definition at line 256 of file PPMacroExpansion.cpp.

References clang::MacroInfo::dump(), clang::IdentifierInfo::getNameStart(), and Visited.

◆ DumpToken()

void Preprocessor::DumpToken	(	const Token &	Tok,
		bool	DumpFlags = `false`
	)		const

Print the token to stderr, used for debugging.

Definition at line 235 of file Preprocessor.cpp.

References DumpLocation(), clang::SourceManager::getCharacterData(), clang::Token::getKind(), clang::Token::getLength(), clang::Token::getLocation(), getSpelling(), clang::tok::getTokenName(), clang::Token::hasLeadingSpace(), clang::Token::isAnnotation(), clang::Token::isAtStartOfLine(), clang::Token::isExpandDisabled(), and clang::Token::needsCleaning().

Referenced by DumpMacro(), clang::DumpRawTokensAction::ExecuteAction(), and clang::DumpTokensAction::ExecuteAction().

◆ emitMacroExpansionWarnings()

void clang::Preprocessor::emitMacroExpansionWarnings	(	const Token &	Identifier,
		bool	IsIfnDef = `false`
	)		const

inline

Definition at line 2903 of file Preprocessor.h.

References getLangOpts(), clang::IdentifierInfo::getName(), Identifier, clang::IdentifierInfo::isDeprecatedMacro(), and clang::IdentifierInfo::isRestrictExpansion().

Referenced by EvaluateDefined().

◆ EnableBacktrackAtThisPos()

void Preprocessor::EnableBacktrackAtThisPos ( bool Unannotated = false )

From the point that this method is called, and until CommitBacktrackedTokens() or Backtrack() is called, the Preprocessor keeps track of the lexed tokens so that a subsequent Backtrack() call will make the Preprocessor re-lex the same tokens.

Nested backtracks are allowed, meaning that EnableBacktrackAtThisPos can be called multiple times and CommitBacktrackedTokens/Backtrack calls will be combined with the EnableBacktrackAtThisPos calls in reverse order.

NOTE: DO NOT forget to call either CommitBacktrackedTokens or Backtrack at some point after EnableBacktrackAtThisPos. If you don't, caching of tokens will continue indefinitely.

Parameters

Unannotated Whether token annotations are reverted upon calling Backtrack().

Definition at line 34 of file PPCaching.cpp.

◆ enableIncrementalProcessing()

void clang::Preprocessor::enableIncrementalProcessing ( bool value = true )

inline

Enables the incremental processing.

Definition at line 1948 of file Preprocessor.h.

◆ EndSourceFile()

void Preprocessor::EndSourceFile ( )

Inform the preprocessor callbacks that processing is complete.

Definition at line 683 of file Preprocessor.cpp.

Referenced by clang::FrontendAction::EndSourceFile().

◆ EnterAnnotationToken()

void Preprocessor::EnterAnnotationToken	(	SourceRange	Range,
		tok::TokenKind	Kind,
		void *	AnnotationVal
	)

Enter an annotation token into the token stream.

Push a token onto the token stream containing an annotation.

Definition at line 1903 of file PPDirectives.cpp.

References clang::SourceRange::getBegin(), clang::SourceRange::getEnd(), Range, clang::Token::setAnnotationEndLoc(), clang::Token::setAnnotationValue(), clang::Token::setKind(), clang::Token::setLocation(), and clang::Token::startToken().

◆ EnterMacro()

void Preprocessor::EnterMacro	(	Token &	Tok,
		SourceLocation	ILEnd,
		MacroInfo *	Macro,
		MacroArgs *	Args
	)

Add a Macro to the top of the include stack and start lexing tokens from it instead of the current buffer.

EnterMacro - Add a Macro to the top of the include stack and start lexing tokens from it instead of the current buffer.

Parameters

Args	specifies the tokens input to a function-like macro.
ILEnd	specifies the location of the ')' for a function-like macro or the identifier for an object-like macro.

Definition at line 150 of file PPLexerChange.cpp.

◆ EnterMainSourceFile()

void Preprocessor::EnterMainSourceFile ( )

Enter the specified FileID as the main source file, which implicitly adds the builtin defines etc.

EnterMainSourceFile - Enter the specified FileID as the main source file, which implicitly adds the builtin defines etc.

Definition at line 544 of file Preprocessor.cpp.

References clang::SrcMgr::C_User, clang::SourceManager::createFileID(), Diag(), EnterSourceFile(), clang::File, clang::SourceManager::getFileEntryRefForID(), clang::SourceManager::getMainFileID(), clang::SourceManager::isLoadedFileID(), clang::FileID::isValid(), LookupFile(), markIncluded(), SkipTokensWhileUsingPCH(), usingPCHWithPragmaHdrStop(), and usingPCHWithThroughHeader().

Referenced by DoPrintMacros(), clang::DoPrintPreprocessedInput(), clang::PrintDependencyDirectivesSourceMinimizerAction::ExecuteAction(), clang::DumpTokensAction::ExecuteAction(), clang::PreprocessOnlyAction::ExecuteAction(), clang::ParseAST(), clang::RewriteIncludesInInput(), and clang::RewriteMacrosInInput().

◆ enterOrExitSafeBufferOptOutRegion()

bool Preprocessor::enterOrExitSafeBufferOptOutRegion	(	bool	isEnter,
		const SourceLocation &	Loc
	)

Alter the state of whether this PP currently is in a "-Wunsafe-buffer-usage" opt-out region.

Parameters

isEnter	true if this PP is entering a region; otherwise, this PP is exiting a region
Loc	the location of the entry or exit of a region

Returns: true iff it is INVALID to enter or exit a region, i.e., attempt to enter a region before exiting a previous region, or exiting a region that PP is not currently in.

Definition at line 1541 of file Preprocessor.cpp.

References isPPInSafeBufferOptOutRegion(), and Loc.

◆ EnterSourceFile()

bool Preprocessor::EnterSourceFile	(	FileID	FID,
		ConstSearchDirIterator	Dir,
		SourceLocation	Loc,
		bool	IsFirstIncludeOfFile = `true`
	)

Add a source file to the top of the include stack and start lexing tokens from it instead of the current buffer.

EnterSourceFile - Add a source file to the top of the include stack and start lexing tokens from it instead of the current buffer.

Emits a diagnostic, doesn't enter the file, and returns true on error.

Definition at line 68 of file PPLexerChange.cpp.

References Diag(), clang::File, clang::SourceManager::getBufferName(), clang::SourceManager::getBufferOrNone(), clang::SourceManager::getFileEntryForID(), clang::SourceManager::getFileEntryRefForID(), clang::SourceManager::getLocForStartOfFile(), clang::SourceLocation::getLocWithOffset(), getPreprocessorOpts(), getSourceManager(), isCodeCompletionEnabled(), and Loc.

Referenced by EnterMainSourceFile(), and clang::IncrementalParser::Parse().

◆ EnterSubmodule()

void Preprocessor::EnterSubmodule	(	Module *	M,
		SourceLocation	ImportLoc,
		bool	ForPragma
	)

Definition at line 698 of file PPLexerChange.cpp.

References getHeaderSearchInfo(), getLangOpts(), clang::HeaderSearch::getModuleMap(), makeModuleVisible(), clang::ModuleMap::resolveConflicts(), clang::ModuleMap::resolveExports(), and clang::ModuleMap::resolveUses().

◆ EnterToken()

void clang::Preprocessor::EnterToken	(	const Token &	Tok,
		bool	IsReinject
	)

inline

Enters a token in the token stream to be lexed next.

If BackTrack() is called afterwards, the token will remain at the insertion point. If IsReinject is true, resulting token will have Token::IsReinjected flag set. See the flag documentation for details.

Definition at line 1862 of file Preprocessor.h.

Referenced by FixDigraph(), and clang::Parser::TryAnnotateTypeOrScopeToken().

◆ EnterTokenStream() [1/2]

void clang::Preprocessor::EnterTokenStream	(	ArrayRef< Token >	Toks,
		bool	DisableMacroExpansion,
		bool	IsReinject
	)

inline

Definition at line 1690 of file Preprocessor.h.

◆ EnterTokenStream() [2/2]

void clang::Preprocessor::EnterTokenStream	(	std::unique_ptr< Token[]>	Toks,
		unsigned	NumToks,
		bool	DisableMacroExpansion,
		bool	IsReinject
	)

inline

Definition at line 1684 of file Preprocessor.h.

◆ FinalizeForModelFile()

void Preprocessor::FinalizeForModelFile ( )

Cleanup after model file parsing.

Definition at line 229 of file Preprocessor.cpp.

◆ FinishLexStringLiteral()

bool Preprocessor::FinishLexStringLiteral	(	Token &	Result,
		std::string &	String,
		const char *	DiagnosticTag,
		bool	AllowMacroExpansion
	)

Complete the lexing of a string literal where the first token has already been lexed (see LexStringLiteral).

Definition at line 1351 of file Preprocessor.cpp.

References Diag(), Lex(), LexUnexpandedToken(), and clang::Result.

Referenced by LexStringLiteral().

◆ getAffectingClangModules()

const llvm::SmallSetVector< Module *, 2 > & clang::Preprocessor::getAffectingClangModules ( ) const

inline

Get the set of top-level clang modules that affected preprocessing, but were not imported.

Definition at line 1486 of file Preprocessor.h.

Referenced by clang::tooling::dependencies::ModuleDepCollectorPP::EndOfMainFile().

◆ getAuxTargetInfo()

const TargetInfo * clang::Preprocessor::getAuxTargetInfo ( ) const

inline

Definition at line 1207 of file Preprocessor.h.

Referenced by clang::InitializePreprocessor().

◆ getBuildingSubmodules()

ArrayRef< BuildingSubmoduleInfo > clang::Preprocessor::getBuildingSubmodules ( ) const

inline

Get the list of submodules that we're currently building.

Definition at line 1451 of file Preprocessor.h.

◆ getBuiltinInfo()

Builtin::Context & clang::Preprocessor::getBuiltinInfo ( )

inline

Definition at line 1215 of file Preprocessor.h.

Referenced by clang::FrontendAction::BeginSourceFile(), clang::CompilerInstance::createASTContext(), clang::createChainedIncludesSource(), and clang::ASTUnit::LoadFromASTFile().

◆ getCheckPoint()

const char * Preprocessor::getCheckPoint	(	FileID	FID,
		const char *	Start
	)		const

Returns a pointer into the given file's buffer that's guaranteed to be between tokens.

The returned pointer is always before Start. The maximum distance betweenthe returned pointer and Start is limited by a constant value, but also an implementation detail. If no such check point exists, nullptr is returned.

Definition at line 1643 of file Preprocessor.cpp.

References clang::Last, and P.

Referenced by highlightLines().

◆ getCodeCompletionFileLoc()

SourceLocation clang::Preprocessor::getCodeCompletionFileLoc ( ) const

inline

Returns the start location of the file of code-completion point.

Returns an invalid location if code-completion is not enabled or the file containing the code-completion point has not been lexed yet.

Definition at line 1982 of file Preprocessor.h.

◆ getCodeCompletionFilter()

StringRef clang::Preprocessor::getCodeCompletionFilter ( )

inline

Get the code completion token for filtering purposes.

Definition at line 1603 of file Preprocessor.h.

Referenced by clang::PrintingCodeCompleteConsumer::ProcessCodeCompleteResults().

◆ getCodeCompletionHandler()

CodeCompletionHandler * clang::Preprocessor::getCodeCompletionHandler ( ) const

inline

Retrieve the current code-completion handler.

Definition at line 1570 of file Preprocessor.h.

Referenced by EvaluateDefined(), and EvaluateValue().

◆ getCodeCompletionLoc()

SourceLocation clang::Preprocessor::getCodeCompletionLoc ( ) const

inline

Returns the location of the code-completion point.

Returns an invalid location if code-completion is not enabled or the file containing the code-completion point has not been lexed yet.

Definition at line 1976 of file Preprocessor.h.

◆ getCodeCompletionTokenRange()

SourceRange clang::Preprocessor::getCodeCompletionTokenRange ( ) const

inline

Definition at line 1598 of file Preprocessor.h.

◆ getCommentRetentionState()

bool clang::Preprocessor::getCommentRetentionState ( ) const

inline

Definition at line 1250 of file Preprocessor.h.

Referenced by HandleComment(), PrintPreprocessedTokens(), and clang::Lexer::resetExtendedTokenMode().

◆ getCounterValue()

unsigned clang::Preprocessor::getCounterValue ( ) const

inline

Definition at line 2355 of file Preprocessor.h.

◆ getCurrentFileLexer()

PreprocessorLexer * Preprocessor::getCurrentFileLexer ( ) const

Return the current file lexer being lexed from.

getCurrentLexer - Return the current file lexer being lexed from.

Note that this ignores any potentially active macro expansions and _Pragma expansions going on at the time.

Definition at line 49 of file PPLexerChange.cpp.

Referenced by clang::SemaCodeCompletion::CodeCompleteIncludedFile(), HandleDirective(), HandlePragmaDependency(), HandlePragmaOnce(), HandlePragmaSystemHeader(), and LookupFile().

◆ getCurrentFPEvalMethod()

LangOptions::FPEvalMethodKind clang::Preprocessor::getCurrentFPEvalMethod ( ) const

inline

Definition at line 2358 of file Preprocessor.h.

References clang::LangOptionsBase::FEM_UnsetOnCommandLine.

Referenced by clang::Sema::DiagnoseUseOfDecl(), and clang::Sema::Sema().

◆ getCurrentLexer()

PreprocessorLexer * clang::Preprocessor::getCurrentLexer ( ) const

inline

Return the current lexer being lexed from.

Note that this ignores any potentially active macro expansions and _Pragma expansions going on at the time.

Definition at line 1282 of file Preprocessor.h.

Referenced by clang::ParseAST().

◆ getCurrentLexerSubmodule()

Module * clang::Preprocessor::getCurrentLexerSubmodule ( ) const

inline

Return the submodule owning the file being lexed.

This may not be the current module if we have changed modules since entering the file.

Definition at line 1292 of file Preprocessor.h.

◆ getCurrentModule()

Module * Preprocessor::getCurrentModule ( )

Retrieves the module that we're currently building, if any.

Definition at line 524 of file Preprocessor.cpp.

References getHeaderSearchInfo(), getLangOpts(), and clang::HeaderSearch::lookupModule().

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), clang::ASTReader::DecodeIdentifierInfo(), HandleEndOfFile(), LookupFile(), and clang::PCHValidator::ReadDiagnosticOptions().

◆ getCurrentModuleImplementation()

Module * Preprocessor::getCurrentModuleImplementation ( )

Retrieves the module whose implementation we're current compiling, if any.

Definition at line 531 of file Preprocessor.cpp.

References getHeaderSearchInfo(), getLangOpts(), and clang::HeaderSearch::lookupModule().

Referenced by clang::tooling::dependencies::ModuleDepCollector::applyDiscoveredDependencies(), and clang::FrontendAction::BeginSourceFile().

◆ getDiagnostics()

DiagnosticsEngine & clang::Preprocessor::getDiagnostics ( ) const

inline

Definition at line 1202 of file Preprocessor.h.

Referenced by clang::Sema::ActOnNumericConstant(), AddImplicitIncludePCH(), clang::AttachHeaderIncludeGen(), clang::CharLiteralParser::CharLiteralParser(), clang::ento::CreateAnalysisConsumer(), EnableCodeCompletion(), EvaluateValue(), clang::PCHGenerator::getDiagnostics(), clang::PCHGenerator::getEmittingModule(), clang::PCHGenerator::HandleTranslationUnit(), HasExtension(), clang::InitializePreprocessor(), ParseDirective(), parseSimpleIntegerLiteral(), clang::PCHValidator::ReadDiagnosticOptions(), and setCodeCompletionReached().

◆ getEmptylineHandler()

EmptylineHandler * clang::Preprocessor::getEmptylineHandler ( ) const

inline

Definition at line 1554 of file Preprocessor.h.

◆ getExternalSource()

ExternalPreprocessorSource * clang::Preprocessor::getExternalSource ( ) const

inline

Definition at line 1222 of file Preprocessor.h.

Referenced by isTrivialSingleTokenExpansion().

◆ getFileManager()

FileManager & clang::Preprocessor::getFileManager ( ) const

inline

Definition at line 1208 of file Preprocessor.h.

Referenced by AddImplicitIncludePCH(), EnableCodeCompletion(), clang::Sema::getDarwinSDKInfoForAvailabilityChecking(), LookupEmbedFile(), clang::ASTWriter::PreparePathForOutput(), clang::PCHValidator::ReadDiagnosticOptions(), clang::PCHValidator::ReadPreprocessorOptions(), and clang::SimpleASTReaderListener::ReadPreprocessorOptions().

◆ getHeaderSearchInfo()

HeaderSearch & clang::Preprocessor::getHeaderSearchInfo ( ) const

inline

Definition at line 1210 of file Preprocessor.h.

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), clang::Sema::ActOnModuleDecl(), clang::Sema::ActOnPrivateModuleFragmentDecl(), clang::tooling::dependencies::ModuleDepCollector::applyDiscoveredDependencies(), clang::DependencyCollector::attachToPreprocessor(), clang::ModuleDependencyCollector::attachToPreprocessor(), clang::FrontendAction::BeginSourceFile(), clang::Sema::BuildModuleInclude(), clang::SemaCodeCompletion::CodeCompleteIncludedFile(), clang::SemaCodeCompletion::CodeCompleteModuleImport(), compileModule(), clang::CompilerInstance::createPCHExternalASTSource(), clang::FrontendAction::EndSourceFile(), EnterSubmodule(), EvaluateHasIncludeCommon(), clang::FrontendAction::Execute(), clang::installapi::InstallAPIContext::findAndRecordFile(), getCurrentModule(), clang::FrontendAction::getCurrentModule(), getCurrentModuleImplementation(), clang::Sema::getDarwinSDKInfoForAvailabilityChecking(), clang::PCHGenerator::getEmittingModule(), getHeaderNameForHeader(), getHeaderToIncludeForDiagnostics(), getInputBufferForModule(), getTopImportImplicitModule(), clang::VerifyDiagnosticConsumer::HandleDiagnostic(), HandlePragmaIncludeAlias(), clang::CXX20ModulesGenerator::HandleTranslationUnit(), clang::PCHGenerator::InitializeSema(), clang::CompilerInstance::loadGlobalModuleIndex(), clang::CompilerInstance::loadModule(), loadModuleMapForModuleBuild(), clang::Sema::notePreviousDefinition(), prepareToBuildModule(), and clang::PCHValidator::ReadHeaderSearchOptions().

◆ getHeaderToIncludeForDiagnostics()

OptionalFileEntryRef Preprocessor::getHeaderToIncludeForDiagnostics	(	SourceLocation	IncLoc,
		SourceLocation	MLoc
	)

We want to produce a diagnostic at location IncLoc concerning an unreachable effect at location MLoc (eg, where a desired entity was declared or defined).

Determine whether the right way to make MLoc reachable is by #include, and if so, what header should be included.

This is not necessarily fast, and might load unexpected module maps, so should only be called by code that intends to produce an error.

Parameters

IncLoc	The location at which the missing effect was detected.
MLoc	A location within an unimported module at which the desired effect occurred.

Returns: A file that can be #included to provide the desired effect. Null if no such file could be determined or if a #include is not appropriate (eg, if a module should be imported instead).

Definition at line 904 of file PPDirectives.cpp.

References clang::ModuleMap::ExcludedHeader, clang::HeaderSearch::findAllModulesForHeader(), getHeaderSearchInfo(), getLangOpts(), getModuleForLocation(), getSourceManager(), clang::HeaderSearch::hasModuleMap(), clang::SourceManager::isInSystemHeader(), clang::SourceLocation::isInvalid(), Loc, clang::ObjC, SM, and clang::ModuleMap::TextualHeader.

Referenced by clang::Sema::diagnoseMissingImport().

◆ getIdentifierInfo()

IdentifierInfo * clang::Preprocessor::getIdentifierInfo ( StringRef Name ) const

inline

Return information about the specified preprocessor identifier token.

Definition at line 1525 of file Preprocessor.h.

References clang::IdentifierTable::get().

Referenced by clang::Sema::ActOnModuleDecl(), clang::Sema::ActOnModuleImport(), checkConfigMacro(), checkTupleLikeDecomposition(), clang::Sema::DefaultVariadicArgumentPromotion(), DiagnoseCallingConvCast(), clang::SemaObjC::DiagnoseOwningPropertyGetterSynthesis(), clang::Sema::EvaluateStaticAssertMessageAsString(), fixSeparateAttrArgAndNumber(), getFallthroughAttrSpelling(), clang::SemaObjC::getNSErrorIdent(), clang::Sema::getNullabilityKeyword(), clang::Sema::GetOrCreateMSAsmLabel(), getTupleLikeElementType(), highlightLines(), clang::Parser::Initialize(), clang::Sema::Initialize(), isTupleLike(), Lex(), LexAfterModuleImport(), LexModuleNameComponent(), clang::CompilerInstance::loadModule(), LookUpIdentifierInfo(), lookupMember(), Preprocessor(), and clang::ento::tryExpandAsInteger().

◆ getIdentifierTable() [1/2]

IdentifierTable & clang::Preprocessor::getIdentifierTable ( )

inline

Definition at line 1212 of file Preprocessor.h.

Referenced by clang::SemaObjC::ActOnClassPropertyRefExpr(), clang::Sema::ActOnCXXTypeid(), clang::SemaOpenMP::ActOnOpenMPInterchangeDirective(), clang::SemaOpenMP::ActOnOpenMPReverseDirective(), clang::SemaOpenMP::ActOnOpenMPTileDirective(), clang::SemaOpenMP::ActOnOpenMPUnrollDirective(), clang::FrontendAction::BeginSourceFile(), buildCoroutineHandle(), clang::Sema::buildCoroutinePromise(), buildMemberCall(), BuildNonArrayForRange(), buildStdNoThrowDeclRef(), buildVarDecl(), clang::CompilerInstance::createASTContext(), clang::createChainedIncludesSource(), clang::Sema::DeclareGlobalNewDelete(), clang::ASTReader::DecodeIdentifierInfo(), clang::FrontendAction::EndSourceFile(), findOMPAllocatorHandleT(), findOMPAlloctraitT(), findOMPDependT(), findOMPEventHandleT(), clang::ASTReader::getIdentifierTable(), clang::Sema::getOrCreateStdNamespace(), clang::SemaObjC::HandleExprPropertyRefExpr(), HandleIdentifier(), handleOwnershipAttr(), highlightLines(), clang::Parser::Initialize(), clang::Sema::isStdInitializerList(), clang::ASTUnit::LoadFromASTFile(), clang::CompilerInstance::loadModule(), lookupCoroutineHandleType(), clang::Sema::lookupCoroutineTraits(), LookupMemberExpr(), lookupPromiseType(), LookupStdInitializerList(), LookupStdSourceLocationImpl(), and lookupStdTypeTraitMember().

◆ getIdentifierTable() [2/2]

const IdentifierTable & clang::Preprocessor::getIdentifierTable ( ) const

inline

Definition at line 1213 of file Preprocessor.h.

◆ getImmediateMacroName()

StringRef clang::Preprocessor::getImmediateMacroName ( SourceLocation Loc )

inline

Retrieve the name of the immediate macro expansion.

This routine starts from a source location, and finds the name of the macro responsible for its immediate expansion. It looks through any intervening macro argument expansions to compute this. It returns a StringRef that refers to the SourceManager-owned buffer of the source where that macro name is spelled. Thus, the result shouldn't out-live the SourceManager.

Definition at line 2153 of file Preprocessor.h.

References clang::Lexer::getImmediateMacroName(), getLangOpts(), and Loc.

Referenced by isExpandedFromConfigurationMacro(), lookThroughRangesV3Condition(), and ShouldDiagnoseAvailabilityInContext().

◆ getIncludedFiles() [1/2]

IncludedFilesSet & clang::Preprocessor::getIncludedFiles ( )

inline

Get the set of included files.

Definition at line 1504 of file Preprocessor.h.

◆ getIncludedFiles() [2/2]

const IncludedFilesSet & clang::Preprocessor::getIncludedFiles ( ) const

inline

Definition at line 1505 of file Preprocessor.h.

◆ GetIncludeFilenameSpelling()

bool Preprocessor::GetIncludeFilenameSpelling	(	SourceLocation	Loc,
		StringRef &	Buffer
	)

Turn the specified lexer token into a fully checked and spelled filename, e.g.

GetIncludeFilenameSpelling - Turn the specified lexer token into a fully checked and spelled filename, e.g.

as an operand of #include.

The caller is expected to provide a buffer that is large enough to hold the spelling of the filename, but is also expected to handle the case when this method decides to use a different buffer.

Returns: true if the input filename was in <>'s or false if it was in ""'s.

as an operand of #include. This returns true if the input filename was in <>'s or false if it were in ""'s. The caller is expected to provide a buffer that is large enough to hold the spelling of the filename, but is also expected to handle the case when this method decides to use a different buffer.

Definition at line 1855 of file PPDirectives.cpp.

References Diag(), and Loc.

Referenced by EvaluateHasIncludeCommon(), HandlePragmaDependency(), and HandlePragmaIncludeAlias().

◆ getLangOpts()

const LangOptions & clang::Preprocessor::getLangOpts ( ) const

inline

Definition at line 1205 of file Preprocessor.h.

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), clang::Sema::ActOnNumericConstant(), AddFunctionParameterChunks(), AddMacroResults(), clang::TokenConcatenation::AvoidConcat(), clang::FrontendAction::BeginSourceFile(), clang::CharLiteralParser::CharLiteralParser(), clang::Sema::checkLiteralOperatorId(), CheckMacroName(), clang::createChainedIncludesSource(), clang::DoPrintPreprocessedInput(), clang::DoRewriteTest(), EmitAlphaCounter(), emitMacroExpansionWarnings(), emitPremigrationErrors(), EnterSubmodule(), EvaluateDirectiveSubExpr(), EvaluateValue(), clang::DumpRawTokensAction::ExecuteAction(), FindLocsWithCommonFileID(), getCurrentModule(), getCurrentModuleImplementation(), clang::PCHGenerator::getEmittingModule(), getFallthroughAttrSpelling(), getHeaderToIncludeForDiagnostics(), getImmediateMacroName(), getIssueHash(), clang::Parser::getLangOpts(), clang::ASTWriter::getLangOpts(), getModuleForLocation(), HandleDirective(), HandleEndOfFile(), HandleIdentifier(), HandlePragmaOnce(), HasExtension(), HasFeature(), Initialize(), clang::InitializePreprocessor(), isExpandedFromConfigurationMacro(), isInImportingCXXNamedModules(), isInterestingIdentifier(), isMacroDefined(), isReservedCXXAttributeName(), LeaveSubmodule(), Lex(), clang::TokenLexer::Lex(), LexAfterModuleImport(), LexRawTokensFromMainFile(), clang::ASTUnit::LoadFromASTFile(), MaybeAddSentinel(), clang::IncrementalParser::Parse(), ParseAlignPragma(), parseSimpleIntegerLiteral(), PrintPreprocessedTokens(), clang::PCHValidator::ReadHeaderSearchOptions(), clang::PCHValidator::ReadLanguageOptions(), clang::PCHValidator::ReadPreprocessorOptions(), clang::SimpleASTReaderListener::ReadPreprocessorOptions(), clang::RewriteMacrosInInput(), shouldWarnOnMacroDef(), shouldWarnOnMacroUndef(), and clang::TokenConcatenation::TokenConcatenation().

◆ getLastCachedTokenLocation()

SourceLocation clang::Preprocessor::getLastCachedTokenLocation ( ) const

inline

Get the location of the last cached token, suitable for setting the end location of an annotation token.

Definition at line 1892 of file Preprocessor.h.

Referenced by IsPreviousCachedToken().

◆ getLastFPEvalPragmaLocation()

SourceLocation clang::Preprocessor::getLastFPEvalPragmaLocation ( ) const

inline

Definition at line 2369 of file Preprocessor.h.

Referenced by clang::Sema::ActOnPragmaFPValueChangingOption(), clang::Sema::DiagnoseUseOfDecl(), and clang::Sema::UsualUnaryConversions().

◆ getLastMacroWithSpelling()

StringRef Preprocessor::getLastMacroWithSpelling	(	SourceLocation	Loc,
		ArrayRef< TokenValue >	Tokens
	)		const

Return the name of the macro defined before Loc that has spelling Tokens.

If there are multiple macros with same spelling, return the last one defined.

Definition at line 357 of file Preprocessor.cpp.

References E, clang::MacroDirective::DefInfo::getLocation(), clang::MacroDirective::DefInfo::getMacroInfo(), clang::SourceManager::isBeforeInTranslationUnit(), clang::SourceLocation::isInvalid(), clang::MacroInfo::isObjectLike(), clang::SourceLocation::isValid(), Loc, macro_begin(), macro_end(), and MacroDefinitionEquals().

Referenced by DiagnoseCallingConvCast(), diagnoseMissingConstinit(), clang::SemaObjC::DiagnoseOwningPropertyGetterSynthesis(), and getFallthroughAttrSpelling().

◆ getLeafModuleMacros()

ArrayRef< ModuleMacro * > clang::Preprocessor::getLeafModuleMacros ( const IdentifierInfo * II ) const

inline

Get the list of leaf (non-overridden) module macros for a name.

Definition at line 1441 of file Preprocessor.h.

References clang::IdentifierInfo::isOutOfDate().

Referenced by indexPreprocessorModuleMacros().

◆ getLocalMacroDirective()

MacroDirective * clang::Preprocessor::getLocalMacroDirective ( const IdentifierInfo * II ) const

inline

Given an identifier, return its latest non-imported MacroDirective if it is #define'd and not #undef'd, or null if it isn't #define'd.

Definition at line 1387 of file Preprocessor.h.

References getLocalMacroDirectiveHistory(), and clang::IdentifierInfo::hasMacroDefinition().

◆ getLocalMacroDirectiveHistory()

MacroDirective * Preprocessor::getLocalMacroDirectiveHistory ( const IdentifierInfo * II ) const

Given an identifier, return the latest non-imported macro directive for that identifier.

One can iterate over all previous macro directives from the most recent one.

Definition at line 61 of file PPMacroExpansion.cpp.

References clang::IdentifierInfo::hadMacroDefinition().

Referenced by checkConfigMacro(), and getLocalMacroDirective().

◆ getLocForEndOfToken()

SourceLocation clang::Preprocessor::getLocForEndOfToken	(	SourceLocation	Loc,
		unsigned	Offset = `0`
	)

inline

Computes the source location just past the end of the token at this source location.

This routine can be used to produce a source location that points just past the end of the token referenced by Loc, and is generally used when a diagnostic needs to point just after a token where it expected something different that it received. If the returned source location would not be meaningful (e.g., if it points into a macro), this routine returns an invalid source location.

Parameters

Offset an offset from the end of the token, where the source location should refer to. The default offset (0) produces a source location pointing just past the end of the token; an offset of 1 produces a source location pointing to the last character in the token, etc.

Definition at line 2186 of file Preprocessor.h.

References clang::Lexer::getLocForEndOfToken(), and Loc.

Referenced by clang::Sema::CheckCompleteVariableDeclaration(), clang::Sema::DiagnoseCommaOperator(), EvaluateHasIncludeCommon(), GenerateNewArgTokens(), clang::Parser::getEndOfPreviousToken(), and clang::Parser::ParseConstraintLogicalAndExpression().

◆ getMacroAnnotations()

const MacroAnnotations & clang::Preprocessor::getMacroAnnotations ( const IdentifierInfo * II ) const

inline

Definition at line 2899 of file Preprocessor.h.

◆ getMacroDefinition()

MacroDefinition clang::Preprocessor::getMacroDefinition ( const IdentifierInfo * II )

inline

Definition at line 1357 of file Preprocessor.h.

References clang::IdentifierInfo::hasMacroDefinition().

Referenced by AddMacroResults(), EvaluateDefined(), getMacroInfo(), HandleIdentifier(), and isMacroDefined().

◆ getMacroDefinitionAtLoc()

MacroDefinition clang::Preprocessor::getMacroDefinitionAtLoc	(	const IdentifierInfo *	II,
		SourceLocation	Loc
	)

inline

Definition at line 1370 of file Preprocessor.h.

References clang::MacroDirective::DefInfo::getDirective(), getSourceManager(), clang::IdentifierInfo::hadMacroDefinition(), and Loc.

Referenced by isMacroDefined().

◆ getMacroInfo() [1/2]

MacroInfo * clang::Preprocessor::getMacroInfo ( const IdentifierInfo * II )

inline

Definition at line 1402 of file Preprocessor.h.

References getMacroDefinition(), and clang::IdentifierInfo::hasMacroDefinition().

◆ getMacroInfo() [2/2]

const MacroInfo * clang::Preprocessor::getMacroInfo ( const IdentifierInfo * II ) const

inline

Definition at line 1398 of file Preprocessor.h.

References getMacroInfo().

Referenced by checkConfigMacro(), clang::CodeCompletionResult::CreateCodeCompletionStringForMacro(), getMacroInfo(), clang::Sema::getPrintingPolicy(), HandleEndOfFile(), HandlePragmaPopMacro(), HandlePragmaPushMacro(), isTrivialSingleTokenExpansion(), and clang::ento::tryExpandAsInteger().

◆ getMaxTokens()

unsigned clang::Preprocessor::getMaxTokens ( ) const

inline

Get the max number of tokens before issuing a -Wmax-tokens warning.

Definition at line 1315 of file Preprocessor.h.

Referenced by clang::Parser::ParseTopLevelDecl().

◆ getMaxTokensOverrideLoc()

SourceLocation clang::Preprocessor::getMaxTokensOverrideLoc ( ) const

inline

Definition at line 1322 of file Preprocessor.h.

Referenced by clang::Parser::ParseTopLevelDecl().

◆ getModuleForLocation()

Module * Preprocessor::getModuleForLocation	(	SourceLocation	Loc,
		bool	AllowTextual
	)

Find the module that owns the source or header file that Loc points to.

If the location is in a file that was included into a module, or is outside any module, returns nullptr.

Definition at line 882 of file PPDirectives.cpp.

References clang::LangOptions::CurrentModule, clang::ModuleMap::findModuleForHeader(), clang::SourceManager::getExpansionLoc(), clang::SourceManager::getFileEntryRefForID(), clang::SourceManager::getFileID(), getLangOpts(), clang::ModuleMap::KnownHeader::getModule(), clang::HeaderSearch::getModuleMap(), clang::SourceManager::isInMainFile(), Loc, and clang::HeaderSearch::lookupModule().

Referenced by getHeaderToIncludeForDiagnostics(), and LookupFile().

◆ getModuleImportLoc()

SourceLocation clang::Preprocessor::getModuleImportLoc ( Module * M ) const

inline

Definition at line 1760 of file Preprocessor.h.

◆ getModuleLoader()

ModuleLoader & clang::Preprocessor::getModuleLoader ( ) const

inline

Retrieve the module loader associated with this preprocessor.

Definition at line 1227 of file Preprocessor.h.

Referenced by clang::SemaCodeCompletion::CodeCompleteModuleImport(), clang::Sema::getModuleLoader(), and clang::PCHGenerator::HandleTranslationUnit().

◆ getModuleMacro()

ModuleMacro * Preprocessor::getModuleMacro	(	Module *	Mod,
		const IdentifierInfo *	II
	)

Definition at line 169 of file PPMacroExpansion.cpp.

References clang::ModuleMacro::Profile().

◆ getNamedModuleName()

StringRef clang::Preprocessor::getNamedModuleName ( ) const

inline

Get the named module name we're preprocessing.

Requires we're preprocessing a named module.

Definition at line 2409 of file Preprocessor.h.

◆ getNumDirectives()

unsigned clang::Preprocessor::getNumDirectives ( ) const

inline

Retrieve the number of Directives that have been processed by the Preprocessor.

Definition at line 1235 of file Preprocessor.h.

◆ getPPCallbacks()

PPCallbacks * clang::Preprocessor::getPPCallbacks ( ) const

inline

Accessors for preprocessor callbacks.

Note that this class takes ownership of any PPCallbacks object given to it.

Definition at line 1302 of file Preprocessor.h.

Referenced by EvaluateDefined(), and EvaluateHasIncludeCommon().

◆ getPragmaARCCFCodeAuditedInfo()

std::pair< IdentifierInfo *, SourceLocation > clang::Preprocessor::getPragmaARCCFCodeAuditedInfo ( ) const

inline

The location of the currently-active #pragma clang arc_cf_code_audited begin.

Returns an invalid location if there is no such pragma active.

Definition at line 2003 of file Preprocessor.h.

Referenced by clang::SemaObjC::AddCFAuditedAttribute().

◆ getPragmaAssumeNonNullLoc()

SourceLocation clang::Preprocessor::getPragmaAssumeNonNullLoc ( ) const

inline

The location of the currently-active #pragma clang assume_nonnull begin.

Returns an invalid location if there is no such pragma active.

Definition at line 2018 of file Preprocessor.h.

Referenced by GetFullTypeForDeclarator().

◆ getPragmasEnabled()

bool clang::Preprocessor::getPragmasEnabled ( ) const

inline

Definition at line 1253 of file Preprocessor.h.

◆ getPreambleConditionalStack()

ArrayRef< PPConditionalInfo > clang::Preprocessor::getPreambleConditionalStack ( ) const

inline

Definition at line 2821 of file Preprocessor.h.

◆ getPreambleRecordedPragmaAssumeNonNullLoc()

SourceLocation clang::Preprocessor::getPreambleRecordedPragmaAssumeNonNullLoc ( ) const

inline

Get the location of the recorded unterminated #pragma clang assume_nonnull begin in the preamble, if one exists.

Returns an invalid location if the premable did not end with such a pragma active or if there is no recorded preamble.

Definition at line 2033 of file Preprocessor.h.

◆ getPreambleSkipInfo()

std::optional< PreambleSkipInfo > clang::Preprocessor::getPreambleSkipInfo ( ) const

inline

Definition at line 2836 of file Preprocessor.h.

◆ getPredefines()

const std::string & clang::Preprocessor::getPredefines ( ) const

inline

Get the predefines for this processor.

Used by some third-party tools to inspect and add predefines (see https://github.com/llvm/llvm-project/issues/57483).

Definition at line 1516 of file Preprocessor.h.

◆ getPredefinesFileID()

FileID clang::Preprocessor::getPredefinesFileID ( ) const

inline

Returns the FileID for the preprocessor predefines.

Definition at line 1295 of file Preprocessor.h.

Referenced by checkConfigMacro(), HandleDirective(), HandleEndOfFile(), clang::RewriteIncludesInInput(), shouldIgnoreMacro(), and SkipTokensWhileUsingPCH().

◆ getPreprocessingRecord()

PreprocessingRecord * clang::Preprocessor::getPreprocessingRecord ( ) const

inline

Retrieve the preprocessing record, or NULL if there is no preprocessing record.

Definition at line 1611 of file Preprocessor.h.

Referenced by clang::ASTUnit::getLocalPreprocessingEntities().

◆ getPreprocessorAllocator()

llvm::BumpPtrAllocator & clang::Preprocessor::getPreprocessorAllocator ( )

inline

Definition at line 1216 of file Preprocessor.h.

Referenced by clang::ModuleMacro::create(), ParseAlignPragma(), and ParseLoopHintValue().

◆ getPreprocessorOpts()

PreprocessorOptions & clang::Preprocessor::getPreprocessorOpts ( ) const

inline

Retrieve the preprocessor options used to initialize this preprocessor.

Definition at line 1200 of file Preprocessor.h.

Referenced by ComputeDATE_TIME(), EnterSourceFile(), clang::InitializePreprocessor(), clang::PCHValidator::ReadHeaderSearchOptions(), clang::PCHValidator::ReadPreprocessorOptions(), and clang::SimpleASTReaderListener::ReadPreprocessorOptions().

◆ getRawToken()

bool clang::Preprocessor::getRawToken	(	SourceLocation	Loc,
		Token &	Result,
		bool	IgnoreWhiteSpace = `false`
	)

inline

Relex the token at the specified location.

Returns: true if there was a failure, false on success.

Definition at line 2121 of file Preprocessor.h.

References clang::Lexer::getRawToken(), Loc, and clang::Result.

Referenced by UseNSOptionsMacro().

◆ getSelectorTable()

SelectorTable & clang::Preprocessor::getSelectorTable ( )

inline

Definition at line 1214 of file Preprocessor.h.

Referenced by clang::SemaObjC::ActOnClassPropertyRefExpr(), clang::CompilerInstance::createASTContext(), clang::SemaObjC::HandleExprPropertyRefExpr(), clang::ASTUnit::LoadFromASTFile(), and LookupMemberExpr().

◆ getSourceManager()

SourceManager & clang::Preprocessor::getSourceManager ( ) const

inline

Definition at line 1209 of file Preprocessor.h.

Referenced by clang::Sema::ActOnNumericConstant(), AddFunctionParameterChunks(), clang::ModuleDependencyCollector::attachToPreprocessor(), clang::TokenConcatenation::AvoidConcat(), clang::VerifyDiagnosticConsumer::BeginSourceFile(), clang::CharLiteralParser::CharLiteralParser(), checkConfigMacro(), clang::Lexer::Create_PragmaLexer(), clang::CompilerInstance::createASTContext(), createPreprocessingRecord(), clang::DoPrintPreprocessedInput(), clang::DoRewriteTest(), emitPremigrationErrors(), EnterSourceFile(), EvaluateDefined(), EvaluateValue(), clang::PrintDependencyDirectivesSourceMinimizerAction::ExecuteAction(), clang::DumpRawTokensAction::ExecuteAction(), FindLocsWithCommonFileID(), clang::PreprocessorLexer::getFileEntry(), GetFirstChar(), getHeaderToIncludeForDiagnostics(), getIssueHash(), getMacroDefinitionAtLoc(), GetMappedTokenLoc(), clang::ASTWriter::getRawSourceLocationEncoding(), clang::VerifyDiagnosticConsumer::HandleComment(), clang::TokenLexer::Init(), isExpandedFromConfigurationMacro(), IsPreviousCachedToken(), clang::TokenLexer::Lex(), LexRawTokensFromMainFile(), parseSimpleIntegerLiteral(), clang::PreprocessorLexer::PreprocessorLexer(), ReadLineMarkerFlags(), clang::MacroExpansionContext::registerForPreprocessor(), clang::RewriteIncludesInInput(), clang::RewriteMacrosInInput(), clang::CodeGen::CoverageMappingModuleGen::setUpCoverageCallbacks(), shouldIgnoreMacro(), SplitToken(), and clang::syntax::TokenCollector::TokenCollector().

◆ getSpelling() [1/4]

std::string clang::Preprocessor::getSpelling	(	const Token &	Tok,
		bool *	Invalid = `nullptr`
	)		const

inline

Return the 'spelling' of the Tok token.

The spelling of a token is the characters used to represent the token in the source file after trigraph expansion and escaped-newline folding. In particular, this wants to get the true, uncanonicalized, spelling of things like digraphs, UCNs, etc.

Parameters

Invalid If non-null, will be set true if an error occurs.

Definition at line 2090 of file Preprocessor.h.

References clang::Lexer::getSpelling(), and clang::Invalid.

◆ getSpelling() [2/4]

unsigned clang::Preprocessor::getSpelling	(	const Token &	Tok,
		const char *&	Buffer,
		bool *	Invalid = `nullptr`
	)		const

inline

Get the spelling of a token into a preallocated buffer, instead of as an std::string.

The caller is required to allocate enough space for the token, which is guaranteed to be at least Tok.getLength() bytes long. The length of the actual result is returned.

Note that this method may do two possible things: it may either fill in the buffer specified with characters, or it may change the input pointer to point to a constant buffer with the data already in it (avoiding a copy). The caller is not allowed to modify the returned buffer pointer if an internal buffer is returned.

Definition at line 2106 of file Preprocessor.h.

References clang::Lexer::getSpelling(), and clang::Invalid.

◆ getSpelling() [3/4]

StringRef Preprocessor::getSpelling	(	const Token &	Tok,
		SmallVectorImpl< char > &	Buffer,
		bool *	Invalid = `nullptr`
	)		const

Get the spelling of a token into a SmallVector.

getSpelling - This method is used to get the spelling of a token into a SmallVector.

Note that the returned StringRef may not point to the supplied buffer if a copy can be avoided.

Definition at line 466 of file Preprocessor.cpp.

References clang::Token::getIdentifierInfo(), clang::Token::getLength(), getSpelling(), clang::Token::hasUCN(), clang::Invalid, clang::Token::isNot(), and clang::Token::needsCleaning().

◆ getSpelling() [4/4]

StringRef clang::Preprocessor::getSpelling	(	SourceLocation	loc,
		SmallVectorImpl< char > &	buffer,
		bool *	invalid = `nullptr`
	)		const

inline

Return the 'spelling' of the token at the given location; does not go up to the spelling location or down to the expansion location.

Parameters

buffer	A buffer which will be used only if the token requires "cleaning", e.g. if it contains trigraphs or escaped newlines
invalid	If non-null, will be set `true` if an error occurs.

Definition at line 2076 of file Preprocessor.h.

References clang::Lexer::getSpelling().

Referenced by clang::Sema::ActOnCharacterConstant(), clang::Sema::ActOnNumericConstant(), buildMSAsmString(), clang::DoRewriteTest(), DumpToken(), dumpTokenInto(), EvaluateHasIncludeCommon(), EvaluateValue(), GetFirstChar(), GetLineValue(), getSpelling(), HandlePragmaDependency(), HandlePragmaIncludeAlias(), clang::MacroInfo::isIdenticalTo(), isMapModifier(), isMapType(), LexHeaderName(), LookUpIdentifierInfo(), parseOpenMPAllocateClauseModifiers(), clang::Parser::ParseOpenMPVarList(), ParsePragmaPushOrPopMacro(), parseSimpleIntegerLiteral(), PrintMacroDefinition(), PrintPreprocessedTokens(), clang::RewriteMacrosInInput(), and clang::MacroArgs::StringifyArgument().

◆ getSpellingOfSingleCharacterNumericConstant()

uint8_t clang::Preprocessor::getSpellingOfSingleCharacterNumericConstant	(	const Token &	Tok,
		bool *	Invalid = `nullptr`
	)		const

inline

Given a Token Tok that is a numeric constant with length 1, return the value of constant as an unsigned 8-bit integer.

Definition at line 2129 of file Preprocessor.h.

References D, clang::Token::getKind(), clang::Token::getLength(), clang::Token::getLiteralData(), clang::Token::getLocation(), clang::Invalid, clang::Token::is(), and clang::Token::needsCleaning().

Referenced by clang::Sema::ActOnNumericConstant().

◆ GetSuppressIncludeNotFoundError()

bool clang::Preprocessor::GetSuppressIncludeNotFoundError ( )

inline

Definition at line 1259 of file Preprocessor.h.

◆ getTargetInfo()

const TargetInfo & clang::Preprocessor::getTargetInfo ( ) const

inline

Definition at line 1206 of file Preprocessor.h.

Referenced by clang::Sema::ActOnNumericConstant(), clang::CharLiteralParser::CharLiteralParser(), EvaluateValue(), clang::Parser::getTargetInfo(), Initialize(), clang::InitializePreprocessor(), isReservedCXXAttributeName(), parseSimpleIntegerLiteral(), and clang::PCHValidator::ReadTargetOptions().

◆ getTokenCount()

unsigned clang::Preprocessor::getTokenCount ( ) const

inline

Get the number of tokens processed so far.

Definition at line 1312 of file Preprocessor.h.

Referenced by clang::Parser::ParseTopLevelDecl().

◆ getTotalMemory()

size_t Preprocessor::getTotalMemory ( ) const

Definition at line 327 of file Preprocessor.cpp.

Referenced by PrintStats().

◆ getTUFPEvalMethod()

LangOptions::FPEvalMethodKind clang::Preprocessor::getTUFPEvalMethod ( ) const

inline

Definition at line 2365 of file Preprocessor.h.

◆ hadModuleLoaderFatalFailure()

bool clang::Preprocessor::hadModuleLoaderFatalFailure ( ) const

inline

Definition at line 1229 of file Preprocessor.h.

References clang::ModuleLoader::HadFatalFailure.

◆ HandleComment()

bool Preprocessor::HandleComment	(	Token &	result,
		SourceRange	Comment
	)

Definition at line 1426 of file Preprocessor.cpp.

References getCommentRetentionState(), and Lex().

◆ HandleDirective()

void Preprocessor::HandleDirective ( Token & Result )

Callback invoked when the lexer sees a # token at the start of a line.

HandleDirective - This callback is invoked when the lexer sees a # token at the start of a line.

This consumes the directive, modifies the lexer/preprocessor state, and advances the lexer(s) so that the next token read is the correct one.

Definition at line 1221 of file PPDirectives.cpp.

References clang::CodeCompletionHandler::CodeCompleteDirective(), Diag(), DiscardUntilEndOfDirective(), clang::PreprocessorLexer::getConditionalStackDepth(), getCurrentFileLexer(), clang::SourceManager::getFileID(), clang::MultipleIncludeOpt::getHasReadAnyTokensVal(), clang::Token::getIdentifierInfo(), clang::MultipleIncludeOpt::getImmediatelyAfterTopLevelIfndef(), getLangOpts(), clang::Token::getLocation(), clang::IdentifierInfo::getPPKeywordID(), getPredefinesFileID(), HandleSkippedDirectiveWhileUsingPCH(), LexUnexpandedToken(), clang::PreprocessorLexer::MIOpt, clang::PreprocessorLexer::ParsingPreprocessorDirective, clang::PIK_HashPragma, clang::MultipleIncludeOpt::resetImmediatelyAfterTopLevelIfndef(), clang::Result, setCodeCompletionReached(), and clang::MultipleIncludeOpt::SetReadToken().

◆ HandleEndOfFile()

bool Preprocessor::HandleEndOfFile	(	Token &	Result,
		bool	isEndOfMacro = `false`
	)

Callback invoked when the lexer hits the end of the current file.

HandleEndOfFile - This callback is invoked when the lexer hits the end of the current file.

This either returns the EOF token and returns true, or pops a level off the include stack and returns false, at which point the client should call lex again.

This either returns the EOF token or pops a level off the include stack and keeps going.

Definition at line 331 of file PPLexerChange.cpp.

References collectAllSubModulesWithUmbrellaHeader(), clang::FixItHint::CreateReplacement(), creatingPCHWithThroughHeader(), Diag(), E, clang::PPCallbacks::ExitFile, clang::MultipleIncludeOpt::GetControllingMacroAtEndOfFile(), getCurrentModule(), clang::MultipleIncludeOpt::GetDefinedLocation(), clang::MultipleIncludeOpt::GetDefinedMacro(), clang::SourceManager::getFileCharacteristic(), clang::PreprocessorLexer::getFileEntry(), clang::SourceManager::getFileEntryForID(), clang::PreprocessorLexer::getFileID(), clang::SourceManager::getIncludeLoc(), clang::PreprocessorLexer::getInitialNumSLocEntries(), getLangOpts(), clang::SourceManager::getLocForStartOfFile(), getMacroInfo(), clang::MultipleIncludeOpt::GetMacroLocation(), getPredefinesFileID(), clang::PreprocessorLexer::getSourceLocation(), isCodeCompletionEnabled(), isIncrementalProcessingEnabled(), isInPrimaryFile(), isMacroDefined(), isPCHThroughHeader(), isPPInSafeBufferOptOutRegion(), isRecordingPreamble(), clang::FileID::isValid(), clang::SourceLocation::isValid(), LeaveSubmodule(), Loc, clang::SourceManager::local_sloc_entry_size(), clang::PreprocessorLexer::MIOpt, recomputeCurLexerKind(), RemoveTopOfLexerStack(), clang::Result, clang::HeaderSearch::SetFileControllingMacro(), clang::SourceManager::setNumCreatedFIDsForFileID(), clang::TU_Complete, and TUKind.

Referenced by HandleEndOfTokenLexer().

◆ HandleEndOfTokenLexer()

bool Preprocessor::HandleEndOfTokenLexer ( Token & Result )

Callback invoked when the current TokenLexer hits the end of its token stream.

HandleEndOfTokenLexer - This callback is invoked when the current TokenLexer hits the end of its token stream.

Definition at line 600 of file PPLexerChange.cpp.

References HandleEndOfFile(), and clang::Result.

Referenced by HandleMicrosoftCommentPaste(), and clang::TokenLexer::Lex().

◆ HandleIdentifier()

bool Preprocessor::HandleIdentifier ( Token & Identifier )

Callback invoked when the lexer reads an identifier and has filled in the tokens IdentifierInfo member.

HandleIdentifier - This callback is invoked when the lexer reads an identifier.

This callback potentially macro expands it or turns it into a named token (like 'for').

Returns: true if we actually computed a token, false if we need to lex again.

This callback looks up the identifier in the map and/or potentially macro expands it or turns it into a named token (like 'for').

Note that callers of this method are guarded by checking the IdentifierInfo's 'isHandleIdentifierCase' bit. If this method changes, the IdentifierInfo methods that compute these properties will need to change to match.

Definition at line 773 of file Preprocessor.cpp.

Referenced by clang::TokenLexer::Lex().

◆ HandleMicrosoftCommentPaste()

void Preprocessor::HandleMicrosoftCommentPaste ( Token & Tok )

When the macro expander pastes together a comment (/##/) in Microsoft mode, this method handles updating the current state, returning the token on the next source line.

HandleMicrosoftCommentPaste - When the macro expander pastes together a comment (/##/) in microsoft mode, this method handles updating the current state, returning the token on the next source line.

Definition at line 638 of file PPLexerChange.cpp.

References HandleEndOfTokenLexer(), clang::Token::is(), clang::Token::isNot(), Lex(), clang::PreprocessorLexer::LexingRawMode, and clang::PreprocessorLexer::ParsingPreprocessorDirective.

◆ HandlePoisonedIdentifier()

void Preprocessor::HandlePoisonedIdentifier ( Token & Identifier )

Display reason for poisoned identifier.

Definition at line 749 of file Preprocessor.cpp.

References Diag(), and Identifier.

Referenced by HandleIdentifier(), clang::TokenLexer::Lex(), and MaybeHandlePoisonedIdentifier().

◆ HandlePragmaDependency()

void Preprocessor::HandlePragmaDependency ( Token & DependencyTok )

HandlePragmaDependency - Handle #pragma GCC dependency "foo" blah.

Definition at line 512 of file Pragma.cpp.

References Diag(), clang::File, Filename, getCurrentFileLexer(), clang::PreprocessorLexer::getFileEntry(), GetIncludeFilenameSpelling(), clang::Token::getLocation(), clang::FileEntryRef::getModificationTime(), getSpelling(), clang::Invalid, clang::Token::isNot(), Lex(), LexHeaderName(), and LookupFile().

◆ HandlePragmaHdrstop()

void Preprocessor::HandlePragmaHdrstop ( Token & Tok )

Definition at line 877 of file Pragma.cpp.

References creatingPCHWithPragmaHdrStop(), Diag(), clang::FileName, clang::Token::getLocation(), clang::Token::is(), clang::SourceManager::isInMainFile(), clang::Token::isNot(), Lex(), LexStringLiteral(), clang::Result, and usingPCHWithPragmaHdrStop().

Referenced by HandleSkippedDirectiveWhileUsingPCH().

◆ HandlePragmaIncludeAlias()

void Preprocessor::HandlePragmaIncludeAlias ( Token & Tok )

Definition at line 681 of file Pragma.cpp.

References clang::HeaderSearch::AddIncludeAlias(), Diag(), getHeaderSearchInfo(), GetIncludeFilenameSpelling(), clang::Token::getLocation(), getSpelling(), clang::Token::is(), clang::Token::isNot(), Lex(), and LexHeaderName().

◆ HandlePragmaMark()

void Preprocessor::HandlePragmaMark ( Token & MarkTok )

Definition at line 428 of file Pragma.cpp.

References clang::Token::getLocation().

◆ HandlePragmaModuleBuild()

void Preprocessor::HandlePragmaModuleBuild ( Token & Tok )

Definition at line 803 of file Pragma.cpp.

References clang::ModuleLoader::createModuleFromSource(), Diag(), DiscardUntilEndOfDirective(), clang::Token::getKind(), clang::Token::getLocation(), clang::IdentifierInfo::getName(), clang::Token::getRawIdentifier(), clang::Token::is(), clang::Token::isAtStartOfLine(), clang::Token::isNot(), LexModuleNameComponent(), LexUnexpandedToken(), and Loc.

◆ HandlePragmaOnce()

void Preprocessor::HandlePragmaOnce ( Token & OnceTok )

HandlePragmaOnce - Handle #pragma once. OnceTok is the 'once'.

Definition at line 413 of file Pragma.cpp.

References Diag(), getCurrentFileLexer(), getLangOpts(), isInPrimaryFile(), clang::HeaderSearch::MarkFileIncludeOnce(), clang::TU_Prefix, and TUKind.

◆ HandlePragmaPoison()

void Preprocessor::HandlePragmaPoison ( )

HandlePragmaPoison - Handle #pragma GCC poison. PoisonTok is the 'poison'.

Definition at line 438 of file Pragma.cpp.

References Diag(), clang::Token::is(), clang::IdentifierInfo::isFromAST(), isMacroDefined(), clang::Token::isNot(), clang::IdentifierInfo::isPoisoned(), clang::PreprocessorLexer::LexingRawMode, LexUnexpandedToken(), LookUpIdentifierInfo(), clang::IdentifierInfo::setChangedSinceDeserialization(), and clang::IdentifierInfo::setIsPoisoned().

◆ HandlePragmaPopMacro()

void Preprocessor::HandlePragmaPopMacro ( Token & PopMacroTok )

Handle #pragma pop_macro.

The syntax is:

#pragma pop_macro("macro")

Definition at line 646 of file Pragma.cpp.

References appendDefMacroDirective(), appendMacroDirective(), Diag(), clang::Token::getLocation(), getMacroInfo(), clang::IdentifierInfo::getName(), and ParsePragmaPushOrPopMacro().

◆ HandlePragmaPushMacro()

void Preprocessor::HandlePragmaPushMacro ( Token & PushMacroTok )

Handle #pragma push_macro.

The syntax is:

#pragma push_macro("macro")

Definition at line 623 of file Pragma.cpp.

References getMacroInfo(), ParsePragmaPushOrPopMacro(), and clang::MacroInfo::setIsAllowRedefinitionsWithoutWarning().

◆ HandlePragmaSystemHeader()

void Preprocessor::HandlePragmaSystemHeader ( Token & SysHeaderTok )

HandlePragmaSystemHeader - Implement #pragma GCC system_header.

We know that the whole directive has been parsed.

Definition at line 480 of file Pragma.cpp.

References clang::SourceManager::AddLineNote(), clang::SrcMgr::C_System, Diag(), getCurrentFileLexer(), clang::PreprocessorLexer::getFileEntry(), clang::PresumedLoc::getFilename(), clang::PresumedLoc::getLine(), clang::SourceManager::getLineTableFilenameID(), clang::Token::getLocation(), clang::SourceManager::getPresumedLoc(), isInPrimaryFile(), clang::PresumedLoc::isInvalid(), clang::HeaderSearch::MarkFileSystemHeader(), and clang::PPCallbacks::SystemHeaderPragma.

◆ HandleSkippedDirectiveWhileUsingPCH()

void Preprocessor::HandleSkippedDirectiveWhileUsingPCH	(	Token &	Result,
		SourceLocation	HashLoc
	)

Process directives while skipping until the through header or #pragma hdrstop is found.

Process a directive while looking for the through header or a #pragma hdrstop.

The following directives are handled: #include (to check if it is the through header) #define (to warn about macros that don't match the PCH) #pragma (to check for pragma hdrstop). All other directives are completely discarded.

Definition at line 1196 of file PPDirectives.cpp.

References DiscardUntilEndOfDirective(), HandlePragmaHdrstop(), Lex(), and clang::Result.

Referenced by HandleDirective().

◆ hasRecordedPreamble()

bool clang::Preprocessor::hasRecordedPreamble ( ) const

inline

Definition at line 2817 of file Preprocessor.h.

◆ IgnorePragmas()

void Preprocessor::IgnorePragmas ( )

Install empty handlers for all pragmas (making them ignored).

Ignore all pragmas, useful for modes such as -Eonly which would otherwise warn about those pragmas being unknown.

Definition at line 2193 of file Pragma.cpp.

References AddPragmaHandler().

Referenced by DoPrintMacros(), clang::PreprocessOnlyAction::ExecuteAction(), and clang::RewriteIncludesInInput().

◆ IncrementPasteCounter()

void clang::Preprocessor::IncrementPasteCounter ( bool isFast )

inline

Increment the counters for the number of token paste operations performed.

If fast was specified, this is a 'fast paste' case we handled.

Definition at line 2228 of file Preprocessor.h.

◆ Initialize()

void Preprocessor::Initialize	(	const TargetInfo &	Target,
		const TargetInfo *	AuxTarget = `nullptr`
	)

Initialize the preprocessor using information about the target.

Parameters

Target	is owned by the caller and must remain valid for the lifetime of the preprocessor.
AuxTarget	is owned by the caller and must remain valid for the lifetime of the preprocessor.

Definition at line 189 of file Preprocessor.cpp.

References clang::IdentifierTable::AddKeywords(), clang::LangOptionsBase::FEM_UnsetOnCommandLine, getLangOpts(), getTargetInfo(), setCurrentFPEvalMethod(), clang::HeaderSearch::setTarget(), and setTUFPEvalMethod().

◆ InitializeForModelFile()

void Preprocessor::InitializeForModelFile ( )

Initialize the preprocessor to parse a model file.

To parse model files the preprocessor of the original source is reused to preserver the identifier table. However to avoid some duplicate information in the preprocessor some cleanup is needed before it is used to parse model files. This method does that cleanup.

Definition at line 217 of file Preprocessor.cpp.

◆ isAtEndOfMacroExpansion()

bool clang::Preprocessor::isAtEndOfMacroExpansion	(	SourceLocation	loc,
		SourceLocation *	MacroEnd = `nullptr`
	)		const

inline

Returns true if the given MacroID location points at the last token of the macro expansion.

Parameters

MacroEnd If non-null and function returns true, it is set to end location of the macro.

Definition at line 2206 of file Preprocessor.h.

References clang::Lexer::isAtEndOfMacroExpansion().

◆ isAtStartOfMacroExpansion()

bool clang::Preprocessor::isAtStartOfMacroExpansion	(	SourceLocation	loc,
		SourceLocation *	MacroBegin = `nullptr`
	)		const

inline

Returns true if the given MacroID location points at the first token of the macro expansion.

Parameters

MacroBegin If non-null and function returns true, it is set to begin location of the macro.

Definition at line 2195 of file Preprocessor.h.

References clang::Lexer::isAtStartOfMacroExpansion().

◆ isBacktrackEnabled()

bool clang::Preprocessor::isBacktrackEnabled ( ) const

inline

True if EnableBacktrackAtThisPos() was called and caching of tokens is on.

Definition at line 1734 of file Preprocessor.h.

Referenced by AnnotateCachedTokens(), Backtrack(), CommitBacktrackedTokens(), ReplaceLastTokenWithAnnotation(), RevertCachedTokens(), TypoCorrectToken(), and ~Preprocessor().

◆ isCodeCompletionEnabled()

bool clang::Preprocessor::isCodeCompletionEnabled ( ) const

inline

Determine if we are performing code completion.

Definition at line 1970 of file Preprocessor.h.

Referenced by clang::Sema::ActOnBlockStmtExpr(), clang::Sema::ActOnEndOfTranslationUnit(), clang::Sema::ActOnFinishFunctionBody(), EnterSourceFile(), HandleEndOfFile(), clang::Parser::Parser(), and setCodeCompletionReached().

◆ isCodeCompletionReached()

bool clang::Preprocessor::isCodeCompletionReached ( ) const

inline

Returns true if code-completion is enabled and we have hit the code-completion point.

Definition at line 1988 of file Preprocessor.h.

Referenced by ProduceSignatureHelp().

◆ isCurrentLexer()

bool clang::Preprocessor::isCurrentLexer ( const PreprocessorLexer * L ) const

inline

Return true if we are lexing directly from the specified lexer.

Definition at line 1274 of file Preprocessor.h.

◆ isIncrementalProcessingEnabled()

bool clang::Preprocessor::isIncrementalProcessingEnabled ( ) const

inline

Returns true if incremental processing is enabled.

Definition at line 1945 of file Preprocessor.h.

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), clang::Sema::ActOnPopScope(), HandleEndOfFile(), and clang::IncrementalParser::Parse().

◆ isInImplementationUnit()

bool clang::Preprocessor::isInImplementationUnit ( ) const

inline

If we are implementing an implementation module unit.

Note that the module implementation partition is not considered as an implementation unit.

Definition at line 2414 of file Preprocessor.h.

◆ isInImportingCXXNamedModules()

bool clang::Preprocessor::isInImportingCXXNamedModules ( ) const

inline

If we're importing a standard C++20 Named Modules.

Definition at line 2419 of file Preprocessor.h.

References getLangOpts().

Referenced by LexAfterModuleImport(), and clang::tooling::dependencies::ModuleDepCollectorPP::moduleImport().

◆ isInNamedInterfaceUnit()

bool clang::Preprocessor::isInNamedInterfaceUnit ( ) const

inline

If we are proprocessing a named interface unit.

Note that a module implementation partition is not considered as an named interface unit here although it is importable to ease the parsing.

Definition at line 2403 of file Preprocessor.h.

◆ isInNamedModule()

bool clang::Preprocessor::isInNamedModule ( ) const

inline

If we are preprocessing a named module.

Definition at line 2397 of file Preprocessor.h.

◆ isInPrimaryFile()

bool Preprocessor::isInPrimaryFile ( ) const

Return true if we're in the top-level file, not in a #include.

isInPrimaryFile - Return true if we're in the top-level file, not in a #include.

This looks through macro expansions and active _Pragma lexers.

Definition at line 34 of file PPLexerChange.cpp.

Referenced by HandleEndOfFile(), HandlePragmaOnce(), and HandlePragmaSystemHeader().

◆ isMacroDefined() [1/2]

bool clang::Preprocessor::isMacroDefined ( const IdentifierInfo * II )

inline

Definition at line 1336 of file Preprocessor.h.

References bool, getLangOpts(), getMacroDefinition(), and clang::IdentifierInfo::hasMacroDefinition().

◆ isMacroDefined() [2/2]

bool clang::Preprocessor::isMacroDefined ( StringRef Id )

inline

Definition at line 1333 of file Preprocessor.h.

References clang::IdentifierTable::get(), Id, and isMacroDefined().

Referenced by AddOrdinaryNameResults(), clang::Sema::CheckPtrComparisonWithNullChar(), clang::SemaCodeCompletion::CodeCompleteObjCPassingType(), clang::Sema::DiagnoseSentinelCalls(), diagnoseXorMisusedAsPow(), DoEmitAvailabilityWarning(), clang::arcmt::trans::getNilString(), HandleEndOfFile(), HandlePragmaPoison(), InsertOCLBuiltinDeclarationsFromTable(), isMacroDefined(), MaybeAddSentinel(), and clang::HeaderSearch::ShouldEnterIncludeFile().

◆ isMacroDefinedInLocalModule()

bool clang::Preprocessor::isMacroDefinedInLocalModule	(	const IdentifierInfo *	II,
		Module *	M
	)

inline

Determine whether II is defined as a macro within the module M, if that is a module that we've already preprocessed.

Does not check for macros imported into M.

Definition at line 1344 of file Preprocessor.h.

References clang::IdentifierInfo::hasMacroDefinition().

Referenced by clang::HeaderSearch::ShouldEnterIncludeFile().

◆ isNextPPTokenLParen()

bool Preprocessor::isNextPPTokenLParen ( )

Determine whether the next preprocessor token to be lexed is a '('.

isNextPPTokenLParen - Determine whether the next preprocessor token to be lexed is a '('.

If so, consume the token and return true, if not, this method should have no observable side-effect on the lexed tokens.

Definition at line 424 of file PPMacroExpansion.cpp.

Referenced by HandleIdentifier(), and isReservedCXXAttributeName().

◆ isParsingIfOrElifDirective()

bool clang::Preprocessor::isParsingIfOrElifDirective ( ) const

inline

True if we are currently preprocessing a if or #elif directive.

Definition at line 1240 of file Preprocessor.h.

Referenced by EvaluateHasIncludeCommon().

◆ isPCHThroughHeader()

bool Preprocessor::isPCHThroughHeader ( const FileEntry * FE )

Returns true if the FileEntry is the PCH through header.

Definition at line 610 of file Preprocessor.cpp.

References clang::SourceManager::getFileEntryForID(), and clang::FileID::isValid().

Referenced by HandleEndOfFile().

◆ isPPInSafeBufferOptOutRegion() [1/2]

bool Preprocessor::isPPInSafeBufferOptOutRegion ( )

Returns: true iff this PP is currently in a "-Wunsafe-buffer-usage" opt-out region

Definition at line 1578 of file Preprocessor.cpp.

Referenced by enterOrExitSafeBufferOptOutRegion(), and HandleEndOfFile().

◆ isPPInSafeBufferOptOutRegion() [2/2]

bool Preprocessor::isPPInSafeBufferOptOutRegion ( SourceLocation & StartLoc )

Parameters

StartLoc output argument. It will be set to the start location of the current "-Wunsafe-buffer-usage" opt-out region iff this function returns true.

Returns: true iff this PP is currently in a "-Wunsafe-buffer-usage" opt-out region

Definition at line 1581 of file Preprocessor.cpp.

◆ isPreprocessedOutput()

bool clang::Preprocessor::isPreprocessedOutput ( ) const

inline

Returns true if the preprocessor is responsible for generating output, false if it is producing tokens to be consumed by Parse and Sema.

Definition at line 1271 of file Preprocessor.h.

◆ IsPreviousCachedToken()

bool Preprocessor::IsPreviousCachedToken ( const Token & Tok ) const

Whether Tok is the most recent token (CachedLexPos - 1) in CachedTokens.

Definition at line 171 of file PPCaching.cpp.

References clang::Token::getKind(), getLastCachedTokenLocation(), clang::Token::getLocation(), and getSourceManager().

◆ isRecordingPreamble()

bool clang::Preprocessor::isRecordingPreamble ( ) const

inline

Definition at line 2813 of file Preprocessor.h.

Referenced by HandleEndOfFile().

◆ isSafeBufferOptOut()

bool Preprocessor::isSafeBufferOptOut	(	const SourceManager &	SourceMgr,
		const SourceLocation &	Loc
	)		const

Returns: true iff the given Loc is in a "-Wunsafe-buffer-usage" opt-out region. This Loc must be a source location that has been pre-processed.

Definition at line 1487 of file Preprocessor.cpp.

References clang::SourceManager::isBeforeInTranslationUnit(), clang::SourceManager::isLocalSourceLocation(), LoadedRegions, and Loc.

◆ isUnannotatedBacktrackEnabled()

bool clang::Preprocessor::isUnannotatedBacktrackEnabled ( ) const

inline

True if EnableBacktrackAtThisPos() was called and caching of unannotated tokens is on.

Definition at line 1738 of file Preprocessor.h.

◆ LeaveSubmodule()

Module * Preprocessor::LeaveSubmodule ( bool ForPragma )

Definition at line 775 of file PPLexerChange.cpp.

References addModuleMacro(), getLangOpts(), clang::MacroDirective::getPrevious(), clang::Module::getTopLevelModuleName(), and makeModuleVisible().

Referenced by HandleEndOfFile().

◆ Lex()

void Preprocessor::Lex ( Token & Result )

Lex the next token for this preprocessor.

Definition at line 866 of file Preprocessor.cpp.

References CheckPointStepSize, getIdentifierInfo(), getLangOpts(), clang::ModuleLoader::HadFatalFailure, clang::Token::IsReinjected, clang::Result, setCodeCompletionIdentifierInfo(), and setCodeCompletionTokenRange().

Referenced by CheckEndOfDirective(), CollectPpImportSuffix(), clang::Parser::ConsumeToken(), clang::DoPrintPreprocessedInput(), EvaluateFeatureLikeBuiltinMacro(), clang::PrintDependencyDirectivesSourceMinimizerAction::ExecuteAction(), clang::DumpTokensAction::ExecuteAction(), clang::PreprocessOnlyAction::ExecuteAction(), FinishLexStringLiteral(), FixDigraph(), clang::MacroArgs::getPreExpArgument(), HandleComment(), HandleMicrosoftCommentPaste(), HandlePragmaDependency(), HandlePragmaHdrstop(), HandlePragmaIncludeAlias(), HandleSkippedDirectiveWhileUsingPCH(), LexAfterModuleImport(), LexHeaderName(), clang::PreprocessorLexer::LexIncludeFilename(), LexNonComment(), LexStringLiteral(), LexTokensUntilEOF(), LexUnexpandedToken(), clang::IncrementalParser::Parse(), ParseAlignPragma(), ParseLoopHintValue(), ParsePragmaPushOrPopMacro(), parseSimpleIntegerLiteral(), PrintPreprocessedTokens(), ReadLineMarkerFlags(), clang::RewriteIncludesInInput(), clang::RewriteMacrosInInput(), clang::Parser::TryAnnotateTypeOrScopeToken(), and clang::Parser::TryConsumeToken().

◆ LexAfterModuleImport()

bool Preprocessor::LexAfterModuleImport ( Token & Result )

Lex a token following the 'import' contextual keyword.

pp-import: [C++20]
      import header-name pp-import-suffix[opt] ;
      import header-name-tokens pp-import-suffix[opt] ;

[ObjC] @ import module-name ; [Clang] import module-name ;

header-name-tokens:
      string-literal
      < [any sequence of preprocessing-tokens other than >] >

module-name:
      module-name-qualifier[opt] identifier

module-name-qualifier
      module-name-qualifier[opt] identifier .

We respond to a pp-import by importing macros from the named module.

Definition at line 1145 of file Preprocessor.cpp.

References CollectPpImportSuffix(), Diag(), getIdentifierInfo(), getLangOpts(), clang::ModuleLoader::HadFatalFailure, clang::Module::Hidden, isInImportingCXXNamedModules(), clang::SourceLocation::isMacroID(), Lex(), LexHeaderName(), clang::ModuleLoader::loadModule(), makeModuleVisible(), recomputeCurLexerKind(), clang::Result, clang::Token::setIdentifierInfo(), clang::Token::setKind(), clang::Token::setLength(), clang::Token::setLocation(), and clang::Token::startToken().

◆ LexEmbedParameters()

std::optional< LexEmbedParametersResult > Preprocessor::LexEmbedParameters	(	Token &	Current,
		bool	ForHasEmbed
	)

Lex the parameters for an #embed directive, returns nullopt on error.

Definition at line 3647 of file PPDirectives.cpp.

References Diag(), DiscardUntilEndOfDirective(), clang::Token::getIdentifierInfo(), clang::Token::getKind(), clang::Token::getLocation(), clang::IdentifierInfo::getName(), clang::Token::is(), clang::Token::isNot(), clang::Token::isOneOf(), LexNonComment(), clang::Parameter, clang::Result, and toString().

◆ LexHeaderName()

bool Preprocessor::LexHeaderName	(	Token &	FilenameTok,
		bool	AllowMacroExpansion = `true`
	)

Lex a token, forming a header-name token if possible.

Lex a header-name token (including one formed from header-name-tokens if AllowMacroExpansion is true).

Parameters

FilenameTok	Filled in with the next token. On success, this will be either a header_name token. On failure, it will be whatever other token was found instead.
AllowMacroExpansion	If `true`, allow the header name to be formed by macro expansion (concatenating tokens as necessary if the first token is a '<').

Returns: true if we reached EOD or EOF while looking for a > token in a concatenated header name and diagnosed it. false otherwise.

Definition at line 1002 of file Preprocessor.cpp.

References CreateString(), Diag(), clang::Token::getLength(), clang::Token::getLocation(), getSpelling(), clang::Token::hasLeadingEmptyMacro(), clang::Token::hasLeadingSpace(), clang::Token::is(), clang::Token::isAtStartOfLine(), clang::Token::isNot(), clang::Token::isOneOf(), clang::Token::LeadingEmptyMacro, clang::Token::LeadingSpace, Lex(), clang::PreprocessorLexer::LexIncludeFilename(), memcpy(), setCodeCompletionReached(), clang::Token::setFlagValue(), clang::Token::setKind(), clang::Token::StartOfLine, and clang::Token::startToken().

Referenced by EvaluateHasIncludeCommon(), HandlePragmaDependency(), HandlePragmaIncludeAlias(), and LexAfterModuleImport().

◆ LexNonComment()

void clang::Preprocessor::LexNonComment ( Token & Result )

inline

Lex a token.

If it's a comment, keep lexing until we get something not a comment.

This is useful in -E -C mode where comments would foul up preprocessor directive handling.

Definition at line 1788 of file Preprocessor.h.

References Lex(), and clang::Result.

Referenced by EvaluateDefined(), EvaluateDirectiveSubExpr(), EvaluateHasIncludeCommon(), EvaluateValue(), and LexEmbedParameters().

◆ LexOnOffSwitch()

bool Preprocessor::LexOnOffSwitch ( tok::OnOffSwitch & Result )

Lex an on-off-switch (C99 6.10.6p2) and verify that it is followed by EOD.

Return true if the token is not a valid on-off-switch.

Definition at line 964 of file Pragma.cpp.

References Diag(), clang::Token::getIdentifierInfo(), clang::Token::isNot(), clang::IdentifierInfo::isStr(), LexUnexpandedToken(), clang::tok::OOS_DEFAULT, clang::tok::OOS_OFF, clang::tok::OOS_ON, and clang::Result.

◆ LexStringLiteral()

bool clang::Preprocessor::LexStringLiteral	(	Token &	Result,
		std::string &	String,
		const char *	DiagnosticTag,
		bool	AllowMacroExpansion
	)

inline

Lex a string literal, which may be the concatenation of multiple string literals and may even come from macro expansion.

Returns: true on success, false if a error diagnostic has been generated.

Definition at line 1767 of file Preprocessor.h.

References FinishLexStringLiteral(), Lex(), LexUnexpandedToken(), and clang::Result.

Referenced by HandlePragmaHdrstop().

◆ LexTokensUntilEOF()

void Preprocessor::LexTokensUntilEOF ( std::vector< Token > * Tokens = nullptr )

Lex all tokens for this preprocessor until (and excluding) end of file.

Definition at line 979 of file Preprocessor.cpp.

References clang::Token::isOneOf(), and Lex().

Referenced by DoPrintMacros().

◆ LexUnexpandedNonComment()

void clang::Preprocessor::LexUnexpandedNonComment ( Token & Result )

inline

Like LexNonComment, but this disables macro expansion of identifier tokens.

Definition at line 1808 of file Preprocessor.h.

References LexUnexpandedToken(), and clang::Result.

Referenced by EvaluateDefined().

◆ LexUnexpandedToken()

void clang::Preprocessor::LexUnexpandedToken ( Token & Result )

inline

Just like Lex, but disables macro expansion of identifier tokens.

Definition at line 1795 of file Preprocessor.h.

References Lex(), and clang::Result.

Referenced by CheckEndOfDirective(), DiscardUntilEndOfDirective(), EvaluateFeatureLikeBuiltinMacro(), FinishLexStringLiteral(), HandleDirective(), clang::PragmaNamespace::HandlePragma(), HandlePragmaModuleBuild(), HandlePragmaPoison(), LexModuleName(), LexModuleNameComponent(), LexOnOffSwitch(), LexStringLiteral(), and LexUnexpandedNonComment().

◆ LookAhead()

const Token & clang::Preprocessor::LookAhead ( unsigned N )

inline

Peeks ahead N tokens and returns that token without consuming any tokens.

LookAhead(0) returns the next token that would be returned by Lex(), LookAhead(1) returns the token after it, etc. This returns normal tokens after phase 5. As such, it is equivalent to using 'Lex', not 'LexUnexpandedToken'.

Definition at line 1832 of file Preprocessor.h.

Referenced by clang::Parser::NextToken(), clang::Parser::parseMapTypeModifiers(), clang::Parser::ParseMSAsmIdentifier(), and clang::Parser::ParseOpenMPVarList().

◆ LookupEmbedFile()

OptionalFileEntryRef Preprocessor::LookupEmbedFile	(	StringRef	Filename,
		bool	isAngled,
		bool	OpenFile,
		const FileEntry *	LookupFromFile = `nullptr`
	)

Given a "Filename" or <Filename> reference, look up the indicated embed resource.

isAngled indicates whether the file reference is for system #include's or not (i.e. using <> instead of ""). If OpenFile is true, the file looked up is opened for reading, otherwise it only validates that the file exists. Quoted filenames are looked up relative to LookupFromFile if it is nonnull.

Returns std::nullopt on failure.

Definition at line 1100 of file PPDirectives.cpp.

References clang::FileName, Filename, clang::FileManager::getDirectoryRef(), getFileManager(), clang::FileManager::getFileRef(), clang::DirectoryEntryRef::getName(), and clang::FileEntry::tryGetRealPathName().

◆ LookupFile()

OptionalFileEntryRef Preprocessor::LookupFile	(	SourceLocation	FilenameLoc,
		StringRef	Filename,
		bool	isAngled,
		ConstSearchDirIterator	FromDir,
		const FileEntry *	FromFile,
		ConstSearchDirIterator *	CurDir,
		SmallVectorImpl< char > *	SearchPath,
		SmallVectorImpl< char > *	RelativePath,
		ModuleMap::KnownHeader *	SuggestedModule,
		bool *	IsMapped,
		bool *	IsFrameworkFound,
		bool	SkipCache = `false`,
		bool	OpenFile = `true`,
		bool	CacheFailures = `true`
	)

Given a "foo" or <foo> reference, look up the indicated file.

Returns std::nullopt on failure. isAngled indicates whether the file reference is for system #include's or not (i.e. using <> instead of "").

Definition at line 974 of file PPDirectives.cpp.

References Filename, clang::ModuleMap::getBuiltinDir(), getCurrentFileLexer(), getCurrentModule(), clang::FileEntryRef::getDir(), clang::FileEntryRef::getFileEntry(), clang::PreprocessorLexer::getFileEntry(), clang::SourceManager::getFileEntryRefForID(), clang::PreprocessorLexer::getFileID(), clang::SourceManager::getMainFileID(), getModuleForLocation(), clang::HeaderSearch::getModuleMap(), clang::FileManager::getOptionalDirectoryRef(), clang::Module::IsSystem, clang::HeaderSearch::LookupFile(), clang::HeaderSearch::LookupSubframeworkHeader(), and clang::ModuleMap::shouldImportRelativeToBuiltinIncludeDir().

Referenced by EnterMainSourceFile(), EvaluateHasIncludeCommon(), HandlePragmaDependency(), and ParseDirective().

◆ LookUpIdentifierInfo()

IdentifierInfo * Preprocessor::LookUpIdentifierInfo ( Token & Identifier ) const

Given a tok::raw_identifier token, look up the identifier information for the token and install it into the token, updating the token kind accordingly.

LookUpIdentifierInfo - Given a tok::raw_identifier token, look up the identifier information for the token and install it into the token, updating the token kind accordingly.

Definition at line 696 of file Preprocessor.cpp.

References clang::expandUCNs(), getIdentifierInfo(), getSpelling(), clang::IdentifierInfo::getTokenID(), and Identifier.

Referenced by HandlePragmaPoison(), LexRawTokensFromMainFile(), and ParsePragmaPushOrPopMacro().

◆ macro_begin()

Preprocessor::macro_iterator Preprocessor::macro_begin ( bool IncludeExternalMacros = true ) const

Definition at line 313 of file Preprocessor.cpp.

Referenced by AddMacroResults(), clang::SemaCodeCompletion::CodeCompletePreprocessorMacroName(), DoPrintMacros(), getLastMacroWithSpelling(), and macros().

◆ macro_end()

Preprocessor::macro_iterator Preprocessor::macro_end ( bool IncludeExternalMacros = true ) const

Definition at line 340 of file Preprocessor.cpp.

Referenced by AddMacroResults(), clang::SemaCodeCompletion::CodeCompletePreprocessorMacroName(), DoPrintMacros(), getLastMacroWithSpelling(), and macros().

◆ macros()

llvm::iterator_range< macro_iterator > clang::Preprocessor::macros ( bool IncludeExternalMacros = true ) const

inline

Definition at line 1465 of file Preprocessor.h.

References macro_begin(), and macro_end().

Referenced by clang::SemaCodeCompletion::CodeCompleteObjCMethodDeclSelector(), clang::DumpModuleInfoAction::ExecuteAction(), indexPreprocessorMacros(), and indexPreprocessorModuleMacros().

◆ makeModuleVisible()

void Preprocessor::makeModuleVisible	(	Module *	M,
		SourceLocation	Loc
	)

Definition at line 1334 of file Preprocessor.cpp.

References Diag(), Loc, and Path.

Referenced by EnterSubmodule(), LeaveSubmodule(), and LexAfterModuleImport().

◆ markClangModuleAsAffecting()

void clang::Preprocessor::markClangModuleAsAffecting ( Module * M )

inline

Mark the given clang module as affecting the current clang module or translation unit.

Definition at line 1474 of file Preprocessor.h.

References clang::Module::isModuleMapModule().

Referenced by clang::CompilerInstance::loadModule().

◆ markIncluded()

bool clang::Preprocessor::markIncluded ( FileEntryRef File )

inline

Mark the file as included.

Returns true if this is the first time the file was included.

Definition at line 1492 of file Preprocessor.h.

References clang::File, clang::HeaderSearch::getFileInfo(), and clang::HeaderFileInfo::IsLocallyIncluded.

Referenced by EnterMainSourceFile(), and clang::HeaderSearch::ShouldEnterIncludeFile().

◆ markMacroAsUsed()

void Preprocessor::markMacroAsUsed ( MacroInfo * MI )

A macro is used, update information about macros that need unused warnings.

Definition at line 2098 of file PPMacroExpansion.cpp.

References clang::MacroInfo::getDefinitionLoc(), clang::MacroInfo::isUsed(), clang::MacroInfo::isWarnIfUnused(), and clang::MacroInfo::setIsUsed().

Referenced by EvaluateDefined().

◆ MaybeHandlePoisonedIdentifier()

void clang::Preprocessor::MaybeHandlePoisonedIdentifier ( Token & Identifier )

inline

Definition at line 2266 of file Preprocessor.h.

References HandlePoisonedIdentifier(), and Identifier.

◆ mightHavePendingAnnotationTokens()

bool clang::Preprocessor::mightHavePendingAnnotationTokens ( )

inline

Determine whether it's possible for a future call to Lex to produce an annotation token created by a previous call to EnterAnnotationToken.

Definition at line 1928 of file Preprocessor.h.

◆ overrideMaxTokens()

void clang::Preprocessor::overrideMaxTokens	(	unsigned	Value,
		SourceLocation	Loc
	)

inline

Definition at line 1317 of file Preprocessor.h.

References Loc.

◆ ParsePragmaPushOrPopMacro()

IdentifierInfo * Preprocessor::ParsePragmaPushOrPopMacro ( Token & Tok )

ParsePragmaPushOrPopMacro - Handle parsing of pragma push_macro/pop_macro.

Return the IdentifierInfo* associated with the macro to push or pop.

Definition at line 568 of file Pragma.cpp.

References CreateString(), Diag(), clang::Token::getLocation(), getSpelling(), clang::Token::hasUDSuffix(), clang::Token::isNot(), Lex(), LookUpIdentifierInfo(), clang::Token::setKind(), and clang::Token::startToken().

Referenced by HandlePragmaPopMacro(), and HandlePragmaPushMacro().

◆ parseSimpleIntegerLiteral()

bool Preprocessor::parseSimpleIntegerLiteral	(	Token &	Tok,
		uint64_t &	Value
	)

Parses a simple integer literal to get its numeric value.

Floating point literals and user defined literals are rejected. Used primarily to handle pragmas that accept integer arguments.

Definition at line 1392 of file Preprocessor.cpp.

References getDiagnostics(), getLangOpts(), clang::Token::getLocation(), getSourceManager(), getSpelling(), getTargetInfo(), clang::Token::is(), and Lex().

Referenced by clang::Parser::ParseOpenMPVarList().

◆ PoisonSEHIdentifiers()

void Preprocessor::PoisonSEHIdentifiers ( bool Poison = true )

Definition at line 735 of file Preprocessor.cpp.

References clang::IdentifierInfo::setIsPoisoned().

◆ PrintStats()

void Preprocessor::PrintStats ( )

Definition at line 274 of file Preprocessor.cpp.

References getTotalMemory().

Referenced by clang::FrontendAction::EndSourceFile().

◆ processPathForFileMacro()

void Preprocessor::processPathForFileMacro	(	SmallVectorImpl< char > &	Path,
		const LangOptions &	LangOpts,
		const TargetInfo &	TI
	)

static

Definition at line 2106 of file PPMacroExpansion.cpp.

References clang::TargetInfo::getTriple(), Path, clang::LangOptions::remapPathPrefix(), and clang::LangOptions::UseTargetPathSeparator.

Referenced by clang::SourceLocExpr::EvaluateInContext(), and processPathToFileName().

◆ processPathToFileName()

void Preprocessor::processPathToFileName	(	SmallVectorImpl< char > &	FileName,
		const PresumedLoc &	PLoc,
		const LangOptions &	LangOpts,
		const TargetInfo &	TI
	)

static

Definition at line 2119 of file PPMacroExpansion.cpp.

References clang::FileName, clang::PresumedLoc::getFilename(), and processPathForFileMacro().

Referenced by clang::SourceLocExpr::EvaluateInContext().

◆ recomputeCurLexerKind()

void Preprocessor::recomputeCurLexerKind ( )

Recompute the current lexer kind based on the CurLexer/ CurTokenLexer pointers.

Definition at line 384 of file Preprocessor.cpp.

Referenced by Backtrack(), HandleEndOfFile(), and LexAfterModuleImport().

◆ removeCommentHandler()

void Preprocessor::removeCommentHandler ( CommentHandler * Handler )

Remove the specified comment handler.

It is an error to remove a handler that has not been registered.

Definition at line 1419 of file Preprocessor.cpp.

Referenced by clang::Parser::~Parser().

◆ RemovePragmaHandler() [1/2]

void clang::Preprocessor::RemovePragmaHandler ( PragmaHandler * Handler )

inline

Definition at line 1544 of file Preprocessor.h.

References RemovePragmaHandler().

◆ RemovePragmaHandler() [2/2]

void Preprocessor::RemovePragmaHandler	(	StringRef	Namespace,
		PragmaHandler *	Handler
	)

Remove the specific pragma handler from this preprocessor.

RemovePragmaHandler - Remove the specific pragma handler from the preprocessor.

If Namespace is non-null, then it should be the namespace that Handler was added to. It is an error to remove a handler that has not been registered.

If

Namespace is non-null, then it should be the namespace that
Handler was added to. It is an error to remove a handler that has not been registered.

Definition at line 942 of file Pragma.cpp.

References clang::PragmaHandler::getIfNamespace(), clang::PragmaNamespace::IsEmpty(), and clang::PragmaNamespace::RemovePragmaHandler().

Referenced by clang::DoPrintPreprocessedInput(), and RemovePragmaHandler().

◆ RemoveTopOfLexerStack()

void Preprocessor::RemoveTopOfLexerStack ( )

Pop the current lexer/macro exp off the top of the lexer stack.

RemoveTopOfLexerStack - Pop the current lexer/macro exp off the top of the lexer stack.

This should only be used in situations where the current state of the top-of-stack lexer is known.

This should only be used in situations where the current state of the top-of-stack lexer is unknown.

Definition at line 621 of file PPLexerChange.cpp.

Referenced by clang::MacroArgs::getPreExpArgument(), and HandleEndOfFile().

◆ ReplaceLastTokenWithAnnotation()

void clang::Preprocessor::ReplaceLastTokenWithAnnotation ( const Token & Tok )

inline

Replace the last token with an annotation token.

Like AnnotateCachedTokens(), this routine replaces an already-parsed (and resolved) token with an annotation token. However, this routine only replaces the last token with the annotation token; it does not affect any other cached tokens. This function has no effect if backtracking is not enabled.

Definition at line 1916 of file Preprocessor.h.

References clang::Token::isAnnotation(), and isBacktrackEnabled().

◆ ReplacePreviousCachedToken()

void Preprocessor::ReplacePreviousCachedToken ( ArrayRef< Token > NewToks )

Replace token in CachedLexPos - 1 in CachedTokens by the tokens in NewToks.

Useful when a token needs to be split in smaller ones and CachedTokens most recent token must to be updated to reflect that.

Definition at line 189 of file PPCaching.cpp.

◆ RevertCachedTokens()

void clang::Preprocessor::RevertCachedTokens ( unsigned N )

inline

When backtracking is enabled and tokens are cached, this allows to revert a specific number of tokens.

Note that the number of tokens being reverted should be up to the last backtrack position, not more.

Definition at line 1845 of file Preprocessor.h.

References isBacktrackEnabled().

◆ SawDateOrTime()

bool clang::Preprocessor::SawDateOrTime ( ) const

inline

Returns true if the preprocessor has seen a use of DATE or TIME in the file so far.

Definition at line 2352 of file Preprocessor.h.

◆ serializeSafeBufferOptOutMap()

SmallVector< SourceLocation, 64 > Preprocessor::serializeSafeBufferOptOutMap ( ) const

Returns: a sequence of SourceLocations representing ordered opt-out regions specified by \#pragma clang unsafe_buffer_usage begin/ends of this translation unit.

Definition at line 1587 of file Preprocessor.cpp.

◆ setCodeCompletionHandler()

void clang::Preprocessor::setCodeCompletionHandler ( CodeCompletionHandler & Handler )

inline

Set the code completion handler to the given object.

Definition at line 1565 of file Preprocessor.h.

Referenced by clang::Parser::Parser().

◆ setCodeCompletionIdentifierInfo()

void clang::Preprocessor::setCodeCompletionIdentifierInfo ( IdentifierInfo * Filter )

inline

Set the code completion token for filtering purposes.

Definition at line 1588 of file Preprocessor.h.

Referenced by Lex().

◆ SetCodeCompletionPoint()

bool Preprocessor::SetCodeCompletionPoint	(	FileEntryRef	File,
		unsigned	Line,
		unsigned	Column
	)

Specify the point at which code-completion will be performed.

Parameters

File	the file in which code completion should occur. If this file is included multiple times, code-completion will perform completion the first time it is included. If NULL, this function clears out the code-completion point.
Line	the line at which code completion should occur (1-based).
Column	the column at which code completion should occur (1-based).

Returns: true if an error occurred, false otherwise.

Definition at line 395 of file Preprocessor.cpp.

References clang::File, clang::SourceManager::getFileEntryForID(), clang::SourceManager::getMainFileID(), clang::SourceManager::getMemoryBufferForFileOrNone(), clang::Line, and clang::SourceManager::overrideFileContents().

Referenced by EnableCodeCompletion().

◆ setCodeCompletionReached()

void clang::Preprocessor::setCodeCompletionReached ( )

inline

Note that we hit the code-completion point.

Definition at line 1991 of file Preprocessor.h.

References getDiagnostics(), isCodeCompletionEnabled(), and clang::DiagnosticsEngine::setSuppressAllDiagnostics().

Referenced by CodeCompleteIncludedFile(), CodeCompleteNaturalLanguage(), EvaluateDefined(), EvaluateValue(), HandleDirective(), and LexHeaderName().

◆ setCodeCompletionTokenRange()

void clang::Preprocessor::setCodeCompletionTokenRange	(	const SourceLocation	Start,
		const SourceLocation	End
	)

inline

Set the code completion token range for detecting replacement range later on.

Definition at line 1594 of file Preprocessor.h.

Referenced by Lex().

◆ SetCommentRetentionState()

void clang::Preprocessor::SetCommentRetentionState	(	bool	KeepComments,
		bool	KeepMacroComments
	)

inline

Control whether the preprocessor retains comments in output.

Definition at line 1245 of file Preprocessor.h.

Referenced by clang::DoPrintPreprocessedInput().

◆ setCounterValue()

void clang::Preprocessor::setCounterValue ( unsigned V )

inline

Definition at line 2356 of file Preprocessor.h.

References V.

Referenced by clang::ASTUnit::LoadFromASTFile(), and clang::PCHValidator::ReadCounter().

◆ setCurrentFPEvalMethod()

void clang::Preprocessor::setCurrentFPEvalMethod	(	SourceLocation	PragmaLoc,
		LangOptions::FPEvalMethodKind	Val
	)

inline

Definition at line 2373 of file Preprocessor.h.

References clang::LangOptionsBase::FEM_UnsetOnCommandLine.

Referenced by clang::Sema::ActOnPragmaFPEvalMethod(), Initialize(), and clang::Sema::FPFeaturesStateRAII::~FPFeaturesStateRAII().

◆ setDeserializedSafeBufferOptOutMap()

bool Preprocessor::setDeserializedSafeBufferOptOutMap ( const SmallVectorImpl< SourceLocation > & SrcLocSeqs )

Parameters

SrcLocSeqs a sequence of SourceLocations deserialized from a record of code PP_UNSAFE_BUFFER_USAGE.

Returns: true iff the Preprocessor has been updated; false Preprocessor is same as itself before the call.

Definition at line 1606 of file Preprocessor.cpp.

References Begin.

◆ setDiagnostics()

void clang::Preprocessor::setDiagnostics ( DiagnosticsEngine & D )

inline

Definition at line 1203 of file Preprocessor.h.

References D.

◆ setEmptylineHandler()

void clang::Preprocessor::setEmptylineHandler ( EmptylineHandler * Handler )

inline

Set empty line handler.

Definition at line 1552 of file Preprocessor.h.

Referenced by clang::CodeGen::CoverageMappingModuleGen::setUpCoverageCallbacks().

◆ setExternalSource()

void clang::Preprocessor::setExternalSource ( ExternalPreprocessorSource * Source )

inline

Definition at line 1218 of file Preprocessor.h.

◆ setLoadedMacroDirective()

void Preprocessor::setLoadedMacroDirective	(	IdentifierInfo *	II,
		MacroDirective *	ED,
		MacroDirective *	MD
	)

Set a MacroDirective that was loaded from a PCH file.

Definition at line 94 of file PPMacroExpansion.cpp.

References clang::MacroDirective::isDefined(), clang::IdentifierInfo::setHasMacroDefinition(), and clang::MacroDirective::setPrevious().

◆ SetMacroExpansionOnlyInDirectives()

void clang::Preprocessor::SetMacroExpansionOnlyInDirectives ( )

inline

Disables macro expansion everywhere except for preprocessor directives.

Definition at line 1820 of file Preprocessor.h.

Referenced by clang::DoPrintPreprocessedInput(), and clang::RewriteIncludesInInput().

◆ setMainFileDir()

void clang::Preprocessor::setMainFileDir ( DirectoryEntryRef Dir )

inline

Set the directory in which the main file should be considered to have been found, if it is not a real file.

Definition at line 2045 of file Preprocessor.h.

Referenced by prepareToBuildModule().

◆ SetPoisonReason()

void Preprocessor::SetPoisonReason	(	IdentifierInfo *	II,
		unsigned	DiagID
	)

Specifies the reason for poisoning an identifier.

If that identifier is accessed while poisoned, then this reason will be used instead of the default "poisoned" diagnostic.

Definition at line 731 of file Preprocessor.cpp.

Referenced by clang::Parser::Initialize(), and Preprocessor().

◆ setPragmaARCCFCodeAuditedInfo()

void clang::Preprocessor::setPragmaARCCFCodeAuditedInfo	(	IdentifierInfo *	Ident,
		SourceLocation	Loc
	)

inline

Set the location of the currently-active #pragma clang arc_cf_code_audited begin.

An invalid location ends the pragma.

Definition at line 2009 of file Preprocessor.h.

References Loc.

◆ setPragmaAssumeNonNullLoc()

void clang::Preprocessor::setPragmaAssumeNonNullLoc ( SourceLocation Loc )

inline

Set the location of the currently-active #pragma clang assume_nonnull begin.

An invalid location ends the pragma.

Definition at line 2024 of file Preprocessor.h.

References Loc.

◆ setPragmasEnabled()

void clang::Preprocessor::setPragmasEnabled ( bool Enabled )

inline

Definition at line 1252 of file Preprocessor.h.

◆ setPreambleRecordedPragmaAssumeNonNullLoc()

void clang::Preprocessor::setPreambleRecordedPragmaAssumeNonNullLoc ( SourceLocation Loc )

inline

Record the location of the unterminated #pragma clang assume_nonnull begin in the preamble.

Definition at line 2039 of file Preprocessor.h.

References Loc.

◆ setPredefines()

void clang::Preprocessor::setPredefines ( std::string P )

inline

Set the predefines for this Preprocessor.

These predefines are automatically injected when parsing the main file.

Definition at line 1521 of file Preprocessor.h.

References P.

Referenced by createASTReader(), clang::CompilerInstance::createPCHExternalASTSource(), and clang::InitializePreprocessor().

◆ setPreprocessedOutput()

void clang::Preprocessor::setPreprocessedOutput ( bool IsPreprocessedOutput )

inline

Sets whether the preprocessor is responsible for producing output or if it is producing tokens to be consumed by Parse and Sema.

Definition at line 1265 of file Preprocessor.h.

◆ setPreprocessToken()

void clang::Preprocessor::setPreprocessToken ( bool Preprocess )

inline

Definition at line 1331 of file Preprocessor.h.

Referenced by clang::CodeGen::CoverageMappingModuleGen::setUpCoverageCallbacks().

◆ setRecordedPreambleConditionalStack()

void clang::Preprocessor::setRecordedPreambleConditionalStack ( ArrayRef< PPConditionalInfo > s )

inline

Definition at line 2825 of file Preprocessor.h.

References s.

◆ setReplayablePreambleConditionalStack()

void clang::Preprocessor::setReplayablePreambleConditionalStack	(	ArrayRef< PPConditionalInfo >	s,
		std::optional< PreambleSkipInfo >	SkipInfo
	)

inline

Definition at line 2829 of file Preprocessor.h.

References s.

◆ setSkipMainFilePreamble()

void clang::Preprocessor::setSkipMainFilePreamble	(	unsigned	Bytes,
		bool	StartOfLine
	)

inline

Instruct the preprocessor to skip part of the main source file.

Parameters

Bytes	The number of bytes in the preamble to skip.
StartOfLine	Whether skipping these bytes puts the lexer at the start of a line.

Definition at line 2053 of file Preprocessor.h.

Referenced by clang::FrontendAction::BeginSourceFile(), and clang::InitializePreprocessor().

◆ SetSuppressIncludeNotFoundError()

void clang::Preprocessor::SetSuppressIncludeNotFoundError ( bool Suppress )

inline

Definition at line 1255 of file Preprocessor.h.

Referenced by clang::DependencyFileGenerator::attachToPreprocessor().

◆ setTokenWatcher()

void clang::Preprocessor::setTokenWatcher ( llvm::unique_function< void(const clang::Token &)> F )

inline

Register a function that would be called on each token in the final expanded token stream.

This also reports annotation tokens produced by the parser.

Definition at line 1327 of file Preprocessor.h.

Referenced by clang::MacroExpansionContext::registerForPreprocessor(), clang::CodeGen::CoverageMappingModuleGen::setUpCoverageCallbacks(), and clang::syntax::TokenCollector::TokenCollector().

◆ setTUFPEvalMethod()

void clang::Preprocessor::setTUFPEvalMethod ( LangOptions::FPEvalMethodKind Val )

inline

Definition at line 2384 of file Preprocessor.h.

References clang::LangOptionsBase::FEM_UnsetOnCommandLine.

Referenced by Initialize().

◆ SkipTokensWhileUsingPCH()

void Preprocessor::SkipTokensWhileUsingPCH ( )

Skip tokens until after the #include of the through header or until after a #pragma hdrstop.

Skip tokens until after the #include of the through header or until after a #pragma hdrstop is seen.

Tokens in the predefines file and the main file may be skipped. If the end of the predefines file is reached, skipping continues into the main file. If the end of the main file is reached, it's a fatal error.

Definition at line 639 of file Preprocessor.cpp.

References Diag(), getPredefinesFileID(), and clang::Token::is().

Referenced by EnterMainSourceFile().

◆ SplitToken()

SourceLocation Preprocessor::SplitToken	(	SourceLocation	TokLoc,
		unsigned	Length
	)

Split the first Length characters out of the token starting at TokLoc and return a location pointing to the split token.

Re-lexing from the split token will return the split token rather than the original.

Definition at line 508 of file Preprocessor.cpp.

References clang::SourceLocation::getLocWithOffset(), getSourceManager(), clang::Invalid, Loc, and SM.

◆ TypoCorrectToken()

void clang::Preprocessor::TypoCorrectToken ( const Token & Tok )

inline

Update the current token to represent the provided identifier, in order to cache an action performed by typo correction.

Definition at line 1934 of file Preprocessor.h.

References clang::Token::getIdentifierInfo(), and isBacktrackEnabled().

◆ usingPCHWithPragmaHdrStop()

bool Preprocessor::usingPCHWithPragmaHdrStop ( )

True if using a PCH with a #pragma hdrstop.

Definition at line 630 of file Preprocessor.cpp.

References clang::TU_Prefix, and TUKind.

Referenced by EnterMainSourceFile(), HandlePragmaHdrstop(), and Preprocessor().

◆ usingPCHWithThroughHeader()

bool Preprocessor::usingPCHWithThroughHeader ( )

True if using a PCH with a through header.

Definition at line 621 of file Preprocessor.cpp.

References clang::FileID::isValid(), clang::TU_Prefix, and TUKind.

Referenced by EnterMainSourceFile().

Friends And Related Function Documentation

◆ ASTReader

friend class ASTReader

friend

Definition at line 703 of file Preprocessor.h.

◆ MacroArgs

friend class MacroArgs

friend

Definition at line 704 of file Preprocessor.h.

◆ TokenLexer::ExpandFunctionArguments

void TokenLexer::ExpandFunctionArguments ( )

friend

◆ VAOptDefinitionContext

friend class VAOptDefinitionContext

friend

Definition at line 139 of file Preprocessor.h.

◆ VariadicMacroScopeGuard

friend class VariadicMacroScopeGuard

friend

Definition at line 140 of file Preprocessor.h.

Member Data Documentation

◆ LoadedRegions

llvm::DenseMap<FileID, SafeBufferOptOutRegionsTy> clang::Preprocessor::LoadedRegions

Definition at line 2959 of file Preprocessor.h.

Referenced by isSafeBufferOptOut().

◆ TUKind

const TranslationUnitKind clang::Preprocessor::TUKind

The kind of translation unit we are processing.

Definition at line 296 of file Preprocessor.h.

Referenced by clang::CompilerInstance::createASTContext(), creatingPCHWithPragmaHdrStop(), creatingPCHWithThroughHeader(), HandleEndOfFile(), HandlePragmaOnce(), clang::Sema::Sema(), usingPCHWithPragmaHdrStop(), and usingPCHWithThroughHeader().

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

include/clang/Lex/Preprocessor.h
lib/Lex/PPCaching.cpp
lib/Lex/PPDirectives.cpp
lib/Lex/PPExpressions.cpp
lib/Lex/PPLexerChange.cpp
lib/Lex/PPMacroExpansion.cpp
lib/Lex/Pragma.cpp
lib/Lex/Preprocessor.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ IncludedFilesSet

◆ macro_iterator

Constructor & Destructor Documentation

◆ Preprocessor()

◆ ~Preprocessor()

Member Function Documentation

◆ addCommentHandler()

◆ addFinalLoc()

◆ addMacroDeprecationMsg()

◆ addModuleMacro()

◆ addPPCallbacks()

◆ AddPragmaHandler() [1/2]

◆ AddPragmaHandler() [2/2]

◆ addRestrictExpansionMsg()

◆ AdvanceToTokenCharacter()

◆ AllocateMacroInfo()

◆ alreadyIncluded()

◆ AnnotateCachedTokens()

◆ appendDefMacroDirective() [1/2]

◆ appendDefMacroDirective() [2/2]

◆ appendMacroDirective()

◆ Backtrack()

◆ CheckEndOfDirective()

◆ CheckMacroName()

◆ checkModuleIsAvailable()

◆ clearCodeCompletionHandler()

◆ CodeCompleteIncludedFile()

◆ CodeCompleteNaturalLanguage()

◆ CollectPpImportSuffix()

◆ CommitBacktrackedTokens()

◆ createPreprocessingRecord()

◆ CreateString()

◆ creatingPCHWithPragmaHdrStop()

◆ creatingPCHWithThroughHeader()

◆ Diag() [1/2]

◆ Diag() [2/2]

◆ DiscardUntilEndOfDirective() [1/2]

◆ DiscardUntilEndOfDirective() [2/2]

◆ DumpLocation()

◆ DumpMacro()

◆ dumpMacroInfo()

◆ DumpToken()

◆ emitMacroExpansionWarnings()

◆ EnableBacktrackAtThisPos()

◆ enableIncrementalProcessing()

◆ EndSourceFile()

◆ EnterAnnotationToken()

◆ EnterMacro()

◆ EnterMainSourceFile()

◆ enterOrExitSafeBufferOptOutRegion()

◆ EnterSourceFile()

◆ EnterSubmodule()

◆ EnterToken()

◆ EnterTokenStream() [1/2]

◆ EnterTokenStream() [2/2]

◆ FinalizeForModelFile()

◆ FinishLexStringLiteral()

◆ getAffectingClangModules()

◆ getAuxTargetInfo()

◆ getBuildingSubmodules()

◆ getBuiltinInfo()

◆ getCheckPoint()

◆ getCodeCompletionFileLoc()

◆ getCodeCompletionFilter()

◆ getCodeCompletionHandler()

◆ getCodeCompletionLoc()

◆ getCodeCompletionTokenRange()

◆ getCommentRetentionState()

◆ getCounterValue()

◆ getCurrentFileLexer()

◆ getCurrentFPEvalMethod()

◆ getCurrentLexer()