add try/catch and call nodes

Author: ichiriac

dist/php-parser.js

@@ -2,32 +2,6 @@
 
 # AST
 
-The AST builder class
-
-**Parameters**
-
--   `withPositions`  
--   `withSource`  
-
-**Properties**
-
--   `withPositions` **[Boolean](#boolean)** Should locate any node (by default false)
--   `withSource` **[Boolean](#boolean)** Should extract the node original code (by default false)
-
-## prepare
-
-Prepares an AST node
-
-**Parameters**
-
--   `kind` **([String](#string) | null)** Defines the node type
-    (if null, the kind must be passed at the function call)
--   `parser` **Parser** The parser instance (use for extracting locations)
-
-Returns **[Function](#function)** 
-
-# AST
-
 ## Class hierarchy
 
 -   [Location](#location)
@@ -69,6 +43,9 @@ Returns **[Function](#function)**
         -   [Foreach](#foreach)
         -   [Switch](#switch)
         -   [Goto](#goto)
+        -   [Try](#try)
+        -   [Catch](#catch)
+        -   [Call](#call)
         -   [Block](#block)
             -   [Program](#program)
             -   [Namespace](#namespace)
@@ -109,6 +86,32 @@ Prepares an AST node
 
 Returns **[Function](#function)** 
 
+# AST
+
+The AST builder class
+
+**Parameters**
+
+-   `withPositions`  
+-   `withSource`  
+
+**Properties**
+
+-   `withPositions` **[Boolean](#boolean)** Should locate any node (by default false)
+-   `withSource` **[Boolean](#boolean)** Should extract the node original code (by default false)
+
+## prepare
+
+Prepares an AST node
+
+**Parameters**
+
+-   `kind` **([String](#string) | null)** Defines the node type
+    (if null, the kind must be passed at the function call)
+-   `parser` **Parser** The parser instance (use for extracting locations)
+
+Returns **[Function](#function)** 
+
 # Array
 
 **Extends Expression**
@@ -154,6 +157,16 @@ Defines a boolean value (true/false)
 
 A break statement
 
+# Call
+
+**Extends Statement**
+
+Executes a call statement
+
+**Properties**
+
+-   `arguments` **[Array](#array)<Arguments>** 
+
 # Case
 
 **Extends Node**
@@ -165,6 +178,30 @@ A switch case statement
 -   `test` **([Expression](#expression) | null)** if null, means that the default case
 -   `body` **([Block](#block) | null)** 
 
+# Try
+
+**Extends Statement**
+
+Defines a catch statement
+
+**Properties**
+
+-   `what` **[Array](#array)<[Identifier](#identifier)>** 
+-   `variable` **[Variable](#variable)** 
+-   `body` **[Statement](#statement)** 
+
+# Try
+
+**Extends Statement**
+
+Defines a try statement
+
+**Properties**
+
+-   `body` **[Block](#block)** 
+-   `catches` **[Array](#array)<Catch>** 
+-   `allways` **[Block](#block)** 
+
 # Class
 
 **Extends Declaration**

dist/php-parser.min.js

@@ -620,6 +620,8 @@ Returns **Switch**
          (T_FINALLY '{' inner_statement* '}')?
 ```
 
+Returns **Try** 
+
 # read_short_form
 
 Reads a short form of tokens

dist/php-parser.min.js.map

@@ -49,6 +49,9 @@ var Position = require('./ast/position');
  *     - [Foreach](#foreach)
  *     - [Switch](#switch)
  *     - [Goto](#goto)
+ *     - [Try](#try)
+ *     - [Catch](#catch)
+ *     - [Call](#call)
  *     - [Block](#block)
  *       - [Program](#program)
  *       - [Namespace](#namespace)
@@ -146,7 +149,9 @@ AST.prototype.prepare = function(kind, parser) {
   require('./ast/block'),
   require('./ast/boolean'),
   require('./ast/break'),
+  require('./ast/call'),
   require('./ast/case'),
+  require('./ast/catch'),
   require('./ast/class'),
   require('./ast/classconstant'),
   require('./ast/clone'),
@@ -192,6 +197,7 @@ AST.prototype.prepare = function(kind, parser) {
   require('./ast/traitalias'),
   require('./ast/traitprecedence'),
   require('./ast/traituse'),
+  require('./ast/try'),
   require('./ast/unset'),
   require('./ast/variable'),
   require('./ast/while')

docs/AST.md

@@ -0,0 +1,24 @@
+/*!
+ * Copyright (C) 2017 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+var Statement = require('./statement');
+var KIND = 'call';
+
+/**
+ * Executes a call statement
+ * @constructor Call
+ * @extends {Statement}
+ * @property {Identifier|Variable|??} what
+ * @property {Arguments[]} arguments
+ */
+var Call = Statement.extends(function Call(what, args, location) {
+  Statement.apply(this, [KIND, location]);
+  this.what = what;
+  this.arguments = args;
+});
+
+module.exports = Call;

docs/parser.md

@@ -0,0 +1,27 @@
+/*!
+ * Copyright (C) 2017 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+var Statement = require('./statement');
+var KIND = 'catch';
+
+/**
+ * Defines a catch statement
+ * @constructor Try
+ * @extends {Statement}
+ * @property {Identifier[]} what
+ * @property {Variable} variable
+ * @property {Statement} body
+ * @see http://php.net/manual/en/language.exceptions.php
+ */
+var Catch = Statement.extends(function Catch(body, what, variable, location) {
+  Statement.apply(this, [KIND, location]);
+  this.body = body;
+  this.what = what;
+  this.variable = variable;
+});
+
+module.exports = Catch;

src/ast.js

@@ -0,0 +1,26 @@
+/*!
+ * Copyright (C) 2017 Glayzzle (BSD3 License)
+ * @authors https://github.com/glayzzle/php-parser/graphs/contributors
+ * @url http://glayzzle.com
+ */
+"use strict";
+
+var Statement = require('./statement');
+var KIND = 'try';
+
+/**
+ * Defines a try statement
+ * @constructor Try
+ * @extends {Statement}
+ * @property {Block} body
+ * @property {Catch[]} catches
+ * @property {Block} allways
+ */
+var Try = Statement.extends(function Try(body, catches, always, location) {
+  Statement.apply(this, [KIND, location]);
+  this.body = body;
+  this.catches = catches;
+  this.always = always;
+});
+
+module.exports = Try;

src/ast/call.js

@@ -36,7 +36,7 @@ module.exports = {
       } else if (this.token === '(') {
         // resolve ambuiguity between namespace & function call
         return this.node('call')(
-          ['ns', name.slice(1)]
+          ['ns', name.slice(1)] // @todo
           , this.read_function_argument_list()
         );
       } else {

src/ast/catch.js

@@ -12,32 +12,33 @@ module.exports = {
    *          )*
    *          (T_FINALLY '{' inner_statement* '}')?
    * ```
+   * @see https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L448
+   * @return {Try}
    */
   read_try: function() {
-
-    // @todo implement the short form of declarations
     this.expect(this.tok.T_TRY);
-    var result = this.node('try');
-    var code = this.nextWithComments().read_statement();
-    var allways = false;
-    var catches = [];
-
+    var result = this.node('try'),
+      always = null,
+      body,
+      catches = []
+    ;
+    body = this.nextWithComments().read_statement();
     this.ignoreComments();
+    // https://github.com/php/php-src/blob/master/Zend/zend_language_parser.y#L455
     while(this.token === this.tok.T_CATCH) {
+      var item = this.node('catch'), what = [], variable = null;
       this.next().expect('(') && this.next();
-      var exName = this.read_namespace_name();
-      var varName = this.read_variable(true, false, false);
-      this.expect(')') && this.nextWithComments();
-      catches.push({
-        exception: exName,
-        as: varName,
-        body: this.read_statement()
-      });
+      what = this.read_list(
+        this.read_namespace_name, '|', false
+      );
+      variable = this.read_variable(true, false, false);
+      this.expect(')');
+      catches.push(item(this.next().read_statement(), what, variable));
       this.ignoreComments();
     }
     if (this.token === this.tok.T_FINALLY) {
-      allways = this.nextWithComments().read_statement();
+      always = this.nextWithComments().read_statement();
     }
-    return result(code, catches, allways);
+    return result(body, catches, always);
   }
 };

src/ast/try.js

@@ -97,7 +97,9 @@ module.exports = {
           if (read_only) {
             return result;
           } else {
-            result = ['call', result,  this.read_function_argument_list()];
+            result = this.node('call')(
+              result,  this.read_function_argument_list()
+            );
           }
           break;
         case '[':

src/parser/namespace.js

@@ -16,4 +16,28 @@ describe('Test statements', function() {
     ast.children[2].kind.should.be.exactly('goto');
     ast.children[2].label.should.be.exactly('start');
   });
+  it('test try', function() {
+    var ast = parser.parseEval([
+      'try {',
+      '  foo();',
+      '} catch(FooError|BarError $err) {',
+      '  var_dump($err);',
+      '} finally {',
+      '  clean();',
+      '}'
+    ].join('\n'), {
+      parser: { debug: false }
+    });
+    ast.children[0].kind.should.be.exactly('try');
+    ast.children[0].body.kind.should.be.exactly('block');
+    ast.children[0].body.children[0].kind.should.be.exactly('call');
+    ast.children[0].body.children[0].what.name.should.be.exactly('foo');
+    ast.children[0].catches[0].kind.should.be.exactly('catch');
+    ast.children[0].catches[0].what.length.should.be.exactly(2);
+    ast.children[0].catches[0].what[0].name.should.be.exactly('FooError');
+    ast.children[0].catches[0].what[1].name.should.be.exactly('BarError');
+    ast.children[0].catches[0].variable.kind.should.be.exactly('variable');
+    ast.children[0].catches[0].variable.identifier.should.be.exactly('$err');
+    ast.children[0].always.kind.should.be.exactly('block');
+  });
 });