blob: 0e332dd421e833cc608289d57162cfa98fa00cc6 [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* vi:set ts=8 sts=4 sw=4:
2 *
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
76/*
77 * do_debug(): Debug mode.
78 * Repeatedly get Ex commands, until told to continue normal execution.
79 */
80 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010081do_debug(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +000082{
83 int save_msg_scroll = msg_scroll;
84 int save_State = State;
85 int save_did_emsg = did_emsg;
86 int save_cmd_silent = cmd_silent;
87 int save_msg_silent = msg_silent;
88 int save_emsg_silent = emsg_silent;
89 int save_redir_off = redir_off;
90 tasave_T typeaheadbuf;
Bram Moolenaaree3f7a52008-01-01 13:17:56 +000091 int typeahead_saved = FALSE;
Bram Moolenaar383c6f52008-01-04 15:01:07 +000092 int save_ignore_script = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000093 int save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 int n;
95 char_u *cmdline = NULL;
96 char_u *p;
97 char *tail = NULL;
98 static int last_cmd = 0;
99#define CMD_CONT 1
100#define CMD_NEXT 2
101#define CMD_STEP 3
102#define CMD_FINISH 4
103#define CMD_QUIT 5
104#define CMD_INTERRUPT 6
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100105#define CMD_BACKTRACE 7
106#define CMD_FRAME 8
107#define CMD_UP 9
108#define CMD_DOWN 10
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110#ifdef ALWAYS_USE_GUI
111 /* Can't do this when there is no terminal for input/output. */
112 if (!gui.in_use)
113 {
114 /* Break as soon as possible. */
115 debug_break_level = 9999;
116 return;
117 }
118#endif
119
120 /* Make sure we are in raw mode and start termcap mode. Might have side
121 * effects... */
122 settmode(TMODE_RAW);
123 starttermcap();
124
125 ++RedrawingDisabled; /* don't redisplay the window */
126 ++no_wait_return; /* don't wait for return */
127 did_emsg = FALSE; /* don't use error from debugged stuff */
128 cmd_silent = FALSE; /* display commands */
129 msg_silent = FALSE; /* display messages */
130 emsg_silent = FALSE; /* display error messages */
131 redir_off = TRUE; /* don't redirect debug commands */
132
133 State = NORMAL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134
135 if (!debug_did_msg)
136 MSG(_("Entering Debug mode. Type \"cont\" to continue."));
137 if (sourcing_name != NULL)
138 msg(sourcing_name);
139 if (sourcing_lnum != 0)
Bram Moolenaar555b2802005-05-19 21:08:39 +0000140 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141 else
Bram Moolenaar555b2802005-05-19 21:08:39 +0000142 smsg((char_u *)_("cmd: %s"), cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143
144 /*
145 * Repeat getting a command and executing it.
146 */
147 for (;;)
148 {
149 msg_scroll = TRUE;
150 need_wait_return = FALSE;
Bram Moolenaar85b11762016-02-27 18:13:23 +0100151
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152 /* Save the current typeahead buffer and replace it with an empty one.
153 * This makes sure we get input from the user here and don't interfere
154 * with the commands being executed. Reset "ex_normal_busy" to avoid
155 * the side effects of using ":normal". Save the stuff buffer and make
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000156 * it empty. Set ignore_script to avoid reading from script input. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157 save_ex_normal_busy = ex_normal_busy;
158 ex_normal_busy = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 if (!debug_greedy)
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000160 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161 save_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000162 typeahead_saved = TRUE;
163 save_ignore_script = ignore_script;
164 ignore_script = TRUE;
165 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166
Bram Moolenaardc303bc2016-05-17 17:45:38 +0200167 vim_free(cmdline);
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000168 cmdline = getcmdline_prompt('>', NULL, 0, EXPAND_NOTHING, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000170 if (typeahead_saved)
171 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172 restore_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000173 ignore_script = save_ignore_script;
174 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175 ex_normal_busy = save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000176
177 cmdline_row = msg_row;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100178 msg_starthere();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000179 if (cmdline != NULL)
180 {
181 /* If this is a debug command, set "last_cmd".
182 * If not, reset "last_cmd".
183 * For a blank line use previous command. */
184 p = skipwhite(cmdline);
185 if (*p != NUL)
186 {
187 switch (*p)
188 {
189 case 'c': last_cmd = CMD_CONT;
190 tail = "ont";
191 break;
192 case 'n': last_cmd = CMD_NEXT;
193 tail = "ext";
194 break;
195 case 's': last_cmd = CMD_STEP;
196 tail = "tep";
197 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100198 case 'f':
199 last_cmd = 0;
200 if (p[1] == 'r')
201 {
202 last_cmd = CMD_FRAME;
203 tail = "rame";
204 }
205 else
206 {
207 last_cmd = CMD_FINISH;
208 tail = "inish";
209 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000210 break;
211 case 'q': last_cmd = CMD_QUIT;
212 tail = "uit";
213 break;
214 case 'i': last_cmd = CMD_INTERRUPT;
215 tail = "nterrupt";
216 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100217 case 'b': last_cmd = CMD_BACKTRACE;
218 if (p[1] == 't')
219 tail = "t";
220 else
221 tail = "acktrace";
222 break;
223 case 'w': last_cmd = CMD_BACKTRACE;
224 tail = "here";
225 break;
226 case 'u': last_cmd = CMD_UP;
227 tail = "p";
228 break;
229 case 'd': last_cmd = CMD_DOWN;
230 tail = "own";
231 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000232 default: last_cmd = 0;
233 }
234 if (last_cmd != 0)
235 {
236 /* Check that the tail matches. */
237 ++p;
238 while (*p != NUL && *p == *tail)
239 {
240 ++p;
241 ++tail;
242 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100243 if (ASCII_ISALPHA(*p) && last_cmd != CMD_FRAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000244 last_cmd = 0;
245 }
246 }
247
248 if (last_cmd != 0)
249 {
250 /* Execute debug command: decided where to break next and
251 * return. */
252 switch (last_cmd)
253 {
254 case CMD_CONT:
255 debug_break_level = -1;
256 break;
257 case CMD_NEXT:
258 debug_break_level = ex_nesting_level;
259 break;
260 case CMD_STEP:
261 debug_break_level = 9999;
262 break;
263 case CMD_FINISH:
264 debug_break_level = ex_nesting_level - 1;
265 break;
266 case CMD_QUIT:
267 got_int = TRUE;
268 debug_break_level = -1;
269 break;
270 case CMD_INTERRUPT:
271 got_int = TRUE;
272 debug_break_level = 9999;
273 /* Do not repeat ">interrupt" cmd, continue stepping. */
274 last_cmd = CMD_STEP;
275 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100276 case CMD_BACKTRACE:
277 do_showbacktrace(cmd);
278 continue;
279 case CMD_FRAME:
280 if (*p == NUL)
281 {
282 do_showbacktrace(cmd);
283 }
284 else
285 {
286 p = skipwhite(p);
287 do_setdebugtracelevel(p);
288 }
289 continue;
290 case CMD_UP:
291 debug_backtrace_level++;
292 do_checkbacktracelevel();
293 continue;
294 case CMD_DOWN:
295 debug_backtrace_level--;
296 do_checkbacktracelevel();
297 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100299 /* Going out reset backtrace_level */
300 debug_backtrace_level = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000301 break;
302 }
303
304 /* don't debug this command */
305 n = debug_break_level;
306 debug_break_level = -1;
307 (void)do_cmdline(cmdline, getexline, NULL,
308 DOCMD_VERBOSE|DOCMD_EXCRESET);
309 debug_break_level = n;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310 }
311 lines_left = Rows - 1;
312 }
313 vim_free(cmdline);
314
315 --RedrawingDisabled;
316 --no_wait_return;
317 redraw_all_later(NOT_VALID);
318 need_wait_return = FALSE;
319 msg_scroll = save_msg_scroll;
320 lines_left = Rows - 1;
321 State = save_State;
322 did_emsg = save_did_emsg;
323 cmd_silent = save_cmd_silent;
324 msg_silent = save_msg_silent;
325 emsg_silent = save_emsg_silent;
326 redir_off = save_redir_off;
327
328 /* Only print the message again when typing a command before coming back
329 * here. */
330 debug_did_msg = TRUE;
331}
332
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100333 static int
334get_maxbacktrace_level(void)
335{
336 char *p, *q;
Bram Moolenaardc633cf2016-04-23 14:33:19 +0200337 int maxbacktrace = 0;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100338
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100339 if (sourcing_name != NULL)
340 {
341 p = (char *)sourcing_name;
342 while ((q = strstr(p, "..")) != NULL)
343 {
344 p = q + 2;
345 maxbacktrace++;
346 }
347 }
348 return maxbacktrace;
349}
350
351 static void
352do_setdebugtracelevel(char_u *arg)
353{
354 int level;
355
356 level = atoi((char *)arg);
357 if (*arg == '+' || level < 0)
358 debug_backtrace_level += level;
359 else
360 debug_backtrace_level = level;
361
362 do_checkbacktracelevel();
363}
364
365 static void
366do_checkbacktracelevel(void)
367{
368 if (debug_backtrace_level < 0)
369 {
370 debug_backtrace_level = 0;
371 MSG(_("frame is zero"));
372 }
373 else
374 {
375 int max = get_maxbacktrace_level();
376
377 if (debug_backtrace_level > max)
378 {
379 debug_backtrace_level = max;
380 smsg((char_u *)_("frame at highest level: %d"), max);
381 }
382 }
383}
384
385 static void
386do_showbacktrace(char_u *cmd)
387{
388 char *cur;
389 char *next;
390 int i = 0;
391 int max = get_maxbacktrace_level();
392
393 if (sourcing_name != NULL)
394 {
395 cur = (char *)sourcing_name;
396 while (!got_int)
397 {
398 next = strstr(cur, "..");
399 if (next != NULL)
400 *next = NUL;
401 if (i == max - debug_backtrace_level)
402 smsg((char_u *)"->%d %s", max - i, cur);
403 else
404 smsg((char_u *)" %d %s", max - i, cur);
405 ++i;
406 if (next == NULL)
407 break;
408 *next = '.';
409 cur = next + 2;
410 }
411 }
412 if (sourcing_lnum != 0)
413 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
414 else
415 smsg((char_u *)_("cmd: %s"), cmd);
416}
417
Bram Moolenaar071d4272004-06-13 20:20:40 +0000418/*
419 * ":debug".
420 */
421 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100422ex_debug(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423{
424 int debug_break_level_save = debug_break_level;
425
426 debug_break_level = 9999;
427 do_cmdline_cmd(eap->arg);
428 debug_break_level = debug_break_level_save;
429}
430
431static char_u *debug_breakpoint_name = NULL;
432static linenr_T debug_breakpoint_lnum;
433
434/*
435 * When debugging or a breakpoint is set on a skipped command, no debug prompt
436 * is shown by do_one_cmd(). This situation is indicated by debug_skipped, and
437 * debug_skipped_name is then set to the source name in the breakpoint case. If
438 * a skipped command decides itself that a debug prompt should be displayed, it
439 * can do so by calling dbg_check_skipped().
440 */
441static int debug_skipped;
442static char_u *debug_skipped_name;
443
444/*
445 * Go to debug mode when a breakpoint was encountered or "ex_nesting_level" is
446 * at or below the break level. But only when the line is actually
447 * executed. Return TRUE and set breakpoint_name for skipped commands that
448 * decide to execute something themselves.
449 * Called from do_one_cmd() before executing a command.
450 */
451 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100452dbg_check_breakpoint(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000453{
454 char_u *p;
455
456 debug_skipped = FALSE;
457 if (debug_breakpoint_name != NULL)
458 {
459 if (!eap->skip)
460 {
461 /* replace K_SNR with "<SNR>" */
462 if (debug_breakpoint_name[0] == K_SPECIAL
463 && debug_breakpoint_name[1] == KS_EXTRA
464 && debug_breakpoint_name[2] == (int)KE_SNR)
465 p = (char_u *)"<SNR>";
466 else
467 p = (char_u *)"";
Bram Moolenaar555b2802005-05-19 21:08:39 +0000468 smsg((char_u *)_("Breakpoint in \"%s%s\" line %ld"),
469 p,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000470 debug_breakpoint_name + (*p == NUL ? 0 : 3),
471 (long)debug_breakpoint_lnum);
472 debug_breakpoint_name = NULL;
473 do_debug(eap->cmd);
474 }
475 else
476 {
477 debug_skipped = TRUE;
478 debug_skipped_name = debug_breakpoint_name;
479 debug_breakpoint_name = NULL;
480 }
481 }
482 else if (ex_nesting_level <= debug_break_level)
483 {
484 if (!eap->skip)
485 do_debug(eap->cmd);
486 else
487 {
488 debug_skipped = TRUE;
489 debug_skipped_name = NULL;
490 }
491 }
492}
493
494/*
495 * Go to debug mode if skipped by dbg_check_breakpoint() because eap->skip was
496 * set. Return TRUE when the debug mode is entered this time.
497 */
498 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100499dbg_check_skipped(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500{
501 int prev_got_int;
502
503 if (debug_skipped)
504 {
505 /*
506 * Save the value of got_int and reset it. We don't want a previous
507 * interruption cause flushing the input buffer.
508 */
509 prev_got_int = got_int;
510 got_int = FALSE;
511 debug_breakpoint_name = debug_skipped_name;
512 /* eap->skip is TRUE */
513 eap->skip = FALSE;
514 (void)dbg_check_breakpoint(eap);
515 eap->skip = TRUE;
516 got_int |= prev_got_int;
517 return TRUE;
518 }
519 return FALSE;
520}
521
522/*
523 * The list of breakpoints: dbg_breakp.
524 * This is a grow-array of structs.
525 */
526struct debuggy
527{
528 int dbg_nr; /* breakpoint number */
529 int dbg_type; /* DBG_FUNC or DBG_FILE */
530 char_u *dbg_name; /* function or file name */
531 regprog_T *dbg_prog; /* regexp program */
532 linenr_T dbg_lnum; /* line number in function or file */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000533 int dbg_forceit; /* ! used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000534};
535
536static garray_T dbg_breakp = {0, 0, sizeof(struct debuggy), 4, NULL};
Bram Moolenaar05159a02005-02-26 23:04:13 +0000537#define BREAKP(idx) (((struct debuggy *)dbg_breakp.ga_data)[idx])
538#define DEBUGGY(gap, idx) (((struct debuggy *)gap->ga_data)[idx])
Bram Moolenaar071d4272004-06-13 20:20:40 +0000539static int last_breakp = 0; /* nr of last defined breakpoint */
540
Bram Moolenaar05159a02005-02-26 23:04:13 +0000541#ifdef FEAT_PROFILE
542/* Profiling uses file and func names similar to breakpoints. */
543static garray_T prof_ga = {0, 0, sizeof(struct debuggy), 4, NULL};
544#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545#define DBG_FUNC 1
546#define DBG_FILE 2
547
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100548static int dbg_parsearg(char_u *arg, garray_T *gap);
549static linenr_T debuggy_find(int file,char_u *fname, linenr_T after, garray_T *gap, int *fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550
551/*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000552 * Parse the arguments of ":profile", ":breakadd" or ":breakdel" and put them
553 * in the entry just after the last one in dbg_breakp. Note that "dbg_name"
554 * is allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555 * Returns FAIL for failure.
556 */
557 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100558dbg_parsearg(
559 char_u *arg,
560 garray_T *gap) /* either &dbg_breakp or &prof_ga */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000561{
562 char_u *p = arg;
563 char_u *q;
564 struct debuggy *bp;
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000565 int here = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000566
Bram Moolenaar05159a02005-02-26 23:04:13 +0000567 if (ga_grow(gap, 1) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568 return FAIL;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000569 bp = &DEBUGGY(gap, gap->ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570
571 /* Find "func" or "file". */
572 if (STRNCMP(p, "func", 4) == 0)
573 bp->dbg_type = DBG_FUNC;
574 else if (STRNCMP(p, "file", 4) == 0)
575 bp->dbg_type = DBG_FILE;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000576 else if (
577#ifdef FEAT_PROFILE
578 gap != &prof_ga &&
579#endif
580 STRNCMP(p, "here", 4) == 0)
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000581 {
582 if (curbuf->b_ffname == NULL)
583 {
584 EMSG(_(e_noname));
585 return FAIL;
586 }
587 bp->dbg_type = DBG_FILE;
588 here = TRUE;
589 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000590 else
591 {
592 EMSG2(_(e_invarg2), p);
593 return FAIL;
594 }
595 p = skipwhite(p + 4);
596
597 /* Find optional line number. */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000598 if (here)
599 bp->dbg_lnum = curwin->w_cursor.lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000600 else if (
601#ifdef FEAT_PROFILE
602 gap != &prof_ga &&
603#endif
604 VIM_ISDIGIT(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000605 {
606 bp->dbg_lnum = getdigits(&p);
607 p = skipwhite(p);
608 }
609 else
610 bp->dbg_lnum = 0;
611
612 /* Find the function or file name. Don't accept a function name with (). */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000613 if ((!here && *p == NUL)
614 || (here && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 || (bp->dbg_type == DBG_FUNC && strstr((char *)p, "()") != NULL))
616 {
617 EMSG2(_(e_invarg2), arg);
618 return FAIL;
619 }
620
621 if (bp->dbg_type == DBG_FUNC)
622 bp->dbg_name = vim_strsave(p);
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000623 else if (here)
624 bp->dbg_name = vim_strsave(curbuf->b_ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000625 else
626 {
627 /* Expand the file name in the same way as do_source(). This means
628 * doing it twice, so that $DIR/file gets expanded when $DIR is
629 * "~/dir". */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630 q = expand_env_save(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000631 if (q == NULL)
632 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 p = expand_env_save(q);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634 vim_free(q);
635 if (p == NULL)
636 return FAIL;
Bram Moolenaar843ee412004-06-30 16:16:41 +0000637 if (*p != '*')
638 {
639 bp->dbg_name = fix_fname(p);
640 vim_free(p);
641 }
642 else
643 bp->dbg_name = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644 }
645
646 if (bp->dbg_name == NULL)
647 return FAIL;
648 return OK;
649}
650
651/*
652 * ":breakadd".
653 */
654 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100655ex_breakadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656{
657 struct debuggy *bp;
658 char_u *pat;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000659 garray_T *gap;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660
Bram Moolenaar05159a02005-02-26 23:04:13 +0000661 gap = &dbg_breakp;
662#ifdef FEAT_PROFILE
663 if (eap->cmdidx == CMD_profile)
664 gap = &prof_ga;
665#endif
666
667 if (dbg_parsearg(eap->arg, gap) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000669 bp = &DEBUGGY(gap, gap->ga_len);
670 bp->dbg_forceit = eap->forceit;
671
Bram Moolenaar071d4272004-06-13 20:20:40 +0000672 pat = file_pat_to_reg_pat(bp->dbg_name, NULL, NULL, FALSE);
673 if (pat != NULL)
674 {
675 bp->dbg_prog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
676 vim_free(pat);
677 }
678 if (pat == NULL || bp->dbg_prog == NULL)
679 vim_free(bp->dbg_name);
680 else
681 {
682 if (bp->dbg_lnum == 0) /* default line number is 1 */
683 bp->dbg_lnum = 1;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000684#ifdef FEAT_PROFILE
685 if (eap->cmdidx != CMD_profile)
686#endif
687 {
688 DEBUGGY(gap, gap->ga_len).dbg_nr = ++last_breakp;
689 ++debug_tick;
690 }
691 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 }
693 }
694}
695
696/*
697 * ":debuggreedy".
698 */
699 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100700ex_debuggreedy(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000701{
702 if (eap->addr_count == 0 || eap->line2 != 0)
703 debug_greedy = TRUE;
704 else
705 debug_greedy = FALSE;
706}
707
708/*
Bram Moolenaard9fba312005-06-26 22:34:35 +0000709 * ":breakdel" and ":profdel".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000710 */
711 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100712ex_breakdel(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000713{
714 struct debuggy *bp, *bpi;
715 int nr;
716 int todel = -1;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000717 int del_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000718 int i;
719 linenr_T best_lnum = 0;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000720 garray_T *gap;
721
722 gap = &dbg_breakp;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000723 if (eap->cmdidx == CMD_profdel)
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200724 {
725#ifdef FEAT_PROFILE
Bram Moolenaard9fba312005-06-26 22:34:35 +0000726 gap = &prof_ga;
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200727#else
728 ex_ni(eap);
729 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000730#endif
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200731 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732
733 if (vim_isdigit(*eap->arg))
734 {
735 /* ":breakdel {nr}" */
736 nr = atol((char *)eap->arg);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000737 for (i = 0; i < gap->ga_len; ++i)
738 if (DEBUGGY(gap, i).dbg_nr == nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 {
740 todel = i;
741 break;
742 }
743 }
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000744 else if (*eap->arg == '*')
745 {
746 todel = 0;
747 del_all = TRUE;
748 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 else
750 {
751 /* ":breakdel {func|file} [lnum] {name}" */
Bram Moolenaard9fba312005-06-26 22:34:35 +0000752 if (dbg_parsearg(eap->arg, gap) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000753 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000754 bp = &DEBUGGY(gap, gap->ga_len);
755 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000756 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000757 bpi = &DEBUGGY(gap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758 if (bp->dbg_type == bpi->dbg_type
759 && STRCMP(bp->dbg_name, bpi->dbg_name) == 0
760 && (bp->dbg_lnum == bpi->dbg_lnum
761 || (bp->dbg_lnum == 0
762 && (best_lnum == 0
763 || bpi->dbg_lnum < best_lnum))))
764 {
765 todel = i;
766 best_lnum = bpi->dbg_lnum;
767 }
768 }
769 vim_free(bp->dbg_name);
770 }
771
772 if (todel < 0)
773 EMSG2(_("E161: Breakpoint not found: %s"), eap->arg);
774 else
Bram Moolenaard9fba312005-06-26 22:34:35 +0000775 {
776 while (gap->ga_len > 0)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000777 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000778 vim_free(DEBUGGY(gap, todel).dbg_name);
Bram Moolenaar473de612013-06-08 18:19:48 +0200779 vim_regfree(DEBUGGY(gap, todel).dbg_prog);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000780 --gap->ga_len;
781 if (todel < gap->ga_len)
782 mch_memmove(&DEBUGGY(gap, todel), &DEBUGGY(gap, todel + 1),
783 (gap->ga_len - todel) * sizeof(struct debuggy));
784#ifdef FEAT_PROFILE
785 if (eap->cmdidx == CMD_breakdel)
786#endif
787 ++debug_tick;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000788 if (!del_all)
789 break;
790 }
Bram Moolenaard9fba312005-06-26 22:34:35 +0000791
792 /* If all breakpoints were removed clear the array. */
793 if (gap->ga_len == 0)
794 ga_clear(gap);
795 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000796}
797
798/*
799 * ":breaklist".
800 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100802ex_breaklist(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803{
804 struct debuggy *bp;
805 int i;
806
807 if (dbg_breakp.ga_len == 0)
808 MSG(_("No breakpoints defined"));
809 else
810 for (i = 0; i < dbg_breakp.ga_len; ++i)
811 {
812 bp = &BREAKP(i);
Bram Moolenaard58ea072011-06-26 04:25:30 +0200813 if (bp->dbg_type == DBG_FILE)
814 home_replace(NULL, bp->dbg_name, NameBuff, MAXPATHL, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000815 smsg((char_u *)_("%3d %s %s line %ld"),
816 bp->dbg_nr,
817 bp->dbg_type == DBG_FUNC ? "func" : "file",
Bram Moolenaard58ea072011-06-26 04:25:30 +0200818 bp->dbg_type == DBG_FUNC ? bp->dbg_name : NameBuff,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000819 (long)bp->dbg_lnum);
820 }
821}
822
823/*
824 * Find a breakpoint for a function or sourced file.
825 * Returns line number at which to break; zero when no matching breakpoint.
826 */
827 linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100828dbg_find_breakpoint(
829 int file, /* TRUE for a file, FALSE for a function */
830 char_u *fname, /* file or function name */
831 linenr_T after) /* after this line number */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000832{
Bram Moolenaar05159a02005-02-26 23:04:13 +0000833 return debuggy_find(file, fname, after, &dbg_breakp, NULL);
834}
835
836#if defined(FEAT_PROFILE) || defined(PROTO)
837/*
838 * Return TRUE if profiling is on for a function or sourced file.
839 */
840 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100841has_profiling(
842 int file, /* TRUE for a file, FALSE for a function */
843 char_u *fname, /* file or function name */
844 int *fp) /* return: forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000845{
846 return (debuggy_find(file, fname, (linenr_T)0, &prof_ga, fp)
847 != (linenr_T)0);
848}
849#endif
850
851/*
852 * Common code for dbg_find_breakpoint() and has_profiling().
853 */
854 static linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100855debuggy_find(
856 int file, /* TRUE for a file, FALSE for a function */
857 char_u *fname, /* file or function name */
858 linenr_T after, /* after this line number */
859 garray_T *gap, /* either &dbg_breakp or &prof_ga */
860 int *fp) /* if not NULL: return forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000861{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862 struct debuggy *bp;
863 int i;
864 linenr_T lnum = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000865 char_u *name = fname;
866 int prev_got_int;
867
Bram Moolenaar05159a02005-02-26 23:04:13 +0000868 /* Return quickly when there are no breakpoints. */
869 if (gap->ga_len == 0)
870 return (linenr_T)0;
871
Bram Moolenaar071d4272004-06-13 20:20:40 +0000872 /* Replace K_SNR in function name with "<SNR>". */
873 if (!file && fname[0] == K_SPECIAL)
874 {
875 name = alloc((unsigned)STRLEN(fname) + 3);
876 if (name == NULL)
877 name = fname;
878 else
879 {
880 STRCPY(name, "<SNR>");
881 STRCPY(name + 5, fname + 3);
882 }
883 }
884
Bram Moolenaar05159a02005-02-26 23:04:13 +0000885 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000887 /* Skip entries that are not useful or are for a line that is beyond
888 * an already found breakpoint. */
889 bp = &DEBUGGY(gap, i);
890 if (((bp->dbg_type == DBG_FILE) == file && (
891#ifdef FEAT_PROFILE
892 gap == &prof_ga ||
893#endif
894 (bp->dbg_lnum > after && (lnum == 0 || bp->dbg_lnum < lnum)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000895 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000896 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000897 * Save the value of got_int and reset it. We don't want a
898 * previous interruption cancel matching, only hitting CTRL-C
899 * while matching should abort it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000900 */
901 prev_got_int = got_int;
902 got_int = FALSE;
Bram Moolenaardffa5b82014-11-19 16:38:07 +0100903 if (vim_regexec_prog(&bp->dbg_prog, FALSE, name, (colnr_T)0))
Bram Moolenaar05159a02005-02-26 23:04:13 +0000904 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905 lnum = bp->dbg_lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000906 if (fp != NULL)
907 *fp = bp->dbg_forceit;
908 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000909 got_int |= prev_got_int;
910 }
911 }
912 if (name != fname)
913 vim_free(name);
914
915 return lnum;
916}
917
918/*
919 * Called when a breakpoint was encountered.
920 */
921 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100922dbg_breakpoint(char_u *name, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923{
924 /* We need to check if this line is actually executed in do_one_cmd() */
925 debug_breakpoint_name = name;
926 debug_breakpoint_lnum = lnum;
927}
Bram Moolenaar05159a02005-02-26 23:04:13 +0000928
929
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000930# if defined(FEAT_PROFILE) || defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000931/*
932 * Store the current time in "tm".
933 */
934 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100935profile_start(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000936{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000937# ifdef WIN3264
938 QueryPerformanceCounter(tm);
939# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000940 gettimeofday(tm, NULL);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000941# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000942}
943
944/*
945 * Compute the elapsed time from "tm" till now and store in "tm".
946 */
947 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100948profile_end(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000949{
950 proftime_T now;
951
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000952# ifdef WIN3264
953 QueryPerformanceCounter(&now);
954 tm->QuadPart = now.QuadPart - tm->QuadPart;
955# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000956 gettimeofday(&now, NULL);
957 tm->tv_usec = now.tv_usec - tm->tv_usec;
958 tm->tv_sec = now.tv_sec - tm->tv_sec;
959 if (tm->tv_usec < 0)
960 {
961 tm->tv_usec += 1000000;
962 --tm->tv_sec;
963 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000964# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000965}
966
967/*
968 * Subtract the time "tm2" from "tm".
969 */
970 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100971profile_sub(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000972{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000973# ifdef WIN3264
974 tm->QuadPart -= tm2->QuadPart;
975# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000976 tm->tv_usec -= tm2->tv_usec;
977 tm->tv_sec -= tm2->tv_sec;
978 if (tm->tv_usec < 0)
979 {
980 tm->tv_usec += 1000000;
981 --tm->tv_sec;
982 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000983# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000984}
985
986/*
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000987 * Return a string that represents the time in "tm".
988 * Uses a static buffer!
989 */
990 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100991profile_msg(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000992{
993 static char buf[50];
994
995# ifdef WIN3264
996 LARGE_INTEGER fr;
997
998 QueryPerformanceFrequency(&fr);
999 sprintf(buf, "%10.6lf", (double)tm->QuadPart / (double)fr.QuadPart);
1000# else
1001 sprintf(buf, "%3ld.%06ld", (long)tm->tv_sec, (long)tm->tv_usec);
Bram Moolenaar76929292008-01-06 19:07:36 +00001002# endif
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001003 return buf;
1004}
1005
Bram Moolenaar79c2c882016-02-07 21:19:28 +01001006# if defined(FEAT_FLOAT) || defined(PROTO)
1007/*
1008 * Return a float that represents the time in "tm".
1009 */
1010 float_T
1011profile_float(proftime_T *tm)
1012{
1013# ifdef WIN3264
1014 LARGE_INTEGER fr;
1015
1016 QueryPerformanceFrequency(&fr);
1017 return (float_T)tm->QuadPart / (float_T)fr.QuadPart;
1018# else
1019 return (float_T)tm->tv_sec + (float_T)tm->tv_usec / 1000000.0;
1020# endif
1021}
1022# endif
1023
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001024/*
Bram Moolenaar76929292008-01-06 19:07:36 +00001025 * Put the time "msec" past now in "tm".
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001026 */
Bram Moolenaar76929292008-01-06 19:07:36 +00001027 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001028profile_setlimit(long msec, proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001029{
1030 if (msec <= 0) /* no limit */
1031 profile_zero(tm);
1032 else
1033 {
1034# ifdef WIN3264
1035 LARGE_INTEGER fr;
1036
1037 QueryPerformanceCounter(tm);
1038 QueryPerformanceFrequency(&fr);
Bram Moolenaarb3c70982008-01-18 10:40:55 +00001039 tm->QuadPart += (LONGLONG)((double)msec / 1000.0 * (double)fr.QuadPart);
Bram Moolenaar76929292008-01-06 19:07:36 +00001040# else
1041 long usec;
1042
1043 gettimeofday(tm, NULL);
1044 usec = (long)tm->tv_usec + (long)msec * 1000;
1045 tm->tv_usec = usec % 1000000L;
1046 tm->tv_sec += usec / 1000000L;
1047# endif
1048 }
1049}
1050
1051/*
1052 * Return TRUE if the current time is past "tm".
1053 */
1054 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001055profile_passed_limit(proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001056{
1057 proftime_T now;
1058
1059# ifdef WIN3264
1060 if (tm->QuadPart == 0) /* timer was not set */
1061 return FALSE;
1062 QueryPerformanceCounter(&now);
1063 return (now.QuadPart > tm->QuadPart);
1064# else
1065 if (tm->tv_sec == 0) /* timer was not set */
1066 return FALSE;
1067 gettimeofday(&now, NULL);
1068 return (now.tv_sec > tm->tv_sec
1069 || (now.tv_sec == tm->tv_sec && now.tv_usec > tm->tv_usec));
1070# endif
1071}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001072
1073/*
1074 * Set the time in "tm" to zero.
1075 */
1076 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001077profile_zero(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001078{
1079# ifdef WIN3264
1080 tm->QuadPart = 0;
1081# else
1082 tm->tv_usec = 0;
1083 tm->tv_sec = 0;
1084# endif
1085}
1086
Bram Moolenaar76929292008-01-06 19:07:36 +00001087# endif /* FEAT_PROFILE || FEAT_RELTIME */
1088
Bram Moolenaar975b5272016-03-15 23:10:59 +01001089# if defined(FEAT_TIMERS) || defined(PROTO)
1090static timer_T *first_timer = NULL;
1091static int last_timer_id = 0;
1092
1093/*
1094 * Insert a timer in the list of timers.
1095 */
1096 static void
1097insert_timer(timer_T *timer)
1098{
1099 timer->tr_next = first_timer;
1100 timer->tr_prev = NULL;
1101 if (first_timer != NULL)
1102 first_timer->tr_prev = timer;
1103 first_timer = timer;
Bram Moolenaar4231da42016-06-02 14:30:04 +02001104 did_add_timer = TRUE;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001105}
1106
1107/*
1108 * Take a timer out of the list of timers.
1109 */
1110 static void
1111remove_timer(timer_T *timer)
1112{
1113 if (timer->tr_prev == NULL)
1114 first_timer = timer->tr_next;
1115 else
1116 timer->tr_prev->tr_next = timer->tr_next;
1117 if (timer->tr_next != NULL)
1118 timer->tr_next->tr_prev = timer->tr_prev;
1119}
1120
1121 static void
1122free_timer(timer_T *timer)
1123{
Bram Moolenaar1436d8d2016-07-11 22:41:15 +02001124 free_callback(timer->tr_callback, timer->tr_partial);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001125 vim_free(timer);
1126}
1127
1128/*
1129 * Create a timer and return it. NULL if out of memory.
1130 * Caller should set the callback.
1131 */
1132 timer_T *
1133create_timer(long msec, int repeat)
1134{
1135 timer_T *timer = (timer_T *)alloc_clear(sizeof(timer_T));
1136
1137 if (timer == NULL)
1138 return NULL;
1139 timer->tr_id = ++last_timer_id;
1140 insert_timer(timer);
1141 if (repeat != 0)
1142 {
1143 timer->tr_repeat = repeat - 1;
1144 timer->tr_interval = msec;
1145 }
1146
1147 profile_setlimit(msec, &timer->tr_due);
1148 return timer;
1149}
1150
1151/*
1152 * Invoke the callback of "timer".
1153 */
1154 static void
1155timer_callback(timer_T *timer)
1156{
1157 typval_T rettv;
1158 int dummy;
1159 typval_T argv[2];
1160
1161 argv[0].v_type = VAR_NUMBER;
1162 argv[0].vval.v_number = timer->tr_id;
1163 argv[1].v_type = VAR_UNKNOWN;
1164
1165 call_func(timer->tr_callback, (int)STRLEN(timer->tr_callback),
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001166 &rettv, 1, argv, NULL, 0L, 0L, &dummy, TRUE,
Bram Moolenaar975b5272016-03-15 23:10:59 +01001167 timer->tr_partial, NULL);
1168 clear_tv(&rettv);
1169}
1170
1171/*
1172 * Call timers that are due.
1173 * Return the time in msec until the next timer is due.
1174 */
1175 long
Bram Moolenaarcf089462016-06-12 21:18:43 +02001176check_due_timer(void)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001177{
1178 timer_T *timer;
1179 long this_due;
Bram Moolenaar597385a2016-03-16 23:24:43 +01001180 long next_due = -1;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001181 proftime_T now;
1182 int did_one = FALSE;
1183# ifdef WIN3264
1184 LARGE_INTEGER fr;
1185
1186 QueryPerformanceFrequency(&fr);
1187# endif
1188 while (!got_int)
1189 {
1190 profile_start(&now);
1191 next_due = -1;
1192 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1193 {
1194# ifdef WIN3264
1195 this_due = (long)(((double)(timer->tr_due.QuadPart - now.QuadPart)
1196 / (double)fr.QuadPart) * 1000);
1197# else
1198 this_due = (timer->tr_due.tv_sec - now.tv_sec) * 1000
1199 + (timer->tr_due.tv_usec - now.tv_usec) / 1000;
1200# endif
1201 if (this_due <= 1)
1202 {
1203 remove_timer(timer);
1204 timer_callback(timer);
1205 did_one = TRUE;
1206 if (timer->tr_repeat != 0)
1207 {
1208 profile_setlimit(timer->tr_interval, &timer->tr_due);
1209 if (timer->tr_repeat > 0)
1210 --timer->tr_repeat;
1211 insert_timer(timer);
1212 }
1213 else
1214 free_timer(timer);
1215 /* the callback may do anything, start all over */
1216 break;
1217 }
1218 if (next_due == -1 || next_due > this_due)
1219 next_due = this_due;
1220 }
1221 if (timer == NULL)
1222 break;
1223 }
1224
1225 if (did_one)
1226 redraw_after_callback();
1227
1228 return next_due;
1229}
1230
1231/*
1232 * Find a timer by ID. Returns NULL if not found;
1233 */
1234 timer_T *
1235find_timer(int id)
1236{
1237 timer_T *timer;
1238
1239 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1240 if (timer->tr_id == id)
1241 break;
1242 return timer;
1243}
1244
1245
1246/*
1247 * Stop a timer and delete it.
1248 */
1249 void
1250stop_timer(timer_T *timer)
1251{
1252 remove_timer(timer);
1253 free_timer(timer);
1254}
Bram Moolenaare3188e22016-05-31 21:13:04 +02001255
1256/*
1257 * Mark references in partials of timers.
1258 */
1259 int
1260set_ref_in_timer(int copyID)
1261{
1262 int abort = FALSE;
1263 timer_T *timer;
1264 typval_T tv;
1265
1266 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1267 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001268 if (timer->tr_partial != NULL)
1269 {
1270 tv.v_type = VAR_PARTIAL;
1271 tv.vval.v_partial = timer->tr_partial;
1272 }
1273 else
1274 {
1275 tv.v_type = VAR_FUNC;
1276 tv.vval.v_string = timer->tr_callback;
1277 }
Bram Moolenaare3188e22016-05-31 21:13:04 +02001278 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
1279 }
1280 return abort;
1281}
Bram Moolenaar623e2632016-07-30 22:47:56 +02001282
1283# if defined(EXITFREE) || defined(PROTO)
1284 void
1285timer_free_all()
1286{
1287 timer_T *timer;
1288
1289 while (first_timer != NULL)
1290 {
1291 timer = first_timer;
1292 remove_timer(timer);
1293 free_timer(timer);
1294 }
1295}
1296# endif
Bram Moolenaar975b5272016-03-15 23:10:59 +01001297# endif
1298
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001299#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1300# if defined(HAVE_MATH_H)
1301# include <math.h>
1302# endif
1303
1304/*
1305 * Divide the time "tm" by "count" and store in "tm2".
1306 */
1307 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001308profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001309{
1310 if (count == 0)
1311 profile_zero(tm2);
1312 else
1313 {
1314# ifdef WIN3264
1315 tm2->QuadPart = tm->QuadPart / count;
1316# else
1317 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1318
1319 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001320 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001321# endif
1322 }
1323}
1324#endif
1325
Bram Moolenaar76929292008-01-06 19:07:36 +00001326# if defined(FEAT_PROFILE) || defined(PROTO)
1327/*
1328 * Functions for profiling.
1329 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001330static void script_do_profile(scriptitem_T *si);
1331static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001332static proftime_T prof_wait_time;
1333
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001334/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001335 * Add the time "tm2" to "tm".
1336 */
1337 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001338profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001339{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001340# ifdef WIN3264
1341 tm->QuadPart += tm2->QuadPart;
1342# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001343 tm->tv_usec += tm2->tv_usec;
1344 tm->tv_sec += tm2->tv_sec;
1345 if (tm->tv_usec >= 1000000)
1346 {
1347 tm->tv_usec -= 1000000;
1348 ++tm->tv_sec;
1349 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001350# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001351}
1352
1353/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001354 * Add the "self" time from the total time and the children's time.
1355 */
1356 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001357profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001358{
1359 /* Check that the result won't be negative. Can happen with recursive
1360 * calls. */
1361#ifdef WIN3264
1362 if (total->QuadPart <= children->QuadPart)
1363 return;
1364#else
1365 if (total->tv_sec < children->tv_sec
1366 || (total->tv_sec == children->tv_sec
1367 && total->tv_usec <= children->tv_usec))
1368 return;
1369#endif
1370 profile_add(self, total);
1371 profile_sub(self, children);
1372}
1373
1374/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001375 * Get the current waittime.
1376 */
1377 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001378profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001379{
1380 *tm = prof_wait_time;
1381}
1382
1383/*
1384 * Subtract the passed waittime since "tm" from "tma".
1385 */
1386 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001387profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001388{
1389 proftime_T tm3 = prof_wait_time;
1390
1391 profile_sub(&tm3, tm);
1392 profile_sub(tma, &tm3);
1393}
1394
1395/*
1396 * Return TRUE if "tm1" and "tm2" are equal.
1397 */
1398 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001399profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001400{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001401# ifdef WIN3264
1402 return (tm1->QuadPart == tm2->QuadPart);
1403# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001404 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001405# endif
1406}
1407
1408/*
1409 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1410 */
1411 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001412profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001413{
1414# ifdef WIN3264
1415 return (int)(tm2->QuadPart - tm1->QuadPart);
1416# else
1417 if (tm1->tv_sec == tm2->tv_sec)
1418 return tm2->tv_usec - tm1->tv_usec;
1419 return tm2->tv_sec - tm1->tv_sec;
1420# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001421}
1422
Bram Moolenaar05159a02005-02-26 23:04:13 +00001423static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001424static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001425
1426/*
1427 * ":profile cmd args"
1428 */
1429 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001430ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001431{
1432 char_u *e;
1433 int len;
1434
1435 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001436 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001437 e = skipwhite(e);
1438
1439 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1440 {
1441 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001442 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001443 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001444 profile_zero(&prof_wait_time);
1445 set_vim_var_nr(VV_PROFILING, 1L);
1446 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001447 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001448 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001449 else if (STRCMP(eap->arg, "pause") == 0)
1450 {
1451 if (do_profiling == PROF_YES)
1452 profile_start(&pause_time);
1453 do_profiling = PROF_PAUSED;
1454 }
1455 else if (STRCMP(eap->arg, "continue") == 0)
1456 {
1457 if (do_profiling == PROF_PAUSED)
1458 {
1459 profile_end(&pause_time);
1460 profile_add(&prof_wait_time, &pause_time);
1461 }
1462 do_profiling = PROF_YES;
1463 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001464 else
1465 {
1466 /* The rest is similar to ":breakadd". */
1467 ex_breakadd(eap);
1468 }
1469}
1470
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001471/* Command line expansion for :profile. */
1472static enum
1473{
1474 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001475 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001476} pexpand_what;
1477
1478static char *pexpand_cmds[] = {
1479 "start",
1480#define PROFCMD_START 0
1481 "pause",
1482#define PROFCMD_PAUSE 1
1483 "continue",
1484#define PROFCMD_CONTINUE 2
1485 "func",
1486#define PROFCMD_FUNC 3
1487 "file",
1488#define PROFCMD_FILE 4
1489 NULL
1490#define PROFCMD_LAST 5
1491};
1492
1493/*
1494 * Function given to ExpandGeneric() to obtain the profile command
1495 * specific expansion.
1496 */
1497 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001498get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001499{
1500 switch (pexpand_what)
1501 {
1502 case PEXP_SUBCMD:
1503 return (char_u *)pexpand_cmds[idx];
1504 /* case PEXP_FUNC: TODO */
1505 default:
1506 return NULL;
1507 }
1508}
1509
1510/*
1511 * Handle command line completion for :profile command.
1512 */
1513 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001514set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001515{
1516 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001517
1518 /* Default: expand subcommands. */
1519 xp->xp_context = EXPAND_PROFILE;
1520 pexpand_what = PEXP_SUBCMD;
1521 xp->xp_pattern = arg;
1522
1523 end_subcmd = skiptowhite(arg);
1524 if (*end_subcmd == NUL)
1525 return;
1526
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001527 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001528 {
1529 xp->xp_context = EXPAND_FILES;
1530 xp->xp_pattern = skipwhite(end_subcmd);
1531 return;
1532 }
1533
1534 /* TODO: expand function names after "func" */
1535 xp->xp_context = EXPAND_NOTHING;
1536}
1537
Bram Moolenaar05159a02005-02-26 23:04:13 +00001538/*
1539 * Dump the profiling info.
1540 */
1541 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001542profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001543{
1544 FILE *fd;
1545
1546 if (profile_fname != NULL)
1547 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001548 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001549 if (fd == NULL)
1550 EMSG2(_(e_notopen), profile_fname);
1551 else
1552 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001553 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001554 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001555 fclose(fd);
1556 }
1557 }
1558}
1559
1560/*
1561 * Start profiling script "fp".
1562 */
1563 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001564script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001565{
1566 si->sn_pr_count = 0;
1567 profile_zero(&si->sn_pr_total);
1568 profile_zero(&si->sn_pr_self);
1569
1570 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1571 si->sn_prl_idx = -1;
1572 si->sn_prof_on = TRUE;
1573 si->sn_pr_nest = 0;
1574}
1575
1576/*
1577 * save time when starting to invoke another script or function.
1578 */
1579 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001580script_prof_save(
1581 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001582{
1583 scriptitem_T *si;
1584
1585 if (current_SID > 0 && current_SID <= script_items.ga_len)
1586 {
1587 si = &SCRIPT_ITEM(current_SID);
1588 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1589 profile_start(&si->sn_pr_child);
1590 }
1591 profile_get_wait(tm);
1592}
1593
1594/*
1595 * Count time spent in children after invoking another script or function.
1596 */
1597 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001598script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001599{
1600 scriptitem_T *si;
1601
1602 if (current_SID > 0 && current_SID <= script_items.ga_len)
1603 {
1604 si = &SCRIPT_ITEM(current_SID);
1605 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1606 {
1607 profile_end(&si->sn_pr_child);
1608 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1609 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1610 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1611 }
1612 }
1613}
1614
1615static proftime_T inchar_time;
1616
1617/*
1618 * Called when starting to wait for the user to type a character.
1619 */
1620 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001621prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001622{
1623 profile_start(&inchar_time);
1624}
1625
1626/*
1627 * Called when finished waiting for the user to type a character.
1628 */
1629 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001630prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001631{
1632 profile_end(&inchar_time);
1633 profile_add(&prof_wait_time, &inchar_time);
1634}
1635
1636/*
1637 * Dump the profiling results for all scripts in file "fd".
1638 */
1639 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001640script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001641{
1642 int id;
1643 scriptitem_T *si;
1644 int i;
1645 FILE *sfd;
1646 sn_prl_T *pp;
1647
1648 for (id = 1; id <= script_items.ga_len; ++id)
1649 {
1650 si = &SCRIPT_ITEM(id);
1651 if (si->sn_prof_on)
1652 {
1653 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1654 if (si->sn_pr_count == 1)
1655 fprintf(fd, "Sourced 1 time\n");
1656 else
1657 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1658 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1659 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1660 fprintf(fd, "\n");
1661 fprintf(fd, "count total (s) self (s)\n");
1662
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001663 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001664 if (sfd == NULL)
1665 fprintf(fd, "Cannot open file!\n");
1666 else
1667 {
1668 for (i = 0; i < si->sn_prl_ga.ga_len; ++i)
1669 {
1670 if (vim_fgets(IObuff, IOSIZE, sfd))
1671 break;
1672 pp = &PRL_ITEM(si, i);
1673 if (pp->snp_count > 0)
1674 {
1675 fprintf(fd, "%5d ", pp->snp_count);
1676 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1677 fprintf(fd, " ");
1678 else
1679 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1680 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1681 }
1682 else
1683 fprintf(fd, " ");
1684 fprintf(fd, "%s", IObuff);
1685 }
1686 fclose(sfd);
1687 }
1688 fprintf(fd, "\n");
1689 }
1690 }
1691}
1692
1693/*
1694 * Return TRUE when a function defined in the current script should be
1695 * profiled.
1696 */
1697 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001698prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001699{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00001700 if (current_SID > 0)
1701 return SCRIPT_ITEM(current_SID).sn_pr_force;
1702 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001703}
1704
1705# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706#endif
1707
1708/*
1709 * If 'autowrite' option set, try to write the file.
1710 * Careful: autocommands may make "buf" invalid!
1711 *
1712 * return FAIL for failure, OK otherwise
1713 */
1714 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001715autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716{
Bram Moolenaar373154b2007-02-13 05:19:30 +00001717 int r;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001718 bufref_T bufref;
Bram Moolenaar373154b2007-02-13 05:19:30 +00001719
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 if (!(p_aw || p_awa) || !p_write
1721#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00001722 /* never autowrite a "nofile" or "nowrite" buffer */
1723 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00001725 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 return FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001727 set_bufref(&bufref, buf);
Bram Moolenaar373154b2007-02-13 05:19:30 +00001728 r = buf_write_all(buf, forceit);
1729
1730 /* Writing may succeed but the buffer still changed, e.g., when there is a
1731 * conversion error. We do want to return FAIL then. */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001732 if (bufref_valid(&bufref) && bufIsChanged(buf))
Bram Moolenaar373154b2007-02-13 05:19:30 +00001733 r = FAIL;
1734 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735}
1736
1737/*
1738 * flush all buffers, except the ones that are readonly
1739 */
1740 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001741autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742{
1743 buf_T *buf;
1744
1745 if (!(p_aw || p_awa) || !p_write)
1746 return;
Bram Moolenaar29323592016-07-24 22:04:11 +02001747 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001748 if (bufIsChanged(buf) && !buf->b_p_ro)
1749 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001750#ifdef FEAT_AUTOCMD
1751 bufref_T bufref;
1752
1753 set_bufref(&bufref, buf);
1754#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 (void)buf_write_all(buf, FALSE);
1756#ifdef FEAT_AUTOCMD
1757 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001758 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 buf = firstbuf;
1760#endif
1761 }
1762}
1763
1764/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001765 * Return TRUE if buffer was changed and cannot be abandoned.
1766 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001769check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770{
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001771 int forceit = (flags & CCGD_FORCEIT);
1772#ifdef FEAT_AUTOCMD
1773 bufref_T bufref;
1774
1775 set_bufref(&bufref, buf);
1776#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001777
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 if ( !forceit
1779 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001780 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
1781 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 {
1783#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1784 if ((p_confirm || cmdmod.confirm) && p_write)
1785 {
1786 buf_T *buf2;
1787 int count = 0;
1788
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001789 if (flags & CCGD_ALLBUF)
Bram Moolenaar29323592016-07-24 22:04:11 +02001790 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 if (bufIsChanged(buf2)
1792 && (buf2->b_ffname != NULL
1793# ifdef FEAT_BROWSE
1794 || cmdmod.browse
1795# endif
1796 ))
1797 ++count;
1798# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001799 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 /* Autocommand deleted buffer, oops! It's not changed now. */
1801 return FALSE;
1802# endif
1803 dialog_changed(buf, count > 1);
1804# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001805 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 /* Autocommand deleted buffer, oops! It's not changed now. */
1807 return FALSE;
1808# endif
1809 return bufIsChanged(buf);
1810 }
1811#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001812 if (flags & CCGD_EXCMD)
1813 EMSG(_(e_nowrtmsg));
1814 else
1815 EMSG(_(e_nowrtmsg_nobang));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816 return TRUE;
1817 }
1818 return FALSE;
1819}
1820
1821#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
1822
1823#if defined(FEAT_BROWSE) || defined(PROTO)
1824/*
1825 * When wanting to write a file without a file name, ask the user for a name.
1826 */
1827 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001828browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829{
1830 if (buf->b_fname == NULL)
1831 {
1832 char_u *fname;
1833
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001834 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
1835 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 if (fname != NULL)
1837 {
1838 if (setfname(buf, fname, NULL, TRUE) == OK)
1839 buf->b_flags |= BF_NOTEDITED;
1840 vim_free(fname);
1841 }
1842 }
1843}
1844#endif
1845
1846/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02001847 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 * Must check 'write' option first!
1849 */
1850 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001851dialog_changed(
1852 buf_T *buf,
1853 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001854{
Bram Moolenaard9462e32011-04-11 21:35:11 +02001855 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 int ret;
1857 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02001858 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00001860 dialog_msg(buff, _("Save changes to \"%s\"?"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 (buf->b_fname != NULL) ?
1862 buf->b_fname : (char_u *)_("Untitled"));
1863 if (checkall)
1864 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
1865 else
1866 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
1867
Bram Moolenaar8218f602012-04-25 17:32:18 +02001868 /* Init ea pseudo-structure, this is needed for the check_overwrite()
1869 * function. */
1870 ea.append = ea.forceit = FALSE;
1871
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 if (ret == VIM_YES)
1873 {
1874#ifdef FEAT_BROWSE
1875 /* May get file name, when there is none */
1876 browse_save_fname(buf);
1877#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02001878 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
1879 buf->b_fname, buf->b_ffname, FALSE) == OK)
1880 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 (void)buf_write_all(buf, FALSE);
1882 }
1883 else if (ret == VIM_NO)
1884 {
1885 unchanged(buf, TRUE);
1886 }
1887 else if (ret == VIM_ALL)
1888 {
1889 /*
1890 * Write all modified files that can be written.
1891 * Skip readonly buffers, these need to be confirmed
1892 * individually.
1893 */
Bram Moolenaar29323592016-07-24 22:04:11 +02001894 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895 {
1896 if (bufIsChanged(buf2)
1897 && (buf2->b_ffname != NULL
1898#ifdef FEAT_BROWSE
1899 || cmdmod.browse
1900#endif
1901 )
1902 && !buf2->b_p_ro)
1903 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001904#ifdef FEAT_AUTOCMD
1905 bufref_T bufref;
1906
1907 set_bufref(&bufref, buf2);
1908#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909#ifdef FEAT_BROWSE
1910 /* May get file name, when there is none */
1911 browse_save_fname(buf2);
1912#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02001913 if (buf2->b_fname != NULL && check_overwrite(&ea, buf2,
1914 buf2->b_fname, buf2->b_ffname, FALSE) == OK)
1915 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 (void)buf_write_all(buf2, FALSE);
1917#ifdef FEAT_AUTOCMD
1918 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001919 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 buf2 = firstbuf;
1921#endif
1922 }
1923 }
1924 }
1925 else if (ret == VIM_DISCARDALL)
1926 {
1927 /*
1928 * mark all buffers as unchanged
1929 */
Bram Moolenaar29323592016-07-24 22:04:11 +02001930 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 unchanged(buf2, TRUE);
1932 }
1933}
1934#endif
1935
1936/*
1937 * Return TRUE if the buffer "buf" can be abandoned, either by making it
1938 * hidden, autowriting it or unloading it.
1939 */
1940 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001941can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942{
1943 return ( P_HID(buf)
1944 || !bufIsChanged(buf)
1945 || buf->b_nwindows > 1
1946 || autowrite(buf, forceit) == OK
1947 || forceit);
1948}
1949
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001950static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001951
1952/*
1953 * Add a buffer number to "bufnrs", unless it's already there.
1954 */
1955 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001956add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001957{
1958 int i;
1959
1960 for (i = 0; i < *bufnump; ++i)
1961 if (bufnrs[i] == nr)
1962 return;
1963 bufnrs[*bufnump] = nr;
1964 *bufnump = *bufnump + 1;
1965}
1966
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967/*
1968 * Return TRUE if any buffer was changed and cannot be abandoned.
1969 * That changed buffer becomes the current buffer.
Bram Moolenaar027387f2016-01-02 22:25:52 +01001970 * When "unload" is true the current buffer is unloaded instead of making it
1971 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 */
1973 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001974check_changed_any(
1975 int hidden, /* Only check hidden buffers */
1976 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001978 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 buf_T *buf;
1980 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001981 int i;
1982 int bufnum = 0;
1983 int bufcount = 0;
1984 int *bufnrs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985#ifdef FEAT_WINDOWS
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001986 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987 win_T *wp;
1988#endif
1989
Bram Moolenaar29323592016-07-24 22:04:11 +02001990 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001991 ++bufcount;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001993 if (bufcount == 0)
1994 return FALSE;
1995
1996 bufnrs = (int *)alloc(sizeof(int) * bufcount);
1997 if (bufnrs == NULL)
1998 return FALSE;
1999
2000 /* curbuf */
2001 bufnrs[bufnum++] = curbuf->b_fnum;
2002#ifdef FEAT_WINDOWS
2003 /* buf in curtab */
2004 FOR_ALL_WINDOWS(wp)
2005 if (wp->w_buffer != curbuf)
2006 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2007
2008 /* buf in other tab */
Bram Moolenaar29323592016-07-24 22:04:11 +02002009 FOR_ALL_TABPAGES(tp)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002010 if (tp != curtab)
2011 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
2012 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2013#endif
2014 /* any other buf */
Bram Moolenaar29323592016-07-24 22:04:11 +02002015 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002016 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
2017
2018 for (i = 0; i < bufnum; ++i)
2019 {
2020 buf = buflist_findnr(bufnrs[i]);
2021 if (buf == NULL)
2022 continue;
2023 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
2024 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002025 bufref_T bufref;
2026
2027 set_bufref(&bufref, buf);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002028 /* Try auto-writing the buffer. If this fails but the buffer no
2029 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002030 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
2031 | CCGD_MULTWIN
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002032 | CCGD_ALLBUF) && bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002033 break; /* didn't save - still changes */
2034 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 }
2036
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002037 if (i >= bufnum)
2038 goto theend;
2039
2040 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 exiting = FALSE;
2042#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2043 /*
2044 * When ":confirm" used, don't give an error message.
2045 */
2046 if (!(p_confirm || cmdmod.confirm))
2047#endif
2048 {
2049 /* There must be a wait_return for this message, do_buffer()
2050 * may cause a redraw. But wait_return() is a no-op when vgetc()
2051 * is busy (Quit used from window menu), then make sure we don't
2052 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00002053 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002054 {
2055 msg_row = cmdline_row;
2056 msg_col = 0;
2057 msg_didout = FALSE;
2058 }
2059 if (EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002060 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 {
2062 save = no_wait_return;
2063 no_wait_return = FALSE;
2064 wait_return(FALSE);
2065 no_wait_return = save;
2066 }
2067 }
2068
2069#ifdef FEAT_WINDOWS
2070 /* Try to find a window that contains the buffer. */
2071 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002072 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 if (wp->w_buffer == buf)
2074 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002075# ifdef FEAT_AUTOCMD
2076 bufref_T bufref;
2077
2078 set_bufref(&bufref, buf);
2079# endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002080 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081# ifdef FEAT_AUTOCMD
2082 /* Paranoia: did autocms wipe out the buffer with changes? */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002083 if (!bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002084 {
2085 goto theend;
2086 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087# endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002088 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002089 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002090buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091#endif
2092
2093 /* Open the changed buffer in the current window. */
2094 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002095 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002097theend:
2098 vim_free(bufnrs);
2099 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100}
2101
2102/*
2103 * return FAIL if there is no file name, OK if there is one
2104 * give error message for FAIL
2105 */
2106 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002107check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108{
2109 if (curbuf->b_ffname == NULL)
2110 {
2111 EMSG(_(e_noname));
2112 return FAIL;
2113 }
2114 return OK;
2115}
2116
2117/*
2118 * flush the contents of a buffer, unless it has no file name
2119 *
2120 * return FAIL for failure, OK otherwise
2121 */
2122 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002123buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124{
2125 int retval;
2126#ifdef FEAT_AUTOCMD
2127 buf_T *old_curbuf = curbuf;
2128#endif
2129
2130 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2131 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2132 FALSE, forceit, TRUE, FALSE));
2133#ifdef FEAT_AUTOCMD
2134 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002135 {
2136 msg_source(hl_attr(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002137 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002138 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002139#endif
2140 return retval;
2141}
2142
2143/*
2144 * Code to handle the argument list.
2145 */
2146
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002147static char_u *do_one_arg(char_u *str);
2148static int do_arglist(char_u *str, int what, int after);
2149static void alist_check_arg_idx(void);
2150static int editing_arg_idx(win_T *win);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002151#ifdef FEAT_LISTCMDS
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002152static int alist_add_list(int count, char_u **files, int after);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002153#endif
2154#define AL_SET 1
2155#define AL_ADD 2
2156#define AL_DEL 3
2157
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002159 * Isolate one argument, taking backticks.
2160 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 * Return a pointer to the start of the next argument.
2162 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002163 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002164do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165{
2166 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 int inbacktick;
2168
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 inbacktick = FALSE;
2170 for (p = str; *str; ++str)
2171 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002172 /* When the backslash is used for escaping the special meaning of a
2173 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002174 if (rem_backslash(str))
2175 {
2176 *p++ = *str++;
2177 *p++ = *str;
2178 }
2179 else
2180 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002181 /* An item ends at a space not in backticks */
2182 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002184 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002186 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 }
2188 }
2189 str = skipwhite(str);
2190 *p = NUL;
2191
2192 return str;
2193}
2194
Bram Moolenaar86b68352004-12-27 21:59:20 +00002195/*
2196 * Separate the arguments in "str" and return a list of pointers in the
2197 * growarray "gap".
2198 */
2199 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002200get_arglist(garray_T *gap, char_u *str)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002201{
2202 ga_init2(gap, (int)sizeof(char_u *), 20);
2203 while (*str != NUL)
2204 {
2205 if (ga_grow(gap, 1) == FAIL)
2206 {
2207 ga_clear(gap);
2208 return FAIL;
2209 }
2210 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2211
2212 /* Isolate one argument, change it in-place, put a NUL after it. */
2213 str = do_one_arg(str);
2214 }
2215 return OK;
2216}
2217
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002218#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002219/*
2220 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002221 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002222 * Return FAIL or OK.
2223 */
2224 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002225get_arglist_exp(
2226 char_u *str,
2227 int *fcountp,
2228 char_u ***fnamesp,
2229 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002230{
2231 garray_T ga;
2232 int i;
2233
2234 if (get_arglist(&ga, str) == FAIL)
2235 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002236 if (wig == TRUE)
2237 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2238 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2239 else
2240 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2241 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2242
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002243 ga_clear(&ga);
2244 return i;
2245}
2246#endif
2247
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
2249/*
2250 * Redefine the argument list.
2251 */
2252 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002253set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002254{
2255 do_arglist(str, AL_SET, 0);
2256}
2257#endif
2258
2259/*
2260 * "what" == AL_SET: Redefine the argument list to 'str'.
2261 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2262 * "what" == AL_DEL: remove files in 'str' from the argument list.
2263 *
2264 * Return FAIL for failure, OK otherwise.
2265 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002267do_arglist(
2268 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002269 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002270 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002271{
2272 garray_T new_ga;
2273 int exp_count;
2274 char_u **exp_files;
2275 int i;
2276#ifdef FEAT_LISTCMDS
2277 char_u *p;
2278 int match;
2279#endif
2280
2281 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002282 * Set default argument for ":argadd" command.
2283 */
2284 if (what == AL_ADD && *str == NUL)
2285 {
2286 if (curbuf->b_ffname == NULL)
2287 return FAIL;
2288 str = curbuf->b_fname;
2289 }
2290
2291 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 * Collect all file name arguments in "new_ga".
2293 */
Bram Moolenaar86b68352004-12-27 21:59:20 +00002294 if (get_arglist(&new_ga, str) == FAIL)
2295 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296
2297#ifdef FEAT_LISTCMDS
2298 if (what == AL_DEL)
2299 {
2300 regmatch_T regmatch;
2301 int didone;
2302
2303 /*
2304 * Delete the items: use each item as a regexp and find a match in the
2305 * argument list.
2306 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002307 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2309 {
2310 p = ((char_u **)new_ga.ga_data)[i];
2311 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2312 if (p == NULL)
2313 break;
2314 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2315 if (regmatch.regprog == NULL)
2316 {
2317 vim_free(p);
2318 break;
2319 }
2320
2321 didone = FALSE;
2322 for (match = 0; match < ARGCOUNT; ++match)
2323 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2324 (colnr_T)0))
2325 {
2326 didone = TRUE;
2327 vim_free(ARGLIST[match].ae_fname);
2328 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2329 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2330 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331 if (curwin->w_arg_idx > match)
2332 --curwin->w_arg_idx;
2333 --match;
2334 }
2335
Bram Moolenaar473de612013-06-08 18:19:48 +02002336 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 vim_free(p);
2338 if (!didone)
2339 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2340 }
2341 ga_clear(&new_ga);
2342 }
2343 else
2344#endif
2345 {
2346 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2347 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2348 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002349 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 {
2351 EMSG(_(e_nomatch));
2352 return FAIL;
2353 }
2354
2355#ifdef FEAT_LISTCMDS
2356 if (what == AL_ADD)
2357 {
2358 (void)alist_add_list(exp_count, exp_files, after);
2359 vim_free(exp_files);
2360 }
2361 else /* what == AL_SET */
2362#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00002363 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 }
2365
2366 alist_check_arg_idx();
2367
2368 return OK;
2369}
2370
2371/*
2372 * Check the validity of the arg_idx for each other window.
2373 */
2374 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002375alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376{
2377#ifdef FEAT_WINDOWS
2378 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002379 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002380
Bram Moolenaarf740b292006-02-16 22:11:02 +00002381 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 if (win->w_alist == curwin->w_alist)
2383 check_arg_idx(win);
2384#else
2385 check_arg_idx(curwin);
2386#endif
2387}
2388
2389/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002390 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002391 * index.
2392 */
2393 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002394editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002395{
2396 return !(win->w_arg_idx >= WARGCOUNT(win)
2397 || (win->w_buffer->b_fnum
2398 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2399 && (win->w_buffer->b_ffname == NULL
2400 || !(fullpathcmp(
2401 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2402 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2403}
2404
2405/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 * Check if window "win" is editing the w_arg_idx file in its argument list.
2407 */
2408 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002409check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002411 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 {
2413 /* We are not editing the current entry in the argument list.
2414 * Set "arg_had_last" if we are editing the last one. */
2415 win->w_arg_idx_invalid = TRUE;
2416 if (win->w_arg_idx != WARGCOUNT(win) - 1
2417 && arg_had_last == FALSE
2418#ifdef FEAT_WINDOWS
2419 && ALIST(win) == &global_alist
2420#endif
2421 && GARGCOUNT > 0
2422 && win->w_arg_idx < GARGCOUNT
2423 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2424 || (win->w_buffer->b_ffname != NULL
2425 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2426 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2427 arg_had_last = TRUE;
2428 }
2429 else
2430 {
2431 /* We are editing the current entry in the argument list.
2432 * Set "arg_had_last" if it's also the last one */
2433 win->w_arg_idx_invalid = FALSE;
2434 if (win->w_arg_idx == WARGCOUNT(win) - 1
2435#ifdef FEAT_WINDOWS
2436 && win->w_alist == &global_alist
2437#endif
2438 )
2439 arg_had_last = TRUE;
2440 }
2441}
2442
2443/*
2444 * ":args", ":argslocal" and ":argsglobal".
2445 */
2446 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002447ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448{
2449 int i;
2450
2451 if (eap->cmdidx != CMD_args)
2452 {
2453#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2454 alist_unlink(ALIST(curwin));
2455 if (eap->cmdidx == CMD_argglobal)
2456 ALIST(curwin) = &global_alist;
2457 else /* eap->cmdidx == CMD_arglocal */
2458 alist_new();
2459#else
2460 ex_ni(eap);
2461 return;
2462#endif
2463 }
2464
2465 if (!ends_excmd(*eap->arg))
2466 {
2467 /*
2468 * ":args file ..": define new argument list, handle like ":next"
2469 * Also for ":argslocal file .." and ":argsglobal file ..".
2470 */
2471 ex_next(eap);
2472 }
2473 else
2474#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2475 if (eap->cmdidx == CMD_args)
2476#endif
2477 {
2478 /*
2479 * ":args": list arguments.
2480 */
2481 if (ARGCOUNT > 0)
2482 {
2483 /* Overwrite the command, for a short list there is no scrolling
2484 * required and no wait_return(). */
2485 gotocmdline(TRUE);
2486 for (i = 0; i < ARGCOUNT; ++i)
2487 {
2488 if (i == curwin->w_arg_idx)
2489 msg_putchar('[');
2490 msg_outtrans(alist_name(&ARGLIST[i]));
2491 if (i == curwin->w_arg_idx)
2492 msg_putchar(']');
2493 msg_putchar(' ');
2494 }
2495 }
2496 }
2497#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2498 else if (eap->cmdidx == CMD_arglocal)
2499 {
2500 garray_T *gap = &curwin->w_alist->al_ga;
2501
2502 /*
2503 * ":argslocal": make a local copy of the global argument list.
2504 */
2505 if (ga_grow(gap, GARGCOUNT) == OK)
2506 for (i = 0; i < GARGCOUNT; ++i)
2507 if (GARGLIST[i].ae_fname != NULL)
2508 {
2509 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2510 vim_strsave(GARGLIST[i].ae_fname);
2511 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2512 GARGLIST[i].ae_fnum;
2513 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 }
2515 }
2516#endif
2517}
2518
2519/*
2520 * ":previous", ":sprevious", ":Next" and ":sNext".
2521 */
2522 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002523ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002524{
2525 /* If past the last one already, go to the last one. */
2526 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2527 do_argfile(eap, ARGCOUNT - 1);
2528 else
2529 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2530}
2531
2532/*
2533 * ":rewind", ":first", ":sfirst" and ":srewind".
2534 */
2535 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002536ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002537{
2538 do_argfile(eap, 0);
2539}
2540
2541/*
2542 * ":last" and ":slast".
2543 */
2544 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002545ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546{
2547 do_argfile(eap, ARGCOUNT - 1);
2548}
2549
2550/*
2551 * ":argument" and ":sargument".
2552 */
2553 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002554ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555{
2556 int i;
2557
2558 if (eap->addr_count > 0)
2559 i = eap->line2 - 1;
2560 else
2561 i = curwin->w_arg_idx;
2562 do_argfile(eap, i);
2563}
2564
2565/*
2566 * Edit file "argn" of the argument lists.
2567 */
2568 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002569do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570{
2571 int other;
2572 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002573 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574
2575 if (argn < 0 || argn >= ARGCOUNT)
2576 {
2577 if (ARGCOUNT <= 1)
2578 EMSG(_("E163: There is only one file to edit"));
2579 else if (argn < 0)
2580 EMSG(_("E164: Cannot go before first file"));
2581 else
2582 EMSG(_("E165: Cannot go beyond last file"));
2583 }
2584 else
2585 {
2586 setpcmark();
2587#ifdef FEAT_GUI
2588 need_mouse_correct = TRUE;
2589#endif
2590
2591#ifdef FEAT_WINDOWS
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002592 /* split window or create new tab page first */
2593 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002594 {
2595 if (win_split(0, 0) == FAIL)
2596 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002597 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 }
2599 else
2600#endif
2601 {
2602 /*
2603 * if 'hidden' set, only check for changed file when re-editing
2604 * the same buffer
2605 */
2606 other = TRUE;
2607 if (P_HID(curbuf))
2608 {
2609 p = fix_fname(alist_name(&ARGLIST[argn]));
2610 other = otherfile(p);
2611 vim_free(p);
2612 }
2613 if ((!P_HID(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002614 && check_changed(curbuf, CCGD_AW
2615 | (other ? 0 : CCGD_MULTWIN)
2616 | (eap->forceit ? CCGD_FORCEIT : 0)
2617 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 return;
2619 }
2620
2621 curwin->w_arg_idx = argn;
2622 if (argn == ARGCOUNT - 1
2623#ifdef FEAT_WINDOWS
2624 && curwin->w_alist == &global_alist
2625#endif
2626 )
2627 arg_had_last = TRUE;
2628
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002629 /* Edit the file; always use the last known line number.
2630 * When it fails (e.g. Abort for already edited file) restore the
2631 * argument index. */
2632 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633 eap, ECMD_LAST,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002634 (P_HID(curwin->w_buffer) ? ECMD_HIDE : 0)
2635 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002636 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002638 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002639 setmark('\'');
2640 }
2641}
2642
2643/*
2644 * ":next", and commands that behave like it.
2645 */
2646 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002647ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002648{
2649 int i;
2650
2651 /*
2652 * check for changed buffer now, if this fails the argument list is not
2653 * redefined.
2654 */
2655 if ( P_HID(curbuf)
2656 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002657 || !check_changed(curbuf, CCGD_AW
2658 | (eap->forceit ? CCGD_FORCEIT : 0)
2659 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 {
2661 if (*eap->arg != NUL) /* redefine file list */
2662 {
2663 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2664 return;
2665 i = 0;
2666 }
2667 else
2668 i = curwin->w_arg_idx + (int)eap->line2;
2669 do_argfile(eap, i);
2670 }
2671}
2672
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002673#if defined(FEAT_LISTCMDS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674/*
2675 * ":argedit"
2676 */
2677 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002678ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002679{
2680 int fnum;
2681 int i;
2682 char_u *s;
2683
2684 /* Add the argument to the buffer list and get the buffer number. */
2685 fnum = buflist_add(eap->arg, BLN_LISTED);
2686
2687 /* Check if this argument is already in the argument list. */
2688 for (i = 0; i < ARGCOUNT; ++i)
2689 if (ARGLIST[i].ae_fnum == fnum)
2690 break;
2691 if (i == ARGCOUNT)
2692 {
2693 /* Can't find it, add it to the argument list. */
2694 s = vim_strsave(eap->arg);
2695 if (s == NULL)
2696 return;
2697 i = alist_add_list(1, &s,
2698 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2699 if (i < 0)
2700 return;
2701 curwin->w_arg_idx = i;
2702 }
2703
2704 alist_check_arg_idx();
2705
2706 /* Edit the argument. */
2707 do_argfile(eap, i);
2708}
2709
2710/*
2711 * ":argadd"
2712 */
2713 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002714ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715{
2716 do_arglist(eap->arg, AL_ADD,
2717 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2718#ifdef FEAT_TITLE
2719 maketitle();
2720#endif
2721}
2722
2723/*
2724 * ":argdelete"
2725 */
2726 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002727ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728{
2729 int i;
2730 int n;
2731
2732 if (eap->addr_count > 0)
2733 {
2734 /* ":1,4argdel": Delete all arguments in the range. */
2735 if (eap->line2 > ARGCOUNT)
2736 eap->line2 = ARGCOUNT;
2737 n = eap->line2 - eap->line1 + 1;
2738 if (*eap->arg != NUL || n <= 0)
2739 EMSG(_(e_invarg));
2740 else
2741 {
2742 for (i = eap->line1; i <= eap->line2; ++i)
2743 vim_free(ARGLIST[i - 1].ae_fname);
2744 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
2745 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
2746 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 if (curwin->w_arg_idx >= eap->line2)
2748 curwin->w_arg_idx -= n;
2749 else if (curwin->w_arg_idx > eap->line1)
2750 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01002751 if (ARGCOUNT == 0)
2752 curwin->w_arg_idx = 0;
2753 else if (curwin->w_arg_idx >= ARGCOUNT)
2754 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 }
2756 }
2757 else if (*eap->arg == NUL)
2758 EMSG(_(e_argreq));
2759 else
2760 do_arglist(eap->arg, AL_DEL, 0);
2761#ifdef FEAT_TITLE
2762 maketitle();
2763#endif
2764}
2765
2766/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002767 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 */
2769 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002770ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771{
2772 int i;
2773#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002774 win_T *wp;
2775 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776#endif
Bram Moolenaare25bb902015-02-27 20:33:37 +01002777 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002778 int next_fnum = 0;
2779#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
2780 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002782 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002783#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02002784 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002785 int qf_idx;
2786#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787
2788#ifndef FEAT_WINDOWS
2789 if (eap->cmdidx == CMD_windo)
2790 {
2791 ex_ni(eap);
2792 return;
2793 }
2794#endif
2795
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002796#ifndef FEAT_QUICKFIX
2797 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
2798 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2799 {
2800 ex_ni(eap);
2801 return;
2802 }
2803#endif
2804
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002806 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00002807 /* Don't do syntax HL autocommands. Skipping the syntax file is a
2808 * great speed improvement. */
2809 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02002811#ifdef FEAT_CLIPBOARD
2812 start_global_changes();
2813#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814
2815 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002816 || eap->cmdidx == CMD_tabdo
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 || P_HID(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002818 || !check_changed(curbuf, CCGD_AW
2819 | (eap->forceit ? CCGD_FORCEIT : 0)
2820 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002823 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002825 wp = firstwin;
2826 tp = first_tabpage;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002827#endif
Bram Moolenaara162bc52015-01-07 16:54:21 +01002828 switch (eap->cmdidx)
2829 {
2830#ifdef FEAT_WINDOWS
2831 case CMD_windo:
2832 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
2833 i++;
2834 break;
2835 case CMD_tabdo:
2836 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
2837 i++;
2838 break;
2839#endif
2840 case CMD_argdo:
2841 i = eap->line1 - 1;
2842 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002843 default:
2844 break;
2845 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 /* set pcmark now */
2847 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002848 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01002849 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002850 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01002851 || !buf->b_p_bl); buf = buf->b_next)
2852 if (buf->b_fnum > eap->line2)
2853 {
2854 buf = NULL;
2855 break;
2856 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002857 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01002858 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002859 }
2860#ifdef FEAT_QUICKFIX
2861 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
2862 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2863 {
2864 qf_size = qf_get_size(eap);
2865 if (qf_size <= 0 || eap->line1 > qf_size)
2866 buf = NULL;
2867 else
2868 {
2869 ex_cc(eap);
2870
2871 buf = curbuf;
2872 i = eap->line1 - 1;
2873 if (eap->addr_count <= 0)
2874 /* default is all the quickfix/location list entries */
2875 eap->line2 = qf_size;
2876 }
2877 }
2878#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002879 else
2880 setpcmark();
2881 listcmd_busy = TRUE; /* avoids setting pcmark below */
2882
Bram Moolenaare25bb902015-02-27 20:33:37 +01002883 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884 {
2885 if (eap->cmdidx == CMD_argdo)
2886 {
2887 /* go to argument "i" */
2888 if (i == ARGCOUNT)
2889 break;
2890 /* Don't call do_argfile() when already there, it will try
2891 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002892 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002893 {
2894 /* Clear 'shm' to avoid that the file message overwrites
2895 * any output from the command. */
2896 p_shm_save = vim_strsave(p_shm);
2897 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002899 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
2900 vim_free(p_shm_save);
2901 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002902 if (curwin->w_arg_idx != i)
2903 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 }
2905#ifdef FEAT_WINDOWS
2906 else if (eap->cmdidx == CMD_windo)
2907 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002908 /* go to window "wp" */
2909 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002911 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00002912 if (curwin != wp)
2913 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002914 wp = curwin->w_next;
2915 }
2916 else if (eap->cmdidx == CMD_tabdo)
2917 {
2918 /* go to window "tp" */
2919 if (!valid_tabpage(tp))
2920 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02002921 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002922 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002923 }
2924#endif
2925 else if (eap->cmdidx == CMD_bufdo)
2926 {
2927 /* Remember the number of the next listed buffer, in case
2928 * ":bwipe" is used or autocommands do something strange. */
2929 next_fnum = -1;
2930 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
2931 if (buf->b_p_bl)
2932 {
2933 next_fnum = buf->b_fnum;
2934 break;
2935 }
2936 }
2937
Bram Moolenaara162bc52015-01-07 16:54:21 +01002938 ++i;
2939
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 /* execute the command */
2941 do_cmdline(eap->arg, eap->getline, eap->cookie,
2942 DOCMD_VERBOSE + DOCMD_NOWAIT);
2943
2944 if (eap->cmdidx == CMD_bufdo)
2945 {
2946 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01002947 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002948 break;
2949 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002950 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 if (buf->b_fnum == next_fnum)
2952 break;
2953 if (buf == NULL)
2954 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002955
2956 /* Go to the next buffer. Clear 'shm' to avoid that the file
2957 * message overwrites any output from the command. */
2958 p_shm_save = vim_strsave(p_shm);
2959 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002961 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
2962 vim_free(p_shm_save);
2963
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002964 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 if (curbuf->b_fnum != next_fnum)
2966 break;
2967 }
2968
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002969#ifdef FEAT_QUICKFIX
2970 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
2971 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2972 {
2973 if (i >= qf_size || i >= eap->line2)
2974 break;
2975
2976 qf_idx = qf_get_cur_idx(eap);
2977
2978 ex_cnext(eap);
2979
2980 /* If jumping to the next quickfix entry fails, quit here */
2981 if (qf_get_cur_idx(eap) == qf_idx)
2982 break;
2983 }
2984#endif
2985
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 if (eap->cmdidx == CMD_windo)
2987 {
2988 validate_cursor(); /* cursor may have moved */
2989#ifdef FEAT_SCROLLBIND
2990 /* required when 'scrollbind' has been set */
2991 if (curwin->w_p_scb)
2992 do_check_scrollbind(TRUE);
2993#endif
2994 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01002995
2996#ifdef FEAT_WINDOWS
2997 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
2998 if (i+1 > eap->line2)
2999 break;
3000#endif
3001 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
3002 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 }
3004 listcmd_busy = FALSE;
3005 }
3006
3007#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003008 if (save_ei != NULL)
3009 {
3010 au_event_restore(save_ei);
3011 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
3012 curbuf->b_fname, TRUE, curbuf);
3013 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003015#ifdef FEAT_CLIPBOARD
3016 end_global_changes();
3017#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018}
3019
3020/*
3021 * Add files[count] to the arglist of the current window after arg "after".
3022 * The file names in files[count] must have been allocated and are taken over.
3023 * Files[] itself is not taken over.
3024 * Returns index of first added argument. Returns -1 when failed (out of mem).
3025 */
3026 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003027alist_add_list(
3028 int count,
3029 char_u **files,
3030 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031{
3032 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003033 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034
3035 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3036 {
3037 if (after < 0)
3038 after = 0;
3039 if (after > ARGCOUNT)
3040 after = ARGCOUNT;
3041 if (after < ARGCOUNT)
3042 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3043 (ARGCOUNT - after) * sizeof(aentry_T));
3044 for (i = 0; i < count; ++i)
3045 {
3046 ARGLIST[after + i].ae_fname = files[i];
3047 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
3048 }
3049 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003050 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3051 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003052 return after;
3053 }
3054
3055 for (i = 0; i < count; ++i)
3056 vim_free(files[i]);
3057 return -1;
3058}
3059
3060#endif /* FEAT_LISTCMDS */
3061
3062#ifdef FEAT_EVAL
3063/*
3064 * ":compiler[!] {name}"
3065 */
3066 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003067ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003068{
3069 char_u *buf;
3070 char_u *old_cur_comp = NULL;
3071 char_u *p;
3072
3073 if (*eap->arg == NUL)
3074 {
3075 /* List all compiler scripts. */
3076 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3077 /* ) keep the indenter happy... */
3078 }
3079 else
3080 {
3081 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3082 if (buf != NULL)
3083 {
3084 if (eap->forceit)
3085 {
3086 /* ":compiler! {name}" sets global options */
3087 do_cmdline_cmd((char_u *)
3088 "command -nargs=* CompilerSet set <args>");
3089 }
3090 else
3091 {
3092 /* ":compiler! {name}" sets local options.
3093 * To remain backwards compatible "current_compiler" is always
3094 * used. A user's compiler plugin may set it, the distributed
3095 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003096 * "b:current_compiler" and restore "current_compiler".
3097 * Explicitly prepend "g:" to make it work in a function. */
3098 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003099 if (old_cur_comp != NULL)
3100 old_cur_comp = vim_strsave(old_cur_comp);
3101 do_cmdline_cmd((char_u *)
3102 "command -nargs=* CompilerSet setlocal <args>");
3103 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003104 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003105 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106
3107 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003108 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3110 vim_free(buf);
3111
3112 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3113
3114 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003115 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 if (p != NULL)
3117 set_internal_string_var((char_u *)"b:current_compiler", p);
3118
3119 /* Restore "current_compiler" for ":compiler {name}". */
3120 if (!eap->forceit)
3121 {
3122 if (old_cur_comp != NULL)
3123 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003124 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 old_cur_comp);
3126 vim_free(old_cur_comp);
3127 }
3128 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003129 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 }
3131 }
3132 }
3133}
3134#endif
3135
3136/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003137 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 */
3139 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003140ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003141{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003142 char_u *arg = eap->arg;
3143 char_u *p = skiptowhite(arg);
3144 int len = (int)(p - arg);
3145 int flags = eap->forceit ? DIP_ALL : 0;
3146
3147 if (STRNCMP(arg, "START", len) == 0)
3148 {
3149 flags += DIP_START + DIP_NORTP;
3150 arg = skipwhite(arg + len);
3151 }
3152 else if (STRNCMP(arg, "OPT", len) == 0)
3153 {
3154 flags += DIP_OPT + DIP_NORTP;
3155 arg = skipwhite(arg + len);
3156 }
3157 else if (STRNCMP(arg, "PACK", len) == 0)
3158 {
3159 flags += DIP_START + DIP_OPT + DIP_NORTP;
3160 arg = skipwhite(arg + len);
3161 }
3162 else if (STRNCMP(arg, "ALL", len) == 0)
3163 {
3164 flags += DIP_START + DIP_OPT;
3165 arg = skipwhite(arg + len);
3166 }
3167
3168 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003169}
3170
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003172source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003174 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175}
3176
3177/*
3178 * Source the file "name" from all directories in 'runtimepath'.
3179 * "name" can contain wildcards.
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003180 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
Bram Moolenaar91715872016-03-03 17:13:03 +01003181 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 * return FAIL when no file could be sourced, OK otherwise.
3183 */
3184 int
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003185source_runtime(char_u *name, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003186{
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003187 return do_in_runtimepath(name, flags, source_callback, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188}
3189
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003190/*
3191 * Find the file "name" in all directories in "path" and invoke
3192 * "callback(fname, cookie)".
3193 * "name" can contain wildcards.
3194 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3195 * When "flags" has DIP_DIR: find directories instead of files.
3196 * When "flags" has DIP_ERR: give an error message if there is no match.
3197 *
3198 * return FAIL when no file could be sourced, OK otherwise.
3199 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003200 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003201do_in_path(
3202 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003203 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003204 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003205 void (*callback)(char_u *fname, void *ck),
3206 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207{
3208 char_u *rtp;
3209 char_u *np;
3210 char_u *buf;
3211 char_u *rtp_copy;
3212 char_u *tail;
3213 int num_files;
3214 char_u **files;
3215 int i;
3216 int did_one = FALSE;
3217#ifdef AMIGA
3218 struct Process *proc = (struct Process *)FindTask(0L);
3219 APTR save_winptr = proc->pr_WindowPtr;
3220
3221 /* Avoid a requester here for a volume that doesn't exist. */
3222 proc->pr_WindowPtr = (APTR)-1L;
3223#endif
3224
3225 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3226 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003227 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 buf = alloc(MAXPATHL);
3229 if (buf != NULL && rtp_copy != NULL)
3230 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003231 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003232 {
3233 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003234 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003235 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003236 verbose_leave();
3237 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003238
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 /* Loop over all entries in 'runtimepath'. */
3240 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003241 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 {
Bram Moolenaar66459b72016-08-06 19:01:55 +02003243 size_t buflen;
3244
Bram Moolenaar071d4272004-06-13 20:20:40 +00003245 /* Copy the path from 'runtimepath' to buf[]. */
3246 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaar66459b72016-08-06 19:01:55 +02003247 buflen = STRLEN(buf);
3248
3249 /* Skip after or non-after directories. */
3250 if (flags & (DIP_NOAFTER | DIP_AFTER))
3251 {
3252 int is_after = buflen >= 5
3253 && STRCMP(buf + buflen - 5, "after") == 0;
3254
3255 if ((is_after && (flags & DIP_NOAFTER))
3256 || (!is_after && (flags & DIP_AFTER)))
3257 continue;
3258 }
3259
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003260 if (name == NULL)
3261 {
3262 (*callback)(buf, (void *) &cookie);
3263 if (!did_one)
3264 did_one = (cookie == NULL);
3265 }
Bram Moolenaar66459b72016-08-06 19:01:55 +02003266 else if (buflen + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003267 {
3268 add_pathsep(buf);
3269 tail = buf + STRLEN(buf);
3270
3271 /* Loop over all patterns in "name" */
3272 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003273 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003274 {
3275 /* Append the pattern from "name" to buf[]. */
3276 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3277 "\t ");
3278
3279 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003280 {
3281 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003282 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003283 verbose_leave();
3284 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285
3286 /* Expand wildcards, invoke the callback for each match. */
3287 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003288 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003289 {
3290 for (i = 0; i < num_files; ++i)
3291 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003292 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003294 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 break;
3296 }
3297 FreeWild(num_files, files);
3298 }
3299 }
3300 }
3301 }
3302 }
3303 vim_free(buf);
3304 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003305 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003306 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003307 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3308
3309 if (flags & DIP_ERR)
3310 EMSG3(_(e_dirnotf), basepath, name);
3311 else if (p_verbose > 0)
3312 {
3313 verbose_enter();
3314 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3315 verbose_leave();
3316 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003317 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318
3319#ifdef AMIGA
3320 proc->pr_WindowPtr = save_winptr;
3321#endif
3322
3323 return did_one ? OK : FAIL;
3324}
3325
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003326/*
3327 * Find "name" in 'runtimepath'. When found, invoke the callback function for
3328 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003329 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3330 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003331 * Returns OK when at least one match found, FAIL otherwise.
3332 *
3333 * If "name" is NULL calls callback for each entry in runtimepath. Cookie is
3334 * passed by reference in this case, setting it to NULL indicates that callback
3335 * has done its job.
3336 */
3337 int
3338do_in_runtimepath(
3339 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003340 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003341 void (*callback)(char_u *fname, void *ck),
3342 void *cookie)
3343{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003344 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003345 char_u *s;
3346 int len;
3347 char *start_dir = "pack/*/start/*/%s";
3348 char *opt_dir = "pack/*/opt/*/%s";
3349
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003350 if ((flags & DIP_NORTP) == 0)
3351 done = do_in_path(p_rtp, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003352
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003353 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003354 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003355 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003356 s = alloc(len);
3357 if (s == NULL)
3358 return FAIL;
3359 vim_snprintf((char *)s, len, start_dir, name);
3360 done = do_in_path(p_pp, s, flags, callback, cookie);
3361 vim_free(s);
3362 }
3363
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003364 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003365 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003366 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003367 s = alloc(len);
3368 if (s == NULL)
3369 return FAIL;
3370 vim_snprintf((char *)s, len, opt_dir, name);
3371 done = do_in_path(p_pp, s, flags, callback, cookie);
3372 vim_free(s);
3373 }
3374
3375 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003376}
3377
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003378/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003379 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003380 */
3381 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003382source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003383{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003384 int num_files;
3385 char_u **files;
3386 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003387
Bram Moolenaarf3654822016-03-04 22:12:23 +01003388 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003389 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003390 for (i = 0; i < num_files; ++i)
3391 (void)do_source(files[i], FALSE, DOSO_NONE);
3392 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003393 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003394}
3395
Bram Moolenaar49b27322016-04-05 21:13:00 +02003396/* used for "cookie" of add_pack_plugin() */
3397static int APP_ADD_DIR;
3398static int APP_LOAD;
3399static int APP_BOTH;
3400
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003401 static void
Bram Moolenaar91715872016-03-03 17:13:03 +01003402add_pack_plugin(char_u *fname, void *cookie)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003403{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003404 char_u *p4, *p3, *p2, *p1, *p;
3405 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003406 int c;
3407 char_u *new_rtp;
3408 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003409 size_t oldlen;
3410 size_t addlen;
Bram Moolenaara5702442016-05-24 19:37:29 +02003411 char_u *afterdir;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003412 size_t afterlen = 0;
Bram Moolenaar91715872016-03-03 17:13:03 +01003413 char_u *ffname = fix_fname(fname);
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003414 size_t fname_len;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003415
Bram Moolenaar91715872016-03-03 17:13:03 +01003416 if (ffname == NULL)
3417 return;
Bram Moolenaar49b27322016-04-05 21:13:00 +02003418 if (cookie != &APP_LOAD && strstr((char *)p_rtp, (char *)ffname) == NULL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003419 {
Bram Moolenaara5702442016-05-24 19:37:29 +02003420 /* directory is not yet in 'runtimepath', add it */
Bram Moolenaarf3654822016-03-04 22:12:23 +01003421 p4 = p3 = p2 = p1 = get_past_head(ffname);
3422 for (p = p1; *p; mb_ptr_adv(p))
3423 if (vim_ispathsep_nocolon(*p))
3424 {
3425 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3426 }
3427
3428 /* now we have:
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +01003429 * rtp/pack/name/start/name
3430 * p4 p3 p2 p1
Bram Moolenaarf3654822016-03-04 22:12:23 +01003431 *
3432 * find the part up to "pack" in 'runtimepath' */
3433 c = *p4;
3434 *p4 = NUL;
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003435
3436 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3437 fname_len = STRLEN(ffname);
3438 insp = p_rtp;
3439 for (;;)
3440 {
3441 if (vim_fnamencmp(insp, ffname, fname_len) == 0)
3442 break;
3443 insp = vim_strchr(insp, ',');
3444 if (insp == NULL)
3445 break;
3446 ++insp;
3447 }
3448
Bram Moolenaarf3654822016-03-04 22:12:23 +01003449 if (insp == NULL)
3450 /* not found, append at the end */
3451 insp = p_rtp + STRLEN(p_rtp);
3452 else
3453 {
3454 /* append after the matching directory. */
3455 insp += STRLEN(ffname);
3456 while (*insp != NUL && *insp != ',')
3457 ++insp;
3458 }
3459 *p4 = c;
3460
Bram Moolenaara5702442016-05-24 19:37:29 +02003461 /* check if rtp/pack/name/start/name/after exists */
3462 afterdir = concat_fnames(ffname, (char_u *)"after", TRUE);
3463 if (afterdir != NULL && mch_isdir(afterdir))
3464 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3465
Bram Moolenaarb0550662016-05-31 21:37:36 +02003466 oldlen = STRLEN(p_rtp);
3467 addlen = STRLEN(ffname) + 1; /* add one for comma */
3468 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1)); /* add one for NUL */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003469 if (new_rtp == NULL)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003470 goto theend;
3471 keep = (int)(insp - p_rtp);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003472 mch_memmove(new_rtp, p_rtp, keep);
3473 new_rtp[keep] = ',';
Bram Moolenaara5702442016-05-24 19:37:29 +02003474 mch_memmove(new_rtp + keep + 1, ffname, addlen);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003475 if (p_rtp[keep] != NUL)
Bram Moolenaara5702442016-05-24 19:37:29 +02003476 mch_memmove(new_rtp + keep + addlen, p_rtp + keep,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003477 oldlen - keep + 1);
Bram Moolenaara5702442016-05-24 19:37:29 +02003478 if (afterlen > 0)
3479 {
3480 STRCAT(new_rtp, ",");
3481 STRCAT(new_rtp, afterdir);
3482 }
Bram Moolenaar863c1a92016-03-03 15:47:06 +01003483 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3484 vim_free(new_rtp);
Bram Moolenaara5702442016-05-24 19:37:29 +02003485 vim_free(afterdir);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003486 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003487
Bram Moolenaar49b27322016-04-05 21:13:00 +02003488 if (cookie != &APP_ADD_DIR)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003489 {
Bram Moolenaar71fb0c12016-04-02 22:44:16 +02003490 static char *plugpat = "%s/plugin/**/*.vim";
Bram Moolenaarf3654822016-03-04 22:12:23 +01003491 static char *ftpat = "%s/ftdetect/*.vim";
3492 int len;
3493 char_u *pat;
3494
3495 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3496 pat = alloc(len);
3497 if (pat == NULL)
3498 goto theend;
3499 vim_snprintf((char *)pat, len, plugpat, ffname);
3500 source_all_matches(pat);
3501
3502#ifdef FEAT_AUTOCMD
3503 {
3504 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3505
3506 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3507 * found when it loads. */
3508 if (cmd != NULL && eval_to_number(cmd) > 0)
3509 {
3510 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3511 vim_snprintf((char *)pat, len, ftpat, ffname);
3512 source_all_matches(pat);
3513 do_cmdline_cmd((char_u *)"augroup END");
3514 }
3515 vim_free(cmd);
3516 }
3517#endif
Bram Moolenaarba8cd122016-03-19 14:16:39 +01003518 vim_free(pat);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003519 }
3520
3521theend:
3522 vim_free(ffname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003523}
3524
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003525static int did_source_packages = FALSE;
3526
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003527/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003528 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003529 * Find plugins in the package directories and source them.
Bram Moolenaar66459b72016-08-06 19:01:55 +02003530 * "eap" is NULL when invoked during startup.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003531 */
3532 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003533ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003534{
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003535 if (!did_source_packages || (eap != NULL && eap->forceit))
3536 {
3537 did_source_packages = TRUE;
Bram Moolenaar49b27322016-04-05 21:13:00 +02003538
3539 /* First do a round to add all directories to 'runtimepath', then load
3540 * the plugins. This allows for plugins to use an autoload directory
3541 * of another plugin. */
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003542 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
Bram Moolenaar49b27322016-04-05 21:13:00 +02003543 add_pack_plugin, &APP_ADD_DIR);
3544 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3545 add_pack_plugin, &APP_LOAD);
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003546 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003547}
3548
3549/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003550 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003551 */
3552 void
3553ex_packadd(exarg_T *eap)
3554{
3555 static char *plugpat = "pack/*/opt/%s";
3556 int len;
3557 char *pat;
3558
3559 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg);
3560 pat = (char *)alloc(len);
3561 if (pat == NULL)
3562 return;
3563 vim_snprintf(pat, len, plugpat, eap->arg);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003564 do_in_path(p_pp, (char_u *)pat, DIP_ALL + DIP_DIR + DIP_ERR,
Bram Moolenaar49b27322016-04-05 21:13:00 +02003565 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
Bram Moolenaar91715872016-03-03 17:13:03 +01003566 vim_free(pat);
3567}
3568
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
3570/*
3571 * ":options"
3572 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003574ex_options(
3575 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576{
3577 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3578}
3579#endif
3580
3581/*
3582 * ":source {fname}"
3583 */
3584 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003585ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586{
3587#ifdef FEAT_BROWSE
3588 if (cmdmod.browse)
3589 {
3590 char_u *fname = NULL;
3591
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003592 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
3594 if (fname != NULL)
3595 {
3596 cmd_source(fname, eap);
3597 vim_free(fname);
3598 }
3599 }
3600 else
3601#endif
3602 cmd_source(eap->arg, eap);
3603}
3604
3605 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003606cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607{
3608 if (*fname == NUL)
3609 EMSG(_(e_argreq));
3610
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02003612 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003613 * Need to execute the commands directly. This is required at least
3614 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 * - ":g" command busy
3616 * - after ":argdo", ":windo" or ":bufdo"
3617 * - another command follows
3618 * - inside a loop
3619 */
3620 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
3621#ifdef FEAT_EVAL
3622 || eap->cstack->cs_idx >= 0
3623#endif
3624 );
3625
3626 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003627 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 EMSG2(_(e_notopen), fname);
3629}
3630
3631/*
3632 * ":source" and associated commands.
3633 */
3634/*
3635 * Structure used to store info for each sourced file.
3636 * It is shared between do_source() and getsourceline().
3637 * This is required, because it needs to be handed to do_cmdline() and
3638 * sourcing can be done recursively.
3639 */
3640struct source_cookie
3641{
3642 FILE *fp; /* opened file for sourcing */
3643 char_u *nextline; /* if not NULL: line that was read ahead */
3644 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003645#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
3647 int error; /* TRUE if LF found after CR-LF */
3648#endif
3649#ifdef FEAT_EVAL
3650 linenr_T breakpoint; /* next line with breakpoint or zero */
3651 char_u *fname; /* name of sourced file */
3652 int dbg_tick; /* debug_tick when breakpoint was set */
3653 int level; /* top nesting level of sourced file */
3654#endif
3655#ifdef FEAT_MBYTE
3656 vimconv_T conv; /* type of conversion */
3657#endif
3658};
3659
3660#ifdef FEAT_EVAL
3661/*
3662 * Return the address holding the next breakpoint line for a source cookie.
3663 */
3664 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003665source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666{
3667 return &((struct source_cookie *)cookie)->breakpoint;
3668}
3669
3670/*
3671 * Return the address holding the debug tick for a source cookie.
3672 */
3673 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003674source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675{
3676 return &((struct source_cookie *)cookie)->dbg_tick;
3677}
3678
3679/*
3680 * Return the nesting level for a source cookie.
3681 */
3682 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003683source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003684{
3685 return ((struct source_cookie *)cookie)->level;
3686}
3687#endif
3688
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01003689static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003691#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
3692# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01003693static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694
3695/*
3696 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003697 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 */
3699 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003700fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003702# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01003703 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
3704# else
3705 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003706# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003707
3708 if (fd_tmp == -1)
3709 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003710
3711# ifdef HAVE_FD_CLOEXEC
3712 {
3713 int fdflags = fcntl(fd_tmp, F_GETFD);
3714 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02003715 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003716 }
3717# endif
3718
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 return fdopen(fd_tmp, READBIN);
3720}
3721#endif
3722
3723
3724/*
3725 * do_source: Read the file "fname" and execute its lines as EX commands.
3726 *
3727 * This function may be called recursively!
3728 *
3729 * return FAIL if file could not be opened, OK otherwise
3730 */
3731 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003732do_source(
3733 char_u *fname,
3734 int check_other, /* check for .vimrc and _vimrc */
3735 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003736{
3737 struct source_cookie cookie;
3738 char_u *save_sourcing_name;
3739 linenr_T save_sourcing_lnum;
3740 char_u *p;
3741 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00003742 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 int retval = FAIL;
3744#ifdef FEAT_EVAL
3745 scid_T save_current_SID;
3746 static scid_T last_current_SID = 0;
3747 void *save_funccalp;
3748 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003749 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02003751 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 int stat_ok;
3753# endif
3754#endif
3755#ifdef STARTUPTIME
3756 struct timeval tv_rel;
3757 struct timeval tv_start;
3758#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00003759#ifdef FEAT_PROFILE
3760 proftime_T wait_start;
3761#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003762
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 if (p == NULL)
3765 return retval;
3766 fname_exp = fix_fname(p);
3767 vim_free(p);
3768 if (fname_exp == NULL)
3769 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 if (mch_isdir(fname_exp))
3771 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00003772 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 goto theend;
3774 }
3775
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003776#ifdef FEAT_AUTOCMD
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003777 /* Apply SourceCmd autocommands, they should get the file and source it. */
3778 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
3779 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
3780 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003781 {
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003782# ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003783 retval = aborting() ? FAIL : OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003784# else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003785 retval = OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003786# endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003787 goto theend;
3788 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003789
3790 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003791 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
3792#endif
3793
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003794#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
3796#else
3797 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
3798#endif
3799 if (cookie.fp == NULL && check_other)
3800 {
3801 /*
3802 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
3803 * and ".exrc" by "_exrc" or vice versa.
3804 */
3805 p = gettail(fname_exp);
3806 if ((*p == '.' || *p == '_')
3807 && (STRICMP(p + 1, "vimrc") == 0
3808 || STRICMP(p + 1, "gvimrc") == 0
3809 || STRICMP(p + 1, "exrc") == 0))
3810 {
3811 if (*p == '_')
3812 *p = '.';
3813 else
3814 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003815#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
3817#else
3818 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
3819#endif
3820 }
3821 }
3822
3823 if (cookie.fp == NULL)
3824 {
3825 if (p_verbose > 0)
3826 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003827 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00003829 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 else
3831 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00003832 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003833 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 }
3835 goto theend;
3836 }
3837
3838 /*
3839 * The file exists.
3840 * - In verbose mode, give a message.
3841 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
3842 */
3843 if (p_verbose > 1)
3844 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003845 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00003847 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003848 else
3849 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00003850 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003851 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003853 if (is_vimrc == DOSO_VIMRC)
3854 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
3855 else if (is_vimrc == DOSO_GVIMRC)
3856 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003857
3858#ifdef USE_CRNL
3859 /* If no automatic file format: Set default to CR-NL. */
3860 if (*p_ffs == NUL)
3861 cookie.fileformat = EOL_DOS;
3862 else
3863 cookie.fileformat = EOL_UNKNOWN;
3864 cookie.error = FALSE;
3865#endif
3866
3867#ifdef USE_CR
3868 /* If no automatic file format: Set default to CR. */
3869 if (*p_ffs == NUL)
3870 cookie.fileformat = EOL_MAC;
3871 else
3872 cookie.fileformat = EOL_UNKNOWN;
3873 cookie.error = FALSE;
3874#endif
3875
3876 cookie.nextline = NULL;
3877 cookie.finished = FALSE;
3878
3879#ifdef FEAT_EVAL
3880 /*
3881 * Check if this script has a breakpoint.
3882 */
3883 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
3884 cookie.fname = fname_exp;
3885 cookie.dbg_tick = debug_tick;
3886
3887 cookie.level = ex_nesting_level;
3888#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889
3890 /*
3891 * Keep the sourcing name/lnum, for recursive calls.
3892 */
3893 save_sourcing_name = sourcing_name;
3894 sourcing_name = fname_exp;
3895 save_sourcing_lnum = sourcing_lnum;
3896 sourcing_lnum = 0;
3897
Bram Moolenaar73881402009-02-04 16:50:47 +00003898#ifdef FEAT_MBYTE
3899 cookie.conv.vc_type = CONV_NONE; /* no conversion */
3900
3901 /* Read the first line so we can check for a UTF-8 BOM. */
3902 firstline = getsourceline(0, (void *)&cookie, 0);
3903 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
3904 && firstline[1] == 0xbb && firstline[2] == 0xbf)
3905 {
3906 /* Found BOM; setup conversion, skip over BOM and recode the line. */
3907 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
3908 p = string_convert(&cookie.conv, firstline + 3, NULL);
Bram Moolenaar4e2a5952009-02-05 19:48:25 +00003909 if (p == NULL)
3910 p = vim_strsave(firstline + 3);
Bram Moolenaar73881402009-02-04 16:50:47 +00003911 if (p != NULL)
3912 {
3913 vim_free(firstline);
3914 firstline = p;
3915 }
3916 }
3917#endif
3918
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01003920 if (time_fd != NULL)
3921 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922#endif
3923
3924#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00003925# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003926 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003927 prof_child_enter(&wait_start); /* entering a child now */
3928# endif
3929
3930 /* Don't use local function variables, if called from a function.
3931 * Also starts profiling timer for nested script. */
3932 save_funccalp = save_funccal();
3933
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 /*
3935 * Check if this script was sourced before to finds its SID.
3936 * If it's new, generate a new SID.
3937 */
3938 save_current_SID = current_SID;
3939# ifdef UNIX
3940 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
3941# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00003942 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
3943 {
3944 si = &SCRIPT_ITEM(current_SID);
3945 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 && (
3947# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00003948 /* Compare dev/ino when possible, it catches symbolic
3949 * links. Also compare file names, the inode may change
3950 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00003951 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003952 && (si->sn_dev == st.st_dev
3953 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00003955 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003957 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 if (current_SID == 0)
3959 {
3960 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003961 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
3962 == FAIL)
3963 goto almosttheend;
3964 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003965 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00003966 ++script_items.ga_len;
3967 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
3968# ifdef FEAT_PROFILE
3969 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00003972 si = &SCRIPT_ITEM(current_SID);
3973 si->sn_name = fname_exp;
3974 fname_exp = NULL;
3975# ifdef UNIX
3976 if (stat_ok)
3977 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00003978 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003979 si->sn_dev = st.st_dev;
3980 si->sn_ino = st.st_ino;
3981 }
3982 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00003983 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003984# endif
3985
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 /* Allocate the local script variables to use for this script. */
3987 new_script_vars(current_SID);
3988 }
3989
Bram Moolenaar05159a02005-02-26 23:04:13 +00003990# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003991 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003992 {
3993 int forceit;
3994
3995 /* Check if we do profiling for this script. */
3996 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
3997 {
3998 script_do_profile(si);
3999 si->sn_pr_force = forceit;
4000 }
4001 if (si->sn_prof_on)
4002 {
4003 ++si->sn_pr_count;
4004 profile_start(&si->sn_pr_start);
4005 profile_zero(&si->sn_pr_children);
4006 }
4007 }
4008# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004009#endif
4010
4011 /*
4012 * Call do_cmdline, which will call getsourceline() to get the lines.
4013 */
Bram Moolenaar73881402009-02-04 16:50:47 +00004014 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004015 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004017
4018#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004019 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004020 {
4021 /* Get "si" again, "script_items" may have been reallocated. */
4022 si = &SCRIPT_ITEM(current_SID);
4023 if (si->sn_prof_on)
4024 {
4025 profile_end(&si->sn_pr_start);
4026 profile_sub_wait(&wait_start, &si->sn_pr_start);
4027 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004028 profile_self(&si->sn_pr_self, &si->sn_pr_start,
4029 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004030 }
4031 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032#endif
4033
4034 if (got_int)
4035 EMSG(_(e_interr));
4036 sourcing_name = save_sourcing_name;
4037 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 if (p_verbose > 1)
4039 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004040 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004041 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004043 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004044 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004045 }
4046#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004047 if (time_fd != NULL)
4048 {
4049 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4050 time_msg((char *)IObuff, &tv_start);
4051 time_pop(&tv_rel);
4052 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053#endif
4054
4055#ifdef FEAT_EVAL
4056 /*
4057 * After a "finish" in debug mode, need to break at first command of next
4058 * sourced file.
4059 */
4060 if (save_debug_break_level > ex_nesting_level
4061 && debug_break_level == ex_nesting_level)
4062 ++debug_break_level;
4063#endif
4064
Bram Moolenaar05159a02005-02-26 23:04:13 +00004065#ifdef FEAT_EVAL
4066almosttheend:
4067 current_SID = save_current_SID;
4068 restore_funccal(save_funccalp);
4069# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004070 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004071 prof_child_exit(&wait_start); /* leaving a child now */
4072# endif
4073#endif
4074 fclose(cookie.fp);
4075 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004076 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004077#ifdef FEAT_MBYTE
4078 convert_setup(&cookie.conv, NULL, NULL);
4079#endif
4080
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081theend:
4082 vim_free(fname_exp);
4083 return retval;
4084}
4085
4086#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004087
Bram Moolenaar071d4272004-06-13 20:20:40 +00004088/*
4089 * ":scriptnames"
4090 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004092ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093{
4094 int i;
4095
Bram Moolenaar05159a02005-02-26 23:04:13 +00004096 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4097 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004098 {
4099 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4100 NameBuff, MAXPATHL, TRUE);
4101 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004102 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004103}
4104
4105# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4106/*
4107 * Fix slashes in the list of script names for 'shellslash'.
4108 */
4109 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004110scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111{
4112 int i;
4113
Bram Moolenaar05159a02005-02-26 23:04:13 +00004114 for (i = 1; i <= script_items.ga_len; ++i)
4115 if (SCRIPT_ITEM(i).sn_name != NULL)
4116 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117}
4118# endif
4119
4120/*
4121 * Get a pointer to a script name. Used for ":verbose set".
4122 */
4123 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004124get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004125{
4126 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004127 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004129 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004130 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004131 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004133 return (char_u *)_("environment variable");
4134 if (id == SID_ERROR)
4135 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004136 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004138
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004139# if defined(EXITFREE) || defined(PROTO)
4140 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004141free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004142{
4143 int i;
4144
4145 for (i = script_items.ga_len; i > 0; --i)
4146 vim_free(SCRIPT_ITEM(i).sn_name);
4147 ga_clear(&script_items);
4148}
4149# endif
4150
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151#endif
4152
4153#if defined(USE_CR) || defined(PROTO)
4154
4155# if defined(__MSL__) && (__MSL__ >= 22)
4156/*
4157 * Newer version of the Metrowerks library handle DOS and UNIX files
4158 * without help.
4159 * Test with earlier versions, MSL 2.2 is the library supplied with
4160 * Codewarrior Pro 2.
4161 */
4162 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004163fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164{
4165 return fgets(s, n, stream);
4166}
4167# else
4168/*
4169 * Version of fgets() which also works for lines ending in a <CR> only
4170 * (Macintosh format).
4171 * For older versions of the Metrowerks library.
4172 * At least CodeWarrior 9 needed this code.
4173 */
4174 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004175fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176{
4177 int c = 0;
4178 int char_read = 0;
4179
4180 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4181 {
4182 c = fgetc(stream);
4183 s[char_read++] = c;
4184 /* If the file is in DOS format, we need to skip a NL after a CR. I
4185 * thought it was the other way around, but this appears to work... */
4186 if (c == '\n')
4187 {
4188 c = fgetc(stream);
4189 if (c != '\r')
4190 ungetc(c, stream);
4191 }
4192 }
4193
4194 s[char_read] = 0;
4195 if (char_read == 0)
4196 return NULL;
4197
4198 if (feof(stream) && char_read == 1)
4199 return NULL;
4200
4201 return s;
4202}
4203# endif
4204#endif
4205
4206/*
4207 * Get one full line from a sourced file.
4208 * Called by do_cmdline() when it's called from do_source().
4209 *
4210 * Return a pointer to the line in allocated memory.
4211 * Return NULL for end-of-file or some error.
4212 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004213 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004214getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215{
4216 struct source_cookie *sp = (struct source_cookie *)cookie;
4217 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004218 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219
4220#ifdef FEAT_EVAL
4221 /* If breakpoints have been added/deleted need to check for it. */
4222 if (sp->dbg_tick < debug_tick)
4223 {
4224 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4225 sp->dbg_tick = debug_tick;
4226 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004227# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004228 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004229 script_line_end();
4230# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231#endif
4232 /*
4233 * Get current line. If there is a read-ahead line, use it, otherwise get
4234 * one now.
4235 */
4236 if (sp->finished)
4237 line = NULL;
4238 else if (sp->nextline == NULL)
4239 line = get_one_sourceline(sp);
4240 else
4241 {
4242 line = sp->nextline;
4243 sp->nextline = NULL;
4244 ++sourcing_lnum;
4245 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004246#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004247 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004248 script_line_start();
4249#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250
4251 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4252 * contain the 'C' flag. */
4253 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4254 {
4255 /* compensate for the one line read-ahead */
4256 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004257
4258 /* Get the next line and concatenate it when it starts with a
4259 * backslash. We always need to read the next line, keep it in
4260 * sp->nextline. */
4261 sp->nextline = get_one_sourceline(sp);
4262 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004263 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004264 garray_T ga;
4265
Bram Moolenaarb549a732012-02-22 18:29:33 +01004266 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004267 ga_concat(&ga, line);
4268 ga_concat(&ga, p + 1);
4269 for (;;)
4270 {
4271 vim_free(sp->nextline);
4272 sp->nextline = get_one_sourceline(sp);
4273 if (sp->nextline == NULL)
4274 break;
4275 p = skipwhite(sp->nextline);
4276 if (*p != '\\')
4277 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004278 /* Adjust the growsize to the current length to speed up
4279 * concatenating many lines. */
4280 if (ga.ga_len > 400)
4281 {
4282 if (ga.ga_len > 8000)
4283 ga.ga_growsize = 8000;
4284 else
4285 ga.ga_growsize = ga.ga_len;
4286 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004287 ga_concat(&ga, p + 1);
4288 }
4289 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004291 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 }
4293 }
4294
4295#ifdef FEAT_MBYTE
4296 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4297 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004298 char_u *s;
4299
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 /* Convert the encoding of the script line. */
4301 s = string_convert(&sp->conv, line, NULL);
4302 if (s != NULL)
4303 {
4304 vim_free(line);
4305 line = s;
4306 }
4307 }
4308#endif
4309
4310#ifdef FEAT_EVAL
4311 /* Did we encounter a breakpoint? */
4312 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4313 {
4314 dbg_breakpoint(sp->fname, sourcing_lnum);
4315 /* Find next breakpoint. */
4316 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4317 sp->dbg_tick = debug_tick;
4318 }
4319#endif
4320
4321 return line;
4322}
4323
4324 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004325get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004326{
4327 garray_T ga;
4328 int len;
4329 int c;
4330 char_u *buf;
4331#ifdef USE_CRNL
4332 int has_cr; /* CR-LF found */
4333#endif
4334#ifdef USE_CR
4335 char_u *scan;
4336#endif
4337 int have_read = FALSE;
4338
4339 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004340 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341
4342 /*
4343 * Loop until there is a finished line (or end-of-file).
4344 */
4345 sourcing_lnum++;
4346 for (;;)
4347 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004348 /* make room to read at least 120 (more) characters */
4349 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 break;
4351 buf = (char_u *)ga.ga_data;
4352
4353#ifdef USE_CR
4354 if (sp->fileformat == EOL_MAC)
4355 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004356 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4357 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004358 break;
4359 }
4360 else
4361#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004362 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4363 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004365 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366#ifdef USE_CRNL
4367 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4368 * CTRL-Z by its own, or after a NL. */
4369 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4370 && sp->fileformat == EOL_DOS
4371 && buf[len - 1] == Ctrl_Z)
4372 {
4373 buf[len - 1] = NUL;
4374 break;
4375 }
4376#endif
4377
4378#ifdef USE_CR
4379 /* If the read doesn't stop on a new line, and there's
4380 * some CR then we assume a Mac format */
4381 if (sp->fileformat == EOL_UNKNOWN)
4382 {
4383 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4384 sp->fileformat = EOL_MAC;
4385 else
4386 sp->fileformat = EOL_UNIX;
4387 }
4388
4389 if (sp->fileformat == EOL_MAC)
4390 {
4391 scan = vim_strchr(buf, '\r');
4392
4393 if (scan != NULL)
4394 {
4395 *scan = '\n';
4396 if (*(scan + 1) != 0)
4397 {
4398 *(scan + 1) = 0;
4399 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4400 }
4401 }
4402 len = STRLEN(buf);
4403 }
4404#endif
4405
4406 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 ga.ga_len = len;
4408
4409 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004410 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411 continue;
4412
4413 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4414 {
4415#ifdef USE_CRNL
4416 has_cr = (len >= 2 && buf[len - 2] == '\r');
4417 if (sp->fileformat == EOL_UNKNOWN)
4418 {
4419 if (has_cr)
4420 sp->fileformat = EOL_DOS;
4421 else
4422 sp->fileformat = EOL_UNIX;
4423 }
4424
4425 if (sp->fileformat == EOL_DOS)
4426 {
4427 if (has_cr) /* replace trailing CR */
4428 {
4429 buf[len - 2] = '\n';
4430 --len;
4431 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 }
4433 else /* lines like ":map xx yy^M" will have failed */
4434 {
4435 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004436 {
4437 msg_source(hl_attr(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004438 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004439 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 sp->error = TRUE;
4441 sp->fileformat = EOL_UNIX;
4442 }
4443 }
4444#endif
4445 /* The '\n' is escaped if there is an odd number of ^V's just
4446 * before it, first set "c" just before the 'V's and then check
4447 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
4448 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
4449 ;
4450 if ((len & 1) != (c & 1)) /* escaped NL, read more */
4451 {
4452 sourcing_lnum++;
4453 continue;
4454 }
4455
4456 buf[len - 1] = NUL; /* remove the NL */
4457 }
4458
4459 /*
4460 * Check for ^C here now and then, so recursive :so can be broken.
4461 */
4462 line_breakcheck();
4463 break;
4464 }
4465
4466 if (have_read)
4467 return (char_u *)ga.ga_data;
4468
4469 vim_free(ga.ga_data);
4470 return NULL;
4471}
4472
Bram Moolenaar05159a02005-02-26 23:04:13 +00004473#if defined(FEAT_PROFILE) || defined(PROTO)
4474/*
4475 * Called when starting to read a script line.
4476 * "sourcing_lnum" must be correct!
4477 * When skipping lines it may not actually be executed, but we won't find out
4478 * until later and we need to store the time now.
4479 */
4480 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004481script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004482{
4483 scriptitem_T *si;
4484 sn_prl_T *pp;
4485
4486 if (current_SID <= 0 || current_SID > script_items.ga_len)
4487 return;
4488 si = &SCRIPT_ITEM(current_SID);
4489 if (si->sn_prof_on && sourcing_lnum >= 1)
4490 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004491 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00004492 * here isn't counted. */
Bram Moolenaarcde88542015-08-11 19:14:00 +02004493 (void)ga_grow(&si->sn_prl_ga, (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00004494 si->sn_prl_idx = sourcing_lnum - 1;
4495 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
4496 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
4497 {
4498 /* Zero counters for a line that was not used before. */
4499 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
4500 pp->snp_count = 0;
4501 profile_zero(&pp->sn_prl_total);
4502 profile_zero(&pp->sn_prl_self);
4503 ++si->sn_prl_ga.ga_len;
4504 }
4505 si->sn_prl_execed = FALSE;
4506 profile_start(&si->sn_prl_start);
4507 profile_zero(&si->sn_prl_children);
4508 profile_get_wait(&si->sn_prl_wait);
4509 }
4510}
4511
4512/*
4513 * Called when actually executing a function line.
4514 */
4515 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004516script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004517{
4518 scriptitem_T *si;
4519
4520 if (current_SID <= 0 || current_SID > script_items.ga_len)
4521 return;
4522 si = &SCRIPT_ITEM(current_SID);
4523 if (si->sn_prof_on && si->sn_prl_idx >= 0)
4524 si->sn_prl_execed = TRUE;
4525}
4526
4527/*
4528 * Called when done with a function line.
4529 */
4530 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004531script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004532{
4533 scriptitem_T *si;
4534 sn_prl_T *pp;
4535
4536 if (current_SID <= 0 || current_SID > script_items.ga_len)
4537 return;
4538 si = &SCRIPT_ITEM(current_SID);
4539 if (si->sn_prof_on && si->sn_prl_idx >= 0
4540 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
4541 {
4542 if (si->sn_prl_execed)
4543 {
4544 pp = &PRL_ITEM(si, si->sn_prl_idx);
4545 ++pp->snp_count;
4546 profile_end(&si->sn_prl_start);
4547 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004548 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004549 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
4550 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004551 }
4552 si->sn_prl_idx = -1;
4553 }
4554}
4555#endif
4556
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557/*
4558 * ":scriptencoding": Set encoding conversion for a sourced script.
4559 * Without the multi-byte feature it's simply ignored.
4560 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004562ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563{
4564#ifdef FEAT_MBYTE
4565 struct source_cookie *sp;
4566 char_u *name;
4567
4568 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
4569 {
4570 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
4571 return;
4572 }
4573
4574 if (*eap->arg != NUL)
4575 {
4576 name = enc_canonize(eap->arg);
4577 if (name == NULL) /* out of memory */
4578 return;
4579 }
4580 else
4581 name = eap->arg;
4582
4583 /* Setup for conversion from the specified encoding to 'encoding'. */
4584 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
4585 convert_setup(&sp->conv, name, p_enc);
4586
4587 if (name != eap->arg)
4588 vim_free(name);
4589#endif
4590}
4591
4592#if defined(FEAT_EVAL) || defined(PROTO)
4593/*
4594 * ":finish": Mark a sourced file as finished.
4595 */
4596 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004597ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598{
4599 if (getline_equal(eap->getline, eap->cookie, getsourceline))
4600 do_finish(eap, FALSE);
4601 else
4602 EMSG(_("E168: :finish used outside of a sourced file"));
4603}
4604
4605/*
4606 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
4607 * Also called for a pending finish at the ":endtry" or after returning from
4608 * an extra do_cmdline(). "reanimate" is used in the latter case.
4609 */
4610 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004611do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004612{
4613 int idx;
4614
4615 if (reanimate)
4616 ((struct source_cookie *)getline_cookie(eap->getline,
4617 eap->cookie))->finished = FALSE;
4618
4619 /*
4620 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4621 * not in its finally clause (which then is to be executed next) is found.
4622 * In this case, make the ":finish" pending for execution at the ":endtry".
4623 * Otherwise, finish normally.
4624 */
4625 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4626 if (idx >= 0)
4627 {
4628 eap->cstack->cs_pending[idx] = CSTP_FINISH;
4629 report_make_pending(CSTP_FINISH, NULL);
4630 }
4631 else
4632 ((struct source_cookie *)getline_cookie(eap->getline,
4633 eap->cookie))->finished = TRUE;
4634}
4635
4636
4637/*
4638 * Return TRUE when a sourced file had the ":finish" command: Don't give error
4639 * message for missing ":endif".
4640 * Return FALSE when not sourcing a file.
4641 */
4642 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004643source_finished(
4644 char_u *(*fgetline)(int, void *, int),
4645 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646{
Bram Moolenaar89d40322006-08-29 15:30:07 +00004647 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00004649 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004650}
4651#endif
4652
4653#if defined(FEAT_LISTCMDS) || defined(PROTO)
4654/*
4655 * ":checktime [buffer]"
4656 */
4657 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004658ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659{
4660 buf_T *buf;
4661 int save_no_check_timestamps = no_check_timestamps;
4662
4663 no_check_timestamps = 0;
4664 if (eap->addr_count == 0) /* default is all buffers */
4665 check_timestamps(FALSE);
4666 else
4667 {
4668 buf = buflist_findnr((int)eap->line2);
4669 if (buf != NULL) /* cannot happen? */
4670 (void)buf_check_timestamp(buf, FALSE);
4671 }
4672 no_check_timestamps = save_no_check_timestamps;
4673}
4674#endif
4675
Bram Moolenaar071d4272004-06-13 20:20:40 +00004676#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4677 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004678# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004679static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004681 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004682get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004683{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004684 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004685
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004686 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004687 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004689# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690 if (loc != NULL)
4691 {
4692 char_u *p;
4693
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004694 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
4695 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 p = vim_strchr(loc, '=');
4697 if (p != NULL)
4698 {
4699 loc = ++p;
4700 while (*p != NUL) /* remove trailing newline */
4701 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004702 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 {
4704 *p = NUL;
4705 break;
4706 }
4707 ++p;
4708 }
4709 }
4710 }
4711# endif
4712
4713 return loc;
4714}
4715#endif
4716
4717
4718#ifdef WIN32
4719/*
4720 * On MS-Windows locale names are strings like "German_Germany.1252", but
4721 * gettext expects "de". Try to translate one into another here for a few
4722 * supported languages.
4723 */
4724 static char_u *
4725gettext_lang(char_u *name)
4726{
4727 int i;
4728 static char *(mtable[]) = {
4729 "afrikaans", "af",
4730 "czech", "cs",
4731 "dutch", "nl",
4732 "german", "de",
4733 "english_united kingdom", "en_GB",
4734 "spanish", "es",
4735 "french", "fr",
4736 "italian", "it",
4737 "japanese", "ja",
4738 "korean", "ko",
4739 "norwegian", "no",
4740 "polish", "pl",
4741 "russian", "ru",
4742 "slovak", "sk",
4743 "swedish", "sv",
4744 "ukrainian", "uk",
4745 "chinese_china", "zh_CN",
4746 "chinese_taiwan", "zh_TW",
4747 NULL};
4748
4749 for (i = 0; mtable[i] != NULL; i += 2)
4750 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004751 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00004752 return name;
4753}
4754#endif
4755
4756#if defined(FEAT_MULTI_LANG) || defined(PROTO)
4757/*
4758 * Obtain the current messages language. Used to set the default for
4759 * 'helplang'. May return NULL or an empty string.
4760 */
4761 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004762get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763{
4764 char_u *p;
4765
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004766# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004768 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004769# else
4770 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004771 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
4772 * and LC_MONETARY may be set differently for a Japanese working in the
4773 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004774 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775# endif
4776# else
4777 p = mch_getenv((char_u *)"LC_ALL");
4778 if (p == NULL || *p == NUL)
4779 {
4780 p = mch_getenv((char_u *)"LC_MESSAGES");
4781 if (p == NULL || *p == NUL)
4782 p = mch_getenv((char_u *)"LANG");
4783 }
4784# endif
4785# ifdef WIN32
4786 p = gettext_lang(p);
4787# endif
4788 return p;
4789}
4790#endif
4791
Bram Moolenaardef9e822004-12-31 20:58:58 +00004792/* Complicated #if; matches with where get_mess_env() is used below. */
4793#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4794 && defined(LC_MESSAGES))) \
4795 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4796 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
4797 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004798static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004799
4800/*
4801 * Get the language used for messages from the environment.
4802 */
4803 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004804get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805{
4806 char_u *p;
4807
4808 p = mch_getenv((char_u *)"LC_ALL");
4809 if (p == NULL || *p == NUL)
4810 {
4811 p = mch_getenv((char_u *)"LC_MESSAGES");
4812 if (p == NULL || *p == NUL)
4813 {
4814 p = mch_getenv((char_u *)"LANG");
4815 if (p != NULL && VIM_ISDIGIT(*p))
4816 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004817# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004818 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004819 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820# endif
4821 }
4822 }
4823 return p;
4824}
4825#endif
4826
4827#if defined(FEAT_EVAL) || defined(PROTO)
4828
4829/*
4830 * Set the "v:lang" variable according to the current locale setting.
4831 * Also do "v:lc_time"and "v:ctype".
4832 */
4833 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004834set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004835{
4836 char_u *loc;
4837
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004838# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004839 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840# else
4841 /* setlocale() not supported: use the default value */
4842 loc = (char_u *)"C";
4843# endif
4844 set_vim_var_string(VV_CTYPE, loc, -1);
4845
4846 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
4847 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004848# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004849 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850# else
4851 loc = get_mess_env();
4852# endif
4853 set_vim_var_string(VV_LANG, loc, -1);
4854
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004855# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004856 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857# endif
4858 set_vim_var_string(VV_LC_TIME, loc, -1);
4859}
4860#endif
4861
4862#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4863 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
4864/*
4865 * ":language": Set the language (locale).
4866 */
4867 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004868ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004869{
4870 char *loc;
4871 char_u *p;
4872 char_u *name;
4873 int what = LC_ALL;
4874 char *whatstr = "";
4875#ifdef LC_MESSAGES
4876# define VIM_LC_MESSAGES LC_MESSAGES
4877#else
4878# define VIM_LC_MESSAGES 6789
4879#endif
4880
4881 name = eap->arg;
4882
4883 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
4884 * Allow abbreviation, but require at least 3 characters to avoid
4885 * confusion with a two letter language name "me" or "ct". */
4886 p = skiptowhite(eap->arg);
4887 if ((*p == NUL || vim_iswhite(*p)) && p - eap->arg >= 3)
4888 {
4889 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
4890 {
4891 what = VIM_LC_MESSAGES;
4892 name = skipwhite(p);
4893 whatstr = "messages ";
4894 }
4895 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
4896 {
4897 what = LC_CTYPE;
4898 name = skipwhite(p);
4899 whatstr = "ctype ";
4900 }
4901 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
4902 {
4903 what = LC_TIME;
4904 name = skipwhite(p);
4905 whatstr = "time ";
4906 }
4907 }
4908
4909 if (*name == NUL)
4910 {
4911#ifndef LC_MESSAGES
4912 if (what == VIM_LC_MESSAGES)
4913 p = get_mess_env();
4914 else
4915#endif
4916 p = (char_u *)setlocale(what, NULL);
4917 if (p == NULL || *p == NUL)
4918 p = (char_u *)"Unknown";
4919 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
4920 }
4921 else
4922 {
4923#ifndef LC_MESSAGES
4924 if (what == VIM_LC_MESSAGES)
4925 loc = "";
4926 else
4927#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004928 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004929 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004930#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
4931 /* Make sure strtod() uses a decimal point, not a comma. */
4932 setlocale(LC_NUMERIC, "C");
4933#endif
4934 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004935 if (loc == NULL)
4936 EMSG2(_("E197: Cannot set language to \"%s\""), name);
4937 else
4938 {
4939#ifdef HAVE_NL_MSG_CAT_CNTR
4940 /* Need to do this for GNU gettext, otherwise cached translations
4941 * will be used again. */
4942 extern int _nl_msg_cat_cntr;
4943
4944 ++_nl_msg_cat_cntr;
4945#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00004946 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004947 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
4948
4949 if (what != LC_TIME)
4950 {
4951 /* Tell gettext() what to translate to. It apparently doesn't
4952 * use the currently effective locale. Also do this when
4953 * FEAT_GETTEXT isn't defined, so that shell commands use this
4954 * value. */
4955 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004956 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02004958
4959 /* Clear $LANGUAGE because GNU gettext uses it. */
4960 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004961# ifdef WIN32
4962 /* Apparently MS-Windows printf() may cause a crash when
4963 * we give it 8-bit text while it's expecting text in the
4964 * current locale. This call avoids that. */
4965 setlocale(LC_CTYPE, "C");
4966# endif
4967 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004968 if (what != LC_CTYPE)
4969 {
4970 char_u *mname;
4971#ifdef WIN32
4972 mname = gettext_lang(name);
4973#else
4974 mname = name;
4975#endif
4976 vim_setenv((char_u *)"LC_MESSAGES", mname);
4977#ifdef FEAT_MULTI_LANG
4978 set_helplang_default(mname);
4979#endif
4980 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 }
4982
4983# ifdef FEAT_EVAL
4984 /* Set v:lang, v:lc_time and v:ctype to the final result. */
4985 set_lang_var();
4986# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02004987# ifdef FEAT_TITLE
4988 maketitle();
4989# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 }
4991 }
4992}
4993
4994# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004995
4996static char_u **locales = NULL; /* Array of all available locales */
4997static int did_init_locales = FALSE;
4998
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004999static void init_locales(void);
5000static char_u **find_locales(void);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005001
5002/*
5003 * Lazy initialization of all available locales.
5004 */
5005 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005006init_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005007{
5008 if (!did_init_locales)
5009 {
5010 did_init_locales = TRUE;
5011 locales = find_locales();
5012 }
5013}
5014
5015/* Return an array of strings for all available locales + NULL for the
5016 * last element. Return NULL in case of error. */
5017 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005018find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005019{
5020 garray_T locales_ga;
5021 char_u *loc;
5022
5023 /* Find all available locales by running command "locale -a". If this
5024 * doesn't work we won't have completion. */
5025 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02005026 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005027 if (locale_a == NULL)
5028 return NULL;
5029 ga_init2(&locales_ga, sizeof(char_u *), 20);
5030
5031 /* Transform locale_a string where each locale is separated by "\n"
5032 * into an array of locale strings. */
5033 loc = (char_u *)strtok((char *)locale_a, "\n");
5034
5035 while (loc != NULL)
5036 {
5037 if (ga_grow(&locales_ga, 1) == FAIL)
5038 break;
5039 loc = vim_strsave(loc);
5040 if (loc == NULL)
5041 break;
5042
5043 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5044 loc = (char_u *)strtok(NULL, "\n");
5045 }
5046 vim_free(locale_a);
5047 if (ga_grow(&locales_ga, 1) == FAIL)
5048 {
5049 ga_clear(&locales_ga);
5050 return NULL;
5051 }
5052 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5053 return (char_u **)locales_ga.ga_data;
5054}
5055
5056# if defined(EXITFREE) || defined(PROTO)
5057 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005058free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005059{
5060 int i;
5061 if (locales != NULL)
5062 {
5063 for (i = 0; locales[i] != NULL; i++)
5064 vim_free(locales[i]);
5065 vim_free(locales);
5066 locales = NULL;
5067 }
5068}
5069# endif
5070
Bram Moolenaar071d4272004-06-13 20:20:40 +00005071/*
5072 * Function given to ExpandGeneric() to obtain the possible arguments of the
5073 * ":language" command.
5074 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005076get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077{
5078 if (idx == 0)
5079 return (char_u *)"messages";
5080 if (idx == 1)
5081 return (char_u *)"ctype";
5082 if (idx == 2)
5083 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005084
5085 init_locales();
5086 if (locales == NULL)
5087 return NULL;
5088 return locales[idx - 3];
5089}
5090
5091/*
5092 * Function given to ExpandGeneric() to obtain the available locales.
5093 */
5094 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005095get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005096{
5097 init_locales();
5098 if (locales == NULL)
5099 return NULL;
5100 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005101}
5102# endif
5103
5104#endif