xref: /vim-8.2.3635/src/quickfix.c (revision 2e693a88)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
3  * VIM - Vi IMproved	by Bram Moolenaar
4  *
5  * Do ":help uganda"  in Vim to read copying and usage conditions.
6  * Do ":help credits" in Vim to see a list of people who contributed.
7  * See README.txt for an overview of the Vim source code.
8  */
9 
10 /*
11  * quickfix.c: functions for quickfix mode, using a file with error messages
12  */
13 
14 #include "vim.h"
15 
16 #if defined(FEAT_QUICKFIX) || defined(PROTO)
17 
18 struct dir_stack_T
19 {
20     struct dir_stack_T	*next;
21     char_u		*dirname;
22 };
23 
24 /*
25  * For each error the next struct is allocated and linked in a list.
26  */
27 typedef struct qfline_S qfline_T;
28 struct qfline_S
29 {
30     qfline_T	*qf_next;	// pointer to next error in the list
31     qfline_T	*qf_prev;	// pointer to previous error in the list
32     linenr_T	qf_lnum;	// line number where the error occurred
33     int		qf_fnum;	// file number for the line
34     int		qf_col;		// column where the error occurred
35     int		qf_nr;		// error number
36     char_u	*qf_module;	// module name for this error
37     char_u	*qf_pattern;	// search pattern for the error
38     char_u	*qf_text;	// description of the error
39     char_u	qf_viscol;	// set to TRUE if qf_col is screen column
40     char_u	qf_cleared;	// set to TRUE if line has been deleted
41     char_u	qf_type;	// type of the error (mostly 'E'); 1 for
42 				// :helpgrep
43     char_u	qf_valid;	// valid error message detected
44 };
45 
46 /*
47  * There is a stack of error lists.
48  */
49 #define LISTCOUNT   10
50 #define INVALID_QFIDX (-1)
51 #define INVALID_QFBUFNR (0)
52 
53 /*
54  * Quickfix list type.
55  */
56 typedef enum
57 {
58     QFLT_QUICKFIX, // Quickfix list - global list
59     QFLT_LOCATION, // Location list - per window list
60     QFLT_INTERNAL  // Internal - Temporary list used by getqflist()/getloclist()
61 } qfltype_T;
62 
63 /*
64  * Quickfix/Location list definition
65  * Contains a list of entries (qfline_T). qf_start points to the first entry
66  * and qf_last points to the last entry. qf_count contains the list size.
67  *
68  * Usually the list contains one or more entries. But an empty list can be
69  * created using setqflist()/setloclist() with a title and/or user context
70  * information and entries can be added later using setqflist()/setloclist().
71  */
72 typedef struct qf_list_S
73 {
74     int_u	qf_id;		// Unique identifier for this list
75     qfltype_T	qfl_type;
76     qfline_T	*qf_start;	// pointer to the first error
77     qfline_T	*qf_last;	// pointer to the last error
78     qfline_T	*qf_ptr;	// pointer to the current error
79     int		qf_count;	// number of errors (0 means empty list)
80     int		qf_index;	// current index in the error list
81     int		qf_nonevalid;	// TRUE if not a single valid entry found
82     char_u	*qf_title;	// title derived from the command that created
83 				// the error list or set by setqflist
84     typval_T	*qf_ctx;	// context set by setqflist/setloclist
85 
86     struct dir_stack_T	*qf_dir_stack;
87     char_u		*qf_directory;
88     struct dir_stack_T	*qf_file_stack;
89     char_u		*qf_currfile;
90     int			qf_multiline;
91     int			qf_multiignore;
92     int			qf_multiscan;
93     long		qf_changedtick;
94 } qf_list_T;
95 
96 /*
97  * Quickfix/Location list stack definition
98  * Contains a list of quickfix/location lists (qf_list_T)
99  */
100 struct qf_info_S
101 {
102     // Count of references to this list. Used only for location lists.
103     // When a location list window reference this list, qf_refcount
104     // will be 2. Otherwise, qf_refcount will be 1. When qf_refcount
105     // reaches 0, the list is freed.
106     int		qf_refcount;
107     int		qf_listcount;	    // current number of lists
108     int		qf_curlist;	    // current error list
109     qf_list_T	qf_lists[LISTCOUNT];
110     qfltype_T	qfl_type;	    // type of list
111     int		qf_bufnr;	    // quickfix window buffer number
112 };
113 
114 static qf_info_T ql_info;	// global quickfix list
115 static int_u last_qf_id = 0;	// Last used quickfix list id
116 
117 #define FMT_PATTERNS 11		// maximum number of % recognized
118 
119 /*
120  * Structure used to hold the info of one part of 'errorformat'
121  */
122 typedef struct efm_S efm_T;
123 struct efm_S
124 {
125     regprog_T	    *prog;	// pre-formatted part of 'errorformat'
126     efm_T	    *next;	// pointer to next (NULL if last)
127     char_u	    addr[FMT_PATTERNS]; // indices of used % patterns
128     char_u	    prefix;	// prefix of this format line:
129 				//   'D' enter directory
130 				//   'X' leave directory
131 				//   'A' start of multi-line message
132 				//   'E' error message
133 				//   'W' warning message
134 				//   'I' informational message
135 				//   'C' continuation line
136 				//   'Z' end of multi-line message
137 				//   'G' general, unspecific message
138 				//   'P' push file (partial) message
139 				//   'Q' pop/quit file (partial) message
140 				//   'O' overread (partial) message
141     char_u	    flags;	// additional flags given in prefix
142 				//   '-' do not include this line
143 				//   '+' include whole line in message
144     int		    conthere;	// %> used
145 };
146 
147 // List of location lists to be deleted.
148 // Used to delay the deletion of locations lists by autocmds.
149 typedef struct qf_delq_S
150 {
151     struct qf_delq_S	*next;
152     qf_info_T		*qi;
153 } qf_delq_T;
154 static qf_delq_T *qf_delq_head = NULL;
155 
156 // Counter to prevent autocmds from freeing up location lists when they are
157 // still being used.
158 static int	quickfix_busy = 0;
159 
160 static efm_T	*fmt_start = NULL; // cached across qf_parse_line() calls
161 
162 static void	qf_new_list(qf_info_T *qi, char_u *qf_title);
163 static int	qf_add_entry(qf_list_T *qfl, char_u *dir, char_u *fname, char_u *module, int bufnum, char_u *mesg, long lnum, int col, int vis_col, char_u *pattern, int nr, int type, int valid);
164 static void	qf_free(qf_list_T *qfl);
165 static char_u	*qf_types(int, int);
166 static int	qf_get_fnum(qf_list_T *qfl, char_u *, char_u *);
167 static char_u	*qf_push_dir(char_u *, struct dir_stack_T **, int is_file_stack);
168 static char_u	*qf_pop_dir(struct dir_stack_T **);
169 static char_u	*qf_guess_filepath(qf_list_T *qfl, char_u *);
170 static void	qf_jump_newwin(qf_info_T *qi, int dir, int errornr, int forceit, int newwin);
171 static void	qf_fmt_text(char_u *text, char_u *buf, int bufsize);
172 static int	qf_win_pos_update(qf_info_T *qi, int old_qf_index);
173 static win_T	*qf_find_win(qf_info_T *qi);
174 static buf_T	*qf_find_buf(qf_info_T *qi);
175 static void	qf_update_buffer(qf_info_T *qi, qfline_T *old_last);
176 static void	qf_fill_buffer(qf_list_T *qfl, buf_T *buf, qfline_T *old_last);
177 static buf_T	*load_dummy_buffer(char_u *fname, char_u *dirname_start, char_u *resulting_dir);
178 static void	wipe_dummy_buffer(buf_T *buf, char_u *dirname_start);
179 static void	unload_dummy_buffer(buf_T *buf, char_u *dirname_start);
180 static qf_info_T *ll_get_or_alloc_list(win_T *);
181 static char_u	*e_no_more_items = (char_u *)N_("E553: No more items");
182 
183 // Quickfix window check helper macro
184 #define IS_QF_WINDOW(wp) (bt_quickfix(wp->w_buffer) && wp->w_llist_ref == NULL)
185 // Location list window check helper macro
186 #define IS_LL_WINDOW(wp) (bt_quickfix(wp->w_buffer) && wp->w_llist_ref != NULL)
187 
188 // Quickfix and location list stack check helper macros
189 #define IS_QF_STACK(qi)		(qi->qfl_type == QFLT_QUICKFIX)
190 #define IS_LL_STACK(qi)		(qi->qfl_type == QFLT_LOCATION)
191 #define IS_QF_LIST(qfl)		(qfl->qfl_type == QFLT_QUICKFIX)
192 #define IS_LL_LIST(qfl)		(qfl->qfl_type == QFLT_LOCATION)
193 
194 /*
195  * Return location list for window 'wp'
196  * For location list window, return the referenced location list
197  */
198 #define GET_LOC_LIST(wp) (IS_LL_WINDOW(wp) ? wp->w_llist_ref : wp->w_llist)
199 
200 // Macro to loop through all the items in a quickfix list
201 // Quickfix item index starts from 1, so i below starts at 1
202 #define FOR_ALL_QFL_ITEMS(qfl, qfp, i) \
203 		    for (i = 1, qfp = qfl->qf_start; \
204 			    !got_int && i <= qfl->qf_count && qfp != NULL; \
205 			    ++i, qfp = qfp->qf_next)
206 
207 /*
208  * Looking up a buffer can be slow if there are many.  Remember the last one
209  * to make this a lot faster if there are multiple matches in the same file.
210  */
211 static char_u   *qf_last_bufname = NULL;
212 static bufref_T  qf_last_bufref = {NULL, 0, 0};
213 
214 static char	*e_loc_list_changed =
215 				 N_("E926: Current location list was changed");
216 
217 /*
218  * Maximum number of bytes allowed per line while reading a errorfile.
219  */
220 #define LINE_MAXLEN 4096
221 
222 static struct fmtpattern
223 {
224     char_u	convchar;
225     char	*pattern;
226 } fmt_pat[FMT_PATTERNS] =
227     {
228 	{'f', ".\\+"},	    // only used when at end
229 	{'n', "\\d\\+"},
230 	{'l', "\\d\\+"},
231 	{'c', "\\d\\+"},
232 	{'t', "."},
233 	{'m', ".\\+"},
234 	{'r', ".*"},
235 	{'p', "[- 	.]*"},
236 	{'v', "\\d\\+"},
237 	{'s', ".\\+"},
238 	{'o', ".\\+"}
239     };
240 
241 /*
242  * Convert an errorformat pattern to a regular expression pattern.
243  * See fmt_pat definition above for the list of supported patterns.  The
244  * pattern specifier is supplied in "efmpat".  The converted pattern is stored
245  * in "regpat".  Returns a pointer to the location after the pattern.
246  */
247     static char_u *
248 efmpat_to_regpat(
249 	char_u	*efmpat,
250 	char_u	*regpat,
251 	efm_T	*efminfo,
252 	int	idx,
253 	int	round)
254 {
255     char_u	*srcptr;
256 
257     if (efminfo->addr[idx])
258     {
259 	// Each errorformat pattern can occur only once
260 	semsg(_("E372: Too many %%%c in format string"), *efmpat);
261 	return NULL;
262     }
263     if ((idx && idx < 6
264 		&& vim_strchr((char_u *)"DXOPQ", efminfo->prefix) != NULL)
265 	    || (idx == 6
266 		&& vim_strchr((char_u *)"OPQ", efminfo->prefix) == NULL))
267     {
268 	semsg(_("E373: Unexpected %%%c in format string"), *efmpat);
269 	return NULL;
270     }
271     efminfo->addr[idx] = (char_u)++round;
272     *regpat++ = '\\';
273     *regpat++ = '(';
274 #ifdef BACKSLASH_IN_FILENAME
275     if (*efmpat == 'f')
276     {
277 	// Also match "c:" in the file name, even when
278 	// checking for a colon next: "%f:".
279 	// "\%(\a:\)\="
280 	STRCPY(regpat, "\\%(\\a:\\)\\=");
281 	regpat += 10;
282     }
283 #endif
284     if (*efmpat == 'f' && efmpat[1] != NUL)
285     {
286 	if (efmpat[1] != '\\' && efmpat[1] != '%')
287 	{
288 	    // A file name may contain spaces, but this isn't
289 	    // in "\f".  For "%f:%l:%m" there may be a ":" in
290 	    // the file name.  Use ".\{-1,}x" instead (x is
291 	    // the next character), the requirement that :999:
292 	    // follows should work.
293 	    STRCPY(regpat, ".\\{-1,}");
294 	    regpat += 7;
295 	}
296 	else
297 	{
298 	    // File name followed by '\\' or '%': include as
299 	    // many file name chars as possible.
300 	    STRCPY(regpat, "\\f\\+");
301 	    regpat += 4;
302 	}
303     }
304     else
305     {
306 	srcptr = (char_u *)fmt_pat[idx].pattern;
307 	while ((*regpat = *srcptr++) != NUL)
308 	    ++regpat;
309     }
310     *regpat++ = '\\';
311     *regpat++ = ')';
312 
313     return regpat;
314 }
315 
316 /*
317  * Convert a scanf like format in 'errorformat' to a regular expression.
318  * Returns a pointer to the location after the pattern.
319  */
320     static char_u *
321 scanf_fmt_to_regpat(
322 	char_u	**pefmp,
323 	char_u	*efm,
324 	int	len,
325 	char_u	*regpat)
326 {
327     char_u	*efmp = *pefmp;
328 
329     if (*efmp == '[' || *efmp == '\\')
330     {
331 	if ((*regpat++ = *efmp) == '[')	// %*[^a-z0-9] etc.
332 	{
333 	    if (efmp[1] == '^')
334 		*regpat++ = *++efmp;
335 	    if (efmp < efm + len)
336 	    {
337 		*regpat++ = *++efmp;	    // could be ']'
338 		while (efmp < efm + len
339 			&& (*regpat++ = *++efmp) != ']')
340 		    // skip ;
341 		if (efmp == efm + len)
342 		{
343 		    emsg(_("E374: Missing ] in format string"));
344 		    return NULL;
345 		}
346 	    }
347 	}
348 	else if (efmp < efm + len)	// %*\D, %*\s etc.
349 	    *regpat++ = *++efmp;
350 	*regpat++ = '\\';
351 	*regpat++ = '+';
352     }
353     else
354     {
355 	// TODO: scanf()-like: %*ud, %*3c, %*f, ... ?
356 	semsg(_("E375: Unsupported %%%c in format string"), *efmp);
357 	return NULL;
358     }
359 
360     *pefmp = efmp;
361 
362     return regpat;
363 }
364 
365 /*
366  * Analyze/parse an errorformat prefix.
367  */
368     static char_u *
369 efm_analyze_prefix(char_u *efmp, efm_T *efminfo)
370 {
371     if (vim_strchr((char_u *)"+-", *efmp) != NULL)
372 	efminfo->flags = *efmp++;
373     if (vim_strchr((char_u *)"DXAEWICZGOPQ", *efmp) != NULL)
374 	efminfo->prefix = *efmp;
375     else
376     {
377 	semsg(_("E376: Invalid %%%c in format string prefix"), *efmp);
378 	return NULL;
379     }
380 
381     return efmp;
382 }
383 
384 /*
385  * Converts a 'errorformat' string part in 'efm' to a regular expression
386  * pattern.  The resulting regex pattern is returned in "regpat". Additional
387  * information about the 'erroformat' pattern is returned in "fmt_ptr".
388  * Returns OK or FAIL.
389  */
390     static int
391 efm_to_regpat(
392 	char_u	*efm,
393 	int	len,
394 	efm_T	*fmt_ptr,
395 	char_u	*regpat)
396 {
397     char_u	*ptr;
398     char_u	*efmp;
399     int		round;
400     int		idx = 0;
401 
402     // Build a regexp pattern for a 'errorformat' option part
403     ptr = regpat;
404     *ptr++ = '^';
405     round = 0;
406     for (efmp = efm; efmp < efm + len; ++efmp)
407     {
408 	if (*efmp == '%')
409 	{
410 	    ++efmp;
411 	    for (idx = 0; idx < FMT_PATTERNS; ++idx)
412 		if (fmt_pat[idx].convchar == *efmp)
413 		    break;
414 	    if (idx < FMT_PATTERNS)
415 	    {
416 		ptr = efmpat_to_regpat(efmp, ptr, fmt_ptr, idx, round);
417 		if (ptr == NULL)
418 		    return FAIL;
419 		round++;
420 	    }
421 	    else if (*efmp == '*')
422 	    {
423 		++efmp;
424 		ptr = scanf_fmt_to_regpat(&efmp, efm, len, ptr);
425 		if (ptr == NULL)
426 		    return FAIL;
427 	    }
428 	    else if (vim_strchr((char_u *)"%\\.^$~[", *efmp) != NULL)
429 		*ptr++ = *efmp;		// regexp magic characters
430 	    else if (*efmp == '#')
431 		*ptr++ = '*';
432 	    else if (*efmp == '>')
433 		fmt_ptr->conthere = TRUE;
434 	    else if (efmp == efm + 1)		// analyse prefix
435 	    {
436 		// prefix is allowed only at the beginning of the errorformat
437 		// option part
438 		efmp = efm_analyze_prefix(efmp, fmt_ptr);
439 		if (efmp == NULL)
440 		    return FAIL;
441 	    }
442 	    else
443 	    {
444 		semsg(_("E377: Invalid %%%c in format string"), *efmp);
445 		return FAIL;
446 	    }
447 	}
448 	else			// copy normal character
449 	{
450 	    if (*efmp == '\\' && efmp + 1 < efm + len)
451 		++efmp;
452 	    else if (vim_strchr((char_u *)".*^$~[", *efmp) != NULL)
453 		*ptr++ = '\\';	// escape regexp atoms
454 	    if (*efmp)
455 		*ptr++ = *efmp;
456 	}
457     }
458     *ptr++ = '$';
459     *ptr = NUL;
460 
461     return OK;
462 }
463 
464 /*
465  * Free the 'errorformat' information list
466  */
467     static void
468 free_efm_list(efm_T **efm_first)
469 {
470     efm_T *efm_ptr;
471 
472     for (efm_ptr = *efm_first; efm_ptr != NULL; efm_ptr = *efm_first)
473     {
474 	*efm_first = efm_ptr->next;
475 	vim_regfree(efm_ptr->prog);
476 	vim_free(efm_ptr);
477     }
478     fmt_start = NULL;
479 }
480 
481 /*
482  * Compute the size of the buffer used to convert a 'errorformat' pattern into
483  * a regular expression pattern.
484  */
485     static int
486 efm_regpat_bufsz(char_u *efm)
487 {
488     int sz;
489     int i;
490 
491     sz = (FMT_PATTERNS * 3) + ((int)STRLEN(efm) << 2);
492     for (i = FMT_PATTERNS; i > 0; )
493 	sz += (int)STRLEN(fmt_pat[--i].pattern);
494 #ifdef BACKSLASH_IN_FILENAME
495     sz += 12; // "%f" can become twelve chars longer (see efm_to_regpat)
496 #else
497     sz += 2; // "%f" can become two chars longer
498 #endif
499 
500     return sz;
501 }
502 
503 /*
504  * Return the length of a 'errorformat' option part (separated by ",").
505  */
506     static int
507 efm_option_part_len(char_u *efm)
508 {
509     int len;
510 
511     for (len = 0; efm[len] != NUL && efm[len] != ','; ++len)
512 	if (efm[len] == '\\' && efm[len + 1] != NUL)
513 	    ++len;
514 
515     return len;
516 }
517 
518 /*
519  * Parse the 'errorformat' option. Multiple parts in the 'errorformat' option
520  * are parsed and converted to regular expressions. Returns information about
521  * the parsed 'errorformat' option.
522  */
523     static efm_T *
524 parse_efm_option(char_u *efm)
525 {
526     efm_T	*fmt_ptr = NULL;
527     efm_T	*fmt_first = NULL;
528     efm_T	*fmt_last = NULL;
529     char_u	*fmtstr = NULL;
530     int		len;
531     int		sz;
532 
533     // Each part of the format string is copied and modified from errorformat
534     // to regex prog.  Only a few % characters are allowed.
535 
536     // Get some space to modify the format string into.
537     sz = efm_regpat_bufsz(efm);
538     if ((fmtstr = alloc(sz)) == NULL)
539 	goto parse_efm_error;
540 
541     while (efm[0] != NUL)
542     {
543 	// Allocate a new eformat structure and put it at the end of the list
544 	fmt_ptr = ALLOC_CLEAR_ONE(efm_T);
545 	if (fmt_ptr == NULL)
546 	    goto parse_efm_error;
547 	if (fmt_first == NULL)	    // first one
548 	    fmt_first = fmt_ptr;
549 	else
550 	    fmt_last->next = fmt_ptr;
551 	fmt_last = fmt_ptr;
552 
553 	// Isolate one part in the 'errorformat' option
554 	len = efm_option_part_len(efm);
555 
556 	if (efm_to_regpat(efm, len, fmt_ptr, fmtstr) == FAIL)
557 	    goto parse_efm_error;
558 	if ((fmt_ptr->prog = vim_regcomp(fmtstr, RE_MAGIC + RE_STRING)) == NULL)
559 	    goto parse_efm_error;
560 	// Advance to next part
561 	efm = skip_to_option_part(efm + len);	// skip comma and spaces
562     }
563 
564     if (fmt_first == NULL)	// nothing found
565 	emsg(_("E378: 'errorformat' contains no pattern"));
566 
567     goto parse_efm_end;
568 
569 parse_efm_error:
570     free_efm_list(&fmt_first);
571 
572 parse_efm_end:
573     vim_free(fmtstr);
574 
575     return fmt_first;
576 }
577 
578 enum {
579     QF_FAIL = 0,
580     QF_OK = 1,
581     QF_END_OF_INPUT = 2,
582     QF_NOMEM = 3,
583     QF_IGNORE_LINE = 4,
584     QF_MULTISCAN = 5,
585 };
586 
587 /*
588  * State information used to parse lines and add entries to a quickfix/location
589  * list.
590  */
591 typedef struct {
592     char_u	*linebuf;
593     int		linelen;
594     char_u	*growbuf;
595     int		growbufsiz;
596     FILE	*fd;
597     typval_T	*tv;
598     char_u	*p_str;
599     listitem_T	*p_li;
600     buf_T	*buf;
601     linenr_T	buflnum;
602     linenr_T	lnumlast;
603     vimconv_T	vc;
604 } qfstate_T;
605 
606 /*
607  * Allocate more memory for the line buffer used for parsing lines.
608  */
609     static char_u *
610 qf_grow_linebuf(qfstate_T *state, int newsz)
611 {
612     char_u	*p;
613 
614     // If the line exceeds LINE_MAXLEN exclude the last
615     // byte since it's not a NL character.
616     state->linelen = newsz > LINE_MAXLEN ? LINE_MAXLEN - 1 : newsz;
617     if (state->growbuf == NULL)
618     {
619 	state->growbuf = alloc(state->linelen + 1);
620 	if (state->growbuf == NULL)
621 	    return NULL;
622 	state->growbufsiz = state->linelen;
623     }
624     else if (state->linelen > state->growbufsiz)
625     {
626 	if ((p = vim_realloc(state->growbuf, state->linelen + 1)) == NULL)
627 	    return NULL;
628 	state->growbuf = p;
629 	state->growbufsiz = state->linelen;
630     }
631     return state->growbuf;
632 }
633 
634 /*
635  * Get the next string (separated by newline) from state->p_str.
636  */
637     static int
638 qf_get_next_str_line(qfstate_T *state)
639 {
640     // Get the next line from the supplied string
641     char_u	*p_str = state->p_str;
642     char_u	*p;
643     int		len;
644 
645     if (*p_str == NUL) // Reached the end of the string
646 	return QF_END_OF_INPUT;
647 
648     p = vim_strchr(p_str, '\n');
649     if (p != NULL)
650 	len = (int)(p - p_str) + 1;
651     else
652 	len = (int)STRLEN(p_str);
653 
654     if (len > IOSIZE - 2)
655     {
656 	state->linebuf = qf_grow_linebuf(state, len);
657 	if (state->linebuf == NULL)
658 	    return QF_NOMEM;
659     }
660     else
661     {
662 	state->linebuf = IObuff;
663 	state->linelen = len;
664     }
665     vim_strncpy(state->linebuf, p_str, state->linelen);
666 
667     // Increment using len in order to discard the rest of the
668     // line if it exceeds LINE_MAXLEN.
669     p_str += len;
670     state->p_str = p_str;
671 
672     return QF_OK;
673 }
674 
675 /*
676  * Get the next string from state->p_Li.
677  */
678     static int
679 qf_get_next_list_line(qfstate_T *state)
680 {
681     listitem_T	*p_li = state->p_li;
682     int		len;
683 
684     while (p_li != NULL
685 	    && (p_li->li_tv.v_type != VAR_STRING
686 		|| p_li->li_tv.vval.v_string == NULL))
687 	p_li = p_li->li_next;	// Skip non-string items
688 
689     if (p_li == NULL)		// End of the list
690     {
691 	state->p_li = NULL;
692 	return QF_END_OF_INPUT;
693     }
694 
695     len = (int)STRLEN(p_li->li_tv.vval.v_string);
696     if (len > IOSIZE - 2)
697     {
698 	state->linebuf = qf_grow_linebuf(state, len);
699 	if (state->linebuf == NULL)
700 	    return QF_NOMEM;
701     }
702     else
703     {
704 	state->linebuf = IObuff;
705 	state->linelen = len;
706     }
707 
708     vim_strncpy(state->linebuf, p_li->li_tv.vval.v_string, state->linelen);
709 
710     state->p_li = p_li->li_next;	// next item
711     return QF_OK;
712 }
713 
714 /*
715  * Get the next string from state->buf.
716  */
717     static int
718 qf_get_next_buf_line(qfstate_T *state)
719 {
720     char_u	*p_buf = NULL;
721     int		len;
722 
723     // Get the next line from the supplied buffer
724     if (state->buflnum > state->lnumlast)
725 	return QF_END_OF_INPUT;
726 
727     p_buf = ml_get_buf(state->buf, state->buflnum, FALSE);
728     state->buflnum += 1;
729 
730     len = (int)STRLEN(p_buf);
731     if (len > IOSIZE - 2)
732     {
733 	state->linebuf = qf_grow_linebuf(state, len);
734 	if (state->linebuf == NULL)
735 	    return QF_NOMEM;
736     }
737     else
738     {
739 	state->linebuf = IObuff;
740 	state->linelen = len;
741     }
742     vim_strncpy(state->linebuf, p_buf, state->linelen);
743 
744     return QF_OK;
745 }
746 
747 /*
748  * Get the next string from file state->fd.
749  */
750     static int
751 qf_get_next_file_line(qfstate_T *state)
752 {
753     int	    discard;
754     int	    growbuflen;
755 
756     if (fgets((char *)IObuff, IOSIZE, state->fd) == NULL)
757 	return QF_END_OF_INPUT;
758 
759     discard = FALSE;
760     state->linelen = (int)STRLEN(IObuff);
761     if (state->linelen == IOSIZE - 1 && !(IObuff[state->linelen - 1] == '\n'))
762     {
763 	// The current line exceeds IObuff, continue reading using
764 	// growbuf until EOL or LINE_MAXLEN bytes is read.
765 	if (state->growbuf == NULL)
766 	{
767 	    state->growbufsiz = 2 * (IOSIZE - 1);
768 	    state->growbuf = alloc(state->growbufsiz);
769 	    if (state->growbuf == NULL)
770 		return QF_NOMEM;
771 	}
772 
773 	// Copy the read part of the line, excluding null-terminator
774 	memcpy(state->growbuf, IObuff, IOSIZE - 1);
775 	growbuflen = state->linelen;
776 
777 	for (;;)
778 	{
779 	    char_u	*p;
780 
781 	    if (fgets((char *)state->growbuf + growbuflen,
782 			state->growbufsiz - growbuflen, state->fd) == NULL)
783 		break;
784 	    state->linelen = (int)STRLEN(state->growbuf + growbuflen);
785 	    growbuflen += state->linelen;
786 	    if ((state->growbuf)[growbuflen - 1] == '\n')
787 		break;
788 	    if (state->growbufsiz == LINE_MAXLEN)
789 	    {
790 		discard = TRUE;
791 		break;
792 	    }
793 
794 	    state->growbufsiz = 2 * state->growbufsiz < LINE_MAXLEN
795 		? 2 * state->growbufsiz : LINE_MAXLEN;
796 	    if ((p = vim_realloc(state->growbuf, state->growbufsiz)) == NULL)
797 		return QF_NOMEM;
798 	    state->growbuf = p;
799 	}
800 
801 	while (discard)
802 	{
803 	    // The current line is longer than LINE_MAXLEN, continue
804 	    // reading but discard everything until EOL or EOF is
805 	    // reached.
806 	    if (fgets((char *)IObuff, IOSIZE, state->fd) == NULL
807 		    || (int)STRLEN(IObuff) < IOSIZE - 1
808 		    || IObuff[IOSIZE - 1] == '\n')
809 		break;
810 	}
811 
812 	state->linebuf = state->growbuf;
813 	state->linelen = growbuflen;
814     }
815     else
816 	state->linebuf = IObuff;
817 
818     // Convert a line if it contains a non-ASCII character.
819     if (state->vc.vc_type != CONV_NONE && has_non_ascii(state->linebuf))
820     {
821 	char_u	*line;
822 
823 	line = string_convert(&state->vc, state->linebuf, &state->linelen);
824 	if (line != NULL)
825 	{
826 	    if (state->linelen < IOSIZE)
827 	    {
828 		STRCPY(state->linebuf, line);
829 		vim_free(line);
830 	    }
831 	    else
832 	    {
833 		vim_free(state->growbuf);
834 		state->linebuf = state->growbuf = line;
835 		state->growbufsiz = state->linelen < LINE_MAXLEN
836 						? state->linelen : LINE_MAXLEN;
837 	    }
838 	}
839     }
840 
841     return QF_OK;
842 }
843 
844 /*
845  * Get the next string from a file/buffer/list/string.
846  */
847     static int
848 qf_get_nextline(qfstate_T *state)
849 {
850     int status = QF_FAIL;
851 
852     if (state->fd == NULL)
853     {
854 	if (state->tv != NULL)
855 	{
856 	    if (state->tv->v_type == VAR_STRING)
857 		// Get the next line from the supplied string
858 		status = qf_get_next_str_line(state);
859 	    else if (state->tv->v_type == VAR_LIST)
860 		// Get the next line from the supplied list
861 		status = qf_get_next_list_line(state);
862 	}
863 	else
864 	    // Get the next line from the supplied buffer
865 	    status = qf_get_next_buf_line(state);
866     }
867     else
868 	// Get the next line from the supplied file
869 	status = qf_get_next_file_line(state);
870 
871     if (status != QF_OK)
872 	return status;
873 
874     // remove newline/CR from the line
875     if (state->linelen > 0 && state->linebuf[state->linelen - 1] == '\n')
876     {
877 	state->linebuf[state->linelen - 1] = NUL;
878 #ifdef USE_CRNL
879 	if (state->linelen > 1 && state->linebuf[state->linelen - 2] == '\r')
880 	    state->linebuf[state->linelen - 2] = NUL;
881 #endif
882     }
883 
884     remove_bom(state->linebuf);
885 
886     return QF_OK;
887 }
888 
889 typedef struct {
890     char_u	*namebuf;
891     char_u	*module;
892     char_u	*errmsg;
893     int		errmsglen;
894     long	lnum;
895     int		col;
896     char_u	use_viscol;
897     char_u	*pattern;
898     int		enr;
899     int		type;
900     int		valid;
901 } qffields_T;
902 
903 /*
904  * Parse the match for filename ('%f') pattern in regmatch.
905  * Return the matched value in "fields->namebuf".
906  */
907     static int
908 qf_parse_fmt_f(regmatch_T *rmp, int midx, qffields_T *fields, int prefix)
909 {
910     int c;
911 
912     if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
913 	return QF_FAIL;
914 
915     // Expand ~/file and $HOME/file to full path.
916     c = *rmp->endp[midx];
917     *rmp->endp[midx] = NUL;
918     expand_env(rmp->startp[midx], fields->namebuf, CMDBUFFSIZE);
919     *rmp->endp[midx] = c;
920 
921     // For separate filename patterns (%O, %P and %Q), the specified file
922     // should exist.
923     if (vim_strchr((char_u *)"OPQ", prefix) != NULL
924 	    && mch_getperm(fields->namebuf) == -1)
925 	return QF_FAIL;
926 
927     return QF_OK;
928 }
929 
930 /*
931  * Parse the match for error number ('%n') pattern in regmatch.
932  * Return the matched value in "fields->enr".
933  */
934     static int
935 qf_parse_fmt_n(regmatch_T *rmp, int midx, qffields_T *fields)
936 {
937     if (rmp->startp[midx] == NULL)
938 	return QF_FAIL;
939     fields->enr = (int)atol((char *)rmp->startp[midx]);
940     return QF_OK;
941 }
942 
943 /*
944  * Parse the match for line number (%l') pattern in regmatch.
945  * Return the matched value in "fields->lnum".
946  */
947     static int
948 qf_parse_fmt_l(regmatch_T *rmp, int midx, qffields_T *fields)
949 {
950     if (rmp->startp[midx] == NULL)
951 	return QF_FAIL;
952     fields->lnum = atol((char *)rmp->startp[midx]);
953     return QF_OK;
954 }
955 
956 /*
957  * Parse the match for column number ('%c') pattern in regmatch.
958  * Return the matched value in "fields->col".
959  */
960     static int
961 qf_parse_fmt_c(regmatch_T *rmp, int midx, qffields_T *fields)
962 {
963     if (rmp->startp[midx] == NULL)
964 	return QF_FAIL;
965     fields->col = (int)atol((char *)rmp->startp[midx]);
966     return QF_OK;
967 }
968 
969 /*
970  * Parse the match for error type ('%t') pattern in regmatch.
971  * Return the matched value in "fields->type".
972  */
973     static int
974 qf_parse_fmt_t(regmatch_T *rmp, int midx, qffields_T *fields)
975 {
976     if (rmp->startp[midx] == NULL)
977 	return QF_FAIL;
978     fields->type = *rmp->startp[midx];
979     return QF_OK;
980 }
981 
982 /*
983  * Parse the match for '%+' format pattern. The whole matching line is included
984  * in the error string.  Return the matched line in "fields->errmsg".
985  */
986     static int
987 qf_parse_fmt_plus(char_u *linebuf, int linelen, qffields_T *fields)
988 {
989     char_u	*p;
990 
991     if (linelen >= fields->errmsglen)
992     {
993 	// linelen + null terminator
994 	if ((p = vim_realloc(fields->errmsg, linelen + 1)) == NULL)
995 	    return QF_NOMEM;
996 	fields->errmsg = p;
997 	fields->errmsglen = linelen + 1;
998     }
999     vim_strncpy(fields->errmsg, linebuf, linelen);
1000     return QF_OK;
1001 }
1002 
1003 /*
1004  * Parse the match for error message ('%m') pattern in regmatch.
1005  * Return the matched value in "fields->errmsg".
1006  */
1007     static int
1008 qf_parse_fmt_m(regmatch_T *rmp, int midx, qffields_T *fields)
1009 {
1010     char_u	*p;
1011     int		len;
1012 
1013     if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
1014 	return QF_FAIL;
1015     len = (int)(rmp->endp[midx] - rmp->startp[midx]);
1016     if (len >= fields->errmsglen)
1017     {
1018 	// len + null terminator
1019 	if ((p = vim_realloc(fields->errmsg, len + 1)) == NULL)
1020 	    return QF_NOMEM;
1021 	fields->errmsg = p;
1022 	fields->errmsglen = len + 1;
1023     }
1024     vim_strncpy(fields->errmsg, rmp->startp[midx], len);
1025     return QF_OK;
1026 }
1027 
1028 /*
1029  * Parse the match for rest of a single-line file message ('%r') pattern.
1030  * Return the matched value in "tail".
1031  */
1032     static int
1033 qf_parse_fmt_r(regmatch_T *rmp, int midx, char_u **tail)
1034 {
1035     if (rmp->startp[midx] == NULL)
1036 	return QF_FAIL;
1037     *tail = rmp->startp[midx];
1038     return QF_OK;
1039 }
1040 
1041 /*
1042  * Parse the match for the pointer line ('%p') pattern in regmatch.
1043  * Return the matched value in "fields->col".
1044  */
1045     static int
1046 qf_parse_fmt_p(regmatch_T *rmp, int midx, qffields_T *fields)
1047 {
1048     char_u	*match_ptr;
1049 
1050     if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
1051 	return QF_FAIL;
1052     fields->col = 0;
1053     for (match_ptr = rmp->startp[midx]; match_ptr != rmp->endp[midx];
1054 								++match_ptr)
1055     {
1056 	++fields->col;
1057 	if (*match_ptr == TAB)
1058 	{
1059 	    fields->col += 7;
1060 	    fields->col -= fields->col % 8;
1061 	}
1062     }
1063     ++fields->col;
1064     fields->use_viscol = TRUE;
1065     return QF_OK;
1066 }
1067 
1068 /*
1069  * Parse the match for the virtual column number ('%v') pattern in regmatch.
1070  * Return the matched value in "fields->col".
1071  */
1072     static int
1073 qf_parse_fmt_v(regmatch_T *rmp, int midx, qffields_T *fields)
1074 {
1075     if (rmp->startp[midx] == NULL)
1076 	return QF_FAIL;
1077     fields->col = (int)atol((char *)rmp->startp[midx]);
1078     fields->use_viscol = TRUE;
1079     return QF_OK;
1080 }
1081 
1082 /*
1083  * Parse the match for the search text ('%s') pattern in regmatch.
1084  * Return the matched value in "fields->pattern".
1085  */
1086     static int
1087 qf_parse_fmt_s(regmatch_T *rmp, int midx, qffields_T *fields)
1088 {
1089     int		len;
1090 
1091     if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
1092 	return QF_FAIL;
1093     len = (int)(rmp->endp[midx] - rmp->startp[midx]);
1094     if (len > CMDBUFFSIZE - 5)
1095 	len = CMDBUFFSIZE - 5;
1096     STRCPY(fields->pattern, "^\\V");
1097     STRNCAT(fields->pattern, rmp->startp[midx], len);
1098     fields->pattern[len + 3] = '\\';
1099     fields->pattern[len + 4] = '$';
1100     fields->pattern[len + 5] = NUL;
1101     return QF_OK;
1102 }
1103 
1104 /*
1105  * Parse the match for the module ('%o') pattern in regmatch.
1106  * Return the matched value in "fields->module".
1107  */
1108     static int
1109 qf_parse_fmt_o(regmatch_T *rmp, int midx, qffields_T *fields)
1110 {
1111     int		len;
1112 
1113     if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
1114 	return QF_FAIL;
1115     len = (int)(rmp->endp[midx] - rmp->startp[midx]);
1116     if (len > CMDBUFFSIZE)
1117 	len = CMDBUFFSIZE;
1118     STRNCAT(fields->module, rmp->startp[midx], len);
1119     return QF_OK;
1120 }
1121 
1122 /*
1123  * 'errorformat' format pattern parser functions.
1124  * The '%f' and '%r' formats are parsed differently from other formats.
1125  * See qf_parse_match() for details.
1126  */
1127 static int (*qf_parse_fmt[FMT_PATTERNS])(regmatch_T *, int, qffields_T *) =
1128 {
1129     NULL,
1130     qf_parse_fmt_n,
1131     qf_parse_fmt_l,
1132     qf_parse_fmt_c,
1133     qf_parse_fmt_t,
1134     qf_parse_fmt_m,
1135     NULL,
1136     qf_parse_fmt_p,
1137     qf_parse_fmt_v,
1138     qf_parse_fmt_s,
1139     qf_parse_fmt_o
1140 };
1141 
1142 /*
1143  * Parse the error format pattern matches in "regmatch" and set the values in
1144  * "fields".  fmt_ptr contains the 'efm' format specifiers/prefixes that have a
1145  * match.  Returns QF_OK if all the matches are successfully parsed. On
1146  * failure, returns QF_FAIL or QF_NOMEM.
1147  */
1148     static int
1149 qf_parse_match(
1150 	char_u		*linebuf,
1151 	int		linelen,
1152 	efm_T		*fmt_ptr,
1153 	regmatch_T	*regmatch,
1154 	qffields_T	*fields,
1155 	int		qf_multiline,
1156 	int		qf_multiscan,
1157 	char_u		**tail)
1158 {
1159     int		idx = fmt_ptr->prefix;
1160     int		i;
1161     int		midx;
1162     int		status;
1163 
1164     if ((idx == 'C' || idx == 'Z') && !qf_multiline)
1165 	return QF_FAIL;
1166     if (vim_strchr((char_u *)"EWI", idx) != NULL)
1167 	fields->type = idx;
1168     else
1169 	fields->type = 0;
1170 
1171     // Extract error message data from matched line.
1172     // We check for an actual submatch, because "\[" and "\]" in
1173     // the 'errorformat' may cause the wrong submatch to be used.
1174     for (i = 0; i < FMT_PATTERNS; i++)
1175     {
1176 	status = QF_OK;
1177 	midx = (int)fmt_ptr->addr[i];
1178 	if (i == 0 && midx > 0)				// %f
1179 	    status = qf_parse_fmt_f(regmatch, midx, fields, idx);
1180 	else if (i == 5)
1181 	{
1182 	    if (fmt_ptr->flags == '+' && !qf_multiscan)	// %+
1183 		status = qf_parse_fmt_plus(linebuf, linelen, fields);
1184 	    else if (midx > 0)				// %m
1185 		status = qf_parse_fmt_m(regmatch, midx, fields);
1186 	}
1187 	else if (i == 6 && midx > 0)			// %r
1188 	    status = qf_parse_fmt_r(regmatch, midx, tail);
1189 	else if (midx > 0)				// others
1190 	    status = (qf_parse_fmt[i])(regmatch, midx, fields);
1191 
1192 	if (status != QF_OK)
1193 	    return status;
1194     }
1195 
1196     return QF_OK;
1197 }
1198 
1199 /*
1200  * Parse an error line in 'linebuf' using a single error format string in
1201  * 'fmt_ptr->prog' and return the matching values in 'fields'.
1202  * Returns QF_OK if the efm format matches completely and the fields are
1203  * successfully copied. Otherwise returns QF_FAIL or QF_NOMEM.
1204  */
1205     static int
1206 qf_parse_get_fields(
1207 	char_u		*linebuf,
1208 	int		linelen,
1209 	efm_T		*fmt_ptr,
1210 	qffields_T	*fields,
1211 	int		qf_multiline,
1212 	int		qf_multiscan,
1213 	char_u		**tail)
1214 {
1215     regmatch_T	regmatch;
1216     int		status = QF_FAIL;
1217     int		r;
1218 
1219     if (qf_multiscan &&
1220 		vim_strchr((char_u *)"OPQ", fmt_ptr->prefix) == NULL)
1221 	return QF_FAIL;
1222 
1223     fields->namebuf[0] = NUL;
1224     fields->module[0] = NUL;
1225     fields->pattern[0] = NUL;
1226     if (!qf_multiscan)
1227 	fields->errmsg[0] = NUL;
1228     fields->lnum = 0;
1229     fields->col = 0;
1230     fields->use_viscol = FALSE;
1231     fields->enr = -1;
1232     fields->type = 0;
1233     *tail = NULL;
1234 
1235     // Always ignore case when looking for a matching error.
1236     regmatch.rm_ic = TRUE;
1237     regmatch.regprog = fmt_ptr->prog;
1238     r = vim_regexec(&regmatch, linebuf, (colnr_T)0);
1239     fmt_ptr->prog = regmatch.regprog;
1240     if (r)
1241 	status = qf_parse_match(linebuf, linelen, fmt_ptr, &regmatch,
1242 		fields, qf_multiline, qf_multiscan, tail);
1243 
1244     return status;
1245 }
1246 
1247 /*
1248  * Parse directory error format prefixes (%D and %X).
1249  * Push and pop directories from the directory stack when scanning directory
1250  * names.
1251  */
1252     static int
1253 qf_parse_dir_pfx(int idx, qffields_T *fields, qf_list_T *qfl)
1254 {
1255     if (idx == 'D')				// enter directory
1256     {
1257 	if (*fields->namebuf == NUL)
1258 	{
1259 	    emsg(_("E379: Missing or empty directory name"));
1260 	    return QF_FAIL;
1261 	}
1262 	qfl->qf_directory =
1263 	    qf_push_dir(fields->namebuf, &qfl->qf_dir_stack, FALSE);
1264 	if (qfl->qf_directory == NULL)
1265 	    return QF_FAIL;
1266     }
1267     else if (idx == 'X')			// leave directory
1268 	qfl->qf_directory = qf_pop_dir(&qfl->qf_dir_stack);
1269 
1270     return QF_OK;
1271 }
1272 
1273 /*
1274  * Parse global file name error format prefixes (%O, %P and %Q).
1275  */
1276     static int
1277 qf_parse_file_pfx(
1278 	int idx,
1279 	qffields_T *fields,
1280 	qf_list_T *qfl,
1281 	char_u *tail)
1282 {
1283     fields->valid = FALSE;
1284     if (*fields->namebuf == NUL || mch_getperm(fields->namebuf) >= 0)
1285     {
1286 	if (*fields->namebuf && idx == 'P')
1287 	    qfl->qf_currfile =
1288 		qf_push_dir(fields->namebuf, &qfl->qf_file_stack, TRUE);
1289 	else if (idx == 'Q')
1290 	    qfl->qf_currfile = qf_pop_dir(&qfl->qf_file_stack);
1291 	*fields->namebuf = NUL;
1292 	if (tail && *tail)
1293 	{
1294 	    STRMOVE(IObuff, skipwhite(tail));
1295 	    qfl->qf_multiscan = TRUE;
1296 	    return QF_MULTISCAN;
1297 	}
1298     }
1299 
1300     return QF_OK;
1301 }
1302 
1303 /*
1304  * Parse a non-error line (a line which doesn't match any of the error
1305  * format in 'efm').
1306  */
1307     static int
1308 qf_parse_line_nomatch(char_u *linebuf, int linelen, qffields_T *fields)
1309 {
1310     char_u	*p;
1311 
1312     fields->namebuf[0] = NUL;	// no match found, remove file name
1313     fields->lnum = 0;		// don't jump to this line
1314     fields->valid = FALSE;
1315     if (linelen >= fields->errmsglen)
1316     {
1317 	// linelen + null terminator
1318 	if ((p = vim_realloc(fields->errmsg, linelen + 1)) == NULL)
1319 	    return QF_NOMEM;
1320 	fields->errmsg = p;
1321 	fields->errmsglen = linelen + 1;
1322     }
1323     // copy whole line to error message
1324     vim_strncpy(fields->errmsg, linebuf, linelen);
1325 
1326     return QF_OK;
1327 }
1328 
1329 /*
1330  * Parse multi-line error format prefixes (%C and %Z)
1331  */
1332     static int
1333 qf_parse_multiline_pfx(
1334 	int idx,
1335 	qf_list_T *qfl,
1336 	qffields_T *fields)
1337 {
1338     char_u		*ptr;
1339     int			len;
1340 
1341     if (!qfl->qf_multiignore)
1342     {
1343 	qfline_T *qfprev = qfl->qf_last;
1344 
1345 	if (qfprev == NULL)
1346 	    return QF_FAIL;
1347 	if (*fields->errmsg && !qfl->qf_multiignore)
1348 	{
1349 	    len = (int)STRLEN(qfprev->qf_text);
1350 	    if ((ptr = alloc(len + STRLEN(fields->errmsg) + 2))
1351 		    == NULL)
1352 		return QF_FAIL;
1353 	    STRCPY(ptr, qfprev->qf_text);
1354 	    vim_free(qfprev->qf_text);
1355 	    qfprev->qf_text = ptr;
1356 	    *(ptr += len) = '\n';
1357 	    STRCPY(++ptr, fields->errmsg);
1358 	}
1359 	if (qfprev->qf_nr == -1)
1360 	    qfprev->qf_nr = fields->enr;
1361 	if (vim_isprintc(fields->type) && !qfprev->qf_type)
1362 	    // only printable chars allowed
1363 	    qfprev->qf_type = fields->type;
1364 
1365 	if (!qfprev->qf_lnum)
1366 	    qfprev->qf_lnum = fields->lnum;
1367 	if (!qfprev->qf_col)
1368 	    qfprev->qf_col = fields->col;
1369 	qfprev->qf_viscol = fields->use_viscol;
1370 	if (!qfprev->qf_fnum)
1371 	    qfprev->qf_fnum = qf_get_fnum(qfl,
1372 		    qfl->qf_directory,
1373 		    *fields->namebuf || qfl->qf_directory != NULL
1374 		    ? fields->namebuf
1375 		    : qfl->qf_currfile != NULL && fields->valid
1376 		    ? qfl->qf_currfile : 0);
1377     }
1378     if (idx == 'Z')
1379 	qfl->qf_multiline = qfl->qf_multiignore = FALSE;
1380     line_breakcheck();
1381 
1382     return QF_IGNORE_LINE;
1383 }
1384 
1385 /*
1386  * Parse a line and get the quickfix fields.
1387  * Return the QF_ status.
1388  */
1389     static int
1390 qf_parse_line(
1391 	qf_list_T	*qfl,
1392 	char_u		*linebuf,
1393 	int		linelen,
1394 	efm_T		*fmt_first,
1395 	qffields_T	*fields)
1396 {
1397     efm_T		*fmt_ptr;
1398     int			idx = 0;
1399     char_u		*tail = NULL;
1400     int			status;
1401 
1402 restofline:
1403     // If there was no %> item start at the first pattern
1404     if (fmt_start == NULL)
1405 	fmt_ptr = fmt_first;
1406     else
1407     {
1408 	// Otherwise start from the last used pattern
1409 	fmt_ptr = fmt_start;
1410 	fmt_start = NULL;
1411     }
1412 
1413     // Try to match each part of 'errorformat' until we find a complete
1414     // match or no match.
1415     fields->valid = TRUE;
1416     for ( ; fmt_ptr != NULL; fmt_ptr = fmt_ptr->next)
1417     {
1418 	idx = fmt_ptr->prefix;
1419 	status = qf_parse_get_fields(linebuf, linelen, fmt_ptr, fields,
1420 				qfl->qf_multiline, qfl->qf_multiscan, &tail);
1421 	if (status == QF_NOMEM)
1422 	    return status;
1423 	if (status == QF_OK)
1424 	    break;
1425     }
1426     qfl->qf_multiscan = FALSE;
1427 
1428     if (fmt_ptr == NULL || idx == 'D' || idx == 'X')
1429     {
1430 	if (fmt_ptr != NULL)
1431 	{
1432 	    // 'D' and 'X' directory specifiers
1433 	    status = qf_parse_dir_pfx(idx, fields, qfl);
1434 	    if (status != QF_OK)
1435 		return status;
1436 	}
1437 
1438 	status = qf_parse_line_nomatch(linebuf, linelen, fields);
1439 	if (status != QF_OK)
1440 	    return status;
1441 
1442 	if (fmt_ptr == NULL)
1443 	    qfl->qf_multiline = qfl->qf_multiignore = FALSE;
1444     }
1445     else if (fmt_ptr != NULL)
1446     {
1447 	// honor %> item
1448 	if (fmt_ptr->conthere)
1449 	    fmt_start = fmt_ptr;
1450 
1451 	if (vim_strchr((char_u *)"AEWI", idx) != NULL)
1452 	{
1453 	    qfl->qf_multiline = TRUE;	// start of a multi-line message
1454 	    qfl->qf_multiignore = FALSE;// reset continuation
1455 	}
1456 	else if (vim_strchr((char_u *)"CZ", idx) != NULL)
1457 	{				// continuation of multi-line msg
1458 	    status = qf_parse_multiline_pfx(idx, qfl, fields);
1459 	    if (status != QF_OK)
1460 		return status;
1461 	}
1462 	else if (vim_strchr((char_u *)"OPQ", idx) != NULL)
1463 	{				// global file names
1464 	    status = qf_parse_file_pfx(idx, fields, qfl, tail);
1465 	    if (status == QF_MULTISCAN)
1466 		goto restofline;
1467 	}
1468 	if (fmt_ptr->flags == '-')	// generally exclude this line
1469 	{
1470 	    if (qfl->qf_multiline)
1471 		// also exclude continuation lines
1472 		qfl->qf_multiignore = TRUE;
1473 	    return QF_IGNORE_LINE;
1474 	}
1475     }
1476 
1477     return QF_OK;
1478 }
1479 
1480 /*
1481  * Returns TRUE if the specified quickfix/location stack is empty
1482  */
1483     static int
1484 qf_stack_empty(qf_info_T *qi)
1485 {
1486     return qi == NULL || qi->qf_listcount <= 0;
1487 }
1488 
1489 /*
1490  * Returns TRUE if the specified quickfix/location list is empty.
1491  */
1492     static int
1493 qf_list_empty(qf_list_T *qfl)
1494 {
1495     return qfl == NULL || qfl->qf_count <= 0;
1496 }
1497 
1498 /*
1499  * Returns TRUE if the specified quickfix/location list is not empty and
1500  * has valid entries.
1501  */
1502     static int
1503 qf_list_has_valid_entries(qf_list_T *qfl)
1504 {
1505     return !qf_list_empty(qfl) && !qfl->qf_nonevalid;
1506 }
1507 
1508 /*
1509  * Return a pointer to a list in the specified quickfix stack
1510  */
1511     static qf_list_T *
1512 qf_get_list(qf_info_T *qi, int idx)
1513 {
1514     return &qi->qf_lists[idx];
1515 }
1516 
1517 /*
1518  * Allocate the fields used for parsing lines and populating a quickfix list.
1519  */
1520     static int
1521 qf_alloc_fields(qffields_T *pfields)
1522 {
1523     pfields->namebuf = alloc_id(CMDBUFFSIZE + 1, aid_qf_namebuf);
1524     pfields->module = alloc_id(CMDBUFFSIZE + 1, aid_qf_module);
1525     pfields->errmsglen = CMDBUFFSIZE + 1;
1526     pfields->errmsg = alloc_id(pfields->errmsglen, aid_qf_errmsg);
1527     pfields->pattern = alloc_id(CMDBUFFSIZE + 1, aid_qf_pattern);
1528     if (pfields->namebuf == NULL || pfields->errmsg == NULL
1529 		|| pfields->pattern == NULL || pfields->module == NULL)
1530 	return FAIL;
1531 
1532     return OK;
1533 }
1534 
1535 /*
1536  * Free the fields used for parsing lines and populating a quickfix list.
1537  */
1538     static void
1539 qf_free_fields(qffields_T *pfields)
1540 {
1541     vim_free(pfields->namebuf);
1542     vim_free(pfields->module);
1543     vim_free(pfields->errmsg);
1544     vim_free(pfields->pattern);
1545 }
1546 
1547 /*
1548  * Setup the state information used for parsing lines and populating a
1549  * quickfix list.
1550  */
1551     static int
1552 qf_setup_state(
1553 	qfstate_T	*pstate,
1554 	char_u		*enc,
1555 	char_u		*efile,
1556 	typval_T	*tv,
1557 	buf_T		*buf,
1558 	linenr_T	lnumfirst,
1559 	linenr_T	lnumlast)
1560 {
1561     pstate->vc.vc_type = CONV_NONE;
1562     if (enc != NULL && *enc != NUL)
1563 	convert_setup(&pstate->vc, enc, p_enc);
1564 
1565     if (efile != NULL && (pstate->fd = mch_fopen((char *)efile, "r")) == NULL)
1566     {
1567 	semsg(_(e_openerrf), efile);
1568 	return FAIL;
1569     }
1570 
1571     if (tv != NULL)
1572     {
1573 	if (tv->v_type == VAR_STRING)
1574 	    pstate->p_str = tv->vval.v_string;
1575 	else if (tv->v_type == VAR_LIST)
1576 	    pstate->p_li = tv->vval.v_list->lv_first;
1577 	pstate->tv = tv;
1578     }
1579     pstate->buf = buf;
1580     pstate->buflnum = lnumfirst;
1581     pstate->lnumlast = lnumlast;
1582 
1583     return OK;
1584 }
1585 
1586 /*
1587  * Cleanup the state information used for parsing lines and populating a
1588  * quickfix list.
1589  */
1590     static void
1591 qf_cleanup_state(qfstate_T *pstate)
1592 {
1593     if (pstate->fd != NULL)
1594 	fclose(pstate->fd);
1595 
1596     vim_free(pstate->growbuf);
1597     if (pstate->vc.vc_type != CONV_NONE)
1598 	convert_setup(&pstate->vc, NULL, NULL);
1599 }
1600 
1601 /*
1602  * Process the next line from a file/buffer/list/string and add it
1603  * to the quickfix list 'qfl'.
1604  */
1605     static int
1606 qf_init_process_nextline(
1607 	qf_list_T	*qfl,
1608 	efm_T		*fmt_first,
1609 	qfstate_T	*state,
1610 	qffields_T	*fields)
1611 {
1612     int		    status;
1613 
1614     // Get the next line from a file/buffer/list/string
1615     status = qf_get_nextline(state);
1616     if (status != QF_OK)
1617 	return status;
1618 
1619     status = qf_parse_line(qfl, state->linebuf, state->linelen,
1620 	    fmt_first, fields);
1621     if (status != QF_OK)
1622 	return status;
1623 
1624     return qf_add_entry(qfl,
1625 		qfl->qf_directory,
1626 		(*fields->namebuf || qfl->qf_directory != NULL)
1627 		? fields->namebuf
1628 		: ((qfl->qf_currfile != NULL && fields->valid)
1629 		    ? qfl->qf_currfile : (char_u *)NULL),
1630 		fields->module,
1631 		0,
1632 		fields->errmsg,
1633 		fields->lnum,
1634 		fields->col,
1635 		fields->use_viscol,
1636 		fields->pattern,
1637 		fields->enr,
1638 		fields->type,
1639 		fields->valid);
1640 }
1641 
1642 /*
1643  * Read the errorfile "efile" into memory, line by line, building the error
1644  * list.
1645  * Alternative: when "efile" is NULL read errors from buffer "buf".
1646  * Alternative: when "tv" is not NULL get errors from the string or list.
1647  * Always use 'errorformat' from "buf" if there is a local value.
1648  * Then "lnumfirst" and "lnumlast" specify the range of lines to use.
1649  * Set the title of the list to "qf_title".
1650  * Return -1 for error, number of errors for success.
1651  */
1652     static int
1653 qf_init_ext(
1654     qf_info_T	    *qi,
1655     int		    qf_idx,
1656     char_u	    *efile,
1657     buf_T	    *buf,
1658     typval_T	    *tv,
1659     char_u	    *errorformat,
1660     int		    newlist,		// TRUE: start a new error list
1661     linenr_T	    lnumfirst,		// first line number to use
1662     linenr_T	    lnumlast,		// last line number to use
1663     char_u	    *qf_title,
1664     char_u	    *enc)
1665 {
1666     qf_list_T	    *qfl;
1667     qfstate_T	    state;
1668     qffields_T	    fields;
1669     qfline_T	    *old_last = NULL;
1670     int		    adding = FALSE;
1671     static efm_T    *fmt_first = NULL;
1672     char_u	    *efm;
1673     static char_u   *last_efm = NULL;
1674     int		    retval = -1;	// default: return error flag
1675     int		    status;
1676 
1677     // Do not used the cached buffer, it may have been wiped out.
1678     VIM_CLEAR(qf_last_bufname);
1679 
1680     vim_memset(&state, 0, sizeof(state));
1681     vim_memset(&fields, 0, sizeof(fields));
1682     if ((qf_alloc_fields(&fields) == FAIL) ||
1683 		(qf_setup_state(&state, enc, efile, tv, buf,
1684 					lnumfirst, lnumlast) == FAIL))
1685 	goto qf_init_end;
1686 
1687     if (newlist || qf_idx == qi->qf_listcount)
1688     {
1689 	// make place for a new list
1690 	qf_new_list(qi, qf_title);
1691 	qf_idx = qi->qf_curlist;
1692 	qfl = qf_get_list(qi, qf_idx);
1693     }
1694     else
1695     {
1696 	// Adding to existing list, use last entry.
1697 	adding = TRUE;
1698 	qfl = qf_get_list(qi, qf_idx);
1699 	if (!qf_list_empty(qfl))
1700 	    old_last = qfl->qf_last;
1701     }
1702 
1703     // Use the local value of 'errorformat' if it's set.
1704     if (errorformat == p_efm && tv == NULL && *buf->b_p_efm != NUL)
1705 	efm = buf->b_p_efm;
1706     else
1707 	efm = errorformat;
1708 
1709     // If the errorformat didn't change between calls, then reuse the
1710     // previously parsed values.
1711     if (last_efm == NULL || (STRCMP(last_efm, efm) != 0))
1712     {
1713 	// free the previously parsed data
1714 	VIM_CLEAR(last_efm);
1715 	free_efm_list(&fmt_first);
1716 
1717 	// parse the current 'efm'
1718 	fmt_first = parse_efm_option(efm);
1719 	if (fmt_first != NULL)
1720 	    last_efm = vim_strsave(efm);
1721     }
1722 
1723     if (fmt_first == NULL)	// nothing found
1724 	goto error2;
1725 
1726     // got_int is reset here, because it was probably set when killing the
1727     // ":make" command, but we still want to read the errorfile then.
1728     got_int = FALSE;
1729 
1730     // Read the lines in the error file one by one.
1731     // Try to recognize one of the error formats in each line.
1732     while (!got_int)
1733     {
1734 	status = qf_init_process_nextline(qfl, fmt_first, &state, &fields);
1735 	if (status == QF_NOMEM)		// memory alloc failure
1736 	    goto qf_init_end;
1737 	if (status == QF_END_OF_INPUT)	// end of input
1738 	    break;
1739 	if (status == QF_FAIL)
1740 	    goto error2;
1741 
1742 	line_breakcheck();
1743     }
1744     if (state.fd == NULL || !ferror(state.fd))
1745     {
1746 	if (qfl->qf_index == 0)
1747 	{
1748 	    // no valid entry found
1749 	    qfl->qf_ptr = qfl->qf_start;
1750 	    qfl->qf_index = 1;
1751 	    qfl->qf_nonevalid = TRUE;
1752 	}
1753 	else
1754 	{
1755 	    qfl->qf_nonevalid = FALSE;
1756 	    if (qfl->qf_ptr == NULL)
1757 		qfl->qf_ptr = qfl->qf_start;
1758 	}
1759 	// return number of matches
1760 	retval = qfl->qf_count;
1761 	goto qf_init_end;
1762     }
1763     emsg(_(e_readerrf));
1764 error2:
1765     if (!adding)
1766     {
1767 	// Error when creating a new list. Free the new list
1768 	qf_free(qfl);
1769 	qi->qf_listcount--;
1770 	if (qi->qf_curlist > 0)
1771 	    --qi->qf_curlist;
1772     }
1773 qf_init_end:
1774     if (qf_idx == qi->qf_curlist)
1775 	qf_update_buffer(qi, old_last);
1776     qf_cleanup_state(&state);
1777     qf_free_fields(&fields);
1778 
1779     return retval;
1780 }
1781 
1782 /*
1783  * Read the errorfile "efile" into memory, line by line, building the error
1784  * list. Set the error list's title to qf_title.
1785  * Return -1 for error, number of errors for success.
1786  */
1787     int
1788 qf_init(win_T	    *wp,
1789 	char_u	    *efile,
1790 	char_u	    *errorformat,
1791 	int	    newlist,		// TRUE: start a new error list
1792 	char_u	    *qf_title,
1793 	char_u	    *enc)
1794 {
1795     qf_info_T	    *qi = &ql_info;
1796 
1797     if (wp != NULL)
1798     {
1799 	qi = ll_get_or_alloc_list(wp);
1800 	if (qi == NULL)
1801 	    return FAIL;
1802     }
1803 
1804     return qf_init_ext(qi, qi->qf_curlist, efile, curbuf, NULL, errorformat,
1805 	    newlist, (linenr_T)0, (linenr_T)0, qf_title, enc);
1806 }
1807 
1808 /*
1809  * Set the title of the specified quickfix list. Frees the previous title.
1810  * Prepends ':' to the title.
1811  */
1812     static void
1813 qf_store_title(qf_list_T *qfl, char_u *title)
1814 {
1815     VIM_CLEAR(qfl->qf_title);
1816 
1817     if (title != NULL)
1818     {
1819 	char_u *p = alloc(STRLEN(title) + 2);
1820 
1821 	qfl->qf_title = p;
1822 	if (p != NULL)
1823 	    STRCPY(p, title);
1824     }
1825 }
1826 
1827 /*
1828  * The title of a quickfix/location list is set, by default, to the command
1829  * that created the quickfix list with the ":" prefix.
1830  * Create a quickfix list title string by prepending ":" to a user command.
1831  * Returns a pointer to a static buffer with the title.
1832  */
1833     static char_u *
1834 qf_cmdtitle(char_u *cmd)
1835 {
1836     static char_u qftitle_str[IOSIZE];
1837 
1838     vim_snprintf((char *)qftitle_str, IOSIZE, ":%s", (char *)cmd);
1839     return qftitle_str;
1840 }
1841 
1842 /*
1843  * Return a pointer to the current list in the specified quickfix stack
1844  */
1845     static qf_list_T *
1846 qf_get_curlist(qf_info_T *qi)
1847 {
1848     return qf_get_list(qi, qi->qf_curlist);
1849 }
1850 
1851 /*
1852  * Prepare for adding a new quickfix list. If the current list is in the
1853  * middle of the stack, then all the following lists are freed and then
1854  * the new list is added.
1855  */
1856     static void
1857 qf_new_list(qf_info_T *qi, char_u *qf_title)
1858 {
1859     int		i;
1860     qf_list_T	*qfl;
1861 
1862     // If the current entry is not the last entry, delete entries beyond
1863     // the current entry.  This makes it possible to browse in a tree-like
1864     // way with ":grep'.
1865     while (qi->qf_listcount > qi->qf_curlist + 1)
1866 	qf_free(&qi->qf_lists[--qi->qf_listcount]);
1867 
1868     // When the stack is full, remove to oldest entry
1869     // Otherwise, add a new entry.
1870     if (qi->qf_listcount == LISTCOUNT)
1871     {
1872 	qf_free(&qi->qf_lists[0]);
1873 	for (i = 1; i < LISTCOUNT; ++i)
1874 	    qi->qf_lists[i - 1] = qi->qf_lists[i];
1875 	qi->qf_curlist = LISTCOUNT - 1;
1876     }
1877     else
1878 	qi->qf_curlist = qi->qf_listcount++;
1879     qfl = qf_get_curlist(qi);
1880     vim_memset(qfl, 0, (size_t)(sizeof(qf_list_T)));
1881     qf_store_title(qfl, qf_title);
1882     qfl->qfl_type = qi->qfl_type;
1883     qfl->qf_id = ++last_qf_id;
1884 }
1885 
1886 /*
1887  * Queue location list stack delete request.
1888  */
1889     static void
1890 locstack_queue_delreq(qf_info_T *qi)
1891 {
1892     qf_delq_T	*q;
1893 
1894     q = ALLOC_ONE(qf_delq_T);
1895     if (q != NULL)
1896     {
1897 	q->qi = qi;
1898 	q->next = qf_delq_head;
1899 	qf_delq_head = q;
1900     }
1901 }
1902 
1903 /*
1904  * Return the global quickfix stack window buffer number.
1905  */
1906     int
1907 qf_stack_get_bufnr(void)
1908 {
1909     return ql_info.qf_bufnr;
1910 }
1911 
1912 /*
1913  * Wipe the quickfix window buffer (if present) for the specified
1914  * quickfix/location list.
1915  */
1916     static void
1917 wipe_qf_buffer(qf_info_T *qi)
1918 {
1919     buf_T	*qfbuf;
1920 
1921     if (qi->qf_bufnr != INVALID_QFBUFNR)
1922     {
1923 	qfbuf = buflist_findnr(qi->qf_bufnr);
1924 	if (qfbuf != NULL && qfbuf->b_nwindows == 0)
1925 	{
1926 	    // If the quickfix buffer is not loaded in any window, then
1927 	    // wipe the buffer.
1928 	    close_buffer(NULL, qfbuf, DOBUF_WIPE, FALSE);
1929 	    qi->qf_bufnr = INVALID_QFBUFNR;
1930 	}
1931     }
1932 }
1933 
1934 /*
1935  * Free a location list stack
1936  */
1937     static void
1938 ll_free_all(qf_info_T **pqi)
1939 {
1940     int		i;
1941     qf_info_T	*qi;
1942 
1943     qi = *pqi;
1944     if (qi == NULL)
1945 	return;
1946     *pqi = NULL;	// Remove reference to this list
1947 
1948     // If the location list is still in use, then queue the delete request
1949     // to be processed later.
1950     if (quickfix_busy > 0)
1951     {
1952 	locstack_queue_delreq(qi);
1953 	return;
1954     }
1955 
1956     qi->qf_refcount--;
1957     if (qi->qf_refcount < 1)
1958     {
1959 	// No references to this location list.
1960 	// If the quickfix window buffer is loaded, then wipe it
1961 	wipe_qf_buffer(qi);
1962 
1963 	for (i = 0; i < qi->qf_listcount; ++i)
1964 	    qf_free(qf_get_list(qi, i));
1965 	vim_free(qi);
1966     }
1967 }
1968 
1969 /*
1970  * Free all the quickfix/location lists in the stack.
1971  */
1972     void
1973 qf_free_all(win_T *wp)
1974 {
1975     int		i;
1976     qf_info_T	*qi = &ql_info;
1977 
1978     if (wp != NULL)
1979     {
1980 	// location list
1981 	ll_free_all(&wp->w_llist);
1982 	ll_free_all(&wp->w_llist_ref);
1983     }
1984     else
1985 	// quickfix list
1986 	for (i = 0; i < qi->qf_listcount; ++i)
1987 	    qf_free(qf_get_list(qi, i));
1988 }
1989 
1990 /*
1991  * Delay freeing of location list stacks when the quickfix code is running.
1992  * Used to avoid problems with autocmds freeing location list stacks when the
1993  * quickfix code is still referencing the stack.
1994  * Must always call decr_quickfix_busy() exactly once after this.
1995  */
1996     static void
1997 incr_quickfix_busy(void)
1998 {
1999     quickfix_busy++;
2000 }
2001 
2002 /*
2003  * Safe to free location list stacks. Process any delayed delete requests.
2004  */
2005     static void
2006 decr_quickfix_busy(void)
2007 {
2008     if (--quickfix_busy == 0)
2009     {
2010 	// No longer referencing the location lists. Process all the pending
2011 	// delete requests.
2012 	while (qf_delq_head != NULL)
2013 	{
2014 	    qf_delq_T	*q = qf_delq_head;
2015 
2016 	    qf_delq_head = q->next;
2017 	    ll_free_all(&q->qi);
2018 	    vim_free(q);
2019 	}
2020     }
2021 #ifdef ABORT_ON_INTERNAL_ERROR
2022     if (quickfix_busy < 0)
2023     {
2024 	emsg("quickfix_busy has become negative");
2025 	abort();
2026     }
2027 #endif
2028 }
2029 
2030 #if defined(EXITFREE) || defined(PROTO)
2031     void
2032 check_quickfix_busy(void)
2033 {
2034     if (quickfix_busy != 0)
2035     {
2036 	semsg("quickfix_busy not zero on exit: %ld", (long)quickfix_busy);
2037 # ifdef ABORT_ON_INTERNAL_ERROR
2038 	abort();
2039 # endif
2040     }
2041 }
2042 #endif
2043 
2044 /*
2045  * Add an entry to the end of the list of errors.
2046  * Returns QF_OK or QF_FAIL.
2047  */
2048     static int
2049 qf_add_entry(
2050     qf_list_T	*qfl,		// quickfix list entry
2051     char_u	*dir,		// optional directory name
2052     char_u	*fname,		// file name or NULL
2053     char_u	*module,	// module name or NULL
2054     int		bufnum,		// buffer number or zero
2055     char_u	*mesg,		// message
2056     long	lnum,		// line number
2057     int		col,		// column
2058     int		vis_col,	// using visual column
2059     char_u	*pattern,	// search pattern
2060     int		nr,		// error number
2061     int		type,		// type character
2062     int		valid)		// valid entry
2063 {
2064     qfline_T	*qfp;
2065     qfline_T	**lastp;	// pointer to qf_last or NULL
2066 
2067     if ((qfp = ALLOC_ONE(qfline_T)) == NULL)
2068 	return QF_FAIL;
2069     if (bufnum != 0)
2070     {
2071 	buf_T *buf = buflist_findnr(bufnum);
2072 
2073 	qfp->qf_fnum = bufnum;
2074 	if (buf != NULL)
2075 	    buf->b_has_qf_entry |=
2076 		IS_QF_LIST(qfl) ? BUF_HAS_QF_ENTRY : BUF_HAS_LL_ENTRY;
2077     }
2078     else
2079 	qfp->qf_fnum = qf_get_fnum(qfl, dir, fname);
2080     if ((qfp->qf_text = vim_strsave(mesg)) == NULL)
2081     {
2082 	vim_free(qfp);
2083 	return QF_FAIL;
2084     }
2085     qfp->qf_lnum = lnum;
2086     qfp->qf_col = col;
2087     qfp->qf_viscol = vis_col;
2088     if (pattern == NULL || *pattern == NUL)
2089 	qfp->qf_pattern = NULL;
2090     else if ((qfp->qf_pattern = vim_strsave(pattern)) == NULL)
2091     {
2092 	vim_free(qfp->qf_text);
2093 	vim_free(qfp);
2094 	return QF_FAIL;
2095     }
2096     if (module == NULL || *module == NUL)
2097 	qfp->qf_module = NULL;
2098     else if ((qfp->qf_module = vim_strsave(module)) == NULL)
2099     {
2100 	vim_free(qfp->qf_text);
2101 	vim_free(qfp->qf_pattern);
2102 	vim_free(qfp);
2103 	return QF_FAIL;
2104     }
2105     qfp->qf_nr = nr;
2106     if (type != 1 && !vim_isprintc(type)) // only printable chars allowed
2107 	type = 0;
2108     qfp->qf_type = type;
2109     qfp->qf_valid = valid;
2110 
2111     lastp = &qfl->qf_last;
2112     if (qf_list_empty(qfl))		// first element in the list
2113     {
2114 	qfl->qf_start = qfp;
2115 	qfl->qf_ptr = qfp;
2116 	qfl->qf_index = 0;
2117 	qfp->qf_prev = NULL;
2118     }
2119     else
2120     {
2121 	qfp->qf_prev = *lastp;
2122 	(*lastp)->qf_next = qfp;
2123     }
2124     qfp->qf_next = NULL;
2125     qfp->qf_cleared = FALSE;
2126     *lastp = qfp;
2127     ++qfl->qf_count;
2128     if (qfl->qf_index == 0 && qfp->qf_valid)	// first valid entry
2129     {
2130 	qfl->qf_index = qfl->qf_count;
2131 	qfl->qf_ptr = qfp;
2132     }
2133 
2134     return QF_OK;
2135 }
2136 
2137 /*
2138  * Allocate a new quickfix/location list stack
2139  */
2140     static qf_info_T *
2141 qf_alloc_stack(qfltype_T qfltype)
2142 {
2143     qf_info_T *qi;
2144 
2145     qi = ALLOC_CLEAR_ONE(qf_info_T);
2146     if (qi != NULL)
2147     {
2148 	qi->qf_refcount++;
2149 	qi->qfl_type = qfltype;
2150 	qi->qf_bufnr = INVALID_QFBUFNR;
2151     }
2152     return qi;
2153 }
2154 
2155 /*
2156  * Return the location list stack for window 'wp'.
2157  * If not present, allocate a location list stack
2158  */
2159     static qf_info_T *
2160 ll_get_or_alloc_list(win_T *wp)
2161 {
2162     if (IS_LL_WINDOW(wp))
2163 	// For a location list window, use the referenced location list
2164 	return wp->w_llist_ref;
2165 
2166     // For a non-location list window, w_llist_ref should not point to a
2167     // location list.
2168     ll_free_all(&wp->w_llist_ref);
2169 
2170     if (wp->w_llist == NULL)
2171 	wp->w_llist = qf_alloc_stack(QFLT_LOCATION);	// new location list
2172     return wp->w_llist;
2173 }
2174 
2175 /*
2176  * Get the quickfix/location list stack to use for the specified Ex command.
2177  * For a location list command, returns the stack for the current window.  If
2178  * the location list is not found, then returns NULL and prints an error
2179  * message if 'print_emsg' is TRUE.
2180  */
2181     static qf_info_T *
2182 qf_cmd_get_stack(exarg_T *eap, int print_emsg)
2183 {
2184     qf_info_T	*qi = &ql_info;
2185 
2186     if (is_loclist_cmd(eap->cmdidx))
2187     {
2188 	qi = GET_LOC_LIST(curwin);
2189 	if (qi == NULL)
2190 	{
2191 	    if (print_emsg)
2192 		emsg(_(e_loclist));
2193 	    return NULL;
2194 	}
2195     }
2196 
2197     return qi;
2198 }
2199 
2200 /*
2201  * Get the quickfix/location list stack to use for the specified Ex command.
2202  * For a location list command, returns the stack for the current window.
2203  * If the location list is not present, then allocates a new one.
2204  * Returns NULL if the allocation fails.  For a location list command, sets
2205  * 'pwinp' to curwin.
2206  */
2207     static qf_info_T *
2208 qf_cmd_get_or_alloc_stack(exarg_T *eap, win_T **pwinp)
2209 {
2210     qf_info_T	*qi = &ql_info;
2211 
2212     if (is_loclist_cmd(eap->cmdidx))
2213     {
2214 	qi = ll_get_or_alloc_list(curwin);
2215 	if (qi == NULL)
2216 	    return NULL;
2217 	*pwinp = curwin;
2218     }
2219 
2220     return qi;
2221 }
2222 
2223 /*
2224  * Copy location list entries from 'from_qfl' to 'to_qfl'.
2225  */
2226     static int
2227 copy_loclist_entries(qf_list_T *from_qfl, qf_list_T *to_qfl)
2228 {
2229     int		i;
2230     qfline_T    *from_qfp;
2231     qfline_T    *prevp;
2232 
2233     // copy all the location entries in this list
2234     FOR_ALL_QFL_ITEMS(from_qfl, from_qfp, i)
2235     {
2236 	if (qf_add_entry(to_qfl,
2237 		    NULL,
2238 		    NULL,
2239 		    from_qfp->qf_module,
2240 		    0,
2241 		    from_qfp->qf_text,
2242 		    from_qfp->qf_lnum,
2243 		    from_qfp->qf_col,
2244 		    from_qfp->qf_viscol,
2245 		    from_qfp->qf_pattern,
2246 		    from_qfp->qf_nr,
2247 		    0,
2248 		    from_qfp->qf_valid) == QF_FAIL)
2249 	    return FAIL;
2250 
2251 	// qf_add_entry() will not set the qf_num field, as the
2252 	// directory and file names are not supplied. So the qf_fnum
2253 	// field is copied here.
2254 	prevp = to_qfl->qf_last;
2255 	prevp->qf_fnum = from_qfp->qf_fnum;	// file number
2256 	prevp->qf_type = from_qfp->qf_type;	// error type
2257 	if (from_qfl->qf_ptr == from_qfp)
2258 	    to_qfl->qf_ptr = prevp;		// current location
2259     }
2260 
2261     return OK;
2262 }
2263 
2264 /*
2265  * Copy the specified location list 'from_qfl' to 'to_qfl'.
2266  */
2267     static int
2268 copy_loclist(qf_list_T *from_qfl, qf_list_T *to_qfl)
2269 {
2270     // Some of the fields are populated by qf_add_entry()
2271     to_qfl->qfl_type = from_qfl->qfl_type;
2272     to_qfl->qf_nonevalid = from_qfl->qf_nonevalid;
2273     to_qfl->qf_count = 0;
2274     to_qfl->qf_index = 0;
2275     to_qfl->qf_start = NULL;
2276     to_qfl->qf_last = NULL;
2277     to_qfl->qf_ptr = NULL;
2278     if (from_qfl->qf_title != NULL)
2279 	to_qfl->qf_title = vim_strsave(from_qfl->qf_title);
2280     else
2281 	to_qfl->qf_title = NULL;
2282     if (from_qfl->qf_ctx != NULL)
2283     {
2284 	to_qfl->qf_ctx = alloc_tv();
2285 	if (to_qfl->qf_ctx != NULL)
2286 	    copy_tv(from_qfl->qf_ctx, to_qfl->qf_ctx);
2287     }
2288     else
2289 	to_qfl->qf_ctx = NULL;
2290 
2291     if (from_qfl->qf_count)
2292 	if (copy_loclist_entries(from_qfl, to_qfl) == FAIL)
2293 	    return FAIL;
2294 
2295     to_qfl->qf_index = from_qfl->qf_index;	// current index in the list
2296 
2297     // Assign a new ID for the location list
2298     to_qfl->qf_id = ++last_qf_id;
2299     to_qfl->qf_changedtick = 0L;
2300 
2301     // When no valid entries are present in the list, qf_ptr points to
2302     // the first item in the list
2303     if (to_qfl->qf_nonevalid)
2304     {
2305 	to_qfl->qf_ptr = to_qfl->qf_start;
2306 	to_qfl->qf_index = 1;
2307     }
2308 
2309     return OK;
2310 }
2311 
2312 /*
2313  * Copy the location list stack 'from' window to 'to' window.
2314  */
2315     void
2316 copy_loclist_stack(win_T *from, win_T *to)
2317 {
2318     qf_info_T	*qi;
2319     int		idx;
2320 
2321     // When copying from a location list window, copy the referenced
2322     // location list. For other windows, copy the location list for
2323     // that window.
2324     if (IS_LL_WINDOW(from))
2325 	qi = from->w_llist_ref;
2326     else
2327 	qi = from->w_llist;
2328 
2329     if (qi == NULL)		    // no location list to copy
2330 	return;
2331 
2332     // allocate a new location list
2333     if ((to->w_llist = qf_alloc_stack(QFLT_LOCATION)) == NULL)
2334 	return;
2335 
2336     to->w_llist->qf_listcount = qi->qf_listcount;
2337 
2338     // Copy the location lists one at a time
2339     for (idx = 0; idx < qi->qf_listcount; ++idx)
2340     {
2341 	to->w_llist->qf_curlist = idx;
2342 
2343 	if (copy_loclist(qf_get_list(qi, idx),
2344 			qf_get_list(to->w_llist, idx)) == FAIL)
2345 	{
2346 	    qf_free_all(to);
2347 	    return;
2348 	}
2349     }
2350 
2351     to->w_llist->qf_curlist = qi->qf_curlist;	// current list
2352 }
2353 
2354 /*
2355  * Get buffer number for file "directory/fname".
2356  * Also sets the b_has_qf_entry flag.
2357  */
2358     static int
2359 qf_get_fnum(qf_list_T *qfl, char_u *directory, char_u *fname)
2360 {
2361     char_u	*ptr = NULL;
2362     buf_T	*buf;
2363     char_u	*bufname;
2364 
2365     if (fname == NULL || *fname == NUL)		// no file name
2366 	return 0;
2367 
2368 #ifdef VMS
2369     vms_remove_version(fname);
2370 #endif
2371 #ifdef BACKSLASH_IN_FILENAME
2372     if (directory != NULL)
2373 	slash_adjust(directory);
2374     slash_adjust(fname);
2375 #endif
2376     if (directory != NULL && !vim_isAbsName(fname)
2377 	    && (ptr = concat_fnames(directory, fname, TRUE)) != NULL)
2378     {
2379 	// Here we check if the file really exists.
2380 	// This should normally be true, but if make works without
2381 	// "leaving directory"-messages we might have missed a
2382 	// directory change.
2383 	if (mch_getperm(ptr) < 0)
2384 	{
2385 	    vim_free(ptr);
2386 	    directory = qf_guess_filepath(qfl, fname);
2387 	    if (directory)
2388 		ptr = concat_fnames(directory, fname, TRUE);
2389 	    else
2390 		ptr = vim_strsave(fname);
2391 	}
2392 	// Use concatenated directory name and file name
2393 	bufname = ptr;
2394     }
2395     else
2396 	bufname = fname;
2397 
2398     if (qf_last_bufname != NULL && STRCMP(bufname, qf_last_bufname) == 0
2399 	    && bufref_valid(&qf_last_bufref))
2400     {
2401 	buf = qf_last_bufref.br_buf;
2402 	vim_free(ptr);
2403     }
2404     else
2405     {
2406 	vim_free(qf_last_bufname);
2407 	buf = buflist_new(bufname, NULL, (linenr_T)0, BLN_NOOPT);
2408 	if (bufname == ptr)
2409 	    qf_last_bufname = bufname;
2410 	else
2411 	    qf_last_bufname = vim_strsave(bufname);
2412 	set_bufref(&qf_last_bufref, buf);
2413     }
2414     if (buf == NULL)
2415 	return 0;
2416 
2417     buf->b_has_qf_entry =
2418 			IS_QF_LIST(qfl) ? BUF_HAS_QF_ENTRY : BUF_HAS_LL_ENTRY;
2419     return buf->b_fnum;
2420 }
2421 
2422 /*
2423  * Push dirbuf onto the directory stack and return pointer to actual dir or
2424  * NULL on error.
2425  */
2426     static char_u *
2427 qf_push_dir(char_u *dirbuf, struct dir_stack_T **stackptr, int is_file_stack)
2428 {
2429     struct dir_stack_T  *ds_new;
2430     struct dir_stack_T  *ds_ptr;
2431 
2432     // allocate new stack element and hook it in
2433     ds_new = ALLOC_ONE(struct dir_stack_T);
2434     if (ds_new == NULL)
2435 	return NULL;
2436 
2437     ds_new->next = *stackptr;
2438     *stackptr = ds_new;
2439 
2440     // store directory on the stack
2441     if (vim_isAbsName(dirbuf)
2442 	    || (*stackptr)->next == NULL
2443 	    || (*stackptr && is_file_stack))
2444 	(*stackptr)->dirname = vim_strsave(dirbuf);
2445     else
2446     {
2447 	// Okay we don't have an absolute path.
2448 	// dirbuf must be a subdir of one of the directories on the stack.
2449 	// Let's search...
2450 	ds_new = (*stackptr)->next;
2451 	(*stackptr)->dirname = NULL;
2452 	while (ds_new)
2453 	{
2454 	    vim_free((*stackptr)->dirname);
2455 	    (*stackptr)->dirname = concat_fnames(ds_new->dirname, dirbuf,
2456 		    TRUE);
2457 	    if (mch_isdir((*stackptr)->dirname) == TRUE)
2458 		break;
2459 
2460 	    ds_new = ds_new->next;
2461 	}
2462 
2463 	// clean up all dirs we already left
2464 	while ((*stackptr)->next != ds_new)
2465 	{
2466 	    ds_ptr = (*stackptr)->next;
2467 	    (*stackptr)->next = (*stackptr)->next->next;
2468 	    vim_free(ds_ptr->dirname);
2469 	    vim_free(ds_ptr);
2470 	}
2471 
2472 	// Nothing found -> it must be on top level
2473 	if (ds_new == NULL)
2474 	{
2475 	    vim_free((*stackptr)->dirname);
2476 	    (*stackptr)->dirname = vim_strsave(dirbuf);
2477 	}
2478     }
2479 
2480     if ((*stackptr)->dirname != NULL)
2481 	return (*stackptr)->dirname;
2482     else
2483     {
2484 	ds_ptr = *stackptr;
2485 	*stackptr = (*stackptr)->next;
2486 	vim_free(ds_ptr);
2487 	return NULL;
2488     }
2489 }
2490 
2491 /*
2492  * pop dirbuf from the directory stack and return previous directory or NULL if
2493  * stack is empty
2494  */
2495     static char_u *
2496 qf_pop_dir(struct dir_stack_T **stackptr)
2497 {
2498     struct dir_stack_T  *ds_ptr;
2499 
2500     // TODO: Should we check if dirbuf is the directory on top of the stack?
2501     // What to do if it isn't?
2502 
2503     // pop top element and free it
2504     if (*stackptr != NULL)
2505     {
2506 	ds_ptr = *stackptr;
2507 	*stackptr = (*stackptr)->next;
2508 	vim_free(ds_ptr->dirname);
2509 	vim_free(ds_ptr);
2510     }
2511 
2512     // return NEW top element as current dir or NULL if stack is empty
2513     return *stackptr ? (*stackptr)->dirname : NULL;
2514 }
2515 
2516 /*
2517  * clean up directory stack
2518  */
2519     static void
2520 qf_clean_dir_stack(struct dir_stack_T **stackptr)
2521 {
2522     struct dir_stack_T  *ds_ptr;
2523 
2524     while ((ds_ptr = *stackptr) != NULL)
2525     {
2526 	*stackptr = (*stackptr)->next;
2527 	vim_free(ds_ptr->dirname);
2528 	vim_free(ds_ptr);
2529     }
2530 }
2531 
2532 /*
2533  * Check in which directory of the directory stack the given file can be
2534  * found.
2535  * Returns a pointer to the directory name or NULL if not found.
2536  * Cleans up intermediate directory entries.
2537  *
2538  * TODO: How to solve the following problem?
2539  * If we have this directory tree:
2540  *     ./
2541  *     ./aa
2542  *     ./aa/bb
2543  *     ./bb
2544  *     ./bb/x.c
2545  * and make says:
2546  *     making all in aa
2547  *     making all in bb
2548  *     x.c:9: Error
2549  * Then qf_push_dir thinks we are in ./aa/bb, but we are in ./bb.
2550  * qf_guess_filepath will return NULL.
2551  */
2552     static char_u *
2553 qf_guess_filepath(qf_list_T *qfl, char_u *filename)
2554 {
2555     struct dir_stack_T     *ds_ptr;
2556     struct dir_stack_T     *ds_tmp;
2557     char_u		   *fullname;
2558 
2559     // no dirs on the stack - there's nothing we can do
2560     if (qfl->qf_dir_stack == NULL)
2561 	return NULL;
2562 
2563     ds_ptr = qfl->qf_dir_stack->next;
2564     fullname = NULL;
2565     while (ds_ptr)
2566     {
2567 	vim_free(fullname);
2568 	fullname = concat_fnames(ds_ptr->dirname, filename, TRUE);
2569 
2570 	// If concat_fnames failed, just go on. The worst thing that can happen
2571 	// is that we delete the entire stack.
2572 	if ((fullname != NULL) && (mch_getperm(fullname) >= 0))
2573 	    break;
2574 
2575 	ds_ptr = ds_ptr->next;
2576     }
2577 
2578     vim_free(fullname);
2579 
2580     // clean up all dirs we already left
2581     while (qfl->qf_dir_stack->next != ds_ptr)
2582     {
2583 	ds_tmp = qfl->qf_dir_stack->next;
2584 	qfl->qf_dir_stack->next = qfl->qf_dir_stack->next->next;
2585 	vim_free(ds_tmp->dirname);
2586 	vim_free(ds_tmp);
2587     }
2588 
2589     return ds_ptr == NULL ? NULL : ds_ptr->dirname;
2590 }
2591 
2592 /*
2593  * Returns TRUE if a quickfix/location list with the given identifier exists.
2594  */
2595     static int
2596 qflist_valid(win_T *wp, int_u qf_id)
2597 {
2598     qf_info_T	*qi = &ql_info;
2599     int		i;
2600 
2601     if (wp != NULL)
2602     {
2603 	qi = GET_LOC_LIST(wp);	    // Location list
2604 	if (qi == NULL)
2605 	    return FALSE;
2606     }
2607 
2608     for (i = 0; i < qi->qf_listcount; ++i)
2609 	if (qi->qf_lists[i].qf_id == qf_id)
2610 	    return TRUE;
2611 
2612     return FALSE;
2613 }
2614 
2615 /*
2616  * When loading a file from the quickfix, the autocommands may modify it.
2617  * This may invalidate the current quickfix entry.  This function checks
2618  * whether an entry is still present in the quickfix list.
2619  * Similar to location list.
2620  */
2621     static int
2622 is_qf_entry_present(qf_list_T *qfl, qfline_T *qf_ptr)
2623 {
2624     qfline_T	*qfp;
2625     int		i;
2626 
2627     // Search for the entry in the current list
2628     FOR_ALL_QFL_ITEMS(qfl, qfp, i)
2629 	if (qfp == qf_ptr)
2630 	    break;
2631 
2632     if (i > qfl->qf_count) // Entry is not found
2633 	return FALSE;
2634 
2635     return TRUE;
2636 }
2637 
2638 /*
2639  * Get the next valid entry in the current quickfix/location list. The search
2640  * starts from the current entry.  Returns NULL on failure.
2641  */
2642     static qfline_T *
2643 get_next_valid_entry(
2644 	qf_list_T	*qfl,
2645 	qfline_T	*qf_ptr,
2646 	int		*qf_index,
2647 	int		dir)
2648 {
2649     int			idx;
2650     int			old_qf_fnum;
2651 
2652     idx = *qf_index;
2653     old_qf_fnum = qf_ptr->qf_fnum;
2654 
2655     do
2656     {
2657 	if (idx == qfl->qf_count || qf_ptr->qf_next == NULL)
2658 	    return NULL;
2659 	++idx;
2660 	qf_ptr = qf_ptr->qf_next;
2661     } while ((!qfl->qf_nonevalid && !qf_ptr->qf_valid)
2662 	    || (dir == FORWARD_FILE && qf_ptr->qf_fnum == old_qf_fnum));
2663 
2664     *qf_index = idx;
2665     return qf_ptr;
2666 }
2667 
2668 /*
2669  * Get the previous valid entry in the current quickfix/location list. The
2670  * search starts from the current entry.  Returns NULL on failure.
2671  */
2672     static qfline_T *
2673 get_prev_valid_entry(
2674 	qf_list_T	*qfl,
2675 	qfline_T	*qf_ptr,
2676 	int		*qf_index,
2677 	int		dir)
2678 {
2679     int			idx;
2680     int			old_qf_fnum;
2681 
2682     idx = *qf_index;
2683     old_qf_fnum = qf_ptr->qf_fnum;
2684 
2685     do
2686     {
2687 	if (idx == 1 || qf_ptr->qf_prev == NULL)
2688 	    return NULL;
2689 	--idx;
2690 	qf_ptr = qf_ptr->qf_prev;
2691     } while ((!qfl->qf_nonevalid && !qf_ptr->qf_valid)
2692 	    || (dir == BACKWARD_FILE && qf_ptr->qf_fnum == old_qf_fnum));
2693 
2694     *qf_index = idx;
2695     return qf_ptr;
2696 }
2697 
2698 /*
2699  * Get the n'th (errornr) previous/next valid entry from the current entry in
2700  * the quickfix list.
2701  *   dir == FORWARD or FORWARD_FILE: next valid entry
2702  *   dir == BACKWARD or BACKWARD_FILE: previous valid entry
2703  */
2704     static qfline_T *
2705 get_nth_valid_entry(
2706 	qf_list_T	*qfl,
2707 	int		errornr,
2708 	int		dir,
2709 	int		*new_qfidx)
2710 {
2711     qfline_T		*qf_ptr = qfl->qf_ptr;
2712     int			qf_idx = qfl->qf_index;
2713     qfline_T		*prev_qf_ptr;
2714     int			prev_index;
2715     char_u		*err = e_no_more_items;
2716 
2717     while (errornr--)
2718     {
2719 	prev_qf_ptr = qf_ptr;
2720 	prev_index = qf_idx;
2721 
2722 	if (dir == FORWARD || dir == FORWARD_FILE)
2723 	    qf_ptr = get_next_valid_entry(qfl, qf_ptr, &qf_idx, dir);
2724 	else
2725 	    qf_ptr = get_prev_valid_entry(qfl, qf_ptr, &qf_idx, dir);
2726 	if (qf_ptr == NULL)
2727 	{
2728 	    qf_ptr = prev_qf_ptr;
2729 	    qf_idx = prev_index;
2730 	    if (err != NULL)
2731 	    {
2732 		emsg(_(err));
2733 		return NULL;
2734 	    }
2735 	    break;
2736 	}
2737 
2738 	err = NULL;
2739     }
2740 
2741     *new_qfidx = qf_idx;
2742     return qf_ptr;
2743 }
2744 
2745 /*
2746  * Get n'th (errornr) quickfix entry from the current entry in the quickfix
2747  * list 'qfl'. Returns a pointer to the new entry and the index in 'new_qfidx'
2748  */
2749     static qfline_T *
2750 get_nth_entry(qf_list_T *qfl, int errornr, int *new_qfidx)
2751 {
2752     qfline_T	*qf_ptr = qfl->qf_ptr;
2753     int		qf_idx = qfl->qf_index;
2754 
2755     // New error number is less than the current error number
2756     while (errornr < qf_idx && qf_idx > 1 && qf_ptr->qf_prev != NULL)
2757     {
2758 	--qf_idx;
2759 	qf_ptr = qf_ptr->qf_prev;
2760     }
2761     // New error number is greater than the current error number
2762     while (errornr > qf_idx && qf_idx < qfl->qf_count &&
2763 						qf_ptr->qf_next != NULL)
2764     {
2765 	++qf_idx;
2766 	qf_ptr = qf_ptr->qf_next;
2767     }
2768 
2769     *new_qfidx = qf_idx;
2770     return qf_ptr;
2771 }
2772 
2773 /*
2774  * Get a entry specied by 'errornr' and 'dir' from the current
2775  * quickfix/location list. 'errornr' specifies the index of the entry and 'dir'
2776  * specifies the direction (FORWARD/BACKWARD/FORWARD_FILE/BACKWARD_FILE).
2777  * Returns a pointer to the entry and the index of the new entry is stored in
2778  * 'new_qfidx'.
2779  */
2780     static qfline_T *
2781 qf_get_entry(
2782 	qf_list_T	*qfl,
2783 	int		errornr,
2784 	int		dir,
2785 	int		*new_qfidx)
2786 {
2787     qfline_T	*qf_ptr = qfl->qf_ptr;
2788     int		qfidx = qfl->qf_index;
2789 
2790     if (dir != 0)    // next/prev valid entry
2791 	qf_ptr = get_nth_valid_entry(qfl, errornr, dir, &qfidx);
2792     else if (errornr != 0)	// go to specified number
2793 	qf_ptr = get_nth_entry(qfl, errornr, &qfidx);
2794 
2795     *new_qfidx = qfidx;
2796     return qf_ptr;
2797 }
2798 
2799 /*
2800  * Find a window displaying a Vim help file.
2801  */
2802     static win_T *
2803 qf_find_help_win(void)
2804 {
2805     win_T *wp;
2806 
2807     FOR_ALL_WINDOWS(wp)
2808 	if (bt_help(wp->w_buffer))
2809 	    return wp;
2810 
2811     return NULL;
2812 }
2813 
2814 /*
2815  * Set the location list for the specified window to 'qi'.
2816  */
2817     static void
2818 win_set_loclist(win_T *wp, qf_info_T *qi)
2819 {
2820     wp->w_llist = qi;
2821     qi->qf_refcount++;
2822 }
2823 
2824 /*
2825  * Find a help window or open one. If 'newwin' is TRUE, then open a new help
2826  * window.
2827  */
2828     static int
2829 jump_to_help_window(qf_info_T *qi, int newwin, int *opened_window)
2830 {
2831     win_T	*wp;
2832     int		flags;
2833 
2834     if (cmdmod.tab != 0 || newwin)
2835 	wp = NULL;
2836     else
2837 	wp = qf_find_help_win();
2838     if (wp != NULL && wp->w_buffer->b_nwindows > 0)
2839 	win_enter(wp, TRUE);
2840     else
2841     {
2842 	// Split off help window; put it at far top if no position
2843 	// specified, the current window is vertically split and narrow.
2844 	flags = WSP_HELP;
2845 	if (cmdmod.split == 0 && curwin->w_width != Columns
2846 		&& curwin->w_width < 80)
2847 	    flags |= WSP_TOP;
2848 	// If the user asks to open a new window, then copy the location list.
2849 	// Otherwise, don't copy the location list.
2850 	if (IS_LL_STACK(qi) && !newwin)
2851 	    flags |= WSP_NEWLOC;
2852 
2853 	if (win_split(0, flags) == FAIL)
2854 	    return FAIL;
2855 
2856 	*opened_window = TRUE;
2857 
2858 	if (curwin->w_height < p_hh)
2859 	    win_setheight((int)p_hh);
2860 
2861 	// When using location list, the new window should use the supplied
2862 	// location list. If the user asks to open a new window, then the new
2863 	// window will get a copy of the location list.
2864 	if (IS_LL_STACK(qi) && !newwin)
2865 	    win_set_loclist(curwin, qi);
2866     }
2867 
2868     if (!p_im)
2869 	restart_edit = 0;	    // don't want insert mode in help file
2870 
2871     return OK;
2872 }
2873 
2874 /*
2875  * Find a non-quickfix window in the current tabpage using the given location
2876  * list stack.
2877  * Returns NULL if a matching window is not found.
2878  */
2879     static win_T *
2880 qf_find_win_with_loclist(qf_info_T *ll)
2881 {
2882     win_T	*wp;
2883 
2884     FOR_ALL_WINDOWS(wp)
2885 	if (wp->w_llist == ll && !bt_quickfix(wp->w_buffer))
2886 	    return wp;
2887 
2888     return NULL;
2889 }
2890 
2891 /*
2892  * Find a window containing a normal buffer
2893  */
2894     static win_T *
2895 qf_find_win_with_normal_buf(void)
2896 {
2897     win_T	*wp;
2898 
2899     FOR_ALL_WINDOWS(wp)
2900 	if (bt_normal(wp->w_buffer))
2901 	    return wp;
2902 
2903     return NULL;
2904 }
2905 
2906 /*
2907  * Go to a window in any tabpage containing the specified file.  Returns TRUE
2908  * if successfully jumped to the window. Otherwise returns FALSE.
2909  */
2910     static int
2911 qf_goto_tabwin_with_file(int fnum)
2912 {
2913     tabpage_T	*tp;
2914     win_T	*wp;
2915 
2916     FOR_ALL_TAB_WINDOWS(tp, wp)
2917 	if (wp->w_buffer->b_fnum == fnum)
2918 	{
2919 	    goto_tabpage_win(tp, wp);
2920 	    return TRUE;
2921 	}
2922 
2923     return FALSE;
2924 }
2925 
2926 /*
2927  * Create a new window to show a file above the quickfix window. Called when
2928  * only the quickfix window is present.
2929  */
2930     static int
2931 qf_open_new_file_win(qf_info_T *ll_ref)
2932 {
2933     int		flags;
2934 
2935     flags = WSP_ABOVE;
2936     if (ll_ref != NULL)
2937 	flags |= WSP_NEWLOC;
2938     if (win_split(0, flags) == FAIL)
2939 	return FAIL;		// not enough room for window
2940     p_swb = empty_option;	// don't split again
2941     swb_flags = 0;
2942     RESET_BINDING(curwin);
2943     if (ll_ref != NULL)
2944 	// The new window should use the location list from the
2945 	// location list window
2946 	win_set_loclist(curwin, ll_ref);
2947     return OK;
2948 }
2949 
2950 /*
2951  * Go to a window that shows the right buffer. If the window is not found, go
2952  * to the window just above the location list window. This is used for opening
2953  * a file from a location window and not from a quickfix window. If some usable
2954  * window is previously found, then it is supplied in 'use_win'.
2955  */
2956     static void
2957 qf_goto_win_with_ll_file(win_T *use_win, int qf_fnum, qf_info_T *ll_ref)
2958 {
2959     win_T	*win = use_win;
2960 
2961     if (win == NULL)
2962     {
2963 	// Find the window showing the selected file
2964 	FOR_ALL_WINDOWS(win)
2965 	    if (win->w_buffer->b_fnum == qf_fnum)
2966 		break;
2967 	if (win == NULL)
2968 	{
2969 	    // Find a previous usable window
2970 	    win = curwin;
2971 	    do
2972 	    {
2973 		if (bt_normal(win->w_buffer))
2974 		    break;
2975 		if (win->w_prev == NULL)
2976 		    win = lastwin;	// wrap around the top
2977 		else
2978 		    win = win->w_prev; // go to previous window
2979 	    } while (win != curwin);
2980 	}
2981     }
2982     win_goto(win);
2983 
2984     // If the location list for the window is not set, then set it
2985     // to the location list from the location window
2986     if (win->w_llist == NULL && ll_ref != NULL)
2987 	win_set_loclist(win, ll_ref);
2988 }
2989 
2990 /*
2991  * Go to a window that contains the specified buffer 'qf_fnum'. If a window is
2992  * not found, then go to the window just above the quickfix window. This is
2993  * used for opening a file from a quickfix window and not from a location
2994  * window.
2995  */
2996     static void
2997 qf_goto_win_with_qfl_file(int qf_fnum)
2998 {
2999     win_T	*win;
3000     win_T	*altwin;
3001 
3002     win = curwin;
3003     altwin = NULL;
3004     for (;;)
3005     {
3006 	if (win->w_buffer->b_fnum == qf_fnum)
3007 	    break;
3008 	if (win->w_prev == NULL)
3009 	    win = lastwin;	// wrap around the top
3010 	else
3011 	    win = win->w_prev;	// go to previous window
3012 
3013 	if (IS_QF_WINDOW(win))
3014 	{
3015 	    // Didn't find it, go to the window before the quickfix
3016 	    // window.
3017 	    if (altwin != NULL)
3018 		win = altwin;
3019 	    else if (curwin->w_prev != NULL)
3020 		win = curwin->w_prev;
3021 	    else
3022 		win = curwin->w_next;
3023 	    break;
3024 	}
3025 
3026 	// Remember a usable window.
3027 	if (altwin == NULL && !win->w_p_pvw && bt_normal(win->w_buffer))
3028 	    altwin = win;
3029     }
3030 
3031     win_goto(win);
3032 }
3033 
3034 /*
3035  * Find a suitable window for opening a file (qf_fnum) from the
3036  * quickfix/location list and jump to it.  If the file is already opened in a
3037  * window, jump to it. Otherwise open a new window to display the file. If
3038  * 'newwin' is TRUE, then always open a new window. This is called from either
3039  * a quickfix or a location list window.
3040  */
3041     static int
3042 qf_jump_to_usable_window(int qf_fnum, int newwin, int *opened_window)
3043 {
3044     win_T	*usable_win_ptr = NULL;
3045     int		usable_win;
3046     qf_info_T	*ll_ref = NULL;
3047     win_T	*win;
3048 
3049     usable_win = 0;
3050 
3051     // If opening a new window, then don't use the location list referred by
3052     // the current window.  Otherwise two windows will refer to the same
3053     // location list.
3054     if (!newwin)
3055 	ll_ref = curwin->w_llist_ref;
3056 
3057     if (ll_ref != NULL)
3058     {
3059 	// Find a non-quickfix window with this location list
3060 	usable_win_ptr = qf_find_win_with_loclist(ll_ref);
3061 	if (usable_win_ptr != NULL)
3062 	    usable_win = 1;
3063     }
3064 
3065     if (!usable_win)
3066     {
3067 	// Locate a window showing a normal buffer
3068 	win = qf_find_win_with_normal_buf();
3069 	if (win != NULL)
3070 	    usable_win = 1;
3071     }
3072 
3073     // If no usable window is found and 'switchbuf' contains "usetab"
3074     // then search in other tabs.
3075     if (!usable_win && (swb_flags & SWB_USETAB))
3076 	usable_win = qf_goto_tabwin_with_file(qf_fnum);
3077 
3078     // If there is only one window and it is the quickfix window, create a
3079     // new one above the quickfix window.
3080     if ((ONE_WINDOW && bt_quickfix(curbuf)) || !usable_win || newwin)
3081     {
3082 	if (qf_open_new_file_win(ll_ref) != OK)
3083 	    return FAIL;
3084 	*opened_window = TRUE;	// close it when fail
3085     }
3086     else
3087     {
3088 	if (curwin->w_llist_ref != NULL)	// In a location window
3089 	    qf_goto_win_with_ll_file(usable_win_ptr, qf_fnum, ll_ref);
3090 	else					// In a quickfix window
3091 	    qf_goto_win_with_qfl_file(qf_fnum);
3092     }
3093 
3094     return OK;
3095 }
3096 
3097 /*
3098  * Edit the selected file or help file.
3099  * Returns OK if successfully edited the file, FAIL on failing to open the
3100  * buffer and NOTDONE if the quickfix/location list was freed by an autocmd
3101  * when opening the buffer.
3102  */
3103     static int
3104 qf_jump_edit_buffer(
3105 	qf_info_T	*qi,
3106 	qfline_T	*qf_ptr,
3107 	int		forceit,
3108 	int		prev_winid,
3109 	int		*opened_window)
3110 {
3111     qf_list_T	*qfl = qf_get_curlist(qi);
3112     qfltype_T	qfl_type = qfl->qfl_type;
3113     int		retval = OK;
3114     int		old_qf_curlist = qi->qf_curlist;
3115     int		save_qfid = qfl->qf_id;
3116 
3117     if (qf_ptr->qf_type == 1)
3118     {
3119 	// Open help file (do_ecmd() will set b_help flag, readfile() will
3120 	// set b_p_ro flag).
3121 	if (!can_abandon(curbuf, forceit))
3122 	{
3123 	    no_write_message();
3124 	    return FAIL;
3125 	}
3126 
3127 	retval = do_ecmd(qf_ptr->qf_fnum, NULL, NULL, NULL, (linenr_T)1,
3128 		ECMD_HIDE + ECMD_SET_HELP,
3129 		prev_winid == curwin->w_id ? curwin : NULL);
3130     }
3131     else
3132 	retval = buflist_getfile(qf_ptr->qf_fnum,
3133 		(linenr_T)1, GETF_SETMARK | GETF_SWITCH, forceit);
3134 
3135     // If a location list, check whether the associated window is still
3136     // present.
3137     if (qfl_type == QFLT_LOCATION)
3138     {
3139 	win_T	*wp = win_id2wp(prev_winid);
3140 	if (wp == NULL && curwin->w_llist != qi)
3141 	{
3142 	    emsg(_("E924: Current window was closed"));
3143 	    *opened_window = FALSE;
3144 	    return NOTDONE;
3145 	}
3146     }
3147 
3148     if (qfl_type == QFLT_QUICKFIX && !qflist_valid(NULL, save_qfid))
3149     {
3150 	emsg(_("E925: Current quickfix was changed"));
3151 	return NOTDONE;
3152     }
3153 
3154     if (old_qf_curlist != qi->qf_curlist
3155 	    || !is_qf_entry_present(qfl, qf_ptr))
3156     {
3157 	if (qfl_type == QFLT_QUICKFIX)
3158 	    emsg(_("E925: Current quickfix was changed"));
3159 	else
3160 	    emsg(_(e_loc_list_changed));
3161 	return NOTDONE;
3162     }
3163 
3164     return retval;
3165 }
3166 
3167 /*
3168  * Go to the error line in the current file using either line/column number or
3169  * a search pattern.
3170  */
3171     static void
3172 qf_jump_goto_line(
3173 	linenr_T	qf_lnum,
3174 	int		qf_col,
3175 	char_u		qf_viscol,
3176 	char_u		*qf_pattern)
3177 {
3178     linenr_T		i;
3179 
3180     if (qf_pattern == NULL)
3181     {
3182 	// Go to line with error, unless qf_lnum is 0.
3183 	i = qf_lnum;
3184 	if (i > 0)
3185 	{
3186 	    if (i > curbuf->b_ml.ml_line_count)
3187 		i = curbuf->b_ml.ml_line_count;
3188 	    curwin->w_cursor.lnum = i;
3189 	}
3190 	if (qf_col > 0)
3191 	{
3192 	    curwin->w_cursor.coladd = 0;
3193 	    if (qf_viscol == TRUE)
3194 		coladvance(qf_col - 1);
3195 	    else
3196 		curwin->w_cursor.col = qf_col - 1;
3197 	    curwin->w_set_curswant = TRUE;
3198 	    check_cursor();
3199 	}
3200 	else
3201 	    beginline(BL_WHITE | BL_FIX);
3202     }
3203     else
3204     {
3205 	pos_T save_cursor;
3206 
3207 	// Move the cursor to the first line in the buffer
3208 	save_cursor = curwin->w_cursor;
3209 	curwin->w_cursor.lnum = 0;
3210 	if (!do_search(NULL, '/', qf_pattern, (long)1,
3211 		    SEARCH_KEEP, NULL, NULL))
3212 	    curwin->w_cursor = save_cursor;
3213     }
3214 }
3215 
3216 /*
3217  * Display quickfix list index and size message
3218  */
3219     static void
3220 qf_jump_print_msg(
3221 	qf_info_T	*qi,
3222 	int		qf_index,
3223 	qfline_T	*qf_ptr,
3224 	buf_T		*old_curbuf,
3225 	linenr_T	old_lnum)
3226 {
3227     linenr_T		i;
3228     int			len;
3229 
3230     // Update the screen before showing the message, unless the screen
3231     // scrolled up.
3232     if (!msg_scrolled)
3233 	update_topline_redraw();
3234     sprintf((char *)IObuff, _("(%d of %d)%s%s: "), qf_index,
3235 	    qf_get_curlist(qi)->qf_count,
3236 	    qf_ptr->qf_cleared ? _(" (line deleted)") : "",
3237 	    (char *)qf_types(qf_ptr->qf_type, qf_ptr->qf_nr));
3238     // Add the message, skipping leading whitespace and newlines.
3239     len = (int)STRLEN(IObuff);
3240     qf_fmt_text(skipwhite(qf_ptr->qf_text), IObuff + len, IOSIZE - len);
3241 
3242     // Output the message.  Overwrite to avoid scrolling when the 'O'
3243     // flag is present in 'shortmess'; But when not jumping, print the
3244     // whole message.
3245     i = msg_scroll;
3246     if (curbuf == old_curbuf && curwin->w_cursor.lnum == old_lnum)
3247 	msg_scroll = TRUE;
3248     else if (!msg_scrolled && shortmess(SHM_OVERALL))
3249 	msg_scroll = FALSE;
3250     msg_attr_keep((char *)IObuff, 0, TRUE);
3251     msg_scroll = i;
3252 }
3253 
3254 /*
3255  * Find a usable window for opening a file from the quickfix/location list. If
3256  * a window is not found then open a new window. If 'newwin' is TRUE, then open
3257  * a new window.
3258  * Returns OK if successfully jumped or opened a window. Returns FAIL if not
3259  * able to jump/open a window.  Returns NOTDONE if a file is not associated
3260  * with the entry.
3261  */
3262     static int
3263 qf_jump_open_window(
3264 	qf_info_T	*qi,
3265 	qfline_T	*qf_ptr,
3266 	int		newwin,
3267 	int		*opened_window)
3268 {
3269     // For ":helpgrep" find a help window or open one.
3270     if (qf_ptr->qf_type == 1 && (!bt_help(curwin->w_buffer) || cmdmod.tab != 0))
3271 	if (jump_to_help_window(qi, newwin, opened_window) == FAIL)
3272 	    return FAIL;
3273 
3274     // If currently in the quickfix window, find another window to show the
3275     // file in.
3276     if (bt_quickfix(curbuf) && !*opened_window)
3277     {
3278 	// If there is no file specified, we don't know where to go.
3279 	// But do advance, otherwise ":cn" gets stuck.
3280 	if (qf_ptr->qf_fnum == 0)
3281 	    return NOTDONE;
3282 
3283 	if (qf_jump_to_usable_window(qf_ptr->qf_fnum, newwin,
3284 						opened_window) == FAIL)
3285 	    return FAIL;
3286     }
3287 
3288     return OK;
3289 }
3290 
3291 /*
3292  * Edit a selected file from the quickfix/location list and jump to a
3293  * particular line/column, adjust the folds and display a message about the
3294  * jump.
3295  * Returns OK on success and FAIL on failing to open the file/buffer.  Returns
3296  * NOTDONE if the quickfix/location list is freed by an autocmd when opening
3297  * the file.
3298  */
3299     static int
3300 qf_jump_to_buffer(
3301 	qf_info_T	*qi,
3302 	int		qf_index,
3303 	qfline_T	*qf_ptr,
3304 	int		forceit,
3305 	int		prev_winid,
3306 	int		*opened_window,
3307 	int		openfold,
3308 	int		print_message)
3309 {
3310     buf_T	*old_curbuf;
3311     linenr_T	old_lnum;
3312     int		retval = OK;
3313 
3314     // If there is a file name, read the wanted file if needed, and check
3315     // autowrite etc.
3316     old_curbuf = curbuf;
3317     old_lnum = curwin->w_cursor.lnum;
3318 
3319     if (qf_ptr->qf_fnum != 0)
3320     {
3321 	retval = qf_jump_edit_buffer(qi, qf_ptr, forceit, prev_winid,
3322 						opened_window);
3323 	if (retval != OK)
3324 	    return retval;
3325     }
3326 
3327     // When not switched to another buffer, still need to set pc mark
3328     if (curbuf == old_curbuf)
3329 	setpcmark();
3330 
3331     qf_jump_goto_line(qf_ptr->qf_lnum, qf_ptr->qf_col, qf_ptr->qf_viscol,
3332 	    qf_ptr->qf_pattern);
3333 
3334 #ifdef FEAT_FOLDING
3335     if ((fdo_flags & FDO_QUICKFIX) && openfold)
3336 	foldOpenCursor();
3337 #endif
3338     if (print_message)
3339 	qf_jump_print_msg(qi, qf_index, qf_ptr, old_curbuf, old_lnum);
3340 
3341     return retval;
3342 }
3343 
3344 /*
3345  * Jump to a quickfix line and try to use an existing window.
3346  */
3347     void
3348 qf_jump(qf_info_T	*qi,
3349 	int		dir,
3350 	int		errornr,
3351 	int		forceit)
3352 {
3353     qf_jump_newwin(qi, dir, errornr, forceit, FALSE);
3354 }
3355 
3356 /*
3357  * Jump to a quickfix line.
3358  * If dir == 0 go to entry "errornr".
3359  * If dir == FORWARD go "errornr" valid entries forward.
3360  * If dir == BACKWARD go "errornr" valid entries backward.
3361  * If dir == FORWARD_FILE go "errornr" valid entries files backward.
3362  * If dir == BACKWARD_FILE go "errornr" valid entries files backward
3363  * else if "errornr" is zero, redisplay the same line
3364  * If 'forceit' is TRUE, then can discard changes to the current buffer.
3365  * If 'newwin' is TRUE, then open the file in a new window.
3366  */
3367     static void
3368 qf_jump_newwin(qf_info_T	*qi,
3369 	int		dir,
3370 	int		errornr,
3371 	int		forceit,
3372 	int		newwin)
3373 {
3374     qf_list_T		*qfl;
3375     qfline_T		*qf_ptr;
3376     qfline_T		*old_qf_ptr;
3377     int			qf_index;
3378     int			old_qf_index;
3379     char_u		*old_swb = p_swb;
3380     unsigned		old_swb_flags = swb_flags;
3381     int			prev_winid;
3382     int			opened_window = FALSE;
3383     int			print_message = TRUE;
3384     int			old_KeyTyped = KeyTyped; // getting file may reset it
3385     int			retval = OK;
3386 
3387     if (qi == NULL)
3388 	qi = &ql_info;
3389 
3390     if (qf_stack_empty(qi) || qf_list_empty(qf_get_curlist(qi)))
3391     {
3392 	emsg(_(e_quickfix));
3393 	return;
3394     }
3395 
3396     incr_quickfix_busy();
3397 
3398     qfl = qf_get_curlist(qi);
3399 
3400     qf_ptr = qfl->qf_ptr;
3401     old_qf_ptr = qf_ptr;
3402     qf_index = qfl->qf_index;
3403     old_qf_index = qf_index;
3404 
3405     qf_ptr = qf_get_entry(qfl, errornr, dir, &qf_index);
3406     if (qf_ptr == NULL)
3407     {
3408 	qf_ptr = old_qf_ptr;
3409 	qf_index = old_qf_index;
3410 	goto theend;
3411     }
3412 
3413     qfl->qf_index = qf_index;
3414     if (qf_win_pos_update(qi, old_qf_index))
3415 	// No need to print the error message if it's visible in the error
3416 	// window
3417 	print_message = FALSE;
3418 
3419     prev_winid = curwin->w_id;
3420 
3421     retval = qf_jump_open_window(qi, qf_ptr, newwin, &opened_window);
3422     if (retval == FAIL)
3423 	goto failed;
3424     if (retval == NOTDONE)
3425 	goto theend;
3426 
3427     retval = qf_jump_to_buffer(qi, qf_index, qf_ptr, forceit, prev_winid,
3428 				  &opened_window, old_KeyTyped, print_message);
3429     if (retval == NOTDONE)
3430     {
3431 	// Quickfix/location list is freed by an autocmd
3432 	qi = NULL;
3433 	qf_ptr = NULL;
3434     }
3435 
3436     if (retval != OK)
3437     {
3438 	if (opened_window)
3439 	    win_close(curwin, TRUE);    // Close opened window
3440 	if (qf_ptr != NULL && qf_ptr->qf_fnum != 0)
3441 	{
3442 	    // Couldn't open file, so put index back where it was.  This could
3443 	    // happen if the file was readonly and we changed something.
3444 failed:
3445 	    qf_ptr = old_qf_ptr;
3446 	    qf_index = old_qf_index;
3447 	}
3448     }
3449 theend:
3450     if (qi != NULL)
3451     {
3452 	qfl->qf_ptr = qf_ptr;
3453 	qfl->qf_index = qf_index;
3454     }
3455     if (p_swb != old_swb)
3456     {
3457 	// Restore old 'switchbuf' value, but not when an autocommand or
3458 	// modeline has changed the value.
3459 	if (p_swb == empty_option)
3460 	{
3461 	    p_swb = old_swb;
3462 	    swb_flags = old_swb_flags;
3463 	}
3464 	else
3465 	    free_string_option(old_swb);
3466     }
3467     decr_quickfix_busy();
3468 }
3469 
3470 // Highlight attributes used for displaying entries from the quickfix list.
3471 static int	qfFileAttr;
3472 static int	qfSepAttr;
3473 static int	qfLineAttr;
3474 
3475 /*
3476  * Display information about a single entry from the quickfix/location list.
3477  * Used by ":clist/:llist" commands.
3478  * 'cursel' will be set to TRUE for the currently selected entry in the
3479  * quickfix list.
3480  */
3481     static void
3482 qf_list_entry(qfline_T *qfp, int qf_idx, int cursel)
3483 {
3484     char_u	*fname;
3485     buf_T	*buf;
3486     int		filter_entry;
3487 
3488     fname = NULL;
3489     if (qfp->qf_module != NULL && *qfp->qf_module != NUL)
3490 	vim_snprintf((char *)IObuff, IOSIZE, "%2d %s", qf_idx,
3491 						(char *)qfp->qf_module);
3492     else {
3493 	if (qfp->qf_fnum != 0
3494 		&& (buf = buflist_findnr(qfp->qf_fnum)) != NULL)
3495 	{
3496 	    fname = buf->b_fname;
3497 	    if (qfp->qf_type == 1)	// :helpgrep
3498 		fname = gettail(fname);
3499 	}
3500 	if (fname == NULL)
3501 	    sprintf((char *)IObuff, "%2d", qf_idx);
3502 	else
3503 	    vim_snprintf((char *)IObuff, IOSIZE, "%2d %s",
3504 		    qf_idx, (char *)fname);
3505     }
3506 
3507     // Support for filtering entries using :filter /pat/ clist
3508     // Match against the module name, file name, search pattern and
3509     // text of the entry.
3510     filter_entry = TRUE;
3511     if (qfp->qf_module != NULL && *qfp->qf_module != NUL)
3512 	filter_entry &= message_filtered(qfp->qf_module);
3513     if (filter_entry && fname != NULL)
3514 	filter_entry &= message_filtered(fname);
3515     if (filter_entry && qfp->qf_pattern != NULL)
3516 	filter_entry &= message_filtered(qfp->qf_pattern);
3517     if (filter_entry)
3518 	filter_entry &= message_filtered(qfp->qf_text);
3519     if (filter_entry)
3520 	return;
3521 
3522     msg_putchar('\n');
3523     msg_outtrans_attr(IObuff, cursel ? HL_ATTR(HLF_QFL) : qfFileAttr);
3524 
3525     if (qfp->qf_lnum != 0)
3526 	msg_puts_attr(":", qfSepAttr);
3527     if (qfp->qf_lnum == 0)
3528 	IObuff[0] = NUL;
3529     else if (qfp->qf_col == 0)
3530 	sprintf((char *)IObuff, "%ld", qfp->qf_lnum);
3531     else
3532 	sprintf((char *)IObuff, "%ld col %d",
3533 		qfp->qf_lnum, qfp->qf_col);
3534     sprintf((char *)IObuff + STRLEN(IObuff), "%s",
3535 	    (char *)qf_types(qfp->qf_type, qfp->qf_nr));
3536     msg_puts_attr((char *)IObuff, qfLineAttr);
3537     msg_puts_attr(":", qfSepAttr);
3538     if (qfp->qf_pattern != NULL)
3539     {
3540 	qf_fmt_text(qfp->qf_pattern, IObuff, IOSIZE);
3541 	msg_puts((char *)IObuff);
3542 	msg_puts_attr(":", qfSepAttr);
3543     }
3544     msg_puts(" ");
3545 
3546     // Remove newlines and leading whitespace from the text.  For an
3547     // unrecognized line keep the indent, the compiler may mark a word
3548     // with ^^^^.
3549     qf_fmt_text((fname != NULL || qfp->qf_lnum != 0)
3550 				? skipwhite(qfp->qf_text) : qfp->qf_text,
3551 				IObuff, IOSIZE);
3552     msg_prt_line(IObuff, FALSE);
3553     out_flush();		// show one line at a time
3554 }
3555 
3556 /*
3557  * ":clist": list all errors
3558  * ":llist": list all locations
3559  */
3560     void
3561 qf_list(exarg_T *eap)
3562 {
3563     qf_list_T	*qfl;
3564     qfline_T	*qfp;
3565     int		i;
3566     int		idx1 = 1;
3567     int		idx2 = -1;
3568     char_u	*arg = eap->arg;
3569     int		plus = FALSE;
3570     int		all = eap->forceit;	// if not :cl!, only show
3571 					// recognised errors
3572     qf_info_T	*qi;
3573 
3574     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
3575 	return;
3576 
3577     if (qf_stack_empty(qi) || qf_list_empty(qf_get_curlist(qi)))
3578     {
3579 	emsg(_(e_quickfix));
3580 	return;
3581     }
3582     if (*arg == '+')
3583     {
3584 	++arg;
3585 	plus = TRUE;
3586     }
3587     if (!get_list_range(&arg, &idx1, &idx2) || *arg != NUL)
3588     {
3589 	emsg(_(e_trailing));
3590 	return;
3591     }
3592     qfl = qf_get_curlist(qi);
3593     if (plus)
3594     {
3595 	i = qfl->qf_index;
3596 	idx2 = i + idx1;
3597 	idx1 = i;
3598     }
3599     else
3600     {
3601 	i = qfl->qf_count;
3602 	if (idx1 < 0)
3603 	    idx1 = (-idx1 > i) ? 0 : idx1 + i + 1;
3604 	if (idx2 < 0)
3605 	    idx2 = (-idx2 > i) ? 0 : idx2 + i + 1;
3606     }
3607 
3608     // Shorten all the file names, so that it is easy to read
3609     shorten_fnames(FALSE);
3610 
3611     // Get the attributes for the different quickfix highlight items.  Note
3612     // that this depends on syntax items defined in the qf.vim syntax file
3613     qfFileAttr = syn_name2attr((char_u *)"qfFileName");
3614     if (qfFileAttr == 0)
3615 	qfFileAttr = HL_ATTR(HLF_D);
3616     qfSepAttr = syn_name2attr((char_u *)"qfSeparator");
3617     if (qfSepAttr == 0)
3618 	qfSepAttr = HL_ATTR(HLF_D);
3619     qfLineAttr = syn_name2attr((char_u *)"qfLineNr");
3620     if (qfLineAttr == 0)
3621 	qfLineAttr = HL_ATTR(HLF_N);
3622 
3623     if (qfl->qf_nonevalid)
3624 	all = TRUE;
3625     FOR_ALL_QFL_ITEMS(qfl, qfp, i)
3626     {
3627 	if ((qfp->qf_valid || all) && idx1 <= i && i <= idx2)
3628 	    qf_list_entry(qfp, i, i == qfl->qf_index);
3629 
3630 	ui_breakcheck();
3631     }
3632 }
3633 
3634 /*
3635  * Remove newlines and leading whitespace from an error message.
3636  * Put the result in "buf[bufsize]".
3637  */
3638     static void
3639 qf_fmt_text(char_u *text, char_u *buf, int bufsize)
3640 {
3641     int		i;
3642     char_u	*p = text;
3643 
3644     for (i = 0; *p != NUL && i < bufsize - 1; ++i)
3645     {
3646 	if (*p == '\n')
3647 	{
3648 	    buf[i] = ' ';
3649 	    while (*++p != NUL)
3650 		if (!VIM_ISWHITE(*p) && *p != '\n')
3651 		    break;
3652 	}
3653 	else
3654 	    buf[i] = *p++;
3655     }
3656     buf[i] = NUL;
3657 }
3658 
3659 /*
3660  * Display information (list number, list size and the title) about a
3661  * quickfix/location list.
3662  */
3663     static void
3664 qf_msg(qf_info_T *qi, int which, char *lead)
3665 {
3666     char   *title = (char *)qi->qf_lists[which].qf_title;
3667     int    count = qi->qf_lists[which].qf_count;
3668     char_u buf[IOSIZE];
3669 
3670     vim_snprintf((char *)buf, IOSIZE, _("%serror list %d of %d; %d errors "),
3671 	    lead,
3672 	    which + 1,
3673 	    qi->qf_listcount,
3674 	    count);
3675 
3676     if (title != NULL)
3677     {
3678 	size_t	len = STRLEN(buf);
3679 
3680 	if (len < 34)
3681 	{
3682 	    vim_memset(buf + len, ' ', 34 - len);
3683 	    buf[34] = NUL;
3684 	}
3685 	vim_strcat(buf, (char_u *)title, IOSIZE);
3686     }
3687     trunc_string(buf, buf, Columns - 1, IOSIZE);
3688     msg((char *)buf);
3689 }
3690 
3691 /*
3692  * ":colder [count]": Up in the quickfix stack.
3693  * ":cnewer [count]": Down in the quickfix stack.
3694  * ":lolder [count]": Up in the location list stack.
3695  * ":lnewer [count]": Down in the location list stack.
3696  */
3697     void
3698 qf_age(exarg_T *eap)
3699 {
3700     qf_info_T	*qi;
3701     int		count;
3702 
3703     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
3704 	return;
3705 
3706     if (eap->addr_count != 0)
3707 	count = eap->line2;
3708     else
3709 	count = 1;
3710     while (count--)
3711     {
3712 	if (eap->cmdidx == CMD_colder || eap->cmdidx == CMD_lolder)
3713 	{
3714 	    if (qi->qf_curlist == 0)
3715 	    {
3716 		emsg(_("E380: At bottom of quickfix stack"));
3717 		break;
3718 	    }
3719 	    --qi->qf_curlist;
3720 	}
3721 	else
3722 	{
3723 	    if (qi->qf_curlist >= qi->qf_listcount - 1)
3724 	    {
3725 		emsg(_("E381: At top of quickfix stack"));
3726 		break;
3727 	    }
3728 	    ++qi->qf_curlist;
3729 	}
3730     }
3731     qf_msg(qi, qi->qf_curlist, "");
3732     qf_update_buffer(qi, NULL);
3733 }
3734 
3735 /*
3736  * Display the information about all the quickfix/location lists in the stack
3737  */
3738     void
3739 qf_history(exarg_T *eap)
3740 {
3741     qf_info_T	*qi = qf_cmd_get_stack(eap, FALSE);
3742     int		i;
3743 
3744     if (eap->addr_count > 0)
3745     {
3746 	if (qi == NULL)
3747 	{
3748 	    emsg(_(e_loclist));
3749 	    return;
3750 	}
3751 
3752 	// Jump to the specified quickfix list
3753 	if (eap->line2 > 0 && eap->line2 <= qi->qf_listcount)
3754 	{
3755 	    qi->qf_curlist = eap->line2 - 1;
3756 	    qf_msg(qi, qi->qf_curlist, "");
3757 	    qf_update_buffer(qi, NULL);
3758 	}
3759 	else
3760 	    emsg(_(e_invrange));
3761 
3762 	return;
3763     }
3764 
3765     if (qf_stack_empty(qi))
3766 	msg(_("No entries"));
3767     else
3768 	for (i = 0; i < qi->qf_listcount; ++i)
3769 	    qf_msg(qi, i, i == qi->qf_curlist ? "> " : "  ");
3770 }
3771 
3772 /*
3773  * Free all the entries in the error list "idx". Note that other information
3774  * associated with the list like context and title are not freed.
3775  */
3776     static void
3777 qf_free_items(qf_list_T *qfl)
3778 {
3779     qfline_T	*qfp;
3780     qfline_T	*qfpnext;
3781     int		stop = FALSE;
3782 
3783     while (qfl->qf_count && qfl->qf_start != NULL)
3784     {
3785 	qfp = qfl->qf_start;
3786 	qfpnext = qfp->qf_next;
3787 	if (!stop)
3788 	{
3789 	    vim_free(qfp->qf_module);
3790 	    vim_free(qfp->qf_text);
3791 	    vim_free(qfp->qf_pattern);
3792 	    stop = (qfp == qfpnext);
3793 	    vim_free(qfp);
3794 	    if (stop)
3795 		// Somehow qf_count may have an incorrect value, set it to 1
3796 		// to avoid crashing when it's wrong.
3797 		// TODO: Avoid qf_count being incorrect.
3798 		qfl->qf_count = 1;
3799 	}
3800 	qfl->qf_start = qfpnext;
3801 	--qfl->qf_count;
3802     }
3803 
3804     qfl->qf_index = 0;
3805     qfl->qf_start = NULL;
3806     qfl->qf_last = NULL;
3807     qfl->qf_ptr = NULL;
3808     qfl->qf_nonevalid = TRUE;
3809 
3810     qf_clean_dir_stack(&qfl->qf_dir_stack);
3811     qfl->qf_directory = NULL;
3812     qf_clean_dir_stack(&qfl->qf_file_stack);
3813     qfl->qf_currfile = NULL;
3814     qfl->qf_multiline = FALSE;
3815     qfl->qf_multiignore = FALSE;
3816     qfl->qf_multiscan = FALSE;
3817 }
3818 
3819 /*
3820  * Free error list "idx". Frees all the entries in the quickfix list,
3821  * associated context information and the title.
3822  */
3823     static void
3824 qf_free(qf_list_T *qfl)
3825 {
3826     qf_free_items(qfl);
3827 
3828     VIM_CLEAR(qfl->qf_title);
3829     free_tv(qfl->qf_ctx);
3830     qfl->qf_ctx = NULL;
3831     qfl->qf_id = 0;
3832     qfl->qf_changedtick = 0L;
3833 }
3834 
3835 /*
3836  * qf_mark_adjust: adjust marks
3837  */
3838    void
3839 qf_mark_adjust(
3840 	win_T	*wp,
3841 	linenr_T	line1,
3842 	linenr_T	line2,
3843 	long	amount,
3844 	long	amount_after)
3845 {
3846     int		i;
3847     qfline_T	*qfp;
3848     int		idx;
3849     qf_info_T	*qi = &ql_info;
3850     int		found_one = FALSE;
3851     int		buf_has_flag = wp == NULL ? BUF_HAS_QF_ENTRY : BUF_HAS_LL_ENTRY;
3852 
3853     if (!(curbuf->b_has_qf_entry & buf_has_flag))
3854 	return;
3855     if (wp != NULL)
3856     {
3857 	if (wp->w_llist == NULL)
3858 	    return;
3859 	qi = wp->w_llist;
3860     }
3861 
3862     for (idx = 0; idx < qi->qf_listcount; ++idx)
3863     {
3864 	qf_list_T	*qfl = qf_get_list(qi, idx);
3865 
3866 	if (!qf_list_empty(qfl))
3867 	    FOR_ALL_QFL_ITEMS(qfl, qfp, i)
3868 		if (qfp->qf_fnum == curbuf->b_fnum)
3869 		{
3870 		    found_one = TRUE;
3871 		    if (qfp->qf_lnum >= line1 && qfp->qf_lnum <= line2)
3872 		    {
3873 			if (amount == MAXLNUM)
3874 			    qfp->qf_cleared = TRUE;
3875 			else
3876 			    qfp->qf_lnum += amount;
3877 		    }
3878 		    else if (amount_after && qfp->qf_lnum > line2)
3879 			qfp->qf_lnum += amount_after;
3880 		}
3881     }
3882 
3883     if (!found_one)
3884 	curbuf->b_has_qf_entry &= ~buf_has_flag;
3885 }
3886 
3887 /*
3888  * Make a nice message out of the error character and the error number:
3889  *  char    number	message
3890  *  e or E    0		" error"
3891  *  w or W    0		" warning"
3892  *  i or I    0		" info"
3893  *  0	      0		""
3894  *  other     0		" c"
3895  *  e or E    n		" error n"
3896  *  w or W    n		" warning n"
3897  *  i or I    n		" info n"
3898  *  0	      n		" error n"
3899  *  other     n		" c n"
3900  *  1	      x		""	:helpgrep
3901  */
3902     static char_u *
3903 qf_types(int c, int nr)
3904 {
3905     static char_u	buf[20];
3906     static char_u	cc[3];
3907     char_u		*p;
3908 
3909     if (c == 'W' || c == 'w')
3910 	p = (char_u *)" warning";
3911     else if (c == 'I' || c == 'i')
3912 	p = (char_u *)" info";
3913     else if (c == 'E' || c == 'e' || (c == 0 && nr > 0))
3914 	p = (char_u *)" error";
3915     else if (c == 0 || c == 1)
3916 	p = (char_u *)"";
3917     else
3918     {
3919 	cc[0] = ' ';
3920 	cc[1] = c;
3921 	cc[2] = NUL;
3922 	p = cc;
3923     }
3924 
3925     if (nr <= 0)
3926 	return p;
3927 
3928     sprintf((char *)buf, "%s %3d", (char *)p, nr);
3929     return buf;
3930 }
3931 
3932 /*
3933  * When "split" is FALSE: Open the entry/result under the cursor.
3934  * When "split" is TRUE: Open the entry/result under the cursor in a new window.
3935  */
3936     void
3937 qf_view_result(int split)
3938 {
3939     qf_info_T   *qi = &ql_info;
3940 
3941     if (!bt_quickfix(curbuf))
3942 	return;
3943 
3944     if (IS_LL_WINDOW(curwin))
3945 	qi = GET_LOC_LIST(curwin);
3946 
3947     if (qf_list_empty(qf_get_curlist(qi)))
3948     {
3949 	emsg(_(e_quickfix));
3950 	return;
3951     }
3952 
3953     if (split)
3954     {
3955 	// Open the selected entry in a new window
3956 	qf_jump_newwin(qi, 0, (long)curwin->w_cursor.lnum, FALSE, TRUE);
3957 	do_cmdline_cmd((char_u *) "clearjumps");
3958 	return;
3959     }
3960 
3961     do_cmdline_cmd((char_u *)(IS_LL_WINDOW(curwin) ? ".ll" : ".cc"));
3962 }
3963 
3964 /*
3965  * ":cwindow": open the quickfix window if we have errors to display,
3966  *	       close it if not.
3967  * ":lwindow": open the location list window if we have locations to display,
3968  *	       close it if not.
3969  */
3970     void
3971 ex_cwindow(exarg_T *eap)
3972 {
3973     qf_info_T	*qi;
3974     qf_list_T	*qfl;
3975     win_T	*win;
3976 
3977     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
3978 	return;
3979 
3980     qfl = qf_get_curlist(qi);
3981 
3982     // Look for an existing quickfix window.
3983     win = qf_find_win(qi);
3984 
3985     // If a quickfix window is open but we have no errors to display,
3986     // close the window.  If a quickfix window is not open, then open
3987     // it if we have errors; otherwise, leave it closed.
3988     if (qf_stack_empty(qi)
3989 	    || qfl->qf_nonevalid
3990 	    || qf_list_empty(qfl))
3991     {
3992 	if (win != NULL)
3993 	    ex_cclose(eap);
3994     }
3995     else if (win == NULL)
3996 	ex_copen(eap);
3997 }
3998 
3999 /*
4000  * ":cclose": close the window showing the list of errors.
4001  * ":lclose": close the window showing the location list
4002  */
4003     void
4004 ex_cclose(exarg_T *eap)
4005 {
4006     win_T	*win = NULL;
4007     qf_info_T	*qi;
4008 
4009     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4010 	return;
4011 
4012     // Find existing quickfix window and close it.
4013     win = qf_find_win(qi);
4014     if (win != NULL)
4015 	win_close(win, FALSE);
4016 }
4017 
4018 /*
4019  * Set "w:quickfix_title" if "qi" has a title.
4020  */
4021     static void
4022 qf_set_title_var(qf_list_T *qfl)
4023 {
4024     if (qfl->qf_title != NULL)
4025 	set_internal_string_var((char_u *)"w:quickfix_title", qfl->qf_title);
4026 }
4027 
4028 /*
4029  * Goto a quickfix or location list window (if present).
4030  * Returns OK if the window is found, FAIL otherwise.
4031  */
4032     static int
4033 qf_goto_cwindow(qf_info_T *qi, int resize, int sz, int vertsplit)
4034 {
4035     win_T	*win;
4036 
4037     win = qf_find_win(qi);
4038     if (win == NULL)
4039 	return FAIL;
4040 
4041     win_goto(win);
4042     if (resize)
4043     {
4044 	if (vertsplit)
4045 	{
4046 	    if (sz != win->w_width)
4047 		win_setwidth(sz);
4048 	}
4049 	else if (sz != win->w_height && win->w_height
4050 		       + win->w_status_height + tabline_height() < cmdline_row)
4051 	    win_setheight(sz);
4052     }
4053 
4054     return OK;
4055 }
4056 
4057 /*
4058  * Set options for the buffer in the quickfix or location list window.
4059  */
4060     static void
4061 qf_set_cwindow_options(void)
4062 {
4063     // switch off 'swapfile'
4064     set_option_value((char_u *)"swf", 0L, NULL, OPT_LOCAL);
4065     set_option_value((char_u *)"bt", 0L, (char_u *)"quickfix",
4066 	    OPT_LOCAL);
4067     set_option_value((char_u *)"bh", 0L, (char_u *)"hide", OPT_LOCAL);
4068     RESET_BINDING(curwin);
4069 #ifdef FEAT_DIFF
4070     curwin->w_p_diff = FALSE;
4071 #endif
4072 #ifdef FEAT_FOLDING
4073     set_option_value((char_u *)"fdm", 0L, (char_u *)"manual",
4074 	    OPT_LOCAL);
4075 #endif
4076 }
4077 
4078 /*
4079  * Open a new quickfix or location list window, load the quickfix buffer and
4080  * set the appropriate options for the window.
4081  * Returns FAIL if the window could not be opened.
4082  */
4083     static int
4084 qf_open_new_cwindow(qf_info_T *qi, int height)
4085 {
4086     buf_T	*qf_buf;
4087     win_T	*oldwin = curwin;
4088     tabpage_T	*prevtab = curtab;
4089     int		flags = 0;
4090     win_T	*win;
4091 
4092     qf_buf = qf_find_buf(qi);
4093 
4094     // The current window becomes the previous window afterwards.
4095     win = curwin;
4096 
4097     if (IS_QF_STACK(qi) && cmdmod.split == 0)
4098 	// Create the new quickfix window at the very bottom, except when
4099 	// :belowright or :aboveleft is used.
4100 	win_goto(lastwin);
4101     // Default is to open the window below the current window
4102     if (cmdmod.split == 0)
4103 	flags = WSP_BELOW;
4104     flags |= WSP_NEWLOC;
4105     if (win_split(height, flags) == FAIL)
4106 	return FAIL;		// not enough room for window
4107     RESET_BINDING(curwin);
4108 
4109     if (IS_LL_STACK(qi))
4110     {
4111 	// For the location list window, create a reference to the
4112 	// location list stack from the window 'win'.
4113 	curwin->w_llist_ref = qi;
4114 	qi->qf_refcount++;
4115     }
4116 
4117     if (oldwin != curwin)
4118 	oldwin = NULL;  // don't store info when in another window
4119     if (qf_buf != NULL)
4120     {
4121 	// Use the existing quickfix buffer
4122 	(void)do_ecmd(qf_buf->b_fnum, NULL, NULL, NULL, ECMD_ONE,
4123 		ECMD_HIDE + ECMD_OLDBUF, oldwin);
4124     }
4125     else
4126     {
4127 	// Create a new quickfix buffer
4128 	(void)do_ecmd(0, NULL, NULL, NULL, ECMD_ONE, ECMD_HIDE, oldwin);
4129 
4130 	// save the number of the new buffer
4131 	qi->qf_bufnr = curbuf->b_fnum;
4132     }
4133 
4134     // Set the options for the quickfix buffer/window (if not already done)
4135     // Do this even if the quickfix buffer was already present, as an autocmd
4136     // might have previously deleted (:bdelete) the quickfix buffer.
4137     if (!bt_quickfix(curbuf))
4138 	qf_set_cwindow_options();
4139 
4140     // Only set the height when still in the same tab page and there is no
4141     // window to the side.
4142     if (curtab == prevtab && curwin->w_width == Columns)
4143 	win_setheight(height);
4144     curwin->w_p_wfh = TRUE;	    // set 'winfixheight'
4145     if (win_valid(win))
4146 	prevwin = win;
4147 
4148     return OK;
4149 }
4150 
4151 /*
4152  * ":copen": open a window that shows the list of errors.
4153  * ":lopen": open a window that shows the location list.
4154  */
4155     void
4156 ex_copen(exarg_T *eap)
4157 {
4158     qf_info_T	*qi;
4159     qf_list_T	*qfl;
4160     int		height;
4161     int		status = FAIL;
4162     int		lnum;
4163 
4164     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
4165 	return;
4166 
4167     incr_quickfix_busy();
4168 
4169     if (eap->addr_count != 0)
4170 	height = eap->line2;
4171     else
4172 	height = QF_WINHEIGHT;
4173 
4174     reset_VIsual_and_resel();			// stop Visual mode
4175 #ifdef FEAT_GUI
4176     need_mouse_correct = TRUE;
4177 #endif
4178 
4179     // Find an existing quickfix window, or open a new one.
4180     if (cmdmod.tab == 0)
4181 	status = qf_goto_cwindow(qi, eap->addr_count != 0, height,
4182 						cmdmod.split & WSP_VERT);
4183     if (status == FAIL)
4184 	if (qf_open_new_cwindow(qi, height) == FAIL)
4185 	{
4186 	    decr_quickfix_busy();
4187 	    return;
4188 	}
4189 
4190     qfl = qf_get_curlist(qi);
4191     qf_set_title_var(qfl);
4192     // Save the current index here, as updating the quickfix buffer may free
4193     // the quickfix list
4194     lnum = qfl->qf_index;
4195 
4196     // Fill the buffer with the quickfix list.
4197     qf_fill_buffer(qfl, curbuf, NULL);
4198 
4199     decr_quickfix_busy();
4200 
4201     curwin->w_cursor.lnum = lnum;
4202     curwin->w_cursor.col = 0;
4203     check_cursor();
4204     update_topline();		// scroll to show the line
4205 }
4206 
4207 /*
4208  * Move the cursor in the quickfix window to "lnum".
4209  */
4210     static void
4211 qf_win_goto(win_T *win, linenr_T lnum)
4212 {
4213     win_T	*old_curwin = curwin;
4214 
4215     curwin = win;
4216     curbuf = win->w_buffer;
4217     curwin->w_cursor.lnum = lnum;
4218     curwin->w_cursor.col = 0;
4219     curwin->w_cursor.coladd = 0;
4220     curwin->w_curswant = 0;
4221     update_topline();		// scroll to show the line
4222     redraw_later(VALID);
4223     curwin->w_redr_status = TRUE;	// update ruler
4224     curwin = old_curwin;
4225     curbuf = curwin->w_buffer;
4226 }
4227 
4228 /*
4229  * :cbottom/:lbottom commands.
4230  */
4231     void
4232 ex_cbottom(exarg_T *eap)
4233 {
4234     qf_info_T	*qi;
4235     win_T	*win;
4236 
4237     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
4238 	return;
4239 
4240     win = qf_find_win(qi);
4241     if (win != NULL && win->w_cursor.lnum != win->w_buffer->b_ml.ml_line_count)
4242 	qf_win_goto(win, win->w_buffer->b_ml.ml_line_count);
4243 }
4244 
4245 /*
4246  * Return the number of the current entry (line number in the quickfix
4247  * window).
4248  */
4249      linenr_T
4250 qf_current_entry(win_T *wp)
4251 {
4252     qf_info_T	*qi = &ql_info;
4253 
4254     if (IS_LL_WINDOW(wp))
4255 	// In the location list window, use the referenced location list
4256 	qi = wp->w_llist_ref;
4257 
4258     return qf_get_curlist(qi)->qf_index;
4259 }
4260 
4261 /*
4262  * Update the cursor position in the quickfix window to the current error.
4263  * Return TRUE if there is a quickfix window.
4264  */
4265     static int
4266 qf_win_pos_update(
4267     qf_info_T	*qi,
4268     int		old_qf_index)	// previous qf_index or zero
4269 {
4270     win_T	*win;
4271     int		qf_index = qf_get_curlist(qi)->qf_index;
4272 
4273     // Put the cursor on the current error in the quickfix window, so that
4274     // it's viewable.
4275     win = qf_find_win(qi);
4276     if (win != NULL
4277 	    && qf_index <= win->w_buffer->b_ml.ml_line_count
4278 	    && old_qf_index != qf_index)
4279     {
4280 	if (qf_index > old_qf_index)
4281 	{
4282 	    win->w_redraw_top = old_qf_index;
4283 	    win->w_redraw_bot = qf_index;
4284 	}
4285 	else
4286 	{
4287 	    win->w_redraw_top = qf_index;
4288 	    win->w_redraw_bot = old_qf_index;
4289 	}
4290 	qf_win_goto(win, qf_index);
4291     }
4292     return win != NULL;
4293 }
4294 
4295 /*
4296  * Check whether the given window is displaying the specified quickfix/location
4297  * stack.
4298  */
4299     static int
4300 is_qf_win(win_T *win, qf_info_T *qi)
4301 {
4302     // A window displaying the quickfix buffer will have the w_llist_ref field
4303     // set to NULL.
4304     // A window displaying a location list buffer will have the w_llist_ref
4305     // pointing to the location list.
4306     if (bt_quickfix(win->w_buffer))
4307 	if ((IS_QF_STACK(qi) && win->w_llist_ref == NULL)
4308 		|| (IS_LL_STACK(qi) && win->w_llist_ref == qi))
4309 	    return TRUE;
4310 
4311     return FALSE;
4312 }
4313 
4314 /*
4315  * Find a window displaying the quickfix/location stack 'qi'
4316  * Only searches in the current tabpage.
4317  */
4318     static win_T *
4319 qf_find_win(qf_info_T *qi)
4320 {
4321     win_T	*win;
4322 
4323     FOR_ALL_WINDOWS(win)
4324 	if (is_qf_win(win, qi))
4325 	    return win;
4326     return NULL;
4327 }
4328 
4329 /*
4330  * Find a quickfix buffer.
4331  * Searches in windows opened in all the tabs.
4332  */
4333     static buf_T *
4334 qf_find_buf(qf_info_T *qi)
4335 {
4336     tabpage_T	*tp;
4337     win_T	*win;
4338 
4339     if (qi->qf_bufnr != INVALID_QFBUFNR)
4340     {
4341 	buf_T	*qfbuf;
4342 	qfbuf = buflist_findnr(qi->qf_bufnr);
4343 	if (qfbuf != NULL)
4344 	    return qfbuf;
4345 	// buffer is no longer present
4346 	qi->qf_bufnr = INVALID_QFBUFNR;
4347     }
4348 
4349     FOR_ALL_TAB_WINDOWS(tp, win)
4350 	if (is_qf_win(win, qi))
4351 	    return win->w_buffer;
4352 
4353     return NULL;
4354 }
4355 
4356 /*
4357  * Update the w:quickfix_title variable in the quickfix/location list window
4358  */
4359     static void
4360 qf_update_win_titlevar(qf_info_T *qi)
4361 {
4362     win_T	*win;
4363     win_T	*curwin_save;
4364 
4365     if ((win = qf_find_win(qi)) != NULL)
4366     {
4367 	curwin_save = curwin;
4368 	curwin = win;
4369 	qf_set_title_var(qf_get_curlist(qi));
4370 	curwin = curwin_save;
4371     }
4372 }
4373 
4374 /*
4375  * Find the quickfix buffer.  If it exists, update the contents.
4376  */
4377     static void
4378 qf_update_buffer(qf_info_T *qi, qfline_T *old_last)
4379 {
4380     buf_T	*buf;
4381     win_T	*win;
4382     aco_save_T	aco;
4383 
4384     // Check if a buffer for the quickfix list exists.  Update it.
4385     buf = qf_find_buf(qi);
4386     if (buf != NULL)
4387     {
4388 	linenr_T	old_line_count = buf->b_ml.ml_line_count;
4389 
4390 	if (old_last == NULL)
4391 	    // set curwin/curbuf to buf and save a few things
4392 	    aucmd_prepbuf(&aco, buf);
4393 
4394 	qf_update_win_titlevar(qi);
4395 
4396 	qf_fill_buffer(qf_get_curlist(qi), buf, old_last);
4397 	++CHANGEDTICK(buf);
4398 
4399 	if (old_last == NULL)
4400 	{
4401 	    (void)qf_win_pos_update(qi, 0);
4402 
4403 	    // restore curwin/curbuf and a few other things
4404 	    aucmd_restbuf(&aco);
4405 	}
4406 
4407 	// Only redraw when added lines are visible.  This avoids flickering
4408 	// when the added lines are not visible.
4409 	if ((win = qf_find_win(qi)) != NULL && old_line_count < win->w_botline)
4410 	    redraw_buf_later(buf, NOT_VALID);
4411     }
4412 }
4413 
4414 /*
4415  * Add an error line to the quickfix buffer.
4416  */
4417     static int
4418 qf_buf_add_line(buf_T *buf, linenr_T lnum, qfline_T *qfp, char_u *dirname)
4419 {
4420     int		len;
4421     buf_T	*errbuf;
4422 
4423     if (qfp->qf_module != NULL)
4424     {
4425 	STRCPY(IObuff, qfp->qf_module);
4426 	len = (int)STRLEN(IObuff);
4427     }
4428     else if (qfp->qf_fnum != 0
4429 	    && (errbuf = buflist_findnr(qfp->qf_fnum)) != NULL
4430 	    && errbuf->b_fname != NULL)
4431     {
4432 	if (qfp->qf_type == 1)	// :helpgrep
4433 	    STRCPY(IObuff, gettail(errbuf->b_fname));
4434 	else
4435 	{
4436 	    // shorten the file name if not done already
4437 	    if (errbuf->b_sfname == NULL
4438 		    || mch_isFullName(errbuf->b_sfname))
4439 	    {
4440 		if (*dirname == NUL)
4441 		    mch_dirname(dirname, MAXPATHL);
4442 		shorten_buf_fname(errbuf, dirname, FALSE);
4443 	    }
4444 	    STRCPY(IObuff, errbuf->b_fname);
4445 	}
4446 	len = (int)STRLEN(IObuff);
4447     }
4448     else
4449 	len = 0;
4450     IObuff[len++] = '|';
4451 
4452     if (qfp->qf_lnum > 0)
4453     {
4454 	sprintf((char *)IObuff + len, "%ld", qfp->qf_lnum);
4455 	len += (int)STRLEN(IObuff + len);
4456 
4457 	if (qfp->qf_col > 0)
4458 	{
4459 	    sprintf((char *)IObuff + len, " col %d", qfp->qf_col);
4460 	    len += (int)STRLEN(IObuff + len);
4461 	}
4462 
4463 	sprintf((char *)IObuff + len, "%s",
4464 		(char *)qf_types(qfp->qf_type, qfp->qf_nr));
4465 	len += (int)STRLEN(IObuff + len);
4466     }
4467     else if (qfp->qf_pattern != NULL)
4468     {
4469 	qf_fmt_text(qfp->qf_pattern, IObuff + len, IOSIZE - len);
4470 	len += (int)STRLEN(IObuff + len);
4471     }
4472     IObuff[len++] = '|';
4473     IObuff[len++] = ' ';
4474 
4475     // Remove newlines and leading whitespace from the text.
4476     // For an unrecognized line keep the indent, the compiler may
4477     // mark a word with ^^^^.
4478     qf_fmt_text(len > 3 ? skipwhite(qfp->qf_text) : qfp->qf_text,
4479 	    IObuff + len, IOSIZE - len);
4480 
4481     if (ml_append_buf(buf, lnum, IObuff,
4482 		(colnr_T)STRLEN(IObuff) + 1, FALSE) == FAIL)
4483 	return FAIL;
4484 
4485     return OK;
4486 }
4487 
4488 /*
4489  * Fill current buffer with quickfix errors, replacing any previous contents.
4490  * curbuf must be the quickfix buffer!
4491  * If "old_last" is not NULL append the items after this one.
4492  * When "old_last" is NULL then "buf" must equal "curbuf"!  Because
4493  * ml_delete() is used and autocommands will be triggered.
4494  */
4495     static void
4496 qf_fill_buffer(qf_list_T *qfl, buf_T *buf, qfline_T *old_last)
4497 {
4498     linenr_T	lnum;
4499     qfline_T	*qfp;
4500     int		old_KeyTyped = KeyTyped;
4501 
4502     if (old_last == NULL)
4503     {
4504 	if (buf != curbuf)
4505 	{
4506 	    internal_error("qf_fill_buffer()");
4507 	    return;
4508 	}
4509 
4510 	// delete all existing lines
4511 	while ((curbuf->b_ml.ml_flags & ML_EMPTY) == 0)
4512 	    (void)ml_delete((linenr_T)1, FALSE);
4513     }
4514 
4515     // Check if there is anything to display
4516     if (qfl != NULL)
4517     {
4518 	char_u		dirname[MAXPATHL];
4519 
4520 	*dirname = NUL;
4521 
4522 	// Add one line for each error
4523 	if (old_last == NULL)
4524 	{
4525 	    qfp = qfl->qf_start;
4526 	    lnum = 0;
4527 	}
4528 	else
4529 	{
4530 	    qfp = old_last->qf_next;
4531 	    lnum = buf->b_ml.ml_line_count;
4532 	}
4533 	while (lnum < qfl->qf_count)
4534 	{
4535 	    if (qf_buf_add_line(buf, lnum, qfp, dirname) == FAIL)
4536 		break;
4537 
4538 	    ++lnum;
4539 	    qfp = qfp->qf_next;
4540 	    if (qfp == NULL)
4541 		break;
4542 	}
4543 
4544 	if (old_last == NULL)
4545 	    // Delete the empty line which is now at the end
4546 	    (void)ml_delete(lnum + 1, FALSE);
4547     }
4548 
4549     // correct cursor position
4550     check_lnums(TRUE);
4551 
4552     if (old_last == NULL)
4553     {
4554 	// Set the 'filetype' to "qf" each time after filling the buffer.
4555 	// This resembles reading a file into a buffer, it's more logical when
4556 	// using autocommands.
4557 	++curbuf_lock;
4558 	set_option_value((char_u *)"ft", 0L, (char_u *)"qf", OPT_LOCAL);
4559 	curbuf->b_p_ma = FALSE;
4560 
4561 	keep_filetype = TRUE;		// don't detect 'filetype'
4562 	apply_autocmds(EVENT_BUFREADPOST, (char_u *)"quickfix", NULL,
4563 							       FALSE, curbuf);
4564 	apply_autocmds(EVENT_BUFWINENTER, (char_u *)"quickfix", NULL,
4565 							       FALSE, curbuf);
4566 	keep_filetype = FALSE;
4567 	--curbuf_lock;
4568 
4569 	// make sure it will be redrawn
4570 	redraw_curbuf_later(NOT_VALID);
4571     }
4572 
4573     // Restore KeyTyped, setting 'filetype' may reset it.
4574     KeyTyped = old_KeyTyped;
4575 }
4576 
4577 /*
4578  * For every change made to the quickfix list, update the changed tick.
4579  */
4580     static void
4581 qf_list_changed(qf_list_T *qfl)
4582 {
4583     qfl->qf_changedtick++;
4584 }
4585 
4586 /*
4587  * Return the quickfix/location list number with the given identifier.
4588  * Returns -1 if list is not found.
4589  */
4590     static int
4591 qf_id2nr(qf_info_T *qi, int_u qfid)
4592 {
4593     int		qf_idx;
4594 
4595     for (qf_idx = 0; qf_idx < qi->qf_listcount; qf_idx++)
4596 	if (qi->qf_lists[qf_idx].qf_id == qfid)
4597 	    return qf_idx;
4598     return INVALID_QFIDX;
4599 }
4600 
4601 /*
4602  * If the current list is not "save_qfid" and we can find the list with that ID
4603  * then make it the current list.
4604  * This is used when autocommands may have changed the current list.
4605  * Returns OK if successfully restored the list. Returns FAIL if the list with
4606  * the specified identifier (save_qfid) is not found in the stack.
4607  */
4608     static int
4609 qf_restore_list(qf_info_T *qi, int_u save_qfid)
4610 {
4611     int curlist;
4612 
4613     if (qf_get_curlist(qi)->qf_id != save_qfid)
4614     {
4615 	curlist = qf_id2nr(qi, save_qfid);
4616 	if (curlist < 0)
4617 	    // list is not present
4618 	    return FAIL;
4619 	qi->qf_curlist = curlist;
4620     }
4621     return OK;
4622 }
4623 
4624 /*
4625  * Jump to the first entry if there is one.
4626  */
4627     static void
4628 qf_jump_first(qf_info_T *qi, int_u save_qfid, int forceit)
4629 {
4630     if (qf_restore_list(qi, save_qfid) == FAIL)
4631 	return;
4632 
4633     // Autocommands might have cleared the list, check for that.
4634     if (!qf_list_empty(qf_get_curlist(qi)))
4635 	qf_jump(qi, 0, 0, forceit);
4636 }
4637 
4638 /*
4639  * Return TRUE when using ":vimgrep" for ":grep".
4640  */
4641     int
4642 grep_internal(cmdidx_T cmdidx)
4643 {
4644     return ((cmdidx == CMD_grep
4645 		|| cmdidx == CMD_lgrep
4646 		|| cmdidx == CMD_grepadd
4647 		|| cmdidx == CMD_lgrepadd)
4648 	    && STRCMP("internal",
4649 			*curbuf->b_p_gp == NUL ? p_gp : curbuf->b_p_gp) == 0);
4650 }
4651 
4652 /*
4653  * Return the make/grep autocmd name.
4654  */
4655     static char_u *
4656 make_get_auname(cmdidx_T cmdidx)
4657 {
4658     switch (cmdidx)
4659     {
4660 	case CMD_make:	    return (char_u *)"make";
4661 	case CMD_lmake:	    return (char_u *)"lmake";
4662 	case CMD_grep:	    return (char_u *)"grep";
4663 	case CMD_lgrep:	    return (char_u *)"lgrep";
4664 	case CMD_grepadd:   return (char_u *)"grepadd";
4665 	case CMD_lgrepadd:  return (char_u *)"lgrepadd";
4666 	default: return NULL;
4667     }
4668 }
4669 
4670 /*
4671  * Return the name for the errorfile, in allocated memory.
4672  * Find a new unique name when 'makeef' contains "##".
4673  * Returns NULL for error.
4674  */
4675     static char_u *
4676 get_mef_name(void)
4677 {
4678     char_u	*p;
4679     char_u	*name;
4680     static int	start = -1;
4681     static int	off = 0;
4682 #ifdef HAVE_LSTAT
4683     stat_T	sb;
4684 #endif
4685 
4686     if (*p_mef == NUL)
4687     {
4688 	name = vim_tempname('e', FALSE);
4689 	if (name == NULL)
4690 	    emsg(_(e_notmp));
4691 	return name;
4692     }
4693 
4694     for (p = p_mef; *p; ++p)
4695 	if (p[0] == '#' && p[1] == '#')
4696 	    break;
4697 
4698     if (*p == NUL)
4699 	return vim_strsave(p_mef);
4700 
4701     // Keep trying until the name doesn't exist yet.
4702     for (;;)
4703     {
4704 	if (start == -1)
4705 	    start = mch_get_pid();
4706 	else
4707 	    off += 19;
4708 
4709 	name = alloc(STRLEN(p_mef) + 30);
4710 	if (name == NULL)
4711 	    break;
4712 	STRCPY(name, p_mef);
4713 	sprintf((char *)name + (p - p_mef), "%d%d", start, off);
4714 	STRCAT(name, p + 2);
4715 	if (mch_getperm(name) < 0
4716 #ifdef HAVE_LSTAT
4717 		    // Don't accept a symbolic link, it's a security risk.
4718 		    && mch_lstat((char *)name, &sb) < 0
4719 #endif
4720 		)
4721 	    break;
4722 	vim_free(name);
4723     }
4724     return name;
4725 }
4726 
4727 /*
4728  * Form the complete command line to invoke 'make'/'grep'. Quote the command
4729  * using 'shellquote' and append 'shellpipe'. Echo the fully formed command.
4730  */
4731     static char_u *
4732 make_get_fullcmd(char_u *makecmd, char_u *fname)
4733 {
4734     char_u	*cmd;
4735     unsigned	len;
4736 
4737     len = (unsigned)STRLEN(p_shq) * 2 + (unsigned)STRLEN(makecmd) + 1;
4738     if (*p_sp != NUL)
4739 	len += (unsigned)STRLEN(p_sp) + (unsigned)STRLEN(fname) + 3;
4740     cmd = alloc(len);
4741     if (cmd == NULL)
4742 	return NULL;
4743     sprintf((char *)cmd, "%s%s%s", (char *)p_shq, (char *)makecmd,
4744 							       (char *)p_shq);
4745 
4746     // If 'shellpipe' empty: don't redirect to 'errorfile'.
4747     if (*p_sp != NUL)
4748 	append_redir(cmd, len, p_sp, fname);
4749 
4750     // Display the fully formed command.  Output a newline if there's something
4751     // else than the :make command that was typed (in which case the cursor is
4752     // in column 0).
4753     if (msg_col == 0)
4754 	msg_didout = FALSE;
4755     msg_start();
4756     msg_puts(":!");
4757     msg_outtrans(cmd);		// show what we are doing
4758 
4759     return cmd;
4760 }
4761 
4762 /*
4763  * Used for ":make", ":lmake", ":grep", ":lgrep", ":grepadd", and ":lgrepadd"
4764  */
4765     void
4766 ex_make(exarg_T *eap)
4767 {
4768     char_u	*fname;
4769     char_u	*cmd;
4770     char_u	*enc = NULL;
4771     win_T	*wp = NULL;
4772     qf_info_T	*qi = &ql_info;
4773     int		res;
4774     char_u	*au_name = NULL;
4775     int_u	save_qfid;
4776 
4777     // Redirect ":grep" to ":vimgrep" if 'grepprg' is "internal".
4778     if (grep_internal(eap->cmdidx))
4779     {
4780 	ex_vimgrep(eap);
4781 	return;
4782     }
4783 
4784     au_name = make_get_auname(eap->cmdidx);
4785     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
4786 					       curbuf->b_fname, TRUE, curbuf))
4787     {
4788 #ifdef FEAT_EVAL
4789 	if (aborting())
4790 	    return;
4791 #endif
4792     }
4793     enc = (*curbuf->b_p_menc != NUL) ? curbuf->b_p_menc : p_menc;
4794 
4795     if (is_loclist_cmd(eap->cmdidx))
4796 	wp = curwin;
4797 
4798     autowrite_all();
4799     fname = get_mef_name();
4800     if (fname == NULL)
4801 	return;
4802     mch_remove(fname);	    // in case it's not unique
4803 
4804     cmd = make_get_fullcmd(eap->arg, fname);
4805     if (cmd == NULL)
4806 	return;
4807 
4808     // let the shell know if we are redirecting output or not
4809     do_shell(cmd, *p_sp != NUL ? SHELL_DOOUT : 0);
4810 
4811 #ifdef AMIGA
4812     out_flush();
4813 		// read window status report and redraw before message
4814     (void)char_avail();
4815 #endif
4816 
4817     incr_quickfix_busy();
4818 
4819     res = qf_init(wp, fname, (eap->cmdidx != CMD_make
4820 			    && eap->cmdidx != CMD_lmake) ? p_gefm : p_efm,
4821 					   (eap->cmdidx != CMD_grepadd
4822 					    && eap->cmdidx != CMD_lgrepadd),
4823 					   qf_cmdtitle(*eap->cmdlinep), enc);
4824     if (wp != NULL)
4825     {
4826 	qi = GET_LOC_LIST(wp);
4827 	if (qi == NULL)
4828 	    goto cleanup;
4829     }
4830     if (res >= 0)
4831 	qf_list_changed(qf_get_curlist(qi));
4832 
4833     // Remember the current quickfix list identifier, so that we can
4834     // check for autocommands changing the current quickfix list.
4835     save_qfid = qf_get_curlist(qi)->qf_id;
4836     if (au_name != NULL)
4837 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
4838 					       curbuf->b_fname, TRUE, curbuf);
4839     if (res > 0 && !eap->forceit && qflist_valid(wp, save_qfid))
4840 	// display the first error
4841 	qf_jump_first(qi, save_qfid, FALSE);
4842 
4843 cleanup:
4844     decr_quickfix_busy();
4845     mch_remove(fname);
4846     vim_free(fname);
4847     vim_free(cmd);
4848 }
4849 
4850 /*
4851  * Returns the number of entries in the current quickfix/location list.
4852  */
4853     int
4854 qf_get_size(exarg_T *eap)
4855 {
4856     qf_info_T	*qi;
4857 
4858     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4859 	return 0;
4860     return qf_get_curlist(qi)->qf_count;
4861 }
4862 
4863 /*
4864  * Returns the number of valid entries in the current quickfix/location list.
4865  */
4866     int
4867 qf_get_valid_size(exarg_T *eap)
4868 {
4869     qf_info_T	*qi;
4870     qf_list_T	*qfl;
4871     qfline_T	*qfp;
4872     int		i, sz = 0;
4873     int		prev_fnum = 0;
4874 
4875     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4876 	return 0;
4877 
4878     qfl = qf_get_curlist(qi);
4879     FOR_ALL_QFL_ITEMS(qfl, qfp, i)
4880     {
4881 	if (qfp->qf_valid)
4882 	{
4883 	    if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo)
4884 		sz++;	// Count all valid entries
4885 	    else if (qfp->qf_fnum > 0 && qfp->qf_fnum != prev_fnum)
4886 	    {
4887 		// Count the number of files
4888 		sz++;
4889 		prev_fnum = qfp->qf_fnum;
4890 	    }
4891 	}
4892     }
4893 
4894     return sz;
4895 }
4896 
4897 /*
4898  * Returns the current index of the quickfix/location list.
4899  * Returns 0 if there is an error.
4900  */
4901     int
4902 qf_get_cur_idx(exarg_T *eap)
4903 {
4904     qf_info_T	*qi;
4905 
4906     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4907 	return 0;
4908 
4909     return qf_get_curlist(qi)->qf_index;
4910 }
4911 
4912 /*
4913  * Returns the current index in the quickfix/location list (counting only valid
4914  * entries). If no valid entries are in the list, then returns 1.
4915  */
4916     int
4917 qf_get_cur_valid_idx(exarg_T *eap)
4918 {
4919     qf_info_T	*qi;
4920     qf_list_T	*qfl;
4921     qfline_T	*qfp;
4922     int		i, eidx = 0;
4923     int		prev_fnum = 0;
4924 
4925     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4926 	return 1;
4927 
4928     qfl = qf_get_curlist(qi);
4929     qfp = qfl->qf_start;
4930 
4931     // check if the list has valid errors
4932     if (!qf_list_has_valid_entries(qfl))
4933 	return 1;
4934 
4935     for (i = 1; i <= qfl->qf_index && qfp!= NULL; i++, qfp = qfp->qf_next)
4936     {
4937 	if (qfp->qf_valid)
4938 	{
4939 	    if (eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
4940 	    {
4941 		if (qfp->qf_fnum > 0 && qfp->qf_fnum != prev_fnum)
4942 		{
4943 		    // Count the number of files
4944 		    eidx++;
4945 		    prev_fnum = qfp->qf_fnum;
4946 		}
4947 	    }
4948 	    else
4949 		eidx++;
4950 	}
4951     }
4952 
4953     return eidx ? eidx : 1;
4954 }
4955 
4956 /*
4957  * Get the 'n'th valid error entry in the quickfix or location list.
4958  * Used by :cdo, :ldo, :cfdo and :lfdo commands.
4959  * For :cdo and :ldo returns the 'n'th valid error entry.
4960  * For :cfdo and :lfdo returns the 'n'th valid file entry.
4961  */
4962     static int
4963 qf_get_nth_valid_entry(qf_list_T *qfl, int n, int fdo)
4964 {
4965     qfline_T	*qfp;
4966     int		i, eidx;
4967     int		prev_fnum = 0;
4968 
4969     // check if the list has valid errors
4970     if (!qf_list_has_valid_entries(qfl))
4971 	return 1;
4972 
4973     eidx = 0;
4974     FOR_ALL_QFL_ITEMS(qfl, qfp, i)
4975     {
4976 	if (qfp->qf_valid)
4977 	{
4978 	    if (fdo)
4979 	    {
4980 		if (qfp->qf_fnum > 0 && qfp->qf_fnum != prev_fnum)
4981 		{
4982 		    // Count the number of files
4983 		    eidx++;
4984 		    prev_fnum = qfp->qf_fnum;
4985 		}
4986 	    }
4987 	    else
4988 		eidx++;
4989 	}
4990 
4991 	if (eidx == n)
4992 	    break;
4993     }
4994 
4995     if (i <= qfl->qf_count)
4996 	return i;
4997     else
4998 	return 1;
4999 }
5000 
5001 /*
5002  * ":cc", ":crewind", ":cfirst" and ":clast".
5003  * ":ll", ":lrewind", ":lfirst" and ":llast".
5004  * ":cdo", ":ldo", ":cfdo" and ":lfdo"
5005  */
5006     void
5007 ex_cc(exarg_T *eap)
5008 {
5009     qf_info_T	*qi;
5010     int		errornr;
5011 
5012     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
5013 	return;
5014 
5015     if (eap->addr_count > 0)
5016 	errornr = (int)eap->line2;
5017     else
5018     {
5019 	switch (eap->cmdidx)
5020 	{
5021 	    case CMD_cc: case CMD_ll:
5022 		errornr = 0;
5023 		break;
5024 	    case CMD_crewind: case CMD_lrewind: case CMD_cfirst:
5025 	    case CMD_lfirst:
5026 		errornr = 1;
5027 		break;
5028 	    default:
5029 		errornr = 32767;
5030 	}
5031     }
5032 
5033     // For cdo and ldo commands, jump to the nth valid error.
5034     // For cfdo and lfdo commands, jump to the nth valid file entry.
5035     if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
5036 	    || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
5037 	errornr = qf_get_nth_valid_entry(qf_get_curlist(qi),
5038 		eap->addr_count > 0 ? (int)eap->line1 : 1,
5039 		eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo);
5040 
5041     qf_jump(qi, 0, errornr, eap->forceit);
5042 }
5043 
5044 /*
5045  * ":cnext", ":cnfile", ":cNext" and ":cprevious".
5046  * ":lnext", ":lNext", ":lprevious", ":lnfile", ":lNfile" and ":lpfile".
5047  * Also, used by ":cdo", ":ldo", ":cfdo" and ":lfdo" commands.
5048  */
5049     void
5050 ex_cnext(exarg_T *eap)
5051 {
5052     qf_info_T	*qi;
5053     int		errornr;
5054     int		dir;
5055 
5056     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
5057 	return;
5058 
5059     if (eap->addr_count > 0
5060 	    && (eap->cmdidx != CMD_cdo && eap->cmdidx != CMD_ldo
5061 		&& eap->cmdidx != CMD_cfdo && eap->cmdidx != CMD_lfdo))
5062 	errornr = (int)eap->line2;
5063     else
5064 	errornr = 1;
5065 
5066     // Depending on the command jump to either next or previous entry/file.
5067     switch (eap->cmdidx)
5068     {
5069 	case CMD_cnext: case CMD_lnext: case CMD_cdo: case CMD_ldo:
5070 	    dir = FORWARD;
5071 	    break;
5072 	case CMD_cprevious: case CMD_lprevious: case CMD_cNext:
5073 	case CMD_lNext:
5074 	    dir = BACKWARD;
5075 	    break;
5076 	case CMD_cnfile: case CMD_lnfile: case CMD_cfdo: case CMD_lfdo:
5077 	    dir = FORWARD_FILE;
5078 	    break;
5079 	case CMD_cpfile: case CMD_lpfile: case CMD_cNfile: case CMD_lNfile:
5080 	    dir = BACKWARD_FILE;
5081 	    break;
5082 	default:
5083 	    dir = FORWARD;
5084 	    break;
5085     }
5086 
5087     qf_jump(qi, dir, errornr, eap->forceit);
5088 }
5089 
5090 /*
5091  * Find the first entry in the quickfix list 'qfl' from buffer 'bnr'.
5092  * The index of the entry is stored in 'errornr'.
5093  * Returns NULL if an entry is not found.
5094  */
5095     static qfline_T *
5096 qf_find_first_entry_in_buf(qf_list_T *qfl, int bnr, int *errornr)
5097 {
5098     qfline_T	*qfp = NULL;
5099     int		idx = 0;
5100 
5101     // Find the first entry in this file
5102     FOR_ALL_QFL_ITEMS(qfl, qfp, idx)
5103 	if (qfp->qf_fnum == bnr)
5104 	    break;
5105 
5106     *errornr = idx;
5107     return qfp;
5108 }
5109 
5110 /*
5111  * Find the first quickfix entry on the same line as 'entry'. Updates 'errornr'
5112  * with the error number for the first entry. Assumes the entries are sorted in
5113  * the quickfix list by line number.
5114  */
5115     static qfline_T *
5116 qf_find_first_entry_on_line(qfline_T *entry, int *errornr)
5117 {
5118     while (!got_int
5119 	    && entry->qf_prev != NULL
5120 	    && entry->qf_fnum == entry->qf_prev->qf_fnum
5121 	    && entry->qf_lnum == entry->qf_prev->qf_lnum)
5122     {
5123 	entry = entry->qf_prev;
5124 	--*errornr;
5125     }
5126 
5127     return entry;
5128 }
5129 
5130 /*
5131  * Find the last quickfix entry on the same line as 'entry'. Updates 'errornr'
5132  * with the error number for the last entry. Assumes the entries are sorted in
5133  * the quickfix list by line number.
5134  */
5135     static qfline_T *
5136 qf_find_last_entry_on_line(qfline_T *entry, int *errornr)
5137 {
5138     while (!got_int &&
5139 	    entry->qf_next != NULL
5140 	    && entry->qf_fnum == entry->qf_next->qf_fnum
5141 	    && entry->qf_lnum == entry->qf_next->qf_lnum)
5142     {
5143 	entry = entry->qf_next;
5144 	++*errornr;
5145     }
5146 
5147     return entry;
5148 }
5149 
5150 /*
5151  * Returns TRUE if the specified quickfix entry is
5152  *   after the given line (linewise is TRUE)
5153  *   or after the line and column.
5154  */
5155     static int
5156 qf_entry_after_pos(qfline_T *qfp, pos_T *pos, int linewise)
5157 {
5158     if (linewise)
5159 	return qfp->qf_lnum > pos->lnum;
5160     else
5161 	return (qfp->qf_lnum > pos->lnum ||
5162 		(qfp->qf_lnum == pos->lnum && qfp->qf_col > pos->col));
5163 }
5164 
5165 /*
5166  * Returns TRUE if the specified quickfix entry is
5167  *   before the given line (linewise is TRUE)
5168  *   or before the line and column.
5169  */
5170     static int
5171 qf_entry_before_pos(qfline_T *qfp, pos_T *pos, int linewise)
5172 {
5173     if (linewise)
5174 	return qfp->qf_lnum < pos->lnum;
5175     else
5176 	return (qfp->qf_lnum < pos->lnum ||
5177 		(qfp->qf_lnum == pos->lnum && qfp->qf_col < pos->col));
5178 }
5179 
5180 /*
5181  * Returns TRUE if the specified quickfix entry is
5182  *   on or after the given line (linewise is TRUE)
5183  *   or on or after the line and column.
5184  */
5185     static int
5186 qf_entry_on_or_after_pos(qfline_T *qfp, pos_T *pos, int linewise)
5187 {
5188     if (linewise)
5189 	return qfp->qf_lnum >= pos->lnum;
5190     else
5191 	return (qfp->qf_lnum > pos->lnum ||
5192 		(qfp->qf_lnum == pos->lnum && qfp->qf_col >= pos->col));
5193 }
5194 
5195 /*
5196  * Returns TRUE if the specified quickfix entry is
5197  *   on or before the given line (linewise is TRUE)
5198  *   or on or before the line and column.
5199  */
5200     static int
5201 qf_entry_on_or_before_pos(qfline_T *qfp, pos_T *pos, int linewise)
5202 {
5203     if (linewise)
5204 	return qfp->qf_lnum <= pos->lnum;
5205     else
5206 	return (qfp->qf_lnum < pos->lnum ||
5207 		(qfp->qf_lnum == pos->lnum && qfp->qf_col <= pos->col));
5208 }
5209 
5210 /*
5211  * Find the first quickfix entry after position 'pos' in buffer 'bnr'.
5212  * If 'linewise' is TRUE, returns the entry after the specified line and treats
5213  * multiple entries on a single line as one. Otherwise returns the entry after
5214  * the specified line and column.
5215  * 'qfp' points to the very first entry in the buffer and 'errornr' is the
5216  * index of the very first entry in the quickfix list.
5217  * Returns NULL if an entry is not found after 'pos'.
5218  */
5219     static qfline_T *
5220 qf_find_entry_after_pos(
5221 	int		bnr,
5222 	pos_T		*pos,
5223 	int		linewise,
5224 	qfline_T	*qfp,
5225 	int		*errornr)
5226 {
5227     if (qf_entry_after_pos(qfp, pos, linewise))
5228 	// First entry is after postion 'pos'
5229 	return qfp;
5230 
5231     // Find the entry just before or at the position 'pos'
5232     while (qfp->qf_next != NULL
5233 	    && qfp->qf_next->qf_fnum == bnr
5234 	    && qf_entry_on_or_before_pos(qfp->qf_next, pos, linewise))
5235     {
5236 	qfp = qfp->qf_next;
5237 	++*errornr;
5238     }
5239 
5240     if (qfp->qf_next == NULL || qfp->qf_next->qf_fnum != bnr)
5241 	// No entries found after position 'pos'
5242 	return NULL;
5243 
5244     // Use the entry just after position 'pos'
5245     qfp = qfp->qf_next;
5246     ++*errornr;
5247 
5248     return qfp;
5249 }
5250 
5251 /*
5252  * Find the first quickfix entry before position 'pos' in buffer 'bnr'.
5253  * If 'linewise' is TRUE, returns the entry before the specified line and
5254  * treats multiple entries on a single line as one. Otherwise returns the entry
5255  * before the specified line and column.
5256  * 'qfp' points to the very first entry in the buffer and 'errornr' is the
5257  * index of the very first entry in the quickfix list.
5258  * Returns NULL if an entry is not found before 'pos'.
5259  */
5260     static qfline_T *
5261 qf_find_entry_before_pos(
5262 	int		bnr,
5263 	pos_T		*pos,
5264 	int		linewise,
5265 	qfline_T	*qfp,
5266 	int		*errornr)
5267 {
5268     // Find the entry just before the position 'pos'
5269     while (qfp->qf_next != NULL
5270 	    && qfp->qf_next->qf_fnum == bnr
5271 	    && qf_entry_before_pos(qfp->qf_next, pos, linewise))
5272     {
5273 	qfp = qfp->qf_next;
5274 	++*errornr;
5275     }
5276 
5277     if (qf_entry_on_or_after_pos(qfp, pos, linewise))
5278 	return NULL;
5279 
5280     if (linewise)
5281 	// If multiple entries are on the same line, then use the first entry
5282 	qfp = qf_find_first_entry_on_line(qfp, errornr);
5283 
5284     return qfp;
5285 }
5286 
5287 /*
5288  * Find a quickfix entry in 'qfl' closest to position 'pos' in buffer 'bnr' in
5289  * the direction 'dir'.
5290  */
5291     static qfline_T *
5292 qf_find_closest_entry(
5293 	qf_list_T	*qfl,
5294 	int		bnr,
5295 	pos_T		*pos,
5296 	int		dir,
5297 	int		linewise,
5298 	int		*errornr)
5299 {
5300     qfline_T	*qfp;
5301 
5302     *errornr = 0;
5303 
5304     // Find the first entry in this file
5305     qfp = qf_find_first_entry_in_buf(qfl, bnr, errornr);
5306     if (qfp == NULL)
5307 	return NULL;		// no entry in this file
5308 
5309     if (dir == FORWARD)
5310 	qfp = qf_find_entry_after_pos(bnr, pos, linewise, qfp, errornr);
5311     else
5312 	qfp = qf_find_entry_before_pos(bnr, pos, linewise, qfp, errornr);
5313 
5314     return qfp;
5315 }
5316 
5317 /*
5318  * Get the nth quickfix entry below the specified entry.  Searches forward in
5319  * the list. If linewise is TRUE, then treat multiple entries on a single line
5320  * as one.
5321  */
5322     static void
5323 qf_get_nth_below_entry(qfline_T *entry, int n, int linewise, int *errornr)
5324 {
5325     while (n-- > 0 && !got_int)
5326     {
5327 	qfline_T	*first_entry = entry;
5328 	int		first_errornr = *errornr;
5329 
5330 	if (linewise)
5331 	    // Treat all the entries on the same line in this file as one
5332 	    entry = qf_find_last_entry_on_line(entry, errornr);
5333 
5334 	if (entry->qf_next == NULL
5335 		|| entry->qf_next->qf_fnum != entry->qf_fnum)
5336 	{
5337 	    if (linewise)
5338 	    {
5339 		// If multiple entries are on the same line, then use the first
5340 		// entry
5341 		entry = first_entry;
5342 		*errornr = first_errornr;
5343 	    }
5344 	    break;
5345 	}
5346 
5347 	entry = entry->qf_next;
5348 	++*errornr;
5349     }
5350 }
5351 
5352 /*
5353  * Get the nth quickfix entry above the specified entry.  Searches backwards in
5354  * the list. If linewise is TRUE, then treat multiple entries on a single line
5355  * as one.
5356  */
5357     static void
5358 qf_get_nth_above_entry(qfline_T *entry, int n, int linewise, int *errornr)
5359 {
5360     while (n-- > 0 && !got_int)
5361     {
5362 	if (entry->qf_prev == NULL
5363 		|| entry->qf_prev->qf_fnum != entry->qf_fnum)
5364 	    break;
5365 
5366 	entry = entry->qf_prev;
5367 	--*errornr;
5368 
5369 	// If multiple entries are on the same line, then use the first entry
5370 	if (linewise)
5371 	    entry = qf_find_first_entry_on_line(entry, errornr);
5372     }
5373 }
5374 
5375 /*
5376  * Find the n'th quickfix entry adjacent to position 'pos' in buffer 'bnr' in
5377  * the specified direction.  Returns the error number in the quickfix list or 0
5378  * if an entry is not found.
5379  */
5380     static int
5381 qf_find_nth_adj_entry(
5382 	qf_list_T	*qfl,
5383 	int		bnr,
5384 	pos_T		*pos,
5385 	int		n,
5386 	int		dir,
5387 	int		linewise)
5388 {
5389     qfline_T	*adj_entry;
5390     int		errornr;
5391 
5392     // Find an entry closest to the specified position
5393     adj_entry = qf_find_closest_entry(qfl, bnr, pos, dir, linewise, &errornr);
5394     if (adj_entry == NULL)
5395 	return 0;
5396 
5397     if (--n > 0)
5398     {
5399 	// Go to the n'th entry in the current buffer
5400 	if (dir == FORWARD)
5401 	    qf_get_nth_below_entry(adj_entry, n, linewise, &errornr);
5402 	else
5403 	    qf_get_nth_above_entry(adj_entry, n, linewise, &errornr);
5404     }
5405 
5406     return errornr;
5407 }
5408 
5409 /*
5410  * Jump to a quickfix entry in the current file nearest to the current line or
5411  * current line/col.
5412  * ":cabove", ":cbelow", ":labove", ":lbelow", ":cafter", ":cbefore",
5413  * ":lafter" and ":lbefore" commands
5414  */
5415     void
5416 ex_cbelow(exarg_T *eap)
5417 {
5418     qf_info_T	*qi;
5419     qf_list_T	*qfl;
5420     int		dir;
5421     int		buf_has_flag;
5422     int		errornr = 0;
5423     pos_T	pos;
5424 
5425     if (eap->addr_count > 0 && eap->line2 <= 0)
5426     {
5427 	emsg(_(e_invrange));
5428 	return;
5429     }
5430 
5431     // Check whether the current buffer has any quickfix entries
5432     if (eap->cmdidx == CMD_cabove || eap->cmdidx == CMD_cbelow
5433 	    || eap->cmdidx == CMD_cbefore || eap->cmdidx == CMD_cafter)
5434 	buf_has_flag = BUF_HAS_QF_ENTRY;
5435     else
5436 	buf_has_flag = BUF_HAS_LL_ENTRY;
5437     if (!(curbuf->b_has_qf_entry & buf_has_flag))
5438     {
5439 	emsg(_(e_quickfix));
5440 	return;
5441     }
5442 
5443     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
5444 	return;
5445 
5446     qfl = qf_get_curlist(qi);
5447     // check if the list has valid errors
5448     if (!qf_list_has_valid_entries(qfl))
5449     {
5450 	emsg(_(e_quickfix));
5451 	return;
5452     }
5453 
5454     if (eap->cmdidx == CMD_cbelow
5455 	    || eap->cmdidx == CMD_lbelow
5456 	    || eap->cmdidx == CMD_cafter
5457 	    || eap->cmdidx == CMD_lafter)
5458 	// Forward motion commands
5459 	dir = FORWARD;
5460     else
5461 	dir = BACKWARD;
5462 
5463     pos = curwin->w_cursor;
5464     // A quickfix entry column number is 1 based whereas cursor column
5465     // number is 0 based. Adjust the column number.
5466     pos.col++;
5467     errornr = qf_find_nth_adj_entry(qfl, curbuf->b_fnum, &pos,
5468 				eap->addr_count > 0 ? eap->line2 : 0, dir,
5469 				eap->cmdidx == CMD_cbelow
5470 					|| eap->cmdidx == CMD_lbelow
5471 					|| eap->cmdidx == CMD_cabove
5472 					|| eap->cmdidx == CMD_labove);
5473 
5474     if (errornr > 0)
5475 	qf_jump(qi, 0, errornr, FALSE);
5476     else
5477 	emsg(_(e_no_more_items));
5478 }
5479 
5480 /*
5481  * Return the autocmd name for the :cfile Ex commands
5482  */
5483     static char_u *
5484 cfile_get_auname(cmdidx_T cmdidx)
5485 {
5486     switch (cmdidx)
5487     {
5488 	case CMD_cfile:	    return (char_u *)"cfile";
5489 	case CMD_cgetfile:  return (char_u *)"cgetfile";
5490 	case CMD_caddfile:  return (char_u *)"caddfile";
5491 	case CMD_lfile:	    return (char_u *)"lfile";
5492 	case CMD_lgetfile:  return (char_u *)"lgetfile";
5493 	case CMD_laddfile:  return (char_u *)"laddfile";
5494 	default:	    return NULL;
5495     }
5496 }
5497 
5498 /*
5499  * ":cfile"/":cgetfile"/":caddfile" commands.
5500  * ":lfile"/":lgetfile"/":laddfile" commands.
5501  */
5502     void
5503 ex_cfile(exarg_T *eap)
5504 {
5505     char_u	*enc = NULL;
5506     win_T	*wp = NULL;
5507     qf_info_T	*qi = &ql_info;
5508     char_u	*au_name = NULL;
5509     int_u	save_qfid = 0;		// init for gcc
5510     int		res;
5511 
5512     au_name = cfile_get_auname(eap->cmdidx);
5513     if (au_name != NULL)
5514 	apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name, NULL, FALSE, curbuf);
5515 
5516     enc = (*curbuf->b_p_menc != NUL) ? curbuf->b_p_menc : p_menc;
5517 #ifdef FEAT_BROWSE
5518     if (cmdmod.browse)
5519     {
5520 	char_u *browse_file = do_browse(0, (char_u *)_("Error file"), eap->arg,
5521 				   NULL, NULL,
5522 				   (char_u *)_(BROWSE_FILTER_ALL_FILES), NULL);
5523 	if (browse_file == NULL)
5524 	    return;
5525 	set_string_option_direct((char_u *)"ef", -1, browse_file, OPT_FREE, 0);
5526 	vim_free(browse_file);
5527     }
5528     else
5529 #endif
5530     if (*eap->arg != NUL)
5531 	set_string_option_direct((char_u *)"ef", -1, eap->arg, OPT_FREE, 0);
5532 
5533     if (is_loclist_cmd(eap->cmdidx))
5534 	wp = curwin;
5535 
5536     incr_quickfix_busy();
5537 
5538     // This function is used by the :cfile, :cgetfile and :caddfile
5539     // commands.
5540     // :cfile always creates a new quickfix list and jumps to the
5541     // first error.
5542     // :cgetfile creates a new quickfix list but doesn't jump to the
5543     // first error.
5544     // :caddfile adds to an existing quickfix list. If there is no
5545     // quickfix list then a new list is created.
5546     res = qf_init(wp, p_ef, p_efm, (eap->cmdidx != CMD_caddfile
5547 			&& eap->cmdidx != CMD_laddfile),
5548 			qf_cmdtitle(*eap->cmdlinep), enc);
5549     if (wp != NULL)
5550     {
5551 	qi = GET_LOC_LIST(wp);
5552 	if (qi == NULL)
5553 	{
5554 	    decr_quickfix_busy();
5555 	    return;
5556 	}
5557     }
5558     if (res >= 0)
5559 	qf_list_changed(qf_get_curlist(qi));
5560     save_qfid = qf_get_curlist(qi)->qf_id;
5561     if (au_name != NULL)
5562 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name, NULL, FALSE, curbuf);
5563 
5564     // Jump to the first error for a new list and if autocmds didn't
5565     // free the list.
5566     if (res > 0 && (eap->cmdidx == CMD_cfile || eap->cmdidx == CMD_lfile)
5567 	    && qflist_valid(wp, save_qfid))
5568 	// display the first error
5569 	qf_jump_first(qi, save_qfid, eap->forceit);
5570 
5571     decr_quickfix_busy();
5572 }
5573 
5574 /*
5575  * Return the vimgrep autocmd name.
5576  */
5577     static char_u *
5578 vgr_get_auname(cmdidx_T cmdidx)
5579 {
5580     switch (cmdidx)
5581     {
5582 	case CMD_vimgrep:     return (char_u *)"vimgrep";
5583 	case CMD_lvimgrep:    return (char_u *)"lvimgrep";
5584 	case CMD_vimgrepadd:  return (char_u *)"vimgrepadd";
5585 	case CMD_lvimgrepadd: return (char_u *)"lvimgrepadd";
5586 	case CMD_grep:	      return (char_u *)"grep";
5587 	case CMD_lgrep:	      return (char_u *)"lgrep";
5588 	case CMD_grepadd:     return (char_u *)"grepadd";
5589 	case CMD_lgrepadd:    return (char_u *)"lgrepadd";
5590 	default: return NULL;
5591     }
5592 }
5593 
5594 /*
5595  * Initialize the regmatch used by vimgrep for pattern "s".
5596  */
5597     static void
5598 vgr_init_regmatch(regmmatch_T *regmatch, char_u *s)
5599 {
5600     // Get the search pattern: either white-separated or enclosed in //
5601     regmatch->regprog = NULL;
5602 
5603     if (s == NULL || *s == NUL)
5604     {
5605 	// Pattern is empty, use last search pattern.
5606 	if (last_search_pat() == NULL)
5607 	{
5608 	    emsg(_(e_noprevre));
5609 	    return;
5610 	}
5611 	regmatch->regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
5612     }
5613     else
5614 	regmatch->regprog = vim_regcomp(s, RE_MAGIC);
5615 
5616     regmatch->rmm_ic = p_ic;
5617     regmatch->rmm_maxcol = 0;
5618 }
5619 
5620 /*
5621  * Display a file name when vimgrep is running.
5622  */
5623     static void
5624 vgr_display_fname(char_u *fname)
5625 {
5626     char_u	*p;
5627 
5628     msg_start();
5629     p = msg_strtrunc(fname, TRUE);
5630     if (p == NULL)
5631 	msg_outtrans(fname);
5632     else
5633     {
5634 	msg_outtrans(p);
5635 	vim_free(p);
5636     }
5637     msg_clr_eos();
5638     msg_didout = FALSE;	    // overwrite this message
5639     msg_nowait = TRUE;	    // don't wait for this message
5640     msg_col = 0;
5641     out_flush();
5642 }
5643 
5644 /*
5645  * Load a dummy buffer to search for a pattern using vimgrep.
5646  */
5647     static buf_T *
5648 vgr_load_dummy_buf(
5649 	char_u *fname,
5650 	char_u *dirname_start,
5651 	char_u *dirname_now)
5652 {
5653     int		save_mls;
5654 #if defined(FEAT_SYN_HL)
5655     char_u	*save_ei = NULL;
5656 #endif
5657     buf_T	*buf;
5658 
5659 #if defined(FEAT_SYN_HL)
5660     // Don't do Filetype autocommands to avoid loading syntax and
5661     // indent scripts, a great speed improvement.
5662     save_ei = au_event_disable(",Filetype");
5663 #endif
5664     // Don't use modelines here, it's useless.
5665     save_mls = p_mls;
5666     p_mls = 0;
5667 
5668     // Load file into a buffer, so that 'fileencoding' is detected,
5669     // autocommands applied, etc.
5670     buf = load_dummy_buffer(fname, dirname_start, dirname_now);
5671 
5672     p_mls = save_mls;
5673 #if defined(FEAT_SYN_HL)
5674     au_event_restore(save_ei);
5675 #endif
5676 
5677     return buf;
5678 }
5679 
5680 /*
5681  * Check whether a quickfix/location list is valid. Autocmds may remove or
5682  * change a quickfix list when vimgrep is running. If the list is not found,
5683  * create a new list.
5684  */
5685     static int
5686 vgr_qflist_valid(
5687 	win_T	    *wp,
5688 	qf_info_T   *qi,
5689 	int_u	    qfid,
5690 	char_u	    *title)
5691 {
5692     // Verify that the quickfix/location list was not freed by an autocmd
5693     if (!qflist_valid(wp, qfid))
5694     {
5695 	if (wp != NULL)
5696 	{
5697 	    // An autocmd has freed the location list.
5698 	    emsg(_(e_loc_list_changed));
5699 	    return FALSE;
5700 	}
5701 	else
5702 	{
5703 	    // Quickfix list is not found, create a new one.
5704 	    qf_new_list(qi, title);
5705 	    return TRUE;
5706 	}
5707     }
5708 
5709     if (qf_restore_list(qi, qfid) == FAIL)
5710 	return FALSE;
5711 
5712     return TRUE;
5713 }
5714 
5715 /*
5716  * Search for a pattern in all the lines in a buffer and add the matching lines
5717  * to a quickfix list.
5718  */
5719     static int
5720 vgr_match_buflines(
5721 	qf_list_T   *qfl,
5722 	char_u	    *fname,
5723 	buf_T	    *buf,
5724 	regmmatch_T *regmatch,
5725 	long	    *tomatch,
5726 	int	    duplicate_name,
5727 	int	    flags)
5728 {
5729     int		found_match = FALSE;
5730     long	lnum;
5731     colnr_T	col;
5732 
5733     for (lnum = 1; lnum <= buf->b_ml.ml_line_count && *tomatch > 0; ++lnum)
5734     {
5735 	col = 0;
5736 	while (vim_regexec_multi(regmatch, curwin, buf, lnum,
5737 		    col, NULL, NULL) > 0)
5738 	{
5739 	    // Pass the buffer number so that it gets used even for a
5740 	    // dummy buffer, unless duplicate_name is set, then the
5741 	    // buffer will be wiped out below.
5742 	    if (qf_add_entry(qfl,
5743 			NULL,       // dir
5744 			fname,
5745 			NULL,
5746 			duplicate_name ? 0 : buf->b_fnum,
5747 			ml_get_buf(buf,
5748 			    regmatch->startpos[0].lnum + lnum, FALSE),
5749 			regmatch->startpos[0].lnum + lnum,
5750 			regmatch->startpos[0].col + 1,
5751 			FALSE,      // vis_col
5752 			NULL,	    // search pattern
5753 			0,	    // nr
5754 			0,	    // type
5755 			TRUE	    // valid
5756 			) == QF_FAIL)
5757 	    {
5758 		got_int = TRUE;
5759 		break;
5760 	    }
5761 	    found_match = TRUE;
5762 	    if (--*tomatch == 0)
5763 		break;
5764 	    if ((flags & VGR_GLOBAL) == 0
5765 		    || regmatch->endpos[0].lnum > 0)
5766 		break;
5767 	    col = regmatch->endpos[0].col
5768 		+ (col == regmatch->endpos[0].col);
5769 	    if (col > (colnr_T)STRLEN(ml_get_buf(buf, lnum, FALSE)))
5770 		break;
5771 	}
5772 	line_breakcheck();
5773 	if (got_int)
5774 	    break;
5775     }
5776 
5777     return found_match;
5778 }
5779 
5780 /*
5781  * Jump to the first match and update the directory.
5782  */
5783     static void
5784 vgr_jump_to_match(
5785 	qf_info_T   *qi,
5786 	int	    forceit,
5787 	int	    *redraw_for_dummy,
5788 	buf_T	    *first_match_buf,
5789 	char_u	    *target_dir)
5790 {
5791     buf_T	*buf;
5792 
5793     buf = curbuf;
5794     qf_jump(qi, 0, 0, forceit);
5795     if (buf != curbuf)
5796 	// If we jumped to another buffer redrawing will already be
5797 	// taken care of.
5798 	*redraw_for_dummy = FALSE;
5799 
5800     // Jump to the directory used after loading the buffer.
5801     if (curbuf == first_match_buf && target_dir != NULL)
5802     {
5803 	exarg_T ea;
5804 
5805 	vim_memset(&ea, 0, sizeof(ea));
5806 	ea.arg = target_dir;
5807 	ea.cmdidx = CMD_lcd;
5808 	ex_cd(&ea);
5809     }
5810 }
5811 
5812 /*
5813  * ":vimgrep {pattern} file(s)"
5814  * ":vimgrepadd {pattern} file(s)"
5815  * ":lvimgrep {pattern} file(s)"
5816  * ":lvimgrepadd {pattern} file(s)"
5817  */
5818     void
5819 ex_vimgrep(exarg_T *eap)
5820 {
5821     regmmatch_T	regmatch;
5822     int		fcount;
5823     char_u	**fnames;
5824     char_u	*fname;
5825     char_u	*title;
5826     char_u	*s;
5827     char_u	*p;
5828     int		fi;
5829     qf_info_T	*qi;
5830     qf_list_T	*qfl;
5831     int_u	save_qfid;
5832     win_T	*wp = NULL;
5833     buf_T	*buf;
5834     int		duplicate_name = FALSE;
5835     int		using_dummy;
5836     int		redraw_for_dummy = FALSE;
5837     int		found_match;
5838     buf_T	*first_match_buf = NULL;
5839     time_t	seconds = 0;
5840     aco_save_T	aco;
5841     int		flags = 0;
5842     long	tomatch;
5843     char_u	*dirname_start = NULL;
5844     char_u	*dirname_now = NULL;
5845     char_u	*target_dir = NULL;
5846     char_u	*au_name =  NULL;
5847 
5848     au_name = vgr_get_auname(eap->cmdidx);
5849     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
5850 					       curbuf->b_fname, TRUE, curbuf))
5851     {
5852 #ifdef FEAT_EVAL
5853 	if (aborting())
5854 	    return;
5855 #endif
5856     }
5857 
5858     qi = qf_cmd_get_or_alloc_stack(eap, &wp);
5859     if (qi == NULL)
5860 	return;
5861 
5862     if (eap->addr_count > 0)
5863 	tomatch = eap->line2;
5864     else
5865 	tomatch = MAXLNUM;
5866 
5867     // Get the search pattern: either white-separated or enclosed in //
5868     regmatch.regprog = NULL;
5869     title = vim_strsave(qf_cmdtitle(*eap->cmdlinep));
5870     p = skip_vimgrep_pat(eap->arg, &s, &flags);
5871     if (p == NULL)
5872     {
5873 	emsg(_(e_invalpat));
5874 	goto theend;
5875     }
5876 
5877     vgr_init_regmatch(&regmatch, s);
5878     if (regmatch.regprog == NULL)
5879 	goto theend;
5880 
5881     p = skipwhite(p);
5882     if (*p == NUL)
5883     {
5884 	emsg(_("E683: File name missing or invalid pattern"));
5885 	goto theend;
5886     }
5887 
5888     if ((eap->cmdidx != CMD_grepadd && eap->cmdidx != CMD_lgrepadd
5889 		&& eap->cmdidx != CMD_vimgrepadd
5890 		&& eap->cmdidx != CMD_lvimgrepadd)
5891 					|| qf_stack_empty(qi))
5892 	// make place for a new list
5893 	qf_new_list(qi, title != NULL ? title : qf_cmdtitle(*eap->cmdlinep));
5894 
5895     // parse the list of arguments
5896     if (get_arglist_exp(p, &fcount, &fnames, TRUE) == FAIL)
5897 	goto theend;
5898     if (fcount == 0)
5899     {
5900 	emsg(_(e_nomatch));
5901 	goto theend;
5902     }
5903 
5904     dirname_start = alloc_id(MAXPATHL, aid_qf_dirname_start);
5905     dirname_now = alloc_id(MAXPATHL, aid_qf_dirname_now);
5906     if (dirname_start == NULL || dirname_now == NULL)
5907     {
5908 	FreeWild(fcount, fnames);
5909 	goto theend;
5910     }
5911 
5912     // Remember the current directory, because a BufRead autocommand that does
5913     // ":lcd %:p:h" changes the meaning of short path names.
5914     mch_dirname(dirname_start, MAXPATHL);
5915 
5916     incr_quickfix_busy();
5917 
5918     // Remember the current quickfix list identifier, so that we can check for
5919     // autocommands changing the current quickfix list.
5920     save_qfid = qf_get_curlist(qi)->qf_id;
5921 
5922     seconds = (time_t)0;
5923     for (fi = 0; fi < fcount && !got_int && tomatch > 0; ++fi)
5924     {
5925 	fname = shorten_fname1(fnames[fi]);
5926 	if (time(NULL) > seconds)
5927 	{
5928 	    // Display the file name every second or so, show the user we are
5929 	    // working on it.
5930 	    seconds = time(NULL);
5931 	    vgr_display_fname(fname);
5932 	}
5933 
5934 	buf = buflist_findname_exp(fnames[fi]);
5935 	if (buf == NULL || buf->b_ml.ml_mfp == NULL)
5936 	{
5937 	    // Remember that a buffer with this name already exists.
5938 	    duplicate_name = (buf != NULL);
5939 	    using_dummy = TRUE;
5940 	    redraw_for_dummy = TRUE;
5941 
5942 	    buf = vgr_load_dummy_buf(fname, dirname_start, dirname_now);
5943 	}
5944 	else
5945 	    // Use existing, loaded buffer.
5946 	    using_dummy = FALSE;
5947 
5948 	// Check whether the quickfix list is still valid. When loading a
5949 	// buffer above, autocommands might have changed the quickfix list.
5950 	if (!vgr_qflist_valid(wp, qi, save_qfid, qf_cmdtitle(*eap->cmdlinep)))
5951 	{
5952 	    FreeWild(fcount, fnames);
5953 	    decr_quickfix_busy();
5954 	    goto theend;
5955 	}
5956 	save_qfid = qf_get_curlist(qi)->qf_id;
5957 
5958 	if (buf == NULL)
5959 	{
5960 	    if (!got_int)
5961 		smsg(_("Cannot open file \"%s\""), fname);
5962 	}
5963 	else
5964 	{
5965 	    // Try for a match in all lines of the buffer.
5966 	    // For ":1vimgrep" look for first match only.
5967 	    found_match = vgr_match_buflines(qf_get_curlist(qi),
5968 		    fname, buf, &regmatch,
5969 		    &tomatch, duplicate_name, flags);
5970 
5971 	    if (using_dummy)
5972 	    {
5973 		if (found_match && first_match_buf == NULL)
5974 		    first_match_buf = buf;
5975 		if (duplicate_name)
5976 		{
5977 		    // Never keep a dummy buffer if there is another buffer
5978 		    // with the same name.
5979 		    wipe_dummy_buffer(buf, dirname_start);
5980 		    buf = NULL;
5981 		}
5982 		else if (!cmdmod.hide
5983 			    || buf->b_p_bh[0] == 'u'	// "unload"
5984 			    || buf->b_p_bh[0] == 'w'	// "wipe"
5985 			    || buf->b_p_bh[0] == 'd')	// "delete"
5986 		{
5987 		    // When no match was found we don't need to remember the
5988 		    // buffer, wipe it out.  If there was a match and it
5989 		    // wasn't the first one or we won't jump there: only
5990 		    // unload the buffer.
5991 		    // Ignore 'hidden' here, because it may lead to having too
5992 		    // many swap files.
5993 		    if (!found_match)
5994 		    {
5995 			wipe_dummy_buffer(buf, dirname_start);
5996 			buf = NULL;
5997 		    }
5998 		    else if (buf != first_match_buf || (flags & VGR_NOJUMP))
5999 		    {
6000 			unload_dummy_buffer(buf, dirname_start);
6001 			// Keeping the buffer, remove the dummy flag.
6002 			buf->b_flags &= ~BF_DUMMY;
6003 			buf = NULL;
6004 		    }
6005 		}
6006 
6007 		if (buf != NULL)
6008 		{
6009 		    // Keeping the buffer, remove the dummy flag.
6010 		    buf->b_flags &= ~BF_DUMMY;
6011 
6012 		    // If the buffer is still loaded we need to use the
6013 		    // directory we jumped to below.
6014 		    if (buf == first_match_buf
6015 			    && target_dir == NULL
6016 			    && STRCMP(dirname_start, dirname_now) != 0)
6017 			target_dir = vim_strsave(dirname_now);
6018 
6019 		    // The buffer is still loaded, the Filetype autocommands
6020 		    // need to be done now, in that buffer.  And the modelines
6021 		    // need to be done (again).  But not the window-local
6022 		    // options!
6023 		    aucmd_prepbuf(&aco, buf);
6024 #if defined(FEAT_SYN_HL)
6025 		    apply_autocmds(EVENT_FILETYPE, buf->b_p_ft,
6026 						     buf->b_fname, TRUE, buf);
6027 #endif
6028 		    do_modelines(OPT_NOWIN);
6029 		    aucmd_restbuf(&aco);
6030 		}
6031 	    }
6032 	}
6033     }
6034 
6035     FreeWild(fcount, fnames);
6036 
6037     qfl = qf_get_curlist(qi);
6038     qfl->qf_nonevalid = FALSE;
6039     qfl->qf_ptr = qfl->qf_start;
6040     qfl->qf_index = 1;
6041     qf_list_changed(qfl);
6042 
6043     qf_update_buffer(qi, NULL);
6044 
6045     if (au_name != NULL)
6046 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
6047 					       curbuf->b_fname, TRUE, curbuf);
6048     // The QuickFixCmdPost autocmd may free the quickfix list. Check the list
6049     // is still valid.
6050     if (!qflist_valid(wp, save_qfid)
6051 	    || qf_restore_list(qi, save_qfid) == FAIL)
6052     {
6053 	decr_quickfix_busy();
6054 	goto theend;
6055     }
6056 
6057     // Jump to first match.
6058     if (!qf_list_empty(qf_get_curlist(qi)))
6059     {
6060 	if ((flags & VGR_NOJUMP) == 0)
6061 	    vgr_jump_to_match(qi, eap->forceit, &redraw_for_dummy,
6062 		    first_match_buf, target_dir);
6063     }
6064     else
6065 	semsg(_(e_nomatch2), s);
6066 
6067     decr_quickfix_busy();
6068 
6069     // If we loaded a dummy buffer into the current window, the autocommands
6070     // may have messed up things, need to redraw and recompute folds.
6071     if (redraw_for_dummy)
6072     {
6073 #ifdef FEAT_FOLDING
6074 	foldUpdateAll(curwin);
6075 #else
6076 	redraw_later(NOT_VALID);
6077 #endif
6078     }
6079 
6080 theend:
6081     vim_free(title);
6082     vim_free(dirname_now);
6083     vim_free(dirname_start);
6084     vim_free(target_dir);
6085     vim_regfree(regmatch.regprog);
6086 }
6087 
6088 /*
6089  * Restore current working directory to "dirname_start" if they differ, taking
6090  * into account whether it is set locally or globally.
6091  */
6092     static void
6093 restore_start_dir(char_u *dirname_start)
6094 {
6095     char_u *dirname_now = alloc(MAXPATHL);
6096 
6097     if (NULL != dirname_now)
6098     {
6099 	mch_dirname(dirname_now, MAXPATHL);
6100 	if (STRCMP(dirname_start, dirname_now) != 0)
6101 	{
6102 	    // If the directory has changed, change it back by building up an
6103 	    // appropriate ex command and executing it.
6104 	    exarg_T ea;
6105 
6106 	    vim_memset(&ea, 0, sizeof(ea));
6107 	    ea.arg = dirname_start;
6108 	    ea.cmdidx = (curwin->w_localdir == NULL) ? CMD_cd : CMD_lcd;
6109 	    ex_cd(&ea);
6110 	}
6111 	vim_free(dirname_now);
6112     }
6113 }
6114 
6115 /*
6116  * Load file "fname" into a dummy buffer and return the buffer pointer,
6117  * placing the directory resulting from the buffer load into the
6118  * "resulting_dir" pointer. "resulting_dir" must be allocated by the caller
6119  * prior to calling this function. Restores directory to "dirname_start" prior
6120  * to returning, if autocmds or the 'autochdir' option have changed it.
6121  *
6122  * If creating the dummy buffer does not fail, must call unload_dummy_buffer()
6123  * or wipe_dummy_buffer() later!
6124  *
6125  * Returns NULL if it fails.
6126  */
6127     static buf_T *
6128 load_dummy_buffer(
6129     char_u	*fname,
6130     char_u	*dirname_start,  // in: old directory
6131     char_u	*resulting_dir)  // out: new directory
6132 {
6133     buf_T	*newbuf;
6134     bufref_T	newbufref;
6135     bufref_T	newbuf_to_wipe;
6136     int		failed = TRUE;
6137     aco_save_T	aco;
6138     int		readfile_result;
6139 
6140     // Allocate a buffer without putting it in the buffer list.
6141     newbuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6142     if (newbuf == NULL)
6143 	return NULL;
6144     set_bufref(&newbufref, newbuf);
6145 
6146     // Init the options.
6147     buf_copy_options(newbuf, BCO_ENTER | BCO_NOHELP);
6148 
6149     // need to open the memfile before putting the buffer in a window
6150     if (ml_open(newbuf) == OK)
6151     {
6152 	// Make sure this buffer isn't wiped out by autocommands.
6153 	++newbuf->b_locked;
6154 
6155 	// set curwin/curbuf to buf and save a few things
6156 	aucmd_prepbuf(&aco, newbuf);
6157 
6158 	// Need to set the filename for autocommands.
6159 	(void)setfname(curbuf, fname, NULL, FALSE);
6160 
6161 	// Create swap file now to avoid the ATTENTION message.
6162 	check_need_swap(TRUE);
6163 
6164 	// Remove the "dummy" flag, otherwise autocommands may not
6165 	// work.
6166 	curbuf->b_flags &= ~BF_DUMMY;
6167 
6168 	newbuf_to_wipe.br_buf = NULL;
6169 	readfile_result = readfile(fname, NULL,
6170 		    (linenr_T)0, (linenr_T)0, (linenr_T)MAXLNUM,
6171 		    NULL, READ_NEW | READ_DUMMY);
6172 	--newbuf->b_locked;
6173 	if (readfile_result == OK
6174 		&& !got_int
6175 		&& !(curbuf->b_flags & BF_NEW))
6176 	{
6177 	    failed = FALSE;
6178 	    if (curbuf != newbuf)
6179 	    {
6180 		// Bloody autocommands changed the buffer!  Can happen when
6181 		// using netrw and editing a remote file.  Use the current
6182 		// buffer instead, delete the dummy one after restoring the
6183 		// window stuff.
6184 		set_bufref(&newbuf_to_wipe, newbuf);
6185 		newbuf = curbuf;
6186 	    }
6187 	}
6188 
6189 	// restore curwin/curbuf and a few other things
6190 	aucmd_restbuf(&aco);
6191 	if (newbuf_to_wipe.br_buf != NULL && bufref_valid(&newbuf_to_wipe))
6192 	    wipe_buffer(newbuf_to_wipe.br_buf, FALSE);
6193 
6194 	// Add back the "dummy" flag, otherwise buflist_findname_stat() won't
6195 	// skip it.
6196 	newbuf->b_flags |= BF_DUMMY;
6197     }
6198 
6199     // When autocommands/'autochdir' option changed directory: go back.
6200     // Let the caller know what the resulting dir was first, in case it is
6201     // important.
6202     mch_dirname(resulting_dir, MAXPATHL);
6203     restore_start_dir(dirname_start);
6204 
6205     if (!bufref_valid(&newbufref))
6206 	return NULL;
6207     if (failed)
6208     {
6209 	wipe_dummy_buffer(newbuf, dirname_start);
6210 	return NULL;
6211     }
6212     return newbuf;
6213 }
6214 
6215 /*
6216  * Wipe out the dummy buffer that load_dummy_buffer() created. Restores
6217  * directory to "dirname_start" prior to returning, if autocmds or the
6218  * 'autochdir' option have changed it.
6219  */
6220     static void
6221 wipe_dummy_buffer(buf_T *buf, char_u *dirname_start)
6222 {
6223     if (curbuf != buf)		// safety check
6224     {
6225 #if defined(FEAT_EVAL)
6226 	cleanup_T   cs;
6227 
6228 	// Reset the error/interrupt/exception state here so that aborting()
6229 	// returns FALSE when wiping out the buffer.  Otherwise it doesn't
6230 	// work when got_int is set.
6231 	enter_cleanup(&cs);
6232 #endif
6233 
6234 	wipe_buffer(buf, FALSE);
6235 
6236 #if defined(FEAT_EVAL)
6237 	// Restore the error/interrupt/exception state if not discarded by a
6238 	// new aborting error, interrupt, or uncaught exception.
6239 	leave_cleanup(&cs);
6240 #endif
6241 	// When autocommands/'autochdir' option changed directory: go back.
6242 	restore_start_dir(dirname_start);
6243     }
6244 }
6245 
6246 /*
6247  * Unload the dummy buffer that load_dummy_buffer() created. Restores
6248  * directory to "dirname_start" prior to returning, if autocmds or the
6249  * 'autochdir' option have changed it.
6250  */
6251     static void
6252 unload_dummy_buffer(buf_T *buf, char_u *dirname_start)
6253 {
6254     if (curbuf != buf)		// safety check
6255     {
6256 	close_buffer(NULL, buf, DOBUF_UNLOAD, FALSE);
6257 
6258 	// When autocommands/'autochdir' option changed directory: go back.
6259 	restore_start_dir(dirname_start);
6260     }
6261 }
6262 
6263 #if defined(FEAT_EVAL) || defined(PROTO)
6264 /*
6265  * Copy the specified quickfix entry items into a new dict and appened the dict
6266  * to 'list'.  Returns OK on success.
6267  */
6268     static int
6269 get_qfline_items(qfline_T *qfp, list_T *list)
6270 {
6271     int		bufnum;
6272     dict_T	*dict;
6273     char_u	buf[2];
6274 
6275     // Handle entries with a non-existing buffer number.
6276     bufnum = qfp->qf_fnum;
6277     if (bufnum != 0 && (buflist_findnr(bufnum) == NULL))
6278 	bufnum = 0;
6279 
6280     if ((dict = dict_alloc()) == NULL)
6281 	return FAIL;
6282     if (list_append_dict(list, dict) == FAIL)
6283 	return FAIL;
6284 
6285     buf[0] = qfp->qf_type;
6286     buf[1] = NUL;
6287     if (dict_add_number(dict, "bufnr", (long)bufnum) == FAIL
6288 	    || dict_add_number(dict, "lnum",  (long)qfp->qf_lnum) == FAIL
6289 	    || dict_add_number(dict, "col",   (long)qfp->qf_col) == FAIL
6290 	    || dict_add_number(dict, "vcol",  (long)qfp->qf_viscol) == FAIL
6291 	    || dict_add_number(dict, "nr",    (long)qfp->qf_nr) == FAIL
6292 	    || dict_add_string(dict, "module", qfp->qf_module) == FAIL
6293 	    || dict_add_string(dict, "pattern", qfp->qf_pattern) == FAIL
6294 	    || dict_add_string(dict, "text", qfp->qf_text) == FAIL
6295 	    || dict_add_string(dict, "type", buf) == FAIL
6296 	    || dict_add_number(dict, "valid", (long)qfp->qf_valid) == FAIL)
6297 	return FAIL;
6298 
6299     return OK;
6300 }
6301 
6302 /*
6303  * Add each quickfix error to list "list" as a dictionary.
6304  * If qf_idx is -1, use the current list. Otherwise, use the specified list.
6305  */
6306     static int
6307 get_errorlist(qf_info_T *qi_arg, win_T *wp, int qf_idx, list_T *list)
6308 {
6309     qf_info_T	*qi = qi_arg;
6310     qf_list_T	*qfl;
6311     qfline_T	*qfp;
6312     int		i;
6313 
6314     if (qi == NULL)
6315     {
6316 	qi = &ql_info;
6317 	if (wp != NULL)
6318 	{
6319 	    qi = GET_LOC_LIST(wp);
6320 	    if (qi == NULL)
6321 		return FAIL;
6322 	}
6323     }
6324 
6325     if (qf_idx == INVALID_QFIDX)
6326 	qf_idx = qi->qf_curlist;
6327 
6328     if (qf_idx >= qi->qf_listcount)
6329 	return FAIL;
6330 
6331     qfl = qf_get_list(qi, qf_idx);
6332     if (qf_list_empty(qfl))
6333 	return FAIL;
6334 
6335     FOR_ALL_QFL_ITEMS(qfl, qfp, i)
6336     {
6337 	if (get_qfline_items(qfp, list) == FAIL)
6338 	    return FAIL;
6339     }
6340 
6341     return OK;
6342 }
6343 
6344 // Flags used by getqflist()/getloclist() to determine which fields to return.
6345 enum {
6346     QF_GETLIST_NONE	= 0x0,
6347     QF_GETLIST_TITLE	= 0x1,
6348     QF_GETLIST_ITEMS	= 0x2,
6349     QF_GETLIST_NR	= 0x4,
6350     QF_GETLIST_WINID	= 0x8,
6351     QF_GETLIST_CONTEXT	= 0x10,
6352     QF_GETLIST_ID	= 0x20,
6353     QF_GETLIST_IDX	= 0x40,
6354     QF_GETLIST_SIZE	= 0x80,
6355     QF_GETLIST_TICK	= 0x100,
6356     QF_GETLIST_FILEWINID	= 0x200,
6357     QF_GETLIST_QFBUFNR	= 0x400,
6358     QF_GETLIST_ALL	= 0x7FF,
6359 };
6360 
6361 /*
6362  * Parse text from 'di' and return the quickfix list items.
6363  * Existing quickfix lists are not modified.
6364  */
6365     static int
6366 qf_get_list_from_lines(dict_T *what, dictitem_T *di, dict_T *retdict)
6367 {
6368     int		status = FAIL;
6369     qf_info_T	*qi;
6370     char_u	*errorformat = p_efm;
6371     dictitem_T	*efm_di;
6372     list_T	*l;
6373 
6374     // Only a List value is supported
6375     if (di->di_tv.v_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
6376     {
6377 	// If errorformat is supplied then use it, otherwise use the 'efm'
6378 	// option setting
6379 	if ((efm_di = dict_find(what, (char_u *)"efm", -1)) != NULL)
6380 	{
6381 	    if (efm_di->di_tv.v_type != VAR_STRING ||
6382 		    efm_di->di_tv.vval.v_string == NULL)
6383 		return FAIL;
6384 	    errorformat = efm_di->di_tv.vval.v_string;
6385 	}
6386 
6387 	l = list_alloc();
6388 	if (l == NULL)
6389 	    return FAIL;
6390 
6391 	qi = qf_alloc_stack(QFLT_INTERNAL);
6392 	if (qi != NULL)
6393 	{
6394 	    if (qf_init_ext(qi, 0, NULL, NULL, &di->di_tv, errorformat,
6395 			TRUE, (linenr_T)0, (linenr_T)0, NULL, NULL) > 0)
6396 	    {
6397 		(void)get_errorlist(qi, NULL, 0, l);
6398 		qf_free(&qi->qf_lists[0]);
6399 	    }
6400 	    free(qi);
6401 	}
6402 	dict_add_list(retdict, "items", l);
6403 	status = OK;
6404     }
6405 
6406     return status;
6407 }
6408 
6409 /*
6410  * Return the quickfix/location list window identifier in the current tabpage.
6411  */
6412     static int
6413 qf_winid(qf_info_T *qi)
6414 {
6415     win_T	*win;
6416 
6417     // The quickfix window can be opened even if the quickfix list is not set
6418     // using ":copen". This is not true for location lists.
6419     if (qi == NULL)
6420 	return 0;
6421     win = qf_find_win(qi);
6422     if (win != NULL)
6423 	return win->w_id;
6424     return 0;
6425 }
6426 
6427 /*
6428  * Returns the number of the buffer displayed in the quickfix/location list
6429  * window. If there is no buffer associated with the list, then returns 0.
6430  */
6431     static int
6432 qf_getprop_qfbufnr(qf_info_T *qi, dict_T *retdict)
6433 {
6434     return dict_add_number(retdict, "qfbufnr",
6435 					(qi == NULL) ? 0 : qi->qf_bufnr);
6436 }
6437 
6438 /*
6439  * Convert the keys in 'what' to quickfix list property flags.
6440  */
6441     static int
6442 qf_getprop_keys2flags(dict_T *what, int loclist)
6443 {
6444     int		flags = QF_GETLIST_NONE;
6445 
6446     if (dict_find(what, (char_u *)"all", -1) != NULL)
6447     {
6448 	flags |= QF_GETLIST_ALL;
6449 	if (!loclist)
6450 	    // File window ID is applicable only to location list windows
6451 	    flags &= ~ QF_GETLIST_FILEWINID;
6452     }
6453 
6454     if (dict_find(what, (char_u *)"title", -1) != NULL)
6455 	flags |= QF_GETLIST_TITLE;
6456 
6457     if (dict_find(what, (char_u *)"nr", -1) != NULL)
6458 	flags |= QF_GETLIST_NR;
6459 
6460     if (dict_find(what, (char_u *)"winid", -1) != NULL)
6461 	flags |= QF_GETLIST_WINID;
6462 
6463     if (dict_find(what, (char_u *)"context", -1) != NULL)
6464 	flags |= QF_GETLIST_CONTEXT;
6465 
6466     if (dict_find(what, (char_u *)"id", -1) != NULL)
6467 	flags |= QF_GETLIST_ID;
6468 
6469     if (dict_find(what, (char_u *)"items", -1) != NULL)
6470 	flags |= QF_GETLIST_ITEMS;
6471 
6472     if (dict_find(what, (char_u *)"idx", -1) != NULL)
6473 	flags |= QF_GETLIST_IDX;
6474 
6475     if (dict_find(what, (char_u *)"size", -1) != NULL)
6476 	flags |= QF_GETLIST_SIZE;
6477 
6478     if (dict_find(what, (char_u *)"changedtick", -1) != NULL)
6479 	flags |= QF_GETLIST_TICK;
6480 
6481     if (loclist && dict_find(what, (char_u *)"filewinid", -1) != NULL)
6482 	flags |= QF_GETLIST_FILEWINID;
6483 
6484     if (dict_find(what, (char_u *)"qfbufnr", -1) != NULL)
6485 	flags |= QF_GETLIST_QFBUFNR;
6486 
6487     return flags;
6488 }
6489 
6490 /*
6491  * Return the quickfix list index based on 'nr' or 'id' in 'what'.
6492  * If 'nr' and 'id' are not present in 'what' then return the current
6493  * quickfix list index.
6494  * If 'nr' is zero then return the current quickfix list index.
6495  * If 'nr' is '$' then return the last quickfix list index.
6496  * If 'id' is present then return the index of the quickfix list with that id.
6497  * If 'id' is zero then return the quickfix list index specified by 'nr'.
6498  * Return -1, if quickfix list is not present or if the stack is empty.
6499  */
6500     static int
6501 qf_getprop_qfidx(qf_info_T *qi, dict_T *what)
6502 {
6503     int		qf_idx;
6504     dictitem_T	*di;
6505 
6506     qf_idx = qi->qf_curlist;	// default is the current list
6507     if ((di = dict_find(what, (char_u *)"nr", -1)) != NULL)
6508     {
6509 	// Use the specified quickfix/location list
6510 	if (di->di_tv.v_type == VAR_NUMBER)
6511 	{
6512 	    // for zero use the current list
6513 	    if (di->di_tv.vval.v_number != 0)
6514 	    {
6515 		qf_idx = di->di_tv.vval.v_number - 1;
6516 		if (qf_idx < 0 || qf_idx >= qi->qf_listcount)
6517 		    qf_idx = INVALID_QFIDX;
6518 	    }
6519 	}
6520 	else if (di->di_tv.v_type == VAR_STRING
6521 		&& di->di_tv.vval.v_string != NULL
6522 		&& STRCMP(di->di_tv.vval.v_string, "$") == 0)
6523 	    // Get the last quickfix list number
6524 	    qf_idx = qi->qf_listcount - 1;
6525 	else
6526 	    qf_idx = INVALID_QFIDX;
6527     }
6528 
6529     if ((di = dict_find(what, (char_u *)"id", -1)) != NULL)
6530     {
6531 	// Look for a list with the specified id
6532 	if (di->di_tv.v_type == VAR_NUMBER)
6533 	{
6534 	    // For zero, use the current list or the list specified by 'nr'
6535 	    if (di->di_tv.vval.v_number != 0)
6536 		qf_idx = qf_id2nr(qi, di->di_tv.vval.v_number);
6537 	}
6538 	else
6539 	    qf_idx = INVALID_QFIDX;
6540     }
6541 
6542     return qf_idx;
6543 }
6544 
6545 /*
6546  * Return default values for quickfix list properties in retdict.
6547  */
6548     static int
6549 qf_getprop_defaults(qf_info_T *qi, int flags, int locstack, dict_T *retdict)
6550 {
6551     int		status = OK;
6552 
6553     if (flags & QF_GETLIST_TITLE)
6554 	status = dict_add_string(retdict, "title", (char_u *)"");
6555     if ((status == OK) && (flags & QF_GETLIST_ITEMS))
6556     {
6557 	list_T	*l = list_alloc();
6558 	if (l != NULL)
6559 	    status = dict_add_list(retdict, "items", l);
6560 	else
6561 	    status = FAIL;
6562     }
6563     if ((status == OK) && (flags & QF_GETLIST_NR))
6564 	status = dict_add_number(retdict, "nr", 0);
6565     if ((status == OK) && (flags & QF_GETLIST_WINID))
6566 	status = dict_add_number(retdict, "winid", qf_winid(qi));
6567     if ((status == OK) && (flags & QF_GETLIST_CONTEXT))
6568 	status = dict_add_string(retdict, "context", (char_u *)"");
6569     if ((status == OK) && (flags & QF_GETLIST_ID))
6570 	status = dict_add_number(retdict, "id", 0);
6571     if ((status == OK) && (flags & QF_GETLIST_IDX))
6572 	status = dict_add_number(retdict, "idx", 0);
6573     if ((status == OK) && (flags & QF_GETLIST_SIZE))
6574 	status = dict_add_number(retdict, "size", 0);
6575     if ((status == OK) && (flags & QF_GETLIST_TICK))
6576 	status = dict_add_number(retdict, "changedtick", 0);
6577     if ((status == OK) && locstack && (flags & QF_GETLIST_FILEWINID))
6578 	status = dict_add_number(retdict, "filewinid", 0);
6579     if ((status == OK) && (flags & QF_GETLIST_QFBUFNR))
6580 	status = qf_getprop_qfbufnr(qi, retdict);
6581 
6582     return status;
6583 }
6584 
6585 /*
6586  * Return the quickfix list title as 'title' in retdict
6587  */
6588     static int
6589 qf_getprop_title(qf_list_T *qfl, dict_T *retdict)
6590 {
6591     return dict_add_string(retdict, "title", qfl->qf_title);
6592 }
6593 
6594 /*
6595  * Returns the identifier of the window used to display files from a location
6596  * list.  If there is no associated window, then returns 0. Useful only when
6597  * called from a location list window.
6598  */
6599     static int
6600 qf_getprop_filewinid(win_T *wp, qf_info_T *qi, dict_T *retdict)
6601 {
6602     int winid = 0;
6603 
6604     if (wp != NULL && IS_LL_WINDOW(wp))
6605     {
6606 	win_T	*ll_wp = qf_find_win_with_loclist(qi);
6607 	if (ll_wp != NULL)
6608 	    winid = ll_wp->w_id;
6609     }
6610 
6611     return dict_add_number(retdict, "filewinid", winid);
6612 }
6613 
6614 /*
6615  * Return the quickfix list items/entries as 'items' in retdict
6616  */
6617     static int
6618 qf_getprop_items(qf_info_T *qi, int qf_idx, dict_T *retdict)
6619 {
6620     int		status = OK;
6621     list_T	*l = list_alloc();
6622     if (l != NULL)
6623     {
6624 	(void)get_errorlist(qi, NULL, qf_idx, l);
6625 	dict_add_list(retdict, "items", l);
6626     }
6627     else
6628 	status = FAIL;
6629 
6630     return status;
6631 }
6632 
6633 /*
6634  * Return the quickfix list context (if any) as 'context' in retdict.
6635  */
6636     static int
6637 qf_getprop_ctx(qf_list_T *qfl, dict_T *retdict)
6638 {
6639     int		status;
6640     dictitem_T	*di;
6641 
6642     if (qfl->qf_ctx != NULL)
6643     {
6644 	di = dictitem_alloc((char_u *)"context");
6645 	if (di != NULL)
6646 	{
6647 	    copy_tv(qfl->qf_ctx, &di->di_tv);
6648 	    status = dict_add(retdict, di);
6649 	    if (status == FAIL)
6650 		dictitem_free(di);
6651 	}
6652 	else
6653 	    status = FAIL;
6654     }
6655     else
6656 	status = dict_add_string(retdict, "context", (char_u *)"");
6657 
6658     return status;
6659 }
6660 
6661 /*
6662  * Return the current quickfix list index as 'idx' in retdict
6663  */
6664     static int
6665 qf_getprop_idx(qf_list_T *qfl, dict_T *retdict)
6666 {
6667     int curidx = qfl->qf_index;
6668     if (qf_list_empty(qfl))
6669 	// For empty lists, current index is set to 0
6670 	curidx = 0;
6671     return dict_add_number(retdict, "idx", curidx);
6672 }
6673 
6674 /*
6675  * Return quickfix/location list details (title) as a
6676  * dictionary. 'what' contains the details to return. If 'list_idx' is -1,
6677  * then current list is used. Otherwise the specified list is used.
6678  */
6679     static int
6680 qf_get_properties(win_T *wp, dict_T *what, dict_T *retdict)
6681 {
6682     qf_info_T	*qi = &ql_info;
6683     qf_list_T	*qfl;
6684     int		status = OK;
6685     int		qf_idx = INVALID_QFIDX;
6686     dictitem_T	*di;
6687     int		flags = QF_GETLIST_NONE;
6688 
6689     if ((di = dict_find(what, (char_u *)"lines", -1)) != NULL)
6690 	return qf_get_list_from_lines(what, di, retdict);
6691 
6692     if (wp != NULL)
6693 	qi = GET_LOC_LIST(wp);
6694 
6695     flags = qf_getprop_keys2flags(what, (wp != NULL));
6696 
6697     if (!qf_stack_empty(qi))
6698 	qf_idx = qf_getprop_qfidx(qi, what);
6699 
6700     // List is not present or is empty
6701     if (qf_stack_empty(qi) || qf_idx == INVALID_QFIDX)
6702 	return qf_getprop_defaults(qi, flags, wp != NULL, retdict);
6703 
6704     qfl = qf_get_list(qi, qf_idx);
6705 
6706     if (flags & QF_GETLIST_TITLE)
6707 	status = qf_getprop_title(qfl, retdict);
6708     if ((status == OK) && (flags & QF_GETLIST_NR))
6709 	status = dict_add_number(retdict, "nr", qf_idx + 1);
6710     if ((status == OK) && (flags & QF_GETLIST_WINID))
6711 	status = dict_add_number(retdict, "winid", qf_winid(qi));
6712     if ((status == OK) && (flags & QF_GETLIST_ITEMS))
6713 	status = qf_getprop_items(qi, qf_idx, retdict);
6714     if ((status == OK) && (flags & QF_GETLIST_CONTEXT))
6715 	status = qf_getprop_ctx(qfl, retdict);
6716     if ((status == OK) && (flags & QF_GETLIST_ID))
6717 	status = dict_add_number(retdict, "id", qfl->qf_id);
6718     if ((status == OK) && (flags & QF_GETLIST_IDX))
6719 	status = qf_getprop_idx(qfl, retdict);
6720     if ((status == OK) && (flags & QF_GETLIST_SIZE))
6721 	status = dict_add_number(retdict, "size", qfl->qf_count);
6722     if ((status == OK) && (flags & QF_GETLIST_TICK))
6723 	status = dict_add_number(retdict, "changedtick", qfl->qf_changedtick);
6724     if ((status == OK) && (wp != NULL) && (flags & QF_GETLIST_FILEWINID))
6725 	status = qf_getprop_filewinid(wp, qi, retdict);
6726     if ((status == OK) && (flags & QF_GETLIST_QFBUFNR))
6727 	status = qf_getprop_qfbufnr(qi, retdict);
6728 
6729     return status;
6730 }
6731 
6732 /*
6733  * Add a new quickfix entry to list at 'qf_idx' in the stack 'qi' from the
6734  * items in the dict 'd'. If it is a valid error entry, then set 'valid_entry'
6735  * to TRUE.
6736  */
6737     static int
6738 qf_add_entry_from_dict(
6739 	qf_list_T	*qfl,
6740 	dict_T		*d,
6741 	int		first_entry,
6742 	int		*valid_entry)
6743 {
6744     static int	did_bufnr_emsg;
6745     char_u	*filename, *module, *pattern, *text, *type;
6746     int		bufnum, valid, status, col, vcol, nr;
6747     long	lnum;
6748 
6749     if (first_entry)
6750 	did_bufnr_emsg = FALSE;
6751 
6752     filename = dict_get_string(d, (char_u *)"filename", TRUE);
6753     module = dict_get_string(d, (char_u *)"module", TRUE);
6754     bufnum = (int)dict_get_number(d, (char_u *)"bufnr");
6755     lnum = (int)dict_get_number(d, (char_u *)"lnum");
6756     col = (int)dict_get_number(d, (char_u *)"col");
6757     vcol = (int)dict_get_number(d, (char_u *)"vcol");
6758     nr = (int)dict_get_number(d, (char_u *)"nr");
6759     type = dict_get_string(d, (char_u *)"type", TRUE);
6760     pattern = dict_get_string(d, (char_u *)"pattern", TRUE);
6761     text = dict_get_string(d, (char_u *)"text", TRUE);
6762     if (text == NULL)
6763 	text = vim_strsave((char_u *)"");
6764 
6765     valid = TRUE;
6766     if ((filename == NULL && bufnum == 0) || (lnum == 0 && pattern == NULL))
6767 	valid = FALSE;
6768 
6769     // Mark entries with non-existing buffer number as not valid. Give the
6770     // error message only once.
6771     if (bufnum != 0 && (buflist_findnr(bufnum) == NULL))
6772     {
6773 	if (!did_bufnr_emsg)
6774 	{
6775 	    did_bufnr_emsg = TRUE;
6776 	    semsg(_("E92: Buffer %d not found"), bufnum);
6777 	}
6778 	valid = FALSE;
6779 	bufnum = 0;
6780     }
6781 
6782     // If the 'valid' field is present it overrules the detected value.
6783     if ((dict_find(d, (char_u *)"valid", -1)) != NULL)
6784 	valid = (int)dict_get_number(d, (char_u *)"valid");
6785 
6786     status =  qf_add_entry(qfl,
6787 			NULL,		// dir
6788 			filename,
6789 			module,
6790 			bufnum,
6791 			text,
6792 			lnum,
6793 			col,
6794 			vcol,		// vis_col
6795 			pattern,	// search pattern
6796 			nr,
6797 			type == NULL ? NUL : *type,
6798 			valid);
6799 
6800     vim_free(filename);
6801     vim_free(module);
6802     vim_free(pattern);
6803     vim_free(text);
6804     vim_free(type);
6805 
6806     if (valid)
6807 	*valid_entry = TRUE;
6808 
6809     return status;
6810 }
6811 
6812 /*
6813  * Add list of entries to quickfix/location list. Each list entry is
6814  * a dictionary with item information.
6815  */
6816     static int
6817 qf_add_entries(
6818 	qf_info_T	*qi,
6819 	int		qf_idx,
6820 	list_T		*list,
6821 	char_u		*title,
6822 	int		action)
6823 {
6824     qf_list_T	*qfl = qf_get_list(qi, qf_idx);
6825     listitem_T	*li;
6826     dict_T	*d;
6827     qfline_T	*old_last = NULL;
6828     int		retval = OK;
6829     int		valid_entry = FALSE;
6830 
6831     if (action == ' ' || qf_idx == qi->qf_listcount)
6832     {
6833 	// make place for a new list
6834 	qf_new_list(qi, title);
6835 	qf_idx = qi->qf_curlist;
6836 	qfl = qf_get_list(qi, qf_idx);
6837     }
6838     else if (action == 'a' && !qf_list_empty(qfl))
6839 	// Adding to existing list, use last entry.
6840 	old_last = qfl->qf_last;
6841     else if (action == 'r')
6842     {
6843 	qf_free_items(qfl);
6844 	qf_store_title(qfl, title);
6845     }
6846 
6847     for (li = list->lv_first; li != NULL; li = li->li_next)
6848     {
6849 	if (li->li_tv.v_type != VAR_DICT)
6850 	    continue; // Skip non-dict items
6851 
6852 	d = li->li_tv.vval.v_dict;
6853 	if (d == NULL)
6854 	    continue;
6855 
6856 	retval = qf_add_entry_from_dict(qfl, d, li == list->lv_first,
6857 								&valid_entry);
6858 	if (retval == QF_FAIL)
6859 	    break;
6860     }
6861 
6862     // Check if any valid error entries are added to the list.
6863     if (valid_entry)
6864 	qfl->qf_nonevalid = FALSE;
6865     else if (qfl->qf_index == 0)
6866 	// no valid entry
6867 	qfl->qf_nonevalid = TRUE;
6868 
6869     // If not appending to the list, set the current error to the first entry
6870     if (action != 'a')
6871 	qfl->qf_ptr = qfl->qf_start;
6872 
6873     // Update the current error index if not appending to the list or if the
6874     // list was empty before and it is not empty now.
6875     if ((action != 'a' || qfl->qf_index == 0) && !qf_list_empty(qfl))
6876 	qfl->qf_index = 1;
6877 
6878     // Don't update the cursor in quickfix window when appending entries
6879     qf_update_buffer(qi, old_last);
6880 
6881     return retval;
6882 }
6883 
6884 /*
6885  * Get the quickfix list index from 'nr' or 'id'
6886  */
6887     static int
6888 qf_setprop_get_qfidx(
6889 	qf_info_T	*qi,
6890 	dict_T		*what,
6891 	int		action,
6892 	int		*newlist)
6893 {
6894     dictitem_T	*di;
6895     int		qf_idx = qi->qf_curlist;    // default is the current list
6896 
6897     if ((di = dict_find(what, (char_u *)"nr", -1)) != NULL)
6898     {
6899 	// Use the specified quickfix/location list
6900 	if (di->di_tv.v_type == VAR_NUMBER)
6901 	{
6902 	    // for zero use the current list
6903 	    if (di->di_tv.vval.v_number != 0)
6904 		qf_idx = di->di_tv.vval.v_number - 1;
6905 
6906 	    if ((action == ' ' || action == 'a') && qf_idx == qi->qf_listcount)
6907 	    {
6908 		// When creating a new list, accept qf_idx pointing to the next
6909 		// non-available list and add the new list at the end of the
6910 		// stack.
6911 		*newlist = TRUE;
6912 		qf_idx = qf_stack_empty(qi) ? 0 : qi->qf_listcount - 1;
6913 	    }
6914 	    else if (qf_idx < 0 || qf_idx >= qi->qf_listcount)
6915 		return INVALID_QFIDX;
6916 	    else if (action != ' ')
6917 		*newlist = FALSE;	// use the specified list
6918 	}
6919 	else if (di->di_tv.v_type == VAR_STRING
6920 		&& di->di_tv.vval.v_string != NULL
6921 		&& STRCMP(di->di_tv.vval.v_string, "$") == 0)
6922 	{
6923 	    if (!qf_stack_empty(qi))
6924 		qf_idx = qi->qf_listcount - 1;
6925 	    else if (*newlist)
6926 		qf_idx = 0;
6927 	    else
6928 		return INVALID_QFIDX;
6929 	}
6930 	else
6931 	    return INVALID_QFIDX;
6932     }
6933 
6934     if (!*newlist && (di = dict_find(what, (char_u *)"id", -1)) != NULL)
6935     {
6936 	// Use the quickfix/location list with the specified id
6937 	if (di->di_tv.v_type != VAR_NUMBER)
6938 	    return INVALID_QFIDX;
6939 
6940 	return qf_id2nr(qi, di->di_tv.vval.v_number);
6941     }
6942 
6943     return qf_idx;
6944 }
6945 
6946 /*
6947  * Set the quickfix list title.
6948  */
6949     static int
6950 qf_setprop_title(qf_info_T *qi, int qf_idx, dict_T *what, dictitem_T *di)
6951 {
6952     qf_list_T	*qfl = qf_get_list(qi, qf_idx);
6953 
6954     if (di->di_tv.v_type != VAR_STRING)
6955 	return FAIL;
6956 
6957     vim_free(qfl->qf_title);
6958     qfl->qf_title = dict_get_string(what, (char_u *)"title", TRUE);
6959     if (qf_idx == qi->qf_curlist)
6960 	qf_update_win_titlevar(qi);
6961 
6962     return OK;
6963 }
6964 
6965 /*
6966  * Set quickfix list items/entries.
6967  */
6968     static int
6969 qf_setprop_items(qf_info_T *qi, int qf_idx, dictitem_T *di, int action)
6970 {
6971     int		retval = FAIL;
6972     char_u	*title_save;
6973 
6974     if (di->di_tv.v_type != VAR_LIST)
6975 	return FAIL;
6976 
6977     title_save = vim_strsave(qi->qf_lists[qf_idx].qf_title);
6978     retval = qf_add_entries(qi, qf_idx, di->di_tv.vval.v_list,
6979 	    title_save, action == ' ' ? 'a' : action);
6980     vim_free(title_save);
6981 
6982     return retval;
6983 }
6984 
6985 /*
6986  * Set quickfix list items/entries from a list of lines.
6987  */
6988     static int
6989 qf_setprop_items_from_lines(
6990 	qf_info_T	*qi,
6991 	int		qf_idx,
6992 	dict_T		*what,
6993 	dictitem_T	*di,
6994 	int		action)
6995 {
6996     char_u	*errorformat = p_efm;
6997     dictitem_T	*efm_di;
6998     int		retval = FAIL;
6999 
7000     // Use the user supplied errorformat settings (if present)
7001     if ((efm_di = dict_find(what, (char_u *)"efm", -1)) != NULL)
7002     {
7003 	if (efm_di->di_tv.v_type != VAR_STRING ||
7004 		efm_di->di_tv.vval.v_string == NULL)
7005 	    return FAIL;
7006 	errorformat = efm_di->di_tv.vval.v_string;
7007     }
7008 
7009     // Only a List value is supported
7010     if (di->di_tv.v_type != VAR_LIST || di->di_tv.vval.v_list == NULL)
7011 	return FAIL;
7012 
7013     if (action == 'r')
7014 	qf_free_items(&qi->qf_lists[qf_idx]);
7015     if (qf_init_ext(qi, qf_idx, NULL, NULL, &di->di_tv, errorformat,
7016 		FALSE, (linenr_T)0, (linenr_T)0, NULL, NULL) > 0)
7017 	retval = OK;
7018 
7019     return retval;
7020 }
7021 
7022 /*
7023  * Set quickfix list context.
7024  */
7025     static int
7026 qf_setprop_context(qf_list_T *qfl, dictitem_T *di)
7027 {
7028     typval_T	*ctx;
7029 
7030     free_tv(qfl->qf_ctx);
7031     ctx =  alloc_tv();
7032     if (ctx != NULL)
7033 	copy_tv(&di->di_tv, ctx);
7034     qfl->qf_ctx = ctx;
7035 
7036     return OK;
7037 }
7038 
7039 /*
7040  * Set the current index in the specified quickfix list
7041  */
7042     static int
7043 qf_setprop_curidx(qf_info_T *qi, qf_list_T *qfl, dictitem_T *di)
7044 {
7045     int		denote = FALSE;
7046     int		newidx;
7047     int		old_qfidx;
7048     qfline_T	*qf_ptr;
7049 
7050     // If the specified index is '$', then use the last entry
7051     if (di->di_tv.v_type == VAR_STRING
7052 	    && di->di_tv.vval.v_string != NULL
7053 	    && STRCMP(di->di_tv.vval.v_string, "$") == 0)
7054 	newidx = qfl->qf_count;
7055     else
7056     {
7057 	// Otherwise use the specified index
7058 	newidx = tv_get_number_chk(&di->di_tv, &denote);
7059 	if (denote)
7060 	    return FAIL;
7061     }
7062 
7063     if (newidx < 1)		// sanity check
7064 	return FAIL;
7065     if (newidx > qfl->qf_count)
7066 	newidx = qfl->qf_count;
7067 
7068     old_qfidx = qfl->qf_index;
7069     qf_ptr = get_nth_entry(qfl, newidx, &newidx);
7070     if (qf_ptr == NULL)
7071 	return FAIL;
7072     qfl->qf_ptr = qf_ptr;
7073     qfl->qf_index = newidx;
7074 
7075     // If the current list is modified and it is displayed in the quickfix
7076     // window, then Update it.
7077     if (qf_get_curlist(qi)->qf_id == qfl->qf_id)
7078 	qf_win_pos_update(qi, old_qfidx);
7079 
7080     return OK;
7081 }
7082 
7083 /*
7084  * Set quickfix/location list properties (title, items, context).
7085  * Also used to add items from parsing a list of lines.
7086  * Used by the setqflist() and setloclist() Vim script functions.
7087  */
7088     static int
7089 qf_set_properties(qf_info_T *qi, dict_T *what, int action, char_u *title)
7090 {
7091     dictitem_T	*di;
7092     int		retval = FAIL;
7093     int		qf_idx;
7094     int		newlist = FALSE;
7095     qf_list_T	*qfl;
7096 
7097     if (action == ' ' || qf_stack_empty(qi))
7098 	newlist = TRUE;
7099 
7100     qf_idx = qf_setprop_get_qfidx(qi, what, action, &newlist);
7101     if (qf_idx == INVALID_QFIDX)	// List not found
7102 	return FAIL;
7103 
7104     if (newlist)
7105     {
7106 	qi->qf_curlist = qf_idx;
7107 	qf_new_list(qi, title);
7108 	qf_idx = qi->qf_curlist;
7109     }
7110 
7111     qfl = qf_get_list(qi, qf_idx);
7112     if ((di = dict_find(what, (char_u *)"title", -1)) != NULL)
7113 	retval = qf_setprop_title(qi, qf_idx, what, di);
7114     if ((di = dict_find(what, (char_u *)"items", -1)) != NULL)
7115 	retval = qf_setprop_items(qi, qf_idx, di, action);
7116     if ((di = dict_find(what, (char_u *)"lines", -1)) != NULL)
7117 	retval = qf_setprop_items_from_lines(qi, qf_idx, what, di, action);
7118     if ((di = dict_find(what, (char_u *)"context", -1)) != NULL)
7119 	retval = qf_setprop_context(qfl, di);
7120     if ((di = dict_find(what, (char_u *)"idx", -1)) != NULL)
7121 	retval = qf_setprop_curidx(qi, qfl, di);
7122 
7123     if (retval == OK)
7124 	qf_list_changed(qfl);
7125 
7126     return retval;
7127 }
7128 
7129 /*
7130  * Free the entire quickfix/location list stack.
7131  * If the quickfix/location list window is open, then clear it.
7132  */
7133     static void
7134 qf_free_stack(win_T *wp, qf_info_T *qi)
7135 {
7136     win_T	*qfwin = qf_find_win(qi);
7137     win_T	*llwin = NULL;
7138 
7139     if (qfwin != NULL)
7140     {
7141 	// If the quickfix/location list window is open, then clear it
7142 	if (qi->qf_curlist < qi->qf_listcount)
7143 	    qf_free(qf_get_curlist(qi));
7144 	qf_update_buffer(qi, NULL);
7145     }
7146 
7147     if (wp != NULL && IS_LL_WINDOW(wp))
7148     {
7149 	// If in the location list window, then use the non-location list
7150 	// window with this location list (if present)
7151 	llwin = qf_find_win_with_loclist(qi);
7152 	if (llwin != NULL)
7153 	    wp = llwin;
7154     }
7155 
7156     qf_free_all(wp);
7157     if (wp == NULL)
7158     {
7159 	// quickfix list
7160 	qi->qf_curlist = 0;
7161 	qi->qf_listcount = 0;
7162     }
7163     else if (qfwin != NULL)
7164     {
7165 	// If the location list window is open, then create a new empty
7166 	// location list
7167 	qf_info_T *new_ll = qf_alloc_stack(QFLT_LOCATION);
7168 
7169 	if (new_ll != NULL)
7170 	{
7171 	    new_ll->qf_bufnr = qfwin->w_buffer->b_fnum;
7172 
7173 	    // first free the list reference in the location list window
7174 	    ll_free_all(&qfwin->w_llist_ref);
7175 
7176 	    qfwin->w_llist_ref = new_ll;
7177 	    if (wp != qfwin)
7178 		win_set_loclist(wp, new_ll);
7179 	}
7180     }
7181 }
7182 
7183 /*
7184  * Populate the quickfix list with the items supplied in the list
7185  * of dictionaries. "title" will be copied to w:quickfix_title.
7186  * "action" is 'a' for add, 'r' for replace.  Otherwise create a new list.
7187  */
7188     int
7189 set_errorlist(
7190 	win_T	*wp,
7191 	list_T	*list,
7192 	int	action,
7193 	char_u	*title,
7194 	dict_T	*what)
7195 {
7196     qf_info_T	*qi = &ql_info;
7197     int		retval = OK;
7198 
7199     if (wp != NULL)
7200     {
7201 	qi = ll_get_or_alloc_list(wp);
7202 	if (qi == NULL)
7203 	    return FAIL;
7204     }
7205 
7206     if (action == 'f')
7207     {
7208 	// Free the entire quickfix or location list stack
7209 	qf_free_stack(wp, qi);
7210 	return OK;
7211     }
7212 
7213     incr_quickfix_busy();
7214 
7215     if (what != NULL)
7216 	retval = qf_set_properties(qi, what, action, title);
7217     else
7218     {
7219 	retval = qf_add_entries(qi, qi->qf_curlist, list, title, action);
7220 	if (retval == OK)
7221 	    qf_list_changed(qf_get_curlist(qi));
7222     }
7223 
7224     decr_quickfix_busy();
7225 
7226     return retval;
7227 }
7228 
7229 /*
7230  * Mark the context as in use for all the lists in a quickfix stack.
7231  */
7232     static int
7233 mark_quickfix_ctx(qf_info_T *qi, int copyID)
7234 {
7235     int		i;
7236     int		abort = FALSE;
7237     typval_T	*ctx;
7238 
7239     for (i = 0; i < LISTCOUNT && !abort; ++i)
7240     {
7241 	ctx = qi->qf_lists[i].qf_ctx;
7242 	if (ctx != NULL && ctx->v_type != VAR_NUMBER
7243 		&& ctx->v_type != VAR_STRING && ctx->v_type != VAR_FLOAT)
7244 	    abort = set_ref_in_item(ctx, copyID, NULL, NULL);
7245     }
7246 
7247     return abort;
7248 }
7249 
7250 /*
7251  * Mark the context of the quickfix list and the location lists (if present) as
7252  * "in use". So that garbage collection doesn't free the context.
7253  */
7254     int
7255 set_ref_in_quickfix(int copyID)
7256 {
7257     int		abort = FALSE;
7258     tabpage_T	*tp;
7259     win_T	*win;
7260 
7261     abort = mark_quickfix_ctx(&ql_info, copyID);
7262     if (abort)
7263 	return abort;
7264 
7265     FOR_ALL_TAB_WINDOWS(tp, win)
7266     {
7267 	if (win->w_llist != NULL)
7268 	{
7269 	    abort = mark_quickfix_ctx(win->w_llist, copyID);
7270 	    if (abort)
7271 		return abort;
7272 	}
7273 	if (IS_LL_WINDOW(win) && (win->w_llist_ref->qf_refcount == 1))
7274 	{
7275 	    // In a location list window and none of the other windows is
7276 	    // referring to this location list. Mark the location list
7277 	    // context as still in use.
7278 	    abort = mark_quickfix_ctx(win->w_llist_ref, copyID);
7279 	    if (abort)
7280 		return abort;
7281 	}
7282     }
7283 
7284     return abort;
7285 }
7286 #endif
7287 
7288 /*
7289  * Return the autocmd name for the :cbuffer Ex commands
7290  */
7291     static char_u *
7292 cbuffer_get_auname(cmdidx_T cmdidx)
7293 {
7294     switch (cmdidx)
7295     {
7296 	case CMD_cbuffer:	return (char_u *)"cbuffer";
7297 	case CMD_cgetbuffer:	return (char_u *)"cgetbuffer";
7298 	case CMD_caddbuffer:	return (char_u *)"caddbuffer";
7299 	case CMD_lbuffer:	return (char_u *)"lbuffer";
7300 	case CMD_lgetbuffer:	return (char_u *)"lgetbuffer";
7301 	case CMD_laddbuffer:	return (char_u *)"laddbuffer";
7302 	default:		return NULL;
7303     }
7304 }
7305 
7306 /*
7307  * Process and validate the arguments passed to the :cbuffer, :caddbuffer,
7308  * :cgetbuffer, :lbuffer, :laddbuffer, :lgetbuffer Ex commands.
7309  */
7310     static int
7311 cbuffer_process_args(
7312 	exarg_T		*eap,
7313 	buf_T		**bufp,
7314 	linenr_T	*line1,
7315 	linenr_T	*line2)
7316 {
7317     buf_T	*buf = NULL;
7318 
7319     if (*eap->arg == NUL)
7320 	buf = curbuf;
7321     else if (*skipwhite(skipdigits(eap->arg)) == NUL)
7322 	buf = buflist_findnr(atoi((char *)eap->arg));
7323 
7324     if (buf == NULL)
7325     {
7326 	emsg(_(e_invarg));
7327 	return FAIL;
7328     }
7329 
7330     if (buf->b_ml.ml_mfp == NULL)
7331     {
7332 	emsg(_("E681: Buffer is not loaded"));
7333 	return FAIL;
7334     }
7335 
7336     if (eap->addr_count == 0)
7337     {
7338 	eap->line1 = 1;
7339 	eap->line2 = buf->b_ml.ml_line_count;
7340     }
7341 
7342     if (eap->line1 < 1 || eap->line1 > buf->b_ml.ml_line_count
7343 	    || eap->line2 < 1 || eap->line2 > buf->b_ml.ml_line_count)
7344     {
7345 	emsg(_(e_invrange));
7346 	return FAIL;
7347     }
7348 
7349     *line1 = eap->line1;
7350     *line2 = eap->line2;
7351     *bufp = buf;
7352 
7353     return OK;
7354 }
7355 
7356 /*
7357  * ":[range]cbuffer [bufnr]" command.
7358  * ":[range]caddbuffer [bufnr]" command.
7359  * ":[range]cgetbuffer [bufnr]" command.
7360  * ":[range]lbuffer [bufnr]" command.
7361  * ":[range]laddbuffer [bufnr]" command.
7362  * ":[range]lgetbuffer [bufnr]" command.
7363  */
7364     void
7365 ex_cbuffer(exarg_T *eap)
7366 {
7367     buf_T	*buf = NULL;
7368     qf_info_T	*qi;
7369     char_u	*au_name = NULL;
7370     int		res;
7371     int_u	save_qfid;
7372     win_T	*wp = NULL;
7373     char_u	*qf_title;
7374     linenr_T	line1;
7375     linenr_T	line2;
7376 
7377     au_name = cbuffer_get_auname(eap->cmdidx);
7378     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
7379 					curbuf->b_fname, TRUE, curbuf))
7380     {
7381 #ifdef FEAT_EVAL
7382 	if (aborting())
7383 	    return;
7384 #endif
7385     }
7386 
7387     // Must come after autocommands.
7388     qi = qf_cmd_get_or_alloc_stack(eap, &wp);
7389     if (qi == NULL)
7390 	return;
7391 
7392     if (cbuffer_process_args(eap, &buf, &line1, &line2) == FAIL)
7393 	return;
7394 
7395     qf_title = qf_cmdtitle(*eap->cmdlinep);
7396 
7397     if (buf->b_sfname)
7398     {
7399 	vim_snprintf((char *)IObuff, IOSIZE, "%s (%s)",
7400 		(char *)qf_title, (char *)buf->b_sfname);
7401 	qf_title = IObuff;
7402     }
7403 
7404     incr_quickfix_busy();
7405 
7406     res = qf_init_ext(qi, qi->qf_curlist, NULL, buf, NULL, p_efm,
7407 	    (eap->cmdidx != CMD_caddbuffer
7408 	     && eap->cmdidx != CMD_laddbuffer),
7409 	    line1, line2,
7410 	    qf_title, NULL);
7411     if (qf_stack_empty(qi))
7412     {
7413 	decr_quickfix_busy();
7414 	return;
7415     }
7416     if (res >= 0)
7417 	qf_list_changed(qf_get_curlist(qi));
7418 
7419     // Remember the current quickfix list identifier, so that we can
7420     // check for autocommands changing the current quickfix list.
7421     save_qfid = qf_get_curlist(qi)->qf_id;
7422     if (au_name != NULL)
7423     {
7424 	buf_T *curbuf_old = curbuf;
7425 
7426 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name, curbuf->b_fname,
7427 								TRUE, curbuf);
7428 	if (curbuf != curbuf_old)
7429 	    // Autocommands changed buffer, don't jump now, "qi" may
7430 	    // be invalid.
7431 	    res = 0;
7432     }
7433     // Jump to the first error for a new list and if autocmds didn't
7434     // free the list.
7435     if (res > 0 && (eap->cmdidx == CMD_cbuffer ||
7436 		eap->cmdidx == CMD_lbuffer)
7437 	    && qflist_valid(wp, save_qfid))
7438 	// display the first error
7439 	qf_jump_first(qi, save_qfid, eap->forceit);
7440 
7441     decr_quickfix_busy();
7442 }
7443 
7444 #if defined(FEAT_EVAL) || defined(PROTO)
7445 /*
7446  * Return the autocmd name for the :cexpr Ex commands.
7447  */
7448     static char_u *
7449 cexpr_get_auname(cmdidx_T cmdidx)
7450 {
7451     switch (cmdidx)
7452     {
7453 	case CMD_cexpr:	    return (char_u *)"cexpr";
7454 	case CMD_cgetexpr:  return (char_u *)"cgetexpr";
7455 	case CMD_caddexpr:  return (char_u *)"caddexpr";
7456 	case CMD_lexpr:	    return (char_u *)"lexpr";
7457 	case CMD_lgetexpr:  return (char_u *)"lgetexpr";
7458 	case CMD_laddexpr:  return (char_u *)"laddexpr";
7459 	default:	    return NULL;
7460     }
7461 }
7462 
7463 /*
7464  * ":cexpr {expr}", ":cgetexpr {expr}", ":caddexpr {expr}" command.
7465  * ":lexpr {expr}", ":lgetexpr {expr}", ":laddexpr {expr}" command.
7466  */
7467     void
7468 ex_cexpr(exarg_T *eap)
7469 {
7470     typval_T	*tv;
7471     qf_info_T	*qi;
7472     char_u	*au_name = NULL;
7473     int		res;
7474     int_u	save_qfid;
7475     win_T	*wp = NULL;
7476 
7477     au_name = cexpr_get_auname(eap->cmdidx);
7478     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
7479 					       curbuf->b_fname, TRUE, curbuf))
7480     {
7481 #ifdef FEAT_EVAL
7482 	if (aborting())
7483 	    return;
7484 #endif
7485     }
7486 
7487     qi = qf_cmd_get_or_alloc_stack(eap, &wp);
7488     if (qi == NULL)
7489 	return;
7490 
7491     // Evaluate the expression.  When the result is a string or a list we can
7492     // use it to fill the errorlist.
7493     tv = eval_expr(eap->arg, NULL);
7494     if (tv != NULL)
7495     {
7496 	if ((tv->v_type == VAR_STRING && tv->vval.v_string != NULL)
7497 		|| (tv->v_type == VAR_LIST && tv->vval.v_list != NULL))
7498 	{
7499 	    incr_quickfix_busy();
7500 	    res = qf_init_ext(qi, qi->qf_curlist, NULL, NULL, tv, p_efm,
7501 			    (eap->cmdidx != CMD_caddexpr
7502 			     && eap->cmdidx != CMD_laddexpr),
7503 				 (linenr_T)0, (linenr_T)0,
7504 				 qf_cmdtitle(*eap->cmdlinep), NULL);
7505 	    if (qf_stack_empty(qi))
7506 	    {
7507 		decr_quickfix_busy();
7508 		goto cleanup;
7509 	    }
7510 	    if (res >= 0)
7511 		qf_list_changed(qf_get_curlist(qi));
7512 
7513 	    // Remember the current quickfix list identifier, so that we can
7514 	    // check for autocommands changing the current quickfix list.
7515 	    save_qfid = qf_get_curlist(qi)->qf_id;
7516 	    if (au_name != NULL)
7517 		apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
7518 						curbuf->b_fname, TRUE, curbuf);
7519 
7520 	    // Jump to the first error for a new list and if autocmds didn't
7521 	    // free the list.
7522 	    if (res > 0 && (eap->cmdidx == CMD_cexpr
7523 						   || eap->cmdidx == CMD_lexpr)
7524 		    && qflist_valid(wp, save_qfid))
7525 		// display the first error
7526 		qf_jump_first(qi, save_qfid, eap->forceit);
7527 	    decr_quickfix_busy();
7528 	}
7529 	else
7530 	    emsg(_("E777: String or List expected"));
7531 cleanup:
7532 	free_tv(tv);
7533     }
7534 }
7535 #endif
7536 
7537 /*
7538  * Get the location list for ":lhelpgrep"
7539  */
7540     static qf_info_T *
7541 hgr_get_ll(int *new_ll)
7542 {
7543     win_T	*wp;
7544     qf_info_T	*qi;
7545 
7546     // If the current window is a help window, then use it
7547     if (bt_help(curwin->w_buffer))
7548 	wp = curwin;
7549     else
7550 	// Find an existing help window
7551 	wp = qf_find_help_win();
7552 
7553     if (wp == NULL)	    // Help window not found
7554 	qi = NULL;
7555     else
7556 	qi = wp->w_llist;
7557 
7558     if (qi == NULL)
7559     {
7560 	// Allocate a new location list for help text matches
7561 	if ((qi = qf_alloc_stack(QFLT_LOCATION)) == NULL)
7562 	    return NULL;
7563 	*new_ll = TRUE;
7564     }
7565 
7566     return qi;
7567 }
7568 
7569 /*
7570  * Search for a pattern in a help file.
7571  */
7572     static void
7573 hgr_search_file(
7574 	qf_list_T *qfl,
7575 	char_u *fname,
7576 	vimconv_T *p_vc,
7577 	regmatch_T *p_regmatch)
7578 {
7579     FILE	*fd;
7580     long	lnum;
7581 
7582     fd = mch_fopen((char *)fname, "r");
7583     if (fd == NULL)
7584 	return;
7585 
7586     lnum = 1;
7587     while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7588     {
7589 	char_u    *line = IObuff;
7590 
7591 	// Convert a line if 'encoding' is not utf-8 and
7592 	// the line contains a non-ASCII character.
7593 	if (p_vc->vc_type != CONV_NONE
7594 		&& has_non_ascii(IObuff))
7595 	{
7596 	    line = string_convert(p_vc, IObuff, NULL);
7597 	    if (line == NULL)
7598 		line = IObuff;
7599 	}
7600 
7601 	if (vim_regexec(p_regmatch, line, (colnr_T)0))
7602 	{
7603 	    int	l = (int)STRLEN(line);
7604 
7605 	    // remove trailing CR, LF, spaces, etc.
7606 	    while (l > 0 && line[l - 1] <= ' ')
7607 		line[--l] = NUL;
7608 
7609 	    if (qf_add_entry(qfl,
7610 			NULL,	// dir
7611 			fname,
7612 			NULL,
7613 			0,
7614 			line,
7615 			lnum,
7616 			(int)(p_regmatch->startp[0] - line)
7617 			+ 1,	// col
7618 			FALSE,	// vis_col
7619 			NULL,	// search pattern
7620 			0,	// nr
7621 			1,	// type
7622 			TRUE	// valid
7623 			) == QF_FAIL)
7624 	    {
7625 		got_int = TRUE;
7626 		if (line != IObuff)
7627 		    vim_free(line);
7628 		break;
7629 	    }
7630 	}
7631 	if (line != IObuff)
7632 	    vim_free(line);
7633 	++lnum;
7634 	line_breakcheck();
7635     }
7636     fclose(fd);
7637 }
7638 
7639 /*
7640  * Search for a pattern in all the help files in the doc directory under
7641  * the given directory.
7642  */
7643     static void
7644 hgr_search_files_in_dir(
7645 	qf_list_T *qfl,
7646 	char_u *dirname,
7647 	regmatch_T *p_regmatch,
7648 	vimconv_T *p_vc
7649 #ifdef FEAT_MULTI_LANG
7650 	, char_u *lang
7651 #endif
7652 	)
7653 {
7654     int		fcount;
7655     char_u	**fnames;
7656     int		fi;
7657 
7658     // Find all "*.txt" and "*.??x" files in the "doc" directory.
7659     add_pathsep(dirname);
7660     STRCAT(dirname, "doc/*.\\(txt\\|??x\\)");
7661     if (gen_expand_wildcards(1, &dirname, &fcount,
7662 		&fnames, EW_FILE|EW_SILENT) == OK
7663 	    && fcount > 0)
7664     {
7665 	for (fi = 0; fi < fcount && !got_int; ++fi)
7666 	{
7667 #ifdef FEAT_MULTI_LANG
7668 	    // Skip files for a different language.
7669 	    if (lang != NULL
7670 		    && STRNICMP(lang, fnames[fi]
7671 				    + STRLEN(fnames[fi]) - 3, 2) != 0
7672 		    && !(STRNICMP(lang, "en", 2) == 0
7673 			&& STRNICMP("txt", fnames[fi]
7674 			    + STRLEN(fnames[fi]) - 3, 3) == 0))
7675 		continue;
7676 #endif
7677 
7678 	    hgr_search_file(qfl, fnames[fi], p_vc, p_regmatch);
7679 	}
7680 	FreeWild(fcount, fnames);
7681     }
7682 }
7683 
7684 /*
7685  * Search for a pattern in all the help files in the 'runtimepath'
7686  * and add the matches to a quickfix list.
7687  * 'lang' is the language specifier.  If supplied, then only matches in the
7688  * specified language are found.
7689  */
7690     static void
7691 hgr_search_in_rtp(qf_list_T *qfl, regmatch_T *p_regmatch, char_u *lang)
7692 {
7693     char_u	*p;
7694 
7695     vimconv_T	vc;
7696 
7697     // Help files are in utf-8 or latin1, convert lines when 'encoding'
7698     // differs.
7699     vc.vc_type = CONV_NONE;
7700     if (!enc_utf8)
7701 	convert_setup(&vc, (char_u *)"utf-8", p_enc);
7702 
7703     // Go through all the directories in 'runtimepath'
7704     p = p_rtp;
7705     while (*p != NUL && !got_int)
7706     {
7707 	copy_option_part(&p, NameBuff, MAXPATHL, ",");
7708 
7709 	hgr_search_files_in_dir(qfl, NameBuff, p_regmatch, &vc
7710 #ifdef FEAT_MULTI_LANG
7711 		, lang
7712 #endif
7713 		);
7714     }
7715 
7716     if (vc.vc_type != CONV_NONE)
7717 	convert_setup(&vc, NULL, NULL);
7718 }
7719 
7720 /*
7721  * ":helpgrep {pattern}"
7722  */
7723     void
7724 ex_helpgrep(exarg_T *eap)
7725 {
7726     regmatch_T	regmatch;
7727     char_u	*save_cpo;
7728     qf_info_T	*qi = &ql_info;
7729     int		new_qi = FALSE;
7730     char_u	*au_name =  NULL;
7731     char_u	*lang = NULL;
7732 
7733     switch (eap->cmdidx)
7734     {
7735 	case CMD_helpgrep:  au_name = (char_u *)"helpgrep"; break;
7736 	case CMD_lhelpgrep: au_name = (char_u *)"lhelpgrep"; break;
7737 	default: break;
7738     }
7739     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
7740 					       curbuf->b_fname, TRUE, curbuf))
7741     {
7742 #ifdef FEAT_EVAL
7743 	if (aborting())
7744 	    return;
7745 #endif
7746     }
7747 
7748     if (is_loclist_cmd(eap->cmdidx))
7749     {
7750 	qi = hgr_get_ll(&new_qi);
7751 	if (qi == NULL)
7752 	    return;
7753     }
7754 
7755     // Make 'cpoptions' empty, the 'l' flag should not be used here.
7756     save_cpo = p_cpo;
7757     p_cpo = empty_option;
7758 
7759     incr_quickfix_busy();
7760 
7761 #ifdef FEAT_MULTI_LANG
7762     // Check for a specified language
7763     lang = check_help_lang(eap->arg);
7764 #endif
7765     regmatch.regprog = vim_regcomp(eap->arg, RE_MAGIC + RE_STRING);
7766     regmatch.rm_ic = FALSE;
7767     if (regmatch.regprog != NULL)
7768     {
7769 	qf_list_T	*qfl;
7770 
7771 	// create a new quickfix list
7772 	qf_new_list(qi, qf_cmdtitle(*eap->cmdlinep));
7773 	qfl = qf_get_curlist(qi);
7774 
7775 	hgr_search_in_rtp(qfl, &regmatch, lang);
7776 
7777 	vim_regfree(regmatch.regprog);
7778 
7779 	qfl->qf_nonevalid = FALSE;
7780 	qfl->qf_ptr = qfl->qf_start;
7781 	qfl->qf_index = 1;
7782 	qf_list_changed(qfl);
7783 	qf_update_buffer(qi, NULL);
7784     }
7785 
7786     if (p_cpo == empty_option)
7787 	p_cpo = save_cpo;
7788     else
7789 	// Darn, some plugin changed the value.
7790 	free_string_option(save_cpo);
7791 
7792     if (au_name != NULL)
7793     {
7794 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
7795 					       curbuf->b_fname, TRUE, curbuf);
7796 	if (!new_qi && IS_LL_STACK(qi) && qf_find_buf(qi) == NULL)
7797 	{
7798 	    // autocommands made "qi" invalid
7799 	    decr_quickfix_busy();
7800 	    return;
7801 	}
7802     }
7803 
7804     // Jump to first match.
7805     if (!qf_list_empty(qf_get_curlist(qi)))
7806 	qf_jump(qi, 0, 0, FALSE);
7807     else
7808 	semsg(_(e_nomatch2), eap->arg);
7809 
7810     decr_quickfix_busy();
7811 
7812     if (eap->cmdidx == CMD_lhelpgrep)
7813     {
7814 	// If the help window is not opened or if it already points to the
7815 	// correct location list, then free the new location list.
7816 	if (!bt_help(curwin->w_buffer) || curwin->w_llist == qi)
7817 	{
7818 	    if (new_qi)
7819 		ll_free_all(&qi);
7820 	}
7821 	else if (curwin->w_llist == NULL)
7822 	    curwin->w_llist = qi;
7823     }
7824 }
7825 #endif /* FEAT_QUICKFIX */
7826 
7827 #if defined(FEAT_EVAL) || defined(PROTO)
7828 # ifdef FEAT_QUICKFIX
7829     static void
7830 get_qf_loc_list(int is_qf, win_T *wp, typval_T *what_arg, typval_T *rettv)
7831 {
7832     if (what_arg->v_type == VAR_UNKNOWN)
7833     {
7834 	if (rettv_list_alloc(rettv) == OK)
7835 	    if (is_qf || wp != NULL)
7836 		(void)get_errorlist(NULL, wp, -1, rettv->vval.v_list);
7837     }
7838     else
7839     {
7840 	if (rettv_dict_alloc(rettv) == OK)
7841 	    if (is_qf || (wp != NULL))
7842 	    {
7843 		if (what_arg->v_type == VAR_DICT)
7844 		{
7845 		    dict_T	*d = what_arg->vval.v_dict;
7846 
7847 		    if (d != NULL)
7848 			qf_get_properties(wp, d, rettv->vval.v_dict);
7849 		}
7850 		else
7851 		    emsg(_(e_dictreq));
7852 	    }
7853     }
7854 }
7855 # endif
7856 
7857 /*
7858  * "getloclist()" function
7859  */
7860     void
7861 f_getloclist(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
7862 {
7863 # ifdef FEAT_QUICKFIX
7864     win_T	*wp;
7865 
7866     wp = find_win_by_nr_or_id(&argvars[0]);
7867     get_qf_loc_list(FALSE, wp, &argvars[1], rettv);
7868 # endif
7869 }
7870 
7871 /*
7872  * "getqflist()" function
7873  */
7874     void
7875 f_getqflist(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
7876 {
7877 # ifdef FEAT_QUICKFIX
7878     get_qf_loc_list(TRUE, NULL, &argvars[0], rettv);
7879 # endif
7880 }
7881 
7882 /*
7883  * Used by "setqflist()" and "setloclist()" functions
7884  */
7885     static void
7886 set_qf_ll_list(
7887     win_T	*wp UNUSED,
7888     typval_T	*list_arg UNUSED,
7889     typval_T	*action_arg UNUSED,
7890     typval_T	*what_arg UNUSED,
7891     typval_T	*rettv)
7892 {
7893 # ifdef FEAT_QUICKFIX
7894     static char *e_invact = N_("E927: Invalid action: '%s'");
7895     char_u	*act;
7896     int		action = 0;
7897     static int	recursive = 0;
7898 # endif
7899 
7900     rettv->vval.v_number = -1;
7901 
7902 # ifdef FEAT_QUICKFIX
7903     if (list_arg->v_type != VAR_LIST)
7904 	emsg(_(e_listreq));
7905     else if (recursive != 0)
7906 	emsg(_(e_au_recursive));
7907     else
7908     {
7909 	list_T  *l = list_arg->vval.v_list;
7910 	dict_T	*d = NULL;
7911 	int	valid_dict = TRUE;
7912 
7913 	if (action_arg->v_type == VAR_STRING)
7914 	{
7915 	    act = tv_get_string_chk(action_arg);
7916 	    if (act == NULL)
7917 		return;		// type error; errmsg already given
7918 	    if ((*act == 'a' || *act == 'r' || *act == ' ' || *act == 'f') &&
7919 		    act[1] == NUL)
7920 		action = *act;
7921 	    else
7922 		semsg(_(e_invact), act);
7923 	}
7924 	else if (action_arg->v_type == VAR_UNKNOWN)
7925 	    action = ' ';
7926 	else
7927 	    emsg(_(e_stringreq));
7928 
7929 	if (action_arg->v_type != VAR_UNKNOWN
7930 		&& what_arg->v_type != VAR_UNKNOWN)
7931 	{
7932 	    if (what_arg->v_type == VAR_DICT)
7933 		d = what_arg->vval.v_dict;
7934 	    else
7935 	    {
7936 		emsg(_(e_dictreq));
7937 		valid_dict = FALSE;
7938 	    }
7939 	}
7940 
7941 	++recursive;
7942 	if (l != NULL && action && valid_dict && set_errorlist(wp, l, action,
7943 		     (char_u *)(wp == NULL ? ":setqflist()" : ":setloclist()"),
7944 		     d) == OK)
7945 	    rettv->vval.v_number = 0;
7946 	--recursive;
7947     }
7948 # endif
7949 }
7950 
7951 /*
7952  * "setloclist()" function
7953  */
7954     void
7955 f_setloclist(typval_T *argvars, typval_T *rettv)
7956 {
7957     win_T	*win;
7958 
7959     rettv->vval.v_number = -1;
7960 
7961     win = find_win_by_nr_or_id(&argvars[0]);
7962     if (win != NULL)
7963 	set_qf_ll_list(win, &argvars[1], &argvars[2], &argvars[3], rettv);
7964 }
7965 
7966 /*
7967  * "setqflist()" function
7968  */
7969     void
7970 f_setqflist(typval_T *argvars, typval_T *rettv)
7971 {
7972     set_qf_ll_list(NULL, &argvars[0], &argvars[1], &argvars[2], rettv);
7973 }
7974 #endif
7975