mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-30 14:05:03 +01:00
Jon MeowandChandler Carruth
652cd8c636
There are some declaration order changes, and a few test classes switched from `struct` to `class`. However, this PR is mostly adopting `_` naming of private member variables due to the shift in naming style. None of what's here should have behavior impacts, it should just be style. Note, there are a lot of things that *look* like they could be accessor-named, but I'm not doing that in this change. Happy to do it separately if you want me to do another PR focused on it. Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
81 lines
3.1 KiB
C++
81 lines
3.1 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 TOOLCHAIN_DRIVER_DRIVER_H_
|
|
#define TOOLCHAIN_DRIVER_DRIVER_H_
|
|
|
|
#include <cstdint>
|
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/Support/Debug.h"
|
|
#include "llvm/Support/raw_ostream.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:
|
|
// Default constructed driver uses stderr for all error and informational
|
|
// output.
|
|
Driver() : output_stream_(llvm::outs()), error_stream_(llvm::errs()) {}
|
|
|
|
// Constructs a driver with any error or informational output directed to a
|
|
// specified stream.
|
|
Driver(llvm::raw_ostream& output_stream, llvm::raw_ostream& error_stream)
|
|
: 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 RunFullCommand(llvm::ArrayRef<llvm::StringRef> args) -> bool;
|
|
|
|
// Subcommand that prints available help text to the error stream.
|
|
//
|
|
// Optionally one positional parameter may be provided to select a particular
|
|
// subcommand or detailed section of help to print.
|
|
//
|
|
// Returns true if appropriate help text was found and printed. If an invalid
|
|
// positional parameter (or flag) is provided, returns false.
|
|
auto RunHelpSubcommand(llvm::ArrayRef<llvm::StringRef> args) -> bool;
|
|
|
|
// Subcommand that dumps the token information for the provided source file.
|
|
//
|
|
// Requires exactly one positional parameter to designate the source file to
|
|
// read. May be `-` to read from stdin.
|
|
//
|
|
// Returns true if the operation succeeds. If the operation fails, this
|
|
// returns false and any information about the failure is printed to the
|
|
// registered error stream (stderr by default).
|
|
auto RunDumpTokensSubcommand(llvm::ArrayRef<llvm::StringRef> args) -> bool;
|
|
|
|
// Subcommand that dumps the parse tree for the provided source file.
|
|
//
|
|
// Requires exactly one positional parameter to designate the source file to
|
|
// read. May be `-` to read from stdin.
|
|
//
|
|
// Returns true if the operation succeeds. If the operation fails, this
|
|
// returns false and any information about the failure is printed to the
|
|
// registered error stream (stderr by default).
|
|
auto RunDumpParseTreeSubcommand(llvm::ArrayRef<llvm::StringRef> args) -> bool;
|
|
|
|
private:
|
|
auto ReportExtraArgs(llvm::StringRef subcommand_text,
|
|
llvm::ArrayRef<llvm::StringRef> args) -> void;
|
|
|
|
llvm::raw_ostream& output_stream_;
|
|
llvm::raw_ostream& error_stream_;
|
|
};
|
|
|
|
} // namespace Carbon
|
|
|
|
#endif // TOOLCHAIN_DRIVER_DRIVER_H_
|