vim-patch:7.4.241

Problem:    The string returned by submatch() does not distinguish between a
            NL from a line break and a NL that stands for a NUL character.
Solution:   Add a second argument to return a list. (ZyX)

https://code.google.com/p/vim/source/detail?r=a63d0cd691dc925283815d17d62f4e948d723a59

src/eval.c

@@ -7029,7 +7029,7 @@ static struct fst {
   {"strridx",         2, 3, f_strridx},
   {"strtrans",        1, 1, f_strtrans},
   {"strwidth",        1, 1, f_strwidth},
-  {"submatch",        1, 1, f_submatch},
+  {"submatch",        1, 2, f_submatch},
   {"substitute",      4, 4, f_substitute},
   {"synID",           3, 3, f_synID},
   {"synIDattr",       2, 3, f_synIDattr},
@@ -14441,9 +14441,28 @@ static void f_strtrans(typval_T *argvars, typval_T *rettv)
  */
 static void f_submatch(typval_T *argvars, typval_T *rettv)
 {
-  rettv->v_type = VAR_STRING;
-  rettv->vval.v_string =
-    reg_submatch((int)get_tv_number_chk(&argvars[0], NULL));
+  int error = FALSE;
+  int no = (int)get_tv_number_chk(&argvars[0], &error);
+  if (error) {
+    return;
+  }
+
+  int retList = 0;
+
+  if (argvars[1].v_type != VAR_UNKNOWN) {
+    retList = get_tv_number_chk(&argvars[1], &error);
+    if (error) {
+    return;
+    }
+  }
+
+  if (retList == 0) {
+    rettv->v_type = VAR_STRING;
+    rettv->vval.v_string = reg_submatch(no);
+  } else {
+    rettv->v_type = VAR_LIST;
+    rettv->vval.v_list = reg_submatch_list(no);
+  }
 }
 
 /*

src/regexp.c

@@ -6929,6 +6929,58 @@ char_u *reg_submatch(int no)
   return retval;
 }
 
+// Used for the submatch() function with the optional non-zero argument: get
+// the list of strings from the n'th submatch in allocated memory with NULs
+// represented in NLs.
+// Returns a list of allocated strings.  Returns NULL when not in a ":s"
+// command, for a non-existing submatch and for any error.
+list_T *reg_submatch_list(int no)
+{
+  if (!can_f_submatch || no < 0) {
+    return NULL;
+  }
+
+  linenr_T slnum;
+  linenr_T elnum;
+  list_T *list;
+  char_u *s;
+
+  if (submatch_match == NULL) {
+    slnum = submatch_mmatch->startpos[no].lnum;
+    elnum = submatch_mmatch->endpos[no].lnum;
+    if (slnum < 0 || elnum < 0) {
+      return NULL;
+    }
+
+    colnr_T scol = submatch_mmatch->startpos[no].col;
+    colnr_T ecol = submatch_mmatch->endpos[no].col;
+
+    list = list_alloc();
+
+    s = reg_getline_submatch(slnum) + scol;
+    if (slnum == elnum) {
+      list_append_string(list, s, ecol - scol);
+    } else {
+      list_append_string(list, s, -1);
+      for (int i = 1; i < elnum - slnum; i++) {
+        s = reg_getline_submatch(slnum + i);
+        list_append_string(list, s, -1);
+      }
+      s = reg_getline_submatch(elnum);
+      list_append_string(list, s, ecol);
+    }
+  } else {
+    s = submatch_match->startp[no];
+    if (s == NULL || submatch_match->endp[no] == NULL) {
+      return NULL;
+    }
+    list = list_alloc();
+    list_append_string(list, s, (int)(submatch_match->endp[no] - s));
+  }
+
+  return list;
+}
+
 static regengine_T bt_regengine =
 {
   bt_regcomp,

src/regexp.h

@@ -16,6 +16,7 @@ int vim_regsub_multi(regmmatch_T *rmp, linenr_T lnum, char_u *source,
                              char_u *dest, int copy, int magic,
                              int backslash);
 char_u *reg_submatch(int no);
+list_T *reg_submatch_list(int no);
 regprog_T *vim_regcomp(char_u *expr_arg, int re_flags);
 void vim_regfree(regprog_T *prog);
 int vim_regexec(regmatch_T *rmp, char_u *line, colnr_T col);

src/testdir/test80.in

@@ -117,6 +117,7 @@ STARTTEST
 :set cpo&
 :$put =\"\n\nTEST_5:\"
 :$put =substitute('A123456789', 'A\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)', '\=submatch(0) . submatch(9) . submatch(8) . submatch(7) . submatch(6) . submatch(5) . submatch(4) . submatch(3) . submatch(2) . submatch(1)', '')
+:$put =substitute('A123456789', 'A\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)\(.\)', '\=string([submatch(0, 1), submatch(9, 1), submatch(8, 1), submatch(7, 1), submatch(6, 1), submatch(5, 1), submatch(4, 1), submatch(3, 1), submatch(2, 1), submatch(1, 1)])', '')
 /^TEST_6
 ENDTEST
 
@@ -142,6 +143,7 @@ STARTTEST
 :$put =\"\n\nTEST_7:\"
 :$put =substitute('A
A', 'A.', '\=submatch(0)', '')
 :$put =substitute(\"B\nB\", 'B.', '\=submatch(0)', '')
+:$put =substitute(\"B\nB\", 'B.', '\=string(submatch(0, 1))', '')
 :$put =substitute('-bb', '\zeb', 'a', 'g')
 :$put =substitute('-bb', '\ze', 'c', 'g')
 /^TEST_8

src/testdir/test80.ok

@@ -90,6 +90,7 @@ l
 
 TEST_5:
 A123456789987654321
+[['A123456789'], ['9'], ['8'], ['7'], ['6'], ['5'], ['4'], ['3'], ['2'], ['1']]
 
 
 TEST_6:
@@ -103,6 +104,8 @@ TEST_7:
 A
A
 B
 B
+['B
+']B
 -abab
 c-cbcbc
 

src/version.c

@@ -226,7 +226,7 @@ static int included_patches[] = {
   //244,
   //243,
   //242,
-  //241,
+  241,
   240,
   239,
   //238,