Bug Summary

File:tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp
Warning:line 4852, column 26
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 RewriteObjC.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 -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mthread-model posix -mframe-pointer=none -relaxed-aliasing -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -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~svn373517/build-llvm/tools/clang/lib/Frontend/Rewrite -I /build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite -I /build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include -I /build/llvm-toolchain-snapshot-10~svn373517/build-llvm/tools/clang/include -I /build/llvm-toolchain-snapshot-10~svn373517/build-llvm/include -I /build/llvm-toolchain-snapshot-10~svn373517/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~svn373517/build-llvm/tools/clang/lib/Frontend/Rewrite -fdebug-prefix-map=/build/llvm-toolchain-snapshot-10~svn373517=. -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -stack-protector 2 -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-2019-10-02-234743-9763-1 -x c++ /build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp

/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp

1//===--- RewriteObjC.cpp - Playground for the code rewriter ---------------===//
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// Hacks and fun related to the code rewriter.
10//
11//===----------------------------------------------------------------------===//
12
13#include "clang/Rewrite/Frontend/ASTConsumers.h"
14#include "clang/AST/AST.h"
15#include "clang/AST/ASTConsumer.h"
16#include "clang/AST/Attr.h"
17#include "clang/AST/ParentMap.h"
18#include "clang/Basic/CharInfo.h"
19#include "clang/Basic/Diagnostic.h"
20#include "clang/Basic/IdentifierTable.h"
21#include "clang/Basic/SourceManager.h"
22#include "clang/Config/config.h"
23#include "clang/Lex/Lexer.h"
24#include "clang/Rewrite/Core/Rewriter.h"
25#include "llvm/ADT/DenseSet.h"
26#include "llvm/ADT/SmallPtrSet.h"
27#include "llvm/ADT/StringExtras.h"
28#include "llvm/Support/MemoryBuffer.h"
29#include "llvm/Support/raw_ostream.h"
30#include <memory>
31
32#if CLANG_ENABLE_OBJC_REWRITER1
33
34using namespace clang;
35using llvm::utostr;
36
37namespace {
38 class RewriteObjC : public ASTConsumer {
39 protected:
40 enum {
41 BLOCK_FIELD_IS_OBJECT = 3, /* id, NSObject, __attribute__((NSObject)),
42 block, ... */
43 BLOCK_FIELD_IS_BLOCK = 7, /* a block variable */
44 BLOCK_FIELD_IS_BYREF = 8, /* the on stack structure holding the
45 __block variable */
46 BLOCK_FIELD_IS_WEAK = 16, /* declared __weak, only used in byref copy
47 helpers */
48 BLOCK_BYREF_CALLER = 128, /* called from __block (byref) copy/dispose
49 support routines */
50 BLOCK_BYREF_CURRENT_MAX = 256
51 };
52
53 enum {
54 BLOCK_NEEDS_FREE = (1 << 24),
55 BLOCK_HAS_COPY_DISPOSE = (1 << 25),
56 BLOCK_HAS_CXX_OBJ = (1 << 26),
57 BLOCK_IS_GC = (1 << 27),
58 BLOCK_IS_GLOBAL = (1 << 28),
59 BLOCK_HAS_DESCRIPTOR = (1 << 29)
60 };
61 static const int OBJC_ABI_VERSION = 7;
62
63 Rewriter Rewrite;
64 DiagnosticsEngine &Diags;
65 const LangOptions &LangOpts;
66 ASTContext *Context;
67 SourceManager *SM;
68 TranslationUnitDecl *TUDecl;
69 FileID MainFileID;
70 const char *MainFileStart, *MainFileEnd;
71 Stmt *CurrentBody;
72 ParentMap *PropParentMap; // created lazily.
73 std::string InFileName;
74 std::unique_ptr<raw_ostream> OutFile;
75 std::string Preamble;
76
77 TypeDecl *ProtocolTypeDecl;
78 VarDecl *GlobalVarDecl;
79 unsigned RewriteFailedDiag;
80 // ObjC string constant support.
81 unsigned NumObjCStringLiterals;
82 VarDecl *ConstantStringClassReference;
83 RecordDecl *NSStringRecord;
84
85 // ObjC foreach break/continue generation support.
86 int BcLabelCount;
87
88 unsigned TryFinallyContainsReturnDiag;
89 // Needed for super.
90 ObjCMethodDecl *CurMethodDef;
91 RecordDecl *SuperStructDecl;
92 RecordDecl *ConstantStringDecl;
93
94 FunctionDecl *MsgSendFunctionDecl;
95 FunctionDecl *MsgSendSuperFunctionDecl;
96 FunctionDecl *MsgSendStretFunctionDecl;
97 FunctionDecl *MsgSendSuperStretFunctionDecl;
98 FunctionDecl *MsgSendFpretFunctionDecl;
99 FunctionDecl *GetClassFunctionDecl;
100 FunctionDecl *GetMetaClassFunctionDecl;
101 FunctionDecl *GetSuperClassFunctionDecl;
102 FunctionDecl *SelGetUidFunctionDecl;
103 FunctionDecl *CFStringFunctionDecl;
104 FunctionDecl *SuperConstructorFunctionDecl;
105 FunctionDecl *CurFunctionDef;
106 FunctionDecl *CurFunctionDeclToDeclareForBlock;
107
108 /* Misc. containers needed for meta-data rewrite. */
109 SmallVector<ObjCImplementationDecl *, 8> ClassImplementation;
110 SmallVector<ObjCCategoryImplDecl *, 8> CategoryImplementation;
111 llvm::SmallPtrSet<ObjCInterfaceDecl*, 8> ObjCSynthesizedStructs;
112 llvm::SmallPtrSet<ObjCProtocolDecl*, 8> ObjCSynthesizedProtocols;
113 llvm::SmallPtrSet<ObjCInterfaceDecl*, 8> ObjCForwardDecls;
114 llvm::DenseMap<ObjCMethodDecl*, std::string> MethodInternalNames;
115 SmallVector<Stmt *, 32> Stmts;
116 SmallVector<int, 8> ObjCBcLabelNo;
117 // Remember all the @protocol(<expr>) expressions.
118 llvm::SmallPtrSet<ObjCProtocolDecl *, 32> ProtocolExprDecls;
119
120 llvm::DenseSet<uint64_t> CopyDestroyCache;
121
122 // Block expressions.
123 SmallVector<BlockExpr *, 32> Blocks;
124 SmallVector<int, 32> InnerDeclRefsCount;
125 SmallVector<DeclRefExpr *, 32> InnerDeclRefs;
126
127 SmallVector<DeclRefExpr *, 32> BlockDeclRefs;
128
129 // Block related declarations.
130 SmallVector<ValueDecl *, 8> BlockByCopyDecls;
131 llvm::SmallPtrSet<ValueDecl *, 8> BlockByCopyDeclsPtrSet;
132 SmallVector<ValueDecl *, 8> BlockByRefDecls;
133 llvm::SmallPtrSet<ValueDecl *, 8> BlockByRefDeclsPtrSet;
134 llvm::DenseMap<ValueDecl *, unsigned> BlockByRefDeclNo;
135 llvm::SmallPtrSet<ValueDecl *, 8> ImportedBlockDecls;
136 llvm::SmallPtrSet<VarDecl *, 8> ImportedLocalExternalDecls;
137
138 llvm::DenseMap<BlockExpr *, std::string> RewrittenBlockExprs;
139
140 // This maps an original source AST to it's rewritten form. This allows
141 // us to avoid rewriting the same node twice (which is very uncommon).
142 // This is needed to support some of the exotic property rewriting.
143 llvm::DenseMap<Stmt *, Stmt *> ReplacedNodes;
144
145 // Needed for header files being rewritten
146 bool IsHeader;
147 bool SilenceRewriteMacroWarning;
148 bool objc_impl_method;
149
150 bool DisableReplaceStmt;
151 class DisableReplaceStmtScope {
152 RewriteObjC &R;
153 bool SavedValue;
154
155 public:
156 DisableReplaceStmtScope(RewriteObjC &R)
157 : R(R), SavedValue(R.DisableReplaceStmt) {
158 R.DisableReplaceStmt = true;
159 }
160
161 ~DisableReplaceStmtScope() {
162 R.DisableReplaceStmt = SavedValue;
163 }
164 };
165
166 void InitializeCommon(ASTContext &context);
167
168 public:
169 // Top Level Driver code.
170 bool HandleTopLevelDecl(DeclGroupRef D) override {
171 for (DeclGroupRef::iterator I = D.begin(), E = D.end(); I != E; ++I) {
1
Assuming 'I' is not equal to 'E'
2
Loop condition is true. Entering loop body
172 if (ObjCInterfaceDecl *Class
3.1
'Class' is null
3.1
'Class' is null
= dyn_cast<ObjCInterfaceDecl>(*I)) {
3
Assuming the object is not a 'ObjCInterfaceDecl'
4
Taking false branch
173 if (!Class->isThisDeclarationADefinition()) {
174 RewriteForwardClassDecl(D);
175 break;
176 }
177 }
178
179 if (ObjCProtocolDecl *Proto
5.1
'Proto' is null
5.1
'Proto' is null
= dyn_cast<ObjCProtocolDecl>(*I)) {
5
Assuming the object is not a 'ObjCProtocolDecl'
6
Taking false branch
180 if (!Proto->isThisDeclarationADefinition()) {
181 RewriteForwardProtocolDecl(D);
182 break;
183 }
184 }
185
186 HandleTopLevelSingleDecl(*I);
7
Calling 'RewriteObjC::HandleTopLevelSingleDecl'
187 }
188 return true;
189 }
190
191 void HandleTopLevelSingleDecl(Decl *D);
192 void HandleDeclInMainFile(Decl *D);
193 RewriteObjC(std::string inFile, std::unique_ptr<raw_ostream> OS,
194 DiagnosticsEngine &D, const LangOptions &LOpts,
195 bool silenceMacroWarn);
196
197 ~RewriteObjC() override {}
198
199 void HandleTranslationUnit(ASTContext &C) override;
200
201 void ReplaceStmt(Stmt *Old, Stmt *New) {
202 ReplaceStmtWithRange(Old, New, Old->getSourceRange());
203 }
204
205 void ReplaceStmtWithRange(Stmt *Old, Stmt *New, SourceRange SrcRange) {
206 assert(Old != nullptr && New != nullptr && "Expected non-null Stmt's")((Old != nullptr && New != nullptr && "Expected non-null Stmt's"
) ? static_cast<void> (0) : __assert_fail ("Old != nullptr && New != nullptr && \"Expected non-null Stmt's\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 206, __PRETTY_FUNCTION__))
;
207
208 Stmt *ReplacingStmt = ReplacedNodes[Old];
209 if (ReplacingStmt)
210 return; // We can't rewrite the same node twice.
211
212 if (DisableReplaceStmt)
213 return;
214
215 // Measure the old text.
216 int Size = Rewrite.getRangeSize(SrcRange);
217 if (Size == -1) {
218 Diags.Report(Context->getFullLoc(Old->getBeginLoc()), RewriteFailedDiag)
219 << Old->getSourceRange();
220 return;
221 }
222 // Get the new text.
223 std::string SStr;
224 llvm::raw_string_ostream S(SStr);
225 New->printPretty(S, nullptr, PrintingPolicy(LangOpts));
226 const std::string &Str = S.str();
227
228 // If replacement succeeded or warning disabled return with no warning.
229 if (!Rewrite.ReplaceText(SrcRange.getBegin(), Size, Str)) {
230 ReplacedNodes[Old] = New;
231 return;
232 }
233 if (SilenceRewriteMacroWarning)
234 return;
235 Diags.Report(Context->getFullLoc(Old->getBeginLoc()), RewriteFailedDiag)
236 << Old->getSourceRange();
237 }
238
239 void InsertText(SourceLocation Loc, StringRef Str,
240 bool InsertAfter = true) {
241 // If insertion succeeded or warning disabled return with no warning.
242 if (!Rewrite.InsertText(Loc, Str, InsertAfter) ||
243 SilenceRewriteMacroWarning)
244 return;
245
246 Diags.Report(Context->getFullLoc(Loc), RewriteFailedDiag);
247 }
248
249 void ReplaceText(SourceLocation Start, unsigned OrigLength,
250 StringRef Str) {
251 // If removal succeeded or warning disabled return with no warning.
252 if (!Rewrite.ReplaceText(Start, OrigLength, Str) ||
253 SilenceRewriteMacroWarning)
254 return;
255
256 Diags.Report(Context->getFullLoc(Start), RewriteFailedDiag);
257 }
258
259 // Syntactic Rewriting.
260 void RewriteRecordBody(RecordDecl *RD);
261 void RewriteInclude();
262 void RewriteForwardClassDecl(DeclGroupRef D);
263 void RewriteForwardClassDecl(const SmallVectorImpl<Decl *> &DG);
264 void RewriteForwardClassEpilogue(ObjCInterfaceDecl *ClassDecl,
265 const std::string &typedefString);
266 void RewriteImplementations();
267 void RewritePropertyImplDecl(ObjCPropertyImplDecl *PID,
268 ObjCImplementationDecl *IMD,
269 ObjCCategoryImplDecl *CID);
270 void RewriteInterfaceDecl(ObjCInterfaceDecl *Dcl);
271 void RewriteImplementationDecl(Decl *Dcl);
272 void RewriteObjCMethodDecl(const ObjCInterfaceDecl *IDecl,
273 ObjCMethodDecl *MDecl, std::string &ResultStr);
274 void RewriteTypeIntoString(QualType T, std::string &ResultStr,
275 const FunctionType *&FPRetType);
276 void RewriteByRefString(std::string &ResultStr, const std::string &Name,
277 ValueDecl *VD, bool def=false);
278 void RewriteCategoryDecl(ObjCCategoryDecl *Dcl);
279 void RewriteProtocolDecl(ObjCProtocolDecl *Dcl);
280 void RewriteForwardProtocolDecl(DeclGroupRef D);
281 void RewriteForwardProtocolDecl(const SmallVectorImpl<Decl *> &DG);
282 void RewriteMethodDeclaration(ObjCMethodDecl *Method);
283 void RewriteProperty(ObjCPropertyDecl *prop);
284 void RewriteFunctionDecl(FunctionDecl *FD);
285 void RewriteBlockPointerType(std::string& Str, QualType Type);
286 void RewriteBlockPointerTypeVariable(std::string& Str, ValueDecl *VD);
287 void RewriteBlockLiteralFunctionDecl(FunctionDecl *FD);
288 void RewriteObjCQualifiedInterfaceTypes(Decl *Dcl);
289 void RewriteTypeOfDecl(VarDecl *VD);
290 void RewriteObjCQualifiedInterfaceTypes(Expr *E);
291
292 // Expression Rewriting.
293 Stmt *RewriteFunctionBodyOrGlobalInitializer(Stmt *S);
294 Stmt *RewriteAtEncode(ObjCEncodeExpr *Exp);
295 Stmt *RewritePropertyOrImplicitGetter(PseudoObjectExpr *Pseudo);
296 Stmt *RewritePropertyOrImplicitSetter(PseudoObjectExpr *Pseudo);
297 Stmt *RewriteAtSelector(ObjCSelectorExpr *Exp);
298 Stmt *RewriteMessageExpr(ObjCMessageExpr *Exp);
299 Stmt *RewriteObjCStringLiteral(ObjCStringLiteral *Exp);
300 Stmt *RewriteObjCProtocolExpr(ObjCProtocolExpr *Exp);
301 void RewriteTryReturnStmts(Stmt *S);
302 void RewriteSyncReturnStmts(Stmt *S, std::string buf);
303 Stmt *RewriteObjCTryStmt(ObjCAtTryStmt *S);
304 Stmt *RewriteObjCSynchronizedStmt(ObjCAtSynchronizedStmt *S);
305 Stmt *RewriteObjCThrowStmt(ObjCAtThrowStmt *S);
306 Stmt *RewriteObjCForCollectionStmt(ObjCForCollectionStmt *S,
307 SourceLocation OrigEnd);
308 Stmt *RewriteBreakStmt(BreakStmt *S);
309 Stmt *RewriteContinueStmt(ContinueStmt *S);
310 void RewriteCastExpr(CStyleCastExpr *CE);
311
312 // Block rewriting.
313 void RewriteBlocksInFunctionProtoType(QualType funcType, NamedDecl *D);
314
315 // Block specific rewrite rules.
316 void RewriteBlockPointerDecl(NamedDecl *VD);
317 void RewriteByRefVar(VarDecl *VD);
318 Stmt *RewriteBlockDeclRefExpr(DeclRefExpr *VD);
319 Stmt *RewriteLocalVariableExternalStorage(DeclRefExpr *DRE);
320 void RewriteBlockPointerFunctionArgs(FunctionDecl *FD);
321
322 void RewriteObjCInternalStruct(ObjCInterfaceDecl *CDecl,
323 std::string &Result);
324
325 void Initialize(ASTContext &context) override = 0;
326
327 // Metadata Rewriting.
328 virtual void RewriteMetaDataIntoBuffer(std::string &Result) = 0;
329 virtual void RewriteObjCProtocolListMetaData(const ObjCList<ObjCProtocolDecl> &Prots,
330 StringRef prefix,
331 StringRef ClassName,
332 std::string &Result) = 0;
333 virtual void RewriteObjCCategoryImplDecl(ObjCCategoryImplDecl *CDecl,
334 std::string &Result) = 0;
335 virtual void RewriteObjCProtocolMetaData(ObjCProtocolDecl *Protocol,
336 StringRef prefix,
337 StringRef ClassName,
338 std::string &Result) = 0;
339 virtual void RewriteObjCClassMetaData(ObjCImplementationDecl *IDecl,
340 std::string &Result) = 0;
341
342 // Rewriting ivar access
343 virtual Stmt *RewriteObjCIvarRefExpr(ObjCIvarRefExpr *IV) = 0;
344 virtual void RewriteIvarOffsetComputation(ObjCIvarDecl *ivar,
345 std::string &Result) = 0;
346
347 // Misc. AST transformation routines. Sometimes they end up calling
348 // rewriting routines on the new ASTs.
349 CallExpr *SynthesizeCallToFunctionDecl(FunctionDecl *FD,
350 ArrayRef<Expr *> Args,
351 SourceLocation StartLoc=SourceLocation(),
352 SourceLocation EndLoc=SourceLocation());
353 CallExpr *SynthMsgSendStretCallExpr(FunctionDecl *MsgSendStretFlavor,
354 QualType msgSendType,
355 QualType returnType,
356 SmallVectorImpl<QualType> &ArgTypes,
357 SmallVectorImpl<Expr*> &MsgExprs,
358 ObjCMethodDecl *Method);
359 Stmt *SynthMessageExpr(ObjCMessageExpr *Exp,
360 SourceLocation StartLoc=SourceLocation(),
361 SourceLocation EndLoc=SourceLocation());
362
363 void SynthCountByEnumWithState(std::string &buf);
364 void SynthMsgSendFunctionDecl();
365 void SynthMsgSendSuperFunctionDecl();
366 void SynthMsgSendStretFunctionDecl();
367 void SynthMsgSendFpretFunctionDecl();
368 void SynthMsgSendSuperStretFunctionDecl();
369 void SynthGetClassFunctionDecl();
370 void SynthGetMetaClassFunctionDecl();
371 void SynthGetSuperClassFunctionDecl();
372 void SynthSelGetUidFunctionDecl();
373 void SynthSuperConstructorFunctionDecl();
374
375 std::string SynthesizeByrefCopyDestroyHelper(VarDecl *VD, int flag);
376 std::string SynthesizeBlockHelperFuncs(BlockExpr *CE, int i,
377 StringRef funcName, std::string Tag);
378 std::string SynthesizeBlockFunc(BlockExpr *CE, int i,
379 StringRef funcName, std::string Tag);
380 std::string SynthesizeBlockImpl(BlockExpr *CE,
381 std::string Tag, std::string Desc);
382 std::string SynthesizeBlockDescriptor(std::string DescTag,
383 std::string ImplTag,
384 int i, StringRef funcName,
385 unsigned hasCopy);
386 Stmt *SynthesizeBlockCall(CallExpr *Exp, const Expr* BlockExp);
387 void SynthesizeBlockLiterals(SourceLocation FunLocStart,
388 StringRef FunName);
389 FunctionDecl *SynthBlockInitFunctionDecl(StringRef name);
390 Stmt *SynthBlockInitExpr(BlockExpr *Exp,
391 const SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs);
392
393 // Misc. helper routines.
394 QualType getProtocolType();
395 void WarnAboutReturnGotoStmts(Stmt *S);
396 void HasReturnStmts(Stmt *S, bool &hasReturns);
397 void CheckFunctionPointerDecl(QualType dType, NamedDecl *ND);
398 void InsertBlockLiteralsWithinFunction(FunctionDecl *FD);
399 void InsertBlockLiteralsWithinMethod(ObjCMethodDecl *MD);
400
401 bool IsDeclStmtInForeachHeader(DeclStmt *DS);
402 void CollectBlockDeclRefInfo(BlockExpr *Exp);
403 void GetBlockDeclRefExprs(Stmt *S);
404 void GetInnerBlockDeclRefExprs(Stmt *S,
405 SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs,
406 llvm::SmallPtrSetImpl<const DeclContext *> &InnerContexts);
407
408 // We avoid calling Type::isBlockPointerType(), since it operates on the
409 // canonical type. We only care if the top-level type is a closure pointer.
410 bool isTopLevelBlockPointerType(QualType T) {
411 return isa<BlockPointerType>(T);
68
Assuming 'T' is not a 'BlockPointerType'
69
Returning zero, which participates in a condition later
412 }
413
414 /// convertBlockPointerToFunctionPointer - Converts a block-pointer type
415 /// to a function pointer type and upon success, returns true; false
416 /// otherwise.
417 bool convertBlockPointerToFunctionPointer(QualType &T) {
418 if (isTopLevelBlockPointerType(T)) {
419 const BlockPointerType *BPT = T->getAs<BlockPointerType>();
420 T = Context->getPointerType(BPT->getPointeeType());
421 return true;
422 }
423 return false;
424 }
425
426 bool needToScanForQualifiers(QualType T);
427 QualType getSuperStructType();
428 QualType getConstantStringStructType();
429 QualType convertFunctionTypeOfBlocks(const FunctionType *FT);
430 bool BufferContainsPPDirectives(const char *startBuf, const char *endBuf);
431
432 void convertToUnqualifiedObjCType(QualType &T) {
433 if (T->isObjCQualifiedIdType())
434 T = Context->getObjCIdType();
435 else if (T->isObjCQualifiedClassType())
436 T = Context->getObjCClassType();
437 else if (T->isObjCObjectPointerType() &&
438 T->getPointeeType()->isObjCQualifiedInterfaceType()) {
439 if (const ObjCObjectPointerType * OBJPT =
440 T->getAsObjCInterfacePointerType()) {
441 const ObjCInterfaceType *IFaceT = OBJPT->getInterfaceType();
442 T = QualType(IFaceT, 0);
443 T = Context->getPointerType(T);
444 }
445 }
446 }
447
448 // FIXME: This predicate seems like it would be useful to add to ASTContext.
449 bool isObjCType(QualType T) {
450 if (!LangOpts.ObjC)
451 return false;
452
453 QualType OCT = Context->getCanonicalType(T).getUnqualifiedType();
454
455 if (OCT == Context->getCanonicalType(Context->getObjCIdType()) ||
456 OCT == Context->getCanonicalType(Context->getObjCClassType()))
457 return true;
458
459 if (const PointerType *PT = OCT->getAs<PointerType>()) {
460 if (isa<ObjCInterfaceType>(PT->getPointeeType()) ||
461 PT->getPointeeType()->isObjCQualifiedIdType())
462 return true;
463 }
464 return false;
465 }
466 bool PointerTypeTakesAnyBlockArguments(QualType QT);
467 bool PointerTypeTakesAnyObjCQualifiedType(QualType QT);
468 void GetExtentOfArgList(const char *Name, const char *&LParen,
469 const char *&RParen);
470
471 void QuoteDoublequotes(std::string &From, std::string &To) {
472 for (unsigned i = 0; i < From.length(); i++) {
473 if (From[i] == '"')
474 To += "\\\"";
475 else
476 To += From[i];
477 }
478 }
479
480 QualType getSimpleFunctionType(QualType result,
481 ArrayRef<QualType> args,
482 bool variadic = false) {
483 if (result == Context->getObjCInstanceType())
484 result = Context->getObjCIdType();
485 FunctionProtoType::ExtProtoInfo fpi;
486 fpi.Variadic = variadic;
487 return Context->getFunctionType(result, args, fpi);
488 }
489
490 // Helper function: create a CStyleCastExpr with trivial type source info.
491 CStyleCastExpr* NoTypeInfoCStyleCastExpr(ASTContext *Ctx, QualType Ty,
492 CastKind Kind, Expr *E) {
493 TypeSourceInfo *TInfo = Ctx->getTrivialTypeSourceInfo(Ty, SourceLocation());
494 return CStyleCastExpr::Create(*Ctx, Ty, VK_RValue, Kind, E, nullptr,
495 TInfo, SourceLocation(), SourceLocation());
496 }
497
498 StringLiteral *getStringLiteral(StringRef Str) {
499 QualType StrType = Context->getConstantArrayType(
500 Context->CharTy, llvm::APInt(32, Str.size() + 1), ArrayType::Normal,
501 0);
502 return StringLiteral::Create(*Context, Str, StringLiteral::Ascii,
503 /*Pascal=*/false, StrType, SourceLocation());
504 }
505 };
506
507 class RewriteObjCFragileABI : public RewriteObjC {
508 public:
509 RewriteObjCFragileABI(std::string inFile, std::unique_ptr<raw_ostream> OS,
510 DiagnosticsEngine &D, const LangOptions &LOpts,
511 bool silenceMacroWarn)
512 : RewriteObjC(inFile, std::move(OS), D, LOpts, silenceMacroWarn) {}
513
514 ~RewriteObjCFragileABI() override {}
515 void Initialize(ASTContext &context) override;
516
517 // Rewriting metadata
518 template<typename MethodIterator>
519 void RewriteObjCMethodsMetaData(MethodIterator MethodBegin,
520 MethodIterator MethodEnd,
521 bool IsInstanceMethod,
522 StringRef prefix,
523 StringRef ClassName,
524 std::string &Result);
525 void RewriteObjCProtocolMetaData(ObjCProtocolDecl *Protocol,
526 StringRef prefix, StringRef ClassName,
527 std::string &Result) override;
528 void RewriteObjCProtocolListMetaData(
529 const ObjCList<ObjCProtocolDecl> &Prots,
530 StringRef prefix, StringRef ClassName, std::string &Result) override;
531 void RewriteObjCClassMetaData(ObjCImplementationDecl *IDecl,
532 std::string &Result) override;
533 void RewriteMetaDataIntoBuffer(std::string &Result) override;
534 void RewriteObjCCategoryImplDecl(ObjCCategoryImplDecl *CDecl,
535 std::string &Result) override;
536
537 // Rewriting ivar
538 void RewriteIvarOffsetComputation(ObjCIvarDecl *ivar,
539 std::string &Result) override;
540 Stmt *RewriteObjCIvarRefExpr(ObjCIvarRefExpr *IV) override;
541 };
542} // end anonymous namespace
543
544void RewriteObjC::RewriteBlocksInFunctionProtoType(QualType funcType,
545 NamedDecl *D) {
546 if (const FunctionProtoType *fproto
547 = dyn_cast<FunctionProtoType>(funcType.IgnoreParens())) {
548 for (const auto &I : fproto->param_types())
549 if (isTopLevelBlockPointerType(I)) {
550 // All the args are checked/rewritten. Don't call twice!
551 RewriteBlockPointerDecl(D);
552 break;
553 }
554 }
555}
556
557void RewriteObjC::CheckFunctionPointerDecl(QualType funcType, NamedDecl *ND) {
558 const PointerType *PT = funcType->getAs<PointerType>();
559 if (PT && PointerTypeTakesAnyBlockArguments(funcType))
560 RewriteBlocksInFunctionProtoType(PT->getPointeeType(), ND);
561}
562
563static bool IsHeaderFile(const std::string &Filename) {
564 std::string::size_type DotPos = Filename.rfind('.');
565
566 if (DotPos == std::string::npos) {
567 // no file extension
568 return false;
569 }
570
571 std::string Ext = std::string(Filename.begin()+DotPos+1, Filename.end());
572 // C header: .h
573 // C++ header: .hh or .H;
574 return Ext == "h" || Ext == "hh" || Ext == "H";
575}
576
577RewriteObjC::RewriteObjC(std::string inFile, std::unique_ptr<raw_ostream> OS,
578 DiagnosticsEngine &D, const LangOptions &LOpts,
579 bool silenceMacroWarn)
580 : Diags(D), LangOpts(LOpts), InFileName(inFile), OutFile(std::move(OS)),
581 SilenceRewriteMacroWarning(silenceMacroWarn) {
582 IsHeader = IsHeaderFile(inFile);
583 RewriteFailedDiag = Diags.getCustomDiagID(DiagnosticsEngine::Warning,
584 "rewriting sub-expression within a macro (may not be correct)");
585 TryFinallyContainsReturnDiag = Diags.getCustomDiagID(
586 DiagnosticsEngine::Warning,
587 "rewriter doesn't support user-specified control flow semantics "
588 "for @try/@finally (code may not execute properly)");
589}
590
591std::unique_ptr<ASTConsumer>
592clang::CreateObjCRewriter(const std::string &InFile,
593 std::unique_ptr<raw_ostream> OS,
594 DiagnosticsEngine &Diags, const LangOptions &LOpts,
595 bool SilenceRewriteMacroWarning) {
596 return std::make_unique<RewriteObjCFragileABI>(
597 InFile, std::move(OS), Diags, LOpts, SilenceRewriteMacroWarning);
598}
599
600void RewriteObjC::InitializeCommon(ASTContext &context) {
601 Context = &context;
602 SM = &Context->getSourceManager();
603 TUDecl = Context->getTranslationUnitDecl();
604 MsgSendFunctionDecl = nullptr;
605 MsgSendSuperFunctionDecl = nullptr;
606 MsgSendStretFunctionDecl = nullptr;
607 MsgSendSuperStretFunctionDecl = nullptr;
608 MsgSendFpretFunctionDecl = nullptr;
609 GetClassFunctionDecl = nullptr;
610 GetMetaClassFunctionDecl = nullptr;
611 GetSuperClassFunctionDecl = nullptr;
612 SelGetUidFunctionDecl = nullptr;
613 CFStringFunctionDecl = nullptr;
614 ConstantStringClassReference = nullptr;
615 NSStringRecord = nullptr;
616 CurMethodDef = nullptr;
617 CurFunctionDef = nullptr;
618 CurFunctionDeclToDeclareForBlock = nullptr;
619 GlobalVarDecl = nullptr;
620 SuperStructDecl = nullptr;
621 ProtocolTypeDecl = nullptr;
622 ConstantStringDecl = nullptr;
623 BcLabelCount = 0;
624 SuperConstructorFunctionDecl = nullptr;
625 NumObjCStringLiterals = 0;
626 PropParentMap = nullptr;
627 CurrentBody = nullptr;
628 DisableReplaceStmt = false;
629 objc_impl_method = false;
630
631 // Get the ID and start/end of the main file.
632 MainFileID = SM->getMainFileID();
633 const llvm::MemoryBuffer *MainBuf = SM->getBuffer(MainFileID);
634 MainFileStart = MainBuf->getBufferStart();
635 MainFileEnd = MainBuf->getBufferEnd();
636
637 Rewrite.setSourceMgr(Context->getSourceManager(), Context->getLangOpts());
638}
639
640//===----------------------------------------------------------------------===//
641// Top Level Driver Code
642//===----------------------------------------------------------------------===//
643
644void RewriteObjC::HandleTopLevelSingleDecl(Decl *D) {
645 if (Diags.hasErrorOccurred())
8
Assuming the condition is false
9
Taking false branch
29
Taking false branch
49
Taking false branch
646 return;
647
648 // Two cases: either the decl could be in the main file, or it could be in a
649 // #included file. If the former, rewrite it now. If the later, check to see
650 // if we rewrote the #include/#import.
651 SourceLocation Loc = D->getLocation();
652 Loc = SM->getExpansionLoc(Loc);
653
654 // If this is for a builtin, ignore it.
655 if (Loc.isInvalid()) return;
10
Taking false branch
30
Taking false branch
50
Taking false branch
656
657 // Look for built-in declarations that we need to refer during the rewrite.
658 if (FunctionDecl *FD
11.1
'FD' is null
31.1
'FD' is null
51.1
'FD' is null
11.1
'FD' is null
31.1
'FD' is null
51.1
'FD' is null
= dyn_cast<FunctionDecl>(D)) {
11
Assuming 'D' is not a 'FunctionDecl'
12
Taking false branch
31
Assuming 'D' is not a 'FunctionDecl'
32
Taking false branch
51
Assuming 'D' is not a 'FunctionDecl'
52
Taking false branch
659 RewriteFunctionDecl(FD);
660 } else if (VarDecl *FVD
13.1
'FVD' is null
33.1
'FVD' is null
53.1
'FVD' is null
13.1
'FVD' is null
33.1
'FVD' is null
53.1
'FVD' is null
= dyn_cast<VarDecl>(D)) {
13
Assuming 'D' is not a 'VarDecl'
14
Taking false branch
33
Assuming 'D' is not a 'VarDecl'
34
Taking false branch
53
Assuming 'D' is not a 'VarDecl'
54
Taking false branch
661 // declared in <Foundation/NSString.h>
662 if (FVD->getName() == "_NSConstantStringClassReference") {
663 ConstantStringClassReference = FVD;
664 return;
665 }
666 } else if (ObjCInterfaceDecl *ID
15.1
'ID' is null
35.1
'ID' is null
55.1
'ID' is null
15.1
'ID' is null
35.1
'ID' is null
55.1
'ID' is null
= dyn_cast<ObjCInterfaceDecl>(D)) {
15
'D' is not a 'ObjCInterfaceDecl'
16
Taking false branch
35
Assuming 'D' is not a 'ObjCInterfaceDecl'
36
Taking false branch
55
Assuming 'D' is not a 'ObjCInterfaceDecl'
56
Taking false branch
667 if (ID->isThisDeclarationADefinition())
668 RewriteInterfaceDecl(ID);
669 } else if (ObjCCategoryDecl *CD
17.1
'CD' is null
37.1
'CD' is null
57.1
'CD' is null
17.1
'CD' is null
37.1
'CD' is null
57.1
'CD' is null
= dyn_cast<ObjCCategoryDecl>(D)) {
17
Assuming 'D' is not a 'ObjCCategoryDecl'
18
Taking false branch
37
Assuming 'D' is not a 'ObjCCategoryDecl'
38
Taking false branch
57
Assuming 'D' is not a 'ObjCCategoryDecl'
58
Taking false branch
670 RewriteCategoryDecl(CD);
671 } else if (ObjCProtocolDecl *PD
19.1
'PD' is null
39.1
'PD' is null
59.1
'PD' is null
19.1
'PD' is null
39.1
'PD' is null
59.1
'PD' is null
= dyn_cast<ObjCProtocolDecl>(D)) {
19
'D' is not a 'ObjCProtocolDecl'
20
Taking false branch
39
Assuming 'D' is not a 'ObjCProtocolDecl'
40
Taking false branch
59
Assuming 'D' is not a 'ObjCProtocolDecl'
60
Taking false branch
672 if (PD->isThisDeclarationADefinition())
673 RewriteProtocolDecl(PD);
674 } else if (LinkageSpecDecl *LSD
21.1
'LSD' is non-null
41.1
'LSD' is non-null
61.1
'LSD' is null
21.1
'LSD' is non-null
41.1
'LSD' is non-null
61.1
'LSD' is null
= dyn_cast<LinkageSpecDecl>(D)) {
21
Assuming 'D' is a 'LinkageSpecDecl'
22
Taking true branch
41
Assuming 'D' is a 'LinkageSpecDecl'
42
Taking true branch
61
Assuming 'D' is not a 'LinkageSpecDecl'
62
Taking false branch
675 // Recurse into linkage specifications
676 for (DeclContext::decl_iterator DI = LSD->decls_begin(),
23
Loop condition is true. Entering loop body
43
Loop condition is true. Entering loop body
677 DIEnd = LSD->decls_end();
678 DI != DIEnd; ) {
679 if (ObjCInterfaceDecl *IFace
24.1
'IFace' is null
44.1
'IFace' is null
24.1
'IFace' is null
44.1
'IFace' is null
= dyn_cast<ObjCInterfaceDecl>((*DI))) {
24
Assuming the object is not a 'ObjCInterfaceDecl'
25
Taking false branch
44
Assuming the object is not a 'ObjCInterfaceDecl'
45
Taking false branch
680 if (!IFace->isThisDeclarationADefinition()) {
681 SmallVector<Decl *, 8> DG;
682 SourceLocation StartLoc = IFace->getBeginLoc();
683 do {
684 if (isa<ObjCInterfaceDecl>(*DI) &&
685 !cast<ObjCInterfaceDecl>(*DI)->isThisDeclarationADefinition() &&
686 StartLoc == (*DI)->getBeginLoc())
687 DG.push_back(*DI);
688 else
689 break;
690
691 ++DI;
692 } while (DI != DIEnd);
693 RewriteForwardClassDecl(DG);
694 continue;
695 }
696 }
697
698 if (ObjCProtocolDecl *Proto
26.1
'Proto' is null
46.1
'Proto' is null
26.1
'Proto' is null
46.1
'Proto' is null
= dyn_cast<ObjCProtocolDecl>((*DI))) {
26
Assuming the object is not a 'ObjCProtocolDecl'
27
Taking false branch
46
Assuming the object is not a 'ObjCProtocolDecl'
47
Taking false branch
699 if (!Proto->isThisDeclarationADefinition()) {
700 SmallVector<Decl *, 8> DG;
701 SourceLocation StartLoc = Proto->getBeginLoc();
702 do {
703 if (isa<ObjCProtocolDecl>(*DI) &&
704 !cast<ObjCProtocolDecl>(*DI)->isThisDeclarationADefinition() &&
705 StartLoc == (*DI)->getBeginLoc())
706 DG.push_back(*DI);
707 else
708 break;
709
710 ++DI;
711 } while (DI != DIEnd);
712 RewriteForwardProtocolDecl(DG);
713 continue;
714 }
715 }
716
717 HandleTopLevelSingleDecl(*DI);
28
Calling 'RewriteObjC::HandleTopLevelSingleDecl'
48
Calling 'RewriteObjC::HandleTopLevelSingleDecl'
718 ++DI;
719 }
720 }
721 // If we have a decl in the main file, see if we should rewrite it.
722 if (SM->isWrittenInMainFile(Loc))
63
Taking true branch
723 return HandleDeclInMainFile(D);
64
Calling 'RewriteObjC::HandleDeclInMainFile'
724}
725
726//===----------------------------------------------------------------------===//
727// Syntactic (non-AST) Rewriting Code
728//===----------------------------------------------------------------------===//
729
730void RewriteObjC::RewriteInclude() {
731 SourceLocation LocStart = SM->getLocForStartOfFile(MainFileID);
732 StringRef MainBuf = SM->getBufferData(MainFileID);
733 const char *MainBufStart = MainBuf.begin();
734 const char *MainBufEnd = MainBuf.end();
735 size_t ImportLen = strlen("import");
736
737 // Loop over the whole file, looking for includes.
738 for (const char *BufPtr = MainBufStart; BufPtr < MainBufEnd; ++BufPtr) {
739 if (*BufPtr == '#') {
740 if (++BufPtr == MainBufEnd)
741 return;
742 while (*BufPtr == ' ' || *BufPtr == '\t')
743 if (++BufPtr == MainBufEnd)
744 return;
745 if (!strncmp(BufPtr, "import", ImportLen)) {
746 // replace import with include
747 SourceLocation ImportLoc =
748 LocStart.getLocWithOffset(BufPtr-MainBufStart);
749 ReplaceText(ImportLoc, ImportLen, "include");
750 BufPtr += ImportLen;
751 }
752 }
753 }
754}
755
756static std::string getIvarAccessString(ObjCIvarDecl *OID) {
757 const ObjCInterfaceDecl *ClassDecl = OID->getContainingInterface();
758 std::string S;
759 S = "((struct ";
760 S += ClassDecl->getIdentifier()->getName();
761 S += "_IMPL *)self)->";
762 S += OID->getName();
763 return S;
764}
765
766void RewriteObjC::RewritePropertyImplDecl(ObjCPropertyImplDecl *PID,
767 ObjCImplementationDecl *IMD,
768 ObjCCategoryImplDecl *CID) {
769 static bool objcGetPropertyDefined = false;
770 static bool objcSetPropertyDefined = false;
771 SourceLocation startLoc = PID->getBeginLoc();
772 InsertText(startLoc, "// ");
773 const char *startBuf = SM->getCharacterData(startLoc);
774 assert((*startBuf == '@') && "bogus @synthesize location")(((*startBuf == '@') && "bogus @synthesize location")
? static_cast<void> (0) : __assert_fail ("(*startBuf == '@') && \"bogus @synthesize location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 774, __PRETTY_FUNCTION__))
;
775 const char *semiBuf = strchr(startBuf, ';');
776 assert((*semiBuf == ';') && "@synthesize: can't find ';'")(((*semiBuf == ';') && "@synthesize: can't find ';'")
? static_cast<void> (0) : __assert_fail ("(*semiBuf == ';') && \"@synthesize: can't find ';'\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 776, __PRETTY_FUNCTION__))
;
777 SourceLocation onePastSemiLoc =
778 startLoc.getLocWithOffset(semiBuf-startBuf+1);
779
780 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic)
781 return; // FIXME: is this correct?
782
783 // Generate the 'getter' function.
784 ObjCPropertyDecl *PD = PID->getPropertyDecl();
785 ObjCIvarDecl *OID = PID->getPropertyIvarDecl();
786
787 if (!OID)
788 return;
789 unsigned Attributes = PD->getPropertyAttributes();
790 if (!PD->getGetterMethodDecl()->isDefined()) {
791 bool GenGetProperty = !(Attributes & ObjCPropertyDecl::OBJC_PR_nonatomic) &&
792 (Attributes & (ObjCPropertyDecl::OBJC_PR_retain |
793 ObjCPropertyDecl::OBJC_PR_copy));
794 std::string Getr;
795 if (GenGetProperty && !objcGetPropertyDefined) {
796 objcGetPropertyDefined = true;
797 // FIXME. Is this attribute correct in all cases?
798 Getr = "\nextern \"C\" __declspec(dllimport) "
799 "id objc_getProperty(id, SEL, long, bool);\n";
800 }
801 RewriteObjCMethodDecl(OID->getContainingInterface(),
802 PD->getGetterMethodDecl(), Getr);
803 Getr += "{ ";
804 // Synthesize an explicit cast to gain access to the ivar.
805 // See objc-act.c:objc_synthesize_new_getter() for details.
806 if (GenGetProperty) {
807 // return objc_getProperty(self, _cmd, offsetof(ClassDecl, OID), 1)
808 Getr += "typedef ";
809 const FunctionType *FPRetType = nullptr;
810 RewriteTypeIntoString(PD->getGetterMethodDecl()->getReturnType(), Getr,
811 FPRetType);
812 Getr += " _TYPE";
813 if (FPRetType) {
814 Getr += ")"; // close the precedence "scope" for "*".
815
816 // Now, emit the argument types (if any).
817 if (const FunctionProtoType *FT = dyn_cast<FunctionProtoType>(FPRetType)){
818 Getr += "(";
819 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
820 if (i) Getr += ", ";
821 std::string ParamStr =
822 FT->getParamType(i).getAsString(Context->getPrintingPolicy());
823 Getr += ParamStr;
824 }
825 if (FT->isVariadic()) {
826 if (FT->getNumParams())
827 Getr += ", ";
828 Getr += "...";
829 }
830 Getr += ")";
831 } else
832 Getr += "()";
833 }
834 Getr += ";\n";
835 Getr += "return (_TYPE)";
836 Getr += "objc_getProperty(self, _cmd, ";
837 RewriteIvarOffsetComputation(OID, Getr);
838 Getr += ", 1)";
839 }
840 else
841 Getr += "return " + getIvarAccessString(OID);
842 Getr += "; }";
843 InsertText(onePastSemiLoc, Getr);
844 }
845
846 if (PD->isReadOnly() || PD->getSetterMethodDecl()->isDefined())
847 return;
848
849 // Generate the 'setter' function.
850 std::string Setr;
851 bool GenSetProperty = Attributes & (ObjCPropertyDecl::OBJC_PR_retain |
852 ObjCPropertyDecl::OBJC_PR_copy);
853 if (GenSetProperty && !objcSetPropertyDefined) {
854 objcSetPropertyDefined = true;
855 // FIXME. Is this attribute correct in all cases?
856 Setr = "\nextern \"C\" __declspec(dllimport) "
857 "void objc_setProperty (id, SEL, long, id, bool, bool);\n";
858 }
859
860 RewriteObjCMethodDecl(OID->getContainingInterface(),
861 PD->getSetterMethodDecl(), Setr);
862 Setr += "{ ";
863 // Synthesize an explicit cast to initialize the ivar.
864 // See objc-act.c:objc_synthesize_new_setter() for details.
865 if (GenSetProperty) {
866 Setr += "objc_setProperty (self, _cmd, ";
867 RewriteIvarOffsetComputation(OID, Setr);
868 Setr += ", (id)";
869 Setr += PD->getName();
870 Setr += ", ";
871 if (Attributes & ObjCPropertyDecl::OBJC_PR_nonatomic)
872 Setr += "0, ";
873 else
874 Setr += "1, ";
875 if (Attributes & ObjCPropertyDecl::OBJC_PR_copy)
876 Setr += "1)";
877 else
878 Setr += "0)";
879 }
880 else {
881 Setr += getIvarAccessString(OID) + " = ";
882 Setr += PD->getName();
883 }
884 Setr += "; }";
885 InsertText(onePastSemiLoc, Setr);
886}
887
888static void RewriteOneForwardClassDecl(ObjCInterfaceDecl *ForwardDecl,
889 std::string &typedefString) {
890 typedefString += "#ifndef _REWRITER_typedef_";
891 typedefString += ForwardDecl->getNameAsString();
892 typedefString += "\n";
893 typedefString += "#define _REWRITER_typedef_";
894 typedefString += ForwardDecl->getNameAsString();
895 typedefString += "\n";
896 typedefString += "typedef struct objc_object ";
897 typedefString += ForwardDecl->getNameAsString();
898 typedefString += ";\n#endif\n";
899}
900
901void RewriteObjC::RewriteForwardClassEpilogue(ObjCInterfaceDecl *ClassDecl,
902 const std::string &typedefString) {
903 SourceLocation startLoc = ClassDecl->getBeginLoc();
904 const char *startBuf = SM->getCharacterData(startLoc);
905 const char *semiPtr = strchr(startBuf, ';');
906 // Replace the @class with typedefs corresponding to the classes.
907 ReplaceText(startLoc, semiPtr - startBuf + 1, typedefString);
908}
909
910void RewriteObjC::RewriteForwardClassDecl(DeclGroupRef D) {
911 std::string typedefString;
912 for (DeclGroupRef::iterator I = D.begin(), E = D.end(); I != E; ++I) {
913 ObjCInterfaceDecl *ForwardDecl = cast<ObjCInterfaceDecl>(*I);
914 if (I == D.begin()) {
915 // Translate to typedef's that forward reference structs with the same name
916 // as the class. As a convenience, we include the original declaration
917 // as a comment.
918 typedefString += "// @class ";
919 typedefString += ForwardDecl->getNameAsString();
920 typedefString += ";\n";
921 }
922 RewriteOneForwardClassDecl(ForwardDecl, typedefString);
923 }
924 DeclGroupRef::iterator I = D.begin();
925 RewriteForwardClassEpilogue(cast<ObjCInterfaceDecl>(*I), typedefString);
926}
927
928void RewriteObjC::RewriteForwardClassDecl(const SmallVectorImpl<Decl *> &D) {
929 std::string typedefString;
930 for (unsigned i = 0; i < D.size(); i++) {
931 ObjCInterfaceDecl *ForwardDecl = cast<ObjCInterfaceDecl>(D[i]);
932 if (i == 0) {
933 typedefString += "// @class ";
934 typedefString += ForwardDecl->getNameAsString();
935 typedefString += ";\n";
936 }
937 RewriteOneForwardClassDecl(ForwardDecl, typedefString);
938 }
939 RewriteForwardClassEpilogue(cast<ObjCInterfaceDecl>(D[0]), typedefString);
940}
941
942void RewriteObjC::RewriteMethodDeclaration(ObjCMethodDecl *Method) {
943 // When method is a synthesized one, such as a getter/setter there is
944 // nothing to rewrite.
945 if (Method->isImplicit())
946 return;
947 SourceLocation LocStart = Method->getBeginLoc();
948 SourceLocation LocEnd = Method->getEndLoc();
949
950 if (SM->getExpansionLineNumber(LocEnd) >
951 SM->getExpansionLineNumber(LocStart)) {
952 InsertText(LocStart, "#if 0\n");
953 ReplaceText(LocEnd, 1, ";\n#endif\n");
954 } else {
955 InsertText(LocStart, "// ");
956 }
957}
958
959void RewriteObjC::RewriteProperty(ObjCPropertyDecl *prop) {
960 SourceLocation Loc = prop->getAtLoc();
961
962 ReplaceText(Loc, 0, "// ");
963 // FIXME: handle properties that are declared across multiple lines.
964}
965
966void RewriteObjC::RewriteCategoryDecl(ObjCCategoryDecl *CatDecl) {
967 SourceLocation LocStart = CatDecl->getBeginLoc();
968
969 // FIXME: handle category headers that are declared across multiple lines.
970 ReplaceText(LocStart, 0, "// ");
971
972 for (auto *I : CatDecl->instance_properties())
973 RewriteProperty(I);
974 for (auto *I : CatDecl->instance_methods())
975 RewriteMethodDeclaration(I);
976 for (auto *I : CatDecl->class_methods())
977 RewriteMethodDeclaration(I);
978
979 // Lastly, comment out the @end.
980 ReplaceText(CatDecl->getAtEndRange().getBegin(),
981 strlen("@end"), "/* @end */");
982}
983
984void RewriteObjC::RewriteProtocolDecl(ObjCProtocolDecl *PDecl) {
985 SourceLocation LocStart = PDecl->getBeginLoc();
986 assert(PDecl->isThisDeclarationADefinition())((PDecl->isThisDeclarationADefinition()) ? static_cast<
void> (0) : __assert_fail ("PDecl->isThisDeclarationADefinition()"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 986, __PRETTY_FUNCTION__))
;
987
988 // FIXME: handle protocol headers that are declared across multiple lines.
989 ReplaceText(LocStart, 0, "// ");
990
991 for (auto *I : PDecl->instance_methods())
992 RewriteMethodDeclaration(I);
993 for (auto *I : PDecl->class_methods())
994 RewriteMethodDeclaration(I);
995 for (auto *I : PDecl->instance_properties())
996 RewriteProperty(I);
997
998 // Lastly, comment out the @end.
999 SourceLocation LocEnd = PDecl->getAtEndRange().getBegin();
1000 ReplaceText(LocEnd, strlen("@end"), "/* @end */");
1001
1002 // Must comment out @optional/@required
1003 const char *startBuf = SM->getCharacterData(LocStart);
1004 const char *endBuf = SM->getCharacterData(LocEnd);
1005 for (const char *p = startBuf; p < endBuf; p++) {
1006 if (*p == '@' && !strncmp(p+1, "optional", strlen("optional"))) {
1007 SourceLocation OptionalLoc = LocStart.getLocWithOffset(p-startBuf);
1008 ReplaceText(OptionalLoc, strlen("@optional"), "/* @optional */");
1009
1010 }
1011 else if (*p == '@' && !strncmp(p+1, "required", strlen("required"))) {
1012 SourceLocation OptionalLoc = LocStart.getLocWithOffset(p-startBuf);
1013 ReplaceText(OptionalLoc, strlen("@required"), "/* @required */");
1014
1015 }
1016 }
1017}
1018
1019void RewriteObjC::RewriteForwardProtocolDecl(DeclGroupRef D) {
1020 SourceLocation LocStart = (*D.begin())->getBeginLoc();
1021 if (LocStart.isInvalid())
1022 llvm_unreachable("Invalid SourceLocation")::llvm::llvm_unreachable_internal("Invalid SourceLocation", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1022)
;
1023 // FIXME: handle forward protocol that are declared across multiple lines.
1024 ReplaceText(LocStart, 0, "// ");
1025}
1026
1027void
1028RewriteObjC::RewriteForwardProtocolDecl(const SmallVectorImpl<Decl *> &DG) {
1029 SourceLocation LocStart = DG[0]->getBeginLoc();
1030 if (LocStart.isInvalid())
1031 llvm_unreachable("Invalid SourceLocation")::llvm::llvm_unreachable_internal("Invalid SourceLocation", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1031)
;
1032 // FIXME: handle forward protocol that are declared across multiple lines.
1033 ReplaceText(LocStart, 0, "// ");
1034}
1035
1036void RewriteObjC::RewriteTypeIntoString(QualType T, std::string &ResultStr,
1037 const FunctionType *&FPRetType) {
1038 if (T->isObjCQualifiedIdType())
1039 ResultStr += "id";
1040 else if (T->isFunctionPointerType() ||
1041 T->isBlockPointerType()) {
1042 // needs special handling, since pointer-to-functions have special
1043 // syntax (where a decaration models use).
1044 QualType retType = T;
1045 QualType PointeeTy;
1046 if (const PointerType* PT = retType->getAs<PointerType>())
1047 PointeeTy = PT->getPointeeType();
1048 else if (const BlockPointerType *BPT = retType->getAs<BlockPointerType>())
1049 PointeeTy = BPT->getPointeeType();
1050 if ((FPRetType = PointeeTy->getAs<FunctionType>())) {
1051 ResultStr +=
1052 FPRetType->getReturnType().getAsString(Context->getPrintingPolicy());
1053 ResultStr += "(*";
1054 }
1055 } else
1056 ResultStr += T.getAsString(Context->getPrintingPolicy());
1057}
1058
1059void RewriteObjC::RewriteObjCMethodDecl(const ObjCInterfaceDecl *IDecl,
1060 ObjCMethodDecl *OMD,
1061 std::string &ResultStr) {
1062 //fprintf(stderr,"In RewriteObjCMethodDecl\n");
1063 const FunctionType *FPRetType = nullptr;
1064 ResultStr += "\nstatic ";
1065 RewriteTypeIntoString(OMD->getReturnType(), ResultStr, FPRetType);
1066 ResultStr += " ";
1067
1068 // Unique method name
1069 std::string NameStr;
1070
1071 if (OMD->isInstanceMethod())
1072 NameStr += "_I_";
1073 else
1074 NameStr += "_C_";
1075
1076 NameStr += IDecl->getNameAsString();
1077 NameStr += "_";
1078
1079 if (ObjCCategoryImplDecl *CID =
1080 dyn_cast<ObjCCategoryImplDecl>(OMD->getDeclContext())) {
1081 NameStr += CID->getNameAsString();
1082 NameStr += "_";
1083 }
1084 // Append selector names, replacing ':' with '_'
1085 {
1086 std::string selString = OMD->getSelector().getAsString();
1087 int len = selString.size();
1088 for (int i = 0; i < len; i++)
1089 if (selString[i] == ':')
1090 selString[i] = '_';
1091 NameStr += selString;
1092 }
1093 // Remember this name for metadata emission
1094 MethodInternalNames[OMD] = NameStr;
1095 ResultStr += NameStr;
1096
1097 // Rewrite arguments
1098 ResultStr += "(";
1099
1100 // invisible arguments
1101 if (OMD->isInstanceMethod()) {
1102 QualType selfTy = Context->getObjCInterfaceType(IDecl);
1103 selfTy = Context->getPointerType(selfTy);
1104 if (!LangOpts.MicrosoftExt) {
1105 if (ObjCSynthesizedStructs.count(const_cast<ObjCInterfaceDecl*>(IDecl)))
1106 ResultStr += "struct ";
1107 }
1108 // When rewriting for Microsoft, explicitly omit the structure name.
1109 ResultStr += IDecl->getNameAsString();
1110 ResultStr += " *";
1111 }
1112 else
1113 ResultStr += Context->getObjCClassType().getAsString(
1114 Context->getPrintingPolicy());
1115
1116 ResultStr += " self, ";
1117 ResultStr += Context->getObjCSelType().getAsString(Context->getPrintingPolicy());
1118 ResultStr += " _cmd";
1119
1120 // Method arguments.
1121 for (const auto *PDecl : OMD->parameters()) {
1122 ResultStr += ", ";
1123 if (PDecl->getType()->isObjCQualifiedIdType()) {
1124 ResultStr += "id ";
1125 ResultStr += PDecl->getNameAsString();
1126 } else {
1127 std::string Name = PDecl->getNameAsString();
1128 QualType QT = PDecl->getType();
1129 // Make sure we convert "t (^)(...)" to "t (*)(...)".
1130 (void)convertBlockPointerToFunctionPointer(QT);
1131 QT.getAsStringInternal(Name, Context->getPrintingPolicy());
1132 ResultStr += Name;
1133 }
1134 }
1135 if (OMD->isVariadic())
1136 ResultStr += ", ...";
1137 ResultStr += ") ";
1138
1139 if (FPRetType) {
1140 ResultStr += ")"; // close the precedence "scope" for "*".
1141
1142 // Now, emit the argument types (if any).
1143 if (const FunctionProtoType *FT = dyn_cast<FunctionProtoType>(FPRetType)) {
1144 ResultStr += "(";
1145 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) {
1146 if (i) ResultStr += ", ";
1147 std::string ParamStr =
1148 FT->getParamType(i).getAsString(Context->getPrintingPolicy());
1149 ResultStr += ParamStr;
1150 }
1151 if (FT->isVariadic()) {
1152 if (FT->getNumParams())
1153 ResultStr += ", ";
1154 ResultStr += "...";
1155 }
1156 ResultStr += ")";
1157 } else {
1158 ResultStr += "()";
1159 }
1160 }
1161}
1162
1163void RewriteObjC::RewriteImplementationDecl(Decl *OID) {
1164 ObjCImplementationDecl *IMD = dyn_cast<ObjCImplementationDecl>(OID);
1165 ObjCCategoryImplDecl *CID = dyn_cast<ObjCCategoryImplDecl>(OID);
1166
1167 InsertText(IMD ? IMD->getBeginLoc() : CID->getBeginLoc(), "// ");
1168
1169 for (auto *OMD : IMD ? IMD->instance_methods() : CID->instance_methods()) {
1170 std::string ResultStr;
1171 RewriteObjCMethodDecl(OMD->getClassInterface(), OMD, ResultStr);
1172 SourceLocation LocStart = OMD->getBeginLoc();
1173 SourceLocation LocEnd = OMD->getCompoundBody()->getBeginLoc();
1174
1175 const char *startBuf = SM->getCharacterData(LocStart);
1176 const char *endBuf = SM->getCharacterData(LocEnd);
1177 ReplaceText(LocStart, endBuf-startBuf, ResultStr);
1178 }
1179
1180 for (auto *OMD : IMD ? IMD->class_methods() : CID->class_methods()) {
1181 std::string ResultStr;
1182 RewriteObjCMethodDecl(OMD->getClassInterface(), OMD, ResultStr);
1183 SourceLocation LocStart = OMD->getBeginLoc();
1184 SourceLocation LocEnd = OMD->getCompoundBody()->getBeginLoc();
1185
1186 const char *startBuf = SM->getCharacterData(LocStart);
1187 const char *endBuf = SM->getCharacterData(LocEnd);
1188 ReplaceText(LocStart, endBuf-startBuf, ResultStr);
1189 }
1190 for (auto *I : IMD ? IMD->property_impls() : CID->property_impls())
1191 RewritePropertyImplDecl(I, IMD, CID);
1192
1193 InsertText(IMD ? IMD->getEndLoc() : CID->getEndLoc(), "// ");
1194}
1195
1196void RewriteObjC::RewriteInterfaceDecl(ObjCInterfaceDecl *ClassDecl) {
1197 std::string ResultStr;
1198 if (!ObjCForwardDecls.count(ClassDecl->getCanonicalDecl())) {
1199 // we haven't seen a forward decl - generate a typedef.
1200 ResultStr = "#ifndef _REWRITER_typedef_";
1201 ResultStr += ClassDecl->getNameAsString();
1202 ResultStr += "\n";
1203 ResultStr += "#define _REWRITER_typedef_";
1204 ResultStr += ClassDecl->getNameAsString();
1205 ResultStr += "\n";
1206 ResultStr += "typedef struct objc_object ";
1207 ResultStr += ClassDecl->getNameAsString();
1208 ResultStr += ";\n#endif\n";
1209 // Mark this typedef as having been generated.
1210 ObjCForwardDecls.insert(ClassDecl->getCanonicalDecl());
1211 }
1212 RewriteObjCInternalStruct(ClassDecl, ResultStr);
1213
1214 for (auto *I : ClassDecl->instance_properties())
1215 RewriteProperty(I);
1216 for (auto *I : ClassDecl->instance_methods())
1217 RewriteMethodDeclaration(I);
1218 for (auto *I : ClassDecl->class_methods())
1219 RewriteMethodDeclaration(I);
1220
1221 // Lastly, comment out the @end.
1222 ReplaceText(ClassDecl->getAtEndRange().getBegin(), strlen("@end"),
1223 "/* @end */");
1224}
1225
1226Stmt *RewriteObjC::RewritePropertyOrImplicitSetter(PseudoObjectExpr *PseudoOp) {
1227 SourceRange OldRange = PseudoOp->getSourceRange();
1228
1229 // We just magically know some things about the structure of this
1230 // expression.
1231 ObjCMessageExpr *OldMsg =
1232 cast<ObjCMessageExpr>(PseudoOp->getSemanticExpr(
1233 PseudoOp->getNumSemanticExprs() - 1));
1234
1235 // Because the rewriter doesn't allow us to rewrite rewritten code,
1236 // we need to suppress rewriting the sub-statements.
1237 Expr *Base, *RHS;
1238 {
1239 DisableReplaceStmtScope S(*this);
1240
1241 // Rebuild the base expression if we have one.
1242 Base = nullptr;
1243 if (OldMsg->getReceiverKind() == ObjCMessageExpr::Instance) {
1244 Base = OldMsg->getInstanceReceiver();
1245 Base = cast<OpaqueValueExpr>(Base)->getSourceExpr();
1246 Base = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Base));
1247 }
1248
1249 // Rebuild the RHS.
1250 RHS = cast<BinaryOperator>(PseudoOp->getSyntacticForm())->getRHS();
1251 RHS = cast<OpaqueValueExpr>(RHS)->getSourceExpr();
1252 RHS = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(RHS));
1253 }
1254
1255 // TODO: avoid this copy.
1256 SmallVector<SourceLocation, 1> SelLocs;
1257 OldMsg->getSelectorLocs(SelLocs);
1258
1259 ObjCMessageExpr *NewMsg = nullptr;
1260 switch (OldMsg->getReceiverKind()) {
1261 case ObjCMessageExpr::Class:
1262 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1263 OldMsg->getValueKind(),
1264 OldMsg->getLeftLoc(),
1265 OldMsg->getClassReceiverTypeInfo(),
1266 OldMsg->getSelector(),
1267 SelLocs,
1268 OldMsg->getMethodDecl(),
1269 RHS,
1270 OldMsg->getRightLoc(),
1271 OldMsg->isImplicit());
1272 break;
1273
1274 case ObjCMessageExpr::Instance:
1275 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1276 OldMsg->getValueKind(),
1277 OldMsg->getLeftLoc(),
1278 Base,
1279 OldMsg->getSelector(),
1280 SelLocs,
1281 OldMsg->getMethodDecl(),
1282 RHS,
1283 OldMsg->getRightLoc(),
1284 OldMsg->isImplicit());
1285 break;
1286
1287 case ObjCMessageExpr::SuperClass:
1288 case ObjCMessageExpr::SuperInstance:
1289 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1290 OldMsg->getValueKind(),
1291 OldMsg->getLeftLoc(),
1292 OldMsg->getSuperLoc(),
1293 OldMsg->getReceiverKind() == ObjCMessageExpr::SuperInstance,
1294 OldMsg->getSuperType(),
1295 OldMsg->getSelector(),
1296 SelLocs,
1297 OldMsg->getMethodDecl(),
1298 RHS,
1299 OldMsg->getRightLoc(),
1300 OldMsg->isImplicit());
1301 break;
1302 }
1303
1304 Stmt *Replacement = SynthMessageExpr(NewMsg);
1305 ReplaceStmtWithRange(PseudoOp, Replacement, OldRange);
1306 return Replacement;
1307}
1308
1309Stmt *RewriteObjC::RewritePropertyOrImplicitGetter(PseudoObjectExpr *PseudoOp) {
1310 SourceRange OldRange = PseudoOp->getSourceRange();
1311
1312 // We just magically know some things about the structure of this
1313 // expression.
1314 ObjCMessageExpr *OldMsg =
1315 cast<ObjCMessageExpr>(PseudoOp->getResultExpr()->IgnoreImplicit());
1316
1317 // Because the rewriter doesn't allow us to rewrite rewritten code,
1318 // we need to suppress rewriting the sub-statements.
1319 Expr *Base = nullptr;
1320 {
1321 DisableReplaceStmtScope S(*this);
1322
1323 // Rebuild the base expression if we have one.
1324 if (OldMsg->getReceiverKind() == ObjCMessageExpr::Instance) {
1325 Base = OldMsg->getInstanceReceiver();
1326 Base = cast<OpaqueValueExpr>(Base)->getSourceExpr();
1327 Base = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Base));
1328 }
1329 }
1330
1331 // Intentionally empty.
1332 SmallVector<SourceLocation, 1> SelLocs;
1333 SmallVector<Expr*, 1> Args;
1334
1335 ObjCMessageExpr *NewMsg = nullptr;
1336 switch (OldMsg->getReceiverKind()) {
1337 case ObjCMessageExpr::Class:
1338 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1339 OldMsg->getValueKind(),
1340 OldMsg->getLeftLoc(),
1341 OldMsg->getClassReceiverTypeInfo(),
1342 OldMsg->getSelector(),
1343 SelLocs,
1344 OldMsg->getMethodDecl(),
1345 Args,
1346 OldMsg->getRightLoc(),
1347 OldMsg->isImplicit());
1348 break;
1349
1350 case ObjCMessageExpr::Instance:
1351 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1352 OldMsg->getValueKind(),
1353 OldMsg->getLeftLoc(),
1354 Base,
1355 OldMsg->getSelector(),
1356 SelLocs,
1357 OldMsg->getMethodDecl(),
1358 Args,
1359 OldMsg->getRightLoc(),
1360 OldMsg->isImplicit());
1361 break;
1362
1363 case ObjCMessageExpr::SuperClass:
1364 case ObjCMessageExpr::SuperInstance:
1365 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1366 OldMsg->getValueKind(),
1367 OldMsg->getLeftLoc(),
1368 OldMsg->getSuperLoc(),
1369 OldMsg->getReceiverKind() == ObjCMessageExpr::SuperInstance,
1370 OldMsg->getSuperType(),
1371 OldMsg->getSelector(),
1372 SelLocs,
1373 OldMsg->getMethodDecl(),
1374 Args,
1375 OldMsg->getRightLoc(),
1376 OldMsg->isImplicit());
1377 break;
1378 }
1379
1380 Stmt *Replacement = SynthMessageExpr(NewMsg);
1381 ReplaceStmtWithRange(PseudoOp, Replacement, OldRange);
1382 return Replacement;
1383}
1384
1385/// SynthCountByEnumWithState - To print:
1386/// ((unsigned int (*)
1387/// (id, SEL, struct __objcFastEnumerationState *, id *, unsigned int))
1388/// (void *)objc_msgSend)((id)l_collection,
1389/// sel_registerName(
1390/// "countByEnumeratingWithState:objects:count:"),
1391/// &enumState,
1392/// (id *)__rw_items, (unsigned int)16)
1393///
1394void RewriteObjC::SynthCountByEnumWithState(std::string &buf) {
1395 buf += "((unsigned int (*) (id, SEL, struct __objcFastEnumerationState *, "
1396 "id *, unsigned int))(void *)objc_msgSend)";
1397 buf += "\n\t\t";
1398 buf += "((id)l_collection,\n\t\t";
1399 buf += "sel_registerName(\"countByEnumeratingWithState:objects:count:\"),";
1400 buf += "\n\t\t";
1401 buf += "&enumState, "
1402 "(id *)__rw_items, (unsigned int)16)";
1403}
1404
1405/// RewriteBreakStmt - Rewrite for a break-stmt inside an ObjC2's foreach
1406/// statement to exit to its outer synthesized loop.
1407///
1408Stmt *RewriteObjC::RewriteBreakStmt(BreakStmt *S) {
1409 if (Stmts.empty() || !isa<ObjCForCollectionStmt>(Stmts.back()))
1410 return S;
1411 // replace break with goto __break_label
1412 std::string buf;
1413
1414 SourceLocation startLoc = S->getBeginLoc();
1415 buf = "goto __break_label_";
1416 buf += utostr(ObjCBcLabelNo.back());
1417 ReplaceText(startLoc, strlen("break"), buf);
1418
1419 return nullptr;
1420}
1421
1422/// RewriteContinueStmt - Rewrite for a continue-stmt inside an ObjC2's foreach
1423/// statement to continue with its inner synthesized loop.
1424///
1425Stmt *RewriteObjC::RewriteContinueStmt(ContinueStmt *S) {
1426 if (Stmts.empty() || !isa<ObjCForCollectionStmt>(Stmts.back()))
1427 return S;
1428 // replace continue with goto __continue_label
1429 std::string buf;
1430
1431 SourceLocation startLoc = S->getBeginLoc();
1432 buf = "goto __continue_label_";
1433 buf += utostr(ObjCBcLabelNo.back());
1434 ReplaceText(startLoc, strlen("continue"), buf);
1435
1436 return nullptr;
1437}
1438
1439/// RewriteObjCForCollectionStmt - Rewriter for ObjC2's foreach statement.
1440/// It rewrites:
1441/// for ( type elem in collection) { stmts; }
1442
1443/// Into:
1444/// {
1445/// type elem;
1446/// struct __objcFastEnumerationState enumState = { 0 };
1447/// id __rw_items[16];
1448/// id l_collection = (id)collection;
1449/// unsigned long limit = [l_collection countByEnumeratingWithState:&enumState
1450/// objects:__rw_items count:16];
1451/// if (limit) {
1452/// unsigned long startMutations = *enumState.mutationsPtr;
1453/// do {
1454/// unsigned long counter = 0;
1455/// do {
1456/// if (startMutations != *enumState.mutationsPtr)
1457/// objc_enumerationMutation(l_collection);
1458/// elem = (type)enumState.itemsPtr[counter++];
1459/// stmts;
1460/// __continue_label: ;
1461/// } while (counter < limit);
1462/// } while (limit = [l_collection countByEnumeratingWithState:&enumState
1463/// objects:__rw_items count:16]);
1464/// elem = nil;
1465/// __break_label: ;
1466/// }
1467/// else
1468/// elem = nil;
1469/// }
1470///
1471Stmt *RewriteObjC::RewriteObjCForCollectionStmt(ObjCForCollectionStmt *S,
1472 SourceLocation OrigEnd) {
1473 assert(!Stmts.empty() && "ObjCForCollectionStmt - Statement stack empty")((!Stmts.empty() && "ObjCForCollectionStmt - Statement stack empty"
) ? static_cast<void> (0) : __assert_fail ("!Stmts.empty() && \"ObjCForCollectionStmt - Statement stack empty\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1473, __PRETTY_FUNCTION__))
;
1474 assert(isa<ObjCForCollectionStmt>(Stmts.back()) &&((isa<ObjCForCollectionStmt>(Stmts.back()) && "ObjCForCollectionStmt Statement stack mismatch"
) ? static_cast<void> (0) : __assert_fail ("isa<ObjCForCollectionStmt>(Stmts.back()) && \"ObjCForCollectionStmt Statement stack mismatch\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1475, __PRETTY_FUNCTION__))
1475 "ObjCForCollectionStmt Statement stack mismatch")((isa<ObjCForCollectionStmt>(Stmts.back()) && "ObjCForCollectionStmt Statement stack mismatch"
) ? static_cast<void> (0) : __assert_fail ("isa<ObjCForCollectionStmt>(Stmts.back()) && \"ObjCForCollectionStmt Statement stack mismatch\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1475, __PRETTY_FUNCTION__))
;
1476 assert(!ObjCBcLabelNo.empty() &&((!ObjCBcLabelNo.empty() && "ObjCForCollectionStmt - Label No stack empty"
) ? static_cast<void> (0) : __assert_fail ("!ObjCBcLabelNo.empty() && \"ObjCForCollectionStmt - Label No stack empty\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1477, __PRETTY_FUNCTION__))
1477 "ObjCForCollectionStmt - Label No stack empty")((!ObjCBcLabelNo.empty() && "ObjCForCollectionStmt - Label No stack empty"
) ? static_cast<void> (0) : __assert_fail ("!ObjCBcLabelNo.empty() && \"ObjCForCollectionStmt - Label No stack empty\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1477, __PRETTY_FUNCTION__))
;
1478
1479 SourceLocation startLoc = S->getBeginLoc();
1480 const char *startBuf = SM->getCharacterData(startLoc);
1481 StringRef elementName;
1482 std::string elementTypeAsString;
1483 std::string buf;
1484 buf = "\n{\n\t";
1485 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->getElement())) {
1486 // type elem;
1487 NamedDecl* D = cast<NamedDecl>(DS->getSingleDecl());
1488 QualType ElementType = cast<ValueDecl>(D)->getType();
1489 if (ElementType->isObjCQualifiedIdType() ||
1490 ElementType->isObjCQualifiedInterfaceType())
1491 // Simply use 'id' for all qualified types.
1492 elementTypeAsString = "id";
1493 else
1494 elementTypeAsString = ElementType.getAsString(Context->getPrintingPolicy());
1495 buf += elementTypeAsString;
1496 buf += " ";
1497 elementName = D->getName();
1498 buf += elementName;
1499 buf += ";\n\t";
1500 }
1501 else {
1502 DeclRefExpr *DR = cast<DeclRefExpr>(S->getElement());
1503 elementName = DR->getDecl()->getName();
1504 ValueDecl *VD = DR->getDecl();
1505 if (VD->getType()->isObjCQualifiedIdType() ||
1506 VD->getType()->isObjCQualifiedInterfaceType())
1507 // Simply use 'id' for all qualified types.
1508 elementTypeAsString = "id";
1509 else
1510 elementTypeAsString = VD->getType().getAsString(Context->getPrintingPolicy());
1511 }
1512
1513 // struct __objcFastEnumerationState enumState = { 0 };
1514 buf += "struct __objcFastEnumerationState enumState = { 0 };\n\t";
1515 // id __rw_items[16];
1516 buf += "id __rw_items[16];\n\t";
1517 // id l_collection = (id)
1518 buf += "id l_collection = (id)";
1519 // Find start location of 'collection' the hard way!
1520 const char *startCollectionBuf = startBuf;
1521 startCollectionBuf += 3; // skip 'for'
1522 startCollectionBuf = strchr(startCollectionBuf, '(');
1523 startCollectionBuf++; // skip '('
1524 // find 'in' and skip it.
1525 while (*startCollectionBuf != ' ' ||
1526 *(startCollectionBuf+1) != 'i' || *(startCollectionBuf+2) != 'n' ||
1527 (*(startCollectionBuf+3) != ' ' &&
1528 *(startCollectionBuf+3) != '[' && *(startCollectionBuf+3) != '('))
1529 startCollectionBuf++;
1530 startCollectionBuf += 3;
1531
1532 // Replace: "for (type element in" with string constructed thus far.
1533 ReplaceText(startLoc, startCollectionBuf - startBuf, buf);
1534 // Replace ')' in for '(' type elem in collection ')' with ';'
1535 SourceLocation rightParenLoc = S->getRParenLoc();
1536 const char *rparenBuf = SM->getCharacterData(rightParenLoc);
1537 SourceLocation lparenLoc = startLoc.getLocWithOffset(rparenBuf-startBuf);
1538 buf = ";\n\t";
1539
1540 // unsigned long limit = [l_collection countByEnumeratingWithState:&enumState
1541 // objects:__rw_items count:16];
1542 // which is synthesized into:
1543 // unsigned int limit =
1544 // ((unsigned int (*)
1545 // (id, SEL, struct __objcFastEnumerationState *, id *, unsigned int))
1546 // (void *)objc_msgSend)((id)l_collection,
1547 // sel_registerName(
1548 // "countByEnumeratingWithState:objects:count:"),
1549 // (struct __objcFastEnumerationState *)&state,
1550 // (id *)__rw_items, (unsigned int)16);
1551 buf += "unsigned long limit =\n\t\t";
1552 SynthCountByEnumWithState(buf);
1553 buf += ";\n\t";
1554 /// if (limit) {
1555 /// unsigned long startMutations = *enumState.mutationsPtr;
1556 /// do {
1557 /// unsigned long counter = 0;
1558 /// do {
1559 /// if (startMutations != *enumState.mutationsPtr)
1560 /// objc_enumerationMutation(l_collection);
1561 /// elem = (type)enumState.itemsPtr[counter++];
1562 buf += "if (limit) {\n\t";
1563 buf += "unsigned long startMutations = *enumState.mutationsPtr;\n\t";
1564 buf += "do {\n\t\t";
1565 buf += "unsigned long counter = 0;\n\t\t";
1566 buf += "do {\n\t\t\t";
1567 buf += "if (startMutations != *enumState.mutationsPtr)\n\t\t\t\t";
1568 buf += "objc_enumerationMutation(l_collection);\n\t\t\t";
1569 buf += elementName;
1570 buf += " = (";
1571 buf += elementTypeAsString;
1572 buf += ")enumState.itemsPtr[counter++];";
1573 // Replace ')' in for '(' type elem in collection ')' with all of these.
1574 ReplaceText(lparenLoc, 1, buf);
1575
1576 /// __continue_label: ;
1577 /// } while (counter < limit);
1578 /// } while (limit = [l_collection countByEnumeratingWithState:&enumState
1579 /// objects:__rw_items count:16]);
1580 /// elem = nil;
1581 /// __break_label: ;
1582 /// }
1583 /// else
1584 /// elem = nil;
1585 /// }
1586 ///
1587 buf = ";\n\t";
1588 buf += "__continue_label_";
1589 buf += utostr(ObjCBcLabelNo.back());
1590 buf += ": ;";
1591 buf += "\n\t\t";
1592 buf += "} while (counter < limit);\n\t";
1593 buf += "} while (limit = ";
1594 SynthCountByEnumWithState(buf);
1595 buf += ");\n\t";
1596 buf += elementName;
1597 buf += " = ((";
1598 buf += elementTypeAsString;
1599 buf += ")0);\n\t";
1600 buf += "__break_label_";
1601 buf += utostr(ObjCBcLabelNo.back());
1602 buf += ": ;\n\t";
1603 buf += "}\n\t";
1604 buf += "else\n\t\t";
1605 buf += elementName;
1606 buf += " = ((";
1607 buf += elementTypeAsString;
1608 buf += ")0);\n\t";
1609 buf += "}\n";
1610
1611 // Insert all these *after* the statement body.
1612 // FIXME: If this should support Obj-C++, support CXXTryStmt
1613 if (isa<CompoundStmt>(S->getBody())) {
1614 SourceLocation endBodyLoc = OrigEnd.getLocWithOffset(1);
1615 InsertText(endBodyLoc, buf);
1616 } else {
1617 /* Need to treat single statements specially. For example:
1618 *
1619 * for (A *a in b) if (stuff()) break;
1620 * for (A *a in b) xxxyy;
1621 *
1622 * The following code simply scans ahead to the semi to find the actual end.
1623 */
1624 const char *stmtBuf = SM->getCharacterData(OrigEnd);
1625 const char *semiBuf = strchr(stmtBuf, ';');
1626 assert(semiBuf && "Can't find ';'")((semiBuf && "Can't find ';'") ? static_cast<void>
(0) : __assert_fail ("semiBuf && \"Can't find ';'\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1626, __PRETTY_FUNCTION__))
;
1627 SourceLocation endBodyLoc = OrigEnd.getLocWithOffset(semiBuf-stmtBuf+1);
1628 InsertText(endBodyLoc, buf);
1629 }
1630 Stmts.pop_back();
1631 ObjCBcLabelNo.pop_back();
1632 return nullptr;
1633}
1634
1635/// RewriteObjCSynchronizedStmt -
1636/// This routine rewrites @synchronized(expr) stmt;
1637/// into:
1638/// objc_sync_enter(expr);
1639/// @try stmt @finally { objc_sync_exit(expr); }
1640///
1641Stmt *RewriteObjC::RewriteObjCSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
1642 // Get the start location and compute the semi location.
1643 SourceLocation startLoc = S->getBeginLoc();
1644 const char *startBuf = SM->getCharacterData(startLoc);
1645
1646 assert((*startBuf == '@') && "bogus @synchronized location")(((*startBuf == '@') && "bogus @synchronized location"
) ? static_cast<void> (0) : __assert_fail ("(*startBuf == '@') && \"bogus @synchronized location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1646, __PRETTY_FUNCTION__))
;
1647
1648 std::string buf;
1649 buf = "objc_sync_enter((id)";
1650 const char *lparenBuf = startBuf;
1651 while (*lparenBuf != '(') lparenBuf++;
1652 ReplaceText(startLoc, lparenBuf-startBuf+1, buf);
1653 // We can't use S->getSynchExpr()->getEndLoc() to find the end location, since
1654 // the sync expression is typically a message expression that's already
1655 // been rewritten! (which implies the SourceLocation's are invalid).
1656 SourceLocation endLoc = S->getSynchBody()->getBeginLoc();
1657 const char *endBuf = SM->getCharacterData(endLoc);
1658 while (*endBuf != ')') endBuf--;
1659 SourceLocation rparenLoc = startLoc.getLocWithOffset(endBuf-startBuf);
1660 buf = ");\n";
1661 // declare a new scope with two variables, _stack and _rethrow.
1662 buf += "/* @try scope begin */ \n{ struct _objc_exception_data {\n";
1663 buf += "int buf[18/*32-bit i386*/];\n";
1664 buf += "char *pointers[4];} _stack;\n";
1665 buf += "id volatile _rethrow = 0;\n";
1666 buf += "objc_exception_try_enter(&_stack);\n";
1667 buf += "if (!_setjmp(_stack.buf)) /* @try block continue */\n";
1668 ReplaceText(rparenLoc, 1, buf);
1669 startLoc = S->getSynchBody()->getEndLoc();
1670 startBuf = SM->getCharacterData(startLoc);
1671
1672 assert((*startBuf == '}') && "bogus @synchronized block")(((*startBuf == '}') && "bogus @synchronized block") ?
static_cast<void> (0) : __assert_fail ("(*startBuf == '}') && \"bogus @synchronized block\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1672, __PRETTY_FUNCTION__))
;
1673 SourceLocation lastCurlyLoc = startLoc;
1674 buf = "}\nelse {\n";
1675 buf += " _rethrow = objc_exception_extract(&_stack);\n";
1676 buf += "}\n";
1677 buf += "{ /* implicit finally clause */\n";
1678 buf += " if (!_rethrow) objc_exception_try_exit(&_stack);\n";
1679
1680 std::string syncBuf;
1681 syncBuf += " objc_sync_exit(";
1682
1683 Expr *syncExpr = S->getSynchExpr();
1684 CastKind CK = syncExpr->getType()->isObjCObjectPointerType()
1685 ? CK_BitCast :
1686 syncExpr->getType()->isBlockPointerType()
1687 ? CK_BlockPointerToObjCPointerCast
1688 : CK_CPointerToObjCPointerCast;
1689 syncExpr = NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(),
1690 CK, syncExpr);
1691 std::string syncExprBufS;
1692 llvm::raw_string_ostream syncExprBuf(syncExprBufS);
1693 assert(syncExpr != nullptr && "Expected non-null Expr")((syncExpr != nullptr && "Expected non-null Expr") ? static_cast
<void> (0) : __assert_fail ("syncExpr != nullptr && \"Expected non-null Expr\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1693, __PRETTY_FUNCTION__))
;
1694 syncExpr->printPretty(syncExprBuf, nullptr, PrintingPolicy(LangOpts));
1695 syncBuf += syncExprBuf.str();
1696 syncBuf += ");";
1697
1698 buf += syncBuf;
1699 buf += "\n if (_rethrow) objc_exception_throw(_rethrow);\n";
1700 buf += "}\n";
1701 buf += "}";
1702
1703 ReplaceText(lastCurlyLoc, 1, buf);
1704
1705 bool hasReturns = false;
1706 HasReturnStmts(S->getSynchBody(), hasReturns);
1707 if (hasReturns)
1708 RewriteSyncReturnStmts(S->getSynchBody(), syncBuf);
1709
1710 return nullptr;
1711}
1712
1713void RewriteObjC::WarnAboutReturnGotoStmts(Stmt *S)
1714{
1715 // Perform a bottom up traversal of all children.
1716 for (Stmt *SubStmt : S->children())
1717 if (SubStmt)
1718 WarnAboutReturnGotoStmts(SubStmt);
1719
1720 if (isa<ReturnStmt>(S) || isa<GotoStmt>(S)) {
1721 Diags.Report(Context->getFullLoc(S->getBeginLoc()),
1722 TryFinallyContainsReturnDiag);
1723 }
1724}
1725
1726void RewriteObjC::HasReturnStmts(Stmt *S, bool &hasReturns)
1727{
1728 // Perform a bottom up traversal of all children.
1729 for (Stmt *SubStmt : S->children())
1730 if (SubStmt)
1731 HasReturnStmts(SubStmt, hasReturns);
1732
1733 if (isa<ReturnStmt>(S))
1734 hasReturns = true;
1735}
1736
1737void RewriteObjC::RewriteTryReturnStmts(Stmt *S) {
1738 // Perform a bottom up traversal of all children.
1739 for (Stmt *SubStmt : S->children())
1740 if (SubStmt) {
1741 RewriteTryReturnStmts(SubStmt);
1742 }
1743 if (isa<ReturnStmt>(S)) {
1744 SourceLocation startLoc = S->getBeginLoc();
1745 const char *startBuf = SM->getCharacterData(startLoc);
1746 const char *semiBuf = strchr(startBuf, ';');
1747 assert((*semiBuf == ';') && "RewriteTryReturnStmts: can't find ';'")(((*semiBuf == ';') && "RewriteTryReturnStmts: can't find ';'"
) ? static_cast<void> (0) : __assert_fail ("(*semiBuf == ';') && \"RewriteTryReturnStmts: can't find ';'\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1747, __PRETTY_FUNCTION__))
;
1748 SourceLocation onePastSemiLoc = startLoc.getLocWithOffset(semiBuf-startBuf+1);
1749
1750 std::string buf;
1751 buf = "{ objc_exception_try_exit(&_stack); return";
1752
1753 ReplaceText(startLoc, 6, buf);
1754 InsertText(onePastSemiLoc, "}");
1755 }
1756}
1757
1758void RewriteObjC::RewriteSyncReturnStmts(Stmt *S, std::string syncExitBuf) {
1759 // Perform a bottom up traversal of all children.
1760 for (Stmt *SubStmt : S->children())
1761 if (SubStmt) {
1762 RewriteSyncReturnStmts(SubStmt, syncExitBuf);
1763 }
1764 if (isa<ReturnStmt>(S)) {
1765 SourceLocation startLoc = S->getBeginLoc();
1766 const char *startBuf = SM->getCharacterData(startLoc);
1767
1768 const char *semiBuf = strchr(startBuf, ';');
1769 assert((*semiBuf == ';') && "RewriteSyncReturnStmts: can't find ';'")(((*semiBuf == ';') && "RewriteSyncReturnStmts: can't find ';'"
) ? static_cast<void> (0) : __assert_fail ("(*semiBuf == ';') && \"RewriteSyncReturnStmts: can't find ';'\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1769, __PRETTY_FUNCTION__))
;
1770 SourceLocation onePastSemiLoc = startLoc.getLocWithOffset(semiBuf-startBuf+1);
1771
1772 std::string buf;
1773 buf = "{ objc_exception_try_exit(&_stack);";
1774 buf += syncExitBuf;
1775 buf += " return";
1776
1777 ReplaceText(startLoc, 6, buf);
1778 InsertText(onePastSemiLoc, "}");
1779 }
1780}
1781
1782Stmt *RewriteObjC::RewriteObjCTryStmt(ObjCAtTryStmt *S) {
1783 // Get the start location and compute the semi location.
1784 SourceLocation startLoc = S->getBeginLoc();
1785 const char *startBuf = SM->getCharacterData(startLoc);
1786
1787 assert((*startBuf == '@') && "bogus @try location")(((*startBuf == '@') && "bogus @try location") ? static_cast
<void> (0) : __assert_fail ("(*startBuf == '@') && \"bogus @try location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1787, __PRETTY_FUNCTION__))
;
1788
1789 std::string buf;
1790 // declare a new scope with two variables, _stack and _rethrow.
1791 buf = "/* @try scope begin */ { struct _objc_exception_data {\n";
1792 buf += "int buf[18/*32-bit i386*/];\n";
1793 buf += "char *pointers[4];} _stack;\n";
1794 buf += "id volatile _rethrow = 0;\n";
1795 buf += "objc_exception_try_enter(&_stack);\n";
1796 buf += "if (!_setjmp(_stack.buf)) /* @try block continue */\n";
1797
1798 ReplaceText(startLoc, 4, buf);
1799
1800 startLoc = S->getTryBody()->getEndLoc();
1801 startBuf = SM->getCharacterData(startLoc);
1802
1803 assert((*startBuf == '}') && "bogus @try block")(((*startBuf == '}') && "bogus @try block") ? static_cast
<void> (0) : __assert_fail ("(*startBuf == '}') && \"bogus @try block\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1803, __PRETTY_FUNCTION__))
;
1804
1805 SourceLocation lastCurlyLoc = startLoc;
1806 if (S->getNumCatchStmts()) {
1807 startLoc = startLoc.getLocWithOffset(1);
1808 buf = " /* @catch begin */ else {\n";
1809 buf += " id _caught = objc_exception_extract(&_stack);\n";
1810 buf += " objc_exception_try_enter (&_stack);\n";
1811 buf += " if (_setjmp(_stack.buf))\n";
1812 buf += " _rethrow = objc_exception_extract(&_stack);\n";
1813 buf += " else { /* @catch continue */";
1814
1815 InsertText(startLoc, buf);
1816 } else { /* no catch list */
1817 buf = "}\nelse {\n";
1818 buf += " _rethrow = objc_exception_extract(&_stack);\n";
1819 buf += "}";
1820 ReplaceText(lastCurlyLoc, 1, buf);
1821 }
1822 Stmt *lastCatchBody = nullptr;
1823 for (unsigned I = 0, N = S->getNumCatchStmts(); I != N; ++I) {
1824 ObjCAtCatchStmt *Catch = S->getCatchStmt(I);
1825 VarDecl *catchDecl = Catch->getCatchParamDecl();
1826
1827 if (I == 0)
1828 buf = "if ("; // we are generating code for the first catch clause
1829 else
1830 buf = "else if (";
1831 startLoc = Catch->getBeginLoc();
1832 startBuf = SM->getCharacterData(startLoc);
1833
1834 assert((*startBuf == '@') && "bogus @catch location")(((*startBuf == '@') && "bogus @catch location") ? static_cast
<void> (0) : __assert_fail ("(*startBuf == '@') && \"bogus @catch location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1834, __PRETTY_FUNCTION__))
;
1835
1836 const char *lParenLoc = strchr(startBuf, '(');
1837
1838 if (Catch->hasEllipsis()) {
1839 // Now rewrite the body...
1840 lastCatchBody = Catch->getCatchBody();
1841 SourceLocation bodyLoc = lastCatchBody->getBeginLoc();
1842 const char *bodyBuf = SM->getCharacterData(bodyLoc);
1843 assert(*SM->getCharacterData(Catch->getRParenLoc()) == ')' &&((*SM->getCharacterData(Catch->getRParenLoc()) == ')' &&
"bogus @catch paren location") ? static_cast<void> (0)
: __assert_fail ("*SM->getCharacterData(Catch->getRParenLoc()) == ')' && \"bogus @catch paren location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1844, __PRETTY_FUNCTION__))
1844 "bogus @catch paren location")((*SM->getCharacterData(Catch->getRParenLoc()) == ')' &&
"bogus @catch paren location") ? static_cast<void> (0)
: __assert_fail ("*SM->getCharacterData(Catch->getRParenLoc()) == ')' && \"bogus @catch paren location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1844, __PRETTY_FUNCTION__))
;
1845 assert((*bodyBuf == '{') && "bogus @catch body location")(((*bodyBuf == '{') && "bogus @catch body location") ?
static_cast<void> (0) : __assert_fail ("(*bodyBuf == '{') && \"bogus @catch body location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1845, __PRETTY_FUNCTION__))
;
1846
1847 buf += "1) { id _tmp = _caught;";
1848 Rewrite.ReplaceText(startLoc, bodyBuf-startBuf+1, buf);
1849 } else if (catchDecl) {
1850 QualType t = catchDecl->getType();
1851 if (t == Context->getObjCIdType()) {
1852 buf += "1) { ";
1853 ReplaceText(startLoc, lParenLoc-startBuf+1, buf);
1854 } else if (const ObjCObjectPointerType *Ptr =
1855 t->getAs<ObjCObjectPointerType>()) {
1856 // Should be a pointer to a class.
1857 ObjCInterfaceDecl *IDecl = Ptr->getObjectType()->getInterface();
1858 if (IDecl) {
1859 buf += "objc_exception_match((struct objc_class *)objc_getClass(\"";
1860 buf += IDecl->getNameAsString();
1861 buf += "\"), (struct objc_object *)_caught)) { ";
1862 ReplaceText(startLoc, lParenLoc-startBuf+1, buf);
1863 }
1864 }
1865 // Now rewrite the body...
1866 lastCatchBody = Catch->getCatchBody();
1867 SourceLocation rParenLoc = Catch->getRParenLoc();
1868 SourceLocation bodyLoc = lastCatchBody->getBeginLoc();
1869 const char *bodyBuf = SM->getCharacterData(bodyLoc);
1870 const char *rParenBuf = SM->getCharacterData(rParenLoc);
1871 assert((*rParenBuf == ')') && "bogus @catch paren location")(((*rParenBuf == ')') && "bogus @catch paren location"
) ? static_cast<void> (0) : __assert_fail ("(*rParenBuf == ')') && \"bogus @catch paren location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1871, __PRETTY_FUNCTION__))
;
1872 assert((*bodyBuf == '{') && "bogus @catch body location")(((*bodyBuf == '{') && "bogus @catch body location") ?
static_cast<void> (0) : __assert_fail ("(*bodyBuf == '{') && \"bogus @catch body location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1872, __PRETTY_FUNCTION__))
;
1873
1874 // Here we replace ") {" with "= _caught;" (which initializes and
1875 // declares the @catch parameter).
1876 ReplaceText(rParenLoc, bodyBuf-rParenBuf+1, " = _caught;");
1877 } else {
1878 llvm_unreachable("@catch rewrite bug")::llvm::llvm_unreachable_internal("@catch rewrite bug", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1878)
;
1879 }
1880 }
1881 // Complete the catch list...
1882 if (lastCatchBody) {
1883 SourceLocation bodyLoc = lastCatchBody->getEndLoc();
1884 assert(*SM->getCharacterData(bodyLoc) == '}' &&((*SM->getCharacterData(bodyLoc) == '}' && "bogus @catch body location"
) ? static_cast<void> (0) : __assert_fail ("*SM->getCharacterData(bodyLoc) == '}' && \"bogus @catch body location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1885, __PRETTY_FUNCTION__))
1885 "bogus @catch body location")((*SM->getCharacterData(bodyLoc) == '}' && "bogus @catch body location"
) ? static_cast<void> (0) : __assert_fail ("*SM->getCharacterData(bodyLoc) == '}' && \"bogus @catch body location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1885, __PRETTY_FUNCTION__))
;
1886
1887 // Insert the last (implicit) else clause *before* the right curly brace.
1888 bodyLoc = bodyLoc.getLocWithOffset(-1);
1889 buf = "} /* last catch end */\n";
1890 buf += "else {\n";
1891 buf += " _rethrow = _caught;\n";
1892 buf += " objc_exception_try_exit(&_stack);\n";
1893 buf += "} } /* @catch end */\n";
1894 if (!S->getFinallyStmt())
1895 buf += "}\n";
1896 InsertText(bodyLoc, buf);
1897
1898 // Set lastCurlyLoc
1899 lastCurlyLoc = lastCatchBody->getEndLoc();
1900 }
1901 if (ObjCAtFinallyStmt *finalStmt = S->getFinallyStmt()) {
1902 startLoc = finalStmt->getBeginLoc();
1903 startBuf = SM->getCharacterData(startLoc);
1904 assert((*startBuf == '@') && "bogus @finally start")(((*startBuf == '@') && "bogus @finally start") ? static_cast
<void> (0) : __assert_fail ("(*startBuf == '@') && \"bogus @finally start\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1904, __PRETTY_FUNCTION__))
;
1905
1906 ReplaceText(startLoc, 8, "/* @finally */");
1907
1908 Stmt *body = finalStmt->getFinallyBody();
1909 SourceLocation startLoc = body->getBeginLoc();
1910 SourceLocation endLoc = body->getEndLoc();
1911 assert(*SM->getCharacterData(startLoc) == '{' &&((*SM->getCharacterData(startLoc) == '{' && "bogus @finally body location"
) ? static_cast<void> (0) : __assert_fail ("*SM->getCharacterData(startLoc) == '{' && \"bogus @finally body location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1912, __PRETTY_FUNCTION__))
1912 "bogus @finally body location")((*SM->getCharacterData(startLoc) == '{' && "bogus @finally body location"
) ? static_cast<void> (0) : __assert_fail ("*SM->getCharacterData(startLoc) == '{' && \"bogus @finally body location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1912, __PRETTY_FUNCTION__))
;
1913 assert(*SM->getCharacterData(endLoc) == '}' &&((*SM->getCharacterData(endLoc) == '}' && "bogus @finally body location"
) ? static_cast<void> (0) : __assert_fail ("*SM->getCharacterData(endLoc) == '}' && \"bogus @finally body location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1914, __PRETTY_FUNCTION__))
1914 "bogus @finally body location")((*SM->getCharacterData(endLoc) == '}' && "bogus @finally body location"
) ? static_cast<void> (0) : __assert_fail ("*SM->getCharacterData(endLoc) == '}' && \"bogus @finally body location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1914, __PRETTY_FUNCTION__))
;
1915
1916 startLoc = startLoc.getLocWithOffset(1);
1917 InsertText(startLoc, " if (!_rethrow) objc_exception_try_exit(&_stack);\n");
1918 endLoc = endLoc.getLocWithOffset(-1);
1919 InsertText(endLoc, " if (_rethrow) objc_exception_throw(_rethrow);\n");
1920
1921 // Set lastCurlyLoc
1922 lastCurlyLoc = body->getEndLoc();
1923
1924 // Now check for any return/continue/go statements within the @try.
1925 WarnAboutReturnGotoStmts(S->getTryBody());
1926 } else { /* no finally clause - make sure we synthesize an implicit one */
1927 buf = "{ /* implicit finally clause */\n";
1928 buf += " if (!_rethrow) objc_exception_try_exit(&_stack);\n";
1929 buf += " if (_rethrow) objc_exception_throw(_rethrow);\n";
1930 buf += "}";
1931 ReplaceText(lastCurlyLoc, 1, buf);
1932
1933 // Now check for any return/continue/go statements within the @try.
1934 // The implicit finally clause won't called if the @try contains any
1935 // jump statements.
1936 bool hasReturns = false;
1937 HasReturnStmts(S->getTryBody(), hasReturns);
1938 if (hasReturns)
1939 RewriteTryReturnStmts(S->getTryBody());
1940 }
1941 // Now emit the final closing curly brace...
1942 lastCurlyLoc = lastCurlyLoc.getLocWithOffset(1);
1943 InsertText(lastCurlyLoc, " } /* @try scope end */\n");
1944 return nullptr;
1945}
1946
1947// This can't be done with ReplaceStmt(S, ThrowExpr), since
1948// the throw expression is typically a message expression that's already
1949// been rewritten! (which implies the SourceLocation's are invalid).
1950Stmt *RewriteObjC::RewriteObjCThrowStmt(ObjCAtThrowStmt *S) {
1951 // Get the start location and compute the semi location.
1952 SourceLocation startLoc = S->getBeginLoc();
1953 const char *startBuf = SM->getCharacterData(startLoc);
1954
1955 assert((*startBuf == '@') && "bogus @throw location")(((*startBuf == '@') && "bogus @throw location") ? static_cast
<void> (0) : __assert_fail ("(*startBuf == '@') && \"bogus @throw location\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1955, __PRETTY_FUNCTION__))
;
1956
1957 std::string buf;
1958 /* void objc_exception_throw(id) __attribute__((noreturn)); */
1959 if (S->getThrowExpr())
1960 buf = "objc_exception_throw(";
1961 else // add an implicit argument
1962 buf = "objc_exception_throw(_caught";
1963
1964 // handle "@ throw" correctly.
1965 const char *wBuf = strchr(startBuf, 'w');
1966 assert((*wBuf == 'w') && "@throw: can't find 'w'")(((*wBuf == 'w') && "@throw: can't find 'w'") ? static_cast
<void> (0) : __assert_fail ("(*wBuf == 'w') && \"@throw: can't find 'w'\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1966, __PRETTY_FUNCTION__))
;
1967 ReplaceText(startLoc, wBuf-startBuf+1, buf);
1968
1969 const char *semiBuf = strchr(startBuf, ';');
1970 assert((*semiBuf == ';') && "@throw: can't find ';'")(((*semiBuf == ';') && "@throw: can't find ';'") ? static_cast
<void> (0) : __assert_fail ("(*semiBuf == ';') && \"@throw: can't find ';'\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1970, __PRETTY_FUNCTION__))
;
1971 SourceLocation semiLoc = startLoc.getLocWithOffset(semiBuf-startBuf);
1972 ReplaceText(semiLoc, 1, ");");
1973 return nullptr;
1974}
1975
1976Stmt *RewriteObjC::RewriteAtEncode(ObjCEncodeExpr *Exp) {
1977 // Create a new string expression.
1978 std::string StrEncoding;
1979 Context->getObjCEncodingForType(Exp->getEncodedType(), StrEncoding);
1980 Expr *Replacement = getStringLiteral(StrEncoding);
1981 ReplaceStmt(Exp, Replacement);
1982
1983 // Replace this subexpr in the parent.
1984 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
1985 return Replacement;
1986}
1987
1988Stmt *RewriteObjC::RewriteAtSelector(ObjCSelectorExpr *Exp) {
1989 if (!SelGetUidFunctionDecl)
1990 SynthSelGetUidFunctionDecl();
1991 assert(SelGetUidFunctionDecl && "Can't find sel_registerName() decl")((SelGetUidFunctionDecl && "Can't find sel_registerName() decl"
) ? static_cast<void> (0) : __assert_fail ("SelGetUidFunctionDecl && \"Can't find sel_registerName() decl\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 1991, __PRETTY_FUNCTION__))
;
1992 // Create a call to sel_registerName("selName").
1993 SmallVector<Expr*, 8> SelExprs;
1994 SelExprs.push_back(getStringLiteral(Exp->getSelector().getAsString()));
1995 CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl,
1996 SelExprs);
1997 ReplaceStmt(Exp, SelExp);
1998 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
1999 return SelExp;
2000}
2001
2002CallExpr *
2003RewriteObjC::SynthesizeCallToFunctionDecl(FunctionDecl *FD,
2004 ArrayRef<Expr *> Args,
2005 SourceLocation StartLoc,
2006 SourceLocation EndLoc) {
2007 // Get the type, we will need to reference it in a couple spots.
2008 QualType msgSendType = FD->getType();
2009
2010 // Create a reference to the objc_msgSend() declaration.
2011 DeclRefExpr *DRE = new (Context) DeclRefExpr(*Context, FD, false, msgSendType,
2012 VK_LValue, SourceLocation());
2013
2014 // Now, we cast the reference to a pointer to the objc_msgSend type.
2015 QualType pToFunc = Context->getPointerType(msgSendType);
2016 ImplicitCastExpr *ICE =
2017 ImplicitCastExpr::Create(*Context, pToFunc, CK_FunctionToPointerDecay,
2018 DRE, nullptr, VK_RValue);
2019
2020 const FunctionType *FT = msgSendType->getAs<FunctionType>();
2021
2022 CallExpr *Exp = CallExpr::Create(
2023 *Context, ICE, Args, FT->getCallResultType(*Context), VK_RValue, EndLoc);
2024 return Exp;
2025}
2026
2027static bool scanForProtocolRefs(const char *startBuf, const char *endBuf,
2028 const char *&startRef, const char *&endRef) {
2029 while (startBuf < endBuf) {
2030 if (*startBuf == '<')
2031 startRef = startBuf; // mark the start.
2032 if (*startBuf == '>') {
2033 if (startRef && *startRef == '<') {
2034 endRef = startBuf; // mark the end.
2035 return true;
2036 }
2037 return false;
2038 }
2039 startBuf++;
2040 }
2041 return false;
2042}
2043
2044static void scanToNextArgument(const char *&argRef) {
2045 int angle = 0;
2046 while (*argRef != ')' && (*argRef != ',' || angle > 0)) {
2047 if (*argRef == '<')
2048 angle++;
2049 else if (*argRef == '>')
2050 angle--;
2051 argRef++;
2052 }
2053 assert(angle == 0 && "scanToNextArgument - bad protocol type syntax")((angle == 0 && "scanToNextArgument - bad protocol type syntax"
) ? static_cast<void> (0) : __assert_fail ("angle == 0 && \"scanToNextArgument - bad protocol type syntax\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2053, __PRETTY_FUNCTION__))
;
2054}
2055
2056bool RewriteObjC::needToScanForQualifiers(QualType T) {
2057 if (T->isObjCQualifiedIdType())
2058 return true;
2059 if (const PointerType *PT = T->getAs<PointerType>()) {
2060 if (PT->getPointeeType()->isObjCQualifiedIdType())
2061 return true;
2062 }
2063 if (T->isObjCObjectPointerType()) {
2064 T = T->getPointeeType();
2065 return T->isObjCQualifiedInterfaceType();
2066 }
2067 if (T->isArrayType()) {
2068 QualType ElemTy = Context->getBaseElementType(T);
2069 return needToScanForQualifiers(ElemTy);
2070 }
2071 return false;
2072}
2073
2074void RewriteObjC::RewriteObjCQualifiedInterfaceTypes(Expr *E) {
2075 QualType Type = E->getType();
2076 if (needToScanForQualifiers(Type)) {
2077 SourceLocation Loc, EndLoc;
2078
2079 if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E)) {
2080 Loc = ECE->getLParenLoc();
2081 EndLoc = ECE->getRParenLoc();
2082 } else {
2083 Loc = E->getBeginLoc();
2084 EndLoc = E->getEndLoc();
2085 }
2086 // This will defend against trying to rewrite synthesized expressions.
2087 if (Loc.isInvalid() || EndLoc.isInvalid())
2088 return;
2089
2090 const char *startBuf = SM->getCharacterData(Loc);
2091 const char *endBuf = SM->getCharacterData(EndLoc);
2092 const char *startRef = nullptr, *endRef = nullptr;
2093 if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) {
2094 // Get the locations of the startRef, endRef.
2095 SourceLocation LessLoc = Loc.getLocWithOffset(startRef-startBuf);
2096 SourceLocation GreaterLoc = Loc.getLocWithOffset(endRef-startBuf+1);
2097 // Comment out the protocol references.
2098 InsertText(LessLoc, "/*");
2099 InsertText(GreaterLoc, "*/");
2100 }
2101 }
2102}
2103
2104void RewriteObjC::RewriteObjCQualifiedInterfaceTypes(Decl *Dcl) {
2105 SourceLocation Loc;
2106 QualType Type;
2107 const FunctionProtoType *proto = nullptr;
2108 if (VarDecl *VD = dyn_cast<VarDecl>(Dcl)) {
2109 Loc = VD->getLocation();
2110 Type = VD->getType();
2111 }
2112 else if (FunctionDecl *FD = dyn_cast<FunctionDecl>(Dcl)) {
2113 Loc = FD->getLocation();
2114 // Check for ObjC 'id' and class types that have been adorned with protocol
2115 // information (id<p>, C<p>*). The protocol references need to be rewritten!
2116 const FunctionType *funcType = FD->getType()->getAs<FunctionType>();
2117 assert(funcType && "missing function type")((funcType && "missing function type") ? static_cast<
void> (0) : __assert_fail ("funcType && \"missing function type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2117, __PRETTY_FUNCTION__))
;
2118 proto = dyn_cast<FunctionProtoType>(funcType);
2119 if (!proto)
2120 return;
2121 Type = proto->getReturnType();
2122 }
2123 else if (FieldDecl *FD = dyn_cast<FieldDecl>(Dcl)) {
2124 Loc = FD->getLocation();
2125 Type = FD->getType();
2126 }
2127 else
2128 return;
2129
2130 if (needToScanForQualifiers(Type)) {
2131 // Since types are unique, we need to scan the buffer.
2132
2133 const char *endBuf = SM->getCharacterData(Loc);
2134 const char *startBuf = endBuf;
2135 while (*startBuf != ';' && *startBuf != '<' && startBuf != MainFileStart)
2136 startBuf--; // scan backward (from the decl location) for return type.
2137 const char *startRef = nullptr, *endRef = nullptr;
2138 if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) {
2139 // Get the locations of the startRef, endRef.
2140 SourceLocation LessLoc = Loc.getLocWithOffset(startRef-endBuf);
2141 SourceLocation GreaterLoc = Loc.getLocWithOffset(endRef-endBuf+1);
2142 // Comment out the protocol references.
2143 InsertText(LessLoc, "/*");
2144 InsertText(GreaterLoc, "*/");
2145 }
2146 }
2147 if (!proto)
2148 return; // most likely, was a variable
2149 // Now check arguments.
2150 const char *startBuf = SM->getCharacterData(Loc);
2151 const char *startFuncBuf = startBuf;
2152 for (unsigned i = 0; i < proto->getNumParams(); i++) {
2153 if (needToScanForQualifiers(proto->getParamType(i))) {
2154 // Since types are unique, we need to scan the buffer.
2155
2156 const char *endBuf = startBuf;
2157 // scan forward (from the decl location) for argument types.
2158 scanToNextArgument(endBuf);
2159 const char *startRef = nullptr, *endRef = nullptr;
2160 if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) {
2161 // Get the locations of the startRef, endRef.
2162 SourceLocation LessLoc =
2163 Loc.getLocWithOffset(startRef-startFuncBuf);
2164 SourceLocation GreaterLoc =
2165 Loc.getLocWithOffset(endRef-startFuncBuf+1);
2166 // Comment out the protocol references.
2167 InsertText(LessLoc, "/*");
2168 InsertText(GreaterLoc, "*/");
2169 }
2170 startBuf = ++endBuf;
2171 }
2172 else {
2173 // If the function name is derived from a macro expansion, then the
2174 // argument buffer will not follow the name. Need to speak with Chris.
2175 while (*startBuf && *startBuf != ')' && *startBuf != ',')
2176 startBuf++; // scan forward (from the decl location) for argument types.
2177 startBuf++;
2178 }
2179 }
2180}
2181
2182void RewriteObjC::RewriteTypeOfDecl(VarDecl *ND) {
2183 QualType QT = ND->getType();
2184 const Type* TypePtr = QT->getAs<Type>();
2185 if (!isa<TypeOfExprType>(TypePtr))
2186 return;
2187 while (isa<TypeOfExprType>(TypePtr)) {
2188 const TypeOfExprType *TypeOfExprTypePtr = cast<TypeOfExprType>(TypePtr);
2189 QT = TypeOfExprTypePtr->getUnderlyingExpr()->getType();
2190 TypePtr = QT->getAs<Type>();
2191 }
2192 // FIXME. This will not work for multiple declarators; as in:
2193 // __typeof__(a) b,c,d;
2194 std::string TypeAsString(QT.getAsString(Context->getPrintingPolicy()));
2195 SourceLocation DeclLoc = ND->getTypeSpecStartLoc();
2196 const char *startBuf = SM->getCharacterData(DeclLoc);
2197 if (ND->getInit()) {
2198 std::string Name(ND->getNameAsString());
2199 TypeAsString += " " + Name + " = ";
2200 Expr *E = ND->getInit();
2201 SourceLocation startLoc;
2202 if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E))
2203 startLoc = ECE->getLParenLoc();
2204 else
2205 startLoc = E->getBeginLoc();
2206 startLoc = SM->getExpansionLoc(startLoc);
2207 const char *endBuf = SM->getCharacterData(startLoc);
2208 ReplaceText(DeclLoc, endBuf-startBuf-1, TypeAsString);
2209 }
2210 else {
2211 SourceLocation X = ND->getEndLoc();
2212 X = SM->getExpansionLoc(X);
2213 const char *endBuf = SM->getCharacterData(X);
2214 ReplaceText(DeclLoc, endBuf-startBuf-1, TypeAsString);
2215 }
2216}
2217
2218// SynthSelGetUidFunctionDecl - SEL sel_registerName(const char *str);
2219void RewriteObjC::SynthSelGetUidFunctionDecl() {
2220 IdentifierInfo *SelGetUidIdent = &Context->Idents.get("sel_registerName");
2221 SmallVector<QualType, 16> ArgTys;
2222 ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst()));
2223 QualType getFuncType =
2224 getSimpleFunctionType(Context->getObjCSelType(), ArgTys);
2225 SelGetUidFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2226 SourceLocation(),
2227 SourceLocation(),
2228 SelGetUidIdent, getFuncType,
2229 nullptr, SC_Extern);
2230}
2231
2232void RewriteObjC::RewriteFunctionDecl(FunctionDecl *FD) {
2233 // declared in <objc/objc.h>
2234 if (FD->getIdentifier() &&
2235 FD->getName() == "sel_registerName") {
2236 SelGetUidFunctionDecl = FD;
2237 return;
2238 }
2239 RewriteObjCQualifiedInterfaceTypes(FD);
2240}
2241
2242void RewriteObjC::RewriteBlockPointerType(std::string& Str, QualType Type) {
2243 std::string TypeString(Type.getAsString(Context->getPrintingPolicy()));
2244 const char *argPtr = TypeString.c_str();
2245 if (!strchr(argPtr, '^')) {
2246 Str += TypeString;
2247 return;
2248 }
2249 while (*argPtr) {
2250 Str += (*argPtr == '^' ? '*' : *argPtr);
2251 argPtr++;
2252 }
2253}
2254
2255// FIXME. Consolidate this routine with RewriteBlockPointerType.
2256void RewriteObjC::RewriteBlockPointerTypeVariable(std::string& Str,
2257 ValueDecl *VD) {
2258 QualType Type = VD->getType();
2259 std::string TypeString(Type.getAsString(Context->getPrintingPolicy()));
2260 const char *argPtr = TypeString.c_str();
2261 int paren = 0;
2262 while (*argPtr) {
2263 switch (*argPtr) {
2264 case '(':
2265 Str += *argPtr;
2266 paren++;
2267 break;
2268 case ')':
2269 Str += *argPtr;
2270 paren--;
2271 break;
2272 case '^':
2273 Str += '*';
2274 if (paren == 1)
2275 Str += VD->getNameAsString();
2276 break;
2277 default:
2278 Str += *argPtr;
2279 break;
2280 }
2281 argPtr++;
2282 }
2283}
2284
2285void RewriteObjC::RewriteBlockLiteralFunctionDecl(FunctionDecl *FD) {
2286 SourceLocation FunLocStart = FD->getTypeSpecStartLoc();
2287 const FunctionType *funcType = FD->getType()->getAs<FunctionType>();
2288 const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(funcType);
2289 if (!proto)
2290 return;
2291 QualType Type = proto->getReturnType();
2292 std::string FdStr = Type.getAsString(Context->getPrintingPolicy());
2293 FdStr += " ";
2294 FdStr += FD->getName();
2295 FdStr += "(";
2296 unsigned numArgs = proto->getNumParams();
2297 for (unsigned i = 0; i < numArgs; i++) {
2298 QualType ArgType = proto->getParamType(i);
2299 RewriteBlockPointerType(FdStr, ArgType);
2300 if (i+1 < numArgs)
2301 FdStr += ", ";
2302 }
2303 FdStr += ");\n";
2304 InsertText(FunLocStart, FdStr);
2305 CurFunctionDeclToDeclareForBlock = nullptr;
2306}
2307
2308// SynthSuperConstructorFunctionDecl - id objc_super(id obj, id super);
2309void RewriteObjC::SynthSuperConstructorFunctionDecl() {
2310 if (SuperConstructorFunctionDecl)
2311 return;
2312 IdentifierInfo *msgSendIdent = &Context->Idents.get("__rw_objc_super");
2313 SmallVector<QualType, 16> ArgTys;
2314 QualType argT = Context->getObjCIdType();
2315 assert(!argT.isNull() && "Can't find 'id' type")((!argT.isNull() && "Can't find 'id' type") ? static_cast
<void> (0) : __assert_fail ("!argT.isNull() && \"Can't find 'id' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2315, __PRETTY_FUNCTION__))
;
2316 ArgTys.push_back(argT);
2317 ArgTys.push_back(argT);
2318 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2319 ArgTys);
2320 SuperConstructorFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2321 SourceLocation(),
2322 SourceLocation(),
2323 msgSendIdent, msgSendType,
2324 nullptr, SC_Extern);
2325}
2326
2327// SynthMsgSendFunctionDecl - id objc_msgSend(id self, SEL op, ...);
2328void RewriteObjC::SynthMsgSendFunctionDecl() {
2329 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend");
2330 SmallVector<QualType, 16> ArgTys;
2331 QualType argT = Context->getObjCIdType();
2332 assert(!argT.isNull() && "Can't find 'id' type")((!argT.isNull() && "Can't find 'id' type") ? static_cast
<void> (0) : __assert_fail ("!argT.isNull() && \"Can't find 'id' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2332, __PRETTY_FUNCTION__))
;
2333 ArgTys.push_back(argT);
2334 argT = Context->getObjCSelType();
2335 assert(!argT.isNull() && "Can't find 'SEL' type")((!argT.isNull() && "Can't find 'SEL' type") ? static_cast
<void> (0) : __assert_fail ("!argT.isNull() && \"Can't find 'SEL' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2335, __PRETTY_FUNCTION__))
;
2336 ArgTys.push_back(argT);
2337 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2338 ArgTys, /*variadic=*/true);
2339 MsgSendFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2340 SourceLocation(),
2341 SourceLocation(),
2342 msgSendIdent, msgSendType,
2343 nullptr, SC_Extern);
2344}
2345
2346// SynthMsgSendSuperFunctionDecl - id objc_msgSendSuper(struct objc_super *, SEL op, ...);
2347void RewriteObjC::SynthMsgSendSuperFunctionDecl() {
2348 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSendSuper");
2349 SmallVector<QualType, 16> ArgTys;
2350 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
2351 SourceLocation(), SourceLocation(),
2352 &Context->Idents.get("objc_super"));
2353 QualType argT = Context->getPointerType(Context->getTagDeclType(RD));
2354 assert(!argT.isNull() && "Can't build 'struct objc_super *' type")((!argT.isNull() && "Can't build 'struct objc_super *' type"
) ? static_cast<void> (0) : __assert_fail ("!argT.isNull() && \"Can't build 'struct objc_super *' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2354, __PRETTY_FUNCTION__))
;
2355 ArgTys.push_back(argT);
2356 argT = Context->getObjCSelType();
2357 assert(!argT.isNull() && "Can't find 'SEL' type")((!argT.isNull() && "Can't find 'SEL' type") ? static_cast
<void> (0) : __assert_fail ("!argT.isNull() && \"Can't find 'SEL' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2357, __PRETTY_FUNCTION__))
;
2358 ArgTys.push_back(argT);
2359 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2360 ArgTys, /*variadic=*/true);
2361 MsgSendSuperFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2362 SourceLocation(),
2363 SourceLocation(),
2364 msgSendIdent, msgSendType,
2365 nullptr, SC_Extern);
2366}
2367
2368// SynthMsgSendStretFunctionDecl - id objc_msgSend_stret(id self, SEL op, ...);
2369void RewriteObjC::SynthMsgSendStretFunctionDecl() {
2370 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend_stret");
2371 SmallVector<QualType, 16> ArgTys;
2372 QualType argT = Context->getObjCIdType();
2373 assert(!argT.isNull() && "Can't find 'id' type")((!argT.isNull() && "Can't find 'id' type") ? static_cast
<void> (0) : __assert_fail ("!argT.isNull() && \"Can't find 'id' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2373, __PRETTY_FUNCTION__))
;
2374 ArgTys.push_back(argT);
2375 argT = Context->getObjCSelType();
2376 assert(!argT.isNull() && "Can't find 'SEL' type")((!argT.isNull() && "Can't find 'SEL' type") ? static_cast
<void> (0) : __assert_fail ("!argT.isNull() && \"Can't find 'SEL' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2376, __PRETTY_FUNCTION__))
;
2377 ArgTys.push_back(argT);
2378 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2379 ArgTys, /*variadic=*/true);
2380 MsgSendStretFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2381 SourceLocation(),
2382 SourceLocation(),
2383 msgSendIdent, msgSendType,
2384 nullptr, SC_Extern);
2385}
2386
2387// SynthMsgSendSuperStretFunctionDecl -
2388// id objc_msgSendSuper_stret(struct objc_super *, SEL op, ...);
2389void RewriteObjC::SynthMsgSendSuperStretFunctionDecl() {
2390 IdentifierInfo *msgSendIdent =
2391 &Context->Idents.get("objc_msgSendSuper_stret");
2392 SmallVector<QualType, 16> ArgTys;
2393 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
2394 SourceLocation(), SourceLocation(),
2395 &Context->Idents.get("objc_super"));
2396 QualType argT = Context->getPointerType(Context->getTagDeclType(RD));
2397 assert(!argT.isNull() && "Can't build 'struct objc_super *' type")((!argT.isNull() && "Can't build 'struct objc_super *' type"
) ? static_cast<void> (0) : __assert_fail ("!argT.isNull() && \"Can't build 'struct objc_super *' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2397, __PRETTY_FUNCTION__))
;
2398 ArgTys.push_back(argT);
2399 argT = Context->getObjCSelType();
2400 assert(!argT.isNull() && "Can't find 'SEL' type")((!argT.isNull() && "Can't find 'SEL' type") ? static_cast
<void> (0) : __assert_fail ("!argT.isNull() && \"Can't find 'SEL' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2400, __PRETTY_FUNCTION__))
;
2401 ArgTys.push_back(argT);
2402 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2403 ArgTys, /*variadic=*/true);
2404 MsgSendSuperStretFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2405 SourceLocation(),
2406 SourceLocation(),
2407 msgSendIdent,
2408 msgSendType, nullptr,
2409 SC_Extern);
2410}
2411
2412// SynthMsgSendFpretFunctionDecl - double objc_msgSend_fpret(id self, SEL op, ...);
2413void RewriteObjC::SynthMsgSendFpretFunctionDecl() {
2414 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend_fpret");
2415 SmallVector<QualType, 16> ArgTys;
2416 QualType argT = Context->getObjCIdType();
2417 assert(!argT.isNull() && "Can't find 'id' type")((!argT.isNull() && "Can't find 'id' type") ? static_cast
<void> (0) : __assert_fail ("!argT.isNull() && \"Can't find 'id' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2417, __PRETTY_FUNCTION__))
;
2418 ArgTys.push_back(argT);
2419 argT = Context->getObjCSelType();
2420 assert(!argT.isNull() && "Can't find 'SEL' type")((!argT.isNull() && "Can't find 'SEL' type") ? static_cast
<void> (0) : __assert_fail ("!argT.isNull() && \"Can't find 'SEL' type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2420, __PRETTY_FUNCTION__))
;
2421 ArgTys.push_back(argT);
2422 QualType msgSendType = getSimpleFunctionType(Context->DoubleTy,
2423 ArgTys, /*variadic=*/true);
2424 MsgSendFpretFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2425 SourceLocation(),
2426 SourceLocation(),
2427 msgSendIdent, msgSendType,
2428 nullptr, SC_Extern);
2429}
2430
2431// SynthGetClassFunctionDecl - id objc_getClass(const char *name);
2432void RewriteObjC::SynthGetClassFunctionDecl() {
2433 IdentifierInfo *getClassIdent = &Context->Idents.get("objc_getClass");
2434 SmallVector<QualType, 16> ArgTys;
2435 ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst()));
2436 QualType getClassType = getSimpleFunctionType(Context->getObjCIdType(),
2437 ArgTys);
2438 GetClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2439 SourceLocation(),
2440 SourceLocation(),
2441 getClassIdent, getClassType,
2442 nullptr, SC_Extern);
2443}
2444
2445// SynthGetSuperClassFunctionDecl - Class class_getSuperclass(Class cls);
2446void RewriteObjC::SynthGetSuperClassFunctionDecl() {
2447 IdentifierInfo *getSuperClassIdent =
2448 &Context->Idents.get("class_getSuperclass");
2449 SmallVector<QualType, 16> ArgTys;
2450 ArgTys.push_back(Context->getObjCClassType());
2451 QualType getClassType = getSimpleFunctionType(Context->getObjCClassType(),
2452 ArgTys);
2453 GetSuperClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2454 SourceLocation(),
2455 SourceLocation(),
2456 getSuperClassIdent,
2457 getClassType, nullptr,
2458 SC_Extern);
2459}
2460
2461// SynthGetMetaClassFunctionDecl - id objc_getMetaClass(const char *name);
2462void RewriteObjC::SynthGetMetaClassFunctionDecl() {
2463 IdentifierInfo *getClassIdent = &Context->Idents.get("objc_getMetaClass");
2464 SmallVector<QualType, 16> ArgTys;
2465 ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst()));
2466 QualType getClassType = getSimpleFunctionType(Context->getObjCIdType(),
2467 ArgTys);
2468 GetMetaClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2469 SourceLocation(),
2470 SourceLocation(),
2471 getClassIdent, getClassType,
2472 nullptr, SC_Extern);
2473}
2474
2475Stmt *RewriteObjC::RewriteObjCStringLiteral(ObjCStringLiteral *Exp) {
2476 assert(Exp != nullptr && "Expected non-null ObjCStringLiteral")((Exp != nullptr && "Expected non-null ObjCStringLiteral"
) ? static_cast<void> (0) : __assert_fail ("Exp != nullptr && \"Expected non-null ObjCStringLiteral\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2476, __PRETTY_FUNCTION__))
;
2477 QualType strType = getConstantStringStructType();
2478
2479 std::string S = "__NSConstantStringImpl_";
2480
2481 std::string tmpName = InFileName;
2482 unsigned i;
2483 for (i=0; i < tmpName.length(); i++) {
2484 char c = tmpName.at(i);
2485 // replace any non-alphanumeric characters with '_'.
2486 if (!isAlphanumeric(c))
2487 tmpName[i] = '_';
2488 }
2489 S += tmpName;
2490 S += "_";
2491 S += utostr(NumObjCStringLiterals++);
2492
2493 Preamble += "static __NSConstantStringImpl " + S;
2494 Preamble += " __attribute__ ((section (\"__DATA, __cfstring\"))) = {__CFConstantStringClassReference,";
2495 Preamble += "0x000007c8,"; // utf8_str
2496 // The pretty printer for StringLiteral handles escape characters properly.
2497 std::string prettyBufS;
2498 llvm::raw_string_ostream prettyBuf(prettyBufS);
2499 Exp->getString()->printPretty(prettyBuf, nullptr, PrintingPolicy(LangOpts));
2500 Preamble += prettyBuf.str();
2501 Preamble += ",";
2502 Preamble += utostr(Exp->getString()->getByteLength()) + "};\n";
2503
2504 VarDecl *NewVD = VarDecl::Create(*Context, TUDecl, SourceLocation(),
2505 SourceLocation(), &Context->Idents.get(S),
2506 strType, nullptr, SC_Static);
2507 DeclRefExpr *DRE = new (Context)
2508 DeclRefExpr(*Context, NewVD, false, strType, VK_LValue, SourceLocation());
2509 Expr *Unop = new (Context)
2510 UnaryOperator(DRE, UO_AddrOf, Context->getPointerType(DRE->getType()),
2511 VK_RValue, OK_Ordinary, SourceLocation(), false);
2512 // cast to NSConstantString *
2513 CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, Exp->getType(),
2514 CK_CPointerToObjCPointerCast, Unop);
2515 ReplaceStmt(Exp, cast);
2516 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
2517 return cast;
2518}
2519
2520// struct objc_super { struct objc_object *receiver; struct objc_class *super; };
2521QualType RewriteObjC::getSuperStructType() {
2522 if (!SuperStructDecl) {
2523 SuperStructDecl = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
2524 SourceLocation(), SourceLocation(),
2525 &Context->Idents.get("objc_super"));
2526 QualType FieldTypes[2];
2527
2528 // struct objc_object *receiver;
2529 FieldTypes[0] = Context->getObjCIdType();
2530 // struct objc_class *super;
2531 FieldTypes[1] = Context->getObjCClassType();
2532
2533 // Create fields
2534 for (unsigned i = 0; i < 2; ++i) {
2535 SuperStructDecl->addDecl(FieldDecl::Create(*Context, SuperStructDecl,
2536 SourceLocation(),
2537 SourceLocation(), nullptr,
2538 FieldTypes[i], nullptr,
2539 /*BitWidth=*/nullptr,
2540 /*Mutable=*/false,
2541 ICIS_NoInit));
2542 }
2543
2544 SuperStructDecl->completeDefinition();
2545 }
2546 return Context->getTagDeclType(SuperStructDecl);
2547}
2548
2549QualType RewriteObjC::getConstantStringStructType() {
2550 if (!ConstantStringDecl) {
2551 ConstantStringDecl = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
2552 SourceLocation(), SourceLocation(),
2553 &Context->Idents.get("__NSConstantStringImpl"));
2554 QualType FieldTypes[4];
2555
2556 // struct objc_object *receiver;
2557 FieldTypes[0] = Context->getObjCIdType();
2558 // int flags;
2559 FieldTypes[1] = Context->IntTy;
2560 // char *str;
2561 FieldTypes[2] = Context->getPointerType(Context->CharTy);
2562 // long length;
2563 FieldTypes[3] = Context->LongTy;
2564
2565 // Create fields
2566 for (unsigned i = 0; i < 4; ++i) {
2567 ConstantStringDecl->addDecl(FieldDecl::Create(*Context,
2568 ConstantStringDecl,
2569 SourceLocation(),
2570 SourceLocation(), nullptr,
2571 FieldTypes[i], nullptr,
2572 /*BitWidth=*/nullptr,
2573 /*Mutable=*/true,
2574 ICIS_NoInit));
2575 }
2576
2577 ConstantStringDecl->completeDefinition();
2578 }
2579 return Context->getTagDeclType(ConstantStringDecl);
2580}
2581
2582CallExpr *RewriteObjC::SynthMsgSendStretCallExpr(FunctionDecl *MsgSendStretFlavor,
2583 QualType msgSendType,
2584 QualType returnType,
2585 SmallVectorImpl<QualType> &ArgTypes,
2586 SmallVectorImpl<Expr*> &MsgExprs,
2587 ObjCMethodDecl *Method) {
2588 // Create a reference to the objc_msgSend_stret() declaration.
2589 DeclRefExpr *STDRE =
2590 new (Context) DeclRefExpr(*Context, MsgSendStretFlavor, false,
2591 msgSendType, VK_LValue, SourceLocation());
2592 // Need to cast objc_msgSend_stret to "void *" (see above comment).
2593 CastExpr *cast = NoTypeInfoCStyleCastExpr(Context,
2594 Context->getPointerType(Context->VoidTy),
2595 CK_BitCast, STDRE);
2596 // Now do the "normal" pointer to function cast.
2597 QualType castType = getSimpleFunctionType(returnType, ArgTypes,
2598 Method ? Method->isVariadic()
2599 : false);
2600 castType = Context->getPointerType(castType);
2601 cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast,
2602 cast);
2603
2604 // Don't forget the parens to enforce the proper binding.
2605 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), cast);
2606
2607 const FunctionType *FT = msgSendType->getAs<FunctionType>();
2608 CallExpr *STCE = CallExpr::Create(*Context, PE, MsgExprs, FT->getReturnType(),
2609 VK_RValue, SourceLocation());
2610 return STCE;
2611}
2612
2613Stmt *RewriteObjC::SynthMessageExpr(ObjCMessageExpr *Exp,
2614 SourceLocation StartLoc,
2615 SourceLocation EndLoc) {
2616 if (!SelGetUidFunctionDecl)
2617 SynthSelGetUidFunctionDecl();
2618 if (!MsgSendFunctionDecl)
2619 SynthMsgSendFunctionDecl();
2620 if (!MsgSendSuperFunctionDecl)
2621 SynthMsgSendSuperFunctionDecl();
2622 if (!MsgSendStretFunctionDecl)
2623 SynthMsgSendStretFunctionDecl();
2624 if (!MsgSendSuperStretFunctionDecl)
2625 SynthMsgSendSuperStretFunctionDecl();
2626 if (!MsgSendFpretFunctionDecl)
2627 SynthMsgSendFpretFunctionDecl();
2628 if (!GetClassFunctionDecl)
2629 SynthGetClassFunctionDecl();
2630 if (!GetSuperClassFunctionDecl)
2631 SynthGetSuperClassFunctionDecl();
2632 if (!GetMetaClassFunctionDecl)
2633 SynthGetMetaClassFunctionDecl();
2634
2635 // default to objc_msgSend().
2636 FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl;
2637 // May need to use objc_msgSend_stret() as well.
2638 FunctionDecl *MsgSendStretFlavor = nullptr;
2639 if (ObjCMethodDecl *mDecl = Exp->getMethodDecl()) {
2640 QualType resultType = mDecl->getReturnType();
2641 if (resultType->isRecordType())
2642 MsgSendStretFlavor = MsgSendStretFunctionDecl;
2643 else if (resultType->isRealFloatingType())
2644 MsgSendFlavor = MsgSendFpretFunctionDecl;
2645 }
2646
2647 // Synthesize a call to objc_msgSend().
2648 SmallVector<Expr*, 8> MsgExprs;
2649 switch (Exp->getReceiverKind()) {
2650 case ObjCMessageExpr::SuperClass: {
2651 MsgSendFlavor = MsgSendSuperFunctionDecl;
2652 if (MsgSendStretFlavor)
2653 MsgSendStretFlavor = MsgSendSuperStretFunctionDecl;
2654 assert(MsgSendFlavor && "MsgSendFlavor is NULL!")((MsgSendFlavor && "MsgSendFlavor is NULL!") ? static_cast
<void> (0) : __assert_fail ("MsgSendFlavor && \"MsgSendFlavor is NULL!\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2654, __PRETTY_FUNCTION__))
;
2655
2656 ObjCInterfaceDecl *ClassDecl = CurMethodDef->getClassInterface();
2657
2658 SmallVector<Expr*, 4> InitExprs;
2659
2660 // set the receiver to self, the first argument to all methods.
2661 InitExprs.push_back(
2662 NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(),
2663 CK_BitCast,
2664 new (Context) DeclRefExpr(*Context,
2665 CurMethodDef->getSelfDecl(),
2666 false,
2667 Context->getObjCIdType(),
2668 VK_RValue,
2669 SourceLocation()))
2670 ); // set the 'receiver'.
2671
2672 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass"))
2673 SmallVector<Expr*, 8> ClsExprs;
2674 ClsExprs.push_back(getStringLiteral(ClassDecl->getIdentifier()->getName()));
2675 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetMetaClassFunctionDecl,
2676 ClsExprs, StartLoc, EndLoc);
2677 // (Class)objc_getClass("CurrentClass")
2678 CastExpr *ArgExpr = NoTypeInfoCStyleCastExpr(Context,
2679 Context->getObjCClassType(),
2680 CK_BitCast, Cls);
2681 ClsExprs.clear();
2682 ClsExprs.push_back(ArgExpr);
2683 Cls = SynthesizeCallToFunctionDecl(GetSuperClassFunctionDecl, ClsExprs,
2684 StartLoc, EndLoc);
2685 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass"))
2686 // To turn off a warning, type-cast to 'id'
2687 InitExprs.push_back( // set 'super class', using class_getSuperclass().
2688 NoTypeInfoCStyleCastExpr(Context,
2689 Context->getObjCIdType(),
2690 CK_BitCast, Cls));
2691 // struct objc_super
2692 QualType superType = getSuperStructType();
2693 Expr *SuperRep;
2694
2695 if (LangOpts.MicrosoftExt) {
2696 SynthSuperConstructorFunctionDecl();
2697 // Simulate a constructor call...
2698 DeclRefExpr *DRE = new (Context)
2699 DeclRefExpr(*Context, SuperConstructorFunctionDecl, false, superType,
2700 VK_LValue, SourceLocation());
2701 SuperRep = CallExpr::Create(*Context, DRE, InitExprs, superType,
2702 VK_LValue, SourceLocation());
2703 // The code for super is a little tricky to prevent collision with
2704 // the structure definition in the header. The rewriter has it's own
2705 // internal definition (__rw_objc_super) that is uses. This is why
2706 // we need the cast below. For example:
2707 // (struct objc_super *)&__rw_objc_super((id)self, (id)objc_getClass("SUPER"))
2708 //
2709 SuperRep = new (Context) UnaryOperator(SuperRep, UO_AddrOf,
2710 Context->getPointerType(SuperRep->getType()),
2711 VK_RValue, OK_Ordinary,
2712 SourceLocation(), false);
2713 SuperRep = NoTypeInfoCStyleCastExpr(Context,
2714 Context->getPointerType(superType),
2715 CK_BitCast, SuperRep);
2716 } else {
2717 // (struct objc_super) { <exprs from above> }
2718 InitListExpr *ILE =
2719 new (Context) InitListExpr(*Context, SourceLocation(), InitExprs,
2720 SourceLocation());
2721 TypeSourceInfo *superTInfo
2722 = Context->getTrivialTypeSourceInfo(superType);
2723 SuperRep = new (Context) CompoundLiteralExpr(SourceLocation(), superTInfo,
2724 superType, VK_LValue,
2725 ILE, false);
2726 // struct objc_super *
2727 SuperRep = new (Context) UnaryOperator(SuperRep, UO_AddrOf,
2728 Context->getPointerType(SuperRep->getType()),
2729 VK_RValue, OK_Ordinary,
2730 SourceLocation(), false);
2731 }
2732 MsgExprs.push_back(SuperRep);
2733 break;
2734 }
2735
2736 case ObjCMessageExpr::Class: {
2737 SmallVector<Expr*, 8> ClsExprs;
2738 ObjCInterfaceDecl *Class
2739 = Exp->getClassReceiver()->getAs<ObjCObjectType>()->getInterface();
2740 IdentifierInfo *clsName = Class->getIdentifier();
2741 ClsExprs.push_back(getStringLiteral(clsName->getName()));
2742 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs,
2743 StartLoc, EndLoc);
2744 MsgExprs.push_back(Cls);
2745 break;
2746 }
2747
2748 case ObjCMessageExpr::SuperInstance:{
2749 MsgSendFlavor = MsgSendSuperFunctionDecl;
2750 if (MsgSendStretFlavor)
2751 MsgSendStretFlavor = MsgSendSuperStretFunctionDecl;
2752 assert(MsgSendFlavor && "MsgSendFlavor is NULL!")((MsgSendFlavor && "MsgSendFlavor is NULL!") ? static_cast
<void> (0) : __assert_fail ("MsgSendFlavor && \"MsgSendFlavor is NULL!\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 2752, __PRETTY_FUNCTION__))
;
2753 ObjCInterfaceDecl *ClassDecl = CurMethodDef->getClassInterface();
2754 SmallVector<Expr*, 4> InitExprs;
2755
2756 InitExprs.push_back(
2757 NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(),
2758 CK_BitCast,
2759 new (Context) DeclRefExpr(*Context,
2760 CurMethodDef->getSelfDecl(),
2761 false,
2762 Context->getObjCIdType(),
2763 VK_RValue, SourceLocation()))
2764 ); // set the 'receiver'.
2765
2766 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass"))
2767 SmallVector<Expr*, 8> ClsExprs;
2768 ClsExprs.push_back(getStringLiteral(ClassDecl->getIdentifier()->getName()));
2769 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs,
2770 StartLoc, EndLoc);
2771 // (Class)objc_getClass("CurrentClass")
2772 CastExpr *ArgExpr = NoTypeInfoCStyleCastExpr(Context,
2773 Context->getObjCClassType(),
2774 CK_BitCast, Cls);
2775 ClsExprs.clear();
2776 ClsExprs.push_back(ArgExpr);
2777 Cls = SynthesizeCallToFunctionDecl(GetSuperClassFunctionDecl, ClsExprs,
2778 StartLoc, EndLoc);
2779
2780 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass"))
2781 // To turn off a warning, type-cast to 'id'
2782 InitExprs.push_back(
2783 // set 'super class', using class_getSuperclass().
2784 NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(),
2785 CK_BitCast, Cls));
2786 // struct objc_super
2787 QualType superType = getSuperStructType();
2788 Expr *SuperRep;
2789
2790 if (LangOpts.MicrosoftExt) {
2791 SynthSuperConstructorFunctionDecl();
2792 // Simulate a constructor call...
2793 DeclRefExpr *DRE = new (Context)
2794 DeclRefExpr(*Context, SuperConstructorFunctionDecl, false, superType,
2795 VK_LValue, SourceLocation());
2796 SuperRep = CallExpr::Create(*Context, DRE, InitExprs, superType,
2797 VK_LValue, SourceLocation());
2798 // The code for super is a little tricky to prevent collision with
2799 // the structure definition in the header. The rewriter has it's own
2800 // internal definition (__rw_objc_super) that is uses. This is why
2801 // we need the cast below. For example:
2802 // (struct objc_super *)&__rw_objc_super((id)self, (id)objc_getClass("SUPER"))
2803 //
2804 SuperRep = new (Context) UnaryOperator(SuperRep, UO_AddrOf,
2805 Context->getPointerType(SuperRep->getType()),
2806 VK_RValue, OK_Ordinary,
2807 SourceLocation(), false);
2808 SuperRep = NoTypeInfoCStyleCastExpr(Context,
2809 Context->getPointerType(superType),
2810 CK_BitCast, SuperRep);
2811 } else {
2812 // (struct objc_super) { <exprs from above> }
2813 InitListExpr *ILE =
2814 new (Context) InitListExpr(*Context, SourceLocation(), InitExprs,
2815 SourceLocation());
2816 TypeSourceInfo *superTInfo
2817 = Context->getTrivialTypeSourceInfo(superType);
2818 SuperRep = new (Context) CompoundLiteralExpr(SourceLocation(), superTInfo,
2819 superType, VK_RValue, ILE,
2820 false);
2821 }
2822 MsgExprs.push_back(SuperRep);
2823 break;
2824 }
2825
2826 case ObjCMessageExpr::Instance: {
2827 // Remove all type-casts because it may contain objc-style types; e.g.
2828 // Foo<Proto> *.
2829 Expr *recExpr = Exp->getInstanceReceiver();
2830 while (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(recExpr))
2831 recExpr = CE->getSubExpr();
2832 CastKind CK = recExpr->getType()->isObjCObjectPointerType()
2833 ? CK_BitCast : recExpr->getType()->isBlockPointerType()
2834 ? CK_BlockPointerToObjCPointerCast
2835 : CK_CPointerToObjCPointerCast;
2836
2837 recExpr = NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(),
2838 CK, recExpr);
2839 MsgExprs.push_back(recExpr);
2840 break;
2841 }
2842 }
2843
2844 // Create a call to sel_registerName("selName"), it will be the 2nd argument.
2845 SmallVector<Expr*, 8> SelExprs;
2846 SelExprs.push_back(getStringLiteral(Exp->getSelector().getAsString()));
2847 CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl,
2848 SelExprs, StartLoc, EndLoc);
2849 MsgExprs.push_back(SelExp);
2850
2851 // Now push any user supplied arguments.
2852 for (unsigned i = 0; i < Exp->getNumArgs(); i++) {
2853 Expr *userExpr = Exp->getArg(i);
2854 // Make all implicit casts explicit...ICE comes in handy:-)
2855 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(userExpr)) {
2856 // Reuse the ICE type, it is exactly what the doctor ordered.
2857 QualType type = ICE->getType();
2858 if (needToScanForQualifiers(type))
2859 type = Context->getObjCIdType();
2860 // Make sure we convert "type (^)(...)" to "type (*)(...)".
2861 (void)convertBlockPointerToFunctionPointer(type);
2862 const Expr *SubExpr = ICE->IgnoreParenImpCasts();
2863 CastKind CK;
2864 if (SubExpr->getType()->isIntegralType(*Context) &&
2865 type->isBooleanType()) {
2866 CK = CK_IntegralToBoolean;
2867 } else if (type->isObjCObjectPointerType()) {
2868 if (SubExpr->getType()->isBlockPointerType()) {
2869 CK = CK_BlockPointerToObjCPointerCast;
2870 } else if (SubExpr->getType()->isPointerType()) {
2871 CK = CK_CPointerToObjCPointerCast;
2872 } else {
2873 CK = CK_BitCast;
2874 }
2875 } else {
2876 CK = CK_BitCast;
2877 }
2878
2879 userExpr = NoTypeInfoCStyleCastExpr(Context, type, CK, userExpr);
2880 }
2881 // Make id<P...> cast into an 'id' cast.
2882 else if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(userExpr)) {
2883 if (CE->getType()->isObjCQualifiedIdType()) {
2884 while ((CE = dyn_cast<CStyleCastExpr>(userExpr)))
2885 userExpr = CE->getSubExpr();
2886 CastKind CK;
2887 if (userExpr->getType()->isIntegralType(*Context)) {
2888 CK = CK_IntegralToPointer;
2889 } else if (userExpr->getType()->isBlockPointerType()) {
2890 CK = CK_BlockPointerToObjCPointerCast;
2891 } else if (userExpr->getType()->isPointerType()) {
2892 CK = CK_CPointerToObjCPointerCast;
2893 } else {
2894 CK = CK_BitCast;
2895 }
2896 userExpr = NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(),
2897 CK, userExpr);
2898 }
2899 }
2900 MsgExprs.push_back(userExpr);
2901 // We've transferred the ownership to MsgExprs. For now, we *don't* null
2902 // out the argument in the original expression (since we aren't deleting
2903 // the ObjCMessageExpr). See RewritePropertyOrImplicitSetter() usage for more info.
2904 //Exp->setArg(i, 0);
2905 }
2906 // Generate the funky cast.
2907 CastExpr *cast;
2908 SmallVector<QualType, 8> ArgTypes;
2909 QualType returnType;
2910
2911 // Push 'id' and 'SEL', the 2 implicit arguments.
2912 if (MsgSendFlavor == MsgSendSuperFunctionDecl)
2913 ArgTypes.push_back(Context->getPointerType(getSuperStructType()));
2914 else
2915 ArgTypes.push_back(Context->getObjCIdType());
2916 ArgTypes.push_back(Context->getObjCSelType());
2917 if (ObjCMethodDecl *OMD = Exp->getMethodDecl()) {
2918 // Push any user argument types.
2919 for (const auto *PI : OMD->parameters()) {
2920 QualType t = PI->getType()->isObjCQualifiedIdType()
2921 ? Context->getObjCIdType()
2922 : PI->getType();
2923 // Make sure we convert "t (^)(...)" to "t (*)(...)".
2924 (void)convertBlockPointerToFunctionPointer(t);
2925 ArgTypes.push_back(t);
2926 }
2927 returnType = Exp->getType();
2928 convertToUnqualifiedObjCType(returnType);
2929 (void)convertBlockPointerToFunctionPointer(returnType);
2930 } else {
2931 returnType = Context->getObjCIdType();
2932 }
2933 // Get the type, we will need to reference it in a couple spots.
2934 QualType msgSendType = MsgSendFlavor->getType();
2935
2936 // Create a reference to the objc_msgSend() declaration.
2937 DeclRefExpr *DRE = new (Context) DeclRefExpr(
2938 *Context, MsgSendFlavor, false, msgSendType, VK_LValue, SourceLocation());
2939
2940 // Need to cast objc_msgSend to "void *" (to workaround a GCC bandaid).
2941 // If we don't do this cast, we get the following bizarre warning/note:
2942 // xx.m:13: warning: function called through a non-compatible type
2943 // xx.m:13: note: if this code is reached, the program will abort
2944 cast = NoTypeInfoCStyleCastExpr(Context,
2945 Context->getPointerType(Context->VoidTy),
2946 CK_BitCast, DRE);
2947
2948 // Now do the "normal" pointer to function cast.
2949 // If we don't have a method decl, force a variadic cast.
2950 const ObjCMethodDecl *MD = Exp->getMethodDecl();
2951 QualType castType =
2952 getSimpleFunctionType(returnType, ArgTypes, MD ? MD->isVariadic() : true);
2953 castType = Context->getPointerType(castType);
2954 cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast,
2955 cast);
2956
2957 // Don't forget the parens to enforce the proper binding.
2958 ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast);
2959
2960 const FunctionType *FT = msgSendType->getAs<FunctionType>();
2961 CallExpr *CE = CallExpr::Create(*Context, PE, MsgExprs, FT->getReturnType(),
2962 VK_RValue, EndLoc);
2963 Stmt *ReplacingStmt = CE;
2964 if (MsgSendStretFlavor) {
2965 // We have the method which returns a struct/union. Must also generate
2966 // call to objc_msgSend_stret and hang both varieties on a conditional
2967 // expression which dictate which one to envoke depending on size of
2968 // method's return type.
2969
2970 CallExpr *STCE = SynthMsgSendStretCallExpr(MsgSendStretFlavor,
2971 msgSendType, returnType,
2972 ArgTypes, MsgExprs,
2973 Exp->getMethodDecl());
2974
2975 // Build sizeof(returnType)
2976 UnaryExprOrTypeTraitExpr *sizeofExpr =
2977 new (Context) UnaryExprOrTypeTraitExpr(UETT_SizeOf,
2978 Context->getTrivialTypeSourceInfo(returnType),
2979 Context->getSizeType(), SourceLocation(),
2980 SourceLocation());
2981 // (sizeof(returnType) <= 8 ? objc_msgSend(...) : objc_msgSend_stret(...))
2982 // FIXME: Value of 8 is base on ppc32/x86 ABI for the most common cases.
2983 // For X86 it is more complicated and some kind of target specific routine
2984 // is needed to decide what to do.
2985 unsigned IntSize =
2986 static_cast<unsigned>(Context->getTypeSize(Context->IntTy));
2987 IntegerLiteral *limit = IntegerLiteral::Create(*Context,
2988 llvm::APInt(IntSize, 8),
2989 Context->IntTy,
2990 SourceLocation());
2991 BinaryOperator *lessThanExpr =
2992 new (Context) BinaryOperator(sizeofExpr, limit, BO_LE, Context->IntTy,
2993 VK_RValue, OK_Ordinary, SourceLocation(),
2994 FPOptions());
2995 // (sizeof(returnType) <= 8 ? objc_msgSend(...) : objc_msgSend_stret(...))
2996 ConditionalOperator *CondExpr =
2997 new (Context) ConditionalOperator(lessThanExpr,
2998 SourceLocation(), CE,
2999 SourceLocation(), STCE,
3000 returnType, VK_RValue, OK_Ordinary);
3001 ReplacingStmt = new (Context) ParenExpr(SourceLocation(), SourceLocation(),
3002 CondExpr);
3003 }
3004 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
3005 return ReplacingStmt;
3006}
3007
3008Stmt *RewriteObjC::RewriteMessageExpr(ObjCMessageExpr *Exp) {
3009 Stmt *ReplacingStmt =
3010 SynthMessageExpr(Exp, Exp->getBeginLoc(), Exp->getEndLoc());
3011
3012 // Now do the actual rewrite.
3013 ReplaceStmt(Exp, ReplacingStmt);
3014
3015 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
3016 return ReplacingStmt;
3017}
3018
3019// typedef struct objc_object Protocol;
3020QualType RewriteObjC::getProtocolType() {
3021 if (!ProtocolTypeDecl) {
3022 TypeSourceInfo *TInfo
3023 = Context->getTrivialTypeSourceInfo(Context->getObjCIdType());
3024 ProtocolTypeDecl = TypedefDecl::Create(*Context, TUDecl,
3025 SourceLocation(), SourceLocation(),
3026 &Context->Idents.get("Protocol"),
3027 TInfo);
3028 }
3029 return Context->getTypeDeclType(ProtocolTypeDecl);
3030}
3031
3032/// RewriteObjCProtocolExpr - Rewrite a protocol expression into
3033/// a synthesized/forward data reference (to the protocol's metadata).
3034/// The forward references (and metadata) are generated in
3035/// RewriteObjC::HandleTranslationUnit().
3036Stmt *RewriteObjC::RewriteObjCProtocolExpr(ObjCProtocolExpr *Exp) {
3037 std::string Name = "_OBJC_PROTOCOL_" + Exp->getProtocol()->getNameAsString();
3038 IdentifierInfo *ID = &Context->Idents.get(Name);
3039 VarDecl *VD = VarDecl::Create(*Context, TUDecl, SourceLocation(),
3040 SourceLocation(), ID, getProtocolType(),
3041 nullptr, SC_Extern);
3042 DeclRefExpr *DRE = new (Context) DeclRefExpr(
3043 *Context, VD, false, getProtocolType(), VK_LValue, SourceLocation());
3044 Expr *DerefExpr = new (Context) UnaryOperator(DRE, UO_AddrOf,
3045 Context->getPointerType(DRE->getType()),
3046 VK_RValue, OK_Ordinary, SourceLocation(), false);
3047 CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, DerefExpr->getType(),
3048 CK_BitCast,
3049 DerefExpr);
3050 ReplaceStmt(Exp, castExpr);
3051 ProtocolExprDecls.insert(Exp->getProtocol()->getCanonicalDecl());
3052 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
3053 return castExpr;
3054}
3055
3056bool RewriteObjC::BufferContainsPPDirectives(const char *startBuf,
3057 const char *endBuf) {
3058 while (startBuf < endBuf) {
3059 if (*startBuf == '#') {
3060 // Skip whitespace.
3061 for (++startBuf; startBuf[0] == ' ' || startBuf[0] == '\t'; ++startBuf)
3062 ;
3063 if (!strncmp(startBuf, "if", strlen("if")) ||
3064 !strncmp(startBuf, "ifdef", strlen("ifdef")) ||
3065 !strncmp(startBuf, "ifndef", strlen("ifndef")) ||
3066 !strncmp(startBuf, "define", strlen("define")) ||
3067 !strncmp(startBuf, "undef", strlen("undef")) ||
3068 !strncmp(startBuf, "else", strlen("else")) ||
3069 !strncmp(startBuf, "elif", strlen("elif")) ||
3070 !strncmp(startBuf, "endif", strlen("endif")) ||
3071 !strncmp(startBuf, "pragma", strlen("pragma")) ||
3072 !strncmp(startBuf, "include", strlen("include")) ||
3073 !strncmp(startBuf, "import", strlen("import")) ||
3074 !strncmp(startBuf, "include_next", strlen("include_next")))
3075 return true;
3076 }
3077 startBuf++;
3078 }
3079 return false;
3080}
3081
3082/// RewriteObjCInternalStruct - Rewrite one internal struct corresponding to
3083/// an objective-c class with ivars.
3084void RewriteObjC::RewriteObjCInternalStruct(ObjCInterfaceDecl *CDecl,
3085 std::string &Result) {
3086 assert(CDecl && "Class missing in SynthesizeObjCInternalStruct")((CDecl && "Class missing in SynthesizeObjCInternalStruct"
) ? static_cast<void> (0) : __assert_fail ("CDecl && \"Class missing in SynthesizeObjCInternalStruct\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3086, __PRETTY_FUNCTION__))
;
3087 assert(CDecl->getName() != "" &&((CDecl->getName() != "" && "Name missing in SynthesizeObjCInternalStruct"
) ? static_cast<void> (0) : __assert_fail ("CDecl->getName() != \"\" && \"Name missing in SynthesizeObjCInternalStruct\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3088, __PRETTY_FUNCTION__))
3088 "Name missing in SynthesizeObjCInternalStruct")((CDecl->getName() != "" && "Name missing in SynthesizeObjCInternalStruct"
) ? static_cast<void> (0) : __assert_fail ("CDecl->getName() != \"\" && \"Name missing in SynthesizeObjCInternalStruct\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3088, __PRETTY_FUNCTION__))
;
3089 // Do not synthesize more than once.
3090 if (ObjCSynthesizedStructs.count(CDecl))
3091 return;
3092 ObjCInterfaceDecl *RCDecl = CDecl->getSuperClass();
3093 int NumIvars = CDecl->ivar_size();
3094 SourceLocation LocStart = CDecl->getBeginLoc();
3095 SourceLocation LocEnd = CDecl->getEndOfDefinitionLoc();
3096
3097 const char *startBuf = SM->getCharacterData(LocStart);
3098 const char *endBuf = SM->getCharacterData(LocEnd);
3099
3100 // If no ivars and no root or if its root, directly or indirectly,
3101 // have no ivars (thus not synthesized) then no need to synthesize this class.
3102 if ((!CDecl->isThisDeclarationADefinition() || NumIvars == 0) &&
3103 (!RCDecl || !ObjCSynthesizedStructs.count(RCDecl))) {
3104 endBuf += Lexer::MeasureTokenLength(LocEnd, *SM, LangOpts);
3105 ReplaceText(LocStart, endBuf-startBuf, Result);
3106 return;
3107 }
3108
3109 // FIXME: This has potential of causing problem. If
3110 // SynthesizeObjCInternalStruct is ever called recursively.
3111 Result += "\nstruct ";
3112 Result += CDecl->getNameAsString();
3113 if (LangOpts.MicrosoftExt)
3114 Result += "_IMPL";
3115
3116 if (NumIvars > 0) {
3117 const char *cursor = strchr(startBuf, '{');
3118 assert((cursor && endBuf)(((cursor && endBuf) && "SynthesizeObjCInternalStruct - malformed @interface"
) ? static_cast<void> (0) : __assert_fail ("(cursor && endBuf) && \"SynthesizeObjCInternalStruct - malformed @interface\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3119, __PRETTY_FUNCTION__))
3119 && "SynthesizeObjCInternalStruct - malformed @interface")(((cursor && endBuf) && "SynthesizeObjCInternalStruct - malformed @interface"
) ? static_cast<void> (0) : __assert_fail ("(cursor && endBuf) && \"SynthesizeObjCInternalStruct - malformed @interface\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3119, __PRETTY_FUNCTION__))
;
3120 // If the buffer contains preprocessor directives, we do more fine-grained
3121 // rewrites. This is intended to fix code that looks like (which occurs in
3122 // NSURL.h, for example):
3123 //
3124 // #ifdef XYZ
3125 // @interface Foo : NSObject
3126 // #else
3127 // @interface FooBar : NSObject
3128 // #endif
3129 // {
3130 // int i;
3131 // }
3132 // @end
3133 //
3134 // This clause is segregated to avoid breaking the common case.
3135 if (BufferContainsPPDirectives(startBuf, cursor)) {
3136 SourceLocation L = RCDecl ? CDecl->getSuperClassLoc() :
3137 CDecl->getAtStartLoc();
3138 const char *endHeader = SM->getCharacterData(L);
3139 endHeader += Lexer::MeasureTokenLength(L, *SM, LangOpts);
3140
3141 if (CDecl->protocol_begin() != CDecl->protocol_end()) {
3142 // advance to the end of the referenced protocols.
3143 while (endHeader < cursor && *endHeader != '>') endHeader++;
3144 endHeader++;
3145 }
3146 // rewrite the original header
3147 ReplaceText(LocStart, endHeader-startBuf, Result);
3148 } else {
3149 // rewrite the original header *without* disturbing the '{'
3150 ReplaceText(LocStart, cursor-startBuf, Result);
3151 }
3152 if (RCDecl && ObjCSynthesizedStructs.count(RCDecl)) {
3153 Result = "\n struct ";
3154 Result += RCDecl->getNameAsString();
3155 Result += "_IMPL ";
3156 Result += RCDecl->getNameAsString();
3157 Result += "_IVARS;\n";
3158
3159 // insert the super class structure definition.
3160 SourceLocation OnePastCurly =
3161 LocStart.getLocWithOffset(cursor-startBuf+1);
3162 InsertText(OnePastCurly, Result);
3163 }
3164 cursor++; // past '{'
3165
3166 // Now comment out any visibility specifiers.
3167 while (cursor < endBuf) {
3168 if (*cursor == '@') {
3169 SourceLocation atLoc = LocStart.getLocWithOffset(cursor-startBuf);
3170 // Skip whitespace.
3171 for (++cursor; cursor[0] == ' ' || cursor[0] == '\t'; ++cursor)
3172 /*scan*/;
3173
3174 // FIXME: presence of @public, etc. inside comment results in
3175 // this transformation as well, which is still correct c-code.
3176 if (!strncmp(cursor, "public", strlen("public")) ||
3177 !strncmp(cursor, "private", strlen("private")) ||
3178 !strncmp(cursor, "package", strlen("package")) ||
3179 !strncmp(cursor, "protected", strlen("protected")))
3180 InsertText(atLoc, "// ");
3181 }
3182 // FIXME: If there are cases where '<' is used in ivar declaration part
3183 // of user code, then scan the ivar list and use needToScanForQualifiers
3184 // for type checking.
3185 else if (*cursor == '<') {
3186 SourceLocation atLoc = LocStart.getLocWithOffset(cursor-startBuf);
3187 InsertText(atLoc, "/* ");
3188 cursor = strchr(cursor, '>');
3189 cursor++;
3190 atLoc = LocStart.getLocWithOffset(cursor-startBuf);
3191 InsertText(atLoc, " */");
3192 } else if (*cursor == '^') { // rewrite block specifier.
3193 SourceLocation caretLoc = LocStart.getLocWithOffset(cursor-startBuf);
3194 ReplaceText(caretLoc, 1, "*");
3195 }
3196 cursor++;
3197 }
3198 // Don't forget to add a ';'!!
3199 InsertText(LocEnd.getLocWithOffset(1), ";");
3200 } else { // we don't have any instance variables - insert super struct.
3201 endBuf += Lexer::MeasureTokenLength(LocEnd, *SM, LangOpts);
3202 Result += " {\n struct ";
3203 Result += RCDecl->getNameAsString();
3204 Result += "_IMPL ";
3205 Result += RCDecl->getNameAsString();
3206 Result += "_IVARS;\n};\n";
3207 ReplaceText(LocStart, endBuf-startBuf, Result);
3208 }
3209 // Mark this struct as having been generated.
3210 if (!ObjCSynthesizedStructs.insert(CDecl).second)
3211 llvm_unreachable("struct already synthesize- SynthesizeObjCInternalStruct")::llvm::llvm_unreachable_internal("struct already synthesize- SynthesizeObjCInternalStruct"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3211)
;
3212}
3213
3214//===----------------------------------------------------------------------===//
3215// Meta Data Emission
3216//===----------------------------------------------------------------------===//
3217
3218/// RewriteImplementations - This routine rewrites all method implementations
3219/// and emits meta-data.
3220
3221void RewriteObjC::RewriteImplementations() {
3222 int ClsDefCount = ClassImplementation.size();
3223 int CatDefCount = CategoryImplementation.size();
3224
3225 // Rewrite implemented methods
3226 for (int i = 0; i < ClsDefCount; i++)
3227 RewriteImplementationDecl(ClassImplementation[i]);
3228
3229 for (int i = 0; i < CatDefCount; i++)
3230 RewriteImplementationDecl(CategoryImplementation[i]);
3231}
3232
3233void RewriteObjC::RewriteByRefString(std::string &ResultStr,
3234 const std::string &Name,
3235 ValueDecl *VD, bool def) {
3236 assert(BlockByRefDeclNo.count(VD) &&((BlockByRefDeclNo.count(VD) && "RewriteByRefString: ByRef decl missing"
) ? static_cast<void> (0) : __assert_fail ("BlockByRefDeclNo.count(VD) && \"RewriteByRefString: ByRef decl missing\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3237, __PRETTY_FUNCTION__))
3237 "RewriteByRefString: ByRef decl missing")((BlockByRefDeclNo.count(VD) && "RewriteByRefString: ByRef decl missing"
) ? static_cast<void> (0) : __assert_fail ("BlockByRefDeclNo.count(VD) && \"RewriteByRefString: ByRef decl missing\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3237, __PRETTY_FUNCTION__))
;
3238 if (def)
3239 ResultStr += "struct ";
3240 ResultStr += "__Block_byref_" + Name +
3241 "_" + utostr(BlockByRefDeclNo[VD]) ;
3242}
3243
3244static bool HasLocalVariableExternalStorage(ValueDecl *VD) {
3245 if (VarDecl *Var = dyn_cast<VarDecl>(VD))
3246 return (Var->isFunctionOrMethodVarDecl() && !Var->hasLocalStorage());
3247 return false;
3248}
3249
3250std::string RewriteObjC::SynthesizeBlockFunc(BlockExpr *CE, int i,
3251 StringRef funcName,
3252 std::string Tag) {
3253 const FunctionType *AFT = CE->getFunctionType();
3254 QualType RT = AFT->getReturnType();
3255 std::string StructRef = "struct " + Tag;
3256 std::string S = "static " + RT.getAsString(Context->getPrintingPolicy()) + " __" +
3257 funcName.str() + "_" + "block_func_" + utostr(i);
3258
3259 BlockDecl *BD = CE->getBlockDecl();
3260
3261 if (isa<FunctionNoProtoType>(AFT)) {
3262 // No user-supplied arguments. Still need to pass in a pointer to the
3263 // block (to reference imported block decl refs).
3264 S += "(" + StructRef + " *__cself)";
3265 } else if (BD->param_empty()) {
3266 S += "(" + StructRef + " *__cself)";
3267 } else {
3268 const FunctionProtoType *FT = cast<FunctionProtoType>(AFT);
3269 assert(FT && "SynthesizeBlockFunc: No function proto")((FT && "SynthesizeBlockFunc: No function proto") ? static_cast
<void> (0) : __assert_fail ("FT && \"SynthesizeBlockFunc: No function proto\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3269, __PRETTY_FUNCTION__))
;
3270 S += '(';
3271 // first add the implicit argument.
3272 S += StructRef + " *__cself, ";
3273 std::string ParamStr;
3274 for (BlockDecl::param_iterator AI = BD->param_begin(),
3275 E = BD->param_end(); AI != E; ++AI) {
3276 if (AI != BD->param_begin()) S += ", ";
3277 ParamStr = (*AI)->getNameAsString();
3278 QualType QT = (*AI)->getType();
3279 (void)convertBlockPointerToFunctionPointer(QT);
3280 QT.getAsStringInternal(ParamStr, Context->getPrintingPolicy());
3281 S += ParamStr;
3282 }
3283 if (FT->isVariadic()) {
3284 if (!BD->param_empty()) S += ", ";
3285 S += "...";
3286 }
3287 S += ')';
3288 }
3289 S += " {\n";
3290
3291 // Create local declarations to avoid rewriting all closure decl ref exprs.
3292 // First, emit a declaration for all "by ref" decls.
3293 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(),
3294 E = BlockByRefDecls.end(); I != E; ++I) {
3295 S += " ";
3296 std::string Name = (*I)->getNameAsString();
3297 std::string TypeString;
3298 RewriteByRefString(TypeString, Name, (*I));
3299 TypeString += " *";
3300 Name = TypeString + Name;
3301 S += Name + " = __cself->" + (*I)->getNameAsString() + "; // bound by ref\n";
3302 }
3303 // Next, emit a declaration for all "by copy" declarations.
3304 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(),
3305 E = BlockByCopyDecls.end(); I != E; ++I) {
3306 S += " ";
3307 // Handle nested closure invocation. For example:
3308 //
3309 // void (^myImportedClosure)(void);
3310 // myImportedClosure = ^(void) { setGlobalInt(x + y); };
3311 //
3312 // void (^anotherClosure)(void);
3313 // anotherClosure = ^(void) {
3314 // myImportedClosure(); // import and invoke the closure
3315 // };
3316 //
3317 if (isTopLevelBlockPointerType((*I)->getType())) {
3318 RewriteBlockPointerTypeVariable(S, (*I));
3319 S += " = (";
3320 RewriteBlockPointerType(S, (*I)->getType());
3321 S += ")";
3322 S += "__cself->" + (*I)->getNameAsString() + "; // bound by copy\n";
3323 }
3324 else {
3325 std::string Name = (*I)->getNameAsString();
3326 QualType QT = (*I)->getType();
3327 if (HasLocalVariableExternalStorage(*I))
3328 QT = Context->getPointerType(QT);
3329 QT.getAsStringInternal(Name, Context->getPrintingPolicy());
3330 S += Name + " = __cself->" +
3331 (*I)->getNameAsString() + "; // bound by copy\n";
3332 }
3333 }
3334 std::string RewrittenStr = RewrittenBlockExprs[CE];
3335 const char *cstr = RewrittenStr.c_str();
3336 while (*cstr++ != '{') ;
3337 S += cstr;
3338 S += "\n";
3339 return S;
3340}
3341
3342std::string RewriteObjC::SynthesizeBlockHelperFuncs(BlockExpr *CE, int i,
3343 StringRef funcName,
3344 std::string Tag) {
3345 std::string StructRef = "struct " + Tag;
3346 std::string S = "static void __";
3347
3348 S += funcName;
3349 S += "_block_copy_" + utostr(i);
3350 S += "(" + StructRef;
3351 S += "*dst, " + StructRef;
3352 S += "*src) {";
3353 for (ValueDecl *VD : ImportedBlockDecls) {
3354 S += "_Block_object_assign((void*)&dst->";
3355 S += VD->getNameAsString();
3356 S += ", (void*)src->";
3357 S += VD->getNameAsString();
3358 if (BlockByRefDeclsPtrSet.count(VD))
3359 S += ", " + utostr(BLOCK_FIELD_IS_BYREF) + "/*BLOCK_FIELD_IS_BYREF*/);";
3360 else if (VD->getType()->isBlockPointerType())
3361 S += ", " + utostr(BLOCK_FIELD_IS_BLOCK) + "/*BLOCK_FIELD_IS_BLOCK*/);";
3362 else
3363 S += ", " + utostr(BLOCK_FIELD_IS_OBJECT) + "/*BLOCK_FIELD_IS_OBJECT*/);";
3364 }
3365 S += "}\n";
3366
3367 S += "\nstatic void __";
3368 S += funcName;
3369 S += "_block_dispose_" + utostr(i);
3370 S += "(" + StructRef;
3371 S += "*src) {";
3372 for (ValueDecl *VD : ImportedBlockDecls) {
3373 S += "_Block_object_dispose((void*)src->";
3374 S += VD->getNameAsString();
3375 if (BlockByRefDeclsPtrSet.count(VD))
3376 S += ", " + utostr(BLOCK_FIELD_IS_BYREF) + "/*BLOCK_FIELD_IS_BYREF*/);";
3377 else if (VD->getType()->isBlockPointerType())
3378 S += ", " + utostr(BLOCK_FIELD_IS_BLOCK) + "/*BLOCK_FIELD_IS_BLOCK*/);";
3379 else
3380 S += ", " + utostr(BLOCK_FIELD_IS_OBJECT) + "/*BLOCK_FIELD_IS_OBJECT*/);";
3381 }
3382 S += "}\n";
3383 return S;
3384}
3385
3386std::string RewriteObjC::SynthesizeBlockImpl(BlockExpr *CE, std::string Tag,
3387 std::string Desc) {
3388 std::string S = "\nstruct " + Tag;
3389 std::string Constructor = " " + Tag;
3390
3391 S += " {\n struct __block_impl impl;\n";
3392 S += " struct " + Desc;
3393 S += "* Desc;\n";
3394
3395 Constructor += "(void *fp, "; // Invoke function pointer.
3396 Constructor += "struct " + Desc; // Descriptor pointer.
3397 Constructor += " *desc";
3398
3399 if (BlockDeclRefs.size()) {
3400 // Output all "by copy" declarations.
3401 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(),
3402 E = BlockByCopyDecls.end(); I != E; ++I) {
3403 S += " ";
3404 std::string FieldName = (*I)->getNameAsString();
3405 std::string ArgName = "_" + FieldName;
3406 // Handle nested closure invocation. For example:
3407 //
3408 // void (^myImportedBlock)(void);
3409 // myImportedBlock = ^(void) { setGlobalInt(x + y); };
3410 //
3411 // void (^anotherBlock)(void);
3412 // anotherBlock = ^(void) {
3413 // myImportedBlock(); // import and invoke the closure
3414 // };
3415 //
3416 if (isTopLevelBlockPointerType((*I)->getType())) {
3417 S += "struct __block_impl *";
3418 Constructor += ", void *" + ArgName;
3419 } else {
3420 QualType QT = (*I)->getType();
3421 if (HasLocalVariableExternalStorage(*I))
3422 QT = Context->getPointerType(QT);
3423 QT.getAsStringInternal(FieldName, Context->getPrintingPolicy());
3424 QT.getAsStringInternal(ArgName, Context->getPrintingPolicy());
3425 Constructor += ", " + ArgName;
3426 }
3427 S += FieldName + ";\n";
3428 }
3429 // Output all "by ref" declarations.
3430 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(),
3431 E = BlockByRefDecls.end(); I != E; ++I) {
3432 S += " ";
3433 std::string FieldName = (*I)->getNameAsString();
3434 std::string ArgName = "_" + FieldName;
3435 {
3436 std::string TypeString;
3437 RewriteByRefString(TypeString, FieldName, (*I));
3438 TypeString += " *";
3439 FieldName = TypeString + FieldName;
3440 ArgName = TypeString + ArgName;
3441 Constructor += ", " + ArgName;
3442 }
3443 S += FieldName + "; // by ref\n";
3444 }
3445 // Finish writing the constructor.
3446 Constructor += ", int flags=0)";
3447 // Initialize all "by copy" arguments.
3448 bool firsTime = true;
3449 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(),
3450 E = BlockByCopyDecls.end(); I != E; ++I) {
3451 std::string Name = (*I)->getNameAsString();
3452 if (firsTime) {
3453 Constructor += " : ";
3454 firsTime = false;
3455 }
3456 else
3457 Constructor += ", ";
3458 if (isTopLevelBlockPointerType((*I)->getType()))
3459 Constructor += Name + "((struct __block_impl *)_" + Name + ")";
3460 else
3461 Constructor += Name + "(_" + Name + ")";
3462 }
3463 // Initialize all "by ref" arguments.
3464 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(),
3465 E = BlockByRefDecls.end(); I != E; ++I) {
3466 std::string Name = (*I)->getNameAsString();
3467 if (firsTime) {
3468 Constructor += " : ";
3469 firsTime = false;
3470 }
3471 else
3472 Constructor += ", ";
3473 Constructor += Name + "(_" + Name + "->__forwarding)";
3474 }
3475
3476 Constructor += " {\n";
3477 if (GlobalVarDecl)
3478 Constructor += " impl.isa = &_NSConcreteGlobalBlock;\n";
3479 else
3480 Constructor += " impl.isa = &_NSConcreteStackBlock;\n";
3481 Constructor += " impl.Flags = flags;\n impl.FuncPtr = fp;\n";
3482
3483 Constructor += " Desc = desc;\n";
3484 } else {
3485 // Finish writing the constructor.
3486 Constructor += ", int flags=0) {\n";
3487 if (GlobalVarDecl)
3488 Constructor += " impl.isa = &_NSConcreteGlobalBlock;\n";
3489 else
3490 Constructor += " impl.isa = &_NSConcreteStackBlock;\n";
3491 Constructor += " impl.Flags = flags;\n impl.FuncPtr = fp;\n";
3492 Constructor += " Desc = desc;\n";
3493 }
3494 Constructor += " ";
3495 Constructor += "}\n";
3496 S += Constructor;
3497 S += "};\n";
3498 return S;
3499}
3500
3501std::string RewriteObjC::SynthesizeBlockDescriptor(std::string DescTag,
3502 std::string ImplTag, int i,
3503 StringRef FunName,
3504 unsigned hasCopy) {
3505 std::string S = "\nstatic struct " + DescTag;
3506
3507 S += " {\n unsigned long reserved;\n";
3508 S += " unsigned long Block_size;\n";
3509 if (hasCopy) {
3510 S += " void (*copy)(struct ";
3511 S += ImplTag; S += "*, struct ";
3512 S += ImplTag; S += "*);\n";
3513
3514 S += " void (*dispose)(struct ";
3515 S += ImplTag; S += "*);\n";
3516 }
3517 S += "} ";
3518
3519 S += DescTag + "_DATA = { 0, sizeof(struct ";
3520 S += ImplTag + ")";
3521 if (hasCopy) {
3522 S += ", __" + FunName.str() + "_block_copy_" + utostr(i);
3523 S += ", __" + FunName.str() + "_block_dispose_" + utostr(i);
3524 }
3525 S += "};\n";
3526 return S;
3527}
3528
3529void RewriteObjC::SynthesizeBlockLiterals(SourceLocation FunLocStart,
3530 StringRef FunName) {
3531 // Insert declaration for the function in which block literal is used.
3532 if (CurFunctionDeclToDeclareForBlock && !Blocks.empty())
3533 RewriteBlockLiteralFunctionDecl(CurFunctionDeclToDeclareForBlock);
3534 bool RewriteSC = (GlobalVarDecl &&
3535 !Blocks.empty() &&
3536 GlobalVarDecl->getStorageClass() == SC_Static &&
3537 GlobalVarDecl->getType().getCVRQualifiers());
3538 if (RewriteSC) {
3539 std::string SC(" void __");
3540 SC += GlobalVarDecl->getNameAsString();
3541 SC += "() {}";
3542 InsertText(FunLocStart, SC);
3543 }
3544
3545 // Insert closures that were part of the function.
3546 for (unsigned i = 0, count=0; i < Blocks.size(); i++) {
3547 CollectBlockDeclRefInfo(Blocks[i]);
3548 // Need to copy-in the inner copied-in variables not actually used in this
3549 // block.
3550 for (int j = 0; j < InnerDeclRefsCount[i]; j++) {
3551 DeclRefExpr *Exp = InnerDeclRefs[count++];
3552 ValueDecl *VD = Exp->getDecl();
3553 BlockDeclRefs.push_back(Exp);
3554 if (!VD->hasAttr<BlocksAttr>() && !BlockByCopyDeclsPtrSet.count(VD)) {
3555 BlockByCopyDeclsPtrSet.insert(VD);
3556 BlockByCopyDecls.push_back(VD);
3557 }
3558 if (VD->hasAttr<BlocksAttr>() && !BlockByRefDeclsPtrSet.count(VD)) {
3559 BlockByRefDeclsPtrSet.insert(VD);
3560 BlockByRefDecls.push_back(VD);
3561 }
3562 // imported objects in the inner blocks not used in the outer
3563 // blocks must be copied/disposed in the outer block as well.
3564 if (VD->hasAttr<BlocksAttr>() ||
3565 VD->getType()->isObjCObjectPointerType() ||
3566 VD->getType()->isBlockPointerType())
3567 ImportedBlockDecls.insert(VD);
3568 }
3569
3570 std::string ImplTag = "__" + FunName.str() + "_block_impl_" + utostr(i);
3571 std::string DescTag = "__" + FunName.str() + "_block_desc_" + utostr(i);
3572
3573 std::string CI = SynthesizeBlockImpl(Blocks[i], ImplTag, DescTag);
3574
3575 InsertText(FunLocStart, CI);
3576
3577 std::string CF = SynthesizeBlockFunc(Blocks[i], i, FunName, ImplTag);
3578
3579 InsertText(FunLocStart, CF);
3580
3581 if (ImportedBlockDecls.size()) {
3582 std::string HF = SynthesizeBlockHelperFuncs(Blocks[i], i, FunName, ImplTag);
3583 InsertText(FunLocStart, HF);
3584 }
3585 std::string BD = SynthesizeBlockDescriptor(DescTag, ImplTag, i, FunName,
3586 ImportedBlockDecls.size() > 0);
3587 InsertText(FunLocStart, BD);
3588
3589 BlockDeclRefs.clear();
3590 BlockByRefDecls.clear();
3591 BlockByRefDeclsPtrSet.clear();
3592 BlockByCopyDecls.clear();
3593 BlockByCopyDeclsPtrSet.clear();
3594 ImportedBlockDecls.clear();
3595 }
3596 if (RewriteSC) {
3597 // Must insert any 'const/volatile/static here. Since it has been
3598 // removed as result of rewriting of block literals.
3599 std::string SC;
3600 if (GlobalVarDecl->getStorageClass() == SC_Static)
3601 SC = "static ";
3602 if (GlobalVarDecl->getType().isConstQualified())
3603 SC += "const ";
3604 if (GlobalVarDecl->getType().isVolatileQualified())
3605 SC += "volatile ";
3606 if (GlobalVarDecl->getType().isRestrictQualified())
3607 SC += "restrict ";
3608 InsertText(FunLocStart, SC);
3609 }
3610
3611 Blocks.clear();
3612 InnerDeclRefsCount.clear();
3613 InnerDeclRefs.clear();
3614 RewrittenBlockExprs.clear();
3615}
3616
3617void RewriteObjC::InsertBlockLiteralsWithinFunction(FunctionDecl *FD) {
3618 SourceLocation FunLocStart = FD->getTypeSpecStartLoc();
3619 StringRef FuncName = FD->getName();
3620
3621 SynthesizeBlockLiterals(FunLocStart, FuncName);
3622}
3623
3624static void BuildUniqueMethodName(std::string &Name,
3625 ObjCMethodDecl *MD) {
3626 ObjCInterfaceDecl *IFace = MD->getClassInterface();
3627 Name = IFace->getName();
3628 Name += "__" + MD->getSelector().getAsString();
3629 // Convert colons to underscores.
3630 std::string::size_type loc = 0;
3631 while ((loc = Name.find(':', loc)) != std::string::npos)
3632 Name.replace(loc, 1, "_");
3633}
3634
3635void RewriteObjC::InsertBlockLiteralsWithinMethod(ObjCMethodDecl *MD) {
3636 // fprintf(stderr,"In InsertBlockLiteralsWitinMethod\n");
3637 // SourceLocation FunLocStart = MD->getBeginLoc();
3638 SourceLocation FunLocStart = MD->getBeginLoc();
3639 std::string FuncName;
3640 BuildUniqueMethodName(FuncName, MD);
3641 SynthesizeBlockLiterals(FunLocStart, FuncName);
3642}
3643
3644void RewriteObjC::GetBlockDeclRefExprs(Stmt *S) {
3645 for (Stmt *SubStmt : S->children())
3646 if (SubStmt) {
3647 if (BlockExpr *CBE = dyn_cast<BlockExpr>(SubStmt))
3648 GetBlockDeclRefExprs(CBE->getBody());
3649 else
3650 GetBlockDeclRefExprs(SubStmt);
3651 }
3652 // Handle specific things.
3653 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S))
3654 if (DRE->refersToEnclosingVariableOrCapture() ||
3655 HasLocalVariableExternalStorage(DRE->getDecl()))
3656 // FIXME: Handle enums.
3657 BlockDeclRefs.push_back(DRE);
3658}
3659
3660void RewriteObjC::GetInnerBlockDeclRefExprs(Stmt *S,
3661 SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs,
3662 llvm::SmallPtrSetImpl<const DeclContext *> &InnerContexts) {
3663 for (Stmt *SubStmt : S->children())
3664 if (SubStmt) {
3665 if (BlockExpr *CBE = dyn_cast<BlockExpr>(SubStmt)) {
3666 InnerContexts.insert(cast<DeclContext>(CBE->getBlockDecl()));
3667 GetInnerBlockDeclRefExprs(CBE->getBody(),
3668 InnerBlockDeclRefs,
3669 InnerContexts);
3670 }
3671 else
3672 GetInnerBlockDeclRefExprs(SubStmt, InnerBlockDeclRefs, InnerContexts);
3673 }
3674 // Handle specific things.
3675 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) {
3676 if (DRE->refersToEnclosingVariableOrCapture() ||
3677 HasLocalVariableExternalStorage(DRE->getDecl())) {
3678 if (!InnerContexts.count(DRE->getDecl()->getDeclContext()))
3679 InnerBlockDeclRefs.push_back(DRE);
3680 if (VarDecl *Var = cast<VarDecl>(DRE->getDecl()))
3681 if (Var->isFunctionOrMethodVarDecl())
3682 ImportedLocalExternalDecls.insert(Var);
3683 }
3684 }
3685}
3686
3687/// convertFunctionTypeOfBlocks - This routine converts a function type
3688/// whose result type may be a block pointer or whose argument type(s)
3689/// might be block pointers to an equivalent function type replacing
3690/// all block pointers to function pointers.
3691QualType RewriteObjC::convertFunctionTypeOfBlocks(const FunctionType *FT) {
3692 const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(FT);
3693 // FTP will be null for closures that don't take arguments.
3694 // Generate a funky cast.
3695 SmallVector<QualType, 8> ArgTypes;
3696 QualType Res = FT->getReturnType();
3697 bool HasBlockType = convertBlockPointerToFunctionPointer(Res);
3698
3699 if (FTP) {
3700 for (auto &I : FTP->param_types()) {
3701 QualType t = I;
3702 // Make sure we convert "t (^)(...)" to "t (*)(...)".
3703 if (convertBlockPointerToFunctionPointer(t))
3704 HasBlockType = true;
3705 ArgTypes.push_back(t);
3706 }
3707 }
3708 QualType FuncType;
3709 // FIXME. Does this work if block takes no argument but has a return type
3710 // which is of block type?
3711 if (HasBlockType)
3712 FuncType = getSimpleFunctionType(Res, ArgTypes);
3713 else FuncType = QualType(FT, 0);
3714 return FuncType;
3715}
3716
3717Stmt *RewriteObjC::SynthesizeBlockCall(CallExpr *Exp, const Expr *BlockExp) {
3718 // Navigate to relevant type information.
3719 const BlockPointerType *CPT = nullptr;
3720
3721 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(BlockExp)) {
3722 CPT = DRE->getType()->getAs<BlockPointerType>();
3723 } else if (const MemberExpr *MExpr = dyn_cast<MemberExpr>(BlockExp)) {
3724 CPT = MExpr->getType()->getAs<BlockPointerType>();
3725 }
3726 else if (const ParenExpr *PRE = dyn_cast<ParenExpr>(BlockExp)) {
3727 return SynthesizeBlockCall(Exp, PRE->getSubExpr());
3728 }
3729 else if (const ImplicitCastExpr *IEXPR = dyn_cast<ImplicitCastExpr>(BlockExp))
3730 CPT = IEXPR->getType()->getAs<BlockPointerType>();
3731 else if (const ConditionalOperator *CEXPR =
3732 dyn_cast<ConditionalOperator>(BlockExp)) {
3733 Expr *LHSExp = CEXPR->getLHS();
3734 Stmt *LHSStmt = SynthesizeBlockCall(Exp, LHSExp);
3735 Expr *RHSExp = CEXPR->getRHS();
3736 Stmt *RHSStmt = SynthesizeBlockCall(Exp, RHSExp);
3737 Expr *CONDExp = CEXPR->getCond();
3738 ConditionalOperator *CondExpr =
3739 new (Context) ConditionalOperator(CONDExp,
3740 SourceLocation(), cast<Expr>(LHSStmt),
3741 SourceLocation(), cast<Expr>(RHSStmt),
3742 Exp->getType(), VK_RValue, OK_Ordinary);
3743 return CondExpr;
3744 } else if (const ObjCIvarRefExpr *IRE = dyn_cast<ObjCIvarRefExpr>(BlockExp)) {
3745 CPT = IRE->getType()->getAs<BlockPointerType>();
3746 } else if (const PseudoObjectExpr *POE
3747 = dyn_cast<PseudoObjectExpr>(BlockExp)) {
3748 CPT = POE->getType()->castAs<BlockPointerType>();
3749 } else {
3750 assert(false && "RewriteBlockClass: Bad type")((false && "RewriteBlockClass: Bad type") ? static_cast
<void> (0) : __assert_fail ("false && \"RewriteBlockClass: Bad type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3750, __PRETTY_FUNCTION__))
;
3751 }
3752 assert(CPT && "RewriteBlockClass: Bad type")((CPT && "RewriteBlockClass: Bad type") ? static_cast
<void> (0) : __assert_fail ("CPT && \"RewriteBlockClass: Bad type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3752, __PRETTY_FUNCTION__))
;
3753 const FunctionType *FT = CPT->getPointeeType()->getAs<FunctionType>();
3754 assert(FT && "RewriteBlockClass: Bad type")((FT && "RewriteBlockClass: Bad type") ? static_cast<
void> (0) : __assert_fail ("FT && \"RewriteBlockClass: Bad type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3754, __PRETTY_FUNCTION__))
;
3755 const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(FT);
3756 // FTP will be null for closures that don't take arguments.
3757
3758 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
3759 SourceLocation(), SourceLocation(),
3760 &Context->Idents.get("__block_impl"));
3761 QualType PtrBlock = Context->getPointerType(Context->getTagDeclType(RD));
3762
3763 // Generate a funky cast.
3764 SmallVector<QualType, 8> ArgTypes;
3765
3766 // Push the block argument type.
3767 ArgTypes.push_back(PtrBlock);
3768 if (FTP) {
3769 for (auto &I : FTP->param_types()) {
3770 QualType t = I;
3771 // Make sure we convert "t (^)(...)" to "t (*)(...)".
3772 if (!convertBlockPointerToFunctionPointer(t))
3773 convertToUnqualifiedObjCType(t);
3774 ArgTypes.push_back(t);
3775 }
3776 }
3777 // Now do the pointer to function cast.
3778 QualType PtrToFuncCastType = getSimpleFunctionType(Exp->getType(), ArgTypes);
3779
3780 PtrToFuncCastType = Context->getPointerType(PtrToFuncCastType);
3781
3782 CastExpr *BlkCast = NoTypeInfoCStyleCastExpr(Context, PtrBlock,
3783 CK_BitCast,
3784 const_cast<Expr*>(BlockExp));
3785 // Don't forget the parens to enforce the proper binding.
3786 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(),
3787 BlkCast);
3788 //PE->dump();
3789
3790 FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(),
3791 SourceLocation(),
3792 &Context->Idents.get("FuncPtr"),
3793 Context->VoidPtrTy, nullptr,
3794 /*BitWidth=*/nullptr, /*Mutable=*/true,
3795 ICIS_NoInit);
3796 MemberExpr *ME = MemberExpr::CreateImplicit(
3797 *Context, PE, true, FD, FD->getType(), VK_LValue, OK_Ordinary);
3798
3799 CastExpr *FunkCast = NoTypeInfoCStyleCastExpr(Context, PtrToFuncCastType,
3800 CK_BitCast, ME);
3801 PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), FunkCast);
3802
3803 SmallVector<Expr*, 8> BlkExprs;
3804 // Add the implicit argument.
3805 BlkExprs.push_back(BlkCast);
3806 // Add the user arguments.
3807 for (CallExpr::arg_iterator I = Exp->arg_begin(),
3808 E = Exp->arg_end(); I != E; ++I) {
3809 BlkExprs.push_back(*I);
3810 }
3811 CallExpr *CE = CallExpr::Create(*Context, PE, BlkExprs, Exp->getType(),
3812 VK_RValue, SourceLocation());
3813 return CE;
3814}
3815
3816// We need to return the rewritten expression to handle cases where the
3817// BlockDeclRefExpr is embedded in another expression being rewritten.
3818// For example:
3819//
3820// int main() {
3821// __block Foo *f;
3822// __block int i;
3823//
3824// void (^myblock)() = ^() {
3825// [f test]; // f is a BlockDeclRefExpr embedded in a message (which is being rewritten).
3826// i = 77;
3827// };
3828//}
3829Stmt *RewriteObjC::RewriteBlockDeclRefExpr(DeclRefExpr *DeclRefExp) {
3830 // Rewrite the byref variable into BYREFVAR->__forwarding->BYREFVAR
3831 // for each DeclRefExp where BYREFVAR is name of the variable.
3832 ValueDecl *VD = DeclRefExp->getDecl();
3833 bool isArrow = DeclRefExp->refersToEnclosingVariableOrCapture() ||
3834 HasLocalVariableExternalStorage(DeclRefExp->getDecl());
3835
3836 FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(),
3837 SourceLocation(),
3838 &Context->Idents.get("__forwarding"),
3839 Context->VoidPtrTy, nullptr,
3840 /*BitWidth=*/nullptr, /*Mutable=*/true,
3841 ICIS_NoInit);
3842 MemberExpr *ME =
3843 MemberExpr::CreateImplicit(*Context, DeclRefExp, isArrow, FD,
3844 FD->getType(), VK_LValue, OK_Ordinary);
3845
3846 StringRef Name = VD->getName();
3847 FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), SourceLocation(),
3848 &Context->Idents.get(Name),
3849 Context->VoidPtrTy, nullptr,
3850 /*BitWidth=*/nullptr, /*Mutable=*/true,
3851 ICIS_NoInit);
3852 ME = MemberExpr::CreateImplicit(*Context, ME, true, FD, DeclRefExp->getType(),
3853 VK_LValue, OK_Ordinary);
3854
3855 // Need parens to enforce precedence.
3856 ParenExpr *PE = new (Context) ParenExpr(DeclRefExp->getExprLoc(),
3857 DeclRefExp->getExprLoc(),
3858 ME);
3859 ReplaceStmt(DeclRefExp, PE);
3860 return PE;
3861}
3862
3863// Rewrites the imported local variable V with external storage
3864// (static, extern, etc.) as *V
3865//
3866Stmt *RewriteObjC::RewriteLocalVariableExternalStorage(DeclRefExpr *DRE) {
3867 ValueDecl *VD = DRE->getDecl();
3868 if (VarDecl *Var = dyn_cast<VarDecl>(VD))
3869 if (!ImportedLocalExternalDecls.count(Var))
3870 return DRE;
3871 Expr *Exp = new (Context) UnaryOperator(DRE, UO_Deref, DRE->getType(),
3872 VK_LValue, OK_Ordinary,
3873 DRE->getLocation(), false);
3874 // Need parens to enforce precedence.
3875 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(),
3876 Exp);
3877 ReplaceStmt(DRE, PE);
3878 return PE;
3879}
3880
3881void RewriteObjC::RewriteCastExpr(CStyleCastExpr *CE) {
3882 SourceLocation LocStart = CE->getLParenLoc();
3883 SourceLocation LocEnd = CE->getRParenLoc();
3884
3885 // Need to avoid trying to rewrite synthesized casts.
3886 if (LocStart.isInvalid())
3887 return;
3888 // Need to avoid trying to rewrite casts contained in macros.
3889 if (!Rewriter::isRewritable(LocStart) || !Rewriter::isRewritable(LocEnd))
3890 return;
3891
3892 const char *startBuf = SM->getCharacterData(LocStart);
3893 const char *endBuf = SM->getCharacterData(LocEnd);
3894 QualType QT = CE->getType();
3895 const Type* TypePtr = QT->getAs<Type>();
3896 if (isa<TypeOfExprType>(TypePtr)) {
3897 const TypeOfExprType *TypeOfExprTypePtr = cast<TypeOfExprType>(TypePtr);
3898 QT = TypeOfExprTypePtr->getUnderlyingExpr()->getType();
3899 std::string TypeAsString = "(";
3900 RewriteBlockPointerType(TypeAsString, QT);
3901 TypeAsString += ")";
3902 ReplaceText(LocStart, endBuf-startBuf+1, TypeAsString);
3903 return;
3904 }
3905 // advance the location to startArgList.
3906 const char *argPtr = startBuf;
3907
3908 while (*argPtr++ && (argPtr < endBuf)) {
3909 switch (*argPtr) {
3910 case '^':
3911 // Replace the '^' with '*'.
3912 LocStart = LocStart.getLocWithOffset(argPtr-startBuf);
3913 ReplaceText(LocStart, 1, "*");
3914 break;
3915 }
3916 }
3917}
3918
3919void RewriteObjC::RewriteBlockPointerFunctionArgs(FunctionDecl *FD) {
3920 SourceLocation DeclLoc = FD->getLocation();
3921 unsigned parenCount = 0;
3922
3923 // We have 1 or more arguments that have closure pointers.
3924 const char *startBuf = SM->getCharacterData(DeclLoc);
3925 const char *startArgList = strchr(startBuf, '(');
3926
3927 assert((*startArgList == '(') && "Rewriter fuzzy parser confused")(((*startArgList == '(') && "Rewriter fuzzy parser confused"
) ? static_cast<void> (0) : __assert_fail ("(*startArgList == '(') && \"Rewriter fuzzy parser confused\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3927, __PRETTY_FUNCTION__))
;
3928
3929 parenCount++;
3930 // advance the location to startArgList.
3931 DeclLoc = DeclLoc.getLocWithOffset(startArgList-startBuf);
3932 assert((DeclLoc.isValid()) && "Invalid DeclLoc")(((DeclLoc.isValid()) && "Invalid DeclLoc") ? static_cast
<void> (0) : __assert_fail ("(DeclLoc.isValid()) && \"Invalid DeclLoc\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3932, __PRETTY_FUNCTION__))
;
3933
3934 const char *argPtr = startArgList;
3935
3936 while (*argPtr++ && parenCount) {
3937 switch (*argPtr) {
3938 case '^':
3939 // Replace the '^' with '*'.
3940 DeclLoc = DeclLoc.getLocWithOffset(argPtr-startArgList);
3941 ReplaceText(DeclLoc, 1, "*");
3942 break;
3943 case '(':
3944 parenCount++;
3945 break;
3946 case ')':
3947 parenCount--;
3948 break;
3949 }
3950 }
3951}
3952
3953bool RewriteObjC::PointerTypeTakesAnyBlockArguments(QualType QT) {
3954 const FunctionProtoType *FTP;
3955 const PointerType *PT = QT->getAs<PointerType>();
3956 if (PT) {
3957 FTP = PT->getPointeeType()->getAs<FunctionProtoType>();
3958 } else {
3959 const BlockPointerType *BPT = QT->getAs<BlockPointerType>();
3960 assert(BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type")((BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type"
) ? static_cast<void> (0) : __assert_fail ("BPT && \"BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3960, __PRETTY_FUNCTION__))
;
3961 FTP = BPT->getPointeeType()->getAs<FunctionProtoType>();
3962 }
3963 if (FTP) {
3964 for (const auto &I : FTP->param_types())
3965 if (isTopLevelBlockPointerType(I))
3966 return true;
3967 }
3968 return false;
3969}
3970
3971bool RewriteObjC::PointerTypeTakesAnyObjCQualifiedType(QualType QT) {
3972 const FunctionProtoType *FTP;
3973 const PointerType *PT = QT->getAs<PointerType>();
3974 if (PT) {
3975 FTP = PT->getPointeeType()->getAs<FunctionProtoType>();
3976 } else {
3977 const BlockPointerType *BPT = QT->getAs<BlockPointerType>();
3978 assert(BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type")((BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type"
) ? static_cast<void> (0) : __assert_fail ("BPT && \"BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3978, __PRETTY_FUNCTION__))
;
3979 FTP = BPT->getPointeeType()->getAs<FunctionProtoType>();
3980 }
3981 if (FTP) {
3982 for (const auto &I : FTP->param_types()) {
3983 if (I->isObjCQualifiedIdType())
3984 return true;
3985 if (I->isObjCObjectPointerType() &&
3986 I->getPointeeType()->isObjCQualifiedInterfaceType())
3987 return true;
3988 }
3989
3990 }
3991 return false;
3992}
3993
3994void RewriteObjC::GetExtentOfArgList(const char *Name, const char *&LParen,
3995 const char *&RParen) {
3996 const char *argPtr = strchr(Name, '(');
3997 assert((*argPtr == '(') && "Rewriter fuzzy parser confused")(((*argPtr == '(') && "Rewriter fuzzy parser confused"
) ? static_cast<void> (0) : __assert_fail ("(*argPtr == '(') && \"Rewriter fuzzy parser confused\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 3997, __PRETTY_FUNCTION__))
;
3998
3999 LParen = argPtr; // output the start.
4000 argPtr++; // skip past the left paren.
4001 unsigned parenCount = 1;
4002
4003 while (*argPtr && parenCount) {
4004 switch (*argPtr) {
4005 case '(': parenCount++; break;
4006 case ')': parenCount--; break;
4007 default: break;
4008 }
4009 if (parenCount) argPtr++;
4010 }
4011 assert((*argPtr == ')') && "Rewriter fuzzy parser confused")(((*argPtr == ')') && "Rewriter fuzzy parser confused"
) ? static_cast<void> (0) : __assert_fail ("(*argPtr == ')') && \"Rewriter fuzzy parser confused\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4011, __PRETTY_FUNCTION__))
;
4012 RParen = argPtr; // output the end
4013}
4014
4015void RewriteObjC::RewriteBlockPointerDecl(NamedDecl *ND) {
4016 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
4017 RewriteBlockPointerFunctionArgs(FD);
4018 return;
4019 }
4020 // Handle Variables and Typedefs.
4021 SourceLocation DeclLoc = ND->getLocation();
4022 QualType DeclT;
4023 if (VarDecl *VD = dyn_cast<VarDecl>(ND))
4024 DeclT = VD->getType();
4025 else if (TypedefNameDecl *TDD = dyn_cast<TypedefNameDecl>(ND))
4026 DeclT = TDD->getUnderlyingType();
4027 else if (FieldDecl *FD = dyn_cast<FieldDecl>(ND))
4028 DeclT = FD->getType();
4029 else
4030 llvm_unreachable("RewriteBlockPointerDecl(): Decl type not yet handled")::llvm::llvm_unreachable_internal("RewriteBlockPointerDecl(): Decl type not yet handled"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4030)
;
4031
4032 const char *startBuf = SM->getCharacterData(DeclLoc);
4033 const char *endBuf = startBuf;
4034 // scan backward (from the decl location) for the end of the previous decl.
4035 while (*startBuf != '^' && *startBuf != ';' && startBuf != MainFileStart)
4036 startBuf--;
4037 SourceLocation Start = DeclLoc.getLocWithOffset(startBuf-endBuf);
4038 std::string buf;
4039 unsigned OrigLength=0;
4040 // *startBuf != '^' if we are dealing with a pointer to function that
4041 // may take block argument types (which will be handled below).
4042 if (*startBuf == '^') {
4043 // Replace the '^' with '*', computing a negative offset.
4044 buf = '*';
4045 startBuf++;
4046 OrigLength++;
4047 }
4048 while (*startBuf != ')') {
4049 buf += *startBuf;
4050 startBuf++;
4051 OrigLength++;
4052 }
4053 buf += ')';
4054 OrigLength++;
4055
4056 if (PointerTypeTakesAnyBlockArguments(DeclT) ||
4057 PointerTypeTakesAnyObjCQualifiedType(DeclT)) {
4058 // Replace the '^' with '*' for arguments.
4059 // Replace id<P> with id/*<>*/
4060 DeclLoc = ND->getLocation();
4061 startBuf = SM->getCharacterData(DeclLoc);
4062 const char *argListBegin, *argListEnd;
4063 GetExtentOfArgList(startBuf, argListBegin, argListEnd);
4064 while (argListBegin < argListEnd) {
4065 if (*argListBegin == '^')
4066 buf += '*';
4067 else if (*argListBegin == '<') {
4068 buf += "/*";
4069 buf += *argListBegin++;
4070 OrigLength++;
4071 while (*argListBegin != '>') {
4072 buf += *argListBegin++;
4073 OrigLength++;
4074 }
4075 buf += *argListBegin;
4076 buf += "*/";
4077 }
4078 else
4079 buf += *argListBegin;
4080 argListBegin++;
4081 OrigLength++;
4082 }
4083 buf += ')';
4084 OrigLength++;
4085 }
4086 ReplaceText(Start, OrigLength, buf);
4087}
4088
4089/// SynthesizeByrefCopyDestroyHelper - This routine synthesizes:
4090/// void __Block_byref_id_object_copy(struct Block_byref_id_object *dst,
4091/// struct Block_byref_id_object *src) {
4092/// _Block_object_assign (&_dest->object, _src->object,
4093/// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_OBJECT
4094/// [|BLOCK_FIELD_IS_WEAK]) // object
4095/// _Block_object_assign(&_dest->object, _src->object,
4096/// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_BLOCK
4097/// [|BLOCK_FIELD_IS_WEAK]) // block
4098/// }
4099/// And:
4100/// void __Block_byref_id_object_dispose(struct Block_byref_id_object *_src) {
4101/// _Block_object_dispose(_src->object,
4102/// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_OBJECT
4103/// [|BLOCK_FIELD_IS_WEAK]) // object
4104/// _Block_object_dispose(_src->object,
4105/// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_BLOCK
4106/// [|BLOCK_FIELD_IS_WEAK]) // block
4107/// }
4108
4109std::string RewriteObjC::SynthesizeByrefCopyDestroyHelper(VarDecl *VD,
4110 int flag) {
4111 std::string S;
4112 if (CopyDestroyCache.count(flag))
4113 return S;
4114 CopyDestroyCache.insert(flag);
4115 S = "static void __Block_byref_id_object_copy_";
4116 S += utostr(flag);
4117 S += "(void *dst, void *src) {\n";
4118
4119 // offset into the object pointer is computed as:
4120 // void * + void* + int + int + void* + void *
4121 unsigned IntSize =
4122 static_cast<unsigned>(Context->getTypeSize(Context->IntTy));
4123 unsigned VoidPtrSize =
4124 static_cast<unsigned>(Context->getTypeSize(Context->VoidPtrTy));
4125
4126 unsigned offset = (VoidPtrSize*4 + IntSize + IntSize)/Context->getCharWidth();
4127 S += " _Block_object_assign((char*)dst + ";
4128 S += utostr(offset);
4129 S += ", *(void * *) ((char*)src + ";
4130 S += utostr(offset);
4131 S += "), ";
4132 S += utostr(flag);
4133 S += ");\n}\n";
4134
4135 S += "static void __Block_byref_id_object_dispose_";
4136 S += utostr(flag);
4137 S += "(void *src) {\n";
4138 S += " _Block_object_dispose(*(void * *) ((char*)src + ";
4139 S += utostr(offset);
4140 S += "), ";
4141 S += utostr(flag);
4142 S += ");\n}\n";
4143 return S;
4144}
4145
4146/// RewriteByRefVar - For each __block typex ND variable this routine transforms
4147/// the declaration into:
4148/// struct __Block_byref_ND {
4149/// void *__isa; // NULL for everything except __weak pointers
4150/// struct __Block_byref_ND *__forwarding;
4151/// int32_t __flags;
4152/// int32_t __size;
4153/// void *__Block_byref_id_object_copy; // If variable is __block ObjC object
4154/// void *__Block_byref_id_object_dispose; // If variable is __block ObjC object
4155/// typex ND;
4156/// };
4157///
4158/// It then replaces declaration of ND variable with:
4159/// struct __Block_byref_ND ND = {__isa=0B, __forwarding=&ND, __flags=some_flag,
4160/// __size=sizeof(struct __Block_byref_ND),
4161/// ND=initializer-if-any};
4162///
4163///
4164void RewriteObjC::RewriteByRefVar(VarDecl *ND) {
4165 // Insert declaration for the function in which block literal is
4166 // used.
4167 if (CurFunctionDeclToDeclareForBlock)
4168 RewriteBlockLiteralFunctionDecl(CurFunctionDeclToDeclareForBlock);
4169 int flag = 0;
4170 int isa = 0;
4171 SourceLocation DeclLoc = ND->getTypeSpecStartLoc();
4172 if (DeclLoc.isInvalid())
4173 // If type location is missing, it is because of missing type (a warning).
4174 // Use variable's location which is good for this case.
4175 DeclLoc = ND->getLocation();
4176 const char *startBuf = SM->getCharacterData(DeclLoc);
4177 SourceLocation X = ND->getEndLoc();
4178 X = SM->getExpansionLoc(X);
4179 const char *endBuf = SM->getCharacterData(X);
4180 std::string Name(ND->getNameAsString());
4181 std::string ByrefType;
4182 RewriteByRefString(ByrefType, Name, ND, true);
4183 ByrefType += " {\n";
4184 ByrefType += " void *__isa;\n";
4185 RewriteByRefString(ByrefType, Name, ND);
4186 ByrefType += " *__forwarding;\n";
4187 ByrefType += " int __flags;\n";
4188 ByrefType += " int __size;\n";
4189 // Add void *__Block_byref_id_object_copy;
4190 // void *__Block_byref_id_object_dispose; if needed.
4191 QualType Ty = ND->getType();
4192 bool HasCopyAndDispose = Context->BlockRequiresCopying(Ty, ND);
4193 if (HasCopyAndDispose) {
4194 ByrefType += " void (*__Block_byref_id_object_copy)(void*, void*);\n";
4195 ByrefType += " void (*__Block_byref_id_object_dispose)(void*);\n";
4196 }
4197
4198 QualType T = Ty;
4199 (void)convertBlockPointerToFunctionPointer(T);
4200 T.getAsStringInternal(Name, Context->getPrintingPolicy());
4201
4202 ByrefType += " " + Name + ";\n";
4203 ByrefType += "};\n";
4204 // Insert this type in global scope. It is needed by helper function.
4205 SourceLocation FunLocStart;
4206 if (CurFunctionDef)
4207 FunLocStart = CurFunctionDef->getTypeSpecStartLoc();
4208 else {
4209 assert(CurMethodDef && "RewriteByRefVar - CurMethodDef is null")((CurMethodDef && "RewriteByRefVar - CurMethodDef is null"
) ? static_cast<void> (0) : __assert_fail ("CurMethodDef && \"RewriteByRefVar - CurMethodDef is null\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4209, __PRETTY_FUNCTION__))
;
4210 FunLocStart = CurMethodDef->getBeginLoc();
4211 }
4212 InsertText(FunLocStart, ByrefType);
4213 if (Ty.isObjCGCWeak()) {
4214 flag |= BLOCK_FIELD_IS_WEAK;
4215 isa = 1;
4216 }
4217
4218 if (HasCopyAndDispose) {
4219 flag = BLOCK_BYREF_CALLER;
4220 QualType Ty = ND->getType();
4221 // FIXME. Handle __weak variable (BLOCK_FIELD_IS_WEAK) as well.
4222 if (Ty->isBlockPointerType())
4223 flag |= BLOCK_FIELD_IS_BLOCK;
4224 else
4225 flag |= BLOCK_FIELD_IS_OBJECT;
4226 std::string HF = SynthesizeByrefCopyDestroyHelper(ND, flag);
4227 if (!HF.empty())
4228 InsertText(FunLocStart, HF);
4229 }
4230
4231 // struct __Block_byref_ND ND =
4232 // {0, &ND, some_flag, __size=sizeof(struct __Block_byref_ND),
4233 // initializer-if-any};
4234 bool hasInit = (ND->getInit() != nullptr);
4235 unsigned flags = 0;
4236 if (HasCopyAndDispose)
4237 flags |= BLOCK_HAS_COPY_DISPOSE;
4238 Name = ND->getNameAsString();
4239 ByrefType.clear();
4240 RewriteByRefString(ByrefType, Name, ND);
4241 std::string ForwardingCastType("(");
4242 ForwardingCastType += ByrefType + " *)";
4243 if (!hasInit) {
4244 ByrefType += " " + Name + " = {(void*)";
4245 ByrefType += utostr(isa);
4246 ByrefType += "," + ForwardingCastType + "&" + Name + ", ";
4247 ByrefType += utostr(flags);
4248 ByrefType += ", ";
4249 ByrefType += "sizeof(";
4250 RewriteByRefString(ByrefType, Name, ND);
4251 ByrefType += ")";
4252 if (HasCopyAndDispose) {
4253 ByrefType += ", __Block_byref_id_object_copy_";
4254 ByrefType += utostr(flag);
4255 ByrefType += ", __Block_byref_id_object_dispose_";
4256 ByrefType += utostr(flag);
4257 }
4258 ByrefType += "};\n";
4259 unsigned nameSize = Name.size();
4260 // for block or function pointer declaration. Name is already
4261 // part of the declaration.
4262 if (Ty->isBlockPointerType() || Ty->isFunctionPointerType())
4263 nameSize = 1;
4264 ReplaceText(DeclLoc, endBuf-startBuf+nameSize, ByrefType);
4265 }
4266 else {
4267 SourceLocation startLoc;
4268 Expr *E = ND->getInit();
4269 if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E))
4270 startLoc = ECE->getLParenLoc();
4271 else
4272 startLoc = E->getBeginLoc();
4273 startLoc = SM->getExpansionLoc(startLoc);
4274 endBuf = SM->getCharacterData(startLoc);
4275 ByrefType += " " + Name;
4276 ByrefType += " = {(void*)";
4277 ByrefType += utostr(isa);
4278 ByrefType += "," + ForwardingCastType + "&" + Name + ", ";
4279 ByrefType += utostr(flags);
4280 ByrefType += ", ";
4281 ByrefType += "sizeof(";
4282 RewriteByRefString(ByrefType, Name, ND);
4283 ByrefType += "), ";
4284 if (HasCopyAndDispose) {
4285 ByrefType += "__Block_byref_id_object_copy_";
4286 ByrefType += utostr(flag);
4287 ByrefType += ", __Block_byref_id_object_dispose_";
4288 ByrefType += utostr(flag);
4289 ByrefType += ", ";
4290 }
4291 ReplaceText(DeclLoc, endBuf-startBuf, ByrefType);
4292
4293 // Complete the newly synthesized compound expression by inserting a right
4294 // curly brace before the end of the declaration.
4295 // FIXME: This approach avoids rewriting the initializer expression. It
4296 // also assumes there is only one declarator. For example, the following
4297 // isn't currently supported by this routine (in general):
4298 //
4299 // double __block BYREFVAR = 1.34, BYREFVAR2 = 1.37;
4300 //
4301 const char *startInitializerBuf = SM->getCharacterData(startLoc);
4302 const char *semiBuf = strchr(startInitializerBuf, ';');
4303 assert((*semiBuf == ';') && "RewriteByRefVar: can't find ';'")(((*semiBuf == ';') && "RewriteByRefVar: can't find ';'"
) ? static_cast<void> (0) : __assert_fail ("(*semiBuf == ';') && \"RewriteByRefVar: can't find ';'\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4303, __PRETTY_FUNCTION__))
;
4304 SourceLocation semiLoc =
4305 startLoc.getLocWithOffset(semiBuf-startInitializerBuf);
4306
4307 InsertText(semiLoc, "}");
4308 }
4309}
4310
4311void RewriteObjC::CollectBlockDeclRefInfo(BlockExpr *Exp) {
4312 // Add initializers for any closure decl refs.
4313 GetBlockDeclRefExprs(Exp->getBody());
4314 if (BlockDeclRefs.size()) {
4315 // Unique all "by copy" declarations.
4316 for (unsigned i = 0; i < BlockDeclRefs.size(); i++)
4317 if (!BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>()) {
4318 if (!BlockByCopyDeclsPtrSet.count(BlockDeclRefs[i]->getDecl())) {
4319 BlockByCopyDeclsPtrSet.insert(BlockDeclRefs[i]->getDecl());
4320 BlockByCopyDecls.push_back(BlockDeclRefs[i]->getDecl());
4321 }
4322 }
4323 // Unique all "by ref" declarations.
4324 for (unsigned i = 0; i < BlockDeclRefs.size(); i++)
4325 if (BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>()) {
4326 if (!BlockByRefDeclsPtrSet.count(BlockDeclRefs[i]->getDecl())) {
4327 BlockByRefDeclsPtrSet.insert(BlockDeclRefs[i]->getDecl());
4328 BlockByRefDecls.push_back(BlockDeclRefs[i]->getDecl());
4329 }
4330 }
4331 // Find any imported blocks...they will need special attention.
4332 for (unsigned i = 0; i < BlockDeclRefs.size(); i++)
4333 if (BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>() ||
4334 BlockDeclRefs[i]->getType()->isObjCObjectPointerType() ||
4335 BlockDeclRefs[i]->getType()->isBlockPointerType())
4336 ImportedBlockDecls.insert(BlockDeclRefs[i]->getDecl());
4337 }
4338}
4339
4340FunctionDecl *RewriteObjC::SynthBlockInitFunctionDecl(StringRef name) {
4341 IdentifierInfo *ID = &Context->Idents.get(name);
4342 QualType FType = Context->getFunctionNoProtoType(Context->VoidPtrTy);
4343 return FunctionDecl::Create(*Context, TUDecl, SourceLocation(),
4344 SourceLocation(), ID, FType, nullptr, SC_Extern,
4345 false, false);
4346}
4347
4348Stmt *RewriteObjC::SynthBlockInitExpr(BlockExpr *Exp,
4349 const SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs) {
4350 const BlockDecl *block = Exp->getBlockDecl();
4351 Blocks.push_back(Exp);
4352
4353 CollectBlockDeclRefInfo(Exp);
4354
4355 // Add inner imported variables now used in current block.
4356 int countOfInnerDecls = 0;
4357 if (!InnerBlockDeclRefs.empty()) {
4358 for (unsigned i = 0; i < InnerBlockDeclRefs.size(); i++) {
4359 DeclRefExpr *Exp = InnerBlockDeclRefs[i];
4360 ValueDecl *VD = Exp->getDecl();
4361 if (!VD->hasAttr<BlocksAttr>() && !BlockByCopyDeclsPtrSet.count(VD)) {
4362 // We need to save the copied-in variables in nested
4363 // blocks because it is needed at the end for some of the API generations.
4364 // See SynthesizeBlockLiterals routine.
4365 InnerDeclRefs.push_back(Exp); countOfInnerDecls++;
4366 BlockDeclRefs.push_back(Exp);
4367 BlockByCopyDeclsPtrSet.insert(VD);
4368 BlockByCopyDecls.push_back(VD);
4369 }
4370 if (VD->hasAttr<BlocksAttr>() && !BlockByRefDeclsPtrSet.count(VD)) {
4371 InnerDeclRefs.push_back(Exp); countOfInnerDecls++;
4372 BlockDeclRefs.push_back(Exp);
4373 BlockByRefDeclsPtrSet.insert(VD);
4374 BlockByRefDecls.push_back(VD);
4375 }
4376 }
4377 // Find any imported blocks...they will need special attention.
4378 for (unsigned i = 0; i < InnerBlockDeclRefs.size(); i++)
4379 if (InnerBlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>() ||
4380 InnerBlockDeclRefs[i]->getType()->isObjCObjectPointerType() ||
4381 InnerBlockDeclRefs[i]->getType()->isBlockPointerType())
4382 ImportedBlockDecls.insert(InnerBlockDeclRefs[i]->getDecl());
4383 }
4384 InnerDeclRefsCount.push_back(countOfInnerDecls);
4385
4386 std::string FuncName;
4387
4388 if (CurFunctionDef)
4389 FuncName = CurFunctionDef->getNameAsString();
4390 else if (CurMethodDef)
4391 BuildUniqueMethodName(FuncName, CurMethodDef);
4392 else if (GlobalVarDecl)
4393 FuncName = std::string(GlobalVarDecl->getNameAsString());
4394
4395 std::string BlockNumber = utostr(Blocks.size()-1);
4396
4397 std::string Tag = "__" + FuncName + "_block_impl_" + BlockNumber;
4398 std::string Func = "__" + FuncName + "_block_func_" + BlockNumber;
4399
4400 // Get a pointer to the function type so we can cast appropriately.
4401 QualType BFT = convertFunctionTypeOfBlocks(Exp->getFunctionType());
4402 QualType FType = Context->getPointerType(BFT);
4403
4404 FunctionDecl *FD;
4405 Expr *NewRep;
4406
4407 // Simulate a constructor call...
4408 FD = SynthBlockInitFunctionDecl(Tag);
4409 DeclRefExpr *DRE = new (Context)
4410 DeclRefExpr(*Context, FD, false, FType, VK_RValue, SourceLocation());
4411
4412 SmallVector<Expr*, 4> InitExprs;
4413
4414 // Initialize the block function.
4415 FD = SynthBlockInitFunctionDecl(Func);
4416 DeclRefExpr *Arg = new (Context) DeclRefExpr(
4417 *Context, FD, false, FD->getType(), VK_LValue, SourceLocation());
4418 CastExpr *castExpr =
4419 NoTypeInfoCStyleCastExpr(Context, Context->VoidPtrTy, CK_BitCast, Arg);
4420 InitExprs.push_back(castExpr);
4421
4422 // Initialize the block descriptor.
4423 std::string DescData = "__" + FuncName + "_block_desc_" + BlockNumber + "_DATA";
4424
4425 VarDecl *NewVD = VarDecl::Create(
4426 *Context, TUDecl, SourceLocation(), SourceLocation(),
4427 &Context->Idents.get(DescData), Context->VoidPtrTy, nullptr, SC_Static);
4428 UnaryOperator *DescRefExpr = new (Context) UnaryOperator(
4429 new (Context) DeclRefExpr(*Context, NewVD, false, Context->VoidPtrTy,
4430 VK_LValue, SourceLocation()),
4431 UO_AddrOf, Context->getPointerType(Context->VoidPtrTy), VK_RValue,
4432 OK_Ordinary, SourceLocation(), false);
4433 InitExprs.push_back(DescRefExpr);
4434
4435 // Add initializers for any closure decl refs.
4436 if (BlockDeclRefs.size()) {
4437 Expr *Exp;
4438 // Output all "by copy" declarations.
4439 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(),
4440 E = BlockByCopyDecls.end(); I != E; ++I) {
4441 if (isObjCType((*I)->getType())) {
4442 // FIXME: Conform to ABI ([[obj retain] autorelease]).
4443 FD = SynthBlockInitFunctionDecl((*I)->getName());
4444 Exp = new (Context) DeclRefExpr(*Context, FD, false, FD->getType(),
4445 VK_LValue, SourceLocation());
4446 if (HasLocalVariableExternalStorage(*I)) {
4447 QualType QT = (*I)->getType();
4448 QT = Context->getPointerType(QT);
4449 Exp = new (Context) UnaryOperator(Exp, UO_AddrOf, QT, VK_RValue,
4450 OK_Ordinary, SourceLocation(),
4451 false);
4452 }
4453 } else if (isTopLevelBlockPointerType((*I)->getType())) {
4454 FD = SynthBlockInitFunctionDecl((*I)->getName());
4455 Arg = new (Context) DeclRefExpr(*Context, FD, false, FD->getType(),
4456 VK_LValue, SourceLocation());
4457 Exp = NoTypeInfoCStyleCastExpr(Context, Context->VoidPtrTy, CK_BitCast,
4458 Arg);
4459 } else {
4460 FD = SynthBlockInitFunctionDecl((*I)->getName());
4461 Exp = new (Context) DeclRefExpr(*Context, FD, false, FD->getType(),
4462 VK_LValue, SourceLocation());
4463 if (HasLocalVariableExternalStorage(*I)) {
4464 QualType QT = (*I)->getType();
4465 QT = Context->getPointerType(QT);
4466 Exp = new (Context) UnaryOperator(Exp, UO_AddrOf, QT, VK_RValue,
4467 OK_Ordinary, SourceLocation(),
4468 false);
4469 }
4470 }
4471 InitExprs.push_back(Exp);
4472 }
4473 // Output all "by ref" declarations.
4474 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(),
4475 E = BlockByRefDecls.end(); I != E; ++I) {
4476 ValueDecl *ND = (*I);
4477 std::string Name(ND->getNameAsString());
4478 std::string RecName;
4479 RewriteByRefString(RecName, Name, ND, true);
4480 IdentifierInfo *II = &Context->Idents.get(RecName.c_str()
4481 + sizeof("struct"));
4482 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
4483 SourceLocation(), SourceLocation(),
4484 II);
4485 assert(RD && "SynthBlockInitExpr(): Can't find RecordDecl")((RD && "SynthBlockInitExpr(): Can't find RecordDecl"
) ? static_cast<void> (0) : __assert_fail ("RD && \"SynthBlockInitExpr(): Can't find RecordDecl\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4485, __PRETTY_FUNCTION__))
;
4486 QualType castT = Context->getPointerType(Context->getTagDeclType(RD));
4487
4488 FD = SynthBlockInitFunctionDecl((*I)->getName());
4489 Exp = new (Context) DeclRefExpr(*Context, FD, false, FD->getType(),
4490 VK_LValue, SourceLocation());
4491 bool isNestedCapturedVar = false;
4492 if (block)
4493 for (const auto &CI : block->captures()) {
4494 const VarDecl *variable = CI.getVariable();
4495 if (variable == ND && CI.isNested()) {
4496 assert (CI.isByRef() &&((CI.isByRef() && "SynthBlockInitExpr - captured block variable is not byref"
) ? static_cast<void> (0) : __assert_fail ("CI.isByRef() && \"SynthBlockInitExpr - captured block variable is not byref\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4497, __PRETTY_FUNCTION__))
4497 "SynthBlockInitExpr - captured block variable is not byref")((CI.isByRef() && "SynthBlockInitExpr - captured block variable is not byref"
) ? static_cast<void> (0) : __assert_fail ("CI.isByRef() && \"SynthBlockInitExpr - captured block variable is not byref\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4497, __PRETTY_FUNCTION__))
;
4498 isNestedCapturedVar = true;
4499 break;
4500 }
4501 }
4502 // captured nested byref variable has its address passed. Do not take
4503 // its address again.
4504 if (!isNestedCapturedVar)
4505 Exp = new (Context) UnaryOperator(
4506 Exp, UO_AddrOf, Context->getPointerType(Exp->getType()), VK_RValue,
4507 OK_Ordinary, SourceLocation(), false);
4508 Exp = NoTypeInfoCStyleCastExpr(Context, castT, CK_BitCast, Exp);
4509 InitExprs.push_back(Exp);
4510 }
4511 }
4512 if (ImportedBlockDecls.size()) {
4513 // generate BLOCK_HAS_COPY_DISPOSE(have helper funcs) | BLOCK_HAS_DESCRIPTOR
4514 int flag = (BLOCK_HAS_COPY_DISPOSE | BLOCK_HAS_DESCRIPTOR);
4515 unsigned IntSize =
4516 static_cast<unsigned>(Context->getTypeSize(Context->IntTy));
4517 Expr *FlagExp = IntegerLiteral::Create(*Context, llvm::APInt(IntSize, flag),
4518 Context->IntTy, SourceLocation());
4519 InitExprs.push_back(FlagExp);
4520 }
4521 NewRep = CallExpr::Create(*Context, DRE, InitExprs, FType, VK_LValue,
4522 SourceLocation());
4523 NewRep = new (Context) UnaryOperator(
4524 NewRep, UO_AddrOf, Context->getPointerType(NewRep->getType()), VK_RValue,
4525 OK_Ordinary, SourceLocation(), false);
4526 NewRep = NoTypeInfoCStyleCastExpr(Context, FType, CK_BitCast,
4527 NewRep);
4528 BlockDeclRefs.clear();
4529 BlockByRefDecls.clear();
4530 BlockByRefDeclsPtrSet.clear();
4531 BlockByCopyDecls.clear();
4532 BlockByCopyDeclsPtrSet.clear();
4533 ImportedBlockDecls.clear();
4534 return NewRep;
4535}
4536
4537bool RewriteObjC::IsDeclStmtInForeachHeader(DeclStmt *DS) {
4538 if (const ObjCForCollectionStmt * CS =
4539 dyn_cast<ObjCForCollectionStmt>(Stmts.back()))
4540 return CS->getElement() == DS;
4541 return false;
4542}
4543
4544//===----------------------------------------------------------------------===//
4545// Function Body / Expression rewriting
4546//===----------------------------------------------------------------------===//
4547
4548Stmt *RewriteObjC::RewriteFunctionBodyOrGlobalInitializer(Stmt *S) {
4549 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
4550 isa<DoStmt>(S) || isa<ForStmt>(S))
4551 Stmts.push_back(S);
4552 else if (isa<ObjCForCollectionStmt>(S)) {
4553 Stmts.push_back(S);
4554 ObjCBcLabelNo.push_back(++BcLabelCount);
4555 }
4556
4557 // Pseudo-object operations and ivar references need special
4558 // treatment because we're going to recursively rewrite them.
4559 if (PseudoObjectExpr *PseudoOp = dyn_cast<PseudoObjectExpr>(S)) {
4560 if (isa<BinaryOperator>(PseudoOp->getSyntacticForm())) {
4561 return RewritePropertyOrImplicitSetter(PseudoOp);
4562 } else {
4563 return RewritePropertyOrImplicitGetter(PseudoOp);
4564 }
4565 } else if (ObjCIvarRefExpr *IvarRefExpr = dyn_cast<ObjCIvarRefExpr>(S)) {
4566 return RewriteObjCIvarRefExpr(IvarRefExpr);
4567 }
4568
4569 SourceRange OrigStmtRange = S->getSourceRange();
4570
4571 // Perform a bottom up rewrite of all children.
4572 for (Stmt *&childStmt : S->children())
4573 if (childStmt) {
4574 Stmt *newStmt = RewriteFunctionBodyOrGlobalInitializer(childStmt);
4575 if (newStmt) {
4576 childStmt = newStmt;
4577 }
4578 }
4579
4580 if (BlockExpr *BE = dyn_cast<BlockExpr>(S)) {
4581 SmallVector<DeclRefExpr *, 8> InnerBlockDeclRefs;
4582 llvm::SmallPtrSet<const DeclContext *, 8> InnerContexts;
4583 InnerContexts.insert(BE->getBlockDecl());
4584 ImportedLocalExternalDecls.clear();
4585 GetInnerBlockDeclRefExprs(BE->getBody(),
4586 InnerBlockDeclRefs, InnerContexts);
4587 // Rewrite the block body in place.
4588 Stmt *SaveCurrentBody = CurrentBody;
4589 CurrentBody = BE->getBody();
4590 PropParentMap = nullptr;
4591 // block literal on rhs of a property-dot-sytax assignment
4592 // must be replaced by its synthesize ast so getRewrittenText
4593 // works as expected. In this case, what actually ends up on RHS
4594 // is the blockTranscribed which is the helper function for the
4595 // block literal; as in: self.c = ^() {[ace ARR];};
4596 bool saveDisableReplaceStmt = DisableReplaceStmt;
4597 DisableReplaceStmt = false;
4598 RewriteFunctionBodyOrGlobalInitializer(BE->getBody());
4599 DisableReplaceStmt = saveDisableReplaceStmt;
4600 CurrentBody = SaveCurrentBody;
4601 PropParentMap = nullptr;
4602 ImportedLocalExternalDecls.clear();
4603 // Now we snarf the rewritten text and stash it away for later use.
4604 std::string Str = Rewrite.getRewrittenText(BE->getSourceRange());
4605 RewrittenBlockExprs[BE] = Str;
4606
4607 Stmt *blockTranscribed = SynthBlockInitExpr(BE, InnerBlockDeclRefs);
4608
4609 //blockTranscribed->dump();
4610 ReplaceStmt(S, blockTranscribed);
4611 return blockTranscribed;
4612 }
4613 // Handle specific things.
4614 if (ObjCEncodeExpr *AtEncode = dyn_cast<ObjCEncodeExpr>(S))
4615 return RewriteAtEncode(AtEncode);
4616
4617 if (ObjCSelectorExpr *AtSelector = dyn_cast<ObjCSelectorExpr>(S))
4618 return RewriteAtSelector(AtSelector);
4619
4620 if (ObjCStringLiteral *AtString = dyn_cast<ObjCStringLiteral>(S))
4621 return RewriteObjCStringLiteral(AtString);
4622
4623 if (ObjCMessageExpr *MessExpr = dyn_cast<ObjCMessageExpr>(S)) {
4624#if 0
4625 // Before we rewrite it, put the original message expression in a comment.
4626 SourceLocation startLoc = MessExpr->getBeginLoc();
4627 SourceLocation endLoc = MessExpr->getEndLoc();
4628
4629 const char *startBuf = SM->getCharacterData(startLoc);
4630 const char *endBuf = SM->getCharacterData(endLoc);
4631
4632 std::string messString;
4633 messString += "// ";
4634 messString.append(startBuf, endBuf-startBuf+1);
4635 messString += "\n";
4636
4637 // FIXME: Missing definition of
4638 // InsertText(clang::SourceLocation, char const*, unsigned int).
4639 // InsertText(startLoc, messString);
4640 // Tried this, but it didn't work either...
4641 // ReplaceText(startLoc, 0, messString.c_str(), messString.size());
4642#endif
4643 return RewriteMessageExpr(MessExpr);
4644 }
4645
4646 if (ObjCAtTryStmt *StmtTry = dyn_cast<ObjCAtTryStmt>(S))
4647 return RewriteObjCTryStmt(StmtTry);
4648
4649 if (ObjCAtSynchronizedStmt *StmtTry = dyn_cast<ObjCAtSynchronizedStmt>(S))
4650 return RewriteObjCSynchronizedStmt(StmtTry);
4651
4652 if (ObjCAtThrowStmt *StmtThrow = dyn_cast<ObjCAtThrowStmt>(S))
4653 return RewriteObjCThrowStmt(StmtThrow);
4654
4655 if (ObjCProtocolExpr *ProtocolExp = dyn_cast<ObjCProtocolExpr>(S))
4656 return RewriteObjCProtocolExpr(ProtocolExp);
4657
4658 if (ObjCForCollectionStmt *StmtForCollection =
4659 dyn_cast<ObjCForCollectionStmt>(S))
4660 return RewriteObjCForCollectionStmt(StmtForCollection,
4661 OrigStmtRange.getEnd());
4662 if (BreakStmt *StmtBreakStmt =
4663 dyn_cast<BreakStmt>(S))
4664 return RewriteBreakStmt(StmtBreakStmt);
4665 if (ContinueStmt *StmtContinueStmt =
4666 dyn_cast<ContinueStmt>(S))
4667 return RewriteContinueStmt(StmtContinueStmt);
4668
4669 // Need to check for protocol refs (id <P>, Foo <P> *) in variable decls
4670 // and cast exprs.
4671 if (DeclStmt *DS = dyn_cast<DeclStmt>(S)) {
4672 // FIXME: What we're doing here is modifying the type-specifier that
4673 // precedes the first Decl. In the future the DeclGroup should have
4674 // a separate type-specifier that we can rewrite.
4675 // NOTE: We need to avoid rewriting the DeclStmt if it is within
4676 // the context of an ObjCForCollectionStmt. For example:
4677 // NSArray *someArray;
4678 // for (id <FooProtocol> index in someArray) ;
4679 // This is because RewriteObjCForCollectionStmt() does textual rewriting
4680 // and it depends on the original text locations/positions.
4681 if (Stmts.empty() || !IsDeclStmtInForeachHeader(DS))
4682 RewriteObjCQualifiedInterfaceTypes(*DS->decl_begin());
4683
4684 // Blocks rewrite rules.
4685 for (auto *SD : DS->decls()) {
4686 if (ValueDecl *ND = dyn_cast<ValueDecl>(SD)) {
4687 if (isTopLevelBlockPointerType(ND->getType()))
4688 RewriteBlockPointerDecl(ND);
4689 else if (ND->getType()->isFunctionPointerType())
4690 CheckFunctionPointerDecl(ND->getType(), ND);
4691 if (VarDecl *VD = dyn_cast<VarDecl>(SD)) {
4692 if (VD->hasAttr<BlocksAttr>()) {
4693 static unsigned uniqueByrefDeclCount = 0;
4694 assert(!BlockByRefDeclNo.count(ND) &&((!BlockByRefDeclNo.count(ND) && "RewriteFunctionBodyOrGlobalInitializer: Duplicate byref decl"
) ? static_cast<void> (0) : __assert_fail ("!BlockByRefDeclNo.count(ND) && \"RewriteFunctionBodyOrGlobalInitializer: Duplicate byref decl\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4695, __PRETTY_FUNCTION__))
4695 "RewriteFunctionBodyOrGlobalInitializer: Duplicate byref decl")((!BlockByRefDeclNo.count(ND) && "RewriteFunctionBodyOrGlobalInitializer: Duplicate byref decl"
) ? static_cast<void> (0) : __assert_fail ("!BlockByRefDeclNo.count(ND) && \"RewriteFunctionBodyOrGlobalInitializer: Duplicate byref decl\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4695, __PRETTY_FUNCTION__))
;
4696 BlockByRefDeclNo[ND] = uniqueByrefDeclCount++;
4697 RewriteByRefVar(VD);
4698 }
4699 else
4700 RewriteTypeOfDecl(VD);
4701 }
4702 }
4703 if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(SD)) {
4704 if (isTopLevelBlockPointerType(TD->getUnderlyingType()))
4705 RewriteBlockPointerDecl(TD);
4706 else if (TD->getUnderlyingType()->isFunctionPointerType())
4707 CheckFunctionPointerDecl(TD->getUnderlyingType(), TD);
4708 }
4709 }
4710 }
4711
4712 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(S))
4713 RewriteObjCQualifiedInterfaceTypes(CE);
4714
4715 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
4716 isa<DoStmt>(S) || isa<ForStmt>(S)) {
4717 assert(!Stmts.empty() && "Statement stack is empty")((!Stmts.empty() && "Statement stack is empty") ? static_cast
<void> (0) : __assert_fail ("!Stmts.empty() && \"Statement stack is empty\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4717, __PRETTY_FUNCTION__))
;
4718 assert ((isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>(Stmts.back()) ||(((isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>
(Stmts.back()) || isa<DoStmt>(Stmts.back()) || isa<ForStmt
>(Stmts.back())) && "Statement stack mismatch") ? static_cast
<void> (0) : __assert_fail ("(isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>(Stmts.back()) || isa<DoStmt>(Stmts.back()) || isa<ForStmt>(Stmts.back())) && \"Statement stack mismatch\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4720, __PRETTY_FUNCTION__))
4719 isa<DoStmt>(Stmts.back()) || isa<ForStmt>(Stmts.back()))(((isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>
(Stmts.back()) || isa<DoStmt>(Stmts.back()) || isa<ForStmt
>(Stmts.back())) && "Statement stack mismatch") ? static_cast
<void> (0) : __assert_fail ("(isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>(Stmts.back()) || isa<DoStmt>(Stmts.back()) || isa<ForStmt>(Stmts.back())) && \"Statement stack mismatch\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4720, __PRETTY_FUNCTION__))
4720 && "Statement stack mismatch")(((isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>
(Stmts.back()) || isa<DoStmt>(Stmts.back()) || isa<ForStmt
>(Stmts.back())) && "Statement stack mismatch") ? static_cast
<void> (0) : __assert_fail ("(isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>(Stmts.back()) || isa<DoStmt>(Stmts.back()) || isa<ForStmt>(Stmts.back())) && \"Statement stack mismatch\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 4720, __PRETTY_FUNCTION__))
;
4721 Stmts.pop_back();
4722 }
4723 // Handle blocks rewriting.
4724 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) {
4725 ValueDecl *VD = DRE->getDecl();
4726 if (VD->hasAttr<BlocksAttr>())
4727 return RewriteBlockDeclRefExpr(DRE);
4728 if (HasLocalVariableExternalStorage(VD))
4729 return RewriteLocalVariableExternalStorage(DRE);
4730 }
4731
4732 if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
4733 if (CE->getCallee()->getType()->isBlockPointerType()) {
4734 Stmt *BlockCall = SynthesizeBlockCall(CE, CE->getCallee());
4735 ReplaceStmt(S, BlockCall);
4736 return BlockCall;
4737 }
4738 }
4739 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(S)) {
4740 RewriteCastExpr(CE);
4741 }
4742#if 0
4743 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(S)) {
4744 CastExpr *Replacement = new (Context) CastExpr(ICE->getType(),
4745 ICE->getSubExpr(),
4746 SourceLocation());
4747 // Get the new text.
4748 std::string SStr;
4749 llvm::raw_string_ostream Buf(SStr);
4750 Replacement->printPretty(Buf);
4751 const std::string &Str = Buf.str();
4752
4753 printf("CAST = %s\n", &Str[0]);
4754 InsertText(ICE->getSubExpr()->getBeginLoc(), Str);
4755 delete S;
4756 return Replacement;
4757 }
4758#endif
4759 // Return this stmt unmodified.
4760 return S;
4761}
4762
4763void RewriteObjC::RewriteRecordBody(RecordDecl *RD) {
4764 for (auto *FD : RD->fields()) {
4765 if (isTopLevelBlockPointerType(FD->getType()))
4766 RewriteBlockPointerDecl(FD);
4767 if (FD->getType()->isObjCQualifiedIdType() ||
4768 FD->getType()->isObjCQualifiedInterfaceType())
4769 RewriteObjCQualifiedInterfaceTypes(FD);
4770 }
4771}
4772
4773/// HandleDeclInMainFile - This is called for each top-level decl defined in the
4774/// main file of the input.
4775void RewriteObjC::HandleDeclInMainFile(Decl *D) {
4776 switch (D->getKind()) {
65
Control jumps to 'case Var:' at line 4839
4777 case Decl::Function: {
4778 FunctionDecl *FD = cast<FunctionDecl>(D);
4779 if (FD->isOverloadedOperator())
4780 return;
4781
4782 // Since function prototypes don't have ParmDecl's, we check the function
4783 // prototype. This enables us to rewrite function declarations and
4784 // definitions using the same code.
4785 RewriteBlocksInFunctionProtoType(FD->getType(), FD);
4786
4787 if (!FD->isThisDeclarationADefinition())
4788 break;
4789
4790 // FIXME: If this should support Obj-C++, support CXXTryStmt
4791 if (CompoundStmt *Body = dyn_cast_or_null<CompoundStmt>(FD->getBody())) {
4792 CurFunctionDef = FD;
4793 CurFunctionDeclToDeclareForBlock = FD;
4794 CurrentBody = Body;
4795 Body =
4796 cast_or_null<CompoundStmt>(RewriteFunctionBodyOrGlobalInitializer(Body));
4797 FD->setBody(Body);
4798 CurrentBody = nullptr;
4799 if (PropParentMap) {
4800 delete PropParentMap;
4801 PropParentMap = nullptr;
4802 }
4803 // This synthesizes and inserts the block "impl" struct, invoke function,
4804 // and any copy/dispose helper functions.
4805 InsertBlockLiteralsWithinFunction(FD);
4806 CurFunctionDef = nullptr;
4807 CurFunctionDeclToDeclareForBlock = nullptr;
4808 }
4809 break;
4810 }
4811 case Decl::ObjCMethod: {
4812 ObjCMethodDecl *MD = cast<ObjCMethodDecl>(D);
4813 if (CompoundStmt *Body = MD->getCompoundBody()) {
4814 CurMethodDef = MD;
4815 CurrentBody = Body;
4816 Body =
4817 cast_or_null<CompoundStmt>(RewriteFunctionBodyOrGlobalInitializer(Body));
4818 MD->setBody(Body);
4819 CurrentBody = nullptr;
4820 if (PropParentMap) {
4821 delete PropParentMap;
4822 PropParentMap = nullptr;
4823 }
4824 InsertBlockLiteralsWithinMethod(MD);
4825 CurMethodDef = nullptr;
4826 }
4827 break;
4828 }
4829 case Decl::ObjCImplementation: {
4830 ObjCImplementationDecl *CI = cast<ObjCImplementationDecl>(D);
4831 ClassImplementation.push_back(CI);
4832 break;
4833 }
4834 case Decl::ObjCCategoryImpl: {
4835 ObjCCategoryImplDecl *CI = cast<ObjCCategoryImplDecl>(D);
4836 CategoryImplementation.push_back(CI);
4837 break;
4838 }
4839 case Decl::Var: {
4840 VarDecl *VD = cast<VarDecl>(D);
66
'D' is a 'VarDecl'
4841 RewriteObjCQualifiedInterfaceTypes(VD);
4842 if (isTopLevelBlockPointerType(VD->getType()))
67
Calling 'RewriteObjC::isTopLevelBlockPointerType'
70
Returning from 'RewriteObjC::isTopLevelBlockPointerType'
71
Taking false branch
4843 RewriteBlockPointerDecl(VD);
4844 else if (VD->getType()->isFunctionPointerType()) {
72
Assuming the condition is false
73
Taking false branch
4845 CheckFunctionPointerDecl(VD->getType(), VD);
4846 if (VD->getInit()) {
4847 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(VD->getInit())) {
4848 RewriteCastExpr(CE);
4849 }
4850 }
4851 } else if (VD->getType()->isRecordType()) {
74
Calling 'Type::isRecordType'
77
Returning from 'Type::isRecordType'
78
Taking true branch
4852 RecordDecl *RD = VD->getType()->getAs<RecordType>()->getDecl();
79
Assuming the object is not a 'RecordType'
80
Called C++ object pointer is null
4853 if (RD->isCompleteDefinition())
4854 RewriteRecordBody(RD);
4855 }
4856 if (VD->getInit()) {
4857 GlobalVarDecl = VD;
4858 CurrentBody = VD->getInit();
4859 RewriteFunctionBodyOrGlobalInitializer(VD->getInit());
4860 CurrentBody = nullptr;
4861 if (PropParentMap) {
4862 delete PropParentMap;
4863 PropParentMap = nullptr;
4864 }
4865 SynthesizeBlockLiterals(VD->getTypeSpecStartLoc(), VD->getName());
4866 GlobalVarDecl = nullptr;
4867
4868 // This is needed for blocks.
4869 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(VD->getInit())) {
4870 RewriteCastExpr(CE);
4871 }
4872 }
4873 break;
4874 }
4875 case Decl::TypeAlias:
4876 case Decl::Typedef: {
4877 if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(D)) {
4878 if (isTopLevelBlockPointerType(TD->getUnderlyingType()))
4879 RewriteBlockPointerDecl(TD);
4880 else if (TD->getUnderlyingType()->isFunctionPointerType())
4881 CheckFunctionPointerDecl(TD->getUnderlyingType(), TD);
4882 }
4883 break;
4884 }
4885 case Decl::CXXRecord:
4886 case Decl::Record: {
4887 RecordDecl *RD = cast<RecordDecl>(D);
4888 if (RD->isCompleteDefinition())
4889 RewriteRecordBody(RD);
4890 break;
4891 }
4892 default:
4893 break;
4894 }
4895 // Nothing yet.
4896}
4897
4898void RewriteObjC::HandleTranslationUnit(ASTContext &C) {
4899 if (Diags.hasErrorOccurred())
4900 return;
4901
4902 RewriteInclude();
4903
4904 // Here's a great place to add any extra declarations that may be needed.
4905 // Write out meta data for each @protocol(<expr>).
4906 for (ObjCProtocolDecl *ProtDecl : ProtocolExprDecls)
4907 RewriteObjCProtocolMetaData(ProtDecl, "", "", Preamble);
4908
4909 InsertText(SM->getLocForStartOfFile(MainFileID), Preamble, false);
4910 if (ClassImplementation.size() || CategoryImplementation.size())
4911 RewriteImplementations();
4912
4913 // Get the buffer corresponding to MainFileID. If we haven't changed it, then
4914 // we are done.
4915 if (const RewriteBuffer *RewriteBuf =
4916 Rewrite.getRewriteBufferFor(MainFileID)) {
4917 //printf("Changed:\n");
4918 *OutFile << std::string(RewriteBuf->begin(), RewriteBuf->end());
4919 } else {
4920 llvm::errs() << "No changes\n";
4921 }
4922
4923 if (ClassImplementation.size() || CategoryImplementation.size() ||
4924 ProtocolExprDecls.size()) {
4925 // Rewrite Objective-c meta data*
4926 std::string ResultStr;
4927 RewriteMetaDataIntoBuffer(ResultStr);
4928 // Emit metadata.
4929 *OutFile << ResultStr;
4930 }
4931 OutFile->flush();
4932}
4933
4934void RewriteObjCFragileABI::Initialize(ASTContext &context) {
4935 InitializeCommon(context);
4936
4937 // declaring objc_selector outside the parameter list removes a silly
4938 // scope related warning...
4939 if (IsHeader)
4940 Preamble = "#pragma once\n";
4941 Preamble += "struct objc_selector; struct objc_class;\n";
4942 Preamble += "struct __rw_objc_super { struct objc_object *object; ";
4943 Preamble += "struct objc_object *superClass; ";
4944 if (LangOpts.MicrosoftExt) {
4945 // Add a constructor for creating temporary objects.
4946 Preamble += "__rw_objc_super(struct objc_object *o, struct objc_object *s) "
4947 ": ";
4948 Preamble += "object(o), superClass(s) {} ";
4949 }
4950 Preamble += "};\n";
4951 Preamble += "#ifndef _REWRITER_typedef_Protocol\n";
4952 Preamble += "typedef struct objc_object Protocol;\n";
4953 Preamble += "#define _REWRITER_typedef_Protocol\n";
4954 Preamble += "#endif\n";
4955 if (LangOpts.MicrosoftExt) {
4956 Preamble += "#define __OBJC_RW_DLLIMPORT extern \"C\" __declspec(dllimport)\n";
4957 Preamble += "#define __OBJC_RW_STATICIMPORT extern \"C\"\n";
4958 } else
4959 Preamble += "#define __OBJC_RW_DLLIMPORT extern\n";
4960 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_msgSend";
4961 Preamble += "(struct objc_object *, struct objc_selector *, ...);\n";
4962 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_msgSendSuper";
4963 Preamble += "(struct objc_super *, struct objc_selector *, ...);\n";
4964 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object* objc_msgSend_stret";
4965 Preamble += "(struct objc_object *, struct objc_selector *, ...);\n";
4966 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object* objc_msgSendSuper_stret";
4967 Preamble += "(struct objc_super *, struct objc_selector *, ...);\n";
4968 Preamble += "__OBJC_RW_DLLIMPORT double objc_msgSend_fpret";
4969 Preamble += "(struct objc_object *, struct objc_selector *, ...);\n";
4970 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_getClass";
4971 Preamble += "(const char *);\n";
4972 Preamble += "__OBJC_RW_DLLIMPORT struct objc_class *class_getSuperclass";
4973 Preamble += "(struct objc_class *);\n";
4974 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_getMetaClass";
4975 Preamble += "(const char *);\n";
4976 Preamble += "__OBJC_RW_DLLIMPORT void objc_exception_throw(struct objc_object *);\n";
4977 Preamble += "__OBJC_RW_DLLIMPORT void objc_exception_try_enter(void *);\n";
4978 Preamble += "__OBJC_RW_DLLIMPORT void objc_exception_try_exit(void *);\n";
4979 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_exception_extract(void *);\n";
4980 Preamble += "__OBJC_RW_DLLIMPORT int objc_exception_match";
4981 Preamble += "(struct objc_class *, struct objc_object *);\n";
4982 // @synchronized hooks.
4983 Preamble += "__OBJC_RW_DLLIMPORT int objc_sync_enter(struct objc_object *);\n";
4984 Preamble += "__OBJC_RW_DLLIMPORT int objc_sync_exit(struct objc_object *);\n";
4985 Preamble += "__OBJC_RW_DLLIMPORT Protocol *objc_getProtocol(const char *);\n";
4986 Preamble += "#ifndef __FASTENUMERATIONSTATE\n";
4987 Preamble += "struct __objcFastEnumerationState {\n\t";
4988 Preamble += "unsigned long state;\n\t";
4989 Preamble += "void **itemsPtr;\n\t";
4990 Preamble += "unsigned long *mutationsPtr;\n\t";
4991 Preamble += "unsigned long extra[5];\n};\n";
4992 Preamble += "__OBJC_RW_DLLIMPORT void objc_enumerationMutation(struct objc_object *);\n";
4993 Preamble += "#define __FASTENUMERATIONSTATE\n";
4994 Preamble += "#endif\n";
4995 Preamble += "#ifndef __NSCONSTANTSTRINGIMPL\n";
4996 Preamble += "struct __NSConstantStringImpl {\n";
4997 Preamble += " int *isa;\n";
4998 Preamble += " int flags;\n";
4999 Preamble += " char *str;\n";
5000 Preamble += " long length;\n";
5001 Preamble += "};\n";
5002 Preamble += "#ifdef CF_EXPORT_CONSTANT_STRING\n";
5003 Preamble += "extern \"C\" __declspec(dllexport) int __CFConstantStringClassReference[];\n";
5004 Preamble += "#else\n";
5005 Preamble += "__OBJC_RW_DLLIMPORT int __CFConstantStringClassReference[];\n";
5006 Preamble += "#endif\n";
5007 Preamble += "#define __NSCONSTANTSTRINGIMPL\n";
5008 Preamble += "#endif\n";
5009 // Blocks preamble.
5010 Preamble += "#ifndef BLOCK_IMPL\n";
5011 Preamble += "#define BLOCK_IMPL\n";
5012 Preamble += "struct __block_impl {\n";
5013 Preamble += " void *isa;\n";
5014 Preamble += " int Flags;\n";
5015 Preamble += " int Reserved;\n";
5016 Preamble += " void *FuncPtr;\n";
5017 Preamble += "};\n";
5018 Preamble += "// Runtime copy/destroy helper functions (from Block_private.h)\n";
5019 Preamble += "#ifdef __OBJC_EXPORT_BLOCKS\n";
5020 Preamble += "extern \"C\" __declspec(dllexport) "
5021 "void _Block_object_assign(void *, const void *, const int);\n";
5022 Preamble += "extern \"C\" __declspec(dllexport) void _Block_object_dispose(const void *, const int);\n";
5023 Preamble += "extern \"C\" __declspec(dllexport) void *_NSConcreteGlobalBlock[32];\n";
5024 Preamble += "extern \"C\" __declspec(dllexport) void *_NSConcreteStackBlock[32];\n";
5025 Preamble += "#else\n";
5026 Preamble += "__OBJC_RW_DLLIMPORT void _Block_object_assign(void *, const void *, const int);\n";
5027 Preamble += "__OBJC_RW_DLLIMPORT void _Block_object_dispose(const void *, const int);\n";
5028 Preamble += "__OBJC_RW_DLLIMPORT void *_NSConcreteGlobalBlock[32];\n";
5029 Preamble += "__OBJC_RW_DLLIMPORT void *_NSConcreteStackBlock[32];\n";
5030 Preamble += "#endif\n";
5031 Preamble += "#endif\n";
5032 if (LangOpts.MicrosoftExt) {
5033 Preamble += "#undef __OBJC_RW_DLLIMPORT\n";
5034 Preamble += "#undef __OBJC_RW_STATICIMPORT\n";
5035 Preamble += "#ifndef KEEP_ATTRIBUTES\n"; // We use this for clang tests.
5036 Preamble += "#define __attribute__(X)\n";
5037 Preamble += "#endif\n";
5038 Preamble += "#define __weak\n";
5039 }
5040 else {
5041 Preamble += "#define __block\n";
5042 Preamble += "#define __weak\n";
5043 }
5044 // NOTE! Windows uses LLP64 for 64bit mode. So, cast pointer to long long
5045 // as this avoids warning in any 64bit/32bit compilation model.
5046 Preamble += "\n#define __OFFSETOFIVAR__(TYPE, MEMBER) ((long long) &((TYPE *)0)->MEMBER)\n";
5047}
5048
5049/// RewriteIvarOffsetComputation - This routine synthesizes computation of
5050/// ivar offset.
5051void RewriteObjCFragileABI::RewriteIvarOffsetComputation(ObjCIvarDecl *ivar,
5052 std::string &Result) {
5053 if (ivar->isBitField()) {
5054 // FIXME: The hack below doesn't work for bitfields. For now, we simply
5055 // place all bitfields at offset 0.
5056 Result += "0";
5057 } else {
5058 Result += "__OFFSETOFIVAR__(struct ";
5059 Result += ivar->getContainingInterface()->getNameAsString();
5060 if (LangOpts.MicrosoftExt)
5061 Result += "_IMPL";
5062 Result += ", ";
5063 Result += ivar->getNameAsString();
5064 Result += ")";
5065 }
5066}
5067
5068/// RewriteObjCProtocolMetaData - Rewrite protocols meta-data.
5069void RewriteObjCFragileABI::RewriteObjCProtocolMetaData(
5070 ObjCProtocolDecl *PDecl, StringRef prefix,
5071 StringRef ClassName, std::string &Result) {
5072 static bool objc_protocol_methods = false;
5073
5074 // Output struct protocol_methods holder of method selector and type.
5075 if (!objc_protocol_methods && PDecl->hasDefinition()) {
5076 /* struct protocol_methods {
5077 SEL _cmd;
5078 char *method_types;
5079 }
5080 */
5081 Result += "\nstruct _protocol_methods {\n";
5082 Result += "\tstruct objc_selector *_cmd;\n";
5083 Result += "\tchar *method_types;\n";
5084 Result += "};\n";
5085
5086 objc_protocol_methods = true;
5087 }
5088 // Do not synthesize the protocol more than once.
5089 if (ObjCSynthesizedProtocols.count(PDecl->getCanonicalDecl()))
5090 return;
5091
5092 if (ObjCProtocolDecl *Def = PDecl->getDefinition())
5093 PDecl = Def;
5094
5095 if (PDecl->instmeth_begin() != PDecl->instmeth_end()) {
5096 unsigned NumMethods = std::distance(PDecl->instmeth_begin(),
5097 PDecl->instmeth_end());
5098 /* struct _objc_protocol_method_list {
5099 int protocol_method_count;
5100 struct protocol_methods protocols[];
5101 }
5102 */
5103 Result += "\nstatic struct {\n";
5104 Result += "\tint protocol_method_count;\n";
5105 Result += "\tstruct _protocol_methods protocol_methods[";
5106 Result += utostr(NumMethods);
5107 Result += "];\n} _OBJC_PROTOCOL_INSTANCE_METHODS_";
5108 Result += PDecl->getNameAsString();
5109 Result += " __attribute__ ((used, section (\"__OBJC, __cat_inst_meth\")))= "
5110 "{\n\t" + utostr(NumMethods) + "\n";
5111
5112 // Output instance methods declared in this protocol.
5113 for (ObjCProtocolDecl::instmeth_iterator
5114 I = PDecl->instmeth_begin(), E = PDecl->instmeth_end();
5115 I != E; ++I) {
5116 if (I == PDecl->instmeth_begin())
5117 Result += "\t ,{{(struct objc_selector *)\"";
5118 else
5119 Result += "\t ,{(struct objc_selector *)\"";
5120 Result += (*I)->getSelector().getAsString();
5121 std::string MethodTypeString = Context->getObjCEncodingForMethodDecl(*I);
5122 Result += "\", \"";
5123 Result += MethodTypeString;
5124 Result += "\"}\n";
5125 }
5126 Result += "\t }\n};\n";
5127 }
5128
5129 // Output class methods declared in this protocol.
5130 unsigned NumMethods = std::distance(PDecl->classmeth_begin(),
5131 PDecl->classmeth_end());
5132 if (NumMethods > 0) {
5133 /* struct _objc_protocol_method_list {
5134 int protocol_method_count;
5135 struct protocol_methods protocols[];
5136 }
5137 */
5138 Result += "\nstatic struct {\n";
5139 Result += "\tint protocol_method_count;\n";
5140 Result += "\tstruct _protocol_methods protocol_methods[";
5141 Result += utostr(NumMethods);
5142 Result += "];\n} _OBJC_PROTOCOL_CLASS_METHODS_";
5143 Result += PDecl->getNameAsString();
5144 Result += " __attribute__ ((used, section (\"__OBJC, __cat_cls_meth\")))= "
5145 "{\n\t";
5146 Result += utostr(NumMethods);
5147 Result += "\n";
5148
5149 // Output instance methods declared in this protocol.
5150 for (ObjCProtocolDecl::classmeth_iterator
5151 I = PDecl->classmeth_begin(), E = PDecl->classmeth_end();
5152 I != E; ++I) {
5153 if (I == PDecl->classmeth_begin())
5154 Result += "\t ,{{(struct objc_selector *)\"";
5155 else
5156 Result += "\t ,{(struct objc_selector *)\"";
5157 Result += (*I)->getSelector().getAsString();
5158 std::string MethodTypeString = Context->getObjCEncodingForMethodDecl(*I);
5159 Result += "\", \"";
5160 Result += MethodTypeString;
5161 Result += "\"}\n";
5162 }
5163 Result += "\t }\n};\n";
5164 }
5165
5166 // Output:
5167 /* struct _objc_protocol {
5168 // Objective-C 1.0 extensions
5169 struct _objc_protocol_extension *isa;
5170 char *protocol_name;
5171 struct _objc_protocol **protocol_list;
5172 struct _objc_protocol_method_list *instance_methods;
5173 struct _objc_protocol_method_list *class_methods;
5174 };
5175 */
5176 static bool objc_protocol = false;
5177 if (!objc_protocol) {
5178 Result += "\nstruct _objc_protocol {\n";
5179 Result += "\tstruct _objc_protocol_extension *isa;\n";
5180 Result += "\tchar *protocol_name;\n";
5181 Result += "\tstruct _objc_protocol **protocol_list;\n";
5182 Result += "\tstruct _objc_protocol_method_list *instance_methods;\n";
5183 Result += "\tstruct _objc_protocol_method_list *class_methods;\n";
5184 Result += "};\n";
5185
5186 objc_protocol = true;
5187 }
5188
5189 Result += "\nstatic struct _objc_protocol _OBJC_PROTOCOL_";
5190 Result += PDecl->getNameAsString();
5191 Result += " __attribute__ ((used, section (\"__OBJC, __protocol\")))= "
5192 "{\n\t0, \"";
5193 Result += PDecl->getNameAsString();
5194 Result += "\", 0, ";
5195 if (PDecl->instmeth_begin() != PDecl->instmeth_end()) {
5196 Result += "(struct _objc_protocol_method_list *)&_OBJC_PROTOCOL_INSTANCE_METHODS_";
5197 Result += PDecl->getNameAsString();
5198 Result += ", ";
5199 }
5200 else
5201 Result += "0, ";
5202 if (PDecl->classmeth_begin() != PDecl->classmeth_end()) {
5203 Result += "(struct _objc_protocol_method_list *)&_OBJC_PROTOCOL_CLASS_METHODS_";
5204 Result += PDecl->getNameAsString();
5205 Result += "\n";
5206 }
5207 else
5208 Result += "0\n";
5209 Result += "};\n";
5210
5211 // Mark this protocol as having been generated.
5212 if (!ObjCSynthesizedProtocols.insert(PDecl->getCanonicalDecl()).second)
5213 llvm_unreachable("protocol already synthesized")::llvm::llvm_unreachable_internal("protocol already synthesized"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 5213)
;
5214}
5215
5216void RewriteObjCFragileABI::RewriteObjCProtocolListMetaData(
5217 const ObjCList<ObjCProtocolDecl> &Protocols,
5218 StringRef prefix, StringRef ClassName,
5219 std::string &Result) {
5220 if (Protocols.empty()) return;
5221
5222 for (unsigned i = 0; i != Protocols.size(); i++)
5223 RewriteObjCProtocolMetaData(Protocols[i], prefix, ClassName, Result);
5224
5225 // Output the top lovel protocol meta-data for the class.
5226 /* struct _objc_protocol_list {
5227 struct _objc_protocol_list *next;
5228 int protocol_count;
5229 struct _objc_protocol *class_protocols[];
5230 }
5231 */
5232 Result += "\nstatic struct {\n";
5233 Result += "\tstruct _objc_protocol_list *next;\n";
5234 Result += "\tint protocol_count;\n";
5235 Result += "\tstruct _objc_protocol *class_protocols[";
5236 Result += utostr(Protocols.size());
5237 Result += "];\n} _OBJC_";
5238 Result += prefix;
5239 Result += "_PROTOCOLS_";
5240 Result += ClassName;
5241 Result += " __attribute__ ((used, section (\"__OBJC, __cat_cls_meth\")))= "
5242 "{\n\t0, ";
5243 Result += utostr(Protocols.size());
5244 Result += "\n";
5245
5246 Result += "\t,{&_OBJC_PROTOCOL_";
5247 Result += Protocols[0]->getNameAsString();
5248 Result += " \n";
5249
5250 for (unsigned i = 1; i != Protocols.size(); i++) {
5251 Result += "\t ,&_OBJC_PROTOCOL_";
5252 Result += Protocols[i]->getNameAsString();
5253 Result += "\n";
5254 }
5255 Result += "\t }\n};\n";
5256}
5257
5258void RewriteObjCFragileABI::RewriteObjCClassMetaData(ObjCImplementationDecl *IDecl,
5259 std::string &Result) {
5260 ObjCInterfaceDecl *CDecl = IDecl->getClassInterface();
5261
5262 // Explicitly declared @interface's are already synthesized.
5263 if (CDecl->isImplicitInterfaceDecl()) {
5264 // FIXME: Implementation of a class with no @interface (legacy) does not
5265 // produce correct synthesis as yet.
5266 RewriteObjCInternalStruct(CDecl, Result);
5267 }
5268
5269 // Build _objc_ivar_list metadata for classes ivars if needed
5270 unsigned NumIvars = !IDecl->ivar_empty()
5271 ? IDecl->ivar_size()
5272 : (CDecl ? CDecl->ivar_size() : 0);
5273 if (NumIvars > 0) {
5274 static bool objc_ivar = false;
5275 if (!objc_ivar) {
5276 /* struct _objc_ivar {
5277 char *ivar_name;
5278 char *ivar_type;
5279 int ivar_offset;
5280 };
5281 */
5282 Result += "\nstruct _objc_ivar {\n";
5283 Result += "\tchar *ivar_name;\n";
5284 Result += "\tchar *ivar_type;\n";
5285 Result += "\tint ivar_offset;\n";
5286 Result += "};\n";
5287
5288 objc_ivar = true;
5289 }
5290
5291 /* struct {
5292 int ivar_count;
5293 struct _objc_ivar ivar_list[nIvars];
5294 };
5295 */
5296 Result += "\nstatic struct {\n";
5297 Result += "\tint ivar_count;\n";
5298 Result += "\tstruct _objc_ivar ivar_list[";
5299 Result += utostr(NumIvars);
5300 Result += "];\n} _OBJC_INSTANCE_VARIABLES_";
5301 Result += IDecl->getNameAsString();
5302 Result += " __attribute__ ((used, section (\"__OBJC, __instance_vars\")))= "
5303 "{\n\t";
5304 Result += utostr(NumIvars);
5305 Result += "\n";
5306
5307 ObjCInterfaceDecl::ivar_iterator IVI, IVE;
5308 SmallVector<ObjCIvarDecl *, 8> IVars;
5309 if (!IDecl->ivar_empty()) {
5310 for (auto *IV : IDecl->ivars())
5311 IVars.push_back(IV);
5312 IVI = IDecl->ivar_begin();
5313 IVE = IDecl->ivar_end();
5314 } else {
5315 IVI = CDecl->ivar_begin();
5316 IVE = CDecl->ivar_end();
5317 }
5318 Result += "\t,{{\"";
5319 Result += IVI->getNameAsString();
5320 Result += "\", \"";
5321 std::string TmpString, StrEncoding;
5322 Context->getObjCEncodingForType(IVI->getType(), TmpString, *IVI);
5323 QuoteDoublequotes(TmpString, StrEncoding);
5324 Result += StrEncoding;
5325 Result += "\", ";
5326 RewriteIvarOffsetComputation(*IVI, Result);
5327 Result += "}\n";
5328 for (++IVI; IVI != IVE; ++IVI) {
5329 Result += "\t ,{\"";
5330 Result += IVI->getNameAsString();
5331 Result += "\", \"";
5332 std::string TmpString, StrEncoding;
5333 Context->getObjCEncodingForType(IVI->getType(), TmpString, *IVI);
5334 QuoteDoublequotes(TmpString, StrEncoding);
5335 Result += StrEncoding;
5336 Result += "\", ";
5337 RewriteIvarOffsetComputation(*IVI, Result);
5338 Result += "}\n";
5339 }
5340
5341 Result += "\t }\n};\n";
5342 }
5343
5344 // Build _objc_method_list for class's instance methods if needed
5345 SmallVector<ObjCMethodDecl *, 32> InstanceMethods(IDecl->instance_methods());
5346
5347 // If any of our property implementations have associated getters or
5348 // setters, produce metadata for them as well.
5349 for (const auto *Prop : IDecl->property_impls()) {
5350 if (Prop->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic)
5351 continue;
5352 if (!Prop->getPropertyIvarDecl())
5353 continue;
5354 ObjCPropertyDecl *PD = Prop->getPropertyDecl();
5355 if (!PD)
5356 continue;
5357 if (ObjCMethodDecl *Getter = PD->getGetterMethodDecl())
5358 if (!Getter->isDefined())
5359 InstanceMethods.push_back(Getter);
5360 if (PD->isReadOnly())
5361 continue;
5362 if (ObjCMethodDecl *Setter = PD->getSetterMethodDecl())
5363 if (!Setter->isDefined())
5364 InstanceMethods.push_back(Setter);
5365 }
5366 RewriteObjCMethodsMetaData(InstanceMethods.begin(), InstanceMethods.end(),
5367 true, "", IDecl->getName(), Result);
5368
5369 // Build _objc_method_list for class's class methods if needed
5370 RewriteObjCMethodsMetaData(IDecl->classmeth_begin(), IDecl->classmeth_end(),
5371 false, "", IDecl->getName(), Result);
5372
5373 // Protocols referenced in class declaration?
5374 RewriteObjCProtocolListMetaData(CDecl->getReferencedProtocols(),
5375 "CLASS", CDecl->getName(), Result);
5376
5377 // Declaration of class/meta-class metadata
5378 /* struct _objc_class {
5379 struct _objc_class *isa; // or const char *root_class_name when metadata
5380 const char *super_class_name;
5381 char *name;
5382 long version;
5383 long info;
5384 long instance_size;
5385 struct _objc_ivar_list *ivars;
5386 struct _objc_method_list *methods;
5387 struct objc_cache *cache;
5388 struct objc_protocol_list *protocols;
5389 const char *ivar_layout;
5390 struct _objc_class_ext *ext;
5391 };
5392 */
5393 static bool objc_class = false;
5394 if (!objc_class) {
5395 Result += "\nstruct _objc_class {\n";
5396 Result += "\tstruct _objc_class *isa;\n";
5397 Result += "\tconst char *super_class_name;\n";
5398 Result += "\tchar *name;\n";
5399 Result += "\tlong version;\n";
5400 Result += "\tlong info;\n";
5401 Result += "\tlong instance_size;\n";
5402 Result += "\tstruct _objc_ivar_list *ivars;\n";
5403 Result += "\tstruct _objc_method_list *methods;\n";
5404 Result += "\tstruct objc_cache *cache;\n";
5405 Result += "\tstruct _objc_protocol_list *protocols;\n";
5406 Result += "\tconst char *ivar_layout;\n";
5407 Result += "\tstruct _objc_class_ext *ext;\n";
5408 Result += "};\n";
5409 objc_class = true;
5410 }
5411
5412 // Meta-class metadata generation.
5413 ObjCInterfaceDecl *RootClass = nullptr;
5414 ObjCInterfaceDecl *SuperClass = CDecl->getSuperClass();
5415 while (SuperClass) {
5416 RootClass = SuperClass;
5417 SuperClass = SuperClass->getSuperClass();
5418 }
5419 SuperClass = CDecl->getSuperClass();
5420
5421 Result += "\nstatic struct _objc_class _OBJC_METACLASS_";
5422 Result += CDecl->getNameAsString();
5423 Result += " __attribute__ ((used, section (\"__OBJC, __meta_class\")))= "
5424 "{\n\t(struct _objc_class *)\"";
5425 Result += (RootClass ? RootClass->getNameAsString() : CDecl->getNameAsString());
5426 Result += "\"";
5427
5428 if (SuperClass) {
5429 Result += ", \"";
5430 Result += SuperClass->getNameAsString();
5431 Result += "\", \"";
5432 Result += CDecl->getNameAsString();
5433 Result += "\"";
5434 }
5435 else {
5436 Result += ", 0, \"";
5437 Result += CDecl->getNameAsString();
5438 Result += "\"";
5439 }
5440 // Set 'ivars' field for root class to 0. ObjC1 runtime does not use it.
5441 // 'info' field is initialized to CLS_META(2) for metaclass
5442 Result += ", 0,2, sizeof(struct _objc_class), 0";
5443 if (IDecl->classmeth_begin() != IDecl->classmeth_end()) {
5444 Result += "\n\t, (struct _objc_method_list *)&_OBJC_CLASS_METHODS_";
5445 Result += IDecl->getNameAsString();
5446 Result += "\n";
5447 }
5448 else
5449 Result += ", 0\n";
5450 if (CDecl->protocol_begin() != CDecl->protocol_end()) {
5451 Result += "\t,0, (struct _objc_protocol_list *)&_OBJC_CLASS_PROTOCOLS_";
5452 Result += CDecl->getNameAsString();
5453 Result += ",0,0\n";
5454 }
5455 else
5456 Result += "\t,0,0,0,0\n";
5457 Result += "};\n";
5458
5459 // class metadata generation.
5460 Result += "\nstatic struct _objc_class _OBJC_CLASS_";
5461 Result += CDecl->getNameAsString();
5462 Result += " __attribute__ ((used, section (\"__OBJC, __class\")))= "
5463 "{\n\t&_OBJC_METACLASS_";
5464 Result += CDecl->getNameAsString();
5465 if (SuperClass) {
5466 Result += ", \"";
5467 Result += SuperClass->getNameAsString();
5468 Result += "\", \"";
5469 Result += CDecl->getNameAsString();
5470 Result += "\"";
5471 }
5472 else {
5473 Result += ", 0, \"";
5474 Result += CDecl->getNameAsString();
5475 Result += "\"";
5476 }
5477 // 'info' field is initialized to CLS_CLASS(1) for class
5478 Result += ", 0,1";
5479 if (!ObjCSynthesizedStructs.count(CDecl))
5480 Result += ",0";
5481 else {
5482 // class has size. Must synthesize its size.
5483 Result += ",sizeof(struct ";
5484 Result += CDecl->getNameAsString();
5485 if (LangOpts.MicrosoftExt)
5486 Result += "_IMPL";
5487 Result += ")";
5488 }
5489 if (NumIvars > 0) {
5490 Result += ", (struct _objc_ivar_list *)&_OBJC_INSTANCE_VARIABLES_";
5491 Result += CDecl->getNameAsString();
5492 Result += "\n\t";
5493 }
5494 else
5495 Result += ",0";
5496 if (IDecl->instmeth_begin() != IDecl->instmeth_end()) {
5497 Result += ", (struct _objc_method_list *)&_OBJC_INSTANCE_METHODS_";
5498 Result += CDecl->getNameAsString();
5499 Result += ", 0\n\t";
5500 }
5501 else
5502 Result += ",0,0";
5503 if (CDecl->protocol_begin() != CDecl->protocol_end()) {
5504 Result += ", (struct _objc_protocol_list*)&_OBJC_CLASS_PROTOCOLS_";
5505 Result += CDecl->getNameAsString();
5506 Result += ", 0,0\n";
5507 }
5508 else
5509 Result += ",0,0,0\n";
5510 Result += "};\n";
5511}
5512
5513void RewriteObjCFragileABI::RewriteMetaDataIntoBuffer(std::string &Result) {
5514 int ClsDefCount = ClassImplementation.size();
5515 int CatDefCount = CategoryImplementation.size();
5516
5517 // For each implemented class, write out all its meta data.
5518 for (int i = 0; i < ClsDefCount; i++)
5519 RewriteObjCClassMetaData(ClassImplementation[i], Result);
5520
5521 // For each implemented category, write out all its meta data.
5522 for (int i = 0; i < CatDefCount; i++)
5523 RewriteObjCCategoryImplDecl(CategoryImplementation[i], Result);
5524
5525 // Write objc_symtab metadata
5526 /*
5527 struct _objc_symtab
5528 {
5529 long sel_ref_cnt;
5530 SEL *refs;
5531 short cls_def_cnt;
5532 short cat_def_cnt;
5533 void *defs[cls_def_cnt + cat_def_cnt];
5534 };
5535 */
5536
5537 Result += "\nstruct _objc_symtab {\n";
5538 Result += "\tlong sel_ref_cnt;\n";
5539 Result += "\tSEL *refs;\n";
5540 Result += "\tshort cls_def_cnt;\n";
5541 Result += "\tshort cat_def_cnt;\n";
5542 Result += "\tvoid *defs[" + utostr(ClsDefCount + CatDefCount)+ "];\n";
5543 Result += "};\n\n";
5544
5545 Result += "static struct _objc_symtab "
5546 "_OBJC_SYMBOLS __attribute__((used, section (\"__OBJC, __symbols\")))= {\n";
5547 Result += "\t0, 0, " + utostr(ClsDefCount)
5548 + ", " + utostr(CatDefCount) + "\n";
5549 for (int i = 0; i < ClsDefCount; i++) {
5550 Result += "\t,&_OBJC_CLASS_";
5551 Result += ClassImplementation[i]->getNameAsString();
5552 Result += "\n";
5553 }
5554
5555 for (int i = 0; i < CatDefCount; i++) {
5556 Result += "\t,&_OBJC_CATEGORY_";
5557 Result += CategoryImplementation[i]->getClassInterface()->getNameAsString();
5558 Result += "_";
5559 Result += CategoryImplementation[i]->getNameAsString();
5560 Result += "\n";
5561 }
5562
5563 Result += "};\n\n";
5564
5565 // Write objc_module metadata
5566
5567 /*
5568 struct _objc_module {
5569 long version;
5570 long size;
5571 const char *name;
5572 struct _objc_symtab *symtab;
5573 }
5574 */
5575
5576 Result += "\nstruct _objc_module {\n";
5577 Result += "\tlong version;\n";
5578 Result += "\tlong size;\n";
5579 Result += "\tconst char *name;\n";
5580 Result += "\tstruct _objc_symtab *symtab;\n";
5581 Result += "};\n\n";
5582 Result += "static struct _objc_module "
5583 "_OBJC_MODULES __attribute__ ((used, section (\"__OBJC, __module_info\")))= {\n";
5584 Result += "\t" + utostr(OBJC_ABI_VERSION) +
5585 ", sizeof(struct _objc_module), \"\", &_OBJC_SYMBOLS\n";
5586 Result += "};\n\n";
5587
5588 if (LangOpts.MicrosoftExt) {
5589 if (ProtocolExprDecls.size()) {
5590 Result += "#pragma section(\".objc_protocol$B\",long,read,write)\n";
5591 Result += "#pragma data_seg(push, \".objc_protocol$B\")\n";
5592 for (ObjCProtocolDecl *ProtDecl : ProtocolExprDecls) {
5593 Result += "static struct _objc_protocol *_POINTER_OBJC_PROTOCOL_";
5594 Result += ProtDecl->getNameAsString();
5595 Result += " = &_OBJC_PROTOCOL_";
5596 Result += ProtDecl->getNameAsString();
5597 Result += ";\n";
5598 }
5599 Result += "#pragma data_seg(pop)\n\n";
5600 }
5601 Result += "#pragma section(\".objc_module_info$B\",long,read,write)\n";
5602 Result += "#pragma data_seg(push, \".objc_module_info$B\")\n";
5603 Result += "static struct _objc_module *_POINTER_OBJC_MODULES = ";
5604 Result += "&_OBJC_MODULES;\n";
5605 Result += "#pragma data_seg(pop)\n\n";
5606 }
5607}
5608
5609/// RewriteObjCCategoryImplDecl - Rewrite metadata for each category
5610/// implementation.
5611void RewriteObjCFragileABI::RewriteObjCCategoryImplDecl(ObjCCategoryImplDecl *IDecl,
5612 std::string &Result) {
5613 ObjCInterfaceDecl *ClassDecl = IDecl->getClassInterface();
5614 // Find category declaration for this implementation.
5615 ObjCCategoryDecl *CDecl
5616 = ClassDecl->FindCategoryDeclaration(IDecl->getIdentifier());
5617
5618 std::string FullCategoryName = ClassDecl->getNameAsString();
5619 FullCategoryName += '_';
5620 FullCategoryName += IDecl->getNameAsString();
5621
5622 // Build _objc_method_list for class's instance methods if needed
5623 SmallVector<ObjCMethodDecl *, 32> InstanceMethods(IDecl->instance_methods());
5624
5625 // If any of our property implementations have associated getters or
5626 // setters, produce metadata for them as well.
5627 for (const auto *Prop : IDecl->property_impls()) {
5628 if (Prop->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic)
5629 continue;
5630 if (!Prop->getPropertyIvarDecl())
5631 continue;
5632 ObjCPropertyDecl *PD = Prop->getPropertyDecl();
5633 if (!PD)
5634 continue;
5635 if (ObjCMethodDecl *Getter = PD->getGetterMethodDecl())
5636 InstanceMethods.push_back(Getter);
5637 if (PD->isReadOnly())
5638 continue;
5639 if (ObjCMethodDecl *Setter = PD->getSetterMethodDecl())
5640 InstanceMethods.push_back(Setter);
5641 }
5642 RewriteObjCMethodsMetaData(InstanceMethods.begin(), InstanceMethods.end(),
5643 true, "CATEGORY_", FullCategoryName, Result);
5644
5645 // Build _objc_method_list for class's class methods if needed
5646 RewriteObjCMethodsMetaData(IDecl->classmeth_begin(), IDecl->classmeth_end(),
5647 false, "CATEGORY_", FullCategoryName, Result);
5648
5649 // Protocols referenced in class declaration?
5650 // Null CDecl is case of a category implementation with no category interface
5651 if (CDecl)
5652 RewriteObjCProtocolListMetaData(CDecl->getReferencedProtocols(), "CATEGORY",
5653 FullCategoryName, Result);
5654 /* struct _objc_category {
5655 char *category_name;
5656 char *class_name;
5657 struct _objc_method_list *instance_methods;
5658 struct _objc_method_list *class_methods;
5659 struct _objc_protocol_list *protocols;
5660 // Objective-C 1.0 extensions
5661 uint32_t size; // sizeof (struct _objc_category)
5662 struct _objc_property_list *instance_properties; // category's own
5663 // @property decl.
5664 };
5665 */
5666
5667 static bool objc_category = false;
5668 if (!objc_category) {
5669 Result += "\nstruct _objc_category {\n";
5670 Result += "\tchar *category_name;\n";
5671 Result += "\tchar *class_name;\n";
5672 Result += "\tstruct _objc_method_list *instance_methods;\n";
5673 Result += "\tstruct _objc_method_list *class_methods;\n";
5674 Result += "\tstruct _objc_protocol_list *protocols;\n";
5675 Result += "\tunsigned int size;\n";
5676 Result += "\tstruct _objc_property_list *instance_properties;\n";
5677 Result += "};\n";
5678 objc_category = true;
5679 }
5680 Result += "\nstatic struct _objc_category _OBJC_CATEGORY_";
5681 Result += FullCategoryName;
5682 Result += " __attribute__ ((used, section (\"__OBJC, __category\")))= {\n\t\"";
5683 Result += IDecl->getNameAsString();
5684 Result += "\"\n\t, \"";
5685 Result += ClassDecl->getNameAsString();
5686 Result += "\"\n";
5687
5688 if (IDecl->instmeth_begin() != IDecl->instmeth_end()) {
5689 Result += "\t, (struct _objc_method_list *)"
5690 "&_OBJC_CATEGORY_INSTANCE_METHODS_";
5691 Result += FullCategoryName;
5692 Result += "\n";
5693 }
5694 else
5695 Result += "\t, 0\n";
5696 if (IDecl->classmeth_begin() != IDecl->classmeth_end()) {
5697 Result += "\t, (struct _objc_method_list *)"
5698 "&_OBJC_CATEGORY_CLASS_METHODS_";
5699 Result += FullCategoryName;
5700 Result += "\n";
5701 }
5702 else
5703 Result += "\t, 0\n";
5704
5705 if (CDecl && CDecl->protocol_begin() != CDecl->protocol_end()) {
5706 Result += "\t, (struct _objc_protocol_list *)&_OBJC_CATEGORY_PROTOCOLS_";
5707 Result += FullCategoryName;
5708 Result += "\n";
5709 }
5710 else
5711 Result += "\t, 0\n";
5712 Result += "\t, sizeof(struct _objc_category), 0\n};\n";
5713}
5714
5715// RewriteObjCMethodsMetaData - Rewrite methods metadata for instance or
5716/// class methods.
5717template<typename MethodIterator>
5718void RewriteObjCFragileABI::RewriteObjCMethodsMetaData(MethodIterator MethodBegin,
5719 MethodIterator MethodEnd,
5720 bool IsInstanceMethod,
5721 StringRef prefix,
5722 StringRef ClassName,
5723 std::string &Result) {
5724 if (MethodBegin == MethodEnd) return;
5725
5726 if (!objc_impl_method) {
5727 /* struct _objc_method {
5728 SEL _cmd;
5729 char *method_types;
5730 void *_imp;
5731 }
5732 */
5733 Result += "\nstruct _objc_method {\n";
5734 Result += "\tSEL _cmd;\n";
5735 Result += "\tchar *method_types;\n";
5736 Result += "\tvoid *_imp;\n";
5737 Result += "};\n";
5738
5739 objc_impl_method = true;
5740 }
5741
5742 // Build _objc_method_list for class's methods if needed
5743
5744 /* struct {
5745 struct _objc_method_list *next_method;
5746 int method_count;
5747 struct _objc_method method_list[];
5748 }
5749 */
5750 unsigned NumMethods = std::distance(MethodBegin, MethodEnd);
5751 Result += "\nstatic struct {\n";
5752 Result += "\tstruct _objc_method_list *next_method;\n";
5753 Result += "\tint method_count;\n";
5754 Result += "\tstruct _objc_method method_list[";
5755 Result += utostr(NumMethods);
5756 Result += "];\n} _OBJC_";
5757 Result += prefix;
5758 Result += IsInstanceMethod ? "INSTANCE" : "CLASS";
5759 Result += "_METHODS_";
5760 Result += ClassName;
5761 Result += " __attribute__ ((used, section (\"__OBJC, __";
5762 Result += IsInstanceMethod ? "inst" : "cls";
5763 Result += "_meth\")))= ";
5764 Result += "{\n\t0, " + utostr(NumMethods) + "\n";
5765
5766 Result += "\t,{{(SEL)\"";
5767 Result += (*MethodBegin)->getSelector().getAsString();
5768 std::string MethodTypeString =
5769 Context->getObjCEncodingForMethodDecl(*MethodBegin);
5770 Result += "\", \"";
5771 Result += MethodTypeString;
5772 Result += "\", (void *)";
5773 Result += MethodInternalNames[*MethodBegin];
5774 Result += "}\n";
5775 for (++MethodBegin; MethodBegin != MethodEnd; ++MethodBegin) {
5776 Result += "\t ,{(SEL)\"";
5777 Result += (*MethodBegin)->getSelector().getAsString();
5778 std::string MethodTypeString =
5779 Context->getObjCEncodingForMethodDecl(*MethodBegin);
5780 Result += "\", \"";
5781 Result += MethodTypeString;
5782 Result += "\", (void *)";
5783 Result += MethodInternalNames[*MethodBegin];
5784 Result += "}\n";
5785 }
5786 Result += "\t }\n};\n";
5787}
5788
5789Stmt *RewriteObjCFragileABI::RewriteObjCIvarRefExpr(ObjCIvarRefExpr *IV) {
5790 SourceRange OldRange = IV->getSourceRange();
5791 Expr *BaseExpr = IV->getBase();
5792
5793 // Rewrite the base, but without actually doing replaces.
5794 {
5795 DisableReplaceStmtScope S(*this);
5796 BaseExpr = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(BaseExpr));
5797 IV->setBase(BaseExpr);
5798 }
5799
5800 ObjCIvarDecl *D = IV->getDecl();
5801
5802 Expr *Replacement = IV;
5803 if (CurMethodDef) {
5804 if (BaseExpr->getType()->isObjCObjectPointerType()) {
5805 const ObjCInterfaceType *iFaceDecl =
5806 dyn_cast<ObjCInterfaceType>(BaseExpr->getType()->getPointeeType());
5807 assert(iFaceDecl && "RewriteObjCIvarRefExpr - iFaceDecl is null")((iFaceDecl && "RewriteObjCIvarRefExpr - iFaceDecl is null"
) ? static_cast<void> (0) : __assert_fail ("iFaceDecl && \"RewriteObjCIvarRefExpr - iFaceDecl is null\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 5807, __PRETTY_FUNCTION__))
;
5808 // lookup which class implements the instance variable.
5809 ObjCInterfaceDecl *clsDeclared = nullptr;
5810 iFaceDecl->getDecl()->lookupInstanceVariable(D->getIdentifier(),
5811 clsDeclared);
5812 assert(clsDeclared && "RewriteObjCIvarRefExpr(): Can't find class")((clsDeclared && "RewriteObjCIvarRefExpr(): Can't find class"
) ? static_cast<void> (0) : __assert_fail ("clsDeclared && \"RewriteObjCIvarRefExpr(): Can't find class\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 5812, __PRETTY_FUNCTION__))
;
5813
5814 // Synthesize an explicit cast to gain access to the ivar.
5815 std::string RecName = clsDeclared->getIdentifier()->getName();
5816 RecName += "_IMPL";
5817 IdentifierInfo *II = &Context->Idents.get(RecName);
5818 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
5819 SourceLocation(), SourceLocation(),
5820 II);
5821 assert(RD && "RewriteObjCIvarRefExpr(): Can't find RecordDecl")((RD && "RewriteObjCIvarRefExpr(): Can't find RecordDecl"
) ? static_cast<void> (0) : __assert_fail ("RD && \"RewriteObjCIvarRefExpr(): Can't find RecordDecl\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 5821, __PRETTY_FUNCTION__))
;
5822 QualType castT = Context->getPointerType(Context->getTagDeclType(RD));
5823 CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, castT,
5824 CK_BitCast,
5825 IV->getBase());
5826 // Don't forget the parens to enforce the proper binding.
5827 ParenExpr *PE = new (Context) ParenExpr(OldRange.getBegin(),
5828 OldRange.getEnd(),
5829 castExpr);
5830 if (IV->isFreeIvar() &&
5831 declaresSameEntity(CurMethodDef->getClassInterface(),
5832 iFaceDecl->getDecl())) {
5833 MemberExpr *ME = MemberExpr::CreateImplicit(
5834 *Context, PE, true, D, D->getType(), VK_LValue, OK_Ordinary);
5835 Replacement = ME;
5836 } else {
5837 IV->setBase(PE);
5838 }
5839 }
5840 } else { // we are outside a method.
5841 assert(!IV->isFreeIvar() && "Cannot have a free standing ivar outside a method")((!IV->isFreeIvar() && "Cannot have a free standing ivar outside a method"
) ? static_cast<void> (0) : __assert_fail ("!IV->isFreeIvar() && \"Cannot have a free standing ivar outside a method\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 5841, __PRETTY_FUNCTION__))
;
5842
5843 // Explicit ivar refs need to have a cast inserted.
5844 // FIXME: consider sharing some of this code with the code above.
5845 if (BaseExpr->getType()->isObjCObjectPointerType()) {
5846 const ObjCInterfaceType *iFaceDecl =
5847 dyn_cast<ObjCInterfaceType>(BaseExpr->getType()->getPointeeType());
5848 // lookup which class implements the instance variable.
5849 ObjCInterfaceDecl *clsDeclared = nullptr;
5850 iFaceDecl->getDecl()->lookupInstanceVariable(D->getIdentifier(),
5851 clsDeclared);
5852 assert(clsDeclared && "RewriteObjCIvarRefExpr(): Can't find class")((clsDeclared && "RewriteObjCIvarRefExpr(): Can't find class"
) ? static_cast<void> (0) : __assert_fail ("clsDeclared && \"RewriteObjCIvarRefExpr(): Can't find class\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 5852, __PRETTY_FUNCTION__))
;
5853
5854 // Synthesize an explicit cast to gain access to the ivar.
5855 std::string RecName = clsDeclared->getIdentifier()->getName();
5856 RecName += "_IMPL";
5857 IdentifierInfo *II = &Context->Idents.get(RecName);
5858 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
5859 SourceLocation(), SourceLocation(),
5860 II);
5861 assert(RD && "RewriteObjCIvarRefExpr(): Can't find RecordDecl")((RD && "RewriteObjCIvarRefExpr(): Can't find RecordDecl"
) ? static_cast<void> (0) : __assert_fail ("RD && \"RewriteObjCIvarRefExpr(): Can't find RecordDecl\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/lib/Frontend/Rewrite/RewriteObjC.cpp"
, 5861, __PRETTY_FUNCTION__))
;
5862 QualType castT = Context->getPointerType(Context->getTagDeclType(RD));
5863 CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, castT,
5864 CK_BitCast,
5865 IV->getBase());
5866 // Don't forget the parens to enforce the proper binding.
5867 ParenExpr *PE = new (Context) ParenExpr(
5868 IV->getBase()->getBeginLoc(), IV->getBase()->getEndLoc(), castExpr);
5869 // Cannot delete IV->getBase(), since PE points to it.
5870 // Replace the old base with the cast. This is important when doing
5871 // embedded rewrites. For example, [newInv->_container addObject:0].
5872 IV->setBase(PE);
5873 }
5874 }
5875
5876 ReplaceStmtWithRange(IV, Replacement, OldRange);
5877 return Replacement;
5878}
5879
5880#endif // CLANG_ENABLE_OBJC_REWRITER

/build/llvm-toolchain-snapshot-10~svn373517/tools/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
69} // namespace clang
70
71namespace llvm {
72
73 template <typename T>
74 struct PointerLikeTypeTraits;
75 template<>
76 struct PointerLikeTypeTraits< ::clang::Type*> {
77 static inline void *getAsVoidPointer(::clang::Type *P) { return P; }
78
79 static inline ::clang::Type *getFromVoidPointer(void *P) {
80 return static_cast< ::clang::Type*>(P);
81 }
82
83 enum { NumLowBitsAvailable = clang::TypeAlignmentInBits };
84 };
85
86 template<>
87 struct PointerLikeTypeTraits< ::clang::ExtQuals*> {
88 static inline void *getAsVoidPointer(::clang::ExtQuals *P) { return P; }
89
90 static inline ::clang::ExtQuals *getFromVoidPointer(void *P) {
91 return static_cast< ::clang::ExtQuals*>(P);
92 }
93
94 enum { NumLowBitsAvailable = clang::TypeAlignmentInBits };
95 };
96
97} // namespace llvm
98
99namespace clang {
100
101class ASTContext;
102template <typename> class CanQual;
103class CXXRecordDecl;
104class DeclContext;
105class EnumDecl;
106class Expr;
107class ExtQualsTypeCommonBase;
108class FunctionDecl;
109class IdentifierInfo;
110class NamedDecl;
111class ObjCInterfaceDecl;
112class ObjCProtocolDecl;
113class ObjCTypeParamDecl;
114struct PrintingPolicy;
115class RecordDecl;
116class Stmt;
117class TagDecl;
118class TemplateArgument;
119class TemplateArgumentListInfo;
120class TemplateArgumentLoc;
121class TemplateTypeParmDecl;
122class TypedefNameDecl;
123class UnresolvedUsingTypenameDecl;
124
125using CanQualType = CanQual<Type>;
126
127// Provide forward declarations for all of the *Type classes.
128#define TYPE(Class, Base) class Class##Type;
129#include "clang/AST/TypeNodes.inc"
130
131/// The collection of all-type qualifiers we support.
132/// Clang supports five independent qualifiers:
133/// * C99: const, volatile, and restrict
134/// * MS: __unaligned
135/// * Embedded C (TR18037): address spaces
136/// * Objective C: the GC attributes (none, weak, or strong)
137class Qualifiers {
138public:
139 enum TQ { // NOTE: These flags must be kept in sync with DeclSpec::TQ.
140 Const = 0x1,
141 Restrict = 0x2,
142 Volatile = 0x4,
143 CVRMask = Const | Volatile | Restrict
144 };
145
146 enum GC {
147 GCNone = 0,
148 Weak,
149 Strong
150 };
151
152 enum ObjCLifetime {
153 /// There is no lifetime qualification on this type.
154 OCL_None,
155
156 /// This object can be modified without requiring retains or
157 /// releases.
158 OCL_ExplicitNone,
159
160 /// Assigning into this object requires the old value to be
161 /// released and the new value to be retained. The timing of the
162 /// release of the old value is inexact: it may be moved to
163 /// immediately after the last known point where the value is
164 /// live.
165 OCL_Strong,
166
167 /// Reading or writing from this object requires a barrier call.
168 OCL_Weak,
169
170 /// Assigning into this object requires a lifetime extension.
171 OCL_Autoreleasing
172 };
173
174 enum {
175 /// The maximum supported address space number.
176 /// 23 bits should be enough for anyone.
177 MaxAddressSpace = 0x7fffffu,
178
179 /// The width of the "fast" qualifier mask.
180 FastWidth = 3,
181
182 /// The fast qualifier mask.
183 FastMask = (1 << FastWidth) - 1
184 };
185
186 /// Returns the common set of qualifiers while removing them from
187 /// the given sets.
188 static Qualifiers removeCommonQualifiers(Qualifiers &L, Qualifiers &R) {
189 // If both are only CVR-qualified, bit operations are sufficient.
190 if (!(L.Mask & ~CVRMask) && !(R.Mask & ~CVRMask)) {
191 Qualifiers Q;
192 Q.Mask = L.Mask & R.Mask;
193 L.Mask &= ~Q.Mask;
194 R.Mask &= ~Q.Mask;
195 return Q;
196 }
197
198 Qualifiers Q;
199 unsigned CommonCRV = L.getCVRQualifiers() & R.getCVRQualifiers();
200 Q.addCVRQualifiers(CommonCRV);
201 L.removeCVRQualifiers(CommonCRV);
202 R.removeCVRQualifiers(CommonCRV);
203
204 if (L.getObjCGCAttr() == R.getObjCGCAttr()) {
205 Q.setObjCGCAttr(L.getObjCGCAttr());
206 L.removeObjCGCAttr();
207 R.removeObjCGCAttr();
208 }
209
210 if (L.getObjCLifetime() == R.getObjCLifetime()) {
211 Q.setObjCLifetime(L.getObjCLifetime());
212 L.removeObjCLifetime();
213 R.removeObjCLifetime();
214 }
215
216 if (L.getAddressSpace() == R.getAddressSpace()) {
217 Q.setAddressSpace(L.getAddressSpace());
218 L.removeAddressSpace();
219 R.removeAddressSpace();
220 }
221 return Q;
222 }
223
224 static Qualifiers fromFastMask(unsigned Mask) {
225 Qualifiers Qs;
226 Qs.addFastQualifiers(Mask);
227 return Qs;
228 }
229
230 static Qualifiers fromCVRMask(unsigned CVR) {
231 Qualifiers Qs;
232 Qs.addCVRQualifiers(CVR);
233 return Qs;
234 }
235
236 static Qualifiers fromCVRUMask(unsigned CVRU) {
237 Qualifiers Qs;
238 Qs.addCVRUQualifiers(CVRU);
239 return Qs;
240 }
241
242 // Deserialize qualifiers from an opaque representation.
243 static Qualifiers fromOpaqueValue(unsigned opaque) {
244 Qualifiers Qs;
245 Qs.Mask = opaque;
246 return Qs;
247 }
248
249 // Serialize these qualifiers into an opaque representation.
250 unsigned getAsOpaqueValue() const {
251 return Mask;
252 }
253
254 bool hasConst() const { return Mask & Const; }
255 bool hasOnlyConst() const { return Mask == Const; }
256 void removeConst() { Mask &= ~Const; }
257 void addConst() { Mask |= Const; }
258
259 bool hasVolatile() const { return Mask & Volatile; }
260 bool hasOnlyVolatile() const { return Mask == Volatile; }
261 void removeVolatile() { Mask &= ~Volatile; }
262 void addVolatile() { Mask |= Volatile; }
263
264 bool hasRestrict() const { return Mask & Restrict; }
265 bool hasOnlyRestrict() const { return Mask == Restrict; }
266 void removeRestrict() { Mask &= ~Restrict; }
267 void addRestrict() { Mask |= Restrict; }
268
269 bool hasCVRQualifiers() const { return getCVRQualifiers(); }
270 unsigned getCVRQualifiers() const { return Mask & CVRMask; }
271 unsigned getCVRUQualifiers() const { return Mask & (CVRMask | UMask); }
272
273 void setCVRQualifiers(unsigned mask) {
274 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 274, __PRETTY_FUNCTION__))
;
275 Mask = (Mask & ~CVRMask) | mask;
276 }
277 void removeCVRQualifiers(unsigned mask) {
278 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 278, __PRETTY_FUNCTION__))
;
279 Mask &= ~mask;
280 }
281 void removeCVRQualifiers() {
282 removeCVRQualifiers(CVRMask);
283 }
284 void addCVRQualifiers(unsigned mask) {
285 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 285, __PRETTY_FUNCTION__))
;
286 Mask |= mask;
287 }
288 void addCVRUQualifiers(unsigned mask) {
289 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 289, __PRETTY_FUNCTION__))
;
290 Mask |= mask;
291 }
292
293 bool hasUnaligned() const { return Mask & UMask; }
294 void setUnaligned(bool flag) {
295 Mask = (Mask & ~UMask) | (flag ? UMask : 0);
296 }
297 void removeUnaligned() { Mask &= ~UMask; }
298 void addUnaligned() { Mask |= UMask; }
299
300 bool hasObjCGCAttr() const { return Mask & GCAttrMask; }
301 GC getObjCGCAttr() const { return GC((Mask & GCAttrMask) >> GCAttrShift); }
302 void setObjCGCAttr(GC type) {
303 Mask = (Mask & ~GCAttrMask) | (type << GCAttrShift);
304 }
305 void removeObjCGCAttr() { setObjCGCAttr(GCNone); }
306 void addObjCGCAttr(GC type) {
307 assert(type)((type) ? static_cast<void> (0) : __assert_fail ("type"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 307, __PRETTY_FUNCTION__))
;
308 setObjCGCAttr(type);
309 }
310 Qualifiers withoutObjCGCAttr() const {
311 Qualifiers qs = *this;
312 qs.removeObjCGCAttr();
313 return qs;
314 }
315 Qualifiers withoutObjCLifetime() const {
316 Qualifiers qs = *this;
317 qs.removeObjCLifetime();
318 return qs;
319 }
320 Qualifiers withoutAddressSpace() const {
321 Qualifiers qs = *this;
322 qs.removeAddressSpace();
323 return qs;
324 }
325
326 bool hasObjCLifetime() const { return Mask & LifetimeMask; }
327 ObjCLifetime getObjCLifetime() const {
328 return ObjCLifetime((Mask & LifetimeMask) >> LifetimeShift);
329 }
330 void setObjCLifetime(ObjCLifetime type) {
331 Mask = (Mask & ~LifetimeMask) | (type << LifetimeShift);
332 }
333 void removeObjCLifetime() { setObjCLifetime(OCL_None); }
334 void addObjCLifetime(ObjCLifetime type) {
335 assert(type)((type) ? static_cast<void> (0) : __assert_fail ("type"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 335, __PRETTY_FUNCTION__))
;
336 assert(!hasObjCLifetime())((!hasObjCLifetime()) ? static_cast<void> (0) : __assert_fail
("!hasObjCLifetime()", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 336, __PRETTY_FUNCTION__))
;
337 Mask |= (type << LifetimeShift);
338 }
339
340 /// True if the lifetime is neither None or ExplicitNone.
341 bool hasNonTrivialObjCLifetime() const {
342 ObjCLifetime lifetime = getObjCLifetime();
343 return (lifetime > OCL_ExplicitNone);
344 }
345
346 /// True if the lifetime is either strong or weak.
347 bool hasStrongOrWeakObjCLifetime() const {
348 ObjCLifetime lifetime = getObjCLifetime();
349 return (lifetime == OCL_Strong || lifetime == OCL_Weak);
350 }
351
352 bool hasAddressSpace() const { return Mask & AddressSpaceMask; }
353 LangAS getAddressSpace() const {
354 return static_cast<LangAS>(Mask >> AddressSpaceShift);
355 }
356 bool hasTargetSpecificAddressSpace() const {
357 return isTargetAddressSpace(getAddressSpace());
358 }
359 /// Get the address space attribute value to be printed by diagnostics.
360 unsigned getAddressSpaceAttributePrintValue() const {
361 auto Addr = getAddressSpace();
362 // This function is not supposed to be used with language specific
363 // address spaces. If that happens, the diagnostic message should consider
364 // printing the QualType instead of the address space value.
365 assert(Addr == LangAS::Default || hasTargetSpecificAddressSpace())((Addr == LangAS::Default || hasTargetSpecificAddressSpace())
? static_cast<void> (0) : __assert_fail ("Addr == LangAS::Default || hasTargetSpecificAddressSpace()"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 365, __PRETTY_FUNCTION__))
;
366 if (Addr != LangAS::Default)
367 return toTargetAddressSpace(Addr);
368 // TODO: The diagnostic messages where Addr may be 0 should be fixed
369 // since it cannot differentiate the situation where 0 denotes the default
370 // address space or user specified __attribute__((address_space(0))).
371 return 0;
372 }
373 void setAddressSpace(LangAS space) {
374 assert((unsigned)space <= MaxAddressSpace)(((unsigned)space <= MaxAddressSpace) ? static_cast<void
> (0) : __assert_fail ("(unsigned)space <= MaxAddressSpace"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 374, __PRETTY_FUNCTION__))
;
375 Mask = (Mask & ~AddressSpaceMask)
376 | (((uint32_t) space) << AddressSpaceShift);
377 }
378 void removeAddressSpace() { setAddressSpace(LangAS::Default); }
379 void addAddressSpace(LangAS space) {
380 assert(space != LangAS::Default)((space != LangAS::Default) ? static_cast<void> (0) : __assert_fail
("space != LangAS::Default", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 380, __PRETTY_FUNCTION__))
;
381 setAddressSpace(space);
382 }
383
384 // Fast qualifiers are those that can be allocated directly
385 // on a QualType object.
386 bool hasFastQualifiers() const { return getFastQualifiers(); }
387 unsigned getFastQualifiers() const { return Mask & FastMask; }
388 void setFastQualifiers(unsigned mask) {
389 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 389, __PRETTY_FUNCTION__))
;
390 Mask = (Mask & ~FastMask) | mask;
391 }
392 void removeFastQualifiers(unsigned mask) {
393 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 393, __PRETTY_FUNCTION__))
;
394 Mask &= ~mask;
395 }
396 void removeFastQualifiers() {
397 removeFastQualifiers(FastMask);
398 }
399 void addFastQualifiers(unsigned mask) {
400 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 400, __PRETTY_FUNCTION__))
;
401 Mask |= mask;
402 }
403
404 /// Return true if the set contains any qualifiers which require an ExtQuals
405 /// node to be allocated.
406 bool hasNonFastQualifiers() const { return Mask & ~FastMask; }
407 Qualifiers getNonFastQualifiers() const {
408 Qualifiers Quals = *this;
409 Quals.setFastQualifiers(0);
410 return Quals;
411 }
412
413 /// Return true if the set contains any qualifiers.
414 bool hasQualifiers() const { return Mask; }
415 bool empty() const { return !Mask; }
416
417 /// Add the qualifiers from the given set to this set.
418 void addQualifiers(Qualifiers Q) {
419 // If the other set doesn't have any non-boolean qualifiers, just
420 // bit-or it in.
421 if (!(Q.Mask & ~CVRMask))
422 Mask |= Q.Mask;
423 else {
424 Mask |= (Q.Mask & CVRMask);
425 if (Q.hasAddressSpace())
426 addAddressSpace(Q.getAddressSpace());
427 if (Q.hasObjCGCAttr())
428 addObjCGCAttr(Q.getObjCGCAttr());
429 if (Q.hasObjCLifetime())
430 addObjCLifetime(Q.getObjCLifetime());
431 }
432 }
433
434 /// Remove the qualifiers from the given set from this set.
435 void removeQualifiers(Qualifiers Q) {
436 // If the other set doesn't have any non-boolean qualifiers, just
437 // bit-and the inverse in.
438 if (!(Q.Mask & ~CVRMask))
439 Mask &= ~Q.Mask;
440 else {
441 Mask &= ~(Q.Mask & CVRMask);
442 if (getObjCGCAttr() == Q.getObjCGCAttr())
443 removeObjCGCAttr();
444 if (getObjCLifetime() == Q.getObjCLifetime())
445 removeObjCLifetime();
446 if (getAddressSpace() == Q.getAddressSpace())
447 removeAddressSpace();
448 }
449 }
450
451 /// Add the qualifiers from the given set to this set, given that
452 /// they don't conflict.
453 void addConsistentQualifiers(Qualifiers qs) {
454 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 455, __PRETTY_FUNCTION__))
455 !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~svn373517/tools/clang/include/clang/AST/Type.h"
, 455, __PRETTY_FUNCTION__))
;
456 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 457, __PRETTY_FUNCTION__))
457 !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~svn373517/tools/clang/include/clang/AST/Type.h"
, 457, __PRETTY_FUNCTION__))
;
458 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 459, __PRETTY_FUNCTION__))
459 !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~svn373517/tools/clang/include/clang/AST/Type.h"
, 459, __PRETTY_FUNCTION__))
;
460 Mask |= qs.Mask;
461 }
462
463 /// Returns true if address space A is equal to or a superset of B.
464 /// OpenCL v2.0 defines conversion rules (OpenCLC v2.0 s6.5.5) and notion of
465 /// overlapping address spaces.
466 /// CL1.1 or CL1.2:
467 /// every address space is a superset of itself.
468 /// CL2.0 adds:
469 /// __generic is a superset of any address space except for __constant.
470 static bool isAddressSpaceSupersetOf(LangAS A, LangAS B) {
471 // Address spaces must match exactly.
472 return A == B ||
473 // Otherwise in OpenCLC v2.0 s6.5.5: every address space except
474 // for __constant can be used as __generic.
475 (A == LangAS::opencl_generic && B != LangAS::opencl_constant);
476 }
477
478 /// Returns true if the address space in these qualifiers is equal to or
479 /// a superset of the address space in the argument qualifiers.
480 bool isAddressSpaceSupersetOf(Qualifiers other) const {
481 return isAddressSpaceSupersetOf(getAddressSpace(), other.getAddressSpace());
482 }
483
484 /// Determines if these qualifiers compatibly include another set.
485 /// Generally this answers the question of whether an object with the other
486 /// qualifiers can be safely used as an object with these qualifiers.
487 bool compatiblyIncludes(Qualifiers other) const {
488 return isAddressSpaceSupersetOf(other) &&
489 // ObjC GC qualifiers can match, be added, or be removed, but can't
490 // be changed.
491 (getObjCGCAttr() == other.getObjCGCAttr() || !hasObjCGCAttr() ||
492 !other.hasObjCGCAttr()) &&
493 // ObjC lifetime qualifiers must match exactly.
494 getObjCLifetime() == other.getObjCLifetime() &&
495 // CVR qualifiers may subset.
496 (((Mask & CVRMask) | (other.Mask & CVRMask)) == (Mask & CVRMask)) &&
497 // U qualifier may superset.
498 (!other.hasUnaligned() || hasUnaligned());
499 }
500
501 /// Determines if these qualifiers compatibly include another set of
502 /// qualifiers from the narrow perspective of Objective-C ARC lifetime.
503 ///
504 /// One set of Objective-C lifetime qualifiers compatibly includes the other
505 /// if the lifetime qualifiers match, or if both are non-__weak and the
506 /// including set also contains the 'const' qualifier, or both are non-__weak
507 /// and one is None (which can only happen in non-ARC modes).
508 bool compatiblyIncludesObjCLifetime(Qualifiers other) const {
509 if (getObjCLifetime() == other.getObjCLifetime())
510 return true;
511
512 if (getObjCLifetime() == OCL_Weak || other.getObjCLifetime() == OCL_Weak)
513 return false;
514
515 if (getObjCLifetime() == OCL_None || other.getObjCLifetime() == OCL_None)
516 return true;
517
518 return hasConst();
519 }
520
521 /// Determine whether this set of qualifiers is a strict superset of
522 /// another set of qualifiers, not considering qualifier compatibility.
523 bool isStrictSupersetOf(Qualifiers Other) const;
524
525 bool operator==(Qualifiers Other) const { return Mask == Other.Mask; }
526 bool operator!=(Qualifiers Other) const { return Mask != Other.Mask; }
527
528 explicit operator bool() const { return hasQualifiers(); }
529
530 Qualifiers &operator+=(Qualifiers R) {
531 addQualifiers(R);
532 return *this;
533 }
534
535 // Union two qualifier sets. If an enumerated qualifier appears
536 // in both sets, use the one from the right.
537 friend Qualifiers operator+(Qualifiers L, Qualifiers R) {
538 L += R;
539 return L;
540 }
541
542 Qualifiers &operator-=(Qualifiers R) {
543 removeQualifiers(R);
544 return *this;
545 }
546
547 /// Compute the difference between two qualifier sets.
548 friend Qualifiers operator-(Qualifiers L, Qualifiers R) {
549 L -= R;
550 return L;
551 }
552
553 std::string getAsString() const;
554 std::string getAsString(const PrintingPolicy &Policy) const;
555
556 bool isEmptyWhenPrinted(const PrintingPolicy &Policy) const;
557 void print(raw_ostream &OS, const PrintingPolicy &Policy,
558 bool appendSpaceIfNonEmpty = false) const;
559
560 void Profile(llvm::FoldingSetNodeID &ID) const {
561 ID.AddInteger(Mask);
562 }
563
564private:
565 // bits: |0 1 2|3|4 .. 5|6 .. 8|9 ... 31|
566 // |C R V|U|GCAttr|Lifetime|AddressSpace|
567 uint32_t Mask = 0;
568
569 static const uint32_t UMask = 0x8;
570 static const uint32_t UShift = 3;
571 static const uint32_t GCAttrMask = 0x30;
572 static const uint32_t GCAttrShift = 4;
573 static const uint32_t LifetimeMask = 0x1C0;
574 static const uint32_t LifetimeShift = 6;
575 static const uint32_t AddressSpaceMask =
576 ~(CVRMask | UMask | GCAttrMask | LifetimeMask);
577 static const uint32_t AddressSpaceShift = 9;
578};
579
580/// A std::pair-like structure for storing a qualified type split
581/// into its local qualifiers and its locally-unqualified type.
582struct SplitQualType {
583 /// The locally-unqualified type.
584 const Type *Ty = nullptr;
585
586 /// The local qualifiers.
587 Qualifiers Quals;
588
589 SplitQualType() = default;
590 SplitQualType(const Type *ty, Qualifiers qs) : Ty(ty), Quals(qs) {}
591
592 SplitQualType getSingleStepDesugaredType() const; // end of this file
593
594 // Make std::tie work.
595 std::pair<const Type *,Qualifiers> asPair() const {
596 return std::pair<const Type *, Qualifiers>(Ty, Quals);
597 }
598
599 friend bool operator==(SplitQualType a, SplitQualType b) {
600 return a.Ty == b.Ty && a.Quals == b.Quals;
601 }
602 friend bool operator!=(SplitQualType a, SplitQualType b) {
603 return a.Ty != b.Ty || a.Quals != b.Quals;
604 }
605};
606
607/// The kind of type we are substituting Objective-C type arguments into.
608///
609/// The kind of substitution affects the replacement of type parameters when
610/// no concrete type information is provided, e.g., when dealing with an
611/// unspecialized type.
612enum class ObjCSubstitutionContext {
613 /// An ordinary type.
614 Ordinary,
615
616 /// The result type of a method or function.
617 Result,
618
619 /// The parameter type of a method or function.
620 Parameter,
621
622 /// The type of a property.
623 Property,
624
625 /// The superclass of a type.
626 Superclass,
627};
628
629/// A (possibly-)qualified type.
630///
631/// For efficiency, we don't store CV-qualified types as nodes on their
632/// own: instead each reference to a type stores the qualifiers. This
633/// greatly reduces the number of nodes we need to allocate for types (for
634/// example we only need one for 'int', 'const int', 'volatile int',
635/// 'const volatile int', etc).
636///
637/// As an added efficiency bonus, instead of making this a pair, we
638/// just store the two bits we care about in the low bits of the
639/// pointer. To handle the packing/unpacking, we make QualType be a
640/// simple wrapper class that acts like a smart pointer. A third bit
641/// indicates whether there are extended qualifiers present, in which
642/// case the pointer points to a special structure.
643class QualType {
644 friend class QualifierCollector;
645
646 // Thankfully, these are efficiently composable.
647 llvm::PointerIntPair<llvm::PointerUnion<const Type *, const ExtQuals *>,
648 Qualifiers::FastWidth> Value;
649
650 const ExtQuals *getExtQualsUnsafe() const {
651 return Value.getPointer().get<const ExtQuals*>();
652 }
653
654 const Type *getTypePtrUnsafe() const {
655 return Value.getPointer().get<const Type*>();
656 }
657
658 const ExtQualsTypeCommonBase *getCommonPtr() const {
659 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 659, __PRETTY_FUNCTION__))
;
660 auto CommonPtrVal = reinterpret_cast<uintptr_t>(Value.getOpaqueValue());
661 CommonPtrVal &= ~(uintptr_t)((1 << TypeAlignmentInBits) - 1);
662 return reinterpret_cast<ExtQualsTypeCommonBase*>(CommonPtrVal);
663 }
664
665public:
666 QualType() = default;
667 QualType(const Type *Ptr, unsigned Quals) : Value(Ptr, Quals) {}
668 QualType(const ExtQuals *Ptr, unsigned Quals) : Value(Ptr, Quals) {}
669
670 unsigned getLocalFastQualifiers() const { return Value.getInt(); }
671 void setLocalFastQualifiers(unsigned Quals) { Value.setInt(Quals); }
672
673 /// Retrieves a pointer to the underlying (unqualified) type.
674 ///
675 /// This function requires that the type not be NULL. If the type might be
676 /// NULL, use the (slightly less efficient) \c getTypePtrOrNull().
677 const Type *getTypePtr() const;
678
679 const Type *getTypePtrOrNull() const;
680
681 /// Retrieves a pointer to the name of the base type.
682 const IdentifierInfo *getBaseTypeIdentifier() const;
683
684 /// Divides a QualType into its unqualified type and a set of local
685 /// qualifiers.
686 SplitQualType split() const;
687
688 void *getAsOpaquePtr() const { return Value.getOpaqueValue(); }
689
690 static QualType getFromOpaquePtr(const void *Ptr) {
691 QualType T;
692 T.Value.setFromOpaqueValue(const_cast<void*>(Ptr));
693 return T;
694 }
695
696 const Type &operator*() const {
697 return *getTypePtr();
698 }
699
700 const Type *operator->() const {
701 return getTypePtr();
702 }
703
704 bool isCanonical() const;
705 bool isCanonicalAsParam() const;
706
707 /// Return true if this QualType doesn't point to a type yet.
708 bool isNull() const {
709 return Value.getPointer().isNull();
710 }
711
712 /// Determine whether this particular QualType instance has the
713 /// "const" qualifier set, without looking through typedefs that may have
714 /// added "const" at a different level.
715 bool isLocalConstQualified() const {
716 return (getLocalFastQualifiers() & Qualifiers::Const);
717 }
718
719 /// Determine whether this type is const-qualified.
720 bool isConstQualified() const;
721
722 /// Determine whether this particular QualType instance has the
723 /// "restrict" qualifier set, without looking through typedefs that may have
724 /// added "restrict" at a different level.
725 bool isLocalRestrictQualified() const {
726 return (getLocalFastQualifiers() & Qualifiers::Restrict);
727 }
728
729 /// Determine whether this type is restrict-qualified.
730 bool isRestrictQualified() const;
731
732 /// Determine whether this particular QualType instance has the
733 /// "volatile" qualifier set, without looking through typedefs that may have
734 /// added "volatile" at a different level.
735 bool isLocalVolatileQualified() const {
736 return (getLocalFastQualifiers() & Qualifiers::Volatile);
737 }
738
739 /// Determine whether this type is volatile-qualified.
740 bool isVolatileQualified() const;
741
742 /// Determine whether this particular QualType instance has any
743 /// qualifiers, without looking through any typedefs that might add
744 /// qualifiers at a different level.
745 bool hasLocalQualifiers() const {
746 return getLocalFastQualifiers() || hasLocalNonFastQualifiers();
747 }
748
749 /// Determine whether this type has any qualifiers.
750 bool hasQualifiers() const;
751
752 /// Determine whether this particular QualType instance has any
753 /// "non-fast" qualifiers, e.g., those that are stored in an ExtQualType
754 /// instance.
755 bool hasLocalNonFastQualifiers() const {
756 return Value.getPointer().is<const ExtQuals*>();
757 }
758
759 /// Retrieve the set of qualifiers local to this particular QualType
760 /// instance, not including any qualifiers acquired through typedefs or
761 /// other sugar.
762 Qualifiers getLocalQualifiers() const;
763
764 /// Retrieve the set of qualifiers applied to this type.
765 Qualifiers getQualifiers() const;
766
767 /// Retrieve the set of CVR (const-volatile-restrict) qualifiers
768 /// local to this particular QualType instance, not including any qualifiers
769 /// acquired through typedefs or other sugar.
770 unsigned getLocalCVRQualifiers() const {
771 return getLocalFastQualifiers();
772 }
773
774 /// Retrieve the set of CVR (const-volatile-restrict) qualifiers
775 /// applied to this type.
776 unsigned getCVRQualifiers() const;
777
778 bool isConstant(const ASTContext& Ctx) const {
779 return QualType::isConstant(*this, Ctx);
780 }
781
782 /// Determine whether this is a Plain Old Data (POD) type (C++ 3.9p10).
783 bool isPODType(const ASTContext &Context) const;
784
785 /// Return true if this is a POD type according to the rules of the C++98
786 /// standard, regardless of the current compilation's language.
787 bool isCXX98PODType(const ASTContext &Context) const;
788
789 /// Return true if this is a POD type according to the more relaxed rules
790 /// of the C++11 standard, regardless of the current compilation's language.
791 /// (C++0x [basic.types]p9). Note that, unlike
792 /// CXXRecordDecl::isCXX11StandardLayout, this takes DRs into account.
793 bool isCXX11PODType(const ASTContext &Context) const;
794
795 /// Return true if this is a trivial type per (C++0x [basic.types]p9)
796 bool isTrivialType(const ASTContext &Context) const;
797
798 /// Return true if this is a trivially copyable type (C++0x [basic.types]p9)
799 bool isTriviallyCopyableType(const ASTContext &Context) const;
800
801
802 /// Returns true if it is a class and it might be dynamic.
803 bool mayBeDynamicClass() const;
804
805 /// Returns true if it is not a class or if the class might not be dynamic.
806 bool mayBeNotDynamicClass() const;
807
808 // Don't promise in the API that anything besides 'const' can be
809 // easily added.
810
811 /// Add the `const` type qualifier to this QualType.
812 void addConst() {
813 addFastQualifiers(Qualifiers::Const);
814 }
815 QualType withConst() const {
816 return withFastQualifiers(Qualifiers::Const);
817 }
818
819 /// Add the `volatile` type qualifier to this QualType.
820 void addVolatile() {
821 addFastQualifiers(Qualifiers::Volatile);
822 }
823 QualType withVolatile() const {
824 return withFastQualifiers(Qualifiers::Volatile);
825 }
826
827 /// Add the `restrict` qualifier to this QualType.
828 void addRestrict() {
829 addFastQualifiers(Qualifiers::Restrict);
830 }
831 QualType withRestrict() const {
832 return withFastQualifiers(Qualifiers::Restrict);
833 }
834
835 QualType withCVRQualifiers(unsigned CVR) const {
836 return withFastQualifiers(CVR);
837 }
838
839 void addFastQualifiers(unsigned TQs) {
840 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 841, __PRETTY_FUNCTION__))
841 && "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~svn373517/tools/clang/include/clang/AST/Type.h"
, 841, __PRETTY_FUNCTION__))
;
842 Value.setInt(Value.getInt() | TQs);
843 }
844
845 void removeLocalConst();
846 void removeLocalVolatile();
847 void removeLocalRestrict();
848 void removeLocalCVRQualifiers(unsigned Mask);
849
850 void removeLocalFastQualifiers() { Value.setInt(0); }
851 void removeLocalFastQualifiers(unsigned Mask) {
852 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 852, __PRETTY_FUNCTION__))
;
853 Value.setInt(Value.getInt() & ~Mask);
854 }
855
856 // Creates a type with the given qualifiers in addition to any
857 // qualifiers already on this type.
858 QualType withFastQualifiers(unsigned TQs) const {
859 QualType T = *this;
860 T.addFastQualifiers(TQs);
861 return T;
862 }
863
864 // Creates a type with exactly the given fast qualifiers, removing
865 // any existing fast qualifiers.
866 QualType withExactLocalFastQualifiers(unsigned TQs) const {
867 return withoutLocalFastQualifiers().withFastQualifiers(TQs);
868 }
869
870 // Removes fast qualifiers, but leaves any extended qualifiers in place.
871 QualType withoutLocalFastQualifiers() const {
872 QualType T = *this;
873 T.removeLocalFastQualifiers();
874 return T;
875 }
876
877 QualType getCanonicalType() const;
878
879 /// Return this type with all of the instance-specific qualifiers
880 /// removed, but without removing any qualifiers that may have been applied
881 /// through typedefs.
882 QualType getLocalUnqualifiedType() const { return QualType(getTypePtr(), 0); }
883
884 /// Retrieve the unqualified variant of the given type,
885 /// removing as little sugar as possible.
886 ///
887 /// This routine looks through various kinds of sugar to find the
888 /// least-desugared type that is unqualified. For example, given:
889 ///
890 /// \code
891 /// typedef int Integer;
892 /// typedef const Integer CInteger;
893 /// typedef CInteger DifferenceType;
894 /// \endcode
895 ///
896 /// Executing \c getUnqualifiedType() on the type \c DifferenceType will
897 /// desugar until we hit the type \c Integer, which has no qualifiers on it.
898 ///
899 /// The resulting type might still be qualified if it's sugar for an array
900 /// type. To strip qualifiers even from within a sugared array type, use
901 /// ASTContext::getUnqualifiedArrayType.
902 inline QualType getUnqualifiedType() const;
903
904 /// Retrieve the unqualified variant of the given type, removing as little
905 /// sugar as possible.
906 ///
907 /// Like getUnqualifiedType(), but also returns the set of
908 /// qualifiers that were built up.
909 ///
910 /// The resulting type might still be qualified if it's sugar for an array
911 /// type. To strip qualifiers even from within a sugared array type, use
912 /// ASTContext::getUnqualifiedArrayType.
913 inline SplitQualType getSplitUnqualifiedType() const;
914
915 /// Determine whether this type is more qualified than the other
916 /// given type, requiring exact equality for non-CVR qualifiers.
917 bool isMoreQualifiedThan(QualType Other) const;
918
919 /// Determine whether this type is at least as qualified as the other
920 /// given type, requiring exact equality for non-CVR qualifiers.
921 bool isAtLeastAsQualifiedAs(QualType Other) const;
922
923 QualType getNonReferenceType() const;
924
925 /// Determine the type of a (typically non-lvalue) expression with the
926 /// specified result type.
927 ///
928 /// This routine should be used for expressions for which the return type is
929 /// explicitly specified (e.g., in a cast or call) and isn't necessarily
930 /// an lvalue. It removes a top-level reference (since there are no
931 /// expressions of reference type) and deletes top-level cvr-qualifiers
932 /// from non-class types (in C++) or all types (in C).
933 QualType getNonLValueExprType(const ASTContext &Context) const;
934
935 /// Return the specified type with any "sugar" removed from
936 /// the type. This takes off typedefs, typeof's etc. If the outer level of
937 /// the type is already concrete, it returns it unmodified. This is similar
938 /// to getting the canonical type, but it doesn't remove *all* typedefs. For
939 /// example, it returns "T*" as "T*", (not as "int*"), because the pointer is
940 /// concrete.
941 ///
942 /// Qualifiers are left in place.
943 QualType getDesugaredType(const ASTContext &Context) const {
944 return getDesugaredType(*this, Context);
945 }
946
947 SplitQualType getSplitDesugaredType() const {
948 return getSplitDesugaredType(*this);
949 }
950
951 /// Return the specified type with one level of "sugar" removed from
952 /// the type.
953 ///
954 /// This routine takes off the first typedef, typeof, etc. If the outer level
955 /// of the type is already concrete, it returns it unmodified.
956 QualType getSingleStepDesugaredType(const ASTContext &Context) const {
957 return getSingleStepDesugaredTypeImpl(*this, Context);
958 }
959
960 /// Returns the specified type after dropping any
961 /// outer-level parentheses.
962 QualType IgnoreParens() const {
963 if (isa<ParenType>(*this))
964 return QualType::IgnoreParens(*this);
965 return *this;
966 }
967
968 /// Indicate whether the specified types and qualifiers are identical.
969 friend bool operator==(const QualType &LHS, const QualType &RHS) {
970 return LHS.Value == RHS.Value;
971 }
972 friend bool operator!=(const QualType &LHS, const QualType &RHS) {
973 return LHS.Value != RHS.Value;
974 }
975 friend bool operator<(const QualType &LHS, const QualType &RHS) {
976 return LHS.Value < RHS.Value;
977 }
978
979 static std::string getAsString(SplitQualType split,
980 const PrintingPolicy &Policy) {
981 return getAsString(split.Ty, split.Quals, Policy);
982 }
983 static std::string getAsString(const Type *ty, Qualifiers qs,
984 const PrintingPolicy &Policy);
985
986 std::string getAsString() const;
987 std::string getAsString(const PrintingPolicy &Policy) const;
988
989 void print(raw_ostream &OS, const PrintingPolicy &Policy,
990 const Twine &PlaceHolder = Twine(),
991 unsigned Indentation = 0) const;
992
993 static void print(SplitQualType split, raw_ostream &OS,
994 const PrintingPolicy &policy, const Twine &PlaceHolder,
995 unsigned Indentation = 0) {
996 return print(split.Ty, split.Quals, OS, policy, PlaceHolder, Indentation);
997 }
998
999 static void print(const Type *ty, Qualifiers qs,
1000 raw_ostream &OS, const PrintingPolicy &policy,
1001 const Twine &PlaceHolder,
1002 unsigned Indentation = 0);
1003
1004 void getAsStringInternal(std::string &Str,
1005 const PrintingPolicy &Policy) const;
1006
1007 static void getAsStringInternal(SplitQualType split, std::string &out,
1008 const PrintingPolicy &policy) {
1009 return getAsStringInternal(split.Ty, split.Quals, out, policy);
1010 }
1011
1012 static void getAsStringInternal(const Type *ty, Qualifiers qs,
1013 std::string &out,
1014 const PrintingPolicy &policy);
1015
1016 class StreamedQualTypeHelper {
1017 const QualType &T;
1018 const PrintingPolicy &Policy;
1019 const Twine &PlaceHolder;
1020 unsigned Indentation;
1021
1022 public:
1023 StreamedQualTypeHelper(const QualType &T, const PrintingPolicy &Policy,
1024 const Twine &PlaceHolder, unsigned Indentation)
1025 : T(T), Policy(Policy), PlaceHolder(PlaceHolder),
1026 Indentation(Indentation) {}
1027
1028 friend raw_ostream &operator<<(raw_ostream &OS,
1029 const StreamedQualTypeHelper &SQT) {
1030 SQT.T.print(OS, SQT.Policy, SQT.PlaceHolder, SQT.Indentation);
1031 return OS;
1032 }
1033 };
1034
1035 StreamedQualTypeHelper stream(const PrintingPolicy &Policy,
1036 const Twine &PlaceHolder = Twine(),
1037 unsigned Indentation = 0) const {
1038 return StreamedQualTypeHelper(*this, Policy, PlaceHolder, Indentation);
1039 }
1040
1041 void dump(const char *s) const;
1042 void dump() const;
1043 void dump(llvm::raw_ostream &OS) const;
1044
1045 void Profile(llvm::FoldingSetNodeID &ID) const {
1046 ID.AddPointer(getAsOpaquePtr());
1047 }
1048
1049 /// Return the address space of this type.
1050 inline LangAS getAddressSpace() const;
1051
1052 /// Returns gc attribute of this type.
1053 inline Qualifiers::GC getObjCGCAttr() const;
1054
1055 /// true when Type is objc's weak.
1056 bool isObjCGCWeak() const {
1057 return getObjCGCAttr() == Qualifiers::Weak;
1058 }
1059
1060 /// true when Type is objc's strong.
1061 bool isObjCGCStrong() const {
1062 return getObjCGCAttr() == Qualifiers::Strong;
1063 }
1064
1065 /// Returns lifetime attribute of this type.
1066 Qualifiers::ObjCLifetime getObjCLifetime() const {
1067 return getQualifiers().getObjCLifetime();
1068 }
1069
1070 bool hasNonTrivialObjCLifetime() const {
1071 return getQualifiers().hasNonTrivialObjCLifetime();
1072 }
1073
1074 bool hasStrongOrWeakObjCLifetime() const {
1075 return getQualifiers().hasStrongOrWeakObjCLifetime();
1076 }
1077
1078 // true when Type is objc's weak and weak is enabled but ARC isn't.
1079 bool isNonWeakInMRRWithObjCWeak(const ASTContext &Context) const;
1080
1081 enum PrimitiveDefaultInitializeKind {
1082 /// The type does not fall into any of the following categories. Note that
1083 /// this case is zero-valued so that values of this enum can be used as a
1084 /// boolean condition for non-triviality.
1085 PDIK_Trivial,
1086
1087 /// The type is an Objective-C retainable pointer type that is qualified
1088 /// with the ARC __strong qualifier.
1089 PDIK_ARCStrong,
1090
1091 /// The type is an Objective-C retainable pointer type that is qualified
1092 /// with the ARC __weak qualifier.
1093 PDIK_ARCWeak,
1094
1095 /// The type is a struct containing a field whose type is not PCK_Trivial.
1096 PDIK_Struct
1097 };
1098
1099 /// Functions to query basic properties of non-trivial C struct types.
1100
1101 /// Check if this is a non-trivial type that would cause a C struct
1102 /// transitively containing this type to be non-trivial to default initialize
1103 /// and return the kind.
1104 PrimitiveDefaultInitializeKind
1105 isNonTrivialToPrimitiveDefaultInitialize() const;
1106
1107 enum PrimitiveCopyKind {
1108 /// The type does not fall into any of the following categories. Note that
1109 /// this case is zero-valued so that values of this enum can be used as a
1110 /// boolean condition for non-triviality.
1111 PCK_Trivial,
1112
1113 /// The type would be trivial except that it is volatile-qualified. Types
1114 /// that fall into one of the other non-trivial cases may additionally be
1115 /// volatile-qualified.
1116 PCK_VolatileTrivial,
1117
1118 /// The type is an Objective-C retainable pointer type that is qualified
1119 /// with the ARC __strong qualifier.
1120 PCK_ARCStrong,
1121
1122 /// The type is an Objective-C retainable pointer type that is qualified
1123 /// with the ARC __weak qualifier.
1124 PCK_ARCWeak,
1125
1126 /// The type is a struct containing a field whose type is neither
1127 /// PCK_Trivial nor PCK_VolatileTrivial.
1128 /// Note that a C++ struct type does not necessarily match this; C++ copying
1129 /// semantics are too complex to express here, in part because they depend
1130 /// on the exact constructor or assignment operator that is chosen by
1131 /// overload resolution to do the copy.
1132 PCK_Struct
1133 };
1134
1135 /// Check if this is a non-trivial type that would cause a C struct
1136 /// transitively containing this type to be non-trivial to copy and return the
1137 /// kind.
1138 PrimitiveCopyKind isNonTrivialToPrimitiveCopy() const;
1139
1140 /// Check if this is a non-trivial type that would cause a C struct
1141 /// transitively containing this type to be non-trivial to destructively
1142 /// move and return the kind. Destructive move in this context is a C++-style
1143 /// move in which the source object is placed in a valid but unspecified state
1144 /// after it is moved, as opposed to a truly destructive move in which the
1145 /// source object is placed in an uninitialized state.
1146 PrimitiveCopyKind isNonTrivialToPrimitiveDestructiveMove() const;
1147
1148 enum DestructionKind {
1149 DK_none,
1150 DK_cxx_destructor,
1151 DK_objc_strong_lifetime,
1152 DK_objc_weak_lifetime,
1153 DK_nontrivial_c_struct
1154 };
1155
1156 /// Returns a nonzero value if objects of this type require
1157 /// non-trivial work to clean up after. Non-zero because it's
1158 /// conceivable that qualifiers (objc_gc(weak)?) could make
1159 /// something require destruction.
1160 DestructionKind isDestructedType() const {
1161 return isDestructedTypeImpl(*this);
1162 }
1163
1164 /// Check if this is or contains a C union that is non-trivial to
1165 /// default-initialize, which is a union that has a member that is non-trivial
1166 /// to default-initialize. If this returns true,
1167 /// isNonTrivialToPrimitiveDefaultInitialize returns PDIK_Struct.
1168 bool hasNonTrivialToPrimitiveDefaultInitializeCUnion() const;
1169
1170 /// Check if this is or contains a C union that is non-trivial to destruct,
1171 /// which is a union that has a member that is non-trivial to destruct. If
1172 /// this returns true, isDestructedType returns DK_nontrivial_c_struct.
1173 bool hasNonTrivialToPrimitiveDestructCUnion() const;
1174
1175 /// Check if this is or contains a C union that is non-trivial to copy, which
1176 /// is a union that has a member that is non-trivial to copy. If this returns
1177 /// true, isNonTrivialToPrimitiveCopy returns PCK_Struct.
1178 bool hasNonTrivialToPrimitiveCopyCUnion() const;
1179
1180 /// Determine whether expressions of the given type are forbidden
1181 /// from being lvalues in C.
1182 ///
1183 /// The expression types that are forbidden to be lvalues are:
1184 /// - 'void', but not qualified void
1185 /// - function types
1186 ///
1187 /// The exact rule here is C99 6.3.2.1:
1188 /// An lvalue is an expression with an object type or an incomplete
1189 /// type other than void.
1190 bool isCForbiddenLValueType() const;
1191
1192 /// Substitute type arguments for the Objective-C type parameters used in the
1193 /// subject type.
1194 ///
1195 /// \param ctx ASTContext in which the type exists.
1196 ///
1197 /// \param typeArgs The type arguments that will be substituted for the
1198 /// Objective-C type parameters in the subject type, which are generally
1199 /// computed via \c Type::getObjCSubstitutions. If empty, the type
1200 /// parameters will be replaced with their bounds or id/Class, as appropriate
1201 /// for the context.
1202 ///
1203 /// \param context The context in which the subject type was written.
1204 ///
1205 /// \returns the resulting type.
1206 QualType substObjCTypeArgs(ASTContext &ctx,
1207 ArrayRef<QualType> typeArgs,
1208 ObjCSubstitutionContext context) const;
1209
1210 /// Substitute type arguments from an object type for the Objective-C type
1211 /// parameters used in the subject type.
1212 ///
1213 /// This operation combines the computation of type arguments for
1214 /// substitution (\c Type::getObjCSubstitutions) with the actual process of
1215 /// substitution (\c QualType::substObjCTypeArgs) for the convenience of
1216 /// callers that need to perform a single substitution in isolation.
1217 ///
1218 /// \param objectType The type of the object whose member type we're
1219 /// substituting into. For example, this might be the receiver of a message
1220 /// or the base of a property access.
1221 ///
1222 /// \param dc The declaration context from which the subject type was
1223 /// retrieved, which indicates (for example) which type parameters should
1224 /// be substituted.
1225 ///
1226 /// \param context The context in which the subject type was written.
1227 ///
1228 /// \returns the subject type after replacing all of the Objective-C type
1229 /// parameters with their corresponding arguments.
1230 QualType substObjCMemberType(QualType objectType,
1231 const DeclContext *dc,
1232 ObjCSubstitutionContext context) const;
1233
1234 /// Strip Objective-C "__kindof" types from the given type.
1235 QualType stripObjCKindOfType(const ASTContext &ctx) const;
1236
1237 /// Remove all qualifiers including _Atomic.
1238 QualType getAtomicUnqualifiedType() const;
1239
1240private:
1241 // These methods are implemented in a separate translation unit;
1242 // "static"-ize them to avoid creating temporary QualTypes in the
1243 // caller.
1244 static bool isConstant(QualType T, const ASTContext& Ctx);
1245 static QualType getDesugaredType(QualType T, const ASTContext &Context);
1246 static SplitQualType getSplitDesugaredType(QualType T);
1247 static SplitQualType getSplitUnqualifiedTypeImpl(QualType type);
1248 static QualType getSingleStepDesugaredTypeImpl(QualType type,
1249 const ASTContext &C);
1250 static QualType IgnoreParens(QualType T);
1251 static DestructionKind isDestructedTypeImpl(QualType type);
1252
1253 /// Check if \param RD is or contains a non-trivial C union.
1254 static bool hasNonTrivialToPrimitiveDefaultInitializeCUnion(const RecordDecl *RD);
1255 static bool hasNonTrivialToPrimitiveDestructCUnion(const RecordDecl *RD);
1256 static bool hasNonTrivialToPrimitiveCopyCUnion(const RecordDecl *RD);
1257};
1258
1259} // namespace clang
1260
1261namespace llvm {
1262
1263/// Implement simplify_type for QualType, so that we can dyn_cast from QualType
1264/// to a specific Type class.
1265template<> struct simplify_type< ::clang::QualType> {
1266 using SimpleType = const ::clang::Type *;
1267
1268 static SimpleType getSimplifiedValue(::clang::QualType Val) {
1269 return Val.getTypePtr();
1270 }
1271};
1272
1273// Teach SmallPtrSet that QualType is "basically a pointer".
1274template<>
1275struct PointerLikeTypeTraits<clang::QualType> {
1276 static inline void *getAsVoidPointer(clang::QualType P) {
1277 return P.getAsOpaquePtr();
1278 }
1279
1280 static inline clang::QualType getFromVoidPointer(void *P) {
1281 return clang::QualType::getFromOpaquePtr(P);
1282 }
1283
1284 // Various qualifiers go in low bits.
1285 enum { NumLowBitsAvailable = 0 };
1286};
1287
1288} // namespace llvm
1289
1290namespace clang {
1291
1292/// Base class that is common to both the \c ExtQuals and \c Type
1293/// classes, which allows \c QualType to access the common fields between the
1294/// two.
1295class ExtQualsTypeCommonBase {
1296 friend class ExtQuals;
1297 friend class QualType;
1298 friend class Type;
1299
1300 /// The "base" type of an extended qualifiers type (\c ExtQuals) or
1301 /// a self-referential pointer (for \c Type).
1302 ///
1303 /// This pointer allows an efficient mapping from a QualType to its
1304 /// underlying type pointer.
1305 const Type *const BaseType;
1306
1307 /// The canonical type of this type. A QualType.
1308 QualType CanonicalType;
1309
1310 ExtQualsTypeCommonBase(const Type *baseType, QualType canon)
1311 : BaseType(baseType), CanonicalType(canon) {}
1312};
1313
1314/// We can encode up to four bits in the low bits of a
1315/// type pointer, but there are many more type qualifiers that we want
1316/// to be able to apply to an arbitrary type. Therefore we have this
1317/// struct, intended to be heap-allocated and used by QualType to
1318/// store qualifiers.
1319///
1320/// The current design tags the 'const', 'restrict', and 'volatile' qualifiers
1321/// in three low bits on the QualType pointer; a fourth bit records whether
1322/// the pointer is an ExtQuals node. The extended qualifiers (address spaces,
1323/// Objective-C GC attributes) are much more rare.
1324class ExtQuals : public ExtQualsTypeCommonBase, public llvm::FoldingSetNode {
1325 // NOTE: changing the fast qualifiers should be straightforward as
1326 // long as you don't make 'const' non-fast.
1327 // 1. Qualifiers:
1328 // a) Modify the bitmasks (Qualifiers::TQ and DeclSpec::TQ).
1329 // Fast qualifiers must occupy the low-order bits.
1330 // b) Update Qualifiers::FastWidth and FastMask.
1331 // 2. QualType:
1332 // a) Update is{Volatile,Restrict}Qualified(), defined inline.
1333 // b) Update remove{Volatile,Restrict}, defined near the end of
1334 // this header.
1335 // 3. ASTContext:
1336 // a) Update get{Volatile,Restrict}Type.
1337
1338 /// The immutable set of qualifiers applied by this node. Always contains
1339 /// extended qualifiers.
1340 Qualifiers Quals;
1341
1342 ExtQuals *this_() { return this; }
1343
1344public:
1345 ExtQuals(const Type *baseType, QualType canon, Qualifiers quals)
1346 : ExtQualsTypeCommonBase(baseType,
1347 canon.isNull() ? QualType(this_(), 0) : canon),
1348 Quals(quals) {
1349 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 1350, __PRETTY_FUNCTION__))
1350 && "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~svn373517/tools/clang/include/clang/AST/Type.h"
, 1350, __PRETTY_FUNCTION__))
;
1351 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 1352, __PRETTY_FUNCTION__))
1352 && "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~svn373517/tools/clang/include/clang/AST/Type.h"
, 1352, __PRETTY_FUNCTION__))
;
1353 }
1354
1355 Qualifiers getQualifiers() const { return Quals; }
1356
1357 bool hasObjCGCAttr() const { return Quals.hasObjCGCAttr(); }
1358 Qualifiers::GC getObjCGCAttr() const { return Quals.getObjCGCAttr(); }
1359
1360 bool hasObjCLifetime() const { return Quals.hasObjCLifetime(); }
1361 Qualifiers::ObjCLifetime getObjCLifetime() const {
1362 return Quals.getObjCLifetime();
1363 }
1364
1365 bool hasAddressSpace() const { return Quals.hasAddressSpace(); }
1366 LangAS getAddressSpace() const { return Quals.getAddressSpace(); }
1367
1368 const Type *getBaseType() const { return BaseType; }
1369
1370public:
1371 void Profile(llvm::FoldingSetNodeID &ID) const {
1372 Profile(ID, getBaseType(), Quals);
1373 }
1374
1375 static void Profile(llvm::FoldingSetNodeID &ID,
1376 const Type *BaseType,
1377 Qualifiers Quals) {
1378 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 1378, __PRETTY_FUNCTION__))
;
1379 ID.AddPointer(BaseType);
1380 Quals.Profile(ID);
1381 }
1382};
1383
1384/// The kind of C++11 ref-qualifier associated with a function type.
1385/// This determines whether a member function's "this" object can be an
1386/// lvalue, rvalue, or neither.
1387enum RefQualifierKind {
1388 /// No ref-qualifier was provided.
1389 RQ_None = 0,
1390
1391 /// An lvalue ref-qualifier was provided (\c &).
1392 RQ_LValue,
1393
1394 /// An rvalue ref-qualifier was provided (\c &&).
1395 RQ_RValue
1396};
1397
1398/// Which keyword(s) were used to create an AutoType.
1399enum class AutoTypeKeyword {
1400 /// auto
1401 Auto,
1402
1403 /// decltype(auto)
1404 DecltypeAuto,
1405
1406 /// __auto_type (GNU extension)
1407 GNUAutoType
1408};
1409
1410/// The base class of the type hierarchy.
1411///
1412/// A central concept with types is that each type always has a canonical
1413/// type. A canonical type is the type with any typedef names stripped out
1414/// of it or the types it references. For example, consider:
1415///
1416/// typedef int foo;
1417/// typedef foo* bar;
1418/// 'int *' 'foo *' 'bar'
1419///
1420/// There will be a Type object created for 'int'. Since int is canonical, its
1421/// CanonicalType pointer points to itself. There is also a Type for 'foo' (a
1422/// TypedefType). Its CanonicalType pointer points to the 'int' Type. Next
1423/// there is a PointerType that represents 'int*', which, like 'int', is
1424/// canonical. Finally, there is a PointerType type for 'foo*' whose canonical
1425/// type is 'int*', and there is a TypedefType for 'bar', whose canonical type
1426/// is also 'int*'.
1427///
1428/// Non-canonical types are useful for emitting diagnostics, without losing
1429/// information about typedefs being used. Canonical types are useful for type
1430/// comparisons (they allow by-pointer equality tests) and useful for reasoning
1431/// about whether something has a particular form (e.g. is a function type),
1432/// because they implicitly, recursively, strip all typedefs out of a type.
1433///
1434/// Types, once created, are immutable.
1435///
1436class alignas(8) Type : public ExtQualsTypeCommonBase {
1437public:
1438 enum TypeClass {
1439#define TYPE(Class, Base) Class,
1440#define LAST_TYPE(Class) TypeLast = Class
1441#define ABSTRACT_TYPE(Class, Base)
1442#include "clang/AST/TypeNodes.inc"
1443 };
1444
1445private:
1446 /// Bitfields required by the Type class.
1447 class TypeBitfields {
1448 friend class Type;
1449 template <class T> friend class TypePropertyCache;
1450
1451 /// TypeClass bitfield - Enum that specifies what subclass this belongs to.
1452 unsigned TC : 8;
1453
1454 /// Whether this type is a dependent type (C++ [temp.dep.type]).
1455 unsigned Dependent : 1;
1456
1457 /// Whether this type somehow involves a template parameter, even
1458 /// if the resolution of the type does not depend on a template parameter.
1459 unsigned InstantiationDependent : 1;
1460
1461 /// Whether this type is a variably-modified type (C99 6.7.5).
1462 unsigned VariablyModified : 1;
1463
1464 /// Whether this type contains an unexpanded parameter pack
1465 /// (for C++11 variadic templates).
1466 unsigned ContainsUnexpandedParameterPack : 1;
1467
1468 /// True if the cache (i.e. the bitfields here starting with
1469 /// 'Cache') is valid.
1470 mutable unsigned CacheValid : 1;
1471
1472 /// Linkage of this type.
1473 mutable unsigned CachedLinkage : 3;
1474
1475 /// Whether this type involves and local or unnamed types.
1476 mutable unsigned CachedLocalOrUnnamed : 1;
1477
1478 /// Whether this type comes from an AST file.
1479 mutable unsigned FromAST : 1;
1480
1481 bool isCacheValid() const {
1482 return CacheValid;
1483 }
1484
1485 Linkage getLinkage() const {
1486 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 1486, __PRETTY_FUNCTION__))
;
1487 return static_cast<Linkage>(CachedLinkage);
1488 }
1489
1490 bool hasLocalOrUnnamedType() const {
1491 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 1491, __PRETTY_FUNCTION__))
;
1492 return CachedLocalOrUnnamed;
1493 }
1494 };
1495 enum { NumTypeBits = 18 };
1496
1497protected:
1498 // These classes allow subclasses to somewhat cleanly pack bitfields
1499 // into Type.
1500
1501 class ArrayTypeBitfields {
1502 friend class ArrayType;
1503
1504 unsigned : NumTypeBits;
1505
1506 /// CVR qualifiers from declarations like
1507 /// 'int X[static restrict 4]'. For function parameters only.
1508 unsigned IndexTypeQuals : 3;
1509
1510 /// Storage class qualifiers from declarations like
1511 /// 'int X[static restrict 4]'. For function parameters only.
1512 /// Actually an ArrayType::ArraySizeModifier.
1513 unsigned SizeModifier : 3;
1514 };
1515
1516 class BuiltinTypeBitfields {
1517 friend class BuiltinType;
1518
1519 unsigned : NumTypeBits;
1520
1521 /// The kind (BuiltinType::Kind) of builtin type this is.
1522 unsigned Kind : 8;
1523 };
1524
1525 /// FunctionTypeBitfields store various bits belonging to FunctionProtoType.
1526 /// Only common bits are stored here. Additional uncommon bits are stored
1527 /// in a trailing object after FunctionProtoType.
1528 class FunctionTypeBitfields {
1529 friend class FunctionProtoType;
1530 friend class FunctionType;
1531
1532 unsigned : NumTypeBits;
1533
1534 /// Extra information which affects how the function is called, like
1535 /// regparm and the calling convention.
1536 unsigned ExtInfo : 12;
1537
1538 /// The ref-qualifier associated with a \c FunctionProtoType.
1539 ///
1540 /// This is a value of type \c RefQualifierKind.
1541 unsigned RefQualifier : 2;
1542
1543 /// Used only by FunctionProtoType, put here to pack with the
1544 /// other bitfields.
1545 /// The qualifiers are part of FunctionProtoType because...
1546 ///
1547 /// C++ 8.3.5p4: The return type, the parameter type list and the
1548 /// cv-qualifier-seq, [...], are part of the function type.
1549 unsigned FastTypeQuals : Qualifiers::FastWidth;
1550 /// Whether this function has extended Qualifiers.
1551 unsigned HasExtQuals : 1;
1552
1553 /// The number of parameters this function has, not counting '...'.
1554 /// According to [implimits] 8 bits should be enough here but this is
1555 /// somewhat easy to exceed with metaprogramming and so we would like to
1556 /// keep NumParams as wide as reasonably possible.
1557 unsigned NumParams : 16;
1558
1559 /// The type of exception specification this function has.
1560 unsigned ExceptionSpecType : 4;
1561
1562 /// Whether this function has extended parameter information.
1563 unsigned HasExtParameterInfos : 1;
1564
1565 /// Whether the function is variadic.
1566 unsigned Variadic : 1;
1567
1568 /// Whether this function has a trailing return type.
1569 unsigned HasTrailingReturn : 1;
1570 };
1571
1572 class ObjCObjectTypeBitfields {
1573 friend class ObjCObjectType;
1574
1575 unsigned : NumTypeBits;
1576
1577 /// The number of type arguments stored directly on this object type.
1578 unsigned NumTypeArgs : 7;
1579
1580 /// The number of protocols stored directly on this object type.
1581 unsigned NumProtocols : 6;
1582
1583 /// Whether this is a "kindof" type.
1584 unsigned IsKindOf : 1;
1585 };
1586
1587 class ReferenceTypeBitfields {
1588 friend class ReferenceType;
1589
1590 unsigned : NumTypeBits;
1591
1592 /// True if the type was originally spelled with an lvalue sigil.
1593 /// This is never true of rvalue references but can also be false
1594 /// on lvalue references because of C++0x [dcl.typedef]p9,
1595 /// as follows:
1596 ///
1597 /// typedef int &ref; // lvalue, spelled lvalue
1598 /// typedef int &&rvref; // rvalue
1599 /// ref &a; // lvalue, inner ref, spelled lvalue
1600 /// ref &&a; // lvalue, inner ref
1601 /// rvref &a; // lvalue, inner ref, spelled lvalue
1602 /// rvref &&a; // rvalue, inner ref
1603 unsigned SpelledAsLValue : 1;
1604
1605 /// True if the inner type is a reference type. This only happens
1606 /// in non-canonical forms.
1607 unsigned InnerRef : 1;
1608 };
1609
1610 class TypeWithKeywordBitfields {
1611 friend class TypeWithKeyword;
1612
1613 unsigned : NumTypeBits;
1614
1615 /// An ElaboratedTypeKeyword. 8 bits for efficient access.
1616 unsigned Keyword : 8;
1617 };
1618
1619 enum { NumTypeWithKeywordBits = 8 };
1620
1621 class ElaboratedTypeBitfields {
1622 friend class ElaboratedType;
1623
1624 unsigned : NumTypeBits;
1625 unsigned : NumTypeWithKeywordBits;
1626
1627 /// Whether the ElaboratedType has a trailing OwnedTagDecl.
1628 unsigned HasOwnedTagDecl : 1;
1629 };
1630
1631 class VectorTypeBitfields {
1632 friend class VectorType;
1633 friend class DependentVectorType;
1634
1635 unsigned : NumTypeBits;
1636
1637 /// The kind of vector, either a generic vector type or some
1638 /// target-specific vector type such as for AltiVec or Neon.
1639 unsigned VecKind : 3;
1640
1641 /// The number of elements in the vector.
1642 unsigned NumElements : 29 - NumTypeBits;
1643
1644 enum { MaxNumElements = (1 << (29 - NumTypeBits)) - 1 };
1645 };
1646
1647 class AttributedTypeBitfields {
1648 friend class AttributedType;
1649
1650 unsigned : NumTypeBits;
1651
1652 /// An AttributedType::Kind
1653 unsigned AttrKind : 32 - NumTypeBits;
1654 };
1655
1656 class AutoTypeBitfields {
1657 friend class AutoType;
1658
1659 unsigned : NumTypeBits;
1660
1661 /// Was this placeholder type spelled as 'auto', 'decltype(auto)',
1662 /// or '__auto_type'? AutoTypeKeyword value.
1663 unsigned Keyword : 2;
1664 };
1665
1666 class SubstTemplateTypeParmPackTypeBitfields {
1667 friend class SubstTemplateTypeParmPackType;
1668
1669 unsigned : NumTypeBits;
1670
1671 /// The number of template arguments in \c Arguments, which is
1672 /// expected to be able to hold at least 1024 according to [implimits].
1673 /// However as this limit is somewhat easy to hit with template
1674 /// metaprogramming we'd prefer to keep it as large as possible.
1675 /// At the moment it has been left as a non-bitfield since this type
1676 /// safely fits in 64 bits as an unsigned, so there is no reason to
1677 /// introduce the performance impact of a bitfield.
1678 unsigned NumArgs;
1679 };
1680
1681 class TemplateSpecializationTypeBitfields {
1682 friend class TemplateSpecializationType;
1683
1684 unsigned : NumTypeBits;
1685
1686 /// Whether this template specialization type is a substituted type alias.
1687 unsigned TypeAlias : 1;
1688
1689 /// The number of template arguments named in this class template
1690 /// specialization, which is expected to be able to hold at least 1024
1691 /// according to [implimits]. However, as this limit is somewhat easy to
1692 /// hit with template metaprogramming we'd prefer to keep it as large
1693 /// as possible. At the moment it has been left as a non-bitfield since
1694 /// this type safely fits in 64 bits as an unsigned, so there is no reason
1695 /// to introduce the performance impact of a bitfield.
1696 unsigned NumArgs;
1697 };
1698
1699 class DependentTemplateSpecializationTypeBitfields {
1700 friend class DependentTemplateSpecializationType;
1701
1702 unsigned : NumTypeBits;
1703 unsigned : NumTypeWithKeywordBits;
1704
1705 /// The number of template arguments named in this class template
1706 /// specialization, which is expected to be able to hold at least 1024
1707 /// according to [implimits]. However, as this limit is somewhat easy to
1708 /// hit with template metaprogramming we'd prefer to keep it as large
1709 /// as possible. At the moment it has been left as a non-bitfield since
1710 /// this type safely fits in 64 bits as an unsigned, so there is no reason
1711 /// to introduce the performance impact of a bitfield.
1712 unsigned NumArgs;
1713 };
1714
1715 class PackExpansionTypeBitfields {
1716 friend class PackExpansionType;
1717
1718 unsigned : NumTypeBits;
1719
1720 /// The number of expansions that this pack expansion will
1721 /// generate when substituted (+1), which is expected to be able to
1722 /// hold at least 1024 according to [implimits]. However, as this limit
1723 /// is somewhat easy to hit with template metaprogramming we'd prefer to
1724 /// keep it as large as possible. At the moment it has been left as a
1725 /// non-bitfield since this type safely fits in 64 bits as an unsigned, so
1726 /// there is no reason to introduce the performance impact of a bitfield.
1727 ///
1728 /// This field will only have a non-zero value when some of the parameter
1729 /// packs that occur within the pattern have been substituted but others
1730 /// have not.
1731 unsigned NumExpansions;
1732 };
1733
1734 union {
1735 TypeBitfields TypeBits;
1736 ArrayTypeBitfields ArrayTypeBits;
1737 AttributedTypeBitfields AttributedTypeBits;
1738 AutoTypeBitfields AutoTypeBits;
1739 BuiltinTypeBitfields BuiltinTypeBits;
1740 FunctionTypeBitfields FunctionTypeBits;
1741 ObjCObjectTypeBitfields ObjCObjectTypeBits;
1742 ReferenceTypeBitfields ReferenceTypeBits;
1743 TypeWithKeywordBitfields TypeWithKeywordBits;
1744 ElaboratedTypeBitfields ElaboratedTypeBits;
1745 VectorTypeBitfields VectorTypeBits;
1746 SubstTemplateTypeParmPackTypeBitfields SubstTemplateTypeParmPackTypeBits;
1747 TemplateSpecializationTypeBitfields TemplateSpecializationTypeBits;
1748 DependentTemplateSpecializationTypeBitfields
1749 DependentTemplateSpecializationTypeBits;
1750 PackExpansionTypeBitfields PackExpansionTypeBits;
1751
1752 static_assert(sizeof(TypeBitfields) <= 8,
1753 "TypeBitfields is larger than 8 bytes!");
1754 static_assert(sizeof(ArrayTypeBitfields) <= 8,
1755 "ArrayTypeBitfields is larger than 8 bytes!");
1756 static_assert(sizeof(AttributedTypeBitfields) <= 8,
1757 "AttributedTypeBitfields is larger than 8 bytes!");
1758 static_assert(sizeof(AutoTypeBitfields) <= 8,
1759 "AutoTypeBitfields is larger than 8 bytes!");
1760 static_assert(sizeof(BuiltinTypeBitfields) <= 8,
1761 "BuiltinTypeBitfields is larger than 8 bytes!");
1762 static_assert(sizeof(FunctionTypeBitfields) <= 8,
1763 "FunctionTypeBitfields is larger than 8 bytes!");
1764 static_assert(sizeof(ObjCObjectTypeBitfields) <= 8,
1765 "ObjCObjectTypeBitfields is larger than 8 bytes!");
1766 static_assert(sizeof(ReferenceTypeBitfields) <= 8,
1767 "ReferenceTypeBitfields is larger than 8 bytes!");
1768 static_assert(sizeof(TypeWithKeywordBitfields) <= 8,
1769 "TypeWithKeywordBitfields is larger than 8 bytes!");
1770 static_assert(sizeof(ElaboratedTypeBitfields) <= 8,
1771 "ElaboratedTypeBitfields is larger than 8 bytes!");
1772 static_assert(sizeof(VectorTypeBitfields) <= 8,
1773 "VectorTypeBitfields is larger than 8 bytes!");
1774 static_assert(sizeof(SubstTemplateTypeParmPackTypeBitfields) <= 8,
1775 "SubstTemplateTypeParmPackTypeBitfields is larger"
1776 " than 8 bytes!");
1777 static_assert(sizeof(TemplateSpecializationTypeBitfields) <= 8,
1778 "TemplateSpecializationTypeBitfields is larger"
1779 " than 8 bytes!");
1780 static_assert(sizeof(DependentTemplateSpecializationTypeBitfields) <= 8,
1781 "DependentTemplateSpecializationTypeBitfields is larger"
1782 " than 8 bytes!");
1783 static_assert(sizeof(PackExpansionTypeBitfields) <= 8,
1784 "PackExpansionTypeBitfields is larger than 8 bytes");
1785 };
1786
1787private:
1788 template <class T> friend class TypePropertyCache;
1789
1790 /// Set whether this type comes from an AST file.
1791 void setFromAST(bool V = true) const {
1792 TypeBits.FromAST = V;
1793 }
1794
1795protected:
1796 friend class ASTContext;
1797
1798 Type(TypeClass tc, QualType canon, bool Dependent,
1799 bool InstantiationDependent, bool VariablyModified,
1800 bool ContainsUnexpandedParameterPack)
1801 : ExtQualsTypeCommonBase(this,
1802 canon.isNull() ? QualType(this_(), 0) : canon) {
1803 TypeBits.TC = tc;
1804 TypeBits.Dependent = Dependent;
1805 TypeBits.InstantiationDependent = Dependent || InstantiationDependent;
1806 TypeBits.VariablyModified = VariablyModified;
1807 TypeBits.ContainsUnexpandedParameterPack = ContainsUnexpandedParameterPack;
1808 TypeBits.CacheValid = false;
1809 TypeBits.CachedLocalOrUnnamed = false;
1810 TypeBits.CachedLinkage = NoLinkage;
1811 TypeBits.FromAST = false;
1812 }
1813
1814 // silence VC++ warning C4355: 'this' : used in base member initializer list
1815 Type *this_() { return this; }
1816
1817 void setDependent(bool D = true) {
1818 TypeBits.Dependent = D;
1819 if (D)
1820 TypeBits.InstantiationDependent = true;
1821 }
1822
1823 void setInstantiationDependent(bool D = true) {
1824 TypeBits.InstantiationDependent = D; }
1825
1826 void setVariablyModified(bool VM = true) { TypeBits.VariablyModified = VM; }
1827
1828 void setContainsUnexpandedParameterPack(bool PP = true) {
1829 TypeBits.ContainsUnexpandedParameterPack = PP;
1830 }
1831
1832public:
1833 friend class ASTReader;
1834 friend class ASTWriter;
1835
1836 Type(const Type &) = delete;
1837 Type(Type &&) = delete;
1838 Type &operator=(const Type &) = delete;
1839 Type &operator=(Type &&) = delete;
1840
1841 TypeClass getTypeClass() const { return static_cast<TypeClass>(TypeBits.TC); }
1842
1843 /// Whether this type comes from an AST file.
1844 bool isFromAST() const { return TypeBits.FromAST; }
1845
1846 /// Whether this type is or contains an unexpanded parameter
1847 /// pack, used to support C++0x variadic templates.
1848 ///
1849 /// A type that contains a parameter pack shall be expanded by the
1850 /// ellipsis operator at some point. For example, the typedef in the
1851 /// following example contains an unexpanded parameter pack 'T':
1852 ///
1853 /// \code
1854 /// template<typename ...T>
1855 /// struct X {
1856 /// typedef T* pointer_types; // ill-formed; T is a parameter pack.
1857 /// };
1858 /// \endcode
1859 ///
1860 /// Note that this routine does not specify which
1861 bool containsUnexpandedParameterPack() const {
1862 return TypeBits.ContainsUnexpandedParameterPack;
1863 }
1864
1865 /// Determines if this type would be canonical if it had no further
1866 /// qualification.
1867 bool isCanonicalUnqualified() const {
1868 return CanonicalType == QualType(this, 0);
1869 }
1870
1871 /// Pull a single level of sugar off of this locally-unqualified type.
1872 /// Users should generally prefer SplitQualType::getSingleStepDesugaredType()
1873 /// or QualType::getSingleStepDesugaredType(const ASTContext&).
1874 QualType getLocallyUnqualifiedSingleStepDesugaredType() const;
1875
1876 /// Types are partitioned into 3 broad categories (C99 6.2.5p1):
1877 /// object types, function types, and incomplete types.
1878
1879 /// Return true if this is an incomplete type.
1880 /// A type that can describe objects, but which lacks information needed to
1881 /// determine its size (e.g. void, or a fwd declared struct). Clients of this
1882 /// routine will need to determine if the size is actually required.
1883 ///
1884 /// Def If non-null, and the type refers to some kind of declaration
1885 /// that can be completed (such as a C struct, C++ class, or Objective-C
1886 /// class), will be set to the declaration.
1887 bool isIncompleteType(NamedDecl **Def = nullptr) const;
1888
1889 /// Return true if this is an incomplete or object
1890 /// type, in other words, not a function type.
1891 bool isIncompleteOrObjectType() const {
1892 return !isFunctionType();
1893 }
1894
1895 /// Determine whether this type is an object type.
1896 bool isObjectType() const {
1897 // C++ [basic.types]p8:
1898 // An object type is a (possibly cv-qualified) type that is not a
1899 // function type, not a reference type, and not a void type.
1900 return !isReferenceType() && !isFunctionType() && !isVoidType();
1901 }
1902
1903 /// Return true if this is a literal type
1904 /// (C++11 [basic.types]p10)
1905 bool isLiteralType(const ASTContext &Ctx) const;
1906
1907 /// Test if this type is a standard-layout type.
1908 /// (C++0x [basic.type]p9)
1909 bool isStandardLayoutType() const;
1910
1911 /// Helper methods to distinguish type categories. All type predicates
1912 /// operate on the canonical type, ignoring typedefs and qualifiers.
1913
1914 /// Returns true if the type is a builtin type.
1915 bool isBuiltinType() const;
1916
1917 /// Test for a particular builtin type.
1918 bool isSpecificBuiltinType(unsigned K) const;
1919
1920 /// Test for a type which does not represent an actual type-system type but
1921 /// is instead used as a placeholder for various convenient purposes within
1922 /// Clang. All such types are BuiltinTypes.
1923 bool isPlaceholderType() const;
1924 const BuiltinType *getAsPlaceholderType() const;
1925
1926 /// Test for a specific placeholder type.
1927 bool isSpecificPlaceholderType(unsigned K) const;
1928
1929 /// Test for a placeholder type other than Overload; see
1930 /// BuiltinType::isNonOverloadPlaceholderType.
1931 bool isNonOverloadPlaceholderType() const;
1932
1933 /// isIntegerType() does *not* include complex integers (a GCC extension).
1934 /// isComplexIntegerType() can be used to test for complex integers.
1935 bool isIntegerType() const; // C99 6.2.5p17 (int, char, bool, enum)
1936 bool isEnumeralType() const;
1937
1938 /// Determine whether this type is a scoped enumeration type.
1939 bool isScopedEnumeralType() const;
1940 bool isBooleanType() const;
1941 bool isCharType() const;
1942 bool isWideCharType() const;
1943 bool isChar8Type() const;
1944 bool isChar16Type() const;
1945 bool isChar32Type() const;
1946 bool isAnyCharacterType() const;
1947 bool isIntegralType(const ASTContext &Ctx) const;
1948
1949 /// Determine whether this type is an integral or enumeration type.
1950 bool isIntegralOrEnumerationType() const;
1951
1952 /// Determine whether this type is an integral or unscoped enumeration type.
1953 bool isIntegralOrUnscopedEnumerationType() const;
1954
1955 /// Floating point categories.
1956 bool isRealFloatingType() const; // C99 6.2.5p10 (float, double, long double)
1957 /// isComplexType() does *not* include complex integers (a GCC extension).
1958 /// isComplexIntegerType() can be used to test for complex integers.
1959 bool isComplexType() const; // C99 6.2.5p11 (complex)
1960 bool isAnyComplexType() const; // C99 6.2.5p11 (complex) + Complex Int.
1961 bool isFloatingType() const; // C99 6.2.5p11 (real floating + complex)
1962 bool isHalfType() const; // OpenCL 6.1.1.1, NEON (IEEE 754-2008 half)
1963 bool isFloat16Type() const; // C11 extension ISO/IEC TS 18661
1964 bool isFloat128Type() const;
1965 bool isRealType() const; // C99 6.2.5p17 (real floating + integer)
1966 bool isArithmeticType() const; // C99 6.2.5p18 (integer + floating)
1967 bool isVoidType() const; // C99 6.2.5p19
1968 bool isScalarType() const; // C99 6.2.5p21 (arithmetic + pointers)
1969 bool isAggregateType() const;
1970 bool isFundamentalType() const;
1971 bool isCompoundType() const;
1972
1973 // Type Predicates: Check to see if this type is structurally the specified
1974 // type, ignoring typedefs and qualifiers.
1975 bool isFunctionType() const;
1976 bool isFunctionNoProtoType() const { return getAs<FunctionNoProtoType>(); }
1977 bool isFunctionProtoType() const { return getAs<FunctionProtoType>(); }
1978 bool isPointerType() const;
1979 bool isAnyPointerType() const; // Any C pointer or ObjC object pointer
1980 bool isBlockPointerType() const;
1981 bool isVoidPointerType() const;
1982 bool isReferenceType() const;
1983 bool isLValueReferenceType() const;
1984 bool isRValueReferenceType() const;
1985 bool isFunctionPointerType() const;
1986 bool isFunctionReferenceType() const;
1987 bool isMemberPointerType() const;
1988 bool isMemberFunctionPointerType() const;
1989 bool isMemberDataPointerType() const;
1990 bool isArrayType() const;
1991 bool isConstantArrayType() const;
1992 bool isIncompleteArrayType() const;
1993 bool isVariableArrayType() const;
1994 bool isDependentSizedArrayType() const;
1995 bool isRecordType() const;
1996 bool isClassType() const;
1997 bool isStructureType() const;
1998 bool isObjCBoxableRecordType() const;
1999 bool isInterfaceType() const;
2000 bool isStructureOrClassType() const;
2001 bool isUnionType() const;
2002 bool isComplexIntegerType() const; // GCC _Complex integer type.
2003 bool isVectorType() const; // GCC vector type.
2004 bool isExtVectorType() const; // Extended vector type.
2005 bool isDependentAddressSpaceType() const; // value-dependent address space qualifier
2006 bool isObjCObjectPointerType() const; // pointer to ObjC object
2007 bool isObjCRetainableType() const; // ObjC object or block pointer
2008 bool isObjCLifetimeType() const; // (array of)* retainable type
2009 bool isObjCIndirectLifetimeType() const; // (pointer to)* lifetime type
2010 bool isObjCNSObjectType() const; // __attribute__((NSObject))
2011 bool isObjCIndependentClassType() const; // __attribute__((objc_independent_class))
2012 // FIXME: change this to 'raw' interface type, so we can used 'interface' type
2013 // for the common case.
2014 bool isObjCObjectType() const; // NSString or typeof(*(id)0)
2015 bool isObjCQualifiedInterfaceType() const; // NSString<foo>
2016 bool isObjCQualifiedIdType() const; // id<foo>
2017 bool isObjCQualifiedClassType() const; // Class<foo>
2018 bool isObjCObjectOrInterfaceType() const;
2019 bool isObjCIdType() const; // id
2020 bool isDecltypeType() const;
2021 /// Was this type written with the special inert-in-ARC __unsafe_unretained
2022 /// qualifier?
2023 ///
2024 /// This approximates the answer to the following question: if this
2025 /// translation unit were compiled in ARC, would this type be qualified
2026 /// with __unsafe_unretained?
2027 bool isObjCInertUnsafeUnretainedType() const {
2028 return hasAttr(attr::ObjCInertUnsafeUnretained);
2029 }
2030
2031 /// Whether the type is Objective-C 'id' or a __kindof type of an
2032 /// object type, e.g., __kindof NSView * or __kindof id
2033 /// <NSCopying>.
2034 ///
2035 /// \param bound Will be set to the bound on non-id subtype types,
2036 /// which will be (possibly specialized) Objective-C class type, or
2037 /// null for 'id.
2038 bool isObjCIdOrObjectKindOfType(const ASTContext &ctx,
2039 const ObjCObjectType *&bound) const;
2040
2041 bool isObjCClassType() const; // Class
2042
2043 /// Whether the type is Objective-C 'Class' or a __kindof type of an
2044 /// Class type, e.g., __kindof Class <NSCopying>.
2045 ///
2046 /// Unlike \c isObjCIdOrObjectKindOfType, there is no relevant bound
2047 /// here because Objective-C's type system cannot express "a class
2048 /// object for a subclass of NSFoo".
2049 bool isObjCClassOrClassKindOfType() const;
2050
2051 bool isBlockCompatibleObjCPointerType(ASTContext &ctx) const;
2052 bool isObjCSelType() const; // Class
2053 bool isObjCBuiltinType() const; // 'id' or 'Class'
2054 bool isObjCARCBridgableType() const;
2055 bool isCARCBridgableType() const;
2056 bool isTemplateTypeParmType() const; // C++ template type parameter
2057 bool isNullPtrType() const; // C++11 std::nullptr_t
2058 bool isNothrowT() const; // C++ std::nothrow_t
2059 bool isAlignValT() const; // C++17 std::align_val_t
2060 bool isStdByteType() const; // C++17 std::byte
2061 bool isAtomicType() const; // C11 _Atomic()
2062
2063#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
2064 bool is##Id##Type() const;
2065#include "clang/Basic/OpenCLImageTypes.def"
2066
2067 bool isImageType() const; // Any OpenCL image type
2068
2069 bool isSamplerT() const; // OpenCL sampler_t
2070 bool isEventT() const; // OpenCL event_t
2071 bool isClkEventT() const; // OpenCL clk_event_t
2072 bool isQueueT() const; // OpenCL queue_t
2073 bool isReserveIDT() const; // OpenCL reserve_id_t
2074
2075#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
2076 bool is##Id##Type() const;
2077#include "clang/Basic/OpenCLExtensionTypes.def"
2078 // Type defined in cl_intel_device_side_avc_motion_estimation OpenCL extension
2079 bool isOCLIntelSubgroupAVCType() const;
2080 bool isOCLExtOpaqueType() const; // Any OpenCL extension type
2081
2082 bool isPipeType() const; // OpenCL pipe type
2083 bool isOpenCLSpecificType() const; // Any OpenCL specific type
2084
2085 /// Determines if this type, which must satisfy
2086 /// isObjCLifetimeType(), is implicitly __unsafe_unretained rather
2087 /// than implicitly __strong.
2088 bool isObjCARCImplicitlyUnretainedType() const;
2089
2090 /// Return the implicit lifetime for this type, which must not be dependent.
2091 Qualifiers::ObjCLifetime getObjCARCImplicitLifetime() const;
2092
2093 enum ScalarTypeKind {
2094 STK_CPointer,
2095 STK_BlockPointer,
2096 STK_ObjCObjectPointer,
2097 STK_MemberPointer,
2098 STK_Bool,
2099 STK_Integral,
2100 STK_Floating,
2101 STK_IntegralComplex,
2102 STK_FloatingComplex,
2103 STK_FixedPoint
2104 };
2105
2106 /// Given that this is a scalar type, classify it.
2107 ScalarTypeKind getScalarTypeKind() const;
2108
2109 /// Whether this type is a dependent type, meaning that its definition
2110 /// somehow depends on a template parameter (C++ [temp.dep.type]).
2111 bool isDependentType() const { return TypeBits.Dependent; }
2112
2113 /// Determine whether this type is an instantiation-dependent type,
2114 /// meaning that the type involves a template parameter (even if the
2115 /// definition does not actually depend on the type substituted for that
2116 /// template parameter).
2117 bool isInstantiationDependentType() const {
2118 return TypeBits.InstantiationDependent;
2119 }
2120
2121 /// Determine whether this type is an undeduced type, meaning that
2122 /// it somehow involves a C++11 'auto' type or similar which has not yet been
2123 /// deduced.
2124 bool isUndeducedType() const;
2125
2126 /// Whether this type is a variably-modified type (C99 6.7.5).
2127 bool isVariablyModifiedType() const { return TypeBits.VariablyModified; }
2128
2129 /// Whether this type involves a variable-length array type
2130 /// with a definite size.
2131 bool hasSizedVLAType() const;
2132
2133 /// Whether this type is or contains a local or unnamed type.
2134 bool hasUnnamedOrLocalType() const;
2135
2136 bool isOverloadableType() const;
2137
2138 /// Determine wither this type is a C++ elaborated-type-specifier.
2139 bool isElaboratedTypeSpecifier() const;
2140
2141 bool canDecayToPointerType() const;
2142
2143 /// Whether this type is represented natively as a pointer. This includes
2144 /// pointers, references, block pointers, and Objective-C interface,
2145 /// qualified id, and qualified interface types, as well as nullptr_t.
2146 bool hasPointerRepresentation() const;
2147
2148 /// Whether this type can represent an objective pointer type for the
2149 /// purpose of GC'ability
2150 bool hasObjCPointerRepresentation() const;
2151
2152 /// Determine whether this type has an integer representation
2153 /// of some sort, e.g., it is an integer type or a vector.
2154 bool hasIntegerRepresentation() const;
2155
2156 /// Determine whether this type has an signed integer representation
2157 /// of some sort, e.g., it is an signed integer type or a vector.
2158 bool hasSignedIntegerRepresentation() const;
2159
2160 /// Determine whether this type has an unsigned integer representation
2161 /// of some sort, e.g., it is an unsigned integer type or a vector.
2162 bool hasUnsignedIntegerRepresentation() const;
2163
2164 /// Determine whether this type has a floating-point representation
2165 /// of some sort, e.g., it is a floating-point type or a vector thereof.
2166 bool hasFloatingRepresentation() const;
2167
2168 // Type Checking Functions: Check to see if this type is structurally the
2169 // specified type, ignoring typedefs and qualifiers, and return a pointer to
2170 // the best type we can.
2171 const RecordType *getAsStructureType() const;
2172 /// NOTE: getAs*ArrayType are methods on ASTContext.
2173 const RecordType *getAsUnionType() const;
2174 const ComplexType *getAsComplexIntegerType() const; // GCC complex int type.
2175 const ObjCObjectType *getAsObjCInterfaceType() const;
2176
2177 // The following is a convenience method that returns an ObjCObjectPointerType
2178 // for object declared using an interface.
2179 const ObjCObjectPointerType *getAsObjCInterfacePointerType() const;
2180 const ObjCObjectPointerType *getAsObjCQualifiedIdType() const;
2181 const ObjCObjectPointerType *getAsObjCQualifiedClassType() const;
2182 const ObjCObjectType *getAsObjCQualifiedInterfaceType() const;
2183
2184 /// Retrieves the CXXRecordDecl that this type refers to, either
2185 /// because the type is a RecordType or because it is the injected-class-name
2186 /// type of a class template or class template partial specialization.
2187 CXXRecordDecl *getAsCXXRecordDecl() const;
2188
2189 /// Retrieves the RecordDecl this type refers to.
2190 RecordDecl *getAsRecordDecl() const;
2191
2192 /// Retrieves the TagDecl that this type refers to, either
2193 /// because the type is a TagType or because it is the injected-class-name
2194 /// type of a class template or class template partial specialization.
2195 TagDecl *getAsTagDecl() const;
2196
2197 /// If this is a pointer or reference to a RecordType, return the
2198 /// CXXRecordDecl that the type refers to.
2199 ///
2200 /// If this is not a pointer or reference, or the type being pointed to does
2201 /// not refer to a CXXRecordDecl, returns NULL.
2202 const CXXRecordDecl *getPointeeCXXRecordDecl() const;
2203
2204 /// Get the DeducedType whose type will be deduced for a variable with
2205 /// an initializer of this type. This looks through declarators like pointer
2206 /// types, but not through decltype or typedefs.
2207 DeducedType *getContainedDeducedType() const;
2208
2209 /// Get the AutoType whose type will be deduced for a variable with
2210 /// an initializer of this type. This looks through declarators like pointer
2211 /// types, but not through decltype or typedefs.
2212 AutoType *getContainedAutoType() const {
2213 return dyn_cast_or_null<AutoType>(getContainedDeducedType());
2214 }
2215
2216 /// Determine whether this type was written with a leading 'auto'
2217 /// corresponding to a trailing return type (possibly for a nested
2218 /// function type within a pointer to function type or similar).
2219 bool hasAutoForTrailingReturnType() const;
2220
2221 /// Member-template getAs<specific type>'. Look through sugar for
2222 /// an instance of \<specific type>. This scheme will eventually
2223 /// replace the specific getAsXXXX methods above.
2224 ///
2225 /// There are some specializations of this member template listed
2226 /// immediately following this class.
2227 template <typename T> const T *getAs() const;
2228
2229 /// Member-template getAsAdjusted<specific type>. Look through specific kinds
2230 /// of sugar (parens, attributes, etc) for an instance of \<specific type>.
2231 /// This is used when you need to walk over sugar nodes that represent some
2232 /// kind of type adjustment from a type that was written as a \<specific type>
2233 /// to another type that is still canonically a \<specific type>.
2234 template <typename T> const T *getAsAdjusted() const;
2235
2236 /// A variant of getAs<> for array types which silently discards
2237 /// qualifiers from the outermost type.
2238 const ArrayType *getAsArrayTypeUnsafe() const;
2239
2240 /// Member-template castAs<specific type>. Look through sugar for
2241 /// the underlying instance of \<specific type>.
2242 ///
2243 /// This method has the same relationship to getAs<T> as cast<T> has
2244 /// to dyn_cast<T>; which is to say, the underlying type *must*
2245 /// have the intended type, and this method will never return null.
2246 template <typename T> const T *castAs() const;
2247
2248 /// A variant of castAs<> for array type which silently discards
2249 /// qualifiers from the outermost type.
2250 const ArrayType *castAsArrayTypeUnsafe() const;
2251
2252 /// Determine whether this type had the specified attribute applied to it
2253 /// (looking through top-level type sugar).
2254 bool hasAttr(attr::Kind AK) const;
2255
2256 /// Get the base element type of this type, potentially discarding type
2257 /// qualifiers. This should never be used when type qualifiers
2258 /// are meaningful.
2259 const Type *getBaseElementTypeUnsafe() const;
2260
2261 /// If this is an array type, return the element type of the array,
2262 /// potentially with type qualifiers missing.
2263 /// This should never be used when type qualifiers are meaningful.
2264 const Type *getArrayElementTypeNoTypeQual() const;
2265
2266 /// If this is a pointer type, return the pointee type.
2267 /// If this is an array type, return the array element type.
2268 /// This should never be used when type qualifiers are meaningful.
2269 const Type *getPointeeOrArrayElementType() const;
2270
2271 /// If this is a pointer, ObjC object pointer, or block
2272 /// pointer, this returns the respective pointee.
2273 QualType getPointeeType() const;
2274
2275 /// Return the specified type with any "sugar" removed from the type,
2276 /// removing any typedefs, typeofs, etc., as well as any qualifiers.
2277 const Type *getUnqualifiedDesugaredType() const;
2278
2279 /// More type predicates useful for type checking/promotion
2280 bool isPromotableIntegerType() const; // C99 6.3.1.1p2
2281
2282 /// Return true if this is an integer type that is
2283 /// signed, according to C99 6.2.5p4 [char, signed char, short, int, long..],
2284 /// or an enum decl which has a signed representation.
2285 bool isSignedIntegerType() const;
2286
2287 /// Return true if this is an integer type that is
2288 /// unsigned, according to C99 6.2.5p6 [which returns true for _Bool],
2289 /// or an enum decl which has an unsigned representation.
2290 bool isUnsignedIntegerType() const;
2291
2292 /// Determines whether this is an integer type that is signed or an
2293 /// enumeration types whose underlying type is a signed integer type.
2294 bool isSignedIntegerOrEnumerationType() const;
2295
2296 /// Determines whether this is an integer type that is unsigned or an
2297 /// enumeration types whose underlying type is a unsigned integer type.
2298 bool isUnsignedIntegerOrEnumerationType() const;
2299
2300 /// Return true if this is a fixed point type according to
2301 /// ISO/IEC JTC1 SC22 WG14 N1169.
2302 bool isFixedPointType() const;
2303
2304 /// Return true if this is a fixed point or integer type.
2305 bool isFixedPointOrIntegerType() const;
2306
2307 /// Return true if this is a saturated fixed point type according to
2308 /// ISO/IEC JTC1 SC22 WG14 N1169. This type can be signed or unsigned.
2309 bool isSaturatedFixedPointType() const;
2310
2311 /// Return true if this is a saturated fixed point type according to
2312 /// ISO/IEC JTC1 SC22 WG14 N1169. This type can be signed or unsigned.
2313 bool isUnsaturatedFixedPointType() const;
2314
2315 /// Return true if this is a fixed point type that is signed according
2316 /// to ISO/IEC JTC1 SC22 WG14 N1169. This type can also be saturated.
2317 bool isSignedFixedPointType() const;
2318
2319 /// Return true if this is a fixed point type that is unsigned according
2320 /// to ISO/IEC JTC1 SC22 WG14 N1169. This type can also be saturated.
2321 bool isUnsignedFixedPointType() const;
2322
2323 /// Return true if this is not a variable sized type,
2324 /// according to the rules of C99 6.7.5p3. It is not legal to call this on
2325 /// incomplete types.
2326 bool isConstantSizeType() const;
2327
2328 /// Returns true if this type can be represented by some
2329 /// set of type specifiers.
2330 bool isSpecifierType() const;
2331
2332 /// Determine the linkage of this type.
2333 Linkage getLinkage() const;
2334
2335 /// Determine the visibility of this type.
2336 Visibility getVisibility() const {
2337 return getLinkageAndVisibility().getVisibility();
2338 }
2339
2340 /// Return true if the visibility was explicitly set is the code.
2341 bool isVisibilityExplicit() const {
2342 return getLinkageAndVisibility().isVisibilityExplicit();
2343 }
2344
2345 /// Determine the linkage and visibility of this type.
2346 LinkageInfo getLinkageAndVisibility() const;
2347
2348 /// True if the computed linkage is valid. Used for consistency
2349 /// checking. Should always return true.
2350 bool isLinkageValid() const;
2351
2352 /// Determine the nullability of the given type.
2353 ///
2354 /// Note that nullability is only captured as sugar within the type
2355 /// system, not as part of the canonical type, so nullability will
2356 /// be lost by canonicalization and desugaring.
2357 Optional<NullabilityKind> getNullability(const ASTContext &context) const;
2358
2359 /// Determine whether the given type can have a nullability
2360 /// specifier applied to it, i.e., if it is any kind of pointer type.
2361 ///
2362 /// \param ResultIfUnknown The value to return if we don't yet know whether
2363 /// this type can have nullability because it is dependent.
2364 bool canHaveNullability(bool ResultIfUnknown = true) const;
2365
2366 /// Retrieve the set of substitutions required when accessing a member
2367 /// of the Objective-C receiver type that is declared in the given context.
2368 ///
2369 /// \c *this is the type of the object we're operating on, e.g., the
2370 /// receiver for a message send or the base of a property access, and is
2371 /// expected to be of some object or object pointer type.
2372 ///
2373 /// \param dc The declaration context for which we are building up a
2374 /// substitution mapping, which should be an Objective-C class, extension,
2375 /// category, or method within.
2376 ///
2377 /// \returns an array of type arguments that can be substituted for
2378 /// the type parameters of the given declaration context in any type described
2379 /// within that context, or an empty optional to indicate that no
2380 /// substitution is required.
2381 Optional<ArrayRef<QualType>>
2382 getObjCSubstitutions(const DeclContext *dc) const;
2383
2384 /// Determines if this is an ObjC interface type that may accept type
2385 /// parameters.
2386 bool acceptsObjCTypeParams() const;
2387
2388 const char *getTypeClassName() const;
2389
2390 QualType getCanonicalTypeInternal() const {
2391 return CanonicalType;
2392 }
2393
2394 CanQualType getCanonicalTypeUnqualified() const; // in CanonicalType.h
2395 void dump() const;
2396 void dump(llvm::raw_ostream &OS) const;
2397};
2398
2399/// This will check for a TypedefType by removing any existing sugar
2400/// until it reaches a TypedefType or a non-sugared type.
2401template <> const TypedefType *Type::getAs() const;
2402
2403/// This will check for a TemplateSpecializationType by removing any
2404/// existing sugar until it reaches a TemplateSpecializationType or a
2405/// non-sugared type.
2406template <> const TemplateSpecializationType *Type::getAs() const;
2407
2408/// This will check for an AttributedType by removing any existing sugar
2409/// until it reaches an AttributedType or a non-sugared type.
2410template <> const AttributedType *Type::getAs() const;
2411
2412// We can do canonical leaf types faster, because we don't have to
2413// worry about preserving child type decoration.
2414#define TYPE(Class, Base)
2415#define LEAF_TYPE(Class) \
2416template <> inline const Class##Type *Type::getAs() const { \
2417 return dyn_cast<Class##Type>(CanonicalType); \
2418} \
2419template <> inline const Class##Type *Type::castAs() const { \
2420 return cast<Class##Type>(CanonicalType); \
2421}
2422#include "clang/AST/TypeNodes.inc"
2423
2424/// This class is used for builtin types like 'int'. Builtin
2425/// types are always canonical and have a literal name field.
2426class BuiltinType : public Type {
2427public:
2428 enum Kind {
2429// OpenCL image types
2430#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) Id,
2431#include "clang/Basic/OpenCLImageTypes.def"
2432// OpenCL extension types
2433#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) Id,
2434#include "clang/Basic/OpenCLExtensionTypes.def"
2435// SVE Types
2436#define SVE_TYPE(Name, Id, SingletonId) Id,
2437#include "clang/Basic/AArch64SVEACLETypes.def"
2438// All other builtin types
2439#define BUILTIN_TYPE(Id, SingletonId) Id,
2440#define LAST_BUILTIN_TYPE(Id) LastKind = Id
2441#include "clang/AST/BuiltinTypes.def"
2442 };
2443
2444private:
2445 friend class ASTContext; // ASTContext creates these.
2446
2447 BuiltinType(Kind K)
2448 : Type(Builtin, QualType(), /*Dependent=*/(K == Dependent),
2449 /*InstantiationDependent=*/(K == Dependent),
2450 /*VariablyModified=*/false,
2451 /*Unexpanded parameter pack=*/false) {
2452 BuiltinTypeBits.Kind = K;
2453 }
2454
2455public:
2456 Kind getKind() const { return static_cast<Kind>(BuiltinTypeBits.Kind); }
2457 StringRef getName(const PrintingPolicy &Policy) const;
2458
2459 const char *getNameAsCString(const PrintingPolicy &Policy) const {
2460 // The StringRef is null-terminated.
2461 StringRef str = getName(Policy);
2462 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 2462, __PRETTY_FUNCTION__))
;
2463 return str.data();
2464 }
2465
2466 bool isSugared() const { return false; }
2467 QualType desugar() const { return QualType(this, 0); }
2468
2469 bool isInteger() const {
2470 return getKind() >= Bool && getKind() <= Int128;
2471 }
2472
2473 bool isSignedInteger() const {
2474 return getKind() >= Char_S && getKind() <= Int128;
2475 }
2476
2477 bool isUnsignedInteger() const {
2478 return getKind() >= Bool && getKind() <= UInt128;
2479 }
2480
2481 bool isFloatingPoint() const {
2482 return getKind() >= Half && getKind() <= Float128;
2483 }
2484
2485 /// Determines whether the given kind corresponds to a placeholder type.
2486 static bool isPlaceholderTypeKind(Kind K) {
2487 return K >= Overload;
2488 }
2489
2490 /// Determines whether this type is a placeholder type, i.e. a type
2491 /// which cannot appear in arbitrary positions in a fully-formed
2492 /// expression.
2493 bool isPlaceholderType() const {
2494 return isPlaceholderTypeKind(getKind());
2495 }
2496
2497 /// Determines whether this type is a placeholder type other than
2498 /// Overload. Most placeholder types require only syntactic
2499 /// information about their context in order to be resolved (e.g.
2500 /// whether it is a call expression), which means they can (and
2501 /// should) be resolved in an earlier "phase" of analysis.
2502 /// Overload expressions sometimes pick up further information
2503 /// from their context, like whether the context expects a
2504 /// specific function-pointer type, and so frequently need
2505 /// special treatment.
2506 bool isNonOverloadPlaceholderType() const {
2507 return getKind() > Overload;
2508 }
2509
2510 static bool classof(const Type *T) { return T->getTypeClass() == Builtin; }
2511};
2512
2513/// Complex values, per C99 6.2.5p11. This supports the C99 complex
2514/// types (_Complex float etc) as well as the GCC integer complex extensions.
2515class ComplexType : public Type, public llvm::FoldingSetNode {
2516 friend class ASTContext; // ASTContext creates these.
2517
2518 QualType ElementType;
2519
2520 ComplexType(QualType Element, QualType CanonicalPtr)
2521 : Type(Complex, CanonicalPtr, Element->isDependentType(),
2522 Element->isInstantiationDependentType(),
2523 Element->isVariablyModifiedType(),
2524 Element->containsUnexpandedParameterPack()),
2525 ElementType(Element) {}
2526
2527public:
2528 QualType getElementType() const { return ElementType; }
2529
2530 bool isSugared() const { return false; }
2531 QualType desugar() const { return QualType(this, 0); }
2532
2533 void Profile(llvm::FoldingSetNodeID &ID) {
2534 Profile(ID, getElementType());
2535 }
2536
2537 static void Profile(llvm::FoldingSetNodeID &ID, QualType Element) {
2538 ID.AddPointer(Element.getAsOpaquePtr());
2539 }
2540
2541 static bool classof(const Type *T) { return T->getTypeClass() == Complex; }
2542};
2543
2544/// Sugar for parentheses used when specifying types.
2545class ParenType : public Type, public llvm::FoldingSetNode {
2546 friend class ASTContext; // ASTContext creates these.
2547
2548 QualType Inner;
2549
2550 ParenType(QualType InnerType, QualType CanonType)
2551 : Type(Paren, CanonType, InnerType->isDependentType(),
2552 InnerType->isInstantiationDependentType(),
2553 InnerType->isVariablyModifiedType(),
2554 InnerType->containsUnexpandedParameterPack()),
2555 Inner(InnerType) {}
2556
2557public:
2558 QualType getInnerType() const { return Inner; }
2559
2560 bool isSugared() const { return true; }
2561 QualType desugar() const { return getInnerType(); }
2562
2563 void Profile(llvm::FoldingSetNodeID &ID) {
2564 Profile(ID, getInnerType());
2565 }
2566
2567 static void Profile(llvm::FoldingSetNodeID &ID, QualType Inner) {
2568 Inner.Profile(ID);
2569 }
2570
2571 static bool classof(const Type *T) { return T->getTypeClass() == Paren; }
2572};
2573
2574/// PointerType - C99 6.7.5.1 - Pointer Declarators.
2575class PointerType : public Type, public llvm::FoldingSetNode {
2576 friend class ASTContext; // ASTContext creates these.
2577
2578 QualType PointeeType;
2579
2580 PointerType(QualType Pointee, QualType CanonicalPtr)
2581 : Type(Pointer, CanonicalPtr, Pointee->isDependentType(),
2582 Pointee->isInstantiationDependentType(),
2583 Pointee->isVariablyModifiedType(),
2584 Pointee->containsUnexpandedParameterPack()),
2585 PointeeType(Pointee) {}
2586
2587public:
2588 QualType getPointeeType() const { return PointeeType; }
2589
2590 /// Returns true if address spaces of pointers overlap.
2591 /// OpenCL v2.0 defines conversion rules for pointers to different
2592 /// address spaces (OpenCLC v2.0 s6.5.5) and notion of overlapping
2593 /// address spaces.
2594 /// CL1.1 or CL1.2:
2595 /// address spaces overlap iff they are they same.
2596 /// CL2.0 adds:
2597 /// __generic overlaps with any address space except for __constant.
2598 bool isAddressSpaceOverlapping(const PointerType &other) const {
2599 Qualifiers thisQuals = PointeeType.getQualifiers();
2600 Qualifiers otherQuals = other.getPointeeType().getQualifiers();
2601 // Address spaces overlap if at least one of them is a superset of another
2602 return thisQuals.isAddressSpaceSupersetOf(otherQuals) ||
2603 otherQuals.isAddressSpaceSupersetOf(thisQuals);
2604 }
2605
2606 bool isSugared() const { return false; }
2607 QualType desugar() const { return QualType(this, 0); }
2608
2609 void Profile(llvm::FoldingSetNodeID &ID) {
2610 Profile(ID, getPointeeType());
2611 }
2612
2613 static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee) {
2614 ID.AddPointer(Pointee.getAsOpaquePtr());
2615 }
2616
2617 static bool classof(const Type *T) { return T->getTypeClass() == Pointer; }
2618};
2619
2620/// Represents a type which was implicitly adjusted by the semantic
2621/// engine for arbitrary reasons. For example, array and function types can
2622/// decay, and function types can have their calling conventions adjusted.
2623class AdjustedType : public Type, public llvm::FoldingSetNode {
2624 QualType OriginalTy;
2625 QualType AdjustedTy;
2626
2627protected:
2628 friend class ASTContext; // ASTContext creates these.
2629
2630 AdjustedType(TypeClass TC, QualType OriginalTy, QualType AdjustedTy,
2631 QualType CanonicalPtr)
2632 : Type(TC, CanonicalPtr, OriginalTy->isDependentType(),
2633 OriginalTy->isInstantiationDependentType(),
2634 OriginalTy->isVariablyModifiedType(),
2635 OriginalTy->containsUnexpandedParameterPack()),
2636 OriginalTy(OriginalTy), AdjustedTy(AdjustedTy) {}
2637
2638public:
2639 QualType getOriginalType() const { return OriginalTy; }
2640 QualType getAdjustedType() const { return AdjustedTy; }
2641
2642 bool isSugared() const { return true; }
2643 QualType desugar() const { return AdjustedTy; }
2644
2645 void Profile(llvm::FoldingSetNodeID &ID) {
2646 Profile(ID, OriginalTy, AdjustedTy);
2647 }
2648
2649 static void Profile(llvm::FoldingSetNodeID &ID, QualType Orig, QualType New) {
2650 ID.AddPointer(Orig.getAsOpaquePtr());
2651 ID.AddPointer(New.getAsOpaquePtr());
2652 }
2653
2654 static bool classof(const Type *T) {
2655 return T->getTypeClass() == Adjusted || T->getTypeClass() == Decayed;
2656 }
2657};
2658
2659/// Represents a pointer type decayed from an array or function type.
2660class DecayedType : public AdjustedType {
2661 friend class ASTContext; // ASTContext creates these.
2662
2663 inline
2664 DecayedType(QualType OriginalType, QualType Decayed, QualType Canonical);
2665
2666public:
2667 QualType getDecayedType() const { return getAdjustedType(); }
2668
2669 inline QualType getPointeeType() const;
2670
2671 static bool classof(const Type *T) { return T->getTypeClass() == Decayed; }
2672};
2673
2674/// Pointer to a block type.
2675/// This type is to represent types syntactically represented as
2676/// "void (^)(int)", etc. Pointee is required to always be a function type.
2677class BlockPointerType : public Type, public llvm::FoldingSetNode {
2678 friend class ASTContext; // ASTContext creates these.
2679
2680 // Block is some kind of pointer type
2681 QualType PointeeType;
2682
2683 BlockPointerType(QualType Pointee, QualType CanonicalCls)
2684 : Type(BlockPointer, CanonicalCls, Pointee->isDependentType(),
2685 Pointee->isInstantiationDependentType(),
2686 Pointee->isVariablyModifiedType(),
2687 Pointee->containsUnexpandedParameterPack()),
2688 PointeeType(Pointee) {}
2689
2690public:
2691 // Get the pointee type. Pointee is required to always be a function type.
2692 QualType getPointeeType() const { return PointeeType; }
2693
2694 bool isSugared() const { return false; }
2695 QualType desugar() const { return QualType(this, 0); }
2696
2697 void Profile(llvm::FoldingSetNodeID &ID) {
2698 Profile(ID, getPointeeType());
2699 }
2700
2701 static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee) {
2702 ID.AddPointer(Pointee.getAsOpaquePtr());
2703 }
2704
2705 static bool classof(const Type *T) {
2706 return T->getTypeClass() == BlockPointer;
2707 }
2708};
2709
2710/// Base for LValueReferenceType and RValueReferenceType
2711class ReferenceType : public Type, public llvm::FoldingSetNode {
2712 QualType PointeeType;
2713
2714protected:
2715 ReferenceType(TypeClass tc, QualType Referencee, QualType CanonicalRef,
2716 bool SpelledAsLValue)
2717 : Type(tc, CanonicalRef, Referencee->isDependentType(),
2718 Referencee->isInstantiationDependentType(),
2719 Referencee->isVariablyModifiedType(),
2720 Referencee->containsUnexpandedParameterPack()),
2721 PointeeType(Referencee) {
2722 ReferenceTypeBits.SpelledAsLValue = SpelledAsLValue;
2723 ReferenceTypeBits.InnerRef = Referencee->isReferenceType();
2724 }
2725
2726public:
2727 bool isSpelledAsLValue() const { return ReferenceTypeBits.SpelledAsLValue; }
2728 bool isInnerRef() const { return ReferenceTypeBits.InnerRef; }
2729
2730 QualType getPointeeTypeAsWritten() const { return PointeeType; }
2731
2732 QualType getPointeeType() const {
2733 // FIXME: this might strip inner qualifiers; okay?
2734 const ReferenceType *T = this;
2735 while (T->isInnerRef())
2736 T = T->PointeeType->castAs<ReferenceType>();
2737 return T->PointeeType;
2738 }
2739
2740 void Profile(llvm::FoldingSetNodeID &ID) {
2741 Profile(ID, PointeeType, isSpelledAsLValue());
2742 }
2743
2744 static void Profile(llvm::FoldingSetNodeID &ID,
2745 QualType Referencee,
2746 bool SpelledAsLValue) {
2747 ID.AddPointer(Referencee.getAsOpaquePtr());
2748 ID.AddBoolean(SpelledAsLValue);
2749 }
2750
2751 static bool classof(const Type *T) {
2752 return T->getTypeClass() == LValueReference ||
2753 T->getTypeClass() == RValueReference;
2754 }
2755};
2756
2757/// An lvalue reference type, per C++11 [dcl.ref].
2758class LValueReferenceType : public ReferenceType {
2759 friend class ASTContext; // ASTContext creates these
2760
2761 LValueReferenceType(QualType Referencee, QualType CanonicalRef,
2762 bool SpelledAsLValue)
2763 : ReferenceType(LValueReference, Referencee, CanonicalRef,
2764 SpelledAsLValue) {}
2765
2766public:
2767 bool isSugared() const { return false; }
2768 QualType desugar() const { return QualType(this, 0); }
2769
2770 static bool classof(const Type *T) {
2771 return T->getTypeClass() == LValueReference;
2772 }
2773};
2774
2775/// An rvalue reference type, per C++11 [dcl.ref].
2776class RValueReferenceType : public ReferenceType {
2777 friend class ASTContext; // ASTContext creates these
2778
2779 RValueReferenceType(QualType Referencee, QualType CanonicalRef)
2780 : ReferenceType(RValueReference, Referencee, CanonicalRef, false) {}
2781
2782public:
2783 bool isSugared() const { return false; }
2784 QualType desugar() const { return QualType(this, 0); }
2785
2786 static bool classof(const Type *T) {
2787 return T->getTypeClass() == RValueReference;
2788 }
2789};
2790
2791/// A pointer to member type per C++ 8.3.3 - Pointers to members.
2792///
2793/// This includes both pointers to data members and pointer to member functions.
2794class MemberPointerType : public Type, public llvm::FoldingSetNode {
2795 friend class ASTContext; // ASTContext creates these.
2796
2797 QualType PointeeType;
2798
2799 /// The class of which the pointee is a member. Must ultimately be a
2800 /// RecordType, but could be a typedef or a template parameter too.
2801 const Type *Class;
2802
2803 MemberPointerType(QualType Pointee, const Type *Cls, QualType CanonicalPtr)
2804 : Type(MemberPointer, CanonicalPtr,
2805 Cls->isDependentType() || Pointee->isDependentType(),
2806 (Cls->isInstantiationDependentType() ||
2807 Pointee->isInstantiationDependentType()),
2808 Pointee->isVariablyModifiedType(),
2809 (Cls->containsUnexpandedParameterPack() ||
2810 Pointee->containsUnexpandedParameterPack())),
2811 PointeeType(Pointee), Class(Cls) {}
2812
2813public:
2814 QualType getPointeeType() const { return PointeeType; }
2815
2816 /// Returns true if the member type (i.e. the pointee type) is a
2817 /// function type rather than a data-member type.
2818 bool isMemberFunctionPointer() const {
2819 return PointeeType->isFunctionProtoType();
2820 }
2821
2822 /// Returns true if the member type (i.e. the pointee type) is a
2823 /// data type rather than a function type.
2824 bool isMemberDataPointer() const {
2825 return !PointeeType->isFunctionProtoType();
2826 }
2827
2828 const Type *getClass() const { return Class; }
2829 CXXRecordDecl *getMostRecentCXXRecordDecl() const;
2830
2831 bool isSugared() const { return false; }
2832 QualType desugar() const { return QualType(this, 0); }
2833
2834 void Profile(llvm::FoldingSetNodeID &ID) {
2835 Profile(ID, getPointeeType(), getClass());
2836 }
2837
2838 static void Profile(llvm::FoldingSetNodeID &ID, QualType Pointee,
2839 const Type *Class) {
2840 ID.AddPointer(Pointee.getAsOpaquePtr());
2841 ID.AddPointer(Class);
2842 }
2843
2844 static bool classof(const Type *T) {
2845 return T->getTypeClass() == MemberPointer;
2846 }
2847};
2848
2849/// Represents an array type, per C99 6.7.5.2 - Array Declarators.
2850class ArrayType : public Type, public llvm::FoldingSetNode {
2851public:
2852 /// Capture whether this is a normal array (e.g. int X[4])
2853 /// an array with a static size (e.g. int X[static 4]), or an array
2854 /// with a star size (e.g. int X[*]).
2855 /// 'static' is only allowed on function parameters.
2856 enum ArraySizeModifier {
2857 Normal, Static, Star
2858 };
2859
2860private:
2861 /// The element type of the array.
2862 QualType ElementType;
2863
2864protected:
2865 friend class ASTContext; // ASTContext creates these.
2866
2867 // C++ [temp.dep.type]p1:
2868 // A type is dependent if it is...
2869 // - an array type constructed from any dependent type or whose
2870 // size is specified by a constant expression that is
2871 // value-dependent,
2872 ArrayType(TypeClass tc, QualType et, QualType can,
2873 ArraySizeModifier sm, unsigned tq,
2874 bool ContainsUnexpandedParameterPack)
2875 : Type(tc, can, et->isDependentType() || tc == DependentSizedArray,
2876 et->isInstantiationDependentType() || tc == DependentSizedArray,
2877 (tc == VariableArray || et->isVariablyModifiedType()),
2878 ContainsUnexpandedParameterPack),
2879 ElementType(et) {
2880 ArrayTypeBits.IndexTypeQuals = tq;
2881 ArrayTypeBits.SizeModifier = sm;
2882 }
2883
2884public:
2885 QualType getElementType() const { return ElementType; }
2886
2887 ArraySizeModifier getSizeModifier() const {
2888 return ArraySizeModifier(ArrayTypeBits.SizeModifier);
2889 }
2890
2891 Qualifiers getIndexTypeQualifiers() const {
2892 return Qualifiers::fromCVRMask(getIndexTypeCVRQualifiers());
2893 }
2894
2895 unsigned getIndexTypeCVRQualifiers() const {
2896 return ArrayTypeBits.IndexTypeQuals;
2897 }
2898
2899 static bool classof(const Type *T) {
2900 return T->getTypeClass() == ConstantArray ||
2901 T->getTypeClass() == VariableArray ||
2902 T->getTypeClass() == IncompleteArray ||
2903 T->getTypeClass() == DependentSizedArray;
2904 }
2905};
2906
2907/// Represents the canonical version of C arrays with a specified constant size.
2908/// For example, the canonical type for 'int A[4 + 4*100]' is a
2909/// ConstantArrayType where the element type is 'int' and the size is 404.
2910class ConstantArrayType : public ArrayType {
2911 llvm::APInt Size; // Allows us to unique the type.
2912
2913 ConstantArrayType(QualType et, QualType can, const llvm::APInt &size,
2914 ArraySizeModifier sm, unsigned tq)
2915 : ArrayType(ConstantArray, et, can, sm, tq,
2916 et->containsUnexpandedParameterPack()),
2917 Size(size) {}
2918
2919protected:
2920 friend class ASTContext; // ASTContext creates these.
2921
2922 ConstantArrayType(TypeClass tc, QualType et, QualType can,
2923 const llvm::APInt &size, ArraySizeModifier sm, unsigned tq)
2924 : ArrayType(tc, et, can, sm, tq, et->containsUnexpandedParameterPack()),
2925 Size(size) {}
2926
2927public:
2928 const llvm::APInt &getSize() const { return Size; }
2929 bool isSugared() const { return false; }
2930 QualType desugar() const { return QualType(this, 0); }
2931
2932 /// Determine the number of bits required to address a member of
2933 // an array with the given element type and number of elements.
2934 static unsigned getNumAddressingBits(const ASTContext &Context,
2935 QualType ElementType,
2936 const llvm::APInt &NumElements);
2937
2938 /// Determine the maximum number of active bits that an array's size
2939 /// can require, which limits the maximum size of the array.
2940 static unsigned getMaxSizeBits(const ASTContext &Context);
2941
2942 void Profile(llvm::FoldingSetNodeID &ID) {
2943 Profile(ID, getElementType(), getSize(),
2944 getSizeModifier(), getIndexTypeCVRQualifiers());
2945 }
2946
2947 static void Profile(llvm::FoldingSetNodeID &ID, QualType ET,
2948 const llvm::APInt &ArraySize, ArraySizeModifier SizeMod,
2949 unsigned TypeQuals) {
2950 ID.AddPointer(ET.getAsOpaquePtr());
2951 ID.AddInteger(ArraySize.getZExtValue());
2952 ID.AddInteger(SizeMod);
2953 ID.AddInteger(TypeQuals);
2954 }
2955
2956 static bool classof(const Type *T) {
2957 return T->getTypeClass() == ConstantArray;
2958 }
2959};
2960
2961/// Represents a C array with an unspecified size. For example 'int A[]' has
2962/// an IncompleteArrayType where the element type is 'int' and the size is
2963/// unspecified.
2964class IncompleteArrayType : public ArrayType {
2965 friend class ASTContext; // ASTContext creates these.
2966
2967 IncompleteArrayType(QualType et, QualType can,
2968 ArraySizeModifier sm, unsigned tq)
2969 : ArrayType(IncompleteArray, et, can, sm, tq,
2970 et->containsUnexpandedParameterPack()) {}
2971
2972public:
2973 friend class StmtIteratorBase;
2974
2975 bool isSugared() const { return false; }
2976 QualType desugar() const { return QualType(this, 0); }
2977
2978 static bool classof(const Type *T) {
2979 return T->getTypeClass() == IncompleteArray;
2980 }
2981
2982 void Profile(llvm::FoldingSetNodeID &ID) {
2983 Profile(ID, getElementType(), getSizeModifier(),
2984 getIndexTypeCVRQualifiers());
2985 }
2986
2987 static void Profile(llvm::FoldingSetNodeID &ID, QualType ET,
2988 ArraySizeModifier SizeMod, unsigned TypeQuals) {
2989 ID.AddPointer(ET.getAsOpaquePtr());
2990 ID.AddInteger(SizeMod);
2991 ID.AddInteger(TypeQuals);
2992 }
2993};
2994
2995/// Represents a C array with a specified size that is not an
2996/// integer-constant-expression. For example, 'int s[x+foo()]'.
2997/// Since the size expression is an arbitrary expression, we store it as such.
2998///
2999/// Note: VariableArrayType's aren't uniqued (since the expressions aren't) and
3000/// should not be: two lexically equivalent variable array types could mean
3001/// different things, for example, these variables do not have the same type
3002/// dynamically:
3003///
3004/// void foo(int x) {
3005/// int Y[x];
3006/// ++x;
3007/// int Z[x];
3008/// }
3009class VariableArrayType : public ArrayType {
3010 friend class ASTContext; // ASTContext creates these.
3011
3012 /// An assignment-expression. VLA's are only permitted within
3013 /// a function block.
3014 Stmt *SizeExpr;
3015
3016 /// The range spanned by the left and right array brackets.
3017 SourceRange Brackets;
3018
3019 VariableArrayType(QualType et, QualType can, Expr *e,
3020 ArraySizeModifier sm, unsigned tq,
3021 SourceRange brackets)
3022 : ArrayType(VariableArray, et, can, sm, tq,
3023 et->containsUnexpandedParameterPack()),
3024 SizeExpr((Stmt*) e), Brackets(brackets) {}
3025
3026public:
3027 friend class StmtIteratorBase;
3028
3029 Expr *getSizeExpr() const {
3030 // We use C-style casts instead of cast<> here because we do not wish
3031 // to have a dependency of Type.h on Stmt.h/Expr.h.
3032 return (Expr*) SizeExpr;
3033 }
3034
3035 SourceRange getBracketsRange() const { return Brackets; }
3036 SourceLocation getLBracketLoc() const { return Brackets.getBegin(); }
3037 SourceLocation getRBracketLoc() const { return Brackets.getEnd(); }
3038
3039 bool isSugared() const { return false; }
3040 QualType desugar() const { return QualType(this, 0); }
3041
3042 static bool classof(const Type *T) {
3043 return T->getTypeClass() == VariableArray;
3044 }
3045
3046 void Profile(llvm::FoldingSetNodeID &ID) {
3047 llvm_unreachable("Cannot unique VariableArrayTypes.")::llvm::llvm_unreachable_internal("Cannot unique VariableArrayTypes."
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 3047)
;
3048 }
3049};
3050
3051/// Represents an array type in C++ whose size is a value-dependent expression.
3052///
3053/// For example:
3054/// \code
3055/// template<typename T, int Size>
3056/// class array {
3057/// T data[Size];
3058/// };
3059/// \endcode
3060///
3061/// For these types, we won't actually know what the array bound is
3062/// until template instantiation occurs, at which point this will
3063/// become either a ConstantArrayType or a VariableArrayType.
3064class DependentSizedArrayType : public ArrayType {
3065 friend class ASTContext; // ASTContext creates these.
3066
3067 const ASTContext &Context;
3068
3069 /// An assignment expression that will instantiate to the
3070 /// size of the array.
3071 ///
3072 /// The expression itself might be null, in which case the array
3073 /// type will have its size deduced from an initializer.
3074 Stmt *SizeExpr;
3075
3076 /// The range spanned by the left and right array brackets.
3077 SourceRange Brackets;
3078
3079 DependentSizedArrayType(const ASTContext &Context, QualType et, QualType can,
3080 Expr *e, ArraySizeModifier sm, unsigned tq,
3081 SourceRange brackets);
3082
3083public:
3084 friend class StmtIteratorBase;
3085
3086 Expr *getSizeExpr() const {
3087 // We use C-style casts instead of cast<> here because we do not wish
3088 // to have a dependency of Type.h on Stmt.h/Expr.h.
3089 return (Expr*) SizeExpr;
3090 }
3091
3092 SourceRange getBracketsRange() const { return Brackets; }
3093 SourceLocation getLBracketLoc() const { return Brackets.getBegin(); }
3094 SourceLocation getRBracketLoc() const { return Brackets.getEnd(); }
3095
3096 bool isSugared() const { return false; }
3097 QualType desugar() const { return QualType(this, 0); }
3098
3099 static bool classof(const Type *T) {
3100 return T->getTypeClass() == DependentSizedArray;
3101 }
3102
3103 void Profile(llvm::FoldingSetNodeID &ID) {
3104 Profile(ID, Context, getElementType(),
3105 getSizeModifier(), getIndexTypeCVRQualifiers(), getSizeExpr());
3106 }
3107
3108 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3109 QualType ET, ArraySizeModifier SizeMod,
3110 unsigned TypeQuals, Expr *E);
3111};
3112
3113/// Represents an extended address space qualifier where the input address space
3114/// value is dependent. Non-dependent address spaces are not represented with a
3115/// special Type subclass; they are stored on an ExtQuals node as part of a QualType.
3116///
3117/// For example:
3118/// \code
3119/// template<typename T, int AddrSpace>
3120/// class AddressSpace {
3121/// typedef T __attribute__((address_space(AddrSpace))) type;
3122/// }
3123/// \endcode
3124class DependentAddressSpaceType : public Type, public llvm::FoldingSetNode {
3125 friend class ASTContext;
3126
3127 const ASTContext &Context;
3128 Expr *AddrSpaceExpr;
3129 QualType PointeeType;
3130 SourceLocation loc;
3131
3132 DependentAddressSpaceType(const ASTContext &Context, QualType PointeeType,
3133 QualType can, Expr *AddrSpaceExpr,
3134 SourceLocation loc);
3135
3136public:
3137 Expr *getAddrSpaceExpr() const { return AddrSpaceExpr; }
3138 QualType getPointeeType() const { return PointeeType; }
3139 SourceLocation getAttributeLoc() const { return loc; }
3140
3141 bool isSugared() const { return false; }
3142 QualType desugar() const { return QualType(this, 0); }
3143
3144 static bool classof(const Type *T) {
3145 return T->getTypeClass() == DependentAddressSpace;
3146 }
3147
3148 void Profile(llvm::FoldingSetNodeID &ID) {
3149 Profile(ID, Context, getPointeeType(), getAddrSpaceExpr());
3150 }
3151
3152 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3153 QualType PointeeType, Expr *AddrSpaceExpr);
3154};
3155
3156/// Represents an extended vector type where either the type or size is
3157/// dependent.
3158///
3159/// For example:
3160/// \code
3161/// template<typename T, int Size>
3162/// class vector {
3163/// typedef T __attribute__((ext_vector_type(Size))) type;
3164/// }
3165/// \endcode
3166class DependentSizedExtVectorType : public Type, public llvm::FoldingSetNode {
3167 friend class ASTContext;
3168
3169 const ASTContext &Context;
3170 Expr *SizeExpr;
3171
3172 /// The element type of the array.
3173 QualType ElementType;
3174
3175 SourceLocation loc;
3176
3177 DependentSizedExtVectorType(const ASTContext &Context, QualType ElementType,
3178 QualType can, Expr *SizeExpr, SourceLocation loc);
3179
3180public:
3181 Expr *getSizeExpr() const { return SizeExpr; }
3182 QualType getElementType() const { return ElementType; }
3183 SourceLocation getAttributeLoc() const { return loc; }
3184
3185 bool isSugared() const { return false; }
3186 QualType desugar() const { return QualType(this, 0); }
3187
3188 static bool classof(const Type *T) {
3189 return T->getTypeClass() == DependentSizedExtVector;
3190 }
3191
3192 void Profile(llvm::FoldingSetNodeID &ID) {
3193 Profile(ID, Context, getElementType(), getSizeExpr());
3194 }
3195
3196 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3197 QualType ElementType, Expr *SizeExpr);
3198};
3199
3200
3201/// Represents a GCC generic vector type. This type is created using
3202/// __attribute__((vector_size(n)), where "n" specifies the vector size in
3203/// bytes; or from an Altivec __vector or vector declaration.
3204/// Since the constructor takes the number of vector elements, the
3205/// client is responsible for converting the size into the number of elements.
3206class VectorType : public Type, public llvm::FoldingSetNode {
3207public:
3208 enum VectorKind {
3209 /// not a target-specific vector type
3210 GenericVector,
3211
3212 /// is AltiVec vector
3213 AltiVecVector,
3214
3215 /// is AltiVec 'vector Pixel'
3216 AltiVecPixel,
3217
3218 /// is AltiVec 'vector bool ...'
3219 AltiVecBool,
3220
3221 /// is ARM Neon vector
3222 NeonVector,
3223
3224 /// is ARM Neon polynomial vector
3225 NeonPolyVector
3226 };
3227
3228protected:
3229 friend class ASTContext; // ASTContext creates these.
3230
3231 /// The element type of the vector.
3232 QualType ElementType;
3233
3234 VectorType(QualType vecType, unsigned nElements, QualType canonType,
3235 VectorKind vecKind);
3236
3237 VectorType(TypeClass tc, QualType vecType, unsigned nElements,
3238 QualType canonType, VectorKind vecKind);
3239
3240public:
3241 QualType getElementType() const { return ElementType; }
3242 unsigned getNumElements() const { return VectorTypeBits.NumElements; }
3243
3244 static bool isVectorSizeTooLarge(unsigned NumElements) {
3245 return NumElements > VectorTypeBitfields::MaxNumElements;
3246 }
3247
3248 bool isSugared() const { return false; }
3249 QualType desugar() const { return QualType(this, 0); }
3250
3251 VectorKind getVectorKind() const {
3252 return VectorKind(VectorTypeBits.VecKind);
3253 }
3254
3255 void Profile(llvm::FoldingSetNodeID &ID) {
3256 Profile(ID, getElementType(), getNumElements(),
3257 getTypeClass(), getVectorKind());
3258 }
3259
3260 static void Profile(llvm::FoldingSetNodeID &ID, QualType ElementType,
3261 unsigned NumElements, TypeClass TypeClass,
3262 VectorKind VecKind) {
3263 ID.AddPointer(ElementType.getAsOpaquePtr());
3264 ID.AddInteger(NumElements);
3265 ID.AddInteger(TypeClass);
3266 ID.AddInteger(VecKind);
3267 }
3268
3269 static bool classof(const Type *T) {
3270 return T->getTypeClass() == Vector || T->getTypeClass() == ExtVector;
3271 }
3272};
3273
3274/// Represents a vector type where either the type or size is dependent.
3275////
3276/// For example:
3277/// \code
3278/// template<typename T, int Size>
3279/// class vector {
3280/// typedef T __attribute__((vector_size(Size))) type;
3281/// }
3282/// \endcode
3283class DependentVectorType : public Type, public llvm::FoldingSetNode {
3284 friend class ASTContext;
3285
3286 const ASTContext &Context;
3287 QualType ElementType;
3288 Expr *SizeExpr;
3289 SourceLocation Loc;
3290
3291 DependentVectorType(const ASTContext &Context, QualType ElementType,
3292 QualType CanonType, Expr *SizeExpr,
3293 SourceLocation Loc, VectorType::VectorKind vecKind);
3294
3295public:
3296 Expr *getSizeExpr() const { return SizeExpr; }
3297 QualType getElementType() const { return ElementType; }
3298 SourceLocation getAttributeLoc() const { return Loc; }
3299 VectorType::VectorKind getVectorKind() const {
3300 return VectorType::VectorKind(VectorTypeBits.VecKind);
3301 }
3302
3303 bool isSugared() const { return false; }
3304 QualType desugar() const { return QualType(this, 0); }
3305
3306 static bool classof(const Type *T) {
3307 return T->getTypeClass() == DependentVector;
3308 }
3309
3310 void Profile(llvm::FoldingSetNodeID &ID) {
3311 Profile(ID, Context, getElementType(), getSizeExpr(), getVectorKind());
3312 }
3313
3314 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
3315 QualType ElementType, const Expr *SizeExpr,
3316 VectorType::VectorKind VecKind);
3317};
3318
3319/// ExtVectorType - Extended vector type. This type is created using
3320/// __attribute__((ext_vector_type(n)), where "n" is the number of elements.
3321/// Unlike vector_size, ext_vector_type is only allowed on typedef's. This
3322/// class enables syntactic extensions, like Vector Components for accessing
3323/// points (as .xyzw), colors (as .rgba), and textures (modeled after OpenGL
3324/// Shading Language).
3325class ExtVectorType : public VectorType {
3326 friend class ASTContext; // ASTContext creates these.
3327
3328 ExtVectorType(QualType vecType, unsigned nElements, QualType canonType)
3329 : VectorType(ExtVector, vecType, nElements, canonType, GenericVector) {}
3330
3331public:
3332 static int getPointAccessorIdx(char c) {
3333 switch (c) {
3334 default: return -1;
3335 case 'x': case 'r': return 0;
3336 case 'y': case 'g': return 1;
3337 case 'z': case 'b': return 2;
3338 case 'w': case 'a': return 3;
3339 }
3340 }
3341
3342 static int getNumericAccessorIdx(char c) {
3343 switch (c) {
3344 default: return -1;
3345 case '0': return 0;
3346 case '1': return 1;
3347 case '2': return 2;
3348 case '3': return 3;
3349 case '4': return 4;
3350 case '5': return 5;
3351 case '6': return 6;
3352 case '7': return 7;
3353 case '8': return 8;
3354 case '9': return 9;
3355 case 'A':
3356 case 'a': return 10;
3357 case 'B':
3358 case 'b': return 11;
3359 case 'C':
3360 case 'c': return 12;
3361 case 'D':
3362 case 'd': return 13;
3363 case 'E':
3364 case 'e': return 14;
3365 case 'F':
3366 case 'f': return 15;
3367 }
3368 }
3369
3370 static int getAccessorIdx(char c, bool isNumericAccessor) {
3371 if (isNumericAccessor)
3372 return getNumericAccessorIdx(c);
3373 else
3374 return getPointAccessorIdx(c);
3375 }
3376
3377 bool isAccessorWithinNumElements(char c, bool isNumericAccessor) const {
3378 if (int idx = getAccessorIdx(c, isNumericAccessor)+1)
3379 return unsigned(idx-1) < getNumElements();
3380 return false;
3381 }
3382
3383 bool isSugared() const { return false; }
3384 QualType desugar() const { return QualType(this, 0); }
3385
3386 static bool classof(const Type *T) {
3387 return T->getTypeClass() == ExtVector;
3388 }
3389};
3390
3391/// FunctionType - C99 6.7.5.3 - Function Declarators. This is the common base
3392/// class of FunctionNoProtoType and FunctionProtoType.
3393class FunctionType : public Type {
3394 // The type returned by the function.
3395 QualType ResultType;
3396
3397public:
3398 /// Interesting information about a specific parameter that can't simply
3399 /// be reflected in parameter's type. This is only used by FunctionProtoType
3400 /// but is in FunctionType to make this class available during the
3401 /// specification of the bases of FunctionProtoType.
3402 ///
3403 /// It makes sense to model language features this way when there's some
3404 /// sort of parameter-specific override (such as an attribute) that
3405 /// affects how the function is called. For example, the ARC ns_consumed
3406 /// attribute changes whether a parameter is passed at +0 (the default)
3407 /// or +1 (ns_consumed). This must be reflected in the function type,
3408 /// but isn't really a change to the parameter type.
3409 ///
3410 /// One serious disadvantage of modelling language features this way is
3411 /// that they generally do not work with language features that attempt
3412 /// to destructure types. For example, template argument deduction will
3413 /// not be able to match a parameter declared as
3414 /// T (*)(U)
3415 /// against an argument of type
3416 /// void (*)(__attribute__((ns_consumed)) id)
3417 /// because the substitution of T=void, U=id into the former will
3418 /// not produce the latter.
3419 class ExtParameterInfo {
3420 enum {
3421 ABIMask = 0x0F,
3422 IsConsumed = 0x10,
3423 HasPassObjSize = 0x20,
3424 IsNoEscape = 0x40,
3425 };
3426 unsigned char Data = 0;
3427
3428 public:
3429 ExtParameterInfo() = default;
3430
3431 /// Return the ABI treatment of this parameter.
3432 ParameterABI getABI() const { return ParameterABI(Data & ABIMask); }
3433 ExtParameterInfo withABI(ParameterABI kind) const {
3434 ExtParameterInfo copy = *this;
3435 copy.Data = (copy.Data & ~ABIMask) | unsigned(kind);
3436 return copy;
3437 }
3438
3439 /// Is this parameter considered "consumed" by Objective-C ARC?
3440 /// Consumed parameters must have retainable object type.
3441 bool isConsumed() const { return (Data & IsConsumed); }
3442 ExtParameterInfo withIsConsumed(bool consumed) const {
3443 ExtParameterInfo copy = *this;
3444 if (consumed)
3445 copy.Data |= IsConsumed;
3446 else
3447 copy.Data &= ~IsConsumed;
3448 return copy;
3449 }
3450
3451 bool hasPassObjectSize() const { return Data & HasPassObjSize; }
3452 ExtParameterInfo withHasPassObjectSize() const {
3453 ExtParameterInfo Copy = *this;
3454 Copy.Data |= HasPassObjSize;
3455 return Copy;
3456 }
3457
3458 bool isNoEscape() const { return Data & IsNoEscape; }
3459 ExtParameterInfo withIsNoEscape(bool NoEscape) const {
3460 ExtParameterInfo Copy = *this;
3461 if (NoEscape)
3462 Copy.Data |= IsNoEscape;
3463 else
3464 Copy.Data &= ~IsNoEscape;
3465 return Copy;
3466 }
3467
3468 unsigned char getOpaqueValue() const { return Data; }
3469 static ExtParameterInfo getFromOpaqueValue(unsigned char data) {
3470 ExtParameterInfo result;
3471 result.Data = data;
3472 return result;
3473 }
3474
3475 friend bool operator==(ExtParameterInfo lhs, ExtParameterInfo rhs) {
3476 return lhs.Data == rhs.Data;
3477 }
3478
3479 friend bool operator!=(ExtParameterInfo lhs, ExtParameterInfo rhs) {
3480 return lhs.Data != rhs.Data;
3481 }
3482 };
3483
3484 /// A class which abstracts out some details necessary for
3485 /// making a call.
3486 ///
3487 /// It is not actually used directly for storing this information in
3488 /// a FunctionType, although FunctionType does currently use the
3489 /// same bit-pattern.
3490 ///
3491 // If you add a field (say Foo), other than the obvious places (both,
3492 // constructors, compile failures), what you need to update is
3493 // * Operator==
3494 // * getFoo
3495 // * withFoo
3496 // * functionType. Add Foo, getFoo.
3497 // * ASTContext::getFooType
3498 // * ASTContext::mergeFunctionTypes
3499 // * FunctionNoProtoType::Profile
3500 // * FunctionProtoType::Profile
3501 // * TypePrinter::PrintFunctionProto
3502 // * AST read and write
3503 // * Codegen
3504 class ExtInfo {
3505 friend class FunctionType;
3506
3507 // Feel free to rearrange or add bits, but if you go over 12,
3508 // you'll need to adjust both the Bits field below and
3509 // Type::FunctionTypeBitfields.
3510
3511 // | CC |noreturn|produces|nocallersavedregs|regparm|nocfcheck|
3512 // |0 .. 4| 5 | 6 | 7 |8 .. 10| 11 |
3513 //
3514 // regparm is either 0 (no regparm attribute) or the regparm value+1.
3515 enum { CallConvMask = 0x1F };
3516 enum { NoReturnMask = 0x20 };
3517 enum { ProducesResultMask = 0x40 };
3518 enum { NoCallerSavedRegsMask = 0x80 };
3519 enum { NoCfCheckMask = 0x800 };
3520 enum {
3521 RegParmMask = ~(CallConvMask | NoReturnMask | ProducesResultMask |
3522 NoCallerSavedRegsMask | NoCfCheckMask),
3523 RegParmOffset = 8
3524 }; // Assumed to be the last field
3525 uint16_t Bits = CC_C;
3526
3527 ExtInfo(unsigned Bits) : Bits(static_cast<uint16_t>(Bits)) {}
3528
3529 public:
3530 // Constructor with no defaults. Use this when you know that you
3531 // have all the elements (when reading an AST file for example).
3532 ExtInfo(bool noReturn, bool hasRegParm, unsigned regParm, CallingConv cc,
3533 bool producesResult, bool noCallerSavedRegs, bool NoCfCheck) {
3534 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 3534, __PRETTY_FUNCTION__))
;
3535 Bits = ((unsigned)cc) | (noReturn ? NoReturnMask : 0) |
3536 (producesResult ? ProducesResultMask : 0) |
3537 (noCallerSavedRegs ? NoCallerSavedRegsMask : 0) |
3538 (hasRegParm ? ((regParm + 1) << RegParmOffset) : 0) |
3539 (NoCfCheck ? NoCfCheckMask : 0);
3540 }
3541
3542 // Constructor with all defaults. Use when for example creating a
3543 // function known to use defaults.
3544 ExtInfo() = default;
3545
3546 // Constructor with just the calling convention, which is an important part
3547 // of the canonical type.
3548 ExtInfo(CallingConv CC) : Bits(CC) {}
3549
3550 bool getNoReturn() const { return Bits & NoReturnMask; }
3551 bool getProducesResult() const { return Bits & ProducesResultMask; }
3552 bool getNoCallerSavedRegs() const { return Bits & NoCallerSavedRegsMask; }
3553 bool getNoCfCheck() const { return Bits & NoCfCheckMask; }
3554 bool getHasRegParm() const { return (Bits >> RegParmOffset) != 0; }
3555
3556 unsigned getRegParm() const {
3557 unsigned RegParm = (Bits & RegParmMask) >> RegParmOffset;
3558 if (RegParm > 0)
3559 --RegParm;
3560 return RegParm;
3561 }
3562
3563 CallingConv getCC() const { return CallingConv(Bits & CallConvMask); }
3564
3565 bool operator==(ExtInfo Other) const {
3566 return Bits == Other.Bits;
3567 }
3568 bool operator!=(ExtInfo Other) const {
3569 return Bits != Other.Bits;
3570 }
3571
3572 // Note that we don't have setters. That is by design, use
3573 // the following with methods instead of mutating these objects.
3574
3575 ExtInfo withNoReturn(bool noReturn) const {
3576 if (noReturn)
3577 return ExtInfo(Bits | NoReturnMask);
3578 else
3579 return ExtInfo(Bits & ~NoReturnMask);
3580 }
3581
3582 ExtInfo withProducesResult(bool producesResult) const {
3583 if (producesResult)
3584 return ExtInfo(Bits | ProducesResultMask);
3585 else
3586 return ExtInfo(Bits & ~ProducesResultMask);
3587 }
3588
3589 ExtInfo withNoCallerSavedRegs(bool noCallerSavedRegs) const {
3590 if (noCallerSavedRegs)
3591 return ExtInfo(Bits | NoCallerSavedRegsMask);
3592 else
3593 return ExtInfo(Bits & ~NoCallerSavedRegsMask);
3594 }
3595
3596 ExtInfo withNoCfCheck(bool noCfCheck) const {
3597 if (noCfCheck)
3598 return ExtInfo(Bits | NoCfCheckMask);
3599 else
3600 return ExtInfo(Bits & ~NoCfCheckMask);
3601 }
3602
3603 ExtInfo withRegParm(unsigned RegParm) const {
3604 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~svn373517/tools/clang/include/clang/AST/Type.h"
, 3604, __PRETTY_FUNCTION__))
;
3605 return ExtInfo((Bits & ~RegParmMask) |
3606 ((RegParm + 1) << RegParmOffset));
3607 }
3608
3609 ExtInfo withCallingConv(CallingConv cc) const {
3610 return ExtInfo((Bits & ~CallConvMask) | (unsigned) cc);
3611 }
3612
3613 void Profile(llvm::FoldingSetNodeID &ID) const {
3614 ID.AddInteger(Bits);
3615 }
3616 };
3617
3618 /// A simple holder for a QualType representing a type in an
3619 /// exception specification. Unfortunately needed by FunctionProtoType
3620 /// because TrailingObjects cannot handle repeated types.
3621 struct ExceptionType { QualType Type; };
3622
3623 /// A simple holder for various uncommon bits which do not fit in
3624 /// FunctionTypeBitfields. Aligned to alignof(void *) to maintain the
3625 /// alignment of subsequent objects in TrailingObjects. You must update
3626 /// hasExtraBitfields in FunctionProtoType after adding extra data here.
3627 struct alignas(void *) FunctionTypeExtraBitfields {
3628 /// The number of types in the exception specification.
3629 /// A whole unsigned is not needed here and according to
3630 /// [implimits] 8 bits would be enough here.
3631 unsigned NumExceptionType;
3632 };
3633
3634protected:
3635 FunctionType(TypeClass tc, QualType res,
3636 QualType Canonical, bool Dependent,
3637 bool InstantiationDependent,
3638 bool VariablyModified, bool ContainsUnexpandedParameterPack,
3639 ExtInfo Info)
3640 : Type(tc, Canonical, Dependent, InstantiationDependent, VariablyModified,
3641 ContainsUnexpandedParameterPack),
3642 ResultType(res) {
3643 FunctionTypeBits.ExtInfo = Info.Bits;
3644 }
3645
3646 Qualifiers getFastTypeQuals() const {
3647 return Qualifiers::fromFastMask(FunctionTypeBits.FastTypeQuals);
3648 }
3649
3650public:
3651 QualType getReturnType() const { return ResultType; }
3652
3653 bool getHasRegParm() const { return getExtInfo().getHasRegParm(); }
3654 unsigned getRegParmType() const { return getExtInfo().getRegParm(); }
3655
3656 /// Determine whether this function type includes the GNU noreturn
3657 /// attribute. The C++11 [[noreturn]] attribute does not affect the function
3658 /// type.
3659 bool getNoReturnAttr() const { return getExtInfo().getNoReturn(); }
3660
3661 CallingConv getCallConv() const { return getExtInfo().getCC(); }
3662 ExtInfo getExtInfo() const { return ExtInfo(FunctionTypeBits.ExtInfo); }
3663
3664 static_assert((~Qualifiers::FastMask & Qualifiers::CVRMask) == 0,
3665 "Const, volatile and restrict are assumed to be a subset of "
3666 "the fast qualifiers.");
3667
3668 bool isConst() const { return getFastTypeQuals().hasConst(); }
3669 bool isVolatile() const { return getFastTypeQuals().hasVolatile(); }
3670 bool isRestrict() const { return getFastTypeQuals().hasRestrict(); }
3671
3672 /// Determine the type of an expression that calls a function of
3673 /// this type.
3674 QualType getCallResultType(const ASTContext &Context) const {
3675 return getReturnType().getNonLValueExprType(Context);
3676 }
3677
3678 static StringRef getNameForCallConv(CallingConv CC);
3679
3680 static bool classof(const Type *T) {
3681 return T->getTypeClass() == FunctionNoProto ||
3682 T->getTypeClass() == FunctionProto;
3683 }
3684};
3685
3686/// Represents a K&R-style 'int foo()' function, which has
3687/// no information available about its arguments.
3688class FunctionNoProtoType : public FunctionType, public llvm::FoldingSetNode {
3689 friend class ASTContext; // ASTContext creates these.
3690
3691 FunctionNoProtoType(QualType Result, QualType Canonical, ExtInfo Info)
3692 : FunctionType(FunctionNoProto, Result, Canonical,
3693 /*Dependent=*/false, /*InstantiationDependent=*/false,
3694 Result->isVariablyModifiedType(),
3695 /*ContainsUnexpandedParameterPack=*/false, Info) {}
3696
3697public:
3698 // No additional state past what FunctionType provides.
3699
3700 bool isSugared() const { return false; }
3701 QualType desugar() const { return QualType(this, 0); }
3702
3703 void Profile(llvm::FoldingSetNodeID &ID) {
3704 Profile(ID, getReturnType(), getExtInfo());
3705 }
3706
3707 static void Profile(llvm::FoldingSetNodeID &ID, QualType ResultType,
3708 ExtInfo Info) {
3709 Info.Profile(ID);
3710 ID.AddPointer(ResultType.getAsOpaquePtr());
3711 }
3712
3713 static bool classof(const Type *T) {
3714 return T->getTypeClass() == FunctionNoProto;
3715 }
3716};
3717
3718/// Represents a prototype with parameter type info, e.g.
3719/// 'int foo(int)' or 'int foo(void)'. 'void' is represented as having no
3720/// parameters, not as having a single void parameter. Such a type can have
3721/// an exception specification, but this specification is not part of the
3722/// canonical type. FunctionProtoType has several trailing objects, some of
3723/// which optional. For more information about the trailing objects see
3724/// the first comment inside FunctionProtoType.
3725class FunctionProtoType final
3726 : public FunctionType,
3727 public llvm::FoldingSetNode,
3728 private llvm::TrailingObjects<
3729 FunctionProtoType, QualType, FunctionType::FunctionTypeExtraBitfields,
3730 FunctionType::ExceptionType, Expr *, FunctionDecl *,
3731 FunctionType::ExtParameterInfo, Qualifiers> {
3732 friend class ASTContext; // ASTContext creates these.
3733 friend TrailingObjects;
3734
3735 // FunctionProtoType is followed by several trailing objects, some of
3736 // which optional. They are in order:
3737 //
3738 // * An array of getNumParams() QualType holding the parameter types.
3739 // Always present. Note that for the vast majority of FunctionProtoType,
3740 // these will be the only trailing objects.
3741 //
3742 // * Optionally if some extra data is stored in FunctionTypeExtraBitfields
3743 // (see FunctionTypeExtraBitfields and FunctionTypeBitfields):
3744 // a single FunctionTypeExtraBitfields. Present if and only if
3745 // hasExtraBitfields() is true.
3746 //
3747 // * Optionally exactly one of:
3748 // * an array of getNumExceptions() ExceptionType,
3749 // * a single Expr *,
3750 // * a pair of FunctionDecl *,
3751 // * a single FunctionDecl *
3752 // used to store information about the various types of exception
3753 // specification. See getExceptionSpecSize for the details.
3754 //
3755 // * Optionally an array of getNumParams() ExtParameterInfo holding
3756 // an ExtParameterInfo for each of the parameters. Present if and
3757 // only if hasExtParameterInfos() is true.
3758 //
3759 // * Optionally a Qualifiers object to represent extra qualifiers that can't
3760 // be represented by FunctionTypeBitfields.FastTypeQuals. Present if and only
3761 // if hasExtQualifiers() is true.
3762 //
3763 // The optional FunctionTypeExtraBitfields has to be before the data
3764 // related to the exception specification since it contains the number
3765 // of exception types.
3766 //
3767 // We put the ExtParameterInfos last. If all were equal, it would make
3768 // more sense to put these before the exception specification, because
3769 // it's much easier to skip past them compared to the elaborate switch
3770 // required to skip the exception specification. However, all is not
3771 // equal; ExtParameterInfos are used to model very uncommon features,
3772 // and it's better not to burden the more common paths.
3773
3774public:
3775 /// Holds information about the various types of exception specification.
3776 /// ExceptionSpecInfo is not stored as such in FunctionProtoType but is
3777 /// used to group together the various bits of information about the
3778 /// exception specification.
3779 struct ExceptionSpecInfo {
3780 /// The kind of exception specification this is.
3781 ExceptionSpecificationType Type = EST_None;
3782
3783 /// Explicitly-specified list of exception types.
3784 ArrayRef<QualType> Exceptions;
3785
3786 /// Noexcept expression, if this is a computed noexcept specification.
3787 Expr *NoexceptExpr = nullptr;
3788
3789 /// The function whose exception specification this is, for
3790 /// EST_Unevaluated and EST_Uninstantiated.
3791 FunctionDecl *SourceDecl = nullptr;
3792
3793 /// The function template whose exception specification this is instantiated
3794 /// from, for EST_Uninstantiated.
3795 FunctionDecl *SourceTemplate = nullptr;
3796
3797 ExceptionSpecInfo() = default;
3798
3799 ExceptionSpecInfo(ExceptionSpecificationType EST) : Type(EST) {}
3800 };
3801
3802 /// Extra information about a function prototype. ExtProtoInfo is not
3803 /// stored as such in FunctionProtoType but is used to group together
3804 /// the various bits of extra information about a function prototype.
3805 struct ExtProtoInfo {
3806 FunctionType::ExtInfo ExtInfo;
3807 bool Variadic : 1;
3808 bool HasTrailingReturn : 1;
3809 Qualifiers TypeQuals;
3810 RefQualifierKind RefQualifier = RQ_None;
3811 ExceptionSpecInfo ExceptionSpec;
3812 const ExtParameterInfo *ExtParameterInfos = nullptr;
3813
3814 ExtProtoInfo() : Variadic(false), HasTrailingReturn(false) {}
3815
3816 ExtProtoInfo(CallingConv CC)
3817 : ExtInfo(CC), Variadic(false), HasTrailingReturn(false) {}
3818
3819 ExtProtoInfo withExceptionSpec(const ExceptionSpecInfo &ESI) {
3820 ExtProtoInfo Result(*this);
3821 Result.ExceptionSpec = ESI;
3822 return Result;
3823 }
3824 };
3825
3826private:
3827 unsigned numTrailingObjects(OverloadToken<QualType>) const {
3828 return getNumParams();
3829 }
3830
3831 unsigned numTrailingObjects(OverloadToken<FunctionTypeExtraBitfields>) const {
3832 return hasExtraBitfields();
3833 }
3834
3835 unsigned numTrailingObjects(OverloadToken<ExceptionType>) const {
3836 return getExceptionSpecSize().NumExceptionType;
3837 }
3838
3839 unsigned numTrailingObjects(OverloadToken<Expr *>) const {
3840 return getExceptionSpecSize().NumExprPtr;
3841 }
3842
3843 unsigned numTrailingObjects(OverloadToken<FunctionDecl *>) const {
3844 return getExceptionSpecSize().NumFunctionDeclPtr;
3845 }
3846
3847 unsigned numTrailingObjects(OverloadToken<ExtParameterInfo>) const {
3848 return hasExtParameterInfos() ? getNumParams() : 0;
3849 }
3850
3851 /// Determine whether there are any argument types that
3852 /// contain an unexpanded parameter pack.
3853 static bool containsAnyUnexpandedParameterPack(const QualType *ArgArray,
3854 unsigned numArgs) {
3855 for (unsigned Idx = 0; Idx < numArgs; ++Idx)
3856 if (ArgArray[Idx]->containsUnexpandedParameterPack())
3857 return true;
3858
3859 return false;
3860 }
3861
3862 FunctionProtoType(QualType result, ArrayRef<QualType> params,
3863 QualType canonical, const ExtProtoInfo &epi);
3864
3865 /// This struct is returned by getExceptionSpecSize and is used to
3866 /// translate an ExceptionSpecificationType to the number and kind
3867 /// of trailing objects related to the exception specification.
3868 struct ExceptionSpecSizeHolder {
3869 unsigned NumExceptionType;
3870 unsigned NumExprPtr;
3871 unsigned NumFunctionDeclPtr;
3872 };
3873
3874 /// Return the number and kind of trailing objects
3875 /// related to the exception specification.
3876 static ExceptionSpecSizeHolder
3877 getExceptionSpecSize(ExceptionSpecificationType EST, unsigned NumExceptions) {
3878 switch (EST) {
3879 case EST_None:
3880 case EST_DynamicNone:
3881 case EST_MSAny:
3882 case EST_BasicNoexcept:
3883 case EST_Unparsed:
3884 case EST_NoThrow:
3885 return {0, 0, 0};
3886
3887 case EST_Dynamic:
3888 return {NumExceptions, 0, 0};
3889
3890 case EST_DependentNoexcept:
3891 case EST_NoexceptFalse:
3892 case EST_NoexceptTrue:
3893 return {0, 1, 0};
3894
3895 case EST_Uninstantiated:
3896 return {0, 0, 2};
3897
3898 case EST_Unevaluated:
3899 return {0, 0, 1};
3900 }
3901 llvm_unreachable("bad exception specification kind")::llvm::llvm_unreachable_internal("bad exception specification kind"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 3901)
;
3902 }
3903
3904 /// Return the number and kind of trailing objects
3905 /// related to the exception specification.
3906 ExceptionSpecSizeHolder getExceptionSpecSize() const {
3907 return getExceptionSpecSize(getExceptionSpecType(), getNumExceptions());
3908 }
3909
3910 /// Whether the trailing FunctionTypeExtraBitfields is present.
3911 static bool hasExtraBitfields(ExceptionSpecificationType EST) {
3912 // If the exception spec type is EST_Dynamic then we have > 0 exception
3913 // types and the exact number is stored in FunctionTypeExtraBitfields.
3914 return EST == EST_Dynamic;
3915 }
3916
3917 /// Whether the trailing FunctionTypeExtraBitfields is present.
3918 bool hasExtraBitfields() const {
3919 return hasExtraBitfields(getExceptionSpecType());
3920 }
3921
3922 bool hasExtQualifiers() const {
3923 return FunctionTypeBits.HasExtQuals;
3924 }
3925
3926public:
3927 unsigned getNumParams() const { return FunctionTypeBits.NumParams; }
3928
3929 QualType getParamType(unsigned i) const {
3930 assert(i < getNumParams() && "invalid parameter index")((i < getNumParams() && "invalid parameter index")
? static_cast<void> (0) : __assert_fail ("i < getNumParams() && \"invalid parameter index\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 3930, __PRETTY_FUNCTION__))
;
3931 return param_type_begin()[i];
3932 }
3933
3934 ArrayRef<QualType> getParamTypes() const {
3935 return llvm::makeArrayRef(param_type_begin(), param_type_end());
3936 }
3937
3938 ExtProtoInfo getExtProtoInfo() const {
3939 ExtProtoInfo EPI;
3940 EPI.ExtInfo = getExtInfo();
3941 EPI.Variadic = isVariadic();
3942 EPI.HasTrailingReturn = hasTrailingReturn();
3943 EPI.ExceptionSpec.Type = getExceptionSpecType();
3944 EPI.TypeQuals = getMethodQuals();
3945 EPI.RefQualifier = getRefQualifier();
3946 if (EPI.ExceptionSpec.Type == EST_Dynamic) {
3947 EPI.ExceptionSpec.Exceptions = exceptions();
3948 } else if (isComputedNoexcept(EPI.ExceptionSpec.Type)) {
3949 EPI.ExceptionSpec.NoexceptExpr = getNoexceptExpr();
3950 } else if (EPI.ExceptionSpec.Type == EST_Uninstantiated) {
3951 EPI.ExceptionSpec.SourceDecl = getExceptionSpecDecl();
3952 EPI.ExceptionSpec.SourceTemplate = getExceptionSpecTemplate();
3953 } else if (EPI.ExceptionSpec.Type == EST_Unevaluated) {
3954 EPI.ExceptionSpec.SourceDecl = getExceptionSpecDecl();
3955 }
3956 EPI.ExtParameterInfos = getExtParameterInfosOrNull();
3957 return EPI;
3958 }
3959
3960 /// Get the kind of exception specification on this function.
3961 ExceptionSpecificationType getExceptionSpecType() const {
3962 return static_cast<ExceptionSpecificationType>(
3963 FunctionTypeBits.ExceptionSpecType);
3964 }
3965
3966 /// Return whether this function has any kind of exception spec.
3967 bool hasExceptionSpec() const { return getExceptionSpecType() != EST_None; }
3968
3969 /// Return whether this function has a dynamic (throw) exception spec.
3970 bool hasDynamicExceptionSpec() const {
3971 return isDynamicExceptionSpec(getExceptionSpecType());
3972 }
3973
3974 /// Return whether this function has a noexcept exception spec.
3975 bool hasNoexceptExceptionSpec() const {
3976 return isNoexceptExceptionSpec(getExceptionSpecType());
3977 }
3978
3979 /// Return whether this function has a dependent exception spec.
3980 bool hasDependentExceptionSpec() const;
3981
3982 /// Return whether this function has an instantiation-dependent exception
3983 /// spec.
3984 bool hasInstantiationDependentExceptionSpec() const;
3985
3986 /// Return the number of types in the exception specification.
3987 unsigned getNumExceptions() const {
3988 return getExceptionSpecType() == EST_Dynamic
3989 ? getTrailingObjects<FunctionTypeExtraBitfields>()
3990 ->NumExceptionType
3991 : 0;
3992 }
3993
3994 /// Return the ith exception type, where 0 <= i < getNumExceptions().
3995 QualType getExceptionType(unsigned i) const {
3996 assert(i < getNumExceptions() && "Invalid exception number!")((i < getNumExceptions() && "Invalid exception number!"
) ? static_cast<void> (0) : __assert_fail ("i < getNumExceptions() && \"Invalid exception number!\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 3996, __PRETTY_FUNCTION__))
;
3997 return exception_begin()[i];
3998 }
3999
4000 /// Return the expression inside noexcept(expression), or a null pointer
4001 /// if there is none (because the exception spec is not of this form).
4002 Expr *getNoexceptExpr() const {
4003 if (!isComputedNoexcept(getExceptionSpecType()))
4004 return nullptr;
4005 return *getTrailingObjects<Expr *>();
4006 }
4007
4008 /// If this function type has an exception specification which hasn't
4009 /// been determined yet (either because it has not been evaluated or because
4010 /// it has not been instantiated), this is the function whose exception
4011 /// specification is represented by this type.
4012 FunctionDecl *getExceptionSpecDecl() const {
4013 if (getExceptionSpecType() != EST_Uninstantiated &&
4014 getExceptionSpecType() != EST_Unevaluated)
4015 return nullptr;
4016 return getTrailingObjects<FunctionDecl *>()[0];
4017 }
4018
4019 /// If this function type has an uninstantiated exception
4020 /// specification, this is the function whose exception specification
4021 /// should be instantiated to find the exception specification for
4022 /// this type.
4023 FunctionDecl *getExceptionSpecTemplate() const {
4024 if (getExceptionSpecType() != EST_Uninstantiated)
4025 return nullptr;
4026 return getTrailingObjects<FunctionDecl *>()[1];
4027 }
4028
4029 /// Determine whether this function type has a non-throwing exception
4030 /// specification.
4031 CanThrowResult canThrow() const;
4032
4033 /// Determine whether this function type has a non-throwing exception
4034 /// specification. If this depends on template arguments, returns
4035 /// \c ResultIfDependent.
4036 bool isNothrow(bool ResultIfDependent = false) const {
4037 return ResultIfDependent ? canThrow() != CT_Can : canThrow() == CT_Cannot;
4038 }
4039
4040 /// Whether this function prototype is variadic.
4041 bool isVariadic() const { return FunctionTypeBits.Variadic; }
4042
4043 /// Determines whether this function prototype contains a
4044 /// parameter pack at the end.
4045 ///
4046 /// A function template whose last parameter is a parameter pack can be
4047 /// called with an arbitrary number of arguments, much like a variadic
4048 /// function.
4049 bool isTemplateVariadic() const;
4050
4051 /// Whether this function prototype has a trailing return type.
4052 bool hasTrailingReturn() const { return FunctionTypeBits.HasTrailingReturn; }
4053
4054 Qualifiers getMethodQuals() const {
4055 if (hasExtQualifiers())
4056 return *getTrailingObjects<Qualifiers>();
4057 else
4058 return getFastTypeQuals();
4059 }
4060
4061 /// Retrieve the ref-qualifier associated with this function type.
4062 RefQualifierKind getRefQualifier() const {
4063 return static_cast<RefQualifierKind>(FunctionTypeBits.RefQualifier);
4064 }
4065
4066 using param_type_iterator = const QualType *;
4067 using param_type_range = llvm::iterator_range<param_type_iterator>;
4068
4069 param_type_range param_types() const {
4070 return param_type_range(param_type_begin(), param_type_end());
4071 }
4072
4073 param_type_iterator param_type_begin() const {
4074 return getTrailingObjects<QualType>();
4075 }
4076
4077 param_type_iterator param_type_end() const {
4078 return param_type_begin() + getNumParams();
4079 }
4080
4081 using exception_iterator = const QualType *;
4082
4083 ArrayRef<QualType> exceptions() const {
4084 return llvm::makeArrayRef(exception_begin(), exception_end());
4085 }
4086
4087 exception_iterator exception_begin() const {
4088 return reinterpret_cast<exception_iterator>(
4089 getTrailingObjects<ExceptionType>());
4090 }
4091
4092 exception_iterator exception_end() const {
4093 return exception_begin() + getNumExceptions();
4094 }
4095
4096 /// Is there any interesting extra information for any of the parameters
4097 /// of this function type?
4098 bool hasExtParameterInfos() const {
4099 return FunctionTypeBits.HasExtParameterInfos;
4100 }
4101
4102 ArrayRef<ExtParameterInfo> getExtParameterInfos() const {
4103 assert(hasExtParameterInfos())((hasExtParameterInfos()) ? static_cast<void> (0) : __assert_fail
("hasExtParameterInfos()", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4103, __PRETTY_FUNCTION__))
;
4104 return ArrayRef<ExtParameterInfo>(getTrailingObjects<ExtParameterInfo>(),
4105 getNumParams());
4106 }
4107
4108 /// Return a pointer to the beginning of the array of extra parameter
4109 /// information, if present, or else null if none of the parameters
4110 /// carry it. This is equivalent to getExtProtoInfo().ExtParameterInfos.
4111 const ExtParameterInfo *getExtParameterInfosOrNull() const {
4112 if (!hasExtParameterInfos())
4113 return nullptr;
4114 return getTrailingObjects<ExtParameterInfo>();
4115 }
4116
4117 ExtParameterInfo getExtParameterInfo(unsigned I) const {
4118 assert(I < getNumParams() && "parameter index out of range")((I < getNumParams() && "parameter index out of range"
) ? static_cast<void> (0) : __assert_fail ("I < getNumParams() && \"parameter index out of range\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4118, __PRETTY_FUNCTION__))
;
4119 if (hasExtParameterInfos())
4120 return getTrailingObjects<ExtParameterInfo>()[I];
4121 return ExtParameterInfo();
4122 }
4123
4124 ParameterABI getParameterABI(unsigned I) const {
4125 assert(I < getNumParams() && "parameter index out of range")((I < getNumParams() && "parameter index out of range"
) ? static_cast<void> (0) : __assert_fail ("I < getNumParams() && \"parameter index out of range\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4125, __PRETTY_FUNCTION__))
;
4126 if (hasExtParameterInfos())
4127 return getTrailingObjects<ExtParameterInfo>()[I].getABI();
4128 return ParameterABI::Ordinary;
4129 }
4130
4131 bool isParamConsumed(unsigned I) const {
4132 assert(I < getNumParams() && "parameter index out of range")((I < getNumParams() && "parameter index out of range"
) ? static_cast<void> (0) : __assert_fail ("I < getNumParams() && \"parameter index out of range\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4132, __PRETTY_FUNCTION__))
;
4133 if (hasExtParameterInfos())
4134 return getTrailingObjects<ExtParameterInfo>()[I].isConsumed();
4135 return false;
4136 }
4137
4138 bool isSugared() const { return false; }
4139 QualType desugar() const { return QualType(this, 0); }
4140
4141 void printExceptionSpecification(raw_ostream &OS,
4142 const PrintingPolicy &Policy) const;
4143
4144 static bool classof(const Type *T) {
4145 return T->getTypeClass() == FunctionProto;
4146 }
4147
4148 void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx);
4149 static void Profile(llvm::FoldingSetNodeID &ID, QualType Result,
4150 param_type_iterator ArgTys, unsigned NumArgs,
4151 const ExtProtoInfo &EPI, const ASTContext &Context,
4152 bool Canonical);
4153};
4154
4155/// Represents the dependent type named by a dependently-scoped
4156/// typename using declaration, e.g.
4157/// using typename Base<T>::foo;
4158///
4159/// Template instantiation turns these into the underlying type.
4160class UnresolvedUsingType : public Type {
4161 friend class ASTContext; // ASTContext creates these.
4162
4163 UnresolvedUsingTypenameDecl *Decl;
4164
4165 UnresolvedUsingType(const UnresolvedUsingTypenameDecl *D)
4166 : Type(UnresolvedUsing, QualType(), true, true, false,
4167 /*ContainsUnexpandedParameterPack=*/false),
4168 Decl(const_cast<UnresolvedUsingTypenameDecl*>(D)) {}
4169
4170public:
4171 UnresolvedUsingTypenameDecl *getDecl() const { return Decl; }
4172
4173 bool isSugared() const { return false; }
4174 QualType desugar() const { return QualType(this, 0); }
4175
4176 static bool classof(const Type *T) {
4177 return T->getTypeClass() == UnresolvedUsing;
4178 }
4179
4180 void Profile(llvm::FoldingSetNodeID &ID) {
4181 return Profile(ID, Decl);
4182 }
4183
4184 static void Profile(llvm::FoldingSetNodeID &ID,
4185 UnresolvedUsingTypenameDecl *D) {
4186 ID.AddPointer(D);
4187 }
4188};
4189
4190class TypedefType : public Type {
4191 TypedefNameDecl *Decl;
4192
4193protected:
4194 friend class ASTContext; // ASTContext creates these.
4195
4196 TypedefType(TypeClass tc, const TypedefNameDecl *D, QualType can)
4197 : Type(tc, can, can->isDependentType(),
4198 can->isInstantiationDependentType(),
4199 can->isVariablyModifiedType(),
4200 /*ContainsUnexpandedParameterPack=*/false),
4201 Decl(const_cast<TypedefNameDecl*>(D)) {
4202 assert(!isa<TypedefType>(can) && "Invalid canonical type")((!isa<TypedefType>(can) && "Invalid canonical type"
) ? static_cast<void> (0) : __assert_fail ("!isa<TypedefType>(can) && \"Invalid canonical type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4202, __PRETTY_FUNCTION__))
;
4203 }
4204
4205public:
4206 TypedefNameDecl *getDecl() const { return Decl; }
4207
4208 bool isSugared() const { return true; }
4209 QualType desugar() const;
4210
4211 static bool classof(const Type *T) { return T->getTypeClass() == Typedef; }
4212};
4213
4214/// Sugar type that represents a type that was qualified by a qualifier written
4215/// as a macro invocation.
4216class MacroQualifiedType : public Type {
4217 friend class ASTContext; // ASTContext creates these.
4218
4219 QualType UnderlyingTy;
4220 const IdentifierInfo *MacroII;
4221
4222 MacroQualifiedType(QualType UnderlyingTy, QualType CanonTy,
4223 const IdentifierInfo *MacroII)
4224 : Type(MacroQualified, CanonTy, UnderlyingTy->isDependentType(),
4225 UnderlyingTy->isInstantiationDependentType(),
4226 UnderlyingTy->isVariablyModifiedType(),
4227 UnderlyingTy->containsUnexpandedParameterPack()),
4228 UnderlyingTy(UnderlyingTy), MacroII(MacroII) {
4229 assert(isa<AttributedType>(UnderlyingTy) &&((isa<AttributedType>(UnderlyingTy) && "Expected a macro qualified type to only wrap attributed types."
) ? static_cast<void> (0) : __assert_fail ("isa<AttributedType>(UnderlyingTy) && \"Expected a macro qualified type to only wrap attributed types.\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4230, __PRETTY_FUNCTION__))
4230 "Expected a macro qualified type to only wrap attributed types.")((isa<AttributedType>(UnderlyingTy) && "Expected a macro qualified type to only wrap attributed types."
) ? static_cast<void> (0) : __assert_fail ("isa<AttributedType>(UnderlyingTy) && \"Expected a macro qualified type to only wrap attributed types.\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4230, __PRETTY_FUNCTION__))
;
4231 }
4232
4233public:
4234 const IdentifierInfo *getMacroIdentifier() const { return MacroII; }
4235 QualType getUnderlyingType() const { return UnderlyingTy; }
4236
4237 /// Return this attributed type's modified type with no qualifiers attached to
4238 /// it.
4239 QualType getModifiedType() const;
4240
4241 bool isSugared() const { return true; }
4242 QualType desugar() const;
4243
4244 static bool classof(const Type *T) {
4245 return T->getTypeClass() == MacroQualified;
4246 }
4247};
4248
4249/// Represents a `typeof` (or __typeof__) expression (a GCC extension).
4250class TypeOfExprType : public Type {
4251 Expr *TOExpr;
4252
4253protected:
4254 friend class ASTContext; // ASTContext creates these.
4255
4256 TypeOfExprType(Expr *E, QualType can = QualType());
4257
4258public:
4259 Expr *getUnderlyingExpr() const { return TOExpr; }
4260
4261 /// Remove a single level of sugar.
4262 QualType desugar() const;
4263
4264 /// Returns whether this type directly provides sugar.
4265 bool isSugared() const;
4266
4267 static bool classof(const Type *T) { return T->getTypeClass() == TypeOfExpr; }
4268};
4269
4270/// Internal representation of canonical, dependent
4271/// `typeof(expr)` types.
4272///
4273/// This class is used internally by the ASTContext to manage
4274/// canonical, dependent types, only. Clients will only see instances
4275/// of this class via TypeOfExprType nodes.
4276class DependentTypeOfExprType
4277 : public TypeOfExprType, public llvm::FoldingSetNode {
4278 const ASTContext &Context;
4279
4280public:
4281 DependentTypeOfExprType(const ASTContext &Context, Expr *E)
4282 : TypeOfExprType(E), Context(Context) {}
4283
4284 void Profile(llvm::FoldingSetNodeID &ID) {
4285 Profile(ID, Context, getUnderlyingExpr());
4286 }
4287
4288 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
4289 Expr *E);
4290};
4291
4292/// Represents `typeof(type)`, a GCC extension.
4293class TypeOfType : public Type {
4294 friend class ASTContext; // ASTContext creates these.
4295
4296 QualType TOType;
4297
4298 TypeOfType(QualType T, QualType can)
4299 : Type(TypeOf, can, T->isDependentType(),
4300 T->isInstantiationDependentType(),
4301 T->isVariablyModifiedType(),
4302 T->containsUnexpandedParameterPack()),
4303 TOType(T) {
4304 assert(!isa<TypedefType>(can) && "Invalid canonical type")((!isa<TypedefType>(can) && "Invalid canonical type"
) ? static_cast<void> (0) : __assert_fail ("!isa<TypedefType>(can) && \"Invalid canonical type\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4304, __PRETTY_FUNCTION__))
;
4305 }
4306
4307public:
4308 QualType getUnderlyingType() const { return TOType; }
4309
4310 /// Remove a single level of sugar.
4311 QualType desugar() const { return getUnderlyingType(); }
4312
4313 /// Returns whether this type directly provides sugar.
4314 bool isSugared() const { return true; }
4315
4316 static bool classof(const Type *T) { return T->getTypeClass() == TypeOf; }
4317};
4318
4319/// Represents the type `decltype(expr)` (C++11).
4320class DecltypeType : public Type {
4321 Expr *E;
4322 QualType UnderlyingType;
4323
4324protected:
4325 friend class ASTContext; // ASTContext creates these.
4326
4327 DecltypeType(Expr *E, QualType underlyingType, QualType can = QualType());
4328
4329public:
4330 Expr *getUnderlyingExpr() const { return E; }
4331 QualType getUnderlyingType() const { return UnderlyingType; }
4332
4333 /// Remove a single level of sugar.
4334 QualType desugar() const;
4335
4336 /// Returns whether this type directly provides sugar.
4337 bool isSugared() const;
4338
4339 static bool classof(const Type *T) { return T->getTypeClass() == Decltype; }
4340};
4341
4342/// Internal representation of canonical, dependent
4343/// decltype(expr) types.
4344///
4345/// This class is used internally by the ASTContext to manage
4346/// canonical, dependent types, only. Clients will only see instances
4347/// of this class via DecltypeType nodes.
4348class DependentDecltypeType : public DecltypeType, public llvm::FoldingSetNode {
4349 const ASTContext &Context;
4350
4351public:
4352 DependentDecltypeType(const ASTContext &Context, Expr *E);
4353
4354 void Profile(llvm::FoldingSetNodeID &ID) {
4355 Profile(ID, Context, getUnderlyingExpr());
4356 }
4357
4358 static void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context,
4359 Expr *E);
4360};
4361
4362/// A unary type transform, which is a type constructed from another.
4363class UnaryTransformType : public Type {
4364public:
4365 enum UTTKind {
4366 EnumUnderlyingType
4367 };
4368
4369private:
4370 /// The untransformed type.
4371 QualType BaseType;
4372
4373 /// The transformed type if not dependent, otherwise the same as BaseType.
4374 QualType UnderlyingType;
4375
4376 UTTKind UKind;
4377
4378protected:
4379 friend class ASTContext;
4380
4381 UnaryTransformType(QualType BaseTy, QualType UnderlyingTy, UTTKind UKind,
4382 QualType CanonicalTy);
4383
4384public:
4385 bool isSugared() const { return !isDependentType(); }
4386 QualType desugar() const { return UnderlyingType; }
4387
4388 QualType getUnderlyingType() const { return UnderlyingType; }
4389 QualType getBaseType() const { return BaseType; }
4390
4391 UTTKind getUTTKind() const { return UKind; }
4392
4393 static bool classof(const Type *T) {
4394 return T->getTypeClass() == UnaryTransform;
4395 }
4396};
4397
4398/// Internal representation of canonical, dependent
4399/// __underlying_type(type) types.
4400///
4401/// This class is used internally by the ASTContext to manage
4402/// canonical, dependent types, only. Clients will only see instances
4403/// of this class via UnaryTransformType nodes.
4404class DependentUnaryTransformType : public UnaryTransformType,
4405 public llvm::FoldingSetNode {
4406public:
4407 DependentUnaryTransformType(const ASTContext &C, QualType BaseType,
4408 UTTKind UKind);
4409
4410 void Profile(llvm::FoldingSetNodeID &ID) {
4411 Profile(ID, getBaseType(), getUTTKind());
4412 }
4413
4414 static void Profile(llvm::FoldingSetNodeID &ID, QualType BaseType,
4415 UTTKind UKind) {
4416 ID.AddPointer(BaseType.getAsOpaquePtr());
4417 ID.AddInteger((unsigned)UKind);
4418 }
4419};
4420
4421class TagType : public Type {
4422 friend class ASTReader;
4423
4424 /// Stores the TagDecl associated with this type. The decl may point to any
4425 /// TagDecl that declares the entity.
4426 TagDecl *decl;
4427
4428protected:
4429 TagType(TypeClass TC, const TagDecl *D, QualType can);
4430
4431public:
4432 TagDecl *getDecl() const;
4433
4434 /// Determines whether this type is in the process of being defined.
4435 bool isBeingDefined() const;
4436
4437 static bool classof(const Type *T) {
4438 return T->getTypeClass() == Enum || T->getTypeClass() == Record;
4439 }
4440};
4441
4442/// A helper class that allows the use of isa/cast/dyncast
4443/// to detect TagType objects of structs/unions/classes.
4444class RecordType : public TagType {
4445protected:
4446 friend class ASTContext; // ASTContext creates these.
4447
4448 explicit RecordType(const RecordDecl *D)
4449 : TagType(Record, reinterpret_cast<const TagDecl*>(D), QualType()) {}
4450 explicit RecordType(TypeClass TC, RecordDecl *D)
4451 : TagType(TC, reinterpret_cast<const TagDecl*>(D), QualType()) {}
4452
4453public:
4454 RecordDecl *getDecl() const {
4455 return reinterpret_cast<RecordDecl*>(TagType::getDecl());
4456 }
4457
4458 /// Recursively check all fields in the record for const-ness. If any field
4459 /// is declared const, return true. Otherwise, return false.
4460 bool hasConstFields() const;
4461
4462 bool isSugared() const { return false; }
4463 QualType desugar() const { return QualType(this, 0); }
4464
4465 static bool classof(const Type *T) { return T->getTypeClass() == Record; }
4466};
4467
4468/// A helper class that allows the use of isa/cast/dyncast
4469/// to detect TagType objects of enums.
4470class EnumType : public TagType {
4471 friend class ASTContext; // ASTContext creates these.
4472
4473 explicit EnumType(const EnumDecl *D)
4474 : TagType(Enum, reinterpret_cast<const TagDecl*>(D), QualType()) {}
4475
4476public:
4477 EnumDecl *getDecl() const {
4478 return reinterpret_cast<EnumDecl*>(TagType::getDecl());
4479 }
4480
4481 bool isSugared() const { return false; }
4482 QualType desugar() const { return QualType(this, 0); }
4483
4484 static bool classof(const Type *T) { return T->getTypeClass() == Enum; }
4485};
4486
4487/// An attributed type is a type to which a type attribute has been applied.
4488///
4489/// The "modified type" is the fully-sugared type to which the attributed
4490/// type was applied; generally it is not canonically equivalent to the
4491/// attributed type. The "equivalent type" is the minimally-desugared type
4492/// which the type is canonically equivalent to.
4493///
4494/// For example, in the following attributed type:
4495/// int32_t __attribute__((vector_size(16)))
4496/// - the modified type is the TypedefType for int32_t
4497/// - the equivalent type is VectorType(16, int32_t)
4498/// - the canonical type is VectorType(16, int)
4499class AttributedType : public Type, public llvm::FoldingSetNode {
4500public:
4501 using Kind = attr::Kind;
4502
4503private:
4504 friend class ASTContext; // ASTContext creates these
4505
4506 QualType ModifiedType;
4507 QualType EquivalentType;
4508
4509 AttributedType(QualType canon, attr::Kind attrKind, QualType modified,
4510 QualType equivalent)
4511 : Type(Attributed, canon, equivalent->isDependentType(),
4512 equivalent->isInstantiationDependentType(),
4513 equivalent->isVariablyModifiedType(),
4514 equivalent->containsUnexpandedParameterPack()),
4515 ModifiedType(modified), EquivalentType(equivalent) {
4516 AttributedTypeBits.AttrKind = attrKind;
4517 }
4518
4519public:
4520 Kind getAttrKind() const {
4521 return static_cast<Kind>(AttributedTypeBits.AttrKind);
4522 }
4523
4524 QualType getModifiedType() const { return ModifiedType; }
4525 QualType getEquivalentType() const { return EquivalentType; }
4526
4527 bool isSugared() const { return true; }
4528 QualType desugar() const { return getEquivalentType(); }
4529
4530 /// Does this attribute behave like a type qualifier?
4531 ///
4532 /// A type qualifier adjusts a type to provide specialized rules for
4533 /// a specific object, like the standard const and volatile qualifiers.
4534 /// This includes attributes controlling things like nullability,
4535 /// address spaces, and ARC ownership. The value of the object is still
4536 /// largely described by the modified type.
4537 ///
4538 /// In contrast, many type attributes "rewrite" their modified type to
4539 /// produce a fundamentally different type, not necessarily related in any
4540 /// formalizable way to the original type. For example, calling convention
4541 /// and vector attributes are not simple type qualifiers.
4542 ///
4543 /// Type qualifiers are often, but not always, reflected in the canonical
4544 /// type.
4545 bool isQualifier() const;
4546
4547 bool isMSTypeSpec() const;
4548
4549 bool isCallingConv() const;
4550
4551 llvm::Optional<NullabilityKind> getImmediateNullability() const;
4552
4553 /// Retrieve the attribute kind corresponding to the given
4554 /// nullability kind.
4555 static Kind getNullabilityAttrKind(NullabilityKind kind) {
4556 switch (kind) {
4557 case NullabilityKind::NonNull:
4558 return attr::TypeNonNull;
4559
4560 case NullabilityKind::Nullable:
4561 return attr::TypeNullable;
4562
4563 case NullabilityKind::Unspecified:
4564 return attr::TypeNullUnspecified;
4565 }
4566 llvm_unreachable("Unknown nullability kind.")::llvm::llvm_unreachable_internal("Unknown nullability kind."
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4566)
;
4567 }
4568
4569 /// Strip off the top-level nullability annotation on the given
4570 /// type, if it's there.
4571 ///
4572 /// \param T The type to strip. If the type is exactly an
4573 /// AttributedType specifying nullability (without looking through
4574 /// type sugar), the nullability is returned and this type changed
4575 /// to the underlying modified type.
4576 ///
4577 /// \returns the top-level nullability, if present.
4578 static Optional<NullabilityKind> stripOuterNullability(QualType &T);
4579
4580 void Profile(llvm::FoldingSetNodeID &ID) {
4581 Profile(ID, getAttrKind(), ModifiedType, EquivalentType);
4582 }
4583
4584 static void Profile(llvm::FoldingSetNodeID &ID, Kind attrKind,
4585 QualType modified, QualType equivalent) {
4586 ID.AddInteger(attrKind);
4587 ID.AddPointer(modified.getAsOpaquePtr());
4588 ID.AddPointer(equivalent.getAsOpaquePtr());
4589 }
4590
4591 static bool classof(const Type *T) {
4592 return T->getTypeClass() == Attributed;
4593 }
4594};
4595
4596class TemplateTypeParmType : public Type, public llvm::FoldingSetNode {
4597 friend class ASTContext; // ASTContext creates these
4598
4599 // Helper data collector for canonical types.
4600 struct CanonicalTTPTInfo {
4601 unsigned Depth : 15;
4602 unsigned ParameterPack : 1;
4603 unsigned Index : 16;
4604 };
4605
4606 union {
4607 // Info for the canonical type.
4608 CanonicalTTPTInfo CanTTPTInfo;
4609
4610 // Info for the non-canonical type.
4611 TemplateTypeParmDecl *TTPDecl;
4612 };
4613
4614 /// Build a non-canonical type.
4615 TemplateTypeParmType(TemplateTypeParmDecl *TTPDecl, QualType Canon)
4616 : Type(TemplateTypeParm, Canon, /*Dependent=*/true,
4617 /*InstantiationDependent=*/true,
4618 /*VariablyModified=*/false,
4619 Canon->containsUnexpandedParameterPack()),
4620 TTPDecl(TTPDecl) {}
4621
4622 /// Build the canonical type.
4623 TemplateTypeParmType(unsigned D, unsigned I, bool PP)
4624 : Type(TemplateTypeParm, QualType(this, 0),
4625 /*Dependent=*/true,
4626 /*InstantiationDependent=*/true,
4627 /*VariablyModified=*/false, PP) {
4628 CanTTPTInfo.Depth = D;
4629 CanTTPTInfo.Index = I;
4630 CanTTPTInfo.ParameterPack = PP;
4631 }
4632
4633 const CanonicalTTPTInfo& getCanTTPTInfo() const {
4634 QualType Can = getCanonicalTypeInternal();
4635 return Can->castAs<TemplateTypeParmType>()->CanTTPTInfo;
4636 }
4637
4638public:
4639 unsigned getDepth() const { return getCanTTPTInfo().Depth; }
4640 unsigned getIndex() const { return getCanTTPTInfo().Index; }
4641 bool isParameterPack() const { return getCanTTPTInfo().ParameterPack; }
4642
4643 TemplateTypeParmDecl *getDecl() const {
4644 return isCanonicalUnqualified() ? nullptr : TTPDecl;
4645 }
4646
4647 IdentifierInfo *getIdentifier() const;
4648
4649 bool isSugared() const { return false; }
4650 QualType desugar() const { return QualType(this, 0); }
4651
4652 void Profile(llvm::FoldingSetNodeID &ID) {
4653 Profile(ID, getDepth(), getIndex(), isParameterPack(), getDecl());
4654 }
4655
4656 static void Profile(llvm::FoldingSetNodeID &ID, unsigned Depth,
4657 unsigned Index, bool ParameterPack,
4658 TemplateTypeParmDecl *TTPDecl) {
4659 ID.AddInteger(Depth);
4660 ID.AddInteger(Index);
4661 ID.AddBoolean(ParameterPack);
4662 ID.AddPointer(TTPDecl);
4663 }
4664
4665 static bool classof(const Type *T) {
4666 return T->getTypeClass() == TemplateTypeParm;
4667 }
4668};
4669
4670/// Represents the result of substituting a type for a template
4671/// type parameter.
4672///
4673/// Within an instantiated template, all template type parameters have
4674/// been replaced with these. They are used solely to record that a
4675/// type was originally written as a template type parameter;
4676/// therefore they are never canonical.
4677class SubstTemplateTypeParmType : public Type, public llvm::FoldingSetNode {
4678 friend class ASTContext;
4679
4680 // The original type parameter.
4681 const TemplateTypeParmType *Replaced;
4682
4683 SubstTemplateTypeParmType(const TemplateTypeParmType *Param, QualType Canon)
4684 : Type(SubstTemplateTypeParm, Canon, Canon->isDependentType(),
4685 Canon->isInstantiationDependentType(),
4686 Canon->isVariablyModifiedType(),
4687 Canon->containsUnexpandedParameterPack()),
4688 Replaced(Param) {}
4689
4690public:
4691 /// Gets the template parameter that was substituted for.
4692 const TemplateTypeParmType *getReplacedParameter() const {
4693 return Replaced;
4694 }
4695
4696 /// Gets the type that was substituted for the template
4697 /// parameter.
4698 QualType getReplacementType() const {
4699 return getCanonicalTypeInternal();
4700 }
4701
4702 bool isSugared() const { return true; }
4703 QualType desugar() const { return getReplacementType(); }
4704
4705 void Profile(llvm::FoldingSetNodeID &ID) {
4706 Profile(ID, getReplacedParameter(), getReplacementType());
4707 }
4708
4709 static void Profile(llvm::FoldingSetNodeID &ID,
4710 const TemplateTypeParmType *Replaced,
4711 QualType Replacement) {
4712 ID.AddPointer(Replaced);
4713 ID.AddPointer(Replacement.getAsOpaquePtr());
4714 }
4715
4716 static bool classof(const Type *T) {
4717 return T->getTypeClass() == SubstTemplateTypeParm;
4718 }
4719};
4720
4721/// Represents the result of substituting a set of types for a template
4722/// type parameter pack.
4723///
4724/// When a pack expansion in the source code contains multiple parameter packs
4725/// and those parameter packs correspond to different levels of template
4726/// parameter lists, this type node is used to represent a template type
4727/// parameter pack from an outer level, which has already had its argument pack
4728/// substituted but that still lives within a pack expansion that itself
4729/// could not be instantiated. When actually performing a substitution into
4730/// that pack expansion (e.g., when all template parameters have corresponding
4731/// arguments), this type will be replaced with the \c SubstTemplateTypeParmType
4732/// at the current pack substitution index.
4733class SubstTemplateTypeParmPackType : public Type, public llvm::FoldingSetNode {
4734 friend class ASTContext;
4735
4736 /// The original type parameter.
4737 const TemplateTypeParmType *Replaced;
4738
4739 /// A pointer to the set of template arguments that this
4740 /// parameter pack is instantiated with.
4741 const TemplateArgument *Arguments;
4742
4743 SubstTemplateTypeParmPackType(const TemplateTypeParmType *Param,
4744 QualType Canon,
4745 const TemplateArgument &ArgPack);
4746
4747public:
4748 IdentifierInfo *getIdentifier() const { return Replaced->getIdentifier(); }
4749
4750 /// Gets the template parameter that was substituted for.
4751 const TemplateTypeParmType *getReplacedParameter() const {
4752 return Replaced;
4753 }
4754
4755 unsigned getNumArgs() const {
4756 return SubstTemplateTypeParmPackTypeBits.NumArgs;
4757 }
4758
4759 bool isSugared() const { return false; }
4760 QualType desugar() const { return QualType(this, 0); }
4761
4762 TemplateArgument getArgumentPack() const;
4763
4764 void Profile(llvm::FoldingSetNodeID &ID);
4765 static void Profile(llvm::FoldingSetNodeID &ID,
4766 const TemplateTypeParmType *Replaced,
4767 const TemplateArgument &ArgPack);
4768
4769 static bool classof(const Type *T) {
4770 return T->getTypeClass() == SubstTemplateTypeParmPack;
4771 }
4772};
4773
4774/// Common base class for placeholders for types that get replaced by
4775/// placeholder type deduction: C++11 auto, C++14 decltype(auto), C++17 deduced
4776/// class template types, and (eventually) constrained type names from the C++
4777/// Concepts TS.
4778///
4779/// These types are usually a placeholder for a deduced type. However, before
4780/// the initializer is attached, or (usually) if the initializer is
4781/// type-dependent, there is no deduced type and the type is canonical. In
4782/// the latter case, it is also a dependent type.
4783class DeducedType : public Type {
4784protected:
4785 DeducedType(TypeClass TC, QualType DeducedAsType, bool IsDependent,
4786 bool IsInstantiationDependent, bool ContainsParameterPack)
4787 : Type(TC,
4788 // FIXME: Retain the sugared deduced type?
4789 DeducedAsType.isNull() ? QualType(this, 0)
4790 : DeducedAsType.getCanonicalType(),
4791 IsDependent, IsInstantiationDependent,
4792 /*VariablyModified=*/false, ContainsParameterPack) {
4793 if (!DeducedAsType.isNull()) {
4794 if (DeducedAsType->isDependentType())
4795 setDependent();
4796 if (DeducedAsType->isInstantiationDependentType())
4797 setInstantiationDependent();
4798 if (DeducedAsType->containsUnexpandedParameterPack())
4799 setContainsUnexpandedParameterPack();
4800 }
4801 }
4802
4803public:
4804 bool isSugared() const { return !isCanonicalUnqualified(); }
4805 QualType desugar() const { return getCanonicalTypeInternal(); }
4806
4807 /// Get the type deduced for this placeholder type, or null if it's
4808 /// either not been deduced or was deduced to a dependent type.
4809 QualType getDeducedType() const {
4810 return !isCanonicalUnqualified() ? getCanonicalTypeInternal() : QualType();
4811 }
4812 bool isDeduced() const {
4813 return !isCanonicalUnqualified() || isDependentType();
4814 }
4815
4816 static bool classof(const Type *T) {
4817 return T->getTypeClass() == Auto ||
4818 T->getTypeClass() == DeducedTemplateSpecialization;
4819 }
4820};
4821
4822/// Represents a C++11 auto or C++14 decltype(auto) type.
4823class AutoType : public DeducedType, public llvm::FoldingSetNode {
4824 friend class ASTContext; // ASTContext creates these
4825
4826 AutoType(QualType DeducedAsType, AutoTypeKeyword Keyword,
4827 bool IsDeducedAsDependent, bool IsDeducedAsPack)
4828 : DeducedType(Auto, DeducedAsType, IsDeducedAsDependent,
4829 IsDeducedAsDependent, IsDeducedAsPack) {
4830 AutoTypeBits.Keyword = (unsigned)Keyword;
4831 }
4832
4833public:
4834 bool isDecltypeAuto() const {
4835 return getKeyword() == AutoTypeKeyword::DecltypeAuto;
4836 }
4837
4838 AutoTypeKeyword getKeyword() const {
4839 return (AutoTypeKeyword)AutoTypeBits.Keyword;
4840 }
4841
4842 void Profile(llvm::FoldingSetNodeID &ID) {
4843 Profile(ID, getDeducedType(), getKeyword(), isDependentType(),
4844 containsUnexpandedParameterPack());
4845 }
4846
4847 static void Profile(llvm::FoldingSetNodeID &ID, QualType Deduced,
4848 AutoTypeKeyword Keyword, bool IsDependent, bool IsPack) {
4849 ID.AddPointer(Deduced.getAsOpaquePtr());
4850 ID.AddInteger((unsigned)Keyword);
4851 ID.AddBoolean(IsDependent);
4852 ID.AddBoolean(IsPack);
4853 }
4854
4855 static bool classof(const Type *T) {
4856 return T->getTypeClass() == Auto;
4857 }
4858};
4859
4860/// Represents a C++17 deduced template specialization type.
4861class DeducedTemplateSpecializationType : public DeducedType,
4862 public llvm::FoldingSetNode {
4863 friend class ASTContext; // ASTContext creates these
4864
4865 /// The name of the template whose arguments will be deduced.
4866 TemplateName Template;
4867
4868 DeducedTemplateSpecializationType(TemplateName Template,
4869 QualType DeducedAsType,
4870 bool IsDeducedAsDependent)
4871 : DeducedType(DeducedTemplateSpecialization, DeducedAsType,
4872 IsDeducedAsDependent || Template.isDependent(),
4873 IsDeducedAsDependent || Template.isInstantiationDependent(),
4874 Template.containsUnexpandedParameterPack()),
4875 Template(Template) {}
4876
4877public:
4878 /// Retrieve the name of the template that we are deducing.
4879 TemplateName getTemplateName() const { return Template;}
4880
4881 void Profile(llvm::FoldingSetNodeID &ID) {
4882 Profile(ID, getTemplateName(), getDeducedType(), isDependentType());
4883 }
4884
4885 static void Profile(llvm::FoldingSetNodeID &ID, TemplateName Template,
4886 QualType Deduced, bool IsDependent) {
4887 Template.Profile(ID);
4888 ID.AddPointer(Deduced.getAsOpaquePtr());
4889 ID.AddBoolean(IsDependent);
4890 }
4891
4892 static bool classof(const Type *T) {
4893 return T->getTypeClass() == DeducedTemplateSpecialization;
4894 }
4895};
4896
4897/// Represents a type template specialization; the template
4898/// must be a class template, a type alias template, or a template
4899/// template parameter. A template which cannot be resolved to one of
4900/// these, e.g. because it is written with a dependent scope
4901/// specifier, is instead represented as a
4902/// @c DependentTemplateSpecializationType.
4903///
4904/// A non-dependent template specialization type is always "sugar",
4905/// typically for a \c RecordType. For example, a class template
4906/// specialization type of \c vector<int> will refer to a tag type for
4907/// the instantiation \c std::vector<int, std::allocator<int>>
4908///
4909/// Template specializations are dependent if either the template or
4910/// any of the template arguments are dependent, in which case the
4911/// type may also be canonical.
4912///
4913/// Instances of this type are allocated with a trailing array of
4914/// TemplateArguments, followed by a QualType representing the
4915/// non-canonical aliased type when the template is a type alias
4916/// template.
4917class alignas(8) TemplateSpecializationType
4918 : public Type,
4919 public llvm::FoldingSetNode {
4920 friend class ASTContext; // ASTContext creates these
4921
4922 /// The name of the template being specialized. This is
4923 /// either a TemplateName::Template (in which case it is a
4924 /// ClassTemplateDecl*, a TemplateTemplateParmDecl*, or a
4925 /// TypeAliasTemplateDecl*), a
4926 /// TemplateName::SubstTemplateTemplateParmPack, or a
4927 /// TemplateName::SubstTemplateTemplateParm (in which case the
4928 /// replacement must, recursively, be one of these).
4929 TemplateName Template;
4930
4931 TemplateSpecializationType(TemplateName T,
4932 ArrayRef<TemplateArgument> Args,
4933 QualType Canon,
4934 QualType Aliased);
4935
4936public:
4937 /// Determine whether any of the given template arguments are dependent.
4938 static bool anyDependentTemplateArguments(ArrayRef<TemplateArgumentLoc> Args,
4939 bool &InstantiationDependent);
4940
4941 static bool anyDependentTemplateArguments(const TemplateArgumentListInfo &,
4942 bool &InstantiationDependent);
4943
4944 /// True if this template specialization type matches a current
4945 /// instantiation in the context in which it is found.
4946 bool isCurrentInstantiation() const {
4947 return isa<InjectedClassNameType>(getCanonicalTypeInternal());
4948 }
4949
4950 /// Determine if this template specialization type is for a type alias
4951 /// template that has been substituted.
4952 ///
4953 /// Nearly every template specialization type whose template is an alias
4954 /// template will be substituted. However, this is not the case when
4955 /// the specialization contains a pack expansion but the template alias
4956 /// does not have a corresponding parameter pack, e.g.,
4957 ///
4958 /// \code
4959 /// template<typename T, typename U, typename V> struct S;
4960 /// template<typename T, typename U> using A = S<T, int, U>;
4961 /// template<typename... Ts> struct X {
4962 /// typedef A<Ts...> type; // not a type alias
4963 /// };
4964 /// \endcode
4965 bool isTypeAlias() const { return TemplateSpecializationTypeBits.TypeAlias; }
4966
4967 /// Get the aliased type, if this is a specialization of a type alias
4968 /// template.
4969 QualType getAliasedType() const {
4970 assert(isTypeAlias() && "not a type alias template specialization")((isTypeAlias() && "not a type alias template specialization"
) ? static_cast<void> (0) : __assert_fail ("isTypeAlias() && \"not a type alias template specialization\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 4970, __PRETTY_FUNCTION__))
;
4971 return *reinterpret_cast<const QualType*>(end());
4972 }
4973
4974 using iterator = const TemplateArgument *;
4975
4976 iterator begin() const { return getArgs(); }
4977 iterator end() const; // defined inline in TemplateBase.h
4978
4979 /// Retrieve the name of the template that we are specializing.
4980 TemplateName getTemplateName() const { return Template; }
4981
4982 /// Retrieve the template arguments.
4983 const TemplateArgument *getArgs() const {
4984 return reinterpret_cast<const TemplateArgument *>(this + 1);
4985 }
4986
4987 /// Retrieve the number of template arguments.
4988 unsigned getNumArgs() const {
4989 return TemplateSpecializationTypeBits.NumArgs;
4990 }
4991
4992 /// Retrieve a specific template argument as a type.
4993 /// \pre \c isArgType(Arg)
4994 const TemplateArgument &getArg(unsigned Idx) const; // in TemplateBase.h
4995
4996 ArrayRef<TemplateArgument> template_arguments() const {
4997 return {getArgs(), getNumArgs()};
4998 }
4999
5000 bool isSugared() const {
5001 return !isDependentType() || isCurrentInstantiation() || isTypeAlias();
5002 }
5003
5004 QualType desugar() const {
5005 return isTypeAlias() ? getAliasedType() : getCanonicalTypeInternal();
5006 }
5007
5008 void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Ctx) {
5009 Profile(ID, Template, template_arguments(), Ctx);
5010 if (isTypeAlias())
5011 getAliasedType().Profile(ID);
5012 }
5013
5014 static void Profile(llvm::FoldingSetNodeID &ID, TemplateName T,
5015 ArrayRef<TemplateArgument> Args,
5016 const ASTContext &Context);
5017
5018 static bool classof(const Type *T) {
5019 return T->getTypeClass() == TemplateSpecialization;
5020 }
5021};
5022
5023/// Print a template argument list, including the '<' and '>'
5024/// enclosing the template arguments.
5025void printTemplateArgumentList(raw_ostream &OS,
5026 ArrayRef<TemplateArgument> Args,
5027 const PrintingPolicy &Policy);
5028
5029void printTemplateArgumentList(raw_ostream &OS,
5030 ArrayRef<TemplateArgumentLoc> Args,
5031 const PrintingPolicy &Policy);
5032
5033void printTemplateArgumentList(raw_ostream &OS,
5034 const TemplateArgumentListInfo &Args,
5035 const PrintingPolicy &Policy);
5036
5037/// The injected class name of a C++ class template or class
5038/// template partial specialization. Used to record that a type was
5039/// spelled with a bare identifier rather than as a template-id; the
5040/// equivalent for non-templated classes is just RecordType.
5041///
5042/// Injected class name types are always dependent. Template
5043/// instantiation turns these into RecordTypes.
5044///
5045/// Injected class name types are always canonical. This works
5046/// because it is impossible to compare an injected class name type
5047/// with the corresponding non-injected template type, for the same
5048/// reason that it is impossible to directly compare template
5049/// parameters from different dependent contexts: injected class name
5050/// types can only occur within the scope of a particular templated
5051/// declaration, and within that scope every template specialization
5052/// will canonicalize to the injected class name (when appropriate
5053/// according to the rules of the language).
5054class InjectedClassNameType : public Type {
5055 friend class ASTContext; // ASTContext creates these.
5056 friend class ASTNodeImporter;
5057 friend class ASTReader; // FIXME: ASTContext::getInjectedClassNameType is not
5058 // currently suitable for AST reading, too much
5059 // interdependencies.
5060
5061 CXXRecordDecl *Decl;
5062
5063 /// The template specialization which this type represents.
5064 /// For example, in
5065 /// template <class T> class A { ... };
5066 /// this is A<T>, whereas in
5067 /// template <class X, class Y> class A<B<X,Y> > { ... };
5068 /// this is A<B<X,Y> >.
5069 ///
5070 /// It is always unqualified, always a template specialization type,
5071 /// and always dependent.
5072 QualType InjectedType;
5073
5074 InjectedClassNameType(CXXRecordDecl *D, QualType TST)
5075 : Type(InjectedClassName, QualType(), /*Dependent=*/true,
5076 /*InstantiationDependent=*/true,
5077 /*VariablyModified=*/false,
5078 /*ContainsUnexpandedParameterPack=*/false),
5079 Decl(D), InjectedType(TST) {
5080 assert(isa<TemplateSpecializationType>(TST))((isa<TemplateSpecializationType>(TST)) ? static_cast<
void> (0) : __assert_fail ("isa<TemplateSpecializationType>(TST)"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5080, __PRETTY_FUNCTION__))
;
5081 assert(!TST.hasQualifiers())((!TST.hasQualifiers()) ? static_cast<void> (0) : __assert_fail
("!TST.hasQualifiers()", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5081, __PRETTY_FUNCTION__))
;
5082 assert(TST->isDependentType())((TST->isDependentType()) ? static_cast<void> (0) : __assert_fail
("TST->isDependentType()", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5082, __PRETTY_FUNCTION__))
;
5083 }
5084
5085public:
5086 QualType getInjectedSpecializationType() const { return InjectedType; }
5087
5088 const TemplateSpecializationType *getInjectedTST() const {
5089 return cast<TemplateSpecializationType>(InjectedType.getTypePtr());
5090 }
5091
5092 TemplateName getTemplateName() const {
5093 return getInjectedTST()->getTemplateName();
5094 }
5095
5096 CXXRecordDecl *getDecl() const;
5097
5098 bool isSugared() const { return false; }
5099 QualType desugar() const { return QualType(this, 0); }
5100
5101 static bool classof(const Type *T) {
5102 return T->getTypeClass() == InjectedClassName;
5103 }
5104};
5105
5106/// The kind of a tag type.
5107enum TagTypeKind {
5108 /// The "struct" keyword.
5109 TTK_Struct,
5110
5111 /// The "__interface" keyword.
5112 TTK_Interface,
5113
5114 /// The "union" keyword.
5115 TTK_Union,
5116
5117 /// The "class" keyword.
5118 TTK_Class,
5119
5120 /// The "enum" keyword.
5121 TTK_Enum
5122};
5123
5124/// The elaboration keyword that precedes a qualified type name or
5125/// introduces an elaborated-type-specifier.
5126enum ElaboratedTypeKeyword {
5127 /// The "struct" keyword introduces the elaborated-type-specifier.
5128 ETK_Struct,
5129
5130 /// The "__interface" keyword introduces the elaborated-type-specifier.
5131 ETK_Interface,
5132
5133 /// The "union" keyword introduces the elaborated-type-specifier.
5134 ETK_Union,
5135
5136 /// The "class" keyword introduces the elaborated-type-specifier.
5137 ETK_Class,
5138
5139 /// The "enum" keyword introduces the elaborated-type-specifier.
5140 ETK_Enum,
5141
5142 /// The "typename" keyword precedes the qualified type name, e.g.,
5143 /// \c typename T::type.
5144 ETK_Typename,
5145
5146 /// No keyword precedes the qualified type name.
5147 ETK_None
5148};
5149
5150/// A helper class for Type nodes having an ElaboratedTypeKeyword.
5151/// The keyword in stored in the free bits of the base class.
5152/// Also provides a few static helpers for converting and printing
5153/// elaborated type keyword and tag type kind enumerations.
5154class TypeWithKeyword : public Type {
5155protected:
5156 TypeWithKeyword(ElaboratedTypeKeyword Keyword, TypeClass tc,
5157 QualType Canonical, bool Dependent,
5158 bool InstantiationDependent, bool VariablyModified,
5159 bool ContainsUnexpandedParameterPack)
5160 : Type(tc, Canonical, Dependent, InstantiationDependent, VariablyModified,
5161 ContainsUnexpandedParameterPack) {
5162 TypeWithKeywordBits.Keyword = Keyword;
5163 }
5164
5165public:
5166 ElaboratedTypeKeyword getKeyword() const {
5167 return static_cast<ElaboratedTypeKeyword>(TypeWithKeywordBits.Keyword);
5168 }
5169
5170 /// Converts a type specifier (DeclSpec::TST) into an elaborated type keyword.
5171 static ElaboratedTypeKeyword getKeywordForTypeSpec(unsigned TypeSpec);
5172
5173 /// Converts a type specifier (DeclSpec::TST) into a tag type kind.
5174 /// It is an error to provide a type specifier which *isn't* a tag kind here.
5175 static TagTypeKind getTagTypeKindForTypeSpec(unsigned TypeSpec);
5176
5177 /// Converts a TagTypeKind into an elaborated type keyword.
5178 static ElaboratedTypeKeyword getKeywordForTagTypeKind(TagTypeKind Tag);
5179
5180 /// Converts an elaborated type keyword into a TagTypeKind.
5181 /// It is an error to provide an elaborated type keyword
5182 /// which *isn't* a tag kind here.
5183 static TagTypeKind getTagTypeKindForKeyword(ElaboratedTypeKeyword Keyword);
5184
5185 static bool KeywordIsTagTypeKind(ElaboratedTypeKeyword Keyword);
5186
5187 static StringRef getKeywordName(ElaboratedTypeKeyword Keyword);
5188
5189 static StringRef getTagTypeKindName(TagTypeKind Kind) {
5190 return getKeywordName(getKeywordForTagTypeKind(Kind));
5191 }
5192
5193 class CannotCastToThisType {};
5194 static CannotCastToThisType classof(const Type *);
5195};
5196
5197/// Represents a type that was referred to using an elaborated type
5198/// keyword, e.g., struct S, or via a qualified name, e.g., N::M::type,
5199/// or both.
5200///
5201/// This type is used to keep track of a type name as written in the
5202/// source code, including tag keywords and any nested-name-specifiers.
5203/// The type itself is always "sugar", used to express what was written
5204/// in the source code but containing no additional semantic information.
5205class ElaboratedType final
5206 : public TypeWithKeyword,
5207 public llvm::FoldingSetNode,
5208 private llvm::TrailingObjects<ElaboratedType, TagDecl *> {
5209 friend class ASTContext; // ASTContext creates these
5210 friend TrailingObjects;
5211
5212 /// The nested name specifier containing the qualifier.
5213 NestedNameSpecifier *NNS;
5214
5215 /// The type that this qualified name refers to.
5216 QualType NamedType;
5217
5218 /// The (re)declaration of this tag type owned by this occurrence is stored
5219 /// as a trailing object if there is one. Use getOwnedTagDecl to obtain
5220 /// it, or obtain a null pointer if there is none.
5221
5222 ElaboratedType(ElaboratedTypeKeyword Keyword, NestedNameSpecifier *NNS,
5223 QualType NamedType, QualType CanonType, TagDecl *OwnedTagDecl)
5224 : TypeWithKeyword(Keyword, Elaborated, CanonType,
5225 NamedType->isDependentType(),
5226 NamedType->isInstantiationDependentType(),
5227 NamedType->isVariablyModifiedType(),
5228 NamedType->containsUnexpandedParameterPack()),
5229 NNS(NNS), NamedType(NamedType) {
5230 ElaboratedTypeBits.HasOwnedTagDecl = false;
5231 if (OwnedTagDecl) {
5232 ElaboratedTypeBits.HasOwnedTagDecl = true;
5233 *getTrailingObjects<TagDecl *>() = OwnedTagDecl;
5234 }
5235 assert(!(Keyword == ETK_None && NNS == nullptr) &&((!(Keyword == ETK_None && NNS == nullptr) &&
"ElaboratedType cannot have elaborated type keyword " "and name qualifier both null."
) ? static_cast<void> (0) : __assert_fail ("!(Keyword == ETK_None && NNS == nullptr) && \"ElaboratedType cannot have elaborated type keyword \" \"and name qualifier both null.\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5237, __PRETTY_FUNCTION__))
5236 "ElaboratedType cannot have elaborated type keyword "((!(Keyword == ETK_None && NNS == nullptr) &&
"ElaboratedType cannot have elaborated type keyword " "and name qualifier both null."
) ? static_cast<void> (0) : __assert_fail ("!(Keyword == ETK_None && NNS == nullptr) && \"ElaboratedType cannot have elaborated type keyword \" \"and name qualifier both null.\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5237, __PRETTY_FUNCTION__))
5237 "and name qualifier both null.")((!(Keyword == ETK_None && NNS == nullptr) &&
"ElaboratedType cannot have elaborated type keyword " "and name qualifier both null."
) ? static_cast<void> (0) : __assert_fail ("!(Keyword == ETK_None && NNS == nullptr) && \"ElaboratedType cannot have elaborated type keyword \" \"and name qualifier both null.\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5237, __PRETTY_FUNCTION__))
;
5238 }
5239
5240public:
5241 /// Retrieve the qualification on this type.
5242 NestedNameSpecifier *getQualifier() const { return NNS; }
5243
5244 /// Retrieve the type named by the qualified-id.
5245 QualType getNamedType() const { return NamedType; }
5246
5247 /// Remove a single level of sugar.
5248 QualType desugar() const { return getNamedType(); }
5249
5250 /// Returns whether this type directly provides sugar.
5251 bool isSugared() const { return true; }
5252
5253 /// Return the (re)declaration of this type owned by this occurrence of this
5254 /// type, or nullptr if there is none.
5255 TagDecl *getOwnedTagDecl() const {
5256 return ElaboratedTypeBits.HasOwnedTagDecl ? *getTrailingObjects<TagDecl *>()
5257 : nullptr;
5258 }
5259
5260 void Profile(llvm::FoldingSetNodeID &ID) {
5261 Profile(ID, getKeyword(), NNS, NamedType, getOwnedTagDecl());
5262 }
5263
5264 static void Profile(llvm::FoldingSetNodeID &ID, ElaboratedTypeKeyword Keyword,
5265 NestedNameSpecifier *NNS, QualType NamedType,
5266 TagDecl *OwnedTagDecl) {
5267 ID.AddInteger(Keyword);
5268 ID.AddPointer(NNS);
5269 NamedType.Profile(ID);
5270 ID.AddPointer(OwnedTagDecl);
5271 }
5272
5273 static bool classof(const Type *T) { return T->getTypeClass() == Elaborated; }
5274};
5275
5276/// Represents a qualified type name for which the type name is
5277/// dependent.
5278///
5279/// DependentNameType represents a class of dependent types that involve a
5280/// possibly dependent nested-name-specifier (e.g., "T::") followed by a
5281/// name of a type. The DependentNameType may start with a "typename" (for a
5282/// typename-specifier), "class", "struct", "union", or "enum" (for a
5283/// dependent elaborated-type-specifier), or nothing (in contexts where we
5284/// know that we must be referring to a type, e.g., in a base class specifier).
5285/// Typically the nested-name-specifier is dependent, but in MSVC compatibility
5286/// mode, this type is used with non-dependent names to delay name lookup until
5287/// instantiation.
5288class DependentNameType : public TypeWithKeyword, public llvm::FoldingSetNode {
5289 friend class ASTContext; // ASTContext creates these
5290
5291 /// The nested name specifier containing the qualifier.
5292 NestedNameSpecifier *NNS;
5293
5294 /// The type that this typename specifier refers to.
5295 const IdentifierInfo *Name;
5296
5297 DependentNameType(ElaboratedTypeKeyword Keyword, NestedNameSpecifier *NNS,
5298 const IdentifierInfo *Name, QualType CanonType)
5299 : TypeWithKeyword(Keyword, DependentName, CanonType, /*Dependent=*/true,
5300 /*InstantiationDependent=*/true,
5301 /*VariablyModified=*/false,
5302 NNS->containsUnexpandedParameterPack()),
5303 NNS(NNS), Name(Name) {}
5304
5305public:
5306 /// Retrieve the qualification on this type.
5307 NestedNameSpecifier *getQualifier() const { return NNS; }
5308
5309 /// Retrieve the type named by the typename specifier as an identifier.
5310 ///
5311 /// This routine will return a non-NULL identifier pointer when the
5312 /// form of the original typename was terminated by an identifier,
5313 /// e.g., "typename T::type".
5314 const IdentifierInfo *getIdentifier() const {
5315 return Name;
5316 }
5317
5318 bool isSugared() const { return false; }
5319 QualType desugar() const { return QualType(this, 0); }
5320
5321 void Profile(llvm::FoldingSetNodeID &ID) {
5322 Profile(ID, getKeyword(), NNS, Name);
5323 }
5324
5325 static void Profile(llvm::FoldingSetNodeID &ID, ElaboratedTypeKeyword Keyword,
5326 NestedNameSpecifier *NNS, const IdentifierInfo *Name) {
5327 ID.AddInteger(Keyword);
5328 ID.AddPointer(NNS);
5329 ID.AddPointer(Name);
5330 }
5331
5332 static bool classof(const Type *T) {
5333 return T->getTypeClass() == DependentName;
5334 }
5335};
5336
5337/// Represents a template specialization type whose template cannot be
5338/// resolved, e.g.
5339/// A<T>::template B<T>
5340class alignas(8) DependentTemplateSpecializationType
5341 : public TypeWithKeyword,
5342 public llvm::FoldingSetNode {
5343 friend class ASTContext; // ASTContext creates these
5344
5345 /// The nested name specifier containing the qualifier.
5346 NestedNameSpecifier *NNS;
5347
5348 /// The identifier of the template.
5349 const IdentifierInfo *Name;
5350
5351 DependentTemplateSpecializationType(ElaboratedTypeKeyword Keyword,
5352 NestedNameSpecifier *NNS,
5353 const IdentifierInfo *Name,
5354 ArrayRef<TemplateArgument> Args,
5355 QualType Canon);
5356
5357 const TemplateArgument *getArgBuffer() const {
5358 return reinterpret_cast<const TemplateArgument*>(this+1);
5359 }
5360
5361 TemplateArgument *getArgBuffer() {
5362 return reinterpret_cast<TemplateArgument*>(this+1);
5363 }
5364
5365public:
5366 NestedNameSpecifier *getQualifier() const { return NNS; }
5367 const IdentifierInfo *getIdentifier() const { return Name; }
5368
5369 /// Retrieve the template arguments.
5370 const TemplateArgument *getArgs() const {
5371 return getArgBuffer();
5372 }
5373
5374 /// Retrieve the number of template arguments.
5375 unsigned getNumArgs() const {
5376 return DependentTemplateSpecializationTypeBits.NumArgs;
5377 }
5378
5379 const TemplateArgument &getArg(unsigned Idx) const; // in TemplateBase.h
5380
5381 ArrayRef<TemplateArgument> template_arguments() const {
5382 return {getArgs(), getNumArgs()};
5383 }
5384
5385 using iterator = const TemplateArgument *;
5386
5387 iterator begin() const { return getArgs(); }
5388 iterator end() const; // inline in TemplateBase.h
5389
5390 bool isSugared() const { return false; }
5391 QualType desugar() const { return QualType(this, 0); }
5392
5393 void Profile(llvm::FoldingSetNodeID &ID, const ASTContext &Context) {
5394 Profile(ID, Context, getKeyword(), NNS, Name, {getArgs(), getNumArgs()});
5395 }
5396
5397 static void Profile(llvm::FoldingSetNodeID &ID,
5398 const ASTContext &Context,
5399 ElaboratedTypeKeyword Keyword,
5400 NestedNameSpecifier *Qualifier,
5401 const IdentifierInfo *Name,
5402 ArrayRef<TemplateArgument> Args);
5403
5404 static bool classof(const Type *T) {
5405 return T->getTypeClass() == DependentTemplateSpecialization;
5406 }
5407};
5408
5409/// Represents a pack expansion of types.
5410///
5411/// Pack expansions are part of C++11 variadic templates. A pack
5412/// expansion contains a pattern, which itself contains one or more
5413/// "unexpanded" parameter packs. When instantiated, a pack expansion
5414/// produces a series of types, each instantiated from the pattern of
5415/// the expansion, where the Ith instantiation of the pattern uses the
5416/// Ith arguments bound to each of the unexpanded parameter packs. The
5417/// pack expansion is considered to "expand" these unexpanded
5418/// parameter packs.
5419///
5420/// \code
5421/// template<typename ...Types> struct tuple;
5422///
5423/// template<typename ...Types>
5424/// struct tuple_of_references {
5425/// typedef tuple<Types&...> type;
5426/// };
5427/// \endcode
5428///
5429/// Here, the pack expansion \c Types&... is represented via a
5430/// PackExpansionType whose pattern is Types&.
5431class PackExpansionType : public Type, public llvm::FoldingSetNode {
5432 friend class ASTContext; // ASTContext creates these
5433
5434 /// The pattern of the pack expansion.
5435 QualType Pattern;
5436
5437 PackExpansionType(QualType Pattern, QualType Canon,
5438 Optional<unsigned> NumExpansions)
5439 : Type(PackExpansion, Canon, /*Dependent=*/Pattern->isDependentType(),
5440 /*InstantiationDependent=*/true,
5441 /*VariablyModified=*/Pattern->isVariablyModifiedType(),
5442 /*ContainsUnexpandedParameterPack=*/false),
5443 Pattern(Pattern) {
5444 PackExpansionTypeBits.NumExpansions =
5445 NumExpansions ? *NumExpansions + 1 : 0;
5446 }
5447
5448public:
5449 /// Retrieve the pattern of this pack expansion, which is the
5450 /// type that will be repeatedly instantiated when instantiating the
5451 /// pack expansion itself.
5452 QualType getPattern() const { return Pattern; }
5453
5454 /// Retrieve the number of expansions that this pack expansion will
5455 /// generate, if known.
5456 Optional<unsigned> getNumExpansions() const {
5457 if (PackExpansionTypeBits.NumExpansions)
5458 return PackExpansionTypeBits.NumExpansions - 1;
5459 return None;
5460 }
5461
5462 bool isSugared() const { return !Pattern->isDependentType(); }
5463 QualType desugar() const { return isSugared() ? Pattern : QualType(this, 0); }
5464
5465 void Profile(llvm::FoldingSetNodeID &ID) {
5466 Profile(ID, getPattern(), getNumExpansions());
5467 }
5468
5469 static void Profile(llvm::FoldingSetNodeID &ID, QualType Pattern,
5470 Optional<unsigned> NumExpansions) {
5471 ID.AddPointer(Pattern.getAsOpaquePtr());
5472 ID.AddBoolean(NumExpansions.hasValue());
5473 if (NumExpansions)
5474 ID.AddInteger(*NumExpansions);
5475 }
5476
5477 static bool classof(const Type *T) {
5478 return T->getTypeClass() == PackExpansion;
5479 }
5480};
5481
5482/// This class wraps the list of protocol qualifiers. For types that can
5483/// take ObjC protocol qualifers, they can subclass this class.
5484template <class T>
5485class ObjCProtocolQualifiers {
5486protected:
5487 ObjCProtocolQualifiers() = default;
5488
5489 ObjCProtocolDecl * const *getProtocolStorage() const {
5490 return const_cast<ObjCProtocolQualifiers*>(this)->getProtocolStorage();
5491 }
5492
5493 ObjCProtocolDecl **getProtocolStorage() {
5494 return static_cast<T*>(this)->getProtocolStorageImpl();
5495 }
5496
5497 void setNumProtocols(unsigned N) {
5498 static_cast<T*>(this)->setNumProtocolsImpl(N);
5499 }
5500
5501 void initialize(ArrayRef<ObjCProtocolDecl *> protocols) {
5502 setNumProtocols(protocols.size());
5503 assert(getNumProtocols() == protocols.size() &&((getNumProtocols() == protocols.size() && "bitfield overflow in protocol count"
) ? static_cast<void> (0) : __assert_fail ("getNumProtocols() == protocols.size() && \"bitfield overflow in protocol count\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5504, __PRETTY_FUNCTION__))
5504 "bitfield overflow in protocol count")((getNumProtocols() == protocols.size() && "bitfield overflow in protocol count"
) ? static_cast<void> (0) : __assert_fail ("getNumProtocols() == protocols.size() && \"bitfield overflow in protocol count\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5504, __PRETTY_FUNCTION__))
;
5505 if (!protocols.empty())
5506 memcpy(getProtocolStorage(), protocols.data(),
5507 protocols.size() * sizeof(ObjCProtocolDecl*));
5508 }
5509
5510public:
5511 using qual_iterator = ObjCProtocolDecl * const *;
5512 using qual_range = llvm::iterator_range<qual_iterator>;
5513
5514 qual_range quals() const { return qual_range(qual_begin(), qual_end()); }
5515 qual_iterator qual_begin() const { return getProtocolStorage(); }
5516 qual_iterator qual_end() const { return qual_begin() + getNumProtocols(); }
5517
5518 bool qual_empty() const { return getNumProtocols() == 0; }
5519
5520 /// Return the number of qualifying protocols in this type, or 0 if
5521 /// there are none.
5522 unsigned getNumProtocols() const {
5523 return static_cast<const T*>(this)->getNumProtocolsImpl();
5524 }
5525
5526 /// Fetch a protocol by index.
5527 ObjCProtocolDecl *getProtocol(unsigned I) const {
5528 assert(I < getNumProtocols() && "Out-of-range protocol access")((I < getNumProtocols() && "Out-of-range protocol access"
) ? static_cast<void> (0) : __assert_fail ("I < getNumProtocols() && \"Out-of-range protocol access\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5528, __PRETTY_FUNCTION__))
;
5529 return qual_begin()[I];
5530 }
5531
5532 /// Retrieve all of the protocol qualifiers.
5533 ArrayRef<ObjCProtocolDecl *> getProtocols() const {
5534 return ArrayRef<ObjCProtocolDecl *>(qual_begin(), getNumProtocols());
5535 }
5536};
5537
5538/// Represents a type parameter type in Objective C. It can take
5539/// a list of protocols.
5540class ObjCTypeParamType : public Type,
5541 public ObjCProtocolQualifiers<ObjCTypeParamType>,
5542 public llvm::FoldingSetNode {
5543 friend class ASTContext;
5544 friend class ObjCProtocolQualifiers<ObjCTypeParamType>;
5545
5546 /// The number of protocols stored on this type.
5547 unsigned NumProtocols : 6;
5548
5549 ObjCTypeParamDecl *OTPDecl;
5550
5551 /// The protocols are stored after the ObjCTypeParamType node. In the
5552 /// canonical type, the list of protocols are sorted alphabetically
5553 /// and uniqued.
5554 ObjCProtocolDecl **getProtocolStorageImpl();
5555
5556 /// Return the number of qualifying protocols in this interface type,
5557 /// or 0 if there are none.
5558 unsigned getNumProtocolsImpl() const {
5559 return NumProtocols;
5560 }
5561
5562 void setNumProtocolsImpl(unsigned N) {
5563 NumProtocols = N;
5564 }
5565
5566 ObjCTypeParamType(const ObjCTypeParamDecl *D,
5567 QualType can,
5568 ArrayRef<ObjCProtocolDecl *> protocols);
5569
5570public:
5571 bool isSugared() const { return true; }
5572 QualType desugar() const { return getCanonicalTypeInternal(); }
5573
5574 static bool classof(const Type *T) {
5575 return T->getTypeClass() == ObjCTypeParam;
5576 }
5577
5578 void Profile(llvm::FoldingSetNodeID &ID);
5579 static void Profile(llvm::FoldingSetNodeID &ID,
5580 const ObjCTypeParamDecl *OTPDecl,
5581 ArrayRef<ObjCProtocolDecl *> protocols);
5582
5583 ObjCTypeParamDecl *getDecl() const { return OTPDecl; }
5584};
5585
5586/// Represents a class type in Objective C.
5587///
5588/// Every Objective C type is a combination of a base type, a set of
5589/// type arguments (optional, for parameterized classes) and a list of
5590/// protocols.
5591///
5592/// Given the following declarations:
5593/// \code
5594/// \@class C<T>;
5595/// \@protocol P;
5596/// \endcode
5597///
5598/// 'C' is an ObjCInterfaceType C. It is sugar for an ObjCObjectType
5599/// with base C and no protocols.
5600///
5601/// 'C<P>' is an unspecialized ObjCObjectType with base C and protocol list [P].
5602/// 'C<C*>' is a specialized ObjCObjectType with type arguments 'C*' and no
5603/// protocol list.
5604/// 'C<C*><P>' is a specialized ObjCObjectType with base C, type arguments 'C*',
5605/// and protocol list [P].
5606///
5607/// 'id' is a TypedefType which is sugar for an ObjCObjectPointerType whose
5608/// pointee is an ObjCObjectType with base BuiltinType::ObjCIdType
5609/// and no protocols.
5610///
5611/// 'id<P>' is an ObjCObjectPointerType whose pointee is an ObjCObjectType
5612/// with base BuiltinType::ObjCIdType and protocol list [P]. Eventually
5613/// this should get its own sugar class to better represent the source.
5614class ObjCObjectType : public Type,
5615 public ObjCProtocolQualifiers<ObjCObjectType> {
5616 friend class ObjCProtocolQualifiers<ObjCObjectType>;
5617
5618 // ObjCObjectType.NumTypeArgs - the number of type arguments stored
5619 // after the ObjCObjectPointerType node.
5620 // ObjCObjectType.NumProtocols - the number of protocols stored
5621 // after the type arguments of ObjCObjectPointerType node.
5622 //
5623 // These protocols are those written directly on the type. If
5624 // protocol qualifiers ever become additive, the iterators will need
5625 // to get kindof complicated.
5626 //
5627 // In the canonical object type, these are sorted alphabetically
5628 // and uniqued.
5629
5630 /// Either a BuiltinType or an InterfaceType or sugar for either.
5631 QualType BaseType;
5632
5633 /// Cached superclass type.
5634 mutable llvm::PointerIntPair<const ObjCObjectType *, 1, bool>
5635 CachedSuperClassType;
5636
5637 QualType *getTypeArgStorage();
5638 const QualType *getTypeArgStorage() const {
5639 return const_cast<ObjCObjectType *>(this)->getTypeArgStorage();
5640 }
5641
5642 ObjCProtocolDecl **getProtocolStorageImpl();
5643 /// Return the number of qualifying protocols in this interface type,
5644 /// or 0 if there are none.
5645 unsigned getNumProtocolsImpl() const {
5646 return ObjCObjectTypeBits.NumProtocols;
5647 }
5648 void setNumProtocolsImpl(unsigned N) {
5649 ObjCObjectTypeBits.NumProtocols = N;
5650 }
5651
5652protected:
5653 enum Nonce_ObjCInterface { Nonce_ObjCInterface };
5654
5655 ObjCObjectType(QualType Canonical, QualType Base,
5656 ArrayRef<QualType> typeArgs,
5657 ArrayRef<ObjCProtocolDecl *> protocols,
5658 bool isKindOf);
5659
5660 ObjCObjectType(enum Nonce_ObjCInterface)
5661 : Type(ObjCInterface, QualType(), false, false, false, false),
5662 BaseType(QualType(this_(), 0)) {
5663 ObjCObjectTypeBits.NumProtocols = 0;
5664 ObjCObjectTypeBits.NumTypeArgs = 0;
5665 ObjCObjectTypeBits.IsKindOf = 0;
5666 }
5667
5668 void computeSuperClassTypeSlow() const;
5669
5670public:
5671 /// Gets the base type of this object type. This is always (possibly
5672 /// sugar for) one of:
5673 /// - the 'id' builtin type (as opposed to the 'id' type visible to the
5674 /// user, which is a typedef for an ObjCObjectPointerType)
5675 /// - the 'Class' builtin type (same caveat)
5676 /// - an ObjCObjectType (currently always an ObjCInterfaceType)
5677 QualType getBaseType() const { return BaseType; }
5678
5679 bool isObjCId() const {
5680 return getBaseType()->isSpecificBuiltinType(BuiltinType::ObjCId);
5681 }
5682
5683 bool isObjCClass() const {
5684 return getBaseType()->isSpecificBuiltinType(BuiltinType::ObjCClass);
5685 }
5686
5687 bool isObjCUnqualifiedId() const { return qual_empty() && isObjCId(); }
5688 bool isObjCUnqualifiedClass() const { return qual_empty() && isObjCClass(); }
5689 bool isObjCUnqualifiedIdOrClass() const {
5690 if (!qual_empty()) return false;
5691 if (const BuiltinType *T = getBaseType()->getAs<BuiltinType>())
5692 return T->getKind() == BuiltinType::ObjCId ||
5693 T->getKind() == BuiltinType::ObjCClass;
5694 return false;
5695 }
5696 bool isObjCQualifiedId() const { return !qual_empty() && isObjCId(); }
5697 bool isObjCQualifiedClass() const { return !qual_empty() && isObjCClass(); }
5698
5699 /// Gets the interface declaration for this object type, if the base type
5700 /// really is an interface.
5701 ObjCInterfaceDecl *getInterface() const;
5702
5703 /// Determine whether this object type is "specialized", meaning
5704 /// that it has type arguments.
5705 bool isSpecialized() const;
5706
5707 /// Determine whether this object type was written with type arguments.
5708 bool isSpecializedAsWritten() const {
5709 return ObjCObjectTypeBits.NumTypeArgs > 0;
5710 }
5711
5712 /// Determine whether this object type is "unspecialized", meaning
5713 /// that it has no type arguments.
5714 bool isUnspecialized() const { return !isSpecialized(); }
5715
5716 /// Determine whether this object type is "unspecialized" as
5717 /// written, meaning that it has no type arguments.
5718 bool isUnspecializedAsWritten() const { return !isSpecializedAsWritten(); }
5719
5720 /// Retrieve the type arguments of this object type (semantically).
5721 ArrayRef<QualType> getTypeArgs() const;
5722
5723 /// Retrieve the type arguments of this object type as they were
5724 /// written.
5725 ArrayRef<QualType> getTypeArgsAsWritten() const {
5726 return llvm::makeArrayRef(getTypeArgStorage(),
5727 ObjCObjectTypeBits.NumTypeArgs);
5728 }
5729
5730 /// Whether this is a "__kindof" type as written.
5731 bool isKindOfTypeAsWritten() const { return ObjCObjectTypeBits.IsKindOf; }
5732
5733 /// Whether this ia a "__kindof" type (semantically).
5734 bool isKindOfType() const;
5735
5736 /// Retrieve the type of the superclass of this object type.
5737 ///
5738 /// This operation substitutes any type arguments into the
5739 /// superclass of the current class type, potentially producing a
5740 /// specialization of the superclass type. Produces a null type if
5741 /// there is no superclass.
5742 QualType getSuperClassType() const {
5743 if (!CachedSuperClassType.getInt())
5744 computeSuperClassTypeSlow();
5745
5746 assert(CachedSuperClassType.getInt() && "Superclass not set?")((CachedSuperClassType.getInt() && "Superclass not set?"
) ? static_cast<void> (0) : __assert_fail ("CachedSuperClassType.getInt() && \"Superclass not set?\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 5746, __PRETTY_FUNCTION__))
;
5747 return QualType(CachedSuperClassType.getPointer(), 0);
5748 }
5749
5750 /// Strip off the Objective-C "kindof" type and (with it) any
5751 /// protocol qualifiers.
5752 QualType stripObjCKindOfTypeAndQuals(const ASTContext &ctx) const;
5753
5754 bool isSugared() const { return false; }
5755 QualType desugar() const { return QualType(this, 0); }
5756
5757 static bool classof(const Type *T) {
5758 return T->getTypeClass() == ObjCObject ||
5759 T->getTypeClass() == ObjCInterface;
5760 }
5761};
5762
5763/// A class providing a concrete implementation
5764/// of ObjCObjectType, so as to not increase the footprint of
5765/// ObjCInterfaceType. Code outside of ASTContext and the core type
5766/// system should not reference this type.
5767class ObjCObjectTypeImpl : public ObjCObjectType, public llvm::FoldingSetNode {
5768 friend class ASTContext;
5769
5770 // If anyone adds fields here, ObjCObjectType::getProtocolStorage()
5771 // will need to be modified.
5772
5773 ObjCObjectTypeImpl(QualType Canonical, QualType Base,
5774 ArrayRef<QualType> typeArgs,
5775 ArrayRef<ObjCProtocolDecl *> protocols,
5776 bool isKindOf)
5777 : ObjCObjectType(Canonical, Base, typeArgs, protocols, isKindOf) {}
5778
5779public:
5780 void Profile(llvm::FoldingSetNodeID &ID);
5781 static void Profile(llvm::FoldingSetNodeID &ID,
5782 QualType Base,
5783 ArrayRef<QualType> typeArgs,
5784 ArrayRef<ObjCProtocolDecl *> protocols,
5785 bool isKindOf);
5786};
5787
5788inline QualType *ObjCObjectType::getTypeArgStorage() {
5789 return reinterpret_cast<QualType *>(static_cast<ObjCObjectTypeImpl*>(this)+1);
5790}
5791
5792inline ObjCProtocolDecl **ObjCObjectType::getProtocolStorageImpl() {
5793 return reinterpret_cast<ObjCProtocolDecl**>(
5794 getTypeArgStorage() + ObjCObjectTypeBits.NumTypeArgs);
5795}
5796
5797inline ObjCProtocolDecl **ObjCTypeParamType::getProtocolStorageImpl() {
5798 return reinterpret_cast<ObjCProtocolDecl**>(
5799 static_cast<ObjCTypeParamType*>(this)+1);
5800}
5801
5802/// Interfaces are the core concept in Objective-C for object oriented design.
5803/// They basically correspond to C++ classes. There are two kinds of interface
5804/// types: normal interfaces like `NSString`, and qualified interfaces, which
5805/// are qualified with a protocol list like `NSString<NSCopyable, NSAmazing>`.
5806///
5807/// ObjCInterfaceType guarantees the following properties when considered
5808/// as a subtype of its superclass, ObjCObjectType:
5809/// - There are no protocol qualifiers. To reinforce this, code which
5810/// tries to invoke the protocol methods via an ObjCInterfaceType will
5811/// fail to compile.
5812/// - It is its own base type. That is, if T is an ObjCInterfaceType*,
5813/// T->getBaseType() == QualType(T, 0).
5814class ObjCInterfaceType : public ObjCObjectType {
5815 friend class ASTContext; // ASTContext creates these.
5816 friend class ASTReader;
5817 friend class ObjCInterfaceDecl;
5818
5819 mutable ObjCInterfaceDecl *Decl;
5820
5821 ObjCInterfaceType(const ObjCInterfaceDecl *D)
5822 : ObjCObjectType(Nonce_ObjCInterface),
5823 Decl(const_cast<ObjCInterfaceDecl*>(D)) {}
5824
5825public:
5826 /// Get the declaration of this interface.
5827 ObjCInterfaceDecl *getDecl() const { return Decl; }
5828
5829 bool isSugared() const { return false; }
5830 QualType desugar() const { return QualType(this, 0); }
5831
5832 static bool classof(const Type *T) {
5833 return T->getTypeClass() == ObjCInterface;
5834 }
5835
5836 // Nonsense to "hide" certain members of ObjCObjectType within this
5837 // class. People asking for protocols on an ObjCInterfaceType are
5838 // not going to get what they want: ObjCInterfaceTypes are
5839 // guaranteed to have no protocols.
5840 enum {
5841 qual_iterator,
5842 qual_begin,
5843 qual_end,
5844 getNumProtocols,
5845 getProtocol
5846 };
5847};
5848
5849inline ObjCInterfaceDecl *ObjCObjectType::getInterface() const {
5850 QualType baseType = getBaseType();
5851 while (const auto *ObjT = baseType->getAs<ObjCObjectType>()) {
5852 if (const auto *T = dyn_cast<ObjCInterfaceType>(ObjT))
5853 return T->getDecl();
5854
5855 baseType = ObjT->getBaseType();
5856 }
5857
5858 return nullptr;
5859}
5860
5861/// Represents a pointer to an Objective C object.
5862///
5863/// These are constructed from pointer declarators when the pointee type is
5864/// an ObjCObjectType (or sugar for one). In addition, the 'id' and 'Class'
5865/// types are typedefs for these, and the protocol-qualified types 'id<P>'
5866/// and 'Class<P>' are translated into these.
5867///
5868/// Pointers to pointers to Objective C objects are still PointerTypes;
5869/// only the first level of pointer gets it own type implementation.
5870class ObjCObjectPointerType : public Type, public llvm::FoldingSetNode {
5871 friend class ASTContext; // ASTContext creates these.
5872
5873 QualType PointeeType;
5874
5875 ObjCObjectPointerType(QualType Canonical, QualType Pointee)
5876 : Type(ObjCObjectPointer, Canonical,
5877 Pointee->isDependentType(),
5878 Pointee->isInstantiationDependentType(),
5879 Pointee->isVariablyModifiedType(),
5880 Pointee->containsUnexpandedParameterPack()),
5881 PointeeType(Pointee) {}
5882
5883public:
5884 /// Gets the type pointed to by this ObjC pointer.
5885 /// The result will always be an ObjCObjectType or sugar thereof.
5886 QualType getPointeeType() const { return PointeeType; }
5887
5888 /// Gets the type pointed to by this ObjC pointer. Always returns non-null.
5889 ///
5890 /// This method is equivalent to getPointeeType() except that
5891 /// it discards any typedefs (or other sugar) between this
5892 /// type and the "outermost" object type. So for:
5893 /// \code
5894 /// \@class A; \@protocol P; \@protocol Q;
5895 /// typedef A<P> AP;
5896 /// typedef A A1;
5897 /// typedef A1<P> A1P;
5898 /// typedef A1P<Q> A1PQ;
5899 /// \endcode
5900 /// For 'A*', getObjectType() will return 'A'.
5901 /// For 'A<P>*', getObjectType() will return 'A<P>'.
5902 /// For 'AP*', getObjectType() will return 'A<P>'.
5903 /// For 'A1*', getObjectType() will return 'A'.
5904 /// For 'A1<P>*', getObjectType() will return 'A1<P>'.
5905 /// For 'A1P*', getObjectType() will return 'A1<P>'.
5906 /// For 'A1PQ*', getObjectType() will return 'A1<Q>', because
5907 /// adding protocols to a protocol-qualified base discards the
5908 /// old qualifiers (for now). But if it didn't, getObjectType()
5909 /// would return 'A1P<Q>' (and we'd have to make iterating over
5910 /// qualifiers more complicated).
5911 const ObjCObjectType *getObjectType() const {
5912 return PointeeType->castAs<ObjCObjectType>();
5913 }
5914
5915 /// If this pointer points to an Objective C
5916 /// \@interface type, gets the type for that interface. Any protocol
5917 /// qualifiers on the interface are ignored.
5918 ///
5919 /// \return null if the base type for this pointer is 'id' or 'Class'
5920 const ObjCInterfaceType *getInterfaceType() const;
5921
5922 /// If this pointer points to an Objective \@interface
5923 /// type, gets the declaration for that interface.
5924 ///
5925 /// \return null if the base type for this pointer is 'id' or 'Class'
5926 ObjCInterfaceDecl *getInterfaceDecl() const {
5927 return getObjectType()->getInterface();
5928 }
5929
5930 /// True if this is equivalent to the 'id' type, i.e. if
5931 /// its object type is the primitive 'id' type with no protocols.
5932 bool isObjCIdType() const {
5933 return getObjectType()->isObjCUnqualifiedId();
5934 }
5935
5936 /// True if this is equivalent to the 'Class' type,
5937 /// i.e. if its object tive is the primitive 'Class' type with no protocols.
5938 bool isObjCClassType() const {
5939 return getObjectType()->isObjCUnqualifiedClass();
5940 }
5941
5942 /// True if this is equivalent to the 'id' or 'Class' type,
5943 bool isObjCIdOrClassType() const {
5944 return getObjectType()->isObjCUnqualifiedIdOrClass();
5945 }
5946
5947 /// True if this is equivalent to 'id<P>' for some non-empty set of
5948 /// protocols.
5949 bool isObjCQualifiedIdType() const {
5950 return getObjectType()->isObjCQualifiedId();
5951 }
5952
5953 /// True if this is equivalent to 'Class<P>' for some non-empty set of
5954 /// protocols.
5955 bool isObjCQualifiedClassType() const {
5956 return getObjectType()->isObjCQualifiedClass();
5957 }
5958
5959 /// Whether this is a "__kindof" type.
5960 bool isKindOfType() const { return getObjectType()->isKindOfType(); }
5961
5962 /// Whether this type is specialized, meaning that it has type arguments.
5963 bool isSpecialized() const { return getObjectType()->isSpecialized(); }
5964
5965 /// Whether this type is specialized, meaning that it has type arguments.
5966 bool isSpecializedAsWritten() const {
5967 return getObjectType()->isSpecializedAsWritten();
5968 }
5969
5970 /// Whether this type is unspecialized, meaning that is has no type arguments.
5971 bool isUnspecialized() const { return getObjectType()->isUnspecialized(); }
5972
5973 /// Determine whether this object type is "unspecialized" as
5974 /// written, meaning that it has no type arguments.
5975 bool isUnspecializedAsWritten() const { return !isSpecializedAsWritten(); }
5976
5977 /// Retrieve the type arguments for this type.
5978 ArrayRef<QualType> getTypeArgs() const {
5979 return getObjectType()->getTypeArgs();
5980 }
5981
5982 /// Retrieve the type arguments for this type.
5983 ArrayRef<QualType> getTypeArgsAsWritten() const {
5984 return getObjectType()->getTypeArgsAsWritten();
5985 }
5986
5987 /// An iterator over the qualifiers on the object type. Provided
5988 /// for convenience. This will always iterate over the full set of
5989 /// protocols on a type, not just those provided directly.
5990 using qual_iterator = ObjCObjectType::qual_iterator;
5991 using qual_range = llvm::iterator_range<qual_iterator>;
5992
5993 qual_range quals() const { return qual_range(qual_begin(), qual_end()); }
5994
5995 qual_iterator qual_begin() const {
5996 return getObjectType()->qual_begin();
5997 }
5998
5999 qual_iterator qual_end() const {
6000 return getObjectType()->qual_end();
6001 }
6002
6003 bool qual_empty() const { return getObjectType()->qual_empty(); }
6004
6005 /// Return the number of qualifying protocols on the object type.
6006 unsigned getNumProtocols() const {
6007 return getObjectType()->getNumProtocols();
6008 }
6009
6010 /// Retrieve a qualifying protocol by index on the object type.
6011 ObjCProtocolDecl *getProtocol(unsigned I) const {
6012 return getObjectType()->getProtocol(I);
6013 }
6014
6015 bool isSugared() const { return false; }
6016 QualType desugar() const { return QualType(this, 0); }
6017
6018 /// Retrieve the type of the superclass of this object pointer type.
6019 ///
6020 /// This operation substitutes any type arguments into the
6021 /// superclass of the current class type, potentially producing a
6022 /// pointer to a specialization of the superclass type. Produces a
6023 /// null type if there is no superclass.
6024 QualType getSuperClassType() const;
6025
6026 /// Strip off the Objective-C "kindof" type and (with it) any
6027 /// protocol qualifiers.
6028 const ObjCObjectPointerType *stripObjCKindOfTypeAndQuals(
6029 const ASTContext &ctx) const;
6030
6031 void Profile(llvm::FoldingSetNodeID &ID) {
6032 Profile(ID, getPointeeType());
6033 }
6034
6035 static void Profile(llvm::FoldingSetNodeID &ID, QualType T) {
6036 ID.AddPointer(T.getAsOpaquePtr());
6037 }
6038
6039 static bool classof(const Type *T) {
6040 return T->getTypeClass() == ObjCObjectPointer;
6041 }
6042};
6043
6044class AtomicType : public Type, public llvm::FoldingSetNode {
6045 friend class ASTContext; // ASTContext creates these.
6046
6047 QualType ValueType;
6048
6049 AtomicType(QualType ValTy, QualType Canonical)
6050 : Type(Atomic, Canonical, ValTy->isDependentType(),
6051 ValTy->isInstantiationDependentType(),
6052 ValTy->isVariablyModifiedType(),
6053 ValTy->containsUnexpandedParameterPack()),
6054 ValueType(ValTy) {}
6055
6056public:
6057 /// Gets the type contained by this atomic type, i.e.
6058 /// the type returned by performing an atomic load of this atomic type.
6059 QualType getValueType() const { return ValueType; }
6060
6061 bool isSugared() const { return false; }
6062 QualType desugar() const { return QualType(this, 0); }
6063
6064 void Profile(llvm::FoldingSetNodeID &ID) {
6065 Profile(ID, getValueType());
6066 }
6067
6068 static void Profile(llvm::FoldingSetNodeID &ID, QualType T) {
6069 ID.AddPointer(T.getAsOpaquePtr());
6070 }
6071
6072 static bool classof(const Type *T) {
6073 return T->getTypeClass() == Atomic;
6074 }
6075};
6076
6077/// PipeType - OpenCL20.
6078class PipeType : public Type, public llvm::FoldingSetNode {
6079 friend class ASTContext; // ASTContext creates these.
6080
6081 QualType ElementType;
6082 bool isRead;
6083
6084 PipeType(QualType elemType, QualType CanonicalPtr, bool isRead)
6085 : Type(Pipe, CanonicalPtr, elemType->isDependentType(),
6086 elemType->isInstantiationDependentType(),
6087 elemType->isVariablyModifiedType(),
6088 elemType->containsUnexpandedParameterPack()),
6089 ElementType(elemType), isRead(isRead) {}
6090
6091public:
6092 QualType getElementType() const { return ElementType; }
6093
6094 bool isSugared() const { return false; }
6095
6096 QualType desugar() const { return QualType(this, 0); }
6097
6098 void Profile(llvm::FoldingSetNodeID &ID) {
6099 Profile(ID, getElementType(), isReadOnly());
6100 }
6101
6102 static void Profile(llvm::FoldingSetNodeID &ID, QualType T, bool isRead) {
6103 ID.AddPointer(T.getAsOpaquePtr());
6104 ID.AddBoolean(isRead);
6105 }
6106
6107 static bool classof(const Type *T) {
6108 return T->getTypeClass() == Pipe;
6109 }
6110
6111 bool isReadOnly() const { return isRead; }
6112};
6113
6114/// A qualifier set is used to build a set of qualifiers.
6115class QualifierCollector : public Qualifiers {
6116public:
6117 QualifierCollector(Qualifiers Qs = Qualifiers()) : Qualifiers(Qs) {}
6118
6119 /// Collect any qualifiers on the given type and return an
6120 /// unqualified type. The qualifiers are assumed to be consistent
6121 /// with those already in the type.
6122 const Type *strip(QualType type) {
6123 addFastQualifiers(type.getLocalFastQualifiers());
6124 if (!type.hasLocalNonFastQualifiers())
6125 return type.getTypePtrUnsafe();
6126
6127 const ExtQuals *extQuals = type.getExtQualsUnsafe();
6128 addConsistentQualifiers(extQuals->getQualifiers());
6129 return extQuals->getBaseType();
6130 }
6131
6132 /// Apply the collected qualifiers to the given type.
6133 QualType apply(const ASTContext &Context, QualType QT) const;
6134
6135 /// Apply the collected qualifiers to the given type.
6136 QualType apply(const ASTContext &Context, const Type* T) const;
6137};
6138
6139// Inline function definitions.
6140
6141inline SplitQualType SplitQualType::getSingleStepDesugaredType() const {
6142 SplitQualType desugar =
6143 Ty->getLocallyUnqualifiedSingleStepDesugaredType().split();
6144 desugar.Quals.addConsistentQualifiers(Quals);
6145 return desugar;
6146}
6147
6148inline const Type *QualType::getTypePtr() const {
6149 return getCommonPtr()->BaseType;
6150}
6151
6152inline const Type *QualType::getTypePtrOrNull() const {
6153 return (isNull() ? nullptr : getCommonPtr()->BaseType);
6154}
6155
6156inline SplitQualType QualType::split() const {
6157 if (!hasLocalNonFastQualifiers())
6158 return SplitQualType(getTypePtrUnsafe(),
6159 Qualifiers::fromFastMask(getLocalFastQualifiers()));
6160
6161 const ExtQuals *eq = getExtQualsUnsafe();
6162 Qualifiers qs = eq->getQualifiers();
6163 qs.addFastQualifiers(getLocalFastQualifiers());
6164 return SplitQualType(eq->getBaseType(), qs);
6165}
6166
6167inline Qualifiers QualType::getLocalQualifiers() const {
6168 Qualifiers Quals;
6169 if (hasLocalNonFastQualifiers())
6170 Quals = getExtQualsUnsafe()->getQualifiers();
6171 Quals.addFastQualifiers(getLocalFastQualifiers());
6172 return Quals;
6173}
6174
6175inline Qualifiers QualType::getQualifiers() const {
6176 Qualifiers quals = getCommonPtr()->CanonicalType.getLocalQualifiers();
6177 quals.addFastQualifiers(getLocalFastQualifiers());
6178 return quals;
6179}
6180
6181inline unsigned QualType::getCVRQualifiers() const {
6182 unsigned cvr = getCommonPtr()->CanonicalType.getLocalCVRQualifiers();
6183 cvr |= getLocalCVRQualifiers();
6184 return cvr;
6185}
6186
6187inline QualType QualType::getCanonicalType() const {
6188 QualType canon = getCommonPtr()->CanonicalType;
6189 return canon.withFastQualifiers(getLocalFastQualifiers());
6190}
6191
6192inline bool QualType::isCanonical() const {
6193 return getTypePtr()->isCanonicalUnqualified();
6194}
6195
6196inline bool QualType::isCanonicalAsParam() const {
6197 if (!isCanonical()) return false;
6198 if (hasLocalQualifiers()) return false;
6199
6200 const Type *T = getTypePtr();
6201 if (T->isVariablyModifiedType() && T->hasSizedVLAType())
6202 return false;
6203
6204 return !isa<FunctionType>(T) && !isa<ArrayType>(T);
6205}
6206
6207inline bool QualType::isConstQualified() const {
6208 return isLocalConstQualified() ||
6209 getCommonPtr()->CanonicalType.isLocalConstQualified();
6210}
6211
6212inline bool QualType::isRestrictQualified() const {
6213 return isLocalRestrictQualified() ||
6214 getCommonPtr()->CanonicalType.isLocalRestrictQualified();
6215}
6216
6217
6218inline bool QualType::isVolatileQualified() const {
6219 return isLocalVolatileQualified() ||
6220 getCommonPtr()->CanonicalType.isLocalVolatileQualified();
6221}
6222
6223inline bool QualType::hasQualifiers() const {
6224 return hasLocalQualifiers() ||
6225 getCommonPtr()->CanonicalType.hasLocalQualifiers();
6226}
6227
6228inline QualType QualType::getUnqualifiedType() const {
6229 if (!getTypePtr()->getCanonicalTypeInternal().hasLocalQualifiers())
6230 return QualType(getTypePtr(), 0);
6231
6232 return QualType(getSplitUnqualifiedTypeImpl(*this).Ty, 0);
6233}
6234
6235inline SplitQualType QualType::getSplitUnqualifiedType() const {
6236 if (!getTypePtr()->getCanonicalTypeInternal().hasLocalQualifiers())
6237 return split();
6238
6239 return getSplitUnqualifiedTypeImpl(*this);
6240}
6241
6242inline void QualType::removeLocalConst() {
6243 removeLocalFastQualifiers(Qualifiers::Const);
6244}
6245
6246inline void QualType::removeLocalRestrict() {
6247 removeLocalFastQualifiers(Qualifiers::Restrict);
6248}
6249
6250inline void QualType::removeLocalVolatile() {
6251 removeLocalFastQualifiers(Qualifiers::Volatile);
6252}
6253
6254inline void QualType::removeLocalCVRQualifiers(unsigned Mask) {
6255 assert(!(Mask & ~Qualifiers::CVRMask) && "mask has non-CVR bits")((!(Mask & ~Qualifiers::CVRMask) && "mask has non-CVR bits"
) ? static_cast<void> (0) : __assert_fail ("!(Mask & ~Qualifiers::CVRMask) && \"mask has non-CVR bits\""
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 6255, __PRETTY_FUNCTION__))
;
6256 static_assert((int)Qualifiers::CVRMask == (int)Qualifiers::FastMask,
6257 "Fast bits differ from CVR bits!");
6258
6259 // Fast path: we don't need to touch the slow qualifiers.
6260 removeLocalFastQualifiers(Mask);
6261}
6262
6263/// Return the address space of this type.
6264inline LangAS QualType::getAddressSpace() const {
6265 return getQualifiers().getAddressSpace();
6266}
6267
6268/// Return the gc attribute of this type.
6269inline Qualifiers::GC QualType::getObjCGCAttr() const {
6270 return getQualifiers().getObjCGCAttr();
6271}
6272
6273inline bool QualType::hasNonTrivialToPrimitiveDefaultInitializeCUnion() const {
6274 if (auto *RD = getTypePtr()->getBaseElementTypeUnsafe()->getAsRecordDecl())
6275 return hasNonTrivialToPrimitiveDefaultInitializeCUnion(RD);
6276 return false;
6277}
6278
6279inline bool QualType::hasNonTrivialToPrimitiveDestructCUnion() const {
6280 if (auto *RD = getTypePtr()->getBaseElementTypeUnsafe()->getAsRecordDecl())
6281 return hasNonTrivialToPrimitiveDestructCUnion(RD);
6282 return false;
6283}
6284
6285inline bool QualType::hasNonTrivialToPrimitiveCopyCUnion() const {
6286 if (auto *RD = getTypePtr()->getBaseElementTypeUnsafe()->getAsRecordDecl())
6287 return hasNonTrivialToPrimitiveCopyCUnion(RD);
6288 return false;
6289}
6290
6291inline FunctionType::ExtInfo getFunctionExtInfo(const Type &t) {
6292 if (const auto *PT = t.getAs<PointerType>()) {
6293 if (const auto *FT = PT->getPointeeType()->getAs<FunctionType>())
6294 return FT->getExtInfo();
6295 } else if (const auto *FT = t.getAs<FunctionType>())
6296 return FT->getExtInfo();
6297
6298 return FunctionType::ExtInfo();
6299}
6300
6301inline FunctionType::ExtInfo getFunctionExtInfo(QualType t) {
6302 return getFunctionExtInfo(*t);
6303}
6304
6305/// Determine whether this type is more
6306/// qualified than the Other type. For example, "const volatile int"
6307/// is more qualified than "const int", "volatile int", and
6308/// "int". However, it is not more qualified than "const volatile
6309/// int".
6310inline bool QualType::isMoreQualifiedThan(QualType other) const {
6311 Qualifiers MyQuals = getQualifiers();
6312 Qualifiers OtherQuals = other.getQualifiers();
6313 return (MyQuals != OtherQuals && MyQuals.compatiblyIncludes(OtherQuals));
6314}
6315
6316/// Determine whether this type is at last
6317/// as qualified as the Other type. For example, "const volatile
6318/// int" is at least as qualified as "const int", "volatile int",
6319/// "int", and "const volatile int".
6320inline bool QualType::isAtLeastAsQualifiedAs(QualType other) const {
6321 Qualifiers OtherQuals = other.getQualifiers();
6322
6323 // Ignore __unaligned qualifier if this type is a void.
6324 if (getUnqualifiedType()->isVoidType())
6325 OtherQuals.removeUnaligned();
6326
6327 return getQualifiers().compatiblyIncludes(OtherQuals);
6328}
6329
6330/// If Type is a reference type (e.g., const
6331/// int&), returns the type that the reference refers to ("const
6332/// int"). Otherwise, returns the type itself. This routine is used
6333/// throughout Sema to implement C++ 5p6:
6334///
6335/// If an expression initially has the type "reference to T" (8.3.2,
6336/// 8.5.3), the type is adjusted to "T" prior to any further
6337/// analysis, the expression designates the object or function
6338/// denoted by the reference, and the expression is an lvalue.
6339inline QualType QualType::getNonReferenceType() const {
6340 if (const auto *RefType = (*this)->getAs<ReferenceType>())
6341 return RefType->getPointeeType();
6342 else
6343 return *this;
6344}
6345
6346inline bool QualType::isCForbiddenLValueType() const {
6347 return ((getTypePtr()->isVoidType() && !hasQualifiers()) ||
6348 getTypePtr()->isFunctionType());
6349}
6350
6351/// Tests whether the type is categorized as a fundamental type.
6352///
6353/// \returns True for types specified in C++0x [basic.fundamental].
6354inline bool Type::isFundamentalType() const {
6355 return isVoidType() ||
6356 isNullPtrType() ||
6357 // FIXME: It's really annoying that we don't have an
6358 // 'isArithmeticType()' which agrees with the standard definition.
6359 (isArithmeticType() && !isEnumeralType());
6360}
6361
6362/// Tests whether the type is categorized as a compound type.
6363///
6364/// \returns True for types specified in C++0x [basic.compound].
6365inline bool Type::isCompoundType() const {
6366 // C++0x [basic.compound]p1:
6367 // Compound types can be constructed in the following ways:
6368 // -- arrays of objects of a given type [...];
6369 return isArrayType() ||
6370 // -- functions, which have parameters of given types [...];
6371 isFunctionType() ||
6372 // -- pointers to void or objects or functions [...];
6373 isPointerType() ||
6374 // -- references to objects or functions of a given type. [...]
6375 isReferenceType() ||
6376 // -- classes containing a sequence of objects of various types, [...];
6377 isRecordType() ||
6378 // -- unions, which are classes capable of containing objects of different
6379 // types at different times;
6380 isUnionType() ||
6381 // -- enumerations, which comprise a set of named constant values. [...];
6382 isEnumeralType() ||
6383 // -- pointers to non-static class members, [...].
6384 isMemberPointerType();
6385}
6386
6387inline bool Type::isFunctionType() const {
6388 return isa<FunctionType>(CanonicalType);
6389}
6390
6391inline bool Type::isPointerType() const {
6392 return isa<PointerType>(CanonicalType);
6393}
6394
6395inline bool Type::isAnyPointerType() const {
6396 return isPointerType() || isObjCObjectPointerType();
6397}
6398
6399inline bool Type::isBlockPointerType() const {
6400 return isa<BlockPointerType>(CanonicalType);
6401}
6402
6403inline bool Type::isReferenceType() const {
6404 return isa<ReferenceType>(CanonicalType);
6405}
6406
6407inline bool Type::isLValueReferenceType() const {
6408 return isa<LValueReferenceType>(CanonicalType);
6409}
6410
6411inline bool Type::isRValueReferenceType() const {
6412 return isa<RValueReferenceType>(CanonicalType);
6413}
6414
6415inline bool Type::isFunctionPointerType() const {
6416 if (const auto *T = getAs<PointerType>())
6417 return T->getPointeeType()->isFunctionType();
6418 else
6419 return false;
6420}
6421
6422inline bool Type::isFunctionReferenceType() const {
6423 if (const auto *T = getAs<ReferenceType>())
6424 return T->getPointeeType()->isFunctionType();
6425 else
6426 return false;
6427}
6428
6429inline bool Type::isMemberPointerType() const {
6430 return isa<MemberPointerType>(CanonicalType);
6431}
6432
6433inline bool Type::isMemberFunctionPointerType() const {
6434 if (const auto *T = getAs<MemberPointerType>())
6435 return T->isMemberFunctionPointer();
6436 else
6437 return false;
6438}
6439
6440inline bool Type::isMemberDataPointerType() const {
6441 if (const auto *T = getAs<MemberPointerType>())
6442 return T->isMemberDataPointer();
6443 else
6444 return false;
6445}
6446
6447inline bool Type::isArrayType() const {
6448 return isa<ArrayType>(CanonicalType);
6449}
6450
6451inline bool Type::isConstantArrayType() const {
6452 return isa<ConstantArrayType>(CanonicalType);
6453}
6454
6455inline bool Type::isIncompleteArrayType() const {
6456 return isa<IncompleteArrayType>(CanonicalType);
6457}
6458
6459inline bool Type::isVariableArrayType() const {
6460 return isa<VariableArrayType>(CanonicalType);
6461}
6462
6463inline bool Type::isDependentSizedArrayType() const {
6464 return isa<DependentSizedArrayType>(CanonicalType);
6465}
6466
6467inline bool Type::isBuiltinType() const {
6468 return isa<BuiltinType>(CanonicalType);
6469}
6470
6471inline bool Type::isRecordType() const {
6472 return isa<RecordType>(CanonicalType);
75
Assuming field 'CanonicalType' is a 'RecordType'
76
Returning the value 1, which participates in a condition later
6473}
6474
6475inline bool Type::isEnumeralType() const {
6476 return isa<EnumType>(CanonicalType);
6477}
6478
6479inline bool Type::isAnyComplexType() const {
6480 return isa<ComplexType>(CanonicalType);
6481}
6482
6483inline bool Type::isVectorType() const {
6484 return isa<VectorType>(CanonicalType);
6485}
6486
6487inline bool Type::isExtVectorType() const {
6488 return isa<ExtVectorType>(CanonicalType);
6489}
6490
6491inline bool Type::isDependentAddressSpaceType() const {
6492 return isa<DependentAddressSpaceType>(CanonicalType);
6493}
6494
6495inline bool Type::isObjCObjectPointerType() const {
6496 return isa<ObjCObjectPointerType>(CanonicalType);
6497}
6498
6499inline bool Type::isObjCObjectType() const {
6500 return isa<ObjCObjectType>(CanonicalType);
6501}
6502
6503inline bool Type::isObjCObjectOrInterfaceType() const {
6504 return isa<ObjCInterfaceType>(CanonicalType) ||
6505 isa<ObjCObjectType>(CanonicalType);
6506}
6507
6508inline bool Type::isAtomicType() const {
6509 return isa<AtomicType>(CanonicalType);
6510}
6511
6512inline bool Type::isObjCQualifiedIdType() const {
6513 if (const auto *OPT = getAs<ObjCObjectPointerType>())
6514 return OPT->isObjCQualifiedIdType();
6515 return false;
6516}
6517
6518inline bool Type::isObjCQualifiedClassType() const {
6519 if (const auto *OPT = getAs<ObjCObjectPointerType>())
6520 return OPT->isObjCQualifiedClassType();
6521 return false;
6522}
6523
6524inline bool Type::isObjCIdType() const {
6525 if (const auto *OPT = getAs<ObjCObjectPointerType>())
6526 return OPT->isObjCIdType();
6527 return false;
6528}
6529
6530inline bool Type::isObjCClassType() const {
6531 if (const auto *OPT = getAs<ObjCObjectPointerType>())
6532 return OPT->isObjCClassType();
6533 return false;
6534}
6535
6536inline bool Type::isObjCSelType() const {
6537 if (const auto *OPT = getAs<PointerType>())
6538 return OPT->getPointeeType()->isSpecificBuiltinType(BuiltinType::ObjCSel);
6539 return false;
6540}
6541
6542inline bool Type::isObjCBuiltinType() const {
6543 return isObjCIdType() || isObjCClassType() || isObjCSelType();
6544}
6545
6546inline bool Type::isDecltypeType() const {
6547 return isa<DecltypeType>(this);
6548}
6549
6550#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) \
6551 inline bool Type::is##Id##Type() const { \
6552 return isSpecificBuiltinType(BuiltinType::Id); \
6553 }
6554#include "clang/Basic/OpenCLImageTypes.def"
6555
6556inline bool Type::isSamplerT() const {
6557 return isSpecificBuiltinType(BuiltinType::OCLSampler);
6558}
6559
6560inline bool Type::isEventT() const {
6561 return isSpecificBuiltinType(BuiltinType::OCLEvent);
6562}
6563
6564inline bool Type::isClkEventT() const {
6565 return isSpecificBuiltinType(BuiltinType::OCLClkEvent);
6566}
6567
6568inline bool Type::isQueueT() const {
6569 return isSpecificBuiltinType(BuiltinType::OCLQueue);
6570}
6571
6572inline bool Type::isReserveIDT() const {
6573 return isSpecificBuiltinType(BuiltinType::OCLReserveID);
6574}
6575
6576inline bool Type::isImageType() const {
6577#define IMAGE_TYPE(ImgType, Id, SingletonId, Access, Suffix) is##Id##Type() ||
6578 return
6579#include "clang/Basic/OpenCLImageTypes.def"
6580 false; // end boolean or operation
6581}
6582
6583inline bool Type::isPipeType() const {
6584 return isa<PipeType>(CanonicalType);
6585}
6586
6587#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) \
6588 inline bool Type::is##Id##Type() const { \
6589 return isSpecificBuiltinType(BuiltinType::Id); \
6590 }
6591#include "clang/Basic/OpenCLExtensionTypes.def"
6592
6593inline bool Type::isOCLIntelSubgroupAVCType() const {
6594#define INTEL_SUBGROUP_AVC_TYPE(ExtType, Id) \
6595 isOCLIntelSubgroupAVC##Id##Type() ||
6596 return
6597#include "clang/Basic/OpenCLExtensionTypes.def"
6598 false; // end of boolean or operation
6599}
6600
6601inline bool Type::isOCLExtOpaqueType() const {
6602#define EXT_OPAQUE_TYPE(ExtType, Id, Ext) is##Id##Type() ||
6603 return
6604#include "clang/Basic/OpenCLExtensionTypes.def"
6605 false; // end of boolean or operation
6606}
6607
6608inline bool Type::isOpenCLSpecificType() const {
6609 return isSamplerT() || isEventT() || isImageType() || isClkEventT() ||
6610 isQueueT() || isReserveIDT() || isPipeType() || isOCLExtOpaqueType();
6611}
6612
6613inline bool Type::isTemplateTypeParmType() const {
6614 return isa<TemplateTypeParmType>(CanonicalType);
6615}
6616
6617inline bool Type::isSpecificBuiltinType(unsigned K) const {
6618 if (const BuiltinType *BT = getAs<BuiltinType>())
6619 if (BT->getKind() == (BuiltinType::Kind) K)
6620 return true;
6621 return false;
6622}
6623
6624inline bool Type::isPlaceholderType() const {
6625 if (const auto *BT = dyn_cast<BuiltinType>(this))
6626 return BT->isPlaceholderType();
6627 return false;
6628}
6629
6630inline const BuiltinType *Type::getAsPlaceholderType() const {
6631 if (const auto *BT = dyn_cast<BuiltinType>(this))
6632 if (BT->isPlaceholderType())
6633 return BT;
6634 return nullptr;
6635}
6636
6637inline bool Type::isSpecificPlaceholderType(unsigned K) const {
6638 assert(BuiltinType::isPlaceholderTypeKind((BuiltinType::Kind) K))((BuiltinType::isPlaceholderTypeKind((BuiltinType::Kind) K)) ?
static_cast<void> (0) : __assert_fail ("BuiltinType::isPlaceholderTypeKind((BuiltinType::Kind) K)"
, "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 6638, __PRETTY_FUNCTION__))
;
6639 if (const auto *BT = dyn_cast<BuiltinType>(this))
6640 return (BT->getKind() == (BuiltinType::Kind) K);
6641 return false;
6642}
6643
6644inline bool Type::isNonOverloadPlaceholderType() const {
6645 if (const auto *BT = dyn_cast<BuiltinType>(this))
6646 return BT->isNonOverloadPlaceholderType();
6647 return false;
6648}
6649
6650inline bool Type::isVoidType() const {
6651 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
6652 return BT->getKind() == BuiltinType::Void;
6653 return false;
6654}
6655
6656inline bool Type::isHalfType() const {
6657 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
6658 return BT->getKind() == BuiltinType::Half;
6659 // FIXME: Should we allow complex __fp16? Probably not.
6660 return false;
6661}
6662
6663inline bool Type::isFloat16Type() const {
6664 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
6665 return BT->getKind() == BuiltinType::Float16;
6666 return false;
6667}
6668
6669inline bool Type::isFloat128Type() const {
6670 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
6671 return BT->getKind() == BuiltinType::Float128;
6672 return false;
6673}
6674
6675inline bool Type::isNullPtrType() const {
6676 if (const auto *BT = getAs<BuiltinType>())
6677 return BT->getKind() == BuiltinType::NullPtr;
6678 return false;
6679}
6680
6681bool IsEnumDeclComplete(EnumDecl *);
6682bool IsEnumDeclScoped(EnumDecl *);
6683
6684inline bool Type::isIntegerType() const {
6685 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
6686 return BT->getKind() >= BuiltinType::Bool &&
6687 BT->getKind() <= BuiltinType::Int128;
6688 if (const EnumType *ET = dyn_cast<EnumType>(CanonicalType)) {
6689 // Incomplete enum types are not treated as integer types.
6690 // FIXME: In C++, enum types are never integer types.
6691 return IsEnumDeclComplete(ET->getDecl()) &&
6692 !IsEnumDeclScoped(ET->getDecl());
6693 }
6694 return false;
6695}
6696
6697inline bool Type::isFixedPointType() const {
6698 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType)) {
6699 return BT->getKind() >= BuiltinType::ShortAccum &&
6700 BT->getKind() <= BuiltinType::SatULongFract;
6701 }
6702 return false;
6703}
6704
6705inline bool Type::isFixedPointOrIntegerType() const {
6706 return isFixedPointType() || isIntegerType();
6707}
6708
6709inline bool Type::isSaturatedFixedPointType() const {
6710 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType)) {
6711 return BT->getKind() >= BuiltinType::SatShortAccum &&
6712 BT->getKind() <= BuiltinType::SatULongFract;
6713 }
6714 return false;
6715}
6716
6717inline bool Type::isUnsaturatedFixedPointType() const {
6718 return isFixedPointType() && !isSaturatedFixedPointType();
6719}
6720
6721inline bool Type::isSignedFixedPointType() const {
6722 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType)) {
6723 return ((BT->getKind() >= BuiltinType::ShortAccum &&
6724 BT->getKind() <= BuiltinType::LongAccum) ||
6725 (BT->getKind() >= BuiltinType::ShortFract &&
6726 BT->getKind() <= BuiltinType::LongFract) ||
6727 (BT->getKind() >= BuiltinType::SatShortAccum &&
6728 BT->getKind() <= BuiltinType::SatLongAccum) ||
6729 (BT->getKind() >= BuiltinType::SatShortFract &&
6730 BT->getKind() <= BuiltinType::SatLongFract));
6731 }
6732 return false;
6733}
6734
6735inline bool Type::isUnsignedFixedPointType() const {
6736 return isFixedPointType() && !isSignedFixedPointType();
6737}
6738
6739inline bool Type::isScalarType() const {
6740 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
6741 return BT->getKind() > BuiltinType::Void &&
6742 BT->getKind() <= BuiltinType::NullPtr;
6743 if (const EnumType *ET = dyn_cast<EnumType>(CanonicalType))
6744 // Enums are scalar types, but only if they are defined. Incomplete enums
6745 // are not treated as scalar types.
6746 return IsEnumDeclComplete(ET->getDecl());
6747 return isa<PointerType>(CanonicalType) ||
6748 isa<BlockPointerType>(CanonicalType) ||
6749 isa<MemberPointerType>(CanonicalType) ||
6750 isa<ComplexType>(CanonicalType) ||
6751 isa<ObjCObjectPointerType>(CanonicalType);
6752}
6753
6754inline bool Type::isIntegralOrEnumerationType() const {
6755 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
6756 return BT->getKind() >= BuiltinType::Bool &&
6757 BT->getKind() <= BuiltinType::Int128;
6758
6759 // Check for a complete enum type; incomplete enum types are not properly an
6760 // enumeration type in the sense required here.
6761 if (const auto *ET = dyn_cast<EnumType>(CanonicalType))
6762 return IsEnumDeclComplete(ET->getDecl());
6763
6764 return false;
6765}
6766
6767inline bool Type::isBooleanType() const {
6768 if (const auto *BT = dyn_cast<BuiltinType>(CanonicalType))
6769 return BT->getKind() == BuiltinType::Bool;
6770 return false;
6771}
6772
6773inline bool Type::isUndeducedType() const {
6774 auto *DT = getContainedDeducedType();
6775 return DT && !DT->isDeduced();
6776}
6777
6778/// Determines whether this is a type for which one can define
6779/// an overloaded operator.
6780inline bool Type::isOverloadableType() const {
6781 return isDependentType() || isRecordType() || isEnumeralType();
6782}
6783
6784/// Determines whether this type can decay to a pointer type.
6785inline bool Type::canDecayToPointerType() const {
6786 return isFunctionType() || isArrayType();
6787}
6788
6789inline bool Type::hasPointerRepresentation() const {
6790 return (isPointerType() || isReferenceType() || isBlockPointerType() ||
6791 isObjCObjectPointerType() || isNullPtrType());
6792}
6793
6794inline bool Type::hasObjCPointerRepresentation() const {
6795 return isObjCObjectPointerType();
6796}
6797
6798inline const Type *Type::getBaseElementTypeUnsafe() const {
6799 const Type *type = this;
6800 while (const ArrayType *arrayType = type->getAsArrayTypeUnsafe())
6801 type = arrayType->getElementType().getTypePtr();
6802 return type;
6803}
6804
6805inline const Type *Type::getPointeeOrArrayElementType() const {
6806 const Type *type = this;
6807 if (type->isAnyPointerType())
6808 return type->getPointeeType().getTypePtr();
6809 else if (type->isArrayType())
6810 return type->getBaseElementTypeUnsafe();
6811 return type;
6812}
6813
6814/// Insertion operator for diagnostics. This allows sending Qualifiers into a
6815/// diagnostic with <<.
6816inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
6817 Qualifiers Q) {
6818 DB.AddTaggedVal(Q.getAsOpaqueValue(),
6819 DiagnosticsEngine::ArgumentKind::ak_qual);
6820 return DB;
6821}
6822
6823/// Insertion operator for partial diagnostics. This allows sending Qualifiers
6824/// into a diagnostic with <<.
6825inline const PartialDiagnostic &operator<<(const PartialDiagnostic &PD,
6826 Qualifiers Q) {
6827 PD.AddTaggedVal(Q.getAsOpaqueValue(),
6828 DiagnosticsEngine::ArgumentKind::ak_qual);
6829 return PD;
6830}
6831
6832/// Insertion operator for diagnostics. This allows sending QualType's into a
6833/// diagnostic with <<.
6834inline const DiagnosticBuilder &operator<<(const DiagnosticBuilder &DB,
6835 QualType T) {
6836 DB.AddTaggedVal(reinterpret_cast<intptr_t>(T.getAsOpaquePtr()),
6837 DiagnosticsEngine::ak_qualtype);
6838 return DB;
6839}
6840
6841/// Insertion operator for partial diagnostics. This allows sending QualType's
6842/// into a diagnostic with <<.
6843inline const PartialDiagnostic &operator<<(const PartialDiagnostic &PD,
6844 QualType T) {
6845 PD.AddTaggedVal(reinterpret_cast<intptr_t>(T.getAsOpaquePtr()),
6846 DiagnosticsEngine::ak_qualtype);
6847 return PD;
6848}
6849
6850// Helper class template that is used by Type::getAs to ensure that one does
6851// not try to look through a qualified type to get to an array type.
6852template <typename T>
6853using TypeIsArrayType =
6854 std::integral_constant<bool, std::is_same<T, ArrayType>::value ||
6855 std::is_base_of<ArrayType, T>::value>;
6856
6857// Member-template getAs<specific type>'.
6858template <typename T> const T *Type::getAs() const {
6859 static_assert(!TypeIsArrayType<T>::value,
6860 "ArrayType cannot be used with getAs!");
6861
6862 // If this is directly a T type, return it.
6863 if (const auto *Ty = dyn_cast<T>(this))
6864 return Ty;
6865
6866 // If the canonical form of this type isn't the right kind, reject it.
6867 if (!isa<T>(CanonicalType))
6868 return nullptr;
6869
6870 // If this is a typedef for the type, strip the typedef off without
6871 // losing all typedef information.
6872 return cast<T>(getUnqualifiedDesugaredType());
6873}
6874
6875template <typename T> const T *Type::getAsAdjusted() const {
6876 static_assert(!TypeIsArrayType<T>::value, "ArrayType cannot be used with getAsAdjusted!");
6877
6878 // If this is directly a T type, return it.
6879 if (const auto *Ty = dyn_cast<T>(this))
6880 return Ty;
6881
6882 // If the canonical form of this type isn't the right kind, reject it.
6883 if (!isa<T>(CanonicalType))
6884 return nullptr;
6885
6886 // Strip off type adjustments that do not modify the underlying nature of the
6887 // type.
6888 const Type *Ty = this;
6889 while (Ty) {
6890 if (const auto *A = dyn_cast<AttributedType>(Ty))
6891 Ty = A->getModifiedType().getTypePtr();
6892 else if (const auto *E = dyn_cast<ElaboratedType>(Ty))
6893 Ty = E->desugar().getTypePtr();
6894 else if (const auto *P = dyn_cast<ParenType>(Ty))
6895 Ty = P->desugar().getTypePtr();
6896 else if (const auto *A = dyn_cast<AdjustedType>(Ty))
6897 Ty = A->desugar().getTypePtr();
6898 else if (const auto *M = dyn_cast<MacroQualifiedType>(Ty))
6899 Ty = M->desugar().getTypePtr();
6900 else
6901 break;
6902 }
6903
6904 // Just because the canonical type is correct does not mean we can use cast<>,
6905 // since we may not have stripped off all the sugar down to the base type.
6906 return dyn_cast<T>(Ty);
6907}
6908
6909inline const ArrayType *Type::getAsArrayTypeUnsafe() const {
6910 // If this is directly an array type, return it.
6911 if (const auto *arr = dyn_cast<ArrayType>(this))
6912 return arr;
6913
6914 // If the canonical form of this type isn't the right kind, reject it.
6915 if (!isa<ArrayType>(CanonicalType))
6916 return nullptr;
6917
6918 // If this is a typedef for the type, strip the typedef off without
6919 // losing all typedef information.
6920 return cast<ArrayType>(getUnqualifiedDesugaredType());
6921}
6922
6923template <typename T> const T *Type::castAs() const {
6924 static_assert(!TypeIsArrayType<T>::value,
6925 "ArrayType cannot be used with castAs!");
6926
6927 if (const auto *ty = dyn_cast<T>(this)) return ty;
6928 assert(isa<T>(CanonicalType))((isa<T>(CanonicalType)) ? static_cast<void> (0) :
__assert_fail ("isa<T>(CanonicalType)", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 6928, __PRETTY_FUNCTION__))
;
6929 return cast<T>(getUnqualifiedDesugaredType());
6930}
6931
6932inline const ArrayType *Type::castAsArrayTypeUnsafe() const {
6933 assert(isa<ArrayType>(CanonicalType))((isa<ArrayType>(CanonicalType)) ? static_cast<void>
(0) : __assert_fail ("isa<ArrayType>(CanonicalType)", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 6933, __PRETTY_FUNCTION__))
;
6934 if (const auto *arr = dyn_cast<ArrayType>(this)) return arr;
6935 return cast<ArrayType>(getUnqualifiedDesugaredType());
6936}
6937
6938DecayedType::DecayedType(QualType OriginalType, QualType DecayedPtr,
6939 QualType CanonicalPtr)
6940 : AdjustedType(Decayed, OriginalType, DecayedPtr, CanonicalPtr) {
6941#ifndef NDEBUG
6942 QualType Adjusted = getAdjustedType();
6943 (void)AttributedType::stripOuterNullability(Adjusted);
6944 assert(isa<PointerType>(Adjusted))((isa<PointerType>(Adjusted)) ? static_cast<void>
(0) : __assert_fail ("isa<PointerType>(Adjusted)", "/build/llvm-toolchain-snapshot-10~svn373517/tools/clang/include/clang/AST/Type.h"
, 6944, __PRETTY_FUNCTION__))
;
6945#endif
6946}
6947
6948QualType DecayedType::getPointeeType() const {
6949 QualType Decayed = getDecayedType();
6950 (void)AttributedType::stripOuterNullability(Decayed);
6951 return cast<PointerType>(Decayed)->getPointeeType();
6952}
6953
6954// Get the decimal string representation of a fixed point type, represented
6955// as a scaled integer.
6956// TODO: At some point, we should change the arguments to instead just accept an
6957// APFixedPoint instead of APSInt and scale.
6958void FixedPointValueToString(SmallVectorImpl<char> &Str, llvm::APSInt Val,
6959 unsigned Scale);
6960
6961} // namespace clang
6962
6963#endif // LLVM_CLANG_AST_TYPE_H