blob: 5f58fedfb70b459c333f111cf040da4fe991040e [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 Moolenaar56bc8e22018-05-10 18:05:56 +02001209 long
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001210proftime_time_left(proftime_T *due, proftime_T *now)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001211{
1212# ifdef WIN3264
1213 LARGE_INTEGER fr;
1214
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001215 if (now->QuadPart > due->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001216 return 0;
1217 QueryPerformanceFrequency(&fr);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001218 return (long)(((double)(due->QuadPart - now->QuadPart)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001219 / (double)fr.QuadPart) * 1000);
1220# else
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001221 if (now->tv_sec > due->tv_sec)
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001222 return 0;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001223 return (due->tv_sec - now->tv_sec) * 1000
1224 + (due->tv_usec - now->tv_usec) / 1000;
Bram Moolenaara8e93d62017-09-18 21:50:47 +02001225# endif
1226}
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001227
Bram Moolenaar975b5272016-03-15 23:10:59 +01001228/*
1229 * Insert a timer in the list of timers.
1230 */
1231 static void
1232insert_timer(timer_T *timer)
1233{
1234 timer->tr_next = first_timer;
1235 timer->tr_prev = NULL;
1236 if (first_timer != NULL)
1237 first_timer->tr_prev = timer;
1238 first_timer = timer;
Bram Moolenaar4231da42016-06-02 14:30:04 +02001239 did_add_timer = TRUE;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001240}
1241
1242/*
1243 * Take a timer out of the list of timers.
1244 */
1245 static void
1246remove_timer(timer_T *timer)
1247{
1248 if (timer->tr_prev == NULL)
1249 first_timer = timer->tr_next;
1250 else
1251 timer->tr_prev->tr_next = timer->tr_next;
1252 if (timer->tr_next != NULL)
1253 timer->tr_next->tr_prev = timer->tr_prev;
1254}
1255
1256 static void
1257free_timer(timer_T *timer)
1258{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001259 free_callback(timer->tr_callback, timer->tr_partial);
1260 vim_free(timer);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001261}
1262
1263/*
1264 * Create a timer and return it. NULL if out of memory.
1265 * Caller should set the callback.
1266 */
1267 timer_T *
1268create_timer(long msec, int repeat)
1269{
1270 timer_T *timer = (timer_T *)alloc_clear(sizeof(timer_T));
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001271 long prev_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001272
1273 if (timer == NULL)
1274 return NULL;
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001275 if (++last_timer_id <= prev_id)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001276 /* Overflow! Might cause duplicates... */
1277 last_timer_id = 0;
1278 timer->tr_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001279 insert_timer(timer);
1280 if (repeat != 0)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001281 timer->tr_repeat = repeat - 1;
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001282 timer->tr_interval = msec;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001283
1284 profile_setlimit(msec, &timer->tr_due);
1285 return timer;
1286}
1287
1288/*
1289 * Invoke the callback of "timer".
1290 */
1291 static void
1292timer_callback(timer_T *timer)
1293{
1294 typval_T rettv;
1295 int dummy;
1296 typval_T argv[2];
1297
1298 argv[0].v_type = VAR_NUMBER;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001299 argv[0].vval.v_number = (varnumber_T)timer->tr_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001300 argv[1].v_type = VAR_UNKNOWN;
1301
1302 call_func(timer->tr_callback, (int)STRLEN(timer->tr_callback),
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001303 &rettv, 1, argv, NULL, 0L, 0L, &dummy, TRUE,
Bram Moolenaar975b5272016-03-15 23:10:59 +01001304 timer->tr_partial, NULL);
1305 clear_tv(&rettv);
1306}
1307
1308/*
1309 * Call timers that are due.
1310 * Return the time in msec until the next timer is due.
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001311 * Returns -1 if there are no pending timers.
Bram Moolenaar975b5272016-03-15 23:10:59 +01001312 */
1313 long
Bram Moolenaarcf089462016-06-12 21:18:43 +02001314check_due_timer(void)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001315{
1316 timer_T *timer;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001317 timer_T *timer_next;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001318 long this_due;
Bram Moolenaar597385a2016-03-16 23:24:43 +01001319 long next_due = -1;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001320 proftime_T now;
1321 int did_one = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001322 int need_update_screen = FALSE;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001323 long current_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001324
Bram Moolenaarc577d812017-07-08 22:37:34 +02001325 /* Don't run any timers while exiting or dealing with an error. */
1326 if (exiting || aborting())
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001327 return next_due;
1328
Bram Moolenaar75537a92016-09-05 22:45:28 +02001329 profile_start(&now);
1330 for (timer = first_timer; timer != NULL && !got_int; timer = timer_next)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001331 {
Bram Moolenaar75537a92016-09-05 22:45:28 +02001332 timer_next = timer->tr_next;
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001333
Bram Moolenaar75537a92016-09-05 22:45:28 +02001334 if (timer->tr_id == -1 || timer->tr_firing || timer->tr_paused)
1335 continue;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001336 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001337 if (this_due <= 1)
1338 {
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02001339 /* Save and restore a lot of flags, because the timer fires while
1340 * waiting for a character, which might be halfway a command. */
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001341 int save_timer_busy = timer_busy;
1342 int save_vgetc_busy = vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001343 int save_did_emsg = did_emsg;
1344 int save_called_emsg = called_emsg;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001345 int save_must_redraw = must_redraw;
Bram Moolenaare723c422017-09-06 23:40:10 +02001346 int save_trylevel = trylevel;
1347 int save_did_throw = did_throw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001348 int save_ex_pressedreturn = get_pressedreturn();
Bram Moolenaare723c422017-09-06 23:40:10 +02001349 except_T *save_current_exception = current_exception;
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02001350 vimvars_save_T vvsave;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001351
Bram Moolenaare723c422017-09-06 23:40:10 +02001352 /* Create a scope for running the timer callback, ignoring most of
1353 * the current scope, such as being inside a try/catch. */
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001354 timer_busy = timer_busy > 0 || vgetc_busy > 0;
1355 vgetc_busy = 0;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001356 called_emsg = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001357 did_emsg = FALSE;
1358 did_uncaught_emsg = FALSE;
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001359 must_redraw = 0;
Bram Moolenaare723c422017-09-06 23:40:10 +02001360 trylevel = 0;
1361 did_throw = FALSE;
1362 current_exception = NULL;
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02001363 save_vimvars(&vvsave);
Bram Moolenaare723c422017-09-06 23:40:10 +02001364
Bram Moolenaar75537a92016-09-05 22:45:28 +02001365 timer->tr_firing = TRUE;
1366 timer_callback(timer);
1367 timer->tr_firing = FALSE;
Bram Moolenaare723c422017-09-06 23:40:10 +02001368
Bram Moolenaar75537a92016-09-05 22:45:28 +02001369 timer_next = timer->tr_next;
1370 did_one = TRUE;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001371 timer_busy = save_timer_busy;
1372 vgetc_busy = save_vgetc_busy;
Bram Moolenaare723c422017-09-06 23:40:10 +02001373 if (did_uncaught_emsg)
Bram Moolenaarc577d812017-07-08 22:37:34 +02001374 ++timer->tr_emsg_count;
Bram Moolenaare723c422017-09-06 23:40:10 +02001375 did_emsg = save_did_emsg;
1376 called_emsg = save_called_emsg;
1377 trylevel = save_trylevel;
1378 did_throw = save_did_throw;
1379 current_exception = save_current_exception;
Bram Moolenaarb0f42ba2018-05-12 15:38:26 +02001380 restore_vimvars(&vvsave);
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001381 if (must_redraw != 0)
1382 need_update_screen = TRUE;
1383 must_redraw = must_redraw > save_must_redraw
1384 ? must_redraw : save_must_redraw;
Bram Moolenaarf5291f32017-09-14 22:55:37 +02001385 set_pressedreturn(save_ex_pressedreturn);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001386
1387 /* Only fire the timer again if it repeats and stop_timer() wasn't
1388 * called while inside the callback (tr_id == -1). */
Bram Moolenaarc577d812017-07-08 22:37:34 +02001389 if (timer->tr_repeat != 0 && timer->tr_id != -1
1390 && timer->tr_emsg_count < 3)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001391 {
1392 profile_setlimit(timer->tr_interval, &timer->tr_due);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001393 this_due = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar75537a92016-09-05 22:45:28 +02001394 if (this_due < 1)
1395 this_due = 1;
1396 if (timer->tr_repeat > 0)
1397 --timer->tr_repeat;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001398 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001399 else
1400 {
1401 this_due = -1;
1402 remove_timer(timer);
1403 free_timer(timer);
1404 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001405 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001406 if (this_due > 0 && (next_due == -1 || next_due > this_due))
1407 next_due = this_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001408 }
1409
1410 if (did_one)
Bram Moolenaar02e177d2017-08-26 23:43:28 +02001411 redraw_after_callback(need_update_screen);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001412
Bram Moolenaarc3719bd2017-11-18 22:13:31 +01001413#ifdef FEAT_BEVAL_TERM
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001414 if (bevalexpr_due_set)
1415 {
1416 this_due = proftime_time_left(&bevalexpr_due, &now);
1417 if (this_due <= 1)
1418 {
1419 bevalexpr_due_set = FALSE;
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001420 if (balloonEval == NULL)
1421 {
Bram Moolenaarca4b6132018-06-28 12:05:11 +02001422 balloonEval = (BalloonEval *)alloc_clear(sizeof(BalloonEval));
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001423 balloonEvalForTerm = TRUE;
1424 }
1425 if (balloonEval != NULL)
1426 general_beval_cb(balloonEval, 0);
1427 }
Bram Moolenaar1c17ffa2018-04-24 15:19:04 +02001428 else if (next_due == -1 || next_due > this_due)
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001429 next_due = this_due;
1430 }
1431#endif
Bram Moolenaar56bc8e22018-05-10 18:05:56 +02001432#ifdef FEAT_TERMINAL
1433 /* Some terminal windows may need their buffer updated. */
1434 next_due = term_check_timers(next_due, &now);
1435#endif
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001436
Bram Moolenaar75537a92016-09-05 22:45:28 +02001437 return current_id != last_timer_id ? 1 : next_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001438}
1439
1440/*
1441 * Find a timer by ID. Returns NULL if not found;
1442 */
1443 timer_T *
Bram Moolenaar75537a92016-09-05 22:45:28 +02001444find_timer(long id)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001445{
1446 timer_T *timer;
1447
Bram Moolenaar75537a92016-09-05 22:45:28 +02001448 if (id >= 0)
1449 {
1450 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1451 if (timer->tr_id == id)
1452 return timer;
1453 }
1454 return NULL;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001455}
1456
1457
1458/*
1459 * Stop a timer and delete it.
1460 */
1461 void
1462stop_timer(timer_T *timer)
1463{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001464 if (timer->tr_firing)
1465 /* Free the timer after the callback returns. */
1466 timer->tr_id = -1;
1467 else
1468 {
1469 remove_timer(timer);
1470 free_timer(timer);
1471 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001472}
Bram Moolenaare3188e22016-05-31 21:13:04 +02001473
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001474 void
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001475stop_all_timers(void)
1476{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001477 timer_T *timer;
1478 timer_T *timer_next;
1479
1480 for (timer = first_timer; timer != NULL; timer = timer_next)
1481 {
1482 timer_next = timer->tr_next;
1483 stop_timer(timer);
1484 }
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001485}
1486
1487 void
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001488add_timer_info(typval_T *rettv, timer_T *timer)
1489{
1490 list_T *list = rettv->vval.v_list;
1491 dict_T *dict = dict_alloc();
1492 dictitem_T *di;
1493 long remaining;
1494 proftime_T now;
1495
1496 if (dict == NULL)
1497 return;
1498 list_append_dict(list, dict);
1499
Bram Moolenaar75537a92016-09-05 22:45:28 +02001500 dict_add_nr_str(dict, "id", timer->tr_id, NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001501 dict_add_nr_str(dict, "time", (long)timer->tr_interval, NULL);
1502
1503 profile_start(&now);
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001504 remaining = proftime_time_left(&timer->tr_due, &now);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001505 dict_add_nr_str(dict, "remaining", (long)remaining, NULL);
1506
1507 dict_add_nr_str(dict, "repeat",
1508 (long)(timer->tr_repeat < 0 ? -1 : timer->tr_repeat + 1), NULL);
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001509 dict_add_nr_str(dict, "paused", (long)(timer->tr_paused), NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001510
1511 di = dictitem_alloc((char_u *)"callback");
1512 if (di != NULL)
1513 {
1514 if (dict_add(dict, di) == FAIL)
1515 vim_free(di);
1516 else if (timer->tr_partial != NULL)
1517 {
1518 di->di_tv.v_type = VAR_PARTIAL;
1519 di->di_tv.vval.v_partial = timer->tr_partial;
1520 ++timer->tr_partial->pt_refcount;
1521 }
1522 else
1523 {
1524 di->di_tv.v_type = VAR_FUNC;
1525 di->di_tv.vval.v_string = vim_strsave(timer->tr_callback);
1526 }
1527 di->di_tv.v_lock = 0;
1528 }
1529}
1530
1531 void
1532add_timer_info_all(typval_T *rettv)
1533{
1534 timer_T *timer;
1535
1536 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001537 if (timer->tr_id != -1)
1538 add_timer_info(rettv, timer);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001539}
1540
Bram Moolenaare3188e22016-05-31 21:13:04 +02001541/*
1542 * Mark references in partials of timers.
1543 */
1544 int
1545set_ref_in_timer(int copyID)
1546{
1547 int abort = FALSE;
1548 timer_T *timer;
1549 typval_T tv;
1550
1551 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1552 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001553 if (timer->tr_partial != NULL)
1554 {
1555 tv.v_type = VAR_PARTIAL;
1556 tv.vval.v_partial = timer->tr_partial;
1557 }
1558 else
1559 {
1560 tv.v_type = VAR_FUNC;
1561 tv.vval.v_string = timer->tr_callback;
1562 }
Bram Moolenaare3188e22016-05-31 21:13:04 +02001563 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
1564 }
1565 return abort;
1566}
Bram Moolenaar623e2632016-07-30 22:47:56 +02001567
1568# if defined(EXITFREE) || defined(PROTO)
1569 void
1570timer_free_all()
1571{
1572 timer_T *timer;
1573
1574 while (first_timer != NULL)
1575 {
1576 timer = first_timer;
1577 remove_timer(timer);
1578 free_timer(timer);
1579 }
1580}
1581# endif
Bram Moolenaar975b5272016-03-15 23:10:59 +01001582# endif
1583
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001584#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1585# if defined(HAVE_MATH_H)
1586# include <math.h>
1587# endif
1588
1589/*
1590 * Divide the time "tm" by "count" and store in "tm2".
1591 */
1592 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001593profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001594{
1595 if (count == 0)
1596 profile_zero(tm2);
1597 else
1598 {
1599# ifdef WIN3264
1600 tm2->QuadPart = tm->QuadPart / count;
1601# else
1602 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1603
1604 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001605 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001606# endif
1607 }
1608}
1609#endif
1610
Bram Moolenaar76929292008-01-06 19:07:36 +00001611# if defined(FEAT_PROFILE) || defined(PROTO)
1612/*
1613 * Functions for profiling.
1614 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001615static void script_do_profile(scriptitem_T *si);
1616static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001617static proftime_T prof_wait_time;
1618
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001619/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001620 * Add the time "tm2" to "tm".
1621 */
1622 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001623profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001624{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001625# ifdef WIN3264
1626 tm->QuadPart += tm2->QuadPart;
1627# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001628 tm->tv_usec += tm2->tv_usec;
1629 tm->tv_sec += tm2->tv_sec;
1630 if (tm->tv_usec >= 1000000)
1631 {
1632 tm->tv_usec -= 1000000;
1633 ++tm->tv_sec;
1634 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001635# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001636}
1637
1638/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001639 * Add the "self" time from the total time and the children's time.
1640 */
1641 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001642profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001643{
1644 /* Check that the result won't be negative. Can happen with recursive
1645 * calls. */
1646#ifdef WIN3264
1647 if (total->QuadPart <= children->QuadPart)
1648 return;
1649#else
1650 if (total->tv_sec < children->tv_sec
1651 || (total->tv_sec == children->tv_sec
1652 && total->tv_usec <= children->tv_usec))
1653 return;
1654#endif
1655 profile_add(self, total);
1656 profile_sub(self, children);
1657}
1658
1659/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001660 * Get the current waittime.
1661 */
1662 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001663profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001664{
1665 *tm = prof_wait_time;
1666}
1667
1668/*
1669 * Subtract the passed waittime since "tm" from "tma".
1670 */
1671 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001672profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001673{
1674 proftime_T tm3 = prof_wait_time;
1675
1676 profile_sub(&tm3, tm);
1677 profile_sub(tma, &tm3);
1678}
1679
1680/*
1681 * Return TRUE if "tm1" and "tm2" are equal.
1682 */
1683 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001684profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001685{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001686# ifdef WIN3264
1687 return (tm1->QuadPart == tm2->QuadPart);
1688# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001689 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001690# endif
1691}
1692
1693/*
1694 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1695 */
1696 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001697profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001698{
1699# ifdef WIN3264
1700 return (int)(tm2->QuadPart - tm1->QuadPart);
1701# else
1702 if (tm1->tv_sec == tm2->tv_sec)
1703 return tm2->tv_usec - tm1->tv_usec;
1704 return tm2->tv_sec - tm1->tv_sec;
1705# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001706}
1707
Bram Moolenaar05159a02005-02-26 23:04:13 +00001708static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001709static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001710
1711/*
1712 * ":profile cmd args"
1713 */
1714 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001715ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001716{
1717 char_u *e;
1718 int len;
1719
1720 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001721 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001722 e = skipwhite(e);
1723
1724 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1725 {
1726 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001727 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001728 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001729 profile_zero(&prof_wait_time);
1730 set_vim_var_nr(VV_PROFILING, 1L);
1731 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001732 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001733 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001734 else if (STRCMP(eap->arg, "pause") == 0)
1735 {
1736 if (do_profiling == PROF_YES)
1737 profile_start(&pause_time);
1738 do_profiling = PROF_PAUSED;
1739 }
1740 else if (STRCMP(eap->arg, "continue") == 0)
1741 {
1742 if (do_profiling == PROF_PAUSED)
1743 {
1744 profile_end(&pause_time);
1745 profile_add(&prof_wait_time, &pause_time);
1746 }
1747 do_profiling = PROF_YES;
1748 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001749 else
1750 {
1751 /* The rest is similar to ":breakadd". */
1752 ex_breakadd(eap);
1753 }
1754}
1755
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001756/* Command line expansion for :profile. */
1757static enum
1758{
1759 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001760 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001761} pexpand_what;
1762
1763static char *pexpand_cmds[] = {
1764 "start",
1765#define PROFCMD_START 0
1766 "pause",
1767#define PROFCMD_PAUSE 1
1768 "continue",
1769#define PROFCMD_CONTINUE 2
1770 "func",
1771#define PROFCMD_FUNC 3
1772 "file",
1773#define PROFCMD_FILE 4
1774 NULL
1775#define PROFCMD_LAST 5
1776};
1777
1778/*
1779 * Function given to ExpandGeneric() to obtain the profile command
1780 * specific expansion.
1781 */
1782 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001783get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001784{
1785 switch (pexpand_what)
1786 {
1787 case PEXP_SUBCMD:
1788 return (char_u *)pexpand_cmds[idx];
1789 /* case PEXP_FUNC: TODO */
1790 default:
1791 return NULL;
1792 }
1793}
1794
1795/*
1796 * Handle command line completion for :profile command.
1797 */
1798 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001799set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001800{
1801 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001802
1803 /* Default: expand subcommands. */
1804 xp->xp_context = EXPAND_PROFILE;
1805 pexpand_what = PEXP_SUBCMD;
1806 xp->xp_pattern = arg;
1807
1808 end_subcmd = skiptowhite(arg);
1809 if (*end_subcmd == NUL)
1810 return;
1811
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001812 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001813 {
1814 xp->xp_context = EXPAND_FILES;
1815 xp->xp_pattern = skipwhite(end_subcmd);
1816 return;
1817 }
1818
1819 /* TODO: expand function names after "func" */
1820 xp->xp_context = EXPAND_NOTHING;
1821}
1822
Bram Moolenaar05159a02005-02-26 23:04:13 +00001823/*
1824 * Dump the profiling info.
1825 */
1826 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001827profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001828{
1829 FILE *fd;
1830
1831 if (profile_fname != NULL)
1832 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001833 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001834 if (fd == NULL)
1835 EMSG2(_(e_notopen), profile_fname);
1836 else
1837 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001838 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001839 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001840 fclose(fd);
1841 }
1842 }
1843}
1844
1845/*
1846 * Start profiling script "fp".
1847 */
1848 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001849script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001850{
1851 si->sn_pr_count = 0;
1852 profile_zero(&si->sn_pr_total);
1853 profile_zero(&si->sn_pr_self);
1854
1855 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1856 si->sn_prl_idx = -1;
1857 si->sn_prof_on = TRUE;
1858 si->sn_pr_nest = 0;
1859}
1860
1861/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02001862 * Save time when starting to invoke another script or function.
Bram Moolenaar05159a02005-02-26 23:04:13 +00001863 */
1864 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001865script_prof_save(
1866 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001867{
1868 scriptitem_T *si;
1869
1870 if (current_SID > 0 && current_SID <= script_items.ga_len)
1871 {
1872 si = &SCRIPT_ITEM(current_SID);
1873 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1874 profile_start(&si->sn_pr_child);
1875 }
1876 profile_get_wait(tm);
1877}
1878
1879/*
1880 * Count time spent in children after invoking another script or function.
1881 */
1882 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001883script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001884{
1885 scriptitem_T *si;
1886
1887 if (current_SID > 0 && current_SID <= script_items.ga_len)
1888 {
1889 si = &SCRIPT_ITEM(current_SID);
1890 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1891 {
1892 profile_end(&si->sn_pr_child);
1893 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1894 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1895 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1896 }
1897 }
1898}
1899
1900static proftime_T inchar_time;
1901
1902/*
1903 * Called when starting to wait for the user to type a character.
1904 */
1905 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001906prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001907{
1908 profile_start(&inchar_time);
1909}
1910
1911/*
1912 * Called when finished waiting for the user to type a character.
1913 */
1914 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001915prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001916{
1917 profile_end(&inchar_time);
1918 profile_add(&prof_wait_time, &inchar_time);
1919}
1920
1921/*
1922 * Dump the profiling results for all scripts in file "fd".
1923 */
1924 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001925script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001926{
1927 int id;
1928 scriptitem_T *si;
1929 int i;
1930 FILE *sfd;
1931 sn_prl_T *pp;
1932
1933 for (id = 1; id <= script_items.ga_len; ++id)
1934 {
1935 si = &SCRIPT_ITEM(id);
1936 if (si->sn_prof_on)
1937 {
1938 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1939 if (si->sn_pr_count == 1)
1940 fprintf(fd, "Sourced 1 time\n");
1941 else
1942 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1943 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1944 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1945 fprintf(fd, "\n");
1946 fprintf(fd, "count total (s) self (s)\n");
1947
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001948 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001949 if (sfd == NULL)
1950 fprintf(fd, "Cannot open file!\n");
1951 else
1952 {
Bram Moolenaar67435d92017-10-19 21:04:37 +02001953 /* Keep going till the end of file, so that trailing
1954 * continuation lines are listed. */
1955 for (i = 0; ; ++i)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001956 {
1957 if (vim_fgets(IObuff, IOSIZE, sfd))
1958 break;
Bram Moolenaarac112f02017-12-05 16:46:28 +01001959 /* When a line has been truncated, append NL, taking care
1960 * of multi-byte characters . */
1961 if (IObuff[IOSIZE - 2] != NUL && IObuff[IOSIZE - 2] != NL)
1962 {
1963 int n = IOSIZE - 2;
1964# ifdef FEAT_MBYTE
1965 if (enc_utf8)
1966 {
1967 /* Move to the first byte of this char.
1968 * utf_head_off() doesn't work, because it checks
1969 * for a truncated character. */
1970 while (n > 0 && (IObuff[n] & 0xc0) == 0x80)
1971 --n;
1972 }
1973 else if (has_mbyte)
1974 n -= mb_head_off(IObuff, IObuff + n);
1975# endif
1976 IObuff[n] = NL;
1977 IObuff[n + 1] = NUL;
1978 }
Bram Moolenaar67435d92017-10-19 21:04:37 +02001979 if (i < si->sn_prl_ga.ga_len
1980 && (pp = &PRL_ITEM(si, i))->snp_count > 0)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001981 {
1982 fprintf(fd, "%5d ", pp->snp_count);
1983 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1984 fprintf(fd, " ");
1985 else
1986 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1987 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1988 }
1989 else
1990 fprintf(fd, " ");
1991 fprintf(fd, "%s", IObuff);
1992 }
1993 fclose(sfd);
1994 }
1995 fprintf(fd, "\n");
1996 }
1997 }
1998}
1999
2000/*
2001 * Return TRUE when a function defined in the current script should be
2002 * profiled.
2003 */
2004 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002005prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00002006{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00002007 if (current_SID > 0)
2008 return SCRIPT_ITEM(current_SID).sn_pr_force;
2009 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00002010}
2011
2012# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013#endif
2014
2015/*
2016 * If 'autowrite' option set, try to write the file.
2017 * Careful: autocommands may make "buf" invalid!
2018 *
2019 * return FAIL for failure, OK otherwise
2020 */
2021 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002022autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023{
Bram Moolenaar373154b2007-02-13 05:19:30 +00002024 int r;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002025 bufref_T bufref;
Bram Moolenaar373154b2007-02-13 05:19:30 +00002026
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 if (!(p_aw || p_awa) || !p_write
2028#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00002029 /* never autowrite a "nofile" or "nowrite" buffer */
2030 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00002032 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 return FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002034 set_bufref(&bufref, buf);
Bram Moolenaar373154b2007-02-13 05:19:30 +00002035 r = buf_write_all(buf, forceit);
2036
2037 /* Writing may succeed but the buffer still changed, e.g., when there is a
2038 * conversion error. We do want to return FAIL then. */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002039 if (bufref_valid(&bufref) && bufIsChanged(buf))
Bram Moolenaar373154b2007-02-13 05:19:30 +00002040 r = FAIL;
2041 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042}
2043
2044/*
2045 * flush all buffers, except the ones that are readonly
2046 */
2047 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002048autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049{
2050 buf_T *buf;
2051
2052 if (!(p_aw || p_awa) || !p_write)
2053 return;
Bram Moolenaar29323592016-07-24 22:04:11 +02002054 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 if (bufIsChanged(buf) && !buf->b_p_ro)
2056 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002057 bufref_T bufref;
2058
2059 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002060
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 (void)buf_write_all(buf, FALSE);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002062
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002064 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 buf = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066 }
2067}
2068
2069/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002070 * Return TRUE if buffer was changed and cannot be abandoned.
2071 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002074check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075{
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002076 int forceit = (flags & CCGD_FORCEIT);
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002077 bufref_T bufref;
2078
2079 set_bufref(&bufref, buf);
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002080
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081 if ( !forceit
2082 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002083 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
2084 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 {
2086#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2087 if ((p_confirm || cmdmod.confirm) && p_write)
2088 {
2089 buf_T *buf2;
2090 int count = 0;
2091
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002092 if (flags & CCGD_ALLBUF)
Bram Moolenaar29323592016-07-24 22:04:11 +02002093 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 if (bufIsChanged(buf2)
2095 && (buf2->b_ffname != NULL
2096# ifdef FEAT_BROWSE
2097 || cmdmod.browse
2098# endif
2099 ))
2100 ++count;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002101 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 /* Autocommand deleted buffer, oops! It's not changed now. */
2103 return FALSE;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002104
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 dialog_changed(buf, count > 1);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002106
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002107 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108 /* Autocommand deleted buffer, oops! It's not changed now. */
2109 return FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 return bufIsChanged(buf);
2111 }
2112#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002113 if (flags & CCGD_EXCMD)
Bram Moolenaarf5be7cd2017-08-17 16:55:13 +02002114 no_write_message();
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002115 else
Bram Moolenaar7a760922018-02-19 23:10:02 +01002116 no_write_message_nobang(curbuf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 return TRUE;
2118 }
2119 return FALSE;
2120}
2121
2122#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
2123
2124#if defined(FEAT_BROWSE) || defined(PROTO)
2125/*
2126 * When wanting to write a file without a file name, ask the user for a name.
2127 */
2128 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002129browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130{
2131 if (buf->b_fname == NULL)
2132 {
2133 char_u *fname;
2134
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002135 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
2136 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 if (fname != NULL)
2138 {
2139 if (setfname(buf, fname, NULL, TRUE) == OK)
2140 buf->b_flags |= BF_NOTEDITED;
2141 vim_free(fname);
2142 }
2143 }
2144}
2145#endif
2146
2147/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02002148 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 * Must check 'write' option first!
2150 */
2151 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002152dialog_changed(
2153 buf_T *buf,
2154 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155{
Bram Moolenaard9462e32011-04-11 21:35:11 +02002156 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 int ret;
2158 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02002159 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160
Bram Moolenaar3f9a1ff2017-08-21 22:06:02 +02002161 dialog_msg(buff, _("Save changes to \"%s\"?"), buf->b_fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002162 if (checkall)
2163 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
2164 else
2165 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
2166
Bram Moolenaar8218f602012-04-25 17:32:18 +02002167 /* Init ea pseudo-structure, this is needed for the check_overwrite()
2168 * function. */
2169 ea.append = ea.forceit = FALSE;
2170
Bram Moolenaar071d4272004-06-13 20:20:40 +00002171 if (ret == VIM_YES)
2172 {
2173#ifdef FEAT_BROWSE
2174 /* May get file name, when there is none */
2175 browse_save_fname(buf);
2176#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002177 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
2178 buf->b_fname, buf->b_ffname, FALSE) == OK)
2179 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 (void)buf_write_all(buf, FALSE);
2181 }
2182 else if (ret == VIM_NO)
2183 {
2184 unchanged(buf, TRUE);
2185 }
2186 else if (ret == VIM_ALL)
2187 {
2188 /*
2189 * Write all modified files that can be written.
2190 * Skip readonly buffers, these need to be confirmed
2191 * individually.
2192 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002193 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 {
2195 if (bufIsChanged(buf2)
2196 && (buf2->b_ffname != NULL
2197#ifdef FEAT_BROWSE
2198 || cmdmod.browse
2199#endif
2200 )
2201 && !buf2->b_p_ro)
2202 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002203 bufref_T bufref;
2204
2205 set_bufref(&bufref, buf2);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206#ifdef FEAT_BROWSE
2207 /* May get file name, when there is none */
2208 browse_save_fname(buf2);
2209#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002210 if (buf2->b_fname != NULL && check_overwrite(&ea, buf2,
2211 buf2->b_fname, buf2->b_ffname, FALSE) == OK)
2212 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 (void)buf_write_all(buf2, FALSE);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002214
Bram Moolenaar071d4272004-06-13 20:20:40 +00002215 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002216 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 buf2 = firstbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 }
2219 }
2220 }
2221 else if (ret == VIM_DISCARDALL)
2222 {
2223 /*
2224 * mark all buffers as unchanged
2225 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002226 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 unchanged(buf2, TRUE);
2228 }
2229}
2230#endif
2231
2232/*
2233 * Return TRUE if the buffer "buf" can be abandoned, either by making it
2234 * hidden, autowriting it or unloading it.
2235 */
2236 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002237can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238{
Bram Moolenaareb44a682017-08-03 22:44:55 +02002239 return ( buf_hide(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 || !bufIsChanged(buf)
2241 || buf->b_nwindows > 1
2242 || autowrite(buf, forceit) == OK
2243 || forceit);
2244}
2245
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002246static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002247
2248/*
2249 * Add a buffer number to "bufnrs", unless it's already there.
2250 */
2251 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002252add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002253{
2254 int i;
2255
2256 for (i = 0; i < *bufnump; ++i)
2257 if (bufnrs[i] == nr)
2258 return;
2259 bufnrs[*bufnump] = nr;
2260 *bufnump = *bufnump + 1;
2261}
2262
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263/*
2264 * Return TRUE if any buffer was changed and cannot be abandoned.
2265 * That changed buffer becomes the current buffer.
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002266 * When "unload" is TRUE the current buffer is unloaded instead of making it
Bram Moolenaar027387f2016-01-02 22:25:52 +01002267 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 */
2269 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002270check_changed_any(
2271 int hidden, /* Only check hidden buffers */
2272 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002273{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002274 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 buf_T *buf;
2276 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002277 int i;
2278 int bufnum = 0;
2279 int bufcount = 0;
2280 int *bufnrs;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002281 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 win_T *wp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002283
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002284 /* Make a list of all buffers, with the most important ones first. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002285 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002286 ++bufcount;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002288 if (bufcount == 0)
2289 return FALSE;
2290
2291 bufnrs = (int *)alloc(sizeof(int) * bufcount);
2292 if (bufnrs == NULL)
2293 return FALSE;
2294
2295 /* curbuf */
2296 bufnrs[bufnum++] = curbuf->b_fnum;
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002297
2298 /* buffers in current tab */
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002299 FOR_ALL_WINDOWS(wp)
2300 if (wp->w_buffer != curbuf)
2301 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2302
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002303 /* buffers in other tabs */
Bram Moolenaar29323592016-07-24 22:04:11 +02002304 FOR_ALL_TABPAGES(tp)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002305 if (tp != curtab)
2306 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
2307 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002308
2309 /* any other buffer */
Bram Moolenaar29323592016-07-24 22:04:11 +02002310 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002311 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
2312
2313 for (i = 0; i < bufnum; ++i)
2314 {
2315 buf = buflist_findnr(bufnrs[i]);
2316 if (buf == NULL)
2317 continue;
2318 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
2319 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002320 bufref_T bufref;
2321
2322 set_bufref(&bufref, buf);
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002323#ifdef FEAT_TERMINAL
2324 if (term_job_running(buf->b_term))
2325 {
2326 if (term_try_stop_job(buf) == FAIL)
2327 break;
2328 }
2329 else
2330#endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002331 /* Try auto-writing the buffer. If this fails but the buffer no
2332 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002333 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
2334 | CCGD_MULTWIN
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002335 | CCGD_ALLBUF) && bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002336 break; /* didn't save - still changes */
2337 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338 }
2339
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002340 if (i >= bufnum)
2341 goto theend;
2342
Bram Moolenaar25cdd9c2018-03-10 20:28:12 +01002343 /* Get here if "buf" cannot be abandoned. */
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002344 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 exiting = FALSE;
2346#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2347 /*
2348 * When ":confirm" used, don't give an error message.
2349 */
2350 if (!(p_confirm || cmdmod.confirm))
2351#endif
2352 {
2353 /* There must be a wait_return for this message, do_buffer()
2354 * may cause a redraw. But wait_return() is a no-op when vgetc()
2355 * is busy (Quit used from window menu), then make sure we don't
2356 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00002357 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 {
2359 msg_row = cmdline_row;
2360 msg_col = 0;
2361 msg_didout = FALSE;
2362 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002363 if (
2364#ifdef FEAT_TERMINAL
2365 term_job_running(buf->b_term)
2366 ? EMSG2(_("E947: Job still running in buffer \"%s\""),
2367 buf->b_fname)
2368 :
2369#endif
2370 EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002371 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002372 {
2373 save = no_wait_return;
2374 no_wait_return = FALSE;
2375 wait_return(FALSE);
2376 no_wait_return = save;
2377 }
2378 }
2379
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380 /* Try to find a window that contains the buffer. */
2381 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002382 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 if (wp->w_buffer == buf)
2384 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002385 bufref_T bufref;
2386
2387 set_bufref(&bufref, buf);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002388
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002389 goto_tabpage_win(tp, wp);
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01002390
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 /* Paranoia: did autocms wipe out the buffer with changes? */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002392 if (!bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002393 goto theend;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002394 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002396buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397
2398 /* Open the changed buffer in the current window. */
2399 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002400 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002402theend:
2403 vim_free(bufnrs);
2404 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002405}
2406
2407/*
2408 * return FAIL if there is no file name, OK if there is one
2409 * give error message for FAIL
2410 */
2411 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002412check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413{
2414 if (curbuf->b_ffname == NULL)
2415 {
2416 EMSG(_(e_noname));
2417 return FAIL;
2418 }
2419 return OK;
2420}
2421
2422/*
2423 * flush the contents of a buffer, unless it has no file name
2424 *
2425 * return FAIL for failure, OK otherwise
2426 */
2427 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002428buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429{
2430 int retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002431 buf_T *old_curbuf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432
2433 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2434 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2435 FALSE, forceit, TRUE, FALSE));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002436 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002437 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01002438 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002439 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002440 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441 return retval;
2442}
2443
2444/*
2445 * Code to handle the argument list.
2446 */
2447
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002448static char_u *do_one_arg(char_u *str);
2449static int do_arglist(char_u *str, int what, int after);
2450static void alist_check_arg_idx(void);
2451static int editing_arg_idx(win_T *win);
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002452static int alist_add_list(int count, char_u **files, int after);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002453#define AL_SET 1
2454#define AL_ADD 2
2455#define AL_DEL 3
2456
Bram Moolenaar071d4272004-06-13 20:20:40 +00002457/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002458 * Isolate one argument, taking backticks.
2459 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002460 * Return a pointer to the start of the next argument.
2461 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002462 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002463do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464{
2465 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002466 int inbacktick;
2467
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 inbacktick = FALSE;
2469 for (p = str; *str; ++str)
2470 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002471 /* When the backslash is used for escaping the special meaning of a
2472 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002473 if (rem_backslash(str))
2474 {
2475 *p++ = *str++;
2476 *p++ = *str;
2477 }
2478 else
2479 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002480 /* An item ends at a space not in backticks */
2481 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002483 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002485 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 }
2487 }
2488 str = skipwhite(str);
2489 *p = NUL;
2490
2491 return str;
2492}
2493
Bram Moolenaar86b68352004-12-27 21:59:20 +00002494/*
2495 * Separate the arguments in "str" and return a list of pointers in the
2496 * growarray "gap".
2497 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002498 static int
2499get_arglist(garray_T *gap, char_u *str, int escaped)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002500{
2501 ga_init2(gap, (int)sizeof(char_u *), 20);
2502 while (*str != NUL)
2503 {
2504 if (ga_grow(gap, 1) == FAIL)
2505 {
2506 ga_clear(gap);
2507 return FAIL;
2508 }
2509 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2510
Bram Moolenaar398ee732017-08-03 14:29:14 +02002511 /* If str is escaped, don't handle backslashes or spaces */
2512 if (!escaped)
2513 return OK;
2514
Bram Moolenaar86b68352004-12-27 21:59:20 +00002515 /* Isolate one argument, change it in-place, put a NUL after it. */
2516 str = do_one_arg(str);
2517 }
2518 return OK;
2519}
2520
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002521#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002522/*
2523 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002524 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002525 * Return FAIL or OK.
2526 */
2527 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002528get_arglist_exp(
2529 char_u *str,
2530 int *fcountp,
2531 char_u ***fnamesp,
2532 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002533{
2534 garray_T ga;
2535 int i;
2536
Bram Moolenaar398ee732017-08-03 14:29:14 +02002537 if (get_arglist(&ga, str, TRUE) == FAIL)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002538 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002539 if (wig == TRUE)
2540 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2541 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2542 else
2543 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2544 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2545
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002546 ga_clear(&ga);
2547 return i;
2548}
2549#endif
2550
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551/*
2552 * Redefine the argument list.
2553 */
2554 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002555set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556{
2557 do_arglist(str, AL_SET, 0);
2558}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559
2560/*
2561 * "what" == AL_SET: Redefine the argument list to 'str'.
2562 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2563 * "what" == AL_DEL: remove files in 'str' from the argument list.
2564 *
2565 * Return FAIL for failure, OK otherwise.
2566 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002568do_arglist(
2569 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002570 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002571 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572{
2573 garray_T new_ga;
2574 int exp_count;
2575 char_u **exp_files;
2576 int i;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 char_u *p;
2578 int match;
Bram Moolenaar398ee732017-08-03 14:29:14 +02002579 int arg_escaped = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580
2581 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002582 * Set default argument for ":argadd" command.
2583 */
2584 if (what == AL_ADD && *str == NUL)
2585 {
2586 if (curbuf->b_ffname == NULL)
2587 return FAIL;
2588 str = curbuf->b_fname;
Bram Moolenaar398ee732017-08-03 14:29:14 +02002589 arg_escaped = FALSE;
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002590 }
2591
2592 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 * Collect all file name arguments in "new_ga".
2594 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002595 if (get_arglist(&new_ga, str, arg_escaped) == FAIL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002596 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 if (what == AL_DEL)
2599 {
2600 regmatch_T regmatch;
2601 int didone;
2602
2603 /*
2604 * Delete the items: use each item as a regexp and find a match in the
2605 * argument list.
2606 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002607 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002608 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2609 {
2610 p = ((char_u **)new_ga.ga_data)[i];
2611 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2612 if (p == NULL)
2613 break;
2614 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2615 if (regmatch.regprog == NULL)
2616 {
2617 vim_free(p);
2618 break;
2619 }
2620
2621 didone = FALSE;
2622 for (match = 0; match < ARGCOUNT; ++match)
2623 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2624 (colnr_T)0))
2625 {
2626 didone = TRUE;
2627 vim_free(ARGLIST[match].ae_fname);
2628 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2629 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2630 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002631 if (curwin->w_arg_idx > match)
2632 --curwin->w_arg_idx;
2633 --match;
2634 }
2635
Bram Moolenaar473de612013-06-08 18:19:48 +02002636 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 vim_free(p);
2638 if (!didone)
2639 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2640 }
2641 ga_clear(&new_ga);
2642 }
2643 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002644 {
2645 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2646 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2647 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002648 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002649 {
2650 EMSG(_(e_nomatch));
2651 return FAIL;
2652 }
2653
Bram Moolenaar071d4272004-06-13 20:20:40 +00002654 if (what == AL_ADD)
2655 {
2656 (void)alist_add_list(exp_count, exp_files, after);
2657 vim_free(exp_files);
2658 }
2659 else /* what == AL_SET */
Bram Moolenaar86b68352004-12-27 21:59:20 +00002660 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 }
2662
2663 alist_check_arg_idx();
2664
2665 return OK;
2666}
2667
2668/*
2669 * Check the validity of the arg_idx for each other window.
2670 */
2671 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002672alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673{
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002675 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002676
Bram Moolenaarf740b292006-02-16 22:11:02 +00002677 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002678 if (win->w_alist == curwin->w_alist)
2679 check_arg_idx(win);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680}
2681
2682/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002683 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002684 * index.
2685 */
2686 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002687editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002688{
2689 return !(win->w_arg_idx >= WARGCOUNT(win)
2690 || (win->w_buffer->b_fnum
2691 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2692 && (win->w_buffer->b_ffname == NULL
2693 || !(fullpathcmp(
2694 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2695 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2696}
2697
2698/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002699 * Check if window "win" is editing the w_arg_idx file in its argument list.
2700 */
2701 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002702check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002704 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 {
2706 /* We are not editing the current entry in the argument list.
2707 * Set "arg_had_last" if we are editing the last one. */
2708 win->w_arg_idx_invalid = TRUE;
2709 if (win->w_arg_idx != WARGCOUNT(win) - 1
2710 && arg_had_last == FALSE
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 && ALIST(win) == &global_alist
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712 && GARGCOUNT > 0
2713 && win->w_arg_idx < GARGCOUNT
2714 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2715 || (win->w_buffer->b_ffname != NULL
2716 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2717 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2718 arg_had_last = TRUE;
2719 }
2720 else
2721 {
2722 /* We are editing the current entry in the argument list.
2723 * Set "arg_had_last" if it's also the last one */
2724 win->w_arg_idx_invalid = FALSE;
2725 if (win->w_arg_idx == WARGCOUNT(win) - 1
Bram Moolenaar4033c552017-09-16 20:54:51 +02002726 && win->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 arg_had_last = TRUE;
2728 }
2729}
2730
2731/*
2732 * ":args", ":argslocal" and ":argsglobal".
2733 */
2734 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002735ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002736{
2737 int i;
2738
2739 if (eap->cmdidx != CMD_args)
2740 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002741 alist_unlink(ALIST(curwin));
2742 if (eap->cmdidx == CMD_argglobal)
2743 ALIST(curwin) = &global_alist;
2744 else /* eap->cmdidx == CMD_arglocal */
2745 alist_new();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 }
2747
2748 if (!ends_excmd(*eap->arg))
2749 {
2750 /*
2751 * ":args file ..": define new argument list, handle like ":next"
2752 * Also for ":argslocal file .." and ":argsglobal file ..".
2753 */
2754 ex_next(eap);
2755 }
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02002756 else if (eap->cmdidx == CMD_args)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 {
2758 /*
2759 * ":args": list arguments.
2760 */
2761 if (ARGCOUNT > 0)
2762 {
Bram Moolenaar405dadb2018-04-20 22:48:58 +02002763 char_u **items = (char_u **)alloc(sizeof(char_u *) * ARGCOUNT);
Bram Moolenaar5d69da42018-04-20 22:01:41 +02002764
2765 if (items != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 {
Bram Moolenaar5d69da42018-04-20 22:01:41 +02002767 /* Overwrite the command, for a short list there is no
2768 * scrolling required and no wait_return(). */
2769 gotocmdline(TRUE);
2770
2771 for (i = 0; i < ARGCOUNT; ++i)
Bram Moolenaar405dadb2018-04-20 22:48:58 +02002772 items[i] = alist_name(&ARGLIST[i]);
Bram Moolenaar5d69da42018-04-20 22:01:41 +02002773 list_in_columns(items, ARGCOUNT, curwin->w_arg_idx);
2774 vim_free(items);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002775 }
2776 }
2777 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 else if (eap->cmdidx == CMD_arglocal)
2779 {
2780 garray_T *gap = &curwin->w_alist->al_ga;
2781
2782 /*
2783 * ":argslocal": make a local copy of the global argument list.
2784 */
2785 if (ga_grow(gap, GARGCOUNT) == OK)
2786 for (i = 0; i < GARGCOUNT; ++i)
2787 if (GARGLIST[i].ae_fname != NULL)
2788 {
2789 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2790 vim_strsave(GARGLIST[i].ae_fname);
2791 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2792 GARGLIST[i].ae_fnum;
2793 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002794 }
2795 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796}
2797
2798/*
2799 * ":previous", ":sprevious", ":Next" and ":sNext".
2800 */
2801 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002802ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002803{
2804 /* If past the last one already, go to the last one. */
2805 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2806 do_argfile(eap, ARGCOUNT - 1);
2807 else
2808 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2809}
2810
2811/*
2812 * ":rewind", ":first", ":sfirst" and ":srewind".
2813 */
2814 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002815ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816{
2817 do_argfile(eap, 0);
2818}
2819
2820/*
2821 * ":last" and ":slast".
2822 */
2823 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002824ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002825{
2826 do_argfile(eap, ARGCOUNT - 1);
2827}
2828
2829/*
2830 * ":argument" and ":sargument".
2831 */
2832 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002833ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002834{
2835 int i;
2836
2837 if (eap->addr_count > 0)
2838 i = eap->line2 - 1;
2839 else
2840 i = curwin->w_arg_idx;
2841 do_argfile(eap, i);
2842}
2843
2844/*
2845 * Edit file "argn" of the argument lists.
2846 */
2847 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002848do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002849{
2850 int other;
2851 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002852 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002853
2854 if (argn < 0 || argn >= ARGCOUNT)
2855 {
2856 if (ARGCOUNT <= 1)
2857 EMSG(_("E163: There is only one file to edit"));
2858 else if (argn < 0)
2859 EMSG(_("E164: Cannot go before first file"));
2860 else
2861 EMSG(_("E165: Cannot go beyond last file"));
2862 }
2863 else
2864 {
2865 setpcmark();
2866#ifdef FEAT_GUI
2867 need_mouse_correct = TRUE;
2868#endif
2869
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002870 /* split window or create new tab page first */
2871 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002872 {
2873 if (win_split(0, 0) == FAIL)
2874 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002875 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 }
2877 else
Bram Moolenaar071d4272004-06-13 20:20:40 +00002878 {
2879 /*
2880 * if 'hidden' set, only check for changed file when re-editing
2881 * the same buffer
2882 */
2883 other = TRUE;
Bram Moolenaareb44a682017-08-03 22:44:55 +02002884 if (buf_hide(curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 {
2886 p = fix_fname(alist_name(&ARGLIST[argn]));
2887 other = otherfile(p);
2888 vim_free(p);
2889 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002890 if ((!buf_hide(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002891 && check_changed(curbuf, CCGD_AW
2892 | (other ? 0 : CCGD_MULTWIN)
2893 | (eap->forceit ? CCGD_FORCEIT : 0)
2894 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 return;
2896 }
2897
2898 curwin->w_arg_idx = argn;
Bram Moolenaar4033c552017-09-16 20:54:51 +02002899 if (argn == ARGCOUNT - 1 && curwin->w_alist == &global_alist)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 arg_had_last = TRUE;
2901
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002902 /* Edit the file; always use the last known line number.
2903 * When it fails (e.g. Abort for already edited file) restore the
2904 * argument index. */
2905 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906 eap, ECMD_LAST,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002907 (buf_hide(curwin->w_buffer) ? ECMD_HIDE : 0)
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002908 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002909 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002911 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912 setmark('\'');
2913 }
2914}
2915
2916/*
2917 * ":next", and commands that behave like it.
2918 */
2919 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002920ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921{
2922 int i;
2923
2924 /*
2925 * check for changed buffer now, if this fails the argument list is not
2926 * redefined.
2927 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002928 if ( buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002930 || !check_changed(curbuf, CCGD_AW
2931 | (eap->forceit ? CCGD_FORCEIT : 0)
2932 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 {
2934 if (*eap->arg != NUL) /* redefine file list */
2935 {
2936 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2937 return;
2938 i = 0;
2939 }
2940 else
2941 i = curwin->w_arg_idx + (int)eap->line2;
2942 do_argfile(eap, i);
2943 }
2944}
2945
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946/*
2947 * ":argedit"
2948 */
2949 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002950ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951{
Bram Moolenaar90305c62017-07-16 15:31:17 +02002952 int i = eap->addr_count ? (int)eap->line2 : curwin->w_arg_idx + 1;
Bram Moolenaar46a53df2018-04-24 21:58:51 +02002953 // Whether curbuf will be reused, curbuf->b_ffname will be set.
2954 int curbuf_is_reusable = curbuf_reusable();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955
Bram Moolenaar90305c62017-07-16 15:31:17 +02002956 if (do_arglist(eap->arg, AL_ADD, i) == FAIL)
2957 return;
2958#ifdef FEAT_TITLE
2959 maketitle();
2960#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961
Bram Moolenaar46a53df2018-04-24 21:58:51 +02002962 if (curwin->w_arg_idx == 0
2963 && (curbuf->b_ml.ml_flags & ML_EMPTY)
2964 && (curbuf->b_ffname == NULL || curbuf_is_reusable))
Bram Moolenaar90305c62017-07-16 15:31:17 +02002965 i = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966 /* Edit the argument. */
Bram Moolenaar90305c62017-07-16 15:31:17 +02002967 if (i < ARGCOUNT)
2968 do_argfile(eap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969}
2970
2971/*
2972 * ":argadd"
2973 */
2974 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002975ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976{
2977 do_arglist(eap->arg, AL_ADD,
2978 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2979#ifdef FEAT_TITLE
2980 maketitle();
2981#endif
2982}
2983
2984/*
2985 * ":argdelete"
2986 */
2987 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002988ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989{
2990 int i;
2991 int n;
2992
2993 if (eap->addr_count > 0)
2994 {
2995 /* ":1,4argdel": Delete all arguments in the range. */
2996 if (eap->line2 > ARGCOUNT)
2997 eap->line2 = ARGCOUNT;
2998 n = eap->line2 - eap->line1 + 1;
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01002999 if (*eap->arg != NUL)
3000 /* Can't have both a range and an argument. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 EMSG(_(e_invarg));
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01003002 else if (n <= 0)
3003 {
3004 /* Don't give an error for ":%argdel" if the list is empty. */
3005 if (eap->line1 != 1 || eap->line2 != 0)
3006 EMSG(_(e_invrange));
3007 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 else
3009 {
3010 for (i = eap->line1; i <= eap->line2; ++i)
3011 vim_free(ARGLIST[i - 1].ae_fname);
3012 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
3013 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
3014 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 if (curwin->w_arg_idx >= eap->line2)
3016 curwin->w_arg_idx -= n;
3017 else if (curwin->w_arg_idx > eap->line1)
3018 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01003019 if (ARGCOUNT == 0)
3020 curwin->w_arg_idx = 0;
3021 else if (curwin->w_arg_idx >= ARGCOUNT)
3022 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003023 }
3024 }
3025 else if (*eap->arg == NUL)
3026 EMSG(_(e_argreq));
3027 else
3028 do_arglist(eap->arg, AL_DEL, 0);
3029#ifdef FEAT_TITLE
3030 maketitle();
3031#endif
3032}
3033
3034/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003035 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003036 */
3037 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003038ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003039{
3040 int i;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003041 win_T *wp;
3042 tabpage_T *tp;
Bram Moolenaare25bb902015-02-27 20:33:37 +01003043 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 int next_fnum = 0;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003045#if defined(FEAT_SYN_HL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003048 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003049#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02003050 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003051 int qf_idx;
3052#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01003054#ifndef FEAT_QUICKFIX
3055 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
3056 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3057 {
3058 ex_ni(eap);
3059 return;
3060 }
3061#endif
3062
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003063#if defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003064 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00003065 /* Don't do syntax HL autocommands. Skipping the syntax file is a
3066 * great speed improvement. */
3067 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003069#ifdef FEAT_CLIPBOARD
3070 start_global_changes();
3071#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003072
3073 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003074 || eap->cmdidx == CMD_tabdo
Bram Moolenaareb44a682017-08-03 22:44:55 +02003075 || buf_hide(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01003076 || !check_changed(curbuf, CCGD_AW
3077 | (eap->forceit ? CCGD_FORCEIT : 0)
3078 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003079 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003080 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003081 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003082 wp = firstwin;
3083 tp = first_tabpage;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003084 switch (eap->cmdidx)
3085 {
Bram Moolenaara162bc52015-01-07 16:54:21 +01003086 case CMD_windo:
3087 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
3088 i++;
3089 break;
3090 case CMD_tabdo:
3091 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
3092 i++;
3093 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003094 case CMD_argdo:
3095 i = eap->line1 - 1;
3096 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003097 default:
3098 break;
3099 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 /* set pcmark now */
3101 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003102 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01003103 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003104 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01003105 || !buf->b_p_bl); buf = buf->b_next)
3106 if (buf->b_fnum > eap->line2)
3107 {
3108 buf = NULL;
3109 break;
3110 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003111 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01003112 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003113 }
3114#ifdef FEAT_QUICKFIX
3115 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3116 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3117 {
3118 qf_size = qf_get_size(eap);
3119 if (qf_size <= 0 || eap->line1 > qf_size)
3120 buf = NULL;
3121 else
3122 {
3123 ex_cc(eap);
3124
3125 buf = curbuf;
3126 i = eap->line1 - 1;
3127 if (eap->addr_count <= 0)
3128 /* default is all the quickfix/location list entries */
3129 eap->line2 = qf_size;
3130 }
3131 }
3132#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 else
3134 setpcmark();
3135 listcmd_busy = TRUE; /* avoids setting pcmark below */
3136
Bram Moolenaare25bb902015-02-27 20:33:37 +01003137 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 {
3139 if (eap->cmdidx == CMD_argdo)
3140 {
3141 /* go to argument "i" */
3142 if (i == ARGCOUNT)
3143 break;
3144 /* Don't call do_argfile() when already there, it will try
3145 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003146 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003147 {
3148 /* Clear 'shm' to avoid that the file message overwrites
3149 * any output from the command. */
3150 p_shm_save = vim_strsave(p_shm);
3151 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003153 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3154 vim_free(p_shm_save);
3155 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 if (curwin->w_arg_idx != i)
3157 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003159 else if (eap->cmdidx == CMD_windo)
3160 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003161 /* go to window "wp" */
3162 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003164 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00003165 if (curwin != wp)
3166 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003167 wp = curwin->w_next;
3168 }
3169 else if (eap->cmdidx == CMD_tabdo)
3170 {
3171 /* go to window "tp" */
3172 if (!valid_tabpage(tp))
3173 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02003174 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003175 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 else if (eap->cmdidx == CMD_bufdo)
3178 {
3179 /* Remember the number of the next listed buffer, in case
3180 * ":bwipe" is used or autocommands do something strange. */
3181 next_fnum = -1;
3182 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
3183 if (buf->b_p_bl)
3184 {
3185 next_fnum = buf->b_fnum;
3186 break;
3187 }
3188 }
3189
Bram Moolenaara162bc52015-01-07 16:54:21 +01003190 ++i;
3191
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 /* execute the command */
3193 do_cmdline(eap->arg, eap->getline, eap->cookie,
3194 DOCMD_VERBOSE + DOCMD_NOWAIT);
3195
3196 if (eap->cmdidx == CMD_bufdo)
3197 {
3198 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01003199 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 break;
3201 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02003202 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 if (buf->b_fnum == next_fnum)
3204 break;
3205 if (buf == NULL)
3206 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003207
3208 /* Go to the next buffer. Clear 'shm' to avoid that the file
3209 * message overwrites any output from the command. */
3210 p_shm_save = vim_strsave(p_shm);
3211 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003213 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3214 vim_free(p_shm_save);
3215
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003216 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 if (curbuf->b_fnum != next_fnum)
3218 break;
3219 }
3220
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003221#ifdef FEAT_QUICKFIX
3222 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3223 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3224 {
3225 if (i >= qf_size || i >= eap->line2)
3226 break;
3227
3228 qf_idx = qf_get_cur_idx(eap);
3229
3230 ex_cnext(eap);
3231
3232 /* If jumping to the next quickfix entry fails, quit here */
3233 if (qf_get_cur_idx(eap) == qf_idx)
3234 break;
3235 }
3236#endif
3237
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 if (eap->cmdidx == CMD_windo)
3239 {
3240 validate_cursor(); /* cursor may have moved */
Bram Moolenaar8a3bb562018-03-04 20:14:14 +01003241
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 /* required when 'scrollbind' has been set */
3243 if (curwin->w_p_scb)
3244 do_check_scrollbind(TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01003246
Bram Moolenaara162bc52015-01-07 16:54:21 +01003247 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
3248 if (i+1 > eap->line2)
3249 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01003250 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
3251 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 }
3253 listcmd_busy = FALSE;
3254 }
3255
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003256#if defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003257 if (save_ei != NULL)
3258 {
3259 au_event_restore(save_ei);
3260 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
3261 curbuf->b_fname, TRUE, curbuf);
3262 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003264#ifdef FEAT_CLIPBOARD
3265 end_global_changes();
3266#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267}
3268
3269/*
3270 * Add files[count] to the arglist of the current window after arg "after".
3271 * The file names in files[count] must have been allocated and are taken over.
3272 * Files[] itself is not taken over.
3273 * Returns index of first added argument. Returns -1 when failed (out of mem).
3274 */
3275 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003276alist_add_list(
3277 int count,
3278 char_u **files,
3279 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280{
3281 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003282 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283
3284 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3285 {
3286 if (after < 0)
3287 after = 0;
3288 if (after > ARGCOUNT)
3289 after = ARGCOUNT;
3290 if (after < ARGCOUNT)
3291 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3292 (ARGCOUNT - after) * sizeof(aentry_T));
3293 for (i = 0; i < count; ++i)
3294 {
3295 ARGLIST[after + i].ae_fname = files[i];
Bram Moolenaar46a53df2018-04-24 21:58:51 +02003296 ARGLIST[after + i].ae_fnum =
3297 buflist_add(files[i], BLN_LISTED | BLN_CURBUF);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 }
3299 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003300 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3301 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 return after;
3303 }
3304
3305 for (i = 0; i < count; ++i)
3306 vim_free(files[i]);
3307 return -1;
3308}
3309
Bram Moolenaarcd43eff2018-03-29 15:55:38 +02003310#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3311/*
3312 * Function given to ExpandGeneric() to obtain the possible arguments of the
3313 * argedit and argdelete commands.
3314 */
3315 char_u *
3316get_arglist_name(expand_T *xp UNUSED, int idx)
3317{
3318 if (idx >= ARGCOUNT)
3319 return NULL;
3320
3321 return alist_name(&ARGLIST[idx]);
3322}
3323#endif
3324
Bram Moolenaar0c72fe42018-03-29 16:04:08 +02003325
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326#ifdef FEAT_EVAL
3327/*
3328 * ":compiler[!] {name}"
3329 */
3330 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003331ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332{
3333 char_u *buf;
3334 char_u *old_cur_comp = NULL;
3335 char_u *p;
3336
3337 if (*eap->arg == NUL)
3338 {
3339 /* List all compiler scripts. */
3340 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3341 /* ) keep the indenter happy... */
3342 }
3343 else
3344 {
3345 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3346 if (buf != NULL)
3347 {
3348 if (eap->forceit)
3349 {
3350 /* ":compiler! {name}" sets global options */
3351 do_cmdline_cmd((char_u *)
3352 "command -nargs=* CompilerSet set <args>");
3353 }
3354 else
3355 {
3356 /* ":compiler! {name}" sets local options.
3357 * To remain backwards compatible "current_compiler" is always
3358 * used. A user's compiler plugin may set it, the distributed
3359 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003360 * "b:current_compiler" and restore "current_compiler".
3361 * Explicitly prepend "g:" to make it work in a function. */
3362 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003363 if (old_cur_comp != NULL)
3364 old_cur_comp = vim_strsave(old_cur_comp);
3365 do_cmdline_cmd((char_u *)
3366 "command -nargs=* CompilerSet setlocal <args>");
3367 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003368 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003369 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003370
3371 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003372 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3374 vim_free(buf);
3375
3376 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3377
3378 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003379 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 if (p != NULL)
3381 set_internal_string_var((char_u *)"b:current_compiler", p);
3382
3383 /* Restore "current_compiler" for ":compiler {name}". */
3384 if (!eap->forceit)
3385 {
3386 if (old_cur_comp != NULL)
3387 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003388 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 old_cur_comp);
3390 vim_free(old_cur_comp);
3391 }
3392 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003393 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003394 }
3395 }
3396 }
3397}
3398#endif
3399
3400/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003401 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 */
3403 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003404ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003406 char_u *arg = eap->arg;
3407 char_u *p = skiptowhite(arg);
3408 int len = (int)(p - arg);
3409 int flags = eap->forceit ? DIP_ALL : 0;
3410
3411 if (STRNCMP(arg, "START", len) == 0)
3412 {
3413 flags += DIP_START + DIP_NORTP;
3414 arg = skipwhite(arg + len);
3415 }
3416 else if (STRNCMP(arg, "OPT", len) == 0)
3417 {
3418 flags += DIP_OPT + DIP_NORTP;
3419 arg = skipwhite(arg + len);
3420 }
3421 else if (STRNCMP(arg, "PACK", len) == 0)
3422 {
3423 flags += DIP_START + DIP_OPT + DIP_NORTP;
3424 arg = skipwhite(arg + len);
3425 }
3426 else if (STRNCMP(arg, "ALL", len) == 0)
3427 {
3428 flags += DIP_START + DIP_OPT;
3429 arg = skipwhite(arg + len);
3430 }
3431
3432 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433}
3434
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003436source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003437{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003438 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003439}
3440
3441/*
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003442 * Find the file "name" in all directories in "path" and invoke
3443 * "callback(fname, cookie)".
3444 * "name" can contain wildcards.
3445 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3446 * When "flags" has DIP_DIR: find directories instead of files.
3447 * When "flags" has DIP_ERR: give an error message if there is no match.
3448 *
3449 * return FAIL when no file could be sourced, OK otherwise.
3450 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003451 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003452do_in_path(
3453 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003454 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003455 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003456 void (*callback)(char_u *fname, void *ck),
3457 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458{
3459 char_u *rtp;
3460 char_u *np;
3461 char_u *buf;
3462 char_u *rtp_copy;
3463 char_u *tail;
3464 int num_files;
3465 char_u **files;
3466 int i;
3467 int did_one = FALSE;
3468#ifdef AMIGA
3469 struct Process *proc = (struct Process *)FindTask(0L);
3470 APTR save_winptr = proc->pr_WindowPtr;
3471
3472 /* Avoid a requester here for a volume that doesn't exist. */
3473 proc->pr_WindowPtr = (APTR)-1L;
3474#endif
3475
3476 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3477 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003478 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003479 buf = alloc(MAXPATHL);
3480 if (buf != NULL && rtp_copy != NULL)
3481 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003482 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003483 {
3484 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003485 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003486 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003487 verbose_leave();
3488 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003489
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 /* Loop over all entries in 'runtimepath'. */
3491 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003492 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 {
Bram Moolenaar66459b72016-08-06 19:01:55 +02003494 size_t buflen;
3495
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 /* Copy the path from 'runtimepath' to buf[]. */
3497 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaar66459b72016-08-06 19:01:55 +02003498 buflen = STRLEN(buf);
3499
3500 /* Skip after or non-after directories. */
3501 if (flags & (DIP_NOAFTER | DIP_AFTER))
3502 {
3503 int is_after = buflen >= 5
3504 && STRCMP(buf + buflen - 5, "after") == 0;
3505
3506 if ((is_after && (flags & DIP_NOAFTER))
3507 || (!is_after && (flags & DIP_AFTER)))
3508 continue;
3509 }
3510
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003511 if (name == NULL)
3512 {
3513 (*callback)(buf, (void *) &cookie);
3514 if (!did_one)
3515 did_one = (cookie == NULL);
3516 }
Bram Moolenaar66459b72016-08-06 19:01:55 +02003517 else if (buflen + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 {
3519 add_pathsep(buf);
3520 tail = buf + STRLEN(buf);
3521
3522 /* Loop over all patterns in "name" */
3523 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003524 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 {
3526 /* Append the pattern from "name" to buf[]. */
3527 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3528 "\t ");
3529
3530 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003531 {
3532 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003533 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003534 verbose_leave();
3535 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536
3537 /* Expand wildcards, invoke the callback for each match. */
3538 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003539 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003540 {
3541 for (i = 0; i < num_files; ++i)
3542 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003543 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003544 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003545 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003546 break;
3547 }
3548 FreeWild(num_files, files);
3549 }
3550 }
3551 }
3552 }
3553 }
3554 vim_free(buf);
3555 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003556 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003557 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003558 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3559
3560 if (flags & DIP_ERR)
3561 EMSG3(_(e_dirnotf), basepath, name);
3562 else if (p_verbose > 0)
3563 {
3564 verbose_enter();
3565 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3566 verbose_leave();
3567 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003568 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569
3570#ifdef AMIGA
3571 proc->pr_WindowPtr = save_winptr;
3572#endif
3573
3574 return did_one ? OK : FAIL;
3575}
3576
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003577/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003578 * Find "name" in "path". When found, invoke the callback function for
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003579 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003580 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3581 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003582 * Returns OK when at least one match found, FAIL otherwise.
3583 *
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003584 * If "name" is NULL calls callback for each entry in "path". Cookie is
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003585 * passed by reference in this case, setting it to NULL indicates that callback
3586 * has done its job.
3587 */
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003588 static int
3589do_in_path_and_pp(
3590 char_u *path,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003591 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003592 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003593 void (*callback)(char_u *fname, void *ck),
3594 void *cookie)
3595{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003596 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003597 char_u *s;
3598 int len;
3599 char *start_dir = "pack/*/start/*/%s";
3600 char *opt_dir = "pack/*/opt/*/%s";
3601
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003602 if ((flags & DIP_NORTP) == 0)
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003603 done = do_in_path(path, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003604
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003605 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003606 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003607 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003608 s = alloc(len);
3609 if (s == NULL)
3610 return FAIL;
3611 vim_snprintf((char *)s, len, start_dir, name);
3612 done = do_in_path(p_pp, s, flags, callback, cookie);
3613 vim_free(s);
3614 }
3615
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003616 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003617 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003618 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003619 s = alloc(len);
3620 if (s == NULL)
3621 return FAIL;
3622 vim_snprintf((char *)s, len, opt_dir, name);
3623 done = do_in_path(p_pp, s, flags, callback, cookie);
3624 vim_free(s);
3625 }
3626
3627 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003628}
3629
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003630/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003631 * Just like do_in_path_and_pp(), using 'runtimepath' for "path".
3632 */
3633 int
3634do_in_runtimepath(
3635 char_u *name,
3636 int flags,
3637 void (*callback)(char_u *fname, void *ck),
3638 void *cookie)
3639{
3640 return do_in_path_and_pp(p_rtp, name, flags, callback, cookie);
3641}
3642
3643/*
3644 * Source the file "name" from all directories in 'runtimepath'.
3645 * "name" can contain wildcards.
3646 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3647 *
3648 * return FAIL when no file could be sourced, OK otherwise.
3649 */
3650 int
3651source_runtime(char_u *name, int flags)
3652{
3653 return source_in_path(p_rtp, name, flags);
3654}
3655
3656/*
3657 * Just like source_runtime(), but use "path" instead of 'runtimepath'.
3658 */
3659 int
3660source_in_path(char_u *path, char_u *name, int flags)
3661{
3662 return do_in_path_and_pp(path, name, flags, source_callback, NULL);
3663}
3664
3665
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003666#if defined(FEAT_EVAL) || defined(PROTO)
3667
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003668/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003669 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003670 */
3671 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003672source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003673{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003674 int num_files;
3675 char_u **files;
3676 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003677
Bram Moolenaarf3654822016-03-04 22:12:23 +01003678 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003679 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003680 for (i = 0; i < num_files; ++i)
3681 (void)do_source(files[i], FALSE, DOSO_NONE);
3682 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003683 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003684}
3685
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003686/*
3687 * Add the package directory to 'runtimepath'.
3688 */
3689 static int
3690add_pack_dir_to_rtp(char_u *fname)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003691{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003692 char_u *p4, *p3, *p2, *p1, *p;
3693 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003694 int c;
3695 char_u *new_rtp;
3696 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003697 size_t oldlen;
3698 size_t addlen;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003699 char_u *afterdir = NULL;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003700 size_t afterlen = 0;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003701 char_u *ffname = NULL;
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003702 size_t fname_len;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003703 char_u *buf = NULL;
3704 char_u *rtp_ffname;
3705 int match;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003706 int retval = FAIL;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003707
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003708 p4 = p3 = p2 = p1 = get_past_head(fname);
3709 for (p = p1; *p; MB_PTR_ADV(p))
3710 if (vim_ispathsep_nocolon(*p))
3711 {
3712 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3713 }
3714
3715 /* now we have:
3716 * rtp/pack/name/start/name
3717 * p4 p3 p2 p1
3718 *
3719 * find the part up to "pack" in 'runtimepath' */
3720 c = *++p4; /* append pathsep in order to expand symlink */
3721 *p4 = NUL;
3722 ffname = fix_fname(fname);
3723 *p4 = c;
Bram Moolenaar91715872016-03-03 17:13:03 +01003724 if (ffname == NULL)
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003725 return FAIL;
3726
3727 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3728 fname_len = STRLEN(ffname);
3729 insp = p_rtp;
3730 buf = alloc(MAXPATHL);
3731 if (buf == NULL)
3732 goto theend;
3733 while (*insp != NUL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003734 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003735 copy_option_part(&insp, buf, MAXPATHL, ",");
3736 add_pathsep(buf);
3737 rtp_ffname = fix_fname(buf);
3738 if (rtp_ffname == NULL)
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003739 goto theend;
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003740 match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0;
3741 vim_free(rtp_ffname);
3742 if (match)
3743 break;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003744 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003745
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003746 if (*insp == NUL)
3747 /* not found, append at the end */
3748 insp = p_rtp + STRLEN(p_rtp);
3749 else
3750 /* append after the matching directory. */
3751 --insp;
3752
3753 /* check if rtp/pack/name/start/name/after exists */
3754 afterdir = concat_fnames(fname, (char_u *)"after", TRUE);
3755 if (afterdir != NULL && mch_isdir(afterdir))
3756 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3757
3758 oldlen = STRLEN(p_rtp);
3759 addlen = STRLEN(fname) + 1; /* add one for comma */
3760 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1));
3761 /* add one for NUL */
3762 if (new_rtp == NULL)
3763 goto theend;
3764 keep = (int)(insp - p_rtp);
3765 mch_memmove(new_rtp, p_rtp, keep);
3766 new_rtp[keep] = ',';
3767 mch_memmove(new_rtp + keep + 1, fname, addlen);
3768 if (p_rtp[keep] != NUL)
3769 mch_memmove(new_rtp + keep + addlen, p_rtp + keep, oldlen - keep + 1);
3770 if (afterlen > 0)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003771 {
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003772 STRCAT(new_rtp, ",");
3773 STRCAT(new_rtp, afterdir);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003774 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003775 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3776 vim_free(new_rtp);
3777 retval = OK;
Bram Moolenaarf3654822016-03-04 22:12:23 +01003778
3779theend:
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003780 vim_free(buf);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003781 vim_free(ffname);
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003782 vim_free(afterdir);
3783 return retval;
3784}
3785
3786/*
3787 * Load scripts in "plugin" and "ftdetect" directories of the package.
3788 */
3789 static int
3790load_pack_plugin(char_u *fname)
3791{
3792 static char *plugpat = "%s/plugin/**/*.vim";
3793 static char *ftpat = "%s/ftdetect/*.vim";
3794 int len;
3795 char_u *ffname = fix_fname(fname);
3796 char_u *pat = NULL;
3797 int retval = FAIL;
3798
3799 if (ffname == NULL)
3800 return FAIL;
3801 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3802 pat = alloc(len);
3803 if (pat == NULL)
3804 goto theend;
3805 vim_snprintf((char *)pat, len, plugpat, ffname);
3806 source_all_matches(pat);
3807
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003808 {
3809 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3810
3811 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3812 * found when it loads. */
3813 if (cmd != NULL && eval_to_number(cmd) > 0)
3814 {
3815 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3816 vim_snprintf((char *)pat, len, ftpat, ffname);
3817 source_all_matches(pat);
3818 do_cmdline_cmd((char_u *)"augroup END");
3819 }
3820 vim_free(cmd);
3821 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003822 vim_free(pat);
3823 retval = OK;
3824
3825theend:
3826 vim_free(ffname);
3827 return retval;
3828}
3829
3830/* used for "cookie" of add_pack_plugin() */
3831static int APP_ADD_DIR;
3832static int APP_LOAD;
3833static int APP_BOTH;
3834
3835 static void
3836add_pack_plugin(char_u *fname, void *cookie)
3837{
Bram Moolenaarf98a39c2018-04-18 22:18:23 +02003838 if (cookie != &APP_LOAD)
3839 {
3840 char_u *buf = alloc(MAXPATHL);
3841 char_u *p;
3842 int found = FALSE;
3843
3844 if (buf == NULL)
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003845 return;
Bram Moolenaarf98a39c2018-04-18 22:18:23 +02003846 p = p_rtp;
3847 while (*p != NUL)
3848 {
3849 copy_option_part(&p, buf, MAXPATHL, ",");
3850 if (pathcmp((char *)buf, (char *)fname, -1) == 0)
3851 {
3852 found = TRUE;
3853 break;
3854 }
3855 }
3856 vim_free(buf);
3857 if (!found)
3858 /* directory is not yet in 'runtimepath', add it */
3859 if (add_pack_dir_to_rtp(fname) == FAIL)
3860 return;
3861 }
Bram Moolenaar2374faa2018-02-04 17:47:42 +01003862
3863 if (cookie != &APP_ADD_DIR)
3864 load_pack_plugin(fname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003865}
3866
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003867/*
3868 * Add all packages in the "start" directory to 'runtimepath'.
3869 */
3870 void
3871add_pack_start_dirs(void)
3872{
3873 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3874 add_pack_plugin, &APP_ADD_DIR);
3875}
3876
3877/*
3878 * Load plugins from all packages in the "start" directory.
3879 */
3880 void
3881load_start_packages(void)
3882{
3883 did_source_packages = TRUE;
3884 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3885 add_pack_plugin, &APP_LOAD);
3886}
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003887
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003888/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003889 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003890 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003891 */
3892 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003893ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003894{
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003895 if (!did_source_packages || eap->forceit)
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003896 {
Bram Moolenaar49b27322016-04-05 21:13:00 +02003897 /* First do a round to add all directories to 'runtimepath', then load
3898 * the plugins. This allows for plugins to use an autoload directory
3899 * of another plugin. */
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003900 add_pack_start_dirs();
3901 load_start_packages();
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003902 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003903}
3904
3905/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003906 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003907 */
3908 void
3909ex_packadd(exarg_T *eap)
3910{
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003911 static char *plugpat = "pack/*/%s/%s";
Bram Moolenaar91715872016-03-03 17:13:03 +01003912 int len;
3913 char *pat;
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003914 int round;
3915 int res = OK;
Bram Moolenaar91715872016-03-03 17:13:03 +01003916
Bram Moolenaar9e1d3992017-12-17 14:26:46 +01003917 /* Round 1: use "start", round 2: use "opt". */
3918 for (round = 1; round <= 2; ++round)
3919 {
3920 /* Only look under "start" when loading packages wasn't done yet. */
3921 if (round == 1 && did_source_packages)
3922 continue;
3923
3924 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg) + 5;
3925 pat = (char *)alloc(len);
3926 if (pat == NULL)
3927 return;
3928 vim_snprintf(pat, len, plugpat, round == 1 ? "start" : "opt", eap->arg);
3929 /* The first round don't give a "not found" error, in the second round
3930 * only when nothing was found in the first round. */
3931 res = do_in_path(p_pp, (char_u *)pat,
3932 DIP_ALL + DIP_DIR + (round == 2 && res == FAIL ? DIP_ERR : 0),
3933 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
3934 vim_free(pat);
3935 }
Bram Moolenaar91715872016-03-03 17:13:03 +01003936}
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003937#endif
Bram Moolenaar91715872016-03-03 17:13:03 +01003938
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01003939#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940/*
3941 * ":options"
3942 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003944ex_options(
3945 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946{
Bram Moolenaarab6c8582017-08-11 17:15:09 +02003947 vim_setenv((char_u *)"OPTWIN_CMD", (char_u *)(cmdmod.tab ? "tab" : ""));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3949}
3950#endif
3951
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003952#if defined(FEAT_PYTHON3) || defined(FEAT_PYTHON) || defined(PROTO)
3953
3954# if (defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)) || defined(PROTO)
3955/*
3956 * Detect Python 3 or 2, and initialize 'pyxversion'.
3957 */
3958 void
3959init_pyxversion(void)
3960{
3961 if (p_pyx == 0)
3962 {
3963 if (python3_enabled(FALSE))
3964 p_pyx = 3;
3965 else if (python_enabled(FALSE))
3966 p_pyx = 2;
3967 }
3968}
3969# endif
3970
3971/*
3972 * Does a file contain one of the following strings at the beginning of any
3973 * line?
3974 * "#!(any string)python2" => returns 2
3975 * "#!(any string)python3" => returns 3
3976 * "# requires python 2.x" => returns 2
3977 * "# requires python 3.x" => returns 3
3978 * otherwise return 0.
3979 */
3980 static int
3981requires_py_version(char_u *filename)
3982{
3983 FILE *file;
3984 int requires_py_version = 0;
3985 int i, lines;
3986
3987 lines = (int)p_mls;
3988 if (lines < 0)
3989 lines = 5;
3990
3991 file = mch_fopen((char *)filename, "r");
3992 if (file != NULL)
3993 {
3994 for (i = 0; i < lines; i++)
3995 {
3996 if (vim_fgets(IObuff, IOSIZE, file))
3997 break;
3998 if (i == 0 && IObuff[0] == '#' && IObuff[1] == '!')
3999 {
4000 /* Check shebang. */
4001 if (strstr((char *)IObuff + 2, "python2") != NULL)
4002 {
4003 requires_py_version = 2;
4004 break;
4005 }
4006 if (strstr((char *)IObuff + 2, "python3") != NULL)
4007 {
4008 requires_py_version = 3;
4009 break;
4010 }
4011 }
4012 IObuff[21] = '\0';
4013 if (STRCMP("# requires python 2.x", IObuff) == 0)
4014 {
4015 requires_py_version = 2;
4016 break;
4017 }
4018 if (STRCMP("# requires python 3.x", IObuff) == 0)
4019 {
4020 requires_py_version = 3;
4021 break;
4022 }
4023 }
4024 fclose(file);
4025 }
4026 return requires_py_version;
4027}
4028
4029
4030/*
4031 * Source a python file using the requested python version.
4032 */
4033 static void
4034source_pyx_file(exarg_T *eap, char_u *fname)
4035{
4036 exarg_T ex;
4037 int v = requires_py_version(fname);
4038
4039# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4040 init_pyxversion();
4041# endif
4042 if (v == 0)
4043 {
4044# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4045 /* user didn't choose a preference, 'pyx' is used */
4046 v = p_pyx;
4047# elif defined(FEAT_PYTHON)
4048 v = 2;
4049# elif defined(FEAT_PYTHON3)
4050 v = 3;
4051# endif
4052 }
4053
4054 /*
4055 * now source, if required python version is not supported show
4056 * unobtrusive message.
4057 */
4058 if (eap == NULL)
4059 vim_memset(&ex, 0, sizeof(ex));
4060 else
4061 ex = *eap;
4062 ex.arg = fname;
4063 ex.cmd = (char_u *)(v == 2 ? "pyfile" : "pyfile3");
4064
4065 if (v == 2)
4066 {
4067# ifdef FEAT_PYTHON
4068 ex_pyfile(&ex);
4069# else
4070 vim_snprintf((char *)IObuff, IOSIZE,
4071 _("W20: Required python version 2.x not supported, ignoring file: %s"),
4072 fname);
4073 MSG(IObuff);
4074# endif
4075 return;
4076 }
4077 else
4078 {
4079# ifdef FEAT_PYTHON3
4080 ex_py3file(&ex);
4081# else
4082 vim_snprintf((char *)IObuff, IOSIZE,
4083 _("W21: Required python version 3.x not supported, ignoring file: %s"),
4084 fname);
4085 MSG(IObuff);
4086# endif
4087 return;
4088 }
4089}
4090
4091/*
4092 * ":pyxfile {fname}"
4093 */
4094 void
4095ex_pyxfile(exarg_T *eap)
4096{
4097 source_pyx_file(eap, eap->arg);
4098}
4099
4100/*
4101 * ":pyx"
4102 */
4103 void
4104ex_pyx(exarg_T *eap)
4105{
4106# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4107 init_pyxversion();
4108 if (p_pyx == 2)
4109 ex_python(eap);
4110 else
4111 ex_py3(eap);
4112# elif defined(FEAT_PYTHON)
4113 ex_python(eap);
4114# elif defined(FEAT_PYTHON3)
4115 ex_py3(eap);
4116# endif
4117}
4118
4119/*
4120 * ":pyxdo"
4121 */
4122 void
4123ex_pyxdo(exarg_T *eap)
4124{
4125# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
4126 init_pyxversion();
4127 if (p_pyx == 2)
4128 ex_pydo(eap);
4129 else
4130 ex_py3do(eap);
4131# elif defined(FEAT_PYTHON)
4132 ex_pydo(eap);
4133# elif defined(FEAT_PYTHON3)
4134 ex_py3do(eap);
4135# endif
4136}
4137
4138#endif
4139
Bram Moolenaar071d4272004-06-13 20:20:40 +00004140/*
4141 * ":source {fname}"
4142 */
4143 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004144ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145{
4146#ifdef FEAT_BROWSE
4147 if (cmdmod.browse)
4148 {
4149 char_u *fname = NULL;
4150
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00004151 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaarc36651b2018-04-29 12:22:56 +02004152 NULL, NULL,
4153 (char_u *)_(BROWSE_FILTER_MACROS), NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004154 if (fname != NULL)
4155 {
4156 cmd_source(fname, eap);
4157 vim_free(fname);
4158 }
4159 }
4160 else
4161#endif
4162 cmd_source(eap->arg, eap);
4163}
4164
4165 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004166cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167{
4168 if (*fname == NUL)
4169 EMSG(_(e_argreq));
4170
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02004172 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004173 * Need to execute the commands directly. This is required at least
4174 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 * - ":g" command busy
4176 * - after ":argdo", ":windo" or ":bufdo"
4177 * - another command follows
4178 * - inside a loop
4179 */
4180 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
4181#ifdef FEAT_EVAL
4182 || eap->cstack->cs_idx >= 0
4183#endif
4184 );
4185
4186 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004187 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188 EMSG2(_(e_notopen), fname);
4189}
4190
4191/*
4192 * ":source" and associated commands.
4193 */
4194/*
4195 * Structure used to store info for each sourced file.
4196 * It is shared between do_source() and getsourceline().
4197 * This is required, because it needs to be handed to do_cmdline() and
4198 * sourcing can be done recursively.
4199 */
4200struct source_cookie
4201{
4202 FILE *fp; /* opened file for sourcing */
4203 char_u *nextline; /* if not NULL: line that was read ahead */
4204 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004205#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004206 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
4207 int error; /* TRUE if LF found after CR-LF */
4208#endif
4209#ifdef FEAT_EVAL
4210 linenr_T breakpoint; /* next line with breakpoint or zero */
4211 char_u *fname; /* name of sourced file */
4212 int dbg_tick; /* debug_tick when breakpoint was set */
4213 int level; /* top nesting level of sourced file */
4214#endif
4215#ifdef FEAT_MBYTE
4216 vimconv_T conv; /* type of conversion */
4217#endif
4218};
4219
4220#ifdef FEAT_EVAL
4221/*
4222 * Return the address holding the next breakpoint line for a source cookie.
4223 */
4224 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004225source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004226{
4227 return &((struct source_cookie *)cookie)->breakpoint;
4228}
4229
4230/*
4231 * Return the address holding the debug tick for a source cookie.
4232 */
4233 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004234source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004235{
4236 return &((struct source_cookie *)cookie)->dbg_tick;
4237}
4238
4239/*
4240 * Return the nesting level for a source cookie.
4241 */
4242 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004243source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244{
4245 return ((struct source_cookie *)cookie)->level;
4246}
4247#endif
4248
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004249static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004251#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
4252# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004253static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004254
4255/*
4256 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004257 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004258 */
4259 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004260fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004262# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01004263 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
4264# else
4265 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004266# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267
4268 if (fd_tmp == -1)
4269 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004270
4271# ifdef HAVE_FD_CLOEXEC
4272 {
4273 int fdflags = fcntl(fd_tmp, F_GETFD);
4274 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02004275 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004276 }
4277# endif
4278
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 return fdopen(fd_tmp, READBIN);
4280}
4281#endif
4282
4283
4284/*
4285 * do_source: Read the file "fname" and execute its lines as EX commands.
4286 *
4287 * This function may be called recursively!
4288 *
4289 * return FAIL if file could not be opened, OK otherwise
4290 */
4291 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004292do_source(
4293 char_u *fname,
4294 int check_other, /* check for .vimrc and _vimrc */
4295 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296{
4297 struct source_cookie cookie;
4298 char_u *save_sourcing_name;
4299 linenr_T save_sourcing_lnum;
4300 char_u *p;
4301 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00004302 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 int retval = FAIL;
4304#ifdef FEAT_EVAL
4305 scid_T save_current_SID;
4306 static scid_T last_current_SID = 0;
4307 void *save_funccalp;
4308 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004309 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02004311 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312 int stat_ok;
4313# endif
4314#endif
4315#ifdef STARTUPTIME
4316 struct timeval tv_rel;
4317 struct timeval tv_start;
4318#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004319#ifdef FEAT_PROFILE
4320 proftime_T wait_start;
4321#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322
Bram Moolenaar071d4272004-06-13 20:20:40 +00004323 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 if (p == NULL)
4325 return retval;
4326 fname_exp = fix_fname(p);
4327 vim_free(p);
4328 if (fname_exp == NULL)
4329 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004330 if (mch_isdir(fname_exp))
4331 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00004332 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 goto theend;
4334 }
4335
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004336 /* Apply SourceCmd autocommands, they should get the file and source it. */
4337 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
4338 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
4339 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004340 {
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004341#ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004342 retval = aborting() ? FAIL : OK;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004343#else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004344 retval = OK;
Bram Moolenaarf2bd8ef2018-03-04 18:08:14 +01004345#endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004346 goto theend;
4347 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004348
4349 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004350 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004351
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004352#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4354#else
4355 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4356#endif
4357 if (cookie.fp == NULL && check_other)
4358 {
4359 /*
4360 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
4361 * and ".exrc" by "_exrc" or vice versa.
4362 */
4363 p = gettail(fname_exp);
4364 if ((*p == '.' || *p == '_')
4365 && (STRICMP(p + 1, "vimrc") == 0
4366 || STRICMP(p + 1, "gvimrc") == 0
4367 || STRICMP(p + 1, "exrc") == 0))
4368 {
4369 if (*p == '_')
4370 *p = '.';
4371 else
4372 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004373#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004374 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4375#else
4376 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4377#endif
4378 }
4379 }
4380
4381 if (cookie.fp == NULL)
4382 {
4383 if (p_verbose > 0)
4384 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004385 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004387 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004388 else
4389 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004390 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004391 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004392 }
4393 goto theend;
4394 }
4395
4396 /*
4397 * The file exists.
4398 * - In verbose mode, give a message.
4399 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
4400 */
4401 if (p_verbose > 1)
4402 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004403 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004404 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004405 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 else
4407 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004408 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004409 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004411 if (is_vimrc == DOSO_VIMRC)
4412 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
4413 else if (is_vimrc == DOSO_GVIMRC)
4414 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415
4416#ifdef USE_CRNL
4417 /* If no automatic file format: Set default to CR-NL. */
4418 if (*p_ffs == NUL)
4419 cookie.fileformat = EOL_DOS;
4420 else
4421 cookie.fileformat = EOL_UNKNOWN;
4422 cookie.error = FALSE;
4423#endif
4424
4425#ifdef USE_CR
4426 /* If no automatic file format: Set default to CR. */
4427 if (*p_ffs == NUL)
4428 cookie.fileformat = EOL_MAC;
4429 else
4430 cookie.fileformat = EOL_UNKNOWN;
4431 cookie.error = FALSE;
4432#endif
4433
4434 cookie.nextline = NULL;
4435 cookie.finished = FALSE;
4436
4437#ifdef FEAT_EVAL
4438 /*
4439 * Check if this script has a breakpoint.
4440 */
4441 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
4442 cookie.fname = fname_exp;
4443 cookie.dbg_tick = debug_tick;
4444
4445 cookie.level = ex_nesting_level;
4446#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447
4448 /*
4449 * Keep the sourcing name/lnum, for recursive calls.
4450 */
4451 save_sourcing_name = sourcing_name;
4452 sourcing_name = fname_exp;
4453 save_sourcing_lnum = sourcing_lnum;
4454 sourcing_lnum = 0;
4455
4456#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004457 if (time_fd != NULL)
4458 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459#endif
4460
4461#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00004462# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004463 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004464 prof_child_enter(&wait_start); /* entering a child now */
4465# endif
4466
4467 /* Don't use local function variables, if called from a function.
4468 * Also starts profiling timer for nested script. */
4469 save_funccalp = save_funccal();
4470
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 /*
4472 * Check if this script was sourced before to finds its SID.
4473 * If it's new, generate a new SID.
4474 */
4475 save_current_SID = current_SID;
4476# ifdef UNIX
4477 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
4478# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004479 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
4480 {
4481 si = &SCRIPT_ITEM(current_SID);
4482 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004483 && (
4484# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00004485 /* Compare dev/ino when possible, it catches symbolic
4486 * links. Also compare file names, the inode may change
4487 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004488 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004489 && (si->sn_dev == st.st_dev
4490 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00004491# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004492 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004494 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 if (current_SID == 0)
4496 {
4497 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004498 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
4499 == FAIL)
4500 goto almosttheend;
4501 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00004503 ++script_items.ga_len;
4504 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
4505# ifdef FEAT_PROFILE
4506 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004509 si = &SCRIPT_ITEM(current_SID);
4510 si->sn_name = fname_exp;
4511 fname_exp = NULL;
4512# ifdef UNIX
4513 if (stat_ok)
4514 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004515 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004516 si->sn_dev = st.st_dev;
4517 si->sn_ino = st.st_ino;
4518 }
4519 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004520 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004521# endif
4522
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 /* Allocate the local script variables to use for this script. */
4524 new_script_vars(current_SID);
4525 }
4526
Bram Moolenaar05159a02005-02-26 23:04:13 +00004527# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004528 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004529 {
4530 int forceit;
4531
4532 /* Check if we do profiling for this script. */
4533 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
4534 {
4535 script_do_profile(si);
4536 si->sn_pr_force = forceit;
4537 }
4538 if (si->sn_prof_on)
4539 {
4540 ++si->sn_pr_count;
4541 profile_start(&si->sn_pr_start);
4542 profile_zero(&si->sn_pr_children);
4543 }
4544 }
4545# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004546#endif
4547
Bram Moolenaar67435d92017-10-19 21:04:37 +02004548#ifdef FEAT_MBYTE
4549 cookie.conv.vc_type = CONV_NONE; /* no conversion */
4550
4551 /* Read the first line so we can check for a UTF-8 BOM. */
4552 firstline = getsourceline(0, (void *)&cookie, 0);
4553 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
4554 && firstline[1] == 0xbb && firstline[2] == 0xbf)
4555 {
4556 /* Found BOM; setup conversion, skip over BOM and recode the line. */
4557 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
4558 p = string_convert(&cookie.conv, firstline + 3, NULL);
4559 if (p == NULL)
4560 p = vim_strsave(firstline + 3);
4561 if (p != NULL)
4562 {
4563 vim_free(firstline);
4564 firstline = p;
4565 }
4566 }
4567#endif
4568
Bram Moolenaar071d4272004-06-13 20:20:40 +00004569 /*
4570 * Call do_cmdline, which will call getsourceline() to get the lines.
4571 */
Bram Moolenaar73881402009-02-04 16:50:47 +00004572 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004573 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004574 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004575
4576#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004577 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004578 {
4579 /* Get "si" again, "script_items" may have been reallocated. */
4580 si = &SCRIPT_ITEM(current_SID);
4581 if (si->sn_prof_on)
4582 {
4583 profile_end(&si->sn_pr_start);
4584 profile_sub_wait(&wait_start, &si->sn_pr_start);
4585 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004586 profile_self(&si->sn_pr_self, &si->sn_pr_start,
4587 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004588 }
4589 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590#endif
4591
4592 if (got_int)
4593 EMSG(_(e_interr));
4594 sourcing_name = save_sourcing_name;
4595 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 if (p_verbose > 1)
4597 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004598 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004599 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004601 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004602 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 }
4604#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004605 if (time_fd != NULL)
4606 {
4607 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4608 time_msg((char *)IObuff, &tv_start);
4609 time_pop(&tv_rel);
4610 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004611#endif
4612
4613#ifdef FEAT_EVAL
4614 /*
4615 * After a "finish" in debug mode, need to break at first command of next
4616 * sourced file.
4617 */
4618 if (save_debug_break_level > ex_nesting_level
4619 && debug_break_level == ex_nesting_level)
4620 ++debug_break_level;
4621#endif
4622
Bram Moolenaar05159a02005-02-26 23:04:13 +00004623#ifdef FEAT_EVAL
4624almosttheend:
4625 current_SID = save_current_SID;
4626 restore_funccal(save_funccalp);
4627# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004628 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004629 prof_child_exit(&wait_start); /* leaving a child now */
4630# endif
4631#endif
4632 fclose(cookie.fp);
4633 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004634 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004635#ifdef FEAT_MBYTE
4636 convert_setup(&cookie.conv, NULL, NULL);
4637#endif
4638
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639theend:
4640 vim_free(fname_exp);
4641 return retval;
4642}
4643
4644#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004645
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646/*
4647 * ":scriptnames"
4648 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004650ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651{
4652 int i;
4653
Bram Moolenaar05159a02005-02-26 23:04:13 +00004654 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4655 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004656 {
4657 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4658 NameBuff, MAXPATHL, TRUE);
4659 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004660 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004661}
4662
4663# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4664/*
4665 * Fix slashes in the list of script names for 'shellslash'.
4666 */
4667 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004668scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004669{
4670 int i;
4671
Bram Moolenaar05159a02005-02-26 23:04:13 +00004672 for (i = 1; i <= script_items.ga_len; ++i)
4673 if (SCRIPT_ITEM(i).sn_name != NULL)
4674 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004675}
4676# endif
4677
4678/*
4679 * Get a pointer to a script name. Used for ":verbose set".
4680 */
4681 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004682get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683{
4684 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004685 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004687 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004689 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004691 return (char_u *)_("environment variable");
4692 if (id == SID_ERROR)
4693 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004694 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004696
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004697# if defined(EXITFREE) || defined(PROTO)
4698 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004699free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004700{
4701 int i;
4702
4703 for (i = script_items.ga_len; i > 0; --i)
4704 vim_free(SCRIPT_ITEM(i).sn_name);
4705 ga_clear(&script_items);
4706}
4707# endif
4708
Bram Moolenaar071d4272004-06-13 20:20:40 +00004709#endif
4710
4711#if defined(USE_CR) || defined(PROTO)
4712
4713# if defined(__MSL__) && (__MSL__ >= 22)
4714/*
4715 * Newer version of the Metrowerks library handle DOS and UNIX files
4716 * without help.
4717 * Test with earlier versions, MSL 2.2 is the library supplied with
4718 * Codewarrior Pro 2.
4719 */
4720 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004721fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722{
4723 return fgets(s, n, stream);
4724}
4725# else
4726/*
4727 * Version of fgets() which also works for lines ending in a <CR> only
4728 * (Macintosh format).
4729 * For older versions of the Metrowerks library.
4730 * At least CodeWarrior 9 needed this code.
4731 */
4732 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004733fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734{
4735 int c = 0;
4736 int char_read = 0;
4737
4738 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4739 {
4740 c = fgetc(stream);
4741 s[char_read++] = c;
4742 /* If the file is in DOS format, we need to skip a NL after a CR. I
4743 * thought it was the other way around, but this appears to work... */
4744 if (c == '\n')
4745 {
4746 c = fgetc(stream);
4747 if (c != '\r')
4748 ungetc(c, stream);
4749 }
4750 }
4751
4752 s[char_read] = 0;
4753 if (char_read == 0)
4754 return NULL;
4755
4756 if (feof(stream) && char_read == 1)
4757 return NULL;
4758
4759 return s;
4760}
4761# endif
4762#endif
4763
4764/*
4765 * Get one full line from a sourced file.
4766 * Called by do_cmdline() when it's called from do_source().
4767 *
4768 * Return a pointer to the line in allocated memory.
4769 * Return NULL for end-of-file or some error.
4770 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004772getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773{
4774 struct source_cookie *sp = (struct source_cookie *)cookie;
4775 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004776 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004777
4778#ifdef FEAT_EVAL
4779 /* If breakpoints have been added/deleted need to check for it. */
4780 if (sp->dbg_tick < debug_tick)
4781 {
4782 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4783 sp->dbg_tick = debug_tick;
4784 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004785# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004786 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004787 script_line_end();
4788# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789#endif
4790 /*
4791 * Get current line. If there is a read-ahead line, use it, otherwise get
4792 * one now.
4793 */
4794 if (sp->finished)
4795 line = NULL;
4796 else if (sp->nextline == NULL)
4797 line = get_one_sourceline(sp);
4798 else
4799 {
4800 line = sp->nextline;
4801 sp->nextline = NULL;
4802 ++sourcing_lnum;
4803 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004804#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004805 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004806 script_line_start();
4807#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004808
4809 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4810 * contain the 'C' flag. */
4811 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4812 {
4813 /* compensate for the one line read-ahead */
4814 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004815
4816 /* Get the next line and concatenate it when it starts with a
4817 * backslash. We always need to read the next line, keep it in
4818 * sp->nextline. */
4819 sp->nextline = get_one_sourceline(sp);
4820 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004821 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004822 garray_T ga;
4823
Bram Moolenaarb549a732012-02-22 18:29:33 +01004824 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004825 ga_concat(&ga, line);
4826 ga_concat(&ga, p + 1);
4827 for (;;)
4828 {
4829 vim_free(sp->nextline);
4830 sp->nextline = get_one_sourceline(sp);
4831 if (sp->nextline == NULL)
4832 break;
4833 p = skipwhite(sp->nextline);
4834 if (*p != '\\')
4835 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004836 /* Adjust the growsize to the current length to speed up
4837 * concatenating many lines. */
4838 if (ga.ga_len > 400)
4839 {
4840 if (ga.ga_len > 8000)
4841 ga.ga_growsize = 8000;
4842 else
4843 ga.ga_growsize = ga.ga_len;
4844 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004845 ga_concat(&ga, p + 1);
4846 }
4847 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004848 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004849 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 }
4851 }
4852
4853#ifdef FEAT_MBYTE
4854 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4855 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004856 char_u *s;
4857
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 /* Convert the encoding of the script line. */
4859 s = string_convert(&sp->conv, line, NULL);
4860 if (s != NULL)
4861 {
4862 vim_free(line);
4863 line = s;
4864 }
4865 }
4866#endif
4867
4868#ifdef FEAT_EVAL
4869 /* Did we encounter a breakpoint? */
4870 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4871 {
4872 dbg_breakpoint(sp->fname, sourcing_lnum);
4873 /* Find next breakpoint. */
4874 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4875 sp->dbg_tick = debug_tick;
4876 }
4877#endif
4878
4879 return line;
4880}
4881
4882 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004883get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884{
4885 garray_T ga;
4886 int len;
4887 int c;
4888 char_u *buf;
4889#ifdef USE_CRNL
4890 int has_cr; /* CR-LF found */
4891#endif
4892#ifdef USE_CR
4893 char_u *scan;
4894#endif
4895 int have_read = FALSE;
4896
4897 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004898 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004899
4900 /*
4901 * Loop until there is a finished line (or end-of-file).
4902 */
4903 sourcing_lnum++;
4904 for (;;)
4905 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004906 /* make room to read at least 120 (more) characters */
4907 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 break;
4909 buf = (char_u *)ga.ga_data;
4910
4911#ifdef USE_CR
4912 if (sp->fileformat == EOL_MAC)
4913 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004914 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4915 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 break;
4917 }
4918 else
4919#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004920 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4921 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004923 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004924#ifdef USE_CRNL
4925 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4926 * CTRL-Z by its own, or after a NL. */
4927 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4928 && sp->fileformat == EOL_DOS
4929 && buf[len - 1] == Ctrl_Z)
4930 {
4931 buf[len - 1] = NUL;
4932 break;
4933 }
4934#endif
4935
4936#ifdef USE_CR
4937 /* If the read doesn't stop on a new line, and there's
4938 * some CR then we assume a Mac format */
4939 if (sp->fileformat == EOL_UNKNOWN)
4940 {
4941 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4942 sp->fileformat = EOL_MAC;
4943 else
4944 sp->fileformat = EOL_UNIX;
4945 }
4946
4947 if (sp->fileformat == EOL_MAC)
4948 {
4949 scan = vim_strchr(buf, '\r');
4950
4951 if (scan != NULL)
4952 {
4953 *scan = '\n';
4954 if (*(scan + 1) != 0)
4955 {
4956 *(scan + 1) = 0;
4957 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4958 }
4959 }
4960 len = STRLEN(buf);
4961 }
4962#endif
4963
4964 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 ga.ga_len = len;
4966
4967 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004968 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004969 continue;
4970
4971 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4972 {
4973#ifdef USE_CRNL
4974 has_cr = (len >= 2 && buf[len - 2] == '\r');
4975 if (sp->fileformat == EOL_UNKNOWN)
4976 {
4977 if (has_cr)
4978 sp->fileformat = EOL_DOS;
4979 else
4980 sp->fileformat = EOL_UNIX;
4981 }
4982
4983 if (sp->fileformat == EOL_DOS)
4984 {
4985 if (has_cr) /* replace trailing CR */
4986 {
4987 buf[len - 2] = '\n';
4988 --len;
4989 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 }
4991 else /* lines like ":map xx yy^M" will have failed */
4992 {
4993 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004994 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01004995 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004997 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 sp->error = TRUE;
4999 sp->fileformat = EOL_UNIX;
5000 }
5001 }
5002#endif
5003 /* The '\n' is escaped if there is an odd number of ^V's just
5004 * before it, first set "c" just before the 'V's and then check
5005 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
5006 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
5007 ;
5008 if ((len & 1) != (c & 1)) /* escaped NL, read more */
5009 {
5010 sourcing_lnum++;
5011 continue;
5012 }
5013
5014 buf[len - 1] = NUL; /* remove the NL */
5015 }
5016
5017 /*
5018 * Check for ^C here now and then, so recursive :so can be broken.
5019 */
5020 line_breakcheck();
5021 break;
5022 }
5023
5024 if (have_read)
5025 return (char_u *)ga.ga_data;
5026
5027 vim_free(ga.ga_data);
5028 return NULL;
5029}
5030
Bram Moolenaar05159a02005-02-26 23:04:13 +00005031#if defined(FEAT_PROFILE) || defined(PROTO)
5032/*
5033 * Called when starting to read a script line.
5034 * "sourcing_lnum" must be correct!
5035 * When skipping lines it may not actually be executed, but we won't find out
5036 * until later and we need to store the time now.
5037 */
5038 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005039script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005040{
5041 scriptitem_T *si;
5042 sn_prl_T *pp;
5043
5044 if (current_SID <= 0 || current_SID > script_items.ga_len)
5045 return;
5046 si = &SCRIPT_ITEM(current_SID);
5047 if (si->sn_prof_on && sourcing_lnum >= 1)
5048 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005049 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00005050 * here isn't counted. */
Bram Moolenaar67435d92017-10-19 21:04:37 +02005051 (void)ga_grow(&si->sn_prl_ga,
5052 (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00005053 si->sn_prl_idx = sourcing_lnum - 1;
5054 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
5055 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
5056 {
5057 /* Zero counters for a line that was not used before. */
5058 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
5059 pp->snp_count = 0;
5060 profile_zero(&pp->sn_prl_total);
5061 profile_zero(&pp->sn_prl_self);
5062 ++si->sn_prl_ga.ga_len;
5063 }
5064 si->sn_prl_execed = FALSE;
5065 profile_start(&si->sn_prl_start);
5066 profile_zero(&si->sn_prl_children);
5067 profile_get_wait(&si->sn_prl_wait);
5068 }
5069}
5070
5071/*
5072 * Called when actually executing a function line.
5073 */
5074 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005075script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005076{
5077 scriptitem_T *si;
5078
5079 if (current_SID <= 0 || current_SID > script_items.ga_len)
5080 return;
5081 si = &SCRIPT_ITEM(current_SID);
5082 if (si->sn_prof_on && si->sn_prl_idx >= 0)
5083 si->sn_prl_execed = TRUE;
5084}
5085
5086/*
Bram Moolenaar67435d92017-10-19 21:04:37 +02005087 * Called when done with a script line.
Bram Moolenaar05159a02005-02-26 23:04:13 +00005088 */
5089 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005090script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00005091{
5092 scriptitem_T *si;
5093 sn_prl_T *pp;
5094
5095 if (current_SID <= 0 || current_SID > script_items.ga_len)
5096 return;
5097 si = &SCRIPT_ITEM(current_SID);
5098 if (si->sn_prof_on && si->sn_prl_idx >= 0
5099 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
5100 {
5101 if (si->sn_prl_execed)
5102 {
5103 pp = &PRL_ITEM(si, si->sn_prl_idx);
5104 ++pp->snp_count;
5105 profile_end(&si->sn_prl_start);
5106 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005107 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00005108 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
5109 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00005110 }
5111 si->sn_prl_idx = -1;
5112 }
5113}
5114#endif
5115
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116/*
5117 * ":scriptencoding": Set encoding conversion for a sourced script.
5118 * Without the multi-byte feature it's simply ignored.
5119 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005121ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122{
5123#ifdef FEAT_MBYTE
5124 struct source_cookie *sp;
5125 char_u *name;
5126
5127 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
5128 {
5129 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
5130 return;
5131 }
5132
5133 if (*eap->arg != NUL)
5134 {
5135 name = enc_canonize(eap->arg);
5136 if (name == NULL) /* out of memory */
5137 return;
5138 }
5139 else
5140 name = eap->arg;
5141
5142 /* Setup for conversion from the specified encoding to 'encoding'. */
5143 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
5144 convert_setup(&sp->conv, name, p_enc);
5145
5146 if (name != eap->arg)
5147 vim_free(name);
5148#endif
5149}
5150
5151#if defined(FEAT_EVAL) || defined(PROTO)
5152/*
5153 * ":finish": Mark a sourced file as finished.
5154 */
5155 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005156ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157{
5158 if (getline_equal(eap->getline, eap->cookie, getsourceline))
5159 do_finish(eap, FALSE);
5160 else
5161 EMSG(_("E168: :finish used outside of a sourced file"));
5162}
5163
5164/*
5165 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
5166 * Also called for a pending finish at the ":endtry" or after returning from
5167 * an extra do_cmdline(). "reanimate" is used in the latter case.
5168 */
5169 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005170do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171{
5172 int idx;
5173
5174 if (reanimate)
5175 ((struct source_cookie *)getline_cookie(eap->getline,
5176 eap->cookie))->finished = FALSE;
5177
5178 /*
5179 * Cleanup (and inactivate) conditionals, but stop when a try conditional
5180 * not in its finally clause (which then is to be executed next) is found.
5181 * In this case, make the ":finish" pending for execution at the ":endtry".
5182 * Otherwise, finish normally.
5183 */
5184 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
5185 if (idx >= 0)
5186 {
5187 eap->cstack->cs_pending[idx] = CSTP_FINISH;
5188 report_make_pending(CSTP_FINISH, NULL);
5189 }
5190 else
5191 ((struct source_cookie *)getline_cookie(eap->getline,
5192 eap->cookie))->finished = TRUE;
5193}
5194
5195
5196/*
5197 * Return TRUE when a sourced file had the ":finish" command: Don't give error
5198 * message for missing ":endif".
5199 * Return FALSE when not sourcing a file.
5200 */
5201 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005202source_finished(
5203 char_u *(*fgetline)(int, void *, int),
5204 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205{
Bram Moolenaar89d40322006-08-29 15:30:07 +00005206 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00005208 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209}
5210#endif
5211
Bram Moolenaar071d4272004-06-13 20:20:40 +00005212/*
5213 * ":checktime [buffer]"
5214 */
5215 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005216ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217{
5218 buf_T *buf;
5219 int save_no_check_timestamps = no_check_timestamps;
5220
5221 no_check_timestamps = 0;
5222 if (eap->addr_count == 0) /* default is all buffers */
5223 check_timestamps(FALSE);
5224 else
5225 {
5226 buf = buflist_findnr((int)eap->line2);
5227 if (buf != NULL) /* cannot happen? */
5228 (void)buf_check_timestamp(buf, FALSE);
5229 }
5230 no_check_timestamps = save_no_check_timestamps;
5231}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5234 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005235# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005236static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005238 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005239get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005241 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005242
Bram Moolenaar48e330a2016-02-23 14:53:34 +01005243 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005244 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005246# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 if (loc != NULL)
5248 {
5249 char_u *p;
5250
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005251 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
5252 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253 p = vim_strchr(loc, '=');
5254 if (p != NULL)
5255 {
5256 loc = ++p;
5257 while (*p != NUL) /* remove trailing newline */
5258 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005259 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 {
5261 *p = NUL;
5262 break;
5263 }
5264 ++p;
5265 }
5266 }
5267 }
5268# endif
5269
5270 return loc;
5271}
5272#endif
5273
5274
5275#ifdef WIN32
5276/*
5277 * On MS-Windows locale names are strings like "German_Germany.1252", but
5278 * gettext expects "de". Try to translate one into another here for a few
5279 * supported languages.
5280 */
5281 static char_u *
5282gettext_lang(char_u *name)
5283{
5284 int i;
5285 static char *(mtable[]) = {
5286 "afrikaans", "af",
5287 "czech", "cs",
5288 "dutch", "nl",
5289 "german", "de",
5290 "english_united kingdom", "en_GB",
5291 "spanish", "es",
5292 "french", "fr",
5293 "italian", "it",
5294 "japanese", "ja",
5295 "korean", "ko",
5296 "norwegian", "no",
5297 "polish", "pl",
5298 "russian", "ru",
5299 "slovak", "sk",
5300 "swedish", "sv",
5301 "ukrainian", "uk",
5302 "chinese_china", "zh_CN",
5303 "chinese_taiwan", "zh_TW",
5304 NULL};
5305
5306 for (i = 0; mtable[i] != NULL; i += 2)
5307 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005308 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309 return name;
5310}
5311#endif
5312
5313#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5314/*
5315 * Obtain the current messages language. Used to set the default for
5316 * 'helplang'. May return NULL or an empty string.
5317 */
5318 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005319get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320{
5321 char_u *p;
5322
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005323# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005324# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005325 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005326# else
5327 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005328 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
5329 * and LC_MONETARY may be set differently for a Japanese working in the
5330 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005331 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332# endif
5333# else
5334 p = mch_getenv((char_u *)"LC_ALL");
5335 if (p == NULL || *p == NUL)
5336 {
5337 p = mch_getenv((char_u *)"LC_MESSAGES");
5338 if (p == NULL || *p == NUL)
5339 p = mch_getenv((char_u *)"LANG");
5340 }
5341# endif
5342# ifdef WIN32
5343 p = gettext_lang(p);
5344# endif
5345 return p;
5346}
5347#endif
5348
Bram Moolenaardef9e822004-12-31 20:58:58 +00005349/* Complicated #if; matches with where get_mess_env() is used below. */
5350#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5351 && defined(LC_MESSAGES))) \
5352 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5353 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
5354 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01005355static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005356
5357/*
5358 * Get the language used for messages from the environment.
5359 */
5360 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005361get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362{
5363 char_u *p;
5364
5365 p = mch_getenv((char_u *)"LC_ALL");
5366 if (p == NULL || *p == NUL)
5367 {
5368 p = mch_getenv((char_u *)"LC_MESSAGES");
5369 if (p == NULL || *p == NUL)
5370 {
5371 p = mch_getenv((char_u *)"LANG");
5372 if (p != NULL && VIM_ISDIGIT(*p))
5373 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005374# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005376 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377# endif
5378 }
5379 }
5380 return p;
5381}
5382#endif
5383
5384#if defined(FEAT_EVAL) || defined(PROTO)
5385
5386/*
5387 * Set the "v:lang" variable according to the current locale setting.
5388 * Also do "v:lc_time"and "v:ctype".
5389 */
5390 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005391set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392{
5393 char_u *loc;
5394
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005395# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005396 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397# else
5398 /* setlocale() not supported: use the default value */
5399 loc = (char_u *)"C";
5400# endif
5401 set_vim_var_string(VV_CTYPE, loc, -1);
5402
5403 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
5404 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005405# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005406 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407# else
5408 loc = get_mess_env();
5409# endif
5410 set_vim_var_string(VV_LANG, loc, -1);
5411
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005412# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005413 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414# endif
5415 set_vim_var_string(VV_LC_TIME, loc, -1);
5416}
5417#endif
5418
5419#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5420 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
5421/*
5422 * ":language": Set the language (locale).
5423 */
5424 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005425ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426{
5427 char *loc;
5428 char_u *p;
5429 char_u *name;
5430 int what = LC_ALL;
5431 char *whatstr = "";
5432#ifdef LC_MESSAGES
5433# define VIM_LC_MESSAGES LC_MESSAGES
5434#else
5435# define VIM_LC_MESSAGES 6789
5436#endif
5437
5438 name = eap->arg;
5439
5440 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
5441 * Allow abbreviation, but require at least 3 characters to avoid
5442 * confusion with a two letter language name "me" or "ct". */
5443 p = skiptowhite(eap->arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005444 if ((*p == NUL || VIM_ISWHITE(*p)) && p - eap->arg >= 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005445 {
5446 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
5447 {
5448 what = VIM_LC_MESSAGES;
5449 name = skipwhite(p);
5450 whatstr = "messages ";
5451 }
5452 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
5453 {
5454 what = LC_CTYPE;
5455 name = skipwhite(p);
5456 whatstr = "ctype ";
5457 }
5458 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
5459 {
5460 what = LC_TIME;
5461 name = skipwhite(p);
5462 whatstr = "time ";
5463 }
5464 }
5465
5466 if (*name == NUL)
5467 {
5468#ifndef LC_MESSAGES
5469 if (what == VIM_LC_MESSAGES)
5470 p = get_mess_env();
5471 else
5472#endif
5473 p = (char_u *)setlocale(what, NULL);
5474 if (p == NULL || *p == NUL)
5475 p = (char_u *)"Unknown";
5476 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
5477 }
5478 else
5479 {
5480#ifndef LC_MESSAGES
5481 if (what == VIM_LC_MESSAGES)
5482 loc = "";
5483 else
5484#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005485 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005487#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
5488 /* Make sure strtod() uses a decimal point, not a comma. */
5489 setlocale(LC_NUMERIC, "C");
5490#endif
5491 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 if (loc == NULL)
5493 EMSG2(_("E197: Cannot set language to \"%s\""), name);
5494 else
5495 {
5496#ifdef HAVE_NL_MSG_CAT_CNTR
5497 /* Need to do this for GNU gettext, otherwise cached translations
5498 * will be used again. */
5499 extern int _nl_msg_cat_cntr;
5500
5501 ++_nl_msg_cat_cntr;
5502#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00005503 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
5505
5506 if (what != LC_TIME)
5507 {
5508 /* Tell gettext() what to translate to. It apparently doesn't
5509 * use the currently effective locale. Also do this when
5510 * FEAT_GETTEXT isn't defined, so that shell commands use this
5511 * value. */
5512 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005513 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005514 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02005515
5516 /* Clear $LANGUAGE because GNU gettext uses it. */
5517 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005518# ifdef WIN32
5519 /* Apparently MS-Windows printf() may cause a crash when
5520 * we give it 8-bit text while it's expecting text in the
5521 * current locale. This call avoids that. */
5522 setlocale(LC_CTYPE, "C");
5523# endif
5524 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 if (what != LC_CTYPE)
5526 {
5527 char_u *mname;
5528#ifdef WIN32
5529 mname = gettext_lang(name);
5530#else
5531 mname = name;
5532#endif
5533 vim_setenv((char_u *)"LC_MESSAGES", mname);
5534#ifdef FEAT_MULTI_LANG
5535 set_helplang_default(mname);
5536#endif
5537 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 }
5539
5540# ifdef FEAT_EVAL
5541 /* Set v:lang, v:lc_time and v:ctype to the final result. */
5542 set_lang_var();
5543# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02005544# ifdef FEAT_TITLE
5545 maketitle();
5546# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 }
5548 }
5549}
5550
5551# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005552
5553static char_u **locales = NULL; /* Array of all available locales */
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005554
5555# ifndef WIN32
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005556static int did_init_locales = FALSE;
5557
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005558/* Return an array of strings for all available locales + NULL for the
5559 * last element. Return NULL in case of error. */
5560 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005561find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005562{
5563 garray_T locales_ga;
5564 char_u *loc;
5565
5566 /* Find all available locales by running command "locale -a". If this
5567 * doesn't work we won't have completion. */
5568 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02005569 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005570 if (locale_a == NULL)
5571 return NULL;
5572 ga_init2(&locales_ga, sizeof(char_u *), 20);
5573
5574 /* Transform locale_a string where each locale is separated by "\n"
5575 * into an array of locale strings. */
5576 loc = (char_u *)strtok((char *)locale_a, "\n");
5577
5578 while (loc != NULL)
5579 {
5580 if (ga_grow(&locales_ga, 1) == FAIL)
5581 break;
5582 loc = vim_strsave(loc);
5583 if (loc == NULL)
5584 break;
5585
5586 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5587 loc = (char_u *)strtok(NULL, "\n");
5588 }
5589 vim_free(locale_a);
5590 if (ga_grow(&locales_ga, 1) == FAIL)
5591 {
5592 ga_clear(&locales_ga);
5593 return NULL;
5594 }
5595 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5596 return (char_u **)locales_ga.ga_data;
5597}
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005598# endif
5599
5600/*
5601 * Lazy initialization of all available locales.
5602 */
5603 static void
5604init_locales(void)
5605{
5606# ifndef WIN32
5607 if (!did_init_locales)
5608 {
5609 did_init_locales = TRUE;
5610 locales = find_locales();
5611 }
5612# endif
5613}
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005614
5615# if defined(EXITFREE) || defined(PROTO)
5616 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005617free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005618{
5619 int i;
5620 if (locales != NULL)
5621 {
5622 for (i = 0; locales[i] != NULL; i++)
5623 vim_free(locales[i]);
Bram Moolenaard23a8232018-02-10 18:45:26 +01005624 VIM_CLEAR(locales);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005625 }
5626}
5627# endif
5628
Bram Moolenaar071d4272004-06-13 20:20:40 +00005629/*
5630 * Function given to ExpandGeneric() to obtain the possible arguments of the
5631 * ":language" command.
5632 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005633 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005634get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635{
5636 if (idx == 0)
5637 return (char_u *)"messages";
5638 if (idx == 1)
5639 return (char_u *)"ctype";
5640 if (idx == 2)
5641 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005642
5643 init_locales();
5644 if (locales == NULL)
5645 return NULL;
5646 return locales[idx - 3];
5647}
5648
5649/*
5650 * Function given to ExpandGeneric() to obtain the available locales.
5651 */
5652 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005653get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005654{
5655 init_locales();
5656 if (locales == NULL)
5657 return NULL;
5658 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659}
5660# endif
5661
5662#endif