xref: /vim-8.2.3635/src/quickfix.c (revision 574ee7bc)
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, SEARCH_KEEP, NULL))
3211 	    curwin->w_cursor = save_cursor;
3212     }
3213 }
3214 
3215 /*
3216  * Display quickfix list index and size message
3217  */
3218     static void
3219 qf_jump_print_msg(
3220 	qf_info_T	*qi,
3221 	int		qf_index,
3222 	qfline_T	*qf_ptr,
3223 	buf_T		*old_curbuf,
3224 	linenr_T	old_lnum)
3225 {
3226     linenr_T		i;
3227     int			len;
3228 
3229     // Update the screen before showing the message, unless the screen
3230     // scrolled up.
3231     if (!msg_scrolled)
3232 	update_topline_redraw();
3233     sprintf((char *)IObuff, _("(%d of %d)%s%s: "), qf_index,
3234 	    qf_get_curlist(qi)->qf_count,
3235 	    qf_ptr->qf_cleared ? _(" (line deleted)") : "",
3236 	    (char *)qf_types(qf_ptr->qf_type, qf_ptr->qf_nr));
3237     // Add the message, skipping leading whitespace and newlines.
3238     len = (int)STRLEN(IObuff);
3239     qf_fmt_text(skipwhite(qf_ptr->qf_text), IObuff + len, IOSIZE - len);
3240 
3241     // Output the message.  Overwrite to avoid scrolling when the 'O'
3242     // flag is present in 'shortmess'; But when not jumping, print the
3243     // whole message.
3244     i = msg_scroll;
3245     if (curbuf == old_curbuf && curwin->w_cursor.lnum == old_lnum)
3246 	msg_scroll = TRUE;
3247     else if (!msg_scrolled && shortmess(SHM_OVERALL))
3248 	msg_scroll = FALSE;
3249     msg_attr_keep((char *)IObuff, 0, TRUE);
3250     msg_scroll = i;
3251 }
3252 
3253 /*
3254  * Find a usable window for opening a file from the quickfix/location list. If
3255  * a window is not found then open a new window. If 'newwin' is TRUE, then open
3256  * a new window.
3257  * Returns OK if successfully jumped or opened a window. Returns FAIL if not
3258  * able to jump/open a window.  Returns NOTDONE if a file is not associated
3259  * with the entry.
3260  */
3261     static int
3262 qf_jump_open_window(
3263 	qf_info_T	*qi,
3264 	qfline_T	*qf_ptr,
3265 	int		newwin,
3266 	int		*opened_window)
3267 {
3268     // For ":helpgrep" find a help window or open one.
3269     if (qf_ptr->qf_type == 1 && (!bt_help(curwin->w_buffer) || cmdmod.tab != 0))
3270 	if (jump_to_help_window(qi, newwin, opened_window) == FAIL)
3271 	    return FAIL;
3272 
3273     // If currently in the quickfix window, find another window to show the
3274     // file in.
3275     if (bt_quickfix(curbuf) && !*opened_window)
3276     {
3277 	// If there is no file specified, we don't know where to go.
3278 	// But do advance, otherwise ":cn" gets stuck.
3279 	if (qf_ptr->qf_fnum == 0)
3280 	    return NOTDONE;
3281 
3282 	if (qf_jump_to_usable_window(qf_ptr->qf_fnum, newwin,
3283 						opened_window) == FAIL)
3284 	    return FAIL;
3285     }
3286 
3287     return OK;
3288 }
3289 
3290 /*
3291  * Edit a selected file from the quickfix/location list and jump to a
3292  * particular line/column, adjust the folds and display a message about the
3293  * jump.
3294  * Returns OK on success and FAIL on failing to open the file/buffer.  Returns
3295  * NOTDONE if the quickfix/location list is freed by an autocmd when opening
3296  * the file.
3297  */
3298     static int
3299 qf_jump_to_buffer(
3300 	qf_info_T	*qi,
3301 	int		qf_index,
3302 	qfline_T	*qf_ptr,
3303 	int		forceit,
3304 	int		prev_winid,
3305 	int		*opened_window,
3306 	int		openfold,
3307 	int		print_message)
3308 {
3309     buf_T	*old_curbuf;
3310     linenr_T	old_lnum;
3311     int		retval = OK;
3312 
3313     // If there is a file name, read the wanted file if needed, and check
3314     // autowrite etc.
3315     old_curbuf = curbuf;
3316     old_lnum = curwin->w_cursor.lnum;
3317 
3318     if (qf_ptr->qf_fnum != 0)
3319     {
3320 	retval = qf_jump_edit_buffer(qi, qf_ptr, forceit, prev_winid,
3321 						opened_window);
3322 	if (retval != OK)
3323 	    return retval;
3324     }
3325 
3326     // When not switched to another buffer, still need to set pc mark
3327     if (curbuf == old_curbuf)
3328 	setpcmark();
3329 
3330     qf_jump_goto_line(qf_ptr->qf_lnum, qf_ptr->qf_col, qf_ptr->qf_viscol,
3331 	    qf_ptr->qf_pattern);
3332 
3333 #ifdef FEAT_FOLDING
3334     if ((fdo_flags & FDO_QUICKFIX) && openfold)
3335 	foldOpenCursor();
3336 #endif
3337     if (print_message)
3338 	qf_jump_print_msg(qi, qf_index, qf_ptr, old_curbuf, old_lnum);
3339 
3340     return retval;
3341 }
3342 
3343 /*
3344  * Jump to a quickfix line and try to use an existing window.
3345  */
3346     void
3347 qf_jump(qf_info_T	*qi,
3348 	int		dir,
3349 	int		errornr,
3350 	int		forceit)
3351 {
3352     qf_jump_newwin(qi, dir, errornr, forceit, FALSE);
3353 }
3354 
3355 /*
3356  * Jump to a quickfix line.
3357  * If dir == 0 go to entry "errornr".
3358  * If dir == FORWARD go "errornr" valid entries forward.
3359  * If dir == BACKWARD go "errornr" valid entries backward.
3360  * If dir == FORWARD_FILE go "errornr" valid entries files backward.
3361  * If dir == BACKWARD_FILE go "errornr" valid entries files backward
3362  * else if "errornr" is zero, redisplay the same line
3363  * If 'forceit' is TRUE, then can discard changes to the current buffer.
3364  * If 'newwin' is TRUE, then open the file in a new window.
3365  */
3366     static void
3367 qf_jump_newwin(qf_info_T	*qi,
3368 	int		dir,
3369 	int		errornr,
3370 	int		forceit,
3371 	int		newwin)
3372 {
3373     qf_list_T		*qfl;
3374     qfline_T		*qf_ptr;
3375     qfline_T		*old_qf_ptr;
3376     int			qf_index;
3377     int			old_qf_index;
3378     char_u		*old_swb = p_swb;
3379     unsigned		old_swb_flags = swb_flags;
3380     int			prev_winid;
3381     int			opened_window = FALSE;
3382     int			print_message = TRUE;
3383     int			old_KeyTyped = KeyTyped; // getting file may reset it
3384     int			retval = OK;
3385 
3386     if (qi == NULL)
3387 	qi = &ql_info;
3388 
3389     if (qf_stack_empty(qi) || qf_list_empty(qf_get_curlist(qi)))
3390     {
3391 	emsg(_(e_quickfix));
3392 	return;
3393     }
3394 
3395     incr_quickfix_busy();
3396 
3397     qfl = qf_get_curlist(qi);
3398 
3399     qf_ptr = qfl->qf_ptr;
3400     old_qf_ptr = qf_ptr;
3401     qf_index = qfl->qf_index;
3402     old_qf_index = qf_index;
3403 
3404     qf_ptr = qf_get_entry(qfl, errornr, dir, &qf_index);
3405     if (qf_ptr == NULL)
3406     {
3407 	qf_ptr = old_qf_ptr;
3408 	qf_index = old_qf_index;
3409 	goto theend;
3410     }
3411 
3412     qfl->qf_index = qf_index;
3413     if (qf_win_pos_update(qi, old_qf_index))
3414 	// No need to print the error message if it's visible in the error
3415 	// window
3416 	print_message = FALSE;
3417 
3418     prev_winid = curwin->w_id;
3419 
3420     retval = qf_jump_open_window(qi, qf_ptr, newwin, &opened_window);
3421     if (retval == FAIL)
3422 	goto failed;
3423     if (retval == NOTDONE)
3424 	goto theend;
3425 
3426     retval = qf_jump_to_buffer(qi, qf_index, qf_ptr, forceit, prev_winid,
3427 				  &opened_window, old_KeyTyped, print_message);
3428     if (retval == NOTDONE)
3429     {
3430 	// Quickfix/location list is freed by an autocmd
3431 	qi = NULL;
3432 	qf_ptr = NULL;
3433     }
3434 
3435     if (retval != OK)
3436     {
3437 	if (opened_window)
3438 	    win_close(curwin, TRUE);    // Close opened window
3439 	if (qf_ptr != NULL && qf_ptr->qf_fnum != 0)
3440 	{
3441 	    // Couldn't open file, so put index back where it was.  This could
3442 	    // happen if the file was readonly and we changed something.
3443 failed:
3444 	    qf_ptr = old_qf_ptr;
3445 	    qf_index = old_qf_index;
3446 	}
3447     }
3448 theend:
3449     if (qi != NULL)
3450     {
3451 	qfl->qf_ptr = qf_ptr;
3452 	qfl->qf_index = qf_index;
3453     }
3454     if (p_swb != old_swb)
3455     {
3456 	// Restore old 'switchbuf' value, but not when an autocommand or
3457 	// modeline has changed the value.
3458 	if (p_swb == empty_option)
3459 	{
3460 	    p_swb = old_swb;
3461 	    swb_flags = old_swb_flags;
3462 	}
3463 	else
3464 	    free_string_option(old_swb);
3465     }
3466     decr_quickfix_busy();
3467 }
3468 
3469 // Highlight attributes used for displaying entries from the quickfix list.
3470 static int	qfFileAttr;
3471 static int	qfSepAttr;
3472 static int	qfLineAttr;
3473 
3474 /*
3475  * Display information about a single entry from the quickfix/location list.
3476  * Used by ":clist/:llist" commands.
3477  * 'cursel' will be set to TRUE for the currently selected entry in the
3478  * quickfix list.
3479  */
3480     static void
3481 qf_list_entry(qfline_T *qfp, int qf_idx, int cursel)
3482 {
3483     char_u	*fname;
3484     buf_T	*buf;
3485     int		filter_entry;
3486 
3487     fname = NULL;
3488     if (qfp->qf_module != NULL && *qfp->qf_module != NUL)
3489 	vim_snprintf((char *)IObuff, IOSIZE, "%2d %s", qf_idx,
3490 						(char *)qfp->qf_module);
3491     else {
3492 	if (qfp->qf_fnum != 0
3493 		&& (buf = buflist_findnr(qfp->qf_fnum)) != NULL)
3494 	{
3495 	    fname = buf->b_fname;
3496 	    if (qfp->qf_type == 1)	// :helpgrep
3497 		fname = gettail(fname);
3498 	}
3499 	if (fname == NULL)
3500 	    sprintf((char *)IObuff, "%2d", qf_idx);
3501 	else
3502 	    vim_snprintf((char *)IObuff, IOSIZE, "%2d %s",
3503 		    qf_idx, (char *)fname);
3504     }
3505 
3506     // Support for filtering entries using :filter /pat/ clist
3507     // Match against the module name, file name, search pattern and
3508     // text of the entry.
3509     filter_entry = TRUE;
3510     if (qfp->qf_module != NULL && *qfp->qf_module != NUL)
3511 	filter_entry &= message_filtered(qfp->qf_module);
3512     if (filter_entry && fname != NULL)
3513 	filter_entry &= message_filtered(fname);
3514     if (filter_entry && qfp->qf_pattern != NULL)
3515 	filter_entry &= message_filtered(qfp->qf_pattern);
3516     if (filter_entry)
3517 	filter_entry &= message_filtered(qfp->qf_text);
3518     if (filter_entry)
3519 	return;
3520 
3521     msg_putchar('\n');
3522     msg_outtrans_attr(IObuff, cursel ? HL_ATTR(HLF_QFL) : qfFileAttr);
3523 
3524     if (qfp->qf_lnum != 0)
3525 	msg_puts_attr(":", qfSepAttr);
3526     if (qfp->qf_lnum == 0)
3527 	IObuff[0] = NUL;
3528     else if (qfp->qf_col == 0)
3529 	sprintf((char *)IObuff, "%ld", qfp->qf_lnum);
3530     else
3531 	sprintf((char *)IObuff, "%ld col %d",
3532 		qfp->qf_lnum, qfp->qf_col);
3533     sprintf((char *)IObuff + STRLEN(IObuff), "%s",
3534 	    (char *)qf_types(qfp->qf_type, qfp->qf_nr));
3535     msg_puts_attr((char *)IObuff, qfLineAttr);
3536     msg_puts_attr(":", qfSepAttr);
3537     if (qfp->qf_pattern != NULL)
3538     {
3539 	qf_fmt_text(qfp->qf_pattern, IObuff, IOSIZE);
3540 	msg_puts((char *)IObuff);
3541 	msg_puts_attr(":", qfSepAttr);
3542     }
3543     msg_puts(" ");
3544 
3545     // Remove newlines and leading whitespace from the text.  For an
3546     // unrecognized line keep the indent, the compiler may mark a word
3547     // with ^^^^.
3548     qf_fmt_text((fname != NULL || qfp->qf_lnum != 0)
3549 				? skipwhite(qfp->qf_text) : qfp->qf_text,
3550 				IObuff, IOSIZE);
3551     msg_prt_line(IObuff, FALSE);
3552     out_flush();		// show one line at a time
3553 }
3554 
3555 /*
3556  * ":clist": list all errors
3557  * ":llist": list all locations
3558  */
3559     void
3560 qf_list(exarg_T *eap)
3561 {
3562     qf_list_T	*qfl;
3563     qfline_T	*qfp;
3564     int		i;
3565     int		idx1 = 1;
3566     int		idx2 = -1;
3567     char_u	*arg = eap->arg;
3568     int		plus = FALSE;
3569     int		all = eap->forceit;	// if not :cl!, only show
3570 					// recognised errors
3571     qf_info_T	*qi;
3572 
3573     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
3574 	return;
3575 
3576     if (qf_stack_empty(qi) || qf_list_empty(qf_get_curlist(qi)))
3577     {
3578 	emsg(_(e_quickfix));
3579 	return;
3580     }
3581     if (*arg == '+')
3582     {
3583 	++arg;
3584 	plus = TRUE;
3585     }
3586     if (!get_list_range(&arg, &idx1, &idx2) || *arg != NUL)
3587     {
3588 	emsg(_(e_trailing));
3589 	return;
3590     }
3591     qfl = qf_get_curlist(qi);
3592     if (plus)
3593     {
3594 	i = qfl->qf_index;
3595 	idx2 = i + idx1;
3596 	idx1 = i;
3597     }
3598     else
3599     {
3600 	i = qfl->qf_count;
3601 	if (idx1 < 0)
3602 	    idx1 = (-idx1 > i) ? 0 : idx1 + i + 1;
3603 	if (idx2 < 0)
3604 	    idx2 = (-idx2 > i) ? 0 : idx2 + i + 1;
3605     }
3606 
3607     // Shorten all the file names, so that it is easy to read
3608     shorten_fnames(FALSE);
3609 
3610     // Get the attributes for the different quickfix highlight items.  Note
3611     // that this depends on syntax items defined in the qf.vim syntax file
3612     qfFileAttr = syn_name2attr((char_u *)"qfFileName");
3613     if (qfFileAttr == 0)
3614 	qfFileAttr = HL_ATTR(HLF_D);
3615     qfSepAttr = syn_name2attr((char_u *)"qfSeparator");
3616     if (qfSepAttr == 0)
3617 	qfSepAttr = HL_ATTR(HLF_D);
3618     qfLineAttr = syn_name2attr((char_u *)"qfLineNr");
3619     if (qfLineAttr == 0)
3620 	qfLineAttr = HL_ATTR(HLF_N);
3621 
3622     if (qfl->qf_nonevalid)
3623 	all = TRUE;
3624     FOR_ALL_QFL_ITEMS(qfl, qfp, i)
3625     {
3626 	if ((qfp->qf_valid || all) && idx1 <= i && i <= idx2)
3627 	    qf_list_entry(qfp, i, i == qfl->qf_index);
3628 
3629 	ui_breakcheck();
3630     }
3631 }
3632 
3633 /*
3634  * Remove newlines and leading whitespace from an error message.
3635  * Put the result in "buf[bufsize]".
3636  */
3637     static void
3638 qf_fmt_text(char_u *text, char_u *buf, int bufsize)
3639 {
3640     int		i;
3641     char_u	*p = text;
3642 
3643     for (i = 0; *p != NUL && i < bufsize - 1; ++i)
3644     {
3645 	if (*p == '\n')
3646 	{
3647 	    buf[i] = ' ';
3648 	    while (*++p != NUL)
3649 		if (!VIM_ISWHITE(*p) && *p != '\n')
3650 		    break;
3651 	}
3652 	else
3653 	    buf[i] = *p++;
3654     }
3655     buf[i] = NUL;
3656 }
3657 
3658 /*
3659  * Display information (list number, list size and the title) about a
3660  * quickfix/location list.
3661  */
3662     static void
3663 qf_msg(qf_info_T *qi, int which, char *lead)
3664 {
3665     char   *title = (char *)qi->qf_lists[which].qf_title;
3666     int    count = qi->qf_lists[which].qf_count;
3667     char_u buf[IOSIZE];
3668 
3669     vim_snprintf((char *)buf, IOSIZE, _("%serror list %d of %d; %d errors "),
3670 	    lead,
3671 	    which + 1,
3672 	    qi->qf_listcount,
3673 	    count);
3674 
3675     if (title != NULL)
3676     {
3677 	size_t	len = STRLEN(buf);
3678 
3679 	if (len < 34)
3680 	{
3681 	    vim_memset(buf + len, ' ', 34 - len);
3682 	    buf[34] = NUL;
3683 	}
3684 	vim_strcat(buf, (char_u *)title, IOSIZE);
3685     }
3686     trunc_string(buf, buf, Columns - 1, IOSIZE);
3687     msg((char *)buf);
3688 }
3689 
3690 /*
3691  * ":colder [count]": Up in the quickfix stack.
3692  * ":cnewer [count]": Down in the quickfix stack.
3693  * ":lolder [count]": Up in the location list stack.
3694  * ":lnewer [count]": Down in the location list stack.
3695  */
3696     void
3697 qf_age(exarg_T *eap)
3698 {
3699     qf_info_T	*qi;
3700     int		count;
3701 
3702     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
3703 	return;
3704 
3705     if (eap->addr_count != 0)
3706 	count = eap->line2;
3707     else
3708 	count = 1;
3709     while (count--)
3710     {
3711 	if (eap->cmdidx == CMD_colder || eap->cmdidx == CMD_lolder)
3712 	{
3713 	    if (qi->qf_curlist == 0)
3714 	    {
3715 		emsg(_("E380: At bottom of quickfix stack"));
3716 		break;
3717 	    }
3718 	    --qi->qf_curlist;
3719 	}
3720 	else
3721 	{
3722 	    if (qi->qf_curlist >= qi->qf_listcount - 1)
3723 	    {
3724 		emsg(_("E381: At top of quickfix stack"));
3725 		break;
3726 	    }
3727 	    ++qi->qf_curlist;
3728 	}
3729     }
3730     qf_msg(qi, qi->qf_curlist, "");
3731     qf_update_buffer(qi, NULL);
3732 }
3733 
3734 /*
3735  * Display the information about all the quickfix/location lists in the stack
3736  */
3737     void
3738 qf_history(exarg_T *eap)
3739 {
3740     qf_info_T	*qi = qf_cmd_get_stack(eap, FALSE);
3741     int		i;
3742 
3743     if (eap->addr_count > 0)
3744     {
3745 	if (qi == NULL)
3746 	{
3747 	    emsg(_(e_loclist));
3748 	    return;
3749 	}
3750 
3751 	// Jump to the specified quickfix list
3752 	if (eap->line2 > 0 && eap->line2 <= qi->qf_listcount)
3753 	{
3754 	    qi->qf_curlist = eap->line2 - 1;
3755 	    qf_msg(qi, qi->qf_curlist, "");
3756 	    qf_update_buffer(qi, NULL);
3757 	}
3758 	else
3759 	    emsg(_(e_invrange));
3760 
3761 	return;
3762     }
3763 
3764     if (qf_stack_empty(qi))
3765 	msg(_("No entries"));
3766     else
3767 	for (i = 0; i < qi->qf_listcount; ++i)
3768 	    qf_msg(qi, i, i == qi->qf_curlist ? "> " : "  ");
3769 }
3770 
3771 /*
3772  * Free all the entries in the error list "idx". Note that other information
3773  * associated with the list like context and title are not freed.
3774  */
3775     static void
3776 qf_free_items(qf_list_T *qfl)
3777 {
3778     qfline_T	*qfp;
3779     qfline_T	*qfpnext;
3780     int		stop = FALSE;
3781 
3782     while (qfl->qf_count && qfl->qf_start != NULL)
3783     {
3784 	qfp = qfl->qf_start;
3785 	qfpnext = qfp->qf_next;
3786 	if (!stop)
3787 	{
3788 	    vim_free(qfp->qf_module);
3789 	    vim_free(qfp->qf_text);
3790 	    vim_free(qfp->qf_pattern);
3791 	    stop = (qfp == qfpnext);
3792 	    vim_free(qfp);
3793 	    if (stop)
3794 		// Somehow qf_count may have an incorrect value, set it to 1
3795 		// to avoid crashing when it's wrong.
3796 		// TODO: Avoid qf_count being incorrect.
3797 		qfl->qf_count = 1;
3798 	}
3799 	qfl->qf_start = qfpnext;
3800 	--qfl->qf_count;
3801     }
3802 
3803     qfl->qf_index = 0;
3804     qfl->qf_start = NULL;
3805     qfl->qf_last = NULL;
3806     qfl->qf_ptr = NULL;
3807     qfl->qf_nonevalid = TRUE;
3808 
3809     qf_clean_dir_stack(&qfl->qf_dir_stack);
3810     qfl->qf_directory = NULL;
3811     qf_clean_dir_stack(&qfl->qf_file_stack);
3812     qfl->qf_currfile = NULL;
3813     qfl->qf_multiline = FALSE;
3814     qfl->qf_multiignore = FALSE;
3815     qfl->qf_multiscan = FALSE;
3816 }
3817 
3818 /*
3819  * Free error list "idx". Frees all the entries in the quickfix list,
3820  * associated context information and the title.
3821  */
3822     static void
3823 qf_free(qf_list_T *qfl)
3824 {
3825     qf_free_items(qfl);
3826 
3827     VIM_CLEAR(qfl->qf_title);
3828     free_tv(qfl->qf_ctx);
3829     qfl->qf_ctx = NULL;
3830     qfl->qf_id = 0;
3831     qfl->qf_changedtick = 0L;
3832 }
3833 
3834 /*
3835  * qf_mark_adjust: adjust marks
3836  */
3837    void
3838 qf_mark_adjust(
3839 	win_T	*wp,
3840 	linenr_T	line1,
3841 	linenr_T	line2,
3842 	long	amount,
3843 	long	amount_after)
3844 {
3845     int		i;
3846     qfline_T	*qfp;
3847     int		idx;
3848     qf_info_T	*qi = &ql_info;
3849     int		found_one = FALSE;
3850     int		buf_has_flag = wp == NULL ? BUF_HAS_QF_ENTRY : BUF_HAS_LL_ENTRY;
3851 
3852     if (!(curbuf->b_has_qf_entry & buf_has_flag))
3853 	return;
3854     if (wp != NULL)
3855     {
3856 	if (wp->w_llist == NULL)
3857 	    return;
3858 	qi = wp->w_llist;
3859     }
3860 
3861     for (idx = 0; idx < qi->qf_listcount; ++idx)
3862     {
3863 	qf_list_T	*qfl = qf_get_list(qi, idx);
3864 
3865 	if (!qf_list_empty(qfl))
3866 	    FOR_ALL_QFL_ITEMS(qfl, qfp, i)
3867 		if (qfp->qf_fnum == curbuf->b_fnum)
3868 		{
3869 		    found_one = TRUE;
3870 		    if (qfp->qf_lnum >= line1 && qfp->qf_lnum <= line2)
3871 		    {
3872 			if (amount == MAXLNUM)
3873 			    qfp->qf_cleared = TRUE;
3874 			else
3875 			    qfp->qf_lnum += amount;
3876 		    }
3877 		    else if (amount_after && qfp->qf_lnum > line2)
3878 			qfp->qf_lnum += amount_after;
3879 		}
3880     }
3881 
3882     if (!found_one)
3883 	curbuf->b_has_qf_entry &= ~buf_has_flag;
3884 }
3885 
3886 /*
3887  * Make a nice message out of the error character and the error number:
3888  *  char    number	message
3889  *  e or E    0		" error"
3890  *  w or W    0		" warning"
3891  *  i or I    0		" info"
3892  *  0	      0		""
3893  *  other     0		" c"
3894  *  e or E    n		" error n"
3895  *  w or W    n		" warning n"
3896  *  i or I    n		" info n"
3897  *  0	      n		" error n"
3898  *  other     n		" c n"
3899  *  1	      x		""	:helpgrep
3900  */
3901     static char_u *
3902 qf_types(int c, int nr)
3903 {
3904     static char_u	buf[20];
3905     static char_u	cc[3];
3906     char_u		*p;
3907 
3908     if (c == 'W' || c == 'w')
3909 	p = (char_u *)" warning";
3910     else if (c == 'I' || c == 'i')
3911 	p = (char_u *)" info";
3912     else if (c == 'E' || c == 'e' || (c == 0 && nr > 0))
3913 	p = (char_u *)" error";
3914     else if (c == 0 || c == 1)
3915 	p = (char_u *)"";
3916     else
3917     {
3918 	cc[0] = ' ';
3919 	cc[1] = c;
3920 	cc[2] = NUL;
3921 	p = cc;
3922     }
3923 
3924     if (nr <= 0)
3925 	return p;
3926 
3927     sprintf((char *)buf, "%s %3d", (char *)p, nr);
3928     return buf;
3929 }
3930 
3931 /*
3932  * When "split" is FALSE: Open the entry/result under the cursor.
3933  * When "split" is TRUE: Open the entry/result under the cursor in a new window.
3934  */
3935     void
3936 qf_view_result(int split)
3937 {
3938     qf_info_T   *qi = &ql_info;
3939 
3940     if (!bt_quickfix(curbuf))
3941 	return;
3942 
3943     if (IS_LL_WINDOW(curwin))
3944 	qi = GET_LOC_LIST(curwin);
3945 
3946     if (qf_list_empty(qf_get_curlist(qi)))
3947     {
3948 	emsg(_(e_quickfix));
3949 	return;
3950     }
3951 
3952     if (split)
3953     {
3954 	// Open the selected entry in a new window
3955 	qf_jump_newwin(qi, 0, (long)curwin->w_cursor.lnum, FALSE, TRUE);
3956 	do_cmdline_cmd((char_u *) "clearjumps");
3957 	return;
3958     }
3959 
3960     do_cmdline_cmd((char_u *)(IS_LL_WINDOW(curwin) ? ".ll" : ".cc"));
3961 }
3962 
3963 /*
3964  * ":cwindow": open the quickfix window if we have errors to display,
3965  *	       close it if not.
3966  * ":lwindow": open the location list window if we have locations to display,
3967  *	       close it if not.
3968  */
3969     void
3970 ex_cwindow(exarg_T *eap)
3971 {
3972     qf_info_T	*qi;
3973     qf_list_T	*qfl;
3974     win_T	*win;
3975 
3976     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
3977 	return;
3978 
3979     qfl = qf_get_curlist(qi);
3980 
3981     // Look for an existing quickfix window.
3982     win = qf_find_win(qi);
3983 
3984     // If a quickfix window is open but we have no errors to display,
3985     // close the window.  If a quickfix window is not open, then open
3986     // it if we have errors; otherwise, leave it closed.
3987     if (qf_stack_empty(qi)
3988 	    || qfl->qf_nonevalid
3989 	    || qf_list_empty(qfl))
3990     {
3991 	if (win != NULL)
3992 	    ex_cclose(eap);
3993     }
3994     else if (win == NULL)
3995 	ex_copen(eap);
3996 }
3997 
3998 /*
3999  * ":cclose": close the window showing the list of errors.
4000  * ":lclose": close the window showing the location list
4001  */
4002     void
4003 ex_cclose(exarg_T *eap)
4004 {
4005     win_T	*win = NULL;
4006     qf_info_T	*qi;
4007 
4008     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4009 	return;
4010 
4011     // Find existing quickfix window and close it.
4012     win = qf_find_win(qi);
4013     if (win != NULL)
4014 	win_close(win, FALSE);
4015 }
4016 
4017 /*
4018  * Set "w:quickfix_title" if "qi" has a title.
4019  */
4020     static void
4021 qf_set_title_var(qf_list_T *qfl)
4022 {
4023     if (qfl->qf_title != NULL)
4024 	set_internal_string_var((char_u *)"w:quickfix_title", qfl->qf_title);
4025 }
4026 
4027 /*
4028  * Goto a quickfix or location list window (if present).
4029  * Returns OK if the window is found, FAIL otherwise.
4030  */
4031     static int
4032 qf_goto_cwindow(qf_info_T *qi, int resize, int sz, int vertsplit)
4033 {
4034     win_T	*win;
4035 
4036     win = qf_find_win(qi);
4037     if (win == NULL)
4038 	return FAIL;
4039 
4040     win_goto(win);
4041     if (resize)
4042     {
4043 	if (vertsplit)
4044 	{
4045 	    if (sz != win->w_width)
4046 		win_setwidth(sz);
4047 	}
4048 	else if (sz != win->w_height && win->w_height
4049 		       + win->w_status_height + tabline_height() < cmdline_row)
4050 	    win_setheight(sz);
4051     }
4052 
4053     return OK;
4054 }
4055 
4056 /*
4057  * Set options for the buffer in the quickfix or location list window.
4058  */
4059     static void
4060 qf_set_cwindow_options(void)
4061 {
4062     // switch off 'swapfile'
4063     set_option_value((char_u *)"swf", 0L, NULL, OPT_LOCAL);
4064     set_option_value((char_u *)"bt", 0L, (char_u *)"quickfix",
4065 	    OPT_LOCAL);
4066     set_option_value((char_u *)"bh", 0L, (char_u *)"hide", OPT_LOCAL);
4067     RESET_BINDING(curwin);
4068 #ifdef FEAT_DIFF
4069     curwin->w_p_diff = FALSE;
4070 #endif
4071 #ifdef FEAT_FOLDING
4072     set_option_value((char_u *)"fdm", 0L, (char_u *)"manual",
4073 	    OPT_LOCAL);
4074 #endif
4075 }
4076 
4077 /*
4078  * Open a new quickfix or location list window, load the quickfix buffer and
4079  * set the appropriate options for the window.
4080  * Returns FAIL if the window could not be opened.
4081  */
4082     static int
4083 qf_open_new_cwindow(qf_info_T *qi, int height)
4084 {
4085     buf_T	*qf_buf;
4086     win_T	*oldwin = curwin;
4087     tabpage_T	*prevtab = curtab;
4088     int		flags = 0;
4089     win_T	*win;
4090 
4091     qf_buf = qf_find_buf(qi);
4092 
4093     // The current window becomes the previous window afterwards.
4094     win = curwin;
4095 
4096     if (IS_QF_STACK(qi) && cmdmod.split == 0)
4097 	// Create the new quickfix window at the very bottom, except when
4098 	// :belowright or :aboveleft is used.
4099 	win_goto(lastwin);
4100     // Default is to open the window below the current window
4101     if (cmdmod.split == 0)
4102 	flags = WSP_BELOW;
4103     flags |= WSP_NEWLOC;
4104     if (win_split(height, flags) == FAIL)
4105 	return FAIL;		// not enough room for window
4106     RESET_BINDING(curwin);
4107 
4108     if (IS_LL_STACK(qi))
4109     {
4110 	// For the location list window, create a reference to the
4111 	// location list stack from the window 'win'.
4112 	curwin->w_llist_ref = qi;
4113 	qi->qf_refcount++;
4114     }
4115 
4116     if (oldwin != curwin)
4117 	oldwin = NULL;  // don't store info when in another window
4118     if (qf_buf != NULL)
4119     {
4120 	// Use the existing quickfix buffer
4121 	(void)do_ecmd(qf_buf->b_fnum, NULL, NULL, NULL, ECMD_ONE,
4122 		ECMD_HIDE + ECMD_OLDBUF, oldwin);
4123     }
4124     else
4125     {
4126 	// Create a new quickfix buffer
4127 	(void)do_ecmd(0, NULL, NULL, NULL, ECMD_ONE, ECMD_HIDE, oldwin);
4128 
4129 	// save the number of the new buffer
4130 	qi->qf_bufnr = curbuf->b_fnum;
4131     }
4132 
4133     // Set the options for the quickfix buffer/window (if not already done)
4134     // Do this even if the quickfix buffer was already present, as an autocmd
4135     // might have previously deleted (:bdelete) the quickfix buffer.
4136     if (!bt_quickfix(curbuf))
4137 	qf_set_cwindow_options();
4138 
4139     // Only set the height when still in the same tab page and there is no
4140     // window to the side.
4141     if (curtab == prevtab && curwin->w_width == Columns)
4142 	win_setheight(height);
4143     curwin->w_p_wfh = TRUE;	    // set 'winfixheight'
4144     if (win_valid(win))
4145 	prevwin = win;
4146 
4147     return OK;
4148 }
4149 
4150 /*
4151  * ":copen": open a window that shows the list of errors.
4152  * ":lopen": open a window that shows the location list.
4153  */
4154     void
4155 ex_copen(exarg_T *eap)
4156 {
4157     qf_info_T	*qi;
4158     qf_list_T	*qfl;
4159     int		height;
4160     int		status = FAIL;
4161     int		lnum;
4162 
4163     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
4164 	return;
4165 
4166     incr_quickfix_busy();
4167 
4168     if (eap->addr_count != 0)
4169 	height = eap->line2;
4170     else
4171 	height = QF_WINHEIGHT;
4172 
4173     reset_VIsual_and_resel();			// stop Visual mode
4174 #ifdef FEAT_GUI
4175     need_mouse_correct = TRUE;
4176 #endif
4177 
4178     // Find an existing quickfix window, or open a new one.
4179     if (cmdmod.tab == 0)
4180 	status = qf_goto_cwindow(qi, eap->addr_count != 0, height,
4181 						cmdmod.split & WSP_VERT);
4182     if (status == FAIL)
4183 	if (qf_open_new_cwindow(qi, height) == FAIL)
4184 	{
4185 	    decr_quickfix_busy();
4186 	    return;
4187 	}
4188 
4189     qfl = qf_get_curlist(qi);
4190     qf_set_title_var(qfl);
4191     // Save the current index here, as updating the quickfix buffer may free
4192     // the quickfix list
4193     lnum = qfl->qf_index;
4194 
4195     // Fill the buffer with the quickfix list.
4196     qf_fill_buffer(qfl, curbuf, NULL);
4197 
4198     decr_quickfix_busy();
4199 
4200     curwin->w_cursor.lnum = lnum;
4201     curwin->w_cursor.col = 0;
4202     check_cursor();
4203     update_topline();		// scroll to show the line
4204 }
4205 
4206 /*
4207  * Move the cursor in the quickfix window to "lnum".
4208  */
4209     static void
4210 qf_win_goto(win_T *win, linenr_T lnum)
4211 {
4212     win_T	*old_curwin = curwin;
4213 
4214     curwin = win;
4215     curbuf = win->w_buffer;
4216     curwin->w_cursor.lnum = lnum;
4217     curwin->w_cursor.col = 0;
4218     curwin->w_cursor.coladd = 0;
4219     curwin->w_curswant = 0;
4220     update_topline();		// scroll to show the line
4221     redraw_later(VALID);
4222     curwin->w_redr_status = TRUE;	// update ruler
4223     curwin = old_curwin;
4224     curbuf = curwin->w_buffer;
4225 }
4226 
4227 /*
4228  * :cbottom/:lbottom commands.
4229  */
4230     void
4231 ex_cbottom(exarg_T *eap)
4232 {
4233     qf_info_T	*qi;
4234     win_T	*win;
4235 
4236     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
4237 	return;
4238 
4239     win = qf_find_win(qi);
4240     if (win != NULL && win->w_cursor.lnum != win->w_buffer->b_ml.ml_line_count)
4241 	qf_win_goto(win, win->w_buffer->b_ml.ml_line_count);
4242 }
4243 
4244 /*
4245  * Return the number of the current entry (line number in the quickfix
4246  * window).
4247  */
4248      linenr_T
4249 qf_current_entry(win_T *wp)
4250 {
4251     qf_info_T	*qi = &ql_info;
4252 
4253     if (IS_LL_WINDOW(wp))
4254 	// In the location list window, use the referenced location list
4255 	qi = wp->w_llist_ref;
4256 
4257     return qf_get_curlist(qi)->qf_index;
4258 }
4259 
4260 /*
4261  * Update the cursor position in the quickfix window to the current error.
4262  * Return TRUE if there is a quickfix window.
4263  */
4264     static int
4265 qf_win_pos_update(
4266     qf_info_T	*qi,
4267     int		old_qf_index)	// previous qf_index or zero
4268 {
4269     win_T	*win;
4270     int		qf_index = qf_get_curlist(qi)->qf_index;
4271 
4272     // Put the cursor on the current error in the quickfix window, so that
4273     // it's viewable.
4274     win = qf_find_win(qi);
4275     if (win != NULL
4276 	    && qf_index <= win->w_buffer->b_ml.ml_line_count
4277 	    && old_qf_index != qf_index)
4278     {
4279 	if (qf_index > old_qf_index)
4280 	{
4281 	    win->w_redraw_top = old_qf_index;
4282 	    win->w_redraw_bot = qf_index;
4283 	}
4284 	else
4285 	{
4286 	    win->w_redraw_top = qf_index;
4287 	    win->w_redraw_bot = old_qf_index;
4288 	}
4289 	qf_win_goto(win, qf_index);
4290     }
4291     return win != NULL;
4292 }
4293 
4294 /*
4295  * Check whether the given window is displaying the specified quickfix/location
4296  * stack.
4297  */
4298     static int
4299 is_qf_win(win_T *win, qf_info_T *qi)
4300 {
4301     // A window displaying the quickfix buffer will have the w_llist_ref field
4302     // set to NULL.
4303     // A window displaying a location list buffer will have the w_llist_ref
4304     // pointing to the location list.
4305     if (bt_quickfix(win->w_buffer))
4306 	if ((IS_QF_STACK(qi) && win->w_llist_ref == NULL)
4307 		|| (IS_LL_STACK(qi) && win->w_llist_ref == qi))
4308 	    return TRUE;
4309 
4310     return FALSE;
4311 }
4312 
4313 /*
4314  * Find a window displaying the quickfix/location stack 'qi'
4315  * Only searches in the current tabpage.
4316  */
4317     static win_T *
4318 qf_find_win(qf_info_T *qi)
4319 {
4320     win_T	*win;
4321 
4322     FOR_ALL_WINDOWS(win)
4323 	if (is_qf_win(win, qi))
4324 	    return win;
4325     return NULL;
4326 }
4327 
4328 /*
4329  * Find a quickfix buffer.
4330  * Searches in windows opened in all the tabs.
4331  */
4332     static buf_T *
4333 qf_find_buf(qf_info_T *qi)
4334 {
4335     tabpage_T	*tp;
4336     win_T	*win;
4337 
4338     if (qi->qf_bufnr != INVALID_QFBUFNR)
4339     {
4340 	buf_T	*qfbuf;
4341 	qfbuf = buflist_findnr(qi->qf_bufnr);
4342 	if (qfbuf != NULL)
4343 	    return qfbuf;
4344 	// buffer is no longer present
4345 	qi->qf_bufnr = INVALID_QFBUFNR;
4346     }
4347 
4348     FOR_ALL_TAB_WINDOWS(tp, win)
4349 	if (is_qf_win(win, qi))
4350 	    return win->w_buffer;
4351 
4352     return NULL;
4353 }
4354 
4355 /*
4356  * Update the w:quickfix_title variable in the quickfix/location list window
4357  */
4358     static void
4359 qf_update_win_titlevar(qf_info_T *qi)
4360 {
4361     win_T	*win;
4362     win_T	*curwin_save;
4363 
4364     if ((win = qf_find_win(qi)) != NULL)
4365     {
4366 	curwin_save = curwin;
4367 	curwin = win;
4368 	qf_set_title_var(qf_get_curlist(qi));
4369 	curwin = curwin_save;
4370     }
4371 }
4372 
4373 /*
4374  * Find the quickfix buffer.  If it exists, update the contents.
4375  */
4376     static void
4377 qf_update_buffer(qf_info_T *qi, qfline_T *old_last)
4378 {
4379     buf_T	*buf;
4380     win_T	*win;
4381     aco_save_T	aco;
4382 
4383     // Check if a buffer for the quickfix list exists.  Update it.
4384     buf = qf_find_buf(qi);
4385     if (buf != NULL)
4386     {
4387 	linenr_T	old_line_count = buf->b_ml.ml_line_count;
4388 
4389 	if (old_last == NULL)
4390 	    // set curwin/curbuf to buf and save a few things
4391 	    aucmd_prepbuf(&aco, buf);
4392 
4393 	qf_update_win_titlevar(qi);
4394 
4395 	qf_fill_buffer(qf_get_curlist(qi), buf, old_last);
4396 	++CHANGEDTICK(buf);
4397 
4398 	if (old_last == NULL)
4399 	{
4400 	    (void)qf_win_pos_update(qi, 0);
4401 
4402 	    // restore curwin/curbuf and a few other things
4403 	    aucmd_restbuf(&aco);
4404 	}
4405 
4406 	// Only redraw when added lines are visible.  This avoids flickering
4407 	// when the added lines are not visible.
4408 	if ((win = qf_find_win(qi)) != NULL && old_line_count < win->w_botline)
4409 	    redraw_buf_later(buf, NOT_VALID);
4410     }
4411 }
4412 
4413 /*
4414  * Add an error line to the quickfix buffer.
4415  */
4416     static int
4417 qf_buf_add_line(buf_T *buf, linenr_T lnum, qfline_T *qfp, char_u *dirname)
4418 {
4419     int		len;
4420     buf_T	*errbuf;
4421 
4422     if (qfp->qf_module != NULL)
4423     {
4424 	STRCPY(IObuff, qfp->qf_module);
4425 	len = (int)STRLEN(IObuff);
4426     }
4427     else if (qfp->qf_fnum != 0
4428 	    && (errbuf = buflist_findnr(qfp->qf_fnum)) != NULL
4429 	    && errbuf->b_fname != NULL)
4430     {
4431 	if (qfp->qf_type == 1)	// :helpgrep
4432 	    STRCPY(IObuff, gettail(errbuf->b_fname));
4433 	else
4434 	{
4435 	    // shorten the file name if not done already
4436 	    if (errbuf->b_sfname == NULL
4437 		    || mch_isFullName(errbuf->b_sfname))
4438 	    {
4439 		if (*dirname == NUL)
4440 		    mch_dirname(dirname, MAXPATHL);
4441 		shorten_buf_fname(errbuf, dirname, FALSE);
4442 	    }
4443 	    STRCPY(IObuff, errbuf->b_fname);
4444 	}
4445 	len = (int)STRLEN(IObuff);
4446     }
4447     else
4448 	len = 0;
4449     IObuff[len++] = '|';
4450 
4451     if (qfp->qf_lnum > 0)
4452     {
4453 	sprintf((char *)IObuff + len, "%ld", qfp->qf_lnum);
4454 	len += (int)STRLEN(IObuff + len);
4455 
4456 	if (qfp->qf_col > 0)
4457 	{
4458 	    sprintf((char *)IObuff + len, " col %d", qfp->qf_col);
4459 	    len += (int)STRLEN(IObuff + len);
4460 	}
4461 
4462 	sprintf((char *)IObuff + len, "%s",
4463 		(char *)qf_types(qfp->qf_type, qfp->qf_nr));
4464 	len += (int)STRLEN(IObuff + len);
4465     }
4466     else if (qfp->qf_pattern != NULL)
4467     {
4468 	qf_fmt_text(qfp->qf_pattern, IObuff + len, IOSIZE - len);
4469 	len += (int)STRLEN(IObuff + len);
4470     }
4471     IObuff[len++] = '|';
4472     IObuff[len++] = ' ';
4473 
4474     // Remove newlines and leading whitespace from the text.
4475     // For an unrecognized line keep the indent, the compiler may
4476     // mark a word with ^^^^.
4477     qf_fmt_text(len > 3 ? skipwhite(qfp->qf_text) : qfp->qf_text,
4478 	    IObuff + len, IOSIZE - len);
4479 
4480     if (ml_append_buf(buf, lnum, IObuff,
4481 		(colnr_T)STRLEN(IObuff) + 1, FALSE) == FAIL)
4482 	return FAIL;
4483 
4484     return OK;
4485 }
4486 
4487 /*
4488  * Fill current buffer with quickfix errors, replacing any previous contents.
4489  * curbuf must be the quickfix buffer!
4490  * If "old_last" is not NULL append the items after this one.
4491  * When "old_last" is NULL then "buf" must equal "curbuf"!  Because
4492  * ml_delete() is used and autocommands will be triggered.
4493  */
4494     static void
4495 qf_fill_buffer(qf_list_T *qfl, buf_T *buf, qfline_T *old_last)
4496 {
4497     linenr_T	lnum;
4498     qfline_T	*qfp;
4499     int		old_KeyTyped = KeyTyped;
4500 
4501     if (old_last == NULL)
4502     {
4503 	if (buf != curbuf)
4504 	{
4505 	    internal_error("qf_fill_buffer()");
4506 	    return;
4507 	}
4508 
4509 	// delete all existing lines
4510 	while ((curbuf->b_ml.ml_flags & ML_EMPTY) == 0)
4511 	    (void)ml_delete((linenr_T)1, FALSE);
4512     }
4513 
4514     // Check if there is anything to display
4515     if (qfl != NULL)
4516     {
4517 	char_u		dirname[MAXPATHL];
4518 
4519 	*dirname = NUL;
4520 
4521 	// Add one line for each error
4522 	if (old_last == NULL)
4523 	{
4524 	    qfp = qfl->qf_start;
4525 	    lnum = 0;
4526 	}
4527 	else
4528 	{
4529 	    qfp = old_last->qf_next;
4530 	    lnum = buf->b_ml.ml_line_count;
4531 	}
4532 	while (lnum < qfl->qf_count)
4533 	{
4534 	    if (qf_buf_add_line(buf, lnum, qfp, dirname) == FAIL)
4535 		break;
4536 
4537 	    ++lnum;
4538 	    qfp = qfp->qf_next;
4539 	    if (qfp == NULL)
4540 		break;
4541 	}
4542 
4543 	if (old_last == NULL)
4544 	    // Delete the empty line which is now at the end
4545 	    (void)ml_delete(lnum + 1, FALSE);
4546     }
4547 
4548     // correct cursor position
4549     check_lnums(TRUE);
4550 
4551     if (old_last == NULL)
4552     {
4553 	// Set the 'filetype' to "qf" each time after filling the buffer.
4554 	// This resembles reading a file into a buffer, it's more logical when
4555 	// using autocommands.
4556 	++curbuf_lock;
4557 	set_option_value((char_u *)"ft", 0L, (char_u *)"qf", OPT_LOCAL);
4558 	curbuf->b_p_ma = FALSE;
4559 
4560 	keep_filetype = TRUE;		// don't detect 'filetype'
4561 	apply_autocmds(EVENT_BUFREADPOST, (char_u *)"quickfix", NULL,
4562 							       FALSE, curbuf);
4563 	apply_autocmds(EVENT_BUFWINENTER, (char_u *)"quickfix", NULL,
4564 							       FALSE, curbuf);
4565 	keep_filetype = FALSE;
4566 	--curbuf_lock;
4567 
4568 	// make sure it will be redrawn
4569 	redraw_curbuf_later(NOT_VALID);
4570     }
4571 
4572     // Restore KeyTyped, setting 'filetype' may reset it.
4573     KeyTyped = old_KeyTyped;
4574 }
4575 
4576 /*
4577  * For every change made to the quickfix list, update the changed tick.
4578  */
4579     static void
4580 qf_list_changed(qf_list_T *qfl)
4581 {
4582     qfl->qf_changedtick++;
4583 }
4584 
4585 /*
4586  * Return the quickfix/location list number with the given identifier.
4587  * Returns -1 if list is not found.
4588  */
4589     static int
4590 qf_id2nr(qf_info_T *qi, int_u qfid)
4591 {
4592     int		qf_idx;
4593 
4594     for (qf_idx = 0; qf_idx < qi->qf_listcount; qf_idx++)
4595 	if (qi->qf_lists[qf_idx].qf_id == qfid)
4596 	    return qf_idx;
4597     return INVALID_QFIDX;
4598 }
4599 
4600 /*
4601  * If the current list is not "save_qfid" and we can find the list with that ID
4602  * then make it the current list.
4603  * This is used when autocommands may have changed the current list.
4604  * Returns OK if successfully restored the list. Returns FAIL if the list with
4605  * the specified identifier (save_qfid) is not found in the stack.
4606  */
4607     static int
4608 qf_restore_list(qf_info_T *qi, int_u save_qfid)
4609 {
4610     int curlist;
4611 
4612     if (qf_get_curlist(qi)->qf_id != save_qfid)
4613     {
4614 	curlist = qf_id2nr(qi, save_qfid);
4615 	if (curlist < 0)
4616 	    // list is not present
4617 	    return FAIL;
4618 	qi->qf_curlist = curlist;
4619     }
4620     return OK;
4621 }
4622 
4623 /*
4624  * Jump to the first entry if there is one.
4625  */
4626     static void
4627 qf_jump_first(qf_info_T *qi, int_u save_qfid, int forceit)
4628 {
4629     if (qf_restore_list(qi, save_qfid) == FAIL)
4630 	return;
4631 
4632     // Autocommands might have cleared the list, check for that.
4633     if (!qf_list_empty(qf_get_curlist(qi)))
4634 	qf_jump(qi, 0, 0, forceit);
4635 }
4636 
4637 /*
4638  * Return TRUE when using ":vimgrep" for ":grep".
4639  */
4640     int
4641 grep_internal(cmdidx_T cmdidx)
4642 {
4643     return ((cmdidx == CMD_grep
4644 		|| cmdidx == CMD_lgrep
4645 		|| cmdidx == CMD_grepadd
4646 		|| cmdidx == CMD_lgrepadd)
4647 	    && STRCMP("internal",
4648 			*curbuf->b_p_gp == NUL ? p_gp : curbuf->b_p_gp) == 0);
4649 }
4650 
4651 /*
4652  * Return the make/grep autocmd name.
4653  */
4654     static char_u *
4655 make_get_auname(cmdidx_T cmdidx)
4656 {
4657     switch (cmdidx)
4658     {
4659 	case CMD_make:	    return (char_u *)"make";
4660 	case CMD_lmake:	    return (char_u *)"lmake";
4661 	case CMD_grep:	    return (char_u *)"grep";
4662 	case CMD_lgrep:	    return (char_u *)"lgrep";
4663 	case CMD_grepadd:   return (char_u *)"grepadd";
4664 	case CMD_lgrepadd:  return (char_u *)"lgrepadd";
4665 	default: return NULL;
4666     }
4667 }
4668 
4669 /*
4670  * Return the name for the errorfile, in allocated memory.
4671  * Find a new unique name when 'makeef' contains "##".
4672  * Returns NULL for error.
4673  */
4674     static char_u *
4675 get_mef_name(void)
4676 {
4677     char_u	*p;
4678     char_u	*name;
4679     static int	start = -1;
4680     static int	off = 0;
4681 #ifdef HAVE_LSTAT
4682     stat_T	sb;
4683 #endif
4684 
4685     if (*p_mef == NUL)
4686     {
4687 	name = vim_tempname('e', FALSE);
4688 	if (name == NULL)
4689 	    emsg(_(e_notmp));
4690 	return name;
4691     }
4692 
4693     for (p = p_mef; *p; ++p)
4694 	if (p[0] == '#' && p[1] == '#')
4695 	    break;
4696 
4697     if (*p == NUL)
4698 	return vim_strsave(p_mef);
4699 
4700     // Keep trying until the name doesn't exist yet.
4701     for (;;)
4702     {
4703 	if (start == -1)
4704 	    start = mch_get_pid();
4705 	else
4706 	    off += 19;
4707 
4708 	name = alloc(STRLEN(p_mef) + 30);
4709 	if (name == NULL)
4710 	    break;
4711 	STRCPY(name, p_mef);
4712 	sprintf((char *)name + (p - p_mef), "%d%d", start, off);
4713 	STRCAT(name, p + 2);
4714 	if (mch_getperm(name) < 0
4715 #ifdef HAVE_LSTAT
4716 		    // Don't accept a symbolic link, it's a security risk.
4717 		    && mch_lstat((char *)name, &sb) < 0
4718 #endif
4719 		)
4720 	    break;
4721 	vim_free(name);
4722     }
4723     return name;
4724 }
4725 
4726 /*
4727  * Form the complete command line to invoke 'make'/'grep'. Quote the command
4728  * using 'shellquote' and append 'shellpipe'. Echo the fully formed command.
4729  */
4730     static char_u *
4731 make_get_fullcmd(char_u *makecmd, char_u *fname)
4732 {
4733     char_u	*cmd;
4734     unsigned	len;
4735 
4736     len = (unsigned)STRLEN(p_shq) * 2 + (unsigned)STRLEN(makecmd) + 1;
4737     if (*p_sp != NUL)
4738 	len += (unsigned)STRLEN(p_sp) + (unsigned)STRLEN(fname) + 3;
4739     cmd = alloc(len);
4740     if (cmd == NULL)
4741 	return NULL;
4742     sprintf((char *)cmd, "%s%s%s", (char *)p_shq, (char *)makecmd,
4743 							       (char *)p_shq);
4744 
4745     // If 'shellpipe' empty: don't redirect to 'errorfile'.
4746     if (*p_sp != NUL)
4747 	append_redir(cmd, len, p_sp, fname);
4748 
4749     // Display the fully formed command.  Output a newline if there's something
4750     // else than the :make command that was typed (in which case the cursor is
4751     // in column 0).
4752     if (msg_col == 0)
4753 	msg_didout = FALSE;
4754     msg_start();
4755     msg_puts(":!");
4756     msg_outtrans(cmd);		// show what we are doing
4757 
4758     return cmd;
4759 }
4760 
4761 /*
4762  * Used for ":make", ":lmake", ":grep", ":lgrep", ":grepadd", and ":lgrepadd"
4763  */
4764     void
4765 ex_make(exarg_T *eap)
4766 {
4767     char_u	*fname;
4768     char_u	*cmd;
4769     char_u	*enc = NULL;
4770     win_T	*wp = NULL;
4771     qf_info_T	*qi = &ql_info;
4772     int		res;
4773     char_u	*au_name = NULL;
4774     int_u	save_qfid;
4775 
4776     // Redirect ":grep" to ":vimgrep" if 'grepprg' is "internal".
4777     if (grep_internal(eap->cmdidx))
4778     {
4779 	ex_vimgrep(eap);
4780 	return;
4781     }
4782 
4783     au_name = make_get_auname(eap->cmdidx);
4784     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
4785 					       curbuf->b_fname, TRUE, curbuf))
4786     {
4787 #ifdef FEAT_EVAL
4788 	if (aborting())
4789 	    return;
4790 #endif
4791     }
4792     enc = (*curbuf->b_p_menc != NUL) ? curbuf->b_p_menc : p_menc;
4793 
4794     if (is_loclist_cmd(eap->cmdidx))
4795 	wp = curwin;
4796 
4797     autowrite_all();
4798     fname = get_mef_name();
4799     if (fname == NULL)
4800 	return;
4801     mch_remove(fname);	    // in case it's not unique
4802 
4803     cmd = make_get_fullcmd(eap->arg, fname);
4804     if (cmd == NULL)
4805 	return;
4806 
4807     // let the shell know if we are redirecting output or not
4808     do_shell(cmd, *p_sp != NUL ? SHELL_DOOUT : 0);
4809 
4810 #ifdef AMIGA
4811     out_flush();
4812 		// read window status report and redraw before message
4813     (void)char_avail();
4814 #endif
4815 
4816     incr_quickfix_busy();
4817 
4818     res = qf_init(wp, fname, (eap->cmdidx != CMD_make
4819 			    && eap->cmdidx != CMD_lmake) ? p_gefm : p_efm,
4820 					   (eap->cmdidx != CMD_grepadd
4821 					    && eap->cmdidx != CMD_lgrepadd),
4822 					   qf_cmdtitle(*eap->cmdlinep), enc);
4823     if (wp != NULL)
4824     {
4825 	qi = GET_LOC_LIST(wp);
4826 	if (qi == NULL)
4827 	    goto cleanup;
4828     }
4829     if (res >= 0)
4830 	qf_list_changed(qf_get_curlist(qi));
4831 
4832     // Remember the current quickfix list identifier, so that we can
4833     // check for autocommands changing the current quickfix list.
4834     save_qfid = qf_get_curlist(qi)->qf_id;
4835     if (au_name != NULL)
4836 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
4837 					       curbuf->b_fname, TRUE, curbuf);
4838     if (res > 0 && !eap->forceit && qflist_valid(wp, save_qfid))
4839 	// display the first error
4840 	qf_jump_first(qi, save_qfid, FALSE);
4841 
4842 cleanup:
4843     decr_quickfix_busy();
4844     mch_remove(fname);
4845     vim_free(fname);
4846     vim_free(cmd);
4847 }
4848 
4849 /*
4850  * Returns the number of entries in the current quickfix/location list.
4851  */
4852     int
4853 qf_get_size(exarg_T *eap)
4854 {
4855     qf_info_T	*qi;
4856 
4857     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4858 	return 0;
4859     return qf_get_curlist(qi)->qf_count;
4860 }
4861 
4862 /*
4863  * Returns the number of valid entries in the current quickfix/location list.
4864  */
4865     int
4866 qf_get_valid_size(exarg_T *eap)
4867 {
4868     qf_info_T	*qi;
4869     qf_list_T	*qfl;
4870     qfline_T	*qfp;
4871     int		i, sz = 0;
4872     int		prev_fnum = 0;
4873 
4874     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4875 	return 0;
4876 
4877     qfl = qf_get_curlist(qi);
4878     FOR_ALL_QFL_ITEMS(qfl, qfp, i)
4879     {
4880 	if (qfp->qf_valid)
4881 	{
4882 	    if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo)
4883 		sz++;	// Count all valid entries
4884 	    else if (qfp->qf_fnum > 0 && qfp->qf_fnum != prev_fnum)
4885 	    {
4886 		// Count the number of files
4887 		sz++;
4888 		prev_fnum = qfp->qf_fnum;
4889 	    }
4890 	}
4891     }
4892 
4893     return sz;
4894 }
4895 
4896 /*
4897  * Returns the current index of the quickfix/location list.
4898  * Returns 0 if there is an error.
4899  */
4900     int
4901 qf_get_cur_idx(exarg_T *eap)
4902 {
4903     qf_info_T	*qi;
4904 
4905     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4906 	return 0;
4907 
4908     return qf_get_curlist(qi)->qf_index;
4909 }
4910 
4911 /*
4912  * Returns the current index in the quickfix/location list (counting only valid
4913  * entries). If no valid entries are in the list, then returns 1.
4914  */
4915     int
4916 qf_get_cur_valid_idx(exarg_T *eap)
4917 {
4918     qf_info_T	*qi;
4919     qf_list_T	*qfl;
4920     qfline_T	*qfp;
4921     int		i, eidx = 0;
4922     int		prev_fnum = 0;
4923 
4924     if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4925 	return 1;
4926 
4927     qfl = qf_get_curlist(qi);
4928     qfp = qfl->qf_start;
4929 
4930     // check if the list has valid errors
4931     if (!qf_list_has_valid_entries(qfl))
4932 	return 1;
4933 
4934     for (i = 1; i <= qfl->qf_index && qfp!= NULL; i++, qfp = qfp->qf_next)
4935     {
4936 	if (qfp->qf_valid)
4937 	{
4938 	    if (eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
4939 	    {
4940 		if (qfp->qf_fnum > 0 && qfp->qf_fnum != prev_fnum)
4941 		{
4942 		    // Count the number of files
4943 		    eidx++;
4944 		    prev_fnum = qfp->qf_fnum;
4945 		}
4946 	    }
4947 	    else
4948 		eidx++;
4949 	}
4950     }
4951 
4952     return eidx ? eidx : 1;
4953 }
4954 
4955 /*
4956  * Get the 'n'th valid error entry in the quickfix or location list.
4957  * Used by :cdo, :ldo, :cfdo and :lfdo commands.
4958  * For :cdo and :ldo returns the 'n'th valid error entry.
4959  * For :cfdo and :lfdo returns the 'n'th valid file entry.
4960  */
4961     static int
4962 qf_get_nth_valid_entry(qf_list_T *qfl, int n, int fdo)
4963 {
4964     qfline_T	*qfp;
4965     int		i, eidx;
4966     int		prev_fnum = 0;
4967 
4968     // check if the list has valid errors
4969     if (!qf_list_has_valid_entries(qfl))
4970 	return 1;
4971 
4972     eidx = 0;
4973     FOR_ALL_QFL_ITEMS(qfl, qfp, i)
4974     {
4975 	if (qfp->qf_valid)
4976 	{
4977 	    if (fdo)
4978 	    {
4979 		if (qfp->qf_fnum > 0 && qfp->qf_fnum != prev_fnum)
4980 		{
4981 		    // Count the number of files
4982 		    eidx++;
4983 		    prev_fnum = qfp->qf_fnum;
4984 		}
4985 	    }
4986 	    else
4987 		eidx++;
4988 	}
4989 
4990 	if (eidx == n)
4991 	    break;
4992     }
4993 
4994     if (i <= qfl->qf_count)
4995 	return i;
4996     else
4997 	return 1;
4998 }
4999 
5000 /*
5001  * ":cc", ":crewind", ":cfirst" and ":clast".
5002  * ":ll", ":lrewind", ":lfirst" and ":llast".
5003  * ":cdo", ":ldo", ":cfdo" and ":lfdo"
5004  */
5005     void
5006 ex_cc(exarg_T *eap)
5007 {
5008     qf_info_T	*qi;
5009     int		errornr;
5010 
5011     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
5012 	return;
5013 
5014     if (eap->addr_count > 0)
5015 	errornr = (int)eap->line2;
5016     else
5017     {
5018 	switch (eap->cmdidx)
5019 	{
5020 	    case CMD_cc: case CMD_ll:
5021 		errornr = 0;
5022 		break;
5023 	    case CMD_crewind: case CMD_lrewind: case CMD_cfirst:
5024 	    case CMD_lfirst:
5025 		errornr = 1;
5026 		break;
5027 	    default:
5028 		errornr = 32767;
5029 	}
5030     }
5031 
5032     // For cdo and ldo commands, jump to the nth valid error.
5033     // For cfdo and lfdo commands, jump to the nth valid file entry.
5034     if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
5035 	    || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
5036 	errornr = qf_get_nth_valid_entry(qf_get_curlist(qi),
5037 		eap->addr_count > 0 ? (int)eap->line1 : 1,
5038 		eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo);
5039 
5040     qf_jump(qi, 0, errornr, eap->forceit);
5041 }
5042 
5043 /*
5044  * ":cnext", ":cnfile", ":cNext" and ":cprevious".
5045  * ":lnext", ":lNext", ":lprevious", ":lnfile", ":lNfile" and ":lpfile".
5046  * Also, used by ":cdo", ":ldo", ":cfdo" and ":lfdo" commands.
5047  */
5048     void
5049 ex_cnext(exarg_T *eap)
5050 {
5051     qf_info_T	*qi;
5052     int		errornr;
5053     int		dir;
5054 
5055     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
5056 	return;
5057 
5058     if (eap->addr_count > 0
5059 	    && (eap->cmdidx != CMD_cdo && eap->cmdidx != CMD_ldo
5060 		&& eap->cmdidx != CMD_cfdo && eap->cmdidx != CMD_lfdo))
5061 	errornr = (int)eap->line2;
5062     else
5063 	errornr = 1;
5064 
5065     // Depending on the command jump to either next or previous entry/file.
5066     switch (eap->cmdidx)
5067     {
5068 	case CMD_cnext: case CMD_lnext: case CMD_cdo: case CMD_ldo:
5069 	    dir = FORWARD;
5070 	    break;
5071 	case CMD_cprevious: case CMD_lprevious: case CMD_cNext:
5072 	case CMD_lNext:
5073 	    dir = BACKWARD;
5074 	    break;
5075 	case CMD_cnfile: case CMD_lnfile: case CMD_cfdo: case CMD_lfdo:
5076 	    dir = FORWARD_FILE;
5077 	    break;
5078 	case CMD_cpfile: case CMD_lpfile: case CMD_cNfile: case CMD_lNfile:
5079 	    dir = BACKWARD_FILE;
5080 	    break;
5081 	default:
5082 	    dir = FORWARD;
5083 	    break;
5084     }
5085 
5086     qf_jump(qi, dir, errornr, eap->forceit);
5087 }
5088 
5089 /*
5090  * Find the first entry in the quickfix list 'qfl' from buffer 'bnr'.
5091  * The index of the entry is stored in 'errornr'.
5092  * Returns NULL if an entry is not found.
5093  */
5094     static qfline_T *
5095 qf_find_first_entry_in_buf(qf_list_T *qfl, int bnr, int *errornr)
5096 {
5097     qfline_T	*qfp = NULL;
5098     int		idx = 0;
5099 
5100     // Find the first entry in this file
5101     FOR_ALL_QFL_ITEMS(qfl, qfp, idx)
5102 	if (qfp->qf_fnum == bnr)
5103 	    break;
5104 
5105     *errornr = idx;
5106     return qfp;
5107 }
5108 
5109 /*
5110  * Find the first quickfix entry on the same line as 'entry'. Updates 'errornr'
5111  * with the error number for the first entry. Assumes the entries are sorted in
5112  * the quickfix list by line number.
5113  */
5114     static qfline_T *
5115 qf_find_first_entry_on_line(qfline_T *entry, int *errornr)
5116 {
5117     while (!got_int
5118 	    && entry->qf_prev != NULL
5119 	    && entry->qf_fnum == entry->qf_prev->qf_fnum
5120 	    && entry->qf_lnum == entry->qf_prev->qf_lnum)
5121     {
5122 	entry = entry->qf_prev;
5123 	--*errornr;
5124     }
5125 
5126     return entry;
5127 }
5128 
5129 /*
5130  * Find the last quickfix entry on the same line as 'entry'. Updates 'errornr'
5131  * with the error number for the last entry. Assumes the entries are sorted in
5132  * the quickfix list by line number.
5133  */
5134     static qfline_T *
5135 qf_find_last_entry_on_line(qfline_T *entry, int *errornr)
5136 {
5137     while (!got_int &&
5138 	    entry->qf_next != NULL
5139 	    && entry->qf_fnum == entry->qf_next->qf_fnum
5140 	    && entry->qf_lnum == entry->qf_next->qf_lnum)
5141     {
5142 	entry = entry->qf_next;
5143 	++*errornr;
5144     }
5145 
5146     return entry;
5147 }
5148 
5149 /*
5150  * Returns TRUE if the specified quickfix entry is
5151  *   after the given line (linewise is TRUE)
5152  *   or after the line and column.
5153  */
5154     static int
5155 qf_entry_after_pos(qfline_T *qfp, pos_T *pos, int linewise)
5156 {
5157     if (linewise)
5158 	return qfp->qf_lnum > pos->lnum;
5159     else
5160 	return (qfp->qf_lnum > pos->lnum ||
5161 		(qfp->qf_lnum == pos->lnum && qfp->qf_col > pos->col));
5162 }
5163 
5164 /*
5165  * Returns TRUE if the specified quickfix entry is
5166  *   before the given line (linewise is TRUE)
5167  *   or before the line and column.
5168  */
5169     static int
5170 qf_entry_before_pos(qfline_T *qfp, pos_T *pos, int linewise)
5171 {
5172     if (linewise)
5173 	return qfp->qf_lnum < pos->lnum;
5174     else
5175 	return (qfp->qf_lnum < pos->lnum ||
5176 		(qfp->qf_lnum == pos->lnum && qfp->qf_col < pos->col));
5177 }
5178 
5179 /*
5180  * Returns TRUE if the specified quickfix entry is
5181  *   on or after the given line (linewise is TRUE)
5182  *   or on or after the line and column.
5183  */
5184     static int
5185 qf_entry_on_or_after_pos(qfline_T *qfp, pos_T *pos, int linewise)
5186 {
5187     if (linewise)
5188 	return qfp->qf_lnum >= pos->lnum;
5189     else
5190 	return (qfp->qf_lnum > pos->lnum ||
5191 		(qfp->qf_lnum == pos->lnum && qfp->qf_col >= pos->col));
5192 }
5193 
5194 /*
5195  * Returns TRUE if the specified quickfix entry is
5196  *   on or before the given line (linewise is TRUE)
5197  *   or on or before the line and column.
5198  */
5199     static int
5200 qf_entry_on_or_before_pos(qfline_T *qfp, pos_T *pos, int linewise)
5201 {
5202     if (linewise)
5203 	return qfp->qf_lnum <= pos->lnum;
5204     else
5205 	return (qfp->qf_lnum < pos->lnum ||
5206 		(qfp->qf_lnum == pos->lnum && qfp->qf_col <= pos->col));
5207 }
5208 
5209 /*
5210  * Find the first quickfix entry after position 'pos' in buffer 'bnr'.
5211  * If 'linewise' is TRUE, returns the entry after the specified line and treats
5212  * multiple entries on a single line as one. Otherwise returns the entry after
5213  * the specified line and column.
5214  * 'qfp' points to the very first entry in the buffer and 'errornr' is the
5215  * index of the very first entry in the quickfix list.
5216  * Returns NULL if an entry is not found after 'pos'.
5217  */
5218     static qfline_T *
5219 qf_find_entry_after_pos(
5220 	int		bnr,
5221 	pos_T		*pos,
5222 	int		linewise,
5223 	qfline_T	*qfp,
5224 	int		*errornr)
5225 {
5226     if (qf_entry_after_pos(qfp, pos, linewise))
5227 	// First entry is after position 'pos'
5228 	return qfp;
5229 
5230     // Find the entry just before or at the position 'pos'
5231     while (qfp->qf_next != NULL
5232 	    && qfp->qf_next->qf_fnum == bnr
5233 	    && qf_entry_on_or_before_pos(qfp->qf_next, pos, linewise))
5234     {
5235 	qfp = qfp->qf_next;
5236 	++*errornr;
5237     }
5238 
5239     if (qfp->qf_next == NULL || qfp->qf_next->qf_fnum != bnr)
5240 	// No entries found after position 'pos'
5241 	return NULL;
5242 
5243     // Use the entry just after position 'pos'
5244     qfp = qfp->qf_next;
5245     ++*errornr;
5246 
5247     return qfp;
5248 }
5249 
5250 /*
5251  * Find the first quickfix entry before position 'pos' in buffer 'bnr'.
5252  * If 'linewise' is TRUE, returns the entry before the specified line and
5253  * treats multiple entries on a single line as one. Otherwise returns the entry
5254  * before the specified line and column.
5255  * 'qfp' points to the very first entry in the buffer and 'errornr' is the
5256  * index of the very first entry in the quickfix list.
5257  * Returns NULL if an entry is not found before 'pos'.
5258  */
5259     static qfline_T *
5260 qf_find_entry_before_pos(
5261 	int		bnr,
5262 	pos_T		*pos,
5263 	int		linewise,
5264 	qfline_T	*qfp,
5265 	int		*errornr)
5266 {
5267     // Find the entry just before the position 'pos'
5268     while (qfp->qf_next != NULL
5269 	    && qfp->qf_next->qf_fnum == bnr
5270 	    && qf_entry_before_pos(qfp->qf_next, pos, linewise))
5271     {
5272 	qfp = qfp->qf_next;
5273 	++*errornr;
5274     }
5275 
5276     if (qf_entry_on_or_after_pos(qfp, pos, linewise))
5277 	return NULL;
5278 
5279     if (linewise)
5280 	// If multiple entries are on the same line, then use the first entry
5281 	qfp = qf_find_first_entry_on_line(qfp, errornr);
5282 
5283     return qfp;
5284 }
5285 
5286 /*
5287  * Find a quickfix entry in 'qfl' closest to position 'pos' in buffer 'bnr' in
5288  * the direction 'dir'.
5289  */
5290     static qfline_T *
5291 qf_find_closest_entry(
5292 	qf_list_T	*qfl,
5293 	int		bnr,
5294 	pos_T		*pos,
5295 	int		dir,
5296 	int		linewise,
5297 	int		*errornr)
5298 {
5299     qfline_T	*qfp;
5300 
5301     *errornr = 0;
5302 
5303     // Find the first entry in this file
5304     qfp = qf_find_first_entry_in_buf(qfl, bnr, errornr);
5305     if (qfp == NULL)
5306 	return NULL;		// no entry in this file
5307 
5308     if (dir == FORWARD)
5309 	qfp = qf_find_entry_after_pos(bnr, pos, linewise, qfp, errornr);
5310     else
5311 	qfp = qf_find_entry_before_pos(bnr, pos, linewise, qfp, errornr);
5312 
5313     return qfp;
5314 }
5315 
5316 /*
5317  * Get the nth quickfix entry below the specified entry.  Searches forward in
5318  * the list. If linewise is TRUE, then treat multiple entries on a single line
5319  * as one.
5320  */
5321     static void
5322 qf_get_nth_below_entry(qfline_T *entry_arg, int n, int linewise, int *errornr)
5323 {
5324     qfline_T *entry = entry_arg;
5325 
5326     while (n-- > 0 && !got_int)
5327     {
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 		*errornr = first_errornr;
5339 	    break;
5340 	}
5341 
5342 	entry = entry->qf_next;
5343 	++*errornr;
5344     }
5345 }
5346 
5347 /*
5348  * Get the nth quickfix entry above the specified entry.  Searches backwards in
5349  * the list. If linewise is TRUE, then treat multiple entries on a single line
5350  * as one.
5351  */
5352     static void
5353 qf_get_nth_above_entry(qfline_T *entry, int n, int linewise, int *errornr)
5354 {
5355     while (n-- > 0 && !got_int)
5356     {
5357 	if (entry->qf_prev == NULL
5358 		|| entry->qf_prev->qf_fnum != entry->qf_fnum)
5359 	    break;
5360 
5361 	entry = entry->qf_prev;
5362 	--*errornr;
5363 
5364 	// If multiple entries are on the same line, then use the first entry
5365 	if (linewise)
5366 	    entry = qf_find_first_entry_on_line(entry, errornr);
5367     }
5368 }
5369 
5370 /*
5371  * Find the n'th quickfix entry adjacent to position 'pos' in buffer 'bnr' in
5372  * the specified direction.  Returns the error number in the quickfix list or 0
5373  * if an entry is not found.
5374  */
5375     static int
5376 qf_find_nth_adj_entry(
5377 	qf_list_T	*qfl,
5378 	int		bnr,
5379 	pos_T		*pos,
5380 	int		n,
5381 	int		dir,
5382 	int		linewise)
5383 {
5384     qfline_T	*adj_entry;
5385     int		errornr;
5386 
5387     // Find an entry closest to the specified position
5388     adj_entry = qf_find_closest_entry(qfl, bnr, pos, dir, linewise, &errornr);
5389     if (adj_entry == NULL)
5390 	return 0;
5391 
5392     if (--n > 0)
5393     {
5394 	// Go to the n'th entry in the current buffer
5395 	if (dir == FORWARD)
5396 	    qf_get_nth_below_entry(adj_entry, n, linewise, &errornr);
5397 	else
5398 	    qf_get_nth_above_entry(adj_entry, n, linewise, &errornr);
5399     }
5400 
5401     return errornr;
5402 }
5403 
5404 /*
5405  * Jump to a quickfix entry in the current file nearest to the current line or
5406  * current line/col.
5407  * ":cabove", ":cbelow", ":labove", ":lbelow", ":cafter", ":cbefore",
5408  * ":lafter" and ":lbefore" commands
5409  */
5410     void
5411 ex_cbelow(exarg_T *eap)
5412 {
5413     qf_info_T	*qi;
5414     qf_list_T	*qfl;
5415     int		dir;
5416     int		buf_has_flag;
5417     int		errornr = 0;
5418     pos_T	pos;
5419 
5420     if (eap->addr_count > 0 && eap->line2 <= 0)
5421     {
5422 	emsg(_(e_invrange));
5423 	return;
5424     }
5425 
5426     // Check whether the current buffer has any quickfix entries
5427     if (eap->cmdidx == CMD_cabove || eap->cmdidx == CMD_cbelow
5428 	    || eap->cmdidx == CMD_cbefore || eap->cmdidx == CMD_cafter)
5429 	buf_has_flag = BUF_HAS_QF_ENTRY;
5430     else
5431 	buf_has_flag = BUF_HAS_LL_ENTRY;
5432     if (!(curbuf->b_has_qf_entry & buf_has_flag))
5433     {
5434 	emsg(_(e_quickfix));
5435 	return;
5436     }
5437 
5438     if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
5439 	return;
5440 
5441     qfl = qf_get_curlist(qi);
5442     // check if the list has valid errors
5443     if (!qf_list_has_valid_entries(qfl))
5444     {
5445 	emsg(_(e_quickfix));
5446 	return;
5447     }
5448 
5449     if (eap->cmdidx == CMD_cbelow
5450 	    || eap->cmdidx == CMD_lbelow
5451 	    || eap->cmdidx == CMD_cafter
5452 	    || eap->cmdidx == CMD_lafter)
5453 	// Forward motion commands
5454 	dir = FORWARD;
5455     else
5456 	dir = BACKWARD;
5457 
5458     pos = curwin->w_cursor;
5459     // A quickfix entry column number is 1 based whereas cursor column
5460     // number is 0 based. Adjust the column number.
5461     pos.col++;
5462     errornr = qf_find_nth_adj_entry(qfl, curbuf->b_fnum, &pos,
5463 				eap->addr_count > 0 ? eap->line2 : 0, dir,
5464 				eap->cmdidx == CMD_cbelow
5465 					|| eap->cmdidx == CMD_lbelow
5466 					|| eap->cmdidx == CMD_cabove
5467 					|| eap->cmdidx == CMD_labove);
5468 
5469     if (errornr > 0)
5470 	qf_jump(qi, 0, errornr, FALSE);
5471     else
5472 	emsg(_(e_no_more_items));
5473 }
5474 
5475 /*
5476  * Return the autocmd name for the :cfile Ex commands
5477  */
5478     static char_u *
5479 cfile_get_auname(cmdidx_T cmdidx)
5480 {
5481     switch (cmdidx)
5482     {
5483 	case CMD_cfile:	    return (char_u *)"cfile";
5484 	case CMD_cgetfile:  return (char_u *)"cgetfile";
5485 	case CMD_caddfile:  return (char_u *)"caddfile";
5486 	case CMD_lfile:	    return (char_u *)"lfile";
5487 	case CMD_lgetfile:  return (char_u *)"lgetfile";
5488 	case CMD_laddfile:  return (char_u *)"laddfile";
5489 	default:	    return NULL;
5490     }
5491 }
5492 
5493 /*
5494  * ":cfile"/":cgetfile"/":caddfile" commands.
5495  * ":lfile"/":lgetfile"/":laddfile" commands.
5496  */
5497     void
5498 ex_cfile(exarg_T *eap)
5499 {
5500     char_u	*enc = NULL;
5501     win_T	*wp = NULL;
5502     qf_info_T	*qi = &ql_info;
5503     char_u	*au_name = NULL;
5504     int_u	save_qfid = 0;		// init for gcc
5505     int		res;
5506 
5507     au_name = cfile_get_auname(eap->cmdidx);
5508     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
5509 							NULL, FALSE, curbuf))
5510     {
5511 #ifdef FEAT_EVAL
5512 	if (aborting())
5513 	    return;
5514 #endif
5515     }
5516 
5517     enc = (*curbuf->b_p_menc != NUL) ? curbuf->b_p_menc : p_menc;
5518 #ifdef FEAT_BROWSE
5519     if (cmdmod.browse)
5520     {
5521 	char_u *browse_file = do_browse(0, (char_u *)_("Error file"), eap->arg,
5522 				   NULL, NULL,
5523 				   (char_u *)_(BROWSE_FILTER_ALL_FILES), NULL);
5524 	if (browse_file == NULL)
5525 	    return;
5526 	set_string_option_direct((char_u *)"ef", -1, browse_file, OPT_FREE, 0);
5527 	vim_free(browse_file);
5528     }
5529     else
5530 #endif
5531     if (*eap->arg != NUL)
5532 	set_string_option_direct((char_u *)"ef", -1, eap->arg, OPT_FREE, 0);
5533 
5534     if (is_loclist_cmd(eap->cmdidx))
5535 	wp = curwin;
5536 
5537     incr_quickfix_busy();
5538 
5539     // This function is used by the :cfile, :cgetfile and :caddfile
5540     // commands.
5541     // :cfile always creates a new quickfix list and jumps to the
5542     // first error.
5543     // :cgetfile creates a new quickfix list but doesn't jump to the
5544     // first error.
5545     // :caddfile adds to an existing quickfix list. If there is no
5546     // quickfix list then a new list is created.
5547     res = qf_init(wp, p_ef, p_efm, (eap->cmdidx != CMD_caddfile
5548 			&& eap->cmdidx != CMD_laddfile),
5549 			qf_cmdtitle(*eap->cmdlinep), enc);
5550     if (wp != NULL)
5551     {
5552 	qi = GET_LOC_LIST(wp);
5553 	if (qi == NULL)
5554 	{
5555 	    decr_quickfix_busy();
5556 	    return;
5557 	}
5558     }
5559     if (res >= 0)
5560 	qf_list_changed(qf_get_curlist(qi));
5561     save_qfid = qf_get_curlist(qi)->qf_id;
5562     if (au_name != NULL)
5563 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name, NULL, FALSE, curbuf);
5564 
5565     // Jump to the first error for a new list and if autocmds didn't
5566     // free the list.
5567     if (res > 0 && (eap->cmdidx == CMD_cfile || eap->cmdidx == CMD_lfile)
5568 	    && qflist_valid(wp, save_qfid))
5569 	// display the first error
5570 	qf_jump_first(qi, save_qfid, eap->forceit);
5571 
5572     decr_quickfix_busy();
5573 }
5574 
5575 /*
5576  * Return the vimgrep autocmd name.
5577  */
5578     static char_u *
5579 vgr_get_auname(cmdidx_T cmdidx)
5580 {
5581     switch (cmdidx)
5582     {
5583 	case CMD_vimgrep:     return (char_u *)"vimgrep";
5584 	case CMD_lvimgrep:    return (char_u *)"lvimgrep";
5585 	case CMD_vimgrepadd:  return (char_u *)"vimgrepadd";
5586 	case CMD_lvimgrepadd: return (char_u *)"lvimgrepadd";
5587 	case CMD_grep:	      return (char_u *)"grep";
5588 	case CMD_lgrep:	      return (char_u *)"lgrep";
5589 	case CMD_grepadd:     return (char_u *)"grepadd";
5590 	case CMD_lgrepadd:    return (char_u *)"lgrepadd";
5591 	default: return NULL;
5592     }
5593 }
5594 
5595 /*
5596  * Initialize the regmatch used by vimgrep for pattern "s".
5597  */
5598     static void
5599 vgr_init_regmatch(regmmatch_T *regmatch, char_u *s)
5600 {
5601     // Get the search pattern: either white-separated or enclosed in //
5602     regmatch->regprog = NULL;
5603 
5604     if (s == NULL || *s == NUL)
5605     {
5606 	// Pattern is empty, use last search pattern.
5607 	if (last_search_pat() == NULL)
5608 	{
5609 	    emsg(_(e_noprevre));
5610 	    return;
5611 	}
5612 	regmatch->regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
5613     }
5614     else
5615 	regmatch->regprog = vim_regcomp(s, RE_MAGIC);
5616 
5617     regmatch->rmm_ic = p_ic;
5618     regmatch->rmm_maxcol = 0;
5619 }
5620 
5621 /*
5622  * Display a file name when vimgrep is running.
5623  */
5624     static void
5625 vgr_display_fname(char_u *fname)
5626 {
5627     char_u	*p;
5628 
5629     msg_start();
5630     p = msg_strtrunc(fname, TRUE);
5631     if (p == NULL)
5632 	msg_outtrans(fname);
5633     else
5634     {
5635 	msg_outtrans(p);
5636 	vim_free(p);
5637     }
5638     msg_clr_eos();
5639     msg_didout = FALSE;	    // overwrite this message
5640     msg_nowait = TRUE;	    // don't wait for this message
5641     msg_col = 0;
5642     out_flush();
5643 }
5644 
5645 /*
5646  * Load a dummy buffer to search for a pattern using vimgrep.
5647  */
5648     static buf_T *
5649 vgr_load_dummy_buf(
5650 	char_u *fname,
5651 	char_u *dirname_start,
5652 	char_u *dirname_now)
5653 {
5654     int		save_mls;
5655 #if defined(FEAT_SYN_HL)
5656     char_u	*save_ei = NULL;
5657 #endif
5658     buf_T	*buf;
5659 
5660 #if defined(FEAT_SYN_HL)
5661     // Don't do Filetype autocommands to avoid loading syntax and
5662     // indent scripts, a great speed improvement.
5663     save_ei = au_event_disable(",Filetype");
5664 #endif
5665     // Don't use modelines here, it's useless.
5666     save_mls = p_mls;
5667     p_mls = 0;
5668 
5669     // Load file into a buffer, so that 'fileencoding' is detected,
5670     // autocommands applied, etc.
5671     buf = load_dummy_buffer(fname, dirname_start, dirname_now);
5672 
5673     p_mls = save_mls;
5674 #if defined(FEAT_SYN_HL)
5675     au_event_restore(save_ei);
5676 #endif
5677 
5678     return buf;
5679 }
5680 
5681 /*
5682  * Check whether a quickfix/location list is valid. Autocmds may remove or
5683  * change a quickfix list when vimgrep is running. If the list is not found,
5684  * create a new list.
5685  */
5686     static int
5687 vgr_qflist_valid(
5688 	win_T	    *wp,
5689 	qf_info_T   *qi,
5690 	int_u	    qfid,
5691 	char_u	    *title)
5692 {
5693     // Verify that the quickfix/location list was not freed by an autocmd
5694     if (!qflist_valid(wp, qfid))
5695     {
5696 	if (wp != NULL)
5697 	{
5698 	    // An autocmd has freed the location list.
5699 	    emsg(_(e_loc_list_changed));
5700 	    return FALSE;
5701 	}
5702 	else
5703 	{
5704 	    // Quickfix list is not found, create a new one.
5705 	    qf_new_list(qi, title);
5706 	    return TRUE;
5707 	}
5708     }
5709 
5710     if (qf_restore_list(qi, qfid) == FAIL)
5711 	return FALSE;
5712 
5713     return TRUE;
5714 }
5715 
5716 /*
5717  * Search for a pattern in all the lines in a buffer and add the matching lines
5718  * to a quickfix list.
5719  */
5720     static int
5721 vgr_match_buflines(
5722 	qf_list_T   *qfl,
5723 	char_u	    *fname,
5724 	buf_T	    *buf,
5725 	regmmatch_T *regmatch,
5726 	long	    *tomatch,
5727 	int	    duplicate_name,
5728 	int	    flags)
5729 {
5730     int		found_match = FALSE;
5731     long	lnum;
5732     colnr_T	col;
5733 
5734     for (lnum = 1; lnum <= buf->b_ml.ml_line_count && *tomatch > 0; ++lnum)
5735     {
5736 	col = 0;
5737 	while (vim_regexec_multi(regmatch, curwin, buf, lnum,
5738 		    col, NULL, NULL) > 0)
5739 	{
5740 	    // Pass the buffer number so that it gets used even for a
5741 	    // dummy buffer, unless duplicate_name is set, then the
5742 	    // buffer will be wiped out below.
5743 	    if (qf_add_entry(qfl,
5744 			NULL,       // dir
5745 			fname,
5746 			NULL,
5747 			duplicate_name ? 0 : buf->b_fnum,
5748 			ml_get_buf(buf,
5749 			    regmatch->startpos[0].lnum + lnum, FALSE),
5750 			regmatch->startpos[0].lnum + lnum,
5751 			regmatch->startpos[0].col + 1,
5752 			FALSE,      // vis_col
5753 			NULL,	    // search pattern
5754 			0,	    // nr
5755 			0,	    // type
5756 			TRUE	    // valid
5757 			) == QF_FAIL)
5758 	    {
5759 		got_int = TRUE;
5760 		break;
5761 	    }
5762 	    found_match = TRUE;
5763 	    if (--*tomatch == 0)
5764 		break;
5765 	    if ((flags & VGR_GLOBAL) == 0
5766 		    || regmatch->endpos[0].lnum > 0)
5767 		break;
5768 	    col = regmatch->endpos[0].col
5769 		+ (col == regmatch->endpos[0].col);
5770 	    if (col > (colnr_T)STRLEN(ml_get_buf(buf, lnum, FALSE)))
5771 		break;
5772 	}
5773 	line_breakcheck();
5774 	if (got_int)
5775 	    break;
5776     }
5777 
5778     return found_match;
5779 }
5780 
5781 /*
5782  * Jump to the first match and update the directory.
5783  */
5784     static void
5785 vgr_jump_to_match(
5786 	qf_info_T   *qi,
5787 	int	    forceit,
5788 	int	    *redraw_for_dummy,
5789 	buf_T	    *first_match_buf,
5790 	char_u	    *target_dir)
5791 {
5792     buf_T	*buf;
5793 
5794     buf = curbuf;
5795     qf_jump(qi, 0, 0, forceit);
5796     if (buf != curbuf)
5797 	// If we jumped to another buffer redrawing will already be
5798 	// taken care of.
5799 	*redraw_for_dummy = FALSE;
5800 
5801     // Jump to the directory used after loading the buffer.
5802     if (curbuf == first_match_buf && target_dir != NULL)
5803     {
5804 	exarg_T ea;
5805 
5806 	vim_memset(&ea, 0, sizeof(ea));
5807 	ea.arg = target_dir;
5808 	ea.cmdidx = CMD_lcd;
5809 	ex_cd(&ea);
5810     }
5811 }
5812 
5813 /*
5814  * :vimgrep command arguments
5815  */
5816 typedef struct
5817 {
5818     long	tomatch;	// maximum number of matches to find
5819     char_u	*spat;		// search pattern
5820     int		flags;		// search modifier
5821     char_u	**fnames;	// list of files to search
5822     int		fcount;		// number of files
5823     regmmatch_T	regmatch;	// compiled search pattern
5824     char_u	*qf_title;	// quickfix list title
5825 } vgr_args_T;
5826 
5827 /*
5828  * Process :vimgrep command arguments. The command syntax is:
5829  *
5830  *	:{count}vimgrep /{pattern}/[g][j] {file} ...
5831  */
5832     static int
5833 vgr_process_args(
5834 	exarg_T		*eap,
5835 	vgr_args_T	*args)
5836 {
5837     char_u	*p;
5838 
5839     vim_memset(args, 0, sizeof(*args));
5840 
5841     args->regmatch.regprog = NULL;
5842     args->qf_title = vim_strsave(qf_cmdtitle(*eap->cmdlinep));
5843 
5844     if (eap->addr_count > 0)
5845 	args->tomatch = eap->line2;
5846     else
5847 	args->tomatch = MAXLNUM;
5848 
5849     // Get the search pattern: either white-separated or enclosed in //
5850     p = skip_vimgrep_pat(eap->arg, &args->spat, &args->flags);
5851     if (p == NULL)
5852     {
5853 	emsg(_(e_invalpat));
5854 	return FAIL;
5855     }
5856 
5857     vgr_init_regmatch(&args->regmatch, args->spat);
5858     if (args->regmatch.regprog == NULL)
5859 	return FAIL;
5860 
5861     p = skipwhite(p);
5862     if (*p == NUL)
5863     {
5864 	emsg(_("E683: File name missing or invalid pattern"));
5865 	return FAIL;
5866     }
5867 
5868     // parse the list of arguments
5869     if (get_arglist_exp(p, &args->fcount, &args->fnames, TRUE) == FAIL)
5870 	return FAIL;
5871     if (args->fcount == 0)
5872     {
5873 	emsg(_(e_nomatch));
5874 	return FAIL;
5875     }
5876 
5877     return OK;
5878 }
5879 
5880 /*
5881  * Search for a pattern in a list of files and populate the quickfix list with
5882  * the matches.
5883  */
5884     static int
5885 vgr_process_files(
5886 	win_T		*wp,
5887 	qf_info_T	*qi,
5888 	vgr_args_T	*cmd_args,
5889 	int		*redraw_for_dummy,
5890 	buf_T		**first_match_buf,
5891 	char_u		**target_dir)
5892 {
5893     int		status = FAIL;
5894     int_u	save_qfid = qf_get_curlist(qi)->qf_id;
5895     time_t	seconds = 0;
5896     char_u	*fname;
5897     int		fi;
5898     buf_T	*buf;
5899     int		duplicate_name = FALSE;
5900     int		using_dummy;
5901     char_u	*dirname_start = NULL;
5902     char_u	*dirname_now = NULL;
5903     int		found_match;
5904     aco_save_T	aco;
5905 
5906     dirname_start = alloc_id(MAXPATHL, aid_qf_dirname_start);
5907     dirname_now = alloc_id(MAXPATHL, aid_qf_dirname_now);
5908     if (dirname_start == NULL || dirname_now == NULL)
5909 	goto theend;
5910 
5911     // Remember the current directory, because a BufRead autocommand that does
5912     // ":lcd %:p:h" changes the meaning of short path names.
5913     mch_dirname(dirname_start, MAXPATHL);
5914 
5915     seconds = (time_t)0;
5916     for (fi = 0; fi < cmd_args->fcount && !got_int && cmd_args->tomatch > 0;
5917 									++fi)
5918     {
5919 	fname = shorten_fname1(cmd_args->fnames[fi]);
5920 	if (time(NULL) > seconds)
5921 	{
5922 	    // Display the file name every second or so, show the user we are
5923 	    // working on it.
5924 	    seconds = time(NULL);
5925 	    vgr_display_fname(fname);
5926 	}
5927 
5928 	buf = buflist_findname_exp(cmd_args->fnames[fi]);
5929 	if (buf == NULL || buf->b_ml.ml_mfp == NULL)
5930 	{
5931 	    // Remember that a buffer with this name already exists.
5932 	    duplicate_name = (buf != NULL);
5933 	    using_dummy = TRUE;
5934 	    *redraw_for_dummy = TRUE;
5935 
5936 	    buf = vgr_load_dummy_buf(fname, dirname_start, dirname_now);
5937 	}
5938 	else
5939 	    // Use existing, loaded buffer.
5940 	    using_dummy = FALSE;
5941 
5942 	// Check whether the quickfix list is still valid. When loading a
5943 	// buffer above, autocommands might have changed the quickfix list.
5944 	if (!vgr_qflist_valid(wp, qi, save_qfid, cmd_args->qf_title))
5945 	    goto theend;
5946 
5947 	save_qfid = qf_get_curlist(qi)->qf_id;
5948 
5949 	if (buf == NULL)
5950 	{
5951 	    if (!got_int)
5952 		smsg(_("Cannot open file \"%s\""), fname);
5953 	}
5954 	else
5955 	{
5956 	    // Try for a match in all lines of the buffer.
5957 	    // For ":1vimgrep" look for first match only.
5958 	    found_match = vgr_match_buflines(qf_get_curlist(qi),
5959 		    fname, buf, &cmd_args->regmatch,
5960 		    &cmd_args->tomatch, duplicate_name, cmd_args->flags);
5961 
5962 	    if (using_dummy)
5963 	    {
5964 		if (found_match && *first_match_buf == NULL)
5965 		    *first_match_buf = buf;
5966 		if (duplicate_name)
5967 		{
5968 		    // Never keep a dummy buffer if there is another buffer
5969 		    // with the same name.
5970 		    wipe_dummy_buffer(buf, dirname_start);
5971 		    buf = NULL;
5972 		}
5973 		else if (!cmdmod.hide
5974 			    || buf->b_p_bh[0] == 'u'	// "unload"
5975 			    || buf->b_p_bh[0] == 'w'	// "wipe"
5976 			    || buf->b_p_bh[0] == 'd')	// "delete"
5977 		{
5978 		    // When no match was found we don't need to remember the
5979 		    // buffer, wipe it out.  If there was a match and it
5980 		    // wasn't the first one or we won't jump there: only
5981 		    // unload the buffer.
5982 		    // Ignore 'hidden' here, because it may lead to having too
5983 		    // many swap files.
5984 		    if (!found_match)
5985 		    {
5986 			wipe_dummy_buffer(buf, dirname_start);
5987 			buf = NULL;
5988 		    }
5989 		    else if (buf != *first_match_buf
5990 					|| (cmd_args->flags & VGR_NOJUMP))
5991 		    {
5992 			unload_dummy_buffer(buf, dirname_start);
5993 			// Keeping the buffer, remove the dummy flag.
5994 			buf->b_flags &= ~BF_DUMMY;
5995 			buf = NULL;
5996 		    }
5997 		}
5998 
5999 		if (buf != NULL)
6000 		{
6001 		    // Keeping the buffer, remove the dummy flag.
6002 		    buf->b_flags &= ~BF_DUMMY;
6003 
6004 		    // If the buffer is still loaded we need to use the
6005 		    // directory we jumped to below.
6006 		    if (buf == *first_match_buf
6007 			    && *target_dir == NULL
6008 			    && STRCMP(dirname_start, dirname_now) != 0)
6009 			*target_dir = vim_strsave(dirname_now);
6010 
6011 		    // The buffer is still loaded, the Filetype autocommands
6012 		    // need to be done now, in that buffer.  And the modelines
6013 		    // need to be done (again).  But not the window-local
6014 		    // options!
6015 		    aucmd_prepbuf(&aco, buf);
6016 #if defined(FEAT_SYN_HL)
6017 		    apply_autocmds(EVENT_FILETYPE, buf->b_p_ft,
6018 						     buf->b_fname, TRUE, buf);
6019 #endif
6020 		    do_modelines(OPT_NOWIN);
6021 		    aucmd_restbuf(&aco);
6022 		}
6023 	    }
6024 	}
6025     }
6026 
6027     status = OK;
6028 
6029 theend:
6030     vim_free(dirname_now);
6031     vim_free(dirname_start);
6032     return status;
6033 }
6034 
6035 /*
6036  * ":vimgrep {pattern} file(s)"
6037  * ":vimgrepadd {pattern} file(s)"
6038  * ":lvimgrep {pattern} file(s)"
6039  * ":lvimgrepadd {pattern} file(s)"
6040  */
6041     void
6042 ex_vimgrep(exarg_T *eap)
6043 {
6044     vgr_args_T	args;
6045     qf_info_T	*qi;
6046     qf_list_T	*qfl;
6047     int_u	save_qfid;
6048     win_T	*wp = NULL;
6049     int		redraw_for_dummy = FALSE;
6050     buf_T	*first_match_buf = NULL;
6051     char_u	*target_dir = NULL;
6052     char_u	*au_name =  NULL;
6053     int		status;
6054 
6055     au_name = vgr_get_auname(eap->cmdidx);
6056     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
6057 					       curbuf->b_fname, TRUE, curbuf))
6058     {
6059 #ifdef FEAT_EVAL
6060 	if (aborting())
6061 	    return;
6062 #endif
6063     }
6064 
6065     qi = qf_cmd_get_or_alloc_stack(eap, &wp);
6066     if (qi == NULL)
6067 	return;
6068 
6069     if (vgr_process_args(eap, &args) == FAIL)
6070 	goto theend;
6071 
6072     if ((eap->cmdidx != CMD_grepadd && eap->cmdidx != CMD_lgrepadd
6073 		&& eap->cmdidx != CMD_vimgrepadd
6074 		&& eap->cmdidx != CMD_lvimgrepadd)
6075 					|| qf_stack_empty(qi))
6076 	// make place for a new list
6077 	qf_new_list(qi, args.qf_title);
6078 
6079     incr_quickfix_busy();
6080 
6081     status = vgr_process_files(wp, qi, &args, &redraw_for_dummy,
6082 						&first_match_buf, &target_dir);
6083     if (status != OK)
6084     {
6085 	FreeWild(args.fcount, args.fnames);
6086 	decr_quickfix_busy();
6087 	goto theend;
6088     }
6089 
6090     FreeWild(args.fcount, args.fnames);
6091 
6092     qfl = qf_get_curlist(qi);
6093     qfl->qf_nonevalid = FALSE;
6094     qfl->qf_ptr = qfl->qf_start;
6095     qfl->qf_index = 1;
6096     qf_list_changed(qfl);
6097 
6098     qf_update_buffer(qi, NULL);
6099 
6100     // Remember the current quickfix list identifier, so that we can check for
6101     // autocommands changing the current quickfix list.
6102     save_qfid = qf_get_curlist(qi)->qf_id;
6103 
6104     if (au_name != NULL)
6105 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
6106 					       curbuf->b_fname, TRUE, curbuf);
6107     // The QuickFixCmdPost autocmd may free the quickfix list. Check the list
6108     // is still valid.
6109     if (!qflist_valid(wp, save_qfid)
6110 	    || qf_restore_list(qi, save_qfid) == FAIL)
6111     {
6112 	decr_quickfix_busy();
6113 	goto theend;
6114     }
6115 
6116     // Jump to first match.
6117     if (!qf_list_empty(qf_get_curlist(qi)))
6118     {
6119 	if ((args.flags & VGR_NOJUMP) == 0)
6120 	    vgr_jump_to_match(qi, eap->forceit, &redraw_for_dummy,
6121 		    first_match_buf, target_dir);
6122     }
6123     else
6124 	semsg(_(e_nomatch2), args.spat);
6125 
6126     decr_quickfix_busy();
6127 
6128     // If we loaded a dummy buffer into the current window, the autocommands
6129     // may have messed up things, need to redraw and recompute folds.
6130     if (redraw_for_dummy)
6131     {
6132 #ifdef FEAT_FOLDING
6133 	foldUpdateAll(curwin);
6134 #else
6135 	redraw_later(NOT_VALID);
6136 #endif
6137     }
6138 
6139 theend:
6140     vim_free(args.qf_title);
6141     vim_free(target_dir);
6142     vim_regfree(args.regmatch.regprog);
6143 }
6144 
6145 /*
6146  * Restore current working directory to "dirname_start" if they differ, taking
6147  * into account whether it is set locally or globally.
6148  */
6149     static void
6150 restore_start_dir(char_u *dirname_start)
6151 {
6152     char_u *dirname_now = alloc(MAXPATHL);
6153 
6154     if (NULL != dirname_now)
6155     {
6156 	mch_dirname(dirname_now, MAXPATHL);
6157 	if (STRCMP(dirname_start, dirname_now) != 0)
6158 	{
6159 	    // If the directory has changed, change it back by building up an
6160 	    // appropriate ex command and executing it.
6161 	    exarg_T ea;
6162 
6163 	    vim_memset(&ea, 0, sizeof(ea));
6164 	    ea.arg = dirname_start;
6165 	    ea.cmdidx = (curwin->w_localdir == NULL) ? CMD_cd : CMD_lcd;
6166 	    ex_cd(&ea);
6167 	}
6168 	vim_free(dirname_now);
6169     }
6170 }
6171 
6172 /*
6173  * Load file "fname" into a dummy buffer and return the buffer pointer,
6174  * placing the directory resulting from the buffer load into the
6175  * "resulting_dir" pointer. "resulting_dir" must be allocated by the caller
6176  * prior to calling this function. Restores directory to "dirname_start" prior
6177  * to returning, if autocmds or the 'autochdir' option have changed it.
6178  *
6179  * If creating the dummy buffer does not fail, must call unload_dummy_buffer()
6180  * or wipe_dummy_buffer() later!
6181  *
6182  * Returns NULL if it fails.
6183  */
6184     static buf_T *
6185 load_dummy_buffer(
6186     char_u	*fname,
6187     char_u	*dirname_start,  // in: old directory
6188     char_u	*resulting_dir)  // out: new directory
6189 {
6190     buf_T	*newbuf;
6191     bufref_T	newbufref;
6192     bufref_T	newbuf_to_wipe;
6193     int		failed = TRUE;
6194     aco_save_T	aco;
6195     int		readfile_result;
6196 
6197     // Allocate a buffer without putting it in the buffer list.
6198     newbuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6199     if (newbuf == NULL)
6200 	return NULL;
6201     set_bufref(&newbufref, newbuf);
6202 
6203     // Init the options.
6204     buf_copy_options(newbuf, BCO_ENTER | BCO_NOHELP);
6205 
6206     // need to open the memfile before putting the buffer in a window
6207     if (ml_open(newbuf) == OK)
6208     {
6209 	// Make sure this buffer isn't wiped out by autocommands.
6210 	++newbuf->b_locked;
6211 
6212 	// set curwin/curbuf to buf and save a few things
6213 	aucmd_prepbuf(&aco, newbuf);
6214 
6215 	// Need to set the filename for autocommands.
6216 	(void)setfname(curbuf, fname, NULL, FALSE);
6217 
6218 	// Create swap file now to avoid the ATTENTION message.
6219 	check_need_swap(TRUE);
6220 
6221 	// Remove the "dummy" flag, otherwise autocommands may not
6222 	// work.
6223 	curbuf->b_flags &= ~BF_DUMMY;
6224 
6225 	newbuf_to_wipe.br_buf = NULL;
6226 	readfile_result = readfile(fname, NULL,
6227 		    (linenr_T)0, (linenr_T)0, (linenr_T)MAXLNUM,
6228 		    NULL, READ_NEW | READ_DUMMY);
6229 	--newbuf->b_locked;
6230 	if (readfile_result == OK
6231 		&& !got_int
6232 		&& !(curbuf->b_flags & BF_NEW))
6233 	{
6234 	    failed = FALSE;
6235 	    if (curbuf != newbuf)
6236 	    {
6237 		// Bloody autocommands changed the buffer!  Can happen when
6238 		// using netrw and editing a remote file.  Use the current
6239 		// buffer instead, delete the dummy one after restoring the
6240 		// window stuff.
6241 		set_bufref(&newbuf_to_wipe, newbuf);
6242 		newbuf = curbuf;
6243 	    }
6244 	}
6245 
6246 	// restore curwin/curbuf and a few other things
6247 	aucmd_restbuf(&aco);
6248 	if (newbuf_to_wipe.br_buf != NULL && bufref_valid(&newbuf_to_wipe))
6249 	    wipe_buffer(newbuf_to_wipe.br_buf, FALSE);
6250 
6251 	// Add back the "dummy" flag, otherwise buflist_findname_stat() won't
6252 	// skip it.
6253 	newbuf->b_flags |= BF_DUMMY;
6254     }
6255 
6256     // When autocommands/'autochdir' option changed directory: go back.
6257     // Let the caller know what the resulting dir was first, in case it is
6258     // important.
6259     mch_dirname(resulting_dir, MAXPATHL);
6260     restore_start_dir(dirname_start);
6261 
6262     if (!bufref_valid(&newbufref))
6263 	return NULL;
6264     if (failed)
6265     {
6266 	wipe_dummy_buffer(newbuf, dirname_start);
6267 	return NULL;
6268     }
6269     return newbuf;
6270 }
6271 
6272 /*
6273  * Wipe out the dummy buffer that load_dummy_buffer() created. Restores
6274  * directory to "dirname_start" prior to returning, if autocmds or the
6275  * 'autochdir' option have changed it.
6276  */
6277     static void
6278 wipe_dummy_buffer(buf_T *buf, char_u *dirname_start)
6279 {
6280     if (curbuf != buf)		// safety check
6281     {
6282 #if defined(FEAT_EVAL)
6283 	cleanup_T   cs;
6284 
6285 	// Reset the error/interrupt/exception state here so that aborting()
6286 	// returns FALSE when wiping out the buffer.  Otherwise it doesn't
6287 	// work when got_int is set.
6288 	enter_cleanup(&cs);
6289 #endif
6290 
6291 	wipe_buffer(buf, FALSE);
6292 
6293 #if defined(FEAT_EVAL)
6294 	// Restore the error/interrupt/exception state if not discarded by a
6295 	// new aborting error, interrupt, or uncaught exception.
6296 	leave_cleanup(&cs);
6297 #endif
6298 	// When autocommands/'autochdir' option changed directory: go back.
6299 	restore_start_dir(dirname_start);
6300     }
6301 }
6302 
6303 /*
6304  * Unload the dummy buffer that load_dummy_buffer() created. Restores
6305  * directory to "dirname_start" prior to returning, if autocmds or the
6306  * 'autochdir' option have changed it.
6307  */
6308     static void
6309 unload_dummy_buffer(buf_T *buf, char_u *dirname_start)
6310 {
6311     if (curbuf != buf)		// safety check
6312     {
6313 	close_buffer(NULL, buf, DOBUF_UNLOAD, FALSE);
6314 
6315 	// When autocommands/'autochdir' option changed directory: go back.
6316 	restore_start_dir(dirname_start);
6317     }
6318 }
6319 
6320 #if defined(FEAT_EVAL) || defined(PROTO)
6321 /*
6322  * Copy the specified quickfix entry items into a new dict and appened the dict
6323  * to 'list'.  Returns OK on success.
6324  */
6325     static int
6326 get_qfline_items(qfline_T *qfp, list_T *list)
6327 {
6328     int		bufnum;
6329     dict_T	*dict;
6330     char_u	buf[2];
6331 
6332     // Handle entries with a non-existing buffer number.
6333     bufnum = qfp->qf_fnum;
6334     if (bufnum != 0 && (buflist_findnr(bufnum) == NULL))
6335 	bufnum = 0;
6336 
6337     if ((dict = dict_alloc()) == NULL)
6338 	return FAIL;
6339     if (list_append_dict(list, dict) == FAIL)
6340 	return FAIL;
6341 
6342     buf[0] = qfp->qf_type;
6343     buf[1] = NUL;
6344     if (dict_add_number(dict, "bufnr", (long)bufnum) == FAIL
6345 	    || dict_add_number(dict, "lnum",  (long)qfp->qf_lnum) == FAIL
6346 	    || dict_add_number(dict, "col",   (long)qfp->qf_col) == FAIL
6347 	    || dict_add_number(dict, "vcol",  (long)qfp->qf_viscol) == FAIL
6348 	    || dict_add_number(dict, "nr",    (long)qfp->qf_nr) == FAIL
6349 	    || dict_add_string(dict, "module", qfp->qf_module) == FAIL
6350 	    || dict_add_string(dict, "pattern", qfp->qf_pattern) == FAIL
6351 	    || dict_add_string(dict, "text", qfp->qf_text) == FAIL
6352 	    || dict_add_string(dict, "type", buf) == FAIL
6353 	    || dict_add_number(dict, "valid", (long)qfp->qf_valid) == FAIL)
6354 	return FAIL;
6355 
6356     return OK;
6357 }
6358 
6359 /*
6360  * Add each quickfix error to list "list" as a dictionary.
6361  * If qf_idx is -1, use the current list. Otherwise, use the specified list.
6362  */
6363     static int
6364 get_errorlist(qf_info_T *qi_arg, win_T *wp, int qf_idx, list_T *list)
6365 {
6366     qf_info_T	*qi = qi_arg;
6367     qf_list_T	*qfl;
6368     qfline_T	*qfp;
6369     int		i;
6370 
6371     if (qi == NULL)
6372     {
6373 	qi = &ql_info;
6374 	if (wp != NULL)
6375 	{
6376 	    qi = GET_LOC_LIST(wp);
6377 	    if (qi == NULL)
6378 		return FAIL;
6379 	}
6380     }
6381 
6382     if (qf_idx == INVALID_QFIDX)
6383 	qf_idx = qi->qf_curlist;
6384 
6385     if (qf_idx >= qi->qf_listcount)
6386 	return FAIL;
6387 
6388     qfl = qf_get_list(qi, qf_idx);
6389     if (qf_list_empty(qfl))
6390 	return FAIL;
6391 
6392     FOR_ALL_QFL_ITEMS(qfl, qfp, i)
6393     {
6394 	if (get_qfline_items(qfp, list) == FAIL)
6395 	    return FAIL;
6396     }
6397 
6398     return OK;
6399 }
6400 
6401 // Flags used by getqflist()/getloclist() to determine which fields to return.
6402 enum {
6403     QF_GETLIST_NONE	= 0x0,
6404     QF_GETLIST_TITLE	= 0x1,
6405     QF_GETLIST_ITEMS	= 0x2,
6406     QF_GETLIST_NR	= 0x4,
6407     QF_GETLIST_WINID	= 0x8,
6408     QF_GETLIST_CONTEXT	= 0x10,
6409     QF_GETLIST_ID	= 0x20,
6410     QF_GETLIST_IDX	= 0x40,
6411     QF_GETLIST_SIZE	= 0x80,
6412     QF_GETLIST_TICK	= 0x100,
6413     QF_GETLIST_FILEWINID	= 0x200,
6414     QF_GETLIST_QFBUFNR	= 0x400,
6415     QF_GETLIST_ALL	= 0x7FF,
6416 };
6417 
6418 /*
6419  * Parse text from 'di' and return the quickfix list items.
6420  * Existing quickfix lists are not modified.
6421  */
6422     static int
6423 qf_get_list_from_lines(dict_T *what, dictitem_T *di, dict_T *retdict)
6424 {
6425     int		status = FAIL;
6426     qf_info_T	*qi;
6427     char_u	*errorformat = p_efm;
6428     dictitem_T	*efm_di;
6429     list_T	*l;
6430 
6431     // Only a List value is supported
6432     if (di->di_tv.v_type == VAR_LIST && di->di_tv.vval.v_list != NULL)
6433     {
6434 	// If errorformat is supplied then use it, otherwise use the 'efm'
6435 	// option setting
6436 	if ((efm_di = dict_find(what, (char_u *)"efm", -1)) != NULL)
6437 	{
6438 	    if (efm_di->di_tv.v_type != VAR_STRING ||
6439 		    efm_di->di_tv.vval.v_string == NULL)
6440 		return FAIL;
6441 	    errorformat = efm_di->di_tv.vval.v_string;
6442 	}
6443 
6444 	l = list_alloc();
6445 	if (l == NULL)
6446 	    return FAIL;
6447 
6448 	qi = qf_alloc_stack(QFLT_INTERNAL);
6449 	if (qi != NULL)
6450 	{
6451 	    if (qf_init_ext(qi, 0, NULL, NULL, &di->di_tv, errorformat,
6452 			TRUE, (linenr_T)0, (linenr_T)0, NULL, NULL) > 0)
6453 	    {
6454 		(void)get_errorlist(qi, NULL, 0, l);
6455 		qf_free(&qi->qf_lists[0]);
6456 	    }
6457 	    free(qi);
6458 	}
6459 	dict_add_list(retdict, "items", l);
6460 	status = OK;
6461     }
6462 
6463     return status;
6464 }
6465 
6466 /*
6467  * Return the quickfix/location list window identifier in the current tabpage.
6468  */
6469     static int
6470 qf_winid(qf_info_T *qi)
6471 {
6472     win_T	*win;
6473 
6474     // The quickfix window can be opened even if the quickfix list is not set
6475     // using ":copen". This is not true for location lists.
6476     if (qi == NULL)
6477 	return 0;
6478     win = qf_find_win(qi);
6479     if (win != NULL)
6480 	return win->w_id;
6481     return 0;
6482 }
6483 
6484 /*
6485  * Returns the number of the buffer displayed in the quickfix/location list
6486  * window. If there is no buffer associated with the list, then returns 0.
6487  */
6488     static int
6489 qf_getprop_qfbufnr(qf_info_T *qi, dict_T *retdict)
6490 {
6491     return dict_add_number(retdict, "qfbufnr",
6492 					(qi == NULL) ? 0 : qi->qf_bufnr);
6493 }
6494 
6495 /*
6496  * Convert the keys in 'what' to quickfix list property flags.
6497  */
6498     static int
6499 qf_getprop_keys2flags(dict_T *what, int loclist)
6500 {
6501     int		flags = QF_GETLIST_NONE;
6502 
6503     if (dict_find(what, (char_u *)"all", -1) != NULL)
6504     {
6505 	flags |= QF_GETLIST_ALL;
6506 	if (!loclist)
6507 	    // File window ID is applicable only to location list windows
6508 	    flags &= ~ QF_GETLIST_FILEWINID;
6509     }
6510 
6511     if (dict_find(what, (char_u *)"title", -1) != NULL)
6512 	flags |= QF_GETLIST_TITLE;
6513 
6514     if (dict_find(what, (char_u *)"nr", -1) != NULL)
6515 	flags |= QF_GETLIST_NR;
6516 
6517     if (dict_find(what, (char_u *)"winid", -1) != NULL)
6518 	flags |= QF_GETLIST_WINID;
6519 
6520     if (dict_find(what, (char_u *)"context", -1) != NULL)
6521 	flags |= QF_GETLIST_CONTEXT;
6522 
6523     if (dict_find(what, (char_u *)"id", -1) != NULL)
6524 	flags |= QF_GETLIST_ID;
6525 
6526     if (dict_find(what, (char_u *)"items", -1) != NULL)
6527 	flags |= QF_GETLIST_ITEMS;
6528 
6529     if (dict_find(what, (char_u *)"idx", -1) != NULL)
6530 	flags |= QF_GETLIST_IDX;
6531 
6532     if (dict_find(what, (char_u *)"size", -1) != NULL)
6533 	flags |= QF_GETLIST_SIZE;
6534 
6535     if (dict_find(what, (char_u *)"changedtick", -1) != NULL)
6536 	flags |= QF_GETLIST_TICK;
6537 
6538     if (loclist && dict_find(what, (char_u *)"filewinid", -1) != NULL)
6539 	flags |= QF_GETLIST_FILEWINID;
6540 
6541     if (dict_find(what, (char_u *)"qfbufnr", -1) != NULL)
6542 	flags |= QF_GETLIST_QFBUFNR;
6543 
6544     return flags;
6545 }
6546 
6547 /*
6548  * Return the quickfix list index based on 'nr' or 'id' in 'what'.
6549  * If 'nr' and 'id' are not present in 'what' then return the current
6550  * quickfix list index.
6551  * If 'nr' is zero then return the current quickfix list index.
6552  * If 'nr' is '$' then return the last quickfix list index.
6553  * If 'id' is present then return the index of the quickfix list with that id.
6554  * If 'id' is zero then return the quickfix list index specified by 'nr'.
6555  * Return -1, if quickfix list is not present or if the stack is empty.
6556  */
6557     static int
6558 qf_getprop_qfidx(qf_info_T *qi, dict_T *what)
6559 {
6560     int		qf_idx;
6561     dictitem_T	*di;
6562 
6563     qf_idx = qi->qf_curlist;	// default is the current list
6564     if ((di = dict_find(what, (char_u *)"nr", -1)) != NULL)
6565     {
6566 	// Use the specified quickfix/location list
6567 	if (di->di_tv.v_type == VAR_NUMBER)
6568 	{
6569 	    // for zero use the current list
6570 	    if (di->di_tv.vval.v_number != 0)
6571 	    {
6572 		qf_idx = di->di_tv.vval.v_number - 1;
6573 		if (qf_idx < 0 || qf_idx >= qi->qf_listcount)
6574 		    qf_idx = INVALID_QFIDX;
6575 	    }
6576 	}
6577 	else if (di->di_tv.v_type == VAR_STRING
6578 		&& di->di_tv.vval.v_string != NULL
6579 		&& STRCMP(di->di_tv.vval.v_string, "$") == 0)
6580 	    // Get the last quickfix list number
6581 	    qf_idx = qi->qf_listcount - 1;
6582 	else
6583 	    qf_idx = INVALID_QFIDX;
6584     }
6585 
6586     if ((di = dict_find(what, (char_u *)"id", -1)) != NULL)
6587     {
6588 	// Look for a list with the specified id
6589 	if (di->di_tv.v_type == VAR_NUMBER)
6590 	{
6591 	    // For zero, use the current list or the list specified by 'nr'
6592 	    if (di->di_tv.vval.v_number != 0)
6593 		qf_idx = qf_id2nr(qi, di->di_tv.vval.v_number);
6594 	}
6595 	else
6596 	    qf_idx = INVALID_QFIDX;
6597     }
6598 
6599     return qf_idx;
6600 }
6601 
6602 /*
6603  * Return default values for quickfix list properties in retdict.
6604  */
6605     static int
6606 qf_getprop_defaults(qf_info_T *qi, int flags, int locstack, dict_T *retdict)
6607 {
6608     int		status = OK;
6609 
6610     if (flags & QF_GETLIST_TITLE)
6611 	status = dict_add_string(retdict, "title", (char_u *)"");
6612     if ((status == OK) && (flags & QF_GETLIST_ITEMS))
6613     {
6614 	list_T	*l = list_alloc();
6615 	if (l != NULL)
6616 	    status = dict_add_list(retdict, "items", l);
6617 	else
6618 	    status = FAIL;
6619     }
6620     if ((status == OK) && (flags & QF_GETLIST_NR))
6621 	status = dict_add_number(retdict, "nr", 0);
6622     if ((status == OK) && (flags & QF_GETLIST_WINID))
6623 	status = dict_add_number(retdict, "winid", qf_winid(qi));
6624     if ((status == OK) && (flags & QF_GETLIST_CONTEXT))
6625 	status = dict_add_string(retdict, "context", (char_u *)"");
6626     if ((status == OK) && (flags & QF_GETLIST_ID))
6627 	status = dict_add_number(retdict, "id", 0);
6628     if ((status == OK) && (flags & QF_GETLIST_IDX))
6629 	status = dict_add_number(retdict, "idx", 0);
6630     if ((status == OK) && (flags & QF_GETLIST_SIZE))
6631 	status = dict_add_number(retdict, "size", 0);
6632     if ((status == OK) && (flags & QF_GETLIST_TICK))
6633 	status = dict_add_number(retdict, "changedtick", 0);
6634     if ((status == OK) && locstack && (flags & QF_GETLIST_FILEWINID))
6635 	status = dict_add_number(retdict, "filewinid", 0);
6636     if ((status == OK) && (flags & QF_GETLIST_QFBUFNR))
6637 	status = qf_getprop_qfbufnr(qi, retdict);
6638 
6639     return status;
6640 }
6641 
6642 /*
6643  * Return the quickfix list title as 'title' in retdict
6644  */
6645     static int
6646 qf_getprop_title(qf_list_T *qfl, dict_T *retdict)
6647 {
6648     return dict_add_string(retdict, "title", qfl->qf_title);
6649 }
6650 
6651 /*
6652  * Returns the identifier of the window used to display files from a location
6653  * list.  If there is no associated window, then returns 0. Useful only when
6654  * called from a location list window.
6655  */
6656     static int
6657 qf_getprop_filewinid(win_T *wp, qf_info_T *qi, dict_T *retdict)
6658 {
6659     int winid = 0;
6660 
6661     if (wp != NULL && IS_LL_WINDOW(wp))
6662     {
6663 	win_T	*ll_wp = qf_find_win_with_loclist(qi);
6664 	if (ll_wp != NULL)
6665 	    winid = ll_wp->w_id;
6666     }
6667 
6668     return dict_add_number(retdict, "filewinid", winid);
6669 }
6670 
6671 /*
6672  * Return the quickfix list items/entries as 'items' in retdict
6673  */
6674     static int
6675 qf_getprop_items(qf_info_T *qi, int qf_idx, dict_T *retdict)
6676 {
6677     int		status = OK;
6678     list_T	*l = list_alloc();
6679     if (l != NULL)
6680     {
6681 	(void)get_errorlist(qi, NULL, qf_idx, l);
6682 	dict_add_list(retdict, "items", l);
6683     }
6684     else
6685 	status = FAIL;
6686 
6687     return status;
6688 }
6689 
6690 /*
6691  * Return the quickfix list context (if any) as 'context' in retdict.
6692  */
6693     static int
6694 qf_getprop_ctx(qf_list_T *qfl, dict_T *retdict)
6695 {
6696     int		status;
6697     dictitem_T	*di;
6698 
6699     if (qfl->qf_ctx != NULL)
6700     {
6701 	di = dictitem_alloc((char_u *)"context");
6702 	if (di != NULL)
6703 	{
6704 	    copy_tv(qfl->qf_ctx, &di->di_tv);
6705 	    status = dict_add(retdict, di);
6706 	    if (status == FAIL)
6707 		dictitem_free(di);
6708 	}
6709 	else
6710 	    status = FAIL;
6711     }
6712     else
6713 	status = dict_add_string(retdict, "context", (char_u *)"");
6714 
6715     return status;
6716 }
6717 
6718 /*
6719  * Return the current quickfix list index as 'idx' in retdict
6720  */
6721     static int
6722 qf_getprop_idx(qf_list_T *qfl, dict_T *retdict)
6723 {
6724     int curidx = qfl->qf_index;
6725     if (qf_list_empty(qfl))
6726 	// For empty lists, current index is set to 0
6727 	curidx = 0;
6728     return dict_add_number(retdict, "idx", curidx);
6729 }
6730 
6731 /*
6732  * Return quickfix/location list details (title) as a
6733  * dictionary. 'what' contains the details to return. If 'list_idx' is -1,
6734  * then current list is used. Otherwise the specified list is used.
6735  */
6736     static int
6737 qf_get_properties(win_T *wp, dict_T *what, dict_T *retdict)
6738 {
6739     qf_info_T	*qi = &ql_info;
6740     qf_list_T	*qfl;
6741     int		status = OK;
6742     int		qf_idx = INVALID_QFIDX;
6743     dictitem_T	*di;
6744     int		flags = QF_GETLIST_NONE;
6745 
6746     if ((di = dict_find(what, (char_u *)"lines", -1)) != NULL)
6747 	return qf_get_list_from_lines(what, di, retdict);
6748 
6749     if (wp != NULL)
6750 	qi = GET_LOC_LIST(wp);
6751 
6752     flags = qf_getprop_keys2flags(what, (wp != NULL));
6753 
6754     if (!qf_stack_empty(qi))
6755 	qf_idx = qf_getprop_qfidx(qi, what);
6756 
6757     // List is not present or is empty
6758     if (qf_stack_empty(qi) || qf_idx == INVALID_QFIDX)
6759 	return qf_getprop_defaults(qi, flags, wp != NULL, retdict);
6760 
6761     qfl = qf_get_list(qi, qf_idx);
6762 
6763     if (flags & QF_GETLIST_TITLE)
6764 	status = qf_getprop_title(qfl, retdict);
6765     if ((status == OK) && (flags & QF_GETLIST_NR))
6766 	status = dict_add_number(retdict, "nr", qf_idx + 1);
6767     if ((status == OK) && (flags & QF_GETLIST_WINID))
6768 	status = dict_add_number(retdict, "winid", qf_winid(qi));
6769     if ((status == OK) && (flags & QF_GETLIST_ITEMS))
6770 	status = qf_getprop_items(qi, qf_idx, retdict);
6771     if ((status == OK) && (flags & QF_GETLIST_CONTEXT))
6772 	status = qf_getprop_ctx(qfl, retdict);
6773     if ((status == OK) && (flags & QF_GETLIST_ID))
6774 	status = dict_add_number(retdict, "id", qfl->qf_id);
6775     if ((status == OK) && (flags & QF_GETLIST_IDX))
6776 	status = qf_getprop_idx(qfl, retdict);
6777     if ((status == OK) && (flags & QF_GETLIST_SIZE))
6778 	status = dict_add_number(retdict, "size", qfl->qf_count);
6779     if ((status == OK) && (flags & QF_GETLIST_TICK))
6780 	status = dict_add_number(retdict, "changedtick", qfl->qf_changedtick);
6781     if ((status == OK) && (wp != NULL) && (flags & QF_GETLIST_FILEWINID))
6782 	status = qf_getprop_filewinid(wp, qi, retdict);
6783     if ((status == OK) && (flags & QF_GETLIST_QFBUFNR))
6784 	status = qf_getprop_qfbufnr(qi, retdict);
6785 
6786     return status;
6787 }
6788 
6789 /*
6790  * Add a new quickfix entry to list at 'qf_idx' in the stack 'qi' from the
6791  * items in the dict 'd'. If it is a valid error entry, then set 'valid_entry'
6792  * to TRUE.
6793  */
6794     static int
6795 qf_add_entry_from_dict(
6796 	qf_list_T	*qfl,
6797 	dict_T		*d,
6798 	int		first_entry,
6799 	int		*valid_entry)
6800 {
6801     static int	did_bufnr_emsg;
6802     char_u	*filename, *module, *pattern, *text, *type;
6803     int		bufnum, valid, status, col, vcol, nr;
6804     long	lnum;
6805 
6806     if (first_entry)
6807 	did_bufnr_emsg = FALSE;
6808 
6809     filename = dict_get_string(d, (char_u *)"filename", TRUE);
6810     module = dict_get_string(d, (char_u *)"module", TRUE);
6811     bufnum = (int)dict_get_number(d, (char_u *)"bufnr");
6812     lnum = (int)dict_get_number(d, (char_u *)"lnum");
6813     col = (int)dict_get_number(d, (char_u *)"col");
6814     vcol = (int)dict_get_number(d, (char_u *)"vcol");
6815     nr = (int)dict_get_number(d, (char_u *)"nr");
6816     type = dict_get_string(d, (char_u *)"type", TRUE);
6817     pattern = dict_get_string(d, (char_u *)"pattern", TRUE);
6818     text = dict_get_string(d, (char_u *)"text", TRUE);
6819     if (text == NULL)
6820 	text = vim_strsave((char_u *)"");
6821 
6822     valid = TRUE;
6823     if ((filename == NULL && bufnum == 0) || (lnum == 0 && pattern == NULL))
6824 	valid = FALSE;
6825 
6826     // Mark entries with non-existing buffer number as not valid. Give the
6827     // error message only once.
6828     if (bufnum != 0 && (buflist_findnr(bufnum) == NULL))
6829     {
6830 	if (!did_bufnr_emsg)
6831 	{
6832 	    did_bufnr_emsg = TRUE;
6833 	    semsg(_("E92: Buffer %d not found"), bufnum);
6834 	}
6835 	valid = FALSE;
6836 	bufnum = 0;
6837     }
6838 
6839     // If the 'valid' field is present it overrules the detected value.
6840     if ((dict_find(d, (char_u *)"valid", -1)) != NULL)
6841 	valid = (int)dict_get_number(d, (char_u *)"valid");
6842 
6843     status =  qf_add_entry(qfl,
6844 			NULL,		// dir
6845 			filename,
6846 			module,
6847 			bufnum,
6848 			text,
6849 			lnum,
6850 			col,
6851 			vcol,		// vis_col
6852 			pattern,	// search pattern
6853 			nr,
6854 			type == NULL ? NUL : *type,
6855 			valid);
6856 
6857     vim_free(filename);
6858     vim_free(module);
6859     vim_free(pattern);
6860     vim_free(text);
6861     vim_free(type);
6862 
6863     if (valid)
6864 	*valid_entry = TRUE;
6865 
6866     return status;
6867 }
6868 
6869 /*
6870  * Add list of entries to quickfix/location list. Each list entry is
6871  * a dictionary with item information.
6872  */
6873     static int
6874 qf_add_entries(
6875 	qf_info_T	*qi,
6876 	int		qf_idx,
6877 	list_T		*list,
6878 	char_u		*title,
6879 	int		action)
6880 {
6881     qf_list_T	*qfl = qf_get_list(qi, qf_idx);
6882     listitem_T	*li;
6883     dict_T	*d;
6884     qfline_T	*old_last = NULL;
6885     int		retval = OK;
6886     int		valid_entry = FALSE;
6887 
6888     if (action == ' ' || qf_idx == qi->qf_listcount)
6889     {
6890 	// make place for a new list
6891 	qf_new_list(qi, title);
6892 	qf_idx = qi->qf_curlist;
6893 	qfl = qf_get_list(qi, qf_idx);
6894     }
6895     else if (action == 'a' && !qf_list_empty(qfl))
6896 	// Adding to existing list, use last entry.
6897 	old_last = qfl->qf_last;
6898     else if (action == 'r')
6899     {
6900 	qf_free_items(qfl);
6901 	qf_store_title(qfl, title);
6902     }
6903 
6904     for (li = list->lv_first; li != NULL; li = li->li_next)
6905     {
6906 	if (li->li_tv.v_type != VAR_DICT)
6907 	    continue; // Skip non-dict items
6908 
6909 	d = li->li_tv.vval.v_dict;
6910 	if (d == NULL)
6911 	    continue;
6912 
6913 	retval = qf_add_entry_from_dict(qfl, d, li == list->lv_first,
6914 								&valid_entry);
6915 	if (retval == QF_FAIL)
6916 	    break;
6917     }
6918 
6919     // Check if any valid error entries are added to the list.
6920     if (valid_entry)
6921 	qfl->qf_nonevalid = FALSE;
6922     else if (qfl->qf_index == 0)
6923 	// no valid entry
6924 	qfl->qf_nonevalid = TRUE;
6925 
6926     // If not appending to the list, set the current error to the first entry
6927     if (action != 'a')
6928 	qfl->qf_ptr = qfl->qf_start;
6929 
6930     // Update the current error index if not appending to the list or if the
6931     // list was empty before and it is not empty now.
6932     if ((action != 'a' || qfl->qf_index == 0) && !qf_list_empty(qfl))
6933 	qfl->qf_index = 1;
6934 
6935     // Don't update the cursor in quickfix window when appending entries
6936     qf_update_buffer(qi, old_last);
6937 
6938     return retval;
6939 }
6940 
6941 /*
6942  * Get the quickfix list index from 'nr' or 'id'
6943  */
6944     static int
6945 qf_setprop_get_qfidx(
6946 	qf_info_T	*qi,
6947 	dict_T		*what,
6948 	int		action,
6949 	int		*newlist)
6950 {
6951     dictitem_T	*di;
6952     int		qf_idx = qi->qf_curlist;    // default is the current list
6953 
6954     if ((di = dict_find(what, (char_u *)"nr", -1)) != NULL)
6955     {
6956 	// Use the specified quickfix/location list
6957 	if (di->di_tv.v_type == VAR_NUMBER)
6958 	{
6959 	    // for zero use the current list
6960 	    if (di->di_tv.vval.v_number != 0)
6961 		qf_idx = di->di_tv.vval.v_number - 1;
6962 
6963 	    if ((action == ' ' || action == 'a') && qf_idx == qi->qf_listcount)
6964 	    {
6965 		// When creating a new list, accept qf_idx pointing to the next
6966 		// non-available list and add the new list at the end of the
6967 		// stack.
6968 		*newlist = TRUE;
6969 		qf_idx = qf_stack_empty(qi) ? 0 : qi->qf_listcount - 1;
6970 	    }
6971 	    else if (qf_idx < 0 || qf_idx >= qi->qf_listcount)
6972 		return INVALID_QFIDX;
6973 	    else if (action != ' ')
6974 		*newlist = FALSE;	// use the specified list
6975 	}
6976 	else if (di->di_tv.v_type == VAR_STRING
6977 		&& di->di_tv.vval.v_string != NULL
6978 		&& STRCMP(di->di_tv.vval.v_string, "$") == 0)
6979 	{
6980 	    if (!qf_stack_empty(qi))
6981 		qf_idx = qi->qf_listcount - 1;
6982 	    else if (*newlist)
6983 		qf_idx = 0;
6984 	    else
6985 		return INVALID_QFIDX;
6986 	}
6987 	else
6988 	    return INVALID_QFIDX;
6989     }
6990 
6991     if (!*newlist && (di = dict_find(what, (char_u *)"id", -1)) != NULL)
6992     {
6993 	// Use the quickfix/location list with the specified id
6994 	if (di->di_tv.v_type != VAR_NUMBER)
6995 	    return INVALID_QFIDX;
6996 
6997 	return qf_id2nr(qi, di->di_tv.vval.v_number);
6998     }
6999 
7000     return qf_idx;
7001 }
7002 
7003 /*
7004  * Set the quickfix list title.
7005  */
7006     static int
7007 qf_setprop_title(qf_info_T *qi, int qf_idx, dict_T *what, dictitem_T *di)
7008 {
7009     qf_list_T	*qfl = qf_get_list(qi, qf_idx);
7010 
7011     if (di->di_tv.v_type != VAR_STRING)
7012 	return FAIL;
7013 
7014     vim_free(qfl->qf_title);
7015     qfl->qf_title = dict_get_string(what, (char_u *)"title", TRUE);
7016     if (qf_idx == qi->qf_curlist)
7017 	qf_update_win_titlevar(qi);
7018 
7019     return OK;
7020 }
7021 
7022 /*
7023  * Set quickfix list items/entries.
7024  */
7025     static int
7026 qf_setprop_items(qf_info_T *qi, int qf_idx, dictitem_T *di, int action)
7027 {
7028     int		retval = FAIL;
7029     char_u	*title_save;
7030 
7031     if (di->di_tv.v_type != VAR_LIST)
7032 	return FAIL;
7033 
7034     title_save = vim_strsave(qi->qf_lists[qf_idx].qf_title);
7035     retval = qf_add_entries(qi, qf_idx, di->di_tv.vval.v_list,
7036 	    title_save, action == ' ' ? 'a' : action);
7037     vim_free(title_save);
7038 
7039     return retval;
7040 }
7041 
7042 /*
7043  * Set quickfix list items/entries from a list of lines.
7044  */
7045     static int
7046 qf_setprop_items_from_lines(
7047 	qf_info_T	*qi,
7048 	int		qf_idx,
7049 	dict_T		*what,
7050 	dictitem_T	*di,
7051 	int		action)
7052 {
7053     char_u	*errorformat = p_efm;
7054     dictitem_T	*efm_di;
7055     int		retval = FAIL;
7056 
7057     // Use the user supplied errorformat settings (if present)
7058     if ((efm_di = dict_find(what, (char_u *)"efm", -1)) != NULL)
7059     {
7060 	if (efm_di->di_tv.v_type != VAR_STRING ||
7061 		efm_di->di_tv.vval.v_string == NULL)
7062 	    return FAIL;
7063 	errorformat = efm_di->di_tv.vval.v_string;
7064     }
7065 
7066     // Only a List value is supported
7067     if (di->di_tv.v_type != VAR_LIST || di->di_tv.vval.v_list == NULL)
7068 	return FAIL;
7069 
7070     if (action == 'r')
7071 	qf_free_items(&qi->qf_lists[qf_idx]);
7072     if (qf_init_ext(qi, qf_idx, NULL, NULL, &di->di_tv, errorformat,
7073 		FALSE, (linenr_T)0, (linenr_T)0, NULL, NULL) > 0)
7074 	retval = OK;
7075 
7076     return retval;
7077 }
7078 
7079 /*
7080  * Set quickfix list context.
7081  */
7082     static int
7083 qf_setprop_context(qf_list_T *qfl, dictitem_T *di)
7084 {
7085     typval_T	*ctx;
7086 
7087     free_tv(qfl->qf_ctx);
7088     ctx =  alloc_tv();
7089     if (ctx != NULL)
7090 	copy_tv(&di->di_tv, ctx);
7091     qfl->qf_ctx = ctx;
7092 
7093     return OK;
7094 }
7095 
7096 /*
7097  * Set the current index in the specified quickfix list
7098  */
7099     static int
7100 qf_setprop_curidx(qf_info_T *qi, qf_list_T *qfl, dictitem_T *di)
7101 {
7102     int		denote = FALSE;
7103     int		newidx;
7104     int		old_qfidx;
7105     qfline_T	*qf_ptr;
7106 
7107     // If the specified index is '$', then use the last entry
7108     if (di->di_tv.v_type == VAR_STRING
7109 	    && di->di_tv.vval.v_string != NULL
7110 	    && STRCMP(di->di_tv.vval.v_string, "$") == 0)
7111 	newidx = qfl->qf_count;
7112     else
7113     {
7114 	// Otherwise use the specified index
7115 	newidx = tv_get_number_chk(&di->di_tv, &denote);
7116 	if (denote)
7117 	    return FAIL;
7118     }
7119 
7120     if (newidx < 1)		// sanity check
7121 	return FAIL;
7122     if (newidx > qfl->qf_count)
7123 	newidx = qfl->qf_count;
7124 
7125     old_qfidx = qfl->qf_index;
7126     qf_ptr = get_nth_entry(qfl, newidx, &newidx);
7127     if (qf_ptr == NULL)
7128 	return FAIL;
7129     qfl->qf_ptr = qf_ptr;
7130     qfl->qf_index = newidx;
7131 
7132     // If the current list is modified and it is displayed in the quickfix
7133     // window, then Update it.
7134     if (qf_get_curlist(qi)->qf_id == qfl->qf_id)
7135 	qf_win_pos_update(qi, old_qfidx);
7136 
7137     return OK;
7138 }
7139 
7140 /*
7141  * Set quickfix/location list properties (title, items, context).
7142  * Also used to add items from parsing a list of lines.
7143  * Used by the setqflist() and setloclist() Vim script functions.
7144  */
7145     static int
7146 qf_set_properties(qf_info_T *qi, dict_T *what, int action, char_u *title)
7147 {
7148     dictitem_T	*di;
7149     int		retval = FAIL;
7150     int		qf_idx;
7151     int		newlist = FALSE;
7152     qf_list_T	*qfl;
7153 
7154     if (action == ' ' || qf_stack_empty(qi))
7155 	newlist = TRUE;
7156 
7157     qf_idx = qf_setprop_get_qfidx(qi, what, action, &newlist);
7158     if (qf_idx == INVALID_QFIDX)	// List not found
7159 	return FAIL;
7160 
7161     if (newlist)
7162     {
7163 	qi->qf_curlist = qf_idx;
7164 	qf_new_list(qi, title);
7165 	qf_idx = qi->qf_curlist;
7166     }
7167 
7168     qfl = qf_get_list(qi, qf_idx);
7169     if ((di = dict_find(what, (char_u *)"title", -1)) != NULL)
7170 	retval = qf_setprop_title(qi, qf_idx, what, di);
7171     if ((di = dict_find(what, (char_u *)"items", -1)) != NULL)
7172 	retval = qf_setprop_items(qi, qf_idx, di, action);
7173     if ((di = dict_find(what, (char_u *)"lines", -1)) != NULL)
7174 	retval = qf_setprop_items_from_lines(qi, qf_idx, what, di, action);
7175     if ((di = dict_find(what, (char_u *)"context", -1)) != NULL)
7176 	retval = qf_setprop_context(qfl, di);
7177     if ((di = dict_find(what, (char_u *)"idx", -1)) != NULL)
7178 	retval = qf_setprop_curidx(qi, qfl, di);
7179 
7180     if (retval == OK)
7181 	qf_list_changed(qfl);
7182 
7183     return retval;
7184 }
7185 
7186 /*
7187  * Free the entire quickfix/location list stack.
7188  * If the quickfix/location list window is open, then clear it.
7189  */
7190     static void
7191 qf_free_stack(win_T *wp, qf_info_T *qi)
7192 {
7193     win_T	*qfwin = qf_find_win(qi);
7194     win_T	*llwin = NULL;
7195 
7196     if (qfwin != NULL)
7197     {
7198 	// If the quickfix/location list window is open, then clear it
7199 	if (qi->qf_curlist < qi->qf_listcount)
7200 	    qf_free(qf_get_curlist(qi));
7201 	qf_update_buffer(qi, NULL);
7202     }
7203 
7204     if (wp != NULL && IS_LL_WINDOW(wp))
7205     {
7206 	// If in the location list window, then use the non-location list
7207 	// window with this location list (if present)
7208 	llwin = qf_find_win_with_loclist(qi);
7209 	if (llwin != NULL)
7210 	    wp = llwin;
7211     }
7212 
7213     qf_free_all(wp);
7214     if (wp == NULL)
7215     {
7216 	// quickfix list
7217 	qi->qf_curlist = 0;
7218 	qi->qf_listcount = 0;
7219     }
7220     else if (qfwin != NULL)
7221     {
7222 	// If the location list window is open, then create a new empty
7223 	// location list
7224 	qf_info_T *new_ll = qf_alloc_stack(QFLT_LOCATION);
7225 
7226 	if (new_ll != NULL)
7227 	{
7228 	    new_ll->qf_bufnr = qfwin->w_buffer->b_fnum;
7229 
7230 	    // first free the list reference in the location list window
7231 	    ll_free_all(&qfwin->w_llist_ref);
7232 
7233 	    qfwin->w_llist_ref = new_ll;
7234 	    if (wp != qfwin)
7235 		win_set_loclist(wp, new_ll);
7236 	}
7237     }
7238 }
7239 
7240 /*
7241  * Populate the quickfix list with the items supplied in the list
7242  * of dictionaries. "title" will be copied to w:quickfix_title.
7243  * "action" is 'a' for add, 'r' for replace.  Otherwise create a new list.
7244  */
7245     int
7246 set_errorlist(
7247 	win_T	*wp,
7248 	list_T	*list,
7249 	int	action,
7250 	char_u	*title,
7251 	dict_T	*what)
7252 {
7253     qf_info_T	*qi = &ql_info;
7254     int		retval = OK;
7255 
7256     if (wp != NULL)
7257     {
7258 	qi = ll_get_or_alloc_list(wp);
7259 	if (qi == NULL)
7260 	    return FAIL;
7261     }
7262 
7263     if (action == 'f')
7264     {
7265 	// Free the entire quickfix or location list stack
7266 	qf_free_stack(wp, qi);
7267 	return OK;
7268     }
7269 
7270     incr_quickfix_busy();
7271 
7272     if (what != NULL)
7273 	retval = qf_set_properties(qi, what, action, title);
7274     else
7275     {
7276 	retval = qf_add_entries(qi, qi->qf_curlist, list, title, action);
7277 	if (retval == OK)
7278 	    qf_list_changed(qf_get_curlist(qi));
7279     }
7280 
7281     decr_quickfix_busy();
7282 
7283     return retval;
7284 }
7285 
7286 /*
7287  * Mark the context as in use for all the lists in a quickfix stack.
7288  */
7289     static int
7290 mark_quickfix_ctx(qf_info_T *qi, int copyID)
7291 {
7292     int		i;
7293     int		abort = FALSE;
7294     typval_T	*ctx;
7295 
7296     for (i = 0; i < LISTCOUNT && !abort; ++i)
7297     {
7298 	ctx = qi->qf_lists[i].qf_ctx;
7299 	if (ctx != NULL && ctx->v_type != VAR_NUMBER
7300 		&& ctx->v_type != VAR_STRING && ctx->v_type != VAR_FLOAT)
7301 	    abort = set_ref_in_item(ctx, copyID, NULL, NULL);
7302     }
7303 
7304     return abort;
7305 }
7306 
7307 /*
7308  * Mark the context of the quickfix list and the location lists (if present) as
7309  * "in use". So that garbage collection doesn't free the context.
7310  */
7311     int
7312 set_ref_in_quickfix(int copyID)
7313 {
7314     int		abort = FALSE;
7315     tabpage_T	*tp;
7316     win_T	*win;
7317 
7318     abort = mark_quickfix_ctx(&ql_info, copyID);
7319     if (abort)
7320 	return abort;
7321 
7322     FOR_ALL_TAB_WINDOWS(tp, win)
7323     {
7324 	if (win->w_llist != NULL)
7325 	{
7326 	    abort = mark_quickfix_ctx(win->w_llist, copyID);
7327 	    if (abort)
7328 		return abort;
7329 	}
7330 	if (IS_LL_WINDOW(win) && (win->w_llist_ref->qf_refcount == 1))
7331 	{
7332 	    // In a location list window and none of the other windows is
7333 	    // referring to this location list. Mark the location list
7334 	    // context as still in use.
7335 	    abort = mark_quickfix_ctx(win->w_llist_ref, copyID);
7336 	    if (abort)
7337 		return abort;
7338 	}
7339     }
7340 
7341     return abort;
7342 }
7343 #endif
7344 
7345 /*
7346  * Return the autocmd name for the :cbuffer Ex commands
7347  */
7348     static char_u *
7349 cbuffer_get_auname(cmdidx_T cmdidx)
7350 {
7351     switch (cmdidx)
7352     {
7353 	case CMD_cbuffer:	return (char_u *)"cbuffer";
7354 	case CMD_cgetbuffer:	return (char_u *)"cgetbuffer";
7355 	case CMD_caddbuffer:	return (char_u *)"caddbuffer";
7356 	case CMD_lbuffer:	return (char_u *)"lbuffer";
7357 	case CMD_lgetbuffer:	return (char_u *)"lgetbuffer";
7358 	case CMD_laddbuffer:	return (char_u *)"laddbuffer";
7359 	default:		return NULL;
7360     }
7361 }
7362 
7363 /*
7364  * Process and validate the arguments passed to the :cbuffer, :caddbuffer,
7365  * :cgetbuffer, :lbuffer, :laddbuffer, :lgetbuffer Ex commands.
7366  */
7367     static int
7368 cbuffer_process_args(
7369 	exarg_T		*eap,
7370 	buf_T		**bufp,
7371 	linenr_T	*line1,
7372 	linenr_T	*line2)
7373 {
7374     buf_T	*buf = NULL;
7375 
7376     if (*eap->arg == NUL)
7377 	buf = curbuf;
7378     else if (*skipwhite(skipdigits(eap->arg)) == NUL)
7379 	buf = buflist_findnr(atoi((char *)eap->arg));
7380 
7381     if (buf == NULL)
7382     {
7383 	emsg(_(e_invarg));
7384 	return FAIL;
7385     }
7386 
7387     if (buf->b_ml.ml_mfp == NULL)
7388     {
7389 	emsg(_("E681: Buffer is not loaded"));
7390 	return FAIL;
7391     }
7392 
7393     if (eap->addr_count == 0)
7394     {
7395 	eap->line1 = 1;
7396 	eap->line2 = buf->b_ml.ml_line_count;
7397     }
7398 
7399     if (eap->line1 < 1 || eap->line1 > buf->b_ml.ml_line_count
7400 	    || eap->line2 < 1 || eap->line2 > buf->b_ml.ml_line_count)
7401     {
7402 	emsg(_(e_invrange));
7403 	return FAIL;
7404     }
7405 
7406     *line1 = eap->line1;
7407     *line2 = eap->line2;
7408     *bufp = buf;
7409 
7410     return OK;
7411 }
7412 
7413 /*
7414  * ":[range]cbuffer [bufnr]" command.
7415  * ":[range]caddbuffer [bufnr]" command.
7416  * ":[range]cgetbuffer [bufnr]" command.
7417  * ":[range]lbuffer [bufnr]" command.
7418  * ":[range]laddbuffer [bufnr]" command.
7419  * ":[range]lgetbuffer [bufnr]" command.
7420  */
7421     void
7422 ex_cbuffer(exarg_T *eap)
7423 {
7424     buf_T	*buf = NULL;
7425     qf_info_T	*qi;
7426     char_u	*au_name = NULL;
7427     int		res;
7428     int_u	save_qfid;
7429     win_T	*wp = NULL;
7430     char_u	*qf_title;
7431     linenr_T	line1;
7432     linenr_T	line2;
7433 
7434     au_name = cbuffer_get_auname(eap->cmdidx);
7435     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
7436 					curbuf->b_fname, TRUE, curbuf))
7437     {
7438 #ifdef FEAT_EVAL
7439 	if (aborting())
7440 	    return;
7441 #endif
7442     }
7443 
7444     // Must come after autocommands.
7445     qi = qf_cmd_get_or_alloc_stack(eap, &wp);
7446     if (qi == NULL)
7447 	return;
7448 
7449     if (cbuffer_process_args(eap, &buf, &line1, &line2) == FAIL)
7450 	return;
7451 
7452     qf_title = qf_cmdtitle(*eap->cmdlinep);
7453 
7454     if (buf->b_sfname)
7455     {
7456 	vim_snprintf((char *)IObuff, IOSIZE, "%s (%s)",
7457 		(char *)qf_title, (char *)buf->b_sfname);
7458 	qf_title = IObuff;
7459     }
7460 
7461     incr_quickfix_busy();
7462 
7463     res = qf_init_ext(qi, qi->qf_curlist, NULL, buf, NULL, p_efm,
7464 	    (eap->cmdidx != CMD_caddbuffer
7465 	     && eap->cmdidx != CMD_laddbuffer),
7466 	    line1, line2,
7467 	    qf_title, NULL);
7468     if (qf_stack_empty(qi))
7469     {
7470 	decr_quickfix_busy();
7471 	return;
7472     }
7473     if (res >= 0)
7474 	qf_list_changed(qf_get_curlist(qi));
7475 
7476     // Remember the current quickfix list identifier, so that we can
7477     // check for autocommands changing the current quickfix list.
7478     save_qfid = qf_get_curlist(qi)->qf_id;
7479     if (au_name != NULL)
7480     {
7481 	buf_T *curbuf_old = curbuf;
7482 
7483 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name, curbuf->b_fname,
7484 								TRUE, curbuf);
7485 	if (curbuf != curbuf_old)
7486 	    // Autocommands changed buffer, don't jump now, "qi" may
7487 	    // be invalid.
7488 	    res = 0;
7489     }
7490     // Jump to the first error for a new list and if autocmds didn't
7491     // free the list.
7492     if (res > 0 && (eap->cmdidx == CMD_cbuffer ||
7493 		eap->cmdidx == CMD_lbuffer)
7494 	    && qflist_valid(wp, save_qfid))
7495 	// display the first error
7496 	qf_jump_first(qi, save_qfid, eap->forceit);
7497 
7498     decr_quickfix_busy();
7499 }
7500 
7501 #if defined(FEAT_EVAL) || defined(PROTO)
7502 /*
7503  * Return the autocmd name for the :cexpr Ex commands.
7504  */
7505     static char_u *
7506 cexpr_get_auname(cmdidx_T cmdidx)
7507 {
7508     switch (cmdidx)
7509     {
7510 	case CMD_cexpr:	    return (char_u *)"cexpr";
7511 	case CMD_cgetexpr:  return (char_u *)"cgetexpr";
7512 	case CMD_caddexpr:  return (char_u *)"caddexpr";
7513 	case CMD_lexpr:	    return (char_u *)"lexpr";
7514 	case CMD_lgetexpr:  return (char_u *)"lgetexpr";
7515 	case CMD_laddexpr:  return (char_u *)"laddexpr";
7516 	default:	    return NULL;
7517     }
7518 }
7519 
7520 /*
7521  * ":cexpr {expr}", ":cgetexpr {expr}", ":caddexpr {expr}" command.
7522  * ":lexpr {expr}", ":lgetexpr {expr}", ":laddexpr {expr}" command.
7523  */
7524     void
7525 ex_cexpr(exarg_T *eap)
7526 {
7527     typval_T	*tv;
7528     qf_info_T	*qi;
7529     char_u	*au_name = NULL;
7530     int		res;
7531     int_u	save_qfid;
7532     win_T	*wp = NULL;
7533 
7534     au_name = cexpr_get_auname(eap->cmdidx);
7535     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
7536 					       curbuf->b_fname, TRUE, curbuf))
7537     {
7538 #ifdef FEAT_EVAL
7539 	if (aborting())
7540 	    return;
7541 #endif
7542     }
7543 
7544     qi = qf_cmd_get_or_alloc_stack(eap, &wp);
7545     if (qi == NULL)
7546 	return;
7547 
7548     // Evaluate the expression.  When the result is a string or a list we can
7549     // use it to fill the errorlist.
7550     tv = eval_expr(eap->arg, NULL);
7551     if (tv != NULL)
7552     {
7553 	if ((tv->v_type == VAR_STRING && tv->vval.v_string != NULL)
7554 		|| (tv->v_type == VAR_LIST && tv->vval.v_list != NULL))
7555 	{
7556 	    incr_quickfix_busy();
7557 	    res = qf_init_ext(qi, qi->qf_curlist, NULL, NULL, tv, p_efm,
7558 			    (eap->cmdidx != CMD_caddexpr
7559 			     && eap->cmdidx != CMD_laddexpr),
7560 				 (linenr_T)0, (linenr_T)0,
7561 				 qf_cmdtitle(*eap->cmdlinep), NULL);
7562 	    if (qf_stack_empty(qi))
7563 	    {
7564 		decr_quickfix_busy();
7565 		goto cleanup;
7566 	    }
7567 	    if (res >= 0)
7568 		qf_list_changed(qf_get_curlist(qi));
7569 
7570 	    // Remember the current quickfix list identifier, so that we can
7571 	    // check for autocommands changing the current quickfix list.
7572 	    save_qfid = qf_get_curlist(qi)->qf_id;
7573 	    if (au_name != NULL)
7574 		apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
7575 						curbuf->b_fname, TRUE, curbuf);
7576 
7577 	    // Jump to the first error for a new list and if autocmds didn't
7578 	    // free the list.
7579 	    if (res > 0 && (eap->cmdidx == CMD_cexpr
7580 						   || eap->cmdidx == CMD_lexpr)
7581 		    && qflist_valid(wp, save_qfid))
7582 		// display the first error
7583 		qf_jump_first(qi, save_qfid, eap->forceit);
7584 	    decr_quickfix_busy();
7585 	}
7586 	else
7587 	    emsg(_("E777: String or List expected"));
7588 cleanup:
7589 	free_tv(tv);
7590     }
7591 }
7592 #endif
7593 
7594 /*
7595  * Get the location list for ":lhelpgrep"
7596  */
7597     static qf_info_T *
7598 hgr_get_ll(int *new_ll)
7599 {
7600     win_T	*wp;
7601     qf_info_T	*qi;
7602 
7603     // If the current window is a help window, then use it
7604     if (bt_help(curwin->w_buffer))
7605 	wp = curwin;
7606     else
7607 	// Find an existing help window
7608 	wp = qf_find_help_win();
7609 
7610     if (wp == NULL)	    // Help window not found
7611 	qi = NULL;
7612     else
7613 	qi = wp->w_llist;
7614 
7615     if (qi == NULL)
7616     {
7617 	// Allocate a new location list for help text matches
7618 	if ((qi = qf_alloc_stack(QFLT_LOCATION)) == NULL)
7619 	    return NULL;
7620 	*new_ll = TRUE;
7621     }
7622 
7623     return qi;
7624 }
7625 
7626 /*
7627  * Search for a pattern in a help file.
7628  */
7629     static void
7630 hgr_search_file(
7631 	qf_list_T *qfl,
7632 	char_u *fname,
7633 	vimconv_T *p_vc,
7634 	regmatch_T *p_regmatch)
7635 {
7636     FILE	*fd;
7637     long	lnum;
7638 
7639     fd = mch_fopen((char *)fname, "r");
7640     if (fd == NULL)
7641 	return;
7642 
7643     lnum = 1;
7644     while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
7645     {
7646 	char_u    *line = IObuff;
7647 
7648 	// Convert a line if 'encoding' is not utf-8 and
7649 	// the line contains a non-ASCII character.
7650 	if (p_vc->vc_type != CONV_NONE
7651 		&& has_non_ascii(IObuff))
7652 	{
7653 	    line = string_convert(p_vc, IObuff, NULL);
7654 	    if (line == NULL)
7655 		line = IObuff;
7656 	}
7657 
7658 	if (vim_regexec(p_regmatch, line, (colnr_T)0))
7659 	{
7660 	    int	l = (int)STRLEN(line);
7661 
7662 	    // remove trailing CR, LF, spaces, etc.
7663 	    while (l > 0 && line[l - 1] <= ' ')
7664 		line[--l] = NUL;
7665 
7666 	    if (qf_add_entry(qfl,
7667 			NULL,	// dir
7668 			fname,
7669 			NULL,
7670 			0,
7671 			line,
7672 			lnum,
7673 			(int)(p_regmatch->startp[0] - line)
7674 			+ 1,	// col
7675 			FALSE,	// vis_col
7676 			NULL,	// search pattern
7677 			0,	// nr
7678 			1,	// type
7679 			TRUE	// valid
7680 			) == QF_FAIL)
7681 	    {
7682 		got_int = TRUE;
7683 		if (line != IObuff)
7684 		    vim_free(line);
7685 		break;
7686 	    }
7687 	}
7688 	if (line != IObuff)
7689 	    vim_free(line);
7690 	++lnum;
7691 	line_breakcheck();
7692     }
7693     fclose(fd);
7694 }
7695 
7696 /*
7697  * Search for a pattern in all the help files in the doc directory under
7698  * the given directory.
7699  */
7700     static void
7701 hgr_search_files_in_dir(
7702 	qf_list_T *qfl,
7703 	char_u *dirname,
7704 	regmatch_T *p_regmatch,
7705 	vimconv_T *p_vc
7706 #ifdef FEAT_MULTI_LANG
7707 	, char_u *lang
7708 #endif
7709 	)
7710 {
7711     int		fcount;
7712     char_u	**fnames;
7713     int		fi;
7714 
7715     // Find all "*.txt" and "*.??x" files in the "doc" directory.
7716     add_pathsep(dirname);
7717     STRCAT(dirname, "doc/*.\\(txt\\|??x\\)");
7718     if (gen_expand_wildcards(1, &dirname, &fcount,
7719 		&fnames, EW_FILE|EW_SILENT) == OK
7720 	    && fcount > 0)
7721     {
7722 	for (fi = 0; fi < fcount && !got_int; ++fi)
7723 	{
7724 #ifdef FEAT_MULTI_LANG
7725 	    // Skip files for a different language.
7726 	    if (lang != NULL
7727 		    && STRNICMP(lang, fnames[fi]
7728 				    + STRLEN(fnames[fi]) - 3, 2) != 0
7729 		    && !(STRNICMP(lang, "en", 2) == 0
7730 			&& STRNICMP("txt", fnames[fi]
7731 			    + STRLEN(fnames[fi]) - 3, 3) == 0))
7732 		continue;
7733 #endif
7734 
7735 	    hgr_search_file(qfl, fnames[fi], p_vc, p_regmatch);
7736 	}
7737 	FreeWild(fcount, fnames);
7738     }
7739 }
7740 
7741 /*
7742  * Search for a pattern in all the help files in the 'runtimepath'
7743  * and add the matches to a quickfix list.
7744  * 'lang' is the language specifier.  If supplied, then only matches in the
7745  * specified language are found.
7746  */
7747     static void
7748 hgr_search_in_rtp(qf_list_T *qfl, regmatch_T *p_regmatch, char_u *lang)
7749 {
7750     char_u	*p;
7751 
7752     vimconv_T	vc;
7753 
7754     // Help files are in utf-8 or latin1, convert lines when 'encoding'
7755     // differs.
7756     vc.vc_type = CONV_NONE;
7757     if (!enc_utf8)
7758 	convert_setup(&vc, (char_u *)"utf-8", p_enc);
7759 
7760     // Go through all the directories in 'runtimepath'
7761     p = p_rtp;
7762     while (*p != NUL && !got_int)
7763     {
7764 	copy_option_part(&p, NameBuff, MAXPATHL, ",");
7765 
7766 	hgr_search_files_in_dir(qfl, NameBuff, p_regmatch, &vc
7767 #ifdef FEAT_MULTI_LANG
7768 		, lang
7769 #endif
7770 		);
7771     }
7772 
7773     if (vc.vc_type != CONV_NONE)
7774 	convert_setup(&vc, NULL, NULL);
7775 }
7776 
7777 /*
7778  * ":helpgrep {pattern}"
7779  */
7780     void
7781 ex_helpgrep(exarg_T *eap)
7782 {
7783     regmatch_T	regmatch;
7784     char_u	*save_cpo;
7785     qf_info_T	*qi = &ql_info;
7786     int		new_qi = FALSE;
7787     char_u	*au_name =  NULL;
7788     char_u	*lang = NULL;
7789 
7790     switch (eap->cmdidx)
7791     {
7792 	case CMD_helpgrep:  au_name = (char_u *)"helpgrep"; break;
7793 	case CMD_lhelpgrep: au_name = (char_u *)"lhelpgrep"; break;
7794 	default: break;
7795     }
7796     if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
7797 					       curbuf->b_fname, TRUE, curbuf))
7798     {
7799 #ifdef FEAT_EVAL
7800 	if (aborting())
7801 	    return;
7802 #endif
7803     }
7804 
7805     if (is_loclist_cmd(eap->cmdidx))
7806     {
7807 	qi = hgr_get_ll(&new_qi);
7808 	if (qi == NULL)
7809 	    return;
7810     }
7811 
7812     // Make 'cpoptions' empty, the 'l' flag should not be used here.
7813     save_cpo = p_cpo;
7814     p_cpo = empty_option;
7815 
7816     incr_quickfix_busy();
7817 
7818 #ifdef FEAT_MULTI_LANG
7819     // Check for a specified language
7820     lang = check_help_lang(eap->arg);
7821 #endif
7822     regmatch.regprog = vim_regcomp(eap->arg, RE_MAGIC + RE_STRING);
7823     regmatch.rm_ic = FALSE;
7824     if (regmatch.regprog != NULL)
7825     {
7826 	qf_list_T	*qfl;
7827 
7828 	// create a new quickfix list
7829 	qf_new_list(qi, qf_cmdtitle(*eap->cmdlinep));
7830 	qfl = qf_get_curlist(qi);
7831 
7832 	hgr_search_in_rtp(qfl, &regmatch, lang);
7833 
7834 	vim_regfree(regmatch.regprog);
7835 
7836 	qfl->qf_nonevalid = FALSE;
7837 	qfl->qf_ptr = qfl->qf_start;
7838 	qfl->qf_index = 1;
7839 	qf_list_changed(qfl);
7840 	qf_update_buffer(qi, NULL);
7841     }
7842 
7843     if (p_cpo == empty_option)
7844 	p_cpo = save_cpo;
7845     else
7846 	// Darn, some plugin changed the value.
7847 	free_string_option(save_cpo);
7848 
7849     if (au_name != NULL)
7850     {
7851 	apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
7852 					       curbuf->b_fname, TRUE, curbuf);
7853 	if (!new_qi && IS_LL_STACK(qi) && qf_find_buf(qi) == NULL)
7854 	{
7855 	    // autocommands made "qi" invalid
7856 	    decr_quickfix_busy();
7857 	    return;
7858 	}
7859     }
7860 
7861     // Jump to first match.
7862     if (!qf_list_empty(qf_get_curlist(qi)))
7863 	qf_jump(qi, 0, 0, FALSE);
7864     else
7865 	semsg(_(e_nomatch2), eap->arg);
7866 
7867     decr_quickfix_busy();
7868 
7869     if (eap->cmdidx == CMD_lhelpgrep)
7870     {
7871 	// If the help window is not opened or if it already points to the
7872 	// correct location list, then free the new location list.
7873 	if (!bt_help(curwin->w_buffer) || curwin->w_llist == qi)
7874 	{
7875 	    if (new_qi)
7876 		ll_free_all(&qi);
7877 	}
7878 	else if (curwin->w_llist == NULL)
7879 	    curwin->w_llist = qi;
7880     }
7881 }
7882 #endif /* FEAT_QUICKFIX */
7883 
7884 #if defined(FEAT_EVAL) || defined(PROTO)
7885 # ifdef FEAT_QUICKFIX
7886     static void
7887 get_qf_loc_list(int is_qf, win_T *wp, typval_T *what_arg, typval_T *rettv)
7888 {
7889     if (what_arg->v_type == VAR_UNKNOWN)
7890     {
7891 	if (rettv_list_alloc(rettv) == OK)
7892 	    if (is_qf || wp != NULL)
7893 		(void)get_errorlist(NULL, wp, -1, rettv->vval.v_list);
7894     }
7895     else
7896     {
7897 	if (rettv_dict_alloc(rettv) == OK)
7898 	    if (is_qf || (wp != NULL))
7899 	    {
7900 		if (what_arg->v_type == VAR_DICT)
7901 		{
7902 		    dict_T	*d = what_arg->vval.v_dict;
7903 
7904 		    if (d != NULL)
7905 			qf_get_properties(wp, d, rettv->vval.v_dict);
7906 		}
7907 		else
7908 		    emsg(_(e_dictreq));
7909 	    }
7910     }
7911 }
7912 # endif
7913 
7914 /*
7915  * "getloclist()" function
7916  */
7917     void
7918 f_getloclist(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
7919 {
7920 # ifdef FEAT_QUICKFIX
7921     win_T	*wp;
7922 
7923     wp = find_win_by_nr_or_id(&argvars[0]);
7924     get_qf_loc_list(FALSE, wp, &argvars[1], rettv);
7925 # endif
7926 }
7927 
7928 /*
7929  * "getqflist()" function
7930  */
7931     void
7932 f_getqflist(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
7933 {
7934 # ifdef FEAT_QUICKFIX
7935     get_qf_loc_list(TRUE, NULL, &argvars[0], rettv);
7936 # endif
7937 }
7938 
7939 /*
7940  * Used by "setqflist()" and "setloclist()" functions
7941  */
7942     static void
7943 set_qf_ll_list(
7944     win_T	*wp UNUSED,
7945     typval_T	*list_arg UNUSED,
7946     typval_T	*action_arg UNUSED,
7947     typval_T	*what_arg UNUSED,
7948     typval_T	*rettv)
7949 {
7950 # ifdef FEAT_QUICKFIX
7951     static char *e_invact = N_("E927: Invalid action: '%s'");
7952     char_u	*act;
7953     int		action = 0;
7954     static int	recursive = 0;
7955 # endif
7956 
7957     rettv->vval.v_number = -1;
7958 
7959 # ifdef FEAT_QUICKFIX
7960     if (list_arg->v_type != VAR_LIST)
7961 	emsg(_(e_listreq));
7962     else if (recursive != 0)
7963 	emsg(_(e_au_recursive));
7964     else
7965     {
7966 	list_T  *l = list_arg->vval.v_list;
7967 	dict_T	*d = NULL;
7968 	int	valid_dict = TRUE;
7969 
7970 	if (action_arg->v_type == VAR_STRING)
7971 	{
7972 	    act = tv_get_string_chk(action_arg);
7973 	    if (act == NULL)
7974 		return;		// type error; errmsg already given
7975 	    if ((*act == 'a' || *act == 'r' || *act == ' ' || *act == 'f') &&
7976 		    act[1] == NUL)
7977 		action = *act;
7978 	    else
7979 		semsg(_(e_invact), act);
7980 	}
7981 	else if (action_arg->v_type == VAR_UNKNOWN)
7982 	    action = ' ';
7983 	else
7984 	    emsg(_(e_stringreq));
7985 
7986 	if (action_arg->v_type != VAR_UNKNOWN
7987 		&& what_arg->v_type != VAR_UNKNOWN)
7988 	{
7989 	    if (what_arg->v_type == VAR_DICT)
7990 		d = what_arg->vval.v_dict;
7991 	    else
7992 	    {
7993 		emsg(_(e_dictreq));
7994 		valid_dict = FALSE;
7995 	    }
7996 	}
7997 
7998 	++recursive;
7999 	if (l != NULL && action && valid_dict && set_errorlist(wp, l, action,
8000 		     (char_u *)(wp == NULL ? ":setqflist()" : ":setloclist()"),
8001 		     d) == OK)
8002 	    rettv->vval.v_number = 0;
8003 	--recursive;
8004     }
8005 # endif
8006 }
8007 
8008 /*
8009  * "setloclist()" function
8010  */
8011     void
8012 f_setloclist(typval_T *argvars, typval_T *rettv)
8013 {
8014     win_T	*win;
8015 
8016     rettv->vval.v_number = -1;
8017 
8018     win = find_win_by_nr_or_id(&argvars[0]);
8019     if (win != NULL)
8020 	set_qf_ll_list(win, &argvars[1], &argvars[2], &argvars[3], rettv);
8021 }
8022 
8023 /*
8024  * "setqflist()" function
8025  */
8026     void
8027 f_setqflist(typval_T *argvars, typval_T *rettv)
8028 {
8029     set_qf_ll_list(NULL, &argvars[0], &argvars[1], &argvars[2], rettv);
8030 }
8031 #endif
8032