carbon-lang/toolchain/check/member_access.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_MEMBER_ACCESS_H_
#define CARBON_TOOLCHAIN_CHECK_MEMBER_ACCESS_H_

#include "toolchain/check/context.h"
#include "toolchain/sem_ir/ids.h"

namespace Carbon::Check {

// Returns the highest allowed access for members of `name_scope_const_id`. For
// example, if this returns `Protected` then only `Public` and `Protected`
// accesses are allowed -- not `Private`.
auto GetHighestAllowedAccess(Context& context, SemIR::LocId loc_id,
                             SemIR::ConstantId name_scope_const_id)
    -> SemIR::AccessKind;

// Creates SemIR to perform a member access with base expression `base_id` and
// member name `name_id`. When `required`, failing to find the name is a
// diagnosed error; otherwise, `None` is returned. Returns the result of the
// access.
auto PerformMemberAccess(Context& context, SemIR::LocId loc_id,
                         SemIR::InstId base_id, SemIR::NameId name_id,
                         bool required = true) -> SemIR::InstId;

// Creates SemIR to perform a compound member access with base expression
// `base_id` and member name expression `member_expr_id`. Returns the result of
// the access. If specified, `missing_impl_diagnostic_context()` is used to
// provide context for the error diagnostic when impl binding fails due to a
// missing `impl`.
//
// On failure, an ErrorInst is returned and a diagnostic is produced unless
// `diagnose` is false. It is incorrect to specify `diagnose` as false if the
// resulting ErrorInst may appear in the produced SemIR.
auto PerformCompoundMemberAccess(
    Context& context, SemIR::LocId loc_id, SemIR::InstId base_id,
    SemIR::InstId member_expr_id, bool diagnose = true,
    DiagnosticContextFn missing_impl_diagnostic_context = nullptr)
    -> SemIR::InstId;

// Finds the value of an associated entity (given by assoc_entity_inst_id, a
// member of the interface given by interface_type_id) associated with a type or
// facet (given by base_id). Never does instance binding.
auto GetAssociatedValue(Context& context, SemIR::LocId loc_id,
                        SemIR::InstId base_id,
                        SemIR::ConstantId assoc_entity_const_id,
                        SemIR::SpecificInterface interface) -> SemIR::InstId;

// Creates SemIR to perform a tuple index with base expression `tuple_inst_id`
// and index expression `index_inst_id`. Returns the result of the access.
auto PerformTupleAccess(Context& context, SemIR::LocId loc_id,
                        SemIR::InstId tuple_inst_id,
                        SemIR::InstId index_inst_id) -> SemIR::InstId;

}  // namespace Carbon::Check

#endif  // CARBON_TOOLCHAIN_CHECK_MEMBER_ACCESS_H_