@appthreat/atom 1.7.5 → 1.8.1

package/plugins/nikic/php-parser/lib/PhpParser/NodeTraverser.php

@@ -0,0 +1,278 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser;
+
+class NodeTraverser implements NodeTraverserInterface {
+    /**
+     * @deprecated Use NodeVisitor::DONT_TRAVERSE_CHILDREN instead.
+     */
+    public const DONT_TRAVERSE_CHILDREN = NodeVisitor::DONT_TRAVERSE_CHILDREN;
+
+    /**
+     * @deprecated Use NodeVisitor::STOP_TRAVERSAL instead.
+     */
+    public const STOP_TRAVERSAL = NodeVisitor::STOP_TRAVERSAL;
+
+    /**
+     * @deprecated Use NodeVisitor::REMOVE_NODE instead.
+     */
+    public const REMOVE_NODE = NodeVisitor::REMOVE_NODE;
+
+    /**
+     * @deprecated Use NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN instead.
+     */
+    public const DONT_TRAVERSE_CURRENT_AND_CHILDREN = NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
+
+    /** @var list<NodeVisitor> Visitors */
+    protected array $visitors = [];
+
+    /** @var bool Whether traversal should be stopped */
+    protected bool $stopTraversal;
+
+    /**
+     * Create a traverser with the given visitors.
+     *
+     * @param NodeVisitor ...$visitors Node visitors
+     */
+    public function __construct(NodeVisitor ...$visitors) {
+        $this->visitors = $visitors;
+    }
+
+    /**
+     * Adds a visitor.
+     *
+     * @param NodeVisitor $visitor Visitor to add
+     */
+    public function addVisitor(NodeVisitor $visitor): void {
+        $this->visitors[] = $visitor;
+    }
+
+    /**
+     * Removes an added visitor.
+     */
+    public function removeVisitor(NodeVisitor $visitor): void {
+        $index = array_search($visitor, $this->visitors);
+        if ($index !== false) {
+            array_splice($this->visitors, $index, 1, []);
+        }
+    }
+
+    /**
+     * Traverses an array of nodes using the registered visitors.
+     *
+     * @param Node[] $nodes Array of nodes
+     *
+     * @return Node[] Traversed array of nodes
+     */
+    public function traverse(array $nodes): array {
+        $this->stopTraversal = false;
+
+        foreach ($this->visitors as $visitor) {
+            if (null !== $return = $visitor->beforeTraverse($nodes)) {
+                $nodes = $return;
+            }
+        }
+
+        $nodes = $this->traverseArray($nodes);
+
+        for ($i = \count($this->visitors) - 1; $i >= 0; --$i) {
+            $visitor = $this->visitors[$i];
+            if (null !== $return = $visitor->afterTraverse($nodes)) {
+                $nodes = $return;
+            }
+        }
+
+        return $nodes;
+    }
+
+    /**
+     * Recursively traverse a node.
+     *
+     * @param Node $node Node to traverse.
+     */
+    protected function traverseNode(Node $node): void {
+        foreach ($node->getSubNodeNames() as $name) {
+            $subNode = $node->$name;
+
+            if (\is_array($subNode)) {
+                $node->$name = $this->traverseArray($subNode);
+                if ($this->stopTraversal) {
+                    break;
+                }
+            } elseif ($subNode instanceof Node) {
+                $traverseChildren = true;
+                $visitorIndex = -1;
+
+                foreach ($this->visitors as $visitorIndex => $visitor) {
+                    $return = $visitor->enterNode($subNode);
+                    if (null !== $return) {
+                        if ($return instanceof Node) {
+                            $this->ensureReplacementReasonable($subNode, $return);
+                            $subNode = $node->$name = $return;
+                        } elseif (NodeVisitor::DONT_TRAVERSE_CHILDREN === $return) {
+                            $traverseChildren = false;
+                        } elseif (NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN === $return) {
+                            $traverseChildren = false;
+                            break;
+                        } elseif (NodeVisitor::STOP_TRAVERSAL === $return) {
+                            $this->stopTraversal = true;
+                            break 2;
+                        } elseif (NodeVisitor::REPLACE_WITH_NULL === $return) {
+                            $node->$name = null;
+                            continue 2;
+                        } else {
+                            throw new \LogicException(
+                                'enterNode() returned invalid value of type ' . gettype($return)
+                            );
+                        }
+                    }
+                }
+
+                if ($traverseChildren) {
+                    $this->traverseNode($subNode);
+                    if ($this->stopTraversal) {
+                        break;
+                    }
+                }
+
+                for (; $visitorIndex >= 0; --$visitorIndex) {
+                    $visitor = $this->visitors[$visitorIndex];
+                    $return = $visitor->leaveNode($subNode);
+
+                    if (null !== $return) {
+                        if ($return instanceof Node) {
+                            $this->ensureReplacementReasonable($subNode, $return);
+                            $subNode = $node->$name = $return;
+                        } elseif (NodeVisitor::STOP_TRAVERSAL === $return) {
+                            $this->stopTraversal = true;
+                            break 2;
+                        } elseif (NodeVisitor::REPLACE_WITH_NULL === $return) {
+                            $node->$name = null;
+                            break;
+                        } elseif (\is_array($return)) {
+                            throw new \LogicException(
+                                'leaveNode() may only return an array ' .
+                                'if the parent structure is an array'
+                            );
+                        } else {
+                            throw new \LogicException(
+                                'leaveNode() returned invalid value of type ' . gettype($return)
+                            );
+                        }
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Recursively traverse array (usually of nodes).
+     *
+     * @param array $nodes Array to traverse
+     *
+     * @return array Result of traversal (may be original array or changed one)
+     */
+    protected function traverseArray(array $nodes): array {
+        $doNodes = [];
+
+        foreach ($nodes as $i => $node) {
+            if ($node instanceof Node) {
+                $traverseChildren = true;
+                $visitorIndex = -1;
+
+                foreach ($this->visitors as $visitorIndex => $visitor) {
+                    $return = $visitor->enterNode($node);
+                    if (null !== $return) {
+                        if ($return instanceof Node) {
+                            $this->ensureReplacementReasonable($node, $return);
+                            $nodes[$i] = $node = $return;
+                        } elseif (\is_array($return)) {
+                            $doNodes[] = [$i, $return];
+                            continue 2;
+                        } elseif (NodeVisitor::REMOVE_NODE === $return) {
+                            $doNodes[] = [$i, []];
+                            continue 2;
+                        } elseif (NodeVisitor::DONT_TRAVERSE_CHILDREN === $return) {
+                            $traverseChildren = false;
+                        } elseif (NodeVisitor::DONT_TRAVERSE_CURRENT_AND_CHILDREN === $return) {
+                            $traverseChildren = false;
+                            break;
+                        } elseif (NodeVisitor::STOP_TRAVERSAL === $return) {
+                            $this->stopTraversal = true;
+                            break 2;
+                        } elseif (NodeVisitor::REPLACE_WITH_NULL === $return) {
+                            throw new \LogicException(
+                                'REPLACE_WITH_NULL can not be used if the parent structure is an array');
+                        } else {
+                            throw new \LogicException(
+                                'enterNode() returned invalid value of type ' . gettype($return)
+                            );
+                        }
+                    }
+                }
+
+                if ($traverseChildren) {
+                    $this->traverseNode($node);
+                    if ($this->stopTraversal) {
+                        break;
+                    }
+                }
+
+                for (; $visitorIndex >= 0; --$visitorIndex) {
+                    $visitor = $this->visitors[$visitorIndex];
+                    $return = $visitor->leaveNode($node);
+
+                    if (null !== $return) {
+                        if ($return instanceof Node) {
+                            $this->ensureReplacementReasonable($node, $return);
+                            $nodes[$i] = $node = $return;
+                        } elseif (\is_array($return)) {
+                            $doNodes[] = [$i, $return];
+                            break;
+                        } elseif (NodeVisitor::REMOVE_NODE === $return) {
+                            $doNodes[] = [$i, []];
+                            break;
+                        } elseif (NodeVisitor::STOP_TRAVERSAL === $return) {
+                            $this->stopTraversal = true;
+                            break 2;
+                        } elseif (NodeVisitor::REPLACE_WITH_NULL === $return) {
+                            throw new \LogicException(
+                                'REPLACE_WITH_NULL can not be used if the parent structure is an array');
+                        } else {
+                            throw new \LogicException(
+                                'leaveNode() returned invalid value of type ' . gettype($return)
+                            );
+                        }
+                    }
+                }
+            } elseif (\is_array($node)) {
+                throw new \LogicException('Invalid node structure: Contains nested arrays');
+            }
+        }
+
+        if (!empty($doNodes)) {
+            while (list($i, $replace) = array_pop($doNodes)) {
+                array_splice($nodes, $i, 1, $replace);
+            }
+        }
+
+        return $nodes;
+    }
+
+    private function ensureReplacementReasonable(Node $old, Node $new): void {
+        if ($old instanceof Node\Stmt && $new instanceof Node\Expr) {
+            throw new \LogicException(
+                "Trying to replace statement ({$old->getType()}) " .
+                "with expression ({$new->getType()}). Are you missing a " .
+                "Stmt_Expression wrapper?"
+            );
+        }
+
+        if ($old instanceof Node\Expr && $new instanceof Node\Stmt) {
+            throw new \LogicException(
+                "Trying to replace expression ({$old->getType()}) " .
+                "with statement ({$new->getType()})"
+            );
+        }
+    }
+}

package/plugins/nikic/php-parser/lib/PhpParser/NodeTraverserInterface.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser;
+
+interface NodeTraverserInterface {
+    /**
+     * Adds a visitor.
+     *
+     * @param NodeVisitor $visitor Visitor to add
+     */
+    public function addVisitor(NodeVisitor $visitor): void;
+
+    /**
+     * Removes an added visitor.
+     */
+    public function removeVisitor(NodeVisitor $visitor): void;
+
+    /**
+     * Traverses an array of nodes using the registered visitors.
+     *
+     * @param Node[] $nodes Array of nodes
+     *
+     * @return Node[] Traversed array of nodes
+     */
+    public function traverse(array $nodes): array;
+}

package/plugins/nikic/php-parser/lib/PhpParser/NodeVisitor/CloningVisitor.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser\NodeVisitor;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitorAbstract;
+
+/**
+ * Visitor cloning all nodes and linking to the original nodes using an attribute.
+ *
+ * This visitor is required to perform format-preserving pretty prints.
+ */
+class CloningVisitor extends NodeVisitorAbstract {
+    public function enterNode(Node $origNode) {
+        $node = clone $origNode;
+        $node->setAttribute('origNode', $origNode);
+        return $node;
+    }
+}

package/plugins/nikic/php-parser/lib/PhpParser/NodeVisitor/CommentAnnotatingVisitor.php

@@ -0,0 +1,82 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser\NodeVisitor;
+
+use PhpParser\Comment;
+use PhpParser\Node;
+use PhpParser\NodeVisitorAbstract;
+use PhpParser\Token;
+
+class CommentAnnotatingVisitor extends NodeVisitorAbstract {
+    /** @var int Last seen token start position */
+    private int $pos = 0;
+    /** @var Token[] Token array */
+    private array $tokens;
+    /** @var list<int> Token positions of comments */
+    private array $commentPositions = [];
+
+    /**
+     * Create a comment annotation visitor.
+     *
+     * @param Token[] $tokens Token array
+     */
+    public function __construct(array $tokens) {
+        $this->tokens = $tokens;
+
+        // Collect positions of comments. We use this to avoid traversing parts of the AST where
+        // there are no comments.
+        foreach ($tokens as $i => $token) {
+            if ($token->id === \T_COMMENT || $token->id === \T_DOC_COMMENT) {
+                $this->commentPositions[] = $i;
+            }
+        }
+    }
+
+    public function enterNode(Node $node) {
+        $nextCommentPos = current($this->commentPositions);
+        if ($nextCommentPos === false) {
+            // No more comments.
+            return self::STOP_TRAVERSAL;
+        }
+
+        $oldPos = $this->pos;
+        $this->pos = $pos = $node->getStartTokenPos();
+        if ($nextCommentPos > $oldPos && $nextCommentPos < $pos) {
+            $comments = [];
+            while (--$pos >= $oldPos) {
+                $token = $this->tokens[$pos];
+                if ($token->id === \T_DOC_COMMENT) {
+                    $comments[] = new Comment\Doc(
+                        $token->text, $token->line, $token->pos, $pos,
+                        $token->getEndLine(), $token->getEndPos() - 1, $pos);
+                    continue;
+                }
+                if ($token->id === \T_COMMENT) {
+                    $comments[] = new Comment(
+                        $token->text, $token->line, $token->pos, $pos,
+                        $token->getEndLine(), $token->getEndPos() - 1, $pos);
+                    continue;
+                }
+                if ($token->id !== \T_WHITESPACE) {
+                    break;
+                }
+            }
+            if (!empty($comments)) {
+                $node->setAttribute('comments', array_reverse($comments));
+            }
+
+            do {
+                $nextCommentPos = next($this->commentPositions);
+            } while ($nextCommentPos !== false && $nextCommentPos < $this->pos);
+        }
+
+        $endPos = $node->getEndTokenPos();
+        if ($nextCommentPos > $endPos) {
+            // Skip children if there are no comments located inside this node.
+            $this->pos = $endPos;
+            return self::DONT_TRAVERSE_CHILDREN;
+        }
+
+        return null;
+    }
+}

package/plugins/nikic/php-parser/lib/PhpParser/NodeVisitor/FindingVisitor.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser\NodeVisitor;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitorAbstract;
+
+/**
+ * This visitor can be used to find and collect all nodes satisfying some criterion determined by
+ * a filter callback.
+ */
+class FindingVisitor extends NodeVisitorAbstract {
+    /** @var callable Filter callback */
+    protected $filterCallback;
+    /** @var Node[] Found nodes */
+    protected array $foundNodes;
+
+    public function __construct(callable $filterCallback) {
+        $this->filterCallback = $filterCallback;
+    }
+
+    /**
+     * Get found nodes satisfying the filter callback.
+     *
+     * Nodes are returned in pre-order.
+     *
+     * @return Node[] Found nodes
+     */
+    public function getFoundNodes(): array {
+        return $this->foundNodes;
+    }
+
+    public function beforeTraverse(array $nodes): ?array {
+        $this->foundNodes = [];
+
+        return null;
+    }
+
+    public function enterNode(Node $node) {
+        $filterCallback = $this->filterCallback;
+        if ($filterCallback($node)) {
+            $this->foundNodes[] = $node;
+        }
+
+        return null;
+    }
+}

package/plugins/nikic/php-parser/lib/PhpParser/NodeVisitor/FirstFindingVisitor.php

@@ -0,0 +1,49 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser\NodeVisitor;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitor;
+use PhpParser\NodeVisitorAbstract;
+
+/**
+ * This visitor can be used to find the first node satisfying some criterion determined by
+ * a filter callback.
+ */
+class FirstFindingVisitor extends NodeVisitorAbstract {
+    /** @var callable Filter callback */
+    protected $filterCallback;
+    /** @var null|Node Found node */
+    protected ?Node $foundNode;
+
+    public function __construct(callable $filterCallback) {
+        $this->filterCallback = $filterCallback;
+    }
+
+    /**
+     * Get found node satisfying the filter callback.
+     *
+     * Returns null if no node satisfies the filter callback.
+     *
+     * @return null|Node Found node (or null if not found)
+     */
+    public function getFoundNode(): ?Node {
+        return $this->foundNode;
+    }
+
+    public function beforeTraverse(array $nodes): ?array {
+        $this->foundNode = null;
+
+        return null;
+    }
+
+    public function enterNode(Node $node) {
+        $filterCallback = $this->filterCallback;
+        if ($filterCallback($node)) {
+            $this->foundNode = $node;
+            return NodeVisitor::STOP_TRAVERSAL;
+        }
+
+        return null;
+    }
+}