Files
carbon-lang/toolchain/semantics/semantics_node_kind.def
T
Richard SmithandChandler Carruth 6cbf280a68 Add formatted textual IR output (#3056)
Add a textual IR format to the toolchain.

The exact details of the format are somewhat arbitrary right now, and I
expect them to change as we refine the semantics IR model, but at the
moment they're somewhat directly following the current structure of the
IR.

Semantics tests currently test both the "raw" format, which shows the
details of the representation, and the textual format, which is somewhat
higher level. We may want to revisit that decision once the textual
format is a bit more stable, and test only the textual format in most of
these tests, but for now it seems prudent to keep both sets of tests.

---------

Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
2023-08-10 19:41:39 +00:00

93 lines
5.2 KiB
Modula-2

// 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
//
// This is an X-macro header. It does not use `#include` guards, and instead is
// designed to be `#include`ed after the x-macro is defined in order for its
// inclusion to expand to the desired output. Macro definitions are cleaned up
// at the end of this file.
//
// Exactly one of these macros should be defined before including this header:
// - CARBON_SEMANTICS_NODE_KIND(Name)
// Invoked for each kind of semantic node.
// - CARBON_SEMANTICS_NODE_KIND_WITH_VALUE_KIND(Name, TypeFieldKind)
// Invoked for each kind of semantic node, along with information about
// whether the node produces a value, and if so, what kind of value.
// - CARBON_SEMANTICS_NODE_KIND_WITH_TERMINATOR_KIND(Name, TerminatorKind)
// Invoked for each kind of semantic node, along with information about
// whether the node is a terminator node.
// - CARBON_SEMANTICS_NODE_KIND_WITH_IR_NAME(Name, IRName)
// Invoked for each kind of semantic node, along with the name that is used
// to denote this node in textual Semantics IR.
#if defined(CARBON_SEMANTICS_NODE_KIND)
#define CARBON_SEMANTICS_NODE_KIND_IMPL(Name, IRName, ValueKind, \
TerminatorKind) \
CARBON_SEMANTICS_NODE_KIND(Name)
#elif defined(CARBON_SEMANTICS_NODE_KIND_WITH_VALUE_KIND)
#define CARBON_SEMANTICS_NODE_KIND_IMPL(Name, IRName, ValueKind, \
TerminatorKind) \
CARBON_SEMANTICS_NODE_KIND_WITH_VALUE_KIND(Name, ValueKind)
#elif defined(CARBON_SEMANTICS_NODE_KIND_WITH_TERMINATOR_KIND)
#define CARBON_SEMANTICS_NODE_KIND_IMPL(Name, IRName, ValueKind, \
TerminatorKind) \
CARBON_SEMANTICS_NODE_KIND_WITH_TERMINATOR_KIND(Name, TerminatorKind)
#elif defined(CARBON_SEMANTICS_NODE_KIND_WITH_IR_NAME)
#define CARBON_SEMANTICS_NODE_KIND_IMPL(Name, IRName, ValueKind, \
TerminatorKind) \
CARBON_SEMANTICS_NODE_KIND_WITH_IR_NAME(Name, IRName)
#else
#error "Must define the x-macro to use this file."
#endif
CARBON_SEMANTICS_NODE_KIND_IMPL(Invalid, "invalid", None, NotTerminator)
// A cross-reference between IRs.
CARBON_SEMANTICS_NODE_KIND_IMPL(CrossReference, "xref", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(AddressOf, "address_of", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(Assign, "assign", None, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(BinaryOperatorAdd, "add", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(BindName, "bind_name", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(BlockArg, "block_arg", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(BoolLiteral, "bool_value", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(Branch, "br", None, Terminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(BranchIf, "br", None, TerminatorSequence)
CARBON_SEMANTICS_NODE_KIND_IMPL(BranchWithArg, "br", None, Terminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(Builtin, "builtin", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(Call, "call", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(ConstType, "const_type", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(Dereference, "dereference", Typed,
NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(FunctionDeclaration, "fn_decl", Untyped,
NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(Index, "tuple_index", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(IntegerLiteral, "int_value", Typed,
NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(Namespace, "namespace", Untyped, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(PointerType, "ptr_type", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(RealLiteral, "real_value", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(Return, "return", None, Terminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(ReturnExpression, "return", None, Terminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(StringLiteral, "string_value", Typed,
NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(StructMemberAccess, "struct_access", Typed,
NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(StructType, "struct_type", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(StructTypeField, "struct_type_field", None,
NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(StructValue, "struct_value", Typed,
NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(StubReference, "stub_reference", Typed,
NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(TupleType, "tuple_type", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(TupleValue, "tuple_value", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(UnaryOperatorNot, "not", Typed, NotTerminator)
CARBON_SEMANTICS_NODE_KIND_IMPL(VarStorage, "var", Typed, NotTerminator)
#undef CARBON_SEMANTICS_NODE_KIND
#undef CARBON_SEMANTICS_NODE_KIND_WITH_VALUE_KIND
#undef CARBON_SEMANTICS_NODE_KIND_WITH_TERMINATOR_KIND
#undef CARBON_SEMANTICS_NODE_KIND_WITH_IR_NAME
#undef CARBON_SEMANTICS_NODE_KIND_IMPL