glayzzle#188 - implement static, parent, self nodes

Author: ichiriac

src/ast.js

@@ -15,6 +15,12 @@ const Position = require("./ast/position");
  * - [Position](#position)
  * - [Node](#node)
  *   - [Identifier](#identifier)
+ *   - [Reference](#reference)
+ *     - [TypeReference](#classreference)
+ *     - [ParentReference](#classreference)
+ *     - [StaticReference](#classreference)
+ *     - [SelfReference](#classreference)
+ *     - [ClassReference](#classreference)
  *   - [TraitUse](#traituse)
  *   - [TraitAlias](#traitalias)
  *   - [TraitPrecedence](#traitprecedence)
@@ -345,6 +351,7 @@ AST.prototype.prepare = function(kind, docs, parser) {
   require("./ast/catch"),
   require("./ast/class"),
   require("./ast/classconstant"),
+  require("./ast/classreference"),
   require("./ast/clone"),
   require("./ast/closure"),
   require("./ast/comment"),
@@ -391,6 +398,7 @@ AST.prototype.prepare = function(kind, docs, parser) {
   require("./ast/offsetlookup"),
   require("./ast/operation"),
   require("./ast/parameter"),
+  require("./ast/parentreference"),
   require("./ast/post"),
   require("./ast/pre"),
   require("./ast/print"),
@@ -400,10 +408,12 @@ AST.prototype.prepare = function(kind, docs, parser) {
   require("./ast/reference"),
   require("./ast/retif"),
   require("./ast/return"),
+  require("./ast/selfreference"),
   require("./ast/silent"),
   require("./ast/statement"),
   require("./ast/static"),
   require("./ast/staticlookup"),
+  require("./ast/staticreference"),
   require("./ast/string"),
   require("./ast/switch"),
   require("./ast/sys"),

src/ast/classreference.js

@@ -0,0 +1,60 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Reference = require("./reference");
+const KIND = "classreference";
+
+/**
+ * Defines a class reference node
+ * @constructor ClassReference
+ * @extends {Node}
+ * @property {string} name
+ * @property {string} resolution
+ */
+const ClassReference = Reference.extends(KIND, function ClassReference(
+  name,
+  isRelative,
+  docs,
+  location
+) {
+  Reference.apply(this, [KIND, docs, location]);
+  if (isRelative) {
+    this.resolution = ClassReference.RELATIVE_NAME;
+  } else if (name.length === 1) {
+    this.resolution = ClassReference.UNQUALIFIED_NAME;
+  } else if (name[0] === "") {
+    this.resolution = ClassReference.FULL_QUALIFIED_NAME;
+  } else {
+    this.resolution = ClassReference.QUALIFIED_NAME;
+  }
+  this.name = name.join("\\");
+});
+
+/**
+ * This is an identifier without a namespace separator, such as Foo
+ * @constant {String} UNQUALIFIED_NAME
+ */
+ClassReference.UNQUALIFIED_NAME = "uqn";
+/**
+ * This is an identifier with a namespace separator, such as Foo\Bar
+ * @constant {String} QUALIFIED_NAME
+ */
+ClassReference.QUALIFIED_NAME = "qn";
+/**
+ * This is an identifier with a namespace separator that begins with
+ * a namespace separator, such as \Foo\Bar. The namespace \Foo is also
+ * a fully qualified name.
+ * @constant {String} FULL_QUALIFIED_NAME
+ */
+ClassReference.FULL_QUALIFIED_NAME = "fqn";
+/**
+ * This is an identifier starting with namespace, such as namespace\Foo\Bar.
+ * @constant {String} RELATIVE_NAME
+ */
+ClassReference.RELATIVE_NAME = "rn";
+
+module.exports = ClassReference;

src/ast/parentreference.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Reference = require("./reference");
+const KIND = "parentreference";
+
+/**
+ * Defines a class reference node
+ * @constructor ParentReference
+ * @extends {Reference}
+ */
+const ParentReference = Reference.extends(KIND, function ParentReference(
+  docs,
+  location
+) {
+  Reference.apply(this, [KIND, docs, location]);
+});
+module.exports = ParentReference;

src/ast/reference.js

@@ -12,49 +12,9 @@ const KIND = "reference";
  * Defines a reference node
  * @constructor Reference
  * @extends {Node}
- * @property {string} name
- * @property {string} resolution
  */
-const Reference = Node.extends(KIND, function Reference(
-  name,
-  isRelative,
-  docs,
-  location
-) {
-  Node.apply(this, [KIND, docs, location]);
-  if (isRelative) {
-    this.resolution = Reference.RELATIVE_NAME;
-  } else if (name.length === 1) {
-    this.resolution = Reference.UNQUALIFIED_NAME;
-  } else if (name[0] === "") {
-    this.resolution = Reference.FULL_QUALIFIED_NAME;
-  } else {
-    this.resolution = Reference.QUALIFIED_NAME;
-  }
-  this.name = name.join("\\");
+const Reference = Node.extends(KIND, function Reference(kind, docs, location) {
+  Node.apply(this, [kind || KIND, docs, location]);
 });
 
-/**
- * This is an identifier without a namespace separator, such as Foo
- * @constant {String} UNQUALIFIED_NAME
- */
-Reference.UNQUALIFIED_NAME = "uqn";
-/**
- * This is an identifier with a namespace separator, such as Foo\Bar
- * @constant {String} QUALIFIED_NAME
- */
-Reference.QUALIFIED_NAME = "qn";
-/**
- * This is an identifier with a namespace separator that begins with
- * a namespace separator, such as \Foo\Bar. The namespace \Foo is also
- * a fully qualified name.
- * @constant {String} FULL_QUALIFIED_NAME
- */
-Reference.FULL_QUALIFIED_NAME = "fqn";
-/**
- * This is an identifier starting with namespace, such as namespace\Foo\Bar.
- * @constant {String} RELATIVE_NAME
- */
-Reference.RELATIVE_NAME = "rn";
-
 module.exports = Reference;

src/ast/selfreference.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Reference = require("./reference");
+const KIND = "selfreference";
+
+/**
+ * Defines a class reference node
+ * @constructor SelfReference
+ * @extends {Reference}
+ */
+const SelfReference = Reference.extends(KIND, function SelfReference(
+  docs,
+  location
+) {
+  Reference.apply(this, [KIND, docs, location]);
+});
+module.exports = SelfReference;

src/ast/staticreference.js

@@ -0,0 +1,22 @@
+/**
+ * Copyright (C) 2018 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+const Reference = require("./reference");
+const KIND = "staticreference";
+
+/**
+ * Defines a class reference node
+ * @constructor StaticReference
+ * @extends {Reference}
+ */
+const StaticReference = Reference.extends(KIND, function StaticReference(
+  docs,
+  location
+) {
+  Reference.apply(this, [KIND, docs, location]);
+});
+module.exports = StaticReference;

src/parser/function.js

@@ -240,7 +240,7 @@ module.exports = {
    * ```
    */
   read_type: function() {
-    const result = this.node("reference");
+    const result = this.node("classreference");
     switch (this.token) {
       case this.tok.T_ARRAY:
         this.next();

src/parser/namespace.js

@@ -62,16 +62,25 @@ module.exports = {
    * @return {Reference}
    */
   read_namespace_name: function() {
-    const result = this.node("reference");
+    const result = this.node();
     let relative = false;
     if (this.token === this.tok.T_NAMESPACE) {
       this.next().expect(this.tok.T_NS_SEPARATOR) && this.next();
       relative = true;
     }
-    return result(
-      this.read_list(this.tok.T_STRING, this.tok.T_NS_SEPARATOR, true),
-      relative
+    const names = this.read_list(
+      this.tok.T_STRING,
+      this.tok.T_NS_SEPARATOR,
+      true
     );
+    if (!relative && names.length === 1) {
+      if (names[0] === "parent") {
+        return result("parentreference");
+      } else if (names[0] === "self") {
+        return result("selfreference");
+      }
+    }
+    return result("classreference", names, relative);
   },
   /**
    * Reads a use statement

src/parser/variable.js

@@ -59,10 +59,9 @@ module.exports = {
         result = name;
       }
     } else if (this.token === this.tok.T_STATIC) {
-      result = this.node("identifier");
-      let name = this.text();
+      result = this.node("staticreference");
       this.next();
-      result = result(name);
+      result = result();
     } else {
       this.expect("VARIABLE");
     }