add a parenthesis node & implement operators precedence

Author: ichiriac

docs/AST.md

@@ -30,6 +30,7 @@
             -   [Pre](#pre)
             -   [Post](#post)
             -   [Bin](#bin)
+            -   [Parenthesis](#parenthesis)
             -   [Bool](#Bool)
             -   [Unary](#unary)
             -   [Cast](#cast)
@@ -843,6 +844,16 @@ Defines a function parameter
 -   `variadic` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 -   `nullable` **[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 
+# Parenthesis
+
+**Extends Operation**
+
+Parenthesis encapsulation `(... expr ...)`
+
+**Properties**
+
+-   `inner` **[Expression](#expression)** 
+
 # Position
 
 Each Position object consists of a line number (1-indexed) and a column number (0-indexed):

src/ast.js

@@ -36,6 +36,7 @@ var Position = require('./ast/position');
  *       - [Pre](#pre)
  *       - [Post](#post)
  *       - [Bin](#bin)
+ *       - [Parenthesis](#parenthesis)
  *       - [Bool](#Bool)
  *       - [Unary](#unary)
  *       - [Cast](#cast)
@@ -203,6 +204,7 @@ AST.prototype.prepare = function(kind, parser) {
   require('./ast/error'),
   require('./ast/eval'),
   require('./ast/exit'),
+  require('./ast/expression'),
   require('./ast/for'),
   require('./ast/foreach'),
   require('./ast/function'),
@@ -222,9 +224,11 @@ AST.prototype.prepare = function(kind, parser) {
   require('./ast/method'),
   require('./ast/namespace'),
   require('./ast/new'),
+  require('./ast/node'),
   require('./ast/number'),
   require('./ast/offsetlookup'),
   require('./ast/parameter'),
+  require('./ast/parenthesis'),
   require('./ast/post'),
   require('./ast/pre'),
   require('./ast/print'),

src/ast/bin.js

@@ -8,6 +8,16 @@
 var Operation = require('./operation');
 var KIND = 'bin';
 
+// define nodes shifting
+var precedence = {
+  '+': 1,
+  '-': 1,
+  '.': 1,
+  '*': 2,
+  '/': 2,
+  '%': 2
+};
+
 /**
  * Binary operations
  * @constructor Bin
@@ -18,6 +28,20 @@ var KIND = 'bin';
  */
 var Bin = Operation.extends(function Bin(type, left, right, location) {
   Operation.apply(this, [KIND, location]);
+  if (right && right.kind === 'bin') {
+    var lLevel = precedence[type];
+    var rLevel = precedence[right.type];
+    if (lLevel && rLevel && rLevel < lLevel) {
+      // shift precedence
+      var buffer = right.right;
+      right.right = right.left;
+      right.left = left;
+      left = buffer;
+      buffer = right.type;
+      right.type = type;
+      type = buffer;
+    }
+  }
   this.type = type;
   this.left = left;
   this.right = right;

src/ast/parenthesis.js

@@ -0,0 +1,22 @@
+/*!
+ * Copyright (C) 2017 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+var Operation = require('./operation');
+var KIND = 'parenthesis';
+
+/**
+ * Parenthesis encapsulation `(... expr ...)`
+ * @constructor Parenthesis
+ * @extends {Operation}
+ * @property {Expression} inner
+ */
+var Parenthesis = Operation.extends(function Parenthesis(inner, location) {
+  Operation.apply(this, [KIND, location]);
+  this.inner = inner;
+});
+
+module.exports = Parenthesis;

src/parser/expr.js

@@ -120,8 +120,10 @@ module.exports = {
     }
 
     if (this.token === '(') {
+      var node = this.node('parenthesis');
       var expr = this.next().read_expr();
       this.expect(')') && this.next();
+      expr = node(expr);
       // handle dereferencable
       if (this.token === this.tok.T_OBJECT_OPERATOR) {
         return this.recursive_variable_chain_scan(expr, false);

src/parser/statement.js

@@ -251,12 +251,7 @@ module.exports = {
 
       case this.tok.T_ECHO:
         var result = this.node('echo');
-        var withParanthesis = (this.next().token === '(');
-        withParanthesis && this.next();
-        var args = this.read_list(this.read_expr, ',');
-        if (withParanthesis) {
-          this.expect(')') && this.next();
-        }
+        var args = this.next().read_list(this.read_expr, ',');
         this.expectEndOfStatement();
         return result(args);
 

test/astTests.js

@@ -56,7 +56,7 @@ describe('Test AST structure', function() {
   });
   it('test echo, isset, unset, empty', function() {
     var ast = parser.parseEval([
-      'echo(true, $var)',
+      'echo ($expr) ? "ok" : "ko";',
       'print "some text"',
       'isset($foo, $bar)',
       'unset($var)',

test/exprTests.js

@@ -142,7 +142,7 @@ describe('Test expressions', function() {
   it('test exit', function() {
     var ast = parser.parseEval([
       'exit(1);',
-      'exit();',
+      'die();',
       'exit;'
     ].join('\n'));
     ast.children[0].kind.should.be.exactly('exit');
@@ -188,7 +188,7 @@ describe('Test expressions', function() {
       '$a = new $foo();',
       '$a = new class extends foo implements bar { };',
     ].join('\n'), {
-      ast: { debug: false }
+      parser: { debug: false }
     });
     ast.children[0].right.kind.should.be.exactly('new');
     ast.children[0].right.what.kind.should.be.exactly('identifier');
@@ -200,4 +200,32 @@ describe('Test expressions', function() {
     ast.children[2].right.what.kind.should.be.exactly('class');
   });
 
+  it('test nested expressions', function() {
+    var ast = parser.parseEval([
+      '$a = 5 * 2 + 1;', // same as (1 + (5 * 2))
+      '$b = 5 * (2 + 1);',
+    ].join('\n'), {
+      parser: { debug: false }
+    });
+    var aExpr = ast.children[0].right;
+    aExpr.kind.should.be.exactly('bin');
+    aExpr.left.value.should.be.exactly('1');
+    aExpr.type.should.be.exactly('+');
+
+    aExpr.right.left.value.should.be.exactly('5');
+    aExpr.right.type.should.be.exactly('*');
+    aExpr.right.right.value.should.be.exactly('2');
+
+    var bExpr = ast.children[1].right;
+    bExpr.kind.should.be.exactly('bin');
+    bExpr.left.value.should.be.exactly('5');
+    bExpr.type.should.be.exactly('*');
+
+    bExpr.right.kind.should.be.exactly('parenthesis');
+    bExpr.right.inner.left.value.should.be.exactly('2');
+    bExpr.right.inner.type.should.be.exactly('+');
+    bExpr.right.inner.right.value.should.be.exactly('1');
+
+  });
+
 });