fix glayzzle#45 & add some tests

Author: ichiriac

src/ast/function.js

@@ -14,13 +14,15 @@ var KIND          = 'function';
  * @property {Parameter[]} arguments
  * @property {Identifier} type
  * @property {boolean} byref
+ * @property {boolean} nullable
  * @property {Block|null} body
  */
-var fn = Declaration.extends(function _Function(name, args, byref, type, location) {
+var fn = Declaration.extends(function _Function(name, args, byref, type, nullable, location) {
   Declaration.apply(this, [KIND, name, location]);
   this.arguments = args;
   this.byref = byref;
   this.type = type;
+  this.nullable = nullable;
   this.body = null;
 });
 module.exports = fn;

src/ast/parameter.js

@@ -15,13 +15,15 @@ var KIND = 'parameter';
  * @property {Node|null} value
  * @property {boolean} byref
  * @property {boolean} variadic
+ * @property {boolean} nullable
  */
-var Parameter = Declaration.extends(function Parameter(name, type, value, isRef, isVariadic, location) {
+var Parameter = Declaration.extends(function Parameter(name, type, value, isRef, isVariadic, nullable, location) {
   Declaration.apply(this, [KIND, name, location]);
   this.value = value;
   this.type = type;
   this.byref = isRef;
   this.variadic = isVariadic;
+  this.nullable = nullable;
 });
 
 module.exports = Parameter;

src/parser.js

@@ -183,6 +183,7 @@ parser.prototype.parse = function(code) {
  * Raise an error
  */
 parser.prototype.raiseError = function(message, msgExpect, expect, token) {
+  message += ' on line ' + this.lexer.yylloc.first_line;
   if (!this.suppressErrors) {
     throw new Error(message);
   }
@@ -219,7 +220,7 @@ parser.prototype.error = function(expect) {
   }
   this.token !== this.EOF
   return this.raiseError(
-    msg + ' on line ' + this.lexer.yylloc.first_line,
+    msg,
     msgExpect,
     expect,
     token

src/parser/function.js

@@ -69,7 +69,7 @@ module.exports = {
       this.next();
     }
     var isRef = this.is_reference();
-    var name = false, use = [], returnType = false;
+    var name = false, use = [], returnType = null, nullable = false;
     if (type !== 1) {
       if (this.expect(this.tok.T_STRING)) {
         name = this.text();
@@ -85,13 +85,17 @@ module.exports = {
       if (this.expect(')')) this.next();
     }
     if (this.token === ':') {
-      returnType = this.next().read_type();
+      if (this.next().token === '?') {
+        nullable = true;
+        this.next();
+      }
+      returnType = this.read_type();
     }
     if (type === 1) {
       // closure
-      return result(params, isRef, use, returnType);
+      return result(params, isRef, use, returnType, nullable);
     }
-    return result(name, params, isRef, returnType);
+    return result(name, params, isRef, returnType, nullable);
   }
   /**
    * ```ebnf
@@ -144,8 +148,17 @@ module.exports = {
   ,read_parameter: function() {
     var node = this.node('parameter'),
       name = null,
-      value = null;
-    var type = this.read_type();
+      value = null,
+      type = null,
+      nullable = false;
+    if (this.token === '?') {
+      this.next();
+      nullable = true;
+    }
+    type = this.read_type();
+    if (nullable && !type) {
+      this.raiseError('Expecting a type definition combined with nullable operator');
+    }
     var isRef = this.is_reference();
     var isVariadic = this.is_variadic();
     if (this.expect(this.tok.T_VARIABLE)) {
@@ -155,16 +168,17 @@ module.exports = {
     if (this.token == '=') {
       value = this.next().read_expr();
     }
-    return node(name, type, value, isRef, isVariadic);
+    return node(name, type, value, isRef, isVariadic, nullable);
   }
   /**
+   * Reads a list of arguments
    * ```ebnf
    *  function_argument_list ::= '(' (argument_list (',' argument_list)*)? ')'
    * ```
    */
   ,read_function_argument_list: function() {
     var result = [];
-    if (this.expect('(')) this.next();
+    this.expect('(') && this.next();
     if (this.token !== ')') {
       while(this.token != this.EOF) {
         result.push(this.read_argument_list());
@@ -173,7 +187,7 @@ module.exports = {
         } else break;
       }
     }
-    if (this.expect(')')) this.next();
+    this.expect(')') && this.next();
     return result;
   }
   /**
@@ -194,16 +208,18 @@ module.exports = {
    * ```
    */
   ,read_type: function() {
+    var result = this.node('identifier');
     switch(this.token) {
       case this.tok.T_ARRAY:
         this.next();
-        return ['array'];
+        return result(['', 'array'], false);
+      case this.tok.T_NAMESPACE:
       case this.tok.T_NS_SEPARATOR:
       case this.tok.T_STRING:
         return this.read_namespace_name();
       case this.tok.T_CALLABLE:
         this.next();
-        return ['callable'];
+        return result(['', 'callable'], false);
       default:
         return null;
     }

test/functionTests.js

@@ -1,18 +1,22 @@
 var should = require("should");
 var parser = require('../src/index');
 
-/*describe('Function tests', function() {
+describe('Function tests', function() {
+  var ast = parser.parseEval(
+    'function &foo($a = 1, callable $b, ?array &...$params) : ?boolean {}'
+  );
 
-  it('test variadic', function () {
+  it('test description', function () {
     // Get result from parser
-    var ast = parser.parseEval('function &foo($a = 1, array &...$params) {}');
-    var fn = ast[1][0];
-    fn[0].should.be.exactly('function');
-    fn[1].should.be.exactly('foo');
-
-    var args = fn[2];
-    args.length.should.be.exactly(2);
+    ast.children[0].kind.should.be.exactly('function');
+    ast.children[0].name.should.be.exactly('foo');
+    ast.children[0].byref.should.be.exactly(true);
+    ast.children[0].nullable.should.be.exactly(true);
+    ast.children[0].type.name.should.be.exactly('boolean');
+  });
 
+  it('test arguments', function () {
+    /*
     // 1st param
     var arg1 = args[0];
     arg1[0].should.be.exactly('param');
@@ -31,6 +35,8 @@ var parser = require('../src/index');
     should.equal(arg2[3], null);
     arg2[4].should.be.exactly(true, 'byref');
     arg2[5].should.be.exactly(true, 'variadic');
+    */
   });
 
-});*/
+
+});

test/namespaceTest.js

@@ -29,7 +29,7 @@ describe('Test namespace statements', function() {
   });
 
   var multiNs = parser.parseEval([
-    'namespace foo {',
+    'namespace \\foo {',
     '  $i++;',
     '}',
     'namespace {',