glayzzle#141 - fix the location retrieval (ignoring comments & whitespace tokens)

Author: ichiriac

src/ast.js

@@ -250,17 +250,17 @@ AST.prototype.prepare = function(kind, docs, parser) {
       if (self.withSource) {
         src = parser.lexer._input.substring(
           start.offset,
-          parser.lexer.yylloc.prev_offset
+          parser.prev[2]
         );
       }
       if (self.withPositions) {
         location = new Location(
           src,
           start,
           new Position(
-            parser.lexer.yylloc.prev_line,
-            parser.lexer.yylloc.prev_column,
-            parser.lexer.yylloc.prev_offset
+            parser.prev[0],
+            parser.prev[1],
+            parser.prev[2]
           )
         );
       } else {

src/parser.js

@@ -432,6 +432,14 @@ parser.prototype.text = function() {
 
 /** consume the next token **/
 parser.prototype.next = function() {
+
+  // prepare the back command
+  this.prev = [
+    this.lexer.yylloc.last_line,
+    this.lexer.yylloc.last_column,
+    this.lexer.offset
+  ];
+
   // eating the token
   this.lex();
 
@@ -462,13 +470,6 @@ parser.prototype.next = function() {
  * Eating a token
  */
 parser.prototype.lex = function() {
-  // prepare the back command
-  this.prev = [
-    this.lexer.yylloc.first_line,
-    this.lexer.yylloc.first_column,
-    this.lexer.offset
-  ];
-
   // append on token stack
   if (this.extractTokens) {
     do {

src/parser/if.js

@@ -13,12 +13,12 @@ module.exports = {
    * ```
    */
   read_if: function() {
-    const result = this.node("if");
+    let result = this.node("if");
     let body = null;
     let alternate = null;
     let shortForm = false;
     let test = null;
-    test = this.read_if_expr();
+    test = this.next().read_if_expr();
 
     if (this.token === ":") {
       shortForm = true;
@@ -27,10 +27,10 @@ module.exports = {
       const items = [];
       while (this.token !== this.EOF && this.token !== this.tok.T_ENDIF) {
         if (this.token === this.tok.T_ELSEIF) {
-          alternate = this.next().read_elseif_short();
+          alternate = this.read_elseif_short();
           break;
         } else if (this.token === this.tok.T_ELSE) {
-          alternate = this.next().read_else_short();
+          alternate = this.read_else_short();
           break;
         }
         items.push(this.read_inner_statement());
@@ -41,7 +41,7 @@ module.exports = {
     } else {
       body = this.read_statement();
       if (this.token === this.tok.T_ELSEIF) {
-        alternate = this.next().read_if();
+        alternate = this.read_if();
       } else if (this.token === this.tok.T_ELSE) {
         alternate = this.next().read_statement();
       }
@@ -66,15 +66,15 @@ module.exports = {
     let test = null;
     let body = null;
     const items = [];
-    test = this.read_if_expr();
+    test = this.next().read_if_expr();
     if (this.expect(":")) this.next();
     body = this.node("block");
     while (this.token != this.EOF && this.token !== this.tok.T_ENDIF) {
       if (this.token === this.tok.T_ELSEIF) {
-        alternate = this.next().read_elseif_short();
+        alternate = this.read_elseif_short();
         break;
       } else if (this.token === this.tok.T_ELSE) {
-        alternate = this.next().read_else_short();
+        alternate = this.read_else_short();
         break;
       }
       items.push(this.read_inner_statement());
@@ -86,8 +86,8 @@ module.exports = {
    *
    */
   read_else_short: function() {
-    if (this.expect(":")) this.next();
     const body = this.node("block");
+    if (this.next().expect(":")) this.next();
     const items = [];
     while (this.token != this.EOF && this.token !== this.tok.T_ENDIF) {
       items.push(this.read_inner_statement());

src/parser/statement.js

@@ -196,7 +196,7 @@ module.exports = {
         return this.read_code_block(false);
 
       case this.tok.T_IF:
-        return this.next().read_if();
+        return this.read_if();
 
       case this.tok.T_SWITCH:
         return this.read_switch();
@@ -394,7 +394,7 @@ module.exports = {
    * ```
    */
   read_code_block: function(top) {
-    const result = this.node("block");
+    let result = this.node("block");
     this.expect("{") && this.next();
     const body = top
       ? this.read_top_statements()

test/locationTests.js

@@ -36,20 +36,19 @@ describe("Test offsets", function() {
   });
 
   describe("to comment node", function() {
+    console.log(ast.comments[0].loc);
     it("test line", function() {
       ast.comments[0].loc.start.line.should.be.exactly(1);
-      ast.comments[0].loc.end.line.should.be.exactly(2);
+      ast.comments[0].loc.end.line.should.be.exactly(1);
     });
     it("test column", function() {
       ast.comments[0].loc.start.column.should.be.exactly(0);
-      ast.comments[0].loc.end.column.should.be.exactly(0);
+      ast.comments[0].loc.end.column.should.be.exactly(12);
     });
     it("test offsets", function() {
       ast.comments[0].loc.start.offset.should.be.exactly(0);
-      ast.comments[0].loc.end.offset.should.be.exactly(
-        lines[0].length + 2 // first line + \r\n
-      );
-      ast.comments[0].loc.source.should.be.exactly(lines[0] + "\r\n");
+      ast.comments[0].loc.end.offset.should.be.exactly(lines[0].length);
+      ast.comments[0].loc.source.should.be.exactly(lines[0]);
     });
   });
 
@@ -129,4 +128,14 @@ describe("Test offsets", function() {
       node.loc.source.should.be.exactly("true");
     });
   });
+
+  describe("test block statements", function() {
+    it("test if", function() {
+      const ast = test.parseEval('if(true) {}\n//foo\necho $bar;');
+      ast.children[0].loc.start.line.should.be.exactly(1);
+      ast.children[0].loc.end.line.should.be.exactly(1);
+      ast.children[1].loc.start.line.should.be.exactly(3);
+      ast.children[1].loc.end.line.should.be.exactly(3);
+    });
+  })
 });