ladybird/Libraries/LibJS/Runtime/IndexedProperties.h

196 lines
6.3 KiB
C
Raw Permalink Normal View History

/*
* Copyright (c) 2020, Matthew Olsson <mattco@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/NonnullOwnPtr.h>
#include <LibJS/Runtime/Shape.h>
#include <LibJS/Runtime/Value.h>
namespace JS {
struct ValueAndAttributes {
Value value;
PropertyAttributes attributes { default_attributes };
Optional<u32> property_offset {};
};
class IndexedProperties;
class IndexedPropertyIterator;
class GenericIndexedPropertyStorage;
class IndexedPropertyStorage {
public:
virtual ~IndexedPropertyStorage() = default;
enum class IsSimpleStorage {
No,
Yes,
};
virtual bool has_index(u32 index) const = 0;
virtual Optional<ValueAndAttributes> get(u32 index) const = 0;
virtual void put(u32 index, Value value, PropertyAttributes attributes = default_attributes) = 0;
virtual void remove(u32 index) = 0;
virtual ValueAndAttributes take_first() = 0;
virtual ValueAndAttributes take_last() = 0;
virtual size_t size() const = 0;
virtual size_t array_like_size() const = 0;
virtual bool set_array_like_size(size_t new_size) = 0;
bool is_simple_storage() const { return m_is_simple_storage; }
protected:
explicit IndexedPropertyStorage(IsSimpleStorage is_simple_storage)
: m_is_simple_storage(is_simple_storage == IsSimpleStorage::Yes) {};
private:
bool m_is_simple_storage { false };
};
class SimpleIndexedPropertyStorage final : public IndexedPropertyStorage {
public:
SimpleIndexedPropertyStorage()
: IndexedPropertyStorage(IsSimpleStorage::Yes) {};
explicit SimpleIndexedPropertyStorage(Vector<Value>&& initial_values);
virtual bool has_index(u32 index) const override;
virtual Optional<ValueAndAttributes> get(u32 index) const override;
virtual void put(u32 index, Value value, PropertyAttributes attributes = default_attributes) override;
virtual void remove(u32 index) override;
virtual ValueAndAttributes take_first() override;
virtual ValueAndAttributes take_last() override;
virtual size_t size() const override { return m_packed_elements.size(); }
virtual size_t array_like_size() const override { return m_array_size; }
virtual bool set_array_like_size(size_t new_size) override;
2022-04-01 17:58:27 +00:00
Vector<Value> const& elements() const { return m_packed_elements; }
[[nodiscard]] bool inline_has_index(u32 index) const
{
return index < m_array_size && !m_packed_elements.data()[index].is_empty();
}
[[nodiscard]] Optional<ValueAndAttributes> inline_get(u32 index) const
{
if (!inline_has_index(index))
return {};
return ValueAndAttributes { m_packed_elements.data()[index], default_attributes };
}
private:
friend GenericIndexedPropertyStorage;
void grow_storage_if_needed();
size_t m_array_size { 0 };
Vector<Value> m_packed_elements;
};
class GenericIndexedPropertyStorage final : public IndexedPropertyStorage {
public:
explicit GenericIndexedPropertyStorage(SimpleIndexedPropertyStorage&&);
explicit GenericIndexedPropertyStorage()
: IndexedPropertyStorage(IsSimpleStorage::No) {};
virtual bool has_index(u32 index) const override;
virtual Optional<ValueAndAttributes> get(u32 index) const override;
virtual void put(u32 index, Value value, PropertyAttributes attributes = default_attributes) override;
virtual void remove(u32 index) override;
virtual ValueAndAttributes take_first() override;
virtual ValueAndAttributes take_last() override;
virtual size_t size() const override { return m_sparse_elements.size(); }
virtual size_t array_like_size() const override { return m_array_size; }
virtual bool set_array_like_size(size_t new_size) override;
2022-04-01 17:58:27 +00:00
HashMap<u32, ValueAndAttributes> const& sparse_elements() const { return m_sparse_elements; }
private:
size_t m_array_size { 0 };
HashMap<u32, ValueAndAttributes> m_sparse_elements;
};
class IndexedPropertyIterator {
public:
2022-04-01 17:58:27 +00:00
IndexedPropertyIterator(IndexedProperties const&, u32 starting_index, bool skip_empty);
IndexedPropertyIterator& operator++();
IndexedPropertyIterator& operator*();
2022-04-01 17:58:27 +00:00
bool operator!=(IndexedPropertyIterator const&) const;
u32 index() const { return m_index; }
private:
void skip_empty_indices();
2022-04-01 17:58:27 +00:00
IndexedProperties const& m_indexed_properties;
Vector<u32> m_cached_indices;
size_t m_next_cached_index { 0 };
u32 m_index { 0 };
bool m_skip_empty { false };
};
class IndexedProperties {
public:
IndexedProperties() = default;
explicit IndexedProperties(Vector<Value> values)
{
if (!values.is_empty())
m_storage = make<SimpleIndexedPropertyStorage>(move(values));
}
bool has_index(u32 index) const { return m_storage ? m_storage->has_index(index) : false; }
LibJS: Rewrite most of Object for spec compliance :^) This is a huge patch, I know. In hindsight this perhaps could've been done slightly more incremental, but I started and then fixed everything until it worked, and here we are. I tried splitting of some completely unrelated changes into separate commits, however. Anyway. This is a rewrite of most of Object, and by extension large parts of Array, Proxy, Reflect, String, TypedArray, and some other things. What we already had worked fine for about 90% of things, but getting the last 10% right proved to be increasingly difficult with the current code that sort of grew organically and is only very loosely based on the spec - this became especially obvious when we started fixing a large number of test262 failures. Key changes include: - 1:1 matching function names and parameters of all object-related functions, to avoid ambiguity. Previously we had things like put(), which the spec doesn't have - as a result it wasn't always clear which need to be used. - Better separation between object abstract operations and internal methods - the former are always the same, the latter can be overridden (and are therefore virtual). The internal methods (i.e. [[Foo]] in the spec) are now prefixed with 'internal_' for clarity - again, it was previously not always clear which AO a certain method represents, get() could've been both Get and [[Get]] (I don't know which one it was closer to right now). Note that some of the old names have been kept until all code relying on them is updated, but they are now simple wrappers around the closest matching standard abstract operation. - Simplifications of the storage layer: functions that write values to storage are now prefixed with 'storage_' to make their purpose clear, and as they are not part of the spec they should not contain any steps specified by it. Much functionality is now covered by the layers above it and was removed (e.g. handling of accessors, attribute checks). - PropertyAttributes has been greatly simplified, and is being replaced by PropertyDescriptor - a concept similar to the current implementation, but more aligned with the actual spec. See the commit message of the previous commit where it was introduced for details. - As a bonus, and since I had to look at the spec a whole lot anyway, I introduced more inline comments with the exact steps from the spec - this makes it super easy to verify correctness. - East-const all the things. As a result of all of this, things are much more correct but a bit slower now. Retaining speed wasn't a consideration at all, I have done no profiling of the new code - there might be low hanging fruits, which we can then harvest separately. Special thanks to Idan for helping me with this by tracking down bugs, updating everything outside of LibJS to work with these changes (LibWeb, Spreadsheet, HackStudio), as well as providing countless patches to fix regressions I introduced - there still are very few (we got it down to 5), but we also get many new passing test262 tests in return. :^) Co-authored-by: Idan Horowitz <idan.horowitz@gmail.com>
2021-07-04 17:14:16 +00:00
Optional<ValueAndAttributes> get(u32 index) const;
void put(u32 index, Value value, PropertyAttributes attributes = default_attributes);
void remove(u32 index);
LibJS: Rewrite most of Object for spec compliance :^) This is a huge patch, I know. In hindsight this perhaps could've been done slightly more incremental, but I started and then fixed everything until it worked, and here we are. I tried splitting of some completely unrelated changes into separate commits, however. Anyway. This is a rewrite of most of Object, and by extension large parts of Array, Proxy, Reflect, String, TypedArray, and some other things. What we already had worked fine for about 90% of things, but getting the last 10% right proved to be increasingly difficult with the current code that sort of grew organically and is only very loosely based on the spec - this became especially obvious when we started fixing a large number of test262 failures. Key changes include: - 1:1 matching function names and parameters of all object-related functions, to avoid ambiguity. Previously we had things like put(), which the spec doesn't have - as a result it wasn't always clear which need to be used. - Better separation between object abstract operations and internal methods - the former are always the same, the latter can be overridden (and are therefore virtual). The internal methods (i.e. [[Foo]] in the spec) are now prefixed with 'internal_' for clarity - again, it was previously not always clear which AO a certain method represents, get() could've been both Get and [[Get]] (I don't know which one it was closer to right now). Note that some of the old names have been kept until all code relying on them is updated, but they are now simple wrappers around the closest matching standard abstract operation. - Simplifications of the storage layer: functions that write values to storage are now prefixed with 'storage_' to make their purpose clear, and as they are not part of the spec they should not contain any steps specified by it. Much functionality is now covered by the layers above it and was removed (e.g. handling of accessors, attribute checks). - PropertyAttributes has been greatly simplified, and is being replaced by PropertyDescriptor - a concept similar to the current implementation, but more aligned with the actual spec. See the commit message of the previous commit where it was introduced for details. - As a bonus, and since I had to look at the spec a whole lot anyway, I introduced more inline comments with the exact steps from the spec - this makes it super easy to verify correctness. - East-const all the things. As a result of all of this, things are much more correct but a bit slower now. Retaining speed wasn't a consideration at all, I have done no profiling of the new code - there might be low hanging fruits, which we can then harvest separately. Special thanks to Idan for helping me with this by tracking down bugs, updating everything outside of LibJS to work with these changes (LibWeb, Spreadsheet, HackStudio), as well as providing countless patches to fix regressions I introduced - there still are very few (we got it down to 5), but we also get many new passing test262 tests in return. :^) Co-authored-by: Idan Horowitz <idan.horowitz@gmail.com>
2021-07-04 17:14:16 +00:00
void append(Value value, PropertyAttributes attributes = default_attributes) { put(array_like_size(), value, attributes); }
IndexedPropertyIterator begin(bool skip_empty = true) const { return IndexedPropertyIterator(*this, 0, skip_empty); }
IndexedPropertyIterator end() const { return IndexedPropertyIterator(*this, array_like_size(), false); }
bool is_empty() const { return array_like_size() == 0; }
size_t array_like_size() const { return m_storage ? m_storage->array_like_size() : 0; }
bool set_array_like_size(size_t);
IndexedPropertyStorage* storage() { return m_storage; }
IndexedPropertyStorage const* storage() const { return m_storage; }
size_t real_size() const;
Vector<u32> indices() const;
template<typename Callback>
void for_each_value(Callback callback)
{
if (!m_storage)
return;
if (m_storage->is_simple_storage()) {
for (auto& value : static_cast<SimpleIndexedPropertyStorage&>(*m_storage).elements())
callback(value);
} else {
2022-04-01 17:58:27 +00:00
for (auto& element : static_cast<GenericIndexedPropertyStorage const&>(*m_storage).sparse_elements())
callback(element.value.value);
}
}
private:
void switch_to_generic_storage();
void ensure_storage();
OwnPtr<IndexedPropertyStorage> m_storage;
};
}