/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at https://mozilla.org/MPL/2.0/. */ use std::borrow::{Cow, ToOwned}; use std::cell::{Cell, RefCell, RefMut}; use std::cmp; use std::collections::hash_map::Entry; use std::collections::{HashMap, HashSet}; use std::default::Default; use std::io::{Write, stderr, stdout}; use std::rc::Rc; use std::sync::{Arc, Mutex}; use std::time::{Duration, Instant}; use app_units::Au; use backtrace::Backtrace; use base::cross_process_instant::CrossProcessInstant; use base::id::{BrowsingContextId, PipelineId, WebViewId}; use base64::Engine; #[cfg(feature = "bluetooth")] use bluetooth_traits::BluetoothRequest; use canvas_traits::webgl::WebGLChan; use constellation_traits::{ScrollState, WindowSizeData, WindowSizeType}; use crossbeam_channel::{Sender, unbounded}; use cssparser::{Parser, ParserInput, SourceLocation}; use devtools_traits::{ScriptToDevtoolsControlMsg, TimelineMarker, TimelineMarkerType}; use dom_struct::dom_struct; use embedder_traits::{ AlertResponse, ConfirmResponse, EmbedderMsg, PromptResponse, SimpleDialog, Theme, WebDriverJSError, WebDriverJSResult, }; use euclid::default::{Point2D as UntypedPoint2D, Rect as UntypedRect}; use euclid::{Point2D, Rect, Scale, Size2D, Vector2D}; use fonts::FontContext; use ipc_channel::ipc::{self, IpcSender}; use js::conversions::ToJSValConvertible; use js::glue::DumpJSStack; use js::jsapi::{ GCReason, Heap, JS_GC, JSAutoRealm, JSContext as RawJSContext, JSObject, JSPROP_ENUMERATE, }; use js::jsval::{NullValue, UndefinedValue}; use js::rust::wrappers::JS_DefineProperty; use js::rust::{ CustomAutoRooter, CustomAutoRooterGuard, HandleObject, HandleValue, MutableHandleObject, MutableHandleValue, }; use malloc_size_of::MallocSizeOf; use media::WindowGLContext; use net_traits::ResourceThreads; use net_traits::image_cache::{ ImageCache, ImageResponder, ImageResponse, PendingImageId, PendingImageResponse, }; use net_traits::storage_thread::StorageType; use num_traits::ToPrimitive; use profile_traits::ipc as ProfiledIpc; use profile_traits::mem::ProfilerChan as MemProfilerChan; use profile_traits::time::ProfilerChan as TimeProfilerChan; use script_layout_interface::{ FragmentType, Layout, PendingImageState, QueryMsg, Reflow, ReflowGoal, ReflowRequest, TrustedNodeAddress, combine_id_with_fragment_type, }; use script_traits::{ DocumentState, LoadData, LoadOrigin, NavigationHistoryBehavior, ScriptMsg, ScriptThreadMessage, ScriptToConstellationChan, StructuredSerializedData, }; use selectors::attr::CaseSensitivity; use servo_arc::Arc as ServoArc; use servo_config::{opts, pref}; use servo_geometry::{DeviceIndependentIntRect, MaxRect, f32_rect_to_au_rect}; use servo_url::{ImmutableOrigin, MutableOrigin, ServoUrl}; use style::dom::OpaqueNode; use style::error_reporting::{ContextualParseError, ParseErrorReporter}; use style::media_queries; use style::parser::ParserContext as CssParserContext; use style::properties::PropertyId; use style::properties::style_structs::Font; use style::queries::values::PrefersColorScheme; use style::selector_parser::PseudoElement; use style::str::HTML_SPACE_CHARACTERS; use style::stylesheets::{CssRuleType, Origin, UrlExtraData}; use style_traits::{CSSPixel, ParsingMode}; use stylo_atoms::Atom; use url::Position; use webrender_api::units::{DevicePixel, LayoutPixel}; use webrender_api::{DocumentId, ExternalScrollId}; use webrender_traits::CrossProcessCompositorApi; use super::bindings::codegen::Bindings::MessagePortBinding::StructuredSerializeOptions; use super::bindings::trace::HashMapTracedValues; use crate::dom::bindings::cell::{DomRefCell, Ref}; use crate::dom::bindings::codegen::Bindings::DocumentBinding::{ DocumentMethods, DocumentReadyState, NamedPropertyValue, }; use crate::dom::bindings::codegen::Bindings::HTMLIFrameElementBinding::HTMLIFrameElementMethods; use crate::dom::bindings::codegen::Bindings::HistoryBinding::History_Binding::HistoryMethods; use crate::dom::bindings::codegen::Bindings::ImageBitmapBinding::{ ImageBitmapOptions, ImageBitmapSource, }; use crate::dom::bindings::codegen::Bindings::MediaQueryListBinding::MediaQueryList_Binding::MediaQueryListMethods; use crate::dom::bindings::codegen::Bindings::RequestBinding::RequestInit; use crate::dom::bindings::codegen::Bindings::VoidFunctionBinding::VoidFunction; use crate::dom::bindings::codegen::Bindings::WindowBinding::{ self, FrameRequestCallback, ScrollBehavior, ScrollToOptions, WindowMethods, WindowPostMessageOptions, }; use crate::dom::bindings::codegen::UnionTypes::{RequestOrUSVString, StringOrFunction}; use crate::dom::bindings::error::{Error, ErrorResult, Fallible}; use crate::dom::bindings::inheritance::{Castable, ElementTypeId, HTMLElementTypeId, NodeTypeId}; use crate::dom::bindings::num::Finite; use crate::dom::bindings::refcounted::Trusted; use crate::dom::bindings::reflector::{DomGlobal, DomObject}; use crate::dom::bindings::root::{Dom, DomRoot, MutNullableDom}; use crate::dom::bindings::str::{DOMString, USVString}; use crate::dom::bindings::structuredclone; use crate::dom::bindings::trace::{CustomTraceable, JSTraceable, RootedTraceableBox}; use crate::dom::bindings::utils::GlobalStaticData; use crate::dom::bindings::weakref::DOMTracker; #[cfg(feature = "bluetooth")] use crate::dom::bluetooth::BluetoothExtraPermissionData; use crate::dom::crypto::Crypto; use crate::dom::cssstyledeclaration::{CSSModificationAccess, CSSStyleDeclaration, CSSStyleOwner}; use crate::dom::customelementregistry::CustomElementRegistry; use crate::dom::document::{AnimationFrameCallback, Document, ReflowTriggerCondition}; use crate::dom::element::Element; use crate::dom::event::{Event, EventBubbles, EventCancelable, EventStatus}; use crate::dom::eventtarget::EventTarget; use crate::dom::globalscope::GlobalScope; use crate::dom::hashchangeevent::HashChangeEvent; use crate::dom::history::History; use crate::dom::htmlcollection::{CollectionFilter, HTMLCollection}; use crate::dom::htmliframeelement::HTMLIFrameElement; use crate::dom::location::Location; use crate::dom::mediaquerylist::{MediaQueryList, MediaQueryListMatchState}; use crate::dom::mediaquerylistevent::MediaQueryListEvent; use crate::dom::messageevent::MessageEvent; use crate::dom::navigator::Navigator; use crate::dom::node::{Node, NodeDamage, NodeTraits, from_untrusted_node_address}; use crate::dom::performance::Performance; use crate::dom::promise::Promise; use crate::dom::screen::Screen; use crate::dom::selection::Selection; use crate::dom::storage::Storage; #[cfg(feature = "bluetooth")] use crate::dom::testrunner::TestRunner; use crate::dom::types::UIEvent; use crate::dom::webglrenderingcontext::WebGLCommandSender; #[cfg(feature = "webgpu")] use crate::dom::webgpu::identityhub::IdentityHub; use crate::dom::windowproxy::{WindowProxy, WindowProxyHandler}; use crate::dom::worklet::Worklet; use crate::dom::workletglobalscope::WorkletGlobalScopeType; use crate::layout_image::fetch_image_for_layout; use crate::messaging::{MainThreadScriptMsg, ScriptEventLoopReceiver, ScriptEventLoopSender}; use crate::microtask::MicrotaskQueue; use crate::realms::{InRealm, enter_realm}; use crate::script_runtime::{CanGc, JSContext, Runtime}; use crate::script_thread::ScriptThread; use crate::timers::{IsInterval, TimerCallback}; use crate::unminify::unminified_path; use crate::webdriver_handlers::jsval_to_webdriver; use crate::{fetch, window_named_properties}; /// A callback to call when a response comes back from the `ImageCache`. /// /// This is wrapped in a struct so that we can implement `MallocSizeOf` /// for this type. #[derive(MallocSizeOf)] pub struct PendingImageCallback( #[ignore_malloc_size_of = "dyn Fn is currently impossible to measure"] Box, ); /// Current state of the window object #[derive(Clone, Copy, Debug, JSTraceable, MallocSizeOf, PartialEq)] enum WindowState { Alive, Zombie, // Pipeline is closed, but the window hasn't been GCed yet. } /// How long we should wait before performing the initial reflow after `` is parsed, /// assuming that `` take this long to parse. const INITIAL_REFLOW_DELAY: Duration = Duration::from_millis(200); /// During loading and parsing, layouts are suppressed to avoid flashing incomplete page /// contents. /// /// Exceptions: /// - Parsing the body takes so long, that layouts are no longer suppressed in order /// to show the user that the page is loading. /// - Script triggers a layout query or scroll event in which case, we want to layout /// but not display the contents. /// /// For more information see: . #[derive(Clone, Copy, MallocSizeOf)] enum LayoutBlocker { /// The first load event hasn't been fired and we have not started to parse the `` yet. WaitingForParse, /// The body is being parsed the `` starting at the `Instant` specified. Parsing(Instant), /// The body finished parsing and the `load` event has been fired or parsing took so /// long, that we are going to do layout anyway. Note that subsequent changes to the body /// can trigger parsing again, but the `Window` stays in this state. FiredLoadEventOrParsingTimerExpired, } impl LayoutBlocker { fn layout_blocked(&self) -> bool { !matches!(self, Self::FiredLoadEventOrParsingTimerExpired) } } #[dom_struct] pub(crate) struct Window { globalscope: GlobalScope, /// The webview that contains this [`Window`]. /// /// This may not be the top-level [`Window`], in the case of frames. #[no_trace] webview_id: WebViewId, script_chan: Sender, #[no_trace] #[ignore_malloc_size_of = "TODO: Add MallocSizeOf support to layout"] layout: RefCell>, /// A [`FontContext`] which is used to store and match against fonts for this `Window` and to /// trigger the download of web fonts. #[no_trace] #[conditional_malloc_size_of] font_context: Arc, navigator: MutNullableDom, #[ignore_malloc_size_of = "Arc"] #[no_trace] image_cache: Arc, #[no_trace] image_cache_sender: IpcSender, window_proxy: MutNullableDom, document: MutNullableDom, location: MutNullableDom, history: MutNullableDom, custom_element_registry: MutNullableDom, performance: MutNullableDom, #[no_trace] navigation_start: Cell, screen: MutNullableDom, session_storage: MutNullableDom, local_storage: MutNullableDom, status: DomRefCell, /// For sending timeline markers. Will be ignored if /// no devtools server #[no_trace] devtools_markers: DomRefCell>, #[no_trace] devtools_marker_sender: DomRefCell>>>, /// Most recent unhandled resize event, if any. #[no_trace] unhandled_resize_event: DomRefCell>, /// Platform theme. #[no_trace] theme: Cell, /// Parent id associated with this page, if any. #[no_trace] parent_info: Option, /// Global static data related to the DOM. dom_static: GlobalStaticData, /// The JavaScript runtime. #[ignore_malloc_size_of = "Rc is hard"] js_runtime: DomRefCell>>, /// The current size of the window, in pixels. #[no_trace] window_size: Cell, /// A handle for communicating messages to the bluetooth thread. #[no_trace] #[cfg(feature = "bluetooth")] bluetooth_thread: IpcSender, #[cfg(feature = "bluetooth")] bluetooth_extra_permission_data: BluetoothExtraPermissionData, /// An enlarged rectangle around the page contents visible in the viewport, used /// to prevent creating display list items for content that is far away from the viewport. #[no_trace] page_clip_rect: Cell>, /// See the documentation for [`LayoutBlocker`]. Essentially, this flag prevents /// layouts from happening before the first load event, apart from a few exceptional /// cases. #[no_trace] layout_blocker: Cell, /// A channel for communicating results of async scripts back to the webdriver server #[no_trace] webdriver_script_chan: DomRefCell>>, /// The current state of the window object current_state: Cell, #[no_trace] current_viewport: Cell>, error_reporter: CSSErrorReporter, /// A list of scroll offsets for each scrollable element. #[no_trace] scroll_offsets: DomRefCell>>, /// All the MediaQueryLists we need to update media_query_lists: DOMTracker, #[cfg(feature = "bluetooth")] test_runner: MutNullableDom, /// A handle for communicating messages to the WebGL thread, if available. #[ignore_malloc_size_of = "channels are hard"] #[no_trace] webgl_chan: Option, #[ignore_malloc_size_of = "defined in webxr"] #[no_trace] #[cfg(feature = "webxr")] webxr_registry: Option, /// When an element triggers an image load or starts watching an image load from the /// `ImageCache` it adds an entry to this list. When those loads are triggered from /// layout, they also add an etry to [`Self::pending_layout_images`]. #[no_trace] pending_image_callbacks: DomRefCell>>, /// All of the elements that have an outstanding image request that was /// initiated by layout during a reflow. They are stored in the script thread /// to ensure that the element can be marked dirty when the image data becomes /// available at some point in the future. pending_layout_images: DomRefCell>>>, /// Directory to store unminified css for this window if unminify-css /// opt is enabled. unminified_css_dir: DomRefCell>, /// Directory with stored unminified scripts local_script_source: Option, /// Worklets test_worklet: MutNullableDom, /// paint_worklet: MutNullableDom, /// The Webrender Document id associated with this window. #[ignore_malloc_size_of = "defined in webrender_api"] #[no_trace] webrender_document: DocumentId, /// Flag to identify whether mutation observers are present(true)/absent(false) exists_mut_observer: Cell, /// Cross-process access to the compositor. #[ignore_malloc_size_of = "Wraps an IpcSender"] #[no_trace] compositor_api: CrossProcessCompositorApi, /// Indicate whether a SetDocumentStatus message has been sent after a reflow is complete. /// It is used to avoid sending idle message more than once, which is unneccessary. has_sent_idle_message: Cell, /// Emits notifications when there is a relayout. relayout_event: bool, /// Unminify Css. unminify_css: bool, /// Where to load userscripts from, if any. An empty string will load from /// the resources/user-agent-js directory, and if the option isn't passed userscripts /// won't be loaded. userscripts_path: Option, /// Window's GL context from application #[ignore_malloc_size_of = "defined in script_thread"] #[no_trace] player_context: WindowGLContext, throttled: Cell, /// A shared marker for the validity of any cached layout values. A value of true /// indicates that any such values remain valid; any new layout that invalidates /// those values will cause the marker to be set to false. #[ignore_malloc_size_of = "Rc is hard"] layout_marker: DomRefCell>>, /// current_event: DomRefCell>>, } impl Window { pub(crate) fn webview_id(&self) -> WebViewId { self.webview_id } pub(crate) fn as_global_scope(&self) -> &GlobalScope { self.upcast::() } pub(crate) fn layout(&self) -> Ref> { self.layout.borrow() } pub(crate) fn layout_mut(&self) -> RefMut> { self.layout.borrow_mut() } pub(crate) fn get_exists_mut_observer(&self) -> bool { self.exists_mut_observer.get() } pub(crate) fn set_exists_mut_observer(&self) { self.exists_mut_observer.set(true); } #[allow(unsafe_code)] pub(crate) fn clear_js_runtime_for_script_deallocation(&self) { self.as_global_scope() .remove_web_messaging_and_dedicated_workers_infra(); unsafe { *self.js_runtime.borrow_for_script_deallocation() = None; self.window_proxy.set(None); self.current_state.set(WindowState::Zombie); self.as_global_scope() .task_manager() .cancel_all_tasks_and_ignore_future_tasks(); } } /// A convenience method for /// pub(crate) fn discard_browsing_context(&self) { let proxy = match self.window_proxy.get() { Some(proxy) => proxy, None => panic!("Discarding a BC from a window that has none"), }; proxy.discard_browsing_context(); // Step 4 of https://html.spec.whatwg.org/multipage/#discard-a-document // Other steps performed when the `PipelineExit` message // is handled by the ScriptThread. self.as_global_scope() .task_manager() .cancel_all_tasks_and_ignore_future_tasks(); } /// Get a sender to the time profiler thread. pub(crate) fn time_profiler_chan(&self) -> &TimeProfilerChan { self.globalscope.time_profiler_chan() } pub(crate) fn origin(&self) -> &MutableOrigin { self.globalscope.origin() } #[allow(unsafe_code)] pub(crate) fn get_cx(&self) -> JSContext { unsafe { JSContext::from_ptr(self.js_runtime.borrow().as_ref().unwrap().cx()) } } pub(crate) fn get_js_runtime(&self) -> Ref>> { self.js_runtime.borrow() } pub(crate) fn main_thread_script_chan(&self) -> &Sender { &self.script_chan } pub(crate) fn parent_info(&self) -> Option { self.parent_info } pub(crate) fn new_script_pair(&self) -> (ScriptEventLoopSender, ScriptEventLoopReceiver) { let (sender, receiver) = unbounded(); ( ScriptEventLoopSender::MainThread(sender), ScriptEventLoopReceiver::MainThread(receiver), ) } pub(crate) fn event_loop_sender(&self) -> ScriptEventLoopSender { ScriptEventLoopSender::MainThread(self.script_chan.clone()) } pub(crate) fn image_cache(&self) -> Arc { self.image_cache.clone() } /// This can panic if it is called after the browsing context has been discarded pub(crate) fn window_proxy(&self) -> DomRoot { self.window_proxy.get().unwrap() } /// Returns the window proxy if it has not been discarded. /// pub(crate) fn undiscarded_window_proxy(&self) -> Option> { self.window_proxy.get().and_then(|window_proxy| { if window_proxy.is_browsing_context_discarded() { None } else { Some(window_proxy) } }) } /// Returns the window proxy of the webview, which is the top-level ancestor browsing context. /// pub(crate) fn webview_window_proxy(&self) -> Option> { self.undiscarded_window_proxy() .and_then(|window_proxy| ScriptThread::find_window_proxy(window_proxy.webview_id().0)) } #[cfg(feature = "bluetooth")] pub(crate) fn bluetooth_thread(&self) -> IpcSender { self.bluetooth_thread.clone() } #[cfg(feature = "bluetooth")] pub(crate) fn bluetooth_extra_permission_data(&self) -> &BluetoothExtraPermissionData { &self.bluetooth_extra_permission_data } pub(crate) fn css_error_reporter(&self) -> Option<&dyn ParseErrorReporter> { Some(&self.error_reporter) } /// Sets a new list of scroll offsets. /// /// This is called when layout gives us new ones and WebRender is in use. pub(crate) fn set_scroll_offsets( &self, offsets: HashMap>, ) { *self.scroll_offsets.borrow_mut() = offsets } pub(crate) fn current_viewport(&self) -> UntypedRect { self.current_viewport.clone().get() } pub(crate) fn webgl_chan(&self) -> Option { self.webgl_chan .as_ref() .map(|chan| WebGLCommandSender::new(chan.clone())) } #[cfg(feature = "webxr")] pub(crate) fn webxr_registry(&self) -> Option { self.webxr_registry.clone() } fn new_paint_worklet(&self, can_gc: CanGc) -> DomRoot { debug!("Creating new paint worklet."); Worklet::new(self, WorkletGlobalScopeType::Paint, can_gc) } pub(crate) fn register_image_cache_listener( &self, id: PendingImageId, callback: impl Fn(PendingImageResponse) + 'static, ) -> IpcSender { self.pending_image_callbacks .borrow_mut() .entry(id) .or_default() .push(PendingImageCallback(Box::new(callback))); self.image_cache_sender.clone() } fn pending_layout_image_notification(&self, response: PendingImageResponse) { let mut images = self.pending_layout_images.borrow_mut(); let nodes = images.entry(response.id); let nodes = match nodes { Entry::Occupied(nodes) => nodes, Entry::Vacant(_) => return, }; for node in nodes.get() { node.dirty(NodeDamage::OtherNodeDamage); } match response.response { ImageResponse::MetadataLoaded(_) => {}, ImageResponse::Loaded(_, _) | ImageResponse::PlaceholderLoaded(_, _) | ImageResponse::None => { nodes.remove(); }, } } pub(crate) fn pending_image_notification(&self, response: PendingImageResponse) { // We take the images here, in order to prevent maintaining a mutable borrow when // image callbacks are called. These, in turn, can trigger garbage collection. // Normally this shouldn't trigger more pending image notifications, but just in // case we do not want to cause a double borrow here. let mut images = std::mem::take(&mut *self.pending_image_callbacks.borrow_mut()); let Entry::Occupied(callbacks) = images.entry(response.id) else { let _ = std::mem::replace(&mut *self.pending_image_callbacks.borrow_mut(), images); return; }; for callback in callbacks.get() { callback.0(response.clone()); } match response.response { ImageResponse::MetadataLoaded(_) => {}, ImageResponse::Loaded(_, _) | ImageResponse::PlaceholderLoaded(_, _) | ImageResponse::None => { callbacks.remove(); }, } let _ = std::mem::replace(&mut *self.pending_image_callbacks.borrow_mut(), images); } pub(crate) fn compositor_api(&self) -> &CrossProcessCompositorApi { &self.compositor_api } pub(crate) fn get_userscripts_path(&self) -> Option { self.userscripts_path.clone() } pub(crate) fn get_player_context(&self) -> WindowGLContext { self.player_context.clone() } // see note at https://dom.spec.whatwg.org/#concept-event-dispatch step 2 pub(crate) fn dispatch_event_with_target_override( &self, event: &Event, can_gc: CanGc, ) -> EventStatus { event.dispatch(self.upcast(), true, can_gc) } pub(crate) fn font_context(&self) -> &Arc { &self.font_context } } // https://html.spec.whatwg.org/multipage/#atob pub(crate) fn base64_btoa(input: DOMString) -> Fallible { // "The btoa() method must throw an InvalidCharacterError exception if // the method's first argument contains any character whose code point // is greater than U+00FF." if input.chars().any(|c: char| c > '\u{FF}') { Err(Error::InvalidCharacter) } else { // "Otherwise, the user agent must convert that argument to a // sequence of octets whose nth octet is the eight-bit // representation of the code point of the nth character of // the argument," let octets = input.chars().map(|c: char| c as u8).collect::>(); // "and then must apply the base64 algorithm to that sequence of // octets, and return the result. [RFC4648]" let config = base64::engine::general_purpose::GeneralPurposeConfig::new().with_encode_padding(true); let engine = base64::engine::GeneralPurpose::new(&base64::alphabet::STANDARD, config); Ok(DOMString::from(engine.encode(octets))) } } // https://html.spec.whatwg.org/multipage/#atob pub(crate) fn base64_atob(input: DOMString) -> Fallible { // "Remove all space characters from input." fn is_html_space(c: char) -> bool { HTML_SPACE_CHARACTERS.iter().any(|&m| m == c) } let without_spaces = input .chars() .filter(|&c| !is_html_space(c)) .collect::(); let mut input = &*without_spaces; // "If the length of input divides by 4 leaving no remainder, then: // if input ends with one or two U+003D EQUALS SIGN (=) characters, // remove them from input." if input.len() % 4 == 0 { if input.ends_with("==") { input = &input[..input.len() - 2] } else if input.ends_with('=') { input = &input[..input.len() - 1] } } // "If the length of input divides by 4 leaving a remainder of 1, // throw an InvalidCharacterError exception and abort these steps." if input.len() % 4 == 1 { return Err(Error::InvalidCharacter); } // "If input contains a character that is not in the following list of // characters and character ranges, throw an InvalidCharacterError // exception and abort these steps: // // U+002B PLUS SIGN (+) // U+002F SOLIDUS (/) // Alphanumeric ASCII characters" if input .chars() .any(|c| c != '+' && c != '/' && !c.is_alphanumeric()) { return Err(Error::InvalidCharacter); } let config = base64::engine::general_purpose::GeneralPurposeConfig::new() .with_decode_padding_mode(base64::engine::DecodePaddingMode::RequireNone) .with_decode_allow_trailing_bits(true); let engine = base64::engine::GeneralPurpose::new(&base64::alphabet::STANDARD, config); let data = engine.decode(input).map_err(|_| Error::InvalidCharacter)?; Ok(data.iter().map(|&b| b as char).collect::().into()) } impl WindowMethods for Window { // https://html.spec.whatwg.org/multipage/#dom-alert fn Alert_(&self) { self.Alert(DOMString::new()); } // https://html.spec.whatwg.org/multipage/#dom-alert fn Alert(&self, s: DOMString) { // Print to the console. // Ensure that stderr doesn't trample through the alert() we use to // communicate test results (see executorservo.py in wptrunner). { let stderr = stderr(); let mut stderr = stderr.lock(); let stdout = stdout(); let mut stdout = stdout.lock(); writeln!(&mut stdout, "\nALERT: {}", s).unwrap(); stdout.flush().unwrap(); stderr.flush().unwrap(); } let (sender, receiver) = ProfiledIpc::channel(self.global().time_profiler_chan().clone()).unwrap(); let dialog = SimpleDialog::Alert { message: s.to_string(), response_sender: sender, }; let msg = EmbedderMsg::ShowSimpleDialog(self.webview_id(), dialog); self.send_to_embedder(msg); let AlertResponse::Ok = receiver.recv().unwrap(); } // https://html.spec.whatwg.org/multipage/#dom-confirm fn Confirm(&self, s: DOMString) -> bool { let (sender, receiver) = ProfiledIpc::channel(self.global().time_profiler_chan().clone()).unwrap(); let dialog = SimpleDialog::Confirm { message: s.to_string(), response_sender: sender, }; let msg = EmbedderMsg::ShowSimpleDialog(self.webview_id(), dialog); self.send_to_embedder(msg); receiver.recv().unwrap() == ConfirmResponse::Ok } // https://html.spec.whatwg.org/multipage/#dom-prompt fn Prompt(&self, message: DOMString, default: DOMString) -> Option { let (sender, receiver) = ProfiledIpc::channel(self.global().time_profiler_chan().clone()).unwrap(); let dialog = SimpleDialog::Prompt { message: message.to_string(), default: default.to_string(), response_sender: sender, }; let msg = EmbedderMsg::ShowSimpleDialog(self.webview_id(), dialog); self.send_to_embedder(msg); match receiver.recv().unwrap() { PromptResponse::Ok(input) => Some(input.into()), PromptResponse::Cancel => None, } } // https://html.spec.whatwg.org/multipage/#dom-window-stop fn Stop(&self, can_gc: CanGc) { // TODO: Cancel ongoing navigation. let doc = self.Document(); doc.abort(can_gc); } // https://html.spec.whatwg.org/multipage/#dom-open fn Open( &self, url: USVString, target: DOMString, features: DOMString, can_gc: CanGc, ) -> Fallible>> { self.window_proxy().open(url, target, features, can_gc) } // https://html.spec.whatwg.org/multipage/#dom-opener fn GetOpener( &self, cx: JSContext, in_realm_proof: InRealm, mut retval: MutableHandleValue, ) -> Fallible<()> { // Step 1, Let current be this Window object's browsing context. let current = match self.window_proxy.get() { Some(proxy) => proxy, // Step 2, If current is null, then return null. None => { retval.set(NullValue()); return Ok(()); }, }; // Still step 2, since the window's BC is the associated doc's BC, // see https://html.spec.whatwg.org/multipage/#window-bc // and a doc's BC is null if it has been discarded. // see https://html.spec.whatwg.org/multipage/#concept-document-bc if current.is_browsing_context_discarded() { retval.set(NullValue()); return Ok(()); } // Step 3 to 5. current.opener(*cx, in_realm_proof, retval); Ok(()) } #[allow(unsafe_code)] // https://html.spec.whatwg.org/multipage/#dom-opener fn SetOpener(&self, cx: JSContext, value: HandleValue) -> ErrorResult { // Step 1. if value.is_null() { if let Some(proxy) = self.window_proxy.get() { proxy.disown(); } return Ok(()); } // Step 2. let obj = self.reflector().get_jsobject(); unsafe { let result = JS_DefineProperty(*cx, obj, c"opener".as_ptr(), value, JSPROP_ENUMERATE as u32); if result { Ok(()) } else { Err(Error::JSFailed) } } } // https://html.spec.whatwg.org/multipage/#dom-window-closed fn Closed(&self) -> bool { self.window_proxy .get() .map(|ref proxy| proxy.is_browsing_context_discarded() || proxy.is_closing()) .unwrap_or(true) } // https://html.spec.whatwg.org/multipage/#dom-window-close fn Close(&self) { // Step 1, Let current be this Window object's browsing context. // Step 2, If current is null or its is closing is true, then return. let window_proxy = match self.window_proxy.get() { Some(proxy) => proxy, None => return, }; if window_proxy.is_closing() { return; } // Note: check the length of the "session history", as opposed to the joint session history? // see https://github.com/whatwg/html/issues/3734 if let Ok(history_length) = self.History().GetLength() { let is_auxiliary = window_proxy.is_auxiliary(); // https://html.spec.whatwg.org/multipage/#script-closable let is_script_closable = (self.is_top_level() && history_length == 1) || is_auxiliary || pref!(dom_allow_scripts_to_close_windows); // TODO: rest of Step 3: // Is the incumbent settings object's responsible browsing context familiar with current? // Is the incumbent settings object's responsible browsing context allowed to navigate current? if is_script_closable { // Step 3.1, set current's is closing to true. window_proxy.close(); // Step 3.2, queue a task on the DOM manipulation task source to close current. let this = Trusted::new(self); let task = task!(window_close_browsing_context: move || { let window = this.root(); let document = window.Document(); // https://html.spec.whatwg.org/multipage/#closing-browsing-contexts // Step 1, check if traversable is closing, was already done above. // Steps 2 and 3, prompt to unload for all inclusive descendant navigables. // TODO: We should be prompting for all inclusive descendant navigables, // but we pass false here, which suggests we are not doing that. Why? if document.prompt_to_unload(false, CanGc::note()) { // Step 4, unload. document.unload(false, CanGc::note()); // https://html.spec.whatwg.org/multipage/#a-browsing-context-is-discarded // which calls into https://html.spec.whatwg.org/multipage/#discard-a-document. window.discard_browsing_context(); window.send_to_constellation(ScriptMsg::DiscardTopLevelBrowsingContext); } }); self.as_global_scope() .task_manager() .dom_manipulation_task_source() .queue(task); } } } // https://html.spec.whatwg.org/multipage/#dom-document-2 fn Document(&self) -> DomRoot { self.document .get() .expect("Document accessed before initialization.") } // https://html.spec.whatwg.org/multipage/#dom-history fn History(&self) -> DomRoot { self.history.or_init(|| History::new(self, CanGc::note())) } // https://html.spec.whatwg.org/multipage/#dom-window-customelements fn CustomElements(&self) -> DomRoot { self.custom_element_registry .or_init(|| CustomElementRegistry::new(self, CanGc::note())) } // https://html.spec.whatwg.org/multipage/#dom-location fn Location(&self) -> DomRoot { self.location.or_init(|| Location::new(self, CanGc::note())) } // https://html.spec.whatwg.org/multipage/#dom-sessionstorage fn SessionStorage(&self) -> DomRoot { self.session_storage .or_init(|| Storage::new(self, StorageType::Session, CanGc::note())) } // https://html.spec.whatwg.org/multipage/#dom-localstorage fn LocalStorage(&self) -> DomRoot { self.local_storage .or_init(|| Storage::new(self, StorageType::Local, CanGc::note())) } // https://dvcs.w3.org/hg/webcrypto-api/raw-file/tip/spec/Overview.html#dfn-GlobalCrypto fn Crypto(&self) -> DomRoot { self.as_global_scope().crypto() } // https://html.spec.whatwg.org/multipage/#dom-frameelement fn GetFrameElement(&self) -> Option> { // Steps 1-3. let window_proxy = self.window_proxy.get()?; // Step 4-5. let container = window_proxy.frame_element()?; // Step 6. let container_doc = container.owner_document(); let current_doc = GlobalScope::current() .expect("No current global object") .as_window() .Document(); if !current_doc .origin() .same_origin_domain(container_doc.origin()) { return None; } // Step 7. Some(DomRoot::from_ref(container)) } // https://html.spec.whatwg.org/multipage/#dom-navigator fn Navigator(&self) -> DomRoot { self.navigator .or_init(|| Navigator::new(self, CanGc::note())) } // https://html.spec.whatwg.org/multipage/#dom-windowtimers-settimeout fn SetTimeout( &self, _cx: JSContext, callback: StringOrFunction, timeout: i32, args: Vec, ) -> i32 { let callback = match callback { StringOrFunction::String(i) => TimerCallback::StringTimerCallback(i), StringOrFunction::Function(i) => TimerCallback::FunctionTimerCallback(i), }; self.as_global_scope().set_timeout_or_interval( callback, args, Duration::from_millis(timeout.max(0) as u64), IsInterval::NonInterval, ) } // https://html.spec.whatwg.org/multipage/#dom-windowtimers-cleartimeout fn ClearTimeout(&self, handle: i32) { self.as_global_scope().clear_timeout_or_interval(handle); } // https://html.spec.whatwg.org/multipage/#dom-windowtimers-setinterval fn SetInterval( &self, _cx: JSContext, callback: StringOrFunction, timeout: i32, args: Vec, ) -> i32 { let callback = match callback { StringOrFunction::String(i) => TimerCallback::StringTimerCallback(i), StringOrFunction::Function(i) => TimerCallback::FunctionTimerCallback(i), }; self.as_global_scope().set_timeout_or_interval( callback, args, Duration::from_millis(timeout.max(0) as u64), IsInterval::Interval, ) } // https://html.spec.whatwg.org/multipage/#dom-windowtimers-clearinterval fn ClearInterval(&self, handle: i32) { self.ClearTimeout(handle); } // https://html.spec.whatwg.org/multipage/#dom-queuemicrotask fn QueueMicrotask(&self, callback: Rc) { self.as_global_scope().queue_function_as_microtask(callback); } // https://html.spec.whatwg.org/multipage/#dom-createimagebitmap fn CreateImageBitmap( &self, image: ImageBitmapSource, options: &ImageBitmapOptions, can_gc: CanGc, ) -> Rc { let p = self .as_global_scope() .create_image_bitmap(image, options, can_gc); p } // https://html.spec.whatwg.org/multipage/#dom-window fn Window(&self) -> DomRoot { self.window_proxy() } // https://html.spec.whatwg.org/multipage/#dom-self fn Self_(&self) -> DomRoot { self.window_proxy() } // https://html.spec.whatwg.org/multipage/#dom-frames fn Frames(&self) -> DomRoot { self.window_proxy() } // https://html.spec.whatwg.org/multipage/#accessing-other-browsing-contexts fn Length(&self) -> u32 { self.Document().iframes().iter().count() as u32 } // https://html.spec.whatwg.org/multipage/#dom-parent fn GetParent(&self) -> Option> { // Steps 1-3. let window_proxy = self.undiscarded_window_proxy()?; // Step 4. if let Some(parent) = window_proxy.parent() { return Some(DomRoot::from_ref(parent)); } // Step 5. Some(window_proxy) } // https://html.spec.whatwg.org/multipage/#dom-top fn GetTop(&self) -> Option> { // Steps 1-3. let window_proxy = self.undiscarded_window_proxy()?; // Steps 4-5. Some(DomRoot::from_ref(window_proxy.top())) } // https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/ // NavigationTiming/Overview.html#sec-window.performance-attribute fn Performance(&self) -> DomRoot { self.performance.or_init(|| { Performance::new( self.as_global_scope(), self.navigation_start.get(), CanGc::note(), ) }) } // https://html.spec.whatwg.org/multipage/#globaleventhandlers global_event_handlers!(); // https://html.spec.whatwg.org/multipage/#windoweventhandlers window_event_handlers!(); // https://developer.mozilla.org/en-US/docs/Web/API/Window/screen fn Screen(&self) -> DomRoot { self.screen.or_init(|| Screen::new(self, CanGc::note())) } // https://html.spec.whatwg.org/multipage/#dom-windowbase64-btoa fn Btoa(&self, btoa: DOMString) -> Fallible { base64_btoa(btoa) } // https://html.spec.whatwg.org/multipage/#dom-windowbase64-atob fn Atob(&self, atob: DOMString) -> Fallible { base64_atob(atob) } /// fn RequestAnimationFrame(&self, callback: Rc) -> u32 { self.Document() .request_animation_frame(AnimationFrameCallback::FrameRequestCallback { callback }) } /// fn CancelAnimationFrame(&self, ident: u32) { let doc = self.Document(); doc.cancel_animation_frame(ident); } // https://html.spec.whatwg.org/multipage/#dom-window-postmessage fn PostMessage( &self, cx: JSContext, message: HandleValue, target_origin: USVString, transfer: CustomAutoRooterGuard>, ) -> ErrorResult { let incumbent = GlobalScope::incumbent().expect("no incumbent global?"); let source = incumbent.as_window(); let source_origin = source.Document().origin().immutable().clone(); self.post_message_impl(&target_origin, source_origin, source, cx, message, transfer) } /// fn PostMessage_( &self, cx: JSContext, message: HandleValue, options: RootedTraceableBox, ) -> ErrorResult { let mut rooted = CustomAutoRooter::new( options .parent .transfer .iter() .map(|js: &RootedTraceableBox>| js.get()) .collect(), ); let transfer = CustomAutoRooterGuard::new(*cx, &mut rooted); let incumbent = GlobalScope::incumbent().expect("no incumbent global?"); let source = incumbent.as_window(); let source_origin = source.Document().origin().immutable().clone(); self.post_message_impl( &options.targetOrigin, source_origin, source, cx, message, transfer, ) } // https://html.spec.whatwg.org/multipage/#dom-window-captureevents fn CaptureEvents(&self) { // This method intentionally does nothing } // https://html.spec.whatwg.org/multipage/#dom-window-releaseevents fn ReleaseEvents(&self) { // This method intentionally does nothing } // check-tidy: no specs after this line fn Debug(&self, message: DOMString) { debug!("{}", message); } #[allow(unsafe_code)] fn Gc(&self) { unsafe { JS_GC(*self.get_cx(), GCReason::API); } } #[allow(unsafe_code)] fn Js_backtrace(&self) { unsafe { println!("Current JS stack:"); dump_js_stack(*self.get_cx()); let rust_stack = Backtrace::new(); println!("Current Rust stack:\n{:?}", rust_stack); } } #[allow(unsafe_code)] fn WebdriverCallback(&self, cx: JSContext, val: HandleValue) { let rv = unsafe { jsval_to_webdriver(*cx, &self.globalscope, val) }; let opt_chan = self.webdriver_script_chan.borrow_mut().take(); if let Some(chan) = opt_chan { chan.send(rv).unwrap(); } } fn WebdriverTimeout(&self) { let opt_chan = self.webdriver_script_chan.borrow_mut().take(); if let Some(chan) = opt_chan { chan.send(Err(WebDriverJSError::Timeout)).unwrap(); } } // https://drafts.csswg.org/cssom/#dom-window-getcomputedstyle fn GetComputedStyle( &self, element: &Element, pseudo: Option, ) -> DomRoot { // Steps 1-4. let pseudo = pseudo.map(|mut s| { s.make_ascii_lowercase(); s }); let pseudo = match pseudo { Some(ref pseudo) if pseudo == ":before" || pseudo == "::before" => { Some(PseudoElement::Before) }, Some(ref pseudo) if pseudo == ":after" || pseudo == "::after" => { Some(PseudoElement::After) }, _ => None, }; // Step 5. CSSStyleDeclaration::new( self, CSSStyleOwner::Element(Dom::from_ref(element)), pseudo, CSSModificationAccess::Readonly, CanGc::note(), ) } // https://drafts.csswg.org/cssom-view/#dom-window-innerheight //TODO Include Scrollbar fn InnerHeight(&self) -> i32 { self.window_size .get() .initial_viewport .height .to_i32() .unwrap_or(0) } // https://drafts.csswg.org/cssom-view/#dom-window-innerwidth //TODO Include Scrollbar fn InnerWidth(&self) -> i32 { self.window_size .get() .initial_viewport .width .to_i32() .unwrap_or(0) } // https://drafts.csswg.org/cssom-view/#dom-window-scrollx fn ScrollX(&self) -> i32 { self.current_viewport.get().origin.x.to_px() } // https://drafts.csswg.org/cssom-view/#dom-window-pagexoffset fn PageXOffset(&self) -> i32 { self.ScrollX() } // https://drafts.csswg.org/cssom-view/#dom-window-scrolly fn ScrollY(&self) -> i32 { self.current_viewport.get().origin.y.to_px() } // https://drafts.csswg.org/cssom-view/#dom-window-pageyoffset fn PageYOffset(&self) -> i32 { self.ScrollY() } // https://drafts.csswg.org/cssom-view/#dom-window-scroll fn Scroll(&self, options: &ScrollToOptions, can_gc: CanGc) { // Step 1 let left = options.left.unwrap_or(0.0f64); let top = options.top.unwrap_or(0.0f64); self.scroll(left, top, options.parent.behavior, can_gc); } // https://drafts.csswg.org/cssom-view/#dom-window-scroll fn Scroll_(&self, x: f64, y: f64, can_gc: CanGc) { self.scroll(x, y, ScrollBehavior::Auto, can_gc); } // https://drafts.csswg.org/cssom-view/#dom-window-scrollto fn ScrollTo(&self, options: &ScrollToOptions) { self.Scroll(options, CanGc::note()); } // https://drafts.csswg.org/cssom-view/#dom-window-scrollto fn ScrollTo_(&self, x: f64, y: f64) { self.scroll(x, y, ScrollBehavior::Auto, CanGc::note()); } // https://drafts.csswg.org/cssom-view/#dom-window-scrollby fn ScrollBy(&self, options: &ScrollToOptions, can_gc: CanGc) { // Step 1 let x = options.left.unwrap_or(0.0f64); let y = options.top.unwrap_or(0.0f64); self.ScrollBy_(x, y, can_gc); self.scroll(x, y, options.parent.behavior, can_gc); } // https://drafts.csswg.org/cssom-view/#dom-window-scrollby fn ScrollBy_(&self, x: f64, y: f64, can_gc: CanGc) { // Step 3 let left = x + self.ScrollX() as f64; // Step 4 let top = y + self.ScrollY() as f64; // Step 5 self.scroll(left, top, ScrollBehavior::Auto, can_gc); } // https://drafts.csswg.org/cssom-view/#dom-window-resizeto fn ResizeTo(&self, width: i32, height: i32) { // Step 1 //TODO determine if this operation is allowed let dpr = self.device_pixel_ratio(); let size = Size2D::new(width, height).to_f32() * dpr; self.send_to_embedder(EmbedderMsg::ResizeTo(self.webview_id(), size.to_i32())); } // https://drafts.csswg.org/cssom-view/#dom-window-resizeby fn ResizeBy(&self, x: i32, y: i32) { let (size, _) = self.client_window(); // Step 1 self.ResizeTo( x + size.width.to_i32().unwrap_or(1), y + size.height.to_i32().unwrap_or(1), ) } // https://drafts.csswg.org/cssom-view/#dom-window-moveto fn MoveTo(&self, x: i32, y: i32) { // Step 1 //TODO determine if this operation is allowed let dpr = self.device_pixel_ratio(); let point = Point2D::new(x, y).to_f32() * dpr; let msg = EmbedderMsg::MoveTo(self.webview_id(), point.to_i32()); self.send_to_embedder(msg); } // https://drafts.csswg.org/cssom-view/#dom-window-moveby fn MoveBy(&self, x: i32, y: i32) { let (_, origin) = self.client_window(); // Step 1 self.MoveTo(x + origin.x, y + origin.y) } // https://drafts.csswg.org/cssom-view/#dom-window-screenx fn ScreenX(&self) -> i32 { let (_, origin) = self.client_window(); origin.x } // https://drafts.csswg.org/cssom-view/#dom-window-screeny fn ScreenY(&self) -> i32 { let (_, origin) = self.client_window(); origin.y } // https://drafts.csswg.org/cssom-view/#dom-window-outerheight fn OuterHeight(&self) -> i32 { let (size, _) = self.client_window(); size.height.to_i32().unwrap_or(1) } // https://drafts.csswg.org/cssom-view/#dom-window-outerwidth fn OuterWidth(&self) -> i32 { let (size, _) = self.client_window(); size.width.to_i32().unwrap_or(1) } // https://drafts.csswg.org/cssom-view/#dom-window-devicepixelratio fn DevicePixelRatio(&self) -> Finite { Finite::wrap(self.device_pixel_ratio().get() as f64) } // https://html.spec.whatwg.org/multipage/#dom-window-status fn Status(&self) -> DOMString { self.status.borrow().clone() } // https://html.spec.whatwg.org/multipage/#dom-window-status fn SetStatus(&self, status: DOMString) { *self.status.borrow_mut() = status } // https://drafts.csswg.org/cssom-view/#dom-window-matchmedia fn MatchMedia(&self, query: DOMString) -> DomRoot { let mut input = ParserInput::new(&query); let mut parser = Parser::new(&mut input); let url_data = UrlExtraData(self.get_url().get_arc()); let quirks_mode = self.Document().quirks_mode(); let context = CssParserContext::new( Origin::Author, &url_data, Some(CssRuleType::Media), ParsingMode::DEFAULT, quirks_mode, /* namespaces = */ Default::default(), self.css_error_reporter(), None, ); let media_query_list = media_queries::MediaList::parse(&context, &mut parser); let document = self.Document(); let mql = MediaQueryList::new(&document, media_query_list, CanGc::note()); self.media_query_lists.track(&*mql); mql } // https://fetch.spec.whatwg.org/#fetch-method fn Fetch( &self, input: RequestOrUSVString, init: RootedTraceableBox, comp: InRealm, can_gc: CanGc, ) -> Rc { fetch::Fetch(self.upcast(), input, init, comp, can_gc) } #[cfg(feature = "bluetooth")] fn TestRunner(&self) -> DomRoot { self.test_runner .or_init(|| TestRunner::new(self.upcast(), CanGc::note())) } fn RunningAnimationCount(&self) -> u32 { self.document .get() .map_or(0, |d| d.animations().running_animation_count() as u32) } // https://html.spec.whatwg.org/multipage/#dom-name fn SetName(&self, name: DOMString) { if let Some(proxy) = self.undiscarded_window_proxy() { proxy.set_name(name); } } // https://html.spec.whatwg.org/multipage/#dom-name fn Name(&self) -> DOMString { match self.undiscarded_window_proxy() { Some(proxy) => proxy.get_name(), None => "".into(), } } // https://html.spec.whatwg.org/multipage/#dom-origin fn Origin(&self) -> USVString { USVString(self.origin().immutable().ascii_serialization()) } // https://w3c.github.io/selection-api/#dom-window-getselection fn GetSelection(&self) -> Option> { self.document.get().and_then(|d| d.GetSelection()) } // https://dom.spec.whatwg.org/#dom-window-event #[allow(unsafe_code)] fn Event(&self, cx: JSContext, rval: MutableHandleValue) { if let Some(ref event) = *self.current_event.borrow() { unsafe { event.reflector().get_jsobject().to_jsval(*cx, rval); } } } fn IsSecureContext(&self) -> bool { self.as_global_scope().is_secure_context() } /// fn NamedGetter(&self, name: DOMString) -> Option { if name.is_empty() { return None; } let document = self.Document(); // https://html.spec.whatwg.org/multipage/#document-tree-child-browsing-context-name-property-set let iframes: Vec<_> = document .iframes() .iter() .filter(|iframe| { if let Some(window) = iframe.GetContentWindow() { return window.get_name() == name; } false }) .collect(); let iframe_iter = iframes.iter().map(|iframe| iframe.upcast::()); let name = Atom::from(&*name); // Step 1. let elements_with_name = document.get_elements_with_name(&name); let name_iter = elements_with_name .iter() .map(|element| &**element) .filter(|elem| is_named_element_with_name_attribute(elem)); let elements_with_id = document.get_elements_with_id(&name); let id_iter = elements_with_id .iter() .map(|element| &**element) .filter(|elem| is_named_element_with_id_attribute(elem)); // Step 2. for elem in iframe_iter.clone() { if let Some(nested_window_proxy) = elem .downcast::() .and_then(|iframe| iframe.GetContentWindow()) { return Some(NamedPropertyValue::WindowProxy(nested_window_proxy)); } } let mut elements = iframe_iter.chain(name_iter).chain(id_iter); let first = elements.next()?; if elements.next().is_none() { // Step 3. return Some(NamedPropertyValue::Element(DomRoot::from_ref(first))); } // Step 4. #[derive(JSTraceable, MallocSizeOf)] struct WindowNamedGetter { #[no_trace] name: Atom, } impl CollectionFilter for WindowNamedGetter { fn filter(&self, elem: &Element, _root: &Node) -> bool { let type_ = match elem.upcast::().type_id() { NodeTypeId::Element(ElementTypeId::HTMLElement(type_)) => type_, _ => return false, }; if elem.get_id().as_ref() == Some(&self.name) { return true; } match type_ { HTMLElementTypeId::HTMLEmbedElement | HTMLElementTypeId::HTMLFormElement | HTMLElementTypeId::HTMLImageElement | HTMLElementTypeId::HTMLObjectElement => { elem.get_name().as_ref() == Some(&self.name) }, _ => false, } } } let collection = HTMLCollection::create( self, document.upcast(), Box::new(WindowNamedGetter { name }), ); Some(NamedPropertyValue::HTMLCollection(collection)) } // https://html.spec.whatwg.org/multipage/#dom-tree-accessors:supported-property-names fn SupportedPropertyNames(&self) -> Vec { let mut names_with_first_named_element_map: HashMap<&Atom, &Element> = HashMap::new(); let document = self.Document(); let name_map = document.name_map(); for (name, elements) in &name_map.0 { if name.is_empty() { continue; } let mut name_iter = elements .iter() .filter(|elem| is_named_element_with_name_attribute(elem)); if let Some(first) = name_iter.next() { names_with_first_named_element_map.insert(name, first); } } let id_map = document.id_map(); for (id, elements) in &id_map.0 { if id.is_empty() { continue; } let mut id_iter = elements .iter() .filter(|elem| is_named_element_with_id_attribute(elem)); if let Some(first) = id_iter.next() { match names_with_first_named_element_map.entry(id) { Entry::Vacant(entry) => drop(entry.insert(first)), Entry::Occupied(mut entry) => { if first.upcast::().is_before(entry.get().upcast()) { *entry.get_mut() = first; } }, } } } let mut names_with_first_named_element_vec: Vec<(&Atom, &Element)> = names_with_first_named_element_map .iter() .map(|(k, v)| (*k, *v)) .collect(); names_with_first_named_element_vec.sort_unstable_by(|a, b| { if a.1 == b.1 { // This can happen if an img has an id different from its name, // spec does not say which string to put first. a.0.cmp(b.0) } else if a.1.upcast::().is_before(b.1.upcast::()) { cmp::Ordering::Less } else { cmp::Ordering::Greater } }); names_with_first_named_element_vec .iter() .map(|(k, _v)| DOMString::from(&***k)) .collect() } /// fn StructuredClone( &self, cx: JSContext, value: HandleValue, options: RootedTraceableBox, retval: MutableHandleValue, ) -> Fallible<()> { self.as_global_scope() .structured_clone(cx, value, options, retval) } } impl Window { // https://heycam.github.io/webidl/#named-properties-object // https://html.spec.whatwg.org/multipage/#named-access-on-the-window-object #[allow(unsafe_code)] pub(crate) fn create_named_properties_object( cx: JSContext, proto: HandleObject, object: MutableHandleObject, ) { window_named_properties::create(cx, proto, object) } pub(crate) fn current_event(&self) -> Option> { self.current_event .borrow() .as_ref() .map(|e| DomRoot::from_ref(&**e)) } pub(crate) fn set_current_event(&self, event: Option<&Event>) -> Option> { let current = self.current_event(); *self.current_event.borrow_mut() = event.map(Dom::from_ref); current } /// fn post_message_impl( &self, target_origin: &USVString, source_origin: ImmutableOrigin, source: &Window, cx: JSContext, message: HandleValue, transfer: CustomAutoRooterGuard>, ) -> ErrorResult { // Step 1-2, 6-8. let data = structuredclone::write(cx, message, Some(transfer))?; // Step 3-5. let target_origin = match target_origin.0[..].as_ref() { "*" => None, "/" => Some(source_origin.clone()), url => match ServoUrl::parse(url) { Ok(url) => Some(url.origin().clone()), Err(_) => return Err(Error::Syntax), }, }; // Step 9. self.post_message(target_origin, source_origin, &source.window_proxy(), data); Ok(()) } // https://drafts.css-houdini.org/css-paint-api-1/#paint-worklet pub(crate) fn paint_worklet(&self) -> DomRoot { self.paint_worklet .or_init(|| self.new_paint_worklet(CanGc::note())) } pub(crate) fn has_document(&self) -> bool { self.document.get().is_some() } pub(crate) fn clear_js_runtime(&self) { self.as_global_scope() .remove_web_messaging_and_dedicated_workers_infra(); // Clean up any active promises // https://github.com/servo/servo/issues/15318 if let Some(custom_elements) = self.custom_element_registry.get() { custom_elements.teardown(); } // The above code may not catch all DOM objects (e.g. DOM // objects removed from the tree that haven't been collected // yet). There should not be any such DOM nodes with layout // data, but if there are, then when they are dropped, they // will attempt to send a message to layout. // This causes memory safety issues, because the DOM node uses // the layout channel from its window, and the window has // already been GC'd. For nodes which do not have a live // pointer, we can avoid this by GCing now: self.Gc(); // but there may still be nodes being kept alive by user // script. // TODO: ensure that this doesn't happen! self.current_state.set(WindowState::Zombie); *self.js_runtime.borrow_mut() = None; // If this is the currently active pipeline, // nullify the window_proxy. if let Some(proxy) = self.window_proxy.get() { let pipeline_id = self.pipeline_id(); if let Some(currently_active) = proxy.currently_active() { if currently_active == pipeline_id { self.window_proxy.set(None); } } } if let Some(performance) = self.performance.get() { performance.clear_and_disable_performance_entry_buffer(); } self.as_global_scope() .task_manager() .cancel_all_tasks_and_ignore_future_tasks(); } /// pub(crate) fn scroll(&self, x_: f64, y_: f64, behavior: ScrollBehavior, can_gc: CanGc) { // Step 3 let xfinite = if x_.is_finite() { x_ } else { 0.0f64 }; let yfinite = if y_.is_finite() { y_ } else { 0.0f64 }; // TODO Step 4 - determine if a window has a viewport // Step 5 & 6 // TODO: Remove scrollbar dimensions. let viewport = self.window_size.get().initial_viewport; // Step 7 & 8 // TODO: Consider `block-end` and `inline-end` overflow direction. let scrolling_area = self.scrolling_area_query(None, can_gc); let x = xfinite .min(scrolling_area.width() as f64 - viewport.width as f64) .max(0.0f64); let y = yfinite .min(scrolling_area.height() as f64 - viewport.height as f64) .max(0.0f64); // Step 10 //TODO handling ongoing smooth scrolling if x == self.ScrollX() as f64 && y == self.ScrollY() as f64 { return; } //TODO Step 11 //let document = self.Document(); // Step 12 let x = x.to_f32().unwrap_or(0.0f32); let y = y.to_f32().unwrap_or(0.0f32); self.update_viewport_for_scroll(x, y); self.perform_a_scroll( x, y, self.pipeline_id().root_scroll_id(), behavior, None, can_gc, ); } /// pub(crate) fn perform_a_scroll( &self, x: f32, y: f32, scroll_id: ExternalScrollId, _behavior: ScrollBehavior, _element: Option<&Element>, can_gc: CanGc, ) { // TODO Step 1 // TODO(mrobinson, #18709): Add smooth scrolling support to WebRender so that we can // properly process ScrollBehavior here. self.reflow( ReflowGoal::UpdateScrollNode(ScrollState { scroll_id, scroll_offset: Vector2D::new(-x, -y), }), can_gc, ); } pub(crate) fn update_viewport_for_scroll(&self, x: f32, y: f32) { let size = self.current_viewport.get().size; let new_viewport = Rect::new(Point2D::new(Au::from_f32_px(x), Au::from_f32_px(y)), size); self.current_viewport.set(new_viewport) } pub(crate) fn device_pixel_ratio(&self) -> Scale { self.window_size.get().device_pixel_ratio } fn client_window(&self) -> (Size2D, Point2D) { let timer_profile_chan = self.global().time_profiler_chan().clone(); let (send, recv) = ProfiledIpc::channel::(timer_profile_chan).unwrap(); let _ = self .compositor_api .sender() .send(webrender_traits::CrossProcessCompositorMessage::GetClientWindowRect(send)); let rect = recv.recv().unwrap_or_default(); ( Size2D::new(rect.size().width as u32, rect.size().height as u32), Point2D::new(rect.min.x, rect.min.y), ) } /// Prepares to tick animations and then does a reflow which also advances the /// layout animation clock. #[allow(unsafe_code)] pub(crate) fn advance_animation_clock(&self, delta_ms: i32) { self.Document() .advance_animation_timeline_for_testing(delta_ms as f64 / 1000.); ScriptThread::handle_tick_all_animations_for_testing(self.pipeline_id()); } /// Reflows the page unconditionally if possible and not suppressed. This method will wait for /// the layout to complete. If there is no window size yet, the page is presumed invisible and /// no reflow is performed. If reflow is suppressed, no reflow will be performed for ForDisplay /// goals. /// /// Returns true if layout actually happened, false otherwise. /// /// NOTE: This method should almost never be called directly! Layout and rendering updates should /// happen as part of the HTML event loop via *update the rendering*. #[allow(unsafe_code)] fn force_reflow( &self, reflow_goal: ReflowGoal, condition: Option, ) -> bool { self.Document().ensure_safe_to_run_script_or_layout(); // If layouts are blocked, we block all layouts that are for display only. Other // layouts (for queries and scrolling) are not blocked, as they do not display // anything and script excpects the layout to be up-to-date after they run. let layout_blocked = self.layout_blocker.get().layout_blocked(); let pipeline_id = self.pipeline_id(); if reflow_goal == ReflowGoal::UpdateTheRendering && layout_blocked { debug!("Suppressing pre-load-event reflow pipeline {pipeline_id}"); return false; } if condition != Some(ReflowTriggerCondition::PaintPostponed) { debug!( "Invalidating layout cache due to reflow condition {:?}", condition ); // Invalidate any existing cached layout values. self.layout_marker.borrow().set(false); // Create a new layout caching token. *self.layout_marker.borrow_mut() = Rc::new(Cell::new(true)); } else { debug!("Not invalidating cached layout values for paint-only reflow."); } debug!("script: performing reflow for goal {reflow_goal:?}"); let marker = if self.need_emit_timeline_marker(TimelineMarkerType::Reflow) { Some(TimelineMarker::start("Reflow".to_owned())) } else { None }; // On debug mode, print the reflow event information. if self.relayout_event { debug_reflow_events(pipeline_id, &reflow_goal); } let document = self.Document(); let stylesheets_changed = document.flush_stylesheets_for_reflow(); // If this reflow is for display, ensure webgl canvases are composited with // up-to-date contents. let for_display = reflow_goal.needs_display(); if for_display { document.flush_dirty_webgl_canvases(); } let pending_restyles = document.drain_pending_restyles(); let dirty_root = document .take_dirty_root() .filter(|_| !stylesheets_changed) .or_else(|| document.GetDocumentElement()) .map(|root| root.upcast::().to_trusted_node_address()); // Send new document and relevant styles to layout. let reflow = ReflowRequest { reflow_info: Reflow { page_clip_rect: self.page_clip_rect.get(), }, document: document.upcast::().to_trusted_node_address(), dirty_root, stylesheets_changed, window_size: self.window_size.get(), origin: self.origin().immutable().clone(), reflow_goal, dom_count: document.dom_count(), pending_restyles, animation_timeline_value: document.current_animation_timeline_value(), animations: document.animations().sets.clone(), theme: self.theme.get(), }; let Some(results) = self.layout.borrow_mut().reflow(reflow) else { return false; }; debug!("script: layout complete"); if let Some(marker) = marker { self.emit_timeline_marker(marker.end()); } // Either this reflow caused new contents to be displayed or on the next // full layout attempt a reflow should be forced in order to update the // visual contents of the page. A case where full display might be delayed // is when reflowing just for the purpose of doing a layout query. document.set_needs_paint(!for_display); for image in results.pending_images { let id = image.id; let node = unsafe { from_untrusted_node_address(image.node) }; if let PendingImageState::Unrequested(ref url) = image.state { fetch_image_for_layout(url.clone(), &node, id, self.image_cache.clone()); } let mut images = self.pending_layout_images.borrow_mut(); let nodes = images.entry(id).or_default(); if !nodes.iter().any(|n| std::ptr::eq(&**n, &*node)) { let trusted_node = Trusted::new(&*node); let sender = self.register_image_cache_listener(id, move |response| { trusted_node .root() .owner_window() .pending_layout_image_notification(response); }); self.image_cache .add_listener(ImageResponder::new(sender, self.pipeline_id(), id)); nodes.push(Dom::from_ref(&*node)); } } let size_messages = self .Document() .iframes_mut() .handle_new_iframe_sizes_after_layout(results.iframe_sizes, self.device_pixel_ratio()); if !size_messages.is_empty() { self.send_to_constellation(ScriptMsg::IFrameSizes(size_messages)); } document.update_animations_post_reflow(); self.update_constellation_epoch(); true } /// Reflows the page if it's possible to do so and the page is dirty. Returns true if layout /// actually happened, false otherwise. /// /// NOTE: This method should almost never be called directly! Layout and rendering updates /// should happen as part of the HTML event loop via *update the rendering*. Currerntly, the /// only exceptions are script queries and scroll requests. pub(crate) fn reflow(&self, reflow_goal: ReflowGoal, can_gc: CanGc) -> bool { // Count the pending web fonts before layout, in case a font loads during the layout. let waiting_for_web_fonts_to_load = self.font_context.web_fonts_still_loading() != 0; self.Document().ensure_safe_to_run_script_or_layout(); let mut issued_reflow = false; let condition = self.Document().needs_reflow(); let updating_the_rendering = reflow_goal == ReflowGoal::UpdateTheRendering; let for_display = reflow_goal.needs_display(); if !updating_the_rendering || condition.is_some() { debug!("Reflowing document ({:?})", self.pipeline_id()); issued_reflow = self.force_reflow(reflow_goal, condition); // We shouldn't need a reflow immediately after a completed reflow, unless the reflow didn't // display anything and it wasn't for display. Queries can cause this to happen. if issued_reflow { let condition = self.Document().needs_reflow(); let display_is_pending = condition == Some(ReflowTriggerCondition::PaintPostponed); assert!( condition.is_none() || (display_is_pending && !for_display), "Needed reflow after reflow: {:?}", condition ); } } else { debug!( "Document ({:?}) doesn't need reflow - skipping it (goal {reflow_goal:?})", self.pipeline_id() ); } let document = self.Document(); let font_face_set = document.Fonts(can_gc); let is_ready_state_complete = document.ReadyState() == DocumentReadyState::Complete; // From https://drafts.csswg.org/css-font-loading/#font-face-set-ready: // > A FontFaceSet is pending on the environment if any of the following are true: // > - the document is still loading // > - the document has pending stylesheet requests // > - the document has pending layout operations which might cause the user agent to request // > a font, or which depend on recently-loaded fonts // // Thus, we are queueing promise resolution here. This reflow should have been triggered by // a "rendering opportunity" in `ScriptThread::handle_web_font_loaded, which should also // make sure a microtask checkpoint happens, triggering the promise callback. if !waiting_for_web_fonts_to_load && is_ready_state_complete { font_face_set.fulfill_ready_promise_if_needed(can_gc); } // If writing a screenshot, check if the script has reached a state // where it's safe to write the image. This means that: // 1) The reflow is for display (otherwise it could be a query) // 2) The html element doesn't contain the 'reftest-wait' class // 3) The load event has fired. // When all these conditions are met, notify the constellation // that this pipeline is ready to write the image (from the script thread // perspective at least). if opts::get().wait_for_stable_image && updating_the_rendering { // Checks if the html element has reftest-wait attribute present. // See http://testthewebforward.org/docs/reftests.html // and https://web-platform-tests.org/writing-tests/crashtest.html let html_element = document.GetDocumentElement(); let reftest_wait = html_element.is_some_and(|elem| { elem.has_class(&atom!("reftest-wait"), CaseSensitivity::CaseSensitive) || elem.has_class(&Atom::from("test-wait"), CaseSensitivity::CaseSensitive) }); let has_sent_idle_message = self.has_sent_idle_message.get(); let pending_images = !self.pending_layout_images.borrow().is_empty(); if !has_sent_idle_message && is_ready_state_complete && !reftest_wait && !pending_images && !waiting_for_web_fonts_to_load { debug!( "{:?}: Sending DocumentState::Idle to Constellation", self.pipeline_id() ); let event = ScriptMsg::SetDocumentState(DocumentState::Idle); self.send_to_constellation(event); self.has_sent_idle_message.set(true); } } issued_reflow } /// If parsing has taken a long time and reflows are still waiting for the `load` event, /// start allowing them. See . pub(crate) fn reflow_if_reflow_timer_expired(&self, can_gc: CanGc) { // Only trigger a long parsing time reflow if we are in the first parse of `` // and it started more than `INITIAL_REFLOW_DELAY` ago. if !matches!( self.layout_blocker.get(), LayoutBlocker::Parsing(instant) if instant + INITIAL_REFLOW_DELAY < Instant::now() ) { return; } self.allow_layout_if_necessary(can_gc); } /// Block layout for this `Window` until parsing is done. If parsing takes a long time, /// we want to layout anyway, so schedule a moment in the future for when layouts are /// allowed even though parsing isn't finished and we havne't sent a load event. pub(crate) fn prevent_layout_until_load_event(&self) { // If we have already started parsing or have already fired a load event, then // don't delay the first layout any longer. if !matches!(self.layout_blocker.get(), LayoutBlocker::WaitingForParse) { return; } self.layout_blocker .set(LayoutBlocker::Parsing(Instant::now())); } /// Inform the [`Window`] that layout is allowed either because `load` has happened /// or because parsing the `` took so long that we cannot wait any longer. pub(crate) fn allow_layout_if_necessary(&self, can_gc: CanGc) { if matches!( self.layout_blocker.get(), LayoutBlocker::FiredLoadEventOrParsingTimerExpired ) { return; } self.layout_blocker .set(LayoutBlocker::FiredLoadEventOrParsingTimerExpired); self.Document().set_needs_paint(true); // We do this immediately instead of scheduling a future task, because this can // happen if parsing is taking a very long time, which means that the // `ScriptThread` is busy doing the parsing and not doing layouts. // // TOOD(mrobinson): It's expected that this is necessary when in the process of // parsing, as we need to interrupt it to update contents, but why is this // necessary when parsing finishes? Not doing the synchronous update in that case // causes iframe tests to become flaky. It seems there's an issue with the timing of // iframe size updates. // // See self.reflow(ReflowGoal::UpdateTheRendering, can_gc); } pub(crate) fn layout_blocked(&self) -> bool { self.layout_blocker.get().layout_blocked() } /// If writing a screenshot, synchronously update the layout epoch that it set /// in the constellation. pub(crate) fn update_constellation_epoch(&self) { if !opts::get().wait_for_stable_image { return; } let epoch = self.layout.borrow().current_epoch(); debug!( "{:?}: Updating constellation epoch: {epoch:?}", self.pipeline_id() ); let (sender, receiver) = ipc::channel().expect("Failed to create IPC channel!"); let event = ScriptMsg::SetLayoutEpoch(epoch, sender); self.send_to_constellation(event); let _ = receiver.recv(); } pub(crate) fn layout_reflow(&self, query_msg: QueryMsg, can_gc: CanGc) -> bool { self.reflow(ReflowGoal::LayoutQuery(query_msg), can_gc) } pub(crate) fn resolved_font_style_query( &self, node: &Node, value: String, can_gc: CanGc, ) -> Option> { if !self.layout_reflow(QueryMsg::ResolvedFontStyleQuery, can_gc) { return None; } let document = self.Document(); let animations = document.animations().sets.clone(); self.layout.borrow().query_resolved_font_style( node.to_trusted_node_address(), &value, animations, document.current_animation_timeline_value(), ) } // Query content box without considering any reflow pub(crate) fn content_box_query_unchecked(&self, node: &Node) -> Option> { self.layout.borrow().query_content_box(node.to_opaque()) } pub(crate) fn content_box_query(&self, node: &Node, can_gc: CanGc) -> Option> { if !self.layout_reflow(QueryMsg::ContentBox, can_gc) { return None; } self.content_box_query_unchecked(node) } pub(crate) fn content_boxes_query(&self, node: &Node, can_gc: CanGc) -> Vec> { if !self.layout_reflow(QueryMsg::ContentBoxes, can_gc) { return vec![]; } self.layout.borrow().query_content_boxes(node.to_opaque()) } pub(crate) fn client_rect_query(&self, node: &Node, can_gc: CanGc) -> UntypedRect { if !self.layout_reflow(QueryMsg::ClientRectQuery, can_gc) { return Rect::zero(); } self.layout.borrow().query_client_rect(node.to_opaque()) } /// Find the scroll area of the given node, if it is not None. If the node /// is None, find the scroll area of the viewport. pub(crate) fn scrolling_area_query( &self, node: Option<&Node>, can_gc: CanGc, ) -> UntypedRect { let opaque = node.map(|node| node.to_opaque()); if !self.layout_reflow(QueryMsg::ScrollingAreaQuery, can_gc) { return Rect::zero(); } self.layout.borrow().query_scrolling_area(opaque) } pub(crate) fn scroll_offset_query(&self, node: &Node) -> Vector2D { if let Some(scroll_offset) = self.scroll_offsets.borrow().get(&node.to_opaque()) { return *scroll_offset; } Vector2D::new(0.0, 0.0) } // https://drafts.csswg.org/cssom-view/#element-scrolling-members pub(crate) fn scroll_node( &self, node: &Node, x_: f64, y_: f64, behavior: ScrollBehavior, can_gc: CanGc, ) { // The scroll offsets are immediatly updated since later calls // to topScroll and others may access the properties before // webrender has a chance to update the offsets. self.scroll_offsets .borrow_mut() .insert(node.to_opaque(), Vector2D::new(x_ as f32, y_ as f32)); let scroll_id = ExternalScrollId( combine_id_with_fragment_type(node.to_opaque().id(), FragmentType::FragmentBody), self.pipeline_id().into(), ); // Step 12 self.perform_a_scroll( x_.to_f32().unwrap_or(0.0f32), y_.to_f32().unwrap_or(0.0f32), scroll_id, behavior, None, can_gc, ); } pub(crate) fn resolved_style_query( &self, element: TrustedNodeAddress, pseudo: Option, property: PropertyId, can_gc: CanGc, ) -> DOMString { if !self.layout_reflow(QueryMsg::ResolvedStyleQuery, can_gc) { return DOMString::new(); } let document = self.Document(); let animations = document.animations().sets.clone(); DOMString::from(self.layout.borrow().query_resolved_style( element, pseudo, property, animations, document.current_animation_timeline_value(), )) } /// If the given |browsing_context_id| refers to an `