Skip to main content

script/dom/debugger/
debuggergetenvironmentevent.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::fmt::Debug;
6
7use devtools_traits::GetEnvironmentRequest;
8use dom_struct::dom_struct;
9use js::context::JSContext;
10use script_bindings::domstring::TracedDOMString;
11use script_bindings::inheritance::Castable;
12use script_bindings::reflector::reflect_dom_object;
13use script_bindings::str::DOMString;
14
15use crate::dom::GlobalScope;
16use crate::dom::bindings::codegen::Bindings::DebuggerGetEnvironmentEventBinding::DebuggerGetEnvironmentEventMethods;
17use crate::dom::bindings::codegen::Bindings::EventBinding::Event_Binding::EventMethods;
18use crate::dom::bindings::root::{Dom, DomRoot};
19use crate::dom::event::Event;
20use crate::dom::pipelineid::PipelineId;
21use crate::dom::types::DebuggerGlobalScope;
22
23#[dom_struct]
24/// Event for Rust → JS calls in [`crate::dom::debugger::DebuggerGlobalScope`].
25pub(crate) struct DebuggerGetEnvironmentEvent {
26    event: Event,
27    frame_actor_id: Option<TracedDOMString>,
28    pipeline_id: Option<Dom<PipelineId>>,
29}
30
31impl DebuggerGetEnvironmentEvent {
32    pub(crate) fn new(
33        cx: &mut JSContext,
34        debugger_global_scope: &DebuggerGlobalScope,
35        request: GetEnvironmentRequest,
36    ) -> DomRoot<Self> {
37        let result = Box::new(match request {
38            GetEnvironmentRequest::Frame(frame_actor_id) => Self {
39                event: Event::new_inherited(),
40                frame_actor_id: Some(frame_actor_id.into()),
41                pipeline_id: None,
42            },
43            GetEnvironmentRequest::Global(debuggee_pipeline_id) => {
44                let debuggee_pipeline_id =
45                    PipelineId::new(cx, debugger_global_scope.upcast(), debuggee_pipeline_id);
46                Self {
47                    event: Event::new_inherited(),
48                    frame_actor_id: None,
49                    pipeline_id: Some(Dom::from_ref(&debuggee_pipeline_id)),
50                }
51            },
52        });
53        let result = reflect_dom_object(cx, result, debugger_global_scope.upcast::<GlobalScope>());
54        result
55            .event
56            .init_event("getEnvironment".into(), false, false);
57
58        result
59    }
60}
61
62impl DebuggerGetEnvironmentEventMethods<crate::DomTypeHolder> for DebuggerGetEnvironmentEvent {
63    // check-tidy: no specs after this line
64    fn GetFrameActorId(&self) -> Option<DOMString> {
65        self.frame_actor_id
66            .clone()
67            .map(|domstring| domstring.root())
68    }
69
70    fn GetPipelineId(&self) -> Option<DomRoot<PipelineId>> {
71        self.pipeline_id.as_deref().map(DomRoot::from_ref)
72    }
73
74    fn IsTrusted(&self) -> bool {
75        self.event.IsTrusted()
76    }
77}
78
79impl Debug for DebuggerGetEnvironmentEvent {
80    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
81        f.debug_struct("DebuggerGetEnvironmentEvent").finish()
82    }
83}