DeclarationName.h revision d57959af02b4af695276f4204443afe6e5d86bd8 
1//===-- DeclarationName.h - Representation of declaration names -*- C++ -*-===//
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//
10// This file declares the DeclarationName and DeclarationNameTable classes.
11//
12//===----------------------------------------------------------------------===//
13#ifndef LLVM_CLANG_AST_DECLARATIONNAME_H
14#define LLVM_CLANG_AST_DECLARATIONNAME_H
15
16#include "clang/Basic/IdentifierTable.h"
17#include "clang/AST/Type.h"
18#include "llvm/Bitcode/SerializationFwd.h"
19
20namespace llvm {
21  template <typename T> struct DenseMapInfo;
22}
23
24namespace clang {
25  class CXXSpecialName;
26  class CXXOperatorIdName;
27  class DeclarationNameExtra;
28  class IdentifierInfo;
29  class MultiKeywordSelector;
30  class UsingDirectiveDecl;
31
32/// DeclarationName - The name of a declaration. In the common case,
33/// this just stores an IdentifierInfo pointer to a normal
34/// name. However, it also provides encodings for Objective-C
35/// selectors (optimizing zero- and one-argument selectors, which make
36/// up 78% percent of all selectors in Cocoa.h) and special C++ names
37/// for constructors, destructors, and conversion functions.
38class DeclarationName {
39public:
40  /// NameKind - The kind of name this object contains.
41  enum NameKind {
42    Identifier,
43    ObjCZeroArgSelector,
44    ObjCOneArgSelector,
45    ObjCMultiArgSelector,
46    CXXConstructorName,
47    CXXDestructorName,
48    CXXConversionFunctionName,
49    CXXOperatorName,
50    CXXUsingDirective
51  };
52
53private:
54  /// StoredNameKind - The kind of name that is actually stored in the
55  /// upper bits of the Ptr field. This is only used internally.
56  enum StoredNameKind {
57    StoredIdentifier = 0,
58    StoredObjCZeroArgSelector,
59    StoredObjCOneArgSelector,
60    StoredDeclarationNameExtra,
61    PtrMask = 0x03
62  };
63
64  /// Ptr - The lowest two bits are used to express what kind of name
65  /// we're actually storing, using the values of NameKind. Depending
66  /// on the kind of name this is, the upper bits of Ptr may have one
67  /// of several different meanings:
68  ///
69  ///   StoredIdentifier - The name is a normal identifier, and Ptr is
70  ///   a normal IdentifierInfo pointer.
71  ///
72  ///   StoredObjCZeroArgSelector - The name is an Objective-C
73  ///   selector with zero arguments, and Ptr is an IdentifierInfo
74  ///   pointer pointing to the selector name.
75  ///
76  ///   StoredObjCOneArgSelector - The name is an Objective-C selector
77  ///   with one argument, and Ptr is an IdentifierInfo pointer
78  ///   pointing to the selector name.
79  ///
80  ///   StoredDeclarationNameExtra - Ptr is actually a pointer to a
81  ///   DeclarationNameExtra structure, whose first value will tell us
82  ///   whether this is an Objective-C selector, C++ operator-id name,
83  ///   or special C++ name.
84  uintptr_t Ptr;
85
86  /// getStoredNameKind - Return the kind of object that is stored in
87  /// Ptr.
88  StoredNameKind getStoredNameKind() const {
89    return static_cast<StoredNameKind>(Ptr & PtrMask);
90  }
91
92  /// getExtra - Get the "extra" information associated with this
93  /// multi-argument selector or C++ special name.
94  DeclarationNameExtra *getExtra() const {
95    assert(getStoredNameKind() == StoredDeclarationNameExtra &&
96           "Declaration name does not store an Extra structure");
97    return reinterpret_cast<DeclarationNameExtra *>(Ptr & ~PtrMask);
98  }
99
100  /// getAsCXXSpecialName - If the stored pointer is actually a
101  /// CXXSpecialName, returns a pointer to it. Otherwise, returns
102  /// a NULL pointer.
103  CXXSpecialName *getAsCXXSpecialName() const {
104    if (getNameKind() >= CXXConstructorName &&
105        getNameKind() <= CXXConversionFunctionName)
106      return reinterpret_cast<CXXSpecialName *>(Ptr & ~PtrMask);
107    return 0;
108  }
109
110  /// getAsCXXOperatorIdName
111  CXXOperatorIdName *getAsCXXOperatorIdName() const {
112    if (getNameKind() == CXXOperatorName)
113      return reinterpret_cast<CXXOperatorIdName *>(Ptr & ~PtrMask);
114    return 0;
115  }
116
117  // Construct a declaration name from the name of a C++ constructor,
118  // destructor, or conversion function.
119  DeclarationName(CXXSpecialName *Name)
120    : Ptr(reinterpret_cast<uintptr_t>(Name)) {
121    assert((Ptr & PtrMask) == 0 && "Improperly aligned CXXSpecialName");
122    Ptr |= StoredDeclarationNameExtra;
123  }
124
125  // Construct a declaration name from the name of a C++ overloaded
126  // operator.
127  DeclarationName(CXXOperatorIdName *Name)
128    : Ptr(reinterpret_cast<uintptr_t>(Name)) {
129    assert((Ptr & PtrMask) == 0 && "Improperly aligned CXXOperatorId");
130    Ptr |= StoredDeclarationNameExtra;
131  }
132
133  /// Construct a declaration name from a raw pointer.
134  DeclarationName(uintptr_t Ptr) : Ptr(Ptr) { }
135
136  /// getUsingDirectiveName - Return name for all using-directives.
137  static DeclarationName getUsingDirectiveName();
138
139  friend class DeclarationNameTable;
140  friend class UsingDirectiveDecl;
141  friend class NamedDecl;
142
143  /// getFETokenInfoAsVoid - Retrieves the front end-specified pointer
144  /// for this name as a void pointer.
145  void *getFETokenInfoAsVoid() const;
146
147public:
148  /// DeclarationName - Used to create an empty selector.
149  DeclarationName() : Ptr(0) { }
150
151  // Construct a declaration name from an IdentifierInfo *.
152  DeclarationName(const IdentifierInfo *II)
153    : Ptr(reinterpret_cast<uintptr_t>(II)) {
154    assert((Ptr & PtrMask) == 0 && "Improperly aligned IdentifierInfo");
155  }
156
157  // Construct a declaration name from an Objective-C selector.
158  DeclarationName(Selector Sel);
159
160  // operator bool() - Evaluates true when this declaration name is
161  // non-empty.
162  operator bool() const {
163    return ((Ptr & PtrMask) != 0) ||
164           (reinterpret_cast<IdentifierInfo *>(Ptr & ~PtrMask));
165  }
166
167  /// Predicate functions for querying what type of name this is.
168  bool isIdentifier() const { return getStoredNameKind() == StoredIdentifier; }
169  bool isObjCZeroArgSelector() const {
170    return getStoredNameKind() == StoredObjCZeroArgSelector;
171  }
172  bool isObjCOneArgSelector() const {
173    return getStoredNameKind() == StoredObjCOneArgSelector;
174  }
175
176  /// getNameKind - Determine what kind of name this is.
177  NameKind getNameKind() const;
178
179
180  /// getName - Retrieve the human-readable string for this name.
181  std::string getAsString() const;
182
183  /// getAsIdentifierInfo - Retrieve the IdentifierInfo * stored in
184  /// this declaration name, or NULL if this declaration name isn't a
185  /// simple identifier.
186  IdentifierInfo *getAsIdentifierInfo() const {
187    if (isIdentifier())
188      return reinterpret_cast<IdentifierInfo *>(Ptr);
189    return 0;
190  }
191
192  /// getAsOpaqueInteger - Get the representation of this declaration
193  /// name as an opaque integer.
194  uintptr_t getAsOpaqueInteger() const { return Ptr; }
195
196  /// getAsOpaquePtr - Get the representation of this declaration name as
197  /// an opaque pointer.
198  void *getAsOpaquePtr() const { return reinterpret_cast<void*>(Ptr); }
199
200  static DeclarationName getFromOpaqueInteger(uintptr_t P) {
201    DeclarationName N;
202    N.Ptr = P;
203    return N;
204  }
205
206  /// getCXXNameType - If this name is one of the C++ names (of a
207  /// constructor, destructor, or conversion function), return the
208  /// type associated with that name.
209  QualType getCXXNameType() const;
210
211  /// getCXXOverloadedOperator - If this name is the name of an
212  /// overloadable operator in C++ (e.g., @c operator+), retrieve the
213  /// kind of overloaded operator.
214  OverloadedOperatorKind getCXXOverloadedOperator() const;
215
216  /// getObjCSelector - Get the Objective-C selector stored in this
217  /// declaration name.
218  Selector getObjCSelector() const;
219
220  /// getFETokenInfo/setFETokenInfo - The language front-end is
221  /// allowed to associate arbitrary metadata with some kinds of
222  /// declaration names, including normal identifiers and C++
223  /// constructors, destructors, and conversion functions.
224  template<typename T>
225  T *getFETokenInfo() const { return static_cast<T*>(getFETokenInfoAsVoid()); }
226
227  void setFETokenInfo(void *T);
228
229  /// operator== - Determine whether the specified names are identical..
230  friend bool operator==(DeclarationName LHS, DeclarationName RHS) {
231    return LHS.Ptr == RHS.Ptr;
232  }
233
234  /// operator!= - Determine whether the specified names are different.
235  friend bool operator!=(DeclarationName LHS, DeclarationName RHS) {
236    return LHS.Ptr != RHS.Ptr;
237  }
238
239  static DeclarationName getEmptyMarker() {
240    return DeclarationName(uintptr_t(-1));
241  }
242
243  static DeclarationName getTombstoneMarker() {
244    return DeclarationName(uintptr_t(-2));
245  }
246};
247
248/// Ordering on two declaration names. If both names are identifiers,
249/// this provides a lexicographical ordering.
250bool operator<(DeclarationName LHS, DeclarationName RHS);
251
252/// Ordering on two declaration names. If both names are identifiers,
253/// this provides a lexicographical ordering.
254inline bool operator>(DeclarationName LHS, DeclarationName RHS) {
255  return RHS < LHS;
256}
257
258/// Ordering on two declaration names. If both names are identifiers,
259/// this provides a lexicographical ordering.
260inline bool operator<=(DeclarationName LHS, DeclarationName RHS) {
261  return !(RHS < LHS);
262}
263
264/// Ordering on two declaration names. If both names are identifiers,
265/// this provides a lexicographical ordering.
266inline bool operator>=(DeclarationName LHS, DeclarationName RHS) {
267  return !(LHS < RHS);
268}
269
270/// DeclarationNameTable - Used to store and retrieve DeclarationName
271/// instances for the various kinds of declaration names, e.g., normal
272/// identifiers, C++ constructor names, etc. This class contains
273/// uniqued versions of each of the C++ special names, which can be
274/// retrieved using its member functions (e.g.,
275/// getCXXConstructorName).
276class DeclarationNameTable {
277  void *CXXSpecialNamesImpl; // Actually a FoldingSet<CXXSpecialName> *
278  CXXOperatorIdName *CXXOperatorNames; // Operator names
279
280  DeclarationNameTable(const DeclarationNameTable&);            // NONCOPYABLE
281  DeclarationNameTable& operator=(const DeclarationNameTable&); // NONCOPYABLE
282
283public:
284  DeclarationNameTable();
285  ~DeclarationNameTable();
286
287  /// getIdentifier - Create a declaration name that is a simple
288  /// identifier.
289  DeclarationName getIdentifier(IdentifierInfo *ID) {
290    return DeclarationName(ID);
291  }
292
293  /// getCXXConstructorName - Returns the name of a C++ constructor
294  /// for the given Type.
295  DeclarationName getCXXConstructorName(QualType Ty) {
296    return getCXXSpecialName(DeclarationName::CXXConstructorName, Ty);
297  }
298
299  /// getCXXDestructorName - Returns the name of a C++ destructor
300  /// for the given Type.
301  DeclarationName getCXXDestructorName(QualType Ty) {
302    return getCXXSpecialName(DeclarationName::CXXDestructorName, Ty);
303  }
304
305  /// getCXXConversionFunctionName - Returns the name of a C++
306  /// conversion function for the given Type.
307  DeclarationName getCXXConversionFunctionName(QualType Ty) {
308    return getCXXSpecialName(DeclarationName::CXXConversionFunctionName, Ty);
309  }
310
311  /// getCXXSpecialName - Returns a declaration name for special kind
312  /// of C++ name, e.g., for a constructor, destructor, or conversion
313  /// function.
314  DeclarationName getCXXSpecialName(DeclarationName::NameKind Kind,
315                                    QualType Ty);
316
317  /// getCXXOperatorName - Get the name of the overloadable C++
318  /// operator corresponding to Op.
319  DeclarationName getCXXOperatorName(OverloadedOperatorKind Op);
320};
321
322/// Insertion operator for diagnostics.  This allows sending DeclarationName's
323/// into a diagnostic with <<.
324inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
325                                           DeclarationName N) {
326  DB.AddTaggedVal(N.getAsOpaqueInteger(),
327                  Diagnostic::ak_declarationname);
328  return DB;
329}
330
331
332}  // end namespace clang
333
334namespace llvm {
335/// Define DenseMapInfo so that DeclarationNames can be used as keys
336/// in DenseMap and DenseSets.
337template<>
338struct DenseMapInfo<clang::DeclarationName> {
339  static inline clang::DeclarationName getEmptyKey() {
340    return clang::DeclarationName::getEmptyMarker();
341  }
342
343  static inline clang::DeclarationName getTombstoneKey() {
344    return clang::DeclarationName::getTombstoneMarker();
345  }
346
347  static unsigned getHashValue(clang::DeclarationName);
348
349  static inline bool
350  isEqual(clang::DeclarationName LHS, clang::DeclarationName RHS) {
351    return LHS == RHS;
352  }
353
354  static inline bool isPod() { return true; }
355};
356
357}  // end namespace llvm
358
359#endif
360