Add the ability to pipe trace output to a file. (#1183)

Breaks `--trace` into two flags:

- `--parser_debug`, which sets the parser debug level (which I haven't dug into piping with `--trace`, but seemed likely to be troublesome)
- `--trace_file`, which now the type checker and interpreter will use for trace information (note compile errors should use a different channel)

Most of the file edits are just mechanical testdata flag updates: `sed -i 's/--trace/--parser_debug --trace_file=-/' testdata/**/*.carbon`

To explain the output paths:

- parse/compile errors: stderr
- print() calls: stdout
- parser tracing: `--parser_debug` option, stdout (formerly stdout if `--trace`)
- type check/compile tracing: `--trace_file=<file>`, giving `-` uses stdout (formerly stdout if `--trace`)
- return code of executed Carbon code: `--trace_file` if set, stdout if not (formerly stdout always)

executable_semantics/syntax/parse.cpp

@@ -14,15 +14,17 @@
 
 namespace Carbon {
 
-auto ParseImpl(yyscan_t scanner, Nonnull<Arena*> arena,
-               std::string_view input_file_name, bool trace) -> ErrorOr<AST> {
+static auto ParseImpl(yyscan_t scanner, Nonnull<Arena*> arena,
+                      std::string_view input_file_name, bool parser_debug)
+    -> ErrorOr<AST> {
   // Prepare other parser arguments.
   std::optional<AST> ast = std::nullopt;
-  ParseAndLexContext context(arena->New<std::string>(input_file_name), trace);
+  ParseAndLexContext context(arena->New<std::string>(input_file_name),
+                             parser_debug);
 
   // Do the parse.
   auto parser = Parser(arena, scanner, context, &ast);
-  if (trace) {
+  if (parser_debug) {
     parser.set_debug_level(1);
   }
 
@@ -39,8 +41,8 @@ auto ParseImpl(yyscan_t scanner, Nonnull<Arena*> arena,
   return *ast;
 }
 
-auto Parse(Nonnull<Arena*> arena, std::string_view input_file_name, bool trace)
-    -> ErrorOr<AST> {
+auto Parse(Nonnull<Arena*> arena, std::string_view input_file_name,
+           bool parser_debug) -> ErrorOr<AST> {
   std::string name_str(input_file_name);
   FILE* input_file = fopen(name_str.c_str(), "r");
   if (input_file == nullptr) {
@@ -54,7 +56,8 @@ auto Parse(Nonnull<Arena*> arena, std::string_view input_file_name, bool trace)
   auto buffer = yy_create_buffer(input_file, YY_BUF_SIZE, scanner);
   yy_switch_to_buffer(buffer, scanner);
 
-  ErrorOr<AST> result = ParseImpl(scanner, arena, input_file_name, trace);
+  ErrorOr<AST> result =
+      ParseImpl(scanner, arena, input_file_name, parser_debug);
 
   // Clean up the lexer.
   yy_delete_buffer(buffer, scanner);
@@ -65,7 +68,7 @@ auto Parse(Nonnull<Arena*> arena, std::string_view input_file_name, bool trace)
 }
 
 auto ParseFromString(Nonnull<Arena*> arena, std::string_view input_file_name,
-                     std::string_view file_contents, bool trace)
+                     std::string_view file_contents, bool parser_debug)
     -> ErrorOr<AST> {
   // Prepare the lexer.
   yyscan_t scanner;
@@ -74,7 +77,8 @@ auto ParseFromString(Nonnull<Arena*> arena, std::string_view input_file_name,
       yy_scan_bytes(file_contents.data(), file_contents.size(), scanner);
   yy_switch_to_buffer(buffer, scanner);
 
-  ErrorOr<AST> result = ParseImpl(scanner, arena, input_file_name, trace);
+  ErrorOr<AST> result =
+      ParseImpl(scanner, arena, input_file_name, parser_debug);
 
   // Clean up the lexer.
   yy_delete_buffer(buffer, scanner);

executable_semantics/syntax/parse.h

@@ -15,14 +15,14 @@ namespace Carbon {
 
 // Returns the AST representing the contents of the named file, or an error code
 // if parsing fails. Allocations go into the provided arena.
-auto Parse(Nonnull<Arena*> arena, std::string_view input_file_name, bool trace)
-    -> ErrorOr<Carbon::AST>;
+auto Parse(Nonnull<Arena*> arena, std::string_view input_file_name,
+           bool parser_debug) -> ErrorOr<Carbon::AST>;
 
 // Equivalent to `Parse`, but parses the contents of `file_contents`.
 // `input_file_name` is used only for reporting source locations, and does
 // not need to name a real file.
 auto ParseFromString(Nonnull<Arena*> arena, std::string_view input_file_name,
-                     std::string_view file_contents, bool trace)
+                     std::string_view file_contents, bool parser_debug)
     -> ErrorOr<Carbon::AST>;
 
 }  // namespace Carbon

executable_semantics/syntax/parse_and_lex_context.cpp

@@ -15,7 +15,7 @@ auto ParseAndLexContext::RecordSyntaxError(const std::string& message,
   // TODO: support formatting of `SourceLocation` instances with formatv().
   std::string full_message;
   llvm::raw_string_ostream(full_message)
-      << (prefix_with_newline && trace() ? "\n" : "")
+      << (prefix_with_newline && parser_debug() ? "\n" : "")
       << "COMPILATION ERROR: " << source_loc() << ": " << message;
   error_messages_.push_back(full_message);
 

executable_semantics/syntax/parse_and_lex_context.h

@@ -17,8 +17,9 @@ namespace Carbon {
 class ParseAndLexContext {
  public:
   // Creates an instance analyzing the given input file.
-  ParseAndLexContext(Nonnull<const std::string*> input_file_name, bool trace)
-      : input_file_name_(input_file_name), trace_(trace) {}
+  ParseAndLexContext(Nonnull<const std::string*> input_file_name,
+                     bool parser_debug)
+      : input_file_name_(input_file_name), parser_debug_(parser_debug) {}
 
   // Formats ands records a lexer error. Returns an error token as a
   // convenience.
@@ -31,7 +32,7 @@ class ParseAndLexContext {
                           static_cast<int>(current_token_position.begin.line));
   }
 
-  auto trace() const -> bool { return trace_; }
+  auto parser_debug() const -> bool { return parser_debug_; }
 
   // The source range of the token being (or just) lex'd.
   location current_token_position;
@@ -45,7 +46,7 @@ class ParseAndLexContext {
   // when *this is called.
   Nonnull<const std::string*> input_file_name_;
 
-  bool trace_;
+  bool parser_debug_;
 
   std::vector<std::string> error_messages_;
 };