blob: a58b955f3c7b2eb594ebf5e22d7f3a9e88fdbe5d [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/*
Bram Moolenaare0be1672018-07-08 16:50:37 +0200692 * ":breakadd". Also used for ":profile".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693 */
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 Moolenaar56bc8e22018-05-10 18:05:56 +02001209 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 Moolenaarb0f42ba2018-05-12 15:38:26 +02001339 /* Save and restore a lot of flags, because the timer fires while
1340 * waiting for a character, which might be halfway a command. */
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001341 int save_timer_busy = timer_busy;
1342 int save_vgetc_busy = vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001343 int save_did_emsg = did_emsg;
1344 int save_called_emsg = called_emsg;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001345 int save_must_redraw = must_redraw;
Bram Moolenaare723c422017-09-06 23:40:10 +02001346 int save_trylevel = trylevel;
1347 int save_did_throw = did_throw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001348 int save_ex_pressedreturn = get_pressedreturn();
Bram Moolenaare723c422017-09-06 23:40:10 +02001349 except_T *save_current_exception = current_exception;
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02001350 vimvars_save_T vvsave;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001351
Bram Moolenaare723c422017-09-06 23:40:10 +02001352 /* Create a scope for running the timer callback, ignoring most of
1353 * the current scope, such as being inside a try/catch. */
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001354 timer_busy = timer_busy > 0 || vgetc_busy > 0;
1355 vgetc_busy = 0;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001356 called_emsg = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001357 did_emsg = FALSE;
1358 did_uncaught_emsg = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001359 must_redraw = 0;
Bram Moolenaare723c422017-09-06 23:40:10 +02001360 trylevel = 0;
1361 did_throw = FALSE;
1362 current_exception = NULL;
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02001363 save_vimvars(&vvsave);
Bram Moolenaare723c422017-09-06 23:40:10 +02001364
Bram Moolenaar75537a92016-09-05 22:45:28 +02001365 timer->tr_firing = TRUE;
1366 timer_callback(timer);
1367 timer->tr_firing = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001368
Bram Moolenaar75537a92016-09-05 22:45:28 +02001369 timer_next = timer->tr_next;
1370 did_one = TRUE;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001371 timer_busy = save_timer_busy;
1372 vgetc_busy = save_vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001373 if (did_uncaught_emsg)
Bram Moolenaarc577d812017-07-08 22:37:34 +02001374 ++timer->tr_emsg_count;
Bram Moolenaare723c422017-09-06 23:40:10 +02001375 did_emsg = save_did_emsg;
1376 called_emsg = save_called_emsg;
1377 trylevel = save_trylevel;
1378 did_throw = save_did_throw;
1379 current_exception = save_current_exception;
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02001380 restore_vimvars(&vvsave);
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001381 if (must_redraw != 0)
1382 need_update_screen = TRUE;
1383 must_redraw = must_redraw > save_must_redraw
1384 ? must_redraw : save_must_redraw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001385 set_pressedreturn(save_ex_pressedreturn);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001386
1387 /* Only fire the timer again if it repeats and stop_timer() wasn't
1388 * called while inside the callback (tr_id == -1). */
Bram Moolenaarc577d812017-07-08 22:37:34 +02001389 if (timer->tr_repeat != 0 && timer->tr_id != -1
1390 && timer->tr_emsg_count < 3)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001391 {
1392 profile_setlimit(timer->tr_interval, &timer->tr_due);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001393 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001394 if (this_due < 1)
1395 this_due = 1;
1396 if (timer->tr_repeat > 0)
1397 --timer->tr_repeat;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001398 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001399 else
1400 {
1401 this_due = -1;
1402 remove_timer(timer);
1403 free_timer(timer);
1404 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001405 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001406 if (this_due > 0 && (next_due == -1 || next_due > this_due))
1407 next_due = this_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001408 }
1409
1410 if (did_one)
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001411 redraw_after_callback(need_update_screen);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001412
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01001413#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001414 if (bevalexpr_due_set)
1415 {
1416 this_due = proftime_time_left(&bevalexpr_due, &now);
1417 if (this_due <= 1)
1418 {
1419 bevalexpr_due_set = FALSE;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001420 if (balloonEval == NULL)
1421 {
Bram Moolenaarca4b6132018-06-28 12:05:11 +02001422 balloonEval = (BalloonEval *)alloc_clear(sizeof(BalloonEval));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001423 balloonEvalForTerm = TRUE;
1424 }
1425 if (balloonEval != NULL)
1426 general_beval_cb(balloonEval, 0);
1427 }
Bram Moolenaar1c17ffa2018-04-24 15:19:04 +02001428 else if (next_due == -1 || next_due > this_due)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001429 next_due = this_due;
1430 }
1431#endif
Bram Moolenaar56bc8e22018-05-10 18:05:56 +02001432#ifdef FEAT_TERMINAL
1433 /* Some terminal windows may need their buffer updated. */
1434 next_due = term_check_timers(next_due, &now);
1435#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001436
Bram Moolenaar75537a92016-09-05 22:45:28 +02001437 return current_id != last_timer_id ? 1 : next_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001438}
1439
1440/*
1441 * Find a timer by ID. Returns NULL if not found;
1442 */
1443 timer_T *
Bram Moolenaar75537a92016-09-05 22:45:28 +02001444find_timer(long id)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001445{
1446 timer_T *timer;
1447
Bram Moolenaar75537a92016-09-05 22:45:28 +02001448 if (id >= 0)
1449 {
1450 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1451 if (timer->tr_id == id)
1452 return timer;
1453 }
1454 return NULL;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001455}
1456
1457
1458/*
1459 * Stop a timer and delete it.
1460 */
1461 void
1462stop_timer(timer_T *timer)
1463{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001464 if (timer->tr_firing)
1465 /* Free the timer after the callback returns. */
1466 timer->tr_id = -1;
1467 else
1468 {
1469 remove_timer(timer);
1470 free_timer(timer);
1471 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001472}
Bram Moolenaare3188e22016-05-31 21:13:04 +02001473
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001474 void
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001475stop_all_timers(void)
1476{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001477 timer_T *timer;
1478 timer_T *timer_next;
1479
1480 for (timer = first_timer; timer != NULL; timer = timer_next)
1481 {
1482 timer_next = timer->tr_next;
1483 stop_timer(timer);
1484 }
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001485}
1486
1487 void
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001488add_timer_info(typval_T *rettv, timer_T *timer)
1489{
1490 list_T *list = rettv->vval.v_list;
1491 dict_T *dict = dict_alloc();
1492 dictitem_T *di;
1493 long remaining;
1494 proftime_T now;
1495
1496 if (dict == NULL)
1497 return;
1498 list_append_dict(list, dict);
1499
Bram Moolenaare0be1672018-07-08 16:50:37 +02001500 dict_add_number(dict, "id", timer->tr_id);
1501 dict_add_number(dict, "time", (long)timer->tr_interval);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001502
1503 profile_start(&now);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001504 remaining = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaare0be1672018-07-08 16:50:37 +02001505 dict_add_number(dict, "remaining", (long)remaining);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001506
Bram Moolenaare0be1672018-07-08 16:50:37 +02001507 dict_add_number(dict, "repeat",
1508 (long)(timer->tr_repeat < 0 ? -1 : timer->tr_repeat + 1));
1509 dict_add_number(dict, "paused", (long)(timer->tr_paused));
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001510
1511 di = dictitem_alloc((char_u *)"callback");
1512 if (di != NULL)
1513 {
1514 if (dict_add(dict, di) == FAIL)
1515 vim_free(di);
1516 else if (timer->tr_partial != NULL)
1517 {
1518 di->di_tv.v_type = VAR_PARTIAL;
1519 di->di_tv.vval.v_partial = timer->tr_partial;
1520 ++timer->tr_partial->pt_refcount;
1521 }
1522 else
1523 {
1524 di->di_tv.v_type = VAR_FUNC;
1525 di->di_tv.vval.v_string = vim_strsave(timer->tr_callback);
1526 }
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001527 }
1528}
1529
1530 void
1531add_timer_info_all(typval_T *rettv)
1532{
1533 timer_T *timer;
1534
1535 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001536 if (timer->tr_id != -1)
1537 add_timer_info(rettv, timer);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001538}
1539
Bram Moolenaare3188e22016-05-31 21:13:04 +02001540/*
1541 * Mark references in partials of timers.
1542 */
1543 int
1544set_ref_in_timer(int copyID)
1545{
1546 int abort = FALSE;
1547 timer_T *timer;
1548 typval_T tv;
1549
1550 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1551 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001552 if (timer->tr_partial != NULL)
1553 {
1554 tv.v_type = VAR_PARTIAL;
1555 tv.vval.v_partial = timer->tr_partial;
1556 }
1557 else
1558 {
1559 tv.v_type = VAR_FUNC;
1560 tv.vval.v_string = timer->tr_callback;
1561 }
Bram Moolenaare3188e22016-05-31 21:13:04 +02001562 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
1563 }
1564 return abort;
1565}
Bram Moolenaar623e2632016-07-30 22:47:56 +02001566
1567# if defined(EXITFREE) || defined(PROTO)
1568 void
1569timer_free_all()
1570{
1571 timer_T *timer;
1572
1573 while (first_timer != NULL)
1574 {
1575 timer = first_timer;
1576 remove_timer(timer);
1577 free_timer(timer);
1578 }
1579}
1580# endif
Bram Moolenaar975b5272016-03-15 23:10:59 +01001581# endif
1582
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001583#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1584# if defined(HAVE_MATH_H)
1585# include <math.h>
1586# endif
1587
1588/*
1589 * Divide the time "tm" by "count" and store in "tm2".
1590 */
1591 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001592profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001593{
1594 if (count == 0)
1595 profile_zero(tm2);
1596 else
1597 {
1598# ifdef WIN3264
1599 tm2->QuadPart = tm->QuadPart / count;
1600# else
1601 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1602
1603 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001604 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001605# endif
1606 }
1607}
1608#endif
1609
Bram Moolenaar76929292008-01-06 19:07:36 +00001610# if defined(FEAT_PROFILE) || defined(PROTO)
1611/*
1612 * Functions for profiling.
1613 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001614static void script_do_profile(scriptitem_T *si);
1615static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001616static proftime_T prof_wait_time;
1617
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001618/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001619 * Add the time "tm2" to "tm".
1620 */
1621 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001622profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001623{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001624# ifdef WIN3264
1625 tm->QuadPart += tm2->QuadPart;
1626# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001627 tm->tv_usec += tm2->tv_usec;
1628 tm->tv_sec += tm2->tv_sec;
1629 if (tm->tv_usec >= 1000000)
1630 {
1631 tm->tv_usec -= 1000000;
1632 ++tm->tv_sec;
1633 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001634# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001635}
1636
1637/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001638 * Add the "self" time from the total time and the children's time.
1639 */
1640 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001641profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001642{
1643 /* Check that the result won't be negative. Can happen with recursive
1644 * calls. */
1645#ifdef WIN3264
1646 if (total->QuadPart <= children->QuadPart)
1647 return;
1648#else
1649 if (total->tv_sec < children->tv_sec
1650 || (total->tv_sec == children->tv_sec
1651 && total->tv_usec <= children->tv_usec))
1652 return;
1653#endif
1654 profile_add(self, total);
1655 profile_sub(self, children);
1656}
1657
1658/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001659 * Get the current waittime.
1660 */
1661 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001662profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001663{
1664 *tm = prof_wait_time;
1665}
1666
1667/*
1668 * Subtract the passed waittime since "tm" from "tma".
1669 */
1670 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001671profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001672{
1673 proftime_T tm3 = prof_wait_time;
1674
1675 profile_sub(&tm3, tm);
1676 profile_sub(tma, &tm3);
1677}
1678
1679/*
1680 * Return TRUE if "tm1" and "tm2" are equal.
1681 */
1682 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001683profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001684{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001685# ifdef WIN3264
1686 return (tm1->QuadPart == tm2->QuadPart);
1687# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001688 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001689# endif
1690}
1691
1692/*
1693 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1694 */
1695 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001696profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001697{
1698# ifdef WIN3264
1699 return (int)(tm2->QuadPart - tm1->QuadPart);
1700# else
1701 if (tm1->tv_sec == tm2->tv_sec)
1702 return tm2->tv_usec - tm1->tv_usec;
1703 return tm2->tv_sec - tm1->tv_sec;
1704# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001705}
1706
Bram Moolenaar05159a02005-02-26 23:04:13 +00001707static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001708static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001709
1710/*
1711 * ":profile cmd args"
1712 */
1713 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001714ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001715{
1716 char_u *e;
1717 int len;
1718
1719 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001720 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001721 e = skipwhite(e);
1722
1723 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1724 {
1725 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001726 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001727 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001728 profile_zero(&prof_wait_time);
1729 set_vim_var_nr(VV_PROFILING, 1L);
1730 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001731 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001732 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001733 else if (STRCMP(eap->arg, "pause") == 0)
1734 {
1735 if (do_profiling == PROF_YES)
1736 profile_start(&pause_time);
1737 do_profiling = PROF_PAUSED;
1738 }
1739 else if (STRCMP(eap->arg, "continue") == 0)
1740 {
1741 if (do_profiling == PROF_PAUSED)
1742 {
1743 profile_end(&pause_time);
1744 profile_add(&prof_wait_time, &pause_time);
1745 }
1746 do_profiling = PROF_YES;
1747 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001748 else
1749 {
1750 /* The rest is similar to ":breakadd". */
1751 ex_breakadd(eap);
1752 }
1753}
1754
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001755/* Command line expansion for :profile. */
1756static enum
1757{
1758 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001759 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001760} pexpand_what;
1761
1762static char *pexpand_cmds[] = {
1763 "start",
1764#define PROFCMD_START 0
1765 "pause",
1766#define PROFCMD_PAUSE 1
1767 "continue",
1768#define PROFCMD_CONTINUE 2
1769 "func",
1770#define PROFCMD_FUNC 3
1771 "file",
1772#define PROFCMD_FILE 4
1773 NULL
1774#define PROFCMD_LAST 5
1775};
1776
1777/*
1778 * Function given to ExpandGeneric() to obtain the profile command
1779 * specific expansion.
1780 */
1781 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001782get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001783{
1784 switch (pexpand_what)
1785 {
1786 case PEXP_SUBCMD:
1787 return (char_u *)pexpand_cmds[idx];
1788 /* case PEXP_FUNC: TODO */
1789 default:
1790 return NULL;
1791 }
1792}
1793
1794/*
1795 * Handle command line completion for :profile command.
1796 */
1797 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001798set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001799{
1800 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001801
1802 /* Default: expand subcommands. */
1803 xp->xp_context = EXPAND_PROFILE;
1804 pexpand_what = PEXP_SUBCMD;
1805 xp->xp_pattern = arg;
1806
1807 end_subcmd = skiptowhite(arg);
1808 if (*end_subcmd == NUL)
1809 return;
1810
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001811 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001812 {
1813 xp->xp_context = EXPAND_FILES;
1814 xp->xp_pattern = skipwhite(end_subcmd);
1815 return;
1816 }
1817
1818 /* TODO: expand function names after "func" */
1819 xp->xp_context = EXPAND_NOTHING;
1820}
1821
Bram Moolenaar05159a02005-02-26 23:04:13 +00001822/*
1823 * Dump the profiling info.
1824 */
1825 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001826profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001827{
1828 FILE *fd;
1829
1830 if (profile_fname != NULL)
1831 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001832 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001833 if (fd == NULL)
1834 EMSG2(_(e_notopen), profile_fname);
1835 else
1836 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001837 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001838 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001839 fclose(fd);
1840 }
1841 }
1842}
1843
1844/*
1845 * Start profiling script "fp".
1846 */
1847 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001848script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001849{
1850 si->sn_pr_count = 0;
1851 profile_zero(&si->sn_pr_total);
1852 profile_zero(&si->sn_pr_self);
1853
1854 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1855 si->sn_prl_idx = -1;
1856 si->sn_prof_on = TRUE;
1857 si->sn_pr_nest = 0;
1858}
1859
1860/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02001861 * Save time when starting to invoke another script or function.
Bram Moolenaar05159a02005-02-26 23:04:13 +00001862 */
1863 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001864script_prof_save(
1865 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001866{
1867 scriptitem_T *si;
1868
1869 if (current_SID > 0 && current_SID <= script_items.ga_len)
1870 {
1871 si = &SCRIPT_ITEM(current_SID);
1872 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1873 profile_start(&si->sn_pr_child);
1874 }
1875 profile_get_wait(tm);
1876}
1877
1878/*
1879 * Count time spent in children after invoking another script or function.
1880 */
1881 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001882script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001883{
1884 scriptitem_T *si;
1885
1886 if (current_SID > 0 && current_SID <= script_items.ga_len)
1887 {
1888 si = &SCRIPT_ITEM(current_SID);
1889 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1890 {
1891 profile_end(&si->sn_pr_child);
1892 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1893 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1894 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1895 }
1896 }
1897}
1898
1899static proftime_T inchar_time;
1900
1901/*
1902 * Called when starting to wait for the user to type a character.
1903 */
1904 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001905prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001906{
1907 profile_start(&inchar_time);
1908}
1909
1910/*
1911 * Called when finished waiting for the user to type a character.
1912 */
1913 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001914prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001915{
1916 profile_end(&inchar_time);
1917 profile_add(&prof_wait_time, &inchar_time);
1918}
1919
1920/*
1921 * Dump the profiling results for all scripts in file "fd".
1922 */
1923 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001924script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001925{
1926 int id;
1927 scriptitem_T *si;
1928 int i;
1929 FILE *sfd;
1930 sn_prl_T *pp;
1931
1932 for (id = 1; id <= script_items.ga_len; ++id)
1933 {
1934 si = &SCRIPT_ITEM(id);
1935 if (si->sn_prof_on)
1936 {
1937 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1938 if (si->sn_pr_count == 1)
1939 fprintf(fd, "Sourced 1 time\n");
1940 else
1941 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1942 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1943 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1944 fprintf(fd, "\n");
1945 fprintf(fd, "count total (s) self (s)\n");
1946
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001947 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001948 if (sfd == NULL)
1949 fprintf(fd, "Cannot open file!\n");
1950 else
1951 {
Bram Moolenaar67435d92017-10-19 21:04:37 +02001952 /* Keep going till the end of file, so that trailing
1953 * continuation lines are listed. */
1954 for (i = 0; ; ++i)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001955 {
1956 if (vim_fgets(IObuff, IOSIZE, sfd))
1957 break;
Bram Moolenaarac112f02017-12-05 16:46:28 +01001958 /* When a line has been truncated, append NL, taking care
1959 * of multi-byte characters . */
1960 if (IObuff[IOSIZE - 2] != NUL && IObuff[IOSIZE - 2] != NL)
1961 {
1962 int n = IOSIZE - 2;
1963# ifdef FEAT_MBYTE
1964 if (enc_utf8)
1965 {
1966 /* Move to the first byte of this char.
1967 * utf_head_off() doesn't work, because it checks
1968 * for a truncated character. */
1969 while (n > 0 && (IObuff[n] & 0xc0) == 0x80)
1970 --n;
1971 }
1972 else if (has_mbyte)
1973 n -= mb_head_off(IObuff, IObuff + n);
1974# endif
1975 IObuff[n] = NL;
1976 IObuff[n + 1] = NUL;
1977 }
Bram Moolenaar67435d92017-10-19 21:04:37 +02001978 if (i < si->sn_prl_ga.ga_len
1979 && (pp = &PRL_ITEM(si, i))->snp_count > 0)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001980 {
1981 fprintf(fd, "%5d ", pp->snp_count);
1982 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1983 fprintf(fd, " ");
1984 else
1985 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1986 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1987 }
1988 else
1989 fprintf(fd, " ");
1990 fprintf(fd, "%s", IObuff);
1991 }
1992 fclose(sfd);
1993 }
1994 fprintf(fd, "\n");
1995 }
1996 }
1997}
1998
1999/*
2000 * Return TRUE when a function defined in the current script should be
2001 * profiled.
2002 */
2003 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002004prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00002005{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00002006 if (current_SID > 0)
2007 return SCRIPT_ITEM(current_SID).sn_pr_force;
2008 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00002009}
2010
2011# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012#endif
2013
2014/*
2015 * If 'autowrite' option set, try to write the file.
2016 * Careful: autocommands may make "buf" invalid!
2017 *
2018 * return FAIL for failure, OK otherwise
2019 */
2020 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002021autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022{
Bram Moolenaar373154b2007-02-13 05:19:30 +00002023 int r;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002024 bufref_T bufref;
Bram Moolenaar373154b2007-02-13 05:19:30 +00002025
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 if (!(p_aw || p_awa) || !p_write
2027#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00002028 /* never autowrite a "nofile" or "nowrite" buffer */
2029 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002030#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00002031 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032 return FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002033 set_bufref(&bufref, buf);
Bram Moolenaar373154b2007-02-13 05:19:30 +00002034 r = buf_write_all(buf, forceit);
2035
2036 /* Writing may succeed but the buffer still changed, e.g., when there is a
2037 * conversion error. We do want to return FAIL then. */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002038 if (bufref_valid(&bufref) && bufIsChanged(buf))
Bram Moolenaar373154b2007-02-13 05:19:30 +00002039 r = FAIL;
2040 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041}
2042
2043/*
Bram Moolenaar8c9e7b02018-08-30 13:07:17 +02002044 * Flush all buffers, except the ones that are readonly or are never written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045 */
2046 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002047autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002048{
2049 buf_T *buf;
2050
2051 if (!(p_aw || p_awa) || !p_write)
2052 return;
Bram Moolenaar29323592016-07-24 22:04:11 +02002053 FOR_ALL_BUFFERS(buf)
Bram Moolenaar8c9e7b02018-08-30 13:07:17 +02002054 if (bufIsChanged(buf) && !buf->b_p_ro && !bt_dontwrite(buf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002056 bufref_T bufref;
2057
2058 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002059
Bram Moolenaar071d4272004-06-13 20:20:40 +00002060 (void)buf_write_all(buf, FALSE);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002061
Bram Moolenaar071d4272004-06-13 20:20:40 +00002062 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002063 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 }
2066}
2067
2068/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002069 * Return TRUE if buffer was changed and cannot be abandoned.
2070 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002073check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074{
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002075 int forceit = (flags & CCGD_FORCEIT);
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002076 bufref_T bufref;
2077
2078 set_bufref(&bufref, buf);
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002079
Bram Moolenaar071d4272004-06-13 20:20:40 +00002080 if ( !forceit
2081 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002082 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
2083 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 {
2085#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2086 if ((p_confirm || cmdmod.confirm) && p_write)
2087 {
2088 buf_T *buf2;
2089 int count = 0;
2090
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002091 if (flags & CCGD_ALLBUF)
Bram Moolenaar29323592016-07-24 22:04:11 +02002092 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 if (bufIsChanged(buf2)
2094 && (buf2->b_ffname != NULL
2095# ifdef FEAT_BROWSE
2096 || cmdmod.browse
2097# endif
2098 ))
2099 ++count;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002100 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 /* Autocommand deleted buffer, oops! It's not changed now. */
2102 return FALSE;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002103
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 dialog_changed(buf, count > 1);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002105
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002106 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002107 /* Autocommand deleted buffer, oops! It's not changed now. */
2108 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 return bufIsChanged(buf);
2110 }
2111#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002112 if (flags & CCGD_EXCMD)
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002113 no_write_message();
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002114 else
Bram Moolenaar7a760922018-02-19 23:10:02 +01002115 no_write_message_nobang(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 return TRUE;
2117 }
2118 return FALSE;
2119}
2120
2121#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
2122
2123#if defined(FEAT_BROWSE) || defined(PROTO)
2124/*
2125 * When wanting to write a file without a file name, ask the user for a name.
2126 */
2127 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002128browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129{
2130 if (buf->b_fname == NULL)
2131 {
2132 char_u *fname;
2133
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002134 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
2135 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 if (fname != NULL)
2137 {
2138 if (setfname(buf, fname, NULL, TRUE) == OK)
2139 buf->b_flags |= BF_NOTEDITED;
2140 vim_free(fname);
2141 }
2142 }
2143}
2144#endif
2145
2146/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02002147 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 * Must check 'write' option first!
2149 */
2150 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002151dialog_changed(
2152 buf_T *buf,
2153 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154{
Bram Moolenaard9462e32011-04-11 21:35:11 +02002155 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 int ret;
2157 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02002158 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159
Bram Moolenaar3f9a1ff2017-08-21 22:06:02 +02002160 dialog_msg(buff, _("Save changes to \"%s\"?"), buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 if (checkall)
2162 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
2163 else
2164 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
2165
Bram Moolenaar8218f602012-04-25 17:32:18 +02002166 /* Init ea pseudo-structure, this is needed for the check_overwrite()
2167 * function. */
2168 ea.append = ea.forceit = FALSE;
2169
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 if (ret == VIM_YES)
2171 {
2172#ifdef FEAT_BROWSE
2173 /* May get file name, when there is none */
2174 browse_save_fname(buf);
2175#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002176 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
2177 buf->b_fname, buf->b_ffname, FALSE) == OK)
2178 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 (void)buf_write_all(buf, FALSE);
2180 }
2181 else if (ret == VIM_NO)
2182 {
2183 unchanged(buf, TRUE);
2184 }
2185 else if (ret == VIM_ALL)
2186 {
2187 /*
2188 * Write all modified files that can be written.
2189 * Skip readonly buffers, these need to be confirmed
2190 * individually.
2191 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002192 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002193 {
2194 if (bufIsChanged(buf2)
2195 && (buf2->b_ffname != NULL
2196#ifdef FEAT_BROWSE
2197 || cmdmod.browse
2198#endif
2199 )
2200 && !buf2->b_p_ro)
2201 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002202 bufref_T bufref;
2203
2204 set_bufref(&bufref, buf2);
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);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002213
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214 /* 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;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 }
2218 }
2219 }
2220 else if (ret == VIM_DISCARDALL)
2221 {
2222 /*
2223 * mark all buffers as unchanged
2224 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002225 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 unchanged(buf2, TRUE);
2227 }
2228}
2229#endif
2230
2231/*
2232 * Return TRUE if the buffer "buf" can be abandoned, either by making it
2233 * hidden, autowriting it or unloading it.
2234 */
2235 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002236can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237{
Bram Moolenaareb44a682017-08-03 22:44:55 +02002238 return ( buf_hide(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 || !bufIsChanged(buf)
2240 || buf->b_nwindows > 1
2241 || autowrite(buf, forceit) == OK
2242 || forceit);
2243}
2244
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002245static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002246
2247/*
2248 * Add a buffer number to "bufnrs", unless it's already there.
2249 */
2250 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002251add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002252{
2253 int i;
2254
2255 for (i = 0; i < *bufnump; ++i)
2256 if (bufnrs[i] == nr)
2257 return;
2258 bufnrs[*bufnump] = nr;
2259 *bufnump = *bufnump + 1;
2260}
2261
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262/*
2263 * Return TRUE if any buffer was changed and cannot be abandoned.
2264 * That changed buffer becomes the current buffer.
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002265 * When "unload" is TRUE the current buffer is unloaded instead of making it
Bram Moolenaar027387f2016-01-02 22:25:52 +01002266 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267 */
2268 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002269check_changed_any(
2270 int hidden, /* Only check hidden buffers */
2271 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002273 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274 buf_T *buf;
2275 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002276 int i;
2277 int bufnum = 0;
2278 int bufcount = 0;
2279 int *bufnrs;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002280 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002283 /* Make a list of all buffers, with the most important ones first. */
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 Moolenaar25cdd9c2018-03-10 20:28:12 +01002296
2297 /* buffers in current tab */
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002298 FOR_ALL_WINDOWS(wp)
2299 if (wp->w_buffer != curbuf)
2300 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2301
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002302 /* buffers in other tabs */
Bram Moolenaar29323592016-07-24 22:04:11 +02002303 FOR_ALL_TABPAGES(tp)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002304 if (tp != curtab)
2305 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
2306 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002307
2308 /* any other buffer */
Bram Moolenaar29323592016-07-24 22:04:11 +02002309 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002310 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
2311
2312 for (i = 0; i < bufnum; ++i)
2313 {
2314 buf = buflist_findnr(bufnrs[i]);
2315 if (buf == NULL)
2316 continue;
2317 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
2318 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002319 bufref_T bufref;
2320
2321 set_bufref(&bufref, buf);
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002322#ifdef FEAT_TERMINAL
2323 if (term_job_running(buf->b_term))
2324 {
2325 if (term_try_stop_job(buf) == FAIL)
2326 break;
2327 }
2328 else
2329#endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002330 /* Try auto-writing the buffer. If this fails but the buffer no
2331 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002332 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
2333 | CCGD_MULTWIN
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002334 | CCGD_ALLBUF) && bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002335 break; /* didn't save - still changes */
2336 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 }
2338
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002339 if (i >= bufnum)
2340 goto theend;
2341
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002342 /* Get here if "buf" cannot be abandoned. */
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002343 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344 exiting = FALSE;
2345#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2346 /*
2347 * When ":confirm" used, don't give an error message.
2348 */
2349 if (!(p_confirm || cmdmod.confirm))
2350#endif
2351 {
2352 /* There must be a wait_return for this message, do_buffer()
2353 * may cause a redraw. But wait_return() is a no-op when vgetc()
2354 * is busy (Quit used from window menu), then make sure we don't
2355 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00002356 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002357 {
2358 msg_row = cmdline_row;
2359 msg_col = 0;
2360 msg_didout = FALSE;
2361 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002362 if (
2363#ifdef FEAT_TERMINAL
2364 term_job_running(buf->b_term)
2365 ? EMSG2(_("E947: Job still running in buffer \"%s\""),
2366 buf->b_fname)
2367 :
2368#endif
2369 EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002370 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 {
2372 save = no_wait_return;
2373 no_wait_return = FALSE;
2374 wait_return(FALSE);
2375 no_wait_return = save;
2376 }
2377 }
2378
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 /* Try to find a window that contains the buffer. */
2380 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002381 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 if (wp->w_buffer == buf)
2383 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002384 bufref_T bufref;
2385
2386 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002387
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002388 goto_tabpage_win(tp, wp);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002389
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 /* Paranoia: did autocms wipe out the buffer with changes? */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002391 if (!bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002392 goto theend;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002393 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002395buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396
2397 /* Open the changed buffer in the current window. */
2398 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002399 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002401theend:
2402 vim_free(bufnrs);
2403 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404}
2405
2406/*
2407 * return FAIL if there is no file name, OK if there is one
2408 * give error message for FAIL
2409 */
2410 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002411check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412{
2413 if (curbuf->b_ffname == NULL)
2414 {
2415 EMSG(_(e_noname));
2416 return FAIL;
2417 }
2418 return OK;
2419}
2420
2421/*
2422 * flush the contents of a buffer, unless it has no file name
2423 *
2424 * return FAIL for failure, OK otherwise
2425 */
2426 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002427buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428{
2429 int retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 buf_T *old_curbuf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431
2432 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2433 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2434 FALSE, forceit, TRUE, FALSE));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002436 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01002437 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002439 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 return retval;
2441}
2442
2443/*
2444 * Code to handle the argument list.
2445 */
2446
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002447static char_u *do_one_arg(char_u *str);
Bram Moolenaar32bbd002018-08-31 23:06:22 +02002448static int do_arglist(char_u *str, int what, int after, int will_edit);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002449static void alist_check_arg_idx(void);
2450static int editing_arg_idx(win_T *win);
Bram Moolenaar32bbd002018-08-31 23:06:22 +02002451static void alist_add_list(int count, char_u **files, int after, int will_edit);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002452#define AL_SET 1
2453#define AL_ADD 2
2454#define AL_DEL 3
2455
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002457 * Isolate one argument, taking backticks.
2458 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 * Return a pointer to the start of the next argument.
2460 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002461 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002462do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002463{
2464 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 int inbacktick;
2466
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 inbacktick = FALSE;
2468 for (p = str; *str; ++str)
2469 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002470 /* When the backslash is used for escaping the special meaning of a
2471 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472 if (rem_backslash(str))
2473 {
2474 *p++ = *str++;
2475 *p++ = *str;
2476 }
2477 else
2478 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002479 /* An item ends at a space not in backticks */
2480 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002482 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002483 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002484 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002485 }
2486 }
2487 str = skipwhite(str);
2488 *p = NUL;
2489
2490 return str;
2491}
2492
Bram Moolenaar86b68352004-12-27 21:59:20 +00002493/*
2494 * Separate the arguments in "str" and return a list of pointers in the
2495 * growarray "gap".
2496 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002497 static int
2498get_arglist(garray_T *gap, char_u *str, int escaped)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002499{
2500 ga_init2(gap, (int)sizeof(char_u *), 20);
2501 while (*str != NUL)
2502 {
2503 if (ga_grow(gap, 1) == FAIL)
2504 {
2505 ga_clear(gap);
2506 return FAIL;
2507 }
2508 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2509
Bram Moolenaar398ee732017-08-03 14:29:14 +02002510 /* If str is escaped, don't handle backslashes or spaces */
2511 if (!escaped)
2512 return OK;
2513
Bram Moolenaar86b68352004-12-27 21:59:20 +00002514 /* Isolate one argument, change it in-place, put a NUL after it. */
2515 str = do_one_arg(str);
2516 }
2517 return OK;
2518}
2519
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002520#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002521/*
2522 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002523 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002524 * Return FAIL or OK.
2525 */
2526 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002527get_arglist_exp(
2528 char_u *str,
2529 int *fcountp,
2530 char_u ***fnamesp,
2531 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002532{
2533 garray_T ga;
2534 int i;
2535
Bram Moolenaar398ee732017-08-03 14:29:14 +02002536 if (get_arglist(&ga, str, TRUE) == FAIL)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002537 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002538 if (wig == TRUE)
2539 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2540 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2541 else
2542 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2543 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2544
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002545 ga_clear(&ga);
2546 return i;
2547}
2548#endif
2549
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550/*
2551 * Redefine the argument list.
2552 */
2553 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002554set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555{
Bram Moolenaar32bbd002018-08-31 23:06:22 +02002556 do_arglist(str, AL_SET, 0, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558
2559/*
2560 * "what" == AL_SET: Redefine the argument list to 'str'.
2561 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2562 * "what" == AL_DEL: remove files in 'str' from the argument list.
2563 *
2564 * Return FAIL for failure, OK otherwise.
2565 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002567do_arglist(
2568 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002569 int what,
Bram Moolenaar32bbd002018-08-31 23:06:22 +02002570 int after UNUSED, // 0 means before first one
2571 int will_edit) // will edit added argument
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572{
2573 garray_T new_ga;
2574 int exp_count;
2575 char_u **exp_files;
2576 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 char_u *p;
2578 int match;
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
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 if (what == AL_DEL)
2599 {
2600 regmatch_T regmatch;
2601 int didone;
2602
2603 /*
2604 * Delete the items: use each item as a regexp and find a match in the
2605 * argument list.
2606 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002607 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2609 {
2610 p = ((char_u **)new_ga.ga_data)[i];
2611 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2612 if (p == NULL)
2613 break;
2614 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2615 if (regmatch.regprog == NULL)
2616 {
2617 vim_free(p);
2618 break;
2619 }
2620
2621 didone = FALSE;
2622 for (match = 0; match < ARGCOUNT; ++match)
2623 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2624 (colnr_T)0))
2625 {
2626 didone = TRUE;
2627 vim_free(ARGLIST[match].ae_fname);
2628 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2629 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2630 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 if (curwin->w_arg_idx > match)
2632 --curwin->w_arg_idx;
2633 --match;
2634 }
2635
Bram Moolenaar473de612013-06-08 18:19:48 +02002636 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 vim_free(p);
2638 if (!didone)
2639 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2640 }
2641 ga_clear(&new_ga);
2642 }
2643 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 {
2645 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2646 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2647 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002648 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 {
2650 EMSG(_(e_nomatch));
2651 return FAIL;
2652 }
2653
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 if (what == AL_ADD)
2655 {
Bram Moolenaar32bbd002018-08-31 23:06:22 +02002656 alist_add_list(exp_count, exp_files, after, will_edit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002657 vim_free(exp_files);
2658 }
2659 else /* what == AL_SET */
Bram Moolenaar32bbd002018-08-31 23:06:22 +02002660 alist_set(ALIST(curwin), exp_count, exp_files, will_edit, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 }
2662
2663 alist_check_arg_idx();
2664
2665 return OK;
2666}
2667
2668/*
2669 * Check the validity of the arg_idx for each other window.
2670 */
2671 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002672alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002675 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676
Bram Moolenaarf740b292006-02-16 22:11:02 +00002677 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 if (win->w_alist == curwin->w_alist)
2679 check_arg_idx(win);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680}
2681
2682/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002683 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002684 * index.
2685 */
2686 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002687editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002688{
2689 return !(win->w_arg_idx >= WARGCOUNT(win)
2690 || (win->w_buffer->b_fnum
2691 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2692 && (win->w_buffer->b_ffname == NULL
2693 || !(fullpathcmp(
2694 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2695 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2696}
2697
2698/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 * Check if window "win" is editing the w_arg_idx file in its argument list.
2700 */
2701 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002702check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002704 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 {
2706 /* We are not editing the current entry in the argument list.
2707 * Set "arg_had_last" if we are editing the last one. */
2708 win->w_arg_idx_invalid = TRUE;
2709 if (win->w_arg_idx != WARGCOUNT(win) - 1
2710 && arg_had_last == FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 && ALIST(win) == &global_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 && GARGCOUNT > 0
2713 && win->w_arg_idx < GARGCOUNT
2714 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2715 || (win->w_buffer->b_ffname != NULL
2716 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2717 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2718 arg_had_last = TRUE;
2719 }
2720 else
2721 {
2722 /* We are editing the current entry in the argument list.
2723 * Set "arg_had_last" if it's also the last one */
2724 win->w_arg_idx_invalid = FALSE;
2725 if (win->w_arg_idx == WARGCOUNT(win) - 1
Bram Moolenaar4033c552017-09-16 20:54:51 +02002726 && win->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 arg_had_last = TRUE;
2728 }
2729}
2730
2731/*
2732 * ":args", ":argslocal" and ":argsglobal".
2733 */
2734 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002735ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736{
2737 int i;
2738
2739 if (eap->cmdidx != CMD_args)
2740 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 alist_unlink(ALIST(curwin));
2742 if (eap->cmdidx == CMD_argglobal)
2743 ALIST(curwin) = &global_alist;
2744 else /* eap->cmdidx == CMD_arglocal */
2745 alist_new();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 }
2747
2748 if (!ends_excmd(*eap->arg))
2749 {
2750 /*
2751 * ":args file ..": define new argument list, handle like ":next"
2752 * Also for ":argslocal file .." and ":argsglobal file ..".
2753 */
2754 ex_next(eap);
2755 }
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02002756 else if (eap->cmdidx == CMD_args)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 {
2758 /*
2759 * ":args": list arguments.
2760 */
2761 if (ARGCOUNT > 0)
2762 {
Bram Moolenaar405dadb2018-04-20 22:48:58 +02002763 char_u **items = (char_u **)alloc(sizeof(char_u *) * ARGCOUNT);
Bram Moolenaar5d69da42018-04-20 22:01:41 +02002764
2765 if (items != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 {
Bram Moolenaar5d69da42018-04-20 22:01:41 +02002767 /* Overwrite the command, for a short list there is no
2768 * scrolling required and no wait_return(). */
2769 gotocmdline(TRUE);
2770
2771 for (i = 0; i < ARGCOUNT; ++i)
Bram Moolenaar405dadb2018-04-20 22:48:58 +02002772 items[i] = alist_name(&ARGLIST[i]);
Bram Moolenaar5d69da42018-04-20 22:01:41 +02002773 list_in_columns(items, ARGCOUNT, curwin->w_arg_idx);
2774 vim_free(items);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 }
2776 }
2777 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 else if (eap->cmdidx == CMD_arglocal)
2779 {
2780 garray_T *gap = &curwin->w_alist->al_ga;
2781
2782 /*
2783 * ":argslocal": make a local copy of the global argument list.
2784 */
2785 if (ga_grow(gap, GARGCOUNT) == OK)
2786 for (i = 0; i < GARGCOUNT; ++i)
2787 if (GARGLIST[i].ae_fname != NULL)
2788 {
2789 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2790 vim_strsave(GARGLIST[i].ae_fname);
2791 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2792 GARGLIST[i].ae_fnum;
2793 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 }
2795 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796}
2797
2798/*
2799 * ":previous", ":sprevious", ":Next" and ":sNext".
2800 */
2801 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002802ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803{
2804 /* If past the last one already, go to the last one. */
2805 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2806 do_argfile(eap, ARGCOUNT - 1);
2807 else
2808 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2809}
2810
2811/*
2812 * ":rewind", ":first", ":sfirst" and ":srewind".
2813 */
2814 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002815ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816{
2817 do_argfile(eap, 0);
2818}
2819
2820/*
2821 * ":last" and ":slast".
2822 */
2823 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002824ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825{
2826 do_argfile(eap, ARGCOUNT - 1);
2827}
2828
2829/*
2830 * ":argument" and ":sargument".
2831 */
2832 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002833ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834{
2835 int i;
2836
2837 if (eap->addr_count > 0)
2838 i = eap->line2 - 1;
2839 else
2840 i = curwin->w_arg_idx;
2841 do_argfile(eap, i);
2842}
2843
2844/*
2845 * Edit file "argn" of the argument lists.
2846 */
2847 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002848do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849{
2850 int other;
2851 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002852 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
2854 if (argn < 0 || argn >= ARGCOUNT)
2855 {
2856 if (ARGCOUNT <= 1)
2857 EMSG(_("E163: There is only one file to edit"));
2858 else if (argn < 0)
2859 EMSG(_("E164: Cannot go before first file"));
2860 else
2861 EMSG(_("E165: Cannot go beyond last file"));
2862 }
2863 else
2864 {
2865 setpcmark();
2866#ifdef FEAT_GUI
2867 need_mouse_correct = TRUE;
2868#endif
2869
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002870 /* split window or create new tab page first */
2871 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 {
2873 if (win_split(0, 0) == FAIL)
2874 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002875 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 }
2877 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 {
2879 /*
2880 * if 'hidden' set, only check for changed file when re-editing
2881 * the same buffer
2882 */
2883 other = TRUE;
Bram Moolenaareb44a682017-08-03 22:44:55 +02002884 if (buf_hide(curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 {
2886 p = fix_fname(alist_name(&ARGLIST[argn]));
2887 other = otherfile(p);
2888 vim_free(p);
2889 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002890 if ((!buf_hide(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002891 && check_changed(curbuf, CCGD_AW
2892 | (other ? 0 : CCGD_MULTWIN)
2893 | (eap->forceit ? CCGD_FORCEIT : 0)
2894 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 return;
2896 }
2897
2898 curwin->w_arg_idx = argn;
Bram Moolenaar4033c552017-09-16 20:54:51 +02002899 if (argn == ARGCOUNT - 1 && curwin->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 arg_had_last = TRUE;
2901
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002902 /* Edit the file; always use the last known line number.
2903 * When it fails (e.g. Abort for already edited file) restore the
2904 * argument index. */
2905 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 eap, ECMD_LAST,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002907 (buf_hide(curwin->w_buffer) ? ECMD_HIDE : 0)
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002908 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002909 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002911 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 setmark('\'');
2913 }
2914}
2915
2916/*
2917 * ":next", and commands that behave like it.
2918 */
2919 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002920ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921{
2922 int i;
2923
2924 /*
2925 * check for changed buffer now, if this fails the argument list is not
2926 * redefined.
2927 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002928 if ( buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002930 || !check_changed(curbuf, CCGD_AW
2931 | (eap->forceit ? CCGD_FORCEIT : 0)
2932 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 {
2934 if (*eap->arg != NUL) /* redefine file list */
2935 {
Bram Moolenaar32bbd002018-08-31 23:06:22 +02002936 if (do_arglist(eap->arg, AL_SET, 0, TRUE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002937 return;
2938 i = 0;
2939 }
2940 else
2941 i = curwin->w_arg_idx + (int)eap->line2;
2942 do_argfile(eap, i);
2943 }
2944}
2945
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946/*
2947 * ":argedit"
2948 */
2949 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002950ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951{
Bram Moolenaar90305c62017-07-16 15:31:17 +02002952 int i = eap->addr_count ? (int)eap->line2 : curwin->w_arg_idx + 1;
Bram Moolenaar46a53df2018-04-24 21:58:51 +02002953 // Whether curbuf will be reused, curbuf->b_ffname will be set.
2954 int curbuf_is_reusable = curbuf_reusable();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955
Bram Moolenaar32bbd002018-08-31 23:06:22 +02002956 if (do_arglist(eap->arg, AL_ADD, i, TRUE) == FAIL)
Bram Moolenaar90305c62017-07-16 15:31:17 +02002957 return;
2958#ifdef FEAT_TITLE
2959 maketitle();
2960#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961
Bram Moolenaar46a53df2018-04-24 21:58:51 +02002962 if (curwin->w_arg_idx == 0
2963 && (curbuf->b_ml.ml_flags & ML_EMPTY)
2964 && (curbuf->b_ffname == NULL || curbuf_is_reusable))
Bram Moolenaar90305c62017-07-16 15:31:17 +02002965 i = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 /* Edit the argument. */
Bram Moolenaar90305c62017-07-16 15:31:17 +02002967 if (i < ARGCOUNT)
2968 do_argfile(eap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969}
2970
2971/*
2972 * ":argadd"
2973 */
2974 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002975ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976{
2977 do_arglist(eap->arg, AL_ADD,
Bram Moolenaar32bbd002018-08-31 23:06:22 +02002978 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1,
2979 FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980#ifdef FEAT_TITLE
2981 maketitle();
2982#endif
2983}
2984
2985/*
2986 * ":argdelete"
2987 */
2988 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002989ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990{
2991 int i;
2992 int n;
2993
2994 if (eap->addr_count > 0)
2995 {
2996 /* ":1,4argdel": Delete all arguments in the range. */
2997 if (eap->line2 > ARGCOUNT)
2998 eap->line2 = ARGCOUNT;
2999 n = eap->line2 - eap->line1 + 1;
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01003000 if (*eap->arg != NUL)
3001 /* Can't have both a range and an argument. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 EMSG(_(e_invarg));
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01003003 else if (n <= 0)
3004 {
3005 /* Don't give an error for ":%argdel" if the list is empty. */
3006 if (eap->line1 != 1 || eap->line2 != 0)
3007 EMSG(_(e_invrange));
3008 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 else
3010 {
3011 for (i = eap->line1; i <= eap->line2; ++i)
3012 vim_free(ARGLIST[i - 1].ae_fname);
3013 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
3014 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
3015 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 if (curwin->w_arg_idx >= eap->line2)
3017 curwin->w_arg_idx -= n;
3018 else if (curwin->w_arg_idx > eap->line1)
3019 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01003020 if (ARGCOUNT == 0)
3021 curwin->w_arg_idx = 0;
3022 else if (curwin->w_arg_idx >= ARGCOUNT)
3023 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 }
3025 }
3026 else if (*eap->arg == NUL)
3027 EMSG(_(e_argreq));
3028 else
Bram Moolenaar32bbd002018-08-31 23:06:22 +02003029 do_arglist(eap->arg, AL_DEL, 0, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030#ifdef FEAT_TITLE
3031 maketitle();
3032#endif
3033}
3034
3035/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003036 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 */
3038 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003039ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040{
3041 int i;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003042 win_T *wp;
3043 tabpage_T *tp;
Bram Moolenaare25bb902015-02-27 20:33:37 +01003044 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 int next_fnum = 0;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003046#if defined(FEAT_SYN_HL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003049 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003050#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02003051 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003052 int qf_idx;
3053#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01003055#ifndef FEAT_QUICKFIX
3056 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
3057 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3058 {
3059 ex_ni(eap);
3060 return;
3061 }
3062#endif
3063
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003064#if defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003065 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00003066 /* Don't do syntax HL autocommands. Skipping the syntax file is a
3067 * great speed improvement. */
3068 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003069#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003070#ifdef FEAT_CLIPBOARD
3071 start_global_changes();
3072#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073
3074 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003075 || eap->cmdidx == CMD_tabdo
Bram Moolenaareb44a682017-08-03 22:44:55 +02003076 || buf_hide(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003077 || !check_changed(curbuf, CCGD_AW
3078 | (eap->forceit ? CCGD_FORCEIT : 0)
3079 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003082 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003083 wp = firstwin;
3084 tp = first_tabpage;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003085 switch (eap->cmdidx)
3086 {
Bram Moolenaara162bc52015-01-07 16:54:21 +01003087 case CMD_windo:
3088 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
3089 i++;
3090 break;
3091 case CMD_tabdo:
3092 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
3093 i++;
3094 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003095 case CMD_argdo:
3096 i = eap->line1 - 1;
3097 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003098 default:
3099 break;
3100 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 /* set pcmark now */
3102 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003103 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01003104 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003105 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01003106 || !buf->b_p_bl); buf = buf->b_next)
3107 if (buf->b_fnum > eap->line2)
3108 {
3109 buf = NULL;
3110 break;
3111 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003112 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01003113 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003114 }
3115#ifdef FEAT_QUICKFIX
3116 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3117 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3118 {
3119 qf_size = qf_get_size(eap);
3120 if (qf_size <= 0 || eap->line1 > qf_size)
3121 buf = NULL;
3122 else
3123 {
3124 ex_cc(eap);
3125
3126 buf = curbuf;
3127 i = eap->line1 - 1;
3128 if (eap->addr_count <= 0)
3129 /* default is all the quickfix/location list entries */
3130 eap->line2 = qf_size;
3131 }
3132 }
3133#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 else
3135 setpcmark();
3136 listcmd_busy = TRUE; /* avoids setting pcmark below */
3137
Bram Moolenaare25bb902015-02-27 20:33:37 +01003138 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 {
3140 if (eap->cmdidx == CMD_argdo)
3141 {
3142 /* go to argument "i" */
3143 if (i == ARGCOUNT)
3144 break;
3145 /* Don't call do_argfile() when already there, it will try
3146 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003147 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003148 {
3149 /* Clear 'shm' to avoid that the file message overwrites
3150 * any output from the command. */
3151 p_shm_save = vim_strsave(p_shm);
3152 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003153 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003154 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3155 vim_free(p_shm_save);
3156 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 if (curwin->w_arg_idx != i)
3158 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160 else if (eap->cmdidx == CMD_windo)
3161 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003162 /* go to window "wp" */
3163 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003165 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00003166 if (curwin != wp)
3167 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003168 wp = curwin->w_next;
3169 }
3170 else if (eap->cmdidx == CMD_tabdo)
3171 {
3172 /* go to window "tp" */
3173 if (!valid_tabpage(tp))
3174 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02003175 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003176 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003178 else if (eap->cmdidx == CMD_bufdo)
3179 {
3180 /* Remember the number of the next listed buffer, in case
3181 * ":bwipe" is used or autocommands do something strange. */
3182 next_fnum = -1;
3183 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
3184 if (buf->b_p_bl)
3185 {
3186 next_fnum = buf->b_fnum;
3187 break;
3188 }
3189 }
3190
Bram Moolenaara162bc52015-01-07 16:54:21 +01003191 ++i;
3192
Bram Moolenaar071d4272004-06-13 20:20:40 +00003193 /* execute the command */
3194 do_cmdline(eap->arg, eap->getline, eap->cookie,
3195 DOCMD_VERBOSE + DOCMD_NOWAIT);
3196
3197 if (eap->cmdidx == CMD_bufdo)
3198 {
3199 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01003200 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 break;
3202 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02003203 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 if (buf->b_fnum == next_fnum)
3205 break;
3206 if (buf == NULL)
3207 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003208
3209 /* Go to the next buffer. Clear 'shm' to avoid that the file
3210 * message overwrites any output from the command. */
3211 p_shm_save = vim_strsave(p_shm);
3212 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003214 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3215 vim_free(p_shm_save);
3216
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003217 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 if (curbuf->b_fnum != next_fnum)
3219 break;
3220 }
3221
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003222#ifdef FEAT_QUICKFIX
3223 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3224 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3225 {
3226 if (i >= qf_size || i >= eap->line2)
3227 break;
3228
3229 qf_idx = qf_get_cur_idx(eap);
3230
3231 ex_cnext(eap);
3232
3233 /* If jumping to the next quickfix entry fails, quit here */
3234 if (qf_get_cur_idx(eap) == qf_idx)
3235 break;
3236 }
3237#endif
3238
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 if (eap->cmdidx == CMD_windo)
3240 {
3241 validate_cursor(); /* cursor may have moved */
Bram Moolenaar8a3bb562018-03-04 20:14:14 +01003242
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 /* required when 'scrollbind' has been set */
3244 if (curwin->w_p_scb)
3245 do_check_scrollbind(TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01003247
Bram Moolenaara162bc52015-01-07 16:54:21 +01003248 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
3249 if (i+1 > eap->line2)
3250 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003251 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
3252 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 }
3254 listcmd_busy = FALSE;
3255 }
3256
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003257#if defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003258 if (save_ei != NULL)
3259 {
3260 au_event_restore(save_ei);
3261 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
3262 curbuf->b_fname, TRUE, curbuf);
3263 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003264#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003265#ifdef FEAT_CLIPBOARD
3266 end_global_changes();
3267#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268}
3269
3270/*
3271 * Add files[count] to the arglist of the current window after arg "after".
3272 * The file names in files[count] must have been allocated and are taken over.
3273 * Files[] itself is not taken over.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 */
Bram Moolenaar32bbd002018-08-31 23:06:22 +02003275 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003276alist_add_list(
3277 int count,
3278 char_u **files,
Bram Moolenaar32bbd002018-08-31 23:06:22 +02003279 int after, // where to add: 0 = before first one
3280 int will_edit) // will edit adding argument
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281{
3282 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003283 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284
3285 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3286 {
3287 if (after < 0)
3288 after = 0;
3289 if (after > ARGCOUNT)
3290 after = ARGCOUNT;
3291 if (after < ARGCOUNT)
3292 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3293 (ARGCOUNT - after) * sizeof(aentry_T));
3294 for (i = 0; i < count; ++i)
3295 {
Bram Moolenaar32bbd002018-08-31 23:06:22 +02003296 int flags = BLN_LISTED | (will_edit ? BLN_CURBUF : 0);
3297
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 ARGLIST[after + i].ae_fname = files[i];
Bram Moolenaar32bbd002018-08-31 23:06:22 +02003299 ARGLIST[after + i].ae_fnum = buflist_add(files[i], flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 }
3301 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003302 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3303 curwin->w_arg_idx += count;
Bram Moolenaar32bbd002018-08-31 23:06:22 +02003304 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 }
3306
3307 for (i = 0; i < count; ++i)
3308 vim_free(files[i]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309}
3310
Bram Moolenaarcd43eff2018-03-29 15:55:38 +02003311#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3312/*
3313 * Function given to ExpandGeneric() to obtain the possible arguments of the
3314 * argedit and argdelete commands.
3315 */
3316 char_u *
3317get_arglist_name(expand_T *xp UNUSED, int idx)
3318{
3319 if (idx >= ARGCOUNT)
3320 return NULL;
3321
3322 return alist_name(&ARGLIST[idx]);
3323}
3324#endif
3325
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02003326
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327#ifdef FEAT_EVAL
3328/*
3329 * ":compiler[!] {name}"
3330 */
3331 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003332ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333{
3334 char_u *buf;
3335 char_u *old_cur_comp = NULL;
3336 char_u *p;
3337
3338 if (*eap->arg == NUL)
3339 {
3340 /* List all compiler scripts. */
3341 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3342 /* ) keep the indenter happy... */
3343 }
3344 else
3345 {
3346 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3347 if (buf != NULL)
3348 {
3349 if (eap->forceit)
3350 {
3351 /* ":compiler! {name}" sets global options */
3352 do_cmdline_cmd((char_u *)
3353 "command -nargs=* CompilerSet set <args>");
3354 }
3355 else
3356 {
3357 /* ":compiler! {name}" sets local options.
3358 * To remain backwards compatible "current_compiler" is always
3359 * used. A user's compiler plugin may set it, the distributed
3360 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003361 * "b:current_compiler" and restore "current_compiler".
3362 * Explicitly prepend "g:" to make it work in a function. */
3363 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 if (old_cur_comp != NULL)
3365 old_cur_comp = vim_strsave(old_cur_comp);
3366 do_cmdline_cmd((char_u *)
3367 "command -nargs=* CompilerSet setlocal <args>");
3368 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003369 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003370 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371
3372 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003373 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3375 vim_free(buf);
3376
3377 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3378
3379 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003380 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 if (p != NULL)
3382 set_internal_string_var((char_u *)"b:current_compiler", p);
3383
3384 /* Restore "current_compiler" for ":compiler {name}". */
3385 if (!eap->forceit)
3386 {
3387 if (old_cur_comp != NULL)
3388 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003389 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 old_cur_comp);
3391 vim_free(old_cur_comp);
3392 }
3393 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003394 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003395 }
3396 }
3397 }
3398}
3399#endif
3400
3401/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003402 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003403 */
3404 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003405ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003407 char_u *arg = eap->arg;
3408 char_u *p = skiptowhite(arg);
3409 int len = (int)(p - arg);
3410 int flags = eap->forceit ? DIP_ALL : 0;
3411
3412 if (STRNCMP(arg, "START", len) == 0)
3413 {
3414 flags += DIP_START + DIP_NORTP;
3415 arg = skipwhite(arg + len);
3416 }
3417 else if (STRNCMP(arg, "OPT", len) == 0)
3418 {
3419 flags += DIP_OPT + DIP_NORTP;
3420 arg = skipwhite(arg + len);
3421 }
3422 else if (STRNCMP(arg, "PACK", len) == 0)
3423 {
3424 flags += DIP_START + DIP_OPT + DIP_NORTP;
3425 arg = skipwhite(arg + len);
3426 }
3427 else if (STRNCMP(arg, "ALL", len) == 0)
3428 {
3429 flags += DIP_START + DIP_OPT;
3430 arg = skipwhite(arg + len);
3431 }
3432
3433 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003434}
3435
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003437source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003439 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440}
3441
3442/*
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003443 * Find the file "name" in all directories in "path" and invoke
3444 * "callback(fname, cookie)".
3445 * "name" can contain wildcards.
3446 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3447 * When "flags" has DIP_DIR: find directories instead of files.
3448 * When "flags" has DIP_ERR: give an error message if there is no match.
3449 *
3450 * return FAIL when no file could be sourced, OK otherwise.
3451 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003452 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003453do_in_path(
3454 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003455 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003456 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003457 void (*callback)(char_u *fname, void *ck),
3458 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003459{
3460 char_u *rtp;
3461 char_u *np;
3462 char_u *buf;
3463 char_u *rtp_copy;
3464 char_u *tail;
3465 int num_files;
3466 char_u **files;
3467 int i;
3468 int did_one = FALSE;
3469#ifdef AMIGA
3470 struct Process *proc = (struct Process *)FindTask(0L);
3471 APTR save_winptr = proc->pr_WindowPtr;
3472
3473 /* Avoid a requester here for a volume that doesn't exist. */
3474 proc->pr_WindowPtr = (APTR)-1L;
3475#endif
3476
3477 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3478 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003479 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 buf = alloc(MAXPATHL);
3481 if (buf != NULL && rtp_copy != NULL)
3482 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003483 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003484 {
3485 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003486 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003487 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003488 verbose_leave();
3489 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003490
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 /* Loop over all entries in 'runtimepath'. */
3492 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003493 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003494 {
Bram Moolenaar66459b72016-08-06 19:01:55 +02003495 size_t buflen;
3496
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 /* Copy the path from 'runtimepath' to buf[]. */
3498 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaar66459b72016-08-06 19:01:55 +02003499 buflen = STRLEN(buf);
3500
3501 /* Skip after or non-after directories. */
3502 if (flags & (DIP_NOAFTER | DIP_AFTER))
3503 {
3504 int is_after = buflen >= 5
3505 && STRCMP(buf + buflen - 5, "after") == 0;
3506
3507 if ((is_after && (flags & DIP_NOAFTER))
3508 || (!is_after && (flags & DIP_AFTER)))
3509 continue;
3510 }
3511
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003512 if (name == NULL)
3513 {
3514 (*callback)(buf, (void *) &cookie);
3515 if (!did_one)
3516 did_one = (cookie == NULL);
3517 }
Bram Moolenaar66459b72016-08-06 19:01:55 +02003518 else if (buflen + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003519 {
3520 add_pathsep(buf);
3521 tail = buf + STRLEN(buf);
3522
3523 /* Loop over all patterns in "name" */
3524 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003525 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 {
3527 /* Append the pattern from "name" to buf[]. */
3528 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3529 "\t ");
3530
3531 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003532 {
3533 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003534 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003535 verbose_leave();
3536 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003537
3538 /* Expand wildcards, invoke the callback for each match. */
3539 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003540 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 {
3542 for (i = 0; i < num_files; ++i)
3543 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003544 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003546 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 break;
3548 }
3549 FreeWild(num_files, files);
3550 }
3551 }
3552 }
3553 }
3554 }
3555 vim_free(buf);
3556 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003557 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003558 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003559 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3560
3561 if (flags & DIP_ERR)
3562 EMSG3(_(e_dirnotf), basepath, name);
3563 else if (p_verbose > 0)
3564 {
3565 verbose_enter();
3566 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3567 verbose_leave();
3568 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003569 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570
3571#ifdef AMIGA
3572 proc->pr_WindowPtr = save_winptr;
3573#endif
3574
3575 return did_one ? OK : FAIL;
3576}
3577
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003578/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003579 * Find "name" in "path". When found, invoke the callback function for
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003580 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003581 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3582 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003583 * Returns OK when at least one match found, FAIL otherwise.
3584 *
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003585 * If "name" is NULL calls callback for each entry in "path". Cookie is
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003586 * passed by reference in this case, setting it to NULL indicates that callback
3587 * has done its job.
3588 */
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003589 static int
3590do_in_path_and_pp(
3591 char_u *path,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003592 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003593 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003594 void (*callback)(char_u *fname, void *ck),
3595 void *cookie)
3596{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003597 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003598 char_u *s;
3599 int len;
3600 char *start_dir = "pack/*/start/*/%s";
3601 char *opt_dir = "pack/*/opt/*/%s";
3602
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003603 if ((flags & DIP_NORTP) == 0)
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003604 done = do_in_path(path, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003605
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003606 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003607 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003608 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003609 s = alloc(len);
3610 if (s == NULL)
3611 return FAIL;
3612 vim_snprintf((char *)s, len, start_dir, name);
3613 done = do_in_path(p_pp, s, flags, callback, cookie);
3614 vim_free(s);
3615 }
3616
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003617 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003618 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003619 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003620 s = alloc(len);
3621 if (s == NULL)
3622 return FAIL;
3623 vim_snprintf((char *)s, len, opt_dir, name);
3624 done = do_in_path(p_pp, s, flags, callback, cookie);
3625 vim_free(s);
3626 }
3627
3628 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003629}
3630
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003631/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003632 * Just like do_in_path_and_pp(), using 'runtimepath' for "path".
3633 */
3634 int
3635do_in_runtimepath(
3636 char_u *name,
3637 int flags,
3638 void (*callback)(char_u *fname, void *ck),
3639 void *cookie)
3640{
3641 return do_in_path_and_pp(p_rtp, name, flags, callback, cookie);
3642}
3643
3644/*
3645 * Source the file "name" from all directories in 'runtimepath'.
3646 * "name" can contain wildcards.
3647 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3648 *
3649 * return FAIL when no file could be sourced, OK otherwise.
3650 */
3651 int
3652source_runtime(char_u *name, int flags)
3653{
3654 return source_in_path(p_rtp, name, flags);
3655}
3656
3657/*
3658 * Just like source_runtime(), but use "path" instead of 'runtimepath'.
3659 */
3660 int
3661source_in_path(char_u *path, char_u *name, int flags)
3662{
3663 return do_in_path_and_pp(path, name, flags, source_callback, NULL);
3664}
3665
3666
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003667#if defined(FEAT_EVAL) || defined(PROTO)
3668
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003669/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003670 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003671 */
3672 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003673source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003674{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003675 int num_files;
3676 char_u **files;
3677 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003678
Bram Moolenaarf3654822016-03-04 22:12:23 +01003679 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003680 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003681 for (i = 0; i < num_files; ++i)
3682 (void)do_source(files[i], FALSE, DOSO_NONE);
3683 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003684 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003685}
3686
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003687/*
3688 * Add the package directory to 'runtimepath'.
3689 */
3690 static int
3691add_pack_dir_to_rtp(char_u *fname)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003692{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003693 char_u *p4, *p3, *p2, *p1, *p;
3694 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003695 int c;
3696 char_u *new_rtp;
3697 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003698 size_t oldlen;
3699 size_t addlen;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003700 char_u *afterdir = NULL;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003701 size_t afterlen = 0;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003702 char_u *ffname = NULL;
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003703 size_t fname_len;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003704 char_u *buf = NULL;
3705 char_u *rtp_ffname;
3706 int match;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003707 int retval = FAIL;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003708
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003709 p4 = p3 = p2 = p1 = get_past_head(fname);
3710 for (p = p1; *p; MB_PTR_ADV(p))
3711 if (vim_ispathsep_nocolon(*p))
3712 {
3713 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3714 }
3715
3716 /* now we have:
3717 * rtp/pack/name/start/name
3718 * p4 p3 p2 p1
3719 *
3720 * find the part up to "pack" in 'runtimepath' */
3721 c = *++p4; /* append pathsep in order to expand symlink */
3722 *p4 = NUL;
3723 ffname = fix_fname(fname);
3724 *p4 = c;
Bram Moolenaar91715872016-03-03 17:13:03 +01003725 if (ffname == NULL)
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003726 return FAIL;
3727
3728 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3729 fname_len = STRLEN(ffname);
3730 insp = p_rtp;
3731 buf = alloc(MAXPATHL);
3732 if (buf == NULL)
3733 goto theend;
3734 while (*insp != NUL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003735 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003736 copy_option_part(&insp, buf, MAXPATHL, ",");
3737 add_pathsep(buf);
3738 rtp_ffname = fix_fname(buf);
3739 if (rtp_ffname == NULL)
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003740 goto theend;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003741 match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0;
3742 vim_free(rtp_ffname);
3743 if (match)
3744 break;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003745 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003746
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003747 if (*insp == NUL)
3748 /* not found, append at the end */
3749 insp = p_rtp + STRLEN(p_rtp);
3750 else
3751 /* append after the matching directory. */
3752 --insp;
3753
3754 /* check if rtp/pack/name/start/name/after exists */
3755 afterdir = concat_fnames(fname, (char_u *)"after", TRUE);
3756 if (afterdir != NULL && mch_isdir(afterdir))
3757 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3758
3759 oldlen = STRLEN(p_rtp);
3760 addlen = STRLEN(fname) + 1; /* add one for comma */
3761 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1));
3762 /* add one for NUL */
3763 if (new_rtp == NULL)
3764 goto theend;
3765 keep = (int)(insp - p_rtp);
3766 mch_memmove(new_rtp, p_rtp, keep);
3767 new_rtp[keep] = ',';
3768 mch_memmove(new_rtp + keep + 1, fname, addlen);
3769 if (p_rtp[keep] != NUL)
3770 mch_memmove(new_rtp + keep + addlen, p_rtp + keep, oldlen - keep + 1);
3771 if (afterlen > 0)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003772 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003773 STRCAT(new_rtp, ",");
3774 STRCAT(new_rtp, afterdir);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003775 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003776 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3777 vim_free(new_rtp);
3778 retval = OK;
Bram Moolenaarf3654822016-03-04 22:12:23 +01003779
3780theend:
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003781 vim_free(buf);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003782 vim_free(ffname);
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003783 vim_free(afterdir);
3784 return retval;
3785}
3786
3787/*
3788 * Load scripts in "plugin" and "ftdetect" directories of the package.
3789 */
3790 static int
3791load_pack_plugin(char_u *fname)
3792{
3793 static char *plugpat = "%s/plugin/**/*.vim";
3794 static char *ftpat = "%s/ftdetect/*.vim";
3795 int len;
3796 char_u *ffname = fix_fname(fname);
3797 char_u *pat = NULL;
3798 int retval = FAIL;
3799
3800 if (ffname == NULL)
3801 return FAIL;
3802 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3803 pat = alloc(len);
3804 if (pat == NULL)
3805 goto theend;
3806 vim_snprintf((char *)pat, len, plugpat, ffname);
3807 source_all_matches(pat);
3808
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003809 {
3810 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3811
3812 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3813 * found when it loads. */
3814 if (cmd != NULL && eval_to_number(cmd) > 0)
3815 {
3816 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3817 vim_snprintf((char *)pat, len, ftpat, ffname);
3818 source_all_matches(pat);
3819 do_cmdline_cmd((char_u *)"augroup END");
3820 }
3821 vim_free(cmd);
3822 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003823 vim_free(pat);
3824 retval = OK;
3825
3826theend:
3827 vim_free(ffname);
3828 return retval;
3829}
3830
3831/* used for "cookie" of add_pack_plugin() */
3832static int APP_ADD_DIR;
3833static int APP_LOAD;
3834static int APP_BOTH;
3835
3836 static void
3837add_pack_plugin(char_u *fname, void *cookie)
3838{
Bram Moolenaarf98a39c2018-04-18 22:18:23 +02003839 if (cookie != &APP_LOAD)
3840 {
3841 char_u *buf = alloc(MAXPATHL);
3842 char_u *p;
3843 int found = FALSE;
3844
3845 if (buf == NULL)
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003846 return;
Bram Moolenaarf98a39c2018-04-18 22:18:23 +02003847 p = p_rtp;
3848 while (*p != NUL)
3849 {
3850 copy_option_part(&p, buf, MAXPATHL, ",");
3851 if (pathcmp((char *)buf, (char *)fname, -1) == 0)
3852 {
3853 found = TRUE;
3854 break;
3855 }
3856 }
3857 vim_free(buf);
3858 if (!found)
3859 /* directory is not yet in 'runtimepath', add it */
3860 if (add_pack_dir_to_rtp(fname) == FAIL)
3861 return;
3862 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003863
3864 if (cookie != &APP_ADD_DIR)
3865 load_pack_plugin(fname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003866}
3867
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003868/*
3869 * Add all packages in the "start" directory to 'runtimepath'.
3870 */
3871 void
3872add_pack_start_dirs(void)
3873{
3874 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3875 add_pack_plugin, &APP_ADD_DIR);
3876}
3877
3878/*
3879 * Load plugins from all packages in the "start" directory.
3880 */
3881 void
3882load_start_packages(void)
3883{
3884 did_source_packages = TRUE;
3885 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3886 add_pack_plugin, &APP_LOAD);
3887}
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003888
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003889/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003890 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003891 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003892 */
3893 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003894ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003895{
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003896 if (!did_source_packages || eap->forceit)
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003897 {
Bram Moolenaar49b27322016-04-05 21:13:00 +02003898 /* First do a round to add all directories to 'runtimepath', then load
3899 * the plugins. This allows for plugins to use an autoload directory
3900 * of another plugin. */
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003901 add_pack_start_dirs();
3902 load_start_packages();
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003903 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003904}
3905
3906/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003907 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003908 */
3909 void
3910ex_packadd(exarg_T *eap)
3911{
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003912 static char *plugpat = "pack/*/%s/%s";
Bram Moolenaar91715872016-03-03 17:13:03 +01003913 int len;
3914 char *pat;
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003915 int round;
3916 int res = OK;
Bram Moolenaar91715872016-03-03 17:13:03 +01003917
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003918 /* Round 1: use "start", round 2: use "opt". */
3919 for (round = 1; round <= 2; ++round)
3920 {
3921 /* Only look under "start" when loading packages wasn't done yet. */
3922 if (round == 1 && did_source_packages)
3923 continue;
3924
3925 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg) + 5;
3926 pat = (char *)alloc(len);
3927 if (pat == NULL)
3928 return;
3929 vim_snprintf(pat, len, plugpat, round == 1 ? "start" : "opt", eap->arg);
3930 /* The first round don't give a "not found" error, in the second round
3931 * only when nothing was found in the first round. */
3932 res = do_in_path(p_pp, (char_u *)pat,
3933 DIP_ALL + DIP_DIR + (round == 2 && res == FAIL ? DIP_ERR : 0),
3934 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
3935 vim_free(pat);
3936 }
Bram Moolenaar91715872016-03-03 17:13:03 +01003937}
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003938#endif
Bram Moolenaar91715872016-03-03 17:13:03 +01003939
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003940#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003941/*
3942 * ":options"
3943 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003944 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003945ex_options(
3946 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003947{
Bram Moolenaarab6c8582017-08-11 17:15:09 +02003948 vim_setenv((char_u *)"OPTWIN_CMD", (char_u *)(cmdmod.tab ? "tab" : ""));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3950}
3951#endif
3952
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003953#if defined(FEAT_PYTHON3) || defined(FEAT_PYTHON) || defined(PROTO)
3954
3955# if (defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)) || defined(PROTO)
3956/*
3957 * Detect Python 3 or 2, and initialize 'pyxversion'.
3958 */
3959 void
3960init_pyxversion(void)
3961{
3962 if (p_pyx == 0)
3963 {
3964 if (python3_enabled(FALSE))
3965 p_pyx = 3;
3966 else if (python_enabled(FALSE))
3967 p_pyx = 2;
3968 }
3969}
3970# endif
3971
3972/*
3973 * Does a file contain one of the following strings at the beginning of any
3974 * line?
3975 * "#!(any string)python2" => returns 2
3976 * "#!(any string)python3" => returns 3
3977 * "# requires python 2.x" => returns 2
3978 * "# requires python 3.x" => returns 3
3979 * otherwise return 0.
3980 */
3981 static int
3982requires_py_version(char_u *filename)
3983{
3984 FILE *file;
3985 int requires_py_version = 0;
3986 int i, lines;
3987
3988 lines = (int)p_mls;
3989 if (lines < 0)
3990 lines = 5;
3991
3992 file = mch_fopen((char *)filename, "r");
3993 if (file != NULL)
3994 {
3995 for (i = 0; i < lines; i++)
3996 {
3997 if (vim_fgets(IObuff, IOSIZE, file))
3998 break;
3999 if (i == 0 && IObuff[0] == '#' && IObuff[1] == '!')
4000 {
4001 /* Check shebang. */
4002 if (strstr((char *)IObuff + 2, "python2") != NULL)
4003 {
4004 requires_py_version = 2;
4005 break;
4006 }
4007 if (strstr((char *)IObuff + 2, "python3") != NULL)
4008 {
4009 requires_py_version = 3;
4010 break;
4011 }
4012 }
4013 IObuff[21] = '\0';
4014 if (STRCMP("# requires python 2.x", IObuff) == 0)
4015 {
4016 requires_py_version = 2;
4017 break;
4018 }
4019 if (STRCMP("# requires python 3.x", IObuff) == 0)
4020 {
4021 requires_py_version = 3;
4022 break;
4023 }
4024 }
4025 fclose(file);
4026 }
4027 return requires_py_version;
4028}
4029
4030
4031/*
4032 * Source a python file using the requested python version.
4033 */
4034 static void
4035source_pyx_file(exarg_T *eap, char_u *fname)
4036{
4037 exarg_T ex;
4038 int v = requires_py_version(fname);
4039
4040# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4041 init_pyxversion();
4042# endif
4043 if (v == 0)
4044 {
4045# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4046 /* user didn't choose a preference, 'pyx' is used */
4047 v = p_pyx;
4048# elif defined(FEAT_PYTHON)
4049 v = 2;
4050# elif defined(FEAT_PYTHON3)
4051 v = 3;
4052# endif
4053 }
4054
4055 /*
4056 * now source, if required python version is not supported show
4057 * unobtrusive message.
4058 */
4059 if (eap == NULL)
4060 vim_memset(&ex, 0, sizeof(ex));
4061 else
4062 ex = *eap;
4063 ex.arg = fname;
4064 ex.cmd = (char_u *)(v == 2 ? "pyfile" : "pyfile3");
4065
4066 if (v == 2)
4067 {
4068# ifdef FEAT_PYTHON
4069 ex_pyfile(&ex);
4070# else
4071 vim_snprintf((char *)IObuff, IOSIZE,
4072 _("W20: Required python version 2.x not supported, ignoring file: %s"),
4073 fname);
4074 MSG(IObuff);
4075# endif
4076 return;
4077 }
4078 else
4079 {
4080# ifdef FEAT_PYTHON3
4081 ex_py3file(&ex);
4082# else
4083 vim_snprintf((char *)IObuff, IOSIZE,
4084 _("W21: Required python version 3.x not supported, ignoring file: %s"),
4085 fname);
4086 MSG(IObuff);
4087# endif
4088 return;
4089 }
4090}
4091
4092/*
4093 * ":pyxfile {fname}"
4094 */
4095 void
4096ex_pyxfile(exarg_T *eap)
4097{
4098 source_pyx_file(eap, eap->arg);
4099}
4100
4101/*
4102 * ":pyx"
4103 */
4104 void
4105ex_pyx(exarg_T *eap)
4106{
4107# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4108 init_pyxversion();
4109 if (p_pyx == 2)
4110 ex_python(eap);
4111 else
4112 ex_py3(eap);
4113# elif defined(FEAT_PYTHON)
4114 ex_python(eap);
4115# elif defined(FEAT_PYTHON3)
4116 ex_py3(eap);
4117# endif
4118}
4119
4120/*
4121 * ":pyxdo"
4122 */
4123 void
4124ex_pyxdo(exarg_T *eap)
4125{
4126# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4127 init_pyxversion();
4128 if (p_pyx == 2)
4129 ex_pydo(eap);
4130 else
4131 ex_py3do(eap);
4132# elif defined(FEAT_PYTHON)
4133 ex_pydo(eap);
4134# elif defined(FEAT_PYTHON3)
4135 ex_py3do(eap);
4136# endif
4137}
4138
4139#endif
4140
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141/*
4142 * ":source {fname}"
4143 */
4144 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004145ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146{
4147#ifdef FEAT_BROWSE
4148 if (cmdmod.browse)
4149 {
4150 char_u *fname = NULL;
4151
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00004152 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaarc36651b2018-04-29 12:22:56 +02004153 NULL, NULL,
4154 (char_u *)_(BROWSE_FILTER_MACROS), NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 if (fname != NULL)
4156 {
4157 cmd_source(fname, eap);
4158 vim_free(fname);
4159 }
4160 }
4161 else
4162#endif
4163 cmd_source(eap->arg, eap);
4164}
4165
4166 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004167cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168{
4169 if (*fname == NUL)
4170 EMSG(_(e_argreq));
4171
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02004173 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004174 * Need to execute the commands directly. This is required at least
4175 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 * - ":g" command busy
4177 * - after ":argdo", ":windo" or ":bufdo"
4178 * - another command follows
4179 * - inside a loop
4180 */
4181 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
4182#ifdef FEAT_EVAL
4183 || eap->cstack->cs_idx >= 0
4184#endif
4185 );
4186
4187 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004188 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004189 EMSG2(_(e_notopen), fname);
4190}
4191
4192/*
4193 * ":source" and associated commands.
4194 */
4195/*
4196 * Structure used to store info for each sourced file.
4197 * It is shared between do_source() and getsourceline().
4198 * This is required, because it needs to be handed to do_cmdline() and
4199 * sourcing can be done recursively.
4200 */
4201struct source_cookie
4202{
4203 FILE *fp; /* opened file for sourcing */
4204 char_u *nextline; /* if not NULL: line that was read ahead */
4205 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004206#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004207 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
4208 int error; /* TRUE if LF found after CR-LF */
4209#endif
4210#ifdef FEAT_EVAL
4211 linenr_T breakpoint; /* next line with breakpoint or zero */
4212 char_u *fname; /* name of sourced file */
4213 int dbg_tick; /* debug_tick when breakpoint was set */
4214 int level; /* top nesting level of sourced file */
4215#endif
4216#ifdef FEAT_MBYTE
4217 vimconv_T conv; /* type of conversion */
4218#endif
4219};
4220
4221#ifdef FEAT_EVAL
4222/*
4223 * Return the address holding the next breakpoint line for a source cookie.
4224 */
4225 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004226source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227{
4228 return &((struct source_cookie *)cookie)->breakpoint;
4229}
4230
4231/*
4232 * Return the address holding the debug tick for a source cookie.
4233 */
4234 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004235source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004236{
4237 return &((struct source_cookie *)cookie)->dbg_tick;
4238}
4239
4240/*
4241 * Return the nesting level for a source cookie.
4242 */
4243 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004244source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245{
4246 return ((struct source_cookie *)cookie)->level;
4247}
4248#endif
4249
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004250static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004251
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004252#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
4253# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004254static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255
4256/*
4257 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004258 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 */
4260 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004261fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004263# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01004264 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
4265# else
4266 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004267# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268
4269 if (fd_tmp == -1)
4270 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004271
4272# ifdef HAVE_FD_CLOEXEC
4273 {
4274 int fdflags = fcntl(fd_tmp, F_GETFD);
4275 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02004276 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004277 }
4278# endif
4279
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 return fdopen(fd_tmp, READBIN);
4281}
4282#endif
4283
4284
4285/*
4286 * do_source: Read the file "fname" and execute its lines as EX commands.
4287 *
4288 * This function may be called recursively!
4289 *
4290 * return FAIL if file could not be opened, OK otherwise
4291 */
4292 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004293do_source(
4294 char_u *fname,
4295 int check_other, /* check for .vimrc and _vimrc */
4296 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297{
4298 struct source_cookie cookie;
4299 char_u *save_sourcing_name;
4300 linenr_T save_sourcing_lnum;
4301 char_u *p;
4302 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00004303 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004304 int retval = FAIL;
4305#ifdef FEAT_EVAL
4306 scid_T save_current_SID;
4307 static scid_T last_current_SID = 0;
4308 void *save_funccalp;
4309 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004310 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004311# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02004312 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004313 int stat_ok;
4314# endif
4315#endif
4316#ifdef STARTUPTIME
4317 struct timeval tv_rel;
4318 struct timeval tv_start;
4319#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004320#ifdef FEAT_PROFILE
4321 proftime_T wait_start;
4322#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004325 if (p == NULL)
4326 return retval;
4327 fname_exp = fix_fname(p);
4328 vim_free(p);
4329 if (fname_exp == NULL)
4330 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331 if (mch_isdir(fname_exp))
4332 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00004333 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334 goto theend;
4335 }
4336
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004337 /* Apply SourceCmd autocommands, they should get the file and source it. */
4338 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
4339 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
4340 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004341 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004342#ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004343 retval = aborting() ? FAIL : OK;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004344#else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004345 retval = OK;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004346#endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004347 goto theend;
4348 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004349
4350 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004351 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004352
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004353#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4355#else
4356 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4357#endif
4358 if (cookie.fp == NULL && check_other)
4359 {
4360 /*
4361 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
4362 * and ".exrc" by "_exrc" or vice versa.
4363 */
4364 p = gettail(fname_exp);
4365 if ((*p == '.' || *p == '_')
4366 && (STRICMP(p + 1, "vimrc") == 0
4367 || STRICMP(p + 1, "gvimrc") == 0
4368 || STRICMP(p + 1, "exrc") == 0))
4369 {
4370 if (*p == '_')
4371 *p = '.';
4372 else
4373 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004374#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4376#else
4377 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4378#endif
4379 }
4380 }
4381
4382 if (cookie.fp == NULL)
4383 {
4384 if (p_verbose > 0)
4385 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004386 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004387 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004388 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 else
4390 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004391 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004392 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 }
4394 goto theend;
4395 }
4396
4397 /*
4398 * The file exists.
4399 * - In verbose mode, give a message.
4400 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
4401 */
4402 if (p_verbose > 1)
4403 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004404 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004406 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 else
4408 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004409 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004410 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004412 if (is_vimrc == DOSO_VIMRC)
4413 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
4414 else if (is_vimrc == DOSO_GVIMRC)
4415 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416
4417#ifdef USE_CRNL
4418 /* If no automatic file format: Set default to CR-NL. */
4419 if (*p_ffs == NUL)
4420 cookie.fileformat = EOL_DOS;
4421 else
4422 cookie.fileformat = EOL_UNKNOWN;
4423 cookie.error = FALSE;
4424#endif
4425
4426#ifdef USE_CR
4427 /* If no automatic file format: Set default to CR. */
4428 if (*p_ffs == NUL)
4429 cookie.fileformat = EOL_MAC;
4430 else
4431 cookie.fileformat = EOL_UNKNOWN;
4432 cookie.error = FALSE;
4433#endif
4434
4435 cookie.nextline = NULL;
4436 cookie.finished = FALSE;
4437
4438#ifdef FEAT_EVAL
4439 /*
4440 * Check if this script has a breakpoint.
4441 */
4442 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
4443 cookie.fname = fname_exp;
4444 cookie.dbg_tick = debug_tick;
4445
4446 cookie.level = ex_nesting_level;
4447#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448
4449 /*
4450 * Keep the sourcing name/lnum, for recursive calls.
4451 */
4452 save_sourcing_name = sourcing_name;
4453 sourcing_name = fname_exp;
4454 save_sourcing_lnum = sourcing_lnum;
4455 sourcing_lnum = 0;
4456
4457#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004458 if (time_fd != NULL)
4459 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004460#endif
4461
4462#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00004463# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004464 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004465 prof_child_enter(&wait_start); /* entering a child now */
4466# endif
4467
4468 /* Don't use local function variables, if called from a function.
4469 * Also starts profiling timer for nested script. */
4470 save_funccalp = save_funccal();
4471
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 /*
4473 * Check if this script was sourced before to finds its SID.
4474 * If it's new, generate a new SID.
4475 */
4476 save_current_SID = current_SID;
4477# ifdef UNIX
4478 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
4479# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004480 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
4481 {
4482 si = &SCRIPT_ITEM(current_SID);
4483 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 && (
4485# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00004486 /* Compare dev/ino when possible, it catches symbolic
4487 * links. Also compare file names, the inode may change
4488 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004489 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004490 && (si->sn_dev == st.st_dev
4491 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004493 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004495 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 if (current_SID == 0)
4497 {
4498 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004499 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
4500 == FAIL)
4501 goto almosttheend;
4502 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00004504 ++script_items.ga_len;
4505 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
4506# ifdef FEAT_PROFILE
4507 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004510 si = &SCRIPT_ITEM(current_SID);
4511 si->sn_name = fname_exp;
4512 fname_exp = NULL;
4513# ifdef UNIX
4514 if (stat_ok)
4515 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004516 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004517 si->sn_dev = st.st_dev;
4518 si->sn_ino = st.st_ino;
4519 }
4520 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004521 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004522# endif
4523
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524 /* Allocate the local script variables to use for this script. */
4525 new_script_vars(current_SID);
4526 }
4527
Bram Moolenaar05159a02005-02-26 23:04:13 +00004528# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004529 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004530 {
4531 int forceit;
4532
4533 /* Check if we do profiling for this script. */
4534 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
4535 {
4536 script_do_profile(si);
4537 si->sn_pr_force = forceit;
4538 }
4539 if (si->sn_prof_on)
4540 {
4541 ++si->sn_pr_count;
4542 profile_start(&si->sn_pr_start);
4543 profile_zero(&si->sn_pr_children);
4544 }
4545 }
4546# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547#endif
4548
Bram Moolenaar67435d92017-10-19 21:04:37 +02004549#ifdef FEAT_MBYTE
4550 cookie.conv.vc_type = CONV_NONE; /* no conversion */
4551
4552 /* Read the first line so we can check for a UTF-8 BOM. */
4553 firstline = getsourceline(0, (void *)&cookie, 0);
4554 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
4555 && firstline[1] == 0xbb && firstline[2] == 0xbf)
4556 {
4557 /* Found BOM; setup conversion, skip over BOM and recode the line. */
4558 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
4559 p = string_convert(&cookie.conv, firstline + 3, NULL);
4560 if (p == NULL)
4561 p = vim_strsave(firstline + 3);
4562 if (p != NULL)
4563 {
4564 vim_free(firstline);
4565 firstline = p;
4566 }
4567 }
4568#endif
4569
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570 /*
4571 * Call do_cmdline, which will call getsourceline() to get the lines.
4572 */
Bram Moolenaar73881402009-02-04 16:50:47 +00004573 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004576
4577#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004578 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004579 {
4580 /* Get "si" again, "script_items" may have been reallocated. */
4581 si = &SCRIPT_ITEM(current_SID);
4582 if (si->sn_prof_on)
4583 {
4584 profile_end(&si->sn_pr_start);
4585 profile_sub_wait(&wait_start, &si->sn_pr_start);
4586 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004587 profile_self(&si->sn_pr_self, &si->sn_pr_start,
4588 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004589 }
4590 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591#endif
4592
4593 if (got_int)
4594 EMSG(_(e_interr));
4595 sourcing_name = save_sourcing_name;
4596 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 if (p_verbose > 1)
4598 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004599 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004600 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004602 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004603 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004604 }
4605#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004606 if (time_fd != NULL)
4607 {
4608 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4609 time_msg((char *)IObuff, &tv_start);
4610 time_pop(&tv_rel);
4611 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612#endif
4613
4614#ifdef FEAT_EVAL
4615 /*
4616 * After a "finish" in debug mode, need to break at first command of next
4617 * sourced file.
4618 */
4619 if (save_debug_break_level > ex_nesting_level
4620 && debug_break_level == ex_nesting_level)
4621 ++debug_break_level;
4622#endif
4623
Bram Moolenaar05159a02005-02-26 23:04:13 +00004624#ifdef FEAT_EVAL
4625almosttheend:
4626 current_SID = save_current_SID;
4627 restore_funccal(save_funccalp);
4628# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004629 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004630 prof_child_exit(&wait_start); /* leaving a child now */
4631# endif
4632#endif
4633 fclose(cookie.fp);
4634 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004635 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004636#ifdef FEAT_MBYTE
4637 convert_setup(&cookie.conv, NULL, NULL);
4638#endif
4639
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640theend:
4641 vim_free(fname_exp);
4642 return retval;
4643}
4644
4645#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004646
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647/*
4648 * ":scriptnames"
4649 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004651ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652{
4653 int i;
4654
Bram Moolenaar05159a02005-02-26 23:04:13 +00004655 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4656 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004657 {
4658 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4659 NameBuff, MAXPATHL, TRUE);
4660 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004661 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004662}
4663
4664# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4665/*
4666 * Fix slashes in the list of script names for 'shellslash'.
4667 */
4668 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004669scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670{
4671 int i;
4672
Bram Moolenaar05159a02005-02-26 23:04:13 +00004673 for (i = 1; i <= script_items.ga_len; ++i)
4674 if (SCRIPT_ITEM(i).sn_name != NULL)
4675 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676}
4677# endif
4678
4679/*
4680 * Get a pointer to a script name. Used for ":verbose set".
4681 */
4682 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004683get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004684{
4685 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004686 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004688 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004690 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004691 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004692 return (char_u *)_("environment variable");
4693 if (id == SID_ERROR)
4694 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004695 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004697
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004698# if defined(EXITFREE) || defined(PROTO)
4699 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004700free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004701{
4702 int i;
4703
4704 for (i = script_items.ga_len; i > 0; --i)
4705 vim_free(SCRIPT_ITEM(i).sn_name);
4706 ga_clear(&script_items);
4707}
4708# endif
4709
Bram Moolenaar071d4272004-06-13 20:20:40 +00004710#endif
4711
4712#if defined(USE_CR) || defined(PROTO)
4713
4714# if defined(__MSL__) && (__MSL__ >= 22)
4715/*
4716 * Newer version of the Metrowerks library handle DOS and UNIX files
4717 * without help.
4718 * Test with earlier versions, MSL 2.2 is the library supplied with
4719 * Codewarrior Pro 2.
4720 */
4721 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004722fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723{
4724 return fgets(s, n, stream);
4725}
4726# else
4727/*
4728 * Version of fgets() which also works for lines ending in a <CR> only
4729 * (Macintosh format).
4730 * For older versions of the Metrowerks library.
4731 * At least CodeWarrior 9 needed this code.
4732 */
4733 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004734fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004735{
4736 int c = 0;
4737 int char_read = 0;
4738
4739 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4740 {
4741 c = fgetc(stream);
4742 s[char_read++] = c;
4743 /* If the file is in DOS format, we need to skip a NL after a CR. I
4744 * thought it was the other way around, but this appears to work... */
4745 if (c == '\n')
4746 {
4747 c = fgetc(stream);
4748 if (c != '\r')
4749 ungetc(c, stream);
4750 }
4751 }
4752
4753 s[char_read] = 0;
4754 if (char_read == 0)
4755 return NULL;
4756
4757 if (feof(stream) && char_read == 1)
4758 return NULL;
4759
4760 return s;
4761}
4762# endif
4763#endif
4764
4765/*
4766 * Get one full line from a sourced file.
4767 * Called by do_cmdline() when it's called from do_source().
4768 *
4769 * Return a pointer to the line in allocated memory.
4770 * Return NULL for end-of-file or some error.
4771 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004772 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004773getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774{
4775 struct source_cookie *sp = (struct source_cookie *)cookie;
4776 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004777 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778
4779#ifdef FEAT_EVAL
4780 /* If breakpoints have been added/deleted need to check for it. */
4781 if (sp->dbg_tick < debug_tick)
4782 {
4783 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4784 sp->dbg_tick = debug_tick;
4785 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004786# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004787 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004788 script_line_end();
4789# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004790#endif
4791 /*
4792 * Get current line. If there is a read-ahead line, use it, otherwise get
4793 * one now.
4794 */
4795 if (sp->finished)
4796 line = NULL;
4797 else if (sp->nextline == NULL)
4798 line = get_one_sourceline(sp);
4799 else
4800 {
4801 line = sp->nextline;
4802 sp->nextline = NULL;
4803 ++sourcing_lnum;
4804 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004805#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004806 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004807 script_line_start();
4808#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809
4810 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4811 * contain the 'C' flag. */
4812 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4813 {
4814 /* compensate for the one line read-ahead */
4815 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004816
4817 /* Get the next line and concatenate it when it starts with a
4818 * backslash. We always need to read the next line, keep it in
4819 * sp->nextline. */
4820 sp->nextline = get_one_sourceline(sp);
4821 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004822 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004823 garray_T ga;
4824
Bram Moolenaarb549a732012-02-22 18:29:33 +01004825 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004826 ga_concat(&ga, line);
4827 ga_concat(&ga, p + 1);
4828 for (;;)
4829 {
4830 vim_free(sp->nextline);
4831 sp->nextline = get_one_sourceline(sp);
4832 if (sp->nextline == NULL)
4833 break;
4834 p = skipwhite(sp->nextline);
4835 if (*p != '\\')
4836 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004837 /* Adjust the growsize to the current length to speed up
4838 * concatenating many lines. */
4839 if (ga.ga_len > 400)
4840 {
4841 if (ga.ga_len > 8000)
4842 ga.ga_growsize = 8000;
4843 else
4844 ga.ga_growsize = ga.ga_len;
4845 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004846 ga_concat(&ga, p + 1);
4847 }
4848 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004850 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 }
4852 }
4853
4854#ifdef FEAT_MBYTE
4855 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4856 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004857 char_u *s;
4858
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 /* Convert the encoding of the script line. */
4860 s = string_convert(&sp->conv, line, NULL);
4861 if (s != NULL)
4862 {
4863 vim_free(line);
4864 line = s;
4865 }
4866 }
4867#endif
4868
4869#ifdef FEAT_EVAL
4870 /* Did we encounter a breakpoint? */
4871 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4872 {
4873 dbg_breakpoint(sp->fname, sourcing_lnum);
4874 /* Find next breakpoint. */
4875 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4876 sp->dbg_tick = debug_tick;
4877 }
4878#endif
4879
4880 return line;
4881}
4882
4883 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004884get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885{
4886 garray_T ga;
4887 int len;
4888 int c;
4889 char_u *buf;
4890#ifdef USE_CRNL
4891 int has_cr; /* CR-LF found */
4892#endif
4893#ifdef USE_CR
4894 char_u *scan;
4895#endif
4896 int have_read = FALSE;
4897
4898 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004899 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004900
4901 /*
4902 * Loop until there is a finished line (or end-of-file).
4903 */
4904 sourcing_lnum++;
4905 for (;;)
4906 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004907 /* make room to read at least 120 (more) characters */
4908 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909 break;
4910 buf = (char_u *)ga.ga_data;
4911
4912#ifdef USE_CR
4913 if (sp->fileformat == EOL_MAC)
4914 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004915 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4916 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004917 break;
4918 }
4919 else
4920#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004921 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4922 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004924 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925#ifdef USE_CRNL
4926 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4927 * CTRL-Z by its own, or after a NL. */
4928 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4929 && sp->fileformat == EOL_DOS
4930 && buf[len - 1] == Ctrl_Z)
4931 {
4932 buf[len - 1] = NUL;
4933 break;
4934 }
4935#endif
4936
4937#ifdef USE_CR
4938 /* If the read doesn't stop on a new line, and there's
4939 * some CR then we assume a Mac format */
4940 if (sp->fileformat == EOL_UNKNOWN)
4941 {
4942 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4943 sp->fileformat = EOL_MAC;
4944 else
4945 sp->fileformat = EOL_UNIX;
4946 }
4947
4948 if (sp->fileformat == EOL_MAC)
4949 {
4950 scan = vim_strchr(buf, '\r');
4951
4952 if (scan != NULL)
4953 {
4954 *scan = '\n';
4955 if (*(scan + 1) != 0)
4956 {
4957 *(scan + 1) = 0;
4958 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4959 }
4960 }
4961 len = STRLEN(buf);
4962 }
4963#endif
4964
4965 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 ga.ga_len = len;
4967
4968 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004969 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 continue;
4971
4972 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4973 {
4974#ifdef USE_CRNL
4975 has_cr = (len >= 2 && buf[len - 2] == '\r');
4976 if (sp->fileformat == EOL_UNKNOWN)
4977 {
4978 if (has_cr)
4979 sp->fileformat = EOL_DOS;
4980 else
4981 sp->fileformat = EOL_UNIX;
4982 }
4983
4984 if (sp->fileformat == EOL_DOS)
4985 {
4986 if (has_cr) /* replace trailing CR */
4987 {
4988 buf[len - 2] = '\n';
4989 --len;
4990 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004991 }
4992 else /* lines like ":map xx yy^M" will have failed */
4993 {
4994 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004995 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01004996 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004998 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004999 sp->error = TRUE;
5000 sp->fileformat = EOL_UNIX;
5001 }
5002 }
5003#endif
5004 /* The '\n' is escaped if there is an odd number of ^V's just
5005 * before it, first set "c" just before the 'V's and then check
5006 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
5007 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
5008 ;
5009 if ((len & 1) != (c & 1)) /* escaped NL, read more */
5010 {
5011 sourcing_lnum++;
5012 continue;
5013 }
5014
5015 buf[len - 1] = NUL; /* remove the NL */
5016 }
5017
5018 /*
5019 * Check for ^C here now and then, so recursive :so can be broken.
5020 */
5021 line_breakcheck();
5022 break;
5023 }
5024
5025 if (have_read)
5026 return (char_u *)ga.ga_data;
5027
5028 vim_free(ga.ga_data);
5029 return NULL;
5030}
5031
Bram Moolenaar05159a02005-02-26 23:04:13 +00005032#if defined(FEAT_PROFILE) || defined(PROTO)
5033/*
5034 * Called when starting to read a script line.
5035 * "sourcing_lnum" must be correct!
5036 * When skipping lines it may not actually be executed, but we won't find out
5037 * until later and we need to store the time now.
5038 */
5039 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005040script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005041{
5042 scriptitem_T *si;
5043 sn_prl_T *pp;
5044
5045 if (current_SID <= 0 || current_SID > script_items.ga_len)
5046 return;
5047 si = &SCRIPT_ITEM(current_SID);
5048 if (si->sn_prof_on && sourcing_lnum >= 1)
5049 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005050 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00005051 * here isn't counted. */
Bram Moolenaar67435d92017-10-19 21:04:37 +02005052 (void)ga_grow(&si->sn_prl_ga,
5053 (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00005054 si->sn_prl_idx = sourcing_lnum - 1;
5055 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
5056 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
5057 {
5058 /* Zero counters for a line that was not used before. */
5059 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
5060 pp->snp_count = 0;
5061 profile_zero(&pp->sn_prl_total);
5062 profile_zero(&pp->sn_prl_self);
5063 ++si->sn_prl_ga.ga_len;
5064 }
5065 si->sn_prl_execed = FALSE;
5066 profile_start(&si->sn_prl_start);
5067 profile_zero(&si->sn_prl_children);
5068 profile_get_wait(&si->sn_prl_wait);
5069 }
5070}
5071
5072/*
5073 * Called when actually executing a function line.
5074 */
5075 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005076script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005077{
5078 scriptitem_T *si;
5079
5080 if (current_SID <= 0 || current_SID > script_items.ga_len)
5081 return;
5082 si = &SCRIPT_ITEM(current_SID);
5083 if (si->sn_prof_on && si->sn_prl_idx >= 0)
5084 si->sn_prl_execed = TRUE;
5085}
5086
5087/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02005088 * Called when done with a script line.
Bram Moolenaar05159a02005-02-26 23:04:13 +00005089 */
5090 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005091script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005092{
5093 scriptitem_T *si;
5094 sn_prl_T *pp;
5095
5096 if (current_SID <= 0 || current_SID > script_items.ga_len)
5097 return;
5098 si = &SCRIPT_ITEM(current_SID);
5099 if (si->sn_prof_on && si->sn_prl_idx >= 0
5100 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
5101 {
5102 if (si->sn_prl_execed)
5103 {
5104 pp = &PRL_ITEM(si, si->sn_prl_idx);
5105 ++pp->snp_count;
5106 profile_end(&si->sn_prl_start);
5107 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005108 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00005109 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
5110 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005111 }
5112 si->sn_prl_idx = -1;
5113 }
5114}
5115#endif
5116
Bram Moolenaar071d4272004-06-13 20:20:40 +00005117/*
5118 * ":scriptencoding": Set encoding conversion for a sourced script.
5119 * Without the multi-byte feature it's simply ignored.
5120 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005121 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005122ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123{
5124#ifdef FEAT_MBYTE
5125 struct source_cookie *sp;
5126 char_u *name;
5127
5128 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
5129 {
5130 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
5131 return;
5132 }
5133
5134 if (*eap->arg != NUL)
5135 {
5136 name = enc_canonize(eap->arg);
5137 if (name == NULL) /* out of memory */
5138 return;
5139 }
5140 else
5141 name = eap->arg;
5142
5143 /* Setup for conversion from the specified encoding to 'encoding'. */
5144 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
5145 convert_setup(&sp->conv, name, p_enc);
5146
5147 if (name != eap->arg)
5148 vim_free(name);
5149#endif
5150}
5151
5152#if defined(FEAT_EVAL) || defined(PROTO)
5153/*
5154 * ":finish": Mark a sourced file as finished.
5155 */
5156 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005157ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158{
5159 if (getline_equal(eap->getline, eap->cookie, getsourceline))
5160 do_finish(eap, FALSE);
5161 else
5162 EMSG(_("E168: :finish used outside of a sourced file"));
5163}
5164
5165/*
5166 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
5167 * Also called for a pending finish at the ":endtry" or after returning from
5168 * an extra do_cmdline(). "reanimate" is used in the latter case.
5169 */
5170 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005171do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172{
5173 int idx;
5174
5175 if (reanimate)
5176 ((struct source_cookie *)getline_cookie(eap->getline,
5177 eap->cookie))->finished = FALSE;
5178
5179 /*
5180 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5181 * not in its finally clause (which then is to be executed next) is found.
5182 * In this case, make the ":finish" pending for execution at the ":endtry".
5183 * Otherwise, finish normally.
5184 */
5185 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5186 if (idx >= 0)
5187 {
5188 eap->cstack->cs_pending[idx] = CSTP_FINISH;
5189 report_make_pending(CSTP_FINISH, NULL);
5190 }
5191 else
5192 ((struct source_cookie *)getline_cookie(eap->getline,
5193 eap->cookie))->finished = TRUE;
5194}
5195
5196
5197/*
5198 * Return TRUE when a sourced file had the ":finish" command: Don't give error
5199 * message for missing ":endif".
5200 * Return FALSE when not sourcing a file.
5201 */
5202 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005203source_finished(
5204 char_u *(*fgetline)(int, void *, int),
5205 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206{
Bram Moolenaar89d40322006-08-29 15:30:07 +00005207 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00005209 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210}
5211#endif
5212
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213/*
5214 * ":checktime [buffer]"
5215 */
5216 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005217ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218{
5219 buf_T *buf;
5220 int save_no_check_timestamps = no_check_timestamps;
5221
5222 no_check_timestamps = 0;
5223 if (eap->addr_count == 0) /* default is all buffers */
5224 check_timestamps(FALSE);
5225 else
5226 {
5227 buf = buflist_findnr((int)eap->line2);
5228 if (buf != NULL) /* cannot happen? */
5229 (void)buf_check_timestamp(buf, FALSE);
5230 }
5231 no_check_timestamps = save_no_check_timestamps;
5232}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5235 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005236# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005237static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005239 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005240get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005242 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243
Bram Moolenaar48e330a2016-02-23 14:53:34 +01005244 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005245 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005247# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 if (loc != NULL)
5249 {
5250 char_u *p;
5251
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005252 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
5253 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 p = vim_strchr(loc, '=');
5255 if (p != NULL)
5256 {
5257 loc = ++p;
5258 while (*p != NUL) /* remove trailing newline */
5259 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005260 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 {
5262 *p = NUL;
5263 break;
5264 }
5265 ++p;
5266 }
5267 }
5268 }
5269# endif
5270
5271 return loc;
5272}
5273#endif
5274
5275
5276#ifdef WIN32
5277/*
5278 * On MS-Windows locale names are strings like "German_Germany.1252", but
5279 * gettext expects "de". Try to translate one into another here for a few
5280 * supported languages.
5281 */
5282 static char_u *
5283gettext_lang(char_u *name)
5284{
5285 int i;
5286 static char *(mtable[]) = {
5287 "afrikaans", "af",
5288 "czech", "cs",
5289 "dutch", "nl",
5290 "german", "de",
5291 "english_united kingdom", "en_GB",
5292 "spanish", "es",
5293 "french", "fr",
5294 "italian", "it",
5295 "japanese", "ja",
5296 "korean", "ko",
5297 "norwegian", "no",
5298 "polish", "pl",
5299 "russian", "ru",
5300 "slovak", "sk",
5301 "swedish", "sv",
5302 "ukrainian", "uk",
5303 "chinese_china", "zh_CN",
5304 "chinese_taiwan", "zh_TW",
5305 NULL};
5306
5307 for (i = 0; mtable[i] != NULL; i += 2)
5308 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005309 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005310 return name;
5311}
5312#endif
5313
5314#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5315/*
5316 * Obtain the current messages language. Used to set the default for
5317 * 'helplang'. May return NULL or an empty string.
5318 */
5319 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005320get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321{
5322 char_u *p;
5323
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005324# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005326 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327# else
5328 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005329 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
5330 * and LC_MONETARY may be set differently for a Japanese working in the
5331 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005332 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333# endif
5334# else
5335 p = mch_getenv((char_u *)"LC_ALL");
5336 if (p == NULL || *p == NUL)
5337 {
5338 p = mch_getenv((char_u *)"LC_MESSAGES");
5339 if (p == NULL || *p == NUL)
5340 p = mch_getenv((char_u *)"LANG");
5341 }
5342# endif
5343# ifdef WIN32
5344 p = gettext_lang(p);
5345# endif
5346 return p;
5347}
5348#endif
5349
Bram Moolenaardef9e822004-12-31 20:58:58 +00005350/* Complicated #if; matches with where get_mess_env() is used below. */
5351#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5352 && defined(LC_MESSAGES))) \
5353 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5354 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
5355 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01005356static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005357
5358/*
5359 * Get the language used for messages from the environment.
5360 */
5361 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005362get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005363{
5364 char_u *p;
5365
5366 p = mch_getenv((char_u *)"LC_ALL");
5367 if (p == NULL || *p == NUL)
5368 {
5369 p = mch_getenv((char_u *)"LC_MESSAGES");
5370 if (p == NULL || *p == NUL)
5371 {
5372 p = mch_getenv((char_u *)"LANG");
5373 if (p != NULL && VIM_ISDIGIT(*p))
5374 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005375# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005377 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005378# endif
5379 }
5380 }
5381 return p;
5382}
5383#endif
5384
5385#if defined(FEAT_EVAL) || defined(PROTO)
5386
5387/*
5388 * Set the "v:lang" variable according to the current locale setting.
5389 * Also do "v:lc_time"and "v:ctype".
5390 */
5391 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005392set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393{
5394 char_u *loc;
5395
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005396# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005397 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398# else
5399 /* setlocale() not supported: use the default value */
5400 loc = (char_u *)"C";
5401# endif
5402 set_vim_var_string(VV_CTYPE, loc, -1);
5403
5404 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
5405 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005406# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005407 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408# else
5409 loc = get_mess_env();
5410# endif
5411 set_vim_var_string(VV_LANG, loc, -1);
5412
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005413# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005414 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415# endif
5416 set_vim_var_string(VV_LC_TIME, loc, -1);
5417}
5418#endif
5419
5420#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5421 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
5422/*
5423 * ":language": Set the language (locale).
5424 */
5425 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005426ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005427{
5428 char *loc;
5429 char_u *p;
5430 char_u *name;
5431 int what = LC_ALL;
5432 char *whatstr = "";
5433#ifdef LC_MESSAGES
5434# define VIM_LC_MESSAGES LC_MESSAGES
5435#else
5436# define VIM_LC_MESSAGES 6789
5437#endif
5438
5439 name = eap->arg;
5440
5441 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
5442 * Allow abbreviation, but require at least 3 characters to avoid
5443 * confusion with a two letter language name "me" or "ct". */
5444 p = skiptowhite(eap->arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005445 if ((*p == NUL || VIM_ISWHITE(*p)) && p - eap->arg >= 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005446 {
5447 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
5448 {
5449 what = VIM_LC_MESSAGES;
5450 name = skipwhite(p);
5451 whatstr = "messages ";
5452 }
5453 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
5454 {
5455 what = LC_CTYPE;
5456 name = skipwhite(p);
5457 whatstr = "ctype ";
5458 }
5459 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
5460 {
5461 what = LC_TIME;
5462 name = skipwhite(p);
5463 whatstr = "time ";
5464 }
5465 }
5466
5467 if (*name == NUL)
5468 {
5469#ifndef LC_MESSAGES
5470 if (what == VIM_LC_MESSAGES)
5471 p = get_mess_env();
5472 else
5473#endif
5474 p = (char_u *)setlocale(what, NULL);
5475 if (p == NULL || *p == NUL)
5476 p = (char_u *)"Unknown";
5477 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
5478 }
5479 else
5480 {
5481#ifndef LC_MESSAGES
5482 if (what == VIM_LC_MESSAGES)
5483 loc = "";
5484 else
5485#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005486 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005488#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
5489 /* Make sure strtod() uses a decimal point, not a comma. */
5490 setlocale(LC_NUMERIC, "C");
5491#endif
5492 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005493 if (loc == NULL)
5494 EMSG2(_("E197: Cannot set language to \"%s\""), name);
5495 else
5496 {
5497#ifdef HAVE_NL_MSG_CAT_CNTR
5498 /* Need to do this for GNU gettext, otherwise cached translations
5499 * will be used again. */
5500 extern int _nl_msg_cat_cntr;
5501
5502 ++_nl_msg_cat_cntr;
5503#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00005504 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005505 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
5506
5507 if (what != LC_TIME)
5508 {
5509 /* Tell gettext() what to translate to. It apparently doesn't
5510 * use the currently effective locale. Also do this when
5511 * FEAT_GETTEXT isn't defined, so that shell commands use this
5512 * value. */
5513 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005514 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02005516
5517 /* Clear $LANGUAGE because GNU gettext uses it. */
5518 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005519# ifdef WIN32
5520 /* Apparently MS-Windows printf() may cause a crash when
5521 * we give it 8-bit text while it's expecting text in the
5522 * current locale. This call avoids that. */
5523 setlocale(LC_CTYPE, "C");
5524# endif
5525 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005526 if (what != LC_CTYPE)
5527 {
5528 char_u *mname;
5529#ifdef WIN32
5530 mname = gettext_lang(name);
5531#else
5532 mname = name;
5533#endif
5534 vim_setenv((char_u *)"LC_MESSAGES", mname);
5535#ifdef FEAT_MULTI_LANG
5536 set_helplang_default(mname);
5537#endif
5538 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005539 }
5540
5541# ifdef FEAT_EVAL
5542 /* Set v:lang, v:lc_time and v:ctype to the final result. */
5543 set_lang_var();
5544# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02005545# ifdef FEAT_TITLE
5546 maketitle();
5547# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 }
5549 }
5550}
5551
5552# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005553
5554static char_u **locales = NULL; /* Array of all available locales */
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005555
5556# ifndef WIN32
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005557static int did_init_locales = FALSE;
5558
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005559/* Return an array of strings for all available locales + NULL for the
5560 * last element. Return NULL in case of error. */
5561 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005562find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005563{
5564 garray_T locales_ga;
5565 char_u *loc;
5566
5567 /* Find all available locales by running command "locale -a". If this
5568 * doesn't work we won't have completion. */
5569 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02005570 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005571 if (locale_a == NULL)
5572 return NULL;
5573 ga_init2(&locales_ga, sizeof(char_u *), 20);
5574
5575 /* Transform locale_a string where each locale is separated by "\n"
5576 * into an array of locale strings. */
5577 loc = (char_u *)strtok((char *)locale_a, "\n");
5578
5579 while (loc != NULL)
5580 {
5581 if (ga_grow(&locales_ga, 1) == FAIL)
5582 break;
5583 loc = vim_strsave(loc);
5584 if (loc == NULL)
5585 break;
5586
5587 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5588 loc = (char_u *)strtok(NULL, "\n");
5589 }
5590 vim_free(locale_a);
5591 if (ga_grow(&locales_ga, 1) == FAIL)
5592 {
5593 ga_clear(&locales_ga);
5594 return NULL;
5595 }
5596 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5597 return (char_u **)locales_ga.ga_data;
5598}
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005599# endif
5600
5601/*
5602 * Lazy initialization of all available locales.
5603 */
5604 static void
5605init_locales(void)
5606{
5607# ifndef WIN32
5608 if (!did_init_locales)
5609 {
5610 did_init_locales = TRUE;
5611 locales = find_locales();
5612 }
5613# endif
5614}
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005615
5616# if defined(EXITFREE) || defined(PROTO)
5617 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005618free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005619{
5620 int i;
5621 if (locales != NULL)
5622 {
5623 for (i = 0; locales[i] != NULL; i++)
5624 vim_free(locales[i]);
Bram Moolenaard23a8232018-02-10 18:45:26 +01005625 VIM_CLEAR(locales);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005626 }
5627}
5628# endif
5629
Bram Moolenaar071d4272004-06-13 20:20:40 +00005630/*
5631 * Function given to ExpandGeneric() to obtain the possible arguments of the
5632 * ":language" command.
5633 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005635get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005636{
5637 if (idx == 0)
5638 return (char_u *)"messages";
5639 if (idx == 1)
5640 return (char_u *)"ctype";
5641 if (idx == 2)
5642 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005643
5644 init_locales();
5645 if (locales == NULL)
5646 return NULL;
5647 return locales[idx - 3];
5648}
5649
5650/*
5651 * Function given to ExpandGeneric() to obtain the available locales.
5652 */
5653 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005654get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005655{
5656 init_locales();
5657 if (locales == NULL)
5658 return NULL;
5659 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005660}
5661# endif
5662
5663#endif