Files
ladybird/Libraries/LibWeb/Streams/TransformStream.h
Shannon Booth 5adfd1c43a LibWeb/Bindings: Generate struct definitions from IDL dictionaries
Previously we were inconsistent by generating code for enum definitions
but not generating code for dictionaries. With future changes to the
IDL generator to expose helpers to convert to and from IDL values
this produced circular depdendencies. To solve this problem, also
generate the dictionary definitions in bindings headers.
2026-05-09 10:49:49 +02:00

84 lines
3.5 KiB
C++

/*
* Copyright (c) 2023, Kenneth Myhra <kennethmyhra@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <LibJS/Forward.h>
#include <LibWeb/Bindings/PlatformObject.h>
#include <LibWeb/Bindings/QueuingStrategy.h>
#include <LibWeb/Bindings/Transferable.h>
#include <LibWeb/Forward.h>
#include <LibWeb/Streams/Algorithms.h>
#include <LibWeb/WebIDL/Promise.h>
namespace Web::Streams {
class TransformStream final
: public Bindings::PlatformObject
, public Bindings::Transferable {
WEB_PLATFORM_OBJECT(TransformStream, Bindings::PlatformObject);
GC_DECLARE_ALLOCATOR(TransformStream);
public:
virtual ~TransformStream() override;
static WebIDL::ExceptionOr<GC::Ref<TransformStream>> construct_impl(JS::Realm&, Optional<GC::Root<JS::Object>> transformer_object = {}, Bindings::QueuingStrategy const& writable_strategy = {}, Bindings::QueuingStrategy const& readable_strategy = {});
// https://streams.spec.whatwg.org/#ts-readable
GC::Ref<ReadableStream> readable() { return *m_readable; }
void set_readable(ReadableStream& readable) { m_readable = readable; }
// https://streams.spec.whatwg.org/#ts-writable
GC::Ref<WritableStream> writable() { return *m_writable; }
void set_writable(WritableStream& writable) { m_writable = writable; }
Optional<bool> backpressure() const { return m_backpressure; }
void set_backpressure(Optional<bool> value) { m_backpressure = move(value); }
GC::Ptr<WebIDL::Promise> backpressure_change_promise() const { return m_backpressure_change_promise; }
void set_backpressure_change_promise(GC::Ptr<WebIDL::Promise> value) { m_backpressure_change_promise = value; }
GC::Ptr<TransformStreamDefaultController> controller() const { return m_controller; }
void set_controller(GC::Ptr<TransformStreamDefaultController> value) { m_controller = value; }
void set_up(GC::Ref<TransformAlgorithm>, GC::Ptr<FlushAlgorithm> = {}, GC::Ptr<CancelAlgorithm> = {});
void enqueue(JS::Value chunk);
// ^Transferable
virtual WebIDL::ExceptionOr<void> transfer_steps(HTML::TransferDataEncoder&) override;
virtual WebIDL::ExceptionOr<void> transfer_receiving_steps(HTML::TransferDataDecoder&) override;
virtual HTML::TransferType primary_interface() const override { return HTML::TransferType::TransformStream; }
private:
explicit TransformStream(JS::Realm& realm);
virtual void initialize(JS::Realm&) override;
virtual void visit_edges(Cell::Visitor&) override;
// https://streams.spec.whatwg.org/#transformstream-backpressure
// Whether there was backpressure on [[readable]] the last time it was observed
Optional<bool> m_backpressure { false };
// https://streams.spec.whatwg.org/#transformstream-backpressurechangepromise
// A promise which is fulfilled and replaced every time the value of [[backpressure]] changes
GC::Ptr<WebIDL::Promise> m_backpressure_change_promise;
// https://streams.spec.whatwg.org/#transformstream-controller
// A TransformStreamDefaultController created with the ability to control [[readable]] and [[writable]]
GC::Ptr<TransformStreamDefaultController> m_controller;
// https://streams.spec.whatwg.org/#transformstream-readable
// The ReadableStream instance controlled by this object
GC::Ptr<ReadableStream> m_readable;
// https://streams.spec.whatwg.org/#transformstream-writable
// The WritableStream instance controlled by this object
GC::Ptr<WritableStream> m_writable;
};
}