[NFC] Refactor InputFile's Accessors

Author: CodaFi

include/swift/Frontend/InputFile.h

@@ -13,9 +13,12 @@
 #ifndef SWIFT_FRONTEND_INPUTFILE_H
 #define SWIFT_FRONTEND_INPUTFILE_H
 
+#include "swift/Basic/FileTypes.h"
 #include "swift/Basic/PrimarySpecificPaths.h"
 #include "swift/Basic/SupplementaryOutputPaths.h"
+#include "llvm/ADT/PointerIntPair.h"
 #include "llvm/Support/MemoryBuffer.h"
+#include "llvm/Support/Path.h"
 #include <string>
 
 namespace swift {
@@ -67,9 +70,23 @@ class InputFile final {
     assert(!name.empty());
   }
 
-  bool isPrimary() const { return IsPrimary; }
-  llvm::MemoryBuffer *buffer() const { return Buffer; }
-  const std::string &file() const {
+public:
+  /// Retrieves the type of this input file.
+  file_types::ID getType() const { return FileID; };
+
+  /// Retrieves whether this input file was passed as a primary to the frontend.
+  bool isPrimary() const { return BufferAndIsPrimary.getInt(); }
+
+  /// Retrieves the backing buffer for this input file, if any.
+  llvm::MemoryBuffer *getBuffer() const {
+    return BufferAndIsPrimary.getPointer();
+  }
+
+  /// The name of this \c InputFile, or `-` if this input corresponds to the
+  /// standard input stream.
+  ///
+  /// The returned file name is guaranteed not to be the empty string.
+  const std::string &getFileName() const {
     assert(!Filename.empty());
     return Filename;
   }
@@ -81,12 +98,22 @@ class InputFile final {
     return filename.equals("<stdin>") ? "-" : filename;
   }
 
+  /// Retrieves the name of the output file corresponding to this input.
+  ///
+  /// If there is no such corresponding file, the result is the empty string.
+  /// If there the resulting output should be directed to the standard output
+  /// stream, the result is "-".
   std::string outputFilename() const { return PSPs.OutputFilename; }
 
+  /// If there are explicit primary inputs (i.e. designated with -primary-input
+  /// or -primary-filelist), the paths specific to those inputs (other than the
+  /// input file path itself) are kept here. If there are no explicit primary
+  /// inputs (for instance for whole module optimization), the corresponding
+  /// paths are kept in the first input file.
   const PrimarySpecificPaths &getPrimarySpecificPaths() const { return PSPs; }
 
-  void setPrimarySpecificPaths(const PrimarySpecificPaths &PSPs) {
-    this->PSPs = PSPs;
+  void setPrimarySpecificPaths(PrimarySpecificPaths &&PSPs) {
+    this->PSPs = std::move(PSPs);
   }
 
   // The next set of functions provides access to those primary-specific paths

lib/Frontend/ArgsToFrontendOutputsConverter.cpp

@@ -183,7 +183,7 @@ OutputFilesComputer::computeOutputFile(StringRef outputArg,
 
 Optional<std::string>
 OutputFilesComputer::deriveOutputFileFromInput(const InputFile &input) const {
-  if (input.file() == "-" || HasTextualOutput)
+  if (input.getFileName() == "-" || HasTextualOutput)
     return std::string("-");
 
   std::string baseName = determineBaseNameOfOutput(input);
@@ -210,7 +210,7 @@ std::string
 OutputFilesComputer::determineBaseNameOfOutput(const InputFile &input) const {
   std::string nameToStem =
       input.isPrimary()
-          ? input.file()
+          ? input.getFileName()
           : ModuleNameArg ? ModuleNameArg->getValue() : FirstInput;
   return llvm::sys::path::stem(nameToStem).str();
 }
@@ -474,8 +474,8 @@ StringRef SupplementaryOutputPathsComputer::
   if (!outputFilename.empty() && outputFilename != "-")
     return outputFilename;
 
-  if (input.isPrimary() && input.file() != "-")
-    return llvm::sys::path::filename(input.file());
+  if (input.isPrimary() && input.getFileName() != "-")
+    return llvm::sys::path::filename(input.getFileName());
 
   return ModuleName;
 }
@@ -600,12 +600,12 @@ SupplementaryOutputPathsComputer::readSupplementaryOutputFileMap() const {
   InputsAndOutputs.forEachInputProducingSupplementaryOutput(
       [&](const InputFile &input) -> bool {
         const TypeToPathMap *mapForInput =
-            OFM->getOutputMapForInput(input.file());
+            OFM->getOutputMapForInput(input.getFileName());
         if (!mapForInput) {
           Diags.diagnose(
               SourceLoc(),
               diag::error_missing_entry_in_supplementary_output_file_map,
-              supplementaryFileMapPath, input.file());
+              supplementaryFileMapPath, input.getFileName());
           hadError = true;
         }
         outputPaths.push_back(createFromTypeToPathMap(mapForInput));

lib/Frontend/Frontend.cpp

@@ -633,9 +633,9 @@ bool CompilerInstance::setUpInputs() {
 
 Optional<unsigned> CompilerInstance::getRecordedBufferID(const InputFile &input,
                                                          bool &failed) {
-  if (!input.buffer()) {
+  if (!input.getBuffer()) {
     if (Optional<unsigned> existingBufferID =
-            SourceMgr.getIDForBufferIdentifier(input.file())) {
+            SourceMgr.getIDForBufferIdentifier(input.getFileName())) {
       return existingBufferID;
     }
   }
@@ -663,17 +663,18 @@ Optional<unsigned> CompilerInstance::getRecordedBufferID(const InputFile &input,
 
 Optional<ModuleBuffers> CompilerInstance::getInputBuffersIfPresent(
     const InputFile &input) {
-  if (auto b = input.buffer()) {
+  if (auto b = input.getBuffer()) {
     return ModuleBuffers(llvm::MemoryBuffer::getMemBufferCopy(b->getBuffer(),
                                                               b->getBufferIdentifier()));
   }
   // FIXME: Working with filenames is fragile, maybe use the real path
   // or have some kind of FileManager.
   using FileOrError = llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>>;
   FileOrError inputFileOrErr = swift::vfs::getFileOrSTDIN(getFileSystem(),
-                                                          input.file());
+                                                          input.getFileName());
   if (!inputFileOrErr) {
-    Diagnostics.diagnose(SourceLoc(), diag::error_open_input_file, input.file(),
+    Diagnostics.diagnose(SourceLoc(), diag::error_open_input_file,
+                         input.getFileName(),
                          inputFileOrErr.getError().message());
     return None;
   }
@@ -689,7 +690,7 @@ Optional<ModuleBuffers> CompilerInstance::getInputBuffersIfPresent(
 
 Optional<std::unique_ptr<llvm::MemoryBuffer>>
 CompilerInstance::openModuleSourceInfo(const InputFile &input) {
-  llvm::SmallString<128> pathWithoutProjectDir(input.file());
+  llvm::SmallString<128> pathWithoutProjectDir(input.getFileName());
   llvm::sys::path::replace_extension(pathWithoutProjectDir,
                   file_types::getExtension(file_types::TY_SwiftSourceInfoFile));
   llvm::SmallString<128> pathWithProjectDir = pathWithoutProjectDir.str();
@@ -708,7 +709,7 @@ CompilerInstance::openModuleSourceInfo(const InputFile &input) {
 
 Optional<std::unique_ptr<llvm::MemoryBuffer>>
 CompilerInstance::openModuleDoc(const InputFile &input) {
-  llvm::SmallString<128> moduleDocFilePath(input.file());
+  llvm::SmallString<128> moduleDocFilePath(input.getFileName());
   llvm::sys::path::replace_extension(
       moduleDocFilePath,
       file_types::getExtension(file_types::TY_SwiftModuleDocFile));
@@ -773,9 +774,12 @@ ImplicitImportInfo CompilerInstance::getImplicitImportInfo() const {
 
 bool CompilerInstance::createFilesForMainModule(
     ModuleDecl *mod, SmallVectorImpl<FileUnit *> &files) const {
-  // Make sure the main file is the first file in the module.
-  if (MainBufferID != NO_SUCH_BUFFER) {
-    files.push_back(mainFile);
+  // Try to pull out the main source file, if any. This ensures that it
+  // is at the start of the list of files.
+  Optional<unsigned> MainBufferID = None;
+  if (SourceFile *mainSourceFile = computeMainSourceFileForModule(mod)) {
+    MainBufferID = mainSourceFile->getBufferID();
+    files.push_back(mainSourceFile);
   }
 
   // If we have partial modules to load, do so now, bailing if any failed to

lib/Frontend/FrontendInputsAndOutputs.cpp

@@ -54,7 +54,7 @@ operator=(const FrontendInputsAndOutputs &other) {
 std::vector<std::string> FrontendInputsAndOutputs::getInputFilenames() const {
   std::vector<std::string> filenames;
   for (auto &input : AllInputs) {
-    filenames.push_back(input.file());
+    filenames.push_back(input.getFileName());
   }
   return filenames;
 }
@@ -66,7 +66,7 @@ bool FrontendInputsAndOutputs::isReadingFromStdin() const {
 const std::string &FrontendInputsAndOutputs::getFilenameOfFirstInput() const {
   assert(hasInputs());
   const InputFile &inp = AllInputs[0];
-  const std::string &f = inp.file();
+  const std::string &f = inp.getFileName();
   assert(!f.empty());
   return f;
 }
@@ -135,7 +135,7 @@ FrontendInputsAndOutputs::getRequiredUniquePrimaryInput() const {
 std::string FrontendInputsAndOutputs::getStatsFileMangledInputName() const {
   // Use the first primary, even if there are multiple primaries.
   // That's enough to keep the file names unique.
-  return isWholeModule() ? "all" : firstPrimaryInput().file();
+  return isWholeModule() ? "all" : firstPrimaryInput().getFileName();
 }
 
 bool FrontendInputsAndOutputs::isInputPrimary(StringRef file) const {
@@ -146,7 +146,7 @@ unsigned FrontendInputsAndOutputs::numberOfPrimaryInputsEndingWith(
     StringRef extension) const {
   unsigned n = 0;
   (void)forEachPrimaryInput([&](const InputFile &input) -> bool {
-    if (llvm::sys::path::extension(input.file()).endswith(extension))
+    if (llvm::sys::path::extension(input.getFileName()).endswith(extension))
       ++n;
     return false;
   });
@@ -216,7 +216,7 @@ bool FrontendInputsAndOutputs::areAllNonPrimariesSIB() const {
   for (const InputFile &input : AllInputs) {
     if (input.isPrimary())
       continue;
-    StringRef extension = llvm::sys::path::extension(input.file());
+    StringRef extension = llvm::sys::path::extension(input.getFileName());
     if (file_types::lookupTypeForExtension(extension) != file_types::TY_SIB) {
       return false;
     }
@@ -269,7 +269,7 @@ void FrontendInputsAndOutputs::addInput(const InputFile &input) {
   AllInputs.push_back(input);
   if (input.isPrimary()) {
     PrimaryInputsInOrder.push_back(index);
-    PrimaryInputsByName.insert(std::make_pair(AllInputs.back().file(), index));
+    PrimaryInputsByName.insert({AllInputs.back().getFileName(), index});
   }
 }
 
@@ -330,7 +330,7 @@ void FrontendInputsAndOutputs::setMainAndSupplementaryOutputs(
     for (auto &input : AllInputs) {
       if (input.isPrimary()) {
         input.setPrimarySpecificPaths(PrimarySpecificPaths(
-            outputFiles[i], input.file(), supplementaryOutputs[i]));
+            outputFiles[i], input.getFileName(), supplementaryOutputs[i]));
         ++i;
       }
     }
@@ -340,7 +340,7 @@ void FrontendInputsAndOutputs::setMainAndSupplementaryOutputs(
          "WMO only ever produces one set of supplementary outputs");
   if (outputFiles.size() == 1) {
     AllInputs.front().setPrimarySpecificPaths(PrimarySpecificPaths(
-        outputFiles.front(), firstInputProducingOutput().file(),
+        outputFiles.front(), firstInputProducingOutput().getFileName(),
         supplementaryOutputs.front()));
     return;
   }

lib/Frontend/ModuleInterfaceBuilder.cpp

@@ -179,7 +179,7 @@ bool ModuleInterfaceBuilder::buildSwiftModuleInternal(
     bool isTypeChecking =
         (FEOpts.RequestedAction == FrontendOptions::ActionType::Typecheck);
     const auto &InputInfo = FEOpts.InputsAndOutputs.firstInput();
-    StringRef InPath = InputInfo.file();
+    StringRef InPath = InputInfo.getFileName();
     const auto &OutputInfo =
     InputInfo.getPrimarySpecificPaths().SupplementaryOutputs;
     StringRef OutPath = OutputInfo.ModuleOutputPath;

lib/FrontendTool/FrontendTool.cpp

@@ -2414,7 +2414,7 @@ createDispatchingDiagnosticConsumerIfNeeded(
   inputsAndOutputs.forEachInputProducingSupplementaryOutput(
       [&](const InputFile &input) -> bool {
         if (auto consumer = maybeCreateConsumerForDiagnosticsFrom(input))
-          subconsumers.emplace_back(input.file(), std::move(consumer));
+          subconsumers.emplace_back(input.getFileName(), std::move(consumer));
         return false;
       });
   // For batch mode, the compiler must sometimes swallow diagnostics pertaining
@@ -2431,7 +2431,7 @@ createDispatchingDiagnosticConsumerIfNeeded(
   if (!subconsumers.empty() && inputsAndOutputs.hasMultiplePrimaryInputs()) {
     inputsAndOutputs.forEachNonPrimaryInput(
         [&](const InputFile &input) -> bool {
-          subconsumers.emplace_back(input.file(), nullptr);
+          subconsumers.emplace_back(input.getFileName(), nullptr);
           return false;
         });
   }

lib/IDE/Utils.cpp

@@ -206,8 +206,8 @@ static FrontendInputsAndOutputs resolveSymbolicLinksInInputs(
   FrontendInputsAndOutputs replacementInputsAndOutputs;
   for (const InputFile &input : inputsAndOutputs.getAllInputs()) {
     llvm::SmallString<128> newFilename;
-    if (auto err = FileSystem->getRealPath(input.file(), newFilename))
-      newFilename = input.file();
+    if (auto err = FileSystem->getRealPath(input.getFileName(), newFilename))
+      newFilename = input.getFileName();
     llvm::sys::path::native(newFilename);
     bool newIsPrimary = input.isPrimary() ||
                         (!PrimaryFile.empty() && PrimaryFile == newFilename);
@@ -216,7 +216,7 @@ static FrontendInputsAndOutputs resolveSymbolicLinksInInputs(
     }
     assert(primaryCount < 2 && "cannot handle multiple primaries");
     replacementInputsAndOutputs.addInput(
-        InputFile(newFilename.str(), newIsPrimary, input.buffer()));
+        InputFile(newFilename.str(), newIsPrimary, input.getBuffer()));
   }
 
   if (PrimaryFile.empty() || primaryCount == 1) {

lib/Migrator/Migrator.cpp

@@ -435,5 +435,5 @@ const MigratorOptions &Migrator::getMigratorOptions() const {
 const StringRef Migrator::getInputFilename() const {
   auto &PrimaryInput = StartInvocation.getFrontendOptions()
                            .InputsAndOutputs.getRequiredUniquePrimaryInput();
-  return PrimaryInput.file();
+  return PrimaryInput.getFileName();
 }

tools/SourceKit/lib/SwiftLang/SwiftASTManager.cpp

@@ -711,7 +711,7 @@ bool ASTProducer::shouldRebuild(
       Invok.Opts.Invok.getFrontendOptions().InputsAndOutputs.inputCount());
   for (const auto &input :
        Invok.Opts.Invok.getFrontendOptions().InputsAndOutputs.getAllInputs()) {
-    const std::string &File = input.file();
+    const std::string &File = input.getFileName();
     bool FoundSnapshot = false;
     for (auto &Snap : Snapshots) {
       if (Snap->getFilename() == File) {
@@ -906,7 +906,7 @@ void ASTProducer::findSnapshotAndOpenFiles(
   const InvocationOptions &Opts = InvokRef->Impl.Opts;
   for (const auto &input :
        Opts.Invok.getFrontendOptions().InputsAndOutputs.getAllInputs()) {
-    const std::string &File = input.file();
+    const std::string &File = input.getFileName();
     bool IsPrimary = input.isPrimary();
     bool FoundSnapshot = false;
     for (auto &Snap : Snapshots) {