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 14 #include "clang/Rewrite/Frontend/ASTConsumers.h" 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" 21 #include "clang/Basic/IdentifierTable.h" 22 #include "clang/Basic/SourceManager.h" 23 #include "clang/Config/config.h" 24 #include "clang/Lex/Lexer.h" 25 #include "clang/Rewrite/Core/Rewriter.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 */ 51 BLOCK_BYREF_CURRENT_MAX = 256 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; 68 SourceManager *SM; 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; 116 SmallVector<Stmt *, 32> Stmts; 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. 124 SmallVector<BlockExpr *, 32> Blocks; 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, 269 ObjCImplementationDecl *IMD, 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() && 439 T->getPointeeType()->isObjCQualifiedInterfaceType()) { 440 if (const ObjCObjectPointerType * OBJPT = 441 T->getAsObjCInterfacePointerType()) { 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(); 486 FunctionProtoType::ExtProtoInfo fpi; 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) { 494 TypeSourceInfo *TInfo = Ctx->getTrivialTypeSourceInfo(Ty, SourceLocation()); 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( 587 DiagnosticsEngine::Warning, 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()) { 682 SmallVector<Decl *, 8> DG; 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()) { 701 SmallVector<Decl *, 8> DG; 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, 768 ObjCImplementationDecl *IMD, 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 781 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic) 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 | 794 ObjCPropertyDecl::OBJC_PR_copy)); 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 | 853 ObjCPropertyDecl::OBJC_PR_copy); 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 889 static void RewriteOneForwardClassDecl(ObjCInterfaceDecl *ForwardDecl, 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 } 925 DeclGroupRef::iterator I = D.begin(); 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. 1257 SmallVector<SourceLocation, 1> SelLocs; 1258 OldMsg->getSelectorLocs(SelLocs); 1259 1260 ObjCMessageExpr *NewMsg = nullptr; 1261 switch (OldMsg->getReceiverKind()) { 1262 case ObjCMessageExpr::Class: 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 1275 case ObjCMessageExpr::Instance: 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 1288 case ObjCMessageExpr::SuperClass: 1289 case ObjCMessageExpr::SuperInstance: 1290 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(), 1291 OldMsg->getValueKind(), 1292 OldMsg->getLeftLoc(), 1293 OldMsg->getSuperLoc(), 1294 OldMsg->getReceiverKind() == ObjCMessageExpr::SuperInstance, 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. 1333 SmallVector<SourceLocation, 1> SelLocs; 1334 SmallVector<Expr*, 1> Args; 1335 1336 ObjCMessageExpr *NewMsg = nullptr; 1337 switch (OldMsg->getReceiverKind()) { 1338 case ObjCMessageExpr::Class: 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 1351 case ObjCMessageExpr::Instance: 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 1364 case ObjCMessageExpr::SuperClass: 1365 case ObjCMessageExpr::SuperInstance: 1366 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(), 1367 OldMsg->getValueKind(), 1368 OldMsg->getLeftLoc(), 1369 OldMsg->getSuperLoc(), 1370 OldMsg->getReceiverKind() == ObjCMessageExpr::SuperInstance, 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() || 1507 VD->getType()->isObjCQualifiedInterfaceType()) 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(FD, false, msgSendType, 2013 VK_LValue, SourceLocation()); 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 = new (Context) CallExpr(*Context, ICE, Args, 2024 FT->getCallResultType(*Context), 2025 VK_RValue, EndLoc); 2026 return Exp; 2027 } 2028 2029 static bool scanForProtocolRefs(const char *startBuf, const char *endBuf, 2030 const char *&startRef, const char *&endRef) { 2031 while (startBuf < endBuf) { 2032 if (*startBuf == '<') 2033 startRef = startBuf; // mark the start. 2034 if (*startBuf == '>') { 2035 if (startRef && *startRef == '<') { 2036 endRef = startBuf; // mark the end. 2037 return true; 2038 } 2039 return false; 2040 } 2041 startBuf++; 2042 } 2043 return false; 2044 } 2045 2046 static void scanToNextArgument(const char *&argRef) { 2047 int angle = 0; 2048 while (*argRef != ')' && (*argRef != ',' || angle > 0)) { 2049 if (*argRef == '<') 2050 angle++; 2051 else if (*argRef == '>') 2052 angle--; 2053 argRef++; 2054 } 2055 assert(angle == 0 && "scanToNextArgument - bad protocol type syntax"); 2056 } 2057 2058 bool RewriteObjC::needToScanForQualifiers(QualType T) { 2059 if (T->isObjCQualifiedIdType()) 2060 return true; 2061 if (const PointerType *PT = T->getAs<PointerType>()) { 2062 if (PT->getPointeeType()->isObjCQualifiedIdType()) 2063 return true; 2064 } 2065 if (T->isObjCObjectPointerType()) { 2066 T = T->getPointeeType(); 2067 return T->isObjCQualifiedInterfaceType(); 2068 } 2069 if (T->isArrayType()) { 2070 QualType ElemTy = Context->getBaseElementType(T); 2071 return needToScanForQualifiers(ElemTy); 2072 } 2073 return false; 2074 } 2075 2076 void RewriteObjC::RewriteObjCQualifiedInterfaceTypes(Expr *E) { 2077 QualType Type = E->getType(); 2078 if (needToScanForQualifiers(Type)) { 2079 SourceLocation Loc, EndLoc; 2080 2081 if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E)) { 2082 Loc = ECE->getLParenLoc(); 2083 EndLoc = ECE->getRParenLoc(); 2084 } else { 2085 Loc = E->getBeginLoc(); 2086 EndLoc = E->getEndLoc(); 2087 } 2088 // This will defend against trying to rewrite synthesized expressions. 2089 if (Loc.isInvalid() || EndLoc.isInvalid()) 2090 return; 2091 2092 const char *startBuf = SM->getCharacterData(Loc); 2093 const char *endBuf = SM->getCharacterData(EndLoc); 2094 const char *startRef = nullptr, *endRef = nullptr; 2095 if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) { 2096 // Get the locations of the startRef, endRef. 2097 SourceLocation LessLoc = Loc.getLocWithOffset(startRef-startBuf); 2098 SourceLocation GreaterLoc = Loc.getLocWithOffset(endRef-startBuf+1); 2099 // Comment out the protocol references. 2100 InsertText(LessLoc, "/*"); 2101 InsertText(GreaterLoc, "*/"); 2102 } 2103 } 2104 } 2105 2106 void RewriteObjC::RewriteObjCQualifiedInterfaceTypes(Decl *Dcl) { 2107 SourceLocation Loc; 2108 QualType Type; 2109 const FunctionProtoType *proto = nullptr; 2110 if (VarDecl *VD = dyn_cast<VarDecl>(Dcl)) { 2111 Loc = VD->getLocation(); 2112 Type = VD->getType(); 2113 } 2114 else if (FunctionDecl *FD = dyn_cast<FunctionDecl>(Dcl)) { 2115 Loc = FD->getLocation(); 2116 // Check for ObjC 'id' and class types that have been adorned with protocol 2117 // information (id<p>, C<p>*). The protocol references need to be rewritten! 2118 const FunctionType *funcType = FD->getType()->getAs<FunctionType>(); 2119 assert(funcType && "missing function type"); 2120 proto = dyn_cast<FunctionProtoType>(funcType); 2121 if (!proto) 2122 return; 2123 Type = proto->getReturnType(); 2124 } 2125 else if (FieldDecl *FD = dyn_cast<FieldDecl>(Dcl)) { 2126 Loc = FD->getLocation(); 2127 Type = FD->getType(); 2128 } 2129 else 2130 return; 2131 2132 if (needToScanForQualifiers(Type)) { 2133 // Since types are unique, we need to scan the buffer. 2134 2135 const char *endBuf = SM->getCharacterData(Loc); 2136 const char *startBuf = endBuf; 2137 while (*startBuf != ';' && *startBuf != '<' && startBuf != MainFileStart) 2138 startBuf--; // scan backward (from the decl location) for return type. 2139 const char *startRef = nullptr, *endRef = nullptr; 2140 if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) { 2141 // Get the locations of the startRef, endRef. 2142 SourceLocation LessLoc = Loc.getLocWithOffset(startRef-endBuf); 2143 SourceLocation GreaterLoc = Loc.getLocWithOffset(endRef-endBuf+1); 2144 // Comment out the protocol references. 2145 InsertText(LessLoc, "/*"); 2146 InsertText(GreaterLoc, "*/"); 2147 } 2148 } 2149 if (!proto) 2150 return; // most likely, was a variable 2151 // Now check arguments. 2152 const char *startBuf = SM->getCharacterData(Loc); 2153 const char *startFuncBuf = startBuf; 2154 for (unsigned i = 0; i < proto->getNumParams(); i++) { 2155 if (needToScanForQualifiers(proto->getParamType(i))) { 2156 // Since types are unique, we need to scan the buffer. 2157 2158 const char *endBuf = startBuf; 2159 // scan forward (from the decl location) for argument types. 2160 scanToNextArgument(endBuf); 2161 const char *startRef = nullptr, *endRef = nullptr; 2162 if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) { 2163 // Get the locations of the startRef, endRef. 2164 SourceLocation LessLoc = 2165 Loc.getLocWithOffset(startRef-startFuncBuf); 2166 SourceLocation GreaterLoc = 2167 Loc.getLocWithOffset(endRef-startFuncBuf+1); 2168 // Comment out the protocol references. 2169 InsertText(LessLoc, "/*"); 2170 InsertText(GreaterLoc, "*/"); 2171 } 2172 startBuf = ++endBuf; 2173 } 2174 else { 2175 // If the function name is derived from a macro expansion, then the 2176 // argument buffer will not follow the name. Need to speak with Chris. 2177 while (*startBuf && *startBuf != ')' && *startBuf != ',') 2178 startBuf++; // scan forward (from the decl location) for argument types. 2179 startBuf++; 2180 } 2181 } 2182 } 2183 2184 void RewriteObjC::RewriteTypeOfDecl(VarDecl *ND) { 2185 QualType QT = ND->getType(); 2186 const Type* TypePtr = QT->getAs<Type>(); 2187 if (!isa<TypeOfExprType>(TypePtr)) 2188 return; 2189 while (isa<TypeOfExprType>(TypePtr)) { 2190 const TypeOfExprType *TypeOfExprTypePtr = cast<TypeOfExprType>(TypePtr); 2191 QT = TypeOfExprTypePtr->getUnderlyingExpr()->getType(); 2192 TypePtr = QT->getAs<Type>(); 2193 } 2194 // FIXME. This will not work for multiple declarators; as in: 2195 // __typeof__(a) b,c,d; 2196 std::string TypeAsString(QT.getAsString(Context->getPrintingPolicy())); 2197 SourceLocation DeclLoc = ND->getTypeSpecStartLoc(); 2198 const char *startBuf = SM->getCharacterData(DeclLoc); 2199 if (ND->getInit()) { 2200 std::string Name(ND->getNameAsString()); 2201 TypeAsString += " " + Name + " = "; 2202 Expr *E = ND->getInit(); 2203 SourceLocation startLoc; 2204 if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E)) 2205 startLoc = ECE->getLParenLoc(); 2206 else 2207 startLoc = E->getBeginLoc(); 2208 startLoc = SM->getExpansionLoc(startLoc); 2209 const char *endBuf = SM->getCharacterData(startLoc); 2210 ReplaceText(DeclLoc, endBuf-startBuf-1, TypeAsString); 2211 } 2212 else { 2213 SourceLocation X = ND->getEndLoc(); 2214 X = SM->getExpansionLoc(X); 2215 const char *endBuf = SM->getCharacterData(X); 2216 ReplaceText(DeclLoc, endBuf-startBuf-1, TypeAsString); 2217 } 2218 } 2219 2220 // SynthSelGetUidFunctionDecl - SEL sel_registerName(const char *str); 2221 void RewriteObjC::SynthSelGetUidFunctionDecl() { 2222 IdentifierInfo *SelGetUidIdent = &Context->Idents.get("sel_registerName"); 2223 SmallVector<QualType, 16> ArgTys; 2224 ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst())); 2225 QualType getFuncType = 2226 getSimpleFunctionType(Context->getObjCSelType(), ArgTys); 2227 SelGetUidFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2228 SourceLocation(), 2229 SourceLocation(), 2230 SelGetUidIdent, getFuncType, 2231 nullptr, SC_Extern); 2232 } 2233 2234 void RewriteObjC::RewriteFunctionDecl(FunctionDecl *FD) { 2235 // declared in <objc/objc.h> 2236 if (FD->getIdentifier() && 2237 FD->getName() == "sel_registerName") { 2238 SelGetUidFunctionDecl = FD; 2239 return; 2240 } 2241 RewriteObjCQualifiedInterfaceTypes(FD); 2242 } 2243 2244 void RewriteObjC::RewriteBlockPointerType(std::string& Str, QualType Type) { 2245 std::string TypeString(Type.getAsString(Context->getPrintingPolicy())); 2246 const char *argPtr = TypeString.c_str(); 2247 if (!strchr(argPtr, '^')) { 2248 Str += TypeString; 2249 return; 2250 } 2251 while (*argPtr) { 2252 Str += (*argPtr == '^' ? '*' : *argPtr); 2253 argPtr++; 2254 } 2255 } 2256 2257 // FIXME. Consolidate this routine with RewriteBlockPointerType. 2258 void RewriteObjC::RewriteBlockPointerTypeVariable(std::string& Str, 2259 ValueDecl *VD) { 2260 QualType Type = VD->getType(); 2261 std::string TypeString(Type.getAsString(Context->getPrintingPolicy())); 2262 const char *argPtr = TypeString.c_str(); 2263 int paren = 0; 2264 while (*argPtr) { 2265 switch (*argPtr) { 2266 case '(': 2267 Str += *argPtr; 2268 paren++; 2269 break; 2270 case ')': 2271 Str += *argPtr; 2272 paren--; 2273 break; 2274 case '^': 2275 Str += '*'; 2276 if (paren == 1) 2277 Str += VD->getNameAsString(); 2278 break; 2279 default: 2280 Str += *argPtr; 2281 break; 2282 } 2283 argPtr++; 2284 } 2285 } 2286 2287 void RewriteObjC::RewriteBlockLiteralFunctionDecl(FunctionDecl *FD) { 2288 SourceLocation FunLocStart = FD->getTypeSpecStartLoc(); 2289 const FunctionType *funcType = FD->getType()->getAs<FunctionType>(); 2290 const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(funcType); 2291 if (!proto) 2292 return; 2293 QualType Type = proto->getReturnType(); 2294 std::string FdStr = Type.getAsString(Context->getPrintingPolicy()); 2295 FdStr += " "; 2296 FdStr += FD->getName(); 2297 FdStr += "("; 2298 unsigned numArgs = proto->getNumParams(); 2299 for (unsigned i = 0; i < numArgs; i++) { 2300 QualType ArgType = proto->getParamType(i); 2301 RewriteBlockPointerType(FdStr, ArgType); 2302 if (i+1 < numArgs) 2303 FdStr += ", "; 2304 } 2305 FdStr += ");\n"; 2306 InsertText(FunLocStart, FdStr); 2307 CurFunctionDeclToDeclareForBlock = nullptr; 2308 } 2309 2310 // SynthSuperConstructorFunctionDecl - id objc_super(id obj, id super); 2311 void RewriteObjC::SynthSuperConstructorFunctionDecl() { 2312 if (SuperConstructorFunctionDecl) 2313 return; 2314 IdentifierInfo *msgSendIdent = &Context->Idents.get("__rw_objc_super"); 2315 SmallVector<QualType, 16> ArgTys; 2316 QualType argT = Context->getObjCIdType(); 2317 assert(!argT.isNull() && "Can't find 'id' type"); 2318 ArgTys.push_back(argT); 2319 ArgTys.push_back(argT); 2320 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2321 ArgTys); 2322 SuperConstructorFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2323 SourceLocation(), 2324 SourceLocation(), 2325 msgSendIdent, msgSendType, 2326 nullptr, SC_Extern); 2327 } 2328 2329 // SynthMsgSendFunctionDecl - id objc_msgSend(id self, SEL op, ...); 2330 void RewriteObjC::SynthMsgSendFunctionDecl() { 2331 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend"); 2332 SmallVector<QualType, 16> ArgTys; 2333 QualType argT = Context->getObjCIdType(); 2334 assert(!argT.isNull() && "Can't find 'id' type"); 2335 ArgTys.push_back(argT); 2336 argT = Context->getObjCSelType(); 2337 assert(!argT.isNull() && "Can't find 'SEL' type"); 2338 ArgTys.push_back(argT); 2339 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2340 ArgTys, /*isVariadic=*/true); 2341 MsgSendFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2342 SourceLocation(), 2343 SourceLocation(), 2344 msgSendIdent, msgSendType, 2345 nullptr, SC_Extern); 2346 } 2347 2348 // SynthMsgSendSuperFunctionDecl - id objc_msgSendSuper(struct objc_super *, SEL op, ...); 2349 void RewriteObjC::SynthMsgSendSuperFunctionDecl() { 2350 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSendSuper"); 2351 SmallVector<QualType, 16> ArgTys; 2352 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 2353 SourceLocation(), SourceLocation(), 2354 &Context->Idents.get("objc_super")); 2355 QualType argT = Context->getPointerType(Context->getTagDeclType(RD)); 2356 assert(!argT.isNull() && "Can't build 'struct objc_super *' type"); 2357 ArgTys.push_back(argT); 2358 argT = Context->getObjCSelType(); 2359 assert(!argT.isNull() && "Can't find 'SEL' type"); 2360 ArgTys.push_back(argT); 2361 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2362 ArgTys, /*isVariadic=*/true); 2363 MsgSendSuperFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2364 SourceLocation(), 2365 SourceLocation(), 2366 msgSendIdent, msgSendType, 2367 nullptr, SC_Extern); 2368 } 2369 2370 // SynthMsgSendStretFunctionDecl - id objc_msgSend_stret(id self, SEL op, ...); 2371 void RewriteObjC::SynthMsgSendStretFunctionDecl() { 2372 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend_stret"); 2373 SmallVector<QualType, 16> ArgTys; 2374 QualType argT = Context->getObjCIdType(); 2375 assert(!argT.isNull() && "Can't find 'id' type"); 2376 ArgTys.push_back(argT); 2377 argT = Context->getObjCSelType(); 2378 assert(!argT.isNull() && "Can't find 'SEL' type"); 2379 ArgTys.push_back(argT); 2380 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2381 ArgTys, /*isVariadic=*/true); 2382 MsgSendStretFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2383 SourceLocation(), 2384 SourceLocation(), 2385 msgSendIdent, msgSendType, 2386 nullptr, SC_Extern); 2387 } 2388 2389 // SynthMsgSendSuperStretFunctionDecl - 2390 // id objc_msgSendSuper_stret(struct objc_super *, SEL op, ...); 2391 void RewriteObjC::SynthMsgSendSuperStretFunctionDecl() { 2392 IdentifierInfo *msgSendIdent = 2393 &Context->Idents.get("objc_msgSendSuper_stret"); 2394 SmallVector<QualType, 16> ArgTys; 2395 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 2396 SourceLocation(), SourceLocation(), 2397 &Context->Idents.get("objc_super")); 2398 QualType argT = Context->getPointerType(Context->getTagDeclType(RD)); 2399 assert(!argT.isNull() && "Can't build 'struct objc_super *' type"); 2400 ArgTys.push_back(argT); 2401 argT = Context->getObjCSelType(); 2402 assert(!argT.isNull() && "Can't find 'SEL' type"); 2403 ArgTys.push_back(argT); 2404 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2405 ArgTys, /*isVariadic=*/true); 2406 MsgSendSuperStretFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2407 SourceLocation(), 2408 SourceLocation(), 2409 msgSendIdent, 2410 msgSendType, nullptr, 2411 SC_Extern); 2412 } 2413 2414 // SynthMsgSendFpretFunctionDecl - double objc_msgSend_fpret(id self, SEL op, ...); 2415 void RewriteObjC::SynthMsgSendFpretFunctionDecl() { 2416 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend_fpret"); 2417 SmallVector<QualType, 16> ArgTys; 2418 QualType argT = Context->getObjCIdType(); 2419 assert(!argT.isNull() && "Can't find 'id' type"); 2420 ArgTys.push_back(argT); 2421 argT = Context->getObjCSelType(); 2422 assert(!argT.isNull() && "Can't find 'SEL' type"); 2423 ArgTys.push_back(argT); 2424 QualType msgSendType = getSimpleFunctionType(Context->DoubleTy, 2425 ArgTys, /*isVariadic=*/true); 2426 MsgSendFpretFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2427 SourceLocation(), 2428 SourceLocation(), 2429 msgSendIdent, msgSendType, 2430 nullptr, SC_Extern); 2431 } 2432 2433 // SynthGetClassFunctionDecl - id objc_getClass(const char *name); 2434 void RewriteObjC::SynthGetClassFunctionDecl() { 2435 IdentifierInfo *getClassIdent = &Context->Idents.get("objc_getClass"); 2436 SmallVector<QualType, 16> ArgTys; 2437 ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst())); 2438 QualType getClassType = getSimpleFunctionType(Context->getObjCIdType(), 2439 ArgTys); 2440 GetClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2441 SourceLocation(), 2442 SourceLocation(), 2443 getClassIdent, getClassType, 2444 nullptr, SC_Extern); 2445 } 2446 2447 // SynthGetSuperClassFunctionDecl - Class class_getSuperclass(Class cls); 2448 void RewriteObjC::SynthGetSuperClassFunctionDecl() { 2449 IdentifierInfo *getSuperClassIdent = 2450 &Context->Idents.get("class_getSuperclass"); 2451 SmallVector<QualType, 16> ArgTys; 2452 ArgTys.push_back(Context->getObjCClassType()); 2453 QualType getClassType = getSimpleFunctionType(Context->getObjCClassType(), 2454 ArgTys); 2455 GetSuperClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2456 SourceLocation(), 2457 SourceLocation(), 2458 getSuperClassIdent, 2459 getClassType, nullptr, 2460 SC_Extern); 2461 } 2462 2463 // SynthGetMetaClassFunctionDecl - id objc_getMetaClass(const char *name); 2464 void RewriteObjC::SynthGetMetaClassFunctionDecl() { 2465 IdentifierInfo *getClassIdent = &Context->Idents.get("objc_getMetaClass"); 2466 SmallVector<QualType, 16> ArgTys; 2467 ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst())); 2468 QualType getClassType = getSimpleFunctionType(Context->getObjCIdType(), 2469 ArgTys); 2470 GetMetaClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2471 SourceLocation(), 2472 SourceLocation(), 2473 getClassIdent, getClassType, 2474 nullptr, SC_Extern); 2475 } 2476 2477 Stmt *RewriteObjC::RewriteObjCStringLiteral(ObjCStringLiteral *Exp) { 2478 assert(Exp != nullptr && "Expected non-null ObjCStringLiteral"); 2479 QualType strType = getConstantStringStructType(); 2480 2481 std::string S = "__NSConstantStringImpl_"; 2482 2483 std::string tmpName = InFileName; 2484 unsigned i; 2485 for (i=0; i < tmpName.length(); i++) { 2486 char c = tmpName.at(i); 2487 // replace any non-alphanumeric characters with '_'. 2488 if (!isAlphanumeric(c)) 2489 tmpName[i] = '_'; 2490 } 2491 S += tmpName; 2492 S += "_"; 2493 S += utostr(NumObjCStringLiterals++); 2494 2495 Preamble += "static __NSConstantStringImpl " + S; 2496 Preamble += " __attribute__ ((section (\"__DATA, __cfstring\"))) = {__CFConstantStringClassReference,"; 2497 Preamble += "0x000007c8,"; // utf8_str 2498 // The pretty printer for StringLiteral handles escape characters properly. 2499 std::string prettyBufS; 2500 llvm::raw_string_ostream prettyBuf(prettyBufS); 2501 Exp->getString()->printPretty(prettyBuf, nullptr, PrintingPolicy(LangOpts)); 2502 Preamble += prettyBuf.str(); 2503 Preamble += ","; 2504 Preamble += utostr(Exp->getString()->getByteLength()) + "};\n"; 2505 2506 VarDecl *NewVD = VarDecl::Create(*Context, TUDecl, SourceLocation(), 2507 SourceLocation(), &Context->Idents.get(S), 2508 strType, nullptr, SC_Static); 2509 DeclRefExpr *DRE = new (Context) DeclRefExpr(NewVD, false, strType, VK_LValue, 2510 SourceLocation()); 2511 Expr *Unop = new (Context) UnaryOperator(DRE, UO_AddrOf, 2512 Context->getPointerType(DRE->getType()), 2513 VK_RValue, OK_Ordinary, 2514 SourceLocation(), false); 2515 // cast to NSConstantString * 2516 CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, Exp->getType(), 2517 CK_CPointerToObjCPointerCast, Unop); 2518 ReplaceStmt(Exp, cast); 2519 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 2520 return cast; 2521 } 2522 2523 // struct objc_super { struct objc_object *receiver; struct objc_class *super; }; 2524 QualType RewriteObjC::getSuperStructType() { 2525 if (!SuperStructDecl) { 2526 SuperStructDecl = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 2527 SourceLocation(), SourceLocation(), 2528 &Context->Idents.get("objc_super")); 2529 QualType FieldTypes[2]; 2530 2531 // struct objc_object *receiver; 2532 FieldTypes[0] = Context->getObjCIdType(); 2533 // struct objc_class *super; 2534 FieldTypes[1] = Context->getObjCClassType(); 2535 2536 // Create fields 2537 for (unsigned i = 0; i < 2; ++i) { 2538 SuperStructDecl->addDecl(FieldDecl::Create(*Context, SuperStructDecl, 2539 SourceLocation(), 2540 SourceLocation(), nullptr, 2541 FieldTypes[i], nullptr, 2542 /*BitWidth=*/nullptr, 2543 /*Mutable=*/false, 2544 ICIS_NoInit)); 2545 } 2546 2547 SuperStructDecl->completeDefinition(); 2548 } 2549 return Context->getTagDeclType(SuperStructDecl); 2550 } 2551 2552 QualType RewriteObjC::getConstantStringStructType() { 2553 if (!ConstantStringDecl) { 2554 ConstantStringDecl = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 2555 SourceLocation(), SourceLocation(), 2556 &Context->Idents.get("__NSConstantStringImpl")); 2557 QualType FieldTypes[4]; 2558 2559 // struct objc_object *receiver; 2560 FieldTypes[0] = Context->getObjCIdType(); 2561 // int flags; 2562 FieldTypes[1] = Context->IntTy; 2563 // char *str; 2564 FieldTypes[2] = Context->getPointerType(Context->CharTy); 2565 // long length; 2566 FieldTypes[3] = Context->LongTy; 2567 2568 // Create fields 2569 for (unsigned i = 0; i < 4; ++i) { 2570 ConstantStringDecl->addDecl(FieldDecl::Create(*Context, 2571 ConstantStringDecl, 2572 SourceLocation(), 2573 SourceLocation(), nullptr, 2574 FieldTypes[i], nullptr, 2575 /*BitWidth=*/nullptr, 2576 /*Mutable=*/true, 2577 ICIS_NoInit)); 2578 } 2579 2580 ConstantStringDecl->completeDefinition(); 2581 } 2582 return Context->getTagDeclType(ConstantStringDecl); 2583 } 2584 2585 CallExpr *RewriteObjC::SynthMsgSendStretCallExpr(FunctionDecl *MsgSendStretFlavor, 2586 QualType msgSendType, 2587 QualType returnType, 2588 SmallVectorImpl<QualType> &ArgTypes, 2589 SmallVectorImpl<Expr*> &MsgExprs, 2590 ObjCMethodDecl *Method) { 2591 // Create a reference to the objc_msgSend_stret() declaration. 2592 DeclRefExpr *STDRE = new (Context) DeclRefExpr(MsgSendStretFlavor, 2593 false, msgSendType, 2594 VK_LValue, SourceLocation()); 2595 // Need to cast objc_msgSend_stret to "void *" (see above comment). 2596 CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, 2597 Context->getPointerType(Context->VoidTy), 2598 CK_BitCast, STDRE); 2599 // Now do the "normal" pointer to function cast. 2600 QualType castType = getSimpleFunctionType(returnType, ArgTypes, 2601 Method ? Method->isVariadic() 2602 : false); 2603 castType = Context->getPointerType(castType); 2604 cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast, 2605 cast); 2606 2607 // Don't forget the parens to enforce the proper binding. 2608 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), cast); 2609 2610 const FunctionType *FT = msgSendType->getAs<FunctionType>(); 2611 CallExpr *STCE = new (Context) CallExpr( 2612 *Context, PE, MsgExprs, FT->getReturnType(), VK_RValue, SourceLocation()); 2613 return STCE; 2614 } 2615 2616 Stmt *RewriteObjC::SynthMessageExpr(ObjCMessageExpr *Exp, 2617 SourceLocation StartLoc, 2618 SourceLocation EndLoc) { 2619 if (!SelGetUidFunctionDecl) 2620 SynthSelGetUidFunctionDecl(); 2621 if (!MsgSendFunctionDecl) 2622 SynthMsgSendFunctionDecl(); 2623 if (!MsgSendSuperFunctionDecl) 2624 SynthMsgSendSuperFunctionDecl(); 2625 if (!MsgSendStretFunctionDecl) 2626 SynthMsgSendStretFunctionDecl(); 2627 if (!MsgSendSuperStretFunctionDecl) 2628 SynthMsgSendSuperStretFunctionDecl(); 2629 if (!MsgSendFpretFunctionDecl) 2630 SynthMsgSendFpretFunctionDecl(); 2631 if (!GetClassFunctionDecl) 2632 SynthGetClassFunctionDecl(); 2633 if (!GetSuperClassFunctionDecl) 2634 SynthGetSuperClassFunctionDecl(); 2635 if (!GetMetaClassFunctionDecl) 2636 SynthGetMetaClassFunctionDecl(); 2637 2638 // default to objc_msgSend(). 2639 FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl; 2640 // May need to use objc_msgSend_stret() as well. 2641 FunctionDecl *MsgSendStretFlavor = nullptr; 2642 if (ObjCMethodDecl *mDecl = Exp->getMethodDecl()) { 2643 QualType resultType = mDecl->getReturnType(); 2644 if (resultType->isRecordType()) 2645 MsgSendStretFlavor = MsgSendStretFunctionDecl; 2646 else if (resultType->isRealFloatingType()) 2647 MsgSendFlavor = MsgSendFpretFunctionDecl; 2648 } 2649 2650 // Synthesize a call to objc_msgSend(). 2651 SmallVector<Expr*, 8> MsgExprs; 2652 switch (Exp->getReceiverKind()) { 2653 case ObjCMessageExpr::SuperClass: { 2654 MsgSendFlavor = MsgSendSuperFunctionDecl; 2655 if (MsgSendStretFlavor) 2656 MsgSendStretFlavor = MsgSendSuperStretFunctionDecl; 2657 assert(MsgSendFlavor && "MsgSendFlavor is NULL!"); 2658 2659 ObjCInterfaceDecl *ClassDecl = CurMethodDef->getClassInterface(); 2660 2661 SmallVector<Expr*, 4> InitExprs; 2662 2663 // set the receiver to self, the first argument to all methods. 2664 InitExprs.push_back( 2665 NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 2666 CK_BitCast, 2667 new (Context) DeclRefExpr(CurMethodDef->getSelfDecl(), 2668 false, 2669 Context->getObjCIdType(), 2670 VK_RValue, 2671 SourceLocation())) 2672 ); // set the 'receiver'. 2673 2674 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass")) 2675 SmallVector<Expr*, 8> ClsExprs; 2676 ClsExprs.push_back(getStringLiteral(ClassDecl->getIdentifier()->getName())); 2677 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetMetaClassFunctionDecl, 2678 ClsExprs, StartLoc, EndLoc); 2679 // (Class)objc_getClass("CurrentClass") 2680 CastExpr *ArgExpr = NoTypeInfoCStyleCastExpr(Context, 2681 Context->getObjCClassType(), 2682 CK_BitCast, Cls); 2683 ClsExprs.clear(); 2684 ClsExprs.push_back(ArgExpr); 2685 Cls = SynthesizeCallToFunctionDecl(GetSuperClassFunctionDecl, ClsExprs, 2686 StartLoc, EndLoc); 2687 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass")) 2688 // To turn off a warning, type-cast to 'id' 2689 InitExprs.push_back( // set 'super class', using class_getSuperclass(). 2690 NoTypeInfoCStyleCastExpr(Context, 2691 Context->getObjCIdType(), 2692 CK_BitCast, Cls)); 2693 // struct objc_super 2694 QualType superType = getSuperStructType(); 2695 Expr *SuperRep; 2696 2697 if (LangOpts.MicrosoftExt) { 2698 SynthSuperConstructorFunctionDecl(); 2699 // Simulate a constructor call... 2700 DeclRefExpr *DRE = new (Context) DeclRefExpr(SuperConstructorFunctionDecl, 2701 false, superType, VK_LValue, 2702 SourceLocation()); 2703 SuperRep = new (Context) CallExpr(*Context, DRE, InitExprs, 2704 superType, VK_LValue, 2705 SourceLocation()); 2706 // The code for super is a little tricky to prevent collision with 2707 // the structure definition in the header. The rewriter has it's own 2708 // internal definition (__rw_objc_super) that is uses. This is why 2709 // we need the cast below. For example: 2710 // (struct objc_super *)&__rw_objc_super((id)self, (id)objc_getClass("SUPER")) 2711 // 2712 SuperRep = new (Context) UnaryOperator(SuperRep, UO_AddrOf, 2713 Context->getPointerType(SuperRep->getType()), 2714 VK_RValue, OK_Ordinary, 2715 SourceLocation(), false); 2716 SuperRep = NoTypeInfoCStyleCastExpr(Context, 2717 Context->getPointerType(superType), 2718 CK_BitCast, SuperRep); 2719 } else { 2720 // (struct objc_super) { <exprs from above> } 2721 InitListExpr *ILE = 2722 new (Context) InitListExpr(*Context, SourceLocation(), InitExprs, 2723 SourceLocation()); 2724 TypeSourceInfo *superTInfo 2725 = Context->getTrivialTypeSourceInfo(superType); 2726 SuperRep = new (Context) CompoundLiteralExpr(SourceLocation(), superTInfo, 2727 superType, VK_LValue, 2728 ILE, false); 2729 // struct objc_super * 2730 SuperRep = new (Context) UnaryOperator(SuperRep, UO_AddrOf, 2731 Context->getPointerType(SuperRep->getType()), 2732 VK_RValue, OK_Ordinary, 2733 SourceLocation(), false); 2734 } 2735 MsgExprs.push_back(SuperRep); 2736 break; 2737 } 2738 2739 case ObjCMessageExpr::Class: { 2740 SmallVector<Expr*, 8> ClsExprs; 2741 ObjCInterfaceDecl *Class 2742 = Exp->getClassReceiver()->getAs<ObjCObjectType>()->getInterface(); 2743 IdentifierInfo *clsName = Class->getIdentifier(); 2744 ClsExprs.push_back(getStringLiteral(clsName->getName())); 2745 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs, 2746 StartLoc, EndLoc); 2747 MsgExprs.push_back(Cls); 2748 break; 2749 } 2750 2751 case ObjCMessageExpr::SuperInstance:{ 2752 MsgSendFlavor = MsgSendSuperFunctionDecl; 2753 if (MsgSendStretFlavor) 2754 MsgSendStretFlavor = MsgSendSuperStretFunctionDecl; 2755 assert(MsgSendFlavor && "MsgSendFlavor is NULL!"); 2756 ObjCInterfaceDecl *ClassDecl = CurMethodDef->getClassInterface(); 2757 SmallVector<Expr*, 4> InitExprs; 2758 2759 InitExprs.push_back( 2760 NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 2761 CK_BitCast, 2762 new (Context) DeclRefExpr(CurMethodDef->getSelfDecl(), 2763 false, 2764 Context->getObjCIdType(), 2765 VK_RValue, SourceLocation())) 2766 ); // set the 'receiver'. 2767 2768 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass")) 2769 SmallVector<Expr*, 8> ClsExprs; 2770 ClsExprs.push_back(getStringLiteral(ClassDecl->getIdentifier()->getName())); 2771 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs, 2772 StartLoc, EndLoc); 2773 // (Class)objc_getClass("CurrentClass") 2774 CastExpr *ArgExpr = NoTypeInfoCStyleCastExpr(Context, 2775 Context->getObjCClassType(), 2776 CK_BitCast, Cls); 2777 ClsExprs.clear(); 2778 ClsExprs.push_back(ArgExpr); 2779 Cls = SynthesizeCallToFunctionDecl(GetSuperClassFunctionDecl, ClsExprs, 2780 StartLoc, EndLoc); 2781 2782 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass")) 2783 // To turn off a warning, type-cast to 'id' 2784 InitExprs.push_back( 2785 // set 'super class', using class_getSuperclass(). 2786 NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 2787 CK_BitCast, Cls)); 2788 // struct objc_super 2789 QualType superType = getSuperStructType(); 2790 Expr *SuperRep; 2791 2792 if (LangOpts.MicrosoftExt) { 2793 SynthSuperConstructorFunctionDecl(); 2794 // Simulate a constructor call... 2795 DeclRefExpr *DRE = new (Context) DeclRefExpr(SuperConstructorFunctionDecl, 2796 false, superType, VK_LValue, 2797 SourceLocation()); 2798 SuperRep = new (Context) CallExpr(*Context, DRE, InitExprs, 2799 superType, VK_LValue, SourceLocation()); 2800 // The code for super is a little tricky to prevent collision with 2801 // the structure definition in the header. The rewriter has it's own 2802 // internal definition (__rw_objc_super) that is uses. This is why 2803 // we need the cast below. For example: 2804 // (struct objc_super *)&__rw_objc_super((id)self, (id)objc_getClass("SUPER")) 2805 // 2806 SuperRep = new (Context) UnaryOperator(SuperRep, UO_AddrOf, 2807 Context->getPointerType(SuperRep->getType()), 2808 VK_RValue, OK_Ordinary, 2809 SourceLocation(), false); 2810 SuperRep = NoTypeInfoCStyleCastExpr(Context, 2811 Context->getPointerType(superType), 2812 CK_BitCast, SuperRep); 2813 } else { 2814 // (struct objc_super) { <exprs from above> } 2815 InitListExpr *ILE = 2816 new (Context) InitListExpr(*Context, SourceLocation(), InitExprs, 2817 SourceLocation()); 2818 TypeSourceInfo *superTInfo 2819 = Context->getTrivialTypeSourceInfo(superType); 2820 SuperRep = new (Context) CompoundLiteralExpr(SourceLocation(), superTInfo, 2821 superType, VK_RValue, ILE, 2822 false); 2823 } 2824 MsgExprs.push_back(SuperRep); 2825 break; 2826 } 2827 2828 case ObjCMessageExpr::Instance: { 2829 // Remove all type-casts because it may contain objc-style types; e.g. 2830 // Foo<Proto> *. 2831 Expr *recExpr = Exp->getInstanceReceiver(); 2832 while (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(recExpr)) 2833 recExpr = CE->getSubExpr(); 2834 CastKind CK = recExpr->getType()->isObjCObjectPointerType() 2835 ? CK_BitCast : recExpr->getType()->isBlockPointerType() 2836 ? CK_BlockPointerToObjCPointerCast 2837 : CK_CPointerToObjCPointerCast; 2838 2839 recExpr = NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 2840 CK, recExpr); 2841 MsgExprs.push_back(recExpr); 2842 break; 2843 } 2844 } 2845 2846 // Create a call to sel_registerName("selName"), it will be the 2nd argument. 2847 SmallVector<Expr*, 8> SelExprs; 2848 SelExprs.push_back(getStringLiteral(Exp->getSelector().getAsString())); 2849 CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl, 2850 SelExprs, StartLoc, EndLoc); 2851 MsgExprs.push_back(SelExp); 2852 2853 // Now push any user supplied arguments. 2854 for (unsigned i = 0; i < Exp->getNumArgs(); i++) { 2855 Expr *userExpr = Exp->getArg(i); 2856 // Make all implicit casts explicit...ICE comes in handy:-) 2857 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(userExpr)) { 2858 // Reuse the ICE type, it is exactly what the doctor ordered. 2859 QualType type = ICE->getType(); 2860 if (needToScanForQualifiers(type)) 2861 type = Context->getObjCIdType(); 2862 // Make sure we convert "type (^)(...)" to "type (*)(...)". 2863 (void)convertBlockPointerToFunctionPointer(type); 2864 const Expr *SubExpr = ICE->IgnoreParenImpCasts(); 2865 CastKind CK; 2866 if (SubExpr->getType()->isIntegralType(*Context) && 2867 type->isBooleanType()) { 2868 CK = CK_IntegralToBoolean; 2869 } else if (type->isObjCObjectPointerType()) { 2870 if (SubExpr->getType()->isBlockPointerType()) { 2871 CK = CK_BlockPointerToObjCPointerCast; 2872 } else if (SubExpr->getType()->isPointerType()) { 2873 CK = CK_CPointerToObjCPointerCast; 2874 } else { 2875 CK = CK_BitCast; 2876 } 2877 } else { 2878 CK = CK_BitCast; 2879 } 2880 2881 userExpr = NoTypeInfoCStyleCastExpr(Context, type, CK, userExpr); 2882 } 2883 // Make id<P...> cast into an 'id' cast. 2884 else if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(userExpr)) { 2885 if (CE->getType()->isObjCQualifiedIdType()) { 2886 while ((CE = dyn_cast<CStyleCastExpr>(userExpr))) 2887 userExpr = CE->getSubExpr(); 2888 CastKind CK; 2889 if (userExpr->getType()->isIntegralType(*Context)) { 2890 CK = CK_IntegralToPointer; 2891 } else if (userExpr->getType()->isBlockPointerType()) { 2892 CK = CK_BlockPointerToObjCPointerCast; 2893 } else if (userExpr->getType()->isPointerType()) { 2894 CK = CK_CPointerToObjCPointerCast; 2895 } else { 2896 CK = CK_BitCast; 2897 } 2898 userExpr = NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 2899 CK, userExpr); 2900 } 2901 } 2902 MsgExprs.push_back(userExpr); 2903 // We've transferred the ownership to MsgExprs. For now, we *don't* null 2904 // out the argument in the original expression (since we aren't deleting 2905 // the ObjCMessageExpr). See RewritePropertyOrImplicitSetter() usage for more info. 2906 //Exp->setArg(i, 0); 2907 } 2908 // Generate the funky cast. 2909 CastExpr *cast; 2910 SmallVector<QualType, 8> ArgTypes; 2911 QualType returnType; 2912 2913 // Push 'id' and 'SEL', the 2 implicit arguments. 2914 if (MsgSendFlavor == MsgSendSuperFunctionDecl) 2915 ArgTypes.push_back(Context->getPointerType(getSuperStructType())); 2916 else 2917 ArgTypes.push_back(Context->getObjCIdType()); 2918 ArgTypes.push_back(Context->getObjCSelType()); 2919 if (ObjCMethodDecl *OMD = Exp->getMethodDecl()) { 2920 // Push any user argument types. 2921 for (const auto *PI : OMD->parameters()) { 2922 QualType t = PI->getType()->isObjCQualifiedIdType() 2923 ? Context->getObjCIdType() 2924 : PI->getType(); 2925 // Make sure we convert "t (^)(...)" to "t (*)(...)". 2926 (void)convertBlockPointerToFunctionPointer(t); 2927 ArgTypes.push_back(t); 2928 } 2929 returnType = Exp->getType(); 2930 convertToUnqualifiedObjCType(returnType); 2931 (void)convertBlockPointerToFunctionPointer(returnType); 2932 } else { 2933 returnType = Context->getObjCIdType(); 2934 } 2935 // Get the type, we will need to reference it in a couple spots. 2936 QualType msgSendType = MsgSendFlavor->getType(); 2937 2938 // Create a reference to the objc_msgSend() declaration. 2939 DeclRefExpr *DRE = new (Context) DeclRefExpr(MsgSendFlavor, false, msgSendType, 2940 VK_LValue, SourceLocation()); 2941 2942 // Need to cast objc_msgSend to "void *" (to workaround a GCC bandaid). 2943 // If we don't do this cast, we get the following bizarre warning/note: 2944 // xx.m:13: warning: function called through a non-compatible type 2945 // xx.m:13: note: if this code is reached, the program will abort 2946 cast = NoTypeInfoCStyleCastExpr(Context, 2947 Context->getPointerType(Context->VoidTy), 2948 CK_BitCast, DRE); 2949 2950 // Now do the "normal" pointer to function cast. 2951 // If we don't have a method decl, force a variadic cast. 2952 const ObjCMethodDecl *MD = Exp->getMethodDecl(); 2953 QualType castType = 2954 getSimpleFunctionType(returnType, ArgTypes, MD ? MD->isVariadic() : true); 2955 castType = Context->getPointerType(castType); 2956 cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast, 2957 cast); 2958 2959 // Don't forget the parens to enforce the proper binding. 2960 ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast); 2961 2962 const FunctionType *FT = msgSendType->getAs<FunctionType>(); 2963 CallExpr *CE = new (Context) 2964 CallExpr(*Context, PE, MsgExprs, FT->getReturnType(), VK_RValue, EndLoc); 2965 Stmt *ReplacingStmt = CE; 2966 if (MsgSendStretFlavor) { 2967 // We have the method which returns a struct/union. Must also generate 2968 // call to objc_msgSend_stret and hang both varieties on a conditional 2969 // expression which dictate which one to envoke depending on size of 2970 // method's return type. 2971 2972 CallExpr *STCE = SynthMsgSendStretCallExpr(MsgSendStretFlavor, 2973 msgSendType, returnType, 2974 ArgTypes, MsgExprs, 2975 Exp->getMethodDecl()); 2976 2977 // Build sizeof(returnType) 2978 UnaryExprOrTypeTraitExpr *sizeofExpr = 2979 new (Context) UnaryExprOrTypeTraitExpr(UETT_SizeOf, 2980 Context->getTrivialTypeSourceInfo(returnType), 2981 Context->getSizeType(), SourceLocation(), 2982 SourceLocation()); 2983 // (sizeof(returnType) <= 8 ? objc_msgSend(...) : objc_msgSend_stret(...)) 2984 // FIXME: Value of 8 is base on ppc32/x86 ABI for the most common cases. 2985 // For X86 it is more complicated and some kind of target specific routine 2986 // is needed to decide what to do. 2987 unsigned IntSize = 2988 static_cast<unsigned>(Context->getTypeSize(Context->IntTy)); 2989 IntegerLiteral *limit = IntegerLiteral::Create(*Context, 2990 llvm::APInt(IntSize, 8), 2991 Context->IntTy, 2992 SourceLocation()); 2993 BinaryOperator *lessThanExpr = 2994 new (Context) BinaryOperator(sizeofExpr, limit, BO_LE, Context->IntTy, 2995 VK_RValue, OK_Ordinary, SourceLocation(), 2996 FPOptions()); 2997 // (sizeof(returnType) <= 8 ? objc_msgSend(...) : objc_msgSend_stret(...)) 2998 ConditionalOperator *CondExpr = 2999 new (Context) ConditionalOperator(lessThanExpr, 3000 SourceLocation(), CE, 3001 SourceLocation(), STCE, 3002 returnType, VK_RValue, OK_Ordinary); 3003 ReplacingStmt = new (Context) ParenExpr(SourceLocation(), SourceLocation(), 3004 CondExpr); 3005 } 3006 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 3007 return ReplacingStmt; 3008 } 3009 3010 Stmt *RewriteObjC::RewriteMessageExpr(ObjCMessageExpr *Exp) { 3011 Stmt *ReplacingStmt = 3012 SynthMessageExpr(Exp, Exp->getBeginLoc(), Exp->getEndLoc()); 3013 3014 // Now do the actual rewrite. 3015 ReplaceStmt(Exp, ReplacingStmt); 3016 3017 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 3018 return ReplacingStmt; 3019 } 3020 3021 // typedef struct objc_object Protocol; 3022 QualType RewriteObjC::getProtocolType() { 3023 if (!ProtocolTypeDecl) { 3024 TypeSourceInfo *TInfo 3025 = Context->getTrivialTypeSourceInfo(Context->getObjCIdType()); 3026 ProtocolTypeDecl = TypedefDecl::Create(*Context, TUDecl, 3027 SourceLocation(), SourceLocation(), 3028 &Context->Idents.get("Protocol"), 3029 TInfo); 3030 } 3031 return Context->getTypeDeclType(ProtocolTypeDecl); 3032 } 3033 3034 /// RewriteObjCProtocolExpr - Rewrite a protocol expression into 3035 /// a synthesized/forward data reference (to the protocol's metadata). 3036 /// The forward references (and metadata) are generated in 3037 /// RewriteObjC::HandleTranslationUnit(). 3038 Stmt *RewriteObjC::RewriteObjCProtocolExpr(ObjCProtocolExpr *Exp) { 3039 std::string Name = "_OBJC_PROTOCOL_" + Exp->getProtocol()->getNameAsString(); 3040 IdentifierInfo *ID = &Context->Idents.get(Name); 3041 VarDecl *VD = VarDecl::Create(*Context, TUDecl, SourceLocation(), 3042 SourceLocation(), ID, getProtocolType(), 3043 nullptr, SC_Extern); 3044 DeclRefExpr *DRE = new (Context) DeclRefExpr(VD, false, getProtocolType(), 3045 VK_LValue, SourceLocation()); 3046 Expr *DerefExpr = new (Context) UnaryOperator(DRE, UO_AddrOf, 3047 Context->getPointerType(DRE->getType()), 3048 VK_RValue, OK_Ordinary, SourceLocation(), false); 3049 CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, DerefExpr->getType(), 3050 CK_BitCast, 3051 DerefExpr); 3052 ReplaceStmt(Exp, castExpr); 3053 ProtocolExprDecls.insert(Exp->getProtocol()->getCanonicalDecl()); 3054 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 3055 return castExpr; 3056 } 3057 3058 bool RewriteObjC::BufferContainsPPDirectives(const char *startBuf, 3059 const char *endBuf) { 3060 while (startBuf < endBuf) { 3061 if (*startBuf == '#') { 3062 // Skip whitespace. 3063 for (++startBuf; startBuf[0] == ' ' || startBuf[0] == '\t'; ++startBuf) 3064 ; 3065 if (!strncmp(startBuf, "if", strlen("if")) || 3066 !strncmp(startBuf, "ifdef", strlen("ifdef")) || 3067 !strncmp(startBuf, "ifndef", strlen("ifndef")) || 3068 !strncmp(startBuf, "define", strlen("define")) || 3069 !strncmp(startBuf, "undef", strlen("undef")) || 3070 !strncmp(startBuf, "else", strlen("else")) || 3071 !strncmp(startBuf, "elif", strlen("elif")) || 3072 !strncmp(startBuf, "endif", strlen("endif")) || 3073 !strncmp(startBuf, "pragma", strlen("pragma")) || 3074 !strncmp(startBuf, "include", strlen("include")) || 3075 !strncmp(startBuf, "import", strlen("import")) || 3076 !strncmp(startBuf, "include_next", strlen("include_next"))) 3077 return true; 3078 } 3079 startBuf++; 3080 } 3081 return false; 3082 } 3083 3084 /// RewriteObjCInternalStruct - Rewrite one internal struct corresponding to 3085 /// an objective-c class with ivars. 3086 void RewriteObjC::RewriteObjCInternalStruct(ObjCInterfaceDecl *CDecl, 3087 std::string &Result) { 3088 assert(CDecl && "Class missing in SynthesizeObjCInternalStruct"); 3089 assert(CDecl->getName() != "" && 3090 "Name missing in SynthesizeObjCInternalStruct"); 3091 // Do not synthesize more than once. 3092 if (ObjCSynthesizedStructs.count(CDecl)) 3093 return; 3094 ObjCInterfaceDecl *RCDecl = CDecl->getSuperClass(); 3095 int NumIvars = CDecl->ivar_size(); 3096 SourceLocation LocStart = CDecl->getBeginLoc(); 3097 SourceLocation LocEnd = CDecl->getEndOfDefinitionLoc(); 3098 3099 const char *startBuf = SM->getCharacterData(LocStart); 3100 const char *endBuf = SM->getCharacterData(LocEnd); 3101 3102 // If no ivars and no root or if its root, directly or indirectly, 3103 // have no ivars (thus not synthesized) then no need to synthesize this class. 3104 if ((!CDecl->isThisDeclarationADefinition() || NumIvars == 0) && 3105 (!RCDecl || !ObjCSynthesizedStructs.count(RCDecl))) { 3106 endBuf += Lexer::MeasureTokenLength(LocEnd, *SM, LangOpts); 3107 ReplaceText(LocStart, endBuf-startBuf, Result); 3108 return; 3109 } 3110 3111 // FIXME: This has potential of causing problem. If 3112 // SynthesizeObjCInternalStruct is ever called recursively. 3113 Result += "\nstruct "; 3114 Result += CDecl->getNameAsString(); 3115 if (LangOpts.MicrosoftExt) 3116 Result += "_IMPL"; 3117 3118 if (NumIvars > 0) { 3119 const char *cursor = strchr(startBuf, '{'); 3120 assert((cursor && endBuf) 3121 && "SynthesizeObjCInternalStruct - malformed @interface"); 3122 // If the buffer contains preprocessor directives, we do more fine-grained 3123 // rewrites. This is intended to fix code that looks like (which occurs in 3124 // NSURL.h, for example): 3125 // 3126 // #ifdef XYZ 3127 // @interface Foo : NSObject 3128 // #else 3129 // @interface FooBar : NSObject 3130 // #endif 3131 // { 3132 // int i; 3133 // } 3134 // @end 3135 // 3136 // This clause is segregated to avoid breaking the common case. 3137 if (BufferContainsPPDirectives(startBuf, cursor)) { 3138 SourceLocation L = RCDecl ? CDecl->getSuperClassLoc() : 3139 CDecl->getAtStartLoc(); 3140 const char *endHeader = SM->getCharacterData(L); 3141 endHeader += Lexer::MeasureTokenLength(L, *SM, LangOpts); 3142 3143 if (CDecl->protocol_begin() != CDecl->protocol_end()) { 3144 // advance to the end of the referenced protocols. 3145 while (endHeader < cursor && *endHeader != '>') endHeader++; 3146 endHeader++; 3147 } 3148 // rewrite the original header 3149 ReplaceText(LocStart, endHeader-startBuf, Result); 3150 } else { 3151 // rewrite the original header *without* disturbing the '{' 3152 ReplaceText(LocStart, cursor-startBuf, Result); 3153 } 3154 if (RCDecl && ObjCSynthesizedStructs.count(RCDecl)) { 3155 Result = "\n struct "; 3156 Result += RCDecl->getNameAsString(); 3157 Result += "_IMPL "; 3158 Result += RCDecl->getNameAsString(); 3159 Result += "_IVARS;\n"; 3160 3161 // insert the super class structure definition. 3162 SourceLocation OnePastCurly = 3163 LocStart.getLocWithOffset(cursor-startBuf+1); 3164 InsertText(OnePastCurly, Result); 3165 } 3166 cursor++; // past '{' 3167 3168 // Now comment out any visibility specifiers. 3169 while (cursor < endBuf) { 3170 if (*cursor == '@') { 3171 SourceLocation atLoc = LocStart.getLocWithOffset(cursor-startBuf); 3172 // Skip whitespace. 3173 for (++cursor; cursor[0] == ' ' || cursor[0] == '\t'; ++cursor) 3174 /*scan*/; 3175 3176 // FIXME: presence of @public, etc. inside comment results in 3177 // this transformation as well, which is still correct c-code. 3178 if (!strncmp(cursor, "public", strlen("public")) || 3179 !strncmp(cursor, "private", strlen("private")) || 3180 !strncmp(cursor, "package", strlen("package")) || 3181 !strncmp(cursor, "protected", strlen("protected"))) 3182 InsertText(atLoc, "// "); 3183 } 3184 // FIXME: If there are cases where '<' is used in ivar declaration part 3185 // of user code, then scan the ivar list and use needToScanForQualifiers 3186 // for type checking. 3187 else if (*cursor == '<') { 3188 SourceLocation atLoc = LocStart.getLocWithOffset(cursor-startBuf); 3189 InsertText(atLoc, "/* "); 3190 cursor = strchr(cursor, '>'); 3191 cursor++; 3192 atLoc = LocStart.getLocWithOffset(cursor-startBuf); 3193 InsertText(atLoc, " */"); 3194 } else if (*cursor == '^') { // rewrite block specifier. 3195 SourceLocation caretLoc = LocStart.getLocWithOffset(cursor-startBuf); 3196 ReplaceText(caretLoc, 1, "*"); 3197 } 3198 cursor++; 3199 } 3200 // Don't forget to add a ';'!! 3201 InsertText(LocEnd.getLocWithOffset(1), ";"); 3202 } else { // we don't have any instance variables - insert super struct. 3203 endBuf += Lexer::MeasureTokenLength(LocEnd, *SM, LangOpts); 3204 Result += " {\n struct "; 3205 Result += RCDecl->getNameAsString(); 3206 Result += "_IMPL "; 3207 Result += RCDecl->getNameAsString(); 3208 Result += "_IVARS;\n};\n"; 3209 ReplaceText(LocStart, endBuf-startBuf, Result); 3210 } 3211 // Mark this struct as having been generated. 3212 if (!ObjCSynthesizedStructs.insert(CDecl).second) 3213 llvm_unreachable("struct already synthesize- SynthesizeObjCInternalStruct"); 3214 } 3215 3216 //===----------------------------------------------------------------------===// 3217 // Meta Data Emission 3218 //===----------------------------------------------------------------------===// 3219 3220 /// RewriteImplementations - This routine rewrites all method implementations 3221 /// and emits meta-data. 3222 3223 void RewriteObjC::RewriteImplementations() { 3224 int ClsDefCount = ClassImplementation.size(); 3225 int CatDefCount = CategoryImplementation.size(); 3226 3227 // Rewrite implemented methods 3228 for (int i = 0; i < ClsDefCount; i++) 3229 RewriteImplementationDecl(ClassImplementation[i]); 3230 3231 for (int i = 0; i < CatDefCount; i++) 3232 RewriteImplementationDecl(CategoryImplementation[i]); 3233 } 3234 3235 void RewriteObjC::RewriteByRefString(std::string &ResultStr, 3236 const std::string &Name, 3237 ValueDecl *VD, bool def) { 3238 assert(BlockByRefDeclNo.count(VD) && 3239 "RewriteByRefString: ByRef decl missing"); 3240 if (def) 3241 ResultStr += "struct "; 3242 ResultStr += "__Block_byref_" + Name + 3243 "_" + utostr(BlockByRefDeclNo[VD]) ; 3244 } 3245 3246 static bool HasLocalVariableExternalStorage(ValueDecl *VD) { 3247 if (VarDecl *Var = dyn_cast<VarDecl>(VD)) 3248 return (Var->isFunctionOrMethodVarDecl() && !Var->hasLocalStorage()); 3249 return false; 3250 } 3251 3252 std::string RewriteObjC::SynthesizeBlockFunc(BlockExpr *CE, int i, 3253 StringRef funcName, 3254 std::string Tag) { 3255 const FunctionType *AFT = CE->getFunctionType(); 3256 QualType RT = AFT->getReturnType(); 3257 std::string StructRef = "struct " + Tag; 3258 std::string S = "static " + RT.getAsString(Context->getPrintingPolicy()) + " __" + 3259 funcName.str() + "_" + "block_func_" + utostr(i); 3260 3261 BlockDecl *BD = CE->getBlockDecl(); 3262 3263 if (isa<FunctionNoProtoType>(AFT)) { 3264 // No user-supplied arguments. Still need to pass in a pointer to the 3265 // block (to reference imported block decl refs). 3266 S += "(" + StructRef + " *__cself)"; 3267 } else if (BD->param_empty()) { 3268 S += "(" + StructRef + " *__cself)"; 3269 } else { 3270 const FunctionProtoType *FT = cast<FunctionProtoType>(AFT); 3271 assert(FT && "SynthesizeBlockFunc: No function proto"); 3272 S += '('; 3273 // first add the implicit argument. 3274 S += StructRef + " *__cself, "; 3275 std::string ParamStr; 3276 for (BlockDecl::param_iterator AI = BD->param_begin(), 3277 E = BD->param_end(); AI != E; ++AI) { 3278 if (AI != BD->param_begin()) S += ", "; 3279 ParamStr = (*AI)->getNameAsString(); 3280 QualType QT = (*AI)->getType(); 3281 (void)convertBlockPointerToFunctionPointer(QT); 3282 QT.getAsStringInternal(ParamStr, Context->getPrintingPolicy()); 3283 S += ParamStr; 3284 } 3285 if (FT->isVariadic()) { 3286 if (!BD->param_empty()) S += ", "; 3287 S += "..."; 3288 } 3289 S += ')'; 3290 } 3291 S += " {\n"; 3292 3293 // Create local declarations to avoid rewriting all closure decl ref exprs. 3294 // First, emit a declaration for all "by ref" decls. 3295 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(), 3296 E = BlockByRefDecls.end(); I != E; ++I) { 3297 S += " "; 3298 std::string Name = (*I)->getNameAsString(); 3299 std::string TypeString; 3300 RewriteByRefString(TypeString, Name, (*I)); 3301 TypeString += " *"; 3302 Name = TypeString + Name; 3303 S += Name + " = __cself->" + (*I)->getNameAsString() + "; // bound by ref\n"; 3304 } 3305 // Next, emit a declaration for all "by copy" declarations. 3306 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(), 3307 E = BlockByCopyDecls.end(); I != E; ++I) { 3308 S += " "; 3309 // Handle nested closure invocation. For example: 3310 // 3311 // void (^myImportedClosure)(void); 3312 // myImportedClosure = ^(void) { setGlobalInt(x + y); }; 3313 // 3314 // void (^anotherClosure)(void); 3315 // anotherClosure = ^(void) { 3316 // myImportedClosure(); // import and invoke the closure 3317 // }; 3318 // 3319 if (isTopLevelBlockPointerType((*I)->getType())) { 3320 RewriteBlockPointerTypeVariable(S, (*I)); 3321 S += " = ("; 3322 RewriteBlockPointerType(S, (*I)->getType()); 3323 S += ")"; 3324 S += "__cself->" + (*I)->getNameAsString() + "; // bound by copy\n"; 3325 } 3326 else { 3327 std::string Name = (*I)->getNameAsString(); 3328 QualType QT = (*I)->getType(); 3329 if (HasLocalVariableExternalStorage(*I)) 3330 QT = Context->getPointerType(QT); 3331 QT.getAsStringInternal(Name, Context->getPrintingPolicy()); 3332 S += Name + " = __cself->" + 3333 (*I)->getNameAsString() + "; // bound by copy\n"; 3334 } 3335 } 3336 std::string RewrittenStr = RewrittenBlockExprs[CE]; 3337 const char *cstr = RewrittenStr.c_str(); 3338 while (*cstr++ != '{') ; 3339 S += cstr; 3340 S += "\n"; 3341 return S; 3342 } 3343 3344 std::string RewriteObjC::SynthesizeBlockHelperFuncs(BlockExpr *CE, int i, 3345 StringRef funcName, 3346 std::string Tag) { 3347 std::string StructRef = "struct " + Tag; 3348 std::string S = "static void __"; 3349 3350 S += funcName; 3351 S += "_block_copy_" + utostr(i); 3352 S += "(" + StructRef; 3353 S += "*dst, " + StructRef; 3354 S += "*src) {"; 3355 for (ValueDecl *VD : ImportedBlockDecls) { 3356 S += "_Block_object_assign((void*)&dst->"; 3357 S += VD->getNameAsString(); 3358 S += ", (void*)src->"; 3359 S += VD->getNameAsString(); 3360 if (BlockByRefDeclsPtrSet.count(VD)) 3361 S += ", " + utostr(BLOCK_FIELD_IS_BYREF) + "/*BLOCK_FIELD_IS_BYREF*/);"; 3362 else if (VD->getType()->isBlockPointerType()) 3363 S += ", " + utostr(BLOCK_FIELD_IS_BLOCK) + "/*BLOCK_FIELD_IS_BLOCK*/);"; 3364 else 3365 S += ", " + utostr(BLOCK_FIELD_IS_OBJECT) + "/*BLOCK_FIELD_IS_OBJECT*/);"; 3366 } 3367 S += "}\n"; 3368 3369 S += "\nstatic void __"; 3370 S += funcName; 3371 S += "_block_dispose_" + utostr(i); 3372 S += "(" + StructRef; 3373 S += "*src) {"; 3374 for (ValueDecl *VD : ImportedBlockDecls) { 3375 S += "_Block_object_dispose((void*)src->"; 3376 S += VD->getNameAsString(); 3377 if (BlockByRefDeclsPtrSet.count(VD)) 3378 S += ", " + utostr(BLOCK_FIELD_IS_BYREF) + "/*BLOCK_FIELD_IS_BYREF*/);"; 3379 else if (VD->getType()->isBlockPointerType()) 3380 S += ", " + utostr(BLOCK_FIELD_IS_BLOCK) + "/*BLOCK_FIELD_IS_BLOCK*/);"; 3381 else 3382 S += ", " + utostr(BLOCK_FIELD_IS_OBJECT) + "/*BLOCK_FIELD_IS_OBJECT*/);"; 3383 } 3384 S += "}\n"; 3385 return S; 3386 } 3387 3388 std::string RewriteObjC::SynthesizeBlockImpl(BlockExpr *CE, std::string Tag, 3389 std::string Desc) { 3390 std::string S = "\nstruct " + Tag; 3391 std::string Constructor = " " + Tag; 3392 3393 S += " {\n struct __block_impl impl;\n"; 3394 S += " struct " + Desc; 3395 S += "* Desc;\n"; 3396 3397 Constructor += "(void *fp, "; // Invoke function pointer. 3398 Constructor += "struct " + Desc; // Descriptor pointer. 3399 Constructor += " *desc"; 3400 3401 if (BlockDeclRefs.size()) { 3402 // Output all "by copy" declarations. 3403 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(), 3404 E = BlockByCopyDecls.end(); I != E; ++I) { 3405 S += " "; 3406 std::string FieldName = (*I)->getNameAsString(); 3407 std::string ArgName = "_" + FieldName; 3408 // Handle nested closure invocation. For example: 3409 // 3410 // void (^myImportedBlock)(void); 3411 // myImportedBlock = ^(void) { setGlobalInt(x + y); }; 3412 // 3413 // void (^anotherBlock)(void); 3414 // anotherBlock = ^(void) { 3415 // myImportedBlock(); // import and invoke the closure 3416 // }; 3417 // 3418 if (isTopLevelBlockPointerType((*I)->getType())) { 3419 S += "struct __block_impl *"; 3420 Constructor += ", void *" + ArgName; 3421 } else { 3422 QualType QT = (*I)->getType(); 3423 if (HasLocalVariableExternalStorage(*I)) 3424 QT = Context->getPointerType(QT); 3425 QT.getAsStringInternal(FieldName, Context->getPrintingPolicy()); 3426 QT.getAsStringInternal(ArgName, Context->getPrintingPolicy()); 3427 Constructor += ", " + ArgName; 3428 } 3429 S += FieldName + ";\n"; 3430 } 3431 // Output all "by ref" declarations. 3432 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(), 3433 E = BlockByRefDecls.end(); I != E; ++I) { 3434 S += " "; 3435 std::string FieldName = (*I)->getNameAsString(); 3436 std::string ArgName = "_" + FieldName; 3437 { 3438 std::string TypeString; 3439 RewriteByRefString(TypeString, FieldName, (*I)); 3440 TypeString += " *"; 3441 FieldName = TypeString + FieldName; 3442 ArgName = TypeString + ArgName; 3443 Constructor += ", " + ArgName; 3444 } 3445 S += FieldName + "; // by ref\n"; 3446 } 3447 // Finish writing the constructor. 3448 Constructor += ", int flags=0)"; 3449 // Initialize all "by copy" arguments. 3450 bool firsTime = true; 3451 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(), 3452 E = BlockByCopyDecls.end(); I != E; ++I) { 3453 std::string Name = (*I)->getNameAsString(); 3454 if (firsTime) { 3455 Constructor += " : "; 3456 firsTime = false; 3457 } 3458 else 3459 Constructor += ", "; 3460 if (isTopLevelBlockPointerType((*I)->getType())) 3461 Constructor += Name + "((struct __block_impl *)_" + Name + ")"; 3462 else 3463 Constructor += Name + "(_" + Name + ")"; 3464 } 3465 // Initialize all "by ref" arguments. 3466 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(), 3467 E = BlockByRefDecls.end(); I != E; ++I) { 3468 std::string Name = (*I)->getNameAsString(); 3469 if (firsTime) { 3470 Constructor += " : "; 3471 firsTime = false; 3472 } 3473 else 3474 Constructor += ", "; 3475 Constructor += Name + "(_" + Name + "->__forwarding)"; 3476 } 3477 3478 Constructor += " {\n"; 3479 if (GlobalVarDecl) 3480 Constructor += " impl.isa = &_NSConcreteGlobalBlock;\n"; 3481 else 3482 Constructor += " impl.isa = &_NSConcreteStackBlock;\n"; 3483 Constructor += " impl.Flags = flags;\n impl.FuncPtr = fp;\n"; 3484 3485 Constructor += " Desc = desc;\n"; 3486 } else { 3487 // Finish writing the constructor. 3488 Constructor += ", int flags=0) {\n"; 3489 if (GlobalVarDecl) 3490 Constructor += " impl.isa = &_NSConcreteGlobalBlock;\n"; 3491 else 3492 Constructor += " impl.isa = &_NSConcreteStackBlock;\n"; 3493 Constructor += " impl.Flags = flags;\n impl.FuncPtr = fp;\n"; 3494 Constructor += " Desc = desc;\n"; 3495 } 3496 Constructor += " "; 3497 Constructor += "}\n"; 3498 S += Constructor; 3499 S += "};\n"; 3500 return S; 3501 } 3502 3503 std::string RewriteObjC::SynthesizeBlockDescriptor(std::string DescTag, 3504 std::string ImplTag, int i, 3505 StringRef FunName, 3506 unsigned hasCopy) { 3507 std::string S = "\nstatic struct " + DescTag; 3508 3509 S += " {\n unsigned long reserved;\n"; 3510 S += " unsigned long Block_size;\n"; 3511 if (hasCopy) { 3512 S += " void (*copy)(struct "; 3513 S += ImplTag; S += "*, struct "; 3514 S += ImplTag; S += "*);\n"; 3515 3516 S += " void (*dispose)(struct "; 3517 S += ImplTag; S += "*);\n"; 3518 } 3519 S += "} "; 3520 3521 S += DescTag + "_DATA = { 0, sizeof(struct "; 3522 S += ImplTag + ")"; 3523 if (hasCopy) { 3524 S += ", __" + FunName.str() + "_block_copy_" + utostr(i); 3525 S += ", __" + FunName.str() + "_block_dispose_" + utostr(i); 3526 } 3527 S += "};\n"; 3528 return S; 3529 } 3530 3531 void RewriteObjC::SynthesizeBlockLiterals(SourceLocation FunLocStart, 3532 StringRef FunName) { 3533 // Insert declaration for the function in which block literal is used. 3534 if (CurFunctionDeclToDeclareForBlock && !Blocks.empty()) 3535 RewriteBlockLiteralFunctionDecl(CurFunctionDeclToDeclareForBlock); 3536 bool RewriteSC = (GlobalVarDecl && 3537 !Blocks.empty() && 3538 GlobalVarDecl->getStorageClass() == SC_Static && 3539 GlobalVarDecl->getType().getCVRQualifiers()); 3540 if (RewriteSC) { 3541 std::string SC(" void __"); 3542 SC += GlobalVarDecl->getNameAsString(); 3543 SC += "() {}"; 3544 InsertText(FunLocStart, SC); 3545 } 3546 3547 // Insert closures that were part of the function. 3548 for (unsigned i = 0, count=0; i < Blocks.size(); i++) { 3549 CollectBlockDeclRefInfo(Blocks[i]); 3550 // Need to copy-in the inner copied-in variables not actually used in this 3551 // block. 3552 for (int j = 0; j < InnerDeclRefsCount[i]; j++) { 3553 DeclRefExpr *Exp = InnerDeclRefs[count++]; 3554 ValueDecl *VD = Exp->getDecl(); 3555 BlockDeclRefs.push_back(Exp); 3556 if (!VD->hasAttr<BlocksAttr>() && !BlockByCopyDeclsPtrSet.count(VD)) { 3557 BlockByCopyDeclsPtrSet.insert(VD); 3558 BlockByCopyDecls.push_back(VD); 3559 } 3560 if (VD->hasAttr<BlocksAttr>() && !BlockByRefDeclsPtrSet.count(VD)) { 3561 BlockByRefDeclsPtrSet.insert(VD); 3562 BlockByRefDecls.push_back(VD); 3563 } 3564 // imported objects in the inner blocks not used in the outer 3565 // blocks must be copied/disposed in the outer block as well. 3566 if (VD->hasAttr<BlocksAttr>() || 3567 VD->getType()->isObjCObjectPointerType() || 3568 VD->getType()->isBlockPointerType()) 3569 ImportedBlockDecls.insert(VD); 3570 } 3571 3572 std::string ImplTag = "__" + FunName.str() + "_block_impl_" + utostr(i); 3573 std::string DescTag = "__" + FunName.str() + "_block_desc_" + utostr(i); 3574 3575 std::string CI = SynthesizeBlockImpl(Blocks[i], ImplTag, DescTag); 3576 3577 InsertText(FunLocStart, CI); 3578 3579 std::string CF = SynthesizeBlockFunc(Blocks[i], i, FunName, ImplTag); 3580 3581 InsertText(FunLocStart, CF); 3582 3583 if (ImportedBlockDecls.size()) { 3584 std::string HF = SynthesizeBlockHelperFuncs(Blocks[i], i, FunName, ImplTag); 3585 InsertText(FunLocStart, HF); 3586 } 3587 std::string BD = SynthesizeBlockDescriptor(DescTag, ImplTag, i, FunName, 3588 ImportedBlockDecls.size() > 0); 3589 InsertText(FunLocStart, BD); 3590 3591 BlockDeclRefs.clear(); 3592 BlockByRefDecls.clear(); 3593 BlockByRefDeclsPtrSet.clear(); 3594 BlockByCopyDecls.clear(); 3595 BlockByCopyDeclsPtrSet.clear(); 3596 ImportedBlockDecls.clear(); 3597 } 3598 if (RewriteSC) { 3599 // Must insert any 'const/volatile/static here. Since it has been 3600 // removed as result of rewriting of block literals. 3601 std::string SC; 3602 if (GlobalVarDecl->getStorageClass() == SC_Static) 3603 SC = "static "; 3604 if (GlobalVarDecl->getType().isConstQualified()) 3605 SC += "const "; 3606 if (GlobalVarDecl->getType().isVolatileQualified()) 3607 SC += "volatile "; 3608 if (GlobalVarDecl->getType().isRestrictQualified()) 3609 SC += "restrict "; 3610 InsertText(FunLocStart, SC); 3611 } 3612 3613 Blocks.clear(); 3614 InnerDeclRefsCount.clear(); 3615 InnerDeclRefs.clear(); 3616 RewrittenBlockExprs.clear(); 3617 } 3618 3619 void RewriteObjC::InsertBlockLiteralsWithinFunction(FunctionDecl *FD) { 3620 SourceLocation FunLocStart = FD->getTypeSpecStartLoc(); 3621 StringRef FuncName = FD->getName(); 3622 3623 SynthesizeBlockLiterals(FunLocStart, FuncName); 3624 } 3625 3626 static void BuildUniqueMethodName(std::string &Name, 3627 ObjCMethodDecl *MD) { 3628 ObjCInterfaceDecl *IFace = MD->getClassInterface(); 3629 Name = IFace->getName(); 3630 Name += "__" + MD->getSelector().getAsString(); 3631 // Convert colons to underscores. 3632 std::string::size_type loc = 0; 3633 while ((loc = Name.find(':', loc)) != std::string::npos) 3634 Name.replace(loc, 1, "_"); 3635 } 3636 3637 void RewriteObjC::InsertBlockLiteralsWithinMethod(ObjCMethodDecl *MD) { 3638 // fprintf(stderr,"In InsertBlockLiteralsWitinMethod\n"); 3639 // SourceLocation FunLocStart = MD->getBeginLoc(); 3640 SourceLocation FunLocStart = MD->getBeginLoc(); 3641 std::string FuncName; 3642 BuildUniqueMethodName(FuncName, MD); 3643 SynthesizeBlockLiterals(FunLocStart, FuncName); 3644 } 3645 3646 void RewriteObjC::GetBlockDeclRefExprs(Stmt *S) { 3647 for (Stmt *SubStmt : S->children()) 3648 if (SubStmt) { 3649 if (BlockExpr *CBE = dyn_cast<BlockExpr>(SubStmt)) 3650 GetBlockDeclRefExprs(CBE->getBody()); 3651 else 3652 GetBlockDeclRefExprs(SubStmt); 3653 } 3654 // Handle specific things. 3655 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) 3656 if (DRE->refersToEnclosingVariableOrCapture() || 3657 HasLocalVariableExternalStorage(DRE->getDecl())) 3658 // FIXME: Handle enums. 3659 BlockDeclRefs.push_back(DRE); 3660 } 3661 3662 void RewriteObjC::GetInnerBlockDeclRefExprs(Stmt *S, 3663 SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs, 3664 llvm::SmallPtrSetImpl<const DeclContext *> &InnerContexts) { 3665 for (Stmt *SubStmt : S->children()) 3666 if (SubStmt) { 3667 if (BlockExpr *CBE = dyn_cast<BlockExpr>(SubStmt)) { 3668 InnerContexts.insert(cast<DeclContext>(CBE->getBlockDecl())); 3669 GetInnerBlockDeclRefExprs(CBE->getBody(), 3670 InnerBlockDeclRefs, 3671 InnerContexts); 3672 } 3673 else 3674 GetInnerBlockDeclRefExprs(SubStmt, InnerBlockDeclRefs, InnerContexts); 3675 } 3676 // Handle specific things. 3677 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) { 3678 if (DRE->refersToEnclosingVariableOrCapture() || 3679 HasLocalVariableExternalStorage(DRE->getDecl())) { 3680 if (!InnerContexts.count(DRE->getDecl()->getDeclContext())) 3681 InnerBlockDeclRefs.push_back(DRE); 3682 if (VarDecl *Var = cast<VarDecl>(DRE->getDecl())) 3683 if (Var->isFunctionOrMethodVarDecl()) 3684 ImportedLocalExternalDecls.insert(Var); 3685 } 3686 } 3687 } 3688 3689 /// convertFunctionTypeOfBlocks - This routine converts a function type 3690 /// whose result type may be a block pointer or whose argument type(s) 3691 /// might be block pointers to an equivalent function type replacing 3692 /// all block pointers to function pointers. 3693 QualType RewriteObjC::convertFunctionTypeOfBlocks(const FunctionType *FT) { 3694 const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(FT); 3695 // FTP will be null for closures that don't take arguments. 3696 // Generate a funky cast. 3697 SmallVector<QualType, 8> ArgTypes; 3698 QualType Res = FT->getReturnType(); 3699 bool HasBlockType = convertBlockPointerToFunctionPointer(Res); 3700 3701 if (FTP) { 3702 for (auto &I : FTP->param_types()) { 3703 QualType t = I; 3704 // Make sure we convert "t (^)(...)" to "t (*)(...)". 3705 if (convertBlockPointerToFunctionPointer(t)) 3706 HasBlockType = true; 3707 ArgTypes.push_back(t); 3708 } 3709 } 3710 QualType FuncType; 3711 // FIXME. Does this work if block takes no argument but has a return type 3712 // which is of block type? 3713 if (HasBlockType) 3714 FuncType = getSimpleFunctionType(Res, ArgTypes); 3715 else FuncType = QualType(FT, 0); 3716 return FuncType; 3717 } 3718 3719 Stmt *RewriteObjC::SynthesizeBlockCall(CallExpr *Exp, const Expr *BlockExp) { 3720 // Navigate to relevant type information. 3721 const BlockPointerType *CPT = nullptr; 3722 3723 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(BlockExp)) { 3724 CPT = DRE->getType()->getAs<BlockPointerType>(); 3725 } else if (const MemberExpr *MExpr = dyn_cast<MemberExpr>(BlockExp)) { 3726 CPT = MExpr->getType()->getAs<BlockPointerType>(); 3727 } 3728 else if (const ParenExpr *PRE = dyn_cast<ParenExpr>(BlockExp)) { 3729 return SynthesizeBlockCall(Exp, PRE->getSubExpr()); 3730 } 3731 else if (const ImplicitCastExpr *IEXPR = dyn_cast<ImplicitCastExpr>(BlockExp)) 3732 CPT = IEXPR->getType()->getAs<BlockPointerType>(); 3733 else if (const ConditionalOperator *CEXPR = 3734 dyn_cast<ConditionalOperator>(BlockExp)) { 3735 Expr *LHSExp = CEXPR->getLHS(); 3736 Stmt *LHSStmt = SynthesizeBlockCall(Exp, LHSExp); 3737 Expr *RHSExp = CEXPR->getRHS(); 3738 Stmt *RHSStmt = SynthesizeBlockCall(Exp, RHSExp); 3739 Expr *CONDExp = CEXPR->getCond(); 3740 ConditionalOperator *CondExpr = 3741 new (Context) ConditionalOperator(CONDExp, 3742 SourceLocation(), cast<Expr>(LHSStmt), 3743 SourceLocation(), cast<Expr>(RHSStmt), 3744 Exp->getType(), VK_RValue, OK_Ordinary); 3745 return CondExpr; 3746 } else if (const ObjCIvarRefExpr *IRE = dyn_cast<ObjCIvarRefExpr>(BlockExp)) { 3747 CPT = IRE->getType()->getAs<BlockPointerType>(); 3748 } else if (const PseudoObjectExpr *POE 3749 = dyn_cast<PseudoObjectExpr>(BlockExp)) { 3750 CPT = POE->getType()->castAs<BlockPointerType>(); 3751 } else { 3752 assert(false && "RewriteBlockClass: Bad type"); 3753 } 3754 assert(CPT && "RewriteBlockClass: Bad type"); 3755 const FunctionType *FT = CPT->getPointeeType()->getAs<FunctionType>(); 3756 assert(FT && "RewriteBlockClass: Bad type"); 3757 const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(FT); 3758 // FTP will be null for closures that don't take arguments. 3759 3760 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 3761 SourceLocation(), SourceLocation(), 3762 &Context->Idents.get("__block_impl")); 3763 QualType PtrBlock = Context->getPointerType(Context->getTagDeclType(RD)); 3764 3765 // Generate a funky cast. 3766 SmallVector<QualType, 8> ArgTypes; 3767 3768 // Push the block argument type. 3769 ArgTypes.push_back(PtrBlock); 3770 if (FTP) { 3771 for (auto &I : FTP->param_types()) { 3772 QualType t = I; 3773 // Make sure we convert "t (^)(...)" to "t (*)(...)". 3774 if (!convertBlockPointerToFunctionPointer(t)) 3775 convertToUnqualifiedObjCType(t); 3776 ArgTypes.push_back(t); 3777 } 3778 } 3779 // Now do the pointer to function cast. 3780 QualType PtrToFuncCastType = getSimpleFunctionType(Exp->getType(), ArgTypes); 3781 3782 PtrToFuncCastType = Context->getPointerType(PtrToFuncCastType); 3783 3784 CastExpr *BlkCast = NoTypeInfoCStyleCastExpr(Context, PtrBlock, 3785 CK_BitCast, 3786 const_cast<Expr*>(BlockExp)); 3787 // Don't forget the parens to enforce the proper binding. 3788 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), 3789 BlkCast); 3790 //PE->dump(); 3791 3792 FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 3793 SourceLocation(), 3794 &Context->Idents.get("FuncPtr"), 3795 Context->VoidPtrTy, nullptr, 3796 /*BitWidth=*/nullptr, /*Mutable=*/true, 3797 ICIS_NoInit); 3798 MemberExpr *ME = 3799 new (Context) MemberExpr(PE, true, SourceLocation(), FD, SourceLocation(), 3800 FD->getType(), VK_LValue, OK_Ordinary); 3801 3802 CastExpr *FunkCast = NoTypeInfoCStyleCastExpr(Context, PtrToFuncCastType, 3803 CK_BitCast, ME); 3804 PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), FunkCast); 3805 3806 SmallVector<Expr*, 8> BlkExprs; 3807 // Add the implicit argument. 3808 BlkExprs.push_back(BlkCast); 3809 // Add the user arguments. 3810 for (CallExpr::arg_iterator I = Exp->arg_begin(), 3811 E = Exp->arg_end(); I != E; ++I) { 3812 BlkExprs.push_back(*I); 3813 } 3814 CallExpr *CE = new (Context) CallExpr(*Context, PE, BlkExprs, 3815 Exp->getType(), VK_RValue, 3816 SourceLocation()); 3817 return CE; 3818 } 3819 3820 // We need to return the rewritten expression to handle cases where the 3821 // BlockDeclRefExpr is embedded in another expression being rewritten. 3822 // For example: 3823 // 3824 // int main() { 3825 // __block Foo *f; 3826 // __block int i; 3827 // 3828 // void (^myblock)() = ^() { 3829 // [f test]; // f is a BlockDeclRefExpr embedded in a message (which is being rewritten). 3830 // i = 77; 3831 // }; 3832 //} 3833 Stmt *RewriteObjC::RewriteBlockDeclRefExpr(DeclRefExpr *DeclRefExp) { 3834 // Rewrite the byref variable into BYREFVAR->__forwarding->BYREFVAR 3835 // for each DeclRefExp where BYREFVAR is name of the variable. 3836 ValueDecl *VD = DeclRefExp->getDecl(); 3837 bool isArrow = DeclRefExp->refersToEnclosingVariableOrCapture() || 3838 HasLocalVariableExternalStorage(DeclRefExp->getDecl()); 3839 3840 FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 3841 SourceLocation(), 3842 &Context->Idents.get("__forwarding"), 3843 Context->VoidPtrTy, nullptr, 3844 /*BitWidth=*/nullptr, /*Mutable=*/true, 3845 ICIS_NoInit); 3846 MemberExpr *ME = new (Context) 3847 MemberExpr(DeclRefExp, isArrow, SourceLocation(), FD, SourceLocation(), 3848 FD->getType(), VK_LValue, OK_Ordinary); 3849 3850 StringRef Name = VD->getName(); 3851 FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), SourceLocation(), 3852 &Context->Idents.get(Name), 3853 Context->VoidPtrTy, nullptr, 3854 /*BitWidth=*/nullptr, /*Mutable=*/true, 3855 ICIS_NoInit); 3856 ME = 3857 new (Context) MemberExpr(ME, true, SourceLocation(), FD, SourceLocation(), 3858 DeclRefExp->getType(), VK_LValue, OK_Ordinary); 3859 3860 // Need parens to enforce precedence. 3861 ParenExpr *PE = new (Context) ParenExpr(DeclRefExp->getExprLoc(), 3862 DeclRefExp->getExprLoc(), 3863 ME); 3864 ReplaceStmt(DeclRefExp, PE); 3865 return PE; 3866 } 3867 3868 // Rewrites the imported local variable V with external storage 3869 // (static, extern, etc.) as *V 3870 // 3871 Stmt *RewriteObjC::RewriteLocalVariableExternalStorage(DeclRefExpr *DRE) { 3872 ValueDecl *VD = DRE->getDecl(); 3873 if (VarDecl *Var = dyn_cast<VarDecl>(VD)) 3874 if (!ImportedLocalExternalDecls.count(Var)) 3875 return DRE; 3876 Expr *Exp = new (Context) UnaryOperator(DRE, UO_Deref, DRE->getType(), 3877 VK_LValue, OK_Ordinary, 3878 DRE->getLocation(), false); 3879 // Need parens to enforce precedence. 3880 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), 3881 Exp); 3882 ReplaceStmt(DRE, PE); 3883 return PE; 3884 } 3885 3886 void RewriteObjC::RewriteCastExpr(CStyleCastExpr *CE) { 3887 SourceLocation LocStart = CE->getLParenLoc(); 3888 SourceLocation LocEnd = CE->getRParenLoc(); 3889 3890 // Need to avoid trying to rewrite synthesized casts. 3891 if (LocStart.isInvalid()) 3892 return; 3893 // Need to avoid trying to rewrite casts contained in macros. 3894 if (!Rewriter::isRewritable(LocStart) || !Rewriter::isRewritable(LocEnd)) 3895 return; 3896 3897 const char *startBuf = SM->getCharacterData(LocStart); 3898 const char *endBuf = SM->getCharacterData(LocEnd); 3899 QualType QT = CE->getType(); 3900 const Type* TypePtr = QT->getAs<Type>(); 3901 if (isa<TypeOfExprType>(TypePtr)) { 3902 const TypeOfExprType *TypeOfExprTypePtr = cast<TypeOfExprType>(TypePtr); 3903 QT = TypeOfExprTypePtr->getUnderlyingExpr()->getType(); 3904 std::string TypeAsString = "("; 3905 RewriteBlockPointerType(TypeAsString, QT); 3906 TypeAsString += ")"; 3907 ReplaceText(LocStart, endBuf-startBuf+1, TypeAsString); 3908 return; 3909 } 3910 // advance the location to startArgList. 3911 const char *argPtr = startBuf; 3912 3913 while (*argPtr++ && (argPtr < endBuf)) { 3914 switch (*argPtr) { 3915 case '^': 3916 // Replace the '^' with '*'. 3917 LocStart = LocStart.getLocWithOffset(argPtr-startBuf); 3918 ReplaceText(LocStart, 1, "*"); 3919 break; 3920 } 3921 } 3922 } 3923 3924 void RewriteObjC::RewriteBlockPointerFunctionArgs(FunctionDecl *FD) { 3925 SourceLocation DeclLoc = FD->getLocation(); 3926 unsigned parenCount = 0; 3927 3928 // We have 1 or more arguments that have closure pointers. 3929 const char *startBuf = SM->getCharacterData(DeclLoc); 3930 const char *startArgList = strchr(startBuf, '('); 3931 3932 assert((*startArgList == '(') && "Rewriter fuzzy parser confused"); 3933 3934 parenCount++; 3935 // advance the location to startArgList. 3936 DeclLoc = DeclLoc.getLocWithOffset(startArgList-startBuf); 3937 assert((DeclLoc.isValid()) && "Invalid DeclLoc"); 3938 3939 const char *argPtr = startArgList; 3940 3941 while (*argPtr++ && parenCount) { 3942 switch (*argPtr) { 3943 case '^': 3944 // Replace the '^' with '*'. 3945 DeclLoc = DeclLoc.getLocWithOffset(argPtr-startArgList); 3946 ReplaceText(DeclLoc, 1, "*"); 3947 break; 3948 case '(': 3949 parenCount++; 3950 break; 3951 case ')': 3952 parenCount--; 3953 break; 3954 } 3955 } 3956 } 3957 3958 bool RewriteObjC::PointerTypeTakesAnyBlockArguments(QualType QT) { 3959 const FunctionProtoType *FTP; 3960 const PointerType *PT = QT->getAs<PointerType>(); 3961 if (PT) { 3962 FTP = PT->getPointeeType()->getAs<FunctionProtoType>(); 3963 } else { 3964 const BlockPointerType *BPT = QT->getAs<BlockPointerType>(); 3965 assert(BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type"); 3966 FTP = BPT->getPointeeType()->getAs<FunctionProtoType>(); 3967 } 3968 if (FTP) { 3969 for (const auto &I : FTP->param_types()) 3970 if (isTopLevelBlockPointerType(I)) 3971 return true; 3972 } 3973 return false; 3974 } 3975 3976 bool RewriteObjC::PointerTypeTakesAnyObjCQualifiedType(QualType QT) { 3977 const FunctionProtoType *FTP; 3978 const PointerType *PT = QT->getAs<PointerType>(); 3979 if (PT) { 3980 FTP = PT->getPointeeType()->getAs<FunctionProtoType>(); 3981 } else { 3982 const BlockPointerType *BPT = QT->getAs<BlockPointerType>(); 3983 assert(BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type"); 3984 FTP = BPT->getPointeeType()->getAs<FunctionProtoType>(); 3985 } 3986 if (FTP) { 3987 for (const auto &I : FTP->param_types()) { 3988 if (I->isObjCQualifiedIdType()) 3989 return true; 3990 if (I->isObjCObjectPointerType() && 3991 I->getPointeeType()->isObjCQualifiedInterfaceType()) 3992 return true; 3993 } 3994 3995 } 3996 return false; 3997 } 3998 3999 void RewriteObjC::GetExtentOfArgList(const char *Name, const char *&LParen, 4000 const char *&RParen) { 4001 const char *argPtr = strchr(Name, '('); 4002 assert((*argPtr == '(') && "Rewriter fuzzy parser confused"); 4003 4004 LParen = argPtr; // output the start. 4005 argPtr++; // skip past the left paren. 4006 unsigned parenCount = 1; 4007 4008 while (*argPtr && parenCount) { 4009 switch (*argPtr) { 4010 case '(': parenCount++; break; 4011 case ')': parenCount--; break; 4012 default: break; 4013 } 4014 if (parenCount) argPtr++; 4015 } 4016 assert((*argPtr == ')') && "Rewriter fuzzy parser confused"); 4017 RParen = argPtr; // output the end 4018 } 4019 4020 void RewriteObjC::RewriteBlockPointerDecl(NamedDecl *ND) { 4021 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) { 4022 RewriteBlockPointerFunctionArgs(FD); 4023 return; 4024 } 4025 // Handle Variables and Typedefs. 4026 SourceLocation DeclLoc = ND->getLocation(); 4027 QualType DeclT; 4028 if (VarDecl *VD = dyn_cast<VarDecl>(ND)) 4029 DeclT = VD->getType(); 4030 else if (TypedefNameDecl *TDD = dyn_cast<TypedefNameDecl>(ND)) 4031 DeclT = TDD->getUnderlyingType(); 4032 else if (FieldDecl *FD = dyn_cast<FieldDecl>(ND)) 4033 DeclT = FD->getType(); 4034 else 4035 llvm_unreachable("RewriteBlockPointerDecl(): Decl type not yet handled"); 4036 4037 const char *startBuf = SM->getCharacterData(DeclLoc); 4038 const char *endBuf = startBuf; 4039 // scan backward (from the decl location) for the end of the previous decl. 4040 while (*startBuf != '^' && *startBuf != ';' && startBuf != MainFileStart) 4041 startBuf--; 4042 SourceLocation Start = DeclLoc.getLocWithOffset(startBuf-endBuf); 4043 std::string buf; 4044 unsigned OrigLength=0; 4045 // *startBuf != '^' if we are dealing with a pointer to function that 4046 // may take block argument types (which will be handled below). 4047 if (*startBuf == '^') { 4048 // Replace the '^' with '*', computing a negative offset. 4049 buf = '*'; 4050 startBuf++; 4051 OrigLength++; 4052 } 4053 while (*startBuf != ')') { 4054 buf += *startBuf; 4055 startBuf++; 4056 OrigLength++; 4057 } 4058 buf += ')'; 4059 OrigLength++; 4060 4061 if (PointerTypeTakesAnyBlockArguments(DeclT) || 4062 PointerTypeTakesAnyObjCQualifiedType(DeclT)) { 4063 // Replace the '^' with '*' for arguments. 4064 // Replace id<P> with id/*<>*/ 4065 DeclLoc = ND->getLocation(); 4066 startBuf = SM->getCharacterData(DeclLoc); 4067 const char *argListBegin, *argListEnd; 4068 GetExtentOfArgList(startBuf, argListBegin, argListEnd); 4069 while (argListBegin < argListEnd) { 4070 if (*argListBegin == '^') 4071 buf += '*'; 4072 else if (*argListBegin == '<') { 4073 buf += "/*"; 4074 buf += *argListBegin++; 4075 OrigLength++; 4076 while (*argListBegin != '>') { 4077 buf += *argListBegin++; 4078 OrigLength++; 4079 } 4080 buf += *argListBegin; 4081 buf += "*/"; 4082 } 4083 else 4084 buf += *argListBegin; 4085 argListBegin++; 4086 OrigLength++; 4087 } 4088 buf += ')'; 4089 OrigLength++; 4090 } 4091 ReplaceText(Start, OrigLength, buf); 4092 } 4093 4094 /// SynthesizeByrefCopyDestroyHelper - This routine synthesizes: 4095 /// void __Block_byref_id_object_copy(struct Block_byref_id_object *dst, 4096 /// struct Block_byref_id_object *src) { 4097 /// _Block_object_assign (&_dest->object, _src->object, 4098 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_OBJECT 4099 /// [|BLOCK_FIELD_IS_WEAK]) // object 4100 /// _Block_object_assign(&_dest->object, _src->object, 4101 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_BLOCK 4102 /// [|BLOCK_FIELD_IS_WEAK]) // block 4103 /// } 4104 /// And: 4105 /// void __Block_byref_id_object_dispose(struct Block_byref_id_object *_src) { 4106 /// _Block_object_dispose(_src->object, 4107 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_OBJECT 4108 /// [|BLOCK_FIELD_IS_WEAK]) // object 4109 /// _Block_object_dispose(_src->object, 4110 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_BLOCK 4111 /// [|BLOCK_FIELD_IS_WEAK]) // block 4112 /// } 4113 4114 std::string RewriteObjC::SynthesizeByrefCopyDestroyHelper(VarDecl *VD, 4115 int flag) { 4116 std::string S; 4117 if (CopyDestroyCache.count(flag)) 4118 return S; 4119 CopyDestroyCache.insert(flag); 4120 S = "static void __Block_byref_id_object_copy_"; 4121 S += utostr(flag); 4122 S += "(void *dst, void *src) {\n"; 4123 4124 // offset into the object pointer is computed as: 4125 // void * + void* + int + int + void* + void * 4126 unsigned IntSize = 4127 static_cast<unsigned>(Context->getTypeSize(Context->IntTy)); 4128 unsigned VoidPtrSize = 4129 static_cast<unsigned>(Context->getTypeSize(Context->VoidPtrTy)); 4130 4131 unsigned offset = (VoidPtrSize*4 + IntSize + IntSize)/Context->getCharWidth(); 4132 S += " _Block_object_assign((char*)dst + "; 4133 S += utostr(offset); 4134 S += ", *(void * *) ((char*)src + "; 4135 S += utostr(offset); 4136 S += "), "; 4137 S += utostr(flag); 4138 S += ");\n}\n"; 4139 4140 S += "static void __Block_byref_id_object_dispose_"; 4141 S += utostr(flag); 4142 S += "(void *src) {\n"; 4143 S += " _Block_object_dispose(*(void * *) ((char*)src + "; 4144 S += utostr(offset); 4145 S += "), "; 4146 S += utostr(flag); 4147 S += ");\n}\n"; 4148 return S; 4149 } 4150 4151 /// RewriteByRefVar - For each __block typex ND variable this routine transforms 4152 /// the declaration into: 4153 /// struct __Block_byref_ND { 4154 /// void *__isa; // NULL for everything except __weak pointers 4155 /// struct __Block_byref_ND *__forwarding; 4156 /// int32_t __flags; 4157 /// int32_t __size; 4158 /// void *__Block_byref_id_object_copy; // If variable is __block ObjC object 4159 /// void *__Block_byref_id_object_dispose; // If variable is __block ObjC object 4160 /// typex ND; 4161 /// }; 4162 /// 4163 /// It then replaces declaration of ND variable with: 4164 /// struct __Block_byref_ND ND = {__isa=0B, __forwarding=&ND, __flags=some_flag, 4165 /// __size=sizeof(struct __Block_byref_ND), 4166 /// ND=initializer-if-any}; 4167 /// 4168 /// 4169 void RewriteObjC::RewriteByRefVar(VarDecl *ND) { 4170 // Insert declaration for the function in which block literal is 4171 // used. 4172 if (CurFunctionDeclToDeclareForBlock) 4173 RewriteBlockLiteralFunctionDecl(CurFunctionDeclToDeclareForBlock); 4174 int flag = 0; 4175 int isa = 0; 4176 SourceLocation DeclLoc = ND->getTypeSpecStartLoc(); 4177 if (DeclLoc.isInvalid()) 4178 // If type location is missing, it is because of missing type (a warning). 4179 // Use variable's location which is good for this case. 4180 DeclLoc = ND->getLocation(); 4181 const char *startBuf = SM->getCharacterData(DeclLoc); 4182 SourceLocation X = ND->getEndLoc(); 4183 X = SM->getExpansionLoc(X); 4184 const char *endBuf = SM->getCharacterData(X); 4185 std::string Name(ND->getNameAsString()); 4186 std::string ByrefType; 4187 RewriteByRefString(ByrefType, Name, ND, true); 4188 ByrefType += " {\n"; 4189 ByrefType += " void *__isa;\n"; 4190 RewriteByRefString(ByrefType, Name, ND); 4191 ByrefType += " *__forwarding;\n"; 4192 ByrefType += " int __flags;\n"; 4193 ByrefType += " int __size;\n"; 4194 // Add void *__Block_byref_id_object_copy; 4195 // void *__Block_byref_id_object_dispose; if needed. 4196 QualType Ty = ND->getType(); 4197 bool HasCopyAndDispose = Context->BlockRequiresCopying(Ty, ND); 4198 if (HasCopyAndDispose) { 4199 ByrefType += " void (*__Block_byref_id_object_copy)(void*, void*);\n"; 4200 ByrefType += " void (*__Block_byref_id_object_dispose)(void*);\n"; 4201 } 4202 4203 QualType T = Ty; 4204 (void)convertBlockPointerToFunctionPointer(T); 4205 T.getAsStringInternal(Name, Context->getPrintingPolicy()); 4206 4207 ByrefType += " " + Name + ";\n"; 4208 ByrefType += "};\n"; 4209 // Insert this type in global scope. It is needed by helper function. 4210 SourceLocation FunLocStart; 4211 if (CurFunctionDef) 4212 FunLocStart = CurFunctionDef->getTypeSpecStartLoc(); 4213 else { 4214 assert(CurMethodDef && "RewriteByRefVar - CurMethodDef is null"); 4215 FunLocStart = CurMethodDef->getBeginLoc(); 4216 } 4217 InsertText(FunLocStart, ByrefType); 4218 if (Ty.isObjCGCWeak()) { 4219 flag |= BLOCK_FIELD_IS_WEAK; 4220 isa = 1; 4221 } 4222 4223 if (HasCopyAndDispose) { 4224 flag = BLOCK_BYREF_CALLER; 4225 QualType Ty = ND->getType(); 4226 // FIXME. Handle __weak variable (BLOCK_FIELD_IS_WEAK) as well. 4227 if (Ty->isBlockPointerType()) 4228 flag |= BLOCK_FIELD_IS_BLOCK; 4229 else 4230 flag |= BLOCK_FIELD_IS_OBJECT; 4231 std::string HF = SynthesizeByrefCopyDestroyHelper(ND, flag); 4232 if (!HF.empty()) 4233 InsertText(FunLocStart, HF); 4234 } 4235 4236 // struct __Block_byref_ND ND = 4237 // {0, &ND, some_flag, __size=sizeof(struct __Block_byref_ND), 4238 // initializer-if-any}; 4239 bool hasInit = (ND->getInit() != nullptr); 4240 unsigned flags = 0; 4241 if (HasCopyAndDispose) 4242 flags |= BLOCK_HAS_COPY_DISPOSE; 4243 Name = ND->getNameAsString(); 4244 ByrefType.clear(); 4245 RewriteByRefString(ByrefType, Name, ND); 4246 std::string ForwardingCastType("("); 4247 ForwardingCastType += ByrefType + " *)"; 4248 if (!hasInit) { 4249 ByrefType += " " + Name + " = {(void*)"; 4250 ByrefType += utostr(isa); 4251 ByrefType += "," + ForwardingCastType + "&" + Name + ", "; 4252 ByrefType += utostr(flags); 4253 ByrefType += ", "; 4254 ByrefType += "sizeof("; 4255 RewriteByRefString(ByrefType, Name, ND); 4256 ByrefType += ")"; 4257 if (HasCopyAndDispose) { 4258 ByrefType += ", __Block_byref_id_object_copy_"; 4259 ByrefType += utostr(flag); 4260 ByrefType += ", __Block_byref_id_object_dispose_"; 4261 ByrefType += utostr(flag); 4262 } 4263 ByrefType += "};\n"; 4264 unsigned nameSize = Name.size(); 4265 // for block or function pointer declaration. Name is already 4266 // part of the declaration. 4267 if (Ty->isBlockPointerType() || Ty->isFunctionPointerType()) 4268 nameSize = 1; 4269 ReplaceText(DeclLoc, endBuf-startBuf+nameSize, ByrefType); 4270 } 4271 else { 4272 SourceLocation startLoc; 4273 Expr *E = ND->getInit(); 4274 if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E)) 4275 startLoc = ECE->getLParenLoc(); 4276 else 4277 startLoc = E->getBeginLoc(); 4278 startLoc = SM->getExpansionLoc(startLoc); 4279 endBuf = SM->getCharacterData(startLoc); 4280 ByrefType += " " + Name; 4281 ByrefType += " = {(void*)"; 4282 ByrefType += utostr(isa); 4283 ByrefType += "," + ForwardingCastType + "&" + Name + ", "; 4284 ByrefType += utostr(flags); 4285 ByrefType += ", "; 4286 ByrefType += "sizeof("; 4287 RewriteByRefString(ByrefType, Name, ND); 4288 ByrefType += "), "; 4289 if (HasCopyAndDispose) { 4290 ByrefType += "__Block_byref_id_object_copy_"; 4291 ByrefType += utostr(flag); 4292 ByrefType += ", __Block_byref_id_object_dispose_"; 4293 ByrefType += utostr(flag); 4294 ByrefType += ", "; 4295 } 4296 ReplaceText(DeclLoc, endBuf-startBuf, ByrefType); 4297 4298 // Complete the newly synthesized compound expression by inserting a right 4299 // curly brace before the end of the declaration. 4300 // FIXME: This approach avoids rewriting the initializer expression. It 4301 // also assumes there is only one declarator. For example, the following 4302 // isn't currently supported by this routine (in general): 4303 // 4304 // double __block BYREFVAR = 1.34, BYREFVAR2 = 1.37; 4305 // 4306 const char *startInitializerBuf = SM->getCharacterData(startLoc); 4307 const char *semiBuf = strchr(startInitializerBuf, ';'); 4308 assert((*semiBuf == ';') && "RewriteByRefVar: can't find ';'"); 4309 SourceLocation semiLoc = 4310 startLoc.getLocWithOffset(semiBuf-startInitializerBuf); 4311 4312 InsertText(semiLoc, "}"); 4313 } 4314 } 4315 4316 void RewriteObjC::CollectBlockDeclRefInfo(BlockExpr *Exp) { 4317 // Add initializers for any closure decl refs. 4318 GetBlockDeclRefExprs(Exp->getBody()); 4319 if (BlockDeclRefs.size()) { 4320 // Unique all "by copy" declarations. 4321 for (unsigned i = 0; i < BlockDeclRefs.size(); i++) 4322 if (!BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>()) { 4323 if (!BlockByCopyDeclsPtrSet.count(BlockDeclRefs[i]->getDecl())) { 4324 BlockByCopyDeclsPtrSet.insert(BlockDeclRefs[i]->getDecl()); 4325 BlockByCopyDecls.push_back(BlockDeclRefs[i]->getDecl()); 4326 } 4327 } 4328 // Unique all "by ref" declarations. 4329 for (unsigned i = 0; i < BlockDeclRefs.size(); i++) 4330 if (BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>()) { 4331 if (!BlockByRefDeclsPtrSet.count(BlockDeclRefs[i]->getDecl())) { 4332 BlockByRefDeclsPtrSet.insert(BlockDeclRefs[i]->getDecl()); 4333 BlockByRefDecls.push_back(BlockDeclRefs[i]->getDecl()); 4334 } 4335 } 4336 // Find any imported blocks...they will need special attention. 4337 for (unsigned i = 0; i < BlockDeclRefs.size(); i++) 4338 if (BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>() || 4339 BlockDeclRefs[i]->getType()->isObjCObjectPointerType() || 4340 BlockDeclRefs[i]->getType()->isBlockPointerType()) 4341 ImportedBlockDecls.insert(BlockDeclRefs[i]->getDecl()); 4342 } 4343 } 4344 4345 FunctionDecl *RewriteObjC::SynthBlockInitFunctionDecl(StringRef name) { 4346 IdentifierInfo *ID = &Context->Idents.get(name); 4347 QualType FType = Context->getFunctionNoProtoType(Context->VoidPtrTy); 4348 return FunctionDecl::Create(*Context, TUDecl, SourceLocation(), 4349 SourceLocation(), ID, FType, nullptr, SC_Extern, 4350 false, false); 4351 } 4352 4353 Stmt *RewriteObjC::SynthBlockInitExpr(BlockExpr *Exp, 4354 const SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs) { 4355 const BlockDecl *block = Exp->getBlockDecl(); 4356 Blocks.push_back(Exp); 4357 4358 CollectBlockDeclRefInfo(Exp); 4359 4360 // Add inner imported variables now used in current block. 4361 int countOfInnerDecls = 0; 4362 if (!InnerBlockDeclRefs.empty()) { 4363 for (unsigned i = 0; i < InnerBlockDeclRefs.size(); i++) { 4364 DeclRefExpr *Exp = InnerBlockDeclRefs[i]; 4365 ValueDecl *VD = Exp->getDecl(); 4366 if (!VD->hasAttr<BlocksAttr>() && !BlockByCopyDeclsPtrSet.count(VD)) { 4367 // We need to save the copied-in variables in nested 4368 // blocks because it is needed at the end for some of the API generations. 4369 // See SynthesizeBlockLiterals routine. 4370 InnerDeclRefs.push_back(Exp); countOfInnerDecls++; 4371 BlockDeclRefs.push_back(Exp); 4372 BlockByCopyDeclsPtrSet.insert(VD); 4373 BlockByCopyDecls.push_back(VD); 4374 } 4375 if (VD->hasAttr<BlocksAttr>() && !BlockByRefDeclsPtrSet.count(VD)) { 4376 InnerDeclRefs.push_back(Exp); countOfInnerDecls++; 4377 BlockDeclRefs.push_back(Exp); 4378 BlockByRefDeclsPtrSet.insert(VD); 4379 BlockByRefDecls.push_back(VD); 4380 } 4381 } 4382 // Find any imported blocks...they will need special attention. 4383 for (unsigned i = 0; i < InnerBlockDeclRefs.size(); i++) 4384 if (InnerBlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>() || 4385 InnerBlockDeclRefs[i]->getType()->isObjCObjectPointerType() || 4386 InnerBlockDeclRefs[i]->getType()->isBlockPointerType()) 4387 ImportedBlockDecls.insert(InnerBlockDeclRefs[i]->getDecl()); 4388 } 4389 InnerDeclRefsCount.push_back(countOfInnerDecls); 4390 4391 std::string FuncName; 4392 4393 if (CurFunctionDef) 4394 FuncName = CurFunctionDef->getNameAsString(); 4395 else if (CurMethodDef) 4396 BuildUniqueMethodName(FuncName, CurMethodDef); 4397 else if (GlobalVarDecl) 4398 FuncName = std::string(GlobalVarDecl->getNameAsString()); 4399 4400 std::string BlockNumber = utostr(Blocks.size()-1); 4401 4402 std::string Tag = "__" + FuncName + "_block_impl_" + BlockNumber; 4403 std::string Func = "__" + FuncName + "_block_func_" + BlockNumber; 4404 4405 // Get a pointer to the function type so we can cast appropriately. 4406 QualType BFT = convertFunctionTypeOfBlocks(Exp->getFunctionType()); 4407 QualType FType = Context->getPointerType(BFT); 4408 4409 FunctionDecl *FD; 4410 Expr *NewRep; 4411 4412 // Simulate a constructor call... 4413 FD = SynthBlockInitFunctionDecl(Tag); 4414 DeclRefExpr *DRE = new (Context) DeclRefExpr(FD, false, FType, VK_RValue, 4415 SourceLocation()); 4416 4417 SmallVector<Expr*, 4> InitExprs; 4418 4419 // Initialize the block function. 4420 FD = SynthBlockInitFunctionDecl(Func); 4421 DeclRefExpr *Arg = new (Context) DeclRefExpr(FD, false, FD->getType(), 4422 VK_LValue, SourceLocation()); 4423 CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, Context->VoidPtrTy, 4424 CK_BitCast, Arg); 4425 InitExprs.push_back(castExpr); 4426 4427 // Initialize the block descriptor. 4428 std::string DescData = "__" + FuncName + "_block_desc_" + BlockNumber + "_DATA"; 4429 4430 VarDecl *NewVD = VarDecl::Create( 4431 *Context, TUDecl, SourceLocation(), SourceLocation(), 4432 &Context->Idents.get(DescData), Context->VoidPtrTy, nullptr, SC_Static); 4433 UnaryOperator *DescRefExpr = 4434 new (Context) UnaryOperator(new (Context) DeclRefExpr(NewVD, false, 4435 Context->VoidPtrTy, 4436 VK_LValue, 4437 SourceLocation()), 4438 UO_AddrOf, 4439 Context->getPointerType(Context->VoidPtrTy), 4440 VK_RValue, OK_Ordinary, 4441 SourceLocation(), false); 4442 InitExprs.push_back(DescRefExpr); 4443 4444 // Add initializers for any closure decl refs. 4445 if (BlockDeclRefs.size()) { 4446 Expr *Exp; 4447 // Output all "by copy" declarations. 4448 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(), 4449 E = BlockByCopyDecls.end(); I != E; ++I) { 4450 if (isObjCType((*I)->getType())) { 4451 // FIXME: Conform to ABI ([[obj retain] autorelease]). 4452 FD = SynthBlockInitFunctionDecl((*I)->getName()); 4453 Exp = new (Context) DeclRefExpr(FD, false, FD->getType(), VK_LValue, 4454 SourceLocation()); 4455 if (HasLocalVariableExternalStorage(*I)) { 4456 QualType QT = (*I)->getType(); 4457 QT = Context->getPointerType(QT); 4458 Exp = new (Context) UnaryOperator(Exp, UO_AddrOf, QT, VK_RValue, 4459 OK_Ordinary, SourceLocation(), 4460 false); 4461 } 4462 } else if (isTopLevelBlockPointerType((*I)->getType())) { 4463 FD = SynthBlockInitFunctionDecl((*I)->getName()); 4464 Arg = new (Context) DeclRefExpr(FD, false, FD->getType(), VK_LValue, 4465 SourceLocation()); 4466 Exp = NoTypeInfoCStyleCastExpr(Context, Context->VoidPtrTy, 4467 CK_BitCast, Arg); 4468 } else { 4469 FD = SynthBlockInitFunctionDecl((*I)->getName()); 4470 Exp = new (Context) DeclRefExpr(FD, false, FD->getType(), VK_LValue, 4471 SourceLocation()); 4472 if (HasLocalVariableExternalStorage(*I)) { 4473 QualType QT = (*I)->getType(); 4474 QT = Context->getPointerType(QT); 4475 Exp = new (Context) UnaryOperator(Exp, UO_AddrOf, QT, VK_RValue, 4476 OK_Ordinary, SourceLocation(), 4477 false); 4478 } 4479 } 4480 InitExprs.push_back(Exp); 4481 } 4482 // Output all "by ref" declarations. 4483 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(), 4484 E = BlockByRefDecls.end(); I != E; ++I) { 4485 ValueDecl *ND = (*I); 4486 std::string Name(ND->getNameAsString()); 4487 std::string RecName; 4488 RewriteByRefString(RecName, Name, ND, true); 4489 IdentifierInfo *II = &Context->Idents.get(RecName.c_str() 4490 + sizeof("struct")); 4491 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 4492 SourceLocation(), SourceLocation(), 4493 II); 4494 assert(RD && "SynthBlockInitExpr(): Can't find RecordDecl"); 4495 QualType castT = Context->getPointerType(Context->getTagDeclType(RD)); 4496 4497 FD = SynthBlockInitFunctionDecl((*I)->getName()); 4498 Exp = new (Context) DeclRefExpr(FD, false, FD->getType(), VK_LValue, 4499 SourceLocation()); 4500 bool isNestedCapturedVar = false; 4501 if (block) 4502 for (const auto &CI : block->captures()) { 4503 const VarDecl *variable = CI.getVariable(); 4504 if (variable == ND && CI.isNested()) { 4505 assert (CI.isByRef() && 4506 "SynthBlockInitExpr - captured block variable is not byref"); 4507 isNestedCapturedVar = true; 4508 break; 4509 } 4510 } 4511 // captured nested byref variable has its address passed. Do not take 4512 // its address again. 4513 if (!isNestedCapturedVar) 4514 Exp = new (Context) UnaryOperator( 4515 Exp, UO_AddrOf, Context->getPointerType(Exp->getType()), VK_RValue, 4516 OK_Ordinary, SourceLocation(), false); 4517 Exp = NoTypeInfoCStyleCastExpr(Context, castT, CK_BitCast, Exp); 4518 InitExprs.push_back(Exp); 4519 } 4520 } 4521 if (ImportedBlockDecls.size()) { 4522 // generate BLOCK_HAS_COPY_DISPOSE(have helper funcs) | BLOCK_HAS_DESCRIPTOR 4523 int flag = (BLOCK_HAS_COPY_DISPOSE | BLOCK_HAS_DESCRIPTOR); 4524 unsigned IntSize = 4525 static_cast<unsigned>(Context->getTypeSize(Context->IntTy)); 4526 Expr *FlagExp = IntegerLiteral::Create(*Context, llvm::APInt(IntSize, flag), 4527 Context->IntTy, SourceLocation()); 4528 InitExprs.push_back(FlagExp); 4529 } 4530 NewRep = new (Context) CallExpr(*Context, DRE, InitExprs, 4531 FType, VK_LValue, SourceLocation()); 4532 NewRep = new (Context) UnaryOperator(NewRep, UO_AddrOf, 4533 Context->getPointerType(NewRep->getType()), 4534 VK_RValue, OK_Ordinary, SourceLocation(), false); 4535 NewRep = NoTypeInfoCStyleCastExpr(Context, FType, CK_BitCast, 4536 NewRep); 4537 BlockDeclRefs.clear(); 4538 BlockByRefDecls.clear(); 4539 BlockByRefDeclsPtrSet.clear(); 4540 BlockByCopyDecls.clear(); 4541 BlockByCopyDeclsPtrSet.clear(); 4542 ImportedBlockDecls.clear(); 4543 return NewRep; 4544 } 4545 4546 bool RewriteObjC::IsDeclStmtInForeachHeader(DeclStmt *DS) { 4547 if (const ObjCForCollectionStmt * CS = 4548 dyn_cast<ObjCForCollectionStmt>(Stmts.back())) 4549 return CS->getElement() == DS; 4550 return false; 4551 } 4552 4553 //===----------------------------------------------------------------------===// 4554 // Function Body / Expression rewriting 4555 //===----------------------------------------------------------------------===// 4556 4557 Stmt *RewriteObjC::RewriteFunctionBodyOrGlobalInitializer(Stmt *S) { 4558 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || 4559 isa<DoStmt>(S) || isa<ForStmt>(S)) 4560 Stmts.push_back(S); 4561 else if (isa<ObjCForCollectionStmt>(S)) { 4562 Stmts.push_back(S); 4563 ObjCBcLabelNo.push_back(++BcLabelCount); 4564 } 4565 4566 // Pseudo-object operations and ivar references need special 4567 // treatment because we're going to recursively rewrite them. 4568 if (PseudoObjectExpr *PseudoOp = dyn_cast<PseudoObjectExpr>(S)) { 4569 if (isa<BinaryOperator>(PseudoOp->getSyntacticForm())) { 4570 return RewritePropertyOrImplicitSetter(PseudoOp); 4571 } else { 4572 return RewritePropertyOrImplicitGetter(PseudoOp); 4573 } 4574 } else if (ObjCIvarRefExpr *IvarRefExpr = dyn_cast<ObjCIvarRefExpr>(S)) { 4575 return RewriteObjCIvarRefExpr(IvarRefExpr); 4576 } 4577 4578 SourceRange OrigStmtRange = S->getSourceRange(); 4579 4580 // Perform a bottom up rewrite of all children. 4581 for (Stmt *&childStmt : S->children()) 4582 if (childStmt) { 4583 Stmt *newStmt = RewriteFunctionBodyOrGlobalInitializer(childStmt); 4584 if (newStmt) { 4585 childStmt = newStmt; 4586 } 4587 } 4588 4589 if (BlockExpr *BE = dyn_cast<BlockExpr>(S)) { 4590 SmallVector<DeclRefExpr *, 8> InnerBlockDeclRefs; 4591 llvm::SmallPtrSet<const DeclContext *, 8> InnerContexts; 4592 InnerContexts.insert(BE->getBlockDecl()); 4593 ImportedLocalExternalDecls.clear(); 4594 GetInnerBlockDeclRefExprs(BE->getBody(), 4595 InnerBlockDeclRefs, InnerContexts); 4596 // Rewrite the block body in place. 4597 Stmt *SaveCurrentBody = CurrentBody; 4598 CurrentBody = BE->getBody(); 4599 PropParentMap = nullptr; 4600 // block literal on rhs of a property-dot-sytax assignment 4601 // must be replaced by its synthesize ast so getRewrittenText 4602 // works as expected. In this case, what actually ends up on RHS 4603 // is the blockTranscribed which is the helper function for the 4604 // block literal; as in: self.c = ^() {[ace ARR];}; 4605 bool saveDisableReplaceStmt = DisableReplaceStmt; 4606 DisableReplaceStmt = false; 4607 RewriteFunctionBodyOrGlobalInitializer(BE->getBody()); 4608 DisableReplaceStmt = saveDisableReplaceStmt; 4609 CurrentBody = SaveCurrentBody; 4610 PropParentMap = nullptr; 4611 ImportedLocalExternalDecls.clear(); 4612 // Now we snarf the rewritten text and stash it away for later use. 4613 std::string Str = Rewrite.getRewrittenText(BE->getSourceRange()); 4614 RewrittenBlockExprs[BE] = Str; 4615 4616 Stmt *blockTranscribed = SynthBlockInitExpr(BE, InnerBlockDeclRefs); 4617 4618 //blockTranscribed->dump(); 4619 ReplaceStmt(S, blockTranscribed); 4620 return blockTranscribed; 4621 } 4622 // Handle specific things. 4623 if (ObjCEncodeExpr *AtEncode = dyn_cast<ObjCEncodeExpr>(S)) 4624 return RewriteAtEncode(AtEncode); 4625 4626 if (ObjCSelectorExpr *AtSelector = dyn_cast<ObjCSelectorExpr>(S)) 4627 return RewriteAtSelector(AtSelector); 4628 4629 if (ObjCStringLiteral *AtString = dyn_cast<ObjCStringLiteral>(S)) 4630 return RewriteObjCStringLiteral(AtString); 4631 4632 if (ObjCMessageExpr *MessExpr = dyn_cast<ObjCMessageExpr>(S)) { 4633 #if 0 4634 // Before we rewrite it, put the original message expression in a comment. 4635 SourceLocation startLoc = MessExpr->getBeginLoc(); 4636 SourceLocation endLoc = MessExpr->getEndLoc(); 4637 4638 const char *startBuf = SM->getCharacterData(startLoc); 4639 const char *endBuf = SM->getCharacterData(endLoc); 4640 4641 std::string messString; 4642 messString += "// "; 4643 messString.append(startBuf, endBuf-startBuf+1); 4644 messString += "\n"; 4645 4646 // FIXME: Missing definition of 4647 // InsertText(clang::SourceLocation, char const*, unsigned int). 4648 // InsertText(startLoc, messString); 4649 // Tried this, but it didn't work either... 4650 // ReplaceText(startLoc, 0, messString.c_str(), messString.size()); 4651 #endif 4652 return RewriteMessageExpr(MessExpr); 4653 } 4654 4655 if (ObjCAtTryStmt *StmtTry = dyn_cast<ObjCAtTryStmt>(S)) 4656 return RewriteObjCTryStmt(StmtTry); 4657 4658 if (ObjCAtSynchronizedStmt *StmtTry = dyn_cast<ObjCAtSynchronizedStmt>(S)) 4659 return RewriteObjCSynchronizedStmt(StmtTry); 4660 4661 if (ObjCAtThrowStmt *StmtThrow = dyn_cast<ObjCAtThrowStmt>(S)) 4662 return RewriteObjCThrowStmt(StmtThrow); 4663 4664 if (ObjCProtocolExpr *ProtocolExp = dyn_cast<ObjCProtocolExpr>(S)) 4665 return RewriteObjCProtocolExpr(ProtocolExp); 4666 4667 if (ObjCForCollectionStmt *StmtForCollection = 4668 dyn_cast<ObjCForCollectionStmt>(S)) 4669 return RewriteObjCForCollectionStmt(StmtForCollection, 4670 OrigStmtRange.getEnd()); 4671 if (BreakStmt *StmtBreakStmt = 4672 dyn_cast<BreakStmt>(S)) 4673 return RewriteBreakStmt(StmtBreakStmt); 4674 if (ContinueStmt *StmtContinueStmt = 4675 dyn_cast<ContinueStmt>(S)) 4676 return RewriteContinueStmt(StmtContinueStmt); 4677 4678 // Need to check for protocol refs (id <P>, Foo <P> *) in variable decls 4679 // and cast exprs. 4680 if (DeclStmt *DS = dyn_cast<DeclStmt>(S)) { 4681 // FIXME: What we're doing here is modifying the type-specifier that 4682 // precedes the first Decl. In the future the DeclGroup should have 4683 // a separate type-specifier that we can rewrite. 4684 // NOTE: We need to avoid rewriting the DeclStmt if it is within 4685 // the context of an ObjCForCollectionStmt. For example: 4686 // NSArray *someArray; 4687 // for (id <FooProtocol> index in someArray) ; 4688 // This is because RewriteObjCForCollectionStmt() does textual rewriting 4689 // and it depends on the original text locations/positions. 4690 if (Stmts.empty() || !IsDeclStmtInForeachHeader(DS)) 4691 RewriteObjCQualifiedInterfaceTypes(*DS->decl_begin()); 4692 4693 // Blocks rewrite rules. 4694 for (auto *SD : DS->decls()) { 4695 if (ValueDecl *ND = dyn_cast<ValueDecl>(SD)) { 4696 if (isTopLevelBlockPointerType(ND->getType())) 4697 RewriteBlockPointerDecl(ND); 4698 else if (ND->getType()->isFunctionPointerType()) 4699 CheckFunctionPointerDecl(ND->getType(), ND); 4700 if (VarDecl *VD = dyn_cast<VarDecl>(SD)) { 4701 if (VD->hasAttr<BlocksAttr>()) { 4702 static unsigned uniqueByrefDeclCount = 0; 4703 assert(!BlockByRefDeclNo.count(ND) && 4704 "RewriteFunctionBodyOrGlobalInitializer: Duplicate byref decl"); 4705 BlockByRefDeclNo[ND] = uniqueByrefDeclCount++; 4706 RewriteByRefVar(VD); 4707 } 4708 else 4709 RewriteTypeOfDecl(VD); 4710 } 4711 } 4712 if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(SD)) { 4713 if (isTopLevelBlockPointerType(TD->getUnderlyingType())) 4714 RewriteBlockPointerDecl(TD); 4715 else if (TD->getUnderlyingType()->isFunctionPointerType()) 4716 CheckFunctionPointerDecl(TD->getUnderlyingType(), TD); 4717 } 4718 } 4719 } 4720 4721 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(S)) 4722 RewriteObjCQualifiedInterfaceTypes(CE); 4723 4724 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || 4725 isa<DoStmt>(S) || isa<ForStmt>(S)) { 4726 assert(!Stmts.empty() && "Statement stack is empty"); 4727 assert ((isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>(Stmts.back()) || 4728 isa<DoStmt>(Stmts.back()) || isa<ForStmt>(Stmts.back())) 4729 && "Statement stack mismatch"); 4730 Stmts.pop_back(); 4731 } 4732 // Handle blocks rewriting. 4733 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) { 4734 ValueDecl *VD = DRE->getDecl(); 4735 if (VD->hasAttr<BlocksAttr>()) 4736 return RewriteBlockDeclRefExpr(DRE); 4737 if (HasLocalVariableExternalStorage(VD)) 4738 return RewriteLocalVariableExternalStorage(DRE); 4739 } 4740 4741 if (CallExpr *CE = dyn_cast<CallExpr>(S)) { 4742 if (CE->getCallee()->getType()->isBlockPointerType()) { 4743 Stmt *BlockCall = SynthesizeBlockCall(CE, CE->getCallee()); 4744 ReplaceStmt(S, BlockCall); 4745 return BlockCall; 4746 } 4747 } 4748 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(S)) { 4749 RewriteCastExpr(CE); 4750 } 4751 #if 0 4752 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(S)) { 4753 CastExpr *Replacement = new (Context) CastExpr(ICE->getType(), 4754 ICE->getSubExpr(), 4755 SourceLocation()); 4756 // Get the new text. 4757 std::string SStr; 4758 llvm::raw_string_ostream Buf(SStr); 4759 Replacement->printPretty(Buf); 4760 const std::string &Str = Buf.str(); 4761 4762 printf("CAST = %s\n", &Str[0]); 4763 InsertText(ICE->getSubExpr()->getBeginLoc(), Str); 4764 delete S; 4765 return Replacement; 4766 } 4767 #endif 4768 // Return this stmt unmodified. 4769 return S; 4770 } 4771 4772 void RewriteObjC::RewriteRecordBody(RecordDecl *RD) { 4773 for (auto *FD : RD->fields()) { 4774 if (isTopLevelBlockPointerType(FD->getType())) 4775 RewriteBlockPointerDecl(FD); 4776 if (FD->getType()->isObjCQualifiedIdType() || 4777 FD->getType()->isObjCQualifiedInterfaceType()) 4778 RewriteObjCQualifiedInterfaceTypes(FD); 4779 } 4780 } 4781 4782 /// HandleDeclInMainFile - This is called for each top-level decl defined in the 4783 /// main file of the input. 4784 void RewriteObjC::HandleDeclInMainFile(Decl *D) { 4785 switch (D->getKind()) { 4786 case Decl::Function: { 4787 FunctionDecl *FD = cast<FunctionDecl>(D); 4788 if (FD->isOverloadedOperator()) 4789 return; 4790 4791 // Since function prototypes don't have ParmDecl's, we check the function 4792 // prototype. This enables us to rewrite function declarations and 4793 // definitions using the same code. 4794 RewriteBlocksInFunctionProtoType(FD->getType(), FD); 4795 4796 if (!FD->isThisDeclarationADefinition()) 4797 break; 4798 4799 // FIXME: If this should support Obj-C++, support CXXTryStmt 4800 if (CompoundStmt *Body = dyn_cast_or_null<CompoundStmt>(FD->getBody())) { 4801 CurFunctionDef = FD; 4802 CurFunctionDeclToDeclareForBlock = FD; 4803 CurrentBody = Body; 4804 Body = 4805 cast_or_null<CompoundStmt>(RewriteFunctionBodyOrGlobalInitializer(Body)); 4806 FD->setBody(Body); 4807 CurrentBody = nullptr; 4808 if (PropParentMap) { 4809 delete PropParentMap; 4810 PropParentMap = nullptr; 4811 } 4812 // This synthesizes and inserts the block "impl" struct, invoke function, 4813 // and any copy/dispose helper functions. 4814 InsertBlockLiteralsWithinFunction(FD); 4815 CurFunctionDef = nullptr; 4816 CurFunctionDeclToDeclareForBlock = nullptr; 4817 } 4818 break; 4819 } 4820 case Decl::ObjCMethod: { 4821 ObjCMethodDecl *MD = cast<ObjCMethodDecl>(D); 4822 if (CompoundStmt *Body = MD->getCompoundBody()) { 4823 CurMethodDef = MD; 4824 CurrentBody = Body; 4825 Body = 4826 cast_or_null<CompoundStmt>(RewriteFunctionBodyOrGlobalInitializer(Body)); 4827 MD->setBody(Body); 4828 CurrentBody = nullptr; 4829 if (PropParentMap) { 4830 delete PropParentMap; 4831 PropParentMap = nullptr; 4832 } 4833 InsertBlockLiteralsWithinMethod(MD); 4834 CurMethodDef = nullptr; 4835 } 4836 break; 4837 } 4838 case Decl::ObjCImplementation: { 4839 ObjCImplementationDecl *CI = cast<ObjCImplementationDecl>(D); 4840 ClassImplementation.push_back(CI); 4841 break; 4842 } 4843 case Decl::ObjCCategoryImpl: { 4844 ObjCCategoryImplDecl *CI = cast<ObjCCategoryImplDecl>(D); 4845 CategoryImplementation.push_back(CI); 4846 break; 4847 } 4848 case Decl::Var: { 4849 VarDecl *VD = cast<VarDecl>(D); 4850 RewriteObjCQualifiedInterfaceTypes(VD); 4851 if (isTopLevelBlockPointerType(VD->getType())) 4852 RewriteBlockPointerDecl(VD); 4853 else if (VD->getType()->isFunctionPointerType()) { 4854 CheckFunctionPointerDecl(VD->getType(), VD); 4855 if (VD->getInit()) { 4856 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(VD->getInit())) { 4857 RewriteCastExpr(CE); 4858 } 4859 } 4860 } else if (VD->getType()->isRecordType()) { 4861 RecordDecl *RD = VD->getType()->getAs<RecordType>()->getDecl(); 4862 if (RD->isCompleteDefinition()) 4863 RewriteRecordBody(RD); 4864 } 4865 if (VD->getInit()) { 4866 GlobalVarDecl = VD; 4867 CurrentBody = VD->getInit(); 4868 RewriteFunctionBodyOrGlobalInitializer(VD->getInit()); 4869 CurrentBody = nullptr; 4870 if (PropParentMap) { 4871 delete PropParentMap; 4872 PropParentMap = nullptr; 4873 } 4874 SynthesizeBlockLiterals(VD->getTypeSpecStartLoc(), VD->getName()); 4875 GlobalVarDecl = nullptr; 4876 4877 // This is needed for blocks. 4878 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(VD->getInit())) { 4879 RewriteCastExpr(CE); 4880 } 4881 } 4882 break; 4883 } 4884 case Decl::TypeAlias: 4885 case Decl::Typedef: { 4886 if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(D)) { 4887 if (isTopLevelBlockPointerType(TD->getUnderlyingType())) 4888 RewriteBlockPointerDecl(TD); 4889 else if (TD->getUnderlyingType()->isFunctionPointerType()) 4890 CheckFunctionPointerDecl(TD->getUnderlyingType(), TD); 4891 } 4892 break; 4893 } 4894 case Decl::CXXRecord: 4895 case Decl::Record: { 4896 RecordDecl *RD = cast<RecordDecl>(D); 4897 if (RD->isCompleteDefinition()) 4898 RewriteRecordBody(RD); 4899 break; 4900 } 4901 default: 4902 break; 4903 } 4904 // Nothing yet. 4905 } 4906 4907 void RewriteObjC::HandleTranslationUnit(ASTContext &C) { 4908 if (Diags.hasErrorOccurred()) 4909 return; 4910 4911 RewriteInclude(); 4912 4913 // Here's a great place to add any extra declarations that may be needed. 4914 // Write out meta data for each @protocol(<expr>). 4915 for (ObjCProtocolDecl *ProtDecl : ProtocolExprDecls) 4916 RewriteObjCProtocolMetaData(ProtDecl, "", "", Preamble); 4917 4918 InsertText(SM->getLocForStartOfFile(MainFileID), Preamble, false); 4919 if (ClassImplementation.size() || CategoryImplementation.size()) 4920 RewriteImplementations(); 4921 4922 // Get the buffer corresponding to MainFileID. If we haven't changed it, then 4923 // we are done. 4924 if (const RewriteBuffer *RewriteBuf = 4925 Rewrite.getRewriteBufferFor(MainFileID)) { 4926 //printf("Changed:\n"); 4927 *OutFile << std::string(RewriteBuf->begin(), RewriteBuf->end()); 4928 } else { 4929 llvm::errs() << "No changes\n"; 4930 } 4931 4932 if (ClassImplementation.size() || CategoryImplementation.size() || 4933 ProtocolExprDecls.size()) { 4934 // Rewrite Objective-c meta data* 4935 std::string ResultStr; 4936 RewriteMetaDataIntoBuffer(ResultStr); 4937 // Emit metadata. 4938 *OutFile << ResultStr; 4939 } 4940 OutFile->flush(); 4941 } 4942 4943 void RewriteObjCFragileABI::Initialize(ASTContext &context) { 4944 InitializeCommon(context); 4945 4946 // declaring objc_selector outside the parameter list removes a silly 4947 // scope related warning... 4948 if (IsHeader) 4949 Preamble = "#pragma once\n"; 4950 Preamble += "struct objc_selector; struct objc_class;\n"; 4951 Preamble += "struct __rw_objc_super { struct objc_object *object; "; 4952 Preamble += "struct objc_object *superClass; "; 4953 if (LangOpts.MicrosoftExt) { 4954 // Add a constructor for creating temporary objects. 4955 Preamble += "__rw_objc_super(struct objc_object *o, struct objc_object *s) " 4956 ": "; 4957 Preamble += "object(o), superClass(s) {} "; 4958 } 4959 Preamble += "};\n"; 4960 Preamble += "#ifndef _REWRITER_typedef_Protocol\n"; 4961 Preamble += "typedef struct objc_object Protocol;\n"; 4962 Preamble += "#define _REWRITER_typedef_Protocol\n"; 4963 Preamble += "#endif\n"; 4964 if (LangOpts.MicrosoftExt) { 4965 Preamble += "#define __OBJC_RW_DLLIMPORT extern \"C\" __declspec(dllimport)\n"; 4966 Preamble += "#define __OBJC_RW_STATICIMPORT extern \"C\"\n"; 4967 } else 4968 Preamble += "#define __OBJC_RW_DLLIMPORT extern\n"; 4969 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_msgSend"; 4970 Preamble += "(struct objc_object *, struct objc_selector *, ...);\n"; 4971 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_msgSendSuper"; 4972 Preamble += "(struct objc_super *, struct objc_selector *, ...);\n"; 4973 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object* objc_msgSend_stret"; 4974 Preamble += "(struct objc_object *, struct objc_selector *, ...);\n"; 4975 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object* objc_msgSendSuper_stret"; 4976 Preamble += "(struct objc_super *, struct objc_selector *, ...);\n"; 4977 Preamble += "__OBJC_RW_DLLIMPORT double objc_msgSend_fpret"; 4978 Preamble += "(struct objc_object *, struct objc_selector *, ...);\n"; 4979 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_getClass"; 4980 Preamble += "(const char *);\n"; 4981 Preamble += "__OBJC_RW_DLLIMPORT struct objc_class *class_getSuperclass"; 4982 Preamble += "(struct objc_class *);\n"; 4983 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_getMetaClass"; 4984 Preamble += "(const char *);\n"; 4985 Preamble += "__OBJC_RW_DLLIMPORT void objc_exception_throw(struct objc_object *);\n"; 4986 Preamble += "__OBJC_RW_DLLIMPORT void objc_exception_try_enter(void *);\n"; 4987 Preamble += "__OBJC_RW_DLLIMPORT void objc_exception_try_exit(void *);\n"; 4988 Preamble += "__OBJC_RW_DLLIMPORT struct objc_object *objc_exception_extract(void *);\n"; 4989 Preamble += "__OBJC_RW_DLLIMPORT int objc_exception_match"; 4990 Preamble += "(struct objc_class *, struct objc_object *);\n"; 4991 // @synchronized hooks. 4992 Preamble += "__OBJC_RW_DLLIMPORT int objc_sync_enter(struct objc_object *);\n"; 4993 Preamble += "__OBJC_RW_DLLIMPORT int objc_sync_exit(struct objc_object *);\n"; 4994 Preamble += "__OBJC_RW_DLLIMPORT Protocol *objc_getProtocol(const char *);\n"; 4995 Preamble += "#ifndef __FASTENUMERATIONSTATE\n"; 4996 Preamble += "struct __objcFastEnumerationState {\n\t"; 4997 Preamble += "unsigned long state;\n\t"; 4998 Preamble += "void **itemsPtr;\n\t"; 4999 Preamble += "unsigned long *mutationsPtr;\n\t"; 5000 Preamble += "unsigned long extra[5];\n};\n"; 5001 Preamble += "__OBJC_RW_DLLIMPORT void objc_enumerationMutation(struct objc_object *);\n"; 5002 Preamble += "#define __FASTENUMERATIONSTATE\n"; 5003 Preamble += "#endif\n"; 5004 Preamble += "#ifndef __NSCONSTANTSTRINGIMPL\n"; 5005 Preamble += "struct __NSConstantStringImpl {\n"; 5006 Preamble += " int *isa;\n"; 5007 Preamble += " int flags;\n"; 5008 Preamble += " char *str;\n"; 5009 Preamble += " long length;\n"; 5010 Preamble += "};\n"; 5011 Preamble += "#ifdef CF_EXPORT_CONSTANT_STRING\n"; 5012 Preamble += "extern \"C\" __declspec(dllexport) int __CFConstantStringClassReference[];\n"; 5013 Preamble += "#else\n"; 5014 Preamble += "__OBJC_RW_DLLIMPORT int __CFConstantStringClassReference[];\n"; 5015 Preamble += "#endif\n"; 5016 Preamble += "#define __NSCONSTANTSTRINGIMPL\n"; 5017 Preamble += "#endif\n"; 5018 // Blocks preamble. 5019 Preamble += "#ifndef BLOCK_IMPL\n"; 5020 Preamble += "#define BLOCK_IMPL\n"; 5021 Preamble += "struct __block_impl {\n"; 5022 Preamble += " void *isa;\n"; 5023 Preamble += " int Flags;\n"; 5024 Preamble += " int Reserved;\n"; 5025 Preamble += " void *FuncPtr;\n"; 5026 Preamble += "};\n"; 5027 Preamble += "// Runtime copy/destroy helper functions (from Block_private.h)\n"; 5028 Preamble += "#ifdef __OBJC_EXPORT_BLOCKS\n"; 5029 Preamble += "extern \"C\" __declspec(dllexport) " 5030 "void _Block_object_assign(void *, const void *, const int);\n"; 5031 Preamble += "extern \"C\" __declspec(dllexport) void _Block_object_dispose(const void *, const int);\n"; 5032 Preamble += "extern \"C\" __declspec(dllexport) void *_NSConcreteGlobalBlock[32];\n"; 5033 Preamble += "extern \"C\" __declspec(dllexport) void *_NSConcreteStackBlock[32];\n"; 5034 Preamble += "#else\n"; 5035 Preamble += "__OBJC_RW_DLLIMPORT void _Block_object_assign(void *, const void *, const int);\n"; 5036 Preamble += "__OBJC_RW_DLLIMPORT void _Block_object_dispose(const void *, const int);\n"; 5037 Preamble += "__OBJC_RW_DLLIMPORT void *_NSConcreteGlobalBlock[32];\n"; 5038 Preamble += "__OBJC_RW_DLLIMPORT void *_NSConcreteStackBlock[32];\n"; 5039 Preamble += "#endif\n"; 5040 Preamble += "#endif\n"; 5041 if (LangOpts.MicrosoftExt) { 5042 Preamble += "#undef __OBJC_RW_DLLIMPORT\n"; 5043 Preamble += "#undef __OBJC_RW_STATICIMPORT\n"; 5044 Preamble += "#ifndef KEEP_ATTRIBUTES\n"; // We use this for clang tests. 5045 Preamble += "#define __attribute__(X)\n"; 5046 Preamble += "#endif\n"; 5047 Preamble += "#define __weak\n"; 5048 } 5049 else { 5050 Preamble += "#define __block\n"; 5051 Preamble += "#define __weak\n"; 5052 } 5053 // NOTE! Windows uses LLP64 for 64bit mode. So, cast pointer to long long 5054 // as this avoids warning in any 64bit/32bit compilation model. 5055 Preamble += "\n#define __OFFSETOFIVAR__(TYPE, MEMBER) ((long long) &((TYPE *)0)->MEMBER)\n"; 5056 } 5057 5058 /// RewriteIvarOffsetComputation - This routine synthesizes computation of 5059 /// ivar offset. 5060 void RewriteObjCFragileABI::RewriteIvarOffsetComputation(ObjCIvarDecl *ivar, 5061 std::string &Result) { 5062 if (ivar->isBitField()) { 5063 // FIXME: The hack below doesn't work for bitfields. For now, we simply 5064 // place all bitfields at offset 0. 5065 Result += "0"; 5066 } else { 5067 Result += "__OFFSETOFIVAR__(struct "; 5068 Result += ivar->getContainingInterface()->getNameAsString(); 5069 if (LangOpts.MicrosoftExt) 5070 Result += "_IMPL"; 5071 Result += ", "; 5072 Result += ivar->getNameAsString(); 5073 Result += ")"; 5074 } 5075 } 5076 5077 /// RewriteObjCProtocolMetaData - Rewrite protocols meta-data. 5078 void RewriteObjCFragileABI::RewriteObjCProtocolMetaData( 5079 ObjCProtocolDecl *PDecl, StringRef prefix, 5080 StringRef ClassName, std::string &Result) { 5081 static bool objc_protocol_methods = false; 5082 5083 // Output struct protocol_methods holder of method selector and type. 5084 if (!objc_protocol_methods && PDecl->hasDefinition()) { 5085 /* struct protocol_methods { 5086 SEL _cmd; 5087 char *method_types; 5088 } 5089 */ 5090 Result += "\nstruct _protocol_methods {\n"; 5091 Result += "\tstruct objc_selector *_cmd;\n"; 5092 Result += "\tchar *method_types;\n"; 5093 Result += "};\n"; 5094 5095 objc_protocol_methods = true; 5096 } 5097 // Do not synthesize the protocol more than once. 5098 if (ObjCSynthesizedProtocols.count(PDecl->getCanonicalDecl())) 5099 return; 5100 5101 if (ObjCProtocolDecl *Def = PDecl->getDefinition()) 5102 PDecl = Def; 5103 5104 if (PDecl->instmeth_begin() != PDecl->instmeth_end()) { 5105 unsigned NumMethods = std::distance(PDecl->instmeth_begin(), 5106 PDecl->instmeth_end()); 5107 /* struct _objc_protocol_method_list { 5108 int protocol_method_count; 5109 struct protocol_methods protocols[]; 5110 } 5111 */ 5112 Result += "\nstatic struct {\n"; 5113 Result += "\tint protocol_method_count;\n"; 5114 Result += "\tstruct _protocol_methods protocol_methods["; 5115 Result += utostr(NumMethods); 5116 Result += "];\n} _OBJC_PROTOCOL_INSTANCE_METHODS_"; 5117 Result += PDecl->getNameAsString(); 5118 Result += " __attribute__ ((used, section (\"__OBJC, __cat_inst_meth\")))= " 5119 "{\n\t" + utostr(NumMethods) + "\n"; 5120 5121 // Output instance methods declared in this protocol. 5122 for (ObjCProtocolDecl::instmeth_iterator 5123 I = PDecl->instmeth_begin(), E = PDecl->instmeth_end(); 5124 I != E; ++I) { 5125 if (I == PDecl->instmeth_begin()) 5126 Result += "\t ,{{(struct objc_selector *)\""; 5127 else 5128 Result += "\t ,{(struct objc_selector *)\""; 5129 Result += (*I)->getSelector().getAsString(); 5130 std::string MethodTypeString = Context->getObjCEncodingForMethodDecl(*I); 5131 Result += "\", \""; 5132 Result += MethodTypeString; 5133 Result += "\"}\n"; 5134 } 5135 Result += "\t }\n};\n"; 5136 } 5137 5138 // Output class methods declared in this protocol. 5139 unsigned NumMethods = std::distance(PDecl->classmeth_begin(), 5140 PDecl->classmeth_end()); 5141 if (NumMethods > 0) { 5142 /* struct _objc_protocol_method_list { 5143 int protocol_method_count; 5144 struct protocol_methods protocols[]; 5145 } 5146 */ 5147 Result += "\nstatic struct {\n"; 5148 Result += "\tint protocol_method_count;\n"; 5149 Result += "\tstruct _protocol_methods protocol_methods["; 5150 Result += utostr(NumMethods); 5151 Result += "];\n} _OBJC_PROTOCOL_CLASS_METHODS_"; 5152 Result += PDecl->getNameAsString(); 5153 Result += " __attribute__ ((used, section (\"__OBJC, __cat_cls_meth\")))= " 5154 "{\n\t"; 5155 Result += utostr(NumMethods); 5156 Result += "\n"; 5157 5158 // Output instance methods declared in this protocol. 5159 for (ObjCProtocolDecl::classmeth_iterator 5160 I = PDecl->classmeth_begin(), E = PDecl->classmeth_end(); 5161 I != E; ++I) { 5162 if (I == PDecl->classmeth_begin()) 5163 Result += "\t ,{{(struct objc_selector *)\""; 5164 else 5165 Result += "\t ,{(struct objc_selector *)\""; 5166 Result += (*I)->getSelector().getAsString(); 5167 std::string MethodTypeString = Context->getObjCEncodingForMethodDecl(*I); 5168 Result += "\", \""; 5169 Result += MethodTypeString; 5170 Result += "\"}\n"; 5171 } 5172 Result += "\t }\n};\n"; 5173 } 5174 5175 // Output: 5176 /* struct _objc_protocol { 5177 // Objective-C 1.0 extensions 5178 struct _objc_protocol_extension *isa; 5179 char *protocol_name; 5180 struct _objc_protocol **protocol_list; 5181 struct _objc_protocol_method_list *instance_methods; 5182 struct _objc_protocol_method_list *class_methods; 5183 }; 5184 */ 5185 static bool objc_protocol = false; 5186 if (!objc_protocol) { 5187 Result += "\nstruct _objc_protocol {\n"; 5188 Result += "\tstruct _objc_protocol_extension *isa;\n"; 5189 Result += "\tchar *protocol_name;\n"; 5190 Result += "\tstruct _objc_protocol **protocol_list;\n"; 5191 Result += "\tstruct _objc_protocol_method_list *instance_methods;\n"; 5192 Result += "\tstruct _objc_protocol_method_list *class_methods;\n"; 5193 Result += "};\n"; 5194 5195 objc_protocol = true; 5196 } 5197 5198 Result += "\nstatic struct _objc_protocol _OBJC_PROTOCOL_"; 5199 Result += PDecl->getNameAsString(); 5200 Result += " __attribute__ ((used, section (\"__OBJC, __protocol\")))= " 5201 "{\n\t0, \""; 5202 Result += PDecl->getNameAsString(); 5203 Result += "\", 0, "; 5204 if (PDecl->instmeth_begin() != PDecl->instmeth_end()) { 5205 Result += "(struct _objc_protocol_method_list *)&_OBJC_PROTOCOL_INSTANCE_METHODS_"; 5206 Result += PDecl->getNameAsString(); 5207 Result += ", "; 5208 } 5209 else 5210 Result += "0, "; 5211 if (PDecl->classmeth_begin() != PDecl->classmeth_end()) { 5212 Result += "(struct _objc_protocol_method_list *)&_OBJC_PROTOCOL_CLASS_METHODS_"; 5213 Result += PDecl->getNameAsString(); 5214 Result += "\n"; 5215 } 5216 else 5217 Result += "0\n"; 5218 Result += "};\n"; 5219 5220 // Mark this protocol as having been generated. 5221 if (!ObjCSynthesizedProtocols.insert(PDecl->getCanonicalDecl()).second) 5222 llvm_unreachable("protocol already synthesized"); 5223 } 5224 5225 void RewriteObjCFragileABI::RewriteObjCProtocolListMetaData( 5226 const ObjCList<ObjCProtocolDecl> &Protocols, 5227 StringRef prefix, StringRef ClassName, 5228 std::string &Result) { 5229 if (Protocols.empty()) return; 5230 5231 for (unsigned i = 0; i != Protocols.size(); i++) 5232 RewriteObjCProtocolMetaData(Protocols[i], prefix, ClassName, Result); 5233 5234 // Output the top lovel protocol meta-data for the class. 5235 /* struct _objc_protocol_list { 5236 struct _objc_protocol_list *next; 5237 int protocol_count; 5238 struct _objc_protocol *class_protocols[]; 5239 } 5240 */ 5241 Result += "\nstatic struct {\n"; 5242 Result += "\tstruct _objc_protocol_list *next;\n"; 5243 Result += "\tint protocol_count;\n"; 5244 Result += "\tstruct _objc_protocol *class_protocols["; 5245 Result += utostr(Protocols.size()); 5246 Result += "];\n} _OBJC_"; 5247 Result += prefix; 5248 Result += "_PROTOCOLS_"; 5249 Result += ClassName; 5250 Result += " __attribute__ ((used, section (\"__OBJC, __cat_cls_meth\")))= " 5251 "{\n\t0, "; 5252 Result += utostr(Protocols.size()); 5253 Result += "\n"; 5254 5255 Result += "\t,{&_OBJC_PROTOCOL_"; 5256 Result += Protocols[0]->getNameAsString(); 5257 Result += " \n"; 5258 5259 for (unsigned i = 1; i != Protocols.size(); i++) { 5260 Result += "\t ,&_OBJC_PROTOCOL_"; 5261 Result += Protocols[i]->getNameAsString(); 5262 Result += "\n"; 5263 } 5264 Result += "\t }\n};\n"; 5265 } 5266 5267 void RewriteObjCFragileABI::RewriteObjCClassMetaData(ObjCImplementationDecl *IDecl, 5268 std::string &Result) { 5269 ObjCInterfaceDecl *CDecl = IDecl->getClassInterface(); 5270 5271 // Explicitly declared @interface's are already synthesized. 5272 if (CDecl->isImplicitInterfaceDecl()) { 5273 // FIXME: Implementation of a class with no @interface (legacy) does not 5274 // produce correct synthesis as yet. 5275 RewriteObjCInternalStruct(CDecl, Result); 5276 } 5277 5278 // Build _objc_ivar_list metadata for classes ivars if needed 5279 unsigned NumIvars = !IDecl->ivar_empty() 5280 ? IDecl->ivar_size() 5281 : (CDecl ? CDecl->ivar_size() : 0); 5282 if (NumIvars > 0) { 5283 static bool objc_ivar = false; 5284 if (!objc_ivar) { 5285 /* struct _objc_ivar { 5286 char *ivar_name; 5287 char *ivar_type; 5288 int ivar_offset; 5289 }; 5290 */ 5291 Result += "\nstruct _objc_ivar {\n"; 5292 Result += "\tchar *ivar_name;\n"; 5293 Result += "\tchar *ivar_type;\n"; 5294 Result += "\tint ivar_offset;\n"; 5295 Result += "};\n"; 5296 5297 objc_ivar = true; 5298 } 5299 5300 /* struct { 5301 int ivar_count; 5302 struct _objc_ivar ivar_list[nIvars]; 5303 }; 5304 */ 5305 Result += "\nstatic struct {\n"; 5306 Result += "\tint ivar_count;\n"; 5307 Result += "\tstruct _objc_ivar ivar_list["; 5308 Result += utostr(NumIvars); 5309 Result += "];\n} _OBJC_INSTANCE_VARIABLES_"; 5310 Result += IDecl->getNameAsString(); 5311 Result += " __attribute__ ((used, section (\"__OBJC, __instance_vars\")))= " 5312 "{\n\t"; 5313 Result += utostr(NumIvars); 5314 Result += "\n"; 5315 5316 ObjCInterfaceDecl::ivar_iterator IVI, IVE; 5317 SmallVector<ObjCIvarDecl *, 8> IVars; 5318 if (!IDecl->ivar_empty()) { 5319 for (auto *IV : IDecl->ivars()) 5320 IVars.push_back(IV); 5321 IVI = IDecl->ivar_begin(); 5322 IVE = IDecl->ivar_end(); 5323 } else { 5324 IVI = CDecl->ivar_begin(); 5325 IVE = CDecl->ivar_end(); 5326 } 5327 Result += "\t,{{\""; 5328 Result += IVI->getNameAsString(); 5329 Result += "\", \""; 5330 std::string TmpString, StrEncoding; 5331 Context->getObjCEncodingForType(IVI->getType(), TmpString, *IVI); 5332 QuoteDoublequotes(TmpString, StrEncoding); 5333 Result += StrEncoding; 5334 Result += "\", "; 5335 RewriteIvarOffsetComputation(*IVI, Result); 5336 Result += "}\n"; 5337 for (++IVI; IVI != IVE; ++IVI) { 5338 Result += "\t ,{\""; 5339 Result += IVI->getNameAsString(); 5340 Result += "\", \""; 5341 std::string TmpString, StrEncoding; 5342 Context->getObjCEncodingForType(IVI->getType(), TmpString, *IVI); 5343 QuoteDoublequotes(TmpString, StrEncoding); 5344 Result += StrEncoding; 5345 Result += "\", "; 5346 RewriteIvarOffsetComputation(*IVI, Result); 5347 Result += "}\n"; 5348 } 5349 5350 Result += "\t }\n};\n"; 5351 } 5352 5353 // Build _objc_method_list for class's instance methods if needed 5354 SmallVector<ObjCMethodDecl *, 32> InstanceMethods(IDecl->instance_methods()); 5355 5356 // If any of our property implementations have associated getters or 5357 // setters, produce metadata for them as well. 5358 for (const auto *Prop : IDecl->property_impls()) { 5359 if (Prop->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic) 5360 continue; 5361 if (!Prop->getPropertyIvarDecl()) 5362 continue; 5363 ObjCPropertyDecl *PD = Prop->getPropertyDecl(); 5364 if (!PD) 5365 continue; 5366 if (ObjCMethodDecl *Getter = PD->getGetterMethodDecl()) 5367 if (!Getter->isDefined()) 5368 InstanceMethods.push_back(Getter); 5369 if (PD->isReadOnly()) 5370 continue; 5371 if (ObjCMethodDecl *Setter = PD->getSetterMethodDecl()) 5372 if (!Setter->isDefined()) 5373 InstanceMethods.push_back(Setter); 5374 } 5375 RewriteObjCMethodsMetaData(InstanceMethods.begin(), InstanceMethods.end(), 5376 true, "", IDecl->getName(), Result); 5377 5378 // Build _objc_method_list for class's class methods if needed 5379 RewriteObjCMethodsMetaData(IDecl->classmeth_begin(), IDecl->classmeth_end(), 5380 false, "", IDecl->getName(), Result); 5381 5382 // Protocols referenced in class declaration? 5383 RewriteObjCProtocolListMetaData(CDecl->getReferencedProtocols(), 5384 "CLASS", CDecl->getName(), Result); 5385 5386 // Declaration of class/meta-class metadata 5387 /* struct _objc_class { 5388 struct _objc_class *isa; // or const char *root_class_name when metadata 5389 const char *super_class_name; 5390 char *name; 5391 long version; 5392 long info; 5393 long instance_size; 5394 struct _objc_ivar_list *ivars; 5395 struct _objc_method_list *methods; 5396 struct objc_cache *cache; 5397 struct objc_protocol_list *protocols; 5398 const char *ivar_layout; 5399 struct _objc_class_ext *ext; 5400 }; 5401 */ 5402 static bool objc_class = false; 5403 if (!objc_class) { 5404 Result += "\nstruct _objc_class {\n"; 5405 Result += "\tstruct _objc_class *isa;\n"; 5406 Result += "\tconst char *super_class_name;\n"; 5407 Result += "\tchar *name;\n"; 5408 Result += "\tlong version;\n"; 5409 Result += "\tlong info;\n"; 5410 Result += "\tlong instance_size;\n"; 5411 Result += "\tstruct _objc_ivar_list *ivars;\n"; 5412 Result += "\tstruct _objc_method_list *methods;\n"; 5413 Result += "\tstruct objc_cache *cache;\n"; 5414 Result += "\tstruct _objc_protocol_list *protocols;\n"; 5415 Result += "\tconst char *ivar_layout;\n"; 5416 Result += "\tstruct _objc_class_ext *ext;\n"; 5417 Result += "};\n"; 5418 objc_class = true; 5419 } 5420 5421 // Meta-class metadata generation. 5422 ObjCInterfaceDecl *RootClass = nullptr; 5423 ObjCInterfaceDecl *SuperClass = CDecl->getSuperClass(); 5424 while (SuperClass) { 5425 RootClass = SuperClass; 5426 SuperClass = SuperClass->getSuperClass(); 5427 } 5428 SuperClass = CDecl->getSuperClass(); 5429 5430 Result += "\nstatic struct _objc_class _OBJC_METACLASS_"; 5431 Result += CDecl->getNameAsString(); 5432 Result += " __attribute__ ((used, section (\"__OBJC, __meta_class\")))= " 5433 "{\n\t(struct _objc_class *)\""; 5434 Result += (RootClass ? RootClass->getNameAsString() : CDecl->getNameAsString()); 5435 Result += "\""; 5436 5437 if (SuperClass) { 5438 Result += ", \""; 5439 Result += SuperClass->getNameAsString(); 5440 Result += "\", \""; 5441 Result += CDecl->getNameAsString(); 5442 Result += "\""; 5443 } 5444 else { 5445 Result += ", 0, \""; 5446 Result += CDecl->getNameAsString(); 5447 Result += "\""; 5448 } 5449 // Set 'ivars' field for root class to 0. ObjC1 runtime does not use it. 5450 // 'info' field is initialized to CLS_META(2) for metaclass 5451 Result += ", 0,2, sizeof(struct _objc_class), 0"; 5452 if (IDecl->classmeth_begin() != IDecl->classmeth_end()) { 5453 Result += "\n\t, (struct _objc_method_list *)&_OBJC_CLASS_METHODS_"; 5454 Result += IDecl->getNameAsString(); 5455 Result += "\n"; 5456 } 5457 else 5458 Result += ", 0\n"; 5459 if (CDecl->protocol_begin() != CDecl->protocol_end()) { 5460 Result += "\t,0, (struct _objc_protocol_list *)&_OBJC_CLASS_PROTOCOLS_"; 5461 Result += CDecl->getNameAsString(); 5462 Result += ",0,0\n"; 5463 } 5464 else 5465 Result += "\t,0,0,0,0\n"; 5466 Result += "};\n"; 5467 5468 // class metadata generation. 5469 Result += "\nstatic struct _objc_class _OBJC_CLASS_"; 5470 Result += CDecl->getNameAsString(); 5471 Result += " __attribute__ ((used, section (\"__OBJC, __class\")))= " 5472 "{\n\t&_OBJC_METACLASS_"; 5473 Result += CDecl->getNameAsString(); 5474 if (SuperClass) { 5475 Result += ", \""; 5476 Result += SuperClass->getNameAsString(); 5477 Result += "\", \""; 5478 Result += CDecl->getNameAsString(); 5479 Result += "\""; 5480 } 5481 else { 5482 Result += ", 0, \""; 5483 Result += CDecl->getNameAsString(); 5484 Result += "\""; 5485 } 5486 // 'info' field is initialized to CLS_CLASS(1) for class 5487 Result += ", 0,1"; 5488 if (!ObjCSynthesizedStructs.count(CDecl)) 5489 Result += ",0"; 5490 else { 5491 // class has size. Must synthesize its size. 5492 Result += ",sizeof(struct "; 5493 Result += CDecl->getNameAsString(); 5494 if (LangOpts.MicrosoftExt) 5495 Result += "_IMPL"; 5496 Result += ")"; 5497 } 5498 if (NumIvars > 0) { 5499 Result += ", (struct _objc_ivar_list *)&_OBJC_INSTANCE_VARIABLES_"; 5500 Result += CDecl->getNameAsString(); 5501 Result += "\n\t"; 5502 } 5503 else 5504 Result += ",0"; 5505 if (IDecl->instmeth_begin() != IDecl->instmeth_end()) { 5506 Result += ", (struct _objc_method_list *)&_OBJC_INSTANCE_METHODS_"; 5507 Result += CDecl->getNameAsString(); 5508 Result += ", 0\n\t"; 5509 } 5510 else 5511 Result += ",0,0"; 5512 if (CDecl->protocol_begin() != CDecl->protocol_end()) { 5513 Result += ", (struct _objc_protocol_list*)&_OBJC_CLASS_PROTOCOLS_"; 5514 Result += CDecl->getNameAsString(); 5515 Result += ", 0,0\n"; 5516 } 5517 else 5518 Result += ",0,0,0\n"; 5519 Result += "};\n"; 5520 } 5521 5522 void RewriteObjCFragileABI::RewriteMetaDataIntoBuffer(std::string &Result) { 5523 int ClsDefCount = ClassImplementation.size(); 5524 int CatDefCount = CategoryImplementation.size(); 5525 5526 // For each implemented class, write out all its meta data. 5527 for (int i = 0; i < ClsDefCount; i++) 5528 RewriteObjCClassMetaData(ClassImplementation[i], Result); 5529 5530 // For each implemented category, write out all its meta data. 5531 for (int i = 0; i < CatDefCount; i++) 5532 RewriteObjCCategoryImplDecl(CategoryImplementation[i], Result); 5533 5534 // Write objc_symtab metadata 5535 /* 5536 struct _objc_symtab 5537 { 5538 long sel_ref_cnt; 5539 SEL *refs; 5540 short cls_def_cnt; 5541 short cat_def_cnt; 5542 void *defs[cls_def_cnt + cat_def_cnt]; 5543 }; 5544 */ 5545 5546 Result += "\nstruct _objc_symtab {\n"; 5547 Result += "\tlong sel_ref_cnt;\n"; 5548 Result += "\tSEL *refs;\n"; 5549 Result += "\tshort cls_def_cnt;\n"; 5550 Result += "\tshort cat_def_cnt;\n"; 5551 Result += "\tvoid *defs[" + utostr(ClsDefCount + CatDefCount)+ "];\n"; 5552 Result += "};\n\n"; 5553 5554 Result += "static struct _objc_symtab " 5555 "_OBJC_SYMBOLS __attribute__((used, section (\"__OBJC, __symbols\")))= {\n"; 5556 Result += "\t0, 0, " + utostr(ClsDefCount) 5557 + ", " + utostr(CatDefCount) + "\n"; 5558 for (int i = 0; i < ClsDefCount; i++) { 5559 Result += "\t,&_OBJC_CLASS_"; 5560 Result += ClassImplementation[i]->getNameAsString(); 5561 Result += "\n"; 5562 } 5563 5564 for (int i = 0; i < CatDefCount; i++) { 5565 Result += "\t,&_OBJC_CATEGORY_"; 5566 Result += CategoryImplementation[i]->getClassInterface()->getNameAsString(); 5567 Result += "_"; 5568 Result += CategoryImplementation[i]->getNameAsString(); 5569 Result += "\n"; 5570 } 5571 5572 Result += "};\n\n"; 5573 5574 // Write objc_module metadata 5575 5576 /* 5577 struct _objc_module { 5578 long version; 5579 long size; 5580 const char *name; 5581 struct _objc_symtab *symtab; 5582 } 5583 */ 5584 5585 Result += "\nstruct _objc_module {\n"; 5586 Result += "\tlong version;\n"; 5587 Result += "\tlong size;\n"; 5588 Result += "\tconst char *name;\n"; 5589 Result += "\tstruct _objc_symtab *symtab;\n"; 5590 Result += "};\n\n"; 5591 Result += "static struct _objc_module " 5592 "_OBJC_MODULES __attribute__ ((used, section (\"__OBJC, __module_info\")))= {\n"; 5593 Result += "\t" + utostr(OBJC_ABI_VERSION) + 5594 ", sizeof(struct _objc_module), \"\", &_OBJC_SYMBOLS\n"; 5595 Result += "};\n\n"; 5596 5597 if (LangOpts.MicrosoftExt) { 5598 if (ProtocolExprDecls.size()) { 5599 Result += "#pragma section(\".objc_protocol$B\",long,read,write)\n"; 5600 Result += "#pragma data_seg(push, \".objc_protocol$B\")\n"; 5601 for (ObjCProtocolDecl *ProtDecl : ProtocolExprDecls) { 5602 Result += "static struct _objc_protocol *_POINTER_OBJC_PROTOCOL_"; 5603 Result += ProtDecl->getNameAsString(); 5604 Result += " = &_OBJC_PROTOCOL_"; 5605 Result += ProtDecl->getNameAsString(); 5606 Result += ";\n"; 5607 } 5608 Result += "#pragma data_seg(pop)\n\n"; 5609 } 5610 Result += "#pragma section(\".objc_module_info$B\",long,read,write)\n"; 5611 Result += "#pragma data_seg(push, \".objc_module_info$B\")\n"; 5612 Result += "static struct _objc_module *_POINTER_OBJC_MODULES = "; 5613 Result += "&_OBJC_MODULES;\n"; 5614 Result += "#pragma data_seg(pop)\n\n"; 5615 } 5616 } 5617 5618 /// RewriteObjCCategoryImplDecl - Rewrite metadata for each category 5619 /// implementation. 5620 void RewriteObjCFragileABI::RewriteObjCCategoryImplDecl(ObjCCategoryImplDecl *IDecl, 5621 std::string &Result) { 5622 ObjCInterfaceDecl *ClassDecl = IDecl->getClassInterface(); 5623 // Find category declaration for this implementation. 5624 ObjCCategoryDecl *CDecl 5625 = ClassDecl->FindCategoryDeclaration(IDecl->getIdentifier()); 5626 5627 std::string FullCategoryName = ClassDecl->getNameAsString(); 5628 FullCategoryName += '_'; 5629 FullCategoryName += IDecl->getNameAsString(); 5630 5631 // Build _objc_method_list for class's instance methods if needed 5632 SmallVector<ObjCMethodDecl *, 32> InstanceMethods(IDecl->instance_methods()); 5633 5634 // If any of our property implementations have associated getters or 5635 // setters, produce metadata for them as well. 5636 for (const auto *Prop : IDecl->property_impls()) { 5637 if (Prop->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic) 5638 continue; 5639 if (!Prop->getPropertyIvarDecl()) 5640 continue; 5641 ObjCPropertyDecl *PD = Prop->getPropertyDecl(); 5642 if (!PD) 5643 continue; 5644 if (ObjCMethodDecl *Getter = PD->getGetterMethodDecl()) 5645 InstanceMethods.push_back(Getter); 5646 if (PD->isReadOnly()) 5647 continue; 5648 if (ObjCMethodDecl *Setter = PD->getSetterMethodDecl()) 5649 InstanceMethods.push_back(Setter); 5650 } 5651 RewriteObjCMethodsMetaData(InstanceMethods.begin(), InstanceMethods.end(), 5652 true, "CATEGORY_", FullCategoryName, Result); 5653 5654 // Build _objc_method_list for class's class methods if needed 5655 RewriteObjCMethodsMetaData(IDecl->classmeth_begin(), IDecl->classmeth_end(), 5656 false, "CATEGORY_", FullCategoryName, Result); 5657 5658 // Protocols referenced in class declaration? 5659 // Null CDecl is case of a category implementation with no category interface 5660 if (CDecl) 5661 RewriteObjCProtocolListMetaData(CDecl->getReferencedProtocols(), "CATEGORY", 5662 FullCategoryName, Result); 5663 /* struct _objc_category { 5664 char *category_name; 5665 char *class_name; 5666 struct _objc_method_list *instance_methods; 5667 struct _objc_method_list *class_methods; 5668 struct _objc_protocol_list *protocols; 5669 // Objective-C 1.0 extensions 5670 uint32_t size; // sizeof (struct _objc_category) 5671 struct _objc_property_list *instance_properties; // category's own 5672 // @property decl. 5673 }; 5674 */ 5675 5676 static bool objc_category = false; 5677 if (!objc_category) { 5678 Result += "\nstruct _objc_category {\n"; 5679 Result += "\tchar *category_name;\n"; 5680 Result += "\tchar *class_name;\n"; 5681 Result += "\tstruct _objc_method_list *instance_methods;\n"; 5682 Result += "\tstruct _objc_method_list *class_methods;\n"; 5683 Result += "\tstruct _objc_protocol_list *protocols;\n"; 5684 Result += "\tunsigned int size;\n"; 5685 Result += "\tstruct _objc_property_list *instance_properties;\n"; 5686 Result += "};\n"; 5687 objc_category = true; 5688 } 5689 Result += "\nstatic struct _objc_category _OBJC_CATEGORY_"; 5690 Result += FullCategoryName; 5691 Result += " __attribute__ ((used, section (\"__OBJC, __category\")))= {\n\t\""; 5692 Result += IDecl->getNameAsString(); 5693 Result += "\"\n\t, \""; 5694 Result += ClassDecl->getNameAsString(); 5695 Result += "\"\n"; 5696 5697 if (IDecl->instmeth_begin() != IDecl->instmeth_end()) { 5698 Result += "\t, (struct _objc_method_list *)" 5699 "&_OBJC_CATEGORY_INSTANCE_METHODS_"; 5700 Result += FullCategoryName; 5701 Result += "\n"; 5702 } 5703 else 5704 Result += "\t, 0\n"; 5705 if (IDecl->classmeth_begin() != IDecl->classmeth_end()) { 5706 Result += "\t, (struct _objc_method_list *)" 5707 "&_OBJC_CATEGORY_CLASS_METHODS_"; 5708 Result += FullCategoryName; 5709 Result += "\n"; 5710 } 5711 else 5712 Result += "\t, 0\n"; 5713 5714 if (CDecl && CDecl->protocol_begin() != CDecl->protocol_end()) { 5715 Result += "\t, (struct _objc_protocol_list *)&_OBJC_CATEGORY_PROTOCOLS_"; 5716 Result += FullCategoryName; 5717 Result += "\n"; 5718 } 5719 else 5720 Result += "\t, 0\n"; 5721 Result += "\t, sizeof(struct _objc_category), 0\n};\n"; 5722 } 5723 5724 // RewriteObjCMethodsMetaData - Rewrite methods metadata for instance or 5725 /// class methods. 5726 template<typename MethodIterator> 5727 void RewriteObjCFragileABI::RewriteObjCMethodsMetaData(MethodIterator MethodBegin, 5728 MethodIterator MethodEnd, 5729 bool IsInstanceMethod, 5730 StringRef prefix, 5731 StringRef ClassName, 5732 std::string &Result) { 5733 if (MethodBegin == MethodEnd) return; 5734 5735 if (!objc_impl_method) { 5736 /* struct _objc_method { 5737 SEL _cmd; 5738 char *method_types; 5739 void *_imp; 5740 } 5741 */ 5742 Result += "\nstruct _objc_method {\n"; 5743 Result += "\tSEL _cmd;\n"; 5744 Result += "\tchar *method_types;\n"; 5745 Result += "\tvoid *_imp;\n"; 5746 Result += "};\n"; 5747 5748 objc_impl_method = true; 5749 } 5750 5751 // Build _objc_method_list for class's methods if needed 5752 5753 /* struct { 5754 struct _objc_method_list *next_method; 5755 int method_count; 5756 struct _objc_method method_list[]; 5757 } 5758 */ 5759 unsigned NumMethods = std::distance(MethodBegin, MethodEnd); 5760 Result += "\nstatic struct {\n"; 5761 Result += "\tstruct _objc_method_list *next_method;\n"; 5762 Result += "\tint method_count;\n"; 5763 Result += "\tstruct _objc_method method_list["; 5764 Result += utostr(NumMethods); 5765 Result += "];\n} _OBJC_"; 5766 Result += prefix; 5767 Result += IsInstanceMethod ? "INSTANCE" : "CLASS"; 5768 Result += "_METHODS_"; 5769 Result += ClassName; 5770 Result += " __attribute__ ((used, section (\"__OBJC, __"; 5771 Result += IsInstanceMethod ? "inst" : "cls"; 5772 Result += "_meth\")))= "; 5773 Result += "{\n\t0, " + utostr(NumMethods) + "\n"; 5774 5775 Result += "\t,{{(SEL)\""; 5776 Result += (*MethodBegin)->getSelector().getAsString(); 5777 std::string MethodTypeString = 5778 Context->getObjCEncodingForMethodDecl(*MethodBegin); 5779 Result += "\", \""; 5780 Result += MethodTypeString; 5781 Result += "\", (void *)"; 5782 Result += MethodInternalNames[*MethodBegin]; 5783 Result += "}\n"; 5784 for (++MethodBegin; MethodBegin != MethodEnd; ++MethodBegin) { 5785 Result += "\t ,{(SEL)\""; 5786 Result += (*MethodBegin)->getSelector().getAsString(); 5787 std::string MethodTypeString = 5788 Context->getObjCEncodingForMethodDecl(*MethodBegin); 5789 Result += "\", \""; 5790 Result += MethodTypeString; 5791 Result += "\", (void *)"; 5792 Result += MethodInternalNames[*MethodBegin]; 5793 Result += "}\n"; 5794 } 5795 Result += "\t }\n};\n"; 5796 } 5797 5798 Stmt *RewriteObjCFragileABI::RewriteObjCIvarRefExpr(ObjCIvarRefExpr *IV) { 5799 SourceRange OldRange = IV->getSourceRange(); 5800 Expr *BaseExpr = IV->getBase(); 5801 5802 // Rewrite the base, but without actually doing replaces. 5803 { 5804 DisableReplaceStmtScope S(*this); 5805 BaseExpr = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(BaseExpr)); 5806 IV->setBase(BaseExpr); 5807 } 5808 5809 ObjCIvarDecl *D = IV->getDecl(); 5810 5811 Expr *Replacement = IV; 5812 if (CurMethodDef) { 5813 if (BaseExpr->getType()->isObjCObjectPointerType()) { 5814 const ObjCInterfaceType *iFaceDecl = 5815 dyn_cast<ObjCInterfaceType>(BaseExpr->getType()->getPointeeType()); 5816 assert(iFaceDecl && "RewriteObjCIvarRefExpr - iFaceDecl is null"); 5817 // lookup which class implements the instance variable. 5818 ObjCInterfaceDecl *clsDeclared = nullptr; 5819 iFaceDecl->getDecl()->lookupInstanceVariable(D->getIdentifier(), 5820 clsDeclared); 5821 assert(clsDeclared && "RewriteObjCIvarRefExpr(): Can't find class"); 5822 5823 // Synthesize an explicit cast to gain access to the ivar. 5824 std::string RecName = clsDeclared->getIdentifier()->getName(); 5825 RecName += "_IMPL"; 5826 IdentifierInfo *II = &Context->Idents.get(RecName); 5827 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 5828 SourceLocation(), SourceLocation(), 5829 II); 5830 assert(RD && "RewriteObjCIvarRefExpr(): Can't find RecordDecl"); 5831 QualType castT = Context->getPointerType(Context->getTagDeclType(RD)); 5832 CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, castT, 5833 CK_BitCast, 5834 IV->getBase()); 5835 // Don't forget the parens to enforce the proper binding. 5836 ParenExpr *PE = new (Context) ParenExpr(OldRange.getBegin(), 5837 OldRange.getEnd(), 5838 castExpr); 5839 if (IV->isFreeIvar() && 5840 declaresSameEntity(CurMethodDef->getClassInterface(), iFaceDecl->getDecl())) { 5841 MemberExpr *ME = new (Context) 5842 MemberExpr(PE, true, SourceLocation(), D, IV->getLocation(), 5843 D->getType(), VK_LValue, OK_Ordinary); 5844 Replacement = ME; 5845 } else { 5846 IV->setBase(PE); 5847 } 5848 } 5849 } else { // we are outside a method. 5850 assert(!IV->isFreeIvar() && "Cannot have a free standing ivar outside a method"); 5851 5852 // Explicit ivar refs need to have a cast inserted. 5853 // FIXME: consider sharing some of this code with the code above. 5854 if (BaseExpr->getType()->isObjCObjectPointerType()) { 5855 const ObjCInterfaceType *iFaceDecl = 5856 dyn_cast<ObjCInterfaceType>(BaseExpr->getType()->getPointeeType()); 5857 // lookup which class implements the instance variable. 5858 ObjCInterfaceDecl *clsDeclared = nullptr; 5859 iFaceDecl->getDecl()->lookupInstanceVariable(D->getIdentifier(), 5860 clsDeclared); 5861 assert(clsDeclared && "RewriteObjCIvarRefExpr(): Can't find class"); 5862 5863 // Synthesize an explicit cast to gain access to the ivar. 5864 std::string RecName = clsDeclared->getIdentifier()->getName(); 5865 RecName += "_IMPL"; 5866 IdentifierInfo *II = &Context->Idents.get(RecName); 5867 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 5868 SourceLocation(), SourceLocation(), 5869 II); 5870 assert(RD && "RewriteObjCIvarRefExpr(): Can't find RecordDecl"); 5871 QualType castT = Context->getPointerType(Context->getTagDeclType(RD)); 5872 CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, castT, 5873 CK_BitCast, 5874 IV->getBase()); 5875 // Don't forget the parens to enforce the proper binding. 5876 ParenExpr *PE = new (Context) ParenExpr( 5877 IV->getBase()->getBeginLoc(), IV->getBase()->getEndLoc(), castExpr); 5878 // Cannot delete IV->getBase(), since PE points to it. 5879 // Replace the old base with the cast. This is important when doing 5880 // embedded rewrites. For example, [newInv->_container addObject:0]. 5881 IV->setBase(PE); 5882 } 5883 } 5884 5885 ReplaceStmtWithRange(IV, Replacement, OldRange); 5886 return Replacement; 5887 } 5888 5889 #endif // CLANG_ENABLE_OBJC_REWRITER 5890