Implement matches() (TODO: cleanup)

Author: nielsdos

ext/dom/element.c

@@ -1744,4 +1744,20 @@ PHP_METHOD(DOMElement, querySelectorAll)
 	php_dom_dispatch_query_selector(INTERNAL_FUNCTION_PARAM_PASSTHRU, true);
 }
 
+PHP_METHOD(DOMElement, matches)
+{
+	zend_string *selectors_str;
+
+	ZEND_PARSE_PARAMETERS_START(1, 1)
+		Z_PARAM_STR(selectors_str)
+	ZEND_PARSE_PARAMETERS_END();
+
+	xmlNodePtr thisp;
+	dom_object *intern;
+	zval *id;
+	DOM_GET_THIS_OBJ(thisp, id, xmlNodePtr, intern);
+
+	dom_element_matches(thisp, intern, return_value, selectors_str);
+}
+
 #endif

ext/dom/parentnode.c

@@ -815,11 +815,18 @@ void dom_parent_node_replace_children(dom_object *context, zval *nodes, uint32_t
  * CSS selector implementation below
  */
 
+// TODO: probably best if this is all moved to another file???
+
 typedef struct {
 	HashTable *list;
 	dom_object *intern;
 } dom_query_selector_all_ctx;
 
+typedef struct {
+	const xmlNode *reference;
+	bool result;
+} dom_query_selector_matches_ctx;
+
 lxb_status_t php_dom_query_selector_find_single_callback(const xmlNode *node, lxb_css_selector_specificity_t spec, void *ctx)
 {
 	xmlNodePtr *result = (xmlNodePtr *) ctx;
@@ -838,6 +845,16 @@ lxb_status_t php_dom_query_selector_find_array_callback(const xmlNode *node, lxb
 	return LXB_STATUS_OK;
 }
 
+lxb_status_t php_dom_query_selector_find_matches_callback(const xmlNode *node, lxb_css_selector_specificity_t spec, void *ctx)
+{
+	dom_query_selector_matches_ctx *matches_ctx = (dom_query_selector_matches_ctx *) ctx;
+	if (node == matches_ctx->reference) {
+		matches_ctx->result = true;
+		return LXB_STATUS_STOP;
+	}
+	return LXB_STATUS_OK;
+}
+
 static lxb_status_t php_dom_query_selector_common(zval *return_value, dom_object *intern, const xmlNode *root, zend_string *selectors_str, lxb_selectors_cb_f cb, void *ctx)
 {
 	lxb_status_t status;
@@ -923,4 +940,28 @@ void dom_parent_node_query_selector_all(xmlNodePtr thisp, dom_object *intern, zv
 	}
 }
 
+/* https://dom.spec.whatwg.org/#dom-element-matches */
+void dom_element_matches(xmlNodePtr thisp, dom_object *intern, zval *return_value, zend_string *selectors_str)
+{
+	dom_query_selector_matches_ctx ctx = { thisp, false };
+
+	const xmlNode *root = thisp;
+	while (root->parent != NULL) {
+		root = root->parent;
+	}
+
+	if (php_dom_query_selector_common(
+		return_value,
+		intern,
+		root,
+		selectors_str,
+		php_dom_query_selector_find_matches_callback,
+		&ctx
+	) != LXB_STATUS_OK) {
+		RETURN_THROWS();
+	} else {
+		RETURN_BOOL(ctx.result);
+	}
+}
+
 #endif

ext/dom/php_dom.h

@@ -200,6 +200,7 @@ bool php_dom_pre_insert(php_libxml_ref_obj *document, xmlNodePtr node, xmlNodePt
 bool php_dom_pre_insert_is_parent_invalid(xmlNodePtr parent);
 void dom_parent_node_query_selector(xmlNodePtr thisp, dom_object *intern, zval *return_value, zend_string *selectors_str);
 void dom_parent_node_query_selector_all(xmlNodePtr thisp, dom_object *intern, zval *return_value, zend_string *selectors_str);
+void dom_element_matches(xmlNodePtr thisp, dom_object *intern, zval *return_value, zend_string *selectors_str);
 
 /* nodemap and nodelist APIs */
 xmlNodePtr php_dom_named_node_map_get_named_item(dom_nnodemap_object *objmap, const zend_string *named, bool may_transform);

ext/dom/php_dom.stub.php

@@ -718,6 +718,8 @@ public function querySelector(string $selectors): ?DOMElement {}
         /** @implementation-alias DOMElement::querySelectorAll */
         public function querySelectorAll(string $selectors): DOMNodeList {}
 
+        public function matches(string $selectors): bool {}
+
         public function insertAdjacentElement(string $where, DOMElement $element): ?DOMElement {}
 
         public function insertAdjacentText(string $where, string $data): void {}

ext/dom/php_dom_arginfo.h

@@ -11,13 +11,27 @@ function test_helper(DOM\ParentNode $dom, string $selector, bool $only_name = fa
         throw new Exception('Mismatch in querySelector and querySelectorAll');
     }
 
+    $list = [];
     foreach ($all as $node) {
+        $list[] = $node;
+
         if ($only_name) {
             echo $node->nodeName, "\n";
             continue;
         }
+
         echo $dom->saveXML($node), "\n";
     }
+
+    // If the element is in the list, then it must match, otherwise it must not
+    // This loops over all the elements in the document and checks them
+    foreach ($dom->querySelectorAll('*') as $node) {
+        if (in_array($node, $list, true) !== $node->matches($selector)) {
+            var_dump($node, $selector, in_array($node, $list, true), $node->matches($selector));
+            echo $dom->saveXML($node), "\n";
+            throw new Exception('Bug in Element::matches()');
+        }
+    }
 }
 
 function test_failure(DOM\ParentNode $dom, string $selector)