clang  10.0.0svn
DeclarationName.cpp
Go to the documentation of this file.
1 //===- DeclarationName.cpp - Declaration names implementation -------------===//
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 DeclarationName and DeclarationNameTable
10 // classes.
11 //
12 //===----------------------------------------------------------------------===//
13 
15 #include "clang/AST/ASTContext.h"
16 #include "clang/AST/Decl.h"
17 #include "clang/AST/DeclBase.h"
18 #include "clang/AST/DeclCXX.h"
19 #include "clang/AST/DeclTemplate.h"
21 #include "clang/AST/Type.h"
22 #include "clang/AST/TypeLoc.h"
23 #include "clang/AST/TypeOrdering.h"
25 #include "clang/Basic/LLVM.h"
29 #include "llvm/ADT/FoldingSet.h"
30 #include "llvm/Support/Casting.h"
31 #include "llvm/Support/Compiler.h"
32 #include "llvm/Support/ErrorHandling.h"
33 #include "llvm/Support/raw_ostream.h"
34 #include <algorithm>
35 #include <cassert>
36 #include <cstdint>
37 #include <string>
38 
39 using namespace clang;
40 
41 static int compareInt(unsigned A, unsigned B) {
42  return (A < B ? -1 : (A > B ? 1 : 0));
43 }
44 
46  if (LHS.getNameKind() != RHS.getNameKind())
47  return (LHS.getNameKind() < RHS.getNameKind() ? -1 : 1);
48 
49  switch (LHS.getNameKind()) {
51  IdentifierInfo *LII = LHS.castAsIdentifierInfo();
52  IdentifierInfo *RII = RHS.castAsIdentifierInfo();
53  if (!LII)
54  return RII ? -1 : 0;
55  if (!RII)
56  return 1;
57 
58  return LII->getName().compare(RII->getName());
59  }
60 
64  Selector LHSSelector = LHS.getObjCSelector();
65  Selector RHSSelector = RHS.getObjCSelector();
66  // getNumArgs for ZeroArgSelector returns 0, but we still need to compare.
69  return LHSSelector.getAsIdentifierInfo()->getName().compare(
70  RHSSelector.getAsIdentifierInfo()->getName());
71  }
72  unsigned LN = LHSSelector.getNumArgs(), RN = RHSSelector.getNumArgs();
73  for (unsigned I = 0, N = std::min(LN, RN); I != N; ++I) {
74  switch (LHSSelector.getNameForSlot(I).compare(
75  RHSSelector.getNameForSlot(I))) {
76  case -1:
77  return -1;
78  case 1:
79  return 1;
80  default:
81  break;
82  }
83  }
84 
85  return compareInt(LN, RN);
86  }
87 
92  return -1;
94  return 1;
95  return 0;
96 
98  // We never want to compare deduction guide names for templates from
99  // different scopes, so just compare the template-name.
102 
106 
108  return LHS.getCXXLiteralIdentifier()->getName().compare(
110 
112  return 0;
113  }
114 
115  llvm_unreachable("Invalid DeclarationName Kind!");
116 }
117 
119  raw_ostream &OS,
120  PrintingPolicy Policy) {
121  // We know we're printing C++ here. Ensure we print types properly.
122  Policy.adjustForCPlusPlus();
123 
124  if (const RecordType *ClassRec = ClassType->getAs<RecordType>()) {
125  OS << *ClassRec->getDecl();
126  return;
127  }
129  if (auto *InjTy = ClassType->getAs<InjectedClassNameType>()) {
130  OS << *InjTy->getDecl();
131  return;
132  }
133  }
134  ClassType.print(OS, Policy);
135 }
136 
137 void DeclarationName::print(raw_ostream &OS, const PrintingPolicy &Policy) {
138  switch (getNameKind()) {
140  if (const IdentifierInfo *II = getAsIdentifierInfo())
141  OS << II->getName();
142  return;
143 
147  getObjCSelector().print(OS);
148  return;
149 
152 
154  OS << '~';
156 
158  OS << "<deduction guide for ";
160  OS << '>';
161  return;
162 
163  case DeclarationName::CXXOperatorName: {
164  const char *OpName = getOperatorSpelling(getCXXOverloadedOperator());
165  assert(OpName && "not an overloaded operator");
166 
167  OS << "operator";
168  if (OpName[0] >= 'a' && OpName[0] <= 'z')
169  OS << ' ';
170  OS << OpName;
171  return;
172  }
173 
174  case DeclarationName::CXXLiteralOperatorName:
175  OS << "operator\"\"" << getCXXLiteralIdentifier()->getName();
176  return;
177 
178  case DeclarationName::CXXConversionFunctionName: {
179  OS << "operator ";
180  QualType Type = getCXXNameType();
181  if (const RecordType *Rec = Type->getAs<RecordType>()) {
182  OS << *Rec->getDecl();
183  return;
184  }
185  // We know we're printing C++ here, ensure we print 'bool' properly.
186  PrintingPolicy CXXPolicy = Policy;
187  CXXPolicy.adjustForCPlusPlus();
188  Type.print(OS, CXXPolicy);
189  return;
190  }
192  OS << "<using-directive>";
193  return;
194  }
195 
196  llvm_unreachable("Unexpected declaration name kind");
197 }
198 
199 namespace clang {
200 
201 raw_ostream &operator<<(raw_ostream &OS, DeclarationName N) {
202  LangOptions LO;
203  N.print(OS, PrintingPolicy(LO));
204  return OS;
205 }
206 
207 } // namespace clang
208 
210  QualType T = getCXXNameType();
211  if (!T.isNull() && T->isDependentType())
212  return true;
213 
214  // A class-scope deduction guide in a dependent context has a dependent name.
215  auto *TD = getCXXDeductionGuideTemplate();
216  if (TD && TD->getDeclContext()->isDependentContext())
217  return true;
218 
219  return false;
220 }
221 
222 std::string DeclarationName::getAsString() const {
223  std::string Result;
224  llvm::raw_string_ostream OS(Result);
225  OS << *this;
226  return OS.str();
227 }
228 
229 void *DeclarationName::getFETokenInfoSlow() const {
230  switch (getNameKind()) {
231  case Identifier:
232  llvm_unreachable("case Identifier already handled by getFETokenInfo!");
233  case CXXConstructorName:
234  case CXXDestructorName:
236  return castAsCXXSpecialNameExtra()->FETokenInfo;
237  case CXXOperatorName:
238  return castAsCXXOperatorIdName()->FETokenInfo;
240  return castAsCXXDeductionGuideNameExtra()->FETokenInfo;
242  return castAsCXXLiteralOperatorIdName()->FETokenInfo;
243  default:
244  llvm_unreachable("DeclarationName has no FETokenInfo!");
245  }
246 }
247 
248 void DeclarationName::setFETokenInfoSlow(void *T) {
249  switch (getNameKind()) {
250  case Identifier:
251  llvm_unreachable("case Identifier already handled by setFETokenInfo!");
252  case CXXConstructorName:
253  case CXXDestructorName:
255  castAsCXXSpecialNameExtra()->FETokenInfo = T;
256  break;
257  case CXXOperatorName:
258  castAsCXXOperatorIdName()->FETokenInfo = T;
259  break;
261  castAsCXXDeductionGuideNameExtra()->FETokenInfo = T;
262  break;
264  castAsCXXLiteralOperatorIdName()->FETokenInfo = T;
265  break;
266  default:
267  llvm_unreachable("DeclarationName has no FETokenInfo!");
268  }
269 }
270 
271 LLVM_DUMP_METHOD void DeclarationName::dump() const {
272  llvm::errs() << *this << '\n';
273 }
274 
276  // Initialize the overloaded operator names.
277  for (unsigned Op = 0; Op < NUM_OVERLOADED_OPERATORS; ++Op)
278  CXXOperatorNames[Op].Kind = static_cast<OverloadedOperatorKind>(Op);
279 }
280 
283  Template = cast<TemplateDecl>(Template->getCanonicalDecl());
284 
285  llvm::FoldingSetNodeID ID;
286  ID.AddPointer(Template);
287 
288  void *InsertPos = nullptr;
289  if (auto *Name = CXXDeductionGuideNames.FindNodeOrInsertPos(ID, InsertPos))
290  return DeclarationName(Name);
291 
292  auto *Name = new (Ctx) detail::CXXDeductionGuideNameExtra(Template);
293  CXXDeductionGuideNames.InsertNode(Name, InsertPos);
294  return DeclarationName(Name);
295 }
296 
298  // The type of constructors is unqualified.
299  Ty = Ty.getUnqualifiedType();
300  // Do we already have this C++ constructor name ?
301  llvm::FoldingSetNodeID ID;
302  ID.AddPointer(Ty.getAsOpaquePtr());
303  void *InsertPos = nullptr;
304  if (auto *Name = CXXConstructorNames.FindNodeOrInsertPos(ID, InsertPos))
305  return {Name, DeclarationName::StoredCXXConstructorName};
306 
307  // We have to create it.
308  auto *SpecialName = new (Ctx) detail::CXXSpecialNameExtra(Ty);
309  CXXConstructorNames.InsertNode(SpecialName, InsertPos);
310  return {SpecialName, DeclarationName::StoredCXXConstructorName};
311 }
312 
314  // The type of destructors is unqualified.
315  Ty = Ty.getUnqualifiedType();
316  // Do we already have this C++ destructor name ?
317  llvm::FoldingSetNodeID ID;
318  ID.AddPointer(Ty.getAsOpaquePtr());
319  void *InsertPos = nullptr;
320  if (auto *Name = CXXDestructorNames.FindNodeOrInsertPos(ID, InsertPos))
321  return {Name, DeclarationName::StoredCXXDestructorName};
322 
323  // We have to create it.
324  auto *SpecialName = new (Ctx) detail::CXXSpecialNameExtra(Ty);
325  CXXDestructorNames.InsertNode(SpecialName, InsertPos);
326  return {SpecialName, DeclarationName::StoredCXXDestructorName};
327 }
328 
331  // Do we already have this C++ conversion function name ?
332  llvm::FoldingSetNodeID ID;
333  ID.AddPointer(Ty.getAsOpaquePtr());
334  void *InsertPos = nullptr;
335  if (auto *Name =
336  CXXConversionFunctionNames.FindNodeOrInsertPos(ID, InsertPos))
337  return {Name, DeclarationName::StoredCXXConversionFunctionName};
338 
339  // We have to create it.
340  auto *SpecialName = new (Ctx) detail::CXXSpecialNameExtra(Ty);
341  CXXConversionFunctionNames.InsertNode(SpecialName, InsertPos);
342  return {SpecialName, DeclarationName::StoredCXXConversionFunctionName};
343 }
344 
347  CanQualType Ty) {
348  switch (Kind) {
350  return getCXXConstructorName(Ty);
352  return getCXXDestructorName(Ty);
354  return getCXXConversionFunctionName(Ty);
355  default:
356  llvm_unreachable("Invalid kind in getCXXSpecialName!");
357  }
358 }
359 
362  llvm::FoldingSetNodeID ID;
363  ID.AddPointer(II);
364 
365  void *InsertPos = nullptr;
366  if (auto *Name = CXXLiteralOperatorNames.FindNodeOrInsertPos(ID, InsertPos))
367  return DeclarationName(Name);
368 
369  auto *LiteralName = new (Ctx) detail::CXXLiteralOperatorIdName(II);
370  CXXLiteralOperatorNames.InsertNode(LiteralName, InsertPos);
371  return DeclarationName(LiteralName);
372 }
373 
375  switch (Name.getNameKind()) {
378  break;
382  NamedType.TInfo = nullptr;
383  break;
385  CXXOperatorName.BeginOpNameLoc = SourceLocation().getRawEncoding();
386  CXXOperatorName.EndOpNameLoc = SourceLocation().getRawEncoding();
387  break;
389  CXXLiteralOperatorName.OpNameLoc = SourceLocation().getRawEncoding();
390  break;
394  // FIXME: ?
395  break;
397  break;
398  }
399 }
400 
402  switch (Name.getNameKind()) {
411  return false;
412 
416  if (TypeSourceInfo *TInfo = LocInfo.NamedType.TInfo)
417  return TInfo->getType()->containsUnexpandedParameterPack();
418 
419  return Name.getCXXNameType()->containsUnexpandedParameterPack();
420  }
421  llvm_unreachable("All name kinds handled.");
422 }
423 
425  switch (Name.getNameKind()) {
434  return false;
435 
439  if (TypeSourceInfo *TInfo = LocInfo.NamedType.TInfo)
440  return TInfo->getType()->isInstantiationDependentType();
441 
442  return Name.getCXXNameType()->isInstantiationDependentType();
443  }
444  llvm_unreachable("All name kinds handled.");
445 }
446 
447 std::string DeclarationNameInfo::getAsString() const {
448  std::string Result;
449  llvm::raw_string_ostream OS(Result);
450  printName(OS);
451  return OS.str();
452 }
453 
454 void DeclarationNameInfo::printName(raw_ostream &OS) const {
455  switch (Name.getNameKind()) {
464  OS << Name;
465  return;
466 
470  if (TypeSourceInfo *TInfo = LocInfo.NamedType.TInfo) {
471  if (Name.getNameKind() == DeclarationName::CXXDestructorName)
472  OS << '~';
473  else if (Name.getNameKind() == DeclarationName::CXXConversionFunctionName)
474  OS << "operator ";
475  LangOptions LO;
476  LO.CPlusPlus = true;
477  LO.Bool = true;
478  PrintingPolicy PP(LO);
479  PP.SuppressScope = true;
480  OS << TInfo->getType().getAsString(PP);
481  } else
482  OS << Name;
483  return;
484  }
485  llvm_unreachable("Unexpected declaration name kind");
486 }
487 
488 SourceLocation DeclarationNameInfo::getEndLocPrivate() const {
489  switch (Name.getNameKind()) {
492  return NameLoc;
493 
495  unsigned raw = LocInfo.CXXOperatorName.EndOpNameLoc;
497  }
498 
500  unsigned raw = LocInfo.CXXLiteralOperatorName.OpNameLoc;
502  }
503 
507  if (TypeSourceInfo *TInfo = LocInfo.NamedType.TInfo)
508  return TInfo->getTypeLoc().getEndLoc();
509  else
510  return NameLoc;
511 
512  // DNInfo work in progress: FIXME.
517  return NameLoc;
518  }
519  llvm_unreachable("Unexpected declaration name kind");
520 }
Defines the clang::ASTContext interface.
Smart pointer class that efficiently represents Objective-C method names.
unsigned getRawEncoding() const
When a SourceLocation itself cannot be used, this returns an (opaque) 32-bit integer encoding for it...
A (possibly-)qualified type.
Definition: Type.h:643
NameKind
The kind of the name stored in this DeclarationName.
DeclarationName getCXXConstructorName(CanQualType Ty)
Returns the name of a C++ constructor for the given Type.
C Language Family Type Representation.
DeclarationName getCXXConversionFunctionName(CanQualType Ty)
Returns the name of a C++ conversion function for the given Type.
Selector getObjCSelector() const
Get the Objective-C selector stored in this declaration name.
Defines the C++ template declaration subclasses.
OverloadedOperatorKind getCXXOverloadedOperator() const
If this name is the name of an overloadable operator in C++ (e.g., operator+), retrieve the kind of o...
const DiagnosticBuilder & operator<<(const DiagnosticBuilder &DB, const Attr *At)
Definition: Attr.h:335
The base class of the type hierarchy.
Definition: Type.h:1421
CanQual< T > getUnqualifiedType() const
Retrieve the unqualified form of this type.
A container of type source information.
Definition: Decl.h:86
bool isInstantiationDependent() const
Determine whether this name involves a template parameter.
DeclarationName getCXXDeductionGuideName(TemplateDecl *TD)
Returns the name of a C++ deduction guide for the given template.
const T * getAs() const
Member-template getAs<specific type>&#39;.
Definition: Type.h:6824
Describes how types, statements, expressions, and declarations should be printed. ...
Definition: PrettyPrinter.h:37
DeclarationName getDeclName() const
Get the actual, stored name of the declaration, which may be a special name.
Definition: Decl.h:297
One of these records is kept for each identifier that is lexed.
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:154
static SourceLocation getFromRawEncoding(unsigned Encoding)
Turn a raw encoding of a SourceLocation object into a real SourceLocation.
NameKind getNameKind() const
Determine what kind of name this is.
DeclarationName getCXXDestructorName(CanQualType Ty)
Returns the name of a C++ destructor for the given Type.
static int compareInt(unsigned A, unsigned B)
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:49
bool isDependentName() const
Determines whether the name itself is dependent, e.g., because it involves a C++ type that is itself ...
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
void print(raw_ostream &OS, const PrintingPolicy &Policy, const Twine &PlaceHolder=Twine(), unsigned Indentation=0) const
bool containsUnexpandedParameterPack() const
Determine whether this name contains an unexpanded parameter pack.
virtual Decl * getCanonicalDecl()
Retrieves the "canonical" declaration of the given declaration.
Definition: DeclBase.h:877
unsigned SuppressTemplateArgsInCXXConstructors
When true, suppresses printing template arguments in names of C++ constructors.
Function object that provides a total ordering on QualType values.
Definition: TypeOrdering.h:28
Allows QualTypes to be sorted and hence used in maps and sets.
QualType getCXXNameType() const
If this name is one of the C++ names (of a constructor, destructor, or conversion function)...
Defines the clang::LangOptions interface.
Contains extra information for the name of a C++ deduction guide.
static void printCXXConstructorDestructorName(QualType ClassType, raw_ostream &OS, PrintingPolicy Policy)
std::string getAsString() const
Retrieve the human-readable string for this name.
Defines an enumeration for C++ overloaded operators.
StringRef getNameForSlot(unsigned argIndex) const
Retrieve the name at a given position in the selector.
Defines the clang::TypeLoc interface and its subclasses.
IdentifierInfo * getAsIdentifierInfo() const
Retrieve the IdentifierInfo * stored in this declaration name, or null if this declaration name isn&#39;t...
Defines the clang::IdentifierInfo, clang::IdentifierTable, and clang::Selector interfaces.
void print(llvm::raw_ostream &OS) const
Prints the full selector name (e.g. "foo:bar:").
unsigned getNumArgs() const
The result type of a method or function.
bool isNull() const
Return true if this QualType doesn&#39;t point to a type yet.
Definition: Type.h:708
Kind
Encodes a location in the source.
DeclarationNameTable(const ASTContext &C)
unsigned SuppressScope
Suppresses printing of scope specifiers.
CXXSpecialNameExtra records the type associated with one of the "special" kinds of declaration names ...
DeclarationName getCXXSpecialName(DeclarationName::NameKind Kind, CanQualType Ty)
Returns a declaration name for special kind of C++ name, e.g., for a constructor, destructor...
void printName(raw_ostream &OS) const
printName - Print the human-readable name to a stream.
The injected class name of a C++ class template or class template partial specialization.
Definition: Type.h:5039
StringRef getName() const
Return the actual identifier string.
Dataflow Directional Tag Classes.
std::string getAsString() const
getAsString - Retrieve the human-readable string for this name.
The base class of all kinds of template declarations (e.g., class, function, etc.).
Definition: DeclTemplate.h:403
The name of a declaration.
void adjustForCPlusPlus()
Adjust this printing policy for cases where it&#39;s known that we&#39;re printing C++ code (for instance...
Definition: PrettyPrinter.h:59
A helper class that allows the use of isa/cast/dyncast to detect TagType objects of structs/unions/cl...
Definition: Type.h:4429
void * getAsOpaquePtr() const
Retrieve the internal representation of this canonical type.
DeclarationName getCXXLiteralOperatorName(IdentifierInfo *II)
Get the name of the literal operator function with II as the identifier.
Defines the C++ Decl subclasses, other than those for templates (found in DeclTemplate.h) and friends (in DeclFriend.h).
TemplateDecl * getCXXDeductionGuideTemplate() const
If this name is the name of a C++ deduction guide, return the template associated with that name...
Defines the clang::SourceLocation class and associated facilities.
static int compare(DeclarationName LHS, DeclarationName RHS)
void print(raw_ostream &OS, const PrintingPolicy &Policy)
Contains the actual identifier that makes up the name of a C++ literal operator.
__DEVICE__ int min(int __a, int __b)
bool isDependentType() const
Whether this type is a dependent type, meaning that its definition somehow depends on a template para...
Definition: Type.h:2096
IdentifierInfo * getCXXLiteralIdentifier() const
If this name is the name of a literal operator, retrieve the identifier associated with it...