blob: 394662741611d87f77e278938d2bd61a04e9144b [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_cmds2.c: some more functions for command line commands
12 */
13
Bram Moolenaar071d4272004-06-13 20:20:40 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010017static void cmd_source(char_u *fname, exarg_T *eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +000018
Bram Moolenaar05159a02005-02-26 23:04:13 +000019#ifdef FEAT_EVAL
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000020/* Growarray to store info about already sourced scripts.
Bram Moolenaar05159a02005-02-26 23:04:13 +000021 * For Unix also store the dev/ino, so that we don't have to stat() each
22 * script when going through the list. */
23typedef struct scriptitem_S
24{
25 char_u *sn_name;
26# ifdef UNIX
Bram Moolenaarbf0c4522009-05-16 19:16:33 +000027 int sn_dev_valid;
28 dev_t sn_dev;
Bram Moolenaar05159a02005-02-26 23:04:13 +000029 ino_t sn_ino;
30# endif
31# ifdef FEAT_PROFILE
32 int sn_prof_on; /* TRUE when script is/was profiled */
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000033 int sn_pr_force; /* forceit: profile functions in this script */
Bram Moolenaar05159a02005-02-26 23:04:13 +000034 proftime_T sn_pr_child; /* time set when going into first child */
35 int sn_pr_nest; /* nesting for sn_pr_child */
36 /* profiling the script as a whole */
37 int sn_pr_count; /* nr of times sourced */
Bram Moolenaar8c8de832008-06-24 22:58:06 +000038 proftime_T sn_pr_total; /* time spent in script + children */
39 proftime_T sn_pr_self; /* time spent in script itself */
Bram Moolenaar05159a02005-02-26 23:04:13 +000040 proftime_T sn_pr_start; /* time at script start */
41 proftime_T sn_pr_children; /* time in children after script start */
42 /* profiling the script per line */
43 garray_T sn_prl_ga; /* things stored for every line */
44 proftime_T sn_prl_start; /* start time for current line */
45 proftime_T sn_prl_children; /* time spent in children for this line */
46 proftime_T sn_prl_wait; /* wait start time for current line */
47 int sn_prl_idx; /* index of line being timed; -1 if none */
48 int sn_prl_execed; /* line being timed was executed */
49# endif
50} scriptitem_T;
51
52static garray_T script_items = {0, 0, sizeof(scriptitem_T), 4, NULL};
53#define SCRIPT_ITEM(id) (((scriptitem_T *)script_items.ga_data)[(id) - 1])
54
55# ifdef FEAT_PROFILE
56/* Struct used in sn_prl_ga for every line of a script. */
57typedef struct sn_prl_S
58{
59 int snp_count; /* nr of times line was executed */
Bram Moolenaar8c8de832008-06-24 22:58:06 +000060 proftime_T sn_prl_total; /* time spent in a line + children */
61 proftime_T sn_prl_self; /* time spent in a line itself */
Bram Moolenaar05159a02005-02-26 23:04:13 +000062} sn_prl_T;
63
64# define PRL_ITEM(si, idx) (((sn_prl_T *)(si)->sn_prl_ga.ga_data)[(idx)])
65# endif
66#endif
67
Bram Moolenaar071d4272004-06-13 20:20:40 +000068#if defined(FEAT_EVAL) || defined(PROTO)
69static int debug_greedy = FALSE; /* batch mode debugging: don't save
70 and restore typeahead. */
Bram Moolenaarf1f60f82016-01-16 15:40:53 +010071static int get_maxbacktrace_level(void);
72static void do_setdebugtracelevel(char_u *arg);
73static void do_checkbacktracelevel(void);
74static void do_showbacktrace(char_u *cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +000075
Bram Moolenaarc6f9f732018-02-11 19:06:26 +010076static char_u *debug_oldval = NULL; /* old and newval for debug expressions */
77static char_u *debug_newval = NULL;
78static int debug_expr = 0; /* use debug_expr */
79
80 int
81has_watchexpr(void)
82{
83 return debug_expr;
84}
85
Bram Moolenaar071d4272004-06-13 20:20:40 +000086/*
87 * do_debug(): Debug mode.
88 * Repeatedly get Ex commands, until told to continue normal execution.
89 */
90 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010091do_debug(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +000092{
93 int save_msg_scroll = msg_scroll;
94 int save_State = State;
95 int save_did_emsg = did_emsg;
96 int save_cmd_silent = cmd_silent;
97 int save_msg_silent = msg_silent;
98 int save_emsg_silent = emsg_silent;
99 int save_redir_off = redir_off;
100 tasave_T typeaheadbuf;
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000101 int typeahead_saved = FALSE;
Bram Moolenaar383c6f52008-01-04 15:01:07 +0000102 int save_ignore_script = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103 int save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104 int n;
105 char_u *cmdline = NULL;
106 char_u *p;
107 char *tail = NULL;
108 static int last_cmd = 0;
109#define CMD_CONT 1
110#define CMD_NEXT 2
111#define CMD_STEP 3
112#define CMD_FINISH 4
113#define CMD_QUIT 5
114#define CMD_INTERRUPT 6
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100115#define CMD_BACKTRACE 7
116#define CMD_FRAME 8
117#define CMD_UP 9
118#define CMD_DOWN 10
Bram Moolenaar071d4272004-06-13 20:20:40 +0000119
120#ifdef ALWAYS_USE_GUI
121 /* Can't do this when there is no terminal for input/output. */
122 if (!gui.in_use)
123 {
124 /* Break as soon as possible. */
125 debug_break_level = 9999;
126 return;
127 }
128#endif
129
130 /* Make sure we are in raw mode and start termcap mode. Might have side
131 * effects... */
132 settmode(TMODE_RAW);
133 starttermcap();
134
135 ++RedrawingDisabled; /* don't redisplay the window */
136 ++no_wait_return; /* don't wait for return */
137 did_emsg = FALSE; /* don't use error from debugged stuff */
138 cmd_silent = FALSE; /* display commands */
139 msg_silent = FALSE; /* display messages */
140 emsg_silent = FALSE; /* display error messages */
141 redir_off = TRUE; /* don't redirect debug commands */
142
143 State = NORMAL;
Bram Moolenaard99388b2017-10-26 14:28:32 +0200144 debug_mode = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146 if (!debug_did_msg)
147 MSG(_("Entering Debug mode. Type \"cont\" to continue."));
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100148 if (debug_oldval != NULL)
149 {
150 smsg((char_u *)_("Oldval = \"%s\""), debug_oldval);
151 vim_free(debug_oldval);
152 debug_oldval = NULL;
153 }
154 if (debug_newval != NULL)
155 {
156 smsg((char_u *)_("Newval = \"%s\""), debug_newval);
157 vim_free(debug_newval);
158 debug_newval = NULL;
159 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160 if (sourcing_name != NULL)
161 msg(sourcing_name);
162 if (sourcing_lnum != 0)
Bram Moolenaar555b2802005-05-19 21:08:39 +0000163 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000164 else
Bram Moolenaar555b2802005-05-19 21:08:39 +0000165 smsg((char_u *)_("cmd: %s"), cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166 /*
167 * Repeat getting a command and executing it.
168 */
169 for (;;)
170 {
171 msg_scroll = TRUE;
172 need_wait_return = FALSE;
Bram Moolenaar85b11762016-02-27 18:13:23 +0100173
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 /* Save the current typeahead buffer and replace it with an empty one.
175 * This makes sure we get input from the user here and don't interfere
176 * with the commands being executed. Reset "ex_normal_busy" to avoid
177 * the side effects of using ":normal". Save the stuff buffer and make
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000178 * it empty. Set ignore_script to avoid reading from script input. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179 save_ex_normal_busy = ex_normal_busy;
180 ex_normal_busy = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000181 if (!debug_greedy)
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000182 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183 save_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000184 typeahead_saved = TRUE;
185 save_ignore_script = ignore_script;
186 ignore_script = TRUE;
187 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000188
Bram Moolenaardc303bc2016-05-17 17:45:38 +0200189 vim_free(cmdline);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000190 cmdline = getcmdline_prompt('>', NULL, 0, EXPAND_NOTHING, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000192 if (typeahead_saved)
193 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000194 restore_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000195 ignore_script = save_ignore_script;
196 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000197 ex_normal_busy = save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198
199 cmdline_row = msg_row;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100200 msg_starthere();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000201 if (cmdline != NULL)
202 {
203 /* If this is a debug command, set "last_cmd".
204 * If not, reset "last_cmd".
205 * For a blank line use previous command. */
206 p = skipwhite(cmdline);
207 if (*p != NUL)
208 {
209 switch (*p)
210 {
211 case 'c': last_cmd = CMD_CONT;
212 tail = "ont";
213 break;
214 case 'n': last_cmd = CMD_NEXT;
215 tail = "ext";
216 break;
217 case 's': last_cmd = CMD_STEP;
218 tail = "tep";
219 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100220 case 'f':
221 last_cmd = 0;
222 if (p[1] == 'r')
223 {
224 last_cmd = CMD_FRAME;
225 tail = "rame";
226 }
227 else
228 {
229 last_cmd = CMD_FINISH;
230 tail = "inish";
231 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232 break;
233 case 'q': last_cmd = CMD_QUIT;
234 tail = "uit";
235 break;
236 case 'i': last_cmd = CMD_INTERRUPT;
237 tail = "nterrupt";
238 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100239 case 'b': last_cmd = CMD_BACKTRACE;
240 if (p[1] == 't')
241 tail = "t";
242 else
243 tail = "acktrace";
244 break;
245 case 'w': last_cmd = CMD_BACKTRACE;
246 tail = "here";
247 break;
248 case 'u': last_cmd = CMD_UP;
249 tail = "p";
250 break;
251 case 'd': last_cmd = CMD_DOWN;
252 tail = "own";
253 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000254 default: last_cmd = 0;
255 }
256 if (last_cmd != 0)
257 {
258 /* Check that the tail matches. */
259 ++p;
260 while (*p != NUL && *p == *tail)
261 {
262 ++p;
263 ++tail;
264 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100265 if (ASCII_ISALPHA(*p) && last_cmd != CMD_FRAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000266 last_cmd = 0;
267 }
268 }
269
270 if (last_cmd != 0)
271 {
272 /* Execute debug command: decided where to break next and
273 * return. */
274 switch (last_cmd)
275 {
276 case CMD_CONT:
277 debug_break_level = -1;
278 break;
279 case CMD_NEXT:
280 debug_break_level = ex_nesting_level;
281 break;
282 case CMD_STEP:
283 debug_break_level = 9999;
284 break;
285 case CMD_FINISH:
286 debug_break_level = ex_nesting_level - 1;
287 break;
288 case CMD_QUIT:
289 got_int = TRUE;
290 debug_break_level = -1;
291 break;
292 case CMD_INTERRUPT:
293 got_int = TRUE;
294 debug_break_level = 9999;
295 /* Do not repeat ">interrupt" cmd, continue stepping. */
296 last_cmd = CMD_STEP;
297 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100298 case CMD_BACKTRACE:
299 do_showbacktrace(cmd);
300 continue;
301 case CMD_FRAME:
302 if (*p == NUL)
303 {
304 do_showbacktrace(cmd);
305 }
306 else
307 {
308 p = skipwhite(p);
309 do_setdebugtracelevel(p);
310 }
311 continue;
312 case CMD_UP:
313 debug_backtrace_level++;
314 do_checkbacktracelevel();
315 continue;
316 case CMD_DOWN:
317 debug_backtrace_level--;
318 do_checkbacktracelevel();
319 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000320 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100321 /* Going out reset backtrace_level */
322 debug_backtrace_level = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000323 break;
324 }
325
326 /* don't debug this command */
327 n = debug_break_level;
328 debug_break_level = -1;
329 (void)do_cmdline(cmdline, getexline, NULL,
330 DOCMD_VERBOSE|DOCMD_EXCRESET);
331 debug_break_level = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000332 }
333 lines_left = Rows - 1;
334 }
335 vim_free(cmdline);
336
337 --RedrawingDisabled;
338 --no_wait_return;
339 redraw_all_later(NOT_VALID);
340 need_wait_return = FALSE;
341 msg_scroll = save_msg_scroll;
342 lines_left = Rows - 1;
343 State = save_State;
Bram Moolenaard99388b2017-10-26 14:28:32 +0200344 debug_mode = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000345 did_emsg = save_did_emsg;
346 cmd_silent = save_cmd_silent;
347 msg_silent = save_msg_silent;
348 emsg_silent = save_emsg_silent;
349 redir_off = save_redir_off;
350
351 /* Only print the message again when typing a command before coming back
352 * here. */
353 debug_did_msg = TRUE;
354}
355
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100356 static int
357get_maxbacktrace_level(void)
358{
359 char *p, *q;
Bram Moolenaardc633cf2016-04-23 14:33:19 +0200360 int maxbacktrace = 0;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100361
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100362 if (sourcing_name != NULL)
363 {
364 p = (char *)sourcing_name;
365 while ((q = strstr(p, "..")) != NULL)
366 {
367 p = q + 2;
368 maxbacktrace++;
369 }
370 }
371 return maxbacktrace;
372}
373
374 static void
375do_setdebugtracelevel(char_u *arg)
376{
377 int level;
378
379 level = atoi((char *)arg);
380 if (*arg == '+' || level < 0)
381 debug_backtrace_level += level;
382 else
383 debug_backtrace_level = level;
384
385 do_checkbacktracelevel();
386}
387
388 static void
389do_checkbacktracelevel(void)
390{
391 if (debug_backtrace_level < 0)
392 {
393 debug_backtrace_level = 0;
394 MSG(_("frame is zero"));
395 }
396 else
397 {
398 int max = get_maxbacktrace_level();
399
400 if (debug_backtrace_level > max)
401 {
402 debug_backtrace_level = max;
403 smsg((char_u *)_("frame at highest level: %d"), max);
404 }
405 }
406}
407
408 static void
409do_showbacktrace(char_u *cmd)
410{
411 char *cur;
412 char *next;
413 int i = 0;
414 int max = get_maxbacktrace_level();
415
416 if (sourcing_name != NULL)
417 {
418 cur = (char *)sourcing_name;
419 while (!got_int)
420 {
421 next = strstr(cur, "..");
422 if (next != NULL)
423 *next = NUL;
424 if (i == max - debug_backtrace_level)
425 smsg((char_u *)"->%d %s", max - i, cur);
426 else
427 smsg((char_u *)" %d %s", max - i, cur);
428 ++i;
429 if (next == NULL)
430 break;
431 *next = '.';
432 cur = next + 2;
433 }
434 }
435 if (sourcing_lnum != 0)
436 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
437 else
438 smsg((char_u *)_("cmd: %s"), cmd);
439}
440
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441/*
442 * ":debug".
443 */
444 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100445ex_debug(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000446{
447 int debug_break_level_save = debug_break_level;
448
449 debug_break_level = 9999;
450 do_cmdline_cmd(eap->arg);
451 debug_break_level = debug_break_level_save;
452}
453
454static char_u *debug_breakpoint_name = NULL;
455static linenr_T debug_breakpoint_lnum;
456
457/*
458 * When debugging or a breakpoint is set on a skipped command, no debug prompt
459 * is shown by do_one_cmd(). This situation is indicated by debug_skipped, and
460 * debug_skipped_name is then set to the source name in the breakpoint case. If
461 * a skipped command decides itself that a debug prompt should be displayed, it
462 * can do so by calling dbg_check_skipped().
463 */
464static int debug_skipped;
465static char_u *debug_skipped_name;
466
467/*
468 * Go to debug mode when a breakpoint was encountered or "ex_nesting_level" is
469 * at or below the break level. But only when the line is actually
470 * executed. Return TRUE and set breakpoint_name for skipped commands that
471 * decide to execute something themselves.
472 * Called from do_one_cmd() before executing a command.
473 */
474 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100475dbg_check_breakpoint(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476{
477 char_u *p;
478
479 debug_skipped = FALSE;
480 if (debug_breakpoint_name != NULL)
481 {
482 if (!eap->skip)
483 {
484 /* replace K_SNR with "<SNR>" */
485 if (debug_breakpoint_name[0] == K_SPECIAL
486 && debug_breakpoint_name[1] == KS_EXTRA
487 && debug_breakpoint_name[2] == (int)KE_SNR)
488 p = (char_u *)"<SNR>";
489 else
490 p = (char_u *)"";
Bram Moolenaar555b2802005-05-19 21:08:39 +0000491 smsg((char_u *)_("Breakpoint in \"%s%s\" line %ld"),
492 p,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000493 debug_breakpoint_name + (*p == NUL ? 0 : 3),
494 (long)debug_breakpoint_lnum);
495 debug_breakpoint_name = NULL;
496 do_debug(eap->cmd);
497 }
498 else
499 {
500 debug_skipped = TRUE;
501 debug_skipped_name = debug_breakpoint_name;
502 debug_breakpoint_name = NULL;
503 }
504 }
505 else if (ex_nesting_level <= debug_break_level)
506 {
507 if (!eap->skip)
508 do_debug(eap->cmd);
509 else
510 {
511 debug_skipped = TRUE;
512 debug_skipped_name = NULL;
513 }
514 }
515}
516
517/*
518 * Go to debug mode if skipped by dbg_check_breakpoint() because eap->skip was
519 * set. Return TRUE when the debug mode is entered this time.
520 */
521 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100522dbg_check_skipped(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523{
524 int prev_got_int;
525
526 if (debug_skipped)
527 {
528 /*
529 * Save the value of got_int and reset it. We don't want a previous
530 * interruption cause flushing the input buffer.
531 */
532 prev_got_int = got_int;
533 got_int = FALSE;
534 debug_breakpoint_name = debug_skipped_name;
535 /* eap->skip is TRUE */
536 eap->skip = FALSE;
537 (void)dbg_check_breakpoint(eap);
538 eap->skip = TRUE;
539 got_int |= prev_got_int;
540 return TRUE;
541 }
542 return FALSE;
543}
544
545/*
546 * The list of breakpoints: dbg_breakp.
547 * This is a grow-array of structs.
548 */
549struct debuggy
550{
551 int dbg_nr; /* breakpoint number */
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100552 int dbg_type; /* DBG_FUNC, DBG_FILE or DBG_EXPR */
553 char_u *dbg_name; /* function, expression or file name */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 regprog_T *dbg_prog; /* regexp program */
555 linenr_T dbg_lnum; /* line number in function or file */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000556 int dbg_forceit; /* ! used */
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100557#ifdef FEAT_EVAL
558 typval_T *dbg_val; /* last result of watchexpression */
559#endif
560 int dbg_level; /* stored nested level for expr */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561};
562
563static garray_T dbg_breakp = {0, 0, sizeof(struct debuggy), 4, NULL};
Bram Moolenaar05159a02005-02-26 23:04:13 +0000564#define BREAKP(idx) (((struct debuggy *)dbg_breakp.ga_data)[idx])
565#define DEBUGGY(gap, idx) (((struct debuggy *)gap->ga_data)[idx])
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566static int last_breakp = 0; /* nr of last defined breakpoint */
567
Bram Moolenaar05159a02005-02-26 23:04:13 +0000568#ifdef FEAT_PROFILE
569/* Profiling uses file and func names similar to breakpoints. */
570static garray_T prof_ga = {0, 0, sizeof(struct debuggy), 4, NULL};
571#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572#define DBG_FUNC 1
573#define DBG_FILE 2
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100574#define DBG_EXPR 3
Bram Moolenaar071d4272004-06-13 20:20:40 +0000575
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100576static int dbg_parsearg(char_u *arg, garray_T *gap);
577static linenr_T debuggy_find(int file,char_u *fname, linenr_T after, garray_T *gap, int *fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578
579/*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000580 * Parse the arguments of ":profile", ":breakadd" or ":breakdel" and put them
581 * in the entry just after the last one in dbg_breakp. Note that "dbg_name"
582 * is allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583 * Returns FAIL for failure.
584 */
585 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100586dbg_parsearg(
587 char_u *arg,
588 garray_T *gap) /* either &dbg_breakp or &prof_ga */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589{
590 char_u *p = arg;
591 char_u *q;
592 struct debuggy *bp;
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000593 int here = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594
Bram Moolenaar05159a02005-02-26 23:04:13 +0000595 if (ga_grow(gap, 1) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596 return FAIL;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000597 bp = &DEBUGGY(gap, gap->ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
599 /* Find "func" or "file". */
600 if (STRNCMP(p, "func", 4) == 0)
601 bp->dbg_type = DBG_FUNC;
602 else if (STRNCMP(p, "file", 4) == 0)
603 bp->dbg_type = DBG_FILE;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000604 else if (
605#ifdef FEAT_PROFILE
606 gap != &prof_ga &&
607#endif
608 STRNCMP(p, "here", 4) == 0)
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000609 {
610 if (curbuf->b_ffname == NULL)
611 {
612 EMSG(_(e_noname));
613 return FAIL;
614 }
615 bp->dbg_type = DBG_FILE;
616 here = TRUE;
617 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100618 else if (
619#ifdef FEAT_PROFILE
620 gap != &prof_ga &&
621#endif
622 STRNCMP(p, "expr", 4) == 0)
623 bp->dbg_type = DBG_EXPR;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 else
625 {
626 EMSG2(_(e_invarg2), p);
627 return FAIL;
628 }
629 p = skipwhite(p + 4);
630
631 /* Find optional line number. */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000632 if (here)
633 bp->dbg_lnum = curwin->w_cursor.lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000634 else if (
635#ifdef FEAT_PROFILE
636 gap != &prof_ga &&
637#endif
638 VIM_ISDIGIT(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 {
640 bp->dbg_lnum = getdigits(&p);
641 p = skipwhite(p);
642 }
643 else
644 bp->dbg_lnum = 0;
645
646 /* Find the function or file name. Don't accept a function name with (). */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000647 if ((!here && *p == NUL)
648 || (here && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 || (bp->dbg_type == DBG_FUNC && strstr((char *)p, "()") != NULL))
650 {
651 EMSG2(_(e_invarg2), arg);
652 return FAIL;
653 }
654
655 if (bp->dbg_type == DBG_FUNC)
656 bp->dbg_name = vim_strsave(p);
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000657 else if (here)
658 bp->dbg_name = vim_strsave(curbuf->b_ffname);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100659 else if (bp->dbg_type == DBG_EXPR)
660 {
661 bp->dbg_name = vim_strsave(p);
662 if (bp->dbg_name != NULL)
663 bp->dbg_val = eval_expr(bp->dbg_name, NULL);
664 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000665 else
666 {
667 /* Expand the file name in the same way as do_source(). This means
668 * doing it twice, so that $DIR/file gets expanded when $DIR is
669 * "~/dir". */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 q = expand_env_save(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671 if (q == NULL)
672 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 p = expand_env_save(q);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 vim_free(q);
675 if (p == NULL)
676 return FAIL;
Bram Moolenaar843ee412004-06-30 16:16:41 +0000677 if (*p != '*')
678 {
679 bp->dbg_name = fix_fname(p);
680 vim_free(p);
681 }
682 else
683 bp->dbg_name = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 }
685
686 if (bp->dbg_name == NULL)
687 return FAIL;
688 return OK;
689}
690
691/*
692 * ":breakadd".
693 */
694 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100695ex_breakadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000696{
697 struct debuggy *bp;
698 char_u *pat;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000699 garray_T *gap;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700
Bram Moolenaar05159a02005-02-26 23:04:13 +0000701 gap = &dbg_breakp;
702#ifdef FEAT_PROFILE
703 if (eap->cmdidx == CMD_profile)
704 gap = &prof_ga;
705#endif
706
707 if (dbg_parsearg(eap->arg, gap) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000709 bp = &DEBUGGY(gap, gap->ga_len);
710 bp->dbg_forceit = eap->forceit;
711
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100712 if (bp->dbg_type != DBG_EXPR)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713 {
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100714 pat = file_pat_to_reg_pat(bp->dbg_name, NULL, NULL, FALSE);
715 if (pat != NULL)
716 {
717 bp->dbg_prog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
718 vim_free(pat);
719 }
720 if (pat == NULL || bp->dbg_prog == NULL)
721 vim_free(bp->dbg_name);
722 else
723 {
724 if (bp->dbg_lnum == 0) /* default line number is 1 */
725 bp->dbg_lnum = 1;
726#ifdef FEAT_PROFILE
727 if (eap->cmdidx != CMD_profile)
728#endif
729 {
730 DEBUGGY(gap, gap->ga_len).dbg_nr = ++last_breakp;
731 ++debug_tick;
732 }
733 ++gap->ga_len;
734 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000735 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000736 else
737 {
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100738 /* DBG_EXPR */
739 DEBUGGY(gap, gap->ga_len++).dbg_nr = ++last_breakp;
740 ++debug_tick;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741 }
742 }
743}
744
745/*
746 * ":debuggreedy".
747 */
748 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100749ex_debuggreedy(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750{
751 if (eap->addr_count == 0 || eap->line2 != 0)
752 debug_greedy = TRUE;
753 else
754 debug_greedy = FALSE;
755}
756
757/*
Bram Moolenaard9fba312005-06-26 22:34:35 +0000758 * ":breakdel" and ":profdel".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759 */
760 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100761ex_breakdel(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762{
763 struct debuggy *bp, *bpi;
764 int nr;
765 int todel = -1;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000766 int del_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 int i;
768 linenr_T best_lnum = 0;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000769 garray_T *gap;
770
771 gap = &dbg_breakp;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000772 if (eap->cmdidx == CMD_profdel)
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200773 {
774#ifdef FEAT_PROFILE
Bram Moolenaard9fba312005-06-26 22:34:35 +0000775 gap = &prof_ga;
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200776#else
777 ex_ni(eap);
778 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000779#endif
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200780 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781
782 if (vim_isdigit(*eap->arg))
783 {
784 /* ":breakdel {nr}" */
785 nr = atol((char *)eap->arg);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000786 for (i = 0; i < gap->ga_len; ++i)
787 if (DEBUGGY(gap, i).dbg_nr == nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 {
789 todel = i;
790 break;
791 }
792 }
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000793 else if (*eap->arg == '*')
794 {
795 todel = 0;
796 del_all = TRUE;
797 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 else
799 {
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100800 /* ":breakdel {func|file|expr} [lnum] {name}" */
Bram Moolenaard9fba312005-06-26 22:34:35 +0000801 if (dbg_parsearg(eap->arg, gap) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000803 bp = &DEBUGGY(gap, gap->ga_len);
804 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000806 bpi = &DEBUGGY(gap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000807 if (bp->dbg_type == bpi->dbg_type
808 && STRCMP(bp->dbg_name, bpi->dbg_name) == 0
809 && (bp->dbg_lnum == bpi->dbg_lnum
810 || (bp->dbg_lnum == 0
811 && (best_lnum == 0
812 || bpi->dbg_lnum < best_lnum))))
813 {
814 todel = i;
815 best_lnum = bpi->dbg_lnum;
816 }
817 }
818 vim_free(bp->dbg_name);
819 }
820
821 if (todel < 0)
822 EMSG2(_("E161: Breakpoint not found: %s"), eap->arg);
823 else
Bram Moolenaard9fba312005-06-26 22:34:35 +0000824 {
825 while (gap->ga_len > 0)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000826 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000827 vim_free(DEBUGGY(gap, todel).dbg_name);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100828#ifdef FEAT_EVAL
829 if (DEBUGGY(gap, todel).dbg_type == DBG_EXPR
830 && DEBUGGY(gap, todel).dbg_val != NULL)
831 free_tv(DEBUGGY(gap, todel).dbg_val);
832#endif
Bram Moolenaar473de612013-06-08 18:19:48 +0200833 vim_regfree(DEBUGGY(gap, todel).dbg_prog);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000834 --gap->ga_len;
835 if (todel < gap->ga_len)
836 mch_memmove(&DEBUGGY(gap, todel), &DEBUGGY(gap, todel + 1),
837 (gap->ga_len - todel) * sizeof(struct debuggy));
838#ifdef FEAT_PROFILE
839 if (eap->cmdidx == CMD_breakdel)
840#endif
841 ++debug_tick;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000842 if (!del_all)
843 break;
844 }
Bram Moolenaard9fba312005-06-26 22:34:35 +0000845
846 /* If all breakpoints were removed clear the array. */
847 if (gap->ga_len == 0)
848 ga_clear(gap);
849 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850}
851
852/*
853 * ":breaklist".
854 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100856ex_breaklist(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000857{
858 struct debuggy *bp;
859 int i;
860
861 if (dbg_breakp.ga_len == 0)
862 MSG(_("No breakpoints defined"));
863 else
864 for (i = 0; i < dbg_breakp.ga_len; ++i)
865 {
866 bp = &BREAKP(i);
Bram Moolenaard58ea072011-06-26 04:25:30 +0200867 if (bp->dbg_type == DBG_FILE)
868 home_replace(NULL, bp->dbg_name, NameBuff, MAXPATHL, TRUE);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100869 if (bp->dbg_type != DBG_EXPR)
870 smsg((char_u *)_("%3d %s %s line %ld"),
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871 bp->dbg_nr,
872 bp->dbg_type == DBG_FUNC ? "func" : "file",
Bram Moolenaard58ea072011-06-26 04:25:30 +0200873 bp->dbg_type == DBG_FUNC ? bp->dbg_name : NameBuff,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 (long)bp->dbg_lnum);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100875 else
876 smsg((char_u *)_("%3d expr %s"),
877 bp->dbg_nr, bp->dbg_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878 }
879}
880
881/*
882 * Find a breakpoint for a function or sourced file.
883 * Returns line number at which to break; zero when no matching breakpoint.
884 */
885 linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100886dbg_find_breakpoint(
887 int file, /* TRUE for a file, FALSE for a function */
888 char_u *fname, /* file or function name */
889 linenr_T after) /* after this line number */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000890{
Bram Moolenaar05159a02005-02-26 23:04:13 +0000891 return debuggy_find(file, fname, after, &dbg_breakp, NULL);
892}
893
894#if defined(FEAT_PROFILE) || defined(PROTO)
895/*
896 * Return TRUE if profiling is on for a function or sourced file.
897 */
898 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100899has_profiling(
900 int file, /* TRUE for a file, FALSE for a function */
901 char_u *fname, /* file or function name */
902 int *fp) /* return: forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000903{
904 return (debuggy_find(file, fname, (linenr_T)0, &prof_ga, fp)
905 != (linenr_T)0);
906}
907#endif
908
909/*
910 * Common code for dbg_find_breakpoint() and has_profiling().
911 */
912 static linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100913debuggy_find(
914 int file, /* TRUE for a file, FALSE for a function */
915 char_u *fname, /* file or function name */
916 linenr_T after, /* after this line number */
917 garray_T *gap, /* either &dbg_breakp or &prof_ga */
918 int *fp) /* if not NULL: return forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000919{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 struct debuggy *bp;
921 int i;
922 linenr_T lnum = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923 char_u *name = fname;
924 int prev_got_int;
925
Bram Moolenaar05159a02005-02-26 23:04:13 +0000926 /* Return quickly when there are no breakpoints. */
927 if (gap->ga_len == 0)
928 return (linenr_T)0;
929
Bram Moolenaar071d4272004-06-13 20:20:40 +0000930 /* Replace K_SNR in function name with "<SNR>". */
931 if (!file && fname[0] == K_SPECIAL)
932 {
933 name = alloc((unsigned)STRLEN(fname) + 3);
934 if (name == NULL)
935 name = fname;
936 else
937 {
938 STRCPY(name, "<SNR>");
939 STRCPY(name + 5, fname + 3);
940 }
941 }
942
Bram Moolenaar05159a02005-02-26 23:04:13 +0000943 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000944 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000945 /* Skip entries that are not useful or are for a line that is beyond
946 * an already found breakpoint. */
947 bp = &DEBUGGY(gap, i);
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100948 if (((bp->dbg_type == DBG_FILE) == file &&
949 bp->dbg_type != DBG_EXPR && (
Bram Moolenaar05159a02005-02-26 23:04:13 +0000950#ifdef FEAT_PROFILE
951 gap == &prof_ga ||
952#endif
953 (bp->dbg_lnum > after && (lnum == 0 || bp->dbg_lnum < lnum)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000954 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000956 * Save the value of got_int and reset it. We don't want a
957 * previous interruption cancel matching, only hitting CTRL-C
958 * while matching should abort it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000959 */
960 prev_got_int = got_int;
961 got_int = FALSE;
Bram Moolenaardffa5b82014-11-19 16:38:07 +0100962 if (vim_regexec_prog(&bp->dbg_prog, FALSE, name, (colnr_T)0))
Bram Moolenaar05159a02005-02-26 23:04:13 +0000963 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000964 lnum = bp->dbg_lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000965 if (fp != NULL)
966 *fp = bp->dbg_forceit;
967 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 got_int |= prev_got_int;
969 }
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100970#ifdef FEAT_EVAL
971 else if (bp->dbg_type == DBG_EXPR)
972 {
973 typval_T *tv;
974 int line = FALSE;
975
976 prev_got_int = got_int;
977 got_int = FALSE;
978
979 tv = eval_expr(bp->dbg_name, NULL);
980 if (tv != NULL)
981 {
982 if (bp->dbg_val == NULL)
983 {
984 debug_oldval = typval_tostring(NULL);
985 bp->dbg_val = tv;
986 debug_newval = typval_tostring(bp->dbg_val);
987 line = TRUE;
988 }
989 else
990 {
Bram Moolenaar31988702018-02-13 12:57:42 +0100991 if (typval_compare(tv, bp->dbg_val, TYPE_EQUAL,
992 TRUE, FALSE) == OK
993 && tv->vval.v_number == FALSE)
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100994 {
Bram Moolenaar31988702018-02-13 12:57:42 +0100995 typval_T *v;
Bram Moolenaarc6f9f732018-02-11 19:06:26 +0100996
Bram Moolenaar31988702018-02-13 12:57:42 +0100997 line = TRUE;
998 debug_oldval = typval_tostring(bp->dbg_val);
999 /* Need to evaluate again, typval_compare() overwrites
1000 * "tv". */
1001 v = eval_expr(bp->dbg_name, NULL);
1002 debug_newval = typval_tostring(v);
1003 free_tv(bp->dbg_val);
1004 bp->dbg_val = v;
Bram Moolenaarc6f9f732018-02-11 19:06:26 +01001005 }
1006 free_tv(tv);
1007 }
1008 }
1009 else if (bp->dbg_val != NULL)
1010 {
1011 debug_oldval = typval_tostring(bp->dbg_val);
1012 debug_newval = typval_tostring(NULL);
1013 free_tv(bp->dbg_val);
1014 bp->dbg_val = NULL;
1015 line = TRUE;
1016 }
1017
1018 if (line)
1019 {
1020 lnum = after > 0 ? after : 1;
1021 break;
1022 }
1023
1024 got_int |= prev_got_int;
1025 }
1026#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027 }
1028 if (name != fname)
1029 vim_free(name);
1030
1031 return lnum;
1032}
1033
1034/*
1035 * Called when a breakpoint was encountered.
1036 */
1037 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001038dbg_breakpoint(char_u *name, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001039{
1040 /* We need to check if this line is actually executed in do_one_cmd() */
1041 debug_breakpoint_name = name;
1042 debug_breakpoint_lnum = lnum;
1043}
Bram Moolenaar05159a02005-02-26 23:04:13 +00001044
1045
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001046# if defined(FEAT_PROFILE) || defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001047/*
1048 * Store the current time in "tm".
1049 */
1050 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001051profile_start(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001052{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001053# ifdef WIN3264
1054 QueryPerformanceCounter(tm);
1055# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001056 gettimeofday(tm, NULL);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001057# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001058}
1059
1060/*
1061 * Compute the elapsed time from "tm" till now and store in "tm".
1062 */
1063 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001064profile_end(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001065{
1066 proftime_T now;
1067
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001068# ifdef WIN3264
1069 QueryPerformanceCounter(&now);
1070 tm->QuadPart = now.QuadPart - tm->QuadPart;
1071# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001072 gettimeofday(&now, NULL);
1073 tm->tv_usec = now.tv_usec - tm->tv_usec;
1074 tm->tv_sec = now.tv_sec - tm->tv_sec;
1075 if (tm->tv_usec < 0)
1076 {
1077 tm->tv_usec += 1000000;
1078 --tm->tv_sec;
1079 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001080# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001081}
1082
1083/*
1084 * Subtract the time "tm2" from "tm".
1085 */
1086 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001087profile_sub(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001088{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001089# ifdef WIN3264
1090 tm->QuadPart -= tm2->QuadPart;
1091# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001092 tm->tv_usec -= tm2->tv_usec;
1093 tm->tv_sec -= tm2->tv_sec;
1094 if (tm->tv_usec < 0)
1095 {
1096 tm->tv_usec += 1000000;
1097 --tm->tv_sec;
1098 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001099# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001100}
1101
1102/*
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001103 * Return a string that represents the time in "tm".
1104 * Uses a static buffer!
1105 */
1106 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001107profile_msg(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001108{
1109 static char buf[50];
1110
1111# ifdef WIN3264
1112 LARGE_INTEGER fr;
1113
1114 QueryPerformanceFrequency(&fr);
1115 sprintf(buf, "%10.6lf", (double)tm->QuadPart / (double)fr.QuadPart);
1116# else
1117 sprintf(buf, "%3ld.%06ld", (long)tm->tv_sec, (long)tm->tv_usec);
Bram Moolenaar76929292008-01-06 19:07:36 +00001118# endif
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001119 return buf;
1120}
1121
Bram Moolenaar79c2c882016-02-07 21:19:28 +01001122# if defined(FEAT_FLOAT) || defined(PROTO)
1123/*
1124 * Return a float that represents the time in "tm".
1125 */
1126 float_T
1127profile_float(proftime_T *tm)
1128{
1129# ifdef WIN3264
1130 LARGE_INTEGER fr;
1131
1132 QueryPerformanceFrequency(&fr);
1133 return (float_T)tm->QuadPart / (float_T)fr.QuadPart;
1134# else
1135 return (float_T)tm->tv_sec + (float_T)tm->tv_usec / 1000000.0;
1136# endif
1137}
1138# endif
1139
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001140/*
Bram Moolenaar76929292008-01-06 19:07:36 +00001141 * Put the time "msec" past now in "tm".
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001142 */
Bram Moolenaar76929292008-01-06 19:07:36 +00001143 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001144profile_setlimit(long msec, proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001145{
1146 if (msec <= 0) /* no limit */
1147 profile_zero(tm);
1148 else
1149 {
1150# ifdef WIN3264
1151 LARGE_INTEGER fr;
1152
1153 QueryPerformanceCounter(tm);
1154 QueryPerformanceFrequency(&fr);
Bram Moolenaarb3c70982008-01-18 10:40:55 +00001155 tm->QuadPart += (LONGLONG)((double)msec / 1000.0 * (double)fr.QuadPart);
Bram Moolenaar76929292008-01-06 19:07:36 +00001156# else
1157 long usec;
1158
1159 gettimeofday(tm, NULL);
1160 usec = (long)tm->tv_usec + (long)msec * 1000;
1161 tm->tv_usec = usec % 1000000L;
1162 tm->tv_sec += usec / 1000000L;
1163# endif
1164 }
1165}
1166
1167/*
1168 * Return TRUE if the current time is past "tm".
1169 */
1170 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001171profile_passed_limit(proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001172{
1173 proftime_T now;
1174
1175# ifdef WIN3264
1176 if (tm->QuadPart == 0) /* timer was not set */
1177 return FALSE;
1178 QueryPerformanceCounter(&now);
1179 return (now.QuadPart > tm->QuadPart);
1180# else
1181 if (tm->tv_sec == 0) /* timer was not set */
1182 return FALSE;
1183 gettimeofday(&now, NULL);
1184 return (now.tv_sec > tm->tv_sec
1185 || (now.tv_sec == tm->tv_sec && now.tv_usec > tm->tv_usec));
1186# endif
1187}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001188
1189/*
1190 * Set the time in "tm" to zero.
1191 */
1192 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001193profile_zero(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001194{
1195# ifdef WIN3264
1196 tm->QuadPart = 0;
1197# else
1198 tm->tv_usec = 0;
1199 tm->tv_sec = 0;
1200# endif
1201}
1202
Bram Moolenaar76929292008-01-06 19:07:36 +00001203# endif /* FEAT_PROFILE || FEAT_RELTIME */
1204
Bram Moolenaar975b5272016-03-15 23:10:59 +01001205# if defined(FEAT_TIMERS) || defined(PROTO)
1206static timer_T *first_timer = NULL;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001207static long last_timer_id = 0;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001208
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001209 static long
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001210proftime_time_left(proftime_T *due, proftime_T *now)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001211{
1212# ifdef WIN3264
1213 LARGE_INTEGER fr;
1214
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001215 if (now->QuadPart > due->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001216 return 0;
1217 QueryPerformanceFrequency(&fr);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001218 return (long)(((double)(due->QuadPart - now->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001219 / (double)fr.QuadPart) * 1000);
1220# else
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001221 if (now->tv_sec > due->tv_sec)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001222 return 0;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001223 return (due->tv_sec - now->tv_sec) * 1000
1224 + (due->tv_usec - now->tv_usec) / 1000;
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001225# endif
1226}
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001227
Bram Moolenaar975b5272016-03-15 23:10:59 +01001228/*
1229 * Insert a timer in the list of timers.
1230 */
1231 static void
1232insert_timer(timer_T *timer)
1233{
1234 timer->tr_next = first_timer;
1235 timer->tr_prev = NULL;
1236 if (first_timer != NULL)
1237 first_timer->tr_prev = timer;
1238 first_timer = timer;
Bram Moolenaar4231da42016-06-02 14:30:04 +02001239 did_add_timer = TRUE;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001240}
1241
1242/*
1243 * Take a timer out of the list of timers.
1244 */
1245 static void
1246remove_timer(timer_T *timer)
1247{
1248 if (timer->tr_prev == NULL)
1249 first_timer = timer->tr_next;
1250 else
1251 timer->tr_prev->tr_next = timer->tr_next;
1252 if (timer->tr_next != NULL)
1253 timer->tr_next->tr_prev = timer->tr_prev;
1254}
1255
1256 static void
1257free_timer(timer_T *timer)
1258{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001259 free_callback(timer->tr_callback, timer->tr_partial);
1260 vim_free(timer);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001261}
1262
1263/*
1264 * Create a timer and return it. NULL if out of memory.
1265 * Caller should set the callback.
1266 */
1267 timer_T *
1268create_timer(long msec, int repeat)
1269{
1270 timer_T *timer = (timer_T *)alloc_clear(sizeof(timer_T));
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001271 long prev_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001272
1273 if (timer == NULL)
1274 return NULL;
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001275 if (++last_timer_id <= prev_id)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001276 /* Overflow! Might cause duplicates... */
1277 last_timer_id = 0;
1278 timer->tr_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001279 insert_timer(timer);
1280 if (repeat != 0)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001281 timer->tr_repeat = repeat - 1;
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001282 timer->tr_interval = msec;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001283
1284 profile_setlimit(msec, &timer->tr_due);
1285 return timer;
1286}
1287
1288/*
1289 * Invoke the callback of "timer".
1290 */
1291 static void
1292timer_callback(timer_T *timer)
1293{
1294 typval_T rettv;
1295 int dummy;
1296 typval_T argv[2];
1297
1298 argv[0].v_type = VAR_NUMBER;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001299 argv[0].vval.v_number = (varnumber_T)timer->tr_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001300 argv[1].v_type = VAR_UNKNOWN;
1301
1302 call_func(timer->tr_callback, (int)STRLEN(timer->tr_callback),
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001303 &rettv, 1, argv, NULL, 0L, 0L, &dummy, TRUE,
Bram Moolenaar975b5272016-03-15 23:10:59 +01001304 timer->tr_partial, NULL);
1305 clear_tv(&rettv);
1306}
1307
1308/*
1309 * Call timers that are due.
1310 * Return the time in msec until the next timer is due.
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001311 * Returns -1 if there are no pending timers.
Bram Moolenaar975b5272016-03-15 23:10:59 +01001312 */
1313 long
Bram Moolenaarcf089462016-06-12 21:18:43 +02001314check_due_timer(void)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001315{
1316 timer_T *timer;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001317 timer_T *timer_next;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001318 long this_due;
Bram Moolenaar597385a2016-03-16 23:24:43 +01001319 long next_due = -1;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001320 proftime_T now;
1321 int did_one = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001322 int need_update_screen = FALSE;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001323 long current_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001324
Bram Moolenaarc577d812017-07-08 22:37:34 +02001325 /* Don't run any timers while exiting or dealing with an error. */
1326 if (exiting || aborting())
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001327 return next_due;
1328
Bram Moolenaar75537a92016-09-05 22:45:28 +02001329 profile_start(&now);
1330 for (timer = first_timer; timer != NULL && !got_int; timer = timer_next)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001331 {
Bram Moolenaar75537a92016-09-05 22:45:28 +02001332 timer_next = timer->tr_next;
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001333
Bram Moolenaar75537a92016-09-05 22:45:28 +02001334 if (timer->tr_id == -1 || timer->tr_firing || timer->tr_paused)
1335 continue;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001336 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001337 if (this_due <= 1)
1338 {
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001339 int save_timer_busy = timer_busy;
1340 int save_vgetc_busy = vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001341 int save_did_emsg = did_emsg;
1342 int save_called_emsg = called_emsg;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001343 int save_must_redraw = must_redraw;
Bram Moolenaare723c422017-09-06 23:40:10 +02001344 int save_trylevel = trylevel;
1345 int save_did_throw = did_throw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001346 int save_ex_pressedreturn = get_pressedreturn();
Bram Moolenaare723c422017-09-06 23:40:10 +02001347 except_T *save_current_exception = current_exception;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001348
Bram Moolenaare723c422017-09-06 23:40:10 +02001349 /* Create a scope for running the timer callback, ignoring most of
1350 * the current scope, such as being inside a try/catch. */
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001351 timer_busy = timer_busy > 0 || vgetc_busy > 0;
1352 vgetc_busy = 0;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001353 called_emsg = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001354 did_emsg = FALSE;
1355 did_uncaught_emsg = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001356 must_redraw = 0;
Bram Moolenaare723c422017-09-06 23:40:10 +02001357 trylevel = 0;
1358 did_throw = FALSE;
1359 current_exception = NULL;
1360
Bram Moolenaar75537a92016-09-05 22:45:28 +02001361 timer->tr_firing = TRUE;
1362 timer_callback(timer);
1363 timer->tr_firing = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001364
Bram Moolenaar75537a92016-09-05 22:45:28 +02001365 timer_next = timer->tr_next;
1366 did_one = TRUE;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001367 timer_busy = save_timer_busy;
1368 vgetc_busy = save_vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001369 if (did_uncaught_emsg)
Bram Moolenaarc577d812017-07-08 22:37:34 +02001370 ++timer->tr_emsg_count;
Bram Moolenaare723c422017-09-06 23:40:10 +02001371 did_emsg = save_did_emsg;
1372 called_emsg = save_called_emsg;
1373 trylevel = save_trylevel;
1374 did_throw = save_did_throw;
1375 current_exception = save_current_exception;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001376 if (must_redraw != 0)
1377 need_update_screen = TRUE;
1378 must_redraw = must_redraw > save_must_redraw
1379 ? must_redraw : save_must_redraw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001380 set_pressedreturn(save_ex_pressedreturn);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001381
1382 /* Only fire the timer again if it repeats and stop_timer() wasn't
1383 * called while inside the callback (tr_id == -1). */
Bram Moolenaarc577d812017-07-08 22:37:34 +02001384 if (timer->tr_repeat != 0 && timer->tr_id != -1
1385 && timer->tr_emsg_count < 3)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001386 {
1387 profile_setlimit(timer->tr_interval, &timer->tr_due);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001388 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001389 if (this_due < 1)
1390 this_due = 1;
1391 if (timer->tr_repeat > 0)
1392 --timer->tr_repeat;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001393 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001394 else
1395 {
1396 this_due = -1;
1397 remove_timer(timer);
1398 free_timer(timer);
1399 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001400 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001401 if (this_due > 0 && (next_due == -1 || next_due > this_due))
1402 next_due = this_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001403 }
1404
1405 if (did_one)
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001406 redraw_after_callback(need_update_screen);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001407
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01001408#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001409 if (bevalexpr_due_set)
1410 {
1411 this_due = proftime_time_left(&bevalexpr_due, &now);
1412 if (this_due <= 1)
1413 {
1414 bevalexpr_due_set = FALSE;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001415 if (balloonEval == NULL)
1416 {
1417 balloonEval = (BalloonEval *)alloc(sizeof(BalloonEval));
1418 balloonEvalForTerm = TRUE;
1419 }
1420 if (balloonEval != NULL)
1421 general_beval_cb(balloonEval, 0);
1422 }
1423 else if (this_due > 0 && (next_due == -1 || next_due > this_due))
1424 next_due = this_due;
1425 }
1426#endif
1427
Bram Moolenaar75537a92016-09-05 22:45:28 +02001428 return current_id != last_timer_id ? 1 : next_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001429}
1430
1431/*
1432 * Find a timer by ID. Returns NULL if not found;
1433 */
1434 timer_T *
Bram Moolenaar75537a92016-09-05 22:45:28 +02001435find_timer(long id)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001436{
1437 timer_T *timer;
1438
Bram Moolenaar75537a92016-09-05 22:45:28 +02001439 if (id >= 0)
1440 {
1441 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1442 if (timer->tr_id == id)
1443 return timer;
1444 }
1445 return NULL;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001446}
1447
1448
1449/*
1450 * Stop a timer and delete it.
1451 */
1452 void
1453stop_timer(timer_T *timer)
1454{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001455 if (timer->tr_firing)
1456 /* Free the timer after the callback returns. */
1457 timer->tr_id = -1;
1458 else
1459 {
1460 remove_timer(timer);
1461 free_timer(timer);
1462 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001463}
Bram Moolenaare3188e22016-05-31 21:13:04 +02001464
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001465 void
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001466stop_all_timers(void)
1467{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001468 timer_T *timer;
1469 timer_T *timer_next;
1470
1471 for (timer = first_timer; timer != NULL; timer = timer_next)
1472 {
1473 timer_next = timer->tr_next;
1474 stop_timer(timer);
1475 }
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001476}
1477
1478 void
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001479add_timer_info(typval_T *rettv, timer_T *timer)
1480{
1481 list_T *list = rettv->vval.v_list;
1482 dict_T *dict = dict_alloc();
1483 dictitem_T *di;
1484 long remaining;
1485 proftime_T now;
1486
1487 if (dict == NULL)
1488 return;
1489 list_append_dict(list, dict);
1490
Bram Moolenaar75537a92016-09-05 22:45:28 +02001491 dict_add_nr_str(dict, "id", timer->tr_id, NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001492 dict_add_nr_str(dict, "time", (long)timer->tr_interval, NULL);
1493
1494 profile_start(&now);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001495 remaining = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001496 dict_add_nr_str(dict, "remaining", (long)remaining, NULL);
1497
1498 dict_add_nr_str(dict, "repeat",
1499 (long)(timer->tr_repeat < 0 ? -1 : timer->tr_repeat + 1), NULL);
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001500 dict_add_nr_str(dict, "paused", (long)(timer->tr_paused), NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001501
1502 di = dictitem_alloc((char_u *)"callback");
1503 if (di != NULL)
1504 {
1505 if (dict_add(dict, di) == FAIL)
1506 vim_free(di);
1507 else if (timer->tr_partial != NULL)
1508 {
1509 di->di_tv.v_type = VAR_PARTIAL;
1510 di->di_tv.vval.v_partial = timer->tr_partial;
1511 ++timer->tr_partial->pt_refcount;
1512 }
1513 else
1514 {
1515 di->di_tv.v_type = VAR_FUNC;
1516 di->di_tv.vval.v_string = vim_strsave(timer->tr_callback);
1517 }
1518 di->di_tv.v_lock = 0;
1519 }
1520}
1521
1522 void
1523add_timer_info_all(typval_T *rettv)
1524{
1525 timer_T *timer;
1526
1527 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001528 if (timer->tr_id != -1)
1529 add_timer_info(rettv, timer);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001530}
1531
Bram Moolenaare3188e22016-05-31 21:13:04 +02001532/*
1533 * Mark references in partials of timers.
1534 */
1535 int
1536set_ref_in_timer(int copyID)
1537{
1538 int abort = FALSE;
1539 timer_T *timer;
1540 typval_T tv;
1541
1542 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1543 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001544 if (timer->tr_partial != NULL)
1545 {
1546 tv.v_type = VAR_PARTIAL;
1547 tv.vval.v_partial = timer->tr_partial;
1548 }
1549 else
1550 {
1551 tv.v_type = VAR_FUNC;
1552 tv.vval.v_string = timer->tr_callback;
1553 }
Bram Moolenaare3188e22016-05-31 21:13:04 +02001554 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
1555 }
1556 return abort;
1557}
Bram Moolenaar623e2632016-07-30 22:47:56 +02001558
1559# if defined(EXITFREE) || defined(PROTO)
1560 void
1561timer_free_all()
1562{
1563 timer_T *timer;
1564
1565 while (first_timer != NULL)
1566 {
1567 timer = first_timer;
1568 remove_timer(timer);
1569 free_timer(timer);
1570 }
1571}
1572# endif
Bram Moolenaar975b5272016-03-15 23:10:59 +01001573# endif
1574
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001575#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1576# if defined(HAVE_MATH_H)
1577# include <math.h>
1578# endif
1579
1580/*
1581 * Divide the time "tm" by "count" and store in "tm2".
1582 */
1583 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001584profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001585{
1586 if (count == 0)
1587 profile_zero(tm2);
1588 else
1589 {
1590# ifdef WIN3264
1591 tm2->QuadPart = tm->QuadPart / count;
1592# else
1593 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1594
1595 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001596 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001597# endif
1598 }
1599}
1600#endif
1601
Bram Moolenaar76929292008-01-06 19:07:36 +00001602# if defined(FEAT_PROFILE) || defined(PROTO)
1603/*
1604 * Functions for profiling.
1605 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001606static void script_do_profile(scriptitem_T *si);
1607static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001608static proftime_T prof_wait_time;
1609
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001610/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001611 * Add the time "tm2" to "tm".
1612 */
1613 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001614profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001615{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001616# ifdef WIN3264
1617 tm->QuadPart += tm2->QuadPart;
1618# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001619 tm->tv_usec += tm2->tv_usec;
1620 tm->tv_sec += tm2->tv_sec;
1621 if (tm->tv_usec >= 1000000)
1622 {
1623 tm->tv_usec -= 1000000;
1624 ++tm->tv_sec;
1625 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001626# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001627}
1628
1629/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001630 * Add the "self" time from the total time and the children's time.
1631 */
1632 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001633profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001634{
1635 /* Check that the result won't be negative. Can happen with recursive
1636 * calls. */
1637#ifdef WIN3264
1638 if (total->QuadPart <= children->QuadPart)
1639 return;
1640#else
1641 if (total->tv_sec < children->tv_sec
1642 || (total->tv_sec == children->tv_sec
1643 && total->tv_usec <= children->tv_usec))
1644 return;
1645#endif
1646 profile_add(self, total);
1647 profile_sub(self, children);
1648}
1649
1650/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001651 * Get the current waittime.
1652 */
1653 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001654profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001655{
1656 *tm = prof_wait_time;
1657}
1658
1659/*
1660 * Subtract the passed waittime since "tm" from "tma".
1661 */
1662 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001663profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001664{
1665 proftime_T tm3 = prof_wait_time;
1666
1667 profile_sub(&tm3, tm);
1668 profile_sub(tma, &tm3);
1669}
1670
1671/*
1672 * Return TRUE if "tm1" and "tm2" are equal.
1673 */
1674 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001675profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001676{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001677# ifdef WIN3264
1678 return (tm1->QuadPart == tm2->QuadPart);
1679# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001680 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001681# endif
1682}
1683
1684/*
1685 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1686 */
1687 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001688profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001689{
1690# ifdef WIN3264
1691 return (int)(tm2->QuadPart - tm1->QuadPart);
1692# else
1693 if (tm1->tv_sec == tm2->tv_sec)
1694 return tm2->tv_usec - tm1->tv_usec;
1695 return tm2->tv_sec - tm1->tv_sec;
1696# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001697}
1698
Bram Moolenaar05159a02005-02-26 23:04:13 +00001699static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001700static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001701
1702/*
1703 * ":profile cmd args"
1704 */
1705 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001706ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001707{
1708 char_u *e;
1709 int len;
1710
1711 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001712 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001713 e = skipwhite(e);
1714
1715 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1716 {
1717 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001718 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001719 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001720 profile_zero(&prof_wait_time);
1721 set_vim_var_nr(VV_PROFILING, 1L);
1722 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001723 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001724 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001725 else if (STRCMP(eap->arg, "pause") == 0)
1726 {
1727 if (do_profiling == PROF_YES)
1728 profile_start(&pause_time);
1729 do_profiling = PROF_PAUSED;
1730 }
1731 else if (STRCMP(eap->arg, "continue") == 0)
1732 {
1733 if (do_profiling == PROF_PAUSED)
1734 {
1735 profile_end(&pause_time);
1736 profile_add(&prof_wait_time, &pause_time);
1737 }
1738 do_profiling = PROF_YES;
1739 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001740 else
1741 {
1742 /* The rest is similar to ":breakadd". */
1743 ex_breakadd(eap);
1744 }
1745}
1746
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001747/* Command line expansion for :profile. */
1748static enum
1749{
1750 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001751 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001752} pexpand_what;
1753
1754static char *pexpand_cmds[] = {
1755 "start",
1756#define PROFCMD_START 0
1757 "pause",
1758#define PROFCMD_PAUSE 1
1759 "continue",
1760#define PROFCMD_CONTINUE 2
1761 "func",
1762#define PROFCMD_FUNC 3
1763 "file",
1764#define PROFCMD_FILE 4
1765 NULL
1766#define PROFCMD_LAST 5
1767};
1768
1769/*
1770 * Function given to ExpandGeneric() to obtain the profile command
1771 * specific expansion.
1772 */
1773 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001774get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001775{
1776 switch (pexpand_what)
1777 {
1778 case PEXP_SUBCMD:
1779 return (char_u *)pexpand_cmds[idx];
1780 /* case PEXP_FUNC: TODO */
1781 default:
1782 return NULL;
1783 }
1784}
1785
1786/*
1787 * Handle command line completion for :profile command.
1788 */
1789 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001790set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001791{
1792 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001793
1794 /* Default: expand subcommands. */
1795 xp->xp_context = EXPAND_PROFILE;
1796 pexpand_what = PEXP_SUBCMD;
1797 xp->xp_pattern = arg;
1798
1799 end_subcmd = skiptowhite(arg);
1800 if (*end_subcmd == NUL)
1801 return;
1802
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001803 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001804 {
1805 xp->xp_context = EXPAND_FILES;
1806 xp->xp_pattern = skipwhite(end_subcmd);
1807 return;
1808 }
1809
1810 /* TODO: expand function names after "func" */
1811 xp->xp_context = EXPAND_NOTHING;
1812}
1813
Bram Moolenaar05159a02005-02-26 23:04:13 +00001814/*
1815 * Dump the profiling info.
1816 */
1817 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001818profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001819{
1820 FILE *fd;
1821
1822 if (profile_fname != NULL)
1823 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001824 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001825 if (fd == NULL)
1826 EMSG2(_(e_notopen), profile_fname);
1827 else
1828 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001829 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001830 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001831 fclose(fd);
1832 }
1833 }
1834}
1835
1836/*
1837 * Start profiling script "fp".
1838 */
1839 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001840script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001841{
1842 si->sn_pr_count = 0;
1843 profile_zero(&si->sn_pr_total);
1844 profile_zero(&si->sn_pr_self);
1845
1846 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1847 si->sn_prl_idx = -1;
1848 si->sn_prof_on = TRUE;
1849 si->sn_pr_nest = 0;
1850}
1851
1852/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02001853 * Save time when starting to invoke another script or function.
Bram Moolenaar05159a02005-02-26 23:04:13 +00001854 */
1855 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001856script_prof_save(
1857 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001858{
1859 scriptitem_T *si;
1860
1861 if (current_SID > 0 && current_SID <= script_items.ga_len)
1862 {
1863 si = &SCRIPT_ITEM(current_SID);
1864 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1865 profile_start(&si->sn_pr_child);
1866 }
1867 profile_get_wait(tm);
1868}
1869
1870/*
1871 * Count time spent in children after invoking another script or function.
1872 */
1873 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001874script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001875{
1876 scriptitem_T *si;
1877
1878 if (current_SID > 0 && current_SID <= script_items.ga_len)
1879 {
1880 si = &SCRIPT_ITEM(current_SID);
1881 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1882 {
1883 profile_end(&si->sn_pr_child);
1884 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1885 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1886 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1887 }
1888 }
1889}
1890
1891static proftime_T inchar_time;
1892
1893/*
1894 * Called when starting to wait for the user to type a character.
1895 */
1896 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001897prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001898{
1899 profile_start(&inchar_time);
1900}
1901
1902/*
1903 * Called when finished waiting for the user to type a character.
1904 */
1905 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001906prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001907{
1908 profile_end(&inchar_time);
1909 profile_add(&prof_wait_time, &inchar_time);
1910}
1911
1912/*
1913 * Dump the profiling results for all scripts in file "fd".
1914 */
1915 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001916script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001917{
1918 int id;
1919 scriptitem_T *si;
1920 int i;
1921 FILE *sfd;
1922 sn_prl_T *pp;
1923
1924 for (id = 1; id <= script_items.ga_len; ++id)
1925 {
1926 si = &SCRIPT_ITEM(id);
1927 if (si->sn_prof_on)
1928 {
1929 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1930 if (si->sn_pr_count == 1)
1931 fprintf(fd, "Sourced 1 time\n");
1932 else
1933 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1934 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1935 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1936 fprintf(fd, "\n");
1937 fprintf(fd, "count total (s) self (s)\n");
1938
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001939 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001940 if (sfd == NULL)
1941 fprintf(fd, "Cannot open file!\n");
1942 else
1943 {
Bram Moolenaar67435d92017-10-19 21:04:37 +02001944 /* Keep going till the end of file, so that trailing
1945 * continuation lines are listed. */
1946 for (i = 0; ; ++i)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001947 {
1948 if (vim_fgets(IObuff, IOSIZE, sfd))
1949 break;
Bram Moolenaarac112f02017-12-05 16:46:28 +01001950 /* When a line has been truncated, append NL, taking care
1951 * of multi-byte characters . */
1952 if (IObuff[IOSIZE - 2] != NUL && IObuff[IOSIZE - 2] != NL)
1953 {
1954 int n = IOSIZE - 2;
1955# ifdef FEAT_MBYTE
1956 if (enc_utf8)
1957 {
1958 /* Move to the first byte of this char.
1959 * utf_head_off() doesn't work, because it checks
1960 * for a truncated character. */
1961 while (n > 0 && (IObuff[n] & 0xc0) == 0x80)
1962 --n;
1963 }
1964 else if (has_mbyte)
1965 n -= mb_head_off(IObuff, IObuff + n);
1966# endif
1967 IObuff[n] = NL;
1968 IObuff[n + 1] = NUL;
1969 }
Bram Moolenaar67435d92017-10-19 21:04:37 +02001970 if (i < si->sn_prl_ga.ga_len
1971 && (pp = &PRL_ITEM(si, i))->snp_count > 0)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001972 {
1973 fprintf(fd, "%5d ", pp->snp_count);
1974 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1975 fprintf(fd, " ");
1976 else
1977 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1978 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1979 }
1980 else
1981 fprintf(fd, " ");
1982 fprintf(fd, "%s", IObuff);
1983 }
1984 fclose(sfd);
1985 }
1986 fprintf(fd, "\n");
1987 }
1988 }
1989}
1990
1991/*
1992 * Return TRUE when a function defined in the current script should be
1993 * profiled.
1994 */
1995 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001996prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001997{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00001998 if (current_SID > 0)
1999 return SCRIPT_ITEM(current_SID).sn_pr_force;
2000 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00002001}
2002
2003# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004#endif
2005
2006/*
2007 * If 'autowrite' option set, try to write the file.
2008 * Careful: autocommands may make "buf" invalid!
2009 *
2010 * return FAIL for failure, OK otherwise
2011 */
2012 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002013autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014{
Bram Moolenaar373154b2007-02-13 05:19:30 +00002015 int r;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002016 bufref_T bufref;
Bram Moolenaar373154b2007-02-13 05:19:30 +00002017
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 if (!(p_aw || p_awa) || !p_write
2019#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00002020 /* never autowrite a "nofile" or "nowrite" buffer */
2021 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00002023 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 return FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002025 set_bufref(&bufref, buf);
Bram Moolenaar373154b2007-02-13 05:19:30 +00002026 r = buf_write_all(buf, forceit);
2027
2028 /* Writing may succeed but the buffer still changed, e.g., when there is a
2029 * conversion error. We do want to return FAIL then. */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002030 if (bufref_valid(&bufref) && bufIsChanged(buf))
Bram Moolenaar373154b2007-02-13 05:19:30 +00002031 r = FAIL;
2032 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033}
2034
2035/*
2036 * flush all buffers, except the ones that are readonly
2037 */
2038 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002039autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040{
2041 buf_T *buf;
2042
2043 if (!(p_aw || p_awa) || !p_write)
2044 return;
Bram Moolenaar29323592016-07-24 22:04:11 +02002045 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 if (bufIsChanged(buf) && !buf->b_p_ro)
2047 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002048 bufref_T bufref;
2049
2050 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002051
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 (void)buf_write_all(buf, FALSE);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002053
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002055 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002057 }
2058}
2059
2060/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002061 * Return TRUE if buffer was changed and cannot be abandoned.
2062 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002065check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066{
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002067 int forceit = (flags & CCGD_FORCEIT);
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002068 bufref_T bufref;
2069
2070 set_bufref(&bufref, buf);
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002071
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 if ( !forceit
2073 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002074 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
2075 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 {
2077#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2078 if ((p_confirm || cmdmod.confirm) && p_write)
2079 {
2080 buf_T *buf2;
2081 int count = 0;
2082
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002083 if (flags & CCGD_ALLBUF)
Bram Moolenaar29323592016-07-24 22:04:11 +02002084 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 if (bufIsChanged(buf2)
2086 && (buf2->b_ffname != NULL
2087# ifdef FEAT_BROWSE
2088 || cmdmod.browse
2089# endif
2090 ))
2091 ++count;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002092 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 /* Autocommand deleted buffer, oops! It's not changed now. */
2094 return FALSE;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002095
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 dialog_changed(buf, count > 1);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002097
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002098 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002099 /* Autocommand deleted buffer, oops! It's not changed now. */
2100 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 return bufIsChanged(buf);
2102 }
2103#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002104 if (flags & CCGD_EXCMD)
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002105 no_write_message();
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002106 else
Bram Moolenaar7a760922018-02-19 23:10:02 +01002107 no_write_message_nobang(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108 return TRUE;
2109 }
2110 return FALSE;
2111}
2112
2113#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
2114
2115#if defined(FEAT_BROWSE) || defined(PROTO)
2116/*
2117 * When wanting to write a file without a file name, ask the user for a name.
2118 */
2119 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002120browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121{
2122 if (buf->b_fname == NULL)
2123 {
2124 char_u *fname;
2125
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002126 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
2127 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 if (fname != NULL)
2129 {
2130 if (setfname(buf, fname, NULL, TRUE) == OK)
2131 buf->b_flags |= BF_NOTEDITED;
2132 vim_free(fname);
2133 }
2134 }
2135}
2136#endif
2137
2138/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02002139 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 * Must check 'write' option first!
2141 */
2142 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002143dialog_changed(
2144 buf_T *buf,
2145 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146{
Bram Moolenaard9462e32011-04-11 21:35:11 +02002147 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 int ret;
2149 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02002150 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151
Bram Moolenaar3f9a1ff2017-08-21 22:06:02 +02002152 dialog_msg(buff, _("Save changes to \"%s\"?"), buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 if (checkall)
2154 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
2155 else
2156 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
2157
Bram Moolenaar8218f602012-04-25 17:32:18 +02002158 /* Init ea pseudo-structure, this is needed for the check_overwrite()
2159 * function. */
2160 ea.append = ea.forceit = FALSE;
2161
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 if (ret == VIM_YES)
2163 {
2164#ifdef FEAT_BROWSE
2165 /* May get file name, when there is none */
2166 browse_save_fname(buf);
2167#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002168 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
2169 buf->b_fname, buf->b_ffname, FALSE) == OK)
2170 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 (void)buf_write_all(buf, FALSE);
2172 }
2173 else if (ret == VIM_NO)
2174 {
2175 unchanged(buf, TRUE);
2176 }
2177 else if (ret == VIM_ALL)
2178 {
2179 /*
2180 * Write all modified files that can be written.
2181 * Skip readonly buffers, these need to be confirmed
2182 * individually.
2183 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002184 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 {
2186 if (bufIsChanged(buf2)
2187 && (buf2->b_ffname != NULL
2188#ifdef FEAT_BROWSE
2189 || cmdmod.browse
2190#endif
2191 )
2192 && !buf2->b_p_ro)
2193 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002194 bufref_T bufref;
2195
2196 set_bufref(&bufref, buf2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197#ifdef FEAT_BROWSE
2198 /* May get file name, when there is none */
2199 browse_save_fname(buf2);
2200#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002201 if (buf2->b_fname != NULL && check_overwrite(&ea, buf2,
2202 buf2->b_fname, buf2->b_ffname, FALSE) == OK)
2203 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204 (void)buf_write_all(buf2, FALSE);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002205
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002207 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002208 buf2 = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209 }
2210 }
2211 }
2212 else if (ret == VIM_DISCARDALL)
2213 {
2214 /*
2215 * mark all buffers as unchanged
2216 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002217 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 unchanged(buf2, TRUE);
2219 }
2220}
2221#endif
2222
2223/*
2224 * Return TRUE if the buffer "buf" can be abandoned, either by making it
2225 * hidden, autowriting it or unloading it.
2226 */
2227 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002228can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002229{
Bram Moolenaareb44a682017-08-03 22:44:55 +02002230 return ( buf_hide(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231 || !bufIsChanged(buf)
2232 || buf->b_nwindows > 1
2233 || autowrite(buf, forceit) == OK
2234 || forceit);
2235}
2236
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002237static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002238
2239/*
2240 * Add a buffer number to "bufnrs", unless it's already there.
2241 */
2242 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002243add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002244{
2245 int i;
2246
2247 for (i = 0; i < *bufnump; ++i)
2248 if (bufnrs[i] == nr)
2249 return;
2250 bufnrs[*bufnump] = nr;
2251 *bufnump = *bufnump + 1;
2252}
2253
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254/*
2255 * Return TRUE if any buffer was changed and cannot be abandoned.
2256 * That changed buffer becomes the current buffer.
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002257 * When "unload" is TRUE the current buffer is unloaded instead of making it
Bram Moolenaar027387f2016-01-02 22:25:52 +01002258 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 */
2260 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002261check_changed_any(
2262 int hidden, /* Only check hidden buffers */
2263 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002265 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 buf_T *buf;
2267 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002268 int i;
2269 int bufnum = 0;
2270 int bufcount = 0;
2271 int *bufnrs;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002272 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002275 /* Make a list of all buffers, with the most important ones first. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002276 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002277 ++bufcount;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002279 if (bufcount == 0)
2280 return FALSE;
2281
2282 bufnrs = (int *)alloc(sizeof(int) * bufcount);
2283 if (bufnrs == NULL)
2284 return FALSE;
2285
2286 /* curbuf */
2287 bufnrs[bufnum++] = curbuf->b_fnum;
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002288
2289 /* buffers in current tab */
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002290 FOR_ALL_WINDOWS(wp)
2291 if (wp->w_buffer != curbuf)
2292 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2293
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002294 /* buffers in other tabs */
Bram Moolenaar29323592016-07-24 22:04:11 +02002295 FOR_ALL_TABPAGES(tp)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002296 if (tp != curtab)
2297 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
2298 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002299
2300 /* any other buffer */
Bram Moolenaar29323592016-07-24 22:04:11 +02002301 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002302 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
2303
2304 for (i = 0; i < bufnum; ++i)
2305 {
2306 buf = buflist_findnr(bufnrs[i]);
2307 if (buf == NULL)
2308 continue;
2309 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
2310 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002311 bufref_T bufref;
2312
2313 set_bufref(&bufref, buf);
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002314#ifdef FEAT_TERMINAL
2315 if (term_job_running(buf->b_term))
2316 {
2317 if (term_try_stop_job(buf) == FAIL)
2318 break;
2319 }
2320 else
2321#endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002322 /* Try auto-writing the buffer. If this fails but the buffer no
2323 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002324 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
2325 | CCGD_MULTWIN
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002326 | CCGD_ALLBUF) && bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002327 break; /* didn't save - still changes */
2328 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 }
2330
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002331 if (i >= bufnum)
2332 goto theend;
2333
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002334 /* Get here if "buf" cannot be abandoned. */
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002335 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002336 exiting = FALSE;
2337#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2338 /*
2339 * When ":confirm" used, don't give an error message.
2340 */
2341 if (!(p_confirm || cmdmod.confirm))
2342#endif
2343 {
2344 /* There must be a wait_return for this message, do_buffer()
2345 * may cause a redraw. But wait_return() is a no-op when vgetc()
2346 * is busy (Quit used from window menu), then make sure we don't
2347 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00002348 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 {
2350 msg_row = cmdline_row;
2351 msg_col = 0;
2352 msg_didout = FALSE;
2353 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002354 if (
2355#ifdef FEAT_TERMINAL
2356 term_job_running(buf->b_term)
2357 ? EMSG2(_("E947: Job still running in buffer \"%s\""),
2358 buf->b_fname)
2359 :
2360#endif
2361 EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002362 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 {
2364 save = no_wait_return;
2365 no_wait_return = FALSE;
2366 wait_return(FALSE);
2367 no_wait_return = save;
2368 }
2369 }
2370
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 /* Try to find a window that contains the buffer. */
2372 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002373 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374 if (wp->w_buffer == buf)
2375 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002376 bufref_T bufref;
2377
2378 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002379
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002380 goto_tabpage_win(tp, wp);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002381
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 /* Paranoia: did autocms wipe out the buffer with changes? */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002383 if (!bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002384 goto theend;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002385 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002387buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388
2389 /* Open the changed buffer in the current window. */
2390 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002391 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002393theend:
2394 vim_free(bufnrs);
2395 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396}
2397
2398/*
2399 * return FAIL if there is no file name, OK if there is one
2400 * give error message for FAIL
2401 */
2402 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002403check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002404{
2405 if (curbuf->b_ffname == NULL)
2406 {
2407 EMSG(_(e_noname));
2408 return FAIL;
2409 }
2410 return OK;
2411}
2412
2413/*
2414 * flush the contents of a buffer, unless it has no file name
2415 *
2416 * return FAIL for failure, OK otherwise
2417 */
2418 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002419buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420{
2421 int retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422 buf_T *old_curbuf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002423
2424 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2425 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2426 FALSE, forceit, TRUE, FALSE));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002428 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01002429 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002431 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 return retval;
2433}
2434
2435/*
2436 * Code to handle the argument list.
2437 */
2438
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002439static char_u *do_one_arg(char_u *str);
2440static int do_arglist(char_u *str, int what, int after);
2441static void alist_check_arg_idx(void);
2442static int editing_arg_idx(win_T *win);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002443static int alist_add_list(int count, char_u **files, int after);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002444#define AL_SET 1
2445#define AL_ADD 2
2446#define AL_DEL 3
2447
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002449 * Isolate one argument, taking backticks.
2450 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 * Return a pointer to the start of the next argument.
2452 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002453 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002454do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455{
2456 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457 int inbacktick;
2458
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 inbacktick = FALSE;
2460 for (p = str; *str; ++str)
2461 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002462 /* When the backslash is used for escaping the special meaning of a
2463 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 if (rem_backslash(str))
2465 {
2466 *p++ = *str++;
2467 *p++ = *str;
2468 }
2469 else
2470 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002471 /* An item ends at a space not in backticks */
2472 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002474 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002475 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002476 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 }
2478 }
2479 str = skipwhite(str);
2480 *p = NUL;
2481
2482 return str;
2483}
2484
Bram Moolenaar86b68352004-12-27 21:59:20 +00002485/*
2486 * Separate the arguments in "str" and return a list of pointers in the
2487 * growarray "gap".
2488 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002489 static int
2490get_arglist(garray_T *gap, char_u *str, int escaped)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002491{
2492 ga_init2(gap, (int)sizeof(char_u *), 20);
2493 while (*str != NUL)
2494 {
2495 if (ga_grow(gap, 1) == FAIL)
2496 {
2497 ga_clear(gap);
2498 return FAIL;
2499 }
2500 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2501
Bram Moolenaar398ee732017-08-03 14:29:14 +02002502 /* If str is escaped, don't handle backslashes or spaces */
2503 if (!escaped)
2504 return OK;
2505
Bram Moolenaar86b68352004-12-27 21:59:20 +00002506 /* Isolate one argument, change it in-place, put a NUL after it. */
2507 str = do_one_arg(str);
2508 }
2509 return OK;
2510}
2511
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002512#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002513/*
2514 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002515 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002516 * Return FAIL or OK.
2517 */
2518 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002519get_arglist_exp(
2520 char_u *str,
2521 int *fcountp,
2522 char_u ***fnamesp,
2523 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002524{
2525 garray_T ga;
2526 int i;
2527
Bram Moolenaar398ee732017-08-03 14:29:14 +02002528 if (get_arglist(&ga, str, TRUE) == FAIL)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002529 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002530 if (wig == TRUE)
2531 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2532 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2533 else
2534 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2535 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2536
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002537 ga_clear(&ga);
2538 return i;
2539}
2540#endif
2541
Bram Moolenaar071d4272004-06-13 20:20:40 +00002542/*
2543 * Redefine the argument list.
2544 */
2545 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002546set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547{
2548 do_arglist(str, AL_SET, 0);
2549}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550
2551/*
2552 * "what" == AL_SET: Redefine the argument list to 'str'.
2553 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2554 * "what" == AL_DEL: remove files in 'str' from the argument list.
2555 *
2556 * Return FAIL for failure, OK otherwise.
2557 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002558 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002559do_arglist(
2560 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002561 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002562 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563{
2564 garray_T new_ga;
2565 int exp_count;
2566 char_u **exp_files;
2567 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 char_u *p;
2569 int match;
Bram Moolenaar398ee732017-08-03 14:29:14 +02002570 int arg_escaped = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571
2572 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002573 * Set default argument for ":argadd" command.
2574 */
2575 if (what == AL_ADD && *str == NUL)
2576 {
2577 if (curbuf->b_ffname == NULL)
2578 return FAIL;
2579 str = curbuf->b_fname;
Bram Moolenaar398ee732017-08-03 14:29:14 +02002580 arg_escaped = FALSE;
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002581 }
2582
2583 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 * Collect all file name arguments in "new_ga".
2585 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002586 if (get_arglist(&new_ga, str, arg_escaped) == FAIL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002587 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002588
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 if (what == AL_DEL)
2590 {
2591 regmatch_T regmatch;
2592 int didone;
2593
2594 /*
2595 * Delete the items: use each item as a regexp and find a match in the
2596 * argument list.
2597 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002598 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2600 {
2601 p = ((char_u **)new_ga.ga_data)[i];
2602 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2603 if (p == NULL)
2604 break;
2605 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2606 if (regmatch.regprog == NULL)
2607 {
2608 vim_free(p);
2609 break;
2610 }
2611
2612 didone = FALSE;
2613 for (match = 0; match < ARGCOUNT; ++match)
2614 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2615 (colnr_T)0))
2616 {
2617 didone = TRUE;
2618 vim_free(ARGLIST[match].ae_fname);
2619 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2620 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2621 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 if (curwin->w_arg_idx > match)
2623 --curwin->w_arg_idx;
2624 --match;
2625 }
2626
Bram Moolenaar473de612013-06-08 18:19:48 +02002627 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002628 vim_free(p);
2629 if (!didone)
2630 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2631 }
2632 ga_clear(&new_ga);
2633 }
2634 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002635 {
2636 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2637 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2638 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002639 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002640 {
2641 EMSG(_(e_nomatch));
2642 return FAIL;
2643 }
2644
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 if (what == AL_ADD)
2646 {
2647 (void)alist_add_list(exp_count, exp_files, after);
2648 vim_free(exp_files);
2649 }
2650 else /* what == AL_SET */
Bram Moolenaar86b68352004-12-27 21:59:20 +00002651 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 }
2653
2654 alist_check_arg_idx();
2655
2656 return OK;
2657}
2658
2659/*
2660 * Check the validity of the arg_idx for each other window.
2661 */
2662 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002663alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002666 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002667
Bram Moolenaarf740b292006-02-16 22:11:02 +00002668 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002669 if (win->w_alist == curwin->w_alist)
2670 check_arg_idx(win);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671}
2672
2673/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002674 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002675 * index.
2676 */
2677 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002678editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002679{
2680 return !(win->w_arg_idx >= WARGCOUNT(win)
2681 || (win->w_buffer->b_fnum
2682 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2683 && (win->w_buffer->b_ffname == NULL
2684 || !(fullpathcmp(
2685 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2686 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2687}
2688
2689/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 * Check if window "win" is editing the w_arg_idx file in its argument list.
2691 */
2692 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002693check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002695 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 {
2697 /* We are not editing the current entry in the argument list.
2698 * Set "arg_had_last" if we are editing the last one. */
2699 win->w_arg_idx_invalid = TRUE;
2700 if (win->w_arg_idx != WARGCOUNT(win) - 1
2701 && arg_had_last == FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 && ALIST(win) == &global_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 && GARGCOUNT > 0
2704 && win->w_arg_idx < GARGCOUNT
2705 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2706 || (win->w_buffer->b_ffname != NULL
2707 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2708 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2709 arg_had_last = TRUE;
2710 }
2711 else
2712 {
2713 /* We are editing the current entry in the argument list.
2714 * Set "arg_had_last" if it's also the last one */
2715 win->w_arg_idx_invalid = FALSE;
2716 if (win->w_arg_idx == WARGCOUNT(win) - 1
Bram Moolenaar4033c552017-09-16 20:54:51 +02002717 && win->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002718 arg_had_last = TRUE;
2719 }
2720}
2721
2722/*
2723 * ":args", ":argslocal" and ":argsglobal".
2724 */
2725 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002726ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727{
2728 int i;
2729
2730 if (eap->cmdidx != CMD_args)
2731 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 alist_unlink(ALIST(curwin));
2733 if (eap->cmdidx == CMD_argglobal)
2734 ALIST(curwin) = &global_alist;
2735 else /* eap->cmdidx == CMD_arglocal */
2736 alist_new();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 }
2738
2739 if (!ends_excmd(*eap->arg))
2740 {
2741 /*
2742 * ":args file ..": define new argument list, handle like ":next"
2743 * Also for ":argslocal file .." and ":argsglobal file ..".
2744 */
2745 ex_next(eap);
2746 }
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02002747 else if (eap->cmdidx == CMD_args)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 {
2749 /*
2750 * ":args": list arguments.
2751 */
2752 if (ARGCOUNT > 0)
2753 {
2754 /* Overwrite the command, for a short list there is no scrolling
2755 * required and no wait_return(). */
2756 gotocmdline(TRUE);
2757 for (i = 0; i < ARGCOUNT; ++i)
2758 {
2759 if (i == curwin->w_arg_idx)
2760 msg_putchar('[');
2761 msg_outtrans(alist_name(&ARGLIST[i]));
2762 if (i == curwin->w_arg_idx)
2763 msg_putchar(']');
2764 msg_putchar(' ');
2765 }
2766 }
2767 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 else if (eap->cmdidx == CMD_arglocal)
2769 {
2770 garray_T *gap = &curwin->w_alist->al_ga;
2771
2772 /*
2773 * ":argslocal": make a local copy of the global argument list.
2774 */
2775 if (ga_grow(gap, GARGCOUNT) == OK)
2776 for (i = 0; i < GARGCOUNT; ++i)
2777 if (GARGLIST[i].ae_fname != NULL)
2778 {
2779 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2780 vim_strsave(GARGLIST[i].ae_fname);
2781 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2782 GARGLIST[i].ae_fnum;
2783 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002784 }
2785 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786}
2787
2788/*
2789 * ":previous", ":sprevious", ":Next" and ":sNext".
2790 */
2791 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002792ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793{
2794 /* If past the last one already, go to the last one. */
2795 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2796 do_argfile(eap, ARGCOUNT - 1);
2797 else
2798 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2799}
2800
2801/*
2802 * ":rewind", ":first", ":sfirst" and ":srewind".
2803 */
2804 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002805ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806{
2807 do_argfile(eap, 0);
2808}
2809
2810/*
2811 * ":last" and ":slast".
2812 */
2813 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002814ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815{
2816 do_argfile(eap, ARGCOUNT - 1);
2817}
2818
2819/*
2820 * ":argument" and ":sargument".
2821 */
2822 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002823ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824{
2825 int i;
2826
2827 if (eap->addr_count > 0)
2828 i = eap->line2 - 1;
2829 else
2830 i = curwin->w_arg_idx;
2831 do_argfile(eap, i);
2832}
2833
2834/*
2835 * Edit file "argn" of the argument lists.
2836 */
2837 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002838do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839{
2840 int other;
2841 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002842 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002843
2844 if (argn < 0 || argn >= ARGCOUNT)
2845 {
2846 if (ARGCOUNT <= 1)
2847 EMSG(_("E163: There is only one file to edit"));
2848 else if (argn < 0)
2849 EMSG(_("E164: Cannot go before first file"));
2850 else
2851 EMSG(_("E165: Cannot go beyond last file"));
2852 }
2853 else
2854 {
2855 setpcmark();
2856#ifdef FEAT_GUI
2857 need_mouse_correct = TRUE;
2858#endif
2859
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002860 /* split window or create new tab page first */
2861 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 {
2863 if (win_split(0, 0) == FAIL)
2864 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002865 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866 }
2867 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 {
2869 /*
2870 * if 'hidden' set, only check for changed file when re-editing
2871 * the same buffer
2872 */
2873 other = TRUE;
Bram Moolenaareb44a682017-08-03 22:44:55 +02002874 if (buf_hide(curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 {
2876 p = fix_fname(alist_name(&ARGLIST[argn]));
2877 other = otherfile(p);
2878 vim_free(p);
2879 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002880 if ((!buf_hide(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002881 && check_changed(curbuf, CCGD_AW
2882 | (other ? 0 : CCGD_MULTWIN)
2883 | (eap->forceit ? CCGD_FORCEIT : 0)
2884 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 return;
2886 }
2887
2888 curwin->w_arg_idx = argn;
Bram Moolenaar4033c552017-09-16 20:54:51 +02002889 if (argn == ARGCOUNT - 1 && curwin->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002890 arg_had_last = TRUE;
2891
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002892 /* Edit the file; always use the last known line number.
2893 * When it fails (e.g. Abort for already edited file) restore the
2894 * argument index. */
2895 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002896 eap, ECMD_LAST,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002897 (buf_hide(curwin->w_buffer) ? ECMD_HIDE : 0)
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002898 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002899 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002901 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 setmark('\'');
2903 }
2904}
2905
2906/*
2907 * ":next", and commands that behave like it.
2908 */
2909 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002910ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911{
2912 int i;
2913
2914 /*
2915 * check for changed buffer now, if this fails the argument list is not
2916 * redefined.
2917 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002918 if ( buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002920 || !check_changed(curbuf, CCGD_AW
2921 | (eap->forceit ? CCGD_FORCEIT : 0)
2922 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 {
2924 if (*eap->arg != NUL) /* redefine file list */
2925 {
2926 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2927 return;
2928 i = 0;
2929 }
2930 else
2931 i = curwin->w_arg_idx + (int)eap->line2;
2932 do_argfile(eap, i);
2933 }
2934}
2935
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936/*
2937 * ":argedit"
2938 */
2939 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002940ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002941{
Bram Moolenaar90305c62017-07-16 15:31:17 +02002942 int i = eap->addr_count ? (int)eap->line2 : curwin->w_arg_idx + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943
Bram Moolenaar90305c62017-07-16 15:31:17 +02002944 if (do_arglist(eap->arg, AL_ADD, i) == FAIL)
2945 return;
2946#ifdef FEAT_TITLE
2947 maketitle();
2948#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949
Bram Moolenaar90305c62017-07-16 15:31:17 +02002950 if (curwin->w_arg_idx == 0 && (curbuf->b_ml.ml_flags & ML_EMPTY)
2951 && curbuf->b_ffname == NULL)
2952 i = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 /* Edit the argument. */
Bram Moolenaar90305c62017-07-16 15:31:17 +02002954 if (i < ARGCOUNT)
2955 do_argfile(eap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956}
2957
2958/*
2959 * ":argadd"
2960 */
2961 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002962ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963{
2964 do_arglist(eap->arg, AL_ADD,
2965 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2966#ifdef FEAT_TITLE
2967 maketitle();
2968#endif
2969}
2970
2971/*
2972 * ":argdelete"
2973 */
2974 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002975ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976{
2977 int i;
2978 int n;
2979
2980 if (eap->addr_count > 0)
2981 {
2982 /* ":1,4argdel": Delete all arguments in the range. */
2983 if (eap->line2 > ARGCOUNT)
2984 eap->line2 = ARGCOUNT;
2985 n = eap->line2 - eap->line1 + 1;
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01002986 if (*eap->arg != NUL)
2987 /* Can't have both a range and an argument. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 EMSG(_(e_invarg));
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01002989 else if (n <= 0)
2990 {
2991 /* Don't give an error for ":%argdel" if the list is empty. */
2992 if (eap->line1 != 1 || eap->line2 != 0)
2993 EMSG(_(e_invrange));
2994 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 else
2996 {
2997 for (i = eap->line1; i <= eap->line2; ++i)
2998 vim_free(ARGLIST[i - 1].ae_fname);
2999 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
3000 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
3001 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003002 if (curwin->w_arg_idx >= eap->line2)
3003 curwin->w_arg_idx -= n;
3004 else if (curwin->w_arg_idx > eap->line1)
3005 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01003006 if (ARGCOUNT == 0)
3007 curwin->w_arg_idx = 0;
3008 else if (curwin->w_arg_idx >= ARGCOUNT)
3009 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003010 }
3011 }
3012 else if (*eap->arg == NUL)
3013 EMSG(_(e_argreq));
3014 else
3015 do_arglist(eap->arg, AL_DEL, 0);
3016#ifdef FEAT_TITLE
3017 maketitle();
3018#endif
3019}
3020
3021/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003022 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 */
3024 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003025ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003026{
3027 int i;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003028 win_T *wp;
3029 tabpage_T *tp;
Bram Moolenaare25bb902015-02-27 20:33:37 +01003030 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 int next_fnum = 0;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003032#if defined(FEAT_SYN_HL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003035 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003036#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02003037 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003038 int qf_idx;
3039#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01003041#ifndef FEAT_QUICKFIX
3042 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
3043 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3044 {
3045 ex_ni(eap);
3046 return;
3047 }
3048#endif
3049
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003050#if defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003051 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00003052 /* Don't do syntax HL autocommands. Skipping the syntax file is a
3053 * great speed improvement. */
3054 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003056#ifdef FEAT_CLIPBOARD
3057 start_global_changes();
3058#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003059
3060 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003061 || eap->cmdidx == CMD_tabdo
Bram Moolenaareb44a682017-08-03 22:44:55 +02003062 || buf_hide(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003063 || !check_changed(curbuf, CCGD_AW
3064 | (eap->forceit ? CCGD_FORCEIT : 0)
3065 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003066 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003068 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003069 wp = firstwin;
3070 tp = first_tabpage;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003071 switch (eap->cmdidx)
3072 {
Bram Moolenaara162bc52015-01-07 16:54:21 +01003073 case CMD_windo:
3074 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
3075 i++;
3076 break;
3077 case CMD_tabdo:
3078 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
3079 i++;
3080 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003081 case CMD_argdo:
3082 i = eap->line1 - 1;
3083 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003084 default:
3085 break;
3086 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 /* set pcmark now */
3088 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003089 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01003090 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003091 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01003092 || !buf->b_p_bl); buf = buf->b_next)
3093 if (buf->b_fnum > eap->line2)
3094 {
3095 buf = NULL;
3096 break;
3097 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003098 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01003099 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003100 }
3101#ifdef FEAT_QUICKFIX
3102 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3103 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3104 {
3105 qf_size = qf_get_size(eap);
3106 if (qf_size <= 0 || eap->line1 > qf_size)
3107 buf = NULL;
3108 else
3109 {
3110 ex_cc(eap);
3111
3112 buf = curbuf;
3113 i = eap->line1 - 1;
3114 if (eap->addr_count <= 0)
3115 /* default is all the quickfix/location list entries */
3116 eap->line2 = qf_size;
3117 }
3118 }
3119#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 else
3121 setpcmark();
3122 listcmd_busy = TRUE; /* avoids setting pcmark below */
3123
Bram Moolenaare25bb902015-02-27 20:33:37 +01003124 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 {
3126 if (eap->cmdidx == CMD_argdo)
3127 {
3128 /* go to argument "i" */
3129 if (i == ARGCOUNT)
3130 break;
3131 /* Don't call do_argfile() when already there, it will try
3132 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003133 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003134 {
3135 /* Clear 'shm' to avoid that the file message overwrites
3136 * any output from the command. */
3137 p_shm_save = vim_strsave(p_shm);
3138 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003140 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3141 vim_free(p_shm_save);
3142 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003143 if (curwin->w_arg_idx != i)
3144 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003145 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003146 else if (eap->cmdidx == CMD_windo)
3147 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003148 /* go to window "wp" */
3149 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003150 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003151 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00003152 if (curwin != wp)
3153 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003154 wp = curwin->w_next;
3155 }
3156 else if (eap->cmdidx == CMD_tabdo)
3157 {
3158 /* go to window "tp" */
3159 if (!valid_tabpage(tp))
3160 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02003161 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003162 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 else if (eap->cmdidx == CMD_bufdo)
3165 {
3166 /* Remember the number of the next listed buffer, in case
3167 * ":bwipe" is used or autocommands do something strange. */
3168 next_fnum = -1;
3169 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
3170 if (buf->b_p_bl)
3171 {
3172 next_fnum = buf->b_fnum;
3173 break;
3174 }
3175 }
3176
Bram Moolenaara162bc52015-01-07 16:54:21 +01003177 ++i;
3178
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 /* execute the command */
3180 do_cmdline(eap->arg, eap->getline, eap->cookie,
3181 DOCMD_VERBOSE + DOCMD_NOWAIT);
3182
3183 if (eap->cmdidx == CMD_bufdo)
3184 {
3185 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01003186 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 break;
3188 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02003189 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003190 if (buf->b_fnum == next_fnum)
3191 break;
3192 if (buf == NULL)
3193 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003194
3195 /* Go to the next buffer. Clear 'shm' to avoid that the file
3196 * message overwrites any output from the command. */
3197 p_shm_save = vim_strsave(p_shm);
3198 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003199 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003200 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3201 vim_free(p_shm_save);
3202
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003203 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204 if (curbuf->b_fnum != next_fnum)
3205 break;
3206 }
3207
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003208#ifdef FEAT_QUICKFIX
3209 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3210 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3211 {
3212 if (i >= qf_size || i >= eap->line2)
3213 break;
3214
3215 qf_idx = qf_get_cur_idx(eap);
3216
3217 ex_cnext(eap);
3218
3219 /* If jumping to the next quickfix entry fails, quit here */
3220 if (qf_get_cur_idx(eap) == qf_idx)
3221 break;
3222 }
3223#endif
3224
Bram Moolenaar071d4272004-06-13 20:20:40 +00003225 if (eap->cmdidx == CMD_windo)
3226 {
3227 validate_cursor(); /* cursor may have moved */
Bram Moolenaar8a3bb562018-03-04 20:14:14 +01003228
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 /* required when 'scrollbind' has been set */
3230 if (curwin->w_p_scb)
3231 do_check_scrollbind(TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01003233
Bram Moolenaara162bc52015-01-07 16:54:21 +01003234 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
3235 if (i+1 > eap->line2)
3236 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003237 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
3238 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 }
3240 listcmd_busy = FALSE;
3241 }
3242
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003243#if defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003244 if (save_ei != NULL)
3245 {
3246 au_event_restore(save_ei);
3247 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
3248 curbuf->b_fname, TRUE, curbuf);
3249 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003251#ifdef FEAT_CLIPBOARD
3252 end_global_changes();
3253#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003254}
3255
3256/*
3257 * Add files[count] to the arglist of the current window after arg "after".
3258 * The file names in files[count] must have been allocated and are taken over.
3259 * Files[] itself is not taken over.
3260 * Returns index of first added argument. Returns -1 when failed (out of mem).
3261 */
3262 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003263alist_add_list(
3264 int count,
3265 char_u **files,
3266 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267{
3268 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003269 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270
3271 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3272 {
3273 if (after < 0)
3274 after = 0;
3275 if (after > ARGCOUNT)
3276 after = ARGCOUNT;
3277 if (after < ARGCOUNT)
3278 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3279 (ARGCOUNT - after) * sizeof(aentry_T));
3280 for (i = 0; i < count; ++i)
3281 {
3282 ARGLIST[after + i].ae_fname = files[i];
3283 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
3284 }
3285 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003286 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3287 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288 return after;
3289 }
3290
3291 for (i = 0; i < count; ++i)
3292 vim_free(files[i]);
3293 return -1;
3294}
3295
Bram Moolenaarcd43eff2018-03-29 15:55:38 +02003296#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3297/*
3298 * Function given to ExpandGeneric() to obtain the possible arguments of the
3299 * argedit and argdelete commands.
3300 */
3301 char_u *
3302get_arglist_name(expand_T *xp UNUSED, int idx)
3303{
3304 if (idx >= ARGCOUNT)
3305 return NULL;
3306
3307 return alist_name(&ARGLIST[idx]);
3308}
3309#endif
3310
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02003311
Bram Moolenaar071d4272004-06-13 20:20:40 +00003312#ifdef FEAT_EVAL
3313/*
3314 * ":compiler[!] {name}"
3315 */
3316 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003317ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318{
3319 char_u *buf;
3320 char_u *old_cur_comp = NULL;
3321 char_u *p;
3322
3323 if (*eap->arg == NUL)
3324 {
3325 /* List all compiler scripts. */
3326 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3327 /* ) keep the indenter happy... */
3328 }
3329 else
3330 {
3331 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3332 if (buf != NULL)
3333 {
3334 if (eap->forceit)
3335 {
3336 /* ":compiler! {name}" sets global options */
3337 do_cmdline_cmd((char_u *)
3338 "command -nargs=* CompilerSet set <args>");
3339 }
3340 else
3341 {
3342 /* ":compiler! {name}" sets local options.
3343 * To remain backwards compatible "current_compiler" is always
3344 * used. A user's compiler plugin may set it, the distributed
3345 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003346 * "b:current_compiler" and restore "current_compiler".
3347 * Explicitly prepend "g:" to make it work in a function. */
3348 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 if (old_cur_comp != NULL)
3350 old_cur_comp = vim_strsave(old_cur_comp);
3351 do_cmdline_cmd((char_u *)
3352 "command -nargs=* CompilerSet setlocal <args>");
3353 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003354 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003355 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356
3357 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003358 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3360 vim_free(buf);
3361
3362 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3363
3364 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003365 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 if (p != NULL)
3367 set_internal_string_var((char_u *)"b:current_compiler", p);
3368
3369 /* Restore "current_compiler" for ":compiler {name}". */
3370 if (!eap->forceit)
3371 {
3372 if (old_cur_comp != NULL)
3373 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003374 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 old_cur_comp);
3376 vim_free(old_cur_comp);
3377 }
3378 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003379 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 }
3381 }
3382 }
3383}
3384#endif
3385
3386/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003387 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003388 */
3389 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003390ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003392 char_u *arg = eap->arg;
3393 char_u *p = skiptowhite(arg);
3394 int len = (int)(p - arg);
3395 int flags = eap->forceit ? DIP_ALL : 0;
3396
3397 if (STRNCMP(arg, "START", len) == 0)
3398 {
3399 flags += DIP_START + DIP_NORTP;
3400 arg = skipwhite(arg + len);
3401 }
3402 else if (STRNCMP(arg, "OPT", len) == 0)
3403 {
3404 flags += DIP_OPT + DIP_NORTP;
3405 arg = skipwhite(arg + len);
3406 }
3407 else if (STRNCMP(arg, "PACK", len) == 0)
3408 {
3409 flags += DIP_START + DIP_OPT + DIP_NORTP;
3410 arg = skipwhite(arg + len);
3411 }
3412 else if (STRNCMP(arg, "ALL", len) == 0)
3413 {
3414 flags += DIP_START + DIP_OPT;
3415 arg = skipwhite(arg + len);
3416 }
3417
3418 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003419}
3420
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003422source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003423{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003424 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425}
3426
3427/*
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003428 * Find the file "name" in all directories in "path" and invoke
3429 * "callback(fname, cookie)".
3430 * "name" can contain wildcards.
3431 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3432 * When "flags" has DIP_DIR: find directories instead of files.
3433 * When "flags" has DIP_ERR: give an error message if there is no match.
3434 *
3435 * return FAIL when no file could be sourced, OK otherwise.
3436 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003437 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003438do_in_path(
3439 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003440 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003441 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003442 void (*callback)(char_u *fname, void *ck),
3443 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444{
3445 char_u *rtp;
3446 char_u *np;
3447 char_u *buf;
3448 char_u *rtp_copy;
3449 char_u *tail;
3450 int num_files;
3451 char_u **files;
3452 int i;
3453 int did_one = FALSE;
3454#ifdef AMIGA
3455 struct Process *proc = (struct Process *)FindTask(0L);
3456 APTR save_winptr = proc->pr_WindowPtr;
3457
3458 /* Avoid a requester here for a volume that doesn't exist. */
3459 proc->pr_WindowPtr = (APTR)-1L;
3460#endif
3461
3462 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3463 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003464 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003465 buf = alloc(MAXPATHL);
3466 if (buf != NULL && rtp_copy != NULL)
3467 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003468 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003469 {
3470 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003471 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003472 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003473 verbose_leave();
3474 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003475
Bram Moolenaar071d4272004-06-13 20:20:40 +00003476 /* Loop over all entries in 'runtimepath'. */
3477 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003478 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 {
Bram Moolenaar66459b72016-08-06 19:01:55 +02003480 size_t buflen;
3481
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 /* Copy the path from 'runtimepath' to buf[]. */
3483 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaar66459b72016-08-06 19:01:55 +02003484 buflen = STRLEN(buf);
3485
3486 /* Skip after or non-after directories. */
3487 if (flags & (DIP_NOAFTER | DIP_AFTER))
3488 {
3489 int is_after = buflen >= 5
3490 && STRCMP(buf + buflen - 5, "after") == 0;
3491
3492 if ((is_after && (flags & DIP_NOAFTER))
3493 || (!is_after && (flags & DIP_AFTER)))
3494 continue;
3495 }
3496
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003497 if (name == NULL)
3498 {
3499 (*callback)(buf, (void *) &cookie);
3500 if (!did_one)
3501 did_one = (cookie == NULL);
3502 }
Bram Moolenaar66459b72016-08-06 19:01:55 +02003503 else if (buflen + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 {
3505 add_pathsep(buf);
3506 tail = buf + STRLEN(buf);
3507
3508 /* Loop over all patterns in "name" */
3509 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003510 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 {
3512 /* Append the pattern from "name" to buf[]. */
3513 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3514 "\t ");
3515
3516 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003517 {
3518 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003519 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003520 verbose_leave();
3521 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522
3523 /* Expand wildcards, invoke the callback for each match. */
3524 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003525 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526 {
3527 for (i = 0; i < num_files; ++i)
3528 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003529 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003531 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 break;
3533 }
3534 FreeWild(num_files, files);
3535 }
3536 }
3537 }
3538 }
3539 }
3540 vim_free(buf);
3541 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003542 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003543 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003544 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3545
3546 if (flags & DIP_ERR)
3547 EMSG3(_(e_dirnotf), basepath, name);
3548 else if (p_verbose > 0)
3549 {
3550 verbose_enter();
3551 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3552 verbose_leave();
3553 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003554 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555
3556#ifdef AMIGA
3557 proc->pr_WindowPtr = save_winptr;
3558#endif
3559
3560 return did_one ? OK : FAIL;
3561}
3562
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003563/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003564 * Find "name" in "path". When found, invoke the callback function for
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003565 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003566 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3567 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003568 * Returns OK when at least one match found, FAIL otherwise.
3569 *
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003570 * If "name" is NULL calls callback for each entry in "path". Cookie is
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003571 * passed by reference in this case, setting it to NULL indicates that callback
3572 * has done its job.
3573 */
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003574 static int
3575do_in_path_and_pp(
3576 char_u *path,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003577 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003578 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003579 void (*callback)(char_u *fname, void *ck),
3580 void *cookie)
3581{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003582 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003583 char_u *s;
3584 int len;
3585 char *start_dir = "pack/*/start/*/%s";
3586 char *opt_dir = "pack/*/opt/*/%s";
3587
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003588 if ((flags & DIP_NORTP) == 0)
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003589 done = do_in_path(path, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003590
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003591 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003592 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003593 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003594 s = alloc(len);
3595 if (s == NULL)
3596 return FAIL;
3597 vim_snprintf((char *)s, len, start_dir, name);
3598 done = do_in_path(p_pp, s, flags, callback, cookie);
3599 vim_free(s);
3600 }
3601
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003602 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003603 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003604 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003605 s = alloc(len);
3606 if (s == NULL)
3607 return FAIL;
3608 vim_snprintf((char *)s, len, opt_dir, name);
3609 done = do_in_path(p_pp, s, flags, callback, cookie);
3610 vim_free(s);
3611 }
3612
3613 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003614}
3615
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003616/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003617 * Just like do_in_path_and_pp(), using 'runtimepath' for "path".
3618 */
3619 int
3620do_in_runtimepath(
3621 char_u *name,
3622 int flags,
3623 void (*callback)(char_u *fname, void *ck),
3624 void *cookie)
3625{
3626 return do_in_path_and_pp(p_rtp, name, flags, callback, cookie);
3627}
3628
3629/*
3630 * Source the file "name" from all directories in 'runtimepath'.
3631 * "name" can contain wildcards.
3632 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3633 *
3634 * return FAIL when no file could be sourced, OK otherwise.
3635 */
3636 int
3637source_runtime(char_u *name, int flags)
3638{
3639 return source_in_path(p_rtp, name, flags);
3640}
3641
3642/*
3643 * Just like source_runtime(), but use "path" instead of 'runtimepath'.
3644 */
3645 int
3646source_in_path(char_u *path, char_u *name, int flags)
3647{
3648 return do_in_path_and_pp(path, name, flags, source_callback, NULL);
3649}
3650
3651
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003652#if defined(FEAT_EVAL) || defined(PROTO)
3653
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003654/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003655 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003656 */
3657 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003658source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003659{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003660 int num_files;
3661 char_u **files;
3662 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003663
Bram Moolenaarf3654822016-03-04 22:12:23 +01003664 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003665 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003666 for (i = 0; i < num_files; ++i)
3667 (void)do_source(files[i], FALSE, DOSO_NONE);
3668 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003669 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003670}
3671
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003672/*
3673 * Add the package directory to 'runtimepath'.
3674 */
3675 static int
3676add_pack_dir_to_rtp(char_u *fname)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003677{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003678 char_u *p4, *p3, *p2, *p1, *p;
3679 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003680 int c;
3681 char_u *new_rtp;
3682 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003683 size_t oldlen;
3684 size_t addlen;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003685 char_u *afterdir = NULL;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003686 size_t afterlen = 0;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003687 char_u *ffname = NULL;
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003688 size_t fname_len;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003689 char_u *buf = NULL;
3690 char_u *rtp_ffname;
3691 int match;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003692 int retval = FAIL;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003693
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003694 p4 = p3 = p2 = p1 = get_past_head(fname);
3695 for (p = p1; *p; MB_PTR_ADV(p))
3696 if (vim_ispathsep_nocolon(*p))
3697 {
3698 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3699 }
3700
3701 /* now we have:
3702 * rtp/pack/name/start/name
3703 * p4 p3 p2 p1
3704 *
3705 * find the part up to "pack" in 'runtimepath' */
3706 c = *++p4; /* append pathsep in order to expand symlink */
3707 *p4 = NUL;
3708 ffname = fix_fname(fname);
3709 *p4 = c;
Bram Moolenaar91715872016-03-03 17:13:03 +01003710 if (ffname == NULL)
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003711 return FAIL;
3712
3713 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3714 fname_len = STRLEN(ffname);
3715 insp = p_rtp;
3716 buf = alloc(MAXPATHL);
3717 if (buf == NULL)
3718 goto theend;
3719 while (*insp != NUL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003720 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003721 copy_option_part(&insp, buf, MAXPATHL, ",");
3722 add_pathsep(buf);
3723 rtp_ffname = fix_fname(buf);
3724 if (rtp_ffname == NULL)
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003725 goto theend;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003726 match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0;
3727 vim_free(rtp_ffname);
3728 if (match)
3729 break;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003730 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003731
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003732 if (*insp == NUL)
3733 /* not found, append at the end */
3734 insp = p_rtp + STRLEN(p_rtp);
3735 else
3736 /* append after the matching directory. */
3737 --insp;
3738
3739 /* check if rtp/pack/name/start/name/after exists */
3740 afterdir = concat_fnames(fname, (char_u *)"after", TRUE);
3741 if (afterdir != NULL && mch_isdir(afterdir))
3742 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3743
3744 oldlen = STRLEN(p_rtp);
3745 addlen = STRLEN(fname) + 1; /* add one for comma */
3746 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1));
3747 /* add one for NUL */
3748 if (new_rtp == NULL)
3749 goto theend;
3750 keep = (int)(insp - p_rtp);
3751 mch_memmove(new_rtp, p_rtp, keep);
3752 new_rtp[keep] = ',';
3753 mch_memmove(new_rtp + keep + 1, fname, addlen);
3754 if (p_rtp[keep] != NUL)
3755 mch_memmove(new_rtp + keep + addlen, p_rtp + keep, oldlen - keep + 1);
3756 if (afterlen > 0)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003757 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003758 STRCAT(new_rtp, ",");
3759 STRCAT(new_rtp, afterdir);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003760 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003761 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3762 vim_free(new_rtp);
3763 retval = OK;
Bram Moolenaarf3654822016-03-04 22:12:23 +01003764
3765theend:
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003766 vim_free(buf);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003767 vim_free(ffname);
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003768 vim_free(afterdir);
3769 return retval;
3770}
3771
3772/*
3773 * Load scripts in "plugin" and "ftdetect" directories of the package.
3774 */
3775 static int
3776load_pack_plugin(char_u *fname)
3777{
3778 static char *plugpat = "%s/plugin/**/*.vim";
3779 static char *ftpat = "%s/ftdetect/*.vim";
3780 int len;
3781 char_u *ffname = fix_fname(fname);
3782 char_u *pat = NULL;
3783 int retval = FAIL;
3784
3785 if (ffname == NULL)
3786 return FAIL;
3787 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3788 pat = alloc(len);
3789 if (pat == NULL)
3790 goto theend;
3791 vim_snprintf((char *)pat, len, plugpat, ffname);
3792 source_all_matches(pat);
3793
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003794 {
3795 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3796
3797 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3798 * found when it loads. */
3799 if (cmd != NULL && eval_to_number(cmd) > 0)
3800 {
3801 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3802 vim_snprintf((char *)pat, len, ftpat, ffname);
3803 source_all_matches(pat);
3804 do_cmdline_cmd((char_u *)"augroup END");
3805 }
3806 vim_free(cmd);
3807 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003808 vim_free(pat);
3809 retval = OK;
3810
3811theend:
3812 vim_free(ffname);
3813 return retval;
3814}
3815
3816/* used for "cookie" of add_pack_plugin() */
3817static int APP_ADD_DIR;
3818static int APP_LOAD;
3819static int APP_BOTH;
3820
3821 static void
3822add_pack_plugin(char_u *fname, void *cookie)
3823{
Bram Moolenaarf98a39c2018-04-18 22:18:23 +02003824 if (cookie != &APP_LOAD)
3825 {
3826 char_u *buf = alloc(MAXPATHL);
3827 char_u *p;
3828 int found = FALSE;
3829
3830 if (buf == NULL)
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003831 return;
Bram Moolenaarf98a39c2018-04-18 22:18:23 +02003832 p = p_rtp;
3833 while (*p != NUL)
3834 {
3835 copy_option_part(&p, buf, MAXPATHL, ",");
3836 if (pathcmp((char *)buf, (char *)fname, -1) == 0)
3837 {
3838 found = TRUE;
3839 break;
3840 }
3841 }
3842 vim_free(buf);
3843 if (!found)
3844 /* directory is not yet in 'runtimepath', add it */
3845 if (add_pack_dir_to_rtp(fname) == FAIL)
3846 return;
3847 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003848
3849 if (cookie != &APP_ADD_DIR)
3850 load_pack_plugin(fname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003851}
3852
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003853/*
3854 * Add all packages in the "start" directory to 'runtimepath'.
3855 */
3856 void
3857add_pack_start_dirs(void)
3858{
3859 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3860 add_pack_plugin, &APP_ADD_DIR);
3861}
3862
3863/*
3864 * Load plugins from all packages in the "start" directory.
3865 */
3866 void
3867load_start_packages(void)
3868{
3869 did_source_packages = TRUE;
3870 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3871 add_pack_plugin, &APP_LOAD);
3872}
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003873
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003874/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003875 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003876 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003877 */
3878 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003879ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003880{
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003881 if (!did_source_packages || eap->forceit)
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003882 {
Bram Moolenaar49b27322016-04-05 21:13:00 +02003883 /* First do a round to add all directories to 'runtimepath', then load
3884 * the plugins. This allows for plugins to use an autoload directory
3885 * of another plugin. */
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003886 add_pack_start_dirs();
3887 load_start_packages();
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003888 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003889}
3890
3891/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003892 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003893 */
3894 void
3895ex_packadd(exarg_T *eap)
3896{
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003897 static char *plugpat = "pack/*/%s/%s";
Bram Moolenaar91715872016-03-03 17:13:03 +01003898 int len;
3899 char *pat;
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003900 int round;
3901 int res = OK;
Bram Moolenaar91715872016-03-03 17:13:03 +01003902
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003903 /* Round 1: use "start", round 2: use "opt". */
3904 for (round = 1; round <= 2; ++round)
3905 {
3906 /* Only look under "start" when loading packages wasn't done yet. */
3907 if (round == 1 && did_source_packages)
3908 continue;
3909
3910 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg) + 5;
3911 pat = (char *)alloc(len);
3912 if (pat == NULL)
3913 return;
3914 vim_snprintf(pat, len, plugpat, round == 1 ? "start" : "opt", eap->arg);
3915 /* The first round don't give a "not found" error, in the second round
3916 * only when nothing was found in the first round. */
3917 res = do_in_path(p_pp, (char_u *)pat,
3918 DIP_ALL + DIP_DIR + (round == 2 && res == FAIL ? DIP_ERR : 0),
3919 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
3920 vim_free(pat);
3921 }
Bram Moolenaar91715872016-03-03 17:13:03 +01003922}
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003923#endif
Bram Moolenaar91715872016-03-03 17:13:03 +01003924
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003925#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926/*
3927 * ":options"
3928 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003929 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003930ex_options(
3931 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003932{
Bram Moolenaarab6c8582017-08-11 17:15:09 +02003933 vim_setenv((char_u *)"OPTWIN_CMD", (char_u *)(cmdmod.tab ? "tab" : ""));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3935}
3936#endif
3937
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003938#if defined(FEAT_PYTHON3) || defined(FEAT_PYTHON) || defined(PROTO)
3939
3940# if (defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)) || defined(PROTO)
3941/*
3942 * Detect Python 3 or 2, and initialize 'pyxversion'.
3943 */
3944 void
3945init_pyxversion(void)
3946{
3947 if (p_pyx == 0)
3948 {
3949 if (python3_enabled(FALSE))
3950 p_pyx = 3;
3951 else if (python_enabled(FALSE))
3952 p_pyx = 2;
3953 }
3954}
3955# endif
3956
3957/*
3958 * Does a file contain one of the following strings at the beginning of any
3959 * line?
3960 * "#!(any string)python2" => returns 2
3961 * "#!(any string)python3" => returns 3
3962 * "# requires python 2.x" => returns 2
3963 * "# requires python 3.x" => returns 3
3964 * otherwise return 0.
3965 */
3966 static int
3967requires_py_version(char_u *filename)
3968{
3969 FILE *file;
3970 int requires_py_version = 0;
3971 int i, lines;
3972
3973 lines = (int)p_mls;
3974 if (lines < 0)
3975 lines = 5;
3976
3977 file = mch_fopen((char *)filename, "r");
3978 if (file != NULL)
3979 {
3980 for (i = 0; i < lines; i++)
3981 {
3982 if (vim_fgets(IObuff, IOSIZE, file))
3983 break;
3984 if (i == 0 && IObuff[0] == '#' && IObuff[1] == '!')
3985 {
3986 /* Check shebang. */
3987 if (strstr((char *)IObuff + 2, "python2") != NULL)
3988 {
3989 requires_py_version = 2;
3990 break;
3991 }
3992 if (strstr((char *)IObuff + 2, "python3") != NULL)
3993 {
3994 requires_py_version = 3;
3995 break;
3996 }
3997 }
3998 IObuff[21] = '\0';
3999 if (STRCMP("# requires python 2.x", IObuff) == 0)
4000 {
4001 requires_py_version = 2;
4002 break;
4003 }
4004 if (STRCMP("# requires python 3.x", IObuff) == 0)
4005 {
4006 requires_py_version = 3;
4007 break;
4008 }
4009 }
4010 fclose(file);
4011 }
4012 return requires_py_version;
4013}
4014
4015
4016/*
4017 * Source a python file using the requested python version.
4018 */
4019 static void
4020source_pyx_file(exarg_T *eap, char_u *fname)
4021{
4022 exarg_T ex;
4023 int v = requires_py_version(fname);
4024
4025# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4026 init_pyxversion();
4027# endif
4028 if (v == 0)
4029 {
4030# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4031 /* user didn't choose a preference, 'pyx' is used */
4032 v = p_pyx;
4033# elif defined(FEAT_PYTHON)
4034 v = 2;
4035# elif defined(FEAT_PYTHON3)
4036 v = 3;
4037# endif
4038 }
4039
4040 /*
4041 * now source, if required python version is not supported show
4042 * unobtrusive message.
4043 */
4044 if (eap == NULL)
4045 vim_memset(&ex, 0, sizeof(ex));
4046 else
4047 ex = *eap;
4048 ex.arg = fname;
4049 ex.cmd = (char_u *)(v == 2 ? "pyfile" : "pyfile3");
4050
4051 if (v == 2)
4052 {
4053# ifdef FEAT_PYTHON
4054 ex_pyfile(&ex);
4055# else
4056 vim_snprintf((char *)IObuff, IOSIZE,
4057 _("W20: Required python version 2.x not supported, ignoring file: %s"),
4058 fname);
4059 MSG(IObuff);
4060# endif
4061 return;
4062 }
4063 else
4064 {
4065# ifdef FEAT_PYTHON3
4066 ex_py3file(&ex);
4067# else
4068 vim_snprintf((char *)IObuff, IOSIZE,
4069 _("W21: Required python version 3.x not supported, ignoring file: %s"),
4070 fname);
4071 MSG(IObuff);
4072# endif
4073 return;
4074 }
4075}
4076
4077/*
4078 * ":pyxfile {fname}"
4079 */
4080 void
4081ex_pyxfile(exarg_T *eap)
4082{
4083 source_pyx_file(eap, eap->arg);
4084}
4085
4086/*
4087 * ":pyx"
4088 */
4089 void
4090ex_pyx(exarg_T *eap)
4091{
4092# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4093 init_pyxversion();
4094 if (p_pyx == 2)
4095 ex_python(eap);
4096 else
4097 ex_py3(eap);
4098# elif defined(FEAT_PYTHON)
4099 ex_python(eap);
4100# elif defined(FEAT_PYTHON3)
4101 ex_py3(eap);
4102# endif
4103}
4104
4105/*
4106 * ":pyxdo"
4107 */
4108 void
4109ex_pyxdo(exarg_T *eap)
4110{
4111# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4112 init_pyxversion();
4113 if (p_pyx == 2)
4114 ex_pydo(eap);
4115 else
4116 ex_py3do(eap);
4117# elif defined(FEAT_PYTHON)
4118 ex_pydo(eap);
4119# elif defined(FEAT_PYTHON3)
4120 ex_py3do(eap);
4121# endif
4122}
4123
4124#endif
4125
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126/*
4127 * ":source {fname}"
4128 */
4129 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004130ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131{
4132#ifdef FEAT_BROWSE
4133 if (cmdmod.browse)
4134 {
4135 char_u *fname = NULL;
4136
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00004137 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
4139 if (fname != NULL)
4140 {
4141 cmd_source(fname, eap);
4142 vim_free(fname);
4143 }
4144 }
4145 else
4146#endif
4147 cmd_source(eap->arg, eap);
4148}
4149
4150 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004151cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004152{
4153 if (*fname == NUL)
4154 EMSG(_(e_argreq));
4155
Bram Moolenaar071d4272004-06-13 20:20:40 +00004156 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02004157 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004158 * Need to execute the commands directly. This is required at least
4159 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004160 * - ":g" command busy
4161 * - after ":argdo", ":windo" or ":bufdo"
4162 * - another command follows
4163 * - inside a loop
4164 */
4165 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
4166#ifdef FEAT_EVAL
4167 || eap->cstack->cs_idx >= 0
4168#endif
4169 );
4170
4171 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004172 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004173 EMSG2(_(e_notopen), fname);
4174}
4175
4176/*
4177 * ":source" and associated commands.
4178 */
4179/*
4180 * Structure used to store info for each sourced file.
4181 * It is shared between do_source() and getsourceline().
4182 * This is required, because it needs to be handed to do_cmdline() and
4183 * sourcing can be done recursively.
4184 */
4185struct source_cookie
4186{
4187 FILE *fp; /* opened file for sourcing */
4188 char_u *nextline; /* if not NULL: line that was read ahead */
4189 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004190#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004191 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
4192 int error; /* TRUE if LF found after CR-LF */
4193#endif
4194#ifdef FEAT_EVAL
4195 linenr_T breakpoint; /* next line with breakpoint or zero */
4196 char_u *fname; /* name of sourced file */
4197 int dbg_tick; /* debug_tick when breakpoint was set */
4198 int level; /* top nesting level of sourced file */
4199#endif
4200#ifdef FEAT_MBYTE
4201 vimconv_T conv; /* type of conversion */
4202#endif
4203};
4204
4205#ifdef FEAT_EVAL
4206/*
4207 * Return the address holding the next breakpoint line for a source cookie.
4208 */
4209 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004210source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211{
4212 return &((struct source_cookie *)cookie)->breakpoint;
4213}
4214
4215/*
4216 * Return the address holding the debug tick for a source cookie.
4217 */
4218 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004219source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220{
4221 return &((struct source_cookie *)cookie)->dbg_tick;
4222}
4223
4224/*
4225 * Return the nesting level for a source cookie.
4226 */
4227 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004228source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229{
4230 return ((struct source_cookie *)cookie)->level;
4231}
4232#endif
4233
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004234static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004236#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
4237# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004238static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004239
4240/*
4241 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004242 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 */
4244 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004245fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004247# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01004248 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
4249# else
4250 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004251# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252
4253 if (fd_tmp == -1)
4254 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004255
4256# ifdef HAVE_FD_CLOEXEC
4257 {
4258 int fdflags = fcntl(fd_tmp, F_GETFD);
4259 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02004260 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004261 }
4262# endif
4263
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 return fdopen(fd_tmp, READBIN);
4265}
4266#endif
4267
4268
4269/*
4270 * do_source: Read the file "fname" and execute its lines as EX commands.
4271 *
4272 * This function may be called recursively!
4273 *
4274 * return FAIL if file could not be opened, OK otherwise
4275 */
4276 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004277do_source(
4278 char_u *fname,
4279 int check_other, /* check for .vimrc and _vimrc */
4280 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281{
4282 struct source_cookie cookie;
4283 char_u *save_sourcing_name;
4284 linenr_T save_sourcing_lnum;
4285 char_u *p;
4286 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00004287 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 int retval = FAIL;
4289#ifdef FEAT_EVAL
4290 scid_T save_current_SID;
4291 static scid_T last_current_SID = 0;
4292 void *save_funccalp;
4293 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004294 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02004296 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 int stat_ok;
4298# endif
4299#endif
4300#ifdef STARTUPTIME
4301 struct timeval tv_rel;
4302 struct timeval tv_start;
4303#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004304#ifdef FEAT_PROFILE
4305 proftime_T wait_start;
4306#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004307
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 if (p == NULL)
4310 return retval;
4311 fname_exp = fix_fname(p);
4312 vim_free(p);
4313 if (fname_exp == NULL)
4314 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004315 if (mch_isdir(fname_exp))
4316 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00004317 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 goto theend;
4319 }
4320
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004321 /* Apply SourceCmd autocommands, they should get the file and source it. */
4322 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
4323 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
4324 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004325 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004326#ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004327 retval = aborting() ? FAIL : OK;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004328#else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004329 retval = OK;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004330#endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004331 goto theend;
4332 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004333
4334 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004335 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004336
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004337#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004338 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4339#else
4340 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4341#endif
4342 if (cookie.fp == NULL && check_other)
4343 {
4344 /*
4345 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
4346 * and ".exrc" by "_exrc" or vice versa.
4347 */
4348 p = gettail(fname_exp);
4349 if ((*p == '.' || *p == '_')
4350 && (STRICMP(p + 1, "vimrc") == 0
4351 || STRICMP(p + 1, "gvimrc") == 0
4352 || STRICMP(p + 1, "exrc") == 0))
4353 {
4354 if (*p == '_')
4355 *p = '.';
4356 else
4357 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004358#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4360#else
4361 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4362#endif
4363 }
4364 }
4365
4366 if (cookie.fp == NULL)
4367 {
4368 if (p_verbose > 0)
4369 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004370 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004372 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373 else
4374 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004375 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004376 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 }
4378 goto theend;
4379 }
4380
4381 /*
4382 * The file exists.
4383 * - In verbose mode, give a message.
4384 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
4385 */
4386 if (p_verbose > 1)
4387 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004388 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004390 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004391 else
4392 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004393 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004394 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004396 if (is_vimrc == DOSO_VIMRC)
4397 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
4398 else if (is_vimrc == DOSO_GVIMRC)
4399 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004400
4401#ifdef USE_CRNL
4402 /* If no automatic file format: Set default to CR-NL. */
4403 if (*p_ffs == NUL)
4404 cookie.fileformat = EOL_DOS;
4405 else
4406 cookie.fileformat = EOL_UNKNOWN;
4407 cookie.error = FALSE;
4408#endif
4409
4410#ifdef USE_CR
4411 /* If no automatic file format: Set default to CR. */
4412 if (*p_ffs == NUL)
4413 cookie.fileformat = EOL_MAC;
4414 else
4415 cookie.fileformat = EOL_UNKNOWN;
4416 cookie.error = FALSE;
4417#endif
4418
4419 cookie.nextline = NULL;
4420 cookie.finished = FALSE;
4421
4422#ifdef FEAT_EVAL
4423 /*
4424 * Check if this script has a breakpoint.
4425 */
4426 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
4427 cookie.fname = fname_exp;
4428 cookie.dbg_tick = debug_tick;
4429
4430 cookie.level = ex_nesting_level;
4431#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432
4433 /*
4434 * Keep the sourcing name/lnum, for recursive calls.
4435 */
4436 save_sourcing_name = sourcing_name;
4437 sourcing_name = fname_exp;
4438 save_sourcing_lnum = sourcing_lnum;
4439 sourcing_lnum = 0;
4440
4441#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004442 if (time_fd != NULL)
4443 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004444#endif
4445
4446#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00004447# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004448 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004449 prof_child_enter(&wait_start); /* entering a child now */
4450# endif
4451
4452 /* Don't use local function variables, if called from a function.
4453 * Also starts profiling timer for nested script. */
4454 save_funccalp = save_funccal();
4455
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 /*
4457 * Check if this script was sourced before to finds its SID.
4458 * If it's new, generate a new SID.
4459 */
4460 save_current_SID = current_SID;
4461# ifdef UNIX
4462 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
4463# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004464 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
4465 {
4466 si = &SCRIPT_ITEM(current_SID);
4467 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 && (
4469# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00004470 /* Compare dev/ino when possible, it catches symbolic
4471 * links. Also compare file names, the inode may change
4472 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004473 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004474 && (si->sn_dev == st.st_dev
4475 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004477 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004478 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004479 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480 if (current_SID == 0)
4481 {
4482 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004483 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
4484 == FAIL)
4485 goto almosttheend;
4486 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00004488 ++script_items.ga_len;
4489 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
4490# ifdef FEAT_PROFILE
4491 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004494 si = &SCRIPT_ITEM(current_SID);
4495 si->sn_name = fname_exp;
4496 fname_exp = NULL;
4497# ifdef UNIX
4498 if (stat_ok)
4499 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004500 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004501 si->sn_dev = st.st_dev;
4502 si->sn_ino = st.st_ino;
4503 }
4504 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004505 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004506# endif
4507
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 /* Allocate the local script variables to use for this script. */
4509 new_script_vars(current_SID);
4510 }
4511
Bram Moolenaar05159a02005-02-26 23:04:13 +00004512# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004513 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004514 {
4515 int forceit;
4516
4517 /* Check if we do profiling for this script. */
4518 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
4519 {
4520 script_do_profile(si);
4521 si->sn_pr_force = forceit;
4522 }
4523 if (si->sn_prof_on)
4524 {
4525 ++si->sn_pr_count;
4526 profile_start(&si->sn_pr_start);
4527 profile_zero(&si->sn_pr_children);
4528 }
4529 }
4530# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004531#endif
4532
Bram Moolenaar67435d92017-10-19 21:04:37 +02004533#ifdef FEAT_MBYTE
4534 cookie.conv.vc_type = CONV_NONE; /* no conversion */
4535
4536 /* Read the first line so we can check for a UTF-8 BOM. */
4537 firstline = getsourceline(0, (void *)&cookie, 0);
4538 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
4539 && firstline[1] == 0xbb && firstline[2] == 0xbf)
4540 {
4541 /* Found BOM; setup conversion, skip over BOM and recode the line. */
4542 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
4543 p = string_convert(&cookie.conv, firstline + 3, NULL);
4544 if (p == NULL)
4545 p = vim_strsave(firstline + 3);
4546 if (p != NULL)
4547 {
4548 vim_free(firstline);
4549 firstline = p;
4550 }
4551 }
4552#endif
4553
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554 /*
4555 * Call do_cmdline, which will call getsourceline() to get the lines.
4556 */
Bram Moolenaar73881402009-02-04 16:50:47 +00004557 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004560
4561#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004562 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004563 {
4564 /* Get "si" again, "script_items" may have been reallocated. */
4565 si = &SCRIPT_ITEM(current_SID);
4566 if (si->sn_prof_on)
4567 {
4568 profile_end(&si->sn_pr_start);
4569 profile_sub_wait(&wait_start, &si->sn_pr_start);
4570 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004571 profile_self(&si->sn_pr_self, &si->sn_pr_start,
4572 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004573 }
4574 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575#endif
4576
4577 if (got_int)
4578 EMSG(_(e_interr));
4579 sourcing_name = save_sourcing_name;
4580 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581 if (p_verbose > 1)
4582 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004583 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004584 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004586 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004587 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004588 }
4589#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004590 if (time_fd != NULL)
4591 {
4592 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4593 time_msg((char *)IObuff, &tv_start);
4594 time_pop(&tv_rel);
4595 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596#endif
4597
4598#ifdef FEAT_EVAL
4599 /*
4600 * After a "finish" in debug mode, need to break at first command of next
4601 * sourced file.
4602 */
4603 if (save_debug_break_level > ex_nesting_level
4604 && debug_break_level == ex_nesting_level)
4605 ++debug_break_level;
4606#endif
4607
Bram Moolenaar05159a02005-02-26 23:04:13 +00004608#ifdef FEAT_EVAL
4609almosttheend:
4610 current_SID = save_current_SID;
4611 restore_funccal(save_funccalp);
4612# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004613 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004614 prof_child_exit(&wait_start); /* leaving a child now */
4615# endif
4616#endif
4617 fclose(cookie.fp);
4618 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004619 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004620#ifdef FEAT_MBYTE
4621 convert_setup(&cookie.conv, NULL, NULL);
4622#endif
4623
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624theend:
4625 vim_free(fname_exp);
4626 return retval;
4627}
4628
4629#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004630
Bram Moolenaar071d4272004-06-13 20:20:40 +00004631/*
4632 * ":scriptnames"
4633 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004635ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636{
4637 int i;
4638
Bram Moolenaar05159a02005-02-26 23:04:13 +00004639 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4640 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004641 {
4642 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4643 NameBuff, MAXPATHL, TRUE);
4644 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004645 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646}
4647
4648# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4649/*
4650 * Fix slashes in the list of script names for 'shellslash'.
4651 */
4652 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004653scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654{
4655 int i;
4656
Bram Moolenaar05159a02005-02-26 23:04:13 +00004657 for (i = 1; i <= script_items.ga_len; ++i)
4658 if (SCRIPT_ITEM(i).sn_name != NULL)
4659 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660}
4661# endif
4662
4663/*
4664 * Get a pointer to a script name. Used for ":verbose set".
4665 */
4666 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004667get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004668{
4669 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004670 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004672 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004674 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004676 return (char_u *)_("environment variable");
4677 if (id == SID_ERROR)
4678 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004679 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004681
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004682# if defined(EXITFREE) || defined(PROTO)
4683 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004684free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004685{
4686 int i;
4687
4688 for (i = script_items.ga_len; i > 0; --i)
4689 vim_free(SCRIPT_ITEM(i).sn_name);
4690 ga_clear(&script_items);
4691}
4692# endif
4693
Bram Moolenaar071d4272004-06-13 20:20:40 +00004694#endif
4695
4696#if defined(USE_CR) || defined(PROTO)
4697
4698# if defined(__MSL__) && (__MSL__ >= 22)
4699/*
4700 * Newer version of the Metrowerks library handle DOS and UNIX files
4701 * without help.
4702 * Test with earlier versions, MSL 2.2 is the library supplied with
4703 * Codewarrior Pro 2.
4704 */
4705 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004706fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004707{
4708 return fgets(s, n, stream);
4709}
4710# else
4711/*
4712 * Version of fgets() which also works for lines ending in a <CR> only
4713 * (Macintosh format).
4714 * For older versions of the Metrowerks library.
4715 * At least CodeWarrior 9 needed this code.
4716 */
4717 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004718fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719{
4720 int c = 0;
4721 int char_read = 0;
4722
4723 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4724 {
4725 c = fgetc(stream);
4726 s[char_read++] = c;
4727 /* If the file is in DOS format, we need to skip a NL after a CR. I
4728 * thought it was the other way around, but this appears to work... */
4729 if (c == '\n')
4730 {
4731 c = fgetc(stream);
4732 if (c != '\r')
4733 ungetc(c, stream);
4734 }
4735 }
4736
4737 s[char_read] = 0;
4738 if (char_read == 0)
4739 return NULL;
4740
4741 if (feof(stream) && char_read == 1)
4742 return NULL;
4743
4744 return s;
4745}
4746# endif
4747#endif
4748
4749/*
4750 * Get one full line from a sourced file.
4751 * Called by do_cmdline() when it's called from do_source().
4752 *
4753 * Return a pointer to the line in allocated memory.
4754 * Return NULL for end-of-file or some error.
4755 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004757getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004758{
4759 struct source_cookie *sp = (struct source_cookie *)cookie;
4760 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004761 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004762
4763#ifdef FEAT_EVAL
4764 /* If breakpoints have been added/deleted need to check for it. */
4765 if (sp->dbg_tick < debug_tick)
4766 {
4767 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4768 sp->dbg_tick = debug_tick;
4769 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004770# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004771 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004772 script_line_end();
4773# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774#endif
4775 /*
4776 * Get current line. If there is a read-ahead line, use it, otherwise get
4777 * one now.
4778 */
4779 if (sp->finished)
4780 line = NULL;
4781 else if (sp->nextline == NULL)
4782 line = get_one_sourceline(sp);
4783 else
4784 {
4785 line = sp->nextline;
4786 sp->nextline = NULL;
4787 ++sourcing_lnum;
4788 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004789#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004790 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004791 script_line_start();
4792#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004793
4794 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4795 * contain the 'C' flag. */
4796 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4797 {
4798 /* compensate for the one line read-ahead */
4799 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004800
4801 /* Get the next line and concatenate it when it starts with a
4802 * backslash. We always need to read the next line, keep it in
4803 * sp->nextline. */
4804 sp->nextline = get_one_sourceline(sp);
4805 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004806 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004807 garray_T ga;
4808
Bram Moolenaarb549a732012-02-22 18:29:33 +01004809 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004810 ga_concat(&ga, line);
4811 ga_concat(&ga, p + 1);
4812 for (;;)
4813 {
4814 vim_free(sp->nextline);
4815 sp->nextline = get_one_sourceline(sp);
4816 if (sp->nextline == NULL)
4817 break;
4818 p = skipwhite(sp->nextline);
4819 if (*p != '\\')
4820 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004821 /* Adjust the growsize to the current length to speed up
4822 * concatenating many lines. */
4823 if (ga.ga_len > 400)
4824 {
4825 if (ga.ga_len > 8000)
4826 ga.ga_growsize = 8000;
4827 else
4828 ga.ga_growsize = ga.ga_len;
4829 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004830 ga_concat(&ga, p + 1);
4831 }
4832 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004834 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835 }
4836 }
4837
4838#ifdef FEAT_MBYTE
4839 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4840 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004841 char_u *s;
4842
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843 /* Convert the encoding of the script line. */
4844 s = string_convert(&sp->conv, line, NULL);
4845 if (s != NULL)
4846 {
4847 vim_free(line);
4848 line = s;
4849 }
4850 }
4851#endif
4852
4853#ifdef FEAT_EVAL
4854 /* Did we encounter a breakpoint? */
4855 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4856 {
4857 dbg_breakpoint(sp->fname, sourcing_lnum);
4858 /* Find next breakpoint. */
4859 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4860 sp->dbg_tick = debug_tick;
4861 }
4862#endif
4863
4864 return line;
4865}
4866
4867 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004868get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869{
4870 garray_T ga;
4871 int len;
4872 int c;
4873 char_u *buf;
4874#ifdef USE_CRNL
4875 int has_cr; /* CR-LF found */
4876#endif
4877#ifdef USE_CR
4878 char_u *scan;
4879#endif
4880 int have_read = FALSE;
4881
4882 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004883 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884
4885 /*
4886 * Loop until there is a finished line (or end-of-file).
4887 */
4888 sourcing_lnum++;
4889 for (;;)
4890 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004891 /* make room to read at least 120 (more) characters */
4892 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004893 break;
4894 buf = (char_u *)ga.ga_data;
4895
4896#ifdef USE_CR
4897 if (sp->fileformat == EOL_MAC)
4898 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004899 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4900 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004901 break;
4902 }
4903 else
4904#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004905 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4906 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004907 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004908 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004909#ifdef USE_CRNL
4910 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4911 * CTRL-Z by its own, or after a NL. */
4912 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4913 && sp->fileformat == EOL_DOS
4914 && buf[len - 1] == Ctrl_Z)
4915 {
4916 buf[len - 1] = NUL;
4917 break;
4918 }
4919#endif
4920
4921#ifdef USE_CR
4922 /* If the read doesn't stop on a new line, and there's
4923 * some CR then we assume a Mac format */
4924 if (sp->fileformat == EOL_UNKNOWN)
4925 {
4926 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4927 sp->fileformat = EOL_MAC;
4928 else
4929 sp->fileformat = EOL_UNIX;
4930 }
4931
4932 if (sp->fileformat == EOL_MAC)
4933 {
4934 scan = vim_strchr(buf, '\r');
4935
4936 if (scan != NULL)
4937 {
4938 *scan = '\n';
4939 if (*(scan + 1) != 0)
4940 {
4941 *(scan + 1) = 0;
4942 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4943 }
4944 }
4945 len = STRLEN(buf);
4946 }
4947#endif
4948
4949 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 ga.ga_len = len;
4951
4952 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004953 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004954 continue;
4955
4956 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4957 {
4958#ifdef USE_CRNL
4959 has_cr = (len >= 2 && buf[len - 2] == '\r');
4960 if (sp->fileformat == EOL_UNKNOWN)
4961 {
4962 if (has_cr)
4963 sp->fileformat = EOL_DOS;
4964 else
4965 sp->fileformat = EOL_UNIX;
4966 }
4967
4968 if (sp->fileformat == EOL_DOS)
4969 {
4970 if (has_cr) /* replace trailing CR */
4971 {
4972 buf[len - 2] = '\n';
4973 --len;
4974 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004975 }
4976 else /* lines like ":map xx yy^M" will have failed */
4977 {
4978 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004979 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01004980 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004982 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983 sp->error = TRUE;
4984 sp->fileformat = EOL_UNIX;
4985 }
4986 }
4987#endif
4988 /* The '\n' is escaped if there is an odd number of ^V's just
4989 * before it, first set "c" just before the 'V's and then check
4990 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
4991 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
4992 ;
4993 if ((len & 1) != (c & 1)) /* escaped NL, read more */
4994 {
4995 sourcing_lnum++;
4996 continue;
4997 }
4998
4999 buf[len - 1] = NUL; /* remove the NL */
5000 }
5001
5002 /*
5003 * Check for ^C here now and then, so recursive :so can be broken.
5004 */
5005 line_breakcheck();
5006 break;
5007 }
5008
5009 if (have_read)
5010 return (char_u *)ga.ga_data;
5011
5012 vim_free(ga.ga_data);
5013 return NULL;
5014}
5015
Bram Moolenaar05159a02005-02-26 23:04:13 +00005016#if defined(FEAT_PROFILE) || defined(PROTO)
5017/*
5018 * Called when starting to read a script line.
5019 * "sourcing_lnum" must be correct!
5020 * When skipping lines it may not actually be executed, but we won't find out
5021 * until later and we need to store the time now.
5022 */
5023 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005024script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005025{
5026 scriptitem_T *si;
5027 sn_prl_T *pp;
5028
5029 if (current_SID <= 0 || current_SID > script_items.ga_len)
5030 return;
5031 si = &SCRIPT_ITEM(current_SID);
5032 if (si->sn_prof_on && sourcing_lnum >= 1)
5033 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005034 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00005035 * here isn't counted. */
Bram Moolenaar67435d92017-10-19 21:04:37 +02005036 (void)ga_grow(&si->sn_prl_ga,
5037 (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00005038 si->sn_prl_idx = sourcing_lnum - 1;
5039 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
5040 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
5041 {
5042 /* Zero counters for a line that was not used before. */
5043 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
5044 pp->snp_count = 0;
5045 profile_zero(&pp->sn_prl_total);
5046 profile_zero(&pp->sn_prl_self);
5047 ++si->sn_prl_ga.ga_len;
5048 }
5049 si->sn_prl_execed = FALSE;
5050 profile_start(&si->sn_prl_start);
5051 profile_zero(&si->sn_prl_children);
5052 profile_get_wait(&si->sn_prl_wait);
5053 }
5054}
5055
5056/*
5057 * Called when actually executing a function line.
5058 */
5059 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005060script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005061{
5062 scriptitem_T *si;
5063
5064 if (current_SID <= 0 || current_SID > script_items.ga_len)
5065 return;
5066 si = &SCRIPT_ITEM(current_SID);
5067 if (si->sn_prof_on && si->sn_prl_idx >= 0)
5068 si->sn_prl_execed = TRUE;
5069}
5070
5071/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02005072 * Called when done with a script line.
Bram Moolenaar05159a02005-02-26 23:04:13 +00005073 */
5074 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005075script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005076{
5077 scriptitem_T *si;
5078 sn_prl_T *pp;
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_idx < si->sn_prl_ga.ga_len)
5085 {
5086 if (si->sn_prl_execed)
5087 {
5088 pp = &PRL_ITEM(si, si->sn_prl_idx);
5089 ++pp->snp_count;
5090 profile_end(&si->sn_prl_start);
5091 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005092 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00005093 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
5094 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005095 }
5096 si->sn_prl_idx = -1;
5097 }
5098}
5099#endif
5100
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101/*
5102 * ":scriptencoding": Set encoding conversion for a sourced script.
5103 * Without the multi-byte feature it's simply ignored.
5104 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005105 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005106ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107{
5108#ifdef FEAT_MBYTE
5109 struct source_cookie *sp;
5110 char_u *name;
5111
5112 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
5113 {
5114 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
5115 return;
5116 }
5117
5118 if (*eap->arg != NUL)
5119 {
5120 name = enc_canonize(eap->arg);
5121 if (name == NULL) /* out of memory */
5122 return;
5123 }
5124 else
5125 name = eap->arg;
5126
5127 /* Setup for conversion from the specified encoding to 'encoding'. */
5128 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
5129 convert_setup(&sp->conv, name, p_enc);
5130
5131 if (name != eap->arg)
5132 vim_free(name);
5133#endif
5134}
5135
5136#if defined(FEAT_EVAL) || defined(PROTO)
5137/*
5138 * ":finish": Mark a sourced file as finished.
5139 */
5140 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005141ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142{
5143 if (getline_equal(eap->getline, eap->cookie, getsourceline))
5144 do_finish(eap, FALSE);
5145 else
5146 EMSG(_("E168: :finish used outside of a sourced file"));
5147}
5148
5149/*
5150 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
5151 * Also called for a pending finish at the ":endtry" or after returning from
5152 * an extra do_cmdline(). "reanimate" is used in the latter case.
5153 */
5154 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005155do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156{
5157 int idx;
5158
5159 if (reanimate)
5160 ((struct source_cookie *)getline_cookie(eap->getline,
5161 eap->cookie))->finished = FALSE;
5162
5163 /*
5164 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5165 * not in its finally clause (which then is to be executed next) is found.
5166 * In this case, make the ":finish" pending for execution at the ":endtry".
5167 * Otherwise, finish normally.
5168 */
5169 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5170 if (idx >= 0)
5171 {
5172 eap->cstack->cs_pending[idx] = CSTP_FINISH;
5173 report_make_pending(CSTP_FINISH, NULL);
5174 }
5175 else
5176 ((struct source_cookie *)getline_cookie(eap->getline,
5177 eap->cookie))->finished = TRUE;
5178}
5179
5180
5181/*
5182 * Return TRUE when a sourced file had the ":finish" command: Don't give error
5183 * message for missing ":endif".
5184 * Return FALSE when not sourcing a file.
5185 */
5186 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005187source_finished(
5188 char_u *(*fgetline)(int, void *, int),
5189 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005190{
Bram Moolenaar89d40322006-08-29 15:30:07 +00005191 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00005193 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194}
5195#endif
5196
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197/*
5198 * ":checktime [buffer]"
5199 */
5200 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005201ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202{
5203 buf_T *buf;
5204 int save_no_check_timestamps = no_check_timestamps;
5205
5206 no_check_timestamps = 0;
5207 if (eap->addr_count == 0) /* default is all buffers */
5208 check_timestamps(FALSE);
5209 else
5210 {
5211 buf = buflist_findnr((int)eap->line2);
5212 if (buf != NULL) /* cannot happen? */
5213 (void)buf_check_timestamp(buf, FALSE);
5214 }
5215 no_check_timestamps = save_no_check_timestamps;
5216}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217
Bram Moolenaar071d4272004-06-13 20:20:40 +00005218#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5219 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005220# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005221static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005223 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005224get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005225{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005226 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005227
Bram Moolenaar48e330a2016-02-23 14:53:34 +01005228 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005229 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005230
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005231# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 if (loc != NULL)
5233 {
5234 char_u *p;
5235
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005236 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
5237 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 p = vim_strchr(loc, '=');
5239 if (p != NULL)
5240 {
5241 loc = ++p;
5242 while (*p != NUL) /* remove trailing newline */
5243 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005244 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 {
5246 *p = NUL;
5247 break;
5248 }
5249 ++p;
5250 }
5251 }
5252 }
5253# endif
5254
5255 return loc;
5256}
5257#endif
5258
5259
5260#ifdef WIN32
5261/*
5262 * On MS-Windows locale names are strings like "German_Germany.1252", but
5263 * gettext expects "de". Try to translate one into another here for a few
5264 * supported languages.
5265 */
5266 static char_u *
5267gettext_lang(char_u *name)
5268{
5269 int i;
5270 static char *(mtable[]) = {
5271 "afrikaans", "af",
5272 "czech", "cs",
5273 "dutch", "nl",
5274 "german", "de",
5275 "english_united kingdom", "en_GB",
5276 "spanish", "es",
5277 "french", "fr",
5278 "italian", "it",
5279 "japanese", "ja",
5280 "korean", "ko",
5281 "norwegian", "no",
5282 "polish", "pl",
5283 "russian", "ru",
5284 "slovak", "sk",
5285 "swedish", "sv",
5286 "ukrainian", "uk",
5287 "chinese_china", "zh_CN",
5288 "chinese_taiwan", "zh_TW",
5289 NULL};
5290
5291 for (i = 0; mtable[i] != NULL; i += 2)
5292 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005293 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005294 return name;
5295}
5296#endif
5297
5298#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5299/*
5300 * Obtain the current messages language. Used to set the default for
5301 * 'helplang'. May return NULL or an empty string.
5302 */
5303 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005304get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005305{
5306 char_u *p;
5307
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005308# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005310 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311# else
5312 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005313 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
5314 * and LC_MONETARY may be set differently for a Japanese working in the
5315 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005316 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005317# endif
5318# else
5319 p = mch_getenv((char_u *)"LC_ALL");
5320 if (p == NULL || *p == NUL)
5321 {
5322 p = mch_getenv((char_u *)"LC_MESSAGES");
5323 if (p == NULL || *p == NUL)
5324 p = mch_getenv((char_u *)"LANG");
5325 }
5326# endif
5327# ifdef WIN32
5328 p = gettext_lang(p);
5329# endif
5330 return p;
5331}
5332#endif
5333
Bram Moolenaardef9e822004-12-31 20:58:58 +00005334/* Complicated #if; matches with where get_mess_env() is used below. */
5335#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5336 && defined(LC_MESSAGES))) \
5337 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5338 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
5339 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01005340static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341
5342/*
5343 * Get the language used for messages from the environment.
5344 */
5345 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005346get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005347{
5348 char_u *p;
5349
5350 p = mch_getenv((char_u *)"LC_ALL");
5351 if (p == NULL || *p == NUL)
5352 {
5353 p = mch_getenv((char_u *)"LC_MESSAGES");
5354 if (p == NULL || *p == NUL)
5355 {
5356 p = mch_getenv((char_u *)"LANG");
5357 if (p != NULL && VIM_ISDIGIT(*p))
5358 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005359# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005361 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362# endif
5363 }
5364 }
5365 return p;
5366}
5367#endif
5368
5369#if defined(FEAT_EVAL) || defined(PROTO)
5370
5371/*
5372 * Set the "v:lang" variable according to the current locale setting.
5373 * Also do "v:lc_time"and "v:ctype".
5374 */
5375 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005376set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377{
5378 char_u *loc;
5379
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005380# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005381 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382# else
5383 /* setlocale() not supported: use the default value */
5384 loc = (char_u *)"C";
5385# endif
5386 set_vim_var_string(VV_CTYPE, loc, -1);
5387
5388 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
5389 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005390# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005391 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392# else
5393 loc = get_mess_env();
5394# endif
5395 set_vim_var_string(VV_LANG, loc, -1);
5396
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005397# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005398 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399# endif
5400 set_vim_var_string(VV_LC_TIME, loc, -1);
5401}
5402#endif
5403
5404#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5405 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
5406/*
5407 * ":language": Set the language (locale).
5408 */
5409 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005410ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005411{
5412 char *loc;
5413 char_u *p;
5414 char_u *name;
5415 int what = LC_ALL;
5416 char *whatstr = "";
5417#ifdef LC_MESSAGES
5418# define VIM_LC_MESSAGES LC_MESSAGES
5419#else
5420# define VIM_LC_MESSAGES 6789
5421#endif
5422
5423 name = eap->arg;
5424
5425 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
5426 * Allow abbreviation, but require at least 3 characters to avoid
5427 * confusion with a two letter language name "me" or "ct". */
5428 p = skiptowhite(eap->arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005429 if ((*p == NUL || VIM_ISWHITE(*p)) && p - eap->arg >= 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005430 {
5431 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
5432 {
5433 what = VIM_LC_MESSAGES;
5434 name = skipwhite(p);
5435 whatstr = "messages ";
5436 }
5437 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
5438 {
5439 what = LC_CTYPE;
5440 name = skipwhite(p);
5441 whatstr = "ctype ";
5442 }
5443 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
5444 {
5445 what = LC_TIME;
5446 name = skipwhite(p);
5447 whatstr = "time ";
5448 }
5449 }
5450
5451 if (*name == NUL)
5452 {
5453#ifndef LC_MESSAGES
5454 if (what == VIM_LC_MESSAGES)
5455 p = get_mess_env();
5456 else
5457#endif
5458 p = (char_u *)setlocale(what, NULL);
5459 if (p == NULL || *p == NUL)
5460 p = (char_u *)"Unknown";
5461 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
5462 }
5463 else
5464 {
5465#ifndef LC_MESSAGES
5466 if (what == VIM_LC_MESSAGES)
5467 loc = "";
5468 else
5469#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005470 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005472#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
5473 /* Make sure strtod() uses a decimal point, not a comma. */
5474 setlocale(LC_NUMERIC, "C");
5475#endif
5476 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005477 if (loc == NULL)
5478 EMSG2(_("E197: Cannot set language to \"%s\""), name);
5479 else
5480 {
5481#ifdef HAVE_NL_MSG_CAT_CNTR
5482 /* Need to do this for GNU gettext, otherwise cached translations
5483 * will be used again. */
5484 extern int _nl_msg_cat_cntr;
5485
5486 ++_nl_msg_cat_cntr;
5487#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00005488 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
5490
5491 if (what != LC_TIME)
5492 {
5493 /* Tell gettext() what to translate to. It apparently doesn't
5494 * use the currently effective locale. Also do this when
5495 * FEAT_GETTEXT isn't defined, so that shell commands use this
5496 * value. */
5497 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005498 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02005500
5501 /* Clear $LANGUAGE because GNU gettext uses it. */
5502 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005503# ifdef WIN32
5504 /* Apparently MS-Windows printf() may cause a crash when
5505 * we give it 8-bit text while it's expecting text in the
5506 * current locale. This call avoids that. */
5507 setlocale(LC_CTYPE, "C");
5508# endif
5509 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 if (what != LC_CTYPE)
5511 {
5512 char_u *mname;
5513#ifdef WIN32
5514 mname = gettext_lang(name);
5515#else
5516 mname = name;
5517#endif
5518 vim_setenv((char_u *)"LC_MESSAGES", mname);
5519#ifdef FEAT_MULTI_LANG
5520 set_helplang_default(mname);
5521#endif
5522 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523 }
5524
5525# ifdef FEAT_EVAL
5526 /* Set v:lang, v:lc_time and v:ctype to the final result. */
5527 set_lang_var();
5528# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02005529# ifdef FEAT_TITLE
5530 maketitle();
5531# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 }
5533 }
5534}
5535
5536# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005537
5538static char_u **locales = NULL; /* Array of all available locales */
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005539
5540# ifndef WIN32
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005541static int did_init_locales = FALSE;
5542
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005543/* Return an array of strings for all available locales + NULL for the
5544 * last element. Return NULL in case of error. */
5545 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005546find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005547{
5548 garray_T locales_ga;
5549 char_u *loc;
5550
5551 /* Find all available locales by running command "locale -a". If this
5552 * doesn't work we won't have completion. */
5553 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02005554 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005555 if (locale_a == NULL)
5556 return NULL;
5557 ga_init2(&locales_ga, sizeof(char_u *), 20);
5558
5559 /* Transform locale_a string where each locale is separated by "\n"
5560 * into an array of locale strings. */
5561 loc = (char_u *)strtok((char *)locale_a, "\n");
5562
5563 while (loc != NULL)
5564 {
5565 if (ga_grow(&locales_ga, 1) == FAIL)
5566 break;
5567 loc = vim_strsave(loc);
5568 if (loc == NULL)
5569 break;
5570
5571 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5572 loc = (char_u *)strtok(NULL, "\n");
5573 }
5574 vim_free(locale_a);
5575 if (ga_grow(&locales_ga, 1) == FAIL)
5576 {
5577 ga_clear(&locales_ga);
5578 return NULL;
5579 }
5580 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5581 return (char_u **)locales_ga.ga_data;
5582}
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005583# endif
5584
5585/*
5586 * Lazy initialization of all available locales.
5587 */
5588 static void
5589init_locales(void)
5590{
5591# ifndef WIN32
5592 if (!did_init_locales)
5593 {
5594 did_init_locales = TRUE;
5595 locales = find_locales();
5596 }
5597# endif
5598}
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005599
5600# if defined(EXITFREE) || defined(PROTO)
5601 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005602free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005603{
5604 int i;
5605 if (locales != NULL)
5606 {
5607 for (i = 0; locales[i] != NULL; i++)
5608 vim_free(locales[i]);
Bram Moolenaard23a8232018-02-10 18:45:26 +01005609 VIM_CLEAR(locales);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005610 }
5611}
5612# endif
5613
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614/*
5615 * Function given to ExpandGeneric() to obtain the possible arguments of the
5616 * ":language" command.
5617 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005619get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005620{
5621 if (idx == 0)
5622 return (char_u *)"messages";
5623 if (idx == 1)
5624 return (char_u *)"ctype";
5625 if (idx == 2)
5626 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005627
5628 init_locales();
5629 if (locales == NULL)
5630 return NULL;
5631 return locales[idx - 3];
5632}
5633
5634/*
5635 * Function given to ExpandGeneric() to obtain the available locales.
5636 */
5637 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005638get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005639{
5640 init_locales();
5641 if (locales == NULL)
5642 return NULL;
5643 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644}
5645# endif
5646
5647#endif