blob: c60789d816cc182f827a4a39d694f1c76b4fee14 [file] [log] [blame]
Chris Lattnerec659fc2006-10-29 22:09:44 +00001//===--- IdentifierTable.cpp - Hash table for identifier lookup -----------===//
Chris Lattner22eb9722006-06-18 05:43:12 +00002//
3// The LLVM Compiler Infrastructure
4//
Chris Lattner5b12ab82007-12-29 19:59:25 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Chris Lattner22eb9722006-06-18 05:43:12 +00007//
8//===----------------------------------------------------------------------===//
9//
Chris Lattnerc79f6fb2006-07-04 17:53:21 +000010// This file implements the IdentifierInfo, IdentifierVisitor, and
Chris Lattner91cbf112006-07-03 04:28:52 +000011// IdentifierTable interfaces.
Chris Lattner22eb9722006-06-18 05:43:12 +000012//
13//===----------------------------------------------------------------------===//
14
Adrian Prantla4ce9062013-06-07 22:29:12 +000015#include "clang/Basic/CharInfo.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000016#include "clang/Basic/IdentifierTable.h"
Chandler Carruth5553d0d2014-01-07 11:51:46 +000017#include "clang/Basic/LangOptions.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000018#include "clang/Basic/OperatorKinds.h"
Douglas Gregor813a0662015-06-19 18:14:38 +000019#include "clang/Basic/Specifiers.h"
Chris Lattnerdadc7622007-10-05 20:15:24 +000020#include "llvm/ADT/DenseMap.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "llvm/ADT/FoldingSet.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000022#include "llvm/ADT/SmallString.h"
David Blaikie8a40f702012-01-17 06:56:22 +000023#include "llvm/Support/ErrorHandling.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000024#include "llvm/Support/raw_ostream.h"
Chris Lattnerc25d8a72009-03-02 22:20:04 +000025#include <cstdio>
Ted Kremenekf25f4a32007-10-23 22:18:37 +000026
Chris Lattner22eb9722006-06-18 05:43:12 +000027using namespace clang;
28
29//===----------------------------------------------------------------------===//
Chris Lattnerc79f6fb2006-07-04 17:53:21 +000030// IdentifierInfo Implementation
Chris Lattner22eb9722006-06-18 05:43:12 +000031//===----------------------------------------------------------------------===//
32
Ted Kremenek52f73ca2009-01-20 23:28:34 +000033IdentifierInfo::IdentifierInfo() {
Chris Lattner3bc804e2006-10-28 23:46:24 +000034 TokenID = tok::identifier;
Douglas Gregor2ad7ee92008-11-06 16:32:23 +000035 ObjCOrBuiltinID = 0;
Chris Lattnera441ca62007-10-07 07:09:52 +000036 HasMacro = false;
Alexander Kornienko1d26c022012-09-25 17:18:14 +000037 HadMacro = false;
Chris Lattner3bc804e2006-10-28 23:46:24 +000038 IsExtension = false;
Richard Smith31d51842015-05-14 04:00:59 +000039 IsFutureCompatKeyword = false;
Chris Lattner3bc804e2006-10-28 23:46:24 +000040 IsPoisoned = false;
Chris Lattner5b9f4892006-11-21 17:23:33 +000041 IsCPPOperatorKeyword = false;
Chris Lattnerad89ec02009-01-21 07:43:11 +000042 NeedsHandleIdentifier = false;
Sebastian Redld44cd6a2010-08-18 23:57:06 +000043 IsFromAST = false;
Douglas Gregor935bc7a22011-10-27 09:33:13 +000044 ChangedAfterLoad = false;
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +000045 RevertedTokenID = false;
Douglas Gregor935bc7a22011-10-27 09:33:13 +000046 OutOfDate = false;
Ted Kremenekc1e4dd02012-03-01 22:07:04 +000047 IsModulesImport = false;
Craig Topperf1186c52014-05-08 06:41:40 +000048 FETokenInfo = nullptr;
49 Entry = nullptr;
Chris Lattner3bc804e2006-10-28 23:46:24 +000050}
51
Chris Lattner91cbf112006-07-03 04:28:52 +000052//===----------------------------------------------------------------------===//
Chris Lattner22eb9722006-06-18 05:43:12 +000053// IdentifierTable Implementation
54//===----------------------------------------------------------------------===//
55
Angel Garcia Gomezb5250d32015-10-20 12:52:55 +000056IdentifierIterator::~IdentifierIterator() = default;
Douglas Gregor57756ea2010-10-14 22:11:03 +000057
Angel Garcia Gomezb5250d32015-10-20 12:52:55 +000058IdentifierInfoLookup::~IdentifierInfoLookup() = default;
Ted Kremeneka705b042009-01-15 18:47:46 +000059
Douglas Gregor57756ea2010-10-14 22:11:03 +000060namespace {
61 /// \brief A simple identifier lookup iterator that represents an
62 /// empty sequence of identifiers.
63 class EmptyLookupIterator : public IdentifierIterator
64 {
65 public:
Craig Topper3164f332014-03-11 03:39:26 +000066 StringRef Next() override { return StringRef(); }
Douglas Gregor57756ea2010-10-14 22:11:03 +000067 };
68}
69
Argyrios Kyrtzidis9aca3c62013-04-17 22:10:55 +000070IdentifierIterator *IdentifierInfoLookup::getIdentifiers() {
Douglas Gregor57756ea2010-10-14 22:11:03 +000071 return new EmptyLookupIterator();
72}
73
Ted Kremeneka705b042009-01-15 18:47:46 +000074IdentifierTable::IdentifierTable(const LangOptions &LangOpts,
75 IdentifierInfoLookup* externalLookup)
76 : HashTable(8192), // Start with space for 8K identifiers.
77 ExternalLookup(externalLookup) {
Chris Lattnerda933aa2006-10-29 23:49:15 +000078
Chris Lattnerf2e3ac32006-10-27 03:59:10 +000079 // Populate the identifier table with info about keywords for the current
80 // language.
Chris Lattner25e0d542006-10-18 06:07:05 +000081 AddKeywords(LangOpts);
Ted Kremenek94666032012-03-01 22:53:32 +000082
83
84 // Add the '_experimental_modules_import' contextual keyword.
Douglas Gregorc50d4922012-12-11 22:11:52 +000085 get("import").setModulesImport(true);
Chris Lattner91cbf112006-07-03 04:28:52 +000086}
Chris Lattner22eb9722006-06-18 05:43:12 +000087
Chris Lattner25e0d542006-10-18 06:07:05 +000088//===----------------------------------------------------------------------===//
89// Language Keyword Implementation
90//===----------------------------------------------------------------------===//
91
Eli Friedman2b680b42009-04-28 03:13:54 +000092// Constants for TokenKinds.def
93namespace {
94 enum {
Dylan Noblesmith92c07c22011-04-09 13:34:05 +000095 KEYC99 = 0x1,
96 KEYCXX = 0x2,
Richard Smith89645bc2013-01-02 12:01:23 +000097 KEYCXX11 = 0x4,
Dylan Noblesmith92c07c22011-04-09 13:34:05 +000098 KEYGNU = 0x8,
99 KEYMS = 0x10,
100 BOOLSUPPORT = 0x20,
101 KEYALTIVEC = 0x40,
102 KEYNOCXX = 0x80,
103 KEYBORLAND = 0x100,
104 KEYOPENCL = 0x200,
Benjamin Kramere56f3932011-12-23 17:00:35 +0000105 KEYC11 = 0x400,
John McCall31168b02011-06-15 23:02:42 +0000106 KEYARC = 0x800,
David Majnemer28aae9c2015-03-18 04:15:23 +0000107 KEYNOMS18 = 0x01000,
Anastasia Stulovab1152f12015-03-18 12:55:29 +0000108 KEYNOOPENCL = 0x02000,
109 WCHARSUPPORT = 0x04000,
110 HALFSUPPORT = 0x08000,
Hubert Tong6e04f982015-06-05 01:10:24 +0000111 KEYCONCEPTS = 0x10000,
Douglas Gregorab209d82015-07-07 03:58:42 +0000112 KEYOBJC2 = 0x20000,
Ulrich Weigand3c5038a2015-07-30 14:08:36 +0000113 KEYZVECTOR = 0x40000,
114 KEYALL = (0x7ffff & ~KEYNOMS18 &
Anastasia Stulovab1152f12015-03-18 12:55:29 +0000115 ~KEYNOOPENCL) // KEYNOMS18 and KEYNOOPENCL are used to exclude.
Eli Friedman2b680b42009-04-28 03:13:54 +0000116 };
Serge Pavlov77af3812014-10-29 10:59:18 +0000117
118 /// \brief How a keyword is treated in the selected standard.
119 enum KeywordStatus {
120 KS_Disabled, // Disabled
121 KS_Extension, // Is an extension
122 KS_Enabled, // Enabled
123 KS_Future // Is a keyword in future standard
124 };
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000125}
Serge Pavlov77af3812014-10-29 10:59:18 +0000126
127/// \brief Translates flags as specified in TokenKinds.def into keyword status
128/// in the given language standard.
Serge Pavlov83cf0782014-12-11 12:18:08 +0000129static KeywordStatus getKeywordStatus(const LangOptions &LangOpts,
Serge Pavlov77af3812014-10-29 10:59:18 +0000130 unsigned Flags) {
131 if (Flags == KEYALL) return KS_Enabled;
132 if (LangOpts.CPlusPlus && (Flags & KEYCXX)) return KS_Enabled;
133 if (LangOpts.CPlusPlus11 && (Flags & KEYCXX11)) return KS_Enabled;
134 if (LangOpts.C99 && (Flags & KEYC99)) return KS_Enabled;
135 if (LangOpts.GNUKeywords && (Flags & KEYGNU)) return KS_Extension;
136 if (LangOpts.MicrosoftExt && (Flags & KEYMS)) return KS_Extension;
137 if (LangOpts.Borland && (Flags & KEYBORLAND)) return KS_Extension;
138 if (LangOpts.Bool && (Flags & BOOLSUPPORT)) return KS_Enabled;
139 if (LangOpts.Half && (Flags & HALFSUPPORT)) return KS_Enabled;
140 if (LangOpts.WChar && (Flags & WCHARSUPPORT)) return KS_Enabled;
141 if (LangOpts.AltiVec && (Flags & KEYALTIVEC)) return KS_Enabled;
142 if (LangOpts.OpenCL && (Flags & KEYOPENCL)) return KS_Enabled;
143 if (!LangOpts.CPlusPlus && (Flags & KEYNOCXX)) return KS_Enabled;
144 if (LangOpts.C11 && (Flags & KEYC11)) return KS_Enabled;
145 // We treat bridge casts as objective-C keywords so we can warn on them
146 // in non-arc mode.
147 if (LangOpts.ObjC2 && (Flags & KEYARC)) return KS_Enabled;
Hubert Tong6e04f982015-06-05 01:10:24 +0000148 if (LangOpts.ConceptsTS && (Flags & KEYCONCEPTS)) return KS_Enabled;
Douglas Gregorab209d82015-07-07 03:58:42 +0000149 if (LangOpts.ObjC2 && (Flags & KEYOBJC2)) return KS_Enabled;
Serge Pavlov77af3812014-10-29 10:59:18 +0000150 if (LangOpts.CPlusPlus && (Flags & KEYCXX11)) return KS_Future;
151 return KS_Disabled;
Eli Friedman2b680b42009-04-28 03:13:54 +0000152}
153
Chris Lattner25e0d542006-10-18 06:07:05 +0000154/// AddKeyword - This method is used to associate a token ID with specific
155/// identifiers because they are language keywords. This causes the lexer to
156/// automatically map matching identifiers to specialized token codes.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000157static void AddKeyword(StringRef Keyword,
Eli Friedman2b680b42009-04-28 03:13:54 +0000158 tok::TokenKind TokenCode, unsigned Flags,
Chris Lattner25e0d542006-10-18 06:07:05 +0000159 const LangOptions &LangOpts, IdentifierTable &Table) {
Serge Pavlov83cf0782014-12-11 12:18:08 +0000160 KeywordStatus AddResult = getKeywordStatus(LangOpts, Flags);
Richard Smith4dd85d62011-10-11 19:57:52 +0000161
Alp Tokerbfa39342014-01-14 12:51:41 +0000162 // Don't add this keyword under MSVCCompat.
David Majnemer28aae9c2015-03-18 04:15:23 +0000163 if (LangOpts.MSVCCompat && (Flags & KEYNOMS18) &&
David Majnemerb710a932015-05-11 03:57:49 +0000164 !LangOpts.isCompatibleWithMSVC(LangOptions::MSVC2015))
Anastasia Stulovab1152f12015-03-18 12:55:29 +0000165 return;
166
167 // Don't add this keyword under OpenCL.
168 if (LangOpts.OpenCL && (Flags & KEYNOOPENCL))
169 return;
170
Eli Friedman2b680b42009-04-28 03:13:54 +0000171 // Don't add this keyword if disabled in this language.
Serge Pavlov77af3812014-10-29 10:59:18 +0000172 if (AddResult == KS_Disabled) return;
Eli Friedman2b680b42009-04-28 03:13:54 +0000173
Richard Smith4dd85d62011-10-11 19:57:52 +0000174 IdentifierInfo &Info =
Serge Pavlov77af3812014-10-29 10:59:18 +0000175 Table.get(Keyword, AddResult == KS_Future ? tok::identifier : TokenCode);
176 Info.setIsExtensionToken(AddResult == KS_Extension);
Richard Smith31d51842015-05-14 04:00:59 +0000177 Info.setIsFutureCompatKeyword(AddResult == KS_Future);
Chris Lattner25e0d542006-10-18 06:07:05 +0000178}
179
Chris Lattner5b9f4892006-11-21 17:23:33 +0000180/// AddCXXOperatorKeyword - Register a C++ operator keyword alternative
181/// representations.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000182static void AddCXXOperatorKeyword(StringRef Keyword,
Chris Lattner5b9f4892006-11-21 17:23:33 +0000183 tok::TokenKind TokenCode,
184 IdentifierTable &Table) {
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +0000185 IdentifierInfo &Info = Table.get(Keyword, TokenCode);
Ted Kremenekf25f4a32007-10-23 22:18:37 +0000186 Info.setIsCPlusPlusOperatorKeyword();
Chris Lattner5b9f4892006-11-21 17:23:33 +0000187}
188
James Dennett0d8a3f82012-06-15 21:27:44 +0000189/// AddObjCKeyword - Register an Objective-C \@keyword like "class" "selector"
190/// or "property".
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000191static void AddObjCKeyword(StringRef Name,
Kovarththanan Rajaratnam00682a42010-03-12 11:27:37 +0000192 tok::ObjCKeywordKind ObjCID,
Chris Lattner25e0d542006-10-18 06:07:05 +0000193 IdentifierTable &Table) {
Kovarththanan Rajaratnam00682a42010-03-12 11:27:37 +0000194 Table.get(Name).setObjCKeywordID(ObjCID);
Chris Lattner25e0d542006-10-18 06:07:05 +0000195}
196
197/// AddKeywords - Add all keywords to the symbol table.
198///
199void IdentifierTable::AddKeywords(const LangOptions &LangOpts) {
Chris Lattner25e0d542006-10-18 06:07:05 +0000200 // Add keywords and tokens for the current language.
201#define KEYWORD(NAME, FLAGS) \
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000202 AddKeyword(StringRef(#NAME), tok::kw_ ## NAME, \
Eli Friedman2b680b42009-04-28 03:13:54 +0000203 FLAGS, LangOpts, *this);
204#define ALIAS(NAME, TOK, FLAGS) \
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000205 AddKeyword(StringRef(NAME), tok::kw_ ## TOK, \
Eli Friedman2b680b42009-04-28 03:13:54 +0000206 FLAGS, LangOpts, *this);
Chris Lattner5b9f4892006-11-21 17:23:33 +0000207#define CXX_KEYWORD_OPERATOR(NAME, ALIAS) \
Chris Lattner3e7592e2006-12-04 07:48:37 +0000208 if (LangOpts.CXXOperatorNames) \
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000209 AddCXXOperatorKeyword(StringRef(#NAME), tok::ALIAS, *this);
Chris Lattner25e0d542006-10-18 06:07:05 +0000210#define OBJC1_AT_KEYWORD(NAME) \
211 if (LangOpts.ObjC1) \
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000212 AddObjCKeyword(StringRef(#NAME), tok::objc_##NAME, *this);
Chris Lattner25e0d542006-10-18 06:07:05 +0000213#define OBJC2_AT_KEYWORD(NAME) \
214 if (LangOpts.ObjC2) \
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000215 AddObjCKeyword(StringRef(#NAME), tok::objc_##NAME, *this);
John McCall39439732011-04-09 22:50:59 +0000216#define TESTING_KEYWORD(NAME, FLAGS)
Chris Lattner25e0d542006-10-18 06:07:05 +0000217#include "clang/Basic/TokenKinds.def"
John McCall39439732011-04-09 22:50:59 +0000218
219 if (LangOpts.ParseUnknownAnytype)
220 AddKeyword("__unknown_anytype", tok::kw___unknown_anytype, KEYALL,
221 LangOpts, *this);
Aaron Ballman674cf262015-05-26 19:44:52 +0000222
Saleem Abdulrasoold170c4b2015-10-04 17:51:05 +0000223 if (LangOpts.DeclSpecKeyword)
Aaron Ballman674cf262015-05-26 19:44:52 +0000224 AddKeyword("__declspec", tok::kw___declspec, KEYALL, LangOpts, *this);
Chris Lattner25e0d542006-10-18 06:07:05 +0000225}
226
Serge Pavlov83cf0782014-12-11 12:18:08 +0000227/// \brief Checks if the specified token kind represents a keyword in the
228/// specified language.
229/// \returns Status of the keyword in the language.
230static KeywordStatus getTokenKwStatus(const LangOptions &LangOpts,
231 tok::TokenKind K) {
232 switch (K) {
233#define KEYWORD(NAME, FLAGS) \
234 case tok::kw_##NAME: return getKeywordStatus(LangOpts, FLAGS);
235#include "clang/Basic/TokenKinds.def"
236 default: return KS_Disabled;
237 }
238}
239
240/// \brief Returns true if the identifier represents a keyword in the
241/// specified language.
242bool IdentifierInfo::isKeyword(const LangOptions &LangOpts) {
243 switch (getTokenKwStatus(LangOpts, getTokenID())) {
244 case KS_Enabled:
245 case KS_Extension:
246 return true;
247 default:
248 return false;
249 }
250}
251
Chris Lattnerff067ce2007-10-07 07:52:34 +0000252tok::PPKeywordKind IdentifierInfo::getPPKeywordID() const {
253 // We use a perfect hash function here involving the length of the keyword,
254 // the first and third character. For preprocessor ID's there are no
255 // collisions (if there were, the switch below would complain about duplicate
256 // case values). Note that this depends on 'if' being null terminated.
Mike Stump11289f42009-09-09 15:08:12 +0000257
Chris Lattnerff067ce2007-10-07 07:52:34 +0000258#define HASH(LEN, FIRST, THIRD) \
259 (LEN << 5) + (((FIRST-'a') + (THIRD-'a')) & 31)
260#define CASE(LEN, FIRST, THIRD, NAME) \
261 case HASH(LEN, FIRST, THIRD): \
262 return memcmp(Name, #NAME, LEN) ? tok::pp_not_keyword : tok::pp_ ## NAME
Mike Stump11289f42009-09-09 15:08:12 +0000263
Chris Lattnerff067ce2007-10-07 07:52:34 +0000264 unsigned Len = getLength();
Chris Lattnerd2b8ce42007-10-10 20:59:57 +0000265 if (Len < 2) return tok::pp_not_keyword;
Daniel Dunbar1c0761d2009-10-17 18:13:02 +0000266 const char *Name = getNameStart();
Chris Lattnerff067ce2007-10-07 07:52:34 +0000267 switch (HASH(Len, Name[0], Name[2])) {
268 default: return tok::pp_not_keyword;
269 CASE( 2, 'i', '\0', if);
270 CASE( 4, 'e', 'i', elif);
271 CASE( 4, 'e', 's', else);
272 CASE( 4, 'l', 'n', line);
273 CASE( 4, 's', 'c', sccs);
274 CASE( 5, 'e', 'd', endif);
275 CASE( 5, 'e', 'r', error);
276 CASE( 5, 'i', 'e', ident);
277 CASE( 5, 'i', 'd', ifdef);
278 CASE( 5, 'u', 'd', undef);
279
280 CASE( 6, 'a', 's', assert);
281 CASE( 6, 'd', 'f', define);
282 CASE( 6, 'i', 'n', ifndef);
283 CASE( 6, 'i', 'p', import);
284 CASE( 6, 'p', 'a', pragma);
Douglas Gregor0bf886d2012-01-03 18:24:14 +0000285
Chris Lattnerff067ce2007-10-07 07:52:34 +0000286 CASE( 7, 'd', 'f', defined);
287 CASE( 7, 'i', 'c', include);
288 CASE( 7, 'w', 'r', warning);
289
290 CASE( 8, 'u', 'a', unassert);
291 CASE(12, 'i', 'c', include_next);
Mike Stump11289f42009-09-09 15:08:12 +0000292
Douglas Gregor663b48f2012-01-03 19:48:16 +0000293 CASE(14, '_', 'p', __public_macro);
294
295 CASE(15, '_', 'p', __private_macro);
296
Chris Lattner14a7f392009-04-08 18:24:34 +0000297 CASE(16, '_', 'i', __include_macros);
Chris Lattnerff067ce2007-10-07 07:52:34 +0000298#undef CASE
299#undef HASH
300 }
301}
Chris Lattner25e0d542006-10-18 06:07:05 +0000302
303//===----------------------------------------------------------------------===//
304// Stats Implementation
305//===----------------------------------------------------------------------===//
306
Chris Lattner22eb9722006-06-18 05:43:12 +0000307/// PrintStats - Print statistics about how well the identifier table is doing
308/// at hashing identifiers.
309void IdentifierTable::PrintStats() const {
Chris Lattner2b9e19b2006-10-29 23:43:13 +0000310 unsigned NumBuckets = HashTable.getNumBuckets();
311 unsigned NumIdentifiers = HashTable.getNumItems();
312 unsigned NumEmptyBuckets = NumBuckets-NumIdentifiers;
Chris Lattner22eb9722006-06-18 05:43:12 +0000313 unsigned AverageIdentifierSize = 0;
314 unsigned MaxIdentifierLength = 0;
Mike Stump11289f42009-09-09 15:08:12 +0000315
Chris Lattner2b9e19b2006-10-29 23:43:13 +0000316 // TODO: Figure out maximum times an identifier had to probe for -stats.
Ted Kremenek52f73ca2009-01-20 23:28:34 +0000317 for (llvm::StringMap<IdentifierInfo*, llvm::BumpPtrAllocator>::const_iterator
Chris Lattnerb055f2d2007-02-11 08:19:57 +0000318 I = HashTable.begin(), E = HashTable.end(); I != E; ++I) {
319 unsigned IdLen = I->getKeyLength();
320 AverageIdentifierSize += IdLen;
321 if (MaxIdentifierLength < IdLen)
322 MaxIdentifierLength = IdLen;
323 }
Mike Stump11289f42009-09-09 15:08:12 +0000324
Chris Lattner23b7eb62007-06-15 23:05:46 +0000325 fprintf(stderr, "\n*** Identifier Table Stats:\n");
326 fprintf(stderr, "# Identifiers: %d\n", NumIdentifiers);
327 fprintf(stderr, "# Empty Buckets: %d\n", NumEmptyBuckets);
328 fprintf(stderr, "Hash density (#identifiers per bucket): %f\n",
329 NumIdentifiers/(double)NumBuckets);
330 fprintf(stderr, "Ave identifier length: %f\n",
331 (AverageIdentifierSize/(double)NumIdentifiers));
332 fprintf(stderr, "Max identifier length: %d\n", MaxIdentifierLength);
Mike Stump11289f42009-09-09 15:08:12 +0000333
Chris Lattner22eb9722006-06-18 05:43:12 +0000334 // Compute statistics about the memory allocated for identifiers.
Chris Lattner2b9e19b2006-10-29 23:43:13 +0000335 HashTable.getAllocator().PrintStats();
Chris Lattner22eb9722006-06-18 05:43:12 +0000336}
Steve Narofff73590d2007-09-27 14:38:14 +0000337
Steve Naroffe61bfa82007-10-05 18:42:47 +0000338//===----------------------------------------------------------------------===//
339// SelectorTable Implementation
340//===----------------------------------------------------------------------===//
341
Chris Lattnerdadc7622007-10-05 20:15:24 +0000342unsigned llvm::DenseMapInfo<clang::Selector>::getHashValue(clang::Selector S) {
343 return DenseMapInfo<void*>::getHashValue(S.getAsOpaquePtr());
344}
345
Douglas Gregor77324f32008-11-17 14:58:09 +0000346namespace clang {
Steve Naroffe61bfa82007-10-05 18:42:47 +0000347/// MultiKeywordSelector - One of these variable length records is kept for each
348/// selector containing more than one keyword. We use a folding set
Mike Stump11289f42009-09-09 15:08:12 +0000349/// to unique aggregate names (keyword selectors in ObjC parlance). Access to
Steve Naroffe61bfa82007-10-05 18:42:47 +0000350/// this class is provided strictly through Selector.
Mike Stump11289f42009-09-09 15:08:12 +0000351class MultiKeywordSelector
Douglas Gregor77324f32008-11-17 14:58:09 +0000352 : public DeclarationNameExtra, public llvm::FoldingSetNode {
Douglas Gregor77324f32008-11-17 14:58:09 +0000353 MultiKeywordSelector(unsigned nKeys) {
354 ExtraKindOrNumArgs = NUM_EXTRA_KINDS + nKeys;
355 }
Mike Stump11289f42009-09-09 15:08:12 +0000356public:
Steve Naroffe61bfa82007-10-05 18:42:47 +0000357 // Constructor for keyword selectors.
358 MultiKeywordSelector(unsigned nKeys, IdentifierInfo **IIV) {
359 assert((nKeys > 1) && "not a multi-keyword selector");
Douglas Gregor77324f32008-11-17 14:58:09 +0000360 ExtraKindOrNumArgs = NUM_EXTRA_KINDS + nKeys;
Mike Stump11289f42009-09-09 15:08:12 +0000361
Steve Naroffe61bfa82007-10-05 18:42:47 +0000362 // Fill in the trailing keyword array.
363 IdentifierInfo **KeyInfo = reinterpret_cast<IdentifierInfo **>(this+1);
364 for (unsigned i = 0; i != nKeys; ++i)
365 KeyInfo[i] = IIV[i];
Mike Stump11289f42009-09-09 15:08:12 +0000366 }
367
Chris Lattnerf7f34d02007-10-07 01:33:16 +0000368 // getName - Derive the full selector name and return it.
369 std::string getName() const;
Mike Stump11289f42009-09-09 15:08:12 +0000370
Douglas Gregor77324f32008-11-17 14:58:09 +0000371 unsigned getNumArgs() const { return ExtraKindOrNumArgs - NUM_EXTRA_KINDS; }
Mike Stump11289f42009-09-09 15:08:12 +0000372
Steve Naroffe61bfa82007-10-05 18:42:47 +0000373 typedef IdentifierInfo *const *keyword_iterator;
374 keyword_iterator keyword_begin() const {
375 return reinterpret_cast<keyword_iterator>(this+1);
376 }
Mike Stump11289f42009-09-09 15:08:12 +0000377 keyword_iterator keyword_end() const {
378 return keyword_begin()+getNumArgs();
Steve Naroffe61bfa82007-10-05 18:42:47 +0000379 }
Chris Lattnerf7f34d02007-10-07 01:33:16 +0000380 IdentifierInfo *getIdentifierInfoForSlot(unsigned i) const {
Douglas Gregor77324f32008-11-17 14:58:09 +0000381 assert(i < getNumArgs() && "getIdentifierInfoForSlot(): illegal index");
Steve Naroffe61bfa82007-10-05 18:42:47 +0000382 return keyword_begin()[i];
383 }
Mike Stump11289f42009-09-09 15:08:12 +0000384 static void Profile(llvm::FoldingSetNodeID &ID,
Steve Naroffe61bfa82007-10-05 18:42:47 +0000385 keyword_iterator ArgTys, unsigned NumArgs) {
386 ID.AddInteger(NumArgs);
Chris Lattnerf7f34d02007-10-07 01:33:16 +0000387 for (unsigned i = 0; i != NumArgs; ++i)
388 ID.AddPointer(ArgTys[i]);
Steve Naroffe61bfa82007-10-05 18:42:47 +0000389 }
390 void Profile(llvm::FoldingSetNodeID &ID) {
Douglas Gregor77324f32008-11-17 14:58:09 +0000391 Profile(ID, keyword_begin(), getNumArgs());
Steve Naroffe61bfa82007-10-05 18:42:47 +0000392 }
393};
Chris Lattnerdadc7622007-10-05 20:15:24 +0000394} // end namespace clang.
Steve Naroffe61bfa82007-10-05 18:42:47 +0000395
396unsigned Selector::getNumArgs() const {
397 unsigned IIF = getIdentifierInfoFlag();
Douglas Gregor93a586f2012-05-04 18:24:37 +0000398 if (IIF <= ZeroArg)
Steve Naroffe61bfa82007-10-05 18:42:47 +0000399 return 0;
400 if (IIF == OneArg)
401 return 1;
Douglas Gregor93a586f2012-05-04 18:24:37 +0000402 // We point to a MultiKeywordSelector.
403 MultiKeywordSelector *SI = getMultiKeywordSelector();
Mike Stump11289f42009-09-09 15:08:12 +0000404 return SI->getNumArgs();
Steve Naroffe61bfa82007-10-05 18:42:47 +0000405}
406
Chris Lattnerf7f34d02007-10-07 01:33:16 +0000407IdentifierInfo *Selector::getIdentifierInfoForSlot(unsigned argIndex) const {
Douglas Gregor93a586f2012-05-04 18:24:37 +0000408 if (getIdentifierInfoFlag() < MultiArg) {
Chris Lattnerf7f34d02007-10-07 01:33:16 +0000409 assert(argIndex == 0 && "illegal keyword index");
Douglas Gregor70091b82009-04-26 22:20:50 +0000410 return getAsIdentifierInfo();
Steve Naroffe61bfa82007-10-05 18:42:47 +0000411 }
Douglas Gregor93a586f2012-05-04 18:24:37 +0000412 // We point to a MultiKeywordSelector.
413 MultiKeywordSelector *SI = getMultiKeywordSelector();
Steve Naroffe61bfa82007-10-05 18:42:47 +0000414 return SI->getIdentifierInfoForSlot(argIndex);
415}
416
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000417StringRef Selector::getNameForSlot(unsigned int argIndex) const {
Douglas Gregoraf2a6ae2011-02-18 22:29:55 +0000418 IdentifierInfo *II = getIdentifierInfoForSlot(argIndex);
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000419 return II? II->getName() : StringRef();
Douglas Gregoraf2a6ae2011-02-18 22:29:55 +0000420}
421
Chris Lattnerf7f34d02007-10-07 01:33:16 +0000422std::string MultiKeywordSelector::getName() const {
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +0000423 SmallString<256> Str;
Daniel Dunbar1c0761d2009-10-17 18:13:02 +0000424 llvm::raw_svector_ostream OS(Str);
Chris Lattnerf7f34d02007-10-07 01:33:16 +0000425 for (keyword_iterator I = keyword_begin(), E = keyword_end(); I != E; ++I) {
426 if (*I)
Daniel Dunbar07d07852009-10-18 21:17:35 +0000427 OS << (*I)->getName();
Daniel Dunbar1c0761d2009-10-17 18:13:02 +0000428 OS << ':';
Steve Naroffe61bfa82007-10-05 18:42:47 +0000429 }
Mike Stump11289f42009-09-09 15:08:12 +0000430
Daniel Dunbar1c0761d2009-10-17 18:13:02 +0000431 return OS.str();
Steve Naroffe61bfa82007-10-05 18:42:47 +0000432}
433
Chris Lattnere4b95692008-11-24 03:33:13 +0000434std::string Selector::getAsString() const {
Douglas Gregor70091b82009-04-26 22:20:50 +0000435 if (InfoPtr == 0)
436 return "<null selector>";
437
Douglas Gregor93a586f2012-05-04 18:24:37 +0000438 if (getIdentifierInfoFlag() < MultiArg) {
Ted Kremenek5f080b42009-03-06 23:36:28 +0000439 IdentifierInfo *II = getAsIdentifierInfo();
Mike Stump11289f42009-09-09 15:08:12 +0000440
Ted Kremenek0666a6c2009-03-07 01:22:02 +0000441 // If the number of arguments is 0 then II is guaranteed to not be null.
Ted Kremenek5f080b42009-03-06 23:36:28 +0000442 if (getNumArgs() == 0)
Daniel Dunbar07d07852009-10-18 21:17:35 +0000443 return II->getName();
Ted Kremenek5f080b42009-03-06 23:36:28 +0000444
Daniel Dunbar1c0761d2009-10-17 18:13:02 +0000445 if (!II)
446 return ":";
447
Daniel Dunbar07d07852009-10-18 21:17:35 +0000448 return II->getName().str() + ":";
Steve Naroffe61bfa82007-10-05 18:42:47 +0000449 }
Mike Stump11289f42009-09-09 15:08:12 +0000450
Douglas Gregor93a586f2012-05-04 18:24:37 +0000451 // We have a multiple keyword selector.
452 return getMultiKeywordSelector()->getName();
Steve Naroffe61bfa82007-10-05 18:42:47 +0000453}
454
Aaron Ballmanb190f972014-01-03 17:59:55 +0000455void Selector::print(llvm::raw_ostream &OS) const {
456 OS << getAsString();
457}
458
John McCallb4526252011-03-02 01:50:55 +0000459/// Interpreting the given string using the normal CamelCase
460/// conventions, determine whether the given string starts with the
461/// given "word", which is assumed to end in a lowercase letter.
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000462static bool startsWithWord(StringRef name, StringRef word) {
John McCallb4526252011-03-02 01:50:55 +0000463 if (name.size() < word.size()) return false;
Jordan Rosea7d03842013-02-08 22:30:41 +0000464 return ((name.size() == word.size() || !isLowercase(name[word.size()])) &&
465 name.startswith(word));
John McCallb4526252011-03-02 01:50:55 +0000466}
467
468ObjCMethodFamily Selector::getMethodFamilyImpl(Selector sel) {
469 IdentifierInfo *first = sel.getIdentifierInfoForSlot(0);
470 if (!first) return OMF_None;
471
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000472 StringRef name = first->getName();
John McCallb4526252011-03-02 01:50:55 +0000473 if (sel.isUnarySelector()) {
474 if (name == "autorelease") return OMF_autorelease;
475 if (name == "dealloc") return OMF_dealloc;
Nico Weber1fb82662011-08-28 22:35:17 +0000476 if (name == "finalize") return OMF_finalize;
John McCallb4526252011-03-02 01:50:55 +0000477 if (name == "release") return OMF_release;
478 if (name == "retain") return OMF_retain;
479 if (name == "retainCount") return OMF_retainCount;
Douglas Gregor33823722011-06-11 01:09:30 +0000480 if (name == "self") return OMF_self;
Fariborz Jahanian78e9deb2014-08-22 16:57:26 +0000481 if (name == "initialize") return OMF_initialize;
John McCallb4526252011-03-02 01:50:55 +0000482 }
Fariborz Jahanianb7a77362011-07-05 22:38:59 +0000483
484 if (name == "performSelector") return OMF_performSelector;
John McCallb4526252011-03-02 01:50:55 +0000485
486 // The other method families may begin with a prefix of underscores.
487 while (!name.empty() && name.front() == '_')
488 name = name.substr(1);
489
490 if (name.empty()) return OMF_None;
491 switch (name.front()) {
492 case 'a':
493 if (startsWithWord(name, "alloc")) return OMF_alloc;
494 break;
495 case 'c':
496 if (startsWithWord(name, "copy")) return OMF_copy;
497 break;
498 case 'i':
499 if (startsWithWord(name, "init")) return OMF_init;
500 break;
501 case 'm':
502 if (startsWithWord(name, "mutableCopy")) return OMF_mutableCopy;
503 break;
504 case 'n':
505 if (startsWithWord(name, "new")) return OMF_new;
506 break;
507 default:
508 break;
509 }
510
511 return OMF_None;
512}
Steve Naroffe61bfa82007-10-05 18:42:47 +0000513
Fariborz Jahanian71221352013-07-23 22:42:28 +0000514ObjCInstanceTypeFamily Selector::getInstTypeMethodFamily(Selector sel) {
Fariborz Jahanian4f3a64f2013-07-23 19:31:17 +0000515 IdentifierInfo *first = sel.getIdentifierInfoForSlot(0);
516 if (!first) return OIT_None;
517
518 StringRef name = first->getName();
519
520 if (name.empty()) return OIT_None;
521 switch (name.front()) {
522 case 'a':
Fariborz Jahanian4ccdc732013-08-29 16:22:26 +0000523 if (startsWithWord(name, "array")) return OIT_Array;
Fariborz Jahanian4f3a64f2013-07-23 19:31:17 +0000524 break;
525 case 'd':
Fariborz Jahanian7c87b432013-10-10 18:23:13 +0000526 if (startsWithWord(name, "default")) return OIT_ReturnsSelf;
Fariborz Jahanian4f3a64f2013-07-23 19:31:17 +0000527 if (startsWithWord(name, "dictionary")) return OIT_Dictionary;
528 break;
Fariborz Jahanian9275c682013-08-02 20:54:18 +0000529 case 's':
Fariborz Jahanian7c87b432013-10-10 18:23:13 +0000530 if (startsWithWord(name, "shared")) return OIT_ReturnsSelf;
531 if (startsWithWord(name, "standard")) return OIT_Singleton;
Fariborz Jahanian1c900bc2013-09-18 20:35:47 +0000532 case 'i':
533 if (startsWithWord(name, "init")) return OIT_Init;
Fariborz Jahanian4f3a64f2013-07-23 19:31:17 +0000534 default:
535 break;
536 }
537 return OIT_None;
538}
539
Fariborz Jahanian6485fe42014-09-09 23:10:54 +0000540ObjCStringFormatFamily Selector::getStringFormatFamilyImpl(Selector sel) {
541 IdentifierInfo *first = sel.getIdentifierInfoForSlot(0);
542 if (!first) return SFF_None;
543
544 StringRef name = first->getName();
545
546 switch (name.front()) {
547 case 'a':
548 if (name == "appendFormat") return SFF_NSString;
549 break;
550
551 case 'i':
552 if (name == "initWithFormat") return SFF_NSString;
553 break;
554
555 case 'l':
556 if (name == "localizedStringWithFormat") return SFF_NSString;
557 break;
558
559 case 's':
560 if (name == "stringByAppendingFormat" ||
561 name == "stringWithFormat") return SFF_NSString;
562 break;
563 }
564 return SFF_None;
565}
566
Chris Lattner1a849942009-03-04 05:35:38 +0000567namespace {
568 struct SelectorTableImpl {
569 llvm::FoldingSet<MultiKeywordSelector> Table;
570 llvm::BumpPtrAllocator Allocator;
571 };
572} // end anonymous namespace.
573
574static SelectorTableImpl &getSelectorTableImpl(void *P) {
575 return *static_cast<SelectorTableImpl*>(P);
576}
577
Adrian Prantl6e77c962013-06-10 21:36:55 +0000578SmallString<64>
Adrian Prantla4ce9062013-06-07 22:29:12 +0000579SelectorTable::constructSetterName(StringRef Name) {
Adrian Prantl6e77c962013-06-10 21:36:55 +0000580 SmallString<64> SetterName("set");
581 SetterName += Name;
582 SetterName[3] = toUppercase(SetterName[3]);
583 return SetterName;
Adrian Prantla4ce9062013-06-07 22:29:12 +0000584}
585
Adrian Prantl6e77c962013-06-10 21:36:55 +0000586Selector
Adrian Prantla4ce9062013-06-07 22:29:12 +0000587SelectorTable::constructSetterSelector(IdentifierTable &Idents,
588 SelectorTable &SelTable,
589 const IdentifierInfo *Name) {
590 IdentifierInfo *SetterName =
591 &Idents.get(constructSetterName(Name->getName()));
Benjamin Kramer49038022012-02-04 13:45:25 +0000592 return SelTable.getUnarySelector(SetterName);
593}
594
Ted Kremenek1c2239e2011-04-18 22:47:04 +0000595size_t SelectorTable::getTotalMemory() const {
596 SelectorTableImpl &SelTabImpl = getSelectorTableImpl(Impl);
597 return SelTabImpl.Allocator.getTotalMemory();
598}
Chris Lattner1a849942009-03-04 05:35:38 +0000599
Chris Lattner5700fab2007-10-07 02:00:24 +0000600Selector SelectorTable::getSelector(unsigned nKeys, IdentifierInfo **IIV) {
601 if (nKeys < 2)
602 return Selector(IIV[0], nKeys);
Mike Stump11289f42009-09-09 15:08:12 +0000603
Chris Lattner1a849942009-03-04 05:35:38 +0000604 SelectorTableImpl &SelTabImpl = getSelectorTableImpl(Impl);
Mike Stump11289f42009-09-09 15:08:12 +0000605
Steve Naroffe61bfa82007-10-05 18:42:47 +0000606 // Unique selector, to guarantee there is one per name.
607 llvm::FoldingSetNodeID ID;
608 MultiKeywordSelector::Profile(ID, IIV, nKeys);
609
Craig Topperf1186c52014-05-08 06:41:40 +0000610 void *InsertPos = nullptr;
Chris Lattner1a849942009-03-04 05:35:38 +0000611 if (MultiKeywordSelector *SI =
612 SelTabImpl.Table.FindNodeOrInsertPos(ID, InsertPos))
Steve Naroffe61bfa82007-10-05 18:42:47 +0000613 return Selector(SI);
Mike Stump11289f42009-09-09 15:08:12 +0000614
Steve Naroffe61bfa82007-10-05 18:42:47 +0000615 // MultiKeywordSelector objects are not allocated with new because they have a
616 // variable size array (for parameter types) at the end of them.
Chris Lattner1a849942009-03-04 05:35:38 +0000617 unsigned Size = sizeof(MultiKeywordSelector) + nKeys*sizeof(IdentifierInfo *);
618 MultiKeywordSelector *SI =
Mike Stump11289f42009-09-09 15:08:12 +0000619 (MultiKeywordSelector*)SelTabImpl.Allocator.Allocate(Size,
Chris Lattner5c0b4052010-10-30 05:14:06 +0000620 llvm::alignOf<MultiKeywordSelector>());
Steve Naroffe61bfa82007-10-05 18:42:47 +0000621 new (SI) MultiKeywordSelector(nKeys, IIV);
Chris Lattner1a849942009-03-04 05:35:38 +0000622 SelTabImpl.Table.InsertNode(SI, InsertPos);
Steve Naroffe61bfa82007-10-05 18:42:47 +0000623 return Selector(SI);
624}
625
Steve Naroffe61bfa82007-10-05 18:42:47 +0000626SelectorTable::SelectorTable() {
Chris Lattner1a849942009-03-04 05:35:38 +0000627 Impl = new SelectorTableImpl();
Steve Naroffe61bfa82007-10-05 18:42:47 +0000628}
629
630SelectorTable::~SelectorTable() {
Chris Lattner1a849942009-03-04 05:35:38 +0000631 delete &getSelectorTableImpl(Impl);
Steve Naroffe61bfa82007-10-05 18:42:47 +0000632}
633
Douglas Gregor71395fa2009-11-04 00:56:37 +0000634const char *clang::getOperatorSpelling(OverloadedOperatorKind Operator) {
635 switch (Operator) {
636 case OO_None:
637 case NUM_OVERLOADED_OPERATORS:
Craig Topperf1186c52014-05-08 06:41:40 +0000638 return nullptr;
Kovarththanan Rajaratnam00682a42010-03-12 11:27:37 +0000639
Douglas Gregor71395fa2009-11-04 00:56:37 +0000640#define OVERLOADED_OPERATOR(Name,Spelling,Token,Unary,Binary,MemberOnly) \
641 case OO_##Name: return Spelling;
642#include "clang/Basic/OperatorKinds.def"
643 }
Kovarththanan Rajaratnam00682a42010-03-12 11:27:37 +0000644
David Blaikie8a40f702012-01-17 06:56:22 +0000645 llvm_unreachable("Invalid OverloadedOperatorKind!");
Douglas Gregor71395fa2009-11-04 00:56:37 +0000646}
Douglas Gregor813a0662015-06-19 18:14:38 +0000647
Douglas Gregoraea7afd2015-06-24 22:02:08 +0000648StringRef clang::getNullabilitySpelling(NullabilityKind kind,
649 bool isContextSensitive) {
Douglas Gregor813a0662015-06-19 18:14:38 +0000650 switch (kind) {
651 case NullabilityKind::NonNull:
Douglas Gregoraea7afd2015-06-24 22:02:08 +0000652 return isContextSensitive ? "nonnull" : "_Nonnull";
Douglas Gregor813a0662015-06-19 18:14:38 +0000653
654 case NullabilityKind::Nullable:
Douglas Gregoraea7afd2015-06-24 22:02:08 +0000655 return isContextSensitive ? "nullable" : "_Nullable";
Douglas Gregor813a0662015-06-19 18:14:38 +0000656
657 case NullabilityKind::Unspecified:
Douglas Gregoraea7afd2015-06-24 22:02:08 +0000658 return isContextSensitive ? "null_unspecified" : "_Null_unspecified";
Douglas Gregor813a0662015-06-19 18:14:38 +0000659 }
Nico Weber708aabd2015-06-20 00:06:30 +0000660 llvm_unreachable("Unknown nullability kind.");
Douglas Gregor813a0662015-06-19 18:14:38 +0000661}