Add support for new PHP 8.1 modifiers (#796)

Implement support for readonly properties (https://wiki.php.net/rfc/readonly_properties_v2) and final class contstants (https://wiki.php.net/rfc/final_class_const).
nikic · Jul 21, 2021 · 55c4269 · 55c4269
1 parent c4304c7
commit 55c4269
Show file tree

Hide file tree

Showing 26 changed files with 1,457 additions and 1,211 deletions.
diff --git a/grammar/php7.y b/grammar/php7.y
@@ -38,7 +38,7 @@ reserved_non_modifiers:
 
 semi_reserved:
       reserved_non_modifiers
-    | T_STATIC | T_ABSTRACT | T_FINAL | T_PRIVATE | T_PROTECTED | T_PUBLIC
+    | T_STATIC | T_ABSTRACT | T_FINAL | T_PRIVATE | T_PROTECTED | T_PUBLIC | T_READONLY
 ;
 
 identifier_ex:
@@ -535,6 +535,7 @@ optional_visibility_modifier:
     | T_PUBLIC                  { $$ = Stmt\Class_::MODIFIER_PUBLIC; }
     | T_PROTECTED               { $$ = Stmt\Class_::MODIFIER_PROTECTED; }
     | T_PRIVATE                 { $$ = Stmt\Class_::MODIFIER_PRIVATE; }
+    | T_READONLY                { $$ = Stmt\Class_::MODIFIER_READONLY; }
 ;
 
 parameter:
@@ -725,6 +726,7 @@ member_modifier:
     | T_STATIC                                              { $$ = Stmt\Class_::MODIFIER_STATIC; }
     | T_ABSTRACT                                            { $$ = Stmt\Class_::MODIFIER_ABSTRACT; }
     | T_FINAL                                               { $$ = Stmt\Class_::MODIFIER_FINAL; }
+    | T_READONLY                                            { $$ = Stmt\Class_::MODIFIER_READONLY; }
 ;
 
 property_declaration_list:

diff --git a/grammar/tokens.y b/grammar/tokens.y
@@ -74,7 +74,7 @@
 %token T_USE
 %token T_INSTEADOF
 %token T_GLOBAL
-%right T_STATIC T_ABSTRACT T_FINAL T_PRIVATE T_PROTECTED T_PUBLIC
+%right T_STATIC T_ABSTRACT T_FINAL T_PRIVATE T_PROTECTED T_PUBLIC T_READONLY
 %token T_VAR
 %token T_UNSET
 %token T_ISSET

diff --git a/lib/PhpParser/Builder/ClassConst.php b/lib/PhpParser/Builder/ClassConst.php
@@ -77,6 +77,17 @@ public function makePrivate() {
         return $this;
     }
 
+    /**
+     * Makes the constant final.
+     *
+     * @return $this The builder instance (for fluid interface)
+     */
+    public function makeFinal() {
+        $this->flags = BuilderHelpers::addModifier($this->flags, Stmt\Class_::MODIFIER_FINAL);
+
+        return $this;
+    }
+
     /**
      * Sets doc comment for the constant.
      *

diff --git a/lib/PhpParser/Builder/Property.php b/lib/PhpParser/Builder/Property.php
@@ -77,6 +77,17 @@ public function makeStatic() {
         return $this;
     }
 
+    /**
+     * Makes the property readonly.
+     *
+     * @return $this The builder instance (for fluid interface)
+     */
+    public function makeReadonly() {
+        $this->flags = BuilderHelpers::addModifier($this->flags, Stmt\Class_::MODIFIER_READONLY);
+
+        return $this;
+    }
+
     /**
      * Sets default value for the property.
      *

diff --git a/lib/PhpParser/Lexer.php b/lib/PhpParser/Lexer.php
@@ -443,6 +443,7 @@ private function defineCompatibilityTokens() {
             'T_ENUM',
             'T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG',
             'T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG',
+            'T_READONLY',
         ];
 
         // PHP-Parser might be used together with another library that also emulates some or all
@@ -536,6 +537,7 @@ protected function createTokenMap() : array {
         $tokenMap[\T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG] = Tokens::T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG;
         $tokenMap[\T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG] = Tokens::T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG;
         $tokenMap[\T_ENUM] = Tokens::T_ENUM;
+        $tokenMap[\T_READONLY] = Tokens::T_READONLY;
 
         return $tokenMap;
     }
@@ -544,7 +546,7 @@ private function createIdentifierTokenMap(): array {
         // Based on semi_reserved production.
         return array_fill_keys([
             \T_STRING,
-            \T_STATIC, \T_ABSTRACT, \T_FINAL, \T_PRIVATE, \T_PROTECTED, \T_PUBLIC,
+            \T_STATIC, \T_ABSTRACT, \T_FINAL, \T_PRIVATE, \T_PROTECTED, \T_PUBLIC, \T_READONLY,
             \T_INCLUDE, \T_INCLUDE_ONCE, \T_EVAL, \T_REQUIRE, \T_REQUIRE_ONCE, \T_LOGICAL_OR, \T_LOGICAL_XOR, \T_LOGICAL_AND,
             \T_INSTANCEOF, \T_NEW, \T_CLONE, \T_EXIT, \T_IF, \T_ELSEIF, \T_ELSE, \T_ENDIF, \T_ECHO, \T_DO, \T_WHILE,
             \T_ENDWHILE, \T_FOR, \T_ENDFOR, \T_FOREACH, \T_ENDFOREACH, \T_DECLARE, \T_ENDDECLARE, \T_AS, \T_TRY, \T_CATCH,

diff --git a/lib/PhpParser/Lexer/Emulative.php b/lib/PhpParser/Lexer/Emulative.php
@@ -13,6 +13,7 @@
 use PhpParser\Lexer\TokenEmulator\MatchTokenEmulator;
 use PhpParser\Lexer\TokenEmulator\NullsafeTokenEmulator;
 use PhpParser\Lexer\TokenEmulator\NumericLiteralSeparatorEmulator;
+use PhpParser\Lexer\TokenEmulator\ReadonlyTokenEmulator;
 use PhpParser\Lexer\TokenEmulator\ReverseEmulator;
 use PhpParser\Lexer\TokenEmulator\TokenEmulator;
 
@@ -53,6 +54,7 @@ public function __construct(array $options = [])
             new NullsafeTokenEmulator(),
             new AttributeEmulator(),
             new EnumTokenEmulator(),
+            new ReadonlyTokenEmulator(),
         ];
 
         // Collect emulators that are relevant for the PHP version we're running

diff --git a/lib/PhpParser/Lexer/TokenEmulator/ReadonlyTokenEmulator.php b/lib/PhpParser/Lexer/TokenEmulator/ReadonlyTokenEmulator.php
@@ -0,0 +1,23 @@
+<?php declare(strict_types=1);
+
+namespace PhpParser\Lexer\TokenEmulator;
+
+use PhpParser\Lexer\Emulative;
+
+final class ReadonlyTokenEmulator extends KeywordEmulator
+{
+    public function getPhpVersion(): string
+    {
+        return Emulative::PHP_8_1;
+    }
+
+    public function getKeywordString(): string
+    {
+        return 'readonly';
+    }
+
+    public function getKeywordToken(): int
+    {
+        return \T_READONLY;
+    }
+}
diff --git a/lib/PhpParser/Node/Stmt/ClassConst.php b/lib/PhpParser/Node/Stmt/ClassConst.php
@@ -65,6 +65,15 @@ public function isPrivate() : bool {
         return (bool) ($this->flags & Class_::MODIFIER_PRIVATE);
     }
 
+    /**
+     * Whether constant is final.
+     *
+     * @return bool
+     */
+    public function isFinal() : bool {
+        return (bool) ($this->flags & Class_::MODIFIER_FINAL);
+    }
+
     public function getType() : string {
         return 'Stmt_ClassConst';
     }

diff --git a/lib/PhpParser/Node/Stmt/Class_.php b/lib/PhpParser/Node/Stmt/Class_.php
@@ -13,6 +13,7 @@ class Class_ extends ClassLike
     const MODIFIER_STATIC    =  8;
     const MODIFIER_ABSTRACT  = 16;
     const MODIFIER_FINAL     = 32;
+    const MODIFIER_READONLY  = 64;
 
     const VISIBILITY_MODIFIER_MASK = 7; // 1 | 2 | 4
 
@@ -96,6 +97,10 @@ public static function verifyModifier($a, $b) {
             throw new Error('Multiple final modifiers are not allowed');
         }
 
+        if ($a & self::MODIFIER_READONLY && $b & self::MODIFIER_READONLY) {
+            throw new Error('Multiple readonly modifiers are not allowed');
+        }
+
         if ($a & 48 && $b & 48) {
             throw new Error('Cannot use the final modifier on an abstract class member');
         }

diff --git a/lib/PhpParser/Node/Stmt/Property.php b/lib/PhpParser/Node/Stmt/Property.php
@@ -77,6 +77,15 @@ public function isStatic() : bool {
         return (bool) ($this->flags & Class_::MODIFIER_STATIC);
     }
 
+    /**
+     * Whether the property is readonly.
+     *
+     * @return bool
+     */
+    public function isReadonly() : bool {
+        return (bool) ($this->flags & Class_::MODIFIER_READONLY);
+    }
+
     public function getType() : string {
         return 'Stmt_Property';
     }

diff --git a/lib/PhpParser/NodeDumper.php b/lib/PhpParser/NodeDumper.php
@@ -128,6 +128,9 @@ protected function dumpFlags($flags) {
         if ($flags & Class_::MODIFIER_FINAL) {
             $strs[] = 'MODIFIER_FINAL';
         }
+        if ($flags & Class_::MODIFIER_READONLY) {
+            $strs[] = 'MODIFIER_READONLY';
+        }
 
         if ($strs) {
             return implode(' | ', $strs) . ' (' . $flags . ')';

diff --git a/lib/PhpParser/Parser/Php5.php b/lib/PhpParser/Parser/Php5.php
@@ -17,11 +17,11 @@
  */
 class Php5 extends \PhpParser\ParserAbstract
 {
-    protected $tokenToSymbolMapSize = 395;
+    protected $tokenToSymbolMapSize = 396;
     protected $actionTableSize = 1093;
     protected $gotoTableSize = 643;
 
-    protected $invalidSymbol = 167;
+    protected $invalidSymbol = 168;
     protected $errorSymbol = 1;
     protected $defaultAction = -32766;
     protected $unexpectedTokenRule = 32767;
@@ -194,38 +194,39 @@ class Php5 extends \PhpParser\ParserAbstract
         "'`'",
         "']'",
         "'\"'",
+        "T_READONLY",
         "T_ENUM",
         "T_NULLSAFE_OBJECT_OPERATOR",
         "T_ATTRIBUTE"
     );
 
     protected $tokenToSymbol = array(
-            0,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,   56,  163,  167,  160,   55,  167,  167,
-          158,  159,   53,   50,    8,   51,   52,   54,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,   31,  155,
-           44,   16,   46,   30,   68,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,   70,  167,  162,   36,  167,  161,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  156,   35,  157,   58,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,  167,  167,  167,  167,
-          167,  167,  167,  167,  167,  167,    1,    2,    3,    4,
+            0,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,   56,  163,  168,  160,   55,  168,  168,
+          158,  159,   53,   50,    8,   51,   52,   54,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,   31,  155,
+           44,   16,   46,   30,   68,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,   70,  168,  162,   36,  168,  161,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  156,   35,  157,   58,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,  168,  168,  168,  168,
+          168,  168,  168,  168,  168,  168,    1,    2,    3,    4,
             5,    6,    7,    9,   10,   11,   12,   13,   14,   15,
            17,   18,   19,   20,   21,   22,   23,   24,   25,   26,
            27,   28,   29,   32,   33,   34,   37,   38,   39,   40,
@@ -235,11 +236,11 @@ class Php5 extends \PhpParser\ParserAbstract
            83,   84,   85,   86,   87,   88,   89,   90,   91,   92,
            93,   94,   95,   96,   97,   98,   99,  100,  101,  102,
           103,  104,  105,  106,  107,  108,  109,  110,  111,  112,
-          113,  114,  115,  116,  117,  118,  119,  120,  121,  122,
-          123,  124,  125,  126,  127,  128,  129,  164,  130,  131,
-          132,  165,  133,  134,  135,  136,  137,  138,  139,  140,
-          141,  142,  143,  144,  145,  146,  147,  148,  149,  150,
-          151,  152,  153,  154,  166
+          113,  114,  115,  116,  117,  118,  119,  120,  121,  164,
+          122,  123,  124,  125,  126,  127,  128,  129,  165,  130,
+          131,  132,  166,  133,  134,  135,  136,  137,  138,  139,
+          140,  141,  142,  143,  144,  145,  146,  147,  148,  149,
+          150,  151,  152,  153,  154,  167
     );
 
     protected $action = array(