dymokomi/luce-browser-engine
Source of release 0.6.1
0.6.1 / src / web / html / text_track.lucb
#==============================================================================================
#
# text_track - HTML::TextTrack and its observers
#
# DESCRIPTION:
# Port of Libraries/LibWeb/HTML/TextTrack.cpp (lines 1-153) with the inline
# readiness_state of TextTrack.h, and TextTrackObserver.cpp (lines 1-43): a <track>
# element's text track (its kind, label, language, id, mode and readiness state) and the
# observers HTMLTrackElement uses to hear of readiness changes.
#
# The observers are a HashTable<GC::Ref<TextTrackObserver>> in C++, iterated in hash
# (pointer) order; here they are a list in insertion order. A track has at most its
# element's observer, so the order does not show.
#
# Copyright (c) 2024, Jamie Mansfield <jmansfield@cadixdev.org>
# Copyright (c) 2025, Tim Flynn <trflynn89@ladybird.org>
# Copyright (c) 2026 the luce-browser authors.
# SPDX-License-Identifier: BSD-2-Clause
#
#==============================================================================================
# mark: TextTrack ===============================================================================
## Ported from TextTrack.cpp:17 Web::HTML::TextTrack::create.
pub func html_text_track_create(realm: Realm*) -> HtmlTextTrack*:
return realm_create_html_text_track(realm, realm)
## Ported from TextTrack.cpp:22 Web::HTML::TextTrack::TextTrack.
pub func html_text_track_construct(this: HtmlTextTrack*, realm: Realm*):
html_text_track_init_fields(this)
dom_event_target_construct(this.dom_event_target(), realm)
## Ported from TextTrack.cpp:29 Web::HTML::TextTrack::initialize (override).
pub func html_text_track_initialize_impl(base: JsCell*, realm: Realm*):
web_set_prototype_for_interface(base, realm, BindInterfaceName.text_track)
dom_event_target_initialize_impl(base, realm)
## Ported from TextTrack.cpp:35 Web::HTML::TextTrack::visit_edges (override).
pub func html_text_track_visit_edges_impl(base: gc.Cell*, visitor: gc.CellVisitor*):
let this = (HtmlTextTrack*)base
dom_event_target_visit_edges_impl(base, visitor)
for observer in ak.vector_span(&this.m_observers):
gc.cell_visitor_visit_t(visitor, observer)
## Ported from TextTrack.cpp:42 Web::HTML::TextTrack::kind.
# https://html.spec.whatwg.org/multipage/media.html#dom-texttrack-kind
pub func html_text_track_kind(this: HtmlTextTrack*) -> BindTextTrackKind:
return this.m_kind
## Ported from TextTrack.cpp:47 Web::HTML::TextTrack::set_kind.
pub func html_text_track_set_kind(this: HtmlTextTrack*, kind: BindTextTrackKind):
this.m_kind = kind
## Ported from TextTrack.cpp:53 Web::HTML::TextTrack::label.
# https://html.spec.whatwg.org/multipage/media.html#dom-texttrack-label
pub func html_text_track_label(this: HtmlTextTrack*) -> ak.String:
return this.m_label
## Ported from TextTrack.cpp:58 Web::HTML::TextTrack::set_label.
pub func html_text_track_set_label(this: HtmlTextTrack*, label: ak.String):
this.m_label = label
## Ported from TextTrack.cpp:64 Web::HTML::TextTrack::language.
# https://html.spec.whatwg.org/multipage/media.html#dom-texttrack-language
pub func html_text_track_language(this: HtmlTextTrack*) -> ak.String:
return this.m_language
## Ported from TextTrack.cpp:69 Web::HTML::TextTrack::set_language.
pub func html_text_track_set_language(this: HtmlTextTrack*, language: ak.String):
this.m_language = language
## Ported from TextTrack.cpp:75 Web::HTML::TextTrack::id.
# https://html.spec.whatwg.org/multipage/media.html#dom-texttrack-id
pub func html_text_track_id(this: HtmlTextTrack*) -> ak.String:
return this.m_id
## Ported from TextTrack.cpp:80 Web::HTML::TextTrack::set_id.
pub func html_text_track_set_id(this: HtmlTextTrack*, id: ak.String):
this.m_id = id
## Ported from TextTrack.cpp:86 Web::HTML::TextTrack::mode.
# https://html.spec.whatwg.org/multipage/media.html#dom-texttrack-mode
pub func html_text_track_mode(this: HtmlTextTrack*) -> BindTextTrackMode:
return this.m_mode
## Ported from TextTrack.cpp:91 Web::HTML::TextTrack::set_mode.
pub func html_text_track_set_mode(this: HtmlTextTrack*, mode: BindTextTrackMode):
this.m_mode = mode
## Ported from TextTrack.cpp:97 Web::HTML::TextTrack::set_oncuechange.
# https://html.spec.whatwg.org/multipage/media.html#handler-texttrack-oncuechange
pub func html_text_track_set_oncuechange(this: HtmlTextTrack*, event_handler: IdlCallbackType*?):
dom_event_target_set_event_handler_attribute(this.dom_event_target(), html_event_names_cuechange, event_handler)
## Ported from TextTrack.cpp:103 Web::HTML::TextTrack::oncuechange.
# https://html.spec.whatwg.org/multipage/media.html#handler-texttrack-oncuechange
pub func html_text_track_oncuechange(this: HtmlTextTrack*) -> IdlCallbackType*?:
return dom_event_target_event_handler_attribute(this.dom_event_target(), html_event_names_cuechange)
## Ported from TextTrack.h:53 Web::HTML::TextTrack::readiness_state.
pub func html_text_track_readiness_state(this: HtmlTextTrack*) -> HtmlTextTrackReadinessState:
return this.m_readiness_state
## Ported from TextTrack.cpp:108 Web::HTML::TextTrack::set_readiness_state.
pub func html_text_track_set_readiness_state(this: HtmlTextTrack*, readiness_state: HtmlTextTrackReadinessState):
this.m_readiness_state = readiness_state
var observers = ak.vector_clone(&this.m_observers)
for observer in ak.vector_span(&observers):
if let callback = html_text_track_observer_track_readiness_observer(observer):
ak.function1_call(&callback.function, this.m_readiness_state)
## Ported from TextTrack.cpp:118 Web::HTML::TextTrack::register_observer.
func html_text_track_register_observer(this: HtmlTextTrack*, observer: HtmlTextTrackObserver*):
for registered in ak.vector_span(&this.m_observers):
assert(registered != observer, "VERIFY: result == AK::HashSetResult::InsertedNewEntry")
ak.vector_append_t(&this.m_observers, observer)
## Ported from TextTrack.cpp:124 Web::HTML::TextTrack::unregister_observer.
func html_text_track_unregister_observer(this: HtmlTextTrack*, observer: HtmlTextTrackObserver*):
let observers = ak.vector_span(&this.m_observers)
for index in 0..<observers.length:
if observers[index] == observer:
ak.vector_remove(&this.m_observers, index)
return
trap("VERIFY: was_removed")
## Ported from TextTrack.cpp:130 Web::HTML::text_track_kind_from_string.
pub func html_text_track_kind_from_string(value: ak.String) -> BindTextTrackKind:
# https://html.spec.whatwg.org/multipage/media.html#attr-track-kind
if ak.string_is_empty(&value) or ak.string_equals_ignoring_ascii_case_string_view(&value, ak.sv("subtitles")):
return BindTextTrackKind.subtitles
if ak.string_equals_ignoring_ascii_case_string_view(&value, ak.sv("captions")):
return BindTextTrackKind.captions
if ak.string_equals_ignoring_ascii_case_string_view(&value, ak.sv("descriptions")):
return BindTextTrackKind.descriptions
if ak.string_equals_ignoring_ascii_case_string_view(&value, ak.sv("chapters")):
return BindTextTrackKind.chapters
if ak.string_equals_ignoring_ascii_case_string_view(&value, ak.sv("metadata")):
return BindTextTrackKind.metadata
return BindTextTrackKind.metadata
# mark: TextTrackObserver =======================================================================
## Ported from TextTrackObserver.cpp:15 Web::HTML::TextTrackObserver::TextTrackObserver.
pub func html_text_track_observer_construct(this: HtmlTextTrackObserver*, realm: Realm*, text_track: HtmlTextTrack*):
bind_platform_object_construct_realm(this.bind_platform_object(), realm)
this.m_text_track = text_track
html_text_track_register_observer(this.m_text_track, this)
## TextTrackObserver::initialize: a non-IDL platform object keeps PlatformObject's.
pub func html_text_track_observer_initialize_impl(base: JsCell*, realm: Realm*):
# Base::initialize(realm): PlatformObject inherits JS::Object's.
js_cell_initialize_impl(base, realm)
## Ported from TextTrackObserver.cpp:22 Web::HTML::TextTrackObserver::visit_edges (override).
pub func html_text_track_observer_visit_edges_impl(base: gc.Cell*, visitor: gc.CellVisitor*):
let this = (HtmlTextTrackObserver*)base
bind_platform_object_visit_edges_impl(base, visitor)
gc.cell_visitor_visit_t(visitor, this.m_text_track)
gc.cell_visitor_visit_cell(visitor, (gc.Cell*?)this.m_track_readiness_observer)
## Ported from TextTrackObserver.cpp:29 Web::HTML::TextTrackObserver::finalize (override).
pub func html_text_track_observer_finalize_impl(base: gc.Cell*):
let this = (HtmlTextTrackObserver*)base
gc.cell_finalize_impl(base)
html_text_track_unregister_observer(this.m_text_track, this)
## Ported from TextTrackObserver.h:24 Web::HTML::TextTrackObserver::track_readiness_observer.
pub func html_text_track_observer_track_readiness_observer(this: HtmlTextTrackObserver*) -> gc.Function1[HtmlTextTrackReadinessState, unit]*?:
return this.m_track_readiness_observer
## Ported from TextTrackObserver.cpp:35 Web::HTML::TextTrackObserver::set_track_readiness_observer
## (none: the empty Function `{}`).
pub func html_text_track_observer_set_track_readiness_observer(this: HtmlTextTrackObserver*, callback: ak.Function1[HtmlTextTrackReadinessState, unit]?):
if let function = callback:
this.m_track_readiness_observer = gc.create_function1(vm_heap(js_cell_vm(this.js_cell())), function)
else:
this.m_track_readiness_observer = none