IdentifierTable.h revision 40847cfb58acc3cac7d68727df9455ac45f2e118
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" 20686775deca8b8685eb90801495880e3abdd844c2Chris Lattner#include "clang/Basic/LLVM.h" 215f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#include "llvm/ADT/StringMap.h" 22700030ebddb987936d4fee14d9412821d96e4840Kovarththanan Rajaratnam#include "llvm/ADT/StringRef.h" 2368d331a78e655d97294e94fcfa63f92cc1f40578Steve Naroff#include "llvm/ADT/SmallString.h" 2472b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek#include "llvm/ADT/OwningPtr.h" 251734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor#include "llvm/Support/PointerLikeTypeTraits.h" 261eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump#include <cassert> 27403ba3522d1b1c97ae5fad81c1a2c4b3a754e1c1Nick Lewycky#include <cctype> 28403ba3522d1b1c97ae5fad81c1a2c4b3a754e1c1Nick Lewycky#include <string> 295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 3085994260c41a54cab061a434ed378fc448333a4eChris Lattnernamespace llvm { 3185994260c41a54cab061a434ed378fc448333a4eChris Lattner template <typename T> struct DenseMapInfo; 3285994260c41a54cab061a434ed378fc448333a4eChris Lattner} 3329238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff 345f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencernamespace clang { 35ea684e699ea84e61711e279f5fa7a1b9f3d46bc2Cedric Venet class LangOptions; 367caeabd868d46cf4e68478c6e9136dae4e735d21Chris Lattner class IdentifierInfo; 37ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek class IdentifierTable; 387caeabd868d46cf4e68478c6e9136dae4e735d21Chris Lattner class SourceLocation; 392e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor class MultiKeywordSelector; // private class used by Selector 402e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor class DeclarationName; // AST class that stores declaration names 412e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 427caeabd868d46cf4e68478c6e9136dae4e735d21Chris Lattner /// IdentifierLocPair - A simple pair of identifier info and location. 437caeabd868d46cf4e68478c6e9136dae4e735d21Chris Lattner typedef std::pair<IdentifierInfo*, SourceLocation> IdentifierLocPair; 441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 451eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// IdentifierInfo - One of these records is kept for each identifier that 475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// is lexed. This contains information about whether the token was #define'd, 485f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// is a language keyword, or if it is a front-end token of some sort (e.g. a 495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// variable or function name). The preprocessor keeps this information in a 501eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// set, and all tok::identifier tokens have a pointer to one of these. 515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass IdentifierInfo { 528e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek // Note: DON'T make TokenID a 'tok::TokenKind'; MSVC will treat it as a 535cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor // signed char and TokenKinds > 255 won't be handled correctly. 545cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor unsigned TokenID : 9; // Front-end token ID or tok::identifier. 555142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor // Objective-C keyword ('protocol' in '@protocol') or builtin (__builtin_inf). 565142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor // First NUM_OBJC_KEYWORDS values are for Objective-C, the remaining values 575142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor // are for builtins. 58c81ca9852806e75972bbb246fa916152e8fba541Ted Kremenek unsigned ObjCOrBuiltinID :11; 594365a7e46822700357a272d839ee2656d9603d5aChris Lattner bool HasMacro : 1; // True if there is a #define for this. 605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool IsExtension : 1; // True if identifier is a lang extension. 615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool IsPoisoned : 1; // True if identifier is poisoned. 625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool IsCPPOperatorKeyword : 1; // True if ident is a C++ operator keyword. 636a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner bool NeedsHandleIdentifier : 1; // See "RecomputeNeedsHandleIdentifier". 643c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl bool IsFromAST : 1; // True if identfier first appeared in an AST 653c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl // file and wasn't modified since. 66646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis bool RevertedTokenID : 1; // True if RevertTokenIDToIdentifier was 67646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis // called. 685cee1195584fa8672253139c86e922daeda69b9eDouglas Gregor // 5 bits left in 32-bit word. 695f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void *FETokenInfo; // Managed by the language front-end. 70ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek llvm::StringMapEntry<IdentifierInfo*> *Entry; 711eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer IdentifierInfo(const IdentifierInfo&); // NONCOPYABLE. 734365a7e46822700357a272d839ee2656d9603d5aChris Lattner void operator=(const IdentifierInfo&); // NONASSIGNABLE. 74ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek 751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump friend class IdentifierTable; 76295a2a617ac335f590e430ab7fcd98f8ce109251Douglas Gregor 775f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 78ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek IdentifierInfo(); 795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 801eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 8192e62b02226410bcad8584541b8f1ff4d35ebab9Chris Lattner /// isStr - Return true if this is the identifier for the specified string. 8292e62b02226410bcad8584541b8f1ff4d35ebab9Chris Lattner /// This is intended to be used for string literals only: II->isStr("foo"). 8392e62b02226410bcad8584541b8f1ff4d35ebab9Chris Lattner template <std::size_t StrLen> 8492e62b02226410bcad8584541b8f1ff4d35ebab9Chris Lattner bool isStr(const char (&Str)[StrLen]) const { 857fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar return getLength() == StrLen-1 && !memcmp(getNameStart(), Str, StrLen-1); 86845222ccd992282bf74b2fca53e7c3b84a81c098Chris Lattner } 871eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 887fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar /// getNameStart - Return the beginning of the actual string for this 897fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar /// identifier. The returned string is properly null terminated. 905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 917fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar const char *getNameStart() const { 92ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek if (Entry) return Entry->getKeyData(); 937e3a004c6ed1fe87912203b9c5a113f8da89d261Ted Kremenek // FIXME: This is gross. It would be best not to embed specific details 947e3a004c6ed1fe87912203b9c5a113f8da89d261Ted Kremenek // of the PTH file format here. 951eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // The 'this' pointer really points to a 96ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek // std::pair<IdentifierInfo, const char*>, where internal pointer 97ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek // points to the external string data. 9840844a8b5a89676fb61898d61ea4a7fa98eb9b6bGabor Greif typedef std::pair<IdentifierInfo, const char*> actualtype; 9940844a8b5a89676fb61898d61ea4a7fa98eb9b6bGabor Greif return ((const actualtype*) this)->second; 1001f945f632ae993bbb9f9e69d908f7526924c1a88Chris Lattner } 1011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1021f945f632ae993bbb9f9e69d908f7526924c1a88Chris Lattner /// getLength - Efficiently return the length of this identifier info. 1031f945f632ae993bbb9f9e69d908f7526924c1a88Chris Lattner /// 1041f945f632ae993bbb9f9e69d908f7526924c1a88Chris Lattner unsigned getLength() const { 105ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek if (Entry) return Entry->getKeyLength(); 1067e3a004c6ed1fe87912203b9c5a113f8da89d261Ted Kremenek // FIXME: This is gross. It would be best not to embed specific details 1077e3a004c6ed1fe87912203b9c5a113f8da89d261Ted Kremenek // of the PTH file format here. 1081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump // The 'this' pointer really points to a 109ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek // std::pair<IdentifierInfo, const char*>, where internal pointer 110ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek // points to the external string data. 11140844a8b5a89676fb61898d61ea4a7fa98eb9b6bGabor Greif typedef std::pair<IdentifierInfo, const char*> actualtype; 11240844a8b5a89676fb61898d61ea4a7fa98eb9b6bGabor Greif const char* p = ((const actualtype*) this)->second - 2; 1137fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar return (((unsigned) p[0]) | (((unsigned) p[1]) << 8)) - 1; 1147fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar } 1157fe60650c1133ee74a3395cf1063690e274bb7acDaniel Dunbar 11601eb9b9683535d8a65c704ad2c545903409e2d36Daniel Dunbar /// getName - Return the actual identifier string. 117686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getName() const { 118686775deca8b8685eb90801495880e3abdd844c2Chris Lattner return StringRef(getNameStart(), getLength()); 1195f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1201eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1219c46de446d18f4a28446cb798d4131bd05515699Chris Lattner /// hasMacroDefinition - Return true if this identifier is #defined to some 1229c46de446d18f4a28446cb798d4131bd05515699Chris Lattner /// other value. 1239c46de446d18f4a28446cb798d4131bd05515699Chris Lattner bool hasMacroDefinition() const { 1249c46de446d18f4a28446cb798d4131bd05515699Chris Lattner return HasMacro; 1259c46de446d18f4a28446cb798d4131bd05515699Chris Lattner } 1266a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner void setHasMacroDefinition(bool Val) { 1276a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner if (HasMacro == Val) return; 1281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1296a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner HasMacro = Val; 1306a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner if (Val) 1316a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner NeedsHandleIdentifier = 1; 1326a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner else 1336a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner RecomputeNeedsHandleIdentifier(); 1343c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl IsFromAST = false; 1356a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner } 1361eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 137646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis /// getTokenID - If this is a source-language token (e.g. 'for'), this API 1385f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// can be used to cause the lexer to map identifiers to source-language 1395f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// tokens. 1408e748ab52395328f2905855b295a22e33dc800b2Ted Kremenek tok::TokenKind getTokenID() const { return (tok::TokenKind)TokenID; } 141646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis 142646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis /// \brief True if RevertTokenIDToIdentifier() was called. 143646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis bool hasRevertedTokenIDToIdentifier() const { return RevertedTokenID; } 144646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis 145646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis /// \brief Revert TokenID to tok::identifier; used for GNU libstdc++ 4.2 146f573084db5807f6003282bdf53ca9d58bab1ddc4Argyrios Kyrtzidis /// compatibility. 147f573084db5807f6003282bdf53ca9d58bab1ddc4Argyrios Kyrtzidis /// 148f573084db5807f6003282bdf53ca9d58bab1ddc4Argyrios Kyrtzidis /// TokenID is normally read-only but there are 2 instances where we revert it 149f573084db5807f6003282bdf53ca9d58bab1ddc4Argyrios Kyrtzidis /// to tok::identifier for libstdc++ 4.2. Keep track of when this happens 1503c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// using this method so we can inform serialization about it. 151646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis void RevertTokenIDToIdentifier() { 152646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis assert(TokenID != tok::identifier && "Already at tok::identifier"); 153646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis TokenID = tok::identifier; 154646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis RevertedTokenID = true; 155646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis } 1561eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getPPKeywordID - Return the preprocessor keyword ID for this identifier. 1586d9a3e648d6bf6b347174152f191bd1377528f8cChris Lattner /// For example, "define" will return tok::pp_define. 159387b98d37e08f7aa9ddf23e067e1d27e39ce16f3Chris Lattner tok::PPKeywordKind getPPKeywordID() const; 1601eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 1615f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getObjCKeywordID - Return the Objective-C keyword ID for the this 1625f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// identifier. For example, 'class' will return tok::objc_class if ObjC is 1635f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// enabled. 164ca63fa00786e51c207c829f4182f11a6c6b552beTed Kremenek tok::ObjCKeywordKind getObjCKeywordID() const { 1651eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump if (ObjCOrBuiltinID < tok::NUM_OBJC_KEYWORDS) 1665142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor return tok::ObjCKeywordKind(ObjCOrBuiltinID); 1675142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor else 1685142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor return tok::objc_not_keyword; 169ca63fa00786e51c207c829f4182f11a6c6b552beTed Kremenek } 1705142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor void setObjCKeywordID(tok::ObjCKeywordKind ID) { ObjCOrBuiltinID = ID; } 1713251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor 1725f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getBuiltinID - Return a value indicating whether this is a builtin 1735f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// function. 0 is not-built-in. 1 is builtin-for-some-nonprimary-target. 1745f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 2+ are specific builtin functions. 1751eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump unsigned getBuiltinID() const { 1765142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor if (ObjCOrBuiltinID >= tok::NUM_OBJC_KEYWORDS) 1771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return ObjCOrBuiltinID - tok::NUM_OBJC_KEYWORDS; 1785142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor else 1795142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor return 0; 1805142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor } 1815f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setBuiltinID(unsigned ID) { 1825142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor ObjCOrBuiltinID = ID + tok::NUM_OBJC_KEYWORDS; 1831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump assert(ObjCOrBuiltinID - unsigned(tok::NUM_OBJC_KEYWORDS) == ID 1845142af38ed0dd2f592cbfa00fa6e2e14dd6cc516Douglas Gregor && "ID too large for field!"); 1855f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 1863251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor 1873251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor unsigned getObjCOrBuiltinID() const { return ObjCOrBuiltinID; } 1883251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor void setObjCOrBuiltinID(unsigned ID) { ObjCOrBuiltinID = ID; } 1893251ceb90b3fec68e86d6dcfa58836e20a7205c3Douglas Gregor 1905f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// get/setExtension - Initialize information about whether or not this 1915f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// language token is an extension. This controls extension warnings, and is 1925f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// only valid if a custom token ID is set. 1935f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isExtensionToken() const { return IsExtension; } 1946a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner void setIsExtensionToken(bool Val) { 1956a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner IsExtension = Val; 1966a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner if (Val) 1976a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner NeedsHandleIdentifier = 1; 1986a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner else 1996a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner RecomputeNeedsHandleIdentifier(); 2006a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner } 2011eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2025f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// setIsPoisoned - Mark this identifier as poisoned. After poisoning, the 2035f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// Preprocessor will emit an error every time this token is used. 2046a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner void setIsPoisoned(bool Value = true) { 2056a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner IsPoisoned = Value; 2066a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner if (Value) 2076a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner NeedsHandleIdentifier = 1; 2086a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner else 2096a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner RecomputeNeedsHandleIdentifier(); 2103c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl IsFromAST = false; 2116a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner } 2121eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2135f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isPoisoned - Return true if this token has been poisoned. 2145f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isPoisoned() const { return IsPoisoned; } 2151eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2165f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// isCPlusPlusOperatorKeyword/setIsCPlusPlusOperatorKeyword controls whether 2175f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// this identifier is a C++ alternate representation of an operator. 2186a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner void setIsCPlusPlusOperatorKeyword(bool Val = true) { 2196a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner IsCPPOperatorKeyword = Val; 2206a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner if (Val) 2216a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner NeedsHandleIdentifier = 1; 2226a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner else 2236a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner RecomputeNeedsHandleIdentifier(); 2246a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner } 2255f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer bool isCPlusPlusOperatorKeyword() const { return IsCPPOperatorKeyword; } 2265f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 2275f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// getFETokenInfo/setFETokenInfo - The language front-end is allowed to 2285f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// associate arbitrary metadata with this token. 2295f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer template<typename T> 2305f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer T *getFETokenInfo() const { return static_cast<T*>(FETokenInfo); } 2315f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void setFETokenInfo(void *T) { FETokenInfo = T; } 2326a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner 2336a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// isHandleIdentifierCase - Return true if the Preprocessor::HandleIdentifier 2346a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// must be called on a token of this identifier. If this returns false, we 2356a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// know that HandleIdentifier will not affect the token. 2366a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner bool isHandleIdentifierCase() const { return NeedsHandleIdentifier; } 2371eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 2383c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// isFromAST - Return true if the identifier in its current state was loaded 2393c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl /// from an AST file. 2403c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl bool isFromAST() const { return IsFromAST; } 241ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl 2423c7f4134603d04b44f997b43c0a9def270f25386Sebastian Redl void setIsFromAST(bool FromAST = true) { IsFromAST = FromAST; } 243ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl 2446a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattnerprivate: 2456a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// RecomputeNeedsHandleIdentifier - The Preprocessor::HandleIdentifier does 2466a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// several special (but rare) things to identifiers of various sorts. For 2476a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// example, it changes the "for" keyword token from tok::identifier to 2486a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// tok::for. 2496a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// 2506a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// This method is very tied to the definition of HandleIdentifier. Any 2516a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner /// change to it should be reflected here. 2526a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner void RecomputeNeedsHandleIdentifier() { 2536a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner NeedsHandleIdentifier = 2546a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner (isPoisoned() | hasMacroDefinition() | isCPlusPlusOperatorKeyword() | 255b8db7cd9ac05c522855631670ec2e97255384f5aDouglas Gregor isExtensionToken() || (getTokenID() == tok::kw___import_module__)); 2566a170eb3ea6d6319277becabef68eb1a26bf8766Chris Lattner } 2575f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 2585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 25928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley/// \brief an RAII object for [un]poisoning an identifier 26028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley/// within a certain scope. II is allowed to be null, in 26128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley/// which case, objects of this type have no effect. 26228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleyclass PoisonIdentifierRAIIObject { 26328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley IdentifierInfo *const II; 26428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley const bool OldValue; 26528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegleypublic: 26628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley PoisonIdentifierRAIIObject(IdentifierInfo *II, bool NewValue) 26728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley : II(II), OldValue(II ? II->isPoisoned() : false) { 26828bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(II) 26928bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley II->setIsPoisoned(NewValue); 27028bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 27128bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 27228bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley ~PoisonIdentifierRAIIObject() { 27328bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley if(II) 27428bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley II->setIsPoisoned(OldValue); 27528bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley } 27628bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley}; 27728bbe4b8acc338476fe0825769b41fb32b423c72John Wiegley 27895f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// \brief An iterator that walks over all of the known identifiers 27995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// in the lookup table. 28095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// 28195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// Since this iterator uses an abstract interface via virtual 28295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// functions, it uses an object-oriented interface rather than the 28395f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// more standard C++ STL iterator interface. In this OO-style 28495f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// iteration, the single function \c Next() provides dereference, 28595f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// advance, and end-of-sequence checking in a single 28695f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// operation. Subclasses of this iterator type will provide the 28795f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor/// actual functionality. 28895f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregorclass IdentifierIterator { 28995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregorprivate: 29095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor IdentifierIterator(const IdentifierIterator&); // Do not implement 29195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor IdentifierIterator &operator=(const IdentifierIterator&); // Do not implement 29295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor 29395f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregorprotected: 29495f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor IdentifierIterator() { } 29595f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor 29695f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregorpublic: 29795f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor virtual ~IdentifierIterator(); 29895f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor 29995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// \brief Retrieve the next string in the identifier table and 30095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// advances the iterator for the following string. 30195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// 30295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// \returns The next string in the identifier table. If there is 303686775deca8b8685eb90801495880e3abdd844c2Chris Lattner /// no such string, returns an empty \c StringRef. 304686775deca8b8685eb90801495880e3abdd844c2Chris Lattner virtual StringRef Next() = 0; 30595f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor}; 30695f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor 30772b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek/// IdentifierInfoLookup - An abstract class used by IdentifierTable that 308668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor/// provides an interface for performing lookups from strings 30972b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek/// (const char *) to IdentiferInfo objects. 31072b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenekclass IdentifierInfoLookup { 31172b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenekpublic: 31272b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek virtual ~IdentifierInfoLookup(); 3131eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 31472b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek /// get - Return the identifier token info for the specified named identifier. 31572b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek /// Unlike the version in IdentifierTable, this returns a pointer instead 31672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek /// of a reference. If the pointer is NULL then the IdentifierInfo cannot 31772b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek /// be found. 318686775deca8b8685eb90801495880e3abdd844c2Chris Lattner virtual IdentifierInfo* get(StringRef Name) = 0; 31995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor 32095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// \brief Retrieve an iterator into the set of all identifiers 32195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// known to this identifier lookup source. 32295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// 32395f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// This routine provides access to all of the identifiers known to 32495f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// the identifier lookup, allowing access to the contents of the 32595f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// identifiers without introducing the overhead of constructing 32695f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// IdentifierInfo objects for each. 32795f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// 32895f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// \returns A new iterator into the set of known identifiers. The 32995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// caller is responsible for deleting this iterator. 33095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor virtual IdentifierIterator *getIdentifiers() const; 3311eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump}; 3328c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor 3338c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor/// \brief An abstract class used to resolve numerical identifier 3348c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor/// references (meaningful only to some external source) into 3358c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor/// IdentifierInfo pointers. 3368c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregorclass ExternalIdentifierLookup { 3378c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregorpublic: 3388c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor virtual ~ExternalIdentifierLookup(); 3398c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor 3408c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor /// \brief Return the identifier associated with the given ID number. 3418c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor /// 3428c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor /// The ID 0 is associated with the NULL identifier. 3438c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor virtual IdentifierInfo *GetIdentifier(unsigned ID) = 0; 3448c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor}; 3458c5a760b82e73ed90b560090772db97e2ae27b09Douglas Gregor 3465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// IdentifierTable - This table implements an efficient mapping from strings to 3475f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// IdentifierInfo nodes. It has no other purpose, but this is an 348fc8f0e14ad142ed811e90fbd9a30e419e301c717Chris Lattner/// extremely performance-critical piece of the code, as each occurrence of 3495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer/// every identifier goes through here when lexed. 3505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerclass IdentifierTable { 3515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // Shark shows that using MallocAllocator is *much* slower than using this 3525f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer // BumpPtrAllocator! 353ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek typedef llvm::StringMap<IdentifierInfo*, llvm::BumpPtrAllocator> HashTableTy; 3545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer HashTableTy HashTable; 3551eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 35672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek IdentifierInfoLookup* ExternalLookup; 3571cd1b1e987f5e2f060d7972b13d83239b36d77d6Douglas Gregor 3585f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencerpublic: 3595f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// IdentifierTable ctor - Create the identifier table, populating it with 3605f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// info about the language keywords for the language specified by LangOpts. 36172b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek IdentifierTable(const LangOptions &LangOpts, 36272b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek IdentifierInfoLookup* externalLookup = 0); 3631eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 364668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor /// \brief Set the external identifier lookup mechanism. 365668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor void setExternalIdentifierLookup(IdentifierInfoLookup *IILookup) { 366668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor ExternalLookup = IILookup; 367668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor } 368668c1a4fdcc56bdd050256b1688e116fe84b72dbDouglas Gregor 36995f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor /// \brief Retrieve the external identifier lookup object, if any. 37095f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor IdentifierInfoLookup *getExternalIdentifierLookup() const { 37195f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor return ExternalLookup; 37295f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor } 37395f4292cc526c629fead321c7fcfd4fe0f3bc66eDouglas Gregor 37472b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek llvm::BumpPtrAllocator& getAllocator() { 37572b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek return HashTable.getAllocator(); 37672b1b15ee88aac0a63e2c1dc53fe22f5ab297b20Ted Kremenek } 3771eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 3785f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// get - Return the identifier token info for the specified named identifier. 3795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// 380686775deca8b8685eb90801495880e3abdd844c2Chris Lattner IdentifierInfo &get(StringRef Name) { 381ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek llvm::StringMapEntry<IdentifierInfo*> &Entry = 3826488292f5e204fed99bb43ab23b8342ddc03ce89Kovarththanan Rajaratnam HashTable.GetOrCreateValue(Name); 3831eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 384ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek IdentifierInfo *II = Entry.getValue(); 385d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar if (II) return *II; 3861eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 387d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar // No entry; if we have an external lookup, look there first. 388d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar if (ExternalLookup) { 3896488292f5e204fed99bb43ab23b8342ddc03ce89Kovarththanan Rajaratnam II = ExternalLookup->get(Name); 390d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar if (II) { 391d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar // Cache in the StringMap for subsequent lookups. 392d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar Entry.setValue(II); 393d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar return *II; 394ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek } 395d42ffbd22fc7eb61321f6a88173ee424991f01c6Ted Kremenek } 396ccb9bac3adb35a2dc78c1737e7b2dc6537a16393Daniel Dunbar 397d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar // Lookups failed, make a new IdentifierInfo. 398d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar void *Mem = getAllocator().Allocate<IdentifierInfo>(); 399d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar II = new (Mem) IdentifierInfo(); 400d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar Entry.setValue(II); 401d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar 402d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar // Make sure getName() knows how to find the IdentifierInfo 403d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar // contents. 404d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar II->Entry = &Entry; 405d43b333be82438102ff4c459b1fb5dfb764e5f0dDaniel Dunbar 406ea9c26b3dbd74a1497f5609ae6e19a85f42b6073Ted Kremenek return *II; 4075f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer } 4081eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 409686775deca8b8685eb90801495880e3abdd844c2Chris Lattner IdentifierInfo &get(StringRef Name, tok::TokenKind TokenCode) { 410646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis IdentifierInfo &II = get(Name); 411646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis II.TokenID = TokenCode; 412d648d373d6c14dccadd3bef7b560f6a7296f949ePeter Collingbourne assert(II.TokenID == (unsigned) TokenCode && "TokenCode too large"); 413646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis return II; 414646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis } 415646395bbcaa849c94bc2a3246c71d809ca719f01Argyrios Kyrtzidis 416ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl /// \brief Gets an IdentifierInfo for the given name without consulting 417ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl /// external sources. 4185f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor /// 419ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl /// This is a version of get() meant for external sources that want to 420ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl /// introduce or modify an identifier. If they called get(), they would 421ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl /// likely end up in a recursion. 422686775deca8b8685eb90801495880e3abdd844c2Chris Lattner IdentifierInfo &getOwn(StringRef Name) { 4235f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor llvm::StringMapEntry<IdentifierInfo*> &Entry = 42465aa6885818d4b4eea2e5a9d12085b2398148662Jay Foad HashTable.GetOrCreateValue(Name); 4251eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4265f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor IdentifierInfo *II = Entry.getValue(); 427ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl if (!II) { 4281eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 429ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl // Lookups failed, make a new IdentifierInfo. 430ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl void *Mem = getAllocator().Allocate<IdentifierInfo>(); 431ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl II = new (Mem) IdentifierInfo(); 432ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl Entry.setValue(II); 4335f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor 434ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl // Make sure getName() knows how to find the IdentifierInfo 435ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl // contents. 436ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl II->Entry = &Entry; 437ffaab3e2bb13991bb3357e80f14bcae3745b2347Sebastian Redl } 4385f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor 4395f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor return *II; 4405f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor } 4415f8e3302242cf94de2f8e46d10167f57fcf747c3Douglas Gregor 4425f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer typedef HashTableTy::const_iterator iterator; 4435f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer typedef HashTableTy::const_iterator const_iterator; 4441eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4455f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer iterator begin() const { return HashTable.begin(); } 4465f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer iterator end() const { return HashTable.end(); } 447c637e6b7afeebc6b4f751e4373715b6a8ea77272Ted Kremenek unsigned size() const { return HashTable.size(); } 4481eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4495f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// PrintStats - Print some statistics to stderr that indicate how well the 4505f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer /// hashing is doing. 4515f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void PrintStats() const; 4521eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 4535f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer void AddKeywords(const LangOptions &LangOpts); 4545f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer}; 4555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 45685f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// ObjCMethodFamily - A family of Objective-C methods. These 45785f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// families have no inherent meaning in the language, but are 45885f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// nonetheless central enough in the existing implementations to 45985f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// merit direct AST support. While, in theory, arbitrary methods can 46085f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// be considered to form families, we focus here on the methods 46185f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// involving allocation and retain-count management, as these are the 46285f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// most "core" and the most likely to be useful to diverse clients 46385f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// without extra information. 46485f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// 46585f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// Both selectors and actual method declarations may be classified 46685f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// into families. Method families may impose additional restrictions 46785f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// beyond their selector name; for example, a method called '_init' 46885f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// that returns void is not considered to be in the 'init' family 46985f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// (but would be if it returned 'id'). It is also possible to 47085f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// explicitly change or remove a method's family. Therefore the 47185f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// method's family should be considered the single source of truth. 47285f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCallenum ObjCMethodFamily { 47385f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall /// \brief No particular method family. 47485f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_None, 47585f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall 47685f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall // Selectors in these families may have arbitrary arity, may be 47785f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall // written with arbitrary leading underscores, and may have 47885f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall // additional CamelCase "words" in their first selector chunk 47985f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall // following the family name. 48085f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_alloc, 48185f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_copy, 48285f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_init, 48385f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_mutableCopy, 48485f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_new, 48585f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall 48685f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall // These families are singletons consisting only of the nullary 48785f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall // selector with the given name. 48885f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_autorelease, 48985f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_dealloc, 49080cb6e69d9e85231588ae604e4bc2bc9a07389afNico Weber OMF_finalize, 49185f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_release, 49285f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall OMF_retain, 493926df6cfabf3eaa4afc990c097fa4619b76a9b57Douglas Gregor OMF_retainCount, 4949670e179a67d868e171feac44fb8f9e2f108c5e8Fariborz Jahanian OMF_self, 4959670e179a67d868e171feac44fb8f9e2f108c5e8Fariborz Jahanian 4969670e179a67d868e171feac44fb8f9e2f108c5e8Fariborz Jahanian // performSelector families 4979670e179a67d868e171feac44fb8f9e2f108c5e8Fariborz Jahanian OMF_performSelector 49885f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall}; 49985f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall 50085f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// Enough bits to store any enumerator in ObjCMethodFamily or 50185f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// InvalidObjCMethodFamily. 50285f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCallenum { ObjCMethodFamilyBitWidth = 4 }; 50385f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall 50485f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall/// An invalid value of ObjCMethodFamily. 50585f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCallenum { InvalidObjCMethodFamily = (1 << ObjCMethodFamilyBitWidth) - 1 }; 50685f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall 50729238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// Selector - This smart pointer class efficiently represents Objective-C 50829238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// method names. This class will either point to an IdentifierInfo or a 50929238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// MultiKeywordSelector (which is private). This enables us to optimize 5101eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump/// selectors that take no arguments and selectors that take 1 argument, which 51129238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// accounts for 78% of all selectors in Cocoa.h. 512bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroffclass Selector { 51340847cfb58acc3cac7d68727df9455ac45f2e118David Blaikie friend class Diagnostic; 5141eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 515bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff enum IdentifierInfoFlag { 5160e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner // MultiKeywordSelector = 0. 517bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff ZeroArg = 0x1, 518bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff OneArg = 0x2, 519bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff ArgFlags = ZeroArg|OneArg 520bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff }; 521bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff uintptr_t InfoPtr; // a pointer to the MultiKeywordSelector or IdentifierInfo. 5221eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 523bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff Selector(IdentifierInfo *II, unsigned nArgs) { 524bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff InfoPtr = reinterpret_cast<uintptr_t>(II); 5250e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner assert((InfoPtr & ArgFlags) == 0 &&"Insufficiently aligned IdentifierInfo"); 5260e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner assert(nArgs < 2 && "nArgs not equal to 0/1"); 5270e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner InfoPtr |= nArgs+1; 528bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff } 529bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff Selector(MultiKeywordSelector *SI) { 530bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff InfoPtr = reinterpret_cast<uintptr_t>(SI); 5310e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner assert((InfoPtr & ArgFlags) == 0 &&"Insufficiently aligned IdentifierInfo"); 532bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff } 5331eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 534bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff IdentifierInfo *getAsIdentifierInfo() const { 5350e2dfd3963465d238e791eb8996e4d49fa47b615Chris Lattner if (getIdentifierInfoFlag()) 536bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff return reinterpret_cast<IdentifierInfo *>(InfoPtr & ~ArgFlags); 537bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff return 0; 538bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff } 539bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff unsigned getIdentifierInfoFlag() const { 540bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff return InfoPtr & ArgFlags; 541bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff } 5428af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek 54385f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall static ObjCMethodFamily getMethodFamilyImpl(Selector sel); 54485f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall 5458af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenekpublic: 5468af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek friend class SelectorTable; // only the SelectorTable can create these 5478af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek friend class DeclarationName; // and the AST's DeclarationName. 5488af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek 5498af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek /// The default ctor should only be used when creating data structures that 5508af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek /// will contain selectors. 5518af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek Selector() : InfoPtr(0) {} 55290cd1bb1baac2a0221f3642de0cbea3244b116e5Steve Naroff Selector(uintptr_t V) : InfoPtr(V) {} 5538af2c16571f3aade6d47ce81fa3857d01d375719Ted Kremenek 554bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff /// operator==/!= - Indicate whether the specified selectors are identical. 55597b7f26a92d87e514530a5b652460190ce48c974Ted Kremenek bool operator==(Selector RHS) const { 556bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff return InfoPtr == RHS.InfoPtr; 557bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff } 55897b7f26a92d87e514530a5b652460190ce48c974Ted Kremenek bool operator!=(Selector RHS) const { 559bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff return InfoPtr != RHS.InfoPtr; 560bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff } 561bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff void *getAsOpaquePtr() const { 562bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff return reinterpret_cast<void*>(InfoPtr); 563bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff } 564405bad07391494d2eb025f8222c256c66b56e5f8Douglas Gregor 565405bad07391494d2eb025f8222c256c66b56e5f8Douglas Gregor /// \brief Determine whether this is the empty selector. 566405bad07391494d2eb025f8222c256c66b56e5f8Douglas Gregor bool isNull() const { return InfoPtr == 0; } 567405bad07391494d2eb025f8222c256c66b56e5f8Douglas Gregor 568bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff // Predicates to identify the selector type. 5691eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool isKeywordSelector() const { 5701eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return getIdentifierInfoFlag() != ZeroArg; 571bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff } 5721eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump bool isUnarySelector() const { 573bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff return getIdentifierInfoFlag() == ZeroArg; 574bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff } 5755b6b72f53ad164497cf62484b60cdbb4361f1978Steve Naroff unsigned getNumArgs() const; 576813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor 577813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor 578813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// \brief Retrieve the identifier at a given position in the selector. 579813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// 580813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// Note that the identifier pointer returned may be NULL. Clients that only 581813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// care about the text of the identifier string, and not the specific, 582813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// uniqued identifier pointer, should use \c getNameForSlot(), which returns 583813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// an empty string when the identifier pointer would be NULL. 584813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// 585813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// \param argIndex The index for which we want to retrieve the identifier. 586813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// This index shall be less than \c getNumArgs() unless this is a keyword 587813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// selector, in which case 0 is the only permissible value. 588813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// 589813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// \returns the uniqued identifier for this slot, or NULL if this slot has 590813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// no corresponding identifier. 591f836e3fea2c77fdbb18170fb313ee0d45551320bChris Lattner IdentifierInfo *getIdentifierInfoForSlot(unsigned argIndex) const; 592813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor 593813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// \brief Retrieve the name at a given position in the selector. 594813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// 595813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// \param argIndex The index for which we want to retrieve the name. 596813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// This index shall be less than \c getNumArgs() unless this is a keyword 597813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// selector, in which case 0 is the only permissible value. 598813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// 599813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// \returns the name for this slot, which may be the empty string if no 600813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor /// name was supplied. 601686775deca8b8685eb90801495880e3abdd844c2Chris Lattner StringRef getNameForSlot(unsigned argIndex) const; 602813d8346529bf094eb2b249648906ba7fd226688Douglas Gregor 603077bf5e2f48acfa9e7d69429b6e4ba86ea14896dChris Lattner /// getAsString - Derive the full selector name (e.g. "foo:bar:") and return 604077bf5e2f48acfa9e7d69429b6e4ba86ea14896dChris Lattner /// it as an std::string. 605077bf5e2f48acfa9e7d69429b6e4ba86ea14896dChris Lattner std::string getAsString() const; 6061eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 60785f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall /// getMethodFamily - Derive the conventional family of this method. 60885f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall ObjCMethodFamily getMethodFamily() const { 60985f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall return getMethodFamilyImpl(*this); 61085f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall } 61185f3d76c0ecfdefcf83ea44a57b7a16119c8a045John McCall 61285994260c41a54cab061a434ed378fc448333a4eChris Lattner static Selector getEmptyMarker() { 61385994260c41a54cab061a434ed378fc448333a4eChris Lattner return Selector(uintptr_t(-1)); 61485994260c41a54cab061a434ed378fc448333a4eChris Lattner } 61585994260c41a54cab061a434ed378fc448333a4eChris Lattner static Selector getTombstoneMarker() { 61685994260c41a54cab061a434ed378fc448333a4eChris Lattner return Selector(uintptr_t(-2)); 61785994260c41a54cab061a434ed378fc448333a4eChris Lattner } 618bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff}; 619bcfb06ac6da1aa3c74ac1ef7a49c2807522366e7Steve Naroff 62029238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// SelectorTable - This table allows us to fully hide how we implement 62129238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff/// multi-keyword caching. 62229238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroffclass SelectorTable { 6235f7d2284c4b2f08d155732454002e68dc40c33efChris Lattner void *Impl; // Actually a SelectorTableImpl 62429238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable(const SelectorTable&); // DISABLED: DO NOT IMPLEMENT 62529238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff void operator=(const SelectorTable&); // DISABLED: DO NOT IMPLEMENT 62629238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroffpublic: 62729238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff SelectorTable(); 62829238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff ~SelectorTable(); 62929238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff 630ff38491c18b060526d754765b952f4a497a89416Chris Lattner /// getSelector - This can create any sort of selector. NumArgs indicates 631ff38491c18b060526d754765b952f4a497a89416Chris Lattner /// whether this is a no argument selector "foo", a single argument selector 632ff38491c18b060526d754765b952f4a497a89416Chris Lattner /// "foo:" or multi-argument "foo:bar:". 633ff38491c18b060526d754765b952f4a497a89416Chris Lattner Selector getSelector(unsigned NumArgs, IdentifierInfo **IIV); 6341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 635ff38491c18b060526d754765b952f4a497a89416Chris Lattner Selector getUnarySelector(IdentifierInfo *ID) { 636ff38491c18b060526d754765b952f4a497a89416Chris Lattner return Selector(ID, 1); 637ff38491c18b060526d754765b952f4a497a89416Chris Lattner } 638ff38491c18b060526d754765b952f4a497a89416Chris Lattner Selector getNullarySelector(IdentifierInfo *ID) { 639ff38491c18b060526d754765b952f4a497a89416Chris Lattner return Selector(ID, 0); 640ff38491c18b060526d754765b952f4a497a89416Chris Lattner } 64161f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff 64297f55d6ffd548d1777d790c84b358030682f9de2Ted Kremenek /// Return the total amount of memory allocated for managing selectors. 64397f55d6ffd548d1777d790c84b358030682f9de2Ted Kremenek size_t getTotalMemory() const; 64497f55d6ffd548d1777d790c84b358030682f9de2Ted Kremenek 64561f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff /// constructSetterName - Return the setter name for the given 64661f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff /// identifier, i.e. "set" + Name where the initial character of Name 64761f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff /// has been capitalized. 648fdc92b7877535e6264fe43cfbdc8f01e9b224f81Steve Naroff static Selector constructSetterName(IdentifierTable &Idents, 649fdc92b7877535e6264fe43cfbdc8f01e9b224f81Steve Naroff SelectorTable &SelTable, 650fdc92b7877535e6264fe43cfbdc8f01e9b224f81Steve Naroff const IdentifierInfo *Name) { 65161f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff llvm::SmallString<100> SelectorName; 65261f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff SelectorName = "set"; 65301eb9b9683535d8a65c704ad2c545903409e2d36Daniel Dunbar SelectorName += Name->getName(); 65461f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff SelectorName[3] = toupper(SelectorName[3]); 6552781deb126663ca1bd412044a1e66577585987b3Kovarththanan Rajaratnam IdentifierInfo *SetterName = &Idents.get(SelectorName); 656fdc92b7877535e6264fe43cfbdc8f01e9b224f81Steve Naroff return SelTable.getUnarySelector(SetterName); 65761f72cbd037e58f12cfe90cd442373f44092f030Steve Naroff } 65829238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff}; 65929238a0bf7cbf5b396efb451a0adb5fe4aa037caSteve Naroff 660e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor/// DeclarationNameExtra - Common base of the MultiKeywordSelector, 661e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor/// CXXSpecialName, and CXXOperatorIdName classes, all of which are 662e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor/// private classes that describe different kinds of names. 6632e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregorclass DeclarationNameExtra { 6642e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregorpublic: 6652e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor /// ExtraKind - The kind of "extra" information stored in the 6662e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor /// DeclarationName. See @c ExtraKindOrNumArgs for an explanation of 6672e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor /// how these enumerator values are used. 6682e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor enum ExtraKind { 6692e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor CXXConstructor = 0, 6702e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor CXXDestructor, 6712e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor CXXConversionFunction, 672e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor#define OVERLOADED_OPERATOR(Name,Spelling,Token,Unary,Binary,MemberOnly) \ 673e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor CXXOperator##Name, 674e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor#include "clang/Basic/OperatorKinds.def" 6753e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt CXXLiteralOperator, 6762a3009a432bdcec59e6383d7b2b17494d6f91649Douglas Gregor CXXUsingDirective, 6772e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor NUM_EXTRA_KINDS 6782e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor }; 6795f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer 680e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor /// ExtraKindOrNumArgs - Either the kind of C++ special name or 681e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor /// operator-id (if the value is one of the CXX* enumerators of 682e94ca9e4371c022329270436b3dd77adc4ddfa8fDouglas Gregor /// ExtraKind), in which case the DeclarationNameExtra is also a 6833e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt /// CXXSpecialName, (for CXXConstructor, CXXDestructor, or 6843e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt /// CXXConversionFunction) CXXOperatorIdName, or CXXLiteralOperatorName, 6853e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt /// it may be also name common to C++ using-directives (CXXUsingDirective), 6863e518bda00d710754ca077cf9be8dd821e16a854Sean Hunt /// otherwise it is NUM_EXTRA_KINDS+NumArgs, where NumArgs is the number of 6872e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor /// arguments in the Objective-C selector, in which case the 6882e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor /// DeclarationNameExtra is also a MultiKeywordSelector. 6892e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor unsigned ExtraKindOrNumArgs; 6902e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor}; 6912e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor 6922e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor} // end namespace clang 6934365a7e46822700357a272d839ee2656d9603d5aChris Lattner 6942e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregornamespace llvm { 6954365a7e46822700357a272d839ee2656d9603d5aChris Lattner/// Define DenseMapInfo so that Selectors can be used as keys in DenseMap and 6964365a7e46822700357a272d839ee2656d9603d5aChris Lattner/// DenseSets. 69785994260c41a54cab061a434ed378fc448333a4eChris Lattnertemplate <> 69885994260c41a54cab061a434ed378fc448333a4eChris Lattnerstruct DenseMapInfo<clang::Selector> { 69985994260c41a54cab061a434ed378fc448333a4eChris Lattner static inline clang::Selector getEmptyKey() { 70085994260c41a54cab061a434ed378fc448333a4eChris Lattner return clang::Selector::getEmptyMarker(); 70185994260c41a54cab061a434ed378fc448333a4eChris Lattner } 70285994260c41a54cab061a434ed378fc448333a4eChris Lattner static inline clang::Selector getTombstoneKey() { 7031eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return clang::Selector::getTombstoneMarker(); 70485994260c41a54cab061a434ed378fc448333a4eChris Lattner } 7051eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70685994260c41a54cab061a434ed378fc448333a4eChris Lattner static unsigned getHashValue(clang::Selector S); 7071eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump 70885994260c41a54cab061a434ed378fc448333a4eChris Lattner static bool isEqual(clang::Selector LHS, clang::Selector RHS) { 70985994260c41a54cab061a434ed378fc448333a4eChris Lattner return LHS == RHS; 71085994260c41a54cab061a434ed378fc448333a4eChris Lattner } 71185994260c41a54cab061a434ed378fc448333a4eChris Lattner}; 712700030ebddb987936d4fee14d9412821d96e4840Kovarththanan Rajaratnam 71306159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnertemplate <> 71406159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattnerstruct isPodLike<clang::Selector> { static const bool value = true; }; 71506159e878569e5f39bf0e8f11b84ac3ad0970597Chris Lattner 716d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregortemplate<> 717d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregorclass PointerLikeTypeTraits<clang::Selector> { 718d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregorpublic: 719d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor static inline const void *getAsVoidPointer(clang::Selector P) { 720d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor return P.getAsOpaquePtr(); 721d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor } 722d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor static inline clang::Selector getFromVoidPointer(const void *P) { 723d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor return clang::Selector(reinterpret_cast<uintptr_t>(P)); 724d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor } 725d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor enum { NumLowBitsAvailable = 0 }; 726d36adf553cd71df96fe869204482e0f0d68c6bbfDouglas Gregor}; 72785994260c41a54cab061a434ed378fc448333a4eChris Lattner 7281734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor// Provide PointerLikeTypeTraits for IdentifierInfo pointers, which 7291734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor// are not guaranteed to be 8-byte aligned. 7301734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregortemplate<> 7311734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregorclass PointerLikeTypeTraits<clang::IdentifierInfo*> { 7321734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregorpublic: 7331734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor static inline void *getAsVoidPointer(clang::IdentifierInfo* P) { 7341eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return P; 7351734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor } 7361734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor static inline clang::IdentifierInfo *getFromVoidPointer(void *P) { 7371734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor return static_cast<clang::IdentifierInfo*>(P); 7381734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor } 7391734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor enum { NumLowBitsAvailable = 1 }; 7401734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor}; 7411734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor 7421734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregortemplate<> 7431734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregorclass PointerLikeTypeTraits<const clang::IdentifierInfo*> { 7441734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregorpublic: 7451734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor static inline const void *getAsVoidPointer(const clang::IdentifierInfo* P) { 7461eb4433ac451dc16f4133a88af2d002ac26c58efMike Stump return P; 7471734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor } 7481734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor static inline const clang::IdentifierInfo *getFromVoidPointer(const void *P) { 7491734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor return static_cast<const clang::IdentifierInfo*>(P); 7501734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor } 7511734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor enum { NumLowBitsAvailable = 1 }; 7521734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor}; 7531734317845d60307d474b5da8a8d33adbaf5e723Douglas Gregor 7542e1cd4264d363ca869bf37ef160902f211d21b8cDouglas Gregor} // end namespace llvm 7555f016e2cb5d11daeb237544de1c5d59f20fe1a6eReid Spencer#endif 756