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.
62 lines
2.7 KiB
C++
62 lines
2.7 KiB
C++
/*
|
|
* Copyright (c) 2024, stelar7 <dudedbz@gmail.com>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <LibGC/Heap.h>
|
|
#include <LibWeb/Bindings/IDBObjectStore.h>
|
|
#include <LibWeb/Bindings/PlatformObject.h>
|
|
#include <LibWeb/IndexedDB/IDBObjectStore.h>
|
|
#include <LibWeb/IndexedDB/Internal/Index.h>
|
|
|
|
namespace Web::IndexedDB {
|
|
|
|
// https://w3c.github.io/IndexedDB/#index-interface
|
|
class IDBIndex : public Bindings::PlatformObject {
|
|
WEB_PLATFORM_OBJECT(IDBIndex, Bindings::PlatformObject);
|
|
GC_DECLARE_ALLOCATOR(IDBIndex);
|
|
|
|
public:
|
|
virtual ~IDBIndex() override;
|
|
[[nodiscard]] static GC::Ref<IDBIndex> create(JS::Realm&, GC::Ref<Index>, GC::Ref<IDBObjectStore>);
|
|
|
|
WebIDL::ExceptionOr<void> set_name(String const& value);
|
|
String name() const { return m_name; }
|
|
GC::Ref<IDBObjectStore> object_store() { return m_object_store_handle; }
|
|
JS::Value key_path() const;
|
|
bool multi_entry() const { return m_index->multi_entry(); }
|
|
bool unique() const { return m_index->unique(); }
|
|
|
|
[[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);
|
|
|
|
// The transaction of an index handle is the transaction of its associated object store handle.
|
|
GC::Ref<IDBTransaction> transaction() { return m_object_store_handle->transaction(); }
|
|
GC::Ref<Index> index() { return m_index; }
|
|
|
|
void update_name() { m_name = m_index->name(); }
|
|
|
|
protected:
|
|
explicit IDBIndex(JS::Realm&, GC::Ref<Index>, GC::Ref<IDBObjectStore>);
|
|
virtual void initialize(JS::Realm&) override;
|
|
virtual void visit_edges(Visitor& visitor) override;
|
|
|
|
private:
|
|
// An index handle has an associated index and an associated object store handle.
|
|
GC::Ref<Index> m_index;
|
|
GC::Ref<IDBObjectStore> m_object_store_handle;
|
|
|
|
// An index handle has a name, which is initialized to the name of the associated index when the index handle is created.
|
|
String m_name;
|
|
};
|
|
|
|
}
|