clang  8.0.0svn
USRGeneration.cpp
Go to the documentation of this file.
1 //===- USRGeneration.cpp - Routines for USR generation --------------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
11 #include "clang/AST/ASTContext.h"
12 #include "clang/AST/DeclTemplate.h"
13 #include "clang/AST/DeclVisitor.h"
15 #include "llvm/Support/Path.h"
16 #include "llvm/Support/raw_ostream.h"
17 
18 using namespace clang;
19 using namespace clang::index;
20 
21 //===----------------------------------------------------------------------===//
22 // USR generation.
23 //===----------------------------------------------------------------------===//
24 
25 /// \returns true on error.
26 static bool printLoc(llvm::raw_ostream &OS, SourceLocation Loc,
27  const SourceManager &SM, bool IncludeOffset) {
28  if (Loc.isInvalid()) {
29  return true;
30  }
31  Loc = SM.getExpansionLoc(Loc);
32  const std::pair<FileID, unsigned> &Decomposed = SM.getDecomposedLoc(Loc);
33  const FileEntry *FE = SM.getFileEntryForID(Decomposed.first);
34  if (FE) {
35  OS << llvm::sys::path::filename(FE->getName());
36  } else {
37  // This case really isn't interesting.
38  return true;
39  }
40  if (IncludeOffset) {
41  // Use the offest into the FileID to represent the location. Using
42  // a line/column can cause us to look back at the original source file,
43  // which is expensive.
44  OS << '@' << Decomposed.second;
45  }
46  return false;
47 }
48 
49 static StringRef GetExternalSourceContainer(const NamedDecl *D) {
50  if (!D)
51  return StringRef();
52  if (auto *attr = D->getExternalSourceSymbolAttr()) {
53  return attr->getDefinedIn();
54  }
55  return StringRef();
56 }
57 
58 namespace {
59 class USRGenerator : public ConstDeclVisitor<USRGenerator> {
61  llvm::raw_svector_ostream Out;
62  bool IgnoreResults;
63  ASTContext *Context;
64  bool generatedLoc;
65 
66  llvm::DenseMap<const Type *, unsigned> TypeSubstitutions;
67 
68 public:
69  explicit USRGenerator(ASTContext *Ctx, SmallVectorImpl<char> &Buf)
70  : Buf(Buf),
71  Out(Buf),
72  IgnoreResults(false),
73  Context(Ctx),
74  generatedLoc(false)
75  {
76  // Add the USR space prefix.
77  Out << getUSRSpacePrefix();
78  }
79 
80  bool ignoreResults() const { return IgnoreResults; }
81 
82  // Visitation methods from generating USRs from AST elements.
83  void VisitDeclContext(const DeclContext *D);
84  void VisitFieldDecl(const FieldDecl *D);
85  void VisitFunctionDecl(const FunctionDecl *D);
86  void VisitNamedDecl(const NamedDecl *D);
87  void VisitNamespaceDecl(const NamespaceDecl *D);
88  void VisitNamespaceAliasDecl(const NamespaceAliasDecl *D);
89  void VisitFunctionTemplateDecl(const FunctionTemplateDecl *D);
90  void VisitClassTemplateDecl(const ClassTemplateDecl *D);
91  void VisitObjCContainerDecl(const ObjCContainerDecl *CD,
92  const ObjCCategoryDecl *CatD = nullptr);
93  void VisitObjCMethodDecl(const ObjCMethodDecl *MD);
94  void VisitObjCPropertyDecl(const ObjCPropertyDecl *D);
95  void VisitObjCPropertyImplDecl(const ObjCPropertyImplDecl *D);
96  void VisitTagDecl(const TagDecl *D);
97  void VisitTypedefDecl(const TypedefDecl *D);
98  void VisitTemplateTypeParmDecl(const TemplateTypeParmDecl *D);
99  void VisitVarDecl(const VarDecl *D);
100  void VisitBindingDecl(const BindingDecl *D);
101  void VisitNonTypeTemplateParmDecl(const NonTypeTemplateParmDecl *D);
102  void VisitTemplateTemplateParmDecl(const TemplateTemplateParmDecl *D);
103  void VisitUnresolvedUsingValueDecl(const UnresolvedUsingValueDecl *D);
104  void VisitUnresolvedUsingTypenameDecl(const UnresolvedUsingTypenameDecl *D);
105 
106  void VisitLinkageSpecDecl(const LinkageSpecDecl *D) {
107  IgnoreResults = true; // No USRs for linkage specs themselves.
108  }
109 
110  void VisitUsingDirectiveDecl(const UsingDirectiveDecl *D) {
111  IgnoreResults = true;
112  }
113 
114  void VisitUsingDecl(const UsingDecl *D) {
115  IgnoreResults = true;
116  }
117 
118  bool ShouldGenerateLocation(const NamedDecl *D);
119 
120  bool isLocal(const NamedDecl *D) {
121  return D->getParentFunctionOrMethod() != nullptr;
122  }
123 
124  void GenExtSymbolContainer(const NamedDecl *D);
125 
126  /// Generate the string component containing the location of the
127  /// declaration.
128  bool GenLoc(const Decl *D, bool IncludeOffset);
129 
130  /// String generation methods used both by the visitation methods
131  /// and from other clients that want to directly generate USRs. These
132  /// methods do not construct complete USRs (which incorporate the parents
133  /// of an AST element), but only the fragments concerning the AST element
134  /// itself.
135 
136  /// Generate a USR for an Objective-C class.
137  void GenObjCClass(StringRef cls, StringRef ExtSymDefinedIn,
138  StringRef CategoryContextExtSymbolDefinedIn) {
139  generateUSRForObjCClass(cls, Out, ExtSymDefinedIn,
140  CategoryContextExtSymbolDefinedIn);
141  }
142 
143  /// Generate a USR for an Objective-C class category.
144  void GenObjCCategory(StringRef cls, StringRef cat,
145  StringRef clsExt, StringRef catExt) {
146  generateUSRForObjCCategory(cls, cat, Out, clsExt, catExt);
147  }
148 
149  /// Generate a USR fragment for an Objective-C property.
150  void GenObjCProperty(StringRef prop, bool isClassProp) {
151  generateUSRForObjCProperty(prop, isClassProp, Out);
152  }
153 
154  /// Generate a USR for an Objective-C protocol.
155  void GenObjCProtocol(StringRef prot, StringRef ext) {
156  generateUSRForObjCProtocol(prot, Out, ext);
157  }
158 
159  void VisitType(QualType T);
160  void VisitTemplateParameterList(const TemplateParameterList *Params);
161  void VisitTemplateName(TemplateName Name);
162  void VisitTemplateArgument(const TemplateArgument &Arg);
163 
164  /// Emit a Decl's name using NamedDecl::printName() and return true if
165  /// the decl had no name.
166  bool EmitDeclName(const NamedDecl *D);
167 };
168 } // end anonymous namespace
169 
170 //===----------------------------------------------------------------------===//
171 // Generating USRs from ASTS.
172 //===----------------------------------------------------------------------===//
173 
174 bool USRGenerator::EmitDeclName(const NamedDecl *D) {
175  const unsigned startSize = Buf.size();
176  D->printName(Out);
177  const unsigned endSize = Buf.size();
178  return startSize == endSize;
179 }
180 
181 bool USRGenerator::ShouldGenerateLocation(const NamedDecl *D) {
182  if (D->isExternallyVisible())
183  return false;
184  if (D->getParentFunctionOrMethod())
185  return true;
186  SourceLocation Loc = D->getLocation();
187  if (Loc.isInvalid())
188  return false;
189  const SourceManager &SM = Context->getSourceManager();
190  return !SM.isInSystemHeader(Loc);
191 }
192 
193 void USRGenerator::VisitDeclContext(const DeclContext *DC) {
194  if (const NamedDecl *D = dyn_cast<NamedDecl>(DC))
195  Visit(D);
196  else if (isa<LinkageSpecDecl>(DC)) // Linkage specs are transparent in USRs.
197  VisitDeclContext(DC->getParent());
198 }
199 
200 void USRGenerator::VisitFieldDecl(const FieldDecl *D) {
201  // The USR for an ivar declared in a class extension is based on the
202  // ObjCInterfaceDecl, not the ObjCCategoryDecl.
203  if (const ObjCInterfaceDecl *ID = Context->getObjContainingInterface(D))
204  Visit(ID);
205  else
206  VisitDeclContext(D->getDeclContext());
207  Out << (isa<ObjCIvarDecl>(D) ? "@" : "@FI@");
208  if (EmitDeclName(D)) {
209  // Bit fields can be anonymous.
210  IgnoreResults = true;
211  return;
212  }
213 }
214 
215 void USRGenerator::VisitFunctionDecl(const FunctionDecl *D) {
216  if (ShouldGenerateLocation(D) && GenLoc(D, /*IncludeOffset=*/isLocal(D)))
217  return;
218 
219  const unsigned StartSize = Buf.size();
220  VisitDeclContext(D->getDeclContext());
221  if (Buf.size() == StartSize)
222  GenExtSymbolContainer(D);
223 
224  bool IsTemplate = false;
226  IsTemplate = true;
227  Out << "@FT@";
228  VisitTemplateParameterList(FunTmpl->getTemplateParameters());
229  } else
230  Out << "@F@";
231 
232  PrintingPolicy Policy(Context->getLangOpts());
233  // Forward references can have different template argument names. Suppress the
234  // template argument names in constructors to make their USR more stable.
236  D->getDeclName().print(Out, Policy);
237 
238  ASTContext &Ctx = *Context;
239  if ((!Ctx.getLangOpts().CPlusPlus || D->isExternC()) &&
240  !D->hasAttr<OverloadableAttr>())
241  return;
242 
243  if (const TemplateArgumentList *
244  SpecArgs = D->getTemplateSpecializationArgs()) {
245  Out << '<';
246  for (unsigned I = 0, N = SpecArgs->size(); I != N; ++I) {
247  Out << '#';
248  VisitTemplateArgument(SpecArgs->get(I));
249  }
250  Out << '>';
251  }
252 
253  // Mangle in type information for the arguments.
254  for (auto PD : D->parameters()) {
255  Out << '#';
256  VisitType(PD->getType());
257  }
258  if (D->isVariadic())
259  Out << '.';
260  if (IsTemplate) {
261  // Function templates can be overloaded by return type, for example:
262  // \code
263  // template <class T> typename T::A foo() {}
264  // template <class T> typename T::B foo() {}
265  // \endcode
266  Out << '#';
267  VisitType(D->getReturnType());
268  }
269  Out << '#';
270  if (const CXXMethodDecl *MD = dyn_cast<CXXMethodDecl>(D)) {
271  if (MD->isStatic())
272  Out << 'S';
273  if (unsigned quals = MD->getTypeQualifiers())
274  Out << (char)('0' + quals);
275  switch (MD->getRefQualifier()) {
276  case RQ_None: break;
277  case RQ_LValue: Out << '&'; break;
278  case RQ_RValue: Out << "&&"; break;
279  }
280  }
281 }
282 
283 void USRGenerator::VisitNamedDecl(const NamedDecl *D) {
284  VisitDeclContext(D->getDeclContext());
285  Out << "@";
286 
287  if (EmitDeclName(D)) {
288  // The string can be empty if the declaration has no name; e.g., it is
289  // the ParmDecl with no name for declaration of a function pointer type,
290  // e.g.: void (*f)(void *);
291  // In this case, don't generate a USR.
292  IgnoreResults = true;
293  }
294 }
295 
296 void USRGenerator::VisitVarDecl(const VarDecl *D) {
297  // VarDecls can be declared 'extern' within a function or method body,
298  // but their enclosing DeclContext is the function, not the TU. We need
299  // to check the storage class to correctly generate the USR.
300  if (ShouldGenerateLocation(D) && GenLoc(D, /*IncludeOffset=*/isLocal(D)))
301  return;
302 
303  VisitDeclContext(D->getDeclContext());
304 
305  if (VarTemplateDecl *VarTmpl = D->getDescribedVarTemplate()) {
306  Out << "@VT";
307  VisitTemplateParameterList(VarTmpl->getTemplateParameters());
308  } else if (const VarTemplatePartialSpecializationDecl *PartialSpec
309  = dyn_cast<VarTemplatePartialSpecializationDecl>(D)) {
310  Out << "@VP";
311  VisitTemplateParameterList(PartialSpec->getTemplateParameters());
312  }
313 
314  // Variables always have simple names.
315  StringRef s = D->getName();
316 
317  // The string can be empty if the declaration has no name; e.g., it is
318  // the ParmDecl with no name for declaration of a function pointer type, e.g.:
319  // void (*f)(void *);
320  // In this case, don't generate a USR.
321  if (s.empty())
322  IgnoreResults = true;
323  else
324  Out << '@' << s;
325 
326  // For a template specialization, mangle the template arguments.
327  if (const VarTemplateSpecializationDecl *Spec
328  = dyn_cast<VarTemplateSpecializationDecl>(D)) {
329  const TemplateArgumentList &Args = Spec->getTemplateArgs();
330  Out << '>';
331  for (unsigned I = 0, N = Args.size(); I != N; ++I) {
332  Out << '#';
333  VisitTemplateArgument(Args.get(I));
334  }
335  }
336 }
337 
338 void USRGenerator::VisitBindingDecl(const BindingDecl *D) {
339  if (isLocal(D) && GenLoc(D, /*IncludeOffset=*/true))
340  return;
341  VisitNamedDecl(D);
342 }
343 
344 void USRGenerator::VisitNonTypeTemplateParmDecl(
345  const NonTypeTemplateParmDecl *D) {
346  GenLoc(D, /*IncludeOffset=*/true);
347 }
348 
349 void USRGenerator::VisitTemplateTemplateParmDecl(
350  const TemplateTemplateParmDecl *D) {
351  GenLoc(D, /*IncludeOffset=*/true);
352 }
353 
354 void USRGenerator::VisitNamespaceDecl(const NamespaceDecl *D) {
355  if (D->isAnonymousNamespace()) {
356  Out << "@aN";
357  return;
358  }
359 
360  VisitDeclContext(D->getDeclContext());
361  if (!IgnoreResults)
362  Out << "@N@" << D->getName();
363 }
364 
365 void USRGenerator::VisitFunctionTemplateDecl(const FunctionTemplateDecl *D) {
366  VisitFunctionDecl(D->getTemplatedDecl());
367 }
368 
369 void USRGenerator::VisitClassTemplateDecl(const ClassTemplateDecl *D) {
370  VisitTagDecl(D->getTemplatedDecl());
371 }
372 
373 void USRGenerator::VisitNamespaceAliasDecl(const NamespaceAliasDecl *D) {
374  VisitDeclContext(D->getDeclContext());
375  if (!IgnoreResults)
376  Out << "@NA@" << D->getName();
377 }
378 
379 void USRGenerator::VisitObjCMethodDecl(const ObjCMethodDecl *D) {
380  const DeclContext *container = D->getDeclContext();
381  if (const ObjCProtocolDecl *pd = dyn_cast<ObjCProtocolDecl>(container)) {
382  Visit(pd);
383  }
384  else {
385  // The USR for a method declared in a class extension or category is based on
386  // the ObjCInterfaceDecl, not the ObjCCategoryDecl.
387  const ObjCInterfaceDecl *ID = D->getClassInterface();
388  if (!ID) {
389  IgnoreResults = true;
390  return;
391  }
392  auto getCategoryContext = [](const ObjCMethodDecl *D) ->
393  const ObjCCategoryDecl * {
394  if (auto *CD = dyn_cast<ObjCCategoryDecl>(D->getDeclContext()))
395  return CD;
396  if (auto *ICD = dyn_cast<ObjCCategoryImplDecl>(D->getDeclContext()))
397  return ICD->getCategoryDecl();
398  return nullptr;
399  };
400  auto *CD = getCategoryContext(D);
401  VisitObjCContainerDecl(ID, CD);
402  }
403  // Ideally we would use 'GenObjCMethod', but this is such a hot path
404  // for Objective-C code that we don't want to use
405  // DeclarationName::getAsString().
406  Out << (D->isInstanceMethod() ? "(im)" : "(cm)")
407  << DeclarationName(D->getSelector());
408 }
409 
410 void USRGenerator::VisitObjCContainerDecl(const ObjCContainerDecl *D,
411  const ObjCCategoryDecl *CatD) {
412  switch (D->getKind()) {
413  default:
414  llvm_unreachable("Invalid ObjC container.");
415  case Decl::ObjCInterface:
416  case Decl::ObjCImplementation:
417  GenObjCClass(D->getName(), GetExternalSourceContainer(D),
419  break;
420  case Decl::ObjCCategory: {
421  const ObjCCategoryDecl *CD = cast<ObjCCategoryDecl>(D);
422  const ObjCInterfaceDecl *ID = CD->getClassInterface();
423  if (!ID) {
424  // Handle invalid code where the @interface might not
425  // have been specified.
426  // FIXME: We should be able to generate this USR even if the
427  // @interface isn't available.
428  IgnoreResults = true;
429  return;
430  }
431  // Specially handle class extensions, which are anonymous categories.
432  // We want to mangle in the location to uniquely distinguish them.
433  if (CD->IsClassExtension()) {
434  Out << "objc(ext)" << ID->getName() << '@';
435  GenLoc(CD, /*IncludeOffset=*/true);
436  }
437  else
438  GenObjCCategory(ID->getName(), CD->getName(),
441 
442  break;
443  }
444  case Decl::ObjCCategoryImpl: {
445  const ObjCCategoryImplDecl *CD = cast<ObjCCategoryImplDecl>(D);
446  const ObjCInterfaceDecl *ID = CD->getClassInterface();
447  if (!ID) {
448  // Handle invalid code where the @interface might not
449  // have been specified.
450  // FIXME: We should be able to generate this USR even if the
451  // @interface isn't available.
452  IgnoreResults = true;
453  return;
454  }
455  GenObjCCategory(ID->getName(), CD->getName(),
458  break;
459  }
460  case Decl::ObjCProtocol: {
461  const ObjCProtocolDecl *PD = cast<ObjCProtocolDecl>(D);
462  GenObjCProtocol(PD->getName(), GetExternalSourceContainer(PD));
463  break;
464  }
465  }
466 }
467 
468 void USRGenerator::VisitObjCPropertyDecl(const ObjCPropertyDecl *D) {
469  // The USR for a property declared in a class extension or category is based
470  // on the ObjCInterfaceDecl, not the ObjCCategoryDecl.
471  if (const ObjCInterfaceDecl *ID = Context->getObjContainingInterface(D))
472  Visit(ID);
473  else
474  Visit(cast<Decl>(D->getDeclContext()));
475  GenObjCProperty(D->getName(), D->isClassProperty());
476 }
477 
478 void USRGenerator::VisitObjCPropertyImplDecl(const ObjCPropertyImplDecl *D) {
479  if (ObjCPropertyDecl *PD = D->getPropertyDecl()) {
480  VisitObjCPropertyDecl(PD);
481  return;
482  }
483 
484  IgnoreResults = true;
485 }
486 
487 void USRGenerator::VisitTagDecl(const TagDecl *D) {
488  // Add the location of the tag decl to handle resolution across
489  // translation units.
490  if (!isa<EnumDecl>(D) &&
491  ShouldGenerateLocation(D) && GenLoc(D, /*IncludeOffset=*/isLocal(D)))
492  return;
493 
494  GenExtSymbolContainer(D);
495 
496  D = D->getCanonicalDecl();
497  VisitDeclContext(D->getDeclContext());
498 
499  bool AlreadyStarted = false;
500  if (const CXXRecordDecl *CXXRecord = dyn_cast<CXXRecordDecl>(D)) {
501  if (ClassTemplateDecl *ClassTmpl = CXXRecord->getDescribedClassTemplate()) {
502  AlreadyStarted = true;
503 
504  switch (D->getTagKind()) {
505  case TTK_Interface:
506  case TTK_Class:
507  case TTK_Struct: Out << "@ST"; break;
508  case TTK_Union: Out << "@UT"; break;
509  case TTK_Enum: llvm_unreachable("enum template");
510  }
511  VisitTemplateParameterList(ClassTmpl->getTemplateParameters());
512  } else if (const ClassTemplatePartialSpecializationDecl *PartialSpec
513  = dyn_cast<ClassTemplatePartialSpecializationDecl>(CXXRecord)) {
514  AlreadyStarted = true;
515 
516  switch (D->getTagKind()) {
517  case TTK_Interface:
518  case TTK_Class:
519  case TTK_Struct: Out << "@SP"; break;
520  case TTK_Union: Out << "@UP"; break;
521  case TTK_Enum: llvm_unreachable("enum partial specialization");
522  }
523  VisitTemplateParameterList(PartialSpec->getTemplateParameters());
524  }
525  }
526 
527  if (!AlreadyStarted) {
528  switch (D->getTagKind()) {
529  case TTK_Interface:
530  case TTK_Class:
531  case TTK_Struct: Out << "@S"; break;
532  case TTK_Union: Out << "@U"; break;
533  case TTK_Enum: Out << "@E"; break;
534  }
535  }
536 
537  Out << '@';
538  assert(Buf.size() > 0);
539  const unsigned off = Buf.size() - 1;
540 
541  if (EmitDeclName(D)) {
542  if (const TypedefNameDecl *TD = D->getTypedefNameForAnonDecl()) {
543  Buf[off] = 'A';
544  Out << '@' << *TD;
545  }
546  else {
547  if (D->isEmbeddedInDeclarator() && !D->isFreeStanding()) {
548  printLoc(Out, D->getLocation(), Context->getSourceManager(), true);
549  } else {
550  Buf[off] = 'a';
551  if (auto *ED = dyn_cast<EnumDecl>(D)) {
552  // Distinguish USRs of anonymous enums by using their first enumerator.
553  auto enum_range = ED->enumerators();
554  if (enum_range.begin() != enum_range.end()) {
555  Out << '@' << **enum_range.begin();
556  }
557  }
558  }
559  }
560  }
561 
562  // For a class template specialization, mangle the template arguments.
563  if (const ClassTemplateSpecializationDecl *Spec
564  = dyn_cast<ClassTemplateSpecializationDecl>(D)) {
565  const TemplateArgumentList &Args = Spec->getTemplateArgs();
566  Out << '>';
567  for (unsigned I = 0, N = Args.size(); I != N; ++I) {
568  Out << '#';
569  VisitTemplateArgument(Args.get(I));
570  }
571  }
572 }
573 
574 void USRGenerator::VisitTypedefDecl(const TypedefDecl *D) {
575  if (ShouldGenerateLocation(D) && GenLoc(D, /*IncludeOffset=*/isLocal(D)))
576  return;
577  const DeclContext *DC = D->getDeclContext();
578  if (const NamedDecl *DCN = dyn_cast<NamedDecl>(DC))
579  Visit(DCN);
580  Out << "@T@";
581  Out << D->getName();
582 }
583 
584 void USRGenerator::VisitTemplateTypeParmDecl(const TemplateTypeParmDecl *D) {
585  GenLoc(D, /*IncludeOffset=*/true);
586 }
587 
588 void USRGenerator::GenExtSymbolContainer(const NamedDecl *D) {
589  StringRef Container = GetExternalSourceContainer(D);
590  if (!Container.empty())
591  Out << "@M@" << Container;
592 }
593 
594 bool USRGenerator::GenLoc(const Decl *D, bool IncludeOffset) {
595  if (generatedLoc)
596  return IgnoreResults;
597  generatedLoc = true;
598 
599  // Guard against null declarations in invalid code.
600  if (!D) {
601  IgnoreResults = true;
602  return true;
603  }
604 
605  // Use the location of canonical decl.
606  D = D->getCanonicalDecl();
607 
608  IgnoreResults =
609  IgnoreResults || printLoc(Out, D->getBeginLoc(),
610  Context->getSourceManager(), IncludeOffset);
611 
612  return IgnoreResults;
613 }
614 
615 static void printQualifier(llvm::raw_ostream &Out, ASTContext &Ctx, NestedNameSpecifier *NNS) {
616  // FIXME: Encode the qualifier, don't just print it.
617  PrintingPolicy PO(Ctx.getLangOpts());
618  PO.SuppressTagKeyword = true;
619  PO.SuppressUnwrittenScope = true;
620  PO.ConstantArraySizeAsWritten = false;
621  PO.AnonymousTagLocations = false;
622  NNS->print(Out, PO);
623 }
624 
625 void USRGenerator::VisitType(QualType T) {
626  // This method mangles in USR information for types. It can possibly
627  // just reuse the naming-mangling logic used by codegen, although the
628  // requirements for USRs might not be the same.
629  ASTContext &Ctx = *Context;
630 
631  do {
632  T = Ctx.getCanonicalType(T);
633  Qualifiers Q = T.getQualifiers();
634  unsigned qVal = 0;
635  if (Q.hasConst())
636  qVal |= 0x1;
637  if (Q.hasVolatile())
638  qVal |= 0x2;
639  if (Q.hasRestrict())
640  qVal |= 0x4;
641  if(qVal)
642  Out << ((char) ('0' + qVal));
643 
644  // Mangle in ObjC GC qualifiers?
645 
646  if (const PackExpansionType *Expansion = T->getAs<PackExpansionType>()) {
647  Out << 'P';
648  T = Expansion->getPattern();
649  }
650 
651  if (const BuiltinType *BT = T->getAs<BuiltinType>()) {
652  unsigned char c = '\0';
653  switch (BT->getKind()) {
654  case BuiltinType::Void:
655  c = 'v'; break;
656  case BuiltinType::Bool:
657  c = 'b'; break;
658  case BuiltinType::UChar:
659  c = 'c'; break;
660  case BuiltinType::Char8:
661  c = 'u'; break; // FIXME: Check this doesn't collide
662  case BuiltinType::Char16:
663  c = 'q'; break;
664  case BuiltinType::Char32:
665  c = 'w'; break;
666  case BuiltinType::UShort:
667  c = 's'; break;
668  case BuiltinType::UInt:
669  c = 'i'; break;
670  case BuiltinType::ULong:
671  c = 'l'; break;
672  case BuiltinType::ULongLong:
673  c = 'k'; break;
674  case BuiltinType::UInt128:
675  c = 'j'; break;
676  case BuiltinType::Char_U:
677  case BuiltinType::Char_S:
678  c = 'C'; break;
679  case BuiltinType::SChar:
680  c = 'r'; break;
681  case BuiltinType::WChar_S:
682  case BuiltinType::WChar_U:
683  c = 'W'; break;
684  case BuiltinType::Short:
685  c = 'S'; break;
686  case BuiltinType::Int:
687  c = 'I'; break;
688  case BuiltinType::Long:
689  c = 'L'; break;
690  case BuiltinType::LongLong:
691  c = 'K'; break;
692  case BuiltinType::Int128:
693  c = 'J'; break;
694  case BuiltinType::Float16:
695  case BuiltinType::Half:
696  c = 'h'; break;
697  case BuiltinType::Float:
698  c = 'f'; break;
699  case BuiltinType::Double:
700  c = 'd'; break;
701  case BuiltinType::LongDouble:
702  c = 'D'; break;
703  case BuiltinType::Float128:
704  c = 'Q'; break;
705  case BuiltinType::NullPtr:
706  c = 'n'; break;
707 #define BUILTIN_TYPE(Id, SingletonId)
708 #define PLACEHOLDER_TYPE(Id, SingletonId) case BuiltinType::Id:
709 #include "clang/AST/BuiltinTypes.def"
710  case BuiltinType::Dependent:
711 #define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
712  case BuiltinType::Id:
713 #include "clang/Basic/OpenCLImageTypes.def"
714 #define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
715  case BuiltinType::Id:
716 #include "clang/Basic/OpenCLExtensionTypes.def"
717  case BuiltinType::OCLEvent:
718  case BuiltinType::OCLClkEvent:
719  case BuiltinType::OCLQueue:
720  case BuiltinType::OCLReserveID:
721  case BuiltinType::OCLSampler:
722  case BuiltinType::ShortAccum:
723  case BuiltinType::Accum:
724  case BuiltinType::LongAccum:
725  case BuiltinType::UShortAccum:
726  case BuiltinType::UAccum:
727  case BuiltinType::ULongAccum:
728  case BuiltinType::ShortFract:
729  case BuiltinType::Fract:
730  case BuiltinType::LongFract:
731  case BuiltinType::UShortFract:
732  case BuiltinType::UFract:
733  case BuiltinType::ULongFract:
734  case BuiltinType::SatShortAccum:
735  case BuiltinType::SatAccum:
736  case BuiltinType::SatLongAccum:
737  case BuiltinType::SatUShortAccum:
738  case BuiltinType::SatUAccum:
739  case BuiltinType::SatULongAccum:
740  case BuiltinType::SatShortFract:
741  case BuiltinType::SatFract:
742  case BuiltinType::SatLongFract:
743  case BuiltinType::SatUShortFract:
744  case BuiltinType::SatUFract:
745  case BuiltinType::SatULongFract:
746  IgnoreResults = true;
747  return;
748  case BuiltinType::ObjCId:
749  c = 'o'; break;
750  case BuiltinType::ObjCClass:
751  c = 'O'; break;
752  case BuiltinType::ObjCSel:
753  c = 'e'; break;
754  }
755  Out << c;
756  return;
757  }
758 
759  // If we have already seen this (non-built-in) type, use a substitution
760  // encoding.
761  llvm::DenseMap<const Type *, unsigned>::iterator Substitution
762  = TypeSubstitutions.find(T.getTypePtr());
763  if (Substitution != TypeSubstitutions.end()) {
764  Out << 'S' << Substitution->second << '_';
765  return;
766  } else {
767  // Record this as a substitution.
768  unsigned Number = TypeSubstitutions.size();
769  TypeSubstitutions[T.getTypePtr()] = Number;
770  }
771 
772  if (const PointerType *PT = T->getAs<PointerType>()) {
773  Out << '*';
774  T = PT->getPointeeType();
775  continue;
776  }
777  if (const ObjCObjectPointerType *OPT = T->getAs<ObjCObjectPointerType>()) {
778  Out << '*';
779  T = OPT->getPointeeType();
780  continue;
781  }
782  if (const RValueReferenceType *RT = T->getAs<RValueReferenceType>()) {
783  Out << "&&";
784  T = RT->getPointeeType();
785  continue;
786  }
787  if (const ReferenceType *RT = T->getAs<ReferenceType>()) {
788  Out << '&';
789  T = RT->getPointeeType();
790  continue;
791  }
792  if (const FunctionProtoType *FT = T->getAs<FunctionProtoType>()) {
793  Out << 'F';
794  VisitType(FT->getReturnType());
795  Out << '(';
796  for (const auto &I : FT->param_types()) {
797  Out << '#';
798  VisitType(I);
799  }
800  Out << ')';
801  if (FT->isVariadic())
802  Out << '.';
803  return;
804  }
805  if (const BlockPointerType *BT = T->getAs<BlockPointerType>()) {
806  Out << 'B';
807  T = BT->getPointeeType();
808  continue;
809  }
810  if (const ComplexType *CT = T->getAs<ComplexType>()) {
811  Out << '<';
812  T = CT->getElementType();
813  continue;
814  }
815  if (const TagType *TT = T->getAs<TagType>()) {
816  Out << '$';
817  VisitTagDecl(TT->getDecl());
818  return;
819  }
820  if (const ObjCInterfaceType *OIT = T->getAs<ObjCInterfaceType>()) {
821  Out << '$';
822  VisitObjCInterfaceDecl(OIT->getDecl());
823  return;
824  }
825  if (const ObjCObjectType *OIT = T->getAs<ObjCObjectType>()) {
826  Out << 'Q';
827  VisitType(OIT->getBaseType());
828  for (auto *Prot : OIT->getProtocols())
829  VisitObjCProtocolDecl(Prot);
830  return;
831  }
832  if (const TemplateTypeParmType *TTP = T->getAs<TemplateTypeParmType>()) {
833  Out << 't' << TTP->getDepth() << '.' << TTP->getIndex();
834  return;
835  }
836  if (const TemplateSpecializationType *Spec
838  Out << '>';
839  VisitTemplateName(Spec->getTemplateName());
840  Out << Spec->getNumArgs();
841  for (unsigned I = 0, N = Spec->getNumArgs(); I != N; ++I)
842  VisitTemplateArgument(Spec->getArg(I));
843  return;
844  }
845  if (const DependentNameType *DNT = T->getAs<DependentNameType>()) {
846  Out << '^';
847  printQualifier(Out, Ctx, DNT->getQualifier());
848  Out << ':' << DNT->getIdentifier()->getName();
849  return;
850  }
851  if (const InjectedClassNameType *InjT = T->getAs<InjectedClassNameType>()) {
852  T = InjT->getInjectedSpecializationType();
853  continue;
854  }
855  if (const auto *VT = T->getAs<VectorType>()) {
856  Out << (T->isExtVectorType() ? ']' : '[');
857  Out << VT->getNumElements();
858  T = VT->getElementType();
859  continue;
860  }
861  if (const auto *const AT = dyn_cast<ArrayType>(T)) {
862  Out << '{';
863  switch (AT->getSizeModifier()) {
864  case ArrayType::Static:
865  Out << 's';
866  break;
867  case ArrayType::Star:
868  Out << '*';
869  break;
870  case ArrayType::Normal:
871  Out << 'n';
872  break;
873  }
874  if (const auto *const CAT = dyn_cast<ConstantArrayType>(T))
875  Out << CAT->getSize();
876 
877  T = AT->getElementType();
878  continue;
879  }
880 
881  // Unhandled type.
882  Out << ' ';
883  break;
884  } while (true);
885 }
886 
887 void USRGenerator::VisitTemplateParameterList(
888  const TemplateParameterList *Params) {
889  if (!Params)
890  return;
891  Out << '>' << Params->size();
892  for (TemplateParameterList::const_iterator P = Params->begin(),
893  PEnd = Params->end();
894  P != PEnd; ++P) {
895  Out << '#';
896  if (isa<TemplateTypeParmDecl>(*P)) {
897  if (cast<TemplateTypeParmDecl>(*P)->isParameterPack())
898  Out<< 'p';
899  Out << 'T';
900  continue;
901  }
902 
903  if (NonTypeTemplateParmDecl *NTTP = dyn_cast<NonTypeTemplateParmDecl>(*P)) {
904  if (NTTP->isParameterPack())
905  Out << 'p';
906  Out << 'N';
907  VisitType(NTTP->getType());
908  continue;
909  }
910 
911  TemplateTemplateParmDecl *TTP = cast<TemplateTemplateParmDecl>(*P);
912  if (TTP->isParameterPack())
913  Out << 'p';
914  Out << 't';
915  VisitTemplateParameterList(TTP->getTemplateParameters());
916  }
917 }
918 
919 void USRGenerator::VisitTemplateName(TemplateName Name) {
920  if (TemplateDecl *Template = Name.getAsTemplateDecl()) {
921  if (TemplateTemplateParmDecl *TTP
922  = dyn_cast<TemplateTemplateParmDecl>(Template)) {
923  Out << 't' << TTP->getDepth() << '.' << TTP->getIndex();
924  return;
925  }
926 
927  Visit(Template);
928  return;
929  }
930 
931  // FIXME: Visit dependent template names.
932 }
933 
934 void USRGenerator::VisitTemplateArgument(const TemplateArgument &Arg) {
935  switch (Arg.getKind()) {
936  case TemplateArgument::Null:
937  break;
938 
939  case TemplateArgument::Declaration:
940  Visit(Arg.getAsDecl());
941  break;
942 
943  case TemplateArgument::NullPtr:
944  break;
945 
946  case TemplateArgument::TemplateExpansion:
947  Out << 'P'; // pack expansion of...
948  LLVM_FALLTHROUGH;
949  case TemplateArgument::Template:
950  VisitTemplateName(Arg.getAsTemplateOrTemplatePattern());
951  break;
952 
953  case TemplateArgument::Expression:
954  // FIXME: Visit expressions.
955  break;
956 
957  case TemplateArgument::Pack:
958  Out << 'p' << Arg.pack_size();
959  for (const auto &P : Arg.pack_elements())
960  VisitTemplateArgument(P);
961  break;
962 
963  case TemplateArgument::Type:
964  VisitType(Arg.getAsType());
965  break;
966 
967  case TemplateArgument::Integral:
968  Out << 'V';
969  VisitType(Arg.getIntegralType());
970  Out << Arg.getAsIntegral();
971  break;
972  }
973 }
974 
975 void USRGenerator::VisitUnresolvedUsingValueDecl(const UnresolvedUsingValueDecl *D) {
976  if (ShouldGenerateLocation(D) && GenLoc(D, /*IncludeOffset=*/isLocal(D)))
977  return;
978  VisitDeclContext(D->getDeclContext());
979  Out << "@UUV@";
980  printQualifier(Out, D->getASTContext(), D->getQualifier());
981  EmitDeclName(D);
982 }
983 
984 void USRGenerator::VisitUnresolvedUsingTypenameDecl(const UnresolvedUsingTypenameDecl *D) {
985  if (ShouldGenerateLocation(D) && GenLoc(D, /*IncludeOffset=*/isLocal(D)))
986  return;
987  VisitDeclContext(D->getDeclContext());
988  Out << "@UUT@";
989  printQualifier(Out, D->getASTContext(), D->getQualifier());
990  Out << D->getName(); // Simple name.
991 }
992 
993 
994 
995 //===----------------------------------------------------------------------===//
996 // USR generation functions.
997 //===----------------------------------------------------------------------===//
998 
999 static void combineClassAndCategoryExtContainers(StringRef ClsSymDefinedIn,
1000  StringRef CatSymDefinedIn,
1001  raw_ostream &OS) {
1002  if (ClsSymDefinedIn.empty() && CatSymDefinedIn.empty())
1003  return;
1004  if (CatSymDefinedIn.empty()) {
1005  OS << "@M@" << ClsSymDefinedIn << '@';
1006  return;
1007  }
1008  OS << "@CM@" << CatSymDefinedIn << '@';
1009  if (ClsSymDefinedIn != CatSymDefinedIn) {
1010  OS << ClsSymDefinedIn << '@';
1011  }
1012 }
1013 
1014 void clang::index::generateUSRForObjCClass(StringRef Cls, raw_ostream &OS,
1015  StringRef ExtSymDefinedIn,
1016  StringRef CategoryContextExtSymbolDefinedIn) {
1017  combineClassAndCategoryExtContainers(ExtSymDefinedIn,
1018  CategoryContextExtSymbolDefinedIn, OS);
1019  OS << "objc(cs)" << Cls;
1020 }
1021 
1022 void clang::index::generateUSRForObjCCategory(StringRef Cls, StringRef Cat,
1023  raw_ostream &OS,
1024  StringRef ClsSymDefinedIn,
1025  StringRef CatSymDefinedIn) {
1026  combineClassAndCategoryExtContainers(ClsSymDefinedIn, CatSymDefinedIn, OS);
1027  OS << "objc(cy)" << Cls << '@' << Cat;
1028 }
1029 
1030 void clang::index::generateUSRForObjCIvar(StringRef Ivar, raw_ostream &OS) {
1031  OS << '@' << Ivar;
1032 }
1033 
1034 void clang::index::generateUSRForObjCMethod(StringRef Sel,
1035  bool IsInstanceMethod,
1036  raw_ostream &OS) {
1037  OS << (IsInstanceMethod ? "(im)" : "(cm)") << Sel;
1038 }
1039 
1040 void clang::index::generateUSRForObjCProperty(StringRef Prop, bool isClassProp,
1041  raw_ostream &OS) {
1042  OS << (isClassProp ? "(cpy)" : "(py)") << Prop;
1043 }
1044 
1045 void clang::index::generateUSRForObjCProtocol(StringRef Prot, raw_ostream &OS,
1046  StringRef ExtSymDefinedIn) {
1047  if (!ExtSymDefinedIn.empty())
1048  OS << "@M@" << ExtSymDefinedIn << '@';
1049  OS << "objc(pl)" << Prot;
1050 }
1051 
1052 void clang::index::generateUSRForGlobalEnum(StringRef EnumName, raw_ostream &OS,
1053  StringRef ExtSymDefinedIn) {
1054  if (!ExtSymDefinedIn.empty())
1055  OS << "@M@" << ExtSymDefinedIn;
1056  OS << "@E@" << EnumName;
1057 }
1058 
1059 void clang::index::generateUSRForEnumConstant(StringRef EnumConstantName,
1060  raw_ostream &OS) {
1061  OS << '@' << EnumConstantName;
1062 }
1063 
1064 bool clang::index::generateUSRForDecl(const Decl *D,
1065  SmallVectorImpl<char> &Buf) {
1066  if (!D)
1067  return true;
1068  // We don't ignore decls with invalid source locations. Implicit decls, like
1069  // C++'s operator new function, can have invalid locations but it is fine to
1070  // create USRs that can identify them.
1071 
1072  USRGenerator UG(&D->getASTContext(), Buf);
1073  UG.Visit(D);
1074  return UG.ignoreResults();
1075 }
1076 
1078  const SourceManager &SM,
1079  SmallVectorImpl<char> &Buf) {
1080  if (!MD)
1081  return true;
1082  return generateUSRForMacro(MD->getName()->getName(), MD->getLocation(),
1083  SM, Buf);
1084 
1085 }
1086 
1088  const SourceManager &SM,
1089  SmallVectorImpl<char> &Buf) {
1090  // Don't generate USRs for things with invalid locations.
1091  if (MacroName.empty() || Loc.isInvalid())
1092  return true;
1093 
1094  llvm::raw_svector_ostream Out(Buf);
1095 
1096  // Assume that system headers are sane. Don't put source location
1097  // information into the USR if the macro comes from a system header.
1098  bool ShouldGenerateLocation = !SM.isInSystemHeader(Loc);
1099 
1100  Out << getUSRSpacePrefix();
1101  if (ShouldGenerateLocation)
1102  printLoc(Out, Loc, SM, /*IncludeOffset=*/true);
1103  Out << "@macro@";
1104  Out << MacroName;
1105  return false;
1106 }
1107 
1109  raw_ostream &OS) {
1110  if (!Mod->Parent)
1111  return generateFullUSRForTopLevelModuleName(Mod->Name, OS);
1112  if (generateFullUSRForModule(Mod->Parent, OS))
1113  return true;
1114  return generateUSRFragmentForModule(Mod, OS);
1115 }
1116 
1118  raw_ostream &OS) {
1119  OS << getUSRSpacePrefix();
1120  return generateUSRFragmentForModuleName(ModName, OS);
1121 }
1122 
1124  raw_ostream &OS) {
1125  return generateUSRFragmentForModuleName(Mod->Name, OS);
1126 }
1127 
1129  raw_ostream &OS) {
1130  OS << "@M@" << ModName;
1131  return false;
1132 }
VarTemplateDecl * getDescribedVarTemplate() const
Retrieves the variable template that is described by this variable declaration.
Definition: Decl.cpp:2454
Defines the clang::ASTContext interface.
Represents a function declaration or definition.
Definition: Decl.h:1732
std::string Name
The name of this module.
Definition: Module.h:68
bool generateUSRForMacro(const MacroDefinitionRecord *MD, const SourceManager &SM, SmallVectorImpl< char > &Buf)
Generate a USR for a macro, including the USR prefix.
PointerType - C99 6.7.5.1 - Pointer Declarators.
Definition: Type.h:2543
A (possibly-)qualified type.
Definition: Type.h:642
ObjCInterfaceDecl * getClassInterface()
Definition: DeclObjC.h:2317
void generateUSRForObjCCategory(StringRef Cls, StringRef Cat, raw_ostream &OS, StringRef ClsExtSymbolDefinedIn="", StringRef CatExtSymbolDefinedIn="")
Generate a USR fragment for an Objective-C class category.
bool isExternC() const
Determines whether this function is a function with external, C linkage.
Definition: Decl.cpp:2900
QualType getPointeeType() const
If this is a pointer, ObjC object pointer, or block pointer, this returns the respective pointee...
Definition: Type.cpp:497
bool generateFullUSRForTopLevelModuleName(StringRef ModName, raw_ostream &OS)
Generate a USR for a top-level module name, including the USR prefix.
Represents the declaration of a typedef-name via the &#39;typedef&#39; type specifier.
Definition: Decl.h:3014
bool generateUSRFragmentForModuleName(StringRef ModName, raw_ostream &OS)
Generate a USR fragment for a module name.
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:87
bool generateFullUSRForModule(const Module *Mod, raw_ostream &OS)
Generate a USR for a module, including the USR prefix.
Defines the C++ template declaration subclasses.
Declaration of a variable template.
Represent a C++ namespace.
Definition: Decl.h:514
const DeclContext * getParentFunctionOrMethod() const
If this decl is defined inside a function/method/block it returns the corresponding DeclContext...
Definition: DeclBase.cpp:254
void generateUSRForObjCClass(StringRef Cls, raw_ostream &OS, StringRef ExtSymbolDefinedIn="", StringRef CategoryContextExtSymbolDefinedIn="")
Generate a USR fragment for an Objective-C class.
Represents a variable declaration or definition.
Definition: Decl.h:812
const T * getAs() const
Member-template getAs<specific type>&#39;.
Definition: Type.h:6716
The "union" keyword.
Definition: Type.h:5025
The "__interface" keyword.
Definition: Type.h:5022
Represents a variable template specialization, which refers to a variable template with a given set o...
ObjCMethodDecl - Represents an instance or class method declaration.
Definition: DeclObjC.h:139
Stores a list of template parameters for a TemplateDecl and its derived classes.
Definition: DeclTemplate.h:68
ExternalSourceSymbolAttr * getExternalSourceSymbolAttr() const
Looks on this and related declarations for an applicable external source symbol attribute.
Definition: DeclBase.cpp:450
Describes how types, statements, expressions, and declarations should be printed. ...
Definition: PrettyPrinter.h:38
The collection of all-type qualifiers we support.
Definition: Type.h:141
DeclarationName getDeclName() const
Get the actual, stored name of the declaration, which may be a special name.
Definition: Decl.h:297
Represents a class template specialization, which refers to a class template with a given set of temp...
Represents a class type in Objective C.
Definition: Type.h:5524
static StringRef getUSRSpacePrefix()
Definition: USRGeneration.h:25
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:154
Record the location of a macro definition.
static bool printLoc(llvm::raw_ostream &OS, SourceLocation Loc, const SourceManager &SM, bool IncludeOffset)
Represents a member of a struct/union/class.
Definition: Decl.h:2575
Describes a module or submodule.
Definition: Module.h:65
bool isClassProperty() const
Definition: DeclObjC.h:871
Represents a C++ using-declaration.
Definition: DeclCXX.h:3346
An rvalue reference type, per C++11 [dcl.ref].
Definition: Type.h:2744
ObjCContainerDecl - Represents a container for method declarations.
Definition: DeclObjC.h:961
TagKind getTagKind() const
Definition: Decl.h:3239
FunctionTemplateDecl * getDescribedFunctionTemplate() const
Retrieves the function template that is described by this function declaration.
Definition: Decl.cpp:3355
SourceLocation getExpansionLoc(SourceLocation Loc) const
Given a SourceLocation object Loc, return the expansion location referenced by the ID...
Module * Parent
The parent of this module.
Definition: Module.h:91
const Type * getTypePtr() const
Retrieves a pointer to the underlying (unqualified) type.
Definition: Type.h:6058
bool generateUSRFragmentForModule(const Module *Mod, raw_ostream &OS)
Generate a USR fragment for a module.
Represents an Objective-C protocol declaration.
Definition: DeclObjC.h:2056
Represents an ObjC class declaration.
Definition: DeclObjC.h:1164
Represents a linkage specification.
Definition: DeclCXX.h:2820
A binding in a decomposition declaration.
Definition: DeclCXX.h:3789
bool hasConst() const
Definition: Type.h:258
unsigned SuppressTemplateArgsInCXXConstructors
When true, suppresses printing template arguments in names of C++ constructors.
ObjCPropertyImplDecl - Represents implementation declaration of a property in a class or category imp...
Definition: DeclObjC.h:2751
bool hasAttr() const
Definition: DeclBase.h:531
Represents a prototype with parameter type info, e.g.
Definition: Type.h:3686
unsigned SuppressTagKeyword
Whether type printing should skip printing the tag keyword.
Definition: PrettyPrinter.h:94
bool isInSystemHeader(SourceLocation Loc) const
Returns if a SourceLocation is in a system header.
const FileEntry * getFileEntryForID(FileID FID) const
Returns the FileEntry record for the provided FileID.
Declaration of a template type parameter.
const TemplateArgumentList * getTemplateSpecializationArgs() const
Retrieve the template arguments used to produce this function template specialization from the primar...
Definition: Decl.cpp:3476
DeclContext * getDeclContext()
Definition: DeclBase.h:427
NonTypeTemplateParmDecl - Declares a non-type template parameter, e.g., "Size" in.
Represents a C++ template name within the type system.
Definition: TemplateName.h:178
DeclContext * getParent()
getParent - Returns the containing DeclContext.
Definition: DeclBase.h:1751
TemplateTemplateParmDecl - Declares a template template parameter, e.g., "T" in.
const SourceManager & SM
Definition: Format.cpp:1490
static StringRef GetExternalSourceContainer(const NamedDecl *D)
virtual void printName(raw_ostream &os) const
Definition: Decl.cpp:1516
The "struct" keyword.
Definition: Type.h:5019
Encodes a location in the source.
StringRef getName() const
Definition: FileManager.h:85
Interfaces are the core concept in Objective-C for object oriented design.
Definition: Type.h:5724
Represents the declaration of a struct/union/class/enum.
Definition: Decl.h:3060
ASTContext & getASTContext() const LLVM_READONLY
Definition: DeclBase.cpp:376
TagDecl * getCanonicalDecl() override
Retrieves the "canonical" declaration of the given declaration.
Definition: Decl.cpp:3867
Represents a dependent using declaration which was not marked with typename.
Definition: DeclCXX.h:3565
Cached information about one file (either on disk or in the virtual file system). ...
Definition: FileManager.h:60
ObjCCategoryDecl - Represents a category declaration.
Definition: DeclObjC.h:2272
bool hasRestrict() const
Definition: Type.h:272
const IdentifierInfo * getName() const
Retrieve the name of the macro being defined.
Represents one property declaration in an Objective-C interface.
Definition: DeclObjC.h:721
Represents a pack expansion of types.
Definition: Type.h:5341
StringRef getName() const
Return the actual identifier string.
Base class for declarations which introduce a typedef-name.
Definition: Decl.h:2912
Represents a template argument.
Definition: TemplateBase.h:51
const ObjCInterfaceDecl * getClassInterface() const
Definition: DeclObjC.h:2432
Dataflow Directional Tag Classes.
DeclContext - This is used only as base class of specific decl types that can act as declaration cont...
Definition: DeclBase.h:1261
bool isEmbeddedInDeclarator() const
True if this tag declaration is "embedded" (i.e., defined or declared for the very first time) in the...
Definition: Decl.h:3189
Represents a dependent using declaration which was marked with typename.
Definition: DeclCXX.h:3661
The name of a declaration.
Kind getKind() const
Definition: DeclBase.h:421
void generateUSRForObjCProtocol(StringRef Prot, raw_ostream &OS, StringRef ExtSymbolDefinedIn="")
Generate a USR fragment for an Objective-C protocol.
Represents a pointer to an Objective C object.
Definition: Type.h:5780
Pointer to a block type.
Definition: Type.h:2645
Complex values, per C99 6.2.5p11.
Definition: Type.h:2483
SourceLocation getLocation() const
Retrieve the location of the macro name in the definition.
Base for LValueReferenceType and RValueReferenceType.
Definition: Type.h:2679
The "class" keyword.
Definition: Type.h:5028
SourceManager & getSourceManager()
Definition: ASTContext.h:671
bool IsClassExtension() const
Definition: DeclObjC.h:2382
CanQualType getCanonicalType(QualType T) const
Return the canonical (structural) type corresponding to the specified potentially non-canonical type ...
Definition: ASTContext.h:2262
A template argument list.
Definition: DeclTemplate.h:210
TypedefNameDecl * getTypedefNameForAnonDecl() const
Definition: Decl.h:3270
Represents a C++ struct/union/class.
Definition: DeclCXX.h:300
void generateUSRForObjCProperty(StringRef Prop, bool isClassProp, raw_ostream &OS)
Generate a USR fragment for an Objective-C property.
const ObjCInterfaceDecl * getObjContainingInterface(const NamedDecl *ND) const
Returns the Objective-C interface that ND belongs to if it is an Objective-C method/property/ivar etc...
Qualifiers getQualifiers() const
Retrieve the set of qualifiers applied to this type.
Definition: Type.h:6085
The "enum" keyword.
Definition: Type.h:5031
Declaration of a class template.
This class is used for builtin types like &#39;int&#39;.
Definition: Type.h:2397
void print(raw_ostream &OS, const PrintingPolicy &Policy)
StringRef getName() const
Get the name of identifier for this declaration as a StringRef.
Definition: Decl.h:275
bool hasVolatile() const
Definition: Type.h:265
Represents a type template specialization; the template must be a class template, a type alias templa...
Definition: Type.h:4827
ObjCPropertyDecl * getPropertyDecl() const
Definition: DeclObjC.h:2810
This represents a decl that may have a name.
Definition: Decl.h:248
Represents a C++ namespace alias.
Definition: DeclCXX.h:3014
Represents C++ using-directive.
Definition: DeclCXX.h:2910
A simple visitor class that helps create declaration visitors.
Definition: DeclVisitor.h:77
bool isFreeStanding() const
True if this tag is free standing, e.g. "struct foo;".
Definition: Decl.h:3200
const LangOptions & getLangOpts() const
Definition: ASTContext.h:716
ObjCCategoryImplDecl - An object of this class encapsulates a category @implementation declaration...
Definition: DeclObjC.h:2491
This class handles loading and caching of source files into memory.
Declaration of a template function.
Definition: DeclTemplate.h:968
SourceLocation getLocation() const
Definition: DeclBase.h:418
bool isExternallyVisible() const
Definition: Decl.h:379
std::pair< FileID, unsigned > getDecomposedLoc(SourceLocation Loc) const
Decompose the specified location into a raw FileID + Offset pair.