Merge pull request glayzzle#862 from czosel/add-enum-support

Add enum support

Author: czosel

src/ast.js

@@ -504,6 +504,8 @@ AST.prototype.checkNodes = function () {
   require("./ast/encapsed"),
   require("./ast/encapsedpart"),
   require("./ast/entry"),
+  require("./ast/enum"),
+  require("./ast/enumcase"),
   require("./ast/error"),
   require("./ast/eval"),
   require("./ast/exit"),

src/ast/enum.js

@@ -0,0 +1,30 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Declaration = require("./declaration");
+const KIND = "enum";
+
+/**
+ * A enum definition
+ * @constructor Enum
+ * @memberOf module:php-parser
+ * @extends {Declaration}
+ * @property {Identifier|null} valueType
+ * @property {Identifier[]} implements
+ * @property {Declaration[]} body
+ * @property {AttrGroup[]} attrGroups
+ */
+module.exports = Declaration.extends(
+  KIND,
+  function Enum(name, valueType, impl, body, docs, location) {
+    Declaration.apply(this, [KIND, name, docs, location]);
+    this.valueType = valueType;
+    this.implements = impl;
+    this.body = body;
+    this.attrGroups = [];
+  }
+);

src/ast/enumcase.js

@@ -0,0 +1,26 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Node = require("./node");
+const KIND = "enumcase";
+
+/**
+ * Declares a cases into the current scope
+ * @constructor EnumCase
+ * @memberOf module:php-parser
+ * @extends {Node}
+ * @property {string} name
+ * @property {string|number|null} value
+ */
+module.exports = Node.extends(
+  KIND,
+  function EnumCase(name, value, docs, location) {
+    Node.apply(this, [KIND, docs, location]);
+    this.name = name;
+    this.value = value;
+  }
+);

src/lexer.js

@@ -77,6 +77,7 @@ const Lexer = function (engine) {
     class: this.tok.T_CLASS,
     interface: this.tok.T_INTERFACE,
     trait: this.tok.T_TRAIT,
+    enum: this.tok.T_ENUM,
     extends: this.tok.T_EXTENDS,
     implements: this.tok.T_IMPLEMENTS,
     new: this.tok.T_NEW,

src/parser.js

@@ -73,6 +73,7 @@ const Parser = function (lexer, ast) {
         this.tok.T_ENDIF,
         this.tok.T_ENDSWITCH,
         this.tok.T_ENDWHILE,
+        this.tok.T_ENUM,
         this.tok.T_EVAL,
         this.tok.T_EXIT,
         this.tok.T_EXTENDS,
@@ -700,6 +701,7 @@ Parser.prototype.is = function (type) {
   require("./parser/class.js"),
   require("./parser/comment.js"),
   require("./parser/expr.js"),
+  require("./parser/enum.js"),
   require("./parser/function.js"),
   require("./parser/if.js"),
   require("./parser/loops.js"),

src/parser/class.js

@@ -29,7 +29,7 @@ module.exports = {
     const propExtends = this.read_extends_from();
     const propImplements = this.read_implements_list();
     this.expect("{");
-    const body = this.next().read_class_body();
+    const body = this.next().read_class_body(true, false);
     const node = result(propName, propExtends, propImplements, body, flag);
     if (attrs) node.attrGroups = attrs;
     return node;
@@ -59,7 +59,7 @@ module.exports = {
    *   class_body ::= (member_flags? (T_VAR | T_STRING | T_FUNCTION))*
    * ```
    */
-  read_class_body: function () {
+  read_class_body: function (allow_variables, allow_enum_cases) {
     let result = [];
     let attrs = [];
     while (this.token !== this.EOF && this.token !== "}") {
@@ -79,6 +79,16 @@ module.exports = {
         continue;
       }
 
+      // check enum cases
+      if (allow_enum_cases && this.token === this.tok.T_CASE) {
+        const enumcase = this.read_enum_case();
+        if (this.expect(";")) {
+          this.next();
+        }
+        result = result.concat(enumcase);
+        continue;
+      }
+
       if (this.token === this.tok.T_ATTRIBUTE) {
         attrs = this.read_attr_list();
       }
@@ -99,7 +109,7 @@ module.exports = {
       }
 
       // jump over T_VAR then land on T_VARIABLE
-      if (this.token === this.tok.T_VAR) {
+      if (allow_variables && this.token === this.tok.T_VAR) {
         this.next().expect(this.tok.T_VARIABLE);
         flags[0] = null; // public (as null)
         flags[1] = 0; // non static var
@@ -110,15 +120,16 @@ module.exports = {
         result.push(this.read_function(false, flags, attrs, locStart));
         attrs = [];
       } else if (
-        this.token === this.tok.T_VARIABLE ||
-        // support https://wiki.php.net/rfc/typed_properties_v2
-        (this.version >= 704 &&
-          (this.token === "?" ||
-            this.token === this.tok.T_CALLABLE ||
-            this.token === this.tok.T_ARRAY ||
-            this.token === this.tok.T_NS_SEPARATOR ||
-            this.token === this.tok.T_STRING ||
-            this.token === this.tok.T_NAMESPACE))
+        allow_variables &&
+        (this.token === this.tok.T_VARIABLE ||
+          // support https://wiki.php.net/rfc/typed_properties_v2
+          (this.version >= 704 &&
+            (this.token === "?" ||
+              this.token === this.tok.T_CALLABLE ||
+              this.token === this.tok.T_ARRAY ||
+              this.token === this.tok.T_NS_SEPARATOR ||
+              this.token === this.tok.T_STRING ||
+              this.token === this.tok.T_NAMESPACE)))
       ) {
         // reads a variable
         const variables = this.read_variable_list(flags, attrs);
@@ -130,7 +141,8 @@ module.exports = {
         // raise an error
         this.error([
           this.tok.T_CONST,
-          this.tok.T_VARIABLE,
+          ...(allow_variables ? [this.tok.T_VARIABLE] : []),
+          ...(allow_enum_cases ? [this.tok.T_CASE] : []),
           this.tok.T_FUNCTION,
         ]);
         // ignore token
@@ -452,7 +464,7 @@ module.exports = {
     this.next();
     propName = propName(name);
     this.expect("{");
-    const body = this.next().read_class_body();
+    const body = this.next().read_class_body(true, false);
     return result(propName, body);
   },
   /*

src/parser/enum.js

@@ -0,0 +1,56 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+module.exports = {
+  /*
+   * reading an enum
+   * ```ebnf
+   * enum ::= enum_scope? T_ENUM T_STRING (':' NAMESPACE_NAME)? (T_IMPLEMENTS (NAMESPACE_NAME ',')* NAMESPACE_NAME)? '{' ENUM_BODY '}'
+   * ```
+   */
+  read_enum_declaration_statement: function (attrs) {
+    const result = this.node("enum");
+    // graceful mode : ignore token & go next
+    if (!this.expect(this.tok.T_ENUM)) {
+      return null;
+    }
+    this.next().expect(this.tok.T_STRING);
+    let propName = this.node("identifier");
+    const name = this.text();
+    this.next();
+    propName = propName(name);
+    const valueType = this.read_enum_value_type();
+    const propImplements = this.read_implements_list();
+    this.expect("{");
+    const body = this.next().read_class_body(false, true);
+    const node = result(propName, valueType, propImplements, body);
+    if (attrs) node.attrGroups = attrs;
+    return node;
+  },
+
+  read_enum_value_type: function () {
+    if (this.token === ":") {
+      return this.next().read_namespace_name();
+    }
+
+    return null;
+  },
+
+  read_enum_case: function () {
+    this.expect(this.tok.T_CASE);
+    const result = this.node("enumcase");
+    let caseName = this.node("identifier");
+    const name = this.next().text();
+    this.next();
+    caseName = caseName(name);
+
+    const value = this.token === "=" ? this.next().read_expr() : null;
+    this.expect(";");
+
+    return result(caseName, value);
+  },
+};

src/parser/expr.js

@@ -724,7 +724,7 @@ module.exports = {
       const propImplements = this.read_implements_list();
       let body = null;
       if (this.expect("{")) {
-        body = this.next().read_class_body();
+        body = this.next().read_class_body(true, false);
       }
       const whatNode = what(null, propExtends, propImplements, body, [0, 0, 0]);
       whatNode.attrGroups = attrs;

src/parser/statement.js

@@ -53,6 +53,8 @@ module.exports = {
         return this.read_interface_declaration_statement(attrs);
       case this.tok.T_TRAIT:
         return this.read_trait_declaration_statement();
+      case this.tok.T_ENUM:
+        return this.read_enum_declaration_statement(attrs);
       case this.tok.T_USE:
         return this.read_use_statement();
       case this.tok.T_CONST: {
@@ -173,6 +175,8 @@ module.exports = {
         return this.read_interface_declaration_statement();
       case this.tok.T_TRAIT:
         return this.read_trait_declaration_statement();
+      case this.tok.T_ENUM:
+        return this.read_enum_declaration_statement();
       case this.tok.T_HALT_COMPILER: {
         this.raiseError(
           "__HALT_COMPILER() can only be used from the outermost scope"

src/tokens.js

@@ -154,6 +154,7 @@ const tokens = {
     236: "T_NULLSAFE_OBJECT_OPERATOR",
     237: "T_MATCH",
     238: "T_ATTRIBUTE",
+    239: "T_ENUM",
   },
   names: {
     T_HALT_COMPILER: 101,
@@ -294,6 +295,7 @@ const tokens = {
     T_NULLSAFE_OBJECT_OPERATOR: 236,
     T_MATCH: 237,
     T_ATTRIBUTE: 238,
+    T_ENUM: 239,
   },
 };