Files
carbon-lang/toolchain/driver/compile_subcommand.h
T
Jon Ross-Perkins 937caaecce Add --dump-sem-ir-ranges for controlling dump output (#5450)
Right now, a lot of tests have started setting `--no-dump-sem-ir`. My
thought is that we can look at:

1. Put ranges in a bunch more files.
2. Shift more towards `--dump-sem-ir-ranges=only` instead of
`--no-dump-sem-ir`, because it allows mixing fail-tests with no IR
alongside tests that contain IR.
3. Evaluate switching the default to `--dump-sem-ir-ranges=only`, and
instead set `--dump-sem-ir-ranges=if-present` only in files that want to
typically show all IR (particularly import-related tests, where ranges
don't work well).

In real-world use, my thought is also that it'd be helpful to be able to
add the dump range comments to files, see the output (i.e., the default
behavior of `if-present`) but then also be able to pass `ignore` in
order to see the full IR without modifying the file (possibly also
useful in tests). That model is why I went for tri-state handling.

Note `only` can also have an interesting side-effect. Because core files
(including min_prelude versions) typically won't have ranges, they'd be
implicitly excluded.
2025-05-12 14:51:10 +00:00

95 lines
2.5 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_COMPILE_SUBCOMMAND_H_
#define CARBON_TOOLCHAIN_DRIVER_COMPILE_SUBCOMMAND_H_
#include "common/command_line.h"
#include "common/error.h"
#include "common/ostream.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "toolchain/driver/codegen_options.h"
#include "toolchain/driver/driver_env.h"
#include "toolchain/driver/driver_subcommand.h"
namespace Carbon {
// Options for the compile subcommand.
//
// See the implementation of `Build` for documentation on members.
struct CompileOptions {
enum class Phase : int8_t {
Lex,
Parse,
Check,
Lower,
CodeGen,
};
enum class DumpSemIRRanges : int8_t {
IfPresent,
Only,
Ignore,
};
friend auto operator<<(llvm::raw_ostream& out, Phase phase)
-> llvm::raw_ostream&;
auto Build(CommandLine::CommandBuilder& b) -> void;
CodegenOptions codegen_options;
Phase phase;
DumpSemIRRanges dump_sem_ir_ranges;
llvm::StringRef output_filename;
llvm::SmallVector<llvm::StringRef> input_filenames;
bool asm_output = false;
bool force_obj_output = false;
bool custom_core = false;
bool dump_shared_values = false;
bool dump_tokens = false;
bool omit_file_boundary_tokens = false;
bool dump_parse_tree = false;
bool dump_raw_sem_ir = false;
bool dump_sem_ir = false;
bool dump_llvm_ir = false;
bool dump_asm = false;
bool dump_mem_usage = false;
bool dump_timings = false;
bool stream_errors = false;
bool preorder_parse_tree = false;
bool builtin_sem_ir = false;
bool prelude_import = false;
bool include_debug_info = true;
llvm::StringRef exclude_dump_file_prefix;
};
// Implements the compile subcommand of the driver.
class CompileSubcommand : public DriverSubcommand {
public:
explicit CompileSubcommand();
auto BuildOptions(CommandLine::CommandBuilder& b) -> void override {
options_.Build(b);
}
auto Run(DriverEnv& driver_env) -> DriverResult override;
private:
// Does custom validation of the compile-subcommand options structure beyond
// what the command line parsing library supports. Diagnoses and returns false
// on failure.
auto ValidateOptions(Diagnostics::NoLocEmitter& emitter) const -> bool;
CompileOptions options_;
};
} // namespace Carbon
#endif // CARBON_TOOLCHAIN_DRIVER_COMPILE_SUBCOMMAND_H_