1 //===--- ObjCMT.cpp - ObjC Migrate Tool -----------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "Transforms.h"
11 #include "clang/ARCMigrate/ARCMT.h"
12 #include "clang/ARCMigrate/ARCMTActions.h"
13 #include "clang/AST/ASTConsumer.h"
14 #include "clang/AST/ASTContext.h"
15 #include "clang/AST/Attr.h"
16 #include "clang/AST/NSAPI.h"
17 #include "clang/AST/ParentMap.h"
18 #include "clang/AST/RecursiveASTVisitor.h"
19 #include "clang/Analysis/DomainSpecific/CocoaConventions.h"
20 #include "clang/Basic/FileManager.h"
21 #include "clang/Edit/Commit.h"
22 #include "clang/Edit/EditedSource.h"
23 #include "clang/Edit/EditsReceiver.h"
24 #include "clang/Edit/Rewriters.h"
25 #include "clang/Frontend/CompilerInstance.h"
26 #include "clang/Frontend/MultiplexConsumer.h"
27 #include "clang/Lex/PPConditionalDirectiveRecord.h"
28 #include "clang/Lex/Preprocessor.h"
29 #include "clang/Rewrite/Core/Rewriter.h"
30 #include "clang/StaticAnalyzer/Core/RetainSummaryManager.h"
31 #include "llvm/ADT/SmallString.h"
32 #include "llvm/ADT/StringSet.h"
33 #include "llvm/Support/Path.h"
34 #include "llvm/Support/SourceMgr.h"
35 #include "llvm/Support/YAMLParser.h"
37 using namespace clang;
38 using namespace arcmt;
43 class ObjCMigrateASTConsumer : public ASTConsumer {
44 enum CF_BRIDGING_KIND {
47 CF_BRIDGING_MAY_INCLUDE
50 void migrateDecl(Decl *D);
51 void migrateObjCContainerDecl(ASTContext &Ctx, ObjCContainerDecl *D);
52 void migrateProtocolConformance(ASTContext &Ctx,
53 const ObjCImplementationDecl *ImpDecl);
54 void CacheObjCNSIntegerTypedefed(const TypedefDecl *TypedefDcl);
55 bool migrateNSEnumDecl(ASTContext &Ctx, const EnumDecl *EnumDcl,
56 const TypedefDecl *TypedefDcl);
57 void migrateAllMethodInstaceType(ASTContext &Ctx, ObjCContainerDecl *CDecl);
58 void migrateMethodInstanceType(ASTContext &Ctx, ObjCContainerDecl *CDecl,
60 bool migrateProperty(ASTContext &Ctx, ObjCContainerDecl *D, ObjCMethodDecl *OM);
61 void migrateNsReturnsInnerPointer(ASTContext &Ctx, ObjCMethodDecl *OM);
62 void migratePropertyNsReturnsInnerPointer(ASTContext &Ctx, ObjCPropertyDecl *P);
63 void migrateFactoryMethod(ASTContext &Ctx, ObjCContainerDecl *CDecl,
65 ObjCInstanceTypeFamily OIT_Family = OIT_None);
67 void migrateCFAnnotation(ASTContext &Ctx, const Decl *Decl);
68 void AddCFAnnotations(ASTContext &Ctx, const CallEffects &CE,
69 const FunctionDecl *FuncDecl, bool ResultAnnotated);
70 void AddCFAnnotations(ASTContext &Ctx, const CallEffects &CE,
71 const ObjCMethodDecl *MethodDecl, bool ResultAnnotated);
73 void AnnotateImplicitBridging(ASTContext &Ctx);
75 CF_BRIDGING_KIND migrateAddFunctionAnnotation(ASTContext &Ctx,
76 const FunctionDecl *FuncDecl);
78 void migrateARCSafeAnnotation(ASTContext &Ctx, ObjCContainerDecl *CDecl);
80 void migrateAddMethodAnnotation(ASTContext &Ctx,
81 const ObjCMethodDecl *MethodDecl);
83 void inferDesignatedInitializers(ASTContext &Ctx,
84 const ObjCImplementationDecl *ImplD);
86 bool InsertFoundation(ASTContext &Ctx, SourceLocation Loc);
89 std::string MigrateDir;
90 unsigned ASTMigrateActions;
92 const TypedefDecl *NSIntegerTypedefed;
93 const TypedefDecl *NSUIntegerTypedefed;
94 std::unique_ptr<NSAPI> NSAPIObj;
95 std::unique_ptr<edit::EditedSource> Editor;
96 FileRemapper &Remapper;
98 const PPConditionalDirectiveRecord *PPRec;
101 bool FoundationIncluded;
102 llvm::SmallPtrSet<ObjCProtocolDecl *, 32> ObjCProtocolDecls;
103 llvm::SmallVector<const Decl *, 8> CFFunctionIBCandidates;
104 llvm::StringSet<> WhiteListFilenames;
106 ObjCMigrateASTConsumer(StringRef migrateDir,
107 unsigned astMigrateActions,
108 FileRemapper &remapper,
109 FileManager &fileMgr,
110 const PPConditionalDirectiveRecord *PPRec,
113 ArrayRef<std::string> WhiteList)
114 : MigrateDir(migrateDir),
115 ASTMigrateActions(astMigrateActions),
116 NSIntegerTypedefed(nullptr), NSUIntegerTypedefed(nullptr),
117 Remapper(remapper), FileMgr(fileMgr), PPRec(PPRec), PP(PP),
118 IsOutputFile(isOutputFile),
119 FoundationIncluded(false){
121 // FIXME: StringSet should have insert(iter, iter) to use here.
122 for (const std::string &Val : WhiteList)
123 WhiteListFilenames.insert(Val);
127 void Initialize(ASTContext &Context) override {
128 NSAPIObj.reset(new NSAPI(Context));
129 Editor.reset(new edit::EditedSource(Context.getSourceManager(),
130 Context.getLangOpts(),
134 bool HandleTopLevelDecl(DeclGroupRef DG) override {
135 for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I)
139 void HandleInterestingDecl(DeclGroupRef DG) override {
140 // Ignore decls from the PCH.
142 void HandleTopLevelDeclInObjCContainer(DeclGroupRef DG) override {
143 ObjCMigrateASTConsumer::HandleTopLevelDecl(DG);
146 void HandleTranslationUnit(ASTContext &Ctx) override;
148 bool canModifyFile(StringRef Path) {
149 if (WhiteListFilenames.empty())
151 return WhiteListFilenames.find(llvm::sys::path::filename(Path))
152 != WhiteListFilenames.end();
154 bool canModifyFile(const FileEntry *FE) {
157 return canModifyFile(FE->getName());
159 bool canModifyFile(FileID FID) {
162 return canModifyFile(PP.getSourceManager().getFileEntryForID(FID));
165 bool canModify(const Decl *D) {
168 if (const ObjCCategoryImplDecl *CatImpl = dyn_cast<ObjCCategoryImplDecl>(D))
169 return canModify(CatImpl->getCategoryDecl());
170 if (const ObjCImplementationDecl *Impl = dyn_cast<ObjCImplementationDecl>(D))
171 return canModify(Impl->getClassInterface());
172 if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
173 return canModify(cast<Decl>(MD->getDeclContext()));
175 FileID FID = PP.getSourceManager().getFileID(D->getLocation());
176 return canModifyFile(FID);
180 } // end anonymous namespace
182 ObjCMigrateAction::ObjCMigrateAction(
183 std::unique_ptr<FrontendAction> WrappedAction,
184 StringRef migrateDir,
185 unsigned migrateAction)
186 : WrapperFrontendAction(std::move(WrappedAction)), MigrateDir(migrateDir),
187 ObjCMigAction(migrateAction),
189 if (MigrateDir.empty())
190 MigrateDir = "."; // user current directory if none is given.
193 std::unique_ptr<ASTConsumer>
194 ObjCMigrateAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
195 PPConditionalDirectiveRecord *
196 PPRec = new PPConditionalDirectiveRecord(CompInst->getSourceManager());
197 CI.getPreprocessor().addPPCallbacks(std::unique_ptr<PPCallbacks>(PPRec));
198 std::vector<std::unique_ptr<ASTConsumer>> Consumers;
199 Consumers.push_back(WrapperFrontendAction::CreateASTConsumer(CI, InFile));
200 Consumers.push_back(llvm::make_unique<ObjCMigrateASTConsumer>(
201 MigrateDir, ObjCMigAction, Remapper, CompInst->getFileManager(), PPRec,
202 CompInst->getPreprocessor(), false, None));
203 return llvm::make_unique<MultiplexConsumer>(std::move(Consumers));
206 bool ObjCMigrateAction::BeginInvocation(CompilerInstance &CI) {
207 Remapper.initFromDisk(MigrateDir, CI.getDiagnostics(),
208 /*ignoreIfFilesChanges=*/true);
210 CI.getDiagnostics().setIgnoreAllWarnings(true);
215 // FIXME. This duplicates one in RewriteObjCFoundationAPI.cpp
216 bool subscriptOperatorNeedsParens(const Expr *FullExpr) {
217 const Expr* Expr = FullExpr->IgnoreImpCasts();
218 return !(isa<ArraySubscriptExpr>(Expr) || isa<CallExpr>(Expr) ||
219 isa<DeclRefExpr>(Expr) || isa<CXXNamedCastExpr>(Expr) ||
220 isa<CXXConstructExpr>(Expr) || isa<CXXThisExpr>(Expr) ||
221 isa<CXXTypeidExpr>(Expr) ||
222 isa<CXXUnresolvedConstructExpr>(Expr) ||
223 isa<ObjCMessageExpr>(Expr) || isa<ObjCPropertyRefExpr>(Expr) ||
224 isa<ObjCProtocolExpr>(Expr) || isa<MemberExpr>(Expr) ||
225 isa<ObjCIvarRefExpr>(Expr) || isa<ParenExpr>(FullExpr) ||
226 isa<ParenListExpr>(Expr) || isa<SizeOfPackExpr>(Expr));
229 /// - Rewrite message expression for Objective-C setter and getters into
230 /// property-dot syntax.
231 bool rewriteToPropertyDotSyntax(const ObjCMessageExpr *Msg,
233 const NSAPI &NS, edit::Commit &commit,
234 const ParentMap *PMap) {
235 if (!Msg || Msg->isImplicit() ||
236 (Msg->getReceiverKind() != ObjCMessageExpr::Instance &&
237 Msg->getReceiverKind() != ObjCMessageExpr::SuperInstance))
239 if (const Expr *Receiver = Msg->getInstanceReceiver())
240 if (Receiver->getType()->isObjCBuiltinType())
243 const ObjCMethodDecl *Method = Msg->getMethodDecl();
246 if (!Method->isPropertyAccessor())
249 const ObjCPropertyDecl *Prop = Method->findPropertyDecl();
253 SourceRange MsgRange = Msg->getSourceRange();
254 bool ReceiverIsSuper =
255 (Msg->getReceiverKind() == ObjCMessageExpr::SuperInstance);
256 // for 'super' receiver is nullptr.
257 const Expr *receiver = Msg->getInstanceReceiver();
259 ReceiverIsSuper ? false : subscriptOperatorNeedsParens(receiver);
260 bool IsGetter = (Msg->getNumArgs() == 0);
262 // Find space location range between receiver expression and getter method.
263 SourceLocation BegLoc =
264 ReceiverIsSuper ? Msg->getSuperLoc() : receiver->getEndLoc();
265 BegLoc = PP.getLocForEndOfToken(BegLoc);
266 SourceLocation EndLoc = Msg->getSelectorLoc(0);
267 SourceRange SpaceRange(BegLoc, EndLoc);
268 std::string PropertyDotString;
269 // rewrite getter method expression into: receiver.property or
270 // (receiver).property
272 commit.insertBefore(receiver->getBeginLoc(), "(");
273 PropertyDotString = ").";
276 PropertyDotString = ".";
277 PropertyDotString += Prop->getName();
278 commit.replace(SpaceRange, PropertyDotString);
281 commit.replace(SourceRange(MsgRange.getBegin(), MsgRange.getBegin()), "");
282 commit.replace(SourceRange(MsgRange.getEnd(), MsgRange.getEnd()), "");
285 commit.insertWrap("(", receiver->getSourceRange(), ")");
286 std::string PropertyDotString = ".";
287 PropertyDotString += Prop->getName();
288 PropertyDotString += " =";
289 const Expr*const* Args = Msg->getArgs();
290 const Expr *RHS = Args[0];
293 SourceLocation BegLoc =
294 ReceiverIsSuper ? Msg->getSuperLoc() : receiver->getEndLoc();
295 BegLoc = PP.getLocForEndOfToken(BegLoc);
296 SourceLocation EndLoc = RHS->getBeginLoc();
297 EndLoc = EndLoc.getLocWithOffset(-1);
298 const char *colon = PP.getSourceManager().getCharacterData(EndLoc);
299 // Add a space after '=' if there is no space between RHS and '='
300 if (colon && colon[0] == ':')
301 PropertyDotString += " ";
302 SourceRange Range(BegLoc, EndLoc);
303 commit.replace(Range, PropertyDotString);
305 commit.replace(SourceRange(MsgRange.getBegin(), MsgRange.getBegin()), "");
306 commit.replace(SourceRange(MsgRange.getEnd(), MsgRange.getEnd()), "");
311 class ObjCMigrator : public RecursiveASTVisitor<ObjCMigrator> {
312 ObjCMigrateASTConsumer &Consumer;
316 ObjCMigrator(ObjCMigrateASTConsumer &consumer, ParentMap &PMap)
317 : Consumer(consumer), PMap(PMap) { }
319 bool shouldVisitTemplateInstantiations() const { return false; }
320 bool shouldWalkTypesOfTypeLocs() const { return false; }
322 bool VisitObjCMessageExpr(ObjCMessageExpr *E) {
323 if (Consumer.ASTMigrateActions & FrontendOptions::ObjCMT_Literals) {
324 edit::Commit commit(*Consumer.Editor);
325 edit::rewriteToObjCLiteralSyntax(E, *Consumer.NSAPIObj, commit, &PMap);
326 Consumer.Editor->commit(commit);
329 if (Consumer.ASTMigrateActions & FrontendOptions::ObjCMT_Subscripting) {
330 edit::Commit commit(*Consumer.Editor);
331 edit::rewriteToObjCSubscriptSyntax(E, *Consumer.NSAPIObj, commit);
332 Consumer.Editor->commit(commit);
335 if (Consumer.ASTMigrateActions & FrontendOptions::ObjCMT_PropertyDotSyntax) {
336 edit::Commit commit(*Consumer.Editor);
337 rewriteToPropertyDotSyntax(E, Consumer.PP, *Consumer.NSAPIObj,
339 Consumer.Editor->commit(commit);
345 bool TraverseObjCMessageExpr(ObjCMessageExpr *E) {
346 // Do depth first; we want to rewrite the subexpressions first so that if
347 // we have to move expressions we will move them already rewritten.
348 for (Stmt *SubStmt : E->children())
349 if (!TraverseStmt(SubStmt))
352 return WalkUpFromObjCMessageExpr(E);
356 class BodyMigrator : public RecursiveASTVisitor<BodyMigrator> {
357 ObjCMigrateASTConsumer &Consumer;
358 std::unique_ptr<ParentMap> PMap;
361 BodyMigrator(ObjCMigrateASTConsumer &consumer) : Consumer(consumer) { }
363 bool shouldVisitTemplateInstantiations() const { return false; }
364 bool shouldWalkTypesOfTypeLocs() const { return false; }
366 bool TraverseStmt(Stmt *S) {
367 PMap.reset(new ParentMap(S));
368 ObjCMigrator(Consumer, *PMap).TraverseStmt(S);
372 } // end anonymous namespace
374 void ObjCMigrateASTConsumer::migrateDecl(Decl *D) {
377 if (isa<ObjCMethodDecl>(D))
378 return; // Wait for the ObjC container declaration.
380 BodyMigrator(*this).TraverseDecl(D);
383 static void append_attr(std::string &PropertyString, const char *attr,
386 PropertyString += "(";
390 PropertyString += ", ";
391 PropertyString += attr;
395 void MigrateBlockOrFunctionPointerTypeVariable(std::string & PropertyString,
396 const std::string& TypeString,
398 const char *argPtr = TypeString.c_str();
403 PropertyString += *argPtr;
407 PropertyString += *argPtr;
412 PropertyString += (*argPtr);
414 PropertyString += name;
419 PropertyString += *argPtr;
426 static const char *PropertyMemoryAttribute(ASTContext &Context, QualType ArgType) {
427 Qualifiers::ObjCLifetime propertyLifetime = ArgType.getObjCLifetime();
428 bool RetainableObject = ArgType->isObjCRetainableType();
429 if (RetainableObject &&
430 (propertyLifetime == Qualifiers::OCL_Strong
431 || propertyLifetime == Qualifiers::OCL_None)) {
432 if (const ObjCObjectPointerType *ObjPtrTy =
433 ArgType->getAs<ObjCObjectPointerType>()) {
434 ObjCInterfaceDecl *IDecl = ObjPtrTy->getObjectType()->getInterface();
436 IDecl->lookupNestedProtocol(&Context.Idents.get("NSCopying")))
441 else if (ArgType->isBlockPointerType())
443 } else if (propertyLifetime == Qualifiers::OCL_Weak)
444 // TODO. More precise determination of 'weak' attribute requires
445 // looking into setter's implementation for backing weak ivar.
447 else if (RetainableObject)
448 return ArgType->isBlockPointerType() ? "copy" : "strong";
452 static void rewriteToObjCProperty(const ObjCMethodDecl *Getter,
453 const ObjCMethodDecl *Setter,
454 const NSAPI &NS, edit::Commit &commit,
455 unsigned LengthOfPrefix,
456 bool Atomic, bool UseNsIosOnlyMacro,
457 bool AvailabilityArgsMatch) {
458 ASTContext &Context = NS.getASTContext();
459 bool LParenAdded = false;
460 std::string PropertyString = "@property ";
461 if (UseNsIosOnlyMacro && NS.isMacroDefined("NS_NONATOMIC_IOSONLY")) {
462 PropertyString += "(NS_NONATOMIC_IOSONLY";
464 } else if (!Atomic) {
465 PropertyString += "(nonatomic";
469 std::string PropertyNameString = Getter->getNameAsString();
470 StringRef PropertyName(PropertyNameString);
471 if (LengthOfPrefix > 0) {
473 PropertyString += "(getter=";
477 PropertyString += ", getter=";
478 PropertyString += PropertyNameString;
480 // Property with no setter may be suggested as a 'readonly' property.
482 append_attr(PropertyString, "readonly", LParenAdded);
485 // Short circuit 'delegate' properties that contain the name "delegate" or
486 // "dataSource", or have exact name "target" to have 'assign' attribute.
487 if (PropertyName.equals("target") ||
488 (PropertyName.find("delegate") != StringRef::npos) ||
489 (PropertyName.find("dataSource") != StringRef::npos)) {
490 QualType QT = Getter->getReturnType();
491 if (!QT->isRealType())
492 append_attr(PropertyString, "assign", LParenAdded);
493 } else if (!Setter) {
494 QualType ResType = Context.getCanonicalType(Getter->getReturnType());
495 if (const char *MemoryManagementAttr = PropertyMemoryAttribute(Context, ResType))
496 append_attr(PropertyString, MemoryManagementAttr, LParenAdded);
498 const ParmVarDecl *argDecl = *Setter->param_begin();
499 QualType ArgType = Context.getCanonicalType(argDecl->getType());
500 if (const char *MemoryManagementAttr = PropertyMemoryAttribute(Context, ArgType))
501 append_attr(PropertyString, MemoryManagementAttr, LParenAdded);
504 PropertyString += ')';
505 QualType RT = Getter->getReturnType();
506 if (!isa<TypedefType>(RT)) {
507 // strip off any ARC lifetime qualifier.
508 QualType CanResultTy = Context.getCanonicalType(RT);
509 if (CanResultTy.getQualifiers().hasObjCLifetime()) {
510 Qualifiers Qs = CanResultTy.getQualifiers();
511 Qs.removeObjCLifetime();
512 RT = Context.getQualifiedType(CanResultTy.getUnqualifiedType(), Qs);
515 PropertyString += " ";
516 PrintingPolicy SubPolicy(Context.getPrintingPolicy());
517 SubPolicy.SuppressStrongLifetime = true;
518 SubPolicy.SuppressLifetimeQualifiers = true;
519 std::string TypeString = RT.getAsString(SubPolicy);
520 if (LengthOfPrefix > 0) {
521 // property name must strip off "is" and lower case the first character
522 // after that; e.g. isContinuous will become continuous.
523 StringRef PropertyNameStringRef(PropertyNameString);
524 PropertyNameStringRef = PropertyNameStringRef.drop_front(LengthOfPrefix);
525 PropertyNameString = PropertyNameStringRef;
526 bool NoLowering = (isUppercase(PropertyNameString[0]) &&
527 PropertyNameString.size() > 1 &&
528 isUppercase(PropertyNameString[1]));
530 PropertyNameString[0] = toLowercase(PropertyNameString[0]);
532 if (RT->isBlockPointerType() || RT->isFunctionPointerType())
533 MigrateBlockOrFunctionPointerTypeVariable(PropertyString,
535 PropertyNameString.c_str());
537 char LastChar = TypeString[TypeString.size()-1];
538 PropertyString += TypeString;
540 PropertyString += ' ';
541 PropertyString += PropertyNameString;
543 SourceLocation StartGetterSelectorLoc = Getter->getSelectorStartLoc();
544 Selector GetterSelector = Getter->getSelector();
546 SourceLocation EndGetterSelectorLoc =
547 StartGetterSelectorLoc.getLocWithOffset(GetterSelector.getNameForSlot(0).size());
548 commit.replace(CharSourceRange::getCharRange(Getter->getBeginLoc(),
549 EndGetterSelectorLoc),
551 if (Setter && AvailabilityArgsMatch) {
552 SourceLocation EndLoc = Setter->getDeclaratorEndLoc();
553 // Get location past ';'
554 EndLoc = EndLoc.getLocWithOffset(1);
555 SourceLocation BeginOfSetterDclLoc = Setter->getBeginLoc();
556 // FIXME. This assumes that setter decl; is immediately preceded by eoln.
557 // It is trying to remove the setter method decl. line entirely.
558 BeginOfSetterDclLoc = BeginOfSetterDclLoc.getLocWithOffset(-1);
559 commit.remove(SourceRange(BeginOfSetterDclLoc, EndLoc));
563 static bool IsCategoryNameWithDeprecatedSuffix(ObjCContainerDecl *D) {
564 if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(D)) {
565 StringRef Name = CatDecl->getName();
566 return Name.endswith("Deprecated");
571 void ObjCMigrateASTConsumer::migrateObjCContainerDecl(ASTContext &Ctx,
572 ObjCContainerDecl *D) {
573 if (D->isDeprecated() || IsCategoryNameWithDeprecatedSuffix(D))
576 for (auto *Method : D->methods()) {
577 if (Method->isDeprecated())
579 bool PropertyInferred = migrateProperty(Ctx, D, Method);
580 // If a property is inferred, do not attempt to attach NS_RETURNS_INNER_POINTER to
581 // the getter method as it ends up on the property itself which we don't want
582 // to do unless -objcmt-returns-innerpointer-property option is on.
583 if (!PropertyInferred ||
584 (ASTMigrateActions & FrontendOptions::ObjCMT_ReturnsInnerPointerProperty))
585 if (ASTMigrateActions & FrontendOptions::ObjCMT_Annotation)
586 migrateNsReturnsInnerPointer(Ctx, Method);
588 if (!(ASTMigrateActions & FrontendOptions::ObjCMT_ReturnsInnerPointerProperty))
591 for (auto *Prop : D->instance_properties()) {
592 if ((ASTMigrateActions & FrontendOptions::ObjCMT_Annotation) &&
593 !Prop->isDeprecated())
594 migratePropertyNsReturnsInnerPointer(Ctx, Prop);
599 ClassImplementsAllMethodsAndProperties(ASTContext &Ctx,
600 const ObjCImplementationDecl *ImpDecl,
601 const ObjCInterfaceDecl *IDecl,
602 ObjCProtocolDecl *Protocol) {
603 // In auto-synthesis, protocol properties are not synthesized. So,
604 // a conforming protocol must have its required properties declared
605 // in class interface.
606 bool HasAtleastOneRequiredProperty = false;
607 if (const ObjCProtocolDecl *PDecl = Protocol->getDefinition())
608 for (const auto *Property : PDecl->instance_properties()) {
609 if (Property->getPropertyImplementation() == ObjCPropertyDecl::Optional)
611 HasAtleastOneRequiredProperty = true;
612 DeclContext::lookup_result R = IDecl->lookup(Property->getDeclName());
614 // Relax the rule and look into class's implementation for a synthesize
615 // or dynamic declaration. Class is implementing a property coming from
616 // another protocol. This still makes the target protocol as conforming.
617 if (!ImpDecl->FindPropertyImplDecl(
618 Property->getDeclName().getAsIdentifierInfo(),
619 Property->getQueryKind()))
622 else if (ObjCPropertyDecl *ClassProperty = dyn_cast<ObjCPropertyDecl>(R[0])) {
623 if ((ClassProperty->getPropertyAttributes()
624 != Property->getPropertyAttributes()) ||
625 !Ctx.hasSameType(ClassProperty->getType(), Property->getType()))
632 // At this point, all required properties in this protocol conform to those
633 // declared in the class.
634 // Check that class implements the required methods of the protocol too.
635 bool HasAtleastOneRequiredMethod = false;
636 if (const ObjCProtocolDecl *PDecl = Protocol->getDefinition()) {
637 if (PDecl->meth_begin() == PDecl->meth_end())
638 return HasAtleastOneRequiredProperty;
639 for (const auto *MD : PDecl->methods()) {
640 if (MD->isImplicit())
642 if (MD->getImplementationControl() == ObjCMethodDecl::Optional)
644 DeclContext::lookup_result R = ImpDecl->lookup(MD->getDeclName());
648 HasAtleastOneRequiredMethod = true;
649 for (unsigned I = 0, N = R.size(); I != N; ++I)
650 if (ObjCMethodDecl *ImpMD = dyn_cast<ObjCMethodDecl>(R[0]))
651 if (Ctx.ObjCMethodsAreEqual(MD, ImpMD)) {
659 return HasAtleastOneRequiredProperty || HasAtleastOneRequiredMethod;
662 static bool rewriteToObjCInterfaceDecl(const ObjCInterfaceDecl *IDecl,
663 llvm::SmallVectorImpl<ObjCProtocolDecl*> &ConformingProtocols,
664 const NSAPI &NS, edit::Commit &commit) {
665 const ObjCList<ObjCProtocolDecl> &Protocols = IDecl->getReferencedProtocols();
666 std::string ClassString;
667 SourceLocation EndLoc =
668 IDecl->getSuperClass() ? IDecl->getSuperClassLoc() : IDecl->getLocation();
670 if (Protocols.empty()) {
672 for (unsigned i = 0, e = ConformingProtocols.size(); i != e; i++) {
673 ClassString += ConformingProtocols[i]->getNameAsString();
681 for (unsigned i = 0, e = ConformingProtocols.size(); i != e; i++) {
682 ClassString += ConformingProtocols[i]->getNameAsString();
686 ObjCInterfaceDecl::protocol_loc_iterator PL = IDecl->protocol_loc_end() - 1;
690 commit.insertAfterToken(EndLoc, ClassString);
694 static StringRef GetUnsignedName(StringRef NSIntegerName) {
695 StringRef UnsignedName = llvm::StringSwitch<StringRef>(NSIntegerName)
696 .Case("int8_t", "uint8_t")
697 .Case("int16_t", "uint16_t")
698 .Case("int32_t", "uint32_t")
699 .Case("NSInteger", "NSUInteger")
700 .Case("int64_t", "uint64_t")
701 .Default(NSIntegerName);
705 static bool rewriteToNSEnumDecl(const EnumDecl *EnumDcl,
706 const TypedefDecl *TypedefDcl,
707 const NSAPI &NS, edit::Commit &commit,
708 StringRef NSIntegerName,
710 std::string ClassString;
712 ClassString = "typedef NS_OPTIONS(";
713 ClassString += GetUnsignedName(NSIntegerName);
716 ClassString = "typedef NS_ENUM(";
717 ClassString += NSIntegerName;
721 ClassString += TypedefDcl->getIdentifier()->getName();
723 SourceRange R(EnumDcl->getBeginLoc(), EnumDcl->getBeginLoc());
724 commit.replace(R, ClassString);
725 SourceLocation EndOfEnumDclLoc = EnumDcl->getEndLoc();
726 EndOfEnumDclLoc = trans::findSemiAfterLocation(EndOfEnumDclLoc,
727 NS.getASTContext(), /*IsDecl*/true);
728 if (EndOfEnumDclLoc.isValid()) {
729 SourceRange EnumDclRange(EnumDcl->getBeginLoc(), EndOfEnumDclLoc);
730 commit.insertFromRange(TypedefDcl->getBeginLoc(), EnumDclRange);
735 SourceLocation EndTypedefDclLoc = TypedefDcl->getEndLoc();
736 EndTypedefDclLoc = trans::findSemiAfterLocation(EndTypedefDclLoc,
737 NS.getASTContext(), /*IsDecl*/true);
738 if (EndTypedefDclLoc.isValid()) {
739 SourceRange TDRange(TypedefDcl->getBeginLoc(), EndTypedefDclLoc);
740 commit.remove(TDRange);
746 trans::findLocationAfterSemi(EnumDcl->getEndLoc(), NS.getASTContext(),
748 if (EndOfEnumDclLoc.isValid()) {
749 SourceLocation BeginOfEnumDclLoc = EnumDcl->getBeginLoc();
750 // FIXME. This assumes that enum decl; is immediately preceded by eoln.
751 // It is trying to remove the enum decl. lines entirely.
752 BeginOfEnumDclLoc = BeginOfEnumDclLoc.getLocWithOffset(-1);
753 commit.remove(SourceRange(BeginOfEnumDclLoc, EndOfEnumDclLoc));
759 static void rewriteToNSMacroDecl(ASTContext &Ctx,
760 const EnumDecl *EnumDcl,
761 const TypedefDecl *TypedefDcl,
762 const NSAPI &NS, edit::Commit &commit,
763 bool IsNSIntegerType) {
764 QualType DesignatedEnumType = EnumDcl->getIntegerType();
765 assert(!DesignatedEnumType.isNull()
766 && "rewriteToNSMacroDecl - underlying enum type is null");
768 PrintingPolicy Policy(Ctx.getPrintingPolicy());
769 std::string TypeString = DesignatedEnumType.getAsString(Policy);
770 std::string ClassString = IsNSIntegerType ? "NS_ENUM(" : "NS_OPTIONS(";
771 ClassString += TypeString;
774 ClassString += TypedefDcl->getIdentifier()->getName();
776 SourceLocation EndLoc = EnumDcl->getBraceRange().getBegin();
777 if (EndLoc.isInvalid())
780 CharSourceRange::getCharRange(EnumDcl->getBeginLoc(), EndLoc);
781 commit.replace(R, ClassString);
782 // This is to remove spaces between '}' and typedef name.
783 SourceLocation StartTypedefLoc = EnumDcl->getEndLoc();
784 StartTypedefLoc = StartTypedefLoc.getLocWithOffset(+1);
785 SourceLocation EndTypedefLoc = TypedefDcl->getEndLoc();
787 commit.remove(SourceRange(StartTypedefLoc, EndTypedefLoc));
790 static bool UseNSOptionsMacro(Preprocessor &PP, ASTContext &Ctx,
791 const EnumDecl *EnumDcl) {
792 bool PowerOfTwo = true;
793 bool AllHexdecimalEnumerator = true;
794 uint64_t MaxPowerOfTwoVal = 0;
795 for (auto Enumerator : EnumDcl->enumerators()) {
796 const Expr *InitExpr = Enumerator->getInitExpr();
799 AllHexdecimalEnumerator = false;
802 InitExpr = InitExpr->IgnoreParenCasts();
803 if (const BinaryOperator *BO = dyn_cast<BinaryOperator>(InitExpr))
804 if (BO->isShiftOp() || BO->isBitwiseOp())
807 uint64_t EnumVal = Enumerator->getInitVal().getZExtValue();
808 if (PowerOfTwo && EnumVal) {
809 if (!llvm::isPowerOf2_64(EnumVal))
811 else if (EnumVal > MaxPowerOfTwoVal)
812 MaxPowerOfTwoVal = EnumVal;
814 if (AllHexdecimalEnumerator && EnumVal) {
815 bool FoundHexdecimalEnumerator = false;
816 SourceLocation EndLoc = Enumerator->getEndLoc();
818 if (!PP.getRawToken(EndLoc, Tok, /*IgnoreWhiteSpace=*/true))
819 if (Tok.isLiteral() && Tok.getLength() > 2) {
820 if (const char *StringLit = Tok.getLiteralData())
821 FoundHexdecimalEnumerator =
822 (StringLit[0] == '0' && (toLowercase(StringLit[1]) == 'x'));
824 if (!FoundHexdecimalEnumerator)
825 AllHexdecimalEnumerator = false;
828 return AllHexdecimalEnumerator || (PowerOfTwo && (MaxPowerOfTwoVal > 2));
831 void ObjCMigrateASTConsumer::migrateProtocolConformance(ASTContext &Ctx,
832 const ObjCImplementationDecl *ImpDecl) {
833 const ObjCInterfaceDecl *IDecl = ImpDecl->getClassInterface();
834 if (!IDecl || ObjCProtocolDecls.empty() || IDecl->isDeprecated())
836 // Find all implicit conforming protocols for this class
837 // and make them explicit.
838 llvm::SmallPtrSet<ObjCProtocolDecl *, 8> ExplicitProtocols;
839 Ctx.CollectInheritedProtocols(IDecl, ExplicitProtocols);
840 llvm::SmallVector<ObjCProtocolDecl *, 8> PotentialImplicitProtocols;
842 for (ObjCProtocolDecl *ProtDecl : ObjCProtocolDecls)
843 if (!ExplicitProtocols.count(ProtDecl))
844 PotentialImplicitProtocols.push_back(ProtDecl);
846 if (PotentialImplicitProtocols.empty())
849 // go through list of non-optional methods and properties in each protocol
850 // in the PotentialImplicitProtocols list. If class implements every one of the
851 // methods and properties, then this class conforms to this protocol.
852 llvm::SmallVector<ObjCProtocolDecl*, 8> ConformingProtocols;
853 for (unsigned i = 0, e = PotentialImplicitProtocols.size(); i != e; i++)
854 if (ClassImplementsAllMethodsAndProperties(Ctx, ImpDecl, IDecl,
855 PotentialImplicitProtocols[i]))
856 ConformingProtocols.push_back(PotentialImplicitProtocols[i]);
858 if (ConformingProtocols.empty())
861 // Further reduce number of conforming protocols. If protocol P1 is in the list
862 // protocol P2 (P2<P1>), No need to include P1.
863 llvm::SmallVector<ObjCProtocolDecl*, 8> MinimalConformingProtocols;
864 for (unsigned i = 0, e = ConformingProtocols.size(); i != e; i++) {
866 ObjCProtocolDecl *TargetPDecl = ConformingProtocols[i];
867 for (unsigned i1 = 0, e1 = ConformingProtocols.size(); i1 != e1; i1++) {
868 ObjCProtocolDecl *PDecl = ConformingProtocols[i1];
869 if (PDecl == TargetPDecl)
871 if (PDecl->lookupProtocolNamed(
872 TargetPDecl->getDeclName().getAsIdentifierInfo())) {
878 MinimalConformingProtocols.push_back(TargetPDecl);
880 if (MinimalConformingProtocols.empty())
882 edit::Commit commit(*Editor);
883 rewriteToObjCInterfaceDecl(IDecl, MinimalConformingProtocols,
885 Editor->commit(commit);
888 void ObjCMigrateASTConsumer::CacheObjCNSIntegerTypedefed(
889 const TypedefDecl *TypedefDcl) {
891 QualType qt = TypedefDcl->getTypeSourceInfo()->getType();
892 if (NSAPIObj->isObjCNSIntegerType(qt))
893 NSIntegerTypedefed = TypedefDcl;
894 else if (NSAPIObj->isObjCNSUIntegerType(qt))
895 NSUIntegerTypedefed = TypedefDcl;
898 bool ObjCMigrateASTConsumer::migrateNSEnumDecl(ASTContext &Ctx,
899 const EnumDecl *EnumDcl,
900 const TypedefDecl *TypedefDcl) {
901 if (!EnumDcl->isCompleteDefinition() || EnumDcl->getIdentifier() ||
902 EnumDcl->isDeprecated())
905 if (NSIntegerTypedefed) {
906 TypedefDcl = NSIntegerTypedefed;
907 NSIntegerTypedefed = nullptr;
909 else if (NSUIntegerTypedefed) {
910 TypedefDcl = NSUIntegerTypedefed;
911 NSUIntegerTypedefed = nullptr;
915 FileID FileIdOfTypedefDcl =
916 PP.getSourceManager().getFileID(TypedefDcl->getLocation());
917 FileID FileIdOfEnumDcl =
918 PP.getSourceManager().getFileID(EnumDcl->getLocation());
919 if (FileIdOfTypedefDcl != FileIdOfEnumDcl)
922 if (TypedefDcl->isDeprecated())
925 QualType qt = TypedefDcl->getTypeSourceInfo()->getType();
926 StringRef NSIntegerName = NSAPIObj->GetNSIntegralKind(qt);
928 if (NSIntegerName.empty()) {
929 // Also check for typedef enum {...} TD;
930 if (const EnumType *EnumTy = qt->getAs<EnumType>()) {
931 if (EnumTy->getDecl() == EnumDcl) {
932 bool NSOptions = UseNSOptionsMacro(PP, Ctx, EnumDcl);
933 if (!InsertFoundation(Ctx, TypedefDcl->getBeginLoc()))
935 edit::Commit commit(*Editor);
936 rewriteToNSMacroDecl(Ctx, EnumDcl, TypedefDcl, *NSAPIObj, commit, !NSOptions);
937 Editor->commit(commit);
944 // We may still use NS_OPTIONS based on what we find in the enumertor list.
945 bool NSOptions = UseNSOptionsMacro(PP, Ctx, EnumDcl);
946 if (!InsertFoundation(Ctx, TypedefDcl->getBeginLoc()))
948 edit::Commit commit(*Editor);
949 bool Res = rewriteToNSEnumDecl(EnumDcl, TypedefDcl, *NSAPIObj,
950 commit, NSIntegerName, NSOptions);
951 Editor->commit(commit);
955 static void ReplaceWithInstancetype(ASTContext &Ctx,
956 const ObjCMigrateASTConsumer &ASTC,
957 ObjCMethodDecl *OM) {
958 if (OM->getReturnType() == Ctx.getObjCInstanceType())
959 return; // already has instancetype.
962 std::string ClassString;
963 if (TypeSourceInfo *TSInfo = OM->getReturnTypeSourceInfo()) {
964 TypeLoc TL = TSInfo->getTypeLoc();
965 R = SourceRange(TL.getBeginLoc(), TL.getEndLoc());
966 ClassString = "instancetype";
969 R = SourceRange(OM->getBeginLoc(), OM->getBeginLoc());
970 ClassString = OM->isInstanceMethod() ? '-' : '+';
971 ClassString += " (instancetype)";
973 edit::Commit commit(*ASTC.Editor);
974 commit.replace(R, ClassString);
975 ASTC.Editor->commit(commit);
978 static void ReplaceWithClasstype(const ObjCMigrateASTConsumer &ASTC,
979 ObjCMethodDecl *OM) {
980 ObjCInterfaceDecl *IDecl = OM->getClassInterface();
982 std::string ClassString;
983 if (TypeSourceInfo *TSInfo = OM->getReturnTypeSourceInfo()) {
984 TypeLoc TL = TSInfo->getTypeLoc();
985 R = SourceRange(TL.getBeginLoc(), TL.getEndLoc()); {
986 ClassString = IDecl->getName();
991 R = SourceRange(OM->getBeginLoc(), OM->getBeginLoc());
993 ClassString += IDecl->getName(); ClassString += "*)";
995 edit::Commit commit(*ASTC.Editor);
996 commit.replace(R, ClassString);
997 ASTC.Editor->commit(commit);
1000 void ObjCMigrateASTConsumer::migrateMethodInstanceType(ASTContext &Ctx,
1001 ObjCContainerDecl *CDecl,
1002 ObjCMethodDecl *OM) {
1003 ObjCInstanceTypeFamily OIT_Family =
1004 Selector::getInstTypeMethodFamily(OM->getSelector());
1006 std::string ClassName;
1007 switch (OIT_Family) {
1009 migrateFactoryMethod(Ctx, CDecl, OM);
1012 ClassName = "NSArray";
1014 case OIT_Dictionary:
1015 ClassName = "NSDictionary";
1018 migrateFactoryMethod(Ctx, CDecl, OM, OIT_Singleton);
1021 if (OM->getReturnType()->isObjCIdType())
1022 ReplaceWithInstancetype(Ctx, *this, OM);
1024 case OIT_ReturnsSelf:
1025 migrateFactoryMethod(Ctx, CDecl, OM, OIT_ReturnsSelf);
1028 if (!OM->getReturnType()->isObjCIdType())
1031 ObjCInterfaceDecl *IDecl = dyn_cast<ObjCInterfaceDecl>(CDecl);
1033 if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(CDecl))
1034 IDecl = CatDecl->getClassInterface();
1035 else if (ObjCImplDecl *ImpDecl = dyn_cast<ObjCImplDecl>(CDecl))
1036 IDecl = ImpDecl->getClassInterface();
1039 !IDecl->lookupInheritedClass(&Ctx.Idents.get(ClassName))) {
1040 migrateFactoryMethod(Ctx, CDecl, OM);
1043 ReplaceWithInstancetype(Ctx, *this, OM);
1046 static bool TypeIsInnerPointer(QualType T) {
1047 if (!T->isAnyPointerType())
1049 if (T->isObjCObjectPointerType() || T->isObjCBuiltinType() ||
1050 T->isBlockPointerType() || T->isFunctionPointerType() ||
1051 ento::coreFoundation::isCFObjectRef(T))
1053 // Also, typedef-of-pointer-to-incomplete-struct is something that we assume
1054 // is not an innter pointer type.
1056 while (const TypedefType *TD = dyn_cast<TypedefType>(T.getTypePtr()))
1057 T = TD->getDecl()->getUnderlyingType();
1058 if (OrigT == T || !T->isPointerType())
1060 const PointerType* PT = T->getAs<PointerType>();
1061 QualType UPointeeT = PT->getPointeeType().getUnqualifiedType();
1062 if (UPointeeT->isRecordType()) {
1063 const RecordType *RecordTy = UPointeeT->getAs<RecordType>();
1064 if (!RecordTy->getDecl()->isCompleteDefinition())
1070 /// Check whether the two versions match.
1071 static bool versionsMatch(const VersionTuple &X, const VersionTuple &Y) {
1075 /// AvailabilityAttrsMatch - This routine checks that if comparing two
1076 /// availability attributes, all their components match. It returns
1077 /// true, if not dealing with availability or when all components of
1078 /// availability attributes match. This routine is only called when
1079 /// the attributes are of the same kind.
1080 static bool AvailabilityAttrsMatch(Attr *At1, Attr *At2) {
1081 const AvailabilityAttr *AA1 = dyn_cast<AvailabilityAttr>(At1);
1084 const AvailabilityAttr *AA2 = dyn_cast<AvailabilityAttr>(At2);
1086 VersionTuple Introduced1 = AA1->getIntroduced();
1087 VersionTuple Deprecated1 = AA1->getDeprecated();
1088 VersionTuple Obsoleted1 = AA1->getObsoleted();
1089 bool IsUnavailable1 = AA1->getUnavailable();
1090 VersionTuple Introduced2 = AA2->getIntroduced();
1091 VersionTuple Deprecated2 = AA2->getDeprecated();
1092 VersionTuple Obsoleted2 = AA2->getObsoleted();
1093 bool IsUnavailable2 = AA2->getUnavailable();
1094 return (versionsMatch(Introduced1, Introduced2) &&
1095 versionsMatch(Deprecated1, Deprecated2) &&
1096 versionsMatch(Obsoleted1, Obsoleted2) &&
1097 IsUnavailable1 == IsUnavailable2);
1100 static bool MatchTwoAttributeLists(const AttrVec &Attrs1, const AttrVec &Attrs2,
1101 bool &AvailabilityArgsMatch) {
1102 // This list is very small, so this need not be optimized.
1103 for (unsigned i = 0, e = Attrs1.size(); i != e; i++) {
1105 for (unsigned j = 0, f = Attrs2.size(); j != f; j++) {
1106 // Matching attribute kind only. Except for Availability attributes,
1107 // we are not getting into details of the attributes. For all practical purposes
1108 // this is sufficient.
1109 if (Attrs1[i]->getKind() == Attrs2[j]->getKind()) {
1110 if (AvailabilityArgsMatch)
1111 AvailabilityArgsMatch = AvailabilityAttrsMatch(Attrs1[i], Attrs2[j]);
1122 /// AttributesMatch - This routine checks list of attributes for two
1123 /// decls. It returns false, if there is a mismatch in kind of
1124 /// attributes seen in the decls. It returns true if the two decls
1125 /// have list of same kind of attributes. Furthermore, when there
1126 /// are availability attributes in the two decls, it sets the
1127 /// AvailabilityArgsMatch to false if availability attributes have
1128 /// different versions, etc.
1129 static bool AttributesMatch(const Decl *Decl1, const Decl *Decl2,
1130 bool &AvailabilityArgsMatch) {
1131 if (!Decl1->hasAttrs() || !Decl2->hasAttrs()) {
1132 AvailabilityArgsMatch = (Decl1->hasAttrs() == Decl2->hasAttrs());
1135 AvailabilityArgsMatch = true;
1136 const AttrVec &Attrs1 = Decl1->getAttrs();
1137 const AttrVec &Attrs2 = Decl2->getAttrs();
1138 bool match = MatchTwoAttributeLists(Attrs1, Attrs2, AvailabilityArgsMatch);
1139 if (match && (Attrs2.size() > Attrs1.size()))
1140 return MatchTwoAttributeLists(Attrs2, Attrs1, AvailabilityArgsMatch);
1144 static bool IsValidIdentifier(ASTContext &Ctx,
1146 if (!isIdentifierHead(Name[0]))
1148 std::string NameString = Name;
1149 NameString[0] = toLowercase(NameString[0]);
1150 IdentifierInfo *II = &Ctx.Idents.get(NameString);
1151 return II->getTokenID() == tok::identifier;
1154 bool ObjCMigrateASTConsumer::migrateProperty(ASTContext &Ctx,
1155 ObjCContainerDecl *D,
1156 ObjCMethodDecl *Method) {
1157 if (Method->isPropertyAccessor() || !Method->isInstanceMethod() ||
1158 Method->param_size() != 0)
1160 // Is this method candidate to be a getter?
1161 QualType GRT = Method->getReturnType();
1162 if (GRT->isVoidType())
1165 Selector GetterSelector = Method->getSelector();
1166 ObjCInstanceTypeFamily OIT_Family =
1167 Selector::getInstTypeMethodFamily(GetterSelector);
1169 if (OIT_Family != OIT_None)
1172 IdentifierInfo *getterName = GetterSelector.getIdentifierInfoForSlot(0);
1173 Selector SetterSelector =
1174 SelectorTable::constructSetterSelector(PP.getIdentifierTable(),
1175 PP.getSelectorTable(),
1177 ObjCMethodDecl *SetterMethod = D->getInstanceMethod(SetterSelector);
1178 unsigned LengthOfPrefix = 0;
1179 if (!SetterMethod) {
1180 // try a different naming convention for getter: isXxxxx
1181 StringRef getterNameString = getterName->getName();
1182 bool IsPrefix = getterNameString.startswith("is");
1183 // Note that we don't want to change an isXXX method of retainable object
1184 // type to property (readonly or otherwise).
1185 if (IsPrefix && GRT->isObjCRetainableType())
1187 if (IsPrefix || getterNameString.startswith("get")) {
1188 LengthOfPrefix = (IsPrefix ? 2 : 3);
1189 const char *CGetterName = getterNameString.data() + LengthOfPrefix;
1190 // Make sure that first character after "is" or "get" prefix can
1191 // start an identifier.
1192 if (!IsValidIdentifier(Ctx, CGetterName))
1194 if (CGetterName[0] && isUppercase(CGetterName[0])) {
1195 getterName = &Ctx.Idents.get(CGetterName);
1197 SelectorTable::constructSetterSelector(PP.getIdentifierTable(),
1198 PP.getSelectorTable(),
1200 SetterMethod = D->getInstanceMethod(SetterSelector);
1206 if ((ASTMigrateActions & FrontendOptions::ObjCMT_ReadwriteProperty) == 0)
1208 bool AvailabilityArgsMatch;
1209 if (SetterMethod->isDeprecated() ||
1210 !AttributesMatch(Method, SetterMethod, AvailabilityArgsMatch))
1213 // Is this a valid setter, matching the target getter?
1214 QualType SRT = SetterMethod->getReturnType();
1215 if (!SRT->isVoidType())
1217 const ParmVarDecl *argDecl = *SetterMethod->param_begin();
1218 QualType ArgType = argDecl->getType();
1219 if (!Ctx.hasSameUnqualifiedType(ArgType, GRT))
1221 edit::Commit commit(*Editor);
1222 rewriteToObjCProperty(Method, SetterMethod, *NSAPIObj, commit,
1224 (ASTMigrateActions &
1225 FrontendOptions::ObjCMT_AtomicProperty) != 0,
1226 (ASTMigrateActions &
1227 FrontendOptions::ObjCMT_NsAtomicIOSOnlyProperty) != 0,
1228 AvailabilityArgsMatch);
1229 Editor->commit(commit);
1232 else if (ASTMigrateActions & FrontendOptions::ObjCMT_ReadonlyProperty) {
1233 // Try a non-void method with no argument (and no setter or property of same name
1234 // as a 'readonly' property.
1235 edit::Commit commit(*Editor);
1236 rewriteToObjCProperty(Method, nullptr /*SetterMethod*/, *NSAPIObj, commit,
1238 (ASTMigrateActions &
1239 FrontendOptions::ObjCMT_AtomicProperty) != 0,
1240 (ASTMigrateActions &
1241 FrontendOptions::ObjCMT_NsAtomicIOSOnlyProperty) != 0,
1242 /*AvailabilityArgsMatch*/false);
1243 Editor->commit(commit);
1249 void ObjCMigrateASTConsumer::migrateNsReturnsInnerPointer(ASTContext &Ctx,
1250 ObjCMethodDecl *OM) {
1251 if (OM->isImplicit() ||
1252 !OM->isInstanceMethod() ||
1253 OM->hasAttr<ObjCReturnsInnerPointerAttr>())
1256 QualType RT = OM->getReturnType();
1257 if (!TypeIsInnerPointer(RT) ||
1258 !NSAPIObj->isMacroDefined("NS_RETURNS_INNER_POINTER"))
1261 edit::Commit commit(*Editor);
1262 commit.insertBefore(OM->getEndLoc(), " NS_RETURNS_INNER_POINTER");
1263 Editor->commit(commit);
1266 void ObjCMigrateASTConsumer::migratePropertyNsReturnsInnerPointer(ASTContext &Ctx,
1267 ObjCPropertyDecl *P) {
1268 QualType T = P->getType();
1270 if (!TypeIsInnerPointer(T) ||
1271 !NSAPIObj->isMacroDefined("NS_RETURNS_INNER_POINTER"))
1273 edit::Commit commit(*Editor);
1274 commit.insertBefore(P->getEndLoc(), " NS_RETURNS_INNER_POINTER ");
1275 Editor->commit(commit);
1278 void ObjCMigrateASTConsumer::migrateAllMethodInstaceType(ASTContext &Ctx,
1279 ObjCContainerDecl *CDecl) {
1280 if (CDecl->isDeprecated() || IsCategoryNameWithDeprecatedSuffix(CDecl))
1283 // migrate methods which can have instancetype as their result type.
1284 for (auto *Method : CDecl->methods()) {
1285 if (Method->isDeprecated())
1287 migrateMethodInstanceType(Ctx, CDecl, Method);
1291 void ObjCMigrateASTConsumer::migrateFactoryMethod(ASTContext &Ctx,
1292 ObjCContainerDecl *CDecl,
1294 ObjCInstanceTypeFamily OIT_Family) {
1295 if (OM->isInstanceMethod() ||
1296 OM->getReturnType() == Ctx.getObjCInstanceType() ||
1297 !OM->getReturnType()->isObjCIdType())
1300 // Candidate factory methods are + (id) NaMeXXX : ... which belong to a class
1301 // NSYYYNamE with matching names be at least 3 characters long.
1302 ObjCInterfaceDecl *IDecl = dyn_cast<ObjCInterfaceDecl>(CDecl);
1304 if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(CDecl))
1305 IDecl = CatDecl->getClassInterface();
1306 else if (ObjCImplDecl *ImpDecl = dyn_cast<ObjCImplDecl>(CDecl))
1307 IDecl = ImpDecl->getClassInterface();
1312 std::string StringClassName = IDecl->getName();
1313 StringRef LoweredClassName(StringClassName);
1314 std::string StringLoweredClassName = LoweredClassName.lower();
1315 LoweredClassName = StringLoweredClassName;
1317 IdentifierInfo *MethodIdName = OM->getSelector().getIdentifierInfoForSlot(0);
1318 // Handle method with no name at its first selector slot; e.g. + (id):(int)x.
1322 std::string MethodName = MethodIdName->getName();
1323 if (OIT_Family == OIT_Singleton || OIT_Family == OIT_ReturnsSelf) {
1324 StringRef STRefMethodName(MethodName);
1326 if (STRefMethodName.startswith("standard"))
1327 len = strlen("standard");
1328 else if (STRefMethodName.startswith("shared"))
1329 len = strlen("shared");
1330 else if (STRefMethodName.startswith("default"))
1331 len = strlen("default");
1334 MethodName = STRefMethodName.substr(len);
1336 std::string MethodNameSubStr = MethodName.substr(0, 3);
1337 StringRef MethodNamePrefix(MethodNameSubStr);
1338 std::string StringLoweredMethodNamePrefix = MethodNamePrefix.lower();
1339 MethodNamePrefix = StringLoweredMethodNamePrefix;
1340 size_t Ix = LoweredClassName.rfind(MethodNamePrefix);
1341 if (Ix == StringRef::npos)
1343 std::string ClassNamePostfix = LoweredClassName.substr(Ix);
1344 StringRef LoweredMethodName(MethodName);
1345 std::string StringLoweredMethodName = LoweredMethodName.lower();
1346 LoweredMethodName = StringLoweredMethodName;
1347 if (!LoweredMethodName.startswith(ClassNamePostfix))
1349 if (OIT_Family == OIT_ReturnsSelf)
1350 ReplaceWithClasstype(*this, OM);
1352 ReplaceWithInstancetype(Ctx, *this, OM);
1355 static bool IsVoidStarType(QualType Ty) {
1356 if (!Ty->isPointerType())
1359 while (const TypedefType *TD = dyn_cast<TypedefType>(Ty.getTypePtr()))
1360 Ty = TD->getDecl()->getUnderlyingType();
1362 // Is the type void*?
1363 const PointerType* PT = Ty->getAs<PointerType>();
1364 if (PT->getPointeeType().getUnqualifiedType()->isVoidType())
1366 return IsVoidStarType(PT->getPointeeType());
1369 /// AuditedType - This routine audits the type AT and returns false if it is one of known
1370 /// CF object types or of the "void *" variety. It returns true if we don't care about the type
1371 /// such as a non-pointer or pointers which have no ownership issues (such as "int *").
1372 static bool AuditedType (QualType AT) {
1373 if (!AT->isAnyPointerType() && !AT->isBlockPointerType())
1375 // FIXME. There isn't much we can say about CF pointer type; or is there?
1376 if (ento::coreFoundation::isCFObjectRef(AT) ||
1377 IsVoidStarType(AT) ||
1378 // If an ObjC object is type, assuming that it is not a CF function and
1379 // that it is an un-audited function.
1380 AT->isObjCObjectPointerType() || AT->isObjCBuiltinType())
1382 // All other pointers are assumed audited as harmless.
1386 void ObjCMigrateASTConsumer::AnnotateImplicitBridging(ASTContext &Ctx) {
1387 if (CFFunctionIBCandidates.empty())
1389 if (!NSAPIObj->isMacroDefined("CF_IMPLICIT_BRIDGING_ENABLED")) {
1390 CFFunctionIBCandidates.clear();
1394 // Insert CF_IMPLICIT_BRIDGING_ENABLE/CF_IMPLICIT_BRIDGING_DISABLED
1395 const Decl *FirstFD = CFFunctionIBCandidates[0];
1396 const Decl *LastFD =
1397 CFFunctionIBCandidates[CFFunctionIBCandidates.size()-1];
1398 const char *PragmaString = "\nCF_IMPLICIT_BRIDGING_ENABLED\n\n";
1399 edit::Commit commit(*Editor);
1400 commit.insertBefore(FirstFD->getBeginLoc(), PragmaString);
1401 PragmaString = "\n\nCF_IMPLICIT_BRIDGING_DISABLED\n";
1402 SourceLocation EndLoc = LastFD->getEndLoc();
1403 // get location just past end of function location.
1404 EndLoc = PP.getLocForEndOfToken(EndLoc);
1405 if (isa<FunctionDecl>(LastFD)) {
1406 // For Methods, EndLoc points to the ending semcolon. So,
1407 // not of these extra work is needed.
1409 // get locaiton of token that comes after end of function.
1410 bool Failed = PP.getRawToken(EndLoc, Tok, /*IgnoreWhiteSpace=*/true);
1412 EndLoc = Tok.getLocation();
1414 commit.insertAfterToken(EndLoc, PragmaString);
1415 Editor->commit(commit);
1417 CFFunctionIBCandidates.clear();
1420 void ObjCMigrateASTConsumer::migrateCFAnnotation(ASTContext &Ctx, const Decl *Decl) {
1421 if (Decl->isDeprecated())
1424 if (Decl->hasAttr<CFAuditedTransferAttr>()) {
1425 assert(CFFunctionIBCandidates.empty() &&
1426 "Cannot have audited functions/methods inside user "
1427 "provided CF_IMPLICIT_BRIDGING_ENABLE");
1431 // Finction must be annotated first.
1432 if (const FunctionDecl *FuncDecl = dyn_cast<FunctionDecl>(Decl)) {
1433 CF_BRIDGING_KIND AuditKind = migrateAddFunctionAnnotation(Ctx, FuncDecl);
1434 if (AuditKind == CF_BRIDGING_ENABLE) {
1435 CFFunctionIBCandidates.push_back(Decl);
1436 if (FileId.isInvalid())
1437 FileId = PP.getSourceManager().getFileID(Decl->getLocation());
1439 else if (AuditKind == CF_BRIDGING_MAY_INCLUDE) {
1440 if (!CFFunctionIBCandidates.empty()) {
1441 CFFunctionIBCandidates.push_back(Decl);
1442 if (FileId.isInvalid())
1443 FileId = PP.getSourceManager().getFileID(Decl->getLocation());
1447 AnnotateImplicitBridging(Ctx);
1450 migrateAddMethodAnnotation(Ctx, cast<ObjCMethodDecl>(Decl));
1451 AnnotateImplicitBridging(Ctx);
1455 void ObjCMigrateASTConsumer::AddCFAnnotations(ASTContext &Ctx,
1456 const CallEffects &CE,
1457 const FunctionDecl *FuncDecl,
1458 bool ResultAnnotated) {
1459 // Annotate function.
1460 if (!ResultAnnotated) {
1461 RetEffect Ret = CE.getReturnValue();
1462 const char *AnnotationString = nullptr;
1463 if (Ret.getObjKind() == ObjKind::CF) {
1464 if (Ret.isOwned() && NSAPIObj->isMacroDefined("CF_RETURNS_RETAINED"))
1465 AnnotationString = " CF_RETURNS_RETAINED";
1466 else if (Ret.notOwned() &&
1467 NSAPIObj->isMacroDefined("CF_RETURNS_NOT_RETAINED"))
1468 AnnotationString = " CF_RETURNS_NOT_RETAINED";
1470 else if (Ret.getObjKind() == ObjKind::ObjC) {
1471 if (Ret.isOwned() && NSAPIObj->isMacroDefined("NS_RETURNS_RETAINED"))
1472 AnnotationString = " NS_RETURNS_RETAINED";
1475 if (AnnotationString) {
1476 edit::Commit commit(*Editor);
1477 commit.insertAfterToken(FuncDecl->getEndLoc(), AnnotationString);
1478 Editor->commit(commit);
1481 ArrayRef<ArgEffect> AEArgs = CE.getArgs();
1483 for (FunctionDecl::param_const_iterator pi = FuncDecl->param_begin(),
1484 pe = FuncDecl->param_end(); pi != pe; ++pi, ++i) {
1485 const ParmVarDecl *pd = *pi;
1486 ArgEffect AE = AEArgs[i];
1487 if (AE.getKind() == DecRef && AE.getObjKind() == ObjKind::CF &&
1488 !pd->hasAttr<CFConsumedAttr>() &&
1489 NSAPIObj->isMacroDefined("CF_CONSUMED")) {
1490 edit::Commit commit(*Editor);
1491 commit.insertBefore(pd->getLocation(), "CF_CONSUMED ");
1492 Editor->commit(commit);
1493 } else if (AE.getKind() == DecRef && AE.getObjKind() == ObjKind::ObjC &&
1494 !pd->hasAttr<NSConsumedAttr>() &&
1495 NSAPIObj->isMacroDefined("NS_CONSUMED")) {
1496 edit::Commit commit(*Editor);
1497 commit.insertBefore(pd->getLocation(), "NS_CONSUMED ");
1498 Editor->commit(commit);
1503 ObjCMigrateASTConsumer::CF_BRIDGING_KIND
1504 ObjCMigrateASTConsumer::migrateAddFunctionAnnotation(
1506 const FunctionDecl *FuncDecl) {
1507 if (FuncDecl->hasBody())
1508 return CF_BRIDGING_NONE;
1510 CallEffects CE = CallEffects::getEffect(FuncDecl);
1511 bool FuncIsReturnAnnotated = (FuncDecl->hasAttr<CFReturnsRetainedAttr>() ||
1512 FuncDecl->hasAttr<CFReturnsNotRetainedAttr>() ||
1513 FuncDecl->hasAttr<NSReturnsRetainedAttr>() ||
1514 FuncDecl->hasAttr<NSReturnsNotRetainedAttr>() ||
1515 FuncDecl->hasAttr<NSReturnsAutoreleasedAttr>());
1517 // Trivial case of when function is annotated and has no argument.
1518 if (FuncIsReturnAnnotated && FuncDecl->getNumParams() == 0)
1519 return CF_BRIDGING_NONE;
1521 bool ReturnCFAudited = false;
1522 if (!FuncIsReturnAnnotated) {
1523 RetEffect Ret = CE.getReturnValue();
1524 if (Ret.getObjKind() == ObjKind::CF &&
1525 (Ret.isOwned() || Ret.notOwned()))
1526 ReturnCFAudited = true;
1527 else if (!AuditedType(FuncDecl->getReturnType()))
1528 return CF_BRIDGING_NONE;
1531 // At this point result type is audited for potential inclusion.
1532 // Now, how about argument types.
1533 ArrayRef<ArgEffect> AEArgs = CE.getArgs();
1535 bool ArgCFAudited = false;
1536 for (FunctionDecl::param_const_iterator pi = FuncDecl->param_begin(),
1537 pe = FuncDecl->param_end(); pi != pe; ++pi, ++i) {
1538 const ParmVarDecl *pd = *pi;
1539 ArgEffect AE = AEArgs[i];
1540 if ((AE.getKind() == DecRef /*CFConsumed annotated*/ ||
1541 AE.getKind() == IncRef) && AE.getObjKind() == ObjKind::CF) {
1542 if (AE.getKind() == DecRef && !pd->hasAttr<CFConsumedAttr>())
1543 ArgCFAudited = true;
1544 else if (AE.getKind() == IncRef)
1545 ArgCFAudited = true;
1547 QualType AT = pd->getType();
1548 if (!AuditedType(AT)) {
1549 AddCFAnnotations(Ctx, CE, FuncDecl, FuncIsReturnAnnotated);
1550 return CF_BRIDGING_NONE;
1554 if (ReturnCFAudited || ArgCFAudited)
1555 return CF_BRIDGING_ENABLE;
1557 return CF_BRIDGING_MAY_INCLUDE;
1560 void ObjCMigrateASTConsumer::migrateARCSafeAnnotation(ASTContext &Ctx,
1561 ObjCContainerDecl *CDecl) {
1562 if (!isa<ObjCInterfaceDecl>(CDecl) || CDecl->isDeprecated())
1565 // migrate methods which can have instancetype as their result type.
1566 for (const auto *Method : CDecl->methods())
1567 migrateCFAnnotation(Ctx, Method);
1570 void ObjCMigrateASTConsumer::AddCFAnnotations(ASTContext &Ctx,
1571 const CallEffects &CE,
1572 const ObjCMethodDecl *MethodDecl,
1573 bool ResultAnnotated) {
1574 // Annotate function.
1575 if (!ResultAnnotated) {
1576 RetEffect Ret = CE.getReturnValue();
1577 const char *AnnotationString = nullptr;
1578 if (Ret.getObjKind() == ObjKind::CF) {
1579 if (Ret.isOwned() && NSAPIObj->isMacroDefined("CF_RETURNS_RETAINED"))
1580 AnnotationString = " CF_RETURNS_RETAINED";
1581 else if (Ret.notOwned() &&
1582 NSAPIObj->isMacroDefined("CF_RETURNS_NOT_RETAINED"))
1583 AnnotationString = " CF_RETURNS_NOT_RETAINED";
1585 else if (Ret.getObjKind() == ObjKind::ObjC) {
1586 ObjCMethodFamily OMF = MethodDecl->getMethodFamily();
1588 case clang::OMF_alloc:
1589 case clang::OMF_new:
1590 case clang::OMF_copy:
1591 case clang::OMF_init:
1592 case clang::OMF_mutableCopy:
1596 if (Ret.isOwned() && NSAPIObj->isMacroDefined("NS_RETURNS_RETAINED"))
1597 AnnotationString = " NS_RETURNS_RETAINED";
1602 if (AnnotationString) {
1603 edit::Commit commit(*Editor);
1604 commit.insertBefore(MethodDecl->getEndLoc(), AnnotationString);
1605 Editor->commit(commit);
1608 ArrayRef<ArgEffect> AEArgs = CE.getArgs();
1610 for (ObjCMethodDecl::param_const_iterator pi = MethodDecl->param_begin(),
1611 pe = MethodDecl->param_end(); pi != pe; ++pi, ++i) {
1612 const ParmVarDecl *pd = *pi;
1613 ArgEffect AE = AEArgs[i];
1614 if (AE.getKind() == DecRef
1615 && AE.getObjKind() == ObjKind::CF
1616 && !pd->hasAttr<CFConsumedAttr>() &&
1617 NSAPIObj->isMacroDefined("CF_CONSUMED")) {
1618 edit::Commit commit(*Editor);
1619 commit.insertBefore(pd->getLocation(), "CF_CONSUMED ");
1620 Editor->commit(commit);
1625 void ObjCMigrateASTConsumer::migrateAddMethodAnnotation(
1627 const ObjCMethodDecl *MethodDecl) {
1628 if (MethodDecl->hasBody() || MethodDecl->isImplicit())
1631 CallEffects CE = CallEffects::getEffect(MethodDecl);
1632 bool MethodIsReturnAnnotated =
1633 (MethodDecl->hasAttr<CFReturnsRetainedAttr>() ||
1634 MethodDecl->hasAttr<CFReturnsNotRetainedAttr>() ||
1635 MethodDecl->hasAttr<NSReturnsRetainedAttr>() ||
1636 MethodDecl->hasAttr<NSReturnsNotRetainedAttr>() ||
1637 MethodDecl->hasAttr<NSReturnsAutoreleasedAttr>());
1639 if (CE.getReceiver().getKind() == DecRef &&
1640 !MethodDecl->hasAttr<NSConsumesSelfAttr>() &&
1641 MethodDecl->getMethodFamily() != OMF_init &&
1642 MethodDecl->getMethodFamily() != OMF_release &&
1643 NSAPIObj->isMacroDefined("NS_CONSUMES_SELF")) {
1644 edit::Commit commit(*Editor);
1645 commit.insertBefore(MethodDecl->getEndLoc(), " NS_CONSUMES_SELF");
1646 Editor->commit(commit);
1649 // Trivial case of when function is annotated and has no argument.
1650 if (MethodIsReturnAnnotated &&
1651 (MethodDecl->param_begin() == MethodDecl->param_end()))
1654 if (!MethodIsReturnAnnotated) {
1655 RetEffect Ret = CE.getReturnValue();
1656 if ((Ret.getObjKind() == ObjKind::CF ||
1657 Ret.getObjKind() == ObjKind::ObjC) &&
1658 (Ret.isOwned() || Ret.notOwned())) {
1659 AddCFAnnotations(Ctx, CE, MethodDecl, false);
1661 } else if (!AuditedType(MethodDecl->getReturnType()))
1665 // At this point result type is either annotated or audited.
1666 // Now, how about argument types.
1667 ArrayRef<ArgEffect> AEArgs = CE.getArgs();
1669 for (ObjCMethodDecl::param_const_iterator pi = MethodDecl->param_begin(),
1670 pe = MethodDecl->param_end(); pi != pe; ++pi, ++i) {
1671 const ParmVarDecl *pd = *pi;
1672 ArgEffect AE = AEArgs[i];
1673 if ((AE.getKind() == DecRef && !pd->hasAttr<CFConsumedAttr>()) ||
1674 AE.getKind() == IncRef || !AuditedType(pd->getType())) {
1675 AddCFAnnotations(Ctx, CE, MethodDecl, MethodIsReturnAnnotated);
1682 class SuperInitChecker : public RecursiveASTVisitor<SuperInitChecker> {
1684 bool shouldVisitTemplateInstantiations() const { return false; }
1685 bool shouldWalkTypesOfTypeLocs() const { return false; }
1687 bool VisitObjCMessageExpr(ObjCMessageExpr *E) {
1688 if (E->getReceiverKind() == ObjCMessageExpr::SuperInstance) {
1689 if (E->getMethodFamily() == OMF_init)
1695 } // end anonymous namespace
1697 static bool hasSuperInitCall(const ObjCMethodDecl *MD) {
1698 return !SuperInitChecker().TraverseStmt(MD->getBody());
1701 void ObjCMigrateASTConsumer::inferDesignatedInitializers(
1703 const ObjCImplementationDecl *ImplD) {
1705 const ObjCInterfaceDecl *IFace = ImplD->getClassInterface();
1706 if (!IFace || IFace->hasDesignatedInitializers())
1708 if (!NSAPIObj->isMacroDefined("NS_DESIGNATED_INITIALIZER"))
1711 for (const auto *MD : ImplD->instance_methods()) {
1712 if (MD->isDeprecated() ||
1713 MD->getMethodFamily() != OMF_init ||
1714 MD->isDesignatedInitializerForTheInterface())
1716 const ObjCMethodDecl *IFaceM = IFace->getMethod(MD->getSelector(),
1717 /*isInstance=*/true);
1720 if (hasSuperInitCall(MD)) {
1721 edit::Commit commit(*Editor);
1722 commit.insert(IFaceM->getEndLoc(), " NS_DESIGNATED_INITIALIZER");
1723 Editor->commit(commit);
1728 bool ObjCMigrateASTConsumer::InsertFoundation(ASTContext &Ctx,
1729 SourceLocation Loc) {
1730 if (FoundationIncluded)
1732 if (Loc.isInvalid())
1734 auto *nsEnumId = &Ctx.Idents.get("NS_ENUM");
1735 if (PP.getMacroDefinitionAtLoc(nsEnumId, Loc)) {
1736 FoundationIncluded = true;
1739 edit::Commit commit(*Editor);
1740 if (Ctx.getLangOpts().Modules)
1741 commit.insert(Loc, "#ifndef NS_ENUM\n@import Foundation;\n#endif\n");
1743 commit.insert(Loc, "#ifndef NS_ENUM\n#import <Foundation/Foundation.h>\n#endif\n");
1744 Editor->commit(commit);
1745 FoundationIncluded = true;
1751 class RewritesReceiver : public edit::EditsReceiver {
1755 RewritesReceiver(Rewriter &Rewrite) : Rewrite(Rewrite) { }
1757 void insert(SourceLocation loc, StringRef text) override {
1758 Rewrite.InsertText(loc, text);
1760 void replace(CharSourceRange range, StringRef text) override {
1761 Rewrite.ReplaceText(range.getBegin(), Rewrite.getRangeSize(range), text);
1765 class JSONEditWriter : public edit::EditsReceiver {
1766 SourceManager &SourceMgr;
1767 llvm::raw_ostream &OS;
1770 JSONEditWriter(SourceManager &SM, llvm::raw_ostream &OS)
1771 : SourceMgr(SM), OS(OS) {
1774 ~JSONEditWriter() override { OS << "]\n"; }
1777 struct EntryWriter {
1778 SourceManager &SourceMgr;
1779 llvm::raw_ostream &OS;
1781 EntryWriter(SourceManager &SM, llvm::raw_ostream &OS)
1782 : SourceMgr(SM), OS(OS) {
1789 void writeLoc(SourceLocation Loc) {
1792 std::tie(FID, Offset) = SourceMgr.getDecomposedLoc(Loc);
1793 assert(FID.isValid());
1794 SmallString<200> Path =
1795 StringRef(SourceMgr.getFileEntryForID(FID)->getName());
1796 llvm::sys::fs::make_absolute(Path);
1797 OS << " \"file\": \"";
1798 OS.write_escaped(Path.str()) << "\",\n";
1799 OS << " \"offset\": " << Offset << ",\n";
1802 void writeRemove(CharSourceRange Range) {
1803 assert(Range.isCharRange());
1804 std::pair<FileID, unsigned> Begin =
1805 SourceMgr.getDecomposedLoc(Range.getBegin());
1806 std::pair<FileID, unsigned> End =
1807 SourceMgr.getDecomposedLoc(Range.getEnd());
1808 assert(Begin.first == End.first);
1809 assert(Begin.second <= End.second);
1810 unsigned Length = End.second - Begin.second;
1812 OS << " \"remove\": " << Length << ",\n";
1815 void writeText(StringRef Text) {
1816 OS << " \"text\": \"";
1817 OS.write_escaped(Text) << "\",\n";
1821 void insert(SourceLocation Loc, StringRef Text) override {
1822 EntryWriter Writer(SourceMgr, OS);
1823 Writer.writeLoc(Loc);
1824 Writer.writeText(Text);
1827 void replace(CharSourceRange Range, StringRef Text) override {
1828 EntryWriter Writer(SourceMgr, OS);
1829 Writer.writeLoc(Range.getBegin());
1830 Writer.writeRemove(Range);
1831 Writer.writeText(Text);
1834 void remove(CharSourceRange Range) override {
1835 EntryWriter Writer(SourceMgr, OS);
1836 Writer.writeLoc(Range.getBegin());
1837 Writer.writeRemove(Range);
1841 } // end anonymous namespace
1843 void ObjCMigrateASTConsumer::HandleTranslationUnit(ASTContext &Ctx) {
1845 TranslationUnitDecl *TU = Ctx.getTranslationUnitDecl();
1846 if (ASTMigrateActions & FrontendOptions::ObjCMT_MigrateDecls) {
1847 for (DeclContext::decl_iterator D = TU->decls_begin(), DEnd = TU->decls_end();
1849 FileID FID = PP.getSourceManager().getFileID((*D)->getLocation());
1851 if (FileId.isValid() && FileId != FID) {
1852 if (ASTMigrateActions & FrontendOptions::ObjCMT_Annotation)
1853 AnnotateImplicitBridging(Ctx);
1856 if (ObjCInterfaceDecl *CDecl = dyn_cast<ObjCInterfaceDecl>(*D))
1857 if (canModify(CDecl))
1858 migrateObjCContainerDecl(Ctx, CDecl);
1859 if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(*D)) {
1860 if (canModify(CatDecl))
1861 migrateObjCContainerDecl(Ctx, CatDecl);
1863 else if (ObjCProtocolDecl *PDecl = dyn_cast<ObjCProtocolDecl>(*D)) {
1864 ObjCProtocolDecls.insert(PDecl->getCanonicalDecl());
1865 if (canModify(PDecl))
1866 migrateObjCContainerDecl(Ctx, PDecl);
1868 else if (const ObjCImplementationDecl *ImpDecl =
1869 dyn_cast<ObjCImplementationDecl>(*D)) {
1870 if ((ASTMigrateActions & FrontendOptions::ObjCMT_ProtocolConformance) &&
1872 migrateProtocolConformance(Ctx, ImpDecl);
1874 else if (const EnumDecl *ED = dyn_cast<EnumDecl>(*D)) {
1875 if (!(ASTMigrateActions & FrontendOptions::ObjCMT_NsMacros))
1879 DeclContext::decl_iterator N = D;
1881 const TypedefDecl *TD = dyn_cast<TypedefDecl>(*N);
1882 if (migrateNSEnumDecl(Ctx, ED, TD) && TD)
1886 migrateNSEnumDecl(Ctx, ED, /*TypedefDecl */nullptr);
1888 else if (const TypedefDecl *TD = dyn_cast<TypedefDecl>(*D)) {
1889 if (!(ASTMigrateActions & FrontendOptions::ObjCMT_NsMacros))
1893 DeclContext::decl_iterator N = D;
1896 if (const EnumDecl *ED = dyn_cast<EnumDecl>(*N)) {
1897 if (canModify(ED)) {
1899 if (const TypedefDecl *TDF = dyn_cast<TypedefDecl>(*N)) {
1900 // prefer typedef-follows-enum to enum-follows-typedef pattern.
1901 if (migrateNSEnumDecl(Ctx, ED, TDF)) {
1903 CacheObjCNSIntegerTypedefed(TD);
1907 if (migrateNSEnumDecl(Ctx, ED, TD)) {
1913 CacheObjCNSIntegerTypedefed(TD);
1915 else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(*D)) {
1916 if ((ASTMigrateActions & FrontendOptions::ObjCMT_Annotation) &&
1918 migrateCFAnnotation(Ctx, FD);
1921 if (ObjCContainerDecl *CDecl = dyn_cast<ObjCContainerDecl>(*D)) {
1922 bool CanModify = canModify(CDecl);
1923 // migrate methods which can have instancetype as their result type.
1924 if ((ASTMigrateActions & FrontendOptions::ObjCMT_Instancetype) &&
1926 migrateAllMethodInstaceType(Ctx, CDecl);
1927 // annotate methods with CF annotations.
1928 if ((ASTMigrateActions & FrontendOptions::ObjCMT_Annotation) &&
1930 migrateARCSafeAnnotation(Ctx, CDecl);
1933 if (const ObjCImplementationDecl *
1934 ImplD = dyn_cast<ObjCImplementationDecl>(*D)) {
1935 if ((ASTMigrateActions & FrontendOptions::ObjCMT_DesignatedInitializer) &&
1937 inferDesignatedInitializers(Ctx, ImplD);
1940 if (ASTMigrateActions & FrontendOptions::ObjCMT_Annotation)
1941 AnnotateImplicitBridging(Ctx);
1946 llvm::raw_fd_ostream OS(MigrateDir, EC, llvm::sys::fs::F_None);
1948 DiagnosticsEngine &Diags = Ctx.getDiagnostics();
1949 Diags.Report(Diags.getCustomDiagID(DiagnosticsEngine::Error, "%0"))
1954 JSONEditWriter Writer(Ctx.getSourceManager(), OS);
1955 Editor->applyRewrites(Writer);
1959 Rewriter rewriter(Ctx.getSourceManager(), Ctx.getLangOpts());
1960 RewritesReceiver Rec(rewriter);
1961 Editor->applyRewrites(Rec);
1963 for (Rewriter::buffer_iterator
1964 I = rewriter.buffer_begin(), E = rewriter.buffer_end(); I != E; ++I) {
1965 FileID FID = I->first;
1966 RewriteBuffer &buf = I->second;
1967 const FileEntry *file = Ctx.getSourceManager().getFileEntryForID(FID);
1969 SmallString<512> newText;
1970 llvm::raw_svector_ostream vecOS(newText);
1972 std::unique_ptr<llvm::MemoryBuffer> memBuf(
1973 llvm::MemoryBuffer::getMemBufferCopy(
1974 StringRef(newText.data(), newText.size()), file->getName()));
1975 SmallString<64> filePath(file->getName());
1976 FileMgr.FixupRelativePath(filePath);
1977 Remapper.remap(filePath.str(), std::move(memBuf));
1981 Remapper.flushToFile(MigrateDir, Ctx.getDiagnostics());
1983 Remapper.flushToDisk(MigrateDir, Ctx.getDiagnostics());
1987 bool MigrateSourceAction::BeginInvocation(CompilerInstance &CI) {
1988 CI.getDiagnostics().setIgnoreAllWarnings(true);
1992 static std::vector<std::string> getWhiteListFilenames(StringRef DirPath) {
1993 using namespace llvm::sys::fs;
1994 using namespace llvm::sys::path;
1996 std::vector<std::string> Filenames;
1997 if (DirPath.empty() || !is_directory(DirPath))
2001 directory_iterator DI = directory_iterator(DirPath, EC);
2002 directory_iterator DE;
2003 for (; !EC && DI != DE; DI = DI.increment(EC)) {
2004 if (is_regular_file(DI->path()))
2005 Filenames.push_back(filename(DI->path()));
2011 std::unique_ptr<ASTConsumer>
2012 MigrateSourceAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
2013 PPConditionalDirectiveRecord *
2014 PPRec = new PPConditionalDirectiveRecord(CI.getSourceManager());
2015 unsigned ObjCMTAction = CI.getFrontendOpts().ObjCMTAction;
2016 unsigned ObjCMTOpts = ObjCMTAction;
2017 // These are companion flags, they do not enable transformations.
2018 ObjCMTOpts &= ~(FrontendOptions::ObjCMT_AtomicProperty |
2019 FrontendOptions::ObjCMT_NsAtomicIOSOnlyProperty);
2020 if (ObjCMTOpts == FrontendOptions::ObjCMT_None) {
2021 // If no specific option was given, enable literals+subscripting transforms
2023 ObjCMTAction |= FrontendOptions::ObjCMT_Literals |
2024 FrontendOptions::ObjCMT_Subscripting;
2026 CI.getPreprocessor().addPPCallbacks(std::unique_ptr<PPCallbacks>(PPRec));
2027 std::vector<std::string> WhiteList =
2028 getWhiteListFilenames(CI.getFrontendOpts().ObjCMTWhiteListPath);
2029 return llvm::make_unique<ObjCMigrateASTConsumer>(
2030 CI.getFrontendOpts().OutputFile, ObjCMTAction, Remapper,
2031 CI.getFileManager(), PPRec, CI.getPreprocessor(),
2032 /*isOutputFile=*/true, WhiteList);
2037 const FileEntry *File;
2042 EditEntry() : File(), Offset(), RemoveLen() {}
2044 } // end anonymous namespace
2047 template<> struct DenseMapInfo<EditEntry> {
2048 static inline EditEntry getEmptyKey() {
2050 Entry.Offset = unsigned(-1);
2053 static inline EditEntry getTombstoneKey() {
2055 Entry.Offset = unsigned(-2);
2058 static unsigned getHashValue(const EditEntry& Val) {
2059 llvm::FoldingSetNodeID ID;
2060 ID.AddPointer(Val.File);
2061 ID.AddInteger(Val.Offset);
2062 ID.AddInteger(Val.RemoveLen);
2063 ID.AddString(Val.Text);
2064 return ID.ComputeHash();
2066 static bool isEqual(const EditEntry &LHS, const EditEntry &RHS) {
2067 return LHS.File == RHS.File &&
2068 LHS.Offset == RHS.Offset &&
2069 LHS.RemoveLen == RHS.RemoveLen &&
2070 LHS.Text == RHS.Text;
2073 } // end namespace llvm
2076 class RemapFileParser {
2077 FileManager &FileMgr;
2080 RemapFileParser(FileManager &FileMgr) : FileMgr(FileMgr) { }
2082 bool parse(StringRef File, SmallVectorImpl<EditEntry> &Entries) {
2083 using namespace llvm::yaml;
2085 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> FileBufOrErr =
2086 llvm::MemoryBuffer::getFile(File);
2091 Stream YAMLStream(FileBufOrErr.get()->getMemBufferRef(), SM);
2092 document_iterator I = YAMLStream.begin();
2093 if (I == YAMLStream.end())
2095 Node *Root = I->getRoot();
2099 SequenceNode *SeqNode = dyn_cast<SequenceNode>(Root);
2103 for (SequenceNode::iterator
2104 AI = SeqNode->begin(), AE = SeqNode->end(); AI != AE; ++AI) {
2105 MappingNode *MapNode = dyn_cast<MappingNode>(&*AI);
2108 parseEdit(MapNode, Entries);
2115 void parseEdit(llvm::yaml::MappingNode *Node,
2116 SmallVectorImpl<EditEntry> &Entries) {
2117 using namespace llvm::yaml;
2119 bool Ignore = false;
2121 for (MappingNode::iterator
2122 KVI = Node->begin(), KVE = Node->end(); KVI != KVE; ++KVI) {
2123 ScalarNode *KeyString = dyn_cast<ScalarNode>((*KVI).getKey());
2126 SmallString<10> KeyStorage;
2127 StringRef Key = KeyString->getValue(KeyStorage);
2129 ScalarNode *ValueString = dyn_cast<ScalarNode>((*KVI).getValue());
2132 SmallString<64> ValueStorage;
2133 StringRef Val = ValueString->getValue(ValueStorage);
2135 if (Key == "file") {
2136 const FileEntry *FE = FileMgr.getFile(Val);
2140 } else if (Key == "offset") {
2141 if (Val.getAsInteger(10, Entry.Offset))
2143 } else if (Key == "remove") {
2144 if (Val.getAsInteger(10, Entry.RemoveLen))
2146 } else if (Key == "text") {
2152 Entries.push_back(Entry);
2155 } // end anonymous namespace
2157 static bool reportDiag(const Twine &Err, DiagnosticsEngine &Diag) {
2158 Diag.Report(Diag.getCustomDiagID(DiagnosticsEngine::Error, "%0"))
2163 static std::string applyEditsToTemp(const FileEntry *FE,
2164 ArrayRef<EditEntry> Edits,
2165 FileManager &FileMgr,
2166 DiagnosticsEngine &Diag) {
2167 using namespace llvm::sys;
2169 SourceManager SM(Diag, FileMgr);
2170 FileID FID = SM.createFileID(FE, SourceLocation(), SrcMgr::C_User);
2171 LangOptions LangOpts;
2172 edit::EditedSource Editor(SM, LangOpts);
2173 for (ArrayRef<EditEntry>::iterator
2174 I = Edits.begin(), E = Edits.end(); I != E; ++I) {
2175 const EditEntry &Entry = *I;
2176 assert(Entry.File == FE);
2177 SourceLocation Loc =
2178 SM.getLocForStartOfFile(FID).getLocWithOffset(Entry.Offset);
2179 CharSourceRange Range;
2180 if (Entry.RemoveLen != 0) {
2181 Range = CharSourceRange::getCharRange(Loc,
2182 Loc.getLocWithOffset(Entry.RemoveLen));
2185 edit::Commit commit(Editor);
2186 if (Range.isInvalid()) {
2187 commit.insert(Loc, Entry.Text);
2188 } else if (Entry.Text.empty()) {
2189 commit.remove(Range);
2191 commit.replace(Range, Entry.Text);
2193 Editor.commit(commit);
2196 Rewriter rewriter(SM, LangOpts);
2197 RewritesReceiver Rec(rewriter);
2198 Editor.applyRewrites(Rec, /*adjustRemovals=*/false);
2200 const RewriteBuffer *Buf = rewriter.getRewriteBufferFor(FID);
2201 SmallString<512> NewText;
2202 llvm::raw_svector_ostream OS(NewText);
2205 SmallString<64> TempPath;
2207 if (fs::createTemporaryFile(path::filename(FE->getName()),
2208 path::extension(FE->getName()).drop_front(), FD,
2210 reportDiag("Could not create file: " + TempPath.str(), Diag);
2211 return std::string();
2214 llvm::raw_fd_ostream TmpOut(FD, /*shouldClose=*/true);
2215 TmpOut.write(NewText.data(), NewText.size());
2218 return TempPath.str();
2221 bool arcmt::getFileRemappingsFromFileList(
2222 std::vector<std::pair<std::string,std::string> > &remap,
2223 ArrayRef<StringRef> remapFiles,
2224 DiagnosticConsumer *DiagClient) {
2225 bool hasErrorOccurred = false;
2227 FileSystemOptions FSOpts;
2228 FileManager FileMgr(FSOpts);
2229 RemapFileParser Parser(FileMgr);
2231 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
2232 IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
2233 new DiagnosticsEngine(DiagID, new DiagnosticOptions,
2234 DiagClient, /*ShouldOwnClient=*/false));
2236 typedef llvm::DenseMap<const FileEntry *, std::vector<EditEntry> >
2238 FileEditEntriesTy FileEditEntries;
2240 llvm::DenseSet<EditEntry> EntriesSet;
2242 for (ArrayRef<StringRef>::iterator
2243 I = remapFiles.begin(), E = remapFiles.end(); I != E; ++I) {
2244 SmallVector<EditEntry, 16> Entries;
2245 if (Parser.parse(*I, Entries))
2248 for (SmallVectorImpl<EditEntry>::iterator
2249 EI = Entries.begin(), EE = Entries.end(); EI != EE; ++EI) {
2250 EditEntry &Entry = *EI;
2253 std::pair<llvm::DenseSet<EditEntry>::iterator, bool>
2254 Insert = EntriesSet.insert(Entry);
2258 FileEditEntries[Entry.File].push_back(Entry);
2262 for (FileEditEntriesTy::iterator
2263 I = FileEditEntries.begin(), E = FileEditEntries.end(); I != E; ++I) {
2264 std::string TempFile = applyEditsToTemp(I->first, I->second,
2266 if (TempFile.empty()) {
2267 hasErrorOccurred = true;
2271 remap.emplace_back(I->first->getName(), TempFile);
2274 return hasErrorOccurred;