blob: 6476d55169bd9d4156f989255d0679ce84a602cc [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 {
Bram Moolenaar31988702018-02-13 12:57:42 +0100991 if (typval_compare(tv, bp->dbg_val, TYPE_EQUAL,
992 TRUE, FALSE) == OK
993 && tv->vval.v_number == FALSE)
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100994 {
Bram Moolenaar31988702018-02-13 12:57:42 +0100995 typval_T *v;
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100996
Bram Moolenaar31988702018-02-13 12:57:42 +0100997 line = TRUE;
998 debug_oldval = typval_tostring(bp->dbg_val);
999 /* Need to evaluate again, typval_compare() overwrites
1000 * "tv". */
1001 v = eval_expr(bp->dbg_name, NULL);
1002 debug_newval = typval_tostring(v);
1003 free_tv(bp->dbg_val);
1004 bp->dbg_val = v;
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01001005 }
1006 free_tv(tv);
1007 }
1008 }
1009 else if (bp->dbg_val != NULL)
1010 {
1011 debug_oldval = typval_tostring(bp->dbg_val);
1012 debug_newval = typval_tostring(NULL);
1013 free_tv(bp->dbg_val);
1014 bp->dbg_val = NULL;
1015 line = TRUE;
1016 }
1017
1018 if (line)
1019 {
1020 lnum = after > 0 ? after : 1;
1021 break;
1022 }
1023
1024 got_int |= prev_got_int;
1025 }
1026#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027 }
1028 if (name != fname)
1029 vim_free(name);
1030
1031 return lnum;
1032}
1033
1034/*
1035 * Called when a breakpoint was encountered.
1036 */
1037 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001038dbg_breakpoint(char_u *name, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039{
1040 /* We need to check if this line is actually executed in do_one_cmd() */
1041 debug_breakpoint_name = name;
1042 debug_breakpoint_lnum = lnum;
1043}
Bram Moolenaar05159a02005-02-26 23:04:13 +00001044
1045
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001046# if defined(FEAT_PROFILE) || defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001047/*
1048 * Store the current time in "tm".
1049 */
1050 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001051profile_start(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001052{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001053# ifdef WIN3264
1054 QueryPerformanceCounter(tm);
1055# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001056 gettimeofday(tm, NULL);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001057# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001058}
1059
1060/*
1061 * Compute the elapsed time from "tm" till now and store in "tm".
1062 */
1063 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001064profile_end(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001065{
1066 proftime_T now;
1067
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001068# ifdef WIN3264
1069 QueryPerformanceCounter(&now);
1070 tm->QuadPart = now.QuadPart - tm->QuadPart;
1071# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001072 gettimeofday(&now, NULL);
1073 tm->tv_usec = now.tv_usec - tm->tv_usec;
1074 tm->tv_sec = now.tv_sec - tm->tv_sec;
1075 if (tm->tv_usec < 0)
1076 {
1077 tm->tv_usec += 1000000;
1078 --tm->tv_sec;
1079 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001080# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001081}
1082
1083/*
1084 * Subtract the time "tm2" from "tm".
1085 */
1086 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001087profile_sub(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001088{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001089# ifdef WIN3264
1090 tm->QuadPart -= tm2->QuadPart;
1091# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001092 tm->tv_usec -= tm2->tv_usec;
1093 tm->tv_sec -= tm2->tv_sec;
1094 if (tm->tv_usec < 0)
1095 {
1096 tm->tv_usec += 1000000;
1097 --tm->tv_sec;
1098 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001099# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001100}
1101
1102/*
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001103 * Return a string that represents the time in "tm".
1104 * Uses a static buffer!
1105 */
1106 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001107profile_msg(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001108{
1109 static char buf[50];
1110
1111# ifdef WIN3264
1112 LARGE_INTEGER fr;
1113
1114 QueryPerformanceFrequency(&fr);
1115 sprintf(buf, "%10.6lf", (double)tm->QuadPart / (double)fr.QuadPart);
1116# else
1117 sprintf(buf, "%3ld.%06ld", (long)tm->tv_sec, (long)tm->tv_usec);
Bram Moolenaar76929292008-01-06 19:07:36 +00001118# endif
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001119 return buf;
1120}
1121
Bram Moolenaar79c2c882016-02-07 21:19:28 +01001122# if defined(FEAT_FLOAT) || defined(PROTO)
1123/*
1124 * Return a float that represents the time in "tm".
1125 */
1126 float_T
1127profile_float(proftime_T *tm)
1128{
1129# ifdef WIN3264
1130 LARGE_INTEGER fr;
1131
1132 QueryPerformanceFrequency(&fr);
1133 return (float_T)tm->QuadPart / (float_T)fr.QuadPart;
1134# else
1135 return (float_T)tm->tv_sec + (float_T)tm->tv_usec / 1000000.0;
1136# endif
1137}
1138# endif
1139
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001140/*
Bram Moolenaar76929292008-01-06 19:07:36 +00001141 * Put the time "msec" past now in "tm".
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001142 */
Bram Moolenaar76929292008-01-06 19:07:36 +00001143 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001144profile_setlimit(long msec, proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001145{
1146 if (msec <= 0) /* no limit */
1147 profile_zero(tm);
1148 else
1149 {
1150# ifdef WIN3264
1151 LARGE_INTEGER fr;
1152
1153 QueryPerformanceCounter(tm);
1154 QueryPerformanceFrequency(&fr);
Bram Moolenaarb3c70982008-01-18 10:40:55 +00001155 tm->QuadPart += (LONGLONG)((double)msec / 1000.0 * (double)fr.QuadPart);
Bram Moolenaar76929292008-01-06 19:07:36 +00001156# else
1157 long usec;
1158
1159 gettimeofday(tm, NULL);
1160 usec = (long)tm->tv_usec + (long)msec * 1000;
1161 tm->tv_usec = usec % 1000000L;
1162 tm->tv_sec += usec / 1000000L;
1163# endif
1164 }
1165}
1166
1167/*
1168 * Return TRUE if the current time is past "tm".
1169 */
1170 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001171profile_passed_limit(proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001172{
1173 proftime_T now;
1174
1175# ifdef WIN3264
1176 if (tm->QuadPart == 0) /* timer was not set */
1177 return FALSE;
1178 QueryPerformanceCounter(&now);
1179 return (now.QuadPart > tm->QuadPart);
1180# else
1181 if (tm->tv_sec == 0) /* timer was not set */
1182 return FALSE;
1183 gettimeofday(&now, NULL);
1184 return (now.tv_sec > tm->tv_sec
1185 || (now.tv_sec == tm->tv_sec && now.tv_usec > tm->tv_usec));
1186# endif
1187}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001188
1189/*
1190 * Set the time in "tm" to zero.
1191 */
1192 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001193profile_zero(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001194{
1195# ifdef WIN3264
1196 tm->QuadPart = 0;
1197# else
1198 tm->tv_usec = 0;
1199 tm->tv_sec = 0;
1200# endif
1201}
1202
Bram Moolenaar76929292008-01-06 19:07:36 +00001203# endif /* FEAT_PROFILE || FEAT_RELTIME */
1204
Bram Moolenaar975b5272016-03-15 23:10:59 +01001205# if defined(FEAT_TIMERS) || defined(PROTO)
1206static timer_T *first_timer = NULL;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001207static long last_timer_id = 0;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001208
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001209 static long
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001210proftime_time_left(proftime_T *due, proftime_T *now)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001211{
1212# ifdef WIN3264
1213 LARGE_INTEGER fr;
1214
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001215 if (now->QuadPart > due->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001216 return 0;
1217 QueryPerformanceFrequency(&fr);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001218 return (long)(((double)(due->QuadPart - now->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001219 / (double)fr.QuadPart) * 1000);
1220# else
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001221 if (now->tv_sec > due->tv_sec)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001222 return 0;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001223 return (due->tv_sec - now->tv_sec) * 1000
1224 + (due->tv_usec - now->tv_usec) / 1000;
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001225# endif
1226}
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001227
Bram Moolenaar975b5272016-03-15 23:10:59 +01001228/*
1229 * Insert a timer in the list of timers.
1230 */
1231 static void
1232insert_timer(timer_T *timer)
1233{
1234 timer->tr_next = first_timer;
1235 timer->tr_prev = NULL;
1236 if (first_timer != NULL)
1237 first_timer->tr_prev = timer;
1238 first_timer = timer;
Bram Moolenaar4231da42016-06-02 14:30:04 +02001239 did_add_timer = TRUE;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001240}
1241
1242/*
1243 * Take a timer out of the list of timers.
1244 */
1245 static void
1246remove_timer(timer_T *timer)
1247{
1248 if (timer->tr_prev == NULL)
1249 first_timer = timer->tr_next;
1250 else
1251 timer->tr_prev->tr_next = timer->tr_next;
1252 if (timer->tr_next != NULL)
1253 timer->tr_next->tr_prev = timer->tr_prev;
1254}
1255
1256 static void
1257free_timer(timer_T *timer)
1258{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001259 free_callback(timer->tr_callback, timer->tr_partial);
1260 vim_free(timer);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001261}
1262
1263/*
1264 * Create a timer and return it. NULL if out of memory.
1265 * Caller should set the callback.
1266 */
1267 timer_T *
1268create_timer(long msec, int repeat)
1269{
1270 timer_T *timer = (timer_T *)alloc_clear(sizeof(timer_T));
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001271 long prev_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001272
1273 if (timer == NULL)
1274 return NULL;
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001275 if (++last_timer_id <= prev_id)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001276 /* Overflow! Might cause duplicates... */
1277 last_timer_id = 0;
1278 timer->tr_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001279 insert_timer(timer);
1280 if (repeat != 0)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001281 timer->tr_repeat = repeat - 1;
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001282 timer->tr_interval = msec;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001283
1284 profile_setlimit(msec, &timer->tr_due);
1285 return timer;
1286}
1287
1288/*
1289 * Invoke the callback of "timer".
1290 */
1291 static void
1292timer_callback(timer_T *timer)
1293{
1294 typval_T rettv;
1295 int dummy;
1296 typval_T argv[2];
1297
1298 argv[0].v_type = VAR_NUMBER;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001299 argv[0].vval.v_number = (varnumber_T)timer->tr_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001300 argv[1].v_type = VAR_UNKNOWN;
1301
1302 call_func(timer->tr_callback, (int)STRLEN(timer->tr_callback),
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001303 &rettv, 1, argv, NULL, 0L, 0L, &dummy, TRUE,
Bram Moolenaar975b5272016-03-15 23:10:59 +01001304 timer->tr_partial, NULL);
1305 clear_tv(&rettv);
1306}
1307
1308/*
1309 * Call timers that are due.
1310 * Return the time in msec until the next timer is due.
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001311 * Returns -1 if there are no pending timers.
Bram Moolenaar975b5272016-03-15 23:10:59 +01001312 */
1313 long
Bram Moolenaarcf089462016-06-12 21:18:43 +02001314check_due_timer(void)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001315{
1316 timer_T *timer;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001317 timer_T *timer_next;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001318 long this_due;
Bram Moolenaar597385a2016-03-16 23:24:43 +01001319 long next_due = -1;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001320 proftime_T now;
1321 int did_one = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001322 int need_update_screen = FALSE;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001323 long current_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001324
Bram Moolenaarc577d812017-07-08 22:37:34 +02001325 /* Don't run any timers while exiting or dealing with an error. */
1326 if (exiting || aborting())
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001327 return next_due;
1328
Bram Moolenaar75537a92016-09-05 22:45:28 +02001329 profile_start(&now);
1330 for (timer = first_timer; timer != NULL && !got_int; timer = timer_next)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001331 {
Bram Moolenaar75537a92016-09-05 22:45:28 +02001332 timer_next = timer->tr_next;
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001333
Bram Moolenaar75537a92016-09-05 22:45:28 +02001334 if (timer->tr_id == -1 || timer->tr_firing || timer->tr_paused)
1335 continue;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001336 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001337 if (this_due <= 1)
1338 {
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001339 int save_timer_busy = timer_busy;
1340 int save_vgetc_busy = vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001341 int save_did_emsg = did_emsg;
1342 int save_called_emsg = called_emsg;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001343 int save_must_redraw = must_redraw;
Bram Moolenaare723c422017-09-06 23:40:10 +02001344 int save_trylevel = trylevel;
1345 int save_did_throw = did_throw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001346 int save_ex_pressedreturn = get_pressedreturn();
Bram Moolenaare723c422017-09-06 23:40:10 +02001347 except_T *save_current_exception = current_exception;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001348
Bram Moolenaare723c422017-09-06 23:40:10 +02001349 /* Create a scope for running the timer callback, ignoring most of
1350 * the current scope, such as being inside a try/catch. */
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001351 timer_busy = timer_busy > 0 || vgetc_busy > 0;
1352 vgetc_busy = 0;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001353 called_emsg = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001354 did_emsg = FALSE;
1355 did_uncaught_emsg = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001356 must_redraw = 0;
Bram Moolenaare723c422017-09-06 23:40:10 +02001357 trylevel = 0;
1358 did_throw = FALSE;
1359 current_exception = NULL;
1360
Bram Moolenaar75537a92016-09-05 22:45:28 +02001361 timer->tr_firing = TRUE;
1362 timer_callback(timer);
1363 timer->tr_firing = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001364
Bram Moolenaar75537a92016-09-05 22:45:28 +02001365 timer_next = timer->tr_next;
1366 did_one = TRUE;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001367 timer_busy = save_timer_busy;
1368 vgetc_busy = save_vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001369 if (did_uncaught_emsg)
Bram Moolenaarc577d812017-07-08 22:37:34 +02001370 ++timer->tr_emsg_count;
Bram Moolenaare723c422017-09-06 23:40:10 +02001371 did_emsg = save_did_emsg;
1372 called_emsg = save_called_emsg;
1373 trylevel = save_trylevel;
1374 did_throw = save_did_throw;
1375 current_exception = save_current_exception;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001376 if (must_redraw != 0)
1377 need_update_screen = TRUE;
1378 must_redraw = must_redraw > save_must_redraw
1379 ? must_redraw : save_must_redraw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001380 set_pressedreturn(save_ex_pressedreturn);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001381
1382 /* Only fire the timer again if it repeats and stop_timer() wasn't
1383 * called while inside the callback (tr_id == -1). */
Bram Moolenaarc577d812017-07-08 22:37:34 +02001384 if (timer->tr_repeat != 0 && timer->tr_id != -1
1385 && timer->tr_emsg_count < 3)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001386 {
1387 profile_setlimit(timer->tr_interval, &timer->tr_due);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001388 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001389 if (this_due < 1)
1390 this_due = 1;
1391 if (timer->tr_repeat > 0)
1392 --timer->tr_repeat;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001393 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001394 else
1395 {
1396 this_due = -1;
1397 remove_timer(timer);
1398 free_timer(timer);
1399 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001400 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001401 if (this_due > 0 && (next_due == -1 || next_due > this_due))
1402 next_due = this_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001403 }
1404
1405 if (did_one)
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001406 redraw_after_callback(need_update_screen);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001407
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01001408#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001409 if (bevalexpr_due_set)
1410 {
1411 this_due = proftime_time_left(&bevalexpr_due, &now);
1412 if (this_due <= 1)
1413 {
1414 bevalexpr_due_set = FALSE;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001415 if (balloonEval == NULL)
1416 {
1417 balloonEval = (BalloonEval *)alloc(sizeof(BalloonEval));
1418 balloonEvalForTerm = TRUE;
1419 }
1420 if (balloonEval != NULL)
1421 general_beval_cb(balloonEval, 0);
1422 }
1423 else if (this_due > 0 && (next_due == -1 || next_due > this_due))
1424 next_due = this_due;
1425 }
1426#endif
1427
Bram Moolenaar75537a92016-09-05 22:45:28 +02001428 return current_id != last_timer_id ? 1 : next_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001429}
1430
1431/*
1432 * Find a timer by ID. Returns NULL if not found;
1433 */
1434 timer_T *
Bram Moolenaar75537a92016-09-05 22:45:28 +02001435find_timer(long id)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001436{
1437 timer_T *timer;
1438
Bram Moolenaar75537a92016-09-05 22:45:28 +02001439 if (id >= 0)
1440 {
1441 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1442 if (timer->tr_id == id)
1443 return timer;
1444 }
1445 return NULL;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001446}
1447
1448
1449/*
1450 * Stop a timer and delete it.
1451 */
1452 void
1453stop_timer(timer_T *timer)
1454{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001455 if (timer->tr_firing)
1456 /* Free the timer after the callback returns. */
1457 timer->tr_id = -1;
1458 else
1459 {
1460 remove_timer(timer);
1461 free_timer(timer);
1462 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001463}
Bram Moolenaare3188e22016-05-31 21:13:04 +02001464
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001465 void
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001466stop_all_timers(void)
1467{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001468 timer_T *timer;
1469 timer_T *timer_next;
1470
1471 for (timer = first_timer; timer != NULL; timer = timer_next)
1472 {
1473 timer_next = timer->tr_next;
1474 stop_timer(timer);
1475 }
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001476}
1477
1478 void
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001479add_timer_info(typval_T *rettv, timer_T *timer)
1480{
1481 list_T *list = rettv->vval.v_list;
1482 dict_T *dict = dict_alloc();
1483 dictitem_T *di;
1484 long remaining;
1485 proftime_T now;
1486
1487 if (dict == NULL)
1488 return;
1489 list_append_dict(list, dict);
1490
Bram Moolenaar75537a92016-09-05 22:45:28 +02001491 dict_add_nr_str(dict, "id", timer->tr_id, NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001492 dict_add_nr_str(dict, "time", (long)timer->tr_interval, NULL);
1493
1494 profile_start(&now);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001495 remaining = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001496 dict_add_nr_str(dict, "remaining", (long)remaining, NULL);
1497
1498 dict_add_nr_str(dict, "repeat",
1499 (long)(timer->tr_repeat < 0 ? -1 : timer->tr_repeat + 1), NULL);
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001500 dict_add_nr_str(dict, "paused", (long)(timer->tr_paused), NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001501
1502 di = dictitem_alloc((char_u *)"callback");
1503 if (di != NULL)
1504 {
1505 if (dict_add(dict, di) == FAIL)
1506 vim_free(di);
1507 else if (timer->tr_partial != NULL)
1508 {
1509 di->di_tv.v_type = VAR_PARTIAL;
1510 di->di_tv.vval.v_partial = timer->tr_partial;
1511 ++timer->tr_partial->pt_refcount;
1512 }
1513 else
1514 {
1515 di->di_tv.v_type = VAR_FUNC;
1516 di->di_tv.vval.v_string = vim_strsave(timer->tr_callback);
1517 }
1518 di->di_tv.v_lock = 0;
1519 }
1520}
1521
1522 void
1523add_timer_info_all(typval_T *rettv)
1524{
1525 timer_T *timer;
1526
1527 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001528 if (timer->tr_id != -1)
1529 add_timer_info(rettv, timer);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001530}
1531
Bram Moolenaare3188e22016-05-31 21:13:04 +02001532/*
1533 * Mark references in partials of timers.
1534 */
1535 int
1536set_ref_in_timer(int copyID)
1537{
1538 int abort = FALSE;
1539 timer_T *timer;
1540 typval_T tv;
1541
1542 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1543 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001544 if (timer->tr_partial != NULL)
1545 {
1546 tv.v_type = VAR_PARTIAL;
1547 tv.vval.v_partial = timer->tr_partial;
1548 }
1549 else
1550 {
1551 tv.v_type = VAR_FUNC;
1552 tv.vval.v_string = timer->tr_callback;
1553 }
Bram Moolenaare3188e22016-05-31 21:13:04 +02001554 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
1555 }
1556 return abort;
1557}
Bram Moolenaar623e2632016-07-30 22:47:56 +02001558
1559# if defined(EXITFREE) || defined(PROTO)
1560 void
1561timer_free_all()
1562{
1563 timer_T *timer;
1564
1565 while (first_timer != NULL)
1566 {
1567 timer = first_timer;
1568 remove_timer(timer);
1569 free_timer(timer);
1570 }
1571}
1572# endif
Bram Moolenaar975b5272016-03-15 23:10:59 +01001573# endif
1574
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001575#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1576# if defined(HAVE_MATH_H)
1577# include <math.h>
1578# endif
1579
1580/*
1581 * Divide the time "tm" by "count" and store in "tm2".
1582 */
1583 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001584profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001585{
1586 if (count == 0)
1587 profile_zero(tm2);
1588 else
1589 {
1590# ifdef WIN3264
1591 tm2->QuadPart = tm->QuadPart / count;
1592# else
1593 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1594
1595 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001596 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001597# endif
1598 }
1599}
1600#endif
1601
Bram Moolenaar76929292008-01-06 19:07:36 +00001602# if defined(FEAT_PROFILE) || defined(PROTO)
1603/*
1604 * Functions for profiling.
1605 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001606static void script_do_profile(scriptitem_T *si);
1607static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001608static proftime_T prof_wait_time;
1609
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001610/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001611 * Add the time "tm2" to "tm".
1612 */
1613 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001614profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001615{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001616# ifdef WIN3264
1617 tm->QuadPart += tm2->QuadPart;
1618# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001619 tm->tv_usec += tm2->tv_usec;
1620 tm->tv_sec += tm2->tv_sec;
1621 if (tm->tv_usec >= 1000000)
1622 {
1623 tm->tv_usec -= 1000000;
1624 ++tm->tv_sec;
1625 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001626# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001627}
1628
1629/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001630 * Add the "self" time from the total time and the children's time.
1631 */
1632 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001633profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001634{
1635 /* Check that the result won't be negative. Can happen with recursive
1636 * calls. */
1637#ifdef WIN3264
1638 if (total->QuadPart <= children->QuadPart)
1639 return;
1640#else
1641 if (total->tv_sec < children->tv_sec
1642 || (total->tv_sec == children->tv_sec
1643 && total->tv_usec <= children->tv_usec))
1644 return;
1645#endif
1646 profile_add(self, total);
1647 profile_sub(self, children);
1648}
1649
1650/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001651 * Get the current waittime.
1652 */
1653 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001654profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001655{
1656 *tm = prof_wait_time;
1657}
1658
1659/*
1660 * Subtract the passed waittime since "tm" from "tma".
1661 */
1662 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001663profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001664{
1665 proftime_T tm3 = prof_wait_time;
1666
1667 profile_sub(&tm3, tm);
1668 profile_sub(tma, &tm3);
1669}
1670
1671/*
1672 * Return TRUE if "tm1" and "tm2" are equal.
1673 */
1674 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001675profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001676{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001677# ifdef WIN3264
1678 return (tm1->QuadPart == tm2->QuadPart);
1679# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001680 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001681# endif
1682}
1683
1684/*
1685 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1686 */
1687 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001688profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001689{
1690# ifdef WIN3264
1691 return (int)(tm2->QuadPart - tm1->QuadPart);
1692# else
1693 if (tm1->tv_sec == tm2->tv_sec)
1694 return tm2->tv_usec - tm1->tv_usec;
1695 return tm2->tv_sec - tm1->tv_sec;
1696# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001697}
1698
Bram Moolenaar05159a02005-02-26 23:04:13 +00001699static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001700static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001701
1702/*
1703 * ":profile cmd args"
1704 */
1705 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001706ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001707{
1708 char_u *e;
1709 int len;
1710
1711 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001712 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001713 e = skipwhite(e);
1714
1715 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1716 {
1717 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001718 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001719 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001720 profile_zero(&prof_wait_time);
1721 set_vim_var_nr(VV_PROFILING, 1L);
1722 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001723 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001724 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001725 else if (STRCMP(eap->arg, "pause") == 0)
1726 {
1727 if (do_profiling == PROF_YES)
1728 profile_start(&pause_time);
1729 do_profiling = PROF_PAUSED;
1730 }
1731 else if (STRCMP(eap->arg, "continue") == 0)
1732 {
1733 if (do_profiling == PROF_PAUSED)
1734 {
1735 profile_end(&pause_time);
1736 profile_add(&prof_wait_time, &pause_time);
1737 }
1738 do_profiling = PROF_YES;
1739 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001740 else
1741 {
1742 /* The rest is similar to ":breakadd". */
1743 ex_breakadd(eap);
1744 }
1745}
1746
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001747/* Command line expansion for :profile. */
1748static enum
1749{
1750 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001751 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001752} pexpand_what;
1753
1754static char *pexpand_cmds[] = {
1755 "start",
1756#define PROFCMD_START 0
1757 "pause",
1758#define PROFCMD_PAUSE 1
1759 "continue",
1760#define PROFCMD_CONTINUE 2
1761 "func",
1762#define PROFCMD_FUNC 3
1763 "file",
1764#define PROFCMD_FILE 4
1765 NULL
1766#define PROFCMD_LAST 5
1767};
1768
1769/*
1770 * Function given to ExpandGeneric() to obtain the profile command
1771 * specific expansion.
1772 */
1773 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001774get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001775{
1776 switch (pexpand_what)
1777 {
1778 case PEXP_SUBCMD:
1779 return (char_u *)pexpand_cmds[idx];
1780 /* case PEXP_FUNC: TODO */
1781 default:
1782 return NULL;
1783 }
1784}
1785
1786/*
1787 * Handle command line completion for :profile command.
1788 */
1789 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001790set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001791{
1792 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001793
1794 /* Default: expand subcommands. */
1795 xp->xp_context = EXPAND_PROFILE;
1796 pexpand_what = PEXP_SUBCMD;
1797 xp->xp_pattern = arg;
1798
1799 end_subcmd = skiptowhite(arg);
1800 if (*end_subcmd == NUL)
1801 return;
1802
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001803 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001804 {
1805 xp->xp_context = EXPAND_FILES;
1806 xp->xp_pattern = skipwhite(end_subcmd);
1807 return;
1808 }
1809
1810 /* TODO: expand function names after "func" */
1811 xp->xp_context = EXPAND_NOTHING;
1812}
1813
Bram Moolenaar05159a02005-02-26 23:04:13 +00001814/*
1815 * Dump the profiling info.
1816 */
1817 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001818profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001819{
1820 FILE *fd;
1821
1822 if (profile_fname != NULL)
1823 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001824 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001825 if (fd == NULL)
1826 EMSG2(_(e_notopen), profile_fname);
1827 else
1828 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001829 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001830 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001831 fclose(fd);
1832 }
1833 }
1834}
1835
1836/*
1837 * Start profiling script "fp".
1838 */
1839 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001840script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001841{
1842 si->sn_pr_count = 0;
1843 profile_zero(&si->sn_pr_total);
1844 profile_zero(&si->sn_pr_self);
1845
1846 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1847 si->sn_prl_idx = -1;
1848 si->sn_prof_on = TRUE;
1849 si->sn_pr_nest = 0;
1850}
1851
1852/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02001853 * Save time when starting to invoke another script or function.
Bram Moolenaar05159a02005-02-26 23:04:13 +00001854 */
1855 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001856script_prof_save(
1857 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001858{
1859 scriptitem_T *si;
1860
1861 if (current_SID > 0 && current_SID <= script_items.ga_len)
1862 {
1863 si = &SCRIPT_ITEM(current_SID);
1864 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1865 profile_start(&si->sn_pr_child);
1866 }
1867 profile_get_wait(tm);
1868}
1869
1870/*
1871 * Count time spent in children after invoking another script or function.
1872 */
1873 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001874script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001875{
1876 scriptitem_T *si;
1877
1878 if (current_SID > 0 && current_SID <= script_items.ga_len)
1879 {
1880 si = &SCRIPT_ITEM(current_SID);
1881 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1882 {
1883 profile_end(&si->sn_pr_child);
1884 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1885 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1886 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1887 }
1888 }
1889}
1890
1891static proftime_T inchar_time;
1892
1893/*
1894 * Called when starting to wait for the user to type a character.
1895 */
1896 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001897prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001898{
1899 profile_start(&inchar_time);
1900}
1901
1902/*
1903 * Called when finished waiting for the user to type a character.
1904 */
1905 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001906prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001907{
1908 profile_end(&inchar_time);
1909 profile_add(&prof_wait_time, &inchar_time);
1910}
1911
1912/*
1913 * Dump the profiling results for all scripts in file "fd".
1914 */
1915 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001916script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001917{
1918 int id;
1919 scriptitem_T *si;
1920 int i;
1921 FILE *sfd;
1922 sn_prl_T *pp;
1923
1924 for (id = 1; id <= script_items.ga_len; ++id)
1925 {
1926 si = &SCRIPT_ITEM(id);
1927 if (si->sn_prof_on)
1928 {
1929 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1930 if (si->sn_pr_count == 1)
1931 fprintf(fd, "Sourced 1 time\n");
1932 else
1933 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1934 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1935 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1936 fprintf(fd, "\n");
1937 fprintf(fd, "count total (s) self (s)\n");
1938
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001939 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001940 if (sfd == NULL)
1941 fprintf(fd, "Cannot open file!\n");
1942 else
1943 {
Bram Moolenaar67435d92017-10-19 21:04:37 +02001944 /* Keep going till the end of file, so that trailing
1945 * continuation lines are listed. */
1946 for (i = 0; ; ++i)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001947 {
1948 if (vim_fgets(IObuff, IOSIZE, sfd))
1949 break;
Bram Moolenaarac112f02017-12-05 16:46:28 +01001950 /* When a line has been truncated, append NL, taking care
1951 * of multi-byte characters . */
1952 if (IObuff[IOSIZE - 2] != NUL && IObuff[IOSIZE - 2] != NL)
1953 {
1954 int n = IOSIZE - 2;
1955# ifdef FEAT_MBYTE
1956 if (enc_utf8)
1957 {
1958 /* Move to the first byte of this char.
1959 * utf_head_off() doesn't work, because it checks
1960 * for a truncated character. */
1961 while (n > 0 && (IObuff[n] & 0xc0) == 0x80)
1962 --n;
1963 }
1964 else if (has_mbyte)
1965 n -= mb_head_off(IObuff, IObuff + n);
1966# endif
1967 IObuff[n] = NL;
1968 IObuff[n + 1] = NUL;
1969 }
Bram Moolenaar67435d92017-10-19 21:04:37 +02001970 if (i < si->sn_prl_ga.ga_len
1971 && (pp = &PRL_ITEM(si, i))->snp_count > 0)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001972 {
1973 fprintf(fd, "%5d ", pp->snp_count);
1974 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1975 fprintf(fd, " ");
1976 else
1977 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1978 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1979 }
1980 else
1981 fprintf(fd, " ");
1982 fprintf(fd, "%s", IObuff);
1983 }
1984 fclose(sfd);
1985 }
1986 fprintf(fd, "\n");
1987 }
1988 }
1989}
1990
1991/*
1992 * Return TRUE when a function defined in the current script should be
1993 * profiled.
1994 */
1995 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001996prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001997{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00001998 if (current_SID > 0)
1999 return SCRIPT_ITEM(current_SID).sn_pr_force;
2000 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00002001}
2002
2003# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004#endif
2005
2006/*
2007 * If 'autowrite' option set, try to write the file.
2008 * Careful: autocommands may make "buf" invalid!
2009 *
2010 * return FAIL for failure, OK otherwise
2011 */
2012 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002013autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014{
Bram Moolenaar373154b2007-02-13 05:19:30 +00002015 int r;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002016 bufref_T bufref;
Bram Moolenaar373154b2007-02-13 05:19:30 +00002017
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 if (!(p_aw || p_awa) || !p_write
2019#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00002020 /* never autowrite a "nofile" or "nowrite" buffer */
2021 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00002023 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 return FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002025 set_bufref(&bufref, buf);
Bram Moolenaar373154b2007-02-13 05:19:30 +00002026 r = buf_write_all(buf, forceit);
2027
2028 /* Writing may succeed but the buffer still changed, e.g., when there is a
2029 * conversion error. We do want to return FAIL then. */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002030 if (bufref_valid(&bufref) && bufIsChanged(buf))
Bram Moolenaar373154b2007-02-13 05:19:30 +00002031 r = FAIL;
2032 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033}
2034
2035/*
2036 * flush all buffers, except the ones that are readonly
2037 */
2038 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002039autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040{
2041 buf_T *buf;
2042
2043 if (!(p_aw || p_awa) || !p_write)
2044 return;
Bram Moolenaar29323592016-07-24 22:04:11 +02002045 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 if (bufIsChanged(buf) && !buf->b_p_ro)
2047 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002048#ifdef FEAT_AUTOCMD
2049 bufref_T bufref;
2050
2051 set_bufref(&bufref, buf);
2052#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 (void)buf_write_all(buf, FALSE);
2054#ifdef FEAT_AUTOCMD
2055 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002056 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 buf = firstbuf;
2058#endif
2059 }
2060}
2061
2062/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002063 * Return TRUE if buffer was changed and cannot be abandoned.
2064 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002067check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068{
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002069 int forceit = (flags & CCGD_FORCEIT);
2070#ifdef FEAT_AUTOCMD
2071 bufref_T bufref;
2072
2073 set_bufref(&bufref, buf);
2074#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002075
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 if ( !forceit
2077 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002078 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
2079 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 {
2081#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2082 if ((p_confirm || cmdmod.confirm) && p_write)
2083 {
2084 buf_T *buf2;
2085 int count = 0;
2086
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002087 if (flags & CCGD_ALLBUF)
Bram Moolenaar29323592016-07-24 22:04:11 +02002088 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 if (bufIsChanged(buf2)
2090 && (buf2->b_ffname != NULL
2091# ifdef FEAT_BROWSE
2092 || cmdmod.browse
2093# endif
2094 ))
2095 ++count;
2096# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002097 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002098 /* Autocommand deleted buffer, oops! It's not changed now. */
2099 return FALSE;
2100# endif
2101 dialog_changed(buf, count > 1);
2102# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002103 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 /* Autocommand deleted buffer, oops! It's not changed now. */
2105 return FALSE;
2106# endif
2107 return bufIsChanged(buf);
2108 }
2109#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002110 if (flags & CCGD_EXCMD)
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002111 no_write_message();
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002112 else
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002113 no_write_message_nobang();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002114 return TRUE;
2115 }
2116 return FALSE;
2117}
2118
2119#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
2120
2121#if defined(FEAT_BROWSE) || defined(PROTO)
2122/*
2123 * When wanting to write a file without a file name, ask the user for a name.
2124 */
2125 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002126browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002127{
2128 if (buf->b_fname == NULL)
2129 {
2130 char_u *fname;
2131
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002132 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
2133 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134 if (fname != NULL)
2135 {
2136 if (setfname(buf, fname, NULL, TRUE) == OK)
2137 buf->b_flags |= BF_NOTEDITED;
2138 vim_free(fname);
2139 }
2140 }
2141}
2142#endif
2143
2144/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02002145 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 * Must check 'write' option first!
2147 */
2148 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002149dialog_changed(
2150 buf_T *buf,
2151 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152{
Bram Moolenaard9462e32011-04-11 21:35:11 +02002153 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154 int ret;
2155 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02002156 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157
Bram Moolenaar3f9a1ff2017-08-21 22:06:02 +02002158 dialog_msg(buff, _("Save changes to \"%s\"?"), buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 if (checkall)
2160 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
2161 else
2162 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
2163
Bram Moolenaar8218f602012-04-25 17:32:18 +02002164 /* Init ea pseudo-structure, this is needed for the check_overwrite()
2165 * function. */
2166 ea.append = ea.forceit = FALSE;
2167
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 if (ret == VIM_YES)
2169 {
2170#ifdef FEAT_BROWSE
2171 /* May get file name, when there is none */
2172 browse_save_fname(buf);
2173#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002174 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
2175 buf->b_fname, buf->b_ffname, FALSE) == OK)
2176 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002177 (void)buf_write_all(buf, FALSE);
2178 }
2179 else if (ret == VIM_NO)
2180 {
2181 unchanged(buf, TRUE);
2182 }
2183 else if (ret == VIM_ALL)
2184 {
2185 /*
2186 * Write all modified files that can be written.
2187 * Skip readonly buffers, these need to be confirmed
2188 * individually.
2189 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002190 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002191 {
2192 if (bufIsChanged(buf2)
2193 && (buf2->b_ffname != NULL
2194#ifdef FEAT_BROWSE
2195 || cmdmod.browse
2196#endif
2197 )
2198 && !buf2->b_p_ro)
2199 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002200#ifdef FEAT_AUTOCMD
2201 bufref_T bufref;
2202
2203 set_bufref(&bufref, buf2);
2204#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205#ifdef FEAT_BROWSE
2206 /* May get file name, when there is none */
2207 browse_save_fname(buf2);
2208#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002209 if (buf2->b_fname != NULL && check_overwrite(&ea, buf2,
2210 buf2->b_fname, buf2->b_ffname, FALSE) == OK)
2211 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 (void)buf_write_all(buf2, FALSE);
2213#ifdef FEAT_AUTOCMD
2214 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002215 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216 buf2 = firstbuf;
2217#endif
2218 }
2219 }
2220 }
2221 else if (ret == VIM_DISCARDALL)
2222 {
2223 /*
2224 * mark all buffers as unchanged
2225 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002226 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 unchanged(buf2, TRUE);
2228 }
2229}
2230#endif
2231
2232/*
2233 * Return TRUE if the buffer "buf" can be abandoned, either by making it
2234 * hidden, autowriting it or unloading it.
2235 */
2236 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002237can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238{
Bram Moolenaareb44a682017-08-03 22:44:55 +02002239 return ( buf_hide(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 || !bufIsChanged(buf)
2241 || buf->b_nwindows > 1
2242 || autowrite(buf, forceit) == OK
2243 || forceit);
2244}
2245
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002246static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002247
2248/*
2249 * Add a buffer number to "bufnrs", unless it's already there.
2250 */
2251 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002252add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002253{
2254 int i;
2255
2256 for (i = 0; i < *bufnump; ++i)
2257 if (bufnrs[i] == nr)
2258 return;
2259 bufnrs[*bufnump] = nr;
2260 *bufnump = *bufnump + 1;
2261}
2262
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263/*
2264 * Return TRUE if any buffer was changed and cannot be abandoned.
2265 * That changed buffer becomes the current buffer.
Bram Moolenaar027387f2016-01-02 22:25:52 +01002266 * When "unload" is true the current buffer is unloaded instead of making it
2267 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 */
2269 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002270check_changed_any(
2271 int hidden, /* Only check hidden buffers */
2272 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002274 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 buf_T *buf;
2276 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002277 int i;
2278 int bufnum = 0;
2279 int bufcount = 0;
2280 int *bufnrs;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002281 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283
Bram Moolenaar29323592016-07-24 22:04:11 +02002284 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002285 ++bufcount;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002287 if (bufcount == 0)
2288 return FALSE;
2289
2290 bufnrs = (int *)alloc(sizeof(int) * bufcount);
2291 if (bufnrs == NULL)
2292 return FALSE;
2293
2294 /* curbuf */
2295 bufnrs[bufnum++] = curbuf->b_fnum;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002296 /* buf in curtab */
2297 FOR_ALL_WINDOWS(wp)
2298 if (wp->w_buffer != curbuf)
2299 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2300
2301 /* buf in other tab */
Bram Moolenaar29323592016-07-24 22:04:11 +02002302 FOR_ALL_TABPAGES(tp)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002303 if (tp != curtab)
2304 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
2305 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002306 /* any other buf */
Bram Moolenaar29323592016-07-24 22:04:11 +02002307 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002308 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
2309
2310 for (i = 0; i < bufnum; ++i)
2311 {
2312 buf = buflist_findnr(bufnrs[i]);
2313 if (buf == NULL)
2314 continue;
2315 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
2316 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002317 bufref_T bufref;
2318
2319 set_bufref(&bufref, buf);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002320 /* Try auto-writing the buffer. If this fails but the buffer no
2321 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002322 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
2323 | CCGD_MULTWIN
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002324 | CCGD_ALLBUF) && bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002325 break; /* didn't save - still changes */
2326 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 }
2328
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002329 if (i >= bufnum)
2330 goto theend;
2331
2332 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 exiting = FALSE;
2334#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2335 /*
2336 * When ":confirm" used, don't give an error message.
2337 */
2338 if (!(p_confirm || cmdmod.confirm))
2339#endif
2340 {
2341 /* There must be a wait_return for this message, do_buffer()
2342 * may cause a redraw. But wait_return() is a no-op when vgetc()
2343 * is busy (Quit used from window menu), then make sure we don't
2344 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00002345 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 {
2347 msg_row = cmdline_row;
2348 msg_col = 0;
2349 msg_didout = FALSE;
2350 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002351 if (
2352#ifdef FEAT_TERMINAL
2353 term_job_running(buf->b_term)
2354 ? EMSG2(_("E947: Job still running in buffer \"%s\""),
2355 buf->b_fname)
2356 :
2357#endif
2358 EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002359 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360 {
2361 save = no_wait_return;
2362 no_wait_return = FALSE;
2363 wait_return(FALSE);
2364 no_wait_return = save;
2365 }
2366 }
2367
Bram Moolenaar071d4272004-06-13 20:20:40 +00002368 /* Try to find a window that contains the buffer. */
2369 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002370 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 if (wp->w_buffer == buf)
2372 {
Bram Moolenaar4033c552017-09-16 20:54:51 +02002373#ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002374 bufref_T bufref;
2375
2376 set_bufref(&bufref, buf);
Bram Moolenaar4033c552017-09-16 20:54:51 +02002377#endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002378 goto_tabpage_win(tp, wp);
Bram Moolenaar4033c552017-09-16 20:54:51 +02002379#ifdef FEAT_AUTOCMD
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 /* Paranoia: did autocms wipe out the buffer with changes? */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002381 if (!bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002382 {
2383 goto theend;
2384 }
Bram Moolenaar4033c552017-09-16 20:54:51 +02002385#endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002386 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002388buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389
2390 /* Open the changed buffer in the current window. */
2391 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002392 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002394theend:
2395 vim_free(bufnrs);
2396 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397}
2398
2399/*
2400 * return FAIL if there is no file name, OK if there is one
2401 * give error message for FAIL
2402 */
2403 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002404check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405{
2406 if (curbuf->b_ffname == NULL)
2407 {
2408 EMSG(_(e_noname));
2409 return FAIL;
2410 }
2411 return OK;
2412}
2413
2414/*
2415 * flush the contents of a buffer, unless it has no file name
2416 *
2417 * return FAIL for failure, OK otherwise
2418 */
2419 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002420buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002421{
2422 int retval;
2423#ifdef FEAT_AUTOCMD
2424 buf_T *old_curbuf = curbuf;
2425#endif
2426
2427 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2428 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2429 FALSE, forceit, TRUE, FALSE));
2430#ifdef FEAT_AUTOCMD
2431 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002432 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01002433 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002435 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436#endif
2437 return retval;
2438}
2439
2440/*
2441 * Code to handle the argument list.
2442 */
2443
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002444static char_u *do_one_arg(char_u *str);
2445static int do_arglist(char_u *str, int what, int after);
2446static void alist_check_arg_idx(void);
2447static int editing_arg_idx(win_T *win);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002448#ifdef FEAT_LISTCMDS
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002449static int alist_add_list(int count, char_u **files, int after);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002450#endif
2451#define AL_SET 1
2452#define AL_ADD 2
2453#define AL_DEL 3
2454
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002456 * Isolate one argument, taking backticks.
2457 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 * Return a pointer to the start of the next argument.
2459 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002460 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002461do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462{
2463 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 int inbacktick;
2465
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466 inbacktick = FALSE;
2467 for (p = str; *str; ++str)
2468 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002469 /* When the backslash is used for escaping the special meaning of a
2470 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002471 if (rem_backslash(str))
2472 {
2473 *p++ = *str++;
2474 *p++ = *str;
2475 }
2476 else
2477 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002478 /* An item ends at a space not in backticks */
2479 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002481 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002483 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 }
2485 }
2486 str = skipwhite(str);
2487 *p = NUL;
2488
2489 return str;
2490}
2491
Bram Moolenaar86b68352004-12-27 21:59:20 +00002492/*
2493 * Separate the arguments in "str" and return a list of pointers in the
2494 * growarray "gap".
2495 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002496 static int
2497get_arglist(garray_T *gap, char_u *str, int escaped)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002498{
2499 ga_init2(gap, (int)sizeof(char_u *), 20);
2500 while (*str != NUL)
2501 {
2502 if (ga_grow(gap, 1) == FAIL)
2503 {
2504 ga_clear(gap);
2505 return FAIL;
2506 }
2507 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2508
Bram Moolenaar398ee732017-08-03 14:29:14 +02002509 /* If str is escaped, don't handle backslashes or spaces */
2510 if (!escaped)
2511 return OK;
2512
Bram Moolenaar86b68352004-12-27 21:59:20 +00002513 /* Isolate one argument, change it in-place, put a NUL after it. */
2514 str = do_one_arg(str);
2515 }
2516 return OK;
2517}
2518
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002519#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002520/*
2521 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002522 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002523 * Return FAIL or OK.
2524 */
2525 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002526get_arglist_exp(
2527 char_u *str,
2528 int *fcountp,
2529 char_u ***fnamesp,
2530 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002531{
2532 garray_T ga;
2533 int i;
2534
Bram Moolenaar398ee732017-08-03 14:29:14 +02002535 if (get_arglist(&ga, str, TRUE) == FAIL)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002536 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002537 if (wig == TRUE)
2538 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2539 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2540 else
2541 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2542 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2543
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002544 ga_clear(&ga);
2545 return i;
2546}
2547#endif
2548
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549/*
2550 * Redefine the argument list.
2551 */
2552 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002553set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554{
2555 do_arglist(str, AL_SET, 0);
2556}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557
2558/*
2559 * "what" == AL_SET: Redefine the argument list to 'str'.
2560 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2561 * "what" == AL_DEL: remove files in 'str' from the argument list.
2562 *
2563 * Return FAIL for failure, OK otherwise.
2564 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002566do_arglist(
2567 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002568 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002569 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570{
2571 garray_T new_ga;
2572 int exp_count;
2573 char_u **exp_files;
2574 int i;
2575#ifdef FEAT_LISTCMDS
2576 char_u *p;
2577 int match;
2578#endif
Bram Moolenaar398ee732017-08-03 14:29:14 +02002579 int arg_escaped = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580
2581 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002582 * Set default argument for ":argadd" command.
2583 */
2584 if (what == AL_ADD && *str == NUL)
2585 {
2586 if (curbuf->b_ffname == NULL)
2587 return FAIL;
2588 str = curbuf->b_fname;
Bram Moolenaar398ee732017-08-03 14:29:14 +02002589 arg_escaped = FALSE;
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002590 }
2591
2592 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 * Collect all file name arguments in "new_ga".
2594 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002595 if (get_arglist(&new_ga, str, arg_escaped) == FAIL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002596 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597
2598#ifdef FEAT_LISTCMDS
2599 if (what == AL_DEL)
2600 {
2601 regmatch_T regmatch;
2602 int didone;
2603
2604 /*
2605 * Delete the items: use each item as a regexp and find a match in the
2606 * argument list.
2607 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002608 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2610 {
2611 p = ((char_u **)new_ga.ga_data)[i];
2612 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2613 if (p == NULL)
2614 break;
2615 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2616 if (regmatch.regprog == NULL)
2617 {
2618 vim_free(p);
2619 break;
2620 }
2621
2622 didone = FALSE;
2623 for (match = 0; match < ARGCOUNT; ++match)
2624 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2625 (colnr_T)0))
2626 {
2627 didone = TRUE;
2628 vim_free(ARGLIST[match].ae_fname);
2629 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2630 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2631 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002632 if (curwin->w_arg_idx > match)
2633 --curwin->w_arg_idx;
2634 --match;
2635 }
2636
Bram Moolenaar473de612013-06-08 18:19:48 +02002637 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002638 vim_free(p);
2639 if (!didone)
2640 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2641 }
2642 ga_clear(&new_ga);
2643 }
2644 else
2645#endif
2646 {
2647 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2648 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2649 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002650 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 {
2652 EMSG(_(e_nomatch));
2653 return FAIL;
2654 }
2655
2656#ifdef FEAT_LISTCMDS
2657 if (what == AL_ADD)
2658 {
2659 (void)alist_add_list(exp_count, exp_files, after);
2660 vim_free(exp_files);
2661 }
2662 else /* what == AL_SET */
2663#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00002664 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 }
2666
2667 alist_check_arg_idx();
2668
2669 return OK;
2670}
2671
2672/*
2673 * Check the validity of the arg_idx for each other window.
2674 */
2675 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002676alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002679 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680
Bram Moolenaarf740b292006-02-16 22:11:02 +00002681 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 if (win->w_alist == curwin->w_alist)
2683 check_arg_idx(win);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684}
2685
2686/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002687 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002688 * index.
2689 */
2690 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002691editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002692{
2693 return !(win->w_arg_idx >= WARGCOUNT(win)
2694 || (win->w_buffer->b_fnum
2695 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2696 && (win->w_buffer->b_ffname == NULL
2697 || !(fullpathcmp(
2698 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2699 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2700}
2701
2702/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 * Check if window "win" is editing the w_arg_idx file in its argument list.
2704 */
2705 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002706check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002708 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 {
2710 /* We are not editing the current entry in the argument list.
2711 * Set "arg_had_last" if we are editing the last one. */
2712 win->w_arg_idx_invalid = TRUE;
2713 if (win->w_arg_idx != WARGCOUNT(win) - 1
2714 && arg_had_last == FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 && ALIST(win) == &global_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 && GARGCOUNT > 0
2717 && win->w_arg_idx < GARGCOUNT
2718 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2719 || (win->w_buffer->b_ffname != NULL
2720 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2721 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2722 arg_had_last = TRUE;
2723 }
2724 else
2725 {
2726 /* We are editing the current entry in the argument list.
2727 * Set "arg_had_last" if it's also the last one */
2728 win->w_arg_idx_invalid = FALSE;
2729 if (win->w_arg_idx == WARGCOUNT(win) - 1
Bram Moolenaar4033c552017-09-16 20:54:51 +02002730 && win->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 arg_had_last = TRUE;
2732 }
2733}
2734
2735/*
2736 * ":args", ":argslocal" and ":argsglobal".
2737 */
2738 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002739ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740{
2741 int i;
2742
2743 if (eap->cmdidx != CMD_args)
2744 {
Bram Moolenaar4033c552017-09-16 20:54:51 +02002745#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 alist_unlink(ALIST(curwin));
2747 if (eap->cmdidx == CMD_argglobal)
2748 ALIST(curwin) = &global_alist;
2749 else /* eap->cmdidx == CMD_arglocal */
2750 alist_new();
2751#else
2752 ex_ni(eap);
2753 return;
2754#endif
2755 }
2756
2757 if (!ends_excmd(*eap->arg))
2758 {
2759 /*
2760 * ":args file ..": define new argument list, handle like ":next"
2761 * Also for ":argslocal file .." and ":argsglobal file ..".
2762 */
2763 ex_next(eap);
2764 }
2765 else
Bram Moolenaar4033c552017-09-16 20:54:51 +02002766#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 if (eap->cmdidx == CMD_args)
2768#endif
2769 {
2770 /*
2771 * ":args": list arguments.
2772 */
2773 if (ARGCOUNT > 0)
2774 {
2775 /* Overwrite the command, for a short list there is no scrolling
2776 * required and no wait_return(). */
2777 gotocmdline(TRUE);
2778 for (i = 0; i < ARGCOUNT; ++i)
2779 {
2780 if (i == curwin->w_arg_idx)
2781 msg_putchar('[');
2782 msg_outtrans(alist_name(&ARGLIST[i]));
2783 if (i == curwin->w_arg_idx)
2784 msg_putchar(']');
2785 msg_putchar(' ');
2786 }
2787 }
2788 }
Bram Moolenaar4033c552017-09-16 20:54:51 +02002789#if defined(FEAT_LISTCMDS)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 else if (eap->cmdidx == CMD_arglocal)
2791 {
2792 garray_T *gap = &curwin->w_alist->al_ga;
2793
2794 /*
2795 * ":argslocal": make a local copy of the global argument list.
2796 */
2797 if (ga_grow(gap, GARGCOUNT) == OK)
2798 for (i = 0; i < GARGCOUNT; ++i)
2799 if (GARGLIST[i].ae_fname != NULL)
2800 {
2801 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2802 vim_strsave(GARGLIST[i].ae_fname);
2803 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2804 GARGLIST[i].ae_fnum;
2805 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 }
2807 }
2808#endif
2809}
2810
2811/*
2812 * ":previous", ":sprevious", ":Next" and ":sNext".
2813 */
2814 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002815ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816{
2817 /* If past the last one already, go to the last one. */
2818 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2819 do_argfile(eap, ARGCOUNT - 1);
2820 else
2821 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2822}
2823
2824/*
2825 * ":rewind", ":first", ":sfirst" and ":srewind".
2826 */
2827 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002828ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829{
2830 do_argfile(eap, 0);
2831}
2832
2833/*
2834 * ":last" and ":slast".
2835 */
2836 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002837ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838{
2839 do_argfile(eap, ARGCOUNT - 1);
2840}
2841
2842/*
2843 * ":argument" and ":sargument".
2844 */
2845 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002846ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002847{
2848 int i;
2849
2850 if (eap->addr_count > 0)
2851 i = eap->line2 - 1;
2852 else
2853 i = curwin->w_arg_idx;
2854 do_argfile(eap, i);
2855}
2856
2857/*
2858 * Edit file "argn" of the argument lists.
2859 */
2860 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002861do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862{
2863 int other;
2864 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002865 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866
2867 if (argn < 0 || argn >= ARGCOUNT)
2868 {
2869 if (ARGCOUNT <= 1)
2870 EMSG(_("E163: There is only one file to edit"));
2871 else if (argn < 0)
2872 EMSG(_("E164: Cannot go before first file"));
2873 else
2874 EMSG(_("E165: Cannot go beyond last file"));
2875 }
2876 else
2877 {
2878 setpcmark();
2879#ifdef FEAT_GUI
2880 need_mouse_correct = TRUE;
2881#endif
2882
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002883 /* split window or create new tab page first */
2884 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 {
2886 if (win_split(0, 0) == FAIL)
2887 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002888 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 }
2890 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 {
2892 /*
2893 * if 'hidden' set, only check for changed file when re-editing
2894 * the same buffer
2895 */
2896 other = TRUE;
Bram Moolenaareb44a682017-08-03 22:44:55 +02002897 if (buf_hide(curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 {
2899 p = fix_fname(alist_name(&ARGLIST[argn]));
2900 other = otherfile(p);
2901 vim_free(p);
2902 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002903 if ((!buf_hide(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002904 && check_changed(curbuf, CCGD_AW
2905 | (other ? 0 : CCGD_MULTWIN)
2906 | (eap->forceit ? CCGD_FORCEIT : 0)
2907 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 return;
2909 }
2910
2911 curwin->w_arg_idx = argn;
Bram Moolenaar4033c552017-09-16 20:54:51 +02002912 if (argn == ARGCOUNT - 1 && curwin->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 arg_had_last = TRUE;
2914
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002915 /* Edit the file; always use the last known line number.
2916 * When it fails (e.g. Abort for already edited file) restore the
2917 * argument index. */
2918 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 eap, ECMD_LAST,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002920 (buf_hide(curwin->w_buffer) ? ECMD_HIDE : 0)
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002921 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002922 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002924 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 setmark('\'');
2926 }
2927}
2928
2929/*
2930 * ":next", and commands that behave like it.
2931 */
2932 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002933ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002934{
2935 int i;
2936
2937 /*
2938 * check for changed buffer now, if this fails the argument list is not
2939 * redefined.
2940 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002941 if ( buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002943 || !check_changed(curbuf, CCGD_AW
2944 | (eap->forceit ? CCGD_FORCEIT : 0)
2945 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946 {
2947 if (*eap->arg != NUL) /* redefine file list */
2948 {
2949 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2950 return;
2951 i = 0;
2952 }
2953 else
2954 i = curwin->w_arg_idx + (int)eap->line2;
2955 do_argfile(eap, i);
2956 }
2957}
2958
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002959#if defined(FEAT_LISTCMDS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960/*
2961 * ":argedit"
2962 */
2963 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002964ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965{
Bram Moolenaar90305c62017-07-16 15:31:17 +02002966 int i = eap->addr_count ? (int)eap->line2 : curwin->w_arg_idx + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967
Bram Moolenaar90305c62017-07-16 15:31:17 +02002968 if (do_arglist(eap->arg, AL_ADD, i) == FAIL)
2969 return;
2970#ifdef FEAT_TITLE
2971 maketitle();
2972#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002973
Bram Moolenaar90305c62017-07-16 15:31:17 +02002974 if (curwin->w_arg_idx == 0 && (curbuf->b_ml.ml_flags & ML_EMPTY)
2975 && curbuf->b_ffname == NULL)
2976 i = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 /* Edit the argument. */
Bram Moolenaar90305c62017-07-16 15:31:17 +02002978 if (i < ARGCOUNT)
2979 do_argfile(eap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980}
2981
2982/*
2983 * ":argadd"
2984 */
2985 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002986ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987{
2988 do_arglist(eap->arg, AL_ADD,
2989 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2990#ifdef FEAT_TITLE
2991 maketitle();
2992#endif
2993}
2994
2995/*
2996 * ":argdelete"
2997 */
2998 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002999ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000{
3001 int i;
3002 int n;
3003
3004 if (eap->addr_count > 0)
3005 {
3006 /* ":1,4argdel": Delete all arguments in the range. */
3007 if (eap->line2 > ARGCOUNT)
3008 eap->line2 = ARGCOUNT;
3009 n = eap->line2 - eap->line1 + 1;
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01003010 if (*eap->arg != NUL)
3011 /* Can't have both a range and an argument. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 EMSG(_(e_invarg));
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01003013 else if (n <= 0)
3014 {
3015 /* Don't give an error for ":%argdel" if the list is empty. */
3016 if (eap->line1 != 1 || eap->line2 != 0)
3017 EMSG(_(e_invrange));
3018 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 else
3020 {
3021 for (i = eap->line1; i <= eap->line2; ++i)
3022 vim_free(ARGLIST[i - 1].ae_fname);
3023 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
3024 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
3025 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026 if (curwin->w_arg_idx >= eap->line2)
3027 curwin->w_arg_idx -= n;
3028 else if (curwin->w_arg_idx > eap->line1)
3029 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01003030 if (ARGCOUNT == 0)
3031 curwin->w_arg_idx = 0;
3032 else if (curwin->w_arg_idx >= ARGCOUNT)
3033 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 }
3035 }
3036 else if (*eap->arg == NUL)
3037 EMSG(_(e_argreq));
3038 else
3039 do_arglist(eap->arg, AL_DEL, 0);
3040#ifdef FEAT_TITLE
3041 maketitle();
3042#endif
3043}
3044
3045/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003046 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 */
3048 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003049ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003050{
3051 int i;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003052 win_T *wp;
3053 tabpage_T *tp;
Bram Moolenaare25bb902015-02-27 20:33:37 +01003054 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 int next_fnum = 0;
3056#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
3057 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003058#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003059 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003060#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02003061 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003062 int qf_idx;
3063#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003064
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01003065#ifndef FEAT_QUICKFIX
3066 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
3067 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3068 {
3069 ex_ni(eap);
3070 return;
3071 }
3072#endif
3073
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003075 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00003076 /* Don't do syntax HL autocommands. Skipping the syntax file is a
3077 * great speed improvement. */
3078 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003080#ifdef FEAT_CLIPBOARD
3081 start_global_changes();
3082#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083
3084 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003085 || eap->cmdidx == CMD_tabdo
Bram Moolenaareb44a682017-08-03 22:44:55 +02003086 || buf_hide(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003087 || !check_changed(curbuf, CCGD_AW
3088 | (eap->forceit ? CCGD_FORCEIT : 0)
3089 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003092 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003093 wp = firstwin;
3094 tp = first_tabpage;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003095 switch (eap->cmdidx)
3096 {
Bram Moolenaara162bc52015-01-07 16:54:21 +01003097 case CMD_windo:
3098 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
3099 i++;
3100 break;
3101 case CMD_tabdo:
3102 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
3103 i++;
3104 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003105 case CMD_argdo:
3106 i = eap->line1 - 1;
3107 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003108 default:
3109 break;
3110 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003111 /* set pcmark now */
3112 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003113 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01003114 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003115 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01003116 || !buf->b_p_bl); buf = buf->b_next)
3117 if (buf->b_fnum > eap->line2)
3118 {
3119 buf = NULL;
3120 break;
3121 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003122 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01003123 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003124 }
3125#ifdef FEAT_QUICKFIX
3126 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3127 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3128 {
3129 qf_size = qf_get_size(eap);
3130 if (qf_size <= 0 || eap->line1 > qf_size)
3131 buf = NULL;
3132 else
3133 {
3134 ex_cc(eap);
3135
3136 buf = curbuf;
3137 i = eap->line1 - 1;
3138 if (eap->addr_count <= 0)
3139 /* default is all the quickfix/location list entries */
3140 eap->line2 = qf_size;
3141 }
3142 }
3143#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 else
3145 setpcmark();
3146 listcmd_busy = TRUE; /* avoids setting pcmark below */
3147
Bram Moolenaare25bb902015-02-27 20:33:37 +01003148 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 {
3150 if (eap->cmdidx == CMD_argdo)
3151 {
3152 /* go to argument "i" */
3153 if (i == ARGCOUNT)
3154 break;
3155 /* Don't call do_argfile() when already there, it will try
3156 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003157 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003158 {
3159 /* Clear 'shm' to avoid that the file message overwrites
3160 * any output from the command. */
3161 p_shm_save = vim_strsave(p_shm);
3162 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003164 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3165 vim_free(p_shm_save);
3166 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 if (curwin->w_arg_idx != i)
3168 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 else if (eap->cmdidx == CMD_windo)
3171 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003172 /* go to window "wp" */
3173 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003175 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00003176 if (curwin != wp)
3177 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003178 wp = curwin->w_next;
3179 }
3180 else if (eap->cmdidx == CMD_tabdo)
3181 {
3182 /* go to window "tp" */
3183 if (!valid_tabpage(tp))
3184 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02003185 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003186 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 else if (eap->cmdidx == CMD_bufdo)
3189 {
3190 /* Remember the number of the next listed buffer, in case
3191 * ":bwipe" is used or autocommands do something strange. */
3192 next_fnum = -1;
3193 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
3194 if (buf->b_p_bl)
3195 {
3196 next_fnum = buf->b_fnum;
3197 break;
3198 }
3199 }
3200
Bram Moolenaara162bc52015-01-07 16:54:21 +01003201 ++i;
3202
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 /* execute the command */
3204 do_cmdline(eap->arg, eap->getline, eap->cookie,
3205 DOCMD_VERBOSE + DOCMD_NOWAIT);
3206
3207 if (eap->cmdidx == CMD_bufdo)
3208 {
3209 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01003210 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 break;
3212 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02003213 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003214 if (buf->b_fnum == next_fnum)
3215 break;
3216 if (buf == NULL)
3217 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003218
3219 /* Go to the next buffer. Clear 'shm' to avoid that the file
3220 * message overwrites any output from the command. */
3221 p_shm_save = vim_strsave(p_shm);
3222 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003224 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3225 vim_free(p_shm_save);
3226
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003227 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 if (curbuf->b_fnum != next_fnum)
3229 break;
3230 }
3231
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003232#ifdef FEAT_QUICKFIX
3233 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3234 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3235 {
3236 if (i >= qf_size || i >= eap->line2)
3237 break;
3238
3239 qf_idx = qf_get_cur_idx(eap);
3240
3241 ex_cnext(eap);
3242
3243 /* If jumping to the next quickfix entry fails, quit here */
3244 if (qf_get_cur_idx(eap) == qf_idx)
3245 break;
3246 }
3247#endif
3248
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 if (eap->cmdidx == CMD_windo)
3250 {
3251 validate_cursor(); /* cursor may have moved */
3252#ifdef FEAT_SCROLLBIND
3253 /* required when 'scrollbind' has been set */
3254 if (curwin->w_p_scb)
3255 do_check_scrollbind(TRUE);
3256#endif
3257 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01003258
Bram Moolenaara162bc52015-01-07 16:54:21 +01003259 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
3260 if (i+1 > eap->line2)
3261 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003262 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
3263 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264 }
3265 listcmd_busy = FALSE;
3266 }
3267
3268#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003269 if (save_ei != NULL)
3270 {
3271 au_event_restore(save_ei);
3272 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
3273 curbuf->b_fname, TRUE, curbuf);
3274 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003276#ifdef FEAT_CLIPBOARD
3277 end_global_changes();
3278#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279}
3280
3281/*
3282 * Add files[count] to the arglist of the current window after arg "after".
3283 * The file names in files[count] must have been allocated and are taken over.
3284 * Files[] itself is not taken over.
3285 * Returns index of first added argument. Returns -1 when failed (out of mem).
3286 */
3287 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003288alist_add_list(
3289 int count,
3290 char_u **files,
3291 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292{
3293 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003294 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295
3296 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3297 {
3298 if (after < 0)
3299 after = 0;
3300 if (after > ARGCOUNT)
3301 after = ARGCOUNT;
3302 if (after < ARGCOUNT)
3303 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3304 (ARGCOUNT - after) * sizeof(aentry_T));
3305 for (i = 0; i < count; ++i)
3306 {
3307 ARGLIST[after + i].ae_fname = files[i];
3308 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
3309 }
3310 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003311 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3312 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 return after;
3314 }
3315
3316 for (i = 0; i < count; ++i)
3317 vim_free(files[i]);
3318 return -1;
3319}
3320
3321#endif /* FEAT_LISTCMDS */
3322
3323#ifdef FEAT_EVAL
3324/*
3325 * ":compiler[!] {name}"
3326 */
3327 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003328ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329{
3330 char_u *buf;
3331 char_u *old_cur_comp = NULL;
3332 char_u *p;
3333
3334 if (*eap->arg == NUL)
3335 {
3336 /* List all compiler scripts. */
3337 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3338 /* ) keep the indenter happy... */
3339 }
3340 else
3341 {
3342 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3343 if (buf != NULL)
3344 {
3345 if (eap->forceit)
3346 {
3347 /* ":compiler! {name}" sets global options */
3348 do_cmdline_cmd((char_u *)
3349 "command -nargs=* CompilerSet set <args>");
3350 }
3351 else
3352 {
3353 /* ":compiler! {name}" sets local options.
3354 * To remain backwards compatible "current_compiler" is always
3355 * used. A user's compiler plugin may set it, the distributed
3356 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003357 * "b:current_compiler" and restore "current_compiler".
3358 * Explicitly prepend "g:" to make it work in a function. */
3359 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360 if (old_cur_comp != NULL)
3361 old_cur_comp = vim_strsave(old_cur_comp);
3362 do_cmdline_cmd((char_u *)
3363 "command -nargs=* CompilerSet setlocal <args>");
3364 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003365 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003366 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367
3368 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003369 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3371 vim_free(buf);
3372
3373 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3374
3375 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003376 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 if (p != NULL)
3378 set_internal_string_var((char_u *)"b:current_compiler", p);
3379
3380 /* Restore "current_compiler" for ":compiler {name}". */
3381 if (!eap->forceit)
3382 {
3383 if (old_cur_comp != NULL)
3384 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003385 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 old_cur_comp);
3387 vim_free(old_cur_comp);
3388 }
3389 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003390 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 }
3392 }
3393 }
3394}
3395#endif
3396
3397/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003398 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 */
3400 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003401ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003403 char_u *arg = eap->arg;
3404 char_u *p = skiptowhite(arg);
3405 int len = (int)(p - arg);
3406 int flags = eap->forceit ? DIP_ALL : 0;
3407
3408 if (STRNCMP(arg, "START", len) == 0)
3409 {
3410 flags += DIP_START + DIP_NORTP;
3411 arg = skipwhite(arg + len);
3412 }
3413 else if (STRNCMP(arg, "OPT", len) == 0)
3414 {
3415 flags += DIP_OPT + DIP_NORTP;
3416 arg = skipwhite(arg + len);
3417 }
3418 else if (STRNCMP(arg, "PACK", len) == 0)
3419 {
3420 flags += DIP_START + DIP_OPT + DIP_NORTP;
3421 arg = skipwhite(arg + len);
3422 }
3423 else if (STRNCMP(arg, "ALL", len) == 0)
3424 {
3425 flags += DIP_START + DIP_OPT;
3426 arg = skipwhite(arg + len);
3427 }
3428
3429 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430}
3431
Bram Moolenaar071d4272004-06-13 20:20:40 +00003432 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003433source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003435 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436}
3437
3438/*
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003439 * Find the file "name" in all directories in "path" and invoke
3440 * "callback(fname, cookie)".
3441 * "name" can contain wildcards.
3442 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3443 * When "flags" has DIP_DIR: find directories instead of files.
3444 * When "flags" has DIP_ERR: give an error message if there is no match.
3445 *
3446 * return FAIL when no file could be sourced, OK otherwise.
3447 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003448 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003449do_in_path(
3450 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003451 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003452 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003453 void (*callback)(char_u *fname, void *ck),
3454 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455{
3456 char_u *rtp;
3457 char_u *np;
3458 char_u *buf;
3459 char_u *rtp_copy;
3460 char_u *tail;
3461 int num_files;
3462 char_u **files;
3463 int i;
3464 int did_one = FALSE;
3465#ifdef AMIGA
3466 struct Process *proc = (struct Process *)FindTask(0L);
3467 APTR save_winptr = proc->pr_WindowPtr;
3468
3469 /* Avoid a requester here for a volume that doesn't exist. */
3470 proc->pr_WindowPtr = (APTR)-1L;
3471#endif
3472
3473 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3474 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003475 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 buf = alloc(MAXPATHL);
3477 if (buf != NULL && rtp_copy != NULL)
3478 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003479 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003480 {
3481 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003482 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003483 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003484 verbose_leave();
3485 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003486
Bram Moolenaar071d4272004-06-13 20:20:40 +00003487 /* Loop over all entries in 'runtimepath'. */
3488 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003489 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 {
Bram Moolenaar66459b72016-08-06 19:01:55 +02003491 size_t buflen;
3492
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 /* Copy the path from 'runtimepath' to buf[]. */
3494 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaar66459b72016-08-06 19:01:55 +02003495 buflen = STRLEN(buf);
3496
3497 /* Skip after or non-after directories. */
3498 if (flags & (DIP_NOAFTER | DIP_AFTER))
3499 {
3500 int is_after = buflen >= 5
3501 && STRCMP(buf + buflen - 5, "after") == 0;
3502
3503 if ((is_after && (flags & DIP_NOAFTER))
3504 || (!is_after && (flags & DIP_AFTER)))
3505 continue;
3506 }
3507
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003508 if (name == NULL)
3509 {
3510 (*callback)(buf, (void *) &cookie);
3511 if (!did_one)
3512 did_one = (cookie == NULL);
3513 }
Bram Moolenaar66459b72016-08-06 19:01:55 +02003514 else if (buflen + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 {
3516 add_pathsep(buf);
3517 tail = buf + STRLEN(buf);
3518
3519 /* Loop over all patterns in "name" */
3520 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003521 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 {
3523 /* Append the pattern from "name" to buf[]. */
3524 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3525 "\t ");
3526
3527 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003528 {
3529 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003530 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003531 verbose_leave();
3532 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003533
3534 /* Expand wildcards, invoke the callback for each match. */
3535 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003536 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537 {
3538 for (i = 0; i < num_files; ++i)
3539 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003540 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003542 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 break;
3544 }
3545 FreeWild(num_files, files);
3546 }
3547 }
3548 }
3549 }
3550 }
3551 vim_free(buf);
3552 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003553 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003554 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003555 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3556
3557 if (flags & DIP_ERR)
3558 EMSG3(_(e_dirnotf), basepath, name);
3559 else if (p_verbose > 0)
3560 {
3561 verbose_enter();
3562 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3563 verbose_leave();
3564 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003565 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566
3567#ifdef AMIGA
3568 proc->pr_WindowPtr = save_winptr;
3569#endif
3570
3571 return did_one ? OK : FAIL;
3572}
3573
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003574/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003575 * Find "name" in "path". When found, invoke the callback function for
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003576 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003577 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3578 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003579 * Returns OK when at least one match found, FAIL otherwise.
3580 *
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003581 * If "name" is NULL calls callback for each entry in "path". Cookie is
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003582 * passed by reference in this case, setting it to NULL indicates that callback
3583 * has done its job.
3584 */
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003585 static int
3586do_in_path_and_pp(
3587 char_u *path,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003588 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003589 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003590 void (*callback)(char_u *fname, void *ck),
3591 void *cookie)
3592{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003593 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003594 char_u *s;
3595 int len;
3596 char *start_dir = "pack/*/start/*/%s";
3597 char *opt_dir = "pack/*/opt/*/%s";
3598
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003599 if ((flags & DIP_NORTP) == 0)
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003600 done = do_in_path(path, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003601
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003602 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003603 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003604 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003605 s = alloc(len);
3606 if (s == NULL)
3607 return FAIL;
3608 vim_snprintf((char *)s, len, start_dir, name);
3609 done = do_in_path(p_pp, s, flags, callback, cookie);
3610 vim_free(s);
3611 }
3612
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003613 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003614 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003615 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003616 s = alloc(len);
3617 if (s == NULL)
3618 return FAIL;
3619 vim_snprintf((char *)s, len, opt_dir, name);
3620 done = do_in_path(p_pp, s, flags, callback, cookie);
3621 vim_free(s);
3622 }
3623
3624 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003625}
3626
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003627/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003628 * Just like do_in_path_and_pp(), using 'runtimepath' for "path".
3629 */
3630 int
3631do_in_runtimepath(
3632 char_u *name,
3633 int flags,
3634 void (*callback)(char_u *fname, void *ck),
3635 void *cookie)
3636{
3637 return do_in_path_and_pp(p_rtp, name, flags, callback, cookie);
3638}
3639
3640/*
3641 * Source the file "name" from all directories in 'runtimepath'.
3642 * "name" can contain wildcards.
3643 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3644 *
3645 * return FAIL when no file could be sourced, OK otherwise.
3646 */
3647 int
3648source_runtime(char_u *name, int flags)
3649{
3650 return source_in_path(p_rtp, name, flags);
3651}
3652
3653/*
3654 * Just like source_runtime(), but use "path" instead of 'runtimepath'.
3655 */
3656 int
3657source_in_path(char_u *path, char_u *name, int flags)
3658{
3659 return do_in_path_and_pp(path, name, flags, source_callback, NULL);
3660}
3661
3662
3663/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003664 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003665 */
3666 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003667source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003668{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003669 int num_files;
3670 char_u **files;
3671 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003672
Bram Moolenaarf3654822016-03-04 22:12:23 +01003673 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003674 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003675 for (i = 0; i < num_files; ++i)
3676 (void)do_source(files[i], FALSE, DOSO_NONE);
3677 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003678 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003679}
3680
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003681/*
3682 * Add the package directory to 'runtimepath'.
3683 */
3684 static int
3685add_pack_dir_to_rtp(char_u *fname)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003686{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003687 char_u *p4, *p3, *p2, *p1, *p;
3688 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003689 int c;
3690 char_u *new_rtp;
3691 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003692 size_t oldlen;
3693 size_t addlen;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003694 char_u *afterdir = NULL;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003695 size_t afterlen = 0;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003696 char_u *ffname = NULL;
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003697 size_t fname_len;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003698 char_u *buf = NULL;
3699 char_u *rtp_ffname;
3700 int match;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003701 int retval = FAIL;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003702
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003703 p4 = p3 = p2 = p1 = get_past_head(fname);
3704 for (p = p1; *p; MB_PTR_ADV(p))
3705 if (vim_ispathsep_nocolon(*p))
3706 {
3707 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3708 }
3709
3710 /* now we have:
3711 * rtp/pack/name/start/name
3712 * p4 p3 p2 p1
3713 *
3714 * find the part up to "pack" in 'runtimepath' */
3715 c = *++p4; /* append pathsep in order to expand symlink */
3716 *p4 = NUL;
3717 ffname = fix_fname(fname);
3718 *p4 = c;
Bram Moolenaar91715872016-03-03 17:13:03 +01003719 if (ffname == NULL)
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003720 return FAIL;
3721
3722 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3723 fname_len = STRLEN(ffname);
3724 insp = p_rtp;
3725 buf = alloc(MAXPATHL);
3726 if (buf == NULL)
3727 goto theend;
3728 while (*insp != NUL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003729 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003730 copy_option_part(&insp, buf, MAXPATHL, ",");
3731 add_pathsep(buf);
3732 rtp_ffname = fix_fname(buf);
3733 if (rtp_ffname == NULL)
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003734 goto theend;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003735 match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0;
3736 vim_free(rtp_ffname);
3737 if (match)
3738 break;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003739 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003740
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003741 if (*insp == NUL)
3742 /* not found, append at the end */
3743 insp = p_rtp + STRLEN(p_rtp);
3744 else
3745 /* append after the matching directory. */
3746 --insp;
3747
3748 /* check if rtp/pack/name/start/name/after exists */
3749 afterdir = concat_fnames(fname, (char_u *)"after", TRUE);
3750 if (afterdir != NULL && mch_isdir(afterdir))
3751 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3752
3753 oldlen = STRLEN(p_rtp);
3754 addlen = STRLEN(fname) + 1; /* add one for comma */
3755 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1));
3756 /* add one for NUL */
3757 if (new_rtp == NULL)
3758 goto theend;
3759 keep = (int)(insp - p_rtp);
3760 mch_memmove(new_rtp, p_rtp, keep);
3761 new_rtp[keep] = ',';
3762 mch_memmove(new_rtp + keep + 1, fname, addlen);
3763 if (p_rtp[keep] != NUL)
3764 mch_memmove(new_rtp + keep + addlen, p_rtp + keep, oldlen - keep + 1);
3765 if (afterlen > 0)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003766 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003767 STRCAT(new_rtp, ",");
3768 STRCAT(new_rtp, afterdir);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003769 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003770 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3771 vim_free(new_rtp);
3772 retval = OK;
Bram Moolenaarf3654822016-03-04 22:12:23 +01003773
3774theend:
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003775 vim_free(buf);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003776 vim_free(ffname);
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003777 vim_free(afterdir);
3778 return retval;
3779}
3780
3781/*
3782 * Load scripts in "plugin" and "ftdetect" directories of the package.
3783 */
3784 static int
3785load_pack_plugin(char_u *fname)
3786{
3787 static char *plugpat = "%s/plugin/**/*.vim";
3788 static char *ftpat = "%s/ftdetect/*.vim";
3789 int len;
3790 char_u *ffname = fix_fname(fname);
3791 char_u *pat = NULL;
3792 int retval = FAIL;
3793
3794 if (ffname == NULL)
3795 return FAIL;
3796 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3797 pat = alloc(len);
3798 if (pat == NULL)
3799 goto theend;
3800 vim_snprintf((char *)pat, len, plugpat, ffname);
3801 source_all_matches(pat);
3802
3803#ifdef FEAT_AUTOCMD
3804 {
3805 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3806
3807 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3808 * found when it loads. */
3809 if (cmd != NULL && eval_to_number(cmd) > 0)
3810 {
3811 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3812 vim_snprintf((char *)pat, len, ftpat, ffname);
3813 source_all_matches(pat);
3814 do_cmdline_cmd((char_u *)"augroup END");
3815 }
3816 vim_free(cmd);
3817 }
3818#endif
3819 vim_free(pat);
3820 retval = OK;
3821
3822theend:
3823 vim_free(ffname);
3824 return retval;
3825}
3826
3827/* used for "cookie" of add_pack_plugin() */
3828static int APP_ADD_DIR;
3829static int APP_LOAD;
3830static int APP_BOTH;
3831
3832 static void
3833add_pack_plugin(char_u *fname, void *cookie)
3834{
3835 if (cookie != &APP_LOAD && strstr((char *)p_rtp, (char *)fname) == NULL)
3836 /* directory is not yet in 'runtimepath', add it */
3837 if (add_pack_dir_to_rtp(fname) == FAIL)
3838 return;
3839
3840 if (cookie != &APP_ADD_DIR)
3841 load_pack_plugin(fname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003842}
3843
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003844/*
3845 * Add all packages in the "start" directory to 'runtimepath'.
3846 */
3847 void
3848add_pack_start_dirs(void)
3849{
3850 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3851 add_pack_plugin, &APP_ADD_DIR);
3852}
3853
3854/*
3855 * Load plugins from all packages in the "start" directory.
3856 */
3857 void
3858load_start_packages(void)
3859{
3860 did_source_packages = TRUE;
3861 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3862 add_pack_plugin, &APP_LOAD);
3863}
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003864
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003865/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003866 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003867 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003868 */
3869 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003870ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003871{
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003872 if (!did_source_packages || eap->forceit)
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003873 {
Bram Moolenaar49b27322016-04-05 21:13:00 +02003874 /* First do a round to add all directories to 'runtimepath', then load
3875 * the plugins. This allows for plugins to use an autoload directory
3876 * of another plugin. */
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003877 add_pack_start_dirs();
3878 load_start_packages();
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003879 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003880}
3881
3882/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003883 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003884 */
3885 void
3886ex_packadd(exarg_T *eap)
3887{
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003888 static char *plugpat = "pack/*/%s/%s";
Bram Moolenaar91715872016-03-03 17:13:03 +01003889 int len;
3890 char *pat;
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003891 int round;
3892 int res = OK;
Bram Moolenaar91715872016-03-03 17:13:03 +01003893
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003894 /* Round 1: use "start", round 2: use "opt". */
3895 for (round = 1; round <= 2; ++round)
3896 {
3897 /* Only look under "start" when loading packages wasn't done yet. */
3898 if (round == 1 && did_source_packages)
3899 continue;
3900
3901 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg) + 5;
3902 pat = (char *)alloc(len);
3903 if (pat == NULL)
3904 return;
3905 vim_snprintf(pat, len, plugpat, round == 1 ? "start" : "opt", eap->arg);
3906 /* The first round don't give a "not found" error, in the second round
3907 * only when nothing was found in the first round. */
3908 res = do_in_path(p_pp, (char_u *)pat,
3909 DIP_ALL + DIP_DIR + (round == 2 && res == FAIL ? DIP_ERR : 0),
3910 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
3911 vim_free(pat);
3912 }
Bram Moolenaar91715872016-03-03 17:13:03 +01003913}
3914
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
3916/*
3917 * ":options"
3918 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003920ex_options(
3921 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922{
Bram Moolenaarab6c8582017-08-11 17:15:09 +02003923 vim_setenv((char_u *)"OPTWIN_CMD", (char_u *)(cmdmod.tab ? "tab" : ""));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3925}
3926#endif
3927
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003928#if defined(FEAT_PYTHON3) || defined(FEAT_PYTHON) || defined(PROTO)
3929
3930# if (defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)) || defined(PROTO)
3931/*
3932 * Detect Python 3 or 2, and initialize 'pyxversion'.
3933 */
3934 void
3935init_pyxversion(void)
3936{
3937 if (p_pyx == 0)
3938 {
3939 if (python3_enabled(FALSE))
3940 p_pyx = 3;
3941 else if (python_enabled(FALSE))
3942 p_pyx = 2;
3943 }
3944}
3945# endif
3946
3947/*
3948 * Does a file contain one of the following strings at the beginning of any
3949 * line?
3950 * "#!(any string)python2" => returns 2
3951 * "#!(any string)python3" => returns 3
3952 * "# requires python 2.x" => returns 2
3953 * "# requires python 3.x" => returns 3
3954 * otherwise return 0.
3955 */
3956 static int
3957requires_py_version(char_u *filename)
3958{
3959 FILE *file;
3960 int requires_py_version = 0;
3961 int i, lines;
3962
3963 lines = (int)p_mls;
3964 if (lines < 0)
3965 lines = 5;
3966
3967 file = mch_fopen((char *)filename, "r");
3968 if (file != NULL)
3969 {
3970 for (i = 0; i < lines; i++)
3971 {
3972 if (vim_fgets(IObuff, IOSIZE, file))
3973 break;
3974 if (i == 0 && IObuff[0] == '#' && IObuff[1] == '!')
3975 {
3976 /* Check shebang. */
3977 if (strstr((char *)IObuff + 2, "python2") != NULL)
3978 {
3979 requires_py_version = 2;
3980 break;
3981 }
3982 if (strstr((char *)IObuff + 2, "python3") != NULL)
3983 {
3984 requires_py_version = 3;
3985 break;
3986 }
3987 }
3988 IObuff[21] = '\0';
3989 if (STRCMP("# requires python 2.x", IObuff) == 0)
3990 {
3991 requires_py_version = 2;
3992 break;
3993 }
3994 if (STRCMP("# requires python 3.x", IObuff) == 0)
3995 {
3996 requires_py_version = 3;
3997 break;
3998 }
3999 }
4000 fclose(file);
4001 }
4002 return requires_py_version;
4003}
4004
4005
4006/*
4007 * Source a python file using the requested python version.
4008 */
4009 static void
4010source_pyx_file(exarg_T *eap, char_u *fname)
4011{
4012 exarg_T ex;
4013 int v = requires_py_version(fname);
4014
4015# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4016 init_pyxversion();
4017# endif
4018 if (v == 0)
4019 {
4020# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4021 /* user didn't choose a preference, 'pyx' is used */
4022 v = p_pyx;
4023# elif defined(FEAT_PYTHON)
4024 v = 2;
4025# elif defined(FEAT_PYTHON3)
4026 v = 3;
4027# endif
4028 }
4029
4030 /*
4031 * now source, if required python version is not supported show
4032 * unobtrusive message.
4033 */
4034 if (eap == NULL)
4035 vim_memset(&ex, 0, sizeof(ex));
4036 else
4037 ex = *eap;
4038 ex.arg = fname;
4039 ex.cmd = (char_u *)(v == 2 ? "pyfile" : "pyfile3");
4040
4041 if (v == 2)
4042 {
4043# ifdef FEAT_PYTHON
4044 ex_pyfile(&ex);
4045# else
4046 vim_snprintf((char *)IObuff, IOSIZE,
4047 _("W20: Required python version 2.x not supported, ignoring file: %s"),
4048 fname);
4049 MSG(IObuff);
4050# endif
4051 return;
4052 }
4053 else
4054 {
4055# ifdef FEAT_PYTHON3
4056 ex_py3file(&ex);
4057# else
4058 vim_snprintf((char *)IObuff, IOSIZE,
4059 _("W21: Required python version 3.x not supported, ignoring file: %s"),
4060 fname);
4061 MSG(IObuff);
4062# endif
4063 return;
4064 }
4065}
4066
4067/*
4068 * ":pyxfile {fname}"
4069 */
4070 void
4071ex_pyxfile(exarg_T *eap)
4072{
4073 source_pyx_file(eap, eap->arg);
4074}
4075
4076/*
4077 * ":pyx"
4078 */
4079 void
4080ex_pyx(exarg_T *eap)
4081{
4082# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4083 init_pyxversion();
4084 if (p_pyx == 2)
4085 ex_python(eap);
4086 else
4087 ex_py3(eap);
4088# elif defined(FEAT_PYTHON)
4089 ex_python(eap);
4090# elif defined(FEAT_PYTHON3)
4091 ex_py3(eap);
4092# endif
4093}
4094
4095/*
4096 * ":pyxdo"
4097 */
4098 void
4099ex_pyxdo(exarg_T *eap)
4100{
4101# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4102 init_pyxversion();
4103 if (p_pyx == 2)
4104 ex_pydo(eap);
4105 else
4106 ex_py3do(eap);
4107# elif defined(FEAT_PYTHON)
4108 ex_pydo(eap);
4109# elif defined(FEAT_PYTHON3)
4110 ex_py3do(eap);
4111# endif
4112}
4113
4114#endif
4115
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116/*
4117 * ":source {fname}"
4118 */
4119 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004120ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121{
4122#ifdef FEAT_BROWSE
4123 if (cmdmod.browse)
4124 {
4125 char_u *fname = NULL;
4126
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00004127 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
4129 if (fname != NULL)
4130 {
4131 cmd_source(fname, eap);
4132 vim_free(fname);
4133 }
4134 }
4135 else
4136#endif
4137 cmd_source(eap->arg, eap);
4138}
4139
4140 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004141cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142{
4143 if (*fname == NUL)
4144 EMSG(_(e_argreq));
4145
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02004147 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004148 * Need to execute the commands directly. This is required at least
4149 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004150 * - ":g" command busy
4151 * - after ":argdo", ":windo" or ":bufdo"
4152 * - another command follows
4153 * - inside a loop
4154 */
4155 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
4156#ifdef FEAT_EVAL
4157 || eap->cstack->cs_idx >= 0
4158#endif
4159 );
4160
4161 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004162 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 EMSG2(_(e_notopen), fname);
4164}
4165
4166/*
4167 * ":source" and associated commands.
4168 */
4169/*
4170 * Structure used to store info for each sourced file.
4171 * It is shared between do_source() and getsourceline().
4172 * This is required, because it needs to be handed to do_cmdline() and
4173 * sourcing can be done recursively.
4174 */
4175struct source_cookie
4176{
4177 FILE *fp; /* opened file for sourcing */
4178 char_u *nextline; /* if not NULL: line that was read ahead */
4179 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004180#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
4182 int error; /* TRUE if LF found after CR-LF */
4183#endif
4184#ifdef FEAT_EVAL
4185 linenr_T breakpoint; /* next line with breakpoint or zero */
4186 char_u *fname; /* name of sourced file */
4187 int dbg_tick; /* debug_tick when breakpoint was set */
4188 int level; /* top nesting level of sourced file */
4189#endif
4190#ifdef FEAT_MBYTE
4191 vimconv_T conv; /* type of conversion */
4192#endif
4193};
4194
4195#ifdef FEAT_EVAL
4196/*
4197 * Return the address holding the next breakpoint line for a source cookie.
4198 */
4199 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004200source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004201{
4202 return &((struct source_cookie *)cookie)->breakpoint;
4203}
4204
4205/*
4206 * Return the address holding the debug tick for a source cookie.
4207 */
4208 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004209source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210{
4211 return &((struct source_cookie *)cookie)->dbg_tick;
4212}
4213
4214/*
4215 * Return the nesting level for a source cookie.
4216 */
4217 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004218source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219{
4220 return ((struct source_cookie *)cookie)->level;
4221}
4222#endif
4223
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004224static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004225
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004226#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
4227# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004228static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229
4230/*
4231 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004232 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 */
4234 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004235fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004237# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01004238 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
4239# else
4240 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004241# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242
4243 if (fd_tmp == -1)
4244 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004245
4246# ifdef HAVE_FD_CLOEXEC
4247 {
4248 int fdflags = fcntl(fd_tmp, F_GETFD);
4249 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02004250 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004251 }
4252# endif
4253
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254 return fdopen(fd_tmp, READBIN);
4255}
4256#endif
4257
4258
4259/*
4260 * do_source: Read the file "fname" and execute its lines as EX commands.
4261 *
4262 * This function may be called recursively!
4263 *
4264 * return FAIL if file could not be opened, OK otherwise
4265 */
4266 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004267do_source(
4268 char_u *fname,
4269 int check_other, /* check for .vimrc and _vimrc */
4270 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271{
4272 struct source_cookie cookie;
4273 char_u *save_sourcing_name;
4274 linenr_T save_sourcing_lnum;
4275 char_u *p;
4276 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00004277 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 int retval = FAIL;
4279#ifdef FEAT_EVAL
4280 scid_T save_current_SID;
4281 static scid_T last_current_SID = 0;
4282 void *save_funccalp;
4283 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004284 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02004286 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 int stat_ok;
4288# endif
4289#endif
4290#ifdef STARTUPTIME
4291 struct timeval tv_rel;
4292 struct timeval tv_start;
4293#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004294#ifdef FEAT_PROFILE
4295 proftime_T wait_start;
4296#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004299 if (p == NULL)
4300 return retval;
4301 fname_exp = fix_fname(p);
4302 vim_free(p);
4303 if (fname_exp == NULL)
4304 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 if (mch_isdir(fname_exp))
4306 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00004307 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 goto theend;
4309 }
4310
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004311#ifdef FEAT_AUTOCMD
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004312 /* Apply SourceCmd autocommands, they should get the file and source it. */
4313 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
4314 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
4315 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004316 {
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004317# ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004318 retval = aborting() ? FAIL : OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004319# else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004320 retval = OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004321# endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004322 goto theend;
4323 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004324
4325 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004326 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
4327#endif
4328
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004329#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4331#else
4332 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4333#endif
4334 if (cookie.fp == NULL && check_other)
4335 {
4336 /*
4337 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
4338 * and ".exrc" by "_exrc" or vice versa.
4339 */
4340 p = gettail(fname_exp);
4341 if ((*p == '.' || *p == '_')
4342 && (STRICMP(p + 1, "vimrc") == 0
4343 || STRICMP(p + 1, "gvimrc") == 0
4344 || STRICMP(p + 1, "exrc") == 0))
4345 {
4346 if (*p == '_')
4347 *p = '.';
4348 else
4349 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004350#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004351 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4352#else
4353 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4354#endif
4355 }
4356 }
4357
4358 if (cookie.fp == NULL)
4359 {
4360 if (p_verbose > 0)
4361 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004362 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004364 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004365 else
4366 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004367 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004368 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 }
4370 goto theend;
4371 }
4372
4373 /*
4374 * The file exists.
4375 * - In verbose mode, give a message.
4376 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
4377 */
4378 if (p_verbose > 1)
4379 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004380 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004382 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 else
4384 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004385 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004386 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004388 if (is_vimrc == DOSO_VIMRC)
4389 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
4390 else if (is_vimrc == DOSO_GVIMRC)
4391 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392
4393#ifdef USE_CRNL
4394 /* If no automatic file format: Set default to CR-NL. */
4395 if (*p_ffs == NUL)
4396 cookie.fileformat = EOL_DOS;
4397 else
4398 cookie.fileformat = EOL_UNKNOWN;
4399 cookie.error = FALSE;
4400#endif
4401
4402#ifdef USE_CR
4403 /* If no automatic file format: Set default to CR. */
4404 if (*p_ffs == NUL)
4405 cookie.fileformat = EOL_MAC;
4406 else
4407 cookie.fileformat = EOL_UNKNOWN;
4408 cookie.error = FALSE;
4409#endif
4410
4411 cookie.nextline = NULL;
4412 cookie.finished = FALSE;
4413
4414#ifdef FEAT_EVAL
4415 /*
4416 * Check if this script has a breakpoint.
4417 */
4418 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
4419 cookie.fname = fname_exp;
4420 cookie.dbg_tick = debug_tick;
4421
4422 cookie.level = ex_nesting_level;
4423#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424
4425 /*
4426 * Keep the sourcing name/lnum, for recursive calls.
4427 */
4428 save_sourcing_name = sourcing_name;
4429 sourcing_name = fname_exp;
4430 save_sourcing_lnum = sourcing_lnum;
4431 sourcing_lnum = 0;
4432
4433#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004434 if (time_fd != NULL)
4435 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436#endif
4437
4438#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00004439# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004440 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004441 prof_child_enter(&wait_start); /* entering a child now */
4442# endif
4443
4444 /* Don't use local function variables, if called from a function.
4445 * Also starts profiling timer for nested script. */
4446 save_funccalp = save_funccal();
4447
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 /*
4449 * Check if this script was sourced before to finds its SID.
4450 * If it's new, generate a new SID.
4451 */
4452 save_current_SID = current_SID;
4453# ifdef UNIX
4454 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
4455# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004456 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
4457 {
4458 si = &SCRIPT_ITEM(current_SID);
4459 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460 && (
4461# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00004462 /* Compare dev/ino when possible, it catches symbolic
4463 * links. Also compare file names, the inode may change
4464 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004465 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004466 && (si->sn_dev == st.st_dev
4467 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004469 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004471 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 if (current_SID == 0)
4473 {
4474 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004475 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
4476 == FAIL)
4477 goto almosttheend;
4478 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00004480 ++script_items.ga_len;
4481 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
4482# ifdef FEAT_PROFILE
4483 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004485 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004486 si = &SCRIPT_ITEM(current_SID);
4487 si->sn_name = fname_exp;
4488 fname_exp = NULL;
4489# ifdef UNIX
4490 if (stat_ok)
4491 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004492 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004493 si->sn_dev = st.st_dev;
4494 si->sn_ino = st.st_ino;
4495 }
4496 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004497 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004498# endif
4499
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 /* Allocate the local script variables to use for this script. */
4501 new_script_vars(current_SID);
4502 }
4503
Bram Moolenaar05159a02005-02-26 23:04:13 +00004504# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004505 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004506 {
4507 int forceit;
4508
4509 /* Check if we do profiling for this script. */
4510 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
4511 {
4512 script_do_profile(si);
4513 si->sn_pr_force = forceit;
4514 }
4515 if (si->sn_prof_on)
4516 {
4517 ++si->sn_pr_count;
4518 profile_start(&si->sn_pr_start);
4519 profile_zero(&si->sn_pr_children);
4520 }
4521 }
4522# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523#endif
4524
Bram Moolenaar67435d92017-10-19 21:04:37 +02004525#ifdef FEAT_MBYTE
4526 cookie.conv.vc_type = CONV_NONE; /* no conversion */
4527
4528 /* Read the first line so we can check for a UTF-8 BOM. */
4529 firstline = getsourceline(0, (void *)&cookie, 0);
4530 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
4531 && firstline[1] == 0xbb && firstline[2] == 0xbf)
4532 {
4533 /* Found BOM; setup conversion, skip over BOM and recode the line. */
4534 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
4535 p = string_convert(&cookie.conv, firstline + 3, NULL);
4536 if (p == NULL)
4537 p = vim_strsave(firstline + 3);
4538 if (p != NULL)
4539 {
4540 vim_free(firstline);
4541 firstline = p;
4542 }
4543 }
4544#endif
4545
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546 /*
4547 * Call do_cmdline, which will call getsourceline() to get the lines.
4548 */
Bram Moolenaar73881402009-02-04 16:50:47 +00004549 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004550 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004552
4553#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004554 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004555 {
4556 /* Get "si" again, "script_items" may have been reallocated. */
4557 si = &SCRIPT_ITEM(current_SID);
4558 if (si->sn_prof_on)
4559 {
4560 profile_end(&si->sn_pr_start);
4561 profile_sub_wait(&wait_start, &si->sn_pr_start);
4562 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004563 profile_self(&si->sn_pr_self, &si->sn_pr_start,
4564 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004565 }
4566 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567#endif
4568
4569 if (got_int)
4570 EMSG(_(e_interr));
4571 sourcing_name = save_sourcing_name;
4572 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 if (p_verbose > 1)
4574 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004575 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004576 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004578 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004579 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 }
4581#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004582 if (time_fd != NULL)
4583 {
4584 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4585 time_msg((char *)IObuff, &tv_start);
4586 time_pop(&tv_rel);
4587 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588#endif
4589
4590#ifdef FEAT_EVAL
4591 /*
4592 * After a "finish" in debug mode, need to break at first command of next
4593 * sourced file.
4594 */
4595 if (save_debug_break_level > ex_nesting_level
4596 && debug_break_level == ex_nesting_level)
4597 ++debug_break_level;
4598#endif
4599
Bram Moolenaar05159a02005-02-26 23:04:13 +00004600#ifdef FEAT_EVAL
4601almosttheend:
4602 current_SID = save_current_SID;
4603 restore_funccal(save_funccalp);
4604# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004605 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004606 prof_child_exit(&wait_start); /* leaving a child now */
4607# endif
4608#endif
4609 fclose(cookie.fp);
4610 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004611 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004612#ifdef FEAT_MBYTE
4613 convert_setup(&cookie.conv, NULL, NULL);
4614#endif
4615
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616theend:
4617 vim_free(fname_exp);
4618 return retval;
4619}
4620
4621#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004622
Bram Moolenaar071d4272004-06-13 20:20:40 +00004623/*
4624 * ":scriptnames"
4625 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004626 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004627ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628{
4629 int i;
4630
Bram Moolenaar05159a02005-02-26 23:04:13 +00004631 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4632 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004633 {
4634 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4635 NameBuff, MAXPATHL, TRUE);
4636 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004637 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638}
4639
4640# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4641/*
4642 * Fix slashes in the list of script names for 'shellslash'.
4643 */
4644 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004645scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646{
4647 int i;
4648
Bram Moolenaar05159a02005-02-26 23:04:13 +00004649 for (i = 1; i <= script_items.ga_len; ++i)
4650 if (SCRIPT_ITEM(i).sn_name != NULL)
4651 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652}
4653# endif
4654
4655/*
4656 * Get a pointer to a script name. Used for ":verbose set".
4657 */
4658 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004659get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660{
4661 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004662 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004664 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004666 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004668 return (char_u *)_("environment variable");
4669 if (id == SID_ERROR)
4670 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004671 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004673
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004674# if defined(EXITFREE) || defined(PROTO)
4675 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004676free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004677{
4678 int i;
4679
4680 for (i = script_items.ga_len; i > 0; --i)
4681 vim_free(SCRIPT_ITEM(i).sn_name);
4682 ga_clear(&script_items);
4683}
4684# endif
4685
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686#endif
4687
4688#if defined(USE_CR) || defined(PROTO)
4689
4690# if defined(__MSL__) && (__MSL__ >= 22)
4691/*
4692 * Newer version of the Metrowerks library handle DOS and UNIX files
4693 * without help.
4694 * Test with earlier versions, MSL 2.2 is the library supplied with
4695 * Codewarrior Pro 2.
4696 */
4697 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004698fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699{
4700 return fgets(s, n, stream);
4701}
4702# else
4703/*
4704 * Version of fgets() which also works for lines ending in a <CR> only
4705 * (Macintosh format).
4706 * For older versions of the Metrowerks library.
4707 * At least CodeWarrior 9 needed this code.
4708 */
4709 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004710fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004711{
4712 int c = 0;
4713 int char_read = 0;
4714
4715 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4716 {
4717 c = fgetc(stream);
4718 s[char_read++] = c;
4719 /* If the file is in DOS format, we need to skip a NL after a CR. I
4720 * thought it was the other way around, but this appears to work... */
4721 if (c == '\n')
4722 {
4723 c = fgetc(stream);
4724 if (c != '\r')
4725 ungetc(c, stream);
4726 }
4727 }
4728
4729 s[char_read] = 0;
4730 if (char_read == 0)
4731 return NULL;
4732
4733 if (feof(stream) && char_read == 1)
4734 return NULL;
4735
4736 return s;
4737}
4738# endif
4739#endif
4740
4741/*
4742 * Get one full line from a sourced file.
4743 * Called by do_cmdline() when it's called from do_source().
4744 *
4745 * Return a pointer to the line in allocated memory.
4746 * Return NULL for end-of-file or some error.
4747 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004748 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004749getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750{
4751 struct source_cookie *sp = (struct source_cookie *)cookie;
4752 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004753 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754
4755#ifdef FEAT_EVAL
4756 /* If breakpoints have been added/deleted need to check for it. */
4757 if (sp->dbg_tick < debug_tick)
4758 {
4759 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4760 sp->dbg_tick = debug_tick;
4761 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004762# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004763 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004764 script_line_end();
4765# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766#endif
4767 /*
4768 * Get current line. If there is a read-ahead line, use it, otherwise get
4769 * one now.
4770 */
4771 if (sp->finished)
4772 line = NULL;
4773 else if (sp->nextline == NULL)
4774 line = get_one_sourceline(sp);
4775 else
4776 {
4777 line = sp->nextline;
4778 sp->nextline = NULL;
4779 ++sourcing_lnum;
4780 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004781#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004782 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004783 script_line_start();
4784#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004785
4786 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4787 * contain the 'C' flag. */
4788 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4789 {
4790 /* compensate for the one line read-ahead */
4791 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004792
4793 /* Get the next line and concatenate it when it starts with a
4794 * backslash. We always need to read the next line, keep it in
4795 * sp->nextline. */
4796 sp->nextline = get_one_sourceline(sp);
4797 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004798 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004799 garray_T ga;
4800
Bram Moolenaarb549a732012-02-22 18:29:33 +01004801 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004802 ga_concat(&ga, line);
4803 ga_concat(&ga, p + 1);
4804 for (;;)
4805 {
4806 vim_free(sp->nextline);
4807 sp->nextline = get_one_sourceline(sp);
4808 if (sp->nextline == NULL)
4809 break;
4810 p = skipwhite(sp->nextline);
4811 if (*p != '\\')
4812 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004813 /* Adjust the growsize to the current length to speed up
4814 * concatenating many lines. */
4815 if (ga.ga_len > 400)
4816 {
4817 if (ga.ga_len > 8000)
4818 ga.ga_growsize = 8000;
4819 else
4820 ga.ga_growsize = ga.ga_len;
4821 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004822 ga_concat(&ga, p + 1);
4823 }
4824 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004825 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004826 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827 }
4828 }
4829
4830#ifdef FEAT_MBYTE
4831 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4832 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004833 char_u *s;
4834
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 /* Convert the encoding of the script line. */
4836 s = string_convert(&sp->conv, line, NULL);
4837 if (s != NULL)
4838 {
4839 vim_free(line);
4840 line = s;
4841 }
4842 }
4843#endif
4844
4845#ifdef FEAT_EVAL
4846 /* Did we encounter a breakpoint? */
4847 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4848 {
4849 dbg_breakpoint(sp->fname, sourcing_lnum);
4850 /* Find next breakpoint. */
4851 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4852 sp->dbg_tick = debug_tick;
4853 }
4854#endif
4855
4856 return line;
4857}
4858
4859 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004860get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861{
4862 garray_T ga;
4863 int len;
4864 int c;
4865 char_u *buf;
4866#ifdef USE_CRNL
4867 int has_cr; /* CR-LF found */
4868#endif
4869#ifdef USE_CR
4870 char_u *scan;
4871#endif
4872 int have_read = FALSE;
4873
4874 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004875 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876
4877 /*
4878 * Loop until there is a finished line (or end-of-file).
4879 */
4880 sourcing_lnum++;
4881 for (;;)
4882 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004883 /* make room to read at least 120 (more) characters */
4884 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885 break;
4886 buf = (char_u *)ga.ga_data;
4887
4888#ifdef USE_CR
4889 if (sp->fileformat == EOL_MAC)
4890 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004891 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4892 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 break;
4894 }
4895 else
4896#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004897 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4898 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004900 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901#ifdef USE_CRNL
4902 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4903 * CTRL-Z by its own, or after a NL. */
4904 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4905 && sp->fileformat == EOL_DOS
4906 && buf[len - 1] == Ctrl_Z)
4907 {
4908 buf[len - 1] = NUL;
4909 break;
4910 }
4911#endif
4912
4913#ifdef USE_CR
4914 /* If the read doesn't stop on a new line, and there's
4915 * some CR then we assume a Mac format */
4916 if (sp->fileformat == EOL_UNKNOWN)
4917 {
4918 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4919 sp->fileformat = EOL_MAC;
4920 else
4921 sp->fileformat = EOL_UNIX;
4922 }
4923
4924 if (sp->fileformat == EOL_MAC)
4925 {
4926 scan = vim_strchr(buf, '\r');
4927
4928 if (scan != NULL)
4929 {
4930 *scan = '\n';
4931 if (*(scan + 1) != 0)
4932 {
4933 *(scan + 1) = 0;
4934 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4935 }
4936 }
4937 len = STRLEN(buf);
4938 }
4939#endif
4940
4941 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004942 ga.ga_len = len;
4943
4944 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004945 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004946 continue;
4947
4948 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4949 {
4950#ifdef USE_CRNL
4951 has_cr = (len >= 2 && buf[len - 2] == '\r');
4952 if (sp->fileformat == EOL_UNKNOWN)
4953 {
4954 if (has_cr)
4955 sp->fileformat = EOL_DOS;
4956 else
4957 sp->fileformat = EOL_UNIX;
4958 }
4959
4960 if (sp->fileformat == EOL_DOS)
4961 {
4962 if (has_cr) /* replace trailing CR */
4963 {
4964 buf[len - 2] = '\n';
4965 --len;
4966 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 }
4968 else /* lines like ":map xx yy^M" will have failed */
4969 {
4970 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004971 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01004972 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004974 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 sp->error = TRUE;
4976 sp->fileformat = EOL_UNIX;
4977 }
4978 }
4979#endif
4980 /* The '\n' is escaped if there is an odd number of ^V's just
4981 * before it, first set "c" just before the 'V's and then check
4982 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
4983 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
4984 ;
4985 if ((len & 1) != (c & 1)) /* escaped NL, read more */
4986 {
4987 sourcing_lnum++;
4988 continue;
4989 }
4990
4991 buf[len - 1] = NUL; /* remove the NL */
4992 }
4993
4994 /*
4995 * Check for ^C here now and then, so recursive :so can be broken.
4996 */
4997 line_breakcheck();
4998 break;
4999 }
5000
5001 if (have_read)
5002 return (char_u *)ga.ga_data;
5003
5004 vim_free(ga.ga_data);
5005 return NULL;
5006}
5007
Bram Moolenaar05159a02005-02-26 23:04:13 +00005008#if defined(FEAT_PROFILE) || defined(PROTO)
5009/*
5010 * Called when starting to read a script line.
5011 * "sourcing_lnum" must be correct!
5012 * When skipping lines it may not actually be executed, but we won't find out
5013 * until later and we need to store the time now.
5014 */
5015 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005016script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005017{
5018 scriptitem_T *si;
5019 sn_prl_T *pp;
5020
5021 if (current_SID <= 0 || current_SID > script_items.ga_len)
5022 return;
5023 si = &SCRIPT_ITEM(current_SID);
5024 if (si->sn_prof_on && sourcing_lnum >= 1)
5025 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005026 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00005027 * here isn't counted. */
Bram Moolenaar67435d92017-10-19 21:04:37 +02005028 (void)ga_grow(&si->sn_prl_ga,
5029 (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00005030 si->sn_prl_idx = sourcing_lnum - 1;
5031 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
5032 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
5033 {
5034 /* Zero counters for a line that was not used before. */
5035 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
5036 pp->snp_count = 0;
5037 profile_zero(&pp->sn_prl_total);
5038 profile_zero(&pp->sn_prl_self);
5039 ++si->sn_prl_ga.ga_len;
5040 }
5041 si->sn_prl_execed = FALSE;
5042 profile_start(&si->sn_prl_start);
5043 profile_zero(&si->sn_prl_children);
5044 profile_get_wait(&si->sn_prl_wait);
5045 }
5046}
5047
5048/*
5049 * Called when actually executing a function line.
5050 */
5051 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005052script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005053{
5054 scriptitem_T *si;
5055
5056 if (current_SID <= 0 || current_SID > script_items.ga_len)
5057 return;
5058 si = &SCRIPT_ITEM(current_SID);
5059 if (si->sn_prof_on && si->sn_prl_idx >= 0)
5060 si->sn_prl_execed = TRUE;
5061}
5062
5063/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02005064 * Called when done with a script line.
Bram Moolenaar05159a02005-02-26 23:04:13 +00005065 */
5066 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005067script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005068{
5069 scriptitem_T *si;
5070 sn_prl_T *pp;
5071
5072 if (current_SID <= 0 || current_SID > script_items.ga_len)
5073 return;
5074 si = &SCRIPT_ITEM(current_SID);
5075 if (si->sn_prof_on && si->sn_prl_idx >= 0
5076 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
5077 {
5078 if (si->sn_prl_execed)
5079 {
5080 pp = &PRL_ITEM(si, si->sn_prl_idx);
5081 ++pp->snp_count;
5082 profile_end(&si->sn_prl_start);
5083 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005084 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00005085 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
5086 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005087 }
5088 si->sn_prl_idx = -1;
5089 }
5090}
5091#endif
5092
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093/*
5094 * ":scriptencoding": Set encoding conversion for a sourced script.
5095 * Without the multi-byte feature it's simply ignored.
5096 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005098ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005099{
5100#ifdef FEAT_MBYTE
5101 struct source_cookie *sp;
5102 char_u *name;
5103
5104 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
5105 {
5106 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
5107 return;
5108 }
5109
5110 if (*eap->arg != NUL)
5111 {
5112 name = enc_canonize(eap->arg);
5113 if (name == NULL) /* out of memory */
5114 return;
5115 }
5116 else
5117 name = eap->arg;
5118
5119 /* Setup for conversion from the specified encoding to 'encoding'. */
5120 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
5121 convert_setup(&sp->conv, name, p_enc);
5122
5123 if (name != eap->arg)
5124 vim_free(name);
5125#endif
5126}
5127
5128#if defined(FEAT_EVAL) || defined(PROTO)
5129/*
5130 * ":finish": Mark a sourced file as finished.
5131 */
5132 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005133ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005134{
5135 if (getline_equal(eap->getline, eap->cookie, getsourceline))
5136 do_finish(eap, FALSE);
5137 else
5138 EMSG(_("E168: :finish used outside of a sourced file"));
5139}
5140
5141/*
5142 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
5143 * Also called for a pending finish at the ":endtry" or after returning from
5144 * an extra do_cmdline(). "reanimate" is used in the latter case.
5145 */
5146 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005147do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148{
5149 int idx;
5150
5151 if (reanimate)
5152 ((struct source_cookie *)getline_cookie(eap->getline,
5153 eap->cookie))->finished = FALSE;
5154
5155 /*
5156 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5157 * not in its finally clause (which then is to be executed next) is found.
5158 * In this case, make the ":finish" pending for execution at the ":endtry".
5159 * Otherwise, finish normally.
5160 */
5161 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5162 if (idx >= 0)
5163 {
5164 eap->cstack->cs_pending[idx] = CSTP_FINISH;
5165 report_make_pending(CSTP_FINISH, NULL);
5166 }
5167 else
5168 ((struct source_cookie *)getline_cookie(eap->getline,
5169 eap->cookie))->finished = TRUE;
5170}
5171
5172
5173/*
5174 * Return TRUE when a sourced file had the ":finish" command: Don't give error
5175 * message for missing ":endif".
5176 * Return FALSE when not sourcing a file.
5177 */
5178 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005179source_finished(
5180 char_u *(*fgetline)(int, void *, int),
5181 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182{
Bram Moolenaar89d40322006-08-29 15:30:07 +00005183 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00005185 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186}
5187#endif
5188
5189#if defined(FEAT_LISTCMDS) || defined(PROTO)
5190/*
5191 * ":checktime [buffer]"
5192 */
5193 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005194ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195{
5196 buf_T *buf;
5197 int save_no_check_timestamps = no_check_timestamps;
5198
5199 no_check_timestamps = 0;
5200 if (eap->addr_count == 0) /* default is all buffers */
5201 check_timestamps(FALSE);
5202 else
5203 {
5204 buf = buflist_findnr((int)eap->line2);
5205 if (buf != NULL) /* cannot happen? */
5206 (void)buf_check_timestamp(buf, FALSE);
5207 }
5208 no_check_timestamps = save_no_check_timestamps;
5209}
5210#endif
5211
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5213 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005214# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005215static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005217 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005218get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005220 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221
Bram Moolenaar48e330a2016-02-23 14:53:34 +01005222 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005223 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005225# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 if (loc != NULL)
5227 {
5228 char_u *p;
5229
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005230 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
5231 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 p = vim_strchr(loc, '=');
5233 if (p != NULL)
5234 {
5235 loc = ++p;
5236 while (*p != NUL) /* remove trailing newline */
5237 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005238 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 {
5240 *p = NUL;
5241 break;
5242 }
5243 ++p;
5244 }
5245 }
5246 }
5247# endif
5248
5249 return loc;
5250}
5251#endif
5252
5253
5254#ifdef WIN32
5255/*
5256 * On MS-Windows locale names are strings like "German_Germany.1252", but
5257 * gettext expects "de". Try to translate one into another here for a few
5258 * supported languages.
5259 */
5260 static char_u *
5261gettext_lang(char_u *name)
5262{
5263 int i;
5264 static char *(mtable[]) = {
5265 "afrikaans", "af",
5266 "czech", "cs",
5267 "dutch", "nl",
5268 "german", "de",
5269 "english_united kingdom", "en_GB",
5270 "spanish", "es",
5271 "french", "fr",
5272 "italian", "it",
5273 "japanese", "ja",
5274 "korean", "ko",
5275 "norwegian", "no",
5276 "polish", "pl",
5277 "russian", "ru",
5278 "slovak", "sk",
5279 "swedish", "sv",
5280 "ukrainian", "uk",
5281 "chinese_china", "zh_CN",
5282 "chinese_taiwan", "zh_TW",
5283 NULL};
5284
5285 for (i = 0; mtable[i] != NULL; i += 2)
5286 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005287 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005288 return name;
5289}
5290#endif
5291
5292#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5293/*
5294 * Obtain the current messages language. Used to set the default for
5295 * 'helplang'. May return NULL or an empty string.
5296 */
5297 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005298get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299{
5300 char_u *p;
5301
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005302# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005304 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305# else
5306 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005307 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
5308 * and LC_MONETARY may be set differently for a Japanese working in the
5309 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005310 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311# endif
5312# else
5313 p = mch_getenv((char_u *)"LC_ALL");
5314 if (p == NULL || *p == NUL)
5315 {
5316 p = mch_getenv((char_u *)"LC_MESSAGES");
5317 if (p == NULL || *p == NUL)
5318 p = mch_getenv((char_u *)"LANG");
5319 }
5320# endif
5321# ifdef WIN32
5322 p = gettext_lang(p);
5323# endif
5324 return p;
5325}
5326#endif
5327
Bram Moolenaardef9e822004-12-31 20:58:58 +00005328/* Complicated #if; matches with where get_mess_env() is used below. */
5329#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5330 && defined(LC_MESSAGES))) \
5331 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5332 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
5333 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01005334static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005335
5336/*
5337 * Get the language used for messages from the environment.
5338 */
5339 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005340get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341{
5342 char_u *p;
5343
5344 p = mch_getenv((char_u *)"LC_ALL");
5345 if (p == NULL || *p == NUL)
5346 {
5347 p = mch_getenv((char_u *)"LC_MESSAGES");
5348 if (p == NULL || *p == NUL)
5349 {
5350 p = mch_getenv((char_u *)"LANG");
5351 if (p != NULL && VIM_ISDIGIT(*p))
5352 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005353# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005355 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356# endif
5357 }
5358 }
5359 return p;
5360}
5361#endif
5362
5363#if defined(FEAT_EVAL) || defined(PROTO)
5364
5365/*
5366 * Set the "v:lang" variable according to the current locale setting.
5367 * Also do "v:lc_time"and "v:ctype".
5368 */
5369 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005370set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371{
5372 char_u *loc;
5373
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005374# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005375 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376# else
5377 /* setlocale() not supported: use the default value */
5378 loc = (char_u *)"C";
5379# endif
5380 set_vim_var_string(VV_CTYPE, loc, -1);
5381
5382 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
5383 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005384# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005385 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005386# else
5387 loc = get_mess_env();
5388# endif
5389 set_vim_var_string(VV_LANG, loc, -1);
5390
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005391# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005392 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393# endif
5394 set_vim_var_string(VV_LC_TIME, loc, -1);
5395}
5396#endif
5397
5398#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5399 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
5400/*
5401 * ":language": Set the language (locale).
5402 */
5403 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005404ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405{
5406 char *loc;
5407 char_u *p;
5408 char_u *name;
5409 int what = LC_ALL;
5410 char *whatstr = "";
5411#ifdef LC_MESSAGES
5412# define VIM_LC_MESSAGES LC_MESSAGES
5413#else
5414# define VIM_LC_MESSAGES 6789
5415#endif
5416
5417 name = eap->arg;
5418
5419 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
5420 * Allow abbreviation, but require at least 3 characters to avoid
5421 * confusion with a two letter language name "me" or "ct". */
5422 p = skiptowhite(eap->arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005423 if ((*p == NUL || VIM_ISWHITE(*p)) && p - eap->arg >= 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 {
5425 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
5426 {
5427 what = VIM_LC_MESSAGES;
5428 name = skipwhite(p);
5429 whatstr = "messages ";
5430 }
5431 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
5432 {
5433 what = LC_CTYPE;
5434 name = skipwhite(p);
5435 whatstr = "ctype ";
5436 }
5437 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
5438 {
5439 what = LC_TIME;
5440 name = skipwhite(p);
5441 whatstr = "time ";
5442 }
5443 }
5444
5445 if (*name == NUL)
5446 {
5447#ifndef LC_MESSAGES
5448 if (what == VIM_LC_MESSAGES)
5449 p = get_mess_env();
5450 else
5451#endif
5452 p = (char_u *)setlocale(what, NULL);
5453 if (p == NULL || *p == NUL)
5454 p = (char_u *)"Unknown";
5455 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
5456 }
5457 else
5458 {
5459#ifndef LC_MESSAGES
5460 if (what == VIM_LC_MESSAGES)
5461 loc = "";
5462 else
5463#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005464 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005465 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005466#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
5467 /* Make sure strtod() uses a decimal point, not a comma. */
5468 setlocale(LC_NUMERIC, "C");
5469#endif
5470 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 if (loc == NULL)
5472 EMSG2(_("E197: Cannot set language to \"%s\""), name);
5473 else
5474 {
5475#ifdef HAVE_NL_MSG_CAT_CNTR
5476 /* Need to do this for GNU gettext, otherwise cached translations
5477 * will be used again. */
5478 extern int _nl_msg_cat_cntr;
5479
5480 ++_nl_msg_cat_cntr;
5481#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00005482 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
5484
5485 if (what != LC_TIME)
5486 {
5487 /* Tell gettext() what to translate to. It apparently doesn't
5488 * use the currently effective locale. Also do this when
5489 * FEAT_GETTEXT isn't defined, so that shell commands use this
5490 * value. */
5491 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005492 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02005494
5495 /* Clear $LANGUAGE because GNU gettext uses it. */
5496 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005497# ifdef WIN32
5498 /* Apparently MS-Windows printf() may cause a crash when
5499 * we give it 8-bit text while it's expecting text in the
5500 * current locale. This call avoids that. */
5501 setlocale(LC_CTYPE, "C");
5502# endif
5503 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 if (what != LC_CTYPE)
5505 {
5506 char_u *mname;
5507#ifdef WIN32
5508 mname = gettext_lang(name);
5509#else
5510 mname = name;
5511#endif
5512 vim_setenv((char_u *)"LC_MESSAGES", mname);
5513#ifdef FEAT_MULTI_LANG
5514 set_helplang_default(mname);
5515#endif
5516 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 }
5518
5519# ifdef FEAT_EVAL
5520 /* Set v:lang, v:lc_time and v:ctype to the final result. */
5521 set_lang_var();
5522# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02005523# ifdef FEAT_TITLE
5524 maketitle();
5525# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 }
5527 }
5528}
5529
5530# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005531
5532static char_u **locales = NULL; /* Array of all available locales */
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005533
5534# ifndef WIN32
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005535static int did_init_locales = FALSE;
5536
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005537/* Return an array of strings for all available locales + NULL for the
5538 * last element. Return NULL in case of error. */
5539 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005540find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005541{
5542 garray_T locales_ga;
5543 char_u *loc;
5544
5545 /* Find all available locales by running command "locale -a". If this
5546 * doesn't work we won't have completion. */
5547 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02005548 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005549 if (locale_a == NULL)
5550 return NULL;
5551 ga_init2(&locales_ga, sizeof(char_u *), 20);
5552
5553 /* Transform locale_a string where each locale is separated by "\n"
5554 * into an array of locale strings. */
5555 loc = (char_u *)strtok((char *)locale_a, "\n");
5556
5557 while (loc != NULL)
5558 {
5559 if (ga_grow(&locales_ga, 1) == FAIL)
5560 break;
5561 loc = vim_strsave(loc);
5562 if (loc == NULL)
5563 break;
5564
5565 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5566 loc = (char_u *)strtok(NULL, "\n");
5567 }
5568 vim_free(locale_a);
5569 if (ga_grow(&locales_ga, 1) == FAIL)
5570 {
5571 ga_clear(&locales_ga);
5572 return NULL;
5573 }
5574 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5575 return (char_u **)locales_ga.ga_data;
5576}
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005577# endif
5578
5579/*
5580 * Lazy initialization of all available locales.
5581 */
5582 static void
5583init_locales(void)
5584{
5585# ifndef WIN32
5586 if (!did_init_locales)
5587 {
5588 did_init_locales = TRUE;
5589 locales = find_locales();
5590 }
5591# endif
5592}
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005593
5594# if defined(EXITFREE) || defined(PROTO)
5595 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005596free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005597{
5598 int i;
5599 if (locales != NULL)
5600 {
5601 for (i = 0; locales[i] != NULL; i++)
5602 vim_free(locales[i]);
Bram Moolenaard23a8232018-02-10 18:45:26 +01005603 VIM_CLEAR(locales);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005604 }
5605}
5606# endif
5607
Bram Moolenaar071d4272004-06-13 20:20:40 +00005608/*
5609 * Function given to ExpandGeneric() to obtain the possible arguments of the
5610 * ":language" command.
5611 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005613get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614{
5615 if (idx == 0)
5616 return (char_u *)"messages";
5617 if (idx == 1)
5618 return (char_u *)"ctype";
5619 if (idx == 2)
5620 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005621
5622 init_locales();
5623 if (locales == NULL)
5624 return NULL;
5625 return locales[idx - 3];
5626}
5627
5628/*
5629 * Function given to ExpandGeneric() to obtain the available locales.
5630 */
5631 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005632get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005633{
5634 init_locales();
5635 if (locales == NULL)
5636 return NULL;
5637 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005638}
5639# endif
5640
5641#endif