Struct script::dom::document::Document

source ·

#[repr(C)]
pub struct Document {Show 94 fields
    node: Node,
    document_or_shadow_root: DocumentOrShadowRoot,
    window: Dom<Window>,
    implementation: MutNullableDom<DOMImplementation>,
    content_type: Mime,
    last_modified: Option<String>,
    encoding: Cell<&'static Encoding>,
    has_browsing_context: bool,
    is_html_document: bool,
    activity: Cell<DocumentActivity>,
    url: DomRefCell<ServoUrl>,
    quirks_mode: Cell<QuirksMode>,
    id_map: DomRefCell<HashMap<Atom, Vec<Dom<Element>>>>,
    name_map: DomRefCell<HashMap<Atom, Vec<Dom<Element>>>>,
    tag_map: DomRefCell<HashMap<LocalName, Dom<HTMLCollection>>>,
    tagns_map: DomRefCell<HashMap<QualName, Dom<HTMLCollection>>>,
    classes_map: DomRefCell<HashMap<Vec<Atom>, Dom<HTMLCollection>>>,
    images: MutNullableDom<HTMLCollection>,
    embeds: MutNullableDom<HTMLCollection>,
    links: MutNullableDom<HTMLCollection>,
    forms: MutNullableDom<HTMLCollection>,
    scripts: MutNullableDom<HTMLCollection>,
    anchors: MutNullableDom<HTMLCollection>,
    applets: MutNullableDom<HTMLCollection>,
    style_shared_lock: StyleSharedRwLock,
    stylesheets: DomRefCell<DocumentStylesheetSet<StyleSheetInDocument>>,
    stylesheet_list: MutNullableDom<StyleSheetList>,
    ready_state: Cell<DocumentReadyState>,
    domcontentloaded_dispatched: Cell<bool>,
    focus_transaction: DomRefCell<FocusTransaction>,
    focused: MutNullableDom<Element>,
    current_script: MutNullableDom<HTMLScriptElement>,
    pending_parsing_blocking_script: DomRefCell<Option<PendingScript>>,
    script_blocking_stylesheets_count: Cell<u32>,
    deferred_scripts: PendingInOrderScriptVec,
    asap_in_order_scripts_list: PendingInOrderScriptVec,
    asap_scripts_set: DomRefCell<Vec<Dom<HTMLScriptElement>>>,
    scripting_enabled: bool,
    animation_frame_ident: Cell<u32>,
    animation_frame_list: DomRefCell<Vec<(u32, Option<AnimationFrameCallback>)>>,
    running_animation_callbacks: Cell<bool>,
    loader: DomRefCell<DocumentLoader>,
    current_parser: MutNullableDom<ServoParser>,
    reflow_timeout: Cell<Option<u64>>,
    base_element: MutNullableDom<HTMLBaseElement>,
    appropriate_template_contents_owner_document: MutNullableDom<Document>,
    pending_restyles: DomRefCell<HashMap<Dom<Element>, PendingRestyle>>,
    needs_paint: Cell<bool>,
    active_touch_points: DomRefCell<Vec<Dom<Touch>>>,
    dom_loading: Cell<u64>,
    dom_interactive: Cell<u64>,
    dom_content_loaded_event_start: Cell<u64>,
    dom_content_loaded_event_end: Cell<u64>,
    dom_complete: Cell<u64>,
    top_level_dom_complete: Cell<u64>,
    load_event_start: Cell<u64>,
    load_event_end: Cell<u64>,
    unload_event_start: Cell<u64>,
    unload_event_end: Cell<u64>,
    https_state: Cell<HttpsState>,
    origin: MutableOrigin,
    referrer_policy: Cell<Option<ReferrerPolicy>>,
    referrer: Option<String>,
    target_element: MutNullableDom<Element>,
    last_click_info: DomRefCell<Option<(Instant, Point2D<f32>)>>,
    ignore_destructive_writes_counter: Cell<u32>,
    ignore_opens_during_unload_counter: Cell<u32>,
    spurious_animation_frames: Cell<u8>,
    dom_count: Cell<u32>,
    fullscreen_element: MutNullableDom<Element>,
    form_id_listener_map: DomRefCell<HashMap<Atom, HashSet<Dom<Element>>>>,
    interactive_time: DomRefCell<InteractiveMetrics>,
    tti_window: DomRefCell<InteractiveWindow>,
    canceller: FetchCanceller,
    throw_on_dynamic_markup_insertion_counter: Cell<u64>,
    page_showing: Cell<bool>,
    salvageable: Cell<bool>,
    active_parser_was_aborted: Cell<bool>,
    fired_unload: Cell<bool>,
    responsive_images: DomRefCell<Vec<Dom<HTMLImageElement>>>,
    redirect_count: Cell<u16>,
    script_and_layout_blockers: Cell<u32>,
    delayed_tasks: DomRefCell<Vec<Box<dyn TaskBox>>>,
    completely_loaded: Cell<bool>,
    shadow_roots: DomRefCell<HashSet<Dom<ShadowRoot>>>,
    shadow_roots_styles_changed: Cell<bool>,
    media_controls: DomRefCell<HashMap<String, Dom<ShadowRoot>>>,
    dirty_webgl_contexts: DomRefCell<HashMap<WebGLContextId, Dom<WebGLRenderingContext>>>,
    dirty_webgpu_contexts: DomRefCell<HashMap<WebGPUContextId, Dom<GPUCanvasContext>>>,
    csp_list: DomRefCell<Option<CspList>>,
    selection: MutNullableDom<Selection>,
    animation_timeline: DomRefCell<AnimationTimeline>,
    animations: DomRefCell<Animations>,
    dirty_root: MutNullableDom<Element>,
}

Expand description

https://dom.spec.whatwg.org/#document

Fields§

§node: Node§document_or_shadow_root: DocumentOrShadowRoot§window: Dom<Window>§implementation: MutNullableDom<DOMImplementation>§content_type: Mime§last_modified: Option<String>§encoding: Cell<&'static Encoding>§has_browsing_context: bool§is_html_document: bool§activity: Cell<DocumentActivity>§url: DomRefCell<ServoUrl>§quirks_mode: Cell<QuirksMode>§id_map: DomRefCell<HashMap<Atom, Vec<Dom<Element>>>>

Caches for the getElement methods

§name_map: DomRefCell<HashMap<Atom, Vec<Dom<Element>>>>§tag_map: DomRefCell<HashMap<LocalName, Dom<HTMLCollection>>>§tagns_map: DomRefCell<HashMap<QualName, Dom<HTMLCollection>>>§classes_map: DomRefCell<HashMap<Vec<Atom>, Dom<HTMLCollection>>>§images: MutNullableDom<HTMLCollection>§embeds: MutNullableDom<HTMLCollection>§links: MutNullableDom<HTMLCollection>§forms: MutNullableDom<HTMLCollection>§scripts: MutNullableDom<HTMLCollection>§anchors: MutNullableDom<HTMLCollection>§applets: MutNullableDom<HTMLCollection>§style_shared_lock: StyleSharedRwLock

Lock use for style attributes and author-origin stylesheet objects in this document. Can be acquired once for accessing many objects.

§stylesheets: DomRefCell<DocumentStylesheetSet<StyleSheetInDocument>>

List of stylesheets associated with nodes in this document. |None| if the list needs to be refreshed.

§stylesheet_list: MutNullableDom<StyleSheetList>§ready_state: Cell<DocumentReadyState>§domcontentloaded_dispatched: Cell<bool>

Whether the DOMContentLoaded event has already been dispatched.

§focus_transaction: DomRefCell<FocusTransaction>

The state of this document’s focus transaction.

§focused: MutNullableDom<Element>

The element that currently has the document focus context.

§current_script: MutNullableDom<HTMLScriptElement>

The script element that is currently executing.

§pending_parsing_blocking_script: DomRefCell<Option<PendingScript>>

https://html.spec.whatwg.org/multipage/#pending-parsing-blocking-script

§script_blocking_stylesheets_count: Cell<u32>

Number of stylesheets that block executing the next parser-inserted script

§deferred_scripts: PendingInOrderScriptVec

https://html.spec.whatwg.org/multipage/#list-of-scripts-that-will-execute-when-the-document-has-finished-parsing

§asap_in_order_scripts_list: PendingInOrderScriptVec

https://html.spec.whatwg.org/multipage/#list-of-scripts-that-will-execute-in-order-as-soon-as-possible

§asap_scripts_set: DomRefCell<Vec<Dom<HTMLScriptElement>>>

https://html.spec.whatwg.org/multipage/#set-of-scripts-that-will-execute-as-soon-as-possible

§scripting_enabled: bool

https://html.spec.whatwg.org/multipage/#concept-n-noscript True if scripting is enabled for all scripts in this document

§animation_frame_ident: Cell<u32>

https://html.spec.whatwg.org/multipage/#animation-frame-callback-identifier Current identifier of animation frame callback

§animation_frame_list: DomRefCell<Vec<(u32, Option<AnimationFrameCallback>)>>

https://html.spec.whatwg.org/multipage/#list-of-animation-frame-callbacks List of animation frame callbacks

§running_animation_callbacks: Cell<bool>

Whether we’re in the process of running animation callbacks.

Tracking this is not necessary for correctness. Instead, it is an optimization to avoid sending needless ChangeRunningAnimationsState messages to the compositor.

§loader: DomRefCell<DocumentLoader>

Tracks all outstanding loads related to this document.

§current_parser: MutNullableDom<ServoParser>

The current active HTML parser, to allow resuming after interruptions.

§reflow_timeout: Cell<Option<u64>>

When we should kick off a reflow. This happens during parsing.

§base_element: MutNullableDom<HTMLBaseElement>

The cached first base element with an href attribute.

§appropriate_template_contents_owner_document: MutNullableDom<Document>

This field is set to the document itself for inert documents. https://html.spec.whatwg.org/multipage/#appropriate-template-contents-owner-document

§pending_restyles: DomRefCell<HashMap<Dom<Element>, PendingRestyle>>

Information on elements needing restyle to ship over to the layout thread when the time comes.

§needs_paint: Cell<bool>

This flag will be true if layout suppressed a reflow attempt that was needed in order for the page to be painted.

§active_touch_points: DomRefCell<Vec<Dom<Touch>>>

http://w3c.github.io/touch-events/#dfn-active-touch-point

§dom_loading: Cell<u64>

Navigation Timing properties: https://w3c.github.io/navigation-timing/#sec-PerformanceNavigationTiming

§dom_interactive: Cell<u64>§dom_content_loaded_event_start: Cell<u64>§dom_content_loaded_event_end: Cell<u64>§dom_complete: Cell<u64>§top_level_dom_complete: Cell<u64>§load_event_start: Cell<u64>§load_event_end: Cell<u64>§unload_event_start: Cell<u64>§unload_event_end: Cell<u64>§https_state: Cell<HttpsState>

https://html.spec.whatwg.org/multipage/#concept-document-https-state

§origin: MutableOrigin

The document’s origin.

§referrer_policy: Cell<Option<ReferrerPolicy>>

https://w3c.github.io/webappsec-referrer-policy/#referrer-policy-states

§referrer: Option<String>

https://html.spec.whatwg.org/multipage/#dom-document-referrer

§target_element: MutNullableDom<Element>

https://html.spec.whatwg.org/multipage/#target-element

§last_click_info: DomRefCell<Option<(Instant, Point2D<f32>)>>

https://w3c.github.io/uievents/#event-type-dblclick

§ignore_destructive_writes_counter: Cell<u32>

https://html.spec.whatwg.org/multipage/#ignore-destructive-writes-counter

§ignore_opens_during_unload_counter: Cell<u32>

https://html.spec.whatwg.org/multipage/#ignore-opens-during-unload-counter

§spurious_animation_frames: Cell<u8>

The number of spurious requestAnimationFrame() requests we’ve received.

A rAF request is considered spurious if nothing was actually reflowed.

§dom_count: Cell<u32>

Track the total number of elements in this DOM’s tree. This is sent to the layout thread every time a reflow is done; layout uses this to determine if the gains from parallel layout will be worth the overhead.

See also: https://github.com/servo/servo/issues/10110

§fullscreen_element: MutNullableDom<Element>

Entry node for fullscreen.

§form_id_listener_map: DomRefCell<HashMap<Atom, HashSet<Dom<Element>>>>

Map from ID to set of form control elements that have that ID as their ‘form’ content attribute. Used to reset form controls whenever any element with the same ID as the form attribute is inserted or removed from the document. See https://html.spec.whatwg.org/multipage/#form-owner

§interactive_time: DomRefCell<InteractiveMetrics>§tti_window: DomRefCell<InteractiveWindow>§canceller: FetchCanceller

RAII canceller for Fetch

§throw_on_dynamic_markup_insertion_counter: Cell<u64>

https://html.spec.whatwg.org/multipage/#throw-on-dynamic-markup-insertion-counter

§page_showing: Cell<bool>

https://html.spec.whatwg.org/multipage/#page-showing

§salvageable: Cell<bool>

Whether the document is salvageable.

§active_parser_was_aborted: Cell<bool>

Whether the document was aborted with an active parser

§fired_unload: Cell<bool>

Whether the unload event has already been fired.

§responsive_images: DomRefCell<Vec<Dom<HTMLImageElement>>>

List of responsive images

§redirect_count: Cell<u16>

Number of redirects for the document load

§script_and_layout_blockers: Cell<u32>

Number of outstanding requests to prevent JS or layout from running.

§delayed_tasks: DomRefCell<Vec<Box<dyn TaskBox>>>

List of tasks to execute as soon as last script/layout blocker is removed.

§completely_loaded: Cell<bool>

https://html.spec.whatwg.org/multipage/#completely-loaded

§shadow_roots: DomRefCell<HashSet<Dom<ShadowRoot>>>

Set of shadow roots connected to the document tree.

§shadow_roots_styles_changed: Cell<bool>

Whether any of the shadow roots need the stylesheets flushed.

§media_controls: DomRefCell<HashMap<String, Dom<ShadowRoot>>>

List of registered media controls. We need to keep this list to allow the media controls to access the “privileged” document.servoGetMediaControls(id) API, where id needs to match any of the registered ShadowRoots hosting the media controls UI.

§dirty_webgl_contexts: DomRefCell<HashMap<WebGLContextId, Dom<WebGLRenderingContext>>>

List of all WebGL context IDs that need flushing.

§dirty_webgpu_contexts: DomRefCell<HashMap<WebGPUContextId, Dom<GPUCanvasContext>>>

List of all WebGPU context IDs that need flushing.

§csp_list: DomRefCell<Option<CspList>>

https://html.spec.whatwg.org/multipage/#concept-document-csp-list

§selection: MutNullableDom<Selection>

https://w3c.github.io/slection-api/#dfn-selection

§animation_timeline: DomRefCell<AnimationTimeline>

A timeline for animations which is used for synchronizing animations. https://drafts.csswg.org/web-animations/#timeline

§animations: DomRefCell<Animations>

Animations for this Document

§dirty_root: MutNullableDom<Element>

The nearest inclusive ancestors to all the nodes that require a restyle.

Struct script::dom::document::Document

Fields§

Implementations§

impl Document

pub fn note_node_with_dirty_descendants(&self, node: &Node)

pub fn take_dirty_root(&self) -> Option<Root<Dom<Element>>>

pub fn loader(&self) -> Ref<'_, DocumentLoader>

pub fn loader_mut(&self) -> RefMut<'_, DocumentLoader>

pub fn has_browsing_context(&self) -> bool

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

pub fn window(&self) -> &Window

pub fn is_html_document(&self) -> bool

pub fn set_https_state(&self, https_state: HttpsState)

pub fn is_fully_active(&self) -> bool

pub fn is_active(&self) -> bool

pub fn set_activity(&self, activity: DocumentActivity)

pub fn origin(&self) -> &MutableOrigin

pub fn url(&self) -> ServoUrl

pub fn set_url(&self, url: ServoUrl)

pub fn fallback_base_url(&self) -> ServoUrl

pub fn base_url(&self) -> ServoUrl

pub fn needs_paint(&self) -> bool

pub fn needs_reflow(&self) -> Option<ReflowTriggerCondition>

pub fn base_element(&self) -> Option<Root<Dom<HTMLBaseElement>>>

pub fn refresh_base_element(&self)

pub fn dom_count(&self) -> u32

pub fn increment_dom_count(&self)

pub fn decrement_dom_count(&self)

pub fn quirks_mode(&self) -> QuirksMode

pub fn set_quirks_mode(&self, mode: QuirksMode)

pub fn encoding(&self) -> &'static Encoding

pub fn set_encoding(&self, encoding: &'static Encoding)

pub fn content_and_heritage_changed(&self, node: &Node)

pub fn reflow_if_reflow_timer_expired(&self)

pub fn set_reflow_timeout(&self, timeout: u64)

pub fn unregister_element_id(&self, to_unregister: &Element, id: Atom)

pub fn register_element_id(&self, element: &Element, id: Atom)

pub fn unregister_element_name(&self, to_unregister: &Element, name: Atom)

pub fn register_element_name(&self, element: &Element, name: Atom)

pub fn register_form_id_listener<T: ?Sized + FormControl>( &self, id: DOMString, listener: &T)

pub fn unregister_form_id_listener<T: ?Sized + FormControl>( &self, id: DOMString, listener: &T)

pub fn find_fragment_node(&self, fragid: &str) -> Option<Root<Dom<Element>>>

pub fn check_and_scroll_fragment(&self, fragment: &str)

fn get_anchor_by_name(&self, name: &str) -> Option<Root<Dom<Element>>>

pub fn set_ready_state(&self, state: DocumentReadyState)

pub fn is_scripting_enabled(&self) -> bool

pub fn get_focused_element(&self) -> Option<Root<Dom<Element>>>

fn begin_focus_transaction(&self)

pub(crate) fn perform_focus_fixup_rule(&self, not_focusable: &Element)

pub(crate) fn request_focus(&self, elem: Option<&Element>, focus_type: FocusType)

fn commit_focus_transaction(&self, focus_type: FocusType)

pub fn title_changed(&self)

pub fn send_title_to_embedder(&self)

fn send_to_embedder(&self, msg: EmbedderMsg)

pub fn dirty_all_nodes(&self)

pub unsafe fn handle_mouse_event( &self, button: MouseButton, client_point: Point2D<f32>, mouse_event_type: MouseEventType, node_address: Option<UntrustedNodeAddress>, point_in_node: Option<Point2D<f32>>, pressed_mouse_buttons: u16)

fn maybe_fire_dblclick( &self, click_pos: Point2D<f32>, target: &Node, pressed_mouse_buttons: u16)

pub fn fire_mouse_event( &self, client_point: Point2D<f32>, target: &EventTarget, event_name: FireMouseEventType, can_bubble: EventBubbles, cancelable: EventCancelable, pressed_mouse_buttons: u16)

pub unsafe fn handle_mouse_move_event( &self, client_point: Point2D<f32>, prev_mouse_over_target: &MutNullableDom<Element>, node_address: Option<UntrustedNodeAddress>, pressed_mouse_buttons: u16)

fn handle_mouse_enter_leave_event( &self, client_point: Point2D<f32>, event_type: FireMouseEventType, related_target: Option<Root<Dom<Node>>>, event_target: Root<Dom<Node>>, pressed_mouse_buttons: u16)

pub unsafe fn handle_wheel_event( &self, delta: WheelDelta, client_point: Point2D<f32>, node_address: Option<UntrustedNodeAddress>)

pub unsafe fn handle_touch_event( &self, event_type: TouchEventType, touch_id: TouchId, point: Point2D<f32>, node_address: Option<UntrustedNodeAddress>) -> TouchEventResult

pub fn dispatch_key_event(&self, keyboard_event: KeyboardEvent)

pub fn ime_dismissed(&self)

pub fn dispatch_composition_event(&self, composition_event: CompositionEvent)

pub fn node_from_nodes_and_strings( &self, nodes: Vec<NodeOrString>) -> Result<Root<Dom<Node>>, Error>

pub fn get_body_attribute(&self, local_name: &LocalName) -> DOMString

pub fn set_body_attribute(&self, local_name: &LocalName, value: DOMString)

pub fn set_current_script(&self, script: Option<&HTMLScriptElement>)

pub fn get_script_blocking_stylesheets_count(&self) -> u32

pub fn increment_script_blocking_stylesheet_count(&self)

pub fn decrement_script_blocking_stylesheet_count(&self)

pub fn invalidate_stylesheets(&self)

pub fn request_animation_frame(&self, callback: AnimationFrameCallback) -> u32

pub fn cancel_animation_frame(&self, ident: u32)

pub fn run_the_animation_frame_callbacks(&self)

pub fn fetch_async( &self, load: LoadType, request: RequestBuilder, fetch_target: IpcSender<FetchResponseMsg>)

pub fn finish_load(&self, load: LoadType)

pub fn prompt_to_unload(&self, recursive_flag: bool) -> bool

pub fn unload(&self, recursive_flag: bool)

pub fn register_form_id_listener<T: ?Sized + FormControl>(
&self,
id: DOMString,
listener: &T
)

pub fn unregister_form_id_listener<T: ?Sized + FormControl>(
&self,
id: DOMString,
listener: &T
)

pub unsafe fn handle_mouse_event(
&self,
button: MouseButton,
client_point: Point2D<f32>,
mouse_event_type: MouseEventType,
node_address: Option<UntrustedNodeAddress>,
point_in_node: Option<Point2D<f32>>,
pressed_mouse_buttons: u16
)

fn maybe_fire_dblclick(
&self,
click_pos: Point2D<f32>,
target: &Node,
pressed_mouse_buttons: u16
)

pub fn fire_mouse_event(
&self,
client_point: Point2D<f32>,
target: &EventTarget,
event_name: FireMouseEventType,
can_bubble: EventBubbles,
cancelable: EventCancelable,
pressed_mouse_buttons: u16
)

pub unsafe fn handle_mouse_move_event(
&self,
client_point: Point2D<f32>,
prev_mouse_over_target: &MutNullableDom<Element>,
node_address: Option<UntrustedNodeAddress>,
pressed_mouse_buttons: u16
)

fn handle_mouse_enter_leave_event(
&self,
client_point: Point2D<f32>,
event_type: FireMouseEventType,
related_target: Option<Root<Dom<Node>>>,
event_target: Root<Dom<Node>>,
pressed_mouse_buttons: u16
)

pub unsafe fn handle_wheel_event(
&self,
delta: WheelDelta,
client_point: Point2D<f32>,
node_address: Option<UntrustedNodeAddress>
)

pub unsafe fn handle_touch_event(
&self,
event_type: TouchEventType,
touch_id: TouchId,
point: Point2D<f32>,
node_address: Option<UntrustedNodeAddress>
) -> TouchEventResult

pub fn node_from_nodes_and_strings(
&self,
nodes: Vec<NodeOrString>
) -> Result<Root<Dom<Node>>, Error>

pub fn fetch_async(
&self,
load: LoadType,
request: RequestBuilder,
fetch_target: IpcSender<FetchResponseMsg>
)

pub fn set_pending_parsing_blocking_script(
&self,
script: &HTMLScriptElement,
load: Option<Result<ScriptOrigin, NetworkError>>
)

pub fn pending_parsing_blocking_script_loaded(
&self,
element: &HTMLScriptElement,
result: Result<ScriptOrigin, NetworkError>
)

pub fn asap_script_loaded(
&self,
element: &HTMLScriptElement,
result: Result<ScriptOrigin, NetworkError>
)

pub fn asap_in_order_script_loaded(
&self,
element: &HTMLScriptElement,
result: Result<ScriptOrigin, NetworkError>
)

pub fn deferred_script_loaded(
&self,
element: &HTMLScriptElement,
result: Result<ScriptOrigin, NetworkError>
)

pub fn find_iframe(
&self,
browsing_context_id: BrowsingContextId
) -> Option<Root<Dom<HTMLIFrameElement>>>

fn fire_focus_event(
&self,
focus_event_type: FocusEventType,
node: &Node,
related_target: Option<&EventTarget>
)

pub fn lookup_custom_element_definition(
&self,
namespace: &Namespace,
local_name: &LocalName,
is: Option<&LocalName>
) -> Option<Rc<CustomElementDefinition>>

pub fn should_elements_inline_type_behavior_be_blocked(
&self,
el: &Element,
type_: InlineCheckType,
source: &str
) -> CheckResult

pub fn Constructor(
window: &Window,
proto: Option<HandleObject<'_>>
) -> Result<Root<Dom<Document>>, Error>