clang  6.0.0svn
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
clang::Preprocessor Class Reference

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

#include "clang/Lex/Preprocessor.h"

Classes

struct  CachedTokensRange
 
class  ResetMacroExpansionHelper
 

Public Member Functions

 Preprocessor (std::shared_ptr< PreprocessorOptions > PPOpts, DiagnosticsEngine &diags, LangOptions &opts, SourceManager &SM, MemoryBufferCache &PCMCache, 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. More...
 
void InitializeForModelFile ()
 Initialize the preprocessor to parse a model file. More...
 
void FinalizeForModelFile ()
 Cleanup after model file parsing. More...
 
PreprocessorOptionsgetPreprocessorOpts () const
 Retrieve the preprocessor options used to initialize this preprocessor. More...
 
DiagnosticsEnginegetDiagnostics () const
 
void setDiagnostics (DiagnosticsEngine &D)
 
const LangOptionsgetLangOpts () const
 
const TargetInfogetTargetInfo () const
 
const TargetInfogetAuxTargetInfo () const
 
FileManagergetFileManager () const
 
SourceManagergetSourceManager () const
 
MemoryBufferCachegetPCMCache () const
 
HeaderSearchgetHeaderSearchInfo () const
 
IdentifierTablegetIdentifierTable ()
 
const IdentifierTablegetIdentifierTable () const
 
SelectorTablegetSelectorTable ()
 
Builtin::ContextgetBuiltinInfo ()
 
llvm::BumpPtrAllocator & getPreprocessorAllocator ()
 
void setPTHManager (PTHManager *pm)
 
PTHManagergetPTHManager ()
 
void setExternalSource (ExternalPreprocessorSource *Source)
 
ExternalPreprocessorSourcegetExternalSource () const
 
ModuleLoadergetModuleLoader () const
 Retrieve the module loader associated with this preprocessor. More...
 
bool hadModuleLoaderFatalFailure () const
 
bool isParsingIfOrElifDirective () const
 True if we are currently preprocessing a if or #elif directive. More...
 
void SetCommentRetentionState (bool KeepComments, bool KeepMacroComments)
 Control whether the preprocessor retains comments in output. More...
 
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. More...
 
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. More...
 
bool isCurrentLexer (const PreprocessorLexer *L) const
 Return true if we are lexing directly from the specified lexer. More...
 
PreprocessorLexergetCurrentLexer () const
 Return the current lexer being lexed from. More...
 
PreprocessorLexergetCurrentFileLexer () const
 Return the current file lexer being lexed from. More...
 
ModulegetCurrentLexerSubmodule () const
 Return the submodule owning the file being lexed. More...
 
FileID getPredefinesFileID () const
 Returns the FileID for the preprocessor predefines. More...
 
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. More...
 
MacroDefinition getMacroDefinition (const IdentifierInfo *II)
 
MacroDefinition getMacroDefinitionAtLoc (const IdentifierInfo *II, SourceLocation Loc)
 
MacroDirectivegetLocalMacroDirective (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. More...
 
const MacroInfogetMacroInfo (const IdentifierInfo *II) const
 
MacroInfogetMacroInfo (const IdentifierInfo *II)
 
MacroDirectivegetLocalMacroDirectiveHistory (const IdentifierInfo *II) const
 Given an identifier, return the latest non-imported macro directive for that identifier. More...
 
void appendMacroDirective (IdentifierInfo *II, MacroDirective *MD)
 Add a directive to the macro directive history for this identifier. More...
 
DefMacroDirectiveappendDefMacroDirective (IdentifierInfo *II, MacroInfo *MI, SourceLocation Loc)
 
DefMacroDirectiveappendDefMacroDirective (IdentifierInfo *II, MacroInfo *MI)
 
void setLoadedMacroDirective (IdentifierInfo *II, MacroDirective *ED, MacroDirective *MD)
 Set a MacroDirective that was loaded from a PCH file. More...
 
ModuleMacroaddModuleMacro (Module *Mod, IdentifierInfo *II, MacroInfo *Macro, ArrayRef< ModuleMacro *> Overrides, bool &IsNew)
 Register an exported macro for a module and identifier. More...
 
ModuleMacrogetModuleMacro (Module *Mod, IdentifierInfo *II)
 
ArrayRef< ModuleMacro * > getLeafModuleMacros (const IdentifierInfo *II) const
 Get the list of leaf (non-overridden) module macros for a name. More...
 
StringRef getLastMacroWithSpelling (SourceLocation Loc, ArrayRef< TokenValue > Tokens) const
 Return the name of the macro defined before Loc that has spelling Tokens. More...
 
const std::string & getPredefines () const
 
void setPredefines (const char *P)
 Set the predefines for this Preprocessor. More...
 
void setPredefines (StringRef P)
 
IdentifierInfogetIdentifierInfo (StringRef Name) const
 Return information about the specified preprocessor identifier token. More...
 
void AddPragmaHandler (StringRef Namespace, PragmaHandler *Handler)
 Add the specified pragma handler to this preprocessor. More...
 
void AddPragmaHandler (PragmaHandler *Handler)
 
void RemovePragmaHandler (StringRef Namespace, PragmaHandler *Handler)
 Remove the specific pragma handler from this preprocessor. More...
 
void RemovePragmaHandler (PragmaHandler *Handler)
 
void IgnorePragmas ()
 Install empty handlers for all pragmas (making them ignored). More...
 
void addCommentHandler (CommentHandler *Handler)
 Add the specified comment handler to the preprocessor. More...
 
void removeCommentHandler (CommentHandler *Handler)
 Remove the specified comment handler. More...
 
void setCodeCompletionHandler (CodeCompletionHandler &Handler)
 Set the code completion handler to the given object. More...
 
CodeCompletionHandlergetCodeCompletionHandler () const
 Retrieve the current code-completion handler. More...
 
void clearCodeCompletionHandler ()
 Clear out the code completion handler. More...
 
void CodeCompleteNaturalLanguage ()
 Hook used by the lexer to invoke the "natural language" code completion point. More...
 
void setCodeCompletionIdentifierInfo (IdentifierInfo *Filter)
 Set the code completion token for filtering purposes. More...
 
StringRef getCodeCompletionFilter ()
 Get the code completion token for filtering purposes. More...
 
PreprocessingRecordgetPreprocessingRecord () const
 Retrieve the preprocessing record, or NULL if there is no preprocessing record. More...
 
void createPreprocessingRecord ()
 Create a new preprocessing record, which will keep track of all macro expansions, macro definitions, etc. More...
 
void EnterMainSourceFile ()
 Enter the specified FileID as the main source file, which implicitly adds the builtin defines etc. More...
 
void EndSourceFile ()
 Inform the preprocessor callbacks that processing is complete. More...
 
bool EnterSourceFile (FileID CurFileID, const DirectoryLookup *Dir, SourceLocation Loc)
 Add a source file to the top of the include stack and start lexing tokens from it instead of the current buffer. More...
 
void EnterMacro (Token &Identifier, 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. More...
 
void EnterTokenStream (std::unique_ptr< Token[]> Toks, unsigned NumToks, bool DisableMacroExpansion)
 
void EnterTokenStream (ArrayRef< Token > Toks, bool DisableMacroExpansion)
 
void RemoveTopOfLexerStack ()
 Pop the current lexer/macro exp off the top of the lexer stack. More...
 
void EnableBacktrackAtThisPos ()
 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. More...
 
void CommitBacktrackedTokens ()
 Disable the last EnableBacktrackAtThisPos call. More...
 
CachedTokensRange LastCachedTokenRange ()
 Returns the range of cached tokens that were lexed since EnableBacktrackAtThisPos() was previously called. More...
 
void EraseCachedTokens (CachedTokensRange TokenRange)
 Erase the range of cached tokens that were lexed since EnableBacktrackAtThisPos() was previously called. More...
 
void Backtrack ()
 Make Preprocessor re-lex the tokens that were lexed since EnableBacktrackAtThisPos() was previously called. More...
 
bool isBacktrackEnabled () const
 True if EnableBacktrackAtThisPos() was called and caching of tokens is on. More...
 
void Lex (Token &Result)
 Lex the next token for this preprocessor. More...
 
void LexAfterModuleImport (Token &Result)
 Lex a token following the 'import' contextual keyword. More...
 
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. More...
 
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). More...
 
void LexNonComment (Token &Result)
 Lex a token. More...
 
void LexUnexpandedToken (Token &Result)
 Just like Lex, but disables macro expansion of identifier tokens. More...
 
void LexUnexpandedNonComment (Token &Result)
 Like LexNonComment, but this disables macro expansion of identifier tokens. More...
 
bool parseSimpleIntegerLiteral (Token &Tok, uint64_t &Value)
 Parses a simple integer literal to get its numeric value. More...
 
void SetMacroExpansionOnlyInDirectives ()
 Disables macro expansion everywhere except for preprocessor directives. More...
 
const TokenLookAhead (unsigned N)
 Peeks ahead N tokens and returns that token without consuming any tokens. More...
 
void RevertCachedTokens (unsigned N)
 When backtracking is enabled and tokens are cached, this allows to revert a specific number of tokens. More...
 
void EnterToken (const Token &Tok)
 Enters a token in the token stream to be lexed next. More...
 
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. More...
 
SourceLocation getLastCachedTokenLocation () const
 Get the location of the last cached token, suitable for setting the end location of an annotation token. More...
 
bool IsPreviousCachedToken (const Token &Tok) const
 Whether Tok is the most recent token (CachedLexPos - 1) in CachedTokens. More...
 
void ReplacePreviousCachedToken (ArrayRef< Token > NewToks)
 Replace token in CachedLexPos - 1 in CachedTokens by the tokens in NewToks. More...
 
void ReplaceLastTokenWithAnnotation (const Token &Tok)
 Replace the last token with an annotation token. More...
 
void EnterAnnotationToken (SourceRange Range, tok::TokenKind Kind, void *AnnotationVal)
 Enter an annotation token into the token stream. More...
 
void TypoCorrectToken (const Token &Tok)
 Update the current token to represent the provided identifier, in order to cache an action performed by typo correction. More...
 
void recomputeCurLexerKind ()
 Recompute the current lexer kind based on the CurLexer/CurPTHLexer/ CurTokenLexer pointers. More...
 
bool isIncrementalProcessingEnabled () const
 Returns true if incremental processing is enabled. More...
 
void enableIncrementalProcessing (bool value=true)
 Enables the incremental processing. More...
 
bool SetCodeCompletionPoint (const FileEntry *File, unsigned Line, unsigned Column)
 Specify the point at which code-completion will be performed. More...
 
bool isCodeCompletionEnabled () const
 Determine if we are performing code completion. More...
 
SourceLocation getCodeCompletionLoc () const
 Returns the location of the code-completion point. More...
 
SourceLocation getCodeCompletionFileLoc () const
 Returns the start location of the file of code-completion point. More...
 
bool isCodeCompletionReached () const
 Returns true if code-completion is enabled and we have hit the code-completion point. More...
 
void setCodeCompletionReached ()
 Note that we hit the code-completion point. More...
 
SourceLocation getPragmaARCCFCodeAuditedLoc () const
 The location of the currently-active #pragma clang arc_cf_code_audited begin. More...
 
void setPragmaARCCFCodeAuditedLoc (SourceLocation Loc)
 Set the location of the currently-active #pragma clang arc_cf_code_audited begin. More...
 
SourceLocation getPragmaAssumeNonNullLoc () const
 The location of the currently-active #pragma clang assume_nonnull begin. More...
 
void setPragmaAssumeNonNullLoc (SourceLocation Loc)
 Set the location of the currently-active #pragma clang assume_nonnull begin. More...
 
void setMainFileDir (const DirectoryEntry *Dir)
 Set the directory in which the main file should be considered to have been found, if it is not a real file. More...
 
void setSkipMainFilePreamble (unsigned Bytes, bool StartOfLine)
 Instruct the preprocessor to skip part of the main source file. More...
 
DiagnosticBuilder Diag (SourceLocation Loc, unsigned DiagID) const
 Forwarding function for diagnostics. More...
 
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. More...
 
std::string getSpelling (const Token &Tok, bool *Invalid=nullptr) const
 Return the 'spelling' of the Tok token. More...
 
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. More...
 
StringRef getSpelling (const Token &Tok, SmallVectorImpl< char > &Buffer, bool *Invalid=nullptr) const
 Get the spelling of a token into a SmallVector. More...
 
bool getRawToken (SourceLocation Loc, Token &Result, bool IgnoreWhiteSpace=false)
 Relex the token at the specified location. More...
 
char getSpellingOfSingleCharacterNumericConstant (const Token &Tok, bool *Invalid=nullptr) const
 Given a Token Tok that is a numeric constant with length 1, return the character. More...
 
StringRef getImmediateMacroName (SourceLocation Loc)
 Retrieve the name of the immediate macro expansion. More...
 
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. More...
 
SourceLocation getLocForEndOfToken (SourceLocation Loc, unsigned Offset=0)
 Computes the source location just past the end of the token at this source location. More...
 
bool isAtStartOfMacroExpansion (SourceLocation loc, SourceLocation *MacroBegin=nullptr) const
 Returns true if the given MacroID location points at the first token of the macro expansion. More...
 
bool isAtEndOfMacroExpansion (SourceLocation loc, SourceLocation *MacroEnd=nullptr) const
 Returns true if the given MacroID location points at the last token of the macro expansion. More...
 
void DumpToken (const Token &Tok, bool DumpFlags=false) const
 Print the token to stderr, used for debugging. More...
 
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. More...
 
void IncrementPasteCounter (bool isFast)
 Increment the counters for the number of token paste operations performed. More...
 
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. More...
 
IdentifierInfoLookUpIdentifierInfo (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. More...
 
void SetPoisonReason (IdentifierInfo *II, unsigned DiagID)
 Specifies the reason for poisoning an identifier. More...
 
void HandlePoisonedIdentifier (Token &Tok)
 Display reason for poisoned identifier. More...
 
void MaybeHandlePoisonedIdentifier (Token &Identifier)
 
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. More...
 
bool HandleEndOfFile (Token &Result, bool isEndOfMacro=false)
 Callback invoked when the lexer hits the end of the current file. More...
 
bool HandleEndOfTokenLexer (Token &Result)
 Callback invoked when the current TokenLexer hits the end of its token stream. More...
 
void HandleDirective (Token &Result)
 Callback invoked when the lexer sees a # token at the start of a line. More...
 
void CheckEndOfDirective (const char *Directive, bool EnableMacros=false)
 Ensure that the next token is a tok::eod token. More...
 
void DiscardUntilEndOfDirective ()
 Read and discard all tokens remaining on the current line until the tok::eod token is found. More...
 
bool SawDateOrTime () const
 Returns true if the preprocessor has seen a use of DATE or TIME in the file so far. More...
 
unsigned getCounterValue () const
 
void setCounterValue (unsigned V)
 
ModulegetCurrentModule ()
 Retrieves the module that we're currently building, if any. More...
 
MacroInfoAllocateMacroInfo (SourceLocation L)
 Allocate a new MacroInfo object with the provided SourceLocation. More...
 
bool GetIncludeFilenameSpelling (SourceLocation Loc, StringRef &Filename)
 Turn the specified lexer token into a fully checked and spelled filename, e.g. More...
 
const FileEntryLookupFile (SourceLocation FilenameLoc, StringRef Filename, bool isAngled, const DirectoryLookup *FromDir, const FileEntry *FromFile, const DirectoryLookup *&CurDir, SmallVectorImpl< char > *SearchPath, SmallVectorImpl< char > *RelativePath, ModuleMap::KnownHeader *SuggestedModule, bool *IsMapped, bool SkipCache=false)
 Given a "foo" or <foo> reference, look up the indicated file. More...
 
const DirectoryLookupGetCurDirLookup ()
 Get the DirectoryLookup structure used to find the current FileEntry, if CurLexer is non-null and if applicable. More...
 
bool isInPrimaryFile () const
 Return true if we're in the top-level file, not in a #include. More...
 
bool ConcatenateIncludeName (SmallString< 128 > &FilenameBuffer, SourceLocation &End)
 Handle cases where the #include name is expanded from a macro as multiple tokens, which need to be glued together. More...
 
bool LexOnOffSwitch (tok::OnOffSwitch &OOS)
 Lex an on-off-switch (C99 6.10.6p2) and verify that it is followed by EOD. More...
 
bool CheckMacroName (Token &MacroNameTok, MacroUse isDefineUndef, bool *ShadowFlag=nullptr)
 
void EnterSubmodule (Module *M, SourceLocation ImportLoc, bool ForPragma)
 
ModuleLeaveSubmodule (bool ForPragma)
 
ModulegetModuleForLocation (SourceLocation Loc)
 Find the module that owns the source or header file that Loc points to. More...
 
const FileEntrygetModuleHeaderToIncludeForDiagnostics (SourceLocation IncLoc, Module *M, SourceLocation MLoc)
 We want to produce a diagnostic at location IncLoc concerning a missing module import. More...
 
bool isRecordingPreamble () const
 
bool hasRecordedPreamble () const
 
ArrayRef< PPConditionalInfogetPreambleConditionalStack () const
 
void setRecordedPreambleConditionalStack (ArrayRef< PPConditionalInfo > s)
 
void setReplayablePreambleConditionalStack (ArrayRef< PPConditionalInfo > s)
 
void HandlePragmaOnce (Token &OnceTok)
 HandlePragmaOnce - Handle #pragma once. More...
 
void HandlePragmaMark ()
 
void HandlePragmaPoison ()
 HandlePragmaPoison - Handle #pragma GCC poison. More...
 
void HandlePragmaSystemHeader (Token &SysHeaderTok)
 HandlePragmaSystemHeader - Implement #pragma GCC system_header. More...
 
void HandlePragmaDependency (Token &DependencyTok)
 HandlePragmaDependency - Handle #pragma GCC dependency "foo" blah. More...
 
void HandlePragmaPushMacro (Token &Tok)
 Handle #pragma push_macro. More...
 
void HandlePragmaPopMacro (Token &Tok)
 Handle #pragma pop_macro. More...
 
void HandlePragmaIncludeAlias (Token &Tok)
 
void HandlePragmaModuleBuild (Token &Tok)
 
IdentifierInfoParsePragmaPushOrPopMacro (Token &Tok)
 ParsePragmaPushOrPopMacro - Handle parsing of pragma push_macro/pop_macro. More...
 
bool HandleComment (Token &Token, SourceRange Comment)
 
void markMacroAsUsed (MacroInfo *MI)
 A macro is used, update information about macros that need unused warnings. More...
 
PPCallbacksgetPPCallbacks () const
 Accessors for preprocessor callbacks. More...
 
void addPPCallbacks (std::unique_ptr< PPCallbacks > C)
 

Static Public Member Functions

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

Friends

class VariadicMacroScopeGuard
 
class VAOptDefinitionContext
 
class ASTReader
 
class MacroArgs
 
void TokenLexer::ExpandFunctionArguments ()
 
typedef MacroMap::const_iterator macro_iterator
 
macro_iterator macro_begin (bool IncludeExternalMacros=true) const
 
macro_iterator macro_end (bool IncludeExternalMacros=true) const
 
llvm::iterator_range< macro_iteratormacros (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 98 of file Preprocessor.h.

Member Typedef Documentation

◆ macro_iterator

typedef MacroMap::const_iterator clang::Preprocessor::macro_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 952 of file Preprocessor.h.

Constructor & Destructor Documentation

◆ Preprocessor()

Preprocessor::Preprocessor ( std::shared_ptr< PreprocessorOptions PPOpts,
DiagnosticsEngine diags,
LangOptions opts,
SourceManager SM,
MemoryBufferCache PCMCache,
HeaderSearch Headers,
ModuleLoader TheModuleLoader,
IdentifierInfoLookup IILookup = nullptr,
bool  OwnsHeaderSearch = false,
TranslationUnitKind  TUKind = TU_Complete 
)

◆ ~Preprocessor()

Preprocessor::~Preprocessor ( )

Definition at line 164 of file Preprocessor.cpp.

Member Function Documentation

◆ addCommentHandler()

void Preprocessor::addCommentHandler ( CommentHandler Handler)

Add the specified comment handler to the preprocessor.

Definition at line 929 of file Preprocessor.cpp.

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

◆ 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().

◆ addPPCallbacks()

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

◆ AddPragmaHandler() [1/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 880 of file Pragma.cpp.

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

Referenced by clang::DoPrintPreprocessedInput().

◆ AddPragmaHandler() [2/2]

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

Definition at line 986 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 1573 of file Preprocessor.h.

Referenced by ExpectFeatureIdentifierInfo(), GetLineValue(), clang::NumericLiteralParser::isValidUDSuffix(), and clang::NumericLiteralParser::NumericLiteralParser().

◆ AllocateMacroInfo()

MacroInfo * Preprocessor::AllocateMacroInfo ( SourceLocation  L)

Allocate a new MacroInfo object with the provided SourceLocation.

Definition at line 59 of file PPDirectives.cpp.

Referenced by isConfigurationPattern().

◆ 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 1265 of file Preprocessor.h.

References clang::Token::isAnnotation().

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

◆ appendDefMacroDirective() [1/2]

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

Definition at line 919 of file Preprocessor.h.

Referenced by isConfigurationPattern().

◆ appendDefMacroDirective() [2/2]

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

Definition at line 925 of file Preprocessor.h.

References clang::MacroInfo::getDefinitionLoc().

◆ appendMacroDirective()

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

◆ Backtrack()

void Preprocessor::Backtrack ( )

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

Definition at line 63 of file PPCaching.cpp.

References clang::C, EraseCachedTokens(), isBacktrackEnabled(), Lex(), clang::None, recomputeCurLexerKind(), and clang::Result.

Referenced by clang::Parser::getTypeAnnotation(), and clang::PragmaNamespace::HandlePragma().

◆ CheckEndOfDirective()

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

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.

Definition at line 316 of file PPDirectives.cpp.

References clang::CodeCompletionHandler::CodeCompleteInConditionalExclusion(), clang::FixItHint::CreateInsertion(), clang::PPCallbacks::CVK_False, clang::PPCallbacks::CVK_True, Diag(), DiscardUntilEndOfDirective(), clang::comments::tok::eof, clang::PPConditionalInfo::FoundElse, clang::PPConditionalInfo::FoundNonSkip, clang::Token::getIdentifierInfo(), clang::Token::getLocation(), clang::IdentifierInfo::getPPKeywordID(), clang::Token::getRawIdentifier(), clang::PreprocessorLexer::getSourceLocation(), getSpelling(), clang::PPConditionalInfo::IfLoc, clang::Token::is(), clang::Token::isAtStartOfLine(), clang::Token::isNot(), Lex(), clang::PreprocessorLexer::LexingRawMode, LexUnexpandedToken(), clang::Token::needsCleaning(), clang::PreprocessorLexer::ParsingPreprocessorDirective, clang::PreprocessorLexer::peekConditionalLevel(), clang::PreprocessorLexer::popConditionalLevel(), clang::PreprocessorLexer::pushConditionalLevel(), setCodeCompletionReached(), clang::format::Tok, and clang::PPConditionalInfo::WasSkipping.

Referenced by checkModuleIsAvailable(), GetLineValue(), isConfigurationPattern(), LexOnOffSwitch(), and ReadLineMarkerFlags().

◆ CheckMacroName()

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

◆ checkModuleIsAvailable()

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

◆ clearCodeCompletionHandler()

void clang::Preprocessor::clearCodeCompletionHandler ( )
inline

Clear out the code completion handler.

Definition at line 1022 of file Preprocessor.h.

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

◆ CodeCompleteNaturalLanguage()

void Preprocessor::CodeCompleteNaturalLanguage ( )

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

Definition at line 445 of file Preprocessor.cpp.

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

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

◆ CommitBacktrackedTokens()

void Preprocessor::CommitBacktrackedTokens ( )

Disable the last EnableBacktrackAtThisPos call.

Definition at line 32 of file PPCaching.cpp.

Referenced by clang::Parser::getTypeAnnotation(), and clang::PragmaNamespace::HandlePragma().

◆ ConcatenateIncludeName()

bool Preprocessor::ConcatenateIncludeName ( SmallString< 128 > &  FilenameBuffer,
SourceLocation End 
)

Handle cases where the #include name is expanded from a macro as multiple tokens, which need to be glued together.

This occurs for code like:

\#define FOO <x/y.h>
\#include FOO

because in this case, "<x/y.h>" is returned as 7 tokens, not one.

This code concatenates and consumes tokens up to the '>' token. It returns false if the > was found, otherwise it returns true if it finds and consumes the EOD marker.

Definition at line 1506 of file PPDirectives.cpp.

References Diag(), clang::Token::getLength(), clang::Token::getLocation(), getSpelling(), clang::Token::hasLeadingSpace(), clang::Token::is(), clang::Token::isNot(), Lex(), and setCodeCompletionReached().

Referenced by checkModuleIsAvailable(), and EvaluateHasIncludeCommon().

◆ createPreprocessingRecord()

void Preprocessor::createPreprocessingRecord ( )

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

Definition at line 963 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 476 of file Preprocessor.cpp.

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

Referenced by ComputeDATE_TIME(), ExpectFeatureIdentifierInfo(), and clang::MacroArgs::StringifyArgument().

◆ Diag() [1/2]

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

◆ Diag() [2/2]

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

◆ DiscardUntilEndOfDirective()

void Preprocessor::DiscardUntilEndOfDirective ( )

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

Definition at line 83 of file PPDirectives.cpp.

References clang::comments::tok::eof, clang::Token::isNot(), and LexUnexpandedToken().

Referenced by CheckEndOfDirective(), CheckMacroName(), checkModuleIsAvailable(), GetLineValue(), HandleDirective(), isConfigurationPattern(), LexOnOffSwitch(), ParseAlignPragma(), and ReadLineMarkerFlags().

◆ DumpLocation()

void Preprocessor::DumpLocation ( SourceLocation  Loc) const

Definition at line 252 of file Preprocessor.cpp.

References clang::SourceLocation::dump().

Referenced by DumpToken().

◆ DumpMacro()

void Preprocessor::DumpMacro ( const MacroInfo MI) const

◆ dumpMacroInfo()

void Preprocessor::dumpMacroInfo ( const IdentifierInfo II)

Definition at line 258 of file PPMacroExpansion.cpp.

References clang::IdentifierInfo::getNameStart(), clang::None, and State.

Referenced by LexOnOffSwitch().

◆ DumpToken()

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

◆ EnableBacktrackAtThisPos()

void Preprocessor::EnableBacktrackAtThisPos ( )

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.

Definition at line 26 of file PPCaching.cpp.

Referenced by clang::Parser::getTypeAnnotation(), and clang::PragmaNamespace::HandlePragma().

◆ enableIncrementalProcessing()

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

Enables the incremental processing.

Definition at line 1323 of file Preprocessor.h.

References Line.

◆ EndSourceFile()

void Preprocessor::EndSourceFile ( )

Inform the preprocessor callbacks that processing is complete.

Definition at line 556 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 1555 of file PPDirectives.cpp.

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

Referenced by LexOnOffSwitch().

◆ 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
Argsspecifies the tokens input to a function-like macro.
ILEndspecifies the location of the ')' for a function-like macro or the identifier for an object-like macro.

Definition at line 160 of file PPLexerChange.cpp.

References clang::format::Tok.

Referenced by isTrivialSingleTokenExpansion().

◆ EnterMainSourceFile()

void Preprocessor::EnterMainSourceFile ( )

◆ EnterSourceFile()

bool Preprocessor::EnterSourceFile ( FileID  FID,
const DirectoryLookup CurDir,
SourceLocation  Loc 
)

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 70 of file PPLexerChange.cpp.

References Diag(), and clang::PPCallbacks::EnterFile.

Referenced by EnterMainSourceFile().

◆ EnterSubmodule()

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

◆ EnterToken()

void clang::Preprocessor::EnterToken ( const Token Tok)
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.

Definition at line 1252 of file Preprocessor.h.

References clang::format::Tok.

Referenced by FixDigraph(), isFoldOperator(), LexOnOffSwitch(), ParseAlignPragma(), clang::Parser::ParseTopLevelDecl(), and clang::Parser::TryAnnotateTypeOrScopeToken().

◆ EnterTokenStream() [1/2]

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

Definition at line 1089 of file Preprocessor.h.

◆ EnterTokenStream() [2/2]

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

Definition at line 1093 of file Preprocessor.h.

◆ EraseCachedTokens()

void Preprocessor::EraseCachedTokens ( CachedTokensRange  TokenRange)

Erase the range of cached tokens that were lexed since EnableBacktrackAtThisPos() was previously called.

Definition at line 44 of file PPCaching.cpp.

References clang::Preprocessor::CachedTokensRange::Begin, and clang::Preprocessor::CachedTokensRange::End.

Referenced by Backtrack(), and clang::PragmaNamespace::HandlePragma().

◆ FinalizeForModelFile()

void Preprocessor::FinalizeForModelFile ( )

Cleanup after model file parsing.

Definition at line 217 of file Preprocessor.cpp.

◆ FinishLexStringLiteral()

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

◆ getAuxTargetInfo()

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

Definition at line 730 of file Preprocessor.h.

◆ getBuiltinInfo()

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

Definition at line 739 of file Preprocessor.h.

References BuiltinInfo.

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

◆ 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 1357 of file Preprocessor.h.

Referenced by isEndOfBlockCommentWithEscapedNewLine(), clang::PTHLexer::Lex(), and clang::Lexer::ReadToEndOfLine().

◆ getCodeCompletionFilter()

StringRef clang::Preprocessor::getCodeCompletionFilter ( )
inline

Get the code completion token for filtering purposes.

Definition at line 1036 of file Preprocessor.h.

References clang::IdentifierInfo::getName().

◆ getCodeCompletionHandler()

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

Retrieve the current code-completion handler.

Definition at line 1017 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 1351 of file Preprocessor.h.

Referenced by findPlaceholderEnd().

◆ getCommentRetentionState()

bool clang::Preprocessor::getCommentRetentionState ( ) const
inline

◆ getCounterValue()

unsigned clang::Preprocessor::getCounterValue ( ) const
inline

Definition at line 1696 of file Preprocessor.h.

Referenced by shouldIgnoreMacro().

◆ GetCurDirLookup()

const DirectoryLookup* clang::Preprocessor::GetCurDirLookup ( )
inline

Get the DirectoryLookup structure used to find the current FileEntry, if CurLexer is non-null and if applicable.

This allows us to implement #include_next and find directory-specific properties.

Definition at line 1734 of file Preprocessor.h.

References clang::prec::Conditional, End, clang::FileID::isInvalid(), clang::Lexer::isPragmaLexer(), clang::MU_Other, and P.

Referenced by EvaluateHasIncludeNext().

◆ 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 51 of file PPLexerChange.cpp.

Referenced by ExpectFeatureIdentifierInfo(), and LookupFile().

◆ 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 804 of file Preprocessor.h.

Referenced by EvaluateHasIncludeCommon(), and EvaluateHasIncludeNext().

◆ 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 814 of file Preprocessor.h.

Referenced by EvaluateHasIncludeNext().

◆ getCurrentModule()

Module * Preprocessor::getCurrentModule ( )

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

Definition at line 496 of file Preprocessor.cpp.

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

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), LookupFile(), and markIdentifierFromAST().

◆ getDiagnostics()

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

◆ getExternalSource()

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

Definition at line 750 of file Preprocessor.h.

Referenced by getFutureCompatDiagKind(), and isTrivialSingleTokenExpansion().

◆ getFileManager()

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

Definition at line 731 of file Preprocessor.h.

Referenced by clang::CacheTokens(), EnableCodeCompletion(), and getNumberOfModules().

◆ getHeaderSearchInfo()

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

◆ getIdentifierInfo()

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

◆ getIdentifierTable() [1/2]

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

◆ getIdentifierTable() [2/2]

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

Definition at line 737 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 1512 of file Preprocessor.h.

Referenced by lookThroughRangesV3Condition().

◆ 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 1454 of file PPDirectives.cpp.

Referenced by checkModuleIsAvailable(), DetectEOL(), and EvaluateHasIncludeCommon().

◆ getLangOpts()

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

◆ 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 1273 of file Preprocessor.h.

Referenced by IsPreviousCachedToken().

◆ 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 348 of file Preprocessor.cpp.

Referenced by DiagnoseCallingConvCast(), clang::Sema::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 939 of file Preprocessor.h.

References clang::IdentifierInfo::isOutOfDate().

◆ 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 887 of file Preprocessor.h.

References clang::MacroDirective::getDefinition(), clang::IdentifierInfo::hasMacroDefinition(), and clang::MacroDirective::DefInfo::isUndefined().

Referenced by ReadLineMarkerFlags().

◆ 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().

◆ 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
Offsetan 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 1540 of file Preprocessor.h.

Referenced by AuditedType(), clang::arcmt::ObjCMigrateAction::BeginInvocation(), clang::Parser::Diag(), EvaluateHasIncludeCommon(), ExpectFeatureIdentifierInfo(), clang::Parser::getEndOfPreviousToken(), IsCommonTypo(), and clang::Parser::ParseTopLevelDecl().

◆ getMacroDefinition()

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

◆ getMacroDefinitionAtLoc()

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

Definition at line 870 of file Preprocessor.h.

References clang::IdentifierInfo::hadMacroDefinition().

Referenced by hasSuperInitCall().

◆ getMacroInfo() [1/2]

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

◆ getMacroInfo() [2/2]

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

◆ getModuleForLocation()

Module * Preprocessor::getModuleForLocation ( SourceLocation  Loc)

◆ getModuleHeaderToIncludeForDiagnostics()

const FileEntry * Preprocessor::getModuleHeaderToIncludeForDiagnostics ( SourceLocation  IncLoc,
Module M,
SourceLocation  MLoc 
)

We want to produce a diagnostic at location IncLoc concerning a missing module import.

Parameters
IncLocThe location at which the missing import was detected.
MThe desired module.
MLocA location within the desired module at which some desired effect occurred (eg, where a desired entity was declared).
Returns
A file that can be #included to import a module containing MLoc. Null if no such file could be determined or if a #include is not appropriate.

Definition at line 659 of file PPDirectives.cpp.

References clang::ModuleMap::findAllModulesForHeader(), clang::SourceManager::getExpansionLoc(), clang::SourceManager::getFileEntryForID(), clang::SourceManager::getFileID(), clang::SourceManager::getIncludeLoc(), getLangOpts(), getModuleForLocation(), clang::HeaderSearch::getModuleMap(), getSourceManager(), clang::Module::getTopLevelModule(), clang::SourceManager::isInMainFile(), clang::SourceLocation::isInvalid(), SM, and clang::ModuleMap::TextualHeader.

◆ getModuleImportLoc()

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

Definition at line 1154 of file Preprocessor.h.

◆ getModuleLoader()

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

Retrieve the module loader associated with this preprocessor.

Definition at line 755 of file Preprocessor.h.

Referenced by clang::PCHGenerator::HandleTranslationUnit(), and LexOnOffSwitch().

◆ getModuleMacro()

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

◆ getPCMCache()

MemoryBufferCache& clang::Preprocessor::getPCMCache ( ) const
inline

◆ 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 824 of file Preprocessor.h.

Referenced by EvaluateDefined(), LexOnOffSwitch(), and ParseAlignPragma().

◆ getPragmaARCCFCodeAuditedLoc()

SourceLocation clang::Preprocessor::getPragmaARCCFCodeAuditedLoc ( ) 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 1377 of file Preprocessor.h.

Referenced by clang::Sema::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 1391 of file Preprocessor.h.

◆ getPragmasEnabled()

bool clang::Preprocessor::getPragmasEnabled ( ) const
inline

Definition at line 775 of file Preprocessor.h.

◆ getPreambleConditionalStack()

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

Definition at line 2014 of file Preprocessor.h.

Referenced by shouldIgnoreMacro().

◆ getPredefines()

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

Definition at line 968 of file Preprocessor.h.

◆ getPredefinesFileID()

FileID clang::Preprocessor::getPredefinesFileID ( ) const
inline

Returns the FileID for the preprocessor predefines.

Definition at line 817 of file Preprocessor.h.

Referenced by checkConfigMacro(), isConfigurationPattern(), clang::RewriteIncludesInInput(), and shouldIgnoreMacro().

◆ getPreprocessingRecord()

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

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

Definition at line 1044 of file Preprocessor.h.

Referenced by shouldIgnoreMacro().

◆ getPreprocessorAllocator()

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

◆ getPreprocessorOpts()

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

Retrieve the preprocessor options used to initialize this preprocessor.

Definition at line 723 of file Preprocessor.h.

Referenced by findPlaceholderEnd().

◆ getPTHManager()

PTHManager* clang::Preprocessor::getPTHManager ( )
inline

Definition at line 744 of file Preprocessor.h.

References clang::PTHManager::get().

◆ 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 1481 of file Preprocessor.h.

Referenced by AuditedType(), and UseNSOptionsMacro().

◆ getSelectorTable()

SelectorTable& clang::Preprocessor::getSelectorTable ( )
inline

◆ getSourceManager()

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

Definition at line 732 of file Preprocessor.h.

Referenced by addConstexprToLambdaDeclSpecifier(), AddFunctionParameterChunks(), clang::DependencyCollector::attachToPreprocessor(), clang::ModuleDependencyCollector::attachToPreprocessor(), AuditedType(), clang::TokenConcatenation::AvoidConcat(), clang::arcmt::ObjCMigrateAction::BeginInvocation(), clang::VerifyDiagnosticConsumer::BeginSourceFile(), clang::CacheTokens(), clang::CharLiteralParser::CharLiteralParser(), checkConfigMacro(), clang::Lexer::Create_PragmaLexer(), clang::CompilerInstance::createASTContext(), clang::PTHManager::CreateLexer(), createPreprocessingRecord(), DetectEOL(), clang::DoPrintPreprocessedInput(), clang::DoRewriteTest(), emitPremigrationErrors(), EvaluateDefined(), clang::DumpRawTokensAction::ExecuteAction(), clang::PreprocessorLexer::getFileEntry(), GetFirstChar(), GetMappedTokenLoc(), getModuleHeaderToIncludeForDiagnostics(), clang::VerifyDiagnosticConsumer::HandleComment(), clang::html::HighlightMacros(), clang::TokenLexer::Init(), isConfigurationPattern(), isFoldOperator(), clang::TokenLexer::isParsingPreprocessorDirective(), IsPreviousCachedToken(), IsStringPrefix(), clang::TokenLexer::Lex(), LexRawTokensFromMainFile(), LookUpIdentifierInfo(), clang::PreprocessorLexer::PreprocessorLexer(), clang::PTHLexer::PTHLexer(), ReadLineMarkerFlags(), clang::RewriteIncludesInInput(), clang::RewriteMacrosInInput(), SelectDigraphErrorMessage(), shouldIgnoreMacro(), clang::html::SyntaxHighlight(), updateConsecutiveMacroArgTokens(), and UseNSOptionsMacro().

◆ getSpelling() [1/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
bufferA buffer which will be used only if the token requires "cleaning", e.g. if it contains trigraphs or escaped newlines
invalidIf non-null, will be set true if an error occurs.

Definition at line 1436 of file Preprocessor.h.

Referenced by buildMSAsmString(), CheckEndOfDirective(), checkModuleIsAvailable(), ConcatenateIncludeName(), DetectEOL(), DumpToken(), EvaluateHasIncludeCommon(), EvaluateValue(), GetLineValue(), IsCommonTypo(), isFoldOperator(), LexOnOffSwitch(), LookUpIdentifierInfo(), ParseLoopHintValue(), ParseOpenMPDirectiveKind(), parseSimpleIntegerLiteral(), ReadLineMarkerFlags(), clang::RewriteMacrosInInput(), and clang::MacroArgs::StringifyArgument().

◆ getSpelling() [2/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
InvalidIf non-null, will be set true if an error occurs.

Definition at line 1450 of file Preprocessor.h.

◆ getSpelling() [3/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 1466 of file Preprocessor.h.

◆ getSpelling() [4/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 454 of file Preprocessor.cpp.

◆ getSpellingOfSingleCharacterNumericConstant()

char 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 character.

Definition at line 1489 of file Preprocessor.h.

References clang::SourceManager::getCharacterData(), clang::Token::getLength(), clang::Token::getLiteralData(), clang::Token::getLocation(), clang::Token::is(), and clang::Token::needsCleaning().

◆ GetSuppressIncludeNotFoundError()

bool clang::Preprocessor::GetSuppressIncludeNotFoundError ( )
inline

Definition at line 781 of file Preprocessor.h.

◆ getTargetInfo()

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

◆ getTotalMemory()

size_t Preprocessor::getTotalMemory ( ) const

Definition at line 318 of file Preprocessor.cpp.

Referenced by PrintStats().

◆ hadModuleLoaderFatalFailure()

bool clang::Preprocessor::hadModuleLoaderFatalFailure ( ) const
inline

Definition at line 757 of file Preprocessor.h.

References clang::ModuleLoader::HadFatalFailure.

◆ HandleComment()

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

Definition at line 943 of file Preprocessor.cpp.

References getCommentRetentionState(), and Lex().

Referenced by isEndOfBlockCommentWithEscapedNewLine().

◆ 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 867 of file PPDirectives.cpp.

References Diag(), DiscardUntilEndOfDirective(), clang::Token::getIdentifierInfo(), clang::Token::getKind(), getLangOpts(), clang::Token::getLocation(), clang::IdentifierInfo::getPPKeywordID(), clang::Token::is(), LexUnexpandedToken(), clang::PIK_HashPragma, clang::Result, and setCodeCompletionReached().

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

◆ 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 335 of file PPLexerChange.cpp.

References clang::FixItHint::CreateReplacement(), Diag(), clang::comments::tok::eof, clang::PPCallbacks::ExitFile, clang::Token::getLocation(), clang::SourceLocation::getLocWithOffset(), isMacroDefined(), max(), clang::Token::setAnnotationEndLoc(), clang::Token::setAnnotationValue(), clang::Token::setLocation(), clang::Token::startToken(), and clang::TU_Complete.

Referenced by clang::PTHLexer::Lex(), and clang::Lexer::ReadToEndOfLine().

◆ 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 562 of file PPLexerChange.cpp.

Referenced by 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 663 of file Preprocessor.cpp.

References Diag(), clang::Token::DisableExpand, getFutureCompatDiagKind(), clang::Token::getIdentifierInfo(), getLangOpts(), clang::Token::getLocation(), getMacroDefinition(), HandlePoisonedIdentifier(), clang::Token::is(), clang::Token::isExpandDisabled(), clang::IdentifierInfo::isPoisoned(), clang::Token::setFlag(), and clang::Token::setKind().

Referenced by clang::PTHLexer::Lex(), clang::TokenLexer::Lex(), and maybeDiagnoseIDCharCompat().

◆ 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 600 of file PPLexerChange.cpp.

References clang::comments::tok::eof, clang::Token::is(), clang::Token::isNot(), clang::PreprocessorLexer::LexingRawMode, and clang::PreprocessorLexer::ParsingPreprocessorDirective.

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

◆ HandlePoisonedIdentifier()

void Preprocessor::HandlePoisonedIdentifier ( Token Tok)

Display reason for poisoned identifier.

Definition at line 620 of file Preprocessor.cpp.

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

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

◆ HandlePragmaDependency()

void Preprocessor::HandlePragmaDependency ( Token DependencyTok)

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

Definition at line 486 of file Pragma.cpp.

References Diag(), Filename, clang::Token::getLocation(), clang::FileEntry::getModificationTime(), clang::Token::is(), and clang::Token::isNot().

Referenced by LexOnOffSwitch().

◆ HandlePragmaIncludeAlias()

void Preprocessor::HandlePragmaIncludeAlias ( Token Tok)

Definition at line 653 of file Pragma.cpp.

References Diag(), End, clang::Token::getLocation(), clang::Token::is(), and clang::Token::isNot().

Referenced by LexOnOffSwitch().

◆ HandlePragmaMark()

void Preprocessor::HandlePragmaMark ( )

Definition at line 400 of file Pragma.cpp.

Referenced by LexOnOffSwitch().

◆ HandlePragmaModuleBuild()

void Preprocessor::HandlePragmaModuleBuild ( Token Tok)

◆ HandlePragmaOnce()

void Preprocessor::HandlePragmaOnce ( Token OnceTok)

HandlePragmaOnce - Handle #pragma once.

OnceTok is the 'once'.

Definition at line 385 of file Pragma.cpp.

References Diag(), IsHeaderFile(), and clang::TU_Prefix.

Referenced by LexOnOffSwitch().

◆ HandlePragmaPoison()

void Preprocessor::HandlePragmaPoison ( )

◆ HandlePragmaPopMacro()

void Preprocessor::HandlePragmaPopMacro ( Token PopMacroTok)

Handle #pragma pop_macro.

The syntax is:

#pragma pop_macro("macro")

Definition at line 618 of file Pragma.cpp.

References Diag(), clang::Token::getLocation(), and clang::IdentifierInfo::getName().

◆ HandlePragmaPushMacro()

void Preprocessor::HandlePragmaPushMacro ( Token PushMacroTok)

Handle #pragma push_macro.

The syntax is:

#pragma push_macro("macro")

Definition at line 595 of file Pragma.cpp.

References 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 452 of file Pragma.cpp.

References clang::SrcMgr::C_System, Diag(), clang::PreprocessorLexer::getFileEntry(), clang::PresumedLoc::getFilename(), clang::PresumedLoc::getLine(), clang::Token::getLocation(), clang::PresumedLoc::isInvalid(), and clang::PPCallbacks::SystemHeaderPragma.

Referenced by LexOnOffSwitch().

◆ hasRecordedPreamble()

bool clang::Preprocessor::hasRecordedPreamble ( ) const
inline

Definition at line 2010 of file Preprocessor.h.

Referenced by shouldIgnoreMacro().

◆ 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 1837 of file Pragma.cpp.

References clang::EmptyPragmaHandler::EmptyPragmaHandler(), clang::PragmaNamespace::FindHandler(), and clang::PragmaNamespace::getIfNamespace().

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 1582 of file Preprocessor.h.

◆ Initialize()

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

Initialize the preprocessor using information about the target.

Parameters
Targetis owned by the caller and must remain valid for the lifetime of the preprocessor.
AuxTargetis owned by the caller and must remain valid for the lifetime of the preprocessor.

Definition at line 190 of file Preprocessor.cpp.

References clang::Builtin::Context::InitializeTarget(), and clang::HeaderSearch::setTarget().

◆ 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 205 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
MacroEndIf non-null and function returns true, it is set to end location of the macro.

Definition at line 1560 of file Preprocessor.h.

◆ 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
MacroBeginIf non-null and function returns true, it is set to begin location of the macro.

Definition at line 1549 of file Preprocessor.h.

Referenced by isFoldOperator().

◆ isBacktrackEnabled()

bool clang::Preprocessor::isBacktrackEnabled ( ) const
inline

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

Definition at line 1145 of file Preprocessor.h.

Referenced by Backtrack(), LastCachedTokenRange(), and clang::Parser::ParseTopLevelDecl().

◆ isCodeCompletionEnabled()

bool clang::Preprocessor::isCodeCompletionEnabled ( ) const
inline

Determine if we are performing code completion.

Definition at line 1345 of file Preprocessor.h.

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), findPlaceholderEnd(), and clang::Parser::Parser().

◆ 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 1363 of file Preprocessor.h.

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

◆ isCurrentLexer()

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

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

Definition at line 796 of file Preprocessor.h.

◆ isIncrementalProcessingEnabled()

bool clang::Preprocessor::isIncrementalProcessingEnabled ( ) const
inline

Returns true if incremental processing is enabled.

Definition at line 1320 of file Preprocessor.h.

Referenced by clang::Sema::ActOnEndOfTranslationUnit(), clang::Parser::ParseTopLevelDecl(), and clang::Parser::~Parser().

◆ 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 36 of file PPLexerChange.cpp.

Referenced by EvaluateHasIncludeNext(), and clang::Lexer::ReadToEndOfLine().

◆ isMacroDefined() [1/2]

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

◆ isMacroDefined() [2/2]

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

Definition at line 836 of file Preprocessor.h.

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

◆ 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 844 of file Preprocessor.h.

References clang::IdentifierInfo::hasMacroDefinition().

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

◆ isParsingIfOrElifDirective()

bool clang::Preprocessor::isParsingIfOrElifDirective ( ) const
inline

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

Definition at line 762 of file Preprocessor.h.

Referenced by EvaluateHasIncludeCommon().

◆ 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 793 of file Preprocessor.h.

Referenced by findPlaceholderEnd(), and LexOnOffSwitch().

◆ IsPreviousCachedToken()

bool Preprocessor::IsPreviousCachedToken ( const Token Tok) const

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

Definition at line 150 of file PPCaching.cpp.

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

◆ isRecordingPreamble()

bool clang::Preprocessor::isRecordingPreamble ( ) const
inline

Definition at line 2006 of file Preprocessor.h.

Referenced by clang::Lexer::ReadToEndOfLine(), and shouldIgnoreMacro().

◆ LastCachedTokenRange()

Preprocessor::CachedTokensRange Preprocessor::LastCachedTokenRange ( )

Returns the range of cached tokens that were lexed since EnableBacktrackAtThisPos() was previously called.

Definition at line 38 of file PPCaching.cpp.

References isBacktrackEnabled().

Referenced by clang::PragmaNamespace::HandlePragma().

◆ LeaveSubmodule()

Module * Preprocessor::LeaveSubmodule ( bool  ForPragma)

Definition at line 732 of file PPLexerChange.cpp.

References clang::Module::getTopLevelModuleName().

◆ Lex()

void Preprocessor::Lex ( Token Result)

◆ LexAfterModuleImport()

void Preprocessor::LexAfterModuleImport ( Token Result)

◆ 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 1182 of file Preprocessor.h.

References clang::Token::getKind().

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

◆ LexOnOffSwitch()

bool Preprocessor::LexOnOffSwitch ( tok::OnOffSwitch OOS)

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 933 of file Pragma.cpp.

References CheckEndOfDirective(), Diag(), Diag(), DiscardUntilEndOfDirective(), dumpMacroInfo(), EnterAnnotationToken(), EnterToken(), clang::diag::Error, clang::diag::Fatal, FinishLexStringLiteral(), getDiagnostics(), clang::Token::getIdentifierInfo(), clang::Token::getKind(), clang::Token::getLocation(), getModuleLoader(), clang::IdentifierInfo::getName(), getPPCallbacks(), getPreprocessorAllocator(), getSpelling(), clang::EmptyPragmaHandler::HandlePragma(), HandlePragmaDependency(), HandlePragmaIncludeAlias(), HandlePragmaMark(), HandlePragmaOnce(), HandlePragmaPoison(), HandlePragmaSystemHeader(), clang::Module::Hidden, clang::diag::Ignored, clang::Token::is(), clang::Token::isNot(), isPreprocessedOutput(), clang::IdentifierInfo::isStr(), Lex(), LexModuleName(), LexUnexpandedToken(), clang::ModuleLoader::loadModule(), makeModuleVisible(), max(), clang::tok::OOS_DEFAULT, clang::tok::OOS_OFF, clang::tok::OOS_ON, P, parseSimpleIntegerLiteral(), clang::PPCallbacks::PMK_Error, clang::PPCallbacks::PMK_Message, clang::PPCallbacks::PMK_Warning, clang::DiagnosticsEngine::popMappings(), clang::PPCallbacks::PragmaDebug(), clang::PPCallbacks::PragmaDiagnostic(), clang::PPCallbacks::PragmaDiagnosticPop(), clang::PPCallbacks::PragmaDiagnosticPush(), clang::PragmaHandler::PragmaHandler(), clang::PPCallbacks::PragmaWarning(), clang::PPCallbacks::PragmaWarningPop(), clang::PPCallbacks::PragmaWarningPush(), clang::DiagnosticsEngine::pushMappings(), clang::diag::Remark, clang::Token::setAnnotationRange(), clang::Token::setAnnotationValue(), clang::Token::setKind(), clang::DiagnosticsEngine::setSeverityForAll(), clang::DiagnosticsEngine::setSeverityForGroup(), Specifier, clang::Token::startToken(), clang::format::Tok, clang::diag::Warning, and clang::diag::WarningOrError.

Referenced by ParseAlignPragma().

◆ 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 1161 of file Preprocessor.h.

◆ LexUnexpandedNonComment()

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

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

Definition at line 1202 of file Preprocessor.h.

References clang::Token::getKind(), and clang::format::Tok.

Referenced by EvaluateDefined().

◆ LexUnexpandedToken()

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

◆ 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 1226 of file Preprocessor.h.

Referenced by clang::Parser::NextToken(), and ParseOpenMPDirectiveKind().

◆ LookupFile()

const FileEntry * Preprocessor::LookupFile ( SourceLocation  FilenameLoc,
StringRef  Filename,
bool  isAngled,
const DirectoryLookup FromDir,
const FileEntry FromFile,
const DirectoryLookup *&  CurDir,
SmallVectorImpl< char > *  SearchPath,
SmallVectorImpl< char > *  RelativePath,
ModuleMap::KnownHeader SuggestedModule,
bool IsMapped,
bool  SkipCache = false 
)

◆ 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 569 of file Preprocessor.cpp.

References clang::expandUCNs(), getIdentifierInfo(), getLangOpts(), clang::Token::getLocation(), clang::Token::getRawIdentifier(), getSourceManager(), getSpelling(), clang::Token::hasUCN(), clang::SourceManager::isInSystemHeader(), clang::Token::needsCleaning(), clang::Token::setIdentifierInfo(), and clang::Token::setKind().

Referenced by DetectEOL(), findPlaceholderEnd(), clang::html::HighlightMacros(), LexRawTokensFromMainFile(), maybeDiagnoseIDCharCompat(), and clang::html::SyntaxHighlight().

◆ macro_begin()

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

Definition at line 304 of file Preprocessor.cpp.

References clang::ExternalPreprocessorSource::ReadDefinedMacros().

Referenced by AddMacroResults().

◆ macro_end()

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

Definition at line 331 of file Preprocessor.cpp.

References clang::ExternalPreprocessorSource::ReadDefinedMacros().

Referenced by AddMacroResults().

◆ macros()

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

Definition at line 956 of file Preprocessor.h.

◆ makeModuleVisible()

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

Definition at line 853 of file Preprocessor.cpp.

References Diag().

Referenced by LexAfterModuleImport(), and LexOnOffSwitch().

◆ markMacroAsUsed()

void Preprocessor::markMacroAsUsed ( MacroInfo MI)

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

Definition at line 1906 of file PPMacroExpansion.cpp.

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

Referenced by EvaluateDefined(), isConfigurationPattern(), and isTrivialSingleTokenExpansion().

◆ MaybeHandlePoisonedIdentifier()

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

◆ 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 540 of file Pragma.cpp.

References Diag(), clang::Token::getLocation(), clang::Token::hasUDSuffix(), clang::Token::isNot(), clang::Token::startToken(), and clang::format::Tok.

◆ 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 911 of file Preprocessor.cpp.

References clang::Token::getLocation(), getSpelling(), clang::Token::is(), and Lex().

Referenced by LexOnOffSwitch().

◆ PoisonSEHIdentifiers()

void Preprocessor::PoisonSEHIdentifiers ( bool  Poison = true)

Definition at line 606 of file Preprocessor.cpp.

References clang::IdentifierInfo::setIsPoisoned().

◆ PrintStats()

void Preprocessor::PrintStats ( )

Definition at line 265 of file Preprocessor.cpp.

References getTotalMemory().

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

◆ recomputeCurLexerKind()

void Preprocessor::recomputeCurLexerKind ( )

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

Definition at line 375 of file Preprocessor.cpp.

Referenced by Backtrack(), 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 936 of file Preprocessor.cpp.

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

◆ RemovePragmaHandler() [1/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 911 of file Pragma.cpp.

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

Referenced by clang::DoPrintPreprocessedInput().

◆ RemovePragmaHandler() [2/2]

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

Definition at line 996 of file Preprocessor.h.

◆ 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 583 of file PPLexerChange.cpp.

◆ 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 1297 of file Preprocessor.h.

References clang::Token::isAnnotation().

◆ 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 168 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 1238 of file Preprocessor.h.

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

◆ 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 1693 of file Preprocessor.h.

Referenced by shouldIgnoreMacro().

◆ setCodeCompletionHandler()

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

Set the code completion handler to the given object.

Definition at line 1012 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 1031 of file Preprocessor.h.

Referenced by Lex().

◆ SetCodeCompletionPoint()

bool Preprocessor::SetCodeCompletionPoint ( const FileEntry File,
unsigned  Line,
unsigned  Column 
)

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

Parameters
Filethe 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.
Linethe line at which code completion should occur (1-based).
Columnthe column at which code completion should occur (1-based).
Returns
true if an error occurred, false otherwise.

Definition at line 386 of file Preprocessor.cpp.

Referenced by EnableCodeCompletion().

◆ setCodeCompletionReached()

void clang::Preprocessor::setCodeCompletionReached ( )
inline

Note that we hit the code-completion point.

Definition at line 1366 of file Preprocessor.h.

Referenced by CheckEndOfDirective(), CheckMacroName(), CodeCompleteNaturalLanguage(), ConcatenateIncludeName(), EvaluateDefined(), EvaluateValue(), and HandleDirective().

◆ SetCommentRetentionState()

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

Control whether the preprocessor retains comments in output.

Definition at line 767 of file Preprocessor.h.

Referenced by clang::DoPrintPreprocessedInput().

◆ setCounterValue()

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

Definition at line 1697 of file Preprocessor.h.

References Filename.

◆ setDiagnostics()

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

Definition at line 726 of file Preprocessor.h.

◆ setExternalSource()

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

Definition at line 746 of file Preprocessor.h.

◆ setLoadedMacroDirective()

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

◆ SetMacroExpansionOnlyInDirectives()

void clang::Preprocessor::SetMacroExpansionOnlyInDirectives ( )
inline

Disables macro expansion everywhere except for preprocessor directives.

Definition at line 1214 of file Preprocessor.h.

Referenced by clang::RewriteIncludesInInput().

◆ setMainFileDir()

void clang::Preprocessor::setMainFileDir ( const DirectoryEntry 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 1403 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 602 of file Preprocessor.cpp.

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

◆ setPragmaARCCFCodeAuditedLoc()

void clang::Preprocessor::setPragmaARCCFCodeAuditedLoc ( 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 1383 of file Preprocessor.h.

◆ 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 1397 of file Preprocessor.h.

◆ setPragmasEnabled()

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

Definition at line 774 of file Preprocessor.h.

◆ setPredefines() [1/2]

void clang::Preprocessor::setPredefines ( const char *  P)
inline

Set the predefines for this Preprocessor.

These predefines are automatically injected when parsing the main file.

Definition at line 972 of file Preprocessor.h.

References P.

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

◆ setPredefines() [2/2]

void clang::Preprocessor::setPredefines ( StringRef  P)
inline

Definition at line 973 of file Preprocessor.h.

References P.

◆ 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 787 of file Preprocessor.h.

◆ setPTHManager()

void Preprocessor::setPTHManager ( PTHManager pm)

Definition at line 223 of file Preprocessor.cpp.

References clang::FileManager::addStatCache().

◆ setRecordedPreambleConditionalStack()

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

Definition at line 2018 of file Preprocessor.h.

Referenced by clang::Lexer::ReadToEndOfLine().

◆ setReplayablePreambleConditionalStack()

void clang::Preprocessor::setReplayablePreambleConditionalStack ( ArrayRef< PPConditionalInfo s)
inline

Definition at line 2022 of file Preprocessor.h.

◆ setSkipMainFilePreamble()

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

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

Parameters
BytesThe number of bytes in the preamble to skip.
StartOfLineWhether skipping these bytes puts the lexer at the start of a line.

Definition at line 1413 of file Preprocessor.h.

◆ SetSuppressIncludeNotFoundError()

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

◆ 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 1309 of file Preprocessor.h.

References clang::Token::getIdentifierInfo().

Friends And Related Function Documentation

◆ ASTReader

friend class ASTReader
friend

Definition at line 545 of file Preprocessor.h.

◆ MacroArgs

friend class MacroArgs
friend

Definition at line 615 of file Preprocessor.h.

◆ TokenLexer::ExpandFunctionArguments

void TokenLexer::ExpandFunctionArguments ( )
friend

◆ VAOptDefinitionContext

friend class VAOptDefinitionContext
friend

Definition at line 100 of file Preprocessor.h.

◆ VariadicMacroScopeGuard

friend class VariadicMacroScopeGuard
friend

Definition at line 99 of file Preprocessor.h.

Referenced by isConfigurationPattern().


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