1 //===--- RewriteObjC.cpp - Playground for the code rewriter ---------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // Hacks and fun related to the code rewriter. 11 // 12 //===----------------------------------------------------------------------===// 13 14 #include "clang/Rewrite/Frontend/ASTConsumers.h" 15 #include "clang/AST/AST.h" 16 #include "clang/AST/ASTConsumer.h" 17 #include "clang/AST/Attr.h" 18 #include "clang/AST/ParentMap.h" 19 #include "clang/Basic/CharInfo.h" 20 #include "clang/Basic/Diagnostic.h" 21 #include "clang/Basic/IdentifierTable.h" 22 #include "clang/Basic/SourceManager.h" 23 #include "clang/Basic/TargetInfo.h" 24 #include "clang/Lex/Lexer.h" 25 #include "clang/Rewrite/Core/Rewriter.h" 26 #include "llvm/ADT/DenseSet.h" 27 #include "llvm/ADT/SmallPtrSet.h" 28 #include "llvm/ADT/StringExtras.h" 29 #include "llvm/Support/MemoryBuffer.h" 30 #include "llvm/Support/raw_ostream.h" 31 #include <memory> 32 33 #ifdef CLANG_ENABLE_OBJC_REWRITER 34 35 using namespace clang; 36 using llvm::utostr; 37 38 namespace { 39 class RewriteModernObjC : public ASTConsumer { 40 protected: 41 42 enum { 43 BLOCK_FIELD_IS_OBJECT = 3, /* id, NSObject, __attribute__((NSObject)), 44 block, ... */ 45 BLOCK_FIELD_IS_BLOCK = 7, /* a block variable */ 46 BLOCK_FIELD_IS_BYREF = 8, /* the on stack structure holding the 47 __block variable */ 48 BLOCK_FIELD_IS_WEAK = 16, /* declared __weak, only used in byref copy 49 helpers */ 50 BLOCK_BYREF_CALLER = 128, /* called from __block (byref) copy/dispose 51 support routines */ 52 BLOCK_BYREF_CURRENT_MAX = 256 53 }; 54 55 enum { 56 BLOCK_NEEDS_FREE = (1 << 24), 57 BLOCK_HAS_COPY_DISPOSE = (1 << 25), 58 BLOCK_HAS_CXX_OBJ = (1 << 26), 59 BLOCK_IS_GC = (1 << 27), 60 BLOCK_IS_GLOBAL = (1 << 28), 61 BLOCK_HAS_DESCRIPTOR = (1 << 29) 62 }; 63 64 Rewriter Rewrite; 65 DiagnosticsEngine &Diags; 66 const LangOptions &LangOpts; 67 ASTContext *Context; 68 SourceManager *SM; 69 TranslationUnitDecl *TUDecl; 70 FileID MainFileID; 71 const char *MainFileStart, *MainFileEnd; 72 Stmt *CurrentBody; 73 ParentMap *PropParentMap; // created lazily. 74 std::string InFileName; 75 std::unique_ptr<raw_ostream> OutFile; 76 std::string Preamble; 77 78 TypeDecl *ProtocolTypeDecl; 79 VarDecl *GlobalVarDecl; 80 Expr *GlobalConstructionExp; 81 unsigned RewriteFailedDiag; 82 unsigned GlobalBlockRewriteFailedDiag; 83 // ObjC string constant support. 84 unsigned NumObjCStringLiterals; 85 VarDecl *ConstantStringClassReference; 86 RecordDecl *NSStringRecord; 87 88 // ObjC foreach break/continue generation support. 89 int BcLabelCount; 90 91 unsigned TryFinallyContainsReturnDiag; 92 // Needed for super. 93 ObjCMethodDecl *CurMethodDef; 94 RecordDecl *SuperStructDecl; 95 RecordDecl *ConstantStringDecl; 96 97 FunctionDecl *MsgSendFunctionDecl; 98 FunctionDecl *MsgSendSuperFunctionDecl; 99 FunctionDecl *MsgSendStretFunctionDecl; 100 FunctionDecl *MsgSendSuperStretFunctionDecl; 101 FunctionDecl *MsgSendFpretFunctionDecl; 102 FunctionDecl *GetClassFunctionDecl; 103 FunctionDecl *GetMetaClassFunctionDecl; 104 FunctionDecl *GetSuperClassFunctionDecl; 105 FunctionDecl *SelGetUidFunctionDecl; 106 FunctionDecl *CFStringFunctionDecl; 107 FunctionDecl *SuperConstructorFunctionDecl; 108 FunctionDecl *CurFunctionDef; 109 110 /* Misc. containers needed for meta-data rewrite. */ 111 SmallVector<ObjCImplementationDecl *, 8> ClassImplementation; 112 SmallVector<ObjCCategoryImplDecl *, 8> CategoryImplementation; 113 llvm::SmallPtrSet<ObjCInterfaceDecl*, 8> ObjCSynthesizedStructs; 114 llvm::SmallPtrSet<ObjCProtocolDecl*, 8> ObjCSynthesizedProtocols; 115 llvm::SmallPtrSet<ObjCInterfaceDecl*, 8> ObjCWrittenInterfaces; 116 llvm::SmallPtrSet<TagDecl*, 32> GlobalDefinedTags; 117 SmallVector<ObjCInterfaceDecl*, 32> ObjCInterfacesSeen; 118 /// DefinedNonLazyClasses - List of defined "non-lazy" classes. 119 SmallVector<ObjCInterfaceDecl*, 8> DefinedNonLazyClasses; 120 121 /// DefinedNonLazyCategories - List of defined "non-lazy" categories. 122 SmallVector<ObjCCategoryDecl *, 8> DefinedNonLazyCategories; 123 124 SmallVector<Stmt *, 32> Stmts; 125 SmallVector<int, 8> ObjCBcLabelNo; 126 // Remember all the @protocol(<expr>) expressions. 127 llvm::SmallPtrSet<ObjCProtocolDecl *, 32> ProtocolExprDecls; 128 129 llvm::DenseSet<uint64_t> CopyDestroyCache; 130 131 // Block expressions. 132 SmallVector<BlockExpr *, 32> Blocks; 133 SmallVector<int, 32> InnerDeclRefsCount; 134 SmallVector<DeclRefExpr *, 32> InnerDeclRefs; 135 136 SmallVector<DeclRefExpr *, 32> BlockDeclRefs; 137 138 // Block related declarations. 139 SmallVector<ValueDecl *, 8> BlockByCopyDecls; 140 llvm::SmallPtrSet<ValueDecl *, 8> BlockByCopyDeclsPtrSet; 141 SmallVector<ValueDecl *, 8> BlockByRefDecls; 142 llvm::SmallPtrSet<ValueDecl *, 8> BlockByRefDeclsPtrSet; 143 llvm::DenseMap<ValueDecl *, unsigned> BlockByRefDeclNo; 144 llvm::SmallPtrSet<ValueDecl *, 8> ImportedBlockDecls; 145 llvm::SmallPtrSet<VarDecl *, 8> ImportedLocalExternalDecls; 146 147 llvm::DenseMap<BlockExpr *, std::string> RewrittenBlockExprs; 148 llvm::DenseMap<ObjCInterfaceDecl *, 149 llvm::SmallSetVector<ObjCIvarDecl *, 8> > ReferencedIvars; 150 151 // ivar bitfield grouping containers 152 llvm::DenseSet<const ObjCInterfaceDecl *> ObjCInterefaceHasBitfieldGroups; 153 llvm::DenseMap<const ObjCIvarDecl* , unsigned> IvarGroupNumber; 154 // This container maps an <class, group number for ivar> tuple to the type 155 // of the struct where the bitfield belongs. 156 llvm::DenseMap<std::pair<const ObjCInterfaceDecl*, unsigned>, QualType> GroupRecordType; 157 SmallVector<FunctionDecl*, 32> FunctionDefinitionsSeen; 158 159 // This maps an original source AST to it's rewritten form. This allows 160 // us to avoid rewriting the same node twice (which is very uncommon). 161 // This is needed to support some of the exotic property rewriting. 162 llvm::DenseMap<Stmt *, Stmt *> ReplacedNodes; 163 164 // Needed for header files being rewritten 165 bool IsHeader; 166 bool SilenceRewriteMacroWarning; 167 bool GenerateLineInfo; 168 bool objc_impl_method; 169 170 bool DisableReplaceStmt; 171 class DisableReplaceStmtScope { 172 RewriteModernObjC &R; 173 bool SavedValue; 174 175 public: 176 DisableReplaceStmtScope(RewriteModernObjC &R) 177 : R(R), SavedValue(R.DisableReplaceStmt) { 178 R.DisableReplaceStmt = true; 179 } 180 ~DisableReplaceStmtScope() { 181 R.DisableReplaceStmt = SavedValue; 182 } 183 }; 184 void InitializeCommon(ASTContext &context); 185 186 public: 187 llvm::DenseMap<ObjCMethodDecl*, std::string> MethodInternalNames; 188 189 // Top Level Driver code. 190 bool HandleTopLevelDecl(DeclGroupRef D) override { 191 for (DeclGroupRef::iterator I = D.begin(), E = D.end(); I != E; ++I) { 192 if (ObjCInterfaceDecl *Class = dyn_cast<ObjCInterfaceDecl>(*I)) { 193 if (!Class->isThisDeclarationADefinition()) { 194 RewriteForwardClassDecl(D); 195 break; 196 } else { 197 // Keep track of all interface declarations seen. 198 ObjCInterfacesSeen.push_back(Class); 199 break; 200 } 201 } 202 203 if (ObjCProtocolDecl *Proto = dyn_cast<ObjCProtocolDecl>(*I)) { 204 if (!Proto->isThisDeclarationADefinition()) { 205 RewriteForwardProtocolDecl(D); 206 break; 207 } 208 } 209 210 if (FunctionDecl *FDecl = dyn_cast<FunctionDecl>(*I)) { 211 // Under modern abi, we cannot translate body of the function 212 // yet until all class extensions and its implementation is seen. 213 // This is because they may introduce new bitfields which must go 214 // into their grouping struct. 215 if (FDecl->isThisDeclarationADefinition() && 216 // Not c functions defined inside an objc container. 217 !FDecl->isTopLevelDeclInObjCContainer()) { 218 FunctionDefinitionsSeen.push_back(FDecl); 219 break; 220 } 221 } 222 HandleTopLevelSingleDecl(*I); 223 } 224 return true; 225 } 226 227 void HandleTopLevelDeclInObjCContainer(DeclGroupRef D) override { 228 for (DeclGroupRef::iterator I = D.begin(), E = D.end(); I != E; ++I) { 229 if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(*I)) { 230 if (isTopLevelBlockPointerType(TD->getUnderlyingType())) 231 RewriteBlockPointerDecl(TD); 232 else if (TD->getUnderlyingType()->isFunctionPointerType()) 233 CheckFunctionPointerDecl(TD->getUnderlyingType(), TD); 234 else 235 RewriteObjCQualifiedInterfaceTypes(TD); 236 } 237 } 238 } 239 240 void HandleTopLevelSingleDecl(Decl *D); 241 void HandleDeclInMainFile(Decl *D); 242 RewriteModernObjC(std::string inFile, std::unique_ptr<raw_ostream> OS, 243 DiagnosticsEngine &D, const LangOptions &LOpts, 244 bool silenceMacroWarn, bool LineInfo); 245 246 ~RewriteModernObjC() override {} 247 248 void HandleTranslationUnit(ASTContext &C) override; 249 250 void ReplaceStmt(Stmt *Old, Stmt *New) { 251 ReplaceStmtWithRange(Old, New, Old->getSourceRange()); 252 } 253 254 void ReplaceStmtWithRange(Stmt *Old, Stmt *New, SourceRange SrcRange) { 255 assert(Old != nullptr && New != nullptr && "Expected non-null Stmt's"); 256 257 Stmt *ReplacingStmt = ReplacedNodes[Old]; 258 if (ReplacingStmt) 259 return; // We can't rewrite the same node twice. 260 261 if (DisableReplaceStmt) 262 return; 263 264 // Measure the old text. 265 int Size = Rewrite.getRangeSize(SrcRange); 266 if (Size == -1) { 267 Diags.Report(Context->getFullLoc(Old->getLocStart()), RewriteFailedDiag) 268 << Old->getSourceRange(); 269 return; 270 } 271 // Get the new text. 272 std::string SStr; 273 llvm::raw_string_ostream S(SStr); 274 New->printPretty(S, nullptr, PrintingPolicy(LangOpts)); 275 const std::string &Str = S.str(); 276 277 // If replacement succeeded or warning disabled return with no warning. 278 if (!Rewrite.ReplaceText(SrcRange.getBegin(), Size, Str)) { 279 ReplacedNodes[Old] = New; 280 return; 281 } 282 if (SilenceRewriteMacroWarning) 283 return; 284 Diags.Report(Context->getFullLoc(Old->getLocStart()), RewriteFailedDiag) 285 << Old->getSourceRange(); 286 } 287 288 void InsertText(SourceLocation Loc, StringRef Str, 289 bool InsertAfter = true) { 290 // If insertion succeeded or warning disabled return with no warning. 291 if (!Rewrite.InsertText(Loc, Str, InsertAfter) || 292 SilenceRewriteMacroWarning) 293 return; 294 295 Diags.Report(Context->getFullLoc(Loc), RewriteFailedDiag); 296 } 297 298 void ReplaceText(SourceLocation Start, unsigned OrigLength, 299 StringRef Str) { 300 // If removal succeeded or warning disabled return with no warning. 301 if (!Rewrite.ReplaceText(Start, OrigLength, Str) || 302 SilenceRewriteMacroWarning) 303 return; 304 305 Diags.Report(Context->getFullLoc(Start), RewriteFailedDiag); 306 } 307 308 // Syntactic Rewriting. 309 void RewriteRecordBody(RecordDecl *RD); 310 void RewriteInclude(); 311 void RewriteLineDirective(const Decl *D); 312 void ConvertSourceLocationToLineDirective(SourceLocation Loc, 313 std::string &LineString); 314 void RewriteForwardClassDecl(DeclGroupRef D); 315 void RewriteForwardClassDecl(const SmallVectorImpl<Decl *> &DG); 316 void RewriteForwardClassEpilogue(ObjCInterfaceDecl *ClassDecl, 317 const std::string &typedefString); 318 void RewriteImplementations(); 319 void RewritePropertyImplDecl(ObjCPropertyImplDecl *PID, 320 ObjCImplementationDecl *IMD, 321 ObjCCategoryImplDecl *CID); 322 void RewriteInterfaceDecl(ObjCInterfaceDecl *Dcl); 323 void RewriteImplementationDecl(Decl *Dcl); 324 void RewriteObjCMethodDecl(const ObjCInterfaceDecl *IDecl, 325 ObjCMethodDecl *MDecl, std::string &ResultStr); 326 void RewriteTypeIntoString(QualType T, std::string &ResultStr, 327 const FunctionType *&FPRetType); 328 void RewriteByRefString(std::string &ResultStr, const std::string &Name, 329 ValueDecl *VD, bool def=false); 330 void RewriteCategoryDecl(ObjCCategoryDecl *Dcl); 331 void RewriteProtocolDecl(ObjCProtocolDecl *Dcl); 332 void RewriteForwardProtocolDecl(DeclGroupRef D); 333 void RewriteForwardProtocolDecl(const SmallVectorImpl<Decl *> &DG); 334 void RewriteMethodDeclaration(ObjCMethodDecl *Method); 335 void RewriteProperty(ObjCPropertyDecl *prop); 336 void RewriteFunctionDecl(FunctionDecl *FD); 337 void RewriteBlockPointerType(std::string& Str, QualType Type); 338 void RewriteBlockPointerTypeVariable(std::string& Str, ValueDecl *VD); 339 void RewriteBlockLiteralFunctionDecl(FunctionDecl *FD); 340 void RewriteObjCQualifiedInterfaceTypes(Decl *Dcl); 341 void RewriteTypeOfDecl(VarDecl *VD); 342 void RewriteObjCQualifiedInterfaceTypes(Expr *E); 343 344 std::string getIvarAccessString(ObjCIvarDecl *D); 345 346 // Expression Rewriting. 347 Stmt *RewriteFunctionBodyOrGlobalInitializer(Stmt *S); 348 Stmt *RewriteAtEncode(ObjCEncodeExpr *Exp); 349 Stmt *RewritePropertyOrImplicitGetter(PseudoObjectExpr *Pseudo); 350 Stmt *RewritePropertyOrImplicitSetter(PseudoObjectExpr *Pseudo); 351 Stmt *RewriteAtSelector(ObjCSelectorExpr *Exp); 352 Stmt *RewriteMessageExpr(ObjCMessageExpr *Exp); 353 Stmt *RewriteObjCStringLiteral(ObjCStringLiteral *Exp); 354 Stmt *RewriteObjCBoolLiteralExpr(ObjCBoolLiteralExpr *Exp); 355 Stmt *RewriteObjCBoxedExpr(ObjCBoxedExpr *Exp); 356 Stmt *RewriteObjCArrayLiteralExpr(ObjCArrayLiteral *Exp); 357 Stmt *RewriteObjCDictionaryLiteralExpr(ObjCDictionaryLiteral *Exp); 358 Stmt *RewriteObjCProtocolExpr(ObjCProtocolExpr *Exp); 359 Stmt *RewriteObjCTryStmt(ObjCAtTryStmt *S); 360 Stmt *RewriteObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S); 361 Stmt *RewriteObjCSynchronizedStmt(ObjCAtSynchronizedStmt *S); 362 Stmt *RewriteObjCThrowStmt(ObjCAtThrowStmt *S); 363 Stmt *RewriteObjCForCollectionStmt(ObjCForCollectionStmt *S, 364 SourceLocation OrigEnd); 365 Stmt *RewriteBreakStmt(BreakStmt *S); 366 Stmt *RewriteContinueStmt(ContinueStmt *S); 367 void RewriteCastExpr(CStyleCastExpr *CE); 368 void RewriteImplicitCastObjCExpr(CastExpr *IE); 369 370 // Computes ivar bitfield group no. 371 unsigned ObjCIvarBitfieldGroupNo(ObjCIvarDecl *IV); 372 // Names field decl. for ivar bitfield group. 373 void ObjCIvarBitfieldGroupDecl(ObjCIvarDecl *IV, std::string &Result); 374 // Names struct type for ivar bitfield group. 375 void ObjCIvarBitfieldGroupType(ObjCIvarDecl *IV, std::string &Result); 376 // Names symbol for ivar bitfield group field offset. 377 void ObjCIvarBitfieldGroupOffset(ObjCIvarDecl *IV, std::string &Result); 378 // Given an ivar bitfield, it builds (or finds) its group record type. 379 QualType GetGroupRecordTypeForObjCIvarBitfield(ObjCIvarDecl *IV); 380 QualType SynthesizeBitfieldGroupStructType( 381 ObjCIvarDecl *IV, 382 SmallVectorImpl<ObjCIvarDecl *> &IVars); 383 384 // Block rewriting. 385 void RewriteBlocksInFunctionProtoType(QualType funcType, NamedDecl *D); 386 387 // Block specific rewrite rules. 388 void RewriteBlockPointerDecl(NamedDecl *VD); 389 void RewriteByRefVar(VarDecl *VD, bool firstDecl, bool lastDecl); 390 Stmt *RewriteBlockDeclRefExpr(DeclRefExpr *VD); 391 Stmt *RewriteLocalVariableExternalStorage(DeclRefExpr *DRE); 392 void RewriteBlockPointerFunctionArgs(FunctionDecl *FD); 393 394 void RewriteObjCInternalStruct(ObjCInterfaceDecl *CDecl, 395 std::string &Result); 396 397 void RewriteObjCFieldDecl(FieldDecl *fieldDecl, std::string &Result); 398 bool IsTagDefinedInsideClass(ObjCContainerDecl *IDecl, TagDecl *Tag, 399 bool &IsNamedDefinition); 400 void RewriteLocallyDefinedNamedAggregates(FieldDecl *fieldDecl, 401 std::string &Result); 402 403 bool RewriteObjCFieldDeclType(QualType &Type, std::string &Result); 404 405 void RewriteIvarOffsetSymbols(ObjCInterfaceDecl *CDecl, 406 std::string &Result); 407 408 void Initialize(ASTContext &context) override; 409 410 // Misc. AST transformation routines. Sometimes they end up calling 411 // rewriting routines on the new ASTs. 412 CallExpr *SynthesizeCallToFunctionDecl(FunctionDecl *FD, 413 ArrayRef<Expr *> Args, 414 SourceLocation StartLoc=SourceLocation(), 415 SourceLocation EndLoc=SourceLocation()); 416 417 Expr *SynthMsgSendStretCallExpr(FunctionDecl *MsgSendStretFlavor, 418 QualType returnType, 419 SmallVectorImpl<QualType> &ArgTypes, 420 SmallVectorImpl<Expr*> &MsgExprs, 421 ObjCMethodDecl *Method); 422 423 Stmt *SynthMessageExpr(ObjCMessageExpr *Exp, 424 SourceLocation StartLoc=SourceLocation(), 425 SourceLocation EndLoc=SourceLocation()); 426 427 void SynthCountByEnumWithState(std::string &buf); 428 void SynthMsgSendFunctionDecl(); 429 void SynthMsgSendSuperFunctionDecl(); 430 void SynthMsgSendStretFunctionDecl(); 431 void SynthMsgSendFpretFunctionDecl(); 432 void SynthMsgSendSuperStretFunctionDecl(); 433 void SynthGetClassFunctionDecl(); 434 void SynthGetMetaClassFunctionDecl(); 435 void SynthGetSuperClassFunctionDecl(); 436 void SynthSelGetUidFunctionDecl(); 437 void SynthSuperConstructorFunctionDecl(); 438 439 // Rewriting metadata 440 template<typename MethodIterator> 441 void RewriteObjCMethodsMetaData(MethodIterator MethodBegin, 442 MethodIterator MethodEnd, 443 bool IsInstanceMethod, 444 StringRef prefix, 445 StringRef ClassName, 446 std::string &Result); 447 void RewriteObjCProtocolMetaData(ObjCProtocolDecl *Protocol, 448 std::string &Result); 449 void RewriteObjCClassMetaData(ObjCImplementationDecl *IDecl, 450 std::string &Result); 451 void RewriteClassSetupInitHook(std::string &Result); 452 453 void RewriteMetaDataIntoBuffer(std::string &Result); 454 void WriteImageInfo(std::string &Result); 455 void RewriteObjCCategoryImplDecl(ObjCCategoryImplDecl *CDecl, 456 std::string &Result); 457 void RewriteCategorySetupInitHook(std::string &Result); 458 459 // Rewriting ivar 460 void RewriteIvarOffsetComputation(ObjCIvarDecl *ivar, 461 std::string &Result); 462 Stmt *RewriteObjCIvarRefExpr(ObjCIvarRefExpr *IV); 463 464 465 std::string SynthesizeByrefCopyDestroyHelper(VarDecl *VD, int flag); 466 std::string SynthesizeBlockHelperFuncs(BlockExpr *CE, int i, 467 StringRef funcName, std::string Tag); 468 std::string SynthesizeBlockFunc(BlockExpr *CE, int i, 469 StringRef funcName, std::string Tag); 470 std::string SynthesizeBlockImpl(BlockExpr *CE, 471 std::string Tag, std::string Desc); 472 std::string SynthesizeBlockDescriptor(std::string DescTag, 473 std::string ImplTag, 474 int i, StringRef funcName, 475 unsigned hasCopy); 476 Stmt *SynthesizeBlockCall(CallExpr *Exp, const Expr* BlockExp); 477 void SynthesizeBlockLiterals(SourceLocation FunLocStart, 478 StringRef FunName); 479 FunctionDecl *SynthBlockInitFunctionDecl(StringRef name); 480 Stmt *SynthBlockInitExpr(BlockExpr *Exp, 481 const SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs); 482 483 // Misc. helper routines. 484 QualType getProtocolType(); 485 void WarnAboutReturnGotoStmts(Stmt *S); 486 void CheckFunctionPointerDecl(QualType dType, NamedDecl *ND); 487 void InsertBlockLiteralsWithinFunction(FunctionDecl *FD); 488 void InsertBlockLiteralsWithinMethod(ObjCMethodDecl *MD); 489 490 bool IsDeclStmtInForeachHeader(DeclStmt *DS); 491 void CollectBlockDeclRefInfo(BlockExpr *Exp); 492 void GetBlockDeclRefExprs(Stmt *S); 493 void GetInnerBlockDeclRefExprs(Stmt *S, 494 SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs, 495 llvm::SmallPtrSetImpl<const DeclContext *> &InnerContexts); 496 497 // We avoid calling Type::isBlockPointerType(), since it operates on the 498 // canonical type. We only care if the top-level type is a closure pointer. 499 bool isTopLevelBlockPointerType(QualType T) { 500 return isa<BlockPointerType>(T); 501 } 502 503 /// convertBlockPointerToFunctionPointer - Converts a block-pointer type 504 /// to a function pointer type and upon success, returns true; false 505 /// otherwise. 506 bool convertBlockPointerToFunctionPointer(QualType &T) { 507 if (isTopLevelBlockPointerType(T)) { 508 const BlockPointerType *BPT = T->getAs<BlockPointerType>(); 509 T = Context->getPointerType(BPT->getPointeeType()); 510 return true; 511 } 512 return false; 513 } 514 515 bool convertObjCTypeToCStyleType(QualType &T); 516 517 bool needToScanForQualifiers(QualType T); 518 QualType getSuperStructType(); 519 QualType getConstantStringStructType(); 520 QualType convertFunctionTypeOfBlocks(const FunctionType *FT); 521 522 void convertToUnqualifiedObjCType(QualType &T) { 523 if (T->isObjCQualifiedIdType()) { 524 bool isConst = T.isConstQualified(); 525 T = isConst ? Context->getObjCIdType().withConst() 526 : Context->getObjCIdType(); 527 } 528 else if (T->isObjCQualifiedClassType()) 529 T = Context->getObjCClassType(); 530 else if (T->isObjCObjectPointerType() && 531 T->getPointeeType()->isObjCQualifiedInterfaceType()) { 532 if (const ObjCObjectPointerType * OBJPT = 533 T->getAsObjCInterfacePointerType()) { 534 const ObjCInterfaceType *IFaceT = OBJPT->getInterfaceType(); 535 T = QualType(IFaceT, 0); 536 T = Context->getPointerType(T); 537 } 538 } 539 } 540 541 // FIXME: This predicate seems like it would be useful to add to ASTContext. 542 bool isObjCType(QualType T) { 543 if (!LangOpts.ObjC1 && !LangOpts.ObjC2) 544 return false; 545 546 QualType OCT = Context->getCanonicalType(T).getUnqualifiedType(); 547 548 if (OCT == Context->getCanonicalType(Context->getObjCIdType()) || 549 OCT == Context->getCanonicalType(Context->getObjCClassType())) 550 return true; 551 552 if (const PointerType *PT = OCT->getAs<PointerType>()) { 553 if (isa<ObjCInterfaceType>(PT->getPointeeType()) || 554 PT->getPointeeType()->isObjCQualifiedIdType()) 555 return true; 556 } 557 return false; 558 } 559 560 bool PointerTypeTakesAnyBlockArguments(QualType QT); 561 bool PointerTypeTakesAnyObjCQualifiedType(QualType QT); 562 void GetExtentOfArgList(const char *Name, const char *&LParen, 563 const char *&RParen); 564 565 void QuoteDoublequotes(std::string &From, std::string &To) { 566 for (unsigned i = 0; i < From.length(); i++) { 567 if (From[i] == '"') 568 To += "\\\""; 569 else 570 To += From[i]; 571 } 572 } 573 574 QualType getSimpleFunctionType(QualType result, 575 ArrayRef<QualType> args, 576 bool variadic = false) { 577 if (result == Context->getObjCInstanceType()) 578 result = Context->getObjCIdType(); 579 FunctionProtoType::ExtProtoInfo fpi; 580 fpi.Variadic = variadic; 581 return Context->getFunctionType(result, args, fpi); 582 } 583 584 // Helper function: create a CStyleCastExpr with trivial type source info. 585 CStyleCastExpr* NoTypeInfoCStyleCastExpr(ASTContext *Ctx, QualType Ty, 586 CastKind Kind, Expr *E) { 587 TypeSourceInfo *TInfo = Ctx->getTrivialTypeSourceInfo(Ty, SourceLocation()); 588 return CStyleCastExpr::Create(*Ctx, Ty, VK_RValue, Kind, E, nullptr, 589 TInfo, SourceLocation(), SourceLocation()); 590 } 591 592 bool ImplementationIsNonLazy(const ObjCImplDecl *OD) const { 593 IdentifierInfo* II = &Context->Idents.get("load"); 594 Selector LoadSel = Context->Selectors.getSelector(0, &II); 595 return OD->getClassMethod(LoadSel) != nullptr; 596 } 597 598 StringLiteral *getStringLiteral(StringRef Str) { 599 QualType StrType = Context->getConstantArrayType( 600 Context->CharTy, llvm::APInt(32, Str.size() + 1), ArrayType::Normal, 601 0); 602 return StringLiteral::Create(*Context, Str, StringLiteral::Ascii, 603 /*Pascal=*/false, StrType, SourceLocation()); 604 } 605 }; 606 } // end anonymous namespace 607 608 void RewriteModernObjC::RewriteBlocksInFunctionProtoType(QualType funcType, 609 NamedDecl *D) { 610 if (const FunctionProtoType *fproto 611 = dyn_cast<FunctionProtoType>(funcType.IgnoreParens())) { 612 for (const auto &I : fproto->param_types()) 613 if (isTopLevelBlockPointerType(I)) { 614 // All the args are checked/rewritten. Don't call twice! 615 RewriteBlockPointerDecl(D); 616 break; 617 } 618 } 619 } 620 621 void RewriteModernObjC::CheckFunctionPointerDecl(QualType funcType, NamedDecl *ND) { 622 const PointerType *PT = funcType->getAs<PointerType>(); 623 if (PT && PointerTypeTakesAnyBlockArguments(funcType)) 624 RewriteBlocksInFunctionProtoType(PT->getPointeeType(), ND); 625 } 626 627 static bool IsHeaderFile(const std::string &Filename) { 628 std::string::size_type DotPos = Filename.rfind('.'); 629 630 if (DotPos == std::string::npos) { 631 // no file extension 632 return false; 633 } 634 635 std::string Ext = std::string(Filename.begin()+DotPos+1, Filename.end()); 636 // C header: .h 637 // C++ header: .hh or .H; 638 return Ext == "h" || Ext == "hh" || Ext == "H"; 639 } 640 641 RewriteModernObjC::RewriteModernObjC(std::string inFile, 642 std::unique_ptr<raw_ostream> OS, 643 DiagnosticsEngine &D, 644 const LangOptions &LOpts, 645 bool silenceMacroWarn, bool LineInfo) 646 : Diags(D), LangOpts(LOpts), InFileName(inFile), OutFile(std::move(OS)), 647 SilenceRewriteMacroWarning(silenceMacroWarn), GenerateLineInfo(LineInfo) { 648 IsHeader = IsHeaderFile(inFile); 649 RewriteFailedDiag = Diags.getCustomDiagID(DiagnosticsEngine::Warning, 650 "rewriting sub-expression within a macro (may not be correct)"); 651 // FIXME. This should be an error. But if block is not called, it is OK. And it 652 // may break including some headers. 653 GlobalBlockRewriteFailedDiag = Diags.getCustomDiagID(DiagnosticsEngine::Warning, 654 "rewriting block literal declared in global scope is not implemented"); 655 656 TryFinallyContainsReturnDiag = Diags.getCustomDiagID( 657 DiagnosticsEngine::Warning, 658 "rewriter doesn't support user-specified control flow semantics " 659 "for @try/@finally (code may not execute properly)"); 660 } 661 662 std::unique_ptr<ASTConsumer> clang::CreateModernObjCRewriter( 663 const std::string &InFile, std::unique_ptr<raw_ostream> OS, 664 DiagnosticsEngine &Diags, const LangOptions &LOpts, 665 bool SilenceRewriteMacroWarning, bool LineInfo) { 666 return llvm::make_unique<RewriteModernObjC>(InFile, std::move(OS), Diags, 667 LOpts, SilenceRewriteMacroWarning, 668 LineInfo); 669 } 670 671 void RewriteModernObjC::InitializeCommon(ASTContext &context) { 672 Context = &context; 673 SM = &Context->getSourceManager(); 674 TUDecl = Context->getTranslationUnitDecl(); 675 MsgSendFunctionDecl = nullptr; 676 MsgSendSuperFunctionDecl = nullptr; 677 MsgSendStretFunctionDecl = nullptr; 678 MsgSendSuperStretFunctionDecl = nullptr; 679 MsgSendFpretFunctionDecl = nullptr; 680 GetClassFunctionDecl = nullptr; 681 GetMetaClassFunctionDecl = nullptr; 682 GetSuperClassFunctionDecl = nullptr; 683 SelGetUidFunctionDecl = nullptr; 684 CFStringFunctionDecl = nullptr; 685 ConstantStringClassReference = nullptr; 686 NSStringRecord = nullptr; 687 CurMethodDef = nullptr; 688 CurFunctionDef = nullptr; 689 GlobalVarDecl = nullptr; 690 GlobalConstructionExp = nullptr; 691 SuperStructDecl = nullptr; 692 ProtocolTypeDecl = nullptr; 693 ConstantStringDecl = nullptr; 694 BcLabelCount = 0; 695 SuperConstructorFunctionDecl = nullptr; 696 NumObjCStringLiterals = 0; 697 PropParentMap = nullptr; 698 CurrentBody = nullptr; 699 DisableReplaceStmt = false; 700 objc_impl_method = false; 701 702 // Get the ID and start/end of the main file. 703 MainFileID = SM->getMainFileID(); 704 const llvm::MemoryBuffer *MainBuf = SM->getBuffer(MainFileID); 705 MainFileStart = MainBuf->getBufferStart(); 706 MainFileEnd = MainBuf->getBufferEnd(); 707 708 Rewrite.setSourceMgr(Context->getSourceManager(), Context->getLangOpts()); 709 } 710 711 //===----------------------------------------------------------------------===// 712 // Top Level Driver Code 713 //===----------------------------------------------------------------------===// 714 715 void RewriteModernObjC::HandleTopLevelSingleDecl(Decl *D) { 716 if (Diags.hasErrorOccurred()) 717 return; 718 719 // Two cases: either the decl could be in the main file, or it could be in a 720 // #included file. If the former, rewrite it now. If the later, check to see 721 // if we rewrote the #include/#import. 722 SourceLocation Loc = D->getLocation(); 723 Loc = SM->getExpansionLoc(Loc); 724 725 // If this is for a builtin, ignore it. 726 if (Loc.isInvalid()) return; 727 728 // Look for built-in declarations that we need to refer during the rewrite. 729 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 730 RewriteFunctionDecl(FD); 731 } else if (VarDecl *FVD = dyn_cast<VarDecl>(D)) { 732 // declared in <Foundation/NSString.h> 733 if (FVD->getName() == "_NSConstantStringClassReference") { 734 ConstantStringClassReference = FVD; 735 return; 736 } 737 } else if (ObjCCategoryDecl *CD = dyn_cast<ObjCCategoryDecl>(D)) { 738 RewriteCategoryDecl(CD); 739 } else if (ObjCProtocolDecl *PD = dyn_cast<ObjCProtocolDecl>(D)) { 740 if (PD->isThisDeclarationADefinition()) 741 RewriteProtocolDecl(PD); 742 } else if (LinkageSpecDecl *LSD = dyn_cast<LinkageSpecDecl>(D)) { 743 // Recurse into linkage specifications 744 for (DeclContext::decl_iterator DI = LSD->decls_begin(), 745 DIEnd = LSD->decls_end(); 746 DI != DIEnd; ) { 747 if (ObjCInterfaceDecl *IFace = dyn_cast<ObjCInterfaceDecl>((*DI))) { 748 if (!IFace->isThisDeclarationADefinition()) { 749 SmallVector<Decl *, 8> DG; 750 SourceLocation StartLoc = IFace->getLocStart(); 751 do { 752 if (isa<ObjCInterfaceDecl>(*DI) && 753 !cast<ObjCInterfaceDecl>(*DI)->isThisDeclarationADefinition() && 754 StartLoc == (*DI)->getLocStart()) 755 DG.push_back(*DI); 756 else 757 break; 758 759 ++DI; 760 } while (DI != DIEnd); 761 RewriteForwardClassDecl(DG); 762 continue; 763 } 764 else { 765 // Keep track of all interface declarations seen. 766 ObjCInterfacesSeen.push_back(IFace); 767 ++DI; 768 continue; 769 } 770 } 771 772 if (ObjCProtocolDecl *Proto = dyn_cast<ObjCProtocolDecl>((*DI))) { 773 if (!Proto->isThisDeclarationADefinition()) { 774 SmallVector<Decl *, 8> DG; 775 SourceLocation StartLoc = Proto->getLocStart(); 776 do { 777 if (isa<ObjCProtocolDecl>(*DI) && 778 !cast<ObjCProtocolDecl>(*DI)->isThisDeclarationADefinition() && 779 StartLoc == (*DI)->getLocStart()) 780 DG.push_back(*DI); 781 else 782 break; 783 784 ++DI; 785 } while (DI != DIEnd); 786 RewriteForwardProtocolDecl(DG); 787 continue; 788 } 789 } 790 791 HandleTopLevelSingleDecl(*DI); 792 ++DI; 793 } 794 } 795 // If we have a decl in the main file, see if we should rewrite it. 796 if (SM->isWrittenInMainFile(Loc)) 797 return HandleDeclInMainFile(D); 798 } 799 800 //===----------------------------------------------------------------------===// 801 // Syntactic (non-AST) Rewriting Code 802 //===----------------------------------------------------------------------===// 803 804 void RewriteModernObjC::RewriteInclude() { 805 SourceLocation LocStart = SM->getLocForStartOfFile(MainFileID); 806 StringRef MainBuf = SM->getBufferData(MainFileID); 807 const char *MainBufStart = MainBuf.begin(); 808 const char *MainBufEnd = MainBuf.end(); 809 size_t ImportLen = strlen("import"); 810 811 // Loop over the whole file, looking for includes. 812 for (const char *BufPtr = MainBufStart; BufPtr < MainBufEnd; ++BufPtr) { 813 if (*BufPtr == '#') { 814 if (++BufPtr == MainBufEnd) 815 return; 816 while (*BufPtr == ' ' || *BufPtr == '\t') 817 if (++BufPtr == MainBufEnd) 818 return; 819 if (!strncmp(BufPtr, "import", ImportLen)) { 820 // replace import with include 821 SourceLocation ImportLoc = 822 LocStart.getLocWithOffset(BufPtr-MainBufStart); 823 ReplaceText(ImportLoc, ImportLen, "include"); 824 BufPtr += ImportLen; 825 } 826 } 827 } 828 } 829 830 static void WriteInternalIvarName(const ObjCInterfaceDecl *IDecl, 831 ObjCIvarDecl *IvarDecl, std::string &Result) { 832 Result += "OBJC_IVAR_$_"; 833 Result += IDecl->getName(); 834 Result += "$"; 835 Result += IvarDecl->getName(); 836 } 837 838 std::string 839 RewriteModernObjC::getIvarAccessString(ObjCIvarDecl *D) { 840 const ObjCInterfaceDecl *ClassDecl = D->getContainingInterface(); 841 842 // Build name of symbol holding ivar offset. 843 std::string IvarOffsetName; 844 if (D->isBitField()) 845 ObjCIvarBitfieldGroupOffset(D, IvarOffsetName); 846 else 847 WriteInternalIvarName(ClassDecl, D, IvarOffsetName); 848 849 std::string S = "(*("; 850 QualType IvarT = D->getType(); 851 if (D->isBitField()) 852 IvarT = GetGroupRecordTypeForObjCIvarBitfield(D); 853 854 if (!isa<TypedefType>(IvarT) && IvarT->isRecordType()) { 855 RecordDecl *RD = IvarT->getAs<RecordType>()->getDecl(); 856 RD = RD->getDefinition(); 857 if (RD && !RD->getDeclName().getAsIdentifierInfo()) { 858 // decltype(((Foo_IMPL*)0)->bar) * 859 ObjCContainerDecl *CDecl = 860 dyn_cast<ObjCContainerDecl>(D->getDeclContext()); 861 // ivar in class extensions requires special treatment. 862 if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(CDecl)) 863 CDecl = CatDecl->getClassInterface(); 864 std::string RecName = CDecl->getName(); 865 RecName += "_IMPL"; 866 RecordDecl *RD = 867 RecordDecl::Create(*Context, TTK_Struct, TUDecl, SourceLocation(), 868 SourceLocation(), &Context->Idents.get(RecName)); 869 QualType PtrStructIMPL = Context->getPointerType(Context->getTagDeclType(RD)); 870 unsigned UnsignedIntSize = 871 static_cast<unsigned>(Context->getTypeSize(Context->UnsignedIntTy)); 872 Expr *Zero = IntegerLiteral::Create(*Context, 873 llvm::APInt(UnsignedIntSize, 0), 874 Context->UnsignedIntTy, SourceLocation()); 875 Zero = NoTypeInfoCStyleCastExpr(Context, PtrStructIMPL, CK_BitCast, Zero); 876 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), 877 Zero); 878 FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 879 SourceLocation(), 880 &Context->Idents.get(D->getNameAsString()), 881 IvarT, nullptr, 882 /*BitWidth=*/nullptr, /*Mutable=*/true, 883 ICIS_NoInit); 884 MemberExpr *ME = new (Context) 885 MemberExpr(PE, true, SourceLocation(), FD, SourceLocation(), 886 FD->getType(), VK_LValue, OK_Ordinary); 887 IvarT = Context->getDecltypeType(ME, ME->getType()); 888 } 889 } 890 convertObjCTypeToCStyleType(IvarT); 891 QualType castT = Context->getPointerType(IvarT); 892 std::string TypeString(castT.getAsString(Context->getPrintingPolicy())); 893 S += TypeString; 894 S += ")"; 895 896 // ((char *)self + IVAR_OFFSET_SYMBOL_NAME) 897 S += "((char *)self + "; 898 S += IvarOffsetName; 899 S += "))"; 900 if (D->isBitField()) { 901 S += "."; 902 S += D->getNameAsString(); 903 } 904 ReferencedIvars[const_cast<ObjCInterfaceDecl *>(ClassDecl)].insert(D); 905 return S; 906 } 907 908 /// mustSynthesizeSetterGetterMethod - returns true if setter or getter has not 909 /// been found in the class implementation. In this case, it must be synthesized. 910 static bool mustSynthesizeSetterGetterMethod(ObjCImplementationDecl *IMP, 911 ObjCPropertyDecl *PD, 912 bool getter) { 913 return getter ? !IMP->getInstanceMethod(PD->getGetterName()) 914 : !IMP->getInstanceMethod(PD->getSetterName()); 915 916 } 917 918 void RewriteModernObjC::RewritePropertyImplDecl(ObjCPropertyImplDecl *PID, 919 ObjCImplementationDecl *IMD, 920 ObjCCategoryImplDecl *CID) { 921 static bool objcGetPropertyDefined = false; 922 static bool objcSetPropertyDefined = false; 923 SourceLocation startGetterSetterLoc; 924 925 if (PID->getLocStart().isValid()) { 926 SourceLocation startLoc = PID->getLocStart(); 927 InsertText(startLoc, "// "); 928 const char *startBuf = SM->getCharacterData(startLoc); 929 assert((*startBuf == '@') && "bogus @synthesize location"); 930 const char *semiBuf = strchr(startBuf, ';'); 931 assert((*semiBuf == ';') && "@synthesize: can't find ';'"); 932 startGetterSetterLoc = startLoc.getLocWithOffset(semiBuf-startBuf+1); 933 } 934 else 935 startGetterSetterLoc = IMD ? IMD->getLocEnd() : CID->getLocEnd(); 936 937 if (PID->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic) 938 return; // FIXME: is this correct? 939 940 // Generate the 'getter' function. 941 ObjCPropertyDecl *PD = PID->getPropertyDecl(); 942 ObjCIvarDecl *OID = PID->getPropertyIvarDecl(); 943 assert(IMD && OID && "Synthesized ivars must be attached to @implementation"); 944 945 unsigned Attributes = PD->getPropertyAttributes(); 946 if (mustSynthesizeSetterGetterMethod(IMD, PD, true /*getter*/)) { 947 bool GenGetProperty = !(Attributes & ObjCPropertyDecl::OBJC_PR_nonatomic) && 948 (Attributes & (ObjCPropertyDecl::OBJC_PR_retain | 949 ObjCPropertyDecl::OBJC_PR_copy)); 950 std::string Getr; 951 if (GenGetProperty && !objcGetPropertyDefined) { 952 objcGetPropertyDefined = true; 953 // FIXME. Is this attribute correct in all cases? 954 Getr = "\nextern \"C\" __declspec(dllimport) " 955 "id objc_getProperty(id, SEL, long, bool);\n"; 956 } 957 RewriteObjCMethodDecl(OID->getContainingInterface(), 958 PD->getGetterMethodDecl(), Getr); 959 Getr += "{ "; 960 // Synthesize an explicit cast to gain access to the ivar. 961 // See objc-act.c:objc_synthesize_new_getter() for details. 962 if (GenGetProperty) { 963 // return objc_getProperty(self, _cmd, offsetof(ClassDecl, OID), 1) 964 Getr += "typedef "; 965 const FunctionType *FPRetType = nullptr; 966 RewriteTypeIntoString(PD->getGetterMethodDecl()->getReturnType(), Getr, 967 FPRetType); 968 Getr += " _TYPE"; 969 if (FPRetType) { 970 Getr += ")"; // close the precedence "scope" for "*". 971 972 // Now, emit the argument types (if any). 973 if (const FunctionProtoType *FT = dyn_cast<FunctionProtoType>(FPRetType)){ 974 Getr += "("; 975 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) { 976 if (i) Getr += ", "; 977 std::string ParamStr = 978 FT->getParamType(i).getAsString(Context->getPrintingPolicy()); 979 Getr += ParamStr; 980 } 981 if (FT->isVariadic()) { 982 if (FT->getNumParams()) 983 Getr += ", "; 984 Getr += "..."; 985 } 986 Getr += ")"; 987 } else 988 Getr += "()"; 989 } 990 Getr += ";\n"; 991 Getr += "return (_TYPE)"; 992 Getr += "objc_getProperty(self, _cmd, "; 993 RewriteIvarOffsetComputation(OID, Getr); 994 Getr += ", 1)"; 995 } 996 else 997 Getr += "return " + getIvarAccessString(OID); 998 Getr += "; }"; 999 InsertText(startGetterSetterLoc, Getr); 1000 } 1001 1002 if (PD->isReadOnly() || 1003 !mustSynthesizeSetterGetterMethod(IMD, PD, false /*setter*/)) 1004 return; 1005 1006 // Generate the 'setter' function. 1007 std::string Setr; 1008 bool GenSetProperty = Attributes & (ObjCPropertyDecl::OBJC_PR_retain | 1009 ObjCPropertyDecl::OBJC_PR_copy); 1010 if (GenSetProperty && !objcSetPropertyDefined) { 1011 objcSetPropertyDefined = true; 1012 // FIXME. Is this attribute correct in all cases? 1013 Setr = "\nextern \"C\" __declspec(dllimport) " 1014 "void objc_setProperty (id, SEL, long, id, bool, bool);\n"; 1015 } 1016 1017 RewriteObjCMethodDecl(OID->getContainingInterface(), 1018 PD->getSetterMethodDecl(), Setr); 1019 Setr += "{ "; 1020 // Synthesize an explicit cast to initialize the ivar. 1021 // See objc-act.c:objc_synthesize_new_setter() for details. 1022 if (GenSetProperty) { 1023 Setr += "objc_setProperty (self, _cmd, "; 1024 RewriteIvarOffsetComputation(OID, Setr); 1025 Setr += ", (id)"; 1026 Setr += PD->getName(); 1027 Setr += ", "; 1028 if (Attributes & ObjCPropertyDecl::OBJC_PR_nonatomic) 1029 Setr += "0, "; 1030 else 1031 Setr += "1, "; 1032 if (Attributes & ObjCPropertyDecl::OBJC_PR_copy) 1033 Setr += "1)"; 1034 else 1035 Setr += "0)"; 1036 } 1037 else { 1038 Setr += getIvarAccessString(OID) + " = "; 1039 Setr += PD->getName(); 1040 } 1041 Setr += "; }\n"; 1042 InsertText(startGetterSetterLoc, Setr); 1043 } 1044 1045 static void RewriteOneForwardClassDecl(ObjCInterfaceDecl *ForwardDecl, 1046 std::string &typedefString) { 1047 typedefString += "\n#ifndef _REWRITER_typedef_"; 1048 typedefString += ForwardDecl->getNameAsString(); 1049 typedefString += "\n"; 1050 typedefString += "#define _REWRITER_typedef_"; 1051 typedefString += ForwardDecl->getNameAsString(); 1052 typedefString += "\n"; 1053 typedefString += "typedef struct objc_object "; 1054 typedefString += ForwardDecl->getNameAsString(); 1055 // typedef struct { } _objc_exc_Classname; 1056 typedefString += ";\ntypedef struct {} _objc_exc_"; 1057 typedefString += ForwardDecl->getNameAsString(); 1058 typedefString += ";\n#endif\n"; 1059 } 1060 1061 void RewriteModernObjC::RewriteForwardClassEpilogue(ObjCInterfaceDecl *ClassDecl, 1062 const std::string &typedefString) { 1063 SourceLocation startLoc = ClassDecl->getLocStart(); 1064 const char *startBuf = SM->getCharacterData(startLoc); 1065 const char *semiPtr = strchr(startBuf, ';'); 1066 // Replace the @class with typedefs corresponding to the classes. 1067 ReplaceText(startLoc, semiPtr-startBuf+1, typedefString); 1068 } 1069 1070 void RewriteModernObjC::RewriteForwardClassDecl(DeclGroupRef D) { 1071 std::string typedefString; 1072 for (DeclGroupRef::iterator I = D.begin(), E = D.end(); I != E; ++I) { 1073 if (ObjCInterfaceDecl *ForwardDecl = dyn_cast<ObjCInterfaceDecl>(*I)) { 1074 if (I == D.begin()) { 1075 // Translate to typedef's that forward reference structs with the same name 1076 // as the class. As a convenience, we include the original declaration 1077 // as a comment. 1078 typedefString += "// @class "; 1079 typedefString += ForwardDecl->getNameAsString(); 1080 typedefString += ";"; 1081 } 1082 RewriteOneForwardClassDecl(ForwardDecl, typedefString); 1083 } 1084 else 1085 HandleTopLevelSingleDecl(*I); 1086 } 1087 DeclGroupRef::iterator I = D.begin(); 1088 RewriteForwardClassEpilogue(cast<ObjCInterfaceDecl>(*I), typedefString); 1089 } 1090 1091 void RewriteModernObjC::RewriteForwardClassDecl( 1092 const SmallVectorImpl<Decl *> &D) { 1093 std::string typedefString; 1094 for (unsigned i = 0; i < D.size(); i++) { 1095 ObjCInterfaceDecl *ForwardDecl = cast<ObjCInterfaceDecl>(D[i]); 1096 if (i == 0) { 1097 typedefString += "// @class "; 1098 typedefString += ForwardDecl->getNameAsString(); 1099 typedefString += ";"; 1100 } 1101 RewriteOneForwardClassDecl(ForwardDecl, typedefString); 1102 } 1103 RewriteForwardClassEpilogue(cast<ObjCInterfaceDecl>(D[0]), typedefString); 1104 } 1105 1106 void RewriteModernObjC::RewriteMethodDeclaration(ObjCMethodDecl *Method) { 1107 // When method is a synthesized one, such as a getter/setter there is 1108 // nothing to rewrite. 1109 if (Method->isImplicit()) 1110 return; 1111 SourceLocation LocStart = Method->getLocStart(); 1112 SourceLocation LocEnd = Method->getLocEnd(); 1113 1114 if (SM->getExpansionLineNumber(LocEnd) > 1115 SM->getExpansionLineNumber(LocStart)) { 1116 InsertText(LocStart, "#if 0\n"); 1117 ReplaceText(LocEnd, 1, ";\n#endif\n"); 1118 } else { 1119 InsertText(LocStart, "// "); 1120 } 1121 } 1122 1123 void RewriteModernObjC::RewriteProperty(ObjCPropertyDecl *prop) { 1124 SourceLocation Loc = prop->getAtLoc(); 1125 1126 ReplaceText(Loc, 0, "// "); 1127 // FIXME: handle properties that are declared across multiple lines. 1128 } 1129 1130 void RewriteModernObjC::RewriteCategoryDecl(ObjCCategoryDecl *CatDecl) { 1131 SourceLocation LocStart = CatDecl->getLocStart(); 1132 1133 // FIXME: handle category headers that are declared across multiple lines. 1134 if (CatDecl->getIvarRBraceLoc().isValid()) { 1135 ReplaceText(LocStart, 1, "/** "); 1136 ReplaceText(CatDecl->getIvarRBraceLoc(), 1, "**/ "); 1137 } 1138 else { 1139 ReplaceText(LocStart, 0, "// "); 1140 } 1141 1142 for (auto *I : CatDecl->instance_properties()) 1143 RewriteProperty(I); 1144 1145 for (auto *I : CatDecl->instance_methods()) 1146 RewriteMethodDeclaration(I); 1147 for (auto *I : CatDecl->class_methods()) 1148 RewriteMethodDeclaration(I); 1149 1150 // Lastly, comment out the @end. 1151 ReplaceText(CatDecl->getAtEndRange().getBegin(), 1152 strlen("@end"), "/* @end */\n"); 1153 } 1154 1155 void RewriteModernObjC::RewriteProtocolDecl(ObjCProtocolDecl *PDecl) { 1156 SourceLocation LocStart = PDecl->getLocStart(); 1157 assert(PDecl->isThisDeclarationADefinition()); 1158 1159 // FIXME: handle protocol headers that are declared across multiple lines. 1160 ReplaceText(LocStart, 0, "// "); 1161 1162 for (auto *I : PDecl->instance_methods()) 1163 RewriteMethodDeclaration(I); 1164 for (auto *I : PDecl->class_methods()) 1165 RewriteMethodDeclaration(I); 1166 for (auto *I : PDecl->instance_properties()) 1167 RewriteProperty(I); 1168 1169 // Lastly, comment out the @end. 1170 SourceLocation LocEnd = PDecl->getAtEndRange().getBegin(); 1171 ReplaceText(LocEnd, strlen("@end"), "/* @end */\n"); 1172 1173 // Must comment out @optional/@required 1174 const char *startBuf = SM->getCharacterData(LocStart); 1175 const char *endBuf = SM->getCharacterData(LocEnd); 1176 for (const char *p = startBuf; p < endBuf; p++) { 1177 if (*p == '@' && !strncmp(p+1, "optional", strlen("optional"))) { 1178 SourceLocation OptionalLoc = LocStart.getLocWithOffset(p-startBuf); 1179 ReplaceText(OptionalLoc, strlen("@optional"), "/* @optional */"); 1180 1181 } 1182 else if (*p == '@' && !strncmp(p+1, "required", strlen("required"))) { 1183 SourceLocation OptionalLoc = LocStart.getLocWithOffset(p-startBuf); 1184 ReplaceText(OptionalLoc, strlen("@required"), "/* @required */"); 1185 1186 } 1187 } 1188 } 1189 1190 void RewriteModernObjC::RewriteForwardProtocolDecl(DeclGroupRef D) { 1191 SourceLocation LocStart = (*D.begin())->getLocStart(); 1192 if (LocStart.isInvalid()) 1193 llvm_unreachable("Invalid SourceLocation"); 1194 // FIXME: handle forward protocol that are declared across multiple lines. 1195 ReplaceText(LocStart, 0, "// "); 1196 } 1197 1198 void 1199 RewriteModernObjC::RewriteForwardProtocolDecl(const SmallVectorImpl<Decl *> &DG) { 1200 SourceLocation LocStart = DG[0]->getLocStart(); 1201 if (LocStart.isInvalid()) 1202 llvm_unreachable("Invalid SourceLocation"); 1203 // FIXME: handle forward protocol that are declared across multiple lines. 1204 ReplaceText(LocStart, 0, "// "); 1205 } 1206 1207 void RewriteModernObjC::RewriteTypeIntoString(QualType T, std::string &ResultStr, 1208 const FunctionType *&FPRetType) { 1209 if (T->isObjCQualifiedIdType()) 1210 ResultStr += "id"; 1211 else if (T->isFunctionPointerType() || 1212 T->isBlockPointerType()) { 1213 // needs special handling, since pointer-to-functions have special 1214 // syntax (where a decaration models use). 1215 QualType retType = T; 1216 QualType PointeeTy; 1217 if (const PointerType* PT = retType->getAs<PointerType>()) 1218 PointeeTy = PT->getPointeeType(); 1219 else if (const BlockPointerType *BPT = retType->getAs<BlockPointerType>()) 1220 PointeeTy = BPT->getPointeeType(); 1221 if ((FPRetType = PointeeTy->getAs<FunctionType>())) { 1222 ResultStr += 1223 FPRetType->getReturnType().getAsString(Context->getPrintingPolicy()); 1224 ResultStr += "(*"; 1225 } 1226 } else 1227 ResultStr += T.getAsString(Context->getPrintingPolicy()); 1228 } 1229 1230 void RewriteModernObjC::RewriteObjCMethodDecl(const ObjCInterfaceDecl *IDecl, 1231 ObjCMethodDecl *OMD, 1232 std::string &ResultStr) { 1233 //fprintf(stderr,"In RewriteObjCMethodDecl\n"); 1234 const FunctionType *FPRetType = nullptr; 1235 ResultStr += "\nstatic "; 1236 RewriteTypeIntoString(OMD->getReturnType(), ResultStr, FPRetType); 1237 ResultStr += " "; 1238 1239 // Unique method name 1240 std::string NameStr; 1241 1242 if (OMD->isInstanceMethod()) 1243 NameStr += "_I_"; 1244 else 1245 NameStr += "_C_"; 1246 1247 NameStr += IDecl->getNameAsString(); 1248 NameStr += "_"; 1249 1250 if (ObjCCategoryImplDecl *CID = 1251 dyn_cast<ObjCCategoryImplDecl>(OMD->getDeclContext())) { 1252 NameStr += CID->getNameAsString(); 1253 NameStr += "_"; 1254 } 1255 // Append selector names, replacing ':' with '_' 1256 { 1257 std::string selString = OMD->getSelector().getAsString(); 1258 int len = selString.size(); 1259 for (int i = 0; i < len; i++) 1260 if (selString[i] == ':') 1261 selString[i] = '_'; 1262 NameStr += selString; 1263 } 1264 // Remember this name for metadata emission 1265 MethodInternalNames[OMD] = NameStr; 1266 ResultStr += NameStr; 1267 1268 // Rewrite arguments 1269 ResultStr += "("; 1270 1271 // invisible arguments 1272 if (OMD->isInstanceMethod()) { 1273 QualType selfTy = Context->getObjCInterfaceType(IDecl); 1274 selfTy = Context->getPointerType(selfTy); 1275 if (!LangOpts.MicrosoftExt) { 1276 if (ObjCSynthesizedStructs.count(const_cast<ObjCInterfaceDecl*>(IDecl))) 1277 ResultStr += "struct "; 1278 } 1279 // When rewriting for Microsoft, explicitly omit the structure name. 1280 ResultStr += IDecl->getNameAsString(); 1281 ResultStr += " *"; 1282 } 1283 else 1284 ResultStr += Context->getObjCClassType().getAsString( 1285 Context->getPrintingPolicy()); 1286 1287 ResultStr += " self, "; 1288 ResultStr += Context->getObjCSelType().getAsString(Context->getPrintingPolicy()); 1289 ResultStr += " _cmd"; 1290 1291 // Method arguments. 1292 for (const auto *PDecl : OMD->parameters()) { 1293 ResultStr += ", "; 1294 if (PDecl->getType()->isObjCQualifiedIdType()) { 1295 ResultStr += "id "; 1296 ResultStr += PDecl->getNameAsString(); 1297 } else { 1298 std::string Name = PDecl->getNameAsString(); 1299 QualType QT = PDecl->getType(); 1300 // Make sure we convert "t (^)(...)" to "t (*)(...)". 1301 (void)convertBlockPointerToFunctionPointer(QT); 1302 QT.getAsStringInternal(Name, Context->getPrintingPolicy()); 1303 ResultStr += Name; 1304 } 1305 } 1306 if (OMD->isVariadic()) 1307 ResultStr += ", ..."; 1308 ResultStr += ") "; 1309 1310 if (FPRetType) { 1311 ResultStr += ")"; // close the precedence "scope" for "*". 1312 1313 // Now, emit the argument types (if any). 1314 if (const FunctionProtoType *FT = dyn_cast<FunctionProtoType>(FPRetType)) { 1315 ResultStr += "("; 1316 for (unsigned i = 0, e = FT->getNumParams(); i != e; ++i) { 1317 if (i) ResultStr += ", "; 1318 std::string ParamStr = 1319 FT->getParamType(i).getAsString(Context->getPrintingPolicy()); 1320 ResultStr += ParamStr; 1321 } 1322 if (FT->isVariadic()) { 1323 if (FT->getNumParams()) 1324 ResultStr += ", "; 1325 ResultStr += "..."; 1326 } 1327 ResultStr += ")"; 1328 } else { 1329 ResultStr += "()"; 1330 } 1331 } 1332 } 1333 1334 void RewriteModernObjC::RewriteImplementationDecl(Decl *OID) { 1335 ObjCImplementationDecl *IMD = dyn_cast<ObjCImplementationDecl>(OID); 1336 ObjCCategoryImplDecl *CID = dyn_cast<ObjCCategoryImplDecl>(OID); 1337 1338 if (IMD) { 1339 if (IMD->getIvarRBraceLoc().isValid()) { 1340 ReplaceText(IMD->getLocStart(), 1, "/** "); 1341 ReplaceText(IMD->getIvarRBraceLoc(), 1, "**/ "); 1342 } 1343 else { 1344 InsertText(IMD->getLocStart(), "// "); 1345 } 1346 } 1347 else 1348 InsertText(CID->getLocStart(), "// "); 1349 1350 for (auto *OMD : IMD ? IMD->instance_methods() : CID->instance_methods()) { 1351 std::string ResultStr; 1352 RewriteObjCMethodDecl(OMD->getClassInterface(), OMD, ResultStr); 1353 SourceLocation LocStart = OMD->getLocStart(); 1354 SourceLocation LocEnd = OMD->getCompoundBody()->getLocStart(); 1355 1356 const char *startBuf = SM->getCharacterData(LocStart); 1357 const char *endBuf = SM->getCharacterData(LocEnd); 1358 ReplaceText(LocStart, endBuf-startBuf, ResultStr); 1359 } 1360 1361 for (auto *OMD : IMD ? IMD->class_methods() : CID->class_methods()) { 1362 std::string ResultStr; 1363 RewriteObjCMethodDecl(OMD->getClassInterface(), OMD, ResultStr); 1364 SourceLocation LocStart = OMD->getLocStart(); 1365 SourceLocation LocEnd = OMD->getCompoundBody()->getLocStart(); 1366 1367 const char *startBuf = SM->getCharacterData(LocStart); 1368 const char *endBuf = SM->getCharacterData(LocEnd); 1369 ReplaceText(LocStart, endBuf-startBuf, ResultStr); 1370 } 1371 for (auto *I : IMD ? IMD->property_impls() : CID->property_impls()) 1372 RewritePropertyImplDecl(I, IMD, CID); 1373 1374 InsertText(IMD ? IMD->getLocEnd() : CID->getLocEnd(), "// "); 1375 } 1376 1377 void RewriteModernObjC::RewriteInterfaceDecl(ObjCInterfaceDecl *ClassDecl) { 1378 // Do not synthesize more than once. 1379 if (ObjCSynthesizedStructs.count(ClassDecl)) 1380 return; 1381 // Make sure super class's are written before current class is written. 1382 ObjCInterfaceDecl *SuperClass = ClassDecl->getSuperClass(); 1383 while (SuperClass) { 1384 RewriteInterfaceDecl(SuperClass); 1385 SuperClass = SuperClass->getSuperClass(); 1386 } 1387 std::string ResultStr; 1388 if (!ObjCWrittenInterfaces.count(ClassDecl->getCanonicalDecl())) { 1389 // we haven't seen a forward decl - generate a typedef. 1390 RewriteOneForwardClassDecl(ClassDecl, ResultStr); 1391 RewriteIvarOffsetSymbols(ClassDecl, ResultStr); 1392 1393 RewriteObjCInternalStruct(ClassDecl, ResultStr); 1394 // Mark this typedef as having been written into its c++ equivalent. 1395 ObjCWrittenInterfaces.insert(ClassDecl->getCanonicalDecl()); 1396 1397 for (auto *I : ClassDecl->instance_properties()) 1398 RewriteProperty(I); 1399 for (auto *I : ClassDecl->instance_methods()) 1400 RewriteMethodDeclaration(I); 1401 for (auto *I : ClassDecl->class_methods()) 1402 RewriteMethodDeclaration(I); 1403 1404 // Lastly, comment out the @end. 1405 ReplaceText(ClassDecl->getAtEndRange().getBegin(), strlen("@end"), 1406 "/* @end */\n"); 1407 } 1408 } 1409 1410 Stmt *RewriteModernObjC::RewritePropertyOrImplicitSetter(PseudoObjectExpr *PseudoOp) { 1411 SourceRange OldRange = PseudoOp->getSourceRange(); 1412 1413 // We just magically know some things about the structure of this 1414 // expression. 1415 ObjCMessageExpr *OldMsg = 1416 cast<ObjCMessageExpr>(PseudoOp->getSemanticExpr( 1417 PseudoOp->getNumSemanticExprs() - 1)); 1418 1419 // Because the rewriter doesn't allow us to rewrite rewritten code, 1420 // we need to suppress rewriting the sub-statements. 1421 Expr *Base; 1422 SmallVector<Expr*, 2> Args; 1423 { 1424 DisableReplaceStmtScope S(*this); 1425 1426 // Rebuild the base expression if we have one. 1427 Base = nullptr; 1428 if (OldMsg->getReceiverKind() == ObjCMessageExpr::Instance) { 1429 Base = OldMsg->getInstanceReceiver(); 1430 Base = cast<OpaqueValueExpr>(Base)->getSourceExpr(); 1431 Base = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Base)); 1432 } 1433 1434 unsigned numArgs = OldMsg->getNumArgs(); 1435 for (unsigned i = 0; i < numArgs; i++) { 1436 Expr *Arg = OldMsg->getArg(i); 1437 if (isa<OpaqueValueExpr>(Arg)) 1438 Arg = cast<OpaqueValueExpr>(Arg)->getSourceExpr(); 1439 Arg = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Arg)); 1440 Args.push_back(Arg); 1441 } 1442 } 1443 1444 // TODO: avoid this copy. 1445 SmallVector<SourceLocation, 1> SelLocs; 1446 OldMsg->getSelectorLocs(SelLocs); 1447 1448 ObjCMessageExpr *NewMsg = nullptr; 1449 switch (OldMsg->getReceiverKind()) { 1450 case ObjCMessageExpr::Class: 1451 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(), 1452 OldMsg->getValueKind(), 1453 OldMsg->getLeftLoc(), 1454 OldMsg->getClassReceiverTypeInfo(), 1455 OldMsg->getSelector(), 1456 SelLocs, 1457 OldMsg->getMethodDecl(), 1458 Args, 1459 OldMsg->getRightLoc(), 1460 OldMsg->isImplicit()); 1461 break; 1462 1463 case ObjCMessageExpr::Instance: 1464 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(), 1465 OldMsg->getValueKind(), 1466 OldMsg->getLeftLoc(), 1467 Base, 1468 OldMsg->getSelector(), 1469 SelLocs, 1470 OldMsg->getMethodDecl(), 1471 Args, 1472 OldMsg->getRightLoc(), 1473 OldMsg->isImplicit()); 1474 break; 1475 1476 case ObjCMessageExpr::SuperClass: 1477 case ObjCMessageExpr::SuperInstance: 1478 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(), 1479 OldMsg->getValueKind(), 1480 OldMsg->getLeftLoc(), 1481 OldMsg->getSuperLoc(), 1482 OldMsg->getReceiverKind() == ObjCMessageExpr::SuperInstance, 1483 OldMsg->getSuperType(), 1484 OldMsg->getSelector(), 1485 SelLocs, 1486 OldMsg->getMethodDecl(), 1487 Args, 1488 OldMsg->getRightLoc(), 1489 OldMsg->isImplicit()); 1490 break; 1491 } 1492 1493 Stmt *Replacement = SynthMessageExpr(NewMsg); 1494 ReplaceStmtWithRange(PseudoOp, Replacement, OldRange); 1495 return Replacement; 1496 } 1497 1498 Stmt *RewriteModernObjC::RewritePropertyOrImplicitGetter(PseudoObjectExpr *PseudoOp) { 1499 SourceRange OldRange = PseudoOp->getSourceRange(); 1500 1501 // We just magically know some things about the structure of this 1502 // expression. 1503 ObjCMessageExpr *OldMsg = 1504 cast<ObjCMessageExpr>(PseudoOp->getResultExpr()->IgnoreImplicit()); 1505 1506 // Because the rewriter doesn't allow us to rewrite rewritten code, 1507 // we need to suppress rewriting the sub-statements. 1508 Expr *Base = nullptr; 1509 SmallVector<Expr*, 1> Args; 1510 { 1511 DisableReplaceStmtScope S(*this); 1512 // Rebuild the base expression if we have one. 1513 if (OldMsg->getReceiverKind() == ObjCMessageExpr::Instance) { 1514 Base = OldMsg->getInstanceReceiver(); 1515 Base = cast<OpaqueValueExpr>(Base)->getSourceExpr(); 1516 Base = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Base)); 1517 } 1518 unsigned numArgs = OldMsg->getNumArgs(); 1519 for (unsigned i = 0; i < numArgs; i++) { 1520 Expr *Arg = OldMsg->getArg(i); 1521 if (isa<OpaqueValueExpr>(Arg)) 1522 Arg = cast<OpaqueValueExpr>(Arg)->getSourceExpr(); 1523 Arg = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(Arg)); 1524 Args.push_back(Arg); 1525 } 1526 } 1527 1528 // Intentionally empty. 1529 SmallVector<SourceLocation, 1> SelLocs; 1530 1531 ObjCMessageExpr *NewMsg = nullptr; 1532 switch (OldMsg->getReceiverKind()) { 1533 case ObjCMessageExpr::Class: 1534 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(), 1535 OldMsg->getValueKind(), 1536 OldMsg->getLeftLoc(), 1537 OldMsg->getClassReceiverTypeInfo(), 1538 OldMsg->getSelector(), 1539 SelLocs, 1540 OldMsg->getMethodDecl(), 1541 Args, 1542 OldMsg->getRightLoc(), 1543 OldMsg->isImplicit()); 1544 break; 1545 1546 case ObjCMessageExpr::Instance: 1547 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(), 1548 OldMsg->getValueKind(), 1549 OldMsg->getLeftLoc(), 1550 Base, 1551 OldMsg->getSelector(), 1552 SelLocs, 1553 OldMsg->getMethodDecl(), 1554 Args, 1555 OldMsg->getRightLoc(), 1556 OldMsg->isImplicit()); 1557 break; 1558 1559 case ObjCMessageExpr::SuperClass: 1560 case ObjCMessageExpr::SuperInstance: 1561 NewMsg = ObjCMessageExpr::Create(*Context, OldMsg->getType(), 1562 OldMsg->getValueKind(), 1563 OldMsg->getLeftLoc(), 1564 OldMsg->getSuperLoc(), 1565 OldMsg->getReceiverKind() == ObjCMessageExpr::SuperInstance, 1566 OldMsg->getSuperType(), 1567 OldMsg->getSelector(), 1568 SelLocs, 1569 OldMsg->getMethodDecl(), 1570 Args, 1571 OldMsg->getRightLoc(), 1572 OldMsg->isImplicit()); 1573 break; 1574 } 1575 1576 Stmt *Replacement = SynthMessageExpr(NewMsg); 1577 ReplaceStmtWithRange(PseudoOp, Replacement, OldRange); 1578 return Replacement; 1579 } 1580 1581 /// SynthCountByEnumWithState - To print: 1582 /// ((NSUInteger (*) 1583 /// (id, SEL, struct __objcFastEnumerationState *, id *, NSUInteger)) 1584 /// (void *)objc_msgSend)((id)l_collection, 1585 /// sel_registerName( 1586 /// "countByEnumeratingWithState:objects:count:"), 1587 /// &enumState, 1588 /// (id *)__rw_items, (NSUInteger)16) 1589 /// 1590 void RewriteModernObjC::SynthCountByEnumWithState(std::string &buf) { 1591 buf += "((_WIN_NSUInteger (*) (id, SEL, struct __objcFastEnumerationState *, " 1592 "id *, _WIN_NSUInteger))(void *)objc_msgSend)"; 1593 buf += "\n\t\t"; 1594 buf += "((id)l_collection,\n\t\t"; 1595 buf += "sel_registerName(\"countByEnumeratingWithState:objects:count:\"),"; 1596 buf += "\n\t\t"; 1597 buf += "&enumState, " 1598 "(id *)__rw_items, (_WIN_NSUInteger)16)"; 1599 } 1600 1601 /// RewriteBreakStmt - Rewrite for a break-stmt inside an ObjC2's foreach 1602 /// statement to exit to its outer synthesized loop. 1603 /// 1604 Stmt *RewriteModernObjC::RewriteBreakStmt(BreakStmt *S) { 1605 if (Stmts.empty() || !isa<ObjCForCollectionStmt>(Stmts.back())) 1606 return S; 1607 // replace break with goto __break_label 1608 std::string buf; 1609 1610 SourceLocation startLoc = S->getLocStart(); 1611 buf = "goto __break_label_"; 1612 buf += utostr(ObjCBcLabelNo.back()); 1613 ReplaceText(startLoc, strlen("break"), buf); 1614 1615 return nullptr; 1616 } 1617 1618 void RewriteModernObjC::ConvertSourceLocationToLineDirective( 1619 SourceLocation Loc, 1620 std::string &LineString) { 1621 if (Loc.isFileID() && GenerateLineInfo) { 1622 LineString += "\n#line "; 1623 PresumedLoc PLoc = SM->getPresumedLoc(Loc); 1624 LineString += utostr(PLoc.getLine()); 1625 LineString += " \""; 1626 LineString += Lexer::Stringify(PLoc.getFilename()); 1627 LineString += "\"\n"; 1628 } 1629 } 1630 1631 /// RewriteContinueStmt - Rewrite for a continue-stmt inside an ObjC2's foreach 1632 /// statement to continue with its inner synthesized loop. 1633 /// 1634 Stmt *RewriteModernObjC::RewriteContinueStmt(ContinueStmt *S) { 1635 if (Stmts.empty() || !isa<ObjCForCollectionStmt>(Stmts.back())) 1636 return S; 1637 // replace continue with goto __continue_label 1638 std::string buf; 1639 1640 SourceLocation startLoc = S->getLocStart(); 1641 buf = "goto __continue_label_"; 1642 buf += utostr(ObjCBcLabelNo.back()); 1643 ReplaceText(startLoc, strlen("continue"), buf); 1644 1645 return nullptr; 1646 } 1647 1648 /// RewriteObjCForCollectionStmt - Rewriter for ObjC2's foreach statement. 1649 /// It rewrites: 1650 /// for ( type elem in collection) { stmts; } 1651 1652 /// Into: 1653 /// { 1654 /// type elem; 1655 /// struct __objcFastEnumerationState enumState = { 0 }; 1656 /// id __rw_items[16]; 1657 /// id l_collection = (id)collection; 1658 /// NSUInteger limit = [l_collection countByEnumeratingWithState:&enumState 1659 /// objects:__rw_items count:16]; 1660 /// if (limit) { 1661 /// unsigned long startMutations = *enumState.mutationsPtr; 1662 /// do { 1663 /// unsigned long counter = 0; 1664 /// do { 1665 /// if (startMutations != *enumState.mutationsPtr) 1666 /// objc_enumerationMutation(l_collection); 1667 /// elem = (type)enumState.itemsPtr[counter++]; 1668 /// stmts; 1669 /// __continue_label: ; 1670 /// } while (counter < limit); 1671 /// } while ((limit = [l_collection countByEnumeratingWithState:&enumState 1672 /// objects:__rw_items count:16])); 1673 /// elem = nil; 1674 /// __break_label: ; 1675 /// } 1676 /// else 1677 /// elem = nil; 1678 /// } 1679 /// 1680 Stmt *RewriteModernObjC::RewriteObjCForCollectionStmt(ObjCForCollectionStmt *S, 1681 SourceLocation OrigEnd) { 1682 assert(!Stmts.empty() && "ObjCForCollectionStmt - Statement stack empty"); 1683 assert(isa<ObjCForCollectionStmt>(Stmts.back()) && 1684 "ObjCForCollectionStmt Statement stack mismatch"); 1685 assert(!ObjCBcLabelNo.empty() && 1686 "ObjCForCollectionStmt - Label No stack empty"); 1687 1688 SourceLocation startLoc = S->getLocStart(); 1689 const char *startBuf = SM->getCharacterData(startLoc); 1690 StringRef elementName; 1691 std::string elementTypeAsString; 1692 std::string buf; 1693 // line directive first. 1694 SourceLocation ForEachLoc = S->getForLoc(); 1695 ConvertSourceLocationToLineDirective(ForEachLoc, buf); 1696 buf += "{\n\t"; 1697 if (DeclStmt *DS = dyn_cast<DeclStmt>(S->getElement())) { 1698 // type elem; 1699 NamedDecl* D = cast<NamedDecl>(DS->getSingleDecl()); 1700 QualType ElementType = cast<ValueDecl>(D)->getType(); 1701 if (ElementType->isObjCQualifiedIdType() || 1702 ElementType->isObjCQualifiedInterfaceType()) 1703 // Simply use 'id' for all qualified types. 1704 elementTypeAsString = "id"; 1705 else 1706 elementTypeAsString = ElementType.getAsString(Context->getPrintingPolicy()); 1707 buf += elementTypeAsString; 1708 buf += " "; 1709 elementName = D->getName(); 1710 buf += elementName; 1711 buf += ";\n\t"; 1712 } 1713 else { 1714 DeclRefExpr *DR = cast<DeclRefExpr>(S->getElement()); 1715 elementName = DR->getDecl()->getName(); 1716 ValueDecl *VD = cast<ValueDecl>(DR->getDecl()); 1717 if (VD->getType()->isObjCQualifiedIdType() || 1718 VD->getType()->isObjCQualifiedInterfaceType()) 1719 // Simply use 'id' for all qualified types. 1720 elementTypeAsString = "id"; 1721 else 1722 elementTypeAsString = VD->getType().getAsString(Context->getPrintingPolicy()); 1723 } 1724 1725 // struct __objcFastEnumerationState enumState = { 0 }; 1726 buf += "struct __objcFastEnumerationState enumState = { 0 };\n\t"; 1727 // id __rw_items[16]; 1728 buf += "id __rw_items[16];\n\t"; 1729 // id l_collection = (id) 1730 buf += "id l_collection = (id)"; 1731 // Find start location of 'collection' the hard way! 1732 const char *startCollectionBuf = startBuf; 1733 startCollectionBuf += 3; // skip 'for' 1734 startCollectionBuf = strchr(startCollectionBuf, '('); 1735 startCollectionBuf++; // skip '(' 1736 // find 'in' and skip it. 1737 while (*startCollectionBuf != ' ' || 1738 *(startCollectionBuf+1) != 'i' || *(startCollectionBuf+2) != 'n' || 1739 (*(startCollectionBuf+3) != ' ' && 1740 *(startCollectionBuf+3) != '[' && *(startCollectionBuf+3) != '(')) 1741 startCollectionBuf++; 1742 startCollectionBuf += 3; 1743 1744 // Replace: "for (type element in" with string constructed thus far. 1745 ReplaceText(startLoc, startCollectionBuf - startBuf, buf); 1746 // Replace ')' in for '(' type elem in collection ')' with ';' 1747 SourceLocation rightParenLoc = S->getRParenLoc(); 1748 const char *rparenBuf = SM->getCharacterData(rightParenLoc); 1749 SourceLocation lparenLoc = startLoc.getLocWithOffset(rparenBuf-startBuf); 1750 buf = ";\n\t"; 1751 1752 // unsigned long limit = [l_collection countByEnumeratingWithState:&enumState 1753 // objects:__rw_items count:16]; 1754 // which is synthesized into: 1755 // NSUInteger limit = 1756 // ((NSUInteger (*) 1757 // (id, SEL, struct __objcFastEnumerationState *, id *, NSUInteger)) 1758 // (void *)objc_msgSend)((id)l_collection, 1759 // sel_registerName( 1760 // "countByEnumeratingWithState:objects:count:"), 1761 // (struct __objcFastEnumerationState *)&state, 1762 // (id *)__rw_items, (NSUInteger)16); 1763 buf += "_WIN_NSUInteger limit =\n\t\t"; 1764 SynthCountByEnumWithState(buf); 1765 buf += ";\n\t"; 1766 /// if (limit) { 1767 /// unsigned long startMutations = *enumState.mutationsPtr; 1768 /// do { 1769 /// unsigned long counter = 0; 1770 /// do { 1771 /// if (startMutations != *enumState.mutationsPtr) 1772 /// objc_enumerationMutation(l_collection); 1773 /// elem = (type)enumState.itemsPtr[counter++]; 1774 buf += "if (limit) {\n\t"; 1775 buf += "unsigned long startMutations = *enumState.mutationsPtr;\n\t"; 1776 buf += "do {\n\t\t"; 1777 buf += "unsigned long counter = 0;\n\t\t"; 1778 buf += "do {\n\t\t\t"; 1779 buf += "if (startMutations != *enumState.mutationsPtr)\n\t\t\t\t"; 1780 buf += "objc_enumerationMutation(l_collection);\n\t\t\t"; 1781 buf += elementName; 1782 buf += " = ("; 1783 buf += elementTypeAsString; 1784 buf += ")enumState.itemsPtr[counter++];"; 1785 // Replace ')' in for '(' type elem in collection ')' with all of these. 1786 ReplaceText(lparenLoc, 1, buf); 1787 1788 /// __continue_label: ; 1789 /// } while (counter < limit); 1790 /// } while ((limit = [l_collection countByEnumeratingWithState:&enumState 1791 /// objects:__rw_items count:16])); 1792 /// elem = nil; 1793 /// __break_label: ; 1794 /// } 1795 /// else 1796 /// elem = nil; 1797 /// } 1798 /// 1799 buf = ";\n\t"; 1800 buf += "__continue_label_"; 1801 buf += utostr(ObjCBcLabelNo.back()); 1802 buf += ": ;"; 1803 buf += "\n\t\t"; 1804 buf += "} while (counter < limit);\n\t"; 1805 buf += "} while ((limit = "; 1806 SynthCountByEnumWithState(buf); 1807 buf += "));\n\t"; 1808 buf += elementName; 1809 buf += " = (("; 1810 buf += elementTypeAsString; 1811 buf += ")0);\n\t"; 1812 buf += "__break_label_"; 1813 buf += utostr(ObjCBcLabelNo.back()); 1814 buf += ": ;\n\t"; 1815 buf += "}\n\t"; 1816 buf += "else\n\t\t"; 1817 buf += elementName; 1818 buf += " = (("; 1819 buf += elementTypeAsString; 1820 buf += ")0);\n\t"; 1821 buf += "}\n"; 1822 1823 // Insert all these *after* the statement body. 1824 // FIXME: If this should support Obj-C++, support CXXTryStmt 1825 if (isa<CompoundStmt>(S->getBody())) { 1826 SourceLocation endBodyLoc = OrigEnd.getLocWithOffset(1); 1827 InsertText(endBodyLoc, buf); 1828 } else { 1829 /* Need to treat single statements specially. For example: 1830 * 1831 * for (A *a in b) if (stuff()) break; 1832 * for (A *a in b) xxxyy; 1833 * 1834 * The following code simply scans ahead to the semi to find the actual end. 1835 */ 1836 const char *stmtBuf = SM->getCharacterData(OrigEnd); 1837 const char *semiBuf = strchr(stmtBuf, ';'); 1838 assert(semiBuf && "Can't find ';'"); 1839 SourceLocation endBodyLoc = OrigEnd.getLocWithOffset(semiBuf-stmtBuf+1); 1840 InsertText(endBodyLoc, buf); 1841 } 1842 Stmts.pop_back(); 1843 ObjCBcLabelNo.pop_back(); 1844 return nullptr; 1845 } 1846 1847 static void Write_RethrowObject(std::string &buf) { 1848 buf += "{ struct _FIN { _FIN(id reth) : rethrow(reth) {}\n"; 1849 buf += "\t~_FIN() { if (rethrow) objc_exception_throw(rethrow); }\n"; 1850 buf += "\tid rethrow;\n"; 1851 buf += "\t} _fin_force_rethow(_rethrow);"; 1852 } 1853 1854 /// RewriteObjCSynchronizedStmt - 1855 /// This routine rewrites @synchronized(expr) stmt; 1856 /// into: 1857 /// objc_sync_enter(expr); 1858 /// @try stmt @finally { objc_sync_exit(expr); } 1859 /// 1860 Stmt *RewriteModernObjC::RewriteObjCSynchronizedStmt(ObjCAtSynchronizedStmt *S) { 1861 // Get the start location and compute the semi location. 1862 SourceLocation startLoc = S->getLocStart(); 1863 const char *startBuf = SM->getCharacterData(startLoc); 1864 1865 assert((*startBuf == '@') && "bogus @synchronized location"); 1866 1867 std::string buf; 1868 SourceLocation SynchLoc = S->getAtSynchronizedLoc(); 1869 ConvertSourceLocationToLineDirective(SynchLoc, buf); 1870 buf += "{ id _rethrow = 0; id _sync_obj = (id)"; 1871 1872 const char *lparenBuf = startBuf; 1873 while (*lparenBuf != '(') lparenBuf++; 1874 ReplaceText(startLoc, lparenBuf-startBuf+1, buf); 1875 1876 buf = "; objc_sync_enter(_sync_obj);\n"; 1877 buf += "try {\n\tstruct _SYNC_EXIT { _SYNC_EXIT(id arg) : sync_exit(arg) {}"; 1878 buf += "\n\t~_SYNC_EXIT() {objc_sync_exit(sync_exit);}"; 1879 buf += "\n\tid sync_exit;"; 1880 buf += "\n\t} _sync_exit(_sync_obj);\n"; 1881 1882 // We can't use S->getSynchExpr()->getLocEnd() to find the end location, since 1883 // the sync expression is typically a message expression that's already 1884 // been rewritten! (which implies the SourceLocation's are invalid). 1885 SourceLocation RParenExprLoc = S->getSynchBody()->getLocStart(); 1886 const char *RParenExprLocBuf = SM->getCharacterData(RParenExprLoc); 1887 while (*RParenExprLocBuf != ')') RParenExprLocBuf--; 1888 RParenExprLoc = startLoc.getLocWithOffset(RParenExprLocBuf-startBuf); 1889 1890 SourceLocation LBranceLoc = S->getSynchBody()->getLocStart(); 1891 const char *LBraceLocBuf = SM->getCharacterData(LBranceLoc); 1892 assert (*LBraceLocBuf == '{'); 1893 ReplaceText(RParenExprLoc, (LBraceLocBuf - SM->getCharacterData(RParenExprLoc) + 1), buf); 1894 1895 SourceLocation startRBraceLoc = S->getSynchBody()->getLocEnd(); 1896 assert((*SM->getCharacterData(startRBraceLoc) == '}') && 1897 "bogus @synchronized block"); 1898 1899 buf = "} catch (id e) {_rethrow = e;}\n"; 1900 Write_RethrowObject(buf); 1901 buf += "}\n"; 1902 buf += "}\n"; 1903 1904 ReplaceText(startRBraceLoc, 1, buf); 1905 1906 return nullptr; 1907 } 1908 1909 void RewriteModernObjC::WarnAboutReturnGotoStmts(Stmt *S) 1910 { 1911 // Perform a bottom up traversal of all children. 1912 for (Stmt *SubStmt : S->children()) 1913 if (SubStmt) 1914 WarnAboutReturnGotoStmts(SubStmt); 1915 1916 if (isa<ReturnStmt>(S) || isa<GotoStmt>(S)) { 1917 Diags.Report(Context->getFullLoc(S->getLocStart()), 1918 TryFinallyContainsReturnDiag); 1919 } 1920 } 1921 1922 Stmt *RewriteModernObjC::RewriteObjCAutoreleasePoolStmt(ObjCAutoreleasePoolStmt *S) { 1923 SourceLocation startLoc = S->getAtLoc(); 1924 ReplaceText(startLoc, strlen("@autoreleasepool"), "/* @autoreleasepool */"); 1925 ReplaceText(S->getSubStmt()->getLocStart(), 1, 1926 "{ __AtAutoreleasePool __autoreleasepool; "); 1927 1928 return nullptr; 1929 } 1930 1931 Stmt *RewriteModernObjC::RewriteObjCTryStmt(ObjCAtTryStmt *S) { 1932 ObjCAtFinallyStmt *finalStmt = S->getFinallyStmt(); 1933 bool noCatch = S->getNumCatchStmts() == 0; 1934 std::string buf; 1935 SourceLocation TryLocation = S->getAtTryLoc(); 1936 ConvertSourceLocationToLineDirective(TryLocation, buf); 1937 1938 if (finalStmt) { 1939 if (noCatch) 1940 buf += "{ id volatile _rethrow = 0;\n"; 1941 else { 1942 buf += "{ id volatile _rethrow = 0;\ntry {\n"; 1943 } 1944 } 1945 // Get the start location and compute the semi location. 1946 SourceLocation startLoc = S->getLocStart(); 1947 const char *startBuf = SM->getCharacterData(startLoc); 1948 1949 assert((*startBuf == '@') && "bogus @try location"); 1950 if (finalStmt) 1951 ReplaceText(startLoc, 1, buf); 1952 else 1953 // @try -> try 1954 ReplaceText(startLoc, 1, ""); 1955 1956 for (unsigned I = 0, N = S->getNumCatchStmts(); I != N; ++I) { 1957 ObjCAtCatchStmt *Catch = S->getCatchStmt(I); 1958 VarDecl *catchDecl = Catch->getCatchParamDecl(); 1959 1960 startLoc = Catch->getLocStart(); 1961 bool AtRemoved = false; 1962 if (catchDecl) { 1963 QualType t = catchDecl->getType(); 1964 if (const ObjCObjectPointerType *Ptr = t->getAs<ObjCObjectPointerType>()) { 1965 // Should be a pointer to a class. 1966 ObjCInterfaceDecl *IDecl = Ptr->getObjectType()->getInterface(); 1967 if (IDecl) { 1968 std::string Result; 1969 ConvertSourceLocationToLineDirective(Catch->getLocStart(), Result); 1970 1971 startBuf = SM->getCharacterData(startLoc); 1972 assert((*startBuf == '@') && "bogus @catch location"); 1973 SourceLocation rParenLoc = Catch->getRParenLoc(); 1974 const char *rParenBuf = SM->getCharacterData(rParenLoc); 1975 1976 // _objc_exc_Foo *_e as argument to catch. 1977 Result += "catch (_objc_exc_"; Result += IDecl->getNameAsString(); 1978 Result += " *_"; Result += catchDecl->getNameAsString(); 1979 Result += ")"; 1980 ReplaceText(startLoc, rParenBuf-startBuf+1, Result); 1981 // Foo *e = (Foo *)_e; 1982 Result.clear(); 1983 Result = "{ "; 1984 Result += IDecl->getNameAsString(); 1985 Result += " *"; Result += catchDecl->getNameAsString(); 1986 Result += " = ("; Result += IDecl->getNameAsString(); Result += "*)"; 1987 Result += "_"; Result += catchDecl->getNameAsString(); 1988 1989 Result += "; "; 1990 SourceLocation lBraceLoc = Catch->getCatchBody()->getLocStart(); 1991 ReplaceText(lBraceLoc, 1, Result); 1992 AtRemoved = true; 1993 } 1994 } 1995 } 1996 if (!AtRemoved) 1997 // @catch -> catch 1998 ReplaceText(startLoc, 1, ""); 1999 2000 } 2001 if (finalStmt) { 2002 buf.clear(); 2003 SourceLocation FinallyLoc = finalStmt->getLocStart(); 2004 2005 if (noCatch) { 2006 ConvertSourceLocationToLineDirective(FinallyLoc, buf); 2007 buf += "catch (id e) {_rethrow = e;}\n"; 2008 } 2009 else { 2010 buf += "}\n"; 2011 ConvertSourceLocationToLineDirective(FinallyLoc, buf); 2012 buf += "catch (id e) {_rethrow = e;}\n"; 2013 } 2014 2015 SourceLocation startFinalLoc = finalStmt->getLocStart(); 2016 ReplaceText(startFinalLoc, 8, buf); 2017 Stmt *body = finalStmt->getFinallyBody(); 2018 SourceLocation startFinalBodyLoc = body->getLocStart(); 2019 buf.clear(); 2020 Write_RethrowObject(buf); 2021 ReplaceText(startFinalBodyLoc, 1, buf); 2022 2023 SourceLocation endFinalBodyLoc = body->getLocEnd(); 2024 ReplaceText(endFinalBodyLoc, 1, "}\n}"); 2025 // Now check for any return/continue/go statements within the @try. 2026 WarnAboutReturnGotoStmts(S->getTryBody()); 2027 } 2028 2029 return nullptr; 2030 } 2031 2032 // This can't be done with ReplaceStmt(S, ThrowExpr), since 2033 // the throw expression is typically a message expression that's already 2034 // been rewritten! (which implies the SourceLocation's are invalid). 2035 Stmt *RewriteModernObjC::RewriteObjCThrowStmt(ObjCAtThrowStmt *S) { 2036 // Get the start location and compute the semi location. 2037 SourceLocation startLoc = S->getLocStart(); 2038 const char *startBuf = SM->getCharacterData(startLoc); 2039 2040 assert((*startBuf == '@') && "bogus @throw location"); 2041 2042 std::string buf; 2043 /* void objc_exception_throw(id) __attribute__((noreturn)); */ 2044 if (S->getThrowExpr()) 2045 buf = "objc_exception_throw("; 2046 else 2047 buf = "throw"; 2048 2049 // handle "@ throw" correctly. 2050 const char *wBuf = strchr(startBuf, 'w'); 2051 assert((*wBuf == 'w') && "@throw: can't find 'w'"); 2052 ReplaceText(startLoc, wBuf-startBuf+1, buf); 2053 2054 SourceLocation endLoc = S->getLocEnd(); 2055 const char *endBuf = SM->getCharacterData(endLoc); 2056 const char *semiBuf = strchr(endBuf, ';'); 2057 assert((*semiBuf == ';') && "@throw: can't find ';'"); 2058 SourceLocation semiLoc = startLoc.getLocWithOffset(semiBuf-startBuf); 2059 if (S->getThrowExpr()) 2060 ReplaceText(semiLoc, 1, ");"); 2061 return nullptr; 2062 } 2063 2064 Stmt *RewriteModernObjC::RewriteAtEncode(ObjCEncodeExpr *Exp) { 2065 // Create a new string expression. 2066 std::string StrEncoding; 2067 Context->getObjCEncodingForType(Exp->getEncodedType(), StrEncoding); 2068 Expr *Replacement = getStringLiteral(StrEncoding); 2069 ReplaceStmt(Exp, Replacement); 2070 2071 // Replace this subexpr in the parent. 2072 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 2073 return Replacement; 2074 } 2075 2076 Stmt *RewriteModernObjC::RewriteAtSelector(ObjCSelectorExpr *Exp) { 2077 if (!SelGetUidFunctionDecl) 2078 SynthSelGetUidFunctionDecl(); 2079 assert(SelGetUidFunctionDecl && "Can't find sel_registerName() decl"); 2080 // Create a call to sel_registerName("selName"). 2081 SmallVector<Expr*, 8> SelExprs; 2082 SelExprs.push_back(getStringLiteral(Exp->getSelector().getAsString())); 2083 CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl, 2084 SelExprs); 2085 ReplaceStmt(Exp, SelExp); 2086 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 2087 return SelExp; 2088 } 2089 2090 CallExpr * 2091 RewriteModernObjC::SynthesizeCallToFunctionDecl(FunctionDecl *FD, 2092 ArrayRef<Expr *> Args, 2093 SourceLocation StartLoc, 2094 SourceLocation EndLoc) { 2095 // Get the type, we will need to reference it in a couple spots. 2096 QualType msgSendType = FD->getType(); 2097 2098 // Create a reference to the objc_msgSend() declaration. 2099 DeclRefExpr *DRE = 2100 new (Context) DeclRefExpr(FD, false, msgSendType, VK_LValue, SourceLocation()); 2101 2102 // Now, we cast the reference to a pointer to the objc_msgSend type. 2103 QualType pToFunc = Context->getPointerType(msgSendType); 2104 ImplicitCastExpr *ICE = 2105 ImplicitCastExpr::Create(*Context, pToFunc, CK_FunctionToPointerDecay, 2106 DRE, nullptr, VK_RValue); 2107 2108 const FunctionType *FT = msgSendType->getAs<FunctionType>(); 2109 2110 CallExpr *Exp = new (Context) CallExpr(*Context, ICE, Args, 2111 FT->getCallResultType(*Context), 2112 VK_RValue, EndLoc); 2113 return Exp; 2114 } 2115 2116 static bool scanForProtocolRefs(const char *startBuf, const char *endBuf, 2117 const char *&startRef, const char *&endRef) { 2118 while (startBuf < endBuf) { 2119 if (*startBuf == '<') 2120 startRef = startBuf; // mark the start. 2121 if (*startBuf == '>') { 2122 if (startRef && *startRef == '<') { 2123 endRef = startBuf; // mark the end. 2124 return true; 2125 } 2126 return false; 2127 } 2128 startBuf++; 2129 } 2130 return false; 2131 } 2132 2133 static void scanToNextArgument(const char *&argRef) { 2134 int angle = 0; 2135 while (*argRef != ')' && (*argRef != ',' || angle > 0)) { 2136 if (*argRef == '<') 2137 angle++; 2138 else if (*argRef == '>') 2139 angle--; 2140 argRef++; 2141 } 2142 assert(angle == 0 && "scanToNextArgument - bad protocol type syntax"); 2143 } 2144 2145 bool RewriteModernObjC::needToScanForQualifiers(QualType T) { 2146 if (T->isObjCQualifiedIdType()) 2147 return true; 2148 if (const PointerType *PT = T->getAs<PointerType>()) { 2149 if (PT->getPointeeType()->isObjCQualifiedIdType()) 2150 return true; 2151 } 2152 if (T->isObjCObjectPointerType()) { 2153 T = T->getPointeeType(); 2154 return T->isObjCQualifiedInterfaceType(); 2155 } 2156 if (T->isArrayType()) { 2157 QualType ElemTy = Context->getBaseElementType(T); 2158 return needToScanForQualifiers(ElemTy); 2159 } 2160 return false; 2161 } 2162 2163 void RewriteModernObjC::RewriteObjCQualifiedInterfaceTypes(Expr *E) { 2164 QualType Type = E->getType(); 2165 if (needToScanForQualifiers(Type)) { 2166 SourceLocation Loc, EndLoc; 2167 2168 if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E)) { 2169 Loc = ECE->getLParenLoc(); 2170 EndLoc = ECE->getRParenLoc(); 2171 } else { 2172 Loc = E->getLocStart(); 2173 EndLoc = E->getLocEnd(); 2174 } 2175 // This will defend against trying to rewrite synthesized expressions. 2176 if (Loc.isInvalid() || EndLoc.isInvalid()) 2177 return; 2178 2179 const char *startBuf = SM->getCharacterData(Loc); 2180 const char *endBuf = SM->getCharacterData(EndLoc); 2181 const char *startRef = nullptr, *endRef = nullptr; 2182 if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) { 2183 // Get the locations of the startRef, endRef. 2184 SourceLocation LessLoc = Loc.getLocWithOffset(startRef-startBuf); 2185 SourceLocation GreaterLoc = Loc.getLocWithOffset(endRef-startBuf+1); 2186 // Comment out the protocol references. 2187 InsertText(LessLoc, "/*"); 2188 InsertText(GreaterLoc, "*/"); 2189 } 2190 } 2191 } 2192 2193 void RewriteModernObjC::RewriteObjCQualifiedInterfaceTypes(Decl *Dcl) { 2194 SourceLocation Loc; 2195 QualType Type; 2196 const FunctionProtoType *proto = nullptr; 2197 if (VarDecl *VD = dyn_cast<VarDecl>(Dcl)) { 2198 Loc = VD->getLocation(); 2199 Type = VD->getType(); 2200 } 2201 else if (FunctionDecl *FD = dyn_cast<FunctionDecl>(Dcl)) { 2202 Loc = FD->getLocation(); 2203 // Check for ObjC 'id' and class types that have been adorned with protocol 2204 // information (id<p>, C<p>*). The protocol references need to be rewritten! 2205 const FunctionType *funcType = FD->getType()->getAs<FunctionType>(); 2206 assert(funcType && "missing function type"); 2207 proto = dyn_cast<FunctionProtoType>(funcType); 2208 if (!proto) 2209 return; 2210 Type = proto->getReturnType(); 2211 } 2212 else if (FieldDecl *FD = dyn_cast<FieldDecl>(Dcl)) { 2213 Loc = FD->getLocation(); 2214 Type = FD->getType(); 2215 } 2216 else if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(Dcl)) { 2217 Loc = TD->getLocation(); 2218 Type = TD->getUnderlyingType(); 2219 } 2220 else 2221 return; 2222 2223 if (needToScanForQualifiers(Type)) { 2224 // Since types are unique, we need to scan the buffer. 2225 2226 const char *endBuf = SM->getCharacterData(Loc); 2227 const char *startBuf = endBuf; 2228 while (*startBuf != ';' && *startBuf != '<' && startBuf != MainFileStart) 2229 startBuf--; // scan backward (from the decl location) for return type. 2230 const char *startRef = nullptr, *endRef = nullptr; 2231 if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) { 2232 // Get the locations of the startRef, endRef. 2233 SourceLocation LessLoc = Loc.getLocWithOffset(startRef-endBuf); 2234 SourceLocation GreaterLoc = Loc.getLocWithOffset(endRef-endBuf+1); 2235 // Comment out the protocol references. 2236 InsertText(LessLoc, "/*"); 2237 InsertText(GreaterLoc, "*/"); 2238 } 2239 } 2240 if (!proto) 2241 return; // most likely, was a variable 2242 // Now check arguments. 2243 const char *startBuf = SM->getCharacterData(Loc); 2244 const char *startFuncBuf = startBuf; 2245 for (unsigned i = 0; i < proto->getNumParams(); i++) { 2246 if (needToScanForQualifiers(proto->getParamType(i))) { 2247 // Since types are unique, we need to scan the buffer. 2248 2249 const char *endBuf = startBuf; 2250 // scan forward (from the decl location) for argument types. 2251 scanToNextArgument(endBuf); 2252 const char *startRef = nullptr, *endRef = nullptr; 2253 if (scanForProtocolRefs(startBuf, endBuf, startRef, endRef)) { 2254 // Get the locations of the startRef, endRef. 2255 SourceLocation LessLoc = 2256 Loc.getLocWithOffset(startRef-startFuncBuf); 2257 SourceLocation GreaterLoc = 2258 Loc.getLocWithOffset(endRef-startFuncBuf+1); 2259 // Comment out the protocol references. 2260 InsertText(LessLoc, "/*"); 2261 InsertText(GreaterLoc, "*/"); 2262 } 2263 startBuf = ++endBuf; 2264 } 2265 else { 2266 // If the function name is derived from a macro expansion, then the 2267 // argument buffer will not follow the name. Need to speak with Chris. 2268 while (*startBuf && *startBuf != ')' && *startBuf != ',') 2269 startBuf++; // scan forward (from the decl location) for argument types. 2270 startBuf++; 2271 } 2272 } 2273 } 2274 2275 void RewriteModernObjC::RewriteTypeOfDecl(VarDecl *ND) { 2276 QualType QT = ND->getType(); 2277 const Type* TypePtr = QT->getAs<Type>(); 2278 if (!isa<TypeOfExprType>(TypePtr)) 2279 return; 2280 while (isa<TypeOfExprType>(TypePtr)) { 2281 const TypeOfExprType *TypeOfExprTypePtr = cast<TypeOfExprType>(TypePtr); 2282 QT = TypeOfExprTypePtr->getUnderlyingExpr()->getType(); 2283 TypePtr = QT->getAs<Type>(); 2284 } 2285 // FIXME. This will not work for multiple declarators; as in: 2286 // __typeof__(a) b,c,d; 2287 std::string TypeAsString(QT.getAsString(Context->getPrintingPolicy())); 2288 SourceLocation DeclLoc = ND->getTypeSpecStartLoc(); 2289 const char *startBuf = SM->getCharacterData(DeclLoc); 2290 if (ND->getInit()) { 2291 std::string Name(ND->getNameAsString()); 2292 TypeAsString += " " + Name + " = "; 2293 Expr *E = ND->getInit(); 2294 SourceLocation startLoc; 2295 if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E)) 2296 startLoc = ECE->getLParenLoc(); 2297 else 2298 startLoc = E->getLocStart(); 2299 startLoc = SM->getExpansionLoc(startLoc); 2300 const char *endBuf = SM->getCharacterData(startLoc); 2301 ReplaceText(DeclLoc, endBuf-startBuf-1, TypeAsString); 2302 } 2303 else { 2304 SourceLocation X = ND->getLocEnd(); 2305 X = SM->getExpansionLoc(X); 2306 const char *endBuf = SM->getCharacterData(X); 2307 ReplaceText(DeclLoc, endBuf-startBuf-1, TypeAsString); 2308 } 2309 } 2310 2311 // SynthSelGetUidFunctionDecl - SEL sel_registerName(const char *str); 2312 void RewriteModernObjC::SynthSelGetUidFunctionDecl() { 2313 IdentifierInfo *SelGetUidIdent = &Context->Idents.get("sel_registerName"); 2314 SmallVector<QualType, 16> ArgTys; 2315 ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst())); 2316 QualType getFuncType = 2317 getSimpleFunctionType(Context->getObjCSelType(), ArgTys); 2318 SelGetUidFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2319 SourceLocation(), 2320 SourceLocation(), 2321 SelGetUidIdent, getFuncType, 2322 nullptr, SC_Extern); 2323 } 2324 2325 void RewriteModernObjC::RewriteFunctionDecl(FunctionDecl *FD) { 2326 // declared in <objc/objc.h> 2327 if (FD->getIdentifier() && 2328 FD->getName() == "sel_registerName") { 2329 SelGetUidFunctionDecl = FD; 2330 return; 2331 } 2332 RewriteObjCQualifiedInterfaceTypes(FD); 2333 } 2334 2335 void RewriteModernObjC::RewriteBlockPointerType(std::string& Str, QualType Type) { 2336 std::string TypeString(Type.getAsString(Context->getPrintingPolicy())); 2337 const char *argPtr = TypeString.c_str(); 2338 if (!strchr(argPtr, '^')) { 2339 Str += TypeString; 2340 return; 2341 } 2342 while (*argPtr) { 2343 Str += (*argPtr == '^' ? '*' : *argPtr); 2344 argPtr++; 2345 } 2346 } 2347 2348 // FIXME. Consolidate this routine with RewriteBlockPointerType. 2349 void RewriteModernObjC::RewriteBlockPointerTypeVariable(std::string& Str, 2350 ValueDecl *VD) { 2351 QualType Type = VD->getType(); 2352 std::string TypeString(Type.getAsString(Context->getPrintingPolicy())); 2353 const char *argPtr = TypeString.c_str(); 2354 int paren = 0; 2355 while (*argPtr) { 2356 switch (*argPtr) { 2357 case '(': 2358 Str += *argPtr; 2359 paren++; 2360 break; 2361 case ')': 2362 Str += *argPtr; 2363 paren--; 2364 break; 2365 case '^': 2366 Str += '*'; 2367 if (paren == 1) 2368 Str += VD->getNameAsString(); 2369 break; 2370 default: 2371 Str += *argPtr; 2372 break; 2373 } 2374 argPtr++; 2375 } 2376 } 2377 2378 void RewriteModernObjC::RewriteBlockLiteralFunctionDecl(FunctionDecl *FD) { 2379 SourceLocation FunLocStart = FD->getTypeSpecStartLoc(); 2380 const FunctionType *funcType = FD->getType()->getAs<FunctionType>(); 2381 const FunctionProtoType *proto = dyn_cast<FunctionProtoType>(funcType); 2382 if (!proto) 2383 return; 2384 QualType Type = proto->getReturnType(); 2385 std::string FdStr = Type.getAsString(Context->getPrintingPolicy()); 2386 FdStr += " "; 2387 FdStr += FD->getName(); 2388 FdStr += "("; 2389 unsigned numArgs = proto->getNumParams(); 2390 for (unsigned i = 0; i < numArgs; i++) { 2391 QualType ArgType = proto->getParamType(i); 2392 RewriteBlockPointerType(FdStr, ArgType); 2393 if (i+1 < numArgs) 2394 FdStr += ", "; 2395 } 2396 if (FD->isVariadic()) { 2397 FdStr += (numArgs > 0) ? ", ...);\n" : "...);\n"; 2398 } 2399 else 2400 FdStr += ");\n"; 2401 InsertText(FunLocStart, FdStr); 2402 } 2403 2404 // SynthSuperConstructorFunctionDecl - id __rw_objc_super(id obj, id super); 2405 void RewriteModernObjC::SynthSuperConstructorFunctionDecl() { 2406 if (SuperConstructorFunctionDecl) 2407 return; 2408 IdentifierInfo *msgSendIdent = &Context->Idents.get("__rw_objc_super"); 2409 SmallVector<QualType, 16> ArgTys; 2410 QualType argT = Context->getObjCIdType(); 2411 assert(!argT.isNull() && "Can't find 'id' type"); 2412 ArgTys.push_back(argT); 2413 ArgTys.push_back(argT); 2414 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2415 ArgTys); 2416 SuperConstructorFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2417 SourceLocation(), 2418 SourceLocation(), 2419 msgSendIdent, msgSendType, 2420 nullptr, SC_Extern); 2421 } 2422 2423 // SynthMsgSendFunctionDecl - id objc_msgSend(id self, SEL op, ...); 2424 void RewriteModernObjC::SynthMsgSendFunctionDecl() { 2425 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend"); 2426 SmallVector<QualType, 16> ArgTys; 2427 QualType argT = Context->getObjCIdType(); 2428 assert(!argT.isNull() && "Can't find 'id' type"); 2429 ArgTys.push_back(argT); 2430 argT = Context->getObjCSelType(); 2431 assert(!argT.isNull() && "Can't find 'SEL' type"); 2432 ArgTys.push_back(argT); 2433 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2434 ArgTys, /*isVariadic=*/true); 2435 MsgSendFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2436 SourceLocation(), 2437 SourceLocation(), 2438 msgSendIdent, msgSendType, nullptr, 2439 SC_Extern); 2440 } 2441 2442 // SynthMsgSendSuperFunctionDecl - id objc_msgSendSuper(void); 2443 void RewriteModernObjC::SynthMsgSendSuperFunctionDecl() { 2444 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSendSuper"); 2445 SmallVector<QualType, 2> ArgTys; 2446 ArgTys.push_back(Context->VoidTy); 2447 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2448 ArgTys, /*isVariadic=*/true); 2449 MsgSendSuperFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2450 SourceLocation(), 2451 SourceLocation(), 2452 msgSendIdent, msgSendType, 2453 nullptr, SC_Extern); 2454 } 2455 2456 // SynthMsgSendStretFunctionDecl - id objc_msgSend_stret(id self, SEL op, ...); 2457 void RewriteModernObjC::SynthMsgSendStretFunctionDecl() { 2458 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend_stret"); 2459 SmallVector<QualType, 16> ArgTys; 2460 QualType argT = Context->getObjCIdType(); 2461 assert(!argT.isNull() && "Can't find 'id' type"); 2462 ArgTys.push_back(argT); 2463 argT = Context->getObjCSelType(); 2464 assert(!argT.isNull() && "Can't find 'SEL' type"); 2465 ArgTys.push_back(argT); 2466 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2467 ArgTys, /*isVariadic=*/true); 2468 MsgSendStretFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2469 SourceLocation(), 2470 SourceLocation(), 2471 msgSendIdent, msgSendType, 2472 nullptr, SC_Extern); 2473 } 2474 2475 // SynthMsgSendSuperStretFunctionDecl - 2476 // id objc_msgSendSuper_stret(void); 2477 void RewriteModernObjC::SynthMsgSendSuperStretFunctionDecl() { 2478 IdentifierInfo *msgSendIdent = 2479 &Context->Idents.get("objc_msgSendSuper_stret"); 2480 SmallVector<QualType, 2> ArgTys; 2481 ArgTys.push_back(Context->VoidTy); 2482 QualType msgSendType = getSimpleFunctionType(Context->getObjCIdType(), 2483 ArgTys, /*isVariadic=*/true); 2484 MsgSendSuperStretFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2485 SourceLocation(), 2486 SourceLocation(), 2487 msgSendIdent, 2488 msgSendType, nullptr, 2489 SC_Extern); 2490 } 2491 2492 // SynthMsgSendFpretFunctionDecl - double objc_msgSend_fpret(id self, SEL op, ...); 2493 void RewriteModernObjC::SynthMsgSendFpretFunctionDecl() { 2494 IdentifierInfo *msgSendIdent = &Context->Idents.get("objc_msgSend_fpret"); 2495 SmallVector<QualType, 16> ArgTys; 2496 QualType argT = Context->getObjCIdType(); 2497 assert(!argT.isNull() && "Can't find 'id' type"); 2498 ArgTys.push_back(argT); 2499 argT = Context->getObjCSelType(); 2500 assert(!argT.isNull() && "Can't find 'SEL' type"); 2501 ArgTys.push_back(argT); 2502 QualType msgSendType = getSimpleFunctionType(Context->DoubleTy, 2503 ArgTys, /*isVariadic=*/true); 2504 MsgSendFpretFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2505 SourceLocation(), 2506 SourceLocation(), 2507 msgSendIdent, msgSendType, 2508 nullptr, SC_Extern); 2509 } 2510 2511 // SynthGetClassFunctionDecl - Class objc_getClass(const char *name); 2512 void RewriteModernObjC::SynthGetClassFunctionDecl() { 2513 IdentifierInfo *getClassIdent = &Context->Idents.get("objc_getClass"); 2514 SmallVector<QualType, 16> ArgTys; 2515 ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst())); 2516 QualType getClassType = getSimpleFunctionType(Context->getObjCClassType(), 2517 ArgTys); 2518 GetClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2519 SourceLocation(), 2520 SourceLocation(), 2521 getClassIdent, getClassType, 2522 nullptr, SC_Extern); 2523 } 2524 2525 // SynthGetSuperClassFunctionDecl - Class class_getSuperclass(Class cls); 2526 void RewriteModernObjC::SynthGetSuperClassFunctionDecl() { 2527 IdentifierInfo *getSuperClassIdent = 2528 &Context->Idents.get("class_getSuperclass"); 2529 SmallVector<QualType, 16> ArgTys; 2530 ArgTys.push_back(Context->getObjCClassType()); 2531 QualType getClassType = getSimpleFunctionType(Context->getObjCClassType(), 2532 ArgTys); 2533 GetSuperClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2534 SourceLocation(), 2535 SourceLocation(), 2536 getSuperClassIdent, 2537 getClassType, nullptr, 2538 SC_Extern); 2539 } 2540 2541 // SynthGetMetaClassFunctionDecl - Class objc_getMetaClass(const char *name); 2542 void RewriteModernObjC::SynthGetMetaClassFunctionDecl() { 2543 IdentifierInfo *getClassIdent = &Context->Idents.get("objc_getMetaClass"); 2544 SmallVector<QualType, 16> ArgTys; 2545 ArgTys.push_back(Context->getPointerType(Context->CharTy.withConst())); 2546 QualType getClassType = getSimpleFunctionType(Context->getObjCClassType(), 2547 ArgTys); 2548 GetMetaClassFunctionDecl = FunctionDecl::Create(*Context, TUDecl, 2549 SourceLocation(), 2550 SourceLocation(), 2551 getClassIdent, getClassType, 2552 nullptr, SC_Extern); 2553 } 2554 2555 Stmt *RewriteModernObjC::RewriteObjCStringLiteral(ObjCStringLiteral *Exp) { 2556 assert (Exp != nullptr && "Expected non-null ObjCStringLiteral"); 2557 QualType strType = getConstantStringStructType(); 2558 2559 std::string S = "__NSConstantStringImpl_"; 2560 2561 std::string tmpName = InFileName; 2562 unsigned i; 2563 for (i=0; i < tmpName.length(); i++) { 2564 char c = tmpName.at(i); 2565 // replace any non-alphanumeric characters with '_'. 2566 if (!isAlphanumeric(c)) 2567 tmpName[i] = '_'; 2568 } 2569 S += tmpName; 2570 S += "_"; 2571 S += utostr(NumObjCStringLiterals++); 2572 2573 Preamble += "static __NSConstantStringImpl " + S; 2574 Preamble += " __attribute__ ((section (\"__DATA, __cfstring\"))) = {__CFConstantStringClassReference,"; 2575 Preamble += "0x000007c8,"; // utf8_str 2576 // The pretty printer for StringLiteral handles escape characters properly. 2577 std::string prettyBufS; 2578 llvm::raw_string_ostream prettyBuf(prettyBufS); 2579 Exp->getString()->printPretty(prettyBuf, nullptr, PrintingPolicy(LangOpts)); 2580 Preamble += prettyBuf.str(); 2581 Preamble += ","; 2582 Preamble += utostr(Exp->getString()->getByteLength()) + "};\n"; 2583 2584 VarDecl *NewVD = VarDecl::Create(*Context, TUDecl, SourceLocation(), 2585 SourceLocation(), &Context->Idents.get(S), 2586 strType, nullptr, SC_Static); 2587 DeclRefExpr *DRE = new (Context) DeclRefExpr(NewVD, false, strType, VK_LValue, 2588 SourceLocation()); 2589 Expr *Unop = new (Context) UnaryOperator(DRE, UO_AddrOf, 2590 Context->getPointerType(DRE->getType()), 2591 VK_RValue, OK_Ordinary, 2592 SourceLocation()); 2593 // cast to NSConstantString * 2594 CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, Exp->getType(), 2595 CK_CPointerToObjCPointerCast, Unop); 2596 ReplaceStmt(Exp, cast); 2597 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 2598 return cast; 2599 } 2600 2601 Stmt *RewriteModernObjC::RewriteObjCBoolLiteralExpr(ObjCBoolLiteralExpr *Exp) { 2602 unsigned IntSize = 2603 static_cast<unsigned>(Context->getTypeSize(Context->IntTy)); 2604 2605 Expr *FlagExp = IntegerLiteral::Create(*Context, 2606 llvm::APInt(IntSize, Exp->getValue()), 2607 Context->IntTy, Exp->getLocation()); 2608 CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, Context->ObjCBuiltinBoolTy, 2609 CK_BitCast, FlagExp); 2610 ParenExpr *PE = new (Context) ParenExpr(Exp->getLocation(), Exp->getExprLoc(), 2611 cast); 2612 ReplaceStmt(Exp, PE); 2613 return PE; 2614 } 2615 2616 Stmt *RewriteModernObjC::RewriteObjCBoxedExpr(ObjCBoxedExpr *Exp) { 2617 // synthesize declaration of helper functions needed in this routine. 2618 if (!SelGetUidFunctionDecl) 2619 SynthSelGetUidFunctionDecl(); 2620 // use objc_msgSend() for all. 2621 if (!MsgSendFunctionDecl) 2622 SynthMsgSendFunctionDecl(); 2623 if (!GetClassFunctionDecl) 2624 SynthGetClassFunctionDecl(); 2625 2626 FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl; 2627 SourceLocation StartLoc = Exp->getLocStart(); 2628 SourceLocation EndLoc = Exp->getLocEnd(); 2629 2630 // Synthesize a call to objc_msgSend(). 2631 SmallVector<Expr*, 4> MsgExprs; 2632 SmallVector<Expr*, 4> ClsExprs; 2633 2634 // Create a call to objc_getClass("<BoxingClass>"). It will be the 1st argument. 2635 ObjCMethodDecl *BoxingMethod = Exp->getBoxingMethod(); 2636 ObjCInterfaceDecl *BoxingClass = BoxingMethod->getClassInterface(); 2637 2638 IdentifierInfo *clsName = BoxingClass->getIdentifier(); 2639 ClsExprs.push_back(getStringLiteral(clsName->getName())); 2640 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs, 2641 StartLoc, EndLoc); 2642 MsgExprs.push_back(Cls); 2643 2644 // Create a call to sel_registerName("<BoxingMethod>:"), etc. 2645 // it will be the 2nd argument. 2646 SmallVector<Expr*, 4> SelExprs; 2647 SelExprs.push_back( 2648 getStringLiteral(BoxingMethod->getSelector().getAsString())); 2649 CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl, 2650 SelExprs, StartLoc, EndLoc); 2651 MsgExprs.push_back(SelExp); 2652 2653 // User provided sub-expression is the 3rd, and last, argument. 2654 Expr *subExpr = Exp->getSubExpr(); 2655 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(subExpr)) { 2656 QualType type = ICE->getType(); 2657 const Expr *SubExpr = ICE->IgnoreParenImpCasts(); 2658 CastKind CK = CK_BitCast; 2659 if (SubExpr->getType()->isIntegralType(*Context) && type->isBooleanType()) 2660 CK = CK_IntegralToBoolean; 2661 subExpr = NoTypeInfoCStyleCastExpr(Context, type, CK, subExpr); 2662 } 2663 MsgExprs.push_back(subExpr); 2664 2665 SmallVector<QualType, 4> ArgTypes; 2666 ArgTypes.push_back(Context->getObjCClassType()); 2667 ArgTypes.push_back(Context->getObjCSelType()); 2668 for (const auto PI : BoxingMethod->parameters()) 2669 ArgTypes.push_back(PI->getType()); 2670 2671 QualType returnType = Exp->getType(); 2672 // Get the type, we will need to reference it in a couple spots. 2673 QualType msgSendType = MsgSendFlavor->getType(); 2674 2675 // Create a reference to the objc_msgSend() declaration. 2676 DeclRefExpr *DRE = new (Context) DeclRefExpr(MsgSendFlavor, false, msgSendType, 2677 VK_LValue, SourceLocation()); 2678 2679 CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, 2680 Context->getPointerType(Context->VoidTy), 2681 CK_BitCast, DRE); 2682 2683 // Now do the "normal" pointer to function cast. 2684 QualType castType = 2685 getSimpleFunctionType(returnType, ArgTypes, BoxingMethod->isVariadic()); 2686 castType = Context->getPointerType(castType); 2687 cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast, 2688 cast); 2689 2690 // Don't forget the parens to enforce the proper binding. 2691 ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast); 2692 2693 const FunctionType *FT = msgSendType->getAs<FunctionType>(); 2694 CallExpr *CE = new (Context) 2695 CallExpr(*Context, PE, MsgExprs, FT->getReturnType(), VK_RValue, EndLoc); 2696 ReplaceStmt(Exp, CE); 2697 return CE; 2698 } 2699 2700 Stmt *RewriteModernObjC::RewriteObjCArrayLiteralExpr(ObjCArrayLiteral *Exp) { 2701 // synthesize declaration of helper functions needed in this routine. 2702 if (!SelGetUidFunctionDecl) 2703 SynthSelGetUidFunctionDecl(); 2704 // use objc_msgSend() for all. 2705 if (!MsgSendFunctionDecl) 2706 SynthMsgSendFunctionDecl(); 2707 if (!GetClassFunctionDecl) 2708 SynthGetClassFunctionDecl(); 2709 2710 FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl; 2711 SourceLocation StartLoc = Exp->getLocStart(); 2712 SourceLocation EndLoc = Exp->getLocEnd(); 2713 2714 // Build the expression: __NSContainer_literal(int, ...).arr 2715 QualType IntQT = Context->IntTy; 2716 QualType NSArrayFType = 2717 getSimpleFunctionType(Context->VoidTy, IntQT, true); 2718 std::string NSArrayFName("__NSContainer_literal"); 2719 FunctionDecl *NSArrayFD = SynthBlockInitFunctionDecl(NSArrayFName); 2720 DeclRefExpr *NSArrayDRE = 2721 new (Context) DeclRefExpr(NSArrayFD, false, NSArrayFType, VK_RValue, 2722 SourceLocation()); 2723 2724 SmallVector<Expr*, 16> InitExprs; 2725 unsigned NumElements = Exp->getNumElements(); 2726 unsigned UnsignedIntSize = 2727 static_cast<unsigned>(Context->getTypeSize(Context->UnsignedIntTy)); 2728 Expr *count = IntegerLiteral::Create(*Context, 2729 llvm::APInt(UnsignedIntSize, NumElements), 2730 Context->UnsignedIntTy, SourceLocation()); 2731 InitExprs.push_back(count); 2732 for (unsigned i = 0; i < NumElements; i++) 2733 InitExprs.push_back(Exp->getElement(i)); 2734 Expr *NSArrayCallExpr = 2735 new (Context) CallExpr(*Context, NSArrayDRE, InitExprs, 2736 NSArrayFType, VK_LValue, SourceLocation()); 2737 2738 FieldDecl *ARRFD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 2739 SourceLocation(), 2740 &Context->Idents.get("arr"), 2741 Context->getPointerType(Context->VoidPtrTy), 2742 nullptr, /*BitWidth=*/nullptr, 2743 /*Mutable=*/true, ICIS_NoInit); 2744 MemberExpr *ArrayLiteralME = new (Context) 2745 MemberExpr(NSArrayCallExpr, false, SourceLocation(), ARRFD, 2746 SourceLocation(), ARRFD->getType(), VK_LValue, OK_Ordinary); 2747 QualType ConstIdT = Context->getObjCIdType().withConst(); 2748 CStyleCastExpr * ArrayLiteralObjects = 2749 NoTypeInfoCStyleCastExpr(Context, 2750 Context->getPointerType(ConstIdT), 2751 CK_BitCast, 2752 ArrayLiteralME); 2753 2754 // Synthesize a call to objc_msgSend(). 2755 SmallVector<Expr*, 32> MsgExprs; 2756 SmallVector<Expr*, 4> ClsExprs; 2757 QualType expType = Exp->getType(); 2758 2759 // Create a call to objc_getClass("NSArray"). It will be th 1st argument. 2760 ObjCInterfaceDecl *Class = 2761 expType->getPointeeType()->getAs<ObjCObjectType>()->getInterface(); 2762 2763 IdentifierInfo *clsName = Class->getIdentifier(); 2764 ClsExprs.push_back(getStringLiteral(clsName->getName())); 2765 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs, 2766 StartLoc, EndLoc); 2767 MsgExprs.push_back(Cls); 2768 2769 // Create a call to sel_registerName("arrayWithObjects:count:"). 2770 // it will be the 2nd argument. 2771 SmallVector<Expr*, 4> SelExprs; 2772 ObjCMethodDecl *ArrayMethod = Exp->getArrayWithObjectsMethod(); 2773 SelExprs.push_back( 2774 getStringLiteral(ArrayMethod->getSelector().getAsString())); 2775 CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl, 2776 SelExprs, StartLoc, EndLoc); 2777 MsgExprs.push_back(SelExp); 2778 2779 // (const id [])objects 2780 MsgExprs.push_back(ArrayLiteralObjects); 2781 2782 // (NSUInteger)cnt 2783 Expr *cnt = IntegerLiteral::Create(*Context, 2784 llvm::APInt(UnsignedIntSize, NumElements), 2785 Context->UnsignedIntTy, SourceLocation()); 2786 MsgExprs.push_back(cnt); 2787 2788 SmallVector<QualType, 4> ArgTypes; 2789 ArgTypes.push_back(Context->getObjCClassType()); 2790 ArgTypes.push_back(Context->getObjCSelType()); 2791 for (const auto *PI : ArrayMethod->parameters()) 2792 ArgTypes.push_back(PI->getType()); 2793 2794 QualType returnType = Exp->getType(); 2795 // Get the type, we will need to reference it in a couple spots. 2796 QualType msgSendType = MsgSendFlavor->getType(); 2797 2798 // Create a reference to the objc_msgSend() declaration. 2799 DeclRefExpr *DRE = new (Context) DeclRefExpr(MsgSendFlavor, false, msgSendType, 2800 VK_LValue, SourceLocation()); 2801 2802 CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, 2803 Context->getPointerType(Context->VoidTy), 2804 CK_BitCast, DRE); 2805 2806 // Now do the "normal" pointer to function cast. 2807 QualType castType = 2808 getSimpleFunctionType(returnType, ArgTypes, ArrayMethod->isVariadic()); 2809 castType = Context->getPointerType(castType); 2810 cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast, 2811 cast); 2812 2813 // Don't forget the parens to enforce the proper binding. 2814 ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast); 2815 2816 const FunctionType *FT = msgSendType->getAs<FunctionType>(); 2817 CallExpr *CE = new (Context) 2818 CallExpr(*Context, PE, MsgExprs, FT->getReturnType(), VK_RValue, EndLoc); 2819 ReplaceStmt(Exp, CE); 2820 return CE; 2821 } 2822 2823 Stmt *RewriteModernObjC::RewriteObjCDictionaryLiteralExpr(ObjCDictionaryLiteral *Exp) { 2824 // synthesize declaration of helper functions needed in this routine. 2825 if (!SelGetUidFunctionDecl) 2826 SynthSelGetUidFunctionDecl(); 2827 // use objc_msgSend() for all. 2828 if (!MsgSendFunctionDecl) 2829 SynthMsgSendFunctionDecl(); 2830 if (!GetClassFunctionDecl) 2831 SynthGetClassFunctionDecl(); 2832 2833 FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl; 2834 SourceLocation StartLoc = Exp->getLocStart(); 2835 SourceLocation EndLoc = Exp->getLocEnd(); 2836 2837 // Build the expression: __NSContainer_literal(int, ...).arr 2838 QualType IntQT = Context->IntTy; 2839 QualType NSDictFType = 2840 getSimpleFunctionType(Context->VoidTy, IntQT, true); 2841 std::string NSDictFName("__NSContainer_literal"); 2842 FunctionDecl *NSDictFD = SynthBlockInitFunctionDecl(NSDictFName); 2843 DeclRefExpr *NSDictDRE = 2844 new (Context) DeclRefExpr(NSDictFD, false, NSDictFType, VK_RValue, 2845 SourceLocation()); 2846 2847 SmallVector<Expr*, 16> KeyExprs; 2848 SmallVector<Expr*, 16> ValueExprs; 2849 2850 unsigned NumElements = Exp->getNumElements(); 2851 unsigned UnsignedIntSize = 2852 static_cast<unsigned>(Context->getTypeSize(Context->UnsignedIntTy)); 2853 Expr *count = IntegerLiteral::Create(*Context, 2854 llvm::APInt(UnsignedIntSize, NumElements), 2855 Context->UnsignedIntTy, SourceLocation()); 2856 KeyExprs.push_back(count); 2857 ValueExprs.push_back(count); 2858 for (unsigned i = 0; i < NumElements; i++) { 2859 ObjCDictionaryElement Element = Exp->getKeyValueElement(i); 2860 KeyExprs.push_back(Element.Key); 2861 ValueExprs.push_back(Element.Value); 2862 } 2863 2864 // (const id [])objects 2865 Expr *NSValueCallExpr = 2866 new (Context) CallExpr(*Context, NSDictDRE, ValueExprs, 2867 NSDictFType, VK_LValue, SourceLocation()); 2868 2869 FieldDecl *ARRFD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 2870 SourceLocation(), 2871 &Context->Idents.get("arr"), 2872 Context->getPointerType(Context->VoidPtrTy), 2873 nullptr, /*BitWidth=*/nullptr, 2874 /*Mutable=*/true, ICIS_NoInit); 2875 MemberExpr *DictLiteralValueME = new (Context) 2876 MemberExpr(NSValueCallExpr, false, SourceLocation(), ARRFD, 2877 SourceLocation(), ARRFD->getType(), VK_LValue, OK_Ordinary); 2878 QualType ConstIdT = Context->getObjCIdType().withConst(); 2879 CStyleCastExpr * DictValueObjects = 2880 NoTypeInfoCStyleCastExpr(Context, 2881 Context->getPointerType(ConstIdT), 2882 CK_BitCast, 2883 DictLiteralValueME); 2884 // (const id <NSCopying> [])keys 2885 Expr *NSKeyCallExpr = 2886 new (Context) CallExpr(*Context, NSDictDRE, KeyExprs, 2887 NSDictFType, VK_LValue, SourceLocation()); 2888 2889 MemberExpr *DictLiteralKeyME = new (Context) 2890 MemberExpr(NSKeyCallExpr, false, SourceLocation(), ARRFD, 2891 SourceLocation(), ARRFD->getType(), VK_LValue, OK_Ordinary); 2892 2893 CStyleCastExpr * DictKeyObjects = 2894 NoTypeInfoCStyleCastExpr(Context, 2895 Context->getPointerType(ConstIdT), 2896 CK_BitCast, 2897 DictLiteralKeyME); 2898 2899 // Synthesize a call to objc_msgSend(). 2900 SmallVector<Expr*, 32> MsgExprs; 2901 SmallVector<Expr*, 4> ClsExprs; 2902 QualType expType = Exp->getType(); 2903 2904 // Create a call to objc_getClass("NSArray"). It will be th 1st argument. 2905 ObjCInterfaceDecl *Class = 2906 expType->getPointeeType()->getAs<ObjCObjectType>()->getInterface(); 2907 2908 IdentifierInfo *clsName = Class->getIdentifier(); 2909 ClsExprs.push_back(getStringLiteral(clsName->getName())); 2910 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs, 2911 StartLoc, EndLoc); 2912 MsgExprs.push_back(Cls); 2913 2914 // Create a call to sel_registerName("arrayWithObjects:count:"). 2915 // it will be the 2nd argument. 2916 SmallVector<Expr*, 4> SelExprs; 2917 ObjCMethodDecl *DictMethod = Exp->getDictWithObjectsMethod(); 2918 SelExprs.push_back(getStringLiteral(DictMethod->getSelector().getAsString())); 2919 CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl, 2920 SelExprs, StartLoc, EndLoc); 2921 MsgExprs.push_back(SelExp); 2922 2923 // (const id [])objects 2924 MsgExprs.push_back(DictValueObjects); 2925 2926 // (const id <NSCopying> [])keys 2927 MsgExprs.push_back(DictKeyObjects); 2928 2929 // (NSUInteger)cnt 2930 Expr *cnt = IntegerLiteral::Create(*Context, 2931 llvm::APInt(UnsignedIntSize, NumElements), 2932 Context->UnsignedIntTy, SourceLocation()); 2933 MsgExprs.push_back(cnt); 2934 2935 SmallVector<QualType, 8> ArgTypes; 2936 ArgTypes.push_back(Context->getObjCClassType()); 2937 ArgTypes.push_back(Context->getObjCSelType()); 2938 for (const auto *PI : DictMethod->parameters()) { 2939 QualType T = PI->getType(); 2940 if (const PointerType* PT = T->getAs<PointerType>()) { 2941 QualType PointeeTy = PT->getPointeeType(); 2942 convertToUnqualifiedObjCType(PointeeTy); 2943 T = Context->getPointerType(PointeeTy); 2944 } 2945 ArgTypes.push_back(T); 2946 } 2947 2948 QualType returnType = Exp->getType(); 2949 // Get the type, we will need to reference it in a couple spots. 2950 QualType msgSendType = MsgSendFlavor->getType(); 2951 2952 // Create a reference to the objc_msgSend() declaration. 2953 DeclRefExpr *DRE = new (Context) DeclRefExpr(MsgSendFlavor, false, msgSendType, 2954 VK_LValue, SourceLocation()); 2955 2956 CastExpr *cast = NoTypeInfoCStyleCastExpr(Context, 2957 Context->getPointerType(Context->VoidTy), 2958 CK_BitCast, DRE); 2959 2960 // Now do the "normal" pointer to function cast. 2961 QualType castType = 2962 getSimpleFunctionType(returnType, ArgTypes, DictMethod->isVariadic()); 2963 castType = Context->getPointerType(castType); 2964 cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast, 2965 cast); 2966 2967 // Don't forget the parens to enforce the proper binding. 2968 ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast); 2969 2970 const FunctionType *FT = msgSendType->getAs<FunctionType>(); 2971 CallExpr *CE = new (Context) 2972 CallExpr(*Context, PE, MsgExprs, FT->getReturnType(), VK_RValue, EndLoc); 2973 ReplaceStmt(Exp, CE); 2974 return CE; 2975 } 2976 2977 // struct __rw_objc_super { 2978 // struct objc_object *object; struct objc_object *superClass; 2979 // }; 2980 QualType RewriteModernObjC::getSuperStructType() { 2981 if (!SuperStructDecl) { 2982 SuperStructDecl = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 2983 SourceLocation(), SourceLocation(), 2984 &Context->Idents.get("__rw_objc_super")); 2985 QualType FieldTypes[2]; 2986 2987 // struct objc_object *object; 2988 FieldTypes[0] = Context->getObjCIdType(); 2989 // struct objc_object *superClass; 2990 FieldTypes[1] = Context->getObjCIdType(); 2991 2992 // Create fields 2993 for (unsigned i = 0; i < 2; ++i) { 2994 SuperStructDecl->addDecl(FieldDecl::Create(*Context, SuperStructDecl, 2995 SourceLocation(), 2996 SourceLocation(), nullptr, 2997 FieldTypes[i], nullptr, 2998 /*BitWidth=*/nullptr, 2999 /*Mutable=*/false, 3000 ICIS_NoInit)); 3001 } 3002 3003 SuperStructDecl->completeDefinition(); 3004 } 3005 return Context->getTagDeclType(SuperStructDecl); 3006 } 3007 3008 QualType RewriteModernObjC::getConstantStringStructType() { 3009 if (!ConstantStringDecl) { 3010 ConstantStringDecl = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 3011 SourceLocation(), SourceLocation(), 3012 &Context->Idents.get("__NSConstantStringImpl")); 3013 QualType FieldTypes[4]; 3014 3015 // struct objc_object *receiver; 3016 FieldTypes[0] = Context->getObjCIdType(); 3017 // int flags; 3018 FieldTypes[1] = Context->IntTy; 3019 // char *str; 3020 FieldTypes[2] = Context->getPointerType(Context->CharTy); 3021 // long length; 3022 FieldTypes[3] = Context->LongTy; 3023 3024 // Create fields 3025 for (unsigned i = 0; i < 4; ++i) { 3026 ConstantStringDecl->addDecl(FieldDecl::Create(*Context, 3027 ConstantStringDecl, 3028 SourceLocation(), 3029 SourceLocation(), nullptr, 3030 FieldTypes[i], nullptr, 3031 /*BitWidth=*/nullptr, 3032 /*Mutable=*/true, 3033 ICIS_NoInit)); 3034 } 3035 3036 ConstantStringDecl->completeDefinition(); 3037 } 3038 return Context->getTagDeclType(ConstantStringDecl); 3039 } 3040 3041 /// getFunctionSourceLocation - returns start location of a function 3042 /// definition. Complication arises when function has declared as 3043 /// extern "C" or extern "C" {...} 3044 static SourceLocation getFunctionSourceLocation (RewriteModernObjC &R, 3045 FunctionDecl *FD) { 3046 if (FD->isExternC() && !FD->isMain()) { 3047 const DeclContext *DC = FD->getDeclContext(); 3048 if (const LinkageSpecDecl *LSD = dyn_cast<LinkageSpecDecl>(DC)) 3049 // if it is extern "C" {...}, return function decl's own location. 3050 if (!LSD->getRBraceLoc().isValid()) 3051 return LSD->getExternLoc(); 3052 } 3053 if (FD->getStorageClass() != SC_None) 3054 R.RewriteBlockLiteralFunctionDecl(FD); 3055 return FD->getTypeSpecStartLoc(); 3056 } 3057 3058 void RewriteModernObjC::RewriteLineDirective(const Decl *D) { 3059 3060 SourceLocation Location = D->getLocation(); 3061 3062 if (Location.isFileID() && GenerateLineInfo) { 3063 std::string LineString("\n#line "); 3064 PresumedLoc PLoc = SM->getPresumedLoc(Location); 3065 LineString += utostr(PLoc.getLine()); 3066 LineString += " \""; 3067 LineString += Lexer::Stringify(PLoc.getFilename()); 3068 if (isa<ObjCMethodDecl>(D)) 3069 LineString += "\""; 3070 else LineString += "\"\n"; 3071 3072 Location = D->getLocStart(); 3073 if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { 3074 if (FD->isExternC() && !FD->isMain()) { 3075 const DeclContext *DC = FD->getDeclContext(); 3076 if (const LinkageSpecDecl *LSD = dyn_cast<LinkageSpecDecl>(DC)) 3077 // if it is extern "C" {...}, return function decl's own location. 3078 if (!LSD->getRBraceLoc().isValid()) 3079 Location = LSD->getExternLoc(); 3080 } 3081 } 3082 InsertText(Location, LineString); 3083 } 3084 } 3085 3086 /// SynthMsgSendStretCallExpr - This routine translates message expression 3087 /// into a call to objc_msgSend_stret() entry point. Tricky part is that 3088 /// nil check on receiver must be performed before calling objc_msgSend_stret. 3089 /// MsgSendStretFlavor - function declaration objc_msgSend_stret(...) 3090 /// msgSendType - function type of objc_msgSend_stret(...) 3091 /// returnType - Result type of the method being synthesized. 3092 /// ArgTypes - type of the arguments passed to objc_msgSend_stret, starting with receiver type. 3093 /// MsgExprs - list of argument expressions being passed to objc_msgSend_stret, 3094 /// starting with receiver. 3095 /// Method - Method being rewritten. 3096 Expr *RewriteModernObjC::SynthMsgSendStretCallExpr(FunctionDecl *MsgSendStretFlavor, 3097 QualType returnType, 3098 SmallVectorImpl<QualType> &ArgTypes, 3099 SmallVectorImpl<Expr*> &MsgExprs, 3100 ObjCMethodDecl *Method) { 3101 // Now do the "normal" pointer to function cast. 3102 QualType castType = getSimpleFunctionType(returnType, ArgTypes, 3103 Method ? Method->isVariadic() 3104 : false); 3105 castType = Context->getPointerType(castType); 3106 3107 // build type for containing the objc_msgSend_stret object. 3108 static unsigned stretCount=0; 3109 std::string name = "__Stret"; name += utostr(stretCount); 3110 std::string str = 3111 "extern \"C\" void * __cdecl memset(void *_Dst, int _Val, size_t _Size);\n"; 3112 str += "namespace {\n"; 3113 str += "struct "; str += name; 3114 str += " {\n\t"; 3115 str += name; 3116 str += "(id receiver, SEL sel"; 3117 for (unsigned i = 2; i < ArgTypes.size(); i++) { 3118 std::string ArgName = "arg"; ArgName += utostr(i); 3119 ArgTypes[i].getAsStringInternal(ArgName, Context->getPrintingPolicy()); 3120 str += ", "; str += ArgName; 3121 } 3122 // could be vararg. 3123 for (unsigned i = ArgTypes.size(); i < MsgExprs.size(); i++) { 3124 std::string ArgName = "arg"; ArgName += utostr(i); 3125 MsgExprs[i]->getType().getAsStringInternal(ArgName, 3126 Context->getPrintingPolicy()); 3127 str += ", "; str += ArgName; 3128 } 3129 3130 str += ") {\n"; 3131 str += "\t unsigned size = sizeof("; 3132 str += returnType.getAsString(Context->getPrintingPolicy()); str += ");\n"; 3133 3134 str += "\t if (size == 1 || size == 2 || size == 4 || size == 8)\n"; 3135 3136 str += "\t s = (("; str += castType.getAsString(Context->getPrintingPolicy()); 3137 str += ")(void *)objc_msgSend)(receiver, sel"; 3138 for (unsigned i = 2; i < ArgTypes.size(); i++) { 3139 str += ", arg"; str += utostr(i); 3140 } 3141 // could be vararg. 3142 for (unsigned i = ArgTypes.size(); i < MsgExprs.size(); i++) { 3143 str += ", arg"; str += utostr(i); 3144 } 3145 str+= ");\n"; 3146 3147 str += "\t else if (receiver == 0)\n"; 3148 str += "\t memset((void*)&s, 0, sizeof(s));\n"; 3149 str += "\t else\n"; 3150 3151 str += "\t s = (("; str += castType.getAsString(Context->getPrintingPolicy()); 3152 str += ")(void *)objc_msgSend_stret)(receiver, sel"; 3153 for (unsigned i = 2; i < ArgTypes.size(); i++) { 3154 str += ", arg"; str += utostr(i); 3155 } 3156 // could be vararg. 3157 for (unsigned i = ArgTypes.size(); i < MsgExprs.size(); i++) { 3158 str += ", arg"; str += utostr(i); 3159 } 3160 str += ");\n"; 3161 3162 str += "\t}\n"; 3163 str += "\t"; str += returnType.getAsString(Context->getPrintingPolicy()); 3164 str += " s;\n"; 3165 str += "};\n};\n\n"; 3166 SourceLocation FunLocStart; 3167 if (CurFunctionDef) 3168 FunLocStart = getFunctionSourceLocation(*this, CurFunctionDef); 3169 else { 3170 assert(CurMethodDef && "SynthMsgSendStretCallExpr - CurMethodDef is null"); 3171 FunLocStart = CurMethodDef->getLocStart(); 3172 } 3173 3174 InsertText(FunLocStart, str); 3175 ++stretCount; 3176 3177 // AST for __Stretn(receiver, args).s; 3178 IdentifierInfo *ID = &Context->Idents.get(name); 3179 FunctionDecl *FD = FunctionDecl::Create(*Context, TUDecl, SourceLocation(), 3180 SourceLocation(), ID, castType, 3181 nullptr, SC_Extern, false, false); 3182 DeclRefExpr *DRE = new (Context) DeclRefExpr(FD, false, castType, VK_RValue, 3183 SourceLocation()); 3184 CallExpr *STCE = new (Context) CallExpr(*Context, DRE, MsgExprs, 3185 castType, VK_LValue, SourceLocation()); 3186 3187 FieldDecl *FieldD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 3188 SourceLocation(), 3189 &Context->Idents.get("s"), 3190 returnType, nullptr, 3191 /*BitWidth=*/nullptr, 3192 /*Mutable=*/true, ICIS_NoInit); 3193 MemberExpr *ME = new (Context) 3194 MemberExpr(STCE, false, SourceLocation(), FieldD, SourceLocation(), 3195 FieldD->getType(), VK_LValue, OK_Ordinary); 3196 3197 return ME; 3198 } 3199 3200 Stmt *RewriteModernObjC::SynthMessageExpr(ObjCMessageExpr *Exp, 3201 SourceLocation StartLoc, 3202 SourceLocation EndLoc) { 3203 if (!SelGetUidFunctionDecl) 3204 SynthSelGetUidFunctionDecl(); 3205 if (!MsgSendFunctionDecl) 3206 SynthMsgSendFunctionDecl(); 3207 if (!MsgSendSuperFunctionDecl) 3208 SynthMsgSendSuperFunctionDecl(); 3209 if (!MsgSendStretFunctionDecl) 3210 SynthMsgSendStretFunctionDecl(); 3211 if (!MsgSendSuperStretFunctionDecl) 3212 SynthMsgSendSuperStretFunctionDecl(); 3213 if (!MsgSendFpretFunctionDecl) 3214 SynthMsgSendFpretFunctionDecl(); 3215 if (!GetClassFunctionDecl) 3216 SynthGetClassFunctionDecl(); 3217 if (!GetSuperClassFunctionDecl) 3218 SynthGetSuperClassFunctionDecl(); 3219 if (!GetMetaClassFunctionDecl) 3220 SynthGetMetaClassFunctionDecl(); 3221 3222 // default to objc_msgSend(). 3223 FunctionDecl *MsgSendFlavor = MsgSendFunctionDecl; 3224 // May need to use objc_msgSend_stret() as well. 3225 FunctionDecl *MsgSendStretFlavor = nullptr; 3226 if (ObjCMethodDecl *mDecl = Exp->getMethodDecl()) { 3227 QualType resultType = mDecl->getReturnType(); 3228 if (resultType->isRecordType()) 3229 MsgSendStretFlavor = MsgSendStretFunctionDecl; 3230 else if (resultType->isRealFloatingType()) 3231 MsgSendFlavor = MsgSendFpretFunctionDecl; 3232 } 3233 3234 // Synthesize a call to objc_msgSend(). 3235 SmallVector<Expr*, 8> MsgExprs; 3236 switch (Exp->getReceiverKind()) { 3237 case ObjCMessageExpr::SuperClass: { 3238 MsgSendFlavor = MsgSendSuperFunctionDecl; 3239 if (MsgSendStretFlavor) 3240 MsgSendStretFlavor = MsgSendSuperStretFunctionDecl; 3241 assert(MsgSendFlavor && "MsgSendFlavor is NULL!"); 3242 3243 ObjCInterfaceDecl *ClassDecl = CurMethodDef->getClassInterface(); 3244 3245 SmallVector<Expr*, 4> InitExprs; 3246 3247 // set the receiver to self, the first argument to all methods. 3248 InitExprs.push_back( 3249 NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 3250 CK_BitCast, 3251 new (Context) DeclRefExpr(CurMethodDef->getSelfDecl(), 3252 false, 3253 Context->getObjCIdType(), 3254 VK_RValue, 3255 SourceLocation())) 3256 ); // set the 'receiver'. 3257 3258 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass")) 3259 SmallVector<Expr*, 8> ClsExprs; 3260 ClsExprs.push_back(getStringLiteral(ClassDecl->getIdentifier()->getName())); 3261 // (Class)objc_getClass("CurrentClass") 3262 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetMetaClassFunctionDecl, 3263 ClsExprs, StartLoc, EndLoc); 3264 ClsExprs.clear(); 3265 ClsExprs.push_back(Cls); 3266 Cls = SynthesizeCallToFunctionDecl(GetSuperClassFunctionDecl, ClsExprs, 3267 StartLoc, EndLoc); 3268 3269 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass")) 3270 // To turn off a warning, type-cast to 'id' 3271 InitExprs.push_back( // set 'super class', using class_getSuperclass(). 3272 NoTypeInfoCStyleCastExpr(Context, 3273 Context->getObjCIdType(), 3274 CK_BitCast, Cls)); 3275 // struct __rw_objc_super 3276 QualType superType = getSuperStructType(); 3277 Expr *SuperRep; 3278 3279 if (LangOpts.MicrosoftExt) { 3280 SynthSuperConstructorFunctionDecl(); 3281 // Simulate a constructor call... 3282 DeclRefExpr *DRE = new (Context) DeclRefExpr(SuperConstructorFunctionDecl, 3283 false, superType, VK_LValue, 3284 SourceLocation()); 3285 SuperRep = new (Context) CallExpr(*Context, DRE, InitExprs, 3286 superType, VK_LValue, 3287 SourceLocation()); 3288 // The code for super is a little tricky to prevent collision with 3289 // the structure definition in the header. The rewriter has it's own 3290 // internal definition (__rw_objc_super) that is uses. This is why 3291 // we need the cast below. For example: 3292 // (struct __rw_objc_super *)&__rw_objc_super((id)self, (id)objc_getClass("SUPER")) 3293 // 3294 SuperRep = new (Context) UnaryOperator(SuperRep, UO_AddrOf, 3295 Context->getPointerType(SuperRep->getType()), 3296 VK_RValue, OK_Ordinary, 3297 SourceLocation()); 3298 SuperRep = NoTypeInfoCStyleCastExpr(Context, 3299 Context->getPointerType(superType), 3300 CK_BitCast, SuperRep); 3301 } else { 3302 // (struct __rw_objc_super) { <exprs from above> } 3303 InitListExpr *ILE = 3304 new (Context) InitListExpr(*Context, SourceLocation(), InitExprs, 3305 SourceLocation()); 3306 TypeSourceInfo *superTInfo 3307 = Context->getTrivialTypeSourceInfo(superType); 3308 SuperRep = new (Context) CompoundLiteralExpr(SourceLocation(), superTInfo, 3309 superType, VK_LValue, 3310 ILE, false); 3311 // struct __rw_objc_super * 3312 SuperRep = new (Context) UnaryOperator(SuperRep, UO_AddrOf, 3313 Context->getPointerType(SuperRep->getType()), 3314 VK_RValue, OK_Ordinary, 3315 SourceLocation()); 3316 } 3317 MsgExprs.push_back(SuperRep); 3318 break; 3319 } 3320 3321 case ObjCMessageExpr::Class: { 3322 SmallVector<Expr*, 8> ClsExprs; 3323 ObjCInterfaceDecl *Class 3324 = Exp->getClassReceiver()->getAs<ObjCObjectType>()->getInterface(); 3325 IdentifierInfo *clsName = Class->getIdentifier(); 3326 ClsExprs.push_back(getStringLiteral(clsName->getName())); 3327 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs, 3328 StartLoc, EndLoc); 3329 CastExpr *ArgExpr = NoTypeInfoCStyleCastExpr(Context, 3330 Context->getObjCIdType(), 3331 CK_BitCast, Cls); 3332 MsgExprs.push_back(ArgExpr); 3333 break; 3334 } 3335 3336 case ObjCMessageExpr::SuperInstance:{ 3337 MsgSendFlavor = MsgSendSuperFunctionDecl; 3338 if (MsgSendStretFlavor) 3339 MsgSendStretFlavor = MsgSendSuperStretFunctionDecl; 3340 assert(MsgSendFlavor && "MsgSendFlavor is NULL!"); 3341 ObjCInterfaceDecl *ClassDecl = CurMethodDef->getClassInterface(); 3342 SmallVector<Expr*, 4> InitExprs; 3343 3344 InitExprs.push_back( 3345 NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 3346 CK_BitCast, 3347 new (Context) DeclRefExpr(CurMethodDef->getSelfDecl(), 3348 false, 3349 Context->getObjCIdType(), 3350 VK_RValue, SourceLocation())) 3351 ); // set the 'receiver'. 3352 3353 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass")) 3354 SmallVector<Expr*, 8> ClsExprs; 3355 ClsExprs.push_back(getStringLiteral(ClassDecl->getIdentifier()->getName())); 3356 // (Class)objc_getClass("CurrentClass") 3357 CallExpr *Cls = SynthesizeCallToFunctionDecl(GetClassFunctionDecl, ClsExprs, 3358 StartLoc, EndLoc); 3359 ClsExprs.clear(); 3360 ClsExprs.push_back(Cls); 3361 Cls = SynthesizeCallToFunctionDecl(GetSuperClassFunctionDecl, ClsExprs, 3362 StartLoc, EndLoc); 3363 3364 // (id)class_getSuperclass((Class)objc_getClass("CurrentClass")) 3365 // To turn off a warning, type-cast to 'id' 3366 InitExprs.push_back( 3367 // set 'super class', using class_getSuperclass(). 3368 NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 3369 CK_BitCast, Cls)); 3370 // struct __rw_objc_super 3371 QualType superType = getSuperStructType(); 3372 Expr *SuperRep; 3373 3374 if (LangOpts.MicrosoftExt) { 3375 SynthSuperConstructorFunctionDecl(); 3376 // Simulate a constructor call... 3377 DeclRefExpr *DRE = new (Context) DeclRefExpr(SuperConstructorFunctionDecl, 3378 false, superType, VK_LValue, 3379 SourceLocation()); 3380 SuperRep = new (Context) CallExpr(*Context, DRE, InitExprs, 3381 superType, VK_LValue, SourceLocation()); 3382 // The code for super is a little tricky to prevent collision with 3383 // the structure definition in the header. The rewriter has it's own 3384 // internal definition (__rw_objc_super) that is uses. This is why 3385 // we need the cast below. For example: 3386 // (struct __rw_objc_super *)&__rw_objc_super((id)self, (id)objc_getClass("SUPER")) 3387 // 3388 SuperRep = new (Context) UnaryOperator(SuperRep, UO_AddrOf, 3389 Context->getPointerType(SuperRep->getType()), 3390 VK_RValue, OK_Ordinary, 3391 SourceLocation()); 3392 SuperRep = NoTypeInfoCStyleCastExpr(Context, 3393 Context->getPointerType(superType), 3394 CK_BitCast, SuperRep); 3395 } else { 3396 // (struct __rw_objc_super) { <exprs from above> } 3397 InitListExpr *ILE = 3398 new (Context) InitListExpr(*Context, SourceLocation(), InitExprs, 3399 SourceLocation()); 3400 TypeSourceInfo *superTInfo 3401 = Context->getTrivialTypeSourceInfo(superType); 3402 SuperRep = new (Context) CompoundLiteralExpr(SourceLocation(), superTInfo, 3403 superType, VK_RValue, ILE, 3404 false); 3405 } 3406 MsgExprs.push_back(SuperRep); 3407 break; 3408 } 3409 3410 case ObjCMessageExpr::Instance: { 3411 // Remove all type-casts because it may contain objc-style types; e.g. 3412 // Foo<Proto> *. 3413 Expr *recExpr = Exp->getInstanceReceiver(); 3414 while (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(recExpr)) 3415 recExpr = CE->getSubExpr(); 3416 CastKind CK = recExpr->getType()->isObjCObjectPointerType() 3417 ? CK_BitCast : recExpr->getType()->isBlockPointerType() 3418 ? CK_BlockPointerToObjCPointerCast 3419 : CK_CPointerToObjCPointerCast; 3420 3421 recExpr = NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 3422 CK, recExpr); 3423 MsgExprs.push_back(recExpr); 3424 break; 3425 } 3426 } 3427 3428 // Create a call to sel_registerName("selName"), it will be the 2nd argument. 3429 SmallVector<Expr*, 8> SelExprs; 3430 SelExprs.push_back(getStringLiteral(Exp->getSelector().getAsString())); 3431 CallExpr *SelExp = SynthesizeCallToFunctionDecl(SelGetUidFunctionDecl, 3432 SelExprs, StartLoc, EndLoc); 3433 MsgExprs.push_back(SelExp); 3434 3435 // Now push any user supplied arguments. 3436 for (unsigned i = 0; i < Exp->getNumArgs(); i++) { 3437 Expr *userExpr = Exp->getArg(i); 3438 // Make all implicit casts explicit...ICE comes in handy:-) 3439 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(userExpr)) { 3440 // Reuse the ICE type, it is exactly what the doctor ordered. 3441 QualType type = ICE->getType(); 3442 if (needToScanForQualifiers(type)) 3443 type = Context->getObjCIdType(); 3444 // Make sure we convert "type (^)(...)" to "type (*)(...)". 3445 (void)convertBlockPointerToFunctionPointer(type); 3446 const Expr *SubExpr = ICE->IgnoreParenImpCasts(); 3447 CastKind CK; 3448 if (SubExpr->getType()->isIntegralType(*Context) && 3449 type->isBooleanType()) { 3450 CK = CK_IntegralToBoolean; 3451 } else if (type->isObjCObjectPointerType()) { 3452 if (SubExpr->getType()->isBlockPointerType()) { 3453 CK = CK_BlockPointerToObjCPointerCast; 3454 } else if (SubExpr->getType()->isPointerType()) { 3455 CK = CK_CPointerToObjCPointerCast; 3456 } else { 3457 CK = CK_BitCast; 3458 } 3459 } else { 3460 CK = CK_BitCast; 3461 } 3462 3463 userExpr = NoTypeInfoCStyleCastExpr(Context, type, CK, userExpr); 3464 } 3465 // Make id<P...> cast into an 'id' cast. 3466 else if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(userExpr)) { 3467 if (CE->getType()->isObjCQualifiedIdType()) { 3468 while ((CE = dyn_cast<CStyleCastExpr>(userExpr))) 3469 userExpr = CE->getSubExpr(); 3470 CastKind CK; 3471 if (userExpr->getType()->isIntegralType(*Context)) { 3472 CK = CK_IntegralToPointer; 3473 } else if (userExpr->getType()->isBlockPointerType()) { 3474 CK = CK_BlockPointerToObjCPointerCast; 3475 } else if (userExpr->getType()->isPointerType()) { 3476 CK = CK_CPointerToObjCPointerCast; 3477 } else { 3478 CK = CK_BitCast; 3479 } 3480 userExpr = NoTypeInfoCStyleCastExpr(Context, Context->getObjCIdType(), 3481 CK, userExpr); 3482 } 3483 } 3484 MsgExprs.push_back(userExpr); 3485 // We've transferred the ownership to MsgExprs. For now, we *don't* null 3486 // out the argument in the original expression (since we aren't deleting 3487 // the ObjCMessageExpr). See RewritePropertyOrImplicitSetter() usage for more info. 3488 //Exp->setArg(i, 0); 3489 } 3490 // Generate the funky cast. 3491 CastExpr *cast; 3492 SmallVector<QualType, 8> ArgTypes; 3493 QualType returnType; 3494 3495 // Push 'id' and 'SEL', the 2 implicit arguments. 3496 if (MsgSendFlavor == MsgSendSuperFunctionDecl) 3497 ArgTypes.push_back(Context->getPointerType(getSuperStructType())); 3498 else 3499 ArgTypes.push_back(Context->getObjCIdType()); 3500 ArgTypes.push_back(Context->getObjCSelType()); 3501 if (ObjCMethodDecl *OMD = Exp->getMethodDecl()) { 3502 // Push any user argument types. 3503 for (const auto *PI : OMD->parameters()) { 3504 QualType t = PI->getType()->isObjCQualifiedIdType() 3505 ? Context->getObjCIdType() 3506 : PI->getType(); 3507 // Make sure we convert "t (^)(...)" to "t (*)(...)". 3508 (void)convertBlockPointerToFunctionPointer(t); 3509 ArgTypes.push_back(t); 3510 } 3511 returnType = Exp->getType(); 3512 convertToUnqualifiedObjCType(returnType); 3513 (void)convertBlockPointerToFunctionPointer(returnType); 3514 } else { 3515 returnType = Context->getObjCIdType(); 3516 } 3517 // Get the type, we will need to reference it in a couple spots. 3518 QualType msgSendType = MsgSendFlavor->getType(); 3519 3520 // Create a reference to the objc_msgSend() declaration. 3521 DeclRefExpr *DRE = new (Context) DeclRefExpr(MsgSendFlavor, false, msgSendType, 3522 VK_LValue, SourceLocation()); 3523 3524 // Need to cast objc_msgSend to "void *" (to workaround a GCC bandaid). 3525 // If we don't do this cast, we get the following bizarre warning/note: 3526 // xx.m:13: warning: function called through a non-compatible type 3527 // xx.m:13: note: if this code is reached, the program will abort 3528 cast = NoTypeInfoCStyleCastExpr(Context, 3529 Context->getPointerType(Context->VoidTy), 3530 CK_BitCast, DRE); 3531 3532 // Now do the "normal" pointer to function cast. 3533 // If we don't have a method decl, force a variadic cast. 3534 const ObjCMethodDecl *MD = Exp->getMethodDecl(); 3535 QualType castType = 3536 getSimpleFunctionType(returnType, ArgTypes, MD ? MD->isVariadic() : true); 3537 castType = Context->getPointerType(castType); 3538 cast = NoTypeInfoCStyleCastExpr(Context, castType, CK_BitCast, 3539 cast); 3540 3541 // Don't forget the parens to enforce the proper binding. 3542 ParenExpr *PE = new (Context) ParenExpr(StartLoc, EndLoc, cast); 3543 3544 const FunctionType *FT = msgSendType->getAs<FunctionType>(); 3545 CallExpr *CE = new (Context) 3546 CallExpr(*Context, PE, MsgExprs, FT->getReturnType(), VK_RValue, EndLoc); 3547 Stmt *ReplacingStmt = CE; 3548 if (MsgSendStretFlavor) { 3549 // We have the method which returns a struct/union. Must also generate 3550 // call to objc_msgSend_stret and hang both varieties on a conditional 3551 // expression which dictate which one to envoke depending on size of 3552 // method's return type. 3553 3554 Expr *STCE = SynthMsgSendStretCallExpr(MsgSendStretFlavor, 3555 returnType, 3556 ArgTypes, MsgExprs, 3557 Exp->getMethodDecl()); 3558 ReplacingStmt = STCE; 3559 } 3560 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 3561 return ReplacingStmt; 3562 } 3563 3564 Stmt *RewriteModernObjC::RewriteMessageExpr(ObjCMessageExpr *Exp) { 3565 Stmt *ReplacingStmt = SynthMessageExpr(Exp, Exp->getLocStart(), 3566 Exp->getLocEnd()); 3567 3568 // Now do the actual rewrite. 3569 ReplaceStmt(Exp, ReplacingStmt); 3570 3571 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 3572 return ReplacingStmt; 3573 } 3574 3575 // typedef struct objc_object Protocol; 3576 QualType RewriteModernObjC::getProtocolType() { 3577 if (!ProtocolTypeDecl) { 3578 TypeSourceInfo *TInfo 3579 = Context->getTrivialTypeSourceInfo(Context->getObjCIdType()); 3580 ProtocolTypeDecl = TypedefDecl::Create(*Context, TUDecl, 3581 SourceLocation(), SourceLocation(), 3582 &Context->Idents.get("Protocol"), 3583 TInfo); 3584 } 3585 return Context->getTypeDeclType(ProtocolTypeDecl); 3586 } 3587 3588 /// RewriteObjCProtocolExpr - Rewrite a protocol expression into 3589 /// a synthesized/forward data reference (to the protocol's metadata). 3590 /// The forward references (and metadata) are generated in 3591 /// RewriteModernObjC::HandleTranslationUnit(). 3592 Stmt *RewriteModernObjC::RewriteObjCProtocolExpr(ObjCProtocolExpr *Exp) { 3593 std::string Name = "_OBJC_PROTOCOL_REFERENCE_$_" + 3594 Exp->getProtocol()->getNameAsString(); 3595 IdentifierInfo *ID = &Context->Idents.get(Name); 3596 VarDecl *VD = VarDecl::Create(*Context, TUDecl, SourceLocation(), 3597 SourceLocation(), ID, getProtocolType(), 3598 nullptr, SC_Extern); 3599 DeclRefExpr *DRE = new (Context) DeclRefExpr(VD, false, getProtocolType(), 3600 VK_LValue, SourceLocation()); 3601 CastExpr *castExpr = 3602 NoTypeInfoCStyleCastExpr( 3603 Context, Context->getPointerType(DRE->getType()), CK_BitCast, DRE); 3604 ReplaceStmt(Exp, castExpr); 3605 ProtocolExprDecls.insert(Exp->getProtocol()->getCanonicalDecl()); 3606 // delete Exp; leak for now, see RewritePropertyOrImplicitSetter() usage for more info. 3607 return castExpr; 3608 } 3609 3610 /// IsTagDefinedInsideClass - This routine checks that a named tagged type 3611 /// is defined inside an objective-c class. If so, it returns true. 3612 bool RewriteModernObjC::IsTagDefinedInsideClass(ObjCContainerDecl *IDecl, 3613 TagDecl *Tag, 3614 bool &IsNamedDefinition) { 3615 if (!IDecl) 3616 return false; 3617 SourceLocation TagLocation; 3618 if (RecordDecl *RD = dyn_cast<RecordDecl>(Tag)) { 3619 RD = RD->getDefinition(); 3620 if (!RD || !RD->getDeclName().getAsIdentifierInfo()) 3621 return false; 3622 IsNamedDefinition = true; 3623 TagLocation = RD->getLocation(); 3624 return Context->getSourceManager().isBeforeInTranslationUnit( 3625 IDecl->getLocation(), TagLocation); 3626 } 3627 if (EnumDecl *ED = dyn_cast<EnumDecl>(Tag)) { 3628 if (!ED || !ED->getDeclName().getAsIdentifierInfo()) 3629 return false; 3630 IsNamedDefinition = true; 3631 TagLocation = ED->getLocation(); 3632 return Context->getSourceManager().isBeforeInTranslationUnit( 3633 IDecl->getLocation(), TagLocation); 3634 } 3635 return false; 3636 } 3637 3638 /// RewriteObjCFieldDeclType - This routine rewrites a type into the buffer. 3639 /// It handles elaborated types, as well as enum types in the process. 3640 bool RewriteModernObjC::RewriteObjCFieldDeclType(QualType &Type, 3641 std::string &Result) { 3642 if (isa<TypedefType>(Type)) { 3643 Result += "\t"; 3644 return false; 3645 } 3646 3647 if (Type->isArrayType()) { 3648 QualType ElemTy = Context->getBaseElementType(Type); 3649 return RewriteObjCFieldDeclType(ElemTy, Result); 3650 } 3651 else if (Type->isRecordType()) { 3652 RecordDecl *RD = Type->getAs<RecordType>()->getDecl(); 3653 if (RD->isCompleteDefinition()) { 3654 if (RD->isStruct()) 3655 Result += "\n\tstruct "; 3656 else if (RD->isUnion()) 3657 Result += "\n\tunion "; 3658 else 3659 assert(false && "class not allowed as an ivar type"); 3660 3661 Result += RD->getName(); 3662 if (GlobalDefinedTags.count(RD)) { 3663 // struct/union is defined globally, use it. 3664 Result += " "; 3665 return true; 3666 } 3667 Result += " {\n"; 3668 for (auto *FD : RD->fields()) 3669 RewriteObjCFieldDecl(FD, Result); 3670 Result += "\t} "; 3671 return true; 3672 } 3673 } 3674 else if (Type->isEnumeralType()) { 3675 EnumDecl *ED = Type->getAs<EnumType>()->getDecl(); 3676 if (ED->isCompleteDefinition()) { 3677 Result += "\n\tenum "; 3678 Result += ED->getName(); 3679 if (GlobalDefinedTags.count(ED)) { 3680 // Enum is globall defined, use it. 3681 Result += " "; 3682 return true; 3683 } 3684 3685 Result += " {\n"; 3686 for (const auto *EC : ED->enumerators()) { 3687 Result += "\t"; Result += EC->getName(); Result += " = "; 3688 llvm::APSInt Val = EC->getInitVal(); 3689 Result += Val.toString(10); 3690 Result += ",\n"; 3691 } 3692 Result += "\t} "; 3693 return true; 3694 } 3695 } 3696 3697 Result += "\t"; 3698 convertObjCTypeToCStyleType(Type); 3699 return false; 3700 } 3701 3702 3703 /// RewriteObjCFieldDecl - This routine rewrites a field into the buffer. 3704 /// It handles elaborated types, as well as enum types in the process. 3705 void RewriteModernObjC::RewriteObjCFieldDecl(FieldDecl *fieldDecl, 3706 std::string &Result) { 3707 QualType Type = fieldDecl->getType(); 3708 std::string Name = fieldDecl->getNameAsString(); 3709 3710 bool EleboratedType = RewriteObjCFieldDeclType(Type, Result); 3711 if (!EleboratedType) 3712 Type.getAsStringInternal(Name, Context->getPrintingPolicy()); 3713 Result += Name; 3714 if (fieldDecl->isBitField()) { 3715 Result += " : "; Result += utostr(fieldDecl->getBitWidthValue(*Context)); 3716 } 3717 else if (EleboratedType && Type->isArrayType()) { 3718 const ArrayType *AT = Context->getAsArrayType(Type); 3719 do { 3720 if (const ConstantArrayType *CAT = dyn_cast<ConstantArrayType>(AT)) { 3721 Result += "["; 3722 llvm::APInt Dim = CAT->getSize(); 3723 Result += utostr(Dim.getZExtValue()); 3724 Result += "]"; 3725 } 3726 AT = Context->getAsArrayType(AT->getElementType()); 3727 } while (AT); 3728 } 3729 3730 Result += ";\n"; 3731 } 3732 3733 /// RewriteLocallyDefinedNamedAggregates - This routine rewrites locally defined 3734 /// named aggregate types into the input buffer. 3735 void RewriteModernObjC::RewriteLocallyDefinedNamedAggregates(FieldDecl *fieldDecl, 3736 std::string &Result) { 3737 QualType Type = fieldDecl->getType(); 3738 if (isa<TypedefType>(Type)) 3739 return; 3740 if (Type->isArrayType()) 3741 Type = Context->getBaseElementType(Type); 3742 ObjCContainerDecl *IDecl = 3743 dyn_cast<ObjCContainerDecl>(fieldDecl->getDeclContext()); 3744 3745 TagDecl *TD = nullptr; 3746 if (Type->isRecordType()) { 3747 TD = Type->getAs<RecordType>()->getDecl(); 3748 } 3749 else if (Type->isEnumeralType()) { 3750 TD = Type->getAs<EnumType>()->getDecl(); 3751 } 3752 3753 if (TD) { 3754 if (GlobalDefinedTags.count(TD)) 3755 return; 3756 3757 bool IsNamedDefinition = false; 3758 if (IsTagDefinedInsideClass(IDecl, TD, IsNamedDefinition)) { 3759 RewriteObjCFieldDeclType(Type, Result); 3760 Result += ";"; 3761 } 3762 if (IsNamedDefinition) 3763 GlobalDefinedTags.insert(TD); 3764 } 3765 } 3766 3767 unsigned RewriteModernObjC::ObjCIvarBitfieldGroupNo(ObjCIvarDecl *IV) { 3768 const ObjCInterfaceDecl *CDecl = IV->getContainingInterface(); 3769 if (ObjCInterefaceHasBitfieldGroups.count(CDecl)) { 3770 return IvarGroupNumber[IV]; 3771 } 3772 unsigned GroupNo = 0; 3773 SmallVector<const ObjCIvarDecl *, 8> IVars; 3774 for (const ObjCIvarDecl *IVD = CDecl->all_declared_ivar_begin(); 3775 IVD; IVD = IVD->getNextIvar()) 3776 IVars.push_back(IVD); 3777 3778 for (unsigned i = 0, e = IVars.size(); i < e; i++) 3779 if (IVars[i]->isBitField()) { 3780 IvarGroupNumber[IVars[i++]] = ++GroupNo; 3781 while (i < e && IVars[i]->isBitField()) 3782 IvarGroupNumber[IVars[i++]] = GroupNo; 3783 if (i < e) 3784 --i; 3785 } 3786 3787 ObjCInterefaceHasBitfieldGroups.insert(CDecl); 3788 return IvarGroupNumber[IV]; 3789 } 3790 3791 QualType RewriteModernObjC::SynthesizeBitfieldGroupStructType( 3792 ObjCIvarDecl *IV, 3793 SmallVectorImpl<ObjCIvarDecl *> &IVars) { 3794 std::string StructTagName; 3795 ObjCIvarBitfieldGroupType(IV, StructTagName); 3796 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, 3797 Context->getTranslationUnitDecl(), 3798 SourceLocation(), SourceLocation(), 3799 &Context->Idents.get(StructTagName)); 3800 for (unsigned i=0, e = IVars.size(); i < e; i++) { 3801 ObjCIvarDecl *Ivar = IVars[i]; 3802 RD->addDecl(FieldDecl::Create(*Context, RD, SourceLocation(), SourceLocation(), 3803 &Context->Idents.get(Ivar->getName()), 3804 Ivar->getType(), 3805 nullptr, /*Expr *BW */Ivar->getBitWidth(), 3806 false, ICIS_NoInit)); 3807 } 3808 RD->completeDefinition(); 3809 return Context->getTagDeclType(RD); 3810 } 3811 3812 QualType RewriteModernObjC::GetGroupRecordTypeForObjCIvarBitfield(ObjCIvarDecl *IV) { 3813 const ObjCInterfaceDecl *CDecl = IV->getContainingInterface(); 3814 unsigned GroupNo = ObjCIvarBitfieldGroupNo(IV); 3815 std::pair<const ObjCInterfaceDecl*, unsigned> tuple = std::make_pair(CDecl, GroupNo); 3816 if (GroupRecordType.count(tuple)) 3817 return GroupRecordType[tuple]; 3818 3819 SmallVector<ObjCIvarDecl *, 8> IVars; 3820 for (const ObjCIvarDecl *IVD = CDecl->all_declared_ivar_begin(); 3821 IVD; IVD = IVD->getNextIvar()) { 3822 if (IVD->isBitField()) 3823 IVars.push_back(const_cast<ObjCIvarDecl *>(IVD)); 3824 else { 3825 if (!IVars.empty()) { 3826 unsigned GroupNo = ObjCIvarBitfieldGroupNo(IVars[0]); 3827 // Generate the struct type for this group of bitfield ivars. 3828 GroupRecordType[std::make_pair(CDecl, GroupNo)] = 3829 SynthesizeBitfieldGroupStructType(IVars[0], IVars); 3830 IVars.clear(); 3831 } 3832 } 3833 } 3834 if (!IVars.empty()) { 3835 // Do the last one. 3836 unsigned GroupNo = ObjCIvarBitfieldGroupNo(IVars[0]); 3837 GroupRecordType[std::make_pair(CDecl, GroupNo)] = 3838 SynthesizeBitfieldGroupStructType(IVars[0], IVars); 3839 } 3840 QualType RetQT = GroupRecordType[tuple]; 3841 assert(!RetQT.isNull() && "GetGroupRecordTypeForObjCIvarBitfield struct type is NULL"); 3842 3843 return RetQT; 3844 } 3845 3846 /// ObjCIvarBitfieldGroupDecl - Names field decl. for ivar bitfield group. 3847 /// Name would be: classname__GRBF_n where n is the group number for this ivar. 3848 void RewriteModernObjC::ObjCIvarBitfieldGroupDecl(ObjCIvarDecl *IV, 3849 std::string &Result) { 3850 const ObjCInterfaceDecl *CDecl = IV->getContainingInterface(); 3851 Result += CDecl->getName(); 3852 Result += "__GRBF_"; 3853 unsigned GroupNo = ObjCIvarBitfieldGroupNo(IV); 3854 Result += utostr(GroupNo); 3855 } 3856 3857 /// ObjCIvarBitfieldGroupType - Names struct type for ivar bitfield group. 3858 /// Name of the struct would be: classname__T_n where n is the group number for 3859 /// this ivar. 3860 void RewriteModernObjC::ObjCIvarBitfieldGroupType(ObjCIvarDecl *IV, 3861 std::string &Result) { 3862 const ObjCInterfaceDecl *CDecl = IV->getContainingInterface(); 3863 Result += CDecl->getName(); 3864 Result += "__T_"; 3865 unsigned GroupNo = ObjCIvarBitfieldGroupNo(IV); 3866 Result += utostr(GroupNo); 3867 } 3868 3869 /// ObjCIvarBitfieldGroupOffset - Names symbol for ivar bitfield group field offset. 3870 /// Name would be: OBJC_IVAR_$_classname__GRBF_n where n is the group number for 3871 /// this ivar. 3872 void RewriteModernObjC::ObjCIvarBitfieldGroupOffset(ObjCIvarDecl *IV, 3873 std::string &Result) { 3874 Result += "OBJC_IVAR_$_"; 3875 ObjCIvarBitfieldGroupDecl(IV, Result); 3876 } 3877 3878 #define SKIP_BITFIELDS(IX, ENDIX, VEC) { \ 3879 while ((IX < ENDIX) && VEC[IX]->isBitField()) \ 3880 ++IX; \ 3881 if (IX < ENDIX) \ 3882 --IX; \ 3883 } 3884 3885 /// RewriteObjCInternalStruct - Rewrite one internal struct corresponding to 3886 /// an objective-c class with ivars. 3887 void RewriteModernObjC::RewriteObjCInternalStruct(ObjCInterfaceDecl *CDecl, 3888 std::string &Result) { 3889 assert(CDecl && "Class missing in SynthesizeObjCInternalStruct"); 3890 assert(CDecl->getName() != "" && 3891 "Name missing in SynthesizeObjCInternalStruct"); 3892 ObjCInterfaceDecl *RCDecl = CDecl->getSuperClass(); 3893 SmallVector<ObjCIvarDecl *, 8> IVars; 3894 for (ObjCIvarDecl *IVD = CDecl->all_declared_ivar_begin(); 3895 IVD; IVD = IVD->getNextIvar()) 3896 IVars.push_back(IVD); 3897 3898 SourceLocation LocStart = CDecl->getLocStart(); 3899 SourceLocation LocEnd = CDecl->getEndOfDefinitionLoc(); 3900 3901 const char *startBuf = SM->getCharacterData(LocStart); 3902 const char *endBuf = SM->getCharacterData(LocEnd); 3903 3904 // If no ivars and no root or if its root, directly or indirectly, 3905 // have no ivars (thus not synthesized) then no need to synthesize this class. 3906 if ((!CDecl->isThisDeclarationADefinition() || IVars.size() == 0) && 3907 (!RCDecl || !ObjCSynthesizedStructs.count(RCDecl))) { 3908 endBuf += Lexer::MeasureTokenLength(LocEnd, *SM, LangOpts); 3909 ReplaceText(LocStart, endBuf-startBuf, Result); 3910 return; 3911 } 3912 3913 // Insert named struct/union definitions inside class to 3914 // outer scope. This follows semantics of locally defined 3915 // struct/unions in objective-c classes. 3916 for (unsigned i = 0, e = IVars.size(); i < e; i++) 3917 RewriteLocallyDefinedNamedAggregates(IVars[i], Result); 3918 3919 // Insert named structs which are syntheized to group ivar bitfields 3920 // to outer scope as well. 3921 for (unsigned i = 0, e = IVars.size(); i < e; i++) 3922 if (IVars[i]->isBitField()) { 3923 ObjCIvarDecl *IV = IVars[i]; 3924 QualType QT = GetGroupRecordTypeForObjCIvarBitfield(IV); 3925 RewriteObjCFieldDeclType(QT, Result); 3926 Result += ";"; 3927 // skip over ivar bitfields in this group. 3928 SKIP_BITFIELDS(i , e, IVars); 3929 } 3930 3931 Result += "\nstruct "; 3932 Result += CDecl->getNameAsString(); 3933 Result += "_IMPL {\n"; 3934 3935 if (RCDecl && ObjCSynthesizedStructs.count(RCDecl)) { 3936 Result += "\tstruct "; Result += RCDecl->getNameAsString(); 3937 Result += "_IMPL "; Result += RCDecl->getNameAsString(); 3938 Result += "_IVARS;\n"; 3939 } 3940 3941 for (unsigned i = 0, e = IVars.size(); i < e; i++) { 3942 if (IVars[i]->isBitField()) { 3943 ObjCIvarDecl *IV = IVars[i]; 3944 Result += "\tstruct "; 3945 ObjCIvarBitfieldGroupType(IV, Result); Result += " "; 3946 ObjCIvarBitfieldGroupDecl(IV, Result); Result += ";\n"; 3947 // skip over ivar bitfields in this group. 3948 SKIP_BITFIELDS(i , e, IVars); 3949 } 3950 else 3951 RewriteObjCFieldDecl(IVars[i], Result); 3952 } 3953 3954 Result += "};\n"; 3955 endBuf += Lexer::MeasureTokenLength(LocEnd, *SM, LangOpts); 3956 ReplaceText(LocStart, endBuf-startBuf, Result); 3957 // Mark this struct as having been generated. 3958 if (!ObjCSynthesizedStructs.insert(CDecl).second) 3959 llvm_unreachable("struct already synthesize- RewriteObjCInternalStruct"); 3960 } 3961 3962 /// RewriteIvarOffsetSymbols - Rewrite ivar offset symbols of those ivars which 3963 /// have been referenced in an ivar access expression. 3964 void RewriteModernObjC::RewriteIvarOffsetSymbols(ObjCInterfaceDecl *CDecl, 3965 std::string &Result) { 3966 // write out ivar offset symbols which have been referenced in an ivar 3967 // access expression. 3968 llvm::SmallSetVector<ObjCIvarDecl *, 8> Ivars = ReferencedIvars[CDecl]; 3969 3970 if (Ivars.empty()) 3971 return; 3972 3973 llvm::DenseSet<std::pair<const ObjCInterfaceDecl*, unsigned> > GroupSymbolOutput; 3974 for (ObjCIvarDecl *IvarDecl : Ivars) { 3975 const ObjCInterfaceDecl *IDecl = IvarDecl->getContainingInterface(); 3976 unsigned GroupNo = 0; 3977 if (IvarDecl->isBitField()) { 3978 GroupNo = ObjCIvarBitfieldGroupNo(IvarDecl); 3979 if (GroupSymbolOutput.count(std::make_pair(IDecl, GroupNo))) 3980 continue; 3981 } 3982 Result += "\n"; 3983 if (LangOpts.MicrosoftExt) 3984 Result += "__declspec(allocate(\".objc_ivar$B\")) "; 3985 Result += "extern \"C\" "; 3986 if (LangOpts.MicrosoftExt && 3987 IvarDecl->getAccessControl() != ObjCIvarDecl::Private && 3988 IvarDecl->getAccessControl() != ObjCIvarDecl::Package) 3989 Result += "__declspec(dllimport) "; 3990 3991 Result += "unsigned long "; 3992 if (IvarDecl->isBitField()) { 3993 ObjCIvarBitfieldGroupOffset(IvarDecl, Result); 3994 GroupSymbolOutput.insert(std::make_pair(IDecl, GroupNo)); 3995 } 3996 else 3997 WriteInternalIvarName(CDecl, IvarDecl, Result); 3998 Result += ";"; 3999 } 4000 } 4001 4002 //===----------------------------------------------------------------------===// 4003 // Meta Data Emission 4004 //===----------------------------------------------------------------------===// 4005 4006 /// RewriteImplementations - This routine rewrites all method implementations 4007 /// and emits meta-data. 4008 4009 void RewriteModernObjC::RewriteImplementations() { 4010 int ClsDefCount = ClassImplementation.size(); 4011 int CatDefCount = CategoryImplementation.size(); 4012 4013 // Rewrite implemented methods 4014 for (int i = 0; i < ClsDefCount; i++) { 4015 ObjCImplementationDecl *OIMP = ClassImplementation[i]; 4016 ObjCInterfaceDecl *CDecl = OIMP->getClassInterface(); 4017 if (CDecl->isImplicitInterfaceDecl()) 4018 assert(false && 4019 "Legacy implicit interface rewriting not supported in moder abi"); 4020 RewriteImplementationDecl(OIMP); 4021 } 4022 4023 for (int i = 0; i < CatDefCount; i++) { 4024 ObjCCategoryImplDecl *CIMP = CategoryImplementation[i]; 4025 ObjCInterfaceDecl *CDecl = CIMP->getClassInterface(); 4026 if (CDecl->isImplicitInterfaceDecl()) 4027 assert(false && 4028 "Legacy implicit interface rewriting not supported in moder abi"); 4029 RewriteImplementationDecl(CIMP); 4030 } 4031 } 4032 4033 void RewriteModernObjC::RewriteByRefString(std::string &ResultStr, 4034 const std::string &Name, 4035 ValueDecl *VD, bool def) { 4036 assert(BlockByRefDeclNo.count(VD) && 4037 "RewriteByRefString: ByRef decl missing"); 4038 if (def) 4039 ResultStr += "struct "; 4040 ResultStr += "__Block_byref_" + Name + 4041 "_" + utostr(BlockByRefDeclNo[VD]) ; 4042 } 4043 4044 static bool HasLocalVariableExternalStorage(ValueDecl *VD) { 4045 if (VarDecl *Var = dyn_cast<VarDecl>(VD)) 4046 return (Var->isFunctionOrMethodVarDecl() && !Var->hasLocalStorage()); 4047 return false; 4048 } 4049 4050 std::string RewriteModernObjC::SynthesizeBlockFunc(BlockExpr *CE, int i, 4051 StringRef funcName, 4052 std::string Tag) { 4053 const FunctionType *AFT = CE->getFunctionType(); 4054 QualType RT = AFT->getReturnType(); 4055 std::string StructRef = "struct " + Tag; 4056 SourceLocation BlockLoc = CE->getExprLoc(); 4057 std::string S; 4058 ConvertSourceLocationToLineDirective(BlockLoc, S); 4059 4060 S += "static " + RT.getAsString(Context->getPrintingPolicy()) + " __" + 4061 funcName.str() + "_block_func_" + utostr(i); 4062 4063 BlockDecl *BD = CE->getBlockDecl(); 4064 4065 if (isa<FunctionNoProtoType>(AFT)) { 4066 // No user-supplied arguments. Still need to pass in a pointer to the 4067 // block (to reference imported block decl refs). 4068 S += "(" + StructRef + " *__cself)"; 4069 } else if (BD->param_empty()) { 4070 S += "(" + StructRef + " *__cself)"; 4071 } else { 4072 const FunctionProtoType *FT = cast<FunctionProtoType>(AFT); 4073 assert(FT && "SynthesizeBlockFunc: No function proto"); 4074 S += '('; 4075 // first add the implicit argument. 4076 S += StructRef + " *__cself, "; 4077 std::string ParamStr; 4078 for (BlockDecl::param_iterator AI = BD->param_begin(), 4079 E = BD->param_end(); AI != E; ++AI) { 4080 if (AI != BD->param_begin()) S += ", "; 4081 ParamStr = (*AI)->getNameAsString(); 4082 QualType QT = (*AI)->getType(); 4083 (void)convertBlockPointerToFunctionPointer(QT); 4084 QT.getAsStringInternal(ParamStr, Context->getPrintingPolicy()); 4085 S += ParamStr; 4086 } 4087 if (FT->isVariadic()) { 4088 if (!BD->param_empty()) S += ", "; 4089 S += "..."; 4090 } 4091 S += ')'; 4092 } 4093 S += " {\n"; 4094 4095 // Create local declarations to avoid rewriting all closure decl ref exprs. 4096 // First, emit a declaration for all "by ref" decls. 4097 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(), 4098 E = BlockByRefDecls.end(); I != E; ++I) { 4099 S += " "; 4100 std::string Name = (*I)->getNameAsString(); 4101 std::string TypeString; 4102 RewriteByRefString(TypeString, Name, (*I)); 4103 TypeString += " *"; 4104 Name = TypeString + Name; 4105 S += Name + " = __cself->" + (*I)->getNameAsString() + "; // bound by ref\n"; 4106 } 4107 // Next, emit a declaration for all "by copy" declarations. 4108 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(), 4109 E = BlockByCopyDecls.end(); I != E; ++I) { 4110 S += " "; 4111 // Handle nested closure invocation. For example: 4112 // 4113 // void (^myImportedClosure)(void); 4114 // myImportedClosure = ^(void) { setGlobalInt(x + y); }; 4115 // 4116 // void (^anotherClosure)(void); 4117 // anotherClosure = ^(void) { 4118 // myImportedClosure(); // import and invoke the closure 4119 // }; 4120 // 4121 if (isTopLevelBlockPointerType((*I)->getType())) { 4122 RewriteBlockPointerTypeVariable(S, (*I)); 4123 S += " = ("; 4124 RewriteBlockPointerType(S, (*I)->getType()); 4125 S += ")"; 4126 S += "__cself->" + (*I)->getNameAsString() + "; // bound by copy\n"; 4127 } 4128 else { 4129 std::string Name = (*I)->getNameAsString(); 4130 QualType QT = (*I)->getType(); 4131 if (HasLocalVariableExternalStorage(*I)) 4132 QT = Context->getPointerType(QT); 4133 QT.getAsStringInternal(Name, Context->getPrintingPolicy()); 4134 S += Name + " = __cself->" + 4135 (*I)->getNameAsString() + "; // bound by copy\n"; 4136 } 4137 } 4138 std::string RewrittenStr = RewrittenBlockExprs[CE]; 4139 const char *cstr = RewrittenStr.c_str(); 4140 while (*cstr++ != '{') ; 4141 S += cstr; 4142 S += "\n"; 4143 return S; 4144 } 4145 4146 std::string RewriteModernObjC::SynthesizeBlockHelperFuncs(BlockExpr *CE, int i, 4147 StringRef funcName, 4148 std::string Tag) { 4149 std::string StructRef = "struct " + Tag; 4150 std::string S = "static void __"; 4151 4152 S += funcName; 4153 S += "_block_copy_" + utostr(i); 4154 S += "(" + StructRef; 4155 S += "*dst, " + StructRef; 4156 S += "*src) {"; 4157 for (ValueDecl *VD : ImportedBlockDecls) { 4158 S += "_Block_object_assign((void*)&dst->"; 4159 S += VD->getNameAsString(); 4160 S += ", (void*)src->"; 4161 S += VD->getNameAsString(); 4162 if (BlockByRefDeclsPtrSet.count(VD)) 4163 S += ", " + utostr(BLOCK_FIELD_IS_BYREF) + "/*BLOCK_FIELD_IS_BYREF*/);"; 4164 else if (VD->getType()->isBlockPointerType()) 4165 S += ", " + utostr(BLOCK_FIELD_IS_BLOCK) + "/*BLOCK_FIELD_IS_BLOCK*/);"; 4166 else 4167 S += ", " + utostr(BLOCK_FIELD_IS_OBJECT) + "/*BLOCK_FIELD_IS_OBJECT*/);"; 4168 } 4169 S += "}\n"; 4170 4171 S += "\nstatic void __"; 4172 S += funcName; 4173 S += "_block_dispose_" + utostr(i); 4174 S += "(" + StructRef; 4175 S += "*src) {"; 4176 for (ValueDecl *VD : ImportedBlockDecls) { 4177 S += "_Block_object_dispose((void*)src->"; 4178 S += VD->getNameAsString(); 4179 if (BlockByRefDeclsPtrSet.count(VD)) 4180 S += ", " + utostr(BLOCK_FIELD_IS_BYREF) + "/*BLOCK_FIELD_IS_BYREF*/);"; 4181 else if (VD->getType()->isBlockPointerType()) 4182 S += ", " + utostr(BLOCK_FIELD_IS_BLOCK) + "/*BLOCK_FIELD_IS_BLOCK*/);"; 4183 else 4184 S += ", " + utostr(BLOCK_FIELD_IS_OBJECT) + "/*BLOCK_FIELD_IS_OBJECT*/);"; 4185 } 4186 S += "}\n"; 4187 return S; 4188 } 4189 4190 std::string RewriteModernObjC::SynthesizeBlockImpl(BlockExpr *CE, std::string Tag, 4191 std::string Desc) { 4192 std::string S = "\nstruct " + Tag; 4193 std::string Constructor = " " + Tag; 4194 4195 S += " {\n struct __block_impl impl;\n"; 4196 S += " struct " + Desc; 4197 S += "* Desc;\n"; 4198 4199 Constructor += "(void *fp, "; // Invoke function pointer. 4200 Constructor += "struct " + Desc; // Descriptor pointer. 4201 Constructor += " *desc"; 4202 4203 if (BlockDeclRefs.size()) { 4204 // Output all "by copy" declarations. 4205 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(), 4206 E = BlockByCopyDecls.end(); I != E; ++I) { 4207 S += " "; 4208 std::string FieldName = (*I)->getNameAsString(); 4209 std::string ArgName = "_" + FieldName; 4210 // Handle nested closure invocation. For example: 4211 // 4212 // void (^myImportedBlock)(void); 4213 // myImportedBlock = ^(void) { setGlobalInt(x + y); }; 4214 // 4215 // void (^anotherBlock)(void); 4216 // anotherBlock = ^(void) { 4217 // myImportedBlock(); // import and invoke the closure 4218 // }; 4219 // 4220 if (isTopLevelBlockPointerType((*I)->getType())) { 4221 S += "struct __block_impl *"; 4222 Constructor += ", void *" + ArgName; 4223 } else { 4224 QualType QT = (*I)->getType(); 4225 if (HasLocalVariableExternalStorage(*I)) 4226 QT = Context->getPointerType(QT); 4227 QT.getAsStringInternal(FieldName, Context->getPrintingPolicy()); 4228 QT.getAsStringInternal(ArgName, Context->getPrintingPolicy()); 4229 Constructor += ", " + ArgName; 4230 } 4231 S += FieldName + ";\n"; 4232 } 4233 // Output all "by ref" declarations. 4234 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(), 4235 E = BlockByRefDecls.end(); I != E; ++I) { 4236 S += " "; 4237 std::string FieldName = (*I)->getNameAsString(); 4238 std::string ArgName = "_" + FieldName; 4239 { 4240 std::string TypeString; 4241 RewriteByRefString(TypeString, FieldName, (*I)); 4242 TypeString += " *"; 4243 FieldName = TypeString + FieldName; 4244 ArgName = TypeString + ArgName; 4245 Constructor += ", " + ArgName; 4246 } 4247 S += FieldName + "; // by ref\n"; 4248 } 4249 // Finish writing the constructor. 4250 Constructor += ", int flags=0)"; 4251 // Initialize all "by copy" arguments. 4252 bool firsTime = true; 4253 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(), 4254 E = BlockByCopyDecls.end(); I != E; ++I) { 4255 std::string Name = (*I)->getNameAsString(); 4256 if (firsTime) { 4257 Constructor += " : "; 4258 firsTime = false; 4259 } 4260 else 4261 Constructor += ", "; 4262 if (isTopLevelBlockPointerType((*I)->getType())) 4263 Constructor += Name + "((struct __block_impl *)_" + Name + ")"; 4264 else 4265 Constructor += Name + "(_" + Name + ")"; 4266 } 4267 // Initialize all "by ref" arguments. 4268 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(), 4269 E = BlockByRefDecls.end(); I != E; ++I) { 4270 std::string Name = (*I)->getNameAsString(); 4271 if (firsTime) { 4272 Constructor += " : "; 4273 firsTime = false; 4274 } 4275 else 4276 Constructor += ", "; 4277 Constructor += Name + "(_" + Name + "->__forwarding)"; 4278 } 4279 4280 Constructor += " {\n"; 4281 if (GlobalVarDecl) 4282 Constructor += " impl.isa = &_NSConcreteGlobalBlock;\n"; 4283 else 4284 Constructor += " impl.isa = &_NSConcreteStackBlock;\n"; 4285 Constructor += " impl.Flags = flags;\n impl.FuncPtr = fp;\n"; 4286 4287 Constructor += " Desc = desc;\n"; 4288 } else { 4289 // Finish writing the constructor. 4290 Constructor += ", int flags=0) {\n"; 4291 if (GlobalVarDecl) 4292 Constructor += " impl.isa = &_NSConcreteGlobalBlock;\n"; 4293 else 4294 Constructor += " impl.isa = &_NSConcreteStackBlock;\n"; 4295 Constructor += " impl.Flags = flags;\n impl.FuncPtr = fp;\n"; 4296 Constructor += " Desc = desc;\n"; 4297 } 4298 Constructor += " "; 4299 Constructor += "}\n"; 4300 S += Constructor; 4301 S += "};\n"; 4302 return S; 4303 } 4304 4305 std::string RewriteModernObjC::SynthesizeBlockDescriptor(std::string DescTag, 4306 std::string ImplTag, int i, 4307 StringRef FunName, 4308 unsigned hasCopy) { 4309 std::string S = "\nstatic struct " + DescTag; 4310 4311 S += " {\n size_t reserved;\n"; 4312 S += " size_t Block_size;\n"; 4313 if (hasCopy) { 4314 S += " void (*copy)(struct "; 4315 S += ImplTag; S += "*, struct "; 4316 S += ImplTag; S += "*);\n"; 4317 4318 S += " void (*dispose)(struct "; 4319 S += ImplTag; S += "*);\n"; 4320 } 4321 S += "} "; 4322 4323 S += DescTag + "_DATA = { 0, sizeof(struct "; 4324 S += ImplTag + ")"; 4325 if (hasCopy) { 4326 S += ", __" + FunName.str() + "_block_copy_" + utostr(i); 4327 S += ", __" + FunName.str() + "_block_dispose_" + utostr(i); 4328 } 4329 S += "};\n"; 4330 return S; 4331 } 4332 4333 void RewriteModernObjC::SynthesizeBlockLiterals(SourceLocation FunLocStart, 4334 StringRef FunName) { 4335 bool RewriteSC = (GlobalVarDecl && 4336 !Blocks.empty() && 4337 GlobalVarDecl->getStorageClass() == SC_Static && 4338 GlobalVarDecl->getType().getCVRQualifiers()); 4339 if (RewriteSC) { 4340 std::string SC(" void __"); 4341 SC += GlobalVarDecl->getNameAsString(); 4342 SC += "() {}"; 4343 InsertText(FunLocStart, SC); 4344 } 4345 4346 // Insert closures that were part of the function. 4347 for (unsigned i = 0, count=0; i < Blocks.size(); i++) { 4348 CollectBlockDeclRefInfo(Blocks[i]); 4349 // Need to copy-in the inner copied-in variables not actually used in this 4350 // block. 4351 for (int j = 0; j < InnerDeclRefsCount[i]; j++) { 4352 DeclRefExpr *Exp = InnerDeclRefs[count++]; 4353 ValueDecl *VD = Exp->getDecl(); 4354 BlockDeclRefs.push_back(Exp); 4355 if (!VD->hasAttr<BlocksAttr>()) { 4356 if (!BlockByCopyDeclsPtrSet.count(VD)) { 4357 BlockByCopyDeclsPtrSet.insert(VD); 4358 BlockByCopyDecls.push_back(VD); 4359 } 4360 continue; 4361 } 4362 4363 if (!BlockByRefDeclsPtrSet.count(VD)) { 4364 BlockByRefDeclsPtrSet.insert(VD); 4365 BlockByRefDecls.push_back(VD); 4366 } 4367 4368 // imported objects in the inner blocks not used in the outer 4369 // blocks must be copied/disposed in the outer block as well. 4370 if (VD->getType()->isObjCObjectPointerType() || 4371 VD->getType()->isBlockPointerType()) 4372 ImportedBlockDecls.insert(VD); 4373 } 4374 4375 std::string ImplTag = "__" + FunName.str() + "_block_impl_" + utostr(i); 4376 std::string DescTag = "__" + FunName.str() + "_block_desc_" + utostr(i); 4377 4378 std::string CI = SynthesizeBlockImpl(Blocks[i], ImplTag, DescTag); 4379 4380 InsertText(FunLocStart, CI); 4381 4382 std::string CF = SynthesizeBlockFunc(Blocks[i], i, FunName, ImplTag); 4383 4384 InsertText(FunLocStart, CF); 4385 4386 if (ImportedBlockDecls.size()) { 4387 std::string HF = SynthesizeBlockHelperFuncs(Blocks[i], i, FunName, ImplTag); 4388 InsertText(FunLocStart, HF); 4389 } 4390 std::string BD = SynthesizeBlockDescriptor(DescTag, ImplTag, i, FunName, 4391 ImportedBlockDecls.size() > 0); 4392 InsertText(FunLocStart, BD); 4393 4394 BlockDeclRefs.clear(); 4395 BlockByRefDecls.clear(); 4396 BlockByRefDeclsPtrSet.clear(); 4397 BlockByCopyDecls.clear(); 4398 BlockByCopyDeclsPtrSet.clear(); 4399 ImportedBlockDecls.clear(); 4400 } 4401 if (RewriteSC) { 4402 // Must insert any 'const/volatile/static here. Since it has been 4403 // removed as result of rewriting of block literals. 4404 std::string SC; 4405 if (GlobalVarDecl->getStorageClass() == SC_Static) 4406 SC = "static "; 4407 if (GlobalVarDecl->getType().isConstQualified()) 4408 SC += "const "; 4409 if (GlobalVarDecl->getType().isVolatileQualified()) 4410 SC += "volatile "; 4411 if (GlobalVarDecl->getType().isRestrictQualified()) 4412 SC += "restrict "; 4413 InsertText(FunLocStart, SC); 4414 } 4415 if (GlobalConstructionExp) { 4416 // extra fancy dance for global literal expression. 4417 4418 // Always the latest block expression on the block stack. 4419 std::string Tag = "__"; 4420 Tag += FunName; 4421 Tag += "_block_impl_"; 4422 Tag += utostr(Blocks.size()-1); 4423 std::string globalBuf = "static "; 4424 globalBuf += Tag; globalBuf += " "; 4425 std::string SStr; 4426 4427 llvm::raw_string_ostream constructorExprBuf(SStr); 4428 GlobalConstructionExp->printPretty(constructorExprBuf, nullptr, 4429 PrintingPolicy(LangOpts)); 4430 globalBuf += constructorExprBuf.str(); 4431 globalBuf += ";\n"; 4432 InsertText(FunLocStart, globalBuf); 4433 GlobalConstructionExp = nullptr; 4434 } 4435 4436 Blocks.clear(); 4437 InnerDeclRefsCount.clear(); 4438 InnerDeclRefs.clear(); 4439 RewrittenBlockExprs.clear(); 4440 } 4441 4442 void RewriteModernObjC::InsertBlockLiteralsWithinFunction(FunctionDecl *FD) { 4443 SourceLocation FunLocStart = 4444 (!Blocks.empty()) ? getFunctionSourceLocation(*this, FD) 4445 : FD->getTypeSpecStartLoc(); 4446 StringRef FuncName = FD->getName(); 4447 4448 SynthesizeBlockLiterals(FunLocStart, FuncName); 4449 } 4450 4451 static void BuildUniqueMethodName(std::string &Name, 4452 ObjCMethodDecl *MD) { 4453 ObjCInterfaceDecl *IFace = MD->getClassInterface(); 4454 Name = IFace->getName(); 4455 Name += "__" + MD->getSelector().getAsString(); 4456 // Convert colons to underscores. 4457 std::string::size_type loc = 0; 4458 while ((loc = Name.find(':', loc)) != std::string::npos) 4459 Name.replace(loc, 1, "_"); 4460 } 4461 4462 void RewriteModernObjC::InsertBlockLiteralsWithinMethod(ObjCMethodDecl *MD) { 4463 //fprintf(stderr,"In InsertBlockLiteralsWitinMethod\n"); 4464 //SourceLocation FunLocStart = MD->getLocStart(); 4465 SourceLocation FunLocStart = MD->getLocStart(); 4466 std::string FuncName; 4467 BuildUniqueMethodName(FuncName, MD); 4468 SynthesizeBlockLiterals(FunLocStart, FuncName); 4469 } 4470 4471 void RewriteModernObjC::GetBlockDeclRefExprs(Stmt *S) { 4472 for (Stmt *SubStmt : S->children()) 4473 if (SubStmt) { 4474 if (BlockExpr *CBE = dyn_cast<BlockExpr>(SubStmt)) 4475 GetBlockDeclRefExprs(CBE->getBody()); 4476 else 4477 GetBlockDeclRefExprs(SubStmt); 4478 } 4479 // Handle specific things. 4480 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) 4481 if (DRE->refersToEnclosingVariableOrCapture() || 4482 HasLocalVariableExternalStorage(DRE->getDecl())) 4483 // FIXME: Handle enums. 4484 BlockDeclRefs.push_back(DRE); 4485 } 4486 4487 void RewriteModernObjC::GetInnerBlockDeclRefExprs(Stmt *S, 4488 SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs, 4489 llvm::SmallPtrSetImpl<const DeclContext *> &InnerContexts) { 4490 for (Stmt *SubStmt : S->children()) 4491 if (SubStmt) { 4492 if (BlockExpr *CBE = dyn_cast<BlockExpr>(SubStmt)) { 4493 InnerContexts.insert(cast<DeclContext>(CBE->getBlockDecl())); 4494 GetInnerBlockDeclRefExprs(CBE->getBody(), 4495 InnerBlockDeclRefs, 4496 InnerContexts); 4497 } 4498 else 4499 GetInnerBlockDeclRefExprs(SubStmt, InnerBlockDeclRefs, InnerContexts); 4500 } 4501 // Handle specific things. 4502 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) { 4503 if (DRE->refersToEnclosingVariableOrCapture() || 4504 HasLocalVariableExternalStorage(DRE->getDecl())) { 4505 if (!InnerContexts.count(DRE->getDecl()->getDeclContext())) 4506 InnerBlockDeclRefs.push_back(DRE); 4507 if (VarDecl *Var = cast<VarDecl>(DRE->getDecl())) 4508 if (Var->isFunctionOrMethodVarDecl()) 4509 ImportedLocalExternalDecls.insert(Var); 4510 } 4511 } 4512 } 4513 4514 /// convertObjCTypeToCStyleType - This routine converts such objc types 4515 /// as qualified objects, and blocks to their closest c/c++ types that 4516 /// it can. It returns true if input type was modified. 4517 bool RewriteModernObjC::convertObjCTypeToCStyleType(QualType &T) { 4518 QualType oldT = T; 4519 convertBlockPointerToFunctionPointer(T); 4520 if (T->isFunctionPointerType()) { 4521 QualType PointeeTy; 4522 if (const PointerType* PT = T->getAs<PointerType>()) { 4523 PointeeTy = PT->getPointeeType(); 4524 if (const FunctionType *FT = PointeeTy->getAs<FunctionType>()) { 4525 T = convertFunctionTypeOfBlocks(FT); 4526 T = Context->getPointerType(T); 4527 } 4528 } 4529 } 4530 4531 convertToUnqualifiedObjCType(T); 4532 return T != oldT; 4533 } 4534 4535 /// convertFunctionTypeOfBlocks - This routine converts a function type 4536 /// whose result type may be a block pointer or whose argument type(s) 4537 /// might be block pointers to an equivalent function type replacing 4538 /// all block pointers to function pointers. 4539 QualType RewriteModernObjC::convertFunctionTypeOfBlocks(const FunctionType *FT) { 4540 const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(FT); 4541 // FTP will be null for closures that don't take arguments. 4542 // Generate a funky cast. 4543 SmallVector<QualType, 8> ArgTypes; 4544 QualType Res = FT->getReturnType(); 4545 bool modified = convertObjCTypeToCStyleType(Res); 4546 4547 if (FTP) { 4548 for (auto &I : FTP->param_types()) { 4549 QualType t = I; 4550 // Make sure we convert "t (^)(...)" to "t (*)(...)". 4551 if (convertObjCTypeToCStyleType(t)) 4552 modified = true; 4553 ArgTypes.push_back(t); 4554 } 4555 } 4556 QualType FuncType; 4557 if (modified) 4558 FuncType = getSimpleFunctionType(Res, ArgTypes); 4559 else FuncType = QualType(FT, 0); 4560 return FuncType; 4561 } 4562 4563 Stmt *RewriteModernObjC::SynthesizeBlockCall(CallExpr *Exp, const Expr *BlockExp) { 4564 // Navigate to relevant type information. 4565 const BlockPointerType *CPT = nullptr; 4566 4567 if (const DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(BlockExp)) { 4568 CPT = DRE->getType()->getAs<BlockPointerType>(); 4569 } else if (const MemberExpr *MExpr = dyn_cast<MemberExpr>(BlockExp)) { 4570 CPT = MExpr->getType()->getAs<BlockPointerType>(); 4571 } 4572 else if (const ParenExpr *PRE = dyn_cast<ParenExpr>(BlockExp)) { 4573 return SynthesizeBlockCall(Exp, PRE->getSubExpr()); 4574 } 4575 else if (const ImplicitCastExpr *IEXPR = dyn_cast<ImplicitCastExpr>(BlockExp)) 4576 CPT = IEXPR->getType()->getAs<BlockPointerType>(); 4577 else if (const ConditionalOperator *CEXPR = 4578 dyn_cast<ConditionalOperator>(BlockExp)) { 4579 Expr *LHSExp = CEXPR->getLHS(); 4580 Stmt *LHSStmt = SynthesizeBlockCall(Exp, LHSExp); 4581 Expr *RHSExp = CEXPR->getRHS(); 4582 Stmt *RHSStmt = SynthesizeBlockCall(Exp, RHSExp); 4583 Expr *CONDExp = CEXPR->getCond(); 4584 ConditionalOperator *CondExpr = 4585 new (Context) ConditionalOperator(CONDExp, 4586 SourceLocation(), cast<Expr>(LHSStmt), 4587 SourceLocation(), cast<Expr>(RHSStmt), 4588 Exp->getType(), VK_RValue, OK_Ordinary); 4589 return CondExpr; 4590 } else if (const ObjCIvarRefExpr *IRE = dyn_cast<ObjCIvarRefExpr>(BlockExp)) { 4591 CPT = IRE->getType()->getAs<BlockPointerType>(); 4592 } else if (const PseudoObjectExpr *POE 4593 = dyn_cast<PseudoObjectExpr>(BlockExp)) { 4594 CPT = POE->getType()->castAs<BlockPointerType>(); 4595 } else { 4596 assert(false && "RewriteBlockClass: Bad type"); 4597 } 4598 assert(CPT && "RewriteBlockClass: Bad type"); 4599 const FunctionType *FT = CPT->getPointeeType()->getAs<FunctionType>(); 4600 assert(FT && "RewriteBlockClass: Bad type"); 4601 const FunctionProtoType *FTP = dyn_cast<FunctionProtoType>(FT); 4602 // FTP will be null for closures that don't take arguments. 4603 4604 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 4605 SourceLocation(), SourceLocation(), 4606 &Context->Idents.get("__block_impl")); 4607 QualType PtrBlock = Context->getPointerType(Context->getTagDeclType(RD)); 4608 4609 // Generate a funky cast. 4610 SmallVector<QualType, 8> ArgTypes; 4611 4612 // Push the block argument type. 4613 ArgTypes.push_back(PtrBlock); 4614 if (FTP) { 4615 for (auto &I : FTP->param_types()) { 4616 QualType t = I; 4617 // Make sure we convert "t (^)(...)" to "t (*)(...)". 4618 if (!convertBlockPointerToFunctionPointer(t)) 4619 convertToUnqualifiedObjCType(t); 4620 ArgTypes.push_back(t); 4621 } 4622 } 4623 // Now do the pointer to function cast. 4624 QualType PtrToFuncCastType = getSimpleFunctionType(Exp->getType(), ArgTypes); 4625 4626 PtrToFuncCastType = Context->getPointerType(PtrToFuncCastType); 4627 4628 CastExpr *BlkCast = NoTypeInfoCStyleCastExpr(Context, PtrBlock, 4629 CK_BitCast, 4630 const_cast<Expr*>(BlockExp)); 4631 // Don't forget the parens to enforce the proper binding. 4632 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), 4633 BlkCast); 4634 //PE->dump(); 4635 4636 FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 4637 SourceLocation(), 4638 &Context->Idents.get("FuncPtr"), 4639 Context->VoidPtrTy, nullptr, 4640 /*BitWidth=*/nullptr, /*Mutable=*/true, 4641 ICIS_NoInit); 4642 MemberExpr *ME = 4643 new (Context) MemberExpr(PE, true, SourceLocation(), FD, SourceLocation(), 4644 FD->getType(), VK_LValue, OK_Ordinary); 4645 4646 CastExpr *FunkCast = NoTypeInfoCStyleCastExpr(Context, PtrToFuncCastType, 4647 CK_BitCast, ME); 4648 PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), FunkCast); 4649 4650 SmallVector<Expr*, 8> BlkExprs; 4651 // Add the implicit argument. 4652 BlkExprs.push_back(BlkCast); 4653 // Add the user arguments. 4654 for (CallExpr::arg_iterator I = Exp->arg_begin(), 4655 E = Exp->arg_end(); I != E; ++I) { 4656 BlkExprs.push_back(*I); 4657 } 4658 CallExpr *CE = new (Context) CallExpr(*Context, PE, BlkExprs, 4659 Exp->getType(), VK_RValue, 4660 SourceLocation()); 4661 return CE; 4662 } 4663 4664 // We need to return the rewritten expression to handle cases where the 4665 // DeclRefExpr is embedded in another expression being rewritten. 4666 // For example: 4667 // 4668 // int main() { 4669 // __block Foo *f; 4670 // __block int i; 4671 // 4672 // void (^myblock)() = ^() { 4673 // [f test]; // f is a DeclRefExpr embedded in a message (which is being rewritten). 4674 // i = 77; 4675 // }; 4676 //} 4677 Stmt *RewriteModernObjC::RewriteBlockDeclRefExpr(DeclRefExpr *DeclRefExp) { 4678 // Rewrite the byref variable into BYREFVAR->__forwarding->BYREFVAR 4679 // for each DeclRefExp where BYREFVAR is name of the variable. 4680 ValueDecl *VD = DeclRefExp->getDecl(); 4681 bool isArrow = DeclRefExp->refersToEnclosingVariableOrCapture() || 4682 HasLocalVariableExternalStorage(DeclRefExp->getDecl()); 4683 4684 FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 4685 SourceLocation(), 4686 &Context->Idents.get("__forwarding"), 4687 Context->VoidPtrTy, nullptr, 4688 /*BitWidth=*/nullptr, /*Mutable=*/true, 4689 ICIS_NoInit); 4690 MemberExpr *ME = new (Context) 4691 MemberExpr(DeclRefExp, isArrow, SourceLocation(), FD, SourceLocation(), 4692 FD->getType(), VK_LValue, OK_Ordinary); 4693 4694 StringRef Name = VD->getName(); 4695 FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), SourceLocation(), 4696 &Context->Idents.get(Name), 4697 Context->VoidPtrTy, nullptr, 4698 /*BitWidth=*/nullptr, /*Mutable=*/true, 4699 ICIS_NoInit); 4700 ME = 4701 new (Context) MemberExpr(ME, true, SourceLocation(), FD, SourceLocation(), 4702 DeclRefExp->getType(), VK_LValue, OK_Ordinary); 4703 4704 // Need parens to enforce precedence. 4705 ParenExpr *PE = new (Context) ParenExpr(DeclRefExp->getExprLoc(), 4706 DeclRefExp->getExprLoc(), 4707 ME); 4708 ReplaceStmt(DeclRefExp, PE); 4709 return PE; 4710 } 4711 4712 // Rewrites the imported local variable V with external storage 4713 // (static, extern, etc.) as *V 4714 // 4715 Stmt *RewriteModernObjC::RewriteLocalVariableExternalStorage(DeclRefExpr *DRE) { 4716 ValueDecl *VD = DRE->getDecl(); 4717 if (VarDecl *Var = dyn_cast<VarDecl>(VD)) 4718 if (!ImportedLocalExternalDecls.count(Var)) 4719 return DRE; 4720 Expr *Exp = new (Context) UnaryOperator(DRE, UO_Deref, DRE->getType(), 4721 VK_LValue, OK_Ordinary, 4722 DRE->getLocation()); 4723 // Need parens to enforce precedence. 4724 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), 4725 Exp); 4726 ReplaceStmt(DRE, PE); 4727 return PE; 4728 } 4729 4730 void RewriteModernObjC::RewriteCastExpr(CStyleCastExpr *CE) { 4731 SourceLocation LocStart = CE->getLParenLoc(); 4732 SourceLocation LocEnd = CE->getRParenLoc(); 4733 4734 // Need to avoid trying to rewrite synthesized casts. 4735 if (LocStart.isInvalid()) 4736 return; 4737 // Need to avoid trying to rewrite casts contained in macros. 4738 if (!Rewriter::isRewritable(LocStart) || !Rewriter::isRewritable(LocEnd)) 4739 return; 4740 4741 const char *startBuf = SM->getCharacterData(LocStart); 4742 const char *endBuf = SM->getCharacterData(LocEnd); 4743 QualType QT = CE->getType(); 4744 const Type* TypePtr = QT->getAs<Type>(); 4745 if (isa<TypeOfExprType>(TypePtr)) { 4746 const TypeOfExprType *TypeOfExprTypePtr = cast<TypeOfExprType>(TypePtr); 4747 QT = TypeOfExprTypePtr->getUnderlyingExpr()->getType(); 4748 std::string TypeAsString = "("; 4749 RewriteBlockPointerType(TypeAsString, QT); 4750 TypeAsString += ")"; 4751 ReplaceText(LocStart, endBuf-startBuf+1, TypeAsString); 4752 return; 4753 } 4754 // advance the location to startArgList. 4755 const char *argPtr = startBuf; 4756 4757 while (*argPtr++ && (argPtr < endBuf)) { 4758 switch (*argPtr) { 4759 case '^': 4760 // Replace the '^' with '*'. 4761 LocStart = LocStart.getLocWithOffset(argPtr-startBuf); 4762 ReplaceText(LocStart, 1, "*"); 4763 break; 4764 } 4765 } 4766 } 4767 4768 void RewriteModernObjC::RewriteImplicitCastObjCExpr(CastExpr *IC) { 4769 CastKind CastKind = IC->getCastKind(); 4770 if (CastKind != CK_BlockPointerToObjCPointerCast && 4771 CastKind != CK_AnyPointerToBlockPointerCast) 4772 return; 4773 4774 QualType QT = IC->getType(); 4775 (void)convertBlockPointerToFunctionPointer(QT); 4776 std::string TypeString(QT.getAsString(Context->getPrintingPolicy())); 4777 std::string Str = "("; 4778 Str += TypeString; 4779 Str += ")"; 4780 InsertText(IC->getSubExpr()->getLocStart(), Str); 4781 } 4782 4783 void RewriteModernObjC::RewriteBlockPointerFunctionArgs(FunctionDecl *FD) { 4784 SourceLocation DeclLoc = FD->getLocation(); 4785 unsigned parenCount = 0; 4786 4787 // We have 1 or more arguments that have closure pointers. 4788 const char *startBuf = SM->getCharacterData(DeclLoc); 4789 const char *startArgList = strchr(startBuf, '('); 4790 4791 assert((*startArgList == '(') && "Rewriter fuzzy parser confused"); 4792 4793 parenCount++; 4794 // advance the location to startArgList. 4795 DeclLoc = DeclLoc.getLocWithOffset(startArgList-startBuf); 4796 assert((DeclLoc.isValid()) && "Invalid DeclLoc"); 4797 4798 const char *argPtr = startArgList; 4799 4800 while (*argPtr++ && parenCount) { 4801 switch (*argPtr) { 4802 case '^': 4803 // Replace the '^' with '*'. 4804 DeclLoc = DeclLoc.getLocWithOffset(argPtr-startArgList); 4805 ReplaceText(DeclLoc, 1, "*"); 4806 break; 4807 case '(': 4808 parenCount++; 4809 break; 4810 case ')': 4811 parenCount--; 4812 break; 4813 } 4814 } 4815 } 4816 4817 bool RewriteModernObjC::PointerTypeTakesAnyBlockArguments(QualType QT) { 4818 const FunctionProtoType *FTP; 4819 const PointerType *PT = QT->getAs<PointerType>(); 4820 if (PT) { 4821 FTP = PT->getPointeeType()->getAs<FunctionProtoType>(); 4822 } else { 4823 const BlockPointerType *BPT = QT->getAs<BlockPointerType>(); 4824 assert(BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type"); 4825 FTP = BPT->getPointeeType()->getAs<FunctionProtoType>(); 4826 } 4827 if (FTP) { 4828 for (const auto &I : FTP->param_types()) 4829 if (isTopLevelBlockPointerType(I)) 4830 return true; 4831 } 4832 return false; 4833 } 4834 4835 bool RewriteModernObjC::PointerTypeTakesAnyObjCQualifiedType(QualType QT) { 4836 const FunctionProtoType *FTP; 4837 const PointerType *PT = QT->getAs<PointerType>(); 4838 if (PT) { 4839 FTP = PT->getPointeeType()->getAs<FunctionProtoType>(); 4840 } else { 4841 const BlockPointerType *BPT = QT->getAs<BlockPointerType>(); 4842 assert(BPT && "BlockPointerTypeTakeAnyBlockArguments(): not a block pointer type"); 4843 FTP = BPT->getPointeeType()->getAs<FunctionProtoType>(); 4844 } 4845 if (FTP) { 4846 for (const auto &I : FTP->param_types()) { 4847 if (I->isObjCQualifiedIdType()) 4848 return true; 4849 if (I->isObjCObjectPointerType() && 4850 I->getPointeeType()->isObjCQualifiedInterfaceType()) 4851 return true; 4852 } 4853 4854 } 4855 return false; 4856 } 4857 4858 void RewriteModernObjC::GetExtentOfArgList(const char *Name, const char *&LParen, 4859 const char *&RParen) { 4860 const char *argPtr = strchr(Name, '('); 4861 assert((*argPtr == '(') && "Rewriter fuzzy parser confused"); 4862 4863 LParen = argPtr; // output the start. 4864 argPtr++; // skip past the left paren. 4865 unsigned parenCount = 1; 4866 4867 while (*argPtr && parenCount) { 4868 switch (*argPtr) { 4869 case '(': parenCount++; break; 4870 case ')': parenCount--; break; 4871 default: break; 4872 } 4873 if (parenCount) argPtr++; 4874 } 4875 assert((*argPtr == ')') && "Rewriter fuzzy parser confused"); 4876 RParen = argPtr; // output the end 4877 } 4878 4879 void RewriteModernObjC::RewriteBlockPointerDecl(NamedDecl *ND) { 4880 if (FunctionDecl *FD = dyn_cast<FunctionDecl>(ND)) { 4881 RewriteBlockPointerFunctionArgs(FD); 4882 return; 4883 } 4884 // Handle Variables and Typedefs. 4885 SourceLocation DeclLoc = ND->getLocation(); 4886 QualType DeclT; 4887 if (VarDecl *VD = dyn_cast<VarDecl>(ND)) 4888 DeclT = VD->getType(); 4889 else if (TypedefNameDecl *TDD = dyn_cast<TypedefNameDecl>(ND)) 4890 DeclT = TDD->getUnderlyingType(); 4891 else if (FieldDecl *FD = dyn_cast<FieldDecl>(ND)) 4892 DeclT = FD->getType(); 4893 else 4894 llvm_unreachable("RewriteBlockPointerDecl(): Decl type not yet handled"); 4895 4896 const char *startBuf = SM->getCharacterData(DeclLoc); 4897 const char *endBuf = startBuf; 4898 // scan backward (from the decl location) for the end of the previous decl. 4899 while (*startBuf != '^' && *startBuf != ';' && startBuf != MainFileStart) 4900 startBuf--; 4901 SourceLocation Start = DeclLoc.getLocWithOffset(startBuf-endBuf); 4902 std::string buf; 4903 unsigned OrigLength=0; 4904 // *startBuf != '^' if we are dealing with a pointer to function that 4905 // may take block argument types (which will be handled below). 4906 if (*startBuf == '^') { 4907 // Replace the '^' with '*', computing a negative offset. 4908 buf = '*'; 4909 startBuf++; 4910 OrigLength++; 4911 } 4912 while (*startBuf != ')') { 4913 buf += *startBuf; 4914 startBuf++; 4915 OrigLength++; 4916 } 4917 buf += ')'; 4918 OrigLength++; 4919 4920 if (PointerTypeTakesAnyBlockArguments(DeclT) || 4921 PointerTypeTakesAnyObjCQualifiedType(DeclT)) { 4922 // Replace the '^' with '*' for arguments. 4923 // Replace id<P> with id/*<>*/ 4924 DeclLoc = ND->getLocation(); 4925 startBuf = SM->getCharacterData(DeclLoc); 4926 const char *argListBegin, *argListEnd; 4927 GetExtentOfArgList(startBuf, argListBegin, argListEnd); 4928 while (argListBegin < argListEnd) { 4929 if (*argListBegin == '^') 4930 buf += '*'; 4931 else if (*argListBegin == '<') { 4932 buf += "/*"; 4933 buf += *argListBegin++; 4934 OrigLength++; 4935 while (*argListBegin != '>') { 4936 buf += *argListBegin++; 4937 OrigLength++; 4938 } 4939 buf += *argListBegin; 4940 buf += "*/"; 4941 } 4942 else 4943 buf += *argListBegin; 4944 argListBegin++; 4945 OrigLength++; 4946 } 4947 buf += ')'; 4948 OrigLength++; 4949 } 4950 ReplaceText(Start, OrigLength, buf); 4951 } 4952 4953 /// SynthesizeByrefCopyDestroyHelper - This routine synthesizes: 4954 /// void __Block_byref_id_object_copy(struct Block_byref_id_object *dst, 4955 /// struct Block_byref_id_object *src) { 4956 /// _Block_object_assign (&_dest->object, _src->object, 4957 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_OBJECT 4958 /// [|BLOCK_FIELD_IS_WEAK]) // object 4959 /// _Block_object_assign(&_dest->object, _src->object, 4960 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_BLOCK 4961 /// [|BLOCK_FIELD_IS_WEAK]) // block 4962 /// } 4963 /// And: 4964 /// void __Block_byref_id_object_dispose(struct Block_byref_id_object *_src) { 4965 /// _Block_object_dispose(_src->object, 4966 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_OBJECT 4967 /// [|BLOCK_FIELD_IS_WEAK]) // object 4968 /// _Block_object_dispose(_src->object, 4969 /// BLOCK_BYREF_CALLER | BLOCK_FIELD_IS_BLOCK 4970 /// [|BLOCK_FIELD_IS_WEAK]) // block 4971 /// } 4972 4973 std::string RewriteModernObjC::SynthesizeByrefCopyDestroyHelper(VarDecl *VD, 4974 int flag) { 4975 std::string S; 4976 if (CopyDestroyCache.count(flag)) 4977 return S; 4978 CopyDestroyCache.insert(flag); 4979 S = "static void __Block_byref_id_object_copy_"; 4980 S += utostr(flag); 4981 S += "(void *dst, void *src) {\n"; 4982 4983 // offset into the object pointer is computed as: 4984 // void * + void* + int + int + void* + void * 4985 unsigned IntSize = 4986 static_cast<unsigned>(Context->getTypeSize(Context->IntTy)); 4987 unsigned VoidPtrSize = 4988 static_cast<unsigned>(Context->getTypeSize(Context->VoidPtrTy)); 4989 4990 unsigned offset = (VoidPtrSize*4 + IntSize + IntSize)/Context->getCharWidth(); 4991 S += " _Block_object_assign((char*)dst + "; 4992 S += utostr(offset); 4993 S += ", *(void * *) ((char*)src + "; 4994 S += utostr(offset); 4995 S += "), "; 4996 S += utostr(flag); 4997 S += ");\n}\n"; 4998 4999 S += "static void __Block_byref_id_object_dispose_"; 5000 S += utostr(flag); 5001 S += "(void *src) {\n"; 5002 S += " _Block_object_dispose(*(void * *) ((char*)src + "; 5003 S += utostr(offset); 5004 S += "), "; 5005 S += utostr(flag); 5006 S += ");\n}\n"; 5007 return S; 5008 } 5009 5010 /// RewriteByRefVar - For each __block typex ND variable this routine transforms 5011 /// the declaration into: 5012 /// struct __Block_byref_ND { 5013 /// void *__isa; // NULL for everything except __weak pointers 5014 /// struct __Block_byref_ND *__forwarding; 5015 /// int32_t __flags; 5016 /// int32_t __size; 5017 /// void *__Block_byref_id_object_copy; // If variable is __block ObjC object 5018 /// void *__Block_byref_id_object_dispose; // If variable is __block ObjC object 5019 /// typex ND; 5020 /// }; 5021 /// 5022 /// It then replaces declaration of ND variable with: 5023 /// struct __Block_byref_ND ND = {__isa=0B, __forwarding=&ND, __flags=some_flag, 5024 /// __size=sizeof(struct __Block_byref_ND), 5025 /// ND=initializer-if-any}; 5026 /// 5027 /// 5028 void RewriteModernObjC::RewriteByRefVar(VarDecl *ND, bool firstDecl, 5029 bool lastDecl) { 5030 int flag = 0; 5031 int isa = 0; 5032 SourceLocation DeclLoc = ND->getTypeSpecStartLoc(); 5033 if (DeclLoc.isInvalid()) 5034 // If type location is missing, it is because of missing type (a warning). 5035 // Use variable's location which is good for this case. 5036 DeclLoc = ND->getLocation(); 5037 const char *startBuf = SM->getCharacterData(DeclLoc); 5038 SourceLocation X = ND->getLocEnd(); 5039 X = SM->getExpansionLoc(X); 5040 const char *endBuf = SM->getCharacterData(X); 5041 std::string Name(ND->getNameAsString()); 5042 std::string ByrefType; 5043 RewriteByRefString(ByrefType, Name, ND, true); 5044 ByrefType += " {\n"; 5045 ByrefType += " void *__isa;\n"; 5046 RewriteByRefString(ByrefType, Name, ND); 5047 ByrefType += " *__forwarding;\n"; 5048 ByrefType += " int __flags;\n"; 5049 ByrefType += " int __size;\n"; 5050 // Add void *__Block_byref_id_object_copy; 5051 // void *__Block_byref_id_object_dispose; if needed. 5052 QualType Ty = ND->getType(); 5053 bool HasCopyAndDispose = Context->BlockRequiresCopying(Ty, ND); 5054 if (HasCopyAndDispose) { 5055 ByrefType += " void (*__Block_byref_id_object_copy)(void*, void*);\n"; 5056 ByrefType += " void (*__Block_byref_id_object_dispose)(void*);\n"; 5057 } 5058 5059 QualType T = Ty; 5060 (void)convertBlockPointerToFunctionPointer(T); 5061 T.getAsStringInternal(Name, Context->getPrintingPolicy()); 5062 5063 ByrefType += " " + Name + ";\n"; 5064 ByrefType += "};\n"; 5065 // Insert this type in global scope. It is needed by helper function. 5066 SourceLocation FunLocStart; 5067 if (CurFunctionDef) 5068 FunLocStart = getFunctionSourceLocation(*this, CurFunctionDef); 5069 else { 5070 assert(CurMethodDef && "RewriteByRefVar - CurMethodDef is null"); 5071 FunLocStart = CurMethodDef->getLocStart(); 5072 } 5073 InsertText(FunLocStart, ByrefType); 5074 5075 if (Ty.isObjCGCWeak()) { 5076 flag |= BLOCK_FIELD_IS_WEAK; 5077 isa = 1; 5078 } 5079 if (HasCopyAndDispose) { 5080 flag = BLOCK_BYREF_CALLER; 5081 QualType Ty = ND->getType(); 5082 // FIXME. Handle __weak variable (BLOCK_FIELD_IS_WEAK) as well. 5083 if (Ty->isBlockPointerType()) 5084 flag |= BLOCK_FIELD_IS_BLOCK; 5085 else 5086 flag |= BLOCK_FIELD_IS_OBJECT; 5087 std::string HF = SynthesizeByrefCopyDestroyHelper(ND, flag); 5088 if (!HF.empty()) 5089 Preamble += HF; 5090 } 5091 5092 // struct __Block_byref_ND ND = 5093 // {0, &ND, some_flag, __size=sizeof(struct __Block_byref_ND), 5094 // initializer-if-any}; 5095 bool hasInit = (ND->getInit() != nullptr); 5096 // FIXME. rewriter does not support __block c++ objects which 5097 // require construction. 5098 if (hasInit) 5099 if (CXXConstructExpr *CExp = dyn_cast<CXXConstructExpr>(ND->getInit())) { 5100 CXXConstructorDecl *CXXDecl = CExp->getConstructor(); 5101 if (CXXDecl && CXXDecl->isDefaultConstructor()) 5102 hasInit = false; 5103 } 5104 5105 unsigned flags = 0; 5106 if (HasCopyAndDispose) 5107 flags |= BLOCK_HAS_COPY_DISPOSE; 5108 Name = ND->getNameAsString(); 5109 ByrefType.clear(); 5110 RewriteByRefString(ByrefType, Name, ND); 5111 std::string ForwardingCastType("("); 5112 ForwardingCastType += ByrefType + " *)"; 5113 ByrefType += " " + Name + " = {(void*)"; 5114 ByrefType += utostr(isa); 5115 ByrefType += "," + ForwardingCastType + "&" + Name + ", "; 5116 ByrefType += utostr(flags); 5117 ByrefType += ", "; 5118 ByrefType += "sizeof("; 5119 RewriteByRefString(ByrefType, Name, ND); 5120 ByrefType += ")"; 5121 if (HasCopyAndDispose) { 5122 ByrefType += ", __Block_byref_id_object_copy_"; 5123 ByrefType += utostr(flag); 5124 ByrefType += ", __Block_byref_id_object_dispose_"; 5125 ByrefType += utostr(flag); 5126 } 5127 5128 if (!firstDecl) { 5129 // In multiple __block declarations, and for all but 1st declaration, 5130 // find location of the separating comma. This would be start location 5131 // where new text is to be inserted. 5132 DeclLoc = ND->getLocation(); 5133 const char *startDeclBuf = SM->getCharacterData(DeclLoc); 5134 const char *commaBuf = startDeclBuf; 5135 while (*commaBuf != ',') 5136 commaBuf--; 5137 assert((*commaBuf == ',') && "RewriteByRefVar: can't find ','"); 5138 DeclLoc = DeclLoc.getLocWithOffset(commaBuf - startDeclBuf); 5139 startBuf = commaBuf; 5140 } 5141 5142 if (!hasInit) { 5143 ByrefType += "};\n"; 5144 unsigned nameSize = Name.size(); 5145 // for block or function pointer declaration. Name is already 5146 // part of the declaration. 5147 if (Ty->isBlockPointerType() || Ty->isFunctionPointerType()) 5148 nameSize = 1; 5149 ReplaceText(DeclLoc, endBuf-startBuf+nameSize, ByrefType); 5150 } 5151 else { 5152 ByrefType += ", "; 5153 SourceLocation startLoc; 5154 Expr *E = ND->getInit(); 5155 if (const CStyleCastExpr *ECE = dyn_cast<CStyleCastExpr>(E)) 5156 startLoc = ECE->getLParenLoc(); 5157 else 5158 startLoc = E->getLocStart(); 5159 startLoc = SM->getExpansionLoc(startLoc); 5160 endBuf = SM->getCharacterData(startLoc); 5161 ReplaceText(DeclLoc, endBuf-startBuf, ByrefType); 5162 5163 const char separator = lastDecl ? ';' : ','; 5164 const char *startInitializerBuf = SM->getCharacterData(startLoc); 5165 const char *separatorBuf = strchr(startInitializerBuf, separator); 5166 assert((*separatorBuf == separator) && 5167 "RewriteByRefVar: can't find ';' or ','"); 5168 SourceLocation separatorLoc = 5169 startLoc.getLocWithOffset(separatorBuf-startInitializerBuf); 5170 5171 InsertText(separatorLoc, lastDecl ? "}" : "};\n"); 5172 } 5173 } 5174 5175 void RewriteModernObjC::CollectBlockDeclRefInfo(BlockExpr *Exp) { 5176 // Add initializers for any closure decl refs. 5177 GetBlockDeclRefExprs(Exp->getBody()); 5178 if (BlockDeclRefs.size()) { 5179 // Unique all "by copy" declarations. 5180 for (unsigned i = 0; i < BlockDeclRefs.size(); i++) 5181 if (!BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>()) { 5182 if (!BlockByCopyDeclsPtrSet.count(BlockDeclRefs[i]->getDecl())) { 5183 BlockByCopyDeclsPtrSet.insert(BlockDeclRefs[i]->getDecl()); 5184 BlockByCopyDecls.push_back(BlockDeclRefs[i]->getDecl()); 5185 } 5186 } 5187 // Unique all "by ref" declarations. 5188 for (unsigned i = 0; i < BlockDeclRefs.size(); i++) 5189 if (BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>()) { 5190 if (!BlockByRefDeclsPtrSet.count(BlockDeclRefs[i]->getDecl())) { 5191 BlockByRefDeclsPtrSet.insert(BlockDeclRefs[i]->getDecl()); 5192 BlockByRefDecls.push_back(BlockDeclRefs[i]->getDecl()); 5193 } 5194 } 5195 // Find any imported blocks...they will need special attention. 5196 for (unsigned i = 0; i < BlockDeclRefs.size(); i++) 5197 if (BlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>() || 5198 BlockDeclRefs[i]->getType()->isObjCObjectPointerType() || 5199 BlockDeclRefs[i]->getType()->isBlockPointerType()) 5200 ImportedBlockDecls.insert(BlockDeclRefs[i]->getDecl()); 5201 } 5202 } 5203 5204 FunctionDecl *RewriteModernObjC::SynthBlockInitFunctionDecl(StringRef name) { 5205 IdentifierInfo *ID = &Context->Idents.get(name); 5206 QualType FType = Context->getFunctionNoProtoType(Context->VoidPtrTy); 5207 return FunctionDecl::Create(*Context, TUDecl, SourceLocation(), 5208 SourceLocation(), ID, FType, nullptr, SC_Extern, 5209 false, false); 5210 } 5211 5212 Stmt *RewriteModernObjC::SynthBlockInitExpr(BlockExpr *Exp, 5213 const SmallVectorImpl<DeclRefExpr *> &InnerBlockDeclRefs) { 5214 const BlockDecl *block = Exp->getBlockDecl(); 5215 5216 Blocks.push_back(Exp); 5217 5218 CollectBlockDeclRefInfo(Exp); 5219 5220 // Add inner imported variables now used in current block. 5221 int countOfInnerDecls = 0; 5222 if (!InnerBlockDeclRefs.empty()) { 5223 for (unsigned i = 0; i < InnerBlockDeclRefs.size(); i++) { 5224 DeclRefExpr *Exp = InnerBlockDeclRefs[i]; 5225 ValueDecl *VD = Exp->getDecl(); 5226 if (!VD->hasAttr<BlocksAttr>() && !BlockByCopyDeclsPtrSet.count(VD)) { 5227 // We need to save the copied-in variables in nested 5228 // blocks because it is needed at the end for some of the API generations. 5229 // See SynthesizeBlockLiterals routine. 5230 InnerDeclRefs.push_back(Exp); countOfInnerDecls++; 5231 BlockDeclRefs.push_back(Exp); 5232 BlockByCopyDeclsPtrSet.insert(VD); 5233 BlockByCopyDecls.push_back(VD); 5234 } 5235 if (VD->hasAttr<BlocksAttr>() && !BlockByRefDeclsPtrSet.count(VD)) { 5236 InnerDeclRefs.push_back(Exp); countOfInnerDecls++; 5237 BlockDeclRefs.push_back(Exp); 5238 BlockByRefDeclsPtrSet.insert(VD); 5239 BlockByRefDecls.push_back(VD); 5240 } 5241 } 5242 // Find any imported blocks...they will need special attention. 5243 for (unsigned i = 0; i < InnerBlockDeclRefs.size(); i++) 5244 if (InnerBlockDeclRefs[i]->getDecl()->hasAttr<BlocksAttr>() || 5245 InnerBlockDeclRefs[i]->getType()->isObjCObjectPointerType() || 5246 InnerBlockDeclRefs[i]->getType()->isBlockPointerType()) 5247 ImportedBlockDecls.insert(InnerBlockDeclRefs[i]->getDecl()); 5248 } 5249 InnerDeclRefsCount.push_back(countOfInnerDecls); 5250 5251 std::string FuncName; 5252 5253 if (CurFunctionDef) 5254 FuncName = CurFunctionDef->getNameAsString(); 5255 else if (CurMethodDef) 5256 BuildUniqueMethodName(FuncName, CurMethodDef); 5257 else if (GlobalVarDecl) 5258 FuncName = std::string(GlobalVarDecl->getNameAsString()); 5259 5260 bool GlobalBlockExpr = 5261 block->getDeclContext()->getRedeclContext()->isFileContext(); 5262 5263 if (GlobalBlockExpr && !GlobalVarDecl) { 5264 Diags.Report(block->getLocation(), GlobalBlockRewriteFailedDiag); 5265 GlobalBlockExpr = false; 5266 } 5267 5268 std::string BlockNumber = utostr(Blocks.size()-1); 5269 5270 std::string Func = "__" + FuncName + "_block_func_" + BlockNumber; 5271 5272 // Get a pointer to the function type so we can cast appropriately. 5273 QualType BFT = convertFunctionTypeOfBlocks(Exp->getFunctionType()); 5274 QualType FType = Context->getPointerType(BFT); 5275 5276 FunctionDecl *FD; 5277 Expr *NewRep; 5278 5279 // Simulate a constructor call... 5280 std::string Tag; 5281 5282 if (GlobalBlockExpr) 5283 Tag = "__global_"; 5284 else 5285 Tag = "__"; 5286 Tag += FuncName + "_block_impl_" + BlockNumber; 5287 5288 FD = SynthBlockInitFunctionDecl(Tag); 5289 DeclRefExpr *DRE = new (Context) DeclRefExpr(FD, false, FType, VK_RValue, 5290 SourceLocation()); 5291 5292 SmallVector<Expr*, 4> InitExprs; 5293 5294 // Initialize the block function. 5295 FD = SynthBlockInitFunctionDecl(Func); 5296 DeclRefExpr *Arg = new (Context) DeclRefExpr(FD, false, FD->getType(), 5297 VK_LValue, SourceLocation()); 5298 CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, Context->VoidPtrTy, 5299 CK_BitCast, Arg); 5300 InitExprs.push_back(castExpr); 5301 5302 // Initialize the block descriptor. 5303 std::string DescData = "__" + FuncName + "_block_desc_" + BlockNumber + "_DATA"; 5304 5305 VarDecl *NewVD = VarDecl::Create( 5306 *Context, TUDecl, SourceLocation(), SourceLocation(), 5307 &Context->Idents.get(DescData), Context->VoidPtrTy, nullptr, SC_Static); 5308 UnaryOperator *DescRefExpr = 5309 new (Context) UnaryOperator(new (Context) DeclRefExpr(NewVD, false, 5310 Context->VoidPtrTy, 5311 VK_LValue, 5312 SourceLocation()), 5313 UO_AddrOf, 5314 Context->getPointerType(Context->VoidPtrTy), 5315 VK_RValue, OK_Ordinary, 5316 SourceLocation()); 5317 InitExprs.push_back(DescRefExpr); 5318 5319 // Add initializers for any closure decl refs. 5320 if (BlockDeclRefs.size()) { 5321 Expr *Exp; 5322 // Output all "by copy" declarations. 5323 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByCopyDecls.begin(), 5324 E = BlockByCopyDecls.end(); I != E; ++I) { 5325 if (isObjCType((*I)->getType())) { 5326 // FIXME: Conform to ABI ([[obj retain] autorelease]). 5327 FD = SynthBlockInitFunctionDecl((*I)->getName()); 5328 Exp = new (Context) DeclRefExpr(FD, false, FD->getType(), 5329 VK_LValue, SourceLocation()); 5330 if (HasLocalVariableExternalStorage(*I)) { 5331 QualType QT = (*I)->getType(); 5332 QT = Context->getPointerType(QT); 5333 Exp = new (Context) UnaryOperator(Exp, UO_AddrOf, QT, VK_RValue, 5334 OK_Ordinary, SourceLocation()); 5335 } 5336 } else if (isTopLevelBlockPointerType((*I)->getType())) { 5337 FD = SynthBlockInitFunctionDecl((*I)->getName()); 5338 Arg = new (Context) DeclRefExpr(FD, false, FD->getType(), 5339 VK_LValue, SourceLocation()); 5340 Exp = NoTypeInfoCStyleCastExpr(Context, Context->VoidPtrTy, 5341 CK_BitCast, Arg); 5342 } else { 5343 FD = SynthBlockInitFunctionDecl((*I)->getName()); 5344 Exp = new (Context) DeclRefExpr(FD, false, FD->getType(), 5345 VK_LValue, SourceLocation()); 5346 if (HasLocalVariableExternalStorage(*I)) { 5347 QualType QT = (*I)->getType(); 5348 QT = Context->getPointerType(QT); 5349 Exp = new (Context) UnaryOperator(Exp, UO_AddrOf, QT, VK_RValue, 5350 OK_Ordinary, SourceLocation()); 5351 } 5352 5353 } 5354 InitExprs.push_back(Exp); 5355 } 5356 // Output all "by ref" declarations. 5357 for (SmallVectorImpl<ValueDecl *>::iterator I = BlockByRefDecls.begin(), 5358 E = BlockByRefDecls.end(); I != E; ++I) { 5359 ValueDecl *ND = (*I); 5360 std::string Name(ND->getNameAsString()); 5361 std::string RecName; 5362 RewriteByRefString(RecName, Name, ND, true); 5363 IdentifierInfo *II = &Context->Idents.get(RecName.c_str() 5364 + sizeof("struct")); 5365 RecordDecl *RD = RecordDecl::Create(*Context, TTK_Struct, TUDecl, 5366 SourceLocation(), SourceLocation(), 5367 II); 5368 assert(RD && "SynthBlockInitExpr(): Can't find RecordDecl"); 5369 QualType castT = Context->getPointerType(Context->getTagDeclType(RD)); 5370 5371 FD = SynthBlockInitFunctionDecl((*I)->getName()); 5372 Exp = new (Context) DeclRefExpr(FD, false, FD->getType(), VK_LValue, 5373 SourceLocation()); 5374 bool isNestedCapturedVar = false; 5375 if (block) 5376 for (const auto &CI : block->captures()) { 5377 const VarDecl *variable = CI.getVariable(); 5378 if (variable == ND && CI.isNested()) { 5379 assert (CI.isByRef() && 5380 "SynthBlockInitExpr - captured block variable is not byref"); 5381 isNestedCapturedVar = true; 5382 break; 5383 } 5384 } 5385 // captured nested byref variable has its address passed. Do not take 5386 // its address again. 5387 if (!isNestedCapturedVar) 5388 Exp = new (Context) UnaryOperator(Exp, UO_AddrOf, 5389 Context->getPointerType(Exp->getType()), 5390 VK_RValue, OK_Ordinary, SourceLocation()); 5391 Exp = NoTypeInfoCStyleCastExpr(Context, castT, CK_BitCast, Exp); 5392 InitExprs.push_back(Exp); 5393 } 5394 } 5395 if (ImportedBlockDecls.size()) { 5396 // generate BLOCK_HAS_COPY_DISPOSE(have helper funcs) | BLOCK_HAS_DESCRIPTOR 5397 int flag = (BLOCK_HAS_COPY_DISPOSE | BLOCK_HAS_DESCRIPTOR); 5398 unsigned IntSize = 5399 static_cast<unsigned>(Context->getTypeSize(Context->IntTy)); 5400 Expr *FlagExp = IntegerLiteral::Create(*Context, llvm::APInt(IntSize, flag), 5401 Context->IntTy, SourceLocation()); 5402 InitExprs.push_back(FlagExp); 5403 } 5404 NewRep = new (Context) CallExpr(*Context, DRE, InitExprs, 5405 FType, VK_LValue, SourceLocation()); 5406 5407 if (GlobalBlockExpr) { 5408 assert (!GlobalConstructionExp && 5409 "SynthBlockInitExpr - GlobalConstructionExp must be null"); 5410 GlobalConstructionExp = NewRep; 5411 NewRep = DRE; 5412 } 5413 5414 NewRep = new (Context) UnaryOperator(NewRep, UO_AddrOf, 5415 Context->getPointerType(NewRep->getType()), 5416 VK_RValue, OK_Ordinary, SourceLocation()); 5417 NewRep = NoTypeInfoCStyleCastExpr(Context, FType, CK_BitCast, 5418 NewRep); 5419 // Put Paren around the call. 5420 NewRep = new (Context) ParenExpr(SourceLocation(), SourceLocation(), 5421 NewRep); 5422 5423 BlockDeclRefs.clear(); 5424 BlockByRefDecls.clear(); 5425 BlockByRefDeclsPtrSet.clear(); 5426 BlockByCopyDecls.clear(); 5427 BlockByCopyDeclsPtrSet.clear(); 5428 ImportedBlockDecls.clear(); 5429 return NewRep; 5430 } 5431 5432 bool RewriteModernObjC::IsDeclStmtInForeachHeader(DeclStmt *DS) { 5433 if (const ObjCForCollectionStmt * CS = 5434 dyn_cast<ObjCForCollectionStmt>(Stmts.back())) 5435 return CS->getElement() == DS; 5436 return false; 5437 } 5438 5439 //===----------------------------------------------------------------------===// 5440 // Function Body / Expression rewriting 5441 //===----------------------------------------------------------------------===// 5442 5443 Stmt *RewriteModernObjC::RewriteFunctionBodyOrGlobalInitializer(Stmt *S) { 5444 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || 5445 isa<DoStmt>(S) || isa<ForStmt>(S)) 5446 Stmts.push_back(S); 5447 else if (isa<ObjCForCollectionStmt>(S)) { 5448 Stmts.push_back(S); 5449 ObjCBcLabelNo.push_back(++BcLabelCount); 5450 } 5451 5452 // Pseudo-object operations and ivar references need special 5453 // treatment because we're going to recursively rewrite them. 5454 if (PseudoObjectExpr *PseudoOp = dyn_cast<PseudoObjectExpr>(S)) { 5455 if (isa<BinaryOperator>(PseudoOp->getSyntacticForm())) { 5456 return RewritePropertyOrImplicitSetter(PseudoOp); 5457 } else { 5458 return RewritePropertyOrImplicitGetter(PseudoOp); 5459 } 5460 } else if (ObjCIvarRefExpr *IvarRefExpr = dyn_cast<ObjCIvarRefExpr>(S)) { 5461 return RewriteObjCIvarRefExpr(IvarRefExpr); 5462 } 5463 else if (isa<OpaqueValueExpr>(S)) 5464 S = cast<OpaqueValueExpr>(S)->getSourceExpr(); 5465 5466 SourceRange OrigStmtRange = S->getSourceRange(); 5467 5468 // Perform a bottom up rewrite of all children. 5469 for (Stmt *&childStmt : S->children()) 5470 if (childStmt) { 5471 Stmt *newStmt = RewriteFunctionBodyOrGlobalInitializer(childStmt); 5472 if (newStmt) { 5473 childStmt = newStmt; 5474 } 5475 } 5476 5477 if (BlockExpr *BE = dyn_cast<BlockExpr>(S)) { 5478 SmallVector<DeclRefExpr *, 8> InnerBlockDeclRefs; 5479 llvm::SmallPtrSet<const DeclContext *, 8> InnerContexts; 5480 InnerContexts.insert(BE->getBlockDecl()); 5481 ImportedLocalExternalDecls.clear(); 5482 GetInnerBlockDeclRefExprs(BE->getBody(), 5483 InnerBlockDeclRefs, InnerContexts); 5484 // Rewrite the block body in place. 5485 Stmt *SaveCurrentBody = CurrentBody; 5486 CurrentBody = BE->getBody(); 5487 PropParentMap = nullptr; 5488 // block literal on rhs of a property-dot-sytax assignment 5489 // must be replaced by its synthesize ast so getRewrittenText 5490 // works as expected. In this case, what actually ends up on RHS 5491 // is the blockTranscribed which is the helper function for the 5492 // block literal; as in: self.c = ^() {[ace ARR];}; 5493 bool saveDisableReplaceStmt = DisableReplaceStmt; 5494 DisableReplaceStmt = false; 5495 RewriteFunctionBodyOrGlobalInitializer(BE->getBody()); 5496 DisableReplaceStmt = saveDisableReplaceStmt; 5497 CurrentBody = SaveCurrentBody; 5498 PropParentMap = nullptr; 5499 ImportedLocalExternalDecls.clear(); 5500 // Now we snarf the rewritten text and stash it away for later use. 5501 std::string Str = Rewrite.getRewrittenText(BE->getSourceRange()); 5502 RewrittenBlockExprs[BE] = Str; 5503 5504 Stmt *blockTranscribed = SynthBlockInitExpr(BE, InnerBlockDeclRefs); 5505 5506 //blockTranscribed->dump(); 5507 ReplaceStmt(S, blockTranscribed); 5508 return blockTranscribed; 5509 } 5510 // Handle specific things. 5511 if (ObjCEncodeExpr *AtEncode = dyn_cast<ObjCEncodeExpr>(S)) 5512 return RewriteAtEncode(AtEncode); 5513 5514 if (ObjCSelectorExpr *AtSelector = dyn_cast<ObjCSelectorExpr>(S)) 5515 return RewriteAtSelector(AtSelector); 5516 5517 if (ObjCStringLiteral *AtString = dyn_cast<ObjCStringLiteral>(S)) 5518 return RewriteObjCStringLiteral(AtString); 5519 5520 if (ObjCBoolLiteralExpr *BoolLitExpr = dyn_cast<ObjCBoolLiteralExpr>(S)) 5521 return RewriteObjCBoolLiteralExpr(BoolLitExpr); 5522 5523 if (ObjCBoxedExpr *BoxedExpr = dyn_cast<ObjCBoxedExpr>(S)) 5524 return RewriteObjCBoxedExpr(BoxedExpr); 5525 5526 if (ObjCArrayLiteral *ArrayLitExpr = dyn_cast<ObjCArrayLiteral>(S)) 5527 return RewriteObjCArrayLiteralExpr(ArrayLitExpr); 5528 5529 if (ObjCDictionaryLiteral *DictionaryLitExpr = 5530 dyn_cast<ObjCDictionaryLiteral>(S)) 5531 return RewriteObjCDictionaryLiteralExpr(DictionaryLitExpr); 5532 5533 if (ObjCMessageExpr *MessExpr = dyn_cast<ObjCMessageExpr>(S)) { 5534 #if 0 5535 // Before we rewrite it, put the original message expression in a comment. 5536 SourceLocation startLoc = MessExpr->getLocStart(); 5537 SourceLocation endLoc = MessExpr->getLocEnd(); 5538 5539 const char *startBuf = SM->getCharacterData(startLoc); 5540 const char *endBuf = SM->getCharacterData(endLoc); 5541 5542 std::string messString; 5543 messString += "// "; 5544 messString.append(startBuf, endBuf-startBuf+1); 5545 messString += "\n"; 5546 5547 // FIXME: Missing definition of 5548 // InsertText(clang::SourceLocation, char const*, unsigned int). 5549 // InsertText(startLoc, messString); 5550 // Tried this, but it didn't work either... 5551 // ReplaceText(startLoc, 0, messString.c_str(), messString.size()); 5552 #endif 5553 return RewriteMessageExpr(MessExpr); 5554 } 5555 5556 if (ObjCAutoreleasePoolStmt *StmtAutoRelease = 5557 dyn_cast<ObjCAutoreleasePoolStmt>(S)) { 5558 return RewriteObjCAutoreleasePoolStmt(StmtAutoRelease); 5559 } 5560 5561 if (ObjCAtTryStmt *StmtTry = dyn_cast<ObjCAtTryStmt>(S)) 5562 return RewriteObjCTryStmt(StmtTry); 5563 5564 if (ObjCAtSynchronizedStmt *StmtTry = dyn_cast<ObjCAtSynchronizedStmt>(S)) 5565 return RewriteObjCSynchronizedStmt(StmtTry); 5566 5567 if (ObjCAtThrowStmt *StmtThrow = dyn_cast<ObjCAtThrowStmt>(S)) 5568 return RewriteObjCThrowStmt(StmtThrow); 5569 5570 if (ObjCProtocolExpr *ProtocolExp = dyn_cast<ObjCProtocolExpr>(S)) 5571 return RewriteObjCProtocolExpr(ProtocolExp); 5572 5573 if (ObjCForCollectionStmt *StmtForCollection = 5574 dyn_cast<ObjCForCollectionStmt>(S)) 5575 return RewriteObjCForCollectionStmt(StmtForCollection, 5576 OrigStmtRange.getEnd()); 5577 if (BreakStmt *StmtBreakStmt = 5578 dyn_cast<BreakStmt>(S)) 5579 return RewriteBreakStmt(StmtBreakStmt); 5580 if (ContinueStmt *StmtContinueStmt = 5581 dyn_cast<ContinueStmt>(S)) 5582 return RewriteContinueStmt(StmtContinueStmt); 5583 5584 // Need to check for protocol refs (id <P>, Foo <P> *) in variable decls 5585 // and cast exprs. 5586 if (DeclStmt *DS = dyn_cast<DeclStmt>(S)) { 5587 // FIXME: What we're doing here is modifying the type-specifier that 5588 // precedes the first Decl. In the future the DeclGroup should have 5589 // a separate type-specifier that we can rewrite. 5590 // NOTE: We need to avoid rewriting the DeclStmt if it is within 5591 // the context of an ObjCForCollectionStmt. For example: 5592 // NSArray *someArray; 5593 // for (id <FooProtocol> index in someArray) ; 5594 // This is because RewriteObjCForCollectionStmt() does textual rewriting 5595 // and it depends on the original text locations/positions. 5596 if (Stmts.empty() || !IsDeclStmtInForeachHeader(DS)) 5597 RewriteObjCQualifiedInterfaceTypes(*DS->decl_begin()); 5598 5599 // Blocks rewrite rules. 5600 for (DeclStmt::decl_iterator DI = DS->decl_begin(), DE = DS->decl_end(); 5601 DI != DE; ++DI) { 5602 Decl *SD = *DI; 5603 if (ValueDecl *ND = dyn_cast<ValueDecl>(SD)) { 5604 if (isTopLevelBlockPointerType(ND->getType())) 5605 RewriteBlockPointerDecl(ND); 5606 else if (ND->getType()->isFunctionPointerType()) 5607 CheckFunctionPointerDecl(ND->getType(), ND); 5608 if (VarDecl *VD = dyn_cast<VarDecl>(SD)) { 5609 if (VD->hasAttr<BlocksAttr>()) { 5610 static unsigned uniqueByrefDeclCount = 0; 5611 assert(!BlockByRefDeclNo.count(ND) && 5612 "RewriteFunctionBodyOrGlobalInitializer: Duplicate byref decl"); 5613 BlockByRefDeclNo[ND] = uniqueByrefDeclCount++; 5614 RewriteByRefVar(VD, (DI == DS->decl_begin()), ((DI+1) == DE)); 5615 } 5616 else 5617 RewriteTypeOfDecl(VD); 5618 } 5619 } 5620 if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(SD)) { 5621 if (isTopLevelBlockPointerType(TD->getUnderlyingType())) 5622 RewriteBlockPointerDecl(TD); 5623 else if (TD->getUnderlyingType()->isFunctionPointerType()) 5624 CheckFunctionPointerDecl(TD->getUnderlyingType(), TD); 5625 } 5626 } 5627 } 5628 5629 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(S)) 5630 RewriteObjCQualifiedInterfaceTypes(CE); 5631 5632 if (isa<SwitchStmt>(S) || isa<WhileStmt>(S) || 5633 isa<DoStmt>(S) || isa<ForStmt>(S)) { 5634 assert(!Stmts.empty() && "Statement stack is empty"); 5635 assert ((isa<SwitchStmt>(Stmts.back()) || isa<WhileStmt>(Stmts.back()) || 5636 isa<DoStmt>(Stmts.back()) || isa<ForStmt>(Stmts.back())) 5637 && "Statement stack mismatch"); 5638 Stmts.pop_back(); 5639 } 5640 // Handle blocks rewriting. 5641 if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(S)) { 5642 ValueDecl *VD = DRE->getDecl(); 5643 if (VD->hasAttr<BlocksAttr>()) 5644 return RewriteBlockDeclRefExpr(DRE); 5645 if (HasLocalVariableExternalStorage(VD)) 5646 return RewriteLocalVariableExternalStorage(DRE); 5647 } 5648 5649 if (CallExpr *CE = dyn_cast<CallExpr>(S)) { 5650 if (CE->getCallee()->getType()->isBlockPointerType()) { 5651 Stmt *BlockCall = SynthesizeBlockCall(CE, CE->getCallee()); 5652 ReplaceStmt(S, BlockCall); 5653 return BlockCall; 5654 } 5655 } 5656 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(S)) { 5657 RewriteCastExpr(CE); 5658 } 5659 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(S)) { 5660 RewriteImplicitCastObjCExpr(ICE); 5661 } 5662 #if 0 5663 5664 if (ImplicitCastExpr *ICE = dyn_cast<ImplicitCastExpr>(S)) { 5665 CastExpr *Replacement = new (Context) CastExpr(ICE->getType(), 5666 ICE->getSubExpr(), 5667 SourceLocation()); 5668 // Get the new text. 5669 std::string SStr; 5670 llvm::raw_string_ostream Buf(SStr); 5671 Replacement->printPretty(Buf); 5672 const std::string &Str = Buf.str(); 5673 5674 printf("CAST = %s\n", &Str[0]); 5675 InsertText(ICE->getSubExpr()->getLocStart(), Str); 5676 delete S; 5677 return Replacement; 5678 } 5679 #endif 5680 // Return this stmt unmodified. 5681 return S; 5682 } 5683 5684 void RewriteModernObjC::RewriteRecordBody(RecordDecl *RD) { 5685 for (auto *FD : RD->fields()) { 5686 if (isTopLevelBlockPointerType(FD->getType())) 5687 RewriteBlockPointerDecl(FD); 5688 if (FD->getType()->isObjCQualifiedIdType() || 5689 FD->getType()->isObjCQualifiedInterfaceType()) 5690 RewriteObjCQualifiedInterfaceTypes(FD); 5691 } 5692 } 5693 5694 /// HandleDeclInMainFile - This is called for each top-level decl defined in the 5695 /// main file of the input. 5696 void RewriteModernObjC::HandleDeclInMainFile(Decl *D) { 5697 switch (D->getKind()) { 5698 case Decl::Function: { 5699 FunctionDecl *FD = cast<FunctionDecl>(D); 5700 if (FD->isOverloadedOperator()) 5701 return; 5702 5703 // Since function prototypes don't have ParmDecl's, we check the function 5704 // prototype. This enables us to rewrite function declarations and 5705 // definitions using the same code. 5706 RewriteBlocksInFunctionProtoType(FD->getType(), FD); 5707 5708 if (!FD->isThisDeclarationADefinition()) 5709 break; 5710 5711 // FIXME: If this should support Obj-C++, support CXXTryStmt 5712 if (CompoundStmt *Body = dyn_cast_or_null<CompoundStmt>(FD->getBody())) { 5713 CurFunctionDef = FD; 5714 CurrentBody = Body; 5715 Body = 5716 cast_or_null<CompoundStmt>(RewriteFunctionBodyOrGlobalInitializer(Body)); 5717 FD->setBody(Body); 5718 CurrentBody = nullptr; 5719 if (PropParentMap) { 5720 delete PropParentMap; 5721 PropParentMap = nullptr; 5722 } 5723 // This synthesizes and inserts the block "impl" struct, invoke function, 5724 // and any copy/dispose helper functions. 5725 InsertBlockLiteralsWithinFunction(FD); 5726 RewriteLineDirective(D); 5727 CurFunctionDef = nullptr; 5728 } 5729 break; 5730 } 5731 case Decl::ObjCMethod: { 5732 ObjCMethodDecl *MD = cast<ObjCMethodDecl>(D); 5733 if (CompoundStmt *Body = MD->getCompoundBody()) { 5734 CurMethodDef = MD; 5735 CurrentBody = Body; 5736 Body = 5737 cast_or_null<CompoundStmt>(RewriteFunctionBodyOrGlobalInitializer(Body)); 5738 MD->setBody(Body); 5739 CurrentBody = nullptr; 5740 if (PropParentMap) { 5741 delete PropParentMap; 5742 PropParentMap = nullptr; 5743 } 5744 InsertBlockLiteralsWithinMethod(MD); 5745 RewriteLineDirective(D); 5746 CurMethodDef = nullptr; 5747 } 5748 break; 5749 } 5750 case Decl::ObjCImplementation: { 5751 ObjCImplementationDecl *CI = cast<ObjCImplementationDecl>(D); 5752 ClassImplementation.push_back(CI); 5753 break; 5754 } 5755 case Decl::ObjCCategoryImpl: { 5756 ObjCCategoryImplDecl *CI = cast<ObjCCategoryImplDecl>(D); 5757 CategoryImplementation.push_back(CI); 5758 break; 5759 } 5760 case Decl::Var: { 5761 VarDecl *VD = cast<VarDecl>(D); 5762 RewriteObjCQualifiedInterfaceTypes(VD); 5763 if (isTopLevelBlockPointerType(VD->getType())) 5764 RewriteBlockPointerDecl(VD); 5765 else if (VD->getType()->isFunctionPointerType()) { 5766 CheckFunctionPointerDecl(VD->getType(), VD); 5767 if (VD->getInit()) { 5768 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(VD->getInit())) { 5769 RewriteCastExpr(CE); 5770 } 5771 } 5772 } else if (VD->getType()->isRecordType()) { 5773 RecordDecl *RD = VD->getType()->getAs<RecordType>()->getDecl(); 5774 if (RD->isCompleteDefinition()) 5775 RewriteRecordBody(RD); 5776 } 5777 if (VD->getInit()) { 5778 GlobalVarDecl = VD; 5779 CurrentBody = VD->getInit(); 5780 RewriteFunctionBodyOrGlobalInitializer(VD->getInit()); 5781 CurrentBody = nullptr; 5782 if (PropParentMap) { 5783 delete PropParentMap; 5784 PropParentMap = nullptr; 5785 } 5786 SynthesizeBlockLiterals(VD->getTypeSpecStartLoc(), VD->getName()); 5787 GlobalVarDecl = nullptr; 5788 5789 // This is needed for blocks. 5790 if (CStyleCastExpr *CE = dyn_cast<CStyleCastExpr>(VD->getInit())) { 5791 RewriteCastExpr(CE); 5792 } 5793 } 5794 break; 5795 } 5796 case Decl::TypeAlias: 5797 case Decl::Typedef: { 5798 if (TypedefNameDecl *TD = dyn_cast<TypedefNameDecl>(D)) { 5799 if (isTopLevelBlockPointerType(TD->getUnderlyingType())) 5800 RewriteBlockPointerDecl(TD); 5801 else if (TD->getUnderlyingType()->isFunctionPointerType()) 5802 CheckFunctionPointerDecl(TD->getUnderlyingType(), TD); 5803 else 5804 RewriteObjCQualifiedInterfaceTypes(TD); 5805 } 5806 break; 5807 } 5808 case Decl::CXXRecord: 5809 case Decl::Record: { 5810 RecordDecl *RD = cast<RecordDecl>(D); 5811 if (RD->isCompleteDefinition()) 5812 RewriteRecordBody(RD); 5813 break; 5814 } 5815 default: 5816 break; 5817 } 5818 // Nothing yet. 5819 } 5820 5821 /// Write_ProtocolExprReferencedMetadata - This routine writer out the 5822 /// protocol reference symbols in the for of: 5823 /// struct _protocol_t *PROTOCOL_REF = &PROTOCOL_METADATA. 5824 static void Write_ProtocolExprReferencedMetadata(ASTContext *Context, 5825 ObjCProtocolDecl *PDecl, 5826 std::string &Result) { 5827 // Also output .objc_protorefs$B section and its meta-data. 5828 if (Context->getLangOpts().MicrosoftExt) 5829 Result += "static "; 5830 Result += "struct _protocol_t *"; 5831 Result += "_OBJC_PROTOCOL_REFERENCE_$_"; 5832 Result += PDecl->getNameAsString(); 5833 Result += " = &"; 5834 Result += "_OBJC_PROTOCOL_"; Result += PDecl->getNameAsString(); 5835 Result += ";\n"; 5836 } 5837 5838 void RewriteModernObjC::HandleTranslationUnit(ASTContext &C) { 5839 if (Diags.hasErrorOccurred()) 5840 return; 5841 5842 RewriteInclude(); 5843 5844 for (unsigned i = 0, e = FunctionDefinitionsSeen.size(); i < e; i++) { 5845 // translation of function bodies were postponed until all class and 5846 // their extensions and implementations are seen. This is because, we 5847 // cannot build grouping structs for bitfields until they are all seen. 5848 FunctionDecl *FDecl = FunctionDefinitionsSeen[i]; 5849 HandleTopLevelSingleDecl(FDecl); 5850 } 5851 5852 // Here's a great place to add any extra declarations that may be needed. 5853 // Write out meta data for each @protocol(<expr>). 5854 for (ObjCProtocolDecl *ProtDecl : ProtocolExprDecls) { 5855 RewriteObjCProtocolMetaData(ProtDecl, Preamble); 5856 Write_ProtocolExprReferencedMetadata(Context, ProtDecl, Preamble); 5857 } 5858 5859 InsertText(SM->getLocForStartOfFile(MainFileID), Preamble, false); 5860 5861 if (ClassImplementation.size() || CategoryImplementation.size()) 5862 RewriteImplementations(); 5863 5864 for (unsigned i = 0, e = ObjCInterfacesSeen.size(); i < e; i++) { 5865 ObjCInterfaceDecl *CDecl = ObjCInterfacesSeen[i]; 5866 // Write struct declaration for the class matching its ivar declarations. 5867 // Note that for modern abi, this is postponed until the end of TU 5868 // because class extensions and the implementation might declare their own 5869 // private ivars. 5870 RewriteInterfaceDecl(CDecl); 5871 } 5872 5873 // Get the buffer corresponding to MainFileID. If we haven't changed it, then 5874 // we are done. 5875 if (const RewriteBuffer *RewriteBuf = 5876 Rewrite.getRewriteBufferFor(MainFileID)) { 5877 //printf("Changed:\n"); 5878 *OutFile << std::string(RewriteBuf->begin(), RewriteBuf->end()); 5879 } else { 5880 llvm::errs() << "No changes\n"; 5881 } 5882 5883 if (ClassImplementation.size() || CategoryImplementation.size() || 5884 ProtocolExprDecls.size()) { 5885 // Rewrite Objective-c meta data* 5886 std::string ResultStr; 5887 RewriteMetaDataIntoBuffer(ResultStr); 5888 // Emit metadata. 5889 *OutFile << ResultStr; 5890 } 5891 // Emit ImageInfo; 5892 { 5893 std::string ResultStr; 5894 WriteImageInfo(ResultStr); 5895 *OutFile << ResultStr; 5896 } 5897 OutFile->flush(); 5898 } 5899 5900 void RewriteModernObjC::Initialize(ASTContext &context) { 5901 InitializeCommon(context); 5902 5903 Preamble += "#ifndef __OBJC2__\n"; 5904 Preamble += "#define __OBJC2__\n"; 5905 Preamble += "#endif\n"; 5906 5907 // declaring objc_selector outside the parameter list removes a silly 5908 // scope related warning... 5909 if (IsHeader) 5910 Preamble = "#pragma once\n"; 5911 Preamble += "struct objc_selector; struct objc_class;\n"; 5912 Preamble += "struct __rw_objc_super { \n\tstruct objc_object *object; "; 5913 Preamble += "\n\tstruct objc_object *superClass; "; 5914 // Add a constructor for creating temporary objects. 5915 Preamble += "\n\t__rw_objc_super(struct objc_object *o, struct objc_object *s) "; 5916 Preamble += ": object(o), superClass(s) {} "; 5917 Preamble += "\n};\n"; 5918 5919 if (LangOpts.MicrosoftExt) { 5920 // Define all sections using syntax that makes sense. 5921 // These are currently generated. 5922 Preamble += "\n#pragma section(\".objc_classlist$B\", long, read, write)\n"; 5923 Preamble += "#pragma section(\".objc_catlist$B\", long, read, write)\n"; 5924 Preamble += "#pragma section(\".objc_imageinfo$B\", long, read, write)\n"; 5925 Preamble += "#pragma section(\".objc_nlclslist$B\", long, read, write)\n"; 5926 Preamble += "#pragma section(\".objc_nlcatlist$B\", long, read, write)\n"; 5927 // These are generated but not necessary for functionality. 5928 Preamble += "#pragma section(\".cat_cls_meth$B\", long, read, write)\n"; 5929 Preamble += "#pragma section(\".inst_meth$B\", long, read, write)\n"; 5930 Preamble += "#pragma section(\".cls_meth$B\", long, read, write)\n"; 5931 Preamble += "#pragma section(\".objc_ivar$B\", long, read, write)\n"; 5932 5933 // These need be generated for performance. Currently they are not, 5934 // using API calls instead. 5935 Preamble += "#pragma section(\".objc_selrefs$B\", long, read, write)\n"; 5936 Preamble += "#pragma section(\".objc_classrefs$B\", long, read, write)\n"; 5937 Preamble += "#pragma section(\".objc_superrefs$B\", long, read, write)\n"; 5938 5939 } 5940 Preamble += "#ifndef _REWRITER_typedef_Protocol\n"; 5941 Preamble += "typedef struct objc_object Protocol;\n"; 5942 Preamble += "#define _REWRITER_typedef_Protocol\n"; 5943 Preamble += "#endif\n"; 5944 if (LangOpts.MicrosoftExt) { 5945 Preamble += "#define __OBJC_RW_DLLIMPORT extern \"C\" __declspec(dllimport)\n"; 5946 Preamble += "#define __OBJC_RW_STATICIMPORT extern \"C\"\n"; 5947 } 5948 else 5949 Preamble += "#define __OBJC_RW_DLLIMPORT extern\n"; 5950 5951 Preamble += "__OBJC_RW_DLLIMPORT void objc_msgSend(void);\n"; 5952 Preamble += "__OBJC_RW_DLLIMPORT void objc_msgSendSuper(void);\n"; 5953 Preamble += "__OBJC_RW_DLLIMPORT void objc_msgSend_stret(void);\n"; 5954 Preamble += "__OBJC_RW_DLLIMPORT void objc_msgSendSuper_stret(void);\n"; 5955 Preamble += "__OBJC_RW_DLLIMPORT void objc_msgSend_fpret(void);\n"; 5956 5957 Preamble += "__OBJC_RW_DLLIMPORT struct objc_class *objc_getClass"; 5958 Preamble += "(const char *);\n"; 5959 Preamble += "__OBJC_RW_DLLIMPORT struct objc_class *class_getSuperclass"; 5960 Preamble += "(struct objc_class *);\n"; 5961 Preamble += "__OBJC_RW_DLLIMPORT struct objc_class *objc_getMetaClass"; 5962 Preamble += "(const char *);\n"; 5963 Preamble += "__OBJC_RW_DLLIMPORT void objc_exception_throw( struct objc_object *);\n"; 5964 // @synchronized hooks. 5965 Preamble += "__OBJC_RW_DLLIMPORT int objc_sync_enter( struct objc_object *);\n"; 5966 Preamble += "__OBJC_RW_DLLIMPORT int objc_sync_exit( struct objc_object *);\n"; 5967 Preamble += "__OBJC_RW_DLLIMPORT Protocol *objc_getProtocol(const char *);\n"; 5968 Preamble += "#ifdef _WIN64\n"; 5969 Preamble += "typedef unsigned long long _WIN_NSUInteger;\n"; 5970 Preamble += "#else\n"; 5971 Preamble += "typedef unsigned int _WIN_NSUInteger;\n"; 5972 Preamble += "#endif\n"; 5973 Preamble += "#ifndef __FASTENUMERATIONSTATE\n"; 5974 Preamble += "struct __objcFastEnumerationState {\n\t"; 5975 Preamble += "unsigned long state;\n\t"; 5976 Preamble += "void **itemsPtr;\n\t"; 5977 Preamble += "unsigned long *mutationsPtr;\n\t"; 5978 Preamble += "unsigned long extra[5];\n};\n"; 5979 Preamble += "__OBJC_RW_DLLIMPORT void objc_enumerationMutation(struct objc_object *);\n"; 5980 Preamble += "#define __FASTENUMERATIONSTATE\n"; 5981 Preamble += "#endif\n"; 5982 Preamble += "#ifndef __NSCONSTANTSTRINGIMPL\n"; 5983 Preamble += "struct __NSConstantStringImpl {\n"; 5984 Preamble += " int *isa;\n"; 5985 Preamble += " int flags;\n"; 5986 Preamble += " char *str;\n"; 5987 Preamble += "#if _WIN64\n"; 5988 Preamble += " long long length;\n"; 5989 Preamble += "#else\n"; 5990 Preamble += " long length;\n"; 5991 Preamble += "#endif\n"; 5992 Preamble += "};\n"; 5993 Preamble += "#ifdef CF_EXPORT_CONSTANT_STRING\n"; 5994 Preamble += "extern \"C\" __declspec(dllexport) int __CFConstantStringClassReference[];\n"; 5995 Preamble += "#else\n"; 5996 Preamble += "__OBJC_RW_DLLIMPORT int __CFConstantStringClassReference[];\n"; 5997 Preamble += "#endif\n"; 5998 Preamble += "#define __NSCONSTANTSTRINGIMPL\n"; 5999 Preamble += "#endif\n"; 6000 // Blocks preamble. 6001 Preamble += "#ifndef BLOCK_IMPL\n"; 6002 Preamble += "#define BLOCK_IMPL\n"; 6003 Preamble += "struct __block_impl {\n"; 6004 Preamble += " void *isa;\n"; 6005 Preamble += " int Flags;\n"; 6006 Preamble += " int Reserved;\n"; 6007 Preamble += " void *FuncPtr;\n"; 6008 Preamble += "};\n"; 6009 Preamble += "// Runtime copy/destroy helper functions (from Block_private.h)\n"; 6010 Preamble += "#ifdef __OBJC_EXPORT_BLOCKS\n"; 6011 Preamble += "extern \"C\" __declspec(dllexport) " 6012 "void _Block_object_assign(void *, const void *, const int);\n"; 6013 Preamble += "extern \"C\" __declspec(dllexport) void _Block_object_dispose(const void *, const int);\n"; 6014 Preamble += "extern \"C\" __declspec(dllexport) void *_NSConcreteGlobalBlock[32];\n"; 6015 Preamble += "extern \"C\" __declspec(dllexport) void *_NSConcreteStackBlock[32];\n"; 6016 Preamble += "#else\n"; 6017 Preamble += "__OBJC_RW_DLLIMPORT void _Block_object_assign(void *, const void *, const int);\n"; 6018 Preamble += "__OBJC_RW_DLLIMPORT void _Block_object_dispose(const void *, const int);\n"; 6019 Preamble += "__OBJC_RW_DLLIMPORT void *_NSConcreteGlobalBlock[32];\n"; 6020 Preamble += "__OBJC_RW_DLLIMPORT void *_NSConcreteStackBlock[32];\n"; 6021 Preamble += "#endif\n"; 6022 Preamble += "#endif\n"; 6023 if (LangOpts.MicrosoftExt) { 6024 Preamble += "#undef __OBJC_RW_DLLIMPORT\n"; 6025 Preamble += "#undef __OBJC_RW_STATICIMPORT\n"; 6026 Preamble += "#ifndef KEEP_ATTRIBUTES\n"; // We use this for clang tests. 6027 Preamble += "#define __attribute__(X)\n"; 6028 Preamble += "#endif\n"; 6029 Preamble += "#ifndef __weak\n"; 6030 Preamble += "#define __weak\n"; 6031 Preamble += "#endif\n"; 6032 Preamble += "#ifndef __block\n"; 6033 Preamble += "#define __block\n"; 6034 Preamble += "#endif\n"; 6035 } 6036 else { 6037 Preamble += "#define __block\n"; 6038 Preamble += "#define __weak\n"; 6039 } 6040 6041 // Declarations required for modern objective-c array and dictionary literals. 6042 Preamble += "\n#include <stdarg.h>\n"; 6043 Preamble += "struct __NSContainer_literal {\n"; 6044 Preamble += " void * *arr;\n"; 6045 Preamble += " __NSContainer_literal (unsigned int count, ...) {\n"; 6046 Preamble += "\tva_list marker;\n"; 6047 Preamble += "\tva_start(marker, count);\n"; 6048 Preamble += "\tarr = new void *[count];\n"; 6049 Preamble += "\tfor (unsigned i = 0; i < count; i++)\n"; 6050 Preamble += "\t arr[i] = va_arg(marker, void *);\n"; 6051 Preamble += "\tva_end( marker );\n"; 6052 Preamble += " };\n"; 6053 Preamble += " ~__NSContainer_literal() {\n"; 6054 Preamble += "\tdelete[] arr;\n"; 6055 Preamble += " }\n"; 6056 Preamble += "};\n"; 6057 6058 // Declaration required for implementation of @autoreleasepool statement. 6059 Preamble += "extern \"C\" __declspec(dllimport) void * objc_autoreleasePoolPush(void);\n"; 6060 Preamble += "extern \"C\" __declspec(dllimport) void objc_autoreleasePoolPop(void *);\n\n"; 6061 Preamble += "struct __AtAutoreleasePool {\n"; 6062 Preamble += " __AtAutoreleasePool() {atautoreleasepoolobj = objc_autoreleasePoolPush();}\n"; 6063 Preamble += " ~__AtAutoreleasePool() {objc_autoreleasePoolPop(atautoreleasepoolobj);}\n"; 6064 Preamble += " void * atautoreleasepoolobj;\n"; 6065 Preamble += "};\n"; 6066 6067 // NOTE! Windows uses LLP64 for 64bit mode. So, cast pointer to long long 6068 // as this avoids warning in any 64bit/32bit compilation model. 6069 Preamble += "\n#define __OFFSETOFIVAR__(TYPE, MEMBER) ((long long) &((TYPE *)0)->MEMBER)\n"; 6070 } 6071 6072 /// RewriteIvarOffsetComputation - This routine synthesizes computation of 6073 /// ivar offset. 6074 void RewriteModernObjC::RewriteIvarOffsetComputation(ObjCIvarDecl *ivar, 6075 std::string &Result) { 6076 Result += "__OFFSETOFIVAR__(struct "; 6077 Result += ivar->getContainingInterface()->getNameAsString(); 6078 if (LangOpts.MicrosoftExt) 6079 Result += "_IMPL"; 6080 Result += ", "; 6081 if (ivar->isBitField()) 6082 ObjCIvarBitfieldGroupDecl(ivar, Result); 6083 else 6084 Result += ivar->getNameAsString(); 6085 Result += ")"; 6086 } 6087 6088 /// WriteModernMetadataDeclarations - Writes out metadata declarations for modern ABI. 6089 /// struct _prop_t { 6090 /// const char *name; 6091 /// char *attributes; 6092 /// } 6093 6094 /// struct _prop_list_t { 6095 /// uint32_t entsize; // sizeof(struct _prop_t) 6096 /// uint32_t count_of_properties; 6097 /// struct _prop_t prop_list[count_of_properties]; 6098 /// } 6099 6100 /// struct _protocol_t; 6101 6102 /// struct _protocol_list_t { 6103 /// long protocol_count; // Note, this is 32/64 bit 6104 /// struct _protocol_t * protocol_list[protocol_count]; 6105 /// } 6106 6107 /// struct _objc_method { 6108 /// SEL _cmd; 6109 /// const char *method_type; 6110 /// char *_imp; 6111 /// } 6112 6113 /// struct _method_list_t { 6114 /// uint32_t entsize; // sizeof(struct _objc_method) 6115 /// uint32_t method_count; 6116 /// struct _objc_method method_list[method_count]; 6117 /// } 6118 6119 /// struct _protocol_t { 6120 /// id isa; // NULL 6121 /// const char *protocol_name; 6122 /// const struct _protocol_list_t * protocol_list; // super protocols 6123 /// const struct method_list_t *instance_methods; 6124 /// const struct method_list_t *class_methods; 6125 /// const struct method_list_t *optionalInstanceMethods; 6126 /// const struct method_list_t *optionalClassMethods; 6127 /// const struct _prop_list_t * properties; 6128 /// const uint32_t size; // sizeof(struct _protocol_t) 6129 /// const uint32_t flags; // = 0 6130 /// const char ** extendedMethodTypes; 6131 /// } 6132 6133 /// struct _ivar_t { 6134 /// unsigned long int *offset; // pointer to ivar offset location 6135 /// const char *name; 6136 /// const char *type; 6137 /// uint32_t alignment; 6138 /// uint32_t size; 6139 /// } 6140 6141 /// struct _ivar_list_t { 6142 /// uint32 entsize; // sizeof(struct _ivar_t) 6143 /// uint32 count; 6144 /// struct _ivar_t list[count]; 6145 /// } 6146 6147 /// struct _class_ro_t { 6148 /// uint32_t flags; 6149 /// uint32_t instanceStart; 6150 /// uint32_t instanceSize; 6151 /// uint32_t reserved; // only when building for 64bit targets 6152 /// const uint8_t *ivarLayout; 6153 /// const char *name; 6154 /// const struct _method_list_t *baseMethods; 6155 /// const struct _protocol_list_t *baseProtocols; 6156 /// const struct _ivar_list_t *ivars; 6157 /// const uint8_t *weakIvarLayout; 6158 /// const struct _prop_list_t *properties; 6159 /// } 6160 6161 /// struct _class_t { 6162 /// struct _class_t *isa; 6163 /// struct _class_t *superclass; 6164 /// void *cache; 6165 /// IMP *vtable; 6166 /// struct _class_ro_t *ro; 6167 /// } 6168 6169 /// struct _category_t { 6170 /// const char *name; 6171 /// struct _class_t *cls; 6172 /// const struct _method_list_t *instance_methods; 6173 /// const struct _method_list_t *class_methods; 6174 /// const struct _protocol_list_t *protocols; 6175 /// const struct _prop_list_t *properties; 6176 /// } 6177 6178 /// MessageRefTy - LLVM for: 6179 /// struct _message_ref_t { 6180 /// IMP messenger; 6181 /// SEL name; 6182 /// }; 6183 6184 /// SuperMessageRefTy - LLVM for: 6185 /// struct _super_message_ref_t { 6186 /// SUPER_IMP messenger; 6187 /// SEL name; 6188 /// }; 6189 6190 static void WriteModernMetadataDeclarations(ASTContext *Context, std::string &Result) { 6191 static bool meta_data_declared = false; 6192 if (meta_data_declared) 6193 return; 6194 6195 Result += "\nstruct _prop_t {\n"; 6196 Result += "\tconst char *name;\n"; 6197 Result += "\tconst char *attributes;\n"; 6198 Result += "};\n"; 6199 6200 Result += "\nstruct _protocol_t;\n"; 6201 6202 Result += "\nstruct _objc_method {\n"; 6203 Result += "\tstruct objc_selector * _cmd;\n"; 6204 Result += "\tconst char *method_type;\n"; 6205 Result += "\tvoid *_imp;\n"; 6206 Result += "};\n"; 6207 6208 Result += "\nstruct _protocol_t {\n"; 6209 Result += "\tvoid * isa; // NULL\n"; 6210 Result += "\tconst char *protocol_name;\n"; 6211 Result += "\tconst struct _protocol_list_t * protocol_list; // super protocols\n"; 6212 Result += "\tconst struct method_list_t *instance_methods;\n"; 6213 Result += "\tconst struct method_list_t *class_methods;\n"; 6214 Result += "\tconst struct method_list_t *optionalInstanceMethods;\n"; 6215 Result += "\tconst struct method_list_t *optionalClassMethods;\n"; 6216 Result += "\tconst struct _prop_list_t * properties;\n"; 6217 Result += "\tconst unsigned int size; // sizeof(struct _protocol_t)\n"; 6218 Result += "\tconst unsigned int flags; // = 0\n"; 6219 Result += "\tconst char ** extendedMethodTypes;\n"; 6220 Result += "};\n"; 6221 6222 Result += "\nstruct _ivar_t {\n"; 6223 Result += "\tunsigned long int *offset; // pointer to ivar offset location\n"; 6224 Result += "\tconst char *name;\n"; 6225 Result += "\tconst char *type;\n"; 6226 Result += "\tunsigned int alignment;\n"; 6227 Result += "\tunsigned int size;\n"; 6228 Result += "};\n"; 6229 6230 Result += "\nstruct _class_ro_t {\n"; 6231 Result += "\tunsigned int flags;\n"; 6232 Result += "\tunsigned int instanceStart;\n"; 6233 Result += "\tunsigned int instanceSize;\n"; 6234 const llvm::Triple &Triple(Context->getTargetInfo().getTriple()); 6235 if (Triple.getArch() == llvm::Triple::x86_64) 6236 Result += "\tunsigned int reserved;\n"; 6237 Result += "\tconst unsigned char *ivarLayout;\n"; 6238 Result += "\tconst char *name;\n"; 6239 Result += "\tconst struct _method_list_t *baseMethods;\n"; 6240 Result += "\tconst struct _objc_protocol_list *baseProtocols;\n"; 6241 Result += "\tconst struct _ivar_list_t *ivars;\n"; 6242 Result += "\tconst unsigned char *weakIvarLayout;\n"; 6243 Result += "\tconst struct _prop_list_t *properties;\n"; 6244 Result += "};\n"; 6245 6246 Result += "\nstruct _class_t {\n"; 6247 Result += "\tstruct _class_t *isa;\n"; 6248 Result += "\tstruct _class_t *superclass;\n"; 6249 Result += "\tvoid *cache;\n"; 6250 Result += "\tvoid *vtable;\n"; 6251 Result += "\tstruct _class_ro_t *ro;\n"; 6252 Result += "};\n"; 6253 6254 Result += "\nstruct _category_t {\n"; 6255 Result += "\tconst char *name;\n"; 6256 Result += "\tstruct _class_t *cls;\n"; 6257 Result += "\tconst struct _method_list_t *instance_methods;\n"; 6258 Result += "\tconst struct _method_list_t *class_methods;\n"; 6259 Result += "\tconst struct _protocol_list_t *protocols;\n"; 6260 Result += "\tconst struct _prop_list_t *properties;\n"; 6261 Result += "};\n"; 6262 6263 Result += "extern \"C\" __declspec(dllimport) struct objc_cache _objc_empty_cache;\n"; 6264 Result += "#pragma warning(disable:4273)\n"; 6265 meta_data_declared = true; 6266 } 6267 6268 static void Write_protocol_list_t_TypeDecl(std::string &Result, 6269 long super_protocol_count) { 6270 Result += "struct /*_protocol_list_t*/"; Result += " {\n"; 6271 Result += "\tlong protocol_count; // Note, this is 32/64 bit\n"; 6272 Result += "\tstruct _protocol_t *super_protocols["; 6273 Result += utostr(super_protocol_count); Result += "];\n"; 6274 Result += "}"; 6275 } 6276 6277 static void Write_method_list_t_TypeDecl(std::string &Result, 6278 unsigned int method_count) { 6279 Result += "struct /*_method_list_t*/"; Result += " {\n"; 6280 Result += "\tunsigned int entsize; // sizeof(struct _objc_method)\n"; 6281 Result += "\tunsigned int method_count;\n"; 6282 Result += "\tstruct _objc_method method_list["; 6283 Result += utostr(method_count); Result += "];\n"; 6284 Result += "}"; 6285 } 6286 6287 static void Write__prop_list_t_TypeDecl(std::string &Result, 6288 unsigned int property_count) { 6289 Result += "struct /*_prop_list_t*/"; Result += " {\n"; 6290 Result += "\tunsigned int entsize; // sizeof(struct _prop_t)\n"; 6291 Result += "\tunsigned int count_of_properties;\n"; 6292 Result += "\tstruct _prop_t prop_list["; 6293 Result += utostr(property_count); Result += "];\n"; 6294 Result += "}"; 6295 } 6296 6297 static void Write__ivar_list_t_TypeDecl(std::string &Result, 6298 unsigned int ivar_count) { 6299 Result += "struct /*_ivar_list_t*/"; Result += " {\n"; 6300 Result += "\tunsigned int entsize; // sizeof(struct _prop_t)\n"; 6301 Result += "\tunsigned int count;\n"; 6302 Result += "\tstruct _ivar_t ivar_list["; 6303 Result += utostr(ivar_count); Result += "];\n"; 6304 Result += "}"; 6305 } 6306 6307 static void Write_protocol_list_initializer(ASTContext *Context, std::string &Result, 6308 ArrayRef<ObjCProtocolDecl *> SuperProtocols, 6309 StringRef VarName, 6310 StringRef ProtocolName) { 6311 if (SuperProtocols.size() > 0) { 6312 Result += "\nstatic "; 6313 Write_protocol_list_t_TypeDecl(Result, SuperProtocols.size()); 6314 Result += " "; Result += VarName; 6315 Result += ProtocolName; 6316 Result += " __attribute__ ((used, section (\"__DATA,__objc_const\"))) = {\n"; 6317 Result += "\t"; Result += utostr(SuperProtocols.size()); Result += ",\n"; 6318 for (unsigned i = 0, e = SuperProtocols.size(); i < e; i++) { 6319 ObjCProtocolDecl *SuperPD = SuperProtocols[i]; 6320 Result += "\t&"; Result += "_OBJC_PROTOCOL_"; 6321 Result += SuperPD->getNameAsString(); 6322 if (i == e-1) 6323 Result += "\n};\n"; 6324 else 6325 Result += ",\n"; 6326 } 6327 } 6328 } 6329 6330 static void Write_method_list_t_initializer(RewriteModernObjC &RewriteObj, 6331 ASTContext *Context, std::string &Result, 6332 ArrayRef<ObjCMethodDecl *> Methods, 6333 StringRef VarName, 6334 StringRef TopLevelDeclName, 6335 bool MethodImpl) { 6336 if (Methods.size() > 0) { 6337 Result += "\nstatic "; 6338 Write_method_list_t_TypeDecl(Result, Methods.size()); 6339 Result += " "; Result += VarName; 6340 Result += TopLevelDeclName; 6341 Result += " __attribute__ ((used, section (\"__DATA,__objc_const\"))) = {\n"; 6342 Result += "\t"; Result += "sizeof(_objc_method)"; Result += ",\n"; 6343 Result += "\t"; Result += utostr(Methods.size()); Result += ",\n"; 6344 for (unsigned i = 0, e = Methods.size(); i < e; i++) { 6345 ObjCMethodDecl *MD = Methods[i]; 6346 if (i == 0) 6347 Result += "\t{{(struct objc_selector *)\""; 6348 else 6349 Result += "\t{(struct objc_selector *)\""; 6350 Result += (MD)->getSelector().getAsString(); Result += "\""; 6351 Result += ", "; 6352 std::string MethodTypeString = Context->getObjCEncodingForMethodDecl(MD); 6353 Result += "\""; Result += MethodTypeString; Result += "\""; 6354 Result += ", "; 6355 if (!MethodImpl) 6356 Result += "0"; 6357 else { 6358 Result += "(void *)"; 6359 Result += RewriteObj.MethodInternalNames[MD]; 6360 } 6361 if (i == e-1) 6362 Result += "}}\n"; 6363 else 6364 Result += "},\n"; 6365 } 6366 Result += "};\n"; 6367 } 6368 } 6369 6370 static void Write_prop_list_t_initializer(RewriteModernObjC &RewriteObj, 6371 ASTContext *Context, std::string &Result, 6372 ArrayRef<ObjCPropertyDecl *> Properties, 6373 const Decl *Container, 6374 StringRef VarName, 6375 StringRef ProtocolName) { 6376 if (Properties.size() > 0) { 6377 Result += "\nstatic "; 6378 Write__prop_list_t_TypeDecl(Result, Properties.size()); 6379 Result += " "; Result += VarName; 6380 Result += ProtocolName; 6381 Result += " __attribute__ ((used, section (\"__DATA,__objc_const\"))) = {\n"; 6382 Result += "\t"; Result += "sizeof(_prop_t)"; Result += ",\n"; 6383 Result += "\t"; Result += utostr(Properties.size()); Result += ",\n"; 6384 for (unsigned i = 0, e = Properties.size(); i < e; i++) { 6385 ObjCPropertyDecl *PropDecl = Properties[i]; 6386 if (i == 0) 6387 Result += "\t{{\""; 6388 else 6389 Result += "\t{\""; 6390 Result += PropDecl->getName(); Result += "\","; 6391 std::string PropertyTypeString = 6392 Context->getObjCEncodingForPropertyDecl(PropDecl, Container); 6393 std::string QuotePropertyTypeString; 6394 RewriteObj.QuoteDoublequotes(PropertyTypeString, QuotePropertyTypeString); 6395 Result += "\""; Result += QuotePropertyTypeString; Result += "\""; 6396 if (i == e-1) 6397 Result += "}}\n"; 6398 else 6399 Result += "},\n"; 6400 } 6401 Result += "};\n"; 6402 } 6403 } 6404 6405 // Metadata flags 6406 enum MetaDataDlags { 6407 CLS = 0x0, 6408 CLS_META = 0x1, 6409 CLS_ROOT = 0x2, 6410 OBJC2_CLS_HIDDEN = 0x10, 6411 CLS_EXCEPTION = 0x20, 6412 6413 /// (Obsolete) ARC-specific: this class has a .release_ivars method 6414 CLS_HAS_IVAR_RELEASER = 0x40, 6415 /// class was compiled with -fobjc-arr 6416 CLS_COMPILED_BY_ARC = 0x80 // (1<<7) 6417 }; 6418 6419 static void Write__class_ro_t_initializer(ASTContext *Context, std::string &Result, 6420 unsigned int flags, 6421 const std::string &InstanceStart, 6422 const std::string &InstanceSize, 6423 ArrayRef<ObjCMethodDecl *>baseMethods, 6424 ArrayRef<ObjCProtocolDecl *>baseProtocols, 6425 ArrayRef<ObjCIvarDecl *>ivars, 6426 ArrayRef<ObjCPropertyDecl *>Properties, 6427 StringRef VarName, 6428 StringRef ClassName) { 6429 Result += "\nstatic struct _class_ro_t "; 6430 Result += VarName; Result += ClassName; 6431 Result += " __attribute__ ((used, section (\"__DATA,__objc_const\"))) = {\n"; 6432 Result += "\t"; 6433 Result += llvm::utostr(flags); Result += ", "; 6434 Result += InstanceStart; Result += ", "; 6435 Result += InstanceSize; Result += ", \n"; 6436 Result += "\t"; 6437 const llvm::Triple &Triple(Context->getTargetInfo().getTriple()); 6438 if (Triple.getArch() == llvm::Triple::x86_64) 6439 // uint32_t const reserved; // only when building for 64bit targets 6440 Result += "(unsigned int)0, \n\t"; 6441 // const uint8_t * const ivarLayout; 6442 Result += "0, \n\t"; 6443 Result += "\""; Result += ClassName; Result += "\",\n\t"; 6444 bool metaclass = ((flags & CLS_META) != 0); 6445 if (baseMethods.size() > 0) { 6446 Result += "(const struct _method_list_t *)&"; 6447 if (metaclass) 6448 Result += "_OBJC_$_CLASS_METHODS_"; 6449 else 6450 Result += "_OBJC_$_INSTANCE_METHODS_"; 6451 Result += ClassName; 6452 Result += ",\n\t"; 6453 } 6454 else 6455 Result += "0, \n\t"; 6456 6457 if (!metaclass && baseProtocols.size() > 0) { 6458 Result += "(const struct _objc_protocol_list *)&"; 6459 Result += "_OBJC_CLASS_PROTOCOLS_$_"; Result += ClassName; 6460 Result += ",\n\t"; 6461 } 6462 else 6463 Result += "0, \n\t"; 6464 6465 if (!metaclass && ivars.size() > 0) { 6466 Result += "(const struct _ivar_list_t *)&"; 6467 Result += "_OBJC_$_INSTANCE_VARIABLES_"; Result += ClassName; 6468 Result += ",\n\t"; 6469 } 6470 else 6471 Result += "0, \n\t"; 6472 6473 // weakIvarLayout 6474 Result += "0, \n\t"; 6475 if (!metaclass && Properties.size() > 0) { 6476 Result += "(const struct _prop_list_t *)&"; 6477 Result += "_OBJC_$_PROP_LIST_"; Result += ClassName; 6478 Result += ",\n"; 6479 } 6480 else 6481 Result += "0, \n"; 6482 6483 Result += "};\n"; 6484 } 6485 6486 static void Write_class_t(ASTContext *Context, std::string &Result, 6487 StringRef VarName, 6488 const ObjCInterfaceDecl *CDecl, bool metaclass) { 6489 bool rootClass = (!CDecl->getSuperClass()); 6490 const ObjCInterfaceDecl *RootClass = CDecl; 6491 6492 if (!rootClass) { 6493 // Find the Root class 6494 RootClass = CDecl->getSuperClass(); 6495 while (RootClass->getSuperClass()) { 6496 RootClass = RootClass->getSuperClass(); 6497 } 6498 } 6499 6500 if (metaclass && rootClass) { 6501 // Need to handle a case of use of forward declaration. 6502 Result += "\n"; 6503 Result += "extern \"C\" "; 6504 if (CDecl->getImplementation()) 6505 Result += "__declspec(dllexport) "; 6506 else 6507 Result += "__declspec(dllimport) "; 6508 6509 Result += "struct _class_t OBJC_CLASS_$_"; 6510 Result += CDecl->getNameAsString(); 6511 Result += ";\n"; 6512 } 6513 // Also, for possibility of 'super' metadata class not having been defined yet. 6514 if (!rootClass) { 6515 ObjCInterfaceDecl *SuperClass = CDecl->getSuperClass(); 6516 Result += "\n"; 6517 Result += "extern \"C\" "; 6518 if (SuperClass->getImplementation()) 6519 Result += "__declspec(dllexport) "; 6520 else 6521 Result += "__declspec(dllimport) "; 6522 6523 Result += "struct _class_t "; 6524 Result += VarName; 6525 Result += SuperClass->getNameAsString(); 6526 Result += ";\n"; 6527 6528 if (metaclass && RootClass != SuperClass) { 6529 Result += "extern \"C\" "; 6530 if (RootClass->getImplementation()) 6531 Result += "__declspec(dllexport) "; 6532 else 6533 Result += "__declspec(dllimport) "; 6534 6535 Result += "struct _class_t "; 6536 Result += VarName; 6537 Result += RootClass->getNameAsString(); 6538 Result += ";\n"; 6539 } 6540 } 6541 6542 Result += "\nextern \"C\" __declspec(dllexport) struct _class_t "; 6543 Result += VarName; Result += CDecl->getNameAsString(); 6544 Result += " __attribute__ ((used, section (\"__DATA,__objc_data\"))) = {\n"; 6545 Result += "\t"; 6546 if (metaclass) { 6547 if (!rootClass) { 6548 Result += "0, // &"; Result += VarName; 6549 Result += RootClass->getNameAsString(); 6550 Result += ",\n\t"; 6551 Result += "0, // &"; Result += VarName; 6552 Result += CDecl->getSuperClass()->getNameAsString(); 6553 Result += ",\n\t"; 6554 } 6555 else { 6556 Result += "0, // &"; Result += VarName; 6557 Result += CDecl->getNameAsString(); 6558 Result += ",\n\t"; 6559 Result += "0, // &OBJC_CLASS_$_"; Result += CDecl->getNameAsString(); 6560 Result += ",\n\t"; 6561 } 6562 } 6563 else { 6564 Result += "0, // &OBJC_METACLASS_$_"; 6565 Result += CDecl->getNameAsString(); 6566 Result += ",\n\t"; 6567 if (!rootClass) { 6568 Result += "0, // &"; Result += VarName; 6569 Result += CDecl->getSuperClass()->getNameAsString(); 6570 Result += ",\n\t"; 6571 } 6572 else 6573 Result += "0,\n\t"; 6574 } 6575 Result += "0, // (void *)&_objc_empty_cache,\n\t"; 6576 Result += "0, // unused, was (void *)&_objc_empty_vtable,\n\t"; 6577 if (metaclass) 6578 Result += "&_OBJC_METACLASS_RO_$_"; 6579 else 6580 Result += "&_OBJC_CLASS_RO_$_"; 6581 Result += CDecl->getNameAsString(); 6582 Result += ",\n};\n"; 6583 6584 // Add static function to initialize some of the meta-data fields. 6585 // avoid doing it twice. 6586 if (metaclass) 6587 return; 6588 6589 const ObjCInterfaceDecl *SuperClass = 6590 rootClass ? CDecl : CDecl->getSuperClass(); 6591 6592 Result += "static void OBJC_CLASS_SETUP_$_"; 6593 Result += CDecl->getNameAsString(); 6594 Result += "(void ) {\n"; 6595 Result += "\tOBJC_METACLASS_$_"; Result += CDecl->getNameAsString(); 6596 Result += ".isa = "; Result += "&OBJC_METACLASS_$_"; 6597 Result += RootClass->getNameAsString(); Result += ";\n"; 6598 6599 Result += "\tOBJC_METACLASS_$_"; Result += CDecl->getNameAsString(); 6600 Result += ".superclass = "; 6601 if (rootClass) 6602 Result += "&OBJC_CLASS_$_"; 6603 else 6604 Result += "&OBJC_METACLASS_$_"; 6605 6606 Result += SuperClass->getNameAsString(); Result += ";\n"; 6607 6608 Result += "\tOBJC_METACLASS_$_"; Result += CDecl->getNameAsString(); 6609 Result += ".cache = "; Result += "&_objc_empty_cache"; Result += ";\n"; 6610 6611 Result += "\tOBJC_CLASS_$_"; Result += CDecl->getNameAsString(); 6612 Result += ".isa = "; Result += "&OBJC_METACLASS_$_"; 6613 Result += CDecl->getNameAsString(); Result += ";\n"; 6614 6615 if (!rootClass) { 6616 Result += "\tOBJC_CLASS_$_"; Result += CDecl->getNameAsString(); 6617 Result += ".superclass = "; Result += "&OBJC_CLASS_$_"; 6618 Result += SuperClass->getNameAsString(); Result += ";\n"; 6619 } 6620 6621 Result += "\tOBJC_CLASS_$_"; Result += CDecl->getNameAsString(); 6622 Result += ".cache = "; Result += "&_objc_empty_cache"; Result += ";\n"; 6623 Result += "}\n"; 6624 } 6625 6626 static void Write_category_t(RewriteModernObjC &RewriteObj, ASTContext *Context, 6627 std::string &Result, 6628 ObjCCategoryDecl *CatDecl, 6629 ObjCInterfaceDecl *ClassDecl, 6630 ArrayRef<ObjCMethodDecl *> InstanceMethods, 6631 ArrayRef<ObjCMethodDecl *> ClassMethods, 6632 ArrayRef<ObjCProtocolDecl *> RefedProtocols, 6633 ArrayRef<ObjCPropertyDecl *> ClassProperties) { 6634 StringRef CatName = CatDecl->getName(); 6635 StringRef ClassName = ClassDecl->getName(); 6636 // must declare an extern class object in case this class is not implemented 6637 // in this TU. 6638 Result += "\n"; 6639 Result += "extern \"C\" "; 6640 if (ClassDecl->getImplementation()) 6641 Result += "__declspec(dllexport) "; 6642 else 6643 Result += "__declspec(dllimport) "; 6644 6645 Result += "struct _class_t "; 6646 Result += "OBJC_CLASS_$_"; Result += ClassName; 6647 Result += ";\n"; 6648 6649 Result += "\nstatic struct _category_t "; 6650 Result += "_OBJC_$_CATEGORY_"; 6651 Result += ClassName; Result += "_$_"; Result += CatName; 6652 Result += " __attribute__ ((used, section (\"__DATA,__objc_const\"))) = \n"; 6653 Result += "{\n"; 6654 Result += "\t\""; Result += ClassName; Result += "\",\n"; 6655 Result += "\t0, // &"; Result += "OBJC_CLASS_$_"; Result += ClassName; 6656 Result += ",\n"; 6657 if (InstanceMethods.size() > 0) { 6658 Result += "\t(const struct _method_list_t *)&"; 6659 Result += "_OBJC_$_CATEGORY_INSTANCE_METHODS_"; 6660 Result += ClassName; Result += "_$_"; Result += CatName; 6661 Result += ",\n"; 6662 } 6663 else 6664 Result += "\t0,\n"; 6665 6666 if (ClassMethods.size() > 0) { 6667 Result += "\t(const struct _method_list_t *)&"; 6668 Result += "_OBJC_$_CATEGORY_CLASS_METHODS_"; 6669 Result += ClassName; Result += "_$_"; Result += CatName; 6670 Result += ",\n"; 6671 } 6672 else 6673 Result += "\t0,\n"; 6674 6675 if (RefedProtocols.size() > 0) { 6676 Result += "\t(const struct _protocol_list_t *)&"; 6677 Result += "_OBJC_CATEGORY_PROTOCOLS_$_"; 6678 Result += ClassName; Result += "_$_"; Result += CatName; 6679 Result += ",\n"; 6680 } 6681 else 6682 Result += "\t0,\n"; 6683 6684 if (ClassProperties.size() > 0) { 6685 Result += "\t(const struct _prop_list_t *)&"; Result += "_OBJC_$_PROP_LIST_"; 6686 Result += ClassName; Result += "_$_"; Result += CatName; 6687 Result += ",\n"; 6688 } 6689 else 6690 Result += "\t0,\n"; 6691 6692 Result += "};\n"; 6693 6694 // Add static function to initialize the class pointer in the category structure. 6695 Result += "static void OBJC_CATEGORY_SETUP_$_"; 6696 Result += ClassDecl->getNameAsString(); 6697 Result += "_$_"; 6698 Result += CatName; 6699 Result += "(void ) {\n"; 6700 Result += "\t_OBJC_$_CATEGORY_"; 6701 Result += ClassDecl->getNameAsString(); 6702 Result += "_$_"; 6703 Result += CatName; 6704 Result += ".cls = "; Result += "&OBJC_CLASS_$_"; Result += ClassName; 6705 Result += ";\n}\n"; 6706 } 6707 6708 static void Write__extendedMethodTypes_initializer(RewriteModernObjC &RewriteObj, 6709 ASTContext *Context, std::string &Result, 6710 ArrayRef<ObjCMethodDecl *> Methods, 6711 StringRef VarName, 6712 StringRef ProtocolName) { 6713 if (Methods.size() == 0) 6714 return; 6715 6716 Result += "\nstatic const char *"; 6717 Result += VarName; Result += ProtocolName; 6718 Result += " [] __attribute__ ((used, section (\"__DATA,__objc_const\"))) = \n"; 6719 Result += "{\n"; 6720 for (unsigned i = 0, e = Methods.size(); i < e; i++) { 6721 ObjCMethodDecl *MD = Methods[i]; 6722 std::string MethodTypeString = 6723 Context->getObjCEncodingForMethodDecl(MD, true); 6724 std::string QuoteMethodTypeString; 6725 RewriteObj.QuoteDoublequotes(MethodTypeString, QuoteMethodTypeString); 6726 Result += "\t\""; Result += QuoteMethodTypeString; Result += "\""; 6727 if (i == e-1) 6728 Result += "\n};\n"; 6729 else { 6730 Result += ",\n"; 6731 } 6732 } 6733 } 6734 6735 static void Write_IvarOffsetVar(RewriteModernObjC &RewriteObj, 6736 ASTContext *Context, 6737 std::string &Result, 6738 ArrayRef<ObjCIvarDecl *> Ivars, 6739 ObjCInterfaceDecl *CDecl) { 6740 // FIXME. visibilty of offset symbols may have to be set; for Darwin 6741 // this is what happens: 6742 /** 6743 if (Ivar->getAccessControl() == ObjCIvarDecl::Private || 6744 Ivar->getAccessControl() == ObjCIvarDecl::Package || 6745 Class->getVisibility() == HiddenVisibility) 6746 Visibility shoud be: HiddenVisibility; 6747 else 6748 Visibility shoud be: DefaultVisibility; 6749 */ 6750 6751 Result += "\n"; 6752 for (unsigned i =0, e = Ivars.size(); i < e; i++) { 6753 ObjCIvarDecl *IvarDecl = Ivars[i]; 6754 if (Context->getLangOpts().MicrosoftExt) 6755 Result += "__declspec(allocate(\".objc_ivar$B\")) "; 6756 6757 if (!Context->getLangOpts().MicrosoftExt || 6758 IvarDecl->getAccessControl() == ObjCIvarDecl::Private || 6759 IvarDecl->getAccessControl() == ObjCIvarDecl::Package) 6760 Result += "extern \"C\" unsigned long int "; 6761 else 6762 Result += "extern \"C\" __declspec(dllexport) unsigned long int "; 6763 if (Ivars[i]->isBitField()) 6764 RewriteObj.ObjCIvarBitfieldGroupOffset(IvarDecl, Result); 6765 else 6766 WriteInternalIvarName(CDecl, IvarDecl, Result); 6767 Result += " __attribute__ ((used, section (\"__DATA,__objc_ivar\")))"; 6768 Result += " = "; 6769 RewriteObj.RewriteIvarOffsetComputation(IvarDecl, Result); 6770 Result += ";\n"; 6771 if (Ivars[i]->isBitField()) { 6772 // skip over rest of the ivar bitfields. 6773 SKIP_BITFIELDS(i , e, Ivars); 6774 } 6775 } 6776 } 6777 6778 static void Write__ivar_list_t_initializer(RewriteModernObjC &RewriteObj, 6779 ASTContext *Context, std::string &Result, 6780 ArrayRef<ObjCIvarDecl *> OriginalIvars, 6781 StringRef VarName, 6782 ObjCInterfaceDecl *CDecl) { 6783 if (OriginalIvars.size() > 0) { 6784 Write_IvarOffsetVar(RewriteObj, Context, Result, OriginalIvars, CDecl); 6785 SmallVector<ObjCIvarDecl *, 8> Ivars; 6786 // strip off all but the first ivar bitfield from each group of ivars. 6787 // Such ivars in the ivar list table will be replaced by their grouping struct 6788 // 'ivar'. 6789 for (unsigned i = 0, e = OriginalIvars.size(); i < e; i++) { 6790 if (OriginalIvars[i]->isBitField()) { 6791 Ivars.push_back(OriginalIvars[i]); 6792 // skip over rest of the ivar bitfields. 6793 SKIP_BITFIELDS(i , e, OriginalIvars); 6794 } 6795 else 6796 Ivars.push_back(OriginalIvars[i]); 6797 } 6798 6799 Result += "\nstatic "; 6800 Write__ivar_list_t_TypeDecl(Result, Ivars.size()); 6801 Result += " "; Result += VarName; 6802 Result += CDecl->getNameAsString(); 6803 Result += " __attribute__ ((used, section (\"__DATA,__objc_const\"))) = {\n"; 6804 Result += "\t"; Result += "sizeof(_ivar_t)"; Result += ",\n"; 6805 Result += "\t"; Result += utostr(Ivars.size()); Result += ",\n"; 6806 for (unsigned i =0, e = Ivars.size(); i < e; i++) { 6807 ObjCIvarDecl *IvarDecl = Ivars[i]; 6808 if (i == 0) 6809 Result += "\t{{"; 6810 else 6811 Result += "\t {"; 6812 Result += "(unsigned long int *)&"; 6813 if (Ivars[i]->isBitField()) 6814 RewriteObj.ObjCIvarBitfieldGroupOffset(IvarDecl, Result); 6815 else 6816 WriteInternalIvarName(CDecl, IvarDecl, Result); 6817 Result += ", "; 6818 6819 Result += "\""; 6820 if (Ivars[i]->isBitField()) 6821 RewriteObj.ObjCIvarBitfieldGroupDecl(Ivars[i], Result); 6822 else 6823 Result += IvarDecl->getName(); 6824 Result += "\", "; 6825 6826 QualType IVQT = IvarDecl->getType(); 6827 if (IvarDecl->isBitField()) 6828 IVQT = RewriteObj.GetGroupRecordTypeForObjCIvarBitfield(IvarDecl); 6829 6830 std::string IvarTypeString, QuoteIvarTypeString; 6831 Context->getObjCEncodingForType(IVQT, IvarTypeString, 6832 IvarDecl); 6833 RewriteObj.QuoteDoublequotes(IvarTypeString, QuoteIvarTypeString); 6834 Result += "\""; Result += QuoteIvarTypeString; Result += "\", "; 6835 6836 // FIXME. this alignment represents the host alignment and need be changed to 6837 // represent the target alignment. 6838 unsigned Align = Context->getTypeAlign(IVQT)/8; 6839 Align = llvm::Log2_32(Align); 6840 Result += llvm::utostr(Align); Result += ", "; 6841 CharUnits Size = Context->getTypeSizeInChars(IVQT); 6842 Result += llvm::utostr(Size.getQuantity()); 6843 if (i == e-1) 6844 Result += "}}\n"; 6845 else 6846 Result += "},\n"; 6847 } 6848 Result += "};\n"; 6849 } 6850 } 6851 6852 /// RewriteObjCProtocolMetaData - Rewrite protocols meta-data. 6853 void RewriteModernObjC::RewriteObjCProtocolMetaData(ObjCProtocolDecl *PDecl, 6854 std::string &Result) { 6855 6856 // Do not synthesize the protocol more than once. 6857 if (ObjCSynthesizedProtocols.count(PDecl->getCanonicalDecl())) 6858 return; 6859 WriteModernMetadataDeclarations(Context, Result); 6860 6861 if (ObjCProtocolDecl *Def = PDecl->getDefinition()) 6862 PDecl = Def; 6863 // Must write out all protocol definitions in current qualifier list, 6864 // and in their nested qualifiers before writing out current definition. 6865 for (auto *I : PDecl->protocols()) 6866 RewriteObjCProtocolMetaData(I, Result); 6867 6868 // Construct method lists. 6869 std::vector<ObjCMethodDecl *> InstanceMethods, ClassMethods; 6870 std::vector<ObjCMethodDecl *> OptInstanceMethods, OptClassMethods; 6871 for (auto *MD : PDecl->instance_methods()) { 6872 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) { 6873 OptInstanceMethods.push_back(MD); 6874 } else { 6875 InstanceMethods.push_back(MD); 6876 } 6877 } 6878 6879 for (auto *MD : PDecl->class_methods()) { 6880 if (MD->getImplementationControl() == ObjCMethodDecl::Optional) { 6881 OptClassMethods.push_back(MD); 6882 } else { 6883 ClassMethods.push_back(MD); 6884 } 6885 } 6886 std::vector<ObjCMethodDecl *> AllMethods; 6887 for (unsigned i = 0, e = InstanceMethods.size(); i < e; i++) 6888 AllMethods.push_back(InstanceMethods[i]); 6889 for (unsigned i = 0, e = ClassMethods.size(); i < e; i++) 6890 AllMethods.push_back(ClassMethods[i]); 6891 for (unsigned i = 0, e = OptInstanceMethods.size(); i < e; i++) 6892 AllMethods.push_back(OptInstanceMethods[i]); 6893 for (unsigned i = 0, e = OptClassMethods.size(); i < e; i++) 6894 AllMethods.push_back(OptClassMethods[i]); 6895 6896 Write__extendedMethodTypes_initializer(*this, Context, Result, 6897 AllMethods, 6898 "_OBJC_PROTOCOL_METHOD_TYPES_", 6899 PDecl->getNameAsString()); 6900 // Protocol's super protocol list 6901 SmallVector<ObjCProtocolDecl *, 8> SuperProtocols(PDecl->protocols()); 6902 Write_protocol_list_initializer(Context, Result, SuperProtocols, 6903 "_OBJC_PROTOCOL_REFS_", 6904 PDecl->getNameAsString()); 6905 6906 Write_method_list_t_initializer(*this, Context, Result, InstanceMethods, 6907 "_OBJC_PROTOCOL_INSTANCE_METHODS_", 6908 PDecl->getNameAsString(), false); 6909 6910 Write_method_list_t_initializer(*this, Context, Result, ClassMethods, 6911 "_OBJC_PROTOCOL_CLASS_METHODS_", 6912 PDecl->getNameAsString(), false); 6913 6914 Write_method_list_t_initializer(*this, Context, Result, OptInstanceMethods, 6915 "_OBJC_PROTOCOL_OPT_INSTANCE_METHODS_", 6916 PDecl->getNameAsString(), false); 6917 6918 Write_method_list_t_initializer(*this, Context, Result, OptClassMethods, 6919 "_OBJC_PROTOCOL_OPT_CLASS_METHODS_", 6920 PDecl->getNameAsString(), false); 6921 6922 // Protocol's property metadata. 6923 SmallVector<ObjCPropertyDecl *, 8> ProtocolProperties( 6924 PDecl->instance_properties()); 6925 Write_prop_list_t_initializer(*this, Context, Result, ProtocolProperties, 6926 /* Container */nullptr, 6927 "_OBJC_PROTOCOL_PROPERTIES_", 6928 PDecl->getNameAsString()); 6929 6930 // Writer out root metadata for current protocol: struct _protocol_t 6931 Result += "\n"; 6932 if (LangOpts.MicrosoftExt) 6933 Result += "static "; 6934 Result += "struct _protocol_t _OBJC_PROTOCOL_"; 6935 Result += PDecl->getNameAsString(); 6936 Result += " __attribute__ ((used)) = {\n"; 6937 Result += "\t0,\n"; // id is; is null 6938 Result += "\t\""; Result += PDecl->getNameAsString(); Result += "\",\n"; 6939 if (SuperProtocols.size() > 0) { 6940 Result += "\t(const struct _protocol_list_t *)&"; Result += "_OBJC_PROTOCOL_REFS_"; 6941 Result += PDecl->getNameAsString(); Result += ",\n"; 6942 } 6943 else 6944 Result += "\t0,\n"; 6945 if (InstanceMethods.size() > 0) { 6946 Result += "\t(const struct method_list_t *)&_OBJC_PROTOCOL_INSTANCE_METHODS_"; 6947 Result += PDecl->getNameAsString(); Result += ",\n"; 6948 } 6949 else 6950 Result += "\t0,\n"; 6951 6952 if (ClassMethods.size() > 0) { 6953 Result += "\t(const struct method_list_t *)&_OBJC_PROTOCOL_CLASS_METHODS_"; 6954 Result += PDecl->getNameAsString(); Result += ",\n"; 6955 } 6956 else 6957 Result += "\t0,\n"; 6958 6959 if (OptInstanceMethods.size() > 0) { 6960 Result += "\t(const struct method_list_t *)&_OBJC_PROTOCOL_OPT_INSTANCE_METHODS_"; 6961 Result += PDecl->getNameAsString(); Result += ",\n"; 6962 } 6963 else 6964 Result += "\t0,\n"; 6965 6966 if (OptClassMethods.size() > 0) { 6967 Result += "\t(const struct method_list_t *)&_OBJC_PROTOCOL_OPT_CLASS_METHODS_"; 6968 Result += PDecl->getNameAsString(); Result += ",\n"; 6969 } 6970 else 6971 Result += "\t0,\n"; 6972 6973 if (ProtocolProperties.size() > 0) { 6974 Result += "\t(const struct _prop_list_t *)&_OBJC_PROTOCOL_PROPERTIES_"; 6975 Result += PDecl->getNameAsString(); Result += ",\n"; 6976 } 6977 else 6978 Result += "\t0,\n"; 6979 6980 Result += "\t"; Result += "sizeof(_protocol_t)"; Result += ",\n"; 6981 Result += "\t0,\n"; 6982 6983 if (AllMethods.size() > 0) { 6984 Result += "\t(const char **)&"; Result += "_OBJC_PROTOCOL_METHOD_TYPES_"; 6985 Result += PDecl->getNameAsString(); 6986 Result += "\n};\n"; 6987 } 6988 else 6989 Result += "\t0\n};\n"; 6990 6991 if (LangOpts.MicrosoftExt) 6992 Result += "static "; 6993 Result += "struct _protocol_t *"; 6994 Result += "_OBJC_LABEL_PROTOCOL_$_"; Result += PDecl->getNameAsString(); 6995 Result += " = &_OBJC_PROTOCOL_"; Result += PDecl->getNameAsString(); 6996 Result += ";\n"; 6997 6998 // Mark this protocol as having been generated. 6999 if (!ObjCSynthesizedProtocols.insert(PDecl->getCanonicalDecl()).second) 7000 llvm_unreachable("protocol already synthesized"); 7001 } 7002 7003 /// hasObjCExceptionAttribute - Return true if this class or any super 7004 /// class has the __objc_exception__ attribute. 7005 /// FIXME. Move this to ASTContext.cpp as it is also used for IRGen. 7006 static bool hasObjCExceptionAttribute(ASTContext &Context, 7007 const ObjCInterfaceDecl *OID) { 7008 if (OID->hasAttr<ObjCExceptionAttr>()) 7009 return true; 7010 if (const ObjCInterfaceDecl *Super = OID->getSuperClass()) 7011 return hasObjCExceptionAttribute(Context, Super); 7012 return false; 7013 } 7014 7015 void RewriteModernObjC::RewriteObjCClassMetaData(ObjCImplementationDecl *IDecl, 7016 std::string &Result) { 7017 ObjCInterfaceDecl *CDecl = IDecl->getClassInterface(); 7018 7019 // Explicitly declared @interface's are already synthesized. 7020 if (CDecl->isImplicitInterfaceDecl()) 7021 assert(false && 7022 "Legacy implicit interface rewriting not supported in moder abi"); 7023 7024 WriteModernMetadataDeclarations(Context, Result); 7025 SmallVector<ObjCIvarDecl *, 8> IVars; 7026 7027 for (ObjCIvarDecl *IVD = CDecl->all_declared_ivar_begin(); 7028 IVD; IVD = IVD->getNextIvar()) { 7029 // Ignore unnamed bit-fields. 7030 if (!IVD->getDeclName()) 7031 continue; 7032 IVars.push_back(IVD); 7033 } 7034 7035 Write__ivar_list_t_initializer(*this, Context, Result, IVars, 7036 "_OBJC_$_INSTANCE_VARIABLES_", 7037 CDecl); 7038 7039 // Build _objc_method_list for class's instance methods if needed 7040 SmallVector<ObjCMethodDecl *, 32> InstanceMethods(IDecl->instance_methods()); 7041 7042 // If any of our property implementations have associated getters or 7043 // setters, produce metadata for them as well. 7044 for (const auto *Prop : IDecl->property_impls()) { 7045 if (Prop->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic) 7046 continue; 7047 if (!Prop->getPropertyIvarDecl()) 7048 continue; 7049 ObjCPropertyDecl *PD = Prop->getPropertyDecl(); 7050 if (!PD) 7051 continue; 7052 if (ObjCMethodDecl *Getter = PD->getGetterMethodDecl()) 7053 if (mustSynthesizeSetterGetterMethod(IDecl, PD, true /*getter*/)) 7054 InstanceMethods.push_back(Getter); 7055 if (PD->isReadOnly()) 7056 continue; 7057 if (ObjCMethodDecl *Setter = PD->getSetterMethodDecl()) 7058 if (mustSynthesizeSetterGetterMethod(IDecl, PD, false /*setter*/)) 7059 InstanceMethods.push_back(Setter); 7060 } 7061 7062 Write_method_list_t_initializer(*this, Context, Result, InstanceMethods, 7063 "_OBJC_$_INSTANCE_METHODS_", 7064 IDecl->getNameAsString(), true); 7065 7066 SmallVector<ObjCMethodDecl *, 32> ClassMethods(IDecl->class_methods()); 7067 7068 Write_method_list_t_initializer(*this, Context, Result, ClassMethods, 7069 "_OBJC_$_CLASS_METHODS_", 7070 IDecl->getNameAsString(), true); 7071 7072 // Protocols referenced in class declaration? 7073 // Protocol's super protocol list 7074 std::vector<ObjCProtocolDecl *> RefedProtocols; 7075 const ObjCList<ObjCProtocolDecl> &Protocols = CDecl->getReferencedProtocols(); 7076 for (ObjCList<ObjCProtocolDecl>::iterator I = Protocols.begin(), 7077 E = Protocols.end(); 7078 I != E; ++I) { 7079 RefedProtocols.push_back(*I); 7080 // Must write out all protocol definitions in current qualifier list, 7081 // and in their nested qualifiers before writing out current definition. 7082 RewriteObjCProtocolMetaData(*I, Result); 7083 } 7084 7085 Write_protocol_list_initializer(Context, Result, 7086 RefedProtocols, 7087 "_OBJC_CLASS_PROTOCOLS_$_", 7088 IDecl->getNameAsString()); 7089 7090 // Protocol's property metadata. 7091 SmallVector<ObjCPropertyDecl *, 8> ClassProperties( 7092 CDecl->instance_properties()); 7093 Write_prop_list_t_initializer(*this, Context, Result, ClassProperties, 7094 /* Container */IDecl, 7095 "_OBJC_$_PROP_LIST_", 7096 CDecl->getNameAsString()); 7097 7098 // Data for initializing _class_ro_t metaclass meta-data 7099 uint32_t flags = CLS_META; 7100 std::string InstanceSize; 7101 std::string InstanceStart; 7102 7103 bool classIsHidden = CDecl->getVisibility() == HiddenVisibility; 7104 if (classIsHidden) 7105 flags |= OBJC2_CLS_HIDDEN; 7106 7107 if (!CDecl->getSuperClass()) 7108 // class is root 7109 flags |= CLS_ROOT; 7110 InstanceSize = "sizeof(struct _class_t)"; 7111 InstanceStart = InstanceSize; 7112 Write__class_ro_t_initializer(Context, Result, flags, 7113 InstanceStart, InstanceSize, 7114 ClassMethods, 7115 nullptr, 7116 nullptr, 7117 nullptr, 7118 "_OBJC_METACLASS_RO_$_", 7119 CDecl->getNameAsString()); 7120 7121 // Data for initializing _class_ro_t meta-data 7122 flags = CLS; 7123 if (classIsHidden) 7124 flags |= OBJC2_CLS_HIDDEN; 7125 7126 if (hasObjCExceptionAttribute(*Context, CDecl)) 7127 flags |= CLS_EXCEPTION; 7128 7129 if (!CDecl->getSuperClass()) 7130 // class is root 7131 flags |= CLS_ROOT; 7132 7133 InstanceSize.clear(); 7134 InstanceStart.clear(); 7135 if (!ObjCSynthesizedStructs.count(CDecl)) { 7136 InstanceSize = "0"; 7137 InstanceStart = "0"; 7138 } 7139 else { 7140 InstanceSize = "sizeof(struct "; 7141 InstanceSize += CDecl->getNameAsString(); 7142 InstanceSize += "_IMPL)"; 7143 7144 ObjCIvarDecl *IVD = CDecl->all_declared_ivar_begin(); 7145 if (IVD) { 7146 RewriteIvarOffsetComputation(IVD, InstanceStart); 7147 } 7148 else 7149 InstanceStart = InstanceSize; 7150 } 7151 Write__class_ro_t_initializer(Context, Result, flags, 7152 InstanceStart, InstanceSize, 7153 InstanceMethods, 7154 RefedProtocols, 7155 IVars, 7156 ClassProperties, 7157 "_OBJC_CLASS_RO_$_", 7158 CDecl->getNameAsString()); 7159 7160 Write_class_t(Context, Result, 7161 "OBJC_METACLASS_$_", 7162 CDecl, /*metaclass*/true); 7163 7164 Write_class_t(Context, Result, 7165 "OBJC_CLASS_$_", 7166 CDecl, /*metaclass*/false); 7167 7168 if (ImplementationIsNonLazy(IDecl)) 7169 DefinedNonLazyClasses.push_back(CDecl); 7170 } 7171 7172 void RewriteModernObjC::RewriteClassSetupInitHook(std::string &Result) { 7173 int ClsDefCount = ClassImplementation.size(); 7174 if (!ClsDefCount) 7175 return; 7176 Result += "#pragma section(\".objc_inithooks$B\", long, read, write)\n"; 7177 Result += "__declspec(allocate(\".objc_inithooks$B\")) "; 7178 Result += "static void *OBJC_CLASS_SETUP[] = {\n"; 7179 for (int i = 0; i < ClsDefCount; i++) { 7180 ObjCImplementationDecl *IDecl = ClassImplementation[i]; 7181 ObjCInterfaceDecl *CDecl = IDecl->getClassInterface(); 7182 Result += "\t(void *)&OBJC_CLASS_SETUP_$_"; 7183 Result += CDecl->getName(); Result += ",\n"; 7184 } 7185 Result += "};\n"; 7186 } 7187 7188 void RewriteModernObjC::RewriteMetaDataIntoBuffer(std::string &Result) { 7189 int ClsDefCount = ClassImplementation.size(); 7190 int CatDefCount = CategoryImplementation.size(); 7191 7192 // For each implemented class, write out all its meta data. 7193 for (int i = 0; i < ClsDefCount; i++) 7194 RewriteObjCClassMetaData(ClassImplementation[i], Result); 7195 7196 RewriteClassSetupInitHook(Result); 7197 7198 // For each implemented category, write out all its meta data. 7199 for (int i = 0; i < CatDefCount; i++) 7200 RewriteObjCCategoryImplDecl(CategoryImplementation[i], Result); 7201 7202 RewriteCategorySetupInitHook(Result); 7203 7204 if (ClsDefCount > 0) { 7205 if (LangOpts.MicrosoftExt) 7206 Result += "__declspec(allocate(\".objc_classlist$B\")) "; 7207 Result += "static struct _class_t *L_OBJC_LABEL_CLASS_$ ["; 7208 Result += llvm::utostr(ClsDefCount); Result += "]"; 7209 Result += 7210 " __attribute__((used, section (\"__DATA, __objc_classlist," 7211 "regular,no_dead_strip\")))= {\n"; 7212 for (int i = 0; i < ClsDefCount; i++) { 7213 Result += "\t&OBJC_CLASS_$_"; 7214 Result += ClassImplementation[i]->getNameAsString(); 7215 Result += ",\n"; 7216 } 7217 Result += "};\n"; 7218 7219 if (!DefinedNonLazyClasses.empty()) { 7220 if (LangOpts.MicrosoftExt) 7221 Result += "__declspec(allocate(\".objc_nlclslist$B\")) \n"; 7222 Result += "static struct _class_t *_OBJC_LABEL_NONLAZY_CLASS_$[] = {\n\t"; 7223 for (unsigned i = 0, e = DefinedNonLazyClasses.size(); i < e; i++) { 7224 Result += "\t&OBJC_CLASS_$_"; Result += DefinedNonLazyClasses[i]->getNameAsString(); 7225 Result += ",\n"; 7226 } 7227 Result += "};\n"; 7228 } 7229 } 7230 7231 if (CatDefCount > 0) { 7232 if (LangOpts.MicrosoftExt) 7233 Result += "__declspec(allocate(\".objc_catlist$B\")) "; 7234 Result += "static struct _category_t *L_OBJC_LABEL_CATEGORY_$ ["; 7235 Result += llvm::utostr(CatDefCount); Result += "]"; 7236 Result += 7237 " __attribute__((used, section (\"__DATA, __objc_catlist," 7238 "regular,no_dead_strip\")))= {\n"; 7239 for (int i = 0; i < CatDefCount; i++) { 7240 Result += "\t&_OBJC_$_CATEGORY_"; 7241 Result += 7242 CategoryImplementation[i]->getClassInterface()->getNameAsString(); 7243 Result += "_$_"; 7244 Result += CategoryImplementation[i]->getNameAsString(); 7245 Result += ",\n"; 7246 } 7247 Result += "};\n"; 7248 } 7249 7250 if (!DefinedNonLazyCategories.empty()) { 7251 if (LangOpts.MicrosoftExt) 7252 Result += "__declspec(allocate(\".objc_nlcatlist$B\")) \n"; 7253 Result += "static struct _category_t *_OBJC_LABEL_NONLAZY_CATEGORY_$[] = {\n\t"; 7254 for (unsigned i = 0, e = DefinedNonLazyCategories.size(); i < e; i++) { 7255 Result += "\t&_OBJC_$_CATEGORY_"; 7256 Result += 7257 DefinedNonLazyCategories[i]->getClassInterface()->getNameAsString(); 7258 Result += "_$_"; 7259 Result += DefinedNonLazyCategories[i]->getNameAsString(); 7260 Result += ",\n"; 7261 } 7262 Result += "};\n"; 7263 } 7264 } 7265 7266 void RewriteModernObjC::WriteImageInfo(std::string &Result) { 7267 if (LangOpts.MicrosoftExt) 7268 Result += "__declspec(allocate(\".objc_imageinfo$B\")) \n"; 7269 7270 Result += "static struct IMAGE_INFO { unsigned version; unsigned flag; } "; 7271 // version 0, ObjCABI is 2 7272 Result += "_OBJC_IMAGE_INFO = { 0, 2 };\n"; 7273 } 7274 7275 /// RewriteObjCCategoryImplDecl - Rewrite metadata for each category 7276 /// implementation. 7277 void RewriteModernObjC::RewriteObjCCategoryImplDecl(ObjCCategoryImplDecl *IDecl, 7278 std::string &Result) { 7279 WriteModernMetadataDeclarations(Context, Result); 7280 ObjCInterfaceDecl *ClassDecl = IDecl->getClassInterface(); 7281 // Find category declaration for this implementation. 7282 ObjCCategoryDecl *CDecl 7283 = ClassDecl->FindCategoryDeclaration(IDecl->getIdentifier()); 7284 7285 std::string FullCategoryName = ClassDecl->getNameAsString(); 7286 FullCategoryName += "_$_"; 7287 FullCategoryName += CDecl->getNameAsString(); 7288 7289 // Build _objc_method_list for class's instance methods if needed 7290 SmallVector<ObjCMethodDecl *, 32> InstanceMethods(IDecl->instance_methods()); 7291 7292 // If any of our property implementations have associated getters or 7293 // setters, produce metadata for them as well. 7294 for (const auto *Prop : IDecl->property_impls()) { 7295 if (Prop->getPropertyImplementation() == ObjCPropertyImplDecl::Dynamic) 7296 continue; 7297 if (!Prop->getPropertyIvarDecl()) 7298 continue; 7299 ObjCPropertyDecl *PD = Prop->getPropertyDecl(); 7300 if (!PD) 7301 continue; 7302 if (ObjCMethodDecl *Getter = PD->getGetterMethodDecl()) 7303 InstanceMethods.push_back(Getter); 7304 if (PD->isReadOnly()) 7305 continue; 7306 if (ObjCMethodDecl *Setter = PD->getSetterMethodDecl()) 7307 InstanceMethods.push_back(Setter); 7308 } 7309 7310 Write_method_list_t_initializer(*this, Context, Result, InstanceMethods, 7311 "_OBJC_$_CATEGORY_INSTANCE_METHODS_", 7312 FullCategoryName, true); 7313 7314 SmallVector<ObjCMethodDecl *, 32> ClassMethods(IDecl->class_methods()); 7315 7316 Write_method_list_t_initializer(*this, Context, Result, ClassMethods, 7317 "_OBJC_$_CATEGORY_CLASS_METHODS_", 7318 FullCategoryName, true); 7319 7320 // Protocols referenced in class declaration? 7321 // Protocol's super protocol list 7322 SmallVector<ObjCProtocolDecl *, 8> RefedProtocols(CDecl->protocols()); 7323 for (auto *I : CDecl->protocols()) 7324 // Must write out all protocol definitions in current qualifier list, 7325 // and in their nested qualifiers before writing out current definition. 7326 RewriteObjCProtocolMetaData(I, Result); 7327 7328 Write_protocol_list_initializer(Context, Result, 7329 RefedProtocols, 7330 "_OBJC_CATEGORY_PROTOCOLS_$_", 7331 FullCategoryName); 7332 7333 // Protocol's property metadata. 7334 SmallVector<ObjCPropertyDecl *, 8> ClassProperties( 7335 CDecl->instance_properties()); 7336 Write_prop_list_t_initializer(*this, Context, Result, ClassProperties, 7337 /* Container */IDecl, 7338 "_OBJC_$_PROP_LIST_", 7339 FullCategoryName); 7340 7341 Write_category_t(*this, Context, Result, 7342 CDecl, 7343 ClassDecl, 7344 InstanceMethods, 7345 ClassMethods, 7346 RefedProtocols, 7347 ClassProperties); 7348 7349 // Determine if this category is also "non-lazy". 7350 if (ImplementationIsNonLazy(IDecl)) 7351 DefinedNonLazyCategories.push_back(CDecl); 7352 } 7353 7354 void RewriteModernObjC::RewriteCategorySetupInitHook(std::string &Result) { 7355 int CatDefCount = CategoryImplementation.size(); 7356 if (!CatDefCount) 7357 return; 7358 Result += "#pragma section(\".objc_inithooks$B\", long, read, write)\n"; 7359 Result += "__declspec(allocate(\".objc_inithooks$B\")) "; 7360 Result += "static void *OBJC_CATEGORY_SETUP[] = {\n"; 7361 for (int i = 0; i < CatDefCount; i++) { 7362 ObjCCategoryImplDecl *IDecl = CategoryImplementation[i]; 7363 ObjCCategoryDecl *CatDecl= IDecl->getCategoryDecl(); 7364 ObjCInterfaceDecl *ClassDecl = IDecl->getClassInterface(); 7365 Result += "\t(void *)&OBJC_CATEGORY_SETUP_$_"; 7366 Result += ClassDecl->getName(); 7367 Result += "_$_"; 7368 Result += CatDecl->getName(); 7369 Result += ",\n"; 7370 } 7371 Result += "};\n"; 7372 } 7373 7374 // RewriteObjCMethodsMetaData - Rewrite methods metadata for instance or 7375 /// class methods. 7376 template<typename MethodIterator> 7377 void RewriteModernObjC::RewriteObjCMethodsMetaData(MethodIterator MethodBegin, 7378 MethodIterator MethodEnd, 7379 bool IsInstanceMethod, 7380 StringRef prefix, 7381 StringRef ClassName, 7382 std::string &Result) { 7383 if (MethodBegin == MethodEnd) return; 7384 7385 if (!objc_impl_method) { 7386 /* struct _objc_method { 7387 SEL _cmd; 7388 char *method_types; 7389 void *_imp; 7390 } 7391 */ 7392 Result += "\nstruct _objc_method {\n"; 7393 Result += "\tSEL _cmd;\n"; 7394 Result += "\tchar *method_types;\n"; 7395 Result += "\tvoid *_imp;\n"; 7396 Result += "};\n"; 7397 7398 objc_impl_method = true; 7399 } 7400 7401 // Build _objc_method_list for class's methods if needed 7402 7403 /* struct { 7404 struct _objc_method_list *next_method; 7405 int method_count; 7406 struct _objc_method method_list[]; 7407 } 7408 */ 7409 unsigned NumMethods = std::distance(MethodBegin, MethodEnd); 7410 Result += "\n"; 7411 if (LangOpts.MicrosoftExt) { 7412 if (IsInstanceMethod) 7413 Result += "__declspec(allocate(\".inst_meth$B\")) "; 7414 else 7415 Result += "__declspec(allocate(\".cls_meth$B\")) "; 7416 } 7417 Result += "static struct {\n"; 7418 Result += "\tstruct _objc_method_list *next_method;\n"; 7419 Result += "\tint method_count;\n"; 7420 Result += "\tstruct _objc_method method_list["; 7421 Result += utostr(NumMethods); 7422 Result += "];\n} _OBJC_"; 7423 Result += prefix; 7424 Result += IsInstanceMethod ? "INSTANCE" : "CLASS"; 7425 Result += "_METHODS_"; 7426 Result += ClassName; 7427 Result += " __attribute__ ((used, section (\"__OBJC, __"; 7428 Result += IsInstanceMethod ? "inst" : "cls"; 7429 Result += "_meth\")))= "; 7430 Result += "{\n\t0, " + utostr(NumMethods) + "\n"; 7431 7432 Result += "\t,{{(SEL)\""; 7433 Result += (*MethodBegin)->getSelector().getAsString().c_str(); 7434 std::string MethodTypeString; 7435 Context->getObjCEncodingForMethodDecl(*MethodBegin, MethodTypeString); 7436 Result += "\", \""; 7437 Result += MethodTypeString; 7438 Result += "\", (void *)"; 7439 Result += MethodInternalNames[*MethodBegin]; 7440 Result += "}\n"; 7441 for (++MethodBegin; MethodBegin != MethodEnd; ++MethodBegin) { 7442 Result += "\t ,{(SEL)\""; 7443 Result += (*MethodBegin)->getSelector().getAsString().c_str(); 7444 std::string MethodTypeString; 7445 Context->getObjCEncodingForMethodDecl(*MethodBegin, MethodTypeString); 7446 Result += "\", \""; 7447 Result += MethodTypeString; 7448 Result += "\", (void *)"; 7449 Result += MethodInternalNames[*MethodBegin]; 7450 Result += "}\n"; 7451 } 7452 Result += "\t }\n};\n"; 7453 } 7454 7455 Stmt *RewriteModernObjC::RewriteObjCIvarRefExpr(ObjCIvarRefExpr *IV) { 7456 SourceRange OldRange = IV->getSourceRange(); 7457 Expr *BaseExpr = IV->getBase(); 7458 7459 // Rewrite the base, but without actually doing replaces. 7460 { 7461 DisableReplaceStmtScope S(*this); 7462 BaseExpr = cast<Expr>(RewriteFunctionBodyOrGlobalInitializer(BaseExpr)); 7463 IV->setBase(BaseExpr); 7464 } 7465 7466 ObjCIvarDecl *D = IV->getDecl(); 7467 7468 Expr *Replacement = IV; 7469 7470 if (BaseExpr->getType()->isObjCObjectPointerType()) { 7471 const ObjCInterfaceType *iFaceDecl = 7472 dyn_cast<ObjCInterfaceType>(BaseExpr->getType()->getPointeeType()); 7473 assert(iFaceDecl && "RewriteObjCIvarRefExpr - iFaceDecl is null"); 7474 // lookup which class implements the instance variable. 7475 ObjCInterfaceDecl *clsDeclared = nullptr; 7476 iFaceDecl->getDecl()->lookupInstanceVariable(D->getIdentifier(), 7477 clsDeclared); 7478 assert(clsDeclared && "RewriteObjCIvarRefExpr(): Can't find class"); 7479 7480 // Build name of symbol holding ivar offset. 7481 std::string IvarOffsetName; 7482 if (D->isBitField()) 7483 ObjCIvarBitfieldGroupOffset(D, IvarOffsetName); 7484 else 7485 WriteInternalIvarName(clsDeclared, D, IvarOffsetName); 7486 7487 ReferencedIvars[clsDeclared].insert(D); 7488 7489 // cast offset to "char *". 7490 CastExpr *castExpr = NoTypeInfoCStyleCastExpr(Context, 7491 Context->getPointerType(Context->CharTy), 7492 CK_BitCast, 7493 BaseExpr); 7494 VarDecl *NewVD = VarDecl::Create(*Context, TUDecl, SourceLocation(), 7495 SourceLocation(), &Context->Idents.get(IvarOffsetName), 7496 Context->UnsignedLongTy, nullptr, 7497 SC_Extern); 7498 DeclRefExpr *DRE = new (Context) DeclRefExpr(NewVD, false, 7499 Context->UnsignedLongTy, VK_LValue, 7500 SourceLocation()); 7501 BinaryOperator *addExpr = 7502 new (Context) BinaryOperator(castExpr, DRE, BO_Add, 7503 Context->getPointerType(Context->CharTy), 7504 VK_RValue, OK_Ordinary, SourceLocation(), FPOptions()); 7505 // Don't forget the parens to enforce the proper binding. 7506 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), 7507 SourceLocation(), 7508 addExpr); 7509 QualType IvarT = D->getType(); 7510 if (D->isBitField()) 7511 IvarT = GetGroupRecordTypeForObjCIvarBitfield(D); 7512 7513 if (!isa<TypedefType>(IvarT) && IvarT->isRecordType()) { 7514 RecordDecl *RD = IvarT->getAs<RecordType>()->getDecl(); 7515 RD = RD->getDefinition(); 7516 if (RD && !RD->getDeclName().getAsIdentifierInfo()) { 7517 // decltype(((Foo_IMPL*)0)->bar) * 7518 ObjCContainerDecl *CDecl = 7519 dyn_cast<ObjCContainerDecl>(D->getDeclContext()); 7520 // ivar in class extensions requires special treatment. 7521 if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(CDecl)) 7522 CDecl = CatDecl->getClassInterface(); 7523 std::string RecName = CDecl->getName(); 7524 RecName += "_IMPL"; 7525 RecordDecl *RD = RecordDecl::Create( 7526 *Context, TTK_Struct, TUDecl, SourceLocation(), SourceLocation(), 7527 &Context->Idents.get(RecName)); 7528 QualType PtrStructIMPL = Context->getPointerType(Context->getTagDeclType(RD)); 7529 unsigned UnsignedIntSize = 7530 static_cast<unsigned>(Context->getTypeSize(Context->UnsignedIntTy)); 7531 Expr *Zero = IntegerLiteral::Create(*Context, 7532 llvm::APInt(UnsignedIntSize, 0), 7533 Context->UnsignedIntTy, SourceLocation()); 7534 Zero = NoTypeInfoCStyleCastExpr(Context, PtrStructIMPL, CK_BitCast, Zero); 7535 ParenExpr *PE = new (Context) ParenExpr(SourceLocation(), SourceLocation(), 7536 Zero); 7537 FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 7538 SourceLocation(), 7539 &Context->Idents.get(D->getNameAsString()), 7540 IvarT, nullptr, 7541 /*BitWidth=*/nullptr, 7542 /*Mutable=*/true, ICIS_NoInit); 7543 MemberExpr *ME = new (Context) 7544 MemberExpr(PE, true, SourceLocation(), FD, SourceLocation(), 7545 FD->getType(), VK_LValue, OK_Ordinary); 7546 IvarT = Context->getDecltypeType(ME, ME->getType()); 7547 } 7548 } 7549 convertObjCTypeToCStyleType(IvarT); 7550 QualType castT = Context->getPointerType(IvarT); 7551 7552 castExpr = NoTypeInfoCStyleCastExpr(Context, 7553 castT, 7554 CK_BitCast, 7555 PE); 7556 7557 7558 Expr *Exp = new (Context) UnaryOperator(castExpr, UO_Deref, IvarT, 7559 VK_LValue, OK_Ordinary, 7560 SourceLocation()); 7561 PE = new (Context) ParenExpr(OldRange.getBegin(), 7562 OldRange.getEnd(), 7563 Exp); 7564 7565 if (D->isBitField()) { 7566 FieldDecl *FD = FieldDecl::Create(*Context, nullptr, SourceLocation(), 7567 SourceLocation(), 7568 &Context->Idents.get(D->getNameAsString()), 7569 D->getType(), nullptr, 7570 /*BitWidth=*/D->getBitWidth(), 7571 /*Mutable=*/true, ICIS_NoInit); 7572 MemberExpr *ME = new (Context) 7573 MemberExpr(PE, /*isArrow*/ false, SourceLocation(), FD, 7574 SourceLocation(), FD->getType(), VK_LValue, OK_Ordinary); 7575 Replacement = ME; 7576 7577 } 7578 else 7579 Replacement = PE; 7580 } 7581 7582 ReplaceStmtWithRange(IV, Replacement, OldRange); 7583 return Replacement; 7584 } 7585 7586 #endif // CLANG_ENABLE_OBJC_REWRITER 7587