blob: 8dae69a723ce0a2f33269f9bbe852e17948fd55f [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#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
2553/*
2554 * Redefine the argument list.
2555 */
2556 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002557set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558{
2559 do_arglist(str, AL_SET, 0);
2560}
2561#endif
2562
2563/*
2564 * "what" == AL_SET: Redefine the argument list to 'str'.
2565 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2566 * "what" == AL_DEL: remove files in 'str' from the argument list.
2567 *
2568 * Return FAIL for failure, OK otherwise.
2569 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002571do_arglist(
2572 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002573 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002574 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575{
2576 garray_T new_ga;
2577 int exp_count;
2578 char_u **exp_files;
2579 int i;
2580#ifdef FEAT_LISTCMDS
2581 char_u *p;
2582 int match;
2583#endif
Bram Moolenaar398ee732017-08-03 14:29:14 +02002584 int arg_escaped = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585
2586 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002587 * Set default argument for ":argadd" command.
2588 */
2589 if (what == AL_ADD && *str == NUL)
2590 {
2591 if (curbuf->b_ffname == NULL)
2592 return FAIL;
2593 str = curbuf->b_fname;
Bram Moolenaar398ee732017-08-03 14:29:14 +02002594 arg_escaped = FALSE;
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002595 }
2596
2597 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 * Collect all file name arguments in "new_ga".
2599 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002600 if (get_arglist(&new_ga, str, arg_escaped) == FAIL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002601 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602
2603#ifdef FEAT_LISTCMDS
2604 if (what == AL_DEL)
2605 {
2606 regmatch_T regmatch;
2607 int didone;
2608
2609 /*
2610 * Delete the items: use each item as a regexp and find a match in the
2611 * argument list.
2612 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002613 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2615 {
2616 p = ((char_u **)new_ga.ga_data)[i];
2617 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2618 if (p == NULL)
2619 break;
2620 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2621 if (regmatch.regprog == NULL)
2622 {
2623 vim_free(p);
2624 break;
2625 }
2626
2627 didone = FALSE;
2628 for (match = 0; match < ARGCOUNT; ++match)
2629 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2630 (colnr_T)0))
2631 {
2632 didone = TRUE;
2633 vim_free(ARGLIST[match].ae_fname);
2634 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2635 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2636 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 if (curwin->w_arg_idx > match)
2638 --curwin->w_arg_idx;
2639 --match;
2640 }
2641
Bram Moolenaar473de612013-06-08 18:19:48 +02002642 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 vim_free(p);
2644 if (!didone)
2645 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2646 }
2647 ga_clear(&new_ga);
2648 }
2649 else
2650#endif
2651 {
2652 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2653 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2654 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002655 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 {
2657 EMSG(_(e_nomatch));
2658 return FAIL;
2659 }
2660
2661#ifdef FEAT_LISTCMDS
2662 if (what == AL_ADD)
2663 {
2664 (void)alist_add_list(exp_count, exp_files, after);
2665 vim_free(exp_files);
2666 }
2667 else /* what == AL_SET */
2668#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00002669 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 }
2671
2672 alist_check_arg_idx();
2673
2674 return OK;
2675}
2676
2677/*
2678 * Check the validity of the arg_idx for each other window.
2679 */
2680 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002681alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002684 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685
Bram Moolenaarf740b292006-02-16 22:11:02 +00002686 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 if (win->w_alist == curwin->w_alist)
2688 check_arg_idx(win);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002689}
2690
2691/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002692 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002693 * index.
2694 */
2695 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002696editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002697{
2698 return !(win->w_arg_idx >= WARGCOUNT(win)
2699 || (win->w_buffer->b_fnum
2700 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2701 && (win->w_buffer->b_ffname == NULL
2702 || !(fullpathcmp(
2703 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2704 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2705}
2706
2707/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 * Check if window "win" is editing the w_arg_idx file in its argument list.
2709 */
2710 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002711check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002713 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 {
2715 /* We are not editing the current entry in the argument list.
2716 * Set "arg_had_last" if we are editing the last one. */
2717 win->w_arg_idx_invalid = TRUE;
2718 if (win->w_arg_idx != WARGCOUNT(win) - 1
2719 && arg_had_last == FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 && ALIST(win) == &global_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +00002721 && GARGCOUNT > 0
2722 && win->w_arg_idx < GARGCOUNT
2723 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2724 || (win->w_buffer->b_ffname != NULL
2725 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2726 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2727 arg_had_last = TRUE;
2728 }
2729 else
2730 {
2731 /* We are editing the current entry in the argument list.
2732 * Set "arg_had_last" if it's also the last one */
2733 win->w_arg_idx_invalid = FALSE;
2734 if (win->w_arg_idx == WARGCOUNT(win) - 1
Bram Moolenaar4033c552017-09-16 20:54:51 +02002735 && win->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736 arg_had_last = TRUE;
2737 }
2738}
2739
2740/*
2741 * ":args", ":argslocal" and ":argsglobal".
2742 */
2743 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002744ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745{
2746 int i;
2747
2748 if (eap->cmdidx != CMD_args)
2749 {
Bram Moolenaar4033c552017-09-16 20:54:51 +02002750#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 alist_unlink(ALIST(curwin));
2752 if (eap->cmdidx == CMD_argglobal)
2753 ALIST(curwin) = &global_alist;
2754 else /* eap->cmdidx == CMD_arglocal */
2755 alist_new();
2756#else
2757 ex_ni(eap);
2758 return;
2759#endif
2760 }
2761
2762 if (!ends_excmd(*eap->arg))
2763 {
2764 /*
2765 * ":args file ..": define new argument list, handle like ":next"
2766 * Also for ":argslocal file .." and ":argsglobal file ..".
2767 */
2768 ex_next(eap);
2769 }
2770 else
Bram Moolenaar4033c552017-09-16 20:54:51 +02002771#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772 if (eap->cmdidx == CMD_args)
2773#endif
2774 {
2775 /*
2776 * ":args": list arguments.
2777 */
2778 if (ARGCOUNT > 0)
2779 {
2780 /* Overwrite the command, for a short list there is no scrolling
2781 * required and no wait_return(). */
2782 gotocmdline(TRUE);
2783 for (i = 0; i < ARGCOUNT; ++i)
2784 {
2785 if (i == curwin->w_arg_idx)
2786 msg_putchar('[');
2787 msg_outtrans(alist_name(&ARGLIST[i]));
2788 if (i == curwin->w_arg_idx)
2789 msg_putchar(']');
2790 msg_putchar(' ');
2791 }
2792 }
2793 }
Bram Moolenaar4033c552017-09-16 20:54:51 +02002794#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795 else if (eap->cmdidx == CMD_arglocal)
2796 {
2797 garray_T *gap = &curwin->w_alist->al_ga;
2798
2799 /*
2800 * ":argslocal": make a local copy of the global argument list.
2801 */
2802 if (ga_grow(gap, GARGCOUNT) == OK)
2803 for (i = 0; i < GARGCOUNT; ++i)
2804 if (GARGLIST[i].ae_fname != NULL)
2805 {
2806 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2807 vim_strsave(GARGLIST[i].ae_fname);
2808 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2809 GARGLIST[i].ae_fnum;
2810 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 }
2812 }
2813#endif
2814}
2815
2816/*
2817 * ":previous", ":sprevious", ":Next" and ":sNext".
2818 */
2819 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002820ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821{
2822 /* If past the last one already, go to the last one. */
2823 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2824 do_argfile(eap, ARGCOUNT - 1);
2825 else
2826 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2827}
2828
2829/*
2830 * ":rewind", ":first", ":sfirst" and ":srewind".
2831 */
2832 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002833ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834{
2835 do_argfile(eap, 0);
2836}
2837
2838/*
2839 * ":last" and ":slast".
2840 */
2841 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002842ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843{
2844 do_argfile(eap, ARGCOUNT - 1);
2845}
2846
2847/*
2848 * ":argument" and ":sargument".
2849 */
2850 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002851ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002852{
2853 int i;
2854
2855 if (eap->addr_count > 0)
2856 i = eap->line2 - 1;
2857 else
2858 i = curwin->w_arg_idx;
2859 do_argfile(eap, i);
2860}
2861
2862/*
2863 * Edit file "argn" of the argument lists.
2864 */
2865 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002866do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867{
2868 int other;
2869 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002870 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002871
2872 if (argn < 0 || argn >= ARGCOUNT)
2873 {
2874 if (ARGCOUNT <= 1)
2875 EMSG(_("E163: There is only one file to edit"));
2876 else if (argn < 0)
2877 EMSG(_("E164: Cannot go before first file"));
2878 else
2879 EMSG(_("E165: Cannot go beyond last file"));
2880 }
2881 else
2882 {
2883 setpcmark();
2884#ifdef FEAT_GUI
2885 need_mouse_correct = TRUE;
2886#endif
2887
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002888 /* split window or create new tab page first */
2889 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 {
2891 if (win_split(0, 0) == FAIL)
2892 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002893 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002894 }
2895 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 {
2897 /*
2898 * if 'hidden' set, only check for changed file when re-editing
2899 * the same buffer
2900 */
2901 other = TRUE;
Bram Moolenaareb44a682017-08-03 22:44:55 +02002902 if (buf_hide(curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002903 {
2904 p = fix_fname(alist_name(&ARGLIST[argn]));
2905 other = otherfile(p);
2906 vim_free(p);
2907 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002908 if ((!buf_hide(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002909 && check_changed(curbuf, CCGD_AW
2910 | (other ? 0 : CCGD_MULTWIN)
2911 | (eap->forceit ? CCGD_FORCEIT : 0)
2912 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 return;
2914 }
2915
2916 curwin->w_arg_idx = argn;
Bram Moolenaar4033c552017-09-16 20:54:51 +02002917 if (argn == ARGCOUNT - 1 && curwin->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 arg_had_last = TRUE;
2919
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002920 /* Edit the file; always use the last known line number.
2921 * When it fails (e.g. Abort for already edited file) restore the
2922 * argument index. */
2923 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 eap, ECMD_LAST,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002925 (buf_hide(curwin->w_buffer) ? ECMD_HIDE : 0)
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002926 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002927 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002929 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 setmark('\'');
2931 }
2932}
2933
2934/*
2935 * ":next", and commands that behave like it.
2936 */
2937 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002938ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939{
2940 int i;
2941
2942 /*
2943 * check for changed buffer now, if this fails the argument list is not
2944 * redefined.
2945 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002946 if ( buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002948 || !check_changed(curbuf, CCGD_AW
2949 | (eap->forceit ? CCGD_FORCEIT : 0)
2950 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 {
2952 if (*eap->arg != NUL) /* redefine file list */
2953 {
2954 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2955 return;
2956 i = 0;
2957 }
2958 else
2959 i = curwin->w_arg_idx + (int)eap->line2;
2960 do_argfile(eap, i);
2961 }
2962}
2963
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002964#if defined(FEAT_LISTCMDS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965/*
2966 * ":argedit"
2967 */
2968 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002969ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970{
Bram Moolenaar90305c62017-07-16 15:31:17 +02002971 int i = eap->addr_count ? (int)eap->line2 : curwin->w_arg_idx + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972
Bram Moolenaar90305c62017-07-16 15:31:17 +02002973 if (do_arglist(eap->arg, AL_ADD, i) == FAIL)
2974 return;
2975#ifdef FEAT_TITLE
2976 maketitle();
2977#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978
Bram Moolenaar90305c62017-07-16 15:31:17 +02002979 if (curwin->w_arg_idx == 0 && (curbuf->b_ml.ml_flags & ML_EMPTY)
2980 && curbuf->b_ffname == NULL)
2981 i = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 /* Edit the argument. */
Bram Moolenaar90305c62017-07-16 15:31:17 +02002983 if (i < ARGCOUNT)
2984 do_argfile(eap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985}
2986
2987/*
2988 * ":argadd"
2989 */
2990 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002991ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992{
2993 do_arglist(eap->arg, AL_ADD,
2994 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2995#ifdef FEAT_TITLE
2996 maketitle();
2997#endif
2998}
2999
3000/*
3001 * ":argdelete"
3002 */
3003 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003004ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005{
3006 int i;
3007 int n;
3008
3009 if (eap->addr_count > 0)
3010 {
3011 /* ":1,4argdel": Delete all arguments in the range. */
3012 if (eap->line2 > ARGCOUNT)
3013 eap->line2 = ARGCOUNT;
3014 n = eap->line2 - eap->line1 + 1;
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01003015 if (*eap->arg != NUL)
3016 /* Can't have both a range and an argument. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003017 EMSG(_(e_invarg));
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01003018 else if (n <= 0)
3019 {
3020 /* Don't give an error for ":%argdel" if the list is empty. */
3021 if (eap->line1 != 1 || eap->line2 != 0)
3022 EMSG(_(e_invrange));
3023 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 else
3025 {
3026 for (i = eap->line1; i <= eap->line2; ++i)
3027 vim_free(ARGLIST[i - 1].ae_fname);
3028 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
3029 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
3030 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 if (curwin->w_arg_idx >= eap->line2)
3032 curwin->w_arg_idx -= n;
3033 else if (curwin->w_arg_idx > eap->line1)
3034 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01003035 if (ARGCOUNT == 0)
3036 curwin->w_arg_idx = 0;
3037 else if (curwin->w_arg_idx >= ARGCOUNT)
3038 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039 }
3040 }
3041 else if (*eap->arg == NUL)
3042 EMSG(_(e_argreq));
3043 else
3044 do_arglist(eap->arg, AL_DEL, 0);
3045#ifdef FEAT_TITLE
3046 maketitle();
3047#endif
3048}
3049
3050/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003051 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 */
3053 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003054ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055{
3056 int i;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003057 win_T *wp;
3058 tabpage_T *tp;
Bram Moolenaare25bb902015-02-27 20:33:37 +01003059 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 int next_fnum = 0;
3061#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
3062 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003064 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003065#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02003066 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003067 int qf_idx;
3068#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01003070#ifndef FEAT_QUICKFIX
3071 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
3072 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3073 {
3074 ex_ni(eap);
3075 return;
3076 }
3077#endif
3078
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003080 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00003081 /* Don't do syntax HL autocommands. Skipping the syntax file is a
3082 * great speed improvement. */
3083 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003085#ifdef FEAT_CLIPBOARD
3086 start_global_changes();
3087#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088
3089 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003090 || eap->cmdidx == CMD_tabdo
Bram Moolenaareb44a682017-08-03 22:44:55 +02003091 || buf_hide(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003092 || !check_changed(curbuf, CCGD_AW
3093 | (eap->forceit ? CCGD_FORCEIT : 0)
3094 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003097 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003098 wp = firstwin;
3099 tp = first_tabpage;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003100 switch (eap->cmdidx)
3101 {
Bram Moolenaara162bc52015-01-07 16:54:21 +01003102 case CMD_windo:
3103 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
3104 i++;
3105 break;
3106 case CMD_tabdo:
3107 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
3108 i++;
3109 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003110 case CMD_argdo:
3111 i = eap->line1 - 1;
3112 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003113 default:
3114 break;
3115 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 /* set pcmark now */
3117 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003118 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01003119 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003120 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01003121 || !buf->b_p_bl); buf = buf->b_next)
3122 if (buf->b_fnum > eap->line2)
3123 {
3124 buf = NULL;
3125 break;
3126 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003127 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01003128 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003129 }
3130#ifdef FEAT_QUICKFIX
3131 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3132 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3133 {
3134 qf_size = qf_get_size(eap);
3135 if (qf_size <= 0 || eap->line1 > qf_size)
3136 buf = NULL;
3137 else
3138 {
3139 ex_cc(eap);
3140
3141 buf = curbuf;
3142 i = eap->line1 - 1;
3143 if (eap->addr_count <= 0)
3144 /* default is all the quickfix/location list entries */
3145 eap->line2 = qf_size;
3146 }
3147 }
3148#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 else
3150 setpcmark();
3151 listcmd_busy = TRUE; /* avoids setting pcmark below */
3152
Bram Moolenaare25bb902015-02-27 20:33:37 +01003153 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 {
3155 if (eap->cmdidx == CMD_argdo)
3156 {
3157 /* go to argument "i" */
3158 if (i == ARGCOUNT)
3159 break;
3160 /* Don't call do_argfile() when already there, it will try
3161 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003162 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003163 {
3164 /* Clear 'shm' to avoid that the file message overwrites
3165 * any output from the command. */
3166 p_shm_save = vim_strsave(p_shm);
3167 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003169 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3170 vim_free(p_shm_save);
3171 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003172 if (curwin->w_arg_idx != i)
3173 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175 else if (eap->cmdidx == CMD_windo)
3176 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003177 /* go to window "wp" */
3178 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003180 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00003181 if (curwin != wp)
3182 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003183 wp = curwin->w_next;
3184 }
3185 else if (eap->cmdidx == CMD_tabdo)
3186 {
3187 /* go to window "tp" */
3188 if (!valid_tabpage(tp))
3189 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02003190 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003191 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 else if (eap->cmdidx == CMD_bufdo)
3194 {
3195 /* Remember the number of the next listed buffer, in case
3196 * ":bwipe" is used or autocommands do something strange. */
3197 next_fnum = -1;
3198 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
3199 if (buf->b_p_bl)
3200 {
3201 next_fnum = buf->b_fnum;
3202 break;
3203 }
3204 }
3205
Bram Moolenaara162bc52015-01-07 16:54:21 +01003206 ++i;
3207
Bram Moolenaar071d4272004-06-13 20:20:40 +00003208 /* execute the command */
3209 do_cmdline(eap->arg, eap->getline, eap->cookie,
3210 DOCMD_VERBOSE + DOCMD_NOWAIT);
3211
3212 if (eap->cmdidx == CMD_bufdo)
3213 {
3214 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01003215 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 break;
3217 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02003218 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003219 if (buf->b_fnum == next_fnum)
3220 break;
3221 if (buf == NULL)
3222 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003223
3224 /* Go to the next buffer. Clear 'shm' to avoid that the file
3225 * message overwrites any output from the command. */
3226 p_shm_save = vim_strsave(p_shm);
3227 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003229 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3230 vim_free(p_shm_save);
3231
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003232 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003233 if (curbuf->b_fnum != next_fnum)
3234 break;
3235 }
3236
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003237#ifdef FEAT_QUICKFIX
3238 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3239 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3240 {
3241 if (i >= qf_size || i >= eap->line2)
3242 break;
3243
3244 qf_idx = qf_get_cur_idx(eap);
3245
3246 ex_cnext(eap);
3247
3248 /* If jumping to the next quickfix entry fails, quit here */
3249 if (qf_get_cur_idx(eap) == qf_idx)
3250 break;
3251 }
3252#endif
3253
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254 if (eap->cmdidx == CMD_windo)
3255 {
3256 validate_cursor(); /* cursor may have moved */
3257#ifdef FEAT_SCROLLBIND
3258 /* required when 'scrollbind' has been set */
3259 if (curwin->w_p_scb)
3260 do_check_scrollbind(TRUE);
3261#endif
3262 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01003263
Bram Moolenaara162bc52015-01-07 16:54:21 +01003264 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
3265 if (i+1 > eap->line2)
3266 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003267 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
3268 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 }
3270 listcmd_busy = FALSE;
3271 }
3272
3273#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003274 if (save_ei != NULL)
3275 {
3276 au_event_restore(save_ei);
3277 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
3278 curbuf->b_fname, TRUE, curbuf);
3279 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003281#ifdef FEAT_CLIPBOARD
3282 end_global_changes();
3283#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284}
3285
3286/*
3287 * Add files[count] to the arglist of the current window after arg "after".
3288 * The file names in files[count] must have been allocated and are taken over.
3289 * Files[] itself is not taken over.
3290 * Returns index of first added argument. Returns -1 when failed (out of mem).
3291 */
3292 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003293alist_add_list(
3294 int count,
3295 char_u **files,
3296 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003297{
3298 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003299 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300
3301 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3302 {
3303 if (after < 0)
3304 after = 0;
3305 if (after > ARGCOUNT)
3306 after = ARGCOUNT;
3307 if (after < ARGCOUNT)
3308 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3309 (ARGCOUNT - after) * sizeof(aentry_T));
3310 for (i = 0; i < count; ++i)
3311 {
3312 ARGLIST[after + i].ae_fname = files[i];
3313 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
3314 }
3315 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003316 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3317 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 return after;
3319 }
3320
3321 for (i = 0; i < count; ++i)
3322 vim_free(files[i]);
3323 return -1;
3324}
3325
3326#endif /* FEAT_LISTCMDS */
3327
3328#ifdef FEAT_EVAL
3329/*
3330 * ":compiler[!] {name}"
3331 */
3332 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003333ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003334{
3335 char_u *buf;
3336 char_u *old_cur_comp = NULL;
3337 char_u *p;
3338
3339 if (*eap->arg == NUL)
3340 {
3341 /* List all compiler scripts. */
3342 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3343 /* ) keep the indenter happy... */
3344 }
3345 else
3346 {
3347 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3348 if (buf != NULL)
3349 {
3350 if (eap->forceit)
3351 {
3352 /* ":compiler! {name}" sets global options */
3353 do_cmdline_cmd((char_u *)
3354 "command -nargs=* CompilerSet set <args>");
3355 }
3356 else
3357 {
3358 /* ":compiler! {name}" sets local options.
3359 * To remain backwards compatible "current_compiler" is always
3360 * used. A user's compiler plugin may set it, the distributed
3361 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003362 * "b:current_compiler" and restore "current_compiler".
3363 * Explicitly prepend "g:" to make it work in a function. */
3364 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 if (old_cur_comp != NULL)
3366 old_cur_comp = vim_strsave(old_cur_comp);
3367 do_cmdline_cmd((char_u *)
3368 "command -nargs=* CompilerSet setlocal <args>");
3369 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003370 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003371 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372
3373 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003374 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3376 vim_free(buf);
3377
3378 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3379
3380 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003381 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 if (p != NULL)
3383 set_internal_string_var((char_u *)"b:current_compiler", p);
3384
3385 /* Restore "current_compiler" for ":compiler {name}". */
3386 if (!eap->forceit)
3387 {
3388 if (old_cur_comp != NULL)
3389 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003390 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 old_cur_comp);
3392 vim_free(old_cur_comp);
3393 }
3394 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003395 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003396 }
3397 }
3398 }
3399}
3400#endif
3401
3402/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003403 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 */
3405 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003406ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003408 char_u *arg = eap->arg;
3409 char_u *p = skiptowhite(arg);
3410 int len = (int)(p - arg);
3411 int flags = eap->forceit ? DIP_ALL : 0;
3412
3413 if (STRNCMP(arg, "START", len) == 0)
3414 {
3415 flags += DIP_START + DIP_NORTP;
3416 arg = skipwhite(arg + len);
3417 }
3418 else if (STRNCMP(arg, "OPT", len) == 0)
3419 {
3420 flags += DIP_OPT + DIP_NORTP;
3421 arg = skipwhite(arg + len);
3422 }
3423 else if (STRNCMP(arg, "PACK", len) == 0)
3424 {
3425 flags += DIP_START + DIP_OPT + DIP_NORTP;
3426 arg = skipwhite(arg + len);
3427 }
3428 else if (STRNCMP(arg, "ALL", len) == 0)
3429 {
3430 flags += DIP_START + DIP_OPT;
3431 arg = skipwhite(arg + len);
3432 }
3433
3434 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435}
3436
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003438source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003440 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441}
3442
3443/*
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003444 * Find the file "name" in all directories in "path" and invoke
3445 * "callback(fname, cookie)".
3446 * "name" can contain wildcards.
3447 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3448 * When "flags" has DIP_DIR: find directories instead of files.
3449 * When "flags" has DIP_ERR: give an error message if there is no match.
3450 *
3451 * return FAIL when no file could be sourced, OK otherwise.
3452 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003453 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003454do_in_path(
3455 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003456 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003457 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003458 void (*callback)(char_u *fname, void *ck),
3459 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003460{
3461 char_u *rtp;
3462 char_u *np;
3463 char_u *buf;
3464 char_u *rtp_copy;
3465 char_u *tail;
3466 int num_files;
3467 char_u **files;
3468 int i;
3469 int did_one = FALSE;
3470#ifdef AMIGA
3471 struct Process *proc = (struct Process *)FindTask(0L);
3472 APTR save_winptr = proc->pr_WindowPtr;
3473
3474 /* Avoid a requester here for a volume that doesn't exist. */
3475 proc->pr_WindowPtr = (APTR)-1L;
3476#endif
3477
3478 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3479 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003480 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003481 buf = alloc(MAXPATHL);
3482 if (buf != NULL && rtp_copy != NULL)
3483 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003484 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003485 {
3486 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003487 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003488 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003489 verbose_leave();
3490 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003491
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 /* Loop over all entries in 'runtimepath'. */
3493 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003494 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 {
Bram Moolenaar66459b72016-08-06 19:01:55 +02003496 size_t buflen;
3497
Bram Moolenaar071d4272004-06-13 20:20:40 +00003498 /* Copy the path from 'runtimepath' to buf[]. */
3499 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaar66459b72016-08-06 19:01:55 +02003500 buflen = STRLEN(buf);
3501
3502 /* Skip after or non-after directories. */
3503 if (flags & (DIP_NOAFTER | DIP_AFTER))
3504 {
3505 int is_after = buflen >= 5
3506 && STRCMP(buf + buflen - 5, "after") == 0;
3507
3508 if ((is_after && (flags & DIP_NOAFTER))
3509 || (!is_after && (flags & DIP_AFTER)))
3510 continue;
3511 }
3512
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003513 if (name == NULL)
3514 {
3515 (*callback)(buf, (void *) &cookie);
3516 if (!did_one)
3517 did_one = (cookie == NULL);
3518 }
Bram Moolenaar66459b72016-08-06 19:01:55 +02003519 else if (buflen + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 {
3521 add_pathsep(buf);
3522 tail = buf + STRLEN(buf);
3523
3524 /* Loop over all patterns in "name" */
3525 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003526 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003527 {
3528 /* Append the pattern from "name" to buf[]. */
3529 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3530 "\t ");
3531
3532 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003533 {
3534 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003535 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003536 verbose_leave();
3537 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538
3539 /* Expand wildcards, invoke the callback for each match. */
3540 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003541 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 {
3543 for (i = 0; i < num_files; ++i)
3544 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003545 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003547 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 break;
3549 }
3550 FreeWild(num_files, files);
3551 }
3552 }
3553 }
3554 }
3555 }
3556 vim_free(buf);
3557 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003558 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003559 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003560 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3561
3562 if (flags & DIP_ERR)
3563 EMSG3(_(e_dirnotf), basepath, name);
3564 else if (p_verbose > 0)
3565 {
3566 verbose_enter();
3567 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3568 verbose_leave();
3569 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003570 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571
3572#ifdef AMIGA
3573 proc->pr_WindowPtr = save_winptr;
3574#endif
3575
3576 return did_one ? OK : FAIL;
3577}
3578
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003579/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003580 * Find "name" in "path". When found, invoke the callback function for
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003581 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003582 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3583 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003584 * Returns OK when at least one match found, FAIL otherwise.
3585 *
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003586 * If "name" is NULL calls callback for each entry in "path". Cookie is
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003587 * passed by reference in this case, setting it to NULL indicates that callback
3588 * has done its job.
3589 */
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003590 static int
3591do_in_path_and_pp(
3592 char_u *path,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003593 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003594 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003595 void (*callback)(char_u *fname, void *ck),
3596 void *cookie)
3597{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003598 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003599 char_u *s;
3600 int len;
3601 char *start_dir = "pack/*/start/*/%s";
3602 char *opt_dir = "pack/*/opt/*/%s";
3603
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003604 if ((flags & DIP_NORTP) == 0)
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003605 done = do_in_path(path, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003606
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003607 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003608 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003609 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003610 s = alloc(len);
3611 if (s == NULL)
3612 return FAIL;
3613 vim_snprintf((char *)s, len, start_dir, name);
3614 done = do_in_path(p_pp, s, flags, callback, cookie);
3615 vim_free(s);
3616 }
3617
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003618 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003619 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003620 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003621 s = alloc(len);
3622 if (s == NULL)
3623 return FAIL;
3624 vim_snprintf((char *)s, len, opt_dir, name);
3625 done = do_in_path(p_pp, s, flags, callback, cookie);
3626 vim_free(s);
3627 }
3628
3629 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003630}
3631
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003632/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003633 * Just like do_in_path_and_pp(), using 'runtimepath' for "path".
3634 */
3635 int
3636do_in_runtimepath(
3637 char_u *name,
3638 int flags,
3639 void (*callback)(char_u *fname, void *ck),
3640 void *cookie)
3641{
3642 return do_in_path_and_pp(p_rtp, name, flags, callback, cookie);
3643}
3644
3645/*
3646 * Source the file "name" from all directories in 'runtimepath'.
3647 * "name" can contain wildcards.
3648 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3649 *
3650 * return FAIL when no file could be sourced, OK otherwise.
3651 */
3652 int
3653source_runtime(char_u *name, int flags)
3654{
3655 return source_in_path(p_rtp, name, flags);
3656}
3657
3658/*
3659 * Just like source_runtime(), but use "path" instead of 'runtimepath'.
3660 */
3661 int
3662source_in_path(char_u *path, char_u *name, int flags)
3663{
3664 return do_in_path_and_pp(path, name, flags, source_callback, NULL);
3665}
3666
3667
3668/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003669 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003670 */
3671 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003672source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003673{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003674 int num_files;
3675 char_u **files;
3676 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003677
Bram Moolenaarf3654822016-03-04 22:12:23 +01003678 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003679 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003680 for (i = 0; i < num_files; ++i)
3681 (void)do_source(files[i], FALSE, DOSO_NONE);
3682 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003683 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003684}
3685
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003686/*
3687 * Add the package directory to 'runtimepath'.
3688 */
3689 static int
3690add_pack_dir_to_rtp(char_u *fname)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003691{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003692 char_u *p4, *p3, *p2, *p1, *p;
3693 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003694 int c;
3695 char_u *new_rtp;
3696 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003697 size_t oldlen;
3698 size_t addlen;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003699 char_u *afterdir = NULL;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003700 size_t afterlen = 0;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003701 char_u *ffname = NULL;
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003702 size_t fname_len;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003703 char_u *buf = NULL;
3704 char_u *rtp_ffname;
3705 int match;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003706 int retval = FAIL;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003707
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003708 p4 = p3 = p2 = p1 = get_past_head(fname);
3709 for (p = p1; *p; MB_PTR_ADV(p))
3710 if (vim_ispathsep_nocolon(*p))
3711 {
3712 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3713 }
3714
3715 /* now we have:
3716 * rtp/pack/name/start/name
3717 * p4 p3 p2 p1
3718 *
3719 * find the part up to "pack" in 'runtimepath' */
3720 c = *++p4; /* append pathsep in order to expand symlink */
3721 *p4 = NUL;
3722 ffname = fix_fname(fname);
3723 *p4 = c;
Bram Moolenaar91715872016-03-03 17:13:03 +01003724 if (ffname == NULL)
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003725 return FAIL;
3726
3727 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3728 fname_len = STRLEN(ffname);
3729 insp = p_rtp;
3730 buf = alloc(MAXPATHL);
3731 if (buf == NULL)
3732 goto theend;
3733 while (*insp != NUL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003734 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003735 copy_option_part(&insp, buf, MAXPATHL, ",");
3736 add_pathsep(buf);
3737 rtp_ffname = fix_fname(buf);
3738 if (rtp_ffname == NULL)
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003739 goto theend;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003740 match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0;
3741 vim_free(rtp_ffname);
3742 if (match)
3743 break;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003744 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003745
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003746 if (*insp == NUL)
3747 /* not found, append at the end */
3748 insp = p_rtp + STRLEN(p_rtp);
3749 else
3750 /* append after the matching directory. */
3751 --insp;
3752
3753 /* check if rtp/pack/name/start/name/after exists */
3754 afterdir = concat_fnames(fname, (char_u *)"after", TRUE);
3755 if (afterdir != NULL && mch_isdir(afterdir))
3756 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3757
3758 oldlen = STRLEN(p_rtp);
3759 addlen = STRLEN(fname) + 1; /* add one for comma */
3760 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1));
3761 /* add one for NUL */
3762 if (new_rtp == NULL)
3763 goto theend;
3764 keep = (int)(insp - p_rtp);
3765 mch_memmove(new_rtp, p_rtp, keep);
3766 new_rtp[keep] = ',';
3767 mch_memmove(new_rtp + keep + 1, fname, addlen);
3768 if (p_rtp[keep] != NUL)
3769 mch_memmove(new_rtp + keep + addlen, p_rtp + keep, oldlen - keep + 1);
3770 if (afterlen > 0)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003771 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003772 STRCAT(new_rtp, ",");
3773 STRCAT(new_rtp, afterdir);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003774 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003775 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3776 vim_free(new_rtp);
3777 retval = OK;
Bram Moolenaarf3654822016-03-04 22:12:23 +01003778
3779theend:
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003780 vim_free(buf);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003781 vim_free(ffname);
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003782 vim_free(afterdir);
3783 return retval;
3784}
3785
3786/*
3787 * Load scripts in "plugin" and "ftdetect" directories of the package.
3788 */
3789 static int
3790load_pack_plugin(char_u *fname)
3791{
3792 static char *plugpat = "%s/plugin/**/*.vim";
3793 static char *ftpat = "%s/ftdetect/*.vim";
3794 int len;
3795 char_u *ffname = fix_fname(fname);
3796 char_u *pat = NULL;
3797 int retval = FAIL;
3798
3799 if (ffname == NULL)
3800 return FAIL;
3801 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3802 pat = alloc(len);
3803 if (pat == NULL)
3804 goto theend;
3805 vim_snprintf((char *)pat, len, plugpat, ffname);
3806 source_all_matches(pat);
3807
3808#ifdef FEAT_AUTOCMD
3809 {
3810 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3811
3812 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3813 * found when it loads. */
3814 if (cmd != NULL && eval_to_number(cmd) > 0)
3815 {
3816 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3817 vim_snprintf((char *)pat, len, ftpat, ffname);
3818 source_all_matches(pat);
3819 do_cmdline_cmd((char_u *)"augroup END");
3820 }
3821 vim_free(cmd);
3822 }
3823#endif
3824 vim_free(pat);
3825 retval = OK;
3826
3827theend:
3828 vim_free(ffname);
3829 return retval;
3830}
3831
3832/* used for "cookie" of add_pack_plugin() */
3833static int APP_ADD_DIR;
3834static int APP_LOAD;
3835static int APP_BOTH;
3836
3837 static void
3838add_pack_plugin(char_u *fname, void *cookie)
3839{
3840 if (cookie != &APP_LOAD && strstr((char *)p_rtp, (char *)fname) == NULL)
3841 /* directory is not yet in 'runtimepath', add it */
3842 if (add_pack_dir_to_rtp(fname) == FAIL)
3843 return;
3844
3845 if (cookie != &APP_ADD_DIR)
3846 load_pack_plugin(fname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003847}
3848
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003849/*
3850 * Add all packages in the "start" directory to 'runtimepath'.
3851 */
3852 void
3853add_pack_start_dirs(void)
3854{
3855 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3856 add_pack_plugin, &APP_ADD_DIR);
3857}
3858
3859/*
3860 * Load plugins from all packages in the "start" directory.
3861 */
3862 void
3863load_start_packages(void)
3864{
3865 did_source_packages = TRUE;
3866 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3867 add_pack_plugin, &APP_LOAD);
3868}
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003869
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003870/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003871 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003872 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003873 */
3874 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003875ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003876{
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003877 if (!did_source_packages || eap->forceit)
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003878 {
Bram Moolenaar49b27322016-04-05 21:13:00 +02003879 /* First do a round to add all directories to 'runtimepath', then load
3880 * the plugins. This allows for plugins to use an autoload directory
3881 * of another plugin. */
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003882 add_pack_start_dirs();
3883 load_start_packages();
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003884 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003885}
3886
3887/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003888 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003889 */
3890 void
3891ex_packadd(exarg_T *eap)
3892{
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003893 static char *plugpat = "pack/*/%s/%s";
Bram Moolenaar91715872016-03-03 17:13:03 +01003894 int len;
3895 char *pat;
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003896 int round;
3897 int res = OK;
Bram Moolenaar91715872016-03-03 17:13:03 +01003898
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003899 /* Round 1: use "start", round 2: use "opt". */
3900 for (round = 1; round <= 2; ++round)
3901 {
3902 /* Only look under "start" when loading packages wasn't done yet. */
3903 if (round == 1 && did_source_packages)
3904 continue;
3905
3906 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg) + 5;
3907 pat = (char *)alloc(len);
3908 if (pat == NULL)
3909 return;
3910 vim_snprintf(pat, len, plugpat, round == 1 ? "start" : "opt", eap->arg);
3911 /* The first round don't give a "not found" error, in the second round
3912 * only when nothing was found in the first round. */
3913 res = do_in_path(p_pp, (char_u *)pat,
3914 DIP_ALL + DIP_DIR + (round == 2 && res == FAIL ? DIP_ERR : 0),
3915 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
3916 vim_free(pat);
3917 }
Bram Moolenaar91715872016-03-03 17:13:03 +01003918}
3919
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
3921/*
3922 * ":options"
3923 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003925ex_options(
3926 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927{
Bram Moolenaarab6c8582017-08-11 17:15:09 +02003928 vim_setenv((char_u *)"OPTWIN_CMD", (char_u *)(cmdmod.tab ? "tab" : ""));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3930}
3931#endif
3932
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003933#if defined(FEAT_PYTHON3) || defined(FEAT_PYTHON) || defined(PROTO)
3934
3935# if (defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)) || defined(PROTO)
3936/*
3937 * Detect Python 3 or 2, and initialize 'pyxversion'.
3938 */
3939 void
3940init_pyxversion(void)
3941{
3942 if (p_pyx == 0)
3943 {
3944 if (python3_enabled(FALSE))
3945 p_pyx = 3;
3946 else if (python_enabled(FALSE))
3947 p_pyx = 2;
3948 }
3949}
3950# endif
3951
3952/*
3953 * Does a file contain one of the following strings at the beginning of any
3954 * line?
3955 * "#!(any string)python2" => returns 2
3956 * "#!(any string)python3" => returns 3
3957 * "# requires python 2.x" => returns 2
3958 * "# requires python 3.x" => returns 3
3959 * otherwise return 0.
3960 */
3961 static int
3962requires_py_version(char_u *filename)
3963{
3964 FILE *file;
3965 int requires_py_version = 0;
3966 int i, lines;
3967
3968 lines = (int)p_mls;
3969 if (lines < 0)
3970 lines = 5;
3971
3972 file = mch_fopen((char *)filename, "r");
3973 if (file != NULL)
3974 {
3975 for (i = 0; i < lines; i++)
3976 {
3977 if (vim_fgets(IObuff, IOSIZE, file))
3978 break;
3979 if (i == 0 && IObuff[0] == '#' && IObuff[1] == '!')
3980 {
3981 /* Check shebang. */
3982 if (strstr((char *)IObuff + 2, "python2") != NULL)
3983 {
3984 requires_py_version = 2;
3985 break;
3986 }
3987 if (strstr((char *)IObuff + 2, "python3") != NULL)
3988 {
3989 requires_py_version = 3;
3990 break;
3991 }
3992 }
3993 IObuff[21] = '\0';
3994 if (STRCMP("# requires python 2.x", IObuff) == 0)
3995 {
3996 requires_py_version = 2;
3997 break;
3998 }
3999 if (STRCMP("# requires python 3.x", IObuff) == 0)
4000 {
4001 requires_py_version = 3;
4002 break;
4003 }
4004 }
4005 fclose(file);
4006 }
4007 return requires_py_version;
4008}
4009
4010
4011/*
4012 * Source a python file using the requested python version.
4013 */
4014 static void
4015source_pyx_file(exarg_T *eap, char_u *fname)
4016{
4017 exarg_T ex;
4018 int v = requires_py_version(fname);
4019
4020# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4021 init_pyxversion();
4022# endif
4023 if (v == 0)
4024 {
4025# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4026 /* user didn't choose a preference, 'pyx' is used */
4027 v = p_pyx;
4028# elif defined(FEAT_PYTHON)
4029 v = 2;
4030# elif defined(FEAT_PYTHON3)
4031 v = 3;
4032# endif
4033 }
4034
4035 /*
4036 * now source, if required python version is not supported show
4037 * unobtrusive message.
4038 */
4039 if (eap == NULL)
4040 vim_memset(&ex, 0, sizeof(ex));
4041 else
4042 ex = *eap;
4043 ex.arg = fname;
4044 ex.cmd = (char_u *)(v == 2 ? "pyfile" : "pyfile3");
4045
4046 if (v == 2)
4047 {
4048# ifdef FEAT_PYTHON
4049 ex_pyfile(&ex);
4050# else
4051 vim_snprintf((char *)IObuff, IOSIZE,
4052 _("W20: Required python version 2.x not supported, ignoring file: %s"),
4053 fname);
4054 MSG(IObuff);
4055# endif
4056 return;
4057 }
4058 else
4059 {
4060# ifdef FEAT_PYTHON3
4061 ex_py3file(&ex);
4062# else
4063 vim_snprintf((char *)IObuff, IOSIZE,
4064 _("W21: Required python version 3.x not supported, ignoring file: %s"),
4065 fname);
4066 MSG(IObuff);
4067# endif
4068 return;
4069 }
4070}
4071
4072/*
4073 * ":pyxfile {fname}"
4074 */
4075 void
4076ex_pyxfile(exarg_T *eap)
4077{
4078 source_pyx_file(eap, eap->arg);
4079}
4080
4081/*
4082 * ":pyx"
4083 */
4084 void
4085ex_pyx(exarg_T *eap)
4086{
4087# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4088 init_pyxversion();
4089 if (p_pyx == 2)
4090 ex_python(eap);
4091 else
4092 ex_py3(eap);
4093# elif defined(FEAT_PYTHON)
4094 ex_python(eap);
4095# elif defined(FEAT_PYTHON3)
4096 ex_py3(eap);
4097# endif
4098}
4099
4100/*
4101 * ":pyxdo"
4102 */
4103 void
4104ex_pyxdo(exarg_T *eap)
4105{
4106# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4107 init_pyxversion();
4108 if (p_pyx == 2)
4109 ex_pydo(eap);
4110 else
4111 ex_py3do(eap);
4112# elif defined(FEAT_PYTHON)
4113 ex_pydo(eap);
4114# elif defined(FEAT_PYTHON3)
4115 ex_py3do(eap);
4116# endif
4117}
4118
4119#endif
4120
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121/*
4122 * ":source {fname}"
4123 */
4124 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004125ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126{
4127#ifdef FEAT_BROWSE
4128 if (cmdmod.browse)
4129 {
4130 char_u *fname = NULL;
4131
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00004132 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
4134 if (fname != NULL)
4135 {
4136 cmd_source(fname, eap);
4137 vim_free(fname);
4138 }
4139 }
4140 else
4141#endif
4142 cmd_source(eap->arg, eap);
4143}
4144
4145 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004146cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147{
4148 if (*fname == NUL)
4149 EMSG(_(e_argreq));
4150
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02004152 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004153 * Need to execute the commands directly. This is required at least
4154 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 * - ":g" command busy
4156 * - after ":argdo", ":windo" or ":bufdo"
4157 * - another command follows
4158 * - inside a loop
4159 */
4160 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
4161#ifdef FEAT_EVAL
4162 || eap->cstack->cs_idx >= 0
4163#endif
4164 );
4165
4166 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004167 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 EMSG2(_(e_notopen), fname);
4169}
4170
4171/*
4172 * ":source" and associated commands.
4173 */
4174/*
4175 * Structure used to store info for each sourced file.
4176 * It is shared between do_source() and getsourceline().
4177 * This is required, because it needs to be handed to do_cmdline() and
4178 * sourcing can be done recursively.
4179 */
4180struct source_cookie
4181{
4182 FILE *fp; /* opened file for sourcing */
4183 char_u *nextline; /* if not NULL: line that was read ahead */
4184 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004185#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
4187 int error; /* TRUE if LF found after CR-LF */
4188#endif
4189#ifdef FEAT_EVAL
4190 linenr_T breakpoint; /* next line with breakpoint or zero */
4191 char_u *fname; /* name of sourced file */
4192 int dbg_tick; /* debug_tick when breakpoint was set */
4193 int level; /* top nesting level of sourced file */
4194#endif
4195#ifdef FEAT_MBYTE
4196 vimconv_T conv; /* type of conversion */
4197#endif
4198};
4199
4200#ifdef FEAT_EVAL
4201/*
4202 * Return the address holding the next breakpoint line for a source cookie.
4203 */
4204 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004205source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206{
4207 return &((struct source_cookie *)cookie)->breakpoint;
4208}
4209
4210/*
4211 * Return the address holding the debug tick for a source cookie.
4212 */
4213 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004214source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215{
4216 return &((struct source_cookie *)cookie)->dbg_tick;
4217}
4218
4219/*
4220 * Return the nesting level for a source cookie.
4221 */
4222 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004223source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004224{
4225 return ((struct source_cookie *)cookie)->level;
4226}
4227#endif
4228
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004229static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004231#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
4232# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004233static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004234
4235/*
4236 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004237 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004238 */
4239 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004240fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004241{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004242# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01004243 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
4244# else
4245 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004246# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004247
4248 if (fd_tmp == -1)
4249 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004250
4251# ifdef HAVE_FD_CLOEXEC
4252 {
4253 int fdflags = fcntl(fd_tmp, F_GETFD);
4254 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02004255 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004256 }
4257# endif
4258
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 return fdopen(fd_tmp, READBIN);
4260}
4261#endif
4262
4263
4264/*
4265 * do_source: Read the file "fname" and execute its lines as EX commands.
4266 *
4267 * This function may be called recursively!
4268 *
4269 * return FAIL if file could not be opened, OK otherwise
4270 */
4271 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004272do_source(
4273 char_u *fname,
4274 int check_other, /* check for .vimrc and _vimrc */
4275 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276{
4277 struct source_cookie cookie;
4278 char_u *save_sourcing_name;
4279 linenr_T save_sourcing_lnum;
4280 char_u *p;
4281 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00004282 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 int retval = FAIL;
4284#ifdef FEAT_EVAL
4285 scid_T save_current_SID;
4286 static scid_T last_current_SID = 0;
4287 void *save_funccalp;
4288 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004289 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02004291 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 int stat_ok;
4293# endif
4294#endif
4295#ifdef STARTUPTIME
4296 struct timeval tv_rel;
4297 struct timeval tv_start;
4298#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004299#ifdef FEAT_PROFILE
4300 proftime_T wait_start;
4301#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 if (p == NULL)
4305 return retval;
4306 fname_exp = fix_fname(p);
4307 vim_free(p);
4308 if (fname_exp == NULL)
4309 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 if (mch_isdir(fname_exp))
4311 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00004312 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 goto theend;
4314 }
4315
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004316#ifdef FEAT_AUTOCMD
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004317 /* Apply SourceCmd autocommands, they should get the file and source it. */
4318 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
4319 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
4320 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004321 {
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004322# ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004323 retval = aborting() ? FAIL : OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004324# else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004325 retval = OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004326# endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004327 goto theend;
4328 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004329
4330 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004331 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
4332#endif
4333
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004334#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4336#else
4337 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4338#endif
4339 if (cookie.fp == NULL && check_other)
4340 {
4341 /*
4342 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
4343 * and ".exrc" by "_exrc" or vice versa.
4344 */
4345 p = gettail(fname_exp);
4346 if ((*p == '.' || *p == '_')
4347 && (STRICMP(p + 1, "vimrc") == 0
4348 || STRICMP(p + 1, "gvimrc") == 0
4349 || STRICMP(p + 1, "exrc") == 0))
4350 {
4351 if (*p == '_')
4352 *p = '.';
4353 else
4354 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004355#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4357#else
4358 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4359#endif
4360 }
4361 }
4362
4363 if (cookie.fp == NULL)
4364 {
4365 if (p_verbose > 0)
4366 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004367 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004369 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 else
4371 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004372 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004373 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 }
4375 goto theend;
4376 }
4377
4378 /*
4379 * The file exists.
4380 * - In verbose mode, give a message.
4381 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
4382 */
4383 if (p_verbose > 1)
4384 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004385 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004387 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 else
4389 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004390 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004391 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004393 if (is_vimrc == DOSO_VIMRC)
4394 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
4395 else if (is_vimrc == DOSO_GVIMRC)
4396 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397
4398#ifdef USE_CRNL
4399 /* If no automatic file format: Set default to CR-NL. */
4400 if (*p_ffs == NUL)
4401 cookie.fileformat = EOL_DOS;
4402 else
4403 cookie.fileformat = EOL_UNKNOWN;
4404 cookie.error = FALSE;
4405#endif
4406
4407#ifdef USE_CR
4408 /* If no automatic file format: Set default to CR. */
4409 if (*p_ffs == NUL)
4410 cookie.fileformat = EOL_MAC;
4411 else
4412 cookie.fileformat = EOL_UNKNOWN;
4413 cookie.error = FALSE;
4414#endif
4415
4416 cookie.nextline = NULL;
4417 cookie.finished = FALSE;
4418
4419#ifdef FEAT_EVAL
4420 /*
4421 * Check if this script has a breakpoint.
4422 */
4423 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
4424 cookie.fname = fname_exp;
4425 cookie.dbg_tick = debug_tick;
4426
4427 cookie.level = ex_nesting_level;
4428#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429
4430 /*
4431 * Keep the sourcing name/lnum, for recursive calls.
4432 */
4433 save_sourcing_name = sourcing_name;
4434 sourcing_name = fname_exp;
4435 save_sourcing_lnum = sourcing_lnum;
4436 sourcing_lnum = 0;
4437
4438#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004439 if (time_fd != NULL)
4440 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004441#endif
4442
4443#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00004444# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004445 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004446 prof_child_enter(&wait_start); /* entering a child now */
4447# endif
4448
4449 /* Don't use local function variables, if called from a function.
4450 * Also starts profiling timer for nested script. */
4451 save_funccalp = save_funccal();
4452
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 /*
4454 * Check if this script was sourced before to finds its SID.
4455 * If it's new, generate a new SID.
4456 */
4457 save_current_SID = current_SID;
4458# ifdef UNIX
4459 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
4460# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004461 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
4462 {
4463 si = &SCRIPT_ITEM(current_SID);
4464 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004465 && (
4466# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00004467 /* Compare dev/ino when possible, it catches symbolic
4468 * links. Also compare file names, the inode may change
4469 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004470 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004471 && (si->sn_dev == st.st_dev
4472 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004474 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004476 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 if (current_SID == 0)
4478 {
4479 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004480 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
4481 == FAIL)
4482 goto almosttheend;
4483 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00004485 ++script_items.ga_len;
4486 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
4487# ifdef FEAT_PROFILE
4488 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004491 si = &SCRIPT_ITEM(current_SID);
4492 si->sn_name = fname_exp;
4493 fname_exp = NULL;
4494# ifdef UNIX
4495 if (stat_ok)
4496 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004497 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004498 si->sn_dev = st.st_dev;
4499 si->sn_ino = st.st_ino;
4500 }
4501 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004502 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004503# endif
4504
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 /* Allocate the local script variables to use for this script. */
4506 new_script_vars(current_SID);
4507 }
4508
Bram Moolenaar05159a02005-02-26 23:04:13 +00004509# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004510 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004511 {
4512 int forceit;
4513
4514 /* Check if we do profiling for this script. */
4515 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
4516 {
4517 script_do_profile(si);
4518 si->sn_pr_force = forceit;
4519 }
4520 if (si->sn_prof_on)
4521 {
4522 ++si->sn_pr_count;
4523 profile_start(&si->sn_pr_start);
4524 profile_zero(&si->sn_pr_children);
4525 }
4526 }
4527# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528#endif
4529
Bram Moolenaar67435d92017-10-19 21:04:37 +02004530#ifdef FEAT_MBYTE
4531 cookie.conv.vc_type = CONV_NONE; /* no conversion */
4532
4533 /* Read the first line so we can check for a UTF-8 BOM. */
4534 firstline = getsourceline(0, (void *)&cookie, 0);
4535 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
4536 && firstline[1] == 0xbb && firstline[2] == 0xbf)
4537 {
4538 /* Found BOM; setup conversion, skip over BOM and recode the line. */
4539 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
4540 p = string_convert(&cookie.conv, firstline + 3, NULL);
4541 if (p == NULL)
4542 p = vim_strsave(firstline + 3);
4543 if (p != NULL)
4544 {
4545 vim_free(firstline);
4546 firstline = p;
4547 }
4548 }
4549#endif
4550
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 /*
4552 * Call do_cmdline, which will call getsourceline() to get the lines.
4553 */
Bram Moolenaar73881402009-02-04 16:50:47 +00004554 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004557
4558#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004559 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004560 {
4561 /* Get "si" again, "script_items" may have been reallocated. */
4562 si = &SCRIPT_ITEM(current_SID);
4563 if (si->sn_prof_on)
4564 {
4565 profile_end(&si->sn_pr_start);
4566 profile_sub_wait(&wait_start, &si->sn_pr_start);
4567 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004568 profile_self(&si->sn_pr_self, &si->sn_pr_start,
4569 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004570 }
4571 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572#endif
4573
4574 if (got_int)
4575 EMSG(_(e_interr));
4576 sourcing_name = save_sourcing_name;
4577 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 if (p_verbose > 1)
4579 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004580 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004581 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004582 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004583 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004584 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585 }
4586#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004587 if (time_fd != NULL)
4588 {
4589 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4590 time_msg((char *)IObuff, &tv_start);
4591 time_pop(&tv_rel);
4592 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593#endif
4594
4595#ifdef FEAT_EVAL
4596 /*
4597 * After a "finish" in debug mode, need to break at first command of next
4598 * sourced file.
4599 */
4600 if (save_debug_break_level > ex_nesting_level
4601 && debug_break_level == ex_nesting_level)
4602 ++debug_break_level;
4603#endif
4604
Bram Moolenaar05159a02005-02-26 23:04:13 +00004605#ifdef FEAT_EVAL
4606almosttheend:
4607 current_SID = save_current_SID;
4608 restore_funccal(save_funccalp);
4609# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004610 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004611 prof_child_exit(&wait_start); /* leaving a child now */
4612# endif
4613#endif
4614 fclose(cookie.fp);
4615 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004616 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004617#ifdef FEAT_MBYTE
4618 convert_setup(&cookie.conv, NULL, NULL);
4619#endif
4620
Bram Moolenaar071d4272004-06-13 20:20:40 +00004621theend:
4622 vim_free(fname_exp);
4623 return retval;
4624}
4625
4626#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004627
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628/*
4629 * ":scriptnames"
4630 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004632ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633{
4634 int i;
4635
Bram Moolenaar05159a02005-02-26 23:04:13 +00004636 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4637 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004638 {
4639 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4640 NameBuff, MAXPATHL, TRUE);
4641 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004642 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004643}
4644
4645# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4646/*
4647 * Fix slashes in the list of script names for 'shellslash'.
4648 */
4649 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004650scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651{
4652 int i;
4653
Bram Moolenaar05159a02005-02-26 23:04:13 +00004654 for (i = 1; i <= script_items.ga_len; ++i)
4655 if (SCRIPT_ITEM(i).sn_name != NULL)
4656 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657}
4658# endif
4659
4660/*
4661 * Get a pointer to a script name. Used for ":verbose set".
4662 */
4663 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004664get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665{
4666 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004667 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004669 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004671 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004673 return (char_u *)_("environment variable");
4674 if (id == SID_ERROR)
4675 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004676 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004677}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004678
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004679# if defined(EXITFREE) || defined(PROTO)
4680 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004681free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004682{
4683 int i;
4684
4685 for (i = script_items.ga_len; i > 0; --i)
4686 vim_free(SCRIPT_ITEM(i).sn_name);
4687 ga_clear(&script_items);
4688}
4689# endif
4690
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691#endif
4692
4693#if defined(USE_CR) || defined(PROTO)
4694
4695# if defined(__MSL__) && (__MSL__ >= 22)
4696/*
4697 * Newer version of the Metrowerks library handle DOS and UNIX files
4698 * without help.
4699 * Test with earlier versions, MSL 2.2 is the library supplied with
4700 * Codewarrior Pro 2.
4701 */
4702 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004703fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704{
4705 return fgets(s, n, stream);
4706}
4707# else
4708/*
4709 * Version of fgets() which also works for lines ending in a <CR> only
4710 * (Macintosh format).
4711 * For older versions of the Metrowerks library.
4712 * At least CodeWarrior 9 needed this code.
4713 */
4714 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004715fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004716{
4717 int c = 0;
4718 int char_read = 0;
4719
4720 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4721 {
4722 c = fgetc(stream);
4723 s[char_read++] = c;
4724 /* If the file is in DOS format, we need to skip a NL after a CR. I
4725 * thought it was the other way around, but this appears to work... */
4726 if (c == '\n')
4727 {
4728 c = fgetc(stream);
4729 if (c != '\r')
4730 ungetc(c, stream);
4731 }
4732 }
4733
4734 s[char_read] = 0;
4735 if (char_read == 0)
4736 return NULL;
4737
4738 if (feof(stream) && char_read == 1)
4739 return NULL;
4740
4741 return s;
4742}
4743# endif
4744#endif
4745
4746/*
4747 * Get one full line from a sourced file.
4748 * Called by do_cmdline() when it's called from do_source().
4749 *
4750 * Return a pointer to the line in allocated memory.
4751 * Return NULL for end-of-file or some error.
4752 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004754getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755{
4756 struct source_cookie *sp = (struct source_cookie *)cookie;
4757 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004758 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759
4760#ifdef FEAT_EVAL
4761 /* If breakpoints have been added/deleted need to check for it. */
4762 if (sp->dbg_tick < debug_tick)
4763 {
4764 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4765 sp->dbg_tick = debug_tick;
4766 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004767# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004768 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004769 script_line_end();
4770# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771#endif
4772 /*
4773 * Get current line. If there is a read-ahead line, use it, otherwise get
4774 * one now.
4775 */
4776 if (sp->finished)
4777 line = NULL;
4778 else if (sp->nextline == NULL)
4779 line = get_one_sourceline(sp);
4780 else
4781 {
4782 line = sp->nextline;
4783 sp->nextline = NULL;
4784 ++sourcing_lnum;
4785 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004786#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004787 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004788 script_line_start();
4789#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790
4791 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4792 * contain the 'C' flag. */
4793 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4794 {
4795 /* compensate for the one line read-ahead */
4796 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004797
4798 /* Get the next line and concatenate it when it starts with a
4799 * backslash. We always need to read the next line, keep it in
4800 * sp->nextline. */
4801 sp->nextline = get_one_sourceline(sp);
4802 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004803 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004804 garray_T ga;
4805
Bram Moolenaarb549a732012-02-22 18:29:33 +01004806 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004807 ga_concat(&ga, line);
4808 ga_concat(&ga, p + 1);
4809 for (;;)
4810 {
4811 vim_free(sp->nextline);
4812 sp->nextline = get_one_sourceline(sp);
4813 if (sp->nextline == NULL)
4814 break;
4815 p = skipwhite(sp->nextline);
4816 if (*p != '\\')
4817 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004818 /* Adjust the growsize to the current length to speed up
4819 * concatenating many lines. */
4820 if (ga.ga_len > 400)
4821 {
4822 if (ga.ga_len > 8000)
4823 ga.ga_growsize = 8000;
4824 else
4825 ga.ga_growsize = ga.ga_len;
4826 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004827 ga_concat(&ga, p + 1);
4828 }
4829 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004830 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004831 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 }
4833 }
4834
4835#ifdef FEAT_MBYTE
4836 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4837 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004838 char_u *s;
4839
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 /* Convert the encoding of the script line. */
4841 s = string_convert(&sp->conv, line, NULL);
4842 if (s != NULL)
4843 {
4844 vim_free(line);
4845 line = s;
4846 }
4847 }
4848#endif
4849
4850#ifdef FEAT_EVAL
4851 /* Did we encounter a breakpoint? */
4852 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4853 {
4854 dbg_breakpoint(sp->fname, sourcing_lnum);
4855 /* Find next breakpoint. */
4856 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4857 sp->dbg_tick = debug_tick;
4858 }
4859#endif
4860
4861 return line;
4862}
4863
4864 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004865get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004866{
4867 garray_T ga;
4868 int len;
4869 int c;
4870 char_u *buf;
4871#ifdef USE_CRNL
4872 int has_cr; /* CR-LF found */
4873#endif
4874#ifdef USE_CR
4875 char_u *scan;
4876#endif
4877 int have_read = FALSE;
4878
4879 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004880 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881
4882 /*
4883 * Loop until there is a finished line (or end-of-file).
4884 */
4885 sourcing_lnum++;
4886 for (;;)
4887 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004888 /* make room to read at least 120 (more) characters */
4889 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 break;
4891 buf = (char_u *)ga.ga_data;
4892
4893#ifdef USE_CR
4894 if (sp->fileformat == EOL_MAC)
4895 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004896 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4897 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 break;
4899 }
4900 else
4901#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004902 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4903 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004905 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906#ifdef USE_CRNL
4907 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4908 * CTRL-Z by its own, or after a NL. */
4909 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4910 && sp->fileformat == EOL_DOS
4911 && buf[len - 1] == Ctrl_Z)
4912 {
4913 buf[len - 1] = NUL;
4914 break;
4915 }
4916#endif
4917
4918#ifdef USE_CR
4919 /* If the read doesn't stop on a new line, and there's
4920 * some CR then we assume a Mac format */
4921 if (sp->fileformat == EOL_UNKNOWN)
4922 {
4923 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4924 sp->fileformat = EOL_MAC;
4925 else
4926 sp->fileformat = EOL_UNIX;
4927 }
4928
4929 if (sp->fileformat == EOL_MAC)
4930 {
4931 scan = vim_strchr(buf, '\r');
4932
4933 if (scan != NULL)
4934 {
4935 *scan = '\n';
4936 if (*(scan + 1) != 0)
4937 {
4938 *(scan + 1) = 0;
4939 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4940 }
4941 }
4942 len = STRLEN(buf);
4943 }
4944#endif
4945
4946 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 ga.ga_len = len;
4948
4949 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004950 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004951 continue;
4952
4953 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4954 {
4955#ifdef USE_CRNL
4956 has_cr = (len >= 2 && buf[len - 2] == '\r');
4957 if (sp->fileformat == EOL_UNKNOWN)
4958 {
4959 if (has_cr)
4960 sp->fileformat = EOL_DOS;
4961 else
4962 sp->fileformat = EOL_UNIX;
4963 }
4964
4965 if (sp->fileformat == EOL_DOS)
4966 {
4967 if (has_cr) /* replace trailing CR */
4968 {
4969 buf[len - 2] = '\n';
4970 --len;
4971 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004972 }
4973 else /* lines like ":map xx yy^M" will have failed */
4974 {
4975 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004976 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01004977 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004979 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004980 sp->error = TRUE;
4981 sp->fileformat = EOL_UNIX;
4982 }
4983 }
4984#endif
4985 /* The '\n' is escaped if there is an odd number of ^V's just
4986 * before it, first set "c" just before the 'V's and then check
4987 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
4988 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
4989 ;
4990 if ((len & 1) != (c & 1)) /* escaped NL, read more */
4991 {
4992 sourcing_lnum++;
4993 continue;
4994 }
4995
4996 buf[len - 1] = NUL; /* remove the NL */
4997 }
4998
4999 /*
5000 * Check for ^C here now and then, so recursive :so can be broken.
5001 */
5002 line_breakcheck();
5003 break;
5004 }
5005
5006 if (have_read)
5007 return (char_u *)ga.ga_data;
5008
5009 vim_free(ga.ga_data);
5010 return NULL;
5011}
5012
Bram Moolenaar05159a02005-02-26 23:04:13 +00005013#if defined(FEAT_PROFILE) || defined(PROTO)
5014/*
5015 * Called when starting to read a script line.
5016 * "sourcing_lnum" must be correct!
5017 * When skipping lines it may not actually be executed, but we won't find out
5018 * until later and we need to store the time now.
5019 */
5020 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005021script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005022{
5023 scriptitem_T *si;
5024 sn_prl_T *pp;
5025
5026 if (current_SID <= 0 || current_SID > script_items.ga_len)
5027 return;
5028 si = &SCRIPT_ITEM(current_SID);
5029 if (si->sn_prof_on && sourcing_lnum >= 1)
5030 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005031 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00005032 * here isn't counted. */
Bram Moolenaar67435d92017-10-19 21:04:37 +02005033 (void)ga_grow(&si->sn_prl_ga,
5034 (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00005035 si->sn_prl_idx = sourcing_lnum - 1;
5036 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
5037 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
5038 {
5039 /* Zero counters for a line that was not used before. */
5040 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
5041 pp->snp_count = 0;
5042 profile_zero(&pp->sn_prl_total);
5043 profile_zero(&pp->sn_prl_self);
5044 ++si->sn_prl_ga.ga_len;
5045 }
5046 si->sn_prl_execed = FALSE;
5047 profile_start(&si->sn_prl_start);
5048 profile_zero(&si->sn_prl_children);
5049 profile_get_wait(&si->sn_prl_wait);
5050 }
5051}
5052
5053/*
5054 * Called when actually executing a function line.
5055 */
5056 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005057script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005058{
5059 scriptitem_T *si;
5060
5061 if (current_SID <= 0 || current_SID > script_items.ga_len)
5062 return;
5063 si = &SCRIPT_ITEM(current_SID);
5064 if (si->sn_prof_on && si->sn_prl_idx >= 0)
5065 si->sn_prl_execed = TRUE;
5066}
5067
5068/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02005069 * Called when done with a script line.
Bram Moolenaar05159a02005-02-26 23:04:13 +00005070 */
5071 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005072script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005073{
5074 scriptitem_T *si;
5075 sn_prl_T *pp;
5076
5077 if (current_SID <= 0 || current_SID > script_items.ga_len)
5078 return;
5079 si = &SCRIPT_ITEM(current_SID);
5080 if (si->sn_prof_on && si->sn_prl_idx >= 0
5081 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
5082 {
5083 if (si->sn_prl_execed)
5084 {
5085 pp = &PRL_ITEM(si, si->sn_prl_idx);
5086 ++pp->snp_count;
5087 profile_end(&si->sn_prl_start);
5088 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005089 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00005090 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
5091 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005092 }
5093 si->sn_prl_idx = -1;
5094 }
5095}
5096#endif
5097
Bram Moolenaar071d4272004-06-13 20:20:40 +00005098/*
5099 * ":scriptencoding": Set encoding conversion for a sourced script.
5100 * Without the multi-byte feature it's simply ignored.
5101 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005102 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005103ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104{
5105#ifdef FEAT_MBYTE
5106 struct source_cookie *sp;
5107 char_u *name;
5108
5109 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
5110 {
5111 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
5112 return;
5113 }
5114
5115 if (*eap->arg != NUL)
5116 {
5117 name = enc_canonize(eap->arg);
5118 if (name == NULL) /* out of memory */
5119 return;
5120 }
5121 else
5122 name = eap->arg;
5123
5124 /* Setup for conversion from the specified encoding to 'encoding'. */
5125 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
5126 convert_setup(&sp->conv, name, p_enc);
5127
5128 if (name != eap->arg)
5129 vim_free(name);
5130#endif
5131}
5132
5133#if defined(FEAT_EVAL) || defined(PROTO)
5134/*
5135 * ":finish": Mark a sourced file as finished.
5136 */
5137 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005138ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139{
5140 if (getline_equal(eap->getline, eap->cookie, getsourceline))
5141 do_finish(eap, FALSE);
5142 else
5143 EMSG(_("E168: :finish used outside of a sourced file"));
5144}
5145
5146/*
5147 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
5148 * Also called for a pending finish at the ":endtry" or after returning from
5149 * an extra do_cmdline(). "reanimate" is used in the latter case.
5150 */
5151 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005152do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153{
5154 int idx;
5155
5156 if (reanimate)
5157 ((struct source_cookie *)getline_cookie(eap->getline,
5158 eap->cookie))->finished = FALSE;
5159
5160 /*
5161 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5162 * not in its finally clause (which then is to be executed next) is found.
5163 * In this case, make the ":finish" pending for execution at the ":endtry".
5164 * Otherwise, finish normally.
5165 */
5166 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5167 if (idx >= 0)
5168 {
5169 eap->cstack->cs_pending[idx] = CSTP_FINISH;
5170 report_make_pending(CSTP_FINISH, NULL);
5171 }
5172 else
5173 ((struct source_cookie *)getline_cookie(eap->getline,
5174 eap->cookie))->finished = TRUE;
5175}
5176
5177
5178/*
5179 * Return TRUE when a sourced file had the ":finish" command: Don't give error
5180 * message for missing ":endif".
5181 * Return FALSE when not sourcing a file.
5182 */
5183 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005184source_finished(
5185 char_u *(*fgetline)(int, void *, int),
5186 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187{
Bram Moolenaar89d40322006-08-29 15:30:07 +00005188 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005189 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00005190 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191}
5192#endif
5193
5194#if defined(FEAT_LISTCMDS) || defined(PROTO)
5195/*
5196 * ":checktime [buffer]"
5197 */
5198 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005199ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200{
5201 buf_T *buf;
5202 int save_no_check_timestamps = no_check_timestamps;
5203
5204 no_check_timestamps = 0;
5205 if (eap->addr_count == 0) /* default is all buffers */
5206 check_timestamps(FALSE);
5207 else
5208 {
5209 buf = buflist_findnr((int)eap->line2);
5210 if (buf != NULL) /* cannot happen? */
5211 (void)buf_check_timestamp(buf, FALSE);
5212 }
5213 no_check_timestamps = save_no_check_timestamps;
5214}
5215#endif
5216
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5218 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005219# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005220static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005222 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005223get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005225 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226
Bram Moolenaar48e330a2016-02-23 14:53:34 +01005227 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005228 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005230# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 if (loc != NULL)
5232 {
5233 char_u *p;
5234
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005235 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
5236 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 p = vim_strchr(loc, '=');
5238 if (p != NULL)
5239 {
5240 loc = ++p;
5241 while (*p != NUL) /* remove trailing newline */
5242 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005243 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 {
5245 *p = NUL;
5246 break;
5247 }
5248 ++p;
5249 }
5250 }
5251 }
5252# endif
5253
5254 return loc;
5255}
5256#endif
5257
5258
5259#ifdef WIN32
5260/*
5261 * On MS-Windows locale names are strings like "German_Germany.1252", but
5262 * gettext expects "de". Try to translate one into another here for a few
5263 * supported languages.
5264 */
5265 static char_u *
5266gettext_lang(char_u *name)
5267{
5268 int i;
5269 static char *(mtable[]) = {
5270 "afrikaans", "af",
5271 "czech", "cs",
5272 "dutch", "nl",
5273 "german", "de",
5274 "english_united kingdom", "en_GB",
5275 "spanish", "es",
5276 "french", "fr",
5277 "italian", "it",
5278 "japanese", "ja",
5279 "korean", "ko",
5280 "norwegian", "no",
5281 "polish", "pl",
5282 "russian", "ru",
5283 "slovak", "sk",
5284 "swedish", "sv",
5285 "ukrainian", "uk",
5286 "chinese_china", "zh_CN",
5287 "chinese_taiwan", "zh_TW",
5288 NULL};
5289
5290 for (i = 0; mtable[i] != NULL; i += 2)
5291 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005292 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 return name;
5294}
5295#endif
5296
5297#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5298/*
5299 * Obtain the current messages language. Used to set the default for
5300 * 'helplang'. May return NULL or an empty string.
5301 */
5302 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005303get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005304{
5305 char_u *p;
5306
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005307# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005308# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005309 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310# else
5311 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005312 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
5313 * and LC_MONETARY may be set differently for a Japanese working in the
5314 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005315 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316# endif
5317# else
5318 p = mch_getenv((char_u *)"LC_ALL");
5319 if (p == NULL || *p == NUL)
5320 {
5321 p = mch_getenv((char_u *)"LC_MESSAGES");
5322 if (p == NULL || *p == NUL)
5323 p = mch_getenv((char_u *)"LANG");
5324 }
5325# endif
5326# ifdef WIN32
5327 p = gettext_lang(p);
5328# endif
5329 return p;
5330}
5331#endif
5332
Bram Moolenaardef9e822004-12-31 20:58:58 +00005333/* Complicated #if; matches with where get_mess_env() is used below. */
5334#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5335 && defined(LC_MESSAGES))) \
5336 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5337 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
5338 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01005339static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340
5341/*
5342 * Get the language used for messages from the environment.
5343 */
5344 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005345get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005346{
5347 char_u *p;
5348
5349 p = mch_getenv((char_u *)"LC_ALL");
5350 if (p == NULL || *p == NUL)
5351 {
5352 p = mch_getenv((char_u *)"LC_MESSAGES");
5353 if (p == NULL || *p == NUL)
5354 {
5355 p = mch_getenv((char_u *)"LANG");
5356 if (p != NULL && VIM_ISDIGIT(*p))
5357 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005358# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005359 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005360 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005361# endif
5362 }
5363 }
5364 return p;
5365}
5366#endif
5367
5368#if defined(FEAT_EVAL) || defined(PROTO)
5369
5370/*
5371 * Set the "v:lang" variable according to the current locale setting.
5372 * Also do "v:lc_time"and "v:ctype".
5373 */
5374 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005375set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376{
5377 char_u *loc;
5378
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005379# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005380 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005381# else
5382 /* setlocale() not supported: use the default value */
5383 loc = (char_u *)"C";
5384# endif
5385 set_vim_var_string(VV_CTYPE, loc, -1);
5386
5387 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
5388 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005389# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005390 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391# else
5392 loc = get_mess_env();
5393# endif
5394 set_vim_var_string(VV_LANG, loc, -1);
5395
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005396# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005397 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398# endif
5399 set_vim_var_string(VV_LC_TIME, loc, -1);
5400}
5401#endif
5402
5403#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5404 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
5405/*
5406 * ":language": Set the language (locale).
5407 */
5408 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005409ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410{
5411 char *loc;
5412 char_u *p;
5413 char_u *name;
5414 int what = LC_ALL;
5415 char *whatstr = "";
5416#ifdef LC_MESSAGES
5417# define VIM_LC_MESSAGES LC_MESSAGES
5418#else
5419# define VIM_LC_MESSAGES 6789
5420#endif
5421
5422 name = eap->arg;
5423
5424 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
5425 * Allow abbreviation, but require at least 3 characters to avoid
5426 * confusion with a two letter language name "me" or "ct". */
5427 p = skiptowhite(eap->arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005428 if ((*p == NUL || VIM_ISWHITE(*p)) && p - eap->arg >= 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 {
5430 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
5431 {
5432 what = VIM_LC_MESSAGES;
5433 name = skipwhite(p);
5434 whatstr = "messages ";
5435 }
5436 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
5437 {
5438 what = LC_CTYPE;
5439 name = skipwhite(p);
5440 whatstr = "ctype ";
5441 }
5442 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
5443 {
5444 what = LC_TIME;
5445 name = skipwhite(p);
5446 whatstr = "time ";
5447 }
5448 }
5449
5450 if (*name == NUL)
5451 {
5452#ifndef LC_MESSAGES
5453 if (what == VIM_LC_MESSAGES)
5454 p = get_mess_env();
5455 else
5456#endif
5457 p = (char_u *)setlocale(what, NULL);
5458 if (p == NULL || *p == NUL)
5459 p = (char_u *)"Unknown";
5460 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
5461 }
5462 else
5463 {
5464#ifndef LC_MESSAGES
5465 if (what == VIM_LC_MESSAGES)
5466 loc = "";
5467 else
5468#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005469 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005471#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
5472 /* Make sure strtod() uses a decimal point, not a comma. */
5473 setlocale(LC_NUMERIC, "C");
5474#endif
5475 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 if (loc == NULL)
5477 EMSG2(_("E197: Cannot set language to \"%s\""), name);
5478 else
5479 {
5480#ifdef HAVE_NL_MSG_CAT_CNTR
5481 /* Need to do this for GNU gettext, otherwise cached translations
5482 * will be used again. */
5483 extern int _nl_msg_cat_cntr;
5484
5485 ++_nl_msg_cat_cntr;
5486#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00005487 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
5489
5490 if (what != LC_TIME)
5491 {
5492 /* Tell gettext() what to translate to. It apparently doesn't
5493 * use the currently effective locale. Also do this when
5494 * FEAT_GETTEXT isn't defined, so that shell commands use this
5495 * value. */
5496 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005497 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005498 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02005499
5500 /* Clear $LANGUAGE because GNU gettext uses it. */
5501 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005502# ifdef WIN32
5503 /* Apparently MS-Windows printf() may cause a crash when
5504 * we give it 8-bit text while it's expecting text in the
5505 * current locale. This call avoids that. */
5506 setlocale(LC_CTYPE, "C");
5507# endif
5508 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 if (what != LC_CTYPE)
5510 {
5511 char_u *mname;
5512#ifdef WIN32
5513 mname = gettext_lang(name);
5514#else
5515 mname = name;
5516#endif
5517 vim_setenv((char_u *)"LC_MESSAGES", mname);
5518#ifdef FEAT_MULTI_LANG
5519 set_helplang_default(mname);
5520#endif
5521 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005522 }
5523
5524# ifdef FEAT_EVAL
5525 /* Set v:lang, v:lc_time and v:ctype to the final result. */
5526 set_lang_var();
5527# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02005528# ifdef FEAT_TITLE
5529 maketitle();
5530# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 }
5532 }
5533}
5534
5535# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005536
5537static char_u **locales = NULL; /* Array of all available locales */
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005538
5539# ifndef WIN32
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005540static int did_init_locales = FALSE;
5541
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005542/* Return an array of strings for all available locales + NULL for the
5543 * last element. Return NULL in case of error. */
5544 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005545find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005546{
5547 garray_T locales_ga;
5548 char_u *loc;
5549
5550 /* Find all available locales by running command "locale -a". If this
5551 * doesn't work we won't have completion. */
5552 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02005553 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005554 if (locale_a == NULL)
5555 return NULL;
5556 ga_init2(&locales_ga, sizeof(char_u *), 20);
5557
5558 /* Transform locale_a string where each locale is separated by "\n"
5559 * into an array of locale strings. */
5560 loc = (char_u *)strtok((char *)locale_a, "\n");
5561
5562 while (loc != NULL)
5563 {
5564 if (ga_grow(&locales_ga, 1) == FAIL)
5565 break;
5566 loc = vim_strsave(loc);
5567 if (loc == NULL)
5568 break;
5569
5570 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5571 loc = (char_u *)strtok(NULL, "\n");
5572 }
5573 vim_free(locale_a);
5574 if (ga_grow(&locales_ga, 1) == FAIL)
5575 {
5576 ga_clear(&locales_ga);
5577 return NULL;
5578 }
5579 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5580 return (char_u **)locales_ga.ga_data;
5581}
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005582# endif
5583
5584/*
5585 * Lazy initialization of all available locales.
5586 */
5587 static void
5588init_locales(void)
5589{
5590# ifndef WIN32
5591 if (!did_init_locales)
5592 {
5593 did_init_locales = TRUE;
5594 locales = find_locales();
5595 }
5596# endif
5597}
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005598
5599# if defined(EXITFREE) || defined(PROTO)
5600 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005601free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005602{
5603 int i;
5604 if (locales != NULL)
5605 {
5606 for (i = 0; locales[i] != NULL; i++)
5607 vim_free(locales[i]);
Bram Moolenaard23a8232018-02-10 18:45:26 +01005608 VIM_CLEAR(locales);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005609 }
5610}
5611# endif
5612
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613/*
5614 * Function given to ExpandGeneric() to obtain the possible arguments of the
5615 * ":language" command.
5616 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005617 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005618get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619{
5620 if (idx == 0)
5621 return (char_u *)"messages";
5622 if (idx == 1)
5623 return (char_u *)"ctype";
5624 if (idx == 2)
5625 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005626
5627 init_locales();
5628 if (locales == NULL)
5629 return NULL;
5630 return locales[idx - 3];
5631}
5632
5633/*
5634 * Function given to ExpandGeneric() to obtain the available locales.
5635 */
5636 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005637get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005638{
5639 init_locales();
5640 if (locales == NULL)
5641 return NULL;
5642 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005643}
5644# endif
5645
5646#endif