Add tidyNode::getNextSibling() and tidyNode::getPreviousSibling()

ndossche · ndossche · commit ad452086d956 · 2024-07-25T13:55:20.000+02:00
These get the next and previous sibling nodes, respectively. We can already kind of do this by using the $child array, but that's inconvenient when actually walking the tree by only using node instances. Since the class is final, there is no BC break here. Closes GH-15047.
diff --git a/NEWS b/NEWS
@@ -53,6 +53,8 @@ PHP                                                                        NEWS
 - Tidy:
   . Failures in the constructor now throw exceptions rather than emitting
     warnings and having a broken object. (nielsdos)
+  . Add tidyNode::getNextSibling() and tidyNode::getPreviousSibling().
+    (nielsdos)
 
 - XSL:
   . Fix trampoline leak in xpath callables. (nielsdos)
diff --git a/UPGRADING b/UPGRADING
@@ -667,6 +667,9 @@ PHP 8.4 UPGRADE NOTES
     array_any().
     RFC: https://wiki.php.net/rfc/array_find
 
+- Tidy:
+  . Added tidyNode::getNextSibling() and tidyNode::getPreviousSibling().
+
 - XMLReader:
   . Added XMLReader::fromStream(), XMLReader::fromUri(), XMLReader::fromString().
     RFC: https://wiki.php.net/rfc/xmlreader_writer_streams
diff --git a/ext/tidy/tests/sibling_nodes.phpt b/ext/tidy/tests/sibling_nodes.phpt
@@ -0,0 +1,52 @@
+--TEST--
+getPreviousSibling() and getNextSibling()
+--EXTENSIONS--
+tidy
+--FILE--
+<?php
+
+$tidy = tidy_parse_string(<<<HTML
+<!DOCTYPE html>
+<html>
+    <body>
+        <div>first</div>
+        <!-- second -->
+        <div>third</div>
+    </body>
+</html>
+HTML);
+$body = $tidy->body();
+
+function format($str) {
+    if (is_null($str)) return $str;
+    return trim($str);
+}
+
+foreach ($body->child as $i => $child) {
+    echo "=== From the perspective of child $i ===\n";
+    echo "Previous: ";
+    var_dump(format($child->getPreviousSibling()?->value));
+    echo "Next: ";
+    var_dump(format($child->getNextSibling()?->value));
+}
+
+echo "=== html element has only the doctype as sibling ===\n";
+echo "Previous: ";
+var_dump(format($tidy->html()->getPreviousSibling()?->value));
+echo "Next: ";
+var_dump(format($tidy->html()->getNextSibling()?->value));
+
+?>
+--EXPECT--
+=== From the perspective of child 0 ===
+Previous: NULL
+Next: string(15) "<!-- second -->"
+=== From the perspective of child 1 ===
+Previous: string(16) "<div>first</div>"
+Next: string(16) "<div>third</div>"
+=== From the perspective of child 2 ===
+Previous: string(15) "<!-- second -->"
+Next: NULL
+=== html element has only the doctype as sibling ===
+Previous: string(15) "<!DOCTYPE html>"
+Next: NULL
diff --git a/ext/tidy/tidy.c b/ext/tidy/tidy.c
@@ -1599,18 +1599,34 @@ PHP_METHOD(tidyNode, isPhp)
 /* {{{ Returns the parent node if available or NULL */
 PHP_METHOD(tidyNode, getParent)
 {
-	TidyNode	parent_node;
 	TIDY_FETCH_ONLY_OBJECT;
 
-	parent_node = tidyGetParent(obj->node);
-	if(parent_node) {
+	TidyNode parent_node = tidyGetParent(obj->node);
+	if (parent_node) {
 		tidy_create_node_object(return_value, obj->ptdoc, parent_node);
-	} else {
-		ZVAL_NULL(return_value);
 	}
 }
 /* }}} */
 
+PHP_METHOD(tidyNode, getPreviousSibling)
+{
+	TIDY_FETCH_ONLY_OBJECT;
+
+	TidyNode previous_node = tidyGetPrev(obj->node);
+	if (previous_node) {
+		tidy_create_node_object(return_value, obj->ptdoc, previous_node);
+	}
+}
+
+PHP_METHOD(tidyNode, getNextSibling)
+{
+	TIDY_FETCH_ONLY_OBJECT;
+
+	TidyNode next_node = tidyGetNext(obj->node);
+	if (next_node) {
+		tidy_create_node_object(return_value, obj->ptdoc, next_node);
+	}
+}
 
 /* {{{ __constructor for tidyNode. */
 PHP_METHOD(tidyNode, __construct)
diff --git a/ext/tidy/tidy.stub.php b/ext/tidy/tidy.stub.php
@@ -1004,4 +1004,8 @@ public function isAsp(): bool {}
     public function isPhp(): bool {}
 
     public function getParent(): ?tidyNode {}
+
+    public function getPreviousSibling(): ?tidyNode {}
+
+    public function getNextSibling(): ?tidyNode {}
 }
diff --git a/ext/tidy/tidy_arginfo.h b/ext/tidy/tidy_arginfo.h

Original file line number	Diff line number	Diff line change
`@@ -1004,4 +1004,8 @@ public function isAsp(): bool {}`
`1004`	`1004`	`public function isPhp(): bool {}`
`1005`	`1005`
`1006`	`1006`	`public function getParent(): ?tidyNode {}`
	`1007`	`+`
	`1008`	`+ public function getPreviousSibling(): ?tidyNode {}`
	`1009`	`+`
	`1010`	`+ public function getNextSibling(): ?tidyNode {}`
`1007`	`1011`	`}`