contrib/llvm/tools/clang/include/clang/Basic/IdentifierTable.h

   1 //===--- IdentifierTable.h - Hash table for identifier lookup ---*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 ///
  10 /// \file
  11 /// \brief Defines the clang::IdentifierInfo, clang::IdentifierTable, and
  12 /// clang::Selector interfaces.
  13 ///
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_CLANG_BASIC_IDENTIFIERTABLE_H
  17 #define LLVM_CLANG_BASIC_IDENTIFIERTABLE_H
  18
  19 #include "clang/Basic/LLVM.h"
  20 #include "clang/Basic/TokenKinds.h"
  21 #include "llvm/ADT/SmallString.h"
  22 #include "llvm/ADT/StringMap.h"
  23 #include "llvm/ADT/StringRef.h"
  24 #include "llvm/Support/Allocator.h"
  25 #include <cassert>
  26 #include <cstddef>
  27 #include <cstdint>
  28 #include <cstring>
  29 #include <new>
  30 #include <string>
  31 #include <utility>
  32
  33 namespace llvm {
  34
  35   template <typename T> struct DenseMapInfo;
  36
  37 } // end namespace llvm
  38
  39 namespace clang {
  40
  41   class LangOptions;
  42   class IdentifierInfo;
  43   class IdentifierTable;
  44   class SourceLocation;
  45   class MultiKeywordSelector; // private class used by Selector
  46   class DeclarationName;      // AST class that stores declaration names
  47
  48   /// \brief A simple pair of identifier info and location.
  49   typedef std::pair<IdentifierInfo*, SourceLocation> IdentifierLocPair;
  50
  51 /// One of these records is kept for each identifier that
  52 /// is lexed.  This contains information about whether the token was \#define'd,
  53 /// is a language keyword, or if it is a front-end token of some sort (e.g. a
  54 /// variable or function name).  The preprocessor keeps this information in a
  55 /// set, and all tok::identifier tokens have a pointer to one of these.
  56 class IdentifierInfo {
  57   friend class IdentifierTable;
  58
  59   unsigned TokenID            : 9; // Front-end token ID or tok::identifier.
  60   // Objective-C keyword ('protocol' in '@protocol') or builtin (__builtin_inf).
  61   // First NUM_OBJC_KEYWORDS values are for Objective-C, the remaining values
  62   // are for builtins.
  63   unsigned ObjCOrBuiltinID    :13;
  64   bool HasMacro               : 1; // True if there is a #define for this.
  65   bool HadMacro               : 1; // True if there was a #define for this.
  66   bool IsExtension            : 1; // True if identifier is a lang extension.
  67   bool IsFutureCompatKeyword  : 1; // True if identifier is a keyword in a
  68                                    // newer Standard or proposed Standard.
  69   bool IsPoisoned             : 1; // True if identifier is poisoned.
  70   bool IsCPPOperatorKeyword   : 1; // True if ident is a C++ operator keyword.
  71   bool NeedsHandleIdentifier  : 1; // See "RecomputeNeedsHandleIdentifier".
  72   bool IsFromAST              : 1; // True if identifier was loaded (at least
  73                                    // partially) from an AST file.
  74   bool ChangedAfterLoad       : 1; // True if identifier has changed from the
  75                                    // definition loaded from an AST file.
  76   bool FEChangedAfterLoad     : 1; // True if identifier's frontend information
  77                                    // has changed from the definition loaded
  78                                    // from an AST file.
  79   bool RevertedTokenID        : 1; // True if revertTokenIDToIdentifier was
  80                                    // called.
  81   bool OutOfDate              : 1; // True if there may be additional
  82                                    // information about this identifier
  83                                    // stored externally.
  84   bool IsModulesImport        : 1; // True if this is the 'import' contextual
  85                                    // keyword.
  86   // 29 bit left in 64-bit word.
  87
  88   void *FETokenInfo;               // Managed by the language front-end.
  89   llvm::StringMapEntry<IdentifierInfo*> *Entry;
  90
  91 public:
  92   IdentifierInfo();
  93   IdentifierInfo(const IdentifierInfo &) = delete;
  94   IdentifierInfo &operator=(const IdentifierInfo &) = delete;
  95
  96   /// \brief Return true if this is the identifier for the specified string.
  97   ///
  98   /// This is intended to be used for string literals only: II->isStr("foo").
  99   template <std::size_t StrLen>
 100   bool isStr(const char (&Str)[StrLen]) const {
 101     return getLength() == StrLen-1 &&
 102            memcmp(getNameStart(), Str, StrLen-1) == 0;
 103   }
 104
 105   /// \brief Return the beginning of the actual null-terminated string for this
 106   /// identifier.
 107   ///
 108   const char *getNameStart() const {
 109     if (Entry) return Entry->getKeyData();
 110     // FIXME: This is gross. It would be best not to embed specific details
 111     // of the PTH file format here.
 112     // The 'this' pointer really points to a
 113     // std::pair<IdentifierInfo, const char*>, where internal pointer
 114     // points to the external string data.
 115     typedef std::pair<IdentifierInfo, const char*> actualtype;
 116     return ((const actualtype*) this)->second;
 117   }
 118
 119   /// \brief Efficiently return the length of this identifier info.
 120   ///
 121   unsigned getLength() const {
 122     if (Entry) return Entry->getKeyLength();
 123     // FIXME: This is gross. It would be best not to embed specific details
 124     // of the PTH file format here.
 125     // The 'this' pointer really points to a
 126     // std::pair<IdentifierInfo, const char*>, where internal pointer
 127     // points to the external string data.
 128     typedef std::pair<IdentifierInfo, const char*> actualtype;
 129     const char* p = ((const actualtype*) this)->second - 2;
 130     return (((unsigned) p[0]) | (((unsigned) p[1]) << 8)) - 1;
 131   }
 132
 133   /// \brief Return the actual identifier string.
 134   StringRef getName() const {
 135     return StringRef(getNameStart(), getLength());
 136   }
 137
 138   /// \brief Return true if this identifier is \#defined to some other value.
 139   /// \note The current definition may be in a module and not currently visible.
 140   bool hasMacroDefinition() const {
 141     return HasMacro;
 142   }
 143   void setHasMacroDefinition(bool Val) {
 144     if (HasMacro == Val) return;
 145
 146     HasMacro = Val;
 147     if (Val) {
 148       NeedsHandleIdentifier = true;
 149       HadMacro = true;
 150     } else {
 151       RecomputeNeedsHandleIdentifier();
 152     }
 153   }
 154   /// \brief Returns true if this identifier was \#defined to some value at any
 155   /// moment. In this case there should be an entry for the identifier in the
 156   /// macro history table in Preprocessor.
 157   bool hadMacroDefinition() const {
 158     return HadMacro;
 159   }
 160
 161   /// If this is a source-language token (e.g. 'for'), this API
 162   /// can be used to cause the lexer to map identifiers to source-language
 163   /// tokens.
 164   tok::TokenKind getTokenID() const { return (tok::TokenKind)TokenID; }
 165
 166   /// \brief True if revertTokenIDToIdentifier() was called.
 167   bool hasRevertedTokenIDToIdentifier() const { return RevertedTokenID; }
 168
 169   /// \brief Revert TokenID to tok::identifier; used for GNU libstdc++ 4.2
 170   /// compatibility.
 171   ///
 172   /// TokenID is normally read-only but there are 2 instances where we revert it
 173   /// to tok::identifier for libstdc++ 4.2. Keep track of when this happens
 174   /// using this method so we can inform serialization about it.
 175   void revertTokenIDToIdentifier() {
 176     assert(TokenID != tok::identifier && "Already at tok::identifier");
 177     TokenID = tok::identifier;
 178     RevertedTokenID = true;
 179   }
 180   void revertIdentifierToTokenID(tok::TokenKind TK) {
 181     assert(TokenID == tok::identifier && "Should be at tok::identifier");
 182     TokenID = TK;
 183     RevertedTokenID = false;
 184   }
 185
 186   /// \brief Return the preprocessor keyword ID for this identifier.
 187   ///
 188   /// For example, "define" will return tok::pp_define.
 189   tok::PPKeywordKind getPPKeywordID() const;
 190
 191   /// \brief Return the Objective-C keyword ID for the this identifier.
 192   ///
 193   /// For example, 'class' will return tok::objc_class if ObjC is enabled.
 194   tok::ObjCKeywordKind getObjCKeywordID() const {
 195     if (ObjCOrBuiltinID < tok::NUM_OBJC_KEYWORDS)
 196       return tok::ObjCKeywordKind(ObjCOrBuiltinID);
 197     else
 198       return tok::objc_not_keyword;
 199   }
 200   void setObjCKeywordID(tok::ObjCKeywordKind ID) { ObjCOrBuiltinID = ID; }
 201
 202   /// \brief True if setNotBuiltin() was called.
 203   bool hasRevertedBuiltin() const {
 204     return ObjCOrBuiltinID == tok::NUM_OBJC_KEYWORDS;
 205   }
 206
 207   /// \brief Revert the identifier to a non-builtin identifier. We do this if
 208   /// the name of a known builtin library function is used to declare that
 209   /// function, but an unexpected type is specified.
 210   void revertBuiltin() {
 211     setBuiltinID(0);
 212   }
 213
 214   /// \brief Return a value indicating whether this is a builtin function.
 215   ///
 216   /// 0 is not-built-in. 1+ are specific builtin functions.
 217   unsigned getBuiltinID() const {
 218     if (ObjCOrBuiltinID >= tok::NUM_OBJC_KEYWORDS)
 219       return ObjCOrBuiltinID - tok::NUM_OBJC_KEYWORDS;
 220     else
 221       return 0;
 222   }
 223   void setBuiltinID(unsigned ID) {
 224     ObjCOrBuiltinID = ID + tok::NUM_OBJC_KEYWORDS;
 225     assert(ObjCOrBuiltinID - unsigned(tok::NUM_OBJC_KEYWORDS) == ID
 226            && "ID too large for field!");
 227   }
 228
 229   unsigned getObjCOrBuiltinID() const { return ObjCOrBuiltinID; }
 230   void setObjCOrBuiltinID(unsigned ID) { ObjCOrBuiltinID = ID; }
 231
 232   /// get/setExtension - Initialize information about whether or not this
 233   /// language token is an extension.  This controls extension warnings, and is
 234   /// only valid if a custom token ID is set.
 235   bool isExtensionToken() const { return IsExtension; }
 236   void setIsExtensionToken(bool Val) {
 237     IsExtension = Val;
 238     if (Val)
 239       NeedsHandleIdentifier = true;
 240     else
 241       RecomputeNeedsHandleIdentifier();
 242   }
 243
 244   /// is/setIsFutureCompatKeyword - Initialize information about whether or not
 245   /// this language token is a keyword in a newer or proposed Standard. This
 246   /// controls compatibility warnings, and is only true when not parsing the
 247   /// corresponding Standard. Once a compatibility problem has been diagnosed
 248   /// with this keyword, the flag will be cleared.
 249   bool isFutureCompatKeyword() const { return IsFutureCompatKeyword; }
 250   void setIsFutureCompatKeyword(bool Val) {
 251     IsFutureCompatKeyword = Val;
 252     if (Val)
 253       NeedsHandleIdentifier = true;
 254     else
 255       RecomputeNeedsHandleIdentifier();
 256   }
 257
 258   /// setIsPoisoned - Mark this identifier as poisoned.  After poisoning, the
 259   /// Preprocessor will emit an error every time this token is used.
 260   void setIsPoisoned(bool Value = true) {
 261     IsPoisoned = Value;
 262     if (Value)
 263       NeedsHandleIdentifier = true;
 264     else
 265       RecomputeNeedsHandleIdentifier();
 266   }
 267
 268   /// \brief Return true if this token has been poisoned.
 269   bool isPoisoned() const { return IsPoisoned; }
 270
 271   /// isCPlusPlusOperatorKeyword/setIsCPlusPlusOperatorKeyword controls whether
 272   /// this identifier is a C++ alternate representation of an operator.
 273   void setIsCPlusPlusOperatorKeyword(bool Val = true) {
 274     IsCPPOperatorKeyword = Val;
 275     if (Val)
 276       NeedsHandleIdentifier = true;
 277     else
 278       RecomputeNeedsHandleIdentifier();
 279   }
 280   bool isCPlusPlusOperatorKeyword() const { return IsCPPOperatorKeyword; }
 281
 282   /// \brief Return true if this token is a keyword in the specified language.
 283   bool isKeyword(const LangOptions &LangOpts);
 284
 285   /// getFETokenInfo/setFETokenInfo - The language front-end is allowed to
 286   /// associate arbitrary metadata with this token.
 287   template<typename T>
 288   T *getFETokenInfo() const { return static_cast<T*>(FETokenInfo); }
 289   void setFETokenInfo(void *T) { FETokenInfo = T; }
 290
 291   /// \brief Return true if the Preprocessor::HandleIdentifier must be called
 292   /// on a token of this identifier.
 293   ///
 294   /// If this returns false, we know that HandleIdentifier will not affect
 295   /// the token.
 296   bool isHandleIdentifierCase() const { return NeedsHandleIdentifier; }
 297
 298   /// \brief Return true if the identifier in its current state was loaded
 299   /// from an AST file.
 300   bool isFromAST() const { return IsFromAST; }
 301
 302   void setIsFromAST() { IsFromAST = true; }
 303
 304   /// \brief Determine whether this identifier has changed since it was loaded
 305   /// from an AST file.
 306   bool hasChangedSinceDeserialization() const {
 307     return ChangedAfterLoad;
 308   }
 309
 310   /// \brief Note that this identifier has changed since it was loaded from
 311   /// an AST file.
 312   void setChangedSinceDeserialization() {
 313     ChangedAfterLoad = true;
 314   }
 315
 316   /// \brief Determine whether the frontend token information for this
 317   /// identifier has changed since it was loaded from an AST file.
 318   bool hasFETokenInfoChangedSinceDeserialization() const {
 319     return FEChangedAfterLoad;
 320   }
 321
 322   /// \brief Note that the frontend token information for this identifier has
 323   /// changed since it was loaded from an AST file.
 324   void setFETokenInfoChangedSinceDeserialization() {
 325     FEChangedAfterLoad = true;
 326   }
 327
 328   /// \brief Determine whether the information for this identifier is out of
 329   /// date with respect to the external source.
 330   bool isOutOfDate() const { return OutOfDate; }
 331
 332   /// \brief Set whether the information for this identifier is out of
 333   /// date with respect to the external source.
 334   void setOutOfDate(bool OOD) {
 335     OutOfDate = OOD;
 336     if (OOD)
 337       NeedsHandleIdentifier = true;
 338     else
 339       RecomputeNeedsHandleIdentifier();
 340   }
 341
 342   /// \brief Determine whether this is the contextual keyword \c import.
 343   bool isModulesImport() const { return IsModulesImport; }
 344
 345   /// \brief Set whether this identifier is the contextual keyword \c import.
 346   void setModulesImport(bool I) {
 347     IsModulesImport = I;
 348     if (I)
 349       NeedsHandleIdentifier = true;
 350     else
 351       RecomputeNeedsHandleIdentifier();
 352   }
 353
 354   /// \brief Provide less than operator for lexicographical sorting.
 355   bool operator<(const IdentifierInfo &RHS) const {
 356     return getName() < RHS.getName();
 357   }
 358
 359 private:
 360   /// The Preprocessor::HandleIdentifier does several special (but rare)
 361   /// things to identifiers of various sorts.  For example, it changes the
 362   /// \c for keyword token from tok::identifier to tok::for.
 363   ///
 364   /// This method is very tied to the definition of HandleIdentifier.  Any
 365   /// change to it should be reflected here.
 366   void RecomputeNeedsHandleIdentifier() {
 367     NeedsHandleIdentifier =
 368       (isPoisoned() | hasMacroDefinition() | isCPlusPlusOperatorKeyword() |
 369        isExtensionToken() | isFutureCompatKeyword() || isOutOfDate() ||
 370        isModulesImport());
 371   }
 372 };
 373
 374 /// \brief An RAII object for [un]poisoning an identifier within a scope.
 375 ///
 376 /// \p II is allowed to be null, in which case objects of this type have
 377 /// no effect.
 378 class PoisonIdentifierRAIIObject {
 379   IdentifierInfo *const II;
 380   const bool OldValue;
 381
 382 public:
 383   PoisonIdentifierRAIIObject(IdentifierInfo *II, bool NewValue)
 384     : II(II), OldValue(II ? II->isPoisoned() : false) {
 385     if(II)
 386       II->setIsPoisoned(NewValue);
 387   }
 388
 389   ~PoisonIdentifierRAIIObject() {
 390     if(II)
 391       II->setIsPoisoned(OldValue);
 392   }
 393 };
 394
 395 /// \brief An iterator that walks over all of the known identifiers
 396 /// in the lookup table.
 397 ///
 398 /// Since this iterator uses an abstract interface via virtual
 399 /// functions, it uses an object-oriented interface rather than the
 400 /// more standard C++ STL iterator interface. In this OO-style
 401 /// iteration, the single function \c Next() provides dereference,
 402 /// advance, and end-of-sequence checking in a single
 403 /// operation. Subclasses of this iterator type will provide the
 404 /// actual functionality.
 405 class IdentifierIterator {
 406 protected:
 407   IdentifierIterator() = default;
 408
 409 public:
 410   IdentifierIterator(const IdentifierIterator &) = delete;
 411   IdentifierIterator &operator=(const IdentifierIterator &) = delete;
 412
 413   virtual ~IdentifierIterator();
 414
 415   /// \brief Retrieve the next string in the identifier table and
 416   /// advances the iterator for the following string.
 417   ///
 418   /// \returns The next string in the identifier table. If there is
 419   /// no such string, returns an empty \c StringRef.
 420   virtual StringRef Next() = 0;
 421 };
 422
 423 /// \brief Provides lookups to, and iteration over, IdentiferInfo objects.
 424 class IdentifierInfoLookup {
 425 public:
 426   virtual ~IdentifierInfoLookup();
 427
 428   /// \brief Return the IdentifierInfo for the specified named identifier.
 429   ///
 430   /// Unlike the version in IdentifierTable, this returns a pointer instead
 431   /// of a reference.  If the pointer is null then the IdentifierInfo cannot
 432   /// be found.
 433   virtual IdentifierInfo* get(StringRef Name) = 0;
 434
 435   /// \brief Retrieve an iterator into the set of all identifiers
 436   /// known to this identifier lookup source.
 437   ///
 438   /// This routine provides access to all of the identifiers known to
 439   /// the identifier lookup, allowing access to the contents of the
 440   /// identifiers without introducing the overhead of constructing
 441   /// IdentifierInfo objects for each.
 442   ///
 443   /// \returns A new iterator into the set of known identifiers. The
 444   /// caller is responsible for deleting this iterator.
 445   virtual IdentifierIterator *getIdentifiers();
 446 };
 447
 448 /// \brief Implements an efficient mapping from strings to IdentifierInfo nodes.
 449 ///
 450 /// This has no other purpose, but this is an extremely performance-critical
 451 /// piece of the code, as each occurrence of every identifier goes through
 452 /// here when lexed.
 453 class IdentifierTable {
 454   // Shark shows that using MallocAllocator is *much* slower than using this
 455   // BumpPtrAllocator!
 456   typedef llvm::StringMap<IdentifierInfo*, llvm::BumpPtrAllocator> HashTableTy;
 457   HashTableTy HashTable;
 458
 459   IdentifierInfoLookup* ExternalLookup;
 460
 461 public:
 462   /// \brief Create the identifier table, populating it with info about the
 463   /// language keywords for the language specified by \p LangOpts.
 464   IdentifierTable(const LangOptions &LangOpts,
 465                   IdentifierInfoLookup* externalLookup = nullptr);
 466
 467   /// \brief Set the external identifier lookup mechanism.
 468   void setExternalIdentifierLookup(IdentifierInfoLookup *IILookup) {
 469     ExternalLookup = IILookup;
 470   }
 471
 472   /// \brief Retrieve the external identifier lookup object, if any.
 473   IdentifierInfoLookup *getExternalIdentifierLookup() const {
 474     return ExternalLookup;
 475   }
 476
 477   llvm::BumpPtrAllocator& getAllocator() {
 478     return HashTable.getAllocator();
 479   }
 480
 481   /// \brief Return the identifier token info for the specified named
 482   /// identifier.
 483   IdentifierInfo &get(StringRef Name) {
 484     auto &Entry = *HashTable.insert(std::make_pair(Name, nullptr)).first;
 485
 486     IdentifierInfo *&II = Entry.second;
 487     if (II) return *II;
 488
 489     // No entry; if we have an external lookup, look there first.
 490     if (ExternalLookup) {
 491       II = ExternalLookup->get(Name);
 492       if (II)
 493         return *II;
 494     }
 495
 496     // Lookups failed, make a new IdentifierInfo.
 497     void *Mem = getAllocator().Allocate<IdentifierInfo>();
 498     II = new (Mem) IdentifierInfo();
 499
 500     // Make sure getName() knows how to find the IdentifierInfo
 501     // contents.
 502     II->Entry = &Entry;
 503
 504     return *II;
 505   }
 506
 507   IdentifierInfo &get(StringRef Name, tok::TokenKind TokenCode) {
 508     IdentifierInfo &II = get(Name);
 509     II.TokenID = TokenCode;
 510     assert(II.TokenID == (unsigned) TokenCode && "TokenCode too large");
 511     return II;
 512   }
 513
 514   /// \brief Gets an IdentifierInfo for the given name without consulting
 515   ///        external sources.
 516   ///
 517   /// This is a version of get() meant for external sources that want to
 518   /// introduce or modify an identifier. If they called get(), they would
 519   /// likely end up in a recursion.
 520   IdentifierInfo &getOwn(StringRef Name) {
 521     auto &Entry = *HashTable.insert(std::make_pair(Name, nullptr)).first;
 522
 523     IdentifierInfo *&II = Entry.second;
 524     if (II)
 525       return *II;
 526
 527     // Lookups failed, make a new IdentifierInfo.
 528     void *Mem = getAllocator().Allocate<IdentifierInfo>();
 529     II = new (Mem) IdentifierInfo();
 530
 531     // Make sure getName() knows how to find the IdentifierInfo
 532     // contents.
 533     II->Entry = &Entry;
 534
 535     // If this is the 'import' contextual keyword, mark it as such.
 536     if (Name.equals("import"))
 537       II->setModulesImport(true);
 538
 539     return *II;
 540   }
 541
 542   typedef HashTableTy::const_iterator iterator;
 543   typedef HashTableTy::const_iterator const_iterator;
 544
 545   iterator begin() const { return HashTable.begin(); }
 546   iterator end() const   { return HashTable.end(); }
 547   unsigned size() const  { return HashTable.size(); }
 548
 549   /// \brief Print some statistics to stderr that indicate how well the
 550   /// hashing is doing.
 551   void PrintStats() const;
 552
 553   void AddKeywords(const LangOptions &LangOpts);
 554 };
 555
 556 /// \brief A family of Objective-C methods.
 557 ///
 558 /// These families have no inherent meaning in the language, but are
 559 /// nonetheless central enough in the existing implementations to
 560 /// merit direct AST support.  While, in theory, arbitrary methods can
 561 /// be considered to form families, we focus here on the methods
 562 /// involving allocation and retain-count management, as these are the
 563 /// most "core" and the most likely to be useful to diverse clients
 564 /// without extra information.
 565 ///
 566 /// Both selectors and actual method declarations may be classified
 567 /// into families.  Method families may impose additional restrictions
 568 /// beyond their selector name; for example, a method called '_init'
 569 /// that returns void is not considered to be in the 'init' family
 570 /// (but would be if it returned 'id').  It is also possible to
 571 /// explicitly change or remove a method's family.  Therefore the
 572 /// method's family should be considered the single source of truth.
 573 enum ObjCMethodFamily {
 574   /// \brief No particular method family.
 575   OMF_None,
 576
 577   // Selectors in these families may have arbitrary arity, may be
 578   // written with arbitrary leading underscores, and may have
 579   // additional CamelCase "words" in their first selector chunk
 580   // following the family name.
 581   OMF_alloc,
 582   OMF_copy,
 583   OMF_init,
 584   OMF_mutableCopy,
 585   OMF_new,
 586
 587   // These families are singletons consisting only of the nullary
 588   // selector with the given name.
 589   OMF_autorelease,
 590   OMF_dealloc,
 591   OMF_finalize,
 592   OMF_release,
 593   OMF_retain,
 594   OMF_retainCount,
 595   OMF_self,
 596   OMF_initialize,
 597
 598   // performSelector families
 599   OMF_performSelector
 600 };
 601
 602 /// Enough bits to store any enumerator in ObjCMethodFamily or
 603 /// InvalidObjCMethodFamily.
 604 enum { ObjCMethodFamilyBitWidth = 4 };
 605
 606 /// \brief An invalid value of ObjCMethodFamily.
 607 enum { InvalidObjCMethodFamily = (1 << ObjCMethodFamilyBitWidth) - 1 };
 608
 609 /// \brief A family of Objective-C methods.
 610 ///
 611 /// These are family of methods whose result type is initially 'id', but
 612 /// but are candidate for the result type to be changed to 'instancetype'.
 613 enum ObjCInstanceTypeFamily {
 614   OIT_None,
 615   OIT_Array,
 616   OIT_Dictionary,
 617   OIT_Singleton,
 618   OIT_Init,
 619   OIT_ReturnsSelf
 620 };
 621
 622 enum ObjCStringFormatFamily {
 623   SFF_None,
 624   SFF_NSString,
 625   SFF_CFString
 626 };
 627
 628 /// \brief Smart pointer class that efficiently represents Objective-C method
 629 /// names.
 630 ///
 631 /// This class will either point to an IdentifierInfo or a
 632 /// MultiKeywordSelector (which is private). This enables us to optimize
 633 /// selectors that take no arguments and selectors that take 1 argument, which
 634 /// accounts for 78% of all selectors in Cocoa.h.
 635 class Selector {
 636   friend class Diagnostic;
 637
 638   enum IdentifierInfoFlag {
 639     // Empty selector = 0.
 640     ZeroArg  = 0x1,
 641     OneArg   = 0x2,
 642     MultiArg = 0x3,
 643     ArgFlags = ZeroArg|OneArg
 644   };
 645   uintptr_t InfoPtr; // a pointer to the MultiKeywordSelector or IdentifierInfo.
 646
 647   Selector(IdentifierInfo *II, unsigned nArgs) {
 648     InfoPtr = reinterpret_cast<uintptr_t>(II);
 649     assert((InfoPtr & ArgFlags) == 0 &&"Insufficiently aligned IdentifierInfo");
 650     assert(nArgs < 2 && "nArgs not equal to 0/1");
 651     InfoPtr |= nArgs+1;
 652   }
 653   Selector(MultiKeywordSelector *SI) {
 654     InfoPtr = reinterpret_cast<uintptr_t>(SI);
 655     assert((InfoPtr & ArgFlags) == 0 &&"Insufficiently aligned IdentifierInfo");
 656     InfoPtr |= MultiArg;
 657   }
 658
 659   IdentifierInfo *getAsIdentifierInfo() const {
 660     if (getIdentifierInfoFlag() < MultiArg)
 661       return reinterpret_cast<IdentifierInfo *>(InfoPtr & ~ArgFlags);
 662     return nullptr;
 663   }
 664
 665   MultiKeywordSelector *getMultiKeywordSelector() const {
 666     return reinterpret_cast<MultiKeywordSelector *>(InfoPtr & ~ArgFlags);
 667   }
 668
 669   unsigned getIdentifierInfoFlag() const {
 670     return InfoPtr & ArgFlags;
 671   }
 672
 673   static ObjCMethodFamily getMethodFamilyImpl(Selector sel);
 674
 675   static ObjCStringFormatFamily getStringFormatFamilyImpl(Selector sel);
 676
 677 public:
 678   friend class SelectorTable; // only the SelectorTable can create these
 679   friend class DeclarationName; // and the AST's DeclarationName.
 680
 681   /// The default ctor should only be used when creating data structures that
 682   ///  will contain selectors.
 683   Selector() : InfoPtr(0) {}
 684   Selector(uintptr_t V) : InfoPtr(V) {}
 685
 686   /// operator==/!= - Indicate whether the specified selectors are identical.
 687   bool operator==(Selector RHS) const {
 688     return InfoPtr == RHS.InfoPtr;
 689   }
 690   bool operator!=(Selector RHS) const {
 691     return InfoPtr != RHS.InfoPtr;
 692   }
 693
 694   void *getAsOpaquePtr() const {
 695     return reinterpret_cast<void*>(InfoPtr);
 696   }
 697
 698   /// \brief Determine whether this is the empty selector.
 699   bool isNull() const { return InfoPtr == 0; }
 700
 701   // Predicates to identify the selector type.
 702   bool isKeywordSelector() const {
 703     return getIdentifierInfoFlag() != ZeroArg;
 704   }
 705
 706   bool isUnarySelector() const {
 707     return getIdentifierInfoFlag() == ZeroArg;
 708   }
 709
 710   unsigned getNumArgs() const;
 711
 712   /// \brief Retrieve the identifier at a given position in the selector.
 713   ///
 714   /// Note that the identifier pointer returned may be NULL. Clients that only
 715   /// care about the text of the identifier string, and not the specific,
 716   /// uniqued identifier pointer, should use \c getNameForSlot(), which returns
 717   /// an empty string when the identifier pointer would be NULL.
 718   ///
 719   /// \param argIndex The index for which we want to retrieve the identifier.
 720   /// This index shall be less than \c getNumArgs() unless this is a keyword
 721   /// selector, in which case 0 is the only permissible value.
 722   ///
 723   /// \returns the uniqued identifier for this slot, or NULL if this slot has
 724   /// no corresponding identifier.
 725   IdentifierInfo *getIdentifierInfoForSlot(unsigned argIndex) const;
 726
 727   /// \brief Retrieve the name at a given position in the selector.
 728   ///
 729   /// \param argIndex The index for which we want to retrieve the name.
 730   /// This index shall be less than \c getNumArgs() unless this is a keyword
 731   /// selector, in which case 0 is the only permissible value.
 732   ///
 733   /// \returns the name for this slot, which may be the empty string if no
 734   /// name was supplied.
 735   StringRef getNameForSlot(unsigned argIndex) const;
 736
 737   /// \brief Derive the full selector name (e.g. "foo:bar:") and return
 738   /// it as an std::string.
 739   std::string getAsString() const;
 740
 741   /// \brief Prints the full selector name (e.g. "foo:bar:").
 742   void print(llvm::raw_ostream &OS) const;
 743
 744   /// \brief Derive the conventional family of this method.
 745   ObjCMethodFamily getMethodFamily() const {
 746     return getMethodFamilyImpl(*this);
 747   }
 748
 749   ObjCStringFormatFamily getStringFormatFamily() const {
 750     return getStringFormatFamilyImpl(*this);
 751   }
 752
 753   static Selector getEmptyMarker() {
 754     return Selector(uintptr_t(-1));
 755   }
 756
 757   static Selector getTombstoneMarker() {
 758     return Selector(uintptr_t(-2));
 759   }
 760
 761   static ObjCInstanceTypeFamily getInstTypeMethodFamily(Selector sel);
 762 };
 763
 764 /// \brief This table allows us to fully hide how we implement
 765 /// multi-keyword caching.
 766 class SelectorTable {
 767   void *Impl;  // Actually a SelectorTableImpl
 768
 769 public:
 770   SelectorTable();
 771   SelectorTable(const SelectorTable &) = delete;
 772   SelectorTable &operator=(const SelectorTable &) = delete;
 773   ~SelectorTable();
 774
 775   /// \brief Can create any sort of selector.
 776   ///
 777   /// \p NumArgs indicates whether this is a no argument selector "foo", a
 778   /// single argument selector "foo:" or multi-argument "foo:bar:".
 779   Selector getSelector(unsigned NumArgs, IdentifierInfo **IIV);
 780
 781   Selector getUnarySelector(IdentifierInfo *ID) {
 782     return Selector(ID, 1);
 783   }
 784   Selector getNullarySelector(IdentifierInfo *ID) {
 785     return Selector(ID, 0);
 786   }
 787
 788   /// \brief Return the total amount of memory allocated for managing selectors.
 789   size_t getTotalMemory() const;
 790
 791   /// \brief Return the default setter name for the given identifier.
 792   ///
 793   /// This is "set" + \p Name where the initial character of \p Name
 794   /// has been capitalized.
 795   static SmallString<64> constructSetterName(StringRef Name);
 796
 797   /// \brief Return the default setter selector for the given identifier.
 798   ///
 799   /// This is "set" + \p Name where the initial character of \p Name
 800   /// has been capitalized.
 801   static Selector constructSetterSelector(IdentifierTable &Idents,
 802                                           SelectorTable &SelTable,
 803                                           const IdentifierInfo *Name);
 804 };
 805
 806 /// DeclarationNameExtra - Common base of the MultiKeywordSelector,
 807 /// CXXSpecialName, and CXXOperatorIdName classes, all of which are
 808 /// private classes that describe different kinds of names.
 809 class DeclarationNameExtra {
 810 public:
 811   /// ExtraKind - The kind of "extra" information stored in the
 812   /// DeclarationName. See @c ExtraKindOrNumArgs for an explanation of
 813   /// how these enumerator values are used.
 814   enum ExtraKind {
 815     CXXConstructor = 0,
 816     CXXDestructor,
 817     CXXConversionFunction,
 818 #define OVERLOADED_OPERATOR(Name,Spelling,Token,Unary,Binary,MemberOnly) \
 819     CXXOperator##Name,
 820 #include "clang/Basic/OperatorKinds.def"
 821     CXXLiteralOperator,
 822     CXXUsingDirective,
 823     NUM_EXTRA_KINDS
 824   };
 825
 826   /// ExtraKindOrNumArgs - Either the kind of C++ special name or
 827   /// operator-id (if the value is one of the CXX* enumerators of
 828   /// ExtraKind), in which case the DeclarationNameExtra is also a
 829   /// CXXSpecialName, (for CXXConstructor, CXXDestructor, or
 830   /// CXXConversionFunction) CXXOperatorIdName, or CXXLiteralOperatorName,
 831   /// it may be also name common to C++ using-directives (CXXUsingDirective),
 832   /// otherwise it is NUM_EXTRA_KINDS+NumArgs, where NumArgs is the number of
 833   /// arguments in the Objective-C selector, in which case the
 834   /// DeclarationNameExtra is also a MultiKeywordSelector.
 835   unsigned ExtraKindOrNumArgs;
 836 };
 837
 838 }  // end namespace clang
 839
 840 namespace llvm {
 841
 842 /// Define DenseMapInfo so that Selectors can be used as keys in DenseMap and
 843 /// DenseSets.
 844 template <>
 845 struct DenseMapInfo<clang::Selector> {
 846   static inline clang::Selector getEmptyKey() {
 847     return clang::Selector::getEmptyMarker();
 848   }
 849
 850   static inline clang::Selector getTombstoneKey() {
 851     return clang::Selector::getTombstoneMarker();
 852   }
 853
 854   static unsigned getHashValue(clang::Selector S);
 855
 856   static bool isEqual(clang::Selector LHS, clang::Selector RHS) {
 857     return LHS == RHS;
 858   }
 859 };
 860
 861 template <>
 862 struct isPodLike<clang::Selector> { static const bool value = true; };
 863
 864 template <typename T> class PointerLikeTypeTraits;
 865
 866 template<>
 867 class PointerLikeTypeTraits<clang::Selector> {
 868 public:
 869   static inline const void *getAsVoidPointer(clang::Selector P) {
 870     return P.getAsOpaquePtr();
 871   }
 872
 873   static inline clang::Selector getFromVoidPointer(const void *P) {
 874     return clang::Selector(reinterpret_cast<uintptr_t>(P));
 875   }
 876
 877   enum { NumLowBitsAvailable = 0 };
 878 };
 879
 880 // Provide PointerLikeTypeTraits for IdentifierInfo pointers, which
 881 // are not guaranteed to be 8-byte aligned.
 882 template<>
 883 class PointerLikeTypeTraits<clang::IdentifierInfo*> {
 884 public:
 885   static inline void *getAsVoidPointer(clang::IdentifierInfo* P) {
 886     return P;
 887   }
 888
 889   static inline clang::IdentifierInfo *getFromVoidPointer(void *P) {
 890     return static_cast<clang::IdentifierInfo*>(P);
 891   }
 892
 893   enum { NumLowBitsAvailable = 1 };
 894 };
 895
 896 template<>
 897 class PointerLikeTypeTraits<const clang::IdentifierInfo*> {
 898 public:
 899   static inline const void *getAsVoidPointer(const clang::IdentifierInfo* P) {
 900     return P;
 901   }
 902
 903   static inline const clang::IdentifierInfo *getFromVoidPointer(const void *P) {
 904     return static_cast<const clang::IdentifierInfo*>(P);
 905   }
 906
 907   enum { NumLowBitsAvailable = 1 };
 908 };
 909
 910 } // end namespace llvm
 911
 912 #endif // LLVM_CLANG_BASIC_IDENTIFIERTABLE_H