IdentifierTable.h revision 813d8346529bf094eb2b249648906ba7fd226688
15f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===--- IdentifierTable.h - Hash table for identifier lookup ---*- C++ -*-===//
25f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
35f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//                     The LLVM Compiler Infrastructure
45f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
50bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// This file is distributed under the University of Illinois Open Source
60bc735ffcfb223c0186419547abaa5c84482663eChris Lattner// License. See LICENSE.TXT for details.
75f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
85f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===//
95f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
10c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner// This file defines the IdentifierInfo, IdentifierTable, and Selector
11c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner// interfaces.
125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//
135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer//===----------------------------------------------------------------------===//
145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
15c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#ifndef LLVM_CLANG_BASIC_IDENTIFIERTABLE_H
16c7229c338c21ef26b01ef3ecf9eec4fd373fa9ecChris Lattner#define LLVM_CLANG_BASIC_IDENTIFIERTABLE_H
175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
181cd1b1e987f5e2f060d7972b13d83239b36d77d6Douglas Gregor#include "clang/Basic/OperatorKinds.h"
195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "clang/Basic/TokenKinds.h"
205f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "llvm/ADT/StringMap.h"
21700030ebddb987936d4fee14d9412821d96e4840Kovarththanan Rajaratnam#include "llvm/ADT/StringRef.h"
2268d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff#include "llvm/ADT/SmallString.h"
2372b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek#include "llvm/ADT/OwningPtr.h"
241734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor#include "llvm/Support/PointerLikeTypeTraits.h"
251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump#include <cassert>
26403ba3522d1b1c97ae5fad81c1a2c4b3a754e1c1Nick Lewycky#include <cctype>
27403ba3522d1b1c97ae5fad81c1a2c4b3a754e1c1Nick Lewycky#include <string>
285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
2985994260c41a54cab061a434ed378fc448333a4eChris Lattnernamespace llvm {
3085994260c41a54cab061a434ed378fc448333a4eChris Lattner  template <typename T> struct DenseMapInfo;
3185994260c41a54cab061a434ed378fc448333a4eChris Lattner}
3229238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff
335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang {
34ea684e699ea84e61711e279f5fa7a1b9f3d46bc2Cedric Venet  class LangOptions;
357caeabd868d46cf4e68478c6e9136dae4e735d21Chris Lattner  class IdentifierInfo;
36ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek  class IdentifierTable;
377caeabd868d46cf4e68478c6e9136dae4e735d21Chris Lattner  class SourceLocation;
382e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  class MultiKeywordSelector; // private class used by Selector
392e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  class DeclarationName;      // AST class that stores declaration names
402e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor
417caeabd868d46cf4e68478c6e9136dae4e735d21Chris Lattner  /// IdentifierLocPair - A simple pair of identifier info and location.
427caeabd868d46cf4e68478c6e9136dae4e735d21Chris Lattner  typedef std::pair<IdentifierInfo*, SourceLocation> IdentifierLocPair;
431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// IdentifierInfo - One of these records is kept for each identifier that
465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// is lexed.  This contains information about whether the token was #define'd,
475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// is a language keyword, or if it is a front-end token of some sort (e.g. a
485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// variable or function name).  The preprocessor keeps this information in a
491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// set, and all tok::identifier tokens have a pointer to one of these.
505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass IdentifierInfo {
518e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek  // Note: DON'T make TokenID a 'tok::TokenKind'; MSVC will treat it as a
528e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek  //       signed char and TokenKinds > 127 won't be handled correctly.
531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  unsigned TokenID            : 8; // Front-end token ID or tok::identifier.
545142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor  // Objective-C keyword ('protocol' in '@protocol') or builtin (__builtin_inf).
555142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor  // First NUM_OBJC_KEYWORDS values are for Objective-C, the remaining values
565142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor  // are for builtins.
57c81ca9852806e75972bbb246fa916152e8fba541Ted Kremenek  unsigned ObjCOrBuiltinID    :11;
584365a7e46822700357a272d839ee2656d9603d5aChris Lattner  bool HasMacro               : 1; // True if there is a #define for this.
595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  bool IsExtension            : 1; // True if identifier is a lang extension.
605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  bool IsPoisoned             : 1; // True if identifier is poisoned.
615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  bool IsCPPOperatorKeyword   : 1; // True if ident is a C++ operator keyword.
626a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  bool NeedsHandleIdentifier  : 1; // See "RecomputeNeedsHandleIdentifier".
633c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  bool IsFromAST              : 1; // True if identfier first appeared in an AST
643c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl                                   // file and wasn't modified since.
65646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis  bool RevertedTokenID        : 1; // True if RevertTokenIDToIdentifier was
66646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis                                   // called.
67c81ca9852806e75972bbb246fa916152e8fba541Ted Kremenek  // 6 bits left in 32-bit word.
685f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void *FETokenInfo;               // Managed by the language front-end.
69ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek  llvm::StringMapEntry<IdentifierInfo*> *Entry;
701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  IdentifierInfo(const IdentifierInfo&);  // NONCOPYABLE.
724365a7e46822700357a272d839ee2656d9603d5aChris Lattner  void operator=(const IdentifierInfo&);  // NONASSIGNABLE.
73ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek
741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  friend class IdentifierTable;
75295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor
765f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic:
77ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek  IdentifierInfo();
785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
791eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
8092e62b02226410bcad8584541b8f1ff4d35ebab9Chris Lattner  /// isStr - Return true if this is the identifier for the specified string.
8192e62b02226410bcad8584541b8f1ff4d35ebab9Chris Lattner  /// This is intended to be used for string literals only: II->isStr("foo").
8292e62b02226410bcad8584541b8f1ff4d35ebab9Chris Lattner  template <std::size_t StrLen>
8392e62b02226410bcad8584541b8f1ff4d35ebab9Chris Lattner  bool isStr(const char (&Str)[StrLen]) const {
847fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar    return getLength() == StrLen-1 && !memcmp(getNameStart(), Str, StrLen-1);
85845222ccd992282bf74b2fca53e7c3b84a81c098Chris Lattner  }
861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
877fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar  /// getNameStart - Return the beginning of the actual string for this
887fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar  /// identifier.  The returned string is properly null terminated.
895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ///
907fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar  const char *getNameStart() const {
91ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek    if (Entry) return Entry->getKeyData();
927e3a004c6ed1fe87912203b9c5a113f8da89d261Ted Kremenek    // FIXME: This is gross. It would be best not to embed specific details
937e3a004c6ed1fe87912203b9c5a113f8da89d261Ted Kremenek    // of the PTH file format here.
941eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump    // The 'this' pointer really points to a
95ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek    // std::pair<IdentifierInfo, const char*>, where internal pointer
96ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek    // points to the external string data.
9740844a8b5a89676fb61898d61ea4a7fa98eb9b6bGabor Greif    typedef std::pair<IdentifierInfo, const char*> actualtype;
9840844a8b5a89676fb61898d61ea4a7fa98eb9b6bGabor Greif    return ((const actualtype*) this)->second;
991f945f632ae993bbb9f9e69d908f7526924c1a88Chris Lattner  }
1001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1011f945f632ae993bbb9f9e69d908f7526924c1a88Chris Lattner  /// getLength - Efficiently return the length of this identifier info.
1021f945f632ae993bbb9f9e69d908f7526924c1a88Chris Lattner  ///
1031f945f632ae993bbb9f9e69d908f7526924c1a88Chris Lattner  unsigned getLength() const {
104ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek    if (Entry) return Entry->getKeyLength();
1057e3a004c6ed1fe87912203b9c5a113f8da89d261Ted Kremenek    // FIXME: This is gross. It would be best not to embed specific details
1067e3a004c6ed1fe87912203b9c5a113f8da89d261Ted Kremenek    // of the PTH file format here.
1071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump    // The 'this' pointer really points to a
108ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek    // std::pair<IdentifierInfo, const char*>, where internal pointer
109ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek    // points to the external string data.
11040844a8b5a89676fb61898d61ea4a7fa98eb9b6bGabor Greif    typedef std::pair<IdentifierInfo, const char*> actualtype;
11140844a8b5a89676fb61898d61ea4a7fa98eb9b6bGabor Greif    const char* p = ((const actualtype*) this)->second - 2;
1127fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar    return (((unsigned) p[0]) | (((unsigned) p[1]) << 8)) - 1;
1137fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar  }
1147fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar
11501eb9b9683535d8a65c704ad2c545903409e2d36Daniel Dunbar  /// getName - Return the actual identifier string.
11601eb9b9683535d8a65c704ad2c545903409e2d36Daniel Dunbar  llvm::StringRef getName() const {
1177fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar    return llvm::StringRef(getNameStart(), getLength());
1185f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  }
1191eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1209c46de446d18f4a28446cb798d4131bd05515699Chris Lattner  /// hasMacroDefinition - Return true if this identifier is #defined to some
1219c46de446d18f4a28446cb798d4131bd05515699Chris Lattner  /// other value.
1229c46de446d18f4a28446cb798d4131bd05515699Chris Lattner  bool hasMacroDefinition() const {
1239c46de446d18f4a28446cb798d4131bd05515699Chris Lattner    return HasMacro;
1249c46de446d18f4a28446cb798d4131bd05515699Chris Lattner  }
1256a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  void setHasMacroDefinition(bool Val) {
1266a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    if (HasMacro == Val) return;
1271eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1286a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    HasMacro = Val;
1296a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    if (Val)
1306a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner      NeedsHandleIdentifier = 1;
1316a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    else
1326a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner      RecomputeNeedsHandleIdentifier();
1333c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl    IsFromAST = false;
1346a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  }
1351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
136646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis  /// getTokenID - If this is a source-language token (e.g. 'for'), this API
1375f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// can be used to cause the lexer to map identifiers to source-language
1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// tokens.
1398e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek  tok::TokenKind getTokenID() const { return (tok::TokenKind)TokenID; }
140646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis
141646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis  /// \brief True if RevertTokenIDToIdentifier() was called.
142646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis  bool hasRevertedTokenIDToIdentifier() const { return RevertedTokenID; }
143646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis
144646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis  /// \brief Revert TokenID to tok::identifier; used for GNU libstdc++ 4.2
145f573084db5807f6003282bdf53ca9d58bab1ddc4Argyrios Kyrtzidis  /// compatibility.
146f573084db5807f6003282bdf53ca9d58bab1ddc4Argyrios Kyrtzidis  ///
147f573084db5807f6003282bdf53ca9d58bab1ddc4Argyrios Kyrtzidis  /// TokenID is normally read-only but there are 2 instances where we revert it
148f573084db5807f6003282bdf53ca9d58bab1ddc4Argyrios Kyrtzidis  /// to tok::identifier for libstdc++ 4.2. Keep track of when this happens
1493c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  /// using this method so we can inform serialization about it.
150646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis  void RevertTokenIDToIdentifier() {
151646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis    assert(TokenID != tok::identifier && "Already at tok::identifier");
152646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis    TokenID = tok::identifier;
153646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis    RevertedTokenID = true;
154646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis  }
1551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getPPKeywordID - Return the preprocessor keyword ID for this identifier.
1576d9a3e648d6bf6b347174152f191bd1377528f8cChris Lattner  /// For example, "define" will return tok::pp_define.
158387b98d37e08f7aa9ddf23e067e1d27e39ce16f3Chris Lattner  tok::PPKeywordKind getPPKeywordID() const;
1591eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
1605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getObjCKeywordID - Return the Objective-C keyword ID for the this
1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// identifier.  For example, 'class' will return tok::objc_class if ObjC is
1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// enabled.
163ca63fa00786e51c207c829f4182f11a6c6b552beTed Kremenek  tok::ObjCKeywordKind getObjCKeywordID() const {
1641eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump    if (ObjCOrBuiltinID < tok::NUM_OBJC_KEYWORDS)
1655142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor      return tok::ObjCKeywordKind(ObjCOrBuiltinID);
1665142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor    else
1675142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor      return tok::objc_not_keyword;
168ca63fa00786e51c207c829f4182f11a6c6b552beTed Kremenek  }
1695142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor  void setObjCKeywordID(tok::ObjCKeywordKind ID) { ObjCOrBuiltinID = ID; }
1703251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor
1715f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getBuiltinID - Return a value indicating whether this is a builtin
1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// function.  0 is not-built-in.  1 is builtin-for-some-nonprimary-target.
1735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// 2+ are specific builtin functions.
1741eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  unsigned getBuiltinID() const {
1755142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor    if (ObjCOrBuiltinID >= tok::NUM_OBJC_KEYWORDS)
1761eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump      return ObjCOrBuiltinID - tok::NUM_OBJC_KEYWORDS;
1775142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor    else
1785142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor      return 0;
1795142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor  }
1805f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void setBuiltinID(unsigned ID) {
1815142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor    ObjCOrBuiltinID = ID + tok::NUM_OBJC_KEYWORDS;
1821eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump    assert(ObjCOrBuiltinID - unsigned(tok::NUM_OBJC_KEYWORDS) == ID
1835142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor           && "ID too large for field!");
1845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  }
1853251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor
1863251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor  unsigned getObjCOrBuiltinID() const { return ObjCOrBuiltinID; }
1873251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor  void setObjCOrBuiltinID(unsigned ID) { ObjCOrBuiltinID = ID; }
1883251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor
1895f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// get/setExtension - Initialize information about whether or not this
1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// language token is an extension.  This controls extension warnings, and is
1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// only valid if a custom token ID is set.
1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  bool isExtensionToken() const { return IsExtension; }
1936a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  void setIsExtensionToken(bool Val) {
1946a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    IsExtension = Val;
1956a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    if (Val)
1966a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner      NeedsHandleIdentifier = 1;
1976a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    else
1986a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner      RecomputeNeedsHandleIdentifier();
1996a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  }
2001eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2015f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// setIsPoisoned - Mark this identifier as poisoned.  After poisoning, the
2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// Preprocessor will emit an error every time this token is used.
2036a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  void setIsPoisoned(bool Value = true) {
2046a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    IsPoisoned = Value;
2056a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    if (Value)
2066a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner      NeedsHandleIdentifier = 1;
2076a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    else
2086a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner      RecomputeNeedsHandleIdentifier();
2093c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl    IsFromAST = false;
2106a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  }
2111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2125f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// isPoisoned - Return true if this token has been poisoned.
2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  bool isPoisoned() const { return IsPoisoned; }
2141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2155f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// isCPlusPlusOperatorKeyword/setIsCPlusPlusOperatorKeyword controls whether
2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// this identifier is a C++ alternate representation of an operator.
2176a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  void setIsCPlusPlusOperatorKeyword(bool Val = true) {
2186a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    IsCPPOperatorKeyword = Val;
2196a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    if (Val)
2206a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner      NeedsHandleIdentifier = 1;
2216a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    else
2226a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner      RecomputeNeedsHandleIdentifier();
2236a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  }
2245f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  bool isCPlusPlusOperatorKeyword() const { return IsCPPOperatorKeyword; }
2255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
2265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// getFETokenInfo/setFETokenInfo - The language front-end is allowed to
2275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// associate arbitrary metadata with this token.
2285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  template<typename T>
2295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  T *getFETokenInfo() const { return static_cast<T*>(FETokenInfo); }
2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void setFETokenInfo(void *T) { FETokenInfo = T; }
2316a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner
2326a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  /// isHandleIdentifierCase - Return true if the Preprocessor::HandleIdentifier
2336a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  /// must be called on a token of this identifier.  If this returns false, we
2346a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  /// know that HandleIdentifier will not affect the token.
2356a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  bool isHandleIdentifierCase() const { return NeedsHandleIdentifier; }
2361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
2373c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  /// isFromAST - Return true if the identifier in its current state was loaded
2383c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  /// from an AST file.
2393c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  bool isFromAST() const { return IsFromAST; }
240ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl
2413c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl  void setIsFromAST(bool FromAST = true) { IsFromAST = FromAST; }
242ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl
2436a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattnerprivate:
2446a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  /// RecomputeNeedsHandleIdentifier - The Preprocessor::HandleIdentifier does
2456a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  /// several special (but rare) things to identifiers of various sorts.  For
2466a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  /// example, it changes the "for" keyword token from tok::identifier to
2476a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  /// tok::for.
2486a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  ///
2496a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  /// This method is very tied to the definition of HandleIdentifier.  Any
2506a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  /// change to it should be reflected here.
2516a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  void RecomputeNeedsHandleIdentifier() {
2526a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner    NeedsHandleIdentifier =
2536a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner      (isPoisoned() | hasMacroDefinition() | isCPlusPlusOperatorKeyword() |
254863c486fcb6162495a94fddf7ac8409de2638995Chris Lattner       isExtensionToken());
2556a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner  }
2565f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer};
2575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
25895f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// \brief An iterator that walks over all of the known identifiers
25995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// in the lookup table.
26095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor///
26195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// Since this iterator uses an abstract interface via virtual
26295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// functions, it uses an object-oriented interface rather than the
26395f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// more standard C++ STL iterator interface. In this OO-style
26495f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// iteration, the single function \c Next() provides dereference,
26595f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// advance, and end-of-sequence checking in a single
26695f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// operation. Subclasses of this iterator type will provide the
26795f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// actual functionality.
26895f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregorclass IdentifierIterator {
26995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregorprivate:
27095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  IdentifierIterator(const IdentifierIterator&); // Do not implement
27195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  IdentifierIterator &operator=(const IdentifierIterator&); // Do not implement
27295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor
27395f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregorprotected:
27495f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  IdentifierIterator() { }
27595f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor
27695f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregorpublic:
27795f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  virtual ~IdentifierIterator();
27895f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor
27995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// \brief Retrieve the next string in the identifier table and
28095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// advances the iterator for the following string.
28195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  ///
28295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// \returns The next string in the identifier table. If there is
28395f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// no such string, returns an empty \c llvm::StringRef.
28495f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  virtual llvm::StringRef Next() = 0;
28595f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor};
28695f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor
28772b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek/// IdentifierInfoLookup - An abstract class used by IdentifierTable that
288668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor///  provides an interface for performing lookups from strings
28972b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek/// (const char *) to IdentiferInfo objects.
29072b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenekclass IdentifierInfoLookup {
29172b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenekpublic:
29272b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek  virtual ~IdentifierInfoLookup();
2931eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
29472b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek  /// get - Return the identifier token info for the specified named identifier.
29572b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek  ///  Unlike the version in IdentifierTable, this returns a pointer instead
29672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek  ///  of a reference.  If the pointer is NULL then the IdentifierInfo cannot
29772b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek  ///  be found.
298700030ebddb987936d4fee14d9412821d96e4840Kovarththanan Rajaratnam  virtual IdentifierInfo* get(llvm::StringRef Name) = 0;
29995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor
30095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// \brief Retrieve an iterator into the set of all identifiers
30195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// known to this identifier lookup source.
30295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  ///
30395f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// This routine provides access to all of the identifiers known to
30495f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// the identifier lookup, allowing access to the contents of the
30595f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// identifiers without introducing the overhead of constructing
30695f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// IdentifierInfo objects for each.
30795f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  ///
30895f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// \returns A new iterator into the set of known identifiers. The
30995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// caller is responsible for deleting this iterator.
31095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  virtual IdentifierIterator *getIdentifiers() const;
3111eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump};
3128c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor
3138c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor/// \brief An abstract class used to resolve numerical identifier
3148c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor/// references (meaningful only to some external source) into
3158c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor/// IdentifierInfo pointers.
3168c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregorclass ExternalIdentifierLookup {
3178c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregorpublic:
3188c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor  virtual ~ExternalIdentifierLookup();
3198c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor
3208c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor  /// \brief Return the identifier associated with the given ID number.
3218c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor  ///
3228c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor  /// The ID 0 is associated with the NULL identifier.
3238c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor  virtual IdentifierInfo *GetIdentifier(unsigned ID) = 0;
3248c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor};
3258c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor
3265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// IdentifierTable - This table implements an efficient mapping from strings to
3275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// IdentifierInfo nodes.  It has no other purpose, but this is an
3285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// extremely performance-critical piece of the code, as each occurrance of
3295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// every identifier goes through here when lexed.
3305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass IdentifierTable {
3315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // Shark shows that using MallocAllocator is *much* slower than using this
3325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  // BumpPtrAllocator!
333ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek  typedef llvm::StringMap<IdentifierInfo*, llvm::BumpPtrAllocator> HashTableTy;
3345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  HashTableTy HashTable;
3351eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
33672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek  IdentifierInfoLookup* ExternalLookup;
3371cd1b1e987f5e2f060d7972b13d83239b36d77d6Douglas Gregor
3385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic:
3395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// IdentifierTable ctor - Create the identifier table, populating it with
3405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// info about the language keywords for the language specified by LangOpts.
34172b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek  IdentifierTable(const LangOptions &LangOpts,
34272b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek                  IdentifierInfoLookup* externalLookup = 0);
3431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
344668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor  /// \brief Set the external identifier lookup mechanism.
345668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor  void setExternalIdentifierLookup(IdentifierInfoLookup *IILookup) {
346668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor    ExternalLookup = IILookup;
347668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor  }
348668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor
34995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  /// \brief Retrieve the external identifier lookup object, if any.
35095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  IdentifierInfoLookup *getExternalIdentifierLookup() const {
35195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor    return ExternalLookup;
35295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor  }
35395f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor
35472b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek  llvm::BumpPtrAllocator& getAllocator() {
35572b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek    return HashTable.getAllocator();
35672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek  }
3571eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
3585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// get - Return the identifier token info for the specified named identifier.
3595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  ///
3606488292f5e204fed99bb43ab23b8342ddc03ce89Kovarththanan Rajaratnam  IdentifierInfo &get(llvm::StringRef Name) {
361ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek    llvm::StringMapEntry<IdentifierInfo*> &Entry =
3626488292f5e204fed99bb43ab23b8342ddc03ce89Kovarththanan Rajaratnam      HashTable.GetOrCreateValue(Name);
3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
364ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek    IdentifierInfo *II = Entry.getValue();
365d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    if (II) return *II;
3661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
367d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    // No entry; if we have an external lookup, look there first.
368d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    if (ExternalLookup) {
3696488292f5e204fed99bb43ab23b8342ddc03ce89Kovarththanan Rajaratnam      II = ExternalLookup->get(Name);
370d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar      if (II) {
371d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar        // Cache in the StringMap for subsequent lookups.
372d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar        Entry.setValue(II);
373d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar        return *II;
374ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek      }
375d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek    }
376ccb9bac3adb35a2dc78c1737e7b2dc6537a16393Daniel Dunbar
377d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    // Lookups failed, make a new IdentifierInfo.
378d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    void *Mem = getAllocator().Allocate<IdentifierInfo>();
379d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    II = new (Mem) IdentifierInfo();
380d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    Entry.setValue(II);
381d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar
382d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    // Make sure getName() knows how to find the IdentifierInfo
383d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    // contents.
384d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar    II->Entry = &Entry;
385d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar
386ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek    return *II;
3875f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  }
3881eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
389646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis  IdentifierInfo &get(llvm::StringRef Name, tok::TokenKind TokenCode) {
390646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis    IdentifierInfo &II = get(Name);
391646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis    II.TokenID = TokenCode;
392646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis    return II;
393646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis  }
394646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis
3956488292f5e204fed99bb43ab23b8342ddc03ce89Kovarththanan Rajaratnam  IdentifierInfo &get(const char *NameStart, const char *NameEnd) {
3966488292f5e204fed99bb43ab23b8342ddc03ce89Kovarththanan Rajaratnam    return get(llvm::StringRef(NameStart, NameEnd-NameStart));
397811f4267aa1ebd727c31594b8ed94048e2c10ad6Kovarththanan Rajaratnam  }
398811f4267aa1ebd727c31594b8ed94048e2c10ad6Kovarththanan Rajaratnam
399811f4267aa1ebd727c31594b8ed94048e2c10ad6Kovarththanan Rajaratnam  IdentifierInfo &get(const char *Name, size_t NameLen) {
400811f4267aa1ebd727c31594b8ed94048e2c10ad6Kovarththanan Rajaratnam    return get(llvm::StringRef(Name, NameLen));
401811f4267aa1ebd727c31594b8ed94048e2c10ad6Kovarththanan Rajaratnam  }
402811f4267aa1ebd727c31594b8ed94048e2c10ad6Kovarththanan Rajaratnam
403ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl  /// \brief Gets an IdentifierInfo for the given name without consulting
404ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl  ///        external sources.
4055f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor  ///
406ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl  /// This is a version of get() meant for external sources that want to
407ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl  /// introduce or modify an identifier. If they called get(), they would
408ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl  /// likely end up in a recursion.
409ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl  IdentifierInfo &getOwn(const char *NameStart, const char *NameEnd) {
4105f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor    llvm::StringMapEntry<IdentifierInfo*> &Entry =
4115f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor      HashTable.GetOrCreateValue(NameStart, NameEnd);
4121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
4135f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor    IdentifierInfo *II = Entry.getValue();
414ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl    if (!II) {
4151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
416ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl      // Lookups failed, make a new IdentifierInfo.
417ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl      void *Mem = getAllocator().Allocate<IdentifierInfo>();
418ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl      II = new (Mem) IdentifierInfo();
419ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl      Entry.setValue(II);
4205f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor
421ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl      // Make sure getName() knows how to find the IdentifierInfo
422ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl      // contents.
423ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl      II->Entry = &Entry;
424ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl    }
4255f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor
4265f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor    return *II;
4275f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor  }
428ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl  IdentifierInfo &getOwn(llvm::StringRef Name) {
429ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl    return getOwn(Name.begin(), Name.end());
43083885f7e3bf68d271e1e96726931814b836353a3Daniel Dunbar  }
4315f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor
4325f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  typedef HashTableTy::const_iterator iterator;
4335f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  typedef HashTableTy::const_iterator const_iterator;
4341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
4355f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  iterator begin() const { return HashTable.begin(); }
4365f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  iterator end() const   { return HashTable.end(); }
437c637e6b7afeebc6b4f751e4373715b6a8ea77272Ted Kremenek  unsigned size() const { return HashTable.size(); }
4381eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
4395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// PrintStats - Print some statistics to stderr that indicate how well the
4405f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  /// hashing is doing.
4415f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void PrintStats() const;
4421eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
4435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer  void AddKeywords(const LangOptions &LangOpts);
4445f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer};
4455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
44629238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// Selector - This smart pointer class efficiently represents Objective-C
44729238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// method names. This class will either point to an IdentifierInfo or a
44829238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// MultiKeywordSelector (which is private). This enables us to optimize
4491eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// selectors that take no arguments and selectors that take 1 argument, which
45029238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// accounts for 78% of all selectors in Cocoa.h.
451bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroffclass Selector {
4528af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek  friend class DiagnosticInfo;
4531eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
454bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  enum IdentifierInfoFlag {
4550e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner    // MultiKeywordSelector = 0.
456bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    ZeroArg  = 0x1,
457bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    OneArg   = 0x2,
458bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    ArgFlags = ZeroArg|OneArg
459bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  };
460bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  uintptr_t InfoPtr; // a pointer to the MultiKeywordSelector or IdentifierInfo.
4611eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
462bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  Selector(IdentifierInfo *II, unsigned nArgs) {
463bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    InfoPtr = reinterpret_cast<uintptr_t>(II);
4640e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner    assert((InfoPtr & ArgFlags) == 0 &&"Insufficiently aligned IdentifierInfo");
4650e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner    assert(nArgs < 2 && "nArgs not equal to 0/1");
4660e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner    InfoPtr |= nArgs+1;
467bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  }
468bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  Selector(MultiKeywordSelector *SI) {
469bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    InfoPtr = reinterpret_cast<uintptr_t>(SI);
4700e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner    assert((InfoPtr & ArgFlags) == 0 &&"Insufficiently aligned IdentifierInfo");
471bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  }
4721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
473bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  IdentifierInfo *getAsIdentifierInfo() const {
4740e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner    if (getIdentifierInfoFlag())
475bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff      return reinterpret_cast<IdentifierInfo *>(InfoPtr & ~ArgFlags);
476bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    return 0;
477bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  }
478bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  unsigned getIdentifierInfoFlag() const {
479bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    return InfoPtr & ArgFlags;
480bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  }
4818af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek
4828af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenekpublic:
4838af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek  friend class SelectorTable; // only the SelectorTable can create these
4848af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek  friend class DeclarationName; // and the AST's DeclarationName.
4858af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek
4868af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek  /// The default ctor should only be used when creating data structures that
4878af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek  ///  will contain selectors.
4888af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek  Selector() : InfoPtr(0) {}
48990cd1bb1baac2a0221f3642de0cbea3244b116e5Steve Naroff  Selector(uintptr_t V) : InfoPtr(V) {}
4908af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek
491bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  /// operator==/!= - Indicate whether the specified selectors are identical.
49297b7f26a92d87e514530a5b652460190ce48c974Ted Kremenek  bool operator==(Selector RHS) const {
493bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    return InfoPtr == RHS.InfoPtr;
494bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  }
49597b7f26a92d87e514530a5b652460190ce48c974Ted Kremenek  bool operator!=(Selector RHS) const {
496bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    return InfoPtr != RHS.InfoPtr;
497bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  }
498bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  void *getAsOpaquePtr() const {
499bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    return reinterpret_cast<void*>(InfoPtr);
500bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  }
501405bad07391494d2eb025f8222c256c66b56e5f8Douglas Gregor
502405bad07391494d2eb025f8222c256c66b56e5f8Douglas Gregor  /// \brief Determine whether this is the empty selector.
503405bad07391494d2eb025f8222c256c66b56e5f8Douglas Gregor  bool isNull() const { return InfoPtr == 0; }
504405bad07391494d2eb025f8222c256c66b56e5f8Douglas Gregor
505bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  // Predicates to identify the selector type.
5061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  bool isKeywordSelector() const {
5071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump    return getIdentifierInfoFlag() != ZeroArg;
508bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  }
5091eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump  bool isUnarySelector() const {
510bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff    return getIdentifierInfoFlag() == ZeroArg;
511bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff  }
5125b6b72f53ad164497cf62484b60cdbb4361f1978Steve Naroff  unsigned getNumArgs() const;
513813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor
514813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor
515813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// \brief Retrieve the identifier at a given position in the selector.
516813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  ///
517813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// Note that the identifier pointer returned may be NULL. Clients that only
518813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// care about the text of the identifier string, and not the specific,
519813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// uniqued identifier pointer, should use \c getNameForSlot(), which returns
520813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// an empty string when the identifier pointer would be NULL.
521813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  ///
522813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// \param argIndex The index for which we want to retrieve the identifier.
523813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// This index shall be less than \c getNumArgs() unless this is a keyword
524813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// selector, in which case 0 is the only permissible value.
525813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  ///
526813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// \returns the uniqued identifier for this slot, or NULL if this slot has
527813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// no corresponding identifier.
528f836e3fea2c77fdbb18170fb313ee0d45551320bChris Lattner  IdentifierInfo *getIdentifierInfoForSlot(unsigned argIndex) const;
529813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor
530813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// \brief Retrieve the name at a given position in the selector.
531813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  ///
532813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// \param argIndex The index for which we want to retrieve the name.
533813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// This index shall be less than \c getNumArgs() unless this is a keyword
534813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// selector, in which case 0 is the only permissible value.
535813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  ///
536813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// \returns the name for this slot, which may be the empty string if no
537813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  /// name was supplied.
538813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor  llvm::StringRef getNameForSlot(unsigned argIndex) const;
539813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor
540077bf5e2f48acfa9e7d69429b6e4ba86ea14896dChris Lattner  /// getAsString - Derive the full selector name (e.g. "foo:bar:") and return
541077bf5e2f48acfa9e7d69429b6e4ba86ea14896dChris Lattner  /// it as an std::string.
542077bf5e2f48acfa9e7d69429b6e4ba86ea14896dChris Lattner  std::string getAsString() const;
5431eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
54485994260c41a54cab061a434ed378fc448333a4eChris Lattner  static Selector getEmptyMarker() {
54585994260c41a54cab061a434ed378fc448333a4eChris Lattner    return Selector(uintptr_t(-1));
54685994260c41a54cab061a434ed378fc448333a4eChris Lattner  }
54785994260c41a54cab061a434ed378fc448333a4eChris Lattner  static Selector getTombstoneMarker() {
54885994260c41a54cab061a434ed378fc448333a4eChris Lattner    return Selector(uintptr_t(-2));
54985994260c41a54cab061a434ed378fc448333a4eChris Lattner  }
550bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff};
551bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff
55229238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// SelectorTable - This table allows us to fully hide how we implement
55329238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// multi-keyword caching.
55429238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroffclass SelectorTable {
5555f7d2284c4b2f08d155732454002e68dc40c33efChris Lattner  void *Impl;  // Actually a SelectorTableImpl
55629238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff  SelectorTable(const SelectorTable&); // DISABLED: DO NOT IMPLEMENT
55729238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff  void operator=(const SelectorTable&); // DISABLED: DO NOT IMPLEMENT
55829238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroffpublic:
55929238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff  SelectorTable();
56029238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff  ~SelectorTable();
56129238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff
562ff38491c18b060526d754765b952f4a497a89416Chris Lattner  /// getSelector - This can create any sort of selector.  NumArgs indicates
563ff38491c18b060526d754765b952f4a497a89416Chris Lattner  /// whether this is a no argument selector "foo", a single argument selector
564ff38491c18b060526d754765b952f4a497a89416Chris Lattner  /// "foo:" or multi-argument "foo:bar:".
565ff38491c18b060526d754765b952f4a497a89416Chris Lattner  Selector getSelector(unsigned NumArgs, IdentifierInfo **IIV);
5661eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
567ff38491c18b060526d754765b952f4a497a89416Chris Lattner  Selector getUnarySelector(IdentifierInfo *ID) {
568ff38491c18b060526d754765b952f4a497a89416Chris Lattner    return Selector(ID, 1);
569ff38491c18b060526d754765b952f4a497a89416Chris Lattner  }
570ff38491c18b060526d754765b952f4a497a89416Chris Lattner  Selector getNullarySelector(IdentifierInfo *ID) {
571ff38491c18b060526d754765b952f4a497a89416Chris Lattner    return Selector(ID, 0);
572ff38491c18b060526d754765b952f4a497a89416Chris Lattner  }
57361f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff
57461f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff  /// constructSetterName - Return the setter name for the given
57561f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff  /// identifier, i.e. "set" + Name where the initial character of Name
57661f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff  /// has been capitalized.
577fdc92b7877535e6264fe43cfbdc8f01e9b224f81Steve Naroff  static Selector constructSetterName(IdentifierTable &Idents,
578fdc92b7877535e6264fe43cfbdc8f01e9b224f81Steve Naroff                                      SelectorTable &SelTable,
579fdc92b7877535e6264fe43cfbdc8f01e9b224f81Steve Naroff                                      const IdentifierInfo *Name) {
58061f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff    llvm::SmallString<100> SelectorName;
58161f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff    SelectorName = "set";
58201eb9b9683535d8a65c704ad2c545903409e2d36Daniel Dunbar    SelectorName += Name->getName();
58361f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff    SelectorName[3] = toupper(SelectorName[3]);
5842781deb126663ca1bd412044a1e66577585987b3Kovarththanan Rajaratnam    IdentifierInfo *SetterName = &Idents.get(SelectorName);
585fdc92b7877535e6264fe43cfbdc8f01e9b224f81Steve Naroff    return SelTable.getUnarySelector(SetterName);
58661f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff  }
58729238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff};
58829238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff
589e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor/// DeclarationNameExtra - Common base of the MultiKeywordSelector,
590e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor/// CXXSpecialName, and CXXOperatorIdName classes, all of which are
591e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor/// private classes that describe different kinds of names.
5922e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregorclass DeclarationNameExtra {
5932e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregorpublic:
5942e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  /// ExtraKind - The kind of "extra" information stored in the
5952e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  /// DeclarationName. See @c ExtraKindOrNumArgs for an explanation of
5962e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  /// how these enumerator values are used.
5972e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  enum ExtraKind {
5982e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor    CXXConstructor = 0,
5992e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor    CXXDestructor,
6002e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor    CXXConversionFunction,
601e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor#define OVERLOADED_OPERATOR(Name,Spelling,Token,Unary,Binary,MemberOnly) \
602e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor    CXXOperator##Name,
603e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor#include "clang/Basic/OperatorKinds.def"
6043e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt    CXXLiteralOperator,
6052a3009a432bdcec59e6383d7b2b17494d6f91649Douglas Gregor    CXXUsingDirective,
6062e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor    NUM_EXTRA_KINDS
6072e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  };
6085f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer
609e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor  /// ExtraKindOrNumArgs - Either the kind of C++ special name or
610e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor  /// operator-id (if the value is one of the CXX* enumerators of
611e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor  /// ExtraKind), in which case the DeclarationNameExtra is also a
6123e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt  /// CXXSpecialName, (for CXXConstructor, CXXDestructor, or
6133e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt  /// CXXConversionFunction) CXXOperatorIdName, or CXXLiteralOperatorName,
6143e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt  /// it may be also name common to C++ using-directives (CXXUsingDirective),
6153e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt  /// otherwise it is NUM_EXTRA_KINDS+NumArgs, where NumArgs is the number of
6162e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  /// arguments in the Objective-C selector, in which case the
6172e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  /// DeclarationNameExtra is also a MultiKeywordSelector.
6182e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor  unsigned ExtraKindOrNumArgs;
6192e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor};
6202e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor
6212e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor}  // end namespace clang
6224365a7e46822700357a272d839ee2656d9603d5aChris Lattner
6232e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregornamespace llvm {
6244365a7e46822700357a272d839ee2656d9603d5aChris Lattner/// Define DenseMapInfo so that Selectors can be used as keys in DenseMap and
6254365a7e46822700357a272d839ee2656d9603d5aChris Lattner/// DenseSets.
62685994260c41a54cab061a434ed378fc448333a4eChris Lattnertemplate <>
62785994260c41a54cab061a434ed378fc448333a4eChris Lattnerstruct DenseMapInfo<clang::Selector> {
62885994260c41a54cab061a434ed378fc448333a4eChris Lattner  static inline clang::Selector getEmptyKey() {
62985994260c41a54cab061a434ed378fc448333a4eChris Lattner    return clang::Selector::getEmptyMarker();
63085994260c41a54cab061a434ed378fc448333a4eChris Lattner  }
63185994260c41a54cab061a434ed378fc448333a4eChris Lattner  static inline clang::Selector getTombstoneKey() {
6321eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump    return clang::Selector::getTombstoneMarker();
63385994260c41a54cab061a434ed378fc448333a4eChris Lattner  }
6341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
63585994260c41a54cab061a434ed378fc448333a4eChris Lattner  static unsigned getHashValue(clang::Selector S);
6361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump
63785994260c41a54cab061a434ed378fc448333a4eChris Lattner  static bool isEqual(clang::Selector LHS, clang::Selector RHS) {
63885994260c41a54cab061a434ed378fc448333a4eChris Lattner    return LHS == RHS;
63985994260c41a54cab061a434ed378fc448333a4eChris Lattner  }
64085994260c41a54cab061a434ed378fc448333a4eChris Lattner};
641700030ebddb987936d4fee14d9412821d96e4840Kovarththanan Rajaratnam
64206159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnertemplate <>
64306159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnerstruct isPodLike<clang::Selector> { static const bool value = true; };
64406159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner
645d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregortemplate<>
646d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregorclass PointerLikeTypeTraits<clang::Selector> {
647d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregorpublic:
648d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor  static inline const void *getAsVoidPointer(clang::Selector P) {
649d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor    return P.getAsOpaquePtr();
650d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor  }
651d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor  static inline clang::Selector getFromVoidPointer(const void *P) {
652d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor    return clang::Selector(reinterpret_cast<uintptr_t>(P));
653d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor  }
654d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor  enum { NumLowBitsAvailable = 0 };
655d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor};
65685994260c41a54cab061a434ed378fc448333a4eChris Lattner
6571734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor// Provide PointerLikeTypeTraits for IdentifierInfo pointers, which
6581734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor// are not guaranteed to be 8-byte aligned.
6591734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregortemplate<>
6601734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregorclass PointerLikeTypeTraits<clang::IdentifierInfo*> {
6611734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregorpublic:
6621734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  static inline void *getAsVoidPointer(clang::IdentifierInfo* P) {
6631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump    return P;
6641734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  }
6651734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  static inline clang::IdentifierInfo *getFromVoidPointer(void *P) {
6661734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor    return static_cast<clang::IdentifierInfo*>(P);
6671734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  }
6681734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  enum { NumLowBitsAvailable = 1 };
6691734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor};
6701734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor
6711734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregortemplate<>
6721734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregorclass PointerLikeTypeTraits<const clang::IdentifierInfo*> {
6731734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregorpublic:
6741734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  static inline const void *getAsVoidPointer(const clang::IdentifierInfo* P) {
6751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump    return P;
6761734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  }
6771734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  static inline const clang::IdentifierInfo *getFromVoidPointer(const void *P) {
6781734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor    return static_cast<const clang::IdentifierInfo*>(P);
6791734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  }
6801734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor  enum { NumLowBitsAvailable = 1 };
6811734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor};
6821734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor
6832e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor}  // end namespace llvm
6845f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif
685