Files
carbon-lang/toolchain/sem_ir/class.h
T
Jon Ross-Perkins d9c62b106d Rename enclosing scope to parent scope (#4020)
Following up on discussion from #3948, doing a general rename of
"enclosing scope" to "parent scope" (and "enclosing scopes" to "ancestor
scopes"). The intent is to improve understandability and collide less
with C++ terminology for "enclosing scope". Note this changes most uses
of "enclosing", but leaves behind a few like "enclosing function" and
"enclosing block".

Note this does create some "parent class" mentions for "adapt" and "var"
(the class they're within), which is maybe unfortunate, but we'd
probably say "base class" if we meant inheritance so perhaps that's
okay. Along the same lines, these are the only `parent_class` uses I see
now, and we do have a few `base_class`.
2024-06-04 19:57:14 +00:00

87 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_SEM_IR_CLASS_H_
#define CARBON_TOOLCHAIN_SEM_IR_CLASS_H_
#include "toolchain/sem_ir/ids.h"
namespace Carbon::SemIR {
// A class.
struct Class : public Printable<Class> {
enum InheritanceKind : int8_t {
// `abstract class`
Abstract,
// `base class`
Base,
// `class`
Final,
};
auto Print(llvm::raw_ostream& out) const -> void {
out << "{name: " << name_id << ", parent_scope: " << parent_scope_id << "}";
}
// Determines whether this class has been fully defined. This is false until
// we reach the `}` of the class definition.
auto is_defined() const -> bool { return object_repr_id.is_valid(); }
// Determines whether this is a generic class.
auto is_generic() const -> bool {
return implicit_param_refs_id.is_valid() || param_refs_id.is_valid();
}
// The following members always have values, and do not change throughout the
// lifetime of the class.
// The class name.
NameId name_id;
// The parent scope.
NameScopeId parent_scope_id;
// A block containing a single reference instruction per implicit parameter.
InstBlockId implicit_param_refs_id;
// A block containing a single reference instruction per parameter.
InstBlockId param_refs_id;
// The class type, which is the type of `Self` in the class definition.
TypeId self_type_id;
// The first declaration of the class. This is a ClassDecl.
InstId decl_id = InstId::Invalid;
// The kind of inheritance that this class supports.
// TODO: The rules here are not yet decided. See #3384.
InheritanceKind inheritance_kind;
// The following members are set at the `{` of the class definition.
// The definition of the class. This is a ClassDecl.
InstId definition_id = InstId::Invalid;
// The class scope.
NameScopeId scope_id = NameScopeId::Invalid;
// The first block of the class body.
// TODO: Handle control flow in the class body, such as if-expressions.
InstBlockId body_block_id = InstBlockId::Invalid;
// The following members are accumulated throughout the class definition.
// The adapted type declaration, if any. Invalid if the class is not an
// adapter. This is an AdaptDecl instruction.
// TODO: Consider sharing the storage for `adapt_id` and `base_id`. A class
// can't have both.
InstId adapt_id = InstId::Invalid;
// The base class declaration. Invalid if the class has no base class. This is
// a BaseDecl instruction.
InstId base_id = InstId::Invalid;
// The following members are set at the `}` of the class definition.
// The object representation type to use for this class. This is valid once
// the class is defined. For an adapter, this is the non-adapter type that
// this class directly or transitively adapts.
TypeId object_repr_id = TypeId::Invalid;
};
} // namespace Carbon::SemIR
#endif // CARBON_TOOLCHAIN_SEM_IR_CLASS_H_