Hi,
I am attaching a patch containing the following changes:
1. The quickfix list title set by a user using setqflist() will be
incorrectly prefixed by ":" when replacing a list. A fix for
this bug.
2. Reduce code duplication using the qf_id2nr() function.
3. Rename get_errorlist_properties() to qf_get_properties()
to be consistent with qf_set_properties().
4. Add two additional test cases.
5. Updates to the documentation
- Yegappan
--
--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php
---
You received this message because you are subscribed to the Google Groups
"vim_dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index af43bf28f..d92847866 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -4657,12 +4657,12 @@ getqflist([{what}])
*getqflist()*
If "nr" is not present then the current quickfix list is used.
If both "nr" and a non-zero "id" are specified, then the list
specified by "id" is used.
- To get the number of lists in the quickfix stack, set 'nr' to
- '$' in {what}. The 'nr' value in the returned dictionary
+ To get the number of lists in the quickfix stack, set "nr" to
+ "$" in {what}. The "nr" value in the returned dictionary
contains the quickfix stack size.
- When 'text' is specified, all the other items are ignored. The
- returned dictionary contains the entry 'items' with the list
- of entries.
+ When "lines" is specified, all the other items except "efm"
+ are ignored. The returned dictionary contains the entry
+ "items" with the list of entries.
In case of error processing {what}, an empty dictionary is
returned.
diff --git a/runtime/doc/quickfix.txt b/runtime/doc/quickfix.txt
index e555451b5..72e74c72a 100644
--- a/runtime/doc/quickfix.txt
+++ b/runtime/doc/quickfix.txt
@@ -44,6 +44,13 @@ From inside Vim an easy way to run a command and handle the
output is with the
The 'errorformat' option should be set to match the error messages from your
compiler (see |errorformat| below).
+ *quickfix-ID*
+Each quickfix list has a unique identifier called the quickfix ID and this
+number will not change within a Vim session. The getqflist() function can be
+used to get the identifier assigned to a list. There is also a quickfix list
+number which may change whenever more than ten lists are added to a quickfix
+stack.
+
*location-list* *E776*
A location list is a window-local quickfix list. You get one after commands
like `:lvimgrep`, `:lgrep`, `:lhelpgrep`, `:lmake`, etc., which create a
diff --git a/src/evalfunc.c b/src/evalfunc.c
index ea342b4c6..4a6332b13 100644
--- a/src/evalfunc.c
+++ b/src/evalfunc.c
@@ -4826,7 +4826,7 @@ get_qf_loc_list(int is_qf, win_T *wp, typval_T *what_arg,
typval_T *rettv)
dict_T *d = what_arg->vval.v_dict;
if (d != NULL)
- get_errorlist_properties(wp, d, rettv->vval.v_dict);
+ qf_get_properties(wp, d, rettv->vval.v_dict);
}
else
EMSG(_(e_dictreq));
diff --git a/src/proto/quickfix.pro b/src/proto/quickfix.pro
index ad6ad3433..a801edd0e 100644
--- a/src/proto/quickfix.pro
+++ b/src/proto/quickfix.pro
@@ -22,7 +22,7 @@ void ex_cnext(exarg_T *eap);
void ex_cfile(exarg_T *eap);
void ex_vimgrep(exarg_T *eap);
int get_errorlist(qf_info_T *qi, win_T *wp, int qf_idx, list_T *list);
-int get_errorlist_properties(win_T *wp, dict_T *what, dict_T *retdict);
+int qf_get_properties(win_T *wp, dict_T *what, dict_T *retdict);
int set_errorlist(win_T *wp, list_T *list, int action, char_u *title, dict_T
*what);
int set_ref_in_quickfix(int copyID);
void ex_cbuffer(exarg_T *eap);
diff --git a/src/quickfix.c b/src/quickfix.c
index ee871fc46..096790317 100644
--- a/src/quickfix.c
+++ b/src/quickfix.c
@@ -4691,12 +4691,27 @@ qf_get_list_from_lines(dict_T *what, dictitem_T *di,
dict_T *retdict)
}
/*
+ * Return the quickfix/location list number with the given identifier.
+ * Returns -1 if list is not found.
+ */
+ static int
+qf_id2nr(qf_info_T *qi, int_u qfid)
+{
+ int qf_idx;
+
+ for (qf_idx = 0; qf_idx < qi->qf_listcount; qf_idx++)
+ if (qi->qf_lists[qf_idx].qf_id == qfid)
+ return qf_idx;
+ return -1;
+}
+
+/*
* Return quickfix/location list details (title) as a
* dictionary. 'what' contains the details to return. If 'list_idx' is -1,
* then current list is used. Otherwise the specified list is used.
*/
int
-get_errorlist_properties(win_T *wp, dict_T *what, dict_T *retdict)
+qf_get_properties(win_T *wp, dict_T *what, dict_T *retdict)
{
qf_info_T *qi = &ql_info;
int status = OK;
@@ -4752,12 +4767,8 @@ get_errorlist_properties(win_T *wp, dict_T *what, dict_T
*retdict)
/* For zero, use the current list or the list specifed by 'nr' */
if (di->di_tv.vval.v_number != 0)
{
- for (qf_idx = 0; qf_idx < qi->qf_listcount; qf_idx++)
- {
- if (qi->qf_lists[qf_idx].qf_id == di->di_tv.vval.v_number)
- break;
- }
- if (qf_idx == qi->qf_listcount)
+ qf_idx = qf_id2nr(qi, di->di_tv.vval.v_number);
+ if (qf_idx == -1)
return FAIL; /* List not found */
}
flags |= QF_GETLIST_ID;
@@ -5024,10 +5035,8 @@ qf_set_properties(qf_info_T *qi, dict_T *what, int
action, char_u *title)
/* Use the quickfix/location list with the specified id */
if (di->di_tv.v_type == VAR_NUMBER)
{
- for (qf_idx = 0; qf_idx < qi->qf_listcount; qf_idx++)
- if (qi->qf_lists[qf_idx].qf_id == di->di_tv.vval.v_number)
- break;
- if (qf_idx == qi->qf_listcount)
+ qf_idx = qf_id2nr(qi, di->di_tv.vval.v_number);
+ if (qf_idx == -1)
return FAIL; /* List not found */
}
else
@@ -5062,6 +5071,16 @@ qf_set_properties(qf_info_T *qi, dict_T *what, int
action, char_u *title)
retval = qf_add_entries(qi, qf_idx, di->di_tv.vval.v_list,
title_save, action == ' ' ? 'a' : action);
+ if (action == 'r')
+ {
+ /*
+ * When replacing the quickfix list entries using
+ * qf_add_entries(), the title is set with a ':' prefix.
+ * Restore the title with the saved title.
+ */
+ vim_free(qi->qf_lists[qf_idx].qf_title);
+ qi->qf_lists[qf_idx].qf_title = vim_strsave(title_save);
+ }
vim_free(title_save);
}
}
diff --git a/src/testdir/test_quickfix.vim b/src/testdir/test_quickfix.vim
index 6a8d0e7bf..671381ce1 100644
--- a/src/testdir/test_quickfix.vim
+++ b/src/testdir/test_quickfix.vim
@@ -487,6 +487,19 @@ func s:test_xhelpgrep(cchar)
" This wipes out the buffer, make sure that doesn't cause trouble.
Xclose
+ if a:cchar == 'l'
+ " When a help window is present, running :lhelpgrep should reuse the
+ " help window and not the current window
+ new | only
+ call g:Xsetlist([], 'f')
+ help index.txt
+ wincmd w
+ lhelpgrep quickfix
+ call assert_equal(1, winnr())
+ call assert_notequal([], getloclist(1))
+ call assert_equal([], getloclist(2))
+ endif
+
new | only
" Search for non existing help string
@@ -1684,6 +1697,10 @@ func HistoryTest(cchar)
call assert_equal(' error list 1 of 3; 1 ' . common, res[0])
call assert_equal(' error list 2 of 3; 2 ' . common, res[1])
call assert_equal('> error list 3 of 3; 3 ' . common, res[2])
+
+ call g:Xsetlist([], 'f')
+ let l = split(execute(a:cchar . 'hist'), "\n")
+ call assert_equal('No entries', l[0])
endfunc
func Test_history()
@@ -1862,6 +1879,11 @@ func Xproperty_tests(cchar)
let l = g:Xgetlist({'items':1})
call assert_equal(0, len(l.items))
+ call g:Xsetlist([], 'r', {'title' : 'TestTitle'})
+ call g:Xsetlist([], 'r', {'items' : [{'filename' : 'F1', 'lnum' : 10,
'text' : 'L10'}]})
+ call g:Xsetlist([], 'r', {'items' : [{'filename' : 'F1', 'lnum' : 10,
'text' : 'L10'}]})
+ call assert_equal('TestTitle', g:Xgetlist({'title' : 1}).title)
+
" The following used to crash Vim with address sanitizer
call g:Xsetlist([], 'f')
call g:Xsetlist([], 'a', {'items' : [{'filename':'F1', 'lnum':10}]})
@@ -1904,10 +1926,10 @@ func Xproperty_tests(cchar)
call g:Xsetlist([], 'r', l2)
let newl1=g:Xgetlist({'nr':1,'all':1})
let newl2=g:Xgetlist({'nr':2,'all':1})
- call assert_equal(':Fruits', newl1.title)
+ call assert_equal('Fruits', newl1.title)
call assert_equal(['Fruits'], newl1.context)
call assert_equal('Line20', newl1.items[0].text)
- call assert_equal(':Colors', newl2.title)
+ call assert_equal('Colors', newl2.title)
call assert_equal(['Colors'], newl2.context)
call assert_equal('Line10', newl2.items[0].text)
call g:Xsetlist([], 'f')
