6024e5c395
clang 20.0.0 (based on r547379) from build 12806354. Bug: http://b/379133546 Test: N/A Change-Id: I2eb8938af55d809de674be63cb30cf27e801862b Upstream-Commit: ad834e67b1105d15ef907f6255d4c96e8e733f57
129 lines
4.8 KiB
C++
129 lines
4.8 KiB
C++
//===- DependencyScanningWorker.h - clang-scan-deps worker ===---*- C++ -*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLING_DEPENDENCYSCANNING_DEPENDENCYSCANNINGWORKER_H
|
|
#define LLVM_CLANG_TOOLING_DEPENDENCYSCANNING_DEPENDENCYSCANNINGWORKER_H
|
|
|
|
#include "clang/Basic/DiagnosticOptions.h"
|
|
#include "clang/Basic/FileManager.h"
|
|
#include "clang/Basic/LLVM.h"
|
|
#include "clang/Frontend/PCHContainerOperations.h"
|
|
#include "clang/Tooling/DependencyScanning/DependencyScanningService.h"
|
|
#include "clang/Tooling/DependencyScanning/ModuleDepCollector.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/FileSystem.h"
|
|
#include <optional>
|
|
#include <string>
|
|
|
|
namespace clang {
|
|
|
|
class DependencyOutputOptions;
|
|
|
|
namespace tooling {
|
|
namespace dependencies {
|
|
|
|
class DependencyScanningWorkerFilesystem;
|
|
|
|
/// A command-line tool invocation that is part of building a TU.
|
|
///
|
|
/// \see TranslationUnitDeps::Commands.
|
|
struct Command {
|
|
std::string Executable;
|
|
std::vector<std::string> Arguments;
|
|
};
|
|
|
|
class DependencyConsumer {
|
|
public:
|
|
virtual ~DependencyConsumer() {}
|
|
|
|
virtual void handleProvidedAndRequiredStdCXXModules(
|
|
std::optional<P1689ModuleInfo> Provided,
|
|
std::vector<P1689ModuleInfo> Requires) {}
|
|
|
|
virtual void handleBuildCommand(Command Cmd) {}
|
|
|
|
virtual void
|
|
handleDependencyOutputOpts(const DependencyOutputOptions &Opts) = 0;
|
|
|
|
virtual void handleFileDependency(StringRef Filename) = 0;
|
|
|
|
virtual void handlePrebuiltModuleDependency(PrebuiltModuleDep PMD) = 0;
|
|
|
|
virtual void handleModuleDependency(ModuleDeps MD) = 0;
|
|
|
|
virtual void handleDirectModuleDependency(ModuleID MD) = 0;
|
|
|
|
virtual void handleContextHash(std::string Hash) = 0;
|
|
};
|
|
|
|
/// Dependency scanner callbacks that are used during scanning to influence the
|
|
/// behaviour of the scan - for example, to customize the scanned invocations.
|
|
class DependencyActionController {
|
|
public:
|
|
virtual ~DependencyActionController();
|
|
|
|
virtual std::string lookupModuleOutput(const ModuleID &ID,
|
|
ModuleOutputKind Kind) = 0;
|
|
};
|
|
|
|
/// An individual dependency scanning worker that is able to run on its own
|
|
/// thread.
|
|
///
|
|
/// The worker computes the dependencies for the input files by preprocessing
|
|
/// sources either using a fast mode where the source files are minimized, or
|
|
/// using the regular processing run.
|
|
class DependencyScanningWorker {
|
|
public:
|
|
DependencyScanningWorker(DependencyScanningService &Service,
|
|
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> FS);
|
|
|
|
/// Run the dependency scanning tool for a given clang driver command-line,
|
|
/// and report the discovered dependencies to the provided consumer. If \p
|
|
/// ModuleName isn't empty, this function reports the dependencies of module
|
|
/// \p ModuleName.
|
|
///
|
|
/// \returns false if clang errors occurred (with diagnostics reported to
|
|
/// \c DiagConsumer), true otherwise.
|
|
bool computeDependencies(StringRef WorkingDirectory,
|
|
const std::vector<std::string> &CommandLine,
|
|
DependencyConsumer &DepConsumer,
|
|
DependencyActionController &Controller,
|
|
DiagnosticConsumer &DiagConsumer,
|
|
std::optional<StringRef> ModuleName = std::nullopt);
|
|
/// \returns A \c StringError with the diagnostic output if clang errors
|
|
/// occurred, success otherwise.
|
|
llvm::Error computeDependencies(
|
|
StringRef WorkingDirectory, const std::vector<std::string> &CommandLine,
|
|
DependencyConsumer &Consumer, DependencyActionController &Controller,
|
|
std::optional<StringRef> ModuleName = std::nullopt);
|
|
|
|
bool shouldEagerLoadModules() const { return EagerLoadModules; }
|
|
|
|
private:
|
|
std::shared_ptr<PCHContainerOperations> PCHContainerOps;
|
|
/// The file system to be used during the scan.
|
|
/// This is either \c FS passed in the constructor (when performing canonical
|
|
/// preprocessing), or \c DepFS (when performing dependency directives scan).
|
|
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS;
|
|
/// When performing dependency directives scan, this is the caching (and
|
|
/// dependency-directives-extracting) filesystem overlaid on top of \c FS
|
|
/// (passed in the constructor).
|
|
llvm::IntrusiveRefCntPtr<DependencyScanningWorkerFilesystem> DepFS;
|
|
ScanningOutputFormat Format;
|
|
/// Whether to optimize the modules' command-line arguments.
|
|
ScanningOptimizations OptimizeArgs;
|
|
/// Whether to set up command-lines to load PCM files eagerly.
|
|
bool EagerLoadModules;
|
|
};
|
|
|
|
} // end namespace dependencies
|
|
} // end namespace tooling
|
|
} // end namespace clang
|
|
|
|
#endif // LLVM_CLANG_TOOLING_DEPENDENCYSCANNING_DEPENDENCYSCANNINGWORKER_H
|