/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/include/clang/Basic/FileEntry.h

Bug Summary

File:	clang/include/clang/Basic/FileEntry.h
Warning:	line 62, column 38 Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

Show analyzer invocation

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name ObjCMT.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -relaxed-aliasing -fmath-errno -fno-rounding-math -mconstructor-aliases -munwind-tables -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/tools/clang/lib/ARCMigrate -resource-dir /usr/lib/llvm-14/lib/clang/14.0.0 -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/tools/clang/lib/ARCMigrate -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/lib/ARCMigrate -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/include -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/tools/clang/include -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/include -I /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/llvm/include -D NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-14/lib/clang/14.0.0/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir=/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/build-llvm/tools/clang/lib/ARCMigrate -fdebug-prefix-map=/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e=. -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2021-09-04-040900-46481-1 -x c++ /build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/lib/ARCMigrate/ObjCMT.cpp

/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/lib/ARCMigrate/ObjCMT.cpp

→

1//===--- ObjCMT.cpp - ObjC Migrate Tool -----------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//

9#include "Transforms.h"
10#include "clang/Analysis/RetainSummaryManager.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 "llvm/ADT/SmallString.h"
31#include "llvm/ADT/StringSet.h"
32#include "llvm/Support/Path.h"
33#include "llvm/Support/SourceMgr.h"
34#include "llvm/Support/YAMLParser.h"

36using namespace clang;
37using namespace arcmt;
38using namespace ento;

40namespace {

42class ObjCMigrateASTConsumer : public ASTConsumer {
enum CF_BRIDGING_KIND {
  CF_BRIDGING_NONE,
  CF_BRIDGING_ENABLE,
  CF_BRIDGING_MAY_INCLUDE
};

void migrateDecl(Decl *D);
void migrateObjCContainerDecl(ASTContext &Ctx, ObjCContainerDecl *D);
void migrateProtocolConformance(ASTContext &Ctx,
                                const ObjCImplementationDecl *ImpDecl);
void CacheObjCNSIntegerTypedefed(const TypedefDecl *TypedefDcl);
bool migrateNSEnumDecl(ASTContext &Ctx, const EnumDecl *EnumDcl,
                   const TypedefDecl *TypedefDcl);
void migrateAllMethodInstaceType(ASTContext &Ctx, ObjCContainerDecl *CDecl);
void migrateMethodInstanceType(ASTContext &Ctx, ObjCContainerDecl *CDecl,
                               ObjCMethodDecl *OM);
bool migrateProperty(ASTContext &Ctx, ObjCContainerDecl *D, ObjCMethodDecl *OM);
void migrateNsReturnsInnerPointer(ASTContext &Ctx, ObjCMethodDecl *OM);
void migratePropertyNsReturnsInnerPointer(ASTContext &Ctx, ObjCPropertyDecl *P);
void migrateFactoryMethod(ASTContext &Ctx, ObjCContainerDecl *CDecl,
                          ObjCMethodDecl *OM,
                          ObjCInstanceTypeFamily OIT_Family = OIT_None);

void migrateCFAnnotation(ASTContext &Ctx, const Decl *Decl);
void AddCFAnnotations(ASTContext &Ctx,
                      const RetainSummary *RS,
                      const FunctionDecl *FuncDecl, bool ResultAnnotated);
void AddCFAnnotations(ASTContext &Ctx,
                      const RetainSummary *RS,
                      const ObjCMethodDecl *MethodDecl, bool ResultAnnotated);

void AnnotateImplicitBridging(ASTContext &Ctx);

CF_BRIDGING_KIND migrateAddFunctionAnnotation(ASTContext &Ctx,
                                              const FunctionDecl *FuncDecl);

void migrateARCSafeAnnotation(ASTContext &Ctx, ObjCContainerDecl *CDecl);

void migrateAddMethodAnnotation(ASTContext &Ctx,
                                const ObjCMethodDecl *MethodDecl);

void inferDesignatedInitializers(ASTContext &Ctx,
                                 const ObjCImplementationDecl *ImplD);

bool InsertFoundation(ASTContext &Ctx, SourceLocation Loc);

std::unique_ptr<RetainSummaryManager> Summaries;

91public:
std::string MigrateDir;
unsigned ASTMigrateActions;
FileID FileId;
const TypedefDecl *NSIntegerTypedefed;
const TypedefDecl *NSUIntegerTypedefed;
std::unique_ptr<NSAPI> NSAPIObj;
std::unique_ptr<edit::EditedSource> Editor;
FileRemapper &Remapper;
FileManager &FileMgr;
const PPConditionalDirectiveRecord *PPRec;
Preprocessor &PP;
bool IsOutputFile;
bool FoundationIncluded;
llvm::SmallPtrSet<ObjCProtocolDecl *, 32> ObjCProtocolDecls;
llvm::SmallVector<const Decl *, 8> CFFunctionIBCandidates;
llvm::StringSet<> WhiteListFilenames;

RetainSummaryManager &getSummaryManager(ASTContext &Ctx) {
  if (!Summaries)
    Summaries.reset(new RetainSummaryManager(Ctx,
                                             /*TrackNSCFObjects=*/true,
                                             /*trackOSObjects=*/false));
  return *Summaries;
}

ObjCMigrateASTConsumer(StringRef migrateDir, unsigned astMigrateActions,
                       FileRemapper &remapper, FileManager &fileMgr,
                       const PPConditionalDirectiveRecord *PPRec,
                       Preprocessor &PP, bool isOutputFile,
                       ArrayRef<std::string> WhiteList)
    : MigrateDir(migrateDir), ASTMigrateActions(astMigrateActions),
      NSIntegerTypedefed(nullptr), NSUIntegerTypedefed(nullptr),
      Remapper(remapper), FileMgr(fileMgr), PPRec(PPRec), PP(PP),
      IsOutputFile(isOutputFile), FoundationIncluded(false) {
  // FIXME: StringSet should have insert(iter, iter) to use here.
  for (const std::string &Val : WhiteList)
    WhiteListFilenames.insert(Val);
}

131protected:
void Initialize(ASTContext &Context) override {
  NSAPIObj.reset(new NSAPI(Context));
  Editor.reset(new edit::EditedSource(Context.getSourceManager(),
                                      Context.getLangOpts(),
                                      PPRec));
}

bool HandleTopLevelDecl(DeclGroupRef DG) override {
  for (DeclGroupRef::iterator I = DG.begin(), E = DG.end(); I != E; ++I)
    migrateDecl(*I);
  return true;
}
void HandleInterestingDecl(DeclGroupRef DG) override {
  // Ignore decls from the PCH.
}
void HandleTopLevelDeclInObjCContainer(DeclGroupRef DG) override {
  ObjCMigrateASTConsumer::HandleTopLevelDecl(DG);
}

void HandleTranslationUnit(ASTContext &Ctx) override;

bool canModifyFile(StringRef Path) {
  if (WhiteListFilenames.empty())
    return true;
  return WhiteListFilenames.find(llvm::sys::path::filename(Path))
      != WhiteListFilenames.end();
}
bool canModifyFile(Optional<FileEntryRef> FE) {
  if (!FE)
    return false;
  return canModifyFile(FE->getName());
}
bool canModifyFile(FileID FID) {
  if (FID.isInvalid())
    return false;
  return canModifyFile(PP.getSourceManager().getFileEntryRefForID(FID));
}

bool canModify(const Decl *D) {
  if (!D)
    return false;
  if (const ObjCCategoryImplDecl *CatImpl = dyn_cast<ObjCCategoryImplDecl>(D))
    return canModify(CatImpl->getCategoryDecl());
  if (const ObjCImplementationDecl *Impl = dyn_cast<ObjCImplementationDecl>(D))
    return canModify(Impl->getClassInterface());
  if (const ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D))
    return canModify(cast<Decl>(MD->getDeclContext()));

  FileID FID = PP.getSourceManager().getFileID(D->getLocation());
  return canModifyFile(FID);
}
183};

185} // end anonymous namespace

187ObjCMigrateAction::ObjCMigrateAction(
  std::unique_ptr<FrontendAction> WrappedAction, StringRef migrateDir,
  unsigned migrateAction)
  : WrapperFrontendAction(std::move(WrappedAction)), MigrateDir(migrateDir),
    ObjCMigAction(migrateAction), CompInst(nullptr) {
if (MigrateDir.empty())
  MigrateDir = "."; // user current directory if none is given.
194}

196std::unique_ptr<ASTConsumer>
197ObjCMigrateAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
PPConditionalDirectiveRecord *
  PPRec = new PPConditionalDirectiveRecord(CompInst->getSourceManager());
CI.getPreprocessor().addPPCallbacks(std::unique_ptr<PPCallbacks>(PPRec));
std::vector<std::unique_ptr<ASTConsumer>> Consumers;
Consumers.push_back(WrapperFrontendAction::CreateASTConsumer(CI, InFile));
Consumers.push_back(std::make_unique<ObjCMigrateASTConsumer>(
    MigrateDir, ObjCMigAction, Remapper, CompInst->getFileManager(), PPRec,
    CompInst->getPreprocessor(), false, None));
return std::make_unique<MultiplexConsumer>(std::move(Consumers));
207}

209bool ObjCMigrateAction::BeginInvocation(CompilerInstance &CI) {
Remapper.initFromDisk(MigrateDir, CI.getDiagnostics(),
                      /*ignoreIfFilesChanged=*/true);
CompInst = &CI;
CI.getDiagnostics().setIgnoreAllWarnings(true);
return true;
215}

217namespace {
// FIXME. This duplicates one in RewriteObjCFoundationAPI.cpp
bool subscriptOperatorNeedsParens(const Expr *FullExpr) {
  const Expr* Expr = FullExpr->IgnoreImpCasts();
  return !(isa<ArraySubscriptExpr>(Expr) || isa<CallExpr>(Expr) ||
           isa<DeclRefExpr>(Expr) || isa<CXXNamedCastExpr>(Expr) ||
           isa<CXXConstructExpr>(Expr) || isa<CXXThisExpr>(Expr) ||
           isa<CXXTypeidExpr>(Expr) ||
           isa<CXXUnresolvedConstructExpr>(Expr) ||
           isa<ObjCMessageExpr>(Expr) || isa<ObjCPropertyRefExpr>(Expr) ||
           isa<ObjCProtocolExpr>(Expr) || isa<MemberExpr>(Expr) ||
           isa<ObjCIvarRefExpr>(Expr) || isa<ParenExpr>(FullExpr) ||
           isa<ParenListExpr>(Expr) || isa<SizeOfPackExpr>(Expr));
}

/// - Rewrite message expression for Objective-C setter and getters into
/// property-dot syntax.
bool rewriteToPropertyDotSyntax(const ObjCMessageExpr *Msg,
                                Preprocessor &PP,
                                const NSAPI &NS, edit::Commit &commit,
                                const ParentMap *PMap) {
  if (!Msg || Msg->isImplicit() ||
      (Msg->getReceiverKind() != ObjCMessageExpr::Instance &&
       Msg->getReceiverKind() != ObjCMessageExpr::SuperInstance))
    return false;
  if (const Expr *Receiver = Msg->getInstanceReceiver())
    if (Receiver->getType()->isObjCBuiltinType())
      return false;

  const ObjCMethodDecl *Method = Msg->getMethodDecl();
  if (!Method)
    return false;
  if (!Method->isPropertyAccessor())
    return false;

  const ObjCPropertyDecl *Prop = Method->findPropertyDecl();
  if (!Prop)
    return false;

  SourceRange MsgRange = Msg->getSourceRange();
  bool ReceiverIsSuper =
    (Msg->getReceiverKind() == ObjCMessageExpr::SuperInstance);
  // for 'super' receiver is nullptr.
  const Expr *receiver = Msg->getInstanceReceiver();
  bool NeedsParen =
    ReceiverIsSuper ? false : subscriptOperatorNeedsParens(receiver);
  bool IsGetter = (Msg->getNumArgs() == 0);
  if (IsGetter) {
    // Find space location range between receiver expression and getter method.
    SourceLocation BegLoc =
        ReceiverIsSuper ? Msg->getSuperLoc() : receiver->getEndLoc();
    BegLoc = PP.getLocForEndOfToken(BegLoc);
    SourceLocation EndLoc = Msg->getSelectorLoc(0);
    SourceRange SpaceRange(BegLoc, EndLoc);
    std::string PropertyDotString;
    // rewrite getter method expression into: receiver.property or
    // (receiver).property
    if (NeedsParen) {
      commit.insertBefore(receiver->getBeginLoc(), "(");
      PropertyDotString = ").";
    }
    else
      PropertyDotString = ".";
    PropertyDotString += Prop->getName();
    commit.replace(SpaceRange, PropertyDotString);

    // remove '[' ']'
    commit.replace(SourceRange(MsgRange.getBegin(), MsgRange.getBegin()), "");
    commit.replace(SourceRange(MsgRange.getEnd(), MsgRange.getEnd()), "");
  } else {
    if (NeedsParen)
      commit.insertWrap("(", receiver->getSourceRange(), ")");
    std::string PropertyDotString = ".";
    PropertyDotString += Prop->getName();
    PropertyDotString += " =";
    const Expr*const* Args = Msg->getArgs();
    const Expr *RHS = Args[0];
    if (!RHS)
      return false;
    SourceLocation BegLoc =
        ReceiverIsSuper ? Msg->getSuperLoc() : receiver->getEndLoc();
    BegLoc = PP.getLocForEndOfToken(BegLoc);
    SourceLocation EndLoc = RHS->getBeginLoc();
    EndLoc = EndLoc.getLocWithOffset(-1);
    const char *colon = PP.getSourceManager().getCharacterData(EndLoc);
    // Add a space after '=' if there is no space between RHS and '='
    if (colon && colon[0] == ':')
      PropertyDotString += " ";
    SourceRange Range(BegLoc, EndLoc);
    commit.replace(Range, PropertyDotString);
    // remove '[' ']'
    commit.replace(SourceRange(MsgRange.getBegin(), MsgRange.getBegin()), "");
    commit.replace(SourceRange(MsgRange.getEnd(), MsgRange.getEnd()), "");
  }
  return true;
}

314class ObjCMigrator : public RecursiveASTVisitor<ObjCMigrator> {
ObjCMigrateASTConsumer &Consumer;
ParentMap &PMap;

318public:
ObjCMigrator(ObjCMigrateASTConsumer &consumer, ParentMap &PMap)
  : Consumer(consumer), PMap(PMap) { }

bool shouldVisitTemplateInstantiations() const { return false; }
bool shouldWalkTypesOfTypeLocs() const { return false; }

bool VisitObjCMessageExpr(ObjCMessageExpr *E) {
  if (Consumer.ASTMigrateActions & FrontendOptions::ObjCMT_Literals) {
    edit::Commit commit(*Consumer.Editor);
    edit::rewriteToObjCLiteralSyntax(E, *Consumer.NSAPIObj, commit, &PMap);
    Consumer.Editor->commit(commit);
  }

  if (Consumer.ASTMigrateActions & FrontendOptions::ObjCMT_Subscripting) {
    edit::Commit commit(*Consumer.Editor);
    edit::rewriteToObjCSubscriptSyntax(E, *Consumer.NSAPIObj, commit);
    Consumer.Editor->commit(commit);
  }

  if (Consumer.ASTMigrateActions & FrontendOptions::ObjCMT_PropertyDotSyntax) {
    edit::Commit commit(*Consumer.Editor);
    rewriteToPropertyDotSyntax(E, Consumer.PP, *Consumer.NSAPIObj,
                               commit, &PMap);
    Consumer.Editor->commit(commit);
  }

  return true;
}

bool TraverseObjCMessageExpr(ObjCMessageExpr *E) {
  // Do depth first; we want to rewrite the subexpressions first so that if
  // we have to move expressions we will move them already rewritten.
  for (Stmt *SubStmt : E->children())
    if (!TraverseStmt(SubStmt))
      return false;

  return WalkUpFromObjCMessageExpr(E);
}
357};

359class BodyMigrator : public RecursiveASTVisitor<BodyMigrator> {
ObjCMigrateASTConsumer &Consumer;
std::unique_ptr<ParentMap> PMap;

363public:
BodyMigrator(ObjCMigrateASTConsumer &consumer) : Consumer(consumer) { }

bool shouldVisitTemplateInstantiations() const { return false; }
bool shouldWalkTypesOfTypeLocs() const { return false; }

bool TraverseStmt(Stmt *S) {
  PMap.reset(new ParentMap(S));
  ObjCMigrator(Consumer, *PMap).TraverseStmt(S);
  return true;
}
374};
375} // end anonymous namespace

377void ObjCMigrateASTConsumer::migrateDecl(Decl *D) {
if (!D)
  return;
if (isa<ObjCMethodDecl>(D))
  return; // Wait for the ObjC container declaration.

BodyMigrator(*this).TraverseDecl(D);
384}

386static void append_attr(std::string &PropertyString, const char *attr,
                      bool &LParenAdded) {
if (!LParenAdded) {
  PropertyString += "(";
  LParenAdded = true;
}
else
  PropertyString += ", ";
PropertyString += attr;
395}

397static
398void MigrateBlockOrFunctionPointerTypeVariable(std::string & PropertyString,
                                             const std::string& TypeString,
                                             const char *name) {
const char *argPtr = TypeString.c_str();
int paren = 0;
while (*argPtr) {
  switch (*argPtr) {
    case '(':
      PropertyString += *argPtr;
      paren++;
      break;
    case ')':
      PropertyString += *argPtr;
      paren--;
      break;
    case '^':
    case '*':
      PropertyString += (*argPtr);
      if (paren == 1) {
        PropertyString += name;
        name = "";
      }
      break;
    default:
      PropertyString += *argPtr;
      break;
  }
  argPtr++;
}
427}

429static const char *PropertyMemoryAttribute(ASTContext &Context, QualType ArgType) {
Qualifiers::ObjCLifetime propertyLifetime = ArgType.getObjCLifetime();
bool RetainableObject = ArgType->isObjCRetainableType();
if (RetainableObject &&
    (propertyLifetime == Qualifiers::OCL_Strong
     || propertyLifetime == Qualifiers::OCL_None)) {
  if (const ObjCObjectPointerType *ObjPtrTy =
      ArgType->getAs<ObjCObjectPointerType>()) {
    ObjCInterfaceDecl *IDecl = ObjPtrTy->getObjectType()->getInterface();
    if (IDecl &&
        IDecl->lookupNestedProtocol(&Context.Idents.get("NSCopying")))
      return "copy";
    else
      return "strong";
  }
  else if (ArgType->isBlockPointerType())
    return "copy";
} else if (propertyLifetime == Qualifiers::OCL_Weak)
  // TODO. More precise determination of 'weak' attribute requires
  // looking into setter's implementation for backing weak ivar.
  return "weak";
else if (RetainableObject)
  return ArgType->isBlockPointerType() ? "copy" : "strong";
return nullptr;
453}

455static void rewriteToObjCProperty(const ObjCMethodDecl *Getter,
                                const ObjCMethodDecl *Setter,
                                const NSAPI &NS, edit::Commit &commit,
                                unsigned LengthOfPrefix,
                                bool Atomic, bool UseNsIosOnlyMacro,
                                bool AvailabilityArgsMatch) {
ASTContext &Context = NS.getASTContext();
bool LParenAdded = false;
std::string PropertyString = "@property ";
if (UseNsIosOnlyMacro && NS.isMacroDefined("NS_NONATOMIC_IOSONLY")) {
  PropertyString += "(NS_NONATOMIC_IOSONLY";
  LParenAdded = true;
} else if (!Atomic) {
  PropertyString += "(nonatomic";
  LParenAdded = true;
}

std::string PropertyNameString = Getter->getNameAsString();
StringRef PropertyName(PropertyNameString);
if (LengthOfPrefix > 0) {
  if (!LParenAdded) {
    PropertyString += "(getter=";
    LParenAdded = true;
  }
  else
    PropertyString += ", getter=";
  PropertyString += PropertyNameString;
}
// Property with no setter may be suggested as a 'readonly' property.
if (!Setter)
  append_attr(PropertyString, "readonly", LParenAdded);


// Short circuit 'delegate' properties that contain the name "delegate" or
// "dataSource", or have exact name "target" to have 'assign' attribute.
if (PropertyName.equals("target") ||
    (PropertyName.find("delegate") != StringRef::npos) ||
    (PropertyName.find("dataSource") != StringRef::npos)) {
  QualType QT = Getter->getReturnType();
  if (!QT->isRealType())
    append_attr(PropertyString, "assign", LParenAdded);
} else if (!Setter) {
  QualType ResType = Context.getCanonicalType(Getter->getReturnType());
  if (const char *MemoryManagementAttr = PropertyMemoryAttribute(Context, ResType))
    append_attr(PropertyString, MemoryManagementAttr, LParenAdded);
} else {
  const ParmVarDecl *argDecl = *Setter->param_begin();
  QualType ArgType = Context.getCanonicalType(argDecl->getType());
  if (const char *MemoryManagementAttr = PropertyMemoryAttribute(Context, ArgType))
    append_attr(PropertyString, MemoryManagementAttr, LParenAdded);
}
if (LParenAdded)
  PropertyString += ')';
QualType RT = Getter->getReturnType();
if (!isa<TypedefType>(RT)) {
  // strip off any ARC lifetime qualifier.
  QualType CanResultTy = Context.getCanonicalType(RT);
  if (CanResultTy.getQualifiers().hasObjCLifetime()) {
    Qualifiers Qs = CanResultTy.getQualifiers();
    Qs.removeObjCLifetime();
    RT = Context.getQualifiedType(CanResultTy.getUnqualifiedType(), Qs);
  }
}
PropertyString += " ";
PrintingPolicy SubPolicy(Context.getPrintingPolicy());
SubPolicy.SuppressStrongLifetime = true;
SubPolicy.SuppressLifetimeQualifiers = true;
std::string TypeString = RT.getAsString(SubPolicy);
if (LengthOfPrefix > 0) {
  // property name must strip off "is" and lower case the first character
  // after that; e.g. isContinuous will become continuous.
  StringRef PropertyNameStringRef(PropertyNameString);
  PropertyNameStringRef = PropertyNameStringRef.drop_front(LengthOfPrefix);
  PropertyNameString = std::string(PropertyNameStringRef);
  bool NoLowering = (isUppercase(PropertyNameString[0]) &&
                     PropertyNameString.size() > 1 &&
                     isUppercase(PropertyNameString[1]));
  if (!NoLowering)
    PropertyNameString[0] = toLowercase(PropertyNameString[0]);
}
if (RT->isBlockPointerType() || RT->isFunctionPointerType())
  MigrateBlockOrFunctionPointerTypeVariable(PropertyString,
                                            TypeString,
                                            PropertyNameString.c_str());
else {
  char LastChar = TypeString[TypeString.size()-1];
  PropertyString += TypeString;
  if (LastChar != '*')
    PropertyString += ' ';
  PropertyString += PropertyNameString;
}
SourceLocation StartGetterSelectorLoc = Getter->getSelectorStartLoc();
Selector GetterSelector = Getter->getSelector();

SourceLocation EndGetterSelectorLoc =
  StartGetterSelectorLoc.getLocWithOffset(GetterSelector.getNameForSlot(0).size());
commit.replace(CharSourceRange::getCharRange(Getter->getBeginLoc(),
                                             EndGetterSelectorLoc),
               PropertyString);
if (Setter && AvailabilityArgsMatch) {
  SourceLocation EndLoc = Setter->getDeclaratorEndLoc();
  // Get location past ';'
  EndLoc = EndLoc.getLocWithOffset(1);
  SourceLocation BeginOfSetterDclLoc = Setter->getBeginLoc();
  // FIXME. This assumes that setter decl; is immediately preceded by eoln.
  // It is trying to remove the setter method decl. line entirely.
  BeginOfSetterDclLoc = BeginOfSetterDclLoc.getLocWithOffset(-1);
  commit.remove(SourceRange(BeginOfSetterDclLoc, EndLoc));
}
564}

566static bool IsCategoryNameWithDeprecatedSuffix(ObjCContainerDecl *D) {
if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(D)) {
  StringRef Name = CatDecl->getName();
  return Name.endswith("Deprecated");
}
return false;
572}

574void ObjCMigrateASTConsumer::migrateObjCContainerDecl(ASTContext &Ctx,
                                                    ObjCContainerDecl *D) {
if (D->isDeprecated() || IsCategoryNameWithDeprecatedSuffix(D))
  return;

for (auto *Method : D->methods()) {
  if (Method->isDeprecated())
    continue;
  bool PropertyInferred = migrateProperty(Ctx, D, Method);
  // If a property is inferred, do not attempt to attach NS_RETURNS_INNER_POINTER to
  // the getter method as it ends up on the property itself which we don't want
  // to do unless -objcmt-returns-innerpointer-property  option is on.
  if (!PropertyInferred ||
      (ASTMigrateActions & FrontendOptions::ObjCMT_ReturnsInnerPointerProperty))
    if (ASTMigrateActions & FrontendOptions::ObjCMT_Annotation)
      migrateNsReturnsInnerPointer(Ctx, Method);
}
if (!(ASTMigrateActions & FrontendOptions::ObjCMT_ReturnsInnerPointerProperty))
  return;

for (auto *Prop : D->instance_properties()) {
  if ((ASTMigrateActions & FrontendOptions::ObjCMT_Annotation) &&
      !Prop->isDeprecated())
    migratePropertyNsReturnsInnerPointer(Ctx, Prop);
}
599}

601static bool
602ClassImplementsAllMethodsAndProperties(ASTContext &Ctx,
                                    const ObjCImplementationDecl *ImpDecl,
                                     const ObjCInterfaceDecl *IDecl,
                                    ObjCProtocolDecl *Protocol) {
// In auto-synthesis, protocol properties are not synthesized. So,
// a conforming protocol must have its required properties declared
// in class interface.
bool HasAtleastOneRequiredProperty = false;
if (const ObjCProtocolDecl *PDecl = Protocol->getDefinition())
  for (const auto *Property : PDecl->instance_properties()) {
    if (Property->getPropertyImplementation() == ObjCPropertyDecl::Optional)
      continue;
    HasAtleastOneRequiredProperty = true;
    DeclContext::lookup_result R = IDecl->lookup(Property->getDeclName());
    if (R.empty()) {
      // Relax the rule and look into class's implementation for a synthesize
      // or dynamic declaration. Class is implementing a property coming from
      // another protocol. This still makes the target protocol as conforming.
      if (!ImpDecl->FindPropertyImplDecl(
                                Property->getDeclName().getAsIdentifierInfo(),
                                Property->getQueryKind()))
        return false;
    } else if (auto *ClassProperty = R.find_first<ObjCPropertyDecl>()) {
      if ((ClassProperty->getPropertyAttributes() !=
           Property->getPropertyAttributes()) ||
          !Ctx.hasSameType(ClassProperty->getType(), Property->getType()))
        return false;
    } else
      return false;
  }

// At this point, all required properties in this protocol conform to those
// declared in the class.
// Check that class implements the required methods of the protocol too.
bool HasAtleastOneRequiredMethod = false;
if (const ObjCProtocolDecl *PDecl = Protocol->getDefinition()) {
  if (PDecl->meth_begin() == PDecl->meth_end())
    return HasAtleastOneRequiredProperty;
  for (const auto *MD : PDecl->methods()) {
    if (MD->isImplicit())
      continue;
    if (MD->getImplementationControl() == ObjCMethodDecl::Optional)
      continue;
    DeclContext::lookup_result R = ImpDecl->lookup(MD->getDeclName());
    if (R.empty())
      return false;
    bool match = false;
    HasAtleastOneRequiredMethod = true;
    for (NamedDecl *ND : R)
      if (ObjCMethodDecl *ImpMD = dyn_cast<ObjCMethodDecl>(ND))
        if (Ctx.ObjCMethodsAreEqual(MD, ImpMD)) {
          match = true;
          break;
        }
    if (!match)
      return false;
  }
}
return HasAtleastOneRequiredProperty || HasAtleastOneRequiredMethod;
661}

663static bool rewriteToObjCInterfaceDecl(const ObjCInterfaceDecl *IDecl,
                  llvm::SmallVectorImpl<ObjCProtocolDecl*> &ConformingProtocols,
                  const NSAPI &NS, edit::Commit &commit) {
const ObjCList<ObjCProtocolDecl> &Protocols = IDecl->getReferencedProtocols();
std::string ClassString;
SourceLocation EndLoc =
IDecl->getSuperClass() ? IDecl->getSuperClassLoc() : IDecl->getLocation();

if (Protocols.empty()) {
  ClassString = '<';
  for (unsigned i = 0, e = ConformingProtocols.size(); i != e; i++) {
    ClassString += ConformingProtocols[i]->getNameAsString();
    if (i != (e-1))
      ClassString += ", ";
  }
  ClassString += "> ";
}
else {
  ClassString = ", ";
  for (unsigned i = 0, e = ConformingProtocols.size(); i != e; i++) {
    ClassString += ConformingProtocols[i]->getNameAsString();
    if (i != (e-1))
      ClassString += ", ";
  }
  ObjCInterfaceDecl::protocol_loc_iterator PL = IDecl->protocol_loc_end() - 1;
  EndLoc = *PL;
}

commit.insertAfterToken(EndLoc, ClassString);
return true;
693}

695static StringRef GetUnsignedName(StringRef NSIntegerName) {
StringRef UnsignedName = llvm::StringSwitch<StringRef>(NSIntegerName)
  .Case("int8_t", "uint8_t")
  .Case("int16_t", "uint16_t")
  .Case("int32_t", "uint32_t")
  .Case("NSInteger", "NSUInteger")
  .Case("int64_t", "uint64_t")
  .Default(NSIntegerName);
return UnsignedName;
704}

706static bool rewriteToNSEnumDecl(const EnumDecl *EnumDcl,
                              const TypedefDecl *TypedefDcl,
                              const NSAPI &NS, edit::Commit &commit,
                              StringRef NSIntegerName,
                              bool NSOptions) {
std::string ClassString;
if (NSOptions) {
  ClassString = "typedef NS_OPTIONS(";
  ClassString += GetUnsignedName(NSIntegerName);
}
else {
  ClassString = "typedef NS_ENUM(";
  ClassString += NSIntegerName;
}
ClassString += ", ";

ClassString += TypedefDcl->getIdentifier()->getName();
ClassString += ')';
SourceRange R(EnumDcl->getBeginLoc(), EnumDcl->getBeginLoc());
commit.replace(R, ClassString);
SourceLocation EndOfEnumDclLoc = EnumDcl->getEndLoc();
EndOfEnumDclLoc = trans::findSemiAfterLocation(EndOfEnumDclLoc,
                                               NS.getASTContext(), /*IsDecl*/true);
if (EndOfEnumDclLoc.isValid()) {
  SourceRange EnumDclRange(EnumDcl->getBeginLoc(), EndOfEnumDclLoc);
  commit.insertFromRange(TypedefDcl->getBeginLoc(), EnumDclRange);
}
else
  return false;

SourceLocation EndTypedefDclLoc = TypedefDcl->getEndLoc();
EndTypedefDclLoc = trans::findSemiAfterLocation(EndTypedefDclLoc,
                                               NS.getASTContext(), /*IsDecl*/true);
if (EndTypedefDclLoc.isValid()) {
  SourceRange TDRange(TypedefDcl->getBeginLoc(), EndTypedefDclLoc);
  commit.remove(TDRange);
}
else
  return false;

EndOfEnumDclLoc =
    trans::findLocationAfterSemi(EnumDcl->getEndLoc(), NS.getASTContext(),
                                 /*IsDecl*/ true);
if (EndOfEnumDclLoc.isValid()) {
  SourceLocation BeginOfEnumDclLoc = EnumDcl->getBeginLoc();
  // FIXME. This assumes that enum decl; is immediately preceded by eoln.
  // It is trying to remove the enum decl. lines entirely.
  BeginOfEnumDclLoc = BeginOfEnumDclLoc.getLocWithOffset(-1);
  commit.remove(SourceRange(BeginOfEnumDclLoc, EndOfEnumDclLoc));
  return true;
}
return false;
758}

760static void rewriteToNSMacroDecl(ASTContext &Ctx,
                               const EnumDecl *EnumDcl,
                              const TypedefDecl *TypedefDcl,
                              const NSAPI &NS, edit::Commit &commit,
                               bool IsNSIntegerType) {
QualType DesignatedEnumType = EnumDcl->getIntegerType();
assert(!DesignatedEnumType.isNull()(static_cast<void> (0))
       && "rewriteToNSMacroDecl - underlying enum type is null")(static_cast<void> (0));

PrintingPolicy Policy(Ctx.getPrintingPolicy());
std::string TypeString = DesignatedEnumType.getAsString(Policy);
std::string ClassString = IsNSIntegerType ? "NS_ENUM(" : "NS_OPTIONS(";
ClassString += TypeString;
ClassString += ", ";

ClassString += TypedefDcl->getIdentifier()->getName();
ClassString += ") ";
SourceLocation EndLoc = EnumDcl->getBraceRange().getBegin();
if (EndLoc.isInvalid())
  return;
CharSourceRange R =
    CharSourceRange::getCharRange(EnumDcl->getBeginLoc(), EndLoc);
commit.replace(R, ClassString);
// This is to remove spaces between '}' and typedef name.
SourceLocation StartTypedefLoc = EnumDcl->getEndLoc();
StartTypedefLoc = StartTypedefLoc.getLocWithOffset(+1);
SourceLocation EndTypedefLoc = TypedefDcl->getEndLoc();

commit.remove(SourceRange(StartTypedefLoc, EndTypedefLoc));
789}

791static bool UseNSOptionsMacro(Preprocessor &PP, ASTContext &Ctx,
                            const EnumDecl *EnumDcl) {
bool PowerOfTwo = true;
bool AllHexdecimalEnumerator = true;
uint64_t MaxPowerOfTwoVal = 0;
for (auto Enumerator : EnumDcl->enumerators()) {
  const Expr *InitExpr = Enumerator->getInitExpr();
  if (!InitExpr) {
    PowerOfTwo = false;
    AllHexdecimalEnumerator = false;
    continue;
  }
  InitExpr = InitExpr->IgnoreParenCasts();
  if (const BinaryOperator *BO = dyn_cast<BinaryOperator>(InitExpr))
    if (BO->isShiftOp() || BO->isBitwiseOp())
      return true;

  uint64_t EnumVal = Enumerator->getInitVal().getZExtValue();
  if (PowerOfTwo && EnumVal) {
    if (!llvm::isPowerOf2_64(EnumVal))
      PowerOfTwo = false;
    else if (EnumVal > MaxPowerOfTwoVal)
      MaxPowerOfTwoVal = EnumVal;
  }
  if (AllHexdecimalEnumerator && EnumVal) {
    bool FoundHexdecimalEnumerator = false;
    SourceLocation EndLoc = Enumerator->getEndLoc();
    Token Tok;
    if (!PP.getRawToken(EndLoc, Tok, /*IgnoreWhiteSpace=*/true))
      if (Tok.isLiteral() && Tok.getLength() > 2) {
        if (const char *StringLit = Tok.getLiteralData())
          FoundHexdecimalEnumerator =
            (StringLit[0] == '0' && (toLowercase(StringLit[1]) == 'x'));
      }
    if (!FoundHexdecimalEnumerator)
      AllHexdecimalEnumerator = false;
  }
}
return AllHexdecimalEnumerator || (PowerOfTwo && (MaxPowerOfTwoVal > 2));
830}

832void ObjCMigrateASTConsumer::migrateProtocolConformance(ASTContext &Ctx,
                                          const ObjCImplementationDecl *ImpDecl) {
const ObjCInterfaceDecl *IDecl = ImpDecl->getClassInterface();
if (!IDecl || ObjCProtocolDecls.empty() || IDecl->isDeprecated())
  return;
// Find all implicit conforming protocols for this class
// and make them explicit.
llvm::SmallPtrSet<ObjCProtocolDecl *, 8> ExplicitProtocols;
Ctx.CollectInheritedProtocols(IDecl, ExplicitProtocols);
llvm::SmallVector<ObjCProtocolDecl *, 8> PotentialImplicitProtocols;

for (ObjCProtocolDecl *ProtDecl : ObjCProtocolDecls)
  if (!ExplicitProtocols.count(ProtDecl))
    PotentialImplicitProtocols.push_back(ProtDecl);

if (PotentialImplicitProtocols.empty())
  return;

// go through list of non-optional methods and properties in each protocol
// in the PotentialImplicitProtocols list. If class implements every one of the
// methods and properties, then this class conforms to this protocol.
llvm::SmallVector<ObjCProtocolDecl*, 8> ConformingProtocols;
for (unsigned i = 0, e = PotentialImplicitProtocols.size(); i != e; i++)
  if (ClassImplementsAllMethodsAndProperties(Ctx, ImpDecl, IDecl,
                                            PotentialImplicitProtocols[i]))
    ConformingProtocols.push_back(PotentialImplicitProtocols[i]);

if (ConformingProtocols.empty())
  return;

// Further reduce number of conforming protocols. If protocol P1 is in the list
// protocol P2 (P2<P1>), No need to include P1.
llvm::SmallVector<ObjCProtocolDecl*, 8> MinimalConformingProtocols;
for (unsigned i = 0, e = ConformingProtocols.size(); i != e; i++) {
  bool DropIt = false;
  ObjCProtocolDecl *TargetPDecl = ConformingProtocols[i];
  for (unsigned i1 = 0, e1 = ConformingProtocols.size(); i1 != e1; i1++) {
    ObjCProtocolDecl *PDecl = ConformingProtocols[i1];
    if (PDecl == TargetPDecl)
      continue;
    if (PDecl->lookupProtocolNamed(
          TargetPDecl->getDeclName().getAsIdentifierInfo())) {
      DropIt = true;
      break;
    }
  }
  if (!DropIt)
    MinimalConformingProtocols.push_back(TargetPDecl);
}
if (MinimalConformingProtocols.empty())
  return;
edit::Commit commit(*Editor);
rewriteToObjCInterfaceDecl(IDecl, MinimalConformingProtocols,
                           *NSAPIObj, commit);
Editor->commit(commit);
887}

889void ObjCMigrateASTConsumer::CacheObjCNSIntegerTypedefed(
                                        const TypedefDecl *TypedefDcl) {

QualType qt = TypedefDcl->getTypeSourceInfo()->getType();
if (NSAPIObj->isObjCNSIntegerType(qt))
  NSIntegerTypedefed = TypedefDcl;
else if (NSAPIObj->isObjCNSUIntegerType(qt))
  NSUIntegerTypedefed = TypedefDcl;
897}

899bool ObjCMigrateASTConsumer::migrateNSEnumDecl(ASTContext &Ctx,
                                         const EnumDecl *EnumDcl,
                                         const TypedefDecl *TypedefDcl) {
if (!EnumDcl->isCompleteDefinition() || EnumDcl->getIdentifier() ||
    EnumDcl->isDeprecated())
  return false;
if (!TypedefDcl) {
  if (NSIntegerTypedefed) {
    TypedefDcl = NSIntegerTypedefed;
    NSIntegerTypedefed = nullptr;
  }
  else if (NSUIntegerTypedefed) {
    TypedefDcl = NSUIntegerTypedefed;
    NSUIntegerTypedefed = nullptr;
  }
  else
    return false;
  FileID FileIdOfTypedefDcl =
    PP.getSourceManager().getFileID(TypedefDcl->getLocation());
  FileID FileIdOfEnumDcl =
    PP.getSourceManager().getFileID(EnumDcl->getLocation());
  if (FileIdOfTypedefDcl != FileIdOfEnumDcl)
    return false;
}
if (TypedefDcl->isDeprecated())
  return false;

QualType qt = TypedefDcl->getTypeSourceInfo()->getType();
StringRef NSIntegerName = NSAPIObj->GetNSIntegralKind(qt);

if (NSIntegerName.empty()) {
  // Also check for typedef enum {...} TD;
  if (const EnumType *EnumTy = qt->getAs<EnumType>()) {
    if (EnumTy->getDecl() == EnumDcl) {
      bool NSOptions = UseNSOptionsMacro(PP, Ctx, EnumDcl);
      if (!InsertFoundation(Ctx, TypedefDcl->getBeginLoc()))
        return false;
      edit::Commit commit(*Editor);
      rewriteToNSMacroDecl(Ctx, EnumDcl, TypedefDcl, *NSAPIObj, commit, !NSOptions);
      Editor->commit(commit);
      return true;
    }
  }
  return false;
}

// We may still use NS_OPTIONS based on what we find in the enumertor list.
bool NSOptions = UseNSOptionsMacro(PP, Ctx, EnumDcl);
if (!InsertFoundation(Ctx, TypedefDcl->getBeginLoc()))
  return false;
edit::Commit commit(*Editor);
bool Res = rewriteToNSEnumDecl(EnumDcl, TypedefDcl, *NSAPIObj,
                               commit, NSIntegerName, NSOptions);
Editor->commit(commit);
return Res;
954}

956static void ReplaceWithInstancetype(ASTContext &Ctx,
                                  const ObjCMigrateASTConsumer &ASTC,
                                  ObjCMethodDecl *OM) {
if (OM->getReturnType() == Ctx.getObjCInstanceType())
  return; // already has instancetype.

SourceRange R;
std::string ClassString;
if (TypeSourceInfo *TSInfo = OM->getReturnTypeSourceInfo()) {
  TypeLoc TL = TSInfo->getTypeLoc();
  R = SourceRange(TL.getBeginLoc(), TL.getEndLoc());
  ClassString = "instancetype";
}
else {
  R = SourceRange(OM->getBeginLoc(), OM->getBeginLoc());
  ClassString = OM->isInstanceMethod() ? '-' : '+';
  ClassString += " (instancetype)";
}
edit::Commit commit(*ASTC.Editor);
commit.replace(R, ClassString);
ASTC.Editor->commit(commit);
977}

979static void ReplaceWithClasstype(const ObjCMigrateASTConsumer &ASTC,
                                  ObjCMethodDecl *OM) {
ObjCInterfaceDecl *IDecl = OM->getClassInterface();
SourceRange R;
std::string ClassString;
if (TypeSourceInfo *TSInfo = OM->getReturnTypeSourceInfo()) {
  TypeLoc TL = TSInfo->getTypeLoc();
  R = SourceRange(TL.getBeginLoc(), TL.getEndLoc()); {
    ClassString = std::string(IDecl->getName());
    ClassString += "*";
  }
}
else {
  R = SourceRange(OM->getBeginLoc(), OM->getBeginLoc());
  ClassString = "+ (";
  ClassString += IDecl->getName(); ClassString += "*)";
}
edit::Commit commit(*ASTC.Editor);
commit.replace(R, ClassString);
ASTC.Editor->commit(commit);
999}

1001void ObjCMigrateASTConsumer::migrateMethodInstanceType(ASTContext &Ctx,
                                                     ObjCContainerDecl *CDecl,
                                                     ObjCMethodDecl *OM) {
ObjCInstanceTypeFamily OIT_Family =
  Selector::getInstTypeMethodFamily(OM->getSelector());

std::string ClassName;
switch (OIT_Family) {
  case OIT_None:
    migrateFactoryMethod(Ctx, CDecl, OM);
    return;
  case OIT_Array:
    ClassName = "NSArray";
    break;
  case OIT_Dictionary:
    ClassName = "NSDictionary";
    break;
  case OIT_Singleton:
    migrateFactoryMethod(Ctx, CDecl, OM, OIT_Singleton);
    return;
  case OIT_Init:
    if (OM->getReturnType()->isObjCIdType())
      ReplaceWithInstancetype(Ctx, *this, OM);
    return;
  case OIT_ReturnsSelf:
    migrateFactoryMethod(Ctx, CDecl, OM, OIT_ReturnsSelf);
    return;
}
if (!OM->getReturnType()->isObjCIdType())
  return;

ObjCInterfaceDecl *IDecl = dyn_cast<ObjCInterfaceDecl>(CDecl);
if (!IDecl) {
  if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(CDecl))
    IDecl = CatDecl->getClassInterface();
  else if (ObjCImplDecl *ImpDecl = dyn_cast<ObjCImplDecl>(CDecl))
    IDecl = ImpDecl->getClassInterface();
}
if (!IDecl ||
    !IDecl->lookupInheritedClass(&Ctx.Idents.get(ClassName))) {
  migrateFactoryMethod(Ctx, CDecl, OM);
  return;
}
ReplaceWithInstancetype(Ctx, *this, OM);
1045}

1047static bool TypeIsInnerPointer(QualType T) {
if (!T->isAnyPointerType())
  return false;
if (T->isObjCObjectPointerType() || T->isObjCBuiltinType() ||
    T->isBlockPointerType() || T->isFunctionPointerType() ||
    ento::coreFoundation::isCFObjectRef(T))
  return false;
// Also, typedef-of-pointer-to-incomplete-struct is something that we assume
// is not an innter pointer type.
QualType OrigT = T;
while (const TypedefType *TD = dyn_cast<TypedefType>(T.getTypePtr()))
  T = TD->getDecl()->getUnderlyingType();
if (OrigT == T || !T->isPointerType())
  return true;
const PointerType* PT = T->getAs<PointerType>();
QualType UPointeeT = PT->getPointeeType().getUnqualifiedType();
if (UPointeeT->isRecordType()) {
  const RecordType *RecordTy = UPointeeT->getAs<RecordType>();
  if (!RecordTy->getDecl()->isCompleteDefinition())
    return false;
}
return true;
1069}

1071/// Check whether the two versions match.
1072static bool versionsMatch(const VersionTuple &X, const VersionTuple &Y) {
return (X == Y);
1074}

1076/// AvailabilityAttrsMatch - This routine checks that if comparing two
1077/// availability attributes, all their components match. It returns
1078/// true, if not dealing with availability or when all components of
1079/// availability attributes match. This routine is only called when
1080/// the attributes are of the same kind.
1081static bool AvailabilityAttrsMatch(Attr *At1, Attr *At2) {
const AvailabilityAttr *AA1 = dyn_cast<AvailabilityAttr>(At1);
if (!AA1)
  return true;
const AvailabilityAttr *AA2 = cast<AvailabilityAttr>(At2);

VersionTuple Introduced1 = AA1->getIntroduced();
VersionTuple Deprecated1 = AA1->getDeprecated();
VersionTuple Obsoleted1 = AA1->getObsoleted();
bool IsUnavailable1 = AA1->getUnavailable();
VersionTuple Introduced2 = AA2->getIntroduced();
VersionTuple Deprecated2 = AA2->getDeprecated();
VersionTuple Obsoleted2 = AA2->getObsoleted();
bool IsUnavailable2 = AA2->getUnavailable();
return (versionsMatch(Introduced1, Introduced2) &&
        versionsMatch(Deprecated1, Deprecated2) &&
        versionsMatch(Obsoleted1, Obsoleted2) &&
        IsUnavailable1 == IsUnavailable2);
1099}

1101static bool MatchTwoAttributeLists(const AttrVec &Attrs1, const AttrVec &Attrs2,
                                 bool &AvailabilityArgsMatch) {
// This list is very small, so this need not be optimized.
for (unsigned i = 0, e = Attrs1.size(); i != e; i++) {
  bool match = false;
  for (unsigned j = 0, f = Attrs2.size(); j != f; j++) {
    // Matching attribute kind only. Except for Availability attributes,
    // we are not getting into details of the attributes. For all practical purposes
    // this is sufficient.
    if (Attrs1[i]->getKind() == Attrs2[j]->getKind()) {
      if (AvailabilityArgsMatch)
        AvailabilityArgsMatch = AvailabilityAttrsMatch(Attrs1[i], Attrs2[j]);
      match = true;
      break;
    }
  }
  if (!match)
    return false;
}
return true;
1121}

1123/// AttributesMatch - This routine checks list of attributes for two
1124/// decls. It returns false, if there is a mismatch in kind of
1125/// attributes seen in the decls. It returns true if the two decls
1126/// have list of same kind of attributes. Furthermore, when there
1127/// are availability attributes in the two decls, it sets the
1128/// AvailabilityArgsMatch to false if availability attributes have
1129/// different versions, etc.
1130static bool AttributesMatch(const Decl *Decl1, const Decl *Decl2,
                          bool &AvailabilityArgsMatch) {
if (!Decl1->hasAttrs() || !Decl2->hasAttrs()) {
  AvailabilityArgsMatch = (Decl1->hasAttrs() == Decl2->hasAttrs());
  return true;
}
AvailabilityArgsMatch = true;
const AttrVec &Attrs1 = Decl1->getAttrs();
const AttrVec &Attrs2 = Decl2->getAttrs();
bool match = MatchTwoAttributeLists(Attrs1, Attrs2, AvailabilityArgsMatch);
if (match && (Attrs2.size() > Attrs1.size()))
  return MatchTwoAttributeLists(Attrs2, Attrs1, AvailabilityArgsMatch);
return match;
1143}

1145static bool IsValidIdentifier(ASTContext &Ctx,
                            const char *Name) {
if (!isIdentifierHead(Name[0]))
  return false;
std::string NameString = Name;
NameString[0] = toLowercase(NameString[0]);
IdentifierInfo *II = &Ctx.Idents.get(NameString);
return II->getTokenID() ==  tok::identifier;
1153}

1155bool ObjCMigrateASTConsumer::migrateProperty(ASTContext &Ctx,
                           ObjCContainerDecl *D,
                           ObjCMethodDecl *Method) {
if (Method->isPropertyAccessor() || !Method->isInstanceMethod() ||
    Method->param_size() != 0)
  return false;
// Is this method candidate to be a getter?
QualType GRT = Method->getReturnType();
if (GRT->isVoidType())
  return false;

Selector GetterSelector = Method->getSelector();
ObjCInstanceTypeFamily OIT_Family =
  Selector::getInstTypeMethodFamily(GetterSelector);

if (OIT_Family != OIT_None)
  return false;

IdentifierInfo *getterName = GetterSelector.getIdentifierInfoForSlot(0);
Selector SetterSelector =
SelectorTable::constructSetterSelector(PP.getIdentifierTable(),
                                       PP.getSelectorTable(),
                                       getterName);
ObjCMethodDecl *SetterMethod = D->getInstanceMethod(SetterSelector);
unsigned LengthOfPrefix = 0;
if (!SetterMethod) {
  // try a different naming convention for getter: isXxxxx
  StringRef getterNameString = getterName->getName();
  bool IsPrefix = getterNameString.startswith("is");
  // Note that we don't want to change an isXXX method of retainable object
  // type to property (readonly or otherwise).
  if (IsPrefix && GRT->isObjCRetainableType())
    return false;
  if (IsPrefix || getterNameString.startswith("get")) {
    LengthOfPrefix = (IsPrefix ? 2 : 3);
    const char *CGetterName = getterNameString.data() + LengthOfPrefix;
    // Make sure that first character after "is" or "get" prefix can
    // start an identifier.
    if (!IsValidIdentifier(Ctx, CGetterName))
      return false;
    if (CGetterName[0] && isUppercase(CGetterName[0])) {
      getterName = &Ctx.Idents.get(CGetterName);
      SetterSelector =
      SelectorTable::constructSetterSelector(PP.getIdentifierTable(),
                                             PP.getSelectorTable(),
                                             getterName);
      SetterMethod = D->getInstanceMethod(SetterSelector);
    }
  }
}

if (SetterMethod) {
  if ((ASTMigrateActions & FrontendOptions::ObjCMT_ReadwriteProperty) == 0)
    return false;
  bool AvailabilityArgsMatch;
  if (SetterMethod->isDeprecated() ||
      !AttributesMatch(Method, SetterMethod, AvailabilityArgsMatch))
    return false;

  // Is this a valid setter, matching the target getter?
  QualType SRT = SetterMethod->getReturnType();
  if (!SRT->isVoidType())
    return false;
  const ParmVarDecl *argDecl = *SetterMethod->param_begin();
  QualType ArgType = argDecl->getType();
  if (!Ctx.hasSameUnqualifiedType(ArgType, GRT))
    return false;
  edit::Commit commit(*Editor);
  rewriteToObjCProperty(Method, SetterMethod, *NSAPIObj, commit,
                        LengthOfPrefix,
                        (ASTMigrateActions &
                         FrontendOptions::ObjCMT_AtomicProperty) != 0,
                        (ASTMigrateActions &
                         FrontendOptions::ObjCMT_NsAtomicIOSOnlyProperty) != 0,
                        AvailabilityArgsMatch);
  Editor->commit(commit);
  return true;
}
else if (ASTMigrateActions & FrontendOptions::ObjCMT_ReadonlyProperty) {
  // Try a non-void method with no argument (and no setter or property of same name
  // as a 'readonly' property.
  edit::Commit commit(*Editor);
  rewriteToObjCProperty(Method, nullptr /*SetterMethod*/, *NSAPIObj, commit,
                        LengthOfPrefix,
                        (ASTMigrateActions &
                         FrontendOptions::ObjCMT_AtomicProperty) != 0,
                        (ASTMigrateActions &
                         FrontendOptions::ObjCMT_NsAtomicIOSOnlyProperty) != 0,
                        /*AvailabilityArgsMatch*/false);
  Editor->commit(commit);
  return true;
}
return false;
1248}

1250void ObjCMigrateASTConsumer::migrateNsReturnsInnerPointer(ASTContext &Ctx,
                                                        ObjCMethodDecl *OM) {
if (OM->isImplicit() ||
    !OM->isInstanceMethod() ||
    OM->hasAttr<ObjCReturnsInnerPointerAttr>())
  return;

QualType RT = OM->getReturnType();
if (!TypeIsInnerPointer(RT) ||
    !NSAPIObj->isMacroDefined("NS_RETURNS_INNER_POINTER"))
  return;

edit::Commit commit(*Editor);
commit.insertBefore(OM->getEndLoc(), " NS_RETURNS_INNER_POINTER");
Editor->commit(commit);
1265}

1267void ObjCMigrateASTConsumer::migratePropertyNsReturnsInnerPointer(ASTContext &Ctx,
                                                                ObjCPropertyDecl *P) {
QualType T = P->getType();

if (!TypeIsInnerPointer(T) ||
    !NSAPIObj->isMacroDefined("NS_RETURNS_INNER_POINTER"))
  return;
edit::Commit commit(*Editor);
commit.insertBefore(P->getEndLoc(), " NS_RETURNS_INNER_POINTER ");
Editor->commit(commit);
1277}

1279void ObjCMigrateASTConsumer::migrateAllMethodInstaceType(ASTContext &Ctx,
                                               ObjCContainerDecl *CDecl) {
if (CDecl->isDeprecated() || IsCategoryNameWithDeprecatedSuffix(CDecl))
  return;

// migrate methods which can have instancetype as their result type.
for (auto *Method : CDecl->methods()) {
  if (Method->isDeprecated())
    continue;
  migrateMethodInstanceType(Ctx, CDecl, Method);
}
1290}

1292void ObjCMigrateASTConsumer::migrateFactoryMethod(ASTContext &Ctx,
                                                ObjCContainerDecl *CDecl,
                                                ObjCMethodDecl *OM,
                                                ObjCInstanceTypeFamily OIT_Family) {
if (OM->isInstanceMethod() ||
    OM->getReturnType() == Ctx.getObjCInstanceType() ||
    !OM->getReturnType()->isObjCIdType())
  return;

// Candidate factory methods are + (id) NaMeXXX : ... which belong to a class
// NSYYYNamE with matching names be at least 3 characters long.
ObjCInterfaceDecl *IDecl = dyn_cast<ObjCInterfaceDecl>(CDecl);
if (!IDecl) {
  if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(CDecl))
    IDecl = CatDecl->getClassInterface();
  else if (ObjCImplDecl *ImpDecl = dyn_cast<ObjCImplDecl>(CDecl))
    IDecl = ImpDecl->getClassInterface();
}
if (!IDecl)
  return;

std::string StringClassName = std::string(IDecl->getName());
StringRef LoweredClassName(StringClassName);
std::string StringLoweredClassName = LoweredClassName.lower();
LoweredClassName = StringLoweredClassName;

IdentifierInfo *MethodIdName = OM->getSelector().getIdentifierInfoForSlot(0);
// Handle method with no name at its first selector slot; e.g. + (id):(int)x.
if (!MethodIdName)
  return;

std::string MethodName = std::string(MethodIdName->getName());
if (OIT_Family == OIT_Singleton || OIT_Family == OIT_ReturnsSelf) {
  StringRef STRefMethodName(MethodName);
  size_t len = 0;
  if (STRefMethodName.startswith("standard"))
    len = strlen("standard");
  else if (STRefMethodName.startswith("shared"))
    len = strlen("shared");
  else if (STRefMethodName.startswith("default"))
    len = strlen("default");
  else
    return;
  MethodName = std::string(STRefMethodName.substr(len));
}
std::string MethodNameSubStr = MethodName.substr(0, 3);
StringRef MethodNamePrefix(MethodNameSubStr);
std::string StringLoweredMethodNamePrefix = MethodNamePrefix.lower();
MethodNamePrefix = StringLoweredMethodNamePrefix;
size_t Ix = LoweredClassName.rfind(MethodNamePrefix);
if (Ix == StringRef::npos)
  return;
std::string ClassNamePostfix = std::string(LoweredClassName.substr(Ix));
StringRef LoweredMethodName(MethodName);
std::string StringLoweredMethodName = LoweredMethodName.lower();
LoweredMethodName = StringLoweredMethodName;
if (!LoweredMethodName.startswith(ClassNamePostfix))
  return;
if (OIT_Family == OIT_ReturnsSelf)
  ReplaceWithClasstype(*this, OM);
else
  ReplaceWithInstancetype(Ctx, *this, OM);
1354}

1356static bool IsVoidStarType(QualType Ty) {
if (!Ty->isPointerType())
  return false;

while (const TypedefType *TD = dyn_cast<TypedefType>(Ty.getTypePtr()))
  Ty = TD->getDecl()->getUnderlyingType();

// Is the type void*?
const PointerType* PT = Ty->castAs<PointerType>();
if (PT->getPointeeType().getUnqualifiedType()->isVoidType())
  return true;
return IsVoidStarType(PT->getPointeeType());
1368}

1370/// AuditedType - This routine audits the type AT and returns false if it is one of known
1371/// CF object types or of the "void *" variety. It returns true if we don't care about the type
1372/// such as a non-pointer or pointers which have no ownership issues (such as "int *").
1373static bool AuditedType (QualType AT) {
if (!AT->isAnyPointerType() && !AT->isBlockPointerType())
  return true;
// FIXME. There isn't much we can say about CF pointer type; or is there?
if (ento::coreFoundation::isCFObjectRef(AT) ||
    IsVoidStarType(AT) ||
    // If an ObjC object is type, assuming that it is not a CF function and
    // that it is an un-audited function.
    AT->isObjCObjectPointerType() || AT->isObjCBuiltinType())
  return false;
// All other pointers are assumed audited as harmless.
return true;
1385}

1387void ObjCMigrateASTConsumer::AnnotateImplicitBridging(ASTContext &Ctx) {
if (CFFunctionIBCandidates.empty())
  return;
if (!NSAPIObj->isMacroDefined("CF_IMPLICIT_BRIDGING_ENABLED")) {
  CFFunctionIBCandidates.clear();
  FileId = FileID();
  return;
}
// Insert CF_IMPLICIT_BRIDGING_ENABLE/CF_IMPLICIT_BRIDGING_DISABLED
const Decl *FirstFD = CFFunctionIBCandidates[0];
const Decl *LastFD  =
  CFFunctionIBCandidates[CFFunctionIBCandidates.size()-1];
const char *PragmaString = "\nCF_IMPLICIT_BRIDGING_ENABLED\n\n";
edit::Commit commit(*Editor);
commit.insertBefore(FirstFD->getBeginLoc(), PragmaString);
PragmaString = "\n\nCF_IMPLICIT_BRIDGING_DISABLED\n";
SourceLocation EndLoc = LastFD->getEndLoc();
// get location just past end of function location.
EndLoc = PP.getLocForEndOfToken(EndLoc);
if (isa<FunctionDecl>(LastFD)) {
  // For Methods, EndLoc points to the ending semcolon. So,
  // not of these extra work is needed.
  Token Tok;
  // get locaiton of token that comes after end of function.
  bool Failed = PP.getRawToken(EndLoc, Tok, /*IgnoreWhiteSpace=*/true);
  if (!Failed)
    EndLoc = Tok.getLocation();
}
commit.insertAfterToken(EndLoc, PragmaString);
Editor->commit(commit);
FileId = FileID();
CFFunctionIBCandidates.clear();
1419}

1421void ObjCMigrateASTConsumer::migrateCFAnnotation(ASTContext &Ctx, const Decl *Decl) {
if (Decl->isDeprecated())
  return;

if (Decl->hasAttr<CFAuditedTransferAttr>()) {
  assert(CFFunctionIBCandidates.empty() &&(static_cast<void> (0))
         "Cannot have audited functions/methods inside user "(static_cast<void> (0))
         "provided CF_IMPLICIT_BRIDGING_ENABLE")(static_cast<void> (0));
  return;
}

// Finction must be annotated first.
if (const FunctionDecl *FuncDecl = dyn_cast<FunctionDecl>(Decl)) {
  CF_BRIDGING_KIND AuditKind = migrateAddFunctionAnnotation(Ctx, FuncDecl);
  if (AuditKind == CF_BRIDGING_ENABLE) {
    CFFunctionIBCandidates.push_back(Decl);
    if (FileId.isInvalid())
      FileId = PP.getSourceManager().getFileID(Decl->getLocation());
  }
  else if (AuditKind == CF_BRIDGING_MAY_INCLUDE) {
    if (!CFFunctionIBCandidates.empty()) {
      CFFunctionIBCandidates.push_back(Decl);
      if (FileId.isInvalid())
        FileId = PP.getSourceManager().getFileID(Decl->getLocation());
    }
  }
  else
    AnnotateImplicitBridging(Ctx);
}
else {
  migrateAddMethodAnnotation(Ctx, cast<ObjCMethodDecl>(Decl));
  AnnotateImplicitBridging(Ctx);
}
1454}

1456void ObjCMigrateASTConsumer::AddCFAnnotations(ASTContext &Ctx,
                                            const RetainSummary *RS,
                                            const FunctionDecl *FuncDecl,
                                            bool ResultAnnotated) {
// Annotate function.
if (!ResultAnnotated) {
  RetEffect Ret = RS->getRetEffect();
  const char *AnnotationString = nullptr;
  if (Ret.getObjKind() == ObjKind::CF) {
    if (Ret.isOwned() && NSAPIObj->isMacroDefined("CF_RETURNS_RETAINED"))
      AnnotationString = " CF_RETURNS_RETAINED";
    else if (Ret.notOwned() &&
             NSAPIObj->isMacroDefined("CF_RETURNS_NOT_RETAINED"))
      AnnotationString = " CF_RETURNS_NOT_RETAINED";
  }
  else if (Ret.getObjKind() == ObjKind::ObjC) {
    if (Ret.isOwned() && NSAPIObj->isMacroDefined("NS_RETURNS_RETAINED"))
      AnnotationString = " NS_RETURNS_RETAINED";
  }

  if (AnnotationString) {
    edit::Commit commit(*Editor);
    commit.insertAfterToken(FuncDecl->getEndLoc(), AnnotationString);
    Editor->commit(commit);
  }
}
unsigned i = 0;
for (FunctionDecl::param_const_iterator pi = FuncDecl->param_begin(),
     pe = FuncDecl->param_end(); pi != pe; ++pi, ++i) {
  const ParmVarDecl *pd = *pi;
  ArgEffect AE = RS->getArg(i);
  if (AE.getKind() == DecRef && AE.getObjKind() == ObjKind::CF &&
      !pd->hasAttr<CFConsumedAttr>() &&
      NSAPIObj->isMacroDefined("CF_CONSUMED")) {
    edit::Commit commit(*Editor);
    commit.insertBefore(pd->getLocation(), "CF_CONSUMED ");
    Editor->commit(commit);
  } else if (AE.getKind() == DecRef && AE.getObjKind() == ObjKind::ObjC &&
             !pd->hasAttr<NSConsumedAttr>() &&
             NSAPIObj->isMacroDefined("NS_CONSUMED")) {
    edit::Commit commit(*Editor);
    commit.insertBefore(pd->getLocation(), "NS_CONSUMED ");
    Editor->commit(commit);
  }
}
1501}

1503ObjCMigrateASTConsumer::CF_BRIDGING_KIND
ObjCMigrateASTConsumer::migrateAddFunctionAnnotation(
                                                ASTContext &Ctx,
                                                const FunctionDecl *FuncDecl) {
if (FuncDecl->hasBody())
  return CF_BRIDGING_NONE;

const RetainSummary *RS =
    getSummaryManager(Ctx).getSummary(AnyCall(FuncDecl));
bool FuncIsReturnAnnotated = (FuncDecl->hasAttr<CFReturnsRetainedAttr>() ||
                              FuncDecl->hasAttr<CFReturnsNotRetainedAttr>() ||
                              FuncDecl->hasAttr<NSReturnsRetainedAttr>() ||
                              FuncDecl->hasAttr<NSReturnsNotRetainedAttr>() ||
                              FuncDecl->hasAttr<NSReturnsAutoreleasedAttr>());

// Trivial case of when function is annotated and has no argument.
if (FuncIsReturnAnnotated && FuncDecl->getNumParams() == 0)
  return CF_BRIDGING_NONE;

bool ReturnCFAudited = false;
if (!FuncIsReturnAnnotated) {
  RetEffect Ret = RS->getRetEffect();
  if (Ret.getObjKind() == ObjKind::CF &&
      (Ret.isOwned() || Ret.notOwned()))
    ReturnCFAudited = true;
  else if (!AuditedType(FuncDecl->getReturnType()))
    return CF_BRIDGING_NONE;
}

// At this point result type is audited for potential inclusion.
unsigned i = 0;
bool ArgCFAudited = false;
for (FunctionDecl::param_const_iterator pi = FuncDecl->param_begin(),
     pe = FuncDecl->param_end(); pi != pe; ++pi, ++i) {
  const ParmVarDecl *pd = *pi;
  ArgEffect AE = RS->getArg(i);
  if ((AE.getKind() == DecRef /*CFConsumed annotated*/ ||
       AE.getKind() == IncRef) && AE.getObjKind() == ObjKind::CF) {
    if (AE.getKind() == DecRef && !pd->hasAttr<CFConsumedAttr>())
      ArgCFAudited = true;
    else if (AE.getKind() == IncRef)
      ArgCFAudited = true;
  } else {
    QualType AT = pd->getType();
    if (!AuditedType(AT)) {
      AddCFAnnotations(Ctx, RS, FuncDecl, FuncIsReturnAnnotated);
      return CF_BRIDGING_NONE;
    }
  }
}
if (ReturnCFAudited || ArgCFAudited)
  return CF_BRIDGING_ENABLE;

return CF_BRIDGING_MAY_INCLUDE;
1557}

1559void ObjCMigrateASTConsumer::migrateARCSafeAnnotation(ASTContext &Ctx,
                                               ObjCContainerDecl *CDecl) {
if (!isa<ObjCInterfaceDecl>(CDecl) || CDecl->isDeprecated())
  return;

// migrate methods which can have instancetype as their result type.
for (const auto *Method : CDecl->methods())
  migrateCFAnnotation(Ctx, Method);
1567}

1569void ObjCMigrateASTConsumer::AddCFAnnotations(ASTContext &Ctx,
                                            const RetainSummary *RS,
                                            const ObjCMethodDecl *MethodDecl,
                                            bool ResultAnnotated) {
// Annotate function.
if (!ResultAnnotated) {
  RetEffect Ret = RS->getRetEffect();
  const char *AnnotationString = nullptr;
  if (Ret.getObjKind() == ObjKind::CF) {
    if (Ret.isOwned() && NSAPIObj->isMacroDefined("CF_RETURNS_RETAINED"))
      AnnotationString = " CF_RETURNS_RETAINED";
    else if (Ret.notOwned() &&
             NSAPIObj->isMacroDefined("CF_RETURNS_NOT_RETAINED"))
      AnnotationString = " CF_RETURNS_NOT_RETAINED";
  }
  else if (Ret.getObjKind() == ObjKind::ObjC) {
    ObjCMethodFamily OMF = MethodDecl->getMethodFamily();
    switch (OMF) {
      case clang::OMF_alloc:
      case clang::OMF_new:
      case clang::OMF_copy:
      case clang::OMF_init:
      case clang::OMF_mutableCopy:
        break;

      default:
        if (Ret.isOwned() && NSAPIObj->isMacroDefined("NS_RETURNS_RETAINED"))
          AnnotationString = " NS_RETURNS_RETAINED";
        break;
    }
  }

  if (AnnotationString) {
    edit::Commit commit(*Editor);
    commit.insertBefore(MethodDecl->getEndLoc(), AnnotationString);
    Editor->commit(commit);
  }
}
unsigned i = 0;
for (ObjCMethodDecl::param_const_iterator pi = MethodDecl->param_begin(),
     pe = MethodDecl->param_end(); pi != pe; ++pi, ++i) {
  const ParmVarDecl *pd = *pi;
  ArgEffect AE = RS->getArg(i);
  if (AE.getKind() == DecRef
      && AE.getObjKind() == ObjKind::CF
      && !pd->hasAttr<CFConsumedAttr>() &&
      NSAPIObj->isMacroDefined("CF_CONSUMED")) {
    edit::Commit commit(*Editor);
    commit.insertBefore(pd->getLocation(), "CF_CONSUMED ");
    Editor->commit(commit);
  }
}
1621}

1623void ObjCMigrateASTConsumer::migrateAddMethodAnnotation(
                                          ASTContext &Ctx,
                                          const ObjCMethodDecl *MethodDecl) {
if (MethodDecl->hasBody() || MethodDecl->isImplicit())
  return;

const RetainSummary *RS =
    getSummaryManager(Ctx).getSummary(AnyCall(MethodDecl));

bool MethodIsReturnAnnotated =
    (MethodDecl->hasAttr<CFReturnsRetainedAttr>() ||
     MethodDecl->hasAttr<CFReturnsNotRetainedAttr>() ||
     MethodDecl->hasAttr<NSReturnsRetainedAttr>() ||
     MethodDecl->hasAttr<NSReturnsNotRetainedAttr>() ||
     MethodDecl->hasAttr<NSReturnsAutoreleasedAttr>());

if (RS->getReceiverEffect().getKind() == DecRef &&
    !MethodDecl->hasAttr<NSConsumesSelfAttr>() &&
    MethodDecl->getMethodFamily() != OMF_init &&
    MethodDecl->getMethodFamily() != OMF_release &&
    NSAPIObj->isMacroDefined("NS_CONSUMES_SELF")) {
  edit::Commit commit(*Editor);
  commit.insertBefore(MethodDecl->getEndLoc(), " NS_CONSUMES_SELF");
  Editor->commit(commit);
}

// Trivial case of when function is annotated and has no argument.
if (MethodIsReturnAnnotated &&
    (MethodDecl->param_begin() == MethodDecl->param_end()))
  return;

if (!MethodIsReturnAnnotated) {
  RetEffect Ret = RS->getRetEffect();
  if ((Ret.getObjKind() == ObjKind::CF ||
       Ret.getObjKind() == ObjKind::ObjC) &&
      (Ret.isOwned() || Ret.notOwned())) {
    AddCFAnnotations(Ctx, RS, MethodDecl, false);
    return;
  } else if (!AuditedType(MethodDecl->getReturnType()))
    return;
}

// At this point result type is either annotated or audited.
unsigned i = 0;
for (ObjCMethodDecl::param_const_iterator pi = MethodDecl->param_begin(),
     pe = MethodDecl->param_end(); pi != pe; ++pi, ++i) {
  const ParmVarDecl *pd = *pi;
  ArgEffect AE = RS->getArg(i);
  if ((AE.getKind() == DecRef && !pd->hasAttr<CFConsumedAttr>()) ||
      AE.getKind() == IncRef || !AuditedType(pd->getType())) {
    AddCFAnnotations(Ctx, RS, MethodDecl, MethodIsReturnAnnotated);
    return;
  }
}
1677}

1679namespace {
1680class SuperInitChecker : public RecursiveASTVisitor<SuperInitChecker> {
1681public:
bool shouldVisitTemplateInstantiations() const { return false; }
bool shouldWalkTypesOfTypeLocs() const { return false; }

bool VisitObjCMessageExpr(ObjCMessageExpr *E) {
  if (E->getReceiverKind() == ObjCMessageExpr::SuperInstance) {
    if (E->getMethodFamily() == OMF_init)
      return false;
  }
  return true;
}
1692};
1693} // end anonymous namespace

1695static bool hasSuperInitCall(const ObjCMethodDecl *MD) {
return !SuperInitChecker().TraverseStmt(MD->getBody());
1697}

1699void ObjCMigrateASTConsumer::inferDesignatedInitializers(
  ASTContext &Ctx,
  const ObjCImplementationDecl *ImplD) {

const ObjCInterfaceDecl *IFace = ImplD->getClassInterface();
if (!IFace || IFace->hasDesignatedInitializers())
  return;
if (!NSAPIObj->isMacroDefined("NS_DESIGNATED_INITIALIZER"))
  return;

for (const auto *MD : ImplD->instance_methods()) {
  if (MD->isDeprecated() ||
      MD->getMethodFamily() != OMF_init ||
      MD->isDesignatedInitializerForTheInterface())
    continue;
  const ObjCMethodDecl *IFaceM = IFace->getMethod(MD->getSelector(),
                                                  /*isInstance=*/true);
  if (!IFaceM)
    continue;
  if (hasSuperInitCall(MD)) {
    edit::Commit commit(*Editor);
    commit.insert(IFaceM->getEndLoc(), " NS_DESIGNATED_INITIALIZER");
    Editor->commit(commit);
  }
}
1724}

1726bool ObjCMigrateASTConsumer::InsertFoundation(ASTContext &Ctx,
                                            SourceLocation  Loc) {
if (FoundationIncluded)
  return true;
if (Loc.isInvalid())
  return false;
auto *nsEnumId = &Ctx.Idents.get("NS_ENUM");
if (PP.getMacroDefinitionAtLoc(nsEnumId, Loc)) {
  FoundationIncluded = true;
  return true;
}
edit::Commit commit(*Editor);
if (Ctx.getLangOpts().Modules)
  commit.insert(Loc, "#ifndef NS_ENUM\n@import Foundation;\n#endif\n");
else
  commit.insert(Loc, "#ifndef NS_ENUM\n#import <Foundation/Foundation.h>\n#endif\n");
Editor->commit(commit);
FoundationIncluded = true;
return true;
1745}

1747namespace {

1749class RewritesReceiver : public edit::EditsReceiver {
Rewriter &Rewrite;

1752public:
RewritesReceiver(Rewriter &Rewrite) : Rewrite(Rewrite) { }

void insert(SourceLocation loc, StringRef text) override {
  Rewrite.InsertText(loc, text);
}
void replace(CharSourceRange range, StringRef text) override {
  Rewrite.ReplaceText(range.getBegin(), Rewrite.getRangeSize(range), text);
}
1761};

1763class JSONEditWriter : public edit::EditsReceiver {
SourceManager &SourceMgr;
llvm::raw_ostream &OS;

1767public:
JSONEditWriter(SourceManager &SM, llvm::raw_ostream &OS)
  : SourceMgr(SM), OS(OS) {
  OS << "[\n";
}
~JSONEditWriter() override { OS << "]\n"; }

1774private:
struct EntryWriter {
  SourceManager &SourceMgr;
  llvm::raw_ostream &OS;

  EntryWriter(SourceManager &SM, llvm::raw_ostream &OS)
    : SourceMgr(SM), OS(OS) {
    OS << " {\n";
  }
  ~EntryWriter() {
    OS << " },\n";
  }

  void writeLoc(SourceLocation Loc) {
    FileID FID;
    unsigned Offset;
    std::tie(FID, Offset) = SourceMgr.getDecomposedLoc(Loc);
    assert(FID.isValid())(static_cast<void> (0));
    SmallString<200> Path =
        StringRef(SourceMgr.getFileEntryForID(FID)->getName());
    llvm::sys::fs::make_absolute(Path);
    OS << "  \"file\": \"";
    OS.write_escaped(Path.str()) << "\",\n";
    OS << "  \"offset\": " << Offset << ",\n";
  }

  void writeRemove(CharSourceRange Range) {
    assert(Range.isCharRange())(static_cast<void> (0));
    std::pair<FileID, unsigned> Begin =
        SourceMgr.getDecomposedLoc(Range.getBegin());
    std::pair<FileID, unsigned> End =
        SourceMgr.getDecomposedLoc(Range.getEnd());
    assert(Begin.first == End.first)(static_cast<void> (0));
    assert(Begin.second <= End.second)(static_cast<void> (0));
    unsigned Length = End.second - Begin.second;

    OS << "  \"remove\": " << Length << ",\n";
  }

  void writeText(StringRef Text) {
    OS << "  \"text\": \"";
    OS.write_escaped(Text) << "\",\n";
  }
};

void insert(SourceLocation Loc, StringRef Text) override {
  EntryWriter Writer(SourceMgr, OS);
  Writer.writeLoc(Loc);
  Writer.writeText(Text);
}

void replace(CharSourceRange Range, StringRef Text) override {
  EntryWriter Writer(SourceMgr, OS);
  Writer.writeLoc(Range.getBegin());
  Writer.writeRemove(Range);
  Writer.writeText(Text);
}

void remove(CharSourceRange Range) override {
  EntryWriter Writer(SourceMgr, OS);
  Writer.writeLoc(Range.getBegin());
  Writer.writeRemove(Range);
}
1837};

1839} // end anonymous namespace

1841void ObjCMigrateASTConsumer::HandleTranslationUnit(ASTContext &Ctx) {

TranslationUnitDecl *TU = Ctx.getTranslationUnitDecl();
if (ASTMigrateActions & FrontendOptions::ObjCMT_MigrateDecls) {
1
Assuming the condition is false→
2
←
Taking false branch→
  for (DeclContext::decl_iterator D = TU->decls_begin(), DEnd = TU->decls_end();
       D != DEnd; ++D) {
    FileID FID = PP.getSourceManager().getFileID((*D)->getLocation());
    if (FID.isValid())
      if (FileId.isValid() && FileId != FID) {
        if (ASTMigrateActions & FrontendOptions::ObjCMT_Annotation)
          AnnotateImplicitBridging(Ctx);
      }

    if (ObjCInterfaceDecl *CDecl = dyn_cast<ObjCInterfaceDecl>(*D))
      if (canModify(CDecl))
        migrateObjCContainerDecl(Ctx, CDecl);
    if (ObjCCategoryDecl *CatDecl = dyn_cast<ObjCCategoryDecl>(*D)) {
      if (canModify(CatDecl))
        migrateObjCContainerDecl(Ctx, CatDecl);
    }
    else if (ObjCProtocolDecl *PDecl = dyn_cast<ObjCProtocolDecl>(*D)) {
      ObjCProtocolDecls.insert(PDecl->getCanonicalDecl());
      if (canModify(PDecl))
        migrateObjCContainerDecl(Ctx, PDecl);
    }
    else if (const ObjCImplementationDecl *ImpDecl =
             dyn_cast<ObjCImplementationDecl>(*D)) {
      if ((ASTMigrateActions & FrontendOptions::ObjCMT_ProtocolConformance) &&
          canModify(ImpDecl))
        migrateProtocolConformance(Ctx, ImpDecl);
    }
    else if (const EnumDecl *ED = dyn_cast<EnumDecl>(*D)) {
      if (!(ASTMigrateActions & FrontendOptions::ObjCMT_NsMacros))
        continue;
      if (!canModify(ED))
        continue;
      DeclContext::decl_iterator N = D;
      if (++N != DEnd) {
        const TypedefDecl *TD = dyn_cast<TypedefDecl>(*N);
        if (migrateNSEnumDecl(Ctx, ED, TD) && TD)
          D++;
      }
      else
        migrateNSEnumDecl(Ctx, ED, /*TypedefDecl */nullptr);
    }
    else if (const TypedefDecl *TD = dyn_cast<TypedefDecl>(*D)) {
      if (!(ASTMigrateActions & FrontendOptions::ObjCMT_NsMacros))
        continue;
      if (!canModify(TD))
        continue;
      DeclContext::decl_iterator N = D;
      if (++N == DEnd)
        continue;
      if (const EnumDecl *ED = dyn_cast<EnumDecl>(*N)) {
        if (canModify(ED)) {
          if (++N != DEnd)
            if (const TypedefDecl *TDF = dyn_cast<TypedefDecl>(*N)) {
              // prefer typedef-follows-enum to enum-follows-typedef pattern.
              if (migrateNSEnumDecl(Ctx, ED, TDF)) {
                ++D; ++D;
                CacheObjCNSIntegerTypedefed(TD);
                continue;
              }
            }
          if (migrateNSEnumDecl(Ctx, ED, TD)) {
            ++D;
            continue;
          }
        }
      }
      CacheObjCNSIntegerTypedefed(TD);
    }
    else if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(*D)) {
      if ((ASTMigrateActions & FrontendOptions::ObjCMT_Annotation) &&
          canModify(FD))
        migrateCFAnnotation(Ctx, FD);
    }

    if (ObjCContainerDecl *CDecl = dyn_cast<ObjCContainerDecl>(*D)) {
      bool CanModify = canModify(CDecl);
      // migrate methods which can have instancetype as their result type.
      if ((ASTMigrateActions & FrontendOptions::ObjCMT_Instancetype) &&
          CanModify)
        migrateAllMethodInstaceType(Ctx, CDecl);
      // annotate methods with CF annotations.
      if ((ASTMigrateActions & FrontendOptions::ObjCMT_Annotation) &&
          CanModify)
        migrateARCSafeAnnotation(Ctx, CDecl);
    }

    if (const ObjCImplementationDecl *
          ImplD = dyn_cast<ObjCImplementationDecl>(*D)) {
      if ((ASTMigrateActions & FrontendOptions::ObjCMT_DesignatedInitializer) &&
          canModify(ImplD))
        inferDesignatedInitializers(Ctx, ImplD);
    }
  }
  if (ASTMigrateActions & FrontendOptions::ObjCMT_Annotation)
    AnnotateImplicitBridging(Ctx);
}

if (IsOutputFile) {
3
←
Assuming field 'IsOutputFile' is false→
4
←
Taking false branch→
 std::error_code EC;
 llvm::raw_fd_ostream OS(MigrateDir, EC, llvm::sys::fs::OF_None);
 if (EC) {
    DiagnosticsEngine &Diags = Ctx.getDiagnostics();
    Diags.Report(Diags.getCustomDiagID(DiagnosticsEngine::Error, "%0"))
        << EC.message();
    return;
  }

 JSONEditWriter Writer(Ctx.getSourceManager(), OS);
 Editor->applyRewrites(Writer);
 return;
}

Rewriter rewriter(Ctx.getSourceManager(), Ctx.getLangOpts());
RewritesReceiver Rec(rewriter);
Editor->applyRewrites(Rec);

for (Rewriter::buffer_iterator
5
←
Loop condition is true.  Entering loop body→
      I = rewriter.buffer_begin(), E = rewriter.buffer_end(); I != E; ++I) {
  FileID FID = I->first;
  RewriteBuffer &buf = I->second;
  Optional<FileEntryRef> file = Ctx.getSourceManager().getFileEntryRefForID(FID);
6
←
Calling 'SourceManager::getFileEntryRefForID'→
17
←
Returning from 'SourceManager::getFileEntryRefForID'→
  assert(file)(static_cast<void> (0));
  SmallString<512> newText;
  llvm::raw_svector_ostream vecOS(newText);
  buf.write(vecOS);
  std::unique_ptr<llvm::MemoryBuffer> memBuf(
      llvm::MemoryBuffer::getMemBufferCopy(
          StringRef(newText.data(), newText.size()), file->getName()));
18
←
Calling 'FileEntryRef::getName'→
  SmallString<64> filePath(file->getName());
  FileMgr.FixupRelativePath(filePath);
  Remapper.remap(filePath.str(), std::move(memBuf));
}

if (IsOutputFile) {
  Remapper.flushToFile(MigrateDir, Ctx.getDiagnostics());
} else {
  Remapper.flushToDisk(MigrateDir, Ctx.getDiagnostics());
}
1983}

1985bool MigrateSourceAction::BeginInvocation(CompilerInstance &CI) {
CI.getDiagnostics().setIgnoreAllWarnings(true);
return true;
1988}

1990static std::vector<std::string> getWhiteListFilenames(StringRef DirPath) {
using namespace llvm::sys::fs;
using namespace llvm::sys::path;

std::vector<std::string> Filenames;
if (DirPath.empty() || !is_directory(DirPath))
  return Filenames;

std::error_code EC;
directory_iterator DI = directory_iterator(DirPath, EC);
directory_iterator DE;
for (; !EC && DI != DE; DI = DI.increment(EC)) {
  if (is_regular_file(DI->path()))
    Filenames.push_back(std::string(filename(DI->path())));
}

return Filenames;
2007}

2009std::unique_ptr<ASTConsumer>
2010MigrateSourceAction::CreateASTConsumer(CompilerInstance &CI, StringRef InFile) {
PPConditionalDirectiveRecord *
  PPRec = new PPConditionalDirectiveRecord(CI.getSourceManager());
unsigned ObjCMTAction = CI.getFrontendOpts().ObjCMTAction;
unsigned ObjCMTOpts = ObjCMTAction;
// These are companion flags, they do not enable transformations.
ObjCMTOpts &= ~(FrontendOptions::ObjCMT_AtomicProperty |
                FrontendOptions::ObjCMT_NsAtomicIOSOnlyProperty);
if (ObjCMTOpts == FrontendOptions::ObjCMT_None) {
  // If no specific option was given, enable literals+subscripting transforms
  // by default.
  ObjCMTAction |= FrontendOptions::ObjCMT_Literals |
                  FrontendOptions::ObjCMT_Subscripting;
}
CI.getPreprocessor().addPPCallbacks(std::unique_ptr<PPCallbacks>(PPRec));
std::vector<std::string> WhiteList =
  getWhiteListFilenames(CI.getFrontendOpts().ObjCMTWhiteListPath);
return std::make_unique<ObjCMigrateASTConsumer>(
    CI.getFrontendOpts().OutputFile, ObjCMTAction, Remapper,
    CI.getFileManager(), PPRec, CI.getPreprocessor(),
    /*isOutputFile=*/true, WhiteList);
2031}

2033namespace {
2034struct EditEntry {
Optional<FileEntryRef> File;
unsigned Offset = 0;
unsigned RemoveLen = 0;
std::string Text;
2039};
2040} // end anonymous namespace

2042namespace llvm {
2043template<> struct DenseMapInfo<EditEntry> {
static inline EditEntry getEmptyKey() {
  EditEntry Entry;
  Entry.Offset = unsigned(-1);
  return Entry;
}
static inline EditEntry getTombstoneKey() {
  EditEntry Entry;
  Entry.Offset = unsigned(-2);
  return Entry;
}
static unsigned getHashValue(const EditEntry& Val) {
  return (unsigned)llvm::hash_combine(Val.File, Val.Offset, Val.RemoveLen,
                                      Val.Text);
}
static bool isEqual(const EditEntry &LHS, const EditEntry &RHS) {
  return LHS.File == RHS.File &&
      LHS.Offset == RHS.Offset &&
      LHS.RemoveLen == RHS.RemoveLen &&
      LHS.Text == RHS.Text;
}
2064};
2065} // end namespace llvm

2067namespace {
2068class RemapFileParser {
FileManager &FileMgr;

2071public:
RemapFileParser(FileManager &FileMgr) : FileMgr(FileMgr) { }

bool parse(StringRef File, SmallVectorImpl<EditEntry> &Entries) {
  using namespace llvm::yaml;

  llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> FileBufOrErr =
      llvm::MemoryBuffer::getFile(File);
  if (!FileBufOrErr)
    return true;

  llvm::SourceMgr SM;
  Stream YAMLStream(FileBufOrErr.get()->getMemBufferRef(), SM);
  document_iterator I = YAMLStream.begin();
  if (I == YAMLStream.end())
    return true;
  Node *Root = I->getRoot();
  if (!Root)
    return true;

  SequenceNode *SeqNode = dyn_cast<SequenceNode>(Root);
  if (!SeqNode)
    return true;

  for (SequenceNode::iterator
         AI = SeqNode->begin(), AE = SeqNode->end(); AI != AE; ++AI) {
    MappingNode *MapNode = dyn_cast<MappingNode>(&*AI);
    if (!MapNode)
      continue;
    parseEdit(MapNode, Entries);
  }

  return false;
}

2106private:
void parseEdit(llvm::yaml::MappingNode *Node,
               SmallVectorImpl<EditEntry> &Entries) {
  using namespace llvm::yaml;
  EditEntry Entry;
  bool Ignore = false;

  for (MappingNode::iterator
         KVI = Node->begin(), KVE = Node->end(); KVI != KVE; ++KVI) {
    ScalarNode *KeyString = dyn_cast<ScalarNode>((*KVI).getKey());
    if (!KeyString)
      continue;
    SmallString<10> KeyStorage;
    StringRef Key = KeyString->getValue(KeyStorage);

    ScalarNode *ValueString = dyn_cast<ScalarNode>((*KVI).getValue());
    if (!ValueString)
      continue;
    SmallString<64> ValueStorage;
    StringRef Val = ValueString->getValue(ValueStorage);

    if (Key == "file") {
      if (auto File = FileMgr.getOptionalFileRef(Val))
        Entry.File = File;
      else
        Ignore = true;
    } else if (Key == "offset") {
      if (Val.getAsInteger(10, Entry.Offset))
        Ignore = true;
    } else if (Key == "remove") {
      if (Val.getAsInteger(10, Entry.RemoveLen))
        Ignore = true;
    } else if (Key == "text") {
      Entry.Text = std::string(Val);
    }
  }

  if (!Ignore)
    Entries.push_back(Entry);
}
2146};
2147} // end anonymous namespace

2149static bool reportDiag(const Twine &Err, DiagnosticsEngine &Diag) {
Diag.Report(Diag.getCustomDiagID(DiagnosticsEngine::Error, "%0"))
    << Err.str();
return true;
2153}

2155static std::string applyEditsToTemp(FileEntryRef FE,
                                  ArrayRef<EditEntry> Edits,
                                  FileManager &FileMgr,
                                  DiagnosticsEngine &Diag) {
using namespace llvm::sys;

SourceManager SM(Diag, FileMgr);
FileID FID = SM.createFileID(FE, SourceLocation(), SrcMgr::C_User);
LangOptions LangOpts;
edit::EditedSource Editor(SM, LangOpts);
for (ArrayRef<EditEntry>::iterator
      I = Edits.begin(), E = Edits.end(); I != E; ++I) {
  const EditEntry &Entry = *I;
  assert(Entry.File == FE)(static_cast<void> (0));
  SourceLocation Loc =
      SM.getLocForStartOfFile(FID).getLocWithOffset(Entry.Offset);
  CharSourceRange Range;
  if (Entry.RemoveLen != 0) {
    Range = CharSourceRange::getCharRange(Loc,
                                       Loc.getLocWithOffset(Entry.RemoveLen));
  }

  edit::Commit commit(Editor);
  if (Range.isInvalid()) {
    commit.insert(Loc, Entry.Text);
  } else if (Entry.Text.empty()) {
    commit.remove(Range);
  } else {
    commit.replace(Range, Entry.Text);
  }
  Editor.commit(commit);
}

Rewriter rewriter(SM, LangOpts);
RewritesReceiver Rec(rewriter);
Editor.applyRewrites(Rec, /*adjustRemovals=*/false);

const RewriteBuffer *Buf = rewriter.getRewriteBufferFor(FID);
SmallString<512> NewText;
llvm::raw_svector_ostream OS(NewText);
Buf->write(OS);

SmallString<64> TempPath;
int FD;
if (fs::createTemporaryFile(path::filename(FE.getName()),
                            path::extension(FE.getName()).drop_front(), FD,
                            TempPath)) {
  reportDiag("Could not create file: " + TempPath.str(), Diag);
  return std::string();
}

llvm::raw_fd_ostream TmpOut(FD, /*shouldClose=*/true);
TmpOut.write(NewText.data(), NewText.size());
TmpOut.close();

return std::string(TempPath.str());
2211}

2213bool arcmt::getFileRemappingsFromFileList(
                      std::vector<std::pair<std::string,std::string> > &remap,
                      ArrayRef<StringRef> remapFiles,
                      DiagnosticConsumer *DiagClient) {
bool hasErrorOccurred = false;

FileSystemOptions FSOpts;
FileManager FileMgr(FSOpts);
RemapFileParser Parser(FileMgr);

IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
IntrusiveRefCntPtr<DiagnosticsEngine> Diags(
    new DiagnosticsEngine(DiagID, new DiagnosticOptions,
                          DiagClient, /*ShouldOwnClient=*/false));

typedef llvm::DenseMap<FileEntryRef, std::vector<EditEntry> >
    FileEditEntriesTy;
FileEditEntriesTy FileEditEntries;

llvm::DenseSet<EditEntry> EntriesSet;

for (ArrayRef<StringRef>::iterator
       I = remapFiles.begin(), E = remapFiles.end(); I != E; ++I) {
  SmallVector<EditEntry, 16> Entries;
  if (Parser.parse(*I, Entries))
    continue;

  for (SmallVectorImpl<EditEntry>::iterator
         EI = Entries.begin(), EE = Entries.end(); EI != EE; ++EI) {
    EditEntry &Entry = *EI;
    if (!Entry.File)
      continue;
    std::pair<llvm::DenseSet<EditEntry>::iterator, bool>
      Insert = EntriesSet.insert(Entry);
    if (!Insert.second)
      continue;

    FileEditEntries[*Entry.File].push_back(Entry);
  }
}

for (FileEditEntriesTy::iterator
       I = FileEditEntries.begin(), E = FileEditEntries.end(); I != E; ++I) {
  std::string TempFile = applyEditsToTemp(I->first, I->second,
                                          FileMgr, *Diags);
  if (TempFile.empty()) {
    hasErrorOccurred = true;
    continue;
  }

  remap.emplace_back(std::string(I->first.getName()), TempFile);
}

return hasErrorOccurred;
2267}

←

/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/include/clang/Basic/SourceManager.h

→

1//===- SourceManager.h - Track and cache source files -----------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9/// \file
10/// Defines the SourceManager interface.
11///
12/// There are three different types of locations in a %file: a spelling
13/// location, an expansion location, and a presumed location.
14///
15/// Given an example of:
16/// \code
17/// #define min(x, y) x < y ? x : y
18/// \endcode
19///
20/// and then later on a use of min:
21/// \code
22/// #line 17
23/// return min(a, b);
24/// \endcode
25///
26/// The expansion location is the line in the source code where the macro
27/// was expanded (the return statement), the spelling location is the
28/// location in the source where the macro was originally defined,
29/// and the presumed location is where the line directive states that
30/// the line is 17, or any other line.
31//
32//===----------------------------------------------------------------------===//

34#ifndef LLVM_CLANG_BASIC_SOURCEMANAGER_H
35#define LLVM_CLANG_BASIC_SOURCEMANAGER_H

37#include "clang/Basic/Diagnostic.h"
38#include "clang/Basic/FileEntry.h"
39#include "clang/Basic/SourceLocation.h"
40#include "llvm/ADT/ArrayRef.h"
41#include "llvm/ADT/BitVector.h"
42#include "llvm/ADT/DenseMap.h"
43#include "llvm/ADT/DenseSet.h"
44#include "llvm/ADT/IntrusiveRefCntPtr.h"
45#include "llvm/ADT/PointerIntPair.h"
46#include "llvm/ADT/SmallVector.h"
47#include "llvm/ADT/StringRef.h"
48#include "llvm/Support/Allocator.h"
49#include "llvm/Support/Compiler.h"
50#include "llvm/Support/MemoryBuffer.h"
51#include <cassert>
52#include <cstddef>
53#include <map>
54#include <memory>
55#include <string>
56#include <utility>
57#include <vector>

59namespace clang {

61class ASTReader;
62class ASTWriter;
63class FileManager;
64class LineTableInfo;
65class SourceManager;

67/// Public enums and private classes that are part of the
68/// SourceManager implementation.
69namespace SrcMgr {

71/// Indicates whether a file or directory holds normal user code,
72/// system code, or system code which is implicitly 'extern "C"' in C++ mode.
73///
74/// Entire directories can be tagged with this (this is maintained by
75/// DirectoryLookup and friends) as can specific FileInfos when a \#pragma
76/// system_header is seen or in various other cases.
77///
78enum CharacteristicKind {
C_User,
C_System,
C_ExternCSystem,
C_User_ModuleMap,
C_System_ModuleMap
84};

86/// Determine whether a file / directory characteristic is for system code.
87inline bool isSystem(CharacteristicKind CK) {
return CK != C_User && CK != C_User_ModuleMap;
89}

91/// Determine whether a file characteristic is for a module map.
92inline bool isModuleMap(CharacteristicKind CK) {
return CK == C_User_ModuleMap || CK == C_System_ModuleMap;
94}

96/// Mapping of line offsets into a source file. This does not own the storage
97/// for the line numbers.
98class LineOffsetMapping {
99public:
explicit operator bool() const { return Storage; }
unsigned size() const {
  assert(Storage)(static_cast<void> (0));
  return Storage[0];
}
ArrayRef<unsigned> getLines() const {
  assert(Storage)(static_cast<void> (0));
  return ArrayRef<unsigned>(Storage + 1, Storage + 1 + size());
}
const unsigned *begin() const { return getLines().begin(); }
const unsigned *end() const { return getLines().end(); }
const unsigned &operator[](int I) const { return getLines()[I]; }

static LineOffsetMapping get(llvm::MemoryBufferRef Buffer,
                             llvm::BumpPtrAllocator &Alloc);

LineOffsetMapping() = default;
LineOffsetMapping(ArrayRef<unsigned> LineOffsets,
                  llvm::BumpPtrAllocator &Alloc);

120private:
/// First element is the size, followed by elements at off-by-one indexes.
unsigned *Storage = nullptr;
123};

125/// One instance of this struct is kept for every file loaded or used.
126///
127/// This object owns the MemoryBuffer object.
128class alignas(8) ContentCache {
/// The actual buffer containing the characters from the input
/// file.
mutable std::unique_ptr<llvm::MemoryBuffer> Buffer;

133public:
/// Reference to the file entry representing this ContentCache.
///
/// This reference does not own the FileEntry object.
///
/// It is possible for this to be NULL if the ContentCache encapsulates
/// an imaginary text buffer.
///
/// FIXME: Turn this into a FileEntryRef and remove Filename.
const FileEntry *OrigEntry;

/// References the file which the contents were actually loaded from.
///
/// Can be different from 'Entry' if we overridden the contents of one file
/// with the contents of another file.
const FileEntry *ContentsEntry;

/// The filename that is used to access OrigEntry.
///
/// FIXME: Remove this once OrigEntry is a FileEntryRef with a stable name.
StringRef Filename;

/// A bump pointer allocated array of offsets for each source line.
///
/// This is lazily computed.  The lines are owned by the SourceManager
/// BumpPointerAllocator object.
mutable LineOffsetMapping SourceLineCache;

/// Indicates whether the buffer itself was provided to override
/// the actual file contents.
///
/// When true, the original entry may be a virtual file that does not
/// exist.
unsigned BufferOverridden : 1;

/// True if this content cache was initially created for a source file
/// considered to be volatile (likely to change between stat and open).
unsigned IsFileVolatile : 1;

/// True if this file may be transient, that is, if it might not
/// exist at some later point in time when this content entry is used,
/// after serialization and deserialization.
unsigned IsTransient : 1;

mutable unsigned IsBufferInvalid : 1;

ContentCache(const FileEntry *Ent = nullptr) : ContentCache(Ent, Ent) {}

ContentCache(const FileEntry *Ent, const FileEntry *contentEnt)
    : OrigEntry(Ent), ContentsEntry(contentEnt), BufferOverridden(false),
      IsFileVolatile(false), IsTransient(false), IsBufferInvalid(false) {}

/// The copy ctor does not allow copies where source object has either
/// a non-NULL Buffer or SourceLineCache.  Ownership of allocated memory
/// is not transferred, so this is a logical error.
ContentCache(const ContentCache &RHS)
    : BufferOverridden(false), IsFileVolatile(false), IsTransient(false),
      IsBufferInvalid(false) {
  OrigEntry = RHS.OrigEntry;
  ContentsEntry = RHS.ContentsEntry;

  assert(!RHS.Buffer && !RHS.SourceLineCache &&(static_cast<void> (0))
         "Passed ContentCache object cannot own a buffer.")(static_cast<void> (0));
}

ContentCache &operator=(const ContentCache &RHS) = delete;

/// Returns the memory buffer for the associated content.
///
/// \param Diag Object through which diagnostics will be emitted if the
///   buffer cannot be retrieved.
///
/// \param Loc If specified, is the location that invalid file diagnostics
///   will be emitted at.
llvm::Optional<llvm::MemoryBufferRef>
getBufferOrNone(DiagnosticsEngine &Diag, FileManager &FM,
                SourceLocation Loc = SourceLocation()) const;

/// Returns the size of the content encapsulated by this
/// ContentCache.
///
/// This can be the size of the source file or the size of an
/// arbitrary scratch buffer.  If the ContentCache encapsulates a source
/// file this size is retrieved from the file's FileEntry.
unsigned getSize() const;

/// Returns the number of bytes actually mapped for this
/// ContentCache.
///
/// This can be 0 if the MemBuffer was not actually expanded.
unsigned getSizeBytesMapped() const;

/// Returns the kind of memory used to back the memory buffer for
/// this content cache.  This is used for performance analysis.
llvm::MemoryBuffer::BufferKind getMemoryBufferKind() const;

/// Return the buffer, only if it has been loaded.
llvm::Optional<llvm::MemoryBufferRef> getBufferIfLoaded() const {
  if (Buffer)
    return Buffer->getMemBufferRef();
  return None;
}

/// Return a StringRef to the source buffer data, only if it has already
/// been loaded.
llvm::Optional<StringRef> getBufferDataIfLoaded() const {
  if (Buffer)
    return Buffer->getBuffer();
  return None;
}

/// Set the buffer.
void setBuffer(std::unique_ptr<llvm::MemoryBuffer> B) {
  IsBufferInvalid = false;
  Buffer = std::move(B);
}

/// Set the buffer to one that's not owned (or to nullptr).
///
/// \pre Buffer cannot already be set.
void setUnownedBuffer(llvm::Optional<llvm::MemoryBufferRef> B) {
  assert(!Buffer && "Expected to be called right after construction")(static_cast<void> (0));
  if (B)
    setBuffer(llvm::MemoryBuffer::getMemBuffer(*B));
}

// If BufStr has an invalid BOM, returns the BOM name; otherwise, returns
// nullptr
static const char *getInvalidBOM(StringRef BufStr);
262};

264// Assert that the \c ContentCache objects will always be 8-byte aligned so
265// that we can pack 3 bits of integer into pointers to such objects.
266static_assert(alignof(ContentCache) >= 8,
            "ContentCache must be 8-byte aligned.");

269/// Information about a FileID, basically just the logical file
270/// that it represents and include stack information.
271///
272/// Each FileInfo has include stack information, indicating where it came
273/// from. This information encodes the \#include chain that a token was
274/// expanded from. The main include file has an invalid IncludeLoc.
275///
276/// FileInfo should not grow larger than ExpansionInfo. Doing so will
277/// cause memory to bloat in compilations with many unloaded macro
278/// expansions, since the two data structurs are stored in a union in
279/// SLocEntry. Extra fields should instead go in "ContentCache *", which
280/// stores file contents and other bits on the side.
281///
282class FileInfo {
friend class clang::SourceManager;
friend class clang::ASTWriter;
friend class clang::ASTReader;

/// The location of the \#include that brought in this file.
///
/// This is an invalid SLOC for the main file (top of the \#include chain).
SourceLocation IncludeLoc;

/// Number of FileIDs (files and macros) that were created during
/// preprocessing of this \#include, including this SLocEntry.
///
/// Zero means the preprocessor didn't provide such info for this SLocEntry.
unsigned NumCreatedFIDs : 31;

/// Whether this FileInfo has any \#line directives.
unsigned HasLineDirectives : 1;

/// The content cache and the characteristic of the file.
llvm::PointerIntPair<const ContentCache *, 3, CharacteristicKind>
    ContentAndKind;

305public:
/// Return a FileInfo object.
static FileInfo get(SourceLocation IL, ContentCache &Con,
                    CharacteristicKind FileCharacter, StringRef Filename) {
  FileInfo X;
  X.IncludeLoc = IL;
  X.NumCreatedFIDs = 0;
  X.HasLineDirectives = false;
  X.ContentAndKind.setPointer(&Con);
  X.ContentAndKind.setInt(FileCharacter);
  Con.Filename = Filename;
  return X;
}

SourceLocation getIncludeLoc() const {
  return IncludeLoc;
}

const ContentCache &getContentCache() const {
  return *ContentAndKind.getPointer();
}

/// Return whether this is a system header or not.
CharacteristicKind getFileCharacteristic() const {
  return ContentAndKind.getInt();
}

/// Return true if this FileID has \#line directives in it.
bool hasLineDirectives() const { return HasLineDirectives; }

/// Set the flag that indicates that this FileID has
/// line table entries associated with it.
void setHasLineDirectives() { HasLineDirectives = true; }

/// Returns the name of the file that was used when the file was loaded from
/// the underlying file system.
StringRef getName() const { return getContentCache().Filename; }
342};

344/// Each ExpansionInfo encodes the expansion location - where
345/// the token was ultimately expanded, and the SpellingLoc - where the actual
346/// character data for the token came from.
347class ExpansionInfo {
// Really these are all SourceLocations.

/// Where the spelling for the token can be found.
SourceLocation SpellingLoc;

/// In a macro expansion, ExpansionLocStart and ExpansionLocEnd
/// indicate the start and end of the expansion. In object-like macros,
/// they will be the same. In a function-like macro expansion, the start
/// will be the identifier and the end will be the ')'. Finally, in
/// macro-argument instantiations, the end will be 'SourceLocation()', an
/// invalid location.
SourceLocation ExpansionLocStart, ExpansionLocEnd;

/// Whether the expansion range is a token range.
bool ExpansionIsTokenRange;

364public:
SourceLocation getSpellingLoc() const {
  return SpellingLoc.isInvalid() ? getExpansionLocStart() : SpellingLoc;
}

SourceLocation getExpansionLocStart() const {
  return ExpansionLocStart;
}

SourceLocation getExpansionLocEnd() const {
  return ExpansionLocEnd.isInvalid() ? getExpansionLocStart()
                                     : ExpansionLocEnd;
}

bool isExpansionTokenRange() const { return ExpansionIsTokenRange; }

CharSourceRange getExpansionLocRange() const {
  return CharSourceRange(
      SourceRange(getExpansionLocStart(), getExpansionLocEnd()),
      isExpansionTokenRange());
}

bool isMacroArgExpansion() const {
  // Note that this needs to return false for default constructed objects.
  return getExpansionLocStart().isValid() && ExpansionLocEnd.isInvalid();
}

bool isMacroBodyExpansion() const {
  return getExpansionLocStart().isValid() && ExpansionLocEnd.isValid();
}

bool isFunctionMacroExpansion() const {
  return getExpansionLocStart().isValid() &&
         getExpansionLocStart() != getExpansionLocEnd();
}

/// Return a ExpansionInfo for an expansion.
///
/// Start and End specify the expansion range (where the macro is
/// expanded), and SpellingLoc specifies the spelling location (where
/// the characters from the token come from). All three can refer to
/// normal File SLocs or expansion locations.
static ExpansionInfo create(SourceLocation SpellingLoc, SourceLocation Start,
                            SourceLocation End,
                            bool ExpansionIsTokenRange = true) {
  ExpansionInfo X;
  X.SpellingLoc = SpellingLoc;
  X.ExpansionLocStart = Start;
  X.ExpansionLocEnd = End;
  X.ExpansionIsTokenRange = ExpansionIsTokenRange;
  return X;
}

/// Return a special ExpansionInfo for the expansion of
/// a macro argument into a function-like macro's body.
///
/// ExpansionLoc specifies the expansion location (where the macro is
/// expanded). This doesn't need to be a range because a macro is always
/// expanded at a macro parameter reference, and macro parameters are
/// always exactly one token. SpellingLoc specifies the spelling location
/// (where the characters from the token come from). ExpansionLoc and
/// SpellingLoc can both refer to normal File SLocs or expansion locations.
///
/// Given the code:
/// \code
///   #define F(x) f(x)
///   F(42);
/// \endcode
///
/// When expanding '\c F(42)', the '\c x' would call this with an
/// SpellingLoc pointing at '\c 42' and an ExpansionLoc pointing at its
/// location in the definition of '\c F'.
static ExpansionInfo createForMacroArg(SourceLocation SpellingLoc,
                                       SourceLocation ExpansionLoc) {
  // We store an intentionally invalid source location for the end of the
  // expansion range to mark that this is a macro argument location rather
  // than a normal one.
  return create(SpellingLoc, ExpansionLoc, SourceLocation());
}

/// Return a special ExpansionInfo representing a token that ends
/// prematurely. This is used to model a '>>' token that has been split
/// into '>' tokens and similar cases. Unlike for the other forms of
/// expansion, the expansion range in this case is a character range, not
/// a token range.
static ExpansionInfo createForTokenSplit(SourceLocation SpellingLoc,
                                         SourceLocation Start,
                                         SourceLocation End) {
  return create(SpellingLoc, Start, End, false);
}
454};

456// Assert that the \c FileInfo objects are no bigger than \c ExpansionInfo
457// objects. This controls the size of \c SLocEntry, of which we have one for
458// each macro expansion. The number of (unloaded) macro expansions can be
459// very large. Any other fields needed in FileInfo should go in ContentCache.
460static_assert(sizeof(FileInfo) <= sizeof(ExpansionInfo),
            "FileInfo must be no larger than ExpansionInfo.");

463/// This is a discriminated union of FileInfo and ExpansionInfo.
464///
465/// SourceManager keeps an array of these objects, and they are uniquely
466/// identified by the FileID datatype.
467class SLocEntry {
static constexpr int OffsetBits = 8 * sizeof(SourceLocation::UIntTy) - 1;
SourceLocation::UIntTy Offset : OffsetBits;
SourceLocation::UIntTy IsExpansion : 1;
union {
  FileInfo File;
  ExpansionInfo Expansion;
};

476public:
SLocEntry() : Offset(), IsExpansion(), File() {}

SourceLocation::UIntTy getOffset() const { return Offset; }

bool isExpansion() const { return IsExpansion; }
bool isFile() const { return !isExpansion(); }

const FileInfo &getFile() const {
  assert(isFile() && "Not a file SLocEntry!")(static_cast<void> (0));
  return File;
}

const ExpansionInfo &getExpansion() const {
  assert(isExpansion() && "Not a macro expansion SLocEntry!")(static_cast<void> (0));
  return Expansion;
}

static SLocEntry get(SourceLocation::UIntTy Offset, const FileInfo &FI) {
  assert(!(Offset & (1ULL << OffsetBits)) && "Offset is too large")(static_cast<void> (0));
  SLocEntry E;
  E.Offset = Offset;
  E.IsExpansion = false;
  E.File = FI;
  return E;
}

static SLocEntry get(SourceLocation::UIntTy Offset,
                     const ExpansionInfo &Expansion) {
  assert(!(Offset & (1ULL << OffsetBits)) && "Offset is too large")(static_cast<void> (0));
  SLocEntry E;
  E.Offset = Offset;
  E.IsExpansion = true;
  new (&E.Expansion) ExpansionInfo(Expansion);
  return E;
}
512};

514} // namespace SrcMgr

516/// External source of source location entries.
517class ExternalSLocEntrySource {
518public:
virtual ~ExternalSLocEntrySource();

/// Read the source location entry with index ID, which will always be
/// less than -1.
///
/// \returns true if an error occurred that prevented the source-location
/// entry from being loaded.
virtual bool ReadSLocEntry(int ID) = 0;

/// Retrieve the module import location and name for the given ID, if
/// in fact it was loaded from a module (rather than, say, a precompiled
/// header).
virtual std::pair<SourceLocation, StringRef> getModuleImportLoc(int ID) = 0;
532};

534/// Holds the cache used by isBeforeInTranslationUnit.
535///
536/// The cache structure is complex enough to be worth breaking out of
537/// SourceManager.
538class InBeforeInTUCacheEntry {
/// The FileID's of the cached query.
///
/// If these match up with a subsequent query, the result can be reused.
FileID LQueryFID, RQueryFID;

/// True if LQueryFID was created before RQueryFID.
///
/// This is used to compare macro expansion locations.
bool IsLQFIDBeforeRQFID;

/// The file found in common between the two \#include traces, i.e.,
/// the nearest common ancestor of the \#include tree.
FileID CommonFID;

/// The offset of the previous query in CommonFID.
///
/// Usually, this represents the location of the \#include for QueryFID, but
/// if LQueryFID is a parent of RQueryFID (or vice versa) then these can be a
/// random token in the parent.
unsigned LCommonOffset, RCommonOffset;

560public:
/// Return true if the currently cached values match up with
/// the specified LHS/RHS query.
///
/// If not, we can't use the cache.
bool isCacheValid(FileID LHS, FileID RHS) const {
  return LQueryFID == LHS && RQueryFID == RHS;
}

/// If the cache is valid, compute the result given the
/// specified offsets in the LHS/RHS FileID's.
bool getCachedResult(unsigned LOffset, unsigned ROffset) const {
  // If one of the query files is the common file, use the offset.  Otherwise,
  // use the #include loc in the common file.
  if (LQueryFID != CommonFID) LOffset = LCommonOffset;
  if (RQueryFID != CommonFID) ROffset = RCommonOffset;

  // It is common for multiple macro expansions to be "included" from the same
  // location (expansion location), in which case use the order of the FileIDs
  // to determine which came first. This will also take care the case where
  // one of the locations points at the inclusion/expansion point of the other
  // in which case its FileID will come before the other.
  if (LOffset == ROffset)
    return IsLQFIDBeforeRQFID;

  return LOffset < ROffset;
}

/// Set up a new query.
void setQueryFIDs(FileID LHS, FileID RHS, bool isLFIDBeforeRFID) {
  assert(LHS != RHS)(static_cast<void> (0));
  LQueryFID = LHS;
  RQueryFID = RHS;
  IsLQFIDBeforeRQFID = isLFIDBeforeRFID;
}

void clear() {
  LQueryFID = RQueryFID = FileID();
  IsLQFIDBeforeRQFID = false;
}

void setCommonLoc(FileID commonFID, unsigned lCommonOffset,
                  unsigned rCommonOffset) {
  CommonFID = commonFID;
  LCommonOffset = lCommonOffset;
  RCommonOffset = rCommonOffset;
}
607};

609/// The stack used when building modules on demand, which is used
610/// to provide a link between the source managers of the different compiler
611/// instances.
612using ModuleBuildStack = ArrayRef<std::pair<std::string, FullSourceLoc>>;

614/// This class handles loading and caching of source files into memory.
615///
616/// This object owns the MemoryBuffer objects for all of the loaded
617/// files and assigns unique FileID's for each unique \#include chain.
618///
619/// The SourceManager can be queried for information about SourceLocation
620/// objects, turning them into either spelling or expansion locations. Spelling
621/// locations represent where the bytes corresponding to a token came from and
622/// expansion locations represent where the location is in the user's view. In
623/// the case of a macro expansion, for example, the spelling location indicates
624/// where the expanded token came from and the expansion location specifies
625/// where it was expanded.
626class SourceManager : public RefCountedBase<SourceManager> {
/// DiagnosticsEngine object.
DiagnosticsEngine &Diag;

FileManager &FileMgr;

mutable llvm::BumpPtrAllocator ContentCacheAlloc;

/// Memoized information about all of the files tracked by this
/// SourceManager.
///
/// This map allows us to merge ContentCache entries based
/// on their FileEntry*.  All ContentCache objects will thus have unique,
/// non-null, FileEntry pointers.
llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*> FileInfos;

/// True if the ContentCache for files that are overridden by other
/// files, should report the original file name. Defaults to true.
bool OverridenFilesKeepOriginalName = true;

/// True if non-system source files should be treated as volatile
/// (likely to change while trying to use them). Defaults to false.
bool UserFilesAreVolatile;

/// True if all files read during this compilation should be treated
/// as transient (may not be present in later compilations using a module
/// file created from this compilation). Defaults to false.
bool FilesAreTransient = false;

struct OverriddenFilesInfoTy {
  /// Files that have been overridden with the contents from another
  /// file.
  llvm::DenseMap<const FileEntry *, const FileEntry *> OverriddenFiles;

  /// Files that were overridden with a memory buffer.
  llvm::DenseSet<const FileEntry *> OverriddenFilesWithBuffer;
};

/// Lazily create the object keeping overridden files info, since
/// it is uncommonly used.
std::unique_ptr<OverriddenFilesInfoTy> OverriddenFilesInfo;

OverriddenFilesInfoTy &getOverriddenFilesInfo() {
  if (!OverriddenFilesInfo)
    OverriddenFilesInfo.reset(new OverriddenFilesInfoTy);
  return *OverriddenFilesInfo;
}

/// Information about various memory buffers that we have read in.
///
/// All FileEntry* within the stored ContentCache objects are NULL,
/// as they do not refer to a file.
std::vector<SrcMgr::ContentCache*> MemBufferInfos;

/// The table of SLocEntries that are local to this module.
///
/// Positive FileIDs are indexes into this table. Entry 0 indicates an invalid
/// expansion.
SmallVector<SrcMgr::SLocEntry, 0> LocalSLocEntryTable;

/// The table of SLocEntries that are loaded from other modules.
///
/// Negative FileIDs are indexes into this table. To get from ID to an index,
/// use (-ID - 2).
SmallVector<SrcMgr::SLocEntry, 0> LoadedSLocEntryTable;

/// The starting offset of the next local SLocEntry.
///
/// This is LocalSLocEntryTable.back().Offset + the size of that entry.
SourceLocation::UIntTy NextLocalOffset;

/// The starting offset of the latest batch of loaded SLocEntries.
///
/// This is LoadedSLocEntryTable.back().Offset, except that that entry might
/// not have been loaded, so that value would be unknown.
SourceLocation::UIntTy CurrentLoadedOffset;

/// The highest possible offset is 2^32-1 (2^63-1 for 64-bit source
/// locations), so CurrentLoadedOffset starts at 2^31 (2^63 resp.).
static const SourceLocation::UIntTy MaxLoadedOffset =
    1ULL << (8 * sizeof(SourceLocation::UIntTy) - 1);

/// A bitmap that indicates whether the entries of LoadedSLocEntryTable
/// have already been loaded from the external source.
///
/// Same indexing as LoadedSLocEntryTable.
llvm::BitVector SLocEntryLoaded;

/// An external source for source location entries.
ExternalSLocEntrySource *ExternalSLocEntries = nullptr;

/// A one-entry cache to speed up getFileID.
///
/// LastFileIDLookup records the last FileID looked up or created, because it
/// is very common to look up many tokens from the same file.
mutable FileID LastFileIDLookup;

/// Holds information for \#line directives.
///
/// This is referenced by indices from SLocEntryTable.
std::unique_ptr<LineTableInfo> LineTable;

/// These ivars serve as a cache used in the getLineNumber
/// method which is used to speedup getLineNumber calls to nearby locations.
mutable FileID LastLineNoFileIDQuery;
mutable const SrcMgr::ContentCache *LastLineNoContentCache;
mutable unsigned LastLineNoFilePos;
mutable unsigned LastLineNoResult;

/// The file ID for the main source file of the translation unit.
FileID MainFileID;

/// The file ID for the precompiled preamble there is one.
FileID PreambleFileID;

// Statistics for -print-stats.
mutable unsigned NumLinearScans = 0;
mutable unsigned NumBinaryProbes = 0;

/// Associates a FileID with its "included/expanded in" decomposed
/// location.
///
/// Used to cache results from and speed-up \c getDecomposedIncludedLoc
/// function.
mutable llvm::DenseMap<FileID, std::pair<FileID, unsigned>> IncludedLocMap;

/// The key value into the IsBeforeInTUCache table.
using IsBeforeInTUCacheKey = std::pair<FileID, FileID>;

/// The IsBeforeInTranslationUnitCache is a mapping from FileID pairs
/// to cache results.
using InBeforeInTUCache =
    llvm::DenseMap<IsBeforeInTUCacheKey, InBeforeInTUCacheEntry>;

/// Cache results for the isBeforeInTranslationUnit method.
mutable InBeforeInTUCache IBTUCache;
mutable InBeforeInTUCacheEntry IBTUCacheOverflow;

/// Return the cache entry for comparing the given file IDs
/// for isBeforeInTranslationUnit.
InBeforeInTUCacheEntry &getInBeforeInTUCache(FileID LFID, FileID RFID) const;

// Cache for the "fake" buffer used for error-recovery purposes.
mutable std::unique_ptr<llvm::MemoryBuffer> FakeBufferForRecovery;

mutable std::unique_ptr<SrcMgr::ContentCache> FakeContentCacheForRecovery;

mutable std::unique_ptr<SrcMgr::SLocEntry> FakeSLocEntryForRecovery;

/// Lazily computed map of macro argument chunks to their expanded
/// source location.
using MacroArgsMap = std::map<unsigned, SourceLocation>;

mutable llvm::DenseMap<FileID, std::unique_ptr<MacroArgsMap>>
    MacroArgsCacheMap;

/// The stack of modules being built, which is used to detect
/// cycles in the module dependency graph as modules are being built, as
/// well as to describe why we're rebuilding a particular module.
///
/// There is no way to set this value from the command line. If we ever need
/// to do so (e.g., if on-demand module construction moves out-of-process),
/// we can add a cc1-level option to do so.
SmallVector<std::pair<std::string, FullSourceLoc>, 2> StoredModuleBuildStack;

791public:
SourceManager(DiagnosticsEngine &Diag, FileManager &FileMgr,
              bool UserFilesAreVolatile = false);
explicit SourceManager(const SourceManager &) = delete;
SourceManager &operator=(const SourceManager &) = delete;
~SourceManager();

void clearIDTables();

/// Initialize this source manager suitably to replay the compilation
/// described by \p Old. Requires that \p Old outlive \p *this.
void initializeForReplay(const SourceManager &Old);

DiagnosticsEngine &getDiagnostics() const { return Diag; }

FileManager &getFileManager() const { return FileMgr; }

/// Set true if the SourceManager should report the original file name
/// for contents of files that were overridden by other files. Defaults to
/// true.
void setOverridenFilesKeepOriginalName(bool value) {
  OverridenFilesKeepOriginalName = value;
}

/// True if non-system source files should be treated as volatile
/// (likely to change while trying to use them).
bool userFilesAreVolatile() const { return UserFilesAreVolatile; }

/// Retrieve the module build stack.
ModuleBuildStack getModuleBuildStack() const {
  return StoredModuleBuildStack;
}

/// Set the module build stack.
void setModuleBuildStack(ModuleBuildStack stack) {
  StoredModuleBuildStack.clear();
  StoredModuleBuildStack.append(stack.begin(), stack.end());
}

/// Push an entry to the module build stack.
void pushModuleBuildStack(StringRef moduleName, FullSourceLoc importLoc) {
  StoredModuleBuildStack.push_back(std::make_pair(moduleName.str(),importLoc));
}

//===--------------------------------------------------------------------===//
// MainFileID creation and querying methods.
//===--------------------------------------------------------------------===//

/// Returns the FileID of the main source file.
FileID getMainFileID() const { return MainFileID; }

/// Set the file ID for the main source file.
void setMainFileID(FileID FID) {
  MainFileID = FID;
}

/// Returns true when the given FileEntry corresponds to the main file.
///
/// The main file should be set prior to calling this function.
bool isMainFile(const FileEntry &SourceFile);

/// Set the file ID for the precompiled preamble.
void setPreambleFileID(FileID Preamble) {
  assert(PreambleFileID.isInvalid() && "PreambleFileID already set!")(static_cast<void> (0));
  PreambleFileID = Preamble;
}

/// Get the file ID for the precompiled preamble if there is one.
FileID getPreambleFileID() const { return PreambleFileID; }

//===--------------------------------------------------------------------===//
// Methods to create new FileID's and macro expansions.
//===--------------------------------------------------------------------===//

/// Create a new FileID that represents the specified file
/// being \#included from the specified IncludePosition.
///
/// This translates NULL into standard input.
FileID createFileID(const FileEntry *SourceFile, SourceLocation IncludePos,
                    SrcMgr::CharacteristicKind FileCharacter,
                    int LoadedID = 0,
                    SourceLocation::UIntTy LoadedOffset = 0);

FileID createFileID(FileEntryRef SourceFile, SourceLocation IncludePos,
                    SrcMgr::CharacteristicKind FileCharacter,
                    int LoadedID = 0,
                    SourceLocation::UIntTy LoadedOffset = 0);

/// Create a new FileID that represents the specified memory buffer.
///
/// This does no caching of the buffer and takes ownership of the
/// MemoryBuffer, so only pass a MemoryBuffer to this once.
FileID createFileID(std::unique_ptr<llvm::MemoryBuffer> Buffer,
                    SrcMgr::CharacteristicKind FileCharacter = SrcMgr::C_User,
                    int LoadedID = 0, SourceLocation::UIntTy LoadedOffset = 0,
                    SourceLocation IncludeLoc = SourceLocation());

/// Create a new FileID that represents the specified memory buffer.
///
/// This does not take ownership of the MemoryBuffer. The memory buffer must
/// outlive the SourceManager.
FileID createFileID(const llvm::MemoryBufferRef &Buffer,
                    SrcMgr::CharacteristicKind FileCharacter = SrcMgr::C_User,
                    int LoadedID = 0, SourceLocation::UIntTy LoadedOffset = 0,
                    SourceLocation IncludeLoc = SourceLocation());

/// Get the FileID for \p SourceFile if it exists. Otherwise, create a
/// new FileID for the \p SourceFile.
FileID getOrCreateFileID(const FileEntry *SourceFile,
                         SrcMgr::CharacteristicKind FileCharacter);

/// Return a new SourceLocation that encodes the
/// fact that a token from SpellingLoc should actually be referenced from
/// ExpansionLoc, and that it represents the expansion of a macro argument
/// into the function-like macro body.
SourceLocation createMacroArgExpansionLoc(SourceLocation Loc,
                                          SourceLocation ExpansionLoc,
                                          unsigned TokLength);

/// Return a new SourceLocation that encodes the fact
/// that a token from SpellingLoc should actually be referenced from
/// ExpansionLoc.
SourceLocation
createExpansionLoc(SourceLocation Loc, SourceLocation ExpansionLocStart,
                   SourceLocation ExpansionLocEnd, unsigned TokLength,
                   bool ExpansionIsTokenRange = true, int LoadedID = 0,
                   SourceLocation::UIntTy LoadedOffset = 0);

/// Return a new SourceLocation that encodes that the token starting
/// at \p TokenStart ends prematurely at \p TokenEnd.
SourceLocation createTokenSplitLoc(SourceLocation SpellingLoc,
                                   SourceLocation TokenStart,
                                   SourceLocation TokenEnd);

/// Retrieve the memory buffer associated with the given file.
///
/// Returns None if the buffer is not valid.
llvm::Optional<llvm::MemoryBufferRef>
getMemoryBufferForFileOrNone(const FileEntry *File);

/// Retrieve the memory buffer associated with the given file.
///
/// Returns a fake buffer if there isn't a real one.
llvm::MemoryBufferRef getMemoryBufferForFileOrFake(const FileEntry *File) {
  if (auto B = getMemoryBufferForFileOrNone(File))
    return *B;
  return getFakeBufferForRecovery();
}

/// Override the contents of the given source file by providing an
/// already-allocated buffer.
///
/// \param SourceFile the source file whose contents will be overridden.
///
/// \param Buffer the memory buffer whose contents will be used as the
/// data in the given source file.
void overrideFileContents(const FileEntry *SourceFile,
                          const llvm::MemoryBufferRef &Buffer) {
  overrideFileContents(SourceFile, llvm::MemoryBuffer::getMemBuffer(Buffer));
}

/// Override the contents of the given source file by providing an
/// already-allocated buffer.
///
/// \param SourceFile the source file whose contents will be overridden.
///
/// \param Buffer the memory buffer whose contents will be used as the
/// data in the given source file.
void overrideFileContents(const FileEntry *SourceFile,
                          std::unique_ptr<llvm::MemoryBuffer> Buffer);
void overrideFileContents(FileEntryRef SourceFile,
                          std::unique_ptr<llvm::MemoryBuffer> Buffer) {
  overrideFileContents(&SourceFile.getFileEntry(), std::move(Buffer));
}

/// Override the given source file with another one.
///
/// \param SourceFile the source file which will be overridden.
///
/// \param NewFile the file whose contents will be used as the
/// data instead of the contents of the given source file.
void overrideFileContents(const FileEntry *SourceFile,
                          const FileEntry *NewFile);

/// Returns true if the file contents have been overridden.
bool isFileOverridden(const FileEntry *File) const {
  if (OverriddenFilesInfo) {
    if (OverriddenFilesInfo->OverriddenFilesWithBuffer.count(File))
      return true;
    if (OverriddenFilesInfo->OverriddenFiles.find(File) !=
        OverriddenFilesInfo->OverriddenFiles.end())
      return true;
  }
  return false;
}

/// Bypass the overridden contents of a file.  This creates a new FileEntry
/// and initializes the content cache for it.  Returns None if there is no
/// such file in the filesystem.
///
/// This should be called before parsing has begun.
Optional<FileEntryRef> bypassFileContentsOverride(FileEntryRef File);

/// Specify that a file is transient.
void setFileIsTransient(const FileEntry *SourceFile);

/// Specify that all files that are read during this compilation are
/// transient.
void setAllFilesAreTransient(bool Transient) {
  FilesAreTransient = Transient;
}

//===--------------------------------------------------------------------===//
// FileID manipulation methods.
//===--------------------------------------------------------------------===//

/// Return the buffer for the specified FileID.
///
/// If there is an error opening this buffer the first time, return None.
llvm::Optional<llvm::MemoryBufferRef>
getBufferOrNone(FileID FID, SourceLocation Loc = SourceLocation()) const {
  if (auto *Entry = getSLocEntryForFile(FID))
    return Entry->getFile().getContentCache().getBufferOrNone(
        Diag, getFileManager(), Loc);
  return None;
}

/// Return the buffer for the specified FileID.
///
/// If there is an error opening this buffer the first time, this
/// manufactures a temporary buffer and returns it.
llvm::MemoryBufferRef
getBufferOrFake(FileID FID, SourceLocation Loc = SourceLocation()) const {
  if (auto B = getBufferOrNone(FID, Loc))
    return *B;
  return getFakeBufferForRecovery();
}

/// Returns the FileEntry record for the provided FileID.
const FileEntry *getFileEntryForID(FileID FID) const {
  if (auto *Entry = getSLocEntryForFile(FID))
    return Entry->getFile().getContentCache().OrigEntry;
  return nullptr;
}

/// Returns the FileEntryRef for the provided FileID.
Optional<FileEntryRef> getFileEntryRefForID(FileID FID) const {
  if (auto *Entry6.1
'Entry' is null
1
'Entry' is null
1
'Entry' is null
1
'Entry' is null
1
'Entry' is null
 = getFileEntryForID(FID))
7
←
Taking false branch→
    return Entry->getLastRef();
  return None;
8
←
Calling constructor for 'Optional<clang::FileEntryRef>'→
16
←
Returning from constructor for 'Optional<clang::FileEntryRef>'→
}

/// Returns the filename for the provided FileID, unless it's a built-in
/// buffer that's not represented by a filename.
///
/// Returns None for non-files and built-in files.
Optional<StringRef> getNonBuiltinFilenameForID(FileID FID) const;

/// Returns the FileEntry record for the provided SLocEntry.
const FileEntry *getFileEntryForSLocEntry(const SrcMgr::SLocEntry &sloc) const
{
  return sloc.getFile().getContentCache().OrigEntry;
}

/// Return a StringRef to the source buffer data for the
/// specified FileID.
///
/// \param FID The file ID whose contents will be returned.
/// \param Invalid If non-NULL, will be set true if an error occurred.
StringRef getBufferData(FileID FID, bool *Invalid = nullptr) const;

/// Return a StringRef to the source buffer data for the
/// specified FileID, returning None if invalid.
///
/// \param FID The file ID whose contents will be returned.
llvm::Optional<StringRef> getBufferDataOrNone(FileID FID) const;

/// Return a StringRef to the source buffer data for the
/// specified FileID, returning None if it's not yet loaded.
///
/// \param FID The file ID whose contents will be returned.
llvm::Optional<StringRef> getBufferDataIfLoaded(FileID FID) const;

/// Get the number of FileIDs (files and macros) that were created
/// during preprocessing of \p FID, including it.
unsigned getNumCreatedFIDsForFileID(FileID FID) const {
  if (auto *Entry = getSLocEntryForFile(FID))
    return Entry->getFile().NumCreatedFIDs;
  return 0;
}

/// Set the number of FileIDs (files and macros) that were created
/// during preprocessing of \p FID, including it.
void setNumCreatedFIDsForFileID(FileID FID, unsigned NumFIDs,
                                bool Force = false) const {
  auto *Entry = getSLocEntryForFile(FID);
  if (!Entry)
    return;
  assert((Force || Entry->getFile().NumCreatedFIDs == 0) && "Already set!")(static_cast<void> (0));
  const_cast<SrcMgr::FileInfo &>(Entry->getFile()).NumCreatedFIDs = NumFIDs;
}

//===--------------------------------------------------------------------===//
// SourceLocation manipulation methods.
//===--------------------------------------------------------------------===//

/// Return the FileID for a SourceLocation.
///
/// This is a very hot method that is used for all SourceManager queries
/// that start with a SourceLocation object.  It is responsible for finding
/// the entry in SLocEntryTable which contains the specified location.
///
FileID getFileID(SourceLocation SpellingLoc) const {
  SourceLocation::UIntTy SLocOffset = SpellingLoc.getOffset();

  // If our one-entry cache covers this offset, just return it.
  if (isOffsetInFileID(LastFileIDLookup, SLocOffset))
    return LastFileIDLookup;

  return getFileIDSlow(SLocOffset);
}

/// Return the filename of the file containing a SourceLocation.
StringRef getFilename(SourceLocation SpellingLoc) const;

/// Return the source location corresponding to the first byte of
/// the specified file.
SourceLocation getLocForStartOfFile(FileID FID) const {
  if (auto *Entry = getSLocEntryForFile(FID))
    return SourceLocation::getFileLoc(Entry->getOffset());
  return SourceLocation();
}

/// Return the source location corresponding to the last byte of the
/// specified file.
SourceLocation getLocForEndOfFile(FileID FID) const {
  if (auto *Entry = getSLocEntryForFile(FID))
    return SourceLocation::getFileLoc(Entry->getOffset() +
                                      getFileIDSize(FID));
  return SourceLocation();
}

/// Returns the include location if \p FID is a \#include'd file
/// otherwise it returns an invalid location.
SourceLocation getIncludeLoc(FileID FID) const {
  if (auto *Entry = getSLocEntryForFile(FID))
    return Entry->getFile().getIncludeLoc();
  return SourceLocation();
}

// Returns the import location if the given source location is
// located within a module, or an invalid location if the source location
// is within the current translation unit.
std::pair<SourceLocation, StringRef>
getModuleImportLoc(SourceLocation Loc) const {
  FileID FID = getFileID(Loc);

  // Positive file IDs are in the current translation unit, and -1 is a
  // placeholder.
  if (FID.ID >= -1)
    return std::make_pair(SourceLocation(), "");

  return ExternalSLocEntries->getModuleImportLoc(FID.ID);
}

/// Given a SourceLocation object \p Loc, return the expansion
/// location referenced by the ID.
SourceLocation getExpansionLoc(SourceLocation Loc) const {
  // Handle the non-mapped case inline, defer to out of line code to handle
  // expansions.
  if (Loc.isFileID()) return Loc;
  return getExpansionLocSlowCase(Loc);
}

/// Given \p Loc, if it is a macro location return the expansion
/// location or the spelling location, depending on if it comes from a
/// macro argument or not.
SourceLocation getFileLoc(SourceLocation Loc) const {
  if (Loc.isFileID()) return Loc;
  return getFileLocSlowCase(Loc);
}

/// Return the start/end of the expansion information for an
/// expansion location.
///
/// \pre \p Loc is required to be an expansion location.
CharSourceRange getImmediateExpansionRange(SourceLocation Loc) const;

/// Given a SourceLocation object, return the range of
/// tokens covered by the expansion in the ultimate file.
CharSourceRange getExpansionRange(SourceLocation Loc) const;

/// Given a SourceRange object, return the range of
/// tokens or characters covered by the expansion in the ultimate file.
CharSourceRange getExpansionRange(SourceRange Range) const {
  SourceLocation Begin = getExpansionRange(Range.getBegin()).getBegin();
  CharSourceRange End = getExpansionRange(Range.getEnd());
  return CharSourceRange(SourceRange(Begin, End.getEnd()),
                         End.isTokenRange());
}

/// Given a CharSourceRange object, return the range of
/// tokens or characters covered by the expansion in the ultimate file.
CharSourceRange getExpansionRange(CharSourceRange Range) const {
  CharSourceRange Expansion = getExpansionRange(Range.getAsRange());
  if (Expansion.getEnd() == Range.getEnd())
    Expansion.setTokenRange(Range.isTokenRange());
  return Expansion;
}

/// Given a SourceLocation object, return the spelling
/// location referenced by the ID.
///
/// This is the place where the characters that make up the lexed token
/// can be found.
SourceLocation getSpellingLoc(SourceLocation Loc) const {
  // Handle the non-mapped case inline, defer to out of line code to handle
  // expansions.
  if (Loc.isFileID()) return Loc;
  return getSpellingLocSlowCase(Loc);
}

/// Given a SourceLocation object, return the spelling location
/// referenced by the ID.
///
/// This is the first level down towards the place where the characters
/// that make up the lexed token can be found.  This should not generally
/// be used by clients.
SourceLocation getImmediateSpellingLoc(SourceLocation Loc) const;

/// Form a SourceLocation from a FileID and Offset pair.
SourceLocation getComposedLoc(FileID FID, unsigned Offset) const {
  auto *Entry = getSLocEntryOrNull(FID);
  if (!Entry)
    return SourceLocation();

  SourceLocation::UIntTy GlobalOffset = Entry->getOffset() + Offset;
  return Entry->isFile() ? SourceLocation::getFileLoc(GlobalOffset)
                         : SourceLocation::getMacroLoc(GlobalOffset);
}

/// Decompose the specified location into a raw FileID + Offset pair.
///
/// The first element is the FileID, the second is the offset from the
/// start of the buffer of the location.
std::pair<FileID, unsigned> getDecomposedLoc(SourceLocation Loc) const {
  FileID FID = getFileID(Loc);
  auto *Entry = getSLocEntryOrNull(FID);
  if (!Entry)
    return std::make_pair(FileID(), 0);
  return std::make_pair(FID, Loc.getOffset() - Entry->getOffset());
}

/// Decompose the specified location into a raw FileID + Offset pair.
///
/// If the location is an expansion record, walk through it until we find
/// the final location expanded.
std::pair<FileID, unsigned>
getDecomposedExpansionLoc(SourceLocation Loc) const {
  FileID FID = getFileID(Loc);
  auto *E = getSLocEntryOrNull(FID);
  if (!E)
    return std::make_pair(FileID(), 0);

  unsigned Offset = Loc.getOffset()-E->getOffset();
  if (Loc.isFileID())
    return std::make_pair(FID, Offset);

  return getDecomposedExpansionLocSlowCase(E);
}

/// Decompose the specified location into a raw FileID + Offset pair.
///
/// If the location is an expansion record, walk through it until we find
/// its spelling record.
std::pair<FileID, unsigned>
getDecomposedSpellingLoc(SourceLocation Loc) const {
  FileID FID = getFileID(Loc);
  auto *E = getSLocEntryOrNull(FID);
  if (!E)
    return std::make_pair(FileID(), 0);

  unsigned Offset = Loc.getOffset()-E->getOffset();
  if (Loc.isFileID())
    return std::make_pair(FID, Offset);
  return getDecomposedSpellingLocSlowCase(E, Offset);
}

/// Returns the "included/expanded in" decomposed location of the given
/// FileID.
std::pair<FileID, unsigned> getDecomposedIncludedLoc(FileID FID) const;

/// Returns the offset from the start of the file that the
/// specified SourceLocation represents.
///
/// This is not very meaningful for a macro ID.
unsigned getFileOffset(SourceLocation SpellingLoc) const {
  return getDecomposedLoc(SpellingLoc).second;
}

/// Tests whether the given source location represents a macro
/// argument's expansion into the function-like macro definition.
///
/// \param StartLoc If non-null and function returns true, it is set to the
/// start location of the macro argument expansion.
///
/// Such source locations only appear inside of the expansion
/// locations representing where a particular function-like macro was
/// expanded.
bool isMacroArgExpansion(SourceLocation Loc,
                         SourceLocation *StartLoc = nullptr) const;

/// Tests whether the given source location represents the expansion of
/// a macro body.
///
/// This is equivalent to testing whether the location is part of a macro
/// expansion but not the expansion of an argument to a function-like macro.
bool isMacroBodyExpansion(SourceLocation Loc) const;

/// Returns true if the given MacroID location points at the beginning
/// of the immediate macro expansion.
///
/// \param MacroBegin If non-null and function returns true, it is set to the
/// begin location of the immediate macro expansion.
bool isAtStartOfImmediateMacroExpansion(SourceLocation Loc,
                                  SourceLocation *MacroBegin = nullptr) const;

/// Returns true if the given MacroID location points at the character
/// end of the immediate macro expansion.
///
/// \param MacroEnd If non-null and function returns true, it is set to the
/// character end location of the immediate macro expansion.
bool
isAtEndOfImmediateMacroExpansion(SourceLocation Loc,
                                 SourceLocation *MacroEnd = nullptr) const;

/// Returns true if \p Loc is inside the [\p Start, +\p Length)
/// chunk of the source location address space.
///
/// If it's true and \p RelativeOffset is non-null, it will be set to the
/// relative offset of \p Loc inside the chunk.
bool
isInSLocAddrSpace(SourceLocation Loc, SourceLocation Start, unsigned Length,
                  SourceLocation::UIntTy *RelativeOffset = nullptr) const {
  assert(((Start.getOffset() < NextLocalOffset &&(static_cast<void> (0))
             Start.getOffset()+Length <= NextLocalOffset) ||(static_cast<void> (0))
          (Start.getOffset() >= CurrentLoadedOffset &&(static_cast<void> (0))
              Start.getOffset()+Length < MaxLoadedOffset)) &&(static_cast<void> (0))
         "Chunk is not valid SLoc address space")(static_cast<void> (0));
  SourceLocation::UIntTy LocOffs = Loc.getOffset();
  SourceLocation::UIntTy BeginOffs = Start.getOffset();
  SourceLocation::UIntTy EndOffs = BeginOffs + Length;
  if (LocOffs >= BeginOffs && LocOffs < EndOffs) {
    if (RelativeOffset)
      *RelativeOffset = LocOffs - BeginOffs;
    return true;
  }

  return false;
}

/// Return true if both \p LHS and \p RHS are in the local source
/// location address space or the loaded one.
///
/// If it's true and \p RelativeOffset is non-null, it will be set to the
/// offset of \p RHS relative to \p LHS.
bool isInSameSLocAddrSpace(SourceLocation LHS, SourceLocation RHS,
                           SourceLocation::IntTy *RelativeOffset) const {
  SourceLocation::UIntTy LHSOffs = LHS.getOffset(), RHSOffs = RHS.getOffset();
  bool LHSLoaded = LHSOffs >= CurrentLoadedOffset;
  bool RHSLoaded = RHSOffs >= CurrentLoadedOffset;

  if (LHSLoaded == RHSLoaded) {
    if (RelativeOffset)
      *RelativeOffset = RHSOffs - LHSOffs;
    return true;
  }

  return false;
}

//===--------------------------------------------------------------------===//
// Queries about the code at a SourceLocation.
//===--------------------------------------------------------------------===//

/// Return a pointer to the start of the specified location
/// in the appropriate spelling MemoryBuffer.
///
/// \param Invalid If non-NULL, will be set \c true if an error occurs.
const char *getCharacterData(SourceLocation SL,
                             bool *Invalid = nullptr) const;

/// Return the column # for the specified file position.
///
/// This is significantly cheaper to compute than the line number.  This
/// returns zero if the column number isn't known.  This may only be called
/// on a file sloc, so you must choose a spelling or expansion location
/// before calling this method.
unsigned getColumnNumber(FileID FID, unsigned FilePos,
                         bool *Invalid = nullptr) const;
unsigned getSpellingColumnNumber(SourceLocation Loc,
                                 bool *Invalid = nullptr) const;
unsigned getExpansionColumnNumber(SourceLocation Loc,
                                  bool *Invalid = nullptr) const;
unsigned getPresumedColumnNumber(SourceLocation Loc,
                                 bool *Invalid = nullptr) const;

/// Given a SourceLocation, return the spelling line number
/// for the position indicated.
///
/// This requires building and caching a table of line offsets for the
/// MemoryBuffer, so this is not cheap: use only when about to emit a
/// diagnostic.
unsigned getLineNumber(FileID FID, unsigned FilePos, bool *Invalid = nullptr) const;
unsigned getSpellingLineNumber(SourceLocation Loc, bool *Invalid = nullptr) const;
unsigned getExpansionLineNumber(SourceLocation Loc, bool *Invalid = nullptr) const;
unsigned getPresumedLineNumber(SourceLocation Loc, bool *Invalid = nullptr) const;

/// Return the filename or buffer identifier of the buffer the
/// location is in.
///
/// Note that this name does not respect \#line directives.  Use
/// getPresumedLoc for normal clients.
StringRef getBufferName(SourceLocation Loc, bool *Invalid = nullptr) const;

/// Return the file characteristic of the specified source
/// location, indicating whether this is a normal file, a system
/// header, or an "implicit extern C" system header.
///
/// This state can be modified with flags on GNU linemarker directives like:
/// \code
///   # 4 "foo.h" 3
/// \endcode
/// which changes all source locations in the current file after that to be
/// considered to be from a system header.
SrcMgr::CharacteristicKind getFileCharacteristic(SourceLocation Loc) const;

/// Returns the "presumed" location of a SourceLocation specifies.
///
/// A "presumed location" can be modified by \#line or GNU line marker
/// directives.  This provides a view on the data that a user should see
/// in diagnostics, for example.
///
/// Note that a presumed location is always given as the expansion point of
/// an expansion location, not at the spelling location.
///
/// \returns The presumed location of the specified SourceLocation. If the
/// presumed location cannot be calculated (e.g., because \p Loc is invalid
/// or the file containing \p Loc has changed on disk), returns an invalid
/// presumed location.
PresumedLoc getPresumedLoc(SourceLocation Loc,
                           bool UseLineDirectives = true) const;

/// Returns whether the PresumedLoc for a given SourceLocation is
/// in the main file.
///
/// This computes the "presumed" location for a SourceLocation, then checks
/// whether it came from a file other than the main file. This is different
/// from isWrittenInMainFile() because it takes line marker directives into
/// account.
bool isInMainFile(SourceLocation Loc) const;

/// Returns true if the spelling locations for both SourceLocations
/// are part of the same file buffer.
///
/// This check ignores line marker directives.
bool isWrittenInSameFile(SourceLocation Loc1, SourceLocation Loc2) const {
  return getFileID(Loc1) == getFileID(Loc2);
}

/// Returns true if the spelling location for the given location
/// is in the main file buffer.
///
/// This check ignores line marker directives.
bool isWrittenInMainFile(SourceLocation Loc) const {
  return getFileID(Loc) == getMainFileID();
}

/// Returns whether \p Loc is located in a <built-in> file.
bool isWrittenInBuiltinFile(SourceLocation Loc) const {
  StringRef Filename(getPresumedLoc(Loc).getFilename());
  return Filename.equals("<built-in>");
}

/// Returns whether \p Loc is located in a <command line> file.
bool isWrittenInCommandLineFile(SourceLocation Loc) const {
  StringRef Filename(getPresumedLoc(Loc).getFilename());
  return Filename.equals("<command line>");
}

/// Returns whether \p Loc is located in a <scratch space> file.
bool isWrittenInScratchSpace(SourceLocation Loc) const {
  StringRef Filename(getPresumedLoc(Loc).getFilename());
  return Filename.equals("<scratch space>");
}

/// Returns if a SourceLocation is in a system header.
bool isInSystemHeader(SourceLocation Loc) const {
  return isSystem(getFileCharacteristic(Loc));
}

/// Returns if a SourceLocation is in an "extern C" system header.
bool isInExternCSystemHeader(SourceLocation Loc) const {
  return getFileCharacteristic(Loc) == SrcMgr::C_ExternCSystem;
}

/// Returns whether \p Loc is expanded from a macro in a system header.
bool isInSystemMacro(SourceLocation loc) const {
  if (!loc.isMacroID())
    return false;

  // This happens when the macro is the result of a paste, in that case
  // its spelling is the scratch memory, so we take the parent context.
  // There can be several level of token pasting.
  if (isWrittenInScratchSpace(getSpellingLoc(loc))) {
    do {
      loc = getImmediateMacroCallerLoc(loc);
    } while (isWrittenInScratchSpace(getSpellingLoc(loc)));
    return isInSystemMacro(loc);
  }

  return isInSystemHeader(getSpellingLoc(loc));
}

/// The size of the SLocEntry that \p FID represents.
unsigned getFileIDSize(FileID FID) const;

/// Given a specific FileID, returns true if \p Loc is inside that
/// FileID chunk and sets relative offset (offset of \p Loc from beginning
/// of FileID) to \p relativeOffset.
bool isInFileID(SourceLocation Loc, FileID FID,
                unsigned *RelativeOffset = nullptr) const {
  SourceLocation::UIntTy Offs = Loc.getOffset();
  if (isOffsetInFileID(FID, Offs)) {
    if (RelativeOffset)
      *RelativeOffset = Offs - getSLocEntry(FID).getOffset();
    return true;
  }

  return false;
}

//===--------------------------------------------------------------------===//
// Line Table Manipulation Routines
//===--------------------------------------------------------------------===//

/// Return the uniqued ID for the specified filename.
unsigned getLineTableFilenameID(StringRef Str);

/// Add a line note to the line table for the FileID and offset
/// specified by Loc.
///
/// If FilenameID is -1, it is considered to be unspecified.
void AddLineNote(SourceLocation Loc, unsigned LineNo, int FilenameID,
                 bool IsFileEntry, bool IsFileExit,
                 SrcMgr::CharacteristicKind FileKind);

/// Determine if the source manager has a line table.
bool hasLineTable() const { return LineTable != nullptr; }

/// Retrieve the stored line table.
LineTableInfo &getLineTable();

//===--------------------------------------------------------------------===//
// Queries for performance analysis.
//===--------------------------------------------------------------------===//

/// Return the total amount of physical memory allocated by the
/// ContentCache allocator.
size_t getContentCacheSize() const {
  return ContentCacheAlloc.getTotalMemory();
}

struct MemoryBufferSizes {
  const size_t malloc_bytes;
  const size_t mmap_bytes;

  MemoryBufferSizes(size_t malloc_bytes, size_t mmap_bytes)
    : malloc_bytes(malloc_bytes), mmap_bytes(mmap_bytes) {}
};

/// Return the amount of memory used by memory buffers, breaking down
/// by heap-backed versus mmap'ed memory.
MemoryBufferSizes getMemoryBufferSizes() const;

/// Return the amount of memory used for various side tables and
/// data structures in the SourceManager.
size_t getDataStructureSizes() const;

//===--------------------------------------------------------------------===//
// Other miscellaneous methods.
//===--------------------------------------------------------------------===//

/// Get the source location for the given file:line:col triplet.
///
/// If the source file is included multiple times, the source location will
/// be based upon the first inclusion.
SourceLocation translateFileLineCol(const FileEntry *SourceFile,
                                    unsigned Line, unsigned Col) const;

/// Get the FileID for the given file.
///
/// If the source file is included multiple times, the FileID will be the
/// first inclusion.
FileID translateFile(const FileEntry *SourceFile) const;
FileID translateFile(FileEntryRef SourceFile) const {
  return translateFile(&SourceFile.getFileEntry());
}

/// Get the source location in \p FID for the given line:col.
/// Returns null location if \p FID is not a file SLocEntry.
SourceLocation translateLineCol(FileID FID,
                                unsigned Line, unsigned Col) const;

/// If \p Loc points inside a function macro argument, the returned
/// location will be the macro location in which the argument was expanded.
/// If a macro argument is used multiple times, the expanded location will
/// be at the first expansion of the argument.
/// e.g.
///   MY_MACRO(foo);
///             ^
/// Passing a file location pointing at 'foo', will yield a macro location
/// where 'foo' was expanded into.
SourceLocation getMacroArgExpandedLocation(SourceLocation Loc) const;

/// Determines the order of 2 source locations in the translation unit.
///
/// \returns true if LHS source location comes before RHS, false otherwise.
bool isBeforeInTranslationUnit(SourceLocation LHS, SourceLocation RHS) const;

/// Determines whether the two decomposed source location is in the
///        same translation unit. As a byproduct, it also calculates the order
///        of the source locations in case they are in the same TU.
///
/// \returns Pair of bools the first component is true if the two locations
///          are in the same TU. The second bool is true if the first is true
///          and \p LOffs is before \p ROffs.
std::pair<bool, bool>
isInTheSameTranslationUnit(std::pair<FileID, unsigned> &LOffs,
                           std::pair<FileID, unsigned> &ROffs) const;

/// Determines the order of 2 source locations in the "source location
/// address space".
bool isBeforeInSLocAddrSpace(SourceLocation LHS, SourceLocation RHS) const {
  return isBeforeInSLocAddrSpace(LHS, RHS.getOffset());
}

/// Determines the order of a source location and a source location
/// offset in the "source location address space".
///
/// Note that we always consider source locations loaded from
bool isBeforeInSLocAddrSpace(SourceLocation LHS,
                             SourceLocation::UIntTy RHS) const {
  SourceLocation::UIntTy LHSOffset = LHS.getOffset();
  bool LHSLoaded = LHSOffset >= CurrentLoadedOffset;
  bool RHSLoaded = RHS >= CurrentLoadedOffset;
  if (LHSLoaded == RHSLoaded)
    return LHSOffset < RHS;

  return LHSLoaded;
}

/// Return true if the Point is within Start and End.
bool isPointWithin(SourceLocation Location, SourceLocation Start,
                   SourceLocation End) const {
  return Location == Start || Location == End ||
         (isBeforeInTranslationUnit(Start, Location) &&
          isBeforeInTranslationUnit(Location, End));
}

// Iterators over FileInfos.
using fileinfo_iterator =
    llvm::DenseMap<const FileEntry*, SrcMgr::ContentCache*>::const_iterator;

fileinfo_iterator fileinfo_begin() const { return FileInfos.begin(); }
fileinfo_iterator fileinfo_end() const { return FileInfos.end(); }
bool hasFileInfo(const FileEntry *File) const {
  return FileInfos.find(File) != FileInfos.end();
}

/// Print statistics to stderr.
void PrintStats() const;

void dump() const;

/// Get the number of local SLocEntries we have.
unsigned local_sloc_entry_size() const { return LocalSLocEntryTable.size(); }

/// Get a local SLocEntry. This is exposed for indexing.
const SrcMgr::SLocEntry &getLocalSLocEntry(unsigned Index) const {
  assert(Index < LocalSLocEntryTable.size() && "Invalid index")(static_cast<void> (0));
  return LocalSLocEntryTable[Index];
}

/// Get the number of loaded SLocEntries we have.
unsigned loaded_sloc_entry_size() const { return LoadedSLocEntryTable.size();}

/// Get a loaded SLocEntry. This is exposed for indexing.
const SrcMgr::SLocEntry &getLoadedSLocEntry(unsigned Index,
                                            bool *Invalid = nullptr) const {
  assert(Index < LoadedSLocEntryTable.size() && "Invalid index")(static_cast<void> (0));
  if (SLocEntryLoaded[Index])
    return LoadedSLocEntryTable[Index];
  return loadSLocEntry(Index, Invalid);
}

const SrcMgr::SLocEntry &getSLocEntry(FileID FID,
                                      bool *Invalid = nullptr) const {
  if (FID.ID == 0 || FID.ID == -1) {
    if (Invalid) *Invalid = true;
    return LocalSLocEntryTable[0];
  }
  return getSLocEntryByID(FID.ID, Invalid);
}

SourceLocation::UIntTy getNextLocalOffset() const { return NextLocalOffset; }

void setExternalSLocEntrySource(ExternalSLocEntrySource *Source) {
  assert(LoadedSLocEntryTable.empty() &&(static_cast<void> (0))
         "Invalidating existing loaded entries")(static_cast<void> (0));
  ExternalSLocEntries = Source;
}

/// Allocate a number of loaded SLocEntries, which will be actually
/// loaded on demand from the external source.
///
/// NumSLocEntries will be allocated, which occupy a total of TotalSize space
/// in the global source view. The lowest ID and the base offset of the
/// entries will be returned.
std::pair<int, SourceLocation::UIntTy>
AllocateLoadedSLocEntries(unsigned NumSLocEntries,
                          SourceLocation::UIntTy TotalSize);

/// Returns true if \p Loc came from a PCH/Module.
bool isLoadedSourceLocation(SourceLocation Loc) const {
  return Loc.getOffset() >= CurrentLoadedOffset;
}

/// Returns true if \p Loc did not come from a PCH/Module.
bool isLocalSourceLocation(SourceLocation Loc) const {
  return Loc.getOffset() < NextLocalOffset;
}

/// Returns true if \p FID came from a PCH/Module.
bool isLoadedFileID(FileID FID) const {
  assert(FID.ID != -1 && "Using FileID sentinel value")(static_cast<void> (0));
  return FID.ID < 0;
}

/// Returns true if \p FID did not come from a PCH/Module.
bool isLocalFileID(FileID FID) const {
  return !isLoadedFileID(FID);
}

/// Gets the location of the immediate macro caller, one level up the stack
/// toward the initial macro typed into the source.
SourceLocation getImmediateMacroCallerLoc(SourceLocation Loc) const {
  if (!Loc.isMacroID()) return Loc;

  // When we have the location of (part of) an expanded parameter, its
  // spelling location points to the argument as expanded in the macro call,
  // and therefore is used to locate the macro caller.
  if (isMacroArgExpansion(Loc))
    return getImmediateSpellingLoc(Loc);

  // Otherwise, the caller of the macro is located where this macro is
  // expanded (while the spelling is part of the macro definition).
  return getImmediateExpansionRange(Loc).getBegin();
}

/// \return Location of the top-level macro caller.
SourceLocation getTopMacroCallerLoc(SourceLocation Loc) const;

1764private:
friend class ASTReader;
friend class ASTWriter;

llvm::MemoryBufferRef getFakeBufferForRecovery() const;
SrcMgr::ContentCache &getFakeContentCacheForRecovery() const;

const SrcMgr::SLocEntry &loadSLocEntry(unsigned Index, bool *Invalid) const;

const SrcMgr::SLocEntry *getSLocEntryOrNull(FileID FID) const {
  bool Invalid = false;
  const SrcMgr::SLocEntry &Entry = getSLocEntry(FID, &Invalid);
  return Invalid ? nullptr : &Entry;
}

const SrcMgr::SLocEntry *getSLocEntryForFile(FileID FID) const {
  if (auto *Entry = getSLocEntryOrNull(FID))
    if (Entry->isFile())
      return Entry;
  return nullptr;
}

/// Get the entry with the given unwrapped FileID.
/// Invalid will not be modified for Local IDs.
const SrcMgr::SLocEntry &getSLocEntryByID(int ID,
                                          bool *Invalid = nullptr) const {
  assert(ID != -1 && "Using FileID sentinel value")(static_cast<void> (0));
  if (ID < 0)
    return getLoadedSLocEntryByID(ID, Invalid);
  return getLocalSLocEntry(static_cast<unsigned>(ID));
}

const SrcMgr::SLocEntry &
getLoadedSLocEntryByID(int ID, bool *Invalid = nullptr) const {
  return getLoadedSLocEntry(static_cast<unsigned>(-ID - 2), Invalid);
}

/// Implements the common elements of storing an expansion info struct into
/// the SLocEntry table and producing a source location that refers to it.
SourceLocation
createExpansionLocImpl(const SrcMgr::ExpansionInfo &Expansion,
                       unsigned TokLength, int LoadedID = 0,
                       SourceLocation::UIntTy LoadedOffset = 0);

/// Return true if the specified FileID contains the
/// specified SourceLocation offset.  This is a very hot method.
inline bool isOffsetInFileID(FileID FID,
                             SourceLocation::UIntTy SLocOffset) const {
  const SrcMgr::SLocEntry &Entry = getSLocEntry(FID);
  // If the entry is after the offset, it can't contain it.
  if (SLocOffset < Entry.getOffset()) return false;

  // If this is the very last entry then it does.
  if (FID.ID == -2)
    return true;

  // If it is the last local entry, then it does if the location is local.
  if (FID.ID+1 == static_cast<int>(LocalSLocEntryTable.size()))
    return SLocOffset < NextLocalOffset;

  // Otherwise, the entry after it has to not include it. This works for both
  // local and loaded entries.
  return SLocOffset < getSLocEntryByID(FID.ID+1).getOffset();
}

/// Returns the previous in-order FileID or an invalid FileID if there
/// is no previous one.
FileID getPreviousFileID(FileID FID) const;

/// Returns the next in-order FileID or an invalid FileID if there is
/// no next one.
FileID getNextFileID(FileID FID) const;

/// Create a new fileID for the specified ContentCache and
/// include position.
///
/// This works regardless of whether the ContentCache corresponds to a
/// file or some other input source.
FileID createFileIDImpl(SrcMgr::ContentCache &File, StringRef Filename,
                        SourceLocation IncludePos,
                        SrcMgr::CharacteristicKind DirCharacter, int LoadedID,
                        SourceLocation::UIntTy LoadedOffset);

SrcMgr::ContentCache &getOrCreateContentCache(FileEntryRef SourceFile,
                                              bool isSystemFile = false);

/// Create a new ContentCache for the specified  memory buffer.
SrcMgr::ContentCache &
createMemBufferContentCache(std::unique_ptr<llvm::MemoryBuffer> Buf);

FileID getFileIDSlow(SourceLocation::UIntTy SLocOffset) const;
FileID getFileIDLocal(SourceLocation::UIntTy SLocOffset) const;
FileID getFileIDLoaded(SourceLocation::UIntTy SLocOffset) const;

SourceLocation getExpansionLocSlowCase(SourceLocation Loc) const;
SourceLocation getSpellingLocSlowCase(SourceLocation Loc) const;
SourceLocation getFileLocSlowCase(SourceLocation Loc) const;

std::pair<FileID, unsigned>
getDecomposedExpansionLocSlowCase(const SrcMgr::SLocEntry *E) const;
std::pair<FileID, unsigned>
getDecomposedSpellingLocSlowCase(const SrcMgr::SLocEntry *E,
                                 unsigned Offset) const;
void computeMacroArgsCache(MacroArgsMap &MacroArgsCache, FileID FID) const;
void associateFileChunkWithMacroArgExp(MacroArgsMap &MacroArgsCache,
                                       FileID FID,
                                       SourceLocation SpellLoc,
                                       SourceLocation ExpansionLoc,
                                       unsigned ExpansionLength) const;
1873};

1875/// Comparison function object.
1876template<typename T>
1877class BeforeThanCompare;

1879/// Compare two source locations.
1880template<>
1881class BeforeThanCompare<SourceLocation> {
SourceManager &SM;

1884public:
explicit BeforeThanCompare(SourceManager &SM) : SM(SM) {}

bool operator()(SourceLocation LHS, SourceLocation RHS) const {
  return SM.isBeforeInTranslationUnit(LHS, RHS);
}
1890};

1892/// Compare two non-overlapping source ranges.
1893template<>
1894class BeforeThanCompare<SourceRange> {
SourceManager &SM;

1897public:
explicit BeforeThanCompare(SourceManager &SM) : SM(SM) {}

bool operator()(SourceRange LHS, SourceRange RHS) const {
  return SM.isBeforeInTranslationUnit(LHS.getBegin(), RHS.getBegin());
}
1903};

1905/// SourceManager and necessary depdencies (e.g. VFS, FileManager) for a single
1906/// in-memorty file.
1907class SourceManagerForFile {
1908public:
/// Creates SourceManager and necessary depdencies (e.g. VFS, FileManager).
/// The main file in the SourceManager will be \p FileName with \p Content.
SourceManagerForFile(StringRef FileName, StringRef Content);

SourceManager &get() {
  assert(SourceMgr)(static_cast<void> (0));
  return *SourceMgr;
}

1918private:
// The order of these fields are important - they should be in the same order
// as they are created in `createSourceManagerForFile` so that they can be
// deleted in the reverse order as they are created.
std::unique_ptr<FileManager> FileMgr;
std::unique_ptr<DiagnosticsEngine> Diagnostics;
std::unique_ptr<SourceManager> SourceMgr;
1925};

1927} // namespace clang

1929#endif // LLVM_CLANG_BASIC_SOURCEMANAGER_H

←

/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/llvm/include/llvm/ADT/Optional.h

→

1//===- Optional.h - Simple variant for passing optional values --*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9//  This file provides Optional, a template class modeled in the spirit of
10//  OCaml's 'opt' variant.  The idea is to strongly type whether or not
11//  a value can be optional.
12//
13//===----------------------------------------------------------------------===//
14 
15#ifndef LLVM_ADT_OPTIONAL_H
16#define LLVM_ADT_OPTIONAL_H
17 
18#include "llvm/ADT/Hashing.h"
19#include "llvm/ADT/None.h"
20#include "llvm/ADT/STLForwardCompat.h"
21#include "llvm/Support/Compiler.h"
22#include "llvm/Support/type_traits.h"
23#include <cassert>
24#include <memory>
25#include <new>
26#include <utility>
27 
28namespace llvm {
29 
30class raw_ostream;
31 
32namespace optional_detail {
33 
34/// Storage for any type.
35//
36// The specialization condition intentionally uses
37// llvm::is_trivially_copy_constructible instead of
38// std::is_trivially_copy_constructible.  GCC versions prior to 7.4 may
39// instantiate the copy constructor of `T` when
40// std::is_trivially_copy_constructible is instantiated.  This causes
41// compilation to fail if we query the trivially copy constructible property of
42// a class which is not copy constructible.
43//
44// The current implementation of OptionalStorage insists that in order to use
45// the trivial specialization, the value_type must be trivially copy
46// constructible and trivially copy assignable due to =default implementations
47// of the copy/move constructor/assignment.  It does not follow that this is
48// necessarily the case std::is_trivially_copyable is true (hence the expanded
49// specialization condition).
50//
51// The move constructible / assignable conditions emulate the remaining behavior
52// of std::is_trivially_copyable.
53template <typename T, bool = (llvm::is_trivially_copy_constructible<T>::value &&
54                              std::is_trivially_copy_assignable<T>::value &&
55                              (std::is_trivially_move_constructible<T>::value ||
56                               !std::is_move_constructible<T>::value) &&
57                              (std::is_trivially_move_assignable<T>::value ||
58                               !std::is_move_assignable<T>::value))>
59class OptionalStorage {
60  union {
61    char empty;
62    T value;
63  };
64  bool hasVal;
65 
66public:
67  ~OptionalStorage() { reset(); }
68 
69  constexpr OptionalStorage() noexcept : empty(), hasVal(false) {}
70 
71  constexpr OptionalStorage(OptionalStorage const &other) : OptionalStorage() {
72    if (other.hasValue()) {
73      emplace(other.value);
74    }
75  }
76  constexpr OptionalStorage(OptionalStorage &&other) : OptionalStorage() {
77    if (other.hasValue()) {
78      emplace(std::move(other.value));
79    }
80  }
81 
82  template <class... Args>
83  constexpr explicit OptionalStorage(in_place_t, Args &&... args)
84      : value(std::forward<Args>(args)...), hasVal(true) {}
85 
86  void reset() noexcept {
87    if (hasVal) {
88      value.~T();
89      hasVal = false;
90    }
91  }
92 
93  constexpr bool hasValue() const noexcept { return hasVal; }
94 
95  T &getValue() LLVM_LVALUE_FUNCTION& noexcept {
96    assert(hasVal)(static_cast<void> (0));
97    return value;
98  }
99  constexpr T const &getValue() const LLVM_LVALUE_FUNCTION& noexcept {
100    assert(hasVal)(static_cast<void> (0));
101    return value;
102  }
103#if LLVM_HAS_RVALUE_REFERENCE_THIS1
104  T &&getValue() && noexcept {
105    assert(hasVal)(static_cast<void> (0));
106    return std::move(value);
107  }
108#endif
109 
110  template <class... Args> void emplace(Args &&... args) {
111    reset();
112    ::new ((void *)std::addressof(value)) T(std::forward<Args>(args)...);
113    hasVal = true;
114  }
115 
116  OptionalStorage &operator=(T const &y) {
117    if (hasValue()) {
118      value = y;
119    } else {
120      ::new ((void *)std::addressof(value)) T(y);
121      hasVal = true;
122    }
123    return *this;
124  }
125  OptionalStorage &operator=(T &&y) {
126    if (hasValue()) {
127      value = std::move(y);
128    } else {
129      ::new ((void *)std::addressof(value)) T(std::move(y));
130      hasVal = true;
131    }
132    return *this;
133  }
134 
135  OptionalStorage &operator=(OptionalStorage const &other) {
136    if (other.hasValue()) {
137      if (hasValue()) {
138        value = other.value;
139      } else {
140        ::new ((void *)std::addressof(value)) T(other.value);
141        hasVal = true;
142      }
143    } else {
144      reset();
145    }
146    return *this;
147  }
148 
149  OptionalStorage &operator=(OptionalStorage &&other) {
150    if (other.hasValue()) {
151      if (hasValue()) {
152        value = std::move(other.value);
153      } else {
154        ::new ((void *)std::addressof(value)) T(std::move(other.value));
155        hasVal = true;
156      }
157    } else {
158      reset();
159    }
160    return *this;
161  }
162};
163 
164template <typename T> class OptionalStorage<T, true> {
165  union {
166    char empty;
167    T value;
168  };
169  bool hasVal = false;
170 
171public:
172  ~OptionalStorage() = default;
173 
174  constexpr OptionalStorage() noexcept : empty{} {}
175 
176  constexpr OptionalStorage(OptionalStorage const &other) = default;
177  constexpr OptionalStorage(OptionalStorage &&other) = default;
178 
179  OptionalStorage &operator=(OptionalStorage const &other) = default;
180  OptionalStorage &operator=(OptionalStorage &&other) = default;
181 
182  template <class... Args>
183  constexpr explicit OptionalStorage(in_place_t, Args &&... args)
184      : value(std::forward<Args>(args)...), hasVal(true) {}
185 
186  void reset() noexcept {
187    if (hasVal) {
188      value.~T();
189      hasVal = false;
190    }
191  }
192 
193  constexpr bool hasValue() const noexcept { return hasVal; }
194 
195  T &getValue() LLVM_LVALUE_FUNCTION& noexcept {
196    assert(hasVal)(static_cast<void> (0));
197    return value;
198  }
199  constexpr T const &getValue() const LLVM_LVALUE_FUNCTION& noexcept {
200    assert(hasVal)(static_cast<void> (0));
201    return value;
202  }
203#if LLVM_HAS_RVALUE_REFERENCE_THIS1
204  T &&getValue() && noexcept {
205    assert(hasVal)(static_cast<void> (0));
206    return std::move(value);
207  }
208#endif
209 
210  template <class... Args> void emplace(Args &&... args) {
211    reset();
212    ::new ((void *)std::addressof(value)) T(std::forward<Args>(args)...);
213    hasVal = true;
214  }
215 
216  OptionalStorage &operator=(T const &y) {
217    if (hasValue()) {
218      value = y;
219    } else {
220      ::new ((void *)std::addressof(value)) T(y);
221      hasVal = true;
222    }
223    return *this;
224  }
225  OptionalStorage &operator=(T &&y) {
226    if (hasValue()) {
227      value = std::move(y);
228    } else {
229      ::new ((void *)std::addressof(value)) T(std::move(y));
230      hasVal = true;
231    }
232    return *this;
233  }
234};
235 
236} // namespace optional_detail
237 
238template <typename T> class Optional {
239  optional_detail::OptionalStorage<T> Storage;
240 
241public:
242  using value_type = T;
243 
244  constexpr Optional() {}
245  constexpr Optional(NoneType) {}
9
←
Calling defaulted default constructor for 'OptionalStorage<clang::FileEntryRef, true>'→
15
←
Returning from default constructor for 'OptionalStorage<clang::FileEntryRef, true>'→
246 
247  constexpr Optional(const T &y) : Storage(in_place, y) {}
248  constexpr Optional(const Optional &O) = default;
249 
250  constexpr Optional(T &&y) : Storage(in_place, std::move(y)) {}
251  constexpr Optional(Optional &&O) = default;
252 
253  template <typename... ArgTypes>
254  constexpr Optional(in_place_t, ArgTypes &&...Args)
255      : Storage(in_place, std::forward<ArgTypes>(Args)...) {}
256 
257  Optional &operator=(T &&y) {
258    Storage = std::move(y);
259    return *this;
260  }
261  Optional &operator=(Optional &&O) = default;
262 
263  /// Create a new object by constructing it in place with the given arguments.
264  template <typename... ArgTypes> void emplace(ArgTypes &&... Args) {
265    Storage.emplace(std::forward<ArgTypes>(Args)...);
266  }
267 
268  static constexpr Optional create(const T *y) {
269    return y ? Optional(*y) : Optional();
270  }
271 
272  Optional &operator=(const T &y) {
273    Storage = y;
274    return *this;
275  }
276  Optional &operator=(const Optional &O) = default;
277 
278  void reset() { Storage.reset(); }
279 
280  constexpr const T *getPointer() const { return &Storage.getValue(); }
281  T *getPointer() { return &Storage.getValue(); }
282  constexpr const T &getValue() const LLVM_LVALUE_FUNCTION& {
283    return Storage.getValue();
284  }
285  T &getValue() LLVM_LVALUE_FUNCTION& { return Storage.getValue(); }
286 
287  constexpr explicit operator bool() const { return hasValue(); }
288  constexpr bool hasValue() const { return Storage.hasValue(); }
289  constexpr const T *operator->() const { return getPointer(); }
290  T *operator->() { return getPointer(); }
291  constexpr const T &operator*() const LLVM_LVALUE_FUNCTION& {
292    return getValue();
293  }
294  T &operator*() LLVM_LVALUE_FUNCTION& { return getValue(); }
295 
296  template <typename U>
297  constexpr T getValueOr(U &&value) const LLVM_LVALUE_FUNCTION& {
298    return hasValue() ? getValue() : std::forward<U>(value);
299  }
300 
301  /// Apply a function to the value if present; otherwise return None.
302  template <class Function>
303  auto map(const Function &F) const LLVM_LVALUE_FUNCTION&
304      -> Optional<decltype(F(getValue()))> {
305    if (*this) return F(getValue());
306    return None;
307  }
308 
309#if LLVM_HAS_RVALUE_REFERENCE_THIS1
310  T &&getValue() && { return std::move(Storage.getValue()); }
311  T &&operator*() && { return std::move(Storage.getValue()); }
312 
313  template <typename U>
314  T getValueOr(U &&value) && {
315    return hasValue() ? std::move(getValue()) : std::forward<U>(value);
316  }
317 
318  /// Apply a function to the value if present; otherwise return None.
319  template <class Function>
320  auto map(const Function &F) &&
321      -> Optional<decltype(F(std::move(*this).getValue()))> {
322    if (*this) return F(std::move(*this).getValue());
323    return None;
324  }
325#endif
326};
327 
328template <class T> llvm::hash_code hash_value(const Optional<T> &O) {
329  return O ? hash_combine(true, *O) : hash_value(false);
330}
331 
332template <typename T, typename U>
333constexpr bool operator==(const Optional<T> &X, const Optional<U> &Y) {
334  if (X && Y)
335    return *X == *Y;
336  return X.hasValue() == Y.hasValue();
337}
338 
339template <typename T, typename U>
340constexpr bool operator!=(const Optional<T> &X, const Optional<U> &Y) {
341  return !(X == Y);
342}
343 
344template <typename T, typename U>
345constexpr bool operator<(const Optional<T> &X, const Optional<U> &Y) {
346  if (X && Y)
347    return *X < *Y;
348  return X.hasValue() < Y.hasValue();
349}
350 
351template <typename T, typename U>
352constexpr bool operator<=(const Optional<T> &X, const Optional<U> &Y) {
353  return !(Y < X);
354}
355 
356template <typename T, typename U>
357constexpr bool operator>(const Optional<T> &X, const Optional<U> &Y) {
358  return Y < X;
359}
360 
361template <typename T, typename U>
362constexpr bool operator>=(const Optional<T> &X, const Optional<U> &Y) {
363  return !(X < Y);
364}
365 
366template <typename T>
367constexpr bool operator==(const Optional<T> &X, NoneType) {
368  return !X;
369}
370 
371template <typename T>
372constexpr bool operator==(NoneType, const Optional<T> &X) {
373  return X == None;
374}
375 
376template <typename T>
377constexpr bool operator!=(const Optional<T> &X, NoneType) {
378  return !(X == None);
379}
380 
381template <typename T>
382constexpr bool operator!=(NoneType, const Optional<T> &X) {
383  return X != None;
384}
385 
386template <typename T> constexpr bool operator<(const Optional<T> &, NoneType) {
387  return false;
388}
389 
390template <typename T> constexpr bool operator<(NoneType, const Optional<T> &X) {
391  return X.hasValue();
392}
393 
394template <typename T>
395constexpr bool operator<=(const Optional<T> &X, NoneType) {
396  return !(None < X);
397}
398 
399template <typename T>
400constexpr bool operator<=(NoneType, const Optional<T> &X) {
401  return !(X < None);
402}
403 
404template <typename T> constexpr bool operator>(const Optional<T> &X, NoneType) {
405  return None < X;
406}
407 
408template <typename T> constexpr bool operator>(NoneType, const Optional<T> &X) {
409  return X < None;
410}
411 
412template <typename T>
413constexpr bool operator>=(const Optional<T> &X, NoneType) {
414  return None <= X;
415}
416 
417template <typename T>
418constexpr bool operator>=(NoneType, const Optional<T> &X) {
419  return X <= None;
420}
421 
422template <typename T>
423constexpr bool operator==(const Optional<T> &X, const T &Y) {
424  return X && *X == Y;
425}
426 
427template <typename T>
428constexpr bool operator==(const T &X, const Optional<T> &Y) {
429  return Y && X == *Y;
430}
431 
432template <typename T>
433constexpr bool operator!=(const Optional<T> &X, const T &Y) {
434  return !(X == Y);
435}
436 
437template <typename T>
438constexpr bool operator!=(const T &X, const Optional<T> &Y) {
439  return !(X == Y);
440}
441 
442template <typename T>
443constexpr bool operator<(const Optional<T> &X, const T &Y) {
444  return !X || *X < Y;
445}
446 
447template <typename T>
448constexpr bool operator<(const T &X, const Optional<T> &Y) {
449  return Y && X < *Y;
450}
451 
452template <typename T>
453constexpr bool operator<=(const Optional<T> &X, const T &Y) {
454  return !(Y < X);
455}
456 
457template <typename T>
458constexpr bool operator<=(const T &X, const Optional<T> &Y) {
459  return !(Y < X);
460}
461 
462template <typename T>
463constexpr bool operator>(const Optional<T> &X, const T &Y) {
464  return Y < X;
465}
466 
467template <typename T>
468constexpr bool operator>(const T &X, const Optional<T> &Y) {
469  return Y < X;
470}
471 
472template <typename T>
473constexpr bool operator>=(const Optional<T> &X, const T &Y) {
474  return !(X < Y);
475}
476 
477template <typename T>
478constexpr bool operator>=(const T &X, const Optional<T> &Y) {
479  return !(X < Y);
480}
481 
482raw_ostream &operator<<(raw_ostream &OS, NoneType);
483 
484template <typename T, typename = decltype(std::declval<raw_ostream &>()
485                                          << std::declval<const T &>())>
486raw_ostream &operator<<(raw_ostream &OS, const Optional<T> &O) {
487  if (O)
488    OS << *O;
489  else
490    OS << None;
491  return OS;
492}
493 
494} // end namespace llvm
495 
496#endif // LLVM_ADT_OPTIONAL_H

←

/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/include/clang/Basic/FileEntry.h

→

1//===- clang/Basic/FileEntry.h - File references ----------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// \file
10/// Defines interfaces for clang::FileEntry and clang::FileEntryRef.
11///
12//===----------------------------------------------------------------------===//

14#ifndef LLVM_CLANG_BASIC_FILEENTRY_H
15#define LLVM_CLANG_BASIC_FILEENTRY_H

17#include "clang/Basic/DirectoryEntry.h"
18#include "clang/Basic/LLVM.h"
19#include "llvm/ADT/DenseMapInfo.h"
20#include "llvm/ADT/Hashing.h"
21#include "llvm/ADT/PointerUnion.h"
22#include "llvm/ADT/StringMap.h"
23#include "llvm/ADT/StringRef.h"
24#include "llvm/Support/ErrorOr.h"
25#include "llvm/Support/FileSystem/UniqueID.h"

27namespace llvm {

29class MemoryBuffer;

31namespace vfs {

33class File;

35} // namespace vfs
36} // namespace llvm

38namespace clang {

40class FileEntryRef;

42} // namespace clang

44namespace llvm {
45namespace optional_detail {

47/// Forward declare a template specialization for OptionalStorage.
48template <>
49class OptionalStorage<clang::FileEntryRef, /*is_trivially_copyable*/ true>;

51} // namespace optional_detail
52} // namespace llvm

54namespace clang {

56class FileEntry;

58/// A reference to a \c FileEntry that includes the name of the file as it was
59/// accessed by the FileManager's client.
60class FileEntryRef {
61public:
StringRef getName() const { return ME->first(); }
19
←
Called C++ object pointer is null
const FileEntry &getFileEntry() const {
  return *ME->second->V.get<FileEntry *>();
}
DirectoryEntryRef getDir() const { return *ME->second->Dir; }

inline bool isValid() const;
inline off_t getSize() const;
inline unsigned getUID() const;
inline const llvm::sys::fs::UniqueID &getUniqueID() const;
inline time_t getModificationTime() const;
inline bool isNamedPipe() const;
inline void closeFile() const;

/// Check if the underlying FileEntry is the same, intentially ignoring
/// whether the file was referenced with the same spelling of the filename.
friend bool operator==(const FileEntryRef &LHS, const FileEntryRef &RHS) {
  return &LHS.getFileEntry() == &RHS.getFileEntry();
}
friend bool operator==(const FileEntry *LHS, const FileEntryRef &RHS) {
  return LHS == &RHS.getFileEntry();
}
friend bool operator==(const FileEntryRef &LHS, const FileEntry *RHS) {
  return &LHS.getFileEntry() == RHS;
}
friend bool operator!=(const FileEntryRef &LHS, const FileEntryRef &RHS) {
  return !(LHS == RHS);
}
friend bool operator!=(const FileEntry *LHS, const FileEntryRef &RHS) {
  return !(LHS == RHS);
}
friend bool operator!=(const FileEntryRef &LHS, const FileEntry *RHS) {
  return !(LHS == RHS);
}

/// Hash code is based on the FileEntry, not the specific named reference,
/// just like operator==.
friend llvm::hash_code hash_value(FileEntryRef Ref) {
  return llvm::hash_value(&Ref.getFileEntry());
}

struct MapValue;

/// Type used in the StringMap.
using MapEntry = llvm::StringMapEntry<llvm::ErrorOr<MapValue>>;

/// Type stored in the StringMap.
struct MapValue {
  /// The pointer at another MapEntry is used when the FileManager should
  /// silently forward from one name to another, which occurs in Redirecting
  /// VFSs that use external names. In that case, the \c FileEntryRef
  /// returned by the \c FileManager will have the external name, and not the
  /// name that was used to lookup the file.
  ///
  /// The second type is really a `const MapEntry *`, but that confuses
  /// gcc5.3.  Once that's no longer supported, change this back.
  llvm::PointerUnion<FileEntry *, const void *> V;

  /// Directory the file was found in. Set if and only if V is a FileEntry.
  Optional<DirectoryEntryRef> Dir;

  MapValue() = delete;
  MapValue(FileEntry &FE, DirectoryEntryRef Dir) : V(&FE), Dir(Dir) {}
  MapValue(MapEntry &ME) : V(&ME) {}
};

/// Check if RHS referenced the file in exactly the same way.
bool isSameRef(const FileEntryRef &RHS) const { return ME == RHS.ME; }

/// Allow FileEntryRef to degrade into 'const FileEntry*' to facilitate
/// incremental adoption.
///
/// The goal is to avoid code churn due to dances like the following:
/// \code
/// // Old code.
/// lvalue = rvalue;
///
/// // Temporary code from an incremental patch.
/// lvalue = &rvalue.getFileEntry();
///
/// // Final code.
/// lvalue = rvalue;
/// \endcode
///
/// FIXME: Once FileEntryRef is "everywhere" and FileEntry::LastRef and
/// FileEntry::getName have been deleted, delete this implicit conversion.
operator const FileEntry *() const { return &getFileEntry(); }

FileEntryRef() = delete;
explicit FileEntryRef(const MapEntry &ME) : ME(&ME) {
  assert(ME.second && "Expected payload")(static_cast<void> (0));
  assert(ME.second->V && "Expected non-null")(static_cast<void> (0));
  assert(ME.second->V.is<FileEntry *>() && "Expected FileEntry")(static_cast<void> (0));
}

/// Expose the underlying MapEntry to simplify packing in a PointerIntPair or
/// PointerUnion and allow construction in Optional.
const clang::FileEntryRef::MapEntry &getMapEntry() const { return *ME; }

161private:
friend class FileMgr::MapEntryOptionalStorage<FileEntryRef>;
struct optional_none_tag {};

// Private constructor for use by OptionalStorage.
FileEntryRef(optional_none_tag) : ME(nullptr) {}
12
←
Null pointer value stored to 'file.Storage.MaybeRef.ME'→
bool hasOptionalValue() const { return ME; }

friend struct llvm::DenseMapInfo<FileEntryRef>;
struct dense_map_empty_tag {};
struct dense_map_tombstone_tag {};

// Private constructors for use by DenseMapInfo.
FileEntryRef(dense_map_empty_tag)
    : ME(llvm::DenseMapInfo<const MapEntry *>::getEmptyKey()) {}
FileEntryRef(dense_map_tombstone_tag)
    : ME(llvm::DenseMapInfo<const MapEntry *>::getTombstoneKey()) {}
bool isSpecialDenseMapKey() const {
  return isSameRef(FileEntryRef(dense_map_empty_tag())) ||
         isSameRef(FileEntryRef(dense_map_tombstone_tag()));
}

const MapEntry *ME;
184};

186static_assert(sizeof(FileEntryRef) == sizeof(const FileEntry *),
            "FileEntryRef must avoid size overhead");

189static_assert(std::is_trivially_copyable<FileEntryRef>::value,
            "FileEntryRef must be trivially copyable");

192} // end namespace clang

194namespace llvm {
195namespace optional_detail {

197/// Customize OptionalStorage<FileEntryRef> to use FileEntryRef and its
198/// optional_none_tag to keep it the size of a single pointer.
199template <>
200class OptionalStorage<clang::FileEntryRef>
  : public clang::FileMgr::MapEntryOptionalStorage<clang::FileEntryRef> {
using StorageImpl =
    clang::FileMgr::MapEntryOptionalStorage<clang::FileEntryRef>;

205public:
OptionalStorage() = default;
10
←
Calling default constructor for 'MapEntryOptionalStorage<clang::FileEntryRef>'→
14
←
Returning from default constructor for 'MapEntryOptionalStorage<clang::FileEntryRef>'→

template <class... ArgTypes>
explicit OptionalStorage(in_place_t, ArgTypes &&...Args)
    : StorageImpl(in_place_t{}, std::forward<ArgTypes>(Args)...) {}

OptionalStorage &operator=(clang::FileEntryRef Ref) {
  StorageImpl::operator=(Ref);
  return *this;
}
216};

218static_assert(sizeof(Optional<clang::FileEntryRef>) ==
                sizeof(clang::FileEntryRef),
            "Optional<FileEntryRef> must avoid size overhead");

222static_assert(std::is_trivially_copyable<Optional<clang::FileEntryRef>>::value,
            "Optional<FileEntryRef> should be trivially copyable");

225} // end namespace optional_detail

227/// Specialisation of DenseMapInfo for FileEntryRef.
228template <> struct DenseMapInfo<clang::FileEntryRef> {
static inline clang::FileEntryRef getEmptyKey() {
  return clang::FileEntryRef(clang::FileEntryRef::dense_map_empty_tag());
}

static inline clang::FileEntryRef getTombstoneKey() {
  return clang::FileEntryRef(clang::FileEntryRef::dense_map_tombstone_tag());
}

static unsigned getHashValue(clang::FileEntryRef Val) {
  return hash_value(Val);
}

static bool isEqual(clang::FileEntryRef LHS, clang::FileEntryRef RHS) {
  // Catch the easy cases: both empty, both tombstone, or the same ref.
  if (LHS.isSameRef(RHS))
    return true;

  // Confirm LHS and RHS are valid.
  if (LHS.isSpecialDenseMapKey() || RHS.isSpecialDenseMapKey())
    return false;

  // It's safe to use operator==.
  return LHS == RHS;
}
253};

255} // end namespace llvm

257namespace clang {

259/// Wrapper around Optional<FileEntryRef> that degrades to 'const FileEntry*',
260/// facilitating incremental patches to propagate FileEntryRef.
261///
262/// This class can be used as return value or field where it's convenient for
263/// an Optional<FileEntryRef> to degrade to a 'const FileEntry*'. The purpose
264/// is to avoid code churn due to dances like the following:
265/// \code
266/// // Old code.
267/// lvalue = rvalue;
268///
269/// // Temporary code from an incremental patch.
270/// Optional<FileEntryRef> MaybeF = rvalue;
271/// lvalue = MaybeF ? &MaybeF.getFileEntry() : nullptr;
272///
273/// // Final code.
274/// lvalue = rvalue;
275/// \endcode
276///
277/// FIXME: Once FileEntryRef is "everywhere" and FileEntry::LastRef and
278/// FileEntry::getName have been deleted, delete this class and replace
279/// instances with Optional<FileEntryRef>.
280class OptionalFileEntryRefDegradesToFileEntryPtr
  : public Optional<FileEntryRef> {
282public:
OptionalFileEntryRefDegradesToFileEntryPtr() = default;
OptionalFileEntryRefDegradesToFileEntryPtr(
    OptionalFileEntryRefDegradesToFileEntryPtr &&) = default;
OptionalFileEntryRefDegradesToFileEntryPtr(
    const OptionalFileEntryRefDegradesToFileEntryPtr &) = default;
OptionalFileEntryRefDegradesToFileEntryPtr &
operator=(OptionalFileEntryRefDegradesToFileEntryPtr &&) = default;
OptionalFileEntryRefDegradesToFileEntryPtr &
operator=(const OptionalFileEntryRefDegradesToFileEntryPtr &) = default;

OptionalFileEntryRefDegradesToFileEntryPtr(llvm::NoneType) {}
OptionalFileEntryRefDegradesToFileEntryPtr(FileEntryRef Ref)
    : Optional<FileEntryRef>(Ref) {}
OptionalFileEntryRefDegradesToFileEntryPtr(Optional<FileEntryRef> MaybeRef)
    : Optional<FileEntryRef>(MaybeRef) {}

OptionalFileEntryRefDegradesToFileEntryPtr &operator=(llvm::NoneType) {
  Optional<FileEntryRef>::operator=(None);
  return *this;
}
OptionalFileEntryRefDegradesToFileEntryPtr &operator=(FileEntryRef Ref) {
  Optional<FileEntryRef>::operator=(Ref);
  return *this;
}
OptionalFileEntryRefDegradesToFileEntryPtr &
operator=(Optional<FileEntryRef> MaybeRef) {
  Optional<FileEntryRef>::operator=(MaybeRef);
  return *this;
}

/// Degrade to 'const FileEntry *' to allow  FileEntry::LastRef and
/// FileEntry::getName have been deleted, delete this class and replace
/// instances with Optional<FileEntryRef>
operator const FileEntry *() const {
  return hasValue() ? &getValue().getFileEntry() : nullptr;
}
319};

321static_assert(
  std::is_trivially_copyable<
      OptionalFileEntryRefDegradesToFileEntryPtr>::value,
  "OptionalFileEntryRefDegradesToFileEntryPtr should be trivially copyable");

326/// Cached information about one file (either on disk
327/// or in the virtual file system).
328///
329/// If the 'File' member is valid, then this FileEntry has an open file
330/// descriptor for the file.
331class FileEntry {
friend class FileManager;

std::string RealPathName;   // Real path to the file; could be empty.
off_t Size = 0;             // File size in bytes.
time_t ModTime = 0;         // Modification time of file.
const DirectoryEntry *Dir = nullptr; // Directory file lives in.
llvm::sys::fs::UniqueID UniqueID;
unsigned UID = 0; // A unique (small) ID for the file.
bool IsNamedPipe = false;
bool IsValid = false; // Is this \c FileEntry initialized and valid?

/// The open file, if it is owned by the \p FileEntry.
mutable std::unique_ptr<llvm::vfs::File> File;

/// The file content, if it is owned by the \p FileEntry.
std::unique_ptr<llvm::MemoryBuffer> Content;

// First access name for this FileEntry.
//
// This is Optional only to allow delayed construction (FileEntryRef has no
// default constructor). It should always have a value in practice.
//
// TODO: remove this once everyone that needs a name uses FileEntryRef.
Optional<FileEntryRef> LastRef;

357public:
FileEntry();
~FileEntry();

FileEntry(const FileEntry &) = delete;
FileEntry &operator=(const FileEntry &) = delete;

StringRef getName() const { return LastRef->getName(); }
FileEntryRef getLastRef() const { return *LastRef; }

StringRef tryGetRealPathName() const { return RealPathName; }
bool isValid() const { return IsValid; }
off_t getSize() const { return Size; }
unsigned getUID() const { return UID; }
const llvm::sys::fs::UniqueID &getUniqueID() const { return UniqueID; }
time_t getModificationTime() const { return ModTime; }

/// Return the directory the file lives in.
const DirectoryEntry *getDir() const { return Dir; }

bool operator<(const FileEntry &RHS) const { return UniqueID < RHS.UniqueID; }

/// Check whether the file is a named pipe (and thus can't be opened by
/// the native FileManager methods).
bool isNamedPipe() const { return IsNamedPipe; }

void closeFile() const;
384};

386bool FileEntryRef::isValid() const { return getFileEntry().isValid(); }

388off_t FileEntryRef::getSize() const { return getFileEntry().getSize(); }

390unsigned FileEntryRef::getUID() const { return getFileEntry().getUID(); }

392const llvm::sys::fs::UniqueID &FileEntryRef::getUniqueID() const {
return getFileEntry().getUniqueID();
394}

396time_t FileEntryRef::getModificationTime() const {
return getFileEntry().getModificationTime();
398}

400bool FileEntryRef::isNamedPipe() const { return getFileEntry().isNamedPipe(); }

402void FileEntryRef::closeFile() const { getFileEntry().closeFile(); }

404} // end namespace clang

406#endif // LLVM_CLANG_BASIC_FILEENTRY_H

←

/build/llvm-toolchain-snapshot-14~++20210903100615+fd66b44ec19e/clang/include/clang/Basic/DirectoryEntry.h

1//===- clang/Basic/DirectoryEntry.h - Directory references ------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8///
9/// \file
10/// Defines interfaces for clang::DirectoryEntry and clang::DirectoryEntryRef.
11///
12//===----------------------------------------------------------------------===//
13 
14#ifndef LLVM_CLANG_BASIC_DIRECTORYENTRY_H
15#define LLVM_CLANG_BASIC_DIRECTORYENTRY_H
16 
17#include "clang/Basic/LLVM.h"
18#include "llvm/ADT/DenseMapInfo.h"
19#include "llvm/ADT/Hashing.h"
20#include "llvm/ADT/StringMap.h"
21#include "llvm/ADT/StringRef.h"
22#include "llvm/Support/ErrorOr.h"
23 
24namespace clang {
25namespace FileMgr {
26 
27template <class RefTy> class MapEntryOptionalStorage;
28 
29} // end namespace FileMgr
30 
31/// Cached information about one directory (either on disk or in
32/// the virtual file system).
33class DirectoryEntry {
34  friend class FileManager;
35 
36  // FIXME: We should not be storing a directory entry name here.
37  StringRef Name; // Name of the directory.
38 
39public:
40  StringRef getName() const { return Name; }
41};
42 
43/// A reference to a \c DirectoryEntry  that includes the name of the directory
44/// as it was accessed by the FileManager's client.
45class DirectoryEntryRef {
46public:
47  const DirectoryEntry &getDirEntry() const { return *ME->getValue(); }
48 
49  StringRef getName() const { return ME->getKey(); }
50 
51  /// Hash code is based on the DirectoryEntry, not the specific named
52  /// reference.
53  friend llvm::hash_code hash_value(DirectoryEntryRef Ref) {
54    return llvm::hash_value(&Ref.getDirEntry());
55  }
56 
57  using MapEntry = llvm::StringMapEntry<llvm::ErrorOr<DirectoryEntry &>>;
58 
59  const MapEntry &getMapEntry() const { return *ME; }
60 
61  /// Check if RHS referenced the file in exactly the same way.
62  bool isSameRef(DirectoryEntryRef RHS) const { return ME == RHS.ME; }
63 
64  DirectoryEntryRef() = delete;
65  DirectoryEntryRef(const MapEntry &ME) : ME(&ME) {}
66 
67  /// Allow DirectoryEntryRef to degrade into 'const DirectoryEntry*' to
68  /// facilitate incremental adoption.
69  ///
70  /// The goal is to avoid code churn due to dances like the following:
71  /// \code
72  /// // Old code.
73  /// lvalue = rvalue;
74  ///
75  /// // Temporary code from an incremental patch.
76  /// lvalue = &rvalue.getDirectoryEntry();
77  ///
78  /// // Final code.
79  /// lvalue = rvalue;
80  /// \endcode
81  ///
82  /// FIXME: Once DirectoryEntryRef is "everywhere" and DirectoryEntry::getName
83  /// has been deleted, delete this implicit conversion.
84  operator const DirectoryEntry *() const { return &getDirEntry(); }
85 
86private:
87  friend class FileMgr::MapEntryOptionalStorage<DirectoryEntryRef>;
88  struct optional_none_tag {};
89 
90  // Private constructor for use by OptionalStorage.
91  DirectoryEntryRef(optional_none_tag) : ME(nullptr) {}
92  bool hasOptionalValue() const { return ME; }
93 
94  friend struct llvm::DenseMapInfo<DirectoryEntryRef>;
95  struct dense_map_empty_tag {};
96  struct dense_map_tombstone_tag {};
97 
98  // Private constructors for use by DenseMapInfo.
99  DirectoryEntryRef(dense_map_empty_tag)
100      : ME(llvm::DenseMapInfo<const MapEntry *>::getEmptyKey()) {}
101  DirectoryEntryRef(dense_map_tombstone_tag)
102      : ME(llvm::DenseMapInfo<const MapEntry *>::getTombstoneKey()) {}
103  bool isSpecialDenseMapKey() const {
104    return isSameRef(DirectoryEntryRef(dense_map_empty_tag())) ||
105           isSameRef(DirectoryEntryRef(dense_map_tombstone_tag()));
106  }
107 
108  const MapEntry *ME;
109};
110 
111namespace FileMgr {
112 
113/// Customized storage for refs derived from map entires in FileManager, using
114/// the private optional_none_tag to keep it to the size of a single pointer.
115template <class RefTy> class MapEntryOptionalStorage {
116  using optional_none_tag = typename RefTy::optional_none_tag;
117  RefTy MaybeRef;
118 
119public:
120  MapEntryOptionalStorage() : MaybeRef(optional_none_tag()) {}
11
←
Calling constructor for 'FileEntryRef'→
13
←
Returning from constructor for 'FileEntryRef'→
121 
122  template <class... ArgTypes>
123  explicit MapEntryOptionalStorage(llvm::in_place_t, ArgTypes &&...Args)
124      : MaybeRef(std::forward<ArgTypes>(Args)...) {}
125 
126  void reset() { MaybeRef = optional_none_tag(); }
127 
128  bool hasValue() const { return MaybeRef.hasOptionalValue(); }
129 
130  RefTy &getValue() LLVM_LVALUE_FUNCTION& {
131    assert(hasValue())(static_cast<void> (0));
132    return MaybeRef;
133  }
134  RefTy const &getValue() const LLVM_LVALUE_FUNCTION& {
135    assert(hasValue())(static_cast<void> (0));
136    return MaybeRef;
137  }
138#if LLVM_HAS_RVALUE_REFERENCE_THIS1
139  RefTy &&getValue() && {
140    assert(hasValue())(static_cast<void> (0));
141    return std::move(MaybeRef);
142  }
143#endif
144 
145  template <class... Args> void emplace(Args &&...args) {
146    MaybeRef = RefTy(std::forward<Args>(args)...);
147  }
148 
149  MapEntryOptionalStorage &operator=(RefTy Ref) {
150    MaybeRef = Ref;
151    return *this;
152  }
153};
154 
155} // end namespace FileMgr
156} // end namespace clang
157 
158namespace llvm {
159namespace optional_detail {
160 
161/// Customize OptionalStorage<DirectoryEntryRef> to use DirectoryEntryRef and
162/// its optional_none_tag to keep it the size of a single pointer.
163template <>
164class OptionalStorage<clang::DirectoryEntryRef>
165    : public clang::FileMgr::MapEntryOptionalStorage<clang::DirectoryEntryRef> {
166  using StorageImpl =
167      clang::FileMgr::MapEntryOptionalStorage<clang::DirectoryEntryRef>;
168 
169public:
170  OptionalStorage() = default;
171 
172  template <class... ArgTypes>
173  explicit OptionalStorage(in_place_t, ArgTypes &&...Args)
174      : StorageImpl(in_place_t{}, std::forward<ArgTypes>(Args)...) {}
175 
176  OptionalStorage &operator=(clang::DirectoryEntryRef Ref) {
177    StorageImpl::operator=(Ref);
178    return *this;
179  }
180};
181 
182static_assert(sizeof(Optional<clang::DirectoryEntryRef>) ==
183                  sizeof(clang::DirectoryEntryRef),
184              "Optional<DirectoryEntryRef> must avoid size overhead");
185 
186static_assert(
187    std::is_trivially_copyable<Optional<clang::DirectoryEntryRef>>::value,
188    "Optional<DirectoryEntryRef> should be trivially copyable");
189 
190} // end namespace optional_detail
191 
192/// Specialisation of DenseMapInfo for DirectoryEntryRef.
193template <> struct DenseMapInfo<clang::DirectoryEntryRef> {
194  static inline clang::DirectoryEntryRef getEmptyKey() {
195    return clang::DirectoryEntryRef(
196        clang::DirectoryEntryRef::dense_map_empty_tag());
197  }
198 
199  static inline clang::DirectoryEntryRef getTombstoneKey() {
200    return clang::DirectoryEntryRef(
201        clang::DirectoryEntryRef::dense_map_tombstone_tag());
202  }
203 
204  static unsigned getHashValue(clang::DirectoryEntryRef Val) {
205    return hash_value(Val);
206  }
207 
208  static bool isEqual(clang::DirectoryEntryRef LHS,
209                      clang::DirectoryEntryRef RHS) {
210    // Catch the easy cases: both empty, both tombstone, or the same ref.
211    if (LHS.isSameRef(RHS))
212      return true;
213 
214    // Confirm LHS and RHS are valid.
215    if (LHS.isSpecialDenseMapKey() || RHS.isSpecialDenseMapKey())
216      return false;
217 
218    // It's safe to use operator==.
219    return LHS == RHS;
220  }
221};
222 
223} // end namespace llvm
224 
225namespace clang {
226 
227/// Wrapper around Optional<DirectoryEntryRef> that degrades to 'const
228/// DirectoryEntry*', facilitating incremental patches to propagate
229/// DirectoryEntryRef.
230///
231/// This class can be used as return value or field where it's convenient for
232/// an Optional<DirectoryEntryRef> to degrade to a 'const DirectoryEntry*'. The
233/// purpose is to avoid code churn due to dances like the following:
234/// \code
235/// // Old code.
236/// lvalue = rvalue;
237///
238/// // Temporary code from an incremental patch.
239/// Optional<DirectoryEntryRef> MaybeF = rvalue;
240/// lvalue = MaybeF ? &MaybeF.getDirectoryEntry() : nullptr;
241///
242/// // Final code.
243/// lvalue = rvalue;
244/// \endcode
245///
246/// FIXME: Once DirectoryEntryRef is "everywhere" and DirectoryEntry::LastRef
247/// and DirectoryEntry::getName have been deleted, delete this class and
248/// replace instances with Optional<DirectoryEntryRef>.
249class OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr
250    : public Optional<DirectoryEntryRef> {
251public:
252  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr() = default;
253  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr(
254      OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr &&) = default;
255  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr(
256      const OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr &) = default;
257  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr &
258  operator=(OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr &&) = default;
259  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr &
260  operator=(const OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr &) = default;
261 
262  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr(llvm::NoneType) {}
263  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr(DirectoryEntryRef Ref)
264      : Optional<DirectoryEntryRef>(Ref) {}
265  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr(Optional<DirectoryEntryRef> MaybeRef)
266      : Optional<DirectoryEntryRef>(MaybeRef) {}
267 
268  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr &operator=(llvm::NoneType) {
269    Optional<DirectoryEntryRef>::operator=(None);
270    return *this;
271  }
272  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr &operator=(DirectoryEntryRef Ref) {
273    Optional<DirectoryEntryRef>::operator=(Ref);
274    return *this;
275  }
276  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr &
277  operator=(Optional<DirectoryEntryRef> MaybeRef) {
278    Optional<DirectoryEntryRef>::operator=(MaybeRef);
279    return *this;
280  }
281 
282  /// Degrade to 'const DirectoryEntry *' to allow  DirectoryEntry::LastRef and
283  /// DirectoryEntry::getName have been deleted, delete this class and replace
284  /// instances with Optional<DirectoryEntryRef>
285  operator const DirectoryEntry *() const {
286    return hasValue() ? &getValue().getDirEntry() : nullptr;
287  }
288};
289 
290static_assert(std::is_trivially_copyable<
291                  OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr>::value,
292              "OptionalDirectoryEntryRefDegradesToDirectoryEntryPtr should be "
293              "trivially copyable");
294 
295} // end namespace clang
296 
297#endif // LLVM_CLANG_BASIC_DIRECTORYENTRY_H