Files
carbon-lang/common/check_internal.h
T
Jon Ross-PerkinsandChandler Carruth 352fec1885 Add some coarse debug information to semantics. (#2382)
Example stack:

```
1.	node_stack_:
	0.	FunctionDefinitionStart
	1.	ReturnStatement -> node1
2.	node_block_stack_:
	0.	block0
	1.	block1
```

Example trace output:

```
*** SemanticsParseTreeHandler::Build Begin ***
Push 0: FunctionIntroducer
Push 1: DeclaredName
Push 2: ParameterListEnd
Pop 2: ParameterListEnd
Push 2: ParameterList
Pop 2: ParameterList
Pop 0: FunctionIntroducer
AddNode block0: FunctionDeclaration()
AddNode block0: BindName(ident0, node0)
AddNode block0: FunctionDefinition(node0, block1)
Push 0: FunctionDefinitionStart
Push 1: Literal -> IntegerLiteral
AddNode block1: IntegerLiteral(int0): node_xref1
Push 2: StatementEnd
Pop 2: StatementEnd
Pop 1: any (Literal) -> node0
Push 1: ReturnStatement -> ReturnExpression
AddNode block1: ReturnExpression(node0)
Pop 0: FunctionDefinitionStart
Push 0: FunctionDefinition
*** SemanticsParseTreeHandler::Build End ***
cross_reference_irs.size == 2,
cross_references = {
  node_xref0 = "xref(ir0, block0, node0)";
  node_xref1 = "xref(ir0, block0, node1)";
},
identifiers = {
  ident0 = "Foo";
},
integer_literals = {
  int0 = 0;
},
node_blocks = {
  block0 = {
    node0 = FunctionDeclaration();
    node1 = BindName(ident0, node0);
    node2 = FunctionDefinition(node0, block1);
  },
  block1 = {
    node0 = IntegerLiteral(int0): node_xref1;
    node1 = ReturnExpression(node0);
  },
}
```

Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
2022-11-11 14:10:13 -08:00

82 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_COMMON_CHECK_INTERNAL_H_
#define CARBON_COMMON_CHECK_INTERNAL_H_
#include <cstdlib>
#include "llvm/Support/ErrorHandling.h"
#include "llvm/Support/Signals.h"
#include "llvm/Support/raw_ostream.h"
namespace Carbon::Internal {
// Wraps a stream and exiting for fatal errors. Should only be used by check.h
// macros.
class ExitingStream {
public:
// A tag type that renders as ": " in an ExitingStream, but only if it is
// followed by additional output. Otherwise, it renders as "". Primarily used
// when building macros around these streams.
struct AddSeparator {};
// Internal type used in macros to dispatch to the `operator|` overload.
struct Helper {};
ExitingStream()
// Prefix the buffer with the current bug report message.
: buffer_(buffer_str_) {}
// Never called.
[[noreturn]] ~ExitingStream();
// If the bool cast occurs, it's because the condition is false. This supports
// && short-circuiting the creation of ExitingStream.
explicit operator bool() const { return true; }
// Forward output to llvm::errs.
template <typename T>
auto operator<<(const T& message) -> ExitingStream& {
if (separator_) {
buffer_ << ": ";
separator_ = false;
}
buffer_ << message;
return *this;
}
auto operator<<(AddSeparator /*add_separator*/) -> ExitingStream& {
separator_ = true;
return *this;
}
// Low-precedence binary operator overload used in check.h macros to flush the
// output and exit the program. We do this in a binary operator rather than
// the destructor to ensure good debug info and backtraces for errors.
[[noreturn]] friend auto operator|(Helper /*helper*/, ExitingStream& stream)
-> void {
stream.Done();
}
private:
[[noreturn]] auto Done() -> void;
// Whether a separator should be printed if << is used again.
bool separator_ = false;
std::string buffer_str_;
llvm::raw_string_ostream buffer_;
};
} // namespace Carbon::Internal
// Raw exiting stream. This should be used when building forms of exiting
// macros. It evaluates to a temporary `ExitingStream` object that can be
// manipulated, streamed into, and then will exit the program.
#define CARBON_CHECK_INTERNAL_STREAM() \
Carbon::Internal::ExitingStream::Helper() | Carbon::Internal::ExitingStream()
#endif // CARBON_COMMON_CHECK_INTERNAL_H_