clang  6.0.0svn
Public Member Functions | Friends | List of all members
clang::IdentifierInfo Class Reference

One of these records is kept for each identifier that is lexed. More...

#include "clang/Basic/IdentifierTable.h"

Public Member Functions

 IdentifierInfo ()
 
 IdentifierInfo (const IdentifierInfo &)=delete
 
IdentifierInfooperator= (const IdentifierInfo &)=delete
 
template<std::size_t StrLen>
bool isStr (const char(&Str)[StrLen]) const
 Return true if this is the identifier for the specified string. More...
 
const char * getNameStart () const
 Return the beginning of the actual null-terminated string for this identifier. More...
 
unsigned getLength () const
 Efficiently return the length of this identifier info. More...
 
StringRef getName () const
 Return the actual identifier string. More...
 
bool hasMacroDefinition () const
 Return true if this identifier is #defined to some other value. More...
 
void setHasMacroDefinition (bool Val)
 
bool hadMacroDefinition () const
 Returns true if this identifier was #defined to some value at any moment. More...
 
tok::TokenKind getTokenID () const
 If this is a source-language token (e.g. More...
 
bool hasRevertedTokenIDToIdentifier () const
 True if revertTokenIDToIdentifier() was called. More...
 
void revertTokenIDToIdentifier ()
 Revert TokenID to tok::identifier; used for GNU libstdc++ 4.2 compatibility. More...
 
void revertIdentifierToTokenID (tok::TokenKind TK)
 
tok::PPKeywordKind getPPKeywordID () const
 Return the preprocessor keyword ID for this identifier. More...
 
tok::ObjCKeywordKind getObjCKeywordID () const
 Return the Objective-C keyword ID for the this identifier. More...
 
void setObjCKeywordID (tok::ObjCKeywordKind ID)
 
bool hasRevertedBuiltin () const
 True if setNotBuiltin() was called. More...
 
void revertBuiltin ()
 Revert the identifier to a non-builtin identifier. More...
 
unsigned getBuiltinID () const
 Return a value indicating whether this is a builtin function. More...
 
void setBuiltinID (unsigned ID)
 
unsigned getObjCOrBuiltinID () const
 
void setObjCOrBuiltinID (unsigned ID)
 
bool isExtensionToken () const
 get/setExtension - Initialize information about whether or not this language token is an extension. More...
 
void setIsExtensionToken (bool Val)
 
bool isFutureCompatKeyword () const
 is/setIsFutureCompatKeyword - Initialize information about whether or not this language token is a keyword in a newer or proposed Standard. More...
 
void setIsFutureCompatKeyword (bool Val)
 
void setIsPoisoned (bool Value=true)
 setIsPoisoned - Mark this identifier as poisoned. More...
 
bool isPoisoned () const
 Return true if this token has been poisoned. More...
 
void setIsCPlusPlusOperatorKeyword (bool Val=true)
 isCPlusPlusOperatorKeyword/setIsCPlusPlusOperatorKeyword controls whether this identifier is a C++ alternate representation of an operator. More...
 
bool isCPlusPlusOperatorKeyword () const
 
bool isKeyword (const LangOptions &LangOpts) const
 Return true if this token is a keyword in the specified language. More...
 
bool isCPlusPlusKeyword (const LangOptions &LangOpts) const
 Return true if this token is a C++ keyword in the specified language. More...
 
template<typename T >
T * getFETokenInfo () const
 getFETokenInfo/setFETokenInfo - The language front-end is allowed to associate arbitrary metadata with this token. More...
 
void setFETokenInfo (void *T)
 
bool isHandleIdentifierCase () const
 Return true if the Preprocessor::HandleIdentifier must be called on a token of this identifier. More...
 
bool isFromAST () const
 Return true if the identifier in its current state was loaded from an AST file. More...
 
void setIsFromAST ()
 
bool hasChangedSinceDeserialization () const
 Determine whether this identifier has changed since it was loaded from an AST file. More...
 
void setChangedSinceDeserialization ()
 Note that this identifier has changed since it was loaded from an AST file. More...
 
bool hasFETokenInfoChangedSinceDeserialization () const
 Determine whether the frontend token information for this identifier has changed since it was loaded from an AST file. More...
 
void setFETokenInfoChangedSinceDeserialization ()
 Note that the frontend token information for this identifier has changed since it was loaded from an AST file. More...
 
bool isOutOfDate () const
 Determine whether the information for this identifier is out of date with respect to the external source. More...
 
void setOutOfDate (bool OOD)
 Set whether the information for this identifier is out of date with respect to the external source. More...
 
bool isModulesImport () const
 Determine whether this is the contextual keyword import. More...
 
void setModulesImport (bool I)
 Set whether this identifier is the contextual keyword import. More...
 
bool isEditorPlaceholder () const
 Return true if this identifier is an editor placeholder. More...
 
bool operator< (const IdentifierInfo &RHS) const
 Provide less than operator for lexicographical sorting. More...
 

Friends

class IdentifierTable
 

Detailed Description

One of these records is kept for each identifier that is lexed.

This contains information about whether the token was #define'd, is a language keyword, or if it is a front-end token of some sort (e.g. a variable or function name). The preprocessor keeps this information in a set, and all tok::identifier tokens have a pointer to one of these.

Definition at line 56 of file IdentifierTable.h.

Constructor & Destructor Documentation

◆ IdentifierInfo() [1/2]

IdentifierInfo::IdentifierInfo ( )

Definition at line 33 of file IdentifierTable.cpp.

◆ IdentifierInfo() [2/2]

clang::IdentifierInfo::IdentifierInfo ( const IdentifierInfo )
delete

Member Function Documentation

◆ getBuiltinID()

unsigned clang::IdentifierInfo::getBuiltinID ( ) const
inline

Return a value indicating whether this is a builtin function.

0 is not-built-in. 1+ are specific builtin functions.

Definition at line 217 of file IdentifierTable.h.

References clang::tok::NUM_OBJC_KEYWORDS.

Referenced by ExpectFeatureIdentifierInfo(), clang::FunctionDecl::getBuiltinID(), clang::ASTImporter::Import(), LookupBuiltin(), ParseLoopHintValue(), and clang::serialization::reader::ASTIdentifierLookupTrait::ReadData().

◆ getFETokenInfo()

template<typename T >
T* clang::IdentifierInfo::getFETokenInfo ( ) const
inline

getFETokenInfo/setFETokenInfo - The language front-end is allowed to associate arbitrary metadata with this token.

Definition at line 288 of file IdentifierTable.h.

Referenced by getDeclForLocalLookup(), and isInterestingIdentifier().

◆ getLength()

unsigned clang::IdentifierInfo::getLength ( ) const
inline

Efficiently return the length of this identifier info.

Definition at line 121 of file IdentifierTable.h.

Referenced by getDeclForLocalLookup(), getStandardSelLoc(), clang::Sema::isCurrentClassNameTypo(), and isReservedName().

◆ getName()

StringRef clang::IdentifierInfo::getName ( ) const
inline

Return the actual identifier string.

Definition at line 134 of file IdentifierTable.h.

Referenced by clang::Sema::ActOnPragmaVisibility(), clang::Sema::ActOnTemplateIdType(), clang::ODRHash::AddIdentifierInfo(), appendEnumType(), appendRecordType(), clang::ento::AnyFunctionCall::argumentsMayEscape(), attributeHasIdentifierArg(), attributeIsTypeArgAttr(), attributeParsedArgsUnevaluated(), CheckArrayDesignatorSyntax(), CheckAvailabilitySpecList(), clang::Sema::checkStringLiteralArgumentAttr(), clang::DeclarationName::compare(), DetectEOL(), DiagnoseNamespaceInlineMismatch(), distributeNullabilityTypeAttr(), EvaluateHasIncludeCommon(), ExpectFeatureIdentifierInfo(), findKnownClass(), clang::ento::coreFoundation::followsCreateRule(), FormatFunctionParameter(), clang::index::generateUSRForMacro(), clang::index::CodegenNameGenerator::Implementation::getAllManglings(), clang::Selector::getAsString(), getCalleeName(), clang::ento::CheckerContext::getCalleeName(), getCCTypeAttrKind(), clang::Preprocessor::getCodeCompletionFilter(), getDeclForLocalLookup(), clang::arcmt::getFileRemappings(), getFutureCompatDiagKind(), getIdentifier(), clang::ento::ExprEngine::getInitialState(), clang::Selector::getInstTypeMethodFamily(), clang::MacroExpansion::getName(), clang::Selector::getNameForSlot(), getOrderedName(), clang::getParameterABISpelling(), handleObjCOwnershipTypeAttr(), clang::PragmaNamespace::HandlePragma(), clang::Preprocessor::HandlePragmaModuleBuild(), clang::Preprocessor::HandlePragmaPopMacro(), clang::ASTImporter::Import(), clang::CallGraph::includeInGraph(), InNamespace(), isAttributeLateParsed(), IsBuiltInOrStandardCXX11Attribute(), isCharSpecialization(), clang::ento::cocoa::isCocoaObjectRef(), isConfigurationPattern(), clang::Sema::isCurrentClassNameTypo(), clang::PrintingCodeCompleteConsumer::isResultFilteredOut(), clang::Preprocessor::LexOnOffSwitch(), clang::ASTUnit::LoadFromASTFile(), LookupMethodInReceiverType(), clang::MacroPPCallbacks::MacroUndefined(), clang::MangleContext::mangleGlobalBlock(), clang::MangleContext::mangleName(), clang::Sema::mergeAvailabilityAttr(), clang::analyze_format_string::FormatSpecifier::namedTypeToLengthModifier(), operator<(), ParseAlignPragma(), parseDeclareSimdClauses(), ParseLoopHintValue(), clang::Parser::ParseMSAsmIdentifier(), PragmaLoopHintString(), clang::NestedNameSpecifier::print(), PrintFloatingLiteral(), PrintMacroDefinition(), clang::RewriteMacrosInInput(), rewriteToNSEnumDecl(), rewriteToNSMacroDecl(), shouldWarnOnMacroDef(), shouldWarnOnMacroUndef(), startsWithWord(), SymbolNameForMethod(), TryNamespaceTypoCorrection(), and clang::ASTReader::updateOutOfDateIdentifier().

◆ getNameStart()

const char* clang::IdentifierInfo::getNameStart ( ) const
inline

Return the beginning of the actual null-terminated string for this identifier.

Definition at line 108 of file IdentifierTable.h.

Referenced by clang::Preprocessor::checkModuleIsAvailable(), clang::PTHManager::Create(), diagnoseRedundantPropertyNullability(), clang::Preprocessor::dumpMacroInfo(), and getDeclForLocalLookup().

◆ getObjCKeywordID()

tok::ObjCKeywordKind clang::IdentifierInfo::getObjCKeywordID ( ) const
inline

Return the Objective-C keyword ID for the this identifier.

For example, 'class' will return tok::objc_class if ObjC is enabled.

Definition at line 194 of file IdentifierTable.h.

References clang::tok::NUM_OBJC_KEYWORDS.

Referenced by clang::Token::getObjCKeywordID(), and maybeDiagnoseIDCharCompat().

◆ getObjCOrBuiltinID()

unsigned clang::IdentifierInfo::getObjCOrBuiltinID ( ) const
inline

◆ getPPKeywordID()

tok::PPKeywordKind IdentifierInfo::getPPKeywordID ( ) const

Return the preprocessor keyword ID for this identifier.

For example, "define" will return tok::pp_define.

Definition at line 274 of file IdentifierTable.cpp.

Referenced by clang::Preprocessor::CheckEndOfDirective(), clang::Preprocessor::CheckMacroName(), clang::Preprocessor::HandleDirective(), clang::format::FormatToken::is(), and maybeDiagnoseIDCharCompat().

◆ getTokenID()

tok::TokenKind clang::IdentifierInfo::getTokenID ( ) const
inline

If this is a source-language token (e.g.

'for'), this API can be used to cause the lexer to map identifiers to source-language tokens.

Definition at line 164 of file IdentifierTable.h.

Referenced by DiagnoseCallingConvCast(), ExpectFeatureIdentifierInfo(), clang::PTHLexer::Lex(), clang::TokenLexer::Lex(), maybeDiagnoseIDCharCompat(), and clang::serialization::reader::ASTIdentifierLookupTrait::ReadData().

◆ hadMacroDefinition()

bool clang::IdentifierInfo::hadMacroDefinition ( ) const
inline

Returns true if this identifier was #defined to some value at any moment.

In this case there should be an entry for the identifier in the macro history table in Preprocessor.

Definition at line 157 of file IdentifierTable.h.

Referenced by checkConfigMacro(), clang::Preprocessor::getLocalMacroDirectiveHistory(), clang::Preprocessor::getMacroDefinitionAtLoc(), and isInterestingIdentifier().

◆ hasChangedSinceDeserialization()

bool clang::IdentifierInfo::hasChangedSinceDeserialization ( ) const
inline

Determine whether this identifier has changed since it was loaded from an AST file.

Definition at line 306 of file IdentifierTable.h.

◆ hasFETokenInfoChangedSinceDeserialization()

bool clang::IdentifierInfo::hasFETokenInfoChangedSinceDeserialization ( ) const
inline

Determine whether the frontend token information for this identifier has changed since it was loaded from an AST file.

Definition at line 318 of file IdentifierTable.h.

◆ hasMacroDefinition()

bool clang::IdentifierInfo::hasMacroDefinition ( ) const
inline

Return true if this identifier is #defined to some other value.

Note
The current definition may be in a module and not currently visible.

Definition at line 140 of file IdentifierTable.h.

Referenced by clang::Preprocessor::getLocalMacroDirective(), clang::Preprocessor::getMacroDefinition(), clang::Preprocessor::getMacroInfo(), clang::NSAPI::isMacroDefined(), clang::Preprocessor::isMacroDefined(), and clang::Preprocessor::isMacroDefinedInLocalModule().

◆ hasRevertedBuiltin()

bool clang::IdentifierInfo::hasRevertedBuiltin ( ) const
inline

◆ hasRevertedTokenIDToIdentifier()

bool clang::IdentifierInfo::hasRevertedTokenIDToIdentifier ( ) const
inline

True if revertTokenIDToIdentifier() was called.

Definition at line 167 of file IdentifierTable.h.

Referenced by getDeclForLocalLookup(), and isInterestingIdentifier().

◆ isCPlusPlusKeyword()

bool IdentifierInfo::isCPlusPlusKeyword ( const LangOptions LangOpts) const

Return true if this token is a C++ keyword in the specified language.

Returns true if the identifier represents a C++ keyword in the specified language.

Definition at line 262 of file IdentifierTable.cpp.

Referenced by getMissingDeclaratorIdLoc().

◆ isCPlusPlusOperatorKeyword()

bool clang::IdentifierInfo::isCPlusPlusOperatorKeyword ( ) const
inline

◆ isEditorPlaceholder()

bool clang::IdentifierInfo::isEditorPlaceholder ( ) const
inline

Return true if this identifier is an editor placeholder.

Editor placeholders are produced by the code-completion engine and are represented as characters between '<#' and '#>' in the source code. An example of auto-completed call with a placeholder parameter is shown below:

function(<#int x#>);

Definition at line 363 of file IdentifierTable.h.

◆ isExtensionToken()

bool clang::IdentifierInfo::isExtensionToken ( ) const
inline

get/setExtension - Initialize information about whether or not this language token is an extension.

This controls extension warnings, and is only valid if a custom token ID is set.

Definition at line 235 of file IdentifierTable.h.

Referenced by getDeclForLocalLookup(), and clang::serialization::reader::ASTIdentifierLookupTrait::ReadData().

◆ isFromAST()

bool clang::IdentifierInfo::isFromAST ( ) const
inline

Return true if the identifier in its current state was loaded from an AST file.

Definition at line 300 of file IdentifierTable.h.

Referenced by clang::Preprocessor::appendMacroDirective(), clang::Preprocessor::HandlePragmaPoison(), and markIdentifierFromAST().

◆ isFutureCompatKeyword()

bool clang::IdentifierInfo::isFutureCompatKeyword ( ) const
inline

is/setIsFutureCompatKeyword - Initialize information about whether or not this language token is a keyword in a newer or proposed Standard.

This controls compatibility warnings, and is only true when not parsing the corresponding Standard. Once a compatibility problem has been diagnosed with this keyword, the flag will be cleared.

Definition at line 249 of file IdentifierTable.h.

Referenced by getFutureCompatDiagKind().

◆ isHandleIdentifierCase()

bool clang::IdentifierInfo::isHandleIdentifierCase ( ) const
inline

Return true if the Preprocessor::HandleIdentifier must be called on a token of this identifier.

If this returns false, we know that HandleIdentifier will not affect the token.

Definition at line 296 of file IdentifierTable.h.

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

◆ isKeyword()

bool IdentifierInfo::isKeyword ( const LangOptions LangOpts) const

Return true if this token is a keyword in the specified language.

Returns true if the identifier represents a keyword in the specified language.

Definition at line 250 of file IdentifierTable.cpp.

References getTokenKwStatus().

Referenced by DiagnoseCallingConvCast(), and shouldWarnOnMacroDef().

◆ isModulesImport()

bool clang::IdentifierInfo::isModulesImport ( ) const
inline

Determine whether this is the contextual keyword import.

Definition at line 343 of file IdentifierTable.h.

◆ isOutOfDate()

bool clang::IdentifierInfo::isOutOfDate ( ) const
inline

Determine whether the information for this identifier is out of date with respect to the external source.

Definition at line 330 of file IdentifierTable.h.

Referenced by clang::HeaderFileInfo::getControllingMacro(), getFutureCompatDiagKind(), clang::Preprocessor::getLeafModuleMacros(), and isTrivialSingleTokenExpansion().

◆ isPoisoned()

bool clang::IdentifierInfo::isPoisoned ( ) const
inline

◆ isStr()

template<std::size_t StrLen>
bool clang::IdentifierInfo::isStr ( const char(&)  Str[StrLen]) const
inline

◆ operator<()

bool clang::IdentifierInfo::operator< ( const IdentifierInfo RHS) const
inline

Provide less than operator for lexicographical sorting.

Definition at line 368 of file IdentifierTable.h.

References getName().

◆ operator=()

IdentifierInfo& clang::IdentifierInfo::operator= ( const IdentifierInfo )
delete

◆ revertBuiltin()

void clang::IdentifierInfo::revertBuiltin ( )
inline

Revert the identifier to a non-builtin identifier.

We do this if the name of a known builtin library function is used to declare that function, but an unexpected type is specified.

Definition at line 210 of file IdentifierTable.h.

Referenced by clang::serialization::reader::ASTIdentifierLookupTrait::ReadData().

◆ revertIdentifierToTokenID()

void clang::IdentifierInfo::revertIdentifierToTokenID ( tok::TokenKind  TK)
inline

Definition at line 180 of file IdentifierTable.h.

◆ revertTokenIDToIdentifier()

void clang::IdentifierInfo::revertTokenIDToIdentifier ( )
inline

Revert TokenID to tok::identifier; used for GNU libstdc++ 4.2 compatibility.

TokenID is normally read-only but there are 2 instances where we revert it to tok::identifier for libstdc++ 4.2. Keep track of when this happens using this method so we can inform serialization about it.

Definition at line 175 of file IdentifierTable.h.

Referenced by clang::serialization::reader::ASTIdentifierLookupTrait::ReadData().

◆ setBuiltinID()

void clang::IdentifierInfo::setBuiltinID ( unsigned  ID)
inline

Definition at line 223 of file IdentifierTable.h.

References clang::tok::NUM_OBJC_KEYWORDS.

Referenced by clang::ASTImporter::Import().

◆ setChangedSinceDeserialization()

void clang::IdentifierInfo::setChangedSinceDeserialization ( )
inline

Note that this identifier has changed since it was loaded from an AST file.

Definition at line 312 of file IdentifierTable.h.

Referenced by clang::Preprocessor::appendMacroDirective(), clang::Preprocessor::HandlePragmaPoison(), and markIdentifierFromAST().

◆ setFETokenInfo()

void clang::IdentifierInfo::setFETokenInfo ( void *  T)
inline

Definition at line 289 of file IdentifierTable.h.

◆ setFETokenInfoChangedSinceDeserialization()

void clang::IdentifierInfo::setFETokenInfoChangedSinceDeserialization ( )
inline

Note that the frontend token information for this identifier has changed since it was loaded from an AST file.

Definition at line 324 of file IdentifierTable.h.

◆ setHasMacroDefinition()

void clang::IdentifierInfo::setHasMacroDefinition ( bool  Val)
inline

◆ setIsCPlusPlusOperatorKeyword()

void clang::IdentifierInfo::setIsCPlusPlusOperatorKeyword ( bool  Val = true)
inline

isCPlusPlusOperatorKeyword/setIsCPlusPlusOperatorKeyword controls whether this identifier is a C++ alternate representation of an operator.

Definition at line 273 of file IdentifierTable.h.

Referenced by AddCXXOperatorKeyword().

◆ setIsExtensionToken()

void clang::IdentifierInfo::setIsExtensionToken ( bool  Val)
inline

Definition at line 236 of file IdentifierTable.h.

Referenced by AddKeyword().

◆ setIsFromAST()

void clang::IdentifierInfo::setIsFromAST ( )
inline

Definition at line 302 of file IdentifierTable.h.

Referenced by markIdentifierFromAST().

◆ setIsFutureCompatKeyword()

void clang::IdentifierInfo::setIsFutureCompatKeyword ( bool  Val)
inline

Definition at line 250 of file IdentifierTable.h.

Referenced by AddKeyword().

◆ setIsPoisoned()

void clang::IdentifierInfo::setIsPoisoned ( bool  Value = true)
inline

◆ setModulesImport()

void clang::IdentifierInfo::setModulesImport ( bool  I)
inline

Set whether this identifier is the contextual keyword import.

Definition at line 346 of file IdentifierTable.h.

Referenced by clang::IdentifierTable::getOwn().

◆ setObjCKeywordID()

void clang::IdentifierInfo::setObjCKeywordID ( tok::ObjCKeywordKind  ID)
inline

Definition at line 200 of file IdentifierTable.h.

◆ setObjCOrBuiltinID()

void clang::IdentifierInfo::setObjCOrBuiltinID ( unsigned  ID)
inline

◆ setOutOfDate()

void clang::IdentifierInfo::setOutOfDate ( bool  OOD)
inline

Set whether the information for this identifier is out of date with respect to the external source.

Definition at line 334 of file IdentifierTable.h.

Referenced by clang::ASTReader::markIdentifierUpToDate().

Friends And Related Function Documentation

◆ IdentifierTable

friend class IdentifierTable
friend

Definition at line 57 of file IdentifierTable.h.


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