Files
carbon-lang/toolchain/semantics/semantics_parse_tree_handler.h
T
Jon Ross-Perkins f10531bcb3 Use macros to enforce handling parse nodes in SemanticsIR. (#2448)
This creates a bit of extra cost in adding parse nodes in that a TODO must be added to semantics, but I think the link is going to last this way long-term. In semantics, it reduces the boilerplate of the main for loop and makes it more obvious what's missing, leaving stub functions to be filled in.
2022-12-08 08:59:28 -08:00

105 lines
3.7 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_PARSE_TREE_HANDLER_H_
#define CARBON_TOOLCHAIN_SEMANTICS_SEMANTICS_PARSE_TREE_HANDLER_H_
#include "toolchain/parser/parse_tree.h"
#include "toolchain/semantics/semantics_ir.h"
#include "toolchain/semantics/semantics_node.h"
namespace Carbon {
// Handles processing of a ParseTree for semantics.
class SemanticsParseTreeHandler {
public:
// Stores references for work.
explicit SemanticsParseTreeHandler(const TokenizedBuffer& tokens,
TokenDiagnosticEmitter& emitter,
const ParseTree& parse_tree,
SemanticsIR& semantics,
llvm::raw_ostream* vlog_stream)
: tokens_(&tokens),
emitter_(&emitter),
parse_tree_(&parse_tree),
semantics_(&semantics),
vlog_stream_(vlog_stream) {}
// Outputs the ParseTree information into SemanticsIR.
auto Build() -> void;
private:
// Prints the node_stack_ on stack dumps.
class PrettyStackTraceNodeStack;
// Prints the node_block_stack_ on stack dumps.
class PrettyStackTraceNodeBlockStack;
struct TraversalStackEntry {
ParseTree::Node parse_node;
// The result_id may be invalid if there's no result.
SemanticsNodeId result_id;
};
static_assert(sizeof(TraversalStackEntry) == 8,
"Unexpected TraversalStackEntry size");
// Adds an identifier for a DeclaredName node, returning its reference.
auto AddIdentifier(ParseTree::Node decl_node) -> SemanticsIdentifierId;
// Adds a node to the current block, returning the produced ID.
auto AddNode(SemanticsNode node) -> SemanticsNodeId;
// Pushes a parse tree node onto the stack. Used when there is no IR generated
// by the node.
auto Push(ParseTree::Node parse_node) -> void;
// Pushes a parse tree node onto the stack, storing the SemanticsNode as the
// result.
auto Push(ParseTree::Node parse_node, SemanticsNode node) -> void;
// Pushes a parse tree node onto the stack with an already-built node ID.
auto Push(ParseTree::Node parse_node, SemanticsNodeId node_id) -> void;
// Pops the top of the stack, verifying that it's the expected kind.
auto Pop(ParseNodeKind pop_parse_kind) -> void;
// Pops the top of the stack, returning the result_id. Must only be called for
// nodes that have results.
auto PopWithResult() -> SemanticsNodeId;
// Pops the top of the stack, verifying that it's the expected kind and
// returning the result_id. Must only be called for nodes that have results.
auto PopWithResult(ParseNodeKind pop_parse_kind) -> SemanticsNodeId;
// Parse node handlers.
#define CARBON_PARSE_NODE_KIND(Name) \
auto Handle##Name(ParseTree::Node parse_node)->void;
#include "toolchain/parser/parse_node_kind.def"
// Tokens for getting data on literals.
const TokenizedBuffer* tokens_;
// Handles diagnostics.
TokenDiagnosticEmitter* emitter_;
// The file's parse tree.
const ParseTree* parse_tree_;
// The SemanticsIR being added to.
SemanticsIR* semantics_;
// Whether to print verbose output.
llvm::raw_ostream* vlog_stream_;
// The stack during Build. Will contain file-level parse nodes on return.
llvm::SmallVector<TraversalStackEntry> node_stack_;
// The stack of node blocks during build. Only updated on ParseTree nodes that
// affect the stack.
llvm::SmallVector<SemanticsNodeBlockId> node_block_stack_;
};
} // namespace Carbon
#endif // CARBON_TOOLCHAIN_SEMANTICS_SEMANTICS_PARSE_TREE_HANDLER_H_