Files
carbon-lang/toolchain/sem_ir/class.h
T
josh11bandJosh L c7a338be59 Replace uses of "defined" with "complete" (#5196)
As of #5087, these terms are no longer synonyms. This change preserves
the original meaning.

---------

Co-authored-by: Josh L <josh11b@users.noreply.github.com>
2025-03-27 18:14:26 +00:00

99 lines
3.4 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/entity_with_params_base.h"
#include "toolchain/sem_ir/ids.h"
namespace Carbon::SemIR {
// Class-specific fields.
struct ClassFields {
enum InheritanceKind : int8_t {
// `abstract class`
Abstract,
// `base class`
Base,
// `class`
Final,
};
// The following members always have values, and do not change throughout the
// lifetime of the class.
// The class type, which is the type of `Self` in the class definition.
TypeId self_type_id;
// The kind of inheritance that this class supports.
// TODO: The rules here are not yet decided. See #3384.
InheritanceKind inheritance_kind;
// Whether this class or any base class has at least one virtual function.
bool is_dynamic = false;
// The following members are set at the `{` of the class definition.
// The class scope.
NameScopeId scope_id = NameScopeId::None;
// The first block of the class body.
// TODO: Handle control flow in the class body, such as if-expressions.
InstBlockId body_block_id = InstBlockId::None;
// The following members are accumulated throughout the class definition.
// The adapted type declaration, if any. `None` 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::None;
// The base class declaration. `None` if the class has no base class. This is
// a BaseDecl instruction.
InstId base_id = InstId::None;
// The following members are set at the `}` of the class definition.
// A `CompleteTypeWitness` instruction witnessing that this class type is
// complete, and tracking its object representation. This has a value once the
// class is defined. For an adapter, the object representation is the
// non-adapter type that this class directly or transitively adapts.
InstId complete_type_witness_id = InstId::None;
// The virtual function table. `None` if the class has no (direct or
// inherited) virtual functions.
InstId vtable_id = InstId::None;
};
// A class. See EntityWithParamsBase regarding the inheritance here.
struct Class : public EntityWithParamsBase,
public ClassFields,
public Printable<Class> {
auto Print(llvm::raw_ostream& out) const -> void {
out << "{";
PrintBaseFields(out);
out << "}";
}
// This is false until we reach the `}` of the class definition.
auto is_complete() const -> bool {
return complete_type_witness_id.has_value();
}
// Gets the type that this class type adapts. Returns `None` if there is no
// such type, or if the class is not yet defined.
auto GetAdaptedType(const File& file, SpecificId specific_id) const -> TypeId;
// Gets the base class for this class type. Returns `None` if there is no
// such type, or if the class is not yet defined.
auto GetBaseType(const File& file, SpecificId specific_id) const -> TypeId;
// Gets the object representation for this class. Returns `None` if the class
// is not yet defined.
auto GetObjectRepr(const File& file, SpecificId specific_id) const -> TypeId;
};
} // namespace Carbon::SemIR
#endif // CARBON_TOOLCHAIN_SEM_IR_CLASS_H_