dymokomi/luce-browser-engine
Source of release 0.6.1
0.6.1 / src / web / streams / abstract_operations.lucb
#==============================================================================================
#
# abstract_operations - Streams' abstract operations over ArrayBuffers and queues:
# transferring a buffer, cloning a view as a Uint8Array, resetting a queue
#
# DESCRIPTION:
# Port of Libraries/LibWeb/Streams/AbstractOperations.cpp (lines 420-495) and the
# ResetQueue template of AbstractOperations.h (lines 112-122), as part of the
# ReadableStream stand-in of DESIGN.md §3.6 (region p2s). The queuing strategies, the
# writable and transform streams' operations and cross-realm transforms are phase 4.
#
# Copyright (c) 2022, Linus Groh <linusg@serenityos.org>
# Copyright (c) 2023, Matthew Olsson <mattco@serenityos.org>
# Copyright (c) 2023-2025, Shannon Booth <shannon@serenityos.org>
# SPDX-License-Identifier: BSD-2-Clause
#
#==============================================================================================
# mark: ArrayBuffers ============================================================================
## Ported from Libraries/LibWeb/Streams/AbstractOperations.cpp:420 Web::Streams::can_transfer_array_buffer.
## https://streams.spec.whatwg.org/#can-transfer-array-buffer
pub func streams_can_transfer_array_buffer(array_buffer: JsArrayBuffer*) -> bool:
# 1. Assert: O is an Object.
# 2. Assert: O has an [[ArrayBufferData]] internal slot.
# 3. If ! IsDetachedBuffer(O) is true, return false.
if js_array_buffer_is_detached(array_buffer):
return false
# 4. If SameValue(O.[[ArrayBufferDetachKey]], undefined) is false, return false.
# (The stand-in's detach key is always undefined.)
# 5. Return true.
return true
## Ported from Libraries/LibWeb/Streams/AbstractOperations.cpp:458 Web::Streams::transfer_array_buffer.
## https://streams.spec.whatwg.org/#transfer-array-buffer
pub func streams_transfer_array_buffer(realm: Realm*, buffer: JsArrayBuffer*) -> JsArrayBuffer*!:
let vm = realm_vm(realm)
# 1. Assert: ! IsDetachedBuffer(O) is false.
assert(not js_array_buffer_is_detached(buffer))
# 2. Let arrayBufferData be O.[[ArrayBufferData]].
# 3. Let arrayBufferByteLength be O.[[ArrayBufferByteLength]].
# 4. Perform ? DetachArrayBuffer(O).
# NB: We steal the underlying bytes and detach atomically so the transfer is zero-copy.
let array_buffer = try js_array_buffer_detach_and_take_bytes(buffer, vm)
# 5. Return a new ArrayBuffer object, created in the current Realm, whose [[ArrayBufferData]] internal slot value is arrayBufferData and whose [[ArrayBufferByteLength]] internal slot value is arrayBufferByteLength.
return js_array_buffer_create_byte_buffer(realm, array_buffer)
## Ported from Libraries/LibWeb/Streams/AbstractOperations.cpp:474 Web::Streams::clone_as_uint8_array.
## https://streams.spec.whatwg.org/#abstract-opdef-cloneasuint8array
pub func streams_clone_as_uint8_array(realm: Realm*, view: IdlArrayBufferView*) -> JsValue!:
let vm = realm_vm(realm)
let base = view.idl_bufferable_object_base()
let viewed_array_buffer = idl_bufferable_object_base_viewed_array_buffer(base) else trap("VERIFY: a view's buffer")
# 1. Assert: O is an Object.
# 2. Assert: O has an [[ViewedArrayBuffer]] internal slot.
# 3. Assert: ! IsDetachedBuffer(O.[[ViewedArrayBuffer]]) is false.
assert(not js_array_buffer_is_detached(viewed_array_buffer))
# 4. Let buffer be ? CloneArrayBuffer(O.[[ViewedArrayBuffer]], O.[[ByteOffset]], O.[[ByteLength]], %ArrayBuffer%).
let buffer = try js_clone_array_buffer(vm, viewed_array_buffer, (usize)idl_bufferable_object_base_byte_offset(base), (usize)idl_bufferable_object_base_byte_length(base))
# 5. Let array be ! Construct(%Uint8Array%, « buffer »).
let array = js_construct_uint8_array(vm, buffer, 0, (u64)js_array_buffer_byte_length(buffer)) else trap("MUST: Construct(%Uint8Array%)")
# 5. Return array.
return js_value_from_object((JsObject*)array)
# mark: Queues ==================================================================================
## Ported from Libraries/LibWeb/Streams/AbstractOperations.h:113 Web::Streams::reset_queue, for a
## ReadableByteStreamController (the template's one instantiation in the stand-in).
## https://streams.spec.whatwg.org/#reset-queue
pub func streams_reset_queue(container: StreamsReadableByteStreamController*):
# 1. Assert: container has [[queue]] and [[queueTotalSize]] internal slots.
# 2. Set container.[[queue]] to a new empty list.
ak.singly_linked_list_clear(&container.m_queue)
# 3. Set container.[[queueTotalSize]] to 0.
container.m_queue_total_size = 0.0