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