Add class constant masks, class constants and const masks in array keys (compat with phpstan parser v2.3 https://github.com/phpstan/phpdoc-parser/releases/tag/2.3.0)

Author: SerafimArts

composer.json

@@ -26,7 +26,8 @@
         "phpstan/phpstan": "^2.1",
         "phpstan/phpstan-strict-rules": "^2.0",
         "phpunit/phpunit": "^10.5|^11.0|^12.0",
-        "symfony/var-dumper": "^6.4|^7.0"
+        "symfony/var-dumper": "^6.4|^7.0",
+        "type-lang/printer": "^1.3"
     },
     "autoload-dev": {
         "psr-4": {

resources/grammar.php

@@ -207,7 +207,7 @@
         new \Phplrt\Parser\Grammar\Concatenation([133]),
         new \Phplrt\Parser\Grammar\Optional(54),
         new \Phplrt\Parser\Grammar\Alternation([127, 128]),
-        new \Phplrt\Parser\Grammar\Alternation([3, 23, 21]),
+        new \Phplrt\Parser\Grammar\Alternation([18, 19, 3, 23, 21]),
         new \Phplrt\Parser\Grammar\Lexeme('T_QMARK', true),
         new \Phplrt\Parser\Grammar\Concatenation([59]),
         new \Phplrt\Parser\Grammar\Optional(132),
@@ -558,7 +558,7 @@
 
             foreach ($children as $field) {
                 if ($field instanceof Node\Stmt\Shape\ExplicitFieldNode) {
-                    $key = $field->getKey();
+                    $key = $field->getHashString();
 
                     if (\in_array($key, $explicit, true)) {
                         throw SemanticException::fromShapeFieldDuplication($key, $field->offset);
@@ -632,6 +632,10 @@
                     => new Node\Stmt\Shape\NumericFieldNode($name, $value, $optional),
                 $name instanceof Node\Literal\StringLiteralNode
                     => new Node\Stmt\Shape\StringNamedFieldNode($name, $value, $optional),
+                $name instanceof Node\Stmt\ClassConstMaskNode
+                    => new Node\Stmt\Shape\ClassConstMaskFieldNode($name, $value, $optional),
+                $name instanceof Node\Stmt\ConstMaskNode
+                    => new Node\Stmt\Shape\ConstMaskFieldNode($name, $value, $optional),
                 default => new Node\Stmt\Shape\NamedFieldNode($name, $value, $optional),
             };
         },

resources/grammar/shape-fields.pp2

@@ -43,7 +43,7 @@ ShapeFieldsList -> {
 
     foreach ($children as $field) {
         if ($field instanceof Node\Stmt\Shape\ExplicitFieldNode) {
-            $key = $field->getKey();
+            $key = $field->getHashString();
 
             if (\in_array($key, $explicit, true)) {
                 throw SemanticException::fromShapeFieldDuplication($key, $field->offset);
@@ -97,6 +97,10 @@ ExplicitField -> {
             => new Node\Stmt\Shape\NumericFieldNode($name, $value, $optional),
         $name instanceof Node\Literal\StringLiteralNode
             => new Node\Stmt\Shape\StringNamedFieldNode($name, $value, $optional),
+        $name instanceof Node\Stmt\ClassConstMaskNode
+            => new Node\Stmt\Shape\ClassConstMaskFieldNode($name, $value, $optional),
+        $name instanceof Node\Stmt\ConstMaskNode
+            => new Node\Stmt\Shape\ConstMaskFieldNode($name, $value, $optional),
         default => new Node\Stmt\Shape\NamedFieldNode($name, $value, $optional),
     };
 }
@@ -110,7 +114,9 @@ ImplicitField -> {
   ;
 
 ShapeKey
-  : Identifier()
+  : ConstMaskLiteral()
+  | ClassConstLiteral()
+  | Identifier()
   | IntLiteral()
   | StringLiteral()
   ;

src/Node/Stmt/Shape/ClassConstMaskFieldNode.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Parser\Node\Stmt\Shape;
+
+use TypeLang\Parser\Node\Stmt\Attribute\AttributeGroupsListNode;
+use TypeLang\Parser\Node\Stmt\ClassConstMaskNode;
+use TypeLang\Parser\Node\Stmt\TypeStatement;
+
+final class ClassConstMaskFieldNode extends ExplicitFieldNode
+{
+    public function __construct(
+        public ClassConstMaskNode $key,
+        TypeStatement $of,
+        bool $optional = false,
+        ?AttributeGroupsListNode $attributes = null,
+    ) {
+        parent::__construct($of, $optional, $attributes);
+    }
+
+    public function getHashString(): string
+    {
+        $key = $this->key::class . ':'
+            . $this->key->class->toString()
+            . '::' . $this->key->constant?->toString();
+
+        return \hash('xxh3', $key);
+    }
+}

src/Node/Stmt/Shape/ConstMaskFieldNode.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TypeLang\Parser\Node\Stmt\Shape;
+
+use TypeLang\Parser\Node\Stmt\Attribute\AttributeGroupsListNode;
+use TypeLang\Parser\Node\Stmt\ConstMaskNode;
+use TypeLang\Parser\Node\Stmt\TypeStatement;
+
+final class ConstMaskFieldNode extends ExplicitFieldNode
+{
+    public function __construct(
+        public ConstMaskNode $key,
+        TypeStatement $of,
+        bool $optional = false,
+        ?AttributeGroupsListNode $attributes = null,
+    ) {
+        parent::__construct($of, $optional, $attributes);
+    }
+
+    public function getHashString(): string
+    {
+        $key = $this->key::class . ':'
+            . $this->key->name->toString();
+
+        return \hash('xxh3', $key);
+    }
+}

src/Node/Stmt/Shape/ExplicitFieldNode.php

@@ -6,5 +6,16 @@
 
 abstract class ExplicitFieldNode extends FieldNode
 {
-    abstract public function getKey(): int|string;
+    /**
+     * @deprecated Please use {@see getHashString()} instead
+     */
+    public function getKey(): int|string
+    {
+        return $this->getHashString();
+    }
+
+    /**
+     * @return non-empty-string
+     */
+    abstract public function getHashString(): string;
 }

src/Node/Stmt/Shape/NamedFieldNode.php

@@ -26,9 +26,8 @@ public function __construct(
         parent::__construct($of, $optional, $attributes);
     }
 
-    public function getKey(): string
+    public function getHashString(): string
     {
-        /** @var non-empty-string */
-        return $this->key->toString();
+        return \hash('xxh3', self::class . ':' . $this->key->toString());
     }
 }

src/Node/Stmt/Shape/NumericFieldNode.php

@@ -23,4 +23,9 @@ public function getKey(): int
     {
         return $this->key->getValue();
     }
+
+    public function getHashString(): string
+    {
+        return \hash('xxh3', self::class . ':' . $this->key->getRawValue());
+    }
 }

src/Node/Stmt/Shape/StringNamedFieldNode.php

@@ -8,9 +8,6 @@
 use TypeLang\Parser\Node\Stmt\Attribute\AttributeGroupsListNode;
 use TypeLang\Parser\Node\Stmt\TypeStatement;
 
-/**
- * TODO Add name non-emptiness assertion
- */
 final class StringNamedFieldNode extends ExplicitFieldNode
 {
     public function __construct(
@@ -22,8 +19,8 @@ public function __construct(
         parent::__construct($of, $optional, $attributes);
     }
 
-    public function getKey(): string
+    public function getHashString(): string
     {
-        return $this->key->getValue();
+        return \hash('xxh3', self::class . ':' . $this->key->getValue());
     }
 }