[−][src]Struct script::dom::window::Window

#[repr(C)]pub struct Window {
    globalscope: GlobalScope,
    script_chan: MainThreadScriptChan,
    task_manager: TaskManager,
    navigator: MutNullableDom<Navigator>,
    image_cache: Arc<dyn ImageCache>,
    image_cache_chan: Sender<ImageCacheMsg>,
    window_proxy: MutNullableDom<WindowProxy>,
    document: MutNullableDom<Document>,
    location: MutNullableDom<Location>,
    history: MutNullableDom<History>,
    custom_element_registry: MutNullableDom<CustomElementRegistry>,
    performance: MutNullableDom<Performance>,
    navigation_start: Cell<u64>,
    navigation_start_precise: Cell<u64>,
    screen: MutNullableDom<Screen>,
    session_storage: MutNullableDom<Storage>,
    local_storage: MutNullableDom<Storage>,
    status: DomRefCell<DOMString>,
    devtools_markers: DomRefCell<HashSet<TimelineMarkerType>>,
    devtools_marker_sender: DomRefCell<Option<IpcSender<Option<TimelineMarker>>>>,
    resize_event: Cell<Option<(WindowSizeData, WindowSizeType)>>,
    parent_info: Option<PipelineId>,
    dom_static: GlobalStaticData,
    js_runtime: DomRefCell<Option<Rc<Runtime>>>,
    layout_chan: Sender<Msg>,
    layout_rpc: Box<dyn LayoutRPC + Send + 'static>,
    window_size: Cell<WindowSizeData>,
    bluetooth_thread: IpcSender<BluetoothRequest>,
    bluetooth_extra_permission_data: BluetoothExtraPermissionData,
    page_clip_rect: Cell<UntypedRect<Au>>,
    suppress_reflow: Cell<bool>,
    pending_reflow_count: Cell<u32>,
    webdriver_script_chan: DomRefCell<Option<IpcSender<WebDriverJSResult>>>,
    current_state: Cell<WindowState>,
    current_viewport: Cell<UntypedRect<Au>>,
    error_reporter: CSSErrorReporter,
    scroll_offsets: DomRefCell<HashMap<OpaqueNode, Vector2D<f32, LayoutPixel>>>,
    media_query_lists: DOMTracker<MediaQueryList>,
    test_runner: MutNullableDom<TestRunner>,
    webgl_chan: Option<WebGLChan>,
    webxr_registry: Registry,
    pending_layout_images: DomRefCell<HashMap<PendingImageId, Vec<Dom<Node>>>>,
    unminified_js_dir: DomRefCell<Option<String>>,
    local_script_source: Option<String>,
    test_worklet: MutNullableDom<Worklet>,
    paint_worklet: MutNullableDom<Worklet>,
    webrender_document: DocumentId,
    exists_mut_observer: Cell<bool>,
    webrender_api_sender: WebrenderIpcSender,
    has_sent_idle_message: Cell<bool>,
    layout_is_busy: Arc<AtomicBool>,
    relayout_event: bool,
    prepare_for_screenshot: bool,
    unminify_js: bool,
    userscripts_path: Option<String>,
    replace_surrogates: bool,
    player_context: WindowGLContext,
    event_loop_waker: Option<Box<dyn EventLoopWaker>>,
    visible: Cell<bool>,
    layout_marker: DomRefCell<Rc<Cell<bool>>>,
    current_event: DomRefCell<Option<Dom<Event>>>,
}

Fields

globalscope: GlobalScopescript_chan: MainThreadScriptChantask_manager: TaskManagernavigator: MutNullableDom<Navigator>image_cache: Arc<dyn ImageCache>image_cache_chan: Sender<ImageCacheMsg>window_proxy: MutNullableDom<WindowProxy>document: MutNullableDom<Document>location: MutNullableDom<Location>history: MutNullableDom<History>custom_element_registry: MutNullableDom<CustomElementRegistry>performance: MutNullableDom<Performance>navigation_start: Cell<u64>navigation_start_precise: Cell<u64>screen: MutNullableDom<Screen>session_storage: MutNullableDom<Storage>local_storage: MutNullableDom<Storage>status: DomRefCell<DOMString>devtools_markers: DomRefCell<HashSet<TimelineMarkerType>>

For sending timeline markers. Will be ignored if no devtools server

devtools_marker_sender: DomRefCell<Option<IpcSender<Option<TimelineMarker>>>>resize_event: Cell<Option<(WindowSizeData, WindowSizeType)>>

Pending resize event, if any.

parent_info: Option<PipelineId>

Parent id associated with this page, if any.

dom_static: GlobalStaticData

Global static data related to the DOM.

js_runtime: DomRefCell<Option<Rc<Runtime>>>

The JavaScript runtime.

layout_chan: Sender<Msg>

A handle for communicating messages to the layout thread.

This channel shouldn't be accessed directly, but through Window::layout_chan(), which returns None if there's no layout thread anymore.

layout_rpc: Box<dyn LayoutRPC + Send + 'static>

A handle to perform RPC calls into the layout, quickly.

window_size: Cell<WindowSizeData>

The current size of the window, in pixels.

bluetooth_thread: IpcSender<BluetoothRequest>

A handle for communicating messages to the bluetooth thread.

bluetooth_extra_permission_data: BluetoothExtraPermissionDatapage_clip_rect: Cell<UntypedRect<Au>>

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.

suppress_reflow: Cell<bool>

Flag to suppress reflows. The first reflow will come either with RefreshTick or with FirstLoad. Until those first reflows, we want to suppress others like MissingExplicitReflow.

pending_reflow_count: Cell<u32>

A counter of the number of pending reflows for this window.

webdriver_script_chan: DomRefCell<Option<IpcSender<WebDriverJSResult>>>

A channel for communicating results of async scripts back to the webdriver server

current_state: Cell<WindowState>

The current state of the window object

current_viewport: Cell<UntypedRect<Au>>error_reporter: CSSErrorReporterscroll_offsets: DomRefCell<HashMap<OpaqueNode, Vector2D<f32, LayoutPixel>>>

A list of scroll offsets for each scrollable element.

media_query_lists: DOMTracker<MediaQueryList>

All the MediaQueryLists we need to update

test_runner: MutNullableDom<TestRunner>webgl_chan: Option<WebGLChan>

A handle for communicating messages to the WebGL thread, if available.

webxr_registry: Registrypending_layout_images: DomRefCell<HashMap<PendingImageId, Vec<Dom<Node>>>>

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.

unminified_js_dir: DomRefCell<Option<String>>

Directory to store unminified scripts for this window if unminify-js opt is enabled.

local_script_source: Option<String>

Directory with stored unminified scripts

test_worklet: MutNullableDom<Worklet>

Worklets

paint_worklet: MutNullableDom<Worklet>

https://drafts.css-houdini.org/css-paint-api-1/#paint-worklet

webrender_document: DocumentId

The Webrender Document id associated with this window.

exists_mut_observer: Cell<bool>

Flag to identify whether mutation observers are present(true)/absent(false)

webrender_api_sender: WebrenderIpcSender

Webrender API Sender

has_sent_idle_message: Cell<bool>

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.

layout_is_busy: Arc<AtomicBool>

Flag that indicates if the layout thread is busy handling a request.

relayout_event: bool

Emits notifications when there is a relayout.

prepare_for_screenshot: bool

True if it is safe to write to the image.

unminify_js: bool

Unminify Javascript.

userscripts_path: Option<String>

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.

replace_surrogates: bool

Replace unpaired surrogates in DOM strings with U+FFFD. See https://github.com/servo/servo/issues/6564

player_context: WindowGLContext

Window's GL context from application

event_loop_waker: Option<Box<dyn EventLoopWaker>>

A mechanism to force the compositor to process events.

visible: Cell<bool>layout_marker: DomRefCell<Rc<Cell<bool>>>

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.

current_event: DomRefCell<Option<Dom<Event>>>

https://dom.spec.whatwg.org/#window-current-event

Implementations

`impl Window`[src]

`fn __assert_parent_type(&self)`[src]

`impl Window`[src]

`pub fn task_manager(&self) -> &TaskManager`[src]

`pub fn get_exists_mut_observer(&self) -> bool`[src]

`pub fn set_exists_mut_observer(&self)`[src]

`pub fn clear_js_runtime_for_script_deallocation(&self)`[src]

`pub fn discard_browsing_context(&self)`[src]

A convenience method for https://html.spec.whatwg.org/multipage/#a-browsing-context-is-discarded

`pub fn ignore_all_tasks(&self)`[src]

Cancel all current, and ignore all subsequently queued, tasks.

`pub fn time_profiler_chan(&self) -> &TimeProfilerChan`[src]

Get a sender to the time profiler thread.

`pub fn origin(&self) -> &MutableOrigin`[src]

`pub fn get_cx(&self) -> JSContext`[src]

`pub fn get_js_runtime(&self) -> Ref<Option<Rc<Runtime>>>`[src]

`pub fn main_thread_script_chan(&self) -> &Sender<MainThreadScriptMsg>`[src]

`pub fn parent_info(&self) -> Option<PipelineId>`[src]

`pub fn new_script_pair( &self ) -> (Box<dyn ScriptChan + Send>, Box<dyn ScriptPort + Send>)`[src]

`pub fn image_cache(&self) -> Arc<dyn ImageCache>`[src]

`pub fn window_proxy(&self) -> Root<Dom<WindowProxy>>`[src]

This can panic if it is called after the browsing context has been discarded

`pub fn undiscarded_window_proxy(&self) -> Option<Root<Dom<WindowProxy>>>`[src]

Returns the window proxy if it has not been discarded. https://html.spec.whatwg.org/multipage/#a-browsing-context-is-discarded

`pub fn bluetooth_thread(&self) -> IpcSender<BluetoothRequest>`[src]

`pub fn bluetooth_extra_permission_data(&self) -> &BluetoothExtraPermissionData`[src]

`pub fn css_error_reporter(&self) -> Option<&dyn ParseErrorReporter>`[src]

`pub fn set_scroll_offsets( &self, offsets: HashMap<OpaqueNode, Vector2D<f32, LayoutPixel>> )`[src]

Sets a new list of scroll offsets.

This is called when layout gives us new ones and WebRender is in use.

`pub fn current_viewport(&self) -> UntypedRect<Au>`[src]

`pub(crate) fn webgl_chan(&self) -> Option<WebGLCommandSender>`[src]

`pub fn webxr_registry(&self) -> Registry`[src]

`fn new_paint_worklet(&self) -> Root<Dom<Worklet>>`[src]

`pub fn pending_image_notification(&self, response: PendingImageResponse)`[src]

`pub fn get_webrender_api_sender(&self) -> WebrenderIpcSender`[src]

`pub fn get_userscripts_path(&self) -> Option<String>`[src]

`pub fn replace_surrogates(&self) -> bool`[src]

`pub fn unminify_js(&self) -> bool`[src]

`pub fn get_player_context(&self) -> WindowGLContext`[src]

`pub fn get_event_loop_waker(&self) -> Option<Box<dyn EventLoopWaker>>`[src]

`pub fn dispatch_event_with_target_override(&self, event: &Event) -> EventStatus`[src]

`impl Window`[src]

`pub(crate) fn set_current_event( &self, event: Option<&Event> ) -> Option<Root<Dom<Event>>>`[src]

`fn post_message_impl( &self, target_origin: &USVString, source_origin: ImmutableOrigin, source: &Window, cx: JSContext, message: HandleValue, transfer: CustomAutoRooterGuard<Vec<*mut JSObject>> ) -> Result<(), Error>`[src]

https://html.spec.whatwg.org/multipage/#window-post-message-steps

`pub fn paint_worklet(&self) -> Root<Dom<Worklet>>`[src]

`pub fn get_navigation_start(&self) -> u64`[src]

`pub fn has_document(&self) -> bool`[src]

`pub fn cancel_all_tasks(&self)`[src]

Cancels all the tasks associated with that window.

This sets the current task_manager.task_cancellers sentinel value to true and replaces it with a brand new one for future tasks.

`pub fn cancel_all_tasks_from_source(&self, task_source_name: TaskSourceName)`[src]

Cancels all the tasks from a given task source. This sets the current sentinel value to true and replaces it with a brand new one for future tasks.

`pub fn clear_js_runtime(&self)`[src]

`pub fn scroll(&self, x_: f64, y_: f64, behavior: ScrollBehavior)`[src]

https://drafts.csswg.org/cssom-view/#dom-window-scroll

`pub fn perform_a_scroll( &self, x: f32, y: f32, scroll_id: ExternalScrollId, _behavior: ScrollBehavior, _element: Option<&Element> )`[src]

https://drafts.csswg.org/cssom-view/#perform-a-scroll

`pub fn update_viewport_for_scroll(&self, x: f32, y: f32)`[src]

`pub fn device_pixel_ratio(&self) -> Scale<f32, CSSPixel, DevicePixel>`[src]

`fn client_window(&self) -> (Size2D<u32, CSSPixel>, Point2D<i32, CSSPixel>)`[src]

`pub fn advance_animation_clock(&self, delta_ms: i32)`[src]

Prepares to tick animations and then does a reflow which also advances the layout animation clock.

`pub fn force_reflow( &self, reflow_goal: ReflowGoal, reason: ReflowReason, condition: Option<ReflowTriggerCondition> ) -> bool`[src]

Reflows the page unconditionally if possible and not suppressed. This method will wait for the layout thread to complete (but see the TODO below). 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.

TODO(pcwalton): Only wait for style recalc, since we have off-main-thread layout.

Returns true if layout actually happened, false otherwise.

`pub fn reflow(&self, reflow_goal: ReflowGoal, reason: ReflowReason) -> bool`[src]

Reflows the page if it's possible to do so and the page is dirty. This method will wait for the layout thread to complete (but see the TODO below). If there is no window size yet, the page is presumed invisible and no reflow is performed.

TODO(pcwalton): Only wait for style recalc, since we have off-main-thread layout.

Returns true if layout actually happened, false otherwise. This return value is useful for script queries, that wait for a lock that layout might hold if the first layout hasn't happened yet (which may happen in the only case a query reflow may bail out, that is, if the viewport size is not present). See #11223 for an example of that.