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