dymokomi/luce-browser-engine
Source of release 0.6.0
0.6.0 / src / web / web_idl / buffers.lucb
#==============================================================================================
#
# buffers - WebIDL buffer source types: BufferableObjectBase, ArrayBufferView, BufferSource
#
# DESCRIPTION:
# Port of Libraries/LibWeb/WebIDL/Buffers.cpp (lines 1-156) and Buffers.h (lines 1-95).
# A BufferableObjectBase wraps a JS TypedArray, DataView or ArrayBuffer. Before luce-js the
# typed arrays and ArrayBuffers are the stand-ins of DESIGN.md §3.6 (external/lib_js
# typed_array and array_buffer, region p2s), so their lengths, offsets and viewed buffers
# are ported; DataViews and writing bytes into a view stay phase 3.
#
# Copyright (c) 2023, Shannon Booth <shannon@serenityos.org>
# Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>
# SPDX-License-Identifier: BSD-2-Clause
#
#==============================================================================================
# mark: BufferableObjectBase ====================================================================
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:18 Web::WebIDL::BufferableObjectBase::byte_length.
pub func idl_bufferable_object_base_byte_length(this: IdlBufferableObjectBase*) -> u32:
match this.m_bufferable_object:
.js_typed_array_base(typed_array):
let typed_array_record = js_make_typed_array_with_buffer_witness_record(typed_array)
return js_typed_array_byte_length(&typed_array_record)
.js_data_view(_):
trap("unported (P3): Web::WebIDL::BufferableObjectBase::byte_length of a DataView (JS buffer objects)")
.js_array_buffer(array_buffer):
return (u32)js_array_buffer_byte_length(array_buffer)
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:32 Web::WebIDL::BufferableObjectBase::byte_offset.
pub func idl_bufferable_object_base_byte_offset(this: IdlBufferableObjectBase*) -> u32:
match this.m_bufferable_object:
.js_array_buffer(_):
return 0
.js_typed_array_base(typed_array):
return js_typed_array_base_byte_offset(typed_array)
.js_data_view(_):
trap("unported (P3): Web::WebIDL::BufferableObjectBase::byte_offset of a DataView (JS buffer objects)")
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:39 Web::WebIDL::BufferableObjectBase::element_size.
pub func idl_bufferable_object_base_element_size(this: IdlBufferableObjectBase*) -> u32:
match this.m_bufferable_object:
.js_typed_array_base(typed_array):
let typed_array_record = js_make_typed_array_with_buffer_witness_record(typed_array)
return js_typed_array_base_element_size(typed_array_record.object)
.js_data_view(_):
return 1
.js_array_buffer(_):
return 1
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:54 Web::WebIDL::BufferableObjectBase::raw_object.
pub func idl_bufferable_object_base_raw_object(this: IdlBufferableObjectBase*) -> JsObject*:
match this.m_bufferable_object:
.js_typed_array_base(object):
return (JsObject*)object
.js_data_view(object):
return (JsObject*)object
.js_array_buffer(object):
return (JsObject*)object
## Ported from Libraries/LibWeb/WebIDL/Buffers.h:36 Web::WebIDL::BufferableObjectBase::raw_object (const).
pub func idl_bufferable_object_base_raw_object_const(this: IdlBufferableObjectBase*) -> JsObject*:
return idl_bufferable_object_base_raw_object(this)
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:59 Web::WebIDL::BufferableObjectBase::viewed_array_buffer.
pub func idl_bufferable_object_base_viewed_array_buffer(this: IdlBufferableObjectBase*) -> JsArrayBuffer*?:
match this.m_bufferable_object:
.js_array_buffer(array_buffer):
return array_buffer
.js_typed_array_base(typed_array):
return js_typed_array_base_viewed_array_buffer(typed_array)
.js_data_view(_):
trap("unported (P3): Web::WebIDL::BufferableObjectBase::viewed_array_buffer of a DataView (JS buffer objects)")
## Ported from Libraries/LibWeb/WebIDL/Buffers.h:40 Web::WebIDL::BufferableObjectBase::bufferable_object (const).
pub func idl_bufferable_object_base_bufferable_object_const(this: IdlBufferableObjectBase*) -> IdlBufferableObject:
return this.m_bufferable_object
## Ported from Libraries/LibWeb/WebIDL/Buffers.h:41 Web::WebIDL::BufferableObjectBase::bufferable_object.
pub func idl_bufferable_object_base_bufferable_object(this: IdlBufferableObjectBase*) -> IdlBufferableObject*:
return &this.m_bufferable_object
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:66 Web::WebIDL::BufferableObjectBase::bufferable_object_from_raw_object:
## which of the three kinds of buffer object `object` is (a DataView is phase 3).
pub func idl_bufferable_object_base_bufferable_object_from_raw_object(object: JsObject*) -> IdlBufferableObject:
let cell = (gc.Cell*)object
if let typed_array = as_if_js_typed_array_base(cell):
return .js_typed_array_base(typed_array)
# is<JS::DataView>: DataViews are phase 3.
if let array_buffer = as_if_js_array_buffer(cell):
return .js_array_buffer(array_buffer)
trap("VERIFY_NOT_REACHED")
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:80 Web::WebIDL::BufferableObjectBase::BufferableObjectBase.
pub func idl_bufferable_object_base_construct(this: IdlBufferableObjectBase*, object: JsObject*):
this.m_bufferable_object = idl_bufferable_object_base_bufferable_object_from_raw_object(object)
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:85 Web::WebIDL::BufferableObjectBase::is_typed_array_base.
pub func idl_bufferable_object_base_is_typed_array_base(this: IdlBufferableObjectBase*) -> bool:
match this.m_bufferable_object:
.js_typed_array_base(_):
return true
_:
return false
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:90 Web::WebIDL::BufferableObjectBase::is_data_view.
pub func idl_bufferable_object_base_is_data_view(this: IdlBufferableObjectBase*) -> bool:
match this.m_bufferable_object:
.js_data_view(_):
return true
_:
return false
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:95 Web::WebIDL::BufferableObjectBase::is_array_buffer.
pub func idl_bufferable_object_base_is_array_buffer(this: IdlBufferableObjectBase*) -> bool:
match this.m_bufferable_object:
.js_array_buffer(_):
return true
_:
return false
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:100 Web::WebIDL::BufferableObjectBase::visit_edges (override).
pub func idl_bufferable_object_base_visit_edges_impl(base: gc.Cell*, visitor: gc.CellVisitor*):
let this = (IdlBufferableObjectBase*)base
gc.cell_visit_edges_impl(base, visitor)
js_visit_object(visitor, idl_bufferable_object_base_raw_object(this))
# mark: ArrayBufferView and BufferSource ========================================================
## `heap.allocate<WebIDL::ArrayBufferView>(object)` (Buffers.h:69, BufferableObjectBase's constructor):
## an ArrayBufferView over a typed array or DataView, constructed under DeferGC.
pub func heap_allocate_idl_array_buffer_view(heap: gc.Heap*, object: JsObject*) -> IdlArrayBufferView*:
let this = (IdlArrayBufferView*)web_heap_allocate_cell(heap, &idl_array_buffer_view_class)
gc.heap_defer_gc(heap)
idl_bufferable_object_base_construct(this.idl_bufferable_object_base(), object)
gc.heap_undefer_gc(heap)
return this
## `realm.create<WebIDL::ArrayBufferView>(object)`: the same, then initialize(realm) (which does
## nothing for a JS::Cell).
pub func realm_create_idl_array_buffer_view(realm: Realm*, object: JsObject*) -> IdlArrayBufferView*:
let this = (IdlArrayBufferView*)web_allocate_cell(realm, &idl_array_buffer_view_class)
idl_bufferable_object_base_construct(this.idl_bufferable_object_base(), object)
web_initialize_cell(this.cell(), realm)
return this
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:109 Web::WebIDL::ArrayBufferView::write.
## https://webidl.spec.whatwg.org/#arraybufferview-write
pub func idl_array_buffer_view_write(this: IdlArrayBufferView*, bytes: const u8[], starting_offset: u32 = 0):
# 1. Let jsView be the result of converting view to a JavaScript value.
# 2. Assert: bytes’s length ≤ jsView.[[ByteLength]] − startingOffset.
# 3. Assert: if view is not a DataView, then bytes’s length modulo the element size of view’s type is 0.
# 4. Let arrayBuffer be the result of converting jsView.[[ViewedArrayBuffer]] to an IDL value of type ArrayBuffer.
# 5. Write bytes into arrayBuffer with startingOffset set to jsView.[[ByteOffset]] + startingOffset.
trap("unported (P3): Web::WebIDL::ArrayBufferView::write (JS buffer objects)")
## Ported from Libraries/LibWeb/WebIDL/Buffers.cpp:131 Web::WebIDL::is_buffer_source_detached.
## https://webidl.spec.whatwg.org/#buffersource-detached
pub func idl_is_buffer_source_detached(buffer_source: JsValue) -> bool:
# A buffer source type instance bufferSource is detached if the following steps return true:
# 1. Let jsArrayBuffer be the result of converting bufferSource to a JavaScript value.
# 2. If jsArrayBuffer has a [[ViewedArrayBuffer]] internal slot, then set jsArrayBuffer to jsArrayBuffer.[[ViewedArrayBuffer]].
if not js_value_is_object(buffer_source):
return false
# The ArrayBuffer, TypedArray or DataView and IsDetachedBuffer: JS buffer objects (phase 3).
# 3. Return IsDetachedBuffer(jsArrayBuffer).
trap("unported (P3): Web::WebIDL::is_buffer_source_detached of a JS object")