diff options
Diffstat (limited to 'include/clang/Basic/IdentifierTable.h')
| -rw-r--r-- | include/clang/Basic/IdentifierTable.h | 876 |
1 files changed, 0 insertions, 876 deletions
diff --git a/include/clang/Basic/IdentifierTable.h b/include/clang/Basic/IdentifierTable.h deleted file mode 100644 index d672314..0000000 --- a/include/clang/Basic/IdentifierTable.h +++ /dev/null @@ -1,876 +0,0 @@ -//===--- IdentifierTable.h - Hash table for identifier lookup ---*- C++ -*-===// -// -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. -// -//===----------------------------------------------------------------------===// -/// -/// \file -/// \brief Defines the clang::IdentifierInfo, clang::IdentifierTable, and -/// clang::Selector interfaces. -/// -//===----------------------------------------------------------------------===// - -#ifndef LLVM_CLANG_BASIC_IDENTIFIERTABLE_H -#define LLVM_CLANG_BASIC_IDENTIFIERTABLE_H - -#include "clang/Basic/LLVM.h" -#include "clang/Basic/TokenKinds.h" -#include "llvm/ADT/StringMap.h" -#include "llvm/ADT/StringRef.h" -#include <cassert> -#include <string> - -namespace llvm { - template <typename T> struct DenseMapInfo; -} - -namespace clang { - class LangOptions; - class IdentifierInfo; - class IdentifierTable; - class SourceLocation; - class MultiKeywordSelector; // private class used by Selector - class DeclarationName; // AST class that stores declaration names - - /// \brief A simple pair of identifier info and location. - typedef std::pair<IdentifierInfo*, SourceLocation> IdentifierLocPair; - - -/// 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. -class IdentifierInfo { - unsigned TokenID : 9; // Front-end token ID or tok::identifier. - // Objective-C keyword ('protocol' in '@protocol') or builtin (__builtin_inf). - // First NUM_OBJC_KEYWORDS values are for Objective-C, the remaining values - // are for builtins. - unsigned ObjCOrBuiltinID :13; - bool HasMacro : 1; // True if there is a #define for this. - bool HadMacro : 1; // True if there was a #define for this. - bool IsExtension : 1; // True if identifier is a lang extension. - bool IsFutureCompatKeyword : 1; // True if identifier is a keyword in a - // newer Standard or proposed Standard. - bool IsPoisoned : 1; // True if identifier is poisoned. - bool IsCPPOperatorKeyword : 1; // True if ident is a C++ operator keyword. - bool NeedsHandleIdentifier : 1; // See "RecomputeNeedsHandleIdentifier". - bool IsFromAST : 1; // True if identifier was loaded (at least - // partially) from an AST file. - bool ChangedAfterLoad : 1; // True if identifier has changed from the - // definition loaded from an AST file. - bool RevertedTokenID : 1; // True if revertTokenIDToIdentifier was - // called. - bool OutOfDate : 1; // True if there may be additional - // information about this identifier - // stored externally. - bool IsModulesImport : 1; // True if this is the 'import' contextual - // keyword. - // 30 bit left in 64-bit word. - - void *FETokenInfo; // Managed by the language front-end. - llvm::StringMapEntry<IdentifierInfo*> *Entry; - - IdentifierInfo(const IdentifierInfo&) = delete; - void operator=(const IdentifierInfo&) = delete; - - friend class IdentifierTable; - -public: - IdentifierInfo(); - - - /// \brief Return true if this is the identifier for the specified string. - /// - /// This is intended to be used for string literals only: II->isStr("foo"). - template <std::size_t StrLen> - bool isStr(const char (&Str)[StrLen]) const { - return getLength() == StrLen-1 && !memcmp(getNameStart(), Str, StrLen-1); - } - - /// \brief Return the beginning of the actual null-terminated string for this - /// identifier. - /// - const char *getNameStart() const { - if (Entry) return Entry->getKeyData(); - // FIXME: This is gross. It would be best not to embed specific details - // of the PTH file format here. - // The 'this' pointer really points to a - // std::pair<IdentifierInfo, const char*>, where internal pointer - // points to the external string data. - typedef std::pair<IdentifierInfo, const char*> actualtype; - return ((const actualtype*) this)->second; - } - - /// \brief Efficiently return the length of this identifier info. - /// - unsigned getLength() const { - if (Entry) return Entry->getKeyLength(); - // FIXME: This is gross. It would be best not to embed specific details - // of the PTH file format here. - // The 'this' pointer really points to a - // std::pair<IdentifierInfo, const char*>, where internal pointer - // points to the external string data. - typedef std::pair<IdentifierInfo, const char*> actualtype; - const char* p = ((const actualtype*) this)->second - 2; - return (((unsigned) p[0]) | (((unsigned) p[1]) << 8)) - 1; - } - - /// \brief Return the actual identifier string. - StringRef getName() const { - return StringRef(getNameStart(), getLength()); - } - - /// \brief Return true if this identifier is \#defined to some other value. - /// \note The current definition may be in a module and not currently visible. - bool hasMacroDefinition() const { - return HasMacro; - } - void setHasMacroDefinition(bool Val) { - if (HasMacro == Val) return; - - HasMacro = Val; - if (Val) { - NeedsHandleIdentifier = 1; - HadMacro = true; - } else { - RecomputeNeedsHandleIdentifier(); - } - } - /// \brief 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. - bool hadMacroDefinition() const { - return HadMacro; - } - - /// 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. - tok::TokenKind getTokenID() const { return (tok::TokenKind)TokenID; } - - /// \brief True if revertTokenIDToIdentifier() was called. - bool hasRevertedTokenIDToIdentifier() const { return RevertedTokenID; } - - /// \brief 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. - void revertTokenIDToIdentifier() { - assert(TokenID != tok::identifier && "Already at tok::identifier"); - TokenID = tok::identifier; - RevertedTokenID = true; - } - void revertIdentifierToTokenID(tok::TokenKind TK) { - assert(TokenID == tok::identifier && "Should be at tok::identifier"); - TokenID = TK; - RevertedTokenID = false; - } - - /// \brief Return the preprocessor keyword ID for this identifier. - /// - /// For example, "define" will return tok::pp_define. - tok::PPKeywordKind getPPKeywordID() const; - - /// \brief Return the Objective-C keyword ID for the this identifier. - /// - /// For example, 'class' will return tok::objc_class if ObjC is enabled. - tok::ObjCKeywordKind getObjCKeywordID() const { - if (ObjCOrBuiltinID < tok::NUM_OBJC_KEYWORDS) - return tok::ObjCKeywordKind(ObjCOrBuiltinID); - else - return tok::objc_not_keyword; - } - void setObjCKeywordID(tok::ObjCKeywordKind ID) { ObjCOrBuiltinID = ID; } - - /// \brief True if setNotBuiltin() was called. - bool hasRevertedBuiltin() const { - return ObjCOrBuiltinID == tok::NUM_OBJC_KEYWORDS; - } - - /// \brief 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. - void revertBuiltin() { - setBuiltinID(0); - } - - /// \brief Return a value indicating whether this is a builtin function. - /// - /// 0 is not-built-in. 1 is builtin-for-some-nonprimary-target. - /// 2+ are specific builtin functions. - unsigned getBuiltinID() const { - if (ObjCOrBuiltinID >= tok::NUM_OBJC_KEYWORDS) - return ObjCOrBuiltinID - tok::NUM_OBJC_KEYWORDS; - else - return 0; - } - void setBuiltinID(unsigned ID) { - ObjCOrBuiltinID = ID + tok::NUM_OBJC_KEYWORDS; - assert(ObjCOrBuiltinID - unsigned(tok::NUM_OBJC_KEYWORDS) == ID - && "ID too large for field!"); - } - - unsigned getObjCOrBuiltinID() const { return ObjCOrBuiltinID; } - void setObjCOrBuiltinID(unsigned ID) { ObjCOrBuiltinID = ID; } - - /// 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. - bool isExtensionToken() const { return IsExtension; } - void setIsExtensionToken(bool Val) { - IsExtension = Val; - if (Val) - NeedsHandleIdentifier = 1; - else - RecomputeNeedsHandleIdentifier(); - } - - /// 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. - bool isFutureCompatKeyword() const { return IsFutureCompatKeyword; } - void setIsFutureCompatKeyword(bool Val) { - IsFutureCompatKeyword = Val; - if (Val) - NeedsHandleIdentifier = 1; - else - RecomputeNeedsHandleIdentifier(); - } - - /// setIsPoisoned - Mark this identifier as poisoned. After poisoning, the - /// Preprocessor will emit an error every time this token is used. - void setIsPoisoned(bool Value = true) { - IsPoisoned = Value; - if (Value) - NeedsHandleIdentifier = 1; - else - RecomputeNeedsHandleIdentifier(); - } - - /// \brief Return true if this token has been poisoned. - bool isPoisoned() const { return IsPoisoned; } - - /// isCPlusPlusOperatorKeyword/setIsCPlusPlusOperatorKeyword controls whether - /// this identifier is a C++ alternate representation of an operator. - void setIsCPlusPlusOperatorKeyword(bool Val = true) { - IsCPPOperatorKeyword = Val; - if (Val) - NeedsHandleIdentifier = 1; - else - RecomputeNeedsHandleIdentifier(); - } - bool isCPlusPlusOperatorKeyword() const { return IsCPPOperatorKeyword; } - - /// \brief Return true if this token is a keyword in the specified language. - bool isKeyword(const LangOptions &LangOpts); - - /// getFETokenInfo/setFETokenInfo - The language front-end is allowed to - /// associate arbitrary metadata with this token. - template<typename T> - T *getFETokenInfo() const { return static_cast<T*>(FETokenInfo); } - void setFETokenInfo(void *T) { FETokenInfo = T; } - - /// \brief 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. - bool isHandleIdentifierCase() const { return NeedsHandleIdentifier; } - - /// \brief Return true if the identifier in its current state was loaded - /// from an AST file. - bool isFromAST() const { return IsFromAST; } - - void setIsFromAST() { IsFromAST = true; } - - /// \brief Determine whether this identifier has changed since it was loaded - /// from an AST file. - bool hasChangedSinceDeserialization() const { - return ChangedAfterLoad; - } - - /// \brief Note that this identifier has changed since it was loaded from - /// an AST file. - void setChangedSinceDeserialization() { - ChangedAfterLoad = true; - } - - /// \brief Determine whether the information for this identifier is out of - /// date with respect to the external source. - bool isOutOfDate() const { return OutOfDate; } - - /// \brief Set whether the information for this identifier is out of - /// date with respect to the external source. - void setOutOfDate(bool OOD) { - OutOfDate = OOD; - if (OOD) - NeedsHandleIdentifier = true; - else - RecomputeNeedsHandleIdentifier(); - } - - /// \brief Determine whether this is the contextual keyword \c import. - bool isModulesImport() const { return IsModulesImport; } - - /// \brief Set whether this identifier is the contextual keyword \c import. - void setModulesImport(bool I) { - IsModulesImport = I; - if (I) - NeedsHandleIdentifier = true; - else - RecomputeNeedsHandleIdentifier(); - } - - /// \brief Provide less than operator for lexicographical sorting. - bool operator<(const IdentifierInfo &RHS) const { - return getName() < RHS.getName(); - } - -private: - /// The Preprocessor::HandleIdentifier does several special (but rare) - /// things to identifiers of various sorts. For example, it changes the - /// \c for keyword token from tok::identifier to tok::for. - /// - /// This method is very tied to the definition of HandleIdentifier. Any - /// change to it should be reflected here. - void RecomputeNeedsHandleIdentifier() { - NeedsHandleIdentifier = - (isPoisoned() | hasMacroDefinition() | isCPlusPlusOperatorKeyword() | - isExtensionToken() | isFutureCompatKeyword() || isOutOfDate() || - isModulesImport()); - } -}; - -/// \brief An RAII object for [un]poisoning an identifier within a scope. -/// -/// \p II is allowed to be null, in which case objects of this type have -/// no effect. -class PoisonIdentifierRAIIObject { - IdentifierInfo *const II; - const bool OldValue; -public: - PoisonIdentifierRAIIObject(IdentifierInfo *II, bool NewValue) - : II(II), OldValue(II ? II->isPoisoned() : false) { - if(II) - II->setIsPoisoned(NewValue); - } - - ~PoisonIdentifierRAIIObject() { - if(II) - II->setIsPoisoned(OldValue); - } -}; - -/// \brief An iterator that walks over all of the known identifiers -/// in the lookup table. -/// -/// Since this iterator uses an abstract interface via virtual -/// functions, it uses an object-oriented interface rather than the -/// more standard C++ STL iterator interface. In this OO-style -/// iteration, the single function \c Next() provides dereference, -/// advance, and end-of-sequence checking in a single -/// operation. Subclasses of this iterator type will provide the -/// actual functionality. -class IdentifierIterator { -private: - IdentifierIterator(const IdentifierIterator &) = delete; - void operator=(const IdentifierIterator &) = delete; - -protected: - IdentifierIterator() { } - -public: - virtual ~IdentifierIterator(); - - /// \brief Retrieve the next string in the identifier table and - /// advances the iterator for the following string. - /// - /// \returns The next string in the identifier table. If there is - /// no such string, returns an empty \c StringRef. - virtual StringRef Next() = 0; -}; - -/// \brief Provides lookups to, and iteration over, IdentiferInfo objects. -class IdentifierInfoLookup { -public: - virtual ~IdentifierInfoLookup(); - - /// \brief Return the IdentifierInfo for the specified named identifier. - /// - /// Unlike the version in IdentifierTable, this returns a pointer instead - /// of a reference. If the pointer is null then the IdentifierInfo cannot - /// be found. - virtual IdentifierInfo* get(StringRef Name) = 0; - - /// \brief Retrieve an iterator into the set of all identifiers - /// known to this identifier lookup source. - /// - /// This routine provides access to all of the identifiers known to - /// the identifier lookup, allowing access to the contents of the - /// identifiers without introducing the overhead of constructing - /// IdentifierInfo objects for each. - /// - /// \returns A new iterator into the set of known identifiers. The - /// caller is responsible for deleting this iterator. - virtual IdentifierIterator *getIdentifiers(); -}; - -/// \brief Implements an efficient mapping from strings to IdentifierInfo nodes. -/// -/// This has no other purpose, but this is an extremely performance-critical -/// piece of the code, as each occurrence of every identifier goes through -/// here when lexed. -class IdentifierTable { - // Shark shows that using MallocAllocator is *much* slower than using this - // BumpPtrAllocator! - typedef llvm::StringMap<IdentifierInfo*, llvm::BumpPtrAllocator> HashTableTy; - HashTableTy HashTable; - - IdentifierInfoLookup* ExternalLookup; - -public: - /// \brief Create the identifier table, populating it with info about the - /// language keywords for the language specified by \p LangOpts. - IdentifierTable(const LangOptions &LangOpts, - IdentifierInfoLookup* externalLookup = nullptr); - - /// \brief Set the external identifier lookup mechanism. - void setExternalIdentifierLookup(IdentifierInfoLookup *IILookup) { - ExternalLookup = IILookup; - } - - /// \brief Retrieve the external identifier lookup object, if any. - IdentifierInfoLookup *getExternalIdentifierLookup() const { - return ExternalLookup; - } - - llvm::BumpPtrAllocator& getAllocator() { - return HashTable.getAllocator(); - } - - /// \brief Return the identifier token info for the specified named - /// identifier. - IdentifierInfo &get(StringRef Name) { - auto &Entry = *HashTable.insert(std::make_pair(Name, nullptr)).first; - - IdentifierInfo *&II = Entry.second; - if (II) return *II; - - // No entry; if we have an external lookup, look there first. - if (ExternalLookup) { - II = ExternalLookup->get(Name); - if (II) - return *II; - } - - // Lookups failed, make a new IdentifierInfo. - void *Mem = getAllocator().Allocate<IdentifierInfo>(); - II = new (Mem) IdentifierInfo(); - - // Make sure getName() knows how to find the IdentifierInfo - // contents. - II->Entry = &Entry; - - return *II; - } - - IdentifierInfo &get(StringRef Name, tok::TokenKind TokenCode) { - IdentifierInfo &II = get(Name); - II.TokenID = TokenCode; - assert(II.TokenID == (unsigned) TokenCode && "TokenCode too large"); - return II; - } - - /// \brief Gets an IdentifierInfo for the given name without consulting - /// external sources. - /// - /// This is a version of get() meant for external sources that want to - /// introduce or modify an identifier. If they called get(), they would - /// likely end up in a recursion. - IdentifierInfo &getOwn(StringRef Name) { - auto &Entry = *HashTable.insert(std::make_pair(Name, nullptr)).first; - - IdentifierInfo *&II = Entry.second; - if (II) - return *II; - - // Lookups failed, make a new IdentifierInfo. - void *Mem = getAllocator().Allocate<IdentifierInfo>(); - II = new (Mem) IdentifierInfo(); - - // Make sure getName() knows how to find the IdentifierInfo - // contents. - II->Entry = &Entry; - - // If this is the 'import' contextual keyword, mark it as such. - if (Name.equals("import")) - II->setModulesImport(true); - - return *II; - } - - typedef HashTableTy::const_iterator iterator; - typedef HashTableTy::const_iterator const_iterator; - - iterator begin() const { return HashTable.begin(); } - iterator end() const { return HashTable.end(); } - unsigned size() const { return HashTable.size(); } - - /// \brief Print some statistics to stderr that indicate how well the - /// hashing is doing. - void PrintStats() const; - - void AddKeywords(const LangOptions &LangOpts); -}; - -/// \brief A family of Objective-C methods. -/// -/// These families have no inherent meaning in the language, but are -/// nonetheless central enough in the existing implementations to -/// merit direct AST support. While, in theory, arbitrary methods can -/// be considered to form families, we focus here on the methods -/// involving allocation and retain-count management, as these are the -/// most "core" and the most likely to be useful to diverse clients -/// without extra information. -/// -/// Both selectors and actual method declarations may be classified -/// into families. Method families may impose additional restrictions -/// beyond their selector name; for example, a method called '_init' -/// that returns void is not considered to be in the 'init' family -/// (but would be if it returned 'id'). It is also possible to -/// explicitly change or remove a method's family. Therefore the -/// method's family should be considered the single source of truth. -enum ObjCMethodFamily { - /// \brief No particular method family. - OMF_None, - - // Selectors in these families may have arbitrary arity, may be - // written with arbitrary leading underscores, and may have - // additional CamelCase "words" in their first selector chunk - // following the family name. - OMF_alloc, - OMF_copy, - OMF_init, - OMF_mutableCopy, - OMF_new, - - // These families are singletons consisting only of the nullary - // selector with the given name. - OMF_autorelease, - OMF_dealloc, - OMF_finalize, - OMF_release, - OMF_retain, - OMF_retainCount, - OMF_self, - OMF_initialize, - - // performSelector families - OMF_performSelector -}; - -/// Enough bits to store any enumerator in ObjCMethodFamily or -/// InvalidObjCMethodFamily. -enum { ObjCMethodFamilyBitWidth = 4 }; - -/// \brief An invalid value of ObjCMethodFamily. -enum { InvalidObjCMethodFamily = (1 << ObjCMethodFamilyBitWidth) - 1 }; - -/// \brief A family of Objective-C methods. -/// -/// These are family of methods whose result type is initially 'id', but -/// but are candidate for the result type to be changed to 'instancetype'. -enum ObjCInstanceTypeFamily { - OIT_None, - OIT_Array, - OIT_Dictionary, - OIT_Singleton, - OIT_Init, - OIT_ReturnsSelf -}; - -enum ObjCStringFormatFamily { - SFF_None, - SFF_NSString, - SFF_CFString -}; - -/// \brief Smart pointer class that efficiently represents Objective-C method -/// names. -/// -/// This class will either point to an IdentifierInfo or a -/// MultiKeywordSelector (which is private). This enables us to optimize -/// selectors that take no arguments and selectors that take 1 argument, which -/// accounts for 78% of all selectors in Cocoa.h. -class Selector { - friend class Diagnostic; - - enum IdentifierInfoFlag { - // Empty selector = 0. - ZeroArg = 0x1, - OneArg = 0x2, - MultiArg = 0x3, - ArgFlags = ZeroArg|OneArg - }; - uintptr_t InfoPtr; // a pointer to the MultiKeywordSelector or IdentifierInfo. - - Selector(IdentifierInfo *II, unsigned nArgs) { - InfoPtr = reinterpret_cast<uintptr_t>(II); - assert((InfoPtr & ArgFlags) == 0 &&"Insufficiently aligned IdentifierInfo"); - assert(nArgs < 2 && "nArgs not equal to 0/1"); - InfoPtr |= nArgs+1; - } - Selector(MultiKeywordSelector *SI) { - InfoPtr = reinterpret_cast<uintptr_t>(SI); - assert((InfoPtr & ArgFlags) == 0 &&"Insufficiently aligned IdentifierInfo"); - InfoPtr |= MultiArg; - } - - IdentifierInfo *getAsIdentifierInfo() const { - if (getIdentifierInfoFlag() < MultiArg) - return reinterpret_cast<IdentifierInfo *>(InfoPtr & ~ArgFlags); - return nullptr; - } - MultiKeywordSelector *getMultiKeywordSelector() const { - return reinterpret_cast<MultiKeywordSelector *>(InfoPtr & ~ArgFlags); - } - - unsigned getIdentifierInfoFlag() const { - return InfoPtr & ArgFlags; - } - - static ObjCMethodFamily getMethodFamilyImpl(Selector sel); - - static ObjCStringFormatFamily getStringFormatFamilyImpl(Selector sel); - -public: - friend class SelectorTable; // only the SelectorTable can create these - friend class DeclarationName; // and the AST's DeclarationName. - - /// The default ctor should only be used when creating data structures that - /// will contain selectors. - Selector() : InfoPtr(0) {} - Selector(uintptr_t V) : InfoPtr(V) {} - - /// operator==/!= - Indicate whether the specified selectors are identical. - bool operator==(Selector RHS) const { - return InfoPtr == RHS.InfoPtr; - } - bool operator!=(Selector RHS) const { - return InfoPtr != RHS.InfoPtr; - } - void *getAsOpaquePtr() const { - return reinterpret_cast<void*>(InfoPtr); - } - - /// \brief Determine whether this is the empty selector. - bool isNull() const { return InfoPtr == 0; } - - // Predicates to identify the selector type. - bool isKeywordSelector() const { - return getIdentifierInfoFlag() != ZeroArg; - } - bool isUnarySelector() const { - return getIdentifierInfoFlag() == ZeroArg; - } - unsigned getNumArgs() const; - - - /// \brief Retrieve the identifier at a given position in the selector. - /// - /// Note that the identifier pointer returned may be NULL. Clients that only - /// care about the text of the identifier string, and not the specific, - /// uniqued identifier pointer, should use \c getNameForSlot(), which returns - /// an empty string when the identifier pointer would be NULL. - /// - /// \param argIndex The index for which we want to retrieve the identifier. - /// This index shall be less than \c getNumArgs() unless this is a keyword - /// selector, in which case 0 is the only permissible value. - /// - /// \returns the uniqued identifier for this slot, or NULL if this slot has - /// no corresponding identifier. - IdentifierInfo *getIdentifierInfoForSlot(unsigned argIndex) const; - - /// \brief Retrieve the name at a given position in the selector. - /// - /// \param argIndex The index for which we want to retrieve the name. - /// This index shall be less than \c getNumArgs() unless this is a keyword - /// selector, in which case 0 is the only permissible value. - /// - /// \returns the name for this slot, which may be the empty string if no - /// name was supplied. - StringRef getNameForSlot(unsigned argIndex) const; - - /// \brief Derive the full selector name (e.g. "foo:bar:") and return - /// it as an std::string. - std::string getAsString() const; - - /// \brief Prints the full selector name (e.g. "foo:bar:"). - void print(llvm::raw_ostream &OS) const; - - /// \brief Derive the conventional family of this method. - ObjCMethodFamily getMethodFamily() const { - return getMethodFamilyImpl(*this); - } - - ObjCStringFormatFamily getStringFormatFamily() const { - return getStringFormatFamilyImpl(*this); - } - - static Selector getEmptyMarker() { - return Selector(uintptr_t(-1)); - } - static Selector getTombstoneMarker() { - return Selector(uintptr_t(-2)); - } - - static ObjCInstanceTypeFamily getInstTypeMethodFamily(Selector sel); -}; - -/// \brief This table allows us to fully hide how we implement -/// multi-keyword caching. -class SelectorTable { - void *Impl; // Actually a SelectorTableImpl - SelectorTable(const SelectorTable &) = delete; - void operator=(const SelectorTable &) = delete; -public: - SelectorTable(); - ~SelectorTable(); - - /// \brief Can create any sort of selector. - /// - /// \p NumArgs indicates whether this is a no argument selector "foo", a - /// single argument selector "foo:" or multi-argument "foo:bar:". - Selector getSelector(unsigned NumArgs, IdentifierInfo **IIV); - - Selector getUnarySelector(IdentifierInfo *ID) { - return Selector(ID, 1); - } - Selector getNullarySelector(IdentifierInfo *ID) { - return Selector(ID, 0); - } - - /// \brief Return the total amount of memory allocated for managing selectors. - size_t getTotalMemory() const; - - /// \brief Return the default setter name for the given identifier. - /// - /// This is "set" + \p Name where the initial character of \p Name - /// has been capitalized. - static SmallString<64> constructSetterName(StringRef Name); - - /// \brief Return the default setter selector for the given identifier. - /// - /// This is "set" + \p Name where the initial character of \p Name - /// has been capitalized. - static Selector constructSetterSelector(IdentifierTable &Idents, - SelectorTable &SelTable, - const IdentifierInfo *Name); -}; - -/// DeclarationNameExtra - Common base of the MultiKeywordSelector, -/// CXXSpecialName, and CXXOperatorIdName classes, all of which are -/// private classes that describe different kinds of names. -class DeclarationNameExtra { -public: - /// ExtraKind - The kind of "extra" information stored in the - /// DeclarationName. See @c ExtraKindOrNumArgs for an explanation of - /// how these enumerator values are used. - enum ExtraKind { - CXXConstructor = 0, - CXXDestructor, - CXXConversionFunction, -#define OVERLOADED_OPERATOR(Name,Spelling,Token,Unary,Binary,MemberOnly) \ - CXXOperator##Name, -#include "clang/Basic/OperatorKinds.def" - CXXLiteralOperator, - CXXUsingDirective, - NUM_EXTRA_KINDS - }; - - /// ExtraKindOrNumArgs - Either the kind of C++ special name or - /// operator-id (if the value is one of the CXX* enumerators of - /// ExtraKind), in which case the DeclarationNameExtra is also a - /// CXXSpecialName, (for CXXConstructor, CXXDestructor, or - /// CXXConversionFunction) CXXOperatorIdName, or CXXLiteralOperatorName, - /// it may be also name common to C++ using-directives (CXXUsingDirective), - /// otherwise it is NUM_EXTRA_KINDS+NumArgs, where NumArgs is the number of - /// arguments in the Objective-C selector, in which case the - /// DeclarationNameExtra is also a MultiKeywordSelector. - unsigned ExtraKindOrNumArgs; -}; - -} // end namespace clang - -namespace llvm { -/// Define DenseMapInfo so that Selectors can be used as keys in DenseMap and -/// DenseSets. -template <> -struct DenseMapInfo<clang::Selector> { - static inline clang::Selector getEmptyKey() { - return clang::Selector::getEmptyMarker(); - } - static inline clang::Selector getTombstoneKey() { - return clang::Selector::getTombstoneMarker(); - } - - static unsigned getHashValue(clang::Selector S); - - static bool isEqual(clang::Selector LHS, clang::Selector RHS) { - return LHS == RHS; - } -}; - -template <> -struct isPodLike<clang::Selector> { static const bool value = true; }; - -template <typename T> class PointerLikeTypeTraits; - -template<> -class PointerLikeTypeTraits<clang::Selector> { -public: - static inline const void *getAsVoidPointer(clang::Selector P) { - return P.getAsOpaquePtr(); - } - static inline clang::Selector getFromVoidPointer(const void *P) { - return clang::Selector(reinterpret_cast<uintptr_t>(P)); - } - enum { NumLowBitsAvailable = 0 }; -}; - -// Provide PointerLikeTypeTraits for IdentifierInfo pointers, which -// are not guaranteed to be 8-byte aligned. -template<> -class PointerLikeTypeTraits<clang::IdentifierInfo*> { -public: - static inline void *getAsVoidPointer(clang::IdentifierInfo* P) { - return P; - } - static inline clang::IdentifierInfo *getFromVoidPointer(void *P) { - return static_cast<clang::IdentifierInfo*>(P); - } - enum { NumLowBitsAvailable = 1 }; -}; - -template<> -class PointerLikeTypeTraits<const clang::IdentifierInfo*> { -public: - static inline const void *getAsVoidPointer(const clang::IdentifierInfo* P) { - return P; - } - static inline const clang::IdentifierInfo *getFromVoidPointer(const void *P) { - return static_cast<const clang::IdentifierInfo*>(P); - } - enum { NumLowBitsAvailable = 1 }; -}; - -} // end namespace llvm -#endif |
