Simplify visitor (#1324)

webonyx · Feb 24, 2023 · 88f8856 · 88f8856
1 parent b9cfc95
commit 88f8856
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 33 deletions.
diff --git a/docs/class-reference.md b/docs/class-reference.md
@@ -1117,15 +1117,11 @@ visitor API:
 /**
  * Visit the AST (see class description for details).
  *
- * @template TNode of Node
- *
- * @param NodeList<TNode>|Node $root
+ * @param NodeList<Node>|Node $root
  * @param VisitorArray $visitor
  * @param array<string, mixed>|null $keyMap
  *
- * @throws \Exception
- *
- * @return Node|mixed
+ * @return mixed
  *
  * @api
  */

diff --git a/src/Language/Visitor.php b/src/Language/Visitor.php
@@ -156,15 +156,11 @@ class Visitor
     /**
      * Visit the AST (see class description for details).
      *
-     * @template TNode of Node
-     *
-     * @param NodeList<TNode>|Node $root
+     * @param NodeList<Node>|Node $root
      * @param VisitorArray $visitor
      * @param array<string, mixed>|null $keyMap
      *
-     * @throws \Exception
-     *
-     * @return Node|mixed
+     * @return mixed
      *
      * @api
      */
@@ -187,7 +183,6 @@ public static function visit(object $root, array $visitor, ?array $keyMap = null
         $parent = null;
         $path = [];
         $ancestors = [];
-        $newRoot = $root;
 
         do {
             ++$index;
@@ -240,20 +235,17 @@ public static function visit(object $root, array $visitor, ?array $keyMap = null
                 ] = \array_pop($stack);
             } else {
                 if ($parent === null) {
-                    $node = $newRoot;
+                    $node = $root;
                 } else {
                     $key = $inList
                         ? $index
                         : $keys[$index];
                     $node = $parent instanceof NodeList
                         ? $parent[$key]
                         : $parent->{$key};
-                }
-                if ($node === null) {
-                    continue;
-                }
-
-                if ($parent !== null) {
+                    if ($node === null) {
+                        continue;
+                    }
                     $path[] = $key;
                 }
             }
@@ -264,7 +256,7 @@ public static function visit(object $root, array $visitor, ?array $keyMap = null
                     throw new \Exception('Invalid AST Node: ' . \json_encode($node));
                 }
 
-                $visitFn = self::getVisitFn($visitor, $node->kind, $isLeaving);
+                $visitFn = self::extractVisitFn($visitor, $node->kind, $isLeaving);
 
                 if ($visitFn !== null) {
                     $result = $visitFn($node, $key, $parent, $path, $ancestors);
@@ -324,11 +316,9 @@ public static function visit(object $root, array $visitor, ?array $keyMap = null
             }
         } while (\count($stack) > 0);
 
-        if (\count($edits) > 0) {
-            $newRoot = $edits[0][1];
-        }
-
-        return $newRoot;
+        return \count($edits) > 0
+            ? $edits[0][1]
+            : $root;
     }
 
     /**
@@ -368,6 +358,8 @@ public static function removeNode(): VisitorRemoveNode
     }
 
     /**
+     * Combines the given visitors to run in parallel.
+     *
      * @phpstan-param array<int, VisitorArray> $visitors
      *
      * @return VisitorArray
@@ -384,7 +376,7 @@ public static function visitInParallel(array $visitors): array
                         continue;
                     }
 
-                    $fn = self::getVisitFn(
+                    $fn = self::extractVisitFn(
                         $visitors[$i],
                         $node->kind,
                         false
@@ -412,7 +404,7 @@ public static function visitInParallel(array $visitors): array
             'leave' => static function (Node $node) use ($visitors, $skipping, $visitorsCount) {
                 for ($i = 0; $i < $visitorsCount; ++$i) {
                     if ($skipping[$i] === null) {
-                        $fn = self::getVisitFn(
+                        $fn = self::extractVisitFn(
                             $visitors[$i],
                             $node->kind,
                             true
@@ -440,8 +432,7 @@ public static function visitInParallel(array $visitors): array
     }
 
     /**
-     * Creates a new visitor instance which maintains a provided TypeInfo instance
-     * along with visiting visitor.
+     * Creates a new visitor that updates TypeInfo and delegates to the given visitor.
      *
      * @phpstan-param VisitorArray $visitor
      *
@@ -452,7 +443,7 @@ public static function visitWithTypeInfo(TypeInfo $typeInfo, array $visitor): ar
         return [
             'enter' => static function (Node $node) use ($typeInfo, $visitor) {
                 $typeInfo->enter($node);
-                $fn = self::getVisitFn($visitor, $node->kind, false);
+                $fn = self::extractVisitFn($visitor, $node->kind, false);
 
                 if ($fn === null) {
                     return null;
@@ -471,7 +462,7 @@ public static function visitWithTypeInfo(TypeInfo $typeInfo, array $visitor): ar
                 return $result;
             },
             'leave' => static function (Node $node) use ($typeInfo, $visitor) {
-                $fn = self::getVisitFn($visitor, $node->kind, true);
+                $fn = self::extractVisitFn($visitor, $node->kind, true);
                 $result = $fn !== null
                     ? $fn(...\func_get_args())
                     : null;
@@ -488,7 +479,7 @@ public static function visitWithTypeInfo(TypeInfo $typeInfo, array $visitor): ar
      *
      * @return callable(Node $node, string $key, Node|NodeList $parent, array<int, int|string $path, array<int, Node|NodeList> $ancestors): VisitorOperation|Node|null
      */
-    public static function getVisitFn(array $visitor, string $kind, bool $isLeaving): ?callable
+    protected static function extractVisitFn(array $visitor, string $kind, bool $isLeaving): ?callable
     {
         $kindVisitor = $visitor[$kind] ?? null;