patch 8.0.1031: "text" argument for getqflist() is confusing

Problem:    "text" argument for getqflist() is confusing. (Lcd47)
Solution:   Use "lines" instead. (Yegappan Lakshmanan)

diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index ecb41c4b81519d8715e21241ea5521e0b472b693..b9f3c09b1676dc0073ad581ff7c97492bd0e3fea 100644 (file)
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -4636,14 +4636,13 @@ getqflist([{what}])                                     *getqflist()*
                                |quickfix-ID|; zero means the id for the
                                current list or the list specifed by 'nr'
                        items   quickfix list entries
+                       lines   use 'errorformat' to extract items from a list
+                               of lines and return the resulting entries.
+                               Only a |List| type is accepted.  The current
+                               quickfix list is not modified.
                        nr      get information for this quickfix list; zero
                                means the current quickfix list and '$' means
                                the last quickfix list
-                       text    use 'errorformat' to extract items from the
-                               text and return the resulting entries. The
-                               value can be a string with one line or a list
-                               with multiple lines. The current quickfix list
-                               is not modified.
                        title   get the list title
                        winid   get the |window-ID| (if opened)
                        all     all of the above quickfix properties
@@ -4671,6 +4670,7 @@ getqflist([{what}])                                       *getqflist()*
                Examples: >
                        :echo getqflist({'all': 1})
                        :echo getqflist({'nr': 2, 'title': 1})
+                       :echo getqflist({'lines' : ["F1:10:L10"]})
 <
 
 getreg([{regname} [, 1 [, {list}]]])                   *getreg()*
@@ -7071,13 +7071,12 @@ setqflist({list} [, {action}[, {what}]])                *setqflist()*
                argument is ignored.  The following items can be specified in
                {what}:
                    context     any Vim type can be stored as a context
-                   text        use 'errorformat' to extract items from the
-                               text and add the resulting entries to the
-                               quickfix list {nr}.  The value can be a string
-                               with one line or a list with multiple lines.
                    id          quickfix list identifier |quickfix-ID|
                    items       list of quickfix entries. Same as the {list}
                                argument.
+                   lines       use 'errorformat' to parse a list of lines and
+                               add the resulting entries to the quickfix list
+                               {nr} or {id}.  Only a |List| value is supported.
                    nr          list number in the quickfix stack; zero
                                means the current quickfix list and '$' means
                                the last quickfix list
@@ -7091,8 +7090,9 @@ setqflist({list} [, {action}[, {what}]])          *setqflist()*
                specify the list.
 
                Examples: >
-                       :call setqflist([], 'r', {'title': 'My search'})
-                       :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
+                  :call setqflist([], 'r', {'title': 'My search'})
+                  :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
+                  :call setqflist([], 'a', {'id':myid, 'lines':["F1:10:L10"]})
 <
                Returns zero for success, -1 for failure.
 

diff --git a/src/quickfix.c b/src/quickfix.c
index 1082fbd374f9f3e15b07e660288da74aef8bc0e6..5cbb1519ad28f780195c80effcb6ed261e2dba10 100644 (file)
--- a/src/quickfix.c
+++ b/src/quickfix.c
@@ -4643,15 +4643,13 @@ enum {
  * Parse text from 'di' and return the quickfix list items
  */
     static int
-qf_get_list_from_text(dictitem_T *di, dict_T *retdict)
+qf_get_list_from_lines(dictitem_T *di, dict_T *retdict)
 {
     int                status = FAIL;
     qf_info_T  *qi;
 
-    /* Only string and list values are supported */
-    if ((di->di_tv.v_type == VAR_STRING && di->di_tv.vval.v_string != NULL)
-           || (di->di_tv.v_type == VAR_LIST
-               && di->di_tv.vval.v_list != NULL))
+    /* Only a List value is supported */
+    if (di->di_tv.v_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
     {
        list_T  *l = list_alloc();
 
@@ -4693,8 +4691,8 @@ get_errorlist_properties(win_T *wp, dict_T *what, dict_T *retdict)
     dictitem_T *di;
     int                flags = QF_GETLIST_NONE;
 
-    if ((di = dict_find(what, (char_u *)"text", -1)) != NULL)
-       return qf_get_list_from_text(di, retdict);
+    if ((di = dict_find(what, (char_u *)"lines", -1)) != NULL)
+       return qf_get_list_from_lines(di, retdict);
 
     if (wp != NULL)
        qi = GET_LOC_LIST(wp);
@@ -5053,12 +5051,10 @@ qf_set_properties(qf_info_T *qi, dict_T *what, int action, char_u *title)
        }
     }
 
-    if ((di = dict_find(what, (char_u *)"text", -1)) != NULL)
+    if ((di = dict_find(what, (char_u *)"lines", -1)) != NULL)
     {
-       /* Only string and list values are supported */
-       if ((di->di_tv.v_type == VAR_STRING && di->di_tv.vval.v_string != NULL)
-               || (di->di_tv.v_type == VAR_LIST
-                                            && di->di_tv.vval.v_list != NULL))
+       /* Only a List value is supported */
+       if (di->di_tv.v_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
        {
            if (action == 'r')
                qf_free_items(qi, qf_idx);

diff --git a/src/testdir/test_quickfix.vim b/src/testdir/test_quickfix.vim
index d6b65e339fd2a3e3e858913d05c2aced15b61631..64f1baea2cc5b8e9cbb96b309544cd965f0cadb3 100644 (file)
--- a/src/testdir/test_quickfix.vim
+++ b/src/testdir/test_quickfix.vim
@@ -2299,25 +2299,26 @@ func Xsetexpr_tests(cchar)
   call s:setup_commands(a:cchar)
 
   let t = ["File1:10:Line10", "File1:20:Line20"]
-  call g:Xsetlist([], ' ', {'text' : t})
-  call g:Xsetlist([], 'a', {'text' : "File1:30:Line30"})
+  call g:Xsetlist([], ' ', {'lines' : t})
+  call g:Xsetlist([], 'a', {'lines' : ["File1:30:Line30"]})
 
   let l = g:Xgetlist()
   call assert_equal(3, len(l))
   call assert_equal(20, l[1].lnum)
   call assert_equal('Line30', l[2].text)
-  call g:Xsetlist([], 'r', {'text' : "File2:5:Line5"})
+  call g:Xsetlist([], 'r', {'lines' : ["File2:5:Line5"]})
   let l = g:Xgetlist()
   call assert_equal(1, len(l))
   call assert_equal('Line5', l[0].text)
-  call assert_equal(-1, g:Xsetlist([], 'a', {'text' : 10}))
+  call assert_equal(-1, g:Xsetlist([], 'a', {'lines' : 10}))
+  call assert_equal(-1, g:Xsetlist([], 'a', {'lines' : "F1:10:L10"}))
 
   call g:Xsetlist([], 'f')
   " Add entries to multiple lists
-  call g:Xsetlist([], 'a', {'nr' : 1, 'text' : ["File1:10:Line10"]})
-  call g:Xsetlist([], 'a', {'nr' : 2, 'text' : ["File2:20:Line20"]})
-  call g:Xsetlist([], 'a', {'nr' : 1, 'text' : ["File1:15:Line15"]})
-  call g:Xsetlist([], 'a', {'nr' : 2, 'text' : ["File2:25:Line25"]})
+  call g:Xsetlist([], 'a', {'nr' : 1, 'lines' : ["File1:10:Line10"]})
+  call g:Xsetlist([], 'a', {'nr' : 2, 'lines' : ["File2:20:Line20"]})
+  call g:Xsetlist([], 'a', {'nr' : 1, 'lines' : ["File1:15:Line15"]})
+  call g:Xsetlist([], 'a', {'nr' : 2, 'lines' : ["File2:25:Line25"]})
   call assert_equal('Line15', g:Xgetlist({'nr':1, 'items':1}).items[1].text)
   call assert_equal('Line25', g:Xgetlist({'nr':2, 'items':1}).items[1].text)
 endfunc
@@ -2334,10 +2335,10 @@ func Xmultidirstack_tests(cchar)
   call g:Xsetlist([], 'f')
   Xexpr "" | Xexpr ""
 
-  call g:Xsetlist([], 'a', {'nr' : 1, 'text' : "Entering dir 'Xone/a'"})
-  call g:Xsetlist([], 'a', {'nr' : 2, 'text' : "Entering dir 'Xtwo/a'"})
-  call g:Xsetlist([], 'a', {'nr' : 1, 'text' : "one.txt:3:one one one"})
-  call g:Xsetlist([], 'a', {'nr' : 2, 'text' : "two.txt:5:two two two"})
+  call g:Xsetlist([], 'a', {'nr' : 1, 'lines' : ["Entering dir 'Xone/a'"]})
+  call g:Xsetlist([], 'a', {'nr' : 2, 'lines' : ["Entering dir 'Xtwo/a'"]})
+  call g:Xsetlist([], 'a', {'nr' : 1, 'lines' : ["one.txt:3:one one one"]})
+  call g:Xsetlist([], 'a', {'nr' : 2, 'lines' : ["two.txt:5:two two two"]})
 
   let l1 = g:Xgetlist({'nr':1, 'items':1})
   let l2 = g:Xgetlist({'nr':2, 'items':1})
@@ -2371,10 +2372,10 @@ func Xmultifilestack_tests(cchar)
   call g:Xsetlist([], 'f')
   Xexpr "" | Xexpr ""
 
-  call g:Xsetlist([], 'a', {'nr' : 1, 'text' : "[one.txt]"})
-  call g:Xsetlist([], 'a', {'nr' : 2, 'text' : "[two.txt]"})
-  call g:Xsetlist([], 'a', {'nr' : 1, 'text' : "(3,5) one one one"})
-  call g:Xsetlist([], 'a', {'nr' : 2, 'text' : "(5,9) two two two"})
+  call g:Xsetlist([], 'a', {'nr' : 1, 'lines' : ["[one.txt]"]})
+  call g:Xsetlist([], 'a', {'nr' : 2, 'lines' : ["[two.txt]"]})
+  call g:Xsetlist([], 'a', {'nr' : 1, 'lines' : ["(3,5) one one one"]})
+  call g:Xsetlist([], 'a', {'nr' : 2, 'lines' : ["(5,9) two two two"]})
 
   let l1 = g:Xgetlist({'nr':1, 'items':1})
   let l2 = g:Xgetlist({'nr':2, 'items':1})
@@ -2523,28 +2524,26 @@ endfunc
 
 " Test for getting the quickfix list items from some text without modifying
 " the quickfix stack
-func XgetListFromText(cchar)
+func XgetListFromLines(cchar)
   call s:setup_commands(a:cchar)
   call g:Xsetlist([], 'f')
 
-  let l = g:Xgetlist({'text' : "File1:10:Line10"}).items
-  call assert_equal(1, len(l))
-  call assert_equal('Line10', l[0].text)
-
-  let l = g:Xgetlist({'text' : ["File2:20:Line20", "File2:30:Line30"]}).items
+  let l = g:Xgetlist({'lines' : ["File2:20:Line20", "File2:30:Line30"]}).items
   call assert_equal(2, len(l))
   call assert_equal(30, l[1].lnum)
 
-  call assert_equal({}, g:Xgetlist({'text' : 10}))
-  call assert_equal([], g:Xgetlist({'text' : []}).items)
+  call assert_equal({}, g:Xgetlist({'lines' : 10}))
+  call assert_equal({}, g:Xgetlist({'lines' : 'File1:10:Line10'}))
+  call assert_equal([], g:Xgetlist({'lines' : []}).items)
+  call assert_equal([], g:Xgetlist({'lines' : [10, 20]}).items)
 
   " Make sure that the quickfix stack is not modified
   call assert_equal(0, g:Xgetlist({'nr' : '$'}).nr)
 endfunc
 
-func Test_get_list_from_text()
-  call XgetListFromText('c')
-  call XgetListFromText('l')
+func Test_get_list_from_lines()
+  call XgetListFromLines('c')
+  call XgetListFromLines('l')
 endfunc
 
 " Tests for the quickfix list id
@@ -2567,7 +2566,7 @@ func Xqfid_tests(cchar)
 
   call g:Xsetlist([], 'a', {'id':start_id, 'context':[1,2]})
   call assert_equal([1,2], g:Xgetlist({'nr':1, 'context':1}).context)
-  call g:Xsetlist([], 'a', {'id':start_id+1, 'text':'F1:10:L10'})
+  call g:Xsetlist([], 'a', {'id':start_id+1, 'lines':['F1:10:L10']})
   call assert_equal('L10', g:Xgetlist({'nr':2, 'items':1}).items[0].text)
   call assert_equal(-1, g:Xsetlist([], 'a', {'id':999, 'title':'Vim'}))
   call assert_equal(-1, g:Xsetlist([], 'a', {'id':'abc', 'title':'Vim'}))

diff --git a/src/version.c b/src/version.c
index d5257a7579a7af65e996ec85dd1df6eb7c398c3e..4eff429707aeb0626af37f2baac86d13f5e910b9 100644 (file)
--- a/src/version.c
+++ b/src/version.c
@@ -769,6 +769,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    1031,
 /**/
     1030,
 /**/