fix glayzzle#193

Author: ichiriac

src/ast.js

@@ -291,6 +291,15 @@ AST.prototype.prepare = function(kind, docs, parser) {
   result.setKind = function(newKind) {
     kind = newKind;
   };
+  /**
+   * Release a node without using it on the AST
+   */
+  result.destroy = function() {
+    if (docs) {
+      // release current docs stack
+      parser._docIndex = parser._docs.length - docs.length;
+    }
+  };
   return result;
 };
 

src/parser.js

@@ -353,6 +353,10 @@ parser.prototype.node = function(name) {
     if (this._docIndex < this._docs.length) {
       const docs = this._docs.slice(this._docIndex);
       this._docIndex = this._docs.length;
+      if (this.debug) {
+        console.log(new Error("Append docs on " + name));
+        console.log(docs);
+      }
       return this.ast.prepare(name, docs, this);
     }
   }
@@ -379,7 +383,7 @@ parser.prototype.expectEndOfStatement = function(node) {
 };
 
 /** outputs some debug information on current token **/
-const ignoreStack = ["parser.next"];
+const ignoreStack = ["parser.next", "parser.node", "parser.showlog"];
 parser.prototype.showlog = function() {
   const stack = new Error().stack.split("\n");
   let line;

src/parser/expr.js

@@ -80,6 +80,9 @@ module.exports = {
       }
       this.expect(":") && this.next();
       return result("retif", expr, trueArg, this.read_expr());
+    } else {
+      // see #193
+      result.destroy();
     }
 
     return expr;
@@ -419,6 +422,9 @@ module.exports = {
           if (isConst) this.error("VARIABLE");
           this.next();
           return result("post", "-", expr);
+        default:
+          // see #193
+          result.destroy();
       }
     } else if (this.is("SCALAR")) {
       result = this.node();
@@ -429,6 +435,9 @@ module.exports = {
         if (expr.loc) list.loc = expr.loc;
         let right = this.next().read_expr();
         return result("assign", list, right, "=");
+      } else {
+        // see #193
+        result.destroy();
       }
       // classic array
       return this.handleDereferencable(expr);

src/parser/scalar.js

@@ -222,6 +222,7 @@ module.exports = {
     } else if (this.token === this.tok.T_CURLY_OPEN) {
       // expression
       // https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L1246
+      result.destroy();
       result = this.next().read_variable(false, false, false);
       if (result.kind === "variable") {
         result.curly = true;
@@ -230,6 +231,7 @@ module.exports = {
     } else if (this.token === this.tok.T_VARIABLE) {
       // plain variable
       // https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L1231
+      result.destroy();
       result = this.read_simple_variable(false);
 
       // https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L1233
@@ -243,8 +245,8 @@ module.exports = {
       // https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L1236
       if (this.token === this.tok.T_OBJECT_OPERATOR) {
         node = this.node("propertylookup");
-        const what = this.node("constref");
         this.next().expect(this.tok.T_STRING);
+        const what = this.node("constref");
         name = this.text();
         this.next();
         result = node(result, what(name));

src/parser/variable.js

@@ -55,6 +55,7 @@ module.exports = {
           result = result("constref", name);
         }
       } else {
+        // @fixme possible #193 bug
         result = name;
       }
     } else if (this.token === this.tok.T_STATIC) {
@@ -296,7 +297,10 @@ module.exports = {
         offset = this.next().read_expr();
         this.expect("}") && this.next();
         result = node("offsetlookup", result, offset);
-      } else break;
+      } else {
+        node.destroy();
+        break;
+      }
     }
     return result;
   },

test/snapshot/__snapshots__/acid.test.js.snap

@@ -6932,6 +6932,27 @@ FOO
 THE END ...
 ",
       "kind": "halt",
+      "leadingComments": Array [
+        CommentLine {
+          "kind": "commentline",
+          "loc": Location {
+            "end": Position {
+              "column": 0,
+              "line": 140,
+              "offset": 2977,
+            },
+            "source": "// list version
+",
+            "start": Position {
+              "column": 2,
+              "line": 139,
+              "offset": 2961,
+            },
+          },
+          "value": "// list version
+",
+        },
+      ],
       "loc": Location {
         "end": Position {
           "column": 17,

test/snapshot/__snapshots__/comment.test.js.snap

@@ -142,6 +142,68 @@ Program {
 }
 `;
 
+exports[`Test comments issues fix #193 1`] = `
+Program {
+  "children": Array [
+    Assign {
+      "kind": "assign",
+      "left": Variable {
+        "byref": false,
+        "curly": false,
+        "kind": "variable",
+        "name": "a",
+      },
+      "operator": "=",
+      "right": Call {
+        "arguments": Array [],
+        "kind": "call",
+        "what": PropertyLookup {
+          "kind": "propertylookup",
+          "leadingComments": Array [
+            CommentLine {
+              "kind": "commentline",
+              "value": "// Comment Before
+",
+            },
+          ],
+          "offset": ConstRef {
+            "kind": "constref",
+            "leadingComments": Array [
+              CommentLine {
+                "kind": "commentline",
+                "value": "// Comment After
+",
+              },
+            ],
+            "name": "each",
+          },
+          "what": Variable {
+            "byref": false,
+            "curly": false,
+            "kind": "variable",
+            "name": "var",
+          },
+        },
+      },
+    },
+  ],
+  "comments": Array [
+    CommentLine {
+      "kind": "commentline",
+      "value": "// Comment Before
+",
+    },
+    CommentLine {
+      "kind": "commentline",
+      "value": "// Comment After
+",
+    },
+  ],
+  "errors": Array [],
+  "kind": "program",
+}
+`;
+
 exports[`Test comments multi line comments test function 1`] = `
 Program {
   "children": Array [
@@ -347,6 +409,14 @@ Program {
             "kind": "commentblock",
             "value": "/* ignore */",
           },
+          CommentBlock {
+            "kind": "commentblock",
+            "value": "/* */",
+          },
+          CommentBlock {
+            "kind": "commentblock",
+            "value": "/* ignore */",
+          },
         ],
       },
       "kind": "if",
@@ -525,6 +595,10 @@ Program {
             "children": Array [],
             "kind": "block",
             "leadingComments": Array [
+              CommentBlock {
+                "kind": "commentblock",
+                "value": "/* bb */",
+              },
               CommentBlock {
                 "kind": "commentblock",
                 "value": "/* dd */",

test/snapshot/comment.test.js

@@ -39,6 +39,25 @@ describe("Test comments", function() {
       );
       expect(ast).toMatchSnapshot();
     });
+    
+    it("fix #193", function() {
+      const ast = parser.parseEval(
+        `
+        $a = $var
+          // Comment Before
+          ->
+          // Comment After
+          each();
+        `,
+        {
+          parser: {
+            extractDoc: true,
+            // debug: true
+          }
+        }
+      );
+      expect(ast).toMatchSnapshot();
+    });
   });
 
   it("test single line comments", function() {