637fd51595
Represent WebIDL C++ types with a single CppType model that tracks nullability, optional presence, and contained storage. GC-like values now use GC::Ref/GC::Ptr directly, while containers choose "plain", "Root", or "Conservative" container types depending on what they contain. For example, sequence<Element> becomes a RootVector of GC::Ref values, while sequence<SomeDictionary> becomes a ConservativeVector only when the dictionary contains GC-like values. This moves the generated bindings away from wrapping GC values in GC::Root by default. This has broad fallout as the types passed to interfaces for GC objects changes almost fully across the board.
78 lines
3.6 KiB
C++
78 lines
3.6 KiB
C++
/*
|
|
* Copyright (c) 2024-2025, stelar7 <dudedbz@gmail.com>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/HashMap.h>
|
|
#include <LibGC/Heap.h>
|
|
#include <LibWeb/Bindings/IDBCursor.h>
|
|
#include <LibWeb/Bindings/PlatformObject.h>
|
|
#include <LibWeb/IndexedDB/IDBTransaction.h>
|
|
#include <LibWeb/IndexedDB/Internal/Index.h>
|
|
#include <LibWeb/IndexedDB/Internal/ObjectStore.h>
|
|
|
|
namespace Web::IndexedDB {
|
|
|
|
// https://w3c.github.io/IndexedDB/#object-store-interface
|
|
// https://w3c.github.io/IndexedDB/#object-store-handle-construct
|
|
class IDBObjectStore : public Bindings::PlatformObject {
|
|
WEB_PLATFORM_OBJECT(IDBObjectStore, Bindings::PlatformObject);
|
|
GC_DECLARE_ALLOCATOR(IDBObjectStore);
|
|
|
|
public:
|
|
virtual ~IDBObjectStore() override;
|
|
[[nodiscard]] static GC::Ref<IDBObjectStore> create(JS::Realm&, GC::Ref<ObjectStore>, GC::Ref<IDBTransaction>);
|
|
|
|
String name() const;
|
|
WebIDL::ExceptionOr<void> set_name(String const& value);
|
|
JS::Value key_path() const;
|
|
[[nodiscard]] GC::Ref<HTML::DOMStringList> index_names();
|
|
GC::Ref<IDBTransaction> transaction() const;
|
|
bool auto_increment() const;
|
|
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> put(JS::Value value, Optional<JS::Value> const& key);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> add(JS::Value value, Optional<JS::Value> const& key);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> delete_(JS::Value);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> clear();
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> get(JS::Value);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> get_key(JS::Value);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> get_all(Optional<JS::Value>, Optional<WebIDL::UnsignedLong>);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> get_all_keys(Optional<JS::Value>, Optional<WebIDL::UnsignedLong>);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> get_all_records(Bindings::IDBGetAllOptions const&);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> count(Optional<JS::Value>);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> open_cursor(Optional<JS::Value>, Bindings::IDBCursorDirection = Bindings::IDBCursorDirection::Next);
|
|
[[nodiscard]] WebIDL::ExceptionOr<GC::Ref<IDBRequest>> open_key_cursor(Optional<JS::Value>, Bindings::IDBCursorDirection = Bindings::IDBCursorDirection::Next);
|
|
|
|
WebIDL::ExceptionOr<GC::Ref<IDBIndex>> index(String const&);
|
|
|
|
WebIDL::ExceptionOr<GC::Ref<IDBIndex>> create_index(String const&, KeyPath, Bindings::IDBIndexParameters const&);
|
|
WebIDL::ExceptionOr<void> delete_index(String const&);
|
|
|
|
AK::HashMap<String, GC::Ref<Index>>& index_set() { return m_indexes; }
|
|
WebIDL::ExceptionOr<GC::Ref<IDBRequest>> add_or_put(GC::Ref<IDBObjectStore>, JS::Value, Optional<JS::Value> const&, bool);
|
|
GC::Ref<ObjectStore> store() const { return m_store; }
|
|
|
|
void update_name() { m_name = m_store->name(); }
|
|
void update_index_set() { m_indexes = m_store->index_set(); }
|
|
|
|
protected:
|
|
explicit IDBObjectStore(JS::Realm&, GC::Ref<ObjectStore>, GC::Ref<IDBTransaction>);
|
|
virtual void initialize(JS::Realm&) override;
|
|
virtual void visit_edges(Visitor& visitor) override;
|
|
|
|
private:
|
|
// An object store handle has an associated object store and an associated transaction.
|
|
GC::Ref<ObjectStore> m_store;
|
|
GC::Ref<IDBTransaction> m_transaction;
|
|
|
|
// An object store handle has a name, which is initialized to the name of the associated object store when the object store handle is created.
|
|
String m_name;
|
|
|
|
// An object store handle has an index set
|
|
AK::HashMap<String, GC::Ref<Index>> m_indexes;
|
|
};
|
|
|
|
}
|