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