ECMAScriptFunctionObject.cpp 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106
  1. /*
  2. * Copyright (c) 2020, Stephan Unverwerth <s.unverwerth@serenityos.org>
  3. * Copyright (c) 2020-2023, Linus Groh <linusg@serenityos.org>
  4. * Copyright (c) 2023, Andreas Kling <kling@serenityos.org>
  5. * Copyright (c) 2023, Shannon Booth <shannon@serenityos.org>
  6. *
  7. * SPDX-License-Identifier: BSD-2-Clause
  8. */
  9. #include <AK/Debug.h>
  10. #include <AK/Function.h>
  11. #include <LibJS/AST.h>
  12. #include <LibJS/Bytecode/BasicBlock.h>
  13. #include <LibJS/Bytecode/Generator.h>
  14. #include <LibJS/Bytecode/Interpreter.h>
  15. #include <LibJS/Runtime/AbstractOperations.h>
  16. #include <LibJS/Runtime/Array.h>
  17. #include <LibJS/Runtime/AsyncFunctionDriverWrapper.h>
  18. #include <LibJS/Runtime/AsyncGenerator.h>
  19. #include <LibJS/Runtime/ECMAScriptFunctionObject.h>
  20. #include <LibJS/Runtime/Error.h>
  21. #include <LibJS/Runtime/ExecutionContext.h>
  22. #include <LibJS/Runtime/FunctionEnvironment.h>
  23. #include <LibJS/Runtime/GeneratorObject.h>
  24. #include <LibJS/Runtime/GlobalEnvironment.h>
  25. #include <LibJS/Runtime/GlobalObject.h>
  26. #include <LibJS/Runtime/NativeFunction.h>
  27. #include <LibJS/Runtime/PromiseCapability.h>
  28. #include <LibJS/Runtime/PromiseConstructor.h>
  29. #include <LibJS/Runtime/Value.h>
  30. namespace JS {
  31. NonnullGCPtr<ECMAScriptFunctionObject> ECMAScriptFunctionObject::create(Realm& realm, DeprecatedFlyString name, DeprecatedString source_text, Statement const& ecmascript_code, Vector<FunctionParameter> parameters, i32 m_function_length, Vector<DeprecatedFlyString> local_variables_names, Environment* parent_environment, PrivateEnvironment* private_environment, FunctionKind kind, bool is_strict, bool might_need_arguments_object, bool contains_direct_call_to_eval, bool is_arrow_function, Variant<PropertyKey, PrivateName, Empty> class_field_initializer_name)
  32. {
  33. Object* prototype = nullptr;
  34. switch (kind) {
  35. case FunctionKind::Normal:
  36. prototype = realm.intrinsics().function_prototype();
  37. break;
  38. case FunctionKind::Generator:
  39. prototype = realm.intrinsics().generator_function_prototype();
  40. break;
  41. case FunctionKind::Async:
  42. prototype = realm.intrinsics().async_function_prototype();
  43. break;
  44. case FunctionKind::AsyncGenerator:
  45. prototype = realm.intrinsics().async_generator_function_prototype();
  46. break;
  47. }
  48. return realm.heap().allocate<ECMAScriptFunctionObject>(realm, move(name), move(source_text), ecmascript_code, move(parameters), m_function_length, move(local_variables_names), parent_environment, private_environment, *prototype, kind, is_strict, might_need_arguments_object, contains_direct_call_to_eval, is_arrow_function, move(class_field_initializer_name));
  49. }
  50. NonnullGCPtr<ECMAScriptFunctionObject> ECMAScriptFunctionObject::create(Realm& realm, DeprecatedFlyString name, Object& prototype, DeprecatedString source_text, Statement const& ecmascript_code, Vector<FunctionParameter> parameters, i32 m_function_length, Vector<DeprecatedFlyString> local_variables_names, Environment* parent_environment, PrivateEnvironment* private_environment, FunctionKind kind, bool is_strict, bool might_need_arguments_object, bool contains_direct_call_to_eval, bool is_arrow_function, Variant<PropertyKey, PrivateName, Empty> class_field_initializer_name)
  51. {
  52. return realm.heap().allocate<ECMAScriptFunctionObject>(realm, move(name), move(source_text), ecmascript_code, move(parameters), m_function_length, move(local_variables_names), parent_environment, private_environment, prototype, kind, is_strict, might_need_arguments_object, contains_direct_call_to_eval, is_arrow_function, move(class_field_initializer_name));
  53. }
  54. ECMAScriptFunctionObject::ECMAScriptFunctionObject(DeprecatedFlyString name, DeprecatedString source_text, Statement const& ecmascript_code, Vector<FunctionParameter> formal_parameters, i32 function_length, Vector<DeprecatedFlyString> local_variables_names, Environment* parent_environment, PrivateEnvironment* private_environment, Object& prototype, FunctionKind kind, bool strict, bool might_need_arguments_object, bool contains_direct_call_to_eval, bool is_arrow_function, Variant<PropertyKey, PrivateName, Empty> class_field_initializer_name)
  55. : FunctionObject(prototype)
  56. , m_name(move(name))
  57. , m_function_length(function_length)
  58. , m_local_variables_names(move(local_variables_names))
  59. , m_environment(parent_environment)
  60. , m_private_environment(private_environment)
  61. , m_formal_parameters(move(formal_parameters))
  62. , m_ecmascript_code(ecmascript_code)
  63. , m_realm(&prototype.shape().realm())
  64. , m_source_text(move(source_text))
  65. , m_class_field_initializer_name(move(class_field_initializer_name))
  66. , m_strict(strict)
  67. , m_might_need_arguments_object(might_need_arguments_object)
  68. , m_contains_direct_call_to_eval(contains_direct_call_to_eval)
  69. , m_is_arrow_function(is_arrow_function)
  70. , m_kind(kind)
  71. {
  72. // NOTE: This logic is from OrdinaryFunctionCreate, https://tc39.es/ecma262/#sec-ordinaryfunctioncreate
  73. // 9. If thisMode is lexical-this, set F.[[ThisMode]] to lexical.
  74. if (m_is_arrow_function)
  75. m_this_mode = ThisMode::Lexical;
  76. // 10. Else if Strict is true, set F.[[ThisMode]] to strict.
  77. else if (m_strict)
  78. m_this_mode = ThisMode::Strict;
  79. else
  80. // 11. Else, set F.[[ThisMode]] to global.
  81. m_this_mode = ThisMode::Global;
  82. // 15. Set F.[[ScriptOrModule]] to GetActiveScriptOrModule().
  83. m_script_or_module = vm().get_active_script_or_module();
  84. // 15.1.3 Static Semantics: IsSimpleParameterList, https://tc39.es/ecma262/#sec-static-semantics-issimpleparameterlist
  85. m_has_simple_parameter_list = all_of(m_formal_parameters, [&](auto& parameter) {
  86. if (parameter.is_rest)
  87. return false;
  88. if (parameter.default_value)
  89. return false;
  90. if (!parameter.binding.template has<NonnullRefPtr<Identifier const>>())
  91. return false;
  92. return true;
  93. });
  94. }
  95. void ECMAScriptFunctionObject::initialize(Realm& realm)
  96. {
  97. auto& vm = this->vm();
  98. Base::initialize(realm);
  99. // Note: The ordering of these properties must be: length, name, prototype which is the order
  100. // they are defined in the spec: https://tc39.es/ecma262/#sec-function-instances .
  101. // This is observable through something like: https://tc39.es/ecma262/#sec-ordinaryownpropertykeys
  102. // which must give the properties in chronological order which in this case is the order they
  103. // are defined in the spec.
  104. MUST(define_property_or_throw(vm.names.length, { .value = Value(m_function_length), .writable = false, .enumerable = false, .configurable = true }));
  105. MUST(define_property_or_throw(vm.names.name, { .value = PrimitiveString::create(vm, m_name.is_null() ? "" : m_name), .writable = false, .enumerable = false, .configurable = true }));
  106. if (!m_is_arrow_function) {
  107. Object* prototype = nullptr;
  108. switch (m_kind) {
  109. case FunctionKind::Normal:
  110. prototype = vm.heap().allocate<Object>(realm, realm.intrinsics().new_ordinary_function_prototype_object_shape());
  111. MUST(prototype->define_property_or_throw(vm.names.constructor, { .value = this, .writable = true, .enumerable = false, .configurable = true }));
  112. break;
  113. case FunctionKind::Generator:
  114. // prototype is "g1.prototype" in figure-2 (https://tc39.es/ecma262/img/figure-2.png)
  115. prototype = Object::create(realm, realm.intrinsics().generator_function_prototype_prototype());
  116. break;
  117. case FunctionKind::Async:
  118. break;
  119. case FunctionKind::AsyncGenerator:
  120. prototype = Object::create(realm, realm.intrinsics().async_generator_function_prototype_prototype());
  121. break;
  122. }
  123. // 27.7.4 AsyncFunction Instances, https://tc39.es/ecma262/#sec-async-function-instances
  124. // AsyncFunction instances do not have a prototype property as they are not constructible.
  125. if (m_kind != FunctionKind::Async)
  126. define_direct_property(vm.names.prototype, prototype, Attribute::Writable);
  127. }
  128. }
  129. // 10.2.1 [[Call]] ( thisArgument, argumentsList ), https://tc39.es/ecma262/#sec-ecmascript-function-objects-call-thisargument-argumentslist
  130. ThrowCompletionOr<Value> ECMAScriptFunctionObject::internal_call(Value this_argument, MarkedVector<Value> arguments_list)
  131. {
  132. auto& vm = this->vm();
  133. // 1. Let callerContext be the running execution context.
  134. // NOTE: No-op, kept by the VM in its execution context stack.
  135. ExecutionContext callee_context(heap());
  136. callee_context.local_variables.resize(m_local_variables_names.size());
  137. // Non-standard
  138. callee_context.arguments.extend(move(arguments_list));
  139. callee_context.instruction_stream_iterator = vm.bytecode_interpreter().instruction_stream_iterator();
  140. // 2. Let calleeContext be PrepareForOrdinaryCall(F, undefined).
  141. // NOTE: We throw if the end of the native stack is reached, so unlike in the spec this _does_ need an exception check.
  142. TRY(prepare_for_ordinary_call(callee_context, nullptr));
  143. // 3. Assert: calleeContext is now the running execution context.
  144. VERIFY(&vm.running_execution_context() == &callee_context);
  145. // 4. If F.[[IsClassConstructor]] is true, then
  146. if (m_is_class_constructor) {
  147. // a. Let error be a newly created TypeError object.
  148. // b. NOTE: error is created in calleeContext with F's associated Realm Record.
  149. auto throw_completion = vm.throw_completion<TypeError>(ErrorType::ClassConstructorWithoutNew, m_name);
  150. // c. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  151. vm.pop_execution_context();
  152. // d. Return ThrowCompletion(error).
  153. return throw_completion;
  154. }
  155. // 5. Perform OrdinaryCallBindThis(F, calleeContext, thisArgument).
  156. ordinary_call_bind_this(callee_context, this_argument);
  157. // 6. Let result be Completion(OrdinaryCallEvaluateBody(F, argumentsList)).
  158. auto result = ordinary_call_evaluate_body();
  159. // 7. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  160. vm.pop_execution_context();
  161. // 8. If result.[[Type]] is return, return result.[[Value]].
  162. if (result.type() == Completion::Type::Return)
  163. return *result.value();
  164. // 9. ReturnIfAbrupt(result).
  165. if (result.is_abrupt()) {
  166. VERIFY(result.is_error());
  167. return result;
  168. }
  169. // 10. Return undefined.
  170. return js_undefined();
  171. }
  172. // 10.2.2 [[Construct]] ( argumentsList, newTarget ), https://tc39.es/ecma262/#sec-ecmascript-function-objects-construct-argumentslist-newtarget
  173. ThrowCompletionOr<NonnullGCPtr<Object>> ECMAScriptFunctionObject::internal_construct(MarkedVector<Value> arguments_list, FunctionObject& new_target)
  174. {
  175. auto& vm = this->vm();
  176. // 1. Let callerContext be the running execution context.
  177. // NOTE: No-op, kept by the VM in its execution context stack.
  178. // 2. Let kind be F.[[ConstructorKind]].
  179. auto kind = m_constructor_kind;
  180. GCPtr<Object> this_argument;
  181. // 3. If kind is base, then
  182. if (kind == ConstructorKind::Base) {
  183. // a. Let thisArgument be ? OrdinaryCreateFromConstructor(newTarget, "%Object.prototype%").
  184. this_argument = TRY(ordinary_create_from_constructor<Object>(vm, new_target, &Intrinsics::object_prototype, ConstructWithPrototypeTag::Tag));
  185. }
  186. ExecutionContext callee_context(heap());
  187. callee_context.local_variables.resize(m_local_variables_names.size());
  188. // Non-standard
  189. callee_context.arguments.extend(move(arguments_list));
  190. callee_context.instruction_stream_iterator = vm.bytecode_interpreter().instruction_stream_iterator();
  191. // 4. Let calleeContext be PrepareForOrdinaryCall(F, newTarget).
  192. // NOTE: We throw if the end of the native stack is reached, so unlike in the spec this _does_ need an exception check.
  193. TRY(prepare_for_ordinary_call(callee_context, &new_target));
  194. // 5. Assert: calleeContext is now the running execution context.
  195. VERIFY(&vm.running_execution_context() == &callee_context);
  196. // 6. If kind is base, then
  197. if (kind == ConstructorKind::Base) {
  198. // a. Perform OrdinaryCallBindThis(F, calleeContext, thisArgument).
  199. ordinary_call_bind_this(callee_context, this_argument);
  200. // b. Let initializeResult be Completion(InitializeInstanceElements(thisArgument, F)).
  201. auto initialize_result = this_argument->initialize_instance_elements(*this);
  202. // c. If initializeResult is an abrupt completion, then
  203. if (initialize_result.is_throw_completion()) {
  204. // i. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  205. vm.pop_execution_context();
  206. // ii. Return ? initializeResult.
  207. return initialize_result.throw_completion();
  208. }
  209. }
  210. // 7. Let constructorEnv be the LexicalEnvironment of calleeContext.
  211. auto constructor_env = callee_context.lexical_environment;
  212. // 8. Let result be Completion(OrdinaryCallEvaluateBody(F, argumentsList)).
  213. auto result = ordinary_call_evaluate_body();
  214. // 9. Remove calleeContext from the execution context stack and restore callerContext as the running execution context.
  215. vm.pop_execution_context();
  216. // 10. If result.[[Type]] is return, then
  217. if (result.type() == Completion::Type::Return) {
  218. // FIXME: This is leftover from untangling the call/construct mess - doesn't belong here in any way, but removing it breaks derived classes.
  219. // Likely fixed by making ClassDefinitionEvaluation fully spec compliant.
  220. if (kind == ConstructorKind::Derived && result.value()->is_object()) {
  221. auto prototype = TRY(new_target.get(vm.names.prototype));
  222. if (prototype.is_object())
  223. TRY(result.value()->as_object().internal_set_prototype_of(&prototype.as_object()));
  224. }
  225. // EOF (End of FIXME)
  226. // a. If Type(result.[[Value]]) is Object, return result.[[Value]].
  227. if (result.value()->is_object())
  228. return result.value()->as_object();
  229. // b. If kind is base, return thisArgument.
  230. if (kind == ConstructorKind::Base)
  231. return *this_argument;
  232. // c. If result.[[Value]] is not undefined, throw a TypeError exception.
  233. if (!result.value()->is_undefined())
  234. return vm.throw_completion<TypeError>(ErrorType::DerivedConstructorReturningInvalidValue);
  235. }
  236. // 11. Else, ReturnIfAbrupt(result).
  237. else if (result.is_abrupt()) {
  238. VERIFY(result.is_error());
  239. return result;
  240. }
  241. // 12. Let thisBinding be ? constructorEnv.GetThisBinding().
  242. auto this_binding = TRY(constructor_env->get_this_binding(vm));
  243. // 13. Assert: Type(thisBinding) is Object.
  244. VERIFY(this_binding.is_object());
  245. // 14. Return thisBinding.
  246. return this_binding.as_object();
  247. }
  248. void ECMAScriptFunctionObject::visit_edges(Visitor& visitor)
  249. {
  250. Base::visit_edges(visitor);
  251. visitor.visit(m_environment);
  252. visitor.visit(m_private_environment);
  253. visitor.visit(m_realm);
  254. visitor.visit(m_home_object);
  255. for (auto& field : m_fields) {
  256. if (auto* property_key_ptr = field.name.get_pointer<PropertyKey>(); property_key_ptr && property_key_ptr->is_symbol())
  257. visitor.visit(property_key_ptr->as_symbol());
  258. }
  259. m_script_or_module.visit(
  260. [](Empty) {},
  261. [&](auto& script_or_module) {
  262. visitor.visit(script_or_module.ptr());
  263. });
  264. }
  265. // 10.2.7 MakeMethod ( F, homeObject ), https://tc39.es/ecma262/#sec-makemethod
  266. void ECMAScriptFunctionObject::make_method(Object& home_object)
  267. {
  268. // 1. Set F.[[HomeObject]] to homeObject.
  269. m_home_object = &home_object;
  270. // 2. Return unused.
  271. }
  272. // 10.2.11 FunctionDeclarationInstantiation ( func, argumentsList ), https://tc39.es/ecma262/#sec-functiondeclarationinstantiation
  273. ThrowCompletionOr<void> ECMAScriptFunctionObject::function_declaration_instantiation()
  274. {
  275. auto& vm = this->vm();
  276. auto& realm = *vm.current_realm();
  277. // 1. Let calleeContext be the running execution context.
  278. auto& callee_context = vm.running_execution_context();
  279. // 2. Let code be func.[[ECMAScriptCode]].
  280. ScopeNode const* scope_body = nullptr;
  281. if (is<ScopeNode>(*m_ecmascript_code))
  282. scope_body = static_cast<ScopeNode const*>(m_ecmascript_code.ptr());
  283. // 3. Let strict be func.[[Strict]].
  284. bool const strict = is_strict_mode();
  285. bool has_parameter_expressions = false;
  286. // 4. Let formals be func.[[FormalParameters]].
  287. auto const& formals = m_formal_parameters;
  288. // FIXME: Maybe compute has duplicates at parse time? (We need to anyway since it's an error in some cases)
  289. // 5. Let parameterNames be the BoundNames of formals.
  290. // 6. If parameterNames has any duplicate entries, let hasDuplicates be true. Otherwise, let hasDuplicates be false.
  291. bool has_duplicates = false;
  292. HashTable<DeprecatedFlyString> parameter_names;
  293. // NOTE: This loop performs step 5, 6, and 8.
  294. for (auto const& parameter : formals) {
  295. if (parameter.default_value)
  296. has_parameter_expressions = true;
  297. parameter.binding.visit(
  298. [&](Identifier const& identifier) {
  299. if (parameter_names.set(identifier.string()) != AK::HashSetResult::InsertedNewEntry)
  300. has_duplicates = true;
  301. },
  302. [&](NonnullRefPtr<BindingPattern const> const& pattern) {
  303. if (pattern->contains_expression())
  304. has_parameter_expressions = true;
  305. // NOTE: Nothing in the callback throws an exception.
  306. MUST(pattern->for_each_bound_identifier([&](auto& identifier) {
  307. if (parameter_names.set(identifier.string()) != AK::HashSetResult::InsertedNewEntry)
  308. has_duplicates = true;
  309. }));
  310. });
  311. }
  312. // 7. Let simpleParameterList be IsSimpleParameterList of formals.
  313. bool const simple_parameter_list = has_simple_parameter_list();
  314. // 8. Let hasParameterExpressions be ContainsExpression of formals.
  315. // NOTE: Already set above.
  316. // 9. Let varNames be the VarDeclaredNames of code.
  317. // 10. Let varDeclarations be the VarScopedDeclarations of code.
  318. // 11. Let lexicalNames be the LexicallyDeclaredNames of code.
  319. // NOTE: Not needed as we use iteration helpers for this instead.
  320. // 12. Let functionNames be a new empty List.
  321. HashTable<DeprecatedFlyString> function_names;
  322. // 13. Let functionsToInitialize be a new empty List.
  323. Vector<FunctionDeclaration const&> functions_to_initialize;
  324. // 14. For each element d of varDeclarations, in reverse List order, do
  325. // a. If d is neither a VariableDeclaration nor a ForBinding nor a BindingIdentifier, then
  326. // i. Assert: d is either a FunctionDeclaration, a GeneratorDeclaration, an AsyncFunctionDeclaration, or an AsyncGeneratorDeclaration.
  327. // ii. Let fn be the sole element of the BoundNames of d.
  328. // iii. If functionNames does not contain fn, then
  329. // 1. Insert fn as the first element of functionNames.
  330. // 2. NOTE: If there are multiple function declarations for the same name, the last declaration is used.
  331. // 3. Insert d as the first element of functionsToInitialize.
  332. // NOTE: This block is done in step 18 below.
  333. // 15. Let argumentsObjectNeeded be true.
  334. auto arguments_object_needed = m_might_need_arguments_object;
  335. // 16. If func.[[ThisMode]] is lexical, then
  336. if (this_mode() == ThisMode::Lexical) {
  337. // a. NOTE: Arrow functions never have an arguments object.
  338. // b. Set argumentsObjectNeeded to false.
  339. arguments_object_needed = false;
  340. }
  341. // 17. Else if parameterNames contains "arguments", then
  342. else if (parameter_names.contains(vm.names.arguments.as_string())) {
  343. // a. Set argumentsObjectNeeded to false.
  344. arguments_object_needed = false;
  345. }
  346. // 18. Else if hasParameterExpressions is false, then
  347. // a. If functionNames contains "arguments" or lexicalNames contains "arguments", then
  348. // i. Set argumentsObjectNeeded to false.
  349. // NOTE: The block below is a combination of step 14 and step 18.
  350. if (scope_body) {
  351. // NOTE: Nothing in the callback throws an exception.
  352. MUST(scope_body->for_each_var_function_declaration_in_reverse_order([&](FunctionDeclaration const& function) {
  353. if (function_names.set(function.name()) == AK::HashSetResult::InsertedNewEntry)
  354. functions_to_initialize.append(function);
  355. }));
  356. auto const& arguments_name = vm.names.arguments.as_string();
  357. if (!has_parameter_expressions && function_names.contains(arguments_name))
  358. arguments_object_needed = false;
  359. if (!has_parameter_expressions && arguments_object_needed) {
  360. // NOTE: Nothing in the callback throws an exception.
  361. MUST(scope_body->for_each_lexically_declared_identifier([&](auto const& identifier) {
  362. if (identifier.string() == arguments_name)
  363. arguments_object_needed = false;
  364. }));
  365. }
  366. } else {
  367. arguments_object_needed = false;
  368. }
  369. GCPtr<Environment> environment;
  370. // 19. If strict is true or hasParameterExpressions is false, then
  371. if (strict || !has_parameter_expressions) {
  372. // a. NOTE: Only a single Environment Record is needed for the parameters, since calls to eval in strict mode code cannot create new bindings which are visible outside of the eval.
  373. // b. Let env be the LexicalEnvironment of calleeContext.
  374. environment = callee_context.lexical_environment;
  375. }
  376. // 20. Else,
  377. else {
  378. // a. NOTE: A separate Environment Record is needed to ensure that bindings created by direct eval calls in the formal parameter list are outside the environment where parameters are declared.
  379. // b. Let calleeEnv be the LexicalEnvironment of calleeContext.
  380. auto callee_env = callee_context.lexical_environment;
  381. // c. Let env be NewDeclarativeEnvironment(calleeEnv).
  382. environment = new_declarative_environment(*callee_env);
  383. // d. Assert: The VariableEnvironment of calleeContext is calleeEnv.
  384. VERIFY(callee_context.variable_environment == callee_context.lexical_environment);
  385. // e. Set the LexicalEnvironment of calleeContext to env.
  386. callee_context.lexical_environment = environment;
  387. }
  388. // 21. For each String paramName of parameterNames, do
  389. for (auto const& parameter_name : parameter_names) {
  390. // a. Let alreadyDeclared be ! env.HasBinding(paramName).
  391. auto already_declared = MUST(environment->has_binding(parameter_name));
  392. // b. NOTE: Early errors ensure that duplicate parameter names can only occur in non-strict functions that do not have parameter default values or rest parameters.
  393. // c. If alreadyDeclared is false, then
  394. if (!already_declared) {
  395. // i. Perform ! env.CreateMutableBinding(paramName, false).
  396. MUST(environment->create_mutable_binding(vm, parameter_name, false));
  397. // ii. If hasDuplicates is true, then
  398. if (has_duplicates) {
  399. // 1. Perform ! env.InitializeBinding(paramName, undefined).
  400. MUST(environment->initialize_binding(vm, parameter_name, js_undefined(), Environment::InitializeBindingHint::Normal));
  401. }
  402. }
  403. }
  404. // 22. If argumentsObjectNeeded is true, then
  405. if (arguments_object_needed) {
  406. Object* arguments_object;
  407. // a. If strict is true or simpleParameterList is false, then
  408. if (strict || !simple_parameter_list) {
  409. // i. Let ao be CreateUnmappedArgumentsObject(argumentsList).
  410. arguments_object = create_unmapped_arguments_object(vm, vm.running_execution_context().arguments);
  411. }
  412. // b. Else,
  413. else {
  414. // i. NOTE: A mapped argument object is only provided for non-strict functions that don't have a rest parameter, any parameter default value initializers, or any destructured parameters.
  415. // ii. Let ao be CreateMappedArgumentsObject(func, formals, argumentsList, env).
  416. arguments_object = create_mapped_arguments_object(vm, *this, formal_parameters(), vm.running_execution_context().arguments, *environment);
  417. }
  418. // c. If strict is true, then
  419. if (strict) {
  420. // i. Perform ! env.CreateImmutableBinding("arguments", false).
  421. MUST(environment->create_immutable_binding(vm, vm.names.arguments.as_string(), false));
  422. // ii. NOTE: In strict mode code early errors prevent attempting to assign to this binding, so its mutability is not observable.
  423. }
  424. // b. Else,
  425. else {
  426. // i. Perform ! env.CreateMutableBinding("arguments", false).
  427. MUST(environment->create_mutable_binding(vm, vm.names.arguments.as_string(), false));
  428. }
  429. // c. Perform ! env.InitializeBinding("arguments", ao).
  430. MUST(environment->initialize_binding(vm, vm.names.arguments.as_string(), arguments_object, Environment::InitializeBindingHint::Normal));
  431. // f. Let parameterBindings be the list-concatenation of parameterNames and « "arguments" ».
  432. parameter_names.set(vm.names.arguments.as_string());
  433. }
  434. // 23. Else,
  435. else {
  436. // a. Let parameterBindings be parameterNames.
  437. }
  438. // NOTE: We now treat parameterBindings as parameterNames.
  439. // 24. Let iteratorRecord be CreateListIteratorRecord(argumentsList).
  440. // 25. If hasDuplicates is true, then
  441. // a. Perform ? IteratorBindingInitialization of formals with arguments iteratorRecord and undefined.
  442. // 26. Else,
  443. // a. Perform ? IteratorBindingInitialization of formals with arguments iteratorRecord and env.
  444. // NOTE: The spec makes an iterator here to do IteratorBindingInitialization but we just do it manually
  445. auto& execution_context_arguments = vm.running_execution_context().arguments;
  446. size_t default_parameter_index = 0;
  447. for (size_t i = 0; i < m_formal_parameters.size(); ++i) {
  448. auto& parameter = m_formal_parameters[i];
  449. if (parameter.default_value)
  450. ++default_parameter_index;
  451. TRY(parameter.binding.visit(
  452. [&](auto const& param) -> ThrowCompletionOr<void> {
  453. Value argument_value;
  454. if (parameter.is_rest) {
  455. auto array = MUST(Array::create(realm, 0));
  456. for (size_t rest_index = i; rest_index < execution_context_arguments.size(); ++rest_index)
  457. array->indexed_properties().append(execution_context_arguments[rest_index]);
  458. argument_value = array;
  459. } else if (i < execution_context_arguments.size() && !execution_context_arguments[i].is_undefined()) {
  460. argument_value = execution_context_arguments[i];
  461. } else if (parameter.default_value) {
  462. auto value_and_frame = vm.bytecode_interpreter().run_and_return_frame(realm, *m_default_parameter_bytecode_executables[default_parameter_index - 1], nullptr);
  463. if (value_and_frame.value.is_error())
  464. return value_and_frame.value.release_error();
  465. // Resulting value is in the accumulator.
  466. argument_value = value_and_frame.frame->registers.at(0);
  467. } else {
  468. argument_value = js_undefined();
  469. }
  470. Environment* used_environment = has_duplicates ? nullptr : environment;
  471. if constexpr (IsSame<NonnullRefPtr<Identifier const> const&, decltype(param)>) {
  472. if (param->is_local()) {
  473. callee_context.local_variables[param->local_variable_index()] = argument_value;
  474. return {};
  475. }
  476. Reference reference = TRY(vm.resolve_binding(param->string(), used_environment));
  477. // Here the difference from hasDuplicates is important
  478. if (has_duplicates)
  479. return reference.put_value(vm, argument_value);
  480. return reference.initialize_referenced_binding(vm, argument_value);
  481. }
  482. if constexpr (IsSame<NonnullRefPtr<BindingPattern const> const&, decltype(param)>) {
  483. // Here the difference from hasDuplicates is important
  484. return vm.binding_initialization(param, argument_value, used_environment);
  485. }
  486. }));
  487. }
  488. GCPtr<Environment> var_environment;
  489. HashTable<DeprecatedFlyString> instantiated_var_names;
  490. if (scope_body)
  491. instantiated_var_names.ensure_capacity(scope_body->var_declaration_count());
  492. // 27. If hasParameterExpressions is false, then
  493. if (!has_parameter_expressions) {
  494. // a. NOTE: Only a single Environment Record is needed for the parameters and top-level vars.
  495. // b. Let instantiatedVarNames be a copy of the List parameterBindings.
  496. // NOTE: Done in implementation of step 27.c.i.1 below
  497. if (scope_body) {
  498. // NOTE: Due to the use of MUST with `create_mutable_binding` and `initialize_binding` below,
  499. // an exception should not result from `for_each_var_declared_name`.
  500. // c. For each element n of varNames, do
  501. MUST(scope_body->for_each_var_declared_identifier([&](auto const& id) {
  502. // i. If instantiatedVarNames does not contain n, then
  503. if (!parameter_names.contains(id.string()) && instantiated_var_names.set(id.string()) == AK::HashSetResult::InsertedNewEntry) {
  504. // 1. Append n to instantiatedVarNames.
  505. // 2. Perform ! env.CreateMutableBinding(n, false).
  506. // 3. Perform ! env.InitializeBinding(n, undefined).
  507. if (id.is_local()) {
  508. callee_context.local_variables[id.local_variable_index()] = js_undefined();
  509. } else {
  510. MUST(environment->create_mutable_binding(vm, id.string(), false));
  511. MUST(environment->initialize_binding(vm, id.string(), js_undefined(), Environment::InitializeBindingHint::Normal));
  512. }
  513. }
  514. }));
  515. }
  516. // d.Let varEnv be env
  517. var_environment = environment;
  518. }
  519. // 28. Else,
  520. else {
  521. // a. NOTE: A separate Environment Record is needed to ensure that closures created by expressions in the formal parameter list do not have visibility of declarations in the function body.
  522. // b. Let varEnv be NewDeclarativeEnvironment(env).
  523. var_environment = new_declarative_environment(*environment);
  524. // c. Set the VariableEnvironment of calleeContext to varEnv.
  525. callee_context.variable_environment = var_environment;
  526. // d. Let instantiatedVarNames be a new empty List.
  527. // NOTE: Already done above.
  528. if (scope_body) {
  529. // NOTE: Due to the use of MUST with `create_mutable_binding`, `get_binding_value` and `initialize_binding` below,
  530. // an exception should not result from `for_each_var_declared_name`.
  531. // e. For each element n of varNames, do
  532. MUST(scope_body->for_each_var_declared_identifier([&](auto const& id) {
  533. // i. If instantiatedVarNames does not contain n, then
  534. if (instantiated_var_names.set(id.string()) == AK::HashSetResult::InsertedNewEntry) {
  535. // 1. Append n to instantiatedVarNames.
  536. // 2. Perform ! varEnv.CreateMutableBinding(n, false).
  537. MUST(var_environment->create_mutable_binding(vm, id.string(), false));
  538. Value initial_value;
  539. // 3. If parameterBindings does not contain n, or if functionNames contains n, then
  540. if (!parameter_names.contains(id.string()) || function_names.contains(id.string())) {
  541. // a. Let initialValue be undefined.
  542. initial_value = js_undefined();
  543. }
  544. // 4. Else,
  545. else {
  546. // a. Let initialValue be ! env.GetBindingValue(n, false).
  547. initial_value = MUST(environment->get_binding_value(vm, id.string(), false));
  548. }
  549. // 5. Perform ! varEnv.InitializeBinding(n, initialValue).
  550. if (id.is_local()) {
  551. // NOTE: Local variables are supported only in bytecode interpreter
  552. callee_context.local_variables[id.local_variable_index()] = initial_value;
  553. } else {
  554. MUST(var_environment->initialize_binding(vm, id.string(), initial_value, Environment::InitializeBindingHint::Normal));
  555. }
  556. // 6. NOTE: A var with the same name as a formal parameter initially has the same value as the corresponding initialized parameter.
  557. }
  558. }));
  559. }
  560. }
  561. // 29. NOTE: Annex B.3.2.1 adds additional steps at this point.
  562. // B.3.2.1 Changes to FunctionDeclarationInstantiation, https://tc39.es/ecma262/#sec-web-compat-functiondeclarationinstantiation
  563. if (!strict && scope_body) {
  564. // NOTE: Due to the use of MUST with `create_mutable_binding` and `initialize_binding` below,
  565. // an exception should not result from `for_each_function_hoistable_with_annexB_extension`.
  566. MUST(scope_body->for_each_function_hoistable_with_annexB_extension([&](FunctionDeclaration& function_declaration) {
  567. auto function_name = function_declaration.name();
  568. if (parameter_names.contains(function_name))
  569. return;
  570. // The spec says 'initializedBindings' here but that does not exist and it then adds it to 'instantiatedVarNames' so it probably means 'instantiatedVarNames'.
  571. if (!instantiated_var_names.contains(function_name) && function_name != vm.names.arguments.as_string()) {
  572. MUST(var_environment->create_mutable_binding(vm, function_name, false));
  573. MUST(var_environment->initialize_binding(vm, function_name, js_undefined(), Environment::InitializeBindingHint::Normal));
  574. instantiated_var_names.set(function_name);
  575. }
  576. function_declaration.set_should_do_additional_annexB_steps();
  577. }));
  578. }
  579. GCPtr<Environment> lex_environment;
  580. // 30. If strict is false, then
  581. if (!strict) {
  582. // Optimization: We avoid creating empty top-level declarative environments in non-strict mode, if both of these conditions are true:
  583. // 1. there is no direct call to eval() within this function
  584. // 2. there are no lexical declarations that would go into the environment
  585. bool can_elide_declarative_environment = !m_contains_direct_call_to_eval && (!scope_body || !scope_body->has_lexical_declarations());
  586. if (can_elide_declarative_environment) {
  587. lex_environment = var_environment;
  588. } else {
  589. // a. Let lexEnv be NewDeclarativeEnvironment(varEnv).
  590. // b. NOTE: Non-strict functions use a separate Environment Record for top-level lexical declarations so that a direct eval
  591. // can determine whether any var scoped declarations introduced by the eval code conflict with pre-existing top-level
  592. // lexically scoped declarations. This is not needed for strict functions because a strict direct eval always places
  593. // all declarations into a new Environment Record.
  594. lex_environment = new_declarative_environment(*var_environment);
  595. }
  596. }
  597. // 31. Else,
  598. else {
  599. // a. let lexEnv be varEnv.
  600. lex_environment = var_environment;
  601. }
  602. // 32. Set the LexicalEnvironment of calleeContext to lexEnv.
  603. callee_context.lexical_environment = lex_environment;
  604. if (!scope_body)
  605. return {};
  606. // 33. Let lexDeclarations be the LexicallyScopedDeclarations of code.
  607. // 34. For each element d of lexDeclarations, do
  608. // NOTE: Due to the use of MUST in the callback, an exception should not result from `for_each_lexically_scoped_declaration`.
  609. MUST(scope_body->for_each_lexically_scoped_declaration([&](Declaration const& declaration) {
  610. // NOTE: Due to the use of MUST with `create_immutable_binding` and `create_mutable_binding` below,
  611. // an exception should not result from `for_each_bound_name`.
  612. // a. NOTE: A lexically declared name cannot be the same as a function/generator declaration, formal parameter, or a var name. Lexically declared names are only instantiated here but not initialized.
  613. // b. For each element dn of the BoundNames of d, do
  614. MUST(declaration.for_each_bound_identifier([&](auto const& id) {
  615. if (id.is_local()) {
  616. // NOTE: Local variables are supported only in bytecode interpreter
  617. return;
  618. }
  619. // i. If IsConstantDeclaration of d is true, then
  620. if (declaration.is_constant_declaration()) {
  621. // 1. Perform ! lexEnv.CreateImmutableBinding(dn, true).
  622. MUST(lex_environment->create_immutable_binding(vm, id.string(), true));
  623. }
  624. // ii. Else,
  625. else {
  626. // 1. Perform ! lexEnv.CreateMutableBinding(dn, false).
  627. MUST(lex_environment->create_mutable_binding(vm, id.string(), false));
  628. }
  629. }));
  630. }));
  631. // 35. Let privateEnv be the PrivateEnvironment of calleeContext.
  632. auto private_environment = callee_context.private_environment;
  633. // 36. For each Parse Node f of functionsToInitialize, do
  634. for (auto& declaration : functions_to_initialize) {
  635. // a. Let fn be the sole element of the BoundNames of f.
  636. // b. Let fo be InstantiateFunctionObject of f with arguments lexEnv and privateEnv.
  637. auto function = ECMAScriptFunctionObject::create(realm, declaration.name(), declaration.source_text(), declaration.body(), declaration.parameters(), declaration.function_length(), declaration.local_variables_names(), lex_environment, private_environment, declaration.kind(), declaration.is_strict_mode(), declaration.might_need_arguments_object(), declaration.contains_direct_call_to_eval());
  638. // c. Perform ! varEnv.SetMutableBinding(fn, fo, false).
  639. if (declaration.name_identifier()->is_local()) {
  640. callee_context.local_variables[declaration.name_identifier()->local_variable_index()] = function;
  641. } else {
  642. MUST(var_environment->set_mutable_binding(vm, declaration.name(), function, false));
  643. }
  644. }
  645. if (is<DeclarativeEnvironment>(*lex_environment))
  646. static_cast<DeclarativeEnvironment*>(lex_environment.ptr())->shrink_to_fit();
  647. if (is<DeclarativeEnvironment>(*var_environment))
  648. static_cast<DeclarativeEnvironment*>(var_environment.ptr())->shrink_to_fit();
  649. // 37. Return unused.
  650. return {};
  651. }
  652. // 10.2.1.1 PrepareForOrdinaryCall ( F, newTarget ), https://tc39.es/ecma262/#sec-prepareforordinarycall
  653. ThrowCompletionOr<void> ECMAScriptFunctionObject::prepare_for_ordinary_call(ExecutionContext& callee_context, Object* new_target)
  654. {
  655. auto& vm = this->vm();
  656. // Non-standard
  657. callee_context.is_strict_mode = m_strict;
  658. // 1. Let callerContext be the running execution context.
  659. // 2. Let calleeContext be a new ECMAScript code execution context.
  660. // NOTE: In the specification, PrepareForOrdinaryCall "returns" a new callee execution context.
  661. // To avoid heap allocations, we put our ExecutionContext objects on the C++ stack instead.
  662. // Whoever calls us should put an ExecutionContext on their stack and pass that as the `callee_context`.
  663. // 3. Set the Function of calleeContext to F.
  664. callee_context.function = this;
  665. callee_context.function_name = m_name;
  666. // 4. Let calleeRealm be F.[[Realm]].
  667. auto callee_realm = m_realm;
  668. // NOTE: This non-standard fallback is needed until we can guarantee that literally
  669. // every function has a realm - especially in LibWeb that's sometimes not the case
  670. // when a function is created while no JS is running, as we currently need to rely on
  671. // that (:acid2:, I know - see set_event_handler_attribute() for an example).
  672. // If there's no 'current realm' either, we can't continue and crash.
  673. if (!callee_realm)
  674. callee_realm = vm.current_realm();
  675. VERIFY(callee_realm);
  676. // 5. Set the Realm of calleeContext to calleeRealm.
  677. callee_context.realm = callee_realm;
  678. // 6. Set the ScriptOrModule of calleeContext to F.[[ScriptOrModule]].
  679. callee_context.script_or_module = m_script_or_module;
  680. // 7. Let localEnv be NewFunctionEnvironment(F, newTarget).
  681. auto local_environment = new_function_environment(*this, new_target);
  682. // 8. Set the LexicalEnvironment of calleeContext to localEnv.
  683. callee_context.lexical_environment = local_environment;
  684. // 9. Set the VariableEnvironment of calleeContext to localEnv.
  685. callee_context.variable_environment = local_environment;
  686. // 10. Set the PrivateEnvironment of calleeContext to F.[[PrivateEnvironment]].
  687. callee_context.private_environment = m_private_environment;
  688. // 11. If callerContext is not already suspended, suspend callerContext.
  689. // FIXME: We don't have this concept yet.
  690. // 12. Push calleeContext onto the execution context stack; calleeContext is now the running execution context.
  691. TRY(vm.push_execution_context(callee_context, {}));
  692. // 13. NOTE: Any exception objects produced after this point are associated with calleeRealm.
  693. // 14. Return calleeContext.
  694. // NOTE: See the comment after step 2 above about how contexts are allocated on the C++ stack.
  695. return {};
  696. }
  697. // 10.2.1.2 OrdinaryCallBindThis ( F, calleeContext, thisArgument ), https://tc39.es/ecma262/#sec-ordinarycallbindthis
  698. void ECMAScriptFunctionObject::ordinary_call_bind_this(ExecutionContext& callee_context, Value this_argument)
  699. {
  700. auto& vm = this->vm();
  701. // 1. Let thisMode be F.[[ThisMode]].
  702. auto this_mode = m_this_mode;
  703. // If thisMode is lexical, return unused.
  704. if (this_mode == ThisMode::Lexical)
  705. return;
  706. // 3. Let calleeRealm be F.[[Realm]].
  707. auto callee_realm = m_realm;
  708. // NOTE: This non-standard fallback is needed until we can guarantee that literally
  709. // every function has a realm - especially in LibWeb that's sometimes not the case
  710. // when a function is created while no JS is running, as we currently need to rely on
  711. // that (:acid2:, I know - see set_event_handler_attribute() for an example).
  712. // If there's no 'current realm' either, we can't continue and crash.
  713. if (!callee_realm)
  714. callee_realm = vm.current_realm();
  715. VERIFY(callee_realm);
  716. // 4. Let localEnv be the LexicalEnvironment of calleeContext.
  717. auto local_env = callee_context.lexical_environment;
  718. Value this_value;
  719. // 5. If thisMode is strict, let thisValue be thisArgument.
  720. if (this_mode == ThisMode::Strict) {
  721. this_value = this_argument;
  722. }
  723. // 6. Else,
  724. else {
  725. // a. If thisArgument is undefined or null, then
  726. if (this_argument.is_nullish()) {
  727. // i. Let globalEnv be calleeRealm.[[GlobalEnv]].
  728. // ii. Assert: globalEnv is a global Environment Record.
  729. auto& global_env = callee_realm->global_environment();
  730. // iii. Let thisValue be globalEnv.[[GlobalThisValue]].
  731. this_value = &global_env.global_this_value();
  732. }
  733. // b. Else,
  734. else {
  735. // i. Let thisValue be ! ToObject(thisArgument).
  736. this_value = MUST(this_argument.to_object(vm));
  737. // ii. NOTE: ToObject produces wrapper objects using calleeRealm.
  738. VERIFY(vm.current_realm() == callee_realm);
  739. }
  740. }
  741. // 7. Assert: localEnv is a function Environment Record.
  742. // 8. Assert: The next step never returns an abrupt completion because localEnv.[[ThisBindingStatus]] is not initialized.
  743. // 9. Perform ! localEnv.BindThisValue(thisValue).
  744. MUST(verify_cast<FunctionEnvironment>(*local_env).bind_this_value(vm, this_value));
  745. // 10. Return unused.
  746. }
  747. // 27.7.5.1 AsyncFunctionStart ( promiseCapability, asyncFunctionBody ), https://tc39.es/ecma262/#sec-async-functions-abstract-operations-async-function-start
  748. template<typename T>
  749. void async_function_start(VM& vm, PromiseCapability const& promise_capability, T const& async_function_body)
  750. {
  751. // 1. Let runningContext be the running execution context.
  752. auto& running_context = vm.running_execution_context();
  753. // 2. Let asyncContext be a copy of runningContext.
  754. auto async_context = running_context.copy();
  755. // 3. NOTE: Copying the execution state is required for AsyncBlockStart to resume its execution. It is ill-defined to resume a currently executing context.
  756. // 4. Perform AsyncBlockStart(promiseCapability, asyncFunctionBody, asyncContext).
  757. async_block_start(vm, async_function_body, promise_capability, async_context);
  758. // 5. Return unused.
  759. }
  760. // 27.7.5.2 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/ecma262/#sec-asyncblockstart
  761. // 12.7.1.1 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/proposal-explicit-resource-management/#sec-asyncblockstart
  762. // 1.2.1.1 AsyncBlockStart ( promiseCapability, asyncBody, asyncContext ), https://tc39.es/proposal-array-from-async/#sec-asyncblockstart
  763. template<typename T>
  764. void async_block_start(VM& vm, T const& async_body, PromiseCapability const& promise_capability, ExecutionContext& async_context)
  765. {
  766. // NOTE: This function is a combination between two proposals, so does not exactly match spec steps of either.
  767. auto& realm = *vm.current_realm();
  768. // 1. Assert: promiseCapability is a PromiseCapability Record.
  769. // 2. Let runningContext be the running execution context.
  770. auto& running_context = vm.running_execution_context();
  771. // 3. Set the code evaluation state of asyncContext such that when evaluation is resumed for that execution context the following steps will be performed:
  772. auto execution_steps = NativeFunction::create(realm, "", [&realm, &async_body, &promise_capability, &async_context](auto& vm) -> ThrowCompletionOr<Value> {
  773. Completion result;
  774. // a. If asyncBody is a Parse Node, then
  775. if constexpr (!IsCallableWithArguments<T, Completion>) {
  776. // a. Let result be the result of evaluating asyncBody.
  777. // FIXME: Cache this executable somewhere.
  778. auto maybe_executable = Bytecode::compile(vm, async_body, FunctionKind::Async, "AsyncBlockStart"sv);
  779. if (maybe_executable.is_error())
  780. result = maybe_executable.release_error();
  781. else
  782. result = vm.bytecode_interpreter().run_and_return_frame(realm, *maybe_executable.value(), nullptr).value;
  783. }
  784. // b. Else,
  785. else {
  786. (void)realm;
  787. // i. Assert: asyncBody is an Abstract Closure with no parameters.
  788. static_assert(IsCallableWithArguments<T, Completion>);
  789. // ii. Let result be asyncBody().
  790. result = async_body();
  791. }
  792. // c. Assert: If we return here, the async function either threw an exception or performed an implicit or explicit return; all awaiting is done.
  793. // d. Remove asyncContext from the execution context stack and restore the execution context that is at the top of the execution context stack as the running execution context.
  794. vm.pop_execution_context();
  795. // NOTE: This does not work for Array.fromAsync, likely due to conflicts between that proposal and Explicit Resource Management proposal.
  796. if constexpr (!IsCallableWithArguments<T, Completion>) {
  797. // e. Let env be asyncContext's LexicalEnvironment.
  798. auto env = async_context.lexical_environment;
  799. // f. Set result to DisposeResources(env, result).
  800. result = dispose_resources(vm, verify_cast<DeclarativeEnvironment>(env.ptr()), result);
  801. } else {
  802. (void)async_context;
  803. }
  804. // g. If result.[[Type]] is normal, then
  805. if (result.type() == Completion::Type::Normal) {
  806. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « undefined »).
  807. MUST(call(vm, *promise_capability.resolve(), js_undefined(), js_undefined()));
  808. }
  809. // h. Else if result.[[Type]] is return, then
  810. else if (result.type() == Completion::Type::Return) {
  811. // i. Perform ! Call(promiseCapability.[[Resolve]], undefined, « result.[[Value]] »).
  812. MUST(call(vm, *promise_capability.resolve(), js_undefined(), *result.value()));
  813. }
  814. // i. Else,
  815. else {
  816. // i. Assert: result.[[Type]] is throw.
  817. VERIFY(result.type() == Completion::Type::Throw);
  818. // ii. Perform ! Call(promiseCapability.[[Reject]], undefined, « result.[[Value]] »).
  819. MUST(call(vm, *promise_capability.reject(), js_undefined(), *result.value()));
  820. }
  821. // j. Return unused.
  822. // NOTE: We don't support returning an empty/optional/unused value here.
  823. return js_undefined();
  824. });
  825. // 4. Push asyncContext onto the execution context stack; asyncContext is now the running execution context.
  826. auto push_result = vm.push_execution_context(async_context, {});
  827. if (push_result.is_error())
  828. return;
  829. // 5. Resume the suspended evaluation of asyncContext. Let result be the value returned by the resumed computation.
  830. auto result = call(vm, *execution_steps, async_context.this_value.is_empty() ? js_undefined() : async_context.this_value);
  831. // 6. Assert: When we return here, asyncContext has already been removed from the execution context stack and runningContext is the currently running execution context.
  832. VERIFY(&vm.running_execution_context() == &running_context);
  833. // 7. Assert: result is a normal completion with a value of unused. The possible sources of this value are Await or, if the async function doesn't await anything, step 3.g above.
  834. VERIFY(result.has_value() && result.value().is_undefined());
  835. // 8. Return unused.
  836. }
  837. template void async_block_start(VM&, NonnullRefPtr<Statement const> const& async_body, PromiseCapability const&, ExecutionContext&);
  838. template void async_function_start(VM&, PromiseCapability const&, NonnullRefPtr<Statement const> const& async_function_body);
  839. template void async_block_start(VM&, SafeFunction<Completion()> const& async_body, PromiseCapability const&, ExecutionContext&);
  840. template void async_function_start(VM&, PromiseCapability const&, SafeFunction<Completion()> const& async_function_body);
  841. // 10.2.1.4 OrdinaryCallEvaluateBody ( F, argumentsList ), https://tc39.es/ecma262/#sec-ordinarycallevaluatebody
  842. // 15.8.4 Runtime Semantics: EvaluateAsyncFunctionBody, https://tc39.es/ecma262/#sec-runtime-semantics-evaluatefunctionbody
  843. Completion ECMAScriptFunctionObject::ordinary_call_evaluate_body()
  844. {
  845. auto& vm = this->vm();
  846. auto& realm = *vm.current_realm();
  847. // NOTE: There's a subtle ordering issue here:
  848. // - We have to compile the default parameter values before instantiating the function.
  849. // - We have to instantiate the function before compiling the function body.
  850. // This is why FunctionDeclarationInstantiation is invoked in the middle.
  851. // The issue is that FunctionDeclarationInstantiation may mark certain functions as hoisted
  852. // per Annex B. This affects code generation for FunctionDeclaration nodes.
  853. if (!m_bytecode_executable) {
  854. size_t default_parameter_index = 0;
  855. for (auto& parameter : m_formal_parameters) {
  856. if (!parameter.default_value)
  857. continue;
  858. auto executable = TRY(Bytecode::compile(vm, *parameter.default_value, FunctionKind::Normal, DeprecatedString::formatted("default parameter #{} for {}", default_parameter_index, m_name)));
  859. m_default_parameter_bytecode_executables.append(move(executable));
  860. }
  861. }
  862. auto declaration_result = function_declaration_instantiation();
  863. if (m_kind == FunctionKind::Normal || m_kind == FunctionKind::Generator || m_kind == FunctionKind::AsyncGenerator) {
  864. if (declaration_result.is_error())
  865. return declaration_result.release_error();
  866. }
  867. if (!m_bytecode_executable)
  868. m_bytecode_executable = TRY(Bytecode::compile(vm, *m_ecmascript_code, m_kind, m_name));
  869. if (m_kind == FunctionKind::Async) {
  870. if (declaration_result.is_throw_completion()) {
  871. auto promise_capability = MUST(new_promise_capability(vm, realm.intrinsics().promise_constructor()));
  872. MUST(call(vm, *promise_capability->reject(), js_undefined(), *declaration_result.throw_completion().value()));
  873. return Completion { Completion::Type::Return, promise_capability->promise(), {} };
  874. }
  875. }
  876. auto result_and_frame = vm.bytecode_interpreter().run_and_return_frame(realm, *m_bytecode_executable, nullptr);
  877. VERIFY(result_and_frame.frame != nullptr);
  878. if (result_and_frame.value.is_error())
  879. return result_and_frame.value.release_error();
  880. auto result = result_and_frame.value.release_value();
  881. // NOTE: Running the bytecode should eventually return a completion.
  882. // Until it does, we assume "return" and include the undefined fallback from the call site.
  883. if (m_kind == FunctionKind::Normal)
  884. return { Completion::Type::Return, result.value_or(js_undefined()), {} };
  885. if (m_kind == FunctionKind::AsyncGenerator) {
  886. auto async_generator_object = TRY(AsyncGenerator::create(realm, result, this, vm.running_execution_context().copy(), move(*result_and_frame.frame)));
  887. return { Completion::Type::Return, async_generator_object, {} };
  888. }
  889. auto generator_object = TRY(GeneratorObject::create(realm, result, this, vm.running_execution_context().copy(), move(*result_and_frame.frame)));
  890. // NOTE: Async functions are entirely transformed to generator functions, and wrapped in a custom driver that returns a promise
  891. // See AwaitExpression::generate_bytecode() for the transformation.
  892. if (m_kind == FunctionKind::Async)
  893. return { Completion::Type::Return, AsyncFunctionDriverWrapper::create(realm, generator_object), {} };
  894. VERIFY(m_kind == FunctionKind::Generator);
  895. return { Completion::Type::Return, generator_object, {} };
  896. }
  897. void ECMAScriptFunctionObject::set_name(DeprecatedFlyString const& name)
  898. {
  899. VERIFY(!name.is_null());
  900. auto& vm = this->vm();
  901. m_name = name;
  902. MUST(define_property_or_throw(vm.names.name, { .value = PrimitiveString::create(vm, m_name), .writable = false, .enumerable = false, .configurable = true }));
  903. }
  904. }