1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 10:47:35 +00:00

LibJS: Implement most of the Reflect object

This commit is contained in:
Linus Groh 2020-05-01 11:06:27 +01:00 committed by Andreas Kling
parent 1ba2e6768d
commit 79b829637e
22 changed files with 877 additions and 54 deletions

View file

@ -49,6 +49,7 @@
#include <LibJS/Runtime/Object.h>
#include <LibJS/Runtime/ObjectConstructor.h>
#include <LibJS/Runtime/ObjectPrototype.h>
#include <LibJS/Runtime/ReflectObject.h>
#include <LibJS/Runtime/Shape.h>
#include <LibJS/Runtime/StringConstructor.h>
#include <LibJS/Runtime/StringPrototype.h>
@ -97,6 +98,7 @@ void GlobalObject::initialize()
put("globalThis", this, attr);
put("console", heap().allocate<ConsoleObject>(), attr);
put("Math", heap().allocate<MathObject>(), attr);
put("Reflect", heap().allocate<ReflectObject>(), attr);
add_constructor("Array", m_array_constructor, *m_array_prototype);
add_constructor("Boolean", m_boolean_constructor, *m_boolean_prototype);

View file

@ -108,7 +108,7 @@ Value Object::get_own_property(const Object& this_object, const FlyString& prope
return value_here;
}
Value Object::get_enumerable_own_properties(const Object& this_object, GetOwnPropertyMode kind) const
Value Object::get_own_properties(const Object& this_object, GetOwnPropertyMode kind, u8 attributes) const
{
auto* properties_array = Array::create(interpreter().global_object());
@ -152,7 +152,7 @@ Value Object::get_enumerable_own_properties(const Object& this_object, GetOwnPro
}
for (auto& it : this_object.shape().property_table_ordered()) {
if (it.value.attributes & Attribute::Enumerable) {
if (it.value.attributes & attributes) {
size_t offset = it.value.offset + property_index;
if (kind == GetOwnPropertyMode::Key) {
@ -171,13 +171,42 @@ Value Object::get_enumerable_own_properties(const Object& this_object, GetOwnPro
return properties_array;
}
Value Object::get_own_property_descriptor(const FlyString& property_name) const
{
auto metadata = shape().lookup(property_name);
if (!metadata.has_value())
return js_undefined();
auto value = get(property_name);
if (interpreter().exception())
return {};
auto* descriptor = Object::create_empty(interpreter(), interpreter().global_object());
descriptor->put("value", value.value_or(js_undefined()));
descriptor->put("writable", Value(!!(metadata.value().attributes & Attribute::Writable)));
descriptor->put("enumerable", Value(!!(metadata.value().attributes & Attribute::Enumerable)));
descriptor->put("configurable", Value(!!(metadata.value().attributes & Attribute::Configurable)));
return descriptor;
}
void Object::set_shape(Shape& new_shape)
{
m_storage.resize(new_shape.property_count());
m_shape = &new_shape;
}
bool Object::put_own_property(Object& this_object, const FlyString& property_name, u8 attributes, Value value, PutOwnPropertyMode mode)
bool Object::define_property(const FlyString& property_name, const Object& descriptor, bool throw_exceptions)
{
auto value = descriptor.get("value");
u8 configurable = descriptor.get("configurable").value_or(Value(false)).to_boolean() * Attribute::Configurable;
u8 enumerable = descriptor.get("enumerable").value_or(Value(false)).to_boolean() * Attribute::Enumerable;
u8 writable = descriptor.get("writable").value_or(Value(false)).to_boolean() * Attribute::Writable;
u8 attributes = configurable | enumerable | writable;
dbg() << "Defining new property " << property_name << " with descriptor { " << configurable << ", " << enumerable << ", " << writable << ", attributes=" << attributes << " }";
return put_own_property(*this, property_name, attributes, value, PutOwnPropertyMode::DefineProperty, throw_exceptions);
}
bool Object::put_own_property(Object& this_object, const FlyString& property_name, u8 attributes, Value value, PutOwnPropertyMode mode, bool throw_exceptions)
{
auto metadata = shape().lookup(property_name);
bool new_property = !metadata.has_value();
@ -195,7 +224,8 @@ bool Object::put_own_property(Object& this_object, const FlyString& property_nam
if (!new_property && mode == PutOwnPropertyMode::DefineProperty && !(metadata.value().attributes & Attribute::Configurable) && attributes != metadata.value().attributes) {
dbg() << "Disallow reconfig of non-configurable property";
interpreter().throw_exception<TypeError>(String::format("Cannot redefine property '%s'", property_name.characters()));
if (throw_exceptions)
interpreter().throw_exception<TypeError>(String::format("Cannot redefine property '%s'", property_name.characters()));
return false;
}

View file

@ -46,6 +46,17 @@ public:
explicit Object(Object* prototype);
virtual ~Object();
enum class GetOwnPropertyMode {
Key,
Value,
KeyAndValue,
};
enum class PutOwnPropertyMode {
Put,
DefineProperty,
};
Shape& shape() { return *m_shape; }
const Shape& shape() const { return *m_shape; }
@ -60,20 +71,11 @@ public:
bool put(PropertyName, Value, u8 attributes = default_attributes);
Value get_own_property(const Object& this_object, const FlyString& property_name) const;
Value get_own_properties(const Object& this_object, GetOwnPropertyMode, u8 attributes = Attribute::Configurable | Attribute::Enumerable | Attribute::Writable) const;
Value get_own_property_descriptor(const FlyString& property_name) const;
enum class GetOwnPropertyMode {
Key,
Value,
KeyAndValue,
};
Value get_enumerable_own_properties(const Object& this_object, GetOwnPropertyMode) const;
enum class PutOwnPropertyMode {
Put,
DefineProperty,
};
bool put_own_property(Object& this_object, const FlyString& property_name, u8 attributes, Value, PutOwnPropertyMode);
bool define_property(const FlyString& property_name, const Object& descriptor, bool throw_exceptions = true);
bool put_own_property(Object& this_object, const FlyString& property_name, u8 attributes, Value, PutOwnPropertyMode, bool throw_exceptions = true);
bool put_native_function(const FlyString& property_name, AK::Function<Value(Interpreter&)>, i32 length = 0, u8 attribute = default_attributes);
bool put_native_property(const FlyString& property_name, AK::Function<Value(Interpreter&)> getter, AK::Function<void(Interpreter&, Value)> setter, u8 attribute = default_attributes);

View file

@ -108,47 +108,23 @@ Value ObjectConstructor::set_prototype_of(Interpreter& interpreter)
Value ObjectConstructor::get_own_property_descriptor(Interpreter& interpreter)
{
if (interpreter.argument_count() < 2)
return interpreter.throw_exception<TypeError>("Object.getOwnPropertyDescriptor() needs 2 arguments");
if (!interpreter.argument(0).is_object())
return interpreter.throw_exception<TypeError>("Object argument is not an object");
auto& object = interpreter.argument(0).as_object();
auto metadata = object.shape().lookup(interpreter.argument(1).to_string());
if (!metadata.has_value())
return js_undefined();
auto value = object.get(interpreter.argument(1).to_string()).value_or(js_undefined());
auto* object = interpreter.argument(0).to_object(interpreter.heap());
if (interpreter.exception())
return {};
auto* descriptor = Object::create_empty(interpreter, interpreter.global_object());
descriptor->put("configurable", Value(!!(metadata.value().attributes & Attribute::Configurable)));
descriptor->put("enumerable", Value(!!(metadata.value().attributes & Attribute::Enumerable)));
descriptor->put("writable", Value(!!(metadata.value().attributes & Attribute::Writable)));
descriptor->put("value", value);
return descriptor;
auto property_key = interpreter.argument(1).to_string();
return object->get_own_property_descriptor(property_key);
}
Value ObjectConstructor::define_property(Interpreter& interpreter)
{
if (interpreter.argument_count() < 3)
return interpreter.throw_exception<TypeError>("Object.defineProperty() needs 3 arguments");
if (!interpreter.argument(0).is_object())
return interpreter.throw_exception<TypeError>("Object argument is not an object");
if (!interpreter.argument(2).is_object())
return interpreter.throw_exception<TypeError>("Descriptor argument is not an object");
auto& object = interpreter.argument(0).as_object();
auto property_key = interpreter.argument(1).to_string();
auto& descriptor = interpreter.argument(2).as_object();
auto value = descriptor.get("value");
u8 configurable = descriptor.get("configurable").value_or(Value(false)).to_boolean() * Attribute::Configurable;
u8 enumerable = descriptor.get("enumerable").value_or(Value(false)).to_boolean() * Attribute::Enumerable;
u8 writable = descriptor.get("writable").value_or(Value(false)).to_boolean() * Attribute::Writable;
u8 attributes = configurable | enumerable | writable;
dbg() << "Defining new property " << interpreter.argument(1).to_string() << " with descriptor { " << configurable << ", " << enumerable << ", " << writable << ", attributes=" << attributes << " }";
object.put_own_property(object, interpreter.argument(1).to_string(), attributes, value, PutOwnPropertyMode::DefineProperty);
object.define_property(property_key, descriptor);
return &object;
}
@ -177,7 +153,7 @@ Value ObjectConstructor::keys(Interpreter& interpreter)
if (interpreter.exception())
return {};
return obj_arg->get_enumerable_own_properties(*obj_arg, GetOwnPropertyMode::Key);
return obj_arg->get_own_properties(*obj_arg, GetOwnPropertyMode::Key, Attribute::Enumerable);
}
Value ObjectConstructor::values(Interpreter& interpreter)
@ -189,7 +165,7 @@ Value ObjectConstructor::values(Interpreter& interpreter)
if (interpreter.exception())
return {};
return obj_arg->get_enumerable_own_properties(*obj_arg, GetOwnPropertyMode::Value);
return obj_arg->get_own_properties(*obj_arg, GetOwnPropertyMode::Value, Attribute::Enumerable);
}
Value ObjectConstructor::entries(Interpreter& interpreter)
@ -201,7 +177,7 @@ Value ObjectConstructor::entries(Interpreter& interpreter)
if (interpreter.exception())
return {};
return obj_arg->get_enumerable_own_properties(*obj_arg, GetOwnPropertyMode::KeyAndValue);
return obj_arg->get_own_properties(*obj_arg, GetOwnPropertyMode::KeyAndValue, Attribute::Enumerable);
}
}

View file

@ -0,0 +1,251 @@
/*
* 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>(String::format("First argument of Reflect.%s() must be an object", 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_object() || !target.as_object().is_function()) {
interpreter.throw_exception<TypeError>(String::format("First argument of Reflect.%s() must be a function", name.characters()));
return nullptr;
}
return static_cast<Function*>(&target.as_object());
}
static void prepare_arguments_list(Interpreter& interpreter, Value value, MarkedValueList* arguments)
{
if (!value.is_object()) {
interpreter.throw_exception<TypeError>("Arguments list must be an object");
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();
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()
: Object(interpreter().global_object().object_prototype())
{
u8 attr = Attribute::Writable | Attribute::Configurable;
put_native_function("apply", apply, 3, attr);
put_native_function("construct", construct, 2, attr);
put_native_function("defineProperty", define_property, 3, attr);
put_native_function("deleteProperty", delete_property, 2, attr);
put_native_function("get", get, 2, attr);
put_native_function("getOwnPropertyDescriptor", get_own_property_descriptor, 2, attr);
put_native_function("getPrototypeOf", get_prototype_of, 1, attr);
put_native_function("has", has, 2, attr);
put_native_function("isExtensible", is_extensible, 1, attr);
put_native_function("ownKeys", own_keys, 1, attr);
put_native_function("preventExtensions", prevent_extensions, 1, attr);
put_native_function("set", set, 3, attr);
put_native_function("setPrototypeOf", set_prototype_of, 2, attr);
}
ReflectObject::~ReflectObject()
{
}
Value ReflectObject::apply(Interpreter& interpreter)
{
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));
}
Value ReflectObject::construct(Interpreter& interpreter)
{
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_object()
|| !new_target_value.as_object().is_function()
|| (new_target_value.as_object().is_native_function() && !static_cast<NativeFunction&>(new_target_value.as_object()).has_constructor())) {
interpreter.throw_exception<TypeError>("Optional third argument of Reflect.construct() must be a constructor");
return {};
}
new_target = static_cast<Function*>(&new_target_value.as_object());
}
return interpreter.construct(*target, *new_target, move(arguments));
}
Value ReflectObject::define_property(Interpreter& interpreter)
{
auto* target = get_target_object_from(interpreter, "defineProperty");
if (!target)
return {};
if (!interpreter.argument(2).is_object())
return interpreter.throw_exception<TypeError>("Descriptor argument is not an object");
auto property_key = interpreter.argument(1).to_string();
auto& descriptor = interpreter.argument(2).as_object();
auto success = target->define_property(property_key, descriptor, false);
return Value(success);
}
Value ReflectObject::delete_property(Interpreter& interpreter)
{
auto* target = get_target_object_from(interpreter, "deleteProperty");
if (!target)
return {};
auto property_key = interpreter.argument(1);
PropertyName property = PropertyName(property_key.to_string());
if (property_key.to_number().is_finite_number()) {
auto property_key_as_double = property_key.to_double();
if (property_key_as_double >= 0 && (i32)property_key_as_double == property_key_as_double)
property = PropertyName(property_key_as_double);
}
return target->delete_property(property);
}
Value ReflectObject::get(Interpreter& interpreter)
{
// FIXME: There's a third argument, receiver, for getters - use it once we have those.
auto* target = get_target_object_from(interpreter, "get");
if (!target)
return {};
auto property_key = interpreter.argument(1).to_string();
return target->get(property_key).value_or(js_undefined());
}
Value ReflectObject::get_own_property_descriptor(Interpreter& interpreter)
{
auto* target = get_target_object_from(interpreter, "getOwnPropertyDescriptor");
if (!target)
return {};
auto property_key = interpreter.argument(1).to_string();
return target->get_own_property_descriptor(property_key);
}
Value ReflectObject::get_prototype_of(Interpreter& interpreter)
{
auto* target = get_target_object_from(interpreter, "getPrototypeOf");
if (!target)
return {};
return target->prototype();
}
Value ReflectObject::has(Interpreter& interpreter)
{
auto* target = get_target_object_from(interpreter, "has");
if (!target)
return {};
auto property_key = interpreter.argument(1).to_string();
return Value(target->has_property(property_key));
}
Value ReflectObject::is_extensible(Interpreter&)
{
// FIXME: For this to be useful we need one of these:
// Object.seal(), Object.freeze(), Reflect.preventExtensions()
// For now we just return true, as that's always the case.
return Value(true);
}
Value ReflectObject::own_keys(Interpreter& interpreter)
{
auto* target = get_target_object_from(interpreter, "ownKeys");
if (!target)
return {};
return target->get_own_properties(*target, GetOwnPropertyMode::Key);
}
Value ReflectObject::prevent_extensions(Interpreter&)
{
// FIXME: Implement me :^)
ASSERT_NOT_REACHED();
}
Value ReflectObject::set(Interpreter& interpreter)
{
// FIXME: There's a fourth argument, receiver, for setters - use it once we have those.
auto* target = get_target_object_from(interpreter, "set");
if (!target)
return {};
auto property_key = interpreter.argument(1).to_string();
auto value = interpreter.argument(2);
return Value(target->put(property_key, value));
}
Value ReflectObject::set_prototype_of(Interpreter& interpreter)
{
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>("Prototype must be an object or null");
return {};
}
Object* prototype = nullptr;
if (!prototype_value.is_null())
prototype = const_cast<Object*>(&prototype_value.as_object());
target->set_prototype(prototype);
// FIXME: Needs to return false for prototype chain cycles and non-extensible objects (don't have those yet).
return Value(true);
}
}

View file

@ -0,0 +1,56 @@
/*
* 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.
*/
#pragma once
#include <LibJS/Runtime/Object.h>
namespace JS {
class ReflectObject final : public Object {
public:
ReflectObject();
virtual ~ReflectObject() override;
private:
virtual const char* class_name() const override { return "ReflectObject"; }
static Value apply(Interpreter&);
static Value construct(Interpreter&);
static Value define_property(Interpreter&);
static Value delete_property(Interpreter&);
static Value get(Interpreter&);
static Value get_own_property_descriptor(Interpreter&);
static Value get_prototype_of(Interpreter&);
static Value has(Interpreter&);
static Value is_extensible(Interpreter&);
static Value own_keys(Interpreter&);
static Value prevent_extensions(Interpreter&);
static Value set(Interpreter&);
static Value set_prototype_of(Interpreter&);
};
}

View file

@ -38,6 +38,9 @@
#include <LibJS/Runtime/Value.h>
#include <math.h>
// 2 ** 53 - 1
#define MAX_ARRAY_LIKE_INDEX 9007199254740991.0
namespace JS {
bool Value::is_array() const
@ -190,7 +193,7 @@ size_t Value::to_size_t() const
auto number = to_number();
if (number.is_nan() || number.as_double() <= 0)
return 0;
return min(number.to_i32(), (i32)pow(2, 53) - 1);
return min((double)number.to_i32(), MAX_ARRAY_LIKE_INDEX);
}
Value greater_than(Interpreter&, Value lhs, Value rhs)