feat: support for readonly class (#1046)

glayzzle · Jan 11, 2023 · 30e229e · 30e229e
1 parent 0cbf7c4
commit 30e229e
Show file tree

Hide file tree

Showing 27 changed files with 325 additions and 37 deletions.
diff --git a/src/ast/class.js b/src/ast/class.js
@@ -19,6 +19,7 @@ const KIND = "class";
  * @property {boolean} isAnonymous
  * @property {boolean} isAbstract
  * @property {boolean} isFinal
+ * @property {boolean} isReadonly
  * @property {AttrGroup[]} attrGroups
  */
 module.exports = Declaration.extends(

diff --git a/src/ast/declaration.js b/src/ast/declaration.js
@@ -39,6 +39,7 @@ const Declaration = Statement.extends(
 Declaration.prototype.parseFlags = function (flags) {
   this.isAbstract = flags[2] === 1;
   this.isFinal = flags[2] === 2;
+  this.isReadonly = flags[3] === 1;
   if (this.kind !== "class") {
     if (flags[0] === -1) {
       this.visibility = IS_UNDEFINED;

diff --git a/src/parser/class.js b/src/parser/class.js
@@ -36,21 +36,35 @@ module.exports = {
   },
 
   read_class_modifiers: function () {
-    return [0, 0, this.read_class_modifier()];
+    const modifier = this.read_class_modifier({
+      readonly: 0,
+      final_or_abstract: 0,
+    });
+    return [0, 0, modifier.final_or_abstract, modifier.readonly];
   },
 
-  read_class_modifier: function () {
-    const result = 0;
-
-    if (this.token === this.tok.T_ABSTRACT) {
+  read_class_modifier: function (memo) {
+    if (this.token === this.tok.T_READ_ONLY) {
+      this.next();
+      memo.readonly = 1;
+      memo = this.read_class_modifier(memo);
+    } else if (
+      memo.final_or_abstract === 0 &&
+      this.token === this.tok.T_ABSTRACT
+    ) {
       this.next();
-      return 1;
-    } else if (this.token === this.tok.T_FINAL) {
+      memo.final_or_abstract = 1;
+      memo = this.read_class_modifier(memo);
+    } else if (
+      memo.final_or_abstract === 0 &&
+      this.token === this.tok.T_FINAL
+    ) {
       this.next();
-      return 2;
+      memo.final_or_abstract = 2;
+      memo = this.read_class_modifier(memo);
     }
 
-    return result;
+    return memo;
   },
 
   /*

diff --git a/src/parser/statement.js b/src/parser/statement.js
@@ -47,6 +47,7 @@ module.exports = {
       // optional flags
       case this.tok.T_ABSTRACT:
       case this.tok.T_FINAL:
+      case this.tok.T_READ_ONLY:
       case this.tok.T_CLASS:
         return this.read_class_declaration_statement(attrs);
       case this.tok.T_INTERFACE:

diff --git a/test/snapshot/__snapshots__/acid.test.js.snap b/test/snapshot/__snapshots__/acid.test.js.snap
@@ -1540,6 +1540,7 @@ Program {
               "byref": false,
               "isAbstract": false,
               "isFinal": true,
+              "isReadonly": false,
               "isStatic": false,
               "kind": "method",
               "leadingComments": [
@@ -1625,6 +1626,7 @@ Program {
           "isAbstract": true,
           "isAnonymous": false,
           "isFinal": false,
+          "isReadonly": false,
           "kind": "class",
           "leadingComments": [
             CommentBlock {
@@ -1713,6 +1715,7 @@ Program {
               "byref": false,
               "isAbstract": false,
               "isFinal": false,
+              "isReadonly": false,
               "isStatic": false,
               "kind": "method",
               "loc": Location {
@@ -1773,6 +1776,7 @@ Program {
               "byref": false,
               "isAbstract": false,
               "isFinal": false,
+              "isReadonly": false,
               "isStatic": false,
               "kind": "method",
               "loc": Location {
@@ -1833,6 +1837,7 @@ Program {
               "byref": false,
               "isAbstract": false,
               "isFinal": false,
+              "isReadonly": false,
               "isStatic": true,
               "kind": "method",
               "loc": Location {
@@ -2823,6 +2828,7 @@ Program {
               "byref": false,
               "isAbstract": false,
               "isFinal": false,
+              "isReadonly": false,
               "isStatic": false,
               "kind": "method",
               "loc": Location {
@@ -2936,6 +2942,7 @@ Program {
               "byref": false,
               "isAbstract": false,
               "isFinal": false,
+              "isReadonly": false,
               "isStatic": false,
               "kind": "method",
               "loc": Location {
@@ -5284,6 +5291,7 @@ next:
                                               "byref": false,
                                               "isAbstract": false,
                                               "isFinal": false,
+                                              "isReadonly": false,
                                               "isStatic": false,
                                               "kind": "method",
                                               "loc": Location {
@@ -5343,6 +5351,7 @@ next:
                                           "isAbstract": false,
                                           "isAnonymous": true,
                                           "isFinal": false,
+                                          "isReadonly": false,
                                           "kind": "class",
                                           "loc": Location {
                                             "end": Position {

diff --git a/test/snapshot/__snapshots__/attributes.test.js.snap b/test/snapshot/__snapshots__/attributes.test.js.snap
@@ -34,6 +34,7 @@ Program {
             "isAbstract": false,
             "isAnonymous": true,
             "isFinal": false,
+            "isReadonly": false,
             "kind": "class",
             "name": null,
           },
@@ -287,6 +288,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -340,6 +342,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -462,6 +465,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -538,6 +542,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "name": Identifier {
@@ -589,6 +594,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "name": Identifier {
@@ -605,6 +611,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -659,6 +666,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -990,6 +998,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -1174,6 +1183,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -1420,6 +1430,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -1525,6 +1536,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -1691,6 +1703,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "name": Identifier {
@@ -1711,6 +1724,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "name": Identifier {
@@ -1731,6 +1745,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "name": Identifier {
@@ -1747,6 +1762,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -1775,6 +1791,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "leadingComments": [
@@ -1799,6 +1816,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "leadingComments": [
         CommentLine {
@@ -1968,6 +1986,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",

diff --git a/test/snapshot/__snapshots__/block.test.js.snap b/test/snapshot/__snapshots__/block.test.js.snap
@@ -88,6 +88,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -667,6 +668,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "name": Identifier {
@@ -683,6 +685,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",

diff --git a/test/snapshot/__snapshots__/call.test.js.snap b/test/snapshot/__snapshots__/call.test.js.snap
@@ -1213,6 +1213,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "name": Identifier {
@@ -1229,6 +1230,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -1339,6 +1341,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "name": Identifier {
@@ -1355,6 +1358,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",
@@ -1450,6 +1454,7 @@ Program {
           "byref": false,
           "isAbstract": false,
           "isFinal": false,
+          "isReadonly": false,
           "isStatic": false,
           "kind": "method",
           "name": Identifier {
@@ -1466,6 +1471,7 @@ Program {
       "isAbstract": false,
       "isAnonymous": false,
       "isFinal": false,
+      "isReadonly": false,
       "kind": "class",
       "name": Identifier {
         "kind": "identifier",