handle_function.cpp 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640
  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::FunctionDecl function_decl): {
  181. prev_function_id = function_decl.function_id;
  182. prev_type_id = function_decl.type_id;
  183. break;
  184. }
  185. case SemIR::ImportRefLoaded::Kind: {
  186. auto import_ir_inst = GetCanonicalImportIRInst(context, prev_id);
  187. // Verify the decl so that things like aliases are name conflicts.
  188. const auto* import_ir =
  189. context.import_irs().Get(import_ir_inst.ir_id()).sem_ir;
  190. if (!import_ir->insts().Is<SemIR::FunctionDecl>(
  191. import_ir_inst.inst_id())) {
  192. break;
  193. }
  194. // Use the type to get the ID.
  195. if (auto struct_value = context.insts().TryGetAs<SemIR::StructValue>(
  196. context.constant_values().GetConstantInstId(prev_id))) {
  197. if (auto function_type = context.types().TryGetAs<SemIR::FunctionType>(
  198. struct_value->type_id)) {
  199. prev_function_id = function_type->function_id;
  200. prev_type_id = struct_value->type_id;
  201. prev_import_ir_id = import_ir_inst.ir_id();
  202. }
  203. }
  204. break;
  205. }
  206. default:
  207. break;
  208. }
  209. if (!prev_function_id.has_value()) {
  210. DiagnoseDuplicateName(context, name_context.name_id, name_context.loc_id,
  211. SemIR::LocId(prev_id));
  212. return;
  213. }
  214. if (MergeFunctionRedecl(context, node_id, function_info, is_definition,
  215. prev_function_id, prev_import_ir_id)) {
  216. // When merging, use the existing function rather than adding a new one.
  217. function_decl.function_id = prev_function_id;
  218. function_decl.type_id = prev_type_id;
  219. }
  220. }
  221. // Adds the declaration to name lookup when appropriate.
  222. static auto MaybeAddToNameLookup(
  223. Context& context, const DeclNameStack::NameContext& name_context,
  224. const KeywordModifierSet& modifier_set,
  225. const std::optional<SemIR::Inst>& parent_scope_inst, SemIR::InstId decl_id)
  226. -> void {
  227. if (name_context.state == DeclNameStack::NameContext::State::Poisoned ||
  228. name_context.prev_inst_id().has_value()) {
  229. return;
  230. }
  231. // At interface scope, a function declaration introduces an associated
  232. // function.
  233. auto lookup_result_id = decl_id;
  234. if (parent_scope_inst && !name_context.has_qualifiers) {
  235. if (auto interface_scope =
  236. parent_scope_inst->TryAs<SemIR::InterfaceDecl>()) {
  237. lookup_result_id = BuildAssociatedEntity(
  238. context, interface_scope->interface_id, decl_id);
  239. }
  240. }
  241. context.decl_name_stack().AddName(name_context, lookup_result_id,
  242. modifier_set.GetAccessKind());
  243. }
  244. // If the function is the entry point, do corresponding validation.
  245. static auto ValidateForEntryPoint(Context& context,
  246. Parse::AnyFunctionDeclId node_id,
  247. SemIR::FunctionId function_id,
  248. const SemIR::Function& function_info)
  249. -> void {
  250. if (!SemIR::IsEntryPoint(context.sem_ir(), function_id)) {
  251. return;
  252. }
  253. auto return_type_id = function_info.GetDeclaredReturnType(context.sem_ir());
  254. // TODO: Update this once valid signatures for the entry point are decided.
  255. if (function_info.implicit_param_patterns_id.has_value() ||
  256. !function_info.param_patterns_id.has_value() ||
  257. !context.inst_blocks().Get(function_info.param_patterns_id).empty() ||
  258. (return_type_id.has_value() &&
  259. return_type_id != GetTupleType(context, {}) &&
  260. // TODO: Decide on valid return types for `Main.Run`. Perhaps we should
  261. // have an interface for this.
  262. return_type_id != MakeIntType(context, node_id, SemIR::IntKind::Signed,
  263. context.ints().Add(32)))) {
  264. CARBON_DIAGNOSTIC(InvalidMainRunSignature, Error,
  265. "invalid signature for `Main.Run` function; expected "
  266. "`fn ()` or `fn () -> i32`");
  267. context.emitter().Emit(node_id, InvalidMainRunSignature);
  268. }
  269. }
  270. static auto IsGenericFunction(Context& context,
  271. SemIR::GenericId function_generic_id,
  272. SemIR::GenericId class_generic_id) -> bool {
  273. if (function_generic_id == SemIR::GenericId::None) {
  274. return false;
  275. }
  276. if (class_generic_id == SemIR::GenericId::None) {
  277. return true;
  278. }
  279. const auto& function_generic = context.generics().Get(function_generic_id);
  280. const auto& class_generic = context.generics().Get(class_generic_id);
  281. auto function_bindings =
  282. context.inst_blocks().Get(function_generic.bindings_id);
  283. auto class_bindings = context.inst_blocks().Get(class_generic.bindings_id);
  284. // If the function's bindings are the same size as the class's bindings,
  285. // then there are no extra bindings for the function, so it is effectively
  286. // non-generic within the scope of a specific of the class.
  287. return class_bindings.size() != function_bindings.size();
  288. }
  289. // Requests a vtable be created when processing a virtual function.
  290. static auto RequestVtableIfVirtual(
  291. Context& context, Parse::AnyFunctionDeclId node_id,
  292. SemIR::Function::VirtualModifier& virtual_modifier,
  293. const std::optional<SemIR::Inst>& parent_scope_inst, SemIR::InstId decl_id,
  294. SemIR::GenericId generic_id) -> void {
  295. // In order to request a vtable, the function must be virtual, and in a class
  296. // scope.
  297. if (virtual_modifier == SemIR::Function::VirtualModifier::None ||
  298. !parent_scope_inst) {
  299. return;
  300. }
  301. auto class_decl = parent_scope_inst->TryAs<SemIR::ClassDecl>();
  302. if (!class_decl) {
  303. return;
  304. }
  305. auto& class_info = context.classes().Get(class_decl->class_id);
  306. if (virtual_modifier == SemIR::Function::VirtualModifier::Override &&
  307. !class_info.base_id.has_value()) {
  308. CARBON_DIAGNOSTIC(OverrideWithoutBase, Error,
  309. "override without base class");
  310. context.emitter().Emit(node_id, OverrideWithoutBase);
  311. virtual_modifier = SemIR::Function::VirtualModifier::None;
  312. return;
  313. }
  314. if (IsGenericFunction(context, generic_id, class_info.generic_id)) {
  315. CARBON_DIAGNOSTIC(GenericVirtual, Error, "generic virtual function");
  316. context.emitter().Emit(node_id, GenericVirtual);
  317. virtual_modifier = SemIR::Function::VirtualModifier::None;
  318. return;
  319. }
  320. // TODO: If this is an `impl` function, check there's a matching base
  321. // function that's impl or virtual.
  322. class_info.is_dynamic = true;
  323. context.vtable_stack().AddInstId(decl_id);
  324. }
  325. // Diagnoses when positional params aren't supported. Reassigns the pattern
  326. // block if needed.
  327. static auto DiagnosePositionalParams(Context& context,
  328. SemIR::Function& function_info) -> void {
  329. if (function_info.param_patterns_id.has_value()) {
  330. return;
  331. }
  332. context.TODO(function_info.latest_decl_id(),
  333. "function with positional parameters");
  334. function_info.param_patterns_id = SemIR::InstBlockId::Empty;
  335. }
  336. // Build a FunctionDecl describing the signature of a function. This
  337. // handles the common logic shared by function declaration syntax and function
  338. // definition syntax.
  339. static auto BuildFunctionDecl(Context& context,
  340. Parse::AnyFunctionDeclId node_id,
  341. bool is_definition)
  342. -> std::pair<SemIR::FunctionId, SemIR::InstId> {
  343. auto return_patterns_id = SemIR::InstBlockId::None;
  344. auto return_type_inst_id = SemIR::TypeInstId::None;
  345. auto return_form_inst_id = SemIR::InstId::None;
  346. if (auto [return_node, maybe_return_patterns_id] =
  347. context.node_stack().PopWithNodeIdIf<Parse::NodeKind::ReturnType>();
  348. maybe_return_patterns_id) {
  349. return_patterns_id = *maybe_return_patterns_id;
  350. auto return_form = context.PopReturnForm();
  351. return_type_inst_id = return_form.type_component_id;
  352. return_form_inst_id = return_form.form_inst_id;
  353. }
  354. auto name = PopNameComponent(context, return_patterns_id);
  355. auto name_context = context.decl_name_stack().FinishName(name);
  356. context.node_stack()
  357. .PopAndDiscardSoloNodeId<Parse::NodeKind::FunctionIntroducer>();
  358. auto self_param_id =
  359. FindSelfPattern(context, name.implicit_param_patterns_id);
  360. // Process modifiers.
  361. auto [parent_scope_inst_id, parent_scope_inst] =
  362. context.name_scopes().GetInstIfValid(name_context.parent_scope_id);
  363. auto introducer =
  364. context.decl_introducer_state_stack().Pop<Lex::TokenKind::Fn>();
  365. DiagnoseModifiers(context, node_id, introducer, is_definition,
  366. parent_scope_inst_id, parent_scope_inst, self_param_id);
  367. bool is_extern = introducer.modifier_set.HasAnyOf(KeywordModifierSet::Extern);
  368. auto virtual_modifier = GetVirtualModifier(introducer.modifier_set);
  369. // Add the function declaration.
  370. SemIR::FunctionDecl function_decl = {SemIR::TypeId::None,
  371. SemIR::FunctionId::None,
  372. context.inst_block_stack().Pop()};
  373. auto decl_id = AddPlaceholderInst(context, node_id, function_decl);
  374. // Build the function entity. This will be merged into an existing function if
  375. // there is one, or otherwise added to the function store.
  376. auto function_info =
  377. SemIR::Function{name_context.MakeEntityWithParamsBase(
  378. name, decl_id, is_extern, introducer.extern_library),
  379. {.call_param_patterns_id = name.call_param_patterns_id,
  380. .call_params_id = name.call_params_id,
  381. .return_type_inst_id = return_type_inst_id,
  382. .return_form_inst_id = return_form_inst_id,
  383. .return_patterns_id = return_patterns_id,
  384. .virtual_modifier = virtual_modifier,
  385. .self_param_id = self_param_id}};
  386. if (is_definition) {
  387. function_info.definition_id = decl_id;
  388. }
  389. DiagnosePositionalParams(context, function_info);
  390. TryMergeRedecl(context, node_id, name_context, function_decl, function_info,
  391. is_definition);
  392. // Create a new function if this isn't a valid redeclaration.
  393. if (!function_decl.function_id.has_value()) {
  394. if (function_info.is_extern && context.sem_ir().is_impl()) {
  395. DiagnoseExternRequiresDeclInApiFile(context, node_id);
  396. }
  397. function_info.generic_id = BuildGenericDecl(context, decl_id);
  398. function_decl.function_id = context.functions().Add(function_info);
  399. function_decl.type_id =
  400. GetFunctionType(context, function_decl.function_id,
  401. context.scope_stack().PeekSpecificId());
  402. } else {
  403. auto prev_decl_generic_id =
  404. context.functions().Get(function_decl.function_id).generic_id;
  405. FinishGenericRedecl(context, prev_decl_generic_id);
  406. // TODO: Validate that the redeclaration doesn't set an access modifier.
  407. }
  408. RequestVtableIfVirtual(context, node_id, function_info.virtual_modifier,
  409. parent_scope_inst, decl_id, function_info.generic_id);
  410. // Write the function ID into the FunctionDecl.
  411. ReplaceInstBeforeConstantUse(context, decl_id, function_decl);
  412. // Diagnose 'definition of `abstract` function' using the canonical Function's
  413. // modifiers.
  414. if (is_definition &&
  415. context.functions().Get(function_decl.function_id).virtual_modifier ==
  416. SemIR::Function::VirtualModifier::Abstract) {
  417. CARBON_DIAGNOSTIC(DefinedAbstractFunction, Error,
  418. "definition of `abstract` function");
  419. context.emitter().Emit(LocIdForDiagnostics::TokenOnly(node_id),
  420. DefinedAbstractFunction);
  421. }
  422. // Add to name lookup if needed, now that the decl is built.
  423. MaybeAddToNameLookup(context, name_context, introducer.modifier_set,
  424. parent_scope_inst, decl_id);
  425. ValidateForEntryPoint(context, node_id, function_decl.function_id,
  426. function_info);
  427. if (!is_definition && context.sem_ir().is_impl() && !is_extern) {
  428. context.definitions_required_by_decl().push_back(decl_id);
  429. }
  430. return {function_decl.function_id, decl_id};
  431. }
  432. auto HandleParseNode(Context& context, Parse::FunctionDeclId node_id) -> bool {
  433. BuildFunctionDecl(context, node_id, /*is_definition=*/false);
  434. context.decl_name_stack().PopScope();
  435. return true;
  436. }
  437. // Processes a function definition after a signature for which we have already
  438. // built a function ID. This logic is shared between processing regular function
  439. // definitions and delayed parsing of inline method definitions.
  440. static auto HandleFunctionDefinitionAfterSignature(
  441. Context& context, Parse::FunctionDefinitionStartId node_id,
  442. SemIR::FunctionId function_id, SemIR::InstId decl_id) -> void {
  443. // Create the function scope and the entry block.
  444. context.scope_stack().PushForFunctionBody(decl_id);
  445. context.inst_block_stack().Push();
  446. context.region_stack().PushRegion(context.inst_block_stack().PeekOrAdd());
  447. StartGenericDefinition(context,
  448. context.functions().Get(function_id).generic_id);
  449. CheckFunctionDefinitionSignature(context, function_id);
  450. context.node_stack().Push(node_id, function_id);
  451. }
  452. auto HandleFunctionDefinitionSuspend(Context& context,
  453. Parse::FunctionDefinitionStartId node_id)
  454. -> DeferredDefinitionWorklist::SuspendedFunction {
  455. // Process the declaration portion of the function.
  456. auto [function_id, decl_id] =
  457. BuildFunctionDecl(context, node_id, /*is_definition=*/true);
  458. return {.function_id = function_id,
  459. .decl_id = decl_id,
  460. .saved_name_state = context.decl_name_stack().Suspend()};
  461. }
  462. auto HandleFunctionDefinitionResume(
  463. Context& context, Parse::FunctionDefinitionStartId node_id,
  464. DeferredDefinitionWorklist::SuspendedFunction&& suspended_fn) -> void {
  465. context.decl_name_stack().Restore(std::move(suspended_fn.saved_name_state));
  466. HandleFunctionDefinitionAfterSignature(
  467. context, node_id, suspended_fn.function_id, suspended_fn.decl_id);
  468. }
  469. auto HandleParseNode(Context& context, Parse::FunctionDefinitionStartId node_id)
  470. -> bool {
  471. // Process the declaration portion of the function.
  472. auto [function_id, decl_id] =
  473. BuildFunctionDecl(context, node_id, /*is_definition=*/true);
  474. HandleFunctionDefinitionAfterSignature(context, node_id, function_id,
  475. decl_id);
  476. return true;
  477. }
  478. auto HandleParseNode(Context& context, Parse::FunctionDefinitionId node_id)
  479. -> bool {
  480. SemIR::FunctionId function_id =
  481. context.node_stack().Pop<Parse::NodeKind::FunctionDefinitionStart>();
  482. // If the `}` of the function is reachable, reject if we need a return value
  483. // and otherwise add an implicit `return;`.
  484. if (IsCurrentPositionReachable(context)) {
  485. if (context.functions().Get(function_id).return_form_inst_id.has_value()) {
  486. CARBON_DIAGNOSTIC(
  487. MissingReturnStatement, Error,
  488. "missing `return` at end of function with declared return type");
  489. context.emitter().Emit(LocIdForDiagnostics::TokenOnly(node_id),
  490. MissingReturnStatement);
  491. } else {
  492. AddReturnCleanupBlock(context, node_id);
  493. }
  494. }
  495. context.inst_block_stack().Pop();
  496. context.scope_stack().Pop();
  497. context.decl_name_stack().PopScope();
  498. auto& function = context.functions().Get(function_id);
  499. function.body_block_ids = context.region_stack().PopRegion();
  500. // If this is a generic function, collect information about the definition.
  501. FinishGenericDefinition(context, function.generic_id);
  502. return true;
  503. }
  504. auto HandleParseNode(Context& context,
  505. Parse::BuiltinFunctionDefinitionStartId node_id) -> bool {
  506. // Process the declaration portion of the function.
  507. auto [function_id, _] =
  508. BuildFunctionDecl(context, node_id, /*is_definition=*/true);
  509. context.node_stack().Push(node_id, function_id);
  510. return true;
  511. }
  512. auto HandleParseNode(Context& context, Parse::BuiltinNameId node_id) -> bool {
  513. context.node_stack().Push(node_id);
  514. return true;
  515. }
  516. // Looks up a builtin function kind given its name as a string.
  517. // TODO: Move this out to another file.
  518. static auto LookupBuiltinFunctionKind(Context& context,
  519. Parse::BuiltinNameId name_id)
  520. -> SemIR::BuiltinFunctionKind {
  521. auto builtin_name = context.string_literal_values().Get(
  522. context.tokens().GetStringLiteralValue(
  523. context.parse_tree().node_token(name_id)));
  524. auto kind = SemIR::BuiltinFunctionKind::ForBuiltinName(builtin_name);
  525. if (kind == SemIR::BuiltinFunctionKind::None) {
  526. CARBON_DIAGNOSTIC(UnknownBuiltinFunctionName, Error,
  527. "unknown builtin function name \"{0}\"", std::string);
  528. context.emitter().Emit(name_id, UnknownBuiltinFunctionName,
  529. builtin_name.str());
  530. }
  531. return kind;
  532. }
  533. auto HandleParseNode(Context& context,
  534. Parse::BuiltinFunctionDefinitionId /*node_id*/) -> bool {
  535. auto name_id =
  536. context.node_stack().PopForSoloNodeId<Parse::NodeKind::BuiltinName>();
  537. auto [fn_node_id, function_id] =
  538. context.node_stack()
  539. .PopWithNodeId<Parse::NodeKind::BuiltinFunctionDefinitionStart>();
  540. auto builtin_kind = LookupBuiltinFunctionKind(context, name_id);
  541. if (builtin_kind != SemIR::BuiltinFunctionKind::None) {
  542. CheckFunctionDefinitionSignature(context, function_id);
  543. auto& function = context.functions().Get(function_id);
  544. if (IsValidBuiltinDeclaration(context, function, builtin_kind)) {
  545. function.SetBuiltinFunction(builtin_kind);
  546. // Build an empty generic definition if this is a generic builtin.
  547. StartGenericDefinition(context, function.generic_id);
  548. FinishGenericDefinition(context, function.generic_id);
  549. } else {
  550. CARBON_DIAGNOSTIC(InvalidBuiltinSignature, Error,
  551. "invalid signature for builtin function \"{0}\"",
  552. std::string);
  553. context.emitter().Emit(fn_node_id, InvalidBuiltinSignature,
  554. builtin_kind.name().str());
  555. }
  556. }
  557. context.decl_name_stack().PopScope();
  558. return true;
  559. }
  560. auto HandleParseNode(Context& context, Parse::FunctionTerseDefinitionId node_id)
  561. -> bool {
  562. return context.TODO(node_id, "HandleFunctionTerseDefinition");
  563. }
  564. } // namespace Carbon::Check