Add XPath parser/evaluator (#34463)

* Add XPath parser/evaluator Signed-off-by: Ville Lindholm <ville@lindholm.dev> * Correctly annotate XPathEvaluator IDL Signed-off-by: Ville Lindholm <ville@lindholm.dev> * [PR review]: have bindings pass in `can_gc` Signed-off-by: Ville Lindholm <ville@lindholm.dev> * [PR review]: add docstrings Signed-off-by: Ville Lindholm <ville@lindholm.dev> * [PR review]: implement PartialEq for Value for readability Signed-off-by: Ville Lindholm <ville@lindholm.dev> * [PR review]: add docstrings for CoreFunctions Signed-off-by: Ville Lindholm <ville@lindholm.dev> * [PR review]: simplify node test code Signed-off-by: Ville Lindholm <ville@lindholm.dev> * [PR review]: add unit tests for string handling xpath functions Signed-off-by: Ville Lindholm <ville@lindholm.dev> * put xpath features behind dom.xpath.enabled pref Signed-off-by: Ville Lindholm <ville@lindholm.dev> * [PR review] remove rstest and insta dev-deps Signed-off-by: Ville Lindholm <ville@lindholm.dev> * update wpt test expectations Signed-off-by: Ville Lindholm <ville@lindholm.dev> * [PR review]: tweak metadata files Signed-off-by: Ville Lindholm <ville@lindholm.dev> * update wpt test expectations AGAIN Signed-off-by: Ville Lindholm <ville@lindholm.dev> --------- Signed-off-by: Ville Lindholm <ville@lindholm.dev>
2025-08-06 22:15:33 +01:00 · 2024-12-08 04:01:50 +02:00 · 2024-12-08 04:01:50 +02:00 · bc7fe41a02
commit bc7fe41a02
parent 264c0f972f
36 changed files with 6426 additions and 314 deletions
--- a/components/script/dom/xpathevaluator.rs
+++ b/components/script/dom/xpathevaluator.rs
@ -0,0 +1,110 @@
+/* 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 super::bindings::error::Error;
+use crate::dom::bindings::codegen::Bindings::XPathEvaluatorBinding::XPathEvaluatorMethods;
+use crate::dom::bindings::codegen::Bindings::XPathExpressionBinding::XPathExpression_Binding::XPathExpressionMethods;
+use crate::dom::bindings::codegen::Bindings::XPathNSResolverBinding::XPathNSResolver;
+use crate::dom::bindings::error::Fallible;
+use crate::dom::bindings::reflector::{reflect_dom_object_with_proto, DomObject, Reflector};
+use crate::dom::bindings::root::{Dom, DomRoot};
+use crate::dom::bindings::str::DOMString;
+use crate::dom::node::Node;
+use crate::dom::window::Window;
+use crate::dom::xpathexpression::XPathExpression;
+use crate::dom::xpathresult::XPathResult;
+use crate::script_runtime::CanGc;
+
+#[dom_struct]
+pub struct XPathEvaluator {
+    reflector_: Reflector,
+    window: Dom<Window>,
+}
+
+impl XPathEvaluator {
+    fn new_inherited(window: &Window) -> XPathEvaluator {
+        XPathEvaluator {
+            reflector_: Reflector::new(),
+            window: Dom::from_ref(window),
+        }
+    }
+
+    pub fn new(
+        window: &Window,
+        proto: Option<HandleObject>,
+        can_gc: CanGc,
+    ) -> DomRoot<XPathEvaluator> {
+        reflect_dom_object_with_proto(
+            Box::new(XPathEvaluator::new_inherited(window)),
+            window,
+            proto,
+            can_gc,
+        )
+    }
+}
+
+impl XPathEvaluatorMethods<crate::DomTypeHolder> for XPathEvaluator {
+    /// <https://dom.spec.whatwg.org/#dom-xpathevaluator-xpathevaluator>
+    fn Constructor(
+        window: &Window,
+        proto: Option<HandleObject>,
+        can_gc: CanGc,
+    ) -> DomRoot<XPathEvaluator> {
+        XPathEvaluator::new(window, proto, can_gc)
+    }
+
+    /// <https://dom.spec.whatwg.org/#dom-xpathevaluatorbase-createexpression>
+    fn CreateExpression(
+        &self,
+        expression: DOMString,
+        _resolver: Option<Rc<XPathNSResolver>>,
+        can_gc: CanGc,
+    ) -> Fallible<DomRoot<XPathExpression>> {
+        let global = self.global();
+        let window = global.as_window();
+        // NB: this function is *not* Fallible according to the spec, so we swallow any parsing errors and
+        // just pass a None as the expression... it's not great.
+        let parsed_expression = crate::xpath::parse(&expression).map_err(|_e| Error::Syntax)?;
+        Ok(XPathExpression::new(
+            window,
+            None,
+            can_gc,
+            parsed_expression,
+        ))
+    }
+
+    /// <https://dom.spec.whatwg.org/#dom-xpathevaluatorbase-creatensresolver>
+    fn CreateNSResolver(&self, node_resolver: &Node) -> DomRoot<Node> {
+        // Legacy: the spec tells us to just return `node_resolver` as-is
+        DomRoot::from_ref(node_resolver)
+    }
+
+    /// <https://dom.spec.whatwg.org/#dom-xpathevaluatorbase-evaluate>
+    fn Evaluate(
+        &self,
+        expression_str: DOMString,
+        context_node: &Node,
+        _resolver: Option<Rc<XPathNSResolver>>,
+        result_type: u16,
+        result: Option<&XPathResult>,
+        can_gc: CanGc,
+    ) -> Fallible<DomRoot<XPathResult>> {
+        let global = self.global();
+        let window = global.as_window();
+        let parsed_expression = crate::xpath::parse(&expression_str).map_err(|_| Error::Syntax)?;
+        let expression = XPathExpression::new(window, None, can_gc, parsed_expression);
+        XPathExpressionMethods::<crate::DomTypeHolder>::Evaluate(
+            &*expression,
+            context_node,
+            result_type,
+            result,
+            can_gc,
+        )
+    }
+}