handle_class.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781
  1. // Part of the Carbon Language project, under the Apache License v2.0 with LLVM
  2. // Exceptions. See /LICENSE for license information.
  3. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  4. #include "toolchain/base/kind_switch.h"
  5. #include "toolchain/check/context.h"
  6. #include "toolchain/check/convert.h"
  7. #include "toolchain/check/decl_name_stack.h"
  8. #include "toolchain/check/diagnostic_helpers.h"
  9. #include "toolchain/check/eval.h"
  10. #include "toolchain/check/generic.h"
  11. #include "toolchain/check/handle.h"
  12. #include "toolchain/check/import.h"
  13. #include "toolchain/check/import_ref.h"
  14. #include "toolchain/check/merge.h"
  15. #include "toolchain/check/modifiers.h"
  16. #include "toolchain/check/name_component.h"
  17. #include "toolchain/check/name_lookup.h"
  18. #include "toolchain/check/type_completion.h"
  19. #include "toolchain/parse/node_ids.h"
  20. #include "toolchain/sem_ir/function.h"
  21. #include "toolchain/sem_ir/ids.h"
  22. #include "toolchain/sem_ir/inst.h"
  23. #include "toolchain/sem_ir/typed_insts.h"
  24. namespace Carbon::Check {
  25. // If `type_id` is a class type, get its corresponding `SemIR::Class` object.
  26. // Otherwise returns `nullptr`.
  27. static auto TryGetAsClass(Context& context, SemIR::TypeId type_id)
  28. -> SemIR::Class* {
  29. auto class_type = context.types().TryGetAs<SemIR::ClassType>(type_id);
  30. if (!class_type) {
  31. return nullptr;
  32. }
  33. return &context.classes().Get(class_type->class_id);
  34. }
  35. auto HandleParseNode(Context& context, Parse::ClassIntroducerId node_id)
  36. -> bool {
  37. // Create an instruction block to hold the instructions created as part of the
  38. // class signature, such as generic parameters.
  39. context.inst_block_stack().Push();
  40. // Push the bracketing node.
  41. context.node_stack().Push(node_id);
  42. // Optional modifiers and the name follow.
  43. context.decl_introducer_state_stack().Push<Lex::TokenKind::Class>();
  44. context.decl_name_stack().PushScopeAndStartName();
  45. // This class is potentially generic.
  46. StartGenericDecl(context);
  47. return true;
  48. }
  49. // Tries to merge new_class into prev_class_id. Since new_class won't have a
  50. // definition even if one is upcoming, set is_definition to indicate the planned
  51. // result.
  52. //
  53. // If merging is successful, returns true and may update the previous class.
  54. // Otherwise, returns false. Prints a diagnostic when appropriate.
  55. static auto MergeClassRedecl(Context& context, Parse::AnyClassDeclId node_id,
  56. SemIR::Class& new_class, bool new_is_definition,
  57. SemIR::ClassId prev_class_id,
  58. SemIR::ImportIRId prev_import_ir_id) -> bool {
  59. auto& prev_class = context.classes().Get(prev_class_id);
  60. SemIRLoc prev_loc = prev_class.latest_decl_id();
  61. // Check the generic parameters match, if they were specified.
  62. if (!CheckRedeclParamsMatch(context, DeclParams(new_class),
  63. DeclParams(prev_class))) {
  64. return false;
  65. }
  66. DiagnoseIfInvalidRedecl(
  67. context, Lex::TokenKind::Class, prev_class.name_id,
  68. RedeclInfo(new_class, node_id, new_is_definition),
  69. RedeclInfo(prev_class, prev_loc, prev_class.has_definition_started()),
  70. prev_import_ir_id);
  71. if (new_is_definition && prev_class.has_definition_started()) {
  72. // Don't attempt to merge multiple definitions.
  73. return false;
  74. }
  75. if (new_is_definition) {
  76. prev_class.MergeDefinition(new_class);
  77. prev_class.scope_id = new_class.scope_id;
  78. prev_class.body_block_id = new_class.body_block_id;
  79. prev_class.adapt_id = new_class.adapt_id;
  80. prev_class.base_id = new_class.base_id;
  81. prev_class.complete_type_witness_id = new_class.complete_type_witness_id;
  82. }
  83. if (prev_import_ir_id.has_value() ||
  84. (prev_class.is_extern && !new_class.is_extern)) {
  85. prev_class.first_owning_decl_id = new_class.first_owning_decl_id;
  86. ReplacePrevInstForMerge(context, new_class.parent_scope_id,
  87. prev_class.name_id, new_class.first_owning_decl_id);
  88. }
  89. return true;
  90. }
  91. // Adds the name to name lookup. If there's a conflict, tries to merge. May
  92. // update class_decl and class_info when merging.
  93. static auto MergeOrAddName(Context& context, Parse::AnyClassDeclId node_id,
  94. const DeclNameStack::NameContext& name_context,
  95. SemIR::InstId class_decl_id,
  96. SemIR::ClassDecl& class_decl,
  97. SemIR::Class& class_info, bool is_definition,
  98. SemIR::AccessKind access_kind) -> void {
  99. SemIR::ScopeLookupResult lookup_result =
  100. context.decl_name_stack().LookupOrAddName(name_context, class_decl_id,
  101. access_kind);
  102. if (lookup_result.is_poisoned()) {
  103. // This is a declaration of a poisoned name.
  104. DiagnosePoisonedName(context, lookup_result.poisoning_loc_id(),
  105. name_context.loc_id);
  106. return;
  107. }
  108. if (!lookup_result.is_found()) {
  109. return;
  110. }
  111. SemIR::InstId prev_id = lookup_result.target_inst_id();
  112. auto prev_class_id = SemIR::ClassId::None;
  113. auto prev_import_ir_id = SemIR::ImportIRId::None;
  114. auto prev = context.insts().Get(prev_id);
  115. CARBON_KIND_SWITCH(prev) {
  116. case CARBON_KIND(SemIR::ClassDecl class_decl): {
  117. prev_class_id = class_decl.class_id;
  118. break;
  119. }
  120. case CARBON_KIND(SemIR::ImportRefLoaded import_ref): {
  121. auto import_ir_inst =
  122. context.import_ir_insts().Get(import_ref.import_ir_inst_id);
  123. // Verify the decl so that things like aliases are name conflicts.
  124. const auto* import_ir =
  125. context.import_irs().Get(import_ir_inst.ir_id).sem_ir;
  126. if (!import_ir->insts().Is<SemIR::ClassDecl>(import_ir_inst.inst_id)) {
  127. break;
  128. }
  129. // Use the constant value to get the ID.
  130. auto decl_value = context.insts().Get(
  131. context.constant_values().GetConstantInstId(prev_id));
  132. if (auto class_type = decl_value.TryAs<SemIR::ClassType>()) {
  133. prev_class_id = class_type->class_id;
  134. prev_import_ir_id = import_ir_inst.ir_id;
  135. } else if (auto generic_class_type =
  136. context.types().TryGetAs<SemIR::GenericClassType>(
  137. decl_value.type_id())) {
  138. prev_class_id = generic_class_type->class_id;
  139. prev_import_ir_id = import_ir_inst.ir_id;
  140. }
  141. break;
  142. }
  143. default:
  144. break;
  145. }
  146. if (!prev_class_id.has_value()) {
  147. // This is a redeclaration of something other than a class.
  148. DiagnoseDuplicateName(context, class_decl_id, prev_id);
  149. return;
  150. }
  151. // TODO: Fix `extern` logic. It doesn't work correctly, but doesn't seem worth
  152. // ripping out because existing code may incrementally help.
  153. if (MergeClassRedecl(context, node_id, class_info, is_definition,
  154. prev_class_id, prev_import_ir_id)) {
  155. // When merging, use the existing entity rather than adding a new one.
  156. class_decl.class_id = prev_class_id;
  157. class_decl.type_id = prev.type_id();
  158. // TODO: Validate that the redeclaration doesn't set an access modifier.
  159. }
  160. }
  161. static auto BuildClassDecl(Context& context, Parse::AnyClassDeclId node_id,
  162. bool is_definition)
  163. -> std::tuple<SemIR::ClassId, SemIR::InstId> {
  164. auto name = PopNameComponent(context);
  165. auto name_context = context.decl_name_stack().FinishName(name);
  166. context.node_stack()
  167. .PopAndDiscardSoloNodeId<Parse::NodeKind::ClassIntroducer>();
  168. // Process modifiers.
  169. auto [_, parent_scope_inst] =
  170. context.name_scopes().GetInstIfValid(name_context.parent_scope_id);
  171. auto introducer =
  172. context.decl_introducer_state_stack().Pop<Lex::TokenKind::Class>();
  173. CheckAccessModifiersOnDecl(context, introducer, parent_scope_inst);
  174. auto always_acceptable_modifiers =
  175. KeywordModifierSet::Access | KeywordModifierSet::Extern;
  176. LimitModifiersOnDecl(context, introducer,
  177. always_acceptable_modifiers | KeywordModifierSet::Class);
  178. if (!is_definition) {
  179. LimitModifiersOnNotDefinition(context, introducer,
  180. always_acceptable_modifiers);
  181. }
  182. RestrictExternModifierOnDecl(context, introducer, parent_scope_inst,
  183. is_definition);
  184. bool is_extern = introducer.modifier_set.HasAnyOf(KeywordModifierSet::Extern);
  185. if (introducer.extern_library.has_value()) {
  186. context.TODO(node_id, "extern library");
  187. }
  188. auto inheritance_kind =
  189. introducer.modifier_set.ToEnum<SemIR::Class::InheritanceKind>()
  190. .Case(KeywordModifierSet::Abstract, SemIR::Class::Abstract)
  191. .Case(KeywordModifierSet::Base, SemIR::Class::Base)
  192. .Default(SemIR::Class::Final);
  193. auto decl_block_id = context.inst_block_stack().Pop();
  194. // Add the class declaration.
  195. auto class_decl =
  196. SemIR::ClassDecl{.type_id = SemIR::TypeType::SingletonTypeId,
  197. .class_id = SemIR::ClassId::None,
  198. .decl_block_id = decl_block_id};
  199. auto class_decl_id =
  200. context.AddPlaceholderInst(SemIR::LocIdAndInst(node_id, class_decl));
  201. // TODO: Store state regarding is_extern.
  202. SemIR::Class class_info = {
  203. name_context.MakeEntityWithParamsBase(name, class_decl_id, is_extern,
  204. SemIR::LibraryNameId::None),
  205. {// `.self_type_id` depends on the ClassType, so is set below.
  206. .self_type_id = SemIR::TypeId::None,
  207. .inheritance_kind = inheritance_kind}};
  208. MergeOrAddName(context, node_id, name_context, class_decl_id, class_decl,
  209. class_info, is_definition,
  210. introducer.modifier_set.GetAccessKind());
  211. // Create a new class if this isn't a valid redeclaration.
  212. bool is_new_class = !class_decl.class_id.has_value();
  213. if (is_new_class) {
  214. // TODO: If this is an invalid redeclaration of a non-class entity or there
  215. // was an error in the qualifier, we will have lost track of the class name
  216. // here. We should keep track of it even if the name is invalid.
  217. class_info.generic_id = BuildGenericDecl(context, class_decl_id);
  218. class_decl.class_id = context.classes().Add(class_info);
  219. if (class_info.has_parameters()) {
  220. class_decl.type_id = context.GetGenericClassType(
  221. class_decl.class_id, context.scope_stack().PeekSpecificId());
  222. }
  223. } else {
  224. FinishGenericRedecl(context, class_decl_id, class_info.generic_id);
  225. }
  226. // Write the class ID into the ClassDecl.
  227. context.ReplaceInstBeforeConstantUse(class_decl_id, class_decl);
  228. if (is_new_class) {
  229. // Build the `Self` type using the resulting type constant.
  230. // TODO: Form this as part of building the definition, not as part of the
  231. // declaration.
  232. auto& class_info = context.classes().Get(class_decl.class_id);
  233. auto specific_id =
  234. context.generics().GetSelfSpecific(class_info.generic_id);
  235. class_info.self_type_id = context.GetTypeIdForTypeConstant(TryEvalInst(
  236. context, SemIR::InstId::None,
  237. SemIR::ClassType{.type_id = SemIR::TypeType::SingletonTypeId,
  238. .class_id = class_decl.class_id,
  239. .specific_id = specific_id}));
  240. }
  241. if (!is_definition && context.sem_ir().is_impl() && !is_extern) {
  242. context.definitions_required().push_back(class_decl_id);
  243. }
  244. return {class_decl.class_id, class_decl_id};
  245. }
  246. auto HandleParseNode(Context& context, Parse::ClassDeclId node_id) -> bool {
  247. BuildClassDecl(context, node_id, /*is_definition=*/false);
  248. context.decl_name_stack().PopScope();
  249. return true;
  250. }
  251. auto HandleParseNode(Context& context, Parse::ClassDefinitionStartId node_id)
  252. -> bool {
  253. auto [class_id, class_decl_id] =
  254. BuildClassDecl(context, node_id, /*is_definition=*/true);
  255. auto& class_info = context.classes().Get(class_id);
  256. // Track that this declaration is the definition.
  257. CARBON_CHECK(!class_info.has_definition_started());
  258. class_info.definition_id = class_decl_id;
  259. class_info.scope_id = context.name_scopes().Add(
  260. class_decl_id, SemIR::NameId::None, class_info.parent_scope_id);
  261. // Enter the class scope.
  262. context.scope_stack().Push(
  263. class_decl_id, class_info.scope_id,
  264. context.generics().GetSelfSpecific(class_info.generic_id));
  265. StartGenericDefinition(context);
  266. // Introduce `Self`.
  267. context.name_scopes().AddRequiredName(
  268. class_info.scope_id, SemIR::NameId::SelfType,
  269. context.types().GetInstId(class_info.self_type_id));
  270. context.inst_block_stack().Push();
  271. context.node_stack().Push(node_id, class_id);
  272. context.field_decls_stack().PushArray();
  273. context.vtable_stack().Push();
  274. // TODO: Handle the case where there's control flow in the class body. For
  275. // example:
  276. //
  277. // class C {
  278. // var v: if true then i32 else f64;
  279. // }
  280. //
  281. // We may need to track a list of instruction blocks here, as we do for a
  282. // function.
  283. class_info.body_block_id = context.inst_block_stack().PeekOrAdd();
  284. return true;
  285. }
  286. // Diagnoses a class-specific declaration appearing outside a class.
  287. static auto DiagnoseClassSpecificDeclOutsideClass(Context& context,
  288. SemIRLoc loc,
  289. Lex::TokenKind tok) -> void {
  290. CARBON_DIAGNOSTIC(ClassSpecificDeclOutsideClass, Error,
  291. "`{0}` declaration outside class", Lex::TokenKind);
  292. context.emitter().Emit(loc, ClassSpecificDeclOutsideClass, tok);
  293. }
  294. // Returns the current scope's class declaration, or diagnoses if it isn't a
  295. // class.
  296. static auto GetCurrentScopeAsClassOrDiagnose(Context& context, SemIRLoc loc,
  297. Lex::TokenKind tok)
  298. -> std::optional<SemIR::ClassDecl> {
  299. auto class_scope =
  300. context.scope_stack().GetCurrentScopeAs<SemIR::ClassDecl>();
  301. if (!class_scope) {
  302. DiagnoseClassSpecificDeclOutsideClass(context, loc, tok);
  303. }
  304. return class_scope;
  305. }
  306. // Diagnoses a class-specific declaration that is repeated within a class, but
  307. // is not permitted to be repeated.
  308. static auto DiagnoseClassSpecificDeclRepeated(Context& context,
  309. SemIRLoc new_loc,
  310. SemIRLoc prev_loc,
  311. Lex::TokenKind tok) -> void {
  312. CARBON_DIAGNOSTIC(AdaptDeclRepeated, Error,
  313. "multiple `adapt` declarations in class");
  314. CARBON_DIAGNOSTIC(BaseDeclRepeated, Error,
  315. "multiple `base` declarations in class; multiple "
  316. "inheritance is not permitted");
  317. CARBON_DIAGNOSTIC(ClassSpecificDeclPrevious, Note,
  318. "previous `{0}` declaration is here", Lex::TokenKind);
  319. CARBON_CHECK(tok == Lex::TokenKind::Adapt || tok == Lex::TokenKind::Base);
  320. context.emitter()
  321. .Build(new_loc, tok == Lex::TokenKind::Adapt ? AdaptDeclRepeated
  322. : BaseDeclRepeated)
  323. .Note(prev_loc, ClassSpecificDeclPrevious, tok)
  324. .Emit();
  325. }
  326. auto HandleParseNode(Context& context, Parse::AdaptIntroducerId /*node_id*/)
  327. -> bool {
  328. context.decl_introducer_state_stack().Push<Lex::TokenKind::Adapt>();
  329. return true;
  330. }
  331. auto HandleParseNode(Context& context, Parse::AdaptDeclId node_id) -> bool {
  332. auto [adapted_type_node, adapted_type_expr_id] =
  333. context.node_stack().PopExprWithNodeId();
  334. // Process modifiers. `extend` is permitted, no others are allowed.
  335. auto introducer =
  336. context.decl_introducer_state_stack().Pop<Lex::TokenKind::Adapt>();
  337. LimitModifiersOnDecl(context, introducer, KeywordModifierSet::Extend);
  338. auto parent_class_decl =
  339. GetCurrentScopeAsClassOrDiagnose(context, node_id, Lex::TokenKind::Adapt);
  340. if (!parent_class_decl) {
  341. return true;
  342. }
  343. auto& class_info = context.classes().Get(parent_class_decl->class_id);
  344. if (class_info.adapt_id.has_value()) {
  345. DiagnoseClassSpecificDeclRepeated(context, node_id, class_info.adapt_id,
  346. Lex::TokenKind::Adapt);
  347. return true;
  348. }
  349. auto [adapted_inst_id, adapted_type_id] =
  350. ExprAsType(context, node_id, adapted_type_expr_id);
  351. adapted_type_id = AsConcreteType(
  352. context, adapted_type_id, node_id,
  353. [&] {
  354. CARBON_DIAGNOSTIC(IncompleteTypeInAdaptDecl, Error,
  355. "adapted type {0} is an incomplete type",
  356. InstIdAsType);
  357. return context.emitter().Build(node_id, IncompleteTypeInAdaptDecl,
  358. adapted_inst_id);
  359. },
  360. [&] {
  361. CARBON_DIAGNOSTIC(AbstractTypeInAdaptDecl, Error,
  362. "adapted type {0} is an abstract type", InstIdAsType);
  363. return context.emitter().Build(node_id, AbstractTypeInAdaptDecl,
  364. adapted_inst_id);
  365. });
  366. if (adapted_type_id == SemIR::ErrorInst::SingletonTypeId) {
  367. adapted_inst_id = SemIR::ErrorInst::SingletonInstId;
  368. }
  369. // Build a SemIR representation for the declaration.
  370. class_info.adapt_id = context.AddInst<SemIR::AdaptDecl>(
  371. node_id, {.adapted_type_inst_id = adapted_inst_id});
  372. // Extend the class scope with the adapted type's scope if requested.
  373. if (introducer.modifier_set.HasAnyOf(KeywordModifierSet::Extend)) {
  374. auto& class_scope = context.name_scopes().Get(class_info.scope_id);
  375. class_scope.AddExtendedScope(adapted_inst_id);
  376. }
  377. return true;
  378. }
  379. auto HandleParseNode(Context& context, Parse::BaseIntroducerId /*node_id*/)
  380. -> bool {
  381. context.decl_introducer_state_stack().Push<Lex::TokenKind::Base>();
  382. return true;
  383. }
  384. auto HandleParseNode(Context& /*context*/, Parse::BaseColonId /*node_id*/)
  385. -> bool {
  386. return true;
  387. }
  388. namespace {
  389. // Information gathered about a base type specified in a `base` declaration.
  390. struct BaseInfo {
  391. // A `BaseInfo` representing an erroneous base.
  392. static const BaseInfo Error;
  393. SemIR::TypeId type_id;
  394. SemIR::NameScopeId scope_id;
  395. SemIR::InstId inst_id;
  396. };
  397. constexpr BaseInfo BaseInfo::Error = {
  398. .type_id = SemIR::ErrorInst::SingletonTypeId,
  399. .scope_id = SemIR::NameScopeId::None,
  400. .inst_id = SemIR::ErrorInst::SingletonInstId};
  401. } // namespace
  402. // Diagnoses an attempt to derive from a final type.
  403. static auto DiagnoseBaseIsFinal(Context& context, Parse::NodeId node_id,
  404. SemIR::InstId base_type_inst_id) -> void {
  405. CARBON_DIAGNOSTIC(BaseIsFinal, Error,
  406. "deriving from final type {0}; base type must be an "
  407. "`abstract` or `base` class",
  408. InstIdAsType);
  409. context.emitter().Emit(node_id, BaseIsFinal, base_type_inst_id);
  410. }
  411. // Checks that the specified base type is valid.
  412. static auto CheckBaseType(Context& context, Parse::NodeId node_id,
  413. SemIR::InstId base_expr_id) -> BaseInfo {
  414. auto [base_type_inst_id, base_type_id] =
  415. ExprAsType(context, node_id, base_expr_id);
  416. base_type_id = AsCompleteType(context, base_type_id, node_id, [&] {
  417. CARBON_DIAGNOSTIC(IncompleteTypeInBaseDecl, Error,
  418. "base {0} is an incomplete type", InstIdAsType);
  419. return context.emitter().Build(node_id, IncompleteTypeInBaseDecl,
  420. base_type_inst_id);
  421. });
  422. if (base_type_id == SemIR::ErrorInst::SingletonTypeId) {
  423. return BaseInfo::Error;
  424. }
  425. auto* base_class_info = TryGetAsClass(context, base_type_id);
  426. // The base must not be a final class.
  427. if (!base_class_info) {
  428. // For now, we treat all types that aren't introduced by a `class`
  429. // declaration as being final classes.
  430. // TODO: Once we have a better idea of which types are considered to be
  431. // classes, produce a better diagnostic for deriving from a non-class type.
  432. DiagnoseBaseIsFinal(context, node_id, base_type_inst_id);
  433. return BaseInfo::Error;
  434. }
  435. if (base_class_info->inheritance_kind == SemIR::Class::Final) {
  436. DiagnoseBaseIsFinal(context, node_id, base_type_inst_id);
  437. }
  438. CARBON_CHECK(base_class_info->scope_id.has_value(),
  439. "Complete class should have a scope");
  440. return {.type_id = base_type_id,
  441. .scope_id = base_class_info->scope_id,
  442. .inst_id = base_type_inst_id};
  443. }
  444. auto HandleParseNode(Context& context, Parse::BaseDeclId node_id) -> bool {
  445. auto [base_type_node_id, base_type_expr_id] =
  446. context.node_stack().PopExprWithNodeId();
  447. // Process modifiers. `extend` is required, no others are allowed.
  448. auto introducer =
  449. context.decl_introducer_state_stack().Pop<Lex::TokenKind::Base>();
  450. LimitModifiersOnDecl(context, introducer, KeywordModifierSet::Extend);
  451. if (!introducer.modifier_set.HasAnyOf(KeywordModifierSet::Extend)) {
  452. CARBON_DIAGNOSTIC(BaseMissingExtend, Error,
  453. "missing `extend` before `base` declaration");
  454. context.emitter().Emit(node_id, BaseMissingExtend);
  455. }
  456. auto parent_class_decl =
  457. GetCurrentScopeAsClassOrDiagnose(context, node_id, Lex::TokenKind::Base);
  458. if (!parent_class_decl) {
  459. return true;
  460. }
  461. auto& class_info = context.classes().Get(parent_class_decl->class_id);
  462. if (class_info.base_id.has_value()) {
  463. DiagnoseClassSpecificDeclRepeated(context, node_id, class_info.base_id,
  464. Lex::TokenKind::Base);
  465. return true;
  466. }
  467. if (!context.field_decls_stack().PeekArray().empty()) {
  468. // TODO: Add note that includes the first field location as an example.
  469. CARBON_DIAGNOSTIC(
  470. BaseDeclAfterFieldDecl, Error,
  471. "`base` declaration must appear before field declarations");
  472. context.emitter().Emit(node_id, BaseDeclAfterFieldDecl);
  473. return true;
  474. }
  475. auto base_info = CheckBaseType(context, base_type_node_id, base_type_expr_id);
  476. // TODO: Should we diagnose if there are already any fields?
  477. // The `base` value in the class scope has an unbound element type. Instance
  478. // binding will be performed when it's found by name lookup into an instance.
  479. auto field_type_id =
  480. context.GetUnboundElementType(class_info.self_type_id, base_info.type_id);
  481. class_info.base_id = context.AddInst<SemIR::BaseDecl>(
  482. node_id, {.type_id = field_type_id,
  483. .base_type_inst_id = base_info.inst_id,
  484. .index = SemIR::ElementIndex::None});
  485. if (base_info.type_id != SemIR::ErrorInst::SingletonTypeId) {
  486. auto base_class_info = context.classes().Get(
  487. context.types().GetAs<SemIR::ClassType>(base_info.type_id).class_id);
  488. class_info.is_dynamic |= base_class_info.is_dynamic;
  489. }
  490. // Bind the name `base` in the class to the base field.
  491. context.decl_name_stack().AddNameOrDiagnose(
  492. context.decl_name_stack().MakeUnqualifiedName(node_id,
  493. SemIR::NameId::Base),
  494. class_info.base_id, introducer.modifier_set.GetAccessKind());
  495. // Extend the class scope with the base class.
  496. if (introducer.modifier_set.HasAnyOf(KeywordModifierSet::Extend)) {
  497. auto& class_scope = context.name_scopes().Get(class_info.scope_id);
  498. if (base_info.scope_id.has_value()) {
  499. class_scope.AddExtendedScope(base_info.inst_id);
  500. } else {
  501. class_scope.set_has_error();
  502. }
  503. }
  504. return true;
  505. }
  506. // Checks that the specified finished adapter definition is valid and builds and
  507. // returns a corresponding complete type witness instruction.
  508. static auto CheckCompleteAdapterClassType(Context& context,
  509. Parse::NodeId node_id,
  510. SemIR::ClassId class_id)
  511. -> SemIR::InstId {
  512. const auto& class_info = context.classes().Get(class_id);
  513. if (class_info.base_id.has_value()) {
  514. CARBON_DIAGNOSTIC(AdaptWithBase, Error, "adapter with base class");
  515. CARBON_DIAGNOSTIC(AdaptWithBaseHere, Note, "`base` declaration is here");
  516. context.emitter()
  517. .Build(class_info.adapt_id, AdaptWithBase)
  518. .Note(class_info.base_id, AdaptWithBaseHere)
  519. .Emit();
  520. return SemIR::ErrorInst::SingletonInstId;
  521. }
  522. auto field_decls = context.field_decls_stack().PeekArray();
  523. if (!field_decls.empty()) {
  524. CARBON_DIAGNOSTIC(AdaptWithFields, Error, "adapter with fields");
  525. CARBON_DIAGNOSTIC(AdaptWithFieldHere, Note,
  526. "first field declaration is here");
  527. context.emitter()
  528. .Build(class_info.adapt_id, AdaptWithFields)
  529. .Note(field_decls.front(), AdaptWithFieldHere)
  530. .Emit();
  531. return SemIR::ErrorInst::SingletonInstId;
  532. }
  533. for (auto inst_id : context.inst_block_stack().PeekCurrentBlockContents()) {
  534. if (auto function_decl =
  535. context.insts().TryGetAs<SemIR::FunctionDecl>(inst_id)) {
  536. auto& function = context.functions().Get(function_decl->function_id);
  537. if (function.virtual_modifier ==
  538. SemIR::Function::VirtualModifier::Virtual) {
  539. CARBON_DIAGNOSTIC(AdaptWithVirtual, Error,
  540. "adapter with virtual function");
  541. CARBON_DIAGNOSTIC(AdaptWithVirtualHere, Note,
  542. "first virtual function declaration is here");
  543. context.emitter()
  544. .Build(class_info.adapt_id, AdaptWithVirtual)
  545. .Note(inst_id, AdaptWithVirtualHere)
  546. .Emit();
  547. return SemIR::ErrorInst::SingletonInstId;
  548. }
  549. }
  550. }
  551. // The object representation of the adapter is the object representation
  552. // of the adapted type.
  553. auto adapted_type_id =
  554. class_info.GetAdaptedType(context.sem_ir(), SemIR::SpecificId::None);
  555. auto object_repr_id = context.types().GetObjectRepr(adapted_type_id);
  556. return context.AddInst<SemIR::CompleteTypeWitness>(
  557. node_id,
  558. {.type_id = context.GetSingletonType(SemIR::WitnessType::SingletonInstId),
  559. .object_repr_id = object_repr_id});
  560. }
  561. static auto AddStructTypeFields(
  562. Context& context,
  563. llvm::SmallVector<SemIR::StructTypeField>& struct_type_fields)
  564. -> SemIR::StructTypeFieldsId {
  565. for (auto field_decl_id : context.field_decls_stack().PeekArray()) {
  566. auto field_decl = context.insts().GetAs<SemIR::FieldDecl>(field_decl_id);
  567. field_decl.index =
  568. SemIR::ElementIndex{static_cast<int>(struct_type_fields.size())};
  569. context.ReplaceInstPreservingConstantValue(field_decl_id, field_decl);
  570. if (field_decl.type_id == SemIR::ErrorInst::SingletonTypeId) {
  571. struct_type_fields.push_back(
  572. {.name_id = field_decl.name_id,
  573. .type_id = SemIR::ErrorInst::SingletonTypeId});
  574. continue;
  575. }
  576. auto unbound_element_type =
  577. context.sem_ir().types().GetAs<SemIR::UnboundElementType>(
  578. field_decl.type_id);
  579. struct_type_fields.push_back(
  580. {.name_id = field_decl.name_id,
  581. .type_id = unbound_element_type.element_type_id});
  582. }
  583. auto fields_id =
  584. context.struct_type_fields().AddCanonical(struct_type_fields);
  585. return fields_id;
  586. }
  587. // Checks that the specified finished class definition is valid and builds and
  588. // returns a corresponding complete type witness instruction.
  589. static auto CheckCompleteClassType(Context& context, Parse::NodeId node_id,
  590. SemIR::ClassId class_id) -> SemIR::InstId {
  591. auto& class_info = context.classes().Get(class_id);
  592. if (class_info.adapt_id.has_value()) {
  593. return CheckCompleteAdapterClassType(context, node_id, class_id);
  594. }
  595. bool defining_vptr = class_info.is_dynamic;
  596. auto base_type_id =
  597. class_info.GetBaseType(context.sem_ir(), SemIR::SpecificId::None);
  598. SemIR::Class* base_class_info = nullptr;
  599. if (base_type_id.has_value()) {
  600. // TODO: If the base class is template dependent, we will need to decide
  601. // whether to add a vptr as part of instantiation.
  602. base_class_info = TryGetAsClass(context, base_type_id);
  603. if (base_class_info && base_class_info->is_dynamic) {
  604. defining_vptr = false;
  605. }
  606. }
  607. auto field_decls = context.field_decls_stack().PeekArray();
  608. llvm::SmallVector<SemIR::StructTypeField> struct_type_fields;
  609. struct_type_fields.reserve(defining_vptr + class_info.base_id.has_value() +
  610. field_decls.size());
  611. if (defining_vptr) {
  612. struct_type_fields.push_back(
  613. {.name_id = SemIR::NameId::Vptr,
  614. .type_id = context.GetPointerType(
  615. context.GetSingletonType(SemIR::VtableType::SingletonInstId))});
  616. }
  617. if (base_type_id.has_value()) {
  618. auto base_decl = context.insts().GetAs<SemIR::BaseDecl>(class_info.base_id);
  619. base_decl.index =
  620. SemIR::ElementIndex{static_cast<int>(struct_type_fields.size())};
  621. context.ReplaceInstPreservingConstantValue(class_info.base_id, base_decl);
  622. struct_type_fields.push_back(
  623. {.name_id = SemIR::NameId::Base, .type_id = base_type_id});
  624. }
  625. if (class_info.is_dynamic) {
  626. llvm::SmallVector<SemIR::InstId> vtable;
  627. if (!defining_vptr) {
  628. LoadImportRef(context, base_class_info->vtable_id);
  629. auto base_vtable_id = context.constant_values().GetConstantInstId(
  630. base_class_info->vtable_id);
  631. auto base_vtable_inst_block =
  632. context.inst_blocks().Get(context.insts()
  633. .GetAs<SemIR::Vtable>(base_vtable_id)
  634. .virtual_functions_id);
  635. // TODO: Avoid quadratic search. Perhaps build a map from `NameId` to the
  636. // elements of the top of `vtable_stack`.
  637. for (auto fn_decl_id : base_vtable_inst_block) {
  638. auto fn_decl = GetCalleeFunction(context.sem_ir(), fn_decl_id);
  639. const auto& fn = context.functions().Get(fn_decl.function_id);
  640. for (auto override_fn_decl_id :
  641. context.vtable_stack().PeekCurrentBlockContents()) {
  642. auto override_fn_decl =
  643. context.insts().GetAs<SemIR::FunctionDecl>(override_fn_decl_id);
  644. const auto& override_fn =
  645. context.functions().Get(override_fn_decl.function_id);
  646. if (override_fn.virtual_modifier ==
  647. SemIR::FunctionFields::VirtualModifier::Impl &&
  648. override_fn.name_id == fn.name_id) {
  649. // TODO: Support generic base classes, rather than passing
  650. // `SpecificId::None`.
  651. CheckFunctionTypeMatches(context, override_fn, fn,
  652. SemIR::SpecificId::None,
  653. /*check_syntax=*/false);
  654. fn_decl_id = override_fn_decl_id;
  655. }
  656. }
  657. vtable.push_back(fn_decl_id);
  658. }
  659. }
  660. for (auto inst_id : context.vtable_stack().PeekCurrentBlockContents()) {
  661. auto fn_decl = context.insts().GetAs<SemIR::FunctionDecl>(inst_id);
  662. const auto& fn = context.functions().Get(fn_decl.function_id);
  663. if (fn.virtual_modifier != SemIR::FunctionFields::VirtualModifier::Impl) {
  664. vtable.push_back(inst_id);
  665. }
  666. }
  667. class_info.vtable_id = context.AddInst<SemIR::Vtable>(
  668. node_id, {.type_id = context.GetSingletonType(
  669. SemIR::VtableType::SingletonInstId),
  670. .virtual_functions_id = context.inst_blocks().Add(vtable)});
  671. }
  672. return context.AddInst<SemIR::CompleteTypeWitness>(
  673. node_id,
  674. {.type_id = context.GetSingletonType(SemIR::WitnessType::SingletonInstId),
  675. .object_repr_id = context.GetStructType(
  676. AddStructTypeFields(context, struct_type_fields))});
  677. }
  678. auto HandleParseNode(Context& context, Parse::ClassDefinitionId node_id)
  679. -> bool {
  680. auto class_id =
  681. context.node_stack().Pop<Parse::NodeKind::ClassDefinitionStart>();
  682. // The class type is now fully defined. Compute its object representation.
  683. auto complete_type_witness_id =
  684. CheckCompleteClassType(context, node_id, class_id);
  685. auto& class_info = context.classes().Get(class_id);
  686. class_info.complete_type_witness_id = complete_type_witness_id;
  687. context.inst_block_stack().Pop();
  688. context.field_decls_stack().PopArray();
  689. context.vtable_stack().Pop();
  690. FinishGenericDefinition(context, class_info.generic_id);
  691. // The decl_name_stack and scopes are popped by `ProcessNodeIds`.
  692. return true;
  693. }
  694. } // namespace Carbon::Check