clang  16.0.0git
RewriteModernObjC.cpp
Go to the documentation of this file.
1 //===-- RewriteModernObjC.cpp - Playground for the code rewriter ----------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // Hacks and fun related to the code rewriter.
10 //
11 //===----------------------------------------------------------------------===//
12 
14 #include "clang/AST/AST.h"
15 #include "clang/AST/ASTConsumer.h"
16 #include "clang/AST/Attr.h"
17 #include "clang/AST/ParentMap.h"
18 #include "clang/Basic/CharInfo.h"
19 #include "clang/Basic/Diagnostic.h"
22 #include "clang/Basic/TargetInfo.h"
23 #include "clang/Config/config.h"
24 #include "clang/Lex/Lexer.h"
26 #include "llvm/ADT/DenseSet.h"
27 #include "llvm/ADT/SetVector.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 
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;
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.
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 
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 auto *BPT = T->castAs<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.ObjC)
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_PRValue, Kind, E, nullptr,
590  FPOptionsOverride(), TInfo,
592  }
593 
594  bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const {
595  IdentifierInfo* II = &Context->Idents.get("load");
596  Selector LoadSel = Context->Selectors.getSelector(0, &II);
597  return OD->getClassMethod(LoadSel) != nullptr;
598  }
599 
600  StringLiteral *getStringLiteral(StringRef Str) {
601  QualType StrType = Context->getConstantArrayType(
602  Context->CharTy, llvm::APInt(32, Str.size() + 1), nullptr,
603  ArrayType::Normal, 0);
604  return StringLiteral::Create(*Context, Str, StringLiteral::Ordinary,
605  /*Pascal=*/false, StrType, SourceLocation());
606  }
607  };
608 } // end anonymous namespace
609 
610 void RewriteModernObjC::RewriteBlocksInFunctionProtoType(QualType funcType,
611  NamedDecl *D) {
612  if (const FunctionProtoType *fproto
613  = dyn_cast<FunctionProtoType>(funcType.IgnoreParens())) {
614  for (const auto &I : fproto->param_types())
615  if (isTopLevelBlockPointerType(I)) {
616  // All the args are checked/rewritten. Don't call twice!
617  RewriteBlockPointerDecl(D);
618  break;
619  }
620  }
621 }
622 
623 void RewriteModernObjC::CheckFunctionPointerDecl(QualType funcType, NamedDecl *ND) {
624  const PointerType *PT = funcType->getAs<PointerType>();
625  if (PT && PointerTypeTakesAnyBlockArguments(funcType))
626  RewriteBlocksInFunctionProtoType(PT->getPointeeType(), ND);
627 }
628 
629 static bool IsHeaderFile(const std::string &Filename) {
630  std::string::size_type DotPos = Filename.rfind('.');
631 
632  if (DotPos == std::string::npos) {
633  // no file extension
634  return false;
635  }
636 
637  std::string Ext = Filename.substr(DotPos + 1);
638  // C header: .h
639  // C++ header: .hh or .H;
640  return Ext == "h" || Ext == "hh" || Ext == "H";
641 }
642 
643 RewriteModernObjC::RewriteModernObjC(std::string inFile,
644  std::unique_ptr<raw_ostream> OS,
646  const LangOptions &LOpts,
647  bool silenceMacroWarn, bool LineInfo)
648  : Diags(D), LangOpts(LOpts), InFileName(inFile), OutFile(std::move(OS)),
649  SilenceRewriteMacroWarning(silenceMacroWarn), GenerateLineInfo(LineInfo) {
650  IsHeader = IsHeaderFile(inFile);
651  RewriteFailedDiag = Diags.getCustomDiagID(DiagnosticsEngine::Warning,
652  "rewriting sub-expression within a macro (may not be correct)");
653  // FIXME. This should be an error. But if block is not called, it is OK. And it
654  // may break including some headers.
655  GlobalBlockRewriteFailedDiag = Diags.getCustomDiagID(DiagnosticsEngine::Warning,
656  "rewriting block literal declared in global scope is not implemented");
657 
658  TryFinallyContainsReturnDiag = Diags.getCustomDiagID(
660  "rewriter doesn't support user-specified control flow semantics "
661  "for @try/@finally (code may not execute properly)");
662 }
663 
664 std::unique_ptr<ASTConsumer> clang::CreateModernObjCRewriter(
665  const std::string &InFile, std::unique_ptr<raw_ostream> OS,
666  DiagnosticsEngine &Diags, const LangOptions &LOpts,
667  bool SilenceRewriteMacroWarning, bool LineInfo) {
668  return std::make_unique<RewriteModernObjC>(InFile, std::move(OS), Diags,
669  LOpts, SilenceRewriteMacroWarning,
670  LineInfo);
671 }
672 
673 void RewriteModernObjC::InitializeCommon(ASTContext &context) {
674  Context = &context;
675  SM = &Context->getSourceManager();
676  TUDecl = Context->getTranslationUnitDecl();
677  MsgSendFunctionDecl = nullptr;
678  MsgSendSuperFunctionDecl = nullptr;
679  MsgSendStretFunctionDecl = nullptr;
680  MsgSendSuperStretFunctionDecl = nullptr;
681  MsgSendFpretFunctionDecl = nullptr;
682  GetClassFunctionDecl = nullptr;
683  GetMetaClassFunctionDecl = nullptr;
684  GetSuperClassFunctionDecl = nullptr;
685  SelGetUidFunctionDecl = nullptr;
686  CFStringFunctionDecl = nullptr;
687  ConstantStringClassReference = nullptr;
688  NSStringRecord = nullptr;
689  CurMethodDef = nullptr;
690  CurFunctionDef = nullptr;
691  GlobalVarDecl = nullptr;
692  GlobalConstructionExp = nullptr;
693  SuperStructDecl = nullptr;
694  ProtocolTypeDecl = nullptr;
695  ConstantStringDecl = nullptr;
696  BcLabelCount = 0;
697  SuperConstructorFunctionDecl = nullptr;
698  NumObjCStringLiterals = 0;
699  PropParentMap = nullptr;
700  CurrentBody = nullptr;
701  DisableReplaceStmt = false;
702  objc_impl_method = false;
703 
704  // Get the ID and start/end of the main file.
705  MainFileID = SM->getMainFileID();
706  llvm::MemoryBufferRef MainBuf = SM->getBufferOrFake(MainFileID);
707  MainFileStart = MainBuf.getBufferStart();
708  MainFileEnd = MainBuf.getBufferEnd();
709 
710  Rewrite.setSourceMgr(Context->getSourceManager(), Context->getLangOpts());
711 }
712 
713 //===----------------------------------------------------------------------===//
714 // Top Level Driver Code
715 //===----------------------------------------------------------------------===//
716 
717 void RewriteModernObjC::HandleTopLevelSingleDecl(Decl *D) {
718  if (Diags.hasErrorOccurred())
719  return;
720 
721  // Two cases: either the decl could be in the main file, or it could be in a
722  // #included file. If the former, rewrite it now. If the later, check to see
723  // if we rewrote the #include/#import.
724  SourceLocation Loc = D->getLocation();
725  Loc = SM->getExpansionLoc(Loc);
726 
727  // If this is for a builtin, ignore it.
728  if (Loc.isInvalid()) return;
729 
730  // Look for built-in declarations that we need to refer during the rewrite.
731  if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
732  RewriteFunctionDecl(FD);
733  } else if (VarDecl *FVD = dyn_cast<VarDecl>(D)) {
734  // declared in <Foundation/NSString.h>
735  if (FVD->getName() == "_NSConstantStringClassReference") {
736  ConstantStringClassReference = FVD;
737  return;
738  }
739  } else if (ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(D)) {
740  RewriteCategoryDecl(CD);
741  } else if (ObjCProtocolDecl *PD = dyn_cast<ObjCProtocolDecl>(D)) {
742  if (PD->isThisDeclarationADefinition())
743  RewriteProtocolDecl(PD);
744  } else if (LinkageSpecDecl *LSD = dyn_cast<LinkageSpecDecl>(D)) {
745  // Recurse into linkage specifications
746  for (DeclContext::decl_iterator DI = LSD->decls_begin(),
747  DIEnd = LSD->decls_end();
748  DI != DIEnd; ) {
749  if (ObjCInterfaceDecl *IFace = dyn_cast<ObjCInterfaceDecl>((*DI))) {
750  if (!IFace->isThisDeclarationADefinition()) {
752  SourceLocation StartLoc = IFace->getBeginLoc();
753  do {
754  if (isa<ObjCInterfaceDecl>(*DI) &&
755  !cast<ObjCInterfaceDecl>(*DI)->isThisDeclarationADefinition() &&
756  StartLoc == (*DI)->getBeginLoc())
757  DG.push_back(*DI);
758  else
759  break;
760 
761  ++DI;
762  } while (DI != DIEnd);
763  RewriteForwardClassDecl(DG);
764  continue;
765  }
766  else {
767  // Keep track of all interface declarations seen.
768  ObjCInterfacesSeen.push_back(IFace);
769  ++DI;
770  continue;
771  }
772  }
773 
774  if (ObjCProtocolDecl *Proto = dyn_cast<ObjCProtocolDecl>((*DI))) {
775  if (!Proto->isThisDeclarationADefinition()) {
777  SourceLocation StartLoc = Proto->getBeginLoc();
778  do {
779  if (isa<ObjCProtocolDecl>(*DI) &&
780  !cast<ObjCProtocolDecl>(*DI)->isThisDeclarationADefinition() &&
781  StartLoc == (*DI)->getBeginLoc())
782  DG.push_back(*DI);
783  else
784  break;
785 
786  ++DI;
787  } while (DI != DIEnd);
788  RewriteForwardProtocolDecl(DG);
789  continue;
790  }
791  }
792 
793  HandleTopLevelSingleDecl(*DI);
794  ++DI;
795  }
796  }
797  // If we have a decl in the main file, see if we should rewrite it.
798  if (SM->isWrittenInMainFile(Loc))
799  return HandleDeclInMainFile(D);
800 }
801 
802 //===----------------------------------------------------------------------===//
803 // Syntactic (non-AST) Rewriting Code
804 //===----------------------------------------------------------------------===//
805 
806 void RewriteModernObjC::RewriteInclude() {
807  SourceLocation LocStart = SM->getLocForStartOfFile(MainFileID);
808  StringRef MainBuf = SM->getBufferData(MainFileID);
809  const char *MainBufStart = MainBuf.begin();
810  const char *MainBufEnd = MainBuf.end();
811  size_t ImportLen = strlen("import");
812 
813  // Loop over the whole file, looking for includes.
814  for (const char *BufPtr = MainBufStart; BufPtr < MainBufEnd; ++BufPtr) {
815  if (*BufPtr == '#') {
816  if (++BufPtr == MainBufEnd)
817  return;
818  while (*BufPtr == ' ' || *BufPtr == '\t')
819  if (++BufPtr == MainBufEnd)
820  return;
821  if (!strncmp(BufPtr, "import", ImportLen)) {
822  // replace import with include
823  SourceLocation ImportLoc =
824  LocStart.getLocWithOffset(BufPtr-MainBufStart);
825  ReplaceText(ImportLoc, ImportLen, "include");
826  BufPtr += ImportLen;
827  }
828  }
829  }
830 }
831 
832 static void WriteInternalIvarName(const ObjCInterfaceDecl *IDecl,
833  ObjCIvarDecl *IvarDecl, std::string &Result) {
834  Result += "OBJC_IVAR_$_";
835  Result += IDecl->getName();
836  Result += "$";
837  Result += IvarDecl->getName();
838 }
839 
842  const ObjCInterfaceDecl *ClassDecl = D->getContainingInterface();
843 
844  // Build name of symbol holding ivar offset.
845  std::string IvarOffsetName;
846  if (D->isBitField())
847  ObjCIvarBitfieldGroupOffset(D, IvarOffsetName);
848  else
849  WriteInternalIvarName(ClassDecl, D, IvarOffsetName);
850 
851  std::string S = "(*(";
852  QualType IvarT = D->getType();
853  if (D->isBitField())
854  IvarT = GetGroupRecordTypeForObjCIvarBitfield(D);
855 
856  if (!IvarT->getAs<TypedefType>() && IvarT->isRecordType()) {
857  RecordDecl *RD = IvarT->castAs<RecordType>()->getDecl();
858  RD = RD->getDefinition();
859  if (RD && !RD->getDeclName().getAsIdentifierInfo()) {
860  // decltype(((Foo_IMPL*)0)->bar) *
861  auto *CDecl = 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 = std::string(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 = MemberExpr::CreateImplicit(
886  *Context, PE, true, FD, FD->getType(), VK_LValue, OK_Ordinary);
887  IvarT = Context->getDecltypeType(ME, ME->getType());
888  }
889  }
890  convertObjCTypeToCStyleType(IvarT);
891  QualType castT = Context->getPointerType(IvarT);
892  std::string TypeString(castT.getAsString(Context->getPrintingPolicy()));
893  S += TypeString;
894  S += ")";
895 
896  // ((char *)self + IVAR_OFFSET_SYMBOL_NAME)
897  S += "((char *)self + ";
898  S += IvarOffsetName;
899  S += "))";
900  if (D->isBitField()) {
901  S += ".";
902  S += D->getNameAsString();
903  }
904  ReferencedIvars[const_cast<ObjCInterfaceDecl *>(ClassDecl)].insert(D);
905  return S;
906 }
907 
908 /// mustSynthesizeSetterGetterMethod - returns true if setter or getter has not
909 /// been found in the class implementation. In this case, it must be synthesized.
911  ObjCPropertyDecl *PD,
912  bool getter) {
913  auto *OMD = IMP->getInstanceMethod(getter ? PD->getGetterName()
914  : PD->getSetterName());
915  return !OMD || OMD->isSynthesizedAccessorStub();
916 }
917 
918 void RewriteModernObjC::RewritePropertyImplDecl(ObjCPropertyImplDecl *PID,
920  ObjCCategoryImplDecl *CID) {
921  static bool objcGetPropertyDefined = false;
922  static bool objcSetPropertyDefined = false;
923  SourceLocation startGetterSetterLoc;
924 
925  if (PID->getBeginLoc().isValid()) {
926  SourceLocation startLoc = PID->getBeginLoc();
927  InsertText(startLoc, "// ");
928  const char *startBuf = SM->getCharacterData(startLoc);
929  assert((*startBuf == '@') && "bogus @synthesize location");
930  const char *semiBuf = strchr(startBuf, ';');
931  assert((*semiBuf == ';') && "@synthesize: can't find ';'");
932  startGetterSetterLoc = startLoc.getLocWithOffset(semiBuf-startBuf+1);
933  } else
934  startGetterSetterLoc = IMD ? IMD->getEndLoc() : CID->getEndLoc();
935 
936  if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic)
937  return; // FIXME: is this correct?
938 
939  // Generate the 'getter' function.
940  ObjCPropertyDecl *PD = PID->getPropertyDecl();
941  ObjCIvarDecl *OID = PID->getPropertyIvarDecl();
942  assert(IMD && OID && "Synthesized ivars must be attached to @implementation");
943 
944  unsigned Attributes = PD->getPropertyAttributes();
945  if (mustSynthesizeSetterGetterMethod(IMD, PD, true /*getter*/)) {
946  bool GenGetProperty =
947  !(Attributes & ObjCPropertyAttribute::kind_nonatomic) &&
948  (Attributes & (ObjCPropertyAttribute::kind_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  PID->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(PID->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 & (ObjCPropertyAttribute::kind_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  PID->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 & ObjCPropertyAttribute::kind_nonatomic)
1029  Setr += "0, ";
1030  else
1031  Setr += "1, ";
1032  if (Attributes & ObjCPropertyAttribute::kind_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 
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  assert((IMD || CID) && "Unknown implementation type");
1338 
1339  if (IMD) {
1340  if (IMD->getIvarRBraceLoc().isValid()) {
1341  ReplaceText(IMD->getBeginLoc(), 1, "/** ");
1342  ReplaceText(IMD->getIvarRBraceLoc(), 1, "**/ ");
1343  }
1344  else {
1345  InsertText(IMD->getBeginLoc(), "// ");
1346  }
1347  }
1348  else
1349  InsertText(CID->getBeginLoc(), "// ");
1350 
1351  for (auto *OMD : IMD ? IMD->instance_methods() : CID->instance_methods()) {
1352  if (!OMD->getBody())
1353  continue;
1354  std::string ResultStr;
1355  RewriteObjCMethodDecl(OMD->getClassInterface(), OMD, ResultStr);
1356  SourceLocation LocStart = OMD->getBeginLoc();
1357  SourceLocation LocEnd = OMD->getCompoundBody()->getBeginLoc();
1358 
1359  const char *startBuf = SM->getCharacterData(LocStart);
1360  const char *endBuf = SM->getCharacterData(LocEnd);
1361  ReplaceText(LocStart, endBuf-startBuf, ResultStr);
1362  }
1363 
1364  for (auto *OMD : IMD ? IMD->class_methods() : CID->class_methods()) {
1365  if (!OMD->getBody())
1366  continue;
1367  std::string ResultStr;
1368  RewriteObjCMethodDecl(OMD->getClassInterface(), OMD, ResultStr);
1369  SourceLocation LocStart = OMD->getBeginLoc();
1370  SourceLocation LocEnd = OMD->getCompoundBody()->getBeginLoc();
1371 
1372  const char *startBuf = SM->getCharacterData(LocStart);
1373  const char *endBuf = SM->getCharacterData(LocEnd);
1374  ReplaceText(LocStart, endBuf-startBuf, ResultStr);
1375  }
1376  for (auto *I : IMD ? IMD->property_impls() : CID->property_impls())
1377  RewritePropertyImplDecl(I, IMD, CID);
1378 
1379  InsertText(IMD ? IMD->getEndLoc() : CID->getEndLoc(), "// ");
1380 }
1381 
1382 void RewriteModernObjC::RewriteInterfaceDecl(ObjCInterfaceDecl *ClassDecl) {
1383  // Do not synthesize more than once.
1384  if (ObjCSynthesizedStructs.count(ClassDecl))
1385  return;
1386  // Make sure super class's are written before current class is written.
1387  ObjCInterfaceDecl *SuperClass = ClassDecl->getSuperClass();
1388  while (SuperClass) {
1389  RewriteInterfaceDecl(SuperClass);
1390  SuperClass = SuperClass->getSuperClass();
1391  }
1392  std::string ResultStr;
1393  if (!ObjCWrittenInterfaces.count(ClassDecl->getCanonicalDecl())) {
1394  // we haven't seen a forward decl - generate a typedef.
1395  RewriteOneForwardClassDecl(ClassDecl, ResultStr);
1396  RewriteIvarOffsetSymbols(ClassDecl, ResultStr);
1397 
1398  RewriteObjCInternalStruct(ClassDecl, ResultStr);
1399  // Mark this typedef as having been written into its c++ equivalent.
1400  ObjCWrittenInterfaces.insert(ClassDecl->getCanonicalDecl());
1401 
1402  for (auto *I : ClassDecl->instance_properties())
1403  RewriteProperty(I);
1404  for (auto *I : ClassDecl->instance_methods())
1405  RewriteMethodDeclaration(I);
1406  for (auto *I : ClassDecl->class_methods())
1407  RewriteMethodDeclaration(I);
1408 
1409  // Lastly, comment out the @end.
1410  ReplaceText(ClassDecl->getAtEndRange().getBegin(), strlen("@end"),
1411  "/* @end */\n");
1412  }
1413 }
1414 
1415 Stmt *RewriteModernObjC::RewritePropertyOrImplicitSetter(PseudoObjectExpr *PseudoOp) {
1416  SourceRange OldRange = PseudoOp->getSourceRange();
1417 
1418  // We just magically know some things about the structure of this
1419  // expression.
1420  ObjCMessageExpr *OldMsg =
1421  cast<ObjCMessageExpr>(PseudoOp->getSemanticExpr(
1422  PseudoOp->getNumSemanticExprs() - 1));
1423 
1424  // Because the rewriter doesn't allow us to rewrite rewritten code,
1425  // we need to suppress rewriting the sub-statements.
1426  Expr *Base;
1427  SmallVector<Expr*, 2> Args;
1428  {
1429  DisableReplaceStmtScope S(*this);
1430 
1431  // Rebuild the base expression if we have one.
1432  Base = nullptr;
1433  if (OldMsg->getReceiverKind() == ObjCMessageExpr::Instance) {
1434  Base = OldMsg->getInstanceReceiver();
1435  Base = cast<OpaqueValueExpr>(Base)->getSourceExpr();
1436  Base = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Base));
1437  }
1438 
1439  unsigned numArgs = OldMsg->getNumArgs();
1440  for (unsigned i = 0; i < numArgs; i++) {
1441  Expr *Arg = OldMsg->getArg(i);
1442  if (isa<OpaqueValueExpr>(Arg))
1443  Arg = cast<OpaqueValueExpr>(Arg)->getSourceExpr();
1444  Arg = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Arg));
1445  Args.push_back(Arg);
1446  }
1447  }
1448 
1449  // TODO: avoid this copy.
1451  OldMsg->getSelectorLocs(SelLocs);
1452 
1453  ObjCMessageExpr *NewMsg = nullptr;
1454  switch (OldMsg->getReceiverKind()) {
1455  case ObjCMessageExpr::Class:
1456  NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1457  OldMsg->getValueKind(),
1458  OldMsg->getLeftLoc(),
1459  OldMsg->getClassReceiverTypeInfo(),
1460  OldMsg->getSelector(),
1461  SelLocs,
1462  OldMsg->getMethodDecl(),
1463  Args,
1464  OldMsg->getRightLoc(),
1465  OldMsg->isImplicit());
1466  break;
1467 
1468  case ObjCMessageExpr::Instance:
1469  NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1470  OldMsg->getValueKind(),
1471  OldMsg->getLeftLoc(),
1472  Base,
1473  OldMsg->getSelector(),
1474  SelLocs,
1475  OldMsg->getMethodDecl(),
1476  Args,
1477  OldMsg->getRightLoc(),
1478  OldMsg->isImplicit());
1479  break;
1480 
1481  case ObjCMessageExpr::SuperClass:
1482  case ObjCMessageExpr::SuperInstance:
1483  NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1484  OldMsg->getValueKind(),
1485  OldMsg->getLeftLoc(),
1486  OldMsg->getSuperLoc(),
1487  OldMsg->getReceiverKind() == ObjCMessageExpr::SuperInstance,
1488  OldMsg->getSuperType(),
1489  OldMsg->getSelector(),
1490  SelLocs,
1491  OldMsg->getMethodDecl(),
1492  Args,
1493  OldMsg->getRightLoc(),
1494  OldMsg->isImplicit());
1495  break;
1496  }
1497 
1498  Stmt *Replacement = SynthMessageExpr(NewMsg);
1499  ReplaceStmtWithRange(PseudoOp, Replacement, OldRange);
1500  return Replacement;
1501 }
1502 
1503 Stmt *RewriteModernObjC::RewritePropertyOrImplicitGetter(PseudoObjectExpr *PseudoOp) {
1504  SourceRange OldRange = PseudoOp->getSourceRange();
1505 
1506  // We just magically know some things about the structure of this
1507  // expression.
1508  ObjCMessageExpr *OldMsg =
1509  cast<ObjCMessageExpr>(PseudoOp->getResultExpr()->IgnoreImplicit());
1510 
1511  // Because the rewriter doesn't allow us to rewrite rewritten code,
1512  // we need to suppress rewriting the sub-statements.
1513  Expr *Base = nullptr;
1514  SmallVector<Expr*, 1> Args;
1515  {
1516  DisableReplaceStmtScope S(*this);
1517  // Rebuild the base expression if we have one.
1518  if (OldMsg->getReceiverKind() == ObjCMessageExpr::Instance) {
1519  Base = OldMsg->getInstanceReceiver();
1520  Base = cast<OpaqueValueExpr>(Base)->getSourceExpr();
1521  Base = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Base));
1522  }
1523  unsigned numArgs = OldMsg->getNumArgs();
1524  for (unsigned i = 0; i < numArgs; i++) {
1525  Expr *Arg = OldMsg->getArg(i);
1526  if (isa<OpaqueValueExpr>(Arg))
1527  Arg = cast<OpaqueValueExpr>(Arg)->getSourceExpr();
1528  Arg = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Arg));
1529  Args.push_back(Arg);
1530  }
1531  }
1532 
1533  // Intentionally empty.
1535 
1536  ObjCMessageExpr *NewMsg = nullptr;
1537  switch (OldMsg->getReceiverKind()) {
1538  case ObjCMessageExpr::Class:
1539  NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1540  OldMsg->getValueKind(),
1541  OldMsg->getLeftLoc(),
1542  OldMsg->getClassReceiverTypeInfo(),
1543  OldMsg->getSelector(),
1544  SelLocs,
1545  OldMsg->getMethodDecl(),
1546  Args,
1547  OldMsg->getRightLoc(),
1548  OldMsg->isImplicit());
1549  break;
1550 
1551  case ObjCMessageExpr::Instance:
1552  NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1553  OldMsg->getValueKind(),
1554  OldMsg->getLeftLoc(),
1555  Base,
1556  OldMsg->getSelector(),
1557  SelLocs,
1558  OldMsg->getMethodDecl(),
1559  Args,
1560  OldMsg->getRightLoc(),
1561  OldMsg->isImplicit());
1562  break;
1563 
1564  case ObjCMessageExpr::SuperClass:
1565  case ObjCMessageExpr::SuperInstance:
1566  NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(),
1567  OldMsg->getValueKind(),
1568  OldMsg->getLeftLoc(),
1569  OldMsg->getSuperLoc(),
1570  OldMsg->getReceiverKind() == ObjCMessageExpr::SuperInstance,
1571  OldMsg->getSuperType(),
1572  OldMsg->getSelector(),
1573  SelLocs,
1574  OldMsg->getMethodDecl(),
1575  Args,
1576  OldMsg->getRightLoc(),
1577  OldMsg->isImplicit());
1578  break;
1579  }
1580 
1581  Stmt *Replacement = SynthMessageExpr(NewMsg);
1582  ReplaceStmtWithRange(PseudoOp, Replacement, OldRange);
1583  return Replacement;
1584 }
1585 
1586 /// SynthCountByEnumWithState - To print:
1587 /// ((NSUInteger (*)
1588 /// (id, SEL, struct __objcFastEnumerationState *, id *, NSUInteger))
1589 /// (void *)objc_msgSend)((id)l_collection,
1590 /// sel_registerName(
1591 /// "countByEnumeratingWithState:objects:count:"),
1592 /// &enumState,
1593 /// (id *)__rw_items, (NSUInteger)16)
1594 ///
1595 void RewriteModernObjC::SynthCountByEnumWithState(std::string &buf) {
1596  buf += "((_WIN_NSUInteger (*) (id, SEL, struct __objcFastEnumerationState *, "
1597  "id *, _WIN_NSUInteger))(void *)objc_msgSend)";
1598  buf += "\n\t\t";
1599  buf += "((id)l_collection,\n\t\t";
1600  buf += "sel_registerName(\"countByEnumeratingWithState:objects:count:\"),";
1601  buf += "\n\t\t";
1602  buf += "&enumState, "
1603  "(id *)__rw_items, (_WIN_NSUInteger)16)";
1604 }
1605 
1606 /// RewriteBreakStmt - Rewrite for a break-stmt inside an ObjC2's foreach
1607 /// statement to exit to its outer synthesized loop.
1608 ///
1609 Stmt *RewriteModernObjC::RewriteBreakStmt(BreakStmt *S) {
1610  if (Stmts.empty() || !isa<ObjCForCollectionStmt>(Stmts.back()))
1611  return S;
1612  // replace break with goto __break_label
1613  std::string buf;
1614 
1615  SourceLocation startLoc = S->getBeginLoc();
1616  buf = "goto __break_label_";
1617  buf += utostr(ObjCBcLabelNo.back());
1618  ReplaceText(startLoc, strlen("break"), buf);
1619 
1620  return nullptr;
1621 }
1622 
1623 void RewriteModernObjC::ConvertSourceLocationToLineDirective(
1624  SourceLocation Loc,
1625  std::string &LineString) {
1626  if (Loc.isFileID() && GenerateLineInfo) {
1627  LineString += "\n#line ";
1628  PresumedLoc PLoc = SM->getPresumedLoc(Loc);
1629  LineString += utostr(PLoc.getLine());
1630  LineString += " \"";
1631  LineString += Lexer::Stringify(PLoc.getFilename());
1632  LineString += "\"\n";
1633  }
1634 }
1635 
1636 /// RewriteContinueStmt - Rewrite for a continue-stmt inside an ObjC2's foreach
1637 /// statement to continue with its inner synthesized loop.
1638 ///
1639 Stmt *RewriteModernObjC::RewriteContinueStmt(ContinueStmt *S) {
1640  if (Stmts.empty() || !isa<ObjCForCollectionStmt>(Stmts.back()))
1641  return S;
1642  // replace continue with goto __continue_label
1643  std::string buf;
1644 
1645  SourceLocation startLoc = S->getBeginLoc();
1646  buf = "goto __continue_label_";
1647  buf += utostr(ObjCBcLabelNo.back());
1648  ReplaceText(startLoc, strlen("continue"), buf);
1649 
1650  return nullptr;
1651 }
1652 
1653 /// RewriteObjCForCollectionStmt - Rewriter for ObjC2's foreach statement.
1654 /// It rewrites:
1655 /// for ( type elem in collection) { stmts; }
1656 
1657 /// Into:
1658 /// {
1659 /// type elem;
1660 /// struct __objcFastEnumerationState enumState = { 0 };
1661 /// id __rw_items[16];
1662 /// id l_collection = (id)collection;
1663 /// NSUInteger limit = [l_collection countByEnumeratingWithState:&enumState
1664 /// objects:__rw_items count:16];
1665 /// if (limit) {
1666 /// unsigned long startMutations = *enumState.mutationsPtr;
1667 /// do {
1668 /// unsigned long counter = 0;
1669 /// do {
1670 /// if (startMutations != *enumState.mutationsPtr)
1671 /// objc_enumerationMutation(l_collection);
1672 /// elem = (type)enumState.itemsPtr[counter++];
1673 /// stmts;
1674 /// __continue_label: ;
1675 /// } while (counter < limit);
1676 /// } while ((limit = [l_collection countByEnumeratingWithState:&enumState
1677 /// objects:__rw_items count:16]));
1678 /// elem = nil;
1679 /// __break_label: ;
1680 /// }
1681 /// else
1682 /// elem = nil;
1683 /// }
1684 ///
1685 Stmt *RewriteModernObjC::RewriteObjCForCollectionStmt(ObjCForCollectionStmt *S,
1686  SourceLocation OrigEnd) {
1687  assert(!Stmts.empty() && "ObjCForCollectionStmt - Statement stack empty");
1688  assert(isa<ObjCForCollectionStmt>(Stmts.back()) &&
1689  "ObjCForCollectionStmt Statement stack mismatch");
1690  assert(!ObjCBcLabelNo.empty() &&
1691  "ObjCForCollectionStmt - Label No stack empty");
1692 
1693  SourceLocation startLoc = S->getBeginLoc();
1694  const char *startBuf = SM->getCharacterData(startLoc);
1695  StringRef elementName;
1696  std::string elementTypeAsString;
1697  std::string buf;
1698  // line directive first.
1699  SourceLocation ForEachLoc = S->getForLoc();
1700  ConvertSourceLocationToLineDirective(ForEachLoc, buf);
1701  buf += "{\n\t";
1702  if (DeclStmt *DS = dyn_cast<DeclStmt>(S->getElement())) {
1703  // type elem;
1704  NamedDecl* D = cast<NamedDecl>(DS->getSingleDecl());
1705  QualType ElementType = cast<ValueDecl>(D)->getType();
1706  if (ElementType->isObjCQualifiedIdType() ||
1707  ElementType->isObjCQualifiedInterfaceType())
1708  // Simply use 'id' for all qualified types.
1709  elementTypeAsString = "id";
1710  else
1711  elementTypeAsString = ElementType.getAsString(Context->getPrintingPolicy());
1712  buf += elementTypeAsString;
1713  buf += " ";
1714  elementName = D->getName();
1715  buf += elementName;
1716  buf += ";\n\t";
1717  }
1718  else {
1719  DeclRefExpr *DR = cast<DeclRefExpr>(S->getElement());
1720  elementName = DR->getDecl()->getName();
1721  ValueDecl *VD = DR->getDecl();
1722  if (VD->getType()->isObjCQualifiedIdType() ||
1724  // Simply use 'id' for all qualified types.
1725  elementTypeAsString = "id";
1726  else
1727  elementTypeAsString = VD->getType().getAsString(Context->getPrintingPolicy());
1728  }
1729 
1730  // struct __objcFastEnumerationState enumState = { 0 };
1731  buf += "struct __objcFastEnumerationState enumState = { 0 };\n\t";
1732  // id __rw_items[16];
1733  buf += "id __rw_items[16];\n\t";
1734  // id l_collection = (id)
1735  buf += "id l_collection = (id)";
1736  // Find start location of 'collection' the hard way!
1737  const char *startCollectionBuf = startBuf;
1738  startCollectionBuf += 3; // skip 'for'
1739  startCollectionBuf = strchr(startCollectionBuf, '(');
1740  startCollectionBuf++; // skip '('
1741  // find 'in' and skip it.
1742  while (*startCollectionBuf != ' ' ||
1743  *(startCollectionBuf+1) != 'i' || *(startCollectionBuf+2) != 'n' ||
1744  (*(startCollectionBuf+3) != ' ' &&
1745  *(startCollectionBuf+3) != '[' && *(startCollectionBuf+3) != '('))
1746  startCollectionBuf++;
1747  startCollectionBuf += 3;
1748 
1749  // Replace: "for (type element in" with string constructed thus far.
1750  ReplaceText(startLoc, startCollectionBuf - startBuf, buf);
1751  // Replace ')' in for '(' type elem in collection ')' with ';'
1752  SourceLocation rightParenLoc = S->getRParenLoc();
1753  const char *rparenBuf = SM->getCharacterData(rightParenLoc);
1754  SourceLocation lparenLoc = startLoc.getLocWithOffset(rparenBuf-startBuf);
1755  buf = ";\n\t";
1756 
1757  // unsigned long limit = [l_collection countByEnumeratingWithState:&enumState
1758  // objects:__rw_items count:16];
1759  // which is synthesized into:
1760  // NSUInteger limit =
1761  // ((NSUInteger (*)
1762  // (id, SEL, struct __objcFastEnumerationState *, id *, NSUInteger))
1763  // (void *)objc_msgSend)((id)l_collection,
1764  // sel_registerName(
1765  // "countByEnumeratingWithState:objects:count:"),
1766  // (struct __objcFastEnumerationState *)&state,
1767  // (id *)__rw_items, (NSUInteger)16);
1768  buf += "_WIN_NSUInteger limit =\n\t\t";
1769  SynthCountByEnumWithState(buf);
1770  buf += ";\n\t";
1771  /// if (limit) {
1772  /// unsigned long startMutations = *enumState.mutationsPtr;
1773  /// do {
1774  /// unsigned long counter = 0;
1775  /// do {
1776  /// if (startMutations != *enumState.mutationsPtr)
1777  /// objc_enumerationMutation(l_collection);
1778  /// elem = (type)enumState.itemsPtr[counter++];
1779  buf += "if (limit) {\n\t";
1780  buf += "unsigned long startMutations = *enumState.mutationsPtr;\n\t";
1781  buf += "do {\n\t\t";
1782  buf += "unsigned long counter = 0;\n\t\t";
1783  buf += "do {\n\t\t\t";
1784  buf += "if (startMutations != *enumState.mutationsPtr)\n\t\t\t\t";
1785  buf += "objc_enumerationMutation(l_collection);\n\t\t\t";
1786  buf += elementName;
1787  buf += " = (";
1788  buf += elementTypeAsString;
1789  buf += ")enumState.itemsPtr[counter++];";
1790  // Replace ')' in for '(' type elem in collection ')' with all of these.
1791  ReplaceText(lparenLoc, 1, buf);
1792 
1793  /// __continue_label: ;
1794  /// } while (counter < limit);
1795  /// } while ((limit = [l_collection countByEnumeratingWithState:&enumState
1796  /// objects:__rw_items count:16]));
1797  /// elem = nil;
1798  /// __break_label: ;
1799  /// }
1800  /// else
1801  /// elem = nil;
1802  /// }
1803  ///
1804  buf = ";\n\t";
1805  buf += "__continue_label_";
1806  buf += utostr(ObjCBcLabelNo.back());
1807  buf += ": ;";
1808  buf += "\n\t\t";
1809  buf += "} while (counter < limit);\n\t";
1810  buf += "} while ((limit = ";
1811  SynthCountByEnumWithState(buf);
1812  buf += "));\n\t";
1813  buf += elementName;
1814  buf += " = ((";
1815  buf += elementTypeAsString;
1816  buf += ")0);\n\t";
1817  buf += "__break_label_";
1818  buf += utostr(ObjCBcLabelNo.back());
1819  buf += ": ;\n\t";
1820  buf += "}\n\t";
1821  buf += "else\n\t\t";
1822  buf += elementName;
1823  buf += " = ((";
1824  buf += elementTypeAsString;
1825  buf += ")0);\n\t";
1826  buf += "}\n";
1827 
1828  // Insert all these *after* the statement body.
1829  // FIXME: If this should support Obj-C++, support CXXTryStmt
1830  if (isa<CompoundStmt>(S->getBody())) {
1831  SourceLocation endBodyLoc = OrigEnd.getLocWithOffset(1);
1832  InsertText(endBodyLoc, buf);
1833  } else {
1834  /* Need to treat single statements specially. For example:
1835  *
1836  * for (A *a in b) if (stuff()) break;
1837  * for (A *a in b) xxxyy;
1838  *
1839  * The following code simply scans ahead to the semi to find the actual end.
1840  */
1841  const char *stmtBuf = SM->getCharacterData(OrigEnd);
1842  const char *semiBuf = strchr(stmtBuf, ';');
1843  assert(semiBuf && "Can't find ';'");
1844  SourceLocation endBodyLoc = OrigEnd.getLocWithOffset(semiBuf-stmtBuf+1);
1845  InsertText(endBodyLoc, buf);
1846  }
1847  Stmts.pop_back();
1848  ObjCBcLabelNo.pop_back();
1849  return nullptr;
1850 }
1851 
1853  buf += "{ struct _FIN { _FIN(id reth) : rethrow(reth) {}\n";
1854  buf += "\t~_FIN() { if (rethrow) objc_exception_throw(rethrow); }\n";
1855  buf += "\tid rethrow;\n";
1856  buf += "\t} _fin_force_rethow(_rethrow);";
1857 }
1858 
1859 /// RewriteObjCSynchronizedStmt -
1860 /// This routine rewrites @synchronized(expr) stmt;
1861 /// into:
1862 /// objc_sync_enter(expr);
1863 /// @try stmt @finally { objc_sync_exit(expr); }
1864 ///
1865 Stmt *RewriteModernObjC::RewriteObjCSynchronizedStmt(ObjCAtSynchronizedStmt *S) {
1866  // Get the start location and compute the semi location.
1867  SourceLocation startLoc = S->getBeginLoc();
1868  const char *startBuf = SM->getCharacterData(startLoc);
1869 
1870  assert((*startBuf == '@') && "bogus @synchronized location");
1871 
1872  std::string buf;
1873  SourceLocation SynchLoc = S->getAtSynchronizedLoc();
1874  ConvertSourceLocationToLineDirective(SynchLoc, buf);
1875  buf += "{ id _rethrow = 0; id _sync_obj = (id)";
1876 
1877  const char *lparenBuf = startBuf;
1878  while (*lparenBuf != '(') lparenBuf++;
1879  ReplaceText(startLoc, lparenBuf-startBuf+1, buf);
1880 
1881  buf = "; objc_sync_enter(_sync_obj);\n";
1882  buf += "try {\n\tstruct _SYNC_EXIT { _SYNC_EXIT(id arg) : sync_exit(arg) {}";
1883  buf += "\n\t~_SYNC_EXIT() {objc_sync_exit(sync_exit);}";
1884  buf += "\n\tid sync_exit;";
1885  buf += "\n\t} _sync_exit(_sync_obj);\n";
1886 
1887  // We can't use S->getSynchExpr()->getEndLoc() to find the end location, since
1888  // the sync expression is typically a message expression that's already
1889  // been rewritten! (which implies the SourceLocation's are invalid).
1890  SourceLocation RParenExprLoc = S->getSynchBody()->getBeginLoc();
1891  const char *RParenExprLocBuf = SM->getCharacterData(RParenExprLoc);
1892  while (*RParenExprLocBuf != ')') RParenExprLocBuf--;
1893  RParenExprLoc = startLoc.getLocWithOffset(RParenExprLocBuf-startBuf);
1894 
1895  SourceLocation LBranceLoc = S->getSynchBody()->getBeginLoc();
1896  const char *LBraceLocBuf = SM->getCharacterData(LBranceLoc);
1897  assert (*LBraceLocBuf == '{');
1898  ReplaceText(RParenExprLoc, (LBraceLocBuf - SM->getCharacterData(RParenExprLoc) + 1), buf);
1899 
1900  SourceLocation startRBraceLoc = S->getSynchBody()->getEndLoc();
1901  assert((*SM->getCharacterData(startRBraceLoc) == '}') &&
1902  "bogus @synchronized block");
1903 
1904  buf = "} catch (id e) {_rethrow = e;}\n";
1905  Write_RethrowObject(buf);
1906  buf += "}\n";
1907  buf += "}\n";
1908 
1909  ReplaceText(startRBraceLoc, 1, buf);
1910 
1911  return nullptr;
1912 }
1913 
1914 void RewriteModernObjC::WarnAboutReturnGotoStmts(Stmt *S)
1915 {
1916  // Perform a bottom up traversal of all children.
1917  for (Stmt *SubStmt : S->children())
1918  if (SubStmt)
1919  WarnAboutReturnGotoStmts(SubStmt);
1920 
1921  if (isa<ReturnStmt>(S) || isa<GotoStmt>(S)) {
1922  Diags.Report(Context->getFullLoc(S->getBeginLoc()),
1923  TryFinallyContainsReturnDiag);
1924  }
1925 }
1926 
1927 Stmt *RewriteModernObjC::RewriteObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) {
1928  SourceLocation startLoc = S->getAtLoc();
1929  ReplaceText(startLoc, strlen("@autoreleasepool"), "/* @autoreleasepool */");
1930  ReplaceText(S->getSubStmt()->getBeginLoc(), 1,
1931  "{ __AtAutoreleasePool __autoreleasepool; ");
1932 
1933  return nullptr;
1934 }
1935 
1936 Stmt *RewriteModernObjC::RewriteObjCTryStmt(ObjCAtTryStmt *S) {
1937  ObjCAtFinallyStmt *finalStmt = S->getFinallyStmt();
1938  bool noCatch = S->getNumCatchStmts() == 0;
1939  std::string buf;
1940  SourceLocation TryLocation = S->getAtTryLoc();
1941  ConvertSourceLocationToLineDirective(TryLocation, buf);
1942 
1943  if (finalStmt) {
1944  if (noCatch)
1945  buf += "{ id volatile _rethrow = 0;\n";
1946  else {
1947  buf += "{ id volatile _rethrow = 0;\ntry {\n";
1948  }
1949  }
1950  // Get the start location and compute the semi location.
1951  SourceLocation startLoc = S->getBeginLoc();
1952  const char *startBuf = SM->getCharacterData(startLoc);
1953 
1954  assert((*startBuf == '@') && "bogus @try location");
1955  if (finalStmt)
1956  ReplaceText(startLoc, 1, buf);
1957  else
1958  // @try -> try
1959  ReplaceText(startLoc, 1, "");
1960 
1961  for (ObjCAtCatchStmt *Catch : S->catch_stmts()) {
1962  VarDecl *catchDecl = Catch->getCatchParamDecl();
1963 
1964  startLoc = Catch->getBeginLoc();
1965  bool AtRemoved = false;
1966  if (catchDecl) {
1967  QualType t = catchDecl->getType();
1968  if (const ObjCObjectPointerType *Ptr =
1969  t->getAs<ObjCObjectPointerType>()) {
1970  // Should be a pointer to a class.
1971  ObjCInterfaceDecl *IDecl = Ptr->getObjectType()->getInterface();
1972  if (IDecl) {
1973  std::string Result;
1974  ConvertSourceLocationToLineDirective(Catch->getBeginLoc(), Result);
1975 
1976  startBuf = SM->getCharacterData(startLoc);
1977  assert((*startBuf == '@') && "bogus @catch location");
1978  SourceLocation rParenLoc = Catch->getRParenLoc();
1979  const char *rParenBuf = SM->getCharacterData(rParenLoc);
1980 
1981  // _objc_exc_Foo *_e as argument to catch.
1982  Result += "catch (_objc_exc_"; Result += IDecl->getNameAsString();
1983  Result += " *_"; Result += catchDecl->getNameAsString();
1984  Result += ")";
1985  ReplaceText(startLoc, rParenBuf-startBuf+1, Result);
1986  // Foo *e = (Foo *)_e;
1987  Result.clear();
1988  Result = "{ ";
1989  Result += IDecl->getNameAsString();
1990  Result += " *"; Result += catchDecl->getNameAsString();
1991  Result += " = ("; Result += IDecl->getNameAsString(); Result += "*)";
1992  Result += "_"; Result += catchDecl->getNameAsString();
1993 
1994  Result += "; ";
1995  SourceLocation lBraceLoc = Catch->getCatchBody()->getBeginLoc();
1996  ReplaceText(lBraceLoc, 1, Result);
1997  AtRemoved = true;
1998  }
1999  }
2000  }
2001  if (!AtRemoved)
2002  // @catch -> catch
2003  ReplaceText(startLoc, 1, "");
2004 
2005  }
2006  if (finalStmt) {
2007  buf.clear();
2008  SourceLocation FinallyLoc = finalStmt->getBeginLoc();
2009 
2010  if (noCatch) {
2011  ConvertSourceLocationToLineDirective(FinallyLoc, buf);
2012  buf += "catch (id e) {_rethrow = e;}\n";
2013  }
2014  else {
2015  buf += "}\n";
2016  ConvertSourceLocationToLineDirective(FinallyLoc, buf);
2017  buf += "catch (id e) {_rethrow = e;}\n";
2018  }
2019 
2020  SourceLocation startFinalLoc = finalStmt->getBeginLoc();
2021  ReplaceText(startFinalLoc, 8, buf);
2022  Stmt *body = finalStmt->getFinallyBody();
2023  SourceLocation startFinalBodyLoc = body->getBeginLoc();
2024  buf.clear();
2025  Write_RethrowObject(buf);
2026  ReplaceText(startFinalBodyLoc, 1, buf);
2027 
2028  SourceLocation endFinalBodyLoc = body->getEndLoc();
2029  ReplaceText(endFinalBodyLoc, 1, "}\n}");
2030  // Now check for any return/continue/go statements within the @try.
2031  WarnAboutReturnGotoStmts(S->getTryBody());
2032  }
2033 
2034  return nullptr;
2035 }
2036 
2037 // This can't be done with ReplaceStmt(S, ThrowExpr), since
2038 // the throw expression is typically a message expression that's already
2039 // been rewritten! (which implies the SourceLocation's are invalid).
2040 Stmt *RewriteModernObjC::RewriteObjCThrowStmt(ObjCAtThrowStmt *S) {
2041  // Get the start location and compute the semi location.
2042  SourceLocation startLoc = S->getBeginLoc();
2043  const char *startBuf = SM->getCharacterData(startLoc);
2044 
2045  assert((*startBuf == '@') && "bogus @throw location");
2046 
2047  std::string buf;
2048  /* void objc_exception_throw(id) __attribute__((noreturn)); */
2049  if (S->getThrowExpr())
2050  buf = "objc_exception_throw(";
2051  else
2052  buf = "throw";
2053 
2054  // handle "@ throw" correctly.
2055  const char *wBuf = strchr(startBuf, 'w');
2056  assert((*wBuf == 'w') && "@throw: can't find 'w'");
2057  ReplaceText(startLoc, wBuf-startBuf+1, buf);
2058 
2059  SourceLocation endLoc = S->getEndLoc();
2060  const char *endBuf = SM->getCharacterData(endLoc);
2061  const char *semiBuf = strchr(endBuf, ';');
2062  assert((*semiBuf == ';') && "@throw: can't find ';'");
2063  SourceLocation semiLoc = startLoc.getLocWithOffset(semiBuf-startBuf);
2064  if (S->getThrowExpr())
2065  ReplaceText(semiLoc, 1, ");");
2066  return nullptr;
2067 }
2068 
2069 Stmt *RewriteModernObjC::RewriteAtEncode(ObjCEncodeExpr *Exp) {
2070  // Create a new string expression.
2071  std::string StrEncoding;
2072  Context->getObjCEncodingForType(Exp->getEncodedType(), StrEncoding);
2073  Expr *Replacement = getStringLiteral(StrEncoding);
2074  ReplaceStmt(Exp, Replacement);
2075 
2076  // Replace this subexpr in the parent.
2077  // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
2078  return Replacement;
2079 }
2080 
2081 Stmt *RewriteModernObjC::RewriteAtSelector(ObjCSelectorExpr *Exp) {
2082  if (!SelGetUidFunctionDecl)
2083  SynthSelGetUidFunctionDecl();
2084  assert(SelGetUidFunctionDecl && "Can't find sel_registerName() decl");
2085  // Create a call to sel_registerName("selName").
2086  SmallVector<Expr*, 8> SelExprs;
2087  SelExprs.push_back(getStringLiteral(Exp->getSelector().getAsString()));
2088  CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl,
2089  SelExprs);
2090  ReplaceStmt(Exp, SelExp);
2091  // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
2092  return SelExp;
2093 }
2094 
2095 CallExpr *
2096 RewriteModernObjC::SynthesizeCallToFunctionDecl(FunctionDecl *FD,
2097  ArrayRef<Expr *> Args,
2098  SourceLocation StartLoc,
2099  SourceLocation EndLoc) {
2100  // Get the type, we will need to reference it in a couple spots.
2101  QualType msgSendType = FD->getType();
2102 
2103  // Create a reference to the objc_msgSend() declaration.
2104  DeclRefExpr *DRE = new (Context) DeclRefExpr(*Context, FD, false, msgSendType,
2106 
2107  // Now, we cast the reference to a pointer to the objc_msgSend type.
2108  QualType pToFunc = Context->getPointerType(msgSendType);
2109  ImplicitCastExpr *ICE =
2110  ImplicitCastExpr::Create(*Context, pToFunc, CK_FunctionToPointerDecay,
2111  DRE, nullptr, VK_PRValue, FPOptionsOverride());
2112 
2113  const auto *FT = msgSendType->castAs<FunctionType>();
2114  CallExpr *Exp =
2115  CallExpr::Create(*Context, ICE, Args, FT->getCallResultType(*Context),
2116  VK_PRValue, EndLoc, FPOptionsOverride());
2117  return Exp;
2118 }
2119 
2120 static bool scanForProtocolRefs(const char *startBuf, const char *endBuf,
2121  const char *&startRef, const char *&endRef) {
2122  while (startBuf < endBuf) {
2123  if (*startBuf == '<')
2124  startRef = startBuf; // mark the start.
2125  if (*startBuf == '>') {
2126  if (startRef && *startRef == '<') {
2127  endRef = startBuf; // mark the end.
2128  return true;
2129  }
2130  return false;
2131  }
2132  startBuf++;
2133  }
2134  return false;
2135 }
2136 
2137 static void scanToNextArgument(const char *&argRef) {
2138  int angle = 0;
2139  while (*argRef != ')' && (*argRef != ',' || angle > 0)) {
2140  if (*argRef == '<')
2141  angle++;
2142  else if (*argRef == '>')
2143  angle--;
2144  argRef++;
2145  }
2146  assert(angle == 0 && "scanToNextArgument - bad protocol type syntax");
2147 }
2148 
2149 bool RewriteModernObjC::needToScanForQualifiers(QualType T) {
2150  if (T->isObjCQualifiedIdType())
2151  return true;
2152  if (const PointerType *PT = T->getAs<PointerType>()) {
2154  return true;
2155  }
2156  if (T->isObjCObjectPointerType()) {
2157  T = T->getPointeeType();
2158  return T->isObjCQualifiedInterfaceType();
2159  }
2160  if (T->isArrayType()) {
2161  QualType ElemTy = Context->getBaseElementType(T);
2162  return needToScanForQualifiers(ElemTy);
2163  }
2164  return false;
2165 }
2166 
2167 void RewriteModernObjC::RewriteObjCQualifiedInterfaceTypes(Expr *E) {
2168  QualType Type = E->getType();
2169  if (needToScanForQualifiers(Type)) {
2170  SourceLocation Loc, EndLoc;
2171 
2172  if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E)) {
2173  Loc = ECE->getLParenLoc();
2174  EndLoc = ECE->getRParenLoc();
2175  } else {
2176  Loc = E->getBeginLoc();
2177  EndLoc = E->getEndLoc();
2178  }
2179  // This will defend against trying to rewrite synthesized expressions.
2180  if (Loc.isInvalid() || EndLoc.isInvalid())
2181  return;
2182 
2183  const char *startBuf = SM->getCharacterData(Loc);
2184  const char *endBuf = SM->getCharacterData(EndLoc);
2185  const char *startRef = nullptr, *endRef = nullptr;
2186  if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) {
2187  // Get the locations of the startRef, endRef.
2188  SourceLocation LessLoc = Loc.getLocWithOffset(startRef-startBuf);
2189  SourceLocation GreaterLoc = Loc.getLocWithOffset(endRef-startBuf+1);
2190  // Comment out the protocol references.
2191  InsertText(LessLoc, "/*");
2192  InsertText(GreaterLoc, "*/");
2193  }
2194  }
2195 }
2196 
2197 void RewriteModernObjC::RewriteObjCQualifiedInterfaceTypes(Decl *Dcl) {
2198  SourceLocation Loc;
2199  QualType Type;
2200  const FunctionProtoType *proto = nullptr;
2201  if (VarDecl *VD = dyn_cast<VarDecl>(Dcl)) {
2202  Loc = VD->getLocation();
2203  Type = VD->getType();
2204  }
2205  else if (FunctionDecl *FD = dyn_cast<FunctionDecl>(Dcl)) {
2206  Loc = FD->getLocation();
2207  // Check for ObjC 'id' and class types that have been adorned with protocol
2208  // information (id<p>, C<p>*). The protocol references need to be rewritten!
2209  const FunctionType *funcType = FD->getType()->getAs<FunctionType>();
2210  assert(funcType && "missing function type");
2211  proto = dyn_cast<FunctionProtoType>(funcType);
2212  if (!proto)
2213  return;
2214  Type = proto->getReturnType();
2215  }
2216  else if (FieldDecl *FD = dyn_cast<FieldDecl>(Dcl)) {
2217  Loc = FD->getLocation();
2218  Type = FD->getType();
2219  }
2220  else if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(Dcl)) {
2221  Loc = TD->getLocation();
2222  Type = TD->getUnderlyingType();
2223  }
2224  else
2225  return;
2226 
2227  if (needToScanForQualifiers(Type)) {
2228  // Since types are unique, we need to scan the buffer.
2229 
2230  const char *endBuf = SM->getCharacterData(Loc);
2231  const char *startBuf = endBuf;
2232  while (*startBuf != ';' && *startBuf != '<' && startBuf != MainFileStart)
2233  startBuf--; // scan backward (from the decl location) for return type.
2234  const char *startRef = nullptr, *endRef = nullptr;
2235  if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) {
2236  // Get the locations of the startRef, endRef.
2237  SourceLocation LessLoc = Loc.getLocWithOffset(startRef-endBuf);
2238  SourceLocation GreaterLoc = Loc.getLocWithOffset(endRef-endBuf+1);
2239  // Comment out the protocol references.
2240  InsertText(LessLoc, "/*");
2241  InsertText(GreaterLoc, "*/");
2242  }
2243  }
2244  if (!proto)
2245  return; // most likely, was a variable
2246  // Now check arguments.
2247  const char *startBuf = SM->getCharacterData(Loc);
2248  const char *startFuncBuf = startBuf;
2249  for (unsigned i = 0; i < proto->getNumParams(); i++) {
2250  if (needToScanForQualifiers(proto->getParamType(i))) {
2251  // Since types are unique, we need to scan the buffer.
2252 
2253  const char *endBuf = startBuf;
2254  // scan forward (from the decl location) for argument types.
2255  scanToNextArgument(endBuf);
2256  const char *startRef = nullptr, *endRef = nullptr;
2257  if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) {
2258  // Get the locations of the startRef, endRef.
2259  SourceLocation LessLoc =
2260  Loc.getLocWithOffset(startRef-startFuncBuf);
2261  SourceLocation GreaterLoc =
2262  Loc.getLocWithOffset(endRef-startFuncBuf+1);
2263  // Comment out the protocol references.
2264  InsertText(LessLoc, "/*");
2265  InsertText(GreaterLoc, "*/");
2266  }
2267  startBuf = ++endBuf;
2268  }
2269  else {
2270  // If the function name is derived from a macro expansion, then the
2271  // argument buffer will not follow the name. Need to speak with Chris.
2272  while (*startBuf && *startBuf != ')' && *startBuf != ',')
2273  startBuf++; // scan forward (from the decl location) for argument types.
2274  startBuf++;
2275  }
2276  }
2277 }
2278 
2279 void RewriteModernObjC::RewriteTypeOfDecl(VarDecl *ND) {
2280  QualType QT = ND->getType();
2281  const Type* TypePtr = QT->getAs<Type>();
2282  if (!isa<TypeOfExprType>(TypePtr))
2283  return;
2284  while (isa<TypeOfExprType>(TypePtr)) {
2285  const TypeOfExprType *TypeOfExprTypePtr = cast<TypeOfExprType>(TypePtr);
2286  QT = TypeOfExprTypePtr->getUnderlyingExpr()->getType();
2287  TypePtr = QT->getAs<Type>();
2288  }
2289  // FIXME. This will not work for multiple declarators; as in:
2290  // __typeof__(a) b,c,d;
2291  std::string TypeAsString(QT.getAsString(Context->getPrintingPolicy()));
2292  SourceLocation DeclLoc = ND->getTypeSpecStartLoc();
2293  const char *startBuf = SM->getCharacterData(DeclLoc);
2294  if (ND->getInit()) {
2295  std::string Name(ND->getNameAsString());
2296  TypeAsString += " " + Name + " = ";
2297  Expr *E = ND->getInit();
2298  SourceLocation startLoc;
2299  if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E))
2300  startLoc = ECE->getLParenLoc();
2301  else
2302  startLoc = E->getBeginLoc();
2303  startLoc = SM->getExpansionLoc(startLoc);
2304  const char *endBuf = SM->getCharacterData(startLoc);
2305  ReplaceText(DeclLoc, endBuf-startBuf-1, TypeAsString);
2306  }
2307  else {
2308  SourceLocation X = ND->getEndLoc();
2309  X = SM->getExpansionLoc(X);
2310  const char *endBuf = SM->getCharacterData(X);
2311  ReplaceText(DeclLoc, endBuf-startBuf-1, TypeAsString);
2312  }
2313 }
2314 
2315 // SynthSelGetUidFunctionDecl - SEL sel_registerName(const char *str);
2316 void RewriteModernObjC::SynthSelGetUidFunctionDecl() {
2317  IdentifierInfo *SelGetUidIdent = &Context->Idents.get("sel_registerName");
2319  ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst()));
2320  QualType getFuncType =
2321  getSimpleFunctionType(Context->getObjCSelType(), ArgTys);
2322  SelGetUidFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2323  SourceLocation(),
2324  SourceLocation(),
2325  SelGetUidIdent, getFuncType,
2326  nullptr, SC_Extern);
2327 }
2328 
2329 void RewriteModernObjC::RewriteFunctionDecl(FunctionDecl *FD) {
2330  // declared in <objc/objc.h>
2331  if (FD->getIdentifier() &&
2332  FD->getName() == "sel_registerName") {
2333  SelGetUidFunctionDecl = FD;
2334  return;
2335  }
2336  RewriteObjCQualifiedInterfaceTypes(FD);
2337 }
2338 
2339 void RewriteModernObjC::RewriteBlockPointerType(std::string& Str, QualType Type) {
2340  std::string TypeString(Type.getAsString(Context->getPrintingPolicy()));
2341  const char *argPtr = TypeString.c_str();
2342  if (!strchr(argPtr, '^')) {
2343  Str += TypeString;
2344  return;
2345  }
2346  while (*argPtr) {
2347  Str += (*argPtr == '^' ? '*' : *argPtr);
2348  argPtr++;
2349  }
2350 }
2351 
2352 // FIXME. Consolidate this routine with RewriteBlockPointerType.
2353 void RewriteModernObjC::RewriteBlockPointerTypeVariable(std::string& Str,
2354  ValueDecl *VD) {
2355  QualType Type = VD->getType();
2356  std::string TypeString(Type.getAsString(Context->getPrintingPolicy()));
2357  const char *argPtr = TypeString.c_str();
2358  int paren = 0;
2359  while (*argPtr) {
2360  switch (*argPtr) {
2361  case '(':
2362  Str += *argPtr;
2363  paren++;
2364  break;
2365  case ')':
2366  Str += *argPtr;
2367  paren--;
2368  break;
2369  case '^':
2370  Str += '*';
2371  if (paren == 1)
2372  Str += VD->getNameAsString();
2373  break;
2374  default:
2375  Str += *argPtr;
2376  break;
2377  }
2378  argPtr++;
2379  }
2380 }
2381 
2382 void RewriteModernObjC::RewriteBlockLiteralFunctionDecl(FunctionDecl *FD) {
2383  SourceLocation FunLocStart = FD->getTypeSpecStartLoc();
2384  const FunctionType *funcType = FD->getType()->getAs<FunctionType>();
2385  const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(funcType);
2386  if (!proto)
2387  return;
2388  QualType Type = proto->getReturnType();
2389  std::string FdStr = Type.getAsString(Context->getPrintingPolicy());
2390  FdStr += " ";
2391  FdStr += FD->getName();
2392  FdStr += "(";
2393  unsigned numArgs = proto->getNumParams();
2394  for (unsigned i = 0; i < numArgs; i++) {
2395  QualType ArgType = proto->getParamType(i);
2396  RewriteBlockPointerType(FdStr, ArgType);
2397  if (i+1 < numArgs)
2398  FdStr += ", ";
2399  }
2400  if (FD->isVariadic()) {
2401  FdStr += (numArgs > 0) ? ", ...);\n" : "...);\n";
2402  }
2403  else
2404  FdStr += ");\n";
2405  InsertText(FunLocStart, FdStr);
2406 }
2407 
2408 // SynthSuperConstructorFunctionDecl - id __rw_objc_super(id obj, id super);
2409 void RewriteModernObjC::SynthSuperConstructorFunctionDecl() {
2410  if (SuperConstructorFunctionDecl)
2411  return;
2412  IdentifierInfo *msgSendIdent = &Context->Idents.get("__rw_objc_super");
2414  QualType argT = Context->getObjCIdType();
2415  assert(!argT.isNull() && "Can't find 'id' type");
2416  ArgTys.push_back(argT);
2417  ArgTys.push_back(argT);
2418  QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2419  ArgTys);
2420  SuperConstructorFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2421  SourceLocation(),
2422  SourceLocation(),
2423  msgSendIdent, msgSendType,
2424  nullptr, SC_Extern);
2425 }
2426 
2427 // SynthMsgSendFunctionDecl - id objc_msgSend(id self, SEL op, ...);
2428 void RewriteModernObjC::SynthMsgSendFunctionDecl() {
2429  IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend");
2431  QualType argT = Context->getObjCIdType();
2432  assert(!argT.isNull() && "Can't find 'id' type");
2433  ArgTys.push_back(argT);
2434  argT = Context->getObjCSelType();
2435  assert(!argT.isNull() && "Can't find 'SEL' type");
2436  ArgTys.push_back(argT);
2437  QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2438  ArgTys, /*variadic=*/true);
2439  MsgSendFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2440  SourceLocation(),
2441  SourceLocation(),
2442  msgSendIdent, msgSendType, nullptr,
2443  SC_Extern);
2444 }
2445 
2446 // SynthMsgSendSuperFunctionDecl - id objc_msgSendSuper(void);
2447 void RewriteModernObjC::SynthMsgSendSuperFunctionDecl() {
2448  IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSendSuper");
2449  SmallVector<QualType, 2> ArgTys;
2450  ArgTys.push_back(Context->VoidTy);
2451  QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2452  ArgTys, /*variadic=*/true);
2453  MsgSendSuperFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2454  SourceLocation(),
2455  SourceLocation(),
2456  msgSendIdent, msgSendType,
2457  nullptr, SC_Extern);
2458 }
2459 
2460 // SynthMsgSendStretFunctionDecl - id objc_msgSend_stret(id self, SEL op, ...);
2461 void RewriteModernObjC::SynthMsgSendStretFunctionDecl() {
2462  IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend_stret");
2464  QualType argT = Context->getObjCIdType();
2465  assert(!argT.isNull() && "Can't find 'id' type");
2466  ArgTys.push_back(argT);
2467  argT = Context->getObjCSelType();
2468  assert(!argT.isNull() && "Can't find 'SEL' type");
2469  ArgTys.push_back(argT);
2470  QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2471  ArgTys, /*variadic=*/true);
2472  MsgSendStretFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2473  SourceLocation(),
2474  SourceLocation(),
2475  msgSendIdent, msgSendType,
2476  nullptr, SC_Extern);
2477 }
2478 
2479 // SynthMsgSendSuperStretFunctionDecl -
2480 // id objc_msgSendSuper_stret(void);
2481 void RewriteModernObjC::SynthMsgSendSuperStretFunctionDecl() {
2482  IdentifierInfo *msgSendIdent =
2483  &Context->Idents.get("objc_msgSendSuper_stret");
2484  SmallVector<QualType, 2> ArgTys;
2485  ArgTys.push_back(Context->VoidTy);
2486  QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(),
2487  ArgTys, /*variadic=*/true);
2488  MsgSendSuperStretFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2489  SourceLocation(),
2490  SourceLocation(),
2491  msgSendIdent,
2492  msgSendType, nullptr,
2493  SC_Extern);
2494 }
2495 
2496 // SynthMsgSendFpretFunctionDecl - double objc_msgSend_fpret(id self, SEL op, ...);
2497 void RewriteModernObjC::SynthMsgSendFpretFunctionDecl() {
2498  IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend_fpret");
2500  QualType argT = Context->getObjCIdType();
2501  assert(!argT.isNull() && "Can't find 'id' type");
2502  ArgTys.push_back(argT);
2503  argT = Context->getObjCSelType();
2504  assert(!argT.isNull() && "Can't find 'SEL' type");
2505  ArgTys.push_back(argT);
2506  QualType msgSendType = getSimpleFunctionType(Context->DoubleTy,
2507  ArgTys, /*variadic=*/true);
2508  MsgSendFpretFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2509  SourceLocation(),
2510  SourceLocation(),
2511  msgSendIdent, msgSendType,
2512  nullptr, SC_Extern);
2513 }
2514 
2515 // SynthGetClassFunctionDecl - Class objc_getClass(const char *name);
2516 void RewriteModernObjC::SynthGetClassFunctionDecl() {
2517  IdentifierInfo *getClassIdent = &Context->Idents.get("objc_getClass");
2519  ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst()));
2520  QualType getClassType = getSimpleFunctionType(Context->getObjCClassType(),
2521  ArgTys);
2522  GetClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2523  SourceLocation(),
2524  SourceLocation(),
2525  getClassIdent, getClassType,
2526  nullptr, SC_Extern);
2527 }
2528 
2529 // SynthGetSuperClassFunctionDecl - Class class_getSuperclass(Class cls);
2530 void RewriteModernObjC::SynthGetSuperClassFunctionDecl() {
2531  IdentifierInfo *getSuperClassIdent =
2532  &Context->Idents.get("class_getSuperclass");
2534  ArgTys.push_back(Context->getObjCClassType());
2535  QualType getClassType = getSimpleFunctionType(Context->getObjCClassType(),
2536  ArgTys);
2537  GetSuperClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2538  SourceLocation(),
2539  SourceLocation(),
2540  getSuperClassIdent,
2541  getClassType, nullptr,
2542  SC_Extern);
2543 }
2544 
2545 // SynthGetMetaClassFunctionDecl - Class objc_getMetaClass(const char *name);
2546 void RewriteModernObjC::SynthGetMetaClassFunctionDecl() {
2547  IdentifierInfo *getClassIdent = &Context->Idents.get("objc_getMetaClass");
2549  ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst()));
2550  QualType getClassType = getSimpleFunctionType(Context->getObjCClassType(),
2551  ArgTys);
2552  GetMetaClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl,
2553  SourceLocation(),
2554  SourceLocation(),
2555  getClassIdent, getClassType,
2556  nullptr, SC_Extern);
2557 }
2558 
2559 Stmt *RewriteModernObjC::RewriteObjCStringLiteral(ObjCStringLiteral *Exp) {
2560  assert (Exp != nullptr && "Expected non-null ObjCStringLiteral");
2561  QualType strType = getConstantStringStructType();
2562 
2563  std::string S = "__NSConstantStringImpl_";
2564 
2565  std::string tmpName = InFileName;
2566  unsigned i;
2567  for (i=0; i < tmpName.length(); i++) {
2568  char c = tmpName.at(i);
2569  // replace any non-alphanumeric characters with '_'.
2570  if (!isAlphanumeric(c))
2571  tmpName[i] = '_';
2572  }
2573  S += tmpName;
2574  S += "_";
2575  S += utostr(NumObjCStringLiterals++);
2576 
2577  Preamble += "static __NSConstantStringImpl " + S;
2578  Preamble += " __attribute__ ((section (\"__DATA, __cfstring\"))) = {__CFConstantStringClassReference,";
2579  Preamble += "0x000007c8,"; // utf8_str
2580  // The pretty printer for StringLiteral handles escape characters properly.
2581  std::string prettyBufS;
2582  llvm::raw_string_ostream prettyBuf(prettyBufS);
2583  Exp->getString()->printPretty(prettyBuf, nullptr, PrintingPolicy(LangOpts));
2584  Preamble += prettyBuf.str();
2585  Preamble += ",";
2586  Preamble += utostr(Exp->getString()->getByteLength()) + "};\n";
2587 
2588  VarDecl *NewVD = VarDecl::Create(*Context, TUDecl, SourceLocation(),
2589  SourceLocation(), &Context->Idents.get(S),
2590  strType, nullptr, SC_Static);
2591  DeclRefExpr *DRE = new (Context)
2592  DeclRefExpr(*Context, NewVD, false, strType, VK_LValue, SourceLocation());
2593  Expr *Unop = UnaryOperator::Create(
2594  const_cast<ASTContext &>(*Context), DRE, UO_AddrOf,
2595  Context->getPointerType(DRE->getType()), VK_PRValue, OK_Ordinary,
2596  SourceLocation(), false, FPOptionsOverride());
2597  // cast to NSConstantString *
2598  CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, Exp->getType(),
2599  CK_CPointerToObjCPointerCast, Unop);
2600  ReplaceStmt(Exp, cast);
2601  // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
2602  return cast;
2603 }
2604 
2605 Stmt *RewriteModernObjC::RewriteObjCBoolLiteralExpr(ObjCBoolLiteralExpr *Exp) {
2606  unsigned IntSize =
2607  static_cast<unsigned>(Context->getTypeSize(Context->IntTy));
2608 
2609  Expr *FlagExp = IntegerLiteral::Create(*Context,
2610  llvm::APInt(IntSize, Exp->getValue()),
2611  Context->IntTy, Exp->getLocation());
2612  CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, Context->ObjCBuiltinBoolTy,
2613  CK_BitCast, FlagExp);
2614  ParenExpr *PE = new (Context) ParenExpr(Exp->getLocation(), Exp->getExprLoc(),
2615  cast);
2616  ReplaceStmt(Exp, PE);
2617  return PE;
2618 }
2619 
2620 Stmt *RewriteModernObjC::RewriteObjCBoxedExpr(ObjCBoxedExpr *Exp) {
2621  // synthesize declaration of helper functions needed in this routine.
2622  if (!SelGetUidFunctionDecl)
2623  SynthSelGetUidFunctionDecl();
2624  // use objc_msgSend() for all.
2625  if (!MsgSendFunctionDecl)
2626  SynthMsgSendFunctionDecl();
2627  if (!GetClassFunctionDecl)
2628  SynthGetClassFunctionDecl();
2629 
2630  FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl;
2631  SourceLocation StartLoc = Exp->getBeginLoc();
2632  SourceLocation EndLoc = Exp->getEndLoc();
2633 
2634  // Synthesize a call to objc_msgSend().
2635  SmallVector<Expr*, 4> MsgExprs;
2636  SmallVector<Expr*, 4> ClsExprs;
2637 
2638  // Create a call to objc_getClass("<BoxingClass>"). It will be the 1st argument.
2639  ObjCMethodDecl *BoxingMethod = Exp->getBoxingMethod();
2640  ObjCInterfaceDecl *BoxingClass = BoxingMethod->getClassInterface();
2641 
2642  IdentifierInfo *clsName = BoxingClass->getIdentifier();
2643  ClsExprs.push_back(getStringLiteral(clsName->getName()));
2644  CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs,
2645  StartLoc, EndLoc);
2646  MsgExprs.push_back(Cls);
2647 
2648  // Create a call to sel_registerName("<BoxingMethod>:"), etc.
2649  // it will be the 2nd argument.
2650  SmallVector<Expr*, 4> SelExprs;
2651  SelExprs.push_back(
2652  getStringLiteral(BoxingMethod->getSelector().getAsString()));
2653  CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl,
2654  SelExprs, StartLoc, EndLoc);
2655  MsgExprs.push_back(SelExp);
2656 
2657  // User provided sub-expression is the 3rd, and last, argument.
2658  Expr *subExpr = Exp->getSubExpr();
2659  if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(subExpr)) {
2660  QualType type = ICE->getType();
2661  const Expr *SubExpr = ICE->IgnoreParenImpCasts();
2662  CastKind CK = CK_BitCast;
2663  if (SubExpr->getType()->isIntegralType(*Context) && type->isBooleanType())
2664  CK = CK_IntegralToBoolean;
2665  subExpr = NoTypeInfoCStyleCastExpr(Context, type, CK, subExpr);
2666  }
2667  MsgExprs.push_back(subExpr);
2668 
2669  SmallVector<QualType, 4> ArgTypes;
2670  ArgTypes.push_back(Context->getObjCClassType());
2671  ArgTypes.push_back(Context->getObjCSelType());
2672  for (const auto PI : BoxingMethod->parameters())
2673  ArgTypes.push_back(PI->getType());
2674 
2675  QualType returnType = Exp->getType();
2676  // Get the type, we will need to reference it in a couple spots.
2677  QualType msgSendType = MsgSendFlavor->getType();
2678 
2679  // Create a reference to the objc_msgSend() declaration.
2680  DeclRefExpr *DRE = new (Context) DeclRefExpr(
2681  *Context, MsgSendFlavor, false, msgSendType, VK_LValue, SourceLocation());
2682 
2683  CastExpr *cast = NoTypeInfoCStyleCastExpr(
2684  Context, Context->getPointerType(Context->VoidTy), CK_BitCast, DRE);
2685 
2686  // Now do the "normal" pointer to function cast.
2687  QualType castType =
2688  getSimpleFunctionType(returnType, ArgTypes, BoxingMethod->isVariadic());
2689  castType = Context->getPointerType(castType);
2690  cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast,
2691  cast);
2692 
2693  // Don't forget the parens to enforce the proper binding.
2694  ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast);
2695 
2696  auto *FT = msgSendType->castAs<FunctionType>();
2697  CallExpr *CE = CallExpr::Create(*Context, PE, MsgExprs, FT->getReturnType(),
2698  VK_PRValue, EndLoc, FPOptionsOverride());
2699  ReplaceStmt(Exp, CE);
2700  return CE;
2701 }
2702 
2703 Stmt *RewriteModernObjC::RewriteObjCArrayLiteralExpr(ObjCArrayLiteral *Exp) {
2704  // synthesize declaration of helper functions needed in this routine.
2705  if (!SelGetUidFunctionDecl)
2706  SynthSelGetUidFunctionDecl();
2707  // use objc_msgSend() for all.
2708  if (!MsgSendFunctionDecl)
2709  SynthMsgSendFunctionDecl();
2710  if (!GetClassFunctionDecl)
2711  SynthGetClassFunctionDecl();
2712 
2713  FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl;
2714  SourceLocation StartLoc = Exp->getBeginLoc();
2715  SourceLocation EndLoc = Exp->getEndLoc();
2716 
2717  // Build the expression: __NSContainer_literal(int, ...).arr
2718  QualType IntQT = Context->IntTy;
2719  QualType NSArrayFType =
2720  getSimpleFunctionType(Context->VoidTy, IntQT, true);
2721  std::string NSArrayFName("__NSContainer_literal");
2722  FunctionDecl *NSArrayFD = SynthBlockInitFunctionDecl(NSArrayFName);
2723  DeclRefExpr *NSArrayDRE = new (Context) DeclRefExpr(
2724  *Context, NSArrayFD, false, NSArrayFType, VK_PRValue, SourceLocation());
2725 
2726  SmallVector<Expr*, 16> InitExprs;
2727  unsigned NumElements = Exp->getNumElements();
2728  unsigned UnsignedIntSize =
2729  static_cast<unsigned>(Context->getTypeSize(Context->UnsignedIntTy));
2730  Expr *count = IntegerLiteral::Create(*Context,
2731  llvm::APInt(UnsignedIntSize, NumElements),
2732  Context->UnsignedIntTy, SourceLocation());
2733  InitExprs.push_back(count);
2734  for (unsigned i = 0; i < NumElements; i++)
2735  InitExprs.push_back(Exp->getElement(i));
2736  Expr *NSArrayCallExpr =
2737  CallExpr::Create(*Context, NSArrayDRE, InitExprs, NSArrayFType, VK_LValue,
2739 
2740  FieldDecl *ARRFD = FieldDecl::Create(*Context, nullptr, SourceLocation(),
2741  SourceLocation(),
2742  &Context->Idents.get("arr"),
2743  Context->getPointerType(Context->VoidPtrTy),
2744  nullptr, /*BitWidth=*/nullptr,
2745  /*Mutable=*/true, ICIS_NoInit);
2746  MemberExpr *ArrayLiteralME =
2747  MemberExpr::CreateImplicit(*Context, NSArrayCallExpr, false, ARRFD,
2748  ARRFD->getType(), VK_LValue, OK_Ordinary);
2749  QualType ConstIdT = Context->getObjCIdType().withConst();
2750  CStyleCastExpr * ArrayLiteralObjects =
2751  NoTypeInfoCStyleCastExpr(Context,
2752  Context->getPointerType(ConstIdT),
2753  CK_BitCast,
2754  ArrayLiteralME);
2755 
2756  // Synthesize a call to objc_msgSend().
2757  SmallVector<Expr*, 32> MsgExprs;
2758  SmallVector<Expr*, 4> ClsExprs;
2759  QualType expType = Exp->getType();
2760 
2761  // Create a call to objc_getClass("NSArray"). It will be th 1st argument.
2763  expType->getPointeeType()->castAs<ObjCObjectType>()->getInterface();
2764 
2765  IdentifierInfo *clsName = Class->getIdentifier();
2766  ClsExprs.push_back(getStringLiteral(clsName->getName()));
2767  CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs,
2768  StartLoc, EndLoc);
2769  MsgExprs.push_back(Cls);
2770 
2771  // Create a call to sel_registerName("arrayWithObjects:count:").
2772  // it will be the 2nd argument.
2773  SmallVector<Expr*, 4> SelExprs;
2774  ObjCMethodDecl *ArrayMethod = Exp->getArrayWithObjectsMethod();
2775  SelExprs.push_back(
2776  getStringLiteral(ArrayMethod->getSelector().getAsString()));
2777  CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl,
2778  SelExprs, StartLoc, EndLoc);
2779  MsgExprs.push_back(SelExp);
2780 
2781  // (const id [])objects
2782  MsgExprs.push_back(ArrayLiteralObjects);
2783 
2784  // (NSUInteger)cnt
2785  Expr *cnt = IntegerLiteral::Create(*Context,
2786  llvm::APInt(UnsignedIntSize, NumElements),
2787  Context->UnsignedIntTy, SourceLocation());
2788  MsgExprs.push_back(cnt);
2789 
2790  SmallVector<QualType, 4> ArgTypes;
2791  ArgTypes.push_back(Context->getObjCClassType());
2792  ArgTypes.push_back(Context->getObjCSelType());
2793  for (const auto *PI : ArrayMethod->parameters())
2794  ArgTypes.push_back(PI->getType());
2795 
2796  QualType returnType = Exp->getType();
2797  // Get the type, we will need to reference it in a couple spots.
2798  QualType msgSendType = MsgSendFlavor->getType();
2799 
2800  // Create a reference to the objc_msgSend() declaration.
2801  DeclRefExpr *DRE = new (Context) DeclRefExpr(
2802  *Context, MsgSendFlavor, false, msgSendType, VK_LValue, SourceLocation());
2803 
2804  CastExpr *cast = NoTypeInfoCStyleCastExpr(
2805  Context, Context->getPointerType(Context->VoidTy), CK_BitCast, DRE);
2806 
2807  // Now do the "normal" pointer to function cast.
2808  QualType castType =
2809  getSimpleFunctionType(returnType, ArgTypes, ArrayMethod->isVariadic());
2810  castType = Context->getPointerType(castType);
2811  cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast,
2812  cast);
2813 
2814  // Don't forget the parens to enforce the proper binding.
2815  ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast);
2816 
2817  const FunctionType *FT = msgSendType->castAs<FunctionType>();
2818  CallExpr *CE = CallExpr::Create(*Context, PE, MsgExprs, FT->getReturnType(),
2819  VK_PRValue, EndLoc, FPOptionsOverride());
2820  ReplaceStmt(Exp, CE);
2821  return CE;
2822 }
2823 
2824 Stmt *RewriteModernObjC::RewriteObjCDictionaryLiteralExpr(ObjCDictionaryLiteral *Exp) {
2825  // synthesize declaration of helper functions needed in this routine.
2826  if (!SelGetUidFunctionDecl)
2827  SynthSelGetUidFunctionDecl();
2828  // use objc_msgSend() for all.
2829  if (!MsgSendFunctionDecl)
2830  SynthMsgSendFunctionDecl();
2831  if (!GetClassFunctionDecl)
2832  SynthGetClassFunctionDecl();
2833 
2834  FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl;
2835  SourceLocation StartLoc = Exp->getBeginLoc();
2836  SourceLocation EndLoc = Exp->getEndLoc();
2837 
2838  // Build the expression: __NSContainer_literal(int, ...).arr
2839  QualType IntQT = Context->IntTy;
2840  QualType NSDictFType =
2841  getSimpleFunctionType(Context->VoidTy, IntQT, true);
2842  std::string NSDictFName("__NSContainer_literal");
2843  FunctionDecl *NSDictFD = SynthBlockInitFunctionDecl(NSDictFName);
2844  DeclRefExpr *NSDictDRE = new (Context) DeclRefExpr(
2845  *Context, NSDictFD, false, NSDictFType, VK_PRValue, 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  CallExpr::Create(*Context, NSDictDRE, ValueExprs, NSDictFType, VK_LValue,
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 =
2876  MemberExpr::CreateImplicit(*Context, NSValueCallExpr, false, ARRFD,
2877  ARRFD->getType(), VK_LValue, OK_Ordinary);
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  CallExpr::Create(*Context, NSDictDRE, KeyExprs, NSDictFType, VK_LValue,
2888 
2889  MemberExpr *DictLiteralKeyME =
2890  MemberExpr::CreateImplicit(*Context, NSKeyCallExpr, false, ARRFD,
2891  ARRFD->getType(), VK_LValue, OK_Ordinary);
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.
2906  expType->getPointeeType()->castAs<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(
2954  *Context, MsgSendFlavor, false, msgSendType, VK_LValue, SourceLocation());
2955 
2956  CastExpr *cast = NoTypeInfoCStyleCastExpr(
2957  Context, Context->getPointerType(Context->VoidTy), CK_BitCast, DRE);
2958 
2959  // Now do the "normal" pointer to function cast.
2960  QualType castType =
2961  getSimpleFunctionType(returnType, ArgTypes, DictMethod->isVariadic());
2962  castType = Context->getPointerType(castType);
2963  cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast,
2964  cast);
2965 
2966  // Don't forget the parens to enforce the proper binding.
2967  ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast);
2968 
2969  const FunctionType *FT = msgSendType->castAs<FunctionType>();
2970  CallExpr *CE = CallExpr::Create(*Context, PE, MsgExprs, FT->getReturnType(),
2971  VK_PRValue, EndLoc, FPOptionsOverride());
2972  ReplaceStmt(Exp, CE);
2973  return CE;
2974 }
2975 
2976 // struct __rw_objc_super {
2977 // struct objc_object *object; struct objc_object *superClass;
2978 // };
2979 QualType RewriteModernObjC::getSuperStructType() {
2980  if (!SuperStructDecl) {
2981  SuperStructDecl = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
2983  &Context->Idents.get("__rw_objc_super"));
2984  QualType FieldTypes[2];
2985 
2986  // struct objc_object *object;
2987  FieldTypes[0] = Context->getObjCIdType();
2988  // struct objc_object *superClass;
2989  FieldTypes[1] = Context->getObjCIdType();
2990 
2991  // Create fields
2992  for (unsigned i = 0; i < 2; ++i) {
2993  SuperStructDecl->addDecl(FieldDecl::Create(*Context, SuperStructDecl,
2994  SourceLocation(),
2995  SourceLocation(), nullptr,
2996  FieldTypes[i], nullptr,
2997  /*BitWidth=*/nullptr,
2998  /*Mutable=*/false,
2999  ICIS_NoInit));
3000  }
3001 
3002  SuperStructDecl->completeDefinition();
3003  }
3004  return Context->getTagDeclType(SuperStructDecl);
3005 }
3006 
3007 QualType RewriteModernObjC::getConstantStringStructType() {
3008  if (!ConstantStringDecl) {
3009  ConstantStringDecl = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
3011  &Context->Idents.get("__NSConstantStringImpl"));
3012  QualType FieldTypes[4];
3013 
3014  // struct objc_object *receiver;
3015  FieldTypes[0] = Context->getObjCIdType();
3016  // int flags;
3017  FieldTypes[1] = Context->IntTy;
3018  // char *str;
3019  FieldTypes[2] = Context->getPointerType(Context->CharTy);
3020  // long length;
3021  FieldTypes[3] = Context->LongTy;
3022 
3023  // Create fields
3024  for (unsigned i = 0; i < 4; ++i) {
3025  ConstantStringDecl->addDecl(FieldDecl::Create(*Context,
3026  ConstantStringDecl,
3027  SourceLocation(),
3028  SourceLocation(), nullptr,
3029  FieldTypes[i], nullptr,
3030  /*BitWidth=*/nullptr,
3031  /*Mutable=*/true,
3032  ICIS_NoInit));
3033  }
3034 
3035  ConstantStringDecl->completeDefinition();
3036  }
3037  return Context->getTagDeclType(ConstantStringDecl);
3038 }
3039 
3040 /// getFunctionSourceLocation - returns start location of a function
3041 /// definition. Complication arises when function has declared as
3042 /// extern "C" or extern "C" {...}
3043 static SourceLocation getFunctionSourceLocation (RewriteModernObjC &R,
3044  FunctionDecl *FD) {
3045  if (FD->isExternC() && !FD->isMain()) {
3046  const DeclContext *DC = FD->getDeclContext();
3047  if (const LinkageSpecDecl *LSD = dyn_cast<LinkageSpecDecl>(DC))
3048  // if it is extern "C" {...}, return function decl's own location.
3049  if (!LSD->getRBraceLoc().isValid())
3050  return LSD->getExternLoc();
3051  }
3052  if (FD->getStorageClass() != SC_None)
3053  R.RewriteBlockLiteralFunctionDecl(FD);
3054  return FD->getTypeSpecStartLoc();
3055 }
3056 
3057 void RewriteModernObjC::RewriteLineDirective(const Decl *D) {
3058 
3059  SourceLocation Location = D->getLocation();
3060 
3061  if (Location.isFileID() && GenerateLineInfo) {
3062  std::string LineString("\n#line ");
3063  PresumedLoc PLoc = SM->getPresumedLoc(Location);
3064  LineString += utostr(PLoc.getLine());
3065  LineString += " \"";
3066  LineString += Lexer::Stringify(PLoc.getFilename());
3067  if (isa<ObjCMethodDecl>(D))
3068  LineString += "\"";
3069  else LineString += "\"\n";
3070 
3071  Location = D->getBeginLoc();
3072  if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
3073  if (FD->isExternC() && !FD->isMain()) {
3074  const DeclContext *DC = FD->getDeclContext();
3075  if (const LinkageSpecDecl *LSD = dyn_cast<LinkageSpecDecl>(DC))
3076  // if it is extern "C" {...}, return function decl's own location.
3077  if (!LSD->getRBraceLoc().isValid())
3078  Location = LSD->getExternLoc();
3079  }
3080  }
3081  InsertText(Location, LineString);
3082  }
3083 }
3084 
3085 /// SynthMsgSendStretCallExpr - This routine translates message expression
3086 /// into a call to objc_msgSend_stret() entry point. Tricky part is that
3087 /// nil check on receiver must be performed before calling objc_msgSend_stret.
3088 /// MsgSendStretFlavor - function declaration objc_msgSend_stret(...)
3089 /// msgSendType - function type of objc_msgSend_stret(...)
3090 /// returnType - Result type of the method being synthesized.
3091 /// ArgTypes - type of the arguments passed to objc_msgSend_stret, starting with receiver type.
3092 /// MsgExprs - list of argument expressions being passed to objc_msgSend_stret,
3093 /// starting with receiver.
3094 /// Method - Method being rewritten.
3095 Expr *RewriteModernObjC::SynthMsgSendStretCallExpr(FunctionDecl *MsgSendStretFlavor,
3096  QualType returnType,
3097  SmallVectorImpl<QualType> &ArgTypes,
3098  SmallVectorImpl<Expr*> &MsgExprs,
3099  ObjCMethodDecl *Method) {
3100  // Now do the "normal" pointer to function cast.
3101  QualType FuncType = getSimpleFunctionType(
3102  returnType, ArgTypes, Method ? Method->isVariadic() : false);
3103  QualType castType = Context->getPointerType(FuncType);
3104 
3105  // build type for containing the objc_msgSend_stret object.
3106  static unsigned stretCount=0;
3107  std::string name = "__Stret"; name += utostr(stretCount);
3108  std::string str =
3109  "extern \"C\" void * __cdecl memset(void *_Dst, int _Val, size_t _Size);\n";
3110  str += "namespace {\n";
3111  str += "struct "; str += name;
3112  str += " {\n\t";
3113  str += name;
3114  str += "(id receiver, SEL sel";
3115  for (unsigned i = 2; i < ArgTypes.size(); i++) {
3116  std::string ArgName = "arg"; ArgName += utostr(i);
3117  ArgTypes[i].getAsStringInternal(ArgName, Context->getPrintingPolicy());
3118  str += ", "; str += ArgName;
3119  }
3120  // could be vararg.
3121  for (unsigned i = ArgTypes.size(); i < MsgExprs.size(); i++) {
3122  std::string ArgName = "arg"; ArgName += utostr(i);
3123  MsgExprs[i]->getType().getAsStringInternal(ArgName,
3124  Context->getPrintingPolicy());
3125  str += ", "; str += ArgName;
3126  }
3127 
3128  str += ") {\n";
3129  str += "\t unsigned size = sizeof(";
3130  str += returnType.getAsString(Context->getPrintingPolicy()); str += ");\n";
3131 
3132  str += "\t if (size == 1 || size == 2 || size == 4 || size == 8)\n";
3133 
3134  str += "\t s = (("; str += castType.getAsString(Context->getPrintingPolicy());
3135  str += ")(void *)objc_msgSend)(receiver, sel";
3136  for (unsigned i = 2; i < ArgTypes.size(); i++) {
3137  str += ", arg"; str += utostr(i);
3138  }
3139  // could be vararg.
3140  for (unsigned i = ArgTypes.size(); i < MsgExprs.size(); i++) {
3141  str += ", arg"; str += utostr(i);
3142  }
3143  str+= ");\n";
3144 
3145  str += "\t else if (receiver == 0)\n";
3146  str += "\t memset((void*)&s, 0, sizeof(s));\n";
3147  str += "\t else\n";
3148 
3149  str += "\t s = (("; str += castType.getAsString(Context->getPrintingPolicy());
3150  str += ")(void *)objc_msgSend_stret)(receiver, sel";
3151  for (unsigned i = 2; i < ArgTypes.size(); i++) {
3152  str += ", arg"; str += utostr(i);
3153  }
3154  // could be vararg.
3155  for (unsigned i = ArgTypes.size(); i < MsgExprs.size(); i++) {
3156  str += ", arg"; str += utostr(i);
3157  }
3158  str += ");\n";
3159 
3160  str += "\t}\n";
3161  str += "\t"; str += returnType.getAsString(Context->getPrintingPolicy());
3162  str += " s;\n";
3163  str += "};\n};\n\n";
3164  SourceLocation FunLocStart;
3165  if (CurFunctionDef)
3166  FunLocStart = getFunctionSourceLocation(*this, CurFunctionDef);
3167  else {
3168  assert(CurMethodDef && "SynthMsgSendStretCallExpr - CurMethodDef is null");
3169  FunLocStart = CurMethodDef->getBeginLoc();
3170  }
3171 
3172  InsertText(FunLocStart, str);
3173  ++stretCount;
3174 
3175  // AST for __Stretn(receiver, args).s;
3176  IdentifierInfo *ID = &Context->Idents.get(name);
3177  FunctionDecl *FD =
3178  FunctionDecl::Create(*Context, TUDecl, SourceLocation(), SourceLocation(),
3179  ID, FuncType, nullptr, SC_Extern, false, false);
3180  DeclRefExpr *DRE = new (Context)
3181  DeclRefExpr(*Context, FD, false, castType, VK_PRValue, SourceLocation());
3182  CallExpr *STCE =
3183  CallExpr::Create(*Context, DRE, MsgExprs, castType, VK_LValue,
3185 
3186  FieldDecl *FieldD = FieldDecl::Create(*Context, nullptr, SourceLocation(),
3187  SourceLocation(),
3188  &Context->Idents.get("s"),
3189  returnType, nullptr,
3190  /*BitWidth=*/nullptr,
3191  /*Mutable=*/true, ICIS_NoInit);
3192  MemberExpr *ME = MemberExpr::CreateImplicit(
3193  *Context, STCE, false, FieldD, FieldD->getType(), VK_LValue, OK_Ordinary);
3194 
3195  return ME;
3196 }
3197 
3198 Stmt *RewriteModernObjC::SynthMessageExpr(ObjCMessageExpr *Exp,
3199  SourceLocation StartLoc,
3200  SourceLocation EndLoc) {
3201  if (!SelGetUidFunctionDecl)
3202  SynthSelGetUidFunctionDecl();
3203  if (!MsgSendFunctionDecl)
3204  SynthMsgSendFunctionDecl();
3205  if (!MsgSendSuperFunctionDecl)
3206  SynthMsgSendSuperFunctionDecl();
3207  if (!MsgSendStretFunctionDecl)
3208  SynthMsgSendStretFunctionDecl();
3209  if (!MsgSendSuperStretFunctionDecl)
3210  SynthMsgSendSuperStretFunctionDecl();
3211  if (!MsgSendFpretFunctionDecl)
3212  SynthMsgSendFpretFunctionDecl();
3213  if (!GetClassFunctionDecl)
3214  SynthGetClassFunctionDecl();
3215  if (!GetSuperClassFunctionDecl)
3216  SynthGetSuperClassFunctionDecl();
3217  if (!GetMetaClassFunctionDecl)
3218  SynthGetMetaClassFunctionDecl();
3219 
3220  // default to objc_msgSend().
3221  FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl;
3222  // May need to use objc_msgSend_stret() as well.
3223  FunctionDecl *MsgSendStretFlavor = nullptr;
3224  if (ObjCMethodDecl *mDecl = Exp->getMethodDecl()) {
3225  QualType resultType = mDecl->getReturnType();
3226  if (resultType->isRecordType())
3227  MsgSendStretFlavor = MsgSendStretFunctionDecl;
3228  else if (resultType->isRealFloatingType())
3229  MsgSendFlavor = MsgSendFpretFunctionDecl;
3230  }
3231 
3232  // Synthesize a call to objc_msgSend().
3233  SmallVector<Expr*, 8> MsgExprs;
3234  switch (Exp->getReceiverKind()) {
3235  case ObjCMessageExpr::SuperClass: {
3236  MsgSendFlavor = MsgSendSuperFunctionDecl;
3237  if (MsgSendStretFlavor)
3238  MsgSendStretFlavor = MsgSendSuperStretFunctionDecl;
3239  assert(MsgSendFlavor && "MsgSendFlavor is NULL!");
3240 
3241  ObjCInterfaceDecl *ClassDecl = CurMethodDef->getClassInterface();
3242 
3243  SmallVector<Expr*, 4> InitExprs;
3244 
3245  // set the receiver to self, the first argument to all methods.
3246  InitExprs.push_back(NoTypeInfoCStyleCastExpr(
3247  Context, Context->getObjCIdType(), CK_BitCast,
3248  new (Context) DeclRefExpr(*Context, CurMethodDef->getSelfDecl(), false,
3249  Context->getObjCIdType(), VK_PRValue,
3250  SourceLocation()))); // set the 'receiver'.
3251 
3252  // (id)class_getSuperclass((Class)objc_getClass("CurrentClass"))
3253  SmallVector<Expr*, 8> ClsExprs;
3254  ClsExprs.push_back(getStringLiteral(ClassDecl->getIdentifier()->getName()));
3255  // (Class)objc_getClass("CurrentClass")
3256  CallExpr *Cls = SynthesizeCallToFunctionDecl(GetMetaClassFunctionDecl,
3257  ClsExprs, StartLoc, EndLoc);
3258  ClsExprs.clear();
3259  ClsExprs.push_back(Cls);
3260  Cls = SynthesizeCallToFunctionDecl(GetSuperClassFunctionDecl, ClsExprs,
3261  StartLoc, EndLoc);
3262 
3263  // (id)class_getSuperclass((Class)objc_getClass("CurrentClass"))
3264  // To turn off a warning, type-cast to 'id'
3265  InitExprs.push_back( // set 'super class', using class_getSuperclass().
3266  NoTypeInfoCStyleCastExpr(Context,
3267  Context->getObjCIdType(),
3268  CK_BitCast, Cls));
3269  // struct __rw_objc_super
3270  QualType superType = getSuperStructType();
3271  Expr *SuperRep;
3272 
3273  if (LangOpts.MicrosoftExt) {
3274  SynthSuperConstructorFunctionDecl();
3275  // Simulate a constructor call...
3276  DeclRefExpr *DRE = new (Context)
3277  DeclRefExpr(*Context, SuperConstructorFunctionDecl, false, superType,
3279  SuperRep =
3280  CallExpr::Create(*Context, DRE, InitExprs, superType, VK_LValue,
3282  // The code for super is a little tricky to prevent collision with
3283  // the structure definition in the header. The rewriter has it's own
3284  // internal definition (__rw_objc_super) that is uses. This is why
3285  // we need the cast below. For example:
3286  // (struct __rw_objc_super *)&__rw_objc_super((id)self, (id)objc_getClass("SUPER"))
3287  //
3288  SuperRep = UnaryOperator::Create(
3289  const_cast<ASTContext &>(*Context), SuperRep, UO_AddrOf,
3290  Context->getPointerType(SuperRep->getType()), VK_PRValue, OK_Ordinary,
3291  SourceLocation(), false, FPOptionsOverride());
3292  SuperRep = NoTypeInfoCStyleCastExpr(Context,
3293  Context->getPointerType(superType),
3294  CK_BitCast, SuperRep);
3295  } else {
3296  // (struct __rw_objc_super) { <exprs from above> }
3297  InitListExpr *ILE =
3298  new (Context) InitListExpr(*Context, SourceLocation(), InitExprs,
3299  SourceLocation());
3300  TypeSourceInfo *superTInfo
3301  = Context->getTrivialTypeSourceInfo(superType);
3302  SuperRep = new (Context) CompoundLiteralExpr(SourceLocation(), superTInfo,
3303  superType, VK_LValue,
3304  ILE, false);
3305  // struct __rw_objc_super *
3306  SuperRep = UnaryOperator::Create(
3307  const_cast<ASTContext &>(*Context), SuperRep, UO_AddrOf,
3308  Context->getPointerType(SuperRep->getType()), VK_PRValue, OK_Ordinary,
3309  SourceLocation(), false, FPOptionsOverride());
3310  }
3311  MsgExprs.push_back(SuperRep);
3312  break;
3313  }
3314 
3315  case ObjCMessageExpr::Class: {
3316  SmallVector<Expr*, 8> ClsExprs;
3318  = Exp->getClassReceiver()->castAs<ObjCObjectType>()->getInterface();
3319  IdentifierInfo *clsName = Class->getIdentifier();
3320  ClsExprs.push_back(getStringLiteral(clsName->getName()));
3321  CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs,
3322  StartLoc, EndLoc);
3323  CastExpr *ArgExpr = NoTypeInfoCStyleCastExpr(Context,
3324  Context->getObjCIdType(),
3325  CK_BitCast, Cls);
3326  MsgExprs.push_back(ArgExpr);
3327  break;
3328  }
3329 
3330  case ObjCMessageExpr::SuperInstance:{
3331  MsgSendFlavor = MsgSendSuperFunctionDecl;
3332  if (MsgSendStretFlavor)
3333  MsgSendStretFlavor = MsgSendSuperStretFunctionDecl;
3334  assert(MsgSendFlavor && "MsgSendFlavor is NULL!");
3335  ObjCInterfaceDecl *ClassDecl = CurMethodDef->getClassInterface();
3336  SmallVector<Expr*, 4> InitExprs;
3337 
3338  InitExprs.push_back(NoTypeInfoCStyleCastExpr(
3339  Context, Context->getObjCIdType(), CK_BitCast,
3340  new (Context) DeclRefExpr(*Context, CurMethodDef->getSelfDecl(), false,
3341  Context->getObjCIdType(), VK_PRValue,
3342  SourceLocation()))); // set the 'receiver'.
3343 
3344  // (id)class_getSuperclass((Class)objc_getClass("CurrentClass"))
3345  SmallVector<Expr*, 8> ClsExprs;
3346  ClsExprs.push_back(getStringLiteral(ClassDecl->getIdentifier()->getName()));
3347  // (Class)objc_getClass("CurrentClass")
3348  CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs,
3349  StartLoc, EndLoc);
3350  ClsExprs.clear();
3351  ClsExprs.push_back(Cls);
3352  Cls = SynthesizeCallToFunctionDecl(GetSuperClassFunctionDecl, ClsExprs,
3353  StartLoc, EndLoc);
3354 
3355  // (id)class_getSuperclass((Class)objc_getClass("CurrentClass"))
3356  // To turn off a warning, type-cast to 'id'
3357  InitExprs.push_back(
3358  // set 'super class', using class_getSuperclass().
3359  NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(),
3360  CK_BitCast, Cls));
3361  // struct __rw_objc_super
3362  QualType superType = getSuperStructType();
3363  Expr *SuperRep;
3364 
3365  if (LangOpts.MicrosoftExt) {
3366  SynthSuperConstructorFunctionDecl();
3367  // Simulate a constructor call...
3368  DeclRefExpr *DRE = new (Context)
3369  DeclRefExpr(*Context, SuperConstructorFunctionDecl, false, superType,
3371  SuperRep =
3372  CallExpr::Create(*Context, DRE, InitExprs, superType, VK_LValue,
3374  // The code for super is a little tricky to prevent collision with
3375  // the structure definition in the header. The rewriter has it's own
3376  // internal definition (__rw_objc_super) that is uses. This is why
3377  // we need the cast below. For example:
3378  // (struct __rw_objc_super *)&__rw_objc_super((id)self, (id)objc_getClass("SUPER"))
3379  //
3380  SuperRep = UnaryOperator::Create(
3381  const_cast<ASTContext &>(*Context), SuperRep, UO_AddrOf,
3382  Context->getPointerType(SuperRep->getType()), VK_PRValue, OK_Ordinary,
3383  SourceLocation(), false, FPOptionsOverride());
3384  SuperRep = NoTypeInfoCStyleCastExpr(Context,
3385  Context->getPointerType(superType),
3386  CK_BitCast, SuperRep);
3387  } else {
3388  // (struct __rw_objc_super) { <exprs from above> }
3389  InitListExpr *ILE =
3390  new (Context) InitListExpr(*Context, SourceLocation(), InitExprs,
3391  SourceLocation());
3392  TypeSourceInfo *superTInfo
3393  = Context->getTrivialTypeSourceInfo(superType);
3394  SuperRep = new (Context) CompoundLiteralExpr(
3395  SourceLocation(), superTInfo, superType, VK_PRValue, ILE, false);
3396  }
3397  MsgExprs.push_back(SuperRep);
3398  break;
3399  }
3400 
3401  case ObjCMessageExpr::Instance: {
3402  // Remove all type-casts because it may contain objc-style types; e.g.
3403  // Foo<Proto> *.
3404  Expr *recExpr = Exp->getInstanceReceiver();
3405  while (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(recExpr))
3406  recExpr = CE->getSubExpr();
3407  CastKind CK = recExpr->getType()->isObjCObjectPointerType()
3408  ? CK_BitCast : recExpr->getType()->isBlockPointerType()
3409  ? CK_BlockPointerToObjCPointerCast
3410  : CK_CPointerToObjCPointerCast;
3411 
3412  recExpr = NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(),
3413  CK, recExpr);
3414  MsgExprs.push_back(recExpr);
3415  break;
3416  }
3417  }
3418 
3419  // Create a call to sel_registerName("selName"), it will be the 2nd argument.
3420  SmallVector<Expr*, 8> SelExprs;
3421  SelExprs.push_back(getStringLiteral(Exp->getSelector().getAsString()));
3422  CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl,
3423  SelExprs, StartLoc, EndLoc);
3424  MsgExprs.push_back(SelExp);
3425 
3426  // Now push any user supplied arguments.
3427  for (unsigned i = 0; i < Exp->getNumArgs(); i++) {
3428  Expr *userExpr = Exp->getArg(i);
3429  // Make all implicit casts explicit...ICE comes in handy:-)
3430  if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(userExpr)) {
3431  // Reuse the ICE type, it is exactly what the doctor ordered.
3432  QualType type = ICE->getType();
3433  if (needToScanForQualifiers(type))
3434  type = Context->getObjCIdType();
3435  // Make sure we convert "type (^)(...)" to "type (*)(...)".
3436  (void)convertBlockPointerToFunctionPointer(type);
3437  const Expr *SubExpr = ICE->IgnoreParenImpCasts();
3438  CastKind CK;
3439  if (SubExpr->getType()->isIntegralType(*Context) &&
3440  type->isBooleanType()) {
3441  CK = CK_IntegralToBoolean;
3442  } else if (type->isObjCObjectPointerType()) {
3443  if (SubExpr->getType()->isBlockPointerType()) {
3444  CK = CK_BlockPointerToObjCPointerCast;
3445  } else if (SubExpr->getType()->isPointerType()) {
3446  CK = CK_CPointerToObjCPointerCast;
3447  } else {
3448  CK = CK_BitCast;
3449  }
3450  } else {
3451  CK = CK_BitCast;
3452  }
3453 
3454  userExpr = NoTypeInfoCStyleCastExpr(Context, type, CK, userExpr);
3455  }
3456  // Make id<P...> cast into an 'id' cast.
3457  else if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(userExpr)) {
3458  if (CE->getType()->isObjCQualifiedIdType()) {
3459  while ((CE = dyn_cast<CStyleCastExpr>(userExpr)))
3460  userExpr = CE->getSubExpr();
3461  CastKind CK;
3462  if (userExpr->getType()->isIntegralType(*Context)) {
3463  CK = CK_IntegralToPointer;
3464  } else if (userExpr->getType()->isBlockPointerType()) {
3465  CK = CK_BlockPointerToObjCPointerCast;
3466  } else if (userExpr->getType()->isPointerType()) {
3467  CK = CK_CPointerToObjCPointerCast;
3468  } else {
3469  CK = CK_BitCast;
3470  }
3471  userExpr = NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(),
3472  CK, userExpr);
3473  }
3474  }
3475  MsgExprs.push_back(userExpr);
3476  // We've transferred the ownership to MsgExprs. For now, we *don't* null
3477  // out the argument in the original expression (since we aren't deleting
3478  // the ObjCMessageExpr). See RewritePropertyOrImplicitSetter() usage for more info.
3479  //Exp->setArg(i, 0);
3480  }
3481  // Generate the funky cast.
3482  CastExpr *cast;
3483  SmallVector<QualType, 8> ArgTypes;
3484  QualType returnType;
3485 
3486  // Push 'id' and 'SEL', the 2 implicit arguments.
3487  if (MsgSendFlavor == MsgSendSuperFunctionDecl)
3488  ArgTypes.push_back(Context->getPointerType(getSuperStructType()));
3489  else
3490  ArgTypes.push_back(Context->getObjCIdType());
3491  ArgTypes.push_back(Context->getObjCSelType());
3492  if (ObjCMethodDecl *OMD = Exp->getMethodDecl()) {
3493  // Push any user argument types.
3494  for (const auto *PI : OMD->parameters()) {
3495  QualType t = PI->getType()->isObjCQualifiedIdType()
3496  ? Context->getObjCIdType()
3497  : PI->getType();
3498  // Make sure we convert "t (^)(...)" to "t (*)(...)".
3499  (void)convertBlockPointerToFunctionPointer(t);
3500  ArgTypes.push_back(t);
3501  }
3502  returnType = Exp->getType();
3503  convertToUnqualifiedObjCType(returnType);
3504  (void)convertBlockPointerToFunctionPointer(returnType);
3505  } else {
3506  returnType = Context->getObjCIdType();
3507  }
3508  // Get the type, we will need to reference it in a couple spots.
3509  QualType msgSendType = MsgSendFlavor->getType();
3510 
3511  // Create a reference to the objc_msgSend() declaration.
3512  DeclRefExpr *DRE = new (Context) DeclRefExpr(
3513  *Context, MsgSendFlavor, false, msgSendType, VK_LValue, SourceLocation());
3514 
3515  // Need to cast objc_msgSend to "void *" (to workaround a GCC bandaid).
3516  // If we don't do this cast, we get the following bizarre warning/note:
3517  // xx.m:13: warning: function called through a non-compatible type
3518  // xx.m:13: note: if this code is reached, the program will abort
3519  cast = NoTypeInfoCStyleCastExpr(Context,
3520  Context->getPointerType(Context->VoidTy),
3521  CK_BitCast, DRE);
3522 
3523  // Now do the "normal" pointer to function cast.
3524  // If we don't have a method decl, force a variadic cast.
3525  const ObjCMethodDecl *MD = Exp->getMethodDecl();
3526  QualType castType =
3527  getSimpleFunctionType(returnType, ArgTypes, MD ? MD->isVariadic() : true);
3528  castType = Context->getPointerType(castType);
3529  cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast,
3530  cast);
3531 
3532  // Don't forget the parens to enforce the proper binding.
3533  ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast);
3534 
3535  const FunctionType *FT = msgSendType->castAs<FunctionType>();
3536  CallExpr *CE = CallExpr::Create(*Context, PE, MsgExprs, FT->getReturnType(),
3537  VK_PRValue, EndLoc, FPOptionsOverride());
3538  Stmt *ReplacingStmt = CE;
3539  if (MsgSendStretFlavor) {
3540  // We have the method which returns a struct/union. Must also generate
3541  // call to objc_msgSend_stret and hang both varieties on a conditional
3542  // expression which dictate which one to envoke depending on size of
3543  // method's return type.
3544 
3545  Expr *STCE = SynthMsgSendStretCallExpr(MsgSendStretFlavor,
3546  returnType,
3547  ArgTypes, MsgExprs,
3548  Exp->getMethodDecl());
3549  ReplacingStmt = STCE;
3550  }
3551  // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
3552  return ReplacingStmt;
3553 }
3554 
3555 Stmt *RewriteModernObjC::RewriteMessageExpr(ObjCMessageExpr *Exp) {
3556  Stmt *ReplacingStmt =
3557  SynthMessageExpr(Exp, Exp->getBeginLoc(), Exp->getEndLoc());
3558 
3559  // Now do the actual rewrite.
3560  ReplaceStmt(Exp, ReplacingStmt);
3561 
3562  // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
3563  return ReplacingStmt;
3564 }
3565 
3566 // typedef struct objc_object Protocol;
3567 QualType RewriteModernObjC::getProtocolType() {
3568  if (!ProtocolTypeDecl) {
3569  TypeSourceInfo *TInfo
3570  = Context->getTrivialTypeSourceInfo(Context->getObjCIdType());
3571  ProtocolTypeDecl = TypedefDecl::Create(*Context, TUDecl,
3573  &Context->Idents.get("Protocol"),
3574  TInfo);
3575  }
3576  return Context->getTypeDeclType(ProtocolTypeDecl);
3577 }
3578 
3579 /// RewriteObjCProtocolExpr - Rewrite a protocol expression into
3580 /// a synthesized/forward data reference (to the protocol's metadata).
3581 /// The forward references (and metadata) are generated in
3582 /// RewriteModernObjC::HandleTranslationUnit().
3583 Stmt *RewriteModernObjC::RewriteObjCProtocolExpr(ObjCProtocolExpr *Exp) {
3584  std::string Name = "_OBJC_PROTOCOL_REFERENCE_$_" +
3585  Exp->getProtocol()->getNameAsString();
3586  IdentifierInfo *ID = &Context->Idents.get(Name);
3587  VarDecl *VD = VarDecl::Create(*Context, TUDecl, SourceLocation(),
3588  SourceLocation(), ID, getProtocolType(),
3589  nullptr, SC_Extern);
3590  DeclRefExpr *DRE = new (Context) DeclRefExpr(
3591  *Context, VD, false, getProtocolType(), VK_LValue, SourceLocation());
3592  CastExpr *castExpr = NoTypeInfoCStyleCastExpr(
3593  Context, Context->getPointerType(DRE->getType()), CK_BitCast, DRE);
3594  ReplaceStmt(Exp, castExpr);
3595  ProtocolExprDecls.insert(Exp->getProtocol()->getCanonicalDecl());
3596  // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info.
3597  return castExpr;
3598 }
3599 
3600 /// IsTagDefinedInsideClass - This routine checks that a named tagged type
3601 /// is defined inside an objective-c class. If so, it returns true.
3602 bool RewriteModernObjC::IsTagDefinedInsideClass(ObjCContainerDecl *IDecl,
3603  TagDecl *Tag,
3604  bool &IsNamedDefinition) {
3605  if (!IDecl)
3606  return false;
3607  SourceLocation TagLocation;
3608  if (RecordDecl *RD = dyn_cast<RecordDecl>(Tag)) {
3609  RD = RD->getDefinition();
3610  if (!RD || !RD->getDeclName().getAsIdentifierInfo())
3611  return false;
3612  IsNamedDefinition = true;
3613  TagLocation = RD->getLocation();
3614  return Context->getSourceManager().isBeforeInTranslationUnit(
3615  IDecl->getLocation(), TagLocation);
3616  }
3617  if (EnumDecl *ED = dyn_cast<EnumDecl>(Tag)) {
3618  if (!ED || !ED->getDeclName().getAsIdentifierInfo())
3619  return false;
3620  IsNamedDefinition = true;
3621  TagLocation = ED->getLocation();
3622  return Context->getSourceManager().isBeforeInTranslationUnit(
3623  IDecl->getLocation(), TagLocation);
3624  }
3625  return false;
3626 }
3627 
3628 /// RewriteObjCFieldDeclType - This routine rewrites a type into the buffer.
3629 /// It handles elaborated types, as well as enum types in the process.
3630 bool RewriteModernObjC::RewriteObjCFieldDeclType(QualType &Type,
3631  std::string &Result) {
3632  if (Type->getAs<TypedefType>()) {
3633  Result += "\t";
3634  return false;
3635  }
3636 
3637  if (Type->isArrayType()) {
3638  QualType ElemTy = Context->getBaseElementType(Type);
3639  return RewriteObjCFieldDeclType(ElemTy, Result);
3640  }
3641  else if (Type->isRecordType()) {
3642  RecordDecl *RD = Type->castAs<RecordType>()->getDecl();
3643  if (RD->isCompleteDefinition()) {
3644  if (RD->isStruct())
3645  Result += "\n\tstruct ";
3646  else if (RD->isUnion())
3647  Result += "\n\tunion ";
3648  else
3649  assert(false && "class not allowed as an ivar type");
3650 
3651  Result += RD->getName();
3652  if (GlobalDefinedTags.count(RD)) {
3653  // struct/union is defined globally, use it.
3654  Result += " ";
3655  return true;
3656  }
3657  Result += " {\n";
3658  for (auto *FD : RD->fields())
3659  RewriteObjCFieldDecl(FD, Result);
3660  Result += "\t} ";
3661  return true;
3662  }
3663  }
3664  else if (Type->isEnumeralType()) {
3665  EnumDecl *ED = Type->castAs<EnumType>()->getDecl();
3666  if (ED->isCompleteDefinition()) {
3667  Result += "\n\tenum ";
3668  Result += ED->getName();
3669  if (GlobalDefinedTags.count(ED)) {
3670  // Enum is globall defined, use it.
3671  Result += " ";
3672  return true;
3673  }
3674 
3675  Result += " {\n";
3676  for (const auto *EC : ED->enumerators()) {
3677  Result += "\t"; Result += EC->getName(); Result += " = ";
3678  Result += toString(EC->getInitVal(), 10);
3679  Result += ",\n";
3680  }
3681  Result += "\t} ";
3682  return true;
3683  }
3684  }
3685 
3686  Result += "\t";
3687  convertObjCTypeToCStyleType(Type);
3688  return false;
3689 }
3690 
3691 
3692 /// RewriteObjCFieldDecl - This routine rewrites a field into the buffer.
3693 /// It handles elaborated types, as well as enum types in the process.
3694 void RewriteModernObjC::RewriteObjCFieldDecl(FieldDecl *fieldDecl,
3695  std::string &Result) {
3696  QualType Type = fieldDecl->getType();
3697  std::string Name = fieldDecl->getNameAsString();
3698 
3699  bool EleboratedType = RewriteObjCFieldDeclType(Type, Result);
3700  if (!EleboratedType)
3701  Type.getAsStringInternal(Name, Context->getPrintingPolicy());
3702  Result += Name;
3703  if (fieldDecl->isBitField()) {
3704  Result += " : "; Result += utostr(fieldDecl->getBitWidthValue(*Context));
3705  }
3706  else if (EleboratedType && Type->isArrayType()) {
3707  const ArrayType *AT = Context->getAsArrayType(Type);
3708  do {
3709  if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(AT)) {
3710  Result += "[";
3711  llvm::APInt Dim = CAT->getSize();
3712  Result += utostr(Dim.getZExtValue());
3713  Result += "]";
3714  }
3715  AT = Context->getAsArrayType(AT->getElementType());
3716  } while (AT);
3717  }
3718 
3719  Result += ";\n";
3720 }
3721 
3722 /// RewriteLocallyDefinedNamedAggregates - This routine rewrites locally defined
3723 /// named aggregate types into the input buffer.
3724 void RewriteModernObjC::RewriteLocallyDefinedNamedAggregates(FieldDecl *fieldDecl,
3725  std::string &Result) {
3726  QualType Type = fieldDecl->getType();
3727  if (Type->getAs<TypedefType>())
3728  return;
3729  if (Type->isArrayType())
3730  Type = Context->getBaseElementType(Type);
3731 
3732  auto *IDecl = dyn_cast<ObjCContainerDecl>(fieldDecl->getDeclContext());
3733 
3734  TagDecl *TD = nullptr;
3735  if (Type->isRecordType()) {
3736  TD = Type->castAs<RecordType>()->getDecl();
3737  }
3738  else if (Type->isEnumeralType()) {
3739  TD = Type->castAs<EnumType>()->getDecl();
3740  }
3741 
3742  if (TD) {
3743  if (GlobalDefinedTags.count(TD))
3744  return;
3745 
3746  bool IsNamedDefinition = false;
3747  if (IsTagDefinedInsideClass(IDecl, TD, IsNamedDefinition)) {
3748  RewriteObjCFieldDeclType(Type, Result);
3749  Result += ";";
3750  }
3751  if (IsNamedDefinition)
3752  GlobalDefinedTags.insert(TD);
3753  }
3754 }
3755 
3756 unsigned RewriteModernObjC::ObjCIvarBitfieldGroupNo(ObjCIvarDecl *IV) {
3757  const ObjCInterfaceDecl *CDecl = IV->getContainingInterface();
3758  if (ObjCInterefaceHasBitfieldGroups.count(CDecl)) {
3759  return IvarGroupNumber[IV];
3760  }
3761  unsigned GroupNo = 0;
3763  for (const ObjCIvarDecl *IVD = CDecl->all_declared_ivar_begin();
3764  IVD; IVD = IVD->getNextIvar())
3765  IVars.push_back(IVD);
3766 
3767  for (unsigned i = 0, e = IVars.size(); i < e; i++)
3768  if (IVars[i]->isBitField()) {
3769  IvarGroupNumber[IVars[i++]] = ++GroupNo;
3770  while (i < e && IVars[i]->isBitField())
3771  IvarGroupNumber[IVars[i++]] = GroupNo;
3772  if (i < e)
3773  --i;
3774  }
3775 
3776  ObjCInterefaceHasBitfieldGroups.insert(CDecl);
3777  return IvarGroupNumber[IV];
3778 }
3779 
3780 QualType RewriteModernObjC::SynthesizeBitfieldGroupStructType(
3781  ObjCIvarDecl *IV,
3783  std::string StructTagName;
3784  ObjCIvarBitfieldGroupType(IV, StructTagName);
3785  RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct,
3786  Context->getTranslationUnitDecl(),
3788  &Context->Idents.get(StructTagName));
3789  for (unsigned i=0, e = IVars.size(); i < e; i++) {
3790  ObjCIvarDecl *Ivar = IVars[i];
3791  RD->addDecl(FieldDecl::Create(*Context, RD, SourceLocation(), SourceLocation(),
3792  &Context->Idents.get(Ivar->getName()),
3793  Ivar->getType(),
3794  nullptr, /*Expr *BW */Ivar->getBitWidth(),
3795  false, ICIS_NoInit));
3796  }
3797  RD->completeDefinition();
3798  return Context->getTagDeclType(RD);
3799 }
3800 
3801 QualType RewriteModernObjC::GetGroupRecordTypeForObjCIvarBitfield(ObjCIvarDecl *IV) {
3802  const ObjCInterfaceDecl *CDecl = IV->getContainingInterface();
3803  unsigned GroupNo = ObjCIvarBitfieldGroupNo(IV);
3804  std::pair<const ObjCInterfaceDecl*, unsigned> tuple = std::make_pair(CDecl, GroupNo);
3805  if (GroupRecordType.count(tuple))
3806  return GroupRecordType[tuple];
3807 
3809  for (const ObjCIvarDecl *IVD = CDecl->all_declared_ivar_begin();
3810  IVD; IVD = IVD->getNextIvar()) {
3811  if (IVD->isBitField())
3812  IVars.push_back(const_cast<ObjCIvarDecl *>(IVD));
3813  else {
3814  if (!IVars.empty()) {
3815  unsigned GroupNo = ObjCIvarBitfieldGroupNo(IVars[0]);
3816  // Generate the struct type for this group of bitfield ivars.
3817  GroupRecordType[std::make_pair(CDecl, GroupNo)] =
3818  SynthesizeBitfieldGroupStructType(IVars[0], IVars);
3819  IVars.clear();
3820  }
3821  }
3822  }
3823  if (!IVars.empty()) {
3824  // Do the last one.
3825  unsigned GroupNo = ObjCIvarBitfieldGroupNo(IVars[0]);
3826  GroupRecordType[std::make_pair(CDecl, GroupNo)] =
3827  SynthesizeBitfieldGroupStructType(IVars[0], IVars);
3828  }
3829  QualType RetQT = GroupRecordType[tuple];
3830  assert(!RetQT.isNull() && "GetGroupRecordTypeForObjCIvarBitfield struct type is NULL");
3831 
3832  return RetQT;
3833 }
3834 
3835 /// ObjCIvarBitfieldGroupDecl - Names field decl. for ivar bitfield group.
3836 /// Name would be: classname__GRBF_n where n is the group number for this ivar.
3837 void RewriteModernObjC::ObjCIvarBitfieldGroupDecl(ObjCIvarDecl *IV,
3838  std::string &Result) {
3839  const ObjCInterfaceDecl *CDecl = IV->getContainingInterface();
3840  Result += CDecl->getName();
3841  Result += "__GRBF_";
3842  unsigned GroupNo = ObjCIvarBitfieldGroupNo(IV);
3843  Result += utostr(GroupNo);
3844 }
3845 
3846 /// ObjCIvarBitfieldGroupType - Names struct type for ivar bitfield group.
3847 /// Name of the struct would be: classname__T_n where n is the group number for
3848 /// this ivar.
3849 void RewriteModernObjC::ObjCIvarBitfieldGroupType(ObjCIvarDecl *IV,
3850  std::string &Result) {
3851  const ObjCInterfaceDecl *CDecl = IV->getContainingInterface();
3852  Result += CDecl->getName();
3853  Result += "__T_";
3854  unsigned GroupNo = ObjCIvarBitfieldGroupNo(IV);
3855  Result += utostr(GroupNo);
3856 }
3857 
3858 /// ObjCIvarBitfieldGroupOffset - Names symbol for ivar bitfield group field offset.
3859 /// Name would be: OBJC_IVAR_$_classname__GRBF_n where n is the group number for
3860 /// this ivar.
3861 void RewriteModernObjC::ObjCIvarBitfieldGroupOffset(ObjCIvarDecl *IV,
3862  std::string &Result) {
3863  Result += "OBJC_IVAR_$_";
3864  ObjCIvarBitfieldGroupDecl(IV, Result);
3865 }
3866 
3867 #define SKIP_BITFIELDS(IX, ENDIX, VEC) { \
3868  while ((IX < ENDIX) && VEC[IX]->isBitField()) \
3869  ++IX; \
3870  if (IX < ENDIX) \
3871  --IX; \
3872 }
3873 
3874 /// RewriteObjCInternalStruct - Rewrite one internal struct corresponding to
3875 /// an objective-c class with ivars.
3876 void RewriteModernObjC::RewriteObjCInternalStruct(ObjCInterfaceDecl *CDecl,
3877  std::string &Result) {
3878  assert(CDecl && "Class missing in SynthesizeObjCInternalStruct");
3879  assert(CDecl->getName() != "" &&
3880  "Name missing in SynthesizeObjCInternalStruct");
3881  ObjCInterfaceDecl *RCDecl = CDecl->getSuperClass();
3883  for (ObjCIvarDecl *IVD = CDecl->all_declared_ivar_begin();
3884  IVD; IVD = IVD->getNextIvar())
3885  IVars.push_back(IVD);
3886 
3887  SourceLocation LocStart = CDecl->getBeginLoc();
3888  SourceLocation LocEnd = CDecl->getEndOfDefinitionLoc();
3889 
3890  const char *startBuf = SM->getCharacterData(LocStart);
3891  const char *endBuf = SM->getCharacterData(LocEnd);
3892 
3893  // If no ivars and no root or if its root, directly or indirectly,
3894  // have no ivars (thus not synthesized) then no need to synthesize this class.
3895  if ((!CDecl->isThisDeclarationADefinition() || IVars.size() == 0) &&
3896  (!RCDecl || !ObjCSynthesizedStructs.count(RCDecl))) {
3897  endBuf += Lexer::MeasureTokenLength(LocEnd, *SM, LangOpts);
3898  ReplaceText(LocStart, endBuf-startBuf, Result);
3899  return;
3900  }
3901 
3902  // Insert named struct/union definitions inside class to
3903  // outer scope. This follows semantics of locally defined
3904  // struct/unions in objective-c classes.
3905  for (unsigned i = 0, e = IVars.size(); i < e; i++)
3906  RewriteLocallyDefinedNamedAggregates(IVars[i], Result);
3907 
3908  // Insert named structs which are syntheized to group ivar bitfields
3909  // to outer scope as well.
3910  for (unsigned i = 0, e = IVars.size(); i < e; i++)
3911  if (IVars[i]->isBitField()) {
3912  ObjCIvarDecl *IV = IVars[i];
3913  QualType QT = GetGroupRecordTypeForObjCIvarBitfield(IV);
3914  RewriteObjCFieldDeclType(QT, Result);
3915  Result += ";";
3916  // skip over ivar bitfields in this group.
3917  SKIP_BITFIELDS(i , e, IVars);
3918  }
3919 
3920  Result += "\nstruct ";
3921  Result += CDecl->getNameAsString();
3922  Result += "_IMPL {\n";
3923 
3924  if (RCDecl && ObjCSynthesizedStructs.count(RCDecl)) {
3925  Result += "\tstruct "; Result += RCDecl->getNameAsString();
3926  Result += "_IMPL "; Result += RCDecl->getNameAsString();
3927  Result += "_IVARS;\n";
3928  }
3929 
3930  for (unsigned i = 0, e = IVars.size(); i < e; i++) {
3931  if (IVars[i]->isBitField()) {
3932  ObjCIvarDecl *IV = IVars[i];
3933  Result += "\tstruct ";
3934  ObjCIvarBitfieldGroupType(IV, Result); Result += " ";
3935  ObjCIvarBitfieldGroupDecl(IV, Result); Result += ";\n";
3936  // skip over ivar bitfields in this group.
3937  SKIP_BITFIELDS(i , e, IVars);
3938  }
3939  else
3940  RewriteObjCFieldDecl(IVars[i], Result);
3941  }
3942 
3943  Result += "};\n";
3944  endBuf += Lexer::MeasureTokenLength(LocEnd, *SM, LangOpts);
3945  ReplaceText(LocStart, endBuf-startBuf, Result);
3946  // Mark this struct as having been generated.
3947  if (!ObjCSynthesizedStructs.insert(CDecl).second)
3948  llvm_unreachable("struct already synthesize- RewriteObjCInternalStruct");
3949 }
3950 
3951 /// RewriteIvarOffsetSymbols - Rewrite ivar offset symbols of those ivars which
3952 /// have been referenced in an ivar access expression.
3953 void RewriteModernObjC::RewriteIvarOffsetSymbols(ObjCInterfaceDecl *CDecl,
3954  std::string &Result) {
3955  // write out ivar offset symbols which have been referenced in an ivar
3956  // access expression.
3957  llvm::SmallSetVector<ObjCIvarDecl *, 8> Ivars = ReferencedIvars[CDecl];
3958 
3959  if (Ivars.empty())
3960  return;
3961 
3963  for (ObjCIvarDecl *IvarDecl : Ivars) {
3964  const ObjCInterfaceDecl *IDecl = IvarDecl->getContainingInterface();
3965  unsigned GroupNo = 0;
3966  if (IvarDecl->isBitField()) {
3967  GroupNo = ObjCIvarBitfieldGroupNo(IvarDecl);
3968  if (GroupSymbolOutput.count(std::make_pair(IDecl, GroupNo)))
3969  continue;
3970  }
3971  Result += "\n";
3972  if (LangOpts.MicrosoftExt)
3973  Result += "__declspec(allocate(\".objc_ivar$B\")) ";
3974  Result += "extern \"C\" ";
3975  if (LangOpts.MicrosoftExt &&
3976  IvarDecl->getAccessControl() != ObjCIvarDecl::Private &&
3977  IvarDecl->getAccessControl() != ObjCIvarDecl::Package)
3978  Result += "__declspec(dllimport) ";
3979 
3980  Result += "unsigned long ";
3981  if (IvarDecl->isBitField()) {
3982  ObjCIvarBitfieldGroupOffset(IvarDecl, Result);
3983  GroupSymbolOutput.insert(std::make_pair(IDecl, GroupNo));
3984  }
3985  else
3986  WriteInternalIvarName(CDecl, IvarDecl, Result);
3987  Result += ";";
3988  }
3989 }
3990 
3991 //===----------------------------------------------------------------------===//
3992 // Meta Data Emission
3993 //===----------------------------------------------------------------------===//
3994 
3995 /// RewriteImplementations - This routine rewrites all method implementations
3996 /// and emits meta-data.
3997 
3998 void RewriteModernObjC::RewriteImplementations() {
3999  int ClsDefCount = ClassImplementation.size();
4000  int CatDefCount = CategoryImplementation.size();
4001 
4002  // Rewrite implemented methods
4003  for (int i = 0; i < ClsDefCount; i++) {
4004  ObjCImplementationDecl *OIMP = ClassImplementation[i];
4005  ObjCInterfaceDecl *CDecl = OIMP->getClassInterface();
4006  if (CDecl->isImplicitInterfaceDecl())
4007  assert(false &&
4008  "Legacy implicit interface rewriting not supported in moder abi");
4009  RewriteImplementationDecl(OIMP);
4010  }
4011 
4012  for (int i = 0; i < CatDefCount; i++) {
4013  ObjCCategoryImplDecl *CIMP = CategoryImplementation[i];
4014  ObjCInterfaceDecl *CDecl = CIMP->getClassInterface();
4015  if (CDecl->isImplicitInterfaceDecl())
4016  assert(false &&
4017  "Legacy implicit interface rewriting not supported in moder abi");
4018  RewriteImplementationDecl(CIMP);
4019  }
4020 }
4021 
4022 void RewriteModernObjC::RewriteByRefString(std::string &ResultStr,
4023  const std::string &Name,
4024  ValueDecl *VD, bool def) {
4025  assert(BlockByRefDeclNo.count(VD) &&
4026  "RewriteByRefString: ByRef decl missing");
4027  if (def)
4028  ResultStr += "struct ";
4029  ResultStr += "__Block_byref_" + Name +
4030  "_" + utostr(BlockByRefDeclNo[VD]) ;
4031 }
4032 
4034  if (VarDecl *Var = dyn_cast<VarDecl>(VD))
4035  return (Var->isFunctionOrMethodVarDecl() && !Var->hasLocalStorage());
4036  return false;
4037 }
4038 
4039 std::string RewriteModernObjC::SynthesizeBlockFunc(BlockExpr *CE, int i,
4040  StringRef funcName,
4041  std::string Tag) {
4042  const FunctionType *AFT = CE->getFunctionType();
4043  QualType RT = AFT->getReturnType();
4044  std::string StructRef = "struct " + Tag;
4045  SourceLocation BlockLoc = CE->getExprLoc();
4046  std::string S;
4047  ConvertSourceLocationToLineDirective(BlockLoc, S);
4048 
4049  S += "static " + RT.getAsString(Context->getPrintingPolicy()) + " __" +
4050  funcName.str() + "_block_func_" + utostr(i);
4051 
4052  BlockDecl *BD = CE->getBlockDecl();
4053 
4054  if (isa<FunctionNoProtoType>(AFT)) {
4055  // No user-supplied arguments. Still need to pass in a pointer to the
4056  // block (to reference imported block decl refs).
4057  S += "(" + StructRef + " *__cself)";
4058  } else if (BD->param_empty()) {
4059  S += "(" + StructRef + " *__cself)";
4060  } else {
4061  const FunctionProtoType *FT = cast<FunctionProtoType>(AFT);
4062  assert(FT && "SynthesizeBlockFunc: No function proto");
4063  S += '(';
4064  // first add the implicit argument.
4065  S += StructRef + " *__cself, ";
4066  std::string ParamStr;
4067  for (BlockDecl::param_iterator AI = BD->param_begin(),
4068  E = BD->param_end(); AI != E; ++AI) {
4069  if (AI != BD->param_begin()) S += ", ";
4070  ParamStr = (*AI)->getNameAsString();
4071  QualType QT = (*AI)->getType();
4072  (void)convertBlockPointerToFunctionPointer(QT);
4073  QT.getAsStringInternal(ParamStr, Context->getPrintingPolicy());
4074  S += ParamStr;
4075  }
4076  if (FT->isVariadic()) {
4077  if (!BD->param_empty()) S += ", ";
4078  S += "...";
4079  }
4080  S += ')';
4081  }
4082  S += " {\n";
4083 
4084  // Create local declarations to avoid rewriting all closure decl ref exprs.
4085  // First, emit a declaration for all "by ref" decls.
4086  for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(),
4087  E = BlockByRefDecls.end(); I != E; ++I) {
4088  S += " ";
4089  std::string Name = (*I)->getNameAsString();
4090  std::string TypeString;
4091  RewriteByRefString(TypeString, Name, (*I));
4092  TypeString += " *";
4093  Name = TypeString + Name;
4094  S += Name + " = __cself->" + (*I)->getNameAsString() + "; // bound by ref\n";
4095  }
4096  // Next, emit a declaration for all "by copy" declarations.
4097  for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(),
4098  E = BlockByCopyDecls.end(); I != E; ++I) {
4099  S += " ";
4100  // Handle nested closure invocation. For example:
4101  //
4102  // void (^myImportedClosure)(void);
4103  // myImportedClosure = ^(void) { setGlobalInt(x + y); };
4104  //
4105  // void (^anotherClosure)(void);
4106  // anotherClosure = ^(void) {
4107  // myImportedClosure(); // import and invoke the closure
4108  // };
4109  //
4110  if (isTopLevelBlockPointerType((*I)->getType())) {
4111  RewriteBlockPointerTypeVariable(S, (*I));
4112  S += " = (";
4113  RewriteBlockPointerType(S, (*I)->getType());
4114  S += ")";
4115  S += "__cself->" + (*I)->getNameAsString() + "; // bound by copy\n";
4116  }
4117  else {
4118  std::string Name = (*I)->getNameAsString();
4119  QualType QT = (*I)->getType();
4121  QT = Context->getPointerType(QT);
4122  QT.getAsStringInternal(Name, Context->getPrintingPolicy());
4123  S += Name + " = __cself->" +
4124  (*I)->getNameAsString() + "; // bound by copy\n";
4125  }
4126  }
4127  std::string RewrittenStr = RewrittenBlockExprs[CE];
4128  const char *cstr = RewrittenStr.c_str();
4129  while (*cstr++ != '{') ;
4130  S += cstr;
4131  S += "\n";
4132  return S;
4133 }
4134 
4135 std::string RewriteModernObjC::SynthesizeBlockHelperFuncs(BlockExpr *CE, int i,
4136  StringRef funcName,
4137  std::string Tag) {
4138  std::string StructRef = "struct " + Tag;
4139  std::string S = "static void __";
4140 
4141  S += funcName;
4142  S += "_block_copy_" + utostr(i);
4143  S += "(" + StructRef;
4144  S += "*dst, " + StructRef;
4145  S += "*src) {";
4146  for (ValueDecl *VD : ImportedBlockDecls) {
4147  S += "_Block_object_assign((void*)&dst->";
4148  S += VD->getNameAsString();
4149  S += ", (void*)src->";
4150  S += VD->getNameAsString();
4151  if (BlockByRefDeclsPtrSet.count(VD))
4152  S += ", " + utostr(BLOCK_FIELD_IS_BYREF) + "/*BLOCK_FIELD_IS_BYREF*/);";
4153  else if (VD->getType()->isBlockPointerType())
4154  S += ", " + utostr(BLOCK_FIELD_IS_BLOCK) + "/*BLOCK_FIELD_IS_BLOCK*/);";
4155  else
4156  S += ", " + utostr(BLOCK_FIELD_IS_OBJECT) + "/*BLOCK_FIELD_IS_OBJECT*/);";
4157  }
4158  S += "}\n";
4159 
4160  S += "\nstatic void __";
4161  S += funcName;
4162  S += "_block_dispose_" + utostr(i);
4163  S += "(" + StructRef;
4164  S += "*src) {";
4165  for (ValueDecl *VD : ImportedBlockDecls) {
4166  S += "_Block_object_dispose((void*)src->";
4167  S += VD->getNameAsString();
4168  if (BlockByRefDeclsPtrSet.count(VD))
4169  S += ", " + utostr(BLOCK_FIELD_IS_BYREF) + "/*BLOCK_FIELD_IS_BYREF*/);";
4170  else if (VD->getType()->isBlockPointerType())
4171  S += ", " + utostr(BLOCK_FIELD_IS_BLOCK) + "/*BLOCK_FIELD_IS_BLOCK*/);";
4172  else
4173  S += ", " + utostr(BLOCK_FIELD_IS_OBJECT) + "/*BLOCK_FIELD_IS_OBJECT*/);";
4174  }
4175  S += "}\n";
4176  return S;
4177 }
4178 
4179 std::string RewriteModernObjC::SynthesizeBlockImpl(BlockExpr *CE, std::string Tag,
4180  std::string Desc) {
4181  std::string S = "\nstruct " + Tag;
4182  std::string Constructor = " " + Tag;
4183 
4184  S += " {\n struct __block_impl impl;\n";
4185  S += " struct " + Desc;
4186  S += "* Desc;\n";
4187 
4188  Constructor += "(void *fp, "; // Invoke function pointer.
4189  Constructor += "struct " + Desc; // Descriptor pointer.
4190  Constructor += " *desc";
4191 
4192  if (BlockDeclRefs.size()) {
4193  // Output all "by copy" declarations.
4194  for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(),
4195  E = BlockByCopyDecls.end(); I != E; ++I) {
4196  S += " ";
4197  std::string FieldName = (*I)->getNameAsString();
4198  std::string ArgName = "_" + FieldName;
4199  // Handle nested closure invocation. For example:
4200  //
4201  // void (^myImportedBlock)(void);
4202  // myImportedBlock = ^(void) { setGlobalInt(x + y); };
4203  //
4204  // void (^anotherBlock)(void);
4205  // anotherBlock = ^(void) {
4206  // myImportedBlock(); // import and invoke the closure
4207  // };
4208  //
4209  if (isTopLevelBlockPointerType((*I)->getType())) {
4210  S += "struct __block_impl *";
4211  Constructor += ", void *" + ArgName;
4212  } else {
4213  QualType QT = (*I)->getType();
4215  QT = Context->getPointerType(QT);
4216  QT.getAsStringInternal(FieldName, Context->getPrintingPolicy());
4217  QT.getAsStringInternal(ArgName, Context->getPrintingPolicy());
4218  Constructor += ", " + ArgName;
4219  }
4220  S += FieldName + ";\n";
4221  }
4222  // Output all "by ref" declarations.
4223  for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(),
4224  E = BlockByRefDecls.end(); I != E; ++I) {
4225  S += " ";
4226  std::string FieldName = (*I)->getNameAsString();
4227  std::string ArgName = "_" + FieldName;
4228  {
4229  std::string TypeString;
4230  RewriteByRefString(TypeString, FieldName, (*I));
4231  TypeString += " *";
4232  FieldName = TypeString + FieldName;
4233  ArgName = TypeString + ArgName;
4234  Constructor += ", " + ArgName;
4235  }
4236  S += FieldName + "; // by ref\n";
4237  }
4238  // Finish writing the constructor.
4239  Constructor += ", int flags=0)";
4240  // Initialize all "by copy" arguments.
4241  bool firsTime = true;
4242  for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(),
4243  E = BlockByCopyDecls.end(); I != E; ++I) {
4244  std::string Name = (*I)->getNameAsString();
4245  if (firsTime) {
4246  Constructor += " : ";
4247  firsTime = false;
4248  }
4249  else
4250  Constructor += ", ";
4251  if (isTopLevelBlockPointerType((*I)->getType()))
4252  Constructor += Name + "((struct __block_impl *)_" + Name + ")";
4253  else
4254  Constructor += Name + "(_" + Name + ")";
4255  }
4256  // Initialize all "by ref" arguments.
4257  for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(),
4258  E = BlockByRefDecls.end(); I != E; ++I) {
4259  std::string Name = (*I)->getNameAsString();
4260  if (firsTime) {
4261  Constructor += " : ";
4262  firsTime = false;
4263  }
4264  else
4265  Constructor += ", ";
4266  Constructor += Name + "(_" + Name + "->__forwarding)";
4267  }
4268 
4269  Constructor += " {\n";
4270  if (GlobalVarDecl)
4271  Constructor += " impl.isa = &_NSConcreteGlobalBlock;\n";
4272  else
4273  Constructor += " impl.isa = &_NSConcreteStackBlock;\n";
4274  Constructor += " impl.Flags = flags;\n impl.FuncPtr = fp;\n";
4275 
4276  Constructor += " Desc = desc;\n";
4277  } else {
4278  // Finish writing the constructor.
4279  Constructor += ", int flags=0) {\n";
4280  if (GlobalVarDecl)
4281  Constructor += " impl.isa = &_NSConcreteGlobalBlock;\n";
4282  else
4283  Constructor += " impl.isa = &_NSConcreteStackBlock;\n";
4284  Constructor += " impl.Flags = flags;\n impl.FuncPtr = fp;\n";
4285  Constructor += " Desc = desc;\n";
4286  }
4287  Constructor += " ";
4288  Constructor += "}\n";
4289  S += Constructor;
4290  S += "};\n";
4291  return S;
4292 }
4293 
4294 std::string RewriteModernObjC::SynthesizeBlockDescriptor(std::string DescTag,
4295  std::string ImplTag, int i,
4296  StringRef FunName,
4297  unsigned hasCopy) {
4298  std::string S = "\nstatic struct " + DescTag;
4299 
4300  S += " {\n size_t reserved;\n";
4301  S += " size_t Block_size;\n";
4302  if (hasCopy) {
4303  S += " void (*copy)(struct ";
4304  S += ImplTag; S += "*, struct ";
4305  S += ImplTag; S += "*);\n";
4306 
4307  S += " void (*dispose)(struct ";
4308  S += ImplTag; S += "*);\n";
4309  }
4310  S += "} ";
4311 
4312  S += DescTag + "_DATA = { 0, sizeof(struct ";
4313  S += ImplTag + ")";
4314  if (hasCopy) {
4315  S += ", __" + FunName.str() + "_block_copy_" + utostr(i);
4316  S += ", __" + FunName.str() + "_block_dispose_" + utostr(i);
4317  }
4318  S += "};\n";
4319  return S;
4320 }
4321 
4322 void RewriteModernObjC::SynthesizeBlockLiterals(SourceLocation FunLocStart,
4323  StringRef FunName) {
4324  bool RewriteSC = (GlobalVarDecl &&
4325  !Blocks.empty() &&
4326  GlobalVarDecl->getStorageClass() == SC_Static &&
4327  GlobalVarDecl->getType().getCVRQualifiers());
4328  if (RewriteSC) {
4329  std::string SC(" void __");
4330  SC += GlobalVarDecl->getNameAsString();
4331  SC += "() {}";
4332  InsertText(FunLocStart, SC);
4333  }
4334 
4335  // Insert closures that were part of the function.
4336  for (unsigned i = 0, count=0; i < Blocks.size(); i++) {
4337  CollectBlockDeclRefInfo(Blocks[i]);
4338  // Need to copy-in the inner copied-in variables not actually used in this
4339  // block.
4340  for (int j = 0; j < InnerDeclRefsCount[i]; j++) {
4341  DeclRefExpr *Exp = InnerDeclRefs[count++];
4342  ValueDecl *VD = Exp->getDecl();
4343  BlockDeclRefs.push_back(Exp);
4344  if (!VD->hasAttr<BlocksAttr>()) {
4345  if (!BlockByCopyDeclsPtrSet.count(VD)) {
4346  BlockByCopyDeclsPtrSet.insert(VD);
4347  BlockByCopyDecls.push_back(VD);
4348  }
4349  continue;
4350  }
4351 
4352  if (!BlockByRefDeclsPtrSet.count(VD)) {
4353  BlockByRefDeclsPtrSet.insert(VD);
4354  BlockByRefDecls.push_back(VD);
4355  }
4356 
4357  // imported objects in the inner blocks not used in the outer
4358  // blocks must be copied/disposed in the outer block as well.
4359  if (VD->getType()->isObjCObjectPointerType() ||
4360  VD->getType()->isBlockPointerType())
4361  ImportedBlockDecls.insert(VD);
4362  }
4363 
4364  std::string ImplTag = "__" + FunName.str() + "_block_impl_" + utostr(i);
4365  std::string DescTag = "__" + FunName.str() + "_block_desc_" + utostr(i);
4366 
4367  std::string CI = SynthesizeBlockImpl(Blocks[i], ImplTag, DescTag);
4368 
4369  InsertText(FunLocStart, CI);
4370 
4371  std::string CF = SynthesizeBlockFunc(Blocks[i], i, FunName, ImplTag);
4372 
4373  InsertText(FunLocStart, CF);
4374 
4375  if (ImportedBlockDecls.size()) {
4376  std::string HF = SynthesizeBlockHelperFuncs(Blocks[i], i, FunName, ImplTag);
4377  InsertText(FunLocStart, HF);
4378  }
4379  std::string BD = SynthesizeBlockDescriptor(DescTag, ImplTag, i, FunName,
4380  ImportedBlockDecls.size() > 0);
4381  InsertText(FunLocStart, BD);
4382 
4383  BlockDeclRefs.clear();
4384  BlockByRefDecls.clear();
4385  BlockByRefDeclsPtrSet.clear();
4386  BlockByCopyDecls.clear();
4387  BlockByCopyDeclsPtrSet.clear();
4388  ImportedBlockDecls.clear();
4389  }
4390  if (RewriteSC) {
4391  // Must insert any 'const/volatile/static here. Since it has been
4392  // removed as result of rewriting of block literals.
4393  std::string SC;
4394  if (GlobalVarDecl->getStorageClass() == SC_Static)
4395  SC = "static ";
4396  if (GlobalVarDecl->getType().isConstQualified())
4397  SC += "const ";
4398  if (GlobalVarDecl->getType().isVolatileQualified())
4399  SC += "volatile ";
4400  if (GlobalVarDecl->getType().isRestrictQualified())
4401  SC += "restrict ";
4402  InsertText(FunLocStart, SC);
4403  }
4404  if (GlobalConstructionExp) {
4405  // extra fancy dance for global literal expression.
4406 
4407  // Always the latest block expression on the block stack.
4408  std::string Tag = "__";
4409  Tag += FunName;
4410  Tag += "_block_impl_";
4411  Tag += utostr(Blocks.size()-1);
4412  std::string globalBuf = "static ";
4413  globalBuf += Tag; globalBuf += " ";
4414  std::string SStr;
4415 
4416  llvm::raw_string_ostream constructorExprBuf(SStr);
4417  GlobalConstructionExp->printPretty(constructorExprBuf, nullptr,
4418  PrintingPolicy(LangOpts));
4419  globalBuf += constructorExprBuf.str();
4420  globalBuf += ";\n";
4421  InsertText(FunLocStart, globalBuf);
4422  GlobalConstructionExp = nullptr;
4423  }
4424 
4425  Blocks.clear();
4426  InnerDeclRefsCount.clear();
4427  InnerDeclRefs.clear();
4428  RewrittenBlockExprs.clear();
4429 }
4430 
4431 void RewriteModernObjC::InsertBlockLiteralsWithinFunction(FunctionDecl *FD) {
4432  SourceLocation FunLocStart =
4433  (!Blocks.empty()) ? getFunctionSourceLocation(*this, FD)
4434  : FD->getTypeSpecStartLoc();
4435  StringRef FuncName = FD->getName();
4436 
4437  SynthesizeBlockLiterals(FunLocStart, FuncName);
4438 }
4439 
4441  ObjCMethodDecl *MD) {
4442  ObjCInterfaceDecl *IFace = MD->getClassInterface();
4443  Name = std::string(IFace->getName());
4444  Name += "__" + MD->getSelector().getAsString();
4445  // Convert colons to underscores.
4446  std::string::size_type loc = 0;
4447  while ((loc = Name.find(':', loc)) != std::string::npos)
4448  Name.replace(loc, 1, "_");
4449 }
4450 
4451 void RewriteModernObjC::InsertBlockLiteralsWithinMethod(ObjCMethodDecl *MD) {
4452  // fprintf(stderr,"In InsertBlockLiteralsWitinMethod\n");
4453  // SourceLocation FunLocStart = MD->getBeginLoc();
4454  SourceLocation FunLocStart = MD->getBeginLoc();
4455  std::string FuncName;
4456  BuildUniqueMethodName(FuncName, MD);
4457  SynthesizeBlockLiterals(FunLocStart, FuncName);
4458 }
4459 
4460 void RewriteModernObjC::GetBlockDeclRefExprs(Stmt *S) {
4461  for (Stmt *SubStmt : S->children())
4462  if (SubStmt) {
4463  if (BlockExpr *CBE = dyn_cast<BlockExpr>(SubStmt))
4464  GetBlockDeclRefExprs(CBE->getBody());
4465  else
4466  GetBlockDeclRefExprs(SubStmt);
4467  }
4468  // Handle specific things.
4469  if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S))
4472  // FIXME: Handle enums.
4473  BlockDeclRefs.push_back(DRE);
4474 }
4475 
4476 void RewriteModernObjC::GetInnerBlockDeclRefExprs(Stmt *S,
4477  SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs,
4478  llvm::SmallPtrSetImpl<const DeclContext *> &InnerContexts) {
4479  for (Stmt *SubStmt : S->children())
4480  if (SubStmt) {
4481  if (BlockExpr *CBE = dyn_cast<BlockExpr>(SubStmt)) {
4482  InnerContexts.insert(cast<DeclContext>(CBE->getBlockDecl()));
4483  GetInnerBlockDeclRefExprs(CBE->getBody(),
4484  InnerBlockDeclRefs,
4485  InnerContexts);
4486  }
4487  else
4488  GetInnerBlockDeclRefExprs(SubStmt, InnerBlockDeclRefs, InnerContexts);
4489  }
4490  // Handle specific things.
4491  if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) {
4494  if (!InnerContexts.count(DRE->getDecl()->getDeclContext()))
4495  InnerBlockDeclRefs.push_back(DRE);
4496  if (VarDecl *Var = cast<VarDecl>(DRE->getDecl()))
4497  if (Var->isFunctionOrMethodVarDecl())
4498  ImportedLocalExternalDecls.insert(Var);
4499  }
4500  }
4501 }
4502 
4503 /// convertObjCTypeToCStyleType - This routine converts such objc types
4504 /// as qualified objects, and blocks to their closest c/c++ types that
4505 /// it can. It returns true if input type was modified.
4506 bool RewriteModernObjC::convertObjCTypeToCStyleType(QualType &T) {
4507  QualType oldT = T;
4508  convertBlockPointerToFunctionPointer(T);
4509  if (T->isFunctionPointerType()) {
4510  QualType PointeeTy;
4511  if (const PointerType* PT = T->getAs<PointerType>()) {
4512  PointeeTy = PT->getPointeeType();
4513  if (const FunctionType *FT = PointeeTy->getAs<FunctionType>()) {
4514  T = convertFunctionTypeOfBlocks(FT);
4515  T = Context->getPointerType(T);
4516  }
4517  }
4518  }
4519 
4520  convertToUnqualifiedObjCType(T);
4521  return T != oldT;
4522 }
4523 
4524 /// convertFunctionTypeOfBlocks - This routine converts a function type
4525 /// whose result type may be a block pointer or whose argument type(s)
4526 /// might be block pointers to an equivalent function type replacing
4527 /// all block pointers to function pointers.
4528 QualType RewriteModernObjC::convertFunctionTypeOfBlocks(const FunctionType *FT) {
4529  const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(FT);
4530  // FTP will be null for closures that don't take arguments.
4531  // Generate a funky cast.
4532  SmallVector<QualType, 8> ArgTypes;
4533  QualType Res = FT->getReturnType();
4534  bool modified = convertObjCTypeToCStyleType(Res);
4535 
4536  if (FTP) {
4537  for (auto &I : FTP->param_types()) {
4538  QualType t = I;
4539  // Make sure we convert "t (^)(...)" to "t (*)(...)".
4540  if (convertObjCTypeToCStyleType(t))
4541  modified = true;
4542  ArgTypes.push_back(t);
4543  }
4544  }
4545  QualType FuncType;
4546  if (modified)
4547  FuncType = getSimpleFunctionType(Res, ArgTypes);
4548  else FuncType = QualType(FT, 0);
4549  return FuncType;
4550 }
4551 
4552 Stmt *RewriteModernObjC::SynthesizeBlockCall(CallExpr *Exp, const Expr *BlockExp) {
4553  // Navigate to relevant type information.
4554  const BlockPointerType *CPT = nullptr;
4555 
4556  if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(BlockExp)) {
4557  CPT = DRE->getType()->getAs<BlockPointerType>();
4558  } else if (const MemberExpr *MExpr = dyn_cast<MemberExpr>(BlockExp)) {
4559  CPT = MExpr->getType()->getAs<BlockPointerType>();
4560  }
4561  else if (const ParenExpr *PRE = dyn_cast<ParenExpr>(BlockExp)) {
4562  return SynthesizeBlockCall(Exp, PRE->getSubExpr());
4563  }
4564  else if (const ImplicitCastExpr *IEXPR = dyn_cast<ImplicitCastExpr>(BlockExp))
4565  CPT = IEXPR->getType()->getAs<BlockPointerType>();
4566  else if (const ConditionalOperator *CEXPR =
4567  dyn_cast<ConditionalOperator>(BlockExp)) {
4568  Expr *LHSExp = CEXPR->getLHS();
4569  Stmt *LHSStmt = SynthesizeBlockCall(Exp, LHSExp);
4570  Expr *RHSExp = CEXPR->getRHS();
4571  Stmt *RHSStmt = SynthesizeBlockCall(Exp, RHSExp);
4572  Expr *CONDExp = CEXPR->getCond();
4573  ConditionalOperator *CondExpr = new (Context) ConditionalOperator(
4574  CONDExp, SourceLocation(), cast<Expr>(LHSStmt), SourceLocation(),
4575  cast<Expr>(RHSStmt), Exp->getType(), VK_PRValue, OK_Ordinary);
4576  return CondExpr;
4577  } else if (const ObjCIvarRefExpr *IRE = dyn_cast<ObjCIvarRefExpr>(BlockExp)) {
4578  CPT = IRE->getType()->getAs<BlockPointerType>();
4579  } else if (const PseudoObjectExpr *POE
4580  = dyn_cast<PseudoObjectExpr>(BlockExp)) {
4581  CPT = POE->getType()->castAs<BlockPointerType>();
4582  } else {
4583  assert(false && "RewriteBlockClass: Bad type");
4584  }
4585  assert(CPT && "RewriteBlockClass: Bad type");
4586  const FunctionType *FT = CPT->getPointeeType()->getAs<FunctionType>();
4587  assert(FT && "RewriteBlockClass: Bad type");
4588  const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(FT);
4589  // FTP will be null for closures that don't take arguments.
4590 
4591  RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
4593  &Context->Idents.get("__block_impl"));
4594  QualType PtrBlock = Context->getPointerType(Context->getTagDeclType(RD));
4595 
4596  // Generate a funky cast.
4597  SmallVector<QualType, 8> ArgTypes;
4598 
4599  // Push the block argument type.
4600  ArgTypes.push_back(PtrBlock);
4601  if (FTP) {
4602  for (auto &I : FTP->param_types()) {
4603  QualType t = I;
4604  // Make sure we convert "t (^)(...)" to "t (*)(...)".
4605  if (!convertBlockPointerToFunctionPointer(t))
4606  convertToUnqualifiedObjCType(t);
4607  ArgTypes.push_back(t);
4608  }
4609  }
4610  // Now do the pointer to function cast.
4611  QualType PtrToFuncCastType = getSimpleFunctionType(Exp->getType(), ArgTypes);
4612 
4613  PtrToFuncCastType = Context->getPointerType(PtrToFuncCastType);
4614 
4615  CastExpr *BlkCast = NoTypeInfoCStyleCastExpr(Context, PtrBlock,
4616  CK_BitCast,
4617  const_cast<Expr*>(BlockExp));
4618  // Don't forget the parens to enforce the proper binding.
4619  ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(),
4620  BlkCast);
4621  //PE->dump();
4622 
4623  FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(),
4624  SourceLocation(),
4625  &Context->Idents.get("FuncPtr"),
4626  Context->VoidPtrTy, nullptr,
4627  /*BitWidth=*/nullptr, /*Mutable=*/true,
4628  ICIS_NoInit);
4629  MemberExpr *ME = MemberExpr::CreateImplicit(
4630  *Context, PE, true, FD, FD->getType(), VK_LValue, OK_Ordinary);
4631 
4632  CastExpr *FunkCast = NoTypeInfoCStyleCastExpr(Context, PtrToFuncCastType,
4633  CK_BitCast, ME);
4634  PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), FunkCast);
4635 
4636  SmallVector<Expr*, 8> BlkExprs;
4637  // Add the implicit argument.
4638  BlkExprs.push_back(BlkCast);
4639  // Add the user arguments.
4640  for (CallExpr::arg_iterator I = Exp->arg_begin(),
4641  E = Exp->arg_end(); I != E; ++I) {
4642  BlkExprs.push_back(*I);
4643  }
4644  CallExpr *CE =
4645  CallExpr::Create(*Context, PE, BlkExprs, Exp->getType(), VK_PRValue,
4647  return CE;
4648 }
4649 
4650 // We need to return the rewritten expression to handle cases where the
4651 // DeclRefExpr is embedded in another expression being rewritten.
4652 // For example:
4653 //
4654 // int main() {
4655 // __block Foo *f;
4656 // __block int i;
4657 //
4658 // void (^myblock)() = ^() {
4659 // [f test]; // f is a DeclRefExpr embedded in a message (which is being rewritten).
4660 // i = 77;
4661 // };
4662 //}
4663 Stmt *RewriteModernObjC::RewriteBlockDeclRefExpr(DeclRefExpr *DeclRefExp) {
4664  // Rewrite the byref variable into BYREFVAR->__forwarding->BYREFVAR
4665  // for each DeclRefExp where BYREFVAR is name of the variable.
4666  ValueDecl *VD = DeclRefExp->getDecl();
4667  bool isArrow = DeclRefExp->refersToEnclosingVariableOrCapture() ||
4669 
4670  FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(),
4671  SourceLocation(),
4672  &Context->Idents.get("__forwarding"),
4673  Context->VoidPtrTy, nullptr,
4674  /*BitWidth=*/nullptr, /*Mutable=*/true,
4675  ICIS_NoInit);
4676  MemberExpr *ME = MemberExpr::CreateImplicit(
4677  *Context, DeclRefExp, isArrow, FD, FD->getType(), VK_LValue, OK_Ordinary);
4678 
4679  StringRef Name = VD->getName();
4680  FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), SourceLocation(),
4681  &Context->Idents.get(Name),
4682  Context->VoidPtrTy, nullptr,
4683  /*BitWidth=*/nullptr, /*Mutable=*/true,
4684  ICIS_NoInit);
4685  ME = MemberExpr::CreateImplicit(*Context, ME, true, FD, DeclRefExp->getType(),
4687 
4688  // Need parens to enforce precedence.
4689  ParenExpr *PE = new (Context) ParenExpr(DeclRefExp->getExprLoc(),
4690  DeclRefExp->getExprLoc(),
4691  ME);
4692  ReplaceStmt(DeclRefExp, PE);
4693  return PE;
4694 }
4695 
4696 // Rewrites the imported local variable V with external storage
4697 // (static, extern, etc.) as *V
4698 //
4699 Stmt *RewriteModernObjC::RewriteLocalVariableExternalStorage(DeclRefExpr *DRE) {
4700  ValueDecl *VD = DRE->getDecl();
4701  if (VarDecl *Var = dyn_cast<VarDecl>(VD))
4702  if (!ImportedLocalExternalDecls.count(Var))
4703  return DRE;
4704  Expr *Exp = UnaryOperator::Create(
4705  const_cast<ASTContext &>(*Context), DRE, UO_Deref, DRE->getType(),
4706  VK_LValue, OK_Ordinary, DRE->getLocation(), false, FPOptionsOverride());
4707  // Need parens to enforce precedence.
4708  ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(),
4709  Exp);
4710  ReplaceStmt(DRE, PE);
4711  return PE;
4712 }
4713 
4714 void RewriteModernObjC::RewriteCastExpr(CStyleCastExpr *CE) {
4715  SourceLocation LocStart = CE->getLParenLoc();
4716  SourceLocation LocEnd = CE->getRParenLoc();
4717 
4718  // Need to avoid trying to rewrite synthesized casts.
4719  if (LocStart.isInvalid())
4720  return;
4721  // Need to avoid trying to rewrite casts contained in macros.
4722  if (!Rewriter::isRewritable(LocStart) || !Rewriter::isRewritable(LocEnd))
4723  return;
4724 
4725  const char *startBuf = SM->getCharacterData(LocStart);
4726  const char *endBuf = SM->getCharacterData(LocEnd);
4727  QualType QT = CE->getType();
4728  const Type* TypePtr = QT->getAs<Type>();
4729  if (isa<TypeOfExprType>(TypePtr)) {
4730  const TypeOfExprType *TypeOfExprTypePtr = cast<TypeOfExprType>(TypePtr);
4731  QT = TypeOfExprTypePtr->getUnderlyingExpr()->getType();
4732  std::string TypeAsString = "(";
4733  RewriteBlockPointerType(TypeAsString, QT);
4734  TypeAsString += ")";
4735  ReplaceText(LocStart, endBuf-startBuf+1, TypeAsString);
4736  return;
4737  }
4738  // advance the location to startArgList.
4739  const char *argPtr = startBuf;
4740 
4741  while (*argPtr++ && (argPtr < endBuf)) {
4742  switch (*argPtr) {
4743  case '^':
4744  // Replace the '^' with '*'.
4745  LocStart = LocStart.getLocWithOffset(argPtr-startBuf);
4746  ReplaceText(LocStart, 1, "*");
4747  break;
4748  }
4749  }
4750 }
4751 
4752 void RewriteModernObjC::RewriteImplicitCastObjCExpr(CastExpr *IC) {
4753  CastKind CastKind = IC->getCastKind();
4754  if (CastKind != CK_BlockPointerToObjCPointerCast &&
4755  CastKind != CK_AnyPointerToBlockPointerCast)
4756  return;
4757 
4758  QualType QT = IC->getType();
4759  (void)convertBlockPointerToFunctionPointer(QT);
4760  std::string TypeString(QT.getAsString(Context->getPrintingPolicy()));
4761  std::string Str = "(";
4762  Str += TypeString;
4763  Str += ")";
4764  InsertText(IC->getSubExpr()->getBeginLoc(), Str);
4765 }
4766 
4767 void RewriteModernObjC::RewriteBlockPointerFunctionArgs(FunctionDecl *FD) {
4768  SourceLocation DeclLoc = FD->getLocation();
4769  unsigned parenCount = 0;
4770 
4771  // We have 1 or more arguments that have closure pointers.
4772  const char *startBuf = SM->getCharacterData(DeclLoc);
4773  const char *startArgList = strchr(startBuf, '(');
4774 
4775  assert((*startArgList == '(') && "Rewriter fuzzy parser confused");
4776 
4777  parenCount++;
4778  // advance the location to startArgList.
4779  DeclLoc = DeclLoc.getLocWithOffset(startArgList-startBuf);
4780  assert((DeclLoc.isValid()) && "Invalid DeclLoc");
4781 
4782  const char *argPtr = startArgList;
4783 
4784  while (*argPtr++ && parenCount) {
4785  switch (*argPtr) {
4786  case '^':
4787  // Replace the '^' with '*'.
4788  DeclLoc = DeclLoc.getLocWithOffset(argPtr-startArgList);
4789  ReplaceText(DeclLoc, 1, "*");
4790  break;
4791  case '(':
4792  parenCount++;
4793  break;
4794  case ')':
4795  parenCount--;
4796  break;
4797  }
4798  }
4799 }
4800 
4801 bool RewriteModernObjC::PointerTypeTakesAnyBlockArguments(QualType QT) {
4802  const FunctionProtoType *FTP;
4803  const PointerType *PT = QT->getAs<PointerType>();
4804  if (PT) {
4805  FTP = PT->getPointeeType()->getAs<FunctionProtoType>();
4806  } else {
4807  const BlockPointerType *BPT = QT->getAs<BlockPointerType>();
4808  assert(BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type");
4809  FTP = BPT->getPointeeType()->getAs<FunctionProtoType>();
4810  }
4811  if (FTP) {
4812  for (const auto &I : FTP->param_types())
4813  if (isTopLevelBlockPointerType(I))
4814  return true;
4815  }
4816  return false;
4817 }
4818 
4819 bool RewriteModernObjC::PointerTypeTakesAnyObjCQualifiedType(QualType QT) {
4820  const FunctionProtoType *FTP;
4821  const PointerType *PT = QT->getAs<PointerType>();
4822  if (PT) {
4823  FTP = PT->getPointeeType()->getAs<FunctionProtoType>();
4824  } else {
4825  const BlockPointerType *BPT = QT->getAs<BlockPointerType>();
4826  assert(BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type");
4827  FTP = BPT->getPointeeType()->getAs<FunctionProtoType>();
4828  }
4829  if (FTP) {
4830  for (const auto &I : FTP->param_types()) {
4831  if (I->isObjCQualifiedIdType())
4832  return true;
4833  if (I->isObjCObjectPointerType() &&
4834  I->getPointeeType()->isObjCQualifiedInterfaceType())
4835  return true;
4836  }
4837 
4838  }
4839  return false;
4840 }
4841 
4842 void RewriteModernObjC::GetExtentOfArgList(const char *Name, const char *&LParen,
4843  const char *&RParen) {
4844  const char *argPtr = strchr(Name, '(');
4845  assert((*argPtr == '(') && "Rewriter fuzzy parser confused");
4846 
4847  LParen = argPtr; // output the start.
4848  argPtr++; // skip past the left paren.
4849  unsigned parenCount = 1;
4850 
4851  while (*argPtr && parenCount) {
4852  switch (*argPtr) {
4853  case '(': parenCount++; break;
4854  case ')': parenCount--; break;
4855  default: break;
4856  }
4857  if (parenCount) argPtr++;
4858  }
4859  assert((*argPtr == ')') && "Rewriter fuzzy parser confused");
4860  RParen = argPtr; // output the end
4861 }
4862 
4863 void RewriteModernObjC::RewriteBlockPointerDecl(NamedDecl *ND) {
4864  if (FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) {
4865  RewriteBlockPointerFunctionArgs(FD);
4866  return;
4867  }
4868  // Handle Variables and Typedefs.
4869  SourceLocation DeclLoc = ND->getLocation();
4870  QualType DeclT;
4871  if (VarDecl *VD = dyn_cast<VarDecl>(ND))
4872  DeclT = VD->getType();
4873  else if (TypedefNameDecl *TDD = dyn_cast<TypedefNameDecl>(ND))
4874  DeclT = TDD->getUnderlyingType();
4875  else if (FieldDecl *FD = dyn_cast<FieldDecl>(ND))
4876  DeclT = FD->getType();
4877  else
4878  llvm_unreachable("RewriteBlockPointerDecl(): Decl type not yet handled");
4879 
4880  const char *startBuf = SM->getCharacterData(DeclLoc);
4881  const char *endBuf = startBuf;
4882  // scan backward (from the decl location) for the end of the previous decl.
4883  while (*startBuf != '^' && *startBuf != ';' && startBuf != MainFileStart)
4884  startBuf--;
4885  SourceLocation Start = DeclLoc.getLocWithOffset(startBuf-endBuf);
4886  std::string buf;
4887  unsigned OrigLength=0;
4888  // *startBuf != '^' if we are dealing with a pointer to function that
4889  // may take block argument types (which will be handled below).
4890  if (*startBuf == '^') {
4891  // Replace the '^' with '*', computing a negative offset.
4892  buf = '*';
4893  startBuf++;
4894  OrigLength++;
4895  }
4896  while (*startBuf != ')') {
4897  buf += *startBuf;
4898  startBuf++;
4899  OrigLength++;
4900  }
4901  buf += ')';
4902  OrigLength++;
4903 
4904  if (PointerTypeTakesAnyBlockArguments(DeclT) ||
4905  PointerTypeTakesAnyObjCQualifiedType(DeclT)) {
4906  // Replace the '^' with '*' for arguments.
4907  // Replace id<P> with id/*<>*/
4908  DeclLoc = ND->getLocation();
4909  startBuf = SM->getCharacterData(DeclLoc);
4910  const char *argListBegin, *argListEnd;
4911  GetExtentOfArgList(startBuf, argListBegin, argListEnd);
4912  while (argListBegin < argListEnd) {
4913  if (*argListBegin == '^')
4914  buf += '*';
4915  else if (*argListBegin == '<') {
4916  buf += "/*";
4917  buf += *argListBegin++;
4918  OrigLength++;
4919  while (*argListBegin != '>') {
4920  buf += *argListBegin++;
4921  OrigLength++;
4922  }
4923  buf += *argListBegin;
4924  buf += "*/";
4925  }
4926  else
4927  buf += *argListBegin;
4928  argListBegin++;
4929  OrigLength++;
4930  }
4931  buf += ')';
4932  OrigLength++;
4933  }
4934  ReplaceText(Start, OrigLength, buf);
4935 }
4936 
4937 /// SynthesizeByrefCopyDestroyHelper - This routine synthesizes:
4938 /// void __Block_byref_id_object_copy(struct Block_byref_id_object *dst,
4939 /// struct Block_byref_id_object *src) {
4940 /// _Block_object_assign (&_dest->object, _src->object,
4941 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_OBJECT
4942 /// [|BLOCK_FIELD_IS_WEAK]) // object
4943 /// _Block_object_assign(&_dest->object, _src->object,
4944 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_BLOCK
4945 /// [|BLOCK_FIELD_IS_WEAK]) // block
4946 /// }
4947 /// And:
4948 /// void __Block_byref_id_object_dispose(struct Block_byref_id_object *_src) {
4949 /// _Block_object_dispose(_src->object,
4950 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_OBJECT
4951 /// [|BLOCK_FIELD_IS_WEAK]) // object
4952 /// _Block_object_dispose(_src->object,
4953 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_BLOCK
4954 /// [|BLOCK_FIELD_IS_WEAK]) // block
4955 /// }
4956 
4957 std::string RewriteModernObjC::SynthesizeByrefCopyDestroyHelper(VarDecl *VD,
4958  int flag) {
4959  std::string S;
4960  if (CopyDestroyCache.count(flag))
4961  return S;
4962  CopyDestroyCache.insert(flag);
4963  S = "static void __Block_byref_id_object_copy_";
4964  S += utostr(flag);
4965  S += "(void *dst, void *src) {\n";
4966 
4967  // offset into the object pointer is computed as:
4968  // void * + void* + int + int + void* + void *
4969  unsigned IntSize =
4970  static_cast<unsigned>(Context->getTypeSize(Context->IntTy));
4971  unsigned VoidPtrSize =
4972  static_cast<unsigned>(Context->getTypeSize(Context->VoidPtrTy));
4973 
4974  unsigned offset = (VoidPtrSize*4 + IntSize + IntSize)/Context->getCharWidth();
4975  S += " _Block_object_assign((char*)dst + ";
4976  S += utostr(offset);
4977  S += ", *(void * *) ((char*)src + ";
4978  S += utostr(offset);
4979  S += "), ";
4980  S += utostr(flag);
4981  S += ");\n}\n";
4982 
4983  S += "static void __Block_byref_id_object_dispose_";
4984  S += utostr(flag);
4985  S += "(void *src) {\n";
4986  S += " _Block_object_dispose(*(void * *) ((char*)src + ";
4987  S += utostr(offset);
4988  S += "), ";
4989  S += utostr(flag);
4990  S += ");\n}\n";
4991  return S;
4992 }
4993 
4994 /// RewriteByRefVar - For each __block typex ND variable this routine transforms
4995 /// the declaration into:
4996 /// struct __Block_byref_ND {
4997 /// void *__isa; // NULL for everything except __weak pointers
4998 /// struct __Block_byref_ND *__forwarding;
4999 /// int32_t __flags;
5000 /// int32_t __size;
5001 /// void *__Block_byref_id_object_copy; // If variable is __block ObjC object
5002 /// void *__Block_byref_id_object_dispose; // If variable is __block ObjC object
5003 /// typex ND;
5004 /// };
5005 ///
5006 /// It then replaces declaration of ND variable with:
5007 /// struct __Block_byref_ND ND = {__isa=0B, __forwarding=&ND, __flags=some_flag,
5008 /// __size=sizeof(struct __Block_byref_ND),
5009 /// ND=initializer-if-any};
5010 ///
5011 ///
5012 void RewriteModernObjC::RewriteByRefVar(VarDecl *ND, bool firstDecl,
5013  bool lastDecl) {
5014  int flag = 0;
5015  int isa = 0;
5016  SourceLocation DeclLoc = ND->getTypeSpecStartLoc();
5017  if (DeclLoc.isInvalid())
5018  // If type location is missing, it is because of missing type (a warning).
5019  // Use variable's location which is good for this case.
5020  DeclLoc = ND->getLocation();
5021  const char *startBuf = SM->getCharacterData(DeclLoc);
5022  SourceLocation X = ND->getEndLoc();
5023  X = SM->getExpansionLoc(X);
5024  const char *endBuf = SM->getCharacterData(X);
5025  std::string Name(ND->getNameAsString());
5026  std::string ByrefType;
5027  RewriteByRefString(ByrefType, Name, ND, true);
5028  ByrefType += " {\n";
5029  ByrefType += " void *__isa;\n";
5030  RewriteByRefString(ByrefType, Name, ND);
5031  ByrefType += " *__forwarding;\n";
5032  ByrefType += " int __flags;\n";
5033  ByrefType += " int __size;\n";
5034  // Add void *__Block_byref_id_object_copy;
5035  // void *__Block_byref_id_object_dispose; if needed.
5036  QualType Ty = ND->getType();
5037  bool HasCopyAndDispose = Context->BlockRequiresCopying(Ty, ND);
5038  if (HasCopyAndDispose) {
5039  ByrefType += " void (*__Block_byref_id_object_copy)(void*, void*);\n";
5040  ByrefType += " void (*__Block_byref_id_object_dispose)(void*);\n";
5041  }
5042 
5043  QualType T = Ty;
5044  (void)convertBlockPointerToFunctionPointer(T);
5045  T.getAsStringInternal(Name, Context->getPrintingPolicy());
5046 
5047  ByrefType += " " + Name + ";\n";
5048  ByrefType += "};\n";
5049  // Insert this type in global scope. It is needed by helper function.
5050  SourceLocation FunLocStart;
5051  if (CurFunctionDef)
5052  FunLocStart = getFunctionSourceLocation(*this, CurFunctionDef);
5053  else {
5054  assert(CurMethodDef && "RewriteByRefVar - CurMethodDef is null");
5055  FunLocStart = CurMethodDef->getBeginLoc();
5056  }
5057  InsertText(FunLocStart, ByrefType);
5058 
5059  if (Ty.isObjCGCWeak()) {
5060  flag |= BLOCK_FIELD_IS_WEAK;
5061  isa = 1;
5062  }
5063  if (HasCopyAndDispose) {
5064  flag = BLOCK_BYREF_CALLER;
5065  QualType Ty = ND->getType();
5066  // FIXME. Handle __weak variable (BLOCK_FIELD_IS_WEAK) as well.
5067  if (Ty->isBlockPointerType())
5068  flag |= BLOCK_FIELD_IS_BLOCK;
5069  else
5070  flag |= BLOCK_FIELD_IS_OBJECT;
5071  std::string HF = SynthesizeByrefCopyDestroyHelper(ND, flag);
5072  if (!HF.empty())
5073  Preamble += HF;
5074  }
5075 
5076  // struct __Block_byref_ND ND =
5077  // {0, &ND, some_flag, __size=sizeof(struct __Block_byref_ND),
5078  // initializer-if-any};
5079  bool hasInit = (ND->getInit() != nullptr);
5080  // FIXME. rewriter does not support __block c++ objects which
5081  // require construction.
5082  if (hasInit)
5083  if (CXXConstructExpr *CExp = dyn_cast<CXXConstructExpr>(ND->getInit())) {
5084  CXXConstructorDecl *CXXDecl = CExp->getConstructor();
5085  if (CXXDecl && CXXDecl->isDefaultConstructor())
5086  hasInit = false;
5087  }
5088 
5089  unsigned flags = 0;
5090  if (HasCopyAndDispose)
5091  flags |= BLOCK_HAS_COPY_DISPOSE;
5092  Name = ND->getNameAsString();
5093  ByrefType.clear();
5094  RewriteByRefString(ByrefType, Name, ND);
5095  std::string ForwardingCastType("(");
5096  ForwardingCastType += ByrefType + " *)";
5097  ByrefType += " " + Name + " = {(void*)";
5098  ByrefType += utostr(isa);
5099  ByrefType += "," + ForwardingCastType + "&" + Name + ", ";
5100  ByrefType += utostr(flags);
5101  ByrefType += ", ";
5102  ByrefType += "sizeof(";
5103  RewriteByRefString(ByrefType, Name, ND);
5104  ByrefType += ")";
5105  if (HasCopyAndDispose) {
5106  ByrefType += ", __Block_byref_id_object_copy_";
5107  ByrefType += utostr(flag);
5108  ByrefType += ", __Block_byref_id_object_dispose_";
5109  ByrefType += utostr(flag);
5110  }
5111 
5112  if (!firstDecl) {
5113  // In multiple __block declarations, and for all but 1st declaration,
5114  // find location of the separating comma. This would be start location
5115  // where new text is to be inserted.
5116  DeclLoc = ND->getLocation();
5117  const char *startDeclBuf = SM->getCharacterData(DeclLoc);
5118  const char *commaBuf = startDeclBuf;
5119  while (*commaBuf != ',')
5120  commaBuf--;
5121  assert((*commaBuf == ',') && "RewriteByRefVar: can't find ','");
5122  DeclLoc = DeclLoc.getLocWithOffset(commaBuf - startDeclBuf);
5123  startBuf = commaBuf;
5124  }
5125 
5126  if (!hasInit) {
5127  ByrefType += "};\n";
5128  unsigned nameSize = Name.size();
5129  // for block or function pointer declaration. Name is already
5130  // part of the declaration.
5131  if (Ty->isBlockPointerType() || Ty->isFunctionPointerType())
5132  nameSize = 1;
5133  ReplaceText(DeclLoc, endBuf-startBuf+nameSize, ByrefType);
5134  }
5135  else {
5136  ByrefType += ", ";
5137  SourceLocation startLoc;
5138  Expr *E = ND->getInit();
5139  if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E))
5140  startLoc = ECE->getLParenLoc();
5141  else
5142  startLoc = E->getBeginLoc();
5143  startLoc = SM->getExpansionLoc(startLoc);
5144  endBuf = SM->getCharacterData(startLoc);
5145  ReplaceText(DeclLoc, endBuf-startBuf, ByrefType);
5146 
5147  const char separator = lastDecl ? ';' : ',';
5148  const char *startInitializerBuf = SM->getCharacterData(startLoc);
5149  const char *separatorBuf = strchr(startInitializerBuf, separator);
5150  assert((*separatorBuf == separator) &&
5151  "RewriteByRefVar: can't find ';' or ','");
5152  SourceLocation separatorLoc =
5153  startLoc.getLocWithOffset(separatorBuf-startInitializerBuf);
5154 
5155  InsertText(separatorLoc, lastDecl ? "}" : "};\n");
5156  }
5157 }
5158 
5159 void RewriteModernObjC::CollectBlockDeclRefInfo(BlockExpr *Exp) {
5160  // Add initializers for any closure decl refs.
5161  GetBlockDeclRefExprs(Exp->getBody());
5162  if (BlockDeclRefs.size()) {
5163  // Unique all "by copy" declarations.
5164  for (unsigned i = 0; i < BlockDeclRefs.size(); i++)
5165  if (!BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>()) {
5166  if (!BlockByCopyDeclsPtrSet.count(BlockDeclRefs[i]->getDecl())) {
5167  BlockByCopyDeclsPtrSet.insert(BlockDeclRefs[i]->getDecl());
5168  BlockByCopyDecls.push_back(BlockDeclRefs[i]->getDecl());
5169  }
5170  }
5171  // Unique all "by ref" declarations.
5172  for (unsigned i = 0; i < BlockDeclRefs.size(); i++)
5173  if (BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>()) {
5174  if (!BlockByRefDeclsPtrSet.count(BlockDeclRefs[i]->getDecl())) {
5175  BlockByRefDeclsPtrSet.insert(BlockDeclRefs[i]->getDecl());
5176  BlockByRefDecls.push_back(BlockDeclRefs[i]->getDecl());
5177  }
5178  }
5179  // Find any imported blocks...they will need special attention.
5180  for (unsigned i = 0; i < BlockDeclRefs.size(); i++)
5181  if (BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>() ||
5182  BlockDeclRefs[i]->getType()->isObjCObjectPointerType() ||
5183  BlockDeclRefs[i]->getType()->isBlockPointerType())
5184  ImportedBlockDecls.insert(BlockDeclRefs[i]->getDecl());
5185  }
5186 }
5187 
5188 FunctionDecl *RewriteModernObjC::SynthBlockInitFunctionDecl(StringRef name) {
5189  IdentifierInfo *ID = &Context->Idents.get(name);
5190  QualType FType = Context->getFunctionNoProtoType(Context->VoidPtrTy);
5191  return FunctionDecl::Create(*Context, TUDecl, SourceLocation(),
5192  SourceLocation(), ID, FType, nullptr, SC_Extern,
5193  false, false);
5194 }
5195 
5196 Stmt *RewriteModernObjC::SynthBlockInitExpr(BlockExpr *Exp,
5197  const SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs) {
5198  const BlockDecl *block = Exp->getBlockDecl();
5199 
5200  Blocks.push_back(Exp);
5201 
5202  CollectBlockDeclRefInfo(Exp);
5203 
5204  // Add inner imported variables now used in current block.
5205  int countOfInnerDecls = 0;
5206  if (!InnerBlockDeclRefs.empty()) {
5207  for (unsigned i = 0; i < InnerBlockDeclRefs.size(); i++) {
5208  DeclRefExpr *Exp = InnerBlockDeclRefs[i];
5209  ValueDecl *VD = Exp->getDecl();
5210  if (!VD->hasAttr<BlocksAttr>() && !BlockByCopyDeclsPtrSet.count(VD)) {
5211  // We need to save the copied-in variables in nested
5212  // blocks because it is needed at the end for some of the API generations.
5213  // See SynthesizeBlockLiterals routine.
5214  InnerDeclRefs.push_back(Exp); countOfInnerDecls++;
5215  BlockDeclRefs.push_back(Exp);
5216  BlockByCopyDeclsPtrSet.insert(VD);
5217  BlockByCopyDecls.push_back(VD);
5218  }
5219  if (VD->hasAttr<BlocksAttr>() && !BlockByRefDeclsPtrSet.count(VD)) {
5220  InnerDeclRefs.push_back(Exp); countOfInnerDecls++;
5221  BlockDeclRefs.push_back(Exp);
5222  BlockByRefDeclsPtrSet.insert(VD);
5223  BlockByRefDecls.push_back(VD);
5224  }
5225  }
5226  // Find any imported blocks...they will need special attention.
5227  for (unsigned i = 0; i < InnerBlockDeclRefs.size(); i++)
5228  if (InnerBlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>() ||
5229  InnerBlockDeclRefs[i]->getType()->isObjCObjectPointerType() ||
5230  InnerBlockDeclRefs[i]->getType()->isBlockPointerType())
5231  ImportedBlockDecls.insert(InnerBlockDeclRefs[i]->getDecl());
5232  }
5233  InnerDeclRefsCount.push_back(countOfInnerDecls);
5234 
5235  std::string FuncName;
5236 
5237  if (CurFunctionDef)
5238  FuncName = CurFunctionDef->getNameAsString();
5239  else if (CurMethodDef)
5240  BuildUniqueMethodName(FuncName, CurMethodDef);
5241  else if (GlobalVarDecl)
5242  FuncName = std::string(GlobalVarDecl->getNameAsString());
5243 
5244  bool GlobalBlockExpr =
5246 
5247  if (GlobalBlockExpr && !GlobalVarDecl) {
5248  Diags.Report(block->getLocation(), GlobalBlockRewriteFailedDiag);
5249  GlobalBlockExpr = false;
5250  }
5251 
5252  std::string BlockNumber = utostr(Blocks.size()-1);
5253 
5254  std::string Func = "__" + FuncName + "_block_func_" + BlockNumber;
5255 
5256  // Get a pointer to the function type so we can cast appropriately.
5257  QualType BFT = convertFunctionTypeOfBlocks(Exp->getFunctionType());
5258  QualType FType = Context->getPointerType(BFT);
5259 
5260  FunctionDecl *FD;
5261  Expr *NewRep;
5262 
5263  // Simulate a constructor call...
5264  std::string Tag;
5265 
5266  if (GlobalBlockExpr)
5267  Tag = "__global_";
5268  else
5269  Tag = "__";
5270  Tag += FuncName + "_block_impl_" + BlockNumber;
5271 
5272  FD = SynthBlockInitFunctionDecl(Tag);
5273  DeclRefExpr *DRE = new (Context)
5274  DeclRefExpr(*Context, FD, false, FType, VK_PRValue, SourceLocation());
5275 
5276  SmallVector<Expr*, 4> InitExprs;
5277 
5278  // Initialize the block function.
5279  FD = SynthBlockInitFunctionDecl(Func);
5280  DeclRefExpr *Arg = new (Context) DeclRefExpr(
5281  *Context, FD, false, FD->getType(), VK_LValue, SourceLocation());
5282  CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, Context->VoidPtrTy,
5283  CK_BitCast, Arg);
5284  InitExprs.push_back(castExpr);
5285 
5286  // Initialize the block descriptor.
5287  std::string DescData = "__" + FuncName + "_block_desc_" + BlockNumber + "_DATA";
5288 
5289  VarDecl *NewVD = VarDecl::Create(
5290  *Context, TUDecl, SourceLocation(), SourceLocation(),
5291  &Context->Idents.get(DescData), Context->VoidPtrTy, nullptr, SC_Static);
5292  UnaryOperator *DescRefExpr = UnaryOperator::Create(
5293  const_cast<ASTContext &>(*Context),
5294  new (Context) DeclRefExpr(*Context, NewVD, false, Context->VoidPtrTy,
5296  UO_AddrOf, Context->getPointerType(Context->VoidPtrTy), VK_PRValue,
5298  InitExprs.push_back(DescRefExpr);
5299 
5300  // Add initializers for any closure decl refs.
5301  if (BlockDeclRefs.size()) {
5302  Expr *Exp;
5303  // Output all "by copy" declarations.
5304  for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(),
5305  E = BlockByCopyDecls.end(); I != E; ++I) {
5306  if (isObjCType((*I)->getType())) {
5307  // FIXME: Conform to ABI ([[obj retain] autorelease]).
5308  FD = SynthBlockInitFunctionDecl((*I)->getName());
5309  Exp = new (Context) DeclRefExpr(*Context, FD, false, FD->getType(),
5312  QualType QT = (*I)->getType();
5313  QT = Context->getPointerType(QT);
5314  Exp = UnaryOperator::Create(const_cast<ASTContext &>(*Context), Exp,
5315  UO_AddrOf, QT, VK_PRValue, OK_Ordinary,
5316  SourceLocation(), false,
5317  FPOptionsOverride());
5318  }
5319  } else if (isTopLevelBlockPointerType((*I)->getType())) {
5320  FD = SynthBlockInitFunctionDecl((*I)->getName());
5321  Arg = new (Context) DeclRefExpr(*Context, FD, false, FD->getType(),
5323  Exp = NoTypeInfoCStyleCastExpr(Context, Context->VoidPtrTy,
5324  CK_BitCast, Arg);
5325  } else {
5326  FD = SynthBlockInitFunctionDecl((*I)->getName());
5327  Exp = new (Context) DeclRefExpr(*Context, FD, false, FD->getType(),
5330  QualType QT = (*I)->getType();
5331  QT = Context->getPointerType(QT);
5332  Exp = UnaryOperator::Create(const_cast<ASTContext &>(*Context), Exp,
5333  UO_AddrOf, QT, VK_PRValue, OK_Ordinary,
5334  SourceLocation(), false,
5335  FPOptionsOverride());
5336  }
5337 
5338  }
5339  InitExprs.push_back(Exp);
5340  }
5341  // Output all "by ref" declarations.
5342  for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(),
5343  E = BlockByRefDecls.end(); I != E; ++I) {
5344  ValueDecl *ND = (*I);
5345  std::string Name(ND->getNameAsString());
5346  std::string RecName;
5347  RewriteByRefString(RecName, Name, ND, true);
5348  IdentifierInfo *II = &Context->Idents.get(RecName.c_str()
5349  + sizeof("struct"));
5350  RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl,
5352  II);
5353  assert(RD && "SynthBlockInitExpr(): Can't find RecordDecl");
5354  QualType castT = Context->getPointerType(Context->getTagDeclType(RD));
5355 
5356  FD = SynthBlockInitFunctionDecl((*I)->getName());
5357  Exp = new (Context) DeclRefExpr(*Context, FD, false, FD->getType(),
5359  bool isNestedCapturedVar = false;
5360  for (const auto &CI : block->captures()) {
5361  const VarDecl *variable = CI.getVariable();
5362  if (variable == ND && CI.isNested()) {
5363  assert(CI.isByRef() &&
5364  "SynthBlockInitExpr - captured block variable is not byref");
5365  isNestedCapturedVar = true;
5366  break;
5367  }
5368  }
5369  // captured nested byref variable has its address passed. Do not take
5370  // its address again.
5371  if (!isNestedCapturedVar)
5372  Exp = UnaryOperator::Create(
5373  const_cast<ASTContext &>(*Context), Exp, UO_AddrOf,
5374  Context->getPointerType(Exp->getType()), VK_PRValue, OK_Ordinary,
5375  SourceLocation(), false, FPOptionsOverride());
5376  Exp = NoTypeInfoCStyleCastExpr(Context, castT, CK_BitCast, Exp);
5377  InitExprs.push_back(Exp);
5378  }
5379  }
5380  if (ImportedBlockDecls.size()) {
5381  // generate BLOCK_HAS_COPY_DISPOSE(have helper funcs) | BLOCK_HAS_DESCRIPTOR
5382  int flag = (BLOCK_HAS_COPY_DISPOSE | BLOCK_HAS_DESCRIPTOR);
5383  unsigned IntSize =
5384  static_cast<unsigned>(Context->getTypeSize(Context->IntTy));
5385  Expr *FlagExp = IntegerLiteral::Create(*Context, llvm::APInt(IntSize, flag),
5386  Context->IntTy, SourceLocation());
5387  InitExprs.push_back(FlagExp);
5388  }
5389  NewRep = CallExpr::Create(*Context, DRE, InitExprs, FType, VK_LValue,
5391 
5392  if (GlobalBlockExpr) {
5393  assert (!GlobalConstructionExp &&
5394  "SynthBlockInitExpr - GlobalConstructionExp must be null");
5395  GlobalConstructionExp = NewRep;
5396  NewRep = DRE;
5397  }
5398 
5399  NewRep = UnaryOperator::Create(
5400  const_cast<ASTContext &>(*Context), NewRep, UO_AddrOf,
5401  Context->getPointerType(NewRep->getType()), VK_PRValue, OK_Ordinary,
5402  SourceLocation(), false, FPOptionsOverride());
5403  NewRep = NoTypeInfoCStyleCastExpr(Context, FType, CK_BitCast,
5404  NewRep);
5405  // Put Paren around the call.
5406  NewRep = new (Context) ParenExpr(SourceLocation(), SourceLocation(),
5407  NewRep);
5408 
5409  BlockDeclRefs.clear();
5410  BlockByRefDecls.clear();
5411  BlockByRefDeclsPtrSet.clear();
5412  BlockByCopyDecls.clear();
5413  BlockByCopyDeclsPtrSet.clear();
5414  ImportedBlockDecls.clear();
5415  return NewRep;
5416 }
5417 
5418 bool RewriteModernObjC::IsDeclStmtInForeachHeader(DeclStmt *DS) {
5419  if (const ObjCForCollectionStmt * CS =
5420  dyn_cast<ObjCForCollectionStmt>(Stmts.back()))
5421  return CS->getElement() == DS;
5422  return false;
5423 }
5424 
5425 //===----------------------------------------------------------------------===//
5426 // Function Body / Expression rewriting
5427 //===----------------------------------------------------------------------===//
5428 
5429 Stmt *RewriteModernObjC::RewriteFunctionBodyOrGlobalInitializer(Stmt *S) {
5430  if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
5431  isa<DoStmt>(S) || isa<ForStmt>(S))
5432  Stmts.push_back(S);
5433  else if (isa<ObjCForCollectionStmt>(S)) {
5434  Stmts.push_back(S);
5435  ObjCBcLabelNo.push_back(++BcLabelCount);
5436  }
5437 
5438  // Pseudo-object operations and ivar references need special
5439  // treatment because we're going to recursively rewrite them.
5440  if (PseudoObjectExpr *PseudoOp = dyn_cast<PseudoObjectExpr>(S)) {
5441  if (isa<BinaryOperator>(PseudoOp->getSyntacticForm())) {
5442  return RewritePropertyOrImplicitSetter(PseudoOp);
5443  } else {
5444  return RewritePropertyOrImplicitGetter(PseudoOp);
5445  }
5446  } else if (ObjCIvarRefExpr *IvarRefExpr = dyn_cast<ObjCIvarRefExpr>(S)) {
5447  return RewriteObjCIvarRefExpr(IvarRefExpr);
5448  }
5449  else if (isa<OpaqueValueExpr>(S))
5450  S = cast<OpaqueValueExpr>(S)->getSourceExpr();
5451 
5452  SourceRange OrigStmtRange = S->getSourceRange();
5453 
5454  // Perform a bottom up rewrite of all children.
5455  for (Stmt *&childStmt : S->children())
5456  if (childStmt) {
5457  Stmt *newStmt = RewriteFunctionBodyOrGlobalInitializer(childStmt);
5458  if (newStmt) {
5459  childStmt = newStmt;
5460  }
5461  }
5462 
5463  if (BlockExpr *BE = dyn_cast<BlockExpr>(S)) {
5464  SmallVector<DeclRefExpr *, 8> InnerBlockDeclRefs;
5466  InnerContexts.insert(BE->getBlockDecl());
5467  ImportedLocalExternalDecls.clear();
5468  GetInnerBlockDeclRefExprs(BE->getBody(),
5469  InnerBlockDeclRefs, InnerContexts);
5470  // Rewrite the block body in place.
5471  Stmt *SaveCurrentBody = CurrentBody;
5472  CurrentBody = BE->getBody();
5473  PropParentMap = nullptr;
5474  // block literal on rhs of a property-dot-sytax assignment
5475  // must be replaced by its synthesize ast so getRewrittenText
5476  // works as expected. In this case, what actually ends up on RHS
5477  // is the blockTranscribed which is the helper function for the
5478  // block literal; as in: self.c = ^() {[ace ARR];};
5479  bool saveDisableReplaceStmt = DisableReplaceStmt;
5480  DisableReplaceStmt = false;
5481  RewriteFunctionBodyOrGlobalInitializer(BE->getBody());
5482  DisableReplaceStmt = saveDisableReplaceStmt;
5483  CurrentBody = SaveCurrentBody;
5484  PropParentMap = nullptr;
5485  ImportedLocalExternalDecls.clear();
5486  // Now we snarf the rewritten text and stash it away for later use.
5487  std::string Str = Rewrite.getRewrittenText(BE->getSourceRange());
5488  RewrittenBlockExprs[BE] = Str;
5489 
5490  Stmt *blockTranscribed = SynthBlockInitExpr(BE, InnerBlockDeclRefs);
5491 
5492  //blockTranscribed->dump();
5493  ReplaceStmt(S, blockTranscribed);
5494  return blockTranscribed;
5495  }
5496  // Handle specific things.
5497  if (ObjCEncodeExpr *AtEncode = dyn_cast<ObjCEncodeExpr>(S))
5498  return RewriteAtEncode(AtEncode);
5499 
5500  if (ObjCSelectorExpr *AtSelector = dyn_cast<ObjCSelectorExpr>(S))
5501  return RewriteAtSelector(AtSelector);
5502 
5503  if (ObjCStringLiteral *AtString = dyn_cast<ObjCStringLiteral>(S))
5504  return RewriteObjCStringLiteral(AtString);
5505 
5506  if (ObjCBoolLiteralExpr *BoolLitExpr = dyn_cast<ObjCBoolLiteralExpr>(S))
5507  return RewriteObjCBoolLiteralExpr(BoolLitExpr);
5508 
5509  if (ObjCBoxedExpr *BoxedExpr = dyn_cast<ObjCBoxedExpr>(S))
5510  return RewriteObjCBoxedExpr(BoxedExpr);
5511 
5512  if (ObjCArrayLiteral *ArrayLitExpr = dyn_cast<ObjCArrayLiteral>(S))
5513  return RewriteObjCArrayLiteralExpr(ArrayLitExpr);
5514 
5515  if (ObjCDictionaryLiteral *DictionaryLitExpr =
5516  dyn_cast<ObjCDictionaryLiteral>(S))
5517  return RewriteObjCDictionaryLiteralExpr(DictionaryLitExpr);
5518 
5519  if (ObjCMessageExpr *MessExpr = dyn_cast<ObjCMessageExpr>(S)) {
5520 #if 0
5521  // Before we rewrite it, put the original message expression in a comment.
5522  SourceLocation startLoc = MessExpr->getBeginLoc();
5523  SourceLocation endLoc = MessExpr->getEndLoc();
5524 
5525  const char *startBuf = SM->getCharacterData(startLoc);
5526  const char *endBuf = SM->getCharacterData(endLoc);
5527 
5528  std::string messString;
5529  messString += "// ";
5530  messString.append(startBuf, endBuf-startBuf+1);
5531  messString += "\n";
5532 
5533  // FIXME: Missing definition of
5534  // InsertText(clang::SourceLocation, char const*, unsigned int).
5535  // InsertText(startLoc, messString);
5536  // Tried this, but it didn't work either...
5537  // ReplaceText(startLoc, 0, messString.c_str(), messString.size());
5538 #endif
5539  return RewriteMessageExpr(MessExpr);
5540  }
5541 
5542  if (ObjCAutoreleasePoolStmt *StmtAutoRelease =
5543  dyn_cast<ObjCAutoreleasePoolStmt>(S)) {
5544  return RewriteObjCAutoreleasePoolStmt(StmtAutoRelease);
5545  }
5546 
5547  if (ObjCAtTryStmt *StmtTry = dyn_cast<ObjCAtTryStmt>(S))
5548  return RewriteObjCTryStmt(StmtTry);
5549 
5550  if (ObjCAtSynchronizedStmt *StmtTry = dyn_cast<ObjCAtSynchronizedStmt>(S))
5551  return RewriteObjCSynchronizedStmt(StmtTry);
5552 
5553  if (ObjCAtThrowStmt *StmtThrow = dyn_cast<ObjCAtThrowStmt>(S))
5554  return RewriteObjCThrowStmt(StmtThrow);
5555 
5556  if (ObjCProtocolExpr *ProtocolExp = dyn_cast<ObjCProtocolExpr>(S))
5557  return RewriteObjCProtocolExpr(ProtocolExp);
5558 
5559  if (ObjCForCollectionStmt *StmtForCollection =
5560  dyn_cast<ObjCForCollectionStmt>(S))
5561  return RewriteObjCForCollectionStmt(StmtForCollection,
5562  OrigStmtRange.getEnd());
5563  if (BreakStmt *StmtBreakStmt =
5564  dyn_cast<BreakStmt>(S))
5565  return RewriteBreakStmt(StmtBreakStmt);
5566  if (ContinueStmt *StmtContinueStmt =
5567  dyn_cast<ContinueStmt>(S))
5568  return RewriteContinueStmt(StmtContinueStmt);
5569 
5570  // Need to check for protocol refs (id <P>, Foo <P> *) in variable decls
5571  // and cast exprs.
5572  if (DeclStmt *DS = dyn_cast<DeclStmt>(S)) {
5573  // FIXME: What we're doing here is modifying the type-specifier that
5574  // precedes the first Decl. In the future the DeclGroup should have
5575  // a separate type-specifier that we can rewrite.
5576  // NOTE: We need to avoid rewriting the DeclStmt if it is within
5577  // the context of an ObjCForCollectionStmt. For example:
5578  // NSArray *someArray;
5579  // for (id <FooProtocol> index in someArray) ;
5580  // This is because RewriteObjCForCollectionStmt() does textual rewriting
5581  // and it depends on the original text locations/positions.
5582  if (Stmts.empty() || !IsDeclStmtInForeachHeader(DS))
5583  RewriteObjCQualifiedInterfaceTypes(*DS->decl_begin());
5584 
5585  // Blocks rewrite rules.
5586  for (DeclStmt::decl_iterator DI = DS->decl_begin(), DE = DS->decl_end();
5587  DI != DE; ++DI) {
5588  Decl *SD = *DI;
5589  if (ValueDecl *ND = dyn_cast<ValueDecl>(SD)) {
5590  if (isTopLevelBlockPointerType(ND->getType()))
5591  RewriteBlockPointerDecl(ND);
5592  else if (ND->getType()->isFunctionPointerType())
5593  CheckFunctionPointerDecl(ND->getType(), ND);
5594  if (VarDecl *VD = dyn_cast<VarDecl>(SD)) {
5595  if (VD->hasAttr<BlocksAttr>()) {
5596  static unsigned uniqueByrefDeclCount = 0;
5597  assert(!BlockByRefDeclNo.count(ND) &&
5598  "RewriteFunctionBodyOrGlobalInitializer: Duplicate byref decl");
5599  BlockByRefDeclNo[ND] = uniqueByrefDeclCount++;
5600  RewriteByRefVar(VD, (DI == DS->decl_begin()), ((DI+1) == DE));
5601  }
5602  else
5603  RewriteTypeOfDecl(VD);
5604  }
5605  }
5606  if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(SD)) {
5607  if (isTopLevelBlockPointerType(TD->getUnderlyingType()))
5608  RewriteBlockPointerDecl(TD);
5609  else if (TD->getUnderlyingType()->isFunctionPointerType())
5610  CheckFunctionPointerDecl(TD->getUnderlyingType(), TD);
5611  }
5612  }
5613  }
5614 
5615  if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(S))
5616  RewriteObjCQualifiedInterfaceTypes(CE);
5617 
5618  if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) ||
5619  isa<DoStmt>(S) || isa<ForStmt>(S)) {
5620  assert(!Stmts.empty() && "Statement stack is empty");
5621  assert ((isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>(Stmts.back()) ||
5622  isa<DoStmt>(Stmts.back()) || isa<ForStmt>(Stmts.back()))
5623  && "Statement stack mismatch");
5624  Stmts.pop_back();
5625  }
5626  // Handle blocks rewriting.
5627  if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) {
5628  ValueDecl *VD = DRE->getDecl();
5629  if (VD->hasAttr<BlocksAttr>())
5630  return RewriteBlockDeclRefExpr(DRE);
5632  return RewriteLocalVariableExternalStorage(DRE);
5633  }
5634 
5635  if (CallExpr *CE = dyn_cast<CallExpr>(S)) {
5636  if (CE->getCallee()->getType()->isBlockPointerType()) {
5637  Stmt *BlockCall = SynthesizeBlockCall(CE, CE->getCallee());
5638  ReplaceStmt(S, BlockCall);
5639  re