Bail out on PHP tags in removed code

If dropping a node would drop PHP tags, bail out of formatting preservation. This will lose formatting, but at least produce legal code. Closes GH-884.
nikic · Sep 21, 2022 · b0edd4c · b0edd4c · TomasVotruba · Sep 22, 2022
1 parent bad10e1
commit b0edd4c
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 14 deletions.
diff --git a/lib/PhpParser/Internal/TokenStream.php b/lib/PhpParser/Internal/TokenStream.php
@@ -205,6 +205,11 @@ public function haveBracesInRange(int $startPos, int $endPos): bool {
             || $this->haveTokenInRange($startPos, $endPos, '}');
     }
 
+    public function haveTagInRange(int $startPos, int $endPos): bool {
+        return $this->haveTokenInRange($startPos, $endPos, \T_OPEN_TAG)
+            || $this->haveTokenInRange($startPos, $endPos, \T_CLOSE_TAG);
+    }
+
     /**
      * Get indentation before token position.
      *

diff --git a/lib/PhpParser/PrettyPrinterAbstract.php b/lib/PhpParser/PrettyPrinterAbstract.php
@@ -774,7 +774,8 @@ protected function pArray(
                 }
 
                 if ($skipRemovedNode) {
-                    if ($isStmtList && $this->origTokens->haveBracesInRange($pos, $itemStartPos)) {
+                    if ($isStmtList && ($this->origTokens->haveBracesInRange($pos, $itemStartPos) ||
+                                        $this->origTokens->haveTagInRange($pos, $itemStartPos))) {
                         // We'd remove the brace of a code block.
                         // TODO: Preserve formatting.
                         $this->setIndentLevel($origIndentLevel);
@@ -884,7 +885,8 @@ protected function pArray(
                         $pos, $itemStartPos, $indentAdjustment);
                     $skipRemovedNode = true;
                 } else {
-                    if ($isStmtList && $this->origTokens->haveBracesInRange($pos, $itemStartPos)) {
+                    if ($isStmtList && ($this->origTokens->haveBracesInRange($pos, $itemStartPos) ||
+                                        $this->origTokens->haveTagInRange($pos, $itemStartPos))) {
                         // We'd remove the brace of a code block.
                         // TODO: Preserve formatting.
                         return null;

diff --git a/test/code/formatPreservation/inlineHtml.test b/test/code/formatPreservation/inlineHtml.test
@@ -42,13 +42,14 @@ function test() {
     baz();
 }
 -----
-// TODO Fix broken result
+// TODO Preserve formatting
 $stmts[0]->stmts[1] = $stmts[0]->stmts[2];
 -----
 <?php
 
-function test() {
-    foo();<?php
+function test()
+{
+    foo();
     baz();
     baz();
 }
@@ -61,14 +62,15 @@ function test() {
     baz();
 }
 -----
-// TODO Fix broken result
+// TODO Preserve formatting
 unset($stmts[0]->stmts[2]);
 -----
 <?php
 
-function test() {
+function test()
+{
     foo();
-    ?>Bar
+    ?>Bar<?php
 }
 -----
 <?php
@@ -79,13 +81,14 @@ function test() {
     baz();
 }
 -----
-// TODO Fix broken result
+// TODO Preserve formatting
 array_splice($stmts[0]->stmts, 0, 1, []);
 -----
 <?php
 
-function test() {
-    Bar<?php
+function test()
+{
+    ?>Bar<?php
     baz();
 }
 -----
@@ -97,12 +100,13 @@ function test() {
     baz();
 }
 -----
-// TODO Fix broken result
+// TODO Preserve formatting
 array_splice($stmts[0]->stmts, 1, 1, []);
 -----
 <?php
 
-function test() {
-    foo();<?php
+function test()
+{
+    foo();
     baz();
 }