servo/components/script/dom/xpathexpression.rs
Simon Wülker 84577c9fd4
script: Allow reusing results from xpath queries (#39392)
This behaviour is optional, but observable. Other browsers implement it,
so we should do it too.

Testing: There are no WPT tests for this, which is fair since the spec
explicitly states implementors may choose to not reuse the result.
Fixes: Part of https://github.com/servo/servo/issues/34527

---------

Signed-off-by: Simon Wülker <simon.wuelker@arcor.de>
2025-09-19 17:19:04 +00:00

97 lines
3.2 KiB
Rust

/* 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::rc::Rc;
use dom_struct::dom_struct;
use js::rust::HandleObject;
use crate::dom::bindings::codegen::Bindings::XPathExpressionBinding::XPathExpressionMethods;
use crate::dom::bindings::codegen::Bindings::XPathNSResolverBinding::XPathNSResolver;
use crate::dom::bindings::error::{Error, Fallible};
use crate::dom::bindings::reflector::{DomGlobal, Reflector, reflect_dom_object_with_proto};
use crate::dom::bindings::root::{Dom, DomRoot};
use crate::dom::node::Node;
use crate::dom::window::Window;
use crate::dom::xpathresult::{XPathResult, XPathResultType};
use crate::script_runtime::CanGc;
use crate::xpath::{Expr, evaluate_parsed_xpath};
#[dom_struct]
pub(crate) struct XPathExpression {
reflector_: Reflector,
window: Dom<Window>,
#[no_trace]
parsed_expression: Expr,
}
impl XPathExpression {
fn new_inherited(window: &Window, parsed_expression: Expr) -> XPathExpression {
XPathExpression {
reflector_: Reflector::new(),
window: Dom::from_ref(window),
parsed_expression,
}
}
pub(crate) fn new(
window: &Window,
proto: Option<HandleObject>,
can_gc: CanGc,
parsed_expression: Expr,
) -> DomRoot<XPathExpression> {
reflect_dom_object_with_proto(
Box::new(XPathExpression::new_inherited(window, parsed_expression)),
window,
proto,
can_gc,
)
}
pub(crate) fn evaluate_internal(
&self,
context_node: &Node,
result_type_num: u16,
result: Option<&XPathResult>,
resolver: Option<Rc<XPathNSResolver>>,
can_gc: CanGc,
) -> Fallible<DomRoot<XPathResult>> {
let result_type = XPathResultType::try_from(result_type_num)
.map_err(|()| Error::Type("Invalid XPath result type".to_string()))?;
let global = self.global();
let window = global.as_window();
let result_value =
evaluate_parsed_xpath(&self.parsed_expression, context_node, resolver)?.into();
if let Some(result) = result {
// According to https://www.w3.org/TR/DOM-Level-3-XPath/xpath.html#XPathEvaluator-evaluate, reusing
// the provided result object is optional. We choose to do it here because thats what other browsers do.
result.reinitialize_with(result_type, result_value);
Ok(DomRoot::from_ref(result))
} else {
Ok(XPathResult::new(
window,
None,
can_gc,
result_type,
result_value,
))
}
}
}
impl XPathExpressionMethods<crate::DomTypeHolder> for XPathExpression {
/// <https://dom.spec.whatwg.org/#dom-xpathexpression-evaluate>
fn Evaluate(
&self,
context_node: &Node,
result_type_num: u16,
result: Option<&XPathResult>,
can_gc: CanGc,
) -> Fallible<DomRoot<XPathResult>> {
self.evaluate_internal(context_node, result_type_num, result, None, can_gc)
}
}