Skip to main content

script/dom/event/
eventtarget.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 std::cell::RefCell;
6use std::collections::hash_map::Entry::{Occupied, Vacant};
7use std::default::Default;
8use std::ffi::CString;
9use std::mem;
10use std::ops::{Deref, DerefMut};
11use std::rc::Rc;
12use std::sync::LazyLock;
13
14use deny_public_fields::DenyPublicFields;
15use devtools_traits::EventListenerInfo;
16use dom_struct::dom_struct;
17use js::context::JSContext;
18use js::jsapi::{JS_GetFunctionObject, SupportUnscopables};
19use js::jsval::JSVal;
20use js::rust::wrappers2::CompileFunction;
21use js::rust::{CompileOptionsWrapper, HandleObject, transform_u16_to_source_text};
22use libc::c_char;
23use rustc_hash::{FxBuildHasher, FxHashSet};
24use script_bindings::callback::OwnerWindow;
25use script_bindings::cell::DomRefCell;
26use script_bindings::cformat;
27use script_bindings::reflector::{DomObject, Reflector, reflect_dom_object_with_proto};
28use servo_constellation_traits::ConstellationInterest;
29use servo_url::ServoUrl;
30use style::str::HTML_SPACE_CHARACTERS;
31use stylo_atoms::Atom;
32
33use crate::conversions::Convert;
34use crate::dom::abortsignal::{AbortAlgorithm, RemovableDomEventListener};
35use crate::dom::beforeunloadevent::BeforeUnloadEvent;
36use crate::dom::bindings::callback::{CallbackContainer, CallbackFunction, ExceptionHandling};
37use crate::dom::bindings::codegen::Bindings::BeforeUnloadEventBinding::BeforeUnloadEventMethods;
38use crate::dom::bindings::codegen::Bindings::ErrorEventBinding::ErrorEventMethods;
39use crate::dom::bindings::codegen::Bindings::EventBinding::EventMethods;
40use crate::dom::bindings::codegen::Bindings::EventHandlerBinding::{
41    EventHandlerNonNull, OnBeforeUnloadEventHandlerNonNull, OnErrorEventHandlerNonNull,
42};
43use crate::dom::bindings::codegen::Bindings::EventListenerBinding::EventListener;
44use crate::dom::bindings::codegen::Bindings::EventTargetBinding::{
45    AddEventListenerOptions, EventListenerOptions, EventTargetMethods,
46};
47use crate::dom::bindings::codegen::Bindings::NodeBinding::GetRootNodeOptions;
48use crate::dom::bindings::codegen::Bindings::NodeBinding::Node_Binding::NodeMethods;
49use crate::dom::bindings::codegen::Bindings::ShadowRootBinding::ShadowRoot_Binding::ShadowRootMethods;
50use crate::dom::bindings::codegen::Bindings::WindowBinding::WindowMethods;
51use crate::dom::bindings::codegen::GenericBindings::DocumentBinding::Document_Binding::DocumentMethods;
52use crate::dom::bindings::codegen::UnionTypes::{
53    AddEventListenerOptionsOrBoolean, EventListenerOptionsOrBoolean, EventOrString,
54};
55use crate::dom::bindings::error::{Error, Fallible, report_pending_exception};
56use crate::dom::bindings::inheritance::Castable;
57use crate::dom::bindings::reflector::DomGlobal;
58use crate::dom::bindings::root::{Dom, DomRoot};
59use crate::dom::bindings::str::DOMString;
60use crate::dom::bindings::trace::HashMapTracedValues;
61use crate::dom::csp::{CspReporting, InlineCheckType};
62use crate::dom::document::Document;
63use crate::dom::element::Element;
64use crate::dom::errorevent::ErrorEvent;
65use crate::dom::event::{Event, EventBubbles, EventCancelable, EventComposed};
66use crate::dom::globalscope::GlobalScope;
67use crate::dom::html::htmlformelement::FormControlElementHelpers;
68use crate::dom::indexeddb::idbdatabase::IDBDatabase;
69use crate::dom::indexeddb::idbrequest::IDBRequest;
70use crate::dom::indexeddb::idbtransaction::IDBTransaction;
71use crate::dom::node::virtualmethods::VirtualMethods;
72use crate::dom::node::{Node, NodeTraits};
73use crate::dom::shadowroot::ShadowRoot;
74use crate::dom::window::Window;
75use crate::dom::workerglobalscope::WorkerGlobalScope;
76use crate::realms::enter_auto_realm;
77use crate::script_runtime::IntroductionType;
78
79/// <https://html.spec.whatwg.org/multipage/#event-handler-content-attributes>
80/// Generated from WebIDL definitions of EventHandler attributes on interfaces
81/// that inherit from Node.
82pub(crate) static CONTENT_EVENT_HANDLER_NAMES: LazyLock<FxHashSet<&str>> = LazyLock::new(|| {
83    FxHashSet::from_iter(include!(concat!(
84        env!("OUT_DIR"),
85        "/ContentEventHandlerNames.rs"
86    )))
87});
88
89#[derive(Clone, JSTraceable, MallocSizeOf, PartialEq)]
90#[expect(clippy::enum_variant_names)]
91pub(crate) enum CommonEventHandler {
92    EventHandler(#[conditional_malloc_size_of] Rc<EventHandlerNonNull>),
93
94    ErrorEventHandler(#[conditional_malloc_size_of] Rc<OnErrorEventHandlerNonNull>),
95
96    BeforeUnloadEventHandler(#[conditional_malloc_size_of] Rc<OnBeforeUnloadEventHandlerNonNull>),
97}
98
99impl CommonEventHandler {
100    fn parent(&self) -> &CallbackFunction<crate::DomTypeHolder> {
101        match *self {
102            CommonEventHandler::EventHandler(ref handler) => &handler.parent,
103            CommonEventHandler::ErrorEventHandler(ref handler) => &handler.parent,
104            CommonEventHandler::BeforeUnloadEventHandler(ref handler) => &handler.parent,
105        }
106    }
107}
108
109#[derive(Clone, Copy, Debug, JSTraceable, MallocSizeOf, PartialEq)]
110pub(crate) enum ListenerPhase {
111    Capturing,
112    Bubbling,
113}
114
115/// <https://html.spec.whatwg.org/multipage/#internal-raw-uncompiled-handler>
116#[derive(Clone, JSTraceable, MallocSizeOf, PartialEq)]
117struct InternalRawUncompiledHandler {
118    source: DOMString,
119    #[no_trace]
120    url: ServoUrl,
121    line: usize,
122}
123
124/// A representation of an event handler, either compiled or uncompiled raw source, or null.
125#[derive(Clone, JSTraceable, MallocSizeOf, PartialEq)]
126enum InlineEventListener {
127    Uncompiled(InternalRawUncompiledHandler),
128    Compiled(CommonEventHandler),
129    Null,
130}
131
132/// Get a compiled representation of this event handler, compiling it from its
133/// raw source if necessary.
134/// <https://html.spec.whatwg.org/multipage/#getting-the-current-value-of-the-event-handler>
135fn get_compiled_handler(
136    cx: &mut JSContext,
137    inline_listener: &RefCell<InlineEventListener>,
138    owner: &EventTarget,
139    ty: &Atom,
140) -> Option<CommonEventHandler> {
141    let listener = mem::replace(
142        &mut *inline_listener.borrow_mut(),
143        InlineEventListener::Null,
144    );
145    let compiled = match listener {
146        InlineEventListener::Null => None,
147        InlineEventListener::Uncompiled(handler) => {
148            owner.get_compiled_event_handler(cx, handler, ty)
149        },
150        InlineEventListener::Compiled(handler) => Some(handler),
151    };
152    if let Some(ref compiled) = compiled {
153        *inline_listener.borrow_mut() = InlineEventListener::Compiled(compiled.clone());
154    }
155    compiled
156}
157
158#[derive(Clone, JSTraceable, MallocSizeOf, PartialEq)]
159enum EventListenerType {
160    Additive(#[conditional_malloc_size_of] Rc<EventListener>),
161    Inline(RefCell<InlineEventListener>),
162}
163
164impl EventListenerType {
165    fn get_compiled_listener(
166        &self,
167        cx: &mut JSContext,
168        owner: &EventTarget,
169        ty: &Atom,
170    ) -> Option<CompiledEventListener> {
171        match *self {
172            EventListenerType::Inline(ref inline) => {
173                get_compiled_handler(cx, inline, owner, ty).map(CompiledEventListener::Handler)
174            },
175            EventListenerType::Additive(ref listener) => {
176                Some(CompiledEventListener::Listener(listener.clone()))
177            },
178        }
179    }
180}
181
182/// A representation of an EventListener/EventHandler object that has previously
183/// been compiled successfully, if applicable.
184pub(crate) enum CompiledEventListener {
185    Listener(Rc<EventListener>),
186    Handler(CommonEventHandler),
187}
188
189impl CompiledEventListener {
190    #[expect(unsafe_code)]
191    pub(crate) fn associated_global(&self) -> DomRoot<GlobalScope> {
192        let obj = match self {
193            CompiledEventListener::Listener(listener) => listener.callback(),
194            CompiledEventListener::Handler(CommonEventHandler::EventHandler(handler)) => {
195                handler.callback()
196            },
197            CompiledEventListener::Handler(CommonEventHandler::ErrorEventHandler(handler)) => {
198                handler.callback()
199            },
200            CompiledEventListener::Handler(CommonEventHandler::BeforeUnloadEventHandler(
201                handler,
202            )) => handler.callback(),
203        };
204        unsafe { GlobalScope::from_object(obj) }
205    }
206
207    // https://html.spec.whatwg.org/multipage/#the-event-handler-processing-algorithm
208    pub(crate) fn call_or_handle_event(
209        &self,
210        cx: &mut JSContext,
211        object: &EventTarget,
212        event: &Event,
213        exception_handle: ExceptionHandling,
214    ) -> Fallible<()> {
215        // Step 3
216        match *self {
217            CompiledEventListener::Listener(ref listener) => {
218                listener.HandleEvent_(cx, object, event, exception_handle)
219            },
220            CompiledEventListener::Handler(ref handler) => {
221                match *handler {
222                    CommonEventHandler::ErrorEventHandler(ref handler) => {
223                        if let Some(event) = event.downcast::<ErrorEvent>() &&
224                            (object.is::<Window>() || object.is::<WorkerGlobalScope>())
225                        {
226                            rooted!(&in(cx) let mut error: JSVal);
227                            event.Error(error.handle_mut());
228                            rooted!(&in(cx) let mut rooted_return_value: JSVal);
229                            let return_value = handler.Call_(
230                                cx,
231                                object,
232                                EventOrString::String(event.Message()),
233                                Some(event.Filename()),
234                                Some(event.Lineno()),
235                                Some(event.Colno()),
236                                Some(error.handle()),
237                                rooted_return_value.handle_mut(),
238                                exception_handle,
239                            );
240                            // Step 4
241                            if let Ok(()) = return_value &&
242                                rooted_return_value.handle().is_boolean() &&
243                                rooted_return_value.handle().to_boolean()
244                            {
245                                event.upcast::<Event>().PreventDefault();
246                            }
247                            return return_value;
248                        }
249
250                        rooted!(&in(cx) let mut rooted_return_value: JSVal);
251                        handler.Call_(
252                            cx,
253                            object,
254                            EventOrString::Event(DomRoot::from_ref(event)),
255                            None,
256                            None,
257                            None,
258                            None,
259                            rooted_return_value.handle_mut(),
260                            exception_handle,
261                        )
262                    },
263
264                    CommonEventHandler::BeforeUnloadEventHandler(ref handler) => {
265                        if let Some(event) = event.downcast::<BeforeUnloadEvent>() {
266                            // Step 5
267                            match handler.Call_(
268                                cx,
269                                object,
270                                event.upcast::<Event>(),
271                                exception_handle,
272                            ) {
273                                Ok(value) => {
274                                    let rv = event.ReturnValue();
275                                    if let Some(v) = value {
276                                        if rv.is_empty() {
277                                            event.SetReturnValue(v);
278                                        }
279                                        event.upcast::<Event>().PreventDefault();
280                                    }
281                                    Ok(())
282                                },
283                                Err(err) => Err(err),
284                            }
285                        } else {
286                            // Step 5, "Otherwise" clause
287                            handler
288                                .Call_(cx, object, event.upcast::<Event>(), exception_handle)
289                                .map(|_| ())
290                        }
291                    },
292
293                    CommonEventHandler::EventHandler(ref handler) => {
294                        rooted!(&in(cx) let mut rooted_return_value: JSVal);
295                        match handler.Call_(
296                            cx,
297                            object,
298                            event,
299                            rooted_return_value.handle_mut(),
300                            exception_handle,
301                        ) {
302                            Ok(()) => {
303                                let value = rooted_return_value.handle();
304
305                                // Step 5
306                                let should_cancel = value.is_boolean() && !value.to_boolean();
307
308                                if should_cancel {
309                                    // FIXME: spec says to set the cancelled flag directly
310                                    // here, not just to prevent default;
311                                    // can that ever make a difference?
312                                    event.PreventDefault();
313                                }
314                                Ok(())
315                            },
316                            Err(err) => Err(err),
317                        }
318                    },
319                }
320            },
321        }
322    }
323}
324
325// https://dom.spec.whatwg.org/#concept-event-listener
326// (as distinct from https://dom.spec.whatwg.org/#callbackdef-eventlistener)
327#[derive(Clone, DenyPublicFields, JSTraceable, MallocSizeOf)]
328/// A listener in a collection of event listeners.
329pub(crate) struct EventListenerEntry {
330    phase: ListenerPhase,
331    listener: EventListenerType,
332    once: bool,
333    passive: bool,
334    removed: bool,
335}
336
337impl EventListenerEntry {
338    pub(crate) fn phase(&self) -> ListenerPhase {
339        self.phase
340    }
341
342    pub(crate) fn once(&self) -> bool {
343        self.once
344    }
345
346    pub(crate) fn removed(&self) -> bool {
347        self.removed
348    }
349
350    /// <https://html.spec.whatwg.org/multipage/#getting-the-current-value-of-the-event-handler>
351    pub(crate) fn get_compiled_listener(
352        &self,
353        cx: &mut JSContext,
354        owner: &EventTarget,
355        ty: &Atom,
356    ) -> Option<CompiledEventListener> {
357        self.listener.get_compiled_listener(cx, owner, ty)
358    }
359}
360
361impl std::cmp::PartialEq for EventListenerEntry {
362    fn eq(&self, other: &Self) -> bool {
363        self.phase == other.phase && self.listener == other.listener
364    }
365}
366
367#[derive(Clone, JSTraceable, MallocSizeOf)]
368/// A mix of potentially uncompiled and compiled event listeners of the same type.
369pub(crate) struct EventListeners(
370    #[conditional_malloc_size_of] Vec<Rc<RefCell<EventListenerEntry>>>,
371);
372
373impl Deref for EventListeners {
374    type Target = Vec<Rc<RefCell<EventListenerEntry>>>;
375    fn deref(&self) -> &Vec<Rc<RefCell<EventListenerEntry>>> {
376        &self.0
377    }
378}
379
380impl DerefMut for EventListeners {
381    fn deref_mut(&mut self) -> &mut Vec<Rc<RefCell<EventListenerEntry>>> {
382        &mut self.0
383    }
384}
385
386impl EventListeners {
387    /// <https://html.spec.whatwg.org/multipage/#getting-the-current-value-of-the-event-handler>
388    fn get_inline_listener(
389        &self,
390        cx: &mut JSContext,
391        owner: &EventTarget,
392        ty: &Atom,
393    ) -> Option<CommonEventHandler> {
394        for entry in &self.0 {
395            if let EventListenerType::Inline(ref inline) = entry.borrow().listener {
396                // Step 1.1-1.8 and Step 2
397                return get_compiled_handler(cx, inline, owner, ty);
398            }
399        }
400
401        // Step 2
402        None
403    }
404
405    fn has_listeners(&self) -> bool {
406        !self.0.is_empty()
407    }
408}
409
410#[dom_struct]
411pub struct EventTarget {
412    reflector_: Reflector,
413    handlers: DomRefCell<HashMapTracedValues<Atom, EventListeners, FxBuildHasher>>,
414}
415
416impl EventTarget {
417    pub(crate) fn new_inherited() -> EventTarget {
418        EventTarget {
419            reflector_: Reflector::new(),
420            handlers: DomRefCell::new(Default::default()),
421        }
422    }
423
424    fn new(
425        cx: &mut JSContext,
426        global: &GlobalScope,
427        proto: Option<HandleObject>,
428    ) -> DomRoot<EventTarget> {
429        reflect_dom_object_with_proto(cx, Box::new(EventTarget::new_inherited()), global, proto)
430    }
431
432    /// Returns the [`ConstellationInterest`] associated with a given event type
433    /// on this specific target, if any. The mapping depends on the concrete type
434    /// of the EventTarget since the same event name can be used in multiple contexts.
435    fn interest_for_event_type(&self, ty: &Atom) -> Option<ConstellationInterest> {
436        if self.is::<Window>() && *ty == atom!("storage") {
437            return Some(ConstellationInterest::StorageEvent);
438        }
439        None
440    }
441
442    /// Notify the global about a listener being added for a given event type.
443    fn notify_listener_added(&self, ty: &Atom) {
444        if let Some(interest) = self.interest_for_event_type(ty) {
445            self.global().register_interest(interest);
446        }
447    }
448
449    /// Notify the global about a listener being removed for a given event type.
450    fn notify_listener_removed(&self, ty: &Atom) {
451        if let Some(interest) = self.interest_for_event_type(ty) {
452            self.global().unregister_interest(interest);
453        }
454    }
455
456    /// Determine if there are any listeners for a given event type.
457    /// See <https://github.com/whatwg/dom/issues/453>.
458    pub(crate) fn has_listeners_for(&self, type_: &Atom) -> bool {
459        match self.handlers.borrow().get(type_) {
460            Some(listeners) => listeners.has_listeners(),
461            None => false,
462        }
463    }
464
465    pub(crate) fn get_listeners_for(&self, type_: &Atom) -> EventListeners {
466        self.handlers
467            .borrow()
468            .get(type_)
469            .map_or(EventListeners(vec![]), |listeners| listeners.clone())
470    }
471
472    pub(crate) fn remove_all_listeners(&self) {
473        let mut handlers = self.handlers.borrow_mut();
474        for (ty, entries) in handlers.iter() {
475            entries
476                .iter()
477                .for_each(|entry| entry.borrow_mut().removed = true);
478            self.notify_listener_removed(ty);
479        }
480
481        *handlers = Default::default();
482    }
483
484    /// <https://dom.spec.whatwg.org/#default-passive-value>
485    fn default_passive_value(&self, ty: &Atom) -> bool {
486        // Return true if all of the following are true:
487        let event_type = ty.to_ascii_lowercase();
488
489        // type is one of "touchstart", "touchmove", "wheel", or "mousewheel"
490        let matches_event_type = matches!(
491            event_type.trim_matches(HTML_SPACE_CHARACTERS),
492            "touchstart" | "touchmove" | "wheel" | "mousewheel"
493        );
494
495        if !matches_event_type {
496            return false;
497        }
498
499        // eventTarget is a Window object
500        if self.is::<Window>() {
501            return true;
502        }
503
504        // or ...
505        if let Some(node) = self.downcast::<Node>() {
506            let node_document = node.owner_document();
507            let event_target = self.upcast::<EventTarget>();
508
509            // is a node whose node document is eventTarget
510            return event_target == node_document.upcast::<EventTarget>()
511                // or is a node whose node document’s document element is eventTarget
512                || node_document.GetDocumentElement().is_some_and(|n| n.upcast::<EventTarget>() == event_target)
513                // or is a node whose node document’s body element is eventTarget
514                || node_document.GetBody().is_some_and(|n| n.upcast::<EventTarget>() == event_target);
515        }
516
517        false
518    }
519
520    /// <https://html.spec.whatwg.org/multipage/#event-handler-attributes:event-handlers-11>
521    fn set_inline_event_listener(&self, ty: Atom, listener: Option<InlineEventListener>) {
522        let mut handlers = self.handlers.borrow_mut();
523        let entries = match handlers.entry(ty.clone()) {
524            Occupied(entry) => entry.into_mut(),
525            Vacant(entry) => entry.insert(EventListeners(vec![])),
526        };
527
528        let idx = entries
529            .iter()
530            .position(|entry| matches!(entry.borrow().listener, EventListenerType::Inline(_)));
531
532        match idx {
533            Some(idx) => match listener {
534                // Replace if there's something to replace with,
535                // but remove entirely if there isn't.
536                Some(listener) => {
537                    entries[idx].borrow_mut().listener = EventListenerType::Inline(listener.into());
538                },
539                None => {
540                    entries.remove(idx).borrow_mut().removed = true;
541                    self.notify_listener_removed(&ty);
542                },
543            },
544            None => {
545                if let Some(listener) = listener {
546                    entries.push(Rc::new(RefCell::new(EventListenerEntry {
547                        phase: ListenerPhase::Bubbling,
548                        listener: EventListenerType::Inline(listener.into()),
549                        once: false,
550                        passive: self.default_passive_value(&ty),
551                        removed: false,
552                    })));
553                    self.notify_listener_added(&ty)
554                }
555            },
556        }
557    }
558
559    pub(crate) fn remove_listener(&self, ty: &Atom, entry: &Rc<RefCell<EventListenerEntry>>) {
560        let mut handlers = self.handlers.borrow_mut();
561
562        if let Some(entries) = handlers.get_mut(ty) &&
563            let Some(position) = entries.iter().position(|e| *e == *entry)
564        {
565            entries.remove(position).borrow_mut().removed = true;
566            self.notify_listener_removed(ty);
567        }
568    }
569
570    /// Determines the `passive` attribute of an associated event listener
571    pub(crate) fn is_passive(&self, listener: &Rc<RefCell<EventListenerEntry>>) -> bool {
572        listener.borrow().passive
573    }
574
575    /// Determines if there are any non-passive listeners for a given event type.
576    pub(crate) fn has_non_passive_listener(&self, type_: &Atom) -> bool {
577        self.get_listeners_for(type_)
578            .iter()
579            .any(|listener| !self.is_passive(listener))
580    }
581
582    fn get_inline_event_listener(
583        &self,
584        cx: &mut JSContext,
585        ty: &Atom,
586    ) -> Option<CommonEventHandler> {
587        let handlers = self.handlers.borrow();
588        handlers
589            .get(ty)
590            .and_then(|entry| entry.get_inline_listener(cx, self, ty))
591    }
592
593    /// Store the raw uncompiled event handler for on-demand compilation later.
594    /// <https://html.spec.whatwg.org/multipage/#event-handler-attributes:event-handler-content-attributes-3>
595    pub(crate) fn set_event_handler_uncompiled(
596        &self,
597        cx: &mut JSContext,
598        url: ServoUrl,
599        line: usize,
600        ty: &str,
601        source: &str,
602    ) {
603        if let Some(element) = self.downcast::<Element>() {
604            let doc = element.owner_document();
605            let global = &doc.global();
606            if global
607                .get_csp_list()
608                .should_elements_inline_type_behavior_be_blocked(
609                    cx,
610                    global,
611                    element.upcast(),
612                    InlineCheckType::ScriptAttribute,
613                    source,
614                    line as u32,
615                )
616            {
617                return;
618            }
619        };
620
621        let handler = InternalRawUncompiledHandler {
622            source: DOMString::from(source),
623            line,
624            url,
625        };
626        self.set_inline_event_listener(
627            Atom::from(ty),
628            Some(InlineEventListener::Uncompiled(handler)),
629        );
630    }
631
632    // https://html.spec.whatwg.org/multipage/#getting-the-current-value-of-the-event-handler
633    // step 3
634    #[expect(unsafe_code)]
635    fn get_compiled_event_handler(
636        &self,
637        cx: &mut JSContext,
638        handler: InternalRawUncompiledHandler,
639        ty: &Atom,
640    ) -> Option<CommonEventHandler> {
641        // Step 3.1
642        let element = self.downcast::<Element>();
643        let document = match element {
644            Some(element) => element.owner_document(),
645            None => self.downcast::<Window>().unwrap().Document(),
646        };
647
648        // Step 3.2
649        if !document.scripting_enabled() {
650            return None;
651        }
652
653        // Step 3.3
654        let body: Vec<u16> = handler.source.str().encode_utf16().collect();
655
656        // Step 3.4 is handler.line
657
658        // Step 3.5
659        let form_owner = element
660            .and_then(|e| e.as_maybe_form_control())
661            .and_then(|f| f.form_owner());
662
663        // Step 3.6 TODO: settings objects not implemented
664
665        // Step 3.7 is written as though we call the parser separately
666        // from the compiler; since we just call CompileFunction with
667        // source text, we handle parse errors later
668
669        // Step 3.8 TODO: settings objects not implemented
670        let window = document.window();
671        let mut realm = enter_auto_realm(cx, window);
672        let cx = &mut realm.current_realm();
673
674        // Step 3.9
675
676        let name = CString::new(format!("on{}", &**ty)).unwrap();
677
678        // Step 3.9, subsection ParameterList
679        const ARG_NAMES: &[*const c_char] = &[c"event".as_ptr()];
680        const ERROR_ARG_NAMES: &[*const c_char] = &[
681            c"event".as_ptr(),
682            c"source".as_ptr(),
683            c"lineno".as_ptr(),
684            c"colno".as_ptr(),
685            c"error".as_ptr(),
686        ];
687        let is_error = ty == &atom!("error") && self.is::<Window>();
688        let args = if is_error { ERROR_ARG_NAMES } else { ARG_NAMES };
689
690        let url = cformat!("{}", handler.url);
691        let mut options = CompileOptionsWrapper::new(cx, url, handler.line as u32);
692        options.set_introduction_type(IntroductionType::EVENT_HANDLER);
693
694        // Step 3.9, subsection Scope steps 1-6
695        let scopechain =
696            js::rust::EnvironmentChain::new(unsafe { cx.raw_cx() }, SupportUnscopables::Yes);
697
698        if let Some(element) = element {
699            scopechain.append(document.reflector().get_jsobject().get());
700            if let Some(form_owner) = form_owner {
701                scopechain.append(form_owner.reflector().get_jsobject().get());
702            }
703            scopechain.append(element.reflector().get_jsobject().get());
704        }
705
706        rooted!(&in(cx) let mut handler = unsafe {
707            CompileFunction(
708                cx,
709                scopechain.get(),
710                options.ptr,
711                name.as_ptr(),
712                args.len() as u32,
713                args.as_ptr(),
714                &mut transform_u16_to_source_text(&body),
715            )
716        });
717        if handler.get().is_null() {
718            // Step 3.7
719            let mut realm = enter_auto_realm(cx, self);
720            report_pending_exception(&mut realm.current_realm());
721            return None;
722        }
723
724        // Step 3.10 happens when we drop _ac
725
726        // TODO Step 3.11
727
728        // Step 3.12
729        let funobj = unsafe { JS_GetFunctionObject(handler.get()) };
730        assert!(!funobj.is_null());
731        // Step 1.14
732        if is_error {
733            Some(CommonEventHandler::ErrorEventHandler(unsafe {
734                OnErrorEventHandlerNonNull::new(cx, funobj)
735            }))
736        } else if ty == &atom!("beforeunload") {
737            Some(CommonEventHandler::BeforeUnloadEventHandler(unsafe {
738                OnBeforeUnloadEventHandlerNonNull::new(cx, funobj)
739            }))
740        } else {
741            Some(CommonEventHandler::EventHandler(unsafe {
742                EventHandlerNonNull::new(cx, funobj)
743            }))
744        }
745    }
746
747    #[expect(unsafe_code)]
748    pub(crate) fn set_event_handler_common<T: CallbackContainer<crate::DomTypeHolder>>(
749        &self,
750        cx: &mut JSContext,
751        ty: &str,
752        listener: Option<Rc<T>>,
753    ) {
754        let event_listener = listener.map(|listener| {
755            InlineEventListener::Compiled(CommonEventHandler::EventHandler(unsafe {
756                EventHandlerNonNull::new(cx, listener.callback())
757            }))
758        });
759        self.set_inline_event_listener(Atom::from(ty), event_listener);
760    }
761
762    #[expect(unsafe_code)]
763    pub(crate) fn set_error_event_handler<T: CallbackContainer<crate::DomTypeHolder>>(
764        &self,
765        cx: &mut JSContext,
766        ty: &str,
767        listener: Option<Rc<T>>,
768    ) {
769        let event_listener = listener.map(|listener| {
770            InlineEventListener::Compiled(CommonEventHandler::ErrorEventHandler(unsafe {
771                OnErrorEventHandlerNonNull::new(cx, listener.callback())
772            }))
773        });
774        self.set_inline_event_listener(Atom::from(ty), event_listener);
775    }
776
777    #[expect(unsafe_code)]
778    pub(crate) fn set_beforeunload_event_handler<T: CallbackContainer<crate::DomTypeHolder>>(
779        &self,
780        cx: &mut JSContext,
781        ty: &str,
782        listener: Option<Rc<T>>,
783    ) {
784        let event_listener = listener.map(|listener| {
785            InlineEventListener::Compiled(CommonEventHandler::BeforeUnloadEventHandler(unsafe {
786                OnBeforeUnloadEventHandlerNonNull::new(cx, listener.callback())
787            }))
788        });
789        self.set_inline_event_listener(Atom::from(ty), event_listener);
790    }
791
792    #[expect(unsafe_code)]
793    pub(crate) fn get_event_handler_common<T: CallbackContainer<crate::DomTypeHolder>>(
794        &self,
795        cx: &mut JSContext,
796        ty: &str,
797    ) -> Option<Rc<T>> {
798        let listener = self.get_inline_event_listener(cx, &Atom::from(ty));
799        unsafe {
800            listener.map(|listener| {
801                CallbackContainer::new(cx, listener.parent().callback_holder().get())
802            })
803        }
804    }
805
806    pub(crate) fn has_handlers(&self) -> bool {
807        !self.handlers.borrow().is_empty()
808    }
809
810    // https://dom.spec.whatwg.org/#concept-event-fire
811    pub(crate) fn fire_event(&self, cx: &mut js::context::JSContext, name: Atom) -> bool {
812        self.fire_event_with_params(
813            cx,
814            name,
815            EventBubbles::DoesNotBubble,
816            EventCancelable::NotCancelable,
817            EventComposed::NotComposed,
818        )
819    }
820
821    // https://dom.spec.whatwg.org/#concept-event-fire
822    pub(crate) fn fire_bubbling_event(&self, cx: &mut js::context::JSContext, name: Atom) -> bool {
823        self.fire_event_with_params(
824            cx,
825            name,
826            EventBubbles::Bubbles,
827            EventCancelable::NotCancelable,
828            EventComposed::NotComposed,
829        )
830    }
831
832    // https://dom.spec.whatwg.org/#concept-event-fire
833    pub(crate) fn fire_cancelable_event(
834        &self,
835        cx: &mut js::context::JSContext,
836        name: Atom,
837    ) -> bool {
838        self.fire_event_with_params(
839            cx,
840            name,
841            EventBubbles::DoesNotBubble,
842            EventCancelable::Cancelable,
843            EventComposed::NotComposed,
844        )
845    }
846
847    // https://dom.spec.whatwg.org/#concept-event-fire
848    pub(crate) fn fire_bubbling_cancelable_event(
849        &self,
850        cx: &mut js::context::JSContext,
851        name: Atom,
852    ) -> bool {
853        self.fire_event_with_params(
854            cx,
855            name,
856            EventBubbles::Bubbles,
857            EventCancelable::Cancelable,
858            EventComposed::NotComposed,
859        )
860    }
861
862    /// <https://dom.spec.whatwg.org/#concept-event-fire>
863    pub(crate) fn fire_event_with_params(
864        &self,
865        cx: &mut js::context::JSContext,
866        name: Atom,
867        bubbles: EventBubbles,
868        cancelable: EventCancelable,
869        composed: EventComposed,
870    ) -> bool {
871        let event = Event::new(cx, &self.global(), name, bubbles, cancelable);
872        event.set_composed(composed.into());
873        event.fire(cx, self)
874    }
875
876    /// <https://dom.spec.whatwg.org/#dom-eventtarget-addeventlistener>
877    /// and <https://dom.spec.whatwg.org/#add-an-event-listener>
878    pub(crate) fn add_event_listener(
879        &self,
880        ty: DOMString,
881        listener: Option<Rc<EventListener>>,
882        options: AddEventListenerOptions,
883    ) {
884        if let Some(signal) = options.signal.as_ref() {
885            // Step 2. If listener’s signal is not null and is aborted, then return.
886            if signal.aborted() {
887                return;
888            }
889            // Step 6. If listener’s signal is not null, then add the following abort steps to it:
890            signal.add(&AbortAlgorithm::DomEventListener(
891                RemovableDomEventListener {
892                    event_target: Dom::from_ref(self),
893                    ty: ty.clone(),
894                    listener: listener.clone(),
895                    options: options.parent.clone(),
896                },
897            ));
898        }
899        // Step 3. If listener’s callback is null, then return.
900        let listener = match listener {
901            Some(l) => l,
902            None => return,
903        };
904        let ty = Atom::from(ty);
905        let mut handlers = self.handlers.borrow_mut();
906        let entries = match handlers.entry(ty.clone()) {
907            Occupied(entry) => entry.into_mut(),
908            Vacant(entry) => entry.insert(EventListeners(vec![])),
909        };
910
911        let phase = if options.parent.capture {
912            ListenerPhase::Capturing
913        } else {
914            ListenerPhase::Bubbling
915        };
916        // Step 4. If listener’s passive is null, then set it to the default passive value given listener’s type and eventTarget.
917        let new_entry = Rc::new(RefCell::new(EventListenerEntry {
918            phase,
919            listener: EventListenerType::Additive(listener),
920            once: options.once,
921            passive: options.passive.unwrap_or(self.default_passive_value(&ty)),
922            removed: false,
923        }));
924
925        // Step 5. If eventTarget’s event listener list does not contain
926        // an event listener whose type is listener’s type, callback is listener’s callback,
927        // and capture is listener’s capture, then append listener to eventTarget’s event listener list.
928        if !entries.contains(&new_entry) {
929            entries.push(new_entry);
930            self.notify_listener_added(&ty);
931        }
932    }
933
934    /// <https://dom.spec.whatwg.org/#dom-eventtarget-removeeventlistener>
935    /// and <https://dom.spec.whatwg.org/#remove-an-event-listener>
936    pub(crate) fn remove_event_listener(
937        &self,
938        ty: DOMString,
939        listener: &Option<Rc<EventListener>>,
940        options: &EventListenerOptions,
941    ) {
942        let Some(listener) = listener else {
943            return;
944        };
945        let ty_atom = Atom::from(ty);
946        let mut handlers = self.handlers.borrow_mut();
947        if let Some(entries) = handlers.get_mut(&ty_atom) {
948            let phase = if options.capture {
949                ListenerPhase::Capturing
950            } else {
951                ListenerPhase::Bubbling
952            };
953            let listener_type = EventListenerType::Additive(listener.clone());
954            if let Some(position) = entries
955                .iter()
956                .position(|e| e.borrow().listener == listener_type && e.borrow().phase == phase)
957            {
958                // Step 2. Set listener’s removed to true and remove listener from eventTarget’s event listener list.
959                entries.remove(position).borrow_mut().removed = true;
960                self.notify_listener_removed(&ty_atom);
961            }
962        }
963    }
964
965    /// <https://dom.spec.whatwg.org/#get-the-parent>
966    pub(crate) fn get_the_parent(&self, event: &Event) -> Option<DomRoot<EventTarget>> {
967        if let Some(document) = self.downcast::<Document>() {
968            if event.type_() == atom!("load") || !document.has_browsing_context() {
969                return None;
970            } else {
971                return Some(DomRoot::from_ref(document.window().upcast::<EventTarget>()));
972            }
973        }
974
975        if let Some(shadow_root) = self.downcast::<ShadowRoot>() {
976            if event.should_pass_shadow_boundary(shadow_root) {
977                let host = shadow_root.Host();
978                return Some(DomRoot::from_ref(host.upcast::<EventTarget>()));
979            } else {
980                return None;
981            }
982        }
983
984        if let Some(node) = self.downcast::<Node>() {
985            // > A node’s get the parent algorithm, given an event, returns the node’s assigned slot,
986            // > if node is assigned; otherwise node’s parent.
987            return node.assigned_slot().map(DomRoot::upcast).or_else(|| {
988                node.GetParentNode()
989                    .map(|parent| DomRoot::from_ref(parent.upcast::<EventTarget>()))
990            });
991        }
992
993        // https://w3c.github.io/IndexedDB/#events
994        // The get the parent algorithm for an IDBRequest returns the request's transaction.
995        if let Some(request) = self.downcast::<IDBRequest>() {
996            return request
997                .transaction()
998                .map(|tx| DomRoot::from_ref(tx.upcast::<EventTarget>()));
999        }
1000
1001        // The get the parent algorithm for an IDBTransaction returns the transaction's connection.
1002        if let Some(transaction) = self.downcast::<IDBTransaction>() {
1003            return Some(DomRoot::from_ref(
1004                transaction.get_db().upcast::<EventTarget>(),
1005            ));
1006        }
1007
1008        // The get the parent algorithm for an IDBDatabase returns null.
1009        if self.is::<IDBDatabase>() {
1010            return None;
1011        }
1012
1013        None
1014    }
1015
1016    // FIXME: This algorithm operates on "objects", which may not be event targets.
1017    // All our current use-cases only work on event targets, but this might change in the future
1018    /// <https://dom.spec.whatwg.org/#retarget>
1019    pub(crate) fn retarget(&self, b: &Self) -> DomRoot<EventTarget> {
1020        // To retarget an object A against an object B, repeat these steps until they return an object:
1021        let mut a = DomRoot::from_ref(self);
1022        loop {
1023            // Step 1. If one of the following is true
1024            // * A is not a node
1025            // * A’s root is not a shadow root
1026            // * B is a node and A’s root is a shadow-including inclusive ancestor of B
1027            // then return A.
1028            let Some(a_node) = a.downcast::<Node>() else {
1029                return a;
1030            };
1031            let a_root = a_node.GetRootNode(&GetRootNodeOptions::empty());
1032            if !a_root.is::<ShadowRoot>() {
1033                return a;
1034            }
1035            if let Some(b_node) = b.downcast::<Node>() &&
1036                a_root.is_shadow_including_inclusive_ancestor_of(b_node)
1037            {
1038                return a;
1039            }
1040
1041            // Step 2. Set A to A’s root’s host.
1042            a = DomRoot::from_ref(
1043                a_root
1044                    .downcast::<ShadowRoot>()
1045                    .unwrap()
1046                    .Host()
1047                    .upcast::<EventTarget>(),
1048            );
1049        }
1050    }
1051
1052    /// <https://html.spec.whatwg.org/multipage/#event-handler-content-attributes>
1053    pub(crate) fn is_content_event_handler(name: &str) -> bool {
1054        CONTENT_EVENT_HANDLER_NAMES.contains(&name)
1055    }
1056
1057    pub(crate) fn summarize_event_listeners_for_devtools(&self) -> Vec<EventListenerInfo> {
1058        let handlers = self.handlers.borrow();
1059        let mut listener_infos = Vec::with_capacity(handlers.0.len());
1060        for (event_type, event_listeners) in &handlers.0 {
1061            for event_listener in event_listeners.iter() {
1062                let event_listener_entry = event_listener.borrow();
1063                listener_infos.push(EventListenerInfo {
1064                    event_type: event_type.to_string(),
1065                    capturing: event_listener_entry.phase() == ListenerPhase::Capturing,
1066                });
1067            }
1068        }
1069
1070        listener_infos
1071    }
1072}
1073
1074impl EventTargetMethods<crate::DomTypeHolder> for EventTarget {
1075    /// <https://dom.spec.whatwg.org/#dom-eventtarget-eventtarget>
1076    fn Constructor(
1077        cx: &mut JSContext,
1078        global: &GlobalScope,
1079        proto: Option<HandleObject>,
1080    ) -> Fallible<DomRoot<EventTarget>> {
1081        Ok(EventTarget::new(cx, global, proto))
1082    }
1083
1084    /// <https://dom.spec.whatwg.org/#dom-eventtarget-addeventlistener>
1085    fn AddEventListener(
1086        &self,
1087        ty: DOMString,
1088        listener: Option<Rc<EventListener>>,
1089        options: AddEventListenerOptionsOrBoolean,
1090    ) {
1091        self.add_event_listener(ty, listener, options.convert())
1092    }
1093
1094    /// <https://dom.spec.whatwg.org/#dom-eventtarget-removeeventlistener>
1095    fn RemoveEventListener(
1096        &self,
1097        ty: DOMString,
1098        listener: Option<Rc<EventListener>>,
1099        options: EventListenerOptionsOrBoolean,
1100    ) {
1101        self.remove_event_listener(ty, &listener, &options.convert())
1102    }
1103
1104    /// <https://dom.spec.whatwg.org/#dom-eventtarget-dispatchevent>
1105    fn DispatchEvent(&self, cx: &mut JSContext, event: &Event) -> Fallible<bool> {
1106        if event.dispatching() || !event.initialized() {
1107            return Err(Error::InvalidState(None));
1108        }
1109        event.set_trusted(false);
1110        Ok(event.dispatch(cx, self, false))
1111    }
1112}
1113
1114impl VirtualMethods for EventTarget {
1115    fn super_type(&self) -> Option<&dyn VirtualMethods> {
1116        None
1117    }
1118}
1119
1120impl Convert<AddEventListenerOptions> for AddEventListenerOptionsOrBoolean {
1121    /// <https://dom.spec.whatwg.org/#event-flatten-more>
1122    fn convert(self) -> AddEventListenerOptions {
1123        // Step 1. Let capture be the result of flattening options.
1124        // Step 5. Return capture, passive, once, and signal.
1125        match self {
1126            // Step 4. If options is a dictionary:
1127            AddEventListenerOptionsOrBoolean::AddEventListenerOptions(options) => options,
1128            AddEventListenerOptionsOrBoolean::Boolean(capture) => AddEventListenerOptions {
1129                parent: EventListenerOptions { capture },
1130                // Step 2. Let once be false.
1131                once: false,
1132                // Step 3. Let passive and signal be null.
1133                passive: None,
1134                signal: None,
1135            },
1136        }
1137    }
1138}
1139
1140impl Convert<EventListenerOptions> for EventListenerOptionsOrBoolean {
1141    fn convert(self) -> EventListenerOptions {
1142        match self {
1143            EventListenerOptionsOrBoolean::EventListenerOptions(options) => options,
1144            EventListenerOptionsOrBoolean::Boolean(capture) => EventListenerOptions { capture },
1145        }
1146    }
1147}
1148
1149impl OwnerWindow<crate::DomTypeHolder> for EventTarget {
1150    fn owner_window(&self) -> Option<DomRoot<Window>> {
1151        self.downcast::<Node>().map(|node| node.owner_window())
1152    }
1153}