patch 7.4.1685

Problem:    There is no easy way to get all the information about a match.
Solution:   Add matchstrpos(). (Ozaki Kiichi)

diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 79cf58cf961ac4ff4c06c69c8a46a3ac56b8c1dd..80395ed45ff43af8bb361ea527214d399661b160 100644 (file)
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -2020,6 +2020,8 @@ matchlist( {expr}, {pat}[, {start}[, {count}]])
                                List    match and submatches of {pat} in {expr}
 matchstr( {expr}, {pat}[, {start}[, {count}]])
                                String  {count}'th match of {pat} in {expr}
+matchstrpos( {expr}, {pat}[, {start}[, {count}]])
+                               List    {count}'th match of {pat} in {expr}
 max( {list})                   Number  maximum value of items in {list}
 min( {list})                   Number  minimum value of items in {list}
 mkdir( {name} [, {path} [, {prot}]])
@@ -5204,6 +5206,24 @@ matchstr({expr}, {pat}[, {start}[, {count}]])                    *matchstr()*
                        :echo matchstr("testing", "ing", 5)
 <              result is "".
                When {expr} is a |List| then the matching item is returned.
+               The type isn't changed, it's not necessarily a String.
+
+matchstrpos({expr}, {pat}[, {start}[, {count}]])               *matchstrpos()*
+               Same as |matchstr()|, but return the matched string, the start
+               position and the end position of the match.  Example: >
+                       :echo matchstrpos("testing", "ing")
+<              results in ["ing", 4, 7].
+               When there is no match ["", -1, -1] is returned.
+               The {start}, if given, has the same meaning as for |match()|. >
+                       :echo matchstrpos("testing", "ing", 2)
+<              results in ["ing", 4, 7]. >
+                       :echo matchstrpos("testing", "ing", 5)
+<              result is ["", -1, -1].
+               When {expr} is a |List| then the matching item, the index
+               of first item where {pat} matches, the start position and the
+               end position of the match are returned. >
+                       :echo matchstrpos([1, '__x'], '\a')
+<              result is ["x", 1, 2, 3].
                The type isn't changed, it's not necessarily a String.
 
                                                        *max()*

diff --git a/runtime/doc/usr_41.txt b/runtime/doc/usr_41.txt
index 920be4aabe09931643374db331320bd79c1532bb..140a8ad8885d41f9b2e862131f1fab925ff7f88e 100644 (file)
--- a/runtime/doc/usr_41.txt
+++ b/runtime/doc/usr_41.txt
@@ -592,6 +592,7 @@ String manipulation:                                        *string-functions*
        match()                 position where a pattern matches in a string
        matchend()              position where a pattern match ends in a string
        matchstr()              match of a pattern in a string
+       matchstrpos()           match and postions of a pattern in a string
        matchlist()             like matchstr() and also return submatches
        stridx()                first index of a short string in a long string
        strridx()               last index of a short string in a long string

diff --git a/src/eval.c b/src/eval.c
index 0784215932154c852d5fe242ce0e794831ea543a..9f6db3123b7dd29458ef84777c8646742ce93334 100644 (file)
--- a/src/eval.c
+++ b/src/eval.c
@@ -673,6 +673,7 @@ static void f_matchdelete(typval_T *argvars, typval_T *rettv);
 static void f_matchend(typval_T *argvars, typval_T *rettv);
 static void f_matchlist(typval_T *argvars, typval_T *rettv);
 static void f_matchstr(typval_T *argvars, typval_T *rettv);
+static void f_matchstrpos(typval_T *argvars, typval_T *rettv);
 static void f_max(typval_T *argvars, typval_T *rettv);
 static void f_min(typval_T *argvars, typval_T *rettv);
 #ifdef vim_mkdir
@@ -8383,6 +8384,7 @@ static struct fst
     {"matchend",       2, 4, f_matchend},
     {"matchlist",      2, 4, f_matchlist},
     {"matchstr",       2, 4, f_matchstr},
+    {"matchstrpos",    2, 4, f_matchstrpos},
     {"max",            1, 1, f_max},
     {"min",            1, 1, f_min},
 #ifdef vim_mkdir
@@ -15302,11 +15304,26 @@ find_some_match(typval_T *argvars, typval_T *rettv, int type)
     p_cpo = (char_u *)"";
 
     rettv->vval.v_number = -1;
-    if (type == 3)
+    if (type == 3 || type == 4)
     {
-       /* return empty list when there are no matches */
+       /* type 3: return empty list when there are no matches.
+        * type 4: return ["", -1, -1, -1] */
        if (rettv_list_alloc(rettv) == FAIL)
            goto theend;
+       if (type == 4
+               && (list_append_string(rettv->vval.v_list,
+                                           (char_u *)"", 0) == FAIL
+                   || list_append_number(rettv->vval.v_list,
+                                           (varnumber_T)-1) == FAIL
+                   || list_append_number(rettv->vval.v_list,
+                                           (varnumber_T)-1) == FAIL
+                   || list_append_number(rettv->vval.v_list,
+                                           (varnumber_T)-1) == FAIL))
+       {
+               list_free(rettv->vval.v_list, TRUE);
+               rettv->vval.v_list = NULL;
+               goto theend;
+       }
     }
     else if (type == 2)
     {
@@ -15383,7 +15400,7 @@ find_some_match(typval_T *argvars, typval_T *rettv, int type)
                    break;
                }
                vim_free(tofree);
-               str = echo_string(&li->li_tv, &tofree, strbuf, 0);
+               expr = str = echo_string(&li->li_tv, &tofree, strbuf, 0);
                if (str == NULL)
                    break;
            }
@@ -15420,7 +15437,23 @@ find_some_match(typval_T *argvars, typval_T *rettv, int type)
 
        if (match)
        {
-           if (type == 3)
+           if (type == 4)
+           {
+               listitem_T *li1 = rettv->vval.v_list->lv_first;
+               listitem_T *li2 = li1->li_next;
+               listitem_T *li3 = li2->li_next;
+               listitem_T *li4 = li3->li_next;
+
+               li1->li_tv.vval.v_string = vim_strnsave(regmatch.startp[0],
+                               (int)(regmatch.endp[0] - regmatch.startp[0]));
+               li3->li_tv.vval.v_number =
+                                     (varnumber_T)(regmatch.startp[0] - expr);
+               li4->li_tv.vval.v_number =
+                                       (varnumber_T)(regmatch.endp[0] - expr);
+               if (l != NULL)
+                   li2->li_tv.vval.v_number = (varnumber_T)idx;
+           }
+           else if (type == 3)
            {
                int i;
 
@@ -15465,6 +15498,11 @@ find_some_match(typval_T *argvars, typval_T *rettv, int type)
        vim_regfree(regmatch.regprog);
     }
 
+    if (type == 4 && l == NULL)
+       /* matchstrpos() without a list: drop the second item. */
+       listitem_remove(rettv->vval.v_list,
+                                      rettv->vval.v_list->lv_first->li_next);
+
 theend:
     vim_free(tofree);
     p_cpo = save_cpo;
@@ -15665,6 +15703,15 @@ f_matchstr(typval_T *argvars, typval_T *rettv)
     find_some_match(argvars, rettv, 2);
 }
 
+/*
+ * "matchstrpos()" function
+ */
+    static void
+f_matchstrpos(typval_T *argvars, typval_T *rettv)
+{
+    find_some_match(argvars, rettv, 4);
+}
+
 static void max_min(typval_T *argvars, typval_T *rettv, int domax);
 
     static void

diff --git a/src/testdir/test_alot.vim b/src/testdir/test_alot.vim
index 06309982acb9ae5fe42752904cbe279db235dcab..4ee331ff1c7e27eb4381f056e1663e8412e8c089 100644 (file)
--- a/src/testdir/test_alot.vim
+++ b/src/testdir/test_alot.vim
@@ -15,6 +15,7 @@ source test_glob2regpat.vim
 source test_help_tagjump.vim
 source test_join.vim
 source test_lispwords.vim
+source test_matchstrpos.vim
 source test_menu.vim
 source test_partial.vim
 source test_reltime.vim

diff --git a/src/testdir/test_matchstrpos.vim b/src/testdir/test_matchstrpos.vim
new file mode 100644 (file)
index 0000000..e14765b
--- /dev/null
+++ b/src/testdir/test_matchstrpos.vim
@@ -0,0 +1,13 @@
+" Test matchstrpos
+
+func Test_matchstrpos()
+  call assert_equal(['ing', 4, 7], matchstrpos('testing', 'ing'))
+
+  call assert_equal(['ing', 4, 7], matchstrpos('testing', 'ing', 2))
+
+  call assert_equal(['', -1, -1], matchstrpos('testing', 'ing', 5))
+
+  call assert_equal(['ing', 1, 4, 7], matchstrpos(['vim', 'testing', 'execute'], 'ing'))
+
+  call assert_equal(['', -1, -1, -1], matchstrpos(['vim', 'testing', 'execute'], 'img'))
+endfunc

diff --git a/src/version.c b/src/version.c
index 20d64f20d7490dc262192a4499133d3dcbf1c0fd..1b34431723a5d6d3de5ab887a8d81e067d4c6cb2 100644 (file)
--- a/src/version.c
+++ b/src/version.c
@@ -748,6 +748,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    1685,
 /**/
     1684,
 /**/