Merge pull request #159 from LumaKernel/support-default-args

Support default args

Author: tyru

autoload/vimlparser.vim

@@ -310,6 +310,7 @@ endfunction
 "   node    rest
 "   node[]  list
 "   node[]  rlist
+"   node[]  default_args
 "   node[]  body
 "   string  op
 "   string  str
@@ -319,7 +320,7 @@ endfunction
 " TOPLEVEL .body
 " COMMENT .str
 " EXCMD .ea .str
-" FUNCTION .ea .body .left .rlist .attr .endfunction
+" FUNCTION .ea .body .left .rlist .default_args .attr .endfunction
 " ENDFUNCTION .ea
 " DELFUNCTION .ea .left
 " RETURN .ea .left
@@ -1358,6 +1359,7 @@ function! s:VimLParser.parse_cmd_function() abort
   let node.ea = self.ea
   let node.left = left
   let node.rlist = []
+  let node.default_args = []
   let node.attr = {'range': 0, 'abort': 0, 'dict': 0, 'closure': 0}
   let node.endfunction = s:NIL
   call self.reader.getn(1)
@@ -1379,6 +1381,12 @@ function! s:VimLParser.parse_cmd_function() abort
         let varnode.pos = token.pos
         let varnode.value = token.value
         call add(node.rlist, varnode)
+        if tokenizer.peek().type ==# s:TOKEN_EQ
+          call tokenizer.get()
+          call add(node.default_args, self.parse_expr())
+        elseif len(node.default_args) > 0
+          throw s:Err('E989: Non-default argument follows default argument', varnode.pos)
+        endif
         " XXX: Vim doesn't skip white space before comma.  F(a ,b) => E475
         if s:iswhite(self.reader.p(0)) && tokenizer.peek().type ==# s:TOKEN_COMMA
           throw s:Err('E475: Invalid argument: White space is not allowed before comma', self.reader.getpos())
@@ -4962,14 +4970,25 @@ endfunction
 function! s:Compiler.compile_function(node) abort
   let left = self.compile(a:node.left)
   let rlist = map(a:node.rlist, 'self.compile(v:val)')
-  if !empty(rlist) && rlist[-1] ==# '...'
-    let rlist[-1] = '. ...'
-  endif
-  if empty(rlist)
-    call self.out('(function (%s)', left)
-  else
-    call self.out('(function (%s %s)', left, join(rlist, ' '))
+  let default_args = map(a:node.default_args, 'self.compile(v:val)')
+  if !empty(rlist)
+    let remaining = s:FALSE
+    if rlist[-1] ==# '...'
+      call remove(rlist, -1)
+      let remaining = s:TRUE
+    endif
+    for i in range(len(rlist))
+      if i < len(rlist) - len(default_args)
+        let left .= printf(' %s', rlist[i])
+      else
+        let left .= printf(' (%s %s)', rlist[i], default_args[i + len(default_args) - len(rlist)])
+      endif
+    endfor
+    if remaining
+      let left .= ' . ...'
+    endif
   endif
+  call self.out('(function (%s)', left)
   call self.incindent('  ')
   call self.compile_body(a:node.body)
   call self.out(')')

js/vimlparser.js

@@ -488,6 +488,7 @@ function ExArg() {
 //   node    rest
 //   node[]  list
 //   node[]  rlist
+//   node[]  default_args
 //   node[]  body
 //   string  op
 //   string  str
@@ -497,7 +498,7 @@ function ExArg() {
 // TOPLEVEL .body
 // COMMENT .str
 // EXCMD .ea .str
-// FUNCTION .ea .body .left .rlist .attr .endfunction
+// FUNCTION .ea .body .left .rlist .default_args .attr .endfunction
 // ENDFUNCTION .ea
 // DELFUNCTION .ea .left
 // RETURN .ea .left
@@ -1639,6 +1640,7 @@ VimLParser.prototype.parse_cmd_function = function() {
     node.ea = this.ea;
     node.left = left;
     node.rlist = [];
+    node.default_args = [];
     node.attr = {"range":0, "abort":0, "dict":0, "closure":0};
     node.endfunction = NIL;
     this.reader.getn(1);
@@ -1662,6 +1664,13 @@ VimLParser.prototype.parse_cmd_function = function() {
                 varnode.pos = token.pos;
                 varnode.value = token.value;
                 viml_add(node.rlist, varnode);
+                if (tokenizer.peek().type == TOKEN_EQ) {
+                    tokenizer.get();
+                    viml_add(node.default_args, this.parse_expr());
+                }
+                else if (viml_len(node.default_args) > 0) {
+                    throw Err("E989: Non-default argument follows default argument", varnode.pos);
+                }
                 // XXX: Vim doesn't skip white space before comma.  F(a ,b) => E475
                 if (iswhite(this.reader.p(0)) && tokenizer.peek().type == TOKEN_COMMA) {
                     throw Err("E475: Invalid argument: White space is not allowed before comma", this.reader.getpos());
@@ -4465,15 +4474,28 @@ Compiler.prototype.compile_excmd = function(node) {
 Compiler.prototype.compile_function = function(node) {
     var left = this.compile(node.left);
     var rlist = node.rlist.map((function(vval) { return this.compile(vval); }).bind(this));
-    if (!viml_empty(rlist) && rlist[rlist.length - 1] == "...") {
-        rlist[rlist.length - 1] = ". ...";
-    }
-    if (viml_empty(rlist)) {
-        this.out("(function (%s)", left);
-    }
-    else {
-        this.out("(function (%s %s)", left, viml_join(rlist, " "));
+    var default_args = node.default_args.map((function(vval) { return this.compile(vval); }).bind(this));
+    if (!viml_empty(rlist)) {
+        var remaining = FALSE;
+        if (rlist[rlist.length - 1] == "...") {
+            viml_remove(rlist, -1);
+            var remaining = TRUE;
+        }
+        var __c11 = viml_range(viml_len(rlist));
+        for (var __i11 = 0; __i11 < __c11.length; ++__i11) {
+            var i = __c11[__i11];
+            if (i < viml_len(rlist) - viml_len(default_args)) {
+                left += viml_printf(" %s", rlist[i]);
+            }
+            else {
+                left += viml_printf(" (%s %s)", rlist[i], default_args[i + viml_len(default_args) - viml_len(rlist)]);
+            }
+        }
+        if (remaining) {
+            left += " . ...";
+        }
     }
+    this.out("(function (%s)", left);
     this.incindent("  ");
     this.compile_body(node.body);
     this.out(")");
@@ -4560,9 +4582,9 @@ Compiler.prototype.compile_if = function(node) {
     this.incindent("  ");
     this.compile_body(node.body);
     this.decindent();
-    var __c11 = node.elseif;
-    for (var __i11 = 0; __i11 < __c11.length; ++__i11) {
-        var enode = __c11[__i11];
+    var __c12 = node.elseif;
+    for (var __i12 = 0; __i12 < __c12.length; ++__i12) {
+        var enode = __c12[__i12];
         this.out(" elseif %s", this.compile(enode.cond));
         this.incindent("  ");
         this.compile_body(enode.body);
@@ -4619,9 +4641,9 @@ Compiler.prototype.compile_try = function(node) {
     this.out("(try");
     this.incindent("  ");
     this.compile_body(node.body);
-    var __c12 = node.catch;
-    for (var __i12 = 0; __i12 < __c12.length; ++__i12) {
-        var cnode = __c12[__i12];
+    var __c13 = node.catch;
+    for (var __i13 = 0; __i13 < __c13.length; ++__i13) {
+        var cnode = __c13[__i13];
         if (cnode.pattern !== NIL) {
             this.decindent();
             this.out(" catch /%s/", cnode.pattern);
@@ -5615,9 +5637,9 @@ RegexpParser.prototype.get_token_sq_char_class = function() {
         var r = this.reader.read_alpha();
         if (this.reader.p(0) == ":" && this.reader.p(1) == "]") {
             this.reader.seek_cur(2);
-            var __c13 = class_names;
-            for (var __i13 = 0; __i13 < __c13.length; ++__i13) {
-                var name = __c13[__i13];
+            var __c14 = class_names;
+            for (var __i14 = 0; __i14 < __c14.length; ++__i14) {
+                var name = __c14[__i14];
                 if (r == name) {
                     return "[:" + name + ":]";
                 }
@@ -5750,9 +5772,9 @@ RegexpParser.prototype.getoctchrs = function() {
 
 RegexpParser.prototype.gethexchrs = function(n) {
     var r = "";
-    var __c14 = viml_range(n);
-    for (var __i14 = 0; __i14 < __c14.length; ++__i14) {
-        var i = __c14[__i14];
+    var __c15 = viml_range(n);
+    for (var __i15 = 0; __i15 < __c15.length; ++__i15) {
+        var i = __c15[__i15];
         var c = this.reader.peek();
         if (!isxdigit(c)) {
             break;

py/vimlparser.py

@@ -476,6 +476,7 @@ def ExArg():
 #   node    rest
 #   node[]  list
 #   node[]  rlist
+#   node[]  default_args
 #   node[]  body
 #   string  op
 #   string  str
@@ -485,7 +486,7 @@ def ExArg():
 # TOPLEVEL .body
 # COMMENT .str
 # EXCMD .ea .str
-# FUNCTION .ea .body .left .rlist .attr .endfunction
+# FUNCTION .ea .body .left .rlist .default_args .attr .endfunction
 # ENDFUNCTION .ea
 # DELFUNCTION .ea .left
 # RETURN .ea .left
@@ -1352,6 +1353,7 @@ def parse_cmd_function(self):
         node.ea = self.ea
         node.left = left
         node.rlist = []
+        node.default_args = []
         node.attr = AttributeDict({"range": 0, "abort": 0, "dict": 0, "closure": 0})
         node.endfunction = NIL
         self.reader.getn(1)
@@ -1372,6 +1374,11 @@ def parse_cmd_function(self):
                     varnode.pos = token.pos
                     varnode.value = token.value
                     viml_add(node.rlist, varnode)
+                    if tokenizer.peek().type == TOKEN_EQ:
+                        tokenizer.get()
+                        viml_add(node.default_args, self.parse_expr())
+                    elif viml_len(node.default_args) > 0:
+                        raise VimLParserException(Err("E989: Non-default argument follows default argument", varnode.pos))
                     # XXX: Vim doesn't skip white space before comma.  F(a ,b) => E475
                     if iswhite(self.reader.p(0)) and tokenizer.peek().type == TOKEN_COMMA:
                         raise VimLParserException(Err("E475: Invalid argument: White space is not allowed before comma", self.reader.getpos()))
@@ -3574,12 +3581,20 @@ def compile_excmd(self, node):
     def compile_function(self, node):
         left = self.compile(node.left)
         rlist = [self.compile(vval) for vval in node.rlist]
-        if not viml_empty(rlist) and rlist[-1] == "...":
-            rlist[-1] = ". ..."
-        if viml_empty(rlist):
-            self.out("(function (%s)", left)
-        else:
-            self.out("(function (%s %s)", left, viml_join(rlist, " "))
+        default_args = [self.compile(vval) for vval in node.default_args]
+        if not viml_empty(rlist):
+            remaining = FALSE
+            if rlist[-1] == "...":
+                viml_remove(rlist, -1)
+                remaining = TRUE
+            for i in viml_range(viml_len(rlist)):
+                if i < viml_len(rlist) - viml_len(default_args):
+                    left += viml_printf(" %s", rlist[i])
+                else:
+                    left += viml_printf(" (%s %s)", rlist[i], default_args[i + viml_len(default_args) - viml_len(rlist)])
+            if remaining:
+                left += " . ..."
+        self.out("(function (%s)", left)
         self.incindent("  ")
         self.compile_body(node.body)
         self.out(")")

test/test1.ok

@@ -1,6 +1,10 @@
 ; test1
 (function (s:foo a b . ...)
   (return 0))
+(function (s:bar (a 1) (b 2) . ...)
+  (return 0))
+(function (s:baz a (b 2) . ...)
+  (return 0))
 (if 1
   (echo "if 1")
  elseif 2

test/test1.vim

@@ -2,6 +2,12 @@
 function s:foo(a, b, ...)
   return 0
 endfunction
+function s:bar(a = 1, b = 2, ...)
+  return 0
+endfunction
+function s:baz(a, b = 2, ...)
+  return 0
+endfunction
 if 1
   echo "if 1"
 elseif 2

test/test_err_funcarg_default.ok

@@ -0,0 +1 @@
+vimlparser: E989: Non-default argument follows default argument: line 1 col 21

test/test_err_funcarg_default.vim

@@ -0,0 +1,2 @@
+function Foo(abc=1, xyz)
+endfunction

test/test_funcarg_default.ok

@@ -0,0 +1,2 @@
+(function (X (foo (+ 1 2)))
+  (return a:foo))

test/test_funcarg_default.vim

@@ -0,0 +1,3 @@
+function X(foo=1+2)
+  return a:foo
+endfunction