carbon-lang/toolchain/check/return.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_RETURN_H_
#define CARBON_TOOLCHAIN_CHECK_RETURN_H_

#include "toolchain/check/context.h"
#include "toolchain/parse/tree.h"
#include "toolchain/sem_ir/inst.h"

namespace Carbon::Check {

// Checks a `returned var` binding and returns the location of the return
// value storage that the name should bind to.
auto CheckReturnedVar(Context& context, Parse::NodeId returned_node,
                      Parse::NodeId name_node, SemIR::NameId name_id,
                      Parse::NodeId type_node, SemIR::TypeId type_id)
    -> SemIR::InstId;

// Registers the given binding as the current `returned var` in this scope.
auto RegisterReturnedVar(Context& context, SemIR::InstId bind_id) -> void;

// Checks and builds SemIR for a `return;` statement.
auto BuildReturnWithNoExpr(Context& context,
                           Parse::ReturnStatementId parse_node) -> void;

// Checks and builds SemIR for a `return <expression>;` statement.
auto BuildReturnWithExpr(Context& context, Parse::ReturnStatementId parse_node,
                         SemIR::InstId expr_id) -> void;

// Checks and builds SemIR for a `return var;` statement.
auto BuildReturnVar(Context& context, Parse::ReturnStatementId parse_node)
    -> void;

}  // namespace Carbon::Check

#endif  // CARBON_TOOLCHAIN_CHECK_RETURN_H_