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