ladybird/Libraries/LibJS/Runtime/ReflectObject.cpp
Linus Groh 9ea6ef4ed1 LibJS: Make Interpreter::throw_exception() a void function
The motivation for this change is twofold:

- Returning a JS::Value is misleading as one would expect it to carry
  some meaningful information, like maybe the error object that's being
  created, but in fact it is always empty. Supposedly to serve as a
  shortcut for the common case of "throw and return empty value", but
  that's just leading us to my second point.
- Inconsistent usage / coding style: as of this commit there are 114
  uses of throw_exception() discarding its return value and 55 uses
  directly returning the call result (in LibJS, not counting LibWeb);
  with the first style often having a more explicit empty value (or
  nullptr in some cases) return anyway.
  One more line to always make the return value obvious is should be
  worth it.

So now it's basically always these steps, which is already being used in
the majority of cases (as outlined above):

- Throw an exception. This mutates interpreter state by updating
  m_exception and unwinding, but doesn't return anything.
- Let the caller explicitly return an empty value, nullptr or anything
  else itself.
2020-08-25 18:30:31 +02:00

280 lines
10 KiB
C++

/*
* Copyright (c) 2020, Linus Groh <mail@linusgroh.de>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <AK/Function.h>
#include <LibJS/Interpreter.h>
#include <LibJS/Runtime/Error.h>
#include <LibJS/Runtime/Function.h>
#include <LibJS/Runtime/GlobalObject.h>
#include <LibJS/Runtime/NativeFunction.h>
#include <LibJS/Runtime/ReflectObject.h>
namespace JS {
static Object* get_target_object_from(Interpreter& interpreter, const String& name)
{
auto target = interpreter.argument(0);
if (!target.is_object()) {
interpreter.throw_exception<TypeError>(ErrorType::ReflectArgumentMustBeAnObject, name.characters());
return nullptr;
}
return static_cast<Object*>(&target.as_object());
}
static Function* get_target_function_from(Interpreter& interpreter, const String& name)
{
auto target = interpreter.argument(0);
if (!target.is_function()) {
interpreter.throw_exception<TypeError>(ErrorType::ReflectArgumentMustBeAFunction, name.characters());
return nullptr;
}
return &target.as_function();
}
static void prepare_arguments_list(Interpreter& interpreter, Value value, MarkedValueList* arguments)
{
if (!value.is_object()) {
interpreter.throw_exception<TypeError>(ErrorType::ReflectBadArgumentsList);
return;
}
auto& arguments_list = value.as_object();
auto length_property = arguments_list.get("length");
if (interpreter.exception())
return;
auto length = length_property.to_size_t(interpreter);
if (interpreter.exception())
return;
for (size_t i = 0; i < length; ++i) {
auto element = arguments_list.get(String::number(i));
if (interpreter.exception())
return;
arguments->append(element.value_or(js_undefined()));
}
}
ReflectObject::ReflectObject(GlobalObject& global_object)
: Object(*global_object.object_prototype())
{
}
void ReflectObject::initialize(GlobalObject& global_object)
{
Object::initialize(global_object);
u8 attr = Attribute::Writable | Attribute::Configurable;
define_native_function("apply", apply, 3, attr);
define_native_function("construct", construct, 2, attr);
define_native_function("defineProperty", define_property, 3, attr);
define_native_function("deleteProperty", delete_property, 2, attr);
define_native_function("get", get, 2, attr);
define_native_function("getOwnPropertyDescriptor", get_own_property_descriptor, 2, attr);
define_native_function("getPrototypeOf", get_prototype_of, 1, attr);
define_native_function("has", has, 2, attr);
define_native_function("isExtensible", is_extensible, 1, attr);
define_native_function("ownKeys", own_keys, 1, attr);
define_native_function("preventExtensions", prevent_extensions, 1, attr);
define_native_function("set", set, 3, attr);
define_native_function("setPrototypeOf", set_prototype_of, 2, attr);
}
ReflectObject::~ReflectObject()
{
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::apply)
{
auto* target = get_target_function_from(interpreter, "apply");
if (!target)
return {};
auto this_arg = interpreter.argument(1);
MarkedValueList arguments(interpreter.heap());
prepare_arguments_list(interpreter, interpreter.argument(2), &arguments);
if (interpreter.exception())
return {};
return interpreter.call(*target, this_arg, move(arguments));
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::construct)
{
auto* target = get_target_function_from(interpreter, "construct");
if (!target)
return {};
MarkedValueList arguments(interpreter.heap());
prepare_arguments_list(interpreter, interpreter.argument(1), &arguments);
if (interpreter.exception())
return {};
auto* new_target = target;
if (interpreter.argument_count() > 2) {
auto new_target_value = interpreter.argument(2);
if (!new_target_value.is_function()
|| (new_target_value.as_object().is_native_function() && !static_cast<NativeFunction&>(new_target_value.as_object()).has_constructor())) {
interpreter.throw_exception<TypeError>(ErrorType::ReflectBadNewTarget);
return {};
}
new_target = &new_target_value.as_function();
}
return interpreter.construct(*target, *new_target, move(arguments), global_object);
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::define_property)
{
auto* target = get_target_object_from(interpreter, "defineProperty");
if (!target)
return {};
if (!interpreter.argument(2).is_object()) {
interpreter.throw_exception<TypeError>(ErrorType::ReflectBadDescriptorArgument);
return {};
}
auto property_key = StringOrSymbol::from_value(interpreter, interpreter.argument(1));
if (interpreter.exception())
return {};
auto& descriptor = interpreter.argument(2).as_object();
auto success = target->define_property(property_key, descriptor, false);
if (interpreter.exception())
return {};
return Value(success);
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::delete_property)
{
auto* target = get_target_object_from(interpreter, "deleteProperty");
if (!target)
return {};
auto property_key = interpreter.argument(1);
auto property_name = PropertyName::from_value(interpreter, property_key);
if (interpreter.exception())
return {};
auto property_key_number = property_key.to_number(interpreter);
if (interpreter.exception())
return {};
if (property_key_number.is_finite_number()) {
auto property_key_as_double = property_key_number.as_double();
if (property_key_as_double >= 0 && (i32)property_key_as_double == property_key_as_double)
property_name = PropertyName(property_key_as_double);
}
return target->delete_property(property_name);
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::get)
{
auto* target = get_target_object_from(interpreter, "get");
if (!target)
return {};
auto property_key = PropertyName::from_value(interpreter, interpreter.argument(1));
if (interpreter.exception())
return {};
Value receiver = {};
if (interpreter.argument_count() > 2)
receiver = interpreter.argument(2);
return target->get(property_key, receiver).value_or(js_undefined());
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::get_own_property_descriptor)
{
auto* target = get_target_object_from(interpreter, "getOwnPropertyDescriptor");
if (!target)
return {};
auto property_key = PropertyName::from_value(interpreter, interpreter.argument(1));
if (interpreter.exception())
return {};
return target->get_own_property_descriptor_object(property_key);
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::get_prototype_of)
{
auto* target = get_target_object_from(interpreter, "getPrototypeOf");
if (!target)
return {};
return target->prototype();
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::has)
{
auto* target = get_target_object_from(interpreter, "has");
if (!target)
return {};
auto property_key = PropertyName::from_value(interpreter, interpreter.argument(1));
if (interpreter.exception())
return {};
return Value(target->has_property(property_key));
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::is_extensible)
{
auto* target = get_target_object_from(interpreter, "isExtensible");
if (!target)
return {};
return Value(target->is_extensible());
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::own_keys)
{
auto* target = get_target_object_from(interpreter, "ownKeys");
if (!target)
return {};
return target->get_own_properties(*target, PropertyKind::Key);
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::prevent_extensions)
{
auto* target = get_target_object_from(interpreter, "preventExtensions");
if (!target)
return {};
return Value(target->prevent_extensions());
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::set)
{
auto* target = get_target_object_from(interpreter, "set");
if (!target)
return {};
auto property_key = interpreter.argument(1).to_string(interpreter);
if (interpreter.exception())
return {};
auto value = interpreter.argument(2);
Value receiver = {};
if (interpreter.argument_count() > 3)
receiver = interpreter.argument(3);
return Value(target->put(property_key, value, receiver));
}
JS_DEFINE_NATIVE_FUNCTION(ReflectObject::set_prototype_of)
{
auto* target = get_target_object_from(interpreter, "setPrototypeOf");
if (!target)
return {};
auto prototype_value = interpreter.argument(1);
if (!prototype_value.is_object() && !prototype_value.is_null()) {
interpreter.throw_exception<TypeError>(ErrorType::ObjectPrototypeWrongType);
return {};
}
Object* prototype = nullptr;
if (!prototype_value.is_null())
prototype = const_cast<Object*>(&prototype_value.as_object());
return Value(target->set_prototype(prototype));
}
}