mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-24 21:30:12 +01:00
Chandler Carruth
5d0d443c98
Previously this was kept in `//toolchain/install` so it would be near to the code that actually defines the installation layout. However, that creates somewhat unfortunate dependency cycles between `//toolchain/install` and other directories. Exacerbating this, a subsequent PR is likely to add dependencies on it from `//toolchain/base` itself that suggests that is the correct layering. This PR just moves the code mechanically with as few other edits as possible.
80 lines
2.8 KiB
C++
80 lines
2.8 KiB
C++
// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
|
// Exceptions. See /LICENSE for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
|
#ifndef CARBON_TOOLCHAIN_DRIVER_DRIVER_SUBCOMMAND_H_
|
|
#define CARBON_TOOLCHAIN_DRIVER_DRIVER_SUBCOMMAND_H_
|
|
|
|
#include "common/command_line.h"
|
|
#include "common/ostream.h"
|
|
#include "llvm/Support/VirtualFileSystem.h"
|
|
#include "toolchain/base/install_paths.h"
|
|
#include "toolchain/driver/driver_env.h"
|
|
|
|
namespace Carbon {
|
|
|
|
// The result of a driver run.
|
|
struct DriverResult {
|
|
// Overall success result.
|
|
bool success;
|
|
|
|
// Per-file success results. May be empty if files aren't individually
|
|
// processed.
|
|
llvm::SmallVector<std::pair<std::string, bool>> per_file_success = {};
|
|
};
|
|
|
|
// A subcommand for the driver.
|
|
class DriverSubcommand {
|
|
public:
|
|
explicit DriverSubcommand(CommandLine::CommandInfo info) : info_(info) {}
|
|
|
|
// Adds the subcommand to the main command, assigning `selected_command` when
|
|
// the subcommand is in use.
|
|
auto AddTo(CommandLine::CommandBuilder& b,
|
|
DriverSubcommand** selected_subcommand) -> void {
|
|
b.AddSubcommand(
|
|
info_, [this, selected_subcommand](CommandLine::CommandBuilder& sub_b) {
|
|
BuildOptionsAndSetAction(sub_b, selected_subcommand);
|
|
});
|
|
}
|
|
|
|
// Adds command line options.
|
|
virtual auto BuildOptions(CommandLine::CommandBuilder& b) -> void = 0;
|
|
|
|
// Adds command line options and registers the `Run` method to be called.
|
|
//
|
|
// For more complex subcommands that need to control the action this method
|
|
// can be overridden and bypass the simple API above.
|
|
//
|
|
// TODO: This isn't the most elegant way to manage this. There is probably a
|
|
// better factoring / organization of the driver subcommand infrastructure
|
|
// that bakes in the needed flexibility here, but that was deferred for a
|
|
// future refactoring.
|
|
virtual auto BuildOptionsAndSetAction(CommandLine::CommandBuilder& b,
|
|
DriverSubcommand** selected_subcommand)
|
|
-> void {
|
|
BuildOptions(b);
|
|
b.Do([this, selected_subcommand] { *selected_subcommand = this; });
|
|
}
|
|
|
|
// Runs the command.
|
|
virtual auto Run(DriverEnv& driver_env) -> DriverResult = 0;
|
|
|
|
protected:
|
|
// Tests if fuzzing and if so diagnose and returns true.
|
|
//
|
|
// This should be used in subcommands to diagnose and exit early rather than
|
|
// entering them during fuzzing when they use external libraries that we can't
|
|
// keep fuzz-clean.
|
|
auto TestAndDiagnoseIfFuzzingExternalLibraries(DriverEnv& driver_env,
|
|
llvm::StringRef name) -> bool;
|
|
|
|
private:
|
|
// Subcommand information.
|
|
CommandLine::CommandInfo info_;
|
|
};
|
|
|
|
} // namespace Carbon
|
|
|
|
#endif // CARBON_TOOLCHAIN_DRIVER_DRIVER_SUBCOMMAND_H_
|