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