Bug Summary

File:clang/lib/AST/ASTDiagnostic.cpp
Warning:line 307, column 28
Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name ASTDiagnostic.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mthread-model posix -mframe-pointer=none -relaxed-aliasing -fmath-errno -fno-rounding-math -masm-verbose -mconstructor-aliases -munwind-tables -target-cpu x86-64 -dwarf-column-info -fno-split-dwarf-inlining -debugger-tuning=gdb -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-10/lib/clang/10.0.0 -D CLANG_VENDOR="Debian " -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/build-llvm/tools/clang/lib/AST -I /build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST -I /build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include -I /build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/build-llvm/tools/clang/include -I /build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/build-llvm/include -I /build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/llvm/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-10/lib/clang/10.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/build-llvm/tools/clang/lib/AST -fdebug-prefix-map=/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd=. -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fobjc-runtime=gcc -fno-common -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -o /tmp/scan-build-2020-01-13-084841-49055-1 -x c++ /build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp

/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp

1//===--- ASTDiagnostic.cpp - Diagnostic Printing Hooks for AST Nodes ------===//
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 a diagnostic formatting hook for AST elements.
10//
11//===----------------------------------------------------------------------===//
12
13#include "clang/AST/ASTDiagnostic.h"
14#include "clang/AST/ASTContext.h"
15#include "clang/AST/ASTLambda.h"
16#include "clang/AST/Attr.h"
17#include "clang/AST/DeclObjC.h"
18#include "clang/AST/DeclTemplate.h"
19#include "clang/AST/ExprCXX.h"
20#include "clang/AST/TemplateBase.h"
21#include "clang/AST/Type.h"
22#include "llvm/Support/raw_ostream.h"
23
24using namespace clang;
25
26// Returns a desugared version of the QualType, and marks ShouldAKA as true
27// whenever we remove significant sugar from the type.
28static QualType Desugar(ASTContext &Context, QualType QT, bool &ShouldAKA) {
29 QualifierCollector QC;
30
31 while (true) {
32 const Type *Ty = QC.strip(QT);
33
34 // Don't aka just because we saw an elaborated type...
35 if (const ElaboratedType *ET = dyn_cast<ElaboratedType>(Ty)) {
36 QT = ET->desugar();
37 continue;
38 }
39 // ... or a paren type ...
40 if (const ParenType *PT = dyn_cast<ParenType>(Ty)) {
41 QT = PT->desugar();
42 continue;
43 }
44 // ... or a macro defined type ...
45 if (const MacroQualifiedType *MDT = dyn_cast<MacroQualifiedType>(Ty)) {
46 QT = MDT->desugar();
47 continue;
48 }
49 // ...or a substituted template type parameter ...
50 if (const SubstTemplateTypeParmType *ST =
51 dyn_cast<SubstTemplateTypeParmType>(Ty)) {
52 QT = ST->desugar();
53 continue;
54 }
55 // ...or an attributed type...
56 if (const AttributedType *AT = dyn_cast<AttributedType>(Ty)) {
57 QT = AT->desugar();
58 continue;
59 }
60 // ...or an adjusted type...
61 if (const AdjustedType *AT = dyn_cast<AdjustedType>(Ty)) {
62 QT = AT->desugar();
63 continue;
64 }
65 // ... or an auto type.
66 if (const AutoType *AT = dyn_cast<AutoType>(Ty)) {
67 if (!AT->isSugared())
68 break;
69 QT = AT->desugar();
70 continue;
71 }
72
73 // Desugar FunctionType if return type or any parameter type should be
74 // desugared. Preserve nullability attribute on desugared types.
75 if (const FunctionType *FT = dyn_cast<FunctionType>(Ty)) {
76 bool DesugarReturn = false;
77 QualType SugarRT = FT->getReturnType();
78 QualType RT = Desugar(Context, SugarRT, DesugarReturn);
79 if (auto nullability = AttributedType::stripOuterNullability(SugarRT)) {
80 RT = Context.getAttributedType(
81 AttributedType::getNullabilityAttrKind(*nullability), RT, RT);
82 }
83
84 bool DesugarArgument = false;
85 SmallVector<QualType, 4> Args;
86 const FunctionProtoType *FPT = dyn_cast<FunctionProtoType>(FT);
87 if (FPT) {
88 for (QualType SugarPT : FPT->param_types()) {
89 QualType PT = Desugar(Context, SugarPT, DesugarArgument);
90 if (auto nullability =
91 AttributedType::stripOuterNullability(SugarPT)) {
92 PT = Context.getAttributedType(
93 AttributedType::getNullabilityAttrKind(*nullability), PT, PT);
94 }
95 Args.push_back(PT);
96 }
97 }
98
99 if (DesugarReturn || DesugarArgument) {
100 ShouldAKA = true;
101 QT = FPT ? Context.getFunctionType(RT, Args, FPT->getExtProtoInfo())
102 : Context.getFunctionNoProtoType(RT, FT->getExtInfo());
103 break;
104 }
105 }
106
107 // Desugar template specializations if any template argument should be
108 // desugared.
109 if (const TemplateSpecializationType *TST =
110 dyn_cast<TemplateSpecializationType>(Ty)) {
111 if (!TST->isTypeAlias()) {
112 bool DesugarArgument = false;
113 SmallVector<TemplateArgument, 4> Args;
114 for (unsigned I = 0, N = TST->getNumArgs(); I != N; ++I) {
115 const TemplateArgument &Arg = TST->getArg(I);
116 if (Arg.getKind() == TemplateArgument::Type)
117 Args.push_back(Desugar(Context, Arg.getAsType(), DesugarArgument));
118 else
119 Args.push_back(Arg);
120 }
121
122 if (DesugarArgument) {
123 ShouldAKA = true;
124 QT = Context.getTemplateSpecializationType(
125 TST->getTemplateName(), Args, QT);
126 }
127 break;
128 }
129 }
130
131 // Don't desugar magic Objective-C types.
132 if (QualType(Ty,0) == Context.getObjCIdType() ||
133 QualType(Ty,0) == Context.getObjCClassType() ||
134 QualType(Ty,0) == Context.getObjCSelType() ||
135 QualType(Ty,0) == Context.getObjCProtoType())
136 break;
137
138 // Don't desugar va_list.
139 if (QualType(Ty, 0) == Context.getBuiltinVaListType() ||
140 QualType(Ty, 0) == Context.getBuiltinMSVaListType())
141 break;
142
143 // Otherwise, do a single-step desugar.
144 QualType Underlying;
145 bool IsSugar = false;
146 switch (Ty->getTypeClass()) {
147#define ABSTRACT_TYPE(Class, Base)
148#define TYPE(Class, Base) \
149case Type::Class: { \
150const Class##Type *CTy = cast<Class##Type>(Ty); \
151if (CTy->isSugared()) { \
152IsSugar = true; \
153Underlying = CTy->desugar(); \
154} \
155break; \
156}
157#include "clang/AST/TypeNodes.inc"
158 }
159
160 // If it wasn't sugared, we're done.
161 if (!IsSugar)
162 break;
163
164 // If the desugared type is a vector type, we don't want to expand
165 // it, it will turn into an attribute mess. People want their "vec4".
166 if (isa<VectorType>(Underlying))
167 break;
168
169 // Don't desugar through the primary typedef of an anonymous type.
170 if (const TagType *UTT = Underlying->getAs<TagType>())
171 if (const TypedefType *QTT = dyn_cast<TypedefType>(QT))
172 if (UTT->getDecl()->getTypedefNameForAnonDecl() == QTT->getDecl())
173 break;
174
175 // Record that we actually looked through an opaque type here.
176 ShouldAKA = true;
177 QT = Underlying;
178 }
179
180 // If we have a pointer-like type, desugar the pointee as well.
181 // FIXME: Handle other pointer-like types.
182 if (const PointerType *Ty = QT->getAs<PointerType>()) {
183 QT = Context.getPointerType(Desugar(Context, Ty->getPointeeType(),
184 ShouldAKA));
185 } else if (const auto *Ty = QT->getAs<ObjCObjectPointerType>()) {
186 QT = Context.getObjCObjectPointerType(Desugar(Context, Ty->getPointeeType(),
187 ShouldAKA));
188 } else if (const LValueReferenceType *Ty = QT->getAs<LValueReferenceType>()) {
189 QT = Context.getLValueReferenceType(Desugar(Context, Ty->getPointeeType(),
190 ShouldAKA));
191 } else if (const RValueReferenceType *Ty = QT->getAs<RValueReferenceType>()) {
192 QT = Context.getRValueReferenceType(Desugar(Context, Ty->getPointeeType(),
193 ShouldAKA));
194 } else if (const auto *Ty = QT->getAs<ObjCObjectType>()) {
195 if (Ty->getBaseType().getTypePtr() != Ty && !ShouldAKA) {
196 QualType BaseType = Desugar(Context, Ty->getBaseType(), ShouldAKA);
197 QT = Context.getObjCObjectType(BaseType, Ty->getTypeArgsAsWritten(),
198 llvm::makeArrayRef(Ty->qual_begin(),
199 Ty->getNumProtocols()),
200 Ty->isKindOfTypeAsWritten());
201 }
202 }
203
204 return QC.apply(Context, QT);
205}
206
207/// Convert the given type to a string suitable for printing as part of
208/// a diagnostic.
209///
210/// There are four main criteria when determining whether we should have an
211/// a.k.a. clause when pretty-printing a type:
212///
213/// 1) Some types provide very minimal sugar that doesn't impede the
214/// user's understanding --- for example, elaborated type
215/// specifiers. If this is all the sugar we see, we don't want an
216/// a.k.a. clause.
217/// 2) Some types are technically sugared but are much more familiar
218/// when seen in their sugared form --- for example, va_list,
219/// vector types, and the magic Objective C types. We don't
220/// want to desugar these, even if we do produce an a.k.a. clause.
221/// 3) Some types may have already been desugared previously in this diagnostic.
222/// if this is the case, doing another "aka" would just be clutter.
223/// 4) Two different types within the same diagnostic have the same output
224/// string. In this case, force an a.k.a with the desugared type when
225/// doing so will provide additional information.
226///
227/// \param Context the context in which the type was allocated
228/// \param Ty the type to print
229/// \param QualTypeVals pointer values to QualTypes which are used in the
230/// diagnostic message
231static std::string
232ConvertTypeToDiagnosticString(ASTContext &Context, QualType Ty,
233 ArrayRef<DiagnosticsEngine::ArgumentValue> PrevArgs,
234 ArrayRef<intptr_t> QualTypeVals) {
235 // FIXME: Playing with std::string is really slow.
236 bool ForceAKA = false;
237 QualType CanTy = Ty.getCanonicalType();
238 std::string S = Ty.getAsString(Context.getPrintingPolicy());
239 std::string CanS = CanTy.getAsString(Context.getPrintingPolicy());
240
241 for (unsigned I = 0, E = QualTypeVals.size(); I != E; ++I) {
6
Assuming 'I' is equal to 'E'
7
Loop condition is false. Execution continues on line 271
242 QualType CompareTy =
243 QualType::getFromOpaquePtr(reinterpret_cast<void*>(QualTypeVals[I]));
244 if (CompareTy.isNull())
245 continue;
246 if (CompareTy == Ty)
247 continue; // Same types
248 QualType CompareCanTy = CompareTy.getCanonicalType();
249 if (CompareCanTy == CanTy)
250 continue; // Same canonical types
251 std::string CompareS = CompareTy.getAsString(Context.getPrintingPolicy());
252 bool ShouldAKA = false;
253 QualType CompareDesugar = Desugar(Context, CompareTy, ShouldAKA);
254 std::string CompareDesugarStr =
255 CompareDesugar.getAsString(Context.getPrintingPolicy());
256 if (CompareS != S && CompareDesugarStr != S)
257 continue; // The type string is different than the comparison string
258 // and the desugared comparison string.
259 std::string CompareCanS =
260 CompareCanTy.getAsString(Context.getPrintingPolicy());
261
262 if (CompareCanS == CanS)
263 continue; // No new info from canonical type
264
265 ForceAKA = true;
266 break;
267 }
268
269 // Check to see if we already desugared this type in this
270 // diagnostic. If so, don't do it again.
271 bool Repeated = false;
272 for (unsigned i = 0, e = PrevArgs.size(); i != e; ++i) {
8
Assuming 'i' is equal to 'e'
9
Loop condition is false. Execution continues on line 286
273 // TODO: Handle ak_declcontext case.
274 if (PrevArgs[i].first == DiagnosticsEngine::ak_qualtype) {
275 void *Ptr = (void*)PrevArgs[i].second;
276 QualType PrevTy(QualType::getFromOpaquePtr(Ptr));
277 if (PrevTy == Ty) {
278 Repeated = true;
279 break;
280 }
281 }
282 }
283
284 // Consider producing an a.k.a. clause if removing all the direct
285 // sugar gives us something "significantly different".
286 if (!Repeated
9.1
'Repeated' is false
9.1
'Repeated' is false
) {
10
Taking true branch
287 bool ShouldAKA = false;
288 QualType DesugaredTy = Desugar(Context, Ty, ShouldAKA);
289 if (ShouldAKA || ForceAKA
11.1
'ForceAKA' is false
11.1
'ForceAKA' is false
) {
11
Assuming 'ShouldAKA' is false
12
Taking false branch
290 if (DesugaredTy == Ty) {
291 DesugaredTy = Ty.getCanonicalType();
292 }
293 std::string akaStr = DesugaredTy.getAsString(Context.getPrintingPolicy());
294 if (akaStr != S) {
295 S = "'" + S + "' (aka '" + akaStr + "')";
296 return S;
297 }
298 }
299
300 // Give some additional info on vector types. These are either not desugared
301 // or displaying complex __attribute__ expressions so add details of the
302 // type and element count.
303 if (Ty->isVectorType()) {
13
Calling 'Type::isVectorType'
16
Returning from 'Type::isVectorType'
17
Taking true branch
304 const VectorType *VTy = Ty->getAs<VectorType>();
18
Assuming the object is not a 'VectorType'
19
'VTy' initialized to a null pointer value
305 std::string DecoratedString;
306 llvm::raw_string_ostream OS(DecoratedString);
307 const char *Values = VTy->getNumElements() > 1 ? "values" : "value";
20
Called C++ object pointer is null
308 OS << "'" << S << "' (vector of " << VTy->getNumElements() << " '"
309 << VTy->getElementType().getAsString(Context.getPrintingPolicy())
310 << "' " << Values << ")";
311 return OS.str();
312 }
313 }
314
315 S = "'" + S + "'";
316 return S;
317}
318
319static bool FormatTemplateTypeDiff(ASTContext &Context, QualType FromType,
320 QualType ToType, bool PrintTree,
321 bool PrintFromType, bool ElideType,
322 bool ShowColors, raw_ostream &OS);
323
324void clang::FormatASTNodeDiagnosticArgument(
325 DiagnosticsEngine::ArgumentKind Kind,
326 intptr_t Val,
327 StringRef Modifier,
328 StringRef Argument,
329 ArrayRef<DiagnosticsEngine::ArgumentValue> PrevArgs,
330 SmallVectorImpl<char> &Output,
331 void *Cookie,
332 ArrayRef<intptr_t> QualTypeVals) {
333 ASTContext &Context = *static_cast<ASTContext*>(Cookie);
334
335 size_t OldEnd = Output.size();
336 llvm::raw_svector_ostream OS(Output);
337 bool NeedQuotes = true;
338
339 switch (Kind) {
1
Control jumps to 'case ak_qualtype:' at line 398
340 default: llvm_unreachable("unknown ArgumentKind")::llvm::llvm_unreachable_internal("unknown ArgumentKind", "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 340)
;
341 case DiagnosticsEngine::ak_addrspace: {
342 assert(Modifier.empty() && Argument.empty() &&((Modifier.empty() && Argument.empty() && "Invalid modifier for Qualfiers argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for Qualfiers argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 343, __PRETTY_FUNCTION__))
343 "Invalid modifier for Qualfiers argument")((Modifier.empty() && Argument.empty() && "Invalid modifier for Qualfiers argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for Qualfiers argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 343, __PRETTY_FUNCTION__))
;
344
345 auto S = Qualifiers::getAddrSpaceAsString(static_cast<LangAS>(Val));
346 if (S.empty()) {
347 OS << (Context.getLangOpts().OpenCL ? "default" : "generic");
348 OS << " address space";
349 } else {
350 OS << "address space";
351 OS << " '" << S << "'";
352 }
353 NeedQuotes = false;
354 break;
355 }
356 case DiagnosticsEngine::ak_qual: {
357 assert(Modifier.empty() && Argument.empty() &&((Modifier.empty() && Argument.empty() && "Invalid modifier for Qualfiers argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for Qualfiers argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 358, __PRETTY_FUNCTION__))
358 "Invalid modifier for Qualfiers argument")((Modifier.empty() && Argument.empty() && "Invalid modifier for Qualfiers argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for Qualfiers argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 358, __PRETTY_FUNCTION__))
;
359
360 Qualifiers Q(Qualifiers::fromOpaqueValue(Val));
361 auto S = Q.getAsString();
362 if (S.empty()) {
363 OS << "unqualified";
364 NeedQuotes = false;
365 } else {
366 OS << S;
367 }
368 break;
369 }
370 case DiagnosticsEngine::ak_qualtype_pair: {
371 TemplateDiffTypes &TDT = *reinterpret_cast<TemplateDiffTypes*>(Val);
372 QualType FromType =
373 QualType::getFromOpaquePtr(reinterpret_cast<void*>(TDT.FromType));
374 QualType ToType =
375 QualType::getFromOpaquePtr(reinterpret_cast<void*>(TDT.ToType));
376
377 if (FormatTemplateTypeDiff(Context, FromType, ToType, TDT.PrintTree,
378 TDT.PrintFromType, TDT.ElideType,
379 TDT.ShowColors, OS)) {
380 NeedQuotes = !TDT.PrintTree;
381 TDT.TemplateDiffUsed = true;
382 break;
383 }
384
385 // Don't fall-back during tree printing. The caller will handle
386 // this case.
387 if (TDT.PrintTree)
388 return;
389
390 // Attempting to do a template diff on non-templates. Set the variables
391 // and continue with regular type printing of the appropriate type.
392 Val = TDT.PrintFromType ? TDT.FromType : TDT.ToType;
393 Modifier = StringRef();
394 Argument = StringRef();
395 // Fall through
396 LLVM_FALLTHROUGH[[gnu::fallthrough]];
397 }
398 case DiagnosticsEngine::ak_qualtype: {
399 assert(Modifier.empty() && Argument.empty() &&((Modifier.empty() && Argument.empty() && "Invalid modifier for QualType argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for QualType argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 400, __PRETTY_FUNCTION__))
2
Assuming the condition is true
3
Assuming the condition is true
4
'?' condition is true
400 "Invalid modifier for QualType argument")((Modifier.empty() && Argument.empty() && "Invalid modifier for QualType argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for QualType argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 400, __PRETTY_FUNCTION__))
;
401
402 QualType Ty(QualType::getFromOpaquePtr(reinterpret_cast<void*>(Val)));
403 OS << ConvertTypeToDiagnosticString(Context, Ty, PrevArgs, QualTypeVals);
5
Calling 'ConvertTypeToDiagnosticString'
404 NeedQuotes = false;
405 break;
406 }
407 case DiagnosticsEngine::ak_declarationname: {
408 if (Modifier == "objcclass" && Argument.empty())
409 OS << '+';
410 else if (Modifier == "objcinstance" && Argument.empty())
411 OS << '-';
412 else
413 assert(Modifier.empty() && Argument.empty() &&((Modifier.empty() && Argument.empty() && "Invalid modifier for DeclarationName argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for DeclarationName argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 414, __PRETTY_FUNCTION__))
414 "Invalid modifier for DeclarationName argument")((Modifier.empty() && Argument.empty() && "Invalid modifier for DeclarationName argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for DeclarationName argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 414, __PRETTY_FUNCTION__))
;
415
416 OS << DeclarationName::getFromOpaqueInteger(Val);
417 break;
418 }
419 case DiagnosticsEngine::ak_nameddecl: {
420 bool Qualified;
421 if (Modifier == "q" && Argument.empty())
422 Qualified = true;
423 else {
424 assert(Modifier.empty() && Argument.empty() &&((Modifier.empty() && Argument.empty() && "Invalid modifier for NamedDecl* argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for NamedDecl* argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 425, __PRETTY_FUNCTION__))
425 "Invalid modifier for NamedDecl* argument")((Modifier.empty() && Argument.empty() && "Invalid modifier for NamedDecl* argument"
) ? static_cast<void> (0) : __assert_fail ("Modifier.empty() && Argument.empty() && \"Invalid modifier for NamedDecl* argument\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 425, __PRETTY_FUNCTION__))
;
426 Qualified = false;
427 }
428 const NamedDecl *ND = reinterpret_cast<const NamedDecl*>(Val);
429 ND->getNameForDiagnostic(OS, Context.getPrintingPolicy(), Qualified);
430 break;
431 }
432 case DiagnosticsEngine::ak_nestednamespec: {
433 NestedNameSpecifier *NNS = reinterpret_cast<NestedNameSpecifier*>(Val);
434 NNS->print(OS, Context.getPrintingPolicy());
435 NeedQuotes = false;
436 break;
437 }
438 case DiagnosticsEngine::ak_declcontext: {
439 DeclContext *DC = reinterpret_cast<DeclContext *> (Val);
440 assert(DC && "Should never have a null declaration context")((DC && "Should never have a null declaration context"
) ? static_cast<void> (0) : __assert_fail ("DC && \"Should never have a null declaration context\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 440, __PRETTY_FUNCTION__))
;
441 NeedQuotes = false;
442
443 // FIXME: Get the strings for DeclContext from some localized place
444 if (DC->isTranslationUnit()) {
445 if (Context.getLangOpts().CPlusPlus)
446 OS << "the global namespace";
447 else
448 OS << "the global scope";
449 } else if (DC->isClosure()) {
450 OS << "block literal";
451 } else if (isLambdaCallOperator(DC)) {
452 OS << "lambda expression";
453 } else if (TypeDecl *Type = dyn_cast<TypeDecl>(DC)) {
454 OS << ConvertTypeToDiagnosticString(Context,
455 Context.getTypeDeclType(Type),
456 PrevArgs, QualTypeVals);
457 } else {
458 assert(isa<NamedDecl>(DC) && "Expected a NamedDecl")((isa<NamedDecl>(DC) && "Expected a NamedDecl")
? static_cast<void> (0) : __assert_fail ("isa<NamedDecl>(DC) && \"Expected a NamedDecl\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 458, __PRETTY_FUNCTION__))
;
459 NamedDecl *ND = cast<NamedDecl>(DC);
460 if (isa<NamespaceDecl>(ND))
461 OS << "namespace ";
462 else if (isa<ObjCMethodDecl>(ND))
463 OS << "method ";
464 else if (isa<FunctionDecl>(ND))
465 OS << "function ";
466
467 OS << '\'';
468 ND->getNameForDiagnostic(OS, Context.getPrintingPolicy(), true);
469 OS << '\'';
470 }
471 break;
472 }
473 case DiagnosticsEngine::ak_attr: {
474 const Attr *At = reinterpret_cast<Attr *>(Val);
475 assert(At && "Received null Attr object!")((At && "Received null Attr object!") ? static_cast<
void> (0) : __assert_fail ("At && \"Received null Attr object!\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 475, __PRETTY_FUNCTION__))
;
476 OS << '\'' << At->getSpelling() << '\'';
477 NeedQuotes = false;
478 break;
479 }
480 }
481
482 if (NeedQuotes) {
483 Output.insert(Output.begin()+OldEnd, '\'');
484 Output.push_back('\'');
485 }
486}
487
488/// TemplateDiff - A class that constructs a pretty string for a pair of
489/// QualTypes. For the pair of types, a diff tree will be created containing
490/// all the information about the templates and template arguments. Afterwards,
491/// the tree is transformed to a string according to the options passed in.
492namespace {
493class TemplateDiff {
494 /// Context - The ASTContext which is used for comparing template arguments.
495 ASTContext &Context;
496
497 /// Policy - Used during expression printing.
498 PrintingPolicy Policy;
499
500 /// ElideType - Option to elide identical types.
501 bool ElideType;
502
503 /// PrintTree - Format output string as a tree.
504 bool PrintTree;
505
506 /// ShowColor - Diagnostics support color, so bolding will be used.
507 bool ShowColor;
508
509 /// FromTemplateType - When single type printing is selected, this is the
510 /// type to be be printed. When tree printing is selected, this type will
511 /// show up first in the tree.
512 QualType FromTemplateType;
513
514 /// ToTemplateType - The type that FromType is compared to. Only in tree
515 /// printing will this type be outputed.
516 QualType ToTemplateType;
517
518 /// OS - The stream used to construct the output strings.
519 raw_ostream &OS;
520
521 /// IsBold - Keeps track of the bold formatting for the output string.
522 bool IsBold;
523
524 /// DiffTree - A tree representation the differences between two types.
525 class DiffTree {
526 public:
527 /// DiffKind - The difference in a DiffNode. Fields of
528 /// TemplateArgumentInfo needed by each difference can be found in the
529 /// Set* and Get* functions.
530 enum DiffKind {
531 /// Incomplete or invalid node.
532 Invalid,
533 /// Another level of templates
534 Template,
535 /// Type difference, all type differences except those falling under
536 /// the Template difference.
537 Type,
538 /// Expression difference, this is only when both arguments are
539 /// expressions. If one argument is an expression and the other is
540 /// Integer or Declaration, then use that diff type instead.
541 Expression,
542 /// Template argument difference
543 TemplateTemplate,
544 /// Integer difference
545 Integer,
546 /// Declaration difference, nullptr arguments are included here
547 Declaration,
548 /// One argument being integer and the other being declaration
549 FromIntegerAndToDeclaration,
550 FromDeclarationAndToInteger
551 };
552
553 private:
554 /// TemplateArgumentInfo - All the information needed to pretty print
555 /// a template argument. See the Set* and Get* functions to see which
556 /// fields are used for each DiffKind.
557 struct TemplateArgumentInfo {
558 QualType ArgType;
559 Qualifiers Qual;
560 llvm::APSInt Val;
561 bool IsValidInt = false;
562 Expr *ArgExpr = nullptr;
563 TemplateDecl *TD = nullptr;
564 ValueDecl *VD = nullptr;
565 bool NeedAddressOf = false;
566 bool IsNullPtr = false;
567 bool IsDefault = false;
568 };
569
570 /// DiffNode - The root node stores the original type. Each child node
571 /// stores template arguments of their parents. For templated types, the
572 /// template decl is also stored.
573 struct DiffNode {
574 DiffKind Kind = Invalid;
575
576 /// NextNode - The index of the next sibling node or 0.
577 unsigned NextNode = 0;
578
579 /// ChildNode - The index of the first child node or 0.
580 unsigned ChildNode = 0;
581
582 /// ParentNode - The index of the parent node.
583 unsigned ParentNode = 0;
584
585 TemplateArgumentInfo FromArgInfo, ToArgInfo;
586
587 /// Same - Whether the two arguments evaluate to the same value.
588 bool Same = false;
589
590 DiffNode(unsigned ParentNode = 0) : ParentNode(ParentNode) {}
591 };
592
593 /// FlatTree - A flattened tree used to store the DiffNodes.
594 SmallVector<DiffNode, 16> FlatTree;
595
596 /// CurrentNode - The index of the current node being used.
597 unsigned CurrentNode;
598
599 /// NextFreeNode - The index of the next unused node. Used when creating
600 /// child nodes.
601 unsigned NextFreeNode;
602
603 /// ReadNode - The index of the current node being read.
604 unsigned ReadNode;
605
606 public:
607 DiffTree() :
608 CurrentNode(0), NextFreeNode(1) {
609 FlatTree.push_back(DiffNode());
610 }
611
612 // Node writing functions, one for each valid DiffKind element.
613 void SetTemplateDiff(TemplateDecl *FromTD, TemplateDecl *ToTD,
614 Qualifiers FromQual, Qualifiers ToQual,
615 bool FromDefault, bool ToDefault) {
616 assert(FlatTree[CurrentNode].Kind == Invalid && "Node is not empty.")((FlatTree[CurrentNode].Kind == Invalid && "Node is not empty."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Invalid && \"Node is not empty.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 616, __PRETTY_FUNCTION__))
;
617 FlatTree[CurrentNode].Kind = Template;
618 FlatTree[CurrentNode].FromArgInfo.TD = FromTD;
619 FlatTree[CurrentNode].ToArgInfo.TD = ToTD;
620 FlatTree[CurrentNode].FromArgInfo.Qual = FromQual;
621 FlatTree[CurrentNode].ToArgInfo.Qual = ToQual;
622 SetDefault(FromDefault, ToDefault);
623 }
624
625 void SetTypeDiff(QualType FromType, QualType ToType, bool FromDefault,
626 bool ToDefault) {
627 assert(FlatTree[CurrentNode].Kind == Invalid && "Node is not empty.")((FlatTree[CurrentNode].Kind == Invalid && "Node is not empty."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Invalid && \"Node is not empty.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 627, __PRETTY_FUNCTION__))
;
628 FlatTree[CurrentNode].Kind = Type;
629 FlatTree[CurrentNode].FromArgInfo.ArgType = FromType;
630 FlatTree[CurrentNode].ToArgInfo.ArgType = ToType;
631 SetDefault(FromDefault, ToDefault);
632 }
633
634 void SetExpressionDiff(Expr *FromExpr, Expr *ToExpr, bool FromDefault,
635 bool ToDefault) {
636 assert(FlatTree[CurrentNode].Kind == Invalid && "Node is not empty.")((FlatTree[CurrentNode].Kind == Invalid && "Node is not empty."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Invalid && \"Node is not empty.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 636, __PRETTY_FUNCTION__))
;
637 FlatTree[CurrentNode].Kind = Expression;
638 FlatTree[CurrentNode].FromArgInfo.ArgExpr = FromExpr;
639 FlatTree[CurrentNode].ToArgInfo.ArgExpr = ToExpr;
640 SetDefault(FromDefault, ToDefault);
641 }
642
643 void SetTemplateTemplateDiff(TemplateDecl *FromTD, TemplateDecl *ToTD,
644 bool FromDefault, bool ToDefault) {
645 assert(FlatTree[CurrentNode].Kind == Invalid && "Node is not empty.")((FlatTree[CurrentNode].Kind == Invalid && "Node is not empty."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Invalid && \"Node is not empty.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 645, __PRETTY_FUNCTION__))
;
646 FlatTree[CurrentNode].Kind = TemplateTemplate;
647 FlatTree[CurrentNode].FromArgInfo.TD = FromTD;
648 FlatTree[CurrentNode].ToArgInfo.TD = ToTD;
649 SetDefault(FromDefault, ToDefault);
650 }
651
652 void SetIntegerDiff(const llvm::APSInt &FromInt, const llvm::APSInt &ToInt,
653 bool IsValidFromInt, bool IsValidToInt,
654 QualType FromIntType, QualType ToIntType,
655 Expr *FromExpr, Expr *ToExpr, bool FromDefault,
656 bool ToDefault) {
657 assert(FlatTree[CurrentNode].Kind == Invalid && "Node is not empty.")((FlatTree[CurrentNode].Kind == Invalid && "Node is not empty."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Invalid && \"Node is not empty.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 657, __PRETTY_FUNCTION__))
;
658 FlatTree[CurrentNode].Kind = Integer;
659 FlatTree[CurrentNode].FromArgInfo.Val = FromInt;
660 FlatTree[CurrentNode].ToArgInfo.Val = ToInt;
661 FlatTree[CurrentNode].FromArgInfo.IsValidInt = IsValidFromInt;
662 FlatTree[CurrentNode].ToArgInfo.IsValidInt = IsValidToInt;
663 FlatTree[CurrentNode].FromArgInfo.ArgType = FromIntType;
664 FlatTree[CurrentNode].ToArgInfo.ArgType = ToIntType;
665 FlatTree[CurrentNode].FromArgInfo.ArgExpr = FromExpr;
666 FlatTree[CurrentNode].ToArgInfo.ArgExpr = ToExpr;
667 SetDefault(FromDefault, ToDefault);
668 }
669
670 void SetDeclarationDiff(ValueDecl *FromValueDecl, ValueDecl *ToValueDecl,
671 bool FromAddressOf, bool ToAddressOf,
672 bool FromNullPtr, bool ToNullPtr, Expr *FromExpr,
673 Expr *ToExpr, bool FromDefault, bool ToDefault) {
674 assert(FlatTree[CurrentNode].Kind == Invalid && "Node is not empty.")((FlatTree[CurrentNode].Kind == Invalid && "Node is not empty."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Invalid && \"Node is not empty.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 674, __PRETTY_FUNCTION__))
;
675 FlatTree[CurrentNode].Kind = Declaration;
676 FlatTree[CurrentNode].FromArgInfo.VD = FromValueDecl;
677 FlatTree[CurrentNode].ToArgInfo.VD = ToValueDecl;
678 FlatTree[CurrentNode].FromArgInfo.NeedAddressOf = FromAddressOf;
679 FlatTree[CurrentNode].ToArgInfo.NeedAddressOf = ToAddressOf;
680 FlatTree[CurrentNode].FromArgInfo.IsNullPtr = FromNullPtr;
681 FlatTree[CurrentNode].ToArgInfo.IsNullPtr = ToNullPtr;
682 FlatTree[CurrentNode].FromArgInfo.ArgExpr = FromExpr;
683 FlatTree[CurrentNode].ToArgInfo.ArgExpr = ToExpr;
684 SetDefault(FromDefault, ToDefault);
685 }
686
687 void SetFromDeclarationAndToIntegerDiff(
688 ValueDecl *FromValueDecl, bool FromAddressOf, bool FromNullPtr,
689 Expr *FromExpr, const llvm::APSInt &ToInt, bool IsValidToInt,
690 QualType ToIntType, Expr *ToExpr, bool FromDefault, bool ToDefault) {
691 assert(FlatTree[CurrentNode].Kind == Invalid && "Node is not empty.")((FlatTree[CurrentNode].Kind == Invalid && "Node is not empty."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Invalid && \"Node is not empty.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 691, __PRETTY_FUNCTION__))
;
692 FlatTree[CurrentNode].Kind = FromDeclarationAndToInteger;
693 FlatTree[CurrentNode].FromArgInfo.VD = FromValueDecl;
694 FlatTree[CurrentNode].FromArgInfo.NeedAddressOf = FromAddressOf;
695 FlatTree[CurrentNode].FromArgInfo.IsNullPtr = FromNullPtr;
696 FlatTree[CurrentNode].FromArgInfo.ArgExpr = FromExpr;
697 FlatTree[CurrentNode].ToArgInfo.Val = ToInt;
698 FlatTree[CurrentNode].ToArgInfo.IsValidInt = IsValidToInt;
699 FlatTree[CurrentNode].ToArgInfo.ArgType = ToIntType;
700 FlatTree[CurrentNode].ToArgInfo.ArgExpr = ToExpr;
701 SetDefault(FromDefault, ToDefault);
702 }
703
704 void SetFromIntegerAndToDeclarationDiff(
705 const llvm::APSInt &FromInt, bool IsValidFromInt, QualType FromIntType,
706 Expr *FromExpr, ValueDecl *ToValueDecl, bool ToAddressOf,
707 bool ToNullPtr, Expr *ToExpr, bool FromDefault, bool ToDefault) {
708 assert(FlatTree[CurrentNode].Kind == Invalid && "Node is not empty.")((FlatTree[CurrentNode].Kind == Invalid && "Node is not empty."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Invalid && \"Node is not empty.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 708, __PRETTY_FUNCTION__))
;
709 FlatTree[CurrentNode].Kind = FromIntegerAndToDeclaration;
710 FlatTree[CurrentNode].FromArgInfo.Val = FromInt;
711 FlatTree[CurrentNode].FromArgInfo.IsValidInt = IsValidFromInt;
712 FlatTree[CurrentNode].FromArgInfo.ArgType = FromIntType;
713 FlatTree[CurrentNode].FromArgInfo.ArgExpr = FromExpr;
714 FlatTree[CurrentNode].ToArgInfo.VD = ToValueDecl;
715 FlatTree[CurrentNode].ToArgInfo.NeedAddressOf = ToAddressOf;
716 FlatTree[CurrentNode].ToArgInfo.IsNullPtr = ToNullPtr;
717 FlatTree[CurrentNode].ToArgInfo.ArgExpr = ToExpr;
718 SetDefault(FromDefault, ToDefault);
719 }
720
721 /// SetDefault - Sets FromDefault and ToDefault flags of the current node.
722 void SetDefault(bool FromDefault, bool ToDefault) {
723 assert((!FromDefault || !ToDefault) && "Both arguments cannot be default.")(((!FromDefault || !ToDefault) && "Both arguments cannot be default."
) ? static_cast<void> (0) : __assert_fail ("(!FromDefault || !ToDefault) && \"Both arguments cannot be default.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 723, __PRETTY_FUNCTION__))
;
724 FlatTree[CurrentNode].FromArgInfo.IsDefault = FromDefault;
725 FlatTree[CurrentNode].ToArgInfo.IsDefault = ToDefault;
726 }
727
728 /// SetSame - Sets the same flag of the current node.
729 void SetSame(bool Same) {
730 FlatTree[CurrentNode].Same = Same;
731 }
732
733 /// SetKind - Sets the current node's type.
734 void SetKind(DiffKind Kind) {
735 FlatTree[CurrentNode].Kind = Kind;
736 }
737
738 /// Up - Changes the node to the parent of the current node.
739 void Up() {
740 assert(FlatTree[CurrentNode].Kind != Invalid &&((FlatTree[CurrentNode].Kind != Invalid && "Cannot exit node before setting node information."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind != Invalid && \"Cannot exit node before setting node information.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 741, __PRETTY_FUNCTION__))
741 "Cannot exit node before setting node information.")((FlatTree[CurrentNode].Kind != Invalid && "Cannot exit node before setting node information."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind != Invalid && \"Cannot exit node before setting node information.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 741, __PRETTY_FUNCTION__))
;
742 CurrentNode = FlatTree[CurrentNode].ParentNode;
743 }
744
745 /// AddNode - Adds a child node to the current node, then sets that node
746 /// node as the current node.
747 void AddNode() {
748 assert(FlatTree[CurrentNode].Kind == Template &&((FlatTree[CurrentNode].Kind == Template && "Only Template nodes can have children nodes."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Template && \"Only Template nodes can have children nodes.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 749, __PRETTY_FUNCTION__))
749 "Only Template nodes can have children nodes.")((FlatTree[CurrentNode].Kind == Template && "Only Template nodes can have children nodes."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[CurrentNode].Kind == Template && \"Only Template nodes can have children nodes.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 749, __PRETTY_FUNCTION__))
;
750 FlatTree.push_back(DiffNode(CurrentNode));
751 DiffNode &Node = FlatTree[CurrentNode];
752 if (Node.ChildNode == 0) {
753 // If a child node doesn't exist, add one.
754 Node.ChildNode = NextFreeNode;
755 } else {
756 // If a child node exists, find the last child node and add a
757 // next node to it.
758 unsigned i;
759 for (i = Node.ChildNode; FlatTree[i].NextNode != 0;
760 i = FlatTree[i].NextNode) {
761 }
762 FlatTree[i].NextNode = NextFreeNode;
763 }
764 CurrentNode = NextFreeNode;
765 ++NextFreeNode;
766 }
767
768 // Node reading functions.
769 /// StartTraverse - Prepares the tree for recursive traversal.
770 void StartTraverse() {
771 ReadNode = 0;
772 CurrentNode = NextFreeNode;
773 NextFreeNode = 0;
774 }
775
776 /// Parent - Move the current read node to its parent.
777 void Parent() {
778 ReadNode = FlatTree[ReadNode].ParentNode;
779 }
780
781 void GetTemplateDiff(TemplateDecl *&FromTD, TemplateDecl *&ToTD,
782 Qualifiers &FromQual, Qualifiers &ToQual) {
783 assert(FlatTree[ReadNode].Kind == Template && "Unexpected kind.")((FlatTree[ReadNode].Kind == Template && "Unexpected kind."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[ReadNode].Kind == Template && \"Unexpected kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 783, __PRETTY_FUNCTION__))
;
784 FromTD = FlatTree[ReadNode].FromArgInfo.TD;
785 ToTD = FlatTree[ReadNode].ToArgInfo.TD;
786 FromQual = FlatTree[ReadNode].FromArgInfo.Qual;
787 ToQual = FlatTree[ReadNode].ToArgInfo.Qual;
788 }
789
790 void GetTypeDiff(QualType &FromType, QualType &ToType) {
791 assert(FlatTree[ReadNode].Kind == Type && "Unexpected kind")((FlatTree[ReadNode].Kind == Type && "Unexpected kind"
) ? static_cast<void> (0) : __assert_fail ("FlatTree[ReadNode].Kind == Type && \"Unexpected kind\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 791, __PRETTY_FUNCTION__))
;
792 FromType = FlatTree[ReadNode].FromArgInfo.ArgType;
793 ToType = FlatTree[ReadNode].ToArgInfo.ArgType;
794 }
795
796 void GetExpressionDiff(Expr *&FromExpr, Expr *&ToExpr) {
797 assert(FlatTree[ReadNode].Kind == Expression && "Unexpected kind")((FlatTree[ReadNode].Kind == Expression && "Unexpected kind"
) ? static_cast<void> (0) : __assert_fail ("FlatTree[ReadNode].Kind == Expression && \"Unexpected kind\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 797, __PRETTY_FUNCTION__))
;
798 FromExpr = FlatTree[ReadNode].FromArgInfo.ArgExpr;
799 ToExpr = FlatTree[ReadNode].ToArgInfo.ArgExpr;
800 }
801
802 void GetTemplateTemplateDiff(TemplateDecl *&FromTD, TemplateDecl *&ToTD) {
803 assert(FlatTree[ReadNode].Kind == TemplateTemplate && "Unexpected kind.")((FlatTree[ReadNode].Kind == TemplateTemplate && "Unexpected kind."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[ReadNode].Kind == TemplateTemplate && \"Unexpected kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 803, __PRETTY_FUNCTION__))
;
804 FromTD = FlatTree[ReadNode].FromArgInfo.TD;
805 ToTD = FlatTree[ReadNode].ToArgInfo.TD;
806 }
807
808 void GetIntegerDiff(llvm::APSInt &FromInt, llvm::APSInt &ToInt,
809 bool &IsValidFromInt, bool &IsValidToInt,
810 QualType &FromIntType, QualType &ToIntType,
811 Expr *&FromExpr, Expr *&ToExpr) {
812 assert(FlatTree[ReadNode].Kind == Integer && "Unexpected kind.")((FlatTree[ReadNode].Kind == Integer && "Unexpected kind."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[ReadNode].Kind == Integer && \"Unexpected kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 812, __PRETTY_FUNCTION__))
;
813 FromInt = FlatTree[ReadNode].FromArgInfo.Val;
814 ToInt = FlatTree[ReadNode].ToArgInfo.Val;
815 IsValidFromInt = FlatTree[ReadNode].FromArgInfo.IsValidInt;
816 IsValidToInt = FlatTree[ReadNode].ToArgInfo.IsValidInt;
817 FromIntType = FlatTree[ReadNode].FromArgInfo.ArgType;
818 ToIntType = FlatTree[ReadNode].ToArgInfo.ArgType;
819 FromExpr = FlatTree[ReadNode].FromArgInfo.ArgExpr;
820 ToExpr = FlatTree[ReadNode].ToArgInfo.ArgExpr;
821 }
822
823 void GetDeclarationDiff(ValueDecl *&FromValueDecl, ValueDecl *&ToValueDecl,
824 bool &FromAddressOf, bool &ToAddressOf,
825 bool &FromNullPtr, bool &ToNullPtr, Expr *&FromExpr,
826 Expr *&ToExpr) {
827 assert(FlatTree[ReadNode].Kind == Declaration && "Unexpected kind.")((FlatTree[ReadNode].Kind == Declaration && "Unexpected kind."
) ? static_cast<void> (0) : __assert_fail ("FlatTree[ReadNode].Kind == Declaration && \"Unexpected kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 827, __PRETTY_FUNCTION__))
;
828 FromValueDecl = FlatTree[ReadNode].FromArgInfo.VD;
829 ToValueDecl = FlatTree[ReadNode].ToArgInfo.VD;
830 FromAddressOf = FlatTree[ReadNode].FromArgInfo.NeedAddressOf;
831 ToAddressOf = FlatTree[ReadNode].ToArgInfo.NeedAddressOf;
832 FromNullPtr = FlatTree[ReadNode].FromArgInfo.IsNullPtr;
833 ToNullPtr = FlatTree[ReadNode].ToArgInfo.IsNullPtr;
834 FromExpr = FlatTree[ReadNode].FromArgInfo.ArgExpr;
835 ToExpr = FlatTree[ReadNode].ToArgInfo.ArgExpr;
836 }
837
838 void GetFromDeclarationAndToIntegerDiff(
839 ValueDecl *&FromValueDecl, bool &FromAddressOf, bool &FromNullPtr,
840 Expr *&FromExpr, llvm::APSInt &ToInt, bool &IsValidToInt,
841 QualType &ToIntType, Expr *&ToExpr) {
842 assert(FlatTree[ReadNode].Kind == FromDeclarationAndToInteger &&((FlatTree[ReadNode].Kind == FromDeclarationAndToInteger &&
"Unexpected kind.") ? static_cast<void> (0) : __assert_fail
("FlatTree[ReadNode].Kind == FromDeclarationAndToInteger && \"Unexpected kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 843, __PRETTY_FUNCTION__))
843 "Unexpected kind.")((FlatTree[ReadNode].Kind == FromDeclarationAndToInteger &&
"Unexpected kind.") ? static_cast<void> (0) : __assert_fail
("FlatTree[ReadNode].Kind == FromDeclarationAndToInteger && \"Unexpected kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 843, __PRETTY_FUNCTION__))
;
844 FromValueDecl = FlatTree[ReadNode].FromArgInfo.VD;
845 FromAddressOf = FlatTree[ReadNode].FromArgInfo.NeedAddressOf;
846 FromNullPtr = FlatTree[ReadNode].FromArgInfo.IsNullPtr;
847 FromExpr = FlatTree[ReadNode].FromArgInfo.ArgExpr;
848 ToInt = FlatTree[ReadNode].ToArgInfo.Val;
849 IsValidToInt = FlatTree[ReadNode].ToArgInfo.IsValidInt;
850 ToIntType = FlatTree[ReadNode].ToArgInfo.ArgType;
851 ToExpr = FlatTree[ReadNode].ToArgInfo.ArgExpr;
852 }
853
854 void GetFromIntegerAndToDeclarationDiff(
855 llvm::APSInt &FromInt, bool &IsValidFromInt, QualType &FromIntType,
856 Expr *&FromExpr, ValueDecl *&ToValueDecl, bool &ToAddressOf,
857 bool &ToNullPtr, Expr *&ToExpr) {
858 assert(FlatTree[ReadNode].Kind == FromIntegerAndToDeclaration &&((FlatTree[ReadNode].Kind == FromIntegerAndToDeclaration &&
"Unexpected kind.") ? static_cast<void> (0) : __assert_fail
("FlatTree[ReadNode].Kind == FromIntegerAndToDeclaration && \"Unexpected kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 859, __PRETTY_FUNCTION__))
859 "Unexpected kind.")((FlatTree[ReadNode].Kind == FromIntegerAndToDeclaration &&
"Unexpected kind.") ? static_cast<void> (0) : __assert_fail
("FlatTree[ReadNode].Kind == FromIntegerAndToDeclaration && \"Unexpected kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 859, __PRETTY_FUNCTION__))
;
860 FromInt = FlatTree[ReadNode].FromArgInfo.Val;
861 IsValidFromInt = FlatTree[ReadNode].FromArgInfo.IsValidInt;
862 FromIntType = FlatTree[ReadNode].FromArgInfo.ArgType;
863 FromExpr = FlatTree[ReadNode].FromArgInfo.ArgExpr;
864 ToValueDecl = FlatTree[ReadNode].ToArgInfo.VD;
865 ToAddressOf = FlatTree[ReadNode].ToArgInfo.NeedAddressOf;
866 ToNullPtr = FlatTree[ReadNode].ToArgInfo.IsNullPtr;
867 ToExpr = FlatTree[ReadNode].ToArgInfo.ArgExpr;
868 }
869
870 /// FromDefault - Return true if the from argument is the default.
871 bool FromDefault() {
872 return FlatTree[ReadNode].FromArgInfo.IsDefault;
873 }
874
875 /// ToDefault - Return true if the to argument is the default.
876 bool ToDefault() {
877 return FlatTree[ReadNode].ToArgInfo.IsDefault;
878 }
879
880 /// NodeIsSame - Returns true the arguments are the same.
881 bool NodeIsSame() {
882 return FlatTree[ReadNode].Same;
883 }
884
885 /// HasChildrend - Returns true if the node has children.
886 bool HasChildren() {
887 return FlatTree[ReadNode].ChildNode != 0;
888 }
889
890 /// MoveToChild - Moves from the current node to its child.
891 void MoveToChild() {
892 ReadNode = FlatTree[ReadNode].ChildNode;
893 }
894
895 /// AdvanceSibling - If there is a next sibling, advance to it and return
896 /// true. Otherwise, return false.
897 bool AdvanceSibling() {
898 if (FlatTree[ReadNode].NextNode == 0)
899 return false;
900
901 ReadNode = FlatTree[ReadNode].NextNode;
902 return true;
903 }
904
905 /// HasNextSibling - Return true if the node has a next sibling.
906 bool HasNextSibling() {
907 return FlatTree[ReadNode].NextNode != 0;
908 }
909
910 /// Empty - Returns true if the tree has no information.
911 bool Empty() {
912 return GetKind() == Invalid;
913 }
914
915 /// GetKind - Returns the current node's type.
916 DiffKind GetKind() {
917 return FlatTree[ReadNode].Kind;
918 }
919 };
920
921 DiffTree Tree;
922
923 /// TSTiterator - a pair of iterators that walks the
924 /// TemplateSpecializationType and the desugared TemplateSpecializationType.
925 /// The deseguared TemplateArgument should provide the canonical argument
926 /// for comparisons.
927 class TSTiterator {
928 typedef const TemplateArgument& reference;
929 typedef const TemplateArgument* pointer;
930
931 /// InternalIterator - an iterator that is used to enter a
932 /// TemplateSpecializationType and read TemplateArguments inside template
933 /// parameter packs in order with the rest of the TemplateArguments.
934 struct InternalIterator {
935 /// TST - the template specialization whose arguments this iterator
936 /// traverse over.
937 const TemplateSpecializationType *TST;
938
939 /// Index - the index of the template argument in TST.
940 unsigned Index;
941
942 /// CurrentTA - if CurrentTA is not the same as EndTA, then CurrentTA
943 /// points to a TemplateArgument within a parameter pack.
944 TemplateArgument::pack_iterator CurrentTA;
945
946 /// EndTA - the end iterator of a parameter pack
947 TemplateArgument::pack_iterator EndTA;
948
949 /// InternalIterator - Constructs an iterator and sets it to the first
950 /// template argument.
951 InternalIterator(const TemplateSpecializationType *TST)
952 : TST(TST), Index(0), CurrentTA(nullptr), EndTA(nullptr) {
953 if (!TST) return;
954
955 if (isEnd()) return;
956
957 // Set to first template argument. If not a parameter pack, done.
958 TemplateArgument TA = TST->getArg(0);
959 if (TA.getKind() != TemplateArgument::Pack) return;
960
961 // Start looking into the parameter pack.
962 CurrentTA = TA.pack_begin();
963 EndTA = TA.pack_end();
964
965 // Found a valid template argument.
966 if (CurrentTA != EndTA) return;
967
968 // Parameter pack is empty, use the increment to get to a valid
969 // template argument.
970 ++(*this);
971 }
972
973 /// Return true if the iterator is non-singular.
974 bool isValid() const { return TST; }
975
976 /// isEnd - Returns true if the iterator is one past the end.
977 bool isEnd() const {
978 assert(TST && "InternalIterator is invalid with a null TST.")((TST && "InternalIterator is invalid with a null TST."
) ? static_cast<void> (0) : __assert_fail ("TST && \"InternalIterator is invalid with a null TST.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 978, __PRETTY_FUNCTION__))
;
979 return Index >= TST->getNumArgs();
980 }
981
982 /// &operator++ - Increment the iterator to the next template argument.
983 InternalIterator &operator++() {
984 assert(TST && "InternalIterator is invalid with a null TST.")((TST && "InternalIterator is invalid with a null TST."
) ? static_cast<void> (0) : __assert_fail ("TST && \"InternalIterator is invalid with a null TST.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 984, __PRETTY_FUNCTION__))
;
985 if (isEnd()) {
986 return *this;
987 }
988
989 // If in a parameter pack, advance in the parameter pack.
990 if (CurrentTA != EndTA) {
991 ++CurrentTA;
992 if (CurrentTA != EndTA)
993 return *this;
994 }
995
996 // Loop until a template argument is found, or the end is reached.
997 while (true) {
998 // Advance to the next template argument. Break if reached the end.
999 if (++Index == TST->getNumArgs())
1000 break;
1001
1002 // If the TemplateArgument is not a parameter pack, done.
1003 TemplateArgument TA = TST->getArg(Index);
1004 if (TA.getKind() != TemplateArgument::Pack)
1005 break;
1006
1007 // Handle parameter packs.
1008 CurrentTA = TA.pack_begin();
1009 EndTA = TA.pack_end();
1010
1011 // If the parameter pack is empty, try to advance again.
1012 if (CurrentTA != EndTA)
1013 break;
1014 }
1015 return *this;
1016 }
1017
1018 /// operator* - Returns the appropriate TemplateArgument.
1019 reference operator*() const {
1020 assert(TST && "InternalIterator is invalid with a null TST.")((TST && "InternalIterator is invalid with a null TST."
) ? static_cast<void> (0) : __assert_fail ("TST && \"InternalIterator is invalid with a null TST.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1020, __PRETTY_FUNCTION__))
;
1021 assert(!isEnd() && "Index exceeds number of arguments.")((!isEnd() && "Index exceeds number of arguments.") ?
static_cast<void> (0) : __assert_fail ("!isEnd() && \"Index exceeds number of arguments.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1021, __PRETTY_FUNCTION__))
;
1022 if (CurrentTA == EndTA)
1023 return TST->getArg(Index);
1024 else
1025 return *CurrentTA;
1026 }
1027
1028 /// operator-> - Allow access to the underlying TemplateArgument.
1029 pointer operator->() const {
1030 assert(TST && "InternalIterator is invalid with a null TST.")((TST && "InternalIterator is invalid with a null TST."
) ? static_cast<void> (0) : __assert_fail ("TST && \"InternalIterator is invalid with a null TST.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1030, __PRETTY_FUNCTION__))
;
1031 return &operator*();
1032 }
1033 };
1034
1035 InternalIterator SugaredIterator;
1036 InternalIterator DesugaredIterator;
1037
1038 public:
1039 TSTiterator(ASTContext &Context, const TemplateSpecializationType *TST)
1040 : SugaredIterator(TST),
1041 DesugaredIterator(
1042 (TST->isSugared() && !TST->isTypeAlias())
1043 ? GetTemplateSpecializationType(Context, TST->desugar())
1044 : nullptr) {}
1045
1046 /// &operator++ - Increment the iterator to the next template argument.
1047 TSTiterator &operator++() {
1048 ++SugaredIterator;
1049 if (DesugaredIterator.isValid())
1050 ++DesugaredIterator;
1051 return *this;
1052 }
1053
1054 /// operator* - Returns the appropriate TemplateArgument.
1055 reference operator*() const {
1056 return *SugaredIterator;
1057 }
1058
1059 /// operator-> - Allow access to the underlying TemplateArgument.
1060 pointer operator->() const {
1061 return &operator*();
1062 }
1063
1064 /// isEnd - Returns true if no more TemplateArguments are available.
1065 bool isEnd() const {
1066 return SugaredIterator.isEnd();
1067 }
1068
1069 /// hasDesugaredTA - Returns true if there is another TemplateArgument
1070 /// available.
1071 bool hasDesugaredTA() const {
1072 return DesugaredIterator.isValid() && !DesugaredIterator.isEnd();
1073 }
1074
1075 /// getDesugaredTA - Returns the desugared TemplateArgument.
1076 reference getDesugaredTA() const {
1077 assert(DesugaredIterator.isValid() &&((DesugaredIterator.isValid() && "Desugared TemplateArgument should not be used."
) ? static_cast<void> (0) : __assert_fail ("DesugaredIterator.isValid() && \"Desugared TemplateArgument should not be used.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1078, __PRETTY_FUNCTION__))
1078 "Desugared TemplateArgument should not be used.")((DesugaredIterator.isValid() && "Desugared TemplateArgument should not be used."
) ? static_cast<void> (0) : __assert_fail ("DesugaredIterator.isValid() && \"Desugared TemplateArgument should not be used.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1078, __PRETTY_FUNCTION__))
;
1079 return *DesugaredIterator;
1080 }
1081 };
1082
1083 // These functions build up the template diff tree, including functions to
1084 // retrieve and compare template arguments.
1085
1086 static const TemplateSpecializationType *GetTemplateSpecializationType(
1087 ASTContext &Context, QualType Ty) {
1088 if (const TemplateSpecializationType *TST =
1089 Ty->getAs<TemplateSpecializationType>())
1090 return TST;
1091
1092 const RecordType *RT = Ty->getAs<RecordType>();
1093
1094 if (!RT)
1095 return nullptr;
1096
1097 const ClassTemplateSpecializationDecl *CTSD =
1098 dyn_cast<ClassTemplateSpecializationDecl>(RT->getDecl());
1099
1100 if (!CTSD)
1101 return nullptr;
1102
1103 Ty = Context.getTemplateSpecializationType(
1104 TemplateName(CTSD->getSpecializedTemplate()),
1105 CTSD->getTemplateArgs().asArray(),
1106 Ty.getLocalUnqualifiedType().getCanonicalType());
1107
1108 return Ty->getAs<TemplateSpecializationType>();
1109 }
1110
1111 /// Returns true if the DiffType is Type and false for Template.
1112 static bool OnlyPerformTypeDiff(ASTContext &Context, QualType FromType,
1113 QualType ToType,
1114 const TemplateSpecializationType *&FromArgTST,
1115 const TemplateSpecializationType *&ToArgTST) {
1116 if (FromType.isNull() || ToType.isNull())
1117 return true;
1118
1119 if (Context.hasSameType(FromType, ToType))
1120 return true;
1121
1122 FromArgTST = GetTemplateSpecializationType(Context, FromType);
1123 ToArgTST = GetTemplateSpecializationType(Context, ToType);
1124
1125 if (!FromArgTST || !ToArgTST)
1126 return true;
1127
1128 if (!hasSameTemplate(FromArgTST, ToArgTST))
1129 return true;
1130
1131 return false;
1132 }
1133
1134 /// DiffTypes - Fills a DiffNode with information about a type difference.
1135 void DiffTypes(const TSTiterator &FromIter, const TSTiterator &ToIter) {
1136 QualType FromType = GetType(FromIter);
1137 QualType ToType = GetType(ToIter);
1138
1139 bool FromDefault = FromIter.isEnd() && !FromType.isNull();
1140 bool ToDefault = ToIter.isEnd() && !ToType.isNull();
1141
1142 const TemplateSpecializationType *FromArgTST = nullptr;
1143 const TemplateSpecializationType *ToArgTST = nullptr;
1144 if (OnlyPerformTypeDiff(Context, FromType, ToType, FromArgTST, ToArgTST)) {
1145 Tree.SetTypeDiff(FromType, ToType, FromDefault, ToDefault);
1146 Tree.SetSame(!FromType.isNull() && !ToType.isNull() &&
1147 Context.hasSameType(FromType, ToType));
1148 } else {
1149 assert(FromArgTST && ToArgTST &&((FromArgTST && ToArgTST && "Both template specializations need to be valid."
) ? static_cast<void> (0) : __assert_fail ("FromArgTST && ToArgTST && \"Both template specializations need to be valid.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1150, __PRETTY_FUNCTION__))
1150 "Both template specializations need to be valid.")((FromArgTST && ToArgTST && "Both template specializations need to be valid."
) ? static_cast<void> (0) : __assert_fail ("FromArgTST && ToArgTST && \"Both template specializations need to be valid.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1150, __PRETTY_FUNCTION__))
;
1151 Qualifiers FromQual = FromType.getQualifiers(),
1152 ToQual = ToType.getQualifiers();
1153 FromQual -= QualType(FromArgTST, 0).getQualifiers();
1154 ToQual -= QualType(ToArgTST, 0).getQualifiers();
1155 Tree.SetTemplateDiff(FromArgTST->getTemplateName().getAsTemplateDecl(),
1156 ToArgTST->getTemplateName().getAsTemplateDecl(),
1157 FromQual, ToQual, FromDefault, ToDefault);
1158 DiffTemplate(FromArgTST, ToArgTST);
1159 }
1160 }
1161
1162 /// DiffTemplateTemplates - Fills a DiffNode with information about a
1163 /// template template difference.
1164 void DiffTemplateTemplates(const TSTiterator &FromIter,
1165 const TSTiterator &ToIter) {
1166 TemplateDecl *FromDecl = GetTemplateDecl(FromIter);
1167 TemplateDecl *ToDecl = GetTemplateDecl(ToIter);
1168 Tree.SetTemplateTemplateDiff(FromDecl, ToDecl, FromIter.isEnd() && FromDecl,
1169 ToIter.isEnd() && ToDecl);
1170 Tree.SetSame(FromDecl && ToDecl &&
1171 FromDecl->getCanonicalDecl() == ToDecl->getCanonicalDecl());
1172 }
1173
1174 /// InitializeNonTypeDiffVariables - Helper function for DiffNonTypes
1175 static void InitializeNonTypeDiffVariables(ASTContext &Context,
1176 const TSTiterator &Iter,
1177 NonTypeTemplateParmDecl *Default,
1178 llvm::APSInt &Value, bool &HasInt,
1179 QualType &IntType, bool &IsNullPtr,
1180 Expr *&E, ValueDecl *&VD,
1181 bool &NeedAddressOf) {
1182 if (!Iter.isEnd()) {
1183 switch (Iter->getKind()) {
1184 default:
1185 llvm_unreachable("unknown ArgumentKind")::llvm::llvm_unreachable_internal("unknown ArgumentKind", "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1185)
;
1186 case TemplateArgument::Integral:
1187 Value = Iter->getAsIntegral();
1188 HasInt = true;
1189 IntType = Iter->getIntegralType();
1190 return;
1191 case TemplateArgument::Declaration: {
1192 VD = Iter->getAsDecl();
1193 QualType ArgType = Iter->getParamTypeForDecl();
1194 QualType VDType = VD->getType();
1195 if (ArgType->isPointerType() &&
1196 Context.hasSameType(ArgType->getPointeeType(), VDType))
1197 NeedAddressOf = true;
1198 return;
1199 }
1200 case TemplateArgument::NullPtr:
1201 IsNullPtr = true;
1202 return;
1203 case TemplateArgument::Expression:
1204 E = Iter->getAsExpr();
1205 }
1206 } else if (!Default->isParameterPack()) {
1207 E = Default->getDefaultArgument();
1208 }
1209
1210 if (!Iter.hasDesugaredTA()) return;
1211
1212 const TemplateArgument& TA = Iter.getDesugaredTA();
1213 switch (TA.getKind()) {
1214 default:
1215 llvm_unreachable("unknown ArgumentKind")::llvm::llvm_unreachable_internal("unknown ArgumentKind", "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1215)
;
1216 case TemplateArgument::Integral:
1217 Value = TA.getAsIntegral();
1218 HasInt = true;
1219 IntType = TA.getIntegralType();
1220 return;
1221 case TemplateArgument::Declaration: {
1222 VD = TA.getAsDecl();
1223 QualType ArgType = TA.getParamTypeForDecl();
1224 QualType VDType = VD->getType();
1225 if (ArgType->isPointerType() &&
1226 Context.hasSameType(ArgType->getPointeeType(), VDType))
1227 NeedAddressOf = true;
1228 return;
1229 }
1230 case TemplateArgument::NullPtr:
1231 IsNullPtr = true;
1232 return;
1233 case TemplateArgument::Expression:
1234 // TODO: Sometimes, the desugared template argument Expr differs from
1235 // the sugared template argument Expr. It may be useful in the future
1236 // but for now, it is just discarded.
1237 if (!E)
1238 E = TA.getAsExpr();
1239 return;
1240 }
1241 }
1242
1243 /// DiffNonTypes - Handles any template parameters not handled by DiffTypes
1244 /// of DiffTemplatesTemplates, such as integer and declaration parameters.
1245 void DiffNonTypes(const TSTiterator &FromIter, const TSTiterator &ToIter,
1246 NonTypeTemplateParmDecl *FromDefaultNonTypeDecl,
1247 NonTypeTemplateParmDecl *ToDefaultNonTypeDecl) {
1248 Expr *FromExpr = nullptr, *ToExpr = nullptr;
1249 llvm::APSInt FromInt, ToInt;
1250 QualType FromIntType, ToIntType;
1251 ValueDecl *FromValueDecl = nullptr, *ToValueDecl = nullptr;
1252 bool HasFromInt = false, HasToInt = false, FromNullPtr = false,
1253 ToNullPtr = false, NeedFromAddressOf = false, NeedToAddressOf = false;
1254 InitializeNonTypeDiffVariables(
1255 Context, FromIter, FromDefaultNonTypeDecl, FromInt, HasFromInt,
1256 FromIntType, FromNullPtr, FromExpr, FromValueDecl, NeedFromAddressOf);
1257 InitializeNonTypeDiffVariables(Context, ToIter, ToDefaultNonTypeDecl, ToInt,
1258 HasToInt, ToIntType, ToNullPtr, ToExpr,
1259 ToValueDecl, NeedToAddressOf);
1260
1261 bool FromDefault = FromIter.isEnd() &&
1262 (FromExpr || FromValueDecl || HasFromInt || FromNullPtr);
1263 bool ToDefault = ToIter.isEnd() &&
1264 (ToExpr || ToValueDecl || HasToInt || ToNullPtr);
1265
1266 bool FromDeclaration = FromValueDecl || FromNullPtr;
1267 bool ToDeclaration = ToValueDecl || ToNullPtr;
1268
1269 if (FromDeclaration && HasToInt) {
1270 Tree.SetFromDeclarationAndToIntegerDiff(
1271 FromValueDecl, NeedFromAddressOf, FromNullPtr, FromExpr, ToInt,
1272 HasToInt, ToIntType, ToExpr, FromDefault, ToDefault);
1273 Tree.SetSame(false);
1274 return;
1275
1276 }
1277
1278 if (HasFromInt && ToDeclaration) {
1279 Tree.SetFromIntegerAndToDeclarationDiff(
1280 FromInt, HasFromInt, FromIntType, FromExpr, ToValueDecl,
1281 NeedToAddressOf, ToNullPtr, ToExpr, FromDefault, ToDefault);
1282 Tree.SetSame(false);
1283 return;
1284 }
1285
1286 if (HasFromInt || HasToInt) {
1287 Tree.SetIntegerDiff(FromInt, ToInt, HasFromInt, HasToInt, FromIntType,
1288 ToIntType, FromExpr, ToExpr, FromDefault, ToDefault);
1289 if (HasFromInt && HasToInt) {
1290 Tree.SetSame(Context.hasSameType(FromIntType, ToIntType) &&
1291 FromInt == ToInt);
1292 }
1293 return;
1294 }
1295
1296 if (FromDeclaration || ToDeclaration) {
1297 Tree.SetDeclarationDiff(FromValueDecl, ToValueDecl, NeedFromAddressOf,
1298 NeedToAddressOf, FromNullPtr, ToNullPtr, FromExpr,
1299 ToExpr, FromDefault, ToDefault);
1300 bool BothNull = FromNullPtr && ToNullPtr;
1301 bool SameValueDecl =
1302 FromValueDecl && ToValueDecl &&
1303 NeedFromAddressOf == NeedToAddressOf &&
1304 FromValueDecl->getCanonicalDecl() == ToValueDecl->getCanonicalDecl();
1305 Tree.SetSame(BothNull || SameValueDecl);
1306 return;
1307 }
1308
1309 assert((FromExpr || ToExpr) && "Both template arguments cannot be empty.")(((FromExpr || ToExpr) && "Both template arguments cannot be empty."
) ? static_cast<void> (0) : __assert_fail ("(FromExpr || ToExpr) && \"Both template arguments cannot be empty.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1309, __PRETTY_FUNCTION__))
;
1310 Tree.SetExpressionDiff(FromExpr, ToExpr, FromDefault, ToDefault);
1311 Tree.SetSame(IsEqualExpr(Context, FromExpr, ToExpr));
1312 }
1313
1314 /// DiffTemplate - recursively visits template arguments and stores the
1315 /// argument info into a tree.
1316 void DiffTemplate(const TemplateSpecializationType *FromTST,
1317 const TemplateSpecializationType *ToTST) {
1318 // Begin descent into diffing template tree.
1319 TemplateParameterList *ParamsFrom =
1320 FromTST->getTemplateName().getAsTemplateDecl()->getTemplateParameters();
1321 TemplateParameterList *ParamsTo =
1322 ToTST->getTemplateName().getAsTemplateDecl()->getTemplateParameters();
1323 unsigned TotalArgs = 0;
1324 for (TSTiterator FromIter(Context, FromTST), ToIter(Context, ToTST);
1325 !FromIter.isEnd() || !ToIter.isEnd(); ++TotalArgs) {
1326 Tree.AddNode();
1327
1328 // Get the parameter at index TotalArgs. If index is larger
1329 // than the total number of parameters, then there is an
1330 // argument pack, so re-use the last parameter.
1331 unsigned FromParamIndex = std::min(TotalArgs, ParamsFrom->size() - 1);
1332 unsigned ToParamIndex = std::min(TotalArgs, ParamsTo->size() - 1);
1333 NamedDecl *FromParamND = ParamsFrom->getParam(FromParamIndex);
1334 NamedDecl *ToParamND = ParamsTo->getParam(ToParamIndex);
1335
1336 assert(FromParamND->getKind() == ToParamND->getKind() &&((FromParamND->getKind() == ToParamND->getKind() &&
"Parameter Decl are not the same kind.") ? static_cast<void
> (0) : __assert_fail ("FromParamND->getKind() == ToParamND->getKind() && \"Parameter Decl are not the same kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1337, __PRETTY_FUNCTION__))
1337 "Parameter Decl are not the same kind.")((FromParamND->getKind() == ToParamND->getKind() &&
"Parameter Decl are not the same kind.") ? static_cast<void
> (0) : __assert_fail ("FromParamND->getKind() == ToParamND->getKind() && \"Parameter Decl are not the same kind.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1337, __PRETTY_FUNCTION__))
;
1338
1339 if (isa<TemplateTypeParmDecl>(FromParamND)) {
1340 DiffTypes(FromIter, ToIter);
1341 } else if (isa<TemplateTemplateParmDecl>(FromParamND)) {
1342 DiffTemplateTemplates(FromIter, ToIter);
1343 } else if (isa<NonTypeTemplateParmDecl>(FromParamND)) {
1344 NonTypeTemplateParmDecl *FromDefaultNonTypeDecl =
1345 cast<NonTypeTemplateParmDecl>(FromParamND);
1346 NonTypeTemplateParmDecl *ToDefaultNonTypeDecl =
1347 cast<NonTypeTemplateParmDecl>(ToParamND);
1348 DiffNonTypes(FromIter, ToIter, FromDefaultNonTypeDecl,
1349 ToDefaultNonTypeDecl);
1350 } else {
1351 llvm_unreachable("Unexpected Decl type.")::llvm::llvm_unreachable_internal("Unexpected Decl type.", "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1351)
;
1352 }
1353
1354 ++FromIter;
1355 ++ToIter;
1356 Tree.Up();
1357 }
1358 }
1359
1360 /// makeTemplateList - Dump every template alias into the vector.
1361 static void makeTemplateList(
1362 SmallVectorImpl<const TemplateSpecializationType *> &TemplateList,
1363 const TemplateSpecializationType *TST) {
1364 while (TST) {
1365 TemplateList.push_back(TST);
1366 if (!TST->isTypeAlias())
1367 return;
1368 TST = TST->getAliasedType()->getAs<TemplateSpecializationType>();
1369 }
1370 }
1371
1372 /// hasSameBaseTemplate - Returns true when the base templates are the same,
1373 /// even if the template arguments are not.
1374 static bool hasSameBaseTemplate(const TemplateSpecializationType *FromTST,
1375 const TemplateSpecializationType *ToTST) {
1376 return FromTST->getTemplateName().getAsTemplateDecl()->getCanonicalDecl() ==
1377 ToTST->getTemplateName().getAsTemplateDecl()->getCanonicalDecl();
1378 }
1379
1380 /// hasSameTemplate - Returns true if both types are specialized from the
1381 /// same template declaration. If they come from different template aliases,
1382 /// do a parallel ascension search to determine the highest template alias in
1383 /// common and set the arguments to them.
1384 static bool hasSameTemplate(const TemplateSpecializationType *&FromTST,
1385 const TemplateSpecializationType *&ToTST) {
1386 // Check the top templates if they are the same.
1387 if (hasSameBaseTemplate(FromTST, ToTST))
1388 return true;
1389
1390 // Create vectors of template aliases.
1391 SmallVector<const TemplateSpecializationType*, 1> FromTemplateList,
1392 ToTemplateList;
1393
1394 makeTemplateList(FromTemplateList, FromTST);
1395 makeTemplateList(ToTemplateList, ToTST);
1396
1397 SmallVectorImpl<const TemplateSpecializationType *>::reverse_iterator
1398 FromIter = FromTemplateList.rbegin(), FromEnd = FromTemplateList.rend(),
1399 ToIter = ToTemplateList.rbegin(), ToEnd = ToTemplateList.rend();
1400
1401 // Check if the lowest template types are the same. If not, return.
1402 if (!hasSameBaseTemplate(*FromIter, *ToIter))
1403 return false;
1404
1405 // Begin searching up the template aliases. The bottom most template
1406 // matches so move up until one pair does not match. Use the template
1407 // right before that one.
1408 for (; FromIter != FromEnd && ToIter != ToEnd; ++FromIter, ++ToIter) {
1409 if (!hasSameBaseTemplate(*FromIter, *ToIter))
1410 break;
1411 }
1412
1413 FromTST = FromIter[-1];
1414 ToTST = ToIter[-1];
1415
1416 return true;
1417 }
1418
1419 /// GetType - Retrieves the template type arguments, including default
1420 /// arguments.
1421 static QualType GetType(const TSTiterator &Iter) {
1422 if (!Iter.isEnd())
1423 return Iter->getAsType();
1424 if (Iter.hasDesugaredTA())
1425 return Iter.getDesugaredTA().getAsType();
1426 return QualType();
1427 }
1428
1429 /// GetTemplateDecl - Retrieves the template template arguments, including
1430 /// default arguments.
1431 static TemplateDecl *GetTemplateDecl(const TSTiterator &Iter) {
1432 if (!Iter.isEnd())
1433 return Iter->getAsTemplate().getAsTemplateDecl();
1434 if (Iter.hasDesugaredTA())
1435 return Iter.getDesugaredTA().getAsTemplate().getAsTemplateDecl();
1436 return nullptr;
1437 }
1438
1439 /// IsEqualExpr - Returns true if the expressions are the same in regards to
1440 /// template arguments. These expressions are dependent, so profile them
1441 /// instead of trying to evaluate them.
1442 static bool IsEqualExpr(ASTContext &Context, Expr *FromExpr, Expr *ToExpr) {
1443 if (FromExpr == ToExpr)
1444 return true;
1445
1446 if (!FromExpr || !ToExpr)
1447 return false;
1448
1449 llvm::FoldingSetNodeID FromID, ToID;
1450 FromExpr->Profile(FromID, Context, true);
1451 ToExpr->Profile(ToID, Context, true);
1452 return FromID == ToID;
1453 }
1454
1455 // These functions converts the tree representation of the template
1456 // differences into the internal character vector.
1457
1458 /// TreeToString - Converts the Tree object into a character stream which
1459 /// will later be turned into the output string.
1460 void TreeToString(int Indent = 1) {
1461 if (PrintTree) {
1462 OS << '\n';
1463 OS.indent(2 * Indent);
1464 ++Indent;
1465 }
1466
1467 // Handle cases where the difference is not templates with different
1468 // arguments.
1469 switch (Tree.GetKind()) {
1470 case DiffTree::Invalid:
1471 llvm_unreachable("Template diffing failed with bad DiffNode")::llvm::llvm_unreachable_internal("Template diffing failed with bad DiffNode"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1471)
;
1472 case DiffTree::Type: {
1473 QualType FromType, ToType;
1474 Tree.GetTypeDiff(FromType, ToType);
1475 PrintTypeNames(FromType, ToType, Tree.FromDefault(), Tree.ToDefault(),
1476 Tree.NodeIsSame());
1477 return;
1478 }
1479 case DiffTree::Expression: {
1480 Expr *FromExpr, *ToExpr;
1481 Tree.GetExpressionDiff(FromExpr, ToExpr);
1482 PrintExpr(FromExpr, ToExpr, Tree.FromDefault(), Tree.ToDefault(),
1483 Tree.NodeIsSame());
1484 return;
1485 }
1486 case DiffTree::TemplateTemplate: {
1487 TemplateDecl *FromTD, *ToTD;
1488 Tree.GetTemplateTemplateDiff(FromTD, ToTD);
1489 PrintTemplateTemplate(FromTD, ToTD, Tree.FromDefault(),
1490 Tree.ToDefault(), Tree.NodeIsSame());
1491 return;
1492 }
1493 case DiffTree::Integer: {
1494 llvm::APSInt FromInt, ToInt;
1495 Expr *FromExpr, *ToExpr;
1496 bool IsValidFromInt, IsValidToInt;
1497 QualType FromIntType, ToIntType;
1498 Tree.GetIntegerDiff(FromInt, ToInt, IsValidFromInt, IsValidToInt,
1499 FromIntType, ToIntType, FromExpr, ToExpr);
1500 PrintAPSInt(FromInt, ToInt, IsValidFromInt, IsValidToInt, FromIntType,
1501 ToIntType, FromExpr, ToExpr, Tree.FromDefault(),
1502 Tree.ToDefault(), Tree.NodeIsSame());
1503 return;
1504 }
1505 case DiffTree::Declaration: {
1506 ValueDecl *FromValueDecl, *ToValueDecl;
1507 bool FromAddressOf, ToAddressOf;
1508 bool FromNullPtr, ToNullPtr;
1509 Expr *FromExpr, *ToExpr;
1510 Tree.GetDeclarationDiff(FromValueDecl, ToValueDecl, FromAddressOf,
1511 ToAddressOf, FromNullPtr, ToNullPtr, FromExpr,
1512 ToExpr);
1513 PrintValueDecl(FromValueDecl, ToValueDecl, FromAddressOf, ToAddressOf,
1514 FromNullPtr, ToNullPtr, FromExpr, ToExpr,
1515 Tree.FromDefault(), Tree.ToDefault(), Tree.NodeIsSame());
1516 return;
1517 }
1518 case DiffTree::FromDeclarationAndToInteger: {
1519 ValueDecl *FromValueDecl;
1520 bool FromAddressOf;
1521 bool FromNullPtr;
1522 Expr *FromExpr;
1523 llvm::APSInt ToInt;
1524 bool IsValidToInt;
1525 QualType ToIntType;
1526 Expr *ToExpr;
1527 Tree.GetFromDeclarationAndToIntegerDiff(
1528 FromValueDecl, FromAddressOf, FromNullPtr, FromExpr, ToInt,
1529 IsValidToInt, ToIntType, ToExpr);
1530 assert((FromValueDecl || FromNullPtr) && IsValidToInt)(((FromValueDecl || FromNullPtr) && IsValidToInt) ? static_cast
<void> (0) : __assert_fail ("(FromValueDecl || FromNullPtr) && IsValidToInt"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1530, __PRETTY_FUNCTION__))
;
1531 PrintValueDeclAndInteger(FromValueDecl, FromAddressOf, FromNullPtr,
1532 FromExpr, Tree.FromDefault(), ToInt, ToIntType,
1533 ToExpr, Tree.ToDefault());
1534 return;
1535 }
1536 case DiffTree::FromIntegerAndToDeclaration: {
1537 llvm::APSInt FromInt;
1538 bool IsValidFromInt;
1539 QualType FromIntType;
1540 Expr *FromExpr;
1541 ValueDecl *ToValueDecl;
1542 bool ToAddressOf;
1543 bool ToNullPtr;
1544 Expr *ToExpr;
1545 Tree.GetFromIntegerAndToDeclarationDiff(
1546 FromInt, IsValidFromInt, FromIntType, FromExpr, ToValueDecl,
1547 ToAddressOf, ToNullPtr, ToExpr);
1548 assert(IsValidFromInt && (ToValueDecl || ToNullPtr))((IsValidFromInt && (ToValueDecl || ToNullPtr)) ? static_cast
<void> (0) : __assert_fail ("IsValidFromInt && (ToValueDecl || ToNullPtr)"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1548, __PRETTY_FUNCTION__))
;
1549 PrintIntegerAndValueDecl(FromInt, FromIntType, FromExpr,
1550 Tree.FromDefault(), ToValueDecl, ToAddressOf,
1551 ToNullPtr, ToExpr, Tree.ToDefault());
1552 return;
1553 }
1554 case DiffTree::Template: {
1555 // Node is root of template. Recurse on children.
1556 TemplateDecl *FromTD, *ToTD;
1557 Qualifiers FromQual, ToQual;
1558 Tree.GetTemplateDiff(FromTD, ToTD, FromQual, ToQual);
1559
1560 PrintQualifiers(FromQual, ToQual);
1561
1562 if (!Tree.HasChildren()) {
1563 // If we're dealing with a template specialization with zero
1564 // arguments, there are no children; special-case this.
1565 OS << FromTD->getNameAsString() << "<>";
1566 return;
1567 }
1568
1569 OS << FromTD->getNameAsString() << '<';
1570 Tree.MoveToChild();
1571 unsigned NumElideArgs = 0;
1572 bool AllArgsElided = true;
1573 do {
1574 if (ElideType) {
1575 if (Tree.NodeIsSame()) {
1576 ++NumElideArgs;
1577 continue;
1578 }
1579 AllArgsElided = false;
1580 if (NumElideArgs > 0) {
1581 PrintElideArgs(NumElideArgs, Indent);
1582 NumElideArgs = 0;
1583 OS << ", ";
1584 }
1585 }
1586 TreeToString(Indent);
1587 if (Tree.HasNextSibling())
1588 OS << ", ";
1589 } while (Tree.AdvanceSibling());
1590 if (NumElideArgs > 0) {
1591 if (AllArgsElided)
1592 OS << "...";
1593 else
1594 PrintElideArgs(NumElideArgs, Indent);
1595 }
1596
1597 Tree.Parent();
1598 OS << ">";
1599 return;
1600 }
1601 }
1602 }
1603
1604 // To signal to the text printer that a certain text needs to be bolded,
1605 // a special character is injected into the character stream which the
1606 // text printer will later strip out.
1607
1608 /// Bold - Start bolding text.
1609 void Bold() {
1610 assert(!IsBold && "Attempting to bold text that is already bold.")((!IsBold && "Attempting to bold text that is already bold."
) ? static_cast<void> (0) : __assert_fail ("!IsBold && \"Attempting to bold text that is already bold.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1610, __PRETTY_FUNCTION__))
;
1611 IsBold = true;
1612 if (ShowColor)
1613 OS << ToggleHighlight;
1614 }
1615
1616 /// Unbold - Stop bolding text.
1617 void Unbold() {
1618 assert(IsBold && "Attempting to remove bold from unbold text.")((IsBold && "Attempting to remove bold from unbold text."
) ? static_cast<void> (0) : __assert_fail ("IsBold && \"Attempting to remove bold from unbold text.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1618, __PRETTY_FUNCTION__))
;
1619 IsBold = false;
1620 if (ShowColor)
1621 OS << ToggleHighlight;
1622 }
1623
1624 // Functions to print out the arguments and highlighting the difference.
1625
1626 /// PrintTypeNames - prints the typenames, bolding differences. Will detect
1627 /// typenames that are the same and attempt to disambiguate them by using
1628 /// canonical typenames.
1629 void PrintTypeNames(QualType FromType, QualType ToType,
1630 bool FromDefault, bool ToDefault, bool Same) {
1631 assert((!FromType.isNull() || !ToType.isNull()) &&(((!FromType.isNull() || !ToType.isNull()) && "Only one template argument may be missing."
) ? static_cast<void> (0) : __assert_fail ("(!FromType.isNull() || !ToType.isNull()) && \"Only one template argument may be missing.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1632, __PRETTY_FUNCTION__))
1632 "Only one template argument may be missing.")(((!FromType.isNull() || !ToType.isNull()) && "Only one template argument may be missing."
) ? static_cast<void> (0) : __assert_fail ("(!FromType.isNull() || !ToType.isNull()) && \"Only one template argument may be missing.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1632, __PRETTY_FUNCTION__))
;
1633
1634 if (Same) {
1635 OS << FromType.getAsString(Policy);
1636 return;
1637 }
1638
1639 if (!FromType.isNull() && !ToType.isNull() &&
1640 FromType.getLocalUnqualifiedType() ==
1641 ToType.getLocalUnqualifiedType()) {
1642 Qualifiers FromQual = FromType.getLocalQualifiers(),
1643 ToQual = ToType.getLocalQualifiers();
1644 PrintQualifiers(FromQual, ToQual);
1645 FromType.getLocalUnqualifiedType().print(OS, Policy);
1646 return;
1647 }
1648
1649 std::string FromTypeStr = FromType.isNull() ? "(no argument)"
1650 : FromType.getAsString(Policy);
1651 std::string ToTypeStr = ToType.isNull() ? "(no argument)"
1652 : ToType.getAsString(Policy);
1653 // Switch to canonical typename if it is better.
1654 // TODO: merge this with other aka printing above.
1655 if (FromTypeStr == ToTypeStr) {
1656 std::string FromCanTypeStr =
1657 FromType.getCanonicalType().getAsString(Policy);
1658 std::string ToCanTypeStr = ToType.getCanonicalType().getAsString(Policy);
1659 if (FromCanTypeStr != ToCanTypeStr) {
1660 FromTypeStr = FromCanTypeStr;
1661 ToTypeStr = ToCanTypeStr;
1662 }
1663 }
1664
1665 if (PrintTree) OS << '[';
1666 OS << (FromDefault ? "(default) " : "");
1667 Bold();
1668 OS << FromTypeStr;
1669 Unbold();
1670 if (PrintTree) {
1671 OS << " != " << (ToDefault ? "(default) " : "");
1672 Bold();
1673 OS << ToTypeStr;
1674 Unbold();
1675 OS << "]";
1676 }
1677 }
1678
1679 /// PrintExpr - Prints out the expr template arguments, highlighting argument
1680 /// differences.
1681 void PrintExpr(const Expr *FromExpr, const Expr *ToExpr, bool FromDefault,
1682 bool ToDefault, bool Same) {
1683 assert((FromExpr || ToExpr) &&(((FromExpr || ToExpr) && "Only one template argument may be missing."
) ? static_cast<void> (0) : __assert_fail ("(FromExpr || ToExpr) && \"Only one template argument may be missing.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1684, __PRETTY_FUNCTION__))
1684 "Only one template argument may be missing.")(((FromExpr || ToExpr) && "Only one template argument may be missing."
) ? static_cast<void> (0) : __assert_fail ("(FromExpr || ToExpr) && \"Only one template argument may be missing.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1684, __PRETTY_FUNCTION__))
;
1685 if (Same) {
1686 PrintExpr(FromExpr);
1687 } else if (!PrintTree) {
1688 OS << (FromDefault ? "(default) " : "");
1689 Bold();
1690 PrintExpr(FromExpr);
1691 Unbold();
1692 } else {
1693 OS << (FromDefault ? "[(default) " : "[");
1694 Bold();
1695 PrintExpr(FromExpr);
1696 Unbold();
1697 OS << " != " << (ToDefault ? "(default) " : "");
1698 Bold();
1699 PrintExpr(ToExpr);
1700 Unbold();
1701 OS << ']';
1702 }
1703 }
1704
1705 /// PrintExpr - Actual formatting and printing of expressions.
1706 void PrintExpr(const Expr *E) {
1707 if (E) {
1708 E->printPretty(OS, nullptr, Policy);
1709 return;
1710 }
1711 OS << "(no argument)";
1712 }
1713
1714 /// PrintTemplateTemplate - Handles printing of template template arguments,
1715 /// highlighting argument differences.
1716 void PrintTemplateTemplate(TemplateDecl *FromTD, TemplateDecl *ToTD,
1717 bool FromDefault, bool ToDefault, bool Same) {
1718 assert((FromTD || ToTD) && "Only one template argument may be missing.")(((FromTD || ToTD) && "Only one template argument may be missing."
) ? static_cast<void> (0) : __assert_fail ("(FromTD || ToTD) && \"Only one template argument may be missing.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1718, __PRETTY_FUNCTION__))
;
1719
1720 std::string FromName = FromTD ? FromTD->getName() : "(no argument)";
1721 std::string ToName = ToTD ? ToTD->getName() : "(no argument)";
1722 if (FromTD && ToTD && FromName == ToName) {
1723 FromName = FromTD->getQualifiedNameAsString();
1724 ToName = ToTD->getQualifiedNameAsString();
1725 }
1726
1727 if (Same) {
1728 OS << "template " << FromTD->getNameAsString();
1729 } else if (!PrintTree) {
1730 OS << (FromDefault ? "(default) template " : "template ");
1731 Bold();
1732 OS << FromName;
1733 Unbold();
1734 } else {
1735 OS << (FromDefault ? "[(default) template " : "[template ");
1736 Bold();
1737 OS << FromName;
1738 Unbold();
1739 OS << " != " << (ToDefault ? "(default) template " : "template ");
1740 Bold();
1741 OS << ToName;
1742 Unbold();
1743 OS << ']';
1744 }
1745 }
1746
1747 /// PrintAPSInt - Handles printing of integral arguments, highlighting
1748 /// argument differences.
1749 void PrintAPSInt(const llvm::APSInt &FromInt, const llvm::APSInt &ToInt,
1750 bool IsValidFromInt, bool IsValidToInt, QualType FromIntType,
1751 QualType ToIntType, Expr *FromExpr, Expr *ToExpr,
1752 bool FromDefault, bool ToDefault, bool Same) {
1753 assert((IsValidFromInt || IsValidToInt) &&(((IsValidFromInt || IsValidToInt) && "Only one integral argument may be missing."
) ? static_cast<void> (0) : __assert_fail ("(IsValidFromInt || IsValidToInt) && \"Only one integral argument may be missing.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1754, __PRETTY_FUNCTION__))
1754 "Only one integral argument may be missing.")(((IsValidFromInt || IsValidToInt) && "Only one integral argument may be missing."
) ? static_cast<void> (0) : __assert_fail ("(IsValidFromInt || IsValidToInt) && \"Only one integral argument may be missing.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1754, __PRETTY_FUNCTION__))
;
1755
1756 if (Same) {
1757 if (FromIntType->isBooleanType()) {
1758 OS << ((FromInt == 0) ? "false" : "true");
1759 } else {
1760 OS << FromInt.toString(10);
1761 }
1762 return;
1763 }
1764
1765 bool PrintType = IsValidFromInt && IsValidToInt &&
1766 !Context.hasSameType(FromIntType, ToIntType);
1767
1768 if (!PrintTree) {
1769 OS << (FromDefault ? "(default) " : "");
1770 PrintAPSInt(FromInt, FromExpr, IsValidFromInt, FromIntType, PrintType);
1771 } else {
1772 OS << (FromDefault ? "[(default) " : "[");
1773 PrintAPSInt(FromInt, FromExpr, IsValidFromInt, FromIntType, PrintType);
1774 OS << " != " << (ToDefault ? "(default) " : "");
1775 PrintAPSInt(ToInt, ToExpr, IsValidToInt, ToIntType, PrintType);
1776 OS << ']';
1777 }
1778 }
1779
1780 /// PrintAPSInt - If valid, print the APSInt. If the expression is
1781 /// gives more information, print it too.
1782 void PrintAPSInt(const llvm::APSInt &Val, Expr *E, bool Valid,
1783 QualType IntType, bool PrintType) {
1784 Bold();
1785 if (Valid) {
1786 if (HasExtraInfo(E)) {
1787 PrintExpr(E);
1788 Unbold();
1789 OS << " aka ";
1790 Bold();
1791 }
1792 if (PrintType) {
1793 Unbold();
1794 OS << "(";
1795 Bold();
1796 IntType.print(OS, Context.getPrintingPolicy());
1797 Unbold();
1798 OS << ") ";
1799 Bold();
1800 }
1801 if (IntType->isBooleanType()) {
1802 OS << ((Val == 0) ? "false" : "true");
1803 } else {
1804 OS << Val.toString(10);
1805 }
1806 } else if (E) {
1807 PrintExpr(E);
1808 } else {
1809 OS << "(no argument)";
1810 }
1811 Unbold();
1812 }
1813
1814 /// HasExtraInfo - Returns true if E is not an integer literal, the
1815 /// negation of an integer literal, or a boolean literal.
1816 bool HasExtraInfo(Expr *E) {
1817 if (!E) return false;
1818
1819 E = E->IgnoreImpCasts();
1820
1821 if (isa<IntegerLiteral>(E)) return false;
1822
1823 if (UnaryOperator *UO = dyn_cast<UnaryOperator>(E))
1824 if (UO->getOpcode() == UO_Minus)
1825 if (isa<IntegerLiteral>(UO->getSubExpr()))
1826 return false;
1827
1828 if (isa<CXXBoolLiteralExpr>(E))
1829 return false;
1830
1831 return true;
1832 }
1833
1834 void PrintValueDecl(ValueDecl *VD, bool AddressOf, Expr *E, bool NullPtr) {
1835 if (VD) {
1836 if (AddressOf)
1837 OS << "&";
1838 OS << VD->getName();
1839 return;
1840 }
1841
1842 if (NullPtr) {
1843 if (E && !isa<CXXNullPtrLiteralExpr>(E)) {
1844 PrintExpr(E);
1845 if (IsBold) {
1846 Unbold();
1847 OS << " aka ";
1848 Bold();
1849 } else {
1850 OS << " aka ";
1851 }
1852 }
1853
1854 OS << "nullptr";
1855 return;
1856 }
1857
1858 OS << "(no argument)";
1859 }
1860
1861 /// PrintDecl - Handles printing of Decl arguments, highlighting
1862 /// argument differences.
1863 void PrintValueDecl(ValueDecl *FromValueDecl, ValueDecl *ToValueDecl,
1864 bool FromAddressOf, bool ToAddressOf, bool FromNullPtr,
1865 bool ToNullPtr, Expr *FromExpr, Expr *ToExpr,
1866 bool FromDefault, bool ToDefault, bool Same) {
1867 assert((FromValueDecl || FromNullPtr || ToValueDecl || ToNullPtr) &&(((FromValueDecl || FromNullPtr || ToValueDecl || ToNullPtr) &&
"Only one Decl argument may be NULL") ? static_cast<void>
(0) : __assert_fail ("(FromValueDecl || FromNullPtr || ToValueDecl || ToNullPtr) && \"Only one Decl argument may be NULL\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1868, __PRETTY_FUNCTION__))
1868 "Only one Decl argument may be NULL")(((FromValueDecl || FromNullPtr || ToValueDecl || ToNullPtr) &&
"Only one Decl argument may be NULL") ? static_cast<void>
(0) : __assert_fail ("(FromValueDecl || FromNullPtr || ToValueDecl || ToNullPtr) && \"Only one Decl argument may be NULL\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 1868, __PRETTY_FUNCTION__))
;
1869
1870 if (Same) {
1871 PrintValueDecl(FromValueDecl, FromAddressOf, FromExpr, FromNullPtr);
1872 } else if (!PrintTree) {
1873 OS << (FromDefault ? "(default) " : "");
1874 Bold();
1875 PrintValueDecl(FromValueDecl, FromAddressOf, FromExpr, FromNullPtr);
1876 Unbold();
1877 } else {
1878 OS << (FromDefault ? "[(default) " : "[");
1879 Bold();
1880 PrintValueDecl(FromValueDecl, FromAddressOf, FromExpr, FromNullPtr);
1881 Unbold();
1882 OS << " != " << (ToDefault ? "(default) " : "");
1883 Bold();
1884 PrintValueDecl(ToValueDecl, ToAddressOf, ToExpr, ToNullPtr);
1885 Unbold();
1886 OS << ']';
1887 }
1888 }
1889
1890 /// PrintValueDeclAndInteger - Uses the print functions for ValueDecl and
1891 /// APSInt to print a mixed difference.
1892 void PrintValueDeclAndInteger(ValueDecl *VD, bool NeedAddressOf,
1893 bool IsNullPtr, Expr *VDExpr, bool DefaultDecl,
1894 const llvm::APSInt &Val, QualType IntType,
1895 Expr *IntExpr, bool DefaultInt) {
1896 if (!PrintTree) {
1897 OS << (DefaultDecl ? "(default) " : "");
1898 Bold();
1899 PrintValueDecl(VD, NeedAddressOf, VDExpr, IsNullPtr);
1900 Unbold();
1901 } else {
1902 OS << (DefaultDecl ? "[(default) " : "[");
1903 Bold();
1904 PrintValueDecl(VD, NeedAddressOf, VDExpr, IsNullPtr);
1905 Unbold();
1906 OS << " != " << (DefaultInt ? "(default) " : "");
1907 PrintAPSInt(Val, IntExpr, true /*Valid*/, IntType, false /*PrintType*/);
1908 OS << ']';
1909 }
1910 }
1911
1912 /// PrintIntegerAndValueDecl - Uses the print functions for APSInt and
1913 /// ValueDecl to print a mixed difference.
1914 void PrintIntegerAndValueDecl(const llvm::APSInt &Val, QualType IntType,
1915 Expr *IntExpr, bool DefaultInt, ValueDecl *VD,
1916 bool NeedAddressOf, bool IsNullPtr,
1917 Expr *VDExpr, bool DefaultDecl) {
1918 if (!PrintTree) {
1919 OS << (DefaultInt ? "(default) " : "");
1920 PrintAPSInt(Val, IntExpr, true /*Valid*/, IntType, false /*PrintType*/);
1921 } else {
1922 OS << (DefaultInt ? "[(default) " : "[");
1923 PrintAPSInt(Val, IntExpr, true /*Valid*/, IntType, false /*PrintType*/);
1924 OS << " != " << (DefaultDecl ? "(default) " : "");
1925 Bold();
1926 PrintValueDecl(VD, NeedAddressOf, VDExpr, IsNullPtr);
1927 Unbold();
1928 OS << ']';
1929 }
1930 }
1931
1932 // Prints the appropriate placeholder for elided template arguments.
1933 void PrintElideArgs(unsigned NumElideArgs, unsigned Indent) {
1934 if (PrintTree) {
1935 OS << '\n';
1936 for (unsigned i = 0; i < Indent; ++i)
1937 OS << " ";
1938 }
1939 if (NumElideArgs == 0) return;
1940 if (NumElideArgs == 1)
1941 OS << "[...]";
1942 else
1943 OS << "[" << NumElideArgs << " * ...]";
1944 }
1945
1946 // Prints and highlights differences in Qualifiers.
1947 void PrintQualifiers(Qualifiers FromQual, Qualifiers ToQual) {
1948 // Both types have no qualifiers
1949 if (FromQual.empty() && ToQual.empty())
1950 return;
1951
1952 // Both types have same qualifiers
1953 if (FromQual == ToQual) {
1954 PrintQualifier(FromQual, /*ApplyBold*/false);
1955 return;
1956 }
1957
1958 // Find common qualifiers and strip them from FromQual and ToQual.
1959 Qualifiers CommonQual = Qualifiers::removeCommonQualifiers(FromQual,
1960 ToQual);
1961
1962 // The qualifiers are printed before the template name.
1963 // Inline printing:
1964 // The common qualifiers are printed. Then, qualifiers only in this type
1965 // are printed and highlighted. Finally, qualifiers only in the other
1966 // type are printed and highlighted inside parentheses after "missing".
1967 // Tree printing:
1968 // Qualifiers are printed next to each other, inside brackets, and
1969 // separated by "!=". The printing order is:
1970 // common qualifiers, highlighted from qualifiers, "!=",
1971 // common qualifiers, highlighted to qualifiers
1972 if (PrintTree) {
1973 OS << "[";
1974 if (CommonQual.empty() && FromQual.empty()) {
1975 Bold();
1976 OS << "(no qualifiers) ";
1977 Unbold();
1978 } else {
1979 PrintQualifier(CommonQual, /*ApplyBold*/false);
1980 PrintQualifier(FromQual, /*ApplyBold*/true);
1981 }
1982 OS << "!= ";
1983 if (CommonQual.empty() && ToQual.empty()) {
1984 Bold();
1985 OS << "(no qualifiers)";
1986 Unbold();
1987 } else {
1988 PrintQualifier(CommonQual, /*ApplyBold*/false,
1989 /*appendSpaceIfNonEmpty*/!ToQual.empty());
1990 PrintQualifier(ToQual, /*ApplyBold*/true,
1991 /*appendSpaceIfNonEmpty*/false);
1992 }
1993 OS << "] ";
1994 } else {
1995 PrintQualifier(CommonQual, /*ApplyBold*/false);
1996 PrintQualifier(FromQual, /*ApplyBold*/true);
1997 }
1998 }
1999
2000 void PrintQualifier(Qualifiers Q, bool ApplyBold,
2001 bool AppendSpaceIfNonEmpty = true) {
2002 if (Q.empty()) return;
2003 if (ApplyBold) Bold();
2004 Q.print(OS, Policy, AppendSpaceIfNonEmpty);
2005 if (ApplyBold) Unbold();
2006 }
2007
2008public:
2009
2010 TemplateDiff(raw_ostream &OS, ASTContext &Context, QualType FromType,
2011 QualType ToType, bool PrintTree, bool PrintFromType,
2012 bool ElideType, bool ShowColor)
2013 : Context(Context),
2014 Policy(Context.getLangOpts()),
2015 ElideType(ElideType),
2016 PrintTree(PrintTree),
2017 ShowColor(ShowColor),
2018 // When printing a single type, the FromType is the one printed.
2019 FromTemplateType(PrintFromType ? FromType : ToType),
2020 ToTemplateType(PrintFromType ? ToType : FromType),
2021 OS(OS),
2022 IsBold(false) {
2023 }
2024
2025 /// DiffTemplate - Start the template type diffing.
2026 void DiffTemplate() {
2027 Qualifiers FromQual = FromTemplateType.getQualifiers(),
2028 ToQual = ToTemplateType.getQualifiers();
2029
2030 const TemplateSpecializationType *FromOrigTST =
2031 GetTemplateSpecializationType(Context, FromTemplateType);
2032 const TemplateSpecializationType *ToOrigTST =
2033 GetTemplateSpecializationType(Context, ToTemplateType);
2034
2035 // Only checking templates.
2036 if (!FromOrigTST || !ToOrigTST)
2037 return;
2038
2039 // Different base templates.
2040 if (!hasSameTemplate(FromOrigTST, ToOrigTST)) {
2041 return;
2042 }
2043
2044 FromQual -= QualType(FromOrigTST, 0).getQualifiers();
2045 ToQual -= QualType(ToOrigTST, 0).getQualifiers();
2046
2047 // Same base template, but different arguments.
2048 Tree.SetTemplateDiff(FromOrigTST->getTemplateName().getAsTemplateDecl(),
2049 ToOrigTST->getTemplateName().getAsTemplateDecl(),
2050 FromQual, ToQual, false /*FromDefault*/,
2051 false /*ToDefault*/);
2052
2053 DiffTemplate(FromOrigTST, ToOrigTST);
2054 }
2055
2056 /// Emit - When the two types given are templated types with the same
2057 /// base template, a string representation of the type difference will be
2058 /// emitted to the stream and return true. Otherwise, return false.
2059 bool Emit() {
2060 Tree.StartTraverse();
2061 if (Tree.Empty())
2062 return false;
2063
2064 TreeToString();
2065 assert(!IsBold && "Bold is applied to end of string.")((!IsBold && "Bold is applied to end of string.") ? static_cast
<void> (0) : __assert_fail ("!IsBold && \"Bold is applied to end of string.\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/lib/AST/ASTDiagnostic.cpp"
, 2065, __PRETTY_FUNCTION__))
;
2066 return true;
2067 }
2068}; // end class TemplateDiff
2069} // end anonymous namespace
2070
2071/// FormatTemplateTypeDiff - A helper static function to start the template
2072/// diff and return the properly formatted string. Returns true if the diff
2073/// is successful.
2074static bool FormatTemplateTypeDiff(ASTContext &Context, QualType FromType,
2075 QualType ToType, bool PrintTree,
2076 bool PrintFromType, bool ElideType,
2077 bool ShowColors, raw_ostream &OS) {
2078 if (PrintTree)
2079 PrintFromType = true;
2080 TemplateDiff TD(OS, Context, FromType, ToType, PrintTree, PrintFromType,
2081 ElideType, ShowColors);
2082 TD.DiffTemplate();
2083 return TD.Emit();
2084}

/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h

1//===- Type.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/// \file
10/// C Language Family Type Representation
11///
12/// This file defines the clang::Type interface and subclasses, used to
13/// represent types for languages in the C family.
14//
15//===----------------------------------------------------------------------===//
16
17#ifndef LLVM_CLANG_AST_TYPE_H
18#define LLVM_CLANG_AST_TYPE_H
19
20#include "clang/AST/NestedNameSpecifier.h"
21#include "clang/AST/TemplateName.h"
22#include "clang/Basic/AddressSpaces.h"
23#include "clang/Basic/AttrKinds.h"
24#include "clang/Basic/Diagnostic.h"
25#include "clang/Basic/ExceptionSpecificationType.h"
26#include "clang/Basic/LLVM.h"
27#include "clang/Basic/Linkage.h"
28#include "clang/Basic/PartialDiagnostic.h"
29#include "clang/Basic/SourceLocation.h"
30#include "clang/Basic/Specifiers.h"
31#include "clang/Basic/Visibility.h"
32#include "llvm/ADT/APInt.h"
33#include "llvm/ADT/APSInt.h"
34#include "llvm/ADT/ArrayRef.h"
35#include "llvm/ADT/FoldingSet.h"
36#include "llvm/ADT/None.h"
37#include "llvm/ADT/Optional.h"
38#include "llvm/ADT/PointerIntPair.h"
39#include "llvm/ADT/PointerUnion.h"
40#include "llvm/ADT/StringRef.h"
41#include "llvm/ADT/Twine.h"
42#include "llvm/ADT/iterator_range.h"
43#include "llvm/Support/Casting.h"
44#include "llvm/Support/Compiler.h"
45#include "llvm/Support/ErrorHandling.h"
46#include "llvm/Support/PointerLikeTypeTraits.h"
47#include "llvm/Support/type_traits.h"
48#include "llvm/Support/TrailingObjects.h"
49#include <cassert>
50#include <cstddef>
51#include <cstdint>
52#include <cstring>
53#include <string>
54#include <type_traits>
55#include <utility>
56
57namespace clang {
58
59class ExtQuals;
60class QualType;
61class TagDecl;
62class Type;
63
64enum {
65 TypeAlignmentInBits = 4,
66 TypeAlignment = 1 << TypeAlignmentInBits
67};
68
69namespace serialization {
70 template <class T> class AbstractTypeReader;
71 template <class T> class AbstractTypeWriter;
72}
73
74} // namespace clang
75
76namespace llvm {
77
78 template <typename T>
79 struct PointerLikeTypeTraits;
80 template<>
81 struct PointerLikeTypeTraits< ::clang::Type*> {
82 static inline void *getAsVoidPointer(::clang::Type *P) { return P; }
83
84 static inline ::clang::Type *getFromVoidPointer(void *P) {
85 return static_cast< ::clang::Type*>(P);
86 }
87
88 enum { NumLowBitsAvailable = clang::TypeAlignmentInBits };
89 };
90
91 template<>
92 struct PointerLikeTypeTraits< ::clang::ExtQuals*> {
93 static inline void *getAsVoidPointer(::clang::ExtQuals *P) { return P; }
94
95 static inline ::clang::ExtQuals *getFromVoidPointer(void *P) {
96 return static_cast< ::clang::ExtQuals*>(P);
97 }
98
99 enum { NumLowBitsAvailable = clang::TypeAlignmentInBits };
100 };
101
102} // namespace llvm
103
104namespace clang {
105
106class ASTContext;
107template <typename> class CanQual;
108class CXXRecordDecl;
109class DeclContext;
110class EnumDecl;
111class Expr;
112class ExtQualsTypeCommonBase;
113class FunctionDecl;
114class IdentifierInfo;
115class NamedDecl;
116class ObjCInterfaceDecl;
117class ObjCProtocolDecl;
118class ObjCTypeParamDecl;
119struct PrintingPolicy;
120class RecordDecl;
121class Stmt;
122class TagDecl;
123class TemplateArgument;
124class TemplateArgumentListInfo;
125class TemplateArgumentLoc;
126class TemplateTypeParmDecl;
127class TypedefNameDecl;
128class UnresolvedUsingTypenameDecl;
129
130using CanQualType = CanQual<Type>;
131
132// Provide forward declarations for all of the *Type classes.
133#define TYPE(Class, Base) class Class##Type;
134#include "clang/AST/TypeNodes.inc"
135
136/// The collection of all-type qualifiers we support.
137/// Clang supports five independent qualifiers:
138/// * C99: const, volatile, and restrict
139/// * MS: __unaligned
140/// * Embedded C (TR18037): address spaces
141/// * Objective C: the GC attributes (none, weak, or strong)
142class Qualifiers {
143public:
144 enum TQ { // NOTE: These flags must be kept in sync with DeclSpec::TQ.
145 Const = 0x1,
146 Restrict = 0x2,
147 Volatile = 0x4,
148 CVRMask = Const | Volatile | Restrict
149 };
150
151 enum GC {
152 GCNone = 0,
153 Weak,
154 Strong
155 };
156
157 enum ObjCLifetime {
158 /// There is no lifetime qualification on this type.
159 OCL_None,
160
161 /// This object can be modified without requiring retains or
162 /// releases.
163 OCL_ExplicitNone,
164
165 /// Assigning into this object requires the old value to be
166 /// released and the new value to be retained. The timing of the
167 /// release of the old value is inexact: it may be moved to
168 /// immediately after the last known point where the value is
169 /// live.
170 OCL_Strong,
171
172 /// Reading or writing from this object requires a barrier call.
173 OCL_Weak,
174
175 /// Assigning into this object requires a lifetime extension.
176 OCL_Autoreleasing
177 };
178
179 enum {
180 /// The maximum supported address space number.
181 /// 23 bits should be enough for anyone.
182 MaxAddressSpace = 0x7fffffu,
183
184 /// The width of the "fast" qualifier mask.
185 FastWidth = 3,
186
187 /// The fast qualifier mask.
188 FastMask = (1 << FastWidth) - 1
189 };
190
191 /// Returns the common set of qualifiers while removing them from
192 /// the given sets.
193 static Qualifiers removeCommonQualifiers(Qualifiers &L, Qualifiers &R) {
194 // If both are only CVR-qualified, bit operations are sufficient.
195 if (!(L.Mask & ~CVRMask) && !(R.Mask & ~CVRMask)) {
196 Qualifiers Q;
197 Q.Mask = L.Mask & R.Mask;
198 L.Mask &= ~Q.Mask;
199 R.Mask &= ~Q.Mask;
200 return Q;
201 }
202
203 Qualifiers Q;
204 unsigned CommonCRV = L.getCVRQualifiers() & R.getCVRQualifiers();
205 Q.addCVRQualifiers(CommonCRV);
206 L.removeCVRQualifiers(CommonCRV);
207 R.removeCVRQualifiers(CommonCRV);
208
209 if (L.getObjCGCAttr() == R.getObjCGCAttr()) {
210 Q.setObjCGCAttr(L.getObjCGCAttr());
211 L.removeObjCGCAttr();
212 R.removeObjCGCAttr();
213 }
214
215 if (L.getObjCLifetime() == R.getObjCLifetime()) {
216 Q.setObjCLifetime(L.getObjCLifetime());
217 L.removeObjCLifetime();
218 R.removeObjCLifetime();
219 }
220
221 if (L.getAddressSpace() == R.getAddressSpace()) {
222 Q.setAddressSpace(L.getAddressSpace());
223 L.removeAddressSpace();
224 R.removeAddressSpace();
225 }
226 return Q;
227 }
228
229 static Qualifiers fromFastMask(unsigned Mask) {
230 Qualifiers Qs;
231 Qs.addFastQualifiers(Mask);
232 return Qs;
233 }
234
235 static Qualifiers fromCVRMask(unsigned CVR) {
236 Qualifiers Qs;
237 Qs.addCVRQualifiers(CVR);
238 return Qs;
239 }
240
241 static Qualifiers fromCVRUMask(unsigned CVRU) {
242 Qualifiers Qs;
243 Qs.addCVRUQualifiers(CVRU);
244 return Qs;
245 }
246
247 // Deserialize qualifiers from an opaque representation.
248 static Qualifiers fromOpaqueValue(unsigned opaque) {
249 Qualifiers Qs;
250 Qs.Mask = opaque;
251 return Qs;
252 }
253
254 // Serialize these qualifiers into an opaque representation.
255 unsigned getAsOpaqueValue() const {
256 return Mask;
257 }
258
259 bool hasConst() const { return Mask & Const; }
260 bool hasOnlyConst() const { return Mask == Const; }
261 void removeConst() { Mask &= ~Const; }
262 void addConst() { Mask |= Const; }
263
264 bool hasVolatile() const { return Mask & Volatile; }
265 bool hasOnlyVolatile() const { return Mask == Volatile; }
266 void removeVolatile() { Mask &= ~Volatile; }
267 void addVolatile() { Mask |= Volatile; }
268
269 bool hasRestrict() const { return Mask & Restrict; }
270 bool hasOnlyRestrict() const { return Mask == Restrict; }
271 void removeRestrict() { Mask &= ~Restrict; }
272 void addRestrict() { Mask |= Restrict; }
273
274 bool hasCVRQualifiers() const { return getCVRQualifiers(); }
275 unsigned getCVRQualifiers() const { return Mask & CVRMask; }
276 unsigned getCVRUQualifiers() const { return Mask & (CVRMask | UMask); }
277
278 void setCVRQualifiers(unsigned mask) {
279 assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")((!(mask & ~CVRMask) && "bitmask contains non-CVR bits"
) ? static_cast<void> (0) : __assert_fail ("!(mask & ~CVRMask) && \"bitmask contains non-CVR bits\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 279, __PRETTY_FUNCTION__))
;
280 Mask = (Mask & ~CVRMask) | mask;
281 }
282 void removeCVRQualifiers(unsigned mask) {
283 assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")((!(mask & ~CVRMask) && "bitmask contains non-CVR bits"
) ? static_cast<void> (0) : __assert_fail ("!(mask & ~CVRMask) && \"bitmask contains non-CVR bits\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 283, __PRETTY_FUNCTION__))
;
284 Mask &= ~mask;
285 }
286 void removeCVRQualifiers() {
287 removeCVRQualifiers(CVRMask);
288 }
289 void addCVRQualifiers(unsigned mask) {
290 assert(!(mask & ~CVRMask) && "bitmask contains non-CVR bits")((!(mask & ~CVRMask) && "bitmask contains non-CVR bits"
) ? static_cast<void> (0) : __assert_fail ("!(mask & ~CVRMask) && \"bitmask contains non-CVR bits\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 290, __PRETTY_FUNCTION__))
;
291 Mask |= mask;
292 }
293 void addCVRUQualifiers(unsigned mask) {
294 assert(!(mask & ~CVRMask & ~UMask) && "bitmask contains non-CVRU bits")((!(mask & ~CVRMask & ~UMask) && "bitmask contains non-CVRU bits"
) ? static_cast<void> (0) : __assert_fail ("!(mask & ~CVRMask & ~UMask) && \"bitmask contains non-CVRU bits\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 294, __PRETTY_FUNCTION__))
;
295 Mask |= mask;
296 }
297
298 bool hasUnaligned() const { return Mask & UMask; }
299 void setUnaligned(bool flag) {
300 Mask = (Mask & ~UMask) | (flag ? UMask : 0);
301 }
302 void removeUnaligned() { Mask &= ~UMask; }
303 void addUnaligned() { Mask |= UMask; }
304
305 bool hasObjCGCAttr() const { return Mask & GCAttrMask; }
306 GC getObjCGCAttr() const { return GC((Mask & GCAttrMask) >> GCAttrShift); }
307 void setObjCGCAttr(GC type) {
308 Mask = (Mask & ~GCAttrMask) | (type << GCAttrShift);
309 }
310 void removeObjCGCAttr() { setObjCGCAttr(GCNone); }
311 void addObjCGCAttr(GC type) {
312 assert(type)((type) ? static_cast<void> (0) : __assert_fail ("type"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 312, __PRETTY_FUNCTION__))
;
313 setObjCGCAttr(type);
314 }
315 Qualifiers withoutObjCGCAttr() const {
316 Qualifiers qs = *this;
317 qs.removeObjCGCAttr();
318 return qs;
319 }
320 Qualifiers withoutObjCLifetime() const {
321 Qualifiers qs = *this;
322 qs.removeObjCLifetime();
323 return qs;
324 }
325 Qualifiers withoutAddressSpace() const {
326 Qualifiers qs = *this;
327 qs.removeAddressSpace();
328 return qs;
329 }
330
331 bool hasObjCLifetime() const { return Mask & LifetimeMask; }
332 ObjCLifetime getObjCLifetime() const {
333 return ObjCLifetime((Mask & LifetimeMask) >> LifetimeShift);
334 }
335 void setObjCLifetime(ObjCLifetime type) {
336 Mask = (Mask & ~LifetimeMask) | (type << LifetimeShift);
337 }
338 void removeObjCLifetime() { setObjCLifetime(OCL_None); }
339 void addObjCLifetime(ObjCLifetime type) {
340 assert(type)((type) ? static_cast<void> (0) : __assert_fail ("type"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 340, __PRETTY_FUNCTION__))
;
341 assert(!hasObjCLifetime())((!hasObjCLifetime()) ? static_cast<void> (0) : __assert_fail
("!hasObjCLifetime()", "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 341, __PRETTY_FUNCTION__))
;
342 Mask |= (type << LifetimeShift);
343 }
344
345 /// True if the lifetime is neither None or ExplicitNone.
346 bool hasNonTrivialObjCLifetime() const {
347 ObjCLifetime lifetime = getObjCLifetime();
348 return (lifetime > OCL_ExplicitNone);
349 }
350
351 /// True if the lifetime is either strong or weak.
352 bool hasStrongOrWeakObjCLifetime() const {
353 ObjCLifetime lifetime = getObjCLifetime();
354 return (lifetime == OCL_Strong || lifetime == OCL_Weak);
355 }
356
357 bool hasAddressSpace() const { return Mask & AddressSpaceMask; }
358 LangAS getAddressSpace() const {
359 return static_cast<LangAS>(Mask >> AddressSpaceShift);
360 }
361 bool hasTargetSpecificAddressSpace() const {
362 return isTargetAddressSpace(getAddressSpace());
363 }
364 /// Get the address space attribute value to be printed by diagnostics.
365 unsigned getAddressSpaceAttributePrintValue() const {
366 auto Addr = getAddressSpace();
367 // This function is not supposed to be used with language specific
368 // address spaces. If that happens, the diagnostic message should consider
369 // printing the QualType instead of the address space value.
370 assert(Addr == LangAS::Default || hasTargetSpecificAddressSpace())((Addr == LangAS::Default || hasTargetSpecificAddressSpace())
? static_cast<void> (0) : __assert_fail ("Addr == LangAS::Default || hasTargetSpecificAddressSpace()"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 370, __PRETTY_FUNCTION__))
;
371 if (Addr != LangAS::Default)
372 return toTargetAddressSpace(Addr);
373 // TODO: The diagnostic messages where Addr may be 0 should be fixed
374 // since it cannot differentiate the situation where 0 denotes the default
375 // address space or user specified __attribute__((address_space(0))).
376 return 0;
377 }
378 void setAddressSpace(LangAS space) {
379 assert((unsigned)space <= MaxAddressSpace)(((unsigned)space <= MaxAddressSpace) ? static_cast<void
> (0) : __assert_fail ("(unsigned)space <= MaxAddressSpace"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 379, __PRETTY_FUNCTION__))
;
380 Mask = (Mask & ~AddressSpaceMask)
381 | (((uint32_t) space) << AddressSpaceShift);
382 }
383 void removeAddressSpace() { setAddressSpace(LangAS::Default); }
384 void addAddressSpace(LangAS space) {
385 assert(space != LangAS::Default)((space != LangAS::Default) ? static_cast<void> (0) : __assert_fail
("space != LangAS::Default", "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 385, __PRETTY_FUNCTION__))
;
386 setAddressSpace(space);
387 }
388
389 // Fast qualifiers are those that can be allocated directly
390 // on a QualType object.
391 bool hasFastQualifiers() const { return getFastQualifiers(); }
392 unsigned getFastQualifiers() const { return Mask & FastMask; }
393 void setFastQualifiers(unsigned mask) {
394 assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")((!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits"
) ? static_cast<void> (0) : __assert_fail ("!(mask & ~FastMask) && \"bitmask contains non-fast qualifier bits\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 394, __PRETTY_FUNCTION__))
;
395 Mask = (Mask & ~FastMask) | mask;
396 }
397 void removeFastQualifiers(unsigned mask) {
398 assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")((!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits"
) ? static_cast<void> (0) : __assert_fail ("!(mask & ~FastMask) && \"bitmask contains non-fast qualifier bits\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 398, __PRETTY_FUNCTION__))
;
399 Mask &= ~mask;
400 }
401 void removeFastQualifiers() {
402 removeFastQualifiers(FastMask);
403 }
404 void addFastQualifiers(unsigned mask) {
405 assert(!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits")((!(mask & ~FastMask) && "bitmask contains non-fast qualifier bits"
) ? static_cast<void> (0) : __assert_fail ("!(mask & ~FastMask) && \"bitmask contains non-fast qualifier bits\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 405, __PRETTY_FUNCTION__))
;
406 Mask |= mask;
407 }
408
409 /// Return true if the set contains any qualifiers which require an ExtQuals
410 /// node to be allocated.
411 bool hasNonFastQualifiers() const { return Mask & ~FastMask; }
412 Qualifiers getNonFastQualifiers() const {
413 Qualifiers Quals = *this;
414 Quals.setFastQualifiers(0);
415 return Quals;
416 }
417
418 /// Return true if the set contains any qualifiers.
419 bool hasQualifiers() const { return Mask; }
420 bool empty() const { return !Mask; }
421
422 /// Add the qualifiers from the given set to this set.
423 void addQualifiers(Qualifiers Q) {
424 // If the other set doesn't have any non-boolean qualifiers, just
425 // bit-or it in.
426 if (!(Q.Mask & ~CVRMask))
427 Mask |= Q.Mask;
428 else {
429 Mask |= (Q.Mask & CVRMask);
430 if (Q.hasAddressSpace())
431 addAddressSpace(Q.getAddressSpace());
432 if (Q.hasObjCGCAttr())
433 addObjCGCAttr(Q.getObjCGCAttr());
434 if (Q.hasObjCLifetime())
435 addObjCLifetime(Q.getObjCLifetime());
436 }
437 }
438
439 /// Remove the qualifiers from the given set from this set.
440 void removeQualifiers(Qualifiers Q) {
441 // If the other set doesn't have any non-boolean qualifiers, just
442 // bit-and the inverse in.
443 if (!(Q.Mask & ~CVRMask))
444 Mask &= ~Q.Mask;
445 else {
446 Mask &= ~(Q.Mask & CVRMask);
447 if (getObjCGCAttr() == Q.getObjCGCAttr())
448 removeObjCGCAttr();
449 if (getObjCLifetime() == Q.getObjCLifetime())
450 removeObjCLifetime();
451 if (getAddressSpace() == Q.getAddressSpace())
452 removeAddressSpace();
453 }
454 }
455
456 /// Add the qualifiers from the given set to this set, given that
457 /// they don't conflict.
458 void addConsistentQualifiers(Qualifiers qs) {
459 assert(getAddressSpace() == qs.getAddressSpace() ||((getAddressSpace() == qs.getAddressSpace() || !hasAddressSpace
() || !qs.hasAddressSpace()) ? static_cast<void> (0) : __assert_fail
("getAddressSpace() == qs.getAddressSpace() || !hasAddressSpace() || !qs.hasAddressSpace()"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 460, __PRETTY_FUNCTION__))
460 !hasAddressSpace() || !qs.hasAddressSpace())((getAddressSpace() == qs.getAddressSpace() || !hasAddressSpace
() || !qs.hasAddressSpace()) ? static_cast<void> (0) : __assert_fail
("getAddressSpace() == qs.getAddressSpace() || !hasAddressSpace() || !qs.hasAddressSpace()"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 460, __PRETTY_FUNCTION__))
;
461 assert(getObjCGCAttr() == qs.getObjCGCAttr() ||((getObjCGCAttr() == qs.getObjCGCAttr() || !hasObjCGCAttr() ||
!qs.hasObjCGCAttr()) ? static_cast<void> (0) : __assert_fail
("getObjCGCAttr() == qs.getObjCGCAttr() || !hasObjCGCAttr() || !qs.hasObjCGCAttr()"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 462, __PRETTY_FUNCTION__))
462 !hasObjCGCAttr() || !qs.hasObjCGCAttr())((getObjCGCAttr() == qs.getObjCGCAttr() || !hasObjCGCAttr() ||
!qs.hasObjCGCAttr()) ? static_cast<void> (0) : __assert_fail
("getObjCGCAttr() == qs.getObjCGCAttr() || !hasObjCGCAttr() || !qs.hasObjCGCAttr()"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 462, __PRETTY_FUNCTION__))
;
463 assert(getObjCLifetime() == qs.getObjCLifetime() ||((getObjCLifetime() == qs.getObjCLifetime() || !hasObjCLifetime
() || !qs.hasObjCLifetime()) ? static_cast<void> (0) : __assert_fail
("getObjCLifetime() == qs.getObjCLifetime() || !hasObjCLifetime() || !qs.hasObjCLifetime()"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 464, __PRETTY_FUNCTION__))
464 !hasObjCLifetime() || !qs.hasObjCLifetime())((getObjCLifetime() == qs.getObjCLifetime() || !hasObjCLifetime
() || !qs.hasObjCLifetime()) ? static_cast<void> (0) : __assert_fail
("getObjCLifetime() == qs.getObjCLifetime() || !hasObjCLifetime() || !qs.hasObjCLifetime()"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 464, __PRETTY_FUNCTION__))
;
465 Mask |= qs.Mask;
466 }
467
468 /// Returns true if address space A is equal to or a superset of B.
469 /// OpenCL v2.0 defines conversion rules (OpenCLC v2.0 s6.5.5) and notion of
470 /// overlapping address spaces.
471 /// CL1.1 or CL1.2:
472 /// every address space is a superset of itself.
473 /// CL2.0 adds:
474 /// __generic is a superset of any address space except for __constant.
475 static bool isAddressSpaceSupersetOf(LangAS A, LangAS B) {
476 // Address spaces must match exactly.
477 return A == B ||
478 // Otherwise in OpenCLC v2.0 s6.5.5: every address space except
479 // for __constant can be used as __generic.
480 (A == LangAS::opencl_generic && B != LangAS::opencl_constant) ||
481 // Consider pointer size address spaces to be equivalent to default.
482 ((isPtrSizeAddressSpace(A) || A == LangAS::Default) &&
483 (isPtrSizeAddressSpace(B) || B == LangAS::Default));
484 }
485
486 /// Returns true if the address space in these qualifiers is equal to or
487 /// a superset of the address space in the argument qualifiers.
488 bool isAddressSpaceSupersetOf(Qualifiers other) const {
489 return isAddressSpaceSupersetOf(getAddressSpace(), other.getAddressSpace());
490 }
491
492 /// Determines if these qualifiers compatibly include another set.
493 /// Generally this answers the question of whether an object with the other
494 /// qualifiers can be safely used as an object with these qualifiers.
495 bool compatiblyIncludes(Qualifiers other) const {
496 return isAddressSpaceSupersetOf(other) &&
497 // ObjC GC qualifiers can match, be added, or be removed, but can't
498 // be changed.
499 (getObjCGCAttr() == other.getObjCGCAttr() || !hasObjCGCAttr() ||
500 !other.hasObjCGCAttr()) &&
501 // ObjC lifetime qualifiers must match exactly.
502 getObjCLifetime() == other.getObjCLifetime() &&
503 // CVR qualifiers may subset.
504 (((Mask & CVRMask) | (other.Mask & CVRMask)) == (Mask & CVRMask)) &&
505 // U qualifier may superset.
506 (!other.hasUnaligned() || hasUnaligned());
507 }
508
509 /// Determines if these qualifiers compatibly include another set of
510 /// qualifiers from the narrow perspective of Objective-C ARC lifetime.
511 ///
512 /// One set of Objective-C lifetime qualifiers compatibly includes the other
513 /// if the lifetime qualifiers match, or if both are non-__weak and the
514 /// including set also contains the 'const' qualifier, or both are non-__weak
515 /// and one is None (which can only happen in non-ARC modes).
516 bool compatiblyIncludesObjCLifetime(Qualifiers other) const {
517 if (getObjCLifetime() == other.getObjCLifetime())
518 return true;
519
520 if (getObjCLifetime() == OCL_Weak || other.getObjCLifetime() == OCL_Weak)
521 return false;
522
523 if (getObjCLifetime() == OCL_None || other.getObjCLifetime() == OCL_None)
524 return true;
525
526 return hasConst();
527 }
528
529 /// Determine whether this set of qualifiers is a strict superset of
530 /// another set of qualifiers, not considering qualifier compatibility.
531 bool isStrictSupersetOf(Qualifiers Other) const;
532
533 bool operator==(Qualifiers Other) const { return Mask == Other.Mask; }
534 bool operator!=(Qualifiers Other) const { return Mask != Other.Mask; }
535
536 explicit operator bool() const { return hasQualifiers(); }
537
538 Qualifiers &operator+=(Qualifiers R) {
539 addQualifiers(R);
540 return *this;
541 }
542
543 // Union two qualifier sets. If an enumerated qualifier appears
544 // in both sets, use the one from the right.
545 friend Qualifiers operator+(Qualifiers L, Qualifiers R) {
546 L += R;
547 return L;
548 }
549
550 Qualifiers &operator-=(Qualifiers R) {
551 removeQualifiers(R);
552 return *this;
553 }
554
555 /// Compute the difference between two qualifier sets.
556 friend Qualifiers operator-(Qualifiers L, Qualifiers R) {
557 L -= R;
558 return L;
559 }
560
561 std::string getAsString() const;
562 std::string getAsString(const PrintingPolicy &Policy) const;
563
564 static std::string getAddrSpaceAsString(LangAS AS);
565
566 bool isEmptyWhenPrinted(const PrintingPolicy &Policy) const;
567 void print(raw_ostream &OS, const PrintingPolicy &Policy,
568 bool appendSpaceIfNonEmpty = false) const;
569
570 void Profile(llvm::FoldingSetNodeID &ID) const {
571 ID.AddInteger(Mask);
572 }
573
574private:
575 // bits: |0 1 2|3|4 .. 5|6 .. 8|9 ... 31|
576 // |C R V|U|GCAttr|Lifetime|AddressSpace|
577 uint32_t Mask = 0;
578
579 static const uint32_t UMask = 0x8;
580 static const uint32_t UShift = 3;
581 static const uint32_t GCAttrMask = 0x30;
582 static const uint32_t GCAttrShift = 4;
583 static const uint32_t LifetimeMask = 0x1C0;
584 static const uint32_t LifetimeShift = 6;
585 static const uint32_t AddressSpaceMask =
586 ~(CVRMask | UMask | GCAttrMask | LifetimeMask);
587 static const uint32_t AddressSpaceShift = 9;
588};
589
590/// A std::pair-like structure for storing a qualified type split
591/// into its local qualifiers and its locally-unqualified type.
592struct SplitQualType {
593 /// The locally-unqualified type.
594 const Type *Ty = nullptr;
595
596 /// The local qualifiers.
597 Qualifiers Quals;
598
599 SplitQualType() = default;
600 SplitQualType(const Type *ty, Qualifiers qs) : Ty(ty), Quals(qs) {}
601
602 SplitQualType getSingleStepDesugaredType() const; // end of this file
603
604 // Make std::tie work.
605 std::pair<const Type *,Qualifiers> asPair() const {
606 return std::pair<const Type *, Qualifiers>(Ty, Quals);
607 }
608
609 friend bool operator==(SplitQualType a, SplitQualType b) {
610 return a.Ty == b.Ty && a.Quals == b.Quals;
611 }
612 friend bool operator!=(SplitQualType a, SplitQualType b) {
613 return a.Ty != b.Ty || a.Quals != b.Quals;
614 }
615};
616
617/// The kind of type we are substituting Objective-C type arguments into.
618///
619/// The kind of substitution affects the replacement of type parameters when
620/// no concrete type information is provided, e.g., when dealing with an
621/// unspecialized type.
622enum class ObjCSubstitutionContext {
623 /// An ordinary type.
624 Ordinary,
625
626 /// The result type of a method or function.
627 Result,
628
629 /// The parameter type of a method or function.
630 Parameter,
631
632 /// The type of a property.
633 Property,
634
635 /// The superclass of a type.
636 Superclass,
637};
638
639/// A (possibly-)qualified type.
640///
641/// For efficiency, we don't store CV-qualified types as nodes on their
642/// own: instead each reference to a type stores the qualifiers. This
643/// greatly reduces the number of nodes we need to allocate for types (for
644/// example we only need one for 'int', 'const int', 'volatile int',
645/// 'const volatile int', etc).
646///
647/// As an added efficiency bonus, instead of making this a pair, we
648/// just store the two bits we care about in the low bits of the
649/// pointer. To handle the packing/unpacking, we make QualType be a
650/// simple wrapper class that acts like a smart pointer. A third bit
651/// indicates whether there are extended qualifiers present, in which
652/// case the pointer points to a special structure.
653class QualType {
654 friend class QualifierCollector;
655
656 // Thankfully, these are efficiently composable.
657 llvm::PointerIntPair<llvm::PointerUnion<const Type *, const ExtQuals *>,
658 Qualifiers::FastWidth> Value;
659
660 const ExtQuals *getExtQualsUnsafe() const {
661 return Value.getPointer().get<const ExtQuals*>();
662 }
663
664 const Type *getTypePtrUnsafe() const {
665 return Value.getPointer().get<const Type*>();
666 }
667
668 const ExtQualsTypeCommonBase *getCommonPtr() const {
669 assert(!isNull() && "Cannot retrieve a NULL type pointer")((!isNull() && "Cannot retrieve a NULL type pointer")
? static_cast<void> (0) : __assert_fail ("!isNull() && \"Cannot retrieve a NULL type pointer\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 669, __PRETTY_FUNCTION__))
;
670 auto CommonPtrVal = reinterpret_cast<uintptr_t>(Value.getOpaqueValue());
671 CommonPtrVal &= ~(uintptr_t)((1 << TypeAlignmentInBits) - 1);
672 return reinterpret_cast<ExtQualsTypeCommonBase*>(CommonPtrVal);
673 }
674
675public:
676 QualType() = default;
677 QualType(const Type *Ptr, unsigned Quals) : Value(Ptr, Quals) {}
678 QualType(const ExtQuals *Ptr, unsigned Quals) : Value(Ptr, Quals) {}
679
680 unsigned getLocalFastQualifiers() const { return Value.getInt(); }
681 void setLocalFastQualifiers(unsigned Quals) { Value.setInt(Quals); }
682
683 /// Retrieves a pointer to the underlying (unqualified) type.
684 ///
685 /// This function requires that the type not be NULL. If the type might be
686 /// NULL, use the (slightly less efficient) \c getTypePtrOrNull().
687 const Type *getTypePtr() const;
688
689 const Type *getTypePtrOrNull() const;
690
691 /// Retrieves a pointer to the name of the base type.
692 const IdentifierInfo *getBaseTypeIdentifier() const;
693
694 /// Divides a QualType into its unqualified type and a set of local
695 /// qualifiers.
696 SplitQualType split() const;
697
698 void *getAsOpaquePtr() const { return Value.getOpaqueValue(); }
699
700 static QualType getFromOpaquePtr(const void *Ptr) {
701 QualType T;
702 T.Value.setFromOpaqueValue(const_cast<void*>(Ptr));
703 return T;
704 }
705
706 const Type &operator*() const {
707 return *getTypePtr();
708 }
709
710 const Type *operator->() const {
711 return getTypePtr();
712 }
713
714 bool isCanonical() const;
715 bool isCanonicalAsParam() const;
716
717 /// Return true if this QualType doesn't point to a type yet.
718 bool isNull() const {
719 return Value.getPointer().isNull();
720 }
721
722 /// Determine whether this particular QualType instance has the
723 /// "const" qualifier set, without looking through typedefs that may have
724 /// added "const" at a different level.
725 bool isLocalConstQualified() const {
726 return (getLocalFastQualifiers() & Qualifiers::Const);
727 }
728
729 /// Determine whether this type is const-qualified.
730 bool isConstQualified() const;
731
732 /// Determine whether this particular QualType instance has the
733 /// "restrict" qualifier set, without looking through typedefs that may have
734 /// added "restrict" at a different level.
735 bool isLocalRestrictQualified() const {
736 return (getLocalFastQualifiers() & Qualifiers::Restrict);
737 }
738
739 /// Determine whether this type is restrict-qualified.
740 bool isRestrictQualified() const;
741
742 /// Determine whether this particular QualType instance has the
743 /// "volatile" qualifier set, without looking through typedefs that may have
744 /// added "volatile" at a different level.
745 bool isLocalVolatileQualified() const {
746 return (getLocalFastQualifiers() & Qualifiers::Volatile);
747 }
748
749 /// Determine whether this type is volatile-qualified.
750 bool isVolatileQualified() const;
751
752 /// Determine whether this particular QualType instance has any
753 /// qualifiers, without looking through any typedefs that might add
754 /// qualifiers at a different level.
755 bool hasLocalQualifiers() const {
756 return getLocalFastQualifiers() || hasLocalNonFastQualifiers();
757 }
758
759 /// Determine whether this type has any qualifiers.
760 bool hasQualifiers() const;
761
762 /// Determine whether this particular QualType instance has any
763 /// "non-fast" qualifiers, e.g., those that are stored in an ExtQualType
764 /// instance.
765 bool hasLocalNonFastQualifiers() const {
766 return Value.getPointer().is<const ExtQuals*>();
767 }
768
769 /// Retrieve the set of qualifiers local to this particular QualType
770 /// instance, not including any qualifiers acquired through typedefs or
771 /// other sugar.
772 Qualifiers getLocalQualifiers() const;
773
774 /// Retrieve the set of qualifiers applied to this type.
775 Qualifiers getQualifiers() const;
776
777 /// Retrieve the set of CVR (const-volatile-restrict) qualifiers
778 /// local to this particular QualType instance, not including any qualifiers
779 /// acquired through typedefs or other sugar.
780 unsigned getLocalCVRQualifiers() const {
781 return getLocalFastQualifiers();
782 }
783
784 /// Retrieve the set of CVR (const-volatile-restrict) qualifiers
785 /// applied to this type.
786 unsigned getCVRQualifiers() const;
787
788 bool isConstant(const ASTContext& Ctx) const {
789 return QualType::isConstant(*this, Ctx);
790 }
791
792 /// Determine whether this is a Plain Old Data (POD) type (C++ 3.9p10).
793 bool isPODType(const ASTContext &Context) const;
794
795 /// Return true if this is a POD type according to the rules of the C++98
796 /// standard, regardless of the current compilation's language.
797 bool isCXX98PODType(const ASTContext &Context) const;
798
799 /// Return true if this is a POD type according to the more relaxed rules
800 /// of the C++11 standard, regardless of the current compilation's language.
801 /// (C++0x [basic.types]p9). Note that, unlike
802 /// CXXRecordDecl::isCXX11StandardLayout, this takes DRs into account.
803 bool isCXX11PODType(const ASTContext &Context) const;
804
805 /// Return true if this is a trivial type per (C++0x [basic.types]p9)
806 bool isTrivialType(const ASTContext &Context) const;
807
808 /// Return true if this is a trivially copyable type (C++0x [basic.types]p9)
809 bool isTriviallyCopyableType(const ASTContext &Context) const;
810
811
812 /// Returns true if it is a class and it might be dynamic.
813 bool mayBeDynamicClass() const;
814
815 /// Returns true if it is not a class or if the class might not be dynamic.
816 bool mayBeNotDynamicClass() const;
817
818 // Don't promise in the API that anything besides 'const' can be
819 // easily added.
820
821 /// Add the `const` type qualifier to this QualType.
822 void addConst() {
823 addFastQualifiers(Qualifiers::Const);
824 }
825 QualType withConst() const {
826 return withFastQualifiers(Qualifiers::Const);
827 }
828
829 /// Add the `volatile` type qualifier to this QualType.
830 void addVolatile() {
831 addFastQualifiers(Qualifiers::Volatile);
832 }
833 QualType withVolatile() const {
834 return withFastQualifiers(Qualifiers::Volatile);
835 }
836
837 /// Add the `restrict` qualifier to this QualType.
838 void addRestrict() {
839 addFastQualifiers(Qualifiers::Restrict);
840 }
841 QualType withRestrict() const {
842 return withFastQualifiers(Qualifiers::Restrict);
843 }
844
845 QualType withCVRQualifiers(unsigned CVR) const {
846 return withFastQualifiers(CVR);
847 }
848
849 void addFastQualifiers(unsigned TQs) {
850 assert(!(TQs & ~Qualifiers::FastMask)((!(TQs & ~Qualifiers::FastMask) && "non-fast qualifier bits set in mask!"
) ? static_cast<void> (0) : __assert_fail ("!(TQs & ~Qualifiers::FastMask) && \"non-fast qualifier bits set in mask!\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 851, __PRETTY_FUNCTION__))
851 && "non-fast qualifier bits set in mask!")((!(TQs & ~Qualifiers::FastMask) && "non-fast qualifier bits set in mask!"
) ? static_cast<void> (0) : __assert_fail ("!(TQs & ~Qualifiers::FastMask) && \"non-fast qualifier bits set in mask!\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 851, __PRETTY_FUNCTION__))
;
852 Value.setInt(Value.getInt() | TQs);
853 }
854
855 void removeLocalConst();
856 void removeLocalVolatile();
857 void removeLocalRestrict();
858 void removeLocalCVRQualifiers(unsigned Mask);
859
860 void removeLocalFastQualifiers() { Value.setInt(0); }
861 void removeLocalFastQualifiers(unsigned Mask) {
862 assert(!(Mask & ~Qualifiers::FastMask) && "mask has non-fast qualifiers")((!(Mask & ~Qualifiers::FastMask) && "mask has non-fast qualifiers"
) ? static_cast<void> (0) : __assert_fail ("!(Mask & ~Qualifiers::FastMask) && \"mask has non-fast qualifiers\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 862, __PRETTY_FUNCTION__))
;
863 Value.setInt(Value.getInt() & ~Mask);
864 }
865
866 // Creates a type with the given qualifiers in addition to any
867 // qualifiers already on this type.
868 QualType withFastQualifiers(unsigned TQs) const {
869 QualType T = *this;
870 T.addFastQualifiers(TQs);
871 return T;
872 }
873
874 // Creates a type with exactly the given fast qualifiers, removing
875 // any existing fast qualifiers.
876 QualType withExactLocalFastQualifiers(unsigned TQs) const {
877 return withoutLocalFastQualifiers().withFastQualifiers(TQs);
878 }
879
880 // Removes fast qualifiers, but leaves any extended qualifiers in place.
881 QualType withoutLocalFastQualifiers() const {
882 QualType T = *this;
883 T.removeLocalFastQualifiers();
884 return T;
885 }
886
887 QualType getCanonicalType() const;
888
889 /// Return this type with all of the instance-specific qualifiers
890 /// removed, but without removing any qualifiers that may have been applied
891 /// through typedefs.
892 QualType getLocalUnqualifiedType() const { return QualType(getTypePtr(), 0); }
893
894 /// Retrieve the unqualified variant of the given type,
895 /// removing as little sugar as possible.
896 ///
897 /// This routine looks through various kinds of sugar to find the
898 /// least-desugared type that is unqualified. For example, given:
899 ///
900 /// \code
901 /// typedef int Integer;
902 /// typedef const Integer CInteger;
903 /// typedef CInteger DifferenceType;
904 /// \endcode
905 ///
906 /// Executing \c getUnqualifiedType() on the type \c DifferenceType will
907 /// desugar until we hit the type \c Integer, which has no qualifiers on it.
908 ///
909 /// The resulting type might still be qualified if it's sugar for an array
910 /// type. To strip qualifiers even from within a sugared array type, use
911 /// ASTContext::getUnqualifiedArrayType.
912 inline QualType getUnqualifiedType() const;
913
914 /// Retrieve the unqualified variant of the given type, removing as little
915 /// sugar as possible.
916 ///
917 /// Like getUnqualifiedType(), but also returns the set of
918 /// qualifiers that were built up.
919 ///
920 /// The resulting type might still be qualified if it's sugar for an array
921 /// type. To strip qualifiers even from within a sugared array type, use
922 /// ASTContext::getUnqualifiedArrayType.
923 inline SplitQualType getSplitUnqualifiedType() const;
924
925 /// Determine whether this type is more qualified than the other
926 /// given type, requiring exact equality for non-CVR qualifiers.
927 bool isMoreQualifiedThan(QualType Other) const;
928
929 /// Determine whether this type is at least as qualified as the other
930 /// given type, requiring exact equality for non-CVR qualifiers.
931 bool isAtLeastAsQualifiedAs(QualType Other) const;
932
933 QualType getNonReferenceType() const;
934
935 /// Determine the type of a (typically non-lvalue) expression with the
936 /// specified result type.
937 ///
938 /// This routine should be used for expressions for which the return type is
939 /// explicitly specified (e.g., in a cast or call) and isn't necessarily
940 /// an lvalue. It removes a top-level reference (since there are no
941 /// expressions of reference type) and deletes top-level cvr-qualifiers
942 /// from non-class types (in C++) or all types (in C).
943 QualType getNonLValueExprType(const ASTContext &Context) const;
944
945 /// Return the specified type with any "sugar" removed from
946 /// the type. This takes off typedefs, typeof's etc. If the outer level of
947 /// the type is already concrete, it returns it unmodified. This is similar
948 /// to getting the canonical type, but it doesn't remove *all* typedefs. For
949 /// example, it returns "T*" as "T*", (not as "int*"), because the pointer is
950 /// concrete.
951 ///
952 /// Qualifiers are left in place.
953 QualType getDesugaredType(const ASTContext &Context) const {
954 return getDesugaredType(*this, Context);
955 }
956
957 SplitQualType getSplitDesugaredType() const {
958 return getSplitDesugaredType(*this);
959 }
960
961 /// Return the specified type with one level of "sugar" removed from
962 /// the type.
963 ///
964 /// This routine takes off the first typedef, typeof, etc. If the outer level
965 /// of the type is already concrete, it returns it unmodified.
966 QualType getSingleStepDesugaredType(const ASTContext &Context) const {
967 return getSingleStepDesugaredTypeImpl(*this, Context);
968 }
969
970 /// Returns the specified type after dropping any
971 /// outer-level parentheses.
972 QualType IgnoreParens() const {
973 if (isa<ParenType>(*this))
974 return QualType::IgnoreParens(*this);
975 return *this;
976 }
977
978 /// Indicate whether the specified types and qualifiers are identical.
979 friend bool operator==(const QualType &LHS, const QualType &RHS) {
980 return LHS.Value == RHS.Value;
981 }
982 friend bool operator!=(const QualType &LHS, const QualType &RHS) {
983 return LHS.Value != RHS.Value;
984 }
985 friend bool operator<(const QualType &LHS, const QualType &RHS) {
986 return LHS.Value < RHS.Value;
987 }
988
989 static std::string getAsString(SplitQualType split,
990 const PrintingPolicy &Policy) {
991 return getAsString(split.Ty, split.Quals, Policy);
992 }
993 static std::string getAsString(const Type *ty, Qualifiers qs,
994 const PrintingPolicy &Policy);
995
996 std::string getAsString() const;
997 std::string getAsString(const PrintingPolicy &Policy) const;
998
999 void print(raw_ostream &OS, const PrintingPolicy &Policy,
1000 const Twine &PlaceHolder = Twine(),
1001 unsigned Indentation = 0) const;
1002
1003 static void print(SplitQualType split, raw_ostream &OS,
1004 const PrintingPolicy &policy, const Twine &PlaceHolder,
1005 unsigned Indentation = 0) {
1006 return print(split.Ty, split.Quals, OS, policy, PlaceHolder, Indentation);
1007 }
1008
1009 static void print(const Type *ty, Qualifiers qs,
1010 raw_ostream &OS, const PrintingPolicy &policy,
1011 const Twine &PlaceHolder,
1012 unsigned Indentation = 0);
1013
1014 void getAsStringInternal(std::string &Str,
1015 const PrintingPolicy &Policy) const;
1016
1017 static void getAsStringInternal(SplitQualType split, std::string &out,
1018 const PrintingPolicy &policy) {
1019 return getAsStringInternal(split.Ty, split.Quals, out, policy);
1020 }
1021
1022 static void getAsStringInternal(const Type *ty, Qualifiers qs,
1023 std::string &out,
1024 const PrintingPolicy &policy);
1025
1026 class StreamedQualTypeHelper {
1027 const QualType &T;
1028 const PrintingPolicy &Policy;
1029 const Twine &PlaceHolder;
1030 unsigned Indentation;
1031
1032 public:
1033 StreamedQualTypeHelper(const QualType &T, const PrintingPolicy &Policy,
1034 const Twine &PlaceHolder, unsigned Indentation)
1035 : T(T), Policy(Policy), PlaceHolder(PlaceHolder),
1036 Indentation(Indentation) {}
1037
1038 friend raw_ostream &operator<<(raw_ostream &OS,
1039 const StreamedQualTypeHelper &SQT) {
1040 SQT.T.print(OS, SQT.Policy, SQT.PlaceHolder, SQT.Indentation);
1041 return OS;
1042 }
1043 };
1044
1045 StreamedQualTypeHelper stream(const PrintingPolicy &Policy,
1046 const Twine &PlaceHolder = Twine(),
1047 unsigned Indentation = 0) const {
1048 return StreamedQualTypeHelper(*this, Policy, PlaceHolder, Indentation);
1049 }
1050
1051 void dump(const char *s) const;
1052 void dump() const;
1053 void dump(llvm::raw_ostream &OS) const;
1054
1055 void Profile(llvm::FoldingSetNodeID &ID) const {
1056 ID.AddPointer(getAsOpaquePtr());
1057 }
1058
1059 /// Check if this type has any address space qualifier.
1060 inline bool hasAddressSpace() const;
1061
1062 /// Return the address space of this type.
1063 inline LangAS getAddressSpace() const;
1064
1065 /// Returns gc attribute of this type.
1066 inline Qualifiers::GC getObjCGCAttr() const;
1067
1068 /// true when Type is objc's weak.
1069 bool isObjCGCWeak() const {
1070 return getObjCGCAttr() == Qualifiers::Weak;
1071 }
1072
1073 /// true when Type is objc's strong.
1074 bool isObjCGCStrong() const {
1075 return getObjCGCAttr() == Qualifiers::Strong;
1076 }
1077
1078 /// Returns lifetime attribute of this type.
1079 Qualifiers::ObjCLifetime getObjCLifetime() const {
1080 return getQualifiers().getObjCLifetime();
1081 }
1082
1083 bool hasNonTrivialObjCLifetime() const {
1084 return getQualifiers().hasNonTrivialObjCLifetime();
1085 }
1086
1087 bool hasStrongOrWeakObjCLifetime() const {
1088 return getQualifiers().hasStrongOrWeakObjCLifetime();
1089 }
1090
1091 // true when Type is objc's weak and weak is enabled but ARC isn't.
1092 bool isNonWeakInMRRWithObjCWeak(const ASTContext &Context) const;
1093
1094 enum PrimitiveDefaultInitializeKind {
1095 /// The type does not fall into any of the following categories. Note that
1096 /// this case is zero-valued so that values of this enum can be used as a
1097 /// boolean condition for non-triviality.
1098 PDIK_Trivial,
1099
1100 /// The type is an Objective-C retainable pointer type that is qualified
1101 /// with the ARC __strong qualifier.
1102 PDIK_ARCStrong,
1103
1104 /// The type is an Objective-C retainable pointer type that is qualified
1105 /// with the ARC __weak qualifier.
1106 PDIK_ARCWeak,
1107
1108 /// The type is a struct containing a field whose type is not PCK_Trivial.
1109 PDIK_Struct
1110 };
1111
1112 /// Functions to query basic properties of non-trivial C struct types.
1113
1114 /// Check if this is a non-trivial type that would cause a C struct
1115 /// transitively containing this type to be non-trivial to default initialize
1116 /// and return the kind.
1117 PrimitiveDefaultInitializeKind
1118 isNonTrivialToPrimitiveDefaultInitialize() const;
1119
1120 enum PrimitiveCopyKind {
1121 /// The type does not fall into any of the following categories. Note that
1122 /// this case is zero-valued so that values of this enum can be used as a
1123 /// boolean condition for non-triviality.
1124 PCK_Trivial,
1125
1126 /// The type would be trivial except that it is volatile-qualified. Types
1127 /// that fall into one of the other non-trivial cases may additionally be
1128 /// volatile-qualified.
1129 PCK_VolatileTrivial,
1130
1131 /// The type is an Objective-C retainable pointer type that is qualified
1132 /// with the ARC __strong qualifier.
1133 PCK_ARCStrong,
1134
1135 /// The type is an Objective-C retainable pointer type that is qualified
1136 /// with the ARC __weak qualifier.
1137 PCK_ARCWeak,
1138
1139 /// The type is a struct containing a field whose type is neither
1140 /// PCK_Trivial nor PCK_VolatileTrivial.
1141 /// Note that a C++ struct type does not necessarily match this; C++ copying
1142 /// semantics are too complex to express here, in part because they depend
1143 /// on the exact constructor or assignment operator that is chosen by
1144 /// overload resolution to do the copy.
1145 PCK_Struct
1146 };
1147
1148 /// Check if this is a non-trivial type that would cause a C struct
1149 /// transitively containing this type to be non-trivial to copy and return the
1150 /// kind.
1151 PrimitiveCopyKind isNonTrivialToPrimitiveCopy() const;
1152
1153 /// Check if this is a non-trivial type that would cause a C struct
1154 /// transitively containing this type to be non-trivial to destructively
1155 /// move and return the kind. Destructive move in this context is a C++-style
1156 /// move in which the source object is placed in a valid but unspecified state
1157 /// after it is moved, as opposed to a truly destructive move in which the
1158 /// source object is placed in an uninitialized state.
1159 PrimitiveCopyKind isNonTrivialToPrimitiveDestructiveMove() const;
1160
1161 enum DestructionKind {
1162 DK_none,
1163 DK_cxx_destructor,
1164 DK_objc_strong_lifetime,
1165 DK_objc_weak_lifetime,
1166 DK_nontrivial_c_struct
1167 };
1168
1169 /// Returns a nonzero value if objects of this type require
1170 /// non-trivial work to clean up after. Non-zero because it's
1171 /// conceivable that qualifiers (objc_gc(weak)?) could make
1172 /// something require destruction.
1173 DestructionKind isDestructedType() const {
1174 return isDestructedTypeImpl(*this);
1175 }
1176
1177 /// Check if this is or contains a C union that is non-trivial to
1178 /// default-initialize, which is a union that has a member that is non-trivial
1179 /// to default-initialize. If this returns true,
1180 /// isNonTrivialToPrimitiveDefaultInitialize returns PDIK_Struct.
1181 bool hasNonTrivialToPrimitiveDefaultInitializeCUnion() const;
1182
1183 /// Check if this is or contains a C union that is non-trivial to destruct,
1184 /// which is a union that has a member that is non-trivial to destruct. If
1185 /// this returns true, isDestructedType returns DK_nontrivial_c_struct.
1186 bool hasNonTrivialToPrimitiveDestructCUnion() const;
1187
1188 /// Check if this is or contains a C union that is non-trivial to copy, which
1189 /// is a union that has a member that is non-trivial to copy. If this returns
1190 /// true, isNonTrivialToPrimitiveCopy returns PCK_Struct.
1191 bool hasNonTrivialToPrimitiveCopyCUnion() const;
1192
1193 /// Determine whether expressions of the given type are forbidden
1194 /// from being lvalues in C.
1195 ///
1196 /// The expression types that are forbidden to be lvalues are:
1197 /// - 'void', but not qualified void
1198 /// - function types
1199 ///
1200 /// The exact rule here is C99 6.3.2.1:
1201 /// An lvalue is an expression with an object type or an incomplete
1202 /// type other than void.
1203 bool isCForbiddenLValueType() const;
1204
1205 /// Substitute type arguments for the Objective-C type parameters used in the
1206 /// subject type.
1207 ///
1208 /// \param ctx ASTContext in which the type exists.
1209 ///
1210 /// \param typeArgs The type arguments that will be substituted for the
1211 /// Objective-C type parameters in the subject type, which are generally
1212 /// computed via \c Type::getObjCSubstitutions. If empty, the type
1213 /// parameters will be replaced with their bounds or id/Class, as appropriate
1214 /// for the context.
1215 ///
1216 /// \param context The context in which the subject type was written.
1217 ///
1218 /// \returns the resulting type.
1219 QualType substObjCTypeArgs(ASTContext &ctx,
1220 ArrayRef<QualType> typeArgs,
1221 ObjCSubstitutionContext context) const;
1222
1223 /// Substitute type arguments from an object type for the Objective-C type
1224 /// parameters used in the subject type.
1225 ///
1226 /// This operation combines the computation of type arguments for
1227 /// substitution (\c Type::getObjCSubstitutions) with the actual process of
1228 /// substitution (\c QualType::substObjCTypeArgs) for the convenience of
1229 /// callers that need to perform a single substitution in isolation.
1230 ///
1231 /// \param objectType The type of the object whose member type we're
1232 /// substituting into. For example, this might be the receiver of a message
1233 /// or the base of a property access.
1234 ///
1235 /// \param dc The declaration context from which the subject type was
1236 /// retrieved, which indicates (for example) which type parameters should
1237 /// be substituted.
1238 ///
1239 /// \param context The context in which the subject type was written.
1240 ///
1241 /// \returns the subject type after replacing all of the Objective-C type
1242 /// parameters with their corresponding arguments.
1243 QualType substObjCMemberType(QualType objectType,
1244 const DeclContext *dc,
1245 ObjCSubstitutionContext context) const;
1246
1247 /// Strip Objective-C "__kindof" types from the given type.
1248 QualType stripObjCKindOfType(const ASTContext &ctx) const;
1249
1250 /// Remove all qualifiers including _Atomic.
1251 QualType getAtomicUnqualifiedType() const;
1252
1253private:
1254 // These methods are implemented in a separate translation unit;
1255 // "static"-ize them to avoid creating temporary QualTypes in the
1256 // caller.
1257 static bool isConstant(QualType T, const ASTContext& Ctx);
1258 static QualType getDesugaredType(QualType T, const ASTContext &Context);
1259 static SplitQualType getSplitDesugaredType(QualType T);
1260 static SplitQualType getSplitUnqualifiedTypeImpl(QualType type);
1261 static QualType getSingleStepDesugaredTypeImpl(QualType type,
1262 const ASTContext &C);
1263 static QualType IgnoreParens(QualType T);
1264 static DestructionKind isDestructedTypeImpl(QualType type);
1265
1266 /// Check if \param RD is or contains a non-trivial C union.
1267 static bool hasNonTrivialToPrimitiveDefaultInitializeCUnion(const RecordDecl *RD);
1268 static bool hasNonTrivialToPrimitiveDestructCUnion(const RecordDecl *RD);
1269 static bool hasNonTrivialToPrimitiveCopyCUnion(const RecordDecl *RD);
1270};
1271
1272} // namespace clang
1273
1274namespace llvm {
1275
1276/// Implement simplify_type for QualType, so that we can dyn_cast from QualType
1277/// to a specific Type class.
1278template<> struct simplify_type< ::clang::QualType> {
1279 using SimpleType = const ::clang::Type *;
1280
1281 static SimpleType getSimplifiedValue(::clang::QualType Val) {
1282 return Val.getTypePtr();
1283 }
1284};
1285
1286// Teach SmallPtrSet that QualType is "basically a pointer".
1287template<>
1288struct PointerLikeTypeTraits<clang::QualType> {
1289 static inline void *getAsVoidPointer(clang::QualType P) {
1290 return P.getAsOpaquePtr();
1291 }
1292
1293 static inline clang::QualType getFromVoidPointer(void *P) {
1294 return clang::QualType::getFromOpaquePtr(P);
1295 }
1296
1297 // Various qualifiers go in low bits.
1298 enum { NumLowBitsAvailable = 0 };
1299};
1300
1301} // namespace llvm
1302
1303namespace clang {
1304
1305/// Base class that is common to both the \c ExtQuals and \c Type
1306/// classes, which allows \c QualType to access the common fields between the
1307/// two.
1308class ExtQualsTypeCommonBase {
1309 friend class ExtQuals;
1310 friend class QualType;
1311 friend class Type;
1312
1313 /// The "base" type of an extended qualifiers type (\c ExtQuals) or
1314 /// a self-referential pointer (for \c Type).
1315 ///
1316 /// This pointer allows an efficient mapping from a QualType to its
1317 /// underlying type pointer.
1318 const Type *const BaseType;
1319
1320 /// The canonical type of this type. A QualType.
1321 QualType CanonicalType;
1322
1323 ExtQualsTypeCommonBase(const Type *baseType, QualType canon)
1324 : BaseType(baseType), CanonicalType(canon) {}
1325};
1326
1327/// We can encode up to four bits in the low bits of a
1328/// type pointer, but there are many more type qualifiers that we want
1329/// to be able to apply to an arbitrary type. Therefore we have this
1330/// struct, intended to be heap-allocated and used by QualType to
1331/// store qualifiers.
1332///
1333/// The current design tags the 'const', 'restrict', and 'volatile' qualifiers
1334/// in three low bits on the QualType pointer; a fourth bit records whether
1335/// the pointer is an ExtQuals node. The extended qualifiers (address spaces,
1336/// Objective-C GC attributes) are much more rare.
1337class ExtQuals : public ExtQualsTypeCommonBase, public llvm::FoldingSetNode {
1338 // NOTE: changing the fast qualifiers should be straightforward as
1339 // long as you don't make 'const' non-fast.
1340 // 1. Qualifiers:
1341 // a) Modify the bitmasks (Qualifiers::TQ and DeclSpec::TQ).
1342 // Fast qualifiers must occupy the low-order bits.
1343 // b) Update Qualifiers::FastWidth and FastMask.
1344 // 2. QualType:
1345 // a) Update is{Volatile,Restrict}Qualified(), defined inline.
1346 // b) Update remove{Volatile,Restrict}, defined near the end of
1347 // this header.
1348 // 3. ASTContext:
1349 // a) Update get{Volatile,Restrict}Type.
1350
1351 /// The immutable set of qualifiers applied by this node. Always contains
1352 /// extended qualifiers.
1353 Qualifiers Quals;
1354
1355 ExtQuals *this_() { return this; }
1356
1357public:
1358 ExtQuals(const Type *baseType, QualType canon, Qualifiers quals)
1359 : ExtQualsTypeCommonBase(baseType,
1360 canon.isNull() ? QualType(this_(), 0) : canon),
1361 Quals(quals) {
1362 assert(Quals.hasNonFastQualifiers()((Quals.hasNonFastQualifiers() && "ExtQuals created with no fast qualifiers"
) ? static_cast<void> (0) : __assert_fail ("Quals.hasNonFastQualifiers() && \"ExtQuals created with no fast qualifiers\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 1363, __PRETTY_FUNCTION__))
1363 && "ExtQuals created with no fast qualifiers")((Quals.hasNonFastQualifiers() && "ExtQuals created with no fast qualifiers"
) ? static_cast<void> (0) : __assert_fail ("Quals.hasNonFastQualifiers() && \"ExtQuals created with no fast qualifiers\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 1363, __PRETTY_FUNCTION__))
;
1364 assert(!Quals.hasFastQualifiers()((!Quals.hasFastQualifiers() && "ExtQuals created with fast qualifiers"
) ? static_cast<void> (0) : __assert_fail ("!Quals.hasFastQualifiers() && \"ExtQuals created with fast qualifiers\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 1365, __PRETTY_FUNCTION__))
1365 && "ExtQuals created with fast qualifiers")((!Quals.hasFastQualifiers() && "ExtQuals created with fast qualifiers"
) ? static_cast<void> (0) : __assert_fail ("!Quals.hasFastQualifiers() && \"ExtQuals created with fast qualifiers\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 1365, __PRETTY_FUNCTION__))
;
1366 }
1367
1368 Qualifiers getQualifiers() const { return Quals; }
1369
1370 bool hasObjCGCAttr() const { return Quals.hasObjCGCAttr(); }
1371 Qualifiers::GC getObjCGCAttr() const { return Quals.getObjCGCAttr(); }
1372
1373 bool hasObjCLifetime() const { return Quals.hasObjCLifetime(); }
1374 Qualifiers::ObjCLifetime getObjCLifetime() const {
1375 return Quals.getObjCLifetime();
1376 }
1377
1378 bool hasAddressSpace() const { return Quals.hasAddressSpace(); }
1379 LangAS getAddressSpace() const { return Quals.getAddressSpace(); }
1380
1381 const Type *getBaseType() const { return BaseType; }
1382
1383public:
1384 void Profile(llvm::FoldingSetNodeID &ID) const {
1385 Profile(ID, getBaseType(), Quals);
1386 }
1387
1388 static void Profile(llvm::FoldingSetNodeID &ID,
1389 const Type *BaseType,
1390 Qualifiers Quals) {
1391 assert(!Quals.hasFastQualifiers() && "fast qualifiers in ExtQuals hash!")((!Quals.hasFastQualifiers() && "fast qualifiers in ExtQuals hash!"
) ? static_cast<void> (0) : __assert_fail ("!Quals.hasFastQualifiers() && \"fast qualifiers in ExtQuals hash!\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 1391, __PRETTY_FUNCTION__))
;
1392 ID.AddPointer(BaseType);
1393 Quals.Profile(ID);
1394 }
1395};
1396
1397/// The kind of C++11 ref-qualifier associated with a function type.
1398/// This determines whether a member function's "this" object can be an
1399/// lvalue, rvalue, or neither.
1400enum RefQualifierKind {
1401 /// No ref-qualifier was provided.
1402 RQ_None = 0,
1403
1404 /// An lvalue ref-qualifier was provided (\c &).
1405 RQ_LValue,
1406
1407 /// An rvalue ref-qualifier was provided (\c &&).
1408 RQ_RValue
1409};
1410
1411/// Which keyword(s) were used to create an AutoType.
1412enum class AutoTypeKeyword {
1413 /// auto
1414 Auto,
1415
1416 /// decltype(auto)
1417 DecltypeAuto,
1418
1419 /// __auto_type (GNU extension)
1420 GNUAutoType
1421};
1422
1423/// The base class of the type hierarchy.
1424///
1425/// A central concept with types is that each type always has a canonical
1426/// type. A canonical type is the type with any typedef names stripped out
1427/// of it or the types it references. For example, consider:
1428///
1429/// typedef int foo;
1430/// typedef foo* bar;
1431/// 'int *' 'foo *' 'bar'
1432///
1433/// There will be a Type object created for 'int'. Since int is canonical, its
1434/// CanonicalType pointer points to itself. There is also a Type for 'foo' (a
1435/// TypedefType). Its CanonicalType pointer points to the 'int' Type. Next
1436/// there is a PointerType that represents 'int*', which, like 'int', is
1437/// canonical. Finally, there is a PointerType type for 'foo*' whose canonical
1438/// type is 'int*', and there is a TypedefType for 'bar', whose canonical type
1439/// is also 'int*'.
1440///
1441/// Non-canonical types are useful for emitting diagnostics, without losing
1442/// information about typedefs being used. Canonical types are useful for type
1443/// comparisons (they allow by-pointer equality tests) and useful for reasoning
1444/// about whether something has a particular form (e.g. is a function type),
1445/// because they implicitly, recursively, strip all typedefs out of a type.
1446///
1447/// Types, once created, are immutable.
1448///
1449class alignas(8) Type : public ExtQualsTypeCommonBase {
1450public:
1451 enum TypeClass {
1452#define TYPE(Class, Base) Class,
1453#define LAST_TYPE(Class) TypeLast = Class
1454#define ABSTRACT_TYPE(Class, Base)
1455#include "clang/AST/TypeNodes.inc"
1456 };
1457
1458private:
1459 /// Bitfields required by the Type class.
1460 class TypeBitfields {
1461 friend class Type;
1462 template <class T> friend class TypePropertyCache;
1463
1464 /// TypeClass bitfield - Enum that specifies what subclass this belongs to.
1465 unsigned TC : 8;
1466
1467 /// Whether this type is a dependent type (C++ [temp.dep.type]).
1468 unsigned Dependent : 1;
1469
1470 /// Whether this type somehow involves a template parameter, even
1471 /// if the resolution of the type does not depend on a template parameter.
1472 unsigned InstantiationDependent : 1;
1473
1474 /// Whether this type is a variably-modified type (C99 6.7.5).
1475 unsigned VariablyModified : 1;
1476
1477 /// Whether this type contains an unexpanded parameter pack
1478 /// (for C++11 variadic templates).
1479 unsigned ContainsUnexpandedParameterPack : 1;
1480
1481 /// True if the cache (i.e. the bitfields here starting with
1482 /// 'Cache') is valid.
1483 mutable unsigned CacheValid : 1;
1484
1485 /// Linkage of this type.
1486 mutable unsigned CachedLinkage : 3;
1487
1488 /// Whether this type involves and local or unnamed types.
1489 mutable unsigned CachedLocalOrUnnamed : 1;
1490
1491 /// Whether this type comes from an AST file.
1492 mutable unsigned FromAST : 1;
1493
1494 bool isCacheValid() const {
1495 return CacheValid;
1496 }
1497
1498 Linkage getLinkage() const {
1499 assert(isCacheValid() && "getting linkage from invalid cache")((isCacheValid() && "getting linkage from invalid cache"
) ? static_cast<void> (0) : __assert_fail ("isCacheValid() && \"getting linkage from invalid cache\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 1499, __PRETTY_FUNCTION__))
;
1500 return static_cast<Linkage>(CachedLinkage);
1501 }
1502
1503 bool hasLocalOrUnnamedType() const {
1504 assert(isCacheValid() && "getting linkage from invalid cache")((isCacheValid() && "getting linkage from invalid cache"
) ? static_cast<void> (0) : __assert_fail ("isCacheValid() && \"getting linkage from invalid cache\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 1504, __PRETTY_FUNCTION__))
;
1505 return CachedLocalOrUnnamed;
1506 }
1507 };
1508 enum { NumTypeBits = 18 };
1509
1510protected:
1511 // These classes allow subclasses to somewhat cleanly pack bitfields
1512 // into Type.
1513
1514 class ArrayTypeBitfields {
1515 friend class ArrayType;
1516
1517 unsigned : NumTypeBits;
1518
1519 /// CVR qualifiers from declarations like
1520 /// 'int X[static restrict 4]'. For function parameters only.
1521 unsigned IndexTypeQuals : 3;
1522
1523 /// Storage class qualifiers from declarations like
1524 /// 'int X[static restrict 4]'. For function parameters only.
1525 /// Actually an ArrayType::ArraySizeModifier.
1526 unsigned SizeModifier : 3;
1527 };
1528
1529 class ConstantArrayTypeBitfields {
1530 friend class ConstantArrayType;
1531
1532 unsigned : NumTypeBits + 3 + 3;
1533
1534 /// Whether we have a stored size expression.
1535 unsigned HasStoredSizeExpr : 1;
1536 };
1537
1538 class BuiltinTypeBitfields {
1539 friend class BuiltinType;
1540
1541 unsigned : NumTypeBits;
1542
1543 /// The kind (BuiltinType::Kind) of builtin type this is.
1544 unsigned Kind : 8;
1545 };
1546
1547 /// FunctionTypeBitfields store various bits belonging to FunctionProtoType.
1548 /// Only common bits are stored here. Additional uncommon bits are stored
1549 /// in a trailing object after FunctionProtoType.
1550 class FunctionTypeBitfields {
1551 friend class FunctionProtoType;
1552 friend class FunctionType;
1553
1554 unsigned : NumTypeBits;
1555
1556 /// Extra information which affects how the function is called, like
1557 /// regparm and the calling convention.
1558 unsigned ExtInfo : 12;
1559
1560 /// The ref-qualifier associated with a \c FunctionProtoType.
1561 ///
1562 /// This is a value of type \c RefQualifierKind.
1563 unsigned RefQualifier : 2;
1564
1565 /// Used only by FunctionProtoType, put here to pack with the
1566 /// other bitfields.
1567 /// The qualifiers are part of FunctionProtoType because...
1568 ///
1569 /// C++ 8.3.5p4: The return type, the parameter type list and the
1570 /// cv-qualifier-seq, [...], are part of the function type.
1571 unsigned FastTypeQuals : Qualifiers::FastWidth;
1572 /// Whether this function has extended Qualifiers.
1573 unsigned HasExtQuals : 1;
1574
1575 /// The number of parameters this function has, not counting '...'.
1576 /// According to [implimits] 8 bits should be enough here but this is
1577 /// somewhat easy to exceed with metaprogramming and so we would like to
1578 /// keep NumParams as wide as reasonably possible.
1579 unsigned NumParams : 16;
1580
1581 /// The type of exception specification this function has.
1582 unsigned ExceptionSpecType : 4;
1583
1584 /// Whether this function has extended parameter information.
1585 unsigned HasExtParameterInfos : 1;
1586
1587 /// Whether the function is variadic.
1588 unsigned Variadic : 1;
1589
1590 /// Whether this function has a trailing return type.
1591 unsigned HasTrailingReturn : 1;
1592 };
1593
1594 class ObjCObjectTypeBitfields {
1595 friend class ObjCObjectType;
1596
1597 unsigned : NumTypeBits;
1598
1599 /// The number of type arguments stored directly on this object type.
1600 unsigned NumTypeArgs : 7;
1601
1602 /// The number of protocols stored directly on this object type.
1603 unsigned NumProtocols : 6;
1604
1605 /// Whether this is a "kindof" type.
1606 unsigned IsKindOf : 1;
1607 };
1608
1609 class ReferenceTypeBitfields {
1610 friend class ReferenceType;
1611
1612 unsigned : NumTypeBits;
1613
1614 /// True if the type was originally spelled with an lvalue sigil.
1615 /// This is never true of rvalue references but can also be false
1616 /// on lvalue references because of C++0x [dcl.typedef]p9,
1617 /// as follows:
1618 ///
1619 /// typedef int &ref; // lvalue, spelled lvalue
1620 /// typedef int &&rvref; // rvalue
1621 /// ref &a; // lvalue, inner ref, spelled lvalue
1622 /// ref &&a; // lvalue, inner ref
1623 /// rvref &a; // lvalue, inner ref, spelled lvalue
1624 /// rvref &&a; // rvalue, inner ref
1625 unsigned SpelledAsLValue : 1;
1626
1627 /// True if the inner type is a reference type. This only happens
1628 /// in non-canonical forms.
1629 unsigned InnerRef : 1;
1630 };
1631
1632 class TypeWithKeywordBitfields {
1633 friend class TypeWithKeyword;
1634
1635 unsigned : NumTypeBits;
1636
1637 /// An ElaboratedTypeKeyword. 8 bits for efficient access.
1638 unsigned Keyword : 8;
1639 };
1640
1641 enum { NumTypeWithKeywordBits = 8 };
1642
1643 class ElaboratedTypeBitfields {
1644 friend class ElaboratedType;
1645
1646 unsigned : NumTypeBits;
1647 unsigned : NumTypeWithKeywordBits;
1648
1649 /// Whether the ElaboratedType has a trailing OwnedTagDecl.
1650 unsigned HasOwnedTagDecl : 1;
1651 };
1652
1653 class VectorTypeBitfields {
1654 friend class VectorType;
1655 friend class DependentVectorType;
1656
1657 unsigned : NumTypeBits;
1658
1659 /// The kind of vector, either a generic vector type or some
1660 /// target-specific vector type such as for AltiVec or Neon.
1661 unsigned VecKind : 3;
1662
1663 /// The number of elements in the vector.
1664 unsigned NumElements : 29 - NumTypeBits;
1665
1666 enum { MaxNumElements = (1 << (29 - NumTypeBits)) - 1 };
1667 };
1668
1669 class AttributedTypeBitfields {
1670 friend class AttributedType;
1671
1672 unsigned : NumTypeBits;
1673
1674 /// An AttributedType::Kind
1675 unsigned AttrKind : 32 - NumTypeBits;
1676 };
1677
1678 class AutoTypeBitfields {
1679 friend class AutoType;
1680
1681 unsigned : NumTypeBits;
1682
1683 /// Was this placeholder type spelled as 'auto', 'decltype(auto)',
1684 /// or '__auto_type'? AutoTypeKeyword value.
1685 unsigned Keyword : 2;
1686 };
1687
1688 class SubstTemplateTypeParmPackTypeBitfields {
1689 friend class SubstTemplateTypeParmPackType;
1690
1691 unsigned : NumTypeBits;
1692
1693 /// The number of template arguments in \c Arguments, which is
1694 /// expected to be able to hold at least 1024 according to [implimits].
1695 /// However as this limit is somewhat easy to hit with template
1696 /// metaprogramming we'd prefer to keep it as large as possible.
1697 /// At the moment it has been left as a non-bitfield since this type
1698 /// safely fits in 64 bits as an unsigned, so there is no reason to
1699 /// introduce the performance impact of a bitfield.
1700 unsigned NumArgs;
1701 };
1702
1703 class TemplateSpecializationTypeBitfields {
1704 friend class TemplateSpecializationType;
1705
1706 unsigned : NumTypeBits;
1707
1708 /// Whether this template specialization type is a substituted type alias.
1709 unsigned TypeAlias : 1;
1710
1711 /// The number of template arguments named in this class template
1712 /// specialization, which is expected to be able to hold at least 1024
1713 /// according to [implimits]. However, as this limit is somewhat easy to
1714 /// hit with template metaprogramming we'd prefer to keep it as large
1715 /// as possible. At the moment it has been left as a non-bitfield since
1716 /// this type safely fits in 64 bits as an unsigned, so there is no reason
1717 /// to introduce the performance impact of a bitfield.
1718 unsigned NumArgs;
1719 };
1720
1721 class DependentTemplateSpecializationTypeBitfields {
1722 friend class DependentTemplateSpecializationType;
1723
1724 unsigned : NumTypeBits;
1725 unsigned : NumTypeWithKeywordBits;
1726
1727 /// The number of template arguments named in this class template
1728 /// specialization, which is expected to be able to hold at least 1024
1729 /// according to [implimits]. However, as this limit is somewhat easy to
1730 /// hit with template metaprogramming we'd prefer to keep it as large
1731 /// as possible. At the moment it has been left as a non-bitfield since
1732 /// this type safely fits in 64 bits as an unsigned, so there is no reason
1733 /// to introduce the performance impact of a bitfield.
1734 unsigned NumArgs;
1735 };
1736
1737 class PackExpansionTypeBitfields {
1738 friend class PackExpansionType;
1739
1740 unsigned : NumTypeBits;
1741
1742 /// The number of expansions that this pack expansion will
1743 /// generate when substituted (+1), which is expected to be able to
1744 /// hold at least 1024 according to [implimits]. However, as this limit
1745 /// is somewhat easy to hit with template metaprogramming we'd prefer to
1746 /// keep it as large as possible. At the moment it has been left as a
1747 /// non-bitfield since this type safely fits in 64 bits as an unsigned, so
1748 /// there is no reason to introduce the performance impact of a bitfield.
1749 ///
1750 /// This field will only have a non-zero value when some of the parameter
1751 /// packs that occur within the pattern have been substituted but others
1752 /// have not.
1753 unsigned NumExpansions;
1754 };
1755
1756 union {
1757 TypeBitfields TypeBits;
1758 ArrayTypeBitfields ArrayTypeBits;
1759 ConstantArrayTypeBitfields ConstantArrayTypeBits;
1760 AttributedTypeBitfields AttributedTypeBits;
1761 AutoTypeBitfields AutoTypeBits;
1762 BuiltinTypeBitfields BuiltinTypeBits;
1763 FunctionTypeBitfields FunctionTypeBits;
1764 ObjCObjectTypeBitfields ObjCObjectTypeBits;
1765 ReferenceTypeBitfields ReferenceTypeBits;
1766 TypeWithKeywordBitfields TypeWithKeywordBits;
1767 ElaboratedTypeBitfields ElaboratedTypeBits;
1768 VectorTypeBitfields VectorTypeBits;
1769 SubstTemplateTypeParmPackTypeBitfields SubstTemplateTypeParmPackTypeBits;
1770 TemplateSpecializationTypeBitfields TemplateSpecializationTypeBits;
1771 DependentTemplateSpecializationTypeBitfields
1772 DependentTemplateSpecializationTypeBits;
1773 PackExpansionTypeBitfields PackExpansionTypeBits;
1774
1775 static_assert(sizeof(TypeBitfields) <= 8,
1776 "TypeBitfields is larger than 8 bytes!");
1777 static_assert(sizeof(ArrayTypeBitfields) <= 8,
1778 "ArrayTypeBitfields is larger than 8 bytes!");
1779 static_assert(sizeof(AttributedTypeBitfields) <= 8,
1780 "AttributedTypeBitfields is larger than 8 bytes!");
1781 static_assert(sizeof(AutoTypeBitfields) <= 8,
1782 "AutoTypeBitfields is larger than 8 bytes!");
1783 static_assert(sizeof(BuiltinTypeBitfields) <= 8,
1784 "BuiltinTypeBitfields is larger than 8 bytes!");
1785 static_assert(sizeof(FunctionTypeBitfields) <= 8,
1786 "FunctionTypeBitfields is larger than 8 bytes!");
1787 static_assert(sizeof(ObjCObjectTypeBitfields) <= 8,
1788 "ObjCObjectTypeBitfields is larger than 8 bytes!");
1789 static_assert(sizeof(ReferenceTypeBitfields) <= 8,
1790 "ReferenceTypeBitfields is larger than 8 bytes!");
1791 static_assert(sizeof(TypeWithKeywordBitfields) <= 8,
1792 "TypeWithKeywordBitfields is larger than 8 bytes!");
1793 static_assert(sizeof(ElaboratedTypeBitfields) <= 8,
1794 "ElaboratedTypeBitfields is larger than 8 bytes!");
1795 static_assert(sizeof(VectorTypeBitfields) <= 8,
1796 "VectorTypeBitfields is larger than 8 bytes!");
1797 static_assert(sizeof(SubstTemplateTypeParmPackTypeBitfields) <= 8,
1798 "SubstTemplateTypeParmPackTypeBitfields is larger"
1799 " than 8 bytes!");
1800 static_assert(sizeof(TemplateSpecializationTypeBitfields) <= 8,
1801 "TemplateSpecializationTypeBitfields is larger"
1802 " than 8 bytes!");
1803 static_assert(sizeof(DependentTemplateSpecializationTypeBitfields) <= 8,
1804 "DependentTemplateSpecializationTypeBitfields is larger"
1805 " than 8 bytes!");
1806 static_assert(sizeof(PackExpansionTypeBitfields) <= 8,
1807 "PackExpansionTypeBitfields is larger than 8 bytes");
1808 };
1809
1810private:
1811 template <class T> friend class TypePropertyCache;
1812
1813 /// Set whether this type comes from an AST file.
1814 void setFromAST(bool V = true) const {
1815 TypeBits.FromAST = V;
1816 }
1817
1818protected:
1819 friend class ASTContext;
1820
1821 Type(TypeClass tc, QualType canon, bool Dependent,
1822 bool InstantiationDependent, bool VariablyModified,
1823 bool ContainsUnexpandedParameterPack)
1824 : ExtQualsTypeCommonBase(this,
1825 canon.isNull() ? QualType(this_(), 0) : canon) {
1826 TypeBits.TC = tc;
1827 TypeBits.Dependent = Dependent;
1828 TypeBits.InstantiationDependent = Dependent || InstantiationDependent;
1829 TypeBits.VariablyModified = VariablyModified;
1830 TypeBits.ContainsUnexpandedParameterPack = ContainsUnexpandedParameterPack;
1831 TypeBits.CacheValid = false;
1832 TypeBits.CachedLocalOrUnnamed = false;
1833 TypeBits.CachedLinkage = NoLinkage;
1834 TypeBits.FromAST = false;
1835 }
1836
1837 // silence VC++ warning C4355: 'this' : used in base member initializer list
1838 Type *this_() { return this; }
1839
1840 void setDependent(bool D = true) {
1841 TypeBits.Dependent = D;
1842 if (D)
1843 TypeBits.InstantiationDependent = true;
1844 }
1845
1846 void setInstantiationDependent(bool D = true) {
1847 TypeBits.InstantiationDependent = D; }
1848
1849 void setVariablyModified(bool VM = true) { TypeBits.VariablyModified = VM; }
1850
1851 void setContainsUnexpandedParameterPack(bool PP = true) {
1852 TypeBits.ContainsUnexpandedParameterPack = PP;
1853 }
1854
1855public:
1856 friend class ASTReader;
1857 friend class ASTWriter;
1858 template <class T> friend class serialization::AbstractTypeReader;
1859 template <class T> friend class serialization::AbstractTypeWriter;
1860
1861 Type(const Type &) = delete;
1862 Type(Type &&) = delete;
1863 Type &operator=(const Type &) = delete;
1864 Type &operator=(Type &&) = delete;
1865
1866 TypeClass getTypeClass() const { return static_cast<TypeClass>(TypeBits.TC); }
1867
1868 /// Whether this type comes from an AST file.
1869 bool isFromAST() const { return TypeBits.FromAST; }
1870
1871 /// Whether this type is or contains an unexpanded parameter
1872 /// pack, used to support C++0x variadic templates.
1873 ///
1874 /// A type that contains a parameter pack shall be expanded by the
1875 /// ellipsis operator at some point. For example, the typedef in the
1876 /// following example contains an unexpanded parameter pack 'T':
1877 ///
1878 /// \code
1879 /// template<typename ...T>
1880 /// struct X {
1881 /// typedef T* pointer_types; // ill-formed; T is a parameter pack.
1882 /// };
1883 /// \endcode
1884 ///
1885 /// Note that this routine does not specify which
1886 bool containsUnexpandedParameterPack() const {
1887 return TypeBits.ContainsUnexpandedParameterPack;
1888 }
1889
1890 /// Determines if this type would be canonical if it had no further
1891 /// qualification.
1892 bool isCanonicalUnqualified() const {
1893 return CanonicalType == QualType(this, 0);
1894 }
1895
1896 /// Pull a single level of sugar off of this locally-unqualified type.
1897 /// Users should generally prefer SplitQualType::getSingleStepDesugaredType()
1898 /// or QualType::getSingleStepDesugaredType(const ASTContext&).
1899 QualType getLocallyUnqualifiedSingleStepDesugaredType() const;
1900
1901 /// Types are partitioned into 3 broad categories (C99 6.2.5p1):
1902 /// object types, function types, and incomplete types.
1903
1904 /// Return true if this is an incomplete type.
1905 /// A type that can describe objects, but which lacks information needed to
1906 /// determine its size (e.g. void, or a fwd declared struct). Clients of this
1907 /// routine will need to determine if the size is actually required.
1908 ///
1909 /// Def If non-null, and the type refers to some kind of declaration
1910 /// that can be completed (such as a C struct, C++ class, or Objective-C
1911 /// class), will be set to the declaration.
1912 bool isIncompleteType(NamedDecl **Def = nullptr) const;
1913
1914 /// Return true if this is an incomplete or object
1915 /// type, in other words, not a function type.
1916 bool isIncompleteOrObjectType() const {
1917 return !isFunctionType();
1918 }
1919
1920 /// Determine whether this type is an object type.
1921 bool isObjectType() const {
1922 // C++ [basic.types]p8:
1923 // An object type is a (possibly cv-qualified) type that is not a
1924 // function type, not a reference type, and not a void type.
1925 return !isReferenceType() && !isFunctionType() && !isVoidType();
1926 }
1927
1928 /// Return true if this is a literal type
1929 /// (C++11 [basic.types]p10)
1930 bool isLiteralType(const ASTContext &Ctx) const;
1931
1932 /// Test if this type is a standard-layout type.
1933 /// (C++0x [basic.type]p9)
1934 bool isStandardLayoutType() const;
1935
1936 /// Helper methods to distinguish type categories. All type predicates
1937 /// operate on the canonical type, ignoring typedefs and qualifiers.
1938
1939 /// Returns true if the type is a builtin type.
1940 bool isBuiltinType() const;
1941
1942 /// Test for a particular builtin type.
1943 bool isSpecificBuiltinType(unsigned K) const;
1944
1945 /// Test for a type which does not represent an actual type-system type but
1946 /// is instead used as a placeholder for various convenient purposes within
1947 /// Clang. All such types are BuiltinTypes.
1948 bool isPlaceholderType() const;
1949 const BuiltinType *getAsPlaceholderType() const;
1950
1951 /// Test for a specific placeholder type.
1952 bool isSpecificPlaceholderType(unsigned K) const;
1953
1954 /// Test for a placeholder type other than Overload; see
1955 /// BuiltinType::isNonOverloadPlaceholderType.
1956 bool isNonOverloadPlaceholderType() const;
1957
1958 /// isIntegerType() does *not* include complex integers (a GCC extension).
1959 /// isComplexIntegerType() can be used to test for complex integers.
1960 bool isIntegerType() const; // C99 6.2.5p17 (int, char, bool, enum)
1961 bool isEnumeralType() const;
1962
1963 /// Determine whether this type is a scoped enumeration type.
1964 bool isScopedEnumeralType() const;
1965 bool isBooleanType() const;
1966 bool isCharType() const;
1967 bool isWideCharType() const;
1968 bool isChar8Type() const;
1969 bool isChar16Type() const;
1970 bool isChar32Type() const;
1971 bool isAnyCharacterType() const;
1972 bool isIntegralType(const ASTContext &Ctx) const;
1973
1974 /// Determine whether this type is an integral or enumeration type.
1975 bool isIntegralOrEnumerationType() const;
1976
1977 /// Determine whether this type is an integral or unscoped enumeration type.
1978 bool isIntegralOrUnscopedEnumerationType() const;
1979 bool isUnscopedEnumerationType() const;
1980
1981 /// Floating point categories.
1982 bool isRealFloatingType() const; // C99 6.2.5p10 (float, double, long double)
1983 /// isComplexType() does *not* include complex integers (a GCC extension).
1984 /// isComplexIntegerType() can be used to test for complex integers.
1985 bool isComplexType() const; // C99 6.2.5p11 (complex)
1986 bool isAnyComplexType() const; // C99 6.2.5p11 (complex) + Complex Int.
1987 bool isFloatingType() const; // C99 6.2.5p11 (real floating + complex)
1988 bool isHalfType() const; // OpenCL 6.1.1.1, NEON (IEEE 754-2008 half)
1989 bool isFloat16Type() const; // C11 extension ISO/IEC TS 18661
1990 bool isFloat128Type() const;
1991 bool isRealType() const; // C99 6.2.5p17 (real floating + integer)
1992 bool isArithmeticType() const; // C99 6.2.5p18 (integer + floating)
1993 bool isVoidType() const; // C99 6.2.5p19
1994 bool isScalarType() const; // C99 6.2.5p21 (arithmetic + pointers)
1995 bool isAggregateType() const;
1996 bool isFundamentalType() const;
1997 bool isCompoundType() const;
1998
1999 // Type Predicates: Check to see if this type is structurally the specified
2000 // type, ignoring typedefs and qualifiers.
2001 bool isFunctionType() const;
2002 bool isFunctionNoProtoType() const { return getAs<FunctionNoProtoType>(); }
2003 bool isFunctionProtoType() const { return getAs<FunctionProtoType>(); }
2004 bool isPointerType() const;
2005 bool isAnyPointerType() const; // Any C pointer or ObjC object pointer
2006 bool isBlockPointerType() const;
2007 bool isVoidPointerType() const;
2008 bool isReferenceType() const;
2009 bool isLValueReferenceType() const;
2010 bool isRValueReferenceType() const;
2011 bool isObjectPointerType() const;
2012 bool isFunctionPointerType() const;
2013 bool isFunctionReferenceType() const;
2014 bool isMemberPointerType() const;
2015 bool isMemberFunctionPointerType() const;
2016 bool isMemberDataPointerType() const;
2017 bool isArrayType() const;
2018 bool isConstantArrayType() const;
2019 bool isIncompleteArrayType() const;
2020 bool isVariableArrayType() const;
2021 bool isDependentSizedArrayType() const;
2022 bool isRecordType() const;
2023 bool isClassType() const;
2024 bool isStructureType() const;
2025 bool isObjCBoxableRecordType() const;
2026 bool isInterfaceType() const;
2027 bool isStructureOrClassType() const;
2028 bool isUnionType() const;
2029 bool isComplexIntegerType() const; // GCC _Complex integer type.
2030 bool isVectorType() const; // GCC vector type.
2031 bool isExtVectorType() const; // Extended vector type.
2032 bool isDependentAddressSpaceType() const; // value-dependent address space qualifier
2033 bool isObjCObjectPointerType() const; // pointer to ObjC object
2034 bool isObjCRetainableType() const; // ObjC object or block pointer
2035 bool isObjCLifetimeType() const; // (array of)* retainable type
2036 bool isObjCIndirectLifetimeType() const; // (pointer to)* lifetime type
2037 bool isObjCNSObjectType() const; // __attribute__((NSObject))
2038 bool isObjCIndependentClassType() const; // __attribute__((objc_independent_class))
2039 // FIXME: change this to 'raw' interface type, so we can used 'interface' type
2040 // for the common case.
2041 bool isObjCObjectType() const; // NSString or typeof(*(id)0)
2042 bool isObjCQualifiedInterfaceType() const; // NSString<foo>
2043 bool isObjCQualifiedIdType() const; // id<foo>
2044 bool isObjCQualifiedClassType() const; // Class<foo>
2045 bool isObjCObjectOrInterfaceType() const;
2046 bool isObjCIdType() const; // id
2047 bool isDecltypeType() const;
2048 /// Was this type written with the special inert-in-ARC __unsafe_unretained
2049 /// qualifier?
2050 ///
2051 /// This approximates the answer to the following question: if this
2052 /// translation unit were compiled in ARC, would this type be qualified
2053 /// with __unsafe_unretained?
2054 bool isObjCInertUnsafeUnretainedType() const {
2055 return hasAttr(attr::ObjCInertUnsafeUnretained);
2056 }
2057
2058 /// Whether the type is Objective-C 'id' or a __kindof type of an
2059 /// object type, e.g., __kindof NSView * or __kindof id
2060 /// <NSCopying>.
2061 ///
2062 /// \param bound Will be set to the bound on non-id subtype types,
2063 /// which will be (possibly specialized) Objective-C class type, or
2064 /// null for 'id.
2065 bool isObjCIdOrObjectKindOfType(const ASTContext &ctx,
2066 const ObjCObjectType *&bound) const;
2067
2068 bool isObjCClassType() const; // Class
2069
2070 /// Whether the type is Objective-C 'Class' or a __kindof type of an
2071 /// Class type, e.g., __kindof Class <NSCopying>.
2072 ///
2073 /// Unlike \c isObjCIdOrObjectKindOfType, there is no relevant bound
2074 /// here because Objective-C's type system cannot express "a class
2075 /// object for a subclass of NSFoo".
2076 bool isObjCClassOrClassKindOfType() const;
2077
2078 bool isBlockCompatibleObjCPointerType(ASTContext &ctx) const;
2079 bool isObjCSelType() const; // Class
2080 bool isObjCBuiltinType() const; // 'id' or 'Class'
2081 bool isObjCARCBridgableType() const;
2082 bool isCARCBridgableType() const;
2083 bool isTemplateTypeParmType() const; // C++ template type parameter
2084 bool isNullPtrType() const; // C++11 std::nullptr_t
2085 bool isNothrowT() const; // C++ std::nothrow_t
2086 bool isAlignValT() const; // C++17 std::align_val_t
2087 bool isStdByteType() const; // C++17 std::byte
2088 bool isAtomicType() const; // C11 _Atomic()
2089 bool isUndeducedAutoType() const; // C++11 auto or
2090 // C++14 decltype(auto)
2091
2092#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2093 bool is##Id##Type() const;
2094#include "clang/Basic/OpenCLImageTypes.def"
2095
2096 bool isImageType() const; // Any OpenCL image type
2097
2098 bool isSamplerT() const; // OpenCL sampler_t
2099 bool isEventT() const; // OpenCL event_t
2100 bool isClkEventT() const; // OpenCL clk_event_t
2101 bool isQueueT() const; // OpenCL queue_t
2102 bool isReserveIDT() const; // OpenCL reserve_id_t
2103
2104#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
2105 bool is##Id##Type() const;
2106#include "clang/Basic/OpenCLExtensionTypes.def"
2107 // Type defined in cl_intel_device_side_avc_motion_estimation OpenCL extension
2108 bool isOCLIntelSubgroupAVCType() const;
2109 bool isOCLExtOpaqueType() const; // Any OpenCL extension type
2110
2111 bool isPipeType() const; // OpenCL pipe type
2112 bool isOpenCLSpecificType() const; // Any OpenCL specific type
2113
2114 /// Determines if this type, which must satisfy
2115 /// isObjCLifetimeType(), is implicitly __unsafe_unretained rather
2116 /// than implicitly __strong.
2117 bool isObjCARCImplicitlyUnretainedType() const;
2118
2119 /// Return the implicit lifetime for this type, which must not be dependent.
2120 Qualifiers::ObjCLifetime getObjCARCImplicitLifetime() const;
2121
2122 enum ScalarTypeKind {
2123 STK_CPointer,
2124 STK_BlockPointer,
2125 STK_ObjCObjectPointer,
2126 STK_MemberPointer,
2127 STK_Bool,
2128 STK_Integral,
2129 STK_Floating,
2130 STK_IntegralComplex,
2131 STK_FloatingComplex,
2132 STK_FixedPoint
2133 };
2134
2135 /// Given that this is a scalar type, classify it.
2136 ScalarTypeKind getScalarTypeKind() const;
2137
2138 /// Whether this type is a dependent type, meaning that its definition
2139 /// somehow depends on a template parameter (C++ [temp.dep.type]).
2140 bool isDependentType() const { return TypeBits.Dependent; }
2141
2142 /// Determine whether this type is an instantiation-dependent type,
2143 /// meaning that the type involves a template parameter (even if the
2144 /// definition does not actually depend on the type substituted for that
2145 /// template parameter).
2146 bool isInstantiationDependentType() const {
2147 return TypeBits.InstantiationDependent;
2148 }
2149
2150 /// Determine whether this type is an undeduced type, meaning that
2151 /// it somehow involves a C++11 'auto' type or similar which has not yet been
2152 /// deduced.
2153 bool isUndeducedType() const;
2154
2155 /// Whether this type is a variably-modified type (C99 6.7.5).
2156 bool isVariablyModifiedType() const { return TypeBits.VariablyModified; }
2157
2158 /// Whether this type involves a variable-length array type
2159 /// with a definite size.
2160 bool hasSizedVLAType() const;
2161
2162 /// Whether this type is or contains a local or unnamed type.
2163 bool hasUnnamedOrLocalType() const;
2164
2165 bool isOverloadableType() const;
2166
2167 /// Determine wither this type is a C++ elaborated-type-specifier.
2168 bool isElaboratedTypeSpecifier() const;
2169
2170 bool canDecayToPointerType() const;
2171
2172 /// Whether this type is represented natively as a pointer. This includes
2173 /// pointers, references, block pointers, and Objective-C interface,
2174 /// qualified id, and qualified interface types, as well as nullptr_t.
2175 bool hasPointerRepresentation() const;
2176
2177 /// Whether this type can represent an objective pointer type for the
2178 /// purpose of GC'ability
2179 bool hasObjCPointerRepresentation() const;
2180
2181 /// Determine whether this type has an integer representation
2182 /// of some sort, e.g., it is an integer type or a vector.
2183 bool hasIntegerRepresentation() const;
2184
2185 /// Determine whether this type has an signed integer representation
2186 /// of some sort, e.g., it is an signed integer type or a vector.
2187 bool hasSignedIntegerRepresentation() const;
2188
2189 /// Determine whether this type has an unsigned integer representation
2190 /// of some sort, e.g., it is an unsigned integer type or a vector.
2191 bool hasUnsignedIntegerRepresentation() const;
2192
2193 /// Determine whether this type has a floating-point representation
2194 /// of some sort, e.g., it is a floating-point type or a vector thereof.
2195 bool hasFloatingRepresentation() const;
2196
2197 // Type Checking Functions: Check to see if this type is structurally the
2198 // specified type, ignoring typedefs and qualifiers, and return a pointer to
2199 // the best type we can.
2200 const RecordType *getAsStructureType() const;
2201 /// NOTE: getAs*ArrayType are methods on ASTContext.
2202 const RecordType *getAsUnionType() const;
2203 const ComplexType *getAsComplexIntegerType() const; // GCC complex int type.
2204 const ObjCObjectType *getAsObjCInterfaceType() const;
2205
2206 // The following is a convenience method that returns an ObjCObjectPointerType
2207 // for object declared using an interface.
2208 const ObjCObjectPointerType *getAsObjCInterfacePointerType() const;
2209 const ObjCObjectPointerType *getAsObjCQualifiedIdType() const;
2210 const ObjCObjectPointerType *getAsObjCQualifiedClassType() const;
2211 const ObjCObjectType *getAsObjCQualifiedInterfaceType() const;
2212
2213 /// Retrieves the CXXRecordDecl that this type refers to, either
2214 /// because the type is a RecordType or because it is the injected-class-name
2215 /// type of a class template or class template partial specialization.
2216 CXXRecordDecl *getAsCXXRecordDecl() const;
2217
2218 /// Retrieves the RecordDecl this type refers to.
2219 RecordDecl *getAsRecordDecl() const;
2220
2221 /// Retrieves the TagDecl that this type refers to, either
2222 /// because the type is a TagType or because it is the injected-class-name
2223 /// type of a class template or class template partial specialization.
2224 TagDecl *getAsTagDecl() const;
2225
2226 /// If this is a pointer or reference to a RecordType, return the
2227 /// CXXRecordDecl that the type refers to.
2228 ///
2229 /// If this is not a pointer or reference, or the type being pointed to does
2230 /// not refer to a CXXRecordDecl, returns NULL.
2231 const CXXRecordDecl *getPointeeCXXRecordDecl() const;
2232
2233 /// Get the DeducedType whose type will be deduced for a variable with
2234 /// an initializer of this type. This looks through declarators like pointer
2235 /// types, but not through decltype or typedefs.
2236 DeducedType *getContainedDeducedType() const;
2237
2238 /// Get the AutoType whose type will be deduced for a variable with
2239 /// an initializer of this type. This looks through declarators like pointer
2240 /// types, but not through decltype or typedefs.
2241 AutoType *getContainedAutoType() const {
2242 return dyn_cast_or_null<AutoType>(getContainedDeducedType());
2243 }
2244
2245 /// Determine whether this type was written with a leading 'auto'
2246 /// corresponding to a trailing return type (possibly for a nested
2247 /// function type within a pointer to function type or similar).
2248 bool hasAutoForTrailingReturnType() const;
2249
2250 /// Member-template getAs<specific type>'. Look through sugar for
2251 /// an instance of \<specific type>. This scheme will eventually
2252 /// replace the specific getAsXXXX methods above.
2253 ///
2254 /// There are some specializations of this member template listed
2255 /// immediately following this class.
2256 template <typename T> const T *getAs() const;
2257
2258 /// Member-template getAsAdjusted<specific type>. Look through specific kinds
2259 /// of sugar (parens, attributes, etc) for an instance of \<specific type>.
2260 /// This is used when you need to walk over sugar nodes that represent some
2261 /// kind of type adjustment from a type that was written as a \<specific type>
2262 /// to another type that is still canonically a \<specific type>.
2263 template <typename T> const T *getAsAdjusted() const;
2264
2265 /// A variant of getAs<> for array types which silently discards
2266 /// qualifiers from the outermost type.
2267 const ArrayType *getAsArrayTypeUnsafe() const;
2268
2269 /// Member-template castAs<specific type>. Look through sugar for
2270 /// the underlying instance of \<specific type>.
2271 ///
2272 /// This method has the same relationship to getAs<T> as cast<T> has
2273 /// to dyn_cast<T>; which is to say, the underlying type *must*
2274 /// have the intended type, and this method will never return null.
2275 template <typename T> const T *castAs() const;
2276
2277 /// A variant of castAs<> for array type which silently discards
2278 /// qualifiers from the outermost type.
2279 const ArrayType *castAsArrayTypeUnsafe() const;
2280
2281 /// Determine whether this type had the specified attribute applied to it
2282 /// (looking through top-level type sugar).
2283 bool hasAttr(attr::Kind AK) const;
2284
2285 /// Get the base element type of this type, potentially discarding type
2286 /// qualifiers. This should never be used when type qualifiers
2287 /// are meaningful.
2288 const Type *getBaseElementTypeUnsafe() const;
2289
2290 /// If this is an array type, return the element type of the array,
2291 /// potentially with type qualifiers missing.
2292 /// This should never be used when type qualifiers are meaningful.
2293 const Type *getArrayElementTypeNoTypeQual() const;
2294
2295 /// If this is a pointer type, return the pointee type.
2296 /// If this is an array type, return the array element type.
2297 /// This should never be used when type qualifiers are meaningful.
2298 const Type *getPointeeOrArrayElementType() const;
2299
2300 /// If this is a pointer, ObjC object pointer, or block
2301 /// pointer, this returns the respective pointee.
2302 QualType getPointeeType() const;
2303
2304 /// Return the specified type with any "sugar" removed from the type,
2305 /// removing any typedefs, typeofs, etc., as well as any qualifiers.
2306 const Type *getUnqualifiedDesugaredType() const;
2307
2308 /// More type predicates useful for type checking/promotion
2309 bool isPromotableIntegerType() const; // C99 6.3.1.1p2
2310
2311 /// Return true if this is an integer type that is
2312 /// signed, according to C99 6.2.5p4 [char, signed char, short, int, long..],
2313 /// or an enum decl which has a signed representation.
2314 bool isSignedIntegerType() const;
2315
2316 /// Return true if this is an integer type that is
2317 /// unsigned, according to C99 6.2.5p6 [which returns true for _Bool],
2318 /// or an enum decl which has an unsigned representation.
2319 bool isUnsignedIntegerType() const;
2320
2321 /// Determines whether this is an integer type that is signed or an
2322 /// enumeration types whose underlying type is a signed integer type.
2323 bool isSignedIntegerOrEnumerationType() const;
2324
2325 /// Determines whether this is an integer type that is unsigned or an
2326 /// enumeration types whose underlying type is a unsigned integer type.
2327 bool isUnsignedIntegerOrEnumerationType() const;
2328
2329 /// Return true if this is a fixed point type according to
2330 /// ISO/IEC JTC1 SC22 WG14 N1169.
2331 bool isFixedPointType() const;
2332
2333 /// Return true if this is a fixed point or integer type.
2334 bool isFixedPointOrIntegerType() const;
2335
2336 /// Return true if this is a saturated fixed point type according to
2337 /// ISO/IEC JTC1 SC22 WG14 N1169. This type can be signed or unsigned.
2338 bool isSaturatedFixedPointType() const;
2339
2340 /// Return true if this is a saturated fixed point type according to
2341 /// ISO/IEC JTC1 SC22 WG14 N1169. This type can be signed or unsigned.
2342 bool isUnsaturatedFixedPointType() const;
2343
2344 /// Return true if this is a fixed point type that is signed according
2345 /// to ISO/IEC JTC1 SC22 WG14 N1169. This type can also be saturated.
2346 bool isSignedFixedPointType() const;
2347
2348 /// Return true if this is a fixed point type that is unsigned according
2349 /// to ISO/IEC JTC1 SC22 WG14 N1169. This type can also be saturated.
2350 bool isUnsignedFixedPointType() const;
2351
2352 /// Return true if this is not a variable sized type,
2353 /// according to the rules of C99 6.7.5p3. It is not legal to call this on
2354 /// incomplete types.
2355 bool isConstantSizeType() const;
2356
2357 /// Returns true if this type can be represented by some
2358 /// set of type specifiers.
2359 bool isSpecifierType() const;
2360
2361 /// Determine the linkage of this type.
2362 Linkage getLinkage() const;
2363
2364 /// Determine the visibility of this type.
2365 Visibility getVisibility() const {
2366 return getLinkageAndVisibility().getVisibility();
2367 }
2368
2369 /// Return true if the visibility was explicitly set is the code.
2370 bool isVisibilityExplicit() const {
2371 return getLinkageAndVisibility().isVisibilityExplicit();
2372 }
2373
2374 /// Determine the linkage and visibility of this type.
2375 LinkageInfo getLinkageAndVisibility() const;
2376
2377 /// True if the computed linkage is valid. Used for consistency
2378 /// checking. Should always return true.
2379 bool isLinkageValid() const;
2380
2381 /// Determine the nullability of the given type.
2382 ///
2383 /// Note that nullability is only captured as sugar within the type
2384 /// system, not as part of the canonical type, so nullability will
2385 /// be lost by canonicalization and desugaring.
2386 Optional<NullabilityKind> getNullability(const ASTContext &context) const;
2387
2388 /// Determine whether the given type can have a nullability
2389 /// specifier applied to it, i.e., if it is any kind of pointer type.
2390 ///
2391 /// \param ResultIfUnknown The value to return if we don't yet know whether
2392 /// this type can have nullability because it is dependent.
2393 bool canHaveNullability(bool ResultIfUnknown = true) const;
2394
2395 /// Retrieve the set of substitutions required when accessing a member
2396 /// of the Objective-C receiver type that is declared in the given context.
2397 ///
2398 /// \c *this is the type of the object we're operating on, e.g., the
2399 /// receiver for a message send or the base of a property access, and is
2400 /// expected to be of some object or object pointer type.
2401 ///
2402 /// \param dc The declaration context for which we are building up a
2403 /// substitution mapping, which should be an Objective-C class, extension,
2404 /// category, or method within.
2405 ///
2406 /// \returns an array of type arguments that can be substituted for
2407 /// the type parameters of the given declaration context in any type described
2408 /// within that context, or an empty optional to indicate that no
2409 /// substitution is required.
2410 Optional<ArrayRef<QualType>>
2411 getObjCSubstitutions(const DeclContext *dc) const;
2412
2413 /// Determines if this is an ObjC interface type that may accept type
2414 /// parameters.
2415 bool acceptsObjCTypeParams() const;
2416
2417 const char *getTypeClassName() const;
2418
2419 QualType getCanonicalTypeInternal() const {
2420 return CanonicalType;
2421 }
2422
2423 CanQualType getCanonicalTypeUnqualified() const; // in CanonicalType.h
2424 void dump() const;
2425 void dump(llvm::raw_ostream &OS) const;
2426};
2427
2428/// This will check for a TypedefType by removing any existing sugar
2429/// until it reaches a TypedefType or a non-sugared type.
2430template <> const TypedefType *Type::getAs() const;
2431
2432/// This will check for a TemplateSpecializationType by removing any
2433/// existing sugar until it reaches a TemplateSpecializationType or a
2434/// non-sugared type.
2435template <> const TemplateSpecializationType *Type::getAs() const;
2436
2437/// This will check for an AttributedType by removing any existing sugar
2438/// until it reaches an AttributedType or a non-sugared type.
2439template <> const AttributedType *Type::getAs() const;
2440
2441// We can do canonical leaf types faster, because we don't have to
2442// worry about preserving child type decoration.
2443#define TYPE(Class, Base)
2444#define LEAF_TYPE(Class) \
2445template <> inline const Class##Type *Type::getAs() const { \
2446 return dyn_cast<Class##Type>(CanonicalType); \
2447} \
2448template <> inline const Class##Type *Type::castAs() const { \
2449 return cast<Class##Type>(CanonicalType); \
2450}
2451#include "clang/AST/TypeNodes.inc"
2452
2453/// This class is used for builtin types like 'int'. Builtin
2454/// types are always canonical and have a literal name field.
2455class BuiltinType : public Type {
2456public:
2457 enum Kind {
2458// OpenCL image types
2459#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) Id,
2460#include "clang/Basic/OpenCLImageTypes.def"
2461// OpenCL extension types
2462#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) Id,
2463#include "clang/Basic/OpenCLExtensionTypes.def"
2464// SVE Types
2465#define SVE_TYPE(Name, Id, SingletonId) Id,
2466#include "clang/Basic/AArch64SVEACLETypes.def"
2467// All other builtin types
2468#define BUILTIN_TYPE(Id, SingletonId) Id,
2469#define LAST_BUILTIN_TYPE(Id) LastKind = Id
2470#include "clang/AST/BuiltinTypes.def"
2471 };
2472
2473private:
2474 friend class ASTContext; // ASTContext creates these.
2475
2476 BuiltinType(Kind K)
2477 : Type(Builtin, QualType(), /*Dependent=*/(K == Dependent),
2478 /*InstantiationDependent=*/(K == Dependent),
2479 /*VariablyModified=*/false,
2480 /*Unexpanded parameter pack=*/false) {
2481 BuiltinTypeBits.Kind = K;
2482 }
2483
2484public:
2485 Kind getKind() const { return static_cast<Kind>(BuiltinTypeBits.Kind); }
2486 StringRef getName(const PrintingPolicy &Policy) const;
2487
2488 const char *getNameAsCString(const PrintingPolicy &Policy) const {
2489 // The StringRef is null-terminated.
2490 StringRef str = getName(Policy);
2491 assert(!str.empty() && str.data()[str.size()] == '\0')((!str.empty() && str.data()[str.size()] == '\0') ? static_cast
<void> (0) : __assert_fail ("!str.empty() && str.data()[str.size()] == '\\0'"
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 2491, __PRETTY_FUNCTION__))
;
2492 return str.data();
2493 }
2494
2495 bool isSugared() const { return false; }
2496 QualType desugar() const { return QualType(this, 0); }
2497
2498 bool isInteger() const {
2499 return getKind() >= Bool && getKind() <= Int128;
2500 }
2501
2502 bool isSignedInteger() const {
2503 return getKind() >= Char_S && getKind() <= Int128;
2504 }
2505
2506 bool isUnsignedInteger() const {
2507 return getKind() >= Bool && getKind() <= UInt128;
2508 }
2509
2510 bool isFloatingPoint() const {
2511 return getKind() >= Half && getKind() <= Float128;
2512 }
2513
2514 /// Determines whether the given kind corresponds to a placeholder type.
2515 static bool isPlaceholderTypeKind(Kind K) {
2516 return K >= Overload;
2517 }
2518
2519 /// Determines whether this type is a placeholder type, i.e. a type
2520 /// which cannot appear in arbitrary positions in a fully-formed
2521 /// expression.
2522 bool isPlaceholderType() const {
2523 return isPlaceholderTypeKind(getKind());
2524 }
2525
2526 /// Determines whether this type is a placeholder type other than
2527 /// Overload. Most placeholder types require only syntactic
2528 /// information about their context in order to be resolved (e.g.
2529 /// whether it is a call expression), which means they can (and
2530 /// should) be resolved in an earlier "phase" of analysis.
2531 /// Overload expressions sometimes pick up further information
2532 /// from their context, like whether the context expects a
2533 /// specific function-pointer type, and so frequently need
2534 /// special treatment.
2535 bool isNonOverloadPlaceholderType() const {
2536 return getKind() > Overload;
2537 }
2538
2539 static bool classof(const Type *T) { return T->getTypeClass() == Builtin; }
2540};
2541
2542/// Complex values, per C99 6.2.5p11. This supports the C99 complex
2543/// types (_Complex float etc) as well as the GCC integer complex extensions.
2544class ComplexType : public Type, public llvm::FoldingSetNode {
2545 friend class ASTContext; // ASTContext creates these.
2546
2547 QualType ElementType;
2548
2549 ComplexType(QualType Element, QualType CanonicalPtr)
2550 : Type(Complex, CanonicalPtr, Element->isDependentType(),
2551 Element->isInstantiationDependentType(),
2552 Element->isVariablyModifiedType(),
2553 Element->containsUnexpandedParameterPack()),
2554 ElementType(Element) {}
2555
2556public:
2557 QualType getElementType() const { return ElementType; }
2558
2559 bool isSugared() const { return false; }
2560 QualType desugar() const { return QualType(this, 0); }
2561
2562 void Profile(llvm::FoldingSetNodeID &ID) {
2563 Profile(ID, getElementType());
2564 }
2565
2566 static void Profile(llvm::FoldingSetNodeID &ID, QualType Element) {
2567 ID.AddPointer(Element.getAsOpaquePtr());
2568 }
2569
2570 static bool classof(const Type *T) { return T->getTypeClass() == Complex; }
2571};
2572
2573/// Sugar for parentheses used when specifying types.
2574class ParenType : public Type, public llvm::FoldingSetNode {
2575 friend class ASTContext; // ASTContext creates these.
2576
2577 QualType Inner;
2578
2579 ParenType(QualType InnerType, QualType CanonType)
2580 : Type(Paren, CanonType, InnerType->isDependentType(),
2581 InnerType->isInstantiationDependentType(),
2582 InnerType->isVariablyModifiedType(),
2583 InnerType->containsUnexpandedParameterPack()),
2584 Inner(InnerType) {}
2585
2586public:
2587 QualType getInnerType() const { return Inner; }
2588
2589 bool isSugared() const { return true; }
2590 QualType desugar() const { return getInnerType(); }
2591
2592 void Profile(llvm::FoldingSetNodeID &ID) {
2593 Profile(ID, getInnerType());
2594 }
2595
2596 static void Profile(llvm::FoldingSetNodeID &ID, QualType Inner) {
2597 Inner.Profile(ID);
2598 }
2599
2600 static bool classof(const Type *T) { return T->getTypeClass() == Paren; }
2601};
2602
2603/// PointerType - C99 6.7.5.1 - Pointer Declarators.
2604class PointerType : public Type, public llvm::FoldingSetNode {
2605 friend class ASTContext; // ASTContext creates these.
2606
2607 QualType PointeeType;
2608
2609 PointerType(QualType Pointee, QualType CanonicalPtr)
2610 : Type(Pointer, CanonicalPtr, Pointee->isDependentType(),
2611 Pointee->isInstantiationDependentType(),
2612 Pointee->isVariablyModifiedType(),
2613 Pointee->containsUnexpandedParameterPack()),
2614 PointeeType(Pointee) {}
2615
2616public:
2617 QualType getPointeeType() const { return PointeeType; }
2618
2619 /// Returns true if address spaces of pointers overlap.
2620 /// OpenCL v2.0 defines conversion rules for pointers to different
2621 /// address spaces (OpenCLC v2.0 s6.5.5) and notion of overlapping
2622 /// address spaces.
2623 /// CL1.1 or CL1.2:
2624 /// address spaces overlap iff they are they same.
2625 /// CL2.0 adds:
2626 /// __generic overlaps with any address space except for __constant.
2627 bool isAddressSpaceOverlapping(const PointerType &other) const {
2628 Qualifiers thisQuals = PointeeType.getQualifiers();
2629 Qualifiers otherQuals = other.getPointeeType().getQualifiers();
2630 // Address spaces overlap if at least one of them is a superset of another
2631 return thisQuals.isAddressSpaceSupersetOf(otherQuals) ||
2632 otherQuals.isAddressSpaceSupersetOf(thisQuals);
2633 }
2634
2635 bool isSugared() const { return false; }
2636 QualType desugar() const { return QualType(this, 0); }
2637
2638 void Profile(llvm::FoldingSetNodeID &ID) {
2639 Profile(ID, getPointeeType());
2640 }
2641
2642 static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee) {
2643 ID.AddPointer(Pointee.getAsOpaquePtr());
2644 }
2645
2646 static bool classof(const Type *T) { return T->getTypeClass() == Pointer; }
2647};
2648
2649/// Represents a type which was implicitly adjusted by the semantic
2650/// engine for arbitrary reasons. For example, array and function types can
2651/// decay, and function types can have their calling conventions adjusted.
2652class AdjustedType : public Type, public llvm::FoldingSetNode {
2653 QualType OriginalTy;
2654 QualType AdjustedTy;
2655
2656protected:
2657 friend class ASTContext; // ASTContext creates these.
2658
2659 AdjustedType(TypeClass TC, QualType OriginalTy, QualType AdjustedTy,
2660 QualType CanonicalPtr)
2661 : Type(TC, CanonicalPtr, OriginalTy->isDependentType(),
2662 OriginalTy->isInstantiationDependentType(),
2663 OriginalTy->isVariablyModifiedType(),
2664 OriginalTy->containsUnexpandedParameterPack()),
2665 OriginalTy(OriginalTy), AdjustedTy(AdjustedTy) {}
2666
2667public:
2668 QualType getOriginalType() const { return OriginalTy; }
2669 QualType getAdjustedType() const { return AdjustedTy; }
2670
2671 bool isSugared() const { return true; }
2672 QualType desugar() const { return AdjustedTy; }
2673
2674 void Profile(llvm::FoldingSetNodeID &ID) {
2675 Profile(ID, OriginalTy, AdjustedTy);
2676 }
2677
2678 static void Profile(llvm::FoldingSetNodeID &ID, QualType Orig, QualType New) {
2679 ID.AddPointer(Orig.getAsOpaquePtr());
2680 ID.AddPointer(New.getAsOpaquePtr());
2681 }
2682
2683 static bool classof(const Type *T) {
2684 return T->getTypeClass() == Adjusted || T->getTypeClass() == Decayed;
2685 }
2686};
2687
2688/// Represents a pointer type decayed from an array or function type.
2689class DecayedType : public AdjustedType {
2690 friend class ASTContext; // ASTContext creates these.
2691
2692 inline
2693 DecayedType(QualType OriginalType, QualType Decayed, QualType Canonical);
2694
2695public:
2696 QualType getDecayedType() const { return getAdjustedType(); }
2697
2698 inline QualType getPointeeType() const;
2699
2700 static bool classof(const Type *T) { return T->getTypeClass() == Decayed; }
2701};
2702
2703/// Pointer to a block type.
2704/// This type is to represent types syntactically represented as
2705/// "void (^)(int)", etc. Pointee is required to always be a function type.
2706class BlockPointerType : public Type, public llvm::FoldingSetNode {
2707 friend class ASTContext; // ASTContext creates these.
2708
2709 // Block is some kind of pointer type
2710 QualType PointeeType;
2711
2712 BlockPointerType(QualType Pointee, QualType CanonicalCls)
2713 : Type(BlockPointer, CanonicalCls, Pointee->isDependentType(),
2714 Pointee->isInstantiationDependentType(),
2715 Pointee->isVariablyModifiedType(),
2716 Pointee->containsUnexpandedParameterPack()),
2717 PointeeType(Pointee) {}
2718
2719public:
2720 // Get the pointee type. Pointee is required to always be a function type.
2721 QualType getPointeeType() const { return PointeeType; }
2722
2723 bool isSugared() const { return false; }
2724 QualType desugar() const { return QualType(this, 0); }
2725
2726 void Profile(llvm::FoldingSetNodeID &ID) {
2727 Profile(ID, getPointeeType());
2728 }
2729
2730 static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee) {
2731 ID.AddPointer(Pointee.getAsOpaquePtr());
2732 }
2733
2734 static bool classof(const Type *T) {
2735 return T->getTypeClass() == BlockPointer;
2736 }
2737};
2738
2739/// Base for LValueReferenceType and RValueReferenceType
2740class ReferenceType : public Type, public llvm::FoldingSetNode {
2741 QualType PointeeType;
2742
2743protected:
2744 ReferenceType(TypeClass tc, QualType Referencee, QualType CanonicalRef,
2745 bool SpelledAsLValue)
2746 : Type(tc, CanonicalRef, Referencee->isDependentType(),
2747 Referencee->isInstantiationDependentType(),
2748 Referencee->isVariablyModifiedType(),
2749 Referencee->containsUnexpandedParameterPack()),
2750 PointeeType(Referencee) {
2751 ReferenceTypeBits.SpelledAsLValue = SpelledAsLValue;
2752 ReferenceTypeBits.InnerRef = Referencee->isReferenceType();
2753 }
2754
2755public:
2756 bool isSpelledAsLValue() const { return ReferenceTypeBits.SpelledAsLValue; }
2757 bool isInnerRef() const { return ReferenceTypeBits.InnerRef; }
2758
2759 QualType getPointeeTypeAsWritten() const { return PointeeType; }
2760
2761 QualType getPointeeType() const {
2762 // FIXME: this might strip inner qualifiers; okay?
2763 const ReferenceType *T = this;
2764 while (T->isInnerRef())
2765 T = T->PointeeType->castAs<ReferenceType>();
2766 return T->PointeeType;
2767 }
2768
2769 void Profile(llvm::FoldingSetNodeID &ID) {
2770 Profile(ID, PointeeType, isSpelledAsLValue());
2771 }
2772
2773 static void Profile(llvm::FoldingSetNodeID &ID,
2774 QualType Referencee,
2775 bool SpelledAsLValue) {
2776 ID.AddPointer(Referencee.getAsOpaquePtr());
2777 ID.AddBoolean(SpelledAsLValue);
2778 }
2779
2780 static bool classof(const Type *T) {
2781 return T->getTypeClass() == LValueReference ||
2782 T->getTypeClass() == RValueReference;
2783 }
2784};
2785
2786/// An lvalue reference type, per C++11 [dcl.ref].
2787class LValueReferenceType : public ReferenceType {
2788 friend class ASTContext; // ASTContext creates these
2789
2790 LValueReferenceType(QualType Referencee, QualType CanonicalRef,
2791 bool SpelledAsLValue)
2792 : ReferenceType(LValueReference, Referencee, CanonicalRef,
2793 SpelledAsLValue) {}
2794
2795public:
2796 bool isSugared() const { return false; }
2797 QualType desugar() const { return QualType(this, 0); }
2798
2799 static bool classof(const Type *T) {
2800 return T->getTypeClass() == LValueReference;
2801 }
2802};
2803
2804/// An rvalue reference type, per C++11 [dcl.ref].
2805class RValueReferenceType : public ReferenceType {
2806 friend class ASTContext; // ASTContext creates these
2807
2808 RValueReferenceType(QualType Referencee, QualType CanonicalRef)
2809 : ReferenceType(RValueReference, Referencee, CanonicalRef, false) {}
2810
2811public:
2812 bool isSugared() const { return false; }
2813 QualType desugar() const { return QualType(this, 0); }
2814
2815 static bool classof(const Type *T) {
2816 return T->getTypeClass() == RValueReference;
2817 }
2818};
2819
2820/// A pointer to member type per C++ 8.3.3 - Pointers to members.
2821///
2822/// This includes both pointers to data members and pointer to member functions.
2823class MemberPointerType : public Type, public llvm::FoldingSetNode {
2824 friend class ASTContext; // ASTContext creates these.
2825
2826 QualType PointeeType;
2827
2828 /// The class of which the pointee is a member. Must ultimately be a
2829 /// RecordType, but could be a typedef or a template parameter too.
2830 const Type *Class;
2831
2832 MemberPointerType(QualType Pointee, const Type *Cls, QualType CanonicalPtr)
2833 : Type(MemberPointer, CanonicalPtr,
2834 Cls->isDependentType() || Pointee->isDependentType(),
2835 (Cls->isInstantiationDependentType() ||
2836 Pointee->isInstantiationDependentType()),
2837 Pointee->isVariablyModifiedType(),
2838 (Cls->containsUnexpandedParameterPack() ||
2839 Pointee->containsUnexpandedParameterPack())),
2840 PointeeType(Pointee), Class(Cls) {}
2841
2842public:
2843 QualType getPointeeType() const { return PointeeType; }
2844
2845 /// Returns true if the member type (i.e. the pointee type) is a
2846 /// function type rather than a data-member type.
2847 bool isMemberFunctionPointer() const {
2848 return PointeeType->isFunctionProtoType();
2849 }
2850
2851 /// Returns true if the member type (i.e. the pointee type) is a
2852 /// data type rather than a function type.
2853 bool isMemberDataPointer() const {
2854 return !PointeeType->isFunctionProtoType();
2855 }
2856
2857 const Type *getClass() const { return Class; }
2858 CXXRecordDecl *getMostRecentCXXRecordDecl() const;
2859
2860 bool isSugared() const { return false; }
2861 QualType desugar() const { return QualType(this, 0); }
2862
2863 void Profile(llvm::FoldingSetNodeID &ID) {
2864 Profile(ID, getPointeeType(), getClass());
2865 }
2866
2867 static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee,
2868 const Type *Class) {
2869 ID.AddPointer(Pointee.getAsOpaquePtr());
2870 ID.AddPointer(Class);
2871 }
2872
2873 static bool classof(const Type *T) {
2874 return T->getTypeClass() == MemberPointer;
2875 }
2876};
2877
2878/// Represents an array type, per C99 6.7.5.2 - Array Declarators.
2879class ArrayType : public Type, public llvm::FoldingSetNode {
2880public:
2881 /// Capture whether this is a normal array (e.g. int X[4])
2882 /// an array with a static size (e.g. int X[static 4]), or an array
2883 /// with a star size (e.g. int X[*]).
2884 /// 'static' is only allowed on function parameters.
2885 enum ArraySizeModifier {
2886 Normal, Static, Star
2887 };
2888
2889private:
2890 /// The element type of the array.
2891 QualType ElementType;
2892
2893protected:
2894 friend class ASTContext; // ASTContext creates these.
2895
2896 ArrayType(TypeClass tc, QualType et, QualType can, ArraySizeModifier sm,
2897 unsigned tq, const Expr *sz = nullptr);
2898
2899public:
2900 QualType getElementType() const { return ElementType; }
2901
2902 ArraySizeModifier getSizeModifier() const {
2903 return ArraySizeModifier(ArrayTypeBits.SizeModifier);
2904 }
2905
2906 Qualifiers getIndexTypeQualifiers() const {
2907 return Qualifiers::fromCVRMask(getIndexTypeCVRQualifiers());
2908 }
2909
2910 unsigned getIndexTypeCVRQualifiers() const {
2911 return ArrayTypeBits.IndexTypeQuals;
2912 }
2913
2914 static bool classof(const Type *T) {
2915 return T->getTypeClass() == ConstantArray ||
2916 T->getTypeClass() == VariableArray ||
2917 T->getTypeClass() == IncompleteArray ||
2918 T->getTypeClass() == DependentSizedArray;
2919 }
2920};
2921
2922/// Represents the canonical version of C arrays with a specified constant size.
2923/// For example, the canonical type for 'int A[4 + 4*100]' is a
2924/// ConstantArrayType where the element type is 'int' and the size is 404.
2925class ConstantArrayType final
2926 : public ArrayType,
2927 private llvm::TrailingObjects<ConstantArrayType, const Expr *> {
2928 friend class ASTContext; // ASTContext creates these.
2929 friend TrailingObjects;
2930
2931 llvm::APInt Size; // Allows us to unique the type.
2932
2933 ConstantArrayType(QualType et, QualType can, const llvm::APInt &size,
2934 const Expr *sz, ArraySizeModifier sm, unsigned tq)
2935 : ArrayType(ConstantArray, et, can, sm, tq, sz), Size(size) {
2936 ConstantArrayTypeBits.HasStoredSizeExpr = sz != nullptr;
2937 if (ConstantArrayTypeBits.HasStoredSizeExpr) {
2938 assert(!can.isNull() && "canonical constant array should not have size")((!can.isNull() && "canonical constant array should not have size"
) ? static_cast<void> (0) : __assert_fail ("!can.isNull() && \"canonical constant array should not have size\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 2938, __PRETTY_FUNCTION__))
;
2939 *getTrailingObjects<const Expr*>() = sz;
2940 }
2941 }
2942
2943 unsigned numTrailingObjects(OverloadToken<const Expr*>) const {
2944 return ConstantArrayTypeBits.HasStoredSizeExpr;
2945 }
2946
2947public:
2948 const llvm::APInt &getSize() const { return Size; }
2949 const Expr *getSizeExpr() const {
2950 return ConstantArrayTypeBits.HasStoredSizeExpr
2951 ? *getTrailingObjects<const Expr *>()
2952 : nullptr;
2953 }
2954 bool isSugared() const { return false; }
2955 QualType desugar() const { return QualType(this, 0); }
2956
2957 /// Determine the number of bits required to address a member of
2958 // an array with the given element type and number of elements.
2959 static unsigned getNumAddressingBits(const ASTContext &Context,
2960 QualType ElementType,
2961 const llvm::APInt &NumElements);
2962
2963 /// Determine the maximum number of active bits that an array's size
2964 /// can require, which limits the maximum size of the array.
2965 static unsigned getMaxSizeBits(const ASTContext &Context);
2966
2967 void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx) {
2968 Profile(ID, Ctx, getElementType(), getSize(), getSizeExpr(),
2969 getSizeModifier(), getIndexTypeCVRQualifiers());
2970 }
2971
2972 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx,
2973 QualType ET, const llvm::APInt &ArraySize,
2974 const Expr *SizeExpr, ArraySizeModifier SizeMod,
2975 unsigned TypeQuals);
2976
2977 static bool classof(const Type *T) {
2978 return T->getTypeClass() == ConstantArray;
2979 }
2980};
2981
2982/// Represents a C array with an unspecified size. For example 'int A[]' has
2983/// an IncompleteArrayType where the element type is 'int' and the size is
2984/// unspecified.
2985class IncompleteArrayType : public ArrayType {
2986 friend class ASTContext; // ASTContext creates these.
2987
2988 IncompleteArrayType(QualType et, QualType can,
2989 ArraySizeModifier sm, unsigned tq)
2990 : ArrayType(IncompleteArray, et, can, sm, tq) {}
2991
2992public:
2993 friend class StmtIteratorBase;
2994
2995 bool isSugared() const { return false; }
2996 QualType desugar() const { return QualType(this, 0); }
2997
2998 static bool classof(const Type *T) {
2999 return T->getTypeClass() == IncompleteArray;
3000 }
3001
3002 void Profile(llvm::FoldingSetNodeID &ID) {
3003 Profile(ID, getElementType(), getSizeModifier(),
3004 getIndexTypeCVRQualifiers());
3005 }
3006
3007 static void Profile(llvm::FoldingSetNodeID &ID, QualType ET,
3008 ArraySizeModifier SizeMod, unsigned TypeQuals) {
3009 ID.AddPointer(ET.getAsOpaquePtr());
3010 ID.AddInteger(SizeMod);
3011 ID.AddInteger(TypeQuals);
3012 }
3013};
3014
3015/// Represents a C array with a specified size that is not an
3016/// integer-constant-expression. For example, 'int s[x+foo()]'.
3017/// Since the size expression is an arbitrary expression, we store it as such.
3018///
3019/// Note: VariableArrayType's aren't uniqued (since the expressions aren't) and
3020/// should not be: two lexically equivalent variable array types could mean
3021/// different things, for example, these variables do not have the same type
3022/// dynamically:
3023///
3024/// void foo(int x) {
3025/// int Y[x];
3026/// ++x;
3027/// int Z[x];
3028/// }
3029class VariableArrayType : public ArrayType {
3030 friend class ASTContext; // ASTContext creates these.
3031
3032 /// An assignment-expression. VLA's are only permitted within
3033 /// a function block.
3034 Stmt *SizeExpr;
3035
3036 /// The range spanned by the left and right array brackets.
3037 SourceRange Brackets;
3038
3039 VariableArrayType(QualType et, QualType can, Expr *e,
3040 ArraySizeModifier sm, unsigned tq,
3041 SourceRange brackets)
3042 : ArrayType(VariableArray, et, can, sm, tq, e),
3043 SizeExpr((Stmt*) e), Brackets(brackets) {}
3044
3045public:
3046 friend class StmtIteratorBase;
3047
3048 Expr *getSizeExpr() const {
3049 // We use C-style casts instead of cast<> here because we do not wish
3050 // to have a dependency of Type.h on Stmt.h/Expr.h.
3051 return (Expr*) SizeExpr;
3052 }
3053
3054 SourceRange getBracketsRange() const { return Brackets; }
3055 SourceLocation getLBracketLoc() const { return Brackets.getBegin(); }
3056 SourceLocation getRBracketLoc() const { return Brackets.getEnd(); }
3057
3058 bool isSugared() const { return false; }
3059 QualType desugar() const { return QualType(this, 0); }
3060
3061 static bool classof(const Type *T) {
3062 return T->getTypeClass() == VariableArray;
3063 }
3064
3065 void Profile(llvm::FoldingSetNodeID &ID) {
3066 llvm_unreachable("Cannot unique VariableArrayTypes.")::llvm::llvm_unreachable_internal("Cannot unique VariableArrayTypes."
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 3066)
;
3067 }
3068};
3069
3070/// Represents an array type in C++ whose size is a value-dependent expression.
3071///
3072/// For example:
3073/// \code
3074/// template<typename T, int Size>
3075/// class array {
3076/// T data[Size];
3077/// };
3078/// \endcode
3079///
3080/// For these types, we won't actually know what the array bound is
3081/// until template instantiation occurs, at which point this will
3082/// become either a ConstantArrayType or a VariableArrayType.
3083class DependentSizedArrayType : public ArrayType {
3084 friend class ASTContext; // ASTContext creates these.
3085
3086 const ASTContext &Context;
3087
3088 /// An assignment expression that will instantiate to the
3089 /// size of the array.
3090 ///
3091 /// The expression itself might be null, in which case the array
3092 /// type will have its size deduced from an initializer.
3093 Stmt *SizeExpr;
3094
3095 /// The range spanned by the left and right array brackets.
3096 SourceRange Brackets;
3097
3098 DependentSizedArrayType(const ASTContext &Context, QualType et, QualType can,
3099 Expr *e, ArraySizeModifier sm, unsigned tq,
3100 SourceRange brackets);
3101
3102public:
3103 friend class StmtIteratorBase;
3104
3105 Expr *getSizeExpr() const {
3106 // We use C-style casts instead of cast<> here because we do not wish
3107 // to have a dependency of Type.h on Stmt.h/Expr.h.
3108 return (Expr*) SizeExpr;
3109 }
3110
3111 SourceRange getBracketsRange() const { return Brackets; }
3112 SourceLocation getLBracketLoc() const { return Brackets.getBegin(); }
3113 SourceLocation getRBracketLoc() const { return Brackets.getEnd(); }
3114
3115 bool isSugared() const { return false; }
3116 QualType desugar() const { return QualType(this, 0); }
3117
3118 static bool classof(const Type *T) {
3119 return T->getTypeClass() == DependentSizedArray;
3120 }
3121
3122 void Profile(llvm::FoldingSetNodeID &ID) {
3123 Profile(ID, Context, getElementType(),
3124 getSizeModifier(), getIndexTypeCVRQualifiers(), getSizeExpr());
3125 }
3126
3127 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3128 QualType ET, ArraySizeModifier SizeMod,
3129 unsigned TypeQuals, Expr *E);
3130};
3131
3132/// Represents an extended address space qualifier where the input address space
3133/// value is dependent. Non-dependent address spaces are not represented with a
3134/// special Type subclass; they are stored on an ExtQuals node as part of a QualType.
3135///
3136/// For example:
3137/// \code
3138/// template<typename T, int AddrSpace>
3139/// class AddressSpace {
3140/// typedef T __attribute__((address_space(AddrSpace))) type;
3141/// }
3142/// \endcode
3143class DependentAddressSpaceType : public Type, public llvm::FoldingSetNode {
3144 friend class ASTContext;
3145
3146 const ASTContext &Context;
3147 Expr *AddrSpaceExpr;
3148 QualType PointeeType;
3149 SourceLocation loc;
3150
3151 DependentAddressSpaceType(const ASTContext &Context, QualType PointeeType,
3152 QualType can, Expr *AddrSpaceExpr,
3153 SourceLocation loc);
3154
3155public:
3156 Expr *getAddrSpaceExpr() const { return AddrSpaceExpr; }
3157 QualType getPointeeType() const { return PointeeType; }
3158 SourceLocation getAttributeLoc() const { return loc; }
3159
3160 bool isSugared() const { return false; }
3161 QualType desugar() const { return QualType(this, 0); }
3162
3163 static bool classof(const Type *T) {
3164 return T->getTypeClass() == DependentAddressSpace;
3165 }
3166
3167 void Profile(llvm::FoldingSetNodeID &ID) {
3168 Profile(ID, Context, getPointeeType(), getAddrSpaceExpr());
3169 }
3170
3171 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3172 QualType PointeeType, Expr *AddrSpaceExpr);
3173};
3174
3175/// Represents an extended vector type where either the type or size is
3176/// dependent.
3177///
3178/// For example:
3179/// \code
3180/// template<typename T, int Size>
3181/// class vector {
3182/// typedef T __attribute__((ext_vector_type(Size))) type;
3183/// }
3184/// \endcode
3185class DependentSizedExtVectorType : public Type, public llvm::FoldingSetNode {
3186 friend class ASTContext;
3187
3188 const ASTContext &Context;
3189 Expr *SizeExpr;
3190
3191 /// The element type of the array.
3192 QualType ElementType;
3193
3194 SourceLocation loc;
3195
3196 DependentSizedExtVectorType(const ASTContext &Context, QualType ElementType,
3197 QualType can, Expr *SizeExpr, SourceLocation loc);
3198
3199public:
3200 Expr *getSizeExpr() const { return SizeExpr; }
3201 QualType getElementType() const { return ElementType; }
3202 SourceLocation getAttributeLoc() const { return loc; }
3203
3204 bool isSugared() const { return false; }
3205 QualType desugar() const { return QualType(this, 0); }
3206
3207 static bool classof(const Type *T) {
3208 return T->getTypeClass() == DependentSizedExtVector;
3209 }
3210
3211 void Profile(llvm::FoldingSetNodeID &ID) {
3212 Profile(ID, Context, getElementType(), getSizeExpr());
3213 }
3214
3215 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3216 QualType ElementType, Expr *SizeExpr);
3217};
3218
3219
3220/// Represents a GCC generic vector type. This type is created using
3221/// __attribute__((vector_size(n)), where "n" specifies the vector size in
3222/// bytes; or from an Altivec __vector or vector declaration.
3223/// Since the constructor takes the number of vector elements, the
3224/// client is responsible for converting the size into the number of elements.
3225class VectorType : public Type, public llvm::FoldingSetNode {
3226public:
3227 enum VectorKind {
3228 /// not a target-specific vector type
3229 GenericVector,
3230
3231 /// is AltiVec vector
3232 AltiVecVector,
3233
3234 /// is AltiVec 'vector Pixel'
3235 AltiVecPixel,
3236
3237 /// is AltiVec 'vector bool ...'
3238 AltiVecBool,
3239
3240 /// is ARM Neon vector
3241 NeonVector,
3242
3243 /// is ARM Neon polynomial vector
3244 NeonPolyVector
3245 };
3246
3247protected:
3248 friend class ASTContext; // ASTContext creates these.
3249
3250 /// The element type of the vector.
3251 QualType ElementType;
3252
3253 VectorType(QualType vecType, unsigned nElements, QualType canonType,
3254 VectorKind vecKind);
3255
3256 VectorType(TypeClass tc, QualType vecType, unsigned nElements,
3257 QualType canonType, VectorKind vecKind);
3258
3259public:
3260 QualType getElementType() const { return ElementType; }
3261 unsigned getNumElements() const { return VectorTypeBits.NumElements; }
3262
3263 static bool isVectorSizeTooLarge(unsigned NumElements) {
3264 return NumElements > VectorTypeBitfields::MaxNumElements;
3265 }
3266
3267 bool isSugared() const { return false; }
3268 QualType desugar() const { return QualType(this, 0); }
3269
3270 VectorKind getVectorKind() const {
3271 return VectorKind(VectorTypeBits.VecKind);
3272 }
3273
3274 void Profile(llvm::FoldingSetNodeID &ID) {
3275 Profile(ID, getElementType(), getNumElements(),
3276 getTypeClass(), getVectorKind());
3277 }
3278
3279 static void Profile(llvm::FoldingSetNodeID &ID, QualType ElementType,
3280 unsigned NumElements, TypeClass TypeClass,
3281 VectorKind VecKind) {
3282 ID.AddPointer(ElementType.getAsOpaquePtr());
3283 ID.AddInteger(NumElements);
3284 ID.AddInteger(TypeClass);
3285 ID.AddInteger(VecKind);
3286 }
3287
3288 static bool classof(const Type *T) {
3289 return T->getTypeClass() == Vector || T->getTypeClass() == ExtVector;
3290 }
3291};
3292
3293/// Represents a vector type where either the type or size is dependent.
3294////
3295/// For example:
3296/// \code
3297/// template<typename T, int Size>
3298/// class vector {
3299/// typedef T __attribute__((vector_size(Size))) type;
3300/// }
3301/// \endcode
3302class DependentVectorType : public Type, public llvm::FoldingSetNode {
3303 friend class ASTContext;
3304
3305 const ASTContext &Context;
3306 QualType ElementType;
3307 Expr *SizeExpr;
3308 SourceLocation Loc;
3309
3310 DependentVectorType(const ASTContext &Context, QualType ElementType,
3311 QualType CanonType, Expr *SizeExpr,
3312 SourceLocation Loc, VectorType::VectorKind vecKind);
3313
3314public:
3315 Expr *getSizeExpr() const { return SizeExpr; }
3316 QualType getElementType() const { return ElementType; }
3317 SourceLocation getAttributeLoc() const { return Loc; }
3318 VectorType::VectorKind getVectorKind() const {
3319 return VectorType::VectorKind(VectorTypeBits.VecKind);
3320 }
3321
3322 bool isSugared() const { return false; }
3323 QualType desugar() const { return QualType(this, 0); }
3324
3325 static bool classof(const Type *T) {
3326 return T->getTypeClass() == DependentVector;
3327 }
3328
3329 void Profile(llvm::FoldingSetNodeID &ID) {
3330 Profile(ID, Context, getElementType(), getSizeExpr(), getVectorKind());
3331 }
3332
3333 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3334 QualType ElementType, const Expr *SizeExpr,
3335 VectorType::VectorKind VecKind);
3336};
3337
3338/// ExtVectorType - Extended vector type. This type is created using
3339/// __attribute__((ext_vector_type(n)), where "n" is the number of elements.
3340/// Unlike vector_size, ext_vector_type is only allowed on typedef's. This
3341/// class enables syntactic extensions, like Vector Components for accessing
3342/// points (as .xyzw), colors (as .rgba), and textures (modeled after OpenGL
3343/// Shading Language).
3344class ExtVectorType : public VectorType {
3345 friend class ASTContext; // ASTContext creates these.
3346
3347 ExtVectorType(QualType vecType, unsigned nElements, QualType canonType)
3348 : VectorType(ExtVector, vecType, nElements, canonType, GenericVector) {}
3349
3350public:
3351 static int getPointAccessorIdx(char c) {
3352 switch (c) {
3353 default: return -1;
3354 case 'x': case 'r': return 0;
3355 case 'y': case 'g': return 1;
3356 case 'z': case 'b': return 2;
3357 case 'w': case 'a': return 3;
3358 }
3359 }
3360
3361 static int getNumericAccessorIdx(char c) {
3362 switch (c) {
3363 default: return -1;
3364 case '0': return 0;
3365 case '1': return 1;
3366 case '2': return 2;
3367 case '3': return 3;
3368 case '4': return 4;
3369 case '5': return 5;
3370 case '6': return 6;
3371 case '7': return 7;
3372 case '8': return 8;
3373 case '9': return 9;
3374 case 'A':
3375 case 'a': return 10;
3376 case 'B':
3377 case 'b': return 11;
3378 case 'C':
3379 case 'c': return 12;
3380 case 'D':
3381 case 'd': return 13;
3382 case 'E':
3383 case 'e': return 14;
3384 case 'F':
3385 case 'f': return 15;
3386 }
3387 }
3388
3389 static int getAccessorIdx(char c, bool isNumericAccessor) {
3390 if (isNumericAccessor)
3391 return getNumericAccessorIdx(c);
3392 else
3393 return getPointAccessorIdx(c);
3394 }
3395
3396 bool isAccessorWithinNumElements(char c, bool isNumericAccessor) const {
3397 if (int idx = getAccessorIdx(c, isNumericAccessor)+1)
3398 return unsigned(idx-1) < getNumElements();
3399 return false;
3400 }
3401
3402 bool isSugared() const { return false; }
3403 QualType desugar() const { return QualType(this, 0); }
3404
3405 static bool classof(const Type *T) {
3406 return T->getTypeClass() == ExtVector;
3407 }
3408};
3409
3410/// FunctionType - C99 6.7.5.3 - Function Declarators. This is the common base
3411/// class of FunctionNoProtoType and FunctionProtoType.
3412class FunctionType : public Type {
3413 // The type returned by the function.
3414 QualType ResultType;
3415
3416public:
3417 /// Interesting information about a specific parameter that can't simply
3418 /// be reflected in parameter's type. This is only used by FunctionProtoType
3419 /// but is in FunctionType to make this class available during the
3420 /// specification of the bases of FunctionProtoType.
3421 ///
3422 /// It makes sense to model language features this way when there's some
3423 /// sort of parameter-specific override (such as an attribute) that
3424 /// affects how the function is called. For example, the ARC ns_consumed
3425 /// attribute changes whether a parameter is passed at +0 (the default)
3426 /// or +1 (ns_consumed). This must be reflected in the function type,
3427 /// but isn't really a change to the parameter type.
3428 ///
3429 /// One serious disadvantage of modelling language features this way is
3430 /// that they generally do not work with language features that attempt
3431 /// to destructure types. For example, template argument deduction will
3432 /// not be able to match a parameter declared as
3433 /// T (*)(U)
3434 /// against an argument of type
3435 /// void (*)(__attribute__((ns_consumed)) id)
3436 /// because the substitution of T=void, U=id into the former will
3437 /// not produce the latter.
3438 class ExtParameterInfo {
3439 enum {
3440 ABIMask = 0x0F,
3441 IsConsumed = 0x10,
3442 HasPassObjSize = 0x20,
3443 IsNoEscape = 0x40,
3444 };
3445 unsigned char Data = 0;
3446
3447 public:
3448 ExtParameterInfo() = default;
3449
3450 /// Return the ABI treatment of this parameter.
3451 ParameterABI getABI() const { return ParameterABI(Data & ABIMask); }
3452 ExtParameterInfo withABI(ParameterABI kind) const {
3453 ExtParameterInfo copy = *this;
3454 copy.Data = (copy.Data & ~ABIMask) | unsigned(kind);
3455 return copy;
3456 }
3457
3458 /// Is this parameter considered "consumed" by Objective-C ARC?
3459 /// Consumed parameters must have retainable object type.
3460 bool isConsumed() const { return (Data & IsConsumed); }
3461 ExtParameterInfo withIsConsumed(bool consumed) const {
3462 ExtParameterInfo copy = *this;
3463 if (consumed)
3464 copy.Data |= IsConsumed;
3465 else
3466 copy.Data &= ~IsConsumed;
3467 return copy;
3468 }
3469
3470 bool hasPassObjectSize() const { return Data & HasPassObjSize; }
3471 ExtParameterInfo withHasPassObjectSize() const {
3472 ExtParameterInfo Copy = *this;
3473 Copy.Data |= HasPassObjSize;
3474 return Copy;
3475 }
3476
3477 bool isNoEscape() const { return Data & IsNoEscape; }
3478 ExtParameterInfo withIsNoEscape(bool NoEscape) const {
3479 ExtParameterInfo Copy = *this;
3480 if (NoEscape)
3481 Copy.Data |= IsNoEscape;
3482 else
3483 Copy.Data &= ~IsNoEscape;
3484 return Copy;
3485 }
3486
3487 unsigned char getOpaqueValue() const { return Data; }
3488 static ExtParameterInfo getFromOpaqueValue(unsigned char data) {
3489 ExtParameterInfo result;
3490 result.Data = data;
3491 return result;
3492 }
3493
3494 friend bool operator==(ExtParameterInfo lhs, ExtParameterInfo rhs) {
3495 return lhs.Data == rhs.Data;
3496 }
3497
3498 friend bool operator!=(ExtParameterInfo lhs, ExtParameterInfo rhs) {
3499 return lhs.Data != rhs.Data;
3500 }
3501 };
3502
3503 /// A class which abstracts out some details necessary for
3504 /// making a call.
3505 ///
3506 /// It is not actually used directly for storing this information in
3507 /// a FunctionType, although FunctionType does currently use the
3508 /// same bit-pattern.
3509 ///
3510 // If you add a field (say Foo), other than the obvious places (both,
3511 // constructors, compile failures), what you need to update is
3512 // * Operator==
3513 // * getFoo
3514 // * withFoo
3515 // * functionType. Add Foo, getFoo.
3516 // * ASTContext::getFooType
3517 // * ASTContext::mergeFunctionTypes
3518 // * FunctionNoProtoType::Profile
3519 // * FunctionProtoType::Profile
3520 // * TypePrinter::PrintFunctionProto
3521 // * AST read and write
3522 // * Codegen
3523 class ExtInfo {
3524 friend class FunctionType;
3525
3526 // Feel free to rearrange or add bits, but if you go over 12,
3527 // you'll need to adjust both the Bits field below and
3528 // Type::FunctionTypeBitfields.
3529
3530 // | CC |noreturn|produces|nocallersavedregs|regparm|nocfcheck|
3531 // |0 .. 4| 5 | 6 | 7 |8 .. 10| 11 |
3532 //
3533 // regparm is either 0 (no regparm attribute) or the regparm value+1.
3534 enum { CallConvMask = 0x1F };
3535 enum { NoReturnMask = 0x20 };
3536 enum { ProducesResultMask = 0x40 };
3537 enum { NoCallerSavedRegsMask = 0x80 };
3538 enum { NoCfCheckMask = 0x800 };
3539 enum {
3540 RegParmMask = ~(CallConvMask | NoReturnMask | ProducesResultMask |
3541 NoCallerSavedRegsMask | NoCfCheckMask),
3542 RegParmOffset = 8
3543 }; // Assumed to be the last field
3544 uint16_t Bits = CC_C;
3545
3546 ExtInfo(unsigned Bits) : Bits(static_cast<uint16_t>(Bits)) {}
3547
3548 public:
3549 // Constructor with no defaults. Use this when you know that you
3550 // have all the elements (when reading an AST file for example).
3551 ExtInfo(bool noReturn, bool hasRegParm, unsigned regParm, CallingConv cc,
3552 bool producesResult, bool noCallerSavedRegs, bool NoCfCheck) {
3553 assert((!hasRegParm || regParm < 7) && "Invalid regparm value")(((!hasRegParm || regParm < 7) && "Invalid regparm value"
) ? static_cast<void> (0) : __assert_fail ("(!hasRegParm || regParm < 7) && \"Invalid regparm value\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 3553, __PRETTY_FUNCTION__))
;
3554 Bits = ((unsigned)cc) | (noReturn ? NoReturnMask : 0) |
3555 (producesResult ? ProducesResultMask : 0) |
3556 (noCallerSavedRegs ? NoCallerSavedRegsMask : 0) |
3557 (hasRegParm ? ((regParm + 1) << RegParmOffset) : 0) |
3558 (NoCfCheck ? NoCfCheckMask : 0);
3559 }
3560
3561 // Constructor with all defaults. Use when for example creating a
3562 // function known to use defaults.
3563 ExtInfo() = default;
3564
3565 // Constructor with just the calling convention, which is an important part
3566 // of the canonical type.
3567 ExtInfo(CallingConv CC) : Bits(CC) {}
3568
3569 bool getNoReturn() const { return Bits & NoReturnMask; }
3570 bool getProducesResult() const { return Bits & ProducesResultMask; }
3571 bool getNoCallerSavedRegs() const { return Bits & NoCallerSavedRegsMask; }
3572 bool getNoCfCheck() const { return Bits & NoCfCheckMask; }
3573 bool getHasRegParm() const { return (Bits >> RegParmOffset) != 0; }
3574
3575 unsigned getRegParm() const {
3576 unsigned RegParm = (Bits & RegParmMask) >> RegParmOffset;
3577 if (RegParm > 0)
3578 --RegParm;
3579 return RegParm;
3580 }
3581
3582 CallingConv getCC() const { return CallingConv(Bits & CallConvMask); }
3583
3584 bool operator==(ExtInfo Other) const {
3585 return Bits == Other.Bits;
3586 }
3587 bool operator!=(ExtInfo Other) const {
3588 return Bits != Other.Bits;
3589 }
3590
3591 // Note that we don't have setters. That is by design, use
3592 // the following with methods instead of mutating these objects.
3593
3594 ExtInfo withNoReturn(bool noReturn) const {
3595 if (noReturn)
3596 return ExtInfo(Bits | NoReturnMask);
3597 else
3598 return ExtInfo(Bits & ~NoReturnMask);
3599 }
3600
3601 ExtInfo withProducesResult(bool producesResult) const {
3602 if (producesResult)
3603 return ExtInfo(Bits | ProducesResultMask);
3604 else
3605 return ExtInfo(Bits & ~ProducesResultMask);
3606 }
3607
3608 ExtInfo withNoCallerSavedRegs(bool noCallerSavedRegs) const {
3609 if (noCallerSavedRegs)
3610 return ExtInfo(Bits | NoCallerSavedRegsMask);
3611 else
3612 return ExtInfo(Bits & ~NoCallerSavedRegsMask);
3613 }
3614
3615 ExtInfo withNoCfCheck(bool noCfCheck) const {
3616 if (noCfCheck)
3617 return ExtInfo(Bits | NoCfCheckMask);
3618 else
3619 return ExtInfo(Bits & ~NoCfCheckMask);
3620 }
3621
3622 ExtInfo withRegParm(unsigned RegParm) const {
3623 assert(RegParm < 7 && "Invalid regparm value")((RegParm < 7 && "Invalid regparm value") ? static_cast
<void> (0) : __assert_fail ("RegParm < 7 && \"Invalid regparm value\""
, "/build/llvm-toolchain-snapshot-10~++20200112100611+7fa5290d5bd/clang/include/clang/AST/Type.h"
, 3623, __PRETTY_FUNCTION__))
;
3624 return ExtInfo((Bits & ~RegParmMask) |
3625 ((RegParm + 1) << RegParmOffset));
3626 }
3627
3628 ExtInfo withCallingConv(CallingConv cc) const {
3629 return ExtInfo((Bits & ~CallConvMask) | (unsigned) cc);
3630 }
3631
3632 void Profile(llvm::FoldingSetNodeID &ID) const {
3633 ID.AddInteger(Bits);
3634 }
3635 };
3636
3637 /// A simple holder for a QualType representing a type in an
3638 /// exception specification. Unfortunately needed by FunctionProtoType
3639 /// because TrailingObjects cannot handle repeated types.
3640 struct ExceptionType { QualType Type; };
3641
3642 /// A simple holder for various uncommon bits which do not fit in
3643 /// FunctionTypeBitfields. Aligned to alignof(void *) to maintain the
3644 /// alignment of subsequent objects in TrailingObjects. You must update
3645 /// hasExtraBitfields in FunctionProtoType after adding extra data here.
3646 struct alignas(void *) FunctionTypeExtraBitfields {
3647 /// The number of types in the exception specification.
3648 /// A whole unsigned is not needed here and according to
3649 /// [implimits] 8 bits would be enough here.
3650 unsigned NumExceptionType;
3651 };
3652
3653protected:
3654 FunctionType(TypeClass tc, QualType res,
3655 QualType Canonical, bool Dependent,
3656 bool InstantiationDependent,
3657 bool VariablyModified, bool ContainsUnexpandedParameterPack,
3658 ExtInfo Info)
3659 : Type(tc, Canonical, Dependent, InstantiationDependent, VariablyModified,
3660 ContainsUnexpandedParameterPack),
3661 ResultType(res) {
3662 FunctionTypeBits.ExtInfo = Info.Bits;
3663 }
3664
3665 Qualifiers getFastTypeQuals() const {
3666 return Qualifiers::fromFastMask(FunctionTypeBits.FastTypeQuals);
3667 }
3668
3669public:
3670 QualType getReturnType() const { return ResultType; }
3671
3672 bool getHasRegParm() const { return getExtInfo().getHasRegParm(); }
3673 unsigned getRegParmType() const { return getExtInfo().getRegParm(); }
3674
3675 /// Determine whether this function type includes the GNU noreturn
3676 /// attribute. The C++11 [[noreturn]] attribute does not affect the function
3677 /// type.
3678 bool getNoReturnAttr() const { return getExtInfo().getNoReturn(); }
3679
3680 CallingConv getCallConv() const { return getExtInfo().getCC(); }
3681 ExtInfo getExtInfo() const { return ExtInfo(FunctionTypeBits.ExtInfo); }
3682
3683 static_assert((~Qualifiers::FastMask & Qualifiers::CVRMask) == 0,
3684 "Const, volatile and restrict are assumed to be a subset of "
3685 "the fast qualifiers.");
3686
3687 bool isConst() const { return getFastTypeQuals().hasConst(); }
3688 bool isVolatile() const { return getFastTypeQuals().hasVolatile(); }
3689 bool isRestrict() const { return getFastTypeQuals().hasRestrict(); }
3690
3691 /// Determine the type of an expression that calls a function of
3692 /// this type.
3693 QualType getCallResultType(const ASTContext &Context) const {
3694 return getReturnType().getNonLValueExprType(Context);
3695 }
3696
3697 static StringRef getNameForCallConv(CallingConv CC);
3698
3699 static bool classof(const Type *T) {
3700 return T->getTypeClass() == FunctionNoProto ||
3701 T->getTypeClass() == FunctionProto;
3702 }
3703};
3704
3705/// Represents a K&R-style 'int foo()' function, which has
3706/// no information available about its arguments.
3707class FunctionNoProtoType : public FunctionType, public llvm::FoldingSetNode {
3708 friend class ASTContext; // ASTContext creates these.
3709
3710 FunctionNoProtoType(QualType Result, QualType Canonical, ExtInfo Info)
3711 : FunctionType(FunctionNoProto, Result, Canonical,
3712 /*Dependent=*/false, /*InstantiationDependent=*/false,
3713 Result->isVariablyModifiedType(),
3714 /*ContainsUnexpandedParameterPack=*/false, Info) {}
3715
3716public:
3717 // No additional state past what FunctionType provides.
3718
3719 bool isSugared() const { return false; }
3720 QualType desugar() const { return QualType(this, 0); }
3721
3722 void Profile(llvm::FoldingSetNodeID &ID) {
3723 Profile(ID, getReturnType(), getExtInfo());
3724 }
3725
3726 static void Profile(llvm::FoldingSetNodeID &ID, QualType ResultType,
3727 ExtInfo Info) {
3728 Info.Profile(ID);
3729 ID.AddPointer(ResultType.getAsOpaquePtr());
3730 }
3731
3732 static bool classof(const Type *T) {
3733 return T->getTypeClass() == FunctionNoProto;
3734 }
3735};
3736
3737/// Represents a prototype with parameter type info, e.g.
3738/// 'int foo(int)' or 'int foo(void)'. 'void' is represented as having no
3739/// parameters, not as having a single void parameter. Such a type can have
3740/// an exception specification, but this specification is not part of the
3741/// canonical type. FunctionProtoType has several trailing objects, some of
3742/// which optional. For more information about the trailing objects see
3743/// the first comment inside FunctionProtoType.
3744class FunctionProtoType final
3745 : public FunctionType,
3746 public llvm::FoldingSetNode,
3747 private llvm::TrailingObjects<
3748 FunctionProtoType, QualType, SourceLocation,
3749 FunctionType::FunctionTypeExtraBitfields, FunctionType::ExceptionType,
3750 Expr *, FunctionDecl *, FunctionType::ExtParameterInfo, Qualifiers> {
3751 friend class ASTContext; // ASTContext creates these.
3752 friend TrailingObjects;
3753
3754 // FunctionProtoType is followed by several trailing objects, some of
3755 // which optional. They are in order:
3756 //
3757 // * An array of getNumParams() QualType holding the parameter types.
3758 // Always present. Note that for the vast majority of FunctionProtoType,
3759 // these will be the only trailing objects.
3760 //
3761 // * Optionally if the function is variadic, the SourceLocation of the
3762 // ellipsis.
3763 //
3764 // * Optionally if some extra data is stored in FunctionTypeExtraBitfields
3765 // (see FunctionTypeExtraBitfields and FunctionTypeBitfields):
3766