handle_function.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634
  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 <optional>
  5. #include <utility>
  6. #include "toolchain/base/kind_switch.h"
  7. #include "toolchain/check/context.h"
  8. #include "toolchain/check/control_flow.h"
  9. #include "toolchain/check/convert.h"
  10. #include "toolchain/check/decl_introducer_state.h"
  11. #include "toolchain/check/decl_name_stack.h"
  12. #include "toolchain/check/function.h"
  13. #include "toolchain/check/generic.h"
  14. #include "toolchain/check/handle.h"
  15. #include "toolchain/check/import.h"
  16. #include "toolchain/check/import_ref.h"
  17. #include "toolchain/check/inst.h"
  18. #include "toolchain/check/interface.h"
  19. #include "toolchain/check/keyword_modifier_set.h"
  20. #include "toolchain/check/literal.h"
  21. #include "toolchain/check/merge.h"
  22. #include "toolchain/check/modifiers.h"
  23. #include "toolchain/check/name_component.h"
  24. #include "toolchain/check/name_lookup.h"
  25. #include "toolchain/check/type.h"
  26. #include "toolchain/check/type_completion.h"
  27. #include "toolchain/lex/token_kind.h"
  28. #include "toolchain/parse/node_ids.h"
  29. #include "toolchain/sem_ir/builtin_function_kind.h"
  30. #include "toolchain/sem_ir/entry_point.h"
  31. #include "toolchain/sem_ir/function.h"
  32. #include "toolchain/sem_ir/ids.h"
  33. #include "toolchain/sem_ir/inst.h"
  34. #include "toolchain/sem_ir/typed_insts.h"
  35. namespace Carbon::Check {
  36. auto HandleParseNode(Context& context, Parse::FunctionIntroducerId node_id)
  37. -> bool {
  38. // The function is potentially generic.
  39. StartGenericDecl(context);
  40. // Create an instruction block to hold the instructions created as part of the
  41. // function signature, such as parameter and return types.
  42. context.inst_block_stack().Push();
  43. // Push the bracketing node.
  44. context.node_stack().Push(node_id);
  45. // Optional modifiers and the name follow.
  46. context.decl_introducer_state_stack().Push<Lex::TokenKind::Fn>();
  47. context.decl_name_stack().PushScopeAndStartName();
  48. return true;
  49. }
  50. auto HandleParseNode(Context& context, Parse::ReturnTypeId node_id) -> bool {
  51. auto [type_node_id, type_inst_id] = context.node_stack().PopExprWithNodeId();
  52. // If the previous node was `IdentifierNameBeforeParams`, then it would have
  53. // caused these entries to be pushed to the pattern stacks. But it's possible
  54. // to have a fn declaration without any parameters, in which case we find
  55. // `IdentifierNameNotBeforeParams` on the node stack. Then these entries are
  56. // not on the pattern stacks yet. They are only needed in that case if we have
  57. // a return type, which we now know that we do.
  58. if (context.node_stack().PeekNodeKind() ==
  59. Parse::NodeKind::IdentifierNameNotBeforeParams) {
  60. context.pattern_block_stack().Push();
  61. context.full_pattern_stack().PushFullPattern(
  62. FullPatternStack::Kind::ExplicitParamList);
  63. }
  64. // Propagate the type expression.
  65. auto form_expr = ExprAsReturnForm(context, type_node_id, type_inst_id);
  66. context.PushReturnForm(form_expr);
  67. auto return_patterns_id = AddReturnPatterns(context, node_id, form_expr);
  68. context.node_stack().Push(node_id, return_patterns_id);
  69. return true;
  70. }
  71. // Diagnoses issues with the modifiers, removing modifiers that shouldn't be
  72. // present.
  73. static auto DiagnoseModifiers(Context& context,
  74. Parse::AnyFunctionDeclId node_id,
  75. DeclIntroducerState& introducer,
  76. bool is_definition,
  77. SemIR::InstId parent_scope_inst_id,
  78. std::optional<SemIR::Inst> parent_scope_inst,
  79. SemIR::InstId self_param_id) -> void {
  80. CheckAccessModifiersOnDecl(context, introducer, parent_scope_inst);
  81. LimitModifiersOnDecl(context, introducer,
  82. KeywordModifierSet::Access | KeywordModifierSet::Extern |
  83. KeywordModifierSet::Method |
  84. KeywordModifierSet::Interface);
  85. RestrictExternModifierOnDecl(context, introducer, parent_scope_inst,
  86. is_definition);
  87. CheckMethodModifiersOnFunction(context, introducer, parent_scope_inst_id,
  88. parent_scope_inst);
  89. RequireDefaultFinalOnlyInInterfaces(context, introducer, parent_scope_inst);
  90. if (introducer.modifier_set.HasAnyOf(KeywordModifierSet::Interface)) {
  91. // TODO: Once we are saving the modifiers for a function, add check that
  92. // the function may only be defined if it is marked `default` or `final`.
  93. context.TODO(introducer.modifier_node_id(ModifierOrder::Decl),
  94. "interface modifier");
  95. }
  96. if (!self_param_id.has_value() &&
  97. introducer.modifier_set.HasAnyOf(KeywordModifierSet::Method)) {
  98. CARBON_DIAGNOSTIC(VirtualWithoutSelf, Error, "virtual class function");
  99. context.emitter().Emit(node_id, VirtualWithoutSelf);
  100. introducer.modifier_set.Remove(KeywordModifierSet::Method);
  101. }
  102. }
  103. // Returns the virtual-family modifier as an enum.
  104. static auto GetVirtualModifier(const KeywordModifierSet& modifier_set)
  105. -> SemIR::Function::VirtualModifier {
  106. return modifier_set.ToEnum<SemIR::Function::VirtualModifier>()
  107. .Case(KeywordModifierSet::Virtual,
  108. SemIR::Function::VirtualModifier::Virtual)
  109. .Case(KeywordModifierSet::Abstract,
  110. SemIR::Function::VirtualModifier::Abstract)
  111. .Case(KeywordModifierSet::Override,
  112. SemIR::Function::VirtualModifier::Override)
  113. .Default(SemIR::Function::VirtualModifier::None);
  114. }
  115. // Tries to merge new_function into prev_function_id. Since new_function won't
  116. // have a definition even if one is upcoming, set is_definition to indicate the
  117. // planned result.
  118. //
  119. // If merging is successful, returns true and may update the previous function.
  120. // Otherwise, returns false. Prints a diagnostic when appropriate.
  121. static auto MergeFunctionRedecl(Context& context,
  122. Parse::AnyFunctionDeclId node_id,
  123. SemIR::Function& new_function,
  124. bool new_is_definition,
  125. SemIR::FunctionId prev_function_id,
  126. SemIR::ImportIRId prev_import_ir_id) -> bool {
  127. auto& prev_function = context.functions().Get(prev_function_id);
  128. if (!CheckFunctionTypeMatches(context, new_function, prev_function)) {
  129. return false;
  130. }
  131. DiagnoseIfInvalidRedecl(
  132. context, Lex::TokenKind::Fn, prev_function.name_id,
  133. RedeclInfo(new_function, node_id, new_is_definition),
  134. RedeclInfo(prev_function, SemIR::LocId(prev_function.latest_decl_id()),
  135. prev_function.has_definition_started()),
  136. prev_import_ir_id);
  137. if (new_is_definition && prev_function.has_definition_started()) {
  138. return false;
  139. }
  140. if (!prev_function.first_owning_decl_id.has_value()) {
  141. prev_function.first_owning_decl_id = new_function.first_owning_decl_id;
  142. }
  143. if (new_is_definition) {
  144. // Track the signature from the definition, so that IDs in the body
  145. // match IDs in the signature.
  146. prev_function.MergeDefinition(new_function);
  147. prev_function.call_param_patterns_id = new_function.call_param_patterns_id;
  148. prev_function.call_params_id = new_function.call_params_id;
  149. prev_function.return_type_inst_id = new_function.return_type_inst_id;
  150. prev_function.return_form_inst_id = new_function.return_form_inst_id;
  151. prev_function.return_patterns_id = new_function.return_patterns_id;
  152. prev_function.self_param_id = new_function.self_param_id;
  153. }
  154. if (prev_import_ir_id.has_value()) {
  155. ReplacePrevInstForMerge(context, new_function.parent_scope_id,
  156. prev_function.name_id,
  157. new_function.first_owning_decl_id);
  158. }
  159. return true;
  160. }
  161. // Check whether this is a redeclaration, merging if needed.
  162. static auto TryMergeRedecl(Context& context, Parse::AnyFunctionDeclId node_id,
  163. const DeclNameStack::NameContext& name_context,
  164. SemIR::FunctionDecl& function_decl,
  165. SemIR::Function& function_info, bool is_definition)
  166. -> void {
  167. if (name_context.state == DeclNameStack::NameContext::State::Poisoned) {
  168. DiagnosePoisonedName(context, name_context.name_id_for_new_inst(),
  169. name_context.poisoning_loc_id, name_context.loc_id);
  170. return;
  171. }
  172. auto prev_id = name_context.prev_inst_id();
  173. if (!prev_id.has_value()) {
  174. return;
  175. }
  176. auto prev_function_id = SemIR::FunctionId::None;
  177. auto prev_type_id = SemIR::TypeId::None;
  178. auto prev_import_ir_id = SemIR::ImportIRId::None;
  179. CARBON_KIND_SWITCH(context.insts().Get(prev_id)) {
  180. case CARBON_KIND(SemIR::AssociatedEntity assoc_entity): {
  181. // This is a function in an interface definition scope (see
  182. // NameScope::is_interface_definition()).
  183. auto function_decl =
  184. context.insts().GetAs<SemIR::FunctionDecl>(assoc_entity.decl_id);
  185. prev_function_id = function_decl.function_id;
  186. prev_type_id = function_decl.type_id;
  187. break;
  188. }
  189. case CARBON_KIND(SemIR::FunctionDecl function_decl): {
  190. prev_function_id = function_decl.function_id;
  191. prev_type_id = function_decl.type_id;
  192. break;
  193. }
  194. case SemIR::ImportRefLoaded::Kind: {
  195. auto import_ir_inst = GetCanonicalImportIRInst(context, prev_id);
  196. // Verify the decl so that things like aliases are name conflicts.
  197. const auto* import_ir =
  198. context.import_irs().Get(import_ir_inst.ir_id()).sem_ir;
  199. if (!import_ir->insts().Is<SemIR::FunctionDecl>(
  200. import_ir_inst.inst_id())) {
  201. break;
  202. }
  203. // Use the type to get the ID.
  204. if (auto struct_value = context.insts().TryGetAs<SemIR::StructValue>(
  205. context.constant_values().GetConstantInstId(prev_id))) {
  206. if (auto function_type = context.types().TryGetAs<SemIR::FunctionType>(
  207. struct_value->type_id)) {
  208. prev_function_id = function_type->function_id;
  209. prev_type_id = struct_value->type_id;
  210. prev_import_ir_id = import_ir_inst.ir_id();
  211. }
  212. }
  213. break;
  214. }
  215. default:
  216. break;
  217. }
  218. if (!prev_function_id.has_value()) {
  219. DiagnoseDuplicateName(context, name_context.name_id, name_context.loc_id,
  220. SemIR::LocId(prev_id));
  221. return;
  222. }
  223. if (MergeFunctionRedecl(context, node_id, function_info, is_definition,
  224. prev_function_id, prev_import_ir_id)) {
  225. // When merging, use the existing function rather than adding a new one.
  226. function_decl.function_id = prev_function_id;
  227. function_decl.type_id = prev_type_id;
  228. }
  229. }
  230. // Adds the declaration to name lookup when appropriate.
  231. static auto MaybeAddToNameLookup(
  232. Context& context, const DeclNameStack::NameContext& name_context,
  233. const KeywordModifierSet& modifier_set,
  234. const std::optional<SemIR::Inst>& parent_scope_inst, SemIR::InstId decl_id)
  235. -> void {
  236. if (name_context.state == DeclNameStack::NameContext::State::Poisoned ||
  237. name_context.prev_inst_id().has_value()) {
  238. return;
  239. }
  240. // At interface scope, a function declaration introduces an associated
  241. // function.
  242. auto lookup_result_id = decl_id;
  243. if (parent_scope_inst && !name_context.has_qualifiers) {
  244. if (auto interface_scope =
  245. parent_scope_inst->TryAs<SemIR::InterfaceDecl>()) {
  246. lookup_result_id = BuildAssociatedEntity(
  247. context, interface_scope->interface_id, decl_id);
  248. }
  249. }
  250. context.decl_name_stack().AddName(name_context, lookup_result_id,
  251. modifier_set.GetAccessKind());
  252. }
  253. // If the function is the entry point, do corresponding validation.
  254. static auto ValidateForEntryPoint(Context& context,
  255. Parse::AnyFunctionDeclId node_id,
  256. SemIR::FunctionId function_id,
  257. const SemIR::Function& function_info)
  258. -> void {
  259. if (!SemIR::IsEntryPoint(context.sem_ir(), function_id)) {
  260. return;
  261. }
  262. auto return_type_id = function_info.GetDeclaredReturnType(context.sem_ir());
  263. // TODO: Update this once valid signatures for the entry point are decided.
  264. if (function_info.implicit_param_patterns_id.has_value() ||
  265. !function_info.param_patterns_id.has_value() ||
  266. !context.inst_blocks().Get(function_info.param_patterns_id).empty() ||
  267. (return_type_id.has_value() &&
  268. return_type_id != GetTupleType(context, {}) &&
  269. // TODO: Decide on valid return types for `Main.Run`. Perhaps we should
  270. // have an interface for this.
  271. return_type_id != MakeIntType(context, node_id, SemIR::IntKind::Signed,
  272. context.ints().Add(32)))) {
  273. CARBON_DIAGNOSTIC(InvalidMainRunSignature, Error,
  274. "invalid signature for `Main.Run` function; expected "
  275. "`fn ()` or `fn () -> i32`");
  276. context.emitter().Emit(node_id, InvalidMainRunSignature);
  277. }
  278. }
  279. static auto IsGenericFunction(Context& context,
  280. SemIR::GenericId function_generic_id,
  281. SemIR::GenericId class_generic_id) -> bool {
  282. if (function_generic_id == SemIR::GenericId::None) {
  283. return false;
  284. }
  285. if (class_generic_id == SemIR::GenericId::None) {
  286. return true;
  287. }
  288. const auto& function_generic = context.generics().Get(function_generic_id);
  289. const auto& class_generic = context.generics().Get(class_generic_id);
  290. auto function_bindings =
  291. context.inst_blocks().Get(function_generic.bindings_id);
  292. auto class_bindings = context.inst_blocks().Get(class_generic.bindings_id);
  293. // If the function's bindings are the same size as the class's bindings,
  294. // then there are no extra bindings for the function, so it is effectively
  295. // non-generic within the scope of a specific of the class.
  296. return class_bindings.size() != function_bindings.size();
  297. }
  298. // Requests a vtable be created when processing a virtual function.
  299. static auto RequestVtableIfVirtual(
  300. Context& context, Parse::AnyFunctionDeclId node_id,
  301. SemIR::Function::VirtualModifier& virtual_modifier,
  302. const std::optional<SemIR::Inst>& parent_scope_inst, SemIR::InstId decl_id,
  303. SemIR::GenericId generic_id) -> void {
  304. // In order to request a vtable, the function must be virtual, and in a class
  305. // scope.
  306. if (virtual_modifier == SemIR::Function::VirtualModifier::None ||
  307. !parent_scope_inst) {
  308. return;
  309. }
  310. auto class_decl = parent_scope_inst->TryAs<SemIR::ClassDecl>();
  311. if (!class_decl) {
  312. return;
  313. }
  314. auto& class_info = context.classes().Get(class_decl->class_id);
  315. if (virtual_modifier == SemIR::Function::VirtualModifier::Override &&
  316. !class_info.base_id.has_value()) {
  317. CARBON_DIAGNOSTIC(OverrideWithoutBase, Error,
  318. "override without base class");
  319. context.emitter().Emit(node_id, OverrideWithoutBase);
  320. virtual_modifier = SemIR::Function::VirtualModifier::None;
  321. return;
  322. }
  323. if (IsGenericFunction(context, generic_id, class_info.generic_id)) {
  324. CARBON_DIAGNOSTIC(GenericVirtual, Error, "generic virtual function");
  325. context.emitter().Emit(node_id, GenericVirtual);
  326. virtual_modifier = SemIR::Function::VirtualModifier::None;
  327. return;
  328. }
  329. // TODO: If this is an `impl` function, check there's a matching base
  330. // function that's impl or virtual.
  331. class_info.is_dynamic = true;
  332. context.vtable_stack().AddInstId(decl_id);
  333. }
  334. // Diagnoses when positional params aren't supported. Reassigns the pattern
  335. // block if needed.
  336. static auto DiagnosePositionalParams(Context& context,
  337. SemIR::Function& function_info) -> void {
  338. if (function_info.param_patterns_id.has_value()) {
  339. return;
  340. }
  341. context.TODO(function_info.latest_decl_id(),
  342. "function with positional parameters");
  343. function_info.param_patterns_id = SemIR::InstBlockId::Empty;
  344. }
  345. // Build a FunctionDecl describing the signature of a function. This
  346. // handles the common logic shared by function declaration syntax and function
  347. // definition syntax.
  348. static auto BuildFunctionDecl(Context& context,
  349. Parse::AnyFunctionDeclId node_id,
  350. bool is_definition)
  351. -> std::pair<SemIR::FunctionId, SemIR::InstId> {
  352. auto return_patterns_id = SemIR::InstBlockId::None;
  353. auto return_type_inst_id = SemIR::TypeInstId::None;
  354. auto return_form_inst_id = SemIR::InstId::None;
  355. if (auto [return_node, maybe_return_patterns_id] =
  356. context.node_stack().PopWithNodeIdIf<Parse::NodeKind::ReturnType>();
  357. maybe_return_patterns_id) {
  358. return_patterns_id = *maybe_return_patterns_id;
  359. auto return_form = context.PopReturnForm();
  360. return_type_inst_id = return_form.type_component_id;
  361. return_form_inst_id = return_form.form_inst_id;
  362. }
  363. auto name = PopNameComponent(context, return_patterns_id);
  364. auto name_context = context.decl_name_stack().FinishName(name);
  365. context.node_stack()
  366. .PopAndDiscardSoloNodeId<Parse::NodeKind::FunctionIntroducer>();
  367. auto self_param_id =
  368. FindSelfPattern(context, name.implicit_param_patterns_id);
  369. // Process modifiers.
  370. auto [parent_scope_inst_id, parent_scope_inst] =
  371. context.name_scopes().GetInstIfValid(name_context.parent_scope_id);
  372. auto introducer =
  373. context.decl_introducer_state_stack().Pop<Lex::TokenKind::Fn>();
  374. DiagnoseModifiers(context, node_id, introducer, is_definition,
  375. parent_scope_inst_id, parent_scope_inst, self_param_id);
  376. bool is_extern = introducer.modifier_set.HasAnyOf(KeywordModifierSet::Extern);
  377. auto virtual_modifier = GetVirtualModifier(introducer.modifier_set);
  378. // Add the function declaration.
  379. SemIR::FunctionDecl function_decl = {SemIR::TypeId::None,
  380. SemIR::FunctionId::None,
  381. context.inst_block_stack().Pop()};
  382. auto decl_id = AddPlaceholderInst(context, node_id, function_decl);
  383. // Build the function entity. This will be merged into an existing function if
  384. // there is one, or otherwise added to the function store.
  385. auto function_info =
  386. SemIR::Function{name_context.MakeEntityWithParamsBase(
  387. name, decl_id, is_extern, introducer.extern_library),
  388. {.call_param_patterns_id = name.call_param_patterns_id,
  389. .call_params_id = name.call_params_id,
  390. .return_type_inst_id = return_type_inst_id,
  391. .return_form_inst_id = return_form_inst_id,
  392. .return_patterns_id = return_patterns_id,
  393. .virtual_modifier = virtual_modifier,
  394. .self_param_id = self_param_id}};
  395. if (is_definition) {
  396. function_info.definition_id = decl_id;
  397. }
  398. DiagnosePositionalParams(context, function_info);
  399. TryMergeRedecl(context, node_id, name_context, function_decl, function_info,
  400. is_definition);
  401. // Create a new function if this isn't a valid redeclaration.
  402. if (!function_decl.function_id.has_value()) {
  403. if (function_info.is_extern && context.sem_ir().is_impl()) {
  404. DiagnoseExternRequiresDeclInApiFile(context, node_id);
  405. }
  406. function_info.generic_id = BuildGenericDecl(context, decl_id);
  407. function_decl.function_id = context.functions().Add(function_info);
  408. function_decl.type_id =
  409. GetFunctionType(context, function_decl.function_id,
  410. context.scope_stack().PeekSpecificId());
  411. } else {
  412. auto prev_decl_generic_id =
  413. context.functions().Get(function_decl.function_id).generic_id;
  414. FinishGenericRedecl(context, prev_decl_generic_id);
  415. // TODO: Validate that the redeclaration doesn't set an access modifier.
  416. }
  417. RequestVtableIfVirtual(context, node_id, function_info.virtual_modifier,
  418. parent_scope_inst, decl_id, function_info.generic_id);
  419. // Write the function ID into the FunctionDecl.
  420. ReplaceInstBeforeConstantUse(context, decl_id, function_decl);
  421. // Diagnose 'definition of `abstract` function' using the canonical Function's
  422. // modifiers.
  423. if (is_definition &&
  424. context.functions().Get(function_decl.function_id).virtual_modifier ==
  425. SemIR::Function::VirtualModifier::Abstract) {
  426. CARBON_DIAGNOSTIC(DefinedAbstractFunction, Error,
  427. "definition of `abstract` function");
  428. context.emitter().Emit(LocIdForDiagnostics::TokenOnly(node_id),
  429. DefinedAbstractFunction);
  430. }
  431. // Add to name lookup if needed, now that the decl is built.
  432. MaybeAddToNameLookup(context, name_context, introducer.modifier_set,
  433. parent_scope_inst, decl_id);
  434. ValidateForEntryPoint(context, node_id, function_decl.function_id,
  435. function_info);
  436. if (!is_definition && context.sem_ir().is_impl() && !is_extern) {
  437. context.definitions_required_by_decl().push_back(decl_id);
  438. }
  439. return {function_decl.function_id, decl_id};
  440. }
  441. auto HandleParseNode(Context& context, Parse::FunctionDeclId node_id) -> bool {
  442. BuildFunctionDecl(context, node_id, /*is_definition=*/false);
  443. context.decl_name_stack().PopScope();
  444. return true;
  445. }
  446. // Processes a function definition after a signature for which we have already
  447. // built a function ID. This logic is shared between processing regular function
  448. // definitions and delayed parsing of inline method definitions.
  449. static auto HandleFunctionDefinitionAfterSignature(
  450. Context& context, Parse::FunctionDefinitionStartId node_id,
  451. SemIR::FunctionId function_id, SemIR::InstId decl_id) -> void {
  452. StartFunctionDefinition(context, decl_id, function_id);
  453. context.node_stack().Push(node_id, function_id);
  454. }
  455. auto HandleFunctionDefinitionSuspend(Context& context,
  456. Parse::FunctionDefinitionStartId node_id)
  457. -> DeferredDefinitionWorklist::SuspendedFunction {
  458. // Process the declaration portion of the function.
  459. auto [function_id, decl_id] =
  460. BuildFunctionDecl(context, node_id, /*is_definition=*/true);
  461. return {.function_id = function_id,
  462. .decl_id = decl_id,
  463. .saved_name_state = context.decl_name_stack().Suspend()};
  464. }
  465. auto HandleFunctionDefinitionResume(
  466. Context& context, Parse::FunctionDefinitionStartId node_id,
  467. DeferredDefinitionWorklist::SuspendedFunction&& suspended_fn) -> void {
  468. context.decl_name_stack().Restore(std::move(suspended_fn.saved_name_state));
  469. HandleFunctionDefinitionAfterSignature(
  470. context, node_id, suspended_fn.function_id, suspended_fn.decl_id);
  471. }
  472. auto HandleParseNode(Context& context, Parse::FunctionDefinitionStartId node_id)
  473. -> bool {
  474. // Process the declaration portion of the function.
  475. auto [function_id, decl_id] =
  476. BuildFunctionDecl(context, node_id, /*is_definition=*/true);
  477. HandleFunctionDefinitionAfterSignature(context, node_id, function_id,
  478. decl_id);
  479. return true;
  480. }
  481. auto HandleParseNode(Context& context, Parse::FunctionDefinitionId node_id)
  482. -> bool {
  483. SemIR::FunctionId function_id =
  484. context.node_stack().Pop<Parse::NodeKind::FunctionDefinitionStart>();
  485. // If the `}` of the function is reachable, reject if we need a return value
  486. // and otherwise add an implicit `return;`.
  487. if (IsCurrentPositionReachable(context)) {
  488. if (context.functions().Get(function_id).return_form_inst_id.has_value()) {
  489. CARBON_DIAGNOSTIC(
  490. MissingReturnStatement, Error,
  491. "missing `return` at end of function with declared return type");
  492. context.emitter().Emit(LocIdForDiagnostics::TokenOnly(node_id),
  493. MissingReturnStatement);
  494. } else {
  495. AddReturnCleanupBlock(context, node_id);
  496. }
  497. }
  498. FinishFunctionDefinition(context, function_id);
  499. context.decl_name_stack().PopScope();
  500. return true;
  501. }
  502. auto HandleParseNode(Context& context,
  503. Parse::BuiltinFunctionDefinitionStartId node_id) -> bool {
  504. // Process the declaration portion of the function.
  505. auto [function_id, _] =
  506. BuildFunctionDecl(context, node_id, /*is_definition=*/true);
  507. context.node_stack().Push(node_id, function_id);
  508. return true;
  509. }
  510. auto HandleParseNode(Context& context, Parse::BuiltinNameId node_id) -> bool {
  511. context.node_stack().Push(node_id);
  512. return true;
  513. }
  514. // Looks up a builtin function kind given its name as a string.
  515. // TODO: Move this out to another file.
  516. static auto LookupBuiltinFunctionKind(Context& context,
  517. Parse::BuiltinNameId name_id)
  518. -> SemIR::BuiltinFunctionKind {
  519. auto builtin_name = context.string_literal_values().Get(
  520. context.tokens().GetStringLiteralValue(
  521. context.parse_tree().node_token(name_id)));
  522. auto kind = SemIR::BuiltinFunctionKind::ForBuiltinName(builtin_name);
  523. if (kind == SemIR::BuiltinFunctionKind::None) {
  524. CARBON_DIAGNOSTIC(UnknownBuiltinFunctionName, Error,
  525. "unknown builtin function name \"{0}\"", std::string);
  526. context.emitter().Emit(name_id, UnknownBuiltinFunctionName,
  527. builtin_name.str());
  528. }
  529. return kind;
  530. }
  531. auto HandleParseNode(Context& context,
  532. Parse::BuiltinFunctionDefinitionId /*node_id*/) -> bool {
  533. auto name_id =
  534. context.node_stack().PopForSoloNodeId<Parse::NodeKind::BuiltinName>();
  535. auto [fn_node_id, function_id] =
  536. context.node_stack()
  537. .PopWithNodeId<Parse::NodeKind::BuiltinFunctionDefinitionStart>();
  538. auto builtin_kind = LookupBuiltinFunctionKind(context, name_id);
  539. if (builtin_kind != SemIR::BuiltinFunctionKind::None) {
  540. CheckFunctionDefinitionSignature(context, function_id);
  541. auto& function = context.functions().Get(function_id);
  542. if (IsValidBuiltinDeclaration(context, function, builtin_kind)) {
  543. function.SetBuiltinFunction(builtin_kind);
  544. // Build an empty generic definition if this is a generic builtin.
  545. StartGenericDefinition(context, function.generic_id);
  546. FinishGenericDefinition(context, function.generic_id);
  547. } else {
  548. CARBON_DIAGNOSTIC(InvalidBuiltinSignature, Error,
  549. "invalid signature for builtin function \"{0}\"",
  550. std::string);
  551. context.emitter().Emit(fn_node_id, InvalidBuiltinSignature,
  552. builtin_kind.name().str());
  553. }
  554. }
  555. context.decl_name_stack().PopScope();
  556. return true;
  557. }
  558. auto HandleParseNode(Context& context, Parse::FunctionTerseDefinitionId node_id)
  559. -> bool {
  560. return context.TODO(node_id, "HandleFunctionTerseDefinition");
  561. }
  562. } // namespace Carbon::Check