Files
swift-mirror/include/swift/Serialization/ScanningLoaders.h
Artem Chikin 68883a1014 [Dependency Scanning] Refactor Swift Scanner loader to be standalone
- 'SwiftModuleScanner' will now be owned directly by the 'ModuleDependencyScanningWorker' and will contain all the necessary custom logic, instead of being instantiated by the module interface loader for each query
- Moves ownership over module output path and sdk module output path directly into the scanning worker, instead of the cache
2025-06-23 13:39:36 -07:00

83 lines
3.6 KiB
C++

//===--- ScanningLoaders.h - Swift module scanning --------------*- C++ -*-===//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2023 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_SCANNINGLOADERS_H
#define SWIFT_SCANNINGLOADERS_H
#include "swift/AST/ASTContext.h"
#include "swift/AST/ModuleDependencies.h"
#include "swift/Frontend/ModuleInterfaceLoader.h"
#include "swift/Serialization/SerializedModuleLoader.h"
namespace swift {
/// A module "loader" that looks for .swiftinterface and .swiftmodule files
/// for the purpose of determining dependencies, but does not attempt to
/// load the module files.
class SwiftModuleScanner : public SerializedModuleLoaderBase {
private:
/// Scan the given interface file to determine dependencies.
llvm::ErrorOr<ModuleDependencyInfo>
scanInterfaceFile(Identifier moduleID, Twine moduleInterfacePath,
bool isFramework, bool isTestableImport);
/// Scan the given serialized module file to determine dependencies.
llvm::ErrorOr<ModuleDependencyInfo>
scanBinaryModuleFile(Identifier moduleID, Twine binaryModulePath,
bool isFramework, bool isTestableImport,
bool isCandidateForTextualModule);
std::error_code findModuleFilesInDirectory(
ImportPath::Element ModuleID, const SerializedModuleBaseName &BaseName,
SmallVectorImpl<char> *ModuleInterfacePath,
SmallVectorImpl<char> *ModuleInterfaceSourcePath,
std::unique_ptr<llvm::MemoryBuffer> *ModuleBuffer,
std::unique_ptr<llvm::MemoryBuffer> *ModuleDocBuffer,
std::unique_ptr<llvm::MemoryBuffer> *ModuleSourceInfoBuffer,
bool SkipBuildingInterface, bool IsFramework,
bool IsTestableDependencyLookup) override;
virtual void collectVisibleTopLevelModuleNames(
SmallVectorImpl<Identifier> &names) const override {
llvm_unreachable("Not used");
}
/// AST delegate to be used for textual interface scanning
InterfaceSubContextDelegate &astDelegate;
/// Location where pre-built modules are to be built into.
std::string moduleOutputPath;
/// Location where pre-built SDK modules are to be built into.
std::string sdkModuleOutputPath;
/// Clang-specific (-Xcc) command-line flags to include on
/// Swift module compilation commands
std::vector<std::string> swiftModuleClangCC1CommandLineArgs;
public:
std::optional<ModuleDependencyInfo> dependencies;
SwiftModuleScanner(ASTContext &ctx, ModuleLoadingMode LoadMode,
InterfaceSubContextDelegate &astDelegate,
StringRef moduleOutputPath, StringRef sdkModuleOutputPath,
std::vector<std::string> swiftModuleClangCC1CommandLineArgs)
: SerializedModuleLoaderBase(ctx, nullptr, LoadMode,
/*IgnoreSwiftSourceInfoFile=*/true),
astDelegate(astDelegate),
moduleOutputPath(moduleOutputPath),
sdkModuleOutputPath(sdkModuleOutputPath),
swiftModuleClangCC1CommandLineArgs(swiftModuleClangCC1CommandLineArgs) {}
/// Perform a filesystem search for a Swift module with a given name
llvm::SmallVector<std::pair<ModuleDependencyID, ModuleDependencyInfo>, 1>
lookupSwiftModule(Identifier moduleName, bool isTestableImport);
};
} // namespace swift
#endif // SWIFT_SCANNINGLOADERS_H