carbon-lang/toolchain/driver/compile_subcommand.h

// 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/check/check.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,
  };

  friend auto operator<<(llvm::raw_ostream& out, Phase phase)
      -> llvm::raw_ostream&;

  auto Build(CommandLine::CommandBuilder& b) -> void;

  CodegenOptions codegen_options;

  Phase phase;
  Check::CheckParseTreesOptions::DumpSemIRRanges dump_sem_ir_ranges;

  llvm::StringRef output_filename;
  llvm::SmallVector<llvm::StringRef> input_filenames;
  llvm::SmallVector<llvm::StringRef> clang_args;

  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;
  bool run_llvm_verifier = true;

  llvm::SmallVector<llvm::StringRef> exclude_dump_file_prefixes;
};

// 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_