dymokomi/luce-browser-engine
Source of release 0.6.1
0.6.1 / src / web / html / message_port.lucb
#==============================================================================================
#
# message_port - HTML::MessagePort: the registry of every port, and disentangling one
#
# DESCRIPTION:
# Port of Libraries/LibWeb/HTML/MessagePort.cpp lines 33-89 and 172-188 (all_message_ports,
# create, the constructor, for_each_message_port, initialize, finalize, visit_edges,
# is_entangled, set_worker_event_target, disentangle) with the inline entangled_port of
# MessagePort.h: what Document::destroy needs to walk the ports of its window. Every port
# registers itself in a static weak set as it is made and leaves it when it is finalized.
#
# The set is a module global (DESIGN.md §3.3 rule 7): its table is allocated from the C
# heap and holds gc.Weaks, which may live anywhere (§3.7); a port leaves it in finalize,
# so it never names a port of a destroyed heap.
#
# Messaging is phase 4: entangling (entangle_with, IPC::Transport::create_paired),
# posting, transferring, enable/start/close and the event handlers. Nothing makes a port
# before then (MessageChannel, BroadcastChannel and workers are phase 3 and 4), so the
# set stays empty and disentangle has no transport to close.
#
# Copyright (c) 2021, Andreas Kling <andreas@ladybird.org>
# Copyright (c) 2023, Andrew Kaster <akaster@serenityos.org>
# Copyright (c) 2025, Aliaksandr Kalenik <kalenik.aliaksandr@gmail.com>
# SPDX-License-Identifier: BSD-2-Clause
#
#==============================================================================================
## The static set of all_message_ports, in the C heap (see above).
var html_message_port_all_message_ports_storage: gc.WeakHashSet[HtmlMessagePort]
## Ported from MessagePort.cpp:35 Web::HTML::all_message_ports.
func html_message_port_all_message_ports() -> gc.WeakHashSet[HtmlMessagePort]*:
return &html_message_port_all_message_ports_storage
## Ported from MessagePort.cpp:41 Web::HTML::MessagePort::create.
pub func html_message_port_create(realm: Realm*) -> HtmlMessagePort*:
return realm_create_html_message_port(realm, realm)
## Ported from MessagePort.cpp:46 Web::HTML::MessagePort::MessagePort.
pub func html_message_port_construct(this: HtmlMessagePort*, realm: Realm*):
dom_event_target_construct(this.dom_event_target(), realm)
# (The set is a module global: its storage comes from the C heap, atomic storage included.)
let saved_atomic_allocator = ak.atomic_allocator
ak.atomic_allocator = none
defer ak.atomic_allocator = saved_atomic_allocator
with memory.heap:
gc.weak_hash_set_set(html_message_port_all_message_ports(), this)
## Ported from MessagePort.cpp:54 Web::HTML::MessagePort::for_each_message_port.
pub func html_message_port_for_each_message_port(callback: ak.Function1[HtmlMessagePort*, unit]):
# `auto ports = all_message_ports();` copies the set: the callback may change it.
var ports: ak.Vector[HtmlMessagePort*]
for port in gc.weak_hash_set_begin(html_message_port_all_message_ports()):
ak.vector_append_t(&ports, port)
for port in ak.vector_span(&ports):
ak.function1_call(&callback, port)
## Ported from MessagePort.cpp:61 Web::HTML::MessagePort::initialize (override).
pub func html_message_port_initialize_impl(base: JsCell*, realm: Realm*):
web_set_prototype_for_interface(base, realm, BindInterfaceName.message_port)
dom_event_target_initialize_impl(base, realm)
## Ported from MessagePort.cpp:67 Web::HTML::MessagePort::finalize (override).
pub func html_message_port_finalize_impl(base: gc.Cell*):
let this = (HtmlMessagePort*)base
gc.cell_finalize_impl(base)
let saved_atomic_allocator = ak.atomic_allocator
ak.atomic_allocator = none
defer ak.atomic_allocator = saved_atomic_allocator
with memory.heap:
_ = gc.weak_hash_set_remove(html_message_port_all_message_ports(), this)
html_message_port_disentangle(this)
## Ported from MessagePort.cpp:74 Web::HTML::MessagePort::visit_edges (override).
pub func html_message_port_visit_edges_impl(base: gc.Cell*, visitor: gc.CellVisitor*):
let this = (HtmlMessagePort*)base
dom_event_target_visit_edges_impl(base, visitor)
gc.cell_visitor_visit_t(visitor, this.m_remote_port)
gc.cell_visitor_visit_t(visitor, this.m_worker_event_target)
## Ported from MessagePort.cpp:81 Web::HTML::MessagePort::is_entangled (private).
func html_message_port_is_entangled(this: HtmlMessagePort*) -> bool:
return this.m_transport != none
## Ported from MessagePort.cpp:86 Web::HTML::MessagePort::set_worker_event_target.
pub func html_message_port_set_worker_event_target(this: HtmlMessagePort*, target: DomEventTarget*):
this.m_worker_event_target = target
## Ported from MessagePort.h:41 Web::HTML::MessagePort::entangled_port.
pub func html_message_port_entangled_port(this: HtmlMessagePort*) -> HtmlMessagePort*?:
return this.m_remote_port
## Ported from MessagePort.cpp:172 Web::HTML::MessagePort::disentangle.
pub func html_message_port_disentangle(this: HtmlMessagePort*):
if let remote_port = this.m_remote_port:
remote_port.m_remote_port = none
this.m_remote_port = none
if html_message_port_is_entangled(this):
# m_transport->close_after_sending_all_pending_messages(); m_transport.clear();
trap("unported (P4): IPC::Transport::close_after_sending_all_pending_messages")
# (m_pending_incoming_messages.clear(); m_pending_outgoing_messages.clear(): the queues are phase 4's.)
this.m_should_shutdown_on_enable = false
this.m_worker_event_target = none