mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-11-16 00:18:10 +00:00
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>
81 lines
3.0 KiB
C++
81 lines
3.0 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_TOOLCHAIN_SEMANTICS_SEMANTICS_NODE_KIND_H_
|
|
#define CARBON_TOOLCHAIN_SEMANTICS_SEMANTICS_NODE_KIND_H_
|
|
|
|
#include <cstdint>
|
|
|
|
#include "common/enum_base.h"
|
|
#include "llvm/ADT/FoldingSet.h"
|
|
|
|
namespace Carbon {
|
|
|
|
CARBON_DEFINE_RAW_ENUM_CLASS(SemanticsNodeKind, uint8_t) {
|
|
#define CARBON_SEMANTICS_NODE_KIND(Name) CARBON_RAW_ENUM_ENUMERATOR(Name)
|
|
#include "toolchain/semantics/semantics_node_kind.def"
|
|
};
|
|
|
|
// Whether a node produces or represents a value, and if so, what kind of value.
|
|
enum class SemanticsNodeValueKind {
|
|
// This node doesn't produce a value, and shouldn't be referenced by other
|
|
// nodes.
|
|
None,
|
|
// This node represents an untyped value. It may be referenced by other nodes
|
|
// expecting this kind of value.
|
|
Untyped,
|
|
// This node represents an expression or expression-like construct that
|
|
// produces a value of the type indicated by its `type_id` field.
|
|
Typed,
|
|
};
|
|
|
|
// Whether a node is a terminator or part of the terminator sequence. The nodes
|
|
// in a block appear in the order NotTerminator, then TerminatorSequence, then
|
|
// Terminator, which is also the numerical order of these values.
|
|
enum class SemanticsTerminatorKind {
|
|
// This node is not a terminator.
|
|
NotTerminator,
|
|
// This node is not itself a terminator, but forms part of a terminator
|
|
// sequence.
|
|
TerminatorSequence,
|
|
// This node is a terminator.
|
|
Terminator,
|
|
};
|
|
|
|
class SemanticsNodeKind : public CARBON_ENUM_BASE(SemanticsNodeKind) {
|
|
public:
|
|
#define CARBON_SEMANTICS_NODE_KIND(Name) CARBON_ENUM_CONSTANT_DECLARATION(Name)
|
|
#include "toolchain/semantics/semantics_node_kind.def"
|
|
|
|
using EnumBase::Create;
|
|
|
|
// Returns the name to use for this node kind in Semantics IR.
|
|
[[nodiscard]] auto ir_name() const -> llvm::StringRef;
|
|
|
|
// Returns whether this kind of node is expected to produce a value.
|
|
[[nodiscard]] auto value_kind() const -> SemanticsNodeValueKind;
|
|
|
|
// Returns whether this node kind is a code block terminator, such as an
|
|
// unconditional branch instruction, or part of the termination sequence,
|
|
// such as a conditional branch instruction. The termination sequence of a
|
|
// code block appears after all other instructions, and ends with a
|
|
// terminator instruction.
|
|
[[nodiscard]] auto terminator_kind() const -> SemanticsTerminatorKind;
|
|
|
|
// Compute a fingerprint for this node kind, allowing its use as part of the
|
|
// key in a `FoldingSet`.
|
|
void Profile(llvm::FoldingSetNodeID& id) { id.AddInteger(AsInt()); }
|
|
};
|
|
|
|
#define CARBON_SEMANTICS_NODE_KIND(Name) \
|
|
CARBON_ENUM_CONSTANT_DEFINITION(SemanticsNodeKind, Name)
|
|
#include "toolchain/semantics/semantics_node_kind.def"
|
|
|
|
// We expect the node kind to fit compactly into 8 bits.
|
|
static_assert(sizeof(SemanticsNodeKind) == 1, "Kind objects include padding!");
|
|
|
|
} // namespace Carbon
|
|
|
|
#endif // CARBON_TOOLCHAIN_SEMANTICS_SEMANTICS_NODE_KIND_H_
|