carbon-lang/toolchain/driver/driver.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_DRIVER_H_
#define CARBON_TOOLCHAIN_DRIVER_DRIVER_H_

#include "common/command_line.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/VirtualFileSystem.h"
#include "llvm/Support/raw_ostream.h"
#include "toolchain/install/install_paths.h"

namespace Carbon {

// Command line interface driver.
//
// Provides simple API to parse and run command lines for Carbon.  It is
// generally expected to be used to implement command line tools for working
// with the language.
class Driver {
 public:
  // The result of RunCommand().
  struct RunResult {
    // 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;
  };

  // Constructs a driver with any error or informational output directed to a
  // specified stream.
  Driver(llvm::vfs::FileSystem& fs, const InstallPaths* installation,
         llvm::raw_pwrite_stream& output_stream,
         llvm::raw_pwrite_stream& error_stream)
      : fs_(fs),
        installation_(installation),
        output_stream_(output_stream),
        error_stream_(error_stream) {}

  // Parses the given arguments into both a subcommand to select the operation
  // to perform and any arguments to that subcommand.
  //
  // Returns true if the operation succeeds. If the operation fails, returns
  // false and any information about the failure is printed to the registered
  // error stream (stderr by default).
  auto RunCommand(llvm::ArrayRef<llvm::StringRef> args) -> RunResult;

  // Finds the source files that define the prelude and returns a list of their
  // filenames. On error, writes a message to `error_stream` and returns an
  // empty list.
  static auto FindPreludeFiles(llvm::StringRef core_package_dir,
                               llvm::raw_ostream& error_stream)
      -> llvm::SmallVector<std::string>;

 private:
  struct Options;
  struct CodegenOptions;
  struct CompileOptions;
  struct LinkOptions;
  class CompilationUnit;

  // Delegates to the command line library to parse the arguments and store the
  // results in a custom `Options` structure that the rest of the driver uses.
  auto ParseArgs(llvm::ArrayRef<llvm::StringRef> args, Options& options)
      -> CommandLine::ParseResult;

  // Does custom validation of the compile-subcommand options structure beyond
  // what the command line parsing library supports.
  auto ValidateCompileOptions(const CompileOptions& options) const -> bool;

  // Implements the compile subcommand of the driver.
  auto Compile(const CompileOptions& options,
               const CodegenOptions& codegen_options) -> RunResult;

  // Implements the link subcommand of the driver.
  auto Link(const LinkOptions& options, const CodegenOptions& codegen_options)
      -> RunResult;

  // The filesystem for source code.
  llvm::vfs::FileSystem& fs_;

  // Helper to locate the toolchain installation's files.
  const InstallPaths* installation_;

  // Standard output; stdout.
  llvm::raw_pwrite_stream& output_stream_;
  // Error output; stderr.
  llvm::raw_pwrite_stream& error_stream_;

  // For CARBON_VLOG.
  llvm::raw_pwrite_stream* vlog_stream_ = nullptr;
};

}  // namespace Carbon

#endif  // CARBON_TOOLCHAIN_DRIVER_DRIVER_H_