@appthreat/atom-parsetools 1.0.4 → 1.0.5

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

@@ -2,23 +2,22 @@
 
 namespace PhpParser;
 
-class Comment implements \JsonSerializable
-{
-    protected $text;
-    protected $startLine;
-    protected $startFilePos;
-    protected $startTokenPos;
-    protected $endLine;
-    protected $endFilePos;
-    protected $endTokenPos;
+class Comment implements \JsonSerializable {
+    protected string $text;
+    protected int $startLine;
+    protected int $startFilePos;
+    protected int $startTokenPos;
+    protected int $endLine;
+    protected int $endFilePos;
+    protected int $endTokenPos;
 
     /**
      * Constructs a comment node.
      *
-     * @param string $text          Comment text (including comment delimiters like /*)
-     * @param int    $startLine     Line number the comment started on
-     * @param int    $startFilePos  File offset the comment started on
-     * @param int    $startTokenPos Token offset the comment started on
+     * @param string $text Comment text (including comment delimiters like /*)
+     * @param int $startLine Line number the comment started on
+     * @param int $startFilePos File offset the comment started on
+     * @param int $startTokenPos Token offset the comment started on
      */
     public function __construct(
         string $text,
@@ -39,7 +38,7 @@ class Comment implements \JsonSerializable
      *
      * @return string The comment text (including comment delimiters like /*)
      */
-    public function getText() : string {
+    public function getText(): string {
         return $this->text;
     }
 
@@ -47,8 +46,9 @@ class Comment implements \JsonSerializable
      * Gets the line number the comment started on.
      *
      * @return int Line number (or -1 if not available)
+     * @phpstan-return -1|positive-int
      */
-    public function getStartLine() : int {
+    public function getStartLine(): int {
         return $this->startLine;
     }
 
@@ -57,7 +57,7 @@ class Comment implements \JsonSerializable
      *
      * @return int File offset (or -1 if not available)
      */
-    public function getStartFilePos() : int {
+    public function getStartFilePos(): int {
         return $this->startFilePos;
     }
 
@@ -66,7 +66,7 @@ class Comment implements \JsonSerializable
      *
      * @return int Token offset (or -1 if not available)
      */
-    public function getStartTokenPos() : int {
+    public function getStartTokenPos(): int {
         return $this->startTokenPos;
     }
 
@@ -74,8 +74,9 @@ class Comment implements \JsonSerializable
      * Gets the line number the comment ends on.
      *
      * @return int Line number (or -1 if not available)
+     * @phpstan-return -1|positive-int
      */
-    public function getEndLine() : int {
+    public function getEndLine(): int {
         return $this->endLine;
     }
 
@@ -84,7 +85,7 @@ class Comment implements \JsonSerializable
      *
      * @return int File offset (or -1 if not available)
      */
-    public function getEndFilePos() : int {
+    public function getEndFilePos(): int {
         return $this->endFilePos;
     }
 
@@ -93,49 +94,16 @@ class Comment implements \JsonSerializable
      *
      * @return int Token offset (or -1 if not available)
      */
-    public function getEndTokenPos() : int {
+    public function getEndTokenPos(): int {
         return $this->endTokenPos;
     }
 
-    /**
-     * Gets the line number the comment started on.
-     *
-     * @deprecated Use getStartLine() instead
-     *
-     * @return int Line number
-     */
-    public function getLine() : int {
-        return $this->startLine;
-    }
-
-    /**
-     * Gets the file offset the comment started on.
-     *
-     * @deprecated Use getStartFilePos() instead
-     *
-     * @return int File offset
-     */
-    public function getFilePos() : int {
-        return $this->startFilePos;
-    }
-
-    /**
-     * Gets the token offset the comment started on.
-     *
-     * @deprecated Use getStartTokenPos() instead
-     *
-     * @return int Token offset
-     */
-    public function getTokenPos() : int {
-        return $this->startTokenPos;
-    }
-
     /**
      * Gets the comment text.
      *
      * @return string The comment text (including comment delimiters like /*)
      */
-    public function __toString() : string {
+    public function __toString(): string {
         return $this->text;
     }
 
@@ -144,18 +112,19 @@ class Comment implements \JsonSerializable
      *
      * "Reformatted" here means that we try to clean up the whitespace at the
      * starts of the lines. This is necessary because we receive the comments
-     * without trailing whitespace on the first line, but with trailing whitespace
+     * without leading whitespace on the first line, but with leading whitespace
      * on all subsequent lines.
      *
-     * @return mixed|string
+     * Additionally, this normalizes CRLF newlines to LF newlines.
      */
-    public function getReformattedText() {
-        $text = trim($this->text);
+    public function getReformattedText(): string {
+        $text = str_replace("\r\n", "\n", $this->text);
         $newlinePos = strpos($text, "\n");
         if (false === $newlinePos) {
             // Single line comments don't need further processing
             return $text;
-        } elseif (preg_match('((*BSR_ANYCRLF)(*ANYCRLF)^.*(?:\R\s+\*.*)+$)', $text)) {
+        }
+        if (preg_match('(^.*(?:\n\s+\*.*)+$)', $text)) {
             // Multi line comment of the type
             //
             //     /*
@@ -164,8 +133,9 @@ class Comment implements \JsonSerializable
             //      */
             //
             // is handled by replacing the whitespace sequences before the * by a single space
-            return preg_replace('(^\s+\*)m', ' *', $this->text);
-        } elseif (preg_match('(^/\*\*?\s*[\r\n])', $text) && preg_match('(\n(\s*)\*/$)', $text, $matches)) {
+            return preg_replace('(^\s+\*)m', ' *', $text);
+        }
+        if (preg_match('(^/\*\*?\s*\n)', $text) && preg_match('(\n(\s*)\*/$)', $text, $matches)) {
             // Multi line comment of the type
             //
             //    /*
@@ -177,7 +147,8 @@ class Comment implements \JsonSerializable
             // */ on all lines. So if the last line is "    */", then "    " is removed at the
             // start of all lines.
             return preg_replace('(^' . preg_quote($matches[1]) . ')m', '', $text);
-        } elseif (preg_match('(^/\*\*?\s*(?!\s))', $text, $matches)) {
+        }
+        if (preg_match('(^/\*\*?\s*(?!\s))', $text, $matches)) {
             // Multi line comment of the type
             //
             //     /* Some text.
@@ -204,9 +175,9 @@ class Comment implements \JsonSerializable
      * @param string $str String to check
      * @return int Length in characters. Tabs count as single characters.
      */
-    private function getShortestWhitespacePrefixLen(string $str) : int {
+    private function getShortestWhitespacePrefixLen(string $str): int {
         $lines = explode("\n", $str);
-        $shortestPrefixLen = \INF;
+        $shortestPrefixLen = \PHP_INT_MAX;
         foreach ($lines as $line) {
             preg_match('(^\s*)', $line, $matches);
             $prefixLen = strlen($matches[0]);
@@ -218,10 +189,9 @@ class Comment implements \JsonSerializable
     }
 
     /**
-     * @return       array
-     * @psalm-return array{nodeType:string, text:mixed, line:mixed, filePos:mixed}
+     * @return array{nodeType:string, text:mixed, line:mixed, filePos:mixed}
      */
-    public function jsonSerialize() : array {
+    public function jsonSerialize(): array {
         // Technically not a node, but we make it look like one anyway
         $type = $this instanceof Comment\Doc ? 'Comment_Doc' : 'Comment';
         return [

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

@@ -1,6 +1,6 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace PhpParser;
 
-class ConstExprEvaluationException extends \Exception
-{}
+class ConstExprEvaluationException extends \Exception {
+}

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

@@ -1,11 +1,12 @@
-<?php
+<?php declare(strict_types=1);
 
 namespace PhpParser;
 
-use function array_merge;
 use PhpParser\Node\Expr;
 use PhpParser\Node\Scalar;
 
+use function array_merge;
+
 /**
  * Evaluates constant expressions.
  *
@@ -25,8 +26,8 @@ use PhpParser\Node\Scalar;
  * point to string conversions are affected by the precision ini setting. Secondly, they are also
  * affected by the LC_NUMERIC locale.
  */
-class ConstExprEvaluator
-{
+class ConstExprEvaluator {
+    /** @var callable|null */
     private $fallbackEvaluator;
 
     /**
@@ -37,8 +38,8 @@ class ConstExprEvaluator
      *
      * @param callable|null $fallbackEvaluator To call if subexpression cannot be evaluated
      */
-    public function __construct(callable $fallbackEvaluator = null) {
-        $this->fallbackEvaluator = $fallbackEvaluator ?? function(Expr $expr) {
+    public function __construct(?callable $fallbackEvaluator = null) {
+        $this->fallbackEvaluator = $fallbackEvaluator ?? function (Expr $expr) {
             throw new ConstExprEvaluationException(
                 "Expression of type {$expr->getType()} cannot be evaluated"
             );
@@ -63,7 +64,7 @@ class ConstExprEvaluator
      * @throws ConstExprEvaluationException if the expression cannot be evaluated or an error occurred
      */
     public function evaluateSilently(Expr $expr) {
-        set_error_handler(function($num, $str, $file, $line) {
+        set_error_handler(function ($num, $str, $file, $line) {
             throw new \ErrorException($str, 0, $num, $file, $line);
         });
 
@@ -101,9 +102,10 @@ class ConstExprEvaluator
         return $this->evaluate($expr);
     }
 
+    /** @return mixed */
     private function evaluate(Expr $expr) {
-        if ($expr instanceof Scalar\LNumber
-            || $expr instanceof Scalar\DNumber
+        if ($expr instanceof Scalar\Int_
+            || $expr instanceof Scalar\Float_
             || $expr instanceof Scalar\String_
         ) {
             return $expr->value;
@@ -146,7 +148,7 @@ class ConstExprEvaluator
         return ($this->fallbackEvaluator)($expr);
     }
 
-    private function evaluateArray(Expr\Array_ $expr) {
+    private function evaluateArray(Expr\Array_ $expr): array {
         $array = [];
         foreach ($expr->items as $item) {
             if (null !== $item->key) {
@@ -160,6 +162,7 @@ class ConstExprEvaluator
         return $array;
     }
 
+    /** @return mixed */
     private function evaluateTernary(Expr\Ternary $expr) {
         if (null === $expr->if) {
             return $this->evaluate($expr->cond) ?: $this->evaluate($expr->else);
@@ -170,6 +173,7 @@ class ConstExprEvaluator
             : $this->evaluate($expr->else);
     }
 
+    /** @return mixed */
     private function evaluateBinaryOp(Expr\BinaryOp $expr) {
         if ($expr instanceof Expr\BinaryOp\Coalesce
             && $expr->left instanceof Expr\ArrayDimFetch
@@ -216,6 +220,7 @@ class ConstExprEvaluator
         throw new \Exception('Should not happen');
     }
 
+    /** @return mixed */
     private function evaluateConstFetch(Expr\ConstFetch $expr) {
         $name = $expr->name->toLowerString();
         switch ($name) {

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

@@ -2,25 +2,20 @@
 
 namespace PhpParser;
 
-class Error extends \RuntimeException
-{
-    protected $rawMessage;
-    protected $attributes;
+class Error extends \RuntimeException {
+    protected string $rawMessage;
+    /** @var array<string, mixed> */
+    protected array $attributes;
 
     /**
      * Creates an Exception signifying a parse error.
      *
-     * @param string    $message    Error message
-     * @param array|int $attributes Attributes of node/token where error occurred
-     *                              (or start line of error -- deprecated)
+     * @param string $message Error message
+     * @param array<string, mixed> $attributes Attributes of node/token where error occurred
      */
-    public function __construct(string $message, $attributes = []) {
+    public function __construct(string $message, array $attributes = []) {
         $this->rawMessage = $message;
-        if (is_array($attributes)) {
-            $this->attributes = $attributes;
-        } else {
-            $this->attributes = ['startLine' => $attributes];
-        }
+        $this->attributes = $attributes;
         $this->updateMessage();
     }
 
@@ -29,7 +24,7 @@ class Error extends \RuntimeException
      *
      * @return string Error message
      */
-    public function getRawMessage() : string {
+    public function getRawMessage(): string {
         return $this->rawMessage;
     }
 
@@ -37,8 +32,9 @@ class Error extends \RuntimeException
      * Gets the line the error starts in.
      *
      * @return int Error start line
+     * @phpstan-return -1|positive-int
      */
-    public function getStartLine() : int {
+    public function getStartLine(): int {
         return $this->attributes['startLine'] ?? -1;
     }
 
@@ -46,26 +42,27 @@ class Error extends \RuntimeException
      * Gets the line the error ends in.
      *
      * @return int Error end line
+     * @phpstan-return -1|positive-int
      */
-    public function getEndLine() : int {
+    public function getEndLine(): int {
         return $this->attributes['endLine'] ?? -1;
     }
 
     /**
      * Gets the attributes of the node/token the error occurred at.
      *
-     * @return array
+     * @return array<string, mixed>
      */
-    public function getAttributes() : array {
+    public function getAttributes(): array {
         return $this->attributes;
     }
 
     /**
      * Sets the attributes of the node/token the error occurred at.
      *
-     * @param array $attributes
+     * @param array<string, mixed> $attributes
      */
-    public function setAttributes(array $attributes) {
+    public function setAttributes(array $attributes): void {
         $this->attributes = $attributes;
         $this->updateMessage();
     }
@@ -75,7 +72,7 @@ class Error extends \RuntimeException
      *
      * @param string $message Error message
      */
-    public function setRawMessage(string $message) {
+    public function setRawMessage(string $message): void {
         $this->rawMessage = $message;
         $this->updateMessage();
     }
@@ -85,7 +82,7 @@ class Error extends \RuntimeException
      *
      * @param int $line Error start line
      */
-    public function setStartLine(int $line) {
+    public function setStartLine(int $line): void {
         $this->attributes['startLine'] = $line;
         $this->updateMessage();
     }
@@ -94,10 +91,8 @@ class Error extends \RuntimeException
      * Returns whether the error has start and end column information.
      *
      * For column information enable the startFilePos and endFilePos in the lexer options.
-     *
-     * @return bool
      */
-    public function hasColumnInfo() : bool {
+    public function hasColumnInfo(): bool {
         return isset($this->attributes['startFilePos'], $this->attributes['endFilePos']);
     }
 
@@ -105,9 +100,8 @@ class Error extends \RuntimeException
      * Gets the start column (1-based) into the line where the error started.
      *
      * @param string $code Source code of the file
-     * @return int
      */
-    public function getStartColumn(string $code) : int {
+    public function getStartColumn(string $code): int {
         if (!$this->hasColumnInfo()) {
             throw new \RuntimeException('Error does not have column information');
         }
@@ -119,9 +113,8 @@ class Error extends \RuntimeException
      * Gets the end column (1-based) into the line where the error ended.
      *
      * @param string $code Source code of the file
-     * @return int
      */
-    public function getEndColumn(string $code) : int {
+    public function getEndColumn(string $code): int {
         if (!$this->hasColumnInfo()) {
             throw new \RuntimeException('Error does not have column information');
         }
@@ -136,7 +129,7 @@ class Error extends \RuntimeException
      *
      * @return string Formatted message
      */
-    public function getMessageWithColumnInfo(string $code) : string {
+    public function getMessageWithColumnInfo(string $code): string {
         return sprintf(
             '%s from %d:%d to %d:%d', $this->getRawMessage(),
             $this->getStartLine(), $this->getStartColumn($code),
@@ -148,11 +141,11 @@ class Error extends \RuntimeException
      * Converts a file offset into a column.
      *
      * @param string $code Source code that $pos indexes into
-     * @param int    $pos  0-based position in $code
+     * @param int $pos 0-based position in $code
      *
      * @return int 1-based column (relative to start of line)
      */
-    private function toColumn(string $code, int $pos) : int {
+    private function toColumn(string $code, int $pos): int {
         if ($pos > strlen($code)) {
             throw new \RuntimeException('Invalid position information');
         }
@@ -168,7 +161,7 @@ class Error extends \RuntimeException
     /**
      * Updates the exception message after a change to rawMessage or rawLine.
      */
-    protected function updateMessage() {
+    protected function updateMessage(): void {
         $this->message = $this->rawMessage;
 
         if (-1 === $this->getStartLine()) {

package/plugins/nikic/php-parser/lib/PhpParser/ErrorHandler/Collecting.php

@@ -10,12 +10,11 @@ use PhpParser\ErrorHandler;
  *
  * This allows graceful handling of errors.
  */
-class Collecting implements ErrorHandler
-{
+class Collecting implements ErrorHandler {
     /** @var Error[] Collected errors */
-    private $errors = [];
+    private array $errors = [];
 
-    public function handleError(Error $error) {
+    public function handleError(Error $error): void {
         $this->errors[] = $error;
     }
 
@@ -24,23 +23,21 @@ class Collecting implements ErrorHandler
      *
      * @return Error[]
      */
-    public function getErrors() : array {
+    public function getErrors(): array {
         return $this->errors;
     }
 
     /**
      * Check whether there are any errors.
-     *
-     * @return bool
      */
-    public function hasErrors() : bool {
+    public function hasErrors(): bool {
         return !empty($this->errors);
     }
 
     /**
      * Reset/clear collected errors.
      */
-    public function clearErrors() {
+    public function clearErrors(): void {
         $this->errors = [];
     }
 }

package/plugins/nikic/php-parser/lib/PhpParser/ErrorHandler/Throwing.php

@@ -10,9 +10,8 @@ use PhpParser\ErrorHandler;
  *
  * This is the default strategy used by all components.
  */
-class Throwing implements ErrorHandler
-{
-    public function handleError(Error $error) {
+class Throwing implements ErrorHandler {
+    public function handleError(Error $error): void {
         throw $error;
     }
 }

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

@@ -2,12 +2,11 @@
 
 namespace PhpParser;
 
-interface ErrorHandler
-{
+interface ErrorHandler {
     /**
      * Handle an error generated during lexing, parsing or some other operation.
      *
      * @param Error $error The error that needs to be handled
      */
-    public function handleError(Error $error);
+    public function handleError(Error $error): void;
 }

package/plugins/nikic/php-parser/lib/PhpParser/Internal/DiffElem.php

@@ -5,20 +5,24 @@ namespace PhpParser\Internal;
 /**
  * @internal
  */
-class DiffElem
-{
-    const TYPE_KEEP = 0;
-    const TYPE_REMOVE = 1;
-    const TYPE_ADD = 2;
-    const TYPE_REPLACE = 3;
+class DiffElem {
+    public const TYPE_KEEP = 0;
+    public const TYPE_REMOVE = 1;
+    public const TYPE_ADD = 2;
+    public const TYPE_REPLACE = 3;
 
     /** @var int One of the TYPE_* constants */
-    public $type;
+    public int $type;
     /** @var mixed Is null for add operations */
     public $old;
     /** @var mixed Is null for remove operations */
     public $new;
 
+    /**
+     * @param int $type One of the TYPE_* constants
+     * @param mixed $old Is null for add operations
+     * @param mixed $new Is null for remove operations
+     */
     public function __construct(int $type, $old, $new) {
         $this->type = $type;
         $this->old = $old;