node_stack.h

// 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_CHECK_NODE_STACK_H_
#define CARBON_TOOLCHAIN_CHECK_NODE_STACK_H_

#include "common/vlog.h"
#include "llvm/ADT/SmallVector.h"
#include "toolchain/parse/node_ids.h"
#include "toolchain/parse/node_kind.h"
#include "toolchain/parse/tree.h"
#include "toolchain/parse/typed_nodes.h"
#include "toolchain/sem_ir/id_kind.h"
#include "toolchain/sem_ir/ids.h"

namespace Carbon::Check {

// A non-discriminated union of ID types.
class IdUnion {
 public:
  // The default constructor forms a `None` ID.
  explicit constexpr IdUnion() : index(AnyIdBase::NoneIndex) {}

  template <typename IdT>
    requires SemIR::IdKind::Contains<IdT>
  explicit constexpr IdUnion(IdT id) : index(id.index) {}

  using Kind = SemIR::IdKind::RawEnumType;

  // Returns the ID given its type.
  template <typename IdT>
    requires SemIR::IdKind::Contains<IdT>
  constexpr auto As() const -> IdT {
    return IdT(index);
  }

  // Returns the ID given its kind.
  template <SemIR::IdKind::RawEnumType K>
  constexpr auto As() const -> SemIR::IdKind::TypeFor<K> {
    return As<SemIR::IdKind::TypeFor<K>>();
  }

  // Translates an ID type to the enum ID kind. Returns `None` if `IdT` isn't
  // a type that can be stored in this union.
  template <typename IdT>
  static constexpr auto KindFor() -> Kind {
    return SemIR::IdKind::For<IdT>;
  }

 private:
  decltype(AnyIdBase::index) index;
};

// The stack of parse nodes representing the current state of a Check::Context.
// Each parse node can have an associated id of some kind (instruction,
// instruction block, function, class, ...).
//
// All pushes and pops will be vlogged.
//
// Pop APIs will run basic verification:
//
// - If receiving a Parse::NodeKind, verify that the node_id being popped has
//   that kind. Similarly, if receiving a Parse::NodeCategory, make sure the
//   of the popped node_id overlaps that category.
// - Validates the kind of id data in the node based on the kind or category of
//   the node_id.
//
// These should be assumed API constraints unless otherwise mentioned on a
// method. The main exception is PopAndIgnore, which doesn't do verification.
class NodeStack {
 public:
  explicit NodeStack(const Parse::Tree& parse_tree,
                     llvm::raw_ostream* vlog_stream)
      : parse_tree_(&parse_tree), vlog_stream_(vlog_stream) {}

  // Pushes a solo parse tree node onto the stack. Used when there is no
  // IR generated by the node.
  auto Push(Parse::NodeId node_id) -> void {
    auto kind = parse_tree_->node_kind(node_id);
    CARBON_CHECK(NodeKindToIdKind(kind) == Id::Kind::None,
                 "Parse kind expects an Id: {0}", kind);
    CARBON_VLOG("Node Push {0}: {1} -> <none>\n", stack_.size(), kind);
    CARBON_CHECK(stack_.size() < (1 << 20),
                 "Excessive stack size: likely infinite loop");
    stack_.push_back({.node_id = node_id, .id = Id()});
  }

  // Pushes a parse tree node onto the stack with an ID.
  template <typename IdT>
  auto Push(Parse::NodeId node_id, IdT id) -> void {
    auto kind = parse_tree_->node_kind(node_id);
    CARBON_CHECK(NodeKindToIdKind(kind) == Id::KindFor<IdT>(),
                 "Parse kind expected a different IdT: {0} -> {1}\n", kind, id);
    CARBON_CHECK(id.has_value(), "Push called with `None` id: {0}",
                 parse_tree_->node_kind(node_id));
    CARBON_VLOG("Node Push {0}: {1} -> {2}\n", stack_.size(), kind, id);
    CARBON_CHECK(stack_.size() < (1 << 20),
                 "Excessive stack size: likely infinite loop");
    stack_.push_back({.node_id = node_id, .id = Id(id)});
  }

  // TODO: Most parse nodes don't know about TypeInstId, so downgrade TypeInstId
  // to InstId to match expectations. We should teach parse nodes that will
  // receive a TypeInstId to expect it, and this function can go away.
  auto Push(Parse::NodeId node_id, SemIR::TypeInstId id) -> void {
    auto kind = parse_tree_->node_kind(node_id);
    if (NodeKindToIdKind(kind) == Id::KindFor<SemIR::InstId>()) {
      Push<SemIR::InstId>(node_id, id);
    } else {
      Push<SemIR::TypeInstId>(node_id, id);
    }
  }

  // Returns whether there is a node of the specified kind on top of the stack.
  auto PeekIs(Parse::NodeKind kind) const -> bool {
    return !stack_.empty() && PeekNodeKind() == kind;
  }

  // Returns whether the node on the top of the stack has an overlapping
  // category.
  auto PeekIs(Parse::NodeCategory category) const -> bool {
    return !stack_.empty() && PeekNodeKind().category().HasAnyOf(category);
  }

  // Returns whether there is a node with the corresponding ID on top of the
  // stack.
  template <typename IdT>
  auto PeekIs() const -> bool {
    return !stack_.empty() &&
           NodeKindToIdKind(PeekNodeKind()) == Id::KindFor<IdT>();
  }

  // Returns whether the *next* node on the stack is a given kind. This doesn't
  // have the breadth of support versus other Peek functions because it's
  // expected to be used in narrow circumstances when determining how to treat
  // the *current* top of the stack.
  auto PeekNextIs(Parse::NodeKind kind) const -> bool {
    CARBON_CHECK(stack_.size() >= 2);
    return parse_tree_->node_kind(stack_[stack_.size() - 2].node_id) == kind;
  }

  // Pops the top of the stack without any verification.
  auto PopAndIgnore() -> void {
    Entry back = stack_.pop_back_val();
    CARBON_VLOG("Node Pop {0}: {1} -> <ignored>\n", stack_.size(),
                parse_tree_->node_kind(back.node_id));
  }

  // Pops the top of the stack and returns the node_id.
  template <const Parse::NodeKind& RequiredParseKind>
  auto PopForSoloNodeId() -> Parse::NodeIdForKind<RequiredParseKind> {
    Entry back = PopEntry<SemIR::InstId>();
    RequireIdKind(RequiredParseKind, Id::Kind::None);
    return parse_tree_->As<Parse::NodeIdForKind<RequiredParseKind>>(
        back.node_id);
  }

  // Pops the top of the stack if it is the given kind, and returns the
  // node_id. Otherwise, returns std::nullopt.
  template <const Parse::NodeKind& RequiredParseKind>
  auto PopForSoloNodeIdIf()
      -> std::optional<Parse::NodeIdForKind<RequiredParseKind>> {
    if (PeekIs(RequiredParseKind)) {
      return PopForSoloNodeId<RequiredParseKind>();
    }
    return std::nullopt;
  }

  // Pops the top of the stack.
  template <const Parse::NodeKind& RequiredParseKind>
  auto PopAndDiscardSoloNodeId() -> void {
    PopForSoloNodeId<RequiredParseKind>();
  }

  // Pops the top of the stack if it is the given kind. Returns `true` if a node
  // was popped.
  template <const Parse::NodeKind& RequiredParseKind>
  auto PopAndDiscardSoloNodeIdIf() -> bool {
    if (!PeekIs(RequiredParseKind)) {
      return false;
    }
    PopForSoloNodeId<RequiredParseKind>();
    return true;
  }

  // Pops an expression from the top of the stack and returns the node_id and
  // the ID.
  auto PopExprWithNodeId() -> std::pair<Parse::AnyExprId, SemIR::InstId>;

  // Pops a pattern from the top of the stack and returns the node_id and
  // the ID.
  auto PopPatternWithNodeId() -> std::pair<Parse::NodeId, SemIR::InstId> {
    return PopWithNodeId<SemIR::InstId>();
  }

  // Pops a name from the top of the stack and returns the node_id and
  // the ID.
  auto PopNameWithNodeId() -> std::pair<Parse::NodeId, SemIR::NameId> {
    return PopWithNodeId<SemIR::NameId>();
  }

  // Pops the top of the stack and returns the node_id and the ID.
  template <const Parse::NodeKind& RequiredParseKind>
  auto PopWithNodeId() -> auto {
    auto id = Peek<RequiredParseKind>();
    auto node_id = parse_tree_->As<Parse::NodeIdForKind<RequiredParseKind>>(
        stack_.pop_back_val().node_id);
    return std::make_pair(node_id, id);
  }

  // Pops the top of the stack and returns the node_id and the ID.
  template <Parse::NodeCategory::RawEnumType RequiredParseCategory>
  auto PopWithNodeId() -> auto {
    auto id = Peek<RequiredParseCategory>();
    auto node_id =
        parse_tree_->As<Parse::NodeIdInCategory<RequiredParseCategory>>(
            stack_.pop_back_val().node_id);
    return std::make_pair(node_id, id);
  }

  // Pops an expression from the top of the stack and returns the ID.
  // Expressions always map Parse::NodeCategory::Expr nodes to SemIR::InstId.
  auto PopExpr() -> SemIR::InstId { return PopExprWithNodeId().second; }

  // Pops a pattern from the top of the stack and returns the ID.
  // Patterns map multiple Parse::NodeKinds to SemIR::InstId always.
  // TODO: TuplePatterns store an InstBlockId instead and must be dealt with as
  // a special case before calling this function.
  auto PopPattern() -> SemIR::InstId { return PopPatternWithNodeId().second; }

  // Pops a name from the top of the stack and returns the ID.
  auto PopName() -> SemIR::NameId { return PopNameWithNodeId().second; }

  // Pops the top of the stack and returns the ID.
  template <const Parse::NodeKind& RequiredParseKind>
  auto Pop() -> auto {
    return PopWithNodeId<RequiredParseKind>().second;
  }

  // Pops the top of the stack and returns the ID.
  template <Parse::NodeCategory::RawEnumType RequiredParseCategory>
  auto Pop() -> auto {
    return PopWithNodeId<RequiredParseCategory>().second;
  }

  // Pops the top of the stack and returns the ID.
  template <typename IdT>
  auto Pop() -> IdT {
    return PopWithNodeId<IdT>().second;
  }

  // Pops the top of the stack if it has the given kind, and returns the ID.
  // Otherwise returns std::nullopt.
  template <const Parse::NodeKind& RequiredParseKind>
  auto PopIf() -> std::optional<decltype(Pop<RequiredParseKind>())> {
    if (PeekIs(RequiredParseKind)) {
      return Pop<RequiredParseKind>();
    }
    return std::nullopt;
  }

  // Pops the top of the stack if it has the given category, and returns the ID.
  // Otherwise returns std::nullopt.
  template <Parse::NodeCategory::RawEnumType RequiredParseCategory>
  auto PopIf() -> std::optional<decltype(Pop<RequiredParseCategory>())> {
    if (PeekIs(RequiredParseCategory)) {
      return Pop<RequiredParseCategory>();
    }
    return std::nullopt;
  }

  // Pops the top of the stack if it has the given category, and returns the ID.
  // Otherwise returns std::nullopt.
  template <typename IdT>
  auto PopIf() -> std::optional<IdT> {
    if (PeekIs<IdT>()) {
      return Pop<IdT>();
    }
    return std::nullopt;
  }

  // Pops the top of the stack and returns the node_id and the ID if it is
  // of the specified kind.
  template <const Parse::NodeKind& RequiredParseKind>
  auto PopWithNodeIdIf() -> std::pair<Parse::NodeIdForKind<RequiredParseKind>,
                                      decltype(PopIf<RequiredParseKind>())> {
    if (!PeekIs(RequiredParseKind)) {
      return {Parse::NodeId::None, std::nullopt};
    }
    return PopWithNodeId<RequiredParseKind>();
  }

  // Pops the top of the stack and returns the node_id and the ID if it is
  // of the specified category.
  template <Parse::NodeCategory::RawEnumType RequiredParseCategory>
  auto PopWithNodeIdIf()
      -> std::pair<Parse::NodeIdInCategory<RequiredParseCategory>,
                   decltype(PopIf<RequiredParseCategory>())> {
    if (!PeekIs(RequiredParseCategory)) {
      return {Parse::NodeId::None, std::nullopt};
    }
    return PopWithNodeId<RequiredParseCategory>();
  }

  // Peeks at the parse node of the top of the node stack.
  auto PeekNodeId() const -> Parse::NodeId { return stack_.back().node_id; }

  // Peeks at the kind of the parse node of the top of the node stack.
  auto PeekNodeKind() const -> Parse::NodeKind {
    return parse_tree_->node_kind(PeekNodeId());
  }

  // Peeks at the ID associated with the top of the name stack.
  template <const Parse::NodeKind& RequiredParseKind>
  auto Peek() const -> auto {
    Entry back = stack_.back();
    CARBON_CHECK(RequiredParseKind == parse_tree_->node_kind(back.node_id),
                 "Expected {0}, found {1}", RequiredParseKind,
                 parse_tree_->node_kind(back.node_id));
    constexpr Id::Kind RequiredIdKind = NodeKindToIdKind(RequiredParseKind);
    return Peek<RequiredIdKind>();
  }

  // Peeks at the ID associated with the top of the name stack.
  template <Parse::NodeCategory::RawEnumType RequiredParseCategory>
  auto Peek() const -> auto {
    Entry back = stack_.back();
    RequireParseCategory<RequiredParseCategory>(back.node_id);
    constexpr std::optional<Id::Kind> RequiredIdKind =
        NodeCategoryToIdKind(RequiredParseCategory, false);
    static_assert(RequiredIdKind.has_value());
    return Peek<*RequiredIdKind>();
  }

  // Peeks at the ID associated with the pattern at the top of the stack.
  // Patterns map multiple Parse::NodeKinds to SemIR::InstId always.
  // TODO: TuplePatterns store an InstBlockId instead and must be dealt with as
  // a special case before calling this function.
  auto PeekPattern() const -> SemIR::InstId;

  // Prints the stack for a stack dump.
  auto PrintForStackDump(int indent, llvm::raw_ostream& output) const -> void;

  auto empty() const -> bool { return stack_.empty(); }
  auto size() const -> size_t { return stack_.size(); }

 private:
  // An ID that can be associated with a parse node.
  //
  // Each parse node kind has a corresponding Id::Kind indicating which kind of
  // ID is stored, computed by NodeKindToIdKind. Id::Kind::None indicates
  // that the parse node has no associated ID, in which case the *SoloNodeId
  // functions should be used to push and pop it. Id::Kind::Invalid indicates
  // that the parse node should not appear in the node stack at all.
  using Id = IdUnion;

  // An entry in stack_.
  struct Entry {
    // The parse node associated with the stack entry.
    Parse::NodeId node_id;

    // The ID associated with this parse node. The kind of ID is determined by
    // the kind of the parse node, so a separate discriminiator is not needed.
    Id id;
  };
  static_assert(sizeof(Entry) == 8, "Unexpected Entry size");

  // Translate a parse node category to the enum ID kind it should always
  // provide, if it is consistent.
  static constexpr auto NodeCategoryToIdKind(Parse::NodeCategory category,
                                             bool for_node_kind)
      -> std::optional<Id::Kind> {
    std::optional<Id::Kind> result;
    auto set_id_if_category_is = [&](Parse::NodeCategory cat, Id::Kind kind) {
      if (category.HasAnyOf(cat)) {
        // Check for no consistent Id::Kind due to category with multiple bits
        // set. When computing the Id::Kind for a node kind, a partial category
        // match is OK, so long as we don't match two inconsistent categories.
        // When computing the Id::Kind for a category query, the query can't
        // have any extra bits set or we could be popping a node that is not in
        // this category.
        if (for_node_kind ? result.has_value() : category.HasAnyOf(~cat)) {
          result = Id::Kind::Invalid;
        } else {
          result = kind;
        }
      }
    };

    set_id_if_category_is(Parse::NodeCategory::Pattern,
                          Id::KindFor<SemIR::InstId>());
    set_id_if_category_is(Parse::NodeCategory::Expr,
                          Id::KindFor<SemIR::InstId>());
    set_id_if_category_is(
        Parse::NodeCategory::MemberName | Parse::NodeCategory::NonExprName,
        Id::KindFor<SemIR::NameId>());
    set_id_if_category_is(Parse::NodeCategory::ImplAs,
                          Id::KindFor<SemIR::TypeInstId>());
    set_id_if_category_is(Parse::NodeCategory::Decl |
                              Parse::NodeCategory::Statement |
                              Parse::NodeCategory::Modifier,
                          Id::Kind::None);
    return result;
  }

  // Translate a parse node kind to the enum ID kind it should always
  // provide, for the cases where this is not known from the category.
  static constexpr auto NodeKindToIdKindSpecialCases(Parse::NodeKind node_kind)
      -> std::optional<Id::Kind> {
    switch (node_kind) {
      case Parse::NodeKind::CallExprStart:
      case Parse::NodeKind::FieldNameAndType:
      case Parse::NodeKind::IfExprThen:
      case Parse::NodeKind::ReturnType:
      case Parse::NodeKind::ShortCircuitOperandAnd:
      case Parse::NodeKind::ShortCircuitOperandOr:
      case Parse::NodeKind::StructLiteralField:
      case Parse::NodeKind::WhereOperand:
        return Id::KindFor<SemIR::InstId>();
      case Parse::NodeKind::ExplicitParamList:
      case Parse::NodeKind::IfCondition:
      case Parse::NodeKind::IfExprIf:
      case Parse::NodeKind::ImplicitParamList:
      case Parse::NodeKind::WhileCondition:
      case Parse::NodeKind::WhileConditionStart:
        return Id::KindFor<SemIR::InstBlockId>();
      case Parse::NodeKind::FunctionDefinitionStart:
      case Parse::NodeKind::BuiltinFunctionDefinitionStart:
        return Id::KindFor<SemIR::FunctionId>();
      case Parse::NodeKind::ChoiceDefinitionStart:
        // TODO: Should we have a separate SemIR::ChoiceId?
      case Parse::NodeKind::ClassDefinitionStart:
        return Id::KindFor<SemIR::ClassId>();
      case Parse::NodeKind::InterfaceDefinitionStart:
        return Id::KindFor<SemIR::InterfaceId>();
      case Parse::NodeKind::ImplDefinitionStart:
        return Id::KindFor<SemIR::ImplId>();
      case Parse::NodeKind::SelfTypeName:
      case Parse::NodeKind::SelfValueName:
        return Id::KindFor<SemIR::NameId>();
      case Parse::NodeKind::DefaultLibrary:
      case Parse::NodeKind::LibraryName:
        return Id::KindFor<SemIR::LibraryNameId>();
      case Parse::NodeKind::BuiltinName:
      case Parse::NodeKind::ChoiceIntroducer:
      case Parse::NodeKind::ClassIntroducer:
      case Parse::NodeKind::CodeBlockStart:
      case Parse::NodeKind::ExplicitParamListStart:
      case Parse::NodeKind::FieldInitializer:
      case Parse::NodeKind::FieldIntroducer:
      case Parse::NodeKind::FunctionIntroducer:
      case Parse::NodeKind::IfStatementElse:
      case Parse::NodeKind::ImplicitParamListStart:
      case Parse::NodeKind::ImplIntroducer:
      case Parse::NodeKind::InterfaceIntroducer:
      case Parse::NodeKind::LetInitializer:
      case Parse::NodeKind::LetIntroducer:
      case Parse::NodeKind::ReturnStatementStart:
      case Parse::NodeKind::StructLiteralStart:
      case Parse::NodeKind::StructTypeLiteralField:
      case Parse::NodeKind::StructTypeLiteralStart:
      case Parse::NodeKind::TemplateBindingName:
      case Parse::NodeKind::TupleLiteralStart:
      case Parse::NodeKind::TuplePatternStart:
      case Parse::NodeKind::VariableInitializer:
      case Parse::NodeKind::VariableIntroducer:
        return Id::Kind::None;
      case Parse::NodeKind::AdaptIntroducer:
      case Parse::NodeKind::AliasInitializer:
      case Parse::NodeKind::AliasIntroducer:
      case Parse::NodeKind::ArrayExprComma:
      case Parse::NodeKind::ArrayExprKeyword:
      case Parse::NodeKind::ArrayExprOpenParen:
      case Parse::NodeKind::BaseColon:
      case Parse::NodeKind::BaseIntroducer:
      case Parse::NodeKind::BreakStatementStart:
      case Parse::NodeKind::CallExprComma:
      case Parse::NodeKind::ChoiceAlternativeListComma:
      case Parse::NodeKind::CodeBlock:
      case Parse::NodeKind::ContinueStatementStart:
      case Parse::NodeKind::CorePackageName:
      case Parse::NodeKind::ExportIntroducer:
      case Parse::NodeKind::FileEnd:
      case Parse::NodeKind::FileStart:
      case Parse::NodeKind::Forall:
      case Parse::NodeKind::ForHeader:
      case Parse::NodeKind::ForHeaderStart:
      case Parse::NodeKind::ForIn:
      case Parse::NodeKind::IdentifierNameQualifierWithParams:
      case Parse::NodeKind::IdentifierNameQualifierWithoutParams:
      case Parse::NodeKind::IdentifierPackageName:
      case Parse::NodeKind::IfConditionStart:
      case Parse::NodeKind::ImportIntroducer:
      case Parse::NodeKind::IndexExprStart:
      case Parse::NodeKind::InvalidParseStart:
      case Parse::NodeKind::KeywordNameQualifierWithParams:
      case Parse::NodeKind::KeywordNameQualifierWithoutParams:
      case Parse::NodeKind::LibraryIntroducer:
      case Parse::NodeKind::LibrarySpecifier:
      case Parse::NodeKind::MatchCase:
      case Parse::NodeKind::MatchCaseEqualGreater:
      case Parse::NodeKind::MatchCaseGuard:
      case Parse::NodeKind::MatchCaseGuardIntroducer:
      case Parse::NodeKind::MatchCaseGuardStart:
      case Parse::NodeKind::MatchCaseIntroducer:
      case Parse::NodeKind::MatchCaseStart:
      case Parse::NodeKind::MatchCondition:
      case Parse::NodeKind::MatchConditionStart:
      case Parse::NodeKind::MatchDefault:
      case Parse::NodeKind::MatchDefaultEqualGreater:
      case Parse::NodeKind::MatchDefaultIntroducer:
      case Parse::NodeKind::MatchDefaultStart:
      case Parse::NodeKind::MatchIntroducer:
      case Parse::NodeKind::MatchStatementStart:
      case Parse::NodeKind::NamedConstraintDefinitionStart:
      case Parse::NodeKind::NamedConstraintIntroducer:
      case Parse::NodeKind::NamespaceStart:
      case Parse::NodeKind::PackageIntroducer:
      case Parse::NodeKind::ParenExprStart:
      case Parse::NodeKind::PatternListComma:
      case Parse::NodeKind::Placeholder:
      case Parse::NodeKind::RequirementAnd:
      case Parse::NodeKind::RequirementEqual:
      case Parse::NodeKind::RequirementEqualEqual:
      case Parse::NodeKind::RequirementImpls:
      case Parse::NodeKind::StructLiteralComma:
      case Parse::NodeKind::StructFieldDesignator:
      case Parse::NodeKind::StructTypeLiteralComma:
      case Parse::NodeKind::TupleLiteralComma:
        return Id::Kind::Invalid;
      default:
        // In this case, the kind must be determinable from the category, or we
        // will produce a build error.
        return std::nullopt;
    }
  }

  using IdKindTableType = std::array<Id::Kind, Parse::NodeKind::ValidCount>;

  // Lookup table to implement `NodeKindToIdKind`. Initialized to the
  // return value of `ComputeIdKindTable()`.
  static const IdKindTableType IdKindTable;

  static consteval auto ComputeIdKindTable() -> IdKindTableType {
    IdKindTableType table = {};

    auto to_id_kind =
        [](const Parse::NodeKind::Definition& node_kind) -> Id::Kind {
      if (auto from_category =
              NodeCategoryToIdKind(node_kind.category(), true)) {
        return *from_category;
      }
      // Assume any node kind that doesn't have an ID kind from its category nor
      // a special case can't appear on the stack just so we can build a table
      // and avoid follow-on errors. We'll enforce at compile time that a value
      // is actually specified in CheckIdKindTable.
      return NodeKindToIdKindSpecialCases(node_kind).value_or(
          Id::Kind::Invalid);
    };

#define CARBON_PARSE_NODE_KIND(Name) \
  table[Parse::Name::Kind.AsInt()] = to_id_kind(Parse::Name::Kind);
#include "toolchain/parse/node_kind.def"

    return table;
  }

  // Check that an Id::Kind is specified for every node kind.
  static auto CheckIdKindTable() -> void;

  // Translate a parse node kind to the enum ID kind it should always provide.
  static constexpr auto NodeKindToIdKind(Parse::NodeKind kind) -> Id::Kind {
    return IdKindTable[kind.AsInt()];
  }

  // Peeks at the ID associated with the top of the name stack.
  template <Id::Kind RequiredIdKind>
  auto Peek() const -> auto {
    Id id = stack_.back().id;
    return id.As<RequiredIdKind>();
  }

  // Pops an entry.
  template <typename IdT>
  auto PopEntry() -> Entry {
    Entry back = stack_.pop_back_val();
    CARBON_VLOG("Node Pop {0}: {1} -> {2}\n", stack_.size(),
                parse_tree_->node_kind(back.node_id),
                back.id.template As<IdT>());
    return back;
  }

  // Pops the top of the stack and returns the node_id and the ID.
  template <typename IdT>
  auto PopWithNodeId() -> std::pair<Parse::NodeId, IdT> {
    Entry back = PopEntry<IdT>();
    RequireIdKind(parse_tree_->node_kind(back.node_id), Id::KindFor<IdT>());
    return {back.node_id, back.id.template As<IdT>()};
  }

  // Require a Parse::NodeKind be mapped to a particular Id::Kind.
  auto RequireIdKind(Parse::NodeKind parse_kind, Id::Kind id_kind) const
      -> void {
    CARBON_CHECK(NodeKindToIdKind(parse_kind) == id_kind,
                 "Unexpected Id::Kind mapping for {0}: expected {1}, found {2}",
                 parse_kind, SemIR::IdKind(id_kind),
                 SemIR::IdKind(NodeKindToIdKind(parse_kind)));
  }

  // Require an entry to have the given Parse::NodeCategory.
  template <Parse::NodeCategory::RawEnumType RequiredParseCategory>
  auto RequireParseCategory(Parse::NodeId node_id) const -> void {
    auto kind = parse_tree_->node_kind(node_id);
    CARBON_CHECK(kind.category().HasAnyOf(RequiredParseCategory),
                 "Expected {0}, found {1} with category {2}",
                 RequiredParseCategory, kind, kind.category());
  }

  // The file's parse tree.
  const Parse::Tree* parse_tree_;

  // Whether to print verbose output.
  llvm::raw_ostream* vlog_stream_;

  // The actual stack.
  // PushEntry and PopEntry control modification in order to centralize
  // vlogging.
  llvm::SmallVector<Entry> stack_;
};

constexpr NodeStack::IdKindTableType NodeStack::IdKindTable =
    ComputeIdKindTable();

inline auto NodeStack::PopExprWithNodeId()
    -> std::pair<Parse::AnyExprId, SemIR::InstId> {
  return PopWithNodeId<Parse::NodeCategory::Expr>();
}

inline auto NodeStack::PeekPattern() const -> SemIR::InstId {
  return Peek<Id::KindFor<SemIR::InstId>()>();
}

}  // namespace Carbon::Check

#endif  // CARBON_TOOLCHAIN_CHECK_NODE_STACK_H_