clang  15.0.0git
IdentifierTable.cpp
Go to the documentation of this file.
1 //===- IdentifierTable.cpp - Hash table for identifier lookup -------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the IdentifierInfo, IdentifierVisitor, and
10 // IdentifierTable interfaces.
11 //
12 //===----------------------------------------------------------------------===//
13 
15 #include "clang/Basic/CharInfo.h"
18 #include "clang/Basic/Specifiers.h"
20 #include "clang/Basic/TokenKinds.h"
21 #include "llvm/ADT/DenseMapInfo.h"
22 #include "llvm/ADT/FoldingSet.h"
23 #include "llvm/ADT/SmallString.h"
24 #include "llvm/ADT/StringMap.h"
25 #include "llvm/ADT/StringRef.h"
26 #include "llvm/Support/Allocator.h"
27 #include "llvm/Support/ErrorHandling.h"
28 #include "llvm/Support/raw_ostream.h"
29 #include <cassert>
30 #include <cstdio>
31 #include <cstring>
32 #include <string>
33 
34 using namespace clang;
35 
36 // A check to make sure the ObjCOrBuiltinID has sufficient room to store the
37 // largest possible target/aux-target combination. If we exceed this, we likely
38 // need to just change the ObjCOrBuiltinIDBits value in IdentifierTable.h.
39 static_assert(2 * LargestBuiltinID < (2 << (ObjCOrBuiltinIDBits - 1)),
40  "Insufficient ObjCOrBuiltinID Bits");
41 
42 //===----------------------------------------------------------------------===//
43 // IdentifierTable Implementation
44 //===----------------------------------------------------------------------===//
45 
47 
49 
50 namespace {
51 
52 /// A simple identifier lookup iterator that represents an
53 /// empty sequence of identifiers.
54 class EmptyLookupIterator : public IdentifierIterator
55 {
56 public:
57  StringRef Next() override { return StringRef(); }
58 };
59 
60 } // namespace
61 
63  return new EmptyLookupIterator();
64 }
65 
67  : HashTable(8192), // Start with space for 8K identifiers.
68  ExternalLookup(ExternalLookup) {}
69 
71  IdentifierInfoLookup *ExternalLookup)
72  : IdentifierTable(ExternalLookup) {
73  // Populate the identifier table with info about keywords for the current
74  // language.
75  AddKeywords(LangOpts);
76 }
77 
78 //===----------------------------------------------------------------------===//
79 // Language Keyword Implementation
80 //===----------------------------------------------------------------------===//
81 
82 // Constants for TokenKinds.def
83 namespace {
84 
85  enum {
86  KEYC99 = 0x1,
87  KEYCXX = 0x2,
88  KEYCXX11 = 0x4,
89  KEYGNU = 0x8,
90  KEYMS = 0x10,
91  BOOLSUPPORT = 0x20,
92  KEYALTIVEC = 0x40,
93  KEYNOCXX = 0x80,
94  KEYBORLAND = 0x100,
95  KEYOPENCLC = 0x200,
96  KEYC11 = 0x400,
97  KEYNOMS18 = 0x800,
98  KEYNOOPENCL = 0x1000,
99  WCHARSUPPORT = 0x2000,
100  HALFSUPPORT = 0x4000,
101  CHAR8SUPPORT = 0x8000,
102  KEYCONCEPTS = 0x10000,
103  KEYOBJC = 0x20000,
104  KEYZVECTOR = 0x40000,
105  KEYCOROUTINES = 0x80000,
106  KEYMODULES = 0x100000,
107  KEYCXX20 = 0x200000,
108  KEYOPENCLCXX = 0x400000,
109  KEYMSCOMPAT = 0x800000,
110  KEYSYCL = 0x1000000,
111  KEYCUDA = 0x2000000,
112  KEYMAX = KEYCUDA, // The maximum key
113  KEYALLCXX = KEYCXX | KEYCXX11 | KEYCXX20,
114  KEYALL = (KEYMAX | (KEYMAX-1)) & ~KEYNOMS18 &
115  ~KEYNOOPENCL // KEYNOMS18 and KEYNOOPENCL are used to exclude.
116  };
117 
118  /// 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  };
125 
126 } // namespace
127 
128 /// Translates flags as specified in TokenKinds.def into keyword status
129 /// in the given language standard.
130 static KeywordStatus getKeywordStatus(const LangOptions &LangOpts,
131  unsigned Flags) {
132  if (Flags == KEYALL) return KS_Enabled;
133  if (LangOpts.CPlusPlus && (Flags & KEYCXX)) return KS_Enabled;
134  if (LangOpts.CPlusPlus11 && (Flags & KEYCXX11)) return KS_Enabled;
135  if (LangOpts.CPlusPlus20 && (Flags & KEYCXX20)) return KS_Enabled;
136  if (LangOpts.C99 && (Flags & KEYC99)) return KS_Enabled;
137  if (LangOpts.GNUKeywords && (Flags & KEYGNU)) return KS_Extension;
138  if (LangOpts.MicrosoftExt && (Flags & KEYMS)) return KS_Extension;
139  if (LangOpts.MSVCCompat && (Flags & KEYMSCOMPAT)) return KS_Enabled;
140  if (LangOpts.Borland && (Flags & KEYBORLAND)) return KS_Extension;
141  if (LangOpts.Bool && (Flags & BOOLSUPPORT)) return KS_Enabled;
142  if (LangOpts.Half && (Flags & HALFSUPPORT)) return KS_Enabled;
143  if (LangOpts.WChar && (Flags & WCHARSUPPORT)) return KS_Enabled;
144  if (LangOpts.Char8 && (Flags & CHAR8SUPPORT)) return KS_Enabled;
145  if (LangOpts.AltiVec && (Flags & KEYALTIVEC)) return KS_Enabled;
146  if (LangOpts.ZVector && (Flags & KEYZVECTOR)) return KS_Enabled;
147  if (LangOpts.OpenCL && !LangOpts.OpenCLCPlusPlus && (Flags & KEYOPENCLC))
148  return KS_Enabled;
149  if (LangOpts.OpenCLCPlusPlus && (Flags & KEYOPENCLCXX)) return KS_Enabled;
150  if (!LangOpts.CPlusPlus && (Flags & KEYNOCXX)) return KS_Enabled;
151  if (LangOpts.C11 && (Flags & KEYC11)) return KS_Enabled;
152  // We treat bridge casts as objective-C keywords so we can warn on them
153  // in non-arc mode.
154  if (LangOpts.ObjC && (Flags & KEYOBJC)) return KS_Enabled;
155  if (LangOpts.CPlusPlus20 && (Flags & KEYCONCEPTS)) return KS_Enabled;
156  if (LangOpts.Coroutines && (Flags & KEYCOROUTINES)) return KS_Enabled;
157  if (LangOpts.ModulesTS && (Flags & KEYMODULES)) return KS_Enabled;
158  if (LangOpts.CPlusPlus && (Flags & KEYALLCXX)) return KS_Future;
159  if (LangOpts.CPlusPlus && !LangOpts.CPlusPlus20 && (Flags & CHAR8SUPPORT))
160  return KS_Future;
161  if (LangOpts.isSYCL() && (Flags & KEYSYCL))
162  return KS_Enabled;
163  if (LangOpts.CUDA && (Flags & KEYCUDA))
164  return KS_Enabled;
165  return KS_Disabled;
166 }
167 
168 /// AddKeyword - This method is used to associate a token ID with specific
169 /// identifiers because they are language keywords. This causes the lexer to
170 /// automatically map matching identifiers to specialized token codes.
171 static void AddKeyword(StringRef Keyword,
172  tok::TokenKind TokenCode, unsigned Flags,
173  const LangOptions &LangOpts, IdentifierTable &Table) {
174  KeywordStatus AddResult = getKeywordStatus(LangOpts, Flags);
175 
176  // Don't add this keyword under MSVCCompat.
177  if (LangOpts.MSVCCompat && (Flags & KEYNOMS18) &&
179  return;
180 
181  // Don't add this keyword under OpenCL.
182  if (LangOpts.OpenCL && (Flags & KEYNOOPENCL))
183  return;
184 
185  // Don't add this keyword if disabled in this language.
186  if (AddResult == KS_Disabled) return;
187 
188  IdentifierInfo &Info =
189  Table.get(Keyword, AddResult == KS_Future ? tok::identifier : TokenCode);
190  Info.setIsExtensionToken(AddResult == KS_Extension);
191  Info.setIsFutureCompatKeyword(AddResult == KS_Future);
192 }
193 
194 /// AddCXXOperatorKeyword - Register a C++ operator keyword alternative
195 /// representations.
196 static void AddCXXOperatorKeyword(StringRef Keyword,
197  tok::TokenKind TokenCode,
198  IdentifierTable &Table) {
199  IdentifierInfo &Info = Table.get(Keyword, TokenCode);
201 }
202 
203 /// AddObjCKeyword - Register an Objective-C \@keyword like "class" "selector"
204 /// or "property".
205 static void AddObjCKeyword(StringRef Name,
206  tok::ObjCKeywordKind ObjCID,
207  IdentifierTable &Table) {
208  Table.get(Name).setObjCKeywordID(ObjCID);
209 }
210 
211 /// AddKeywords - Add all keywords to the symbol table.
212 ///
214  // Add keywords and tokens for the current language.
215 #define KEYWORD(NAME, FLAGS) \
216  AddKeyword(StringRef(#NAME), tok::kw_ ## NAME, \
217  FLAGS, LangOpts, *this);
218 #define ALIAS(NAME, TOK, FLAGS) \
219  AddKeyword(StringRef(NAME), tok::kw_ ## TOK, \
220  FLAGS, LangOpts, *this);
221 #define CXX_KEYWORD_OPERATOR(NAME, ALIAS) \
222  if (LangOpts.CXXOperatorNames) \
223  AddCXXOperatorKeyword(StringRef(#NAME), tok::ALIAS, *this);
224 #define OBJC_AT_KEYWORD(NAME) \
225  if (LangOpts.ObjC) \
226  AddObjCKeyword(StringRef(#NAME), tok::objc_##NAME, *this);
227 #define TESTING_KEYWORD(NAME, FLAGS)
228 #include "clang/Basic/TokenKinds.def"
229 
230  if (LangOpts.ParseUnknownAnytype)
231  AddKeyword("__unknown_anytype", tok::kw___unknown_anytype, KEYALL,
232  LangOpts, *this);
233 
234  if (LangOpts.DeclSpecKeyword)
235  AddKeyword("__declspec", tok::kw___declspec, KEYALL, LangOpts, *this);
236 
237  if (LangOpts.IEEE128)
238  AddKeyword("__ieee128", tok::kw___float128, KEYALL, LangOpts, *this);
239 
240  // Add the 'import' contextual keyword.
241  get("import").setModulesImport(true);
242 }
243 
244 /// Checks if the specified token kind represents a keyword in the
245 /// specified language.
246 /// \returns Status of the keyword in the language.
247 static KeywordStatus getTokenKwStatus(const LangOptions &LangOpts,
248  tok::TokenKind K) {
249  switch (K) {
250 #define KEYWORD(NAME, FLAGS) \
251  case tok::kw_##NAME: return getKeywordStatus(LangOpts, FLAGS);
252 #include "clang/Basic/TokenKinds.def"
253  default: return KS_Disabled;
254  }
255 }
256 
257 /// Returns true if the identifier represents a keyword in the
258 /// specified language.
259 bool IdentifierInfo::isKeyword(const LangOptions &LangOpts) const {
260  switch (getTokenKwStatus(LangOpts, getTokenID())) {
261  case KS_Enabled:
262  case KS_Extension:
263  return true;
264  default:
265  return false;
266  }
267 }
268 
269 /// Returns true if the identifier represents a C++ keyword in the
270 /// specified language.
271 bool IdentifierInfo::isCPlusPlusKeyword(const LangOptions &LangOpts) const {
272  if (!LangOpts.CPlusPlus || !isKeyword(LangOpts))
273  return false;
274  // This is a C++ keyword if this identifier is not a keyword when checked
275  // using LangOptions without C++ support.
276  LangOptions LangOptsNoCPP = LangOpts;
277  LangOptsNoCPP.CPlusPlus = false;
278  LangOptsNoCPP.CPlusPlus11 = false;
279  LangOptsNoCPP.CPlusPlus20 = false;
280  return !isKeyword(LangOptsNoCPP);
281 }
282 
284 IdentifierInfo::isReserved(const LangOptions &LangOpts) const {
285  StringRef Name = getName();
286 
287  // '_' is a reserved identifier, but its use is so common (e.g. to store
288  // ignored values) that we don't warn on it.
289  if (Name.size() <= 1)
291 
292  // [lex.name] p3
293  if (Name[0] == '_') {
294 
295  // Each name that begins with an underscore followed by an uppercase letter
296  // or another underscore is reserved.
297  if (Name[1] == '_')
299 
300  if ('A' <= Name[1] && Name[1] <= 'Z')
303 
304  // This is a bit misleading: it actually means it's only reserved if we're
305  // at global scope because it starts with an underscore.
307  }
308 
309  // Each name that contains a double underscore (__) is reserved.
310  if (LangOpts.CPlusPlus && Name.contains("__"))
312 
314 }
315 
317  StringRef Name = getName();
318  if (Name.size() >= 2 && Name.front() == '_' &&
319  (Name[1] == '_' || (Name[1] >= 'A' && Name[1] <= 'Z')))
320  return Name.ltrim('_');
321  return Name;
322 }
323 
325  // We use a perfect hash function here involving the length of the keyword,
326  // the first and third character. For preprocessor ID's there are no
327  // collisions (if there were, the switch below would complain about duplicate
328  // case values). Note that this depends on 'if' being null terminated.
329 
330 #define HASH(LEN, FIRST, THIRD) \
331  (LEN << 5) + (((FIRST-'a') + (THIRD-'a')) & 31)
332 #define CASE(LEN, FIRST, THIRD, NAME) \
333  case HASH(LEN, FIRST, THIRD): \
334  return memcmp(Name, #NAME, LEN) ? tok::pp_not_keyword : tok::pp_ ## NAME
335 
336  unsigned Len = getLength();
337  if (Len < 2) return tok::pp_not_keyword;
338  const char *Name = getNameStart();
339  switch (HASH(Len, Name[0], Name[2])) {
340  default: return tok::pp_not_keyword;
341  CASE( 2, 'i', '\0', if);
342  CASE( 4, 'e', 'i', elif);
343  CASE( 4, 'e', 's', else);
344  CASE( 4, 'l', 'n', line);
345  CASE( 4, 's', 'c', sccs);
346  CASE( 5, 'e', 'd', endif);
347  CASE( 5, 'e', 'r', error);
348  CASE( 5, 'i', 'e', ident);
349  CASE( 5, 'i', 'd', ifdef);
350  CASE( 5, 'u', 'd', undef);
351 
352  CASE( 6, 'a', 's', assert);
353  CASE( 6, 'd', 'f', define);
354  CASE( 6, 'i', 'n', ifndef);
355  CASE( 6, 'i', 'p', import);
356  CASE( 6, 'p', 'a', pragma);
357 
358  CASE( 7, 'd', 'f', defined);
359  CASE( 7, 'e', 'i', elifdef);
360  CASE( 7, 'i', 'c', include);
361  CASE( 7, 'w', 'r', warning);
362 
363  CASE( 8, 'e', 'i', elifndef);
364  CASE( 8, 'u', 'a', unassert);
365  CASE(12, 'i', 'c', include_next);
366 
367  CASE(14, '_', 'p', __public_macro);
368 
369  CASE(15, '_', 'p', __private_macro);
370 
371  CASE(16, '_', 'i', __include_macros);
372 #undef CASE
373 #undef HASH
374  }
375 }
376 
377 //===----------------------------------------------------------------------===//
378 // Stats Implementation
379 //===----------------------------------------------------------------------===//
380 
381 /// PrintStats - Print statistics about how well the identifier table is doing
382 /// at hashing identifiers.
384  unsigned NumBuckets = HashTable.getNumBuckets();
385  unsigned NumIdentifiers = HashTable.getNumItems();
386  unsigned NumEmptyBuckets = NumBuckets-NumIdentifiers;
387  unsigned AverageIdentifierSize = 0;
388  unsigned MaxIdentifierLength = 0;
389 
390  // TODO: Figure out maximum times an identifier had to probe for -stats.
391  for (llvm::StringMap<IdentifierInfo*, llvm::BumpPtrAllocator>::const_iterator
392  I = HashTable.begin(), E = HashTable.end(); I != E; ++I) {
393  unsigned IdLen = I->getKeyLength();
394  AverageIdentifierSize += IdLen;
395  if (MaxIdentifierLength < IdLen)
396  MaxIdentifierLength = IdLen;
397  }
398 
399  fprintf(stderr, "\n*** Identifier Table Stats:\n");
400  fprintf(stderr, "# Identifiers: %d\n", NumIdentifiers);
401  fprintf(stderr, "# Empty Buckets: %d\n", NumEmptyBuckets);
402  fprintf(stderr, "Hash density (#identifiers per bucket): %f\n",
403  NumIdentifiers/(double)NumBuckets);
404  fprintf(stderr, "Ave identifier length: %f\n",
405  (AverageIdentifierSize/(double)NumIdentifiers));
406  fprintf(stderr, "Max identifier length: %d\n", MaxIdentifierLength);
407 
408  // Compute statistics about the memory allocated for identifiers.
409  HashTable.getAllocator().PrintStats();
410 }
411 
412 //===----------------------------------------------------------------------===//
413 // SelectorTable Implementation
414 //===----------------------------------------------------------------------===//
415 
417  return DenseMapInfo<void*>::getHashValue(S.getAsOpaquePtr());
418 }
419 
420 namespace clang {
421 
422 /// One of these variable length records is kept for each
423 /// selector containing more than one keyword. We use a folding set
424 /// to unique aggregate names (keyword selectors in ObjC parlance). Access to
425 /// this class is provided strictly through Selector.
426 class alignas(IdentifierInfoAlignment) MultiKeywordSelector
428  public llvm::FoldingSetNode {
429  MultiKeywordSelector(unsigned nKeys) : DeclarationNameExtra(nKeys) {}
430 
431 public:
432  // Constructor for keyword selectors.
433  MultiKeywordSelector(unsigned nKeys, IdentifierInfo **IIV)
434  : DeclarationNameExtra(nKeys) {
435  assert((nKeys > 1) && "not a multi-keyword selector");
436 
437  // Fill in the trailing keyword array.
438  IdentifierInfo **KeyInfo = reinterpret_cast<IdentifierInfo **>(this + 1);
439  for (unsigned i = 0; i != nKeys; ++i)
440  KeyInfo[i] = IIV[i];
441  }
442 
443  // getName - Derive the full selector name and return it.
444  std::string getName() const;
445 
446  using DeclarationNameExtra::getNumArgs;
447 
449 
451  return reinterpret_cast<keyword_iterator>(this + 1);
452  }
453 
455  return keyword_begin() + getNumArgs();
456  }
457 
459  assert(i < getNumArgs() && "getIdentifierInfoForSlot(): illegal index");
460  return keyword_begin()[i];
461  }
462 
463  static void Profile(llvm::FoldingSetNodeID &ID, keyword_iterator ArgTys,
464  unsigned NumArgs) {
465  ID.AddInteger(NumArgs);
466  for (unsigned i = 0; i != NumArgs; ++i)
467  ID.AddPointer(ArgTys[i]);
468  }
469 
470  void Profile(llvm::FoldingSetNodeID &ID) {
471  Profile(ID, keyword_begin(), getNumArgs());
472  }
473 };
474 
475 } // namespace clang.
476 
477 bool Selector::isKeywordSelector(ArrayRef<StringRef> Names) const {
478  assert(!Names.empty() && "must have >= 1 selector slots");
479  if (getNumArgs() != Names.size())
480  return false;
481  for (unsigned I = 0, E = Names.size(); I != E; ++I) {
482  if (getNameForSlot(I) != Names[I])
483  return false;
484  }
485  return true;
486 }
487 
488 bool Selector::isUnarySelector(StringRef Name) const {
489  return isUnarySelector() && getNameForSlot(0) == Name;
490 }
491 
492 unsigned Selector::getNumArgs() const {
493  unsigned IIF = getIdentifierInfoFlag();
494  if (IIF <= ZeroArg)
495  return 0;
496  if (IIF == OneArg)
497  return 1;
498  // We point to a MultiKeywordSelector.
499  MultiKeywordSelector *SI = getMultiKeywordSelector();
500  return SI->getNumArgs();
501 }
502 
503 IdentifierInfo *Selector::getIdentifierInfoForSlot(unsigned argIndex) const {
504  if (getIdentifierInfoFlag() < MultiArg) {
505  assert(argIndex == 0 && "illegal keyword index");
506  return getAsIdentifierInfo();
507  }
508 
509  // We point to a MultiKeywordSelector.
510  MultiKeywordSelector *SI = getMultiKeywordSelector();
511  return SI->getIdentifierInfoForSlot(argIndex);
512 }
513 
514 StringRef Selector::getNameForSlot(unsigned int argIndex) const {
515  IdentifierInfo *II = getIdentifierInfoForSlot(argIndex);
516  return II ? II->getName() : StringRef();
517 }
518 
520  SmallString<256> Str;
521  llvm::raw_svector_ostream OS(Str);
522  for (keyword_iterator I = keyword_begin(), E = keyword_end(); I != E; ++I) {
523  if (*I)
524  OS << (*I)->getName();
525  OS << ':';
526  }
527 
528  return std::string(OS.str());
529 }
530 
532  if (InfoPtr == 0)
533  return "<null selector>";
534 
535  if (getIdentifierInfoFlag() < MultiArg) {
536  IdentifierInfo *II = getAsIdentifierInfo();
537 
538  if (getNumArgs() == 0) {
539  assert(II && "If the number of arguments is 0 then II is guaranteed to "
540  "not be null.");
541  return std::string(II->getName());
542  }
543 
544  if (!II)
545  return ":";
546 
547  return II->getName().str() + ":";
548  }
549 
550  // We have a multiple keyword selector.
551  return getMultiKeywordSelector()->getName();
552 }
553 
554 void Selector::print(llvm::raw_ostream &OS) const {
555  OS << getAsString();
556 }
557 
558 LLVM_DUMP_METHOD void Selector::dump() const { print(llvm::errs()); }
559 
560 /// Interpreting the given string using the normal CamelCase
561 /// conventions, determine whether the given string starts with the
562 /// given "word", which is assumed to end in a lowercase letter.
563 static bool startsWithWord(StringRef name, StringRef word) {
564  if (name.size() < word.size()) return false;
565  return ((name.size() == word.size() || !isLowercase(name[word.size()])) &&
566  name.startswith(word));
567 }
568 
569 ObjCMethodFamily Selector::getMethodFamilyImpl(Selector sel) {
571  if (!first) return OMF_None;
572 
573  StringRef name = first->getName();
574  if (sel.isUnarySelector()) {
575  if (name == "autorelease") return OMF_autorelease;
576  if (name == "dealloc") return OMF_dealloc;
577  if (name == "finalize") return OMF_finalize;
578  if (name == "release") return OMF_release;
579  if (name == "retain") return OMF_retain;
580  if (name == "retainCount") return OMF_retainCount;
581  if (name == "self") return OMF_self;
582  if (name == "initialize") return OMF_initialize;
583  }
584 
585  if (name == "performSelector" || name == "performSelectorInBackground" ||
586  name == "performSelectorOnMainThread")
587  return OMF_performSelector;
588 
589  // The other method families may begin with a prefix of underscores.
590  while (!name.empty() && name.front() == '_')
591  name = name.substr(1);
592 
593  if (name.empty()) return OMF_None;
594  switch (name.front()) {
595  case 'a':
596  if (startsWithWord(name, "alloc")) return OMF_alloc;
597  break;
598  case 'c':
599  if (startsWithWord(name, "copy")) return OMF_copy;
600  break;
601  case 'i':
602  if (startsWithWord(name, "init")) return OMF_init;
603  break;
604  case 'm':
605  if (startsWithWord(name, "mutableCopy")) return OMF_mutableCopy;
606  break;
607  case 'n':
608  if (startsWithWord(name, "new")) return OMF_new;
609  break;
610  default:
611  break;
612  }
613 
614  return OMF_None;
615 }
616 
617 ObjCInstanceTypeFamily Selector::getInstTypeMethodFamily(Selector sel) {
619  if (!first) return OIT_None;
620 
621  StringRef name = first->getName();
622 
623  if (name.empty()) return OIT_None;
624  switch (name.front()) {
625  case 'a':
626  if (startsWithWord(name, "array")) return OIT_Array;
627  break;
628  case 'd':
629  if (startsWithWord(name, "default")) return OIT_ReturnsSelf;
630  if (startsWithWord(name, "dictionary")) return OIT_Dictionary;
631  break;
632  case 's':
633  if (startsWithWord(name, "shared")) return OIT_ReturnsSelf;
634  if (startsWithWord(name, "standard")) return OIT_Singleton;
635  break;
636  case 'i':
637  if (startsWithWord(name, "init")) return OIT_Init;
638  break;
639  default:
640  break;
641  }
642  return OIT_None;
643 }
644 
645 ObjCStringFormatFamily Selector::getStringFormatFamilyImpl(Selector sel) {
647  if (!first) return SFF_None;
648 
649  StringRef name = first->getName();
650 
651  switch (name.front()) {
652  case 'a':
653  if (name == "appendFormat") return SFF_NSString;
654  break;
655 
656  case 'i':
657  if (name == "initWithFormat") return SFF_NSString;
658  break;
659 
660  case 'l':
661  if (name == "localizedStringWithFormat") return SFF_NSString;
662  break;
663 
664  case 's':
665  if (name == "stringByAppendingFormat" ||
666  name == "stringWithFormat") return SFF_NSString;
667  break;
668  }
669  return SFF_None;
670 }
671 
672 namespace {
673 
674 struct SelectorTableImpl {
675  llvm::FoldingSet<MultiKeywordSelector> Table;
676  llvm::BumpPtrAllocator Allocator;
677 };
678 
679 } // namespace
680 
681 static SelectorTableImpl &getSelectorTableImpl(void *P) {
682  return *static_cast<SelectorTableImpl*>(P);
683 }
684 
686 SelectorTable::constructSetterName(StringRef Name) {
687  SmallString<64> SetterName("set");
688  SetterName += Name;
689  SetterName[3] = toUppercase(SetterName[3]);
690  return SetterName;
691 }
692 
693 Selector
694 SelectorTable::constructSetterSelector(IdentifierTable &Idents,
695  SelectorTable &SelTable,
696  const IdentifierInfo *Name) {
697  IdentifierInfo *SetterName =
698  &Idents.get(constructSetterName(Name->getName()));
699  return SelTable.getUnarySelector(SetterName);
700 }
701 
702 std::string SelectorTable::getPropertyNameFromSetterSelector(Selector Sel) {
703  StringRef Name = Sel.getNameForSlot(0);
704  assert(Name.startswith("set") && "invalid setter name");
705  return (Twine(toLowercase(Name[3])) + Name.drop_front(4)).str();
706 }
707 
708 size_t SelectorTable::getTotalMemory() const {
709  SelectorTableImpl &SelTabImpl = getSelectorTableImpl(Impl);
710  return SelTabImpl.Allocator.getTotalMemory();
711 }
712 
713 Selector SelectorTable::getSelector(unsigned nKeys, IdentifierInfo **IIV) {
714  if (nKeys < 2)
715  return Selector(IIV[0], nKeys);
716 
717  SelectorTableImpl &SelTabImpl = getSelectorTableImpl(Impl);
718 
719  // Unique selector, to guarantee there is one per name.
720  llvm::FoldingSetNodeID ID;
721  MultiKeywordSelector::Profile(ID, IIV, nKeys);
722 
723  void *InsertPos = nullptr;
724  if (MultiKeywordSelector *SI =
725  SelTabImpl.Table.FindNodeOrInsertPos(ID, InsertPos))
726  return Selector(SI);
727 
728  // MultiKeywordSelector objects are not allocated with new because they have a
729  // variable size array (for parameter types) at the end of them.
730  unsigned Size = sizeof(MultiKeywordSelector) + nKeys*sizeof(IdentifierInfo *);
732  (MultiKeywordSelector *)SelTabImpl.Allocator.Allocate(
733  Size, alignof(MultiKeywordSelector));
734  new (SI) MultiKeywordSelector(nKeys, IIV);
735  SelTabImpl.Table.InsertNode(SI, InsertPos);
736  return Selector(SI);
737 }
738 
739 SelectorTable::SelectorTable() {
740  Impl = new SelectorTableImpl();
741 }
742 
743 SelectorTable::~SelectorTable() {
744  delete &getSelectorTableImpl(Impl);
745 }
746 
748  switch (Operator) {
749  case OO_None:
751  return nullptr;
752 
753 #define OVERLOADED_OPERATOR(Name,Spelling,Token,Unary,Binary,MemberOnly) \
754  case OO_##Name: return Spelling;
755 #include "clang/Basic/OperatorKinds.def"
756  }
757 
758  llvm_unreachable("Invalid OverloadedOperatorKind!");
759 }
760 
762  bool isContextSensitive) {
763  switch (kind) {
764  case NullabilityKind::NonNull:
765  return isContextSensitive ? "nonnull" : "_Nonnull";
766 
767  case NullabilityKind::Nullable:
768  return isContextSensitive ? "nullable" : "_Nullable";
769 
770  case NullabilityKind::NullableResult:
771  assert(!isContextSensitive &&
772  "_Nullable_result isn't supported as context-sensitive keyword");
773  return "_Nullable_result";
774 
775  case NullabilityKind::Unspecified:
776  return isContextSensitive ? "null_unspecified" : "_Null_unspecified";
777  }
778  llvm_unreachable("Unknown nullability kind.");
779 }
AddCXXOperatorKeyword
static void AddCXXOperatorKeyword(StringRef Keyword, tok::TokenKind TokenCode, IdentifierTable &Table)
AddCXXOperatorKeyword - Register a C++ operator keyword alternative representations.
Definition: IdentifierTable.cpp:196
clang::OMF_autorelease
@ OMF_autorelease
Definition: IdentifierTable.h:706
Specifiers.h
llvm::DenseMapInfo< clang::Selector >::getHashValue
static unsigned getHashValue(clang::Selector S)
Definition: IdentifierTable.cpp:416
clang::ReservedIdentifierStatus::StartsWithUnderscoreAtGlobalScope
@ StartsWithUnderscoreAtGlobalScope
clang::IdentifierInfo::setModulesImport
void setModulesImport(bool I)
Set whether this identifier is the contextual keyword import.
Definition: IdentifierTable.h:430
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::ObjCMethodFamily
ObjCMethodFamily
A family of Objective-C methods.
Definition: IdentifierTable.h:690
clang::ReservedIdentifierStatus::NotReserved
@ NotReserved
include
include(CheckIncludeFiles) set(LLVM_LINK_COMPONENTS support) set(DIRECTORY_WATCHER_SOURCES DirectoryScanner.cpp) set(DIRECTORY_WATCHER_LINK_LIBS "") if(APPLE) check_include_files("CoreServices/CoreServices.h" HAVE_CORESERVICES) if(HAVE_CORESERVICES) list(APPEND DIRECTORY_WATCHER_SOURCES mac/DirectoryWatcher-mac.cpp) set(DIRECTORY_WATCHER_LINK_LIBS "-framework CoreServices") endif() elseif(CMAKE_SYSTEM_NAME MATCHES "Linux") check_include_files("sys/inotify.h" HAVE_INOTIFY) if(HAVE_INOTIFY) list(APPEND DIRECTORY_WATCHER_SOURCES linux/DirectoryWatcher-linux.cpp) find_package(Threads REQUIRED) endif() elseif(CMAKE_SYSTEM_NAME MATCHES "Windows") list(APPEND DIRECTORY_WATCHER_SOURCES windows/DirectoryWatcher-windows.cpp) else() list(APPEND DIRECTORY_WATCHER_SOURCES default/DirectoryWatcher-not-implemented.cpp) endif() add_clang_library(clangDirectoryWatcher $
Definition: CMakeLists.txt:1
clang::IdentifierTable::get
IdentifierInfo & get(StringRef Name)
Return the identifier token info for the specified named identifier.
Definition: IdentifierTable.h:596
clang::OMF_None
@ OMF_None
No particular method family.
Definition: IdentifierTable.h:692
clang::OMF_release
@ OMF_release
Definition: IdentifierTable.h:709
clang::ObjCOrBuiltinIDBits
static constexpr int ObjCOrBuiltinIDBits
Definition: IdentifierTable.h:76
clang::IdentifierInfoLookup::getIdentifiers
virtual IdentifierIterator * getIdentifiers()
Retrieve an iterator into the set of all identifiers known to this identifier lookup source.
Definition: IdentifierTable.cpp:62
clang::ObjCInstanceTypeFamily
ObjCInstanceTypeFamily
A family of Objective-C methods.
Definition: IdentifierTable.h:730
clang::Selector::isUnarySelector
bool isUnarySelector() const
Definition: IdentifierTable.h:829
clang::OMF_finalize
@ OMF_finalize
Definition: IdentifierTable.h:708
clang::OMF_init
@ OMF_init
Definition: IdentifierTable.h:700
clang::IdentifierInfo::isReserved
ReservedIdentifierStatus isReserved(const LangOptions &LangOpts) const
Determine whether this is a name reserved for the implementation (C99 7.1.3, C++ [lib....
Definition: IdentifierTable.cpp:284
clang::detail::DeclarationNameExtra::getNumArgs
unsigned getNumArgs() const
Return the number of arguments in an ObjC selector.
Definition: IdentifierTable.h:995
clang::ReservedIdentifierStatus::ContainsDoubleUnderscore
@ ContainsDoubleUnderscore
AddObjCKeyword
static void AddObjCKeyword(StringRef Name, tok::ObjCKeywordKind ObjCID, IdentifierTable &Table)
AddObjCKeyword - Register an Objective-C @keyword like "class" "selector" or "property".
Definition: IdentifierTable.cpp:205
clang::isLowercase
LLVM_READONLY bool isLowercase(unsigned char c)
Return true if this character is a lowercase ASCII letter: [a-z].
Definition: CharInfo.h:105
CASE
#define CASE(LEN, FIRST, THIRD, NAME)
clang::OMF_retainCount
@ OMF_retainCount
Definition: IdentifierTable.h:711
startsWithWord
static bool startsWithWord(StringRef name, StringRef word)
Interpreting the given string using the normal CamelCase conventions, determine whether the given str...
Definition: IdentifierTable.cpp:563
clang::toLowercase
LLVM_READONLY char toLowercase(char c)
Converts the given ASCII character to its lowercase equivalent.
Definition: CharInfo.h:208
print
void print(llvm::raw_ostream &OS, const Pointer &P, ASTContext &Ctx, QualType Ty)
Definition: InterpFrame.cpp:62
clang::IdentifierInfo::getTokenID
tok::TokenKind getTokenID() const
If this is a source-language token (e.g.
Definition: IdentifierTable.h:261
clang::MultiKeywordSelector::getIdentifierInfoForSlot
IdentifierInfo * getIdentifierInfoForSlot(unsigned i) const
Definition: IdentifierTable.cpp:458
clang::IdentifierIterator::~IdentifierIterator
virtual ~IdentifierIterator()
clang::MultiKeywordSelector::Profile
void Profile(llvm::FoldingSetNodeID &ID)
Definition: IdentifierTable.cpp:470
clang::ReservedIdentifierStatus::StartsWithUnderscoreFollowedByCapitalLetter
@ StartsWithUnderscoreFollowedByCapitalLetter
clang::IdentifierInfo::deuglifiedName
StringRef deuglifiedName() const
If the identifier is an "uglified" reserved name, return a cleaned form.
Definition: IdentifierTable.cpp:316
clang::OIT_ReturnsSelf
@ OIT_ReturnsSelf
Definition: IdentifierTable.h:736
TokenKinds.h
clang::OMF_copy
@ OMF_copy
Definition: IdentifierTable.h:699
clang::OIT_Dictionary
@ OIT_Dictionary
Definition: IdentifierTable.h:733
clang::MultiKeywordSelector::keyword_iterator
IdentifierInfo *const * keyword_iterator
Definition: IdentifierTable.cpp:448
clang::getAsString
llvm::StringRef getAsString(SyncScope S)
Definition: SyncScope.h:55
clang::LangOptions::isCompatibleWithMSVC
bool isCompatibleWithMSVC(MSVCMajorVersion MajorVersion) const
Definition: LangOptions.h:512
clang::OIT_Array
@ OIT_Array
Definition: IdentifierTable.h:732
clang::IdentifierInfo::isCPlusPlusKeyword
bool isCPlusPlusKeyword(const LangOptions &LangOpts) const
Return true if this token is a C++ keyword in the specified language.
Definition: IdentifierTable.cpp:271
clang::Selector::getNameForSlot
StringRef getNameForSlot(unsigned argIndex) const
Retrieve the name at a given position in the selector.
Definition: IdentifierTable.cpp:514
clang::OMF_retain
@ OMF_retain
Definition: IdentifierTable.h:710
OperatorKinds.h
clang::OMF_dealloc
@ OMF_dealloc
Definition: IdentifierTable.h:707
clang::OIT_Init
@ OIT_Init
Definition: IdentifierTable.h:735
getKeywordStatus
static KeywordStatus getKeywordStatus(const LangOptions &LangOpts, unsigned Flags)
Translates flags as specified in TokenKinds.def into keyword status in the given language standard.
Definition: IdentifierTable.cpp:130
clang::IdentifierInfo::setIsFutureCompatKeyword
void setIsFutureCompatKeyword(bool Val)
Definition: IdentifierTable.h:335
LangOptions.h
clang::ReservedIdentifierStatus
ReservedIdentifierStatus
Definition: IdentifierTable.h:43
clang::LargestBuiltinID
static constexpr uint64_t LargestBuiltinID
Definition: TargetBuiltins.h:339
clang::detail::DeclarationNameExtra
DeclarationNameExtra is used as a base of various uncommon special names.
Definition: IdentifierTable.h:952
clang::IdentifierInfo::getLength
unsigned getLength() const
Efficiently return the length of this identifier info.
Definition: IdentifierTable.h:192
AddKeyword
static void AddKeyword(StringRef Keyword, tok::TokenKind TokenCode, unsigned Flags, const LangOptions &LangOpts, IdentifierTable &Table)
AddKeyword - This method is used to associate a token ID with specific identifiers because they are l...
Definition: IdentifierTable.cpp:171
IdentifierTable.h
llvm::SmallString
Definition: LLVM.h:37
clang::SelectorTable
This table allows us to fully hide how we implement multi-keyword caching.
Definition: IdentifierTable.h:897
clang::IdentifierIterator
An iterator that walks over all of the known identifiers in the lookup table.
Definition: IdentifierTable.h:515
clang::IdentifierInfo::setObjCKeywordID
void setObjCKeywordID(tok::ObjCKeywordKind ID)
Definition: IdentifierTable.h:297
clang::NUM_OVERLOADED_OPERATORS
@ NUM_OVERLOADED_OPERATORS
Definition: OperatorKinds.h:26
clang::tok::ObjCKeywordKind
ObjCKeywordKind
Provides a namespace for Objective-C keywords which start with an '@'.
Definition: TokenKinds.h:41
clang::getOperatorSpelling
const char * getOperatorSpelling(OverloadedOperatorKind Operator)
Retrieve the spelling of the given overloaded operator, without the preceding "operator" keyword.
Definition: IdentifierTable.cpp:747
clang::SFF_NSString
@ SFF_NSString
Definition: IdentifierTable.h:741
clang::IdentifierInfo::setIsCPlusPlusOperatorKeyword
void setIsCPlusPlusOperatorKeyword(bool Val=true)
isCPlusPlusOperatorKeyword/setIsCPlusPlusOperatorKeyword controls whether this identifier is a C++ al...
Definition: IdentifierTable.h:358
clang::OMF_initialize
@ OMF_initialize
Definition: IdentifierTable.h:713
HASH
#define HASH(LEN, FIRST, THIRD)
getName
static std::string getName(const CallEvent &Call)
Definition: ReturnValueChecker.cpp:61
clang::OMF_self
@ OMF_self
Definition: IdentifierTable.h:712
clang::OverloadedOperatorKind
OverloadedOperatorKind
Enumeration specifying the different kinds of C++ overloaded operators.
Definition: OperatorKinds.h:21
clang::toUppercase
LLVM_READONLY char toUppercase(char c)
Converts the given ASCII character to its uppercase equivalent.
Definition: CharInfo.h:217
clang::IdentifierInfo::isKeyword
bool isKeyword(const LangOptions &LangOpts) const
Return true if this token is a keyword in the specified language.
Definition: IdentifierTable.cpp:259
clang::OMF_performSelector
@ OMF_performSelector
Definition: IdentifierTable.h:716
clang::OO_None
@ OO_None
Not an overloaded operator.
Definition: OperatorKinds.h:22
clang::tok::TokenKind
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
Definition: TokenKinds.h:25
clang::MultiKeywordSelector::Profile
static void Profile(llvm::FoldingSetNodeID &ID, keyword_iterator ArgTys, unsigned NumArgs)
Definition: IdentifierTable.cpp:463
P
StringRef P
Definition: ASTMatchersInternal.cpp:563
CharInfo.h
clang::getNullabilitySpelling
llvm::StringRef getNullabilitySpelling(NullabilityKind kind, bool isContextSensitive=false)
Retrieve the spelling of the given nullability kind.
Definition: IdentifierTable.cpp:761
getSelectorTableImpl
static SelectorTableImpl & getSelectorTableImpl(void *P)
Definition: IdentifierTable.cpp:681
dump
static void dump(llvm::raw_ostream &OS, StringRef FunctionName, ArrayRef< CounterExpression > Expressions, ArrayRef< CounterMappingRegion > Regions)
Definition: CoverageMappingGen.cpp:1533
llvm::ArrayRef
Definition: LLVM.h:34
clang::tok::PPKeywordKind
PPKeywordKind
Provides a namespace for preprocessor keywords which start with a '#' at the beginning of the line.
Definition: TokenKinds.h:33
clang::MultiKeywordSelector::keyword_begin
keyword_iterator keyword_begin() const
Definition: IdentifierTable.cpp:450
clang::IdentifierInfo::getPPKeywordID
tok::PPKeywordKind getPPKeywordID() const
Return the preprocessor keyword ID for this identifier.
Definition: IdentifierTable.cpp:324
clang::Selector::getIdentifierInfoForSlot
IdentifierInfo * getIdentifierInfoForSlot(unsigned argIndex) const
Retrieve the identifier at a given position in the selector.
Definition: IdentifierTable.cpp:503
TargetBuiltins.h
clang::IdentifierInfoLookup::~IdentifierInfoLookup
virtual ~IdentifierInfoLookup()
clang::IdentifierInfo
One of these records is kept for each identifier that is lexed.
Definition: IdentifierTable.h:84
clang::IdentifierTable::AddKeywords
void AddKeywords(const LangOptions &LangOpts)
Populate the identifier table with info about the language keywords for the language specified by Lan...
Definition: IdentifierTable.cpp:213
getTokenKwStatus
static KeywordStatus getTokenKwStatus(const LangOptions &LangOpts, tok::TokenKind K)
Checks if the specified token kind represents a keyword in the specified language.
Definition: IdentifierTable.cpp:247
clang::OMF_new
@ OMF_new
Definition: IdentifierTable.h:702
clang::LangOptions::isSYCL
bool isSYCL() const
Definition: LangOptions.h:592
clang::LangOptions
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:78
clang::IdentifierInfo::getNameStart
const char * getNameStart() const
Return the beginning of the actual null-terminated string for this identifier.
Definition: IdentifierTable.h:189
clang::SelectorTable::getUnarySelector
Selector getUnarySelector(IdentifierInfo *ID)
Definition: IdentifierTable.h:913
clang::NullabilityKind
NullabilityKind
Describes the nullability of a particular type.
Definition: Specifiers.h:317
clang::ObjCStringFormatFamily
ObjCStringFormatFamily
Definition: IdentifierTable.h:739
clang::MultiKeywordSelector
One of these variable length records is kept for each selector containing more than one keyword.
Definition: IdentifierTable.cpp:426
clang::IdentifierTable::IdentifierTable
IdentifierTable(IdentifierInfoLookup *ExternalLookup=nullptr)
Create the identifier table.
Definition: IdentifierTable.cpp:66
clang::IdentifierInfo::getName
StringRef getName() const
Return the actual identifier string.
Definition: IdentifierTable.h:195
clang::Builtin::ID
ID
Definition: Builtins.h:52
clang
Definition: CalledOnceCheck.h:17
clang::LangOptions::MSVC2015
@ MSVC2015
Definition: LangOptions.h:145
clang::Selector
Smart pointer class that efficiently represents Objective-C method names.
Definition: IdentifierTable.h:752
clang::IdentifierTable::PrintStats
void PrintStats() const
Print some statistics to stderr that indicate how well the hashing is doing.
Definition: IdentifierTable.cpp:383
endif
endif() if(clang_vc AND LLVM_APPEND_VC_REV) set(clang_source_dir $
Definition: CMakeLists.txt:15
clang::OMF_alloc
@ OMF_alloc
Definition: IdentifierTable.h:698
clang::OMF_mutableCopy
@ OMF_mutableCopy
Definition: IdentifierTable.h:701
clang::IdentifierTable
Implements an efficient mapping from strings to IdentifierInfo nodes.
Definition: IdentifierTable.h:563
clang::IdentifierInfoLookup
Provides lookups to, and iteration over, IdentiferInfo objects.
Definition: IdentifierTable.h:534
clang::MultiKeywordSelector::keyword_end
keyword_iterator keyword_end() const
Definition: IdentifierTable.cpp:454
clang::MultiKeywordSelector::MultiKeywordSelector
MultiKeywordSelector(unsigned nKeys, IdentifierInfo **IIV)
Definition: IdentifierTable.cpp:433
clang::SFF_None
@ SFF_None
Definition: IdentifierTable.h:740
clang::transformer::name
RangeSelector name(std::string ID)
Given a node with a "name", (like NamedDecl, DeclRefExpr, CxxCtorInitializer, and TypeLoc) selects th...
Definition: RangeSelector.cpp:200
clang::OIT_Singleton
@ OIT_Singleton
Definition: IdentifierTable.h:734
clang::diag::kind
unsigned kind
All of the diagnostics that can be emitted by the frontend.
Definition: DiagnosticIDs.h:62
clang::OIT_None
@ OIT_None
Definition: IdentifierTable.h:731
clang::ReservedIdentifierStatus::StartsWithDoubleUnderscore
@ StartsWithDoubleUnderscore
clang::IdentifierInfo::setIsExtensionToken
void setIsExtensionToken(bool Val)
Definition: IdentifierTable.h:321