clang 19.0.0git
CanonicalType.h
Go to the documentation of this file.
1//===- CanonicalType.h - C Language Family Type Representation --*- C++ -*-===//
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 defines the CanQual class template, which provides access to
10// canonical types.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_AST_CANONICALTYPE_H
15#define LLVM_CLANG_AST_CANONICALTYPE_H
16
17#include "clang/AST/Type.h"
20#include "llvm/ADT/ArrayRef.h"
21#include "llvm/ADT/FoldingSet.h"
22#include "llvm/ADT/iterator.h"
23#include "llvm/Support/Casting.h"
24#include "llvm/Support/PointerLikeTypeTraits.h"
25#include <cassert>
26#include <iterator>
27#include <type_traits>
28
29namespace clang {
30
31template<typename T> class CanProxy;
32template<typename T> struct CanProxyAdaptor;
33class CXXRecordDecl;
34class EnumDecl;
35class Expr;
36class IdentifierInfo;
37class ObjCInterfaceDecl;
38class RecordDecl;
39class TagDecl;
40class TemplateTypeParmDecl;
41
42//----------------------------------------------------------------------------//
43// Canonical, qualified type template
44//----------------------------------------------------------------------------//
45
46/// Represents a canonical, potentially-qualified type.
47///
48/// The CanQual template is a lightweight smart pointer that provides access
49/// to the canonical representation of a type, where all typedefs and other
50/// syntactic sugar has been eliminated. A CanQualType may also have various
51/// qualifiers (const, volatile, restrict) attached to it.
52///
53/// The template type parameter @p T is one of the Type classes (PointerType,
54/// BuiltinType, etc.). The type stored within @c CanQual<T> will be of that
55/// type (or some subclass of that type). The typedef @c CanQualType is just
56/// a shorthand for @c CanQual<Type>.
57///
58/// An instance of @c CanQual<T> can be implicitly converted to a
59/// @c CanQual<U> when T is derived from U, which essentially provides an
60/// implicit upcast. For example, @c CanQual<LValueReferenceType> can be
61/// converted to @c CanQual<ReferenceType>. Note that any @c CanQual type can
62/// be implicitly converted to a QualType, but the reverse operation requires
63/// a call to ASTContext::getCanonicalType().
64template<typename T = Type>
65class CanQual {
66 /// The actual, canonical type.
67 QualType Stored;
68
69public:
70 /// Constructs a NULL canonical type.
71 CanQual() = default;
72
73 /// Converting constructor that permits implicit upcasting of
74 /// canonical type pointers.
75 template <typename U>
77 std::enable_if_t<std::is_base_of<T, U>::value, int> = 0);
78
79 /// Retrieve the underlying type pointer, which refers to a
80 /// canonical type.
81 ///
82 /// The underlying pointer must not be nullptr.
83 const T *getTypePtr() const { return cast<T>(Stored.getTypePtr()); }
84
85 /// Retrieve the underlying type pointer, which refers to a
86 /// canonical type, or nullptr.
87 const T *getTypePtrOrNull() const {
88 return cast_or_null<T>(Stored.getTypePtrOrNull());
89 }
90
91 /// Implicit conversion to a qualified type.
92 operator QualType() const { return Stored; }
93
94 /// Implicit conversion to bool.
95 explicit operator bool() const { return !isNull(); }
96
97 bool isNull() const {
98 return Stored.isNull();
99 }
100
101 SplitQualType split() const { return Stored.split(); }
102
103 /// Retrieve a canonical type pointer with a different static type,
104 /// upcasting or downcasting as needed.
105 ///
106 /// The getAs() function is typically used to try to downcast to a
107 /// more specific (canonical) type in the type system. For example:
108 ///
109 /// @code
110 /// void f(CanQual<Type> T) {
111 /// if (CanQual<PointerType> Ptr = T->getAs<PointerType>()) {
112 /// // look at Ptr's pointee type
113 /// }
114 /// }
115 /// @endcode
116 ///
117 /// \returns A proxy pointer to the same type, but with the specified
118 /// static type (@p U). If the dynamic type is not the specified static type
119 /// or a derived class thereof, a NULL canonical type.
120 template<typename U> CanProxy<U> getAs() const;
121
122 template<typename U> CanProxy<U> castAs() const;
123
124 /// Overloaded arrow operator that produces a canonical type
125 /// proxy.
127
128 /// Retrieve all qualifiers.
129 Qualifiers getQualifiers() const { return Stored.getLocalQualifiers(); }
130
131 /// Retrieve the const/volatile/restrict qualifiers.
132 unsigned getCVRQualifiers() const { return Stored.getLocalCVRQualifiers(); }
133
134 /// Determines whether this type has any qualifiers
135 bool hasQualifiers() const { return Stored.hasLocalQualifiers(); }
136
137 bool isConstQualified() const {
138 return Stored.isLocalConstQualified();
139 }
140
141 bool isVolatileQualified() const {
142 return Stored.isLocalVolatileQualified();
143 }
144
145 bool isRestrictQualified() const {
146 return Stored.isLocalRestrictQualified();
147 }
148
149 /// Determines if this canonical type is furthermore
150 /// canonical as a parameter. The parameter-canonicalization
151 /// process decays arrays to pointers and drops top-level qualifiers.
152 bool isCanonicalAsParam() const {
153 return Stored.isCanonicalAsParam();
154 }
155
156 /// Retrieve the unqualified form of this type.
158
159 /// Retrieves a version of this type with const applied.
160 /// Note that this does not always yield a canonical type.
162 return Stored.withConst();
163 }
164
165 /// Determines whether this canonical type is more qualified than
166 /// the @p Other canonical type.
168 return Stored.isMoreQualifiedThan(Other.Stored);
169 }
170
171 /// Determines whether this canonical type is at least as qualified as
172 /// the @p Other canonical type.
174 return Stored.isAtLeastAsQualifiedAs(Other.Stored);
175 }
176
177 /// If the canonical type is a reference type, returns the type that
178 /// it refers to; otherwise, returns the type itself.
180
181 /// Retrieve the internal representation of this canonical type.
182 void *getAsOpaquePtr() const { return Stored.getAsOpaquePtr(); }
183
184 /// Construct a canonical type from its internal representation.
185 static CanQual<T> getFromOpaquePtr(void *Ptr);
186
187 /// Builds a canonical type from a QualType.
188 ///
189 /// This routine is inherently unsafe, because it requires the user to
190 /// ensure that the given type is a canonical type with the correct
191 // (dynamic) type.
193
194 void dump() const { Stored.dump(); }
195
196 void Profile(llvm::FoldingSetNodeID &ID) const {
197 ID.AddPointer(getAsOpaquePtr());
198 }
199};
200
201template<typename T, typename U>
203 return x.getAsOpaquePtr() == y.getAsOpaquePtr();
204}
205
206template<typename T, typename U>
208 return x.getAsOpaquePtr() != y.getAsOpaquePtr();
209}
210
211/// Represents a canonical, potentially-qualified type.
213
216}
217
219 CanQualType T) {
220 DB << static_cast<QualType>(T);
221 return DB;
222}
223
224//----------------------------------------------------------------------------//
225// Internal proxy classes used by canonical types
226//----------------------------------------------------------------------------//
227
228#define LLVM_CLANG_CANPROXY_TYPE_ACCESSOR(Accessor) \
229CanQualType Accessor() const { \
230return CanQualType::CreateUnsafe(this->getTypePtr()->Accessor()); \
231}
232
233#define LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(Type, Accessor) \
234Type Accessor() const { return this->getTypePtr()->Accessor(); }
235
236/// Base class of all canonical proxy types, which is responsible for
237/// storing the underlying canonical type and providing basic conversions.
238template<typename T>
240protected:
242
243public:
244 /// Retrieve the pointer to the underlying Type
245 const T *getTypePtr() const { return Stored.getTypePtr(); }
246
247 /// Implicit conversion to the underlying pointer.
248 ///
249 /// Also provides the ability to use canonical type proxies in a Boolean
250 // context,e.g.,
251 /// @code
252 /// if (CanQual<PointerType> Ptr = T->getAs<PointerType>()) { ... }
253 /// @endcode
254 operator const T*() const { return this->Stored.getTypePtrOrNull(); }
255
256 /// Try to convert the given canonical type to a specific structural
257 /// type.
258 template<typename U> CanProxy<U> getAs() const {
259 return this->Stored.template getAs<U>();
260 }
261
263
264 // Type predicates
265 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isObjectType)
266 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isIncompleteType)
267 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isSizelessType)
268 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isSizelessBuiltinType)
269 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isIncompleteOrObjectType)
270 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isVariablyModifiedType)
271 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isIntegerType)
272 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isEnumeralType)
275 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isWideCharType)
276 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isIntegralType)
277 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isIntegralOrEnumerationType)
278 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isRealFloatingType)
279 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isComplexType)
280 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isAnyComplexType)
281 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isFloatingType)
283 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isArithmeticType)
285 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isDerivedType)
286 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isScalarType)
287 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isAggregateType)
288 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isAnyPointerType)
289 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isVoidPointerType)
290 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isFunctionPointerType)
291 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isMemberFunctionPointerType)
292 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isClassType)
293 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isStructureType)
294 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isInterfaceType)
295 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isStructureOrClassType)
296 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isUnionType)
297 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isComplexIntegerType)
298 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isNullPtrType)
299 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isDependentType)
300 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isOverloadableType)
301 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isArrayType)
302 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, hasPointerRepresentation)
303 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, hasObjCPointerRepresentation)
304 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, hasIntegerRepresentation)
305 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, hasSignedIntegerRepresentation)
306 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, hasUnsignedIntegerRepresentation)
307 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, hasFloatingRepresentation)
308 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isSignedIntegerType)
309 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isUnsignedIntegerType)
310 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isSignedIntegerOrEnumerationType)
311 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isUnsignedIntegerOrEnumerationType)
312 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isConstantSizeType)
313 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isSpecifierType)
315
316 /// Retrieve the proxy-adaptor type.
317 ///
318 /// This arrow operator is used when CanProxyAdaptor has been specialized
319 /// for the given type T. In that case, we reference members of the
320 /// CanProxyAdaptor specialization. Otherwise, this operator will be hidden
321 /// by the arrow operator in the primary CanProxyAdaptor template.
322 const CanProxyAdaptor<T> *operator->() const {
323 return static_cast<const CanProxyAdaptor<T> *>(this);
324 }
325};
326
327/// Replaceable canonical proxy adaptor class that provides the link
328/// between a canonical type and the accessors of the type.
329///
330/// The CanProxyAdaptor is a replaceable class template that is instantiated
331/// as part of each canonical proxy type. The primary template merely provides
332/// redirection to the underlying type (T), e.g., @c PointerType. One can
333/// provide specializations of this class template for each underlying type
334/// that provide accessors returning canonical types (@c CanQualType) rather
335/// than the more typical @c QualType, to propagate the notion of "canonical"
336/// through the system.
337template<typename T>
339
340/// Canonical proxy type returned when retrieving the members of a
341/// canonical type or as the result of the @c CanQual<T>::getAs member
342/// function.
343///
344/// The CanProxy type mainly exists as a proxy through which operator-> will
345/// look to either map down to a raw T* (e.g., PointerType*) or to a proxy
346/// type that provides canonical-type access to the fields of the type.
347template<typename T>
348class CanProxy : public CanProxyAdaptor<T> {
349public:
350 /// Build a NULL proxy.
351 CanProxy() = default;
352
353 /// Build a proxy to the given canonical type.
354 CanProxy(CanQual<T> Stored) { this->Stored = Stored; }
355
356 /// Implicit conversion to the stored canonical type.
357 operator CanQual<T>() const { return this->Stored; }
358};
359
360} // namespace clang
361
362namespace llvm {
363
364/// Implement simplify_type for CanQual<T>, so that we can dyn_cast from
365/// CanQual<T> to a specific Type class. We're prefer isa/dyn_cast/cast/etc.
366/// to return smart pointer (proxies?).
367template<typename T>
368struct simplify_type< ::clang::CanQual<T>> {
369 using SimpleType = const T *;
370
372 return Val.getTypePtr();
373 }
374};
375
376// Teach SmallPtrSet that CanQual<T> is "basically a pointer".
377template<typename T>
378struct PointerLikeTypeTraits<clang::CanQual<T>> {
380 return P.getAsOpaquePtr();
381 }
382
385 }
386
387 // qualifier information is encoded in the low bits.
388 static constexpr int NumLowBitsAvailable = 0;
389};
390
391} // namespace llvm
392
393namespace clang {
394
395//----------------------------------------------------------------------------//
396// Canonical proxy adaptors for canonical type nodes.
397//----------------------------------------------------------------------------//
398
399/// Iterator adaptor that turns an iterator over canonical QualTypes
400/// into an iterator over CanQualTypes.
401template <typename InputIterator>
403 : llvm::iterator_adaptor_base<
404 CanTypeIterator<InputIterator>, InputIterator,
405 typename std::iterator_traits<InputIterator>::iterator_category,
406 CanQualType,
407 typename std::iterator_traits<InputIterator>::difference_type,
408 CanProxy<Type>, CanQualType> {
409 CanTypeIterator() = default;
410 explicit CanTypeIterator(InputIterator Iter)
411 : CanTypeIterator::iterator_adaptor_base(std::move(Iter)) {}
412
413 CanQualType operator*() const { return CanQualType::CreateUnsafe(*this->I); }
415};
416
417template<>
418struct CanProxyAdaptor<ComplexType> : public CanProxyBase<ComplexType> {
420};
421
422template<>
423struct CanProxyAdaptor<PointerType> : public CanProxyBase<PointerType> {
425};
426
427template<>
429 : public CanProxyBase<BlockPointerType> {
431};
432
433template<>
434struct CanProxyAdaptor<ReferenceType> : public CanProxyBase<ReferenceType> {
436};
437
438template<>
440 : public CanProxyBase<LValueReferenceType> {
442};
443
444template<>
446 : public CanProxyBase<RValueReferenceType> {
448};
449
450template<>
452 : public CanProxyBase<MemberPointerType> {
455};
456
457// CanProxyAdaptors for arrays are intentionally unimplemented because
458// they are not safe.
459template<> struct CanProxyAdaptor<ArrayType>;
460template<> struct CanProxyAdaptor<ConstantArrayType>;
461template<> struct CanProxyAdaptor<IncompleteArrayType>;
462template<> struct CanProxyAdaptor<VariableArrayType>;
464
465template<>
467 : public CanProxyBase<DependentSizedExtVectorType> {
469 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(const Expr *, getSizeExpr)
471};
472
473template<>
474struct CanProxyAdaptor<VectorType> : public CanProxyBase<VectorType> {
476 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(unsigned, getNumElements)
477};
478
479template<>
480struct CanProxyAdaptor<ExtVectorType> : public CanProxyBase<ExtVectorType> {
482 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(unsigned, getNumElements)
483};
484
485template<>
486struct CanProxyAdaptor<FunctionType> : public CanProxyBase<FunctionType> {
489};
490
491template<>
493 : public CanProxyBase<FunctionNoProtoType> {
496};
497
498template<>
500 : public CanProxyBase<FunctionProtoType> {
503 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(unsigned, getNumParams)
504 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, hasExtParameterInfos)
506 ArrayRef<FunctionProtoType::ExtParameterInfo>, getExtParameterInfos)
507
508 CanQualType getParamType(unsigned i) const {
510 }
511
514
517
518 param_type_iterator param_type_begin() const {
519 return param_type_iterator(this->getTypePtr()->param_type_begin());
520 }
521
523 return param_type_iterator(this->getTypePtr()->param_type_end());
524 }
525
526 // Note: canonical function types never have exception specifications
527};
528
529template<>
530struct CanProxyAdaptor<TypeOfType> : public CanProxyBase<TypeOfType> {
531 LLVM_CLANG_CANPROXY_TYPE_ACCESSOR(getUnmodifiedType)
532};
533
534template<>
535struct CanProxyAdaptor<DecltypeType> : public CanProxyBase<DecltypeType> {
536 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(Expr *, getUnderlyingExpr)
538};
539
540template <>
542 : public CanProxyBase<UnaryTransformType> {
546};
547
548template<>
549struct CanProxyAdaptor<TagType> : public CanProxyBase<TagType> {
551 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isBeingDefined)
552};
553
554template<>
555struct CanProxyAdaptor<RecordType> : public CanProxyBase<RecordType> {
557 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isBeingDefined)
558 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, hasConstFields)
559};
560
561template<>
562struct CanProxyAdaptor<EnumType> : public CanProxyBase<EnumType> {
564 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isBeingDefined)
565};
566
567template<>
569 : public CanProxyBase<TemplateTypeParmType> {
570 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(unsigned, getDepth)
571 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(unsigned, getIndex)
575};
576
577template<>
579 : public CanProxyBase<ObjCObjectType> {
582 getInterface)
583 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isObjCUnqualifiedId)
584 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isObjCUnqualifiedClass)
585 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isObjCQualifiedId)
586 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isObjCQualifiedClass)
587
588 using qual_iterator = ObjCObjectPointerType::qual_iterator;
589
590 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(qual_iterator, qual_begin)
591 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(qual_iterator, qual_end)
593 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(unsigned, getNumProtocols)
594};
595
596template<>
601 getInterfaceType)
602 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isObjCIdType)
603 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isObjCClassType)
604 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isObjCQualifiedIdType)
605 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(bool, isObjCQualifiedClassType)
606
607 using qual_iterator = ObjCObjectPointerType::qual_iterator;
608
609 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(qual_iterator, qual_begin)
610 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(qual_iterator, qual_end)
612 LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(unsigned, getNumProtocols)
613};
614
615//----------------------------------------------------------------------------//
616// Method and function definitions
617//----------------------------------------------------------------------------//
618template<typename T>
619inline CanQual<T> CanQual<T>::getUnqualifiedType() const {
620 return CanQual<T>::CreateUnsafe(Stored.getLocalUnqualifiedType());
621}
622
623template<typename T>
625 if (CanQual<ReferenceType> RefType = getAs<ReferenceType>())
626 return RefType->getPointeeType();
627 else
628 return *this;
629}
630
631template<typename T>
635 assert((!Result || Result.Stored.getAsOpaquePtr() == (void*)-1 ||
636 Result.Stored.isCanonical()) && "Type is not canonical!");
637 return Result;
638}
639
640template<typename T>
642 assert((Other.isNull() || Other.isCanonical()) && "Type is not canonical!");
643 assert((Other.isNull() || isa<T>(Other.getTypePtr())) &&
644 "Dynamic type does not meet the static type's requires");
646 Result.Stored = Other;
647 return Result;
648}
649
650template<typename T>
651template<typename U>
653 static_assert(!TypeIsArrayType<T>::value,
654 "ArrayType cannot be used with getAs!");
655
656 if (Stored.isNull())
657 return CanProxy<U>();
658
659 if (isa<U>(Stored.getTypePtr()))
661
662 return CanProxy<U>();
663}
664
665template<typename T>
666template<typename U>
668 static_assert(!TypeIsArrayType<U>::value,
669 "ArrayType cannot be used with castAs!");
670
671 assert(!Stored.isNull() && isa<U>(Stored.getTypePtr()));
673}
674
675template<typename T>
677 return CanProxy<T>(*this);
678}
679
680template <typename InputIterator>
682 return CanProxy<Type>(*this);
683}
684
685} // namespace clang
686
687#endif // LLVM_CLANG_AST_CANONICALTYPE_H
StringRef P
static char ID
Definition: Arena.cpp:183
Defines the Diagnostic-related interfaces.
static bool isBooleanType(QualType Ty)
#define LLVM_CLANG_CANPROXY_TYPE_ACCESSOR(Accessor)
#define LLVM_CLANG_CANPROXY_SIMPLE_ACCESSOR(Type, Accessor)
unsigned Iter
Definition: HTMLLogger.cpp:154
static StringRef getIdentifier(const Token &Tok)
static QualType getUnderlyingType(const SubRegion *R)
static QualType getParamType(Sema &SemaRef, ArrayRef< ResultCandidate > Candidates, unsigned N)
Get the type of the Nth parameter from a given set of overload candidates.
static bool isParameterPack(Expr *PackExpression)
Defines the clang::SourceLocation class and associated facilities.
C Language Family Type Representation.
Represents an array type, per C99 6.7.5.2 - Array Declarators.
Definition: Type.h:3308
Pointer to a block type.
Definition: Type.h:3139
Represents a C++ struct/union/class.
Definition: DeclCXX.h:258
Base class of all canonical proxy types, which is responsible for storing the underlying canonical ty...
CanProxy< U > getAs() const
Try to convert the given canonical type to a specific structural type.
const T * getTypePtr() const
Retrieve the pointer to the underlying Type.
CanQual< T > Stored
Canonical proxy type returned when retrieving the members of a canonical type or as the result of the...
CanProxy(CanQual< T > Stored)
Build a proxy to the given canonical type.
CanProxy()=default
Build a NULL proxy.
Represents a canonical, potentially-qualified type.
Definition: CanonicalType.h:65
bool isMoreQualifiedThan(CanQual< T > Other) const
Determines whether this canonical type is more qualified than the Other canonical type.
void * getAsOpaquePtr() const
Retrieve the internal representation of this canonical type.
CanQual< Type > getNonReferenceType() const
If the canonical type is a reference type, returns the type that it refers to; otherwise,...
CanQual()=default
Constructs a NULL canonical type.
const T * getTypePtrOrNull() const
Retrieve the underlying type pointer, which refers to a canonical type, or nullptr.
Definition: CanonicalType.h:87
bool isRestrictQualified() const
unsigned getCVRQualifiers() const
Retrieve the const/volatile/restrict qualifiers.
CanProxy< T > operator->() const
Overloaded arrow operator that produces a canonical type proxy.
SplitQualType split() const
bool hasQualifiers() const
Determines whether this type has any qualifiers.
static CanQual< T > CreateUnsafe(QualType Other)
Builds a canonical type from a QualType.
QualType withConst() const
Retrieves a version of this type with const applied.
CanQual(const CanQual< U > &Other, std::enable_if_t< std::is_base_of< T, U >::value, int >=0)
Converting constructor that permits implicit upcasting of canonical type pointers.
CanProxy< U > castAs() const
CanQual< T > getUnqualifiedType() const
Retrieve the unqualified form of this type.
void dump() const
bool isConstQualified() const
bool isNull() const
Definition: CanonicalType.h:97
bool isCanonicalAsParam() const
Determines if this canonical type is furthermore canonical as a parameter.
Qualifiers getQualifiers() const
Retrieve all qualifiers.
void Profile(llvm::FoldingSetNodeID &ID) const
CanProxy< U > getAs() const
Retrieve a canonical type pointer with a different static type, upcasting or downcasting as needed.
static CanQual< T > getFromOpaquePtr(void *Ptr)
Construct a canonical type from its internal representation.
bool isAtLeastAsQualifiedAs(CanQual< T > Other) const
Determines whether this canonical type is at least as qualified as the Other canonical type.
bool isVolatileQualified() const
const T * getTypePtr() const
Retrieve the underlying type pointer, which refers to a canonical type.
Definition: CanonicalType.h:83
Complex values, per C99 6.2.5p11.
Definition: Type.h:2876
Represents the canonical version of C arrays with a specified constant size.
Definition: Type.h:3346
Represents the type decltype(expr) (C++11).
Definition: Type.h:5148
Represents an array type in C++ whose size is a value-dependent expression.
Definition: Type.h:3591
Represents an extended vector type where either the type or size is dependent.
Definition: Type.h:3689
Represents an enum.
Definition: Decl.h:3847
A helper class that allows the use of isa/cast/dyncast to detect TagType objects of enums.
Definition: Type.h:5365
This represents one expression.
Definition: Expr.h:110
ExtVectorType - Extended vector type.
Definition: Type.h:3851
Represents a K&R-style 'int foo()' function, which has no information available about its arguments.
Definition: Type.h:4401
Represents a prototype with parameter type info, e.g.
Definition: Type.h:4446
A class which abstracts out some details necessary for making a call.
Definition: Type.h:4157
FunctionType - C99 6.7.5.3 - Function Declarators.
Definition: Type.h:4046
One of these records is kept for each identifier that is lexed.
Represents a C array with an unspecified size.
Definition: Type.h:3493
An lvalue reference type, per C++11 [dcl.ref].
Definition: Type.h:3214
A pointer to member type per C++ 8.3.3 - Pointers to members.
Definition: Type.h:3250
Represents an ObjC class declaration.
Definition: DeclObjC.h:1152
Interfaces are the core concept in Objective-C for object oriented design.
Definition: Type.h:6742
Represents a pointer to an Objective C object.
Definition: Type.h:6798
Represents a class type in Objective C.
Definition: Type.h:6544
PointerType - C99 6.7.5.1 - Pointer Declarators.
Definition: Type.h:2929
A (possibly-)qualified type.
Definition: Type.h:738
bool isLocalConstQualified() const
Determine whether this particular QualType instance has the "const" qualifier set,...
Definition: Type.h:815
bool isLocalRestrictQualified() const
Determine whether this particular QualType instance has the "restrict" qualifier set,...
Definition: Type.h:845
QualType withConst() const
Definition: Type.h:952
bool isAtLeastAsQualifiedAs(QualType Other) const
Determine whether this type is at least as qualified as the other given type, requiring exact equalit...
Definition: Type.h:7331
bool hasLocalQualifiers() const
Determine whether this particular QualType instance has any qualifiers, without looking through any t...
Definition: Type.h:865
bool isNull() const
Return true if this QualType doesn't point to a type yet.
Definition: Type.h:805
const Type * getTypePtr() const
Retrieves a pointer to the underlying (unqualified) type.
Definition: Type.h:7149
static QualType getFromOpaquePtr(const void *Ptr)
Definition: Type.h:787
void dump(const char *s) const
Definition: ASTDumper.cpp:179
unsigned getLocalCVRQualifiers() const
Retrieve the set of CVR (const-volatile-restrict) qualifiers local to this particular QualType instan...
Definition: Type.h:890
SplitQualType split() const
Divides a QualType into its unqualified type and a set of local qualifiers.
Definition: Type.h:7170
void * getAsOpaquePtr() const
Definition: Type.h:785
bool isCanonicalAsParam() const
Definition: Type.h:7210
bool isMoreQualifiedThan(QualType Other) const
Determine whether this type is more qualified than the other given type, requiring exact equality for...
Definition: Type.h:7321
bool isLocalVolatileQualified() const
Determine whether this particular QualType instance has the "volatile" qualifier set,...
Definition: Type.h:855
const Type * getTypePtrOrNull() const
Definition: Type.h:7153
Qualifiers getLocalQualifiers() const
Retrieve the set of qualifiers local to this particular QualType instance, not including any qualifie...
Definition: Type.h:7181
The collection of all-type qualifiers we support.
Definition: Type.h:148
An rvalue reference type, per C++11 [dcl.ref].
Definition: Type.h:3232
Represents a struct/union/class.
Definition: Decl.h:4148
A helper class that allows the use of isa/cast/dyncast to detect TagType objects of structs/unions/cl...
Definition: Type.h:5339
Base for LValueReferenceType and RValueReferenceType.
Definition: Type.h:3170
Encodes a location in the source.
The streaming interface shared between DiagnosticBuilder and PartialDiagnostic.
Definition: Diagnostic.h:1115
Represents the declaration of a struct/union/class/enum.
Definition: Decl.h:3564
Declaration of a template type parameter.
Represents typeof(type), a C23 feature and GCC extension, or `typeof_unqual(type),...
Definition: Type.h:5112
The base class of the type hierarchy.
Definition: Type.h:1607
CanQualType getCanonicalTypeUnqualified() const
QualType getCanonicalTypeInternal() const
Definition: Type.h:2726
A unary type transform, which is a type constructed from another.
Definition: Type.h:5256
Represents a C array with a specified size that is not an integer-constant-expression.
Definition: Type.h:3537
Represents a GCC generic vector type.
Definition: Type.h:3759
The JSON file list parser is used to communicate input to InstallAPI.
bool operator==(const CallGraphNode::CallRecord &LHS, const CallGraphNode::CallRecord &RHS)
Definition: CallGraph.h:207
const StreamingDiagnostic & operator<<(const StreamingDiagnostic &DB, const ASTContext::SectionInfo &Section)
Insertion operator for diagnostics.
@ Result
The result type of a method or function.
bool operator!=(CanQual< T > x, CanQual< U > y)
std::integral_constant< bool, std::is_same< T, ArrayType >::value||std::is_base_of< ArrayType, T >::value > TypeIsArrayType
Definition: Type.h:7910
const FunctionProtoType * T
@ Other
Other implicit parameter.
Diagnostic wrappers for TextAPI types for error reporting.
Definition: Dominators.h:30
Definition: Format.h:5394
#define bool
Definition: stdbool.h:20
param_type_iterator param_type_end() const
Replaceable canonical proxy adaptor class that provides the link between a canonical type and the acc...
Iterator adaptor that turns an iterator over canonical QualTypes into an iterator over CanQualTypes.
CanQualType operator*() const
CanProxy< Type > operator->() const
CanTypeIterator(InputIterator Iter)
A std::pair-like structure for storing a qualified type split into its local qualifiers and its local...
Definition: Type.h:671
static clang::CanQual< T > getFromVoidPointer(void *P)
static void * getAsVoidPointer(clang::CanQual< T > P)
static SimpleType getSimplifiedValue(::clang::CanQual< T > Val)