blob: c6a6dbe14db8b7279046030ad322502e68d9b53b [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 * ex_cmds2.c: some more functions for command line commands
12 */
13
Bram Moolenaar071d4272004-06-13 20:20:40 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010017static void cmd_source(char_u *fname, exarg_T *eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +000018
Bram Moolenaar05159a02005-02-26 23:04:13 +000019#ifdef FEAT_EVAL
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000020/* Growarray to store info about already sourced scripts.
Bram Moolenaar05159a02005-02-26 23:04:13 +000021 * For Unix also store the dev/ino, so that we don't have to stat() each
22 * script when going through the list. */
23typedef struct scriptitem_S
24{
25 char_u *sn_name;
26# ifdef UNIX
Bram Moolenaarbf0c4522009-05-16 19:16:33 +000027 int sn_dev_valid;
28 dev_t sn_dev;
Bram Moolenaar05159a02005-02-26 23:04:13 +000029 ino_t sn_ino;
30# endif
31# ifdef FEAT_PROFILE
32 int sn_prof_on; /* TRUE when script is/was profiled */
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000033 int sn_pr_force; /* forceit: profile functions in this script */
Bram Moolenaar05159a02005-02-26 23:04:13 +000034 proftime_T sn_pr_child; /* time set when going into first child */
35 int sn_pr_nest; /* nesting for sn_pr_child */
36 /* profiling the script as a whole */
37 int sn_pr_count; /* nr of times sourced */
Bram Moolenaar8c8de832008-06-24 22:58:06 +000038 proftime_T sn_pr_total; /* time spent in script + children */
39 proftime_T sn_pr_self; /* time spent in script itself */
Bram Moolenaar05159a02005-02-26 23:04:13 +000040 proftime_T sn_pr_start; /* time at script start */
41 proftime_T sn_pr_children; /* time in children after script start */
42 /* profiling the script per line */
43 garray_T sn_prl_ga; /* things stored for every line */
44 proftime_T sn_prl_start; /* start time for current line */
45 proftime_T sn_prl_children; /* time spent in children for this line */
46 proftime_T sn_prl_wait; /* wait start time for current line */
47 int sn_prl_idx; /* index of line being timed; -1 if none */
48 int sn_prl_execed; /* line being timed was executed */
49# endif
50} scriptitem_T;
51
52static garray_T script_items = {0, 0, sizeof(scriptitem_T), 4, NULL};
53#define SCRIPT_ITEM(id) (((scriptitem_T *)script_items.ga_data)[(id) - 1])
54
55# ifdef FEAT_PROFILE
56/* Struct used in sn_prl_ga for every line of a script. */
57typedef struct sn_prl_S
58{
59 int snp_count; /* nr of times line was executed */
Bram Moolenaar8c8de832008-06-24 22:58:06 +000060 proftime_T sn_prl_total; /* time spent in a line + children */
61 proftime_T sn_prl_self; /* time spent in a line itself */
Bram Moolenaar05159a02005-02-26 23:04:13 +000062} sn_prl_T;
63
64# define PRL_ITEM(si, idx) (((sn_prl_T *)(si)->sn_prl_ga.ga_data)[(idx)])
65# endif
66#endif
67
Bram Moolenaar071d4272004-06-13 20:20:40 +000068#if defined(FEAT_EVAL) || defined(PROTO)
69static int debug_greedy = FALSE; /* batch mode debugging: don't save
70 and restore typeahead. */
Bram Moolenaarf1f60f82016-01-16 15:40:53 +010071static int get_maxbacktrace_level(void);
72static void do_setdebugtracelevel(char_u *arg);
73static void do_checkbacktracelevel(void);
74static void do_showbacktrace(char_u *cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +000075
76/*
77 * do_debug(): Debug mode.
78 * Repeatedly get Ex commands, until told to continue normal execution.
79 */
80 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010081do_debug(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +000082{
83 int save_msg_scroll = msg_scroll;
84 int save_State = State;
85 int save_did_emsg = did_emsg;
86 int save_cmd_silent = cmd_silent;
87 int save_msg_silent = msg_silent;
88 int save_emsg_silent = emsg_silent;
89 int save_redir_off = redir_off;
90 tasave_T typeaheadbuf;
Bram Moolenaaree3f7a52008-01-01 13:17:56 +000091 int typeahead_saved = FALSE;
Bram Moolenaar383c6f52008-01-04 15:01:07 +000092 int save_ignore_script = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000093 int save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 int n;
95 char_u *cmdline = NULL;
96 char_u *p;
97 char *tail = NULL;
98 static int last_cmd = 0;
99#define CMD_CONT 1
100#define CMD_NEXT 2
101#define CMD_STEP 3
102#define CMD_FINISH 4
103#define CMD_QUIT 5
104#define CMD_INTERRUPT 6
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100105#define CMD_BACKTRACE 7
106#define CMD_FRAME 8
107#define CMD_UP 9
108#define CMD_DOWN 10
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110#ifdef ALWAYS_USE_GUI
111 /* Can't do this when there is no terminal for input/output. */
112 if (!gui.in_use)
113 {
114 /* Break as soon as possible. */
115 debug_break_level = 9999;
116 return;
117 }
118#endif
119
120 /* Make sure we are in raw mode and start termcap mode. Might have side
121 * effects... */
122 settmode(TMODE_RAW);
123 starttermcap();
124
125 ++RedrawingDisabled; /* don't redisplay the window */
126 ++no_wait_return; /* don't wait for return */
127 did_emsg = FALSE; /* don't use error from debugged stuff */
128 cmd_silent = FALSE; /* display commands */
129 msg_silent = FALSE; /* display messages */
130 emsg_silent = FALSE; /* display error messages */
131 redir_off = TRUE; /* don't redirect debug commands */
132
133 State = NORMAL;
Bram Moolenaard99388b2017-10-26 14:28:32 +0200134 debug_mode = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000135
136 if (!debug_did_msg)
137 MSG(_("Entering Debug mode. Type \"cont\" to continue."));
138 if (sourcing_name != NULL)
139 msg(sourcing_name);
140 if (sourcing_lnum != 0)
Bram Moolenaar555b2802005-05-19 21:08:39 +0000141 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000142 else
Bram Moolenaar555b2802005-05-19 21:08:39 +0000143 smsg((char_u *)_("cmd: %s"), cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144
145 /*
146 * Repeat getting a command and executing it.
147 */
148 for (;;)
149 {
150 msg_scroll = TRUE;
151 need_wait_return = FALSE;
Bram Moolenaar85b11762016-02-27 18:13:23 +0100152
Bram Moolenaar071d4272004-06-13 20:20:40 +0000153 /* Save the current typeahead buffer and replace it with an empty one.
154 * This makes sure we get input from the user here and don't interfere
155 * with the commands being executed. Reset "ex_normal_busy" to avoid
156 * the side effects of using ":normal". Save the stuff buffer and make
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000157 * it empty. Set ignore_script to avoid reading from script input. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158 save_ex_normal_busy = ex_normal_busy;
159 ex_normal_busy = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160 if (!debug_greedy)
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000161 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000162 save_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000163 typeahead_saved = TRUE;
164 save_ignore_script = ignore_script;
165 ignore_script = TRUE;
166 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000167
Bram Moolenaardc303bc2016-05-17 17:45:38 +0200168 vim_free(cmdline);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000169 cmdline = getcmdline_prompt('>', NULL, 0, EXPAND_NOTHING, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000171 if (typeahead_saved)
172 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173 restore_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000174 ignore_script = save_ignore_script;
175 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176 ex_normal_busy = save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000177
178 cmdline_row = msg_row;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100179 msg_starthere();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000180 if (cmdline != NULL)
181 {
182 /* If this is a debug command, set "last_cmd".
183 * If not, reset "last_cmd".
184 * For a blank line use previous command. */
185 p = skipwhite(cmdline);
186 if (*p != NUL)
187 {
188 switch (*p)
189 {
190 case 'c': last_cmd = CMD_CONT;
191 tail = "ont";
192 break;
193 case 'n': last_cmd = CMD_NEXT;
194 tail = "ext";
195 break;
196 case 's': last_cmd = CMD_STEP;
197 tail = "tep";
198 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100199 case 'f':
200 last_cmd = 0;
201 if (p[1] == 'r')
202 {
203 last_cmd = CMD_FRAME;
204 tail = "rame";
205 }
206 else
207 {
208 last_cmd = CMD_FINISH;
209 tail = "inish";
210 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211 break;
212 case 'q': last_cmd = CMD_QUIT;
213 tail = "uit";
214 break;
215 case 'i': last_cmd = CMD_INTERRUPT;
216 tail = "nterrupt";
217 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100218 case 'b': last_cmd = CMD_BACKTRACE;
219 if (p[1] == 't')
220 tail = "t";
221 else
222 tail = "acktrace";
223 break;
224 case 'w': last_cmd = CMD_BACKTRACE;
225 tail = "here";
226 break;
227 case 'u': last_cmd = CMD_UP;
228 tail = "p";
229 break;
230 case 'd': last_cmd = CMD_DOWN;
231 tail = "own";
232 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000233 default: last_cmd = 0;
234 }
235 if (last_cmd != 0)
236 {
237 /* Check that the tail matches. */
238 ++p;
239 while (*p != NUL && *p == *tail)
240 {
241 ++p;
242 ++tail;
243 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100244 if (ASCII_ISALPHA(*p) && last_cmd != CMD_FRAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000245 last_cmd = 0;
246 }
247 }
248
249 if (last_cmd != 0)
250 {
251 /* Execute debug command: decided where to break next and
252 * return. */
253 switch (last_cmd)
254 {
255 case CMD_CONT:
256 debug_break_level = -1;
257 break;
258 case CMD_NEXT:
259 debug_break_level = ex_nesting_level;
260 break;
261 case CMD_STEP:
262 debug_break_level = 9999;
263 break;
264 case CMD_FINISH:
265 debug_break_level = ex_nesting_level - 1;
266 break;
267 case CMD_QUIT:
268 got_int = TRUE;
269 debug_break_level = -1;
270 break;
271 case CMD_INTERRUPT:
272 got_int = TRUE;
273 debug_break_level = 9999;
274 /* Do not repeat ">interrupt" cmd, continue stepping. */
275 last_cmd = CMD_STEP;
276 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100277 case CMD_BACKTRACE:
278 do_showbacktrace(cmd);
279 continue;
280 case CMD_FRAME:
281 if (*p == NUL)
282 {
283 do_showbacktrace(cmd);
284 }
285 else
286 {
287 p = skipwhite(p);
288 do_setdebugtracelevel(p);
289 }
290 continue;
291 case CMD_UP:
292 debug_backtrace_level++;
293 do_checkbacktracelevel();
294 continue;
295 case CMD_DOWN:
296 debug_backtrace_level--;
297 do_checkbacktracelevel();
298 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000299 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100300 /* Going out reset backtrace_level */
301 debug_backtrace_level = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000302 break;
303 }
304
305 /* don't debug this command */
306 n = debug_break_level;
307 debug_break_level = -1;
308 (void)do_cmdline(cmdline, getexline, NULL,
309 DOCMD_VERBOSE|DOCMD_EXCRESET);
310 debug_break_level = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000311 }
312 lines_left = Rows - 1;
313 }
314 vim_free(cmdline);
315
316 --RedrawingDisabled;
317 --no_wait_return;
318 redraw_all_later(NOT_VALID);
319 need_wait_return = FALSE;
320 msg_scroll = save_msg_scroll;
321 lines_left = Rows - 1;
322 State = save_State;
Bram Moolenaard99388b2017-10-26 14:28:32 +0200323 debug_mode = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324 did_emsg = save_did_emsg;
325 cmd_silent = save_cmd_silent;
326 msg_silent = save_msg_silent;
327 emsg_silent = save_emsg_silent;
328 redir_off = save_redir_off;
329
330 /* Only print the message again when typing a command before coming back
331 * here. */
332 debug_did_msg = TRUE;
333}
334
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100335 static int
336get_maxbacktrace_level(void)
337{
338 char *p, *q;
Bram Moolenaardc633cf2016-04-23 14:33:19 +0200339 int maxbacktrace = 0;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100340
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100341 if (sourcing_name != NULL)
342 {
343 p = (char *)sourcing_name;
344 while ((q = strstr(p, "..")) != NULL)
345 {
346 p = q + 2;
347 maxbacktrace++;
348 }
349 }
350 return maxbacktrace;
351}
352
353 static void
354do_setdebugtracelevel(char_u *arg)
355{
356 int level;
357
358 level = atoi((char *)arg);
359 if (*arg == '+' || level < 0)
360 debug_backtrace_level += level;
361 else
362 debug_backtrace_level = level;
363
364 do_checkbacktracelevel();
365}
366
367 static void
368do_checkbacktracelevel(void)
369{
370 if (debug_backtrace_level < 0)
371 {
372 debug_backtrace_level = 0;
373 MSG(_("frame is zero"));
374 }
375 else
376 {
377 int max = get_maxbacktrace_level();
378
379 if (debug_backtrace_level > max)
380 {
381 debug_backtrace_level = max;
382 smsg((char_u *)_("frame at highest level: %d"), max);
383 }
384 }
385}
386
387 static void
388do_showbacktrace(char_u *cmd)
389{
390 char *cur;
391 char *next;
392 int i = 0;
393 int max = get_maxbacktrace_level();
394
395 if (sourcing_name != NULL)
396 {
397 cur = (char *)sourcing_name;
398 while (!got_int)
399 {
400 next = strstr(cur, "..");
401 if (next != NULL)
402 *next = NUL;
403 if (i == max - debug_backtrace_level)
404 smsg((char_u *)"->%d %s", max - i, cur);
405 else
406 smsg((char_u *)" %d %s", max - i, cur);
407 ++i;
408 if (next == NULL)
409 break;
410 *next = '.';
411 cur = next + 2;
412 }
413 }
414 if (sourcing_lnum != 0)
415 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
416 else
417 smsg((char_u *)_("cmd: %s"), cmd);
418}
419
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420/*
421 * ":debug".
422 */
423 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100424ex_debug(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425{
426 int debug_break_level_save = debug_break_level;
427
428 debug_break_level = 9999;
429 do_cmdline_cmd(eap->arg);
430 debug_break_level = debug_break_level_save;
431}
432
433static char_u *debug_breakpoint_name = NULL;
434static linenr_T debug_breakpoint_lnum;
435
436/*
437 * When debugging or a breakpoint is set on a skipped command, no debug prompt
438 * is shown by do_one_cmd(). This situation is indicated by debug_skipped, and
439 * debug_skipped_name is then set to the source name in the breakpoint case. If
440 * a skipped command decides itself that a debug prompt should be displayed, it
441 * can do so by calling dbg_check_skipped().
442 */
443static int debug_skipped;
444static char_u *debug_skipped_name;
445
446/*
447 * Go to debug mode when a breakpoint was encountered or "ex_nesting_level" is
448 * at or below the break level. But only when the line is actually
449 * executed. Return TRUE and set breakpoint_name for skipped commands that
450 * decide to execute something themselves.
451 * Called from do_one_cmd() before executing a command.
452 */
453 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100454dbg_check_breakpoint(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455{
456 char_u *p;
457
458 debug_skipped = FALSE;
459 if (debug_breakpoint_name != NULL)
460 {
461 if (!eap->skip)
462 {
463 /* replace K_SNR with "<SNR>" */
464 if (debug_breakpoint_name[0] == K_SPECIAL
465 && debug_breakpoint_name[1] == KS_EXTRA
466 && debug_breakpoint_name[2] == (int)KE_SNR)
467 p = (char_u *)"<SNR>";
468 else
469 p = (char_u *)"";
Bram Moolenaar555b2802005-05-19 21:08:39 +0000470 smsg((char_u *)_("Breakpoint in \"%s%s\" line %ld"),
471 p,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472 debug_breakpoint_name + (*p == NUL ? 0 : 3),
473 (long)debug_breakpoint_lnum);
474 debug_breakpoint_name = NULL;
475 do_debug(eap->cmd);
476 }
477 else
478 {
479 debug_skipped = TRUE;
480 debug_skipped_name = debug_breakpoint_name;
481 debug_breakpoint_name = NULL;
482 }
483 }
484 else if (ex_nesting_level <= debug_break_level)
485 {
486 if (!eap->skip)
487 do_debug(eap->cmd);
488 else
489 {
490 debug_skipped = TRUE;
491 debug_skipped_name = NULL;
492 }
493 }
494}
495
496/*
497 * Go to debug mode if skipped by dbg_check_breakpoint() because eap->skip was
498 * set. Return TRUE when the debug mode is entered this time.
499 */
500 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100501dbg_check_skipped(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000502{
503 int prev_got_int;
504
505 if (debug_skipped)
506 {
507 /*
508 * Save the value of got_int and reset it. We don't want a previous
509 * interruption cause flushing the input buffer.
510 */
511 prev_got_int = got_int;
512 got_int = FALSE;
513 debug_breakpoint_name = debug_skipped_name;
514 /* eap->skip is TRUE */
515 eap->skip = FALSE;
516 (void)dbg_check_breakpoint(eap);
517 eap->skip = TRUE;
518 got_int |= prev_got_int;
519 return TRUE;
520 }
521 return FALSE;
522}
523
524/*
525 * The list of breakpoints: dbg_breakp.
526 * This is a grow-array of structs.
527 */
528struct debuggy
529{
530 int dbg_nr; /* breakpoint number */
531 int dbg_type; /* DBG_FUNC or DBG_FILE */
532 char_u *dbg_name; /* function or file name */
533 regprog_T *dbg_prog; /* regexp program */
534 linenr_T dbg_lnum; /* line number in function or file */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000535 int dbg_forceit; /* ! used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536};
537
538static garray_T dbg_breakp = {0, 0, sizeof(struct debuggy), 4, NULL};
Bram Moolenaar05159a02005-02-26 23:04:13 +0000539#define BREAKP(idx) (((struct debuggy *)dbg_breakp.ga_data)[idx])
540#define DEBUGGY(gap, idx) (((struct debuggy *)gap->ga_data)[idx])
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541static int last_breakp = 0; /* nr of last defined breakpoint */
542
Bram Moolenaar05159a02005-02-26 23:04:13 +0000543#ifdef FEAT_PROFILE
544/* Profiling uses file and func names similar to breakpoints. */
545static garray_T prof_ga = {0, 0, sizeof(struct debuggy), 4, NULL};
546#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547#define DBG_FUNC 1
548#define DBG_FILE 2
549
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100550static int dbg_parsearg(char_u *arg, garray_T *gap);
551static linenr_T debuggy_find(int file,char_u *fname, linenr_T after, garray_T *gap, int *fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552
553/*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000554 * Parse the arguments of ":profile", ":breakadd" or ":breakdel" and put them
555 * in the entry just after the last one in dbg_breakp. Note that "dbg_name"
556 * is allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557 * Returns FAIL for failure.
558 */
559 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100560dbg_parsearg(
561 char_u *arg,
562 garray_T *gap) /* either &dbg_breakp or &prof_ga */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563{
564 char_u *p = arg;
565 char_u *q;
566 struct debuggy *bp;
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000567 int here = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568
Bram Moolenaar05159a02005-02-26 23:04:13 +0000569 if (ga_grow(gap, 1) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570 return FAIL;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000571 bp = &DEBUGGY(gap, gap->ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
573 /* Find "func" or "file". */
574 if (STRNCMP(p, "func", 4) == 0)
575 bp->dbg_type = DBG_FUNC;
576 else if (STRNCMP(p, "file", 4) == 0)
577 bp->dbg_type = DBG_FILE;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000578 else if (
579#ifdef FEAT_PROFILE
580 gap != &prof_ga &&
581#endif
582 STRNCMP(p, "here", 4) == 0)
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000583 {
584 if (curbuf->b_ffname == NULL)
585 {
586 EMSG(_(e_noname));
587 return FAIL;
588 }
589 bp->dbg_type = DBG_FILE;
590 here = TRUE;
591 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592 else
593 {
594 EMSG2(_(e_invarg2), p);
595 return FAIL;
596 }
597 p = skipwhite(p + 4);
598
599 /* Find optional line number. */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000600 if (here)
601 bp->dbg_lnum = curwin->w_cursor.lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000602 else if (
603#ifdef FEAT_PROFILE
604 gap != &prof_ga &&
605#endif
606 VIM_ISDIGIT(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607 {
608 bp->dbg_lnum = getdigits(&p);
609 p = skipwhite(p);
610 }
611 else
612 bp->dbg_lnum = 0;
613
614 /* Find the function or file name. Don't accept a function name with (). */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000615 if ((!here && *p == NUL)
616 || (here && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 || (bp->dbg_type == DBG_FUNC && strstr((char *)p, "()") != NULL))
618 {
619 EMSG2(_(e_invarg2), arg);
620 return FAIL;
621 }
622
623 if (bp->dbg_type == DBG_FUNC)
624 bp->dbg_name = vim_strsave(p);
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000625 else if (here)
626 bp->dbg_name = vim_strsave(curbuf->b_ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000627 else
628 {
629 /* Expand the file name in the same way as do_source(). This means
630 * doing it twice, so that $DIR/file gets expanded when $DIR is
631 * "~/dir". */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 q = expand_env_save(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 if (q == NULL)
634 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635 p = expand_env_save(q);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000636 vim_free(q);
637 if (p == NULL)
638 return FAIL;
Bram Moolenaar843ee412004-06-30 16:16:41 +0000639 if (*p != '*')
640 {
641 bp->dbg_name = fix_fname(p);
642 vim_free(p);
643 }
644 else
645 bp->dbg_name = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 }
647
648 if (bp->dbg_name == NULL)
649 return FAIL;
650 return OK;
651}
652
653/*
654 * ":breakadd".
655 */
656 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100657ex_breakadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658{
659 struct debuggy *bp;
660 char_u *pat;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000661 garray_T *gap;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662
Bram Moolenaar05159a02005-02-26 23:04:13 +0000663 gap = &dbg_breakp;
664#ifdef FEAT_PROFILE
665 if (eap->cmdidx == CMD_profile)
666 gap = &prof_ga;
667#endif
668
669 if (dbg_parsearg(eap->arg, gap) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000671 bp = &DEBUGGY(gap, gap->ga_len);
672 bp->dbg_forceit = eap->forceit;
673
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 pat = file_pat_to_reg_pat(bp->dbg_name, NULL, NULL, FALSE);
675 if (pat != NULL)
676 {
677 bp->dbg_prog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
678 vim_free(pat);
679 }
680 if (pat == NULL || bp->dbg_prog == NULL)
681 vim_free(bp->dbg_name);
682 else
683 {
684 if (bp->dbg_lnum == 0) /* default line number is 1 */
685 bp->dbg_lnum = 1;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000686#ifdef FEAT_PROFILE
687 if (eap->cmdidx != CMD_profile)
688#endif
689 {
690 DEBUGGY(gap, gap->ga_len).dbg_nr = ++last_breakp;
691 ++debug_tick;
692 }
693 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 }
695 }
696}
697
698/*
699 * ":debuggreedy".
700 */
701 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100702ex_debuggreedy(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703{
704 if (eap->addr_count == 0 || eap->line2 != 0)
705 debug_greedy = TRUE;
706 else
707 debug_greedy = FALSE;
708}
709
710/*
Bram Moolenaard9fba312005-06-26 22:34:35 +0000711 * ":breakdel" and ":profdel".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 */
713 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100714ex_breakdel(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715{
716 struct debuggy *bp, *bpi;
717 int nr;
718 int todel = -1;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000719 int del_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 int i;
721 linenr_T best_lnum = 0;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000722 garray_T *gap;
723
724 gap = &dbg_breakp;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000725 if (eap->cmdidx == CMD_profdel)
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200726 {
727#ifdef FEAT_PROFILE
Bram Moolenaard9fba312005-06-26 22:34:35 +0000728 gap = &prof_ga;
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200729#else
730 ex_ni(eap);
731 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000732#endif
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200733 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734
735 if (vim_isdigit(*eap->arg))
736 {
737 /* ":breakdel {nr}" */
738 nr = atol((char *)eap->arg);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000739 for (i = 0; i < gap->ga_len; ++i)
740 if (DEBUGGY(gap, i).dbg_nr == nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741 {
742 todel = i;
743 break;
744 }
745 }
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000746 else if (*eap->arg == '*')
747 {
748 todel = 0;
749 del_all = TRUE;
750 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751 else
752 {
753 /* ":breakdel {func|file} [lnum] {name}" */
Bram Moolenaard9fba312005-06-26 22:34:35 +0000754 if (dbg_parsearg(eap->arg, gap) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000756 bp = &DEBUGGY(gap, gap->ga_len);
757 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000759 bpi = &DEBUGGY(gap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760 if (bp->dbg_type == bpi->dbg_type
761 && STRCMP(bp->dbg_name, bpi->dbg_name) == 0
762 && (bp->dbg_lnum == bpi->dbg_lnum
763 || (bp->dbg_lnum == 0
764 && (best_lnum == 0
765 || bpi->dbg_lnum < best_lnum))))
766 {
767 todel = i;
768 best_lnum = bpi->dbg_lnum;
769 }
770 }
771 vim_free(bp->dbg_name);
772 }
773
774 if (todel < 0)
775 EMSG2(_("E161: Breakpoint not found: %s"), eap->arg);
776 else
Bram Moolenaard9fba312005-06-26 22:34:35 +0000777 {
778 while (gap->ga_len > 0)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000779 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000780 vim_free(DEBUGGY(gap, todel).dbg_name);
Bram Moolenaar473de612013-06-08 18:19:48 +0200781 vim_regfree(DEBUGGY(gap, todel).dbg_prog);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000782 --gap->ga_len;
783 if (todel < gap->ga_len)
784 mch_memmove(&DEBUGGY(gap, todel), &DEBUGGY(gap, todel + 1),
785 (gap->ga_len - todel) * sizeof(struct debuggy));
786#ifdef FEAT_PROFILE
787 if (eap->cmdidx == CMD_breakdel)
788#endif
789 ++debug_tick;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000790 if (!del_all)
791 break;
792 }
Bram Moolenaard9fba312005-06-26 22:34:35 +0000793
794 /* If all breakpoints were removed clear the array. */
795 if (gap->ga_len == 0)
796 ga_clear(gap);
797 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798}
799
800/*
801 * ":breaklist".
802 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100804ex_breaklist(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805{
806 struct debuggy *bp;
807 int i;
808
809 if (dbg_breakp.ga_len == 0)
810 MSG(_("No breakpoints defined"));
811 else
812 for (i = 0; i < dbg_breakp.ga_len; ++i)
813 {
814 bp = &BREAKP(i);
Bram Moolenaard58ea072011-06-26 04:25:30 +0200815 if (bp->dbg_type == DBG_FILE)
816 home_replace(NULL, bp->dbg_name, NameBuff, MAXPATHL, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 smsg((char_u *)_("%3d %s %s line %ld"),
818 bp->dbg_nr,
819 bp->dbg_type == DBG_FUNC ? "func" : "file",
Bram Moolenaard58ea072011-06-26 04:25:30 +0200820 bp->dbg_type == DBG_FUNC ? bp->dbg_name : NameBuff,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 (long)bp->dbg_lnum);
822 }
823}
824
825/*
826 * Find a breakpoint for a function or sourced file.
827 * Returns line number at which to break; zero when no matching breakpoint.
828 */
829 linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100830dbg_find_breakpoint(
831 int file, /* TRUE for a file, FALSE for a function */
832 char_u *fname, /* file or function name */
833 linenr_T after) /* after this line number */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834{
Bram Moolenaar05159a02005-02-26 23:04:13 +0000835 return debuggy_find(file, fname, after, &dbg_breakp, NULL);
836}
837
838#if defined(FEAT_PROFILE) || defined(PROTO)
839/*
840 * Return TRUE if profiling is on for a function or sourced file.
841 */
842 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100843has_profiling(
844 int file, /* TRUE for a file, FALSE for a function */
845 char_u *fname, /* file or function name */
846 int *fp) /* return: forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000847{
848 return (debuggy_find(file, fname, (linenr_T)0, &prof_ga, fp)
849 != (linenr_T)0);
850}
851#endif
852
853/*
854 * Common code for dbg_find_breakpoint() and has_profiling().
855 */
856 static linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100857debuggy_find(
858 int file, /* TRUE for a file, FALSE for a function */
859 char_u *fname, /* file or function name */
860 linenr_T after, /* after this line number */
861 garray_T *gap, /* either &dbg_breakp or &prof_ga */
862 int *fp) /* if not NULL: return forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000863{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 struct debuggy *bp;
865 int i;
866 linenr_T lnum = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 char_u *name = fname;
868 int prev_got_int;
869
Bram Moolenaar05159a02005-02-26 23:04:13 +0000870 /* Return quickly when there are no breakpoints. */
871 if (gap->ga_len == 0)
872 return (linenr_T)0;
873
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 /* Replace K_SNR in function name with "<SNR>". */
875 if (!file && fname[0] == K_SPECIAL)
876 {
877 name = alloc((unsigned)STRLEN(fname) + 3);
878 if (name == NULL)
879 name = fname;
880 else
881 {
882 STRCPY(name, "<SNR>");
883 STRCPY(name + 5, fname + 3);
884 }
885 }
886
Bram Moolenaar05159a02005-02-26 23:04:13 +0000887 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000889 /* Skip entries that are not useful or are for a line that is beyond
890 * an already found breakpoint. */
891 bp = &DEBUGGY(gap, i);
892 if (((bp->dbg_type == DBG_FILE) == file && (
893#ifdef FEAT_PROFILE
894 gap == &prof_ga ||
895#endif
896 (bp->dbg_lnum > after && (lnum == 0 || bp->dbg_lnum < lnum)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000899 * Save the value of got_int and reset it. We don't want a
900 * previous interruption cancel matching, only hitting CTRL-C
901 * while matching should abort it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 */
903 prev_got_int = got_int;
904 got_int = FALSE;
Bram Moolenaardffa5b82014-11-19 16:38:07 +0100905 if (vim_regexec_prog(&bp->dbg_prog, FALSE, name, (colnr_T)0))
Bram Moolenaar05159a02005-02-26 23:04:13 +0000906 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 lnum = bp->dbg_lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000908 if (fp != NULL)
909 *fp = bp->dbg_forceit;
910 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 got_int |= prev_got_int;
912 }
913 }
914 if (name != fname)
915 vim_free(name);
916
917 return lnum;
918}
919
920/*
921 * Called when a breakpoint was encountered.
922 */
923 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100924dbg_breakpoint(char_u *name, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925{
926 /* We need to check if this line is actually executed in do_one_cmd() */
927 debug_breakpoint_name = name;
928 debug_breakpoint_lnum = lnum;
929}
Bram Moolenaar05159a02005-02-26 23:04:13 +0000930
931
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000932# if defined(FEAT_PROFILE) || defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000933/*
934 * Store the current time in "tm".
935 */
936 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100937profile_start(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000938{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000939# ifdef WIN3264
940 QueryPerformanceCounter(tm);
941# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000942 gettimeofday(tm, NULL);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000943# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000944}
945
946/*
947 * Compute the elapsed time from "tm" till now and store in "tm".
948 */
949 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100950profile_end(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000951{
952 proftime_T now;
953
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000954# ifdef WIN3264
955 QueryPerformanceCounter(&now);
956 tm->QuadPart = now.QuadPart - tm->QuadPart;
957# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000958 gettimeofday(&now, NULL);
959 tm->tv_usec = now.tv_usec - tm->tv_usec;
960 tm->tv_sec = now.tv_sec - tm->tv_sec;
961 if (tm->tv_usec < 0)
962 {
963 tm->tv_usec += 1000000;
964 --tm->tv_sec;
965 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000966# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000967}
968
969/*
970 * Subtract the time "tm2" from "tm".
971 */
972 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100973profile_sub(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000974{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000975# ifdef WIN3264
976 tm->QuadPart -= tm2->QuadPart;
977# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000978 tm->tv_usec -= tm2->tv_usec;
979 tm->tv_sec -= tm2->tv_sec;
980 if (tm->tv_usec < 0)
981 {
982 tm->tv_usec += 1000000;
983 --tm->tv_sec;
984 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000985# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000986}
987
988/*
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000989 * Return a string that represents the time in "tm".
990 * Uses a static buffer!
991 */
992 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100993profile_msg(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000994{
995 static char buf[50];
996
997# ifdef WIN3264
998 LARGE_INTEGER fr;
999
1000 QueryPerformanceFrequency(&fr);
1001 sprintf(buf, "%10.6lf", (double)tm->QuadPart / (double)fr.QuadPart);
1002# else
1003 sprintf(buf, "%3ld.%06ld", (long)tm->tv_sec, (long)tm->tv_usec);
Bram Moolenaar76929292008-01-06 19:07:36 +00001004# endif
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001005 return buf;
1006}
1007
Bram Moolenaar79c2c882016-02-07 21:19:28 +01001008# if defined(FEAT_FLOAT) || defined(PROTO)
1009/*
1010 * Return a float that represents the time in "tm".
1011 */
1012 float_T
1013profile_float(proftime_T *tm)
1014{
1015# ifdef WIN3264
1016 LARGE_INTEGER fr;
1017
1018 QueryPerformanceFrequency(&fr);
1019 return (float_T)tm->QuadPart / (float_T)fr.QuadPart;
1020# else
1021 return (float_T)tm->tv_sec + (float_T)tm->tv_usec / 1000000.0;
1022# endif
1023}
1024# endif
1025
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001026/*
Bram Moolenaar76929292008-01-06 19:07:36 +00001027 * Put the time "msec" past now in "tm".
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001028 */
Bram Moolenaar76929292008-01-06 19:07:36 +00001029 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001030profile_setlimit(long msec, proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001031{
1032 if (msec <= 0) /* no limit */
1033 profile_zero(tm);
1034 else
1035 {
1036# ifdef WIN3264
1037 LARGE_INTEGER fr;
1038
1039 QueryPerformanceCounter(tm);
1040 QueryPerformanceFrequency(&fr);
Bram Moolenaarb3c70982008-01-18 10:40:55 +00001041 tm->QuadPart += (LONGLONG)((double)msec / 1000.0 * (double)fr.QuadPart);
Bram Moolenaar76929292008-01-06 19:07:36 +00001042# else
1043 long usec;
1044
1045 gettimeofday(tm, NULL);
1046 usec = (long)tm->tv_usec + (long)msec * 1000;
1047 tm->tv_usec = usec % 1000000L;
1048 tm->tv_sec += usec / 1000000L;
1049# endif
1050 }
1051}
1052
1053/*
1054 * Return TRUE if the current time is past "tm".
1055 */
1056 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001057profile_passed_limit(proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001058{
1059 proftime_T now;
1060
1061# ifdef WIN3264
1062 if (tm->QuadPart == 0) /* timer was not set */
1063 return FALSE;
1064 QueryPerformanceCounter(&now);
1065 return (now.QuadPart > tm->QuadPart);
1066# else
1067 if (tm->tv_sec == 0) /* timer was not set */
1068 return FALSE;
1069 gettimeofday(&now, NULL);
1070 return (now.tv_sec > tm->tv_sec
1071 || (now.tv_sec == tm->tv_sec && now.tv_usec > tm->tv_usec));
1072# endif
1073}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001074
1075/*
1076 * Set the time in "tm" to zero.
1077 */
1078 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001079profile_zero(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001080{
1081# ifdef WIN3264
1082 tm->QuadPart = 0;
1083# else
1084 tm->tv_usec = 0;
1085 tm->tv_sec = 0;
1086# endif
1087}
1088
Bram Moolenaar76929292008-01-06 19:07:36 +00001089# endif /* FEAT_PROFILE || FEAT_RELTIME */
1090
Bram Moolenaar975b5272016-03-15 23:10:59 +01001091# if defined(FEAT_TIMERS) || defined(PROTO)
1092static timer_T *first_timer = NULL;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001093static long last_timer_id = 0;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001094
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001095 static long
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001096proftime_time_left(proftime_T *due, proftime_T *now)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001097{
1098# ifdef WIN3264
1099 LARGE_INTEGER fr;
1100
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001101 if (now->QuadPart > due->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001102 return 0;
1103 QueryPerformanceFrequency(&fr);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001104 return (long)(((double)(due->QuadPart - now->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001105 / (double)fr.QuadPart) * 1000);
1106# else
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001107 if (now->tv_sec > due->tv_sec)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001108 return 0;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001109 return (due->tv_sec - now->tv_sec) * 1000
1110 + (due->tv_usec - now->tv_usec) / 1000;
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001111# endif
1112}
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001113
Bram Moolenaar975b5272016-03-15 23:10:59 +01001114/*
1115 * Insert a timer in the list of timers.
1116 */
1117 static void
1118insert_timer(timer_T *timer)
1119{
1120 timer->tr_next = first_timer;
1121 timer->tr_prev = NULL;
1122 if (first_timer != NULL)
1123 first_timer->tr_prev = timer;
1124 first_timer = timer;
Bram Moolenaar4231da42016-06-02 14:30:04 +02001125 did_add_timer = TRUE;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001126}
1127
1128/*
1129 * Take a timer out of the list of timers.
1130 */
1131 static void
1132remove_timer(timer_T *timer)
1133{
1134 if (timer->tr_prev == NULL)
1135 first_timer = timer->tr_next;
1136 else
1137 timer->tr_prev->tr_next = timer->tr_next;
1138 if (timer->tr_next != NULL)
1139 timer->tr_next->tr_prev = timer->tr_prev;
1140}
1141
1142 static void
1143free_timer(timer_T *timer)
1144{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001145 free_callback(timer->tr_callback, timer->tr_partial);
1146 vim_free(timer);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001147}
1148
1149/*
1150 * Create a timer and return it. NULL if out of memory.
1151 * Caller should set the callback.
1152 */
1153 timer_T *
1154create_timer(long msec, int repeat)
1155{
1156 timer_T *timer = (timer_T *)alloc_clear(sizeof(timer_T));
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001157 long prev_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001158
1159 if (timer == NULL)
1160 return NULL;
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001161 if (++last_timer_id <= prev_id)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001162 /* Overflow! Might cause duplicates... */
1163 last_timer_id = 0;
1164 timer->tr_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001165 insert_timer(timer);
1166 if (repeat != 0)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001167 timer->tr_repeat = repeat - 1;
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001168 timer->tr_interval = msec;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001169
1170 profile_setlimit(msec, &timer->tr_due);
1171 return timer;
1172}
1173
1174/*
1175 * Invoke the callback of "timer".
1176 */
1177 static void
1178timer_callback(timer_T *timer)
1179{
1180 typval_T rettv;
1181 int dummy;
1182 typval_T argv[2];
1183
1184 argv[0].v_type = VAR_NUMBER;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001185 argv[0].vval.v_number = (varnumber_T)timer->tr_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001186 argv[1].v_type = VAR_UNKNOWN;
1187
1188 call_func(timer->tr_callback, (int)STRLEN(timer->tr_callback),
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001189 &rettv, 1, argv, NULL, 0L, 0L, &dummy, TRUE,
Bram Moolenaar975b5272016-03-15 23:10:59 +01001190 timer->tr_partial, NULL);
1191 clear_tv(&rettv);
1192}
1193
1194/*
1195 * Call timers that are due.
1196 * Return the time in msec until the next timer is due.
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001197 * Returns -1 if there are no pending timers.
Bram Moolenaar975b5272016-03-15 23:10:59 +01001198 */
1199 long
Bram Moolenaarcf089462016-06-12 21:18:43 +02001200check_due_timer(void)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001201{
1202 timer_T *timer;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001203 timer_T *timer_next;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001204 long this_due;
Bram Moolenaar597385a2016-03-16 23:24:43 +01001205 long next_due = -1;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001206 proftime_T now;
1207 int did_one = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001208 int need_update_screen = FALSE;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001209 long current_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001210
Bram Moolenaarc577d812017-07-08 22:37:34 +02001211 /* Don't run any timers while exiting or dealing with an error. */
1212 if (exiting || aborting())
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001213 return next_due;
1214
Bram Moolenaar75537a92016-09-05 22:45:28 +02001215 profile_start(&now);
1216 for (timer = first_timer; timer != NULL && !got_int; timer = timer_next)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001217 {
Bram Moolenaar75537a92016-09-05 22:45:28 +02001218 timer_next = timer->tr_next;
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001219
Bram Moolenaar75537a92016-09-05 22:45:28 +02001220 if (timer->tr_id == -1 || timer->tr_firing || timer->tr_paused)
1221 continue;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001222 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001223 if (this_due <= 1)
1224 {
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001225 int save_timer_busy = timer_busy;
1226 int save_vgetc_busy = vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001227 int save_did_emsg = did_emsg;
1228 int save_called_emsg = called_emsg;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001229 int save_must_redraw = must_redraw;
Bram Moolenaare723c422017-09-06 23:40:10 +02001230 int save_trylevel = trylevel;
1231 int save_did_throw = did_throw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001232 int save_ex_pressedreturn = get_pressedreturn();
Bram Moolenaare723c422017-09-06 23:40:10 +02001233 except_T *save_current_exception = current_exception;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001234
Bram Moolenaare723c422017-09-06 23:40:10 +02001235 /* Create a scope for running the timer callback, ignoring most of
1236 * the current scope, such as being inside a try/catch. */
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001237 timer_busy = timer_busy > 0 || vgetc_busy > 0;
1238 vgetc_busy = 0;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001239 called_emsg = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001240 did_emsg = FALSE;
1241 did_uncaught_emsg = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001242 must_redraw = 0;
Bram Moolenaare723c422017-09-06 23:40:10 +02001243 trylevel = 0;
1244 did_throw = FALSE;
1245 current_exception = NULL;
1246
Bram Moolenaar75537a92016-09-05 22:45:28 +02001247 timer->tr_firing = TRUE;
1248 timer_callback(timer);
1249 timer->tr_firing = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001250
Bram Moolenaar75537a92016-09-05 22:45:28 +02001251 timer_next = timer->tr_next;
1252 did_one = TRUE;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001253 timer_busy = save_timer_busy;
1254 vgetc_busy = save_vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001255 if (did_uncaught_emsg)
Bram Moolenaarc577d812017-07-08 22:37:34 +02001256 ++timer->tr_emsg_count;
Bram Moolenaare723c422017-09-06 23:40:10 +02001257 did_emsg = save_did_emsg;
1258 called_emsg = save_called_emsg;
1259 trylevel = save_trylevel;
1260 did_throw = save_did_throw;
1261 current_exception = save_current_exception;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001262 if (must_redraw != 0)
1263 need_update_screen = TRUE;
1264 must_redraw = must_redraw > save_must_redraw
1265 ? must_redraw : save_must_redraw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001266 set_pressedreturn(save_ex_pressedreturn);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001267
1268 /* Only fire the timer again if it repeats and stop_timer() wasn't
1269 * called while inside the callback (tr_id == -1). */
Bram Moolenaarc577d812017-07-08 22:37:34 +02001270 if (timer->tr_repeat != 0 && timer->tr_id != -1
1271 && timer->tr_emsg_count < 3)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001272 {
1273 profile_setlimit(timer->tr_interval, &timer->tr_due);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001274 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001275 if (this_due < 1)
1276 this_due = 1;
1277 if (timer->tr_repeat > 0)
1278 --timer->tr_repeat;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001279 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001280 else
1281 {
1282 this_due = -1;
1283 remove_timer(timer);
1284 free_timer(timer);
1285 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001286 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001287 if (this_due > 0 && (next_due == -1 || next_due > this_due))
1288 next_due = this_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001289 }
1290
1291 if (did_one)
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001292 redraw_after_callback(need_update_screen);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001293
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001294#ifdef FEAT_BEVALTERM
1295 if (bevalexpr_due_set)
1296 {
1297 this_due = proftime_time_left(&bevalexpr_due, &now);
1298 if (this_due <= 1)
1299 {
1300 bevalexpr_due_set = FALSE;
1301
1302 if (balloonEval == NULL)
1303 {
1304 balloonEval = (BalloonEval *)alloc(sizeof(BalloonEval));
1305 balloonEvalForTerm = TRUE;
1306 }
1307 if (balloonEval != NULL)
1308 general_beval_cb(balloonEval, 0);
1309 }
1310 else if (this_due > 0 && (next_due == -1 || next_due > this_due))
1311 next_due = this_due;
1312 }
1313#endif
1314
Bram Moolenaar75537a92016-09-05 22:45:28 +02001315 return current_id != last_timer_id ? 1 : next_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001316}
1317
1318/*
1319 * Find a timer by ID. Returns NULL if not found;
1320 */
1321 timer_T *
Bram Moolenaar75537a92016-09-05 22:45:28 +02001322find_timer(long id)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001323{
1324 timer_T *timer;
1325
Bram Moolenaar75537a92016-09-05 22:45:28 +02001326 if (id >= 0)
1327 {
1328 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1329 if (timer->tr_id == id)
1330 return timer;
1331 }
1332 return NULL;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001333}
1334
1335
1336/*
1337 * Stop a timer and delete it.
1338 */
1339 void
1340stop_timer(timer_T *timer)
1341{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001342 if (timer->tr_firing)
1343 /* Free the timer after the callback returns. */
1344 timer->tr_id = -1;
1345 else
1346 {
1347 remove_timer(timer);
1348 free_timer(timer);
1349 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001350}
Bram Moolenaare3188e22016-05-31 21:13:04 +02001351
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001352 void
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001353stop_all_timers(void)
1354{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001355 timer_T *timer;
1356 timer_T *timer_next;
1357
1358 for (timer = first_timer; timer != NULL; timer = timer_next)
1359 {
1360 timer_next = timer->tr_next;
1361 stop_timer(timer);
1362 }
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001363}
1364
1365 void
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001366add_timer_info(typval_T *rettv, timer_T *timer)
1367{
1368 list_T *list = rettv->vval.v_list;
1369 dict_T *dict = dict_alloc();
1370 dictitem_T *di;
1371 long remaining;
1372 proftime_T now;
1373
1374 if (dict == NULL)
1375 return;
1376 list_append_dict(list, dict);
1377
Bram Moolenaar75537a92016-09-05 22:45:28 +02001378 dict_add_nr_str(dict, "id", timer->tr_id, NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001379 dict_add_nr_str(dict, "time", (long)timer->tr_interval, NULL);
1380
1381 profile_start(&now);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001382 remaining = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001383 dict_add_nr_str(dict, "remaining", (long)remaining, NULL);
1384
1385 dict_add_nr_str(dict, "repeat",
1386 (long)(timer->tr_repeat < 0 ? -1 : timer->tr_repeat + 1), NULL);
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001387 dict_add_nr_str(dict, "paused", (long)(timer->tr_paused), NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001388
1389 di = dictitem_alloc((char_u *)"callback");
1390 if (di != NULL)
1391 {
1392 if (dict_add(dict, di) == FAIL)
1393 vim_free(di);
1394 else if (timer->tr_partial != NULL)
1395 {
1396 di->di_tv.v_type = VAR_PARTIAL;
1397 di->di_tv.vval.v_partial = timer->tr_partial;
1398 ++timer->tr_partial->pt_refcount;
1399 }
1400 else
1401 {
1402 di->di_tv.v_type = VAR_FUNC;
1403 di->di_tv.vval.v_string = vim_strsave(timer->tr_callback);
1404 }
1405 di->di_tv.v_lock = 0;
1406 }
1407}
1408
1409 void
1410add_timer_info_all(typval_T *rettv)
1411{
1412 timer_T *timer;
1413
1414 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001415 if (timer->tr_id != -1)
1416 add_timer_info(rettv, timer);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001417}
1418
Bram Moolenaare3188e22016-05-31 21:13:04 +02001419/*
1420 * Mark references in partials of timers.
1421 */
1422 int
1423set_ref_in_timer(int copyID)
1424{
1425 int abort = FALSE;
1426 timer_T *timer;
1427 typval_T tv;
1428
1429 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1430 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001431 if (timer->tr_partial != NULL)
1432 {
1433 tv.v_type = VAR_PARTIAL;
1434 tv.vval.v_partial = timer->tr_partial;
1435 }
1436 else
1437 {
1438 tv.v_type = VAR_FUNC;
1439 tv.vval.v_string = timer->tr_callback;
1440 }
Bram Moolenaare3188e22016-05-31 21:13:04 +02001441 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
1442 }
1443 return abort;
1444}
Bram Moolenaar623e2632016-07-30 22:47:56 +02001445
1446# if defined(EXITFREE) || defined(PROTO)
1447 void
1448timer_free_all()
1449{
1450 timer_T *timer;
1451
1452 while (first_timer != NULL)
1453 {
1454 timer = first_timer;
1455 remove_timer(timer);
1456 free_timer(timer);
1457 }
1458}
1459# endif
Bram Moolenaar975b5272016-03-15 23:10:59 +01001460# endif
1461
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001462#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1463# if defined(HAVE_MATH_H)
1464# include <math.h>
1465# endif
1466
1467/*
1468 * Divide the time "tm" by "count" and store in "tm2".
1469 */
1470 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001471profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001472{
1473 if (count == 0)
1474 profile_zero(tm2);
1475 else
1476 {
1477# ifdef WIN3264
1478 tm2->QuadPart = tm->QuadPart / count;
1479# else
1480 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1481
1482 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001483 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001484# endif
1485 }
1486}
1487#endif
1488
Bram Moolenaar76929292008-01-06 19:07:36 +00001489# if defined(FEAT_PROFILE) || defined(PROTO)
1490/*
1491 * Functions for profiling.
1492 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001493static void script_do_profile(scriptitem_T *si);
1494static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001495static proftime_T prof_wait_time;
1496
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001497/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001498 * Add the time "tm2" to "tm".
1499 */
1500 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001501profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001502{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001503# ifdef WIN3264
1504 tm->QuadPart += tm2->QuadPart;
1505# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001506 tm->tv_usec += tm2->tv_usec;
1507 tm->tv_sec += tm2->tv_sec;
1508 if (tm->tv_usec >= 1000000)
1509 {
1510 tm->tv_usec -= 1000000;
1511 ++tm->tv_sec;
1512 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001513# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001514}
1515
1516/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001517 * Add the "self" time from the total time and the children's time.
1518 */
1519 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001520profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001521{
1522 /* Check that the result won't be negative. Can happen with recursive
1523 * calls. */
1524#ifdef WIN3264
1525 if (total->QuadPart <= children->QuadPart)
1526 return;
1527#else
1528 if (total->tv_sec < children->tv_sec
1529 || (total->tv_sec == children->tv_sec
1530 && total->tv_usec <= children->tv_usec))
1531 return;
1532#endif
1533 profile_add(self, total);
1534 profile_sub(self, children);
1535}
1536
1537/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001538 * Get the current waittime.
1539 */
1540 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001541profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001542{
1543 *tm = prof_wait_time;
1544}
1545
1546/*
1547 * Subtract the passed waittime since "tm" from "tma".
1548 */
1549 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001550profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001551{
1552 proftime_T tm3 = prof_wait_time;
1553
1554 profile_sub(&tm3, tm);
1555 profile_sub(tma, &tm3);
1556}
1557
1558/*
1559 * Return TRUE if "tm1" and "tm2" are equal.
1560 */
1561 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001562profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001563{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001564# ifdef WIN3264
1565 return (tm1->QuadPart == tm2->QuadPart);
1566# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001567 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001568# endif
1569}
1570
1571/*
1572 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1573 */
1574 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001575profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001576{
1577# ifdef WIN3264
1578 return (int)(tm2->QuadPart - tm1->QuadPart);
1579# else
1580 if (tm1->tv_sec == tm2->tv_sec)
1581 return tm2->tv_usec - tm1->tv_usec;
1582 return tm2->tv_sec - tm1->tv_sec;
1583# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001584}
1585
Bram Moolenaar05159a02005-02-26 23:04:13 +00001586static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001587static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001588
1589/*
1590 * ":profile cmd args"
1591 */
1592 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001593ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001594{
1595 char_u *e;
1596 int len;
1597
1598 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001599 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001600 e = skipwhite(e);
1601
1602 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1603 {
1604 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001605 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001606 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001607 profile_zero(&prof_wait_time);
1608 set_vim_var_nr(VV_PROFILING, 1L);
1609 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001610 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001611 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001612 else if (STRCMP(eap->arg, "pause") == 0)
1613 {
1614 if (do_profiling == PROF_YES)
1615 profile_start(&pause_time);
1616 do_profiling = PROF_PAUSED;
1617 }
1618 else if (STRCMP(eap->arg, "continue") == 0)
1619 {
1620 if (do_profiling == PROF_PAUSED)
1621 {
1622 profile_end(&pause_time);
1623 profile_add(&prof_wait_time, &pause_time);
1624 }
1625 do_profiling = PROF_YES;
1626 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001627 else
1628 {
1629 /* The rest is similar to ":breakadd". */
1630 ex_breakadd(eap);
1631 }
1632}
1633
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001634/* Command line expansion for :profile. */
1635static enum
1636{
1637 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001638 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001639} pexpand_what;
1640
1641static char *pexpand_cmds[] = {
1642 "start",
1643#define PROFCMD_START 0
1644 "pause",
1645#define PROFCMD_PAUSE 1
1646 "continue",
1647#define PROFCMD_CONTINUE 2
1648 "func",
1649#define PROFCMD_FUNC 3
1650 "file",
1651#define PROFCMD_FILE 4
1652 NULL
1653#define PROFCMD_LAST 5
1654};
1655
1656/*
1657 * Function given to ExpandGeneric() to obtain the profile command
1658 * specific expansion.
1659 */
1660 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001661get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001662{
1663 switch (pexpand_what)
1664 {
1665 case PEXP_SUBCMD:
1666 return (char_u *)pexpand_cmds[idx];
1667 /* case PEXP_FUNC: TODO */
1668 default:
1669 return NULL;
1670 }
1671}
1672
1673/*
1674 * Handle command line completion for :profile command.
1675 */
1676 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001677set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001678{
1679 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001680
1681 /* Default: expand subcommands. */
1682 xp->xp_context = EXPAND_PROFILE;
1683 pexpand_what = PEXP_SUBCMD;
1684 xp->xp_pattern = arg;
1685
1686 end_subcmd = skiptowhite(arg);
1687 if (*end_subcmd == NUL)
1688 return;
1689
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001690 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001691 {
1692 xp->xp_context = EXPAND_FILES;
1693 xp->xp_pattern = skipwhite(end_subcmd);
1694 return;
1695 }
1696
1697 /* TODO: expand function names after "func" */
1698 xp->xp_context = EXPAND_NOTHING;
1699}
1700
Bram Moolenaar05159a02005-02-26 23:04:13 +00001701/*
1702 * Dump the profiling info.
1703 */
1704 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001705profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001706{
1707 FILE *fd;
1708
1709 if (profile_fname != NULL)
1710 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001711 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001712 if (fd == NULL)
1713 EMSG2(_(e_notopen), profile_fname);
1714 else
1715 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001716 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001717 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001718 fclose(fd);
1719 }
1720 }
1721}
1722
1723/*
1724 * Start profiling script "fp".
1725 */
1726 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001727script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001728{
1729 si->sn_pr_count = 0;
1730 profile_zero(&si->sn_pr_total);
1731 profile_zero(&si->sn_pr_self);
1732
1733 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1734 si->sn_prl_idx = -1;
1735 si->sn_prof_on = TRUE;
1736 si->sn_pr_nest = 0;
1737}
1738
1739/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02001740 * Save time when starting to invoke another script or function.
Bram Moolenaar05159a02005-02-26 23:04:13 +00001741 */
1742 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001743script_prof_save(
1744 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001745{
1746 scriptitem_T *si;
1747
1748 if (current_SID > 0 && current_SID <= script_items.ga_len)
1749 {
1750 si = &SCRIPT_ITEM(current_SID);
1751 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1752 profile_start(&si->sn_pr_child);
1753 }
1754 profile_get_wait(tm);
1755}
1756
1757/*
1758 * Count time spent in children after invoking another script or function.
1759 */
1760 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001761script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001762{
1763 scriptitem_T *si;
1764
1765 if (current_SID > 0 && current_SID <= script_items.ga_len)
1766 {
1767 si = &SCRIPT_ITEM(current_SID);
1768 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1769 {
1770 profile_end(&si->sn_pr_child);
1771 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1772 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1773 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1774 }
1775 }
1776}
1777
1778static proftime_T inchar_time;
1779
1780/*
1781 * Called when starting to wait for the user to type a character.
1782 */
1783 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001784prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001785{
1786 profile_start(&inchar_time);
1787}
1788
1789/*
1790 * Called when finished waiting for the user to type a character.
1791 */
1792 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001793prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001794{
1795 profile_end(&inchar_time);
1796 profile_add(&prof_wait_time, &inchar_time);
1797}
1798
1799/*
1800 * Dump the profiling results for all scripts in file "fd".
1801 */
1802 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001803script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001804{
1805 int id;
1806 scriptitem_T *si;
1807 int i;
1808 FILE *sfd;
1809 sn_prl_T *pp;
1810
1811 for (id = 1; id <= script_items.ga_len; ++id)
1812 {
1813 si = &SCRIPT_ITEM(id);
1814 if (si->sn_prof_on)
1815 {
1816 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1817 if (si->sn_pr_count == 1)
1818 fprintf(fd, "Sourced 1 time\n");
1819 else
1820 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1821 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1822 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1823 fprintf(fd, "\n");
1824 fprintf(fd, "count total (s) self (s)\n");
1825
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001826 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001827 if (sfd == NULL)
1828 fprintf(fd, "Cannot open file!\n");
1829 else
1830 {
Bram Moolenaar67435d92017-10-19 21:04:37 +02001831 /* Keep going till the end of file, so that trailing
1832 * continuation lines are listed. */
1833 for (i = 0; ; ++i)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001834 {
1835 if (vim_fgets(IObuff, IOSIZE, sfd))
1836 break;
Bram Moolenaar67435d92017-10-19 21:04:37 +02001837 if (i < si->sn_prl_ga.ga_len
1838 && (pp = &PRL_ITEM(si, i))->snp_count > 0)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001839 {
1840 fprintf(fd, "%5d ", pp->snp_count);
1841 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1842 fprintf(fd, " ");
1843 else
1844 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1845 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1846 }
1847 else
1848 fprintf(fd, " ");
1849 fprintf(fd, "%s", IObuff);
1850 }
1851 fclose(sfd);
1852 }
1853 fprintf(fd, "\n");
1854 }
1855 }
1856}
1857
1858/*
1859 * Return TRUE when a function defined in the current script should be
1860 * profiled.
1861 */
1862 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001863prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001864{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00001865 if (current_SID > 0)
1866 return SCRIPT_ITEM(current_SID).sn_pr_force;
1867 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001868}
1869
1870# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001871#endif
1872
1873/*
1874 * If 'autowrite' option set, try to write the file.
1875 * Careful: autocommands may make "buf" invalid!
1876 *
1877 * return FAIL for failure, OK otherwise
1878 */
1879 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001880autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881{
Bram Moolenaar373154b2007-02-13 05:19:30 +00001882 int r;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001883 bufref_T bufref;
Bram Moolenaar373154b2007-02-13 05:19:30 +00001884
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 if (!(p_aw || p_awa) || !p_write
1886#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00001887 /* never autowrite a "nofile" or "nowrite" buffer */
1888 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00001890 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 return FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001892 set_bufref(&bufref, buf);
Bram Moolenaar373154b2007-02-13 05:19:30 +00001893 r = buf_write_all(buf, forceit);
1894
1895 /* Writing may succeed but the buffer still changed, e.g., when there is a
1896 * conversion error. We do want to return FAIL then. */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001897 if (bufref_valid(&bufref) && bufIsChanged(buf))
Bram Moolenaar373154b2007-02-13 05:19:30 +00001898 r = FAIL;
1899 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001900}
1901
1902/*
1903 * flush all buffers, except the ones that are readonly
1904 */
1905 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001906autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907{
1908 buf_T *buf;
1909
1910 if (!(p_aw || p_awa) || !p_write)
1911 return;
Bram Moolenaar29323592016-07-24 22:04:11 +02001912 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 if (bufIsChanged(buf) && !buf->b_p_ro)
1914 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001915#ifdef FEAT_AUTOCMD
1916 bufref_T bufref;
1917
1918 set_bufref(&bufref, buf);
1919#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 (void)buf_write_all(buf, FALSE);
1921#ifdef FEAT_AUTOCMD
1922 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001923 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 buf = firstbuf;
1925#endif
1926 }
1927}
1928
1929/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001930 * Return TRUE if buffer was changed and cannot be abandoned.
1931 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001932 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001934check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935{
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001936 int forceit = (flags & CCGD_FORCEIT);
1937#ifdef FEAT_AUTOCMD
1938 bufref_T bufref;
1939
1940 set_bufref(&bufref, buf);
1941#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001942
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 if ( !forceit
1944 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001945 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
1946 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 {
1948#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1949 if ((p_confirm || cmdmod.confirm) && p_write)
1950 {
1951 buf_T *buf2;
1952 int count = 0;
1953
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001954 if (flags & CCGD_ALLBUF)
Bram Moolenaar29323592016-07-24 22:04:11 +02001955 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001956 if (bufIsChanged(buf2)
1957 && (buf2->b_ffname != NULL
1958# ifdef FEAT_BROWSE
1959 || cmdmod.browse
1960# endif
1961 ))
1962 ++count;
1963# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001964 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 /* Autocommand deleted buffer, oops! It's not changed now. */
1966 return FALSE;
1967# endif
1968 dialog_changed(buf, count > 1);
1969# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001970 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001971 /* Autocommand deleted buffer, oops! It's not changed now. */
1972 return FALSE;
1973# endif
1974 return bufIsChanged(buf);
1975 }
1976#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001977 if (flags & CCGD_EXCMD)
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02001978 no_write_message();
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001979 else
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02001980 no_write_message_nobang();
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 return TRUE;
1982 }
1983 return FALSE;
1984}
1985
1986#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
1987
1988#if defined(FEAT_BROWSE) || defined(PROTO)
1989/*
1990 * When wanting to write a file without a file name, ask the user for a name.
1991 */
1992 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001993browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994{
1995 if (buf->b_fname == NULL)
1996 {
1997 char_u *fname;
1998
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001999 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
2000 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 if (fname != NULL)
2002 {
2003 if (setfname(buf, fname, NULL, TRUE) == OK)
2004 buf->b_flags |= BF_NOTEDITED;
2005 vim_free(fname);
2006 }
2007 }
2008}
2009#endif
2010
2011/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02002012 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 * Must check 'write' option first!
2014 */
2015 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002016dialog_changed(
2017 buf_T *buf,
2018 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019{
Bram Moolenaard9462e32011-04-11 21:35:11 +02002020 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 int ret;
2022 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02002023 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024
Bram Moolenaar3f9a1ff2017-08-21 22:06:02 +02002025 dialog_msg(buff, _("Save changes to \"%s\"?"), buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 if (checkall)
2027 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
2028 else
2029 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
2030
Bram Moolenaar8218f602012-04-25 17:32:18 +02002031 /* Init ea pseudo-structure, this is needed for the check_overwrite()
2032 * function. */
2033 ea.append = ea.forceit = FALSE;
2034
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 if (ret == VIM_YES)
2036 {
2037#ifdef FEAT_BROWSE
2038 /* May get file name, when there is none */
2039 browse_save_fname(buf);
2040#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002041 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
2042 buf->b_fname, buf->b_ffname, FALSE) == OK)
2043 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 (void)buf_write_all(buf, FALSE);
2045 }
2046 else if (ret == VIM_NO)
2047 {
2048 unchanged(buf, TRUE);
2049 }
2050 else if (ret == VIM_ALL)
2051 {
2052 /*
2053 * Write all modified files that can be written.
2054 * Skip readonly buffers, these need to be confirmed
2055 * individually.
2056 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002057 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 {
2059 if (bufIsChanged(buf2)
2060 && (buf2->b_ffname != NULL
2061#ifdef FEAT_BROWSE
2062 || cmdmod.browse
2063#endif
2064 )
2065 && !buf2->b_p_ro)
2066 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002067#ifdef FEAT_AUTOCMD
2068 bufref_T bufref;
2069
2070 set_bufref(&bufref, buf2);
2071#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072#ifdef FEAT_BROWSE
2073 /* May get file name, when there is none */
2074 browse_save_fname(buf2);
2075#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002076 if (buf2->b_fname != NULL && check_overwrite(&ea, buf2,
2077 buf2->b_fname, buf2->b_ffname, FALSE) == OK)
2078 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 (void)buf_write_all(buf2, FALSE);
2080#ifdef FEAT_AUTOCMD
2081 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002082 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 buf2 = firstbuf;
2084#endif
2085 }
2086 }
2087 }
2088 else if (ret == VIM_DISCARDALL)
2089 {
2090 /*
2091 * mark all buffers as unchanged
2092 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002093 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 unchanged(buf2, TRUE);
2095 }
2096}
2097#endif
2098
2099/*
2100 * Return TRUE if the buffer "buf" can be abandoned, either by making it
2101 * hidden, autowriting it or unloading it.
2102 */
2103 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002104can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105{
Bram Moolenaareb44a682017-08-03 22:44:55 +02002106 return ( buf_hide(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 || !bufIsChanged(buf)
2108 || buf->b_nwindows > 1
2109 || autowrite(buf, forceit) == OK
2110 || forceit);
2111}
2112
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002113static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002114
2115/*
2116 * Add a buffer number to "bufnrs", unless it's already there.
2117 */
2118 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002119add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002120{
2121 int i;
2122
2123 for (i = 0; i < *bufnump; ++i)
2124 if (bufnrs[i] == nr)
2125 return;
2126 bufnrs[*bufnump] = nr;
2127 *bufnump = *bufnump + 1;
2128}
2129
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130/*
2131 * Return TRUE if any buffer was changed and cannot be abandoned.
2132 * That changed buffer becomes the current buffer.
Bram Moolenaar027387f2016-01-02 22:25:52 +01002133 * When "unload" is true the current buffer is unloaded instead of making it
2134 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 */
2136 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002137check_changed_any(
2138 int hidden, /* Only check hidden buffers */
2139 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002141 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 buf_T *buf;
2143 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002144 int i;
2145 int bufnum = 0;
2146 int bufcount = 0;
2147 int *bufnrs;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002148 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150
Bram Moolenaar29323592016-07-24 22:04:11 +02002151 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002152 ++bufcount;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002154 if (bufcount == 0)
2155 return FALSE;
2156
2157 bufnrs = (int *)alloc(sizeof(int) * bufcount);
2158 if (bufnrs == NULL)
2159 return FALSE;
2160
2161 /* curbuf */
2162 bufnrs[bufnum++] = curbuf->b_fnum;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002163 /* buf in curtab */
2164 FOR_ALL_WINDOWS(wp)
2165 if (wp->w_buffer != curbuf)
2166 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2167
2168 /* buf in other tab */
Bram Moolenaar29323592016-07-24 22:04:11 +02002169 FOR_ALL_TABPAGES(tp)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002170 if (tp != curtab)
2171 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
2172 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002173 /* any other buf */
Bram Moolenaar29323592016-07-24 22:04:11 +02002174 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002175 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
2176
2177 for (i = 0; i < bufnum; ++i)
2178 {
2179 buf = buflist_findnr(bufnrs[i]);
2180 if (buf == NULL)
2181 continue;
2182 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
2183 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002184 bufref_T bufref;
2185
2186 set_bufref(&bufref, buf);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002187 /* Try auto-writing the buffer. If this fails but the buffer no
2188 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002189 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
2190 | CCGD_MULTWIN
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002191 | CCGD_ALLBUF) && bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002192 break; /* didn't save - still changes */
2193 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 }
2195
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002196 if (i >= bufnum)
2197 goto theend;
2198
2199 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 exiting = FALSE;
2201#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2202 /*
2203 * When ":confirm" used, don't give an error message.
2204 */
2205 if (!(p_confirm || cmdmod.confirm))
2206#endif
2207 {
2208 /* There must be a wait_return for this message, do_buffer()
2209 * may cause a redraw. But wait_return() is a no-op when vgetc()
2210 * is busy (Quit used from window menu), then make sure we don't
2211 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00002212 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 {
2214 msg_row = cmdline_row;
2215 msg_col = 0;
2216 msg_didout = FALSE;
2217 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002218 if (
2219#ifdef FEAT_TERMINAL
2220 term_job_running(buf->b_term)
2221 ? EMSG2(_("E947: Job still running in buffer \"%s\""),
2222 buf->b_fname)
2223 :
2224#endif
2225 EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002226 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 {
2228 save = no_wait_return;
2229 no_wait_return = FALSE;
2230 wait_return(FALSE);
2231 no_wait_return = save;
2232 }
2233 }
2234
Bram Moolenaar071d4272004-06-13 20:20:40 +00002235 /* Try to find a window that contains the buffer. */
2236 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002237 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 if (wp->w_buffer == buf)
2239 {
Bram Moolenaar4033c552017-09-16 20:54:51 +02002240#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002241 bufref_T bufref;
2242
2243 set_bufref(&bufref, buf);
Bram Moolenaar4033c552017-09-16 20:54:51 +02002244#endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002245 goto_tabpage_win(tp, wp);
Bram Moolenaar4033c552017-09-16 20:54:51 +02002246#ifdef FEAT_AUTOCMD
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 /* Paranoia: did autocms wipe out the buffer with changes? */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002248 if (!bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002249 {
2250 goto theend;
2251 }
Bram Moolenaar4033c552017-09-16 20:54:51 +02002252#endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002253 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002255buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256
2257 /* Open the changed buffer in the current window. */
2258 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002259 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002260
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002261theend:
2262 vim_free(bufnrs);
2263 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264}
2265
2266/*
2267 * return FAIL if there is no file name, OK if there is one
2268 * give error message for FAIL
2269 */
2270 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002271check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272{
2273 if (curbuf->b_ffname == NULL)
2274 {
2275 EMSG(_(e_noname));
2276 return FAIL;
2277 }
2278 return OK;
2279}
2280
2281/*
2282 * flush the contents of a buffer, unless it has no file name
2283 *
2284 * return FAIL for failure, OK otherwise
2285 */
2286 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002287buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288{
2289 int retval;
2290#ifdef FEAT_AUTOCMD
2291 buf_T *old_curbuf = curbuf;
2292#endif
2293
2294 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2295 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2296 FALSE, forceit, TRUE, FALSE));
2297#ifdef FEAT_AUTOCMD
2298 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002299 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01002300 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002301 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002302 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303#endif
2304 return retval;
2305}
2306
2307/*
2308 * Code to handle the argument list.
2309 */
2310
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002311static char_u *do_one_arg(char_u *str);
2312static int do_arglist(char_u *str, int what, int after);
2313static void alist_check_arg_idx(void);
2314static int editing_arg_idx(win_T *win);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002315#ifdef FEAT_LISTCMDS
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002316static int alist_add_list(int count, char_u **files, int after);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002317#endif
2318#define AL_SET 1
2319#define AL_ADD 2
2320#define AL_DEL 3
2321
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002323 * Isolate one argument, taking backticks.
2324 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002325 * Return a pointer to the start of the next argument.
2326 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002327 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002328do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329{
2330 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 int inbacktick;
2332
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 inbacktick = FALSE;
2334 for (p = str; *str; ++str)
2335 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002336 /* When the backslash is used for escaping the special meaning of a
2337 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 if (rem_backslash(str))
2339 {
2340 *p++ = *str++;
2341 *p++ = *str;
2342 }
2343 else
2344 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002345 /* An item ends at a space not in backticks */
2346 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002348 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002350 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002351 }
2352 }
2353 str = skipwhite(str);
2354 *p = NUL;
2355
2356 return str;
2357}
2358
Bram Moolenaar86b68352004-12-27 21:59:20 +00002359/*
2360 * Separate the arguments in "str" and return a list of pointers in the
2361 * growarray "gap".
2362 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002363 static int
2364get_arglist(garray_T *gap, char_u *str, int escaped)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002365{
2366 ga_init2(gap, (int)sizeof(char_u *), 20);
2367 while (*str != NUL)
2368 {
2369 if (ga_grow(gap, 1) == FAIL)
2370 {
2371 ga_clear(gap);
2372 return FAIL;
2373 }
2374 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2375
Bram Moolenaar398ee732017-08-03 14:29:14 +02002376 /* If str is escaped, don't handle backslashes or spaces */
2377 if (!escaped)
2378 return OK;
2379
Bram Moolenaar86b68352004-12-27 21:59:20 +00002380 /* Isolate one argument, change it in-place, put a NUL after it. */
2381 str = do_one_arg(str);
2382 }
2383 return OK;
2384}
2385
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002386#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002387/*
2388 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002389 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002390 * Return FAIL or OK.
2391 */
2392 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002393get_arglist_exp(
2394 char_u *str,
2395 int *fcountp,
2396 char_u ***fnamesp,
2397 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002398{
2399 garray_T ga;
2400 int i;
2401
Bram Moolenaar398ee732017-08-03 14:29:14 +02002402 if (get_arglist(&ga, str, TRUE) == FAIL)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002403 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002404 if (wig == TRUE)
2405 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2406 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2407 else
2408 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2409 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2410
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002411 ga_clear(&ga);
2412 return i;
2413}
2414#endif
2415
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
2417/*
2418 * Redefine the argument list.
2419 */
2420 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002421set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422{
2423 do_arglist(str, AL_SET, 0);
2424}
2425#endif
2426
2427/*
2428 * "what" == AL_SET: Redefine the argument list to 'str'.
2429 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2430 * "what" == AL_DEL: remove files in 'str' from the argument list.
2431 *
2432 * Return FAIL for failure, OK otherwise.
2433 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002435do_arglist(
2436 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002437 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002438 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439{
2440 garray_T new_ga;
2441 int exp_count;
2442 char_u **exp_files;
2443 int i;
2444#ifdef FEAT_LISTCMDS
2445 char_u *p;
2446 int match;
2447#endif
Bram Moolenaar398ee732017-08-03 14:29:14 +02002448 int arg_escaped = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449
2450 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002451 * Set default argument for ":argadd" command.
2452 */
2453 if (what == AL_ADD && *str == NUL)
2454 {
2455 if (curbuf->b_ffname == NULL)
2456 return FAIL;
2457 str = curbuf->b_fname;
Bram Moolenaar398ee732017-08-03 14:29:14 +02002458 arg_escaped = FALSE;
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002459 }
2460
2461 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 * Collect all file name arguments in "new_ga".
2463 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002464 if (get_arglist(&new_ga, str, arg_escaped) == FAIL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002465 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466
2467#ifdef FEAT_LISTCMDS
2468 if (what == AL_DEL)
2469 {
2470 regmatch_T regmatch;
2471 int didone;
2472
2473 /*
2474 * Delete the items: use each item as a regexp and find a match in the
2475 * argument list.
2476 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002477 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002478 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2479 {
2480 p = ((char_u **)new_ga.ga_data)[i];
2481 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2482 if (p == NULL)
2483 break;
2484 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2485 if (regmatch.regprog == NULL)
2486 {
2487 vim_free(p);
2488 break;
2489 }
2490
2491 didone = FALSE;
2492 for (match = 0; match < ARGCOUNT; ++match)
2493 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2494 (colnr_T)0))
2495 {
2496 didone = TRUE;
2497 vim_free(ARGLIST[match].ae_fname);
2498 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2499 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2500 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 if (curwin->w_arg_idx > match)
2502 --curwin->w_arg_idx;
2503 --match;
2504 }
2505
Bram Moolenaar473de612013-06-08 18:19:48 +02002506 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507 vim_free(p);
2508 if (!didone)
2509 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2510 }
2511 ga_clear(&new_ga);
2512 }
2513 else
2514#endif
2515 {
2516 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2517 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2518 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002519 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 {
2521 EMSG(_(e_nomatch));
2522 return FAIL;
2523 }
2524
2525#ifdef FEAT_LISTCMDS
2526 if (what == AL_ADD)
2527 {
2528 (void)alist_add_list(exp_count, exp_files, after);
2529 vim_free(exp_files);
2530 }
2531 else /* what == AL_SET */
2532#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00002533 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 }
2535
2536 alist_check_arg_idx();
2537
2538 return OK;
2539}
2540
2541/*
2542 * Check the validity of the arg_idx for each other window.
2543 */
2544 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002545alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002548 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549
Bram Moolenaarf740b292006-02-16 22:11:02 +00002550 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 if (win->w_alist == curwin->w_alist)
2552 check_arg_idx(win);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553}
2554
2555/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002556 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002557 * index.
2558 */
2559 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002560editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002561{
2562 return !(win->w_arg_idx >= WARGCOUNT(win)
2563 || (win->w_buffer->b_fnum
2564 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2565 && (win->w_buffer->b_ffname == NULL
2566 || !(fullpathcmp(
2567 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2568 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2569}
2570
2571/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 * Check if window "win" is editing the w_arg_idx file in its argument list.
2573 */
2574 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002575check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002577 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 {
2579 /* We are not editing the current entry in the argument list.
2580 * Set "arg_had_last" if we are editing the last one. */
2581 win->w_arg_idx_invalid = TRUE;
2582 if (win->w_arg_idx != WARGCOUNT(win) - 1
2583 && arg_had_last == FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 && ALIST(win) == &global_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585 && GARGCOUNT > 0
2586 && win->w_arg_idx < GARGCOUNT
2587 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2588 || (win->w_buffer->b_ffname != NULL
2589 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2590 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2591 arg_had_last = TRUE;
2592 }
2593 else
2594 {
2595 /* We are editing the current entry in the argument list.
2596 * Set "arg_had_last" if it's also the last one */
2597 win->w_arg_idx_invalid = FALSE;
2598 if (win->w_arg_idx == WARGCOUNT(win) - 1
Bram Moolenaar4033c552017-09-16 20:54:51 +02002599 && win->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 arg_had_last = TRUE;
2601 }
2602}
2603
2604/*
2605 * ":args", ":argslocal" and ":argsglobal".
2606 */
2607 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002608ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609{
2610 int i;
2611
2612 if (eap->cmdidx != CMD_args)
2613 {
Bram Moolenaar4033c552017-09-16 20:54:51 +02002614#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002615 alist_unlink(ALIST(curwin));
2616 if (eap->cmdidx == CMD_argglobal)
2617 ALIST(curwin) = &global_alist;
2618 else /* eap->cmdidx == CMD_arglocal */
2619 alist_new();
2620#else
2621 ex_ni(eap);
2622 return;
2623#endif
2624 }
2625
2626 if (!ends_excmd(*eap->arg))
2627 {
2628 /*
2629 * ":args file ..": define new argument list, handle like ":next"
2630 * Also for ":argslocal file .." and ":argsglobal file ..".
2631 */
2632 ex_next(eap);
2633 }
2634 else
Bram Moolenaar4033c552017-09-16 20:54:51 +02002635#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 if (eap->cmdidx == CMD_args)
2637#endif
2638 {
2639 /*
2640 * ":args": list arguments.
2641 */
2642 if (ARGCOUNT > 0)
2643 {
2644 /* Overwrite the command, for a short list there is no scrolling
2645 * required and no wait_return(). */
2646 gotocmdline(TRUE);
2647 for (i = 0; i < ARGCOUNT; ++i)
2648 {
2649 if (i == curwin->w_arg_idx)
2650 msg_putchar('[');
2651 msg_outtrans(alist_name(&ARGLIST[i]));
2652 if (i == curwin->w_arg_idx)
2653 msg_putchar(']');
2654 msg_putchar(' ');
2655 }
2656 }
2657 }
Bram Moolenaar4033c552017-09-16 20:54:51 +02002658#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659 else if (eap->cmdidx == CMD_arglocal)
2660 {
2661 garray_T *gap = &curwin->w_alist->al_ga;
2662
2663 /*
2664 * ":argslocal": make a local copy of the global argument list.
2665 */
2666 if (ga_grow(gap, GARGCOUNT) == OK)
2667 for (i = 0; i < GARGCOUNT; ++i)
2668 if (GARGLIST[i].ae_fname != NULL)
2669 {
2670 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2671 vim_strsave(GARGLIST[i].ae_fname);
2672 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2673 GARGLIST[i].ae_fnum;
2674 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 }
2676 }
2677#endif
2678}
2679
2680/*
2681 * ":previous", ":sprevious", ":Next" and ":sNext".
2682 */
2683 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002684ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685{
2686 /* If past the last one already, go to the last one. */
2687 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2688 do_argfile(eap, ARGCOUNT - 1);
2689 else
2690 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2691}
2692
2693/*
2694 * ":rewind", ":first", ":sfirst" and ":srewind".
2695 */
2696 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002697ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698{
2699 do_argfile(eap, 0);
2700}
2701
2702/*
2703 * ":last" and ":slast".
2704 */
2705 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002706ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707{
2708 do_argfile(eap, ARGCOUNT - 1);
2709}
2710
2711/*
2712 * ":argument" and ":sargument".
2713 */
2714 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002715ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716{
2717 int i;
2718
2719 if (eap->addr_count > 0)
2720 i = eap->line2 - 1;
2721 else
2722 i = curwin->w_arg_idx;
2723 do_argfile(eap, i);
2724}
2725
2726/*
2727 * Edit file "argn" of the argument lists.
2728 */
2729 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002730do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731{
2732 int other;
2733 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002734 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735
2736 if (argn < 0 || argn >= ARGCOUNT)
2737 {
2738 if (ARGCOUNT <= 1)
2739 EMSG(_("E163: There is only one file to edit"));
2740 else if (argn < 0)
2741 EMSG(_("E164: Cannot go before first file"));
2742 else
2743 EMSG(_("E165: Cannot go beyond last file"));
2744 }
2745 else
2746 {
2747 setpcmark();
2748#ifdef FEAT_GUI
2749 need_mouse_correct = TRUE;
2750#endif
2751
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002752 /* split window or create new tab page first */
2753 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 {
2755 if (win_split(0, 0) == FAIL)
2756 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002757 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002758 }
2759 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 {
2761 /*
2762 * if 'hidden' set, only check for changed file when re-editing
2763 * the same buffer
2764 */
2765 other = TRUE;
Bram Moolenaareb44a682017-08-03 22:44:55 +02002766 if (buf_hide(curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 {
2768 p = fix_fname(alist_name(&ARGLIST[argn]));
2769 other = otherfile(p);
2770 vim_free(p);
2771 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002772 if ((!buf_hide(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002773 && check_changed(curbuf, CCGD_AW
2774 | (other ? 0 : CCGD_MULTWIN)
2775 | (eap->forceit ? CCGD_FORCEIT : 0)
2776 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002777 return;
2778 }
2779
2780 curwin->w_arg_idx = argn;
Bram Moolenaar4033c552017-09-16 20:54:51 +02002781 if (argn == ARGCOUNT - 1 && curwin->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 arg_had_last = TRUE;
2783
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002784 /* Edit the file; always use the last known line number.
2785 * When it fails (e.g. Abort for already edited file) restore the
2786 * argument index. */
2787 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 eap, ECMD_LAST,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002789 (buf_hide(curwin->w_buffer) ? ECMD_HIDE : 0)
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002790 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002791 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002793 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 setmark('\'');
2795 }
2796}
2797
2798/*
2799 * ":next", and commands that behave like it.
2800 */
2801 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002802ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803{
2804 int i;
2805
2806 /*
2807 * check for changed buffer now, if this fails the argument list is not
2808 * redefined.
2809 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002810 if ( buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002812 || !check_changed(curbuf, CCGD_AW
2813 | (eap->forceit ? CCGD_FORCEIT : 0)
2814 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 {
2816 if (*eap->arg != NUL) /* redefine file list */
2817 {
2818 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2819 return;
2820 i = 0;
2821 }
2822 else
2823 i = curwin->w_arg_idx + (int)eap->line2;
2824 do_argfile(eap, i);
2825 }
2826}
2827
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002828#if defined(FEAT_LISTCMDS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829/*
2830 * ":argedit"
2831 */
2832 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002833ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834{
Bram Moolenaar90305c62017-07-16 15:31:17 +02002835 int i = eap->addr_count ? (int)eap->line2 : curwin->w_arg_idx + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002836
Bram Moolenaar90305c62017-07-16 15:31:17 +02002837 if (do_arglist(eap->arg, AL_ADD, i) == FAIL)
2838 return;
2839#ifdef FEAT_TITLE
2840 maketitle();
2841#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842
Bram Moolenaar90305c62017-07-16 15:31:17 +02002843 if (curwin->w_arg_idx == 0 && (curbuf->b_ml.ml_flags & ML_EMPTY)
2844 && curbuf->b_ffname == NULL)
2845 i = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 /* Edit the argument. */
Bram Moolenaar90305c62017-07-16 15:31:17 +02002847 if (i < ARGCOUNT)
2848 do_argfile(eap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849}
2850
2851/*
2852 * ":argadd"
2853 */
2854 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002855ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856{
2857 do_arglist(eap->arg, AL_ADD,
2858 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2859#ifdef FEAT_TITLE
2860 maketitle();
2861#endif
2862}
2863
2864/*
2865 * ":argdelete"
2866 */
2867 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002868ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869{
2870 int i;
2871 int n;
2872
2873 if (eap->addr_count > 0)
2874 {
2875 /* ":1,4argdel": Delete all arguments in the range. */
2876 if (eap->line2 > ARGCOUNT)
2877 eap->line2 = ARGCOUNT;
2878 n = eap->line2 - eap->line1 + 1;
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01002879 if (*eap->arg != NUL)
2880 /* Can't have both a range and an argument. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 EMSG(_(e_invarg));
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01002882 else if (n <= 0)
2883 {
2884 /* Don't give an error for ":%argdel" if the list is empty. */
2885 if (eap->line1 != 1 || eap->line2 != 0)
2886 EMSG(_(e_invrange));
2887 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 else
2889 {
2890 for (i = eap->line1; i <= eap->line2; ++i)
2891 vim_free(ARGLIST[i - 1].ae_fname);
2892 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
2893 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
2894 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 if (curwin->w_arg_idx >= eap->line2)
2896 curwin->w_arg_idx -= n;
2897 else if (curwin->w_arg_idx > eap->line1)
2898 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01002899 if (ARGCOUNT == 0)
2900 curwin->w_arg_idx = 0;
2901 else if (curwin->w_arg_idx >= ARGCOUNT)
2902 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 }
2904 }
2905 else if (*eap->arg == NUL)
2906 EMSG(_(e_argreq));
2907 else
2908 do_arglist(eap->arg, AL_DEL, 0);
2909#ifdef FEAT_TITLE
2910 maketitle();
2911#endif
2912}
2913
2914/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002915 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 */
2917 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002918ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919{
2920 int i;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002921 win_T *wp;
2922 tabpage_T *tp;
Bram Moolenaare25bb902015-02-27 20:33:37 +01002923 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 int next_fnum = 0;
2925#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
2926 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002928 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002929#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02002930 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002931 int qf_idx;
2932#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002934#ifndef FEAT_QUICKFIX
2935 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
2936 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2937 {
2938 ex_ni(eap);
2939 return;
2940 }
2941#endif
2942
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002944 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00002945 /* Don't do syntax HL autocommands. Skipping the syntax file is a
2946 * great speed improvement. */
2947 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02002949#ifdef FEAT_CLIPBOARD
2950 start_global_changes();
2951#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952
2953 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002954 || eap->cmdidx == CMD_tabdo
Bram Moolenaareb44a682017-08-03 22:44:55 +02002955 || buf_hide(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002956 || !check_changed(curbuf, CCGD_AW
2957 | (eap->forceit ? CCGD_FORCEIT : 0)
2958 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002961 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002962 wp = firstwin;
2963 tp = first_tabpage;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002964 switch (eap->cmdidx)
2965 {
Bram Moolenaara162bc52015-01-07 16:54:21 +01002966 case CMD_windo:
2967 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
2968 i++;
2969 break;
2970 case CMD_tabdo:
2971 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
2972 i++;
2973 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002974 case CMD_argdo:
2975 i = eap->line1 - 1;
2976 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002977 default:
2978 break;
2979 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 /* set pcmark now */
2981 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002982 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01002983 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002984 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01002985 || !buf->b_p_bl); buf = buf->b_next)
2986 if (buf->b_fnum > eap->line2)
2987 {
2988 buf = NULL;
2989 break;
2990 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002991 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01002992 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002993 }
2994#ifdef FEAT_QUICKFIX
2995 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
2996 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2997 {
2998 qf_size = qf_get_size(eap);
2999 if (qf_size <= 0 || eap->line1 > qf_size)
3000 buf = NULL;
3001 else
3002 {
3003 ex_cc(eap);
3004
3005 buf = curbuf;
3006 i = eap->line1 - 1;
3007 if (eap->addr_count <= 0)
3008 /* default is all the quickfix/location list entries */
3009 eap->line2 = qf_size;
3010 }
3011 }
3012#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003013 else
3014 setpcmark();
3015 listcmd_busy = TRUE; /* avoids setting pcmark below */
3016
Bram Moolenaare25bb902015-02-27 20:33:37 +01003017 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 {
3019 if (eap->cmdidx == CMD_argdo)
3020 {
3021 /* go to argument "i" */
3022 if (i == ARGCOUNT)
3023 break;
3024 /* Don't call do_argfile() when already there, it will try
3025 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003026 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003027 {
3028 /* Clear 'shm' to avoid that the file message overwrites
3029 * any output from the command. */
3030 p_shm_save = vim_strsave(p_shm);
3031 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003033 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3034 vim_free(p_shm_save);
3035 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 if (curwin->w_arg_idx != i)
3037 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003038 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 else if (eap->cmdidx == CMD_windo)
3040 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003041 /* go to window "wp" */
3042 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003043 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003044 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00003045 if (curwin != wp)
3046 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003047 wp = curwin->w_next;
3048 }
3049 else if (eap->cmdidx == CMD_tabdo)
3050 {
3051 /* go to window "tp" */
3052 if (!valid_tabpage(tp))
3053 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02003054 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003055 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003056 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 else if (eap->cmdidx == CMD_bufdo)
3058 {
3059 /* Remember the number of the next listed buffer, in case
3060 * ":bwipe" is used or autocommands do something strange. */
3061 next_fnum = -1;
3062 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
3063 if (buf->b_p_bl)
3064 {
3065 next_fnum = buf->b_fnum;
3066 break;
3067 }
3068 }
3069
Bram Moolenaara162bc52015-01-07 16:54:21 +01003070 ++i;
3071
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072 /* execute the command */
3073 do_cmdline(eap->arg, eap->getline, eap->cookie,
3074 DOCMD_VERBOSE + DOCMD_NOWAIT);
3075
3076 if (eap->cmdidx == CMD_bufdo)
3077 {
3078 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01003079 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 break;
3081 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02003082 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 if (buf->b_fnum == next_fnum)
3084 break;
3085 if (buf == NULL)
3086 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003087
3088 /* Go to the next buffer. Clear 'shm' to avoid that the file
3089 * message overwrites any output from the command. */
3090 p_shm_save = vim_strsave(p_shm);
3091 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003092 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003093 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3094 vim_free(p_shm_save);
3095
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003096 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 if (curbuf->b_fnum != next_fnum)
3098 break;
3099 }
3100
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003101#ifdef FEAT_QUICKFIX
3102 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3103 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3104 {
3105 if (i >= qf_size || i >= eap->line2)
3106 break;
3107
3108 qf_idx = qf_get_cur_idx(eap);
3109
3110 ex_cnext(eap);
3111
3112 /* If jumping to the next quickfix entry fails, quit here */
3113 if (qf_get_cur_idx(eap) == qf_idx)
3114 break;
3115 }
3116#endif
3117
Bram Moolenaar071d4272004-06-13 20:20:40 +00003118 if (eap->cmdidx == CMD_windo)
3119 {
3120 validate_cursor(); /* cursor may have moved */
3121#ifdef FEAT_SCROLLBIND
3122 /* required when 'scrollbind' has been set */
3123 if (curwin->w_p_scb)
3124 do_check_scrollbind(TRUE);
3125#endif
3126 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01003127
Bram Moolenaara162bc52015-01-07 16:54:21 +01003128 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
3129 if (i+1 > eap->line2)
3130 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003131 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
3132 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 }
3134 listcmd_busy = FALSE;
3135 }
3136
3137#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003138 if (save_ei != NULL)
3139 {
3140 au_event_restore(save_ei);
3141 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
3142 curbuf->b_fname, TRUE, curbuf);
3143 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003145#ifdef FEAT_CLIPBOARD
3146 end_global_changes();
3147#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148}
3149
3150/*
3151 * Add files[count] to the arglist of the current window after arg "after".
3152 * The file names in files[count] must have been allocated and are taken over.
3153 * Files[] itself is not taken over.
3154 * Returns index of first added argument. Returns -1 when failed (out of mem).
3155 */
3156 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003157alist_add_list(
3158 int count,
3159 char_u **files,
3160 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161{
3162 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003163 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164
3165 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3166 {
3167 if (after < 0)
3168 after = 0;
3169 if (after > ARGCOUNT)
3170 after = ARGCOUNT;
3171 if (after < ARGCOUNT)
3172 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3173 (ARGCOUNT - after) * sizeof(aentry_T));
3174 for (i = 0; i < count; ++i)
3175 {
3176 ARGLIST[after + i].ae_fname = files[i];
3177 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
3178 }
3179 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003180 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3181 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 return after;
3183 }
3184
3185 for (i = 0; i < count; ++i)
3186 vim_free(files[i]);
3187 return -1;
3188}
3189
3190#endif /* FEAT_LISTCMDS */
3191
3192#ifdef FEAT_EVAL
3193/*
3194 * ":compiler[!] {name}"
3195 */
3196 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003197ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198{
3199 char_u *buf;
3200 char_u *old_cur_comp = NULL;
3201 char_u *p;
3202
3203 if (*eap->arg == NUL)
3204 {
3205 /* List all compiler scripts. */
3206 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3207 /* ) keep the indenter happy... */
3208 }
3209 else
3210 {
3211 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3212 if (buf != NULL)
3213 {
3214 if (eap->forceit)
3215 {
3216 /* ":compiler! {name}" sets global options */
3217 do_cmdline_cmd((char_u *)
3218 "command -nargs=* CompilerSet set <args>");
3219 }
3220 else
3221 {
3222 /* ":compiler! {name}" sets local options.
3223 * To remain backwards compatible "current_compiler" is always
3224 * used. A user's compiler plugin may set it, the distributed
3225 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003226 * "b:current_compiler" and restore "current_compiler".
3227 * Explicitly prepend "g:" to make it work in a function. */
3228 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 if (old_cur_comp != NULL)
3230 old_cur_comp = vim_strsave(old_cur_comp);
3231 do_cmdline_cmd((char_u *)
3232 "command -nargs=* CompilerSet setlocal <args>");
3233 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003234 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003235 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236
3237 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003238 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3240 vim_free(buf);
3241
3242 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3243
3244 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003245 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 if (p != NULL)
3247 set_internal_string_var((char_u *)"b:current_compiler", p);
3248
3249 /* Restore "current_compiler" for ":compiler {name}". */
3250 if (!eap->forceit)
3251 {
3252 if (old_cur_comp != NULL)
3253 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003254 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 old_cur_comp);
3256 vim_free(old_cur_comp);
3257 }
3258 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003259 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 }
3261 }
3262 }
3263}
3264#endif
3265
3266/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003267 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 */
3269 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003270ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003272 char_u *arg = eap->arg;
3273 char_u *p = skiptowhite(arg);
3274 int len = (int)(p - arg);
3275 int flags = eap->forceit ? DIP_ALL : 0;
3276
3277 if (STRNCMP(arg, "START", len) == 0)
3278 {
3279 flags += DIP_START + DIP_NORTP;
3280 arg = skipwhite(arg + len);
3281 }
3282 else if (STRNCMP(arg, "OPT", len) == 0)
3283 {
3284 flags += DIP_OPT + DIP_NORTP;
3285 arg = skipwhite(arg + len);
3286 }
3287 else if (STRNCMP(arg, "PACK", len) == 0)
3288 {
3289 flags += DIP_START + DIP_OPT + DIP_NORTP;
3290 arg = skipwhite(arg + len);
3291 }
3292 else if (STRNCMP(arg, "ALL", len) == 0)
3293 {
3294 flags += DIP_START + DIP_OPT;
3295 arg = skipwhite(arg + len);
3296 }
3297
3298 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299}
3300
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003302source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003304 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305}
3306
3307/*
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003308 * Find the file "name" in all directories in "path" and invoke
3309 * "callback(fname, cookie)".
3310 * "name" can contain wildcards.
3311 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3312 * When "flags" has DIP_DIR: find directories instead of files.
3313 * When "flags" has DIP_ERR: give an error message if there is no match.
3314 *
3315 * return FAIL when no file could be sourced, OK otherwise.
3316 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003317 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003318do_in_path(
3319 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003320 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003321 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003322 void (*callback)(char_u *fname, void *ck),
3323 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324{
3325 char_u *rtp;
3326 char_u *np;
3327 char_u *buf;
3328 char_u *rtp_copy;
3329 char_u *tail;
3330 int num_files;
3331 char_u **files;
3332 int i;
3333 int did_one = FALSE;
3334#ifdef AMIGA
3335 struct Process *proc = (struct Process *)FindTask(0L);
3336 APTR save_winptr = proc->pr_WindowPtr;
3337
3338 /* Avoid a requester here for a volume that doesn't exist. */
3339 proc->pr_WindowPtr = (APTR)-1L;
3340#endif
3341
3342 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3343 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003344 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 buf = alloc(MAXPATHL);
3346 if (buf != NULL && rtp_copy != NULL)
3347 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003348 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003349 {
3350 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003351 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003352 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003353 verbose_leave();
3354 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003355
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 /* Loop over all entries in 'runtimepath'. */
3357 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003358 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 {
Bram Moolenaar66459b72016-08-06 19:01:55 +02003360 size_t buflen;
3361
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 /* Copy the path from 'runtimepath' to buf[]. */
3363 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaar66459b72016-08-06 19:01:55 +02003364 buflen = STRLEN(buf);
3365
3366 /* Skip after or non-after directories. */
3367 if (flags & (DIP_NOAFTER | DIP_AFTER))
3368 {
3369 int is_after = buflen >= 5
3370 && STRCMP(buf + buflen - 5, "after") == 0;
3371
3372 if ((is_after && (flags & DIP_NOAFTER))
3373 || (!is_after && (flags & DIP_AFTER)))
3374 continue;
3375 }
3376
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003377 if (name == NULL)
3378 {
3379 (*callback)(buf, (void *) &cookie);
3380 if (!did_one)
3381 did_one = (cookie == NULL);
3382 }
Bram Moolenaar66459b72016-08-06 19:01:55 +02003383 else if (buflen + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 {
3385 add_pathsep(buf);
3386 tail = buf + STRLEN(buf);
3387
3388 /* Loop over all patterns in "name" */
3389 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003390 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 {
3392 /* Append the pattern from "name" to buf[]. */
3393 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3394 "\t ");
3395
3396 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003397 {
3398 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003399 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003400 verbose_leave();
3401 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402
3403 /* Expand wildcards, invoke the callback for each match. */
3404 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003405 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 {
3407 for (i = 0; i < num_files; ++i)
3408 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003409 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003411 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 break;
3413 }
3414 FreeWild(num_files, files);
3415 }
3416 }
3417 }
3418 }
3419 }
3420 vim_free(buf);
3421 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003422 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003423 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003424 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3425
3426 if (flags & DIP_ERR)
3427 EMSG3(_(e_dirnotf), basepath, name);
3428 else if (p_verbose > 0)
3429 {
3430 verbose_enter();
3431 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3432 verbose_leave();
3433 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003434 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435
3436#ifdef AMIGA
3437 proc->pr_WindowPtr = save_winptr;
3438#endif
3439
3440 return did_one ? OK : FAIL;
3441}
3442
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003443/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003444 * Find "name" in "path". When found, invoke the callback function for
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003445 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003446 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3447 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003448 * Returns OK when at least one match found, FAIL otherwise.
3449 *
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003450 * If "name" is NULL calls callback for each entry in "path". Cookie is
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003451 * passed by reference in this case, setting it to NULL indicates that callback
3452 * has done its job.
3453 */
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003454 static int
3455do_in_path_and_pp(
3456 char_u *path,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003457 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003458 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003459 void (*callback)(char_u *fname, void *ck),
3460 void *cookie)
3461{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003462 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003463 char_u *s;
3464 int len;
3465 char *start_dir = "pack/*/start/*/%s";
3466 char *opt_dir = "pack/*/opt/*/%s";
3467
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003468 if ((flags & DIP_NORTP) == 0)
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003469 done = do_in_path(path, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003470
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003471 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003472 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003473 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003474 s = alloc(len);
3475 if (s == NULL)
3476 return FAIL;
3477 vim_snprintf((char *)s, len, start_dir, name);
3478 done = do_in_path(p_pp, s, flags, callback, cookie);
3479 vim_free(s);
3480 }
3481
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003482 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003483 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003484 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003485 s = alloc(len);
3486 if (s == NULL)
3487 return FAIL;
3488 vim_snprintf((char *)s, len, opt_dir, name);
3489 done = do_in_path(p_pp, s, flags, callback, cookie);
3490 vim_free(s);
3491 }
3492
3493 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003494}
3495
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003496/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003497 * Just like do_in_path_and_pp(), using 'runtimepath' for "path".
3498 */
3499 int
3500do_in_runtimepath(
3501 char_u *name,
3502 int flags,
3503 void (*callback)(char_u *fname, void *ck),
3504 void *cookie)
3505{
3506 return do_in_path_and_pp(p_rtp, name, flags, callback, cookie);
3507}
3508
3509/*
3510 * Source the file "name" from all directories in 'runtimepath'.
3511 * "name" can contain wildcards.
3512 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3513 *
3514 * return FAIL when no file could be sourced, OK otherwise.
3515 */
3516 int
3517source_runtime(char_u *name, int flags)
3518{
3519 return source_in_path(p_rtp, name, flags);
3520}
3521
3522/*
3523 * Just like source_runtime(), but use "path" instead of 'runtimepath'.
3524 */
3525 int
3526source_in_path(char_u *path, char_u *name, int flags)
3527{
3528 return do_in_path_and_pp(path, name, flags, source_callback, NULL);
3529}
3530
3531
3532/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003533 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003534 */
3535 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003536source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003537{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003538 int num_files;
3539 char_u **files;
3540 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003541
Bram Moolenaarf3654822016-03-04 22:12:23 +01003542 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003543 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003544 for (i = 0; i < num_files; ++i)
3545 (void)do_source(files[i], FALSE, DOSO_NONE);
3546 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003547 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003548}
3549
Bram Moolenaar49b27322016-04-05 21:13:00 +02003550/* used for "cookie" of add_pack_plugin() */
3551static int APP_ADD_DIR;
3552static int APP_LOAD;
3553static int APP_BOTH;
3554
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003555 static void
Bram Moolenaar91715872016-03-03 17:13:03 +01003556add_pack_plugin(char_u *fname, void *cookie)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003557{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003558 char_u *p4, *p3, *p2, *p1, *p;
3559 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003560 int c;
3561 char_u *new_rtp;
3562 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003563 size_t oldlen;
3564 size_t addlen;
Bram Moolenaara5702442016-05-24 19:37:29 +02003565 char_u *afterdir;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003566 size_t afterlen = 0;
Bram Moolenaar91715872016-03-03 17:13:03 +01003567 char_u *ffname = fix_fname(fname);
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003568 size_t fname_len;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003569 char_u *buf = NULL;
3570 char_u *rtp_ffname;
3571 int match;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003572
Bram Moolenaar91715872016-03-03 17:13:03 +01003573 if (ffname == NULL)
3574 return;
Bram Moolenaar49b27322016-04-05 21:13:00 +02003575 if (cookie != &APP_LOAD && strstr((char *)p_rtp, (char *)ffname) == NULL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003576 {
Bram Moolenaara5702442016-05-24 19:37:29 +02003577 /* directory is not yet in 'runtimepath', add it */
Bram Moolenaarf3654822016-03-04 22:12:23 +01003578 p4 = p3 = p2 = p1 = get_past_head(ffname);
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003579 for (p = p1; *p; MB_PTR_ADV(p))
Bram Moolenaarf3654822016-03-04 22:12:23 +01003580 if (vim_ispathsep_nocolon(*p))
3581 {
3582 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3583 }
3584
3585 /* now we have:
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +01003586 * rtp/pack/name/start/name
3587 * p4 p3 p2 p1
Bram Moolenaarf3654822016-03-04 22:12:23 +01003588 *
3589 * find the part up to "pack" in 'runtimepath' */
3590 c = *p4;
3591 *p4 = NUL;
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003592
3593 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3594 fname_len = STRLEN(ffname);
3595 insp = p_rtp;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003596 buf = alloc(MAXPATHL);
3597 if (buf == NULL)
3598 goto theend;
3599 while (*insp != NUL)
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003600 {
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003601 copy_option_part(&insp, buf, MAXPATHL, ",");
3602 add_pathsep(buf);
3603 rtp_ffname = fix_fname(buf);
3604 if (rtp_ffname == NULL)
3605 goto theend;
3606 match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0;
3607 vim_free(rtp_ffname);
3608 if (match)
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003609 break;
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003610 }
3611
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003612 if (*insp == NUL)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003613 /* not found, append at the end */
3614 insp = p_rtp + STRLEN(p_rtp);
3615 else
Bram Moolenaarf3654822016-03-04 22:12:23 +01003616 /* append after the matching directory. */
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003617 --insp;
Bram Moolenaarf3654822016-03-04 22:12:23 +01003618 *p4 = c;
3619
Bram Moolenaara5702442016-05-24 19:37:29 +02003620 /* check if rtp/pack/name/start/name/after exists */
3621 afterdir = concat_fnames(ffname, (char_u *)"after", TRUE);
3622 if (afterdir != NULL && mch_isdir(afterdir))
3623 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3624
Bram Moolenaarb0550662016-05-31 21:37:36 +02003625 oldlen = STRLEN(p_rtp);
3626 addlen = STRLEN(ffname) + 1; /* add one for comma */
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003627 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1));
3628 /* add one for NUL */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003629 if (new_rtp == NULL)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003630 goto theend;
3631 keep = (int)(insp - p_rtp);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003632 mch_memmove(new_rtp, p_rtp, keep);
3633 new_rtp[keep] = ',';
Bram Moolenaara5702442016-05-24 19:37:29 +02003634 mch_memmove(new_rtp + keep + 1, ffname, addlen);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003635 if (p_rtp[keep] != NUL)
Bram Moolenaara5702442016-05-24 19:37:29 +02003636 mch_memmove(new_rtp + keep + addlen, p_rtp + keep,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003637 oldlen - keep + 1);
Bram Moolenaara5702442016-05-24 19:37:29 +02003638 if (afterlen > 0)
3639 {
3640 STRCAT(new_rtp, ",");
3641 STRCAT(new_rtp, afterdir);
3642 }
Bram Moolenaar863c1a92016-03-03 15:47:06 +01003643 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3644 vim_free(new_rtp);
Bram Moolenaara5702442016-05-24 19:37:29 +02003645 vim_free(afterdir);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003646 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003647
Bram Moolenaar49b27322016-04-05 21:13:00 +02003648 if (cookie != &APP_ADD_DIR)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003649 {
Bram Moolenaar71fb0c12016-04-02 22:44:16 +02003650 static char *plugpat = "%s/plugin/**/*.vim";
Bram Moolenaarf3654822016-03-04 22:12:23 +01003651 static char *ftpat = "%s/ftdetect/*.vim";
3652 int len;
3653 char_u *pat;
3654
3655 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3656 pat = alloc(len);
3657 if (pat == NULL)
3658 goto theend;
3659 vim_snprintf((char *)pat, len, plugpat, ffname);
3660 source_all_matches(pat);
3661
3662#ifdef FEAT_AUTOCMD
3663 {
3664 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3665
3666 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3667 * found when it loads. */
3668 if (cmd != NULL && eval_to_number(cmd) > 0)
3669 {
3670 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3671 vim_snprintf((char *)pat, len, ftpat, ffname);
3672 source_all_matches(pat);
3673 do_cmdline_cmd((char_u *)"augroup END");
3674 }
3675 vim_free(cmd);
3676 }
3677#endif
Bram Moolenaarba8cd122016-03-19 14:16:39 +01003678 vim_free(pat);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003679 }
3680
3681theend:
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003682 vim_free(buf);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003683 vim_free(ffname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003684}
3685
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003686/*
3687 * Add all packages in the "start" directory to 'runtimepath'.
3688 */
3689 void
3690add_pack_start_dirs(void)
3691{
3692 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3693 add_pack_plugin, &APP_ADD_DIR);
3694}
3695
3696/*
3697 * Load plugins from all packages in the "start" directory.
3698 */
3699 void
3700load_start_packages(void)
3701{
3702 did_source_packages = TRUE;
3703 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3704 add_pack_plugin, &APP_LOAD);
3705}
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003706
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003707/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003708 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003709 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003710 */
3711 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003712ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003713{
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003714 if (!did_source_packages || eap->forceit)
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003715 {
Bram Moolenaar49b27322016-04-05 21:13:00 +02003716 /* First do a round to add all directories to 'runtimepath', then load
3717 * the plugins. This allows for plugins to use an autoload directory
3718 * of another plugin. */
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003719 add_pack_start_dirs();
3720 load_start_packages();
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003721 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003722}
3723
3724/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003725 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003726 */
3727 void
3728ex_packadd(exarg_T *eap)
3729{
3730 static char *plugpat = "pack/*/opt/%s";
3731 int len;
3732 char *pat;
3733
3734 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg);
3735 pat = (char *)alloc(len);
3736 if (pat == NULL)
3737 return;
3738 vim_snprintf(pat, len, plugpat, eap->arg);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003739 do_in_path(p_pp, (char_u *)pat, DIP_ALL + DIP_DIR + DIP_ERR,
Bram Moolenaar49b27322016-04-05 21:13:00 +02003740 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
Bram Moolenaar91715872016-03-03 17:13:03 +01003741 vim_free(pat);
3742}
3743
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
3745/*
3746 * ":options"
3747 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003749ex_options(
3750 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751{
Bram Moolenaarab6c8582017-08-11 17:15:09 +02003752 vim_setenv((char_u *)"OPTWIN_CMD", (char_u *)(cmdmod.tab ? "tab" : ""));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3754}
3755#endif
3756
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003757#if defined(FEAT_PYTHON3) || defined(FEAT_PYTHON) || defined(PROTO)
3758
3759# if (defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)) || defined(PROTO)
3760/*
3761 * Detect Python 3 or 2, and initialize 'pyxversion'.
3762 */
3763 void
3764init_pyxversion(void)
3765{
3766 if (p_pyx == 0)
3767 {
3768 if (python3_enabled(FALSE))
3769 p_pyx = 3;
3770 else if (python_enabled(FALSE))
3771 p_pyx = 2;
3772 }
3773}
3774# endif
3775
3776/*
3777 * Does a file contain one of the following strings at the beginning of any
3778 * line?
3779 * "#!(any string)python2" => returns 2
3780 * "#!(any string)python3" => returns 3
3781 * "# requires python 2.x" => returns 2
3782 * "# requires python 3.x" => returns 3
3783 * otherwise return 0.
3784 */
3785 static int
3786requires_py_version(char_u *filename)
3787{
3788 FILE *file;
3789 int requires_py_version = 0;
3790 int i, lines;
3791
3792 lines = (int)p_mls;
3793 if (lines < 0)
3794 lines = 5;
3795
3796 file = mch_fopen((char *)filename, "r");
3797 if (file != NULL)
3798 {
3799 for (i = 0; i < lines; i++)
3800 {
3801 if (vim_fgets(IObuff, IOSIZE, file))
3802 break;
3803 if (i == 0 && IObuff[0] == '#' && IObuff[1] == '!')
3804 {
3805 /* Check shebang. */
3806 if (strstr((char *)IObuff + 2, "python2") != NULL)
3807 {
3808 requires_py_version = 2;
3809 break;
3810 }
3811 if (strstr((char *)IObuff + 2, "python3") != NULL)
3812 {
3813 requires_py_version = 3;
3814 break;
3815 }
3816 }
3817 IObuff[21] = '\0';
3818 if (STRCMP("# requires python 2.x", IObuff) == 0)
3819 {
3820 requires_py_version = 2;
3821 break;
3822 }
3823 if (STRCMP("# requires python 3.x", IObuff) == 0)
3824 {
3825 requires_py_version = 3;
3826 break;
3827 }
3828 }
3829 fclose(file);
3830 }
3831 return requires_py_version;
3832}
3833
3834
3835/*
3836 * Source a python file using the requested python version.
3837 */
3838 static void
3839source_pyx_file(exarg_T *eap, char_u *fname)
3840{
3841 exarg_T ex;
3842 int v = requires_py_version(fname);
3843
3844# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
3845 init_pyxversion();
3846# endif
3847 if (v == 0)
3848 {
3849# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
3850 /* user didn't choose a preference, 'pyx' is used */
3851 v = p_pyx;
3852# elif defined(FEAT_PYTHON)
3853 v = 2;
3854# elif defined(FEAT_PYTHON3)
3855 v = 3;
3856# endif
3857 }
3858
3859 /*
3860 * now source, if required python version is not supported show
3861 * unobtrusive message.
3862 */
3863 if (eap == NULL)
3864 vim_memset(&ex, 0, sizeof(ex));
3865 else
3866 ex = *eap;
3867 ex.arg = fname;
3868 ex.cmd = (char_u *)(v == 2 ? "pyfile" : "pyfile3");
3869
3870 if (v == 2)
3871 {
3872# ifdef FEAT_PYTHON
3873 ex_pyfile(&ex);
3874# else
3875 vim_snprintf((char *)IObuff, IOSIZE,
3876 _("W20: Required python version 2.x not supported, ignoring file: %s"),
3877 fname);
3878 MSG(IObuff);
3879# endif
3880 return;
3881 }
3882 else
3883 {
3884# ifdef FEAT_PYTHON3
3885 ex_py3file(&ex);
3886# else
3887 vim_snprintf((char *)IObuff, IOSIZE,
3888 _("W21: Required python version 3.x not supported, ignoring file: %s"),
3889 fname);
3890 MSG(IObuff);
3891# endif
3892 return;
3893 }
3894}
3895
3896/*
3897 * ":pyxfile {fname}"
3898 */
3899 void
3900ex_pyxfile(exarg_T *eap)
3901{
3902 source_pyx_file(eap, eap->arg);
3903}
3904
3905/*
3906 * ":pyx"
3907 */
3908 void
3909ex_pyx(exarg_T *eap)
3910{
3911# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
3912 init_pyxversion();
3913 if (p_pyx == 2)
3914 ex_python(eap);
3915 else
3916 ex_py3(eap);
3917# elif defined(FEAT_PYTHON)
3918 ex_python(eap);
3919# elif defined(FEAT_PYTHON3)
3920 ex_py3(eap);
3921# endif
3922}
3923
3924/*
3925 * ":pyxdo"
3926 */
3927 void
3928ex_pyxdo(exarg_T *eap)
3929{
3930# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
3931 init_pyxversion();
3932 if (p_pyx == 2)
3933 ex_pydo(eap);
3934 else
3935 ex_py3do(eap);
3936# elif defined(FEAT_PYTHON)
3937 ex_pydo(eap);
3938# elif defined(FEAT_PYTHON3)
3939 ex_py3do(eap);
3940# endif
3941}
3942
3943#endif
3944
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945/*
3946 * ":source {fname}"
3947 */
3948 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003949ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950{
3951#ifdef FEAT_BROWSE
3952 if (cmdmod.browse)
3953 {
3954 char_u *fname = NULL;
3955
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003956 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
3958 if (fname != NULL)
3959 {
3960 cmd_source(fname, eap);
3961 vim_free(fname);
3962 }
3963 }
3964 else
3965#endif
3966 cmd_source(eap->arg, eap);
3967}
3968
3969 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003970cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971{
3972 if (*fname == NUL)
3973 EMSG(_(e_argreq));
3974
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02003976 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003977 * Need to execute the commands directly. This is required at least
3978 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 * - ":g" command busy
3980 * - after ":argdo", ":windo" or ":bufdo"
3981 * - another command follows
3982 * - inside a loop
3983 */
3984 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
3985#ifdef FEAT_EVAL
3986 || eap->cstack->cs_idx >= 0
3987#endif
3988 );
3989
3990 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003991 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 EMSG2(_(e_notopen), fname);
3993}
3994
3995/*
3996 * ":source" and associated commands.
3997 */
3998/*
3999 * Structure used to store info for each sourced file.
4000 * It is shared between do_source() and getsourceline().
4001 * This is required, because it needs to be handed to do_cmdline() and
4002 * sourcing can be done recursively.
4003 */
4004struct source_cookie
4005{
4006 FILE *fp; /* opened file for sourcing */
4007 char_u *nextline; /* if not NULL: line that was read ahead */
4008 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004009#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
4011 int error; /* TRUE if LF found after CR-LF */
4012#endif
4013#ifdef FEAT_EVAL
4014 linenr_T breakpoint; /* next line with breakpoint or zero */
4015 char_u *fname; /* name of sourced file */
4016 int dbg_tick; /* debug_tick when breakpoint was set */
4017 int level; /* top nesting level of sourced file */
4018#endif
4019#ifdef FEAT_MBYTE
4020 vimconv_T conv; /* type of conversion */
4021#endif
4022};
4023
4024#ifdef FEAT_EVAL
4025/*
4026 * Return the address holding the next breakpoint line for a source cookie.
4027 */
4028 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004029source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030{
4031 return &((struct source_cookie *)cookie)->breakpoint;
4032}
4033
4034/*
4035 * Return the address holding the debug tick for a source cookie.
4036 */
4037 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004038source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039{
4040 return &((struct source_cookie *)cookie)->dbg_tick;
4041}
4042
4043/*
4044 * Return the nesting level for a source cookie.
4045 */
4046 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004047source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048{
4049 return ((struct source_cookie *)cookie)->level;
4050}
4051#endif
4052
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004053static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004055#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
4056# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004057static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058
4059/*
4060 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004061 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 */
4063 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004064fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004066# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01004067 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
4068# else
4069 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004070# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071
4072 if (fd_tmp == -1)
4073 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004074
4075# ifdef HAVE_FD_CLOEXEC
4076 {
4077 int fdflags = fcntl(fd_tmp, F_GETFD);
4078 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02004079 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004080 }
4081# endif
4082
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 return fdopen(fd_tmp, READBIN);
4084}
4085#endif
4086
4087
4088/*
4089 * do_source: Read the file "fname" and execute its lines as EX commands.
4090 *
4091 * This function may be called recursively!
4092 *
4093 * return FAIL if file could not be opened, OK otherwise
4094 */
4095 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004096do_source(
4097 char_u *fname,
4098 int check_other, /* check for .vimrc and _vimrc */
4099 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100{
4101 struct source_cookie cookie;
4102 char_u *save_sourcing_name;
4103 linenr_T save_sourcing_lnum;
4104 char_u *p;
4105 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00004106 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 int retval = FAIL;
4108#ifdef FEAT_EVAL
4109 scid_T save_current_SID;
4110 static scid_T last_current_SID = 0;
4111 void *save_funccalp;
4112 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004113 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02004115 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 int stat_ok;
4117# endif
4118#endif
4119#ifdef STARTUPTIME
4120 struct timeval tv_rel;
4121 struct timeval tv_start;
4122#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004123#ifdef FEAT_PROFILE
4124 proftime_T wait_start;
4125#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 if (p == NULL)
4129 return retval;
4130 fname_exp = fix_fname(p);
4131 vim_free(p);
4132 if (fname_exp == NULL)
4133 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 if (mch_isdir(fname_exp))
4135 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00004136 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 goto theend;
4138 }
4139
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004140#ifdef FEAT_AUTOCMD
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004141 /* Apply SourceCmd autocommands, they should get the file and source it. */
4142 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
4143 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
4144 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004145 {
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004146# ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004147 retval = aborting() ? FAIL : OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004148# else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004149 retval = OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004150# endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004151 goto theend;
4152 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004153
4154 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004155 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
4156#endif
4157
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004158#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4160#else
4161 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4162#endif
4163 if (cookie.fp == NULL && check_other)
4164 {
4165 /*
4166 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
4167 * and ".exrc" by "_exrc" or vice versa.
4168 */
4169 p = gettail(fname_exp);
4170 if ((*p == '.' || *p == '_')
4171 && (STRICMP(p + 1, "vimrc") == 0
4172 || STRICMP(p + 1, "gvimrc") == 0
4173 || STRICMP(p + 1, "exrc") == 0))
4174 {
4175 if (*p == '_')
4176 *p = '.';
4177 else
4178 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004179#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4181#else
4182 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4183#endif
4184 }
4185 }
4186
4187 if (cookie.fp == NULL)
4188 {
4189 if (p_verbose > 0)
4190 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004191 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004193 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 else
4195 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004196 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004197 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 }
4199 goto theend;
4200 }
4201
4202 /*
4203 * The file exists.
4204 * - In verbose mode, give a message.
4205 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
4206 */
4207 if (p_verbose > 1)
4208 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004209 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004211 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 else
4213 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004214 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004215 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004217 if (is_vimrc == DOSO_VIMRC)
4218 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
4219 else if (is_vimrc == DOSO_GVIMRC)
4220 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221
4222#ifdef USE_CRNL
4223 /* If no automatic file format: Set default to CR-NL. */
4224 if (*p_ffs == NUL)
4225 cookie.fileformat = EOL_DOS;
4226 else
4227 cookie.fileformat = EOL_UNKNOWN;
4228 cookie.error = FALSE;
4229#endif
4230
4231#ifdef USE_CR
4232 /* If no automatic file format: Set default to CR. */
4233 if (*p_ffs == NUL)
4234 cookie.fileformat = EOL_MAC;
4235 else
4236 cookie.fileformat = EOL_UNKNOWN;
4237 cookie.error = FALSE;
4238#endif
4239
4240 cookie.nextline = NULL;
4241 cookie.finished = FALSE;
4242
4243#ifdef FEAT_EVAL
4244 /*
4245 * Check if this script has a breakpoint.
4246 */
4247 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
4248 cookie.fname = fname_exp;
4249 cookie.dbg_tick = debug_tick;
4250
4251 cookie.level = ex_nesting_level;
4252#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253
4254 /*
4255 * Keep the sourcing name/lnum, for recursive calls.
4256 */
4257 save_sourcing_name = sourcing_name;
4258 sourcing_name = fname_exp;
4259 save_sourcing_lnum = sourcing_lnum;
4260 sourcing_lnum = 0;
4261
4262#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004263 if (time_fd != NULL)
4264 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265#endif
4266
4267#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00004268# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004269 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004270 prof_child_enter(&wait_start); /* entering a child now */
4271# endif
4272
4273 /* Don't use local function variables, if called from a function.
4274 * Also starts profiling timer for nested script. */
4275 save_funccalp = save_funccal();
4276
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 /*
4278 * Check if this script was sourced before to finds its SID.
4279 * If it's new, generate a new SID.
4280 */
4281 save_current_SID = current_SID;
4282# ifdef UNIX
4283 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
4284# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004285 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
4286 {
4287 si = &SCRIPT_ITEM(current_SID);
4288 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 && (
4290# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00004291 /* Compare dev/ino when possible, it catches symbolic
4292 * links. Also compare file names, the inode may change
4293 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004294 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004295 && (si->sn_dev == st.st_dev
4296 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004298 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004300 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 if (current_SID == 0)
4302 {
4303 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004304 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
4305 == FAIL)
4306 goto almosttheend;
4307 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00004309 ++script_items.ga_len;
4310 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
4311# ifdef FEAT_PROFILE
4312 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004315 si = &SCRIPT_ITEM(current_SID);
4316 si->sn_name = fname_exp;
4317 fname_exp = NULL;
4318# ifdef UNIX
4319 if (stat_ok)
4320 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004321 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004322 si->sn_dev = st.st_dev;
4323 si->sn_ino = st.st_ino;
4324 }
4325 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004326 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004327# endif
4328
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 /* Allocate the local script variables to use for this script. */
4330 new_script_vars(current_SID);
4331 }
4332
Bram Moolenaar05159a02005-02-26 23:04:13 +00004333# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004334 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004335 {
4336 int forceit;
4337
4338 /* Check if we do profiling for this script. */
4339 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
4340 {
4341 script_do_profile(si);
4342 si->sn_pr_force = forceit;
4343 }
4344 if (si->sn_prof_on)
4345 {
4346 ++si->sn_pr_count;
4347 profile_start(&si->sn_pr_start);
4348 profile_zero(&si->sn_pr_children);
4349 }
4350 }
4351# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352#endif
4353
Bram Moolenaar67435d92017-10-19 21:04:37 +02004354#ifdef FEAT_MBYTE
4355 cookie.conv.vc_type = CONV_NONE; /* no conversion */
4356
4357 /* Read the first line so we can check for a UTF-8 BOM. */
4358 firstline = getsourceline(0, (void *)&cookie, 0);
4359 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
4360 && firstline[1] == 0xbb && firstline[2] == 0xbf)
4361 {
4362 /* Found BOM; setup conversion, skip over BOM and recode the line. */
4363 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
4364 p = string_convert(&cookie.conv, firstline + 3, NULL);
4365 if (p == NULL)
4366 p = vim_strsave(firstline + 3);
4367 if (p != NULL)
4368 {
4369 vim_free(firstline);
4370 firstline = p;
4371 }
4372 }
4373#endif
4374
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 /*
4376 * Call do_cmdline, which will call getsourceline() to get the lines.
4377 */
Bram Moolenaar73881402009-02-04 16:50:47 +00004378 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004381
4382#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004383 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004384 {
4385 /* Get "si" again, "script_items" may have been reallocated. */
4386 si = &SCRIPT_ITEM(current_SID);
4387 if (si->sn_prof_on)
4388 {
4389 profile_end(&si->sn_pr_start);
4390 profile_sub_wait(&wait_start, &si->sn_pr_start);
4391 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004392 profile_self(&si->sn_pr_self, &si->sn_pr_start,
4393 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004394 }
4395 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396#endif
4397
4398 if (got_int)
4399 EMSG(_(e_interr));
4400 sourcing_name = save_sourcing_name;
4401 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 if (p_verbose > 1)
4403 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004404 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004405 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004407 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004408 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 }
4410#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004411 if (time_fd != NULL)
4412 {
4413 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4414 time_msg((char *)IObuff, &tv_start);
4415 time_pop(&tv_rel);
4416 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417#endif
4418
4419#ifdef FEAT_EVAL
4420 /*
4421 * After a "finish" in debug mode, need to break at first command of next
4422 * sourced file.
4423 */
4424 if (save_debug_break_level > ex_nesting_level
4425 && debug_break_level == ex_nesting_level)
4426 ++debug_break_level;
4427#endif
4428
Bram Moolenaar05159a02005-02-26 23:04:13 +00004429#ifdef FEAT_EVAL
4430almosttheend:
4431 current_SID = save_current_SID;
4432 restore_funccal(save_funccalp);
4433# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004434 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004435 prof_child_exit(&wait_start); /* leaving a child now */
4436# endif
4437#endif
4438 fclose(cookie.fp);
4439 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004440 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004441#ifdef FEAT_MBYTE
4442 convert_setup(&cookie.conv, NULL, NULL);
4443#endif
4444
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445theend:
4446 vim_free(fname_exp);
4447 return retval;
4448}
4449
4450#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004451
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452/*
4453 * ":scriptnames"
4454 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004456ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457{
4458 int i;
4459
Bram Moolenaar05159a02005-02-26 23:04:13 +00004460 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4461 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004462 {
4463 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4464 NameBuff, MAXPATHL, TRUE);
4465 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004466 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467}
4468
4469# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4470/*
4471 * Fix slashes in the list of script names for 'shellslash'.
4472 */
4473 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004474scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475{
4476 int i;
4477
Bram Moolenaar05159a02005-02-26 23:04:13 +00004478 for (i = 1; i <= script_items.ga_len; ++i)
4479 if (SCRIPT_ITEM(i).sn_name != NULL)
4480 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481}
4482# endif
4483
4484/*
4485 * Get a pointer to a script name. Used for ":verbose set".
4486 */
4487 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004488get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489{
4490 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004491 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004493 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004495 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004497 return (char_u *)_("environment variable");
4498 if (id == SID_ERROR)
4499 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004500 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004502
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004503# if defined(EXITFREE) || defined(PROTO)
4504 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004505free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004506{
4507 int i;
4508
4509 for (i = script_items.ga_len; i > 0; --i)
4510 vim_free(SCRIPT_ITEM(i).sn_name);
4511 ga_clear(&script_items);
4512}
4513# endif
4514
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515#endif
4516
4517#if defined(USE_CR) || defined(PROTO)
4518
4519# if defined(__MSL__) && (__MSL__ >= 22)
4520/*
4521 * Newer version of the Metrowerks library handle DOS and UNIX files
4522 * without help.
4523 * Test with earlier versions, MSL 2.2 is the library supplied with
4524 * Codewarrior Pro 2.
4525 */
4526 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004527fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528{
4529 return fgets(s, n, stream);
4530}
4531# else
4532/*
4533 * Version of fgets() which also works for lines ending in a <CR> only
4534 * (Macintosh format).
4535 * For older versions of the Metrowerks library.
4536 * At least CodeWarrior 9 needed this code.
4537 */
4538 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004539fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540{
4541 int c = 0;
4542 int char_read = 0;
4543
4544 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4545 {
4546 c = fgetc(stream);
4547 s[char_read++] = c;
4548 /* If the file is in DOS format, we need to skip a NL after a CR. I
4549 * thought it was the other way around, but this appears to work... */
4550 if (c == '\n')
4551 {
4552 c = fgetc(stream);
4553 if (c != '\r')
4554 ungetc(c, stream);
4555 }
4556 }
4557
4558 s[char_read] = 0;
4559 if (char_read == 0)
4560 return NULL;
4561
4562 if (feof(stream) && char_read == 1)
4563 return NULL;
4564
4565 return s;
4566}
4567# endif
4568#endif
4569
4570/*
4571 * Get one full line from a sourced file.
4572 * Called by do_cmdline() when it's called from do_source().
4573 *
4574 * Return a pointer to the line in allocated memory.
4575 * Return NULL for end-of-file or some error.
4576 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004578getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579{
4580 struct source_cookie *sp = (struct source_cookie *)cookie;
4581 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004582 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583
4584#ifdef FEAT_EVAL
4585 /* If breakpoints have been added/deleted need to check for it. */
4586 if (sp->dbg_tick < debug_tick)
4587 {
4588 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4589 sp->dbg_tick = debug_tick;
4590 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004591# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004592 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004593 script_line_end();
4594# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595#endif
4596 /*
4597 * Get current line. If there is a read-ahead line, use it, otherwise get
4598 * one now.
4599 */
4600 if (sp->finished)
4601 line = NULL;
4602 else if (sp->nextline == NULL)
4603 line = get_one_sourceline(sp);
4604 else
4605 {
4606 line = sp->nextline;
4607 sp->nextline = NULL;
4608 ++sourcing_lnum;
4609 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004610#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004611 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004612 script_line_start();
4613#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614
4615 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4616 * contain the 'C' flag. */
4617 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4618 {
4619 /* compensate for the one line read-ahead */
4620 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004621
4622 /* Get the next line and concatenate it when it starts with a
4623 * backslash. We always need to read the next line, keep it in
4624 * sp->nextline. */
4625 sp->nextline = get_one_sourceline(sp);
4626 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004628 garray_T ga;
4629
Bram Moolenaarb549a732012-02-22 18:29:33 +01004630 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004631 ga_concat(&ga, line);
4632 ga_concat(&ga, p + 1);
4633 for (;;)
4634 {
4635 vim_free(sp->nextline);
4636 sp->nextline = get_one_sourceline(sp);
4637 if (sp->nextline == NULL)
4638 break;
4639 p = skipwhite(sp->nextline);
4640 if (*p != '\\')
4641 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004642 /* Adjust the growsize to the current length to speed up
4643 * concatenating many lines. */
4644 if (ga.ga_len > 400)
4645 {
4646 if (ga.ga_len > 8000)
4647 ga.ga_growsize = 8000;
4648 else
4649 ga.ga_growsize = ga.ga_len;
4650 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004651 ga_concat(&ga, p + 1);
4652 }
4653 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004655 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 }
4657 }
4658
4659#ifdef FEAT_MBYTE
4660 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4661 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004662 char_u *s;
4663
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 /* Convert the encoding of the script line. */
4665 s = string_convert(&sp->conv, line, NULL);
4666 if (s != NULL)
4667 {
4668 vim_free(line);
4669 line = s;
4670 }
4671 }
4672#endif
4673
4674#ifdef FEAT_EVAL
4675 /* Did we encounter a breakpoint? */
4676 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4677 {
4678 dbg_breakpoint(sp->fname, sourcing_lnum);
4679 /* Find next breakpoint. */
4680 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4681 sp->dbg_tick = debug_tick;
4682 }
4683#endif
4684
4685 return line;
4686}
4687
4688 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004689get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690{
4691 garray_T ga;
4692 int len;
4693 int c;
4694 char_u *buf;
4695#ifdef USE_CRNL
4696 int has_cr; /* CR-LF found */
4697#endif
4698#ifdef USE_CR
4699 char_u *scan;
4700#endif
4701 int have_read = FALSE;
4702
4703 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004704 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705
4706 /*
4707 * Loop until there is a finished line (or end-of-file).
4708 */
4709 sourcing_lnum++;
4710 for (;;)
4711 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004712 /* make room to read at least 120 (more) characters */
4713 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 break;
4715 buf = (char_u *)ga.ga_data;
4716
4717#ifdef USE_CR
4718 if (sp->fileformat == EOL_MAC)
4719 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004720 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4721 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 break;
4723 }
4724 else
4725#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004726 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4727 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004729 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730#ifdef USE_CRNL
4731 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4732 * CTRL-Z by its own, or after a NL. */
4733 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4734 && sp->fileformat == EOL_DOS
4735 && buf[len - 1] == Ctrl_Z)
4736 {
4737 buf[len - 1] = NUL;
4738 break;
4739 }
4740#endif
4741
4742#ifdef USE_CR
4743 /* If the read doesn't stop on a new line, and there's
4744 * some CR then we assume a Mac format */
4745 if (sp->fileformat == EOL_UNKNOWN)
4746 {
4747 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4748 sp->fileformat = EOL_MAC;
4749 else
4750 sp->fileformat = EOL_UNIX;
4751 }
4752
4753 if (sp->fileformat == EOL_MAC)
4754 {
4755 scan = vim_strchr(buf, '\r');
4756
4757 if (scan != NULL)
4758 {
4759 *scan = '\n';
4760 if (*(scan + 1) != 0)
4761 {
4762 *(scan + 1) = 0;
4763 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4764 }
4765 }
4766 len = STRLEN(buf);
4767 }
4768#endif
4769
4770 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 ga.ga_len = len;
4772
4773 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004774 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 continue;
4776
4777 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4778 {
4779#ifdef USE_CRNL
4780 has_cr = (len >= 2 && buf[len - 2] == '\r');
4781 if (sp->fileformat == EOL_UNKNOWN)
4782 {
4783 if (has_cr)
4784 sp->fileformat = EOL_DOS;
4785 else
4786 sp->fileformat = EOL_UNIX;
4787 }
4788
4789 if (sp->fileformat == EOL_DOS)
4790 {
4791 if (has_cr) /* replace trailing CR */
4792 {
4793 buf[len - 2] = '\n';
4794 --len;
4795 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 }
4797 else /* lines like ":map xx yy^M" will have failed */
4798 {
4799 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004800 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01004801 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004803 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 sp->error = TRUE;
4805 sp->fileformat = EOL_UNIX;
4806 }
4807 }
4808#endif
4809 /* The '\n' is escaped if there is an odd number of ^V's just
4810 * before it, first set "c" just before the 'V's and then check
4811 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
4812 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
4813 ;
4814 if ((len & 1) != (c & 1)) /* escaped NL, read more */
4815 {
4816 sourcing_lnum++;
4817 continue;
4818 }
4819
4820 buf[len - 1] = NUL; /* remove the NL */
4821 }
4822
4823 /*
4824 * Check for ^C here now and then, so recursive :so can be broken.
4825 */
4826 line_breakcheck();
4827 break;
4828 }
4829
4830 if (have_read)
4831 return (char_u *)ga.ga_data;
4832
4833 vim_free(ga.ga_data);
4834 return NULL;
4835}
4836
Bram Moolenaar05159a02005-02-26 23:04:13 +00004837#if defined(FEAT_PROFILE) || defined(PROTO)
4838/*
4839 * Called when starting to read a script line.
4840 * "sourcing_lnum" must be correct!
4841 * When skipping lines it may not actually be executed, but we won't find out
4842 * until later and we need to store the time now.
4843 */
4844 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004845script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004846{
4847 scriptitem_T *si;
4848 sn_prl_T *pp;
4849
4850 if (current_SID <= 0 || current_SID > script_items.ga_len)
4851 return;
4852 si = &SCRIPT_ITEM(current_SID);
4853 if (si->sn_prof_on && sourcing_lnum >= 1)
4854 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004855 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00004856 * here isn't counted. */
Bram Moolenaar67435d92017-10-19 21:04:37 +02004857 (void)ga_grow(&si->sn_prl_ga,
4858 (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00004859 si->sn_prl_idx = sourcing_lnum - 1;
4860 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
4861 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
4862 {
4863 /* Zero counters for a line that was not used before. */
4864 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
4865 pp->snp_count = 0;
4866 profile_zero(&pp->sn_prl_total);
4867 profile_zero(&pp->sn_prl_self);
4868 ++si->sn_prl_ga.ga_len;
4869 }
4870 si->sn_prl_execed = FALSE;
4871 profile_start(&si->sn_prl_start);
4872 profile_zero(&si->sn_prl_children);
4873 profile_get_wait(&si->sn_prl_wait);
4874 }
4875}
4876
4877/*
4878 * Called when actually executing a function line.
4879 */
4880 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004881script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004882{
4883 scriptitem_T *si;
4884
4885 if (current_SID <= 0 || current_SID > script_items.ga_len)
4886 return;
4887 si = &SCRIPT_ITEM(current_SID);
4888 if (si->sn_prof_on && si->sn_prl_idx >= 0)
4889 si->sn_prl_execed = TRUE;
4890}
4891
4892/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02004893 * Called when done with a script line.
Bram Moolenaar05159a02005-02-26 23:04:13 +00004894 */
4895 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004896script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004897{
4898 scriptitem_T *si;
4899 sn_prl_T *pp;
4900
4901 if (current_SID <= 0 || current_SID > script_items.ga_len)
4902 return;
4903 si = &SCRIPT_ITEM(current_SID);
4904 if (si->sn_prof_on && si->sn_prl_idx >= 0
4905 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
4906 {
4907 if (si->sn_prl_execed)
4908 {
4909 pp = &PRL_ITEM(si, si->sn_prl_idx);
4910 ++pp->snp_count;
4911 profile_end(&si->sn_prl_start);
4912 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004913 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004914 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
4915 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004916 }
4917 si->sn_prl_idx = -1;
4918 }
4919}
4920#endif
4921
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922/*
4923 * ":scriptencoding": Set encoding conversion for a sourced script.
4924 * Without the multi-byte feature it's simply ignored.
4925 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004927ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004928{
4929#ifdef FEAT_MBYTE
4930 struct source_cookie *sp;
4931 char_u *name;
4932
4933 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
4934 {
4935 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
4936 return;
4937 }
4938
4939 if (*eap->arg != NUL)
4940 {
4941 name = enc_canonize(eap->arg);
4942 if (name == NULL) /* out of memory */
4943 return;
4944 }
4945 else
4946 name = eap->arg;
4947
4948 /* Setup for conversion from the specified encoding to 'encoding'. */
4949 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
4950 convert_setup(&sp->conv, name, p_enc);
4951
4952 if (name != eap->arg)
4953 vim_free(name);
4954#endif
4955}
4956
4957#if defined(FEAT_EVAL) || defined(PROTO)
4958/*
4959 * ":finish": Mark a sourced file as finished.
4960 */
4961 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004962ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963{
4964 if (getline_equal(eap->getline, eap->cookie, getsourceline))
4965 do_finish(eap, FALSE);
4966 else
4967 EMSG(_("E168: :finish used outside of a sourced file"));
4968}
4969
4970/*
4971 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
4972 * Also called for a pending finish at the ":endtry" or after returning from
4973 * an extra do_cmdline(). "reanimate" is used in the latter case.
4974 */
4975 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004976do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977{
4978 int idx;
4979
4980 if (reanimate)
4981 ((struct source_cookie *)getline_cookie(eap->getline,
4982 eap->cookie))->finished = FALSE;
4983
4984 /*
4985 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4986 * not in its finally clause (which then is to be executed next) is found.
4987 * In this case, make the ":finish" pending for execution at the ":endtry".
4988 * Otherwise, finish normally.
4989 */
4990 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4991 if (idx >= 0)
4992 {
4993 eap->cstack->cs_pending[idx] = CSTP_FINISH;
4994 report_make_pending(CSTP_FINISH, NULL);
4995 }
4996 else
4997 ((struct source_cookie *)getline_cookie(eap->getline,
4998 eap->cookie))->finished = TRUE;
4999}
5000
5001
5002/*
5003 * Return TRUE when a sourced file had the ":finish" command: Don't give error
5004 * message for missing ":endif".
5005 * Return FALSE when not sourcing a file.
5006 */
5007 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005008source_finished(
5009 char_u *(*fgetline)(int, void *, int),
5010 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005011{
Bram Moolenaar89d40322006-08-29 15:30:07 +00005012 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00005014 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015}
5016#endif
5017
5018#if defined(FEAT_LISTCMDS) || defined(PROTO)
5019/*
5020 * ":checktime [buffer]"
5021 */
5022 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005023ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024{
5025 buf_T *buf;
5026 int save_no_check_timestamps = no_check_timestamps;
5027
5028 no_check_timestamps = 0;
5029 if (eap->addr_count == 0) /* default is all buffers */
5030 check_timestamps(FALSE);
5031 else
5032 {
5033 buf = buflist_findnr((int)eap->line2);
5034 if (buf != NULL) /* cannot happen? */
5035 (void)buf_check_timestamp(buf, FALSE);
5036 }
5037 no_check_timestamps = save_no_check_timestamps;
5038}
5039#endif
5040
Bram Moolenaar071d4272004-06-13 20:20:40 +00005041#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5042 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005043# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005044static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005045
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005046 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005047get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005048{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005049 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050
Bram Moolenaar48e330a2016-02-23 14:53:34 +01005051 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005052 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005053
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005054# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 if (loc != NULL)
5056 {
5057 char_u *p;
5058
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005059 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
5060 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005061 p = vim_strchr(loc, '=');
5062 if (p != NULL)
5063 {
5064 loc = ++p;
5065 while (*p != NUL) /* remove trailing newline */
5066 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005067 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005068 {
5069 *p = NUL;
5070 break;
5071 }
5072 ++p;
5073 }
5074 }
5075 }
5076# endif
5077
5078 return loc;
5079}
5080#endif
5081
5082
5083#ifdef WIN32
5084/*
5085 * On MS-Windows locale names are strings like "German_Germany.1252", but
5086 * gettext expects "de". Try to translate one into another here for a few
5087 * supported languages.
5088 */
5089 static char_u *
5090gettext_lang(char_u *name)
5091{
5092 int i;
5093 static char *(mtable[]) = {
5094 "afrikaans", "af",
5095 "czech", "cs",
5096 "dutch", "nl",
5097 "german", "de",
5098 "english_united kingdom", "en_GB",
5099 "spanish", "es",
5100 "french", "fr",
5101 "italian", "it",
5102 "japanese", "ja",
5103 "korean", "ko",
5104 "norwegian", "no",
5105 "polish", "pl",
5106 "russian", "ru",
5107 "slovak", "sk",
5108 "swedish", "sv",
5109 "ukrainian", "uk",
5110 "chinese_china", "zh_CN",
5111 "chinese_taiwan", "zh_TW",
5112 NULL};
5113
5114 for (i = 0; mtable[i] != NULL; i += 2)
5115 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005116 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117 return name;
5118}
5119#endif
5120
5121#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5122/*
5123 * Obtain the current messages language. Used to set the default for
5124 * 'helplang'. May return NULL or an empty string.
5125 */
5126 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005127get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128{
5129 char_u *p;
5130
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005131# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005132# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005133 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134# else
5135 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005136 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
5137 * and LC_MONETARY may be set differently for a Japanese working in the
5138 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005139 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140# endif
5141# else
5142 p = mch_getenv((char_u *)"LC_ALL");
5143 if (p == NULL || *p == NUL)
5144 {
5145 p = mch_getenv((char_u *)"LC_MESSAGES");
5146 if (p == NULL || *p == NUL)
5147 p = mch_getenv((char_u *)"LANG");
5148 }
5149# endif
5150# ifdef WIN32
5151 p = gettext_lang(p);
5152# endif
5153 return p;
5154}
5155#endif
5156
Bram Moolenaardef9e822004-12-31 20:58:58 +00005157/* Complicated #if; matches with where get_mess_env() is used below. */
5158#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5159 && defined(LC_MESSAGES))) \
5160 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5161 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
5162 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01005163static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164
5165/*
5166 * Get the language used for messages from the environment.
5167 */
5168 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005169get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170{
5171 char_u *p;
5172
5173 p = mch_getenv((char_u *)"LC_ALL");
5174 if (p == NULL || *p == NUL)
5175 {
5176 p = mch_getenv((char_u *)"LC_MESSAGES");
5177 if (p == NULL || *p == NUL)
5178 {
5179 p = mch_getenv((char_u *)"LANG");
5180 if (p != NULL && VIM_ISDIGIT(*p))
5181 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005182# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005183 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005184 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185# endif
5186 }
5187 }
5188 return p;
5189}
5190#endif
5191
5192#if defined(FEAT_EVAL) || defined(PROTO)
5193
5194/*
5195 * Set the "v:lang" variable according to the current locale setting.
5196 * Also do "v:lc_time"and "v:ctype".
5197 */
5198 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005199set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200{
5201 char_u *loc;
5202
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005203# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005204 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205# else
5206 /* setlocale() not supported: use the default value */
5207 loc = (char_u *)"C";
5208# endif
5209 set_vim_var_string(VV_CTYPE, loc, -1);
5210
5211 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
5212 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005213# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005214 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215# else
5216 loc = get_mess_env();
5217# endif
5218 set_vim_var_string(VV_LANG, loc, -1);
5219
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005220# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005221 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222# endif
5223 set_vim_var_string(VV_LC_TIME, loc, -1);
5224}
5225#endif
5226
5227#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5228 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
5229/*
5230 * ":language": Set the language (locale).
5231 */
5232 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005233ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234{
5235 char *loc;
5236 char_u *p;
5237 char_u *name;
5238 int what = LC_ALL;
5239 char *whatstr = "";
5240#ifdef LC_MESSAGES
5241# define VIM_LC_MESSAGES LC_MESSAGES
5242#else
5243# define VIM_LC_MESSAGES 6789
5244#endif
5245
5246 name = eap->arg;
5247
5248 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
5249 * Allow abbreviation, but require at least 3 characters to avoid
5250 * confusion with a two letter language name "me" or "ct". */
5251 p = skiptowhite(eap->arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005252 if ((*p == NUL || VIM_ISWHITE(*p)) && p - eap->arg >= 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 {
5254 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
5255 {
5256 what = VIM_LC_MESSAGES;
5257 name = skipwhite(p);
5258 whatstr = "messages ";
5259 }
5260 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
5261 {
5262 what = LC_CTYPE;
5263 name = skipwhite(p);
5264 whatstr = "ctype ";
5265 }
5266 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
5267 {
5268 what = LC_TIME;
5269 name = skipwhite(p);
5270 whatstr = "time ";
5271 }
5272 }
5273
5274 if (*name == NUL)
5275 {
5276#ifndef LC_MESSAGES
5277 if (what == VIM_LC_MESSAGES)
5278 p = get_mess_env();
5279 else
5280#endif
5281 p = (char_u *)setlocale(what, NULL);
5282 if (p == NULL || *p == NUL)
5283 p = (char_u *)"Unknown";
5284 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
5285 }
5286 else
5287 {
5288#ifndef LC_MESSAGES
5289 if (what == VIM_LC_MESSAGES)
5290 loc = "";
5291 else
5292#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005293 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005295#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
5296 /* Make sure strtod() uses a decimal point, not a comma. */
5297 setlocale(LC_NUMERIC, "C");
5298#endif
5299 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 if (loc == NULL)
5301 EMSG2(_("E197: Cannot set language to \"%s\""), name);
5302 else
5303 {
5304#ifdef HAVE_NL_MSG_CAT_CNTR
5305 /* Need to do this for GNU gettext, otherwise cached translations
5306 * will be used again. */
5307 extern int _nl_msg_cat_cntr;
5308
5309 ++_nl_msg_cat_cntr;
5310#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00005311 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005312 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
5313
5314 if (what != LC_TIME)
5315 {
5316 /* Tell gettext() what to translate to. It apparently doesn't
5317 * use the currently effective locale. Also do this when
5318 * FEAT_GETTEXT isn't defined, so that shell commands use this
5319 * value. */
5320 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005321 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02005323
5324 /* Clear $LANGUAGE because GNU gettext uses it. */
5325 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005326# ifdef WIN32
5327 /* Apparently MS-Windows printf() may cause a crash when
5328 * we give it 8-bit text while it's expecting text in the
5329 * current locale. This call avoids that. */
5330 setlocale(LC_CTYPE, "C");
5331# endif
5332 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333 if (what != LC_CTYPE)
5334 {
5335 char_u *mname;
5336#ifdef WIN32
5337 mname = gettext_lang(name);
5338#else
5339 mname = name;
5340#endif
5341 vim_setenv((char_u *)"LC_MESSAGES", mname);
5342#ifdef FEAT_MULTI_LANG
5343 set_helplang_default(mname);
5344#endif
5345 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346 }
5347
5348# ifdef FEAT_EVAL
5349 /* Set v:lang, v:lc_time and v:ctype to the final result. */
5350 set_lang_var();
5351# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02005352# ifdef FEAT_TITLE
5353 maketitle();
5354# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005355 }
5356 }
5357}
5358
5359# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005360
5361static char_u **locales = NULL; /* Array of all available locales */
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005362
5363# ifndef WIN32
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005364static int did_init_locales = FALSE;
5365
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005366/* Return an array of strings for all available locales + NULL for the
5367 * last element. Return NULL in case of error. */
5368 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005369find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005370{
5371 garray_T locales_ga;
5372 char_u *loc;
5373
5374 /* Find all available locales by running command "locale -a". If this
5375 * doesn't work we won't have completion. */
5376 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02005377 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005378 if (locale_a == NULL)
5379 return NULL;
5380 ga_init2(&locales_ga, sizeof(char_u *), 20);
5381
5382 /* Transform locale_a string where each locale is separated by "\n"
5383 * into an array of locale strings. */
5384 loc = (char_u *)strtok((char *)locale_a, "\n");
5385
5386 while (loc != NULL)
5387 {
5388 if (ga_grow(&locales_ga, 1) == FAIL)
5389 break;
5390 loc = vim_strsave(loc);
5391 if (loc == NULL)
5392 break;
5393
5394 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5395 loc = (char_u *)strtok(NULL, "\n");
5396 }
5397 vim_free(locale_a);
5398 if (ga_grow(&locales_ga, 1) == FAIL)
5399 {
5400 ga_clear(&locales_ga);
5401 return NULL;
5402 }
5403 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5404 return (char_u **)locales_ga.ga_data;
5405}
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005406# endif
5407
5408/*
5409 * Lazy initialization of all available locales.
5410 */
5411 static void
5412init_locales(void)
5413{
5414# ifndef WIN32
5415 if (!did_init_locales)
5416 {
5417 did_init_locales = TRUE;
5418 locales = find_locales();
5419 }
5420# endif
5421}
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005422
5423# if defined(EXITFREE) || defined(PROTO)
5424 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005425free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005426{
5427 int i;
5428 if (locales != NULL)
5429 {
5430 for (i = 0; locales[i] != NULL; i++)
5431 vim_free(locales[i]);
5432 vim_free(locales);
5433 locales = NULL;
5434 }
5435}
5436# endif
5437
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438/*
5439 * Function given to ExpandGeneric() to obtain the possible arguments of the
5440 * ":language" command.
5441 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005442 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005443get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444{
5445 if (idx == 0)
5446 return (char_u *)"messages";
5447 if (idx == 1)
5448 return (char_u *)"ctype";
5449 if (idx == 2)
5450 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005451
5452 init_locales();
5453 if (locales == NULL)
5454 return NULL;
5455 return locales[idx - 3];
5456}
5457
5458/*
5459 * Function given to ExpandGeneric() to obtain the available locales.
5460 */
5461 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005462get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005463{
5464 init_locales();
5465 if (locales == NULL)
5466 return NULL;
5467 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468}
5469# endif
5470
5471#endif