script/dom/
texttracklist.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use dom_struct::dom_struct;
6
7use crate::dom::bindings::cell::DomRefCell;
8use crate::dom::bindings::codegen::Bindings::TextTrackListBinding::TextTrackListMethods;
9use crate::dom::bindings::codegen::UnionTypes::VideoTrackOrAudioTrackOrTextTrack;
10use crate::dom::bindings::inheritance::Castable;
11use crate::dom::bindings::refcounted::Trusted;
12use crate::dom::bindings::reflector::{DomGlobal, reflect_dom_object};
13use crate::dom::bindings::root::{Dom, DomRoot};
14use crate::dom::bindings::str::DOMString;
15use crate::dom::event::Event;
16use crate::dom::eventtarget::EventTarget;
17use crate::dom::texttrack::TextTrack;
18use crate::dom::trackevent::TrackEvent;
19use crate::dom::window::Window;
20use crate::script_runtime::CanGc;
21
22#[dom_struct]
23pub(crate) struct TextTrackList {
24    eventtarget: EventTarget,
25    dom_tracks: DomRefCell<Vec<Dom<TextTrack>>>,
26}
27
28impl TextTrackList {
29    pub(crate) fn new_inherited(tracks: &[&TextTrack]) -> TextTrackList {
30        TextTrackList {
31            eventtarget: EventTarget::new_inherited(),
32            dom_tracks: DomRefCell::new(tracks.iter().map(|g| Dom::from_ref(&**g)).collect()),
33        }
34    }
35
36    pub(crate) fn new(
37        window: &Window,
38        tracks: &[&TextTrack],
39        can_gc: CanGc,
40    ) -> DomRoot<TextTrackList> {
41        reflect_dom_object(
42            Box::new(TextTrackList::new_inherited(tracks)),
43            window,
44            can_gc,
45        )
46    }
47
48    pub(crate) fn item(&self, idx: usize) -> Option<DomRoot<TextTrack>> {
49        self.dom_tracks
50            .borrow()
51            .get(idx)
52            .map(|t| DomRoot::from_ref(&**t))
53    }
54
55    pub(crate) fn find(&self, track: &TextTrack) -> Option<usize> {
56        self.dom_tracks
57            .borrow()
58            .iter()
59            .enumerate()
60            .find(|(_, t)| **t == track)
61            .map(|(i, _)| i)
62    }
63
64    pub(crate) fn add(&self, track: &TextTrack) {
65        // Only add a track if it does not exist in the list
66        if self.find(track).is_none() {
67            self.dom_tracks.borrow_mut().push(Dom::from_ref(track));
68
69            let Some(idx) = self.find(track) else {
70                return;
71            };
72
73            let this = Trusted::new(self);
74            self.global()
75                .task_manager()
76                .media_element_task_source()
77                .queue(task!(track_event_queue: move || {
78                    let this = this.root();
79
80                    if let Some(track) = this.item(idx) {
81                        let event = TrackEvent::new(
82                            this.global().as_window(),
83                            atom!("addtrack"),
84                            false,
85                            false,
86                            &Some(VideoTrackOrAudioTrackOrTextTrack::TextTrack(
87                                DomRoot::from_ref(&track)
88                            )),
89                            CanGc::note()
90                        );
91
92                        event.upcast::<Event>().fire(this.upcast::<EventTarget>(), CanGc::note());
93                    }
94                }));
95            track.add_track_list(self);
96        }
97    }
98
99    // FIXME(#22314, dlrobertson) allow TextTracks to be
100    // removed from the TextTrackList.
101    #[allow(dead_code)]
102    pub(crate) fn remove(&self, idx: usize, can_gc: CanGc) {
103        if let Some(track) = self.dom_tracks.borrow().get(idx) {
104            track.remove_track_list();
105        }
106        self.dom_tracks.borrow_mut().remove(idx);
107        self.upcast::<EventTarget>()
108            .fire_event(atom!("removetrack"), can_gc);
109    }
110}
111
112impl TextTrackListMethods<crate::DomTypeHolder> for TextTrackList {
113    // https://html.spec.whatwg.org/multipage/#dom-texttracklist-length
114    fn Length(&self) -> u32 {
115        self.dom_tracks.borrow().len() as u32
116    }
117
118    // https://html.spec.whatwg.org/multipage/#dom-texttracklist-item
119    fn IndexedGetter(&self, idx: u32) -> Option<DomRoot<TextTrack>> {
120        self.item(idx as usize)
121    }
122
123    // https://html.spec.whatwg.org/multipage/#dom-texttracklist-gettrackbyid
124    fn GetTrackById(&self, id: DOMString) -> Option<DomRoot<TextTrack>> {
125        let id_str = String::from(id.clone());
126        self.dom_tracks
127            .borrow()
128            .iter()
129            .find(|track| track.id() == id_str)
130            .map(|t| DomRoot::from_ref(&**t))
131    }
132
133    // https://html.spec.whatwg.org/multipage/#handler-texttracklist-onchange
134    event_handler!(change, GetOnchange, SetOnchange);
135
136    // https://html.spec.whatwg.org/multipage/#handler-texttracklist-onaddtrack
137    event_handler!(addtrack, GetOnaddtrack, SetOnaddtrack);
138
139    // https://html.spec.whatwg.org/multipage/#handler-texttracklist-onremovetrack
140    event_handler!(removetrack, GetOnremovetrack, SetOnremovetrack);
141}
script/dom/texttracklist.rs

script/dom/
texttracklist.rs
