blob: d8bcc1232afd8549caf5dc2c9960579cb18e782e [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
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
18struct dir_stack_T
19{
20 struct dir_stack_T *next;
21 char_u *dirname;
22};
23
Bram Moolenaar071d4272004-06-13 20:20:40 +000024/*
Bram Moolenaar68b76a62005-03-25 21:53:48 +000025 * For each error the next struct is allocated and linked in a list.
Bram Moolenaar071d4272004-06-13 20:20:40 +000026 */
Bram Moolenaar68b76a62005-03-25 21:53:48 +000027typedef struct qfline_S qfline_T;
28struct qfline_S
Bram Moolenaar071d4272004-06-13 20:20:40 +000029{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +020030 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
thinca6864efa2021-06-19 20:45:20 +020033 linenr_T qf_end_lnum; // line number when the error has range or zero
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +020034 int qf_fnum; // file number for the line
35 int qf_col; // column where the error occurred
thinca6864efa2021-06-19 20:45:20 +020036 int qf_end_col; // column when the error has range or zero
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +020037 int qf_nr; // error number
38 char_u *qf_module; // module name for this error
39 char_u *qf_pattern; // search pattern for the error
40 char_u *qf_text; // description of the error
thinca6864efa2021-06-19 20:45:20 +020041 char_u qf_viscol; // set to TRUE if qf_col and qf_end_col is
42 // screen column
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +020043 char_u qf_cleared; // set to TRUE if line has been deleted
44 char_u qf_type; // type of the error (mostly 'E'); 1 for
45 // :helpgrep
Tom Praschanca6ac992023-08-11 23:26:12 +020046 typval_T qf_user_data; // custom user data associated with this item
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +020047 char_u qf_valid; // valid error message detected
Bram Moolenaar071d4272004-06-13 20:20:40 +000048};
49
50/*
51 * There is a stack of error lists.
52 */
53#define LISTCOUNT 10
Bram Moolenaara2aa8a22018-04-24 13:55:00 +020054#define INVALID_QFIDX (-1)
Bram Moolenaaree8188f2019-02-05 21:23:04 +010055#define INVALID_QFBUFNR (0)
Bram Moolenaar071d4272004-06-13 20:20:40 +000056
Bram Moolenaar6a8958d2017-06-22 21:33:20 +020057/*
Bram Moolenaar2d67d302018-11-16 18:46:02 +010058 * Quickfix list type.
59 */
60typedef enum
61{
62 QFLT_QUICKFIX, // Quickfix list - global list
63 QFLT_LOCATION, // Location list - per window list
64 QFLT_INTERNAL // Internal - Temporary list used by getqflist()/getloclist()
65} qfltype_T;
66
67/*
Bram Moolenaar6a8958d2017-06-22 21:33:20 +020068 * Quickfix/Location list definition
69 * Contains a list of entries (qfline_T). qf_start points to the first entry
70 * and qf_last points to the last entry. qf_count contains the list size.
71 *
72 * Usually the list contains one or more entries. But an empty list can be
73 * created using setqflist()/setloclist() with a title and/or user context
74 * information and entries can be added later using setqflist()/setloclist().
75 */
Bram Moolenaard12f5c12006-01-25 22:10:52 +000076typedef struct qf_list_S
Bram Moolenaar071d4272004-06-13 20:20:40 +000077{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +020078 int_u qf_id; // Unique identifier for this list
Bram Moolenaar2d67d302018-11-16 18:46:02 +010079 qfltype_T qfl_type;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +020080 qfline_T *qf_start; // pointer to the first error
81 qfline_T *qf_last; // pointer to the last error
82 qfline_T *qf_ptr; // pointer to the current error
83 int qf_count; // number of errors (0 means empty list)
84 int qf_index; // current index in the error list
85 int qf_nonevalid; // TRUE if not a single valid entry found
Tom Praschanca6ac992023-08-11 23:26:12 +020086 int qf_has_user_data; // TRUE if at least one item has user_data attached
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +020087 char_u *qf_title; // title derived from the command that created
88 // the error list or set by setqflist
89 typval_T *qf_ctx; // context set by setqflist/setloclist
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +010090 callback_T qf_qftf_cb; // 'quickfixtextfunc' callback function
Bram Moolenaara7df8c72017-07-19 13:23:06 +020091
92 struct dir_stack_T *qf_dir_stack;
93 char_u *qf_directory;
94 struct dir_stack_T *qf_file_stack;
95 char_u *qf_currfile;
96 int qf_multiline;
97 int qf_multiignore;
98 int qf_multiscan;
Bram Moolenaarb254af32017-12-18 19:48:58 +010099 long qf_changedtick;
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000100} qf_list_T;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000101
Bram Moolenaar6a8958d2017-06-22 21:33:20 +0200102/*
103 * Quickfix/Location list stack definition
104 * Contains a list of quickfix/location lists (qf_list_T)
105 */
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000106struct qf_info_S
107{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200108 // Count of references to this list. Used only for location lists.
109 // When a location list window reference this list, qf_refcount
110 // will be 2. Otherwise, qf_refcount will be 1. When qf_refcount
111 // reaches 0, the list is freed.
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000112 int qf_refcount;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200113 int qf_listcount; // current number of lists
114 int qf_curlist; // current error list
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000115 qf_list_T qf_lists[LISTCOUNT];
Bram Moolenaar2d67d302018-11-16 18:46:02 +0100116 qfltype_T qfl_type; // type of list
Bram Moolenaaree8188f2019-02-05 21:23:04 +0100117 int qf_bufnr; // quickfix window buffer number
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000118};
119
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200120static qf_info_T ql_info; // global quickfix list
121static int_u last_qf_id = 0; // Last used quickfix list id
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122
Yegappan Lakshmananb7318002023-10-25 20:50:28 +0200123#define FMT_PATTERNS 14 // maximum number of % recognized
Bram Moolenaar071d4272004-06-13 20:20:40 +0000124
125/*
126 * Structure used to hold the info of one part of 'errorformat'
127 */
Bram Moolenaar01265852006-03-20 21:50:15 +0000128typedef struct efm_S efm_T;
129struct efm_S
Bram Moolenaar071d4272004-06-13 20:20:40 +0000130{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200131 regprog_T *prog; // pre-formatted part of 'errorformat'
132 efm_T *next; // pointer to next (NULL if last)
133 char_u addr[FMT_PATTERNS]; // indices of used % patterns
134 char_u prefix; // prefix of this format line:
135 // 'D' enter directory
136 // 'X' leave directory
137 // 'A' start of multi-line message
138 // 'E' error message
139 // 'W' warning message
140 // 'I' informational message
Bram Moolenaare9283662020-06-07 14:10:47 +0200141 // 'N' note message
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200142 // 'C' continuation line
143 // 'Z' end of multi-line message
144 // 'G' general, unspecific message
145 // 'P' push file (partial) message
146 // 'Q' pop/quit file (partial) message
147 // 'O' overread (partial) message
148 char_u flags; // additional flags given in prefix
149 // '-' do not include this line
150 // '+' include whole line in message
151 int conthere; // %> used
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152};
153
Bram Moolenaar9f84ded2018-10-20 20:54:02 +0200154// List of location lists to be deleted.
155// Used to delay the deletion of locations lists by autocmds.
156typedef struct qf_delq_S
157{
158 struct qf_delq_S *next;
159 qf_info_T *qi;
160} qf_delq_T;
161static qf_delq_T *qf_delq_head = NULL;
162
163// Counter to prevent autocmds from freeing up location lists when they are
164// still being used.
165static int quickfix_busy = 0;
166
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200167static efm_T *fmt_start = NULL; // cached across qf_parse_line() calls
Bram Moolenaar63bed3d2016-11-12 15:36:54 +0100168
Bram Moolenaard43906d2020-07-20 21:31:32 +0200169// callback function for 'quickfixtextfunc'
170static callback_T qftf_cb;
171
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100172static void qf_new_list(qf_info_T *qi, char_u *qf_title);
Tom Praschanca6ac992023-08-11 23:26:12 +0200173static int qf_add_entry(qf_list_T *qfl, char_u *dir, char_u *fname, char_u *module, int bufnum, char_u *mesg, long lnum, long end_lnum, int col, int end_col, int vis_col, char_u *pattern, int nr, int type, typval_T *user_data, int valid);
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +0200174static void qf_free(qf_list_T *qfl);
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100175static char_u *qf_types(int, int);
Bram Moolenaar0398e002019-03-21 21:12:49 +0100176static int qf_get_fnum(qf_list_T *qfl, char_u *, char_u *);
Bram Moolenaar361c8f02016-07-02 15:41:47 +0200177static char_u *qf_push_dir(char_u *, struct dir_stack_T **, int is_file_stack);
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100178static char_u *qf_pop_dir(struct dir_stack_T **);
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +0200179static char_u *qf_guess_filepath(qf_list_T *qfl, char_u *);
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200180static void qf_jump_newwin(qf_info_T *qi, int dir, int errornr, int forceit, int newwin);
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +0100181static void qf_fmt_text(garray_T *gap, char_u *text);
182static void qf_range_text(garray_T *gap, qfline_T *qfp);
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100183static int qf_win_pos_update(qf_info_T *qi, int old_qf_index);
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100184static win_T *qf_find_win(qf_info_T *qi);
185static buf_T *qf_find_buf(qf_info_T *qi);
Bram Moolenaar864293a2016-06-02 13:40:04 +0200186static void qf_update_buffer(qf_info_T *qi, qfline_T *old_last);
Bram Moolenaar7ba5a7e2020-06-08 19:20:27 +0200187static void qf_fill_buffer(qf_list_T *qfl, buf_T *buf, qfline_T *old_last, int qf_winid);
Bram Moolenaarbaaa7e92016-01-29 22:47:03 +0100188static buf_T *load_dummy_buffer(char_u *fname, char_u *dirname_start, char_u *resulting_dir);
189static void wipe_dummy_buffer(buf_T *buf, char_u *dirname_start);
190static void unload_dummy_buffer(buf_T *buf, char_u *dirname_start);
191static qf_info_T *ll_get_or_alloc_list(win_T *);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200193// Quickfix window check helper macro
kylo252ae6f1d82022-02-16 19:24:07 +0000194#define IS_QF_WINDOW(wp) (bt_quickfix((wp)->w_buffer) && (wp)->w_llist_ref == NULL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200195// Location list window check helper macro
kylo252ae6f1d82022-02-16 19:24:07 +0000196#define IS_LL_WINDOW(wp) (bt_quickfix((wp)->w_buffer) && (wp)->w_llist_ref != NULL)
Bram Moolenaar4d77c652018-08-18 19:59:54 +0200197
198// Quickfix and location list stack check helper macros
kylo252ae6f1d82022-02-16 19:24:07 +0000199#define IS_QF_STACK(qi) ((qi)->qfl_type == QFLT_QUICKFIX)
200#define IS_LL_STACK(qi) ((qi)->qfl_type == QFLT_LOCATION)
201#define IS_QF_LIST(qfl) ((qfl)->qfl_type == QFLT_QUICKFIX)
202#define IS_LL_LIST(qfl) ((qfl)->qfl_type == QFLT_LOCATION)
Bram Moolenaar4d77c652018-08-18 19:59:54 +0200203
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000204/*
205 * Return location list for window 'wp'
206 * For location list window, return the referenced location list
207 */
kylo252ae6f1d82022-02-16 19:24:07 +0000208#define GET_LOC_LIST(wp) (IS_LL_WINDOW(wp) ? (wp)->w_llist_ref : (wp)->w_llist)
Bram Moolenaard12f5c12006-01-25 22:10:52 +0000209
Bram Moolenaar95946f12019-03-31 15:31:59 +0200210// Macro to loop through all the items in a quickfix list
211// Quickfix item index starts from 1, so i below starts at 1
Bram Moolenaara16123a2019-03-28 20:31:07 +0100212#define FOR_ALL_QFL_ITEMS(qfl, qfp, i) \
kylo252ae6f1d82022-02-16 19:24:07 +0000213 for ((i) = 1, (qfp) = (qfl)->qf_start; \
214 !got_int && (i) <= (qfl)->qf_count && (qfp) != NULL; \
215 ++(i), (qfp) = (qfp)->qf_next)
Bram Moolenaara16123a2019-03-28 20:31:07 +0100216
Bram Moolenaar071d4272004-06-13 20:20:40 +0000217/*
Bram Moolenaar6dd4a532017-05-28 07:56:36 +0200218 * Looking up a buffer can be slow if there are many. Remember the last one
219 * to make this a lot faster if there are multiple matches in the same file.
220 */
Bram Moolenaar45e5fd12017-06-04 14:58:02 +0200221static char_u *qf_last_bufname = NULL;
222static bufref_T qf_last_bufref = {NULL, 0, 0};
Bram Moolenaar6dd4a532017-05-28 07:56:36 +0200223
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +0100224static garray_T qfga;
225
226/*
227 * Get a growarray to buffer text in. Shared between various commands to avoid
228 * many alloc/free calls.
229 */
230 static garray_T *
231qfga_get(void)
232{
233 static int initialized = FALSE;
234
235 if (!initialized)
236 {
237 initialized = TRUE;
238 ga_init2(&qfga, 1, 256);
239 }
240
Yegappan Lakshmanand8cd6f72022-10-16 11:30:48 +0100241 // Reset the length to zero. Retain ga_data from previous use to avoid
242 // many alloc/free calls.
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +0100243 qfga.ga_len = 0;
244
245 return &qfga;
246}
247
Bram Moolenaar6dd4a532017-05-28 07:56:36 +0200248/*
Yegappan Lakshmanand8cd6f72022-10-16 11:30:48 +0100249 * The "qfga" grow array buffer is reused across multiple quickfix commands as
250 * a temporary buffer to reduce the number of alloc/free calls. But if the
251 * buffer size is large, then to avoid holding on to that memory, clear the
252 * grow array. Otherwise just reset the grow array length.
253 */
254 static void
255qfga_clear(void)
256{
257 if (qfga.ga_maxlen > 1000)
258 ga_clear(&qfga);
259 else
260 qfga.ga_len = 0;
261}
262
263/*
Bram Moolenaar6be8c8e2016-04-30 13:17:09 +0200264 * Maximum number of bytes allowed per line while reading a errorfile.
265 */
266#define LINE_MAXLEN 4096
267
haya14busae023d492022-02-08 18:09:29 +0000268/*
269 * Patterns used. Keep in sync with qf_parse_fmt[].
270 */
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200271static struct fmtpattern
272{
273 char_u convchar;
274 char *pattern;
275} fmt_pat[FMT_PATTERNS] =
Bram Moolenaar18cebf42018-05-08 22:31:37 +0200276 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200277 {'f', ".\\+"}, // only used when at end
Yegappan Lakshmananb7318002023-10-25 20:50:28 +0200278 {'b', "\\d\\+"}, // 1
279 {'n', "\\d\\+"}, // 2
280 {'l', "\\d\\+"}, // 3
281 {'e', "\\d\\+"}, // 4
282 {'c', "\\d\\+"}, // 5
283 {'k', "\\d\\+"}, // 6
284 {'t', "."}, // 7
285#define FMT_PATTERN_M 8
286 {'m', ".\\+"}, // 8
287#define FMT_PATTERN_R 9
288 {'r', ".*"}, // 9
289 {'p', "[- .]*"}, // 10
290 {'v', "\\d\\+"}, // 11
291 {'s', ".\\+"}, // 12
292 {'o', ".\\+"} // 13
Bram Moolenaar18cebf42018-05-08 22:31:37 +0200293 };
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200294
295/*
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200296 * Convert an errorformat pattern to a regular expression pattern.
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200297 * See fmt_pat definition above for the list of supported patterns. The
298 * pattern specifier is supplied in "efmpat". The converted pattern is stored
299 * in "regpat". Returns a pointer to the location after the pattern.
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200300 */
301 static char_u *
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200302efmpat_to_regpat(
303 char_u *efmpat,
304 char_u *regpat,
305 efm_T *efminfo,
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200306 int idx,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100307 int round)
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200308{
309 char_u *srcptr;
310
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200311 if (efminfo->addr[idx])
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200312 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200313 // Each errorformat pattern can occur only once
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000314 semsg(_(e_too_many_chr_in_format_string), *efmpat);
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200315 return NULL;
316 }
haya14busae023d492022-02-08 18:09:29 +0000317 if ((idx && idx < FMT_PATTERN_R
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200318 && vim_strchr((char_u *)"DXOPQ", efminfo->prefix) != NULL)
haya14busae023d492022-02-08 18:09:29 +0000319 || (idx == FMT_PATTERN_R
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200320 && vim_strchr((char_u *)"OPQ", efminfo->prefix) == NULL))
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200321 {
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000322 semsg(_(e_unexpected_chr_in_format_str), *efmpat);
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200323 return NULL;
324 }
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200325 efminfo->addr[idx] = (char_u)++round;
326 *regpat++ = '\\';
327 *regpat++ = '(';
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200328#ifdef BACKSLASH_IN_FILENAME
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200329 if (*efmpat == 'f')
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200330 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200331 // Also match "c:" in the file name, even when
332 // checking for a colon next: "%f:".
333 // "\%(\a:\)\="
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200334 STRCPY(regpat, "\\%(\\a:\\)\\=");
335 regpat += 10;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200336 }
337#endif
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200338 if (*efmpat == 'f' && efmpat[1] != NUL)
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200339 {
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200340 if (efmpat[1] != '\\' && efmpat[1] != '%')
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200341 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200342 // A file name may contain spaces, but this isn't
343 // in "\f". For "%f:%l:%m" there may be a ":" in
344 // the file name. Use ".\{-1,}x" instead (x is
345 // the next character), the requirement that :999:
346 // follows should work.
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200347 STRCPY(regpat, ".\\{-1,}");
348 regpat += 7;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200349 }
350 else
351 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200352 // File name followed by '\\' or '%': include as
353 // many file name chars as possible.
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200354 STRCPY(regpat, "\\f\\+");
355 regpat += 4;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200356 }
357 }
358 else
359 {
360 srcptr = (char_u *)fmt_pat[idx].pattern;
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200361 while ((*regpat = *srcptr++) != NUL)
362 ++regpat;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200363 }
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200364 *regpat++ = '\\';
365 *regpat++ = ')';
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200366
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200367 return regpat;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200368}
369
370/*
371 * Convert a scanf like format in 'errorformat' to a regular expression.
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200372 * Returns a pointer to the location after the pattern.
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200373 */
374 static char_u *
375scanf_fmt_to_regpat(
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200376 char_u **pefmp,
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200377 char_u *efm,
378 int len,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100379 char_u *regpat)
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200380{
381 char_u *efmp = *pefmp;
382
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200383 if (*efmp == '[' || *efmp == '\\')
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200384 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200385 if ((*regpat++ = *efmp) == '[') // %*[^a-z0-9] etc.
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200386 {
387 if (efmp[1] == '^')
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200388 *regpat++ = *++efmp;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200389 if (efmp < efm + len)
390 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200391 *regpat++ = *++efmp; // could be ']'
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200392 while (efmp < efm + len
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200393 && (*regpat++ = *++efmp) != ']')
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200394 // skip ;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200395 if (efmp == efm + len)
396 {
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000397 emsg(_(e_missing_rsb_in_format_string));
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200398 return NULL;
399 }
400 }
401 }
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200402 else if (efmp < efm + len) // %*\D, %*\s etc.
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200403 *regpat++ = *++efmp;
404 *regpat++ = '\\';
405 *regpat++ = '+';
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200406 }
407 else
408 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200409 // TODO: scanf()-like: %*ud, %*3c, %*f, ... ?
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000410 semsg(_(e_unsupported_chr_in_format_string), *efmp);
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200411 return NULL;
412 }
413
414 *pefmp = efmp;
415
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200416 return regpat;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200417}
418
419/*
420 * Analyze/parse an errorformat prefix.
421 */
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200422 static char_u *
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100423efm_analyze_prefix(char_u *efmp, efm_T *efminfo)
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200424{
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200425 if (vim_strchr((char_u *)"+-", *efmp) != NULL)
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200426 efminfo->flags = *efmp++;
Bram Moolenaare9283662020-06-07 14:10:47 +0200427 if (vim_strchr((char_u *)"DXAEWINCZGOPQ", *efmp) != NULL)
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200428 efminfo->prefix = *efmp;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200429 else
430 {
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000431 semsg(_(e_invalid_chr_in_format_string_prefix), *efmp);
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200432 return NULL;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200433 }
434
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200435 return efmp;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200436}
437
438/*
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200439 * Converts a 'errorformat' string part in 'efm' to a regular expression
440 * pattern. The resulting regex pattern is returned in "regpat". Additional
441 * information about the 'erroformat' pattern is returned in "fmt_ptr".
442 * Returns OK or FAIL.
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200443 */
444 static int
445efm_to_regpat(
Bram Moolenaaref6b8de2017-09-14 13:57:37 +0200446 char_u *efm,
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200447 int len,
Bram Moolenaaref6b8de2017-09-14 13:57:37 +0200448 efm_T *fmt_ptr,
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100449 char_u *regpat)
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200450{
451 char_u *ptr;
452 char_u *efmp;
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200453 int round;
454 int idx = 0;
455
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200456 // Build a regexp pattern for a 'errorformat' option part
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200457 ptr = regpat;
458 *ptr++ = '^';
459 round = 0;
460 for (efmp = efm; efmp < efm + len; ++efmp)
461 {
462 if (*efmp == '%')
463 {
464 ++efmp;
465 for (idx = 0; idx < FMT_PATTERNS; ++idx)
466 if (fmt_pat[idx].convchar == *efmp)
467 break;
468 if (idx < FMT_PATTERNS)
469 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100470 ptr = efmpat_to_regpat(efmp, ptr, fmt_ptr, idx, round);
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200471 if (ptr == NULL)
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200472 return FAIL;
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200473 round++;
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200474 }
475 else if (*efmp == '*')
476 {
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200477 ++efmp;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100478 ptr = scanf_fmt_to_regpat(&efmp, efm, len, ptr);
Bram Moolenaar6bff7192018-05-20 15:41:17 +0200479 if (ptr == NULL)
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200480 return FAIL;
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200481 }
482 else if (vim_strchr((char_u *)"%\\.^$~[", *efmp) != NULL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200483 *ptr++ = *efmp; // regexp magic characters
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200484 else if (*efmp == '#')
485 *ptr++ = '*';
486 else if (*efmp == '>')
487 fmt_ptr->conthere = TRUE;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200488 else if (efmp == efm + 1) // analyse prefix
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200489 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200490 // prefix is allowed only at the beginning of the errorformat
491 // option part
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100492 efmp = efm_analyze_prefix(efmp, fmt_ptr);
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200493 if (efmp == NULL)
494 return FAIL;
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200495 }
496 else
497 {
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000498 semsg(_(e_invalid_chr_in_format_string), *efmp);
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200499 return FAIL;
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200500 }
501 }
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200502 else // copy normal character
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200503 {
504 if (*efmp == '\\' && efmp + 1 < efm + len)
505 ++efmp;
506 else if (vim_strchr((char_u *)".*^$~[", *efmp) != NULL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200507 *ptr++ = '\\'; // escape regexp atoms
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200508 if (*efmp)
509 *ptr++ = *efmp;
510 }
511 }
512 *ptr++ = '$';
513 *ptr = NUL;
514
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200515 return OK;
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200516}
517
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200518/*
519 * Free the 'errorformat' information list
520 */
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200521 static void
522free_efm_list(efm_T **efm_first)
523{
524 efm_T *efm_ptr;
525
526 for (efm_ptr = *efm_first; efm_ptr != NULL; efm_ptr = *efm_first)
527 {
528 *efm_first = efm_ptr->next;
529 vim_regfree(efm_ptr->prog);
530 vim_free(efm_ptr);
531 }
Bram Moolenaar63bed3d2016-11-12 15:36:54 +0100532 fmt_start = NULL;
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200533}
534
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200535/*
536 * Compute the size of the buffer used to convert a 'errorformat' pattern into
537 * a regular expression pattern.
538 */
539 static int
540efm_regpat_bufsz(char_u *efm)
541{
542 int sz;
543 int i;
544
545 sz = (FMT_PATTERNS * 3) + ((int)STRLEN(efm) << 2);
546 for (i = FMT_PATTERNS; i > 0; )
547 sz += (int)STRLEN(fmt_pat[--i].pattern);
548#ifdef BACKSLASH_IN_FILENAME
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200549 sz += 12; // "%f" can become twelve chars longer (see efm_to_regpat)
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200550#else
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200551 sz += 2; // "%f" can become two chars longer
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200552#endif
553
554 return sz;
555}
556
557/*
558 * Return the length of a 'errorformat' option part (separated by ",").
559 */
560 static int
561efm_option_part_len(char_u *efm)
562{
563 int len;
564
565 for (len = 0; efm[len] != NUL && efm[len] != ','; ++len)
566 if (efm[len] == '\\' && efm[len + 1] != NUL)
567 ++len;
568
569 return len;
570}
571
572/*
573 * Parse the 'errorformat' option. Multiple parts in the 'errorformat' option
574 * are parsed and converted to regular expressions. Returns information about
575 * the parsed 'errorformat' option.
576 */
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200577 static efm_T *
578parse_efm_option(char_u *efm)
579{
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200580 efm_T *fmt_ptr = NULL;
581 efm_T *fmt_first = NULL;
582 efm_T *fmt_last = NULL;
583 char_u *fmtstr = NULL;
584 int len;
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200585 int sz;
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200586
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200587 // Each part of the format string is copied and modified from errorformat
588 // to regex prog. Only a few % characters are allowed.
Bram Moolenaare87e6dd2016-07-17 19:25:04 +0200589
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200590 // Get some space to modify the format string into.
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200591 sz = efm_regpat_bufsz(efm);
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +0000592 if ((fmtstr = alloc_id(sz, aid_qf_efm_fmtstr)) == NULL)
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200593 goto parse_efm_error;
594
595 while (efm[0] != NUL)
596 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200597 // Allocate a new eformat structure and put it at the end of the list
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +0000598 fmt_ptr = ALLOC_CLEAR_ONE_ID(efm_T, aid_qf_efm_fmtpart);
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200599 if (fmt_ptr == NULL)
600 goto parse_efm_error;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200601 if (fmt_first == NULL) // first one
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200602 fmt_first = fmt_ptr;
603 else
604 fmt_last->next = fmt_ptr;
605 fmt_last = fmt_ptr;
606
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200607 // Isolate one part in the 'errorformat' option
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200608 len = efm_option_part_len(efm);
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200609
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100610 if (efm_to_regpat(efm, len, fmt_ptr, fmtstr) == FAIL)
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200611 goto parse_efm_error;
612 if ((fmt_ptr->prog = vim_regcomp(fmtstr, RE_MAGIC + RE_STRING)) == NULL)
613 goto parse_efm_error;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200614 // Advance to next part
615 efm = skip_to_option_part(efm + len); // skip comma and spaces
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200616 }
617
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200618 if (fmt_first == NULL) // nothing found
Bram Moolenaarac78dd42022-01-02 19:25:26 +0000619 emsg(_(e_errorformat_contains_no_pattern));
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200620
621 goto parse_efm_end;
622
623parse_efm_error:
624 free_efm_list(&fmt_first);
625
626parse_efm_end:
627 vim_free(fmtstr);
Bram Moolenaar688e3d12016-06-26 22:05:54 +0200628
629 return fmt_first;
630}
631
Bram Moolenaare0d37972016-07-15 22:36:01 +0200632enum {
633 QF_FAIL = 0,
634 QF_OK = 1,
635 QF_END_OF_INPUT = 2,
Bram Moolenaare87e6dd2016-07-17 19:25:04 +0200636 QF_NOMEM = 3,
Bram Moolenaar18cebf42018-05-08 22:31:37 +0200637 QF_IGNORE_LINE = 4,
638 QF_MULTISCAN = 5,
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +0100639 QF_ABORT = 6
Bram Moolenaare0d37972016-07-15 22:36:01 +0200640};
641
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200642/*
643 * State information used to parse lines and add entries to a quickfix/location
644 * list.
645 */
Bram Moolenaare0d37972016-07-15 22:36:01 +0200646typedef struct {
647 char_u *linebuf;
648 int linelen;
649 char_u *growbuf;
650 int growbufsiz;
651 FILE *fd;
652 typval_T *tv;
653 char_u *p_str;
654 listitem_T *p_li;
655 buf_T *buf;
656 linenr_T buflnum;
657 linenr_T lnumlast;
Bram Moolenaar2c7292d2017-03-05 17:43:31 +0100658 vimconv_T vc;
Bram Moolenaare0d37972016-07-15 22:36:01 +0200659} qfstate_T;
660
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200661/*
662 * Allocate more memory for the line buffer used for parsing lines.
663 */
Bram Moolenaare0d37972016-07-15 22:36:01 +0200664 static char_u *
665qf_grow_linebuf(qfstate_T *state, int newsz)
666{
Bram Moolenaar18cebf42018-05-08 22:31:37 +0200667 char_u *p;
668
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200669 // If the line exceeds LINE_MAXLEN exclude the last
670 // byte since it's not a NL character.
Bram Moolenaare0d37972016-07-15 22:36:01 +0200671 state->linelen = newsz > LINE_MAXLEN ? LINE_MAXLEN - 1 : newsz;
672 if (state->growbuf == NULL)
673 {
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +0000674 state->growbuf = alloc_id(state->linelen + 1, aid_qf_linebuf);
Bram Moolenaare0d37972016-07-15 22:36:01 +0200675 if (state->growbuf == NULL)
676 return NULL;
677 state->growbufsiz = state->linelen;
678 }
679 else if (state->linelen > state->growbufsiz)
680 {
Bram Moolenaar18cebf42018-05-08 22:31:37 +0200681 if ((p = vim_realloc(state->growbuf, state->linelen + 1)) == NULL)
Bram Moolenaare0d37972016-07-15 22:36:01 +0200682 return NULL;
Bram Moolenaar18cebf42018-05-08 22:31:37 +0200683 state->growbuf = p;
Bram Moolenaare0d37972016-07-15 22:36:01 +0200684 state->growbufsiz = state->linelen;
685 }
686 return state->growbuf;
687}
688
689/*
690 * Get the next string (separated by newline) from state->p_str.
691 */
692 static int
693qf_get_next_str_line(qfstate_T *state)
694{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200695 // Get the next line from the supplied string
Bram Moolenaare0d37972016-07-15 22:36:01 +0200696 char_u *p_str = state->p_str;
697 char_u *p;
698 int len;
699
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200700 if (*p_str == NUL) // Reached the end of the string
Bram Moolenaare0d37972016-07-15 22:36:01 +0200701 return QF_END_OF_INPUT;
702
703 p = vim_strchr(p_str, '\n');
704 if (p != NULL)
705 len = (int)(p - p_str) + 1;
706 else
707 len = (int)STRLEN(p_str);
708
709 if (len > IOSIZE - 2)
710 {
711 state->linebuf = qf_grow_linebuf(state, len);
712 if (state->linebuf == NULL)
713 return QF_NOMEM;
714 }
715 else
716 {
717 state->linebuf = IObuff;
718 state->linelen = len;
719 }
720 vim_strncpy(state->linebuf, p_str, state->linelen);
721
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200722 // Increment using len in order to discard the rest of the
723 // line if it exceeds LINE_MAXLEN.
Bram Moolenaare0d37972016-07-15 22:36:01 +0200724 p_str += len;
725 state->p_str = p_str;
726
727 return QF_OK;
728}
729
730/*
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +0000731 * Get the next string from the List item state->p_li.
Bram Moolenaare0d37972016-07-15 22:36:01 +0200732 */
733 static int
734qf_get_next_list_line(qfstate_T *state)
735{
736 listitem_T *p_li = state->p_li;
737 int len;
738
739 while (p_li != NULL
740 && (p_li->li_tv.v_type != VAR_STRING
741 || p_li->li_tv.vval.v_string == NULL))
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200742 p_li = p_li->li_next; // Skip non-string items
Bram Moolenaare0d37972016-07-15 22:36:01 +0200743
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200744 if (p_li == NULL) // End of the list
Bram Moolenaare0d37972016-07-15 22:36:01 +0200745 {
746 state->p_li = NULL;
747 return QF_END_OF_INPUT;
748 }
749
750 len = (int)STRLEN(p_li->li_tv.vval.v_string);
751 if (len > IOSIZE - 2)
752 {
753 state->linebuf = qf_grow_linebuf(state, len);
754 if (state->linebuf == NULL)
755 return QF_NOMEM;
756 }
757 else
758 {
759 state->linebuf = IObuff;
760 state->linelen = len;
761 }
762
763 vim_strncpy(state->linebuf, p_li->li_tv.vval.v_string, state->linelen);
764
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200765 state->p_li = p_li->li_next; // next item
Bram Moolenaare0d37972016-07-15 22:36:01 +0200766 return QF_OK;
767}
768
769/*
770 * Get the next string from state->buf.
771 */
772 static int
773qf_get_next_buf_line(qfstate_T *state)
774{
775 char_u *p_buf = NULL;
776 int len;
777
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200778 // Get the next line from the supplied buffer
Bram Moolenaare0d37972016-07-15 22:36:01 +0200779 if (state->buflnum > state->lnumlast)
780 return QF_END_OF_INPUT;
781
782 p_buf = ml_get_buf(state->buf, state->buflnum, FALSE);
783 state->buflnum += 1;
784
785 len = (int)STRLEN(p_buf);
786 if (len > IOSIZE - 2)
787 {
788 state->linebuf = qf_grow_linebuf(state, len);
789 if (state->linebuf == NULL)
790 return QF_NOMEM;
791 }
792 else
793 {
794 state->linebuf = IObuff;
795 state->linelen = len;
796 }
797 vim_strncpy(state->linebuf, p_buf, state->linelen);
798
799 return QF_OK;
800}
801
802/*
803 * Get the next string from file state->fd.
804 */
805 static int
806qf_get_next_file_line(qfstate_T *state)
807{
808 int discard;
809 int growbuflen;
810
811 if (fgets((char *)IObuff, IOSIZE, state->fd) == NULL)
812 return QF_END_OF_INPUT;
813
814 discard = FALSE;
815 state->linelen = (int)STRLEN(IObuff);
Bram Moolenaar796aa9c2016-08-02 21:41:28 +0200816 if (state->linelen == IOSIZE - 1 && !(IObuff[state->linelen - 1] == '\n'))
Bram Moolenaare0d37972016-07-15 22:36:01 +0200817 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200818 // The current line exceeds IObuff, continue reading using
819 // growbuf until EOL or LINE_MAXLEN bytes is read.
Bram Moolenaare0d37972016-07-15 22:36:01 +0200820 if (state->growbuf == NULL)
821 {
822 state->growbufsiz = 2 * (IOSIZE - 1);
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +0000823 state->growbuf = alloc_id(state->growbufsiz, aid_qf_linebuf);
Bram Moolenaare0d37972016-07-15 22:36:01 +0200824 if (state->growbuf == NULL)
825 return QF_NOMEM;
826 }
827
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200828 // Copy the read part of the line, excluding null-terminator
Bram Moolenaare0d37972016-07-15 22:36:01 +0200829 memcpy(state->growbuf, IObuff, IOSIZE - 1);
830 growbuflen = state->linelen;
831
832 for (;;)
833 {
Bram Moolenaar18cebf42018-05-08 22:31:37 +0200834 char_u *p;
835
Bram Moolenaare0d37972016-07-15 22:36:01 +0200836 if (fgets((char *)state->growbuf + growbuflen,
837 state->growbufsiz - growbuflen, state->fd) == NULL)
838 break;
839 state->linelen = (int)STRLEN(state->growbuf + growbuflen);
840 growbuflen += state->linelen;
Bram Moolenaar796aa9c2016-08-02 21:41:28 +0200841 if ((state->growbuf)[growbuflen - 1] == '\n')
Bram Moolenaare0d37972016-07-15 22:36:01 +0200842 break;
843 if (state->growbufsiz == LINE_MAXLEN)
844 {
845 discard = TRUE;
846 break;
847 }
848
849 state->growbufsiz = 2 * state->growbufsiz < LINE_MAXLEN
850 ? 2 * state->growbufsiz : LINE_MAXLEN;
Bram Moolenaar18cebf42018-05-08 22:31:37 +0200851 if ((p = vim_realloc(state->growbuf, state->growbufsiz)) == NULL)
Bram Moolenaare0d37972016-07-15 22:36:01 +0200852 return QF_NOMEM;
Bram Moolenaar18cebf42018-05-08 22:31:37 +0200853 state->growbuf = p;
Bram Moolenaare0d37972016-07-15 22:36:01 +0200854 }
855
856 while (discard)
857 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200858 // The current line is longer than LINE_MAXLEN, continue
859 // reading but discard everything until EOL or EOF is
860 // reached.
Bram Moolenaare0d37972016-07-15 22:36:01 +0200861 if (fgets((char *)IObuff, IOSIZE, state->fd) == NULL
862 || (int)STRLEN(IObuff) < IOSIZE - 1
Bram Moolenaar59941cb2020-09-05 17:03:40 +0200863 || IObuff[IOSIZE - 2] == '\n')
Bram Moolenaare0d37972016-07-15 22:36:01 +0200864 break;
865 }
866
867 state->linebuf = state->growbuf;
868 state->linelen = growbuflen;
869 }
870 else
871 state->linebuf = IObuff;
872
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200873 // Convert a line if it contains a non-ASCII character.
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +0200874 if (state->vc.vc_type != CONV_NONE && has_non_ascii(state->linebuf))
875 {
Bram Moolenaar2c7292d2017-03-05 17:43:31 +0100876 char_u *line;
877
878 line = string_convert(&state->vc, state->linebuf, &state->linelen);
879 if (line != NULL)
880 {
881 if (state->linelen < IOSIZE)
882 {
883 STRCPY(state->linebuf, line);
884 vim_free(line);
885 }
886 else
887 {
888 vim_free(state->growbuf);
889 state->linebuf = state->growbuf = line;
890 state->growbufsiz = state->linelen < LINE_MAXLEN
891 ? state->linelen : LINE_MAXLEN;
892 }
893 }
894 }
Bram Moolenaar2c7292d2017-03-05 17:43:31 +0100895
Bram Moolenaare0d37972016-07-15 22:36:01 +0200896 return QF_OK;
897}
898
899/*
900 * Get the next string from a file/buffer/list/string.
901 */
902 static int
903qf_get_nextline(qfstate_T *state)
904{
905 int status = QF_FAIL;
906
907 if (state->fd == NULL)
908 {
909 if (state->tv != NULL)
910 {
911 if (state->tv->v_type == VAR_STRING)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200912 // Get the next line from the supplied string
Bram Moolenaare0d37972016-07-15 22:36:01 +0200913 status = qf_get_next_str_line(state);
914 else if (state->tv->v_type == VAR_LIST)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200915 // Get the next line from the supplied list
Bram Moolenaare0d37972016-07-15 22:36:01 +0200916 status = qf_get_next_list_line(state);
917 }
918 else
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200919 // Get the next line from the supplied buffer
Bram Moolenaare0d37972016-07-15 22:36:01 +0200920 status = qf_get_next_buf_line(state);
921 }
922 else
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200923 // Get the next line from the supplied file
Bram Moolenaare0d37972016-07-15 22:36:01 +0200924 status = qf_get_next_file_line(state);
925
926 if (status != QF_OK)
927 return status;
928
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200929 // remove newline/CR from the line
Bram Moolenaare0d37972016-07-15 22:36:01 +0200930 if (state->linelen > 0 && state->linebuf[state->linelen - 1] == '\n')
Bram Moolenaar796aa9c2016-08-02 21:41:28 +0200931 {
Bram Moolenaare0d37972016-07-15 22:36:01 +0200932 state->linebuf[state->linelen - 1] = NUL;
933#ifdef USE_CRNL
Bram Moolenaar796aa9c2016-08-02 21:41:28 +0200934 if (state->linelen > 1 && state->linebuf[state->linelen - 2] == '\r')
935 state->linebuf[state->linelen - 2] = NUL;
Bram Moolenaare0d37972016-07-15 22:36:01 +0200936#endif
Bram Moolenaar796aa9c2016-08-02 21:41:28 +0200937 }
Bram Moolenaare0d37972016-07-15 22:36:01 +0200938
Bram Moolenaare0d37972016-07-15 22:36:01 +0200939 remove_bom(state->linebuf);
Bram Moolenaare0d37972016-07-15 22:36:01 +0200940
941 return QF_OK;
942}
943
Bram Moolenaare87e6dd2016-07-17 19:25:04 +0200944typedef struct {
945 char_u *namebuf;
Yegappan Lakshmananb7318002023-10-25 20:50:28 +0200946 int bnr;
Bram Moolenaard76ce852018-05-01 15:02:04 +0200947 char_u *module;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +0200948 char_u *errmsg;
949 int errmsglen;
950 long lnum;
thinca6864efa2021-06-19 20:45:20 +0200951 long end_lnum;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +0200952 int col;
thinca6864efa2021-06-19 20:45:20 +0200953 int end_col;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +0200954 char_u use_viscol;
955 char_u *pattern;
956 int enr;
957 int type;
Tom Praschanca6ac992023-08-11 23:26:12 +0200958 typval_T *user_data;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +0200959 int valid;
960} qffields_T;
961
962/*
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200963 * Parse the match for filename ('%f') pattern in regmatch.
964 * Return the matched value in "fields->namebuf".
965 */
966 static int
967qf_parse_fmt_f(regmatch_T *rmp, int midx, qffields_T *fields, int prefix)
968{
969 int c;
970
971 if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
972 return QF_FAIL;
973
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200974 // Expand ~/file and $HOME/file to full path.
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200975 c = *rmp->endp[midx];
976 *rmp->endp[midx] = NUL;
977 expand_env(rmp->startp[midx], fields->namebuf, CMDBUFFSIZE);
978 *rmp->endp[midx] = c;
979
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +0200980 // For separate filename patterns (%O, %P and %Q), the specified file
981 // should exist.
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200982 if (vim_strchr((char_u *)"OPQ", prefix) != NULL
983 && mch_getperm(fields->namebuf) == -1)
984 return QF_FAIL;
985
986 return QF_OK;
987}
988
989/*
zeertzjqb0221812023-10-26 23:15:44 +0200990 * Parse the match for buffer number ('%b') pattern in regmatch.
991 * Return the matched value in "fields->bnr".
Bram Moolenaarde3b3672018-08-07 21:54:41 +0200992 */
993 static int
Yegappan Lakshmananb7318002023-10-25 20:50:28 +0200994qf_parse_fmt_b(regmatch_T *rmp, int midx, qffields_T *fields)
995{
996 if (rmp->startp[midx] == NULL)
997 return QF_FAIL;
998 int bnr = (int)atol((char *)rmp->startp[midx]);
999 if (buflist_findnr(bnr) == NULL)
1000 return QF_FAIL;
1001 fields->bnr = bnr;
1002 return QF_OK;
1003}
1004
1005/*
1006 * Parse the match for error number ('%n') pattern in regmatch.
1007 * Return the matched value in "fields->enr".
1008 */
1009 static int
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001010qf_parse_fmt_n(regmatch_T *rmp, int midx, qffields_T *fields)
1011{
1012 if (rmp->startp[midx] == NULL)
1013 return QF_FAIL;
1014 fields->enr = (int)atol((char *)rmp->startp[midx]);
1015 return QF_OK;
1016}
1017
1018/*
haya14busae023d492022-02-08 18:09:29 +00001019 * Parse the match for line number ('%l') pattern in regmatch.
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001020 * Return the matched value in "fields->lnum".
1021 */
1022 static int
1023qf_parse_fmt_l(regmatch_T *rmp, int midx, qffields_T *fields)
1024{
1025 if (rmp->startp[midx] == NULL)
1026 return QF_FAIL;
1027 fields->lnum = atol((char *)rmp->startp[midx]);
1028 return QF_OK;
1029}
1030
1031/*
haya14busae023d492022-02-08 18:09:29 +00001032 * Parse the match for end line number ('%e') pattern in regmatch.
1033 * Return the matched value in "fields->end_lnum".
1034 */
1035 static int
1036qf_parse_fmt_e(regmatch_T *rmp, int midx, qffields_T *fields)
1037{
1038 if (rmp->startp[midx] == NULL)
1039 return QF_FAIL;
1040 fields->end_lnum = atol((char *)rmp->startp[midx]);
1041 return QF_OK;
1042}
1043
1044/*
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001045 * Parse the match for column number ('%c') pattern in regmatch.
1046 * Return the matched value in "fields->col".
1047 */
1048 static int
1049qf_parse_fmt_c(regmatch_T *rmp, int midx, qffields_T *fields)
1050{
1051 if (rmp->startp[midx] == NULL)
1052 return QF_FAIL;
1053 fields->col = (int)atol((char *)rmp->startp[midx]);
1054 return QF_OK;
1055}
1056
1057/*
haya14busae023d492022-02-08 18:09:29 +00001058 * Parse the match for end column number ('%k') pattern in regmatch.
1059 * Return the matched value in "fields->end_col".
1060 */
1061 static int
1062qf_parse_fmt_k(regmatch_T *rmp, int midx, qffields_T *fields)
1063{
1064 if (rmp->startp[midx] == NULL)
1065 return QF_FAIL;
1066 fields->end_col = (int)atol((char *)rmp->startp[midx]);
1067 return QF_OK;
1068}
1069
1070/*
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001071 * Parse the match for error type ('%t') pattern in regmatch.
1072 * Return the matched value in "fields->type".
1073 */
1074 static int
1075qf_parse_fmt_t(regmatch_T *rmp, int midx, qffields_T *fields)
1076{
1077 if (rmp->startp[midx] == NULL)
1078 return QF_FAIL;
1079 fields->type = *rmp->startp[midx];
1080 return QF_OK;
1081}
1082
1083/*
Bram Moolenaarf4140482020-02-15 23:06:45 +01001084 * Copy a non-error line into the error string. Return the matched line in
1085 * "fields->errmsg".
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001086 */
1087 static int
Bram Moolenaarf4140482020-02-15 23:06:45 +01001088copy_nonerror_line(char_u *linebuf, int linelen, qffields_T *fields)
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001089{
1090 char_u *p;
1091
1092 if (linelen >= fields->errmsglen)
1093 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001094 // linelen + null terminator
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001095 if ((p = vim_realloc(fields->errmsg, linelen + 1)) == NULL)
1096 return QF_NOMEM;
1097 fields->errmsg = p;
1098 fields->errmsglen = linelen + 1;
1099 }
Bram Moolenaarf4140482020-02-15 23:06:45 +01001100 // copy whole line to error message
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001101 vim_strncpy(fields->errmsg, linebuf, linelen);
Bram Moolenaarf4140482020-02-15 23:06:45 +01001102
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001103 return QF_OK;
1104}
1105
1106/*
1107 * Parse the match for error message ('%m') pattern in regmatch.
1108 * Return the matched value in "fields->errmsg".
1109 */
1110 static int
1111qf_parse_fmt_m(regmatch_T *rmp, int midx, qffields_T *fields)
1112{
1113 char_u *p;
1114 int len;
1115
1116 if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
1117 return QF_FAIL;
1118 len = (int)(rmp->endp[midx] - rmp->startp[midx]);
1119 if (len >= fields->errmsglen)
1120 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001121 // len + null terminator
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001122 if ((p = vim_realloc(fields->errmsg, len + 1)) == NULL)
1123 return QF_NOMEM;
1124 fields->errmsg = p;
1125 fields->errmsglen = len + 1;
1126 }
1127 vim_strncpy(fields->errmsg, rmp->startp[midx], len);
1128 return QF_OK;
1129}
1130
1131/*
1132 * Parse the match for rest of a single-line file message ('%r') pattern.
1133 * Return the matched value in "tail".
1134 */
1135 static int
1136qf_parse_fmt_r(regmatch_T *rmp, int midx, char_u **tail)
1137{
1138 if (rmp->startp[midx] == NULL)
1139 return QF_FAIL;
1140 *tail = rmp->startp[midx];
1141 return QF_OK;
1142}
1143
1144/*
1145 * Parse the match for the pointer line ('%p') pattern in regmatch.
1146 * Return the matched value in "fields->col".
1147 */
1148 static int
1149qf_parse_fmt_p(regmatch_T *rmp, int midx, qffields_T *fields)
1150{
1151 char_u *match_ptr;
1152
1153 if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
1154 return QF_FAIL;
1155 fields->col = 0;
1156 for (match_ptr = rmp->startp[midx]; match_ptr != rmp->endp[midx];
1157 ++match_ptr)
1158 {
1159 ++fields->col;
1160 if (*match_ptr == TAB)
1161 {
1162 fields->col += 7;
1163 fields->col -= fields->col % 8;
1164 }
1165 }
1166 ++fields->col;
1167 fields->use_viscol = TRUE;
1168 return QF_OK;
1169}
1170
1171/*
1172 * Parse the match for the virtual column number ('%v') pattern in regmatch.
1173 * Return the matched value in "fields->col".
1174 */
1175 static int
1176qf_parse_fmt_v(regmatch_T *rmp, int midx, qffields_T *fields)
1177{
1178 if (rmp->startp[midx] == NULL)
1179 return QF_FAIL;
1180 fields->col = (int)atol((char *)rmp->startp[midx]);
1181 fields->use_viscol = TRUE;
1182 return QF_OK;
1183}
1184
1185/*
1186 * Parse the match for the search text ('%s') pattern in regmatch.
1187 * Return the matched value in "fields->pattern".
1188 */
1189 static int
1190qf_parse_fmt_s(regmatch_T *rmp, int midx, qffields_T *fields)
1191{
1192 int len;
1193
1194 if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
1195 return QF_FAIL;
1196 len = (int)(rmp->endp[midx] - rmp->startp[midx]);
1197 if (len > CMDBUFFSIZE - 5)
1198 len = CMDBUFFSIZE - 5;
1199 STRCPY(fields->pattern, "^\\V");
1200 STRNCAT(fields->pattern, rmp->startp[midx], len);
1201 fields->pattern[len + 3] = '\\';
1202 fields->pattern[len + 4] = '$';
1203 fields->pattern[len + 5] = NUL;
1204 return QF_OK;
1205}
1206
1207/*
1208 * Parse the match for the module ('%o') pattern in regmatch.
1209 * Return the matched value in "fields->module".
1210 */
1211 static int
1212qf_parse_fmt_o(regmatch_T *rmp, int midx, qffields_T *fields)
1213{
1214 int len;
1215
1216 if (rmp->startp[midx] == NULL || rmp->endp[midx] == NULL)
1217 return QF_FAIL;
1218 len = (int)(rmp->endp[midx] - rmp->startp[midx]);
1219 if (len > CMDBUFFSIZE)
1220 len = CMDBUFFSIZE;
1221 STRNCAT(fields->module, rmp->startp[midx], len);
1222 return QF_OK;
1223}
1224
1225/*
1226 * 'errorformat' format pattern parser functions.
1227 * The '%f' and '%r' formats are parsed differently from other formats.
1228 * See qf_parse_match() for details.
haya14busae023d492022-02-08 18:09:29 +00001229 * Keep in sync with fmt_pat[].
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001230 */
1231static int (*qf_parse_fmt[FMT_PATTERNS])(regmatch_T *, int, qffields_T *) =
1232{
haya14busae023d492022-02-08 18:09:29 +00001233 NULL, // %f
Yegappan Lakshmananb7318002023-10-25 20:50:28 +02001234 qf_parse_fmt_b,
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001235 qf_parse_fmt_n,
1236 qf_parse_fmt_l,
haya14busae023d492022-02-08 18:09:29 +00001237 qf_parse_fmt_e,
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001238 qf_parse_fmt_c,
haya14busae023d492022-02-08 18:09:29 +00001239 qf_parse_fmt_k,
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001240 qf_parse_fmt_t,
1241 qf_parse_fmt_m,
haya14busae023d492022-02-08 18:09:29 +00001242 NULL, // %r
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001243 qf_parse_fmt_p,
1244 qf_parse_fmt_v,
1245 qf_parse_fmt_s,
1246 qf_parse_fmt_o
1247};
1248
1249/*
1250 * Parse the error format pattern matches in "regmatch" and set the values in
1251 * "fields". fmt_ptr contains the 'efm' format specifiers/prefixes that have a
1252 * match. Returns QF_OK if all the matches are successfully parsed. On
1253 * failure, returns QF_FAIL or QF_NOMEM.
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001254 */
1255 static int
1256qf_parse_match(
1257 char_u *linebuf,
1258 int linelen,
1259 efm_T *fmt_ptr,
1260 regmatch_T *regmatch,
1261 qffields_T *fields,
1262 int qf_multiline,
1263 int qf_multiscan,
1264 char_u **tail)
1265{
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001266 int idx = fmt_ptr->prefix;
1267 int i;
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001268 int midx;
1269 int status;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001270
1271 if ((idx == 'C' || idx == 'Z') && !qf_multiline)
1272 return QF_FAIL;
Bram Moolenaare9283662020-06-07 14:10:47 +02001273 if (vim_strchr((char_u *)"EWIN", idx) != NULL)
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001274 fields->type = idx;
1275 else
1276 fields->type = 0;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001277
1278 // Extract error message data from matched line.
1279 // We check for an actual submatch, because "\[" and "\]" in
1280 // the 'errorformat' may cause the wrong submatch to be used.
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001281 for (i = 0; i < FMT_PATTERNS; i++)
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001282 {
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001283 status = QF_OK;
1284 midx = (int)fmt_ptr->addr[i];
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001285 if (i == 0 && midx > 0) // %f
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001286 status = qf_parse_fmt_f(regmatch, midx, fields, idx);
haya14busae023d492022-02-08 18:09:29 +00001287 else if (i == FMT_PATTERN_M)
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001288 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001289 if (fmt_ptr->flags == '+' && !qf_multiscan) // %+
Bram Moolenaarf4140482020-02-15 23:06:45 +01001290 status = copy_nonerror_line(linebuf, linelen, fields);
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001291 else if (midx > 0) // %m
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001292 status = qf_parse_fmt_m(regmatch, midx, fields);
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001293 }
haya14busae023d492022-02-08 18:09:29 +00001294 else if (i == FMT_PATTERN_R && midx > 0) // %r
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001295 status = qf_parse_fmt_r(regmatch, midx, tail);
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001296 else if (midx > 0) // others
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001297 status = (qf_parse_fmt[i])(regmatch, midx, fields);
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001298
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001299 if (status != QF_OK)
1300 return status;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001301 }
1302
1303 return QF_OK;
1304}
1305
1306/*
1307 * Parse an error line in 'linebuf' using a single error format string in
1308 * 'fmt_ptr->prog' and return the matching values in 'fields'.
1309 * Returns QF_OK if the efm format matches completely and the fields are
1310 * successfully copied. Otherwise returns QF_FAIL or QF_NOMEM.
1311 */
1312 static int
1313qf_parse_get_fields(
1314 char_u *linebuf,
1315 int linelen,
1316 efm_T *fmt_ptr,
1317 qffields_T *fields,
1318 int qf_multiline,
1319 int qf_multiscan,
1320 char_u **tail)
1321{
1322 regmatch_T regmatch;
1323 int status = QF_FAIL;
1324 int r;
1325
1326 if (qf_multiscan &&
1327 vim_strchr((char_u *)"OPQ", fmt_ptr->prefix) == NULL)
1328 return QF_FAIL;
1329
1330 fields->namebuf[0] = NUL;
Yegappan Lakshmananb7318002023-10-25 20:50:28 +02001331 fields->bnr = 0;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001332 fields->module[0] = NUL;
1333 fields->pattern[0] = NUL;
1334 if (!qf_multiscan)
1335 fields->errmsg[0] = NUL;
1336 fields->lnum = 0;
thinca6864efa2021-06-19 20:45:20 +02001337 fields->end_lnum = 0;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001338 fields->col = 0;
thinca6864efa2021-06-19 20:45:20 +02001339 fields->end_col = 0;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001340 fields->use_viscol = FALSE;
1341 fields->enr = -1;
1342 fields->type = 0;
1343 *tail = NULL;
1344
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001345 // Always ignore case when looking for a matching error.
Bram Moolenaar8b62e312018-05-13 15:29:04 +02001346 regmatch.rm_ic = TRUE;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001347 regmatch.regprog = fmt_ptr->prog;
1348 r = vim_regexec(&regmatch, linebuf, (colnr_T)0);
1349 fmt_ptr->prog = regmatch.regprog;
1350 if (r)
1351 status = qf_parse_match(linebuf, linelen, fmt_ptr, &regmatch,
1352 fields, qf_multiline, qf_multiscan, tail);
1353
1354 return status;
1355}
1356
1357/*
1358 * Parse directory error format prefixes (%D and %X).
1359 * Push and pop directories from the directory stack when scanning directory
1360 * names.
1361 */
1362 static int
1363qf_parse_dir_pfx(int idx, qffields_T *fields, qf_list_T *qfl)
1364{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001365 if (idx == 'D') // enter directory
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001366 {
1367 if (*fields->namebuf == NUL)
1368 {
Bram Moolenaarac78dd42022-01-02 19:25:26 +00001369 emsg(_(e_missing_or_empty_directory_name));
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001370 return QF_FAIL;
1371 }
1372 qfl->qf_directory =
1373 qf_push_dir(fields->namebuf, &qfl->qf_dir_stack, FALSE);
1374 if (qfl->qf_directory == NULL)
1375 return QF_FAIL;
1376 }
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001377 else if (idx == 'X') // leave directory
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001378 qfl->qf_directory = qf_pop_dir(&qfl->qf_dir_stack);
1379
1380 return QF_OK;
1381}
1382
1383/*
1384 * Parse global file name error format prefixes (%O, %P and %Q).
1385 */
1386 static int
1387qf_parse_file_pfx(
1388 int idx,
1389 qffields_T *fields,
1390 qf_list_T *qfl,
1391 char_u *tail)
1392{
1393 fields->valid = FALSE;
1394 if (*fields->namebuf == NUL || mch_getperm(fields->namebuf) >= 0)
1395 {
1396 if (*fields->namebuf && idx == 'P')
1397 qfl->qf_currfile =
1398 qf_push_dir(fields->namebuf, &qfl->qf_file_stack, TRUE);
1399 else if (idx == 'Q')
1400 qfl->qf_currfile = qf_pop_dir(&qfl->qf_file_stack);
1401 *fields->namebuf = NUL;
1402 if (tail && *tail)
1403 {
1404 STRMOVE(IObuff, skipwhite(tail));
1405 qfl->qf_multiscan = TRUE;
1406 return QF_MULTISCAN;
1407 }
1408 }
1409
1410 return QF_OK;
1411}
1412
1413/*
1414 * Parse a non-error line (a line which doesn't match any of the error
1415 * format in 'efm').
1416 */
1417 static int
1418qf_parse_line_nomatch(char_u *linebuf, int linelen, qffields_T *fields)
1419{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001420 fields->namebuf[0] = NUL; // no match found, remove file name
1421 fields->lnum = 0; // don't jump to this line
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001422 fields->valid = FALSE;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001423
Bram Moolenaarf4140482020-02-15 23:06:45 +01001424 return copy_nonerror_line(linebuf, linelen, fields);
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001425}
1426
1427/*
1428 * Parse multi-line error format prefixes (%C and %Z)
1429 */
1430 static int
1431qf_parse_multiline_pfx(
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001432 int idx,
1433 qf_list_T *qfl,
1434 qffields_T *fields)
1435{
1436 char_u *ptr;
1437 int len;
1438
1439 if (!qfl->qf_multiignore)
1440 {
1441 qfline_T *qfprev = qfl->qf_last;
1442
1443 if (qfprev == NULL)
1444 return QF_FAIL;
1445 if (*fields->errmsg && !qfl->qf_multiignore)
1446 {
1447 len = (int)STRLEN(qfprev->qf_text);
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +00001448 ptr = alloc_id(len + STRLEN(fields->errmsg) + 2,
1449 aid_qf_multiline_pfx);
1450 if (ptr == NULL)
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001451 return QF_FAIL;
1452 STRCPY(ptr, qfprev->qf_text);
1453 vim_free(qfprev->qf_text);
1454 qfprev->qf_text = ptr;
1455 *(ptr += len) = '\n';
1456 STRCPY(++ptr, fields->errmsg);
1457 }
1458 if (qfprev->qf_nr == -1)
1459 qfprev->qf_nr = fields->enr;
1460 if (vim_isprintc(fields->type) && !qfprev->qf_type)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001461 // only printable chars allowed
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001462 qfprev->qf_type = fields->type;
1463
1464 if (!qfprev->qf_lnum)
1465 qfprev->qf_lnum = fields->lnum;
haya14busae023d492022-02-08 18:09:29 +00001466 if (!qfprev->qf_end_lnum)
1467 qfprev->qf_end_lnum = fields->end_lnum;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001468 if (!qfprev->qf_col)
Bram Moolenaarc95940c2020-10-20 14:59:12 +02001469 {
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001470 qfprev->qf_col = fields->col;
Bram Moolenaarc95940c2020-10-20 14:59:12 +02001471 qfprev->qf_viscol = fields->use_viscol;
1472 }
haya14busae023d492022-02-08 18:09:29 +00001473 if (!qfprev->qf_end_col)
1474 qfprev->qf_end_col = fields->end_col;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001475 if (!qfprev->qf_fnum)
Bram Moolenaar0398e002019-03-21 21:12:49 +01001476 qfprev->qf_fnum = qf_get_fnum(qfl,
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001477 qfl->qf_directory,
1478 *fields->namebuf || qfl->qf_directory != NULL
1479 ? fields->namebuf
1480 : qfl->qf_currfile != NULL && fields->valid
1481 ? qfl->qf_currfile : 0);
1482 }
1483 if (idx == 'Z')
1484 qfl->qf_multiline = qfl->qf_multiignore = FALSE;
1485 line_breakcheck();
1486
1487 return QF_IGNORE_LINE;
1488}
1489
1490/*
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001491 * Parse a line and get the quickfix fields.
1492 * Return the QF_ status.
1493 */
1494 static int
1495qf_parse_line(
Bram Moolenaar0398e002019-03-21 21:12:49 +01001496 qf_list_T *qfl,
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001497 char_u *linebuf,
1498 int linelen,
1499 efm_T *fmt_first,
1500 qffields_T *fields)
1501{
1502 efm_T *fmt_ptr;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001503 int idx = 0;
1504 char_u *tail = NULL;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001505 int status;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001506
Bram Moolenaare333e792018-04-08 13:27:39 +02001507restofline:
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001508 // If there was no %> item start at the first pattern
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001509 if (fmt_start == NULL)
1510 fmt_ptr = fmt_first;
1511 else
1512 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001513 // Otherwise start from the last used pattern
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001514 fmt_ptr = fmt_start;
1515 fmt_start = NULL;
1516 }
1517
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001518 // Try to match each part of 'errorformat' until we find a complete
1519 // match or no match.
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001520 fields->valid = TRUE;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001521 for ( ; fmt_ptr != NULL; fmt_ptr = fmt_ptr->next)
1522 {
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001523 idx = fmt_ptr->prefix;
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001524 status = qf_parse_get_fields(linebuf, linelen, fmt_ptr, fields,
1525 qfl->qf_multiline, qfl->qf_multiscan, &tail);
1526 if (status == QF_NOMEM)
1527 return status;
1528 if (status == QF_OK)
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001529 break;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001530 }
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001531 qfl->qf_multiscan = FALSE;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001532
1533 if (fmt_ptr == NULL || idx == 'D' || idx == 'X')
1534 {
1535 if (fmt_ptr != NULL)
1536 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001537 // 'D' and 'X' directory specifiers
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001538 status = qf_parse_dir_pfx(idx, fields, qfl);
1539 if (status != QF_OK)
1540 return status;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001541 }
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001542
1543 status = qf_parse_line_nomatch(linebuf, linelen, fields);
1544 if (status != QF_OK)
1545 return status;
1546
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001547 if (fmt_ptr == NULL)
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001548 qfl->qf_multiline = qfl->qf_multiignore = FALSE;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001549 }
1550 else if (fmt_ptr != NULL)
1551 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001552 // honor %> item
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001553 if (fmt_ptr->conthere)
1554 fmt_start = fmt_ptr;
1555
Bram Moolenaare9283662020-06-07 14:10:47 +02001556 if (vim_strchr((char_u *)"AEWIN", idx) != NULL)
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001557 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001558 qfl->qf_multiline = TRUE; // start of a multi-line message
1559 qfl->qf_multiignore = FALSE;// reset continuation
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001560 }
1561 else if (vim_strchr((char_u *)"CZ", idx) != NULL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001562 { // continuation of multi-line msg
Bram Moolenaar0398e002019-03-21 21:12:49 +01001563 status = qf_parse_multiline_pfx(idx, qfl, fields);
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001564 if (status != QF_OK)
1565 return status;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001566 }
1567 else if (vim_strchr((char_u *)"OPQ", idx) != NULL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001568 { // global file names
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001569 status = qf_parse_file_pfx(idx, fields, qfl, tail);
1570 if (status == QF_MULTISCAN)
1571 goto restofline;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001572 }
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001573 if (fmt_ptr->flags == '-') // generally exclude this line
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001574 {
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001575 if (qfl->qf_multiline)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001576 // also exclude continuation lines
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001577 qfl->qf_multiignore = TRUE;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001578 return QF_IGNORE_LINE;
1579 }
1580 }
1581
1582 return QF_OK;
1583}
1584
Bram Moolenaar6be8c8e2016-04-30 13:17:09 +02001585/*
Bram Moolenaar019dfe62018-10-07 14:38:49 +02001586 * Returns TRUE if the specified quickfix/location stack is empty
1587 */
1588 static int
1589qf_stack_empty(qf_info_T *qi)
1590{
1591 return qi == NULL || qi->qf_listcount <= 0;
1592}
1593
1594/*
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001595 * Returns TRUE if the specified quickfix/location list is empty.
1596 */
1597 static int
Bram Moolenaar0398e002019-03-21 21:12:49 +01001598qf_list_empty(qf_list_T *qfl)
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001599{
Bram Moolenaar0398e002019-03-21 21:12:49 +01001600 return qfl == NULL || qfl->qf_count <= 0;
1601}
1602
1603/*
Bram Moolenaar3ff33112019-05-03 21:56:35 +02001604 * Returns TRUE if the specified quickfix/location list is not empty and
1605 * has valid entries.
1606 */
1607 static int
1608qf_list_has_valid_entries(qf_list_T *qfl)
1609{
1610 return !qf_list_empty(qfl) && !qfl->qf_nonevalid;
1611}
1612
1613/*
Bram Moolenaar0398e002019-03-21 21:12:49 +01001614 * Return a pointer to a list in the specified quickfix stack
1615 */
1616 static qf_list_T *
1617qf_get_list(qf_info_T *qi, int idx)
1618{
1619 return &qi->qf_lists[idx];
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001620}
1621
Bram Moolenaarde3b3672018-08-07 21:54:41 +02001622/*
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001623 * Allocate the fields used for parsing lines and populating a quickfix list.
1624 */
1625 static int
1626qf_alloc_fields(qffields_T *pfields)
1627{
1628 pfields->namebuf = alloc_id(CMDBUFFSIZE + 1, aid_qf_namebuf);
1629 pfields->module = alloc_id(CMDBUFFSIZE + 1, aid_qf_module);
1630 pfields->errmsglen = CMDBUFFSIZE + 1;
1631 pfields->errmsg = alloc_id(pfields->errmsglen, aid_qf_errmsg);
1632 pfields->pattern = alloc_id(CMDBUFFSIZE + 1, aid_qf_pattern);
1633 if (pfields->namebuf == NULL || pfields->errmsg == NULL
1634 || pfields->pattern == NULL || pfields->module == NULL)
1635 return FAIL;
1636
1637 return OK;
1638}
1639
1640/*
1641 * Free the fields used for parsing lines and populating a quickfix list.
1642 */
1643 static void
1644qf_free_fields(qffields_T *pfields)
1645{
1646 vim_free(pfields->namebuf);
1647 vim_free(pfields->module);
1648 vim_free(pfields->errmsg);
1649 vim_free(pfields->pattern);
1650}
1651
1652/*
1653 * Setup the state information used for parsing lines and populating a
1654 * quickfix list.
1655 */
1656 static int
1657qf_setup_state(
1658 qfstate_T *pstate,
1659 char_u *enc,
1660 char_u *efile,
1661 typval_T *tv,
1662 buf_T *buf,
1663 linenr_T lnumfirst,
1664 linenr_T lnumlast)
1665{
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001666 pstate->vc.vc_type = CONV_NONE;
1667 if (enc != NULL && *enc != NUL)
1668 convert_setup(&pstate->vc, enc, p_enc);
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001669
1670 if (efile != NULL && (pstate->fd = mch_fopen((char *)efile, "r")) == NULL)
1671 {
Bram Moolenaare29a27f2021-07-20 21:07:36 +02001672 semsg(_(e_cant_open_errorfile_str), efile);
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001673 return FAIL;
1674 }
1675
1676 if (tv != NULL)
1677 {
1678 if (tv->v_type == VAR_STRING)
1679 pstate->p_str = tv->vval.v_string;
1680 else if (tv->v_type == VAR_LIST)
1681 pstate->p_li = tv->vval.v_list->lv_first;
1682 pstate->tv = tv;
1683 }
1684 pstate->buf = buf;
1685 pstate->buflnum = lnumfirst;
1686 pstate->lnumlast = lnumlast;
1687
1688 return OK;
1689}
1690
1691/*
1692 * Cleanup the state information used for parsing lines and populating a
1693 * quickfix list.
1694 */
1695 static void
1696qf_cleanup_state(qfstate_T *pstate)
1697{
1698 if (pstate->fd != NULL)
1699 fclose(pstate->fd);
1700
1701 vim_free(pstate->growbuf);
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001702 if (pstate->vc.vc_type != CONV_NONE)
1703 convert_setup(&pstate->vc, NULL, NULL);
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001704}
1705
1706/*
Bram Moolenaar95946f12019-03-31 15:31:59 +02001707 * Process the next line from a file/buffer/list/string and add it
1708 * to the quickfix list 'qfl'.
1709 */
1710 static int
1711qf_init_process_nextline(
1712 qf_list_T *qfl,
1713 efm_T *fmt_first,
1714 qfstate_T *state,
1715 qffields_T *fields)
1716{
1717 int status;
1718
1719 // Get the next line from a file/buffer/list/string
1720 status = qf_get_nextline(state);
1721 if (status != QF_OK)
1722 return status;
1723
1724 status = qf_parse_line(qfl, state->linebuf, state->linelen,
1725 fmt_first, fields);
1726 if (status != QF_OK)
1727 return status;
1728
1729 return qf_add_entry(qfl,
1730 qfl->qf_directory,
1731 (*fields->namebuf || qfl->qf_directory != NULL)
1732 ? fields->namebuf
1733 : ((qfl->qf_currfile != NULL && fields->valid)
1734 ? qfl->qf_currfile : (char_u *)NULL),
1735 fields->module,
Yegappan Lakshmananb7318002023-10-25 20:50:28 +02001736 fields->bnr,
Bram Moolenaar95946f12019-03-31 15:31:59 +02001737 fields->errmsg,
1738 fields->lnum,
thinca6864efa2021-06-19 20:45:20 +02001739 fields->end_lnum,
Bram Moolenaar95946f12019-03-31 15:31:59 +02001740 fields->col,
thinca6864efa2021-06-19 20:45:20 +02001741 fields->end_col,
Bram Moolenaar95946f12019-03-31 15:31:59 +02001742 fields->use_viscol,
1743 fields->pattern,
1744 fields->enr,
1745 fields->type,
Tom Praschanca6ac992023-08-11 23:26:12 +02001746 fields->user_data,
Bram Moolenaar95946f12019-03-31 15:31:59 +02001747 fields->valid);
1748}
1749
1750/*
Bram Moolenaar86b68352004-12-27 21:59:20 +00001751 * Read the errorfile "efile" into memory, line by line, building the error
1752 * list.
Bram Moolenaar864293a2016-06-02 13:40:04 +02001753 * Alternative: when "efile" is NULL read errors from buffer "buf".
1754 * Alternative: when "tv" is not NULL get errors from the string or list.
Bram Moolenaar86b68352004-12-27 21:59:20 +00001755 * Always use 'errorformat' from "buf" if there is a local value.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02001756 * Then "lnumfirst" and "lnumlast" specify the range of lines to use.
1757 * Set the title of the list to "qf_title".
Bram Moolenaar86b68352004-12-27 21:59:20 +00001758 * Return -1 for error, number of errors for success.
1759 */
1760 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01001761qf_init_ext(
1762 qf_info_T *qi,
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001763 int qf_idx,
Bram Moolenaar05540972016-01-30 20:31:25 +01001764 char_u *efile,
1765 buf_T *buf,
1766 typval_T *tv,
1767 char_u *errorformat,
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001768 int newlist, // TRUE: start a new error list
1769 linenr_T lnumfirst, // first line number to use
1770 linenr_T lnumlast, // last line number to use
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01001771 char_u *qf_title,
1772 char_u *enc)
Bram Moolenaar86b68352004-12-27 21:59:20 +00001773{
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001774 qf_list_T *qfl;
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01001775 qfstate_T state;
1776 qffields_T fields;
Bram Moolenaar864293a2016-06-02 13:40:04 +02001777 qfline_T *old_last = NULL;
Bram Moolenaar86f100dc2017-06-28 21:26:27 +02001778 int adding = FALSE;
Bram Moolenaar361c8f02016-07-02 15:41:47 +02001779 static efm_T *fmt_first = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 char_u *efm;
Bram Moolenaar361c8f02016-07-02 15:41:47 +02001781 static char_u *last_efm = NULL;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001782 int retval = -1; // default: return error flag
Bram Moolenaare0d37972016-07-15 22:36:01 +02001783 int status;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001785 // Do not used the cached buffer, it may have been wiped out.
Bram Moolenaard23a8232018-02-10 18:45:26 +01001786 VIM_CLEAR(qf_last_bufname);
Bram Moolenaar6dd4a532017-05-28 07:56:36 +02001787
Bram Moolenaara80faa82020-04-12 19:37:17 +02001788 CLEAR_FIELD(state);
1789 CLEAR_FIELD(fields);
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001790 if ((qf_alloc_fields(&fields) == FAIL) ||
1791 (qf_setup_state(&state, enc, efile, tv, buf,
1792 lnumfirst, lnumlast) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001793 goto qf_init_end;
1794
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001795 if (newlist || qf_idx == qi->qf_listcount)
1796 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001797 // make place for a new list
Bram Moolenaar94116152012-11-28 17:41:59 +01001798 qf_new_list(qi, qf_title);
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001799 qf_idx = qi->qf_curlist;
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01001800 qfl = qf_get_list(qi, qf_idx);
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001801 }
Bram Moolenaar86f100dc2017-06-28 21:26:27 +02001802 else
Bram Moolenaar864293a2016-06-02 13:40:04 +02001803 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001804 // Adding to existing list, use last entry.
Bram Moolenaar2b946c92016-11-12 18:14:44 +01001805 adding = TRUE;
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01001806 qfl = qf_get_list(qi, qf_idx);
1807 if (!qf_list_empty(qfl))
1808 old_last = qfl->qf_last;
Bram Moolenaar86f100dc2017-06-28 21:26:27 +02001809 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001811 // Use the local value of 'errorformat' if it's set.
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001812 if (errorformat == p_efm && tv == NULL && *buf->b_p_efm != NUL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00001813 efm = buf->b_p_efm;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 else
1815 efm = errorformat;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001817 // If the errorformat didn't change between calls, then reuse the
1818 // previously parsed values.
Bram Moolenaar361c8f02016-07-02 15:41:47 +02001819 if (last_efm == NULL || (STRCMP(last_efm, efm) != 0))
1820 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001821 // free the previously parsed data
Bram Moolenaard23a8232018-02-10 18:45:26 +01001822 VIM_CLEAR(last_efm);
Bram Moolenaar361c8f02016-07-02 15:41:47 +02001823 free_efm_list(&fmt_first);
1824
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001825 // parse the current 'efm'
Bram Moolenaar361c8f02016-07-02 15:41:47 +02001826 fmt_first = parse_efm_option(efm);
1827 if (fmt_first != NULL)
1828 last_efm = vim_strsave(efm);
1829 }
1830
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001831 if (fmt_first == NULL) // nothing found
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 goto error2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001834 // got_int is reset here, because it was probably set when killing the
1835 // ":make" command, but we still want to read the errorfile then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 got_int = FALSE;
1837
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001838 // Read the lines in the error file one by one.
1839 // Try to recognize one of the error formats in each line.
Bram Moolenaar86b68352004-12-27 21:59:20 +00001840 while (!got_int)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 {
Bram Moolenaar95946f12019-03-31 15:31:59 +02001842 status = qf_init_process_nextline(qfl, fmt_first, &state, &fields);
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001843 if (status == QF_NOMEM) // memory alloc failure
Bram Moolenaare0d37972016-07-15 22:36:01 +02001844 goto qf_init_end;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001845 if (status == QF_END_OF_INPUT) // end of input
Bram Moolenaare0d37972016-07-15 22:36:01 +02001846 break;
Bram Moolenaare87e6dd2016-07-17 19:25:04 +02001847 if (status == QF_FAIL)
1848 goto error2;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 line_breakcheck();
1851 }
Bram Moolenaare0d37972016-07-15 22:36:01 +02001852 if (state.fd == NULL || !ferror(state.fd))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001853 {
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001854 if (qfl->qf_index == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001856 // no valid entry found
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001857 qfl->qf_ptr = qfl->qf_start;
1858 qfl->qf_index = 1;
1859 qfl->qf_nonevalid = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001860 }
1861 else
1862 {
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001863 qfl->qf_nonevalid = FALSE;
1864 if (qfl->qf_ptr == NULL)
1865 qfl->qf_ptr = qfl->qf_start;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 }
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001867 // return number of matches
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001868 retval = qfl->qf_count;
Bram Moolenaarbcf77722016-06-28 21:11:32 +02001869 goto qf_init_end;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001870 }
Bram Moolenaard8e44472021-07-21 22:20:33 +02001871 emsg(_(e_error_while_reading_errorfile));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872error2:
Bram Moolenaar2b946c92016-11-12 18:14:44 +01001873 if (!adding)
1874 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001875 // Error when creating a new list. Free the new list
Bram Moolenaar108e7b42018-10-11 17:39:12 +02001876 qf_free(qfl);
Bram Moolenaar2b946c92016-11-12 18:14:44 +01001877 qi->qf_listcount--;
1878 if (qi->qf_curlist > 0)
1879 --qi->qf_curlist;
1880 }
Bram Moolenaarbcf77722016-06-28 21:11:32 +02001881qf_init_end:
Bram Moolenaara7df8c72017-07-19 13:23:06 +02001882 if (qf_idx == qi->qf_curlist)
1883 qf_update_buffer(qi, old_last);
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001884 qf_cleanup_state(&state);
1885 qf_free_fields(&fields);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886
1887 return retval;
1888}
1889
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001890/*
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001891 * Read the errorfile "efile" into memory, line by line, building the error
1892 * list. Set the error list's title to qf_title.
1893 * Return -1 for error, number of errors for success.
1894 */
1895 int
1896qf_init(win_T *wp,
1897 char_u *efile,
1898 char_u *errorformat,
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001899 int newlist, // TRUE: start a new error list
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02001900 char_u *qf_title,
1901 char_u *enc)
1902{
1903 qf_info_T *qi = &ql_info;
1904
1905 if (wp != NULL)
1906 {
1907 qi = ll_get_or_alloc_list(wp);
1908 if (qi == NULL)
1909 return FAIL;
1910 }
1911
1912 return qf_init_ext(qi, qi->qf_curlist, efile, curbuf, NULL, errorformat,
1913 newlist, (linenr_T)0, (linenr_T)0, qf_title, enc);
1914}
1915
1916/*
Bram Moolenaar18cebf42018-05-08 22:31:37 +02001917 * Set the title of the specified quickfix list. Frees the previous title.
1918 * Prepends ':' to the title.
1919 */
Bram Moolenaarfb604092014-07-23 15:55:00 +02001920 static void
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02001921qf_store_title(qf_list_T *qfl, char_u *title)
Bram Moolenaarfb604092014-07-23 15:55:00 +02001922{
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02001923 VIM_CLEAR(qfl->qf_title);
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02001924
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00001925 if (title == NULL)
1926 return;
Bram Moolenaarfb604092014-07-23 15:55:00 +02001927
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00001928 char_u *p = alloc_id(STRLEN(title) + 2, aid_qf_title);
1929
1930 qfl->qf_title = p;
1931 if (p != NULL)
1932 STRCPY(p, title);
Bram Moolenaarfb604092014-07-23 15:55:00 +02001933}
1934
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935/*
Bram Moolenaar8b62e312018-05-13 15:29:04 +02001936 * The title of a quickfix/location list is set, by default, to the command
1937 * that created the quickfix list with the ":" prefix.
1938 * Create a quickfix list title string by prepending ":" to a user command.
1939 * Returns a pointer to a static buffer with the title.
1940 */
1941 static char_u *
1942qf_cmdtitle(char_u *cmd)
1943{
1944 static char_u qftitle_str[IOSIZE];
1945
1946 vim_snprintf((char *)qftitle_str, IOSIZE, ":%s", (char *)cmd);
1947 return qftitle_str;
1948}
1949
1950/*
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01001951 * Return a pointer to the current list in the specified quickfix stack
1952 */
1953 static qf_list_T *
1954qf_get_curlist(qf_info_T *qi)
1955{
Bram Moolenaar0398e002019-03-21 21:12:49 +01001956 return qf_get_list(qi, qi->qf_curlist);
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01001957}
1958
1959/*
Bram Moolenaar55b69262017-08-13 13:42:01 +02001960 * Prepare for adding a new quickfix list. If the current list is in the
1961 * middle of the stack, then all the following lists are freed and then
1962 * the new list is added.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 */
1964 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01001965qf_new_list(qf_info_T *qi, char_u *qf_title)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966{
1967 int i;
Bram Moolenaar108e7b42018-10-11 17:39:12 +02001968 qf_list_T *qfl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001970 // If the current entry is not the last entry, delete entries beyond
1971 // the current entry. This makes it possible to browse in a tree-like
Bram Moolenaar32aa1022019-11-02 22:54:41 +01001972 // way with ":grep".
Bram Moolenaard12f5c12006-01-25 22:10:52 +00001973 while (qi->qf_listcount > qi->qf_curlist + 1)
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02001974 qf_free(&qi->qf_lists[--qi->qf_listcount]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02001976 // When the stack is full, remove to oldest entry
1977 // Otherwise, add a new entry.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00001978 if (qi->qf_listcount == LISTCOUNT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 {
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02001980 qf_free(&qi->qf_lists[0]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 for (i = 1; i < LISTCOUNT; ++i)
Bram Moolenaard12f5c12006-01-25 22:10:52 +00001982 qi->qf_lists[i - 1] = qi->qf_lists[i];
1983 qi->qf_curlist = LISTCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 }
1985 else
Bram Moolenaard12f5c12006-01-25 22:10:52 +00001986 qi->qf_curlist = qi->qf_listcount++;
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01001987 qfl = qf_get_curlist(qi);
Bram Moolenaara80faa82020-04-12 19:37:17 +02001988 CLEAR_POINTER(qfl);
Bram Moolenaar108e7b42018-10-11 17:39:12 +02001989 qf_store_title(qfl, qf_title);
Bram Moolenaar2d67d302018-11-16 18:46:02 +01001990 qfl->qfl_type = qi->qfl_type;
Bram Moolenaar108e7b42018-10-11 17:39:12 +02001991 qfl->qf_id = ++last_qf_id;
Tom Praschanca6ac992023-08-11 23:26:12 +02001992 qfl->qf_has_user_data = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993}
1994
Bram Moolenaard12f5c12006-01-25 22:10:52 +00001995/*
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02001996 * Queue location list stack delete request.
1997 */
1998 static void
1999locstack_queue_delreq(qf_info_T *qi)
2000{
2001 qf_delq_T *q;
2002
Bram Moolenaarc799fe22019-05-28 23:08:19 +02002003 q = ALLOC_ONE(qf_delq_T);
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00002004 if (q == NULL)
2005 return;
2006
2007 q->qi = qi;
2008 q->next = qf_delq_head;
2009 qf_delq_head = q;
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02002010}
2011
2012/*
Bram Moolenaaree8188f2019-02-05 21:23:04 +01002013 * Return the global quickfix stack window buffer number.
2014 */
2015 int
2016qf_stack_get_bufnr(void)
2017{
2018 return ql_info.qf_bufnr;
2019}
2020
2021/*
2022 * Wipe the quickfix window buffer (if present) for the specified
2023 * quickfix/location list.
2024 */
2025 static void
2026wipe_qf_buffer(qf_info_T *qi)
2027{
2028 buf_T *qfbuf;
2029
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00002030 if (qi->qf_bufnr == INVALID_QFBUFNR)
2031 return;
2032
2033 qfbuf = buflist_findnr(qi->qf_bufnr);
2034 if (qfbuf != NULL && qfbuf->b_nwindows == 0)
Bram Moolenaaree8188f2019-02-05 21:23:04 +01002035 {
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00002036 // If the quickfix buffer is not loaded in any window, then
2037 // wipe the buffer.
2038 close_buffer(NULL, qfbuf, DOBUF_WIPE, FALSE, FALSE);
2039 qi->qf_bufnr = INVALID_QFBUFNR;
Bram Moolenaaree8188f2019-02-05 21:23:04 +01002040 }
2041}
2042
2043/*
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002044 * Free a location list stack
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002045 */
2046 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002047ll_free_all(qf_info_T **pqi)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002048{
2049 int i;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002050 qf_info_T *qi;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002051
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002052 qi = *pqi;
2053 if (qi == NULL)
2054 return;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002055 *pqi = NULL; // Remove reference to this list
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002056
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01002057 // If the location list is still in use, then queue the delete request
2058 // to be processed later.
2059 if (quickfix_busy > 0)
2060 {
2061 locstack_queue_delreq(qi);
2062 return;
2063 }
2064
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002065 qi->qf_refcount--;
2066 if (qi->qf_refcount < 1)
2067 {
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02002068 // No references to this location list.
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01002069 // If the quickfix window buffer is loaded, then wipe it
2070 wipe_qf_buffer(qi);
Bram Moolenaaree8188f2019-02-05 21:23:04 +01002071
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01002072 for (i = 0; i < qi->qf_listcount; ++i)
Bram Moolenaar0398e002019-03-21 21:12:49 +01002073 qf_free(qf_get_list(qi, i));
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01002074 vim_free(qi);
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002075 }
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002076}
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002077
Bram Moolenaar18cebf42018-05-08 22:31:37 +02002078/*
2079 * Free all the quickfix/location lists in the stack.
2080 */
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002081 void
Bram Moolenaar05540972016-01-30 20:31:25 +01002082qf_free_all(win_T *wp)
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002083{
2084 int i;
2085 qf_info_T *qi = &ql_info;
2086
2087 if (wp != NULL)
2088 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002089 // location list
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002090 ll_free_all(&wp->w_llist);
2091 ll_free_all(&wp->w_llist_ref);
2092 }
2093 else
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002094 // quickfix list
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002095 for (i = 0; i < qi->qf_listcount; ++i)
Bram Moolenaar0398e002019-03-21 21:12:49 +01002096 qf_free(qf_get_list(qi, i));
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002097}
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002098
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099/*
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02002100 * Delay freeing of location list stacks when the quickfix code is running.
2101 * Used to avoid problems with autocmds freeing location list stacks when the
2102 * quickfix code is still referencing the stack.
2103 * Must always call decr_quickfix_busy() exactly once after this.
2104 */
2105 static void
2106incr_quickfix_busy(void)
2107{
2108 quickfix_busy++;
2109}
2110
2111/*
2112 * Safe to free location list stacks. Process any delayed delete requests.
2113 */
2114 static void
2115decr_quickfix_busy(void)
2116{
2117 if (--quickfix_busy == 0)
2118 {
2119 // No longer referencing the location lists. Process all the pending
2120 // delete requests.
2121 while (qf_delq_head != NULL)
2122 {
2123 qf_delq_T *q = qf_delq_head;
2124
2125 qf_delq_head = q->next;
2126 ll_free_all(&q->qi);
2127 vim_free(q);
2128 }
2129 }
2130#ifdef ABORT_ON_INTERNAL_ERROR
2131 if (quickfix_busy < 0)
2132 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002133 emsg("quickfix_busy has become negative");
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02002134 abort();
2135 }
2136#endif
2137}
2138
2139#if defined(EXITFREE) || defined(PROTO)
2140 void
2141check_quickfix_busy(void)
2142{
2143 if (quickfix_busy != 0)
2144 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002145 semsg("quickfix_busy not zero on exit: %ld", (long)quickfix_busy);
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02002146# ifdef ABORT_ON_INTERNAL_ERROR
2147 abort();
2148# endif
2149 }
2150}
2151#endif
2152
2153/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154 * Add an entry to the end of the list of errors.
Yegappan Lakshmanan9c9be052022-02-24 12:33:17 +00002155 * Returns QF_OK on success or QF_FAIL on a memory allocation failure.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 */
2157 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01002158qf_add_entry(
Bram Moolenaar0398e002019-03-21 21:12:49 +01002159 qf_list_T *qfl, // quickfix list entry
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002160 char_u *dir, // optional directory name
2161 char_u *fname, // file name or NULL
2162 char_u *module, // module name or NULL
2163 int bufnum, // buffer number or zero
2164 char_u *mesg, // message
2165 long lnum, // line number
thinca6864efa2021-06-19 20:45:20 +02002166 long end_lnum, // line number for end
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002167 int col, // column
thinca6864efa2021-06-19 20:45:20 +02002168 int end_col, // column for end
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002169 int vis_col, // using visual column
2170 char_u *pattern, // search pattern
2171 int nr, // error number
2172 int type, // type character
Tom Praschanca6ac992023-08-11 23:26:12 +02002173 typval_T *user_data, // custom user data or NULL
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002174 int valid) // valid entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175{
Bram Moolenaar68b76a62005-03-25 21:53:48 +00002176 qfline_T *qfp;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002177 qfline_T **lastp; // pointer to qf_last or NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +00002179 if ((qfp = ALLOC_ONE_ID(qfline_T, aid_qf_qfline)) == NULL)
Bram Moolenaar95946f12019-03-31 15:31:59 +02002180 return QF_FAIL;
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00002181 if (bufnum != 0)
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002182 {
2183 buf_T *buf = buflist_findnr(bufnum);
2184
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00002185 qfp->qf_fnum = bufnum;
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002186 if (buf != NULL)
Bram Moolenaarc1542742016-07-20 21:44:37 +02002187 buf->b_has_qf_entry |=
Bram Moolenaar2d67d302018-11-16 18:46:02 +01002188 IS_QF_LIST(qfl) ? BUF_HAS_QF_ENTRY : BUF_HAS_LL_ENTRY;
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002189 }
Bram Moolenaar48b66fb2007-02-04 01:58:18 +00002190 else
Bram Moolenaar0398e002019-03-21 21:12:49 +01002191 qfp->qf_fnum = qf_get_fnum(qfl, dir, fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 if ((qfp->qf_text = vim_strsave(mesg)) == NULL)
2193 {
2194 vim_free(qfp);
Bram Moolenaar95946f12019-03-31 15:31:59 +02002195 return QF_FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002196 }
2197 qfp->qf_lnum = lnum;
thinca6864efa2021-06-19 20:45:20 +02002198 qfp->qf_end_lnum = end_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002199 qfp->qf_col = col;
thinca6864efa2021-06-19 20:45:20 +02002200 qfp->qf_end_col = end_col;
Bram Moolenaar05159a02005-02-26 23:04:13 +00002201 qfp->qf_viscol = vis_col;
Tom Praschanca6ac992023-08-11 23:26:12 +02002202 if (user_data == NULL || user_data->v_type == VAR_UNKNOWN)
Yegappan Lakshmanand4e4ecb2023-08-27 18:35:45 +02002203 qfp->qf_user_data.v_type = VAR_UNKNOWN;
Tom Praschanca6ac992023-08-11 23:26:12 +02002204 else
2205 {
2206 copy_tv(user_data, &qfp->qf_user_data);
2207 qfl->qf_has_user_data = TRUE;
2208 }
Bram Moolenaar68b76a62005-03-25 21:53:48 +00002209 if (pattern == NULL || *pattern == NUL)
2210 qfp->qf_pattern = NULL;
2211 else if ((qfp->qf_pattern = vim_strsave(pattern)) == NULL)
2212 {
2213 vim_free(qfp->qf_text);
2214 vim_free(qfp);
Bram Moolenaar95946f12019-03-31 15:31:59 +02002215 return QF_FAIL;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00002216 }
Bram Moolenaard76ce852018-05-01 15:02:04 +02002217 if (module == NULL || *module == NUL)
2218 qfp->qf_module = NULL;
2219 else if ((qfp->qf_module = vim_strsave(module)) == NULL)
2220 {
2221 vim_free(qfp->qf_text);
2222 vim_free(qfp->qf_pattern);
2223 vim_free(qfp);
Bram Moolenaar95946f12019-03-31 15:31:59 +02002224 return QF_FAIL;
Bram Moolenaard76ce852018-05-01 15:02:04 +02002225 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 qfp->qf_nr = nr;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002227 if (type != 1 && !vim_isprintc(type)) // only printable chars allowed
Bram Moolenaar071d4272004-06-13 20:20:40 +00002228 type = 0;
2229 qfp->qf_type = type;
2230 qfp->qf_valid = valid;
2231
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002232 lastp = &qfl->qf_last;
Bram Moolenaar0398e002019-03-21 21:12:49 +01002233 if (qf_list_empty(qfl)) // first element in the list
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 {
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002235 qfl->qf_start = qfp;
2236 qfl->qf_ptr = qfp;
2237 qfl->qf_index = 0;
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02002238 qfp->qf_prev = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 }
2240 else
2241 {
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02002242 qfp->qf_prev = *lastp;
2243 (*lastp)->qf_next = qfp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244 }
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02002245 qfp->qf_next = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002246 qfp->qf_cleared = FALSE;
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02002247 *lastp = qfp;
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002248 ++qfl->qf_count;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002249 if (qfl->qf_index == 0 && qfp->qf_valid) // first valid entry
Bram Moolenaar071d4272004-06-13 20:20:40 +00002250 {
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002251 qfl->qf_index = qfl->qf_count;
2252 qfl->qf_ptr = qfp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002253 }
2254
Bram Moolenaar95946f12019-03-31 15:31:59 +02002255 return QF_OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256}
2257
2258/*
Bram Moolenaar2d67d302018-11-16 18:46:02 +01002259 * Allocate a new quickfix/location list stack
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002260 */
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00002261 static qf_info_T *
Bram Moolenaar2d67d302018-11-16 18:46:02 +01002262qf_alloc_stack(qfltype_T qfltype)
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002263{
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00002264 qf_info_T *qi;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002265
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +00002266 qi = ALLOC_CLEAR_ONE_ID(qf_info_T, aid_qf_qfinfo);
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00002267 if (qi == NULL)
2268 return NULL;
2269
2270 qi->qf_refcount++;
2271 qi->qfl_type = qfltype;
2272 qi->qf_bufnr = INVALID_QFBUFNR;
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00002273 return qi;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002274}
2275
2276/*
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002277 * Return the location list stack for window 'wp'.
2278 * If not present, allocate a location list stack
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002279 */
2280 static qf_info_T *
Bram Moolenaar05540972016-01-30 20:31:25 +01002281ll_get_or_alloc_list(win_T *wp)
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002282{
2283 if (IS_LL_WINDOW(wp))
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002284 // For a location list window, use the referenced location list
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002285 return wp->w_llist_ref;
2286
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002287 // For a non-location list window, w_llist_ref should not point to a
2288 // location list.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002289 ll_free_all(&wp->w_llist_ref);
2290
2291 if (wp->w_llist == NULL)
Bram Moolenaar2d67d302018-11-16 18:46:02 +01002292 wp->w_llist = qf_alloc_stack(QFLT_LOCATION); // new location list
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002293 return wp->w_llist;
2294}
2295
2296/*
Bram Moolenaar87f59b02019-04-04 14:04:11 +02002297 * Get the quickfix/location list stack to use for the specified Ex command.
2298 * For a location list command, returns the stack for the current window. If
2299 * the location list is not found, then returns NULL and prints an error
2300 * message if 'print_emsg' is TRUE.
2301 */
2302 static qf_info_T *
2303qf_cmd_get_stack(exarg_T *eap, int print_emsg)
2304{
2305 qf_info_T *qi = &ql_info;
2306
2307 if (is_loclist_cmd(eap->cmdidx))
2308 {
2309 qi = GET_LOC_LIST(curwin);
2310 if (qi == NULL)
2311 {
2312 if (print_emsg)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00002313 emsg(_(e_no_location_list));
Bram Moolenaar87f59b02019-04-04 14:04:11 +02002314 return NULL;
2315 }
2316 }
2317
2318 return qi;
2319}
2320
2321/*
2322 * Get the quickfix/location list stack to use for the specified Ex command.
2323 * For a location list command, returns the stack for the current window.
2324 * If the location list is not present, then allocates a new one.
2325 * Returns NULL if the allocation fails. For a location list command, sets
2326 * 'pwinp' to curwin.
2327 */
2328 static qf_info_T *
2329qf_cmd_get_or_alloc_stack(exarg_T *eap, win_T **pwinp)
2330{
2331 qf_info_T *qi = &ql_info;
2332
2333 if (is_loclist_cmd(eap->cmdidx))
2334 {
2335 qi = ll_get_or_alloc_list(curwin);
2336 if (qi == NULL)
2337 return NULL;
2338 *pwinp = curwin;
2339 }
2340
2341 return qi;
2342}
2343
2344/*
Bram Moolenaar09037502018-09-25 22:08:14 +02002345 * Copy location list entries from 'from_qfl' to 'to_qfl'.
2346 */
2347 static int
Bram Moolenaar0398e002019-03-21 21:12:49 +01002348copy_loclist_entries(qf_list_T *from_qfl, qf_list_T *to_qfl)
Bram Moolenaar09037502018-09-25 22:08:14 +02002349{
2350 int i;
2351 qfline_T *from_qfp;
2352 qfline_T *prevp;
2353
2354 // copy all the location entries in this list
Bram Moolenaara16123a2019-03-28 20:31:07 +01002355 FOR_ALL_QFL_ITEMS(from_qfl, from_qfp, i)
Bram Moolenaar09037502018-09-25 22:08:14 +02002356 {
Bram Moolenaar0398e002019-03-21 21:12:49 +01002357 if (qf_add_entry(to_qfl,
Bram Moolenaar09037502018-09-25 22:08:14 +02002358 NULL,
2359 NULL,
2360 from_qfp->qf_module,
2361 0,
2362 from_qfp->qf_text,
2363 from_qfp->qf_lnum,
thinca6864efa2021-06-19 20:45:20 +02002364 from_qfp->qf_end_lnum,
Bram Moolenaar09037502018-09-25 22:08:14 +02002365 from_qfp->qf_col,
thinca6864efa2021-06-19 20:45:20 +02002366 from_qfp->qf_end_col,
Bram Moolenaar09037502018-09-25 22:08:14 +02002367 from_qfp->qf_viscol,
2368 from_qfp->qf_pattern,
2369 from_qfp->qf_nr,
2370 0,
Tom Praschanca6ac992023-08-11 23:26:12 +02002371 &from_qfp->qf_user_data,
Bram Moolenaar95946f12019-03-31 15:31:59 +02002372 from_qfp->qf_valid) == QF_FAIL)
Bram Moolenaar09037502018-09-25 22:08:14 +02002373 return FAIL;
2374
2375 // qf_add_entry() will not set the qf_num field, as the
2376 // directory and file names are not supplied. So the qf_fnum
2377 // field is copied here.
2378 prevp = to_qfl->qf_last;
2379 prevp->qf_fnum = from_qfp->qf_fnum; // file number
2380 prevp->qf_type = from_qfp->qf_type; // error type
2381 if (from_qfl->qf_ptr == from_qfp)
2382 to_qfl->qf_ptr = prevp; // current location
2383 }
2384
2385 return OK;
2386}
2387
2388/*
2389 * Copy the specified location list 'from_qfl' to 'to_qfl'.
2390 */
2391 static int
Bram Moolenaar0398e002019-03-21 21:12:49 +01002392copy_loclist(qf_list_T *from_qfl, qf_list_T *to_qfl)
Bram Moolenaar09037502018-09-25 22:08:14 +02002393{
2394 // Some of the fields are populated by qf_add_entry()
Bram Moolenaar2d67d302018-11-16 18:46:02 +01002395 to_qfl->qfl_type = from_qfl->qfl_type;
Bram Moolenaar09037502018-09-25 22:08:14 +02002396 to_qfl->qf_nonevalid = from_qfl->qf_nonevalid;
Tom Praschanca6ac992023-08-11 23:26:12 +02002397 to_qfl->qf_has_user_data = from_qfl->qf_has_user_data;
Bram Moolenaar09037502018-09-25 22:08:14 +02002398 to_qfl->qf_count = 0;
2399 to_qfl->qf_index = 0;
2400 to_qfl->qf_start = NULL;
2401 to_qfl->qf_last = NULL;
2402 to_qfl->qf_ptr = NULL;
2403 if (from_qfl->qf_title != NULL)
2404 to_qfl->qf_title = vim_strsave(from_qfl->qf_title);
2405 else
2406 to_qfl->qf_title = NULL;
2407 if (from_qfl->qf_ctx != NULL)
2408 {
2409 to_qfl->qf_ctx = alloc_tv();
2410 if (to_qfl->qf_ctx != NULL)
2411 copy_tv(from_qfl->qf_ctx, to_qfl->qf_ctx);
2412 }
2413 else
2414 to_qfl->qf_ctx = NULL;
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +01002415 if (from_qfl->qf_qftf_cb.cb_name != NULL)
2416 copy_callback(&to_qfl->qf_qftf_cb, &from_qfl->qf_qftf_cb);
Bram Moolenaar858ba062020-05-31 23:11:59 +02002417 else
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +01002418 to_qfl->qf_qftf_cb.cb_name = NULL;
Bram Moolenaar09037502018-09-25 22:08:14 +02002419
2420 if (from_qfl->qf_count)
Bram Moolenaar0398e002019-03-21 21:12:49 +01002421 if (copy_loclist_entries(from_qfl, to_qfl) == FAIL)
Bram Moolenaar09037502018-09-25 22:08:14 +02002422 return FAIL;
2423
2424 to_qfl->qf_index = from_qfl->qf_index; // current index in the list
2425
2426 // Assign a new ID for the location list
2427 to_qfl->qf_id = ++last_qf_id;
2428 to_qfl->qf_changedtick = 0L;
2429
2430 // When no valid entries are present in the list, qf_ptr points to
2431 // the first item in the list
2432 if (to_qfl->qf_nonevalid)
2433 {
2434 to_qfl->qf_ptr = to_qfl->qf_start;
2435 to_qfl->qf_index = 1;
2436 }
2437
2438 return OK;
2439}
2440
2441/*
2442 * Copy the location list stack 'from' window to 'to' window.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002443 */
2444 void
Bram Moolenaar09037502018-09-25 22:08:14 +02002445copy_loclist_stack(win_T *from, win_T *to)
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002446{
2447 qf_info_T *qi;
2448 int idx;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002449
Bram Moolenaar09037502018-09-25 22:08:14 +02002450 // When copying from a location list window, copy the referenced
2451 // location list. For other windows, copy the location list for
2452 // that window.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002453 if (IS_LL_WINDOW(from))
2454 qi = from->w_llist_ref;
2455 else
2456 qi = from->w_llist;
2457
Bram Moolenaar09037502018-09-25 22:08:14 +02002458 if (qi == NULL) // no location list to copy
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002459 return;
2460
Bram Moolenaar09037502018-09-25 22:08:14 +02002461 // allocate a new location list
Bram Moolenaar2d67d302018-11-16 18:46:02 +01002462 if ((to->w_llist = qf_alloc_stack(QFLT_LOCATION)) == NULL)
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002463 return;
2464
2465 to->w_llist->qf_listcount = qi->qf_listcount;
2466
Bram Moolenaar09037502018-09-25 22:08:14 +02002467 // Copy the location lists one at a time
Bram Moolenaarde3b3672018-08-07 21:54:41 +02002468 for (idx = 0; idx < qi->qf_listcount; ++idx)
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002469 {
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002470 to->w_llist->qf_curlist = idx;
2471
Bram Moolenaar0398e002019-03-21 21:12:49 +01002472 if (copy_loclist(qf_get_list(qi, idx),
2473 qf_get_list(to->w_llist, idx)) == FAIL)
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02002474 {
Bram Moolenaar09037502018-09-25 22:08:14 +02002475 qf_free_all(to);
2476 return;
Bram Moolenaar730d2c02013-06-30 13:33:58 +02002477 }
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002478 }
2479
Bram Moolenaar09037502018-09-25 22:08:14 +02002480 to->w_llist->qf_curlist = qi->qf_curlist; // current list
Bram Moolenaard12f5c12006-01-25 22:10:52 +00002481}
2482
2483/*
Bram Moolenaar7618e002016-11-13 15:09:26 +01002484 * Get buffer number for file "directory/fname".
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002485 * Also sets the b_has_qf_entry flag.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 */
2487 static int
Bram Moolenaar0398e002019-03-21 21:12:49 +01002488qf_get_fnum(qf_list_T *qfl, char_u *directory, char_u *fname)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002489{
Bram Moolenaar82404332016-07-10 17:00:38 +02002490 char_u *ptr = NULL;
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002491 buf_T *buf;
Bram Moolenaar82404332016-07-10 17:00:38 +02002492 char_u *bufname;
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002493
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002494 if (fname == NULL || *fname == NUL) // no file name
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 return 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496
Bram Moolenaare60acc12011-05-10 16:41:25 +02002497#ifdef VMS
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002498 vms_remove_version(fname);
Bram Moolenaare60acc12011-05-10 16:41:25 +02002499#endif
2500#ifdef BACKSLASH_IN_FILENAME
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002501 if (directory != NULL)
2502 slash_adjust(directory);
2503 slash_adjust(fname);
Bram Moolenaare60acc12011-05-10 16:41:25 +02002504#endif
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002505 if (directory != NULL && !vim_isAbsName(fname)
2506 && (ptr = concat_fnames(directory, fname, TRUE)) != NULL)
2507 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002508 // Here we check if the file really exists.
2509 // This should normally be true, but if make works without
2510 // "leaving directory"-messages we might have missed a
2511 // directory change.
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002512 if (mch_getperm(ptr) < 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 vim_free(ptr);
Bram Moolenaar108e7b42018-10-11 17:39:12 +02002515 directory = qf_guess_filepath(qfl, fname);
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002516 if (directory)
2517 ptr = concat_fnames(directory, fname, TRUE);
2518 else
2519 ptr = vim_strsave(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 }
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002521 // Use concatenated directory name and file name
Bram Moolenaar82404332016-07-10 17:00:38 +02002522 bufname = ptr;
2523 }
2524 else
2525 bufname = fname;
2526
2527 if (qf_last_bufname != NULL && STRCMP(bufname, qf_last_bufname) == 0
Bram Moolenaarb25f9a92016-07-10 18:21:50 +02002528 && bufref_valid(&qf_last_bufref))
Bram Moolenaar82404332016-07-10 17:00:38 +02002529 {
Bram Moolenaarb25f9a92016-07-10 18:21:50 +02002530 buf = qf_last_bufref.br_buf;
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002531 vim_free(ptr);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 }
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002533 else
Bram Moolenaar82404332016-07-10 17:00:38 +02002534 {
2535 vim_free(qf_last_bufname);
2536 buf = buflist_new(bufname, NULL, (linenr_T)0, BLN_NOOPT);
2537 if (bufname == ptr)
2538 qf_last_bufname = bufname;
2539 else
2540 qf_last_bufname = vim_strsave(bufname);
Bram Moolenaarb25f9a92016-07-10 18:21:50 +02002541 set_bufref(&qf_last_bufref, buf);
Bram Moolenaar82404332016-07-10 17:00:38 +02002542 }
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002543 if (buf == NULL)
2544 return 0;
Bram Moolenaar82404332016-07-10 17:00:38 +02002545
Bram Moolenaarc1542742016-07-20 21:44:37 +02002546 buf->b_has_qf_entry =
Bram Moolenaar2d67d302018-11-16 18:46:02 +01002547 IS_QF_LIST(qfl) ? BUF_HAS_QF_ENTRY : BUF_HAS_LL_ENTRY;
Bram Moolenaar2f095a42016-06-03 19:05:49 +02002548 return buf->b_fnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549}
2550
2551/*
Bram Moolenaar38df43b2016-06-20 21:41:12 +02002552 * Push dirbuf onto the directory stack and return pointer to actual dir or
2553 * NULL on error.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554 */
2555 static char_u *
Bram Moolenaar361c8f02016-07-02 15:41:47 +02002556qf_push_dir(char_u *dirbuf, struct dir_stack_T **stackptr, int is_file_stack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557{
2558 struct dir_stack_T *ds_new;
2559 struct dir_stack_T *ds_ptr;
2560
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002561 // allocate new stack element and hook it in
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +00002562 ds_new = ALLOC_ONE_ID(struct dir_stack_T, aid_qf_dirstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 if (ds_new == NULL)
2564 return NULL;
2565
2566 ds_new->next = *stackptr;
2567 *stackptr = ds_new;
2568
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002569 // store directory on the stack
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 if (vim_isAbsName(dirbuf)
2571 || (*stackptr)->next == NULL
=?UTF-8?q?Dundar=20G=C3=B6c?=dd410372022-05-15 13:59:11 +01002572 || is_file_stack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 (*stackptr)->dirname = vim_strsave(dirbuf);
2574 else
2575 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002576 // Okay we don't have an absolute path.
2577 // dirbuf must be a subdir of one of the directories on the stack.
2578 // Let's search...
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 ds_new = (*stackptr)->next;
2580 (*stackptr)->dirname = NULL;
2581 while (ds_new)
2582 {
2583 vim_free((*stackptr)->dirname);
2584 (*stackptr)->dirname = concat_fnames(ds_new->dirname, dirbuf,
2585 TRUE);
2586 if (mch_isdir((*stackptr)->dirname) == TRUE)
2587 break;
2588
2589 ds_new = ds_new->next;
2590 }
2591
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002592 // clean up all dirs we already left
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 while ((*stackptr)->next != ds_new)
2594 {
2595 ds_ptr = (*stackptr)->next;
2596 (*stackptr)->next = (*stackptr)->next->next;
2597 vim_free(ds_ptr->dirname);
2598 vim_free(ds_ptr);
2599 }
2600
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002601 // Nothing found -> it must be on top level
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602 if (ds_new == NULL)
2603 {
2604 vim_free((*stackptr)->dirname);
2605 (*stackptr)->dirname = vim_strsave(dirbuf);
2606 }
2607 }
2608
2609 if ((*stackptr)->dirname != NULL)
2610 return (*stackptr)->dirname;
2611 else
2612 {
2613 ds_ptr = *stackptr;
2614 *stackptr = (*stackptr)->next;
2615 vim_free(ds_ptr);
2616 return NULL;
2617 }
2618}
2619
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620/*
2621 * pop dirbuf from the directory stack and return previous directory or NULL if
2622 * stack is empty
2623 */
2624 static char_u *
Bram Moolenaar05540972016-01-30 20:31:25 +01002625qf_pop_dir(struct dir_stack_T **stackptr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002626{
2627 struct dir_stack_T *ds_ptr;
2628
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002629 // TODO: Should we check if dirbuf is the directory on top of the stack?
2630 // What to do if it isn't?
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002632 // pop top element and free it
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 if (*stackptr != NULL)
2634 {
2635 ds_ptr = *stackptr;
2636 *stackptr = (*stackptr)->next;
2637 vim_free(ds_ptr->dirname);
2638 vim_free(ds_ptr);
2639 }
2640
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002641 // return NEW top element as current dir or NULL if stack is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00002642 return *stackptr ? (*stackptr)->dirname : NULL;
2643}
2644
2645/*
2646 * clean up directory stack
2647 */
2648 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01002649qf_clean_dir_stack(struct dir_stack_T **stackptr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650{
2651 struct dir_stack_T *ds_ptr;
2652
2653 while ((ds_ptr = *stackptr) != NULL)
2654 {
2655 *stackptr = (*stackptr)->next;
2656 vim_free(ds_ptr->dirname);
2657 vim_free(ds_ptr);
2658 }
2659}
2660
2661/*
2662 * Check in which directory of the directory stack the given file can be
2663 * found.
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002664 * Returns a pointer to the directory name or NULL if not found.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 * Cleans up intermediate directory entries.
2666 *
2667 * TODO: How to solve the following problem?
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02002668 * If we have this directory tree:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 * ./
2670 * ./aa
2671 * ./aa/bb
2672 * ./bb
2673 * ./bb/x.c
2674 * and make says:
2675 * making all in aa
2676 * making all in bb
2677 * x.c:9: Error
2678 * Then qf_push_dir thinks we are in ./aa/bb, but we are in ./bb.
2679 * qf_guess_filepath will return NULL.
2680 */
2681 static char_u *
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002682qf_guess_filepath(qf_list_T *qfl, char_u *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683{
2684 struct dir_stack_T *ds_ptr;
2685 struct dir_stack_T *ds_tmp;
2686 char_u *fullname;
2687
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002688 // no dirs on the stack - there's nothing we can do
Bram Moolenaara7df8c72017-07-19 13:23:06 +02002689 if (qfl->qf_dir_stack == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 return NULL;
2691
Bram Moolenaara7df8c72017-07-19 13:23:06 +02002692 ds_ptr = qfl->qf_dir_stack->next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 fullname = NULL;
2694 while (ds_ptr)
2695 {
2696 vim_free(fullname);
2697 fullname = concat_fnames(ds_ptr->dirname, filename, TRUE);
2698
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002699 // If concat_fnames failed, just go on. The worst thing that can happen
2700 // is that we delete the entire stack.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 if ((fullname != NULL) && (mch_getperm(fullname) >= 0))
2702 break;
2703
2704 ds_ptr = ds_ptr->next;
2705 }
2706
2707 vim_free(fullname);
2708
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002709 // clean up all dirs we already left
Bram Moolenaara7df8c72017-07-19 13:23:06 +02002710 while (qfl->qf_dir_stack->next != ds_ptr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 {
Bram Moolenaara7df8c72017-07-19 13:23:06 +02002712 ds_tmp = qfl->qf_dir_stack->next;
2713 qfl->qf_dir_stack->next = qfl->qf_dir_stack->next->next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 vim_free(ds_tmp->dirname);
2715 vim_free(ds_tmp);
2716 }
2717
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02002718 return ds_ptr == NULL ? NULL : ds_ptr->dirname;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719}
2720
2721/*
Bram Moolenaar3c097222017-12-21 20:54:49 +01002722 * Returns TRUE if a quickfix/location list with the given identifier exists.
2723 */
2724 static int
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02002725qflist_valid(win_T *wp, int_u qf_id)
Bram Moolenaar3c097222017-12-21 20:54:49 +01002726{
2727 qf_info_T *qi = &ql_info;
2728 int i;
2729
2730 if (wp != NULL)
2731 {
Bram Moolenaar2c7080b2021-02-06 19:19:42 +01002732 if (!win_valid(wp))
2733 return FALSE;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002734 qi = GET_LOC_LIST(wp); // Location list
Bram Moolenaar3c097222017-12-21 20:54:49 +01002735 if (qi == NULL)
2736 return FALSE;
2737 }
2738
2739 for (i = 0; i < qi->qf_listcount; ++i)
2740 if (qi->qf_lists[i].qf_id == qf_id)
2741 return TRUE;
2742
2743 return FALSE;
2744}
2745
2746/*
Bram Moolenaar531b9a32018-07-03 16:54:23 +02002747 * When loading a file from the quickfix, the autocommands may modify it.
Bram Moolenaarffec3c52016-03-23 20:55:42 +01002748 * This may invalidate the current quickfix entry. This function checks
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02002749 * whether an entry is still present in the quickfix list.
Bram Moolenaarffec3c52016-03-23 20:55:42 +01002750 * Similar to location list.
2751 */
2752 static int
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002753is_qf_entry_present(qf_list_T *qfl, qfline_T *qf_ptr)
Bram Moolenaarffec3c52016-03-23 20:55:42 +01002754{
Bram Moolenaarffec3c52016-03-23 20:55:42 +01002755 qfline_T *qfp;
2756 int i;
2757
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002758 // Search for the entry in the current list
Bram Moolenaara16123a2019-03-28 20:31:07 +01002759 FOR_ALL_QFL_ITEMS(qfl, qfp, i)
2760 if (qfp == qf_ptr)
Bram Moolenaarffec3c52016-03-23 20:55:42 +01002761 break;
2762
Bram Moolenaar95946f12019-03-31 15:31:59 +02002763 if (i > qfl->qf_count) // Entry is not found
Bram Moolenaarffec3c52016-03-23 20:55:42 +01002764 return FALSE;
2765
2766 return TRUE;
2767}
2768
2769/*
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002770 * Get the next valid entry in the current quickfix/location list. The search
Bram Moolenaar9cb03712017-09-20 22:43:02 +02002771 * starts from the current entry. Returns NULL on failure.
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002772 */
2773 static qfline_T *
2774get_next_valid_entry(
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002775 qf_list_T *qfl,
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002776 qfline_T *qf_ptr,
2777 int *qf_index,
2778 int dir)
2779{
2780 int idx;
2781 int old_qf_fnum;
2782
2783 idx = *qf_index;
2784 old_qf_fnum = qf_ptr->qf_fnum;
2785
2786 do
2787 {
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002788 if (idx == qfl->qf_count || qf_ptr->qf_next == NULL)
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002789 return NULL;
2790 ++idx;
2791 qf_ptr = qf_ptr->qf_next;
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002792 } while ((!qfl->qf_nonevalid && !qf_ptr->qf_valid)
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002793 || (dir == FORWARD_FILE && qf_ptr->qf_fnum == old_qf_fnum));
2794
2795 *qf_index = idx;
2796 return qf_ptr;
2797}
2798
2799/*
2800 * Get the previous valid entry in the current quickfix/location list. The
Bram Moolenaar9cb03712017-09-20 22:43:02 +02002801 * search starts from the current entry. Returns NULL on failure.
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002802 */
2803 static qfline_T *
2804get_prev_valid_entry(
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002805 qf_list_T *qfl,
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002806 qfline_T *qf_ptr,
2807 int *qf_index,
2808 int dir)
2809{
2810 int idx;
2811 int old_qf_fnum;
2812
2813 idx = *qf_index;
2814 old_qf_fnum = qf_ptr->qf_fnum;
2815
2816 do
2817 {
2818 if (idx == 1 || qf_ptr->qf_prev == NULL)
2819 return NULL;
2820 --idx;
2821 qf_ptr = qf_ptr->qf_prev;
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002822 } while ((!qfl->qf_nonevalid && !qf_ptr->qf_valid)
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002823 || (dir == BACKWARD_FILE && qf_ptr->qf_fnum == old_qf_fnum));
2824
2825 *qf_index = idx;
2826 return qf_ptr;
2827}
2828
2829/*
2830 * Get the n'th (errornr) previous/next valid entry from the current entry in
2831 * the quickfix list.
2832 * dir == FORWARD or FORWARD_FILE: next valid entry
2833 * dir == BACKWARD or BACKWARD_FILE: previous valid entry
2834 */
2835 static qfline_T *
2836get_nth_valid_entry(
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002837 qf_list_T *qfl,
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002838 int errornr,
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002839 int dir,
2840 int *new_qfidx)
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002841{
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002842 qfline_T *qf_ptr = qfl->qf_ptr;
2843 int qf_idx = qfl->qf_index;
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002844 qfline_T *prev_qf_ptr;
2845 int prev_index;
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00002846 char *err = e_no_more_items;
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002847
2848 while (errornr--)
2849 {
2850 prev_qf_ptr = qf_ptr;
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002851 prev_index = qf_idx;
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002852
2853 if (dir == FORWARD || dir == FORWARD_FILE)
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002854 qf_ptr = get_next_valid_entry(qfl, qf_ptr, &qf_idx, dir);
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002855 else
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002856 qf_ptr = get_prev_valid_entry(qfl, qf_ptr, &qf_idx, dir);
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002857 if (qf_ptr == NULL)
2858 {
2859 qf_ptr = prev_qf_ptr;
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002860 qf_idx = prev_index;
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002861 if (err != NULL)
2862 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002863 emsg(_(err));
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002864 return NULL;
2865 }
2866 break;
2867 }
2868
2869 err = NULL;
2870 }
2871
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002872 *new_qfidx = qf_idx;
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002873 return qf_ptr;
2874}
2875
2876/*
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002877 * Get n'th (errornr) quickfix entry from the current entry in the quickfix
2878 * list 'qfl'. Returns a pointer to the new entry and the index in 'new_qfidx'
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002879 */
2880 static qfline_T *
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002881get_nth_entry(qf_list_T *qfl, int errornr, int *new_qfidx)
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002882{
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002883 qfline_T *qf_ptr = qfl->qf_ptr;
2884 int qf_idx = qfl->qf_index;
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002885
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002886 // New error number is less than the current error number
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002887 while (errornr < qf_idx && qf_idx > 1 && qf_ptr->qf_prev != NULL)
2888 {
2889 --qf_idx;
2890 qf_ptr = qf_ptr->qf_prev;
2891 }
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002892 // New error number is greater than the current error number
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02002893 while (errornr > qf_idx && qf_idx < qfl->qf_count &&
2894 qf_ptr->qf_next != NULL)
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002895 {
2896 ++qf_idx;
2897 qf_ptr = qf_ptr->qf_next;
2898 }
2899
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002900 *new_qfidx = qf_idx;
2901 return qf_ptr;
2902}
2903
2904/*
Bram Moolenaar4b96df52020-01-26 22:00:26 +01002905 * Get a entry specified by 'errornr' and 'dir' from the current
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02002906 * quickfix/location list. 'errornr' specifies the index of the entry and 'dir'
2907 * specifies the direction (FORWARD/BACKWARD/FORWARD_FILE/BACKWARD_FILE).
2908 * Returns a pointer to the entry and the index of the new entry is stored in
2909 * 'new_qfidx'.
2910 */
2911 static qfline_T *
2912qf_get_entry(
2913 qf_list_T *qfl,
2914 int errornr,
2915 int dir,
2916 int *new_qfidx)
2917{
2918 qfline_T *qf_ptr = qfl->qf_ptr;
2919 int qfidx = qfl->qf_index;
2920
2921 if (dir != 0) // next/prev valid entry
2922 qf_ptr = get_nth_valid_entry(qfl, errornr, dir, &qfidx);
2923 else if (errornr != 0) // go to specified number
2924 qf_ptr = get_nth_entry(qfl, errornr, &qfidx);
2925
2926 *new_qfidx = qfidx;
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002927 return qf_ptr;
2928}
2929
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002930/*
Yegappan Lakshmanan78a61062021-12-08 20:03:31 +00002931 * Find a window displaying a Vim help file in the current tab page.
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02002932 */
2933 static win_T *
2934qf_find_help_win(void)
2935{
2936 win_T *wp;
2937
2938 FOR_ALL_WINDOWS(wp)
2939 if (bt_help(wp->w_buffer))
2940 return wp;
2941
2942 return NULL;
2943}
2944
2945/*
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01002946 * Set the location list for the specified window to 'qi'.
2947 */
2948 static void
2949win_set_loclist(win_T *wp, qf_info_T *qi)
2950{
2951 wp->w_llist = qi;
2952 qi->qf_refcount++;
2953}
2954
2955/*
Bram Moolenaarb2443732018-11-11 22:50:27 +01002956 * Find a help window or open one. If 'newwin' is TRUE, then open a new help
2957 * window.
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002958 */
2959 static int
Bram Moolenaarb2443732018-11-11 22:50:27 +01002960jump_to_help_window(qf_info_T *qi, int newwin, int *opened_window)
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002961{
2962 win_T *wp;
2963 int flags;
2964
Bram Moolenaare1004402020-10-24 20:49:43 +02002965 if (cmdmod.cmod_tab != 0 || newwin)
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002966 wp = NULL;
2967 else
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02002968 wp = qf_find_help_win();
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002969 if (wp != NULL && wp->w_buffer->b_nwindows > 0)
2970 win_enter(wp, TRUE);
2971 else
2972 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02002973 // Split off help window; put it at far top if no position
2974 // specified, the current window is vertically split and narrow.
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002975 flags = WSP_HELP;
Bram Moolenaare1004402020-10-24 20:49:43 +02002976 if (cmdmod.cmod_split == 0 && curwin->w_width != Columns
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002977 && curwin->w_width < 80)
2978 flags |= WSP_TOP;
Bram Moolenaarb2443732018-11-11 22:50:27 +01002979 // If the user asks to open a new window, then copy the location list.
2980 // Otherwise, don't copy the location list.
2981 if (IS_LL_STACK(qi) && !newwin)
2982 flags |= WSP_NEWLOC;
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002983
2984 if (win_split(0, flags) == FAIL)
2985 return FAIL;
2986
2987 *opened_window = TRUE;
2988
2989 if (curwin->w_height < p_hh)
2990 win_setheight((int)p_hh);
2991
Bram Moolenaarb2443732018-11-11 22:50:27 +01002992 // When using location list, the new window should use the supplied
2993 // location list. If the user asks to open a new window, then the new
2994 // window will get a copy of the location list.
2995 if (IS_LL_STACK(qi) && !newwin)
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01002996 win_set_loclist(curwin, qi);
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02002997 }
2998
2999 if (!p_im)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003000 restart_edit = 0; // don't want insert mode in help file
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02003001
3002 return OK;
3003}
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02003004
3005/*
Yegappan Lakshmanan78a61062021-12-08 20:03:31 +00003006 * Find a non-quickfix window using the given location list stack in the
3007 * current tabpage.
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003008 * Returns NULL if a matching window is not found.
3009 */
3010 static win_T *
3011qf_find_win_with_loclist(qf_info_T *ll)
3012{
3013 win_T *wp;
3014
3015 FOR_ALL_WINDOWS(wp)
3016 if (wp->w_llist == ll && !bt_quickfix(wp->w_buffer))
3017 return wp;
3018
3019 return NULL;
3020}
3021
3022/*
Yegappan Lakshmanan78a61062021-12-08 20:03:31 +00003023 * Find a window containing a normal buffer in the current tab page.
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003024 */
3025 static win_T *
3026qf_find_win_with_normal_buf(void)
3027{
3028 win_T *wp;
3029
3030 FOR_ALL_WINDOWS(wp)
Bram Moolenaar91335e52018-08-01 17:53:12 +02003031 if (bt_normal(wp->w_buffer))
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003032 return wp;
3033
3034 return NULL;
3035}
3036
3037/*
3038 * Go to a window in any tabpage containing the specified file. Returns TRUE
3039 * if successfully jumped to the window. Otherwise returns FALSE.
3040 */
3041 static int
3042qf_goto_tabwin_with_file(int fnum)
3043{
3044 tabpage_T *tp;
3045 win_T *wp;
3046
3047 FOR_ALL_TAB_WINDOWS(tp, wp)
3048 if (wp->w_buffer->b_fnum == fnum)
3049 {
3050 goto_tabpage_win(tp, wp);
3051 return TRUE;
3052 }
3053
3054 return FALSE;
3055}
3056
3057/*
3058 * Create a new window to show a file above the quickfix window. Called when
3059 * only the quickfix window is present.
3060 */
3061 static int
3062qf_open_new_file_win(qf_info_T *ll_ref)
3063{
3064 int flags;
3065
3066 flags = WSP_ABOVE;
3067 if (ll_ref != NULL)
3068 flags |= WSP_NEWLOC;
3069 if (win_split(0, flags) == FAIL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003070 return FAIL; // not enough room for window
3071 p_swb = empty_option; // don't split again
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003072 swb_flags = 0;
3073 RESET_BINDING(curwin);
3074 if (ll_ref != NULL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003075 // The new window should use the location list from the
3076 // location list window
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01003077 win_set_loclist(curwin, ll_ref);
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003078 return OK;
3079}
3080
3081/*
3082 * Go to a window that shows the right buffer. If the window is not found, go
3083 * to the window just above the location list window. This is used for opening
3084 * a file from a location window and not from a quickfix window. If some usable
3085 * window is previously found, then it is supplied in 'use_win'.
3086 */
3087 static void
3088qf_goto_win_with_ll_file(win_T *use_win, int qf_fnum, qf_info_T *ll_ref)
3089{
3090 win_T *win = use_win;
3091
3092 if (win == NULL)
3093 {
Yegappan Lakshmanan78a61062021-12-08 20:03:31 +00003094 // Find the window showing the selected file in the current tab page.
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003095 FOR_ALL_WINDOWS(win)
3096 if (win->w_buffer->b_fnum == qf_fnum)
3097 break;
3098 if (win == NULL)
3099 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003100 // Find a previous usable window
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003101 win = curwin;
3102 do
3103 {
Bram Moolenaar91335e52018-08-01 17:53:12 +02003104 if (bt_normal(win->w_buffer))
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003105 break;
3106 if (win->w_prev == NULL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003107 win = lastwin; // wrap around the top
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003108 else
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003109 win = win->w_prev; // go to previous window
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003110 } while (win != curwin);
3111 }
3112 }
3113 win_goto(win);
3114
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003115 // If the location list for the window is not set, then set it
3116 // to the location list from the location window
Bram Moolenaar0398e002019-03-21 21:12:49 +01003117 if (win->w_llist == NULL && ll_ref != NULL)
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01003118 win_set_loclist(win, ll_ref);
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003119}
3120
3121/*
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003122 * Go to a window that contains the specified buffer 'qf_fnum'. If a window is
3123 * not found, then go to the window just above the quickfix window. This is
3124 * used for opening a file from a quickfix window and not from a location
3125 * window.
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003126 */
3127 static void
3128qf_goto_win_with_qfl_file(int qf_fnum)
3129{
3130 win_T *win;
3131 win_T *altwin;
3132
3133 win = curwin;
3134 altwin = NULL;
3135 for (;;)
3136 {
3137 if (win->w_buffer->b_fnum == qf_fnum)
3138 break;
3139 if (win->w_prev == NULL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003140 win = lastwin; // wrap around the top
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003141 else
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003142 win = win->w_prev; // go to previous window
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003143
3144 if (IS_QF_WINDOW(win))
3145 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003146 // Didn't find it, go to the window before the quickfix
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01003147 // window, unless 'switchbuf' contains 'uselast': in this case we
3148 // try to jump to the previously used window first.
3149 if ((swb_flags & SWB_USELAST) && win_valid(prevwin))
3150 win = prevwin;
3151 else if (altwin != NULL)
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003152 win = altwin;
3153 else if (curwin->w_prev != NULL)
3154 win = curwin->w_prev;
3155 else
3156 win = curwin->w_next;
3157 break;
3158 }
3159
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003160 // Remember a usable window.
Bram Moolenaar91335e52018-08-01 17:53:12 +02003161 if (altwin == NULL && !win->w_p_pvw && bt_normal(win->w_buffer))
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003162 altwin = win;
3163 }
3164
3165 win_goto(win);
3166}
3167
3168/*
3169 * Find a suitable window for opening a file (qf_fnum) from the
3170 * quickfix/location list and jump to it. If the file is already opened in a
Bram Moolenaarb2443732018-11-11 22:50:27 +01003171 * window, jump to it. Otherwise open a new window to display the file. If
3172 * 'newwin' is TRUE, then always open a new window. This is called from either
3173 * a quickfix or a location list window.
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003174 */
3175 static int
Bram Moolenaarb2443732018-11-11 22:50:27 +01003176qf_jump_to_usable_window(int qf_fnum, int newwin, int *opened_window)
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003177{
Bram Moolenaarf9ae1542019-11-18 22:02:16 +01003178 win_T *usable_wp = NULL;
3179 int usable_win = FALSE;
Bram Moolenaarb2443732018-11-11 22:50:27 +01003180 qf_info_T *ll_ref = NULL;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003181
Bram Moolenaarb2443732018-11-11 22:50:27 +01003182 // If opening a new window, then don't use the location list referred by
3183 // the current window. Otherwise two windows will refer to the same
3184 // location list.
3185 if (!newwin)
3186 ll_ref = curwin->w_llist_ref;
3187
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003188 if (ll_ref != NULL)
3189 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003190 // Find a non-quickfix window with this location list
Bram Moolenaarf9ae1542019-11-18 22:02:16 +01003191 usable_wp = qf_find_win_with_loclist(ll_ref);
3192 if (usable_wp != NULL)
3193 usable_win = TRUE;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003194 }
3195
3196 if (!usable_win)
3197 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003198 // Locate a window showing a normal buffer
Bram Moolenaarf9ae1542019-11-18 22:02:16 +01003199 win_T *win = qf_find_win_with_normal_buf();
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003200 if (win != NULL)
Bram Moolenaarf9ae1542019-11-18 22:02:16 +01003201 usable_win = TRUE;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003202 }
3203
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003204 // If no usable window is found and 'switchbuf' contains "usetab"
3205 // then search in other tabs.
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003206 if (!usable_win && (swb_flags & SWB_USETAB))
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003207 usable_win = qf_goto_tabwin_with_file(qf_fnum);
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003208
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003209 // If there is only one window and it is the quickfix window, create a
3210 // new one above the quickfix window.
Bram Moolenaarb2443732018-11-11 22:50:27 +01003211 if ((ONE_WINDOW && bt_quickfix(curbuf)) || !usable_win || newwin)
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003212 {
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003213 if (qf_open_new_file_win(ll_ref) != OK)
3214 return FAIL;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003215 *opened_window = TRUE; // close it when fail
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003216 }
3217 else
3218 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003219 if (curwin->w_llist_ref != NULL) // In a location window
Bram Moolenaarf9ae1542019-11-18 22:02:16 +01003220 qf_goto_win_with_ll_file(usable_wp, qf_fnum, ll_ref);
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003221 else // In a quickfix window
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003222 qf_goto_win_with_qfl_file(qf_fnum);
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003223 }
3224
3225 return OK;
3226}
3227
3228/*
3229 * Edit the selected file or help file.
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003230 * Returns OK if successfully edited the file, FAIL on failing to open the
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003231 * buffer and QF_ABORT if the quickfix/location list was freed by an autocmd
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003232 * when opening the buffer.
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003233 */
3234 static int
3235qf_jump_edit_buffer(
3236 qf_info_T *qi,
3237 qfline_T *qf_ptr,
3238 int forceit,
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003239 int prev_winid,
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003240 int *opened_window)
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003241{
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01003242 qf_list_T *qfl = qf_get_curlist(qi);
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003243 int old_changedtick = qfl->qf_changedtick;
Bram Moolenaar2d67d302018-11-16 18:46:02 +01003244 qfltype_T qfl_type = qfl->qfl_type;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003245 int retval = OK;
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003246 int old_qf_curlist = qi->qf_curlist;
3247 int save_qfid = qfl->qf_id;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003248
3249 if (qf_ptr->qf_type == 1)
3250 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003251 // Open help file (do_ecmd() will set b_help flag, readfile() will
3252 // set b_p_ro flag).
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003253 if (!can_abandon(curbuf, forceit))
3254 {
3255 no_write_message();
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003256 return FAIL;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003257 }
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003258
3259 retval = do_ecmd(qf_ptr->qf_fnum, NULL, NULL, NULL, (linenr_T)1,
3260 ECMD_HIDE + ECMD_SET_HELP,
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003261 prev_winid == curwin->w_id ? curwin : NULL);
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003262 }
3263 else
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003264 retval = buflist_getfile(qf_ptr->qf_fnum,
3265 (linenr_T)1, GETF_SETMARK | GETF_SWITCH, forceit);
Bram Moolenaar3c097222017-12-21 20:54:49 +01003266
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003267 // If a location list, check whether the associated window is still
3268 // present.
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003269 if (qfl_type == QFLT_LOCATION)
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003270 {
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003271 win_T *wp = win_id2wp(prev_winid);
Bram Moolenaarb4ad3b02022-03-30 10:57:45 +01003272
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003273 if (wp == NULL && curwin->w_llist != qi)
3274 {
Bram Moolenaard82a47d2022-01-05 20:24:39 +00003275 emsg(_(e_current_window_was_closed));
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003276 *opened_window = FALSE;
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003277 return QF_ABORT;
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003278 }
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003279 }
3280
Bram Moolenaar2d67d302018-11-16 18:46:02 +01003281 if (qfl_type == QFLT_QUICKFIX && !qflist_valid(NULL, save_qfid))
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003282 {
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003283 emsg(_(e_current_quickfix_list_was_changed));
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003284 return QF_ABORT;
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003285 }
3286
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003287 // Check if the list was changed. The pointers may happen to be identical,
3288 // thus also check qf_changedtick.
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003289 if (old_qf_curlist != qi->qf_curlist
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003290 || old_changedtick != qfl->qf_changedtick
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003291 || !is_qf_entry_present(qfl, qf_ptr))
3292 {
Bram Moolenaar2d67d302018-11-16 18:46:02 +01003293 if (qfl_type == QFLT_QUICKFIX)
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003294 emsg(_(e_current_quickfix_list_was_changed));
Bram Moolenaarb6f14802018-10-21 18:47:43 +02003295 else
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003296 emsg(_(e_current_location_list_was_changed));
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003297 return QF_ABORT;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003298 }
3299
3300 return retval;
3301}
3302
3303/*
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02003304 * Go to the error line in the current file using either line/column number or
3305 * a search pattern.
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003306 */
3307 static void
3308qf_jump_goto_line(
3309 linenr_T qf_lnum,
3310 int qf_col,
3311 char_u qf_viscol,
3312 char_u *qf_pattern)
3313{
3314 linenr_T i;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003315
3316 if (qf_pattern == NULL)
3317 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003318 // Go to line with error, unless qf_lnum is 0.
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003319 i = qf_lnum;
3320 if (i > 0)
3321 {
3322 if (i > curbuf->b_ml.ml_line_count)
3323 i = curbuf->b_ml.ml_line_count;
3324 curwin->w_cursor.lnum = i;
3325 }
3326 if (qf_col > 0)
3327 {
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003328 curwin->w_cursor.coladd = 0;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003329 if (qf_viscol == TRUE)
Bram Moolenaarc45eb772019-01-31 14:27:04 +01003330 coladvance(qf_col - 1);
3331 else
3332 curwin->w_cursor.col = qf_col - 1;
Bram Moolenaar2dfcef42018-08-15 22:29:51 +02003333 curwin->w_set_curswant = TRUE;
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003334 check_cursor();
3335 }
3336 else
3337 beginline(BL_WHITE | BL_FIX);
3338 }
3339 else
3340 {
3341 pos_T save_cursor;
3342
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003343 // Move the cursor to the first line in the buffer
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003344 save_cursor = curwin->w_cursor;
3345 curwin->w_cursor.lnum = 0;
Bram Moolenaarc036e872020-02-21 21:30:52 +01003346 if (!do_search(NULL, '/', '/', qf_pattern, (long)1, SEARCH_KEEP, NULL))
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003347 curwin->w_cursor = save_cursor;
3348 }
3349}
3350
3351/*
3352 * Display quickfix list index and size message
3353 */
3354 static void
3355qf_jump_print_msg(
3356 qf_info_T *qi,
3357 int qf_index,
3358 qfline_T *qf_ptr,
3359 buf_T *old_curbuf,
3360 linenr_T old_lnum)
3361{
3362 linenr_T i;
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003363 garray_T *gap;
3364
3365 gap = qfga_get();
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003366
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003367 // Update the screen before showing the message, unless the screen
3368 // scrolled up.
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003369 if (!msg_scrolled)
3370 update_topline_redraw();
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003371 vim_snprintf((char *)IObuff, IOSIZE, _("(%d of %d)%s%s: "), qf_index,
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01003372 qf_get_curlist(qi)->qf_count,
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003373 qf_ptr->qf_cleared ? _(" (line deleted)") : "",
3374 (char *)qf_types(qf_ptr->qf_type, qf_ptr->qf_nr));
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003375 // Add the message, skipping leading whitespace and newlines.
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003376 ga_concat(gap, IObuff);
3377 qf_fmt_text(gap, skipwhite(qf_ptr->qf_text));
Shane Harper5bf04282023-06-07 19:09:57 +01003378 ga_append(gap, NUL);
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003379
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003380 // Output the message. Overwrite to avoid scrolling when the 'O'
3381 // flag is present in 'shortmess'; But when not jumping, print the
3382 // whole message.
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003383 i = msg_scroll;
3384 if (curbuf == old_curbuf && curwin->w_cursor.lnum == old_lnum)
3385 msg_scroll = TRUE;
3386 else if (!msg_scrolled && shortmess(SHM_OVERALL))
3387 msg_scroll = FALSE;
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003388 msg_attr_keep((char *)gap->ga_data, 0, TRUE);
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003389 msg_scroll = i;
Yegappan Lakshmanand8cd6f72022-10-16 11:30:48 +01003390
3391 qfga_clear();
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003392}
3393
3394/*
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003395 * Find a usable window for opening a file from the quickfix/location list. If
Bram Moolenaarb2443732018-11-11 22:50:27 +01003396 * a window is not found then open a new window. If 'newwin' is TRUE, then open
3397 * a new window.
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003398 * Returns OK if successfully jumped or opened a window. Returns FAIL if not
3399 * able to jump/open a window. Returns NOTDONE if a file is not associated
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003400 * with the entry. Returns QF_ABORT if the quickfix/location list was modified
3401 * by an autocmd.
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003402 */
3403 static int
Bram Moolenaarb2443732018-11-11 22:50:27 +01003404qf_jump_open_window(
3405 qf_info_T *qi,
3406 qfline_T *qf_ptr,
3407 int newwin,
3408 int *opened_window)
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003409{
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003410 qf_list_T *qfl = qf_get_curlist(qi);
3411 int old_changedtick = qfl->qf_changedtick;
3412 int old_qf_curlist = qi->qf_curlist;
3413 qfltype_T qfl_type = qfl->qfl_type;
3414
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003415 // For ":helpgrep" find a help window or open one.
Bram Moolenaare1004402020-10-24 20:49:43 +02003416 if (qf_ptr->qf_type == 1 && (!bt_help(curwin->w_buffer)
3417 || cmdmod.cmod_tab != 0))
Bram Moolenaarb2443732018-11-11 22:50:27 +01003418 if (jump_to_help_window(qi, newwin, opened_window) == FAIL)
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003419 return FAIL;
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003420 if (old_qf_curlist != qi->qf_curlist
3421 || old_changedtick != qfl->qf_changedtick
3422 || !is_qf_entry_present(qfl, qf_ptr))
3423 {
3424 if (qfl_type == QFLT_QUICKFIX)
3425 emsg(_(e_current_quickfix_list_was_changed));
3426 else
3427 emsg(_(e_current_location_list_was_changed));
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003428 return QF_ABORT;
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003429 }
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003430
3431 // If currently in the quickfix window, find another window to show the
3432 // file in.
3433 if (bt_quickfix(curbuf) && !*opened_window)
3434 {
3435 // If there is no file specified, we don't know where to go.
3436 // But do advance, otherwise ":cn" gets stuck.
3437 if (qf_ptr->qf_fnum == 0)
3438 return NOTDONE;
3439
Bram Moolenaarb2443732018-11-11 22:50:27 +01003440 if (qf_jump_to_usable_window(qf_ptr->qf_fnum, newwin,
3441 opened_window) == FAIL)
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003442 return FAIL;
3443 }
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003444 if (old_qf_curlist != qi->qf_curlist
3445 || old_changedtick != qfl->qf_changedtick
3446 || !is_qf_entry_present(qfl, qf_ptr))
3447 {
3448 if (qfl_type == QFLT_QUICKFIX)
3449 emsg(_(e_current_quickfix_list_was_changed));
3450 else
3451 emsg(_(e_current_location_list_was_changed));
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003452 return QF_ABORT;
Bram Moolenaar4d170af2020-09-13 22:21:22 +02003453 }
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003454
3455 return OK;
3456}
3457
3458/*
3459 * Edit a selected file from the quickfix/location list and jump to a
3460 * particular line/column, adjust the folds and display a message about the
3461 * jump.
3462 * Returns OK on success and FAIL on failing to open the file/buffer. Returns
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003463 * QF_ABORT if the quickfix/location list is freed by an autocmd when opening
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003464 * the file.
3465 */
3466 static int
3467qf_jump_to_buffer(
3468 qf_info_T *qi,
3469 int qf_index,
3470 qfline_T *qf_ptr,
3471 int forceit,
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003472 int prev_winid,
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003473 int *opened_window,
3474 int openfold,
3475 int print_message)
3476{
3477 buf_T *old_curbuf;
3478 linenr_T old_lnum;
3479 int retval = OK;
3480
3481 // If there is a file name, read the wanted file if needed, and check
3482 // autowrite etc.
3483 old_curbuf = curbuf;
3484 old_lnum = curwin->w_cursor.lnum;
3485
3486 if (qf_ptr->qf_fnum != 0)
3487 {
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003488 retval = qf_jump_edit_buffer(qi, qf_ptr, forceit, prev_winid,
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003489 opened_window);
3490 if (retval != OK)
3491 return retval;
3492 }
3493
3494 // When not switched to another buffer, still need to set pc mark
3495 if (curbuf == old_curbuf)
3496 setpcmark();
3497
3498 qf_jump_goto_line(qf_ptr->qf_lnum, qf_ptr->qf_col, qf_ptr->qf_viscol,
3499 qf_ptr->qf_pattern);
3500
3501#ifdef FEAT_FOLDING
3502 if ((fdo_flags & FDO_QUICKFIX) && openfold)
3503 foldOpenCursor();
3504#endif
3505 if (print_message)
3506 qf_jump_print_msg(qi, qf_index, qf_ptr, old_curbuf, old_lnum);
3507
3508 return retval;
3509}
3510
3511/*
Bram Moolenaar5b69c222019-01-11 14:50:06 +01003512 * Jump to a quickfix line and try to use an existing window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 */
3514 void
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02003515qf_jump(qf_info_T *qi,
3516 int dir,
3517 int errornr,
3518 int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519{
Bram Moolenaarb2443732018-11-11 22:50:27 +01003520 qf_jump_newwin(qi, dir, errornr, forceit, FALSE);
3521}
3522
3523/*
Bram Moolenaar5b69c222019-01-11 14:50:06 +01003524 * Jump to a quickfix line.
3525 * If dir == 0 go to entry "errornr".
3526 * If dir == FORWARD go "errornr" valid entries forward.
3527 * If dir == BACKWARD go "errornr" valid entries backward.
3528 * If dir == FORWARD_FILE go "errornr" valid entries files backward.
3529 * If dir == BACKWARD_FILE go "errornr" valid entries files backward
3530 * else if "errornr" is zero, redisplay the same line
3531 * If 'forceit' is TRUE, then can discard changes to the current buffer.
Bram Moolenaarb2443732018-11-11 22:50:27 +01003532 * If 'newwin' is TRUE, then open the file in a new window.
3533 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02003534 static void
Bram Moolenaarb2443732018-11-11 22:50:27 +01003535qf_jump_newwin(qf_info_T *qi,
3536 int dir,
3537 int errornr,
3538 int forceit,
3539 int newwin)
3540{
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003541 qf_list_T *qfl;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00003542 qfline_T *qf_ptr;
3543 qfline_T *old_qf_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 int qf_index;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 int old_qf_index;
Bram Moolenaar71fe80d2006-01-22 23:25:56 +00003546 char_u *old_swb = p_swb;
Bram Moolenaar446cb832008-06-24 21:56:24 +00003547 unsigned old_swb_flags = swb_flags;
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003548 int prev_winid;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549 int opened_window = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 int print_message = TRUE;
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003551 int old_KeyTyped = KeyTyped; // getting file may reset it
Bram Moolenaar9cb03712017-09-20 22:43:02 +02003552 int retval = OK;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00003554 if (qi == NULL)
3555 qi = &ql_info;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003556
Bram Moolenaar0398e002019-03-21 21:12:49 +01003557 if (qf_stack_empty(qi) || qf_list_empty(qf_get_curlist(qi)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003558 {
Bram Moolenaare29a27f2021-07-20 21:07:36 +02003559 emsg(_(e_no_errors));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 return;
3561 }
3562
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003563 incr_quickfix_busy();
3564
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01003565 qfl = qf_get_curlist(qi);
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003566
3567 qf_ptr = qfl->qf_ptr;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 old_qf_ptr = qf_ptr;
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003569 qf_index = qfl->qf_index;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 old_qf_index = qf_index;
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003571
3572 qf_ptr = qf_get_entry(qfl, errornr, dir, &qf_index);
3573 if (qf_ptr == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 {
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003575 qf_ptr = old_qf_ptr;
3576 qf_index = old_qf_index;
3577 goto theend;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003580 qfl->qf_index = qf_index;
Wei-Chung Wen1557b162021-07-15 13:13:39 +02003581 qfl->qf_ptr = qf_ptr;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003582 if (qf_win_pos_update(qi, old_qf_index))
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003583 // No need to print the error message if it's visible in the error
3584 // window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003585 print_message = FALSE;
3586
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003587 prev_winid = curwin->w_id;
3588
Bram Moolenaarb2443732018-11-11 22:50:27 +01003589 retval = qf_jump_open_window(qi, qf_ptr, newwin, &opened_window);
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003590 if (retval == FAIL)
3591 goto failed;
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003592 if (retval == QF_ABORT)
3593 {
3594 qi = NULL;
3595 qf_ptr = NULL;
3596 goto theend;
3597 }
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003598 if (retval == NOTDONE)
3599 goto theend;
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00003600
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003601 retval = qf_jump_to_buffer(qi, qf_index, qf_ptr, forceit, prev_winid,
Bram Moolenaard570ab92019-09-03 23:20:05 +02003602 &opened_window, old_KeyTyped, print_message);
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003603 if (retval == QF_ABORT)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 {
Yegappan Lakshmanan6d24a512022-08-27 20:59:57 +01003605 // Quickfix/location list was modified by an autocmd
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003606 qi = NULL;
3607 qf_ptr = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003608 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003610 if (retval != OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 if (opened_window)
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003613 win_close(curwin, TRUE); // Close opened window
Bram Moolenaar0899d692016-03-19 13:35:03 +01003614 if (qf_ptr != NULL && qf_ptr->qf_fnum != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 {
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003616 // Couldn't open file, so put index back where it was. This could
3617 // happen if the file was readonly and we changed something.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618failed:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003619 qf_ptr = old_qf_ptr;
3620 qf_index = old_qf_index;
3621 }
3622 }
3623theend:
Bram Moolenaar0899d692016-03-19 13:35:03 +01003624 if (qi != NULL)
3625 {
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003626 qfl->qf_ptr = qf_ptr;
3627 qfl->qf_index = qf_index;
Bram Moolenaar0899d692016-03-19 13:35:03 +01003628 }
Bram Moolenaarf9ae1542019-11-18 22:02:16 +01003629 if (p_swb != old_swb && p_swb == empty_option)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003630 {
Bram Moolenaar6dae96e2018-09-24 21:50:12 +02003631 // Restore old 'switchbuf' value, but not when an autocommand or
3632 // modeline has changed the value.
Bram Moolenaarf9ae1542019-11-18 22:02:16 +01003633 p_swb = old_swb;
3634 swb_flags = old_swb_flags;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635 }
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01003636 decr_quickfix_busy();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003637}
3638
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003639// Highlight attributes used for displaying entries from the quickfix list.
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003640static int qfFileAttr;
3641static int qfSepAttr;
3642static int qfLineAttr;
3643
3644/*
3645 * Display information about a single entry from the quickfix/location list.
3646 * Used by ":clist/:llist" commands.
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003647 * 'cursel' will be set to TRUE for the currently selected entry in the
3648 * quickfix list.
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003649 */
3650 static void
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003651qf_list_entry(qfline_T *qfp, int qf_idx, int cursel)
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003652{
3653 char_u *fname;
3654 buf_T *buf;
3655 int filter_entry;
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003656 garray_T *gap;
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003657
3658 fname = NULL;
3659 if (qfp->qf_module != NULL && *qfp->qf_module != NUL)
3660 vim_snprintf((char *)IObuff, IOSIZE, "%2d %s", qf_idx,
3661 (char *)qfp->qf_module);
Bram Moolenaarebfec1c2023-01-22 21:14:53 +00003662 else
3663 {
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003664 if (qfp->qf_fnum != 0
3665 && (buf = buflist_findnr(qfp->qf_fnum)) != NULL)
3666 {
3667 fname = buf->b_fname;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003668 if (qfp->qf_type == 1) // :helpgrep
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003669 fname = gettail(fname);
3670 }
3671 if (fname == NULL)
3672 sprintf((char *)IObuff, "%2d", qf_idx);
3673 else
3674 vim_snprintf((char *)IObuff, IOSIZE, "%2d %s",
3675 qf_idx, (char *)fname);
3676 }
3677
3678 // Support for filtering entries using :filter /pat/ clist
3679 // Match against the module name, file name, search pattern and
3680 // text of the entry.
3681 filter_entry = TRUE;
3682 if (qfp->qf_module != NULL && *qfp->qf_module != NUL)
3683 filter_entry &= message_filtered(qfp->qf_module);
3684 if (filter_entry && fname != NULL)
3685 filter_entry &= message_filtered(fname);
3686 if (filter_entry && qfp->qf_pattern != NULL)
3687 filter_entry &= message_filtered(qfp->qf_pattern);
3688 if (filter_entry)
3689 filter_entry &= message_filtered(qfp->qf_text);
3690 if (filter_entry)
3691 return;
3692
3693 msg_putchar('\n');
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003694 msg_outtrans_attr(IObuff, cursel ? HL_ATTR(HLF_QFL) : qfFileAttr);
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003695
3696 if (qfp->qf_lnum != 0)
Bram Moolenaar32526b32019-01-19 17:43:09 +01003697 msg_puts_attr(":", qfSepAttr);
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003698 gap = qfga_get();
Shane Harper5bf04282023-06-07 19:09:57 +01003699 if (qfp->qf_lnum != 0)
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003700 qf_range_text(gap, qfp);
3701 ga_concat(gap, qf_types(qfp->qf_type, qfp->qf_nr));
3702 ga_append(gap, NUL);
3703 msg_puts_attr((char *)gap->ga_data, qfLineAttr);
Bram Moolenaar32526b32019-01-19 17:43:09 +01003704 msg_puts_attr(":", qfSepAttr);
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003705 if (qfp->qf_pattern != NULL)
3706 {
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003707 gap = qfga_get();
3708 qf_fmt_text(gap, qfp->qf_pattern);
Shane Harper5bf04282023-06-07 19:09:57 +01003709 ga_append(gap, NUL);
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003710 msg_puts((char *)gap->ga_data);
Bram Moolenaar32526b32019-01-19 17:43:09 +01003711 msg_puts_attr(":", qfSepAttr);
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003712 }
Bram Moolenaar32526b32019-01-19 17:43:09 +01003713 msg_puts(" ");
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003714
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003715 // Remove newlines and leading whitespace from the text. For an
3716 // unrecognized line keep the indent, the compiler may mark a word
3717 // with ^^^^.
3718 gap = qfga_get();
3719 qf_fmt_text(gap, (fname != NULL || qfp->qf_lnum != 0)
Shane Harper5bf04282023-06-07 19:09:57 +01003720 ? skipwhite(qfp->qf_text) : qfp->qf_text);
3721 ga_append(gap, NUL);
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01003722 msg_prt_line((char_u *)gap->ga_data, FALSE);
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003723 out_flush(); // show one line at a time
Bram Moolenaarde3b3672018-08-07 21:54:41 +02003724}
3725
3726/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003727 * ":clist": list all errors
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003728 * ":llist": list all locations
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 */
3730 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003731qf_list(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732{
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003733 qf_list_T *qfl;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00003734 qfline_T *qfp;
3735 int i;
3736 int idx1 = 1;
3737 int idx2 = -1;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00003738 char_u *arg = eap->arg;
Bram Moolenaare8fea072016-07-01 14:48:27 +02003739 int plus = FALSE;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003740 int all = eap->forceit; // if not :cl!, only show
3741 // recognised errors
Bram Moolenaar87f59b02019-04-04 14:04:11 +02003742 qf_info_T *qi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743
Bram Moolenaar87f59b02019-04-04 14:04:11 +02003744 if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
3745 return;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003746
Bram Moolenaar0398e002019-03-21 21:12:49 +01003747 if (qf_stack_empty(qi) || qf_list_empty(qf_get_curlist(qi)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 {
Bram Moolenaare29a27f2021-07-20 21:07:36 +02003749 emsg(_(e_no_errors));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 return;
3751 }
Bram Moolenaare8fea072016-07-01 14:48:27 +02003752 if (*arg == '+')
3753 {
3754 ++arg;
3755 plus = TRUE;
3756 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 if (!get_list_range(&arg, &idx1, &idx2) || *arg != NUL)
3758 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00003759 semsg(_(e_trailing_characters_str), arg);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 return;
3761 }
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01003762 qfl = qf_get_curlist(qi);
Bram Moolenaare8fea072016-07-01 14:48:27 +02003763 if (plus)
3764 {
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003765 i = qfl->qf_index;
Bram Moolenaare8fea072016-07-01 14:48:27 +02003766 idx2 = i + idx1;
3767 idx1 = i;
3768 }
3769 else
3770 {
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003771 i = qfl->qf_count;
Bram Moolenaare8fea072016-07-01 14:48:27 +02003772 if (idx1 < 0)
3773 idx1 = (-idx1 > i) ? 0 : idx1 + i + 1;
3774 if (idx2 < 0)
3775 idx2 = (-idx2 > i) ? 0 : idx2 + i + 1;
3776 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003778 // Shorten all the file names, so that it is easy to read
Bram Moolenaara796d462018-05-01 14:30:36 +02003779 shorten_fnames(FALSE);
3780
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003781 // Get the attributes for the different quickfix highlight items. Note
3782 // that this depends on syntax items defined in the qf.vim syntax file
Bram Moolenaar93a32e22017-11-23 22:05:45 +01003783 qfFileAttr = syn_name2attr((char_u *)"qfFileName");
3784 if (qfFileAttr == 0)
3785 qfFileAttr = HL_ATTR(HLF_D);
3786 qfSepAttr = syn_name2attr((char_u *)"qfSeparator");
3787 if (qfSepAttr == 0)
3788 qfSepAttr = HL_ATTR(HLF_D);
3789 qfLineAttr = syn_name2attr((char_u *)"qfLineNr");
3790 if (qfLineAttr == 0)
3791 qfLineAttr = HL_ATTR(HLF_N);
3792
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003793 if (qfl->qf_nonevalid)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 all = TRUE;
Bram Moolenaar95946f12019-03-31 15:31:59 +02003795 FOR_ALL_QFL_ITEMS(qfl, qfp, i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 {
3797 if ((qfp->qf_valid || all) && idx1 <= i && i <= idx2)
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003798 qf_list_entry(qfp, i, i == qfl->qf_index);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00003799
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 ui_breakcheck();
3801 }
Yegappan Lakshmanand8cd6f72022-10-16 11:30:48 +01003802 qfga_clear();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803}
3804
3805/*
3806 * Remove newlines and leading whitespace from an error message.
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003807 * Add the result to the grow array "gap".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 */
3809 static void
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003810qf_fmt_text(garray_T *gap, char_u *text)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003811{
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 char_u *p = text;
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003813 while (*p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 {
3815 if (*p == '\n')
3816 {
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003817 ga_append(gap, ' ');
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 while (*++p != NUL)
Bram Moolenaar1c465442017-03-12 20:10:05 +01003819 if (!VIM_ISWHITE(*p) && *p != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 break;
3821 }
3822 else
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003823 ga_append(gap, *p++);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825}
3826
Bram Moolenaar18cebf42018-05-08 22:31:37 +02003827/*
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003828 * Add the range information from the lnum, col, end_lnum, and end_col values
3829 * of a quickfix entry to the grow array "gap".
thinca6864efa2021-06-19 20:45:20 +02003830 */
3831 static void
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003832qf_range_text(garray_T *gap, qfline_T *qfp)
thinca6864efa2021-06-19 20:45:20 +02003833{
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003834 char_u *buf = IObuff;
3835 int bufsize = IOSIZE;
thinca6864efa2021-06-19 20:45:20 +02003836 int len;
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003837
thinca6864efa2021-06-19 20:45:20 +02003838 vim_snprintf((char *)buf, bufsize, "%ld", qfp->qf_lnum);
3839 len = (int)STRLEN(buf);
3840
3841 if (qfp->qf_end_lnum > 0 && qfp->qf_lnum != qfp->qf_end_lnum)
3842 {
Shane Harper5bf04282023-06-07 19:09:57 +01003843 vim_snprintf((char *)buf + len, bufsize - len, "-%ld",
3844 qfp->qf_end_lnum);
thinca6864efa2021-06-19 20:45:20 +02003845 len += (int)STRLEN(buf + len);
3846 }
3847 if (qfp->qf_col > 0)
3848 {
3849 vim_snprintf((char *)buf + len, bufsize - len, " col %d", qfp->qf_col);
3850 len += (int)STRLEN(buf + len);
3851 if (qfp->qf_end_col > 0 && qfp->qf_col != qfp->qf_end_col)
3852 {
Shane Harper5bf04282023-06-07 19:09:57 +01003853 vim_snprintf((char *)buf + len, bufsize - len, "-%d",
3854 qfp->qf_end_col);
thinca6864efa2021-06-19 20:45:20 +02003855 len += (int)STRLEN(buf + len);
3856 }
3857 }
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01003858
3859 ga_concat_len(gap, buf, len);
thinca6864efa2021-06-19 20:45:20 +02003860}
3861
3862/*
Bram Moolenaar18cebf42018-05-08 22:31:37 +02003863 * Display information (list number, list size and the title) about a
3864 * quickfix/location list.
3865 */
Bram Moolenaarf6acffb2016-07-16 16:54:24 +02003866 static void
3867qf_msg(qf_info_T *qi, int which, char *lead)
3868{
3869 char *title = (char *)qi->qf_lists[which].qf_title;
3870 int count = qi->qf_lists[which].qf_count;
3871 char_u buf[IOSIZE];
3872
3873 vim_snprintf((char *)buf, IOSIZE, _("%serror list %d of %d; %d errors "),
3874 lead,
3875 which + 1,
3876 qi->qf_listcount,
3877 count);
3878
3879 if (title != NULL)
3880 {
Bram Moolenaar16ec3c92016-07-18 22:22:39 +02003881 size_t len = STRLEN(buf);
3882
3883 if (len < 34)
3884 {
3885 vim_memset(buf + len, ' ', 34 - len);
3886 buf[34] = NUL;
3887 }
3888 vim_strcat(buf, (char_u *)title, IOSIZE);
Bram Moolenaarf6acffb2016-07-16 16:54:24 +02003889 }
3890 trunc_string(buf, buf, Columns - 1, IOSIZE);
Bram Moolenaar32526b32019-01-19 17:43:09 +01003891 msg((char *)buf);
Bram Moolenaarf6acffb2016-07-16 16:54:24 +02003892}
3893
Bram Moolenaar071d4272004-06-13 20:20:40 +00003894/*
3895 * ":colder [count]": Up in the quickfix stack.
3896 * ":cnewer [count]": Down in the quickfix stack.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003897 * ":lolder [count]": Up in the location list stack.
3898 * ":lnewer [count]": Down in the location list stack.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 */
3900 void
Bram Moolenaar05540972016-01-30 20:31:25 +01003901qf_age(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02003903 qf_info_T *qi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 int count;
3905
Bram Moolenaar87f59b02019-04-04 14:04:11 +02003906 if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
3907 return;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003908
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 if (eap->addr_count != 0)
3910 count = eap->line2;
3911 else
3912 count = 1;
3913 while (count--)
3914 {
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003915 if (eap->cmdidx == CMD_colder || eap->cmdidx == CMD_lolder)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003916 {
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003917 if (qi->qf_curlist == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 {
Bram Moolenaarac78dd42022-01-02 19:25:26 +00003919 emsg(_(e_at_bottom_of_quickfix_stack));
Bram Moolenaar82e803b2013-05-11 15:50:33 +02003920 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003921 }
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003922 --qi->qf_curlist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 }
3924 else
3925 {
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003926 if (qi->qf_curlist >= qi->qf_listcount - 1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 {
Bram Moolenaarac78dd42022-01-02 19:25:26 +00003928 emsg(_(e_at_top_of_quickfix_stack));
Bram Moolenaar82e803b2013-05-11 15:50:33 +02003929 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 }
Bram Moolenaard12f5c12006-01-25 22:10:52 +00003931 ++qi->qf_curlist;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932 }
3933 }
Bram Moolenaarf6acffb2016-07-16 16:54:24 +02003934 qf_msg(qi, qi->qf_curlist, "");
Bram Moolenaar864293a2016-06-02 13:40:04 +02003935 qf_update_buffer(qi, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936}
3937
Bram Moolenaar18cebf42018-05-08 22:31:37 +02003938/*
3939 * Display the information about all the quickfix/location lists in the stack
3940 */
Bram Moolenaarf6acffb2016-07-16 16:54:24 +02003941 void
3942qf_history(exarg_T *eap)
3943{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02003944 qf_info_T *qi = qf_cmd_get_stack(eap, FALSE);
Bram Moolenaarf6acffb2016-07-16 16:54:24 +02003945 int i;
3946
Bram Moolenaar8ffc7c82019-05-05 21:00:26 +02003947 if (eap->addr_count > 0)
3948 {
3949 if (qi == NULL)
3950 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00003951 emsg(_(e_no_location_list));
Bram Moolenaar8ffc7c82019-05-05 21:00:26 +02003952 return;
3953 }
3954
3955 // Jump to the specified quickfix list
3956 if (eap->line2 > 0 && eap->line2 <= qi->qf_listcount)
3957 {
3958 qi->qf_curlist = eap->line2 - 1;
3959 qf_msg(qi, qi->qf_curlist, "");
3960 qf_update_buffer(qi, NULL);
3961 }
3962 else
Bram Moolenaar108010a2021-06-27 22:03:33 +02003963 emsg(_(e_invalid_range));
Bram Moolenaar8ffc7c82019-05-05 21:00:26 +02003964
3965 return;
3966 }
3967
Bram Moolenaar5b69c222019-01-11 14:50:06 +01003968 if (qf_stack_empty(qi))
Bram Moolenaar32526b32019-01-19 17:43:09 +01003969 msg(_("No entries"));
Bram Moolenaarf6acffb2016-07-16 16:54:24 +02003970 else
3971 for (i = 0; i < qi->qf_listcount; ++i)
3972 qf_msg(qi, i, i == qi->qf_curlist ? "> " : " ");
3973}
3974
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975/*
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02003976 * Free all the entries in the error list "idx". Note that other information
3977 * associated with the list like context and title are not freed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978 */
3979 static void
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02003980qf_free_items(qf_list_T *qfl)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981{
Bram Moolenaar68b76a62005-03-25 21:53:48 +00003982 qfline_T *qfp;
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02003983 qfline_T *qfpnext;
Bram Moolenaar81484f42012-12-05 15:16:47 +01003984 int stop = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985
Bram Moolenaara7df8c72017-07-19 13:23:06 +02003986 while (qfl->qf_count && qfl->qf_start != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987 {
Bram Moolenaara7df8c72017-07-19 13:23:06 +02003988 qfp = qfl->qf_start;
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02003989 qfpnext = qfp->qf_next;
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02003990 if (!stop)
Bram Moolenaarc83a44b2012-11-28 15:25:34 +01003991 {
Bram Moolenaard76ce852018-05-01 15:02:04 +02003992 vim_free(qfp->qf_module);
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02003993 vim_free(qfp->qf_text);
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02003994 vim_free(qfp->qf_pattern);
Tom Praschanca6ac992023-08-11 23:26:12 +02003995 clear_tv(&qfp->qf_user_data);
Bram Moolenaard76ce852018-05-01 15:02:04 +02003996 stop = (qfp == qfpnext);
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02003997 vim_free(qfp);
Bram Moolenaar81484f42012-12-05 15:16:47 +01003998 if (stop)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02003999 // Somehow qf_count may have an incorrect value, set it to 1
4000 // to avoid crashing when it's wrong.
4001 // TODO: Avoid qf_count being incorrect.
Bram Moolenaara7df8c72017-07-19 13:23:06 +02004002 qfl->qf_count = 1;
Christian Brabandt567cae22023-11-19 16:19:27 +01004003 else
4004 qfl->qf_start = qfpnext;
Bram Moolenaarc83a44b2012-11-28 15:25:34 +01004005 }
Bram Moolenaara7df8c72017-07-19 13:23:06 +02004006 --qfl->qf_count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 }
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02004008
Bram Moolenaara7df8c72017-07-19 13:23:06 +02004009 qfl->qf_index = 0;
4010 qfl->qf_start = NULL;
4011 qfl->qf_last = NULL;
4012 qfl->qf_ptr = NULL;
4013 qfl->qf_nonevalid = TRUE;
Bram Moolenaar361c8f02016-07-02 15:41:47 +02004014
Bram Moolenaara7df8c72017-07-19 13:23:06 +02004015 qf_clean_dir_stack(&qfl->qf_dir_stack);
4016 qfl->qf_directory = NULL;
4017 qf_clean_dir_stack(&qfl->qf_file_stack);
4018 qfl->qf_currfile = NULL;
4019 qfl->qf_multiline = FALSE;
4020 qfl->qf_multiignore = FALSE;
4021 qfl->qf_multiscan = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022}
4023
4024/*
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02004025 * Free error list "idx". Frees all the entries in the quickfix list,
4026 * associated context information and the title.
4027 */
4028 static void
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02004029qf_free(qf_list_T *qfl)
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02004030{
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02004031 qf_free_items(qfl);
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02004032
Bram Moolenaard23a8232018-02-10 18:45:26 +01004033 VIM_CLEAR(qfl->qf_title);
Bram Moolenaara7df8c72017-07-19 13:23:06 +02004034 free_tv(qfl->qf_ctx);
4035 qfl->qf_ctx = NULL;
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +01004036 free_callback(&qfl->qf_qftf_cb);
Bram Moolenaara539f4f2017-08-30 20:33:55 +02004037 qfl->qf_id = 0;
Bram Moolenaarb254af32017-12-18 19:48:58 +01004038 qfl->qf_changedtick = 0L;
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02004039}
4040
4041/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 * qf_mark_adjust: adjust marks
4043 */
4044 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004045qf_mark_adjust(
Bram Moolenaaref6b8de2017-09-14 13:57:37 +02004046 win_T *wp,
4047 linenr_T line1,
4048 linenr_T line2,
4049 long amount,
4050 long amount_after)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004051{
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004052 int i;
4053 qfline_T *qfp;
4054 int idx;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004055 qf_info_T *qi = &ql_info;
Bram Moolenaar2f095a42016-06-03 19:05:49 +02004056 int found_one = FALSE;
Bram Moolenaarc1542742016-07-20 21:44:37 +02004057 int buf_has_flag = wp == NULL ? BUF_HAS_QF_ENTRY : BUF_HAS_LL_ENTRY;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058
Bram Moolenaarc1542742016-07-20 21:44:37 +02004059 if (!(curbuf->b_has_qf_entry & buf_has_flag))
Bram Moolenaar2f095a42016-06-03 19:05:49 +02004060 return;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004061 if (wp != NULL)
4062 {
4063 if (wp->w_llist == NULL)
4064 return;
4065 qi = wp->w_llist;
4066 }
4067
4068 for (idx = 0; idx < qi->qf_listcount; ++idx)
Bram Moolenaar0398e002019-03-21 21:12:49 +01004069 {
4070 qf_list_T *qfl = qf_get_list(qi, idx);
4071
4072 if (!qf_list_empty(qfl))
Bram Moolenaara16123a2019-03-28 20:31:07 +01004073 FOR_ALL_QFL_ITEMS(qfl, qfp, i)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 if (qfp->qf_fnum == curbuf->b_fnum)
4075 {
Bram Moolenaar2f095a42016-06-03 19:05:49 +02004076 found_one = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 if (qfp->qf_lnum >= line1 && qfp->qf_lnum <= line2)
4078 {
4079 if (amount == MAXLNUM)
4080 qfp->qf_cleared = TRUE;
4081 else
4082 qfp->qf_lnum += amount;
4083 }
4084 else if (amount_after && qfp->qf_lnum > line2)
4085 qfp->qf_lnum += amount_after;
4086 }
Bram Moolenaar0398e002019-03-21 21:12:49 +01004087 }
Bram Moolenaar2f095a42016-06-03 19:05:49 +02004088
4089 if (!found_one)
Bram Moolenaarc1542742016-07-20 21:44:37 +02004090 curbuf->b_has_qf_entry &= ~buf_has_flag;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091}
4092
4093/*
4094 * Make a nice message out of the error character and the error number:
4095 * char number message
4096 * e or E 0 " error"
4097 * w or W 0 " warning"
4098 * i or I 0 " info"
Bram Moolenaare9283662020-06-07 14:10:47 +02004099 * n or N 0 " note"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 * 0 0 ""
4101 * other 0 " c"
4102 * e or E n " error n"
4103 * w or W n " warning n"
4104 * i or I n " info n"
Bram Moolenaare9283662020-06-07 14:10:47 +02004105 * n or N n " note n"
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106 * 0 n " error n"
4107 * other n " c n"
4108 * 1 x "" :helpgrep
4109 */
4110 static char_u *
Bram Moolenaar05540972016-01-30 20:31:25 +01004111qf_types(int c, int nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112{
4113 static char_u buf[20];
4114 static char_u cc[3];
4115 char_u *p;
4116
4117 if (c == 'W' || c == 'w')
4118 p = (char_u *)" warning";
4119 else if (c == 'I' || c == 'i')
4120 p = (char_u *)" info";
Bram Moolenaare9283662020-06-07 14:10:47 +02004121 else if (c == 'N' || c == 'n')
4122 p = (char_u *)" note";
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123 else if (c == 'E' || c == 'e' || (c == 0 && nr > 0))
4124 p = (char_u *)" error";
4125 else if (c == 0 || c == 1)
4126 p = (char_u *)"";
4127 else
4128 {
4129 cc[0] = ' ';
4130 cc[1] = c;
4131 cc[2] = NUL;
4132 p = cc;
4133 }
4134
4135 if (nr <= 0)
4136 return p;
4137
4138 sprintf((char *)buf, "%s %3d", (char *)p, nr);
4139 return buf;
4140}
4141
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142/*
Bram Moolenaar0a08c632018-07-25 22:36:52 +02004143 * When "split" is FALSE: Open the entry/result under the cursor.
4144 * When "split" is TRUE: Open the entry/result under the cursor in a new window.
4145 */
4146 void
4147qf_view_result(int split)
4148{
4149 qf_info_T *qi = &ql_info;
4150
Bram Moolenaar0a08c632018-07-25 22:36:52 +02004151 if (IS_LL_WINDOW(curwin))
4152 qi = GET_LOC_LIST(curwin);
4153
Bram Moolenaar0398e002019-03-21 21:12:49 +01004154 if (qf_list_empty(qf_get_curlist(qi)))
Bram Moolenaar0a08c632018-07-25 22:36:52 +02004155 {
Bram Moolenaare29a27f2021-07-20 21:07:36 +02004156 emsg(_(e_no_errors));
Bram Moolenaar0a08c632018-07-25 22:36:52 +02004157 return;
4158 }
4159
4160 if (split)
4161 {
Bram Moolenaarb2443732018-11-11 22:50:27 +01004162 // Open the selected entry in a new window
4163 qf_jump_newwin(qi, 0, (long)curwin->w_cursor.lnum, FALSE, TRUE);
4164 do_cmdline_cmd((char_u *) "clearjumps");
Bram Moolenaar0a08c632018-07-25 22:36:52 +02004165 return;
4166 }
4167
4168 do_cmdline_cmd((char_u *)(IS_LL_WINDOW(curwin) ? ".ll" : ".cc"));
4169}
4170
4171/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 * ":cwindow": open the quickfix window if we have errors to display,
4173 * close it if not.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004174 * ":lwindow": open the location list window if we have locations to display,
4175 * close it if not.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 */
4177 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004178ex_cwindow(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02004180 qf_info_T *qi;
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004181 qf_list_T *qfl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 win_T *win;
4183
Bram Moolenaar87f59b02019-04-04 14:04:11 +02004184 if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
4185 return;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004186
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01004187 qfl = qf_get_curlist(qi);
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004188
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004189 // Look for an existing quickfix window.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004190 win = qf_find_win(qi);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004192 // If a quickfix window is open but we have no errors to display,
4193 // close the window. If a quickfix window is not open, then open
4194 // it if we have errors; otherwise, leave it closed.
Bram Moolenaar019dfe62018-10-07 14:38:49 +02004195 if (qf_stack_empty(qi)
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004196 || qfl->qf_nonevalid
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01004197 || qf_list_empty(qfl))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 {
4199 if (win != NULL)
4200 ex_cclose(eap);
4201 }
4202 else if (win == NULL)
4203 ex_copen(eap);
4204}
4205
4206/*
4207 * ":cclose": close the window showing the list of errors.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004208 * ":lclose": close the window showing the location list
Bram Moolenaar071d4272004-06-13 20:20:40 +00004209 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004211ex_cclose(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212{
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004213 win_T *win = NULL;
Bram Moolenaar87f59b02019-04-04 14:04:11 +02004214 qf_info_T *qi;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215
Bram Moolenaar87f59b02019-04-04 14:04:11 +02004216 if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
4217 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004219 // Find existing quickfix window and close it.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004220 win = qf_find_win(qi);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221 if (win != NULL)
4222 win_close(win, FALSE);
4223}
4224
4225/*
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02004226 * Set "w:quickfix_title" if "qi" has a title.
4227 */
4228 static void
4229qf_set_title_var(qf_list_T *qfl)
4230{
4231 if (qfl->qf_title != NULL)
4232 set_internal_string_var((char_u *)"w:quickfix_title", qfl->qf_title);
4233}
4234
4235/*
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004236 * Goto a quickfix or location list window (if present).
4237 * Returns OK if the window is found, FAIL otherwise.
4238 */
4239 static int
4240qf_goto_cwindow(qf_info_T *qi, int resize, int sz, int vertsplit)
4241{
4242 win_T *win;
4243
4244 win = qf_find_win(qi);
4245 if (win == NULL)
4246 return FAIL;
4247
4248 win_goto(win);
4249 if (resize)
4250 {
4251 if (vertsplit)
4252 {
4253 if (sz != win->w_width)
4254 win_setwidth(sz);
4255 }
Bram Moolenaar1142a312019-10-16 14:51:39 +02004256 else if (sz != win->w_height && win->w_height
4257 + win->w_status_height + tabline_height() < cmdline_row)
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004258 win_setheight(sz);
4259 }
4260
4261 return OK;
4262}
4263
4264/*
Bram Moolenaard82a81c2019-03-02 07:57:18 +01004265 * Set options for the buffer in the quickfix or location list window.
4266 */
4267 static void
4268qf_set_cwindow_options(void)
4269{
4270 // switch off 'swapfile'
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004271 set_option_value_give_err((char_u *)"swf", 0L, NULL, OPT_LOCAL);
4272 set_option_value_give_err((char_u *)"bt",
4273 0L, (char_u *)"quickfix", OPT_LOCAL);
4274 set_option_value_give_err((char_u *)"bh", 0L, (char_u *)"hide", OPT_LOCAL);
Bram Moolenaard82a81c2019-03-02 07:57:18 +01004275 RESET_BINDING(curwin);
4276#ifdef FEAT_DIFF
4277 curwin->w_p_diff = FALSE;
4278#endif
4279#ifdef FEAT_FOLDING
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004280 set_option_value_give_err((char_u *)"fdm", 0L, (char_u *)"manual",
Bram Moolenaard82a81c2019-03-02 07:57:18 +01004281 OPT_LOCAL);
4282#endif
4283}
4284
4285/*
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004286 * Open a new quickfix or location list window, load the quickfix buffer and
4287 * set the appropriate options for the window.
4288 * Returns FAIL if the window could not be opened.
4289 */
4290 static int
4291qf_open_new_cwindow(qf_info_T *qi, int height)
4292{
4293 buf_T *qf_buf;
4294 win_T *oldwin = curwin;
4295 tabpage_T *prevtab = curtab;
4296 int flags = 0;
4297 win_T *win;
4298
4299 qf_buf = qf_find_buf(qi);
4300
4301 // The current window becomes the previous window afterwards.
4302 win = curwin;
4303
Bram Moolenaare1004402020-10-24 20:49:43 +02004304 if (IS_QF_STACK(qi) && cmdmod.cmod_split == 0)
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004305 // Create the new quickfix window at the very bottom, except when
4306 // :belowright or :aboveleft is used.
4307 win_goto(lastwin);
4308 // Default is to open the window below the current window
Bram Moolenaare1004402020-10-24 20:49:43 +02004309 if (cmdmod.cmod_split == 0)
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004310 flags = WSP_BELOW;
4311 flags |= WSP_NEWLOC;
4312 if (win_split(height, flags) == FAIL)
4313 return FAIL; // not enough room for window
4314 RESET_BINDING(curwin);
4315
4316 if (IS_LL_STACK(qi))
4317 {
4318 // For the location list window, create a reference to the
Bram Moolenaareeb1b9c2019-02-10 22:59:04 +01004319 // location list stack from the window 'win'.
4320 curwin->w_llist_ref = qi;
4321 qi->qf_refcount++;
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004322 }
4323
4324 if (oldwin != curwin)
4325 oldwin = NULL; // don't store info when in another window
4326 if (qf_buf != NULL)
4327 {
4328 // Use the existing quickfix buffer
Bram Moolenaar9e40c4b2020-11-23 20:15:08 +01004329 if (do_ecmd(qf_buf->b_fnum, NULL, NULL, NULL, ECMD_ONE,
Bram Moolenaar1d30fde2021-10-20 21:58:42 +01004330 ECMD_HIDE + ECMD_OLDBUF + ECMD_NOWINENTER, oldwin) == FAIL)
Bram Moolenaar9e40c4b2020-11-23 20:15:08 +01004331 return FAIL;
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004332 }
4333 else
4334 {
4335 // Create a new quickfix buffer
Bram Moolenaar1d30fde2021-10-20 21:58:42 +01004336 if (do_ecmd(0, NULL, NULL, NULL, ECMD_ONE, ECMD_HIDE + ECMD_NOWINENTER,
4337 oldwin) == FAIL)
Bram Moolenaar9e40c4b2020-11-23 20:15:08 +01004338 return FAIL;
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004339
Bram Moolenaaree8188f2019-02-05 21:23:04 +01004340 // save the number of the new buffer
4341 qi->qf_bufnr = curbuf->b_fnum;
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004342 }
4343
Bram Moolenaard82a81c2019-03-02 07:57:18 +01004344 // Set the options for the quickfix buffer/window (if not already done)
4345 // Do this even if the quickfix buffer was already present, as an autocmd
4346 // might have previously deleted (:bdelete) the quickfix buffer.
Bram Moolenaar61eeeea2019-06-15 21:56:17 +02004347 if (!bt_quickfix(curbuf))
Bram Moolenaard82a81c2019-03-02 07:57:18 +01004348 qf_set_cwindow_options();
4349
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004350 // Only set the height when still in the same tab page and there is no
4351 // window to the side.
4352 if (curtab == prevtab && curwin->w_width == Columns)
4353 win_setheight(height);
4354 curwin->w_p_wfh = TRUE; // set 'winfixheight'
4355 if (win_valid(win))
4356 prevwin = win;
4357
4358 return OK;
4359}
4360
4361/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 * ":copen": open a window that shows the list of errors.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004363 * ":lopen": open a window that shows the location list.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 */
4365 void
Bram Moolenaar05540972016-01-30 20:31:25 +01004366ex_copen(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02004368 qf_info_T *qi;
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004369 qf_list_T *qfl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 int height;
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004371 int status = FAIL;
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02004372 int lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373
Bram Moolenaar87f59b02019-04-04 14:04:11 +02004374 if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
4375 return;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004376
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02004377 incr_quickfix_busy();
4378
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 if (eap->addr_count != 0)
4380 height = eap->line2;
4381 else
4382 height = QF_WINHEIGHT;
4383
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004384 reset_VIsual_and_resel(); // stop Visual mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385#ifdef FEAT_GUI
4386 need_mouse_correct = TRUE;
4387#endif
4388
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004389 // Find an existing quickfix window, or open a new one.
Bram Moolenaare1004402020-10-24 20:49:43 +02004390 if (cmdmod.cmod_tab == 0)
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004391 status = qf_goto_cwindow(qi, eap->addr_count != 0, height,
Bram Moolenaare1004402020-10-24 20:49:43 +02004392 cmdmod.cmod_split & WSP_VERT);
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004393 if (status == FAIL)
4394 if (qf_open_new_cwindow(qi, height) == FAIL)
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02004395 {
4396 decr_quickfix_busy();
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004397 return;
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02004398 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01004400 qfl = qf_get_curlist(qi);
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004401 qf_set_title_var(qfl);
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02004402 // Save the current index here, as updating the quickfix buffer may free
4403 // the quickfix list
4404 lnum = qfl->qf_index;
Bram Moolenaar81278ef2015-05-04 12:34:22 +02004405
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004406 // Fill the buffer with the quickfix list.
Bram Moolenaar7ba5a7e2020-06-08 19:20:27 +02004407 qf_fill_buffer(qfl, curbuf, NULL, curwin->w_id);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02004409 decr_quickfix_busy();
4410
4411 curwin->w_cursor.lnum = lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 curwin->w_cursor.col = 0;
4413 check_cursor();
Bram Moolenaar476c0db2018-09-19 21:56:02 +02004414 update_topline(); // scroll to show the line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415}
4416
4417/*
Bram Moolenaardcb17002016-07-07 18:58:59 +02004418 * Move the cursor in the quickfix window to "lnum".
4419 */
4420 static void
4421qf_win_goto(win_T *win, linenr_T lnum)
4422{
4423 win_T *old_curwin = curwin;
4424
4425 curwin = win;
4426 curbuf = win->w_buffer;
4427 curwin->w_cursor.lnum = lnum;
4428 curwin->w_cursor.col = 0;
Bram Moolenaardcb17002016-07-07 18:58:59 +02004429 curwin->w_cursor.coladd = 0;
Bram Moolenaardcb17002016-07-07 18:58:59 +02004430 curwin->w_curswant = 0;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004431 update_topline(); // scroll to show the line
Bram Moolenaara4d158b2022-08-14 14:17:45 +01004432 redraw_later(UPD_VALID);
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004433 curwin->w_redr_status = TRUE; // update ruler
Bram Moolenaardcb17002016-07-07 18:58:59 +02004434 curwin = old_curwin;
4435 curbuf = curwin->w_buffer;
4436}
4437
4438/*
Bram Moolenaar537ef082016-07-09 17:56:19 +02004439 * :cbottom/:lbottom commands.
Bram Moolenaardcb17002016-07-07 18:58:59 +02004440 */
4441 void
Bram Moolenaar39665952018-08-15 20:59:48 +02004442ex_cbottom(exarg_T *eap)
Bram Moolenaardcb17002016-07-07 18:58:59 +02004443{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02004444 qf_info_T *qi;
Bram Moolenaar537ef082016-07-09 17:56:19 +02004445 win_T *win;
Bram Moolenaardcb17002016-07-07 18:58:59 +02004446
Bram Moolenaar87f59b02019-04-04 14:04:11 +02004447 if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
4448 return;
Bram Moolenaar537ef082016-07-09 17:56:19 +02004449
4450 win = qf_find_win(qi);
Bram Moolenaardcb17002016-07-07 18:58:59 +02004451 if (win != NULL && win->w_cursor.lnum != win->w_buffer->b_ml.ml_line_count)
4452 qf_win_goto(win, win->w_buffer->b_ml.ml_line_count);
4453}
4454
4455/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 * Return the number of the current entry (line number in the quickfix
4457 * window).
4458 */
4459 linenr_T
Bram Moolenaar05540972016-01-30 20:31:25 +01004460qf_current_entry(win_T *wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461{
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004462 qf_info_T *qi = &ql_info;
4463
4464 if (IS_LL_WINDOW(wp))
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004465 // In the location list window, use the referenced location list
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004466 qi = wp->w_llist_ref;
4467
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01004468 return qf_get_curlist(qi)->qf_index;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004469}
4470
4471/*
4472 * Update the cursor position in the quickfix window to the current error.
4473 * Return TRUE if there is a quickfix window.
4474 */
4475 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01004476qf_win_pos_update(
4477 qf_info_T *qi,
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004478 int old_qf_index) // previous qf_index or zero
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479{
4480 win_T *win;
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01004481 int qf_index = qf_get_curlist(qi)->qf_index;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004483 // Put the cursor on the current error in the quickfix window, so that
4484 // it's viewable.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004485 win = qf_find_win(qi);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486 if (win != NULL
4487 && qf_index <= win->w_buffer->b_ml.ml_line_count
4488 && old_qf_index != qf_index)
4489 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 if (qf_index > old_qf_index)
4491 {
Bram Moolenaardcb17002016-07-07 18:58:59 +02004492 win->w_redraw_top = old_qf_index;
4493 win->w_redraw_bot = qf_index;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 }
4495 else
4496 {
Bram Moolenaardcb17002016-07-07 18:58:59 +02004497 win->w_redraw_top = qf_index;
4498 win->w_redraw_bot = old_qf_index;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 }
Bram Moolenaardcb17002016-07-07 18:58:59 +02004500 qf_win_goto(win, qf_index);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501 }
4502 return win != NULL;
4503}
4504
4505/*
Bram Moolenaar9c102382006-05-03 21:26:49 +00004506 * Check whether the given window is displaying the specified quickfix/location
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02004507 * stack.
Bram Moolenaar9c102382006-05-03 21:26:49 +00004508 */
4509 static int
Bram Moolenaar05540972016-01-30 20:31:25 +01004510is_qf_win(win_T *win, qf_info_T *qi)
Bram Moolenaar9c102382006-05-03 21:26:49 +00004511{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004512 // A window displaying the quickfix buffer will have the w_llist_ref field
4513 // set to NULL.
4514 // A window displaying a location list buffer will have the w_llist_ref
4515 // pointing to the location list.
Christian Brabandtfc682992023-09-03 20:20:52 +02004516 if (buf_valid(win->w_buffer) && bt_quickfix(win->w_buffer))
Bram Moolenaar4d77c652018-08-18 19:59:54 +02004517 if ((IS_QF_STACK(qi) && win->w_llist_ref == NULL)
4518 || (IS_LL_STACK(qi) && win->w_llist_ref == qi))
Bram Moolenaar9c102382006-05-03 21:26:49 +00004519 return TRUE;
4520
4521 return FALSE;
4522}
4523
4524/*
Yegappan Lakshmanan78a61062021-12-08 20:03:31 +00004525 * Find a window displaying the quickfix/location stack 'qi' in the current tab
4526 * page.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004527 */
4528 static win_T *
Bram Moolenaar05540972016-01-30 20:31:25 +01004529qf_find_win(qf_info_T *qi)
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004530{
4531 win_T *win;
4532
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004533 FOR_ALL_WINDOWS(win)
Bram Moolenaar9c102382006-05-03 21:26:49 +00004534 if (is_qf_win(win, qi))
Bram Moolenaar2ec364e2018-01-27 11:52:13 +01004535 return win;
4536 return NULL;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004537}
4538
4539/*
Bram Moolenaar9c102382006-05-03 21:26:49 +00004540 * Find a quickfix buffer.
Yegappan Lakshmanan78a61062021-12-08 20:03:31 +00004541 * Searches in windows opened in all the tab pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004542 */
4543 static buf_T *
Bram Moolenaar05540972016-01-30 20:31:25 +01004544qf_find_buf(qf_info_T *qi)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545{
Bram Moolenaar9c102382006-05-03 21:26:49 +00004546 tabpage_T *tp;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004547 win_T *win;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004548
Bram Moolenaaree8188f2019-02-05 21:23:04 +01004549 if (qi->qf_bufnr != INVALID_QFBUFNR)
4550 {
4551 buf_T *qfbuf;
4552 qfbuf = buflist_findnr(qi->qf_bufnr);
4553 if (qfbuf != NULL)
4554 return qfbuf;
4555 // buffer is no longer present
4556 qi->qf_bufnr = INVALID_QFBUFNR;
4557 }
4558
Bram Moolenaar9c102382006-05-03 21:26:49 +00004559 FOR_ALL_TAB_WINDOWS(tp, win)
4560 if (is_qf_win(win, qi))
4561 return win->w_buffer;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004562
Bram Moolenaar9c102382006-05-03 21:26:49 +00004563 return NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004564}
4565
4566/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02004567 * Process the 'quickfixtextfunc' option value.
Yegappan Lakshmanan777175b2021-11-18 22:08:57 +00004568 * Returns OK or FAIL.
Bram Moolenaard43906d2020-07-20 21:31:32 +02004569 */
Yegappan Lakshmananf2e30d02023-01-30 13:04:42 +00004570 char *
Yegappan Lakshmananaf936912023-02-20 12:16:39 +00004571did_set_quickfixtextfunc(optset_T *args UNUSED)
Bram Moolenaard43906d2020-07-20 21:31:32 +02004572{
Yegappan Lakshmananf2e30d02023-01-30 13:04:42 +00004573 if (option_set_callback_func(p_qftf, &qftf_cb) == FAIL)
4574 return e_invalid_argument;
4575
4576 return NULL;
Bram Moolenaard43906d2020-07-20 21:31:32 +02004577}
4578
4579/*
Bram Moolenaar530bed92020-12-16 21:02:56 +01004580 * Update the w:quickfix_title variable in the quickfix/location list window in
4581 * all the tab pages.
Bram Moolenaard823fa92016-08-12 16:29:27 +02004582 */
4583 static void
4584qf_update_win_titlevar(qf_info_T *qi)
4585{
Bram Moolenaar530bed92020-12-16 21:02:56 +01004586 qf_list_T *qfl = qf_get_curlist(qi);
4587 tabpage_T *tp;
Bram Moolenaard823fa92016-08-12 16:29:27 +02004588 win_T *win;
Bram Moolenaar530bed92020-12-16 21:02:56 +01004589 win_T *save_curwin = curwin;
Bram Moolenaard823fa92016-08-12 16:29:27 +02004590
Bram Moolenaar530bed92020-12-16 21:02:56 +01004591 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaard823fa92016-08-12 16:29:27 +02004592 {
Bram Moolenaar530bed92020-12-16 21:02:56 +01004593 if (is_qf_win(win, qi))
4594 {
4595 curwin = win;
4596 qf_set_title_var(qfl);
4597 }
Bram Moolenaard823fa92016-08-12 16:29:27 +02004598 }
Bram Moolenaar530bed92020-12-16 21:02:56 +01004599 curwin = save_curwin;
Bram Moolenaard823fa92016-08-12 16:29:27 +02004600}
4601
4602/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 * Find the quickfix buffer. If it exists, update the contents.
4604 */
4605 static void
Bram Moolenaar864293a2016-06-02 13:40:04 +02004606qf_update_buffer(qf_info_T *qi, qfline_T *old_last)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004607{
4608 buf_T *buf;
Bram Moolenaarc95e3262011-08-10 18:36:54 +02004609 win_T *win;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 aco_save_T aco;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004612 // Check if a buffer for the quickfix list exists. Update it.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00004613 buf = qf_find_buf(qi);
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00004614 if (buf == NULL)
4615 return;
4616
4617 linenr_T old_line_count = buf->b_ml.ml_line_count;
4618 int qf_winid = 0;
4619
4620 if (IS_LL_STACK(qi))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621 {
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00004622 if (curwin->w_llist == qi)
4623 win = curwin;
4624 else
Yegappan Lakshmananad52f962021-06-19 18:22:53 +02004625 {
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00004626 // Find the file window (non-quickfix) with this location list
4627 win = qf_find_win_with_loclist(qi);
4628 if (win == NULL)
4629 // File window is not found. Find the location list window.
4630 win = qf_find_win(qi);
4631 if (win == NULL)
4632 return;
Yegappan Lakshmananad52f962021-06-19 18:22:53 +02004633 }
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00004634 qf_winid = win->w_id;
4635 }
Bram Moolenaar864293a2016-06-02 13:40:04 +02004636
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00004637 // autocommands may cause trouble
4638 incr_quickfix_busy();
Bram Moolenaard0fab102022-10-20 16:03:33 +01004639
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00004640 int do_fill = TRUE;
4641 if (old_last == NULL)
4642 {
4643 // set curwin/curbuf to buf and save a few things
4644 aucmd_prepbuf(&aco, buf);
4645 if (curbuf != buf)
4646 do_fill = FALSE; // failed to find a window for "buf"
4647 }
4648
4649 if (do_fill)
4650 {
4651 qf_update_win_titlevar(qi);
4652
4653 qf_fill_buffer(qf_get_curlist(qi), buf, old_last, qf_winid);
4654 ++CHANGEDTICK(buf);
4655
Bram Moolenaar864293a2016-06-02 13:40:04 +02004656 if (old_last == NULL)
4657 {
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00004658 (void)qf_win_pos_update(qi, 0);
4659
4660 // restore curwin/curbuf and a few other things
4661 aucmd_restbuf(&aco);
Bram Moolenaare76062c2022-11-28 18:51:43 +00004662 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 }
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00004664
4665 // Only redraw when added lines are visible. This avoids flickering
4666 // when the added lines are not visible.
4667 if ((win = qf_find_win(qi)) != NULL && old_line_count < win->w_botline)
4668 redraw_buf_later(buf, UPD_NOT_VALID);
4669
4670 // always called after incr_quickfix_busy()
4671 decr_quickfix_busy();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672}
4673
Bram Moolenaar81278ef2015-05-04 12:34:22 +02004674/*
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004675 * Add an error line to the quickfix buffer.
4676 */
4677 static int
Bram Moolenaar858ba062020-05-31 23:11:59 +02004678qf_buf_add_line(
Bram Moolenaar858ba062020-05-31 23:11:59 +02004679 buf_T *buf, // quickfix window buffer
4680 linenr_T lnum,
4681 qfline_T *qfp,
Bram Moolenaar7ba5a7e2020-06-08 19:20:27 +02004682 char_u *dirname,
Bram Moolenaar8ec92c92020-09-29 22:47:03 +02004683 int first_bufline,
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004684 char_u *qftf_str)
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004685{
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004686 buf_T *errbuf;
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01004687 garray_T *gap;
Yegappan Lakshmananf8412c92022-10-13 11:59:22 +01004688
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01004689 gap = qfga_get();
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004690
Dominique Pelleaf4a61a2021-12-27 17:21:41 +00004691 // If the 'quickfixtextfunc' function returned a non-empty custom string
Bram Moolenaard43906d2020-07-20 21:31:32 +02004692 // for this entry, then use it.
4693 if (qftf_str != NULL && *qftf_str != NUL)
Bram Moolenaar2f7bfe62022-11-13 12:54:50 +00004694 {
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01004695 ga_concat(gap, qftf_str);
Bram Moolenaar2f7bfe62022-11-13 12:54:50 +00004696 }
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004697 else
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004698 {
Bram Moolenaar858ba062020-05-31 23:11:59 +02004699 if (qfp->qf_module != NULL)
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01004700 ga_concat(gap, qfp->qf_module);
Bram Moolenaar858ba062020-05-31 23:11:59 +02004701 else if (qfp->qf_fnum != 0
4702 && (errbuf = buflist_findnr(qfp->qf_fnum)) != NULL
4703 && errbuf->b_fname != NULL)
4704 {
4705 if (qfp->qf_type == 1) // :helpgrep
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01004706 ga_concat(gap, gettail(errbuf->b_fname));
Bram Moolenaar858ba062020-05-31 23:11:59 +02004707 else
4708 {
Bram Moolenaar8ec92c92020-09-29 22:47:03 +02004709 // Shorten the file name if not done already.
4710 // For optimization, do this only for the first entry in a
4711 // buffer.
4712 if (first_bufline && (errbuf->b_sfname == NULL
4713 || mch_isFullName(errbuf->b_sfname)))
Bram Moolenaar858ba062020-05-31 23:11:59 +02004714 {
4715 if (*dirname == NUL)
4716 mch_dirname(dirname, MAXPATHL);
4717 shorten_buf_fname(errbuf, dirname, FALSE);
4718 }
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01004719 ga_concat(gap, errbuf->b_fname);
Bram Moolenaar858ba062020-05-31 23:11:59 +02004720 }
Bram Moolenaar858ba062020-05-31 23:11:59 +02004721 }
Bram Moolenaar858ba062020-05-31 23:11:59 +02004722
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01004723 ga_append(gap, '|');
Bram Moolenaar858ba062020-05-31 23:11:59 +02004724
4725 if (qfp->qf_lnum > 0)
4726 {
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01004727 qf_range_text(gap, qfp);
4728 ga_concat(gap, qf_types(qfp->qf_type, qfp->qf_nr));
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004729 }
Bram Moolenaar858ba062020-05-31 23:11:59 +02004730 else if (qfp->qf_pattern != NULL)
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01004731 qf_fmt_text(gap, qfp->qf_pattern);
4732 ga_append(gap, '|');
4733 ga_append(gap, ' ');
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004734
Bram Moolenaar858ba062020-05-31 23:11:59 +02004735 // Remove newlines and leading whitespace from the text.
4736 // For an unrecognized line keep the indent, the compiler may
4737 // mark a word with ^^^^.
Bram Moolenaar2f7bfe62022-11-13 12:54:50 +00004738 qf_fmt_text(gap, gap->ga_len > 3 ? skipwhite(qfp->qf_text)
4739 : qfp->qf_text);
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004740 }
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004741
Shane Harper5bf04282023-06-07 19:09:57 +01004742 ga_append(gap, NUL);
Bram Moolenaar2f7bfe62022-11-13 12:54:50 +00004743 if (ml_append_buf(buf, lnum, gap->ga_data, gap->ga_len, FALSE) == FAIL)
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004744 return FAIL;
4745
4746 return OK;
4747}
4748
Bram Moolenaard43906d2020-07-20 21:31:32 +02004749/*
4750 * Call the 'quickfixtextfunc' function to get the list of lines to display in
4751 * the quickfix window for the entries 'start_idx' to 'end_idx'.
4752 */
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004753 static list_T *
4754call_qftf_func(qf_list_T *qfl, int qf_winid, long start_idx, long end_idx)
4755{
Bram Moolenaard43906d2020-07-20 21:31:32 +02004756 callback_T *cb = &qftf_cb;
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004757 list_T *qftf_list = NULL;
Bram Moolenaard6c67622022-08-24 20:07:22 +01004758 static int recursive = FALSE;
4759
4760 if (recursive)
4761 return NULL; // this doesn't work properly recursively
4762 recursive = TRUE;
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004763
4764 // If 'quickfixtextfunc' is set, then use the user-supplied function to get
4765 // the text to display. Use the local value of 'quickfixtextfunc' if it is
4766 // set.
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +01004767 if (qfl->qf_qftf_cb.cb_name != NULL)
4768 cb = &qfl->qf_qftf_cb;
4769 if (cb->cb_name != NULL)
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004770 {
4771 typval_T args[1];
4772 dict_T *d;
Bram Moolenaard43906d2020-07-20 21:31:32 +02004773 typval_T rettv;
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004774
4775 // create the dict argument
4776 if ((d = dict_alloc_lock(VAR_FIXED)) == NULL)
Bram Moolenaard6c67622022-08-24 20:07:22 +01004777 {
4778 recursive = FALSE;
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004779 return NULL;
Bram Moolenaard6c67622022-08-24 20:07:22 +01004780 }
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004781 dict_add_number(d, "quickfix", (long)IS_QF_LIST(qfl));
4782 dict_add_number(d, "winid", (long)qf_winid);
4783 dict_add_number(d, "id", (long)qfl->qf_id);
4784 dict_add_number(d, "start_idx", start_idx);
4785 dict_add_number(d, "end_idx", end_idx);
4786 ++d->dv_refcount;
4787 args[0].v_type = VAR_DICT;
4788 args[0].vval.v_dict = d;
4789
Bram Moolenaard43906d2020-07-20 21:31:32 +02004790 qftf_list = NULL;
4791 if (call_callback(cb, 0, &rettv, 1, args) != FAIL)
4792 {
4793 if (rettv.v_type == VAR_LIST)
4794 {
4795 qftf_list = rettv.vval.v_list;
4796 qftf_list->lv_refcount++;
4797 }
4798 clear_tv(&rettv);
4799 }
4800 dict_unref(d);
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004801 }
4802
Bram Moolenaard6c67622022-08-24 20:07:22 +01004803 recursive = FALSE;
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004804 return qftf_list;
4805}
4806
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004807/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808 * Fill current buffer with quickfix errors, replacing any previous contents.
4809 * curbuf must be the quickfix buffer!
Bram Moolenaar864293a2016-06-02 13:40:04 +02004810 * If "old_last" is not NULL append the items after this one.
4811 * When "old_last" is NULL then "buf" must equal "curbuf"! Because
4812 * ml_delete() is used and autocommands will be triggered.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 */
4814 static void
Bram Moolenaar7ba5a7e2020-06-08 19:20:27 +02004815qf_fill_buffer(qf_list_T *qfl, buf_T *buf, qfline_T *old_last, int qf_winid)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004816{
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004817 linenr_T lnum;
4818 qfline_T *qfp;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00004819 int old_KeyTyped = KeyTyped;
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004820 list_T *qftf_list = NULL;
4821 listitem_T *qftf_li = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822
Bram Moolenaar864293a2016-06-02 13:40:04 +02004823 if (old_last == NULL)
4824 {
4825 if (buf != curbuf)
4826 {
Bram Moolenaar95f09602016-11-10 20:01:45 +01004827 internal_error("qf_fill_buffer()");
Bram Moolenaar864293a2016-06-02 13:40:04 +02004828 return;
4829 }
4830
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004831 // delete all existing lines
Christian Brabandtf0d3d4a2024-02-15 20:15:04 +01004832 //
4833 // Note: we cannot store undo information, because
4834 // qf buffer is usually not allowed to be modified.
4835 //
4836 // So we need to clean up undo information
4837 // otherwise autocommands may invalidate the undo stack
Bram Moolenaar864293a2016-06-02 13:40:04 +02004838 while ((curbuf->b_ml.ml_flags & ML_EMPTY) == 0)
Bram Moolenaarca70c072020-05-30 20:30:46 +02004839 (void)ml_delete((linenr_T)1);
Christian Brabandtf0d3d4a2024-02-15 20:15:04 +01004840
4841 // Remove all undo information
Christian Brabandt9071ed82024-02-15 20:17:37 +01004842 u_clearallandblockfree(curbuf);
Bram Moolenaar864293a2016-06-02 13:40:04 +02004843 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004844
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004845 // Check if there is anything to display
Bram Moolenaar4f1b0832022-08-29 20:45:16 +01004846 if (qfl != NULL && qfl->qf_start != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 {
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004848 char_u dirname[MAXPATHL];
Bram Moolenaard43906d2020-07-20 21:31:32 +02004849 int invalid_val = FALSE;
Bram Moolenaar8ec92c92020-09-29 22:47:03 +02004850 int prev_bufnr = -1;
Bram Moolenaara796d462018-05-01 14:30:36 +02004851
4852 *dirname = NUL;
4853
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004854 // Add one line for each error
Bram Moolenaar2ce77902020-11-14 13:15:24 +01004855 if (old_last == NULL)
Bram Moolenaar864293a2016-06-02 13:40:04 +02004856 {
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004857 qfp = qfl->qf_start;
Bram Moolenaar864293a2016-06-02 13:40:04 +02004858 lnum = 0;
4859 }
4860 else
4861 {
Bram Moolenaar2ce77902020-11-14 13:15:24 +01004862 if (old_last->qf_next != NULL)
4863 qfp = old_last->qf_next;
4864 else
4865 qfp = old_last;
Bram Moolenaar864293a2016-06-02 13:40:04 +02004866 lnum = buf->b_ml.ml_line_count;
4867 }
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004868
4869 qftf_list = call_qftf_func(qfl, qf_winid, (long)(lnum + 1),
4870 (long)qfl->qf_count);
4871 if (qftf_list != NULL)
4872 qftf_li = qftf_list->lv_first;
4873
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004874 while (lnum < qfl->qf_count)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 {
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004876 char_u *qftf_str = NULL;
4877
Bram Moolenaard43906d2020-07-20 21:31:32 +02004878 // Use the text supplied by the user defined function (if any).
4879 // If the returned value is not string, then ignore the rest
4880 // of the returned values and use the default.
4881 if (qftf_li != NULL && !invalid_val)
4882 {
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004883 qftf_str = tv_get_string_chk(&qftf_li->li_tv);
Bram Moolenaard43906d2020-07-20 21:31:32 +02004884 if (qftf_str == NULL)
4885 invalid_val = TRUE;
4886 }
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004887
Bram Moolenaar8ec92c92020-09-29 22:47:03 +02004888 if (qf_buf_add_line(buf, lnum, qfp, dirname,
4889 prev_bufnr != qfp->qf_fnum, qftf_str) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 break;
Bram Moolenaar6053f2d2018-05-21 16:56:38 +02004891
Bram Moolenaar8ec92c92020-09-29 22:47:03 +02004892 prev_bufnr = qfp->qf_fnum;
Bram Moolenaar864293a2016-06-02 13:40:04 +02004893 ++lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894 qfp = qfp->qf_next;
Bram Moolenaar83e6d7a2016-06-02 22:08:05 +02004895 if (qfp == NULL)
4896 break;
Bram Moolenaar00e260b2020-06-11 19:35:52 +02004897
4898 if (qftf_li != NULL)
4899 qftf_li = qftf_li->li_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900 }
Bram Moolenaar864293a2016-06-02 13:40:04 +02004901
4902 if (old_last == NULL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004903 // Delete the empty line which is now at the end
Bram Moolenaarca70c072020-05-30 20:30:46 +02004904 (void)ml_delete(lnum + 1);
Yegappan Lakshmanand8cd6f72022-10-16 11:30:48 +01004905
4906 qfga_clear();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 }
4908
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004909 // correct cursor position
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 check_lnums(TRUE);
4911
Bram Moolenaar864293a2016-06-02 13:40:04 +02004912 if (old_last == NULL)
4913 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004914 // Set the 'filetype' to "qf" each time after filling the buffer.
4915 // This resembles reading a file into a buffer, it's more logical when
4916 // using autocommands.
Bram Moolenaar18141832017-06-25 21:17:25 +02004917 ++curbuf_lock;
Bram Moolenaar31e5c602022-04-15 13:53:33 +01004918 set_option_value_give_err((char_u *)"ft",
4919 0L, (char_u *)"qf", OPT_LOCAL);
Bram Moolenaar864293a2016-06-02 13:40:04 +02004920 curbuf->b_p_ma = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004922 keep_filetype = TRUE; // don't detect 'filetype'
Bram Moolenaar864293a2016-06-02 13:40:04 +02004923 apply_autocmds(EVENT_BUFREADPOST, (char_u *)"quickfix", NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924 FALSE, curbuf);
Bram Moolenaar864293a2016-06-02 13:40:04 +02004925 apply_autocmds(EVENT_BUFWINENTER, (char_u *)"quickfix", NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 FALSE, curbuf);
Bram Moolenaar864293a2016-06-02 13:40:04 +02004927 keep_filetype = FALSE;
Bram Moolenaar18141832017-06-25 21:17:25 +02004928 --curbuf_lock;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004929
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004930 // make sure it will be redrawn
Bram Moolenaara4d158b2022-08-14 14:17:45 +01004931 redraw_curbuf_later(UPD_NOT_VALID);
Bram Moolenaar864293a2016-06-02 13:40:04 +02004932 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02004934 // Restore KeyTyped, setting 'filetype' may reset it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 KeyTyped = old_KeyTyped;
4936}
4937
Bram Moolenaar18cebf42018-05-08 22:31:37 +02004938/*
4939 * For every change made to the quickfix list, update the changed tick.
4940 */
Bram Moolenaarb254af32017-12-18 19:48:58 +01004941 static void
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004942qf_list_changed(qf_list_T *qfl)
Bram Moolenaarb254af32017-12-18 19:48:58 +01004943{
Bram Moolenaar108e7b42018-10-11 17:39:12 +02004944 qfl->qf_changedtick++;
Bram Moolenaarb254af32017-12-18 19:48:58 +01004945}
4946
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947/*
Bram Moolenaar531b9a32018-07-03 16:54:23 +02004948 * Return the quickfix/location list number with the given identifier.
4949 * Returns -1 if list is not found.
4950 */
4951 static int
4952qf_id2nr(qf_info_T *qi, int_u qfid)
4953{
4954 int qf_idx;
4955
4956 for (qf_idx = 0; qf_idx < qi->qf_listcount; qf_idx++)
4957 if (qi->qf_lists[qf_idx].qf_id == qfid)
4958 return qf_idx;
4959 return INVALID_QFIDX;
4960}
4961
4962/*
Bram Moolenaar38efd1d2018-08-09 21:52:24 +02004963 * If the current list is not "save_qfid" and we can find the list with that ID
4964 * then make it the current list.
4965 * This is used when autocommands may have changed the current list.
Bram Moolenaar90f1e2b2018-08-11 13:36:56 +02004966 * Returns OK if successfully restored the list. Returns FAIL if the list with
4967 * the specified identifier (save_qfid) is not found in the stack.
Bram Moolenaar38efd1d2018-08-09 21:52:24 +02004968 */
Bram Moolenaar90f1e2b2018-08-11 13:36:56 +02004969 static int
Bram Moolenaar38efd1d2018-08-09 21:52:24 +02004970qf_restore_list(qf_info_T *qi, int_u save_qfid)
4971{
4972 int curlist;
4973
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00004974 if (qf_get_curlist(qi)->qf_id == save_qfid)
4975 return OK;
4976
4977 curlist = qf_id2nr(qi, save_qfid);
4978 if (curlist < 0)
4979 // list is not present
4980 return FAIL;
4981 qi->qf_curlist = curlist;
Bram Moolenaar90f1e2b2018-08-11 13:36:56 +02004982 return OK;
Bram Moolenaar38efd1d2018-08-09 21:52:24 +02004983}
4984
4985/*
Bram Moolenaar8d8a65e2018-08-07 19:48:08 +02004986 * Jump to the first entry if there is one.
4987 */
4988 static void
4989qf_jump_first(qf_info_T *qi, int_u save_qfid, int forceit)
4990{
Bram Moolenaar90f1e2b2018-08-11 13:36:56 +02004991 if (qf_restore_list(qi, save_qfid) == FAIL)
4992 return;
Bram Moolenaar8d8a65e2018-08-07 19:48:08 +02004993
Bram Moolenaar90f1e2b2018-08-11 13:36:56 +02004994 // Autocommands might have cleared the list, check for that.
Bram Moolenaar0398e002019-03-21 21:12:49 +01004995 if (!qf_list_empty(qf_get_curlist(qi)))
Bram Moolenaar8d8a65e2018-08-07 19:48:08 +02004996 qf_jump(qi, 0, 0, forceit);
4997}
4998
4999/*
Bram Moolenaar86b68352004-12-27 21:59:20 +00005000 * Return TRUE when using ":vimgrep" for ":grep".
5001 */
5002 int
Bram Moolenaar05540972016-01-30 20:31:25 +01005003grep_internal(cmdidx_T cmdidx)
Bram Moolenaar86b68352004-12-27 21:59:20 +00005004{
Bram Moolenaar754b5602006-02-09 23:53:20 +00005005 return ((cmdidx == CMD_grep
5006 || cmdidx == CMD_lgrep
5007 || cmdidx == CMD_grepadd
5008 || cmdidx == CMD_lgrepadd)
Bram Moolenaar86b68352004-12-27 21:59:20 +00005009 && STRCMP("internal",
5010 *curbuf->b_p_gp == NUL ? p_gp : curbuf->b_p_gp) == 0);
5011}
5012
5013/*
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005014 * Return the make/grep autocmd name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 */
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005016 static char_u *
5017make_get_auname(cmdidx_T cmdidx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018{
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005019 switch (cmdidx)
Bram Moolenaard88e02d2011-04-28 17:27:09 +02005020 {
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005021 case CMD_make: return (char_u *)"make";
5022 case CMD_lmake: return (char_u *)"lmake";
5023 case CMD_grep: return (char_u *)"grep";
5024 case CMD_lgrep: return (char_u *)"lgrep";
5025 case CMD_grepadd: return (char_u *)"grepadd";
5026 case CMD_lgrepadd: return (char_u *)"lgrepadd";
5027 default: return NULL;
Bram Moolenaard88e02d2011-04-28 17:27:09 +02005028 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029}
5030
5031/*
5032 * Return the name for the errorfile, in allocated memory.
5033 * Find a new unique name when 'makeef' contains "##".
5034 * Returns NULL for error.
5035 */
5036 static char_u *
Bram Moolenaar05540972016-01-30 20:31:25 +01005037get_mef_name(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038{
5039 char_u *p;
5040 char_u *name;
5041 static int start = -1;
5042 static int off = 0;
5043#ifdef HAVE_LSTAT
Bram Moolenaar8767f522016-07-01 17:17:39 +02005044 stat_T sb;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045#endif
5046
5047 if (*p_mef == NUL)
5048 {
Bram Moolenaare5c421c2015-03-31 13:33:08 +02005049 name = vim_tempname('e', FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 if (name == NULL)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00005051 emsg(_(e_cant_get_temp_file_name));
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052 return name;
5053 }
5054
5055 for (p = p_mef; *p; ++p)
5056 if (p[0] == '#' && p[1] == '#')
5057 break;
5058
5059 if (*p == NUL)
5060 return vim_strsave(p_mef);
5061
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005062 // Keep trying until the name doesn't exist yet.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005063 for (;;)
5064 {
5065 if (start == -1)
5066 start = mch_get_pid();
5067 else
5068 off += 19;
5069
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +00005070 name = alloc_id(STRLEN(p_mef) + 30, aid_qf_mef_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071 if (name == NULL)
5072 break;
5073 STRCPY(name, p_mef);
5074 sprintf((char *)name + (p - p_mef), "%d%d", start, off);
5075 STRCAT(name, p + 2);
5076 if (mch_getperm(name) < 0
5077#ifdef HAVE_LSTAT
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005078 // Don't accept a symbolic link, it's a security risk.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 && mch_lstat((char *)name, &sb) < 0
5080#endif
5081 )
5082 break;
5083 vim_free(name);
5084 }
5085 return name;
5086}
5087
5088/*
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005089 * Form the complete command line to invoke 'make'/'grep'. Quote the command
5090 * using 'shellquote' and append 'shellpipe'. Echo the fully formed command.
5091 */
5092 static char_u *
5093make_get_fullcmd(char_u *makecmd, char_u *fname)
5094{
5095 char_u *cmd;
5096 unsigned len;
5097
5098 len = (unsigned)STRLEN(p_shq) * 2 + (unsigned)STRLEN(makecmd) + 1;
5099 if (*p_sp != NUL)
5100 len += (unsigned)STRLEN(p_sp) + (unsigned)STRLEN(fname) + 3;
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +00005101 cmd = alloc_id(len, aid_qf_makecmd);
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005102 if (cmd == NULL)
5103 return NULL;
5104 sprintf((char *)cmd, "%s%s%s", (char *)p_shq, (char *)makecmd,
5105 (char *)p_shq);
5106
5107 // If 'shellpipe' empty: don't redirect to 'errorfile'.
5108 if (*p_sp != NUL)
5109 append_redir(cmd, len, p_sp, fname);
5110
5111 // Display the fully formed command. Output a newline if there's something
5112 // else than the :make command that was typed (in which case the cursor is
5113 // in column 0).
5114 if (msg_col == 0)
5115 msg_didout = FALSE;
5116 msg_start();
Bram Moolenaar32526b32019-01-19 17:43:09 +01005117 msg_puts(":!");
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005118 msg_outtrans(cmd); // show what we are doing
5119
5120 return cmd;
5121}
5122
5123/*
5124 * Used for ":make", ":lmake", ":grep", ":lgrep", ":grepadd", and ":lgrepadd"
5125 */
5126 void
5127ex_make(exarg_T *eap)
5128{
5129 char_u *fname;
5130 char_u *cmd;
5131 char_u *enc = NULL;
5132 win_T *wp = NULL;
5133 qf_info_T *qi = &ql_info;
5134 int res;
5135 char_u *au_name = NULL;
5136 int_u save_qfid;
Yegappan Lakshmanan2f87a992022-03-02 20:29:35 +00005137 char_u *errorformat = p_efm;
5138 int newlist = TRUE;
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005139
5140 // Redirect ":grep" to ":vimgrep" if 'grepprg' is "internal".
5141 if (grep_internal(eap->cmdidx))
5142 {
5143 ex_vimgrep(eap);
5144 return;
5145 }
5146
5147 au_name = make_get_auname(eap->cmdidx);
5148 if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
5149 curbuf->b_fname, TRUE, curbuf))
5150 {
5151#ifdef FEAT_EVAL
5152 if (aborting())
5153 return;
5154#endif
5155 }
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005156 enc = (*curbuf->b_p_menc != NUL) ? curbuf->b_p_menc : p_menc;
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005157
5158 if (is_loclist_cmd(eap->cmdidx))
5159 wp = curwin;
5160
5161 autowrite_all();
5162 fname = get_mef_name();
5163 if (fname == NULL)
5164 return;
5165 mch_remove(fname); // in case it's not unique
5166
5167 cmd = make_get_fullcmd(eap->arg, fname);
5168 if (cmd == NULL)
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +00005169 {
5170 vim_free(fname);
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005171 return;
Yegappan Lakshmanan5a2d4a32022-02-26 10:31:32 +00005172 }
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005173
5174 // let the shell know if we are redirecting output or not
5175 do_shell(cmd, *p_sp != NUL ? SHELL_DOOUT : 0);
5176
5177#ifdef AMIGA
5178 out_flush();
5179 // read window status report and redraw before message
5180 (void)char_avail();
5181#endif
5182
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02005183 incr_quickfix_busy();
5184
Yegappan Lakshmanan2f87a992022-03-02 20:29:35 +00005185 if (eap->cmdidx != CMD_make && eap->cmdidx != CMD_lmake)
5186 errorformat = p_gefm;
5187 if (eap->cmdidx == CMD_grepadd || eap->cmdidx == CMD_lgrepadd)
5188 newlist = FALSE;
5189
5190 res = qf_init(wp, fname, errorformat, newlist, qf_cmdtitle(*eap->cmdlinep),
5191 enc);
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005192 if (wp != NULL)
5193 {
5194 qi = GET_LOC_LIST(wp);
5195 if (qi == NULL)
5196 goto cleanup;
5197 }
5198 if (res >= 0)
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01005199 qf_list_changed(qf_get_curlist(qi));
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005200
5201 // Remember the current quickfix list identifier, so that we can
5202 // check for autocommands changing the current quickfix list.
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01005203 save_qfid = qf_get_curlist(qi)->qf_id;
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005204 if (au_name != NULL)
5205 apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
5206 curbuf->b_fname, TRUE, curbuf);
5207 if (res > 0 && !eap->forceit && qflist_valid(wp, save_qfid))
5208 // display the first error
5209 qf_jump_first(qi, save_qfid, FALSE);
5210
5211cleanup:
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02005212 decr_quickfix_busy();
Bram Moolenaarb434ae22018-09-28 23:09:55 +02005213 mch_remove(fname);
5214 vim_free(fname);
5215 vim_free(cmd);
5216}
5217
5218/*
Bram Moolenaar25190db2019-05-04 15:05:28 +02005219 * Returns the number of entries in the current quickfix/location list.
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005220 */
5221 int
Bram Moolenaar05540972016-01-30 20:31:25 +01005222qf_get_size(exarg_T *eap)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005223{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005224 qf_info_T *qi;
Bram Moolenaar25190db2019-05-04 15:05:28 +02005225
5226 if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
5227 return 0;
5228 return qf_get_curlist(qi)->qf_count;
5229}
5230
5231/*
5232 * Returns the number of valid entries in the current quickfix/location list.
5233 */
5234 int
5235qf_get_valid_size(exarg_T *eap)
5236{
5237 qf_info_T *qi;
Bram Moolenaar108e7b42018-10-11 17:39:12 +02005238 qf_list_T *qfl;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005239 qfline_T *qfp;
5240 int i, sz = 0;
5241 int prev_fnum = 0;
5242
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005243 if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
5244 return 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005245
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01005246 qfl = qf_get_curlist(qi);
Bram Moolenaara16123a2019-03-28 20:31:07 +01005247 FOR_ALL_QFL_ITEMS(qfl, qfp, i)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005248 {
5249 if (qfp->qf_valid)
5250 {
5251 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005252 sz++; // Count all valid entries
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005253 else if (qfp->qf_fnum > 0 && qfp->qf_fnum != prev_fnum)
5254 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005255 // Count the number of files
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005256 sz++;
5257 prev_fnum = qfp->qf_fnum;
5258 }
5259 }
5260 }
5261
5262 return sz;
5263}
5264
5265/*
5266 * Returns the current index of the quickfix/location list.
5267 * Returns 0 if there is an error.
5268 */
5269 int
Bram Moolenaar05540972016-01-30 20:31:25 +01005270qf_get_cur_idx(exarg_T *eap)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005271{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005272 qf_info_T *qi;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005273
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005274 if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
5275 return 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005276
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01005277 return qf_get_curlist(qi)->qf_index;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005278}
5279
5280/*
5281 * Returns the current index in the quickfix/location list (counting only valid
5282 * entries). If no valid entries are in the list, then returns 1.
5283 */
5284 int
Bram Moolenaar05540972016-01-30 20:31:25 +01005285qf_get_cur_valid_idx(exarg_T *eap)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005286{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005287 qf_info_T *qi;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005288 qf_list_T *qfl;
5289 qfline_T *qfp;
5290 int i, eidx = 0;
5291 int prev_fnum = 0;
5292
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005293 if ((qi = qf_cmd_get_stack(eap, FALSE)) == NULL)
5294 return 1;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005295
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01005296 qfl = qf_get_curlist(qi);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005297 qfp = qfl->qf_start;
5298
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005299 // check if the list has valid errors
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005300 if (!qf_list_has_valid_entries(qfl))
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005301 return 1;
5302
5303 for (i = 1; i <= qfl->qf_index && qfp!= NULL; i++, qfp = qfp->qf_next)
5304 {
5305 if (qfp->qf_valid)
5306 {
5307 if (eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
5308 {
5309 if (qfp->qf_fnum > 0 && qfp->qf_fnum != prev_fnum)
5310 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005311 // Count the number of files
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005312 eidx++;
5313 prev_fnum = qfp->qf_fnum;
5314 }
5315 }
5316 else
5317 eidx++;
5318 }
5319 }
5320
5321 return eidx ? eidx : 1;
5322}
5323
5324/*
5325 * Get the 'n'th valid error entry in the quickfix or location list.
5326 * Used by :cdo, :ldo, :cfdo and :lfdo commands.
5327 * For :cdo and :ldo returns the 'n'th valid error entry.
5328 * For :cfdo and :lfdo returns the 'n'th valid file entry.
5329 */
5330 static int
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02005331qf_get_nth_valid_entry(qf_list_T *qfl, int n, int fdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005332{
Bram Moolenaar95946f12019-03-31 15:31:59 +02005333 qfline_T *qfp;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005334 int i, eidx;
5335 int prev_fnum = 0;
5336
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005337 // check if the list has valid errors
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005338 if (!qf_list_has_valid_entries(qfl))
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005339 return 1;
5340
Bram Moolenaar95946f12019-03-31 15:31:59 +02005341 eidx = 0;
5342 FOR_ALL_QFL_ITEMS(qfl, qfp, i)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005343 {
5344 if (qfp->qf_valid)
5345 {
5346 if (fdo)
5347 {
5348 if (qfp->qf_fnum > 0 && qfp->qf_fnum != prev_fnum)
5349 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005350 // Count the number of files
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005351 eidx++;
5352 prev_fnum = qfp->qf_fnum;
5353 }
5354 }
5355 else
5356 eidx++;
5357 }
5358
5359 if (eidx == n)
5360 break;
5361 }
5362
5363 if (i <= qfl->qf_count)
5364 return i;
5365 else
5366 return 1;
5367}
5368
5369/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005370 * ":cc", ":crewind", ":cfirst" and ":clast".
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005371 * ":ll", ":lrewind", ":lfirst" and ":llast".
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005372 * ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 */
5374 void
Bram Moolenaar05540972016-01-30 20:31:25 +01005375ex_cc(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005377 qf_info_T *qi;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005378 int errornr;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005379
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005380 if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
5381 return;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005382
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005383 if (eap->addr_count > 0)
5384 errornr = (int)eap->line2;
5385 else
5386 {
Bram Moolenaar39665952018-08-15 20:59:48 +02005387 switch (eap->cmdidx)
5388 {
5389 case CMD_cc: case CMD_ll:
5390 errornr = 0;
5391 break;
5392 case CMD_crewind: case CMD_lrewind: case CMD_cfirst:
5393 case CMD_lfirst:
5394 errornr = 1;
5395 break;
5396 default:
5397 errornr = 32767;
5398 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005399 }
5400
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005401 // For cdo and ldo commands, jump to the nth valid error.
5402 // For cfdo and lfdo commands, jump to the nth valid file entry.
Bram Moolenaar55b69262017-08-13 13:42:01 +02005403 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
5404 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01005405 errornr = qf_get_nth_valid_entry(qf_get_curlist(qi),
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005406 eap->addr_count > 0 ? (int)eap->line1 : 1,
5407 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo);
5408
5409 qf_jump(qi, 0, errornr, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410}
5411
5412/*
5413 * ":cnext", ":cnfile", ":cNext" and ":cprevious".
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005414 * ":lnext", ":lNext", ":lprevious", ":lnfile", ":lNfile" and ":lpfile".
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005415 * Also, used by ":cdo", ":ldo", ":cfdo" and ":lfdo" commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005416 */
5417 void
Bram Moolenaar05540972016-01-30 20:31:25 +01005418ex_cnext(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419{
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005420 qf_info_T *qi;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005421 int errornr;
Bram Moolenaar39665952018-08-15 20:59:48 +02005422 int dir;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005423
Bram Moolenaar87f59b02019-04-04 14:04:11 +02005424 if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
5425 return;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005426
Bram Moolenaar55b69262017-08-13 13:42:01 +02005427 if (eap->addr_count > 0
5428 && (eap->cmdidx != CMD_cdo && eap->cmdidx != CMD_ldo
5429 && eap->cmdidx != CMD_cfdo && eap->cmdidx != CMD_lfdo))
Bram Moolenaaraa23b372015-09-08 18:46:31 +02005430 errornr = (int)eap->line2;
5431 else
5432 errornr = 1;
5433
Bram Moolenaar39665952018-08-15 20:59:48 +02005434 // Depending on the command jump to either next or previous entry/file.
5435 switch (eap->cmdidx)
5436 {
5437 case CMD_cnext: case CMD_lnext: case CMD_cdo: case CMD_ldo:
5438 dir = FORWARD;
5439 break;
5440 case CMD_cprevious: case CMD_lprevious: case CMD_cNext:
5441 case CMD_lNext:
5442 dir = BACKWARD;
5443 break;
5444 case CMD_cnfile: case CMD_lnfile: case CMD_cfdo: case CMD_lfdo:
5445 dir = FORWARD_FILE;
5446 break;
5447 case CMD_cpfile: case CMD_lpfile: case CMD_cNfile: case CMD_lNfile:
5448 dir = BACKWARD_FILE;
5449 break;
5450 default:
5451 dir = FORWARD;
5452 break;
5453 }
5454
5455 qf_jump(qi, dir, errornr, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005456}
5457
5458/*
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005459 * Find the first entry in the quickfix list 'qfl' from buffer 'bnr'.
5460 * The index of the entry is stored in 'errornr'.
5461 * Returns NULL if an entry is not found.
5462 */
5463 static qfline_T *
5464qf_find_first_entry_in_buf(qf_list_T *qfl, int bnr, int *errornr)
5465{
5466 qfline_T *qfp = NULL;
5467 int idx = 0;
5468
5469 // Find the first entry in this file
5470 FOR_ALL_QFL_ITEMS(qfl, qfp, idx)
5471 if (qfp->qf_fnum == bnr)
5472 break;
5473
5474 *errornr = idx;
5475 return qfp;
5476}
5477
5478/*
5479 * Find the first quickfix entry on the same line as 'entry'. Updates 'errornr'
5480 * with the error number for the first entry. Assumes the entries are sorted in
5481 * the quickfix list by line number.
5482 */
5483 static qfline_T *
5484qf_find_first_entry_on_line(qfline_T *entry, int *errornr)
5485{
5486 while (!got_int
5487 && entry->qf_prev != NULL
5488 && entry->qf_fnum == entry->qf_prev->qf_fnum
5489 && entry->qf_lnum == entry->qf_prev->qf_lnum)
5490 {
5491 entry = entry->qf_prev;
5492 --*errornr;
5493 }
5494
5495 return entry;
5496}
5497
5498/*
5499 * Find the last quickfix entry on the same line as 'entry'. Updates 'errornr'
5500 * with the error number for the last entry. Assumes the entries are sorted in
5501 * the quickfix list by line number.
5502 */
5503 static qfline_T *
5504qf_find_last_entry_on_line(qfline_T *entry, int *errornr)
5505{
5506 while (!got_int &&
5507 entry->qf_next != NULL
5508 && entry->qf_fnum == entry->qf_next->qf_fnum
5509 && entry->qf_lnum == entry->qf_next->qf_lnum)
5510 {
5511 entry = entry->qf_next;
5512 ++*errornr;
5513 }
5514
5515 return entry;
5516}
5517
5518/*
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005519 * Returns TRUE if the specified quickfix entry is
5520 * after the given line (linewise is TRUE)
5521 * or after the line and column.
5522 */
5523 static int
5524qf_entry_after_pos(qfline_T *qfp, pos_T *pos, int linewise)
5525{
5526 if (linewise)
5527 return qfp->qf_lnum > pos->lnum;
5528 else
5529 return (qfp->qf_lnum > pos->lnum ||
5530 (qfp->qf_lnum == pos->lnum && qfp->qf_col > pos->col));
5531}
5532
5533/*
5534 * Returns TRUE if the specified quickfix entry is
5535 * before the given line (linewise is TRUE)
5536 * or before the line and column.
5537 */
5538 static int
5539qf_entry_before_pos(qfline_T *qfp, pos_T *pos, int linewise)
5540{
5541 if (linewise)
5542 return qfp->qf_lnum < pos->lnum;
5543 else
5544 return (qfp->qf_lnum < pos->lnum ||
5545 (qfp->qf_lnum == pos->lnum && qfp->qf_col < pos->col));
5546}
5547
5548/*
5549 * Returns TRUE if the specified quickfix entry is
5550 * on or after the given line (linewise is TRUE)
5551 * or on or after the line and column.
5552 */
5553 static int
5554qf_entry_on_or_after_pos(qfline_T *qfp, pos_T *pos, int linewise)
5555{
5556 if (linewise)
5557 return qfp->qf_lnum >= pos->lnum;
5558 else
5559 return (qfp->qf_lnum > pos->lnum ||
5560 (qfp->qf_lnum == pos->lnum && qfp->qf_col >= pos->col));
5561}
5562
5563/*
5564 * Returns TRUE if the specified quickfix entry is
5565 * on or before the given line (linewise is TRUE)
5566 * or on or before the line and column.
5567 */
5568 static int
5569qf_entry_on_or_before_pos(qfline_T *qfp, pos_T *pos, int linewise)
5570{
5571 if (linewise)
5572 return qfp->qf_lnum <= pos->lnum;
5573 else
5574 return (qfp->qf_lnum < pos->lnum ||
5575 (qfp->qf_lnum == pos->lnum && qfp->qf_col <= pos->col));
5576}
5577
5578/*
5579 * Find the first quickfix entry after position 'pos' in buffer 'bnr'.
5580 * If 'linewise' is TRUE, returns the entry after the specified line and treats
5581 * multiple entries on a single line as one. Otherwise returns the entry after
5582 * the specified line and column.
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005583 * 'qfp' points to the very first entry in the buffer and 'errornr' is the
5584 * index of the very first entry in the quickfix list.
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005585 * Returns NULL if an entry is not found after 'pos'.
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005586 */
5587 static qfline_T *
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005588qf_find_entry_after_pos(
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005589 int bnr,
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005590 pos_T *pos,
5591 int linewise,
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005592 qfline_T *qfp,
5593 int *errornr)
5594{
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005595 if (qf_entry_after_pos(qfp, pos, linewise))
Bram Moolenaar32aa1022019-11-02 22:54:41 +01005596 // First entry is after position 'pos'
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005597 return qfp;
5598
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005599 // Find the entry just before or at the position 'pos'
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005600 while (qfp->qf_next != NULL
5601 && qfp->qf_next->qf_fnum == bnr
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005602 && qf_entry_on_or_before_pos(qfp->qf_next, pos, linewise))
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005603 {
5604 qfp = qfp->qf_next;
5605 ++*errornr;
5606 }
5607
5608 if (qfp->qf_next == NULL || qfp->qf_next->qf_fnum != bnr)
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005609 // No entries found after position 'pos'
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005610 return NULL;
5611
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005612 // Use the entry just after position 'pos'
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005613 qfp = qfp->qf_next;
5614 ++*errornr;
5615
5616 return qfp;
5617}
5618
5619/*
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005620 * Find the first quickfix entry before position 'pos' in buffer 'bnr'.
5621 * If 'linewise' is TRUE, returns the entry before the specified line and
5622 * treats multiple entries on a single line as one. Otherwise returns the entry
5623 * before the specified line and column.
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005624 * 'qfp' points to the very first entry in the buffer and 'errornr' is the
5625 * index of the very first entry in the quickfix list.
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005626 * Returns NULL if an entry is not found before 'pos'.
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005627 */
5628 static qfline_T *
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005629qf_find_entry_before_pos(
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005630 int bnr,
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005631 pos_T *pos,
5632 int linewise,
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005633 qfline_T *qfp,
5634 int *errornr)
5635{
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005636 // Find the entry just before the position 'pos'
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005637 while (qfp->qf_next != NULL
5638 && qfp->qf_next->qf_fnum == bnr
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005639 && qf_entry_before_pos(qfp->qf_next, pos, linewise))
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005640 {
5641 qfp = qfp->qf_next;
5642 ++*errornr;
5643 }
5644
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005645 if (qf_entry_on_or_after_pos(qfp, pos, linewise))
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005646 return NULL;
5647
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005648 if (linewise)
5649 // If multiple entries are on the same line, then use the first entry
5650 qfp = qf_find_first_entry_on_line(qfp, errornr);
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005651
5652 return qfp;
5653}
5654
5655/*
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005656 * Find a quickfix entry in 'qfl' closest to position 'pos' in buffer 'bnr' in
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005657 * the direction 'dir'.
5658 */
5659 static qfline_T *
5660qf_find_closest_entry(
5661 qf_list_T *qfl,
5662 int bnr,
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005663 pos_T *pos,
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005664 int dir,
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005665 int linewise,
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005666 int *errornr)
5667{
5668 qfline_T *qfp;
5669
5670 *errornr = 0;
5671
5672 // Find the first entry in this file
5673 qfp = qf_find_first_entry_in_buf(qfl, bnr, errornr);
5674 if (qfp == NULL)
5675 return NULL; // no entry in this file
5676
5677 if (dir == FORWARD)
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005678 qfp = qf_find_entry_after_pos(bnr, pos, linewise, qfp, errornr);
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005679 else
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005680 qfp = qf_find_entry_before_pos(bnr, pos, linewise, qfp, errornr);
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005681
5682 return qfp;
5683}
5684
5685/*
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005686 * Get the nth quickfix entry below the specified entry. Searches forward in
5687 * the list. If linewise is TRUE, then treat multiple entries on a single line
5688 * as one.
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005689 */
Bram Moolenaar64416122019-06-07 21:37:13 +02005690 static void
Bram Moolenaard6a98a32019-11-12 22:59:51 +01005691qf_get_nth_below_entry(qfline_T *entry_arg, int n, int linewise, int *errornr)
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005692{
Bram Moolenaard6a98a32019-11-12 22:59:51 +01005693 qfline_T *entry = entry_arg;
5694
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005695 while (n-- > 0 && !got_int)
5696 {
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005697 int first_errornr = *errornr;
5698
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005699 if (linewise)
5700 // Treat all the entries on the same line in this file as one
5701 entry = qf_find_last_entry_on_line(entry, errornr);
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005702
5703 if (entry->qf_next == NULL
5704 || entry->qf_next->qf_fnum != entry->qf_fnum)
5705 {
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005706 if (linewise)
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005707 *errornr = first_errornr;
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005708 break;
5709 }
5710
5711 entry = entry->qf_next;
5712 ++*errornr;
5713 }
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005714}
5715
5716/*
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005717 * Get the nth quickfix entry above the specified entry. Searches backwards in
5718 * the list. If linewise is TRUE, then treat multiple entries on a single line
5719 * as one.
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005720 */
Bram Moolenaar64416122019-06-07 21:37:13 +02005721 static void
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005722qf_get_nth_above_entry(qfline_T *entry, int n, int linewise, int *errornr)
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005723{
5724 while (n-- > 0 && !got_int)
5725 {
5726 if (entry->qf_prev == NULL
5727 || entry->qf_prev->qf_fnum != entry->qf_fnum)
5728 break;
5729
5730 entry = entry->qf_prev;
5731 --*errornr;
5732
5733 // If multiple entries are on the same line, then use the first entry
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005734 if (linewise)
5735 entry = qf_find_first_entry_on_line(entry, errornr);
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005736 }
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005737}
5738
5739/*
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005740 * Find the n'th quickfix entry adjacent to position 'pos' in buffer 'bnr' in
5741 * the specified direction. Returns the error number in the quickfix list or 0
5742 * if an entry is not found.
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005743 */
5744 static int
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005745qf_find_nth_adj_entry(
5746 qf_list_T *qfl,
5747 int bnr,
5748 pos_T *pos,
5749 int n,
5750 int dir,
5751 int linewise)
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005752{
5753 qfline_T *adj_entry;
5754 int errornr;
5755
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005756 // Find an entry closest to the specified position
5757 adj_entry = qf_find_closest_entry(qfl, bnr, pos, dir, linewise, &errornr);
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005758 if (adj_entry == NULL)
5759 return 0;
5760
5761 if (--n > 0)
5762 {
5763 // Go to the n'th entry in the current buffer
5764 if (dir == FORWARD)
Bram Moolenaar64416122019-06-07 21:37:13 +02005765 qf_get_nth_below_entry(adj_entry, n, linewise, &errornr);
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005766 else
Bram Moolenaar64416122019-06-07 21:37:13 +02005767 qf_get_nth_above_entry(adj_entry, n, linewise, &errornr);
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005768 }
5769
5770 return errornr;
5771}
5772
5773/*
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005774 * Jump to a quickfix entry in the current file nearest to the current line or
5775 * current line/col.
5776 * ":cabove", ":cbelow", ":labove", ":lbelow", ":cafter", ":cbefore",
5777 * ":lafter" and ":lbefore" commands
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005778 */
5779 void
5780ex_cbelow(exarg_T *eap)
5781{
5782 qf_info_T *qi;
5783 qf_list_T *qfl;
5784 int dir;
5785 int buf_has_flag;
5786 int errornr = 0;
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005787 pos_T pos;
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005788
5789 if (eap->addr_count > 0 && eap->line2 <= 0)
5790 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02005791 emsg(_(e_invalid_range));
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005792 return;
5793 }
5794
5795 // Check whether the current buffer has any quickfix entries
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005796 if (eap->cmdidx == CMD_cabove || eap->cmdidx == CMD_cbelow
5797 || eap->cmdidx == CMD_cbefore || eap->cmdidx == CMD_cafter)
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005798 buf_has_flag = BUF_HAS_QF_ENTRY;
5799 else
5800 buf_has_flag = BUF_HAS_LL_ENTRY;
5801 if (!(curbuf->b_has_qf_entry & buf_has_flag))
5802 {
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005803 emsg(_(e_no_errors));
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005804 return;
5805 }
5806
5807 if ((qi = qf_cmd_get_stack(eap, TRUE)) == NULL)
5808 return;
5809
5810 qfl = qf_get_curlist(qi);
5811 // check if the list has valid errors
5812 if (!qf_list_has_valid_entries(qfl))
5813 {
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005814 emsg(_(e_no_errors));
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005815 return;
5816 }
5817
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005818 if (eap->cmdidx == CMD_cbelow
5819 || eap->cmdidx == CMD_lbelow
5820 || eap->cmdidx == CMD_cafter
5821 || eap->cmdidx == CMD_lafter)
5822 // Forward motion commands
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005823 dir = FORWARD;
5824 else
5825 dir = BACKWARD;
5826
Bram Moolenaarcf6a55c2019-05-05 15:02:30 +02005827 pos = curwin->w_cursor;
5828 // A quickfix entry column number is 1 based whereas cursor column
5829 // number is 0 based. Adjust the column number.
5830 pos.col++;
5831 errornr = qf_find_nth_adj_entry(qfl, curbuf->b_fnum, &pos,
5832 eap->addr_count > 0 ? eap->line2 : 0, dir,
5833 eap->cmdidx == CMD_cbelow
5834 || eap->cmdidx == CMD_lbelow
5835 || eap->cmdidx == CMD_cabove
5836 || eap->cmdidx == CMD_labove);
Bram Moolenaar3ff33112019-05-03 21:56:35 +02005837
5838 if (errornr > 0)
5839 qf_jump(qi, 0, errornr, FALSE);
5840 else
5841 emsg(_(e_no_more_items));
5842}
5843
5844/*
Bram Moolenaara16123a2019-03-28 20:31:07 +01005845 * Return the autocmd name for the :cfile Ex commands
5846 */
5847 static char_u *
5848cfile_get_auname(cmdidx_T cmdidx)
5849{
5850 switch (cmdidx)
5851 {
5852 case CMD_cfile: return (char_u *)"cfile";
5853 case CMD_cgetfile: return (char_u *)"cgetfile";
5854 case CMD_caddfile: return (char_u *)"caddfile";
5855 case CMD_lfile: return (char_u *)"lfile";
5856 case CMD_lgetfile: return (char_u *)"lgetfile";
5857 case CMD_laddfile: return (char_u *)"laddfile";
5858 default: return NULL;
5859 }
5860}
5861
5862/*
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00005863 * ":cfile"/":cgetfile"/":caddfile" commands.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005864 * ":lfile"/":lgetfile"/":laddfile" commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005865 */
5866 void
Bram Moolenaar05540972016-01-30 20:31:25 +01005867ex_cfile(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868{
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005869 char_u *enc = NULL;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005870 win_T *wp = NULL;
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00005871 qf_info_T *qi = &ql_info;
Bram Moolenaar8ec1f852012-03-07 20:13:49 +01005872 char_u *au_name = NULL;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005873 int_u save_qfid = 0; // init for gcc
Bram Moolenaar1ed22762017-11-28 18:03:44 +01005874 int res;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00005875
Bram Moolenaara16123a2019-03-28 20:31:07 +01005876 au_name = cfile_get_auname(eap->cmdidx);
Bram Moolenaar6a0cc912019-10-26 16:48:44 +02005877 if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
5878 NULL, FALSE, curbuf))
5879 {
5880#ifdef FEAT_EVAL
5881 if (aborting())
5882 return;
5883#endif
5884 }
Bram Moolenaara16123a2019-03-28 20:31:07 +01005885
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01005886 enc = (*curbuf->b_p_menc != NUL) ? curbuf->b_p_menc : p_menc;
Bram Moolenaar9028b102010-07-11 16:58:51 +02005887#ifdef FEAT_BROWSE
Bram Moolenaare1004402020-10-24 20:49:43 +02005888 if (cmdmod.cmod_flags & CMOD_BROWSE)
Bram Moolenaar9028b102010-07-11 16:58:51 +02005889 {
5890 char_u *browse_file = do_browse(0, (char_u *)_("Error file"), eap->arg,
Bram Moolenaarc36651b2018-04-29 12:22:56 +02005891 NULL, NULL,
5892 (char_u *)_(BROWSE_FILTER_ALL_FILES), NULL);
Bram Moolenaar9028b102010-07-11 16:58:51 +02005893 if (browse_file == NULL)
5894 return;
5895 set_string_option_direct((char_u *)"ef", -1, browse_file, OPT_FREE, 0);
5896 vim_free(browse_file);
5897 }
5898 else
5899#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005900 if (*eap->arg != NUL)
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00005901 set_string_option_direct((char_u *)"ef", -1, eap->arg, OPT_FREE, 0);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00005902
Bram Moolenaar39665952018-08-15 20:59:48 +02005903 if (is_loclist_cmd(eap->cmdidx))
Bram Moolenaar14a4deb2017-12-19 16:48:55 +01005904 wp = curwin;
5905
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02005906 incr_quickfix_busy();
5907
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005908 // This function is used by the :cfile, :cgetfile and :caddfile
5909 // commands.
5910 // :cfile always creates a new quickfix list and jumps to the
5911 // first error.
5912 // :cgetfile creates a new quickfix list but doesn't jump to the
5913 // first error.
5914 // :caddfile adds to an existing quickfix list. If there is no
5915 // quickfix list then a new list is created.
Bram Moolenaar1ed22762017-11-28 18:03:44 +01005916 res = qf_init(wp, p_ef, p_efm, (eap->cmdidx != CMD_caddfile
Bram Moolenaar8b62e312018-05-13 15:29:04 +02005917 && eap->cmdidx != CMD_laddfile),
5918 qf_cmdtitle(*eap->cmdlinep), enc);
Bram Moolenaarb254af32017-12-18 19:48:58 +01005919 if (wp != NULL)
Bram Moolenaar531b9a32018-07-03 16:54:23 +02005920 {
Bram Moolenaarb254af32017-12-18 19:48:58 +01005921 qi = GET_LOC_LIST(wp);
Bram Moolenaar531b9a32018-07-03 16:54:23 +02005922 if (qi == NULL)
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02005923 {
5924 decr_quickfix_busy();
Bram Moolenaar531b9a32018-07-03 16:54:23 +02005925 return;
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02005926 }
Bram Moolenaar531b9a32018-07-03 16:54:23 +02005927 }
5928 if (res >= 0)
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01005929 qf_list_changed(qf_get_curlist(qi));
5930 save_qfid = qf_get_curlist(qi)->qf_id;
Bram Moolenaar1ed22762017-11-28 18:03:44 +01005931 if (au_name != NULL)
5932 apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name, NULL, FALSE, curbuf);
Bram Moolenaar0549a1e2018-02-11 15:02:48 +01005933
Bram Moolenaar531b9a32018-07-03 16:54:23 +02005934 // Jump to the first error for a new list and if autocmds didn't
5935 // free the list.
5936 if (res > 0 && (eap->cmdidx == CMD_cfile || eap->cmdidx == CMD_lfile)
5937 && qflist_valid(wp, save_qfid))
Bram Moolenaar8d8a65e2018-08-07 19:48:08 +02005938 // display the first error
5939 qf_jump_first(qi, save_qfid, eap->forceit);
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02005940
5941 decr_quickfix_busy();
Bram Moolenaare1bb8792018-04-06 22:58:23 +02005942}
5943
5944/*
Bram Moolenaar75b0a882018-03-24 14:01:56 +01005945 * Return the vimgrep autocmd name.
5946 */
5947 static char_u *
5948vgr_get_auname(cmdidx_T cmdidx)
5949{
5950 switch (cmdidx)
5951 {
5952 case CMD_vimgrep: return (char_u *)"vimgrep";
5953 case CMD_lvimgrep: return (char_u *)"lvimgrep";
5954 case CMD_vimgrepadd: return (char_u *)"vimgrepadd";
5955 case CMD_lvimgrepadd: return (char_u *)"lvimgrepadd";
5956 case CMD_grep: return (char_u *)"grep";
5957 case CMD_lgrep: return (char_u *)"lgrep";
5958 case CMD_grepadd: return (char_u *)"grepadd";
5959 case CMD_lgrepadd: return (char_u *)"lgrepadd";
5960 default: return NULL;
5961 }
5962}
5963
5964/*
5965 * Initialize the regmatch used by vimgrep for pattern "s".
5966 */
5967 static void
5968vgr_init_regmatch(regmmatch_T *regmatch, char_u *s)
5969{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005970 // Get the search pattern: either white-separated or enclosed in //
Bram Moolenaar75b0a882018-03-24 14:01:56 +01005971 regmatch->regprog = NULL;
5972
5973 if (s == NULL || *s == NUL)
5974 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02005975 // Pattern is empty, use last search pattern.
Bram Moolenaar75b0a882018-03-24 14:01:56 +01005976 if (last_search_pat() == NULL)
5977 {
Bram Moolenaare29a27f2021-07-20 21:07:36 +02005978 emsg(_(e_no_previous_regular_expression));
Bram Moolenaar75b0a882018-03-24 14:01:56 +01005979 return;
5980 }
5981 regmatch->regprog = vim_regcomp(last_search_pat(), RE_MAGIC);
5982 }
5983 else
5984 regmatch->regprog = vim_regcomp(s, RE_MAGIC);
5985
5986 regmatch->rmm_ic = p_ic;
5987 regmatch->rmm_maxcol = 0;
5988}
5989
5990/*
5991 * Display a file name when vimgrep is running.
5992 */
5993 static void
5994vgr_display_fname(char_u *fname)
5995{
5996 char_u *p;
5997
5998 msg_start();
5999 p = msg_strtrunc(fname, TRUE);
6000 if (p == NULL)
6001 msg_outtrans(fname);
6002 else
6003 {
6004 msg_outtrans(p);
6005 vim_free(p);
6006 }
6007 msg_clr_eos();
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006008 msg_didout = FALSE; // overwrite this message
6009 msg_nowait = TRUE; // don't wait for this message
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006010 msg_col = 0;
6011 out_flush();
6012}
6013
6014/*
6015 * Load a dummy buffer to search for a pattern using vimgrep.
6016 */
6017 static buf_T *
6018vgr_load_dummy_buf(
6019 char_u *fname,
6020 char_u *dirname_start,
6021 char_u *dirname_now)
6022{
6023 int save_mls;
6024#if defined(FEAT_SYN_HL)
6025 char_u *save_ei = NULL;
6026#endif
6027 buf_T *buf;
6028
6029#if defined(FEAT_SYN_HL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006030 // Don't do Filetype autocommands to avoid loading syntax and
6031 // indent scripts, a great speed improvement.
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006032 save_ei = au_event_disable(",Filetype");
6033#endif
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006034 // Don't use modelines here, it's useless.
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006035 save_mls = p_mls;
6036 p_mls = 0;
6037
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006038 // Load file into a buffer, so that 'fileencoding' is detected,
6039 // autocommands applied, etc.
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006040 buf = load_dummy_buffer(fname, dirname_start, dirname_now);
6041
6042 p_mls = save_mls;
6043#if defined(FEAT_SYN_HL)
6044 au_event_restore(save_ei);
6045#endif
6046
6047 return buf;
6048}
6049
6050/*
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01006051 * Check whether a quickfix/location list is valid. Autocmds may remove or
6052 * change a quickfix list when vimgrep is running. If the list is not found,
6053 * create a new list.
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006054 */
6055 static int
6056vgr_qflist_valid(
Bram Moolenaare1bb8792018-04-06 22:58:23 +02006057 win_T *wp,
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006058 qf_info_T *qi,
Bram Moolenaare1bb8792018-04-06 22:58:23 +02006059 int_u qfid,
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006060 char_u *title)
6061{
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006062 // Verify that the quickfix/location list was not freed by an autocmd
Bram Moolenaare1bb8792018-04-06 22:58:23 +02006063 if (!qflist_valid(wp, qfid))
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006064 {
Bram Moolenaare1bb8792018-04-06 22:58:23 +02006065 if (wp != NULL)
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006066 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006067 // An autocmd has freed the location list.
Bram Moolenaar4d170af2020-09-13 22:21:22 +02006068 emsg(_(e_current_location_list_was_changed));
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006069 return FALSE;
6070 }
Bram Moolenaare1bb8792018-04-06 22:58:23 +02006071 else
6072 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006073 // Quickfix list is not found, create a new one.
Bram Moolenaare1bb8792018-04-06 22:58:23 +02006074 qf_new_list(qi, title);
6075 return TRUE;
6076 }
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006077 }
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006078
Bram Moolenaar90f1e2b2018-08-11 13:36:56 +02006079 if (qf_restore_list(qi, qfid) == FAIL)
6080 return FALSE;
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006081
6082 return TRUE;
6083}
6084
6085/*
6086 * Search for a pattern in all the lines in a buffer and add the matching lines
6087 * to a quickfix list.
6088 */
6089 static int
6090vgr_match_buflines(
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01006091 qf_list_T *qfl,
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006092 char_u *fname,
6093 buf_T *buf,
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006094 char_u *spat,
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006095 regmmatch_T *regmatch,
Bram Moolenaar1c299432018-10-28 14:36:09 +01006096 long *tomatch,
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006097 int duplicate_name,
6098 int flags)
6099{
6100 int found_match = FALSE;
6101 long lnum;
6102 colnr_T col;
Bram Moolenaar551c1ae2021-05-03 18:57:05 +02006103 int pat_len = (int)STRLEN(spat);
Bram Moolenaarcaf642c2023-04-29 21:38:04 +01006104 if (pat_len > MAX_FUZZY_MATCHES)
6105 pat_len = MAX_FUZZY_MATCHES;
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006106
Bram Moolenaar1c299432018-10-28 14:36:09 +01006107 for (lnum = 1; lnum <= buf->b_ml.ml_line_count && *tomatch > 0; ++lnum)
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006108 {
6109 col = 0;
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006110 if (!(flags & VGR_FUZZY))
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006111 {
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006112 // Regular expression match
6113 while (vim_regexec_multi(regmatch, curwin, buf, lnum,
Bram Moolenaarcaf642c2023-04-29 21:38:04 +01006114 col, NULL) > 0)
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006115 {
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006116 // Pass the buffer number so that it gets used even for a
6117 // dummy buffer, unless duplicate_name is set, then the
6118 // buffer will be wiped out below.
6119 if (qf_add_entry(qfl,
6120 NULL, // dir
6121 fname,
6122 NULL,
6123 duplicate_name ? 0 : buf->b_fnum,
6124 ml_get_buf(buf,
6125 regmatch->startpos[0].lnum + lnum, FALSE),
6126 regmatch->startpos[0].lnum + lnum,
thinca6864efa2021-06-19 20:45:20 +02006127 regmatch->endpos[0].lnum + lnum,
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006128 regmatch->startpos[0].col + 1,
thinca6864efa2021-06-19 20:45:20 +02006129 regmatch->endpos[0].col + 1,
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006130 FALSE, // vis_col
6131 NULL, // search pattern
6132 0, // nr
6133 0, // type
Tom Praschanca6ac992023-08-11 23:26:12 +02006134 NULL, // user_data
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006135 TRUE // valid
6136 ) == QF_FAIL)
6137 {
6138 got_int = TRUE;
6139 break;
6140 }
6141 found_match = TRUE;
6142 if (--*tomatch == 0)
6143 break;
6144 if ((flags & VGR_GLOBAL) == 0
6145 || regmatch->endpos[0].lnum > 0)
6146 break;
6147 col = regmatch->endpos[0].col
6148 + (col == regmatch->endpos[0].col);
6149 if (col > (colnr_T)STRLEN(ml_get_buf(buf, lnum, FALSE)))
6150 break;
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006151 }
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006152 }
6153 else
6154 {
6155 char_u *str = ml_get_buf(buf, lnum, FALSE);
6156 int score;
6157 int_u matches[MAX_FUZZY_MATCHES];
K.Takataeeec2542021-06-02 13:28:16 +02006158 int_u sz = ARRAY_LENGTH(matches);
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006159
6160 // Fuzzy string match
Bram Moolenaarcaf642c2023-04-29 21:38:04 +01006161 CLEAR_FIELD(matches);
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006162 while (fuzzy_match(str + col, spat, FALSE, &score, matches, sz) > 0)
6163 {
6164 // Pass the buffer number so that it gets used even for a
6165 // dummy buffer, unless duplicate_name is set, then the
6166 // buffer will be wiped out below.
6167 if (qf_add_entry(qfl,
6168 NULL, // dir
6169 fname,
6170 NULL,
6171 duplicate_name ? 0 : buf->b_fnum,
6172 str,
6173 lnum,
thinca6864efa2021-06-19 20:45:20 +02006174 0,
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006175 matches[0] + col + 1,
thinca6864efa2021-06-19 20:45:20 +02006176 0,
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006177 FALSE, // vis_col
6178 NULL, // search pattern
6179 0, // nr
6180 0, // type
Tom Praschanca6ac992023-08-11 23:26:12 +02006181 NULL, // user_data
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006182 TRUE // valid
6183 ) == QF_FAIL)
6184 {
6185 got_int = TRUE;
6186 break;
6187 }
6188 found_match = TRUE;
6189 if (--*tomatch == 0)
6190 break;
6191 if ((flags & VGR_GLOBAL) == 0)
6192 break;
6193 col = matches[pat_len - 1] + col + 1;
6194 if (col > (colnr_T)STRLEN(str))
6195 break;
6196 }
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006197 }
6198 line_breakcheck();
6199 if (got_int)
6200 break;
6201 }
6202
6203 return found_match;
6204}
6205
6206/*
6207 * Jump to the first match and update the directory.
6208 */
6209 static void
6210vgr_jump_to_match(
6211 qf_info_T *qi,
6212 int forceit,
6213 int *redraw_for_dummy,
6214 buf_T *first_match_buf,
6215 char_u *target_dir)
6216{
6217 buf_T *buf;
6218
6219 buf = curbuf;
6220 qf_jump(qi, 0, 0, forceit);
6221 if (buf != curbuf)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006222 // If we jumped to another buffer redrawing will already be
6223 // taken care of.
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006224 *redraw_for_dummy = FALSE;
6225
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006226 // Jump to the directory used after loading the buffer.
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006227 if (curbuf == first_match_buf && target_dir != NULL)
6228 {
6229 exarg_T ea;
6230
Bram Moolenaara80faa82020-04-12 19:37:17 +02006231 CLEAR_FIELD(ea);
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006232 ea.arg = target_dir;
6233 ea.cmdidx = CMD_lcd;
6234 ex_cd(&ea);
6235 }
6236}
6237
6238/*
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006239 * :vimgrep command arguments
Bram Moolenaar86b68352004-12-27 21:59:20 +00006240 */
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006241typedef struct
Bram Moolenaar86b68352004-12-27 21:59:20 +00006242{
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006243 long tomatch; // maximum number of matches to find
6244 char_u *spat; // search pattern
6245 int flags; // search modifier
6246 char_u **fnames; // list of files to search
6247 int fcount; // number of files
6248 regmmatch_T regmatch; // compiled search pattern
6249 char_u *qf_title; // quickfix list title
6250} vgr_args_T;
6251
6252/*
6253 * Process :vimgrep command arguments. The command syntax is:
6254 *
6255 * :{count}vimgrep /{pattern}/[g][j] {file} ...
6256 */
6257 static int
6258vgr_process_args(
6259 exarg_T *eap,
6260 vgr_args_T *args)
6261{
Bram Moolenaar748bf032005-02-02 23:04:36 +00006262 char_u *p;
Bram Moolenaar7c626922005-02-07 22:01:03 +00006263
Yegappan Lakshmanan960dcbd2023-03-07 17:45:11 +00006264 CLEAR_POINTER(args);
Bram Moolenaar86b68352004-12-27 21:59:20 +00006265
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006266 args->regmatch.regprog = NULL;
6267 args->qf_title = vim_strsave(qf_cmdtitle(*eap->cmdlinep));
Bram Moolenaara6557602006-02-04 22:43:20 +00006268
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00006269 if (eap->addr_count > 0)
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006270 args->tomatch = eap->line2;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00006271 else
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006272 args->tomatch = MAXLNUM;
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00006273
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006274 // Get the search pattern: either white-separated or enclosed in //
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006275 p = skip_vimgrep_pat(eap->arg, &args->spat, &args->flags);
Bram Moolenaar748bf032005-02-02 23:04:36 +00006276 if (p == NULL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00006277 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00006278 emsg(_(e_invalid_search_pattern_or_delimiter));
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006279 return FAIL;
Bram Moolenaar81695252004-12-29 20:58:21 +00006280 }
Bram Moolenaar60abe752013-03-07 16:32:54 +01006281
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006282 vgr_init_regmatch(&args->regmatch, args->spat);
6283 if (args->regmatch.regprog == NULL)
6284 return FAIL;
Bram Moolenaar86b68352004-12-27 21:59:20 +00006285
6286 p = skipwhite(p);
6287 if (*p == NUL)
6288 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00006289 emsg(_(e_file_name_missing_or_invalid_pattern));
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006290 return FAIL;
Bram Moolenaar86b68352004-12-27 21:59:20 +00006291 }
6292
Bram Moolenaarf8c6a172021-01-30 18:09:06 +01006293 // Parse the list of arguments, wildcards have already been expanded.
Christian Brabandt0b226f62021-12-01 10:54:24 +00006294 if ((get_arglist_exp(p, &args->fcount, &args->fnames, TRUE) == FAIL) ||
6295 args->fcount == 0)
Bram Moolenaar86b68352004-12-27 21:59:20 +00006296 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006297 emsg(_(e_no_match));
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006298 return FAIL;
Bram Moolenaar86b68352004-12-27 21:59:20 +00006299 }
6300
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006301 return OK;
6302}
6303
6304/*
Bram Moolenaar8ce4b7e2020-08-07 18:12:18 +02006305 * Return TRUE if "buf" had an existing swap file, the current swap file does
6306 * not end in ".swp".
6307 */
6308 static int
6309existing_swapfile(buf_T *buf)
6310{
Bram Moolenaar997cd1a2020-08-31 22:16:08 +02006311 if (buf->b_ml.ml_mfp != NULL && buf->b_ml.ml_mfp->mf_fname != NULL)
Bram Moolenaar8ce4b7e2020-08-07 18:12:18 +02006312 {
6313 char_u *fname = buf->b_ml.ml_mfp->mf_fname;
6314 size_t len = STRLEN(fname);
6315
6316 return fname[len - 1] != 'p' || fname[len - 2] != 'w';
6317 }
6318 return FALSE;
6319}
6320
6321/*
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006322 * Search for a pattern in a list of files and populate the quickfix list with
6323 * the matches.
6324 */
6325 static int
6326vgr_process_files(
6327 win_T *wp,
6328 qf_info_T *qi,
6329 vgr_args_T *cmd_args,
6330 int *redraw_for_dummy,
6331 buf_T **first_match_buf,
6332 char_u **target_dir)
6333{
6334 int status = FAIL;
6335 int_u save_qfid = qf_get_curlist(qi)->qf_id;
6336 time_t seconds = 0;
6337 char_u *fname;
6338 int fi;
6339 buf_T *buf;
6340 int duplicate_name = FALSE;
6341 int using_dummy;
6342 char_u *dirname_start = NULL;
6343 char_u *dirname_now = NULL;
6344 int found_match;
6345 aco_save_T aco;
6346
Bram Moolenaarb86a3432016-01-10 16:00:53 +01006347 dirname_start = alloc_id(MAXPATHL, aid_qf_dirname_start);
6348 dirname_now = alloc_id(MAXPATHL, aid_qf_dirname_now);
Bram Moolenaard9462e32011-04-11 21:35:11 +02006349 if (dirname_start == NULL || dirname_now == NULL)
6350 goto theend;
6351
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006352 // Remember the current directory, because a BufRead autocommand that does
6353 // ":lcd %:p:h" changes the meaning of short path names.
Bram Moolenaard089d9b2007-09-30 12:02:55 +00006354 mch_dirname(dirname_start, MAXPATHL);
6355
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006356 seconds = (time_t)0;
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006357 for (fi = 0; fi < cmd_args->fcount && !got_int && cmd_args->tomatch > 0;
6358 ++fi)
Bram Moolenaar86b68352004-12-27 21:59:20 +00006359 {
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006360 fname = shorten_fname1(cmd_args->fnames[fi]);
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006361 if (time(NULL) > seconds)
6362 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006363 // Display the file name every second or so, show the user we are
6364 // working on it.
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006365 seconds = time(NULL);
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006366 vgr_display_fname(fname);
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006367 }
6368
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006369 buf = buflist_findname_exp(cmd_args->fnames[fi]);
Bram Moolenaar81695252004-12-29 20:58:21 +00006370 if (buf == NULL || buf->b_ml.ml_mfp == NULL)
6371 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006372 // Remember that a buffer with this name already exists.
Bram Moolenaar81695252004-12-29 20:58:21 +00006373 duplicate_name = (buf != NULL);
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006374 using_dummy = TRUE;
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006375 *redraw_for_dummy = TRUE;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006376
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006377 buf = vgr_load_dummy_buf(fname, dirname_start, dirname_now);
Bram Moolenaar81695252004-12-29 20:58:21 +00006378 }
6379 else
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006380 // Use existing, loaded buffer.
Bram Moolenaar81695252004-12-29 20:58:21 +00006381 using_dummy = FALSE;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006382
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006383 // Check whether the quickfix list is still valid. When loading a
6384 // buffer above, autocommands might have changed the quickfix list.
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006385 if (!vgr_qflist_valid(wp, qi, save_qfid, cmd_args->qf_title))
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006386 goto theend;
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006387
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01006388 save_qfid = qf_get_curlist(qi)->qf_id;
Bram Moolenaar321a9ec2012-12-12 15:55:20 +01006389
Bram Moolenaar81695252004-12-29 20:58:21 +00006390 if (buf == NULL)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006391 {
6392 if (!got_int)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01006393 smsg(_("Cannot open file \"%s\""), fname);
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006394 }
Bram Moolenaar86b68352004-12-27 21:59:20 +00006395 else
6396 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006397 // Try for a match in all lines of the buffer.
6398 // For ":1vimgrep" look for first match only.
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01006399 found_match = vgr_match_buflines(qf_get_curlist(qi),
Yegappan Lakshmananbb01a1e2021-04-26 21:17:52 +02006400 fname, buf, cmd_args->spat, &cmd_args->regmatch,
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006401 &cmd_args->tomatch, duplicate_name, cmd_args->flags);
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006402
Bram Moolenaar81695252004-12-29 20:58:21 +00006403 if (using_dummy)
6404 {
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006405 if (found_match && *first_match_buf == NULL)
6406 *first_match_buf = buf;
Bram Moolenaar81695252004-12-29 20:58:21 +00006407 if (duplicate_name)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006408 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006409 // Never keep a dummy buffer if there is another buffer
6410 // with the same name.
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006411 wipe_dummy_buffer(buf, dirname_start);
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006412 buf = NULL;
6413 }
Bram Moolenaare1004402020-10-24 20:49:43 +02006414 else if ((cmdmod.cmod_flags & CMOD_HIDE) == 0
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006415 || buf->b_p_bh[0] == 'u' // "unload"
6416 || buf->b_p_bh[0] == 'w' // "wipe"
6417 || buf->b_p_bh[0] == 'd') // "delete"
Bram Moolenaar81695252004-12-29 20:58:21 +00006418 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006419 // When no match was found we don't need to remember the
6420 // buffer, wipe it out. If there was a match and it
6421 // wasn't the first one or we won't jump there: only
6422 // unload the buffer.
6423 // Ignore 'hidden' here, because it may lead to having too
6424 // many swap files.
Bram Moolenaar81695252004-12-29 20:58:21 +00006425 if (!found_match)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006426 {
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006427 wipe_dummy_buffer(buf, dirname_start);
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006428 buf = NULL;
6429 }
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006430 else if (buf != *first_match_buf
Bram Moolenaar8ce4b7e2020-08-07 18:12:18 +02006431 || (cmd_args->flags & VGR_NOJUMP)
6432 || existing_swapfile(buf))
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006433 {
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006434 unload_dummy_buffer(buf, dirname_start);
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006435 // Keeping the buffer, remove the dummy flag.
Bram Moolenaar015102e2016-07-16 18:24:56 +02006436 buf->b_flags &= ~BF_DUMMY;
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006437 buf = NULL;
6438 }
Bram Moolenaar81695252004-12-29 20:58:21 +00006439 }
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006440
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006441 if (buf != NULL)
6442 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006443 // Keeping the buffer, remove the dummy flag.
Bram Moolenaar015102e2016-07-16 18:24:56 +02006444 buf->b_flags &= ~BF_DUMMY;
6445
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006446 // If the buffer is still loaded we need to use the
6447 // directory we jumped to below.
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006448 if (buf == *first_match_buf
6449 && *target_dir == NULL
Bram Moolenaard089d9b2007-09-30 12:02:55 +00006450 && STRCMP(dirname_start, dirname_now) != 0)
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006451 *target_dir = vim_strsave(dirname_now);
Bram Moolenaard089d9b2007-09-30 12:02:55 +00006452
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006453 // The buffer is still loaded, the Filetype autocommands
6454 // need to be done now, in that buffer. And the modelines
6455 // need to be done (again). But not the window-local
6456 // options!
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006457 aucmd_prepbuf(&aco, buf);
Bram Moolenaare76062c2022-11-28 18:51:43 +00006458 if (curbuf == buf)
6459 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01006460#if defined(FEAT_SYN_HL)
Bram Moolenaare76062c2022-11-28 18:51:43 +00006461 apply_autocmds(EVENT_FILETYPE, buf->b_p_ft,
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006462 buf->b_fname, TRUE, buf);
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00006463#endif
Bram Moolenaare76062c2022-11-28 18:51:43 +00006464 do_modelines(OPT_NOWIN);
6465 aucmd_restbuf(&aco);
6466 }
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006467 }
Bram Moolenaar81695252004-12-29 20:58:21 +00006468 }
Bram Moolenaar86b68352004-12-27 21:59:20 +00006469 }
6470 }
6471
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006472 status = OK;
6473
6474theend:
6475 vim_free(dirname_now);
6476 vim_free(dirname_start);
6477 return status;
6478}
6479
6480/*
6481 * ":vimgrep {pattern} file(s)"
6482 * ":vimgrepadd {pattern} file(s)"
6483 * ":lvimgrep {pattern} file(s)"
6484 * ":lvimgrepadd {pattern} file(s)"
6485 */
6486 void
6487ex_vimgrep(exarg_T *eap)
6488{
6489 vgr_args_T args;
6490 qf_info_T *qi;
6491 qf_list_T *qfl;
6492 int_u save_qfid;
6493 win_T *wp = NULL;
6494 int redraw_for_dummy = FALSE;
6495 buf_T *first_match_buf = NULL;
6496 char_u *target_dir = NULL;
6497 char_u *au_name = NULL;
6498 int status;
6499
6500 au_name = vgr_get_auname(eap->cmdidx);
6501 if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
6502 curbuf->b_fname, TRUE, curbuf))
6503 {
6504#ifdef FEAT_EVAL
6505 if (aborting())
6506 return;
6507#endif
6508 }
6509
6510 qi = qf_cmd_get_or_alloc_stack(eap, &wp);
6511 if (qi == NULL)
6512 return;
6513
6514 if (vgr_process_args(eap, &args) == FAIL)
6515 goto theend;
6516
6517 if ((eap->cmdidx != CMD_grepadd && eap->cmdidx != CMD_lgrepadd
6518 && eap->cmdidx != CMD_vimgrepadd
6519 && eap->cmdidx != CMD_lvimgrepadd)
6520 || qf_stack_empty(qi))
6521 // make place for a new list
6522 qf_new_list(qi, args.qf_title);
6523
6524 incr_quickfix_busy();
6525
6526 status = vgr_process_files(wp, qi, &args, &redraw_for_dummy,
6527 &first_match_buf, &target_dir);
6528 if (status != OK)
6529 {
6530 FreeWild(args.fcount, args.fnames);
6531 decr_quickfix_busy();
6532 goto theend;
6533 }
6534
6535 FreeWild(args.fcount, args.fnames);
Bram Moolenaar86b68352004-12-27 21:59:20 +00006536
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01006537 qfl = qf_get_curlist(qi);
Bram Moolenaar108e7b42018-10-11 17:39:12 +02006538 qfl->qf_nonevalid = FALSE;
6539 qfl->qf_ptr = qfl->qf_start;
6540 qfl->qf_index = 1;
6541 qf_list_changed(qfl);
Bram Moolenaar86b68352004-12-27 21:59:20 +00006542
Bram Moolenaar864293a2016-06-02 13:40:04 +02006543 qf_update_buffer(qi, NULL);
Bram Moolenaar86b68352004-12-27 21:59:20 +00006544
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006545 // Remember the current quickfix list identifier, so that we can check for
6546 // autocommands changing the current quickfix list.
6547 save_qfid = qf_get_curlist(qi)->qf_id;
6548
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00006549 if (au_name != NULL)
6550 apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
6551 curbuf->b_fname, TRUE, curbuf);
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006552 // The QuickFixCmdPost autocmd may free the quickfix list. Check the list
6553 // is still valid.
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02006554 if (!qflist_valid(wp, save_qfid)
6555 || qf_restore_list(qi, save_qfid) == FAIL)
6556 {
6557 decr_quickfix_busy();
Bram Moolenaar3c097222017-12-21 20:54:49 +01006558 goto theend;
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02006559 }
Bram Moolenaar531b9a32018-07-03 16:54:23 +02006560
Bram Moolenaarc631f2d2018-08-21 21:58:13 +02006561 // Jump to first match.
Bram Moolenaar0398e002019-03-21 21:12:49 +01006562 if (!qf_list_empty(qf_get_curlist(qi)))
Bram Moolenaar05159a02005-02-26 23:04:13 +00006563 {
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006564 if ((args.flags & VGR_NOJUMP) == 0)
Bram Moolenaar75b0a882018-03-24 14:01:56 +01006565 vgr_jump_to_match(qi, eap->forceit, &redraw_for_dummy,
6566 first_match_buf, target_dir);
Bram Moolenaar05159a02005-02-26 23:04:13 +00006567 }
Bram Moolenaar81695252004-12-29 20:58:21 +00006568 else
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00006569 semsg(_(e_no_match_str_2), args.spat);
Bram Moolenaar86b68352004-12-27 21:59:20 +00006570
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02006571 decr_quickfix_busy();
6572
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006573 // If we loaded a dummy buffer into the current window, the autocommands
6574 // may have messed up things, need to redraw and recompute folds.
Bram Moolenaar1042fa32007-09-16 11:27:42 +00006575 if (redraw_for_dummy)
6576 {
6577#ifdef FEAT_FOLDING
6578 foldUpdateAll(curwin);
6579#else
Bram Moolenaara4d158b2022-08-14 14:17:45 +01006580 redraw_later(UPD_NOT_VALID);
Bram Moolenaar1042fa32007-09-16 11:27:42 +00006581#endif
6582 }
6583
Bram Moolenaar86b68352004-12-27 21:59:20 +00006584theend:
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006585 vim_free(args.qf_title);
Bram Moolenaard089d9b2007-09-30 12:02:55 +00006586 vim_free(target_dir);
Bram Moolenaard6a98a32019-11-12 22:59:51 +01006587 vim_regfree(args.regmatch.regprog);
Bram Moolenaar86b68352004-12-27 21:59:20 +00006588}
6589
6590/*
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006591 * Restore current working directory to "dirname_start" if they differ, taking
6592 * into account whether it is set locally or globally.
6593 */
6594 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01006595restore_start_dir(char_u *dirname_start)
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006596{
6597 char_u *dirname_now = alloc(MAXPATHL);
6598
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00006599 if (dirname_now == NULL)
6600 return;
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006601
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00006602 mch_dirname(dirname_now, MAXPATHL);
6603 if (STRCMP(dirname_start, dirname_now) != 0)
6604 {
6605 // If the directory has changed, change it back by building up an
6606 // appropriate ex command and executing it.
6607 exarg_T ea;
6608
6609 CLEAR_FIELD(ea);
6610 ea.arg = dirname_start;
6611 ea.cmdidx = (curwin->w_localdir == NULL) ? CMD_cd : CMD_lcd;
6612 ex_cd(&ea);
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006613 }
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00006614 vim_free(dirname_now);
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006615}
6616
6617/*
6618 * Load file "fname" into a dummy buffer and return the buffer pointer,
6619 * placing the directory resulting from the buffer load into the
6620 * "resulting_dir" pointer. "resulting_dir" must be allocated by the caller
6621 * prior to calling this function. Restores directory to "dirname_start" prior
6622 * to returning, if autocmds or the 'autochdir' option have changed it.
6623 *
6624 * If creating the dummy buffer does not fail, must call unload_dummy_buffer()
6625 * or wipe_dummy_buffer() later!
6626 *
Bram Moolenaar81695252004-12-29 20:58:21 +00006627 * Returns NULL if it fails.
Bram Moolenaar81695252004-12-29 20:58:21 +00006628 */
6629 static buf_T *
Bram Moolenaar05540972016-01-30 20:31:25 +01006630load_dummy_buffer(
6631 char_u *fname,
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006632 char_u *dirname_start, // in: old directory
6633 char_u *resulting_dir) // out: new directory
Bram Moolenaar81695252004-12-29 20:58:21 +00006634{
6635 buf_T *newbuf;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02006636 bufref_T newbufref;
6637 bufref_T newbuf_to_wipe;
Bram Moolenaar81695252004-12-29 20:58:21 +00006638 int failed = TRUE;
Bram Moolenaar81695252004-12-29 20:58:21 +00006639 aco_save_T aco;
Bram Moolenaar4fb921e2017-12-18 15:33:00 +01006640 int readfile_result;
Bram Moolenaar81695252004-12-29 20:58:21 +00006641
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006642 // Allocate a buffer without putting it in the buffer list.
Bram Moolenaar81695252004-12-29 20:58:21 +00006643 newbuf = buflist_new(NULL, NULL, (linenr_T)1, BLN_DUMMY);
6644 if (newbuf == NULL)
6645 return NULL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02006646 set_bufref(&newbufref, newbuf);
Bram Moolenaar81695252004-12-29 20:58:21 +00006647
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006648 // Init the options.
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00006649 buf_copy_options(newbuf, BCO_ENTER | BCO_NOHELP);
6650
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006651 // need to open the memfile before putting the buffer in a window
Bram Moolenaarf061e0b2009-06-24 15:32:01 +00006652 if (ml_open(newbuf) == OK)
Bram Moolenaar81695252004-12-29 20:58:21 +00006653 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006654 // Make sure this buffer isn't wiped out by autocommands.
Bram Moolenaar4fb921e2017-12-18 15:33:00 +01006655 ++newbuf->b_locked;
6656
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006657 // set curwin/curbuf to buf and save a few things
Bram Moolenaarf061e0b2009-06-24 15:32:01 +00006658 aucmd_prepbuf(&aco, newbuf);
Bram Moolenaare76062c2022-11-28 18:51:43 +00006659 if (curbuf == newbuf)
Bram Moolenaar81695252004-12-29 20:58:21 +00006660 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00006661 // Need to set the filename for autocommands.
6662 (void)setfname(curbuf, fname, NULL, FALSE);
6663
6664 // Create swap file now to avoid the ATTENTION message.
6665 check_need_swap(TRUE);
6666
6667 // Remove the "dummy" flag, otherwise autocommands may not
6668 // work.
6669 curbuf->b_flags &= ~BF_DUMMY;
6670
6671 newbuf_to_wipe.br_buf = NULL;
6672 readfile_result = readfile(fname, NULL,
6673 (linenr_T)0, (linenr_T)0, (linenr_T)MAXLNUM,
6674 NULL, READ_NEW | READ_DUMMY);
6675 --newbuf->b_locked;
6676 if (readfile_result == OK
6677 && !got_int
6678 && !(curbuf->b_flags & BF_NEW))
Bram Moolenaar81695252004-12-29 20:58:21 +00006679 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00006680 failed = FALSE;
6681 if (curbuf != newbuf)
6682 {
6683 // Bloody autocommands changed the buffer! Can happen when
6684 // using netrw and editing a remote file. Use the current
6685 // buffer instead, delete the dummy one after restoring the
6686 // window stuff.
6687 set_bufref(&newbuf_to_wipe, newbuf);
6688 newbuf = curbuf;
6689 }
Bram Moolenaar81695252004-12-29 20:58:21 +00006690 }
Bram Moolenaare76062c2022-11-28 18:51:43 +00006691
6692 // restore curwin/curbuf and a few other things
6693 aucmd_restbuf(&aco);
Bram Moolenaar81695252004-12-29 20:58:21 +00006694
Bram Moolenaar84497cd2022-11-28 20:34:52 +00006695 if (newbuf_to_wipe.br_buf != NULL && bufref_valid(&newbuf_to_wipe))
6696 wipe_buffer(newbuf_to_wipe.br_buf, FALSE);
6697 }
Bram Moolenaarea3f2e72016-07-10 20:27:32 +02006698
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006699 // Add back the "dummy" flag, otherwise buflist_findname_stat() won't
6700 // skip it.
Bram Moolenaarea3f2e72016-07-10 20:27:32 +02006701 newbuf->b_flags |= BF_DUMMY;
Bram Moolenaarf061e0b2009-06-24 15:32:01 +00006702 }
Bram Moolenaar81695252004-12-29 20:58:21 +00006703
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006704 // When autocommands/'autochdir' option changed directory: go back.
6705 // Let the caller know what the resulting dir was first, in case it is
6706 // important.
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006707 mch_dirname(resulting_dir, MAXPATHL);
6708 restore_start_dir(dirname_start);
6709
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02006710 if (!bufref_valid(&newbufref))
Bram Moolenaar81695252004-12-29 20:58:21 +00006711 return NULL;
6712 if (failed)
6713 {
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006714 wipe_dummy_buffer(newbuf, dirname_start);
Bram Moolenaar81695252004-12-29 20:58:21 +00006715 return NULL;
6716 }
6717 return newbuf;
6718}
6719
6720/*
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006721 * Wipe out the dummy buffer that load_dummy_buffer() created. Restores
6722 * directory to "dirname_start" prior to returning, if autocmds or the
6723 * 'autochdir' option have changed it.
Bram Moolenaar81695252004-12-29 20:58:21 +00006724 */
6725 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01006726wipe_dummy_buffer(buf_T *buf, char_u *dirname_start)
Bram Moolenaar81695252004-12-29 20:58:21 +00006727{
Bram Moolenaar2573af32020-03-14 17:21:34 +01006728 // If any autocommand opened a window on the dummy buffer, close that
6729 // window. If we can't close them all then give up.
6730 while (buf->b_nwindows > 0)
6731 {
6732 int did_one = FALSE;
6733 win_T *wp;
6734
6735 if (firstwin->w_next != NULL)
Bram Moolenaar00d253e2020-04-06 22:13:01 +02006736 FOR_ALL_WINDOWS(wp)
Bram Moolenaar2573af32020-03-14 17:21:34 +01006737 if (wp->w_buffer == buf)
6738 {
6739 if (win_close(wp, FALSE) == OK)
6740 did_one = TRUE;
6741 break;
6742 }
6743 if (!did_one)
6744 return;
6745 }
6746
6747 if (curbuf != buf && buf->b_nwindows == 0) // safety check
Bram Moolenaard68071d2006-05-02 22:08:30 +00006748 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01006749#if defined(FEAT_EVAL)
Bram Moolenaard68071d2006-05-02 22:08:30 +00006750 cleanup_T cs;
6751
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006752 // Reset the error/interrupt/exception state here so that aborting()
6753 // returns FALSE when wiping out the buffer. Otherwise it doesn't
6754 // work when got_int is set.
Bram Moolenaard68071d2006-05-02 22:08:30 +00006755 enter_cleanup(&cs);
6756#endif
6757
Bram Moolenaar1cfb9bb2020-12-22 11:40:45 +01006758 wipe_buffer(buf, TRUE);
Bram Moolenaard68071d2006-05-02 22:08:30 +00006759
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01006760#if defined(FEAT_EVAL)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006761 // Restore the error/interrupt/exception state if not discarded by a
6762 // new aborting error, interrupt, or uncaught exception.
Bram Moolenaard68071d2006-05-02 22:08:30 +00006763 leave_cleanup(&cs);
6764#endif
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006765 // When autocommands/'autochdir' option changed directory: go back.
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006766 restore_start_dir(dirname_start);
Bram Moolenaard68071d2006-05-02 22:08:30 +00006767 }
Bram Moolenaar81695252004-12-29 20:58:21 +00006768}
6769
6770/*
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006771 * Unload the dummy buffer that load_dummy_buffer() created. Restores
6772 * directory to "dirname_start" prior to returning, if autocmds or the
6773 * 'autochdir' option have changed it.
Bram Moolenaar81695252004-12-29 20:58:21 +00006774 */
6775 static void
Bram Moolenaar05540972016-01-30 20:31:25 +01006776unload_dummy_buffer(buf_T *buf, char_u *dirname_start)
Bram Moolenaar81695252004-12-29 20:58:21 +00006777{
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00006778 if (curbuf == buf) // safety check
6779 return;
Bram Moolenaar7f51a822012-04-25 18:57:21 +02006780
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00006781 close_buffer(NULL, buf, DOBUF_UNLOAD, FALSE, TRUE);
6782
6783 // When autocommands/'autochdir' option changed directory: go back.
6784 restore_start_dir(dirname_start);
Bram Moolenaar81695252004-12-29 20:58:21 +00006785}
6786
Bram Moolenaar05159a02005-02-26 23:04:13 +00006787#if defined(FEAT_EVAL) || defined(PROTO)
6788/*
Bram Moolenaar4b96df52020-01-26 22:00:26 +01006789 * Copy the specified quickfix entry items into a new dict and append the dict
Bram Moolenaara16123a2019-03-28 20:31:07 +01006790 * to 'list'. Returns OK on success.
6791 */
6792 static int
6793get_qfline_items(qfline_T *qfp, list_T *list)
6794{
6795 int bufnum;
6796 dict_T *dict;
6797 char_u buf[2];
6798
6799 // Handle entries with a non-existing buffer number.
6800 bufnum = qfp->qf_fnum;
6801 if (bufnum != 0 && (buflist_findnr(bufnum) == NULL))
6802 bufnum = 0;
6803
6804 if ((dict = dict_alloc()) == NULL)
6805 return FAIL;
6806 if (list_append_dict(list, dict) == FAIL)
6807 return FAIL;
6808
6809 buf[0] = qfp->qf_type;
6810 buf[1] = NUL;
6811 if (dict_add_number(dict, "bufnr", (long)bufnum) == FAIL
thinca6864efa2021-06-19 20:45:20 +02006812 || dict_add_number(dict, "lnum", (long)qfp->qf_lnum) == FAIL
6813 || dict_add_number(dict, "end_lnum", (long)qfp->qf_end_lnum) == FAIL
6814 || dict_add_number(dict, "col", (long)qfp->qf_col) == FAIL
6815 || dict_add_number(dict, "end_col", (long)qfp->qf_end_col) == FAIL
6816 || dict_add_number(dict, "vcol", (long)qfp->qf_viscol) == FAIL
6817 || dict_add_number(dict, "nr", (long)qfp->qf_nr) == FAIL
Bram Moolenaara16123a2019-03-28 20:31:07 +01006818 || dict_add_string(dict, "module", qfp->qf_module) == FAIL
6819 || dict_add_string(dict, "pattern", qfp->qf_pattern) == FAIL
6820 || dict_add_string(dict, "text", qfp->qf_text) == FAIL
6821 || dict_add_string(dict, "type", buf) == FAIL
Tom Praschanca6ac992023-08-11 23:26:12 +02006822 || (qfp->qf_user_data.v_type != VAR_UNKNOWN
6823 && dict_add_tv(dict, "user_data", &qfp->qf_user_data) == FAIL )
Bram Moolenaara16123a2019-03-28 20:31:07 +01006824 || dict_add_number(dict, "valid", (long)qfp->qf_valid) == FAIL)
6825 return FAIL;
6826
6827 return OK;
6828}
6829
6830/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00006831 * Add each quickfix error to list "list" as a dictionary.
Bram Moolenaard823fa92016-08-12 16:29:27 +02006832 * If qf_idx is -1, use the current list. Otherwise, use the specified list.
Bram Moolenaar858ba062020-05-31 23:11:59 +02006833 * If eidx is not 0, then return only the specified entry. Otherwise return
6834 * all the entries.
Bram Moolenaar05159a02005-02-26 23:04:13 +00006835 */
Bram Moolenaare677df82019-09-02 22:31:11 +02006836 static int
Bram Moolenaar858ba062020-05-31 23:11:59 +02006837get_errorlist(
6838 qf_info_T *qi_arg,
6839 win_T *wp,
6840 int qf_idx,
6841 int eidx,
6842 list_T *list)
Bram Moolenaar05159a02005-02-26 23:04:13 +00006843{
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02006844 qf_info_T *qi = qi_arg;
Bram Moolenaar0398e002019-03-21 21:12:49 +01006845 qf_list_T *qfl;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006846 qfline_T *qfp;
6847 int i;
Bram Moolenaar05159a02005-02-26 23:04:13 +00006848
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02006849 if (qi == NULL)
Bram Moolenaar17c7c012006-01-26 22:25:15 +00006850 {
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02006851 qi = &ql_info;
6852 if (wp != NULL)
6853 {
6854 qi = GET_LOC_LIST(wp);
6855 if (qi == NULL)
6856 return FAIL;
6857 }
Bram Moolenaar17c7c012006-01-26 22:25:15 +00006858 }
6859
Bram Moolenaar858ba062020-05-31 23:11:59 +02006860 if (eidx < 0)
6861 return OK;
6862
Bram Moolenaar29ce4092018-04-28 21:56:44 +02006863 if (qf_idx == INVALID_QFIDX)
Bram Moolenaard823fa92016-08-12 16:29:27 +02006864 qf_idx = qi->qf_curlist;
6865
Bram Moolenaar0398e002019-03-21 21:12:49 +01006866 if (qf_idx >= qi->qf_listcount)
Bram Moolenaar05159a02005-02-26 23:04:13 +00006867 return FAIL;
Bram Moolenaar05159a02005-02-26 23:04:13 +00006868
Bram Moolenaar0398e002019-03-21 21:12:49 +01006869 qfl = qf_get_list(qi, qf_idx);
6870 if (qf_list_empty(qfl))
6871 return FAIL;
6872
Bram Moolenaara16123a2019-03-28 20:31:07 +01006873 FOR_ALL_QFL_ITEMS(qfl, qfp, i)
Bram Moolenaar05159a02005-02-26 23:04:13 +00006874 {
Bram Moolenaar858ba062020-05-31 23:11:59 +02006875 if (eidx > 0)
6876 {
6877 if (eidx == i)
6878 return get_qfline_items(qfp, list);
6879 }
6880 else if (get_qfline_items(qfp, list) == FAIL)
Bram Moolenaar05159a02005-02-26 23:04:13 +00006881 return FAIL;
Bram Moolenaar05159a02005-02-26 23:04:13 +00006882 }
Bram Moolenaara16123a2019-03-28 20:31:07 +01006883
Bram Moolenaar05159a02005-02-26 23:04:13 +00006884 return OK;
6885}
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006886
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006887// Flags used by getqflist()/getloclist() to determine which fields to return.
Bram Moolenaard823fa92016-08-12 16:29:27 +02006888enum {
6889 QF_GETLIST_NONE = 0x0,
6890 QF_GETLIST_TITLE = 0x1,
6891 QF_GETLIST_ITEMS = 0x2,
6892 QF_GETLIST_NR = 0x4,
6893 QF_GETLIST_WINID = 0x8,
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02006894 QF_GETLIST_CONTEXT = 0x10,
Bram Moolenaara539f4f2017-08-30 20:33:55 +02006895 QF_GETLIST_ID = 0x20,
Bram Moolenaarfc2b2702017-09-15 22:43:07 +02006896 QF_GETLIST_IDX = 0x40,
6897 QF_GETLIST_SIZE = 0x80,
Bram Moolenaarb254af32017-12-18 19:48:58 +01006898 QF_GETLIST_TICK = 0x100,
Bram Moolenaarc9cc9c72018-09-02 15:18:42 +02006899 QF_GETLIST_FILEWINID = 0x200,
Bram Moolenaar647e24b2019-03-17 16:39:46 +01006900 QF_GETLIST_QFBUFNR = 0x400,
Bram Moolenaard43906d2020-07-20 21:31:32 +02006901 QF_GETLIST_QFTF = 0x800,
6902 QF_GETLIST_ALL = 0xFFF,
Bram Moolenaard823fa92016-08-12 16:29:27 +02006903};
6904
6905/*
Bram Moolenaar353eeea2018-04-16 18:04:57 +02006906 * Parse text from 'di' and return the quickfix list items.
6907 * Existing quickfix lists are not modified.
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02006908 */
6909 static int
Bram Moolenaar36538222017-09-02 19:51:44 +02006910qf_get_list_from_lines(dict_T *what, dictitem_T *di, dict_T *retdict)
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02006911{
6912 int status = FAIL;
6913 qf_info_T *qi;
Bram Moolenaar36538222017-09-02 19:51:44 +02006914 char_u *errorformat = p_efm;
6915 dictitem_T *efm_di;
6916 list_T *l;
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02006917
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006918 // Only a List value is supported
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00006919 if (di->di_tv.v_type != VAR_LIST || di->di_tv.vval.v_list == NULL)
6920 return FAIL;
6921
6922 // If errorformat is supplied then use it, otherwise use the 'efm'
6923 // option setting
6924 if ((efm_di = dict_find(what, (char_u *)"efm", -1)) != NULL)
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02006925 {
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00006926 if (efm_di->di_tv.v_type != VAR_STRING ||
6927 efm_di->di_tv.vval.v_string == NULL)
Bram Moolenaarda732532017-08-31 20:58:02 +02006928 return FAIL;
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00006929 errorformat = efm_di->di_tv.vval.v_string;
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02006930 }
6931
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00006932 l = list_alloc();
6933 if (l == NULL)
6934 return FAIL;
6935
6936 qi = qf_alloc_stack(QFLT_INTERNAL);
6937 if (qi != NULL)
6938 {
6939 if (qf_init_ext(qi, 0, NULL, NULL, &di->di_tv, errorformat,
6940 TRUE, (linenr_T)0, (linenr_T)0, NULL, NULL) > 0)
6941 {
6942 (void)get_errorlist(qi, NULL, 0, 0, l);
6943 qf_free(&qi->qf_lists[0]);
6944 }
6945 free(qi);
6946 }
6947 dict_add_list(retdict, "items", l);
6948 status = OK;
6949
Bram Moolenaar7adf06f2017-08-27 15:23:41 +02006950 return status;
6951}
6952
6953/*
Bram Moolenaar2ec364e2018-01-27 11:52:13 +01006954 * Return the quickfix/location list window identifier in the current tabpage.
6955 */
6956 static int
6957qf_winid(qf_info_T *qi)
6958{
6959 win_T *win;
6960
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02006961 // The quickfix window can be opened even if the quickfix list is not set
6962 // using ":copen". This is not true for location lists.
Bram Moolenaar2ec364e2018-01-27 11:52:13 +01006963 if (qi == NULL)
6964 return 0;
6965 win = qf_find_win(qi);
6966 if (win != NULL)
6967 return win->w_id;
6968 return 0;
6969}
6970
6971/*
Bram Moolenaar647e24b2019-03-17 16:39:46 +01006972 * Returns the number of the buffer displayed in the quickfix/location list
Yegappan Lakshmanan56150da2021-12-09 09:27:06 +00006973 * window. If there is no buffer associated with the list or the buffer is
6974 * wiped out, then returns 0.
Bram Moolenaar647e24b2019-03-17 16:39:46 +01006975 */
6976 static int
6977qf_getprop_qfbufnr(qf_info_T *qi, dict_T *retdict)
6978{
Yegappan Lakshmanan56150da2021-12-09 09:27:06 +00006979 int bufnum = 0;
6980
6981 if (qi != NULL && buflist_findnr(qi->qf_bufnr) != NULL)
6982 bufnum = qi->qf_bufnr;
6983
6984 return dict_add_number(retdict, "qfbufnr", bufnum);
Bram Moolenaar647e24b2019-03-17 16:39:46 +01006985}
6986
6987/*
Bram Moolenaar353eeea2018-04-16 18:04:57 +02006988 * Convert the keys in 'what' to quickfix list property flags.
Bram Moolenaar68b76a62005-03-25 21:53:48 +00006989 */
Bram Moolenaar353eeea2018-04-16 18:04:57 +02006990 static int
Bram Moolenaarc9cc9c72018-09-02 15:18:42 +02006991qf_getprop_keys2flags(dict_T *what, int loclist)
Bram Moolenaard823fa92016-08-12 16:29:27 +02006992{
Bram Moolenaard823fa92016-08-12 16:29:27 +02006993 int flags = QF_GETLIST_NONE;
6994
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01006995 if (dict_has_key(what, "all"))
Bram Moolenaarc9cc9c72018-09-02 15:18:42 +02006996 {
Bram Moolenaara539f4f2017-08-30 20:33:55 +02006997 flags |= QF_GETLIST_ALL;
Bram Moolenaarc9cc9c72018-09-02 15:18:42 +02006998 if (!loclist)
6999 // File window ID is applicable only to location list windows
7000 flags &= ~ QF_GETLIST_FILEWINID;
7001 }
Bram Moolenaard823fa92016-08-12 16:29:27 +02007002
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007003 if (dict_has_key(what, "title"))
Bram Moolenaara539f4f2017-08-30 20:33:55 +02007004 flags |= QF_GETLIST_TITLE;
Bram Moolenaard823fa92016-08-12 16:29:27 +02007005
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007006 if (dict_has_key(what, "nr"))
Bram Moolenaara6d48492017-12-12 22:45:31 +01007007 flags |= QF_GETLIST_NR;
7008
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007009 if (dict_has_key(what, "winid"))
Bram Moolenaara539f4f2017-08-30 20:33:55 +02007010 flags |= QF_GETLIST_WINID;
Bram Moolenaard823fa92016-08-12 16:29:27 +02007011
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007012 if (dict_has_key(what, "context"))
Bram Moolenaara539f4f2017-08-30 20:33:55 +02007013 flags |= QF_GETLIST_CONTEXT;
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02007014
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007015 if (dict_has_key(what, "id"))
Bram Moolenaara6d48492017-12-12 22:45:31 +01007016 flags |= QF_GETLIST_ID;
7017
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007018 if (dict_has_key(what, "items"))
Bram Moolenaara539f4f2017-08-30 20:33:55 +02007019 flags |= QF_GETLIST_ITEMS;
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007020
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007021 if (dict_has_key(what, "idx"))
Bram Moolenaarfc2b2702017-09-15 22:43:07 +02007022 flags |= QF_GETLIST_IDX;
7023
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007024 if (dict_has_key(what, "size"))
Bram Moolenaarfc2b2702017-09-15 22:43:07 +02007025 flags |= QF_GETLIST_SIZE;
7026
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007027 if (dict_has_key(what, "changedtick"))
Bram Moolenaarb254af32017-12-18 19:48:58 +01007028 flags |= QF_GETLIST_TICK;
7029
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007030 if (loclist && dict_has_key(what, "filewinid"))
Bram Moolenaarc9cc9c72018-09-02 15:18:42 +02007031 flags |= QF_GETLIST_FILEWINID;
7032
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007033 if (dict_has_key(what, "qfbufnr"))
Bram Moolenaar647e24b2019-03-17 16:39:46 +01007034 flags |= QF_GETLIST_QFBUFNR;
7035
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007036 if (dict_has_key(what, "quickfixtextfunc"))
Bram Moolenaard43906d2020-07-20 21:31:32 +02007037 flags |= QF_GETLIST_QFTF;
7038
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007039 return flags;
7040}
Bram Moolenaara6d48492017-12-12 22:45:31 +01007041
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007042/*
7043 * Return the quickfix list index based on 'nr' or 'id' in 'what'.
7044 * If 'nr' and 'id' are not present in 'what' then return the current
7045 * quickfix list index.
7046 * If 'nr' is zero then return the current quickfix list index.
7047 * If 'nr' is '$' then return the last quickfix list index.
7048 * If 'id' is present then return the index of the quickfix list with that id.
7049 * If 'id' is zero then return the quickfix list index specified by 'nr'.
7050 * Return -1, if quickfix list is not present or if the stack is empty.
7051 */
7052 static int
7053qf_getprop_qfidx(qf_info_T *qi, dict_T *what)
7054{
7055 int qf_idx;
7056 dictitem_T *di;
7057
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007058 qf_idx = qi->qf_curlist; // default is the current list
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007059 if ((di = dict_find(what, (char_u *)"nr", -1)) != NULL)
7060 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007061 // Use the specified quickfix/location list
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007062 if (di->di_tv.v_type == VAR_NUMBER)
Bram Moolenaara6d48492017-12-12 22:45:31 +01007063 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007064 // for zero use the current list
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007065 if (di->di_tv.vval.v_number != 0)
Bram Moolenaara6d48492017-12-12 22:45:31 +01007066 {
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007067 qf_idx = di->di_tv.vval.v_number - 1;
7068 if (qf_idx < 0 || qf_idx >= qi->qf_listcount)
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007069 qf_idx = INVALID_QFIDX;
Bram Moolenaara6d48492017-12-12 22:45:31 +01007070 }
Bram Moolenaara6d48492017-12-12 22:45:31 +01007071 }
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007072 else if (di->di_tv.v_type == VAR_STRING
7073 && di->di_tv.vval.v_string != NULL
7074 && STRCMP(di->di_tv.vval.v_string, "$") == 0)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007075 // Get the last quickfix list number
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007076 qf_idx = qi->qf_listcount - 1;
7077 else
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007078 qf_idx = INVALID_QFIDX;
Bram Moolenaara6d48492017-12-12 22:45:31 +01007079 }
7080
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007081 if ((di = dict_find(what, (char_u *)"id", -1)) != NULL)
7082 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007083 // Look for a list with the specified id
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007084 if (di->di_tv.v_type == VAR_NUMBER)
7085 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007086 // For zero, use the current list or the list specified by 'nr'
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007087 if (di->di_tv.vval.v_number != 0)
7088 qf_idx = qf_id2nr(qi, di->di_tv.vval.v_number);
7089 }
7090 else
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007091 qf_idx = INVALID_QFIDX;
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007092 }
7093
7094 return qf_idx;
7095}
7096
7097/*
7098 * Return default values for quickfix list properties in retdict.
7099 */
7100 static int
Bram Moolenaar2d67d302018-11-16 18:46:02 +01007101qf_getprop_defaults(qf_info_T *qi, int flags, int locstack, dict_T *retdict)
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007102{
7103 int status = OK;
7104
7105 if (flags & QF_GETLIST_TITLE)
Bram Moolenaare0be1672018-07-08 16:50:37 +02007106 status = dict_add_string(retdict, "title", (char_u *)"");
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007107 if ((status == OK) && (flags & QF_GETLIST_ITEMS))
7108 {
7109 list_T *l = list_alloc();
7110 if (l != NULL)
7111 status = dict_add_list(retdict, "items", l);
7112 else
7113 status = FAIL;
7114 }
7115 if ((status == OK) && (flags & QF_GETLIST_NR))
Bram Moolenaare0be1672018-07-08 16:50:37 +02007116 status = dict_add_number(retdict, "nr", 0);
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007117 if ((status == OK) && (flags & QF_GETLIST_WINID))
Bram Moolenaare0be1672018-07-08 16:50:37 +02007118 status = dict_add_number(retdict, "winid", qf_winid(qi));
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007119 if ((status == OK) && (flags & QF_GETLIST_CONTEXT))
Bram Moolenaare0be1672018-07-08 16:50:37 +02007120 status = dict_add_string(retdict, "context", (char_u *)"");
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007121 if ((status == OK) && (flags & QF_GETLIST_ID))
Bram Moolenaare0be1672018-07-08 16:50:37 +02007122 status = dict_add_number(retdict, "id", 0);
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007123 if ((status == OK) && (flags & QF_GETLIST_IDX))
Bram Moolenaare0be1672018-07-08 16:50:37 +02007124 status = dict_add_number(retdict, "idx", 0);
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007125 if ((status == OK) && (flags & QF_GETLIST_SIZE))
Bram Moolenaare0be1672018-07-08 16:50:37 +02007126 status = dict_add_number(retdict, "size", 0);
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007127 if ((status == OK) && (flags & QF_GETLIST_TICK))
Bram Moolenaare0be1672018-07-08 16:50:37 +02007128 status = dict_add_number(retdict, "changedtick", 0);
Bram Moolenaar2d67d302018-11-16 18:46:02 +01007129 if ((status == OK) && locstack && (flags & QF_GETLIST_FILEWINID))
Bram Moolenaarc9cc9c72018-09-02 15:18:42 +02007130 status = dict_add_number(retdict, "filewinid", 0);
Bram Moolenaar647e24b2019-03-17 16:39:46 +01007131 if ((status == OK) && (flags & QF_GETLIST_QFBUFNR))
7132 status = qf_getprop_qfbufnr(qi, retdict);
Bram Moolenaard43906d2020-07-20 21:31:32 +02007133 if ((status == OK) && (flags & QF_GETLIST_QFTF))
7134 status = dict_add_string(retdict, "quickfixtextfunc", (char_u *)"");
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007135
7136 return status;
7137}
7138
7139/*
7140 * Return the quickfix list title as 'title' in retdict
7141 */
7142 static int
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007143qf_getprop_title(qf_list_T *qfl, dict_T *retdict)
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007144{
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007145 return dict_add_string(retdict, "title", qfl->qf_title);
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007146}
7147
7148/*
Bram Moolenaarc9cc9c72018-09-02 15:18:42 +02007149 * Returns the identifier of the window used to display files from a location
7150 * list. If there is no associated window, then returns 0. Useful only when
7151 * called from a location list window.
7152 */
7153 static int
7154qf_getprop_filewinid(win_T *wp, qf_info_T *qi, dict_T *retdict)
7155{
7156 int winid = 0;
7157
7158 if (wp != NULL && IS_LL_WINDOW(wp))
7159 {
7160 win_T *ll_wp = qf_find_win_with_loclist(qi);
7161 if (ll_wp != NULL)
7162 winid = ll_wp->w_id;
7163 }
7164
7165 return dict_add_number(retdict, "filewinid", winid);
7166}
7167
7168/*
Bram Moolenaar858ba062020-05-31 23:11:59 +02007169 * Return the quickfix list items/entries as 'items' in retdict.
7170 * If eidx is not 0, then return the item at the specified index.
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007171 */
7172 static int
Bram Moolenaar858ba062020-05-31 23:11:59 +02007173qf_getprop_items(qf_info_T *qi, int qf_idx, int eidx, dict_T *retdict)
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007174{
7175 int status = OK;
7176 list_T *l = list_alloc();
7177 if (l != NULL)
7178 {
Bram Moolenaar858ba062020-05-31 23:11:59 +02007179 (void)get_errorlist(qi, NULL, qf_idx, eidx, l);
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007180 dict_add_list(retdict, "items", l);
7181 }
7182 else
7183 status = FAIL;
7184
7185 return status;
7186}
7187
7188/*
7189 * Return the quickfix list context (if any) as 'context' in retdict.
7190 */
7191 static int
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007192qf_getprop_ctx(qf_list_T *qfl, dict_T *retdict)
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007193{
7194 int status;
7195 dictitem_T *di;
7196
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007197 if (qfl->qf_ctx != NULL)
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007198 {
7199 di = dictitem_alloc((char_u *)"context");
7200 if (di != NULL)
7201 {
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007202 copy_tv(qfl->qf_ctx, &di->di_tv);
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007203 status = dict_add(retdict, di);
7204 if (status == FAIL)
7205 dictitem_free(di);
7206 }
7207 else
7208 status = FAIL;
7209 }
7210 else
Bram Moolenaare0be1672018-07-08 16:50:37 +02007211 status = dict_add_string(retdict, "context", (char_u *)"");
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007212
7213 return status;
7214}
7215
7216/*
Bram Moolenaar858ba062020-05-31 23:11:59 +02007217 * Return the current quickfix list index as 'idx' in retdict.
7218 * If a specific entry index (eidx) is supplied, then use that.
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007219 */
7220 static int
Bram Moolenaar858ba062020-05-31 23:11:59 +02007221qf_getprop_idx(qf_list_T *qfl, int eidx, dict_T *retdict)
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007222{
Bram Moolenaar858ba062020-05-31 23:11:59 +02007223 if (eidx == 0)
7224 {
7225 eidx = qfl->qf_index;
7226 if (qf_list_empty(qfl))
7227 // For empty lists, current index is set to 0
7228 eidx = 0;
7229 }
7230 return dict_add_number(retdict, "idx", eidx);
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007231}
7232
7233/*
Bram Moolenaard43906d2020-07-20 21:31:32 +02007234 * Return the 'quickfixtextfunc' function of a quickfix/location list
7235 */
7236 static int
7237qf_getprop_qftf(qf_list_T *qfl, dict_T *retdict)
7238{
7239 int status;
7240
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +01007241 if (qfl->qf_qftf_cb.cb_name != NULL)
Bram Moolenaard43906d2020-07-20 21:31:32 +02007242 {
7243 typval_T tv;
7244
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +01007245 put_callback(&qfl->qf_qftf_cb, &tv);
Bram Moolenaard43906d2020-07-20 21:31:32 +02007246 status = dict_add_tv(retdict, "quickfixtextfunc", &tv);
7247 clear_tv(&tv);
7248 }
7249 else
7250 status = dict_add_string(retdict, "quickfixtextfunc", (char_u *)"");
7251
7252 return status;
7253}
7254
7255/*
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007256 * Return quickfix/location list details (title) as a
7257 * dictionary. 'what' contains the details to return. If 'list_idx' is -1,
7258 * then current list is used. Otherwise the specified list is used.
7259 */
Bram Moolenaare677df82019-09-02 22:31:11 +02007260 static int
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007261qf_get_properties(win_T *wp, dict_T *what, dict_T *retdict)
7262{
7263 qf_info_T *qi = &ql_info;
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007264 qf_list_T *qfl;
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007265 int status = OK;
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007266 int qf_idx = INVALID_QFIDX;
Bram Moolenaar858ba062020-05-31 23:11:59 +02007267 int eidx = 0;
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007268 dictitem_T *di;
7269 int flags = QF_GETLIST_NONE;
7270
7271 if ((di = dict_find(what, (char_u *)"lines", -1)) != NULL)
7272 return qf_get_list_from_lines(what, di, retdict);
7273
7274 if (wp != NULL)
7275 qi = GET_LOC_LIST(wp);
7276
Bram Moolenaarc9cc9c72018-09-02 15:18:42 +02007277 flags = qf_getprop_keys2flags(what, (wp != NULL));
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007278
Bram Moolenaar019dfe62018-10-07 14:38:49 +02007279 if (!qf_stack_empty(qi))
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007280 qf_idx = qf_getprop_qfidx(qi, what);
7281
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007282 // List is not present or is empty
Bram Moolenaar019dfe62018-10-07 14:38:49 +02007283 if (qf_stack_empty(qi) || qf_idx == INVALID_QFIDX)
Bram Moolenaar2d67d302018-11-16 18:46:02 +01007284 return qf_getprop_defaults(qi, flags, wp != NULL, retdict);
Bram Moolenaara6d48492017-12-12 22:45:31 +01007285
Bram Moolenaar0398e002019-03-21 21:12:49 +01007286 qfl = qf_get_list(qi, qf_idx);
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007287
Bram Moolenaar858ba062020-05-31 23:11:59 +02007288 // If an entry index is specified, use that
7289 if ((di = dict_find(what, (char_u *)"idx", -1)) != NULL)
7290 {
7291 if (di->di_tv.v_type != VAR_NUMBER)
7292 return FAIL;
7293 eidx = di->di_tv.vval.v_number;
7294 }
7295
Bram Moolenaard823fa92016-08-12 16:29:27 +02007296 if (flags & QF_GETLIST_TITLE)
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007297 status = qf_getprop_title(qfl, retdict);
Bram Moolenaard823fa92016-08-12 16:29:27 +02007298 if ((status == OK) && (flags & QF_GETLIST_NR))
Bram Moolenaare0be1672018-07-08 16:50:37 +02007299 status = dict_add_number(retdict, "nr", qf_idx + 1);
Bram Moolenaard823fa92016-08-12 16:29:27 +02007300 if ((status == OK) && (flags & QF_GETLIST_WINID))
Bram Moolenaare0be1672018-07-08 16:50:37 +02007301 status = dict_add_number(retdict, "winid", qf_winid(qi));
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02007302 if ((status == OK) && (flags & QF_GETLIST_ITEMS))
Bram Moolenaar858ba062020-05-31 23:11:59 +02007303 status = qf_getprop_items(qi, qf_idx, eidx, retdict);
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007304 if ((status == OK) && (flags & QF_GETLIST_CONTEXT))
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007305 status = qf_getprop_ctx(qfl, retdict);
Bram Moolenaara539f4f2017-08-30 20:33:55 +02007306 if ((status == OK) && (flags & QF_GETLIST_ID))
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007307 status = dict_add_number(retdict, "id", qfl->qf_id);
Bram Moolenaarfc2b2702017-09-15 22:43:07 +02007308 if ((status == OK) && (flags & QF_GETLIST_IDX))
Bram Moolenaar858ba062020-05-31 23:11:59 +02007309 status = qf_getprop_idx(qfl, eidx, retdict);
Bram Moolenaarfc2b2702017-09-15 22:43:07 +02007310 if ((status == OK) && (flags & QF_GETLIST_SIZE))
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007311 status = dict_add_number(retdict, "size", qfl->qf_count);
Bram Moolenaarb254af32017-12-18 19:48:58 +01007312 if ((status == OK) && (flags & QF_GETLIST_TICK))
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007313 status = dict_add_number(retdict, "changedtick", qfl->qf_changedtick);
Bram Moolenaarc9cc9c72018-09-02 15:18:42 +02007314 if ((status == OK) && (wp != NULL) && (flags & QF_GETLIST_FILEWINID))
7315 status = qf_getprop_filewinid(wp, qi, retdict);
Bram Moolenaar647e24b2019-03-17 16:39:46 +01007316 if ((status == OK) && (flags & QF_GETLIST_QFBUFNR))
7317 status = qf_getprop_qfbufnr(qi, retdict);
Bram Moolenaard43906d2020-07-20 21:31:32 +02007318 if ((status == OK) && (flags & QF_GETLIST_QFTF))
7319 status = qf_getprop_qftf(qfl, retdict);
Bram Moolenaarb254af32017-12-18 19:48:58 +01007320
Bram Moolenaard823fa92016-08-12 16:29:27 +02007321 return status;
7322}
7323
7324/*
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007325 * Add a new quickfix entry to list at 'qf_idx' in the stack 'qi' from the
Bram Moolenaar9752c722018-12-22 16:49:34 +01007326 * items in the dict 'd'. If it is a valid error entry, then set 'valid_entry'
7327 * to TRUE.
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007328 */
7329 static int
7330qf_add_entry_from_dict(
Bram Moolenaar0398e002019-03-21 21:12:49 +01007331 qf_list_T *qfl,
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007332 dict_T *d,
Bram Moolenaar9752c722018-12-22 16:49:34 +01007333 int first_entry,
7334 int *valid_entry)
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007335{
7336 static int did_bufnr_emsg;
7337 char_u *filename, *module, *pattern, *text, *type;
thinca6864efa2021-06-19 20:45:20 +02007338 int bufnum, valid, status, col, end_col, vcol, nr;
7339 long lnum, end_lnum;
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007340
7341 if (first_entry)
7342 did_bufnr_emsg = FALSE;
7343
Bram Moolenaard61efa52022-07-23 09:52:04 +01007344 filename = dict_get_string(d, "filename", TRUE);
7345 module = dict_get_string(d, "module", TRUE);
7346 bufnum = (int)dict_get_number(d, "bufnr");
7347 lnum = (int)dict_get_number(d, "lnum");
7348 end_lnum = (int)dict_get_number(d, "end_lnum");
7349 col = (int)dict_get_number(d, "col");
7350 end_col = (int)dict_get_number(d, "end_col");
7351 vcol = (int)dict_get_number(d, "vcol");
7352 nr = (int)dict_get_number(d, "nr");
7353 type = dict_get_string(d, "type", TRUE);
7354 pattern = dict_get_string(d, "pattern", TRUE);
7355 text = dict_get_string(d, "text", TRUE);
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007356 if (text == NULL)
7357 text = vim_strsave((char_u *)"");
Tom Praschanca6ac992023-08-11 23:26:12 +02007358 typval_T user_data;
7359 user_data.v_type = VAR_UNKNOWN;
7360 dict_get_tv(d, "user_data", &user_data);
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007361
7362 valid = TRUE;
7363 if ((filename == NULL && bufnum == 0) || (lnum == 0 && pattern == NULL))
7364 valid = FALSE;
7365
7366 // Mark entries with non-existing buffer number as not valid. Give the
7367 // error message only once.
7368 if (bufnum != 0 && (buflist_findnr(bufnum) == NULL))
7369 {
7370 if (!did_bufnr_emsg)
7371 {
7372 did_bufnr_emsg = TRUE;
Bram Moolenaare1242042021-12-16 20:56:57 +00007373 semsg(_(e_buffer_nr_not_found), bufnum);
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007374 }
7375 valid = FALSE;
7376 bufnum = 0;
7377 }
7378
7379 // If the 'valid' field is present it overrules the detected value.
Yegappan Lakshmanan4829c1c2022-04-04 15:16:54 +01007380 if (dict_has_key(d, "valid"))
Bram Moolenaard61efa52022-07-23 09:52:04 +01007381 valid = (int)dict_get_bool(d, "valid", FALSE);
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007382
Bram Moolenaar0398e002019-03-21 21:12:49 +01007383 status = qf_add_entry(qfl,
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007384 NULL, // dir
7385 filename,
7386 module,
7387 bufnum,
7388 text,
7389 lnum,
thinca6864efa2021-06-19 20:45:20 +02007390 end_lnum,
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007391 col,
thinca6864efa2021-06-19 20:45:20 +02007392 end_col,
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007393 vcol, // vis_col
7394 pattern, // search pattern
7395 nr,
7396 type == NULL ? NUL : *type,
Tom Praschanca6ac992023-08-11 23:26:12 +02007397 &user_data,
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007398 valid);
7399
7400 vim_free(filename);
7401 vim_free(module);
7402 vim_free(pattern);
7403 vim_free(text);
7404 vim_free(type);
Tom Praschanca6ac992023-08-11 23:26:12 +02007405 clear_tv(&user_data);
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007406
Bram Moolenaar9752c722018-12-22 16:49:34 +01007407 if (valid)
7408 *valid_entry = TRUE;
7409
Bram Moolenaar6f6ef7c2018-08-28 22:07:44 +02007410 return status;
7411}
7412
7413/*
Bram Moolenaard823fa92016-08-12 16:29:27 +02007414 * Add list of entries to quickfix/location list. Each list entry is
7415 * a dictionary with item information.
7416 */
7417 static int
7418qf_add_entries(
7419 qf_info_T *qi,
Bram Moolenaara3921f42017-06-04 15:30:34 +02007420 int qf_idx,
Bram Moolenaard823fa92016-08-12 16:29:27 +02007421 list_T *list,
7422 char_u *title,
7423 int action)
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007424{
Bram Moolenaar0398e002019-03-21 21:12:49 +01007425 qf_list_T *qfl = qf_get_list(qi, qf_idx);
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007426 listitem_T *li;
7427 dict_T *d;
Bram Moolenaar864293a2016-06-02 13:40:04 +02007428 qfline_T *old_last = NULL;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007429 int retval = OK;
Bram Moolenaar9752c722018-12-22 16:49:34 +01007430 int valid_entry = FALSE;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007431
Bram Moolenaara3921f42017-06-04 15:30:34 +02007432 if (action == ' ' || qf_idx == qi->qf_listcount)
7433 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007434 // make place for a new list
Bram Moolenaar94116152012-11-28 17:41:59 +01007435 qf_new_list(qi, title);
Bram Moolenaara3921f42017-06-04 15:30:34 +02007436 qf_idx = qi->qf_curlist;
Bram Moolenaar0398e002019-03-21 21:12:49 +01007437 qfl = qf_get_list(qi, qf_idx);
Bram Moolenaara3921f42017-06-04 15:30:34 +02007438 }
Bram Moolenaar0398e002019-03-21 21:12:49 +01007439 else if (action == 'a' && !qf_list_empty(qfl))
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007440 // Adding to existing list, use last entry.
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007441 old_last = qfl->qf_last;
Bram Moolenaar35c54e52005-05-20 21:25:31 +00007442 else if (action == 'r')
Bram Moolenaarfb604092014-07-23 15:55:00 +02007443 {
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007444 qf_free_items(qfl);
7445 qf_store_title(qfl, title);
Bram Moolenaarfb604092014-07-23 15:55:00 +02007446 }
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007447
Bram Moolenaaraeea7212020-04-02 18:50:46 +02007448 FOR_ALL_LIST_ITEMS(list, li)
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007449 {
7450 if (li->li_tv.v_type != VAR_DICT)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007451 continue; // Skip non-dict items
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007452
7453 d = li->li_tv.vval.v_dict;
7454 if (d == NULL)
7455 continue;
7456
Bram Moolenaar0398e002019-03-21 21:12:49 +01007457 retval = qf_add_entry_from_dict(qfl, d, li == list->lv_first,
Bram Moolenaar9752c722018-12-22 16:49:34 +01007458 &valid_entry);
Bram Moolenaar95946f12019-03-31 15:31:59 +02007459 if (retval == QF_FAIL)
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007460 break;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007461 }
7462
Bram Moolenaar9752c722018-12-22 16:49:34 +01007463 // Check if any valid error entries are added to the list.
7464 if (valid_entry)
7465 qfl->qf_nonevalid = FALSE;
7466 else if (qfl->qf_index == 0)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007467 // no valid entry
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007468 qfl->qf_nonevalid = TRUE;
Bram Moolenaar9752c722018-12-22 16:49:34 +01007469
7470 // If not appending to the list, set the current error to the first entry
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007471 if (action != 'a')
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007472 qfl->qf_ptr = qfl->qf_start;
Bram Moolenaar9752c722018-12-22 16:49:34 +01007473
7474 // Update the current error index if not appending to the list or if the
7475 // list was empty before and it is not empty now.
Bram Moolenaar0398e002019-03-21 21:12:49 +01007476 if ((action != 'a' || qfl->qf_index == 0) && !qf_list_empty(qfl))
Bram Moolenaar9752c722018-12-22 16:49:34 +01007477 qfl->qf_index = 1;
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007478
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007479 // Don't update the cursor in quickfix window when appending entries
Bram Moolenaar864293a2016-06-02 13:40:04 +02007480 qf_update_buffer(qi, old_last);
Bram Moolenaar68b76a62005-03-25 21:53:48 +00007481
7482 return retval;
7483}
Bram Moolenaard823fa92016-08-12 16:29:27 +02007484
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007485/*
7486 * Get the quickfix list index from 'nr' or 'id'
7487 */
Bram Moolenaard823fa92016-08-12 16:29:27 +02007488 static int
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007489qf_setprop_get_qfidx(
7490 qf_info_T *qi,
7491 dict_T *what,
7492 int action,
7493 int *newlist)
Bram Moolenaard823fa92016-08-12 16:29:27 +02007494{
7495 dictitem_T *di;
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007496 int qf_idx = qi->qf_curlist; // default is the current list
Bram Moolenaar2b529bb2016-08-27 13:35:35 +02007497
Bram Moolenaard823fa92016-08-12 16:29:27 +02007498 if ((di = dict_find(what, (char_u *)"nr", -1)) != NULL)
7499 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007500 // Use the specified quickfix/location list
Bram Moolenaard823fa92016-08-12 16:29:27 +02007501 if (di->di_tv.v_type == VAR_NUMBER)
7502 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007503 // for zero use the current list
Bram Moolenaar6e62da32017-05-28 08:16:25 +02007504 if (di->di_tv.vval.v_number != 0)
7505 qf_idx = di->di_tv.vval.v_number - 1;
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02007506
Bram Moolenaar55b69262017-08-13 13:42:01 +02007507 if ((action == ' ' || action == 'a') && qf_idx == qi->qf_listcount)
7508 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007509 // When creating a new list, accept qf_idx pointing to the next
7510 // non-available list and add the new list at the end of the
7511 // stack.
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007512 *newlist = TRUE;
Bram Moolenaar019dfe62018-10-07 14:38:49 +02007513 qf_idx = qf_stack_empty(qi) ? 0 : qi->qf_listcount - 1;
Bram Moolenaar55b69262017-08-13 13:42:01 +02007514 }
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02007515 else if (qf_idx < 0 || qf_idx >= qi->qf_listcount)
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007516 return INVALID_QFIDX;
Bram Moolenaar55b69262017-08-13 13:42:01 +02007517 else if (action != ' ')
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007518 *newlist = FALSE; // use the specified list
Bram Moolenaar55b69262017-08-13 13:42:01 +02007519 }
7520 else if (di->di_tv.v_type == VAR_STRING
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007521 && di->di_tv.vval.v_string != NULL
7522 && STRCMP(di->di_tv.vval.v_string, "$") == 0)
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02007523 {
Bram Moolenaar019dfe62018-10-07 14:38:49 +02007524 if (!qf_stack_empty(qi))
Bram Moolenaar55b69262017-08-13 13:42:01 +02007525 qf_idx = qi->qf_listcount - 1;
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007526 else if (*newlist)
Bram Moolenaar55b69262017-08-13 13:42:01 +02007527 qf_idx = 0;
7528 else
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007529 return INVALID_QFIDX;
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02007530 }
Bram Moolenaard823fa92016-08-12 16:29:27 +02007531 else
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007532 return INVALID_QFIDX;
Bram Moolenaar2b529bb2016-08-27 13:35:35 +02007533 }
7534
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007535 if (!*newlist && (di = dict_find(what, (char_u *)"id", -1)) != NULL)
Bram Moolenaara539f4f2017-08-30 20:33:55 +02007536 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007537 // Use the quickfix/location list with the specified id
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007538 if (di->di_tv.v_type != VAR_NUMBER)
7539 return INVALID_QFIDX;
7540
7541 return qf_id2nr(qi, di->di_tv.vval.v_number);
Bram Moolenaara539f4f2017-08-30 20:33:55 +02007542 }
7543
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007544 return qf_idx;
7545}
7546
7547/*
7548 * Set the quickfix list title.
7549 */
7550 static int
7551qf_setprop_title(qf_info_T *qi, int qf_idx, dict_T *what, dictitem_T *di)
7552{
Bram Moolenaar0398e002019-03-21 21:12:49 +01007553 qf_list_T *qfl = qf_get_list(qi, qf_idx);
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007554
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007555 if (di->di_tv.v_type != VAR_STRING)
7556 return FAIL;
7557
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007558 vim_free(qfl->qf_title);
Bram Moolenaard61efa52022-07-23 09:52:04 +01007559 qfl->qf_title = dict_get_string(what, "title", TRUE);
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007560 if (qf_idx == qi->qf_curlist)
7561 qf_update_win_titlevar(qi);
7562
7563 return OK;
7564}
7565
7566/*
7567 * Set quickfix list items/entries.
7568 */
7569 static int
7570qf_setprop_items(qf_info_T *qi, int qf_idx, dictitem_T *di, int action)
7571{
7572 int retval = FAIL;
7573 char_u *title_save;
7574
7575 if (di->di_tv.v_type != VAR_LIST)
7576 return FAIL;
7577
7578 title_save = vim_strsave(qi->qf_lists[qf_idx].qf_title);
7579 retval = qf_add_entries(qi, qf_idx, di->di_tv.vval.v_list,
7580 title_save, action == ' ' ? 'a' : action);
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007581 vim_free(title_save);
7582
7583 return retval;
7584}
7585
7586/*
7587 * Set quickfix list items/entries from a list of lines.
7588 */
7589 static int
7590qf_setprop_items_from_lines(
7591 qf_info_T *qi,
7592 int qf_idx,
7593 dict_T *what,
7594 dictitem_T *di,
7595 int action)
7596{
7597 char_u *errorformat = p_efm;
7598 dictitem_T *efm_di;
7599 int retval = FAIL;
7600
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007601 // Use the user supplied errorformat settings (if present)
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007602 if ((efm_di = dict_find(what, (char_u *)"efm", -1)) != NULL)
7603 {
7604 if (efm_di->di_tv.v_type != VAR_STRING ||
7605 efm_di->di_tv.vval.v_string == NULL)
7606 return FAIL;
7607 errorformat = efm_di->di_tv.vval.v_string;
7608 }
7609
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007610 // Only a List value is supported
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007611 if (di->di_tv.v_type != VAR_LIST || di->di_tv.vval.v_list == NULL)
7612 return FAIL;
7613
7614 if (action == 'r')
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007615 qf_free_items(&qi->qf_lists[qf_idx]);
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007616 if (qf_init_ext(qi, qf_idx, NULL, NULL, &di->di_tv, errorformat,
Bram Moolenaar287153c2020-11-29 14:20:27 +01007617 FALSE, (linenr_T)0, (linenr_T)0, NULL, NULL) >= 0)
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007618 retval = OK;
7619
7620 return retval;
7621}
7622
7623/*
7624 * Set quickfix list context.
7625 */
7626 static int
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007627qf_setprop_context(qf_list_T *qfl, dictitem_T *di)
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007628{
7629 typval_T *ctx;
7630
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007631 free_tv(qfl->qf_ctx);
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007632 ctx = alloc_tv();
7633 if (ctx != NULL)
7634 copy_tv(&di->di_tv, ctx);
Bram Moolenaarfe15b7d2018-09-18 22:50:06 +02007635 qfl->qf_ctx = ctx;
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007636
7637 return OK;
7638}
7639
7640/*
Bram Moolenaar5b69c222019-01-11 14:50:06 +01007641 * Set the current index in the specified quickfix list
7642 */
7643 static int
7644qf_setprop_curidx(qf_info_T *qi, qf_list_T *qfl, dictitem_T *di)
7645{
7646 int denote = FALSE;
7647 int newidx;
7648 int old_qfidx;
7649 qfline_T *qf_ptr;
7650
7651 // If the specified index is '$', then use the last entry
7652 if (di->di_tv.v_type == VAR_STRING
7653 && di->di_tv.vval.v_string != NULL
7654 && STRCMP(di->di_tv.vval.v_string, "$") == 0)
7655 newidx = qfl->qf_count;
7656 else
7657 {
7658 // Otherwise use the specified index
7659 newidx = tv_get_number_chk(&di->di_tv, &denote);
7660 if (denote)
7661 return FAIL;
7662 }
7663
7664 if (newidx < 1) // sanity check
7665 return FAIL;
7666 if (newidx > qfl->qf_count)
7667 newidx = qfl->qf_count;
7668
7669 old_qfidx = qfl->qf_index;
7670 qf_ptr = get_nth_entry(qfl, newidx, &newidx);
7671 if (qf_ptr == NULL)
7672 return FAIL;
7673 qfl->qf_ptr = qf_ptr;
7674 qfl->qf_index = newidx;
7675
7676 // If the current list is modified and it is displayed in the quickfix
7677 // window, then Update it.
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01007678 if (qf_get_curlist(qi)->qf_id == qfl->qf_id)
Bram Moolenaar5b69c222019-01-11 14:50:06 +01007679 qf_win_pos_update(qi, old_qfidx);
7680
7681 return OK;
7682}
7683
7684/*
Bram Moolenaar858ba062020-05-31 23:11:59 +02007685 * Set the current index in the specified quickfix list
7686 */
7687 static int
7688qf_setprop_qftf(qf_info_T *qi UNUSED, qf_list_T *qfl, dictitem_T *di)
7689{
Bram Moolenaard43906d2020-07-20 21:31:32 +02007690 callback_T cb;
7691
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +01007692 free_callback(&qfl->qf_qftf_cb);
Bram Moolenaard43906d2020-07-20 21:31:32 +02007693 cb = get_callback(&di->di_tv);
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00007694 if (cb.cb_name == NULL || *cb.cb_name == NUL)
7695 return OK;
7696
7697 set_callback(&qfl->qf_qftf_cb, &cb);
7698 if (cb.cb_free_name)
7699 vim_free(cb.cb_name);
Bram Moolenaar858ba062020-05-31 23:11:59 +02007700
7701 return OK;
7702}
7703
7704/*
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007705 * Set quickfix/location list properties (title, items, context).
7706 * Also used to add items from parsing a list of lines.
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02007707 * Used by the setqflist() and setloclist() Vim script functions.
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007708 */
7709 static int
7710qf_set_properties(qf_info_T *qi, dict_T *what, int action, char_u *title)
7711{
7712 dictitem_T *di;
7713 int retval = FAIL;
7714 int qf_idx;
7715 int newlist = FALSE;
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007716 qf_list_T *qfl;
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007717
Bram Moolenaar019dfe62018-10-07 14:38:49 +02007718 if (action == ' ' || qf_stack_empty(qi))
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007719 newlist = TRUE;
7720
7721 qf_idx = qf_setprop_get_qfidx(qi, what, action, &newlist);
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007722 if (qf_idx == INVALID_QFIDX) // List not found
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007723 return FAIL;
7724
Bram Moolenaar2b529bb2016-08-27 13:35:35 +02007725 if (newlist)
7726 {
Bram Moolenaar55b69262017-08-13 13:42:01 +02007727 qi->qf_curlist = qf_idx;
Bram Moolenaarae338332017-08-11 20:25:26 +02007728 qf_new_list(qi, title);
Bram Moolenaar2b529bb2016-08-27 13:35:35 +02007729 qf_idx = qi->qf_curlist;
Bram Moolenaard823fa92016-08-12 16:29:27 +02007730 }
7731
Bram Moolenaar0398e002019-03-21 21:12:49 +01007732 qfl = qf_get_list(qi, qf_idx);
Bram Moolenaard823fa92016-08-12 16:29:27 +02007733 if ((di = dict_find(what, (char_u *)"title", -1)) != NULL)
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007734 retval = qf_setprop_title(qi, qf_idx, what, di);
Bram Moolenaar6a8958d2017-06-22 21:33:20 +02007735 if ((di = dict_find(what, (char_u *)"items", -1)) != NULL)
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007736 retval = qf_setprop_items(qi, qf_idx, di, action);
Bram Moolenaar2c809b72017-09-01 18:34:02 +02007737 if ((di = dict_find(what, (char_u *)"lines", -1)) != NULL)
Bram Moolenaara2aa8a22018-04-24 13:55:00 +02007738 retval = qf_setprop_items_from_lines(qi, qf_idx, what, di, action);
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007739 if ((di = dict_find(what, (char_u *)"context", -1)) != NULL)
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007740 retval = qf_setprop_context(qfl, di);
Bram Moolenaar5b69c222019-01-11 14:50:06 +01007741 if ((di = dict_find(what, (char_u *)"idx", -1)) != NULL)
7742 retval = qf_setprop_curidx(qi, qfl, di);
Bram Moolenaar858ba062020-05-31 23:11:59 +02007743 if ((di = dict_find(what, (char_u *)"quickfixtextfunc", -1)) != NULL)
7744 retval = qf_setprop_qftf(qi, qfl, di);
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007745
Bram Moolenaar287153c2020-11-29 14:20:27 +01007746 if (newlist || retval == OK)
Bram Moolenaar108e7b42018-10-11 17:39:12 +02007747 qf_list_changed(qfl);
Bram Moolenaar287153c2020-11-29 14:20:27 +01007748 if (newlist)
7749 qf_update_buffer(qi, NULL);
Bram Moolenaarb254af32017-12-18 19:48:58 +01007750
Bram Moolenaard823fa92016-08-12 16:29:27 +02007751 return retval;
7752}
7753
Bram Moolenaar69f40be2017-04-02 15:15:49 +02007754/*
Bram Moolenaar69f40be2017-04-02 15:15:49 +02007755 * Free the entire quickfix/location list stack.
7756 * If the quickfix/location list window is open, then clear it.
7757 */
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007758 static void
7759qf_free_stack(win_T *wp, qf_info_T *qi)
7760{
Bram Moolenaar69f40be2017-04-02 15:15:49 +02007761 win_T *qfwin = qf_find_win(qi);
7762 win_T *llwin = NULL;
Bram Moolenaar69f40be2017-04-02 15:15:49 +02007763
7764 if (qfwin != NULL)
7765 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007766 // If the quickfix/location list window is open, then clear it
Bram Moolenaar69f40be2017-04-02 15:15:49 +02007767 if (qi->qf_curlist < qi->qf_listcount)
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01007768 qf_free(qf_get_curlist(qi));
Bram Moolenaar69f40be2017-04-02 15:15:49 +02007769 qf_update_buffer(qi, NULL);
7770 }
7771
7772 if (wp != NULL && IS_LL_WINDOW(wp))
7773 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007774 // If in the location list window, then use the non-location list
7775 // window with this location list (if present)
Bram Moolenaaree8188f2019-02-05 21:23:04 +01007776 llwin = qf_find_win_with_loclist(qi);
Bram Moolenaar69f40be2017-04-02 15:15:49 +02007777 if (llwin != NULL)
7778 wp = llwin;
7779 }
7780
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007781 qf_free_all(wp);
7782 if (wp == NULL)
7783 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007784 // quickfix list
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007785 qi->qf_curlist = 0;
7786 qi->qf_listcount = 0;
7787 }
Bram Moolenaaree8188f2019-02-05 21:23:04 +01007788 else if (qfwin != NULL)
Bram Moolenaar69f40be2017-04-02 15:15:49 +02007789 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007790 // If the location list window is open, then create a new empty
7791 // location list
Bram Moolenaar2d67d302018-11-16 18:46:02 +01007792 qf_info_T *new_ll = qf_alloc_stack(QFLT_LOCATION);
Bram Moolenaar99895ea2017-04-20 22:44:47 +02007793
Bram Moolenaar95946f12019-03-31 15:31:59 +02007794 if (new_ll != NULL)
7795 {
7796 new_ll->qf_bufnr = qfwin->w_buffer->b_fnum;
Bram Moolenaard788f6f2017-04-23 17:19:43 +02007797
Bram Moolenaar95946f12019-03-31 15:31:59 +02007798 // first free the list reference in the location list window
7799 ll_free_all(&qfwin->w_llist_ref);
7800
7801 qfwin->w_llist_ref = new_ll;
7802 if (wp != qfwin)
7803 win_set_loclist(wp, new_ll);
7804 }
Bram Moolenaar69f40be2017-04-02 15:15:49 +02007805 }
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007806}
7807
Bram Moolenaard823fa92016-08-12 16:29:27 +02007808/*
7809 * Populate the quickfix list with the items supplied in the list
7810 * of dictionaries. "title" will be copied to w:quickfix_title.
7811 * "action" is 'a' for add, 'r' for replace. Otherwise create a new list.
Bram Moolenaar90049492020-07-01 13:04:05 +02007812 * When "what" is not NULL then only set some properties.
Bram Moolenaard823fa92016-08-12 16:29:27 +02007813 */
7814 int
7815set_errorlist(
7816 win_T *wp,
7817 list_T *list,
7818 int action,
7819 char_u *title,
7820 dict_T *what)
7821{
7822 qf_info_T *qi = &ql_info;
7823 int retval = OK;
7824
7825 if (wp != NULL)
7826 {
7827 qi = ll_get_or_alloc_list(wp);
7828 if (qi == NULL)
7829 return FAIL;
7830 }
7831
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007832 if (action == 'f')
7833 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007834 // Free the entire quickfix or location list stack
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007835 qf_free_stack(wp, qi);
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02007836 return OK;
Bram Moolenaarb6fa30c2017-03-29 14:19:25 +02007837 }
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02007838
Bram Moolenaarbe7a50c2020-06-30 22:11:44 +02007839 // A dict argument cannot be specified with a non-empty list argument
Bram Moolenaar90049492020-07-01 13:04:05 +02007840 if (list->lv_len != 0 && what != NULL)
Bram Moolenaarbe7a50c2020-06-30 22:11:44 +02007841 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00007842 semsg(_(e_invalid_argument_str),
Bram Moolenaarbe7a50c2020-06-30 22:11:44 +02007843 _("cannot have both a list and a \"what\" argument"));
7844 return FAIL;
7845 }
7846
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02007847 incr_quickfix_busy();
7848
7849 if (what != NULL)
Bram Moolenaarae338332017-08-11 20:25:26 +02007850 retval = qf_set_properties(qi, what, action, title);
Bram Moolenaard823fa92016-08-12 16:29:27 +02007851 else
Bram Moolenaarb254af32017-12-18 19:48:58 +01007852 {
Bram Moolenaara3921f42017-06-04 15:30:34 +02007853 retval = qf_add_entries(qi, qi->qf_curlist, list, title, action);
Bram Moolenaarb254af32017-12-18 19:48:58 +01007854 if (retval == OK)
Bram Moolenaar4aa47b22019-03-13 06:51:53 +01007855 qf_list_changed(qf_get_curlist(qi));
Bram Moolenaarb254af32017-12-18 19:48:58 +01007856 }
Bram Moolenaard823fa92016-08-12 16:29:27 +02007857
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02007858 decr_quickfix_busy();
7859
Bram Moolenaard823fa92016-08-12 16:29:27 +02007860 return retval;
7861}
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007862
Tom Praschanca6ac992023-08-11 23:26:12 +02007863static int mark_quickfix_user_data(qf_info_T *qi, int copyID)
7864{
7865 int abort = FALSE;
7866 for (int i = 0; i < LISTCOUNT && !abort; ++i)
7867 {
7868 qf_list_T *qfl = &qi->qf_lists[i];
7869 if (!qfl->qf_has_user_data)
7870 continue;
7871 qfline_T *qfp;
7872 int j;
7873 FOR_ALL_QFL_ITEMS(qfl, qfp, j)
7874 {
7875 typval_T* user_data = &qfp->qf_user_data;
7876 if (user_data != NULL && user_data->v_type != VAR_NUMBER
7877 && user_data->v_type != VAR_STRING && user_data->v_type != VAR_FLOAT)
7878 abort = abort || set_ref_in_item(user_data, copyID, NULL, NULL);
7879 }
7880 }
7881 return abort;
7882}
7883
Bram Moolenaar18cebf42018-05-08 22:31:37 +02007884/*
Yegappan Lakshmanan6ae8fae2021-12-12 16:26:44 +00007885 * Mark the quickfix context and callback function as in use for all the lists
7886 * in a quickfix stack.
Bram Moolenaar18cebf42018-05-08 22:31:37 +02007887 */
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007888 static int
7889mark_quickfix_ctx(qf_info_T *qi, int copyID)
7890{
7891 int i;
7892 int abort = FALSE;
7893 typval_T *ctx;
Yegappan Lakshmanan6ae8fae2021-12-12 16:26:44 +00007894 callback_T *cb;
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007895
7896 for (i = 0; i < LISTCOUNT && !abort; ++i)
7897 {
7898 ctx = qi->qf_lists[i].qf_ctx;
Bram Moolenaar55b69262017-08-13 13:42:01 +02007899 if (ctx != NULL && ctx->v_type != VAR_NUMBER
7900 && ctx->v_type != VAR_STRING && ctx->v_type != VAR_FLOAT)
Yegappan Lakshmanan6ae8fae2021-12-12 16:26:44 +00007901 abort = abort || set_ref_in_item(ctx, copyID, NULL, NULL);
7902
=?UTF-8?q?Dundar=20G=C3=B6c?=b8366582022-04-14 20:43:56 +01007903 cb = &qi->qf_lists[i].qf_qftf_cb;
Yegappan Lakshmanan6ae8fae2021-12-12 16:26:44 +00007904 abort = abort || set_ref_in_callback(cb, copyID);
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007905 }
7906
7907 return abort;
7908}
7909
7910/*
7911 * Mark the context of the quickfix list and the location lists (if present) as
Bram Moolenaar353eeea2018-04-16 18:04:57 +02007912 * "in use". So that garbage collection doesn't free the context.
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007913 */
7914 int
7915set_ref_in_quickfix(int copyID)
7916{
7917 int abort = FALSE;
7918 tabpage_T *tp;
7919 win_T *win;
7920
7921 abort = mark_quickfix_ctx(&ql_info, copyID);
7922 if (abort)
7923 return abort;
7924
Tom Praschanca6ac992023-08-11 23:26:12 +02007925 abort = mark_quickfix_user_data(&ql_info, copyID);
7926 if (abort)
7927 return abort;
7928
Yegappan Lakshmanan6ae8fae2021-12-12 16:26:44 +00007929 abort = set_ref_in_callback(&qftf_cb, copyID);
7930 if (abort)
7931 return abort;
7932
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007933 FOR_ALL_TAB_WINDOWS(tp, win)
7934 {
7935 if (win->w_llist != NULL)
7936 {
7937 abort = mark_quickfix_ctx(win->w_llist, copyID);
7938 if (abort)
7939 return abort;
Tom Praschanca6ac992023-08-11 23:26:12 +02007940
7941 abort = mark_quickfix_user_data(win->w_llist, copyID);
7942 if (abort)
7943 return abort;
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007944 }
Bram Moolenaar12237442017-12-19 12:38:52 +01007945 if (IS_LL_WINDOW(win) && (win->w_llist_ref->qf_refcount == 1))
7946 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02007947 // In a location list window and none of the other windows is
7948 // referring to this location list. Mark the location list
7949 // context as still in use.
Bram Moolenaar12237442017-12-19 12:38:52 +01007950 abort = mark_quickfix_ctx(win->w_llist_ref, copyID);
7951 if (abort)
7952 return abort;
7953 }
Bram Moolenaar8f77c5a2017-04-30 14:21:00 +02007954 }
7955
7956 return abort;
7957}
Bram Moolenaar05159a02005-02-26 23:04:13 +00007958#endif
7959
Bram Moolenaar81695252004-12-29 20:58:21 +00007960/*
Bram Moolenaara16123a2019-03-28 20:31:07 +01007961 * Return the autocmd name for the :cbuffer Ex commands
7962 */
7963 static char_u *
7964cbuffer_get_auname(cmdidx_T cmdidx)
7965{
7966 switch (cmdidx)
7967 {
7968 case CMD_cbuffer: return (char_u *)"cbuffer";
7969 case CMD_cgetbuffer: return (char_u *)"cgetbuffer";
7970 case CMD_caddbuffer: return (char_u *)"caddbuffer";
7971 case CMD_lbuffer: return (char_u *)"lbuffer";
7972 case CMD_lgetbuffer: return (char_u *)"lgetbuffer";
7973 case CMD_laddbuffer: return (char_u *)"laddbuffer";
7974 default: return NULL;
7975 }
7976}
7977
7978/*
7979 * Process and validate the arguments passed to the :cbuffer, :caddbuffer,
7980 * :cgetbuffer, :lbuffer, :laddbuffer, :lgetbuffer Ex commands.
7981 */
7982 static int
7983cbuffer_process_args(
7984 exarg_T *eap,
7985 buf_T **bufp,
7986 linenr_T *line1,
7987 linenr_T *line2)
7988{
7989 buf_T *buf = NULL;
7990
7991 if (*eap->arg == NUL)
7992 buf = curbuf;
7993 else if (*skipwhite(skipdigits(eap->arg)) == NUL)
7994 buf = buflist_findnr(atoi((char *)eap->arg));
7995
7996 if (buf == NULL)
7997 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00007998 emsg(_(e_invalid_argument));
Bram Moolenaara16123a2019-03-28 20:31:07 +01007999 return FAIL;
8000 }
8001
8002 if (buf->b_ml.ml_mfp == NULL)
8003 {
Bram Moolenaara6f79292022-01-04 21:30:47 +00008004 emsg(_(e_buffer_is_not_loaded));
Bram Moolenaara16123a2019-03-28 20:31:07 +01008005 return FAIL;
8006 }
8007
8008 if (eap->addr_count == 0)
8009 {
8010 eap->line1 = 1;
8011 eap->line2 = buf->b_ml.ml_line_count;
8012 }
8013
8014 if (eap->line1 < 1 || eap->line1 > buf->b_ml.ml_line_count
8015 || eap->line2 < 1 || eap->line2 > buf->b_ml.ml_line_count)
8016 {
Bram Moolenaar108010a2021-06-27 22:03:33 +02008017 emsg(_(e_invalid_range));
Bram Moolenaara16123a2019-03-28 20:31:07 +01008018 return FAIL;
8019 }
8020
8021 *line1 = eap->line1;
8022 *line2 = eap->line2;
8023 *bufp = buf;
8024
8025 return OK;
8026}
8027
8028/*
Bram Moolenaar86b68352004-12-27 21:59:20 +00008029 * ":[range]cbuffer [bufnr]" command.
Bram Moolenaara6557602006-02-04 22:43:20 +00008030 * ":[range]caddbuffer [bufnr]" command.
Bram Moolenaardb552d602006-03-23 22:59:57 +00008031 * ":[range]cgetbuffer [bufnr]" command.
Bram Moolenaard12f5c12006-01-25 22:10:52 +00008032 * ":[range]lbuffer [bufnr]" command.
Bram Moolenaara6557602006-02-04 22:43:20 +00008033 * ":[range]laddbuffer [bufnr]" command.
Bram Moolenaardb552d602006-03-23 22:59:57 +00008034 * ":[range]lgetbuffer [bufnr]" command.
Bram Moolenaar86b68352004-12-27 21:59:20 +00008035 */
8036 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008037ex_cbuffer(exarg_T *eap)
Bram Moolenaar86b68352004-12-27 21:59:20 +00008038{
8039 buf_T *buf = NULL;
Bram Moolenaar87f59b02019-04-04 14:04:11 +02008040 qf_info_T *qi;
Bram Moolenaar04c4ce62016-09-01 15:45:58 +02008041 char_u *au_name = NULL;
Bram Moolenaar1ed22762017-11-28 18:03:44 +01008042 int res;
Bram Moolenaar531b9a32018-07-03 16:54:23 +02008043 int_u save_qfid;
8044 win_T *wp = NULL;
Bram Moolenaara16123a2019-03-28 20:31:07 +01008045 char_u *qf_title;
8046 linenr_T line1;
8047 linenr_T line2;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00008048
Bram Moolenaara16123a2019-03-28 20:31:07 +01008049 au_name = cbuffer_get_auname(eap->cmdidx);
Bram Moolenaar21662be2016-11-06 14:46:44 +01008050 if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
Bram Moolenaara16123a2019-03-28 20:31:07 +01008051 curbuf->b_fname, TRUE, curbuf))
Bram Moolenaar04c4ce62016-09-01 15:45:58 +02008052 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01008053#ifdef FEAT_EVAL
Bram Moolenaar21662be2016-11-06 14:46:44 +01008054 if (aborting())
Bram Moolenaar04c4ce62016-09-01 15:45:58 +02008055 return;
Bram Moolenaar04c4ce62016-09-01 15:45:58 +02008056#endif
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01008057 }
Bram Moolenaar04c4ce62016-09-01 15:45:58 +02008058
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008059 // Must come after autocommands.
Bram Moolenaar87f59b02019-04-04 14:04:11 +02008060 qi = qf_cmd_get_or_alloc_stack(eap, &wp);
8061 if (qi == NULL)
8062 return;
Bram Moolenaaraaf6e432017-12-19 16:41:14 +01008063
Bram Moolenaara16123a2019-03-28 20:31:07 +01008064 if (cbuffer_process_args(eap, &buf, &line1, &line2) == FAIL)
8065 return;
8066
8067 qf_title = qf_cmdtitle(*eap->cmdlinep);
8068
8069 if (buf->b_sfname)
Bram Moolenaar86b68352004-12-27 21:59:20 +00008070 {
Bram Moolenaara16123a2019-03-28 20:31:07 +01008071 vim_snprintf((char *)IObuff, IOSIZE, "%s (%s)",
8072 (char *)qf_title, (char *)buf->b_sfname);
8073 qf_title = IObuff;
Bram Moolenaar86b68352004-12-27 21:59:20 +00008074 }
Bram Moolenaara16123a2019-03-28 20:31:07 +01008075
8076 incr_quickfix_busy();
8077
8078 res = qf_init_ext(qi, qi->qf_curlist, NULL, buf, NULL, p_efm,
8079 (eap->cmdidx != CMD_caddbuffer
8080 && eap->cmdidx != CMD_laddbuffer),
8081 line1, line2,
8082 qf_title, NULL);
8083 if (qf_stack_empty(qi))
8084 {
8085 decr_quickfix_busy();
8086 return;
8087 }
8088 if (res >= 0)
8089 qf_list_changed(qf_get_curlist(qi));
8090
8091 // Remember the current quickfix list identifier, so that we can
8092 // check for autocommands changing the current quickfix list.
8093 save_qfid = qf_get_curlist(qi)->qf_id;
8094 if (au_name != NULL)
8095 {
8096 buf_T *curbuf_old = curbuf;
8097
8098 apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name, curbuf->b_fname,
8099 TRUE, curbuf);
8100 if (curbuf != curbuf_old)
8101 // Autocommands changed buffer, don't jump now, "qi" may
8102 // be invalid.
8103 res = 0;
8104 }
8105 // Jump to the first error for a new list and if autocmds didn't
8106 // free the list.
8107 if (res > 0 && (eap->cmdidx == CMD_cbuffer ||
8108 eap->cmdidx == CMD_lbuffer)
8109 && qflist_valid(wp, save_qfid))
8110 // display the first error
8111 qf_jump_first(qi, save_qfid, eap->forceit);
8112
8113 decr_quickfix_busy();
Bram Moolenaar86b68352004-12-27 21:59:20 +00008114}
8115
Bram Moolenaar1e015462005-09-25 22:16:38 +00008116#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar86b68352004-12-27 21:59:20 +00008117/*
Bram Moolenaara16123a2019-03-28 20:31:07 +01008118 * Return the autocmd name for the :cexpr Ex commands.
8119 */
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02008120 char_u *
Bram Moolenaara16123a2019-03-28 20:31:07 +01008121cexpr_get_auname(cmdidx_T cmdidx)
8122{
8123 switch (cmdidx)
8124 {
8125 case CMD_cexpr: return (char_u *)"cexpr";
8126 case CMD_cgetexpr: return (char_u *)"cgetexpr";
8127 case CMD_caddexpr: return (char_u *)"caddexpr";
8128 case CMD_lexpr: return (char_u *)"lexpr";
8129 case CMD_lgetexpr: return (char_u *)"lgetexpr";
8130 case CMD_laddexpr: return (char_u *)"laddexpr";
8131 default: return NULL;
8132 }
8133}
8134
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02008135 int
8136trigger_cexpr_autocmd(int cmdidx)
8137{
8138 char_u *au_name = cexpr_get_auname(cmdidx);
8139
8140 if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
8141 curbuf->b_fname, TRUE, curbuf))
8142 {
8143 if (aborting())
8144 return FAIL;
8145 }
8146 return OK;
8147}
8148
8149 int
8150cexpr_core(exarg_T *eap, typval_T *tv)
8151{
8152 qf_info_T *qi;
8153 win_T *wp = NULL;
8154
8155 qi = qf_cmd_get_or_alloc_stack(eap, &wp);
8156 if (qi == NULL)
8157 return FAIL;
8158
8159 if ((tv->v_type == VAR_STRING && tv->vval.v_string != NULL)
8160 || (tv->v_type == VAR_LIST && tv->vval.v_list != NULL))
8161 {
8162 int res;
8163 int_u save_qfid;
8164 char_u *au_name = cexpr_get_auname(eap->cmdidx);
8165
8166 incr_quickfix_busy();
8167 res = qf_init_ext(qi, qi->qf_curlist, NULL, NULL, tv, p_efm,
8168 (eap->cmdidx != CMD_caddexpr
8169 && eap->cmdidx != CMD_laddexpr),
8170 (linenr_T)0, (linenr_T)0,
8171 qf_cmdtitle(*eap->cmdlinep), NULL);
8172 if (qf_stack_empty(qi))
8173 {
8174 decr_quickfix_busy();
8175 return FAIL;
8176 }
8177 if (res >= 0)
8178 qf_list_changed(qf_get_curlist(qi));
8179
8180 // Remember the current quickfix list identifier, so that we can
8181 // check for autocommands changing the current quickfix list.
8182 save_qfid = qf_get_curlist(qi)->qf_id;
8183 if (au_name != NULL)
8184 apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
8185 curbuf->b_fname, TRUE, curbuf);
8186
8187 // Jump to the first error for a new list and if autocmds didn't
8188 // free the list.
8189 if (res > 0 && (eap->cmdidx == CMD_cexpr || eap->cmdidx == CMD_lexpr)
8190 && qflist_valid(wp, save_qfid))
8191 // display the first error
8192 qf_jump_first(qi, save_qfid, eap->forceit);
8193 decr_quickfix_busy();
8194 return OK;
8195 }
8196
Bram Moolenaar677658a2022-01-05 16:09:06 +00008197 emsg(_(e_string_or_list_expected));
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02008198 return FAIL;
8199}
8200
Bram Moolenaara16123a2019-03-28 20:31:07 +01008201/*
Bram Moolenaardb552d602006-03-23 22:59:57 +00008202 * ":cexpr {expr}", ":cgetexpr {expr}", ":caddexpr {expr}" command.
8203 * ":lexpr {expr}", ":lgetexpr {expr}", ":laddexpr {expr}" command.
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02008204 * Also: ":caddexpr", ":cgetexpr", "laddexpr" and "laddexpr".
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00008205 */
8206 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008207ex_cexpr(exarg_T *eap)
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00008208{
8209 typval_T *tv;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00008210
Bram Moolenaar5f7d4c02021-05-05 21:31:39 +02008211 if (trigger_cexpr_autocmd(eap->cmdidx) == FAIL)
Bram Moolenaar87f59b02019-04-04 14:04:11 +02008212 return;
Bram Moolenaar3c097222017-12-21 20:54:49 +01008213
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008214 // Evaluate the expression. When the result is a string or a list we can
8215 // use it to fill the errorlist.
Bram Moolenaarb171fb12020-06-24 20:34:03 +02008216 tv = eval_expr(eap->arg, eap);
Yegappan Lakshmananf97a2952023-01-18 18:17:48 +00008217 if (tv == NULL)
8218 return;
8219
8220 (void)cexpr_core(eap, tv);
8221 free_tv(tv);
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00008222}
Bram Moolenaar1e015462005-09-25 22:16:38 +00008223#endif
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00008224
8225/*
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008226 * Get the location list for ":lhelpgrep"
8227 */
8228 static qf_info_T *
8229hgr_get_ll(int *new_ll)
8230{
8231 win_T *wp;
8232 qf_info_T *qi;
8233
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008234 // If the current window is a help window, then use it
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008235 if (bt_help(curwin->w_buffer))
8236 wp = curwin;
8237 else
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008238 // Find an existing help window
Bram Moolenaar7a2b0e52018-05-10 18:55:28 +02008239 wp = qf_find_help_win();
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008240
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008241 if (wp == NULL) // Help window not found
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008242 qi = NULL;
8243 else
8244 qi = wp->w_llist;
8245
8246 if (qi == NULL)
8247 {
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008248 // Allocate a new location list for help text matches
Bram Moolenaar2d67d302018-11-16 18:46:02 +01008249 if ((qi = qf_alloc_stack(QFLT_LOCATION)) == NULL)
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008250 return NULL;
8251 *new_ll = TRUE;
8252 }
8253
8254 return qi;
8255}
8256
8257/*
8258 * Search for a pattern in a help file.
8259 */
8260 static void
8261hgr_search_file(
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01008262 qf_list_T *qfl,
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008263 char_u *fname,
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008264 vimconv_T *p_vc,
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008265 regmatch_T *p_regmatch)
8266{
8267 FILE *fd;
8268 long lnum;
8269
8270 fd = mch_fopen((char *)fname, "r");
8271 if (fd == NULL)
8272 return;
8273
8274 lnum = 1;
8275 while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int)
8276 {
8277 char_u *line = IObuff;
Bram Moolenaara12a1612019-01-24 16:39:02 +01008278
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008279 // Convert a line if 'encoding' is not utf-8 and
8280 // the line contains a non-ASCII character.
Yegappan Lakshmanandf1bbea2022-03-05 14:35:12 +00008281 if (p_vc->vc_type != CONV_NONE && has_non_ascii(IObuff))
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008282 {
8283 line = string_convert(p_vc, IObuff, NULL);
8284 if (line == NULL)
8285 line = IObuff;
8286 }
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008287
8288 if (vim_regexec(p_regmatch, line, (colnr_T)0))
8289 {
8290 int l = (int)STRLEN(line);
8291
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008292 // remove trailing CR, LF, spaces, etc.
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008293 while (l > 0 && line[l - 1] <= ' ')
8294 line[--l] = NUL;
8295
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01008296 if (qf_add_entry(qfl,
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008297 NULL, // dir
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008298 fname,
Bram Moolenaard76ce852018-05-01 15:02:04 +02008299 NULL,
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008300 0,
8301 line,
8302 lnum,
thinca6864efa2021-06-19 20:45:20 +02008303 0,
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008304 (int)(p_regmatch->startp[0] - line)
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008305 + 1, // col
thinca6864efa2021-06-19 20:45:20 +02008306 (int)(p_regmatch->endp[0] - line)
8307 + 1, // end_col
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008308 FALSE, // vis_col
8309 NULL, // search pattern
8310 0, // nr
8311 1, // type
Tom Praschanca6ac992023-08-11 23:26:12 +02008312 NULL, // user_data
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008313 TRUE // valid
Bram Moolenaar95946f12019-03-31 15:31:59 +02008314 ) == QF_FAIL)
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008315 {
8316 got_int = TRUE;
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008317 if (line != IObuff)
8318 vim_free(line);
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008319 break;
8320 }
8321 }
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008322 if (line != IObuff)
8323 vim_free(line);
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008324 ++lnum;
8325 line_breakcheck();
8326 }
8327 fclose(fd);
8328}
8329
8330/*
8331 * Search for a pattern in all the help files in the doc directory under
8332 * the given directory.
8333 */
8334 static void
8335hgr_search_files_in_dir(
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01008336 qf_list_T *qfl,
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008337 char_u *dirname,
Bram Moolenaara12a1612019-01-24 16:39:02 +01008338 regmatch_T *p_regmatch,
8339 vimconv_T *p_vc
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008340#ifdef FEAT_MULTI_LANG
8341 , char_u *lang
8342#endif
8343 )
8344{
8345 int fcount;
8346 char_u **fnames;
8347 int fi;
8348
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008349 // Find all "*.txt" and "*.??x" files in the "doc" directory.
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008350 add_pathsep(dirname);
8351 STRCAT(dirname, "doc/*.\\(txt\\|??x\\)");
8352 if (gen_expand_wildcards(1, &dirname, &fcount,
8353 &fnames, EW_FILE|EW_SILENT) == OK
8354 && fcount > 0)
8355 {
8356 for (fi = 0; fi < fcount && !got_int; ++fi)
8357 {
8358#ifdef FEAT_MULTI_LANG
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008359 // Skip files for a different language.
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008360 if (lang != NULL
8361 && STRNICMP(lang, fnames[fi]
Bram Moolenaard76ce852018-05-01 15:02:04 +02008362 + STRLEN(fnames[fi]) - 3, 2) != 0
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008363 && !(STRNICMP(lang, "en", 2) == 0
8364 && STRNICMP("txt", fnames[fi]
8365 + STRLEN(fnames[fi]) - 3, 3) == 0))
8366 continue;
8367#endif
8368
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01008369 hgr_search_file(qfl, fnames[fi], p_vc, p_regmatch);
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008370 }
8371 FreeWild(fcount, fnames);
8372 }
8373}
8374
8375/*
Bram Moolenaar18cebf42018-05-08 22:31:37 +02008376 * Search for a pattern in all the help files in the 'runtimepath'
8377 * and add the matches to a quickfix list.
Bram Moolenaarc631f2d2018-08-21 21:58:13 +02008378 * 'lang' is the language specifier. If supplied, then only matches in the
Bram Moolenaar18cebf42018-05-08 22:31:37 +02008379 * specified language are found.
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008380 */
8381 static void
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01008382hgr_search_in_rtp(qf_list_T *qfl, regmatch_T *p_regmatch, char_u *lang)
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008383{
8384 char_u *p;
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008385
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008386 vimconv_T vc;
8387
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008388 // Help files are in utf-8 or latin1, convert lines when 'encoding'
8389 // differs.
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008390 vc.vc_type = CONV_NONE;
8391 if (!enc_utf8)
8392 convert_setup(&vc, (char_u *)"utf-8", p_enc);
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008393
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008394 // Go through all the directories in 'runtimepath'
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008395 p = p_rtp;
8396 while (*p != NUL && !got_int)
8397 {
8398 copy_option_part(&p, NameBuff, MAXPATHL, ",");
8399
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01008400 hgr_search_files_in_dir(qfl, NameBuff, p_regmatch, &vc
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008401#ifdef FEAT_MULTI_LANG
8402 , lang
8403#endif
8404 );
8405 }
8406
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008407 if (vc.vc_type != CONV_NONE)
8408 convert_setup(&vc, NULL, NULL);
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008409}
8410
8411/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008412 * ":helpgrep {pattern}"
8413 */
8414 void
Bram Moolenaar05540972016-01-30 20:31:25 +01008415ex_helpgrep(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416{
8417 regmatch_T regmatch;
8418 char_u *save_cpo;
Bram Moolenaar4791fcd2022-02-23 12:06:00 +00008419 int save_cpo_allocated;
Bram Moolenaard12f5c12006-01-25 22:10:52 +00008420 qf_info_T *qi = &ql_info;
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00008421 int new_qi = FALSE;
Bram Moolenaar73633f82012-01-20 13:39:07 +01008422 char_u *au_name = NULL;
Bram Moolenaarc631f2d2018-08-21 21:58:13 +02008423 char_u *lang = NULL;
Bram Moolenaare5a2dc82021-01-03 19:52:05 +01008424 int updated = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425
Bram Moolenaar73633f82012-01-20 13:39:07 +01008426 switch (eap->cmdidx)
8427 {
8428 case CMD_helpgrep: au_name = (char_u *)"helpgrep"; break;
8429 case CMD_lhelpgrep: au_name = (char_u *)"lhelpgrep"; break;
8430 default: break;
8431 }
Bram Moolenaar21662be2016-11-06 14:46:44 +01008432 if (au_name != NULL && apply_autocmds(EVENT_QUICKFIXCMDPRE, au_name,
8433 curbuf->b_fname, TRUE, curbuf))
Bram Moolenaar73633f82012-01-20 13:39:07 +01008434 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01008435#ifdef FEAT_EVAL
Bram Moolenaar21662be2016-11-06 14:46:44 +01008436 if (aborting())
Bram Moolenaar73633f82012-01-20 13:39:07 +01008437 return;
Bram Moolenaar73633f82012-01-20 13:39:07 +01008438#endif
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01008439 }
Bram Moolenaar73633f82012-01-20 13:39:07 +01008440
Bram Moolenaar39665952018-08-15 20:59:48 +02008441 if (is_loclist_cmd(eap->cmdidx))
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00008442 {
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008443 qi = hgr_get_ll(&new_qi);
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00008444 if (qi == NULL)
Bram Moolenaar2225ebb2018-04-24 15:48:11 +02008445 return;
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00008446 }
8447
Bram Moolenaara16123a2019-03-28 20:31:07 +01008448 // Make 'cpoptions' empty, the 'l' flag should not be used here.
8449 save_cpo = p_cpo;
Bram Moolenaar4791fcd2022-02-23 12:06:00 +00008450 save_cpo_allocated = is_option_allocated("cpo");
Bram Moolenaara16123a2019-03-28 20:31:07 +01008451 p_cpo = empty_option;
8452
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02008453 incr_quickfix_busy();
8454
Bram Moolenaarc631f2d2018-08-21 21:58:13 +02008455#ifdef FEAT_MULTI_LANG
8456 // Check for a specified language
8457 lang = check_help_lang(eap->arg);
8458#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459 regmatch.regprog = vim_regcomp(eap->arg, RE_MAGIC + RE_STRING);
8460 regmatch.rm_ic = FALSE;
8461 if (regmatch.regprog != NULL)
8462 {
Bram Moolenaar108e7b42018-10-11 17:39:12 +02008463 qf_list_T *qfl;
8464
Bram Moolenaarc631f2d2018-08-21 21:58:13 +02008465 // create a new quickfix list
Bram Moolenaar8b62e312018-05-13 15:29:04 +02008466 qf_new_list(qi, qf_cmdtitle(*eap->cmdlinep));
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01008467 qfl = qf_get_curlist(qi);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008468
Bram Moolenaar9afe5e92019-03-22 14:16:06 +01008469 hgr_search_in_rtp(qfl, &regmatch, lang);
Bram Moolenaar10b7b392012-01-10 16:28:45 +01008470
Bram Moolenaar473de612013-06-08 18:19:48 +02008471 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472
Bram Moolenaar108e7b42018-10-11 17:39:12 +02008473 qfl->qf_nonevalid = FALSE;
8474 qfl->qf_ptr = qfl->qf_start;
8475 qfl->qf_index = 1;
8476 qf_list_changed(qfl);
Bram Moolenaare5a2dc82021-01-03 19:52:05 +01008477 updated = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00008478 }
8479
Bram Moolenaar9c24ccc2008-07-14 21:05:15 +00008480 if (p_cpo == empty_option)
8481 p_cpo = save_cpo;
8482 else
Bram Moolenaare5a2dc82021-01-03 19:52:05 +01008483 {
8484 // Darn, some plugin changed the value. If it's still empty it was
8485 // changed and restored, need to restore in the complicated way.
8486 if (*p_cpo == NUL)
Bram Moolenaar31e5c602022-04-15 13:53:33 +01008487 set_option_value_give_err((char_u *)"cpo", 0L, save_cpo, 0);
Bram Moolenaar4791fcd2022-02-23 12:06:00 +00008488 if (save_cpo_allocated)
8489 free_string_option(save_cpo);
Bram Moolenaare5a2dc82021-01-03 19:52:05 +01008490 }
8491
8492 if (updated)
8493 // This may open a window and source scripts, do this after 'cpo' was
8494 // restored.
8495 qf_update_buffer(qi, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00008496
Bram Moolenaar73633f82012-01-20 13:39:07 +01008497 if (au_name != NULL)
8498 {
8499 apply_autocmds(EVENT_QUICKFIXCMDPOST, au_name,
8500 curbuf->b_fname, TRUE, curbuf);
Bram Moolenaarec98e932020-06-08 19:35:59 +02008501 // When adding a location list to an existing location list stack,
8502 // if the autocmd made the stack invalid, then just return.
8503 if (!new_qi && IS_LL_STACK(qi) && qf_find_win_with_loclist(qi) == NULL)
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02008504 {
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02008505 decr_quickfix_busy();
Bram Moolenaar73633f82012-01-20 13:39:07 +01008506 return;
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02008507 }
Bram Moolenaar73633f82012-01-20 13:39:07 +01008508 }
Bram Moolenaar73633f82012-01-20 13:39:07 +01008509
Bram Moolenaar00bf8cd2018-10-07 20:26:20 +02008510 // Jump to first match.
Bram Moolenaar0398e002019-03-21 21:12:49 +01008511 if (!qf_list_empty(qf_get_curlist(qi)))
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00008512 qf_jump(qi, 0, 0, FALSE);
Bram Moolenaar69a7cb42004-06-20 12:51:53 +00008513 else
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00008514 semsg(_(e_no_match_str_2), eap->arg);
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00008515
Bram Moolenaar9f84ded2018-10-20 20:54:02 +02008516 decr_quickfix_busy();
8517
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00008518 if (eap->cmdidx == CMD_lhelpgrep)
8519 {
Bram Moolenaarc631f2d2018-08-21 21:58:13 +02008520 // If the help window is not opened or if it already points to the
8521 // correct location list, then free the new location list.
Bram Moolenaard28cc3f2017-07-27 22:03:50 +02008522 if (!bt_help(curwin->w_buffer) || curwin->w_llist == qi)
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00008523 {
8524 if (new_qi)
8525 ll_free_all(&qi);
8526 }
Yegappan Lakshmanan9c9be052022-02-24 12:33:17 +00008527 else if (curwin->w_llist == NULL && new_qi)
8528 // current window didn't have a location list associated with it
8529 // before. Associate the new location list now.
Bram Moolenaar8b6144b2006-02-08 09:20:24 +00008530 curwin->w_llist = qi;
8531 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532}
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01008533
8534# if defined(EXITFREE) || defined(PROTO)
8535 void
Yegappan Lakshmanana23a11b2023-02-21 14:27:41 +00008536free_quickfix(void)
Yegappan Lakshmanan975a6652022-10-14 13:11:13 +01008537{
8538 win_T *win;
8539 tabpage_T *tab;
8540
8541 qf_free_all(NULL);
8542 // Free all location lists
8543 FOR_ALL_TAB_WINDOWS(tab, win)
8544 qf_free_all(win);
8545
8546 ga_clear(&qfga);
8547}
8548# endif
8549
Bram Moolenaar63d9e732019-12-05 21:10:38 +01008550#endif // FEAT_QUICKFIX
Bram Moolenaare677df82019-09-02 22:31:11 +02008551
8552#if defined(FEAT_EVAL) || defined(PROTO)
8553# ifdef FEAT_QUICKFIX
8554 static void
8555get_qf_loc_list(int is_qf, win_T *wp, typval_T *what_arg, typval_T *rettv)
8556{
8557 if (what_arg->v_type == VAR_UNKNOWN)
8558 {
8559 if (rettv_list_alloc(rettv) == OK)
8560 if (is_qf || wp != NULL)
Bram Moolenaar858ba062020-05-31 23:11:59 +02008561 (void)get_errorlist(NULL, wp, -1, 0, rettv->vval.v_list);
Bram Moolenaare677df82019-09-02 22:31:11 +02008562 }
8563 else
8564 {
8565 if (rettv_dict_alloc(rettv) == OK)
8566 if (is_qf || (wp != NULL))
8567 {
8568 if (what_arg->v_type == VAR_DICT)
8569 {
8570 dict_T *d = what_arg->vval.v_dict;
8571
8572 if (d != NULL)
8573 qf_get_properties(wp, d, rettv->vval.v_dict);
8574 }
8575 else
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00008576 emsg(_(e_dictionary_required));
Bram Moolenaare677df82019-09-02 22:31:11 +02008577 }
8578 }
8579}
8580# endif
8581
8582/*
8583 * "getloclist()" function
8584 */
8585 void
8586f_getloclist(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
8587{
8588# ifdef FEAT_QUICKFIX
8589 win_T *wp;
8590
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02008591 if (in_vim9script()
8592 && (check_for_number_arg(argvars, 0) == FAIL
8593 || check_for_opt_dict_arg(argvars, 1) == FAIL))
8594 return;
8595
Bram Moolenaare677df82019-09-02 22:31:11 +02008596 wp = find_win_by_nr_or_id(&argvars[0]);
8597 get_qf_loc_list(FALSE, wp, &argvars[1], rettv);
8598# endif
8599}
8600
8601/*
8602 * "getqflist()" function
8603 */
8604 void
8605f_getqflist(typval_T *argvars UNUSED, typval_T *rettv UNUSED)
8606{
8607# ifdef FEAT_QUICKFIX
Yegappan Lakshmanan4490ec42021-07-27 22:00:44 +02008608 if (in_vim9script() && check_for_opt_dict_arg(argvars, 0) == FAIL)
8609 return;
8610
Bram Moolenaare677df82019-09-02 22:31:11 +02008611 get_qf_loc_list(TRUE, NULL, &argvars[0], rettv);
8612# endif
8613}
8614
8615/*
8616 * Used by "setqflist()" and "setloclist()" functions
8617 */
8618 static void
8619set_qf_ll_list(
8620 win_T *wp UNUSED,
8621 typval_T *list_arg UNUSED,
8622 typval_T *action_arg UNUSED,
8623 typval_T *what_arg UNUSED,
8624 typval_T *rettv)
8625{
8626# ifdef FEAT_QUICKFIX
Bram Moolenaare677df82019-09-02 22:31:11 +02008627 char_u *act;
8628 int action = 0;
8629 static int recursive = 0;
8630# endif
8631
8632 rettv->vval.v_number = -1;
8633
8634# ifdef FEAT_QUICKFIX
8635 if (list_arg->v_type != VAR_LIST)
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00008636 emsg(_(e_list_required));
Bram Moolenaare677df82019-09-02 22:31:11 +02008637 else if (recursive != 0)
Bram Moolenaar74409f62022-01-01 15:58:22 +00008638 emsg(_(e_autocommand_caused_recursive_behavior));
Bram Moolenaare677df82019-09-02 22:31:11 +02008639 else
8640 {
8641 list_T *l = list_arg->vval.v_list;
Bram Moolenaar90049492020-07-01 13:04:05 +02008642 dict_T *what = NULL;
Bram Moolenaare677df82019-09-02 22:31:11 +02008643 int valid_dict = TRUE;
8644
8645 if (action_arg->v_type == VAR_STRING)
8646 {
8647 act = tv_get_string_chk(action_arg);
8648 if (act == NULL)
8649 return; // type error; errmsg already given
8650 if ((*act == 'a' || *act == 'r' || *act == ' ' || *act == 'f') &&
8651 act[1] == NUL)
8652 action = *act;
8653 else
Bram Moolenaard82a47d2022-01-05 20:24:39 +00008654 semsg(_(e_invalid_action_str_1), act);
Bram Moolenaare677df82019-09-02 22:31:11 +02008655 }
8656 else if (action_arg->v_type == VAR_UNKNOWN)
8657 action = ' ';
8658 else
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00008659 emsg(_(e_string_required));
Bram Moolenaare677df82019-09-02 22:31:11 +02008660
8661 if (action_arg->v_type != VAR_UNKNOWN
8662 && what_arg->v_type != VAR_UNKNOWN)
8663 {
Bram Moolenaar90049492020-07-01 13:04:05 +02008664 if (what_arg->v_type == VAR_DICT && what_arg->vval.v_dict != NULL)
8665 what = what_arg->vval.v_dict;
Bram Moolenaare677df82019-09-02 22:31:11 +02008666 else
8667 {
Bram Moolenaar460ae5d2022-01-01 14:19:49 +00008668 emsg(_(e_dictionary_required));
Bram Moolenaare677df82019-09-02 22:31:11 +02008669 valid_dict = FALSE;
8670 }
8671 }
8672
8673 ++recursive;
Bram Moolenaar90049492020-07-01 13:04:05 +02008674 if (l != NULL && action && valid_dict
8675 && set_errorlist(wp, l, action,
Bram Moolenaare677df82019-09-02 22:31:11 +02008676 (char_u *)(wp == NULL ? ":setqflist()" : ":setloclist()"),
Bram Moolenaar90049492020-07-01 13:04:05 +02008677 what) == OK)
Bram Moolenaare677df82019-09-02 22:31:11 +02008678 rettv->vval.v_number = 0;
8679 --recursive;
8680 }
8681# endif
8682}
8683
8684/*
8685 * "setloclist()" function
8686 */
8687 void
8688f_setloclist(typval_T *argvars, typval_T *rettv)
8689{
8690 win_T *win;
8691
8692 rettv->vval.v_number = -1;
8693
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02008694 if (in_vim9script()
8695 && (check_for_number_arg(argvars, 0) == FAIL
8696 || check_for_list_arg(argvars, 1) == FAIL
8697 || check_for_opt_string_arg(argvars, 2) == FAIL
8698 || (argvars[2].v_type != VAR_UNKNOWN
8699 && check_for_opt_dict_arg(argvars, 3) == FAIL)))
8700 return;
8701
Bram Moolenaare677df82019-09-02 22:31:11 +02008702 win = find_win_by_nr_or_id(&argvars[0]);
8703 if (win != NULL)
8704 set_qf_ll_list(win, &argvars[1], &argvars[2], &argvars[3], rettv);
8705}
8706
8707/*
8708 * "setqflist()" function
8709 */
8710 void
8711f_setqflist(typval_T *argvars, typval_T *rettv)
8712{
Yegappan Lakshmanan83494b42021-07-20 17:51:51 +02008713 if (in_vim9script()
8714 && (check_for_list_arg(argvars, 0) == FAIL
8715 || check_for_opt_string_arg(argvars, 1) == FAIL
8716 || (argvars[1].v_type != VAR_UNKNOWN
8717 && check_for_opt_dict_arg(argvars, 2) == FAIL)))
8718 return;
8719
Bram Moolenaare677df82019-09-02 22:31:11 +02008720 set_qf_ll_list(NULL, &argvars[0], &argvars[1], &argvars[2], rettv);
8721}
8722#endif