Struct script::dom::window::Window

source ·

#[repr(C)]
pub struct Window {Show 61 fields
    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: 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>>

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: BluetoothExtraPermissionData§page_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: CSSErrorReporter§scroll_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: Registry§pending_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

Struct script::dom::window::Window

Fields§

Implementations§

impl Window

fn __assert_parent_type(&self)

impl Window

pub fn task_manager(&self) -> &TaskManager

pub fn get_exists_mut_observer(&self) -> bool

pub fn set_exists_mut_observer(&self)

pub fn clear_js_runtime_for_script_deallocation(&self)

pub fn discard_browsing_context(&self)

pub fn ignore_all_tasks(&self)

pub fn time_profiler_chan(&self) -> &TimeProfilerChan

pub fn origin(&self) -> &MutableOrigin

pub fn get_cx(&self) -> JSContext

pub fn get_js_runtime(&self) -> Ref<'_, Option<Rc<Runtime>>>

pub fn main_thread_script_chan(&self) -> &Sender<MainThreadScriptMsg>

pub fn parent_info(&self) -> Option<PipelineId>

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

pub fn image_cache(&self) -> Arc<dyn ImageCache>

pub fn window_proxy(&self) -> Root<Dom<WindowProxy>>

pub fn undiscarded_window_proxy(&self) -> Option<Root<Dom<WindowProxy>>>

pub fn bluetooth_thread(&self) -> IpcSender<BluetoothRequest>

pub fn bluetooth_extra_permission_data(&self) -> &BluetoothExtraPermissionData

pub fn css_error_reporter(&self) -> Option<&dyn ParseErrorReporter>

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

pub fn current_viewport(&self) -> UntypedRect<Au>

pub(crate) fn webgl_chan(&self) -> Option<WebGLCommandSender>

pub fn webxr_registry(&self) -> Registry

fn new_paint_worklet(&self) -> Root<Dom<Worklet>>

pub fn pending_image_notification(&self, response: PendingImageResponse)

pub fn get_webrender_api_sender(&self) -> WebrenderIpcSender

pub fn get_userscripts_path(&self) -> Option<String>

pub fn replace_surrogates(&self) -> bool

pub fn unminify_js(&self) -> bool

pub fn get_player_context(&self) -> WindowGLContext

pub fn get_event_loop_waker(&self) -> Option<Box<dyn EventLoopWaker>>

pub fn dispatch_event_with_target_override(&self, event: &Event) -> EventStatus

impl Window

pub fn create_named_properties_object( cx: JSContext, proto: HandleObject<'_>, object: MutableHandleObject<'_>)

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

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

pub fn paint_worklet(&self) -> Root<Dom<Worklet>>

pub fn get_navigation_start(&self) -> u64

pub fn has_document(&self) -> bool

pub fn cancel_all_tasks(&self)

pub fn cancel_all_tasks_from_source(&self, task_source_name: TaskSourceName)

pub fn clear_js_runtime(&self)

pub fn scroll(&self, x_: f64, y_: f64, behavior: ScrollBehavior)

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

pub fn update_viewport_for_scroll(&self, x: f32, y: f32)

pub fn device_pixel_ratio(&self) -> Scale<f32, CSSPixel, DevicePixel>

fn client_window(&self) -> (Size2D<u32, CSSPixel>, Point2D<i32, CSSPixel>)

pub fn advance_animation_clock(&self, delta_ms: i32)

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

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

pub fn layout_reflow(&self, query_msg: QueryMsg) -> bool

pub fn resolved_font_style_query( &self, node: &Node, value: String) -> Option<ServoArc<Font>>

pub fn layout(&self) -> &dyn LayoutRPC

pub fn content_box_query(&self, node: &Node) -> Option<UntypedRect<Au>>

pub fn content_boxes_query(&self, node: &Node) -> Vec<UntypedRect<Au>> ⓘ

pub fn client_rect_query(&self, node: &Node) -> UntypedRect<i32>

pub fn scroll_area_query(&self, node: &Node) -> UntypedRect<i32>

pub fn scroll_offset_query(&self, node: &Node) -> Vector2D<f32, LayoutPixel>

pub fn scroll_node(&self, node: &Node, x_: f64, y_: f64, behavior: ScrollBehavior)

pub fn resolved_style_query( &self, element: TrustedNodeAddress, pseudo: Option<PseudoElement>, property: PropertyId) -> DOMString

pub fn inner_window_dimensions_query( &self, browsing_context: BrowsingContextId) -> Option<Size2D<f32, CSSPixel>>

pub fn offset_parent_query( &self, node: &Node) -> (Option<Root<Dom<Element>>>, UntypedRect<Au>)

pub fn text_index_query( &self, node: &Node, point_in_node: UntypedPoint2D<f32>) -> TextIndexResponse

pub fn init_window_proxy(&self, window_proxy: &WindowProxy)

pub fn init_document(&self, document: &Document)

pub fn load_url( &self, replace: HistoryEntryReplacement, force_reload: bool, load_data: LoadData)

pub fn handle_fire_timer(&self, timer_id: TimerEventId)

pub fn set_window_size(&self, size: WindowSizeData)

pub fn window_size(&self) -> WindowSizeData

pub fn get_url(&self) -> ServoUrl

pub fn layout_chan(&self) -> Option<&Sender<Msg>>

pub fn windowproxy_handler(&self) -> WindowProxyHandler

pub fn get_pending_reflow_count(&self) -> u32

pub fn add_pending_reflow(&self)

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

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

pub fn create_named_properties_object(
cx: JSContext,
proto: HandleObject<'_>,
object: MutableHandleObject<'_>
)

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

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

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

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

pub fn resolved_font_style_query(
&self,
node: &Node,
value: String
) -> Option<ServoArc<Font>>

pub fn resolved_style_query(
&self,
element: TrustedNodeAddress,
pseudo: Option<PseudoElement>,
property: PropertyId
) -> DOMString

pub fn inner_window_dimensions_query(
&self,
browsing_context: BrowsingContextId
) -> Option<Size2D<f32, CSSPixel>>

pub fn offset_parent_query(
&self,
node: &Node
) -> (Option<Root<Dom<Element>>>, UntypedRect<Au>)

pub fn text_index_query(
&self,
node: &Node,
point_in_node: UntypedPoint2D<f32>
) -> TextIndexResponse

pub fn load_url(
&self,
replace: HistoryEntryReplacement,
force_reload: bool,
load_data: LoadData
)

pub fn set_page_clip_rect_with_new_viewport(
&self,
viewport: UntypedRect<f32>
) -> bool

pub fn need_emit_timeline_marker(
&self,
timeline_type: TimelineMarkerType
) -> bool

pub fn set_devtools_timeline_markers(
&self,
markers: Vec<TimelineMarkerType>,
reply: IpcSender<Option<TimelineMarker>>
)

pub fn set_webdriver_script_chan(
&self,
chan: Option<IpcSender<WebDriverJSResult>>
)

pub fn cache_layout_value<T>(&self, value: T) -> LayoutValue<T>where
T: Copy + JSTraceable + MallocSizeOf,

pub fn post_message(
&self,
target_origin: Option<ImmutableOrigin>,
source_origin: ImmutableOrigin,
source: &WindowProxy,
data: StructuredSerializedData
)

fn is<T>(&self) -> boolwhere
T: DerivedFrom<Self>,

fn upcast<T>(&self) -> &Twhere
T: Castable,
Self: DerivedFrom<T>,

fn downcast<T>(&self) -> Option<&T>where
T: DerivedFrom<Self>,

fn global(&self) -> Root<Dom<GlobalScope>>where
Self: Sized,

fn PostMessage_(
&self,
cx: JSContext,
message: HandleValue<'_>,
options: RootedTraceableBox<WindowPostMessageOptions>
) -> Result<(), Error>

fn Open(
&self,
url: USVString,
target: DOMString,
features: DOMString
) -> Result<Option<Root<Dom<WindowProxy>>>, Error>