blob: c36435cc1773142627134799706e8b7aaba3ede9 [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
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010076static char_u *debug_oldval = NULL; /* old and newval for debug expressions */
77static char_u *debug_newval = NULL;
78static int debug_expr = 0; /* use debug_expr */
79
80 int
81has_watchexpr(void)
82{
83 return debug_expr;
84}
85
Bram Moolenaar071d4272004-06-13 20:20:40 +000086/*
87 * do_debug(): Debug mode.
88 * Repeatedly get Ex commands, until told to continue normal execution.
89 */
90 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010091do_debug(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +000092{
93 int save_msg_scroll = msg_scroll;
94 int save_State = State;
95 int save_did_emsg = did_emsg;
96 int save_cmd_silent = cmd_silent;
97 int save_msg_silent = msg_silent;
98 int save_emsg_silent = emsg_silent;
99 int save_redir_off = redir_off;
100 tasave_T typeaheadbuf;
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000101 int typeahead_saved = FALSE;
Bram Moolenaar383c6f52008-01-04 15:01:07 +0000102 int save_ignore_script = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103 int save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104 int n;
105 char_u *cmdline = NULL;
106 char_u *p;
107 char *tail = NULL;
108 static int last_cmd = 0;
109#define CMD_CONT 1
110#define CMD_NEXT 2
111#define CMD_STEP 3
112#define CMD_FINISH 4
113#define CMD_QUIT 5
114#define CMD_INTERRUPT 6
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100115#define CMD_BACKTRACE 7
116#define CMD_FRAME 8
117#define CMD_UP 9
118#define CMD_DOWN 10
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119
120#ifdef ALWAYS_USE_GUI
121 /* Can't do this when there is no terminal for input/output. */
122 if (!gui.in_use)
123 {
124 /* Break as soon as possible. */
125 debug_break_level = 9999;
126 return;
127 }
128#endif
129
130 /* Make sure we are in raw mode and start termcap mode. Might have side
131 * effects... */
132 settmode(TMODE_RAW);
133 starttermcap();
134
135 ++RedrawingDisabled; /* don't redisplay the window */
136 ++no_wait_return; /* don't wait for return */
137 did_emsg = FALSE; /* don't use error from debugged stuff */
138 cmd_silent = FALSE; /* display commands */
139 msg_silent = FALSE; /* display messages */
140 emsg_silent = FALSE; /* display error messages */
141 redir_off = TRUE; /* don't redirect debug commands */
142
143 State = NORMAL;
Bram Moolenaard99388b2017-10-26 14:28:32 +0200144 debug_mode = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146 if (!debug_did_msg)
147 MSG(_("Entering Debug mode. Type \"cont\" to continue."));
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100148 if (debug_oldval != NULL)
149 {
150 smsg((char_u *)_("Oldval = \"%s\""), debug_oldval);
151 vim_free(debug_oldval);
152 debug_oldval = NULL;
153 }
154 if (debug_newval != NULL)
155 {
156 smsg((char_u *)_("Newval = \"%s\""), debug_newval);
157 vim_free(debug_newval);
158 debug_newval = NULL;
159 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160 if (sourcing_name != NULL)
161 msg(sourcing_name);
162 if (sourcing_lnum != 0)
Bram Moolenaar555b2802005-05-19 21:08:39 +0000163 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164 else
Bram Moolenaar555b2802005-05-19 21:08:39 +0000165 smsg((char_u *)_("cmd: %s"), cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166 /*
167 * Repeat getting a command and executing it.
168 */
169 for (;;)
170 {
171 msg_scroll = TRUE;
172 need_wait_return = FALSE;
Bram Moolenaar85b11762016-02-27 18:13:23 +0100173
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 /* Save the current typeahead buffer and replace it with an empty one.
175 * This makes sure we get input from the user here and don't interfere
176 * with the commands being executed. Reset "ex_normal_busy" to avoid
177 * the side effects of using ":normal". Save the stuff buffer and make
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000178 * it empty. Set ignore_script to avoid reading from script input. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179 save_ex_normal_busy = ex_normal_busy;
180 ex_normal_busy = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181 if (!debug_greedy)
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000182 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183 save_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000184 typeahead_saved = TRUE;
185 save_ignore_script = ignore_script;
186 ignore_script = TRUE;
187 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188
Bram Moolenaardc303bc2016-05-17 17:45:38 +0200189 vim_free(cmdline);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000190 cmdline = getcmdline_prompt('>', NULL, 0, EXPAND_NOTHING, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000192 if (typeahead_saved)
193 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194 restore_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000195 ignore_script = save_ignore_script;
196 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197 ex_normal_busy = save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198
199 cmdline_row = msg_row;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100200 msg_starthere();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 if (cmdline != NULL)
202 {
203 /* If this is a debug command, set "last_cmd".
204 * If not, reset "last_cmd".
205 * For a blank line use previous command. */
206 p = skipwhite(cmdline);
207 if (*p != NUL)
208 {
209 switch (*p)
210 {
211 case 'c': last_cmd = CMD_CONT;
212 tail = "ont";
213 break;
214 case 'n': last_cmd = CMD_NEXT;
215 tail = "ext";
216 break;
217 case 's': last_cmd = CMD_STEP;
218 tail = "tep";
219 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100220 case 'f':
221 last_cmd = 0;
222 if (p[1] == 'r')
223 {
224 last_cmd = CMD_FRAME;
225 tail = "rame";
226 }
227 else
228 {
229 last_cmd = CMD_FINISH;
230 tail = "inish";
231 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232 break;
233 case 'q': last_cmd = CMD_QUIT;
234 tail = "uit";
235 break;
236 case 'i': last_cmd = CMD_INTERRUPT;
237 tail = "nterrupt";
238 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100239 case 'b': last_cmd = CMD_BACKTRACE;
240 if (p[1] == 't')
241 tail = "t";
242 else
243 tail = "acktrace";
244 break;
245 case 'w': last_cmd = CMD_BACKTRACE;
246 tail = "here";
247 break;
248 case 'u': last_cmd = CMD_UP;
249 tail = "p";
250 break;
251 case 'd': last_cmd = CMD_DOWN;
252 tail = "own";
253 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254 default: last_cmd = 0;
255 }
256 if (last_cmd != 0)
257 {
258 /* Check that the tail matches. */
259 ++p;
260 while (*p != NUL && *p == *tail)
261 {
262 ++p;
263 ++tail;
264 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100265 if (ASCII_ISALPHA(*p) && last_cmd != CMD_FRAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266 last_cmd = 0;
267 }
268 }
269
270 if (last_cmd != 0)
271 {
272 /* Execute debug command: decided where to break next and
273 * return. */
274 switch (last_cmd)
275 {
276 case CMD_CONT:
277 debug_break_level = -1;
278 break;
279 case CMD_NEXT:
280 debug_break_level = ex_nesting_level;
281 break;
282 case CMD_STEP:
283 debug_break_level = 9999;
284 break;
285 case CMD_FINISH:
286 debug_break_level = ex_nesting_level - 1;
287 break;
288 case CMD_QUIT:
289 got_int = TRUE;
290 debug_break_level = -1;
291 break;
292 case CMD_INTERRUPT:
293 got_int = TRUE;
294 debug_break_level = 9999;
295 /* Do not repeat ">interrupt" cmd, continue stepping. */
296 last_cmd = CMD_STEP;
297 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100298 case CMD_BACKTRACE:
299 do_showbacktrace(cmd);
300 continue;
301 case CMD_FRAME:
302 if (*p == NUL)
303 {
304 do_showbacktrace(cmd);
305 }
306 else
307 {
308 p = skipwhite(p);
309 do_setdebugtracelevel(p);
310 }
311 continue;
312 case CMD_UP:
313 debug_backtrace_level++;
314 do_checkbacktracelevel();
315 continue;
316 case CMD_DOWN:
317 debug_backtrace_level--;
318 do_checkbacktracelevel();
319 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100321 /* Going out reset backtrace_level */
322 debug_backtrace_level = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323 break;
324 }
325
326 /* don't debug this command */
327 n = debug_break_level;
328 debug_break_level = -1;
329 (void)do_cmdline(cmdline, getexline, NULL,
330 DOCMD_VERBOSE|DOCMD_EXCRESET);
331 debug_break_level = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332 }
333 lines_left = Rows - 1;
334 }
335 vim_free(cmdline);
336
337 --RedrawingDisabled;
338 --no_wait_return;
339 redraw_all_later(NOT_VALID);
340 need_wait_return = FALSE;
341 msg_scroll = save_msg_scroll;
342 lines_left = Rows - 1;
343 State = save_State;
Bram Moolenaard99388b2017-10-26 14:28:32 +0200344 debug_mode = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345 did_emsg = save_did_emsg;
346 cmd_silent = save_cmd_silent;
347 msg_silent = save_msg_silent;
348 emsg_silent = save_emsg_silent;
349 redir_off = save_redir_off;
350
351 /* Only print the message again when typing a command before coming back
352 * here. */
353 debug_did_msg = TRUE;
354}
355
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100356 static int
357get_maxbacktrace_level(void)
358{
359 char *p, *q;
Bram Moolenaardc633cf2016-04-23 14:33:19 +0200360 int maxbacktrace = 0;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100361
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100362 if (sourcing_name != NULL)
363 {
364 p = (char *)sourcing_name;
365 while ((q = strstr(p, "..")) != NULL)
366 {
367 p = q + 2;
368 maxbacktrace++;
369 }
370 }
371 return maxbacktrace;
372}
373
374 static void
375do_setdebugtracelevel(char_u *arg)
376{
377 int level;
378
379 level = atoi((char *)arg);
380 if (*arg == '+' || level < 0)
381 debug_backtrace_level += level;
382 else
383 debug_backtrace_level = level;
384
385 do_checkbacktracelevel();
386}
387
388 static void
389do_checkbacktracelevel(void)
390{
391 if (debug_backtrace_level < 0)
392 {
393 debug_backtrace_level = 0;
394 MSG(_("frame is zero"));
395 }
396 else
397 {
398 int max = get_maxbacktrace_level();
399
400 if (debug_backtrace_level > max)
401 {
402 debug_backtrace_level = max;
403 smsg((char_u *)_("frame at highest level: %d"), max);
404 }
405 }
406}
407
408 static void
409do_showbacktrace(char_u *cmd)
410{
411 char *cur;
412 char *next;
413 int i = 0;
414 int max = get_maxbacktrace_level();
415
416 if (sourcing_name != NULL)
417 {
418 cur = (char *)sourcing_name;
419 while (!got_int)
420 {
421 next = strstr(cur, "..");
422 if (next != NULL)
423 *next = NUL;
424 if (i == max - debug_backtrace_level)
425 smsg((char_u *)"->%d %s", max - i, cur);
426 else
427 smsg((char_u *)" %d %s", max - i, cur);
428 ++i;
429 if (next == NULL)
430 break;
431 *next = '.';
432 cur = next + 2;
433 }
434 }
435 if (sourcing_lnum != 0)
436 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
437 else
438 smsg((char_u *)_("cmd: %s"), cmd);
439}
440
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441/*
442 * ":debug".
443 */
444 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100445ex_debug(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446{
447 int debug_break_level_save = debug_break_level;
448
449 debug_break_level = 9999;
450 do_cmdline_cmd(eap->arg);
451 debug_break_level = debug_break_level_save;
452}
453
454static char_u *debug_breakpoint_name = NULL;
455static linenr_T debug_breakpoint_lnum;
456
457/*
458 * When debugging or a breakpoint is set on a skipped command, no debug prompt
459 * is shown by do_one_cmd(). This situation is indicated by debug_skipped, and
460 * debug_skipped_name is then set to the source name in the breakpoint case. If
461 * a skipped command decides itself that a debug prompt should be displayed, it
462 * can do so by calling dbg_check_skipped().
463 */
464static int debug_skipped;
465static char_u *debug_skipped_name;
466
467/*
468 * Go to debug mode when a breakpoint was encountered or "ex_nesting_level" is
469 * at or below the break level. But only when the line is actually
470 * executed. Return TRUE and set breakpoint_name for skipped commands that
471 * decide to execute something themselves.
472 * Called from do_one_cmd() before executing a command.
473 */
474 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100475dbg_check_breakpoint(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476{
477 char_u *p;
478
479 debug_skipped = FALSE;
480 if (debug_breakpoint_name != NULL)
481 {
482 if (!eap->skip)
483 {
484 /* replace K_SNR with "<SNR>" */
485 if (debug_breakpoint_name[0] == K_SPECIAL
486 && debug_breakpoint_name[1] == KS_EXTRA
487 && debug_breakpoint_name[2] == (int)KE_SNR)
488 p = (char_u *)"<SNR>";
489 else
490 p = (char_u *)"";
Bram Moolenaar555b2802005-05-19 21:08:39 +0000491 smsg((char_u *)_("Breakpoint in \"%s%s\" line %ld"),
492 p,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493 debug_breakpoint_name + (*p == NUL ? 0 : 3),
494 (long)debug_breakpoint_lnum);
495 debug_breakpoint_name = NULL;
496 do_debug(eap->cmd);
497 }
498 else
499 {
500 debug_skipped = TRUE;
501 debug_skipped_name = debug_breakpoint_name;
502 debug_breakpoint_name = NULL;
503 }
504 }
505 else if (ex_nesting_level <= debug_break_level)
506 {
507 if (!eap->skip)
508 do_debug(eap->cmd);
509 else
510 {
511 debug_skipped = TRUE;
512 debug_skipped_name = NULL;
513 }
514 }
515}
516
517/*
518 * Go to debug mode if skipped by dbg_check_breakpoint() because eap->skip was
519 * set. Return TRUE when the debug mode is entered this time.
520 */
521 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100522dbg_check_skipped(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523{
524 int prev_got_int;
525
526 if (debug_skipped)
527 {
528 /*
529 * Save the value of got_int and reset it. We don't want a previous
530 * interruption cause flushing the input buffer.
531 */
532 prev_got_int = got_int;
533 got_int = FALSE;
534 debug_breakpoint_name = debug_skipped_name;
535 /* eap->skip is TRUE */
536 eap->skip = FALSE;
537 (void)dbg_check_breakpoint(eap);
538 eap->skip = TRUE;
539 got_int |= prev_got_int;
540 return TRUE;
541 }
542 return FALSE;
543}
544
545/*
546 * The list of breakpoints: dbg_breakp.
547 * This is a grow-array of structs.
548 */
549struct debuggy
550{
551 int dbg_nr; /* breakpoint number */
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100552 int dbg_type; /* DBG_FUNC, DBG_FILE or DBG_EXPR */
553 char_u *dbg_name; /* function, expression or file name */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 regprog_T *dbg_prog; /* regexp program */
555 linenr_T dbg_lnum; /* line number in function or file */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000556 int dbg_forceit; /* ! used */
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100557#ifdef FEAT_EVAL
558 typval_T *dbg_val; /* last result of watchexpression */
559#endif
560 int dbg_level; /* stored nested level for expr */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561};
562
563static garray_T dbg_breakp = {0, 0, sizeof(struct debuggy), 4, NULL};
Bram Moolenaar05159a02005-02-26 23:04:13 +0000564#define BREAKP(idx) (((struct debuggy *)dbg_breakp.ga_data)[idx])
565#define DEBUGGY(gap, idx) (((struct debuggy *)gap->ga_data)[idx])
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566static int last_breakp = 0; /* nr of last defined breakpoint */
567
Bram Moolenaar05159a02005-02-26 23:04:13 +0000568#ifdef FEAT_PROFILE
569/* Profiling uses file and func names similar to breakpoints. */
570static garray_T prof_ga = {0, 0, sizeof(struct debuggy), 4, NULL};
571#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572#define DBG_FUNC 1
573#define DBG_FILE 2
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100574#define DBG_EXPR 3
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100576static int dbg_parsearg(char_u *arg, garray_T *gap);
577static linenr_T debuggy_find(int file,char_u *fname, linenr_T after, garray_T *gap, int *fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578
579/*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000580 * Parse the arguments of ":profile", ":breakadd" or ":breakdel" and put them
581 * in the entry just after the last one in dbg_breakp. Note that "dbg_name"
582 * is allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583 * Returns FAIL for failure.
584 */
585 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100586dbg_parsearg(
587 char_u *arg,
588 garray_T *gap) /* either &dbg_breakp or &prof_ga */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589{
590 char_u *p = arg;
591 char_u *q;
592 struct debuggy *bp;
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000593 int here = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594
Bram Moolenaar05159a02005-02-26 23:04:13 +0000595 if (ga_grow(gap, 1) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 return FAIL;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000597 bp = &DEBUGGY(gap, gap->ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599 /* Find "func" or "file". */
600 if (STRNCMP(p, "func", 4) == 0)
601 bp->dbg_type = DBG_FUNC;
602 else if (STRNCMP(p, "file", 4) == 0)
603 bp->dbg_type = DBG_FILE;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000604 else if (
605#ifdef FEAT_PROFILE
606 gap != &prof_ga &&
607#endif
608 STRNCMP(p, "here", 4) == 0)
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000609 {
610 if (curbuf->b_ffname == NULL)
611 {
612 EMSG(_(e_noname));
613 return FAIL;
614 }
615 bp->dbg_type = DBG_FILE;
616 here = TRUE;
617 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100618 else if (
619#ifdef FEAT_PROFILE
620 gap != &prof_ga &&
621#endif
622 STRNCMP(p, "expr", 4) == 0)
623 bp->dbg_type = DBG_EXPR;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 else
625 {
626 EMSG2(_(e_invarg2), p);
627 return FAIL;
628 }
629 p = skipwhite(p + 4);
630
631 /* Find optional line number. */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000632 if (here)
633 bp->dbg_lnum = curwin->w_cursor.lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000634 else if (
635#ifdef FEAT_PROFILE
636 gap != &prof_ga &&
637#endif
638 VIM_ISDIGIT(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 {
640 bp->dbg_lnum = getdigits(&p);
641 p = skipwhite(p);
642 }
643 else
644 bp->dbg_lnum = 0;
645
646 /* Find the function or file name. Don't accept a function name with (). */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000647 if ((!here && *p == NUL)
648 || (here && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 || (bp->dbg_type == DBG_FUNC && strstr((char *)p, "()") != NULL))
650 {
651 EMSG2(_(e_invarg2), arg);
652 return FAIL;
653 }
654
655 if (bp->dbg_type == DBG_FUNC)
656 bp->dbg_name = vim_strsave(p);
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000657 else if (here)
658 bp->dbg_name = vim_strsave(curbuf->b_ffname);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100659 else if (bp->dbg_type == DBG_EXPR)
660 {
661 bp->dbg_name = vim_strsave(p);
662 if (bp->dbg_name != NULL)
663 bp->dbg_val = eval_expr(bp->dbg_name, NULL);
664 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 else
666 {
667 /* Expand the file name in the same way as do_source(). This means
668 * doing it twice, so that $DIR/file gets expanded when $DIR is
669 * "~/dir". */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 q = expand_env_save(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671 if (q == NULL)
672 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 p = expand_env_save(q);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 vim_free(q);
675 if (p == NULL)
676 return FAIL;
Bram Moolenaar843ee412004-06-30 16:16:41 +0000677 if (*p != '*')
678 {
679 bp->dbg_name = fix_fname(p);
680 vim_free(p);
681 }
682 else
683 bp->dbg_name = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 }
685
686 if (bp->dbg_name == NULL)
687 return FAIL;
688 return OK;
689}
690
691/*
692 * ":breakadd".
693 */
694 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100695ex_breakadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696{
697 struct debuggy *bp;
698 char_u *pat;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000699 garray_T *gap;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700
Bram Moolenaar05159a02005-02-26 23:04:13 +0000701 gap = &dbg_breakp;
702#ifdef FEAT_PROFILE
703 if (eap->cmdidx == CMD_profile)
704 gap = &prof_ga;
705#endif
706
707 if (dbg_parsearg(eap->arg, gap) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000709 bp = &DEBUGGY(gap, gap->ga_len);
710 bp->dbg_forceit = eap->forceit;
711
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100712 if (bp->dbg_type != DBG_EXPR)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 {
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100714 pat = file_pat_to_reg_pat(bp->dbg_name, NULL, NULL, FALSE);
715 if (pat != NULL)
716 {
717 bp->dbg_prog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
718 vim_free(pat);
719 }
720 if (pat == NULL || bp->dbg_prog == NULL)
721 vim_free(bp->dbg_name);
722 else
723 {
724 if (bp->dbg_lnum == 0) /* default line number is 1 */
725 bp->dbg_lnum = 1;
726#ifdef FEAT_PROFILE
727 if (eap->cmdidx != CMD_profile)
728#endif
729 {
730 DEBUGGY(gap, gap->ga_len).dbg_nr = ++last_breakp;
731 ++debug_tick;
732 }
733 ++gap->ga_len;
734 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736 else
737 {
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100738 /* DBG_EXPR */
739 DEBUGGY(gap, gap->ga_len++).dbg_nr = ++last_breakp;
740 ++debug_tick;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741 }
742 }
743}
744
745/*
746 * ":debuggreedy".
747 */
748 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100749ex_debuggreedy(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750{
751 if (eap->addr_count == 0 || eap->line2 != 0)
752 debug_greedy = TRUE;
753 else
754 debug_greedy = FALSE;
755}
756
757/*
Bram Moolenaard9fba312005-06-26 22:34:35 +0000758 * ":breakdel" and ":profdel".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759 */
760 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100761ex_breakdel(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762{
763 struct debuggy *bp, *bpi;
764 int nr;
765 int todel = -1;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000766 int del_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 int i;
768 linenr_T best_lnum = 0;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000769 garray_T *gap;
770
771 gap = &dbg_breakp;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000772 if (eap->cmdidx == CMD_profdel)
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200773 {
774#ifdef FEAT_PROFILE
Bram Moolenaard9fba312005-06-26 22:34:35 +0000775 gap = &prof_ga;
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200776#else
777 ex_ni(eap);
778 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000779#endif
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200780 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781
782 if (vim_isdigit(*eap->arg))
783 {
784 /* ":breakdel {nr}" */
785 nr = atol((char *)eap->arg);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000786 for (i = 0; i < gap->ga_len; ++i)
787 if (DEBUGGY(gap, i).dbg_nr == nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 {
789 todel = i;
790 break;
791 }
792 }
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000793 else if (*eap->arg == '*')
794 {
795 todel = 0;
796 del_all = TRUE;
797 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 else
799 {
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100800 /* ":breakdel {func|file|expr} [lnum] {name}" */
Bram Moolenaard9fba312005-06-26 22:34:35 +0000801 if (dbg_parsearg(eap->arg, gap) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000803 bp = &DEBUGGY(gap, gap->ga_len);
804 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000806 bpi = &DEBUGGY(gap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 if (bp->dbg_type == bpi->dbg_type
808 && STRCMP(bp->dbg_name, bpi->dbg_name) == 0
809 && (bp->dbg_lnum == bpi->dbg_lnum
810 || (bp->dbg_lnum == 0
811 && (best_lnum == 0
812 || bpi->dbg_lnum < best_lnum))))
813 {
814 todel = i;
815 best_lnum = bpi->dbg_lnum;
816 }
817 }
818 vim_free(bp->dbg_name);
819 }
820
821 if (todel < 0)
822 EMSG2(_("E161: Breakpoint not found: %s"), eap->arg);
823 else
Bram Moolenaard9fba312005-06-26 22:34:35 +0000824 {
825 while (gap->ga_len > 0)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000826 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000827 vim_free(DEBUGGY(gap, todel).dbg_name);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100828#ifdef FEAT_EVAL
829 if (DEBUGGY(gap, todel).dbg_type == DBG_EXPR
830 && DEBUGGY(gap, todel).dbg_val != NULL)
831 free_tv(DEBUGGY(gap, todel).dbg_val);
832#endif
Bram Moolenaar473de612013-06-08 18:19:48 +0200833 vim_regfree(DEBUGGY(gap, todel).dbg_prog);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000834 --gap->ga_len;
835 if (todel < gap->ga_len)
836 mch_memmove(&DEBUGGY(gap, todel), &DEBUGGY(gap, todel + 1),
837 (gap->ga_len - todel) * sizeof(struct debuggy));
838#ifdef FEAT_PROFILE
839 if (eap->cmdidx == CMD_breakdel)
840#endif
841 ++debug_tick;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000842 if (!del_all)
843 break;
844 }
Bram Moolenaard9fba312005-06-26 22:34:35 +0000845
846 /* If all breakpoints were removed clear the array. */
847 if (gap->ga_len == 0)
848 ga_clear(gap);
849 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850}
851
852/*
853 * ":breaklist".
854 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100856ex_breaklist(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857{
858 struct debuggy *bp;
859 int i;
860
861 if (dbg_breakp.ga_len == 0)
862 MSG(_("No breakpoints defined"));
863 else
864 for (i = 0; i < dbg_breakp.ga_len; ++i)
865 {
866 bp = &BREAKP(i);
Bram Moolenaard58ea072011-06-26 04:25:30 +0200867 if (bp->dbg_type == DBG_FILE)
868 home_replace(NULL, bp->dbg_name, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100869 if (bp->dbg_type != DBG_EXPR)
870 smsg((char_u *)_("%3d %s %s line %ld"),
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 bp->dbg_nr,
872 bp->dbg_type == DBG_FUNC ? "func" : "file",
Bram Moolenaard58ea072011-06-26 04:25:30 +0200873 bp->dbg_type == DBG_FUNC ? bp->dbg_name : NameBuff,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 (long)bp->dbg_lnum);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100875 else
876 smsg((char_u *)_("%3d expr %s"),
877 bp->dbg_nr, bp->dbg_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 }
879}
880
881/*
882 * Find a breakpoint for a function or sourced file.
883 * Returns line number at which to break; zero when no matching breakpoint.
884 */
885 linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100886dbg_find_breakpoint(
887 int file, /* TRUE for a file, FALSE for a function */
888 char_u *fname, /* file or function name */
889 linenr_T after) /* after this line number */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890{
Bram Moolenaar05159a02005-02-26 23:04:13 +0000891 return debuggy_find(file, fname, after, &dbg_breakp, NULL);
892}
893
894#if defined(FEAT_PROFILE) || defined(PROTO)
895/*
896 * Return TRUE if profiling is on for a function or sourced file.
897 */
898 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100899has_profiling(
900 int file, /* TRUE for a file, FALSE for a function */
901 char_u *fname, /* file or function name */
902 int *fp) /* return: forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000903{
904 return (debuggy_find(file, fname, (linenr_T)0, &prof_ga, fp)
905 != (linenr_T)0);
906}
907#endif
908
909/*
910 * Common code for dbg_find_breakpoint() and has_profiling().
911 */
912 static linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100913debuggy_find(
914 int file, /* TRUE for a file, FALSE for a function */
915 char_u *fname, /* file or function name */
916 linenr_T after, /* after this line number */
917 garray_T *gap, /* either &dbg_breakp or &prof_ga */
918 int *fp) /* if not NULL: return forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000919{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 struct debuggy *bp;
921 int i;
922 linenr_T lnum = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923 char_u *name = fname;
924 int prev_got_int;
925
Bram Moolenaar05159a02005-02-26 23:04:13 +0000926 /* Return quickly when there are no breakpoints. */
927 if (gap->ga_len == 0)
928 return (linenr_T)0;
929
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 /* Replace K_SNR in function name with "<SNR>". */
931 if (!file && fname[0] == K_SPECIAL)
932 {
933 name = alloc((unsigned)STRLEN(fname) + 3);
934 if (name == NULL)
935 name = fname;
936 else
937 {
938 STRCPY(name, "<SNR>");
939 STRCPY(name + 5, fname + 3);
940 }
941 }
942
Bram Moolenaar05159a02005-02-26 23:04:13 +0000943 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000945 /* Skip entries that are not useful or are for a line that is beyond
946 * an already found breakpoint. */
947 bp = &DEBUGGY(gap, i);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100948 if (((bp->dbg_type == DBG_FILE) == file &&
949 bp->dbg_type != DBG_EXPR && (
Bram Moolenaar05159a02005-02-26 23:04:13 +0000950#ifdef FEAT_PROFILE
951 gap == &prof_ga ||
952#endif
953 (bp->dbg_lnum > after && (lnum == 0 || bp->dbg_lnum < lnum)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000956 * Save the value of got_int and reset it. We don't want a
957 * previous interruption cancel matching, only hitting CTRL-C
958 * while matching should abort it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000959 */
960 prev_got_int = got_int;
961 got_int = FALSE;
Bram Moolenaardffa5b82014-11-19 16:38:07 +0100962 if (vim_regexec_prog(&bp->dbg_prog, FALSE, name, (colnr_T)0))
Bram Moolenaar05159a02005-02-26 23:04:13 +0000963 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964 lnum = bp->dbg_lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000965 if (fp != NULL)
966 *fp = bp->dbg_forceit;
967 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 got_int |= prev_got_int;
969 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100970#ifdef FEAT_EVAL
971 else if (bp->dbg_type == DBG_EXPR)
972 {
973 typval_T *tv;
974 int line = FALSE;
975
976 prev_got_int = got_int;
977 got_int = FALSE;
978
979 tv = eval_expr(bp->dbg_name, NULL);
980 if (tv != NULL)
981 {
982 if (bp->dbg_val == NULL)
983 {
984 debug_oldval = typval_tostring(NULL);
985 bp->dbg_val = tv;
986 debug_newval = typval_tostring(bp->dbg_val);
987 line = TRUE;
988 }
989 else
990 {
991 typval_T val3;
992
993 if (typval_copy(bp->dbg_val, &val3) == OK)
994 {
995 if (typval_compare(tv, &val3, TYPE_EQUAL,
996 TRUE, FALSE, TRUE) == OK
997 && tv->vval.v_number == FALSE)
998 {
999 typval_T *v;
1000
1001 line = TRUE;
1002 debug_oldval = typval_tostring(bp->dbg_val);
1003 v = eval_expr(bp->dbg_name, NULL);
1004 debug_newval = typval_tostring(v);
1005 free_tv(bp->dbg_val);
1006 bp->dbg_val = v;
1007 }
1008 }
1009 free_tv(tv);
1010 }
1011 }
1012 else if (bp->dbg_val != NULL)
1013 {
1014 debug_oldval = typval_tostring(bp->dbg_val);
1015 debug_newval = typval_tostring(NULL);
1016 free_tv(bp->dbg_val);
1017 bp->dbg_val = NULL;
1018 line = TRUE;
1019 }
1020
1021 if (line)
1022 {
1023 lnum = after > 0 ? after : 1;
1024 break;
1025 }
1026
1027 got_int |= prev_got_int;
1028 }
1029#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030 }
1031 if (name != fname)
1032 vim_free(name);
1033
1034 return lnum;
1035}
1036
1037/*
1038 * Called when a breakpoint was encountered.
1039 */
1040 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001041dbg_breakpoint(char_u *name, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042{
1043 /* We need to check if this line is actually executed in do_one_cmd() */
1044 debug_breakpoint_name = name;
1045 debug_breakpoint_lnum = lnum;
1046}
Bram Moolenaar05159a02005-02-26 23:04:13 +00001047
1048
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001049# if defined(FEAT_PROFILE) || defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001050/*
1051 * Store the current time in "tm".
1052 */
1053 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001054profile_start(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001055{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001056# ifdef WIN3264
1057 QueryPerformanceCounter(tm);
1058# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001059 gettimeofday(tm, NULL);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001060# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001061}
1062
1063/*
1064 * Compute the elapsed time from "tm" till now and store in "tm".
1065 */
1066 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001067profile_end(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001068{
1069 proftime_T now;
1070
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001071# ifdef WIN3264
1072 QueryPerformanceCounter(&now);
1073 tm->QuadPart = now.QuadPart - tm->QuadPart;
1074# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001075 gettimeofday(&now, NULL);
1076 tm->tv_usec = now.tv_usec - tm->tv_usec;
1077 tm->tv_sec = now.tv_sec - tm->tv_sec;
1078 if (tm->tv_usec < 0)
1079 {
1080 tm->tv_usec += 1000000;
1081 --tm->tv_sec;
1082 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001083# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001084}
1085
1086/*
1087 * Subtract the time "tm2" from "tm".
1088 */
1089 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001090profile_sub(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001091{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001092# ifdef WIN3264
1093 tm->QuadPart -= tm2->QuadPart;
1094# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001095 tm->tv_usec -= tm2->tv_usec;
1096 tm->tv_sec -= tm2->tv_sec;
1097 if (tm->tv_usec < 0)
1098 {
1099 tm->tv_usec += 1000000;
1100 --tm->tv_sec;
1101 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001102# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001103}
1104
1105/*
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001106 * Return a string that represents the time in "tm".
1107 * Uses a static buffer!
1108 */
1109 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001110profile_msg(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001111{
1112 static char buf[50];
1113
1114# ifdef WIN3264
1115 LARGE_INTEGER fr;
1116
1117 QueryPerformanceFrequency(&fr);
1118 sprintf(buf, "%10.6lf", (double)tm->QuadPart / (double)fr.QuadPart);
1119# else
1120 sprintf(buf, "%3ld.%06ld", (long)tm->tv_sec, (long)tm->tv_usec);
Bram Moolenaar76929292008-01-06 19:07:36 +00001121# endif
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001122 return buf;
1123}
1124
Bram Moolenaar79c2c882016-02-07 21:19:28 +01001125# if defined(FEAT_FLOAT) || defined(PROTO)
1126/*
1127 * Return a float that represents the time in "tm".
1128 */
1129 float_T
1130profile_float(proftime_T *tm)
1131{
1132# ifdef WIN3264
1133 LARGE_INTEGER fr;
1134
1135 QueryPerformanceFrequency(&fr);
1136 return (float_T)tm->QuadPart / (float_T)fr.QuadPart;
1137# else
1138 return (float_T)tm->tv_sec + (float_T)tm->tv_usec / 1000000.0;
1139# endif
1140}
1141# endif
1142
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001143/*
Bram Moolenaar76929292008-01-06 19:07:36 +00001144 * Put the time "msec" past now in "tm".
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001145 */
Bram Moolenaar76929292008-01-06 19:07:36 +00001146 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001147profile_setlimit(long msec, proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001148{
1149 if (msec <= 0) /* no limit */
1150 profile_zero(tm);
1151 else
1152 {
1153# ifdef WIN3264
1154 LARGE_INTEGER fr;
1155
1156 QueryPerformanceCounter(tm);
1157 QueryPerformanceFrequency(&fr);
Bram Moolenaarb3c70982008-01-18 10:40:55 +00001158 tm->QuadPart += (LONGLONG)((double)msec / 1000.0 * (double)fr.QuadPart);
Bram Moolenaar76929292008-01-06 19:07:36 +00001159# else
1160 long usec;
1161
1162 gettimeofday(tm, NULL);
1163 usec = (long)tm->tv_usec + (long)msec * 1000;
1164 tm->tv_usec = usec % 1000000L;
1165 tm->tv_sec += usec / 1000000L;
1166# endif
1167 }
1168}
1169
1170/*
1171 * Return TRUE if the current time is past "tm".
1172 */
1173 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001174profile_passed_limit(proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001175{
1176 proftime_T now;
1177
1178# ifdef WIN3264
1179 if (tm->QuadPart == 0) /* timer was not set */
1180 return FALSE;
1181 QueryPerformanceCounter(&now);
1182 return (now.QuadPart > tm->QuadPart);
1183# else
1184 if (tm->tv_sec == 0) /* timer was not set */
1185 return FALSE;
1186 gettimeofday(&now, NULL);
1187 return (now.tv_sec > tm->tv_sec
1188 || (now.tv_sec == tm->tv_sec && now.tv_usec > tm->tv_usec));
1189# endif
1190}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001191
1192/*
1193 * Set the time in "tm" to zero.
1194 */
1195 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001196profile_zero(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001197{
1198# ifdef WIN3264
1199 tm->QuadPart = 0;
1200# else
1201 tm->tv_usec = 0;
1202 tm->tv_sec = 0;
1203# endif
1204}
1205
Bram Moolenaar76929292008-01-06 19:07:36 +00001206# endif /* FEAT_PROFILE || FEAT_RELTIME */
1207
Bram Moolenaar975b5272016-03-15 23:10:59 +01001208# if defined(FEAT_TIMERS) || defined(PROTO)
1209static timer_T *first_timer = NULL;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001210static long last_timer_id = 0;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001211
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001212 static long
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001213proftime_time_left(proftime_T *due, proftime_T *now)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001214{
1215# ifdef WIN3264
1216 LARGE_INTEGER fr;
1217
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001218 if (now->QuadPart > due->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001219 return 0;
1220 QueryPerformanceFrequency(&fr);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001221 return (long)(((double)(due->QuadPart - now->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001222 / (double)fr.QuadPart) * 1000);
1223# else
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001224 if (now->tv_sec > due->tv_sec)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001225 return 0;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001226 return (due->tv_sec - now->tv_sec) * 1000
1227 + (due->tv_usec - now->tv_usec) / 1000;
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001228# endif
1229}
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001230
Bram Moolenaar975b5272016-03-15 23:10:59 +01001231/*
1232 * Insert a timer in the list of timers.
1233 */
1234 static void
1235insert_timer(timer_T *timer)
1236{
1237 timer->tr_next = first_timer;
1238 timer->tr_prev = NULL;
1239 if (first_timer != NULL)
1240 first_timer->tr_prev = timer;
1241 first_timer = timer;
Bram Moolenaar4231da42016-06-02 14:30:04 +02001242 did_add_timer = TRUE;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001243}
1244
1245/*
1246 * Take a timer out of the list of timers.
1247 */
1248 static void
1249remove_timer(timer_T *timer)
1250{
1251 if (timer->tr_prev == NULL)
1252 first_timer = timer->tr_next;
1253 else
1254 timer->tr_prev->tr_next = timer->tr_next;
1255 if (timer->tr_next != NULL)
1256 timer->tr_next->tr_prev = timer->tr_prev;
1257}
1258
1259 static void
1260free_timer(timer_T *timer)
1261{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001262 free_callback(timer->tr_callback, timer->tr_partial);
1263 vim_free(timer);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001264}
1265
1266/*
1267 * Create a timer and return it. NULL if out of memory.
1268 * Caller should set the callback.
1269 */
1270 timer_T *
1271create_timer(long msec, int repeat)
1272{
1273 timer_T *timer = (timer_T *)alloc_clear(sizeof(timer_T));
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001274 long prev_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001275
1276 if (timer == NULL)
1277 return NULL;
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001278 if (++last_timer_id <= prev_id)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001279 /* Overflow! Might cause duplicates... */
1280 last_timer_id = 0;
1281 timer->tr_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001282 insert_timer(timer);
1283 if (repeat != 0)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001284 timer->tr_repeat = repeat - 1;
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001285 timer->tr_interval = msec;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001286
1287 profile_setlimit(msec, &timer->tr_due);
1288 return timer;
1289}
1290
1291/*
1292 * Invoke the callback of "timer".
1293 */
1294 static void
1295timer_callback(timer_T *timer)
1296{
1297 typval_T rettv;
1298 int dummy;
1299 typval_T argv[2];
1300
1301 argv[0].v_type = VAR_NUMBER;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001302 argv[0].vval.v_number = (varnumber_T)timer->tr_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001303 argv[1].v_type = VAR_UNKNOWN;
1304
1305 call_func(timer->tr_callback, (int)STRLEN(timer->tr_callback),
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001306 &rettv, 1, argv, NULL, 0L, 0L, &dummy, TRUE,
Bram Moolenaar975b5272016-03-15 23:10:59 +01001307 timer->tr_partial, NULL);
1308 clear_tv(&rettv);
1309}
1310
1311/*
1312 * Call timers that are due.
1313 * Return the time in msec until the next timer is due.
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001314 * Returns -1 if there are no pending timers.
Bram Moolenaar975b5272016-03-15 23:10:59 +01001315 */
1316 long
Bram Moolenaarcf089462016-06-12 21:18:43 +02001317check_due_timer(void)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001318{
1319 timer_T *timer;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001320 timer_T *timer_next;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001321 long this_due;
Bram Moolenaar597385a2016-03-16 23:24:43 +01001322 long next_due = -1;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001323 proftime_T now;
1324 int did_one = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001325 int need_update_screen = FALSE;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001326 long current_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001327
Bram Moolenaarc577d812017-07-08 22:37:34 +02001328 /* Don't run any timers while exiting or dealing with an error. */
1329 if (exiting || aborting())
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001330 return next_due;
1331
Bram Moolenaar75537a92016-09-05 22:45:28 +02001332 profile_start(&now);
1333 for (timer = first_timer; timer != NULL && !got_int; timer = timer_next)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001334 {
Bram Moolenaar75537a92016-09-05 22:45:28 +02001335 timer_next = timer->tr_next;
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001336
Bram Moolenaar75537a92016-09-05 22:45:28 +02001337 if (timer->tr_id == -1 || timer->tr_firing || timer->tr_paused)
1338 continue;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001339 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001340 if (this_due <= 1)
1341 {
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001342 int save_timer_busy = timer_busy;
1343 int save_vgetc_busy = vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001344 int save_did_emsg = did_emsg;
1345 int save_called_emsg = called_emsg;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001346 int save_must_redraw = must_redraw;
Bram Moolenaare723c422017-09-06 23:40:10 +02001347 int save_trylevel = trylevel;
1348 int save_did_throw = did_throw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001349 int save_ex_pressedreturn = get_pressedreturn();
Bram Moolenaare723c422017-09-06 23:40:10 +02001350 except_T *save_current_exception = current_exception;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001351
Bram Moolenaare723c422017-09-06 23:40:10 +02001352 /* Create a scope for running the timer callback, ignoring most of
1353 * the current scope, such as being inside a try/catch. */
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001354 timer_busy = timer_busy > 0 || vgetc_busy > 0;
1355 vgetc_busy = 0;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001356 called_emsg = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001357 did_emsg = FALSE;
1358 did_uncaught_emsg = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001359 must_redraw = 0;
Bram Moolenaare723c422017-09-06 23:40:10 +02001360 trylevel = 0;
1361 did_throw = FALSE;
1362 current_exception = NULL;
1363
Bram Moolenaar75537a92016-09-05 22:45:28 +02001364 timer->tr_firing = TRUE;
1365 timer_callback(timer);
1366 timer->tr_firing = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001367
Bram Moolenaar75537a92016-09-05 22:45:28 +02001368 timer_next = timer->tr_next;
1369 did_one = TRUE;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001370 timer_busy = save_timer_busy;
1371 vgetc_busy = save_vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001372 if (did_uncaught_emsg)
Bram Moolenaarc577d812017-07-08 22:37:34 +02001373 ++timer->tr_emsg_count;
Bram Moolenaare723c422017-09-06 23:40:10 +02001374 did_emsg = save_did_emsg;
1375 called_emsg = save_called_emsg;
1376 trylevel = save_trylevel;
1377 did_throw = save_did_throw;
1378 current_exception = save_current_exception;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001379 if (must_redraw != 0)
1380 need_update_screen = TRUE;
1381 must_redraw = must_redraw > save_must_redraw
1382 ? must_redraw : save_must_redraw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001383 set_pressedreturn(save_ex_pressedreturn);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001384
1385 /* Only fire the timer again if it repeats and stop_timer() wasn't
1386 * called while inside the callback (tr_id == -1). */
Bram Moolenaarc577d812017-07-08 22:37:34 +02001387 if (timer->tr_repeat != 0 && timer->tr_id != -1
1388 && timer->tr_emsg_count < 3)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001389 {
1390 profile_setlimit(timer->tr_interval, &timer->tr_due);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001391 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001392 if (this_due < 1)
1393 this_due = 1;
1394 if (timer->tr_repeat > 0)
1395 --timer->tr_repeat;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001396 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001397 else
1398 {
1399 this_due = -1;
1400 remove_timer(timer);
1401 free_timer(timer);
1402 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001403 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001404 if (this_due > 0 && (next_due == -1 || next_due > this_due))
1405 next_due = this_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001406 }
1407
1408 if (did_one)
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001409 redraw_after_callback(need_update_screen);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001410
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01001411#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001412 if (bevalexpr_due_set)
1413 {
1414 this_due = proftime_time_left(&bevalexpr_due, &now);
1415 if (this_due <= 1)
1416 {
1417 bevalexpr_due_set = FALSE;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001418 if (balloonEval == NULL)
1419 {
1420 balloonEval = (BalloonEval *)alloc(sizeof(BalloonEval));
1421 balloonEvalForTerm = TRUE;
1422 }
1423 if (balloonEval != NULL)
1424 general_beval_cb(balloonEval, 0);
1425 }
1426 else if (this_due > 0 && (next_due == -1 || next_due > this_due))
1427 next_due = this_due;
1428 }
1429#endif
1430
Bram Moolenaar75537a92016-09-05 22:45:28 +02001431 return current_id != last_timer_id ? 1 : next_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001432}
1433
1434/*
1435 * Find a timer by ID. Returns NULL if not found;
1436 */
1437 timer_T *
Bram Moolenaar75537a92016-09-05 22:45:28 +02001438find_timer(long id)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001439{
1440 timer_T *timer;
1441
Bram Moolenaar75537a92016-09-05 22:45:28 +02001442 if (id >= 0)
1443 {
1444 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1445 if (timer->tr_id == id)
1446 return timer;
1447 }
1448 return NULL;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001449}
1450
1451
1452/*
1453 * Stop a timer and delete it.
1454 */
1455 void
1456stop_timer(timer_T *timer)
1457{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001458 if (timer->tr_firing)
1459 /* Free the timer after the callback returns. */
1460 timer->tr_id = -1;
1461 else
1462 {
1463 remove_timer(timer);
1464 free_timer(timer);
1465 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001466}
Bram Moolenaare3188e22016-05-31 21:13:04 +02001467
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001468 void
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001469stop_all_timers(void)
1470{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001471 timer_T *timer;
1472 timer_T *timer_next;
1473
1474 for (timer = first_timer; timer != NULL; timer = timer_next)
1475 {
1476 timer_next = timer->tr_next;
1477 stop_timer(timer);
1478 }
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001479}
1480
1481 void
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001482add_timer_info(typval_T *rettv, timer_T *timer)
1483{
1484 list_T *list = rettv->vval.v_list;
1485 dict_T *dict = dict_alloc();
1486 dictitem_T *di;
1487 long remaining;
1488 proftime_T now;
1489
1490 if (dict == NULL)
1491 return;
1492 list_append_dict(list, dict);
1493
Bram Moolenaar75537a92016-09-05 22:45:28 +02001494 dict_add_nr_str(dict, "id", timer->tr_id, NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001495 dict_add_nr_str(dict, "time", (long)timer->tr_interval, NULL);
1496
1497 profile_start(&now);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001498 remaining = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001499 dict_add_nr_str(dict, "remaining", (long)remaining, NULL);
1500
1501 dict_add_nr_str(dict, "repeat",
1502 (long)(timer->tr_repeat < 0 ? -1 : timer->tr_repeat + 1), NULL);
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001503 dict_add_nr_str(dict, "paused", (long)(timer->tr_paused), NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001504
1505 di = dictitem_alloc((char_u *)"callback");
1506 if (di != NULL)
1507 {
1508 if (dict_add(dict, di) == FAIL)
1509 vim_free(di);
1510 else if (timer->tr_partial != NULL)
1511 {
1512 di->di_tv.v_type = VAR_PARTIAL;
1513 di->di_tv.vval.v_partial = timer->tr_partial;
1514 ++timer->tr_partial->pt_refcount;
1515 }
1516 else
1517 {
1518 di->di_tv.v_type = VAR_FUNC;
1519 di->di_tv.vval.v_string = vim_strsave(timer->tr_callback);
1520 }
1521 di->di_tv.v_lock = 0;
1522 }
1523}
1524
1525 void
1526add_timer_info_all(typval_T *rettv)
1527{
1528 timer_T *timer;
1529
1530 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001531 if (timer->tr_id != -1)
1532 add_timer_info(rettv, timer);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001533}
1534
Bram Moolenaare3188e22016-05-31 21:13:04 +02001535/*
1536 * Mark references in partials of timers.
1537 */
1538 int
1539set_ref_in_timer(int copyID)
1540{
1541 int abort = FALSE;
1542 timer_T *timer;
1543 typval_T tv;
1544
1545 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1546 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001547 if (timer->tr_partial != NULL)
1548 {
1549 tv.v_type = VAR_PARTIAL;
1550 tv.vval.v_partial = timer->tr_partial;
1551 }
1552 else
1553 {
1554 tv.v_type = VAR_FUNC;
1555 tv.vval.v_string = timer->tr_callback;
1556 }
Bram Moolenaare3188e22016-05-31 21:13:04 +02001557 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
1558 }
1559 return abort;
1560}
Bram Moolenaar623e2632016-07-30 22:47:56 +02001561
1562# if defined(EXITFREE) || defined(PROTO)
1563 void
1564timer_free_all()
1565{
1566 timer_T *timer;
1567
1568 while (first_timer != NULL)
1569 {
1570 timer = first_timer;
1571 remove_timer(timer);
1572 free_timer(timer);
1573 }
1574}
1575# endif
Bram Moolenaar975b5272016-03-15 23:10:59 +01001576# endif
1577
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001578#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1579# if defined(HAVE_MATH_H)
1580# include <math.h>
1581# endif
1582
1583/*
1584 * Divide the time "tm" by "count" and store in "tm2".
1585 */
1586 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001587profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001588{
1589 if (count == 0)
1590 profile_zero(tm2);
1591 else
1592 {
1593# ifdef WIN3264
1594 tm2->QuadPart = tm->QuadPart / count;
1595# else
1596 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1597
1598 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001599 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001600# endif
1601 }
1602}
1603#endif
1604
Bram Moolenaar76929292008-01-06 19:07:36 +00001605# if defined(FEAT_PROFILE) || defined(PROTO)
1606/*
1607 * Functions for profiling.
1608 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001609static void script_do_profile(scriptitem_T *si);
1610static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001611static proftime_T prof_wait_time;
1612
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001613/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001614 * Add the time "tm2" to "tm".
1615 */
1616 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001617profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001618{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001619# ifdef WIN3264
1620 tm->QuadPart += tm2->QuadPart;
1621# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001622 tm->tv_usec += tm2->tv_usec;
1623 tm->tv_sec += tm2->tv_sec;
1624 if (tm->tv_usec >= 1000000)
1625 {
1626 tm->tv_usec -= 1000000;
1627 ++tm->tv_sec;
1628 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001629# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001630}
1631
1632/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001633 * Add the "self" time from the total time and the children's time.
1634 */
1635 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001636profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001637{
1638 /* Check that the result won't be negative. Can happen with recursive
1639 * calls. */
1640#ifdef WIN3264
1641 if (total->QuadPart <= children->QuadPart)
1642 return;
1643#else
1644 if (total->tv_sec < children->tv_sec
1645 || (total->tv_sec == children->tv_sec
1646 && total->tv_usec <= children->tv_usec))
1647 return;
1648#endif
1649 profile_add(self, total);
1650 profile_sub(self, children);
1651}
1652
1653/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001654 * Get the current waittime.
1655 */
1656 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001657profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001658{
1659 *tm = prof_wait_time;
1660}
1661
1662/*
1663 * Subtract the passed waittime since "tm" from "tma".
1664 */
1665 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001666profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001667{
1668 proftime_T tm3 = prof_wait_time;
1669
1670 profile_sub(&tm3, tm);
1671 profile_sub(tma, &tm3);
1672}
1673
1674/*
1675 * Return TRUE if "tm1" and "tm2" are equal.
1676 */
1677 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001678profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001679{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001680# ifdef WIN3264
1681 return (tm1->QuadPart == tm2->QuadPart);
1682# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001683 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001684# endif
1685}
1686
1687/*
1688 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1689 */
1690 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001691profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001692{
1693# ifdef WIN3264
1694 return (int)(tm2->QuadPart - tm1->QuadPart);
1695# else
1696 if (tm1->tv_sec == tm2->tv_sec)
1697 return tm2->tv_usec - tm1->tv_usec;
1698 return tm2->tv_sec - tm1->tv_sec;
1699# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001700}
1701
Bram Moolenaar05159a02005-02-26 23:04:13 +00001702static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001703static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001704
1705/*
1706 * ":profile cmd args"
1707 */
1708 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001709ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001710{
1711 char_u *e;
1712 int len;
1713
1714 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001715 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001716 e = skipwhite(e);
1717
1718 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1719 {
1720 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001721 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001722 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001723 profile_zero(&prof_wait_time);
1724 set_vim_var_nr(VV_PROFILING, 1L);
1725 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001726 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001727 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001728 else if (STRCMP(eap->arg, "pause") == 0)
1729 {
1730 if (do_profiling == PROF_YES)
1731 profile_start(&pause_time);
1732 do_profiling = PROF_PAUSED;
1733 }
1734 else if (STRCMP(eap->arg, "continue") == 0)
1735 {
1736 if (do_profiling == PROF_PAUSED)
1737 {
1738 profile_end(&pause_time);
1739 profile_add(&prof_wait_time, &pause_time);
1740 }
1741 do_profiling = PROF_YES;
1742 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001743 else
1744 {
1745 /* The rest is similar to ":breakadd". */
1746 ex_breakadd(eap);
1747 }
1748}
1749
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001750/* Command line expansion for :profile. */
1751static enum
1752{
1753 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001754 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001755} pexpand_what;
1756
1757static char *pexpand_cmds[] = {
1758 "start",
1759#define PROFCMD_START 0
1760 "pause",
1761#define PROFCMD_PAUSE 1
1762 "continue",
1763#define PROFCMD_CONTINUE 2
1764 "func",
1765#define PROFCMD_FUNC 3
1766 "file",
1767#define PROFCMD_FILE 4
1768 NULL
1769#define PROFCMD_LAST 5
1770};
1771
1772/*
1773 * Function given to ExpandGeneric() to obtain the profile command
1774 * specific expansion.
1775 */
1776 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001777get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001778{
1779 switch (pexpand_what)
1780 {
1781 case PEXP_SUBCMD:
1782 return (char_u *)pexpand_cmds[idx];
1783 /* case PEXP_FUNC: TODO */
1784 default:
1785 return NULL;
1786 }
1787}
1788
1789/*
1790 * Handle command line completion for :profile command.
1791 */
1792 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001793set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001794{
1795 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001796
1797 /* Default: expand subcommands. */
1798 xp->xp_context = EXPAND_PROFILE;
1799 pexpand_what = PEXP_SUBCMD;
1800 xp->xp_pattern = arg;
1801
1802 end_subcmd = skiptowhite(arg);
1803 if (*end_subcmd == NUL)
1804 return;
1805
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001806 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001807 {
1808 xp->xp_context = EXPAND_FILES;
1809 xp->xp_pattern = skipwhite(end_subcmd);
1810 return;
1811 }
1812
1813 /* TODO: expand function names after "func" */
1814 xp->xp_context = EXPAND_NOTHING;
1815}
1816
Bram Moolenaar05159a02005-02-26 23:04:13 +00001817/*
1818 * Dump the profiling info.
1819 */
1820 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001821profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001822{
1823 FILE *fd;
1824
1825 if (profile_fname != NULL)
1826 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001827 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001828 if (fd == NULL)
1829 EMSG2(_(e_notopen), profile_fname);
1830 else
1831 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001832 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001833 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001834 fclose(fd);
1835 }
1836 }
1837}
1838
1839/*
1840 * Start profiling script "fp".
1841 */
1842 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001843script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001844{
1845 si->sn_pr_count = 0;
1846 profile_zero(&si->sn_pr_total);
1847 profile_zero(&si->sn_pr_self);
1848
1849 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1850 si->sn_prl_idx = -1;
1851 si->sn_prof_on = TRUE;
1852 si->sn_pr_nest = 0;
1853}
1854
1855/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02001856 * Save time when starting to invoke another script or function.
Bram Moolenaar05159a02005-02-26 23:04:13 +00001857 */
1858 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001859script_prof_save(
1860 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001861{
1862 scriptitem_T *si;
1863
1864 if (current_SID > 0 && current_SID <= script_items.ga_len)
1865 {
1866 si = &SCRIPT_ITEM(current_SID);
1867 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1868 profile_start(&si->sn_pr_child);
1869 }
1870 profile_get_wait(tm);
1871}
1872
1873/*
1874 * Count time spent in children after invoking another script or function.
1875 */
1876 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001877script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001878{
1879 scriptitem_T *si;
1880
1881 if (current_SID > 0 && current_SID <= script_items.ga_len)
1882 {
1883 si = &SCRIPT_ITEM(current_SID);
1884 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1885 {
1886 profile_end(&si->sn_pr_child);
1887 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1888 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1889 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1890 }
1891 }
1892}
1893
1894static proftime_T inchar_time;
1895
1896/*
1897 * Called when starting to wait for the user to type a character.
1898 */
1899 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001900prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001901{
1902 profile_start(&inchar_time);
1903}
1904
1905/*
1906 * Called when finished waiting for the user to type a character.
1907 */
1908 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001909prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001910{
1911 profile_end(&inchar_time);
1912 profile_add(&prof_wait_time, &inchar_time);
1913}
1914
1915/*
1916 * Dump the profiling results for all scripts in file "fd".
1917 */
1918 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001919script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001920{
1921 int id;
1922 scriptitem_T *si;
1923 int i;
1924 FILE *sfd;
1925 sn_prl_T *pp;
1926
1927 for (id = 1; id <= script_items.ga_len; ++id)
1928 {
1929 si = &SCRIPT_ITEM(id);
1930 if (si->sn_prof_on)
1931 {
1932 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1933 if (si->sn_pr_count == 1)
1934 fprintf(fd, "Sourced 1 time\n");
1935 else
1936 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1937 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1938 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1939 fprintf(fd, "\n");
1940 fprintf(fd, "count total (s) self (s)\n");
1941
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001942 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001943 if (sfd == NULL)
1944 fprintf(fd, "Cannot open file!\n");
1945 else
1946 {
Bram Moolenaar67435d92017-10-19 21:04:37 +02001947 /* Keep going till the end of file, so that trailing
1948 * continuation lines are listed. */
1949 for (i = 0; ; ++i)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001950 {
1951 if (vim_fgets(IObuff, IOSIZE, sfd))
1952 break;
Bram Moolenaarac112f02017-12-05 16:46:28 +01001953 /* When a line has been truncated, append NL, taking care
1954 * of multi-byte characters . */
1955 if (IObuff[IOSIZE - 2] != NUL && IObuff[IOSIZE - 2] != NL)
1956 {
1957 int n = IOSIZE - 2;
1958# ifdef FEAT_MBYTE
1959 if (enc_utf8)
1960 {
1961 /* Move to the first byte of this char.
1962 * utf_head_off() doesn't work, because it checks
1963 * for a truncated character. */
1964 while (n > 0 && (IObuff[n] & 0xc0) == 0x80)
1965 --n;
1966 }
1967 else if (has_mbyte)
1968 n -= mb_head_off(IObuff, IObuff + n);
1969# endif
1970 IObuff[n] = NL;
1971 IObuff[n + 1] = NUL;
1972 }
Bram Moolenaar67435d92017-10-19 21:04:37 +02001973 if (i < si->sn_prl_ga.ga_len
1974 && (pp = &PRL_ITEM(si, i))->snp_count > 0)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001975 {
1976 fprintf(fd, "%5d ", pp->snp_count);
1977 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1978 fprintf(fd, " ");
1979 else
1980 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1981 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1982 }
1983 else
1984 fprintf(fd, " ");
1985 fprintf(fd, "%s", IObuff);
1986 }
1987 fclose(sfd);
1988 }
1989 fprintf(fd, "\n");
1990 }
1991 }
1992}
1993
1994/*
1995 * Return TRUE when a function defined in the current script should be
1996 * profiled.
1997 */
1998 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001999prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00002000{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00002001 if (current_SID > 0)
2002 return SCRIPT_ITEM(current_SID).sn_pr_force;
2003 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00002004}
2005
2006# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007#endif
2008
2009/*
2010 * If 'autowrite' option set, try to write the file.
2011 * Careful: autocommands may make "buf" invalid!
2012 *
2013 * return FAIL for failure, OK otherwise
2014 */
2015 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002016autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017{
Bram Moolenaar373154b2007-02-13 05:19:30 +00002018 int r;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002019 bufref_T bufref;
Bram Moolenaar373154b2007-02-13 05:19:30 +00002020
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 if (!(p_aw || p_awa) || !p_write
2022#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00002023 /* never autowrite a "nofile" or "nowrite" buffer */
2024 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00002026 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 return FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002028 set_bufref(&bufref, buf);
Bram Moolenaar373154b2007-02-13 05:19:30 +00002029 r = buf_write_all(buf, forceit);
2030
2031 /* Writing may succeed but the buffer still changed, e.g., when there is a
2032 * conversion error. We do want to return FAIL then. */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002033 if (bufref_valid(&bufref) && bufIsChanged(buf))
Bram Moolenaar373154b2007-02-13 05:19:30 +00002034 r = FAIL;
2035 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002036}
2037
2038/*
2039 * flush all buffers, except the ones that are readonly
2040 */
2041 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002042autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043{
2044 buf_T *buf;
2045
2046 if (!(p_aw || p_awa) || !p_write)
2047 return;
Bram Moolenaar29323592016-07-24 22:04:11 +02002048 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 if (bufIsChanged(buf) && !buf->b_p_ro)
2050 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002051#ifdef FEAT_AUTOCMD
2052 bufref_T bufref;
2053
2054 set_bufref(&bufref, buf);
2055#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 (void)buf_write_all(buf, FALSE);
2057#ifdef FEAT_AUTOCMD
2058 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002059 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 buf = firstbuf;
2061#endif
2062 }
2063}
2064
2065/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002066 * Return TRUE if buffer was changed and cannot be abandoned.
2067 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002069 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002070check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071{
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002072 int forceit = (flags & CCGD_FORCEIT);
2073#ifdef FEAT_AUTOCMD
2074 bufref_T bufref;
2075
2076 set_bufref(&bufref, buf);
2077#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002078
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 if ( !forceit
2080 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002081 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
2082 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002083 {
2084#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2085 if ((p_confirm || cmdmod.confirm) && p_write)
2086 {
2087 buf_T *buf2;
2088 int count = 0;
2089
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002090 if (flags & CCGD_ALLBUF)
Bram Moolenaar29323592016-07-24 22:04:11 +02002091 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002092 if (bufIsChanged(buf2)
2093 && (buf2->b_ffname != NULL
2094# ifdef FEAT_BROWSE
2095 || cmdmod.browse
2096# endif
2097 ))
2098 ++count;
2099# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002100 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 /* Autocommand deleted buffer, oops! It's not changed now. */
2102 return FALSE;
2103# endif
2104 dialog_changed(buf, count > 1);
2105# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002106 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 /* Autocommand deleted buffer, oops! It's not changed now. */
2108 return FALSE;
2109# endif
2110 return bufIsChanged(buf);
2111 }
2112#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002113 if (flags & CCGD_EXCMD)
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002114 no_write_message();
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002115 else
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002116 no_write_message_nobang();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 return TRUE;
2118 }
2119 return FALSE;
2120}
2121
2122#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
2123
2124#if defined(FEAT_BROWSE) || defined(PROTO)
2125/*
2126 * When wanting to write a file without a file name, ask the user for a name.
2127 */
2128 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002129browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130{
2131 if (buf->b_fname == NULL)
2132 {
2133 char_u *fname;
2134
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002135 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
2136 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 if (fname != NULL)
2138 {
2139 if (setfname(buf, fname, NULL, TRUE) == OK)
2140 buf->b_flags |= BF_NOTEDITED;
2141 vim_free(fname);
2142 }
2143 }
2144}
2145#endif
2146
2147/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02002148 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 * Must check 'write' option first!
2150 */
2151 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002152dialog_changed(
2153 buf_T *buf,
2154 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155{
Bram Moolenaard9462e32011-04-11 21:35:11 +02002156 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 int ret;
2158 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02002159 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160
Bram Moolenaar3f9a1ff2017-08-21 22:06:02 +02002161 dialog_msg(buff, _("Save changes to \"%s\"?"), buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 if (checkall)
2163 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
2164 else
2165 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
2166
Bram Moolenaar8218f602012-04-25 17:32:18 +02002167 /* Init ea pseudo-structure, this is needed for the check_overwrite()
2168 * function. */
2169 ea.append = ea.forceit = FALSE;
2170
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 if (ret == VIM_YES)
2172 {
2173#ifdef FEAT_BROWSE
2174 /* May get file name, when there is none */
2175 browse_save_fname(buf);
2176#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002177 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
2178 buf->b_fname, buf->b_ffname, FALSE) == OK)
2179 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 (void)buf_write_all(buf, FALSE);
2181 }
2182 else if (ret == VIM_NO)
2183 {
2184 unchanged(buf, TRUE);
2185 }
2186 else if (ret == VIM_ALL)
2187 {
2188 /*
2189 * Write all modified files that can be written.
2190 * Skip readonly buffers, these need to be confirmed
2191 * individually.
2192 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002193 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 {
2195 if (bufIsChanged(buf2)
2196 && (buf2->b_ffname != NULL
2197#ifdef FEAT_BROWSE
2198 || cmdmod.browse
2199#endif
2200 )
2201 && !buf2->b_p_ro)
2202 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002203#ifdef FEAT_AUTOCMD
2204 bufref_T bufref;
2205
2206 set_bufref(&bufref, buf2);
2207#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208#ifdef FEAT_BROWSE
2209 /* May get file name, when there is none */
2210 browse_save_fname(buf2);
2211#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002212 if (buf2->b_fname != NULL && check_overwrite(&ea, buf2,
2213 buf2->b_fname, buf2->b_ffname, FALSE) == OK)
2214 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 (void)buf_write_all(buf2, FALSE);
2216#ifdef FEAT_AUTOCMD
2217 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002218 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 buf2 = firstbuf;
2220#endif
2221 }
2222 }
2223 }
2224 else if (ret == VIM_DISCARDALL)
2225 {
2226 /*
2227 * mark all buffers as unchanged
2228 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002229 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 unchanged(buf2, TRUE);
2231 }
2232}
2233#endif
2234
2235/*
2236 * Return TRUE if the buffer "buf" can be abandoned, either by making it
2237 * hidden, autowriting it or unloading it.
2238 */
2239 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002240can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002241{
Bram Moolenaareb44a682017-08-03 22:44:55 +02002242 return ( buf_hide(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 || !bufIsChanged(buf)
2244 || buf->b_nwindows > 1
2245 || autowrite(buf, forceit) == OK
2246 || forceit);
2247}
2248
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002249static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002250
2251/*
2252 * Add a buffer number to "bufnrs", unless it's already there.
2253 */
2254 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002255add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002256{
2257 int i;
2258
2259 for (i = 0; i < *bufnump; ++i)
2260 if (bufnrs[i] == nr)
2261 return;
2262 bufnrs[*bufnump] = nr;
2263 *bufnump = *bufnump + 1;
2264}
2265
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266/*
2267 * Return TRUE if any buffer was changed and cannot be abandoned.
2268 * That changed buffer becomes the current buffer.
Bram Moolenaar027387f2016-01-02 22:25:52 +01002269 * When "unload" is true the current buffer is unloaded instead of making it
2270 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271 */
2272 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002273check_changed_any(
2274 int hidden, /* Only check hidden buffers */
2275 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002277 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 buf_T *buf;
2279 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002280 int i;
2281 int bufnum = 0;
2282 int bufcount = 0;
2283 int *bufnrs;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002284 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286
Bram Moolenaar29323592016-07-24 22:04:11 +02002287 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002288 ++bufcount;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002290 if (bufcount == 0)
2291 return FALSE;
2292
2293 bufnrs = (int *)alloc(sizeof(int) * bufcount);
2294 if (bufnrs == NULL)
2295 return FALSE;
2296
2297 /* curbuf */
2298 bufnrs[bufnum++] = curbuf->b_fnum;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002299 /* buf in curtab */
2300 FOR_ALL_WINDOWS(wp)
2301 if (wp->w_buffer != curbuf)
2302 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2303
2304 /* buf in other tab */
Bram Moolenaar29323592016-07-24 22:04:11 +02002305 FOR_ALL_TABPAGES(tp)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002306 if (tp != curtab)
2307 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
2308 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002309 /* any other buf */
Bram Moolenaar29323592016-07-24 22:04:11 +02002310 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002311 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
2312
2313 for (i = 0; i < bufnum; ++i)
2314 {
2315 buf = buflist_findnr(bufnrs[i]);
2316 if (buf == NULL)
2317 continue;
2318 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
2319 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002320 bufref_T bufref;
2321
2322 set_bufref(&bufref, buf);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002323 /* Try auto-writing the buffer. If this fails but the buffer no
2324 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002325 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
2326 | CCGD_MULTWIN
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002327 | CCGD_ALLBUF) && bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002328 break; /* didn't save - still changes */
2329 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002330 }
2331
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002332 if (i >= bufnum)
2333 goto theend;
2334
2335 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336 exiting = FALSE;
2337#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2338 /*
2339 * When ":confirm" used, don't give an error message.
2340 */
2341 if (!(p_confirm || cmdmod.confirm))
2342#endif
2343 {
2344 /* There must be a wait_return for this message, do_buffer()
2345 * may cause a redraw. But wait_return() is a no-op when vgetc()
2346 * is busy (Quit used from window menu), then make sure we don't
2347 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00002348 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 {
2350 msg_row = cmdline_row;
2351 msg_col = 0;
2352 msg_didout = FALSE;
2353 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002354 if (
2355#ifdef FEAT_TERMINAL
2356 term_job_running(buf->b_term)
2357 ? EMSG2(_("E947: Job still running in buffer \"%s\""),
2358 buf->b_fname)
2359 :
2360#endif
2361 EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002362 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 {
2364 save = no_wait_return;
2365 no_wait_return = FALSE;
2366 wait_return(FALSE);
2367 no_wait_return = save;
2368 }
2369 }
2370
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 /* Try to find a window that contains the buffer. */
2372 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002373 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374 if (wp->w_buffer == buf)
2375 {
Bram Moolenaar4033c552017-09-16 20:54:51 +02002376#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002377 bufref_T bufref;
2378
2379 set_bufref(&bufref, buf);
Bram Moolenaar4033c552017-09-16 20:54:51 +02002380#endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002381 goto_tabpage_win(tp, wp);
Bram Moolenaar4033c552017-09-16 20:54:51 +02002382#ifdef FEAT_AUTOCMD
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 /* Paranoia: did autocms wipe out the buffer with changes? */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002384 if (!bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002385 {
2386 goto theend;
2387 }
Bram Moolenaar4033c552017-09-16 20:54:51 +02002388#endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002389 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002391buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392
2393 /* Open the changed buffer in the current window. */
2394 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002395 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002397theend:
2398 vim_free(bufnrs);
2399 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400}
2401
2402/*
2403 * return FAIL if there is no file name, OK if there is one
2404 * give error message for FAIL
2405 */
2406 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002407check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002408{
2409 if (curbuf->b_ffname == NULL)
2410 {
2411 EMSG(_(e_noname));
2412 return FAIL;
2413 }
2414 return OK;
2415}
2416
2417/*
2418 * flush the contents of a buffer, unless it has no file name
2419 *
2420 * return FAIL for failure, OK otherwise
2421 */
2422 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002423buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424{
2425 int retval;
2426#ifdef FEAT_AUTOCMD
2427 buf_T *old_curbuf = curbuf;
2428#endif
2429
2430 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2431 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2432 FALSE, forceit, TRUE, FALSE));
2433#ifdef FEAT_AUTOCMD
2434 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002435 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01002436 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002438 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439#endif
2440 return retval;
2441}
2442
2443/*
2444 * Code to handle the argument list.
2445 */
2446
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002447static char_u *do_one_arg(char_u *str);
2448static int do_arglist(char_u *str, int what, int after);
2449static void alist_check_arg_idx(void);
2450static int editing_arg_idx(win_T *win);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002451#ifdef FEAT_LISTCMDS
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002452static int alist_add_list(int count, char_u **files, int after);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002453#endif
2454#define AL_SET 1
2455#define AL_ADD 2
2456#define AL_DEL 3
2457
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002459 * Isolate one argument, taking backticks.
2460 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002461 * Return a pointer to the start of the next argument.
2462 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002463 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002464do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465{
2466 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 int inbacktick;
2468
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 inbacktick = FALSE;
2470 for (p = str; *str; ++str)
2471 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002472 /* When the backslash is used for escaping the special meaning of a
2473 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 if (rem_backslash(str))
2475 {
2476 *p++ = *str++;
2477 *p++ = *str;
2478 }
2479 else
2480 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002481 /* An item ends at a space not in backticks */
2482 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002484 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002486 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 }
2488 }
2489 str = skipwhite(str);
2490 *p = NUL;
2491
2492 return str;
2493}
2494
Bram Moolenaar86b68352004-12-27 21:59:20 +00002495/*
2496 * Separate the arguments in "str" and return a list of pointers in the
2497 * growarray "gap".
2498 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002499 static int
2500get_arglist(garray_T *gap, char_u *str, int escaped)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002501{
2502 ga_init2(gap, (int)sizeof(char_u *), 20);
2503 while (*str != NUL)
2504 {
2505 if (ga_grow(gap, 1) == FAIL)
2506 {
2507 ga_clear(gap);
2508 return FAIL;
2509 }
2510 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2511
Bram Moolenaar398ee732017-08-03 14:29:14 +02002512 /* If str is escaped, don't handle backslashes or spaces */
2513 if (!escaped)
2514 return OK;
2515
Bram Moolenaar86b68352004-12-27 21:59:20 +00002516 /* Isolate one argument, change it in-place, put a NUL after it. */
2517 str = do_one_arg(str);
2518 }
2519 return OK;
2520}
2521
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002522#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002523/*
2524 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002525 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002526 * Return FAIL or OK.
2527 */
2528 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002529get_arglist_exp(
2530 char_u *str,
2531 int *fcountp,
2532 char_u ***fnamesp,
2533 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002534{
2535 garray_T ga;
2536 int i;
2537
Bram Moolenaar398ee732017-08-03 14:29:14 +02002538 if (get_arglist(&ga, str, TRUE) == FAIL)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002539 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002540 if (wig == TRUE)
2541 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2542 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2543 else
2544 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2545 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2546
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002547 ga_clear(&ga);
2548 return i;
2549}
2550#endif
2551
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552/*
2553 * Redefine the argument list.
2554 */
2555 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002556set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557{
2558 do_arglist(str, AL_SET, 0);
2559}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560
2561/*
2562 * "what" == AL_SET: Redefine the argument list to 'str'.
2563 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2564 * "what" == AL_DEL: remove files in 'str' from the argument list.
2565 *
2566 * Return FAIL for failure, OK otherwise.
2567 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002569do_arglist(
2570 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002571 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002572 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573{
2574 garray_T new_ga;
2575 int exp_count;
2576 char_u **exp_files;
2577 int i;
2578#ifdef FEAT_LISTCMDS
2579 char_u *p;
2580 int match;
2581#endif
Bram Moolenaar398ee732017-08-03 14:29:14 +02002582 int arg_escaped = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583
2584 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002585 * Set default argument for ":argadd" command.
2586 */
2587 if (what == AL_ADD && *str == NUL)
2588 {
2589 if (curbuf->b_ffname == NULL)
2590 return FAIL;
2591 str = curbuf->b_fname;
Bram Moolenaar398ee732017-08-03 14:29:14 +02002592 arg_escaped = FALSE;
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002593 }
2594
2595 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 * Collect all file name arguments in "new_ga".
2597 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002598 if (get_arglist(&new_ga, str, arg_escaped) == FAIL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002599 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600
2601#ifdef FEAT_LISTCMDS
2602 if (what == AL_DEL)
2603 {
2604 regmatch_T regmatch;
2605 int didone;
2606
2607 /*
2608 * Delete the items: use each item as a regexp and find a match in the
2609 * argument list.
2610 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002611 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002612 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2613 {
2614 p = ((char_u **)new_ga.ga_data)[i];
2615 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2616 if (p == NULL)
2617 break;
2618 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2619 if (regmatch.regprog == NULL)
2620 {
2621 vim_free(p);
2622 break;
2623 }
2624
2625 didone = FALSE;
2626 for (match = 0; match < ARGCOUNT; ++match)
2627 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2628 (colnr_T)0))
2629 {
2630 didone = TRUE;
2631 vim_free(ARGLIST[match].ae_fname);
2632 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2633 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2634 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 if (curwin->w_arg_idx > match)
2636 --curwin->w_arg_idx;
2637 --match;
2638 }
2639
Bram Moolenaar473de612013-06-08 18:19:48 +02002640 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002641 vim_free(p);
2642 if (!didone)
2643 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2644 }
2645 ga_clear(&new_ga);
2646 }
2647 else
2648#endif
2649 {
2650 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2651 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2652 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002653 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 {
2655 EMSG(_(e_nomatch));
2656 return FAIL;
2657 }
2658
2659#ifdef FEAT_LISTCMDS
2660 if (what == AL_ADD)
2661 {
2662 (void)alist_add_list(exp_count, exp_files, after);
2663 vim_free(exp_files);
2664 }
2665 else /* what == AL_SET */
2666#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00002667 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 }
2669
2670 alist_check_arg_idx();
2671
2672 return OK;
2673}
2674
2675/*
2676 * Check the validity of the arg_idx for each other window.
2677 */
2678 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002679alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002682 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683
Bram Moolenaarf740b292006-02-16 22:11:02 +00002684 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 if (win->w_alist == curwin->w_alist)
2686 check_arg_idx(win);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687}
2688
2689/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002690 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002691 * index.
2692 */
2693 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002694editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002695{
2696 return !(win->w_arg_idx >= WARGCOUNT(win)
2697 || (win->w_buffer->b_fnum
2698 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2699 && (win->w_buffer->b_ffname == NULL
2700 || !(fullpathcmp(
2701 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2702 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2703}
2704
2705/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 * Check if window "win" is editing the w_arg_idx file in its argument list.
2707 */
2708 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002709check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002711 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 {
2713 /* We are not editing the current entry in the argument list.
2714 * Set "arg_had_last" if we are editing the last one. */
2715 win->w_arg_idx_invalid = TRUE;
2716 if (win->w_arg_idx != WARGCOUNT(win) - 1
2717 && arg_had_last == FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 && ALIST(win) == &global_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719 && GARGCOUNT > 0
2720 && win->w_arg_idx < GARGCOUNT
2721 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2722 || (win->w_buffer->b_ffname != NULL
2723 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2724 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2725 arg_had_last = TRUE;
2726 }
2727 else
2728 {
2729 /* We are editing the current entry in the argument list.
2730 * Set "arg_had_last" if it's also the last one */
2731 win->w_arg_idx_invalid = FALSE;
2732 if (win->w_arg_idx == WARGCOUNT(win) - 1
Bram Moolenaar4033c552017-09-16 20:54:51 +02002733 && win->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 arg_had_last = TRUE;
2735 }
2736}
2737
2738/*
2739 * ":args", ":argslocal" and ":argsglobal".
2740 */
2741 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002742ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743{
2744 int i;
2745
2746 if (eap->cmdidx != CMD_args)
2747 {
Bram Moolenaar4033c552017-09-16 20:54:51 +02002748#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749 alist_unlink(ALIST(curwin));
2750 if (eap->cmdidx == CMD_argglobal)
2751 ALIST(curwin) = &global_alist;
2752 else /* eap->cmdidx == CMD_arglocal */
2753 alist_new();
2754#else
2755 ex_ni(eap);
2756 return;
2757#endif
2758 }
2759
2760 if (!ends_excmd(*eap->arg))
2761 {
2762 /*
2763 * ":args file ..": define new argument list, handle like ":next"
2764 * Also for ":argslocal file .." and ":argsglobal file ..".
2765 */
2766 ex_next(eap);
2767 }
2768 else
Bram Moolenaar4033c552017-09-16 20:54:51 +02002769#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 if (eap->cmdidx == CMD_args)
2771#endif
2772 {
2773 /*
2774 * ":args": list arguments.
2775 */
2776 if (ARGCOUNT > 0)
2777 {
2778 /* Overwrite the command, for a short list there is no scrolling
2779 * required and no wait_return(). */
2780 gotocmdline(TRUE);
2781 for (i = 0; i < ARGCOUNT; ++i)
2782 {
2783 if (i == curwin->w_arg_idx)
2784 msg_putchar('[');
2785 msg_outtrans(alist_name(&ARGLIST[i]));
2786 if (i == curwin->w_arg_idx)
2787 msg_putchar(']');
2788 msg_putchar(' ');
2789 }
2790 }
2791 }
Bram Moolenaar4033c552017-09-16 20:54:51 +02002792#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 else if (eap->cmdidx == CMD_arglocal)
2794 {
2795 garray_T *gap = &curwin->w_alist->al_ga;
2796
2797 /*
2798 * ":argslocal": make a local copy of the global argument list.
2799 */
2800 if (ga_grow(gap, GARGCOUNT) == OK)
2801 for (i = 0; i < GARGCOUNT; ++i)
2802 if (GARGLIST[i].ae_fname != NULL)
2803 {
2804 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2805 vim_strsave(GARGLIST[i].ae_fname);
2806 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2807 GARGLIST[i].ae_fnum;
2808 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 }
2810 }
2811#endif
2812}
2813
2814/*
2815 * ":previous", ":sprevious", ":Next" and ":sNext".
2816 */
2817 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002818ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819{
2820 /* If past the last one already, go to the last one. */
2821 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2822 do_argfile(eap, ARGCOUNT - 1);
2823 else
2824 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2825}
2826
2827/*
2828 * ":rewind", ":first", ":sfirst" and ":srewind".
2829 */
2830 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002831ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002832{
2833 do_argfile(eap, 0);
2834}
2835
2836/*
2837 * ":last" and ":slast".
2838 */
2839 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002840ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002841{
2842 do_argfile(eap, ARGCOUNT - 1);
2843}
2844
2845/*
2846 * ":argument" and ":sargument".
2847 */
2848 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002849ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850{
2851 int i;
2852
2853 if (eap->addr_count > 0)
2854 i = eap->line2 - 1;
2855 else
2856 i = curwin->w_arg_idx;
2857 do_argfile(eap, i);
2858}
2859
2860/*
2861 * Edit file "argn" of the argument lists.
2862 */
2863 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002864do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865{
2866 int other;
2867 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002868 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869
2870 if (argn < 0 || argn >= ARGCOUNT)
2871 {
2872 if (ARGCOUNT <= 1)
2873 EMSG(_("E163: There is only one file to edit"));
2874 else if (argn < 0)
2875 EMSG(_("E164: Cannot go before first file"));
2876 else
2877 EMSG(_("E165: Cannot go beyond last file"));
2878 }
2879 else
2880 {
2881 setpcmark();
2882#ifdef FEAT_GUI
2883 need_mouse_correct = TRUE;
2884#endif
2885
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002886 /* split window or create new tab page first */
2887 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 {
2889 if (win_split(0, 0) == FAIL)
2890 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002891 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 }
2893 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 {
2895 /*
2896 * if 'hidden' set, only check for changed file when re-editing
2897 * the same buffer
2898 */
2899 other = TRUE;
Bram Moolenaareb44a682017-08-03 22:44:55 +02002900 if (buf_hide(curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 {
2902 p = fix_fname(alist_name(&ARGLIST[argn]));
2903 other = otherfile(p);
2904 vim_free(p);
2905 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002906 if ((!buf_hide(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002907 && check_changed(curbuf, CCGD_AW
2908 | (other ? 0 : CCGD_MULTWIN)
2909 | (eap->forceit ? CCGD_FORCEIT : 0)
2910 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 return;
2912 }
2913
2914 curwin->w_arg_idx = argn;
Bram Moolenaar4033c552017-09-16 20:54:51 +02002915 if (argn == ARGCOUNT - 1 && curwin->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 arg_had_last = TRUE;
2917
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002918 /* Edit the file; always use the last known line number.
2919 * When it fails (e.g. Abort for already edited file) restore the
2920 * argument index. */
2921 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002922 eap, ECMD_LAST,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002923 (buf_hide(curwin->w_buffer) ? ECMD_HIDE : 0)
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002924 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002925 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002927 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 setmark('\'');
2929 }
2930}
2931
2932/*
2933 * ":next", and commands that behave like it.
2934 */
2935 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002936ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937{
2938 int i;
2939
2940 /*
2941 * check for changed buffer now, if this fails the argument list is not
2942 * redefined.
2943 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002944 if ( buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002946 || !check_changed(curbuf, CCGD_AW
2947 | (eap->forceit ? CCGD_FORCEIT : 0)
2948 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 {
2950 if (*eap->arg != NUL) /* redefine file list */
2951 {
2952 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2953 return;
2954 i = 0;
2955 }
2956 else
2957 i = curwin->w_arg_idx + (int)eap->line2;
2958 do_argfile(eap, i);
2959 }
2960}
2961
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002962#if defined(FEAT_LISTCMDS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963/*
2964 * ":argedit"
2965 */
2966 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002967ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968{
Bram Moolenaar90305c62017-07-16 15:31:17 +02002969 int i = eap->addr_count ? (int)eap->line2 : curwin->w_arg_idx + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970
Bram Moolenaar90305c62017-07-16 15:31:17 +02002971 if (do_arglist(eap->arg, AL_ADD, i) == FAIL)
2972 return;
2973#ifdef FEAT_TITLE
2974 maketitle();
2975#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976
Bram Moolenaar90305c62017-07-16 15:31:17 +02002977 if (curwin->w_arg_idx == 0 && (curbuf->b_ml.ml_flags & ML_EMPTY)
2978 && curbuf->b_ffname == NULL)
2979 i = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 /* Edit the argument. */
Bram Moolenaar90305c62017-07-16 15:31:17 +02002981 if (i < ARGCOUNT)
2982 do_argfile(eap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983}
2984
2985/*
2986 * ":argadd"
2987 */
2988 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002989ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990{
2991 do_arglist(eap->arg, AL_ADD,
2992 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2993#ifdef FEAT_TITLE
2994 maketitle();
2995#endif
2996}
2997
2998/*
2999 * ":argdelete"
3000 */
3001 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003002ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003{
3004 int i;
3005 int n;
3006
3007 if (eap->addr_count > 0)
3008 {
3009 /* ":1,4argdel": Delete all arguments in the range. */
3010 if (eap->line2 > ARGCOUNT)
3011 eap->line2 = ARGCOUNT;
3012 n = eap->line2 - eap->line1 + 1;
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01003013 if (*eap->arg != NUL)
3014 /* Can't have both a range and an argument. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 EMSG(_(e_invarg));
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01003016 else if (n <= 0)
3017 {
3018 /* Don't give an error for ":%argdel" if the list is empty. */
3019 if (eap->line1 != 1 || eap->line2 != 0)
3020 EMSG(_(e_invrange));
3021 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 else
3023 {
3024 for (i = eap->line1; i <= eap->line2; ++i)
3025 vim_free(ARGLIST[i - 1].ae_fname);
3026 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
3027 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
3028 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 if (curwin->w_arg_idx >= eap->line2)
3030 curwin->w_arg_idx -= n;
3031 else if (curwin->w_arg_idx > eap->line1)
3032 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01003033 if (ARGCOUNT == 0)
3034 curwin->w_arg_idx = 0;
3035 else if (curwin->w_arg_idx >= ARGCOUNT)
3036 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 }
3038 }
3039 else if (*eap->arg == NUL)
3040 EMSG(_(e_argreq));
3041 else
3042 do_arglist(eap->arg, AL_DEL, 0);
3043#ifdef FEAT_TITLE
3044 maketitle();
3045#endif
3046}
3047
3048/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003049 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050 */
3051 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003052ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053{
3054 int i;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003055 win_T *wp;
3056 tabpage_T *tp;
Bram Moolenaare25bb902015-02-27 20:33:37 +01003057 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058 int next_fnum = 0;
3059#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
3060 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003062 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003063#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02003064 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003065 int qf_idx;
3066#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01003068#ifndef FEAT_QUICKFIX
3069 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
3070 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3071 {
3072 ex_ni(eap);
3073 return;
3074 }
3075#endif
3076
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003078 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00003079 /* Don't do syntax HL autocommands. Skipping the syntax file is a
3080 * great speed improvement. */
3081 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003082#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003083#ifdef FEAT_CLIPBOARD
3084 start_global_changes();
3085#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003086
3087 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003088 || eap->cmdidx == CMD_tabdo
Bram Moolenaareb44a682017-08-03 22:44:55 +02003089 || buf_hide(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003090 || !check_changed(curbuf, CCGD_AW
3091 | (eap->forceit ? CCGD_FORCEIT : 0)
3092 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003093 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003095 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003096 wp = firstwin;
3097 tp = first_tabpage;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003098 switch (eap->cmdidx)
3099 {
Bram Moolenaara162bc52015-01-07 16:54:21 +01003100 case CMD_windo:
3101 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
3102 i++;
3103 break;
3104 case CMD_tabdo:
3105 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
3106 i++;
3107 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003108 case CMD_argdo:
3109 i = eap->line1 - 1;
3110 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003111 default:
3112 break;
3113 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114 /* set pcmark now */
3115 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003116 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01003117 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003118 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01003119 || !buf->b_p_bl); buf = buf->b_next)
3120 if (buf->b_fnum > eap->line2)
3121 {
3122 buf = NULL;
3123 break;
3124 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003125 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01003126 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003127 }
3128#ifdef FEAT_QUICKFIX
3129 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3130 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3131 {
3132 qf_size = qf_get_size(eap);
3133 if (qf_size <= 0 || eap->line1 > qf_size)
3134 buf = NULL;
3135 else
3136 {
3137 ex_cc(eap);
3138
3139 buf = curbuf;
3140 i = eap->line1 - 1;
3141 if (eap->addr_count <= 0)
3142 /* default is all the quickfix/location list entries */
3143 eap->line2 = qf_size;
3144 }
3145 }
3146#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 else
3148 setpcmark();
3149 listcmd_busy = TRUE; /* avoids setting pcmark below */
3150
Bram Moolenaare25bb902015-02-27 20:33:37 +01003151 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 {
3153 if (eap->cmdidx == CMD_argdo)
3154 {
3155 /* go to argument "i" */
3156 if (i == ARGCOUNT)
3157 break;
3158 /* Don't call do_argfile() when already there, it will try
3159 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003160 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003161 {
3162 /* Clear 'shm' to avoid that the file message overwrites
3163 * any output from the command. */
3164 p_shm_save = vim_strsave(p_shm);
3165 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003166 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003167 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3168 vim_free(p_shm_save);
3169 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 if (curwin->w_arg_idx != i)
3171 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173 else if (eap->cmdidx == CMD_windo)
3174 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003175 /* go to window "wp" */
3176 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003178 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00003179 if (curwin != wp)
3180 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003181 wp = curwin->w_next;
3182 }
3183 else if (eap->cmdidx == CMD_tabdo)
3184 {
3185 /* go to window "tp" */
3186 if (!valid_tabpage(tp))
3187 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02003188 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003189 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191 else if (eap->cmdidx == CMD_bufdo)
3192 {
3193 /* Remember the number of the next listed buffer, in case
3194 * ":bwipe" is used or autocommands do something strange. */
3195 next_fnum = -1;
3196 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
3197 if (buf->b_p_bl)
3198 {
3199 next_fnum = buf->b_fnum;
3200 break;
3201 }
3202 }
3203
Bram Moolenaara162bc52015-01-07 16:54:21 +01003204 ++i;
3205
Bram Moolenaar071d4272004-06-13 20:20:40 +00003206 /* execute the command */
3207 do_cmdline(eap->arg, eap->getline, eap->cookie,
3208 DOCMD_VERBOSE + DOCMD_NOWAIT);
3209
3210 if (eap->cmdidx == CMD_bufdo)
3211 {
3212 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01003213 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 break;
3215 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02003216 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 if (buf->b_fnum == next_fnum)
3218 break;
3219 if (buf == NULL)
3220 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003221
3222 /* Go to the next buffer. Clear 'shm' to avoid that the file
3223 * message overwrites any output from the command. */
3224 p_shm_save = vim_strsave(p_shm);
3225 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003227 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3228 vim_free(p_shm_save);
3229
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003230 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 if (curbuf->b_fnum != next_fnum)
3232 break;
3233 }
3234
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003235#ifdef FEAT_QUICKFIX
3236 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3237 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3238 {
3239 if (i >= qf_size || i >= eap->line2)
3240 break;
3241
3242 qf_idx = qf_get_cur_idx(eap);
3243
3244 ex_cnext(eap);
3245
3246 /* If jumping to the next quickfix entry fails, quit here */
3247 if (qf_get_cur_idx(eap) == qf_idx)
3248 break;
3249 }
3250#endif
3251
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 if (eap->cmdidx == CMD_windo)
3253 {
3254 validate_cursor(); /* cursor may have moved */
3255#ifdef FEAT_SCROLLBIND
3256 /* required when 'scrollbind' has been set */
3257 if (curwin->w_p_scb)
3258 do_check_scrollbind(TRUE);
3259#endif
3260 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01003261
Bram Moolenaara162bc52015-01-07 16:54:21 +01003262 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
3263 if (i+1 > eap->line2)
3264 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003265 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
3266 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 }
3268 listcmd_busy = FALSE;
3269 }
3270
3271#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003272 if (save_ei != NULL)
3273 {
3274 au_event_restore(save_ei);
3275 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
3276 curbuf->b_fname, TRUE, curbuf);
3277 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003278#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003279#ifdef FEAT_CLIPBOARD
3280 end_global_changes();
3281#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282}
3283
3284/*
3285 * Add files[count] to the arglist of the current window after arg "after".
3286 * The file names in files[count] must have been allocated and are taken over.
3287 * Files[] itself is not taken over.
3288 * Returns index of first added argument. Returns -1 when failed (out of mem).
3289 */
3290 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003291alist_add_list(
3292 int count,
3293 char_u **files,
3294 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295{
3296 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003297 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298
3299 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3300 {
3301 if (after < 0)
3302 after = 0;
3303 if (after > ARGCOUNT)
3304 after = ARGCOUNT;
3305 if (after < ARGCOUNT)
3306 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3307 (ARGCOUNT - after) * sizeof(aentry_T));
3308 for (i = 0; i < count; ++i)
3309 {
3310 ARGLIST[after + i].ae_fname = files[i];
3311 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
3312 }
3313 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003314 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3315 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 return after;
3317 }
3318
3319 for (i = 0; i < count; ++i)
3320 vim_free(files[i]);
3321 return -1;
3322}
3323
3324#endif /* FEAT_LISTCMDS */
3325
3326#ifdef FEAT_EVAL
3327/*
3328 * ":compiler[!] {name}"
3329 */
3330 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003331ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332{
3333 char_u *buf;
3334 char_u *old_cur_comp = NULL;
3335 char_u *p;
3336
3337 if (*eap->arg == NUL)
3338 {
3339 /* List all compiler scripts. */
3340 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3341 /* ) keep the indenter happy... */
3342 }
3343 else
3344 {
3345 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3346 if (buf != NULL)
3347 {
3348 if (eap->forceit)
3349 {
3350 /* ":compiler! {name}" sets global options */
3351 do_cmdline_cmd((char_u *)
3352 "command -nargs=* CompilerSet set <args>");
3353 }
3354 else
3355 {
3356 /* ":compiler! {name}" sets local options.
3357 * To remain backwards compatible "current_compiler" is always
3358 * used. A user's compiler plugin may set it, the distributed
3359 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003360 * "b:current_compiler" and restore "current_compiler".
3361 * Explicitly prepend "g:" to make it work in a function. */
3362 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 if (old_cur_comp != NULL)
3364 old_cur_comp = vim_strsave(old_cur_comp);
3365 do_cmdline_cmd((char_u *)
3366 "command -nargs=* CompilerSet setlocal <args>");
3367 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003368 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003369 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370
3371 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003372 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3374 vim_free(buf);
3375
3376 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3377
3378 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003379 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 if (p != NULL)
3381 set_internal_string_var((char_u *)"b:current_compiler", p);
3382
3383 /* Restore "current_compiler" for ":compiler {name}". */
3384 if (!eap->forceit)
3385 {
3386 if (old_cur_comp != NULL)
3387 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003388 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 old_cur_comp);
3390 vim_free(old_cur_comp);
3391 }
3392 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003393 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 }
3395 }
3396 }
3397}
3398#endif
3399
3400/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003401 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 */
3403 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003404ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003406 char_u *arg = eap->arg;
3407 char_u *p = skiptowhite(arg);
3408 int len = (int)(p - arg);
3409 int flags = eap->forceit ? DIP_ALL : 0;
3410
3411 if (STRNCMP(arg, "START", len) == 0)
3412 {
3413 flags += DIP_START + DIP_NORTP;
3414 arg = skipwhite(arg + len);
3415 }
3416 else if (STRNCMP(arg, "OPT", len) == 0)
3417 {
3418 flags += DIP_OPT + DIP_NORTP;
3419 arg = skipwhite(arg + len);
3420 }
3421 else if (STRNCMP(arg, "PACK", len) == 0)
3422 {
3423 flags += DIP_START + DIP_OPT + DIP_NORTP;
3424 arg = skipwhite(arg + len);
3425 }
3426 else if (STRNCMP(arg, "ALL", len) == 0)
3427 {
3428 flags += DIP_START + DIP_OPT;
3429 arg = skipwhite(arg + len);
3430 }
3431
3432 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433}
3434
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003436source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003438 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439}
3440
3441/*
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003442 * Find the file "name" in all directories in "path" and invoke
3443 * "callback(fname, cookie)".
3444 * "name" can contain wildcards.
3445 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3446 * When "flags" has DIP_DIR: find directories instead of files.
3447 * When "flags" has DIP_ERR: give an error message if there is no match.
3448 *
3449 * return FAIL when no file could be sourced, OK otherwise.
3450 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003451 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003452do_in_path(
3453 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003454 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003455 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003456 void (*callback)(char_u *fname, void *ck),
3457 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458{
3459 char_u *rtp;
3460 char_u *np;
3461 char_u *buf;
3462 char_u *rtp_copy;
3463 char_u *tail;
3464 int num_files;
3465 char_u **files;
3466 int i;
3467 int did_one = FALSE;
3468#ifdef AMIGA
3469 struct Process *proc = (struct Process *)FindTask(0L);
3470 APTR save_winptr = proc->pr_WindowPtr;
3471
3472 /* Avoid a requester here for a volume that doesn't exist. */
3473 proc->pr_WindowPtr = (APTR)-1L;
3474#endif
3475
3476 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3477 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003478 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 buf = alloc(MAXPATHL);
3480 if (buf != NULL && rtp_copy != NULL)
3481 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003482 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003483 {
3484 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003485 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003486 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003487 verbose_leave();
3488 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003489
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 /* Loop over all entries in 'runtimepath'. */
3491 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003492 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 {
Bram Moolenaar66459b72016-08-06 19:01:55 +02003494 size_t buflen;
3495
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 /* Copy the path from 'runtimepath' to buf[]. */
3497 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaar66459b72016-08-06 19:01:55 +02003498 buflen = STRLEN(buf);
3499
3500 /* Skip after or non-after directories. */
3501 if (flags & (DIP_NOAFTER | DIP_AFTER))
3502 {
3503 int is_after = buflen >= 5
3504 && STRCMP(buf + buflen - 5, "after") == 0;
3505
3506 if ((is_after && (flags & DIP_NOAFTER))
3507 || (!is_after && (flags & DIP_AFTER)))
3508 continue;
3509 }
3510
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003511 if (name == NULL)
3512 {
3513 (*callback)(buf, (void *) &cookie);
3514 if (!did_one)
3515 did_one = (cookie == NULL);
3516 }
Bram Moolenaar66459b72016-08-06 19:01:55 +02003517 else if (buflen + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 {
3519 add_pathsep(buf);
3520 tail = buf + STRLEN(buf);
3521
3522 /* Loop over all patterns in "name" */
3523 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003524 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 {
3526 /* Append the pattern from "name" to buf[]. */
3527 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3528 "\t ");
3529
3530 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003531 {
3532 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003533 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003534 verbose_leave();
3535 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536
3537 /* Expand wildcards, invoke the callback for each match. */
3538 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003539 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 {
3541 for (i = 0; i < num_files; ++i)
3542 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003543 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003545 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 break;
3547 }
3548 FreeWild(num_files, files);
3549 }
3550 }
3551 }
3552 }
3553 }
3554 vim_free(buf);
3555 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003556 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003557 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003558 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3559
3560 if (flags & DIP_ERR)
3561 EMSG3(_(e_dirnotf), basepath, name);
3562 else if (p_verbose > 0)
3563 {
3564 verbose_enter();
3565 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3566 verbose_leave();
3567 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003568 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569
3570#ifdef AMIGA
3571 proc->pr_WindowPtr = save_winptr;
3572#endif
3573
3574 return did_one ? OK : FAIL;
3575}
3576
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003577/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003578 * Find "name" in "path". When found, invoke the callback function for
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003579 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003580 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3581 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003582 * Returns OK when at least one match found, FAIL otherwise.
3583 *
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003584 * If "name" is NULL calls callback for each entry in "path". Cookie is
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003585 * passed by reference in this case, setting it to NULL indicates that callback
3586 * has done its job.
3587 */
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003588 static int
3589do_in_path_and_pp(
3590 char_u *path,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003591 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003592 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003593 void (*callback)(char_u *fname, void *ck),
3594 void *cookie)
3595{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003596 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003597 char_u *s;
3598 int len;
3599 char *start_dir = "pack/*/start/*/%s";
3600 char *opt_dir = "pack/*/opt/*/%s";
3601
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003602 if ((flags & DIP_NORTP) == 0)
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003603 done = do_in_path(path, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003604
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003605 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003606 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003607 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003608 s = alloc(len);
3609 if (s == NULL)
3610 return FAIL;
3611 vim_snprintf((char *)s, len, start_dir, name);
3612 done = do_in_path(p_pp, s, flags, callback, cookie);
3613 vim_free(s);
3614 }
3615
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003616 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003617 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003618 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003619 s = alloc(len);
3620 if (s == NULL)
3621 return FAIL;
3622 vim_snprintf((char *)s, len, opt_dir, name);
3623 done = do_in_path(p_pp, s, flags, callback, cookie);
3624 vim_free(s);
3625 }
3626
3627 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003628}
3629
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003630/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003631 * Just like do_in_path_and_pp(), using 'runtimepath' for "path".
3632 */
3633 int
3634do_in_runtimepath(
3635 char_u *name,
3636 int flags,
3637 void (*callback)(char_u *fname, void *ck),
3638 void *cookie)
3639{
3640 return do_in_path_and_pp(p_rtp, name, flags, callback, cookie);
3641}
3642
3643/*
3644 * Source the file "name" from all directories in 'runtimepath'.
3645 * "name" can contain wildcards.
3646 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3647 *
3648 * return FAIL when no file could be sourced, OK otherwise.
3649 */
3650 int
3651source_runtime(char_u *name, int flags)
3652{
3653 return source_in_path(p_rtp, name, flags);
3654}
3655
3656/*
3657 * Just like source_runtime(), but use "path" instead of 'runtimepath'.
3658 */
3659 int
3660source_in_path(char_u *path, char_u *name, int flags)
3661{
3662 return do_in_path_and_pp(path, name, flags, source_callback, NULL);
3663}
3664
3665
3666/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003667 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003668 */
3669 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003670source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003671{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003672 int num_files;
3673 char_u **files;
3674 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003675
Bram Moolenaarf3654822016-03-04 22:12:23 +01003676 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003677 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003678 for (i = 0; i < num_files; ++i)
3679 (void)do_source(files[i], FALSE, DOSO_NONE);
3680 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003681 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003682}
3683
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003684/*
3685 * Add the package directory to 'runtimepath'.
3686 */
3687 static int
3688add_pack_dir_to_rtp(char_u *fname)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003689{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003690 char_u *p4, *p3, *p2, *p1, *p;
3691 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003692 int c;
3693 char_u *new_rtp;
3694 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003695 size_t oldlen;
3696 size_t addlen;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003697 char_u *afterdir = NULL;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003698 size_t afterlen = 0;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003699 char_u *ffname = NULL;
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003700 size_t fname_len;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003701 char_u *buf = NULL;
3702 char_u *rtp_ffname;
3703 int match;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003704 int retval = FAIL;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003705
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003706 p4 = p3 = p2 = p1 = get_past_head(fname);
3707 for (p = p1; *p; MB_PTR_ADV(p))
3708 if (vim_ispathsep_nocolon(*p))
3709 {
3710 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3711 }
3712
3713 /* now we have:
3714 * rtp/pack/name/start/name
3715 * p4 p3 p2 p1
3716 *
3717 * find the part up to "pack" in 'runtimepath' */
3718 c = *++p4; /* append pathsep in order to expand symlink */
3719 *p4 = NUL;
3720 ffname = fix_fname(fname);
3721 *p4 = c;
Bram Moolenaar91715872016-03-03 17:13:03 +01003722 if (ffname == NULL)
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003723 return FAIL;
3724
3725 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3726 fname_len = STRLEN(ffname);
3727 insp = p_rtp;
3728 buf = alloc(MAXPATHL);
3729 if (buf == NULL)
3730 goto theend;
3731 while (*insp != NUL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003732 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003733 copy_option_part(&insp, buf, MAXPATHL, ",");
3734 add_pathsep(buf);
3735 rtp_ffname = fix_fname(buf);
3736 if (rtp_ffname == NULL)
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003737 goto theend;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003738 match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0;
3739 vim_free(rtp_ffname);
3740 if (match)
3741 break;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003742 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003743
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003744 if (*insp == NUL)
3745 /* not found, append at the end */
3746 insp = p_rtp + STRLEN(p_rtp);
3747 else
3748 /* append after the matching directory. */
3749 --insp;
3750
3751 /* check if rtp/pack/name/start/name/after exists */
3752 afterdir = concat_fnames(fname, (char_u *)"after", TRUE);
3753 if (afterdir != NULL && mch_isdir(afterdir))
3754 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3755
3756 oldlen = STRLEN(p_rtp);
3757 addlen = STRLEN(fname) + 1; /* add one for comma */
3758 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1));
3759 /* add one for NUL */
3760 if (new_rtp == NULL)
3761 goto theend;
3762 keep = (int)(insp - p_rtp);
3763 mch_memmove(new_rtp, p_rtp, keep);
3764 new_rtp[keep] = ',';
3765 mch_memmove(new_rtp + keep + 1, fname, addlen);
3766 if (p_rtp[keep] != NUL)
3767 mch_memmove(new_rtp + keep + addlen, p_rtp + keep, oldlen - keep + 1);
3768 if (afterlen > 0)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003769 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003770 STRCAT(new_rtp, ",");
3771 STRCAT(new_rtp, afterdir);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003772 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003773 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3774 vim_free(new_rtp);
3775 retval = OK;
Bram Moolenaarf3654822016-03-04 22:12:23 +01003776
3777theend:
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003778 vim_free(buf);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003779 vim_free(ffname);
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003780 vim_free(afterdir);
3781 return retval;
3782}
3783
3784/*
3785 * Load scripts in "plugin" and "ftdetect" directories of the package.
3786 */
3787 static int
3788load_pack_plugin(char_u *fname)
3789{
3790 static char *plugpat = "%s/plugin/**/*.vim";
3791 static char *ftpat = "%s/ftdetect/*.vim";
3792 int len;
3793 char_u *ffname = fix_fname(fname);
3794 char_u *pat = NULL;
3795 int retval = FAIL;
3796
3797 if (ffname == NULL)
3798 return FAIL;
3799 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3800 pat = alloc(len);
3801 if (pat == NULL)
3802 goto theend;
3803 vim_snprintf((char *)pat, len, plugpat, ffname);
3804 source_all_matches(pat);
3805
3806#ifdef FEAT_AUTOCMD
3807 {
3808 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3809
3810 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3811 * found when it loads. */
3812 if (cmd != NULL && eval_to_number(cmd) > 0)
3813 {
3814 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3815 vim_snprintf((char *)pat, len, ftpat, ffname);
3816 source_all_matches(pat);
3817 do_cmdline_cmd((char_u *)"augroup END");
3818 }
3819 vim_free(cmd);
3820 }
3821#endif
3822 vim_free(pat);
3823 retval = OK;
3824
3825theend:
3826 vim_free(ffname);
3827 return retval;
3828}
3829
3830/* used for "cookie" of add_pack_plugin() */
3831static int APP_ADD_DIR;
3832static int APP_LOAD;
3833static int APP_BOTH;
3834
3835 static void
3836add_pack_plugin(char_u *fname, void *cookie)
3837{
3838 if (cookie != &APP_LOAD && strstr((char *)p_rtp, (char *)fname) == NULL)
3839 /* directory is not yet in 'runtimepath', add it */
3840 if (add_pack_dir_to_rtp(fname) == FAIL)
3841 return;
3842
3843 if (cookie != &APP_ADD_DIR)
3844 load_pack_plugin(fname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003845}
3846
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003847/*
3848 * Add all packages in the "start" directory to 'runtimepath'.
3849 */
3850 void
3851add_pack_start_dirs(void)
3852{
3853 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3854 add_pack_plugin, &APP_ADD_DIR);
3855}
3856
3857/*
3858 * Load plugins from all packages in the "start" directory.
3859 */
3860 void
3861load_start_packages(void)
3862{
3863 did_source_packages = TRUE;
3864 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3865 add_pack_plugin, &APP_LOAD);
3866}
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003867
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003868/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003869 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003870 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003871 */
3872 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003873ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003874{
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003875 if (!did_source_packages || eap->forceit)
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003876 {
Bram Moolenaar49b27322016-04-05 21:13:00 +02003877 /* First do a round to add all directories to 'runtimepath', then load
3878 * the plugins. This allows for plugins to use an autoload directory
3879 * of another plugin. */
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003880 add_pack_start_dirs();
3881 load_start_packages();
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003882 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003883}
3884
3885/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003886 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003887 */
3888 void
3889ex_packadd(exarg_T *eap)
3890{
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003891 static char *plugpat = "pack/*/%s/%s";
Bram Moolenaar91715872016-03-03 17:13:03 +01003892 int len;
3893 char *pat;
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003894 int round;
3895 int res = OK;
Bram Moolenaar91715872016-03-03 17:13:03 +01003896
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003897 /* Round 1: use "start", round 2: use "opt". */
3898 for (round = 1; round <= 2; ++round)
3899 {
3900 /* Only look under "start" when loading packages wasn't done yet. */
3901 if (round == 1 && did_source_packages)
3902 continue;
3903
3904 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg) + 5;
3905 pat = (char *)alloc(len);
3906 if (pat == NULL)
3907 return;
3908 vim_snprintf(pat, len, plugpat, round == 1 ? "start" : "opt", eap->arg);
3909 /* The first round don't give a "not found" error, in the second round
3910 * only when nothing was found in the first round. */
3911 res = do_in_path(p_pp, (char_u *)pat,
3912 DIP_ALL + DIP_DIR + (round == 2 && res == FAIL ? DIP_ERR : 0),
3913 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
3914 vim_free(pat);
3915 }
Bram Moolenaar91715872016-03-03 17:13:03 +01003916}
3917
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
3919/*
3920 * ":options"
3921 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003923ex_options(
3924 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925{
Bram Moolenaarab6c8582017-08-11 17:15:09 +02003926 vim_setenv((char_u *)"OPTWIN_CMD", (char_u *)(cmdmod.tab ? "tab" : ""));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3928}
3929#endif
3930
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003931#if defined(FEAT_PYTHON3) || defined(FEAT_PYTHON) || defined(PROTO)
3932
3933# if (defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)) || defined(PROTO)
3934/*
3935 * Detect Python 3 or 2, and initialize 'pyxversion'.
3936 */
3937 void
3938init_pyxversion(void)
3939{
3940 if (p_pyx == 0)
3941 {
3942 if (python3_enabled(FALSE))
3943 p_pyx = 3;
3944 else if (python_enabled(FALSE))
3945 p_pyx = 2;
3946 }
3947}
3948# endif
3949
3950/*
3951 * Does a file contain one of the following strings at the beginning of any
3952 * line?
3953 * "#!(any string)python2" => returns 2
3954 * "#!(any string)python3" => returns 3
3955 * "# requires python 2.x" => returns 2
3956 * "# requires python 3.x" => returns 3
3957 * otherwise return 0.
3958 */
3959 static int
3960requires_py_version(char_u *filename)
3961{
3962 FILE *file;
3963 int requires_py_version = 0;
3964 int i, lines;
3965
3966 lines = (int)p_mls;
3967 if (lines < 0)
3968 lines = 5;
3969
3970 file = mch_fopen((char *)filename, "r");
3971 if (file != NULL)
3972 {
3973 for (i = 0; i < lines; i++)
3974 {
3975 if (vim_fgets(IObuff, IOSIZE, file))
3976 break;
3977 if (i == 0 && IObuff[0] == '#' && IObuff[1] == '!')
3978 {
3979 /* Check shebang. */
3980 if (strstr((char *)IObuff + 2, "python2") != NULL)
3981 {
3982 requires_py_version = 2;
3983 break;
3984 }
3985 if (strstr((char *)IObuff + 2, "python3") != NULL)
3986 {
3987 requires_py_version = 3;
3988 break;
3989 }
3990 }
3991 IObuff[21] = '\0';
3992 if (STRCMP("# requires python 2.x", IObuff) == 0)
3993 {
3994 requires_py_version = 2;
3995 break;
3996 }
3997 if (STRCMP("# requires python 3.x", IObuff) == 0)
3998 {
3999 requires_py_version = 3;
4000 break;
4001 }
4002 }
4003 fclose(file);
4004 }
4005 return requires_py_version;
4006}
4007
4008
4009/*
4010 * Source a python file using the requested python version.
4011 */
4012 static void
4013source_pyx_file(exarg_T *eap, char_u *fname)
4014{
4015 exarg_T ex;
4016 int v = requires_py_version(fname);
4017
4018# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4019 init_pyxversion();
4020# endif
4021 if (v == 0)
4022 {
4023# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4024 /* user didn't choose a preference, 'pyx' is used */
4025 v = p_pyx;
4026# elif defined(FEAT_PYTHON)
4027 v = 2;
4028# elif defined(FEAT_PYTHON3)
4029 v = 3;
4030# endif
4031 }
4032
4033 /*
4034 * now source, if required python version is not supported show
4035 * unobtrusive message.
4036 */
4037 if (eap == NULL)
4038 vim_memset(&ex, 0, sizeof(ex));
4039 else
4040 ex = *eap;
4041 ex.arg = fname;
4042 ex.cmd = (char_u *)(v == 2 ? "pyfile" : "pyfile3");
4043
4044 if (v == 2)
4045 {
4046# ifdef FEAT_PYTHON
4047 ex_pyfile(&ex);
4048# else
4049 vim_snprintf((char *)IObuff, IOSIZE,
4050 _("W20: Required python version 2.x not supported, ignoring file: %s"),
4051 fname);
4052 MSG(IObuff);
4053# endif
4054 return;
4055 }
4056 else
4057 {
4058# ifdef FEAT_PYTHON3
4059 ex_py3file(&ex);
4060# else
4061 vim_snprintf((char *)IObuff, IOSIZE,
4062 _("W21: Required python version 3.x not supported, ignoring file: %s"),
4063 fname);
4064 MSG(IObuff);
4065# endif
4066 return;
4067 }
4068}
4069
4070/*
4071 * ":pyxfile {fname}"
4072 */
4073 void
4074ex_pyxfile(exarg_T *eap)
4075{
4076 source_pyx_file(eap, eap->arg);
4077}
4078
4079/*
4080 * ":pyx"
4081 */
4082 void
4083ex_pyx(exarg_T *eap)
4084{
4085# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4086 init_pyxversion();
4087 if (p_pyx == 2)
4088 ex_python(eap);
4089 else
4090 ex_py3(eap);
4091# elif defined(FEAT_PYTHON)
4092 ex_python(eap);
4093# elif defined(FEAT_PYTHON3)
4094 ex_py3(eap);
4095# endif
4096}
4097
4098/*
4099 * ":pyxdo"
4100 */
4101 void
4102ex_pyxdo(exarg_T *eap)
4103{
4104# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4105 init_pyxversion();
4106 if (p_pyx == 2)
4107 ex_pydo(eap);
4108 else
4109 ex_py3do(eap);
4110# elif defined(FEAT_PYTHON)
4111 ex_pydo(eap);
4112# elif defined(FEAT_PYTHON3)
4113 ex_py3do(eap);
4114# endif
4115}
4116
4117#endif
4118
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119/*
4120 * ":source {fname}"
4121 */
4122 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004123ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124{
4125#ifdef FEAT_BROWSE
4126 if (cmdmod.browse)
4127 {
4128 char_u *fname = NULL;
4129
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00004130 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
4132 if (fname != NULL)
4133 {
4134 cmd_source(fname, eap);
4135 vim_free(fname);
4136 }
4137 }
4138 else
4139#endif
4140 cmd_source(eap->arg, eap);
4141}
4142
4143 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004144cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145{
4146 if (*fname == NUL)
4147 EMSG(_(e_argreq));
4148
Bram Moolenaar071d4272004-06-13 20:20:40 +00004149 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02004150 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004151 * Need to execute the commands directly. This is required at least
4152 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153 * - ":g" command busy
4154 * - after ":argdo", ":windo" or ":bufdo"
4155 * - another command follows
4156 * - inside a loop
4157 */
4158 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
4159#ifdef FEAT_EVAL
4160 || eap->cstack->cs_idx >= 0
4161#endif
4162 );
4163
4164 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004165 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 EMSG2(_(e_notopen), fname);
4167}
4168
4169/*
4170 * ":source" and associated commands.
4171 */
4172/*
4173 * Structure used to store info for each sourced file.
4174 * It is shared between do_source() and getsourceline().
4175 * This is required, because it needs to be handed to do_cmdline() and
4176 * sourcing can be done recursively.
4177 */
4178struct source_cookie
4179{
4180 FILE *fp; /* opened file for sourcing */
4181 char_u *nextline; /* if not NULL: line that was read ahead */
4182 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004183#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
4185 int error; /* TRUE if LF found after CR-LF */
4186#endif
4187#ifdef FEAT_EVAL
4188 linenr_T breakpoint; /* next line with breakpoint or zero */
4189 char_u *fname; /* name of sourced file */
4190 int dbg_tick; /* debug_tick when breakpoint was set */
4191 int level; /* top nesting level of sourced file */
4192#endif
4193#ifdef FEAT_MBYTE
4194 vimconv_T conv; /* type of conversion */
4195#endif
4196};
4197
4198#ifdef FEAT_EVAL
4199/*
4200 * Return the address holding the next breakpoint line for a source cookie.
4201 */
4202 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004203source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004204{
4205 return &((struct source_cookie *)cookie)->breakpoint;
4206}
4207
4208/*
4209 * Return the address holding the debug tick for a source cookie.
4210 */
4211 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004212source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213{
4214 return &((struct source_cookie *)cookie)->dbg_tick;
4215}
4216
4217/*
4218 * Return the nesting level for a source cookie.
4219 */
4220 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004221source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222{
4223 return ((struct source_cookie *)cookie)->level;
4224}
4225#endif
4226
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004227static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004228
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004229#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
4230# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004231static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232
4233/*
4234 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004235 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236 */
4237 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004238fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004240# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01004241 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
4242# else
4243 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004244# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245
4246 if (fd_tmp == -1)
4247 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004248
4249# ifdef HAVE_FD_CLOEXEC
4250 {
4251 int fdflags = fcntl(fd_tmp, F_GETFD);
4252 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02004253 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004254 }
4255# endif
4256
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 return fdopen(fd_tmp, READBIN);
4258}
4259#endif
4260
4261
4262/*
4263 * do_source: Read the file "fname" and execute its lines as EX commands.
4264 *
4265 * This function may be called recursively!
4266 *
4267 * return FAIL if file could not be opened, OK otherwise
4268 */
4269 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004270do_source(
4271 char_u *fname,
4272 int check_other, /* check for .vimrc and _vimrc */
4273 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274{
4275 struct source_cookie cookie;
4276 char_u *save_sourcing_name;
4277 linenr_T save_sourcing_lnum;
4278 char_u *p;
4279 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00004280 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 int retval = FAIL;
4282#ifdef FEAT_EVAL
4283 scid_T save_current_SID;
4284 static scid_T last_current_SID = 0;
4285 void *save_funccalp;
4286 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004287 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02004289 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 int stat_ok;
4291# endif
4292#endif
4293#ifdef STARTUPTIME
4294 struct timeval tv_rel;
4295 struct timeval tv_start;
4296#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004297#ifdef FEAT_PROFILE
4298 proftime_T wait_start;
4299#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 if (p == NULL)
4303 return retval;
4304 fname_exp = fix_fname(p);
4305 vim_free(p);
4306 if (fname_exp == NULL)
4307 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 if (mch_isdir(fname_exp))
4309 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00004310 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311 goto theend;
4312 }
4313
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004314#ifdef FEAT_AUTOCMD
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004315 /* Apply SourceCmd autocommands, they should get the file and source it. */
4316 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
4317 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
4318 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004319 {
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004320# ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004321 retval = aborting() ? FAIL : OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004322# else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004323 retval = OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004324# endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004325 goto theend;
4326 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004327
4328 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004329 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
4330#endif
4331
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004332#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4334#else
4335 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4336#endif
4337 if (cookie.fp == NULL && check_other)
4338 {
4339 /*
4340 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
4341 * and ".exrc" by "_exrc" or vice versa.
4342 */
4343 p = gettail(fname_exp);
4344 if ((*p == '.' || *p == '_')
4345 && (STRICMP(p + 1, "vimrc") == 0
4346 || STRICMP(p + 1, "gvimrc") == 0
4347 || STRICMP(p + 1, "exrc") == 0))
4348 {
4349 if (*p == '_')
4350 *p = '.';
4351 else
4352 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004353#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4355#else
4356 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4357#endif
4358 }
4359 }
4360
4361 if (cookie.fp == NULL)
4362 {
4363 if (p_verbose > 0)
4364 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004365 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004367 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 else
4369 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004370 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004371 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004372 }
4373 goto theend;
4374 }
4375
4376 /*
4377 * The file exists.
4378 * - In verbose mode, give a message.
4379 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
4380 */
4381 if (p_verbose > 1)
4382 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004383 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004384 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004385 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 else
4387 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004388 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004389 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004390 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004391 if (is_vimrc == DOSO_VIMRC)
4392 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
4393 else if (is_vimrc == DOSO_GVIMRC)
4394 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395
4396#ifdef USE_CRNL
4397 /* If no automatic file format: Set default to CR-NL. */
4398 if (*p_ffs == NUL)
4399 cookie.fileformat = EOL_DOS;
4400 else
4401 cookie.fileformat = EOL_UNKNOWN;
4402 cookie.error = FALSE;
4403#endif
4404
4405#ifdef USE_CR
4406 /* If no automatic file format: Set default to CR. */
4407 if (*p_ffs == NUL)
4408 cookie.fileformat = EOL_MAC;
4409 else
4410 cookie.fileformat = EOL_UNKNOWN;
4411 cookie.error = FALSE;
4412#endif
4413
4414 cookie.nextline = NULL;
4415 cookie.finished = FALSE;
4416
4417#ifdef FEAT_EVAL
4418 /*
4419 * Check if this script has a breakpoint.
4420 */
4421 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
4422 cookie.fname = fname_exp;
4423 cookie.dbg_tick = debug_tick;
4424
4425 cookie.level = ex_nesting_level;
4426#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427
4428 /*
4429 * Keep the sourcing name/lnum, for recursive calls.
4430 */
4431 save_sourcing_name = sourcing_name;
4432 sourcing_name = fname_exp;
4433 save_sourcing_lnum = sourcing_lnum;
4434 sourcing_lnum = 0;
4435
4436#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004437 if (time_fd != NULL)
4438 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439#endif
4440
4441#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00004442# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004443 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004444 prof_child_enter(&wait_start); /* entering a child now */
4445# endif
4446
4447 /* Don't use local function variables, if called from a function.
4448 * Also starts profiling timer for nested script. */
4449 save_funccalp = save_funccal();
4450
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 /*
4452 * Check if this script was sourced before to finds its SID.
4453 * If it's new, generate a new SID.
4454 */
4455 save_current_SID = current_SID;
4456# ifdef UNIX
4457 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
4458# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004459 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
4460 {
4461 si = &SCRIPT_ITEM(current_SID);
4462 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 && (
4464# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00004465 /* Compare dev/ino when possible, it catches symbolic
4466 * links. Also compare file names, the inode may change
4467 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004468 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004469 && (si->sn_dev == st.st_dev
4470 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004472 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004474 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 if (current_SID == 0)
4476 {
4477 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004478 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
4479 == FAIL)
4480 goto almosttheend;
4481 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004482 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00004483 ++script_items.ga_len;
4484 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
4485# ifdef FEAT_PROFILE
4486 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004489 si = &SCRIPT_ITEM(current_SID);
4490 si->sn_name = fname_exp;
4491 fname_exp = NULL;
4492# ifdef UNIX
4493 if (stat_ok)
4494 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004495 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004496 si->sn_dev = st.st_dev;
4497 si->sn_ino = st.st_ino;
4498 }
4499 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004500 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004501# endif
4502
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 /* Allocate the local script variables to use for this script. */
4504 new_script_vars(current_SID);
4505 }
4506
Bram Moolenaar05159a02005-02-26 23:04:13 +00004507# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004508 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004509 {
4510 int forceit;
4511
4512 /* Check if we do profiling for this script. */
4513 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
4514 {
4515 script_do_profile(si);
4516 si->sn_pr_force = forceit;
4517 }
4518 if (si->sn_prof_on)
4519 {
4520 ++si->sn_pr_count;
4521 profile_start(&si->sn_pr_start);
4522 profile_zero(&si->sn_pr_children);
4523 }
4524 }
4525# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526#endif
4527
Bram Moolenaar67435d92017-10-19 21:04:37 +02004528#ifdef FEAT_MBYTE
4529 cookie.conv.vc_type = CONV_NONE; /* no conversion */
4530
4531 /* Read the first line so we can check for a UTF-8 BOM. */
4532 firstline = getsourceline(0, (void *)&cookie, 0);
4533 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
4534 && firstline[1] == 0xbb && firstline[2] == 0xbf)
4535 {
4536 /* Found BOM; setup conversion, skip over BOM and recode the line. */
4537 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
4538 p = string_convert(&cookie.conv, firstline + 3, NULL);
4539 if (p == NULL)
4540 p = vim_strsave(firstline + 3);
4541 if (p != NULL)
4542 {
4543 vim_free(firstline);
4544 firstline = p;
4545 }
4546 }
4547#endif
4548
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 /*
4550 * Call do_cmdline, which will call getsourceline() to get the lines.
4551 */
Bram Moolenaar73881402009-02-04 16:50:47 +00004552 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004555
4556#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004557 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004558 {
4559 /* Get "si" again, "script_items" may have been reallocated. */
4560 si = &SCRIPT_ITEM(current_SID);
4561 if (si->sn_prof_on)
4562 {
4563 profile_end(&si->sn_pr_start);
4564 profile_sub_wait(&wait_start, &si->sn_pr_start);
4565 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004566 profile_self(&si->sn_pr_self, &si->sn_pr_start,
4567 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004568 }
4569 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570#endif
4571
4572 if (got_int)
4573 EMSG(_(e_interr));
4574 sourcing_name = save_sourcing_name;
4575 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 if (p_verbose > 1)
4577 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004578 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004579 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004581 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004582 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 }
4584#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004585 if (time_fd != NULL)
4586 {
4587 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4588 time_msg((char *)IObuff, &tv_start);
4589 time_pop(&tv_rel);
4590 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591#endif
4592
4593#ifdef FEAT_EVAL
4594 /*
4595 * After a "finish" in debug mode, need to break at first command of next
4596 * sourced file.
4597 */
4598 if (save_debug_break_level > ex_nesting_level
4599 && debug_break_level == ex_nesting_level)
4600 ++debug_break_level;
4601#endif
4602
Bram Moolenaar05159a02005-02-26 23:04:13 +00004603#ifdef FEAT_EVAL
4604almosttheend:
4605 current_SID = save_current_SID;
4606 restore_funccal(save_funccalp);
4607# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004608 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004609 prof_child_exit(&wait_start); /* leaving a child now */
4610# endif
4611#endif
4612 fclose(cookie.fp);
4613 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004614 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004615#ifdef FEAT_MBYTE
4616 convert_setup(&cookie.conv, NULL, NULL);
4617#endif
4618
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619theend:
4620 vim_free(fname_exp);
4621 return retval;
4622}
4623
4624#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004625
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626/*
4627 * ":scriptnames"
4628 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004630ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631{
4632 int i;
4633
Bram Moolenaar05159a02005-02-26 23:04:13 +00004634 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4635 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004636 {
4637 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4638 NameBuff, MAXPATHL, TRUE);
4639 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004640 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004641}
4642
4643# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4644/*
4645 * Fix slashes in the list of script names for 'shellslash'.
4646 */
4647 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004648scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649{
4650 int i;
4651
Bram Moolenaar05159a02005-02-26 23:04:13 +00004652 for (i = 1; i <= script_items.ga_len; ++i)
4653 if (SCRIPT_ITEM(i).sn_name != NULL)
4654 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004655}
4656# endif
4657
4658/*
4659 * Get a pointer to a script name. Used for ":verbose set".
4660 */
4661 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004662get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663{
4664 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004665 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004666 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004667 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004669 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004671 return (char_u *)_("environment variable");
4672 if (id == SID_ERROR)
4673 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004674 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004676
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004677# if defined(EXITFREE) || defined(PROTO)
4678 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004679free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004680{
4681 int i;
4682
4683 for (i = script_items.ga_len; i > 0; --i)
4684 vim_free(SCRIPT_ITEM(i).sn_name);
4685 ga_clear(&script_items);
4686}
4687# endif
4688
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689#endif
4690
4691#if defined(USE_CR) || defined(PROTO)
4692
4693# if defined(__MSL__) && (__MSL__ >= 22)
4694/*
4695 * Newer version of the Metrowerks library handle DOS and UNIX files
4696 * without help.
4697 * Test with earlier versions, MSL 2.2 is the library supplied with
4698 * Codewarrior Pro 2.
4699 */
4700 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004701fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702{
4703 return fgets(s, n, stream);
4704}
4705# else
4706/*
4707 * Version of fgets() which also works for lines ending in a <CR> only
4708 * (Macintosh format).
4709 * For older versions of the Metrowerks library.
4710 * At least CodeWarrior 9 needed this code.
4711 */
4712 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004713fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714{
4715 int c = 0;
4716 int char_read = 0;
4717
4718 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4719 {
4720 c = fgetc(stream);
4721 s[char_read++] = c;
4722 /* If the file is in DOS format, we need to skip a NL after a CR. I
4723 * thought it was the other way around, but this appears to work... */
4724 if (c == '\n')
4725 {
4726 c = fgetc(stream);
4727 if (c != '\r')
4728 ungetc(c, stream);
4729 }
4730 }
4731
4732 s[char_read] = 0;
4733 if (char_read == 0)
4734 return NULL;
4735
4736 if (feof(stream) && char_read == 1)
4737 return NULL;
4738
4739 return s;
4740}
4741# endif
4742#endif
4743
4744/*
4745 * Get one full line from a sourced file.
4746 * Called by do_cmdline() when it's called from do_source().
4747 *
4748 * Return a pointer to the line in allocated memory.
4749 * Return NULL for end-of-file or some error.
4750 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004752getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753{
4754 struct source_cookie *sp = (struct source_cookie *)cookie;
4755 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004756 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004757
4758#ifdef FEAT_EVAL
4759 /* If breakpoints have been added/deleted need to check for it. */
4760 if (sp->dbg_tick < debug_tick)
4761 {
4762 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4763 sp->dbg_tick = debug_tick;
4764 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004765# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004766 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004767 script_line_end();
4768# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769#endif
4770 /*
4771 * Get current line. If there is a read-ahead line, use it, otherwise get
4772 * one now.
4773 */
4774 if (sp->finished)
4775 line = NULL;
4776 else if (sp->nextline == NULL)
4777 line = get_one_sourceline(sp);
4778 else
4779 {
4780 line = sp->nextline;
4781 sp->nextline = NULL;
4782 ++sourcing_lnum;
4783 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004784#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004785 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004786 script_line_start();
4787#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788
4789 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4790 * contain the 'C' flag. */
4791 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4792 {
4793 /* compensate for the one line read-ahead */
4794 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004795
4796 /* Get the next line and concatenate it when it starts with a
4797 * backslash. We always need to read the next line, keep it in
4798 * sp->nextline. */
4799 sp->nextline = get_one_sourceline(sp);
4800 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004802 garray_T ga;
4803
Bram Moolenaarb549a732012-02-22 18:29:33 +01004804 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004805 ga_concat(&ga, line);
4806 ga_concat(&ga, p + 1);
4807 for (;;)
4808 {
4809 vim_free(sp->nextline);
4810 sp->nextline = get_one_sourceline(sp);
4811 if (sp->nextline == NULL)
4812 break;
4813 p = skipwhite(sp->nextline);
4814 if (*p != '\\')
4815 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004816 /* Adjust the growsize to the current length to speed up
4817 * concatenating many lines. */
4818 if (ga.ga_len > 400)
4819 {
4820 if (ga.ga_len > 8000)
4821 ga.ga_growsize = 8000;
4822 else
4823 ga.ga_growsize = ga.ga_len;
4824 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004825 ga_concat(&ga, p + 1);
4826 }
4827 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004829 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 }
4831 }
4832
4833#ifdef FEAT_MBYTE
4834 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4835 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004836 char_u *s;
4837
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838 /* Convert the encoding of the script line. */
4839 s = string_convert(&sp->conv, line, NULL);
4840 if (s != NULL)
4841 {
4842 vim_free(line);
4843 line = s;
4844 }
4845 }
4846#endif
4847
4848#ifdef FEAT_EVAL
4849 /* Did we encounter a breakpoint? */
4850 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4851 {
4852 dbg_breakpoint(sp->fname, sourcing_lnum);
4853 /* Find next breakpoint. */
4854 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4855 sp->dbg_tick = debug_tick;
4856 }
4857#endif
4858
4859 return line;
4860}
4861
4862 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004863get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864{
4865 garray_T ga;
4866 int len;
4867 int c;
4868 char_u *buf;
4869#ifdef USE_CRNL
4870 int has_cr; /* CR-LF found */
4871#endif
4872#ifdef USE_CR
4873 char_u *scan;
4874#endif
4875 int have_read = FALSE;
4876
4877 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004878 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004879
4880 /*
4881 * Loop until there is a finished line (or end-of-file).
4882 */
4883 sourcing_lnum++;
4884 for (;;)
4885 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004886 /* make room to read at least 120 (more) characters */
4887 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004888 break;
4889 buf = (char_u *)ga.ga_data;
4890
4891#ifdef USE_CR
4892 if (sp->fileformat == EOL_MAC)
4893 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004894 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4895 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004896 break;
4897 }
4898 else
4899#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004900 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4901 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004903 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904#ifdef USE_CRNL
4905 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4906 * CTRL-Z by its own, or after a NL. */
4907 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4908 && sp->fileformat == EOL_DOS
4909 && buf[len - 1] == Ctrl_Z)
4910 {
4911 buf[len - 1] = NUL;
4912 break;
4913 }
4914#endif
4915
4916#ifdef USE_CR
4917 /* If the read doesn't stop on a new line, and there's
4918 * some CR then we assume a Mac format */
4919 if (sp->fileformat == EOL_UNKNOWN)
4920 {
4921 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4922 sp->fileformat = EOL_MAC;
4923 else
4924 sp->fileformat = EOL_UNIX;
4925 }
4926
4927 if (sp->fileformat == EOL_MAC)
4928 {
4929 scan = vim_strchr(buf, '\r');
4930
4931 if (scan != NULL)
4932 {
4933 *scan = '\n';
4934 if (*(scan + 1) != 0)
4935 {
4936 *(scan + 1) = 0;
4937 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4938 }
4939 }
4940 len = STRLEN(buf);
4941 }
4942#endif
4943
4944 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 ga.ga_len = len;
4946
4947 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004948 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004949 continue;
4950
4951 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4952 {
4953#ifdef USE_CRNL
4954 has_cr = (len >= 2 && buf[len - 2] == '\r');
4955 if (sp->fileformat == EOL_UNKNOWN)
4956 {
4957 if (has_cr)
4958 sp->fileformat = EOL_DOS;
4959 else
4960 sp->fileformat = EOL_UNIX;
4961 }
4962
4963 if (sp->fileformat == EOL_DOS)
4964 {
4965 if (has_cr) /* replace trailing CR */
4966 {
4967 buf[len - 2] = '\n';
4968 --len;
4969 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 }
4971 else /* lines like ":map xx yy^M" will have failed */
4972 {
4973 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004974 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01004975 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004977 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 sp->error = TRUE;
4979 sp->fileformat = EOL_UNIX;
4980 }
4981 }
4982#endif
4983 /* The '\n' is escaped if there is an odd number of ^V's just
4984 * before it, first set "c" just before the 'V's and then check
4985 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
4986 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
4987 ;
4988 if ((len & 1) != (c & 1)) /* escaped NL, read more */
4989 {
4990 sourcing_lnum++;
4991 continue;
4992 }
4993
4994 buf[len - 1] = NUL; /* remove the NL */
4995 }
4996
4997 /*
4998 * Check for ^C here now and then, so recursive :so can be broken.
4999 */
5000 line_breakcheck();
5001 break;
5002 }
5003
5004 if (have_read)
5005 return (char_u *)ga.ga_data;
5006
5007 vim_free(ga.ga_data);
5008 return NULL;
5009}
5010
Bram Moolenaar05159a02005-02-26 23:04:13 +00005011#if defined(FEAT_PROFILE) || defined(PROTO)
5012/*
5013 * Called when starting to read a script line.
5014 * "sourcing_lnum" must be correct!
5015 * When skipping lines it may not actually be executed, but we won't find out
5016 * until later and we need to store the time now.
5017 */
5018 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005019script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005020{
5021 scriptitem_T *si;
5022 sn_prl_T *pp;
5023
5024 if (current_SID <= 0 || current_SID > script_items.ga_len)
5025 return;
5026 si = &SCRIPT_ITEM(current_SID);
5027 if (si->sn_prof_on && sourcing_lnum >= 1)
5028 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005029 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00005030 * here isn't counted. */
Bram Moolenaar67435d92017-10-19 21:04:37 +02005031 (void)ga_grow(&si->sn_prl_ga,
5032 (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00005033 si->sn_prl_idx = sourcing_lnum - 1;
5034 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
5035 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
5036 {
5037 /* Zero counters for a line that was not used before. */
5038 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
5039 pp->snp_count = 0;
5040 profile_zero(&pp->sn_prl_total);
5041 profile_zero(&pp->sn_prl_self);
5042 ++si->sn_prl_ga.ga_len;
5043 }
5044 si->sn_prl_execed = FALSE;
5045 profile_start(&si->sn_prl_start);
5046 profile_zero(&si->sn_prl_children);
5047 profile_get_wait(&si->sn_prl_wait);
5048 }
5049}
5050
5051/*
5052 * Called when actually executing a function line.
5053 */
5054 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005055script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005056{
5057 scriptitem_T *si;
5058
5059 if (current_SID <= 0 || current_SID > script_items.ga_len)
5060 return;
5061 si = &SCRIPT_ITEM(current_SID);
5062 if (si->sn_prof_on && si->sn_prl_idx >= 0)
5063 si->sn_prl_execed = TRUE;
5064}
5065
5066/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02005067 * Called when done with a script line.
Bram Moolenaar05159a02005-02-26 23:04:13 +00005068 */
5069 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005070script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005071{
5072 scriptitem_T *si;
5073 sn_prl_T *pp;
5074
5075 if (current_SID <= 0 || current_SID > script_items.ga_len)
5076 return;
5077 si = &SCRIPT_ITEM(current_SID);
5078 if (si->sn_prof_on && si->sn_prl_idx >= 0
5079 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
5080 {
5081 if (si->sn_prl_execed)
5082 {
5083 pp = &PRL_ITEM(si, si->sn_prl_idx);
5084 ++pp->snp_count;
5085 profile_end(&si->sn_prl_start);
5086 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005087 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00005088 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
5089 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005090 }
5091 si->sn_prl_idx = -1;
5092 }
5093}
5094#endif
5095
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096/*
5097 * ":scriptencoding": Set encoding conversion for a sourced script.
5098 * Without the multi-byte feature it's simply ignored.
5099 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005100 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005101ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102{
5103#ifdef FEAT_MBYTE
5104 struct source_cookie *sp;
5105 char_u *name;
5106
5107 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
5108 {
5109 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
5110 return;
5111 }
5112
5113 if (*eap->arg != NUL)
5114 {
5115 name = enc_canonize(eap->arg);
5116 if (name == NULL) /* out of memory */
5117 return;
5118 }
5119 else
5120 name = eap->arg;
5121
5122 /* Setup for conversion from the specified encoding to 'encoding'. */
5123 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
5124 convert_setup(&sp->conv, name, p_enc);
5125
5126 if (name != eap->arg)
5127 vim_free(name);
5128#endif
5129}
5130
5131#if defined(FEAT_EVAL) || defined(PROTO)
5132/*
5133 * ":finish": Mark a sourced file as finished.
5134 */
5135 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005136ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137{
5138 if (getline_equal(eap->getline, eap->cookie, getsourceline))
5139 do_finish(eap, FALSE);
5140 else
5141 EMSG(_("E168: :finish used outside of a sourced file"));
5142}
5143
5144/*
5145 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
5146 * Also called for a pending finish at the ":endtry" or after returning from
5147 * an extra do_cmdline(). "reanimate" is used in the latter case.
5148 */
5149 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005150do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005151{
5152 int idx;
5153
5154 if (reanimate)
5155 ((struct source_cookie *)getline_cookie(eap->getline,
5156 eap->cookie))->finished = FALSE;
5157
5158 /*
5159 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5160 * not in its finally clause (which then is to be executed next) is found.
5161 * In this case, make the ":finish" pending for execution at the ":endtry".
5162 * Otherwise, finish normally.
5163 */
5164 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5165 if (idx >= 0)
5166 {
5167 eap->cstack->cs_pending[idx] = CSTP_FINISH;
5168 report_make_pending(CSTP_FINISH, NULL);
5169 }
5170 else
5171 ((struct source_cookie *)getline_cookie(eap->getline,
5172 eap->cookie))->finished = TRUE;
5173}
5174
5175
5176/*
5177 * Return TRUE when a sourced file had the ":finish" command: Don't give error
5178 * message for missing ":endif".
5179 * Return FALSE when not sourcing a file.
5180 */
5181 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005182source_finished(
5183 char_u *(*fgetline)(int, void *, int),
5184 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185{
Bram Moolenaar89d40322006-08-29 15:30:07 +00005186 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00005188 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189}
5190#endif
5191
5192#if defined(FEAT_LISTCMDS) || defined(PROTO)
5193/*
5194 * ":checktime [buffer]"
5195 */
5196 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005197ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198{
5199 buf_T *buf;
5200 int save_no_check_timestamps = no_check_timestamps;
5201
5202 no_check_timestamps = 0;
5203 if (eap->addr_count == 0) /* default is all buffers */
5204 check_timestamps(FALSE);
5205 else
5206 {
5207 buf = buflist_findnr((int)eap->line2);
5208 if (buf != NULL) /* cannot happen? */
5209 (void)buf_check_timestamp(buf, FALSE);
5210 }
5211 no_check_timestamps = save_no_check_timestamps;
5212}
5213#endif
5214
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5216 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005217# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005218static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005220 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005221get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005223 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224
Bram Moolenaar48e330a2016-02-23 14:53:34 +01005225 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005226 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005228# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 if (loc != NULL)
5230 {
5231 char_u *p;
5232
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005233 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
5234 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005235 p = vim_strchr(loc, '=');
5236 if (p != NULL)
5237 {
5238 loc = ++p;
5239 while (*p != NUL) /* remove trailing newline */
5240 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005241 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242 {
5243 *p = NUL;
5244 break;
5245 }
5246 ++p;
5247 }
5248 }
5249 }
5250# endif
5251
5252 return loc;
5253}
5254#endif
5255
5256
5257#ifdef WIN32
5258/*
5259 * On MS-Windows locale names are strings like "German_Germany.1252", but
5260 * gettext expects "de". Try to translate one into another here for a few
5261 * supported languages.
5262 */
5263 static char_u *
5264gettext_lang(char_u *name)
5265{
5266 int i;
5267 static char *(mtable[]) = {
5268 "afrikaans", "af",
5269 "czech", "cs",
5270 "dutch", "nl",
5271 "german", "de",
5272 "english_united kingdom", "en_GB",
5273 "spanish", "es",
5274 "french", "fr",
5275 "italian", "it",
5276 "japanese", "ja",
5277 "korean", "ko",
5278 "norwegian", "no",
5279 "polish", "pl",
5280 "russian", "ru",
5281 "slovak", "sk",
5282 "swedish", "sv",
5283 "ukrainian", "uk",
5284 "chinese_china", "zh_CN",
5285 "chinese_taiwan", "zh_TW",
5286 NULL};
5287
5288 for (i = 0; mtable[i] != NULL; i += 2)
5289 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005290 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005291 return name;
5292}
5293#endif
5294
5295#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5296/*
5297 * Obtain the current messages language. Used to set the default for
5298 * 'helplang'. May return NULL or an empty string.
5299 */
5300 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005301get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005302{
5303 char_u *p;
5304
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005305# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005306# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005307 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308# else
5309 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005310 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
5311 * and LC_MONETARY may be set differently for a Japanese working in the
5312 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005313 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005314# endif
5315# else
5316 p = mch_getenv((char_u *)"LC_ALL");
5317 if (p == NULL || *p == NUL)
5318 {
5319 p = mch_getenv((char_u *)"LC_MESSAGES");
5320 if (p == NULL || *p == NUL)
5321 p = mch_getenv((char_u *)"LANG");
5322 }
5323# endif
5324# ifdef WIN32
5325 p = gettext_lang(p);
5326# endif
5327 return p;
5328}
5329#endif
5330
Bram Moolenaardef9e822004-12-31 20:58:58 +00005331/* Complicated #if; matches with where get_mess_env() is used below. */
5332#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5333 && defined(LC_MESSAGES))) \
5334 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5335 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
5336 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01005337static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005338
5339/*
5340 * Get the language used for messages from the environment.
5341 */
5342 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005343get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005344{
5345 char_u *p;
5346
5347 p = mch_getenv((char_u *)"LC_ALL");
5348 if (p == NULL || *p == NUL)
5349 {
5350 p = mch_getenv((char_u *)"LC_MESSAGES");
5351 if (p == NULL || *p == NUL)
5352 {
5353 p = mch_getenv((char_u *)"LANG");
5354 if (p != NULL && VIM_ISDIGIT(*p))
5355 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005356# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005358 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359# endif
5360 }
5361 }
5362 return p;
5363}
5364#endif
5365
5366#if defined(FEAT_EVAL) || defined(PROTO)
5367
5368/*
5369 * Set the "v:lang" variable according to the current locale setting.
5370 * Also do "v:lc_time"and "v:ctype".
5371 */
5372 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005373set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005374{
5375 char_u *loc;
5376
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005377# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005378 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379# else
5380 /* setlocale() not supported: use the default value */
5381 loc = (char_u *)"C";
5382# endif
5383 set_vim_var_string(VV_CTYPE, loc, -1);
5384
5385 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
5386 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005387# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005388 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389# else
5390 loc = get_mess_env();
5391# endif
5392 set_vim_var_string(VV_LANG, loc, -1);
5393
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005394# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005395 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396# endif
5397 set_vim_var_string(VV_LC_TIME, loc, -1);
5398}
5399#endif
5400
5401#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5402 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
5403/*
5404 * ":language": Set the language (locale).
5405 */
5406 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005407ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408{
5409 char *loc;
5410 char_u *p;
5411 char_u *name;
5412 int what = LC_ALL;
5413 char *whatstr = "";
5414#ifdef LC_MESSAGES
5415# define VIM_LC_MESSAGES LC_MESSAGES
5416#else
5417# define VIM_LC_MESSAGES 6789
5418#endif
5419
5420 name = eap->arg;
5421
5422 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
5423 * Allow abbreviation, but require at least 3 characters to avoid
5424 * confusion with a two letter language name "me" or "ct". */
5425 p = skiptowhite(eap->arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005426 if ((*p == NUL || VIM_ISWHITE(*p)) && p - eap->arg >= 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427 {
5428 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
5429 {
5430 what = VIM_LC_MESSAGES;
5431 name = skipwhite(p);
5432 whatstr = "messages ";
5433 }
5434 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
5435 {
5436 what = LC_CTYPE;
5437 name = skipwhite(p);
5438 whatstr = "ctype ";
5439 }
5440 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
5441 {
5442 what = LC_TIME;
5443 name = skipwhite(p);
5444 whatstr = "time ";
5445 }
5446 }
5447
5448 if (*name == NUL)
5449 {
5450#ifndef LC_MESSAGES
5451 if (what == VIM_LC_MESSAGES)
5452 p = get_mess_env();
5453 else
5454#endif
5455 p = (char_u *)setlocale(what, NULL);
5456 if (p == NULL || *p == NUL)
5457 p = (char_u *)"Unknown";
5458 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
5459 }
5460 else
5461 {
5462#ifndef LC_MESSAGES
5463 if (what == VIM_LC_MESSAGES)
5464 loc = "";
5465 else
5466#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005467 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005469#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
5470 /* Make sure strtod() uses a decimal point, not a comma. */
5471 setlocale(LC_NUMERIC, "C");
5472#endif
5473 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005474 if (loc == NULL)
5475 EMSG2(_("E197: Cannot set language to \"%s\""), name);
5476 else
5477 {
5478#ifdef HAVE_NL_MSG_CAT_CNTR
5479 /* Need to do this for GNU gettext, otherwise cached translations
5480 * will be used again. */
5481 extern int _nl_msg_cat_cntr;
5482
5483 ++_nl_msg_cat_cntr;
5484#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00005485 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
5487
5488 if (what != LC_TIME)
5489 {
5490 /* Tell gettext() what to translate to. It apparently doesn't
5491 * use the currently effective locale. Also do this when
5492 * FEAT_GETTEXT isn't defined, so that shell commands use this
5493 * value. */
5494 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005495 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005496 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02005497
5498 /* Clear $LANGUAGE because GNU gettext uses it. */
5499 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005500# ifdef WIN32
5501 /* Apparently MS-Windows printf() may cause a crash when
5502 * we give it 8-bit text while it's expecting text in the
5503 * current locale. This call avoids that. */
5504 setlocale(LC_CTYPE, "C");
5505# endif
5506 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 if (what != LC_CTYPE)
5508 {
5509 char_u *mname;
5510#ifdef WIN32
5511 mname = gettext_lang(name);
5512#else
5513 mname = name;
5514#endif
5515 vim_setenv((char_u *)"LC_MESSAGES", mname);
5516#ifdef FEAT_MULTI_LANG
5517 set_helplang_default(mname);
5518#endif
5519 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005520 }
5521
5522# ifdef FEAT_EVAL
5523 /* Set v:lang, v:lc_time and v:ctype to the final result. */
5524 set_lang_var();
5525# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02005526# ifdef FEAT_TITLE
5527 maketitle();
5528# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005529 }
5530 }
5531}
5532
5533# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005534
5535static char_u **locales = NULL; /* Array of all available locales */
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005536
5537# ifndef WIN32
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005538static int did_init_locales = FALSE;
5539
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005540/* Return an array of strings for all available locales + NULL for the
5541 * last element. Return NULL in case of error. */
5542 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005543find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005544{
5545 garray_T locales_ga;
5546 char_u *loc;
5547
5548 /* Find all available locales by running command "locale -a". If this
5549 * doesn't work we won't have completion. */
5550 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02005551 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005552 if (locale_a == NULL)
5553 return NULL;
5554 ga_init2(&locales_ga, sizeof(char_u *), 20);
5555
5556 /* Transform locale_a string where each locale is separated by "\n"
5557 * into an array of locale strings. */
5558 loc = (char_u *)strtok((char *)locale_a, "\n");
5559
5560 while (loc != NULL)
5561 {
5562 if (ga_grow(&locales_ga, 1) == FAIL)
5563 break;
5564 loc = vim_strsave(loc);
5565 if (loc == NULL)
5566 break;
5567
5568 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5569 loc = (char_u *)strtok(NULL, "\n");
5570 }
5571 vim_free(locale_a);
5572 if (ga_grow(&locales_ga, 1) == FAIL)
5573 {
5574 ga_clear(&locales_ga);
5575 return NULL;
5576 }
5577 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5578 return (char_u **)locales_ga.ga_data;
5579}
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005580# endif
5581
5582/*
5583 * Lazy initialization of all available locales.
5584 */
5585 static void
5586init_locales(void)
5587{
5588# ifndef WIN32
5589 if (!did_init_locales)
5590 {
5591 did_init_locales = TRUE;
5592 locales = find_locales();
5593 }
5594# endif
5595}
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005596
5597# if defined(EXITFREE) || defined(PROTO)
5598 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005599free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005600{
5601 int i;
5602 if (locales != NULL)
5603 {
5604 for (i = 0; locales[i] != NULL; i++)
5605 vim_free(locales[i]);
Bram Moolenaard23a8232018-02-10 18:45:26 +01005606 VIM_CLEAR(locales);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005607 }
5608}
5609# endif
5610
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611/*
5612 * Function given to ExpandGeneric() to obtain the possible arguments of the
5613 * ":language" command.
5614 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005616get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617{
5618 if (idx == 0)
5619 return (char_u *)"messages";
5620 if (idx == 1)
5621 return (char_u *)"ctype";
5622 if (idx == 2)
5623 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005624
5625 init_locales();
5626 if (locales == NULL)
5627 return NULL;
5628 return locales[idx - 3];
5629}
5630
5631/*
5632 * Function given to ExpandGeneric() to obtain the available locales.
5633 */
5634 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005635get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005636{
5637 init_locales();
5638 if (locales == NULL)
5639 return NULL;
5640 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005641}
5642# endif
5643
5644#endif