blob: ec9f50a527f67932a9c2ec8c946ff477c81f5954 [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 Moolenaar975b5272016-03-15 23:10:59 +01001282# endif
1283
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001284#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1285# if defined(HAVE_MATH_H)
1286# include <math.h>
1287# endif
1288
1289/*
1290 * Divide the time "tm" by "count" and store in "tm2".
1291 */
1292 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001293profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001294{
1295 if (count == 0)
1296 profile_zero(tm2);
1297 else
1298 {
1299# ifdef WIN3264
1300 tm2->QuadPart = tm->QuadPart / count;
1301# else
1302 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1303
1304 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001305 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001306# endif
1307 }
1308}
1309#endif
1310
Bram Moolenaar76929292008-01-06 19:07:36 +00001311# if defined(FEAT_PROFILE) || defined(PROTO)
1312/*
1313 * Functions for profiling.
1314 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001315static void script_do_profile(scriptitem_T *si);
1316static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001317static proftime_T prof_wait_time;
1318
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001319/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001320 * Add the time "tm2" to "tm".
1321 */
1322 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001323profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001324{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001325# ifdef WIN3264
1326 tm->QuadPart += tm2->QuadPart;
1327# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001328 tm->tv_usec += tm2->tv_usec;
1329 tm->tv_sec += tm2->tv_sec;
1330 if (tm->tv_usec >= 1000000)
1331 {
1332 tm->tv_usec -= 1000000;
1333 ++tm->tv_sec;
1334 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001335# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001336}
1337
1338/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001339 * Add the "self" time from the total time and the children's time.
1340 */
1341 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001342profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001343{
1344 /* Check that the result won't be negative. Can happen with recursive
1345 * calls. */
1346#ifdef WIN3264
1347 if (total->QuadPart <= children->QuadPart)
1348 return;
1349#else
1350 if (total->tv_sec < children->tv_sec
1351 || (total->tv_sec == children->tv_sec
1352 && total->tv_usec <= children->tv_usec))
1353 return;
1354#endif
1355 profile_add(self, total);
1356 profile_sub(self, children);
1357}
1358
1359/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001360 * Get the current waittime.
1361 */
1362 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001363profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001364{
1365 *tm = prof_wait_time;
1366}
1367
1368/*
1369 * Subtract the passed waittime since "tm" from "tma".
1370 */
1371 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001372profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001373{
1374 proftime_T tm3 = prof_wait_time;
1375
1376 profile_sub(&tm3, tm);
1377 profile_sub(tma, &tm3);
1378}
1379
1380/*
1381 * Return TRUE if "tm1" and "tm2" are equal.
1382 */
1383 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001384profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001385{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001386# ifdef WIN3264
1387 return (tm1->QuadPart == tm2->QuadPart);
1388# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001389 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001390# endif
1391}
1392
1393/*
1394 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1395 */
1396 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001397profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001398{
1399# ifdef WIN3264
1400 return (int)(tm2->QuadPart - tm1->QuadPart);
1401# else
1402 if (tm1->tv_sec == tm2->tv_sec)
1403 return tm2->tv_usec - tm1->tv_usec;
1404 return tm2->tv_sec - tm1->tv_sec;
1405# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001406}
1407
Bram Moolenaar05159a02005-02-26 23:04:13 +00001408static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001409static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001410
1411/*
1412 * ":profile cmd args"
1413 */
1414 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001415ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001416{
1417 char_u *e;
1418 int len;
1419
1420 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001421 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001422 e = skipwhite(e);
1423
1424 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1425 {
1426 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001427 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001428 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001429 profile_zero(&prof_wait_time);
1430 set_vim_var_nr(VV_PROFILING, 1L);
1431 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001432 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001433 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001434 else if (STRCMP(eap->arg, "pause") == 0)
1435 {
1436 if (do_profiling == PROF_YES)
1437 profile_start(&pause_time);
1438 do_profiling = PROF_PAUSED;
1439 }
1440 else if (STRCMP(eap->arg, "continue") == 0)
1441 {
1442 if (do_profiling == PROF_PAUSED)
1443 {
1444 profile_end(&pause_time);
1445 profile_add(&prof_wait_time, &pause_time);
1446 }
1447 do_profiling = PROF_YES;
1448 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001449 else
1450 {
1451 /* The rest is similar to ":breakadd". */
1452 ex_breakadd(eap);
1453 }
1454}
1455
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001456/* Command line expansion for :profile. */
1457static enum
1458{
1459 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001460 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001461} pexpand_what;
1462
1463static char *pexpand_cmds[] = {
1464 "start",
1465#define PROFCMD_START 0
1466 "pause",
1467#define PROFCMD_PAUSE 1
1468 "continue",
1469#define PROFCMD_CONTINUE 2
1470 "func",
1471#define PROFCMD_FUNC 3
1472 "file",
1473#define PROFCMD_FILE 4
1474 NULL
1475#define PROFCMD_LAST 5
1476};
1477
1478/*
1479 * Function given to ExpandGeneric() to obtain the profile command
1480 * specific expansion.
1481 */
1482 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001483get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001484{
1485 switch (pexpand_what)
1486 {
1487 case PEXP_SUBCMD:
1488 return (char_u *)pexpand_cmds[idx];
1489 /* case PEXP_FUNC: TODO */
1490 default:
1491 return NULL;
1492 }
1493}
1494
1495/*
1496 * Handle command line completion for :profile command.
1497 */
1498 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001499set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001500{
1501 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001502
1503 /* Default: expand subcommands. */
1504 xp->xp_context = EXPAND_PROFILE;
1505 pexpand_what = PEXP_SUBCMD;
1506 xp->xp_pattern = arg;
1507
1508 end_subcmd = skiptowhite(arg);
1509 if (*end_subcmd == NUL)
1510 return;
1511
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001512 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001513 {
1514 xp->xp_context = EXPAND_FILES;
1515 xp->xp_pattern = skipwhite(end_subcmd);
1516 return;
1517 }
1518
1519 /* TODO: expand function names after "func" */
1520 xp->xp_context = EXPAND_NOTHING;
1521}
1522
Bram Moolenaar05159a02005-02-26 23:04:13 +00001523/*
1524 * Dump the profiling info.
1525 */
1526 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001527profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001528{
1529 FILE *fd;
1530
1531 if (profile_fname != NULL)
1532 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001533 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001534 if (fd == NULL)
1535 EMSG2(_(e_notopen), profile_fname);
1536 else
1537 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001538 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001539 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001540 fclose(fd);
1541 }
1542 }
1543}
1544
1545/*
1546 * Start profiling script "fp".
1547 */
1548 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001549script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001550{
1551 si->sn_pr_count = 0;
1552 profile_zero(&si->sn_pr_total);
1553 profile_zero(&si->sn_pr_self);
1554
1555 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1556 si->sn_prl_idx = -1;
1557 si->sn_prof_on = TRUE;
1558 si->sn_pr_nest = 0;
1559}
1560
1561/*
1562 * save time when starting to invoke another script or function.
1563 */
1564 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001565script_prof_save(
1566 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001567{
1568 scriptitem_T *si;
1569
1570 if (current_SID > 0 && current_SID <= script_items.ga_len)
1571 {
1572 si = &SCRIPT_ITEM(current_SID);
1573 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1574 profile_start(&si->sn_pr_child);
1575 }
1576 profile_get_wait(tm);
1577}
1578
1579/*
1580 * Count time spent in children after invoking another script or function.
1581 */
1582 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001583script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001584{
1585 scriptitem_T *si;
1586
1587 if (current_SID > 0 && current_SID <= script_items.ga_len)
1588 {
1589 si = &SCRIPT_ITEM(current_SID);
1590 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1591 {
1592 profile_end(&si->sn_pr_child);
1593 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1594 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1595 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1596 }
1597 }
1598}
1599
1600static proftime_T inchar_time;
1601
1602/*
1603 * Called when starting to wait for the user to type a character.
1604 */
1605 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001606prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001607{
1608 profile_start(&inchar_time);
1609}
1610
1611/*
1612 * Called when finished waiting for the user to type a character.
1613 */
1614 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001615prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001616{
1617 profile_end(&inchar_time);
1618 profile_add(&prof_wait_time, &inchar_time);
1619}
1620
1621/*
1622 * Dump the profiling results for all scripts in file "fd".
1623 */
1624 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001625script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001626{
1627 int id;
1628 scriptitem_T *si;
1629 int i;
1630 FILE *sfd;
1631 sn_prl_T *pp;
1632
1633 for (id = 1; id <= script_items.ga_len; ++id)
1634 {
1635 si = &SCRIPT_ITEM(id);
1636 if (si->sn_prof_on)
1637 {
1638 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1639 if (si->sn_pr_count == 1)
1640 fprintf(fd, "Sourced 1 time\n");
1641 else
1642 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1643 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1644 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1645 fprintf(fd, "\n");
1646 fprintf(fd, "count total (s) self (s)\n");
1647
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001648 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001649 if (sfd == NULL)
1650 fprintf(fd, "Cannot open file!\n");
1651 else
1652 {
1653 for (i = 0; i < si->sn_prl_ga.ga_len; ++i)
1654 {
1655 if (vim_fgets(IObuff, IOSIZE, sfd))
1656 break;
1657 pp = &PRL_ITEM(si, i);
1658 if (pp->snp_count > 0)
1659 {
1660 fprintf(fd, "%5d ", pp->snp_count);
1661 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1662 fprintf(fd, " ");
1663 else
1664 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1665 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1666 }
1667 else
1668 fprintf(fd, " ");
1669 fprintf(fd, "%s", IObuff);
1670 }
1671 fclose(sfd);
1672 }
1673 fprintf(fd, "\n");
1674 }
1675 }
1676}
1677
1678/*
1679 * Return TRUE when a function defined in the current script should be
1680 * profiled.
1681 */
1682 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001683prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001684{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00001685 if (current_SID > 0)
1686 return SCRIPT_ITEM(current_SID).sn_pr_force;
1687 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001688}
1689
1690# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691#endif
1692
1693/*
1694 * If 'autowrite' option set, try to write the file.
1695 * Careful: autocommands may make "buf" invalid!
1696 *
1697 * return FAIL for failure, OK otherwise
1698 */
1699 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001700autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001701{
Bram Moolenaar373154b2007-02-13 05:19:30 +00001702 int r;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001703 bufref_T bufref;
Bram Moolenaar373154b2007-02-13 05:19:30 +00001704
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 if (!(p_aw || p_awa) || !p_write
1706#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00001707 /* never autowrite a "nofile" or "nowrite" buffer */
1708 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00001710 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 return FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001712 set_bufref(&bufref, buf);
Bram Moolenaar373154b2007-02-13 05:19:30 +00001713 r = buf_write_all(buf, forceit);
1714
1715 /* Writing may succeed but the buffer still changed, e.g., when there is a
1716 * conversion error. We do want to return FAIL then. */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001717 if (bufref_valid(&bufref) && bufIsChanged(buf))
Bram Moolenaar373154b2007-02-13 05:19:30 +00001718 r = FAIL;
1719 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720}
1721
1722/*
1723 * flush all buffers, except the ones that are readonly
1724 */
1725 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001726autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727{
1728 buf_T *buf;
1729
1730 if (!(p_aw || p_awa) || !p_write)
1731 return;
Bram Moolenaar29323592016-07-24 22:04:11 +02001732 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 if (bufIsChanged(buf) && !buf->b_p_ro)
1734 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001735#ifdef FEAT_AUTOCMD
1736 bufref_T bufref;
1737
1738 set_bufref(&bufref, buf);
1739#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 (void)buf_write_all(buf, FALSE);
1741#ifdef FEAT_AUTOCMD
1742 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001743 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 buf = firstbuf;
1745#endif
1746 }
1747}
1748
1749/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001750 * Return TRUE if buffer was changed and cannot be abandoned.
1751 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001752 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001753 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001754check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755{
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001756 int forceit = (flags & CCGD_FORCEIT);
1757#ifdef FEAT_AUTOCMD
1758 bufref_T bufref;
1759
1760 set_bufref(&bufref, buf);
1761#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001762
Bram Moolenaar071d4272004-06-13 20:20:40 +00001763 if ( !forceit
1764 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001765 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
1766 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 {
1768#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1769 if ((p_confirm || cmdmod.confirm) && p_write)
1770 {
1771 buf_T *buf2;
1772 int count = 0;
1773
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001774 if (flags & CCGD_ALLBUF)
Bram Moolenaar29323592016-07-24 22:04:11 +02001775 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 if (bufIsChanged(buf2)
1777 && (buf2->b_ffname != NULL
1778# ifdef FEAT_BROWSE
1779 || cmdmod.browse
1780# endif
1781 ))
1782 ++count;
1783# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001784 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 /* Autocommand deleted buffer, oops! It's not changed now. */
1786 return FALSE;
1787# endif
1788 dialog_changed(buf, count > 1);
1789# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001790 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 /* Autocommand deleted buffer, oops! It's not changed now. */
1792 return FALSE;
1793# endif
1794 return bufIsChanged(buf);
1795 }
1796#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001797 if (flags & CCGD_EXCMD)
1798 EMSG(_(e_nowrtmsg));
1799 else
1800 EMSG(_(e_nowrtmsg_nobang));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 return TRUE;
1802 }
1803 return FALSE;
1804}
1805
1806#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
1807
1808#if defined(FEAT_BROWSE) || defined(PROTO)
1809/*
1810 * When wanting to write a file without a file name, ask the user for a name.
1811 */
1812 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001813browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814{
1815 if (buf->b_fname == NULL)
1816 {
1817 char_u *fname;
1818
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001819 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
1820 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 if (fname != NULL)
1822 {
1823 if (setfname(buf, fname, NULL, TRUE) == OK)
1824 buf->b_flags |= BF_NOTEDITED;
1825 vim_free(fname);
1826 }
1827 }
1828}
1829#endif
1830
1831/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02001832 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 * Must check 'write' option first!
1834 */
1835 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001836dialog_changed(
1837 buf_T *buf,
1838 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839{
Bram Moolenaard9462e32011-04-11 21:35:11 +02001840 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001841 int ret;
1842 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02001843 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00001845 dialog_msg(buff, _("Save changes to \"%s\"?"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 (buf->b_fname != NULL) ?
1847 buf->b_fname : (char_u *)_("Untitled"));
1848 if (checkall)
1849 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
1850 else
1851 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
1852
Bram Moolenaar8218f602012-04-25 17:32:18 +02001853 /* Init ea pseudo-structure, this is needed for the check_overwrite()
1854 * function. */
1855 ea.append = ea.forceit = FALSE;
1856
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 if (ret == VIM_YES)
1858 {
1859#ifdef FEAT_BROWSE
1860 /* May get file name, when there is none */
1861 browse_save_fname(buf);
1862#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02001863 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
1864 buf->b_fname, buf->b_ffname, FALSE) == OK)
1865 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866 (void)buf_write_all(buf, FALSE);
1867 }
1868 else if (ret == VIM_NO)
1869 {
1870 unchanged(buf, TRUE);
1871 }
1872 else if (ret == VIM_ALL)
1873 {
1874 /*
1875 * Write all modified files that can be written.
1876 * Skip readonly buffers, these need to be confirmed
1877 * individually.
1878 */
Bram Moolenaar29323592016-07-24 22:04:11 +02001879 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001880 {
1881 if (bufIsChanged(buf2)
1882 && (buf2->b_ffname != NULL
1883#ifdef FEAT_BROWSE
1884 || cmdmod.browse
1885#endif
1886 )
1887 && !buf2->b_p_ro)
1888 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001889#ifdef FEAT_AUTOCMD
1890 bufref_T bufref;
1891
1892 set_bufref(&bufref, buf2);
1893#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894#ifdef FEAT_BROWSE
1895 /* May get file name, when there is none */
1896 browse_save_fname(buf2);
1897#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02001898 if (buf2->b_fname != NULL && check_overwrite(&ea, buf2,
1899 buf2->b_fname, buf2->b_ffname, FALSE) == OK)
1900 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901 (void)buf_write_all(buf2, FALSE);
1902#ifdef FEAT_AUTOCMD
1903 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001904 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 buf2 = firstbuf;
1906#endif
1907 }
1908 }
1909 }
1910 else if (ret == VIM_DISCARDALL)
1911 {
1912 /*
1913 * mark all buffers as unchanged
1914 */
Bram Moolenaar29323592016-07-24 22:04:11 +02001915 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 unchanged(buf2, TRUE);
1917 }
1918}
1919#endif
1920
1921/*
1922 * Return TRUE if the buffer "buf" can be abandoned, either by making it
1923 * hidden, autowriting it or unloading it.
1924 */
1925 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001926can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927{
1928 return ( P_HID(buf)
1929 || !bufIsChanged(buf)
1930 || buf->b_nwindows > 1
1931 || autowrite(buf, forceit) == OK
1932 || forceit);
1933}
1934
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001935static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001936
1937/*
1938 * Add a buffer number to "bufnrs", unless it's already there.
1939 */
1940 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001941add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001942{
1943 int i;
1944
1945 for (i = 0; i < *bufnump; ++i)
1946 if (bufnrs[i] == nr)
1947 return;
1948 bufnrs[*bufnump] = nr;
1949 *bufnump = *bufnump + 1;
1950}
1951
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952/*
1953 * Return TRUE if any buffer was changed and cannot be abandoned.
1954 * That changed buffer becomes the current buffer.
Bram Moolenaar027387f2016-01-02 22:25:52 +01001955 * When "unload" is true the current buffer is unloaded instead of making it
1956 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001957 */
1958 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001959check_changed_any(
1960 int hidden, /* Only check hidden buffers */
1961 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001962{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001963 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 buf_T *buf;
1965 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001966 int i;
1967 int bufnum = 0;
1968 int bufcount = 0;
1969 int *bufnrs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001970#ifdef FEAT_WINDOWS
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001971 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 win_T *wp;
1973#endif
1974
Bram Moolenaar29323592016-07-24 22:04:11 +02001975 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001976 ++bufcount;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001977
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001978 if (bufcount == 0)
1979 return FALSE;
1980
1981 bufnrs = (int *)alloc(sizeof(int) * bufcount);
1982 if (bufnrs == NULL)
1983 return FALSE;
1984
1985 /* curbuf */
1986 bufnrs[bufnum++] = curbuf->b_fnum;
1987#ifdef FEAT_WINDOWS
1988 /* buf in curtab */
1989 FOR_ALL_WINDOWS(wp)
1990 if (wp->w_buffer != curbuf)
1991 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
1992
1993 /* buf in other tab */
Bram Moolenaar29323592016-07-24 22:04:11 +02001994 FOR_ALL_TABPAGES(tp)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001995 if (tp != curtab)
1996 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
1997 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
1998#endif
1999 /* any other buf */
Bram Moolenaar29323592016-07-24 22:04:11 +02002000 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002001 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
2002
2003 for (i = 0; i < bufnum; ++i)
2004 {
2005 buf = buflist_findnr(bufnrs[i]);
2006 if (buf == NULL)
2007 continue;
2008 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
2009 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002010 bufref_T bufref;
2011
2012 set_bufref(&bufref, buf);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002013 /* Try auto-writing the buffer. If this fails but the buffer no
2014 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002015 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
2016 | CCGD_MULTWIN
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002017 | CCGD_ALLBUF) && bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002018 break; /* didn't save - still changes */
2019 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 }
2021
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002022 if (i >= bufnum)
2023 goto theend;
2024
2025 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 exiting = FALSE;
2027#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2028 /*
2029 * When ":confirm" used, don't give an error message.
2030 */
2031 if (!(p_confirm || cmdmod.confirm))
2032#endif
2033 {
2034 /* There must be a wait_return for this message, do_buffer()
2035 * may cause a redraw. But wait_return() is a no-op when vgetc()
2036 * is busy (Quit used from window menu), then make sure we don't
2037 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00002038 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039 {
2040 msg_row = cmdline_row;
2041 msg_col = 0;
2042 msg_didout = FALSE;
2043 }
2044 if (EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002045 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002046 {
2047 save = no_wait_return;
2048 no_wait_return = FALSE;
2049 wait_return(FALSE);
2050 no_wait_return = save;
2051 }
2052 }
2053
2054#ifdef FEAT_WINDOWS
2055 /* Try to find a window that contains the buffer. */
2056 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002057 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002058 if (wp->w_buffer == buf)
2059 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002060# ifdef FEAT_AUTOCMD
2061 bufref_T bufref;
2062
2063 set_bufref(&bufref, buf);
2064# endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002065 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066# ifdef FEAT_AUTOCMD
2067 /* Paranoia: did autocms wipe out the buffer with changes? */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002068 if (!bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002069 {
2070 goto theend;
2071 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072# endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002073 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002075buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076#endif
2077
2078 /* Open the changed buffer in the current window. */
2079 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002080 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002081
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002082theend:
2083 vim_free(bufnrs);
2084 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085}
2086
2087/*
2088 * return FAIL if there is no file name, OK if there is one
2089 * give error message for FAIL
2090 */
2091 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002092check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093{
2094 if (curbuf->b_ffname == NULL)
2095 {
2096 EMSG(_(e_noname));
2097 return FAIL;
2098 }
2099 return OK;
2100}
2101
2102/*
2103 * flush the contents of a buffer, unless it has no file name
2104 *
2105 * return FAIL for failure, OK otherwise
2106 */
2107 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002108buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109{
2110 int retval;
2111#ifdef FEAT_AUTOCMD
2112 buf_T *old_curbuf = curbuf;
2113#endif
2114
2115 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2116 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2117 FALSE, forceit, TRUE, FALSE));
2118#ifdef FEAT_AUTOCMD
2119 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002120 {
2121 msg_source(hl_attr(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002123 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124#endif
2125 return retval;
2126}
2127
2128/*
2129 * Code to handle the argument list.
2130 */
2131
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002132static char_u *do_one_arg(char_u *str);
2133static int do_arglist(char_u *str, int what, int after);
2134static void alist_check_arg_idx(void);
2135static int editing_arg_idx(win_T *win);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002136#ifdef FEAT_LISTCMDS
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002137static int alist_add_list(int count, char_u **files, int after);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002138#endif
2139#define AL_SET 1
2140#define AL_ADD 2
2141#define AL_DEL 3
2142
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002144 * Isolate one argument, taking backticks.
2145 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 * Return a pointer to the start of the next argument.
2147 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002148 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002149do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150{
2151 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152 int inbacktick;
2153
Bram Moolenaar071d4272004-06-13 20:20:40 +00002154 inbacktick = FALSE;
2155 for (p = str; *str; ++str)
2156 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002157 /* When the backslash is used for escaping the special meaning of a
2158 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 if (rem_backslash(str))
2160 {
2161 *p++ = *str++;
2162 *p++ = *str;
2163 }
2164 else
2165 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002166 /* An item ends at a space not in backticks */
2167 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002169 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002171 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002172 }
2173 }
2174 str = skipwhite(str);
2175 *p = NUL;
2176
2177 return str;
2178}
2179
Bram Moolenaar86b68352004-12-27 21:59:20 +00002180/*
2181 * Separate the arguments in "str" and return a list of pointers in the
2182 * growarray "gap".
2183 */
2184 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002185get_arglist(garray_T *gap, char_u *str)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002186{
2187 ga_init2(gap, (int)sizeof(char_u *), 20);
2188 while (*str != NUL)
2189 {
2190 if (ga_grow(gap, 1) == FAIL)
2191 {
2192 ga_clear(gap);
2193 return FAIL;
2194 }
2195 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2196
2197 /* Isolate one argument, change it in-place, put a NUL after it. */
2198 str = do_one_arg(str);
2199 }
2200 return OK;
2201}
2202
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002203#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002204/*
2205 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002206 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002207 * Return FAIL or OK.
2208 */
2209 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002210get_arglist_exp(
2211 char_u *str,
2212 int *fcountp,
2213 char_u ***fnamesp,
2214 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002215{
2216 garray_T ga;
2217 int i;
2218
2219 if (get_arglist(&ga, str) == FAIL)
2220 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002221 if (wig == TRUE)
2222 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2223 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2224 else
2225 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2226 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2227
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002228 ga_clear(&ga);
2229 return i;
2230}
2231#endif
2232
Bram Moolenaar071d4272004-06-13 20:20:40 +00002233#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
2234/*
2235 * Redefine the argument list.
2236 */
2237 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002238set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239{
2240 do_arglist(str, AL_SET, 0);
2241}
2242#endif
2243
2244/*
2245 * "what" == AL_SET: Redefine the argument list to 'str'.
2246 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2247 * "what" == AL_DEL: remove files in 'str' from the argument list.
2248 *
2249 * Return FAIL for failure, OK otherwise.
2250 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002252do_arglist(
2253 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002254 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002255 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256{
2257 garray_T new_ga;
2258 int exp_count;
2259 char_u **exp_files;
2260 int i;
2261#ifdef FEAT_LISTCMDS
2262 char_u *p;
2263 int match;
2264#endif
2265
2266 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002267 * Set default argument for ":argadd" command.
2268 */
2269 if (what == AL_ADD && *str == NUL)
2270 {
2271 if (curbuf->b_ffname == NULL)
2272 return FAIL;
2273 str = curbuf->b_fname;
2274 }
2275
2276 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 * Collect all file name arguments in "new_ga".
2278 */
Bram Moolenaar86b68352004-12-27 21:59:20 +00002279 if (get_arglist(&new_ga, str) == FAIL)
2280 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281
2282#ifdef FEAT_LISTCMDS
2283 if (what == AL_DEL)
2284 {
2285 regmatch_T regmatch;
2286 int didone;
2287
2288 /*
2289 * Delete the items: use each item as a regexp and find a match in the
2290 * argument list.
2291 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002292 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2294 {
2295 p = ((char_u **)new_ga.ga_data)[i];
2296 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2297 if (p == NULL)
2298 break;
2299 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2300 if (regmatch.regprog == NULL)
2301 {
2302 vim_free(p);
2303 break;
2304 }
2305
2306 didone = FALSE;
2307 for (match = 0; match < ARGCOUNT; ++match)
2308 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2309 (colnr_T)0))
2310 {
2311 didone = TRUE;
2312 vim_free(ARGLIST[match].ae_fname);
2313 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2314 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2315 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 if (curwin->w_arg_idx > match)
2317 --curwin->w_arg_idx;
2318 --match;
2319 }
2320
Bram Moolenaar473de612013-06-08 18:19:48 +02002321 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002322 vim_free(p);
2323 if (!didone)
2324 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2325 }
2326 ga_clear(&new_ga);
2327 }
2328 else
2329#endif
2330 {
2331 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2332 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2333 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002334 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335 {
2336 EMSG(_(e_nomatch));
2337 return FAIL;
2338 }
2339
2340#ifdef FEAT_LISTCMDS
2341 if (what == AL_ADD)
2342 {
2343 (void)alist_add_list(exp_count, exp_files, after);
2344 vim_free(exp_files);
2345 }
2346 else /* what == AL_SET */
2347#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00002348 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002349 }
2350
2351 alist_check_arg_idx();
2352
2353 return OK;
2354}
2355
2356/*
2357 * Check the validity of the arg_idx for each other window.
2358 */
2359 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002360alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002361{
2362#ifdef FEAT_WINDOWS
2363 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002364 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365
Bram Moolenaarf740b292006-02-16 22:11:02 +00002366 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 if (win->w_alist == curwin->w_alist)
2368 check_arg_idx(win);
2369#else
2370 check_arg_idx(curwin);
2371#endif
2372}
2373
2374/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002375 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002376 * index.
2377 */
2378 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002379editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002380{
2381 return !(win->w_arg_idx >= WARGCOUNT(win)
2382 || (win->w_buffer->b_fnum
2383 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2384 && (win->w_buffer->b_ffname == NULL
2385 || !(fullpathcmp(
2386 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2387 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2388}
2389
2390/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391 * Check if window "win" is editing the w_arg_idx file in its argument list.
2392 */
2393 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002394check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002396 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 {
2398 /* We are not editing the current entry in the argument list.
2399 * Set "arg_had_last" if we are editing the last one. */
2400 win->w_arg_idx_invalid = TRUE;
2401 if (win->w_arg_idx != WARGCOUNT(win) - 1
2402 && arg_had_last == FALSE
2403#ifdef FEAT_WINDOWS
2404 && ALIST(win) == &global_alist
2405#endif
2406 && GARGCOUNT > 0
2407 && win->w_arg_idx < GARGCOUNT
2408 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2409 || (win->w_buffer->b_ffname != NULL
2410 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2411 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2412 arg_had_last = TRUE;
2413 }
2414 else
2415 {
2416 /* We are editing the current entry in the argument list.
2417 * Set "arg_had_last" if it's also the last one */
2418 win->w_arg_idx_invalid = FALSE;
2419 if (win->w_arg_idx == WARGCOUNT(win) - 1
2420#ifdef FEAT_WINDOWS
2421 && win->w_alist == &global_alist
2422#endif
2423 )
2424 arg_had_last = TRUE;
2425 }
2426}
2427
2428/*
2429 * ":args", ":argslocal" and ":argsglobal".
2430 */
2431 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002432ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433{
2434 int i;
2435
2436 if (eap->cmdidx != CMD_args)
2437 {
2438#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2439 alist_unlink(ALIST(curwin));
2440 if (eap->cmdidx == CMD_argglobal)
2441 ALIST(curwin) = &global_alist;
2442 else /* eap->cmdidx == CMD_arglocal */
2443 alist_new();
2444#else
2445 ex_ni(eap);
2446 return;
2447#endif
2448 }
2449
2450 if (!ends_excmd(*eap->arg))
2451 {
2452 /*
2453 * ":args file ..": define new argument list, handle like ":next"
2454 * Also for ":argslocal file .." and ":argsglobal file ..".
2455 */
2456 ex_next(eap);
2457 }
2458 else
2459#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2460 if (eap->cmdidx == CMD_args)
2461#endif
2462 {
2463 /*
2464 * ":args": list arguments.
2465 */
2466 if (ARGCOUNT > 0)
2467 {
2468 /* Overwrite the command, for a short list there is no scrolling
2469 * required and no wait_return(). */
2470 gotocmdline(TRUE);
2471 for (i = 0; i < ARGCOUNT; ++i)
2472 {
2473 if (i == curwin->w_arg_idx)
2474 msg_putchar('[');
2475 msg_outtrans(alist_name(&ARGLIST[i]));
2476 if (i == curwin->w_arg_idx)
2477 msg_putchar(']');
2478 msg_putchar(' ');
2479 }
2480 }
2481 }
2482#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2483 else if (eap->cmdidx == CMD_arglocal)
2484 {
2485 garray_T *gap = &curwin->w_alist->al_ga;
2486
2487 /*
2488 * ":argslocal": make a local copy of the global argument list.
2489 */
2490 if (ga_grow(gap, GARGCOUNT) == OK)
2491 for (i = 0; i < GARGCOUNT; ++i)
2492 if (GARGLIST[i].ae_fname != NULL)
2493 {
2494 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2495 vim_strsave(GARGLIST[i].ae_fname);
2496 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2497 GARGLIST[i].ae_fnum;
2498 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499 }
2500 }
2501#endif
2502}
2503
2504/*
2505 * ":previous", ":sprevious", ":Next" and ":sNext".
2506 */
2507 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002508ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509{
2510 /* If past the last one already, go to the last one. */
2511 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2512 do_argfile(eap, ARGCOUNT - 1);
2513 else
2514 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2515}
2516
2517/*
2518 * ":rewind", ":first", ":sfirst" and ":srewind".
2519 */
2520 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002521ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002522{
2523 do_argfile(eap, 0);
2524}
2525
2526/*
2527 * ":last" and ":slast".
2528 */
2529 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002530ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531{
2532 do_argfile(eap, ARGCOUNT - 1);
2533}
2534
2535/*
2536 * ":argument" and ":sargument".
2537 */
2538 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002539ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540{
2541 int i;
2542
2543 if (eap->addr_count > 0)
2544 i = eap->line2 - 1;
2545 else
2546 i = curwin->w_arg_idx;
2547 do_argfile(eap, i);
2548}
2549
2550/*
2551 * Edit file "argn" of the argument lists.
2552 */
2553 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002554do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555{
2556 int other;
2557 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002558 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559
2560 if (argn < 0 || argn >= ARGCOUNT)
2561 {
2562 if (ARGCOUNT <= 1)
2563 EMSG(_("E163: There is only one file to edit"));
2564 else if (argn < 0)
2565 EMSG(_("E164: Cannot go before first file"));
2566 else
2567 EMSG(_("E165: Cannot go beyond last file"));
2568 }
2569 else
2570 {
2571 setpcmark();
2572#ifdef FEAT_GUI
2573 need_mouse_correct = TRUE;
2574#endif
2575
2576#ifdef FEAT_WINDOWS
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002577 /* split window or create new tab page first */
2578 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 {
2580 if (win_split(0, 0) == FAIL)
2581 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002582 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 }
2584 else
2585#endif
2586 {
2587 /*
2588 * if 'hidden' set, only check for changed file when re-editing
2589 * the same buffer
2590 */
2591 other = TRUE;
2592 if (P_HID(curbuf))
2593 {
2594 p = fix_fname(alist_name(&ARGLIST[argn]));
2595 other = otherfile(p);
2596 vim_free(p);
2597 }
2598 if ((!P_HID(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002599 && check_changed(curbuf, CCGD_AW
2600 | (other ? 0 : CCGD_MULTWIN)
2601 | (eap->forceit ? CCGD_FORCEIT : 0)
2602 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002603 return;
2604 }
2605
2606 curwin->w_arg_idx = argn;
2607 if (argn == ARGCOUNT - 1
2608#ifdef FEAT_WINDOWS
2609 && curwin->w_alist == &global_alist
2610#endif
2611 )
2612 arg_had_last = TRUE;
2613
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002614 /* Edit the file; always use the last known line number.
2615 * When it fails (e.g. Abort for already edited file) restore the
2616 * argument index. */
2617 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002618 eap, ECMD_LAST,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002619 (P_HID(curwin->w_buffer) ? ECMD_HIDE : 0)
2620 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002621 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002622 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002623 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 setmark('\'');
2625 }
2626}
2627
2628/*
2629 * ":next", and commands that behave like it.
2630 */
2631 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002632ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002633{
2634 int i;
2635
2636 /*
2637 * check for changed buffer now, if this fails the argument list is not
2638 * redefined.
2639 */
2640 if ( P_HID(curbuf)
2641 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002642 || !check_changed(curbuf, CCGD_AW
2643 | (eap->forceit ? CCGD_FORCEIT : 0)
2644 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002645 {
2646 if (*eap->arg != NUL) /* redefine file list */
2647 {
2648 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2649 return;
2650 i = 0;
2651 }
2652 else
2653 i = curwin->w_arg_idx + (int)eap->line2;
2654 do_argfile(eap, i);
2655 }
2656}
2657
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002658#if defined(FEAT_LISTCMDS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002659/*
2660 * ":argedit"
2661 */
2662 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002663ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002664{
2665 int fnum;
2666 int i;
2667 char_u *s;
2668
2669 /* Add the argument to the buffer list and get the buffer number. */
2670 fnum = buflist_add(eap->arg, BLN_LISTED);
2671
2672 /* Check if this argument is already in the argument list. */
2673 for (i = 0; i < ARGCOUNT; ++i)
2674 if (ARGLIST[i].ae_fnum == fnum)
2675 break;
2676 if (i == ARGCOUNT)
2677 {
2678 /* Can't find it, add it to the argument list. */
2679 s = vim_strsave(eap->arg);
2680 if (s == NULL)
2681 return;
2682 i = alist_add_list(1, &s,
2683 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2684 if (i < 0)
2685 return;
2686 curwin->w_arg_idx = i;
2687 }
2688
2689 alist_check_arg_idx();
2690
2691 /* Edit the argument. */
2692 do_argfile(eap, i);
2693}
2694
2695/*
2696 * ":argadd"
2697 */
2698 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002699ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700{
2701 do_arglist(eap->arg, AL_ADD,
2702 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2703#ifdef FEAT_TITLE
2704 maketitle();
2705#endif
2706}
2707
2708/*
2709 * ":argdelete"
2710 */
2711 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002712ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713{
2714 int i;
2715 int n;
2716
2717 if (eap->addr_count > 0)
2718 {
2719 /* ":1,4argdel": Delete all arguments in the range. */
2720 if (eap->line2 > ARGCOUNT)
2721 eap->line2 = ARGCOUNT;
2722 n = eap->line2 - eap->line1 + 1;
2723 if (*eap->arg != NUL || n <= 0)
2724 EMSG(_(e_invarg));
2725 else
2726 {
2727 for (i = eap->line1; i <= eap->line2; ++i)
2728 vim_free(ARGLIST[i - 1].ae_fname);
2729 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
2730 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
2731 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 if (curwin->w_arg_idx >= eap->line2)
2733 curwin->w_arg_idx -= n;
2734 else if (curwin->w_arg_idx > eap->line1)
2735 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01002736 if (ARGCOUNT == 0)
2737 curwin->w_arg_idx = 0;
2738 else if (curwin->w_arg_idx >= ARGCOUNT)
2739 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 }
2741 }
2742 else if (*eap->arg == NUL)
2743 EMSG(_(e_argreq));
2744 else
2745 do_arglist(eap->arg, AL_DEL, 0);
2746#ifdef FEAT_TITLE
2747 maketitle();
2748#endif
2749}
2750
2751/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002752 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 */
2754 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002755ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756{
2757 int i;
2758#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002759 win_T *wp;
2760 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761#endif
Bram Moolenaare25bb902015-02-27 20:33:37 +01002762 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763 int next_fnum = 0;
2764#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
2765 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002767 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002768#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02002769 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002770 int qf_idx;
2771#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772
2773#ifndef FEAT_WINDOWS
2774 if (eap->cmdidx == CMD_windo)
2775 {
2776 ex_ni(eap);
2777 return;
2778 }
2779#endif
2780
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002781#ifndef FEAT_QUICKFIX
2782 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
2783 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2784 {
2785 ex_ni(eap);
2786 return;
2787 }
2788#endif
2789
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002791 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00002792 /* Don't do syntax HL autocommands. Skipping the syntax file is a
2793 * great speed improvement. */
2794 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02002796#ifdef FEAT_CLIPBOARD
2797 start_global_changes();
2798#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799
2800 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002801 || eap->cmdidx == CMD_tabdo
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 || P_HID(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002803 || !check_changed(curbuf, CCGD_AW
2804 | (eap->forceit ? CCGD_FORCEIT : 0)
2805 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002806 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002808 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002810 wp = firstwin;
2811 tp = first_tabpage;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002812#endif
Bram Moolenaara162bc52015-01-07 16:54:21 +01002813 switch (eap->cmdidx)
2814 {
2815#ifdef FEAT_WINDOWS
2816 case CMD_windo:
2817 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
2818 i++;
2819 break;
2820 case CMD_tabdo:
2821 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
2822 i++;
2823 break;
2824#endif
2825 case CMD_argdo:
2826 i = eap->line1 - 1;
2827 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002828 default:
2829 break;
2830 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831 /* set pcmark now */
2832 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002833 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01002834 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002835 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01002836 || !buf->b_p_bl); buf = buf->b_next)
2837 if (buf->b_fnum > eap->line2)
2838 {
2839 buf = NULL;
2840 break;
2841 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002842 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01002843 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002844 }
2845#ifdef FEAT_QUICKFIX
2846 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
2847 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2848 {
2849 qf_size = qf_get_size(eap);
2850 if (qf_size <= 0 || eap->line1 > qf_size)
2851 buf = NULL;
2852 else
2853 {
2854 ex_cc(eap);
2855
2856 buf = curbuf;
2857 i = eap->line1 - 1;
2858 if (eap->addr_count <= 0)
2859 /* default is all the quickfix/location list entries */
2860 eap->line2 = qf_size;
2861 }
2862 }
2863#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 else
2865 setpcmark();
2866 listcmd_busy = TRUE; /* avoids setting pcmark below */
2867
Bram Moolenaare25bb902015-02-27 20:33:37 +01002868 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 {
2870 if (eap->cmdidx == CMD_argdo)
2871 {
2872 /* go to argument "i" */
2873 if (i == ARGCOUNT)
2874 break;
2875 /* Don't call do_argfile() when already there, it will try
2876 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002877 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002878 {
2879 /* Clear 'shm' to avoid that the file message overwrites
2880 * any output from the command. */
2881 p_shm_save = vim_strsave(p_shm);
2882 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002884 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
2885 vim_free(p_shm_save);
2886 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 if (curwin->w_arg_idx != i)
2888 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002889 }
2890#ifdef FEAT_WINDOWS
2891 else if (eap->cmdidx == CMD_windo)
2892 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002893 /* go to window "wp" */
2894 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002896 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00002897 if (curwin != wp)
2898 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002899 wp = curwin->w_next;
2900 }
2901 else if (eap->cmdidx == CMD_tabdo)
2902 {
2903 /* go to window "tp" */
2904 if (!valid_tabpage(tp))
2905 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02002906 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002907 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 }
2909#endif
2910 else if (eap->cmdidx == CMD_bufdo)
2911 {
2912 /* Remember the number of the next listed buffer, in case
2913 * ":bwipe" is used or autocommands do something strange. */
2914 next_fnum = -1;
2915 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
2916 if (buf->b_p_bl)
2917 {
2918 next_fnum = buf->b_fnum;
2919 break;
2920 }
2921 }
2922
Bram Moolenaara162bc52015-01-07 16:54:21 +01002923 ++i;
2924
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 /* execute the command */
2926 do_cmdline(eap->arg, eap->getline, eap->cookie,
2927 DOCMD_VERBOSE + DOCMD_NOWAIT);
2928
2929 if (eap->cmdidx == CMD_bufdo)
2930 {
2931 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01002932 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 break;
2934 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02002935 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 if (buf->b_fnum == next_fnum)
2937 break;
2938 if (buf == NULL)
2939 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002940
2941 /* Go to the next buffer. Clear 'shm' to avoid that the file
2942 * message overwrites any output from the command. */
2943 p_shm_save = vim_strsave(p_shm);
2944 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002946 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
2947 vim_free(p_shm_save);
2948
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002949 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 if (curbuf->b_fnum != next_fnum)
2951 break;
2952 }
2953
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002954#ifdef FEAT_QUICKFIX
2955 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
2956 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2957 {
2958 if (i >= qf_size || i >= eap->line2)
2959 break;
2960
2961 qf_idx = qf_get_cur_idx(eap);
2962
2963 ex_cnext(eap);
2964
2965 /* If jumping to the next quickfix entry fails, quit here */
2966 if (qf_get_cur_idx(eap) == qf_idx)
2967 break;
2968 }
2969#endif
2970
Bram Moolenaar071d4272004-06-13 20:20:40 +00002971 if (eap->cmdidx == CMD_windo)
2972 {
2973 validate_cursor(); /* cursor may have moved */
2974#ifdef FEAT_SCROLLBIND
2975 /* required when 'scrollbind' has been set */
2976 if (curwin->w_p_scb)
2977 do_check_scrollbind(TRUE);
2978#endif
2979 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01002980
2981#ifdef FEAT_WINDOWS
2982 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
2983 if (i+1 > eap->line2)
2984 break;
2985#endif
2986 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
2987 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 }
2989 listcmd_busy = FALSE;
2990 }
2991
2992#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00002993 if (save_ei != NULL)
2994 {
2995 au_event_restore(save_ei);
2996 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
2997 curbuf->b_fname, TRUE, curbuf);
2998 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003000#ifdef FEAT_CLIPBOARD
3001 end_global_changes();
3002#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003}
3004
3005/*
3006 * Add files[count] to the arglist of the current window after arg "after".
3007 * The file names in files[count] must have been allocated and are taken over.
3008 * Files[] itself is not taken over.
3009 * Returns index of first added argument. Returns -1 when failed (out of mem).
3010 */
3011 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003012alist_add_list(
3013 int count,
3014 char_u **files,
3015 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016{
3017 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003018 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019
3020 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3021 {
3022 if (after < 0)
3023 after = 0;
3024 if (after > ARGCOUNT)
3025 after = ARGCOUNT;
3026 if (after < ARGCOUNT)
3027 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3028 (ARGCOUNT - after) * sizeof(aentry_T));
3029 for (i = 0; i < count; ++i)
3030 {
3031 ARGLIST[after + i].ae_fname = files[i];
3032 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
3033 }
3034 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003035 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3036 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 return after;
3038 }
3039
3040 for (i = 0; i < count; ++i)
3041 vim_free(files[i]);
3042 return -1;
3043}
3044
3045#endif /* FEAT_LISTCMDS */
3046
3047#ifdef FEAT_EVAL
3048/*
3049 * ":compiler[!] {name}"
3050 */
3051 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003052ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053{
3054 char_u *buf;
3055 char_u *old_cur_comp = NULL;
3056 char_u *p;
3057
3058 if (*eap->arg == NUL)
3059 {
3060 /* List all compiler scripts. */
3061 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3062 /* ) keep the indenter happy... */
3063 }
3064 else
3065 {
3066 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3067 if (buf != NULL)
3068 {
3069 if (eap->forceit)
3070 {
3071 /* ":compiler! {name}" sets global options */
3072 do_cmdline_cmd((char_u *)
3073 "command -nargs=* CompilerSet set <args>");
3074 }
3075 else
3076 {
3077 /* ":compiler! {name}" sets local options.
3078 * To remain backwards compatible "current_compiler" is always
3079 * used. A user's compiler plugin may set it, the distributed
3080 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003081 * "b:current_compiler" and restore "current_compiler".
3082 * Explicitly prepend "g:" to make it work in a function. */
3083 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 if (old_cur_comp != NULL)
3085 old_cur_comp = vim_strsave(old_cur_comp);
3086 do_cmdline_cmd((char_u *)
3087 "command -nargs=* CompilerSet setlocal <args>");
3088 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003089 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003090 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003091
3092 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003093 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3095 vim_free(buf);
3096
3097 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3098
3099 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003100 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101 if (p != NULL)
3102 set_internal_string_var((char_u *)"b:current_compiler", p);
3103
3104 /* Restore "current_compiler" for ":compiler {name}". */
3105 if (!eap->forceit)
3106 {
3107 if (old_cur_comp != NULL)
3108 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003109 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 old_cur_comp);
3111 vim_free(old_cur_comp);
3112 }
3113 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003114 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003115 }
3116 }
3117 }
3118}
3119#endif
3120
3121/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003122 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 */
3124 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003125ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003127 char_u *arg = eap->arg;
3128 char_u *p = skiptowhite(arg);
3129 int len = (int)(p - arg);
3130 int flags = eap->forceit ? DIP_ALL : 0;
3131
3132 if (STRNCMP(arg, "START", len) == 0)
3133 {
3134 flags += DIP_START + DIP_NORTP;
3135 arg = skipwhite(arg + len);
3136 }
3137 else if (STRNCMP(arg, "OPT", len) == 0)
3138 {
3139 flags += DIP_OPT + DIP_NORTP;
3140 arg = skipwhite(arg + len);
3141 }
3142 else if (STRNCMP(arg, "PACK", len) == 0)
3143 {
3144 flags += DIP_START + DIP_OPT + DIP_NORTP;
3145 arg = skipwhite(arg + len);
3146 }
3147 else if (STRNCMP(arg, "ALL", len) == 0)
3148 {
3149 flags += DIP_START + DIP_OPT;
3150 arg = skipwhite(arg + len);
3151 }
3152
3153 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154}
3155
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003157source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003159 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160}
3161
3162/*
3163 * Source the file "name" from all directories in 'runtimepath'.
3164 * "name" can contain wildcards.
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003165 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
Bram Moolenaar91715872016-03-03 17:13:03 +01003166 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 * return FAIL when no file could be sourced, OK otherwise.
3168 */
3169 int
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003170source_runtime(char_u *name, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171{
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003172 return do_in_runtimepath(name, flags, source_callback, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003173}
3174
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003175/*
3176 * Find the file "name" in all directories in "path" and invoke
3177 * "callback(fname, cookie)".
3178 * "name" can contain wildcards.
3179 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3180 * When "flags" has DIP_DIR: find directories instead of files.
3181 * When "flags" has DIP_ERR: give an error message if there is no match.
3182 *
3183 * return FAIL when no file could be sourced, OK otherwise.
3184 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003185 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003186do_in_path(
3187 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003188 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003189 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003190 void (*callback)(char_u *fname, void *ck),
3191 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192{
3193 char_u *rtp;
3194 char_u *np;
3195 char_u *buf;
3196 char_u *rtp_copy;
3197 char_u *tail;
3198 int num_files;
3199 char_u **files;
3200 int i;
3201 int did_one = FALSE;
3202#ifdef AMIGA
3203 struct Process *proc = (struct Process *)FindTask(0L);
3204 APTR save_winptr = proc->pr_WindowPtr;
3205
3206 /* Avoid a requester here for a volume that doesn't exist. */
3207 proc->pr_WindowPtr = (APTR)-1L;
3208#endif
3209
3210 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3211 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003212 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 buf = alloc(MAXPATHL);
3214 if (buf != NULL && rtp_copy != NULL)
3215 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003216 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003217 {
3218 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003219 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003220 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003221 verbose_leave();
3222 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003223
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 /* Loop over all entries in 'runtimepath'. */
3225 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003226 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 {
3228 /* Copy the path from 'runtimepath' to buf[]. */
3229 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003230 if (name == NULL)
3231 {
3232 (*callback)(buf, (void *) &cookie);
3233 if (!did_one)
3234 did_one = (cookie == NULL);
3235 }
3236 else if (STRLEN(buf) + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003237 {
3238 add_pathsep(buf);
3239 tail = buf + STRLEN(buf);
3240
3241 /* Loop over all patterns in "name" */
3242 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003243 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244 {
3245 /* Append the pattern from "name" to buf[]. */
3246 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3247 "\t ");
3248
3249 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003250 {
3251 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003252 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003253 verbose_leave();
3254 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255
3256 /* Expand wildcards, invoke the callback for each match. */
3257 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003258 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003259 {
3260 for (i = 0; i < num_files; ++i)
3261 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003262 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003264 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265 break;
3266 }
3267 FreeWild(num_files, files);
3268 }
3269 }
3270 }
3271 }
3272 }
3273 vim_free(buf);
3274 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003275 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003276 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003277 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3278
3279 if (flags & DIP_ERR)
3280 EMSG3(_(e_dirnotf), basepath, name);
3281 else if (p_verbose > 0)
3282 {
3283 verbose_enter();
3284 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3285 verbose_leave();
3286 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003287 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003288
3289#ifdef AMIGA
3290 proc->pr_WindowPtr = save_winptr;
3291#endif
3292
3293 return did_one ? OK : FAIL;
3294}
3295
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003296/*
3297 * Find "name" in 'runtimepath'. When found, invoke the callback function for
3298 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003299 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3300 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003301 * Returns OK when at least one match found, FAIL otherwise.
3302 *
3303 * If "name" is NULL calls callback for each entry in runtimepath. Cookie is
3304 * passed by reference in this case, setting it to NULL indicates that callback
3305 * has done its job.
3306 */
3307 int
3308do_in_runtimepath(
3309 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003310 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003311 void (*callback)(char_u *fname, void *ck),
3312 void *cookie)
3313{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003314 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003315 char_u *s;
3316 int len;
3317 char *start_dir = "pack/*/start/*/%s";
3318 char *opt_dir = "pack/*/opt/*/%s";
3319
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003320 if ((flags & DIP_NORTP) == 0)
3321 done = do_in_path(p_rtp, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003322
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003323 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003324 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003325 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003326 s = alloc(len);
3327 if (s == NULL)
3328 return FAIL;
3329 vim_snprintf((char *)s, len, start_dir, name);
3330 done = do_in_path(p_pp, s, flags, callback, cookie);
3331 vim_free(s);
3332 }
3333
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003334 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003335 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003336 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003337 s = alloc(len);
3338 if (s == NULL)
3339 return FAIL;
3340 vim_snprintf((char *)s, len, opt_dir, name);
3341 done = do_in_path(p_pp, s, flags, callback, cookie);
3342 vim_free(s);
3343 }
3344
3345 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003346}
3347
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003348/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003349 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003350 */
3351 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003352source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003353{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003354 int num_files;
3355 char_u **files;
3356 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003357
Bram Moolenaarf3654822016-03-04 22:12:23 +01003358 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003359 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003360 for (i = 0; i < num_files; ++i)
3361 (void)do_source(files[i], FALSE, DOSO_NONE);
3362 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003363 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003364}
3365
Bram Moolenaar49b27322016-04-05 21:13:00 +02003366/* used for "cookie" of add_pack_plugin() */
3367static int APP_ADD_DIR;
3368static int APP_LOAD;
3369static int APP_BOTH;
3370
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003371 static void
Bram Moolenaar91715872016-03-03 17:13:03 +01003372add_pack_plugin(char_u *fname, void *cookie)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003373{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003374 char_u *p4, *p3, *p2, *p1, *p;
3375 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003376 int c;
3377 char_u *new_rtp;
3378 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003379 size_t oldlen;
3380 size_t addlen;
Bram Moolenaara5702442016-05-24 19:37:29 +02003381 char_u *afterdir;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003382 size_t afterlen = 0;
Bram Moolenaar91715872016-03-03 17:13:03 +01003383 char_u *ffname = fix_fname(fname);
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003384 size_t fname_len;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003385
Bram Moolenaar91715872016-03-03 17:13:03 +01003386 if (ffname == NULL)
3387 return;
Bram Moolenaar49b27322016-04-05 21:13:00 +02003388 if (cookie != &APP_LOAD && strstr((char *)p_rtp, (char *)ffname) == NULL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003389 {
Bram Moolenaara5702442016-05-24 19:37:29 +02003390 /* directory is not yet in 'runtimepath', add it */
Bram Moolenaarf3654822016-03-04 22:12:23 +01003391 p4 = p3 = p2 = p1 = get_past_head(ffname);
3392 for (p = p1; *p; mb_ptr_adv(p))
3393 if (vim_ispathsep_nocolon(*p))
3394 {
3395 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3396 }
3397
3398 /* now we have:
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +01003399 * rtp/pack/name/start/name
3400 * p4 p3 p2 p1
Bram Moolenaarf3654822016-03-04 22:12:23 +01003401 *
3402 * find the part up to "pack" in 'runtimepath' */
3403 c = *p4;
3404 *p4 = NUL;
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003405
3406 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3407 fname_len = STRLEN(ffname);
3408 insp = p_rtp;
3409 for (;;)
3410 {
3411 if (vim_fnamencmp(insp, ffname, fname_len) == 0)
3412 break;
3413 insp = vim_strchr(insp, ',');
3414 if (insp == NULL)
3415 break;
3416 ++insp;
3417 }
3418
Bram Moolenaarf3654822016-03-04 22:12:23 +01003419 if (insp == NULL)
3420 /* not found, append at the end */
3421 insp = p_rtp + STRLEN(p_rtp);
3422 else
3423 {
3424 /* append after the matching directory. */
3425 insp += STRLEN(ffname);
3426 while (*insp != NUL && *insp != ',')
3427 ++insp;
3428 }
3429 *p4 = c;
3430
Bram Moolenaara5702442016-05-24 19:37:29 +02003431 /* check if rtp/pack/name/start/name/after exists */
3432 afterdir = concat_fnames(ffname, (char_u *)"after", TRUE);
3433 if (afterdir != NULL && mch_isdir(afterdir))
3434 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3435
Bram Moolenaarb0550662016-05-31 21:37:36 +02003436 oldlen = STRLEN(p_rtp);
3437 addlen = STRLEN(ffname) + 1; /* add one for comma */
3438 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1)); /* add one for NUL */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003439 if (new_rtp == NULL)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003440 goto theend;
3441 keep = (int)(insp - p_rtp);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003442 mch_memmove(new_rtp, p_rtp, keep);
3443 new_rtp[keep] = ',';
Bram Moolenaara5702442016-05-24 19:37:29 +02003444 mch_memmove(new_rtp + keep + 1, ffname, addlen);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003445 if (p_rtp[keep] != NUL)
Bram Moolenaara5702442016-05-24 19:37:29 +02003446 mch_memmove(new_rtp + keep + addlen, p_rtp + keep,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003447 oldlen - keep + 1);
Bram Moolenaara5702442016-05-24 19:37:29 +02003448 if (afterlen > 0)
3449 {
3450 STRCAT(new_rtp, ",");
3451 STRCAT(new_rtp, afterdir);
3452 }
Bram Moolenaar863c1a92016-03-03 15:47:06 +01003453 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3454 vim_free(new_rtp);
Bram Moolenaara5702442016-05-24 19:37:29 +02003455 vim_free(afterdir);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003456 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003457
Bram Moolenaar49b27322016-04-05 21:13:00 +02003458 if (cookie != &APP_ADD_DIR)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003459 {
Bram Moolenaar71fb0c12016-04-02 22:44:16 +02003460 static char *plugpat = "%s/plugin/**/*.vim";
Bram Moolenaarf3654822016-03-04 22:12:23 +01003461 static char *ftpat = "%s/ftdetect/*.vim";
3462 int len;
3463 char_u *pat;
3464
3465 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3466 pat = alloc(len);
3467 if (pat == NULL)
3468 goto theend;
3469 vim_snprintf((char *)pat, len, plugpat, ffname);
3470 source_all_matches(pat);
3471
3472#ifdef FEAT_AUTOCMD
3473 {
3474 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3475
3476 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3477 * found when it loads. */
3478 if (cmd != NULL && eval_to_number(cmd) > 0)
3479 {
3480 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3481 vim_snprintf((char *)pat, len, ftpat, ffname);
3482 source_all_matches(pat);
3483 do_cmdline_cmd((char_u *)"augroup END");
3484 }
3485 vim_free(cmd);
3486 }
3487#endif
Bram Moolenaarba8cd122016-03-19 14:16:39 +01003488 vim_free(pat);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003489 }
3490
3491theend:
3492 vim_free(ffname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003493}
3494
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003495static int did_source_packages = FALSE;
3496
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003497/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003498 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003499 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003500 */
3501 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003502ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003503{
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003504 if (!did_source_packages || (eap != NULL && eap->forceit))
3505 {
3506 did_source_packages = TRUE;
Bram Moolenaar49b27322016-04-05 21:13:00 +02003507
3508 /* First do a round to add all directories to 'runtimepath', then load
3509 * the plugins. This allows for plugins to use an autoload directory
3510 * of another plugin. */
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003511 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
Bram Moolenaar49b27322016-04-05 21:13:00 +02003512 add_pack_plugin, &APP_ADD_DIR);
3513 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3514 add_pack_plugin, &APP_LOAD);
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003515 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003516}
3517
3518/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003519 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003520 */
3521 void
3522ex_packadd(exarg_T *eap)
3523{
3524 static char *plugpat = "pack/*/opt/%s";
3525 int len;
3526 char *pat;
3527
3528 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg);
3529 pat = (char *)alloc(len);
3530 if (pat == NULL)
3531 return;
3532 vim_snprintf(pat, len, plugpat, eap->arg);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003533 do_in_path(p_pp, (char_u *)pat, DIP_ALL + DIP_DIR + DIP_ERR,
Bram Moolenaar49b27322016-04-05 21:13:00 +02003534 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
Bram Moolenaar91715872016-03-03 17:13:03 +01003535 vim_free(pat);
3536}
3537
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
3539/*
3540 * ":options"
3541 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003543ex_options(
3544 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545{
3546 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3547}
3548#endif
3549
3550/*
3551 * ":source {fname}"
3552 */
3553 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003554ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003555{
3556#ifdef FEAT_BROWSE
3557 if (cmdmod.browse)
3558 {
3559 char_u *fname = NULL;
3560
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003561 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
3563 if (fname != NULL)
3564 {
3565 cmd_source(fname, eap);
3566 vim_free(fname);
3567 }
3568 }
3569 else
3570#endif
3571 cmd_source(eap->arg, eap);
3572}
3573
3574 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003575cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576{
3577 if (*fname == NUL)
3578 EMSG(_(e_argreq));
3579
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02003581 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003582 * Need to execute the commands directly. This is required at least
3583 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 * - ":g" command busy
3585 * - after ":argdo", ":windo" or ":bufdo"
3586 * - another command follows
3587 * - inside a loop
3588 */
3589 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
3590#ifdef FEAT_EVAL
3591 || eap->cstack->cs_idx >= 0
3592#endif
3593 );
3594
3595 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003596 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 EMSG2(_(e_notopen), fname);
3598}
3599
3600/*
3601 * ":source" and associated commands.
3602 */
3603/*
3604 * Structure used to store info for each sourced file.
3605 * It is shared between do_source() and getsourceline().
3606 * This is required, because it needs to be handed to do_cmdline() and
3607 * sourcing can be done recursively.
3608 */
3609struct source_cookie
3610{
3611 FILE *fp; /* opened file for sourcing */
3612 char_u *nextline; /* if not NULL: line that was read ahead */
3613 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003614#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
3616 int error; /* TRUE if LF found after CR-LF */
3617#endif
3618#ifdef FEAT_EVAL
3619 linenr_T breakpoint; /* next line with breakpoint or zero */
3620 char_u *fname; /* name of sourced file */
3621 int dbg_tick; /* debug_tick when breakpoint was set */
3622 int level; /* top nesting level of sourced file */
3623#endif
3624#ifdef FEAT_MBYTE
3625 vimconv_T conv; /* type of conversion */
3626#endif
3627};
3628
3629#ifdef FEAT_EVAL
3630/*
3631 * Return the address holding the next breakpoint line for a source cookie.
3632 */
3633 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003634source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003635{
3636 return &((struct source_cookie *)cookie)->breakpoint;
3637}
3638
3639/*
3640 * Return the address holding the debug tick for a source cookie.
3641 */
3642 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003643source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644{
3645 return &((struct source_cookie *)cookie)->dbg_tick;
3646}
3647
3648/*
3649 * Return the nesting level for a source cookie.
3650 */
3651 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003652source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003653{
3654 return ((struct source_cookie *)cookie)->level;
3655}
3656#endif
3657
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01003658static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003660#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
3661# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01003662static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003663
3664/*
3665 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003666 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 */
3668 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003669fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003671# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01003672 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
3673# else
3674 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003675# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676
3677 if (fd_tmp == -1)
3678 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003679
3680# ifdef HAVE_FD_CLOEXEC
3681 {
3682 int fdflags = fcntl(fd_tmp, F_GETFD);
3683 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02003684 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003685 }
3686# endif
3687
Bram Moolenaar071d4272004-06-13 20:20:40 +00003688 return fdopen(fd_tmp, READBIN);
3689}
3690#endif
3691
3692
3693/*
3694 * do_source: Read the file "fname" and execute its lines as EX commands.
3695 *
3696 * This function may be called recursively!
3697 *
3698 * return FAIL if file could not be opened, OK otherwise
3699 */
3700 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003701do_source(
3702 char_u *fname,
3703 int check_other, /* check for .vimrc and _vimrc */
3704 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705{
3706 struct source_cookie cookie;
3707 char_u *save_sourcing_name;
3708 linenr_T save_sourcing_lnum;
3709 char_u *p;
3710 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00003711 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 int retval = FAIL;
3713#ifdef FEAT_EVAL
3714 scid_T save_current_SID;
3715 static scid_T last_current_SID = 0;
3716 void *save_funccalp;
3717 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003718 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02003720 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003721 int stat_ok;
3722# endif
3723#endif
3724#ifdef STARTUPTIME
3725 struct timeval tv_rel;
3726 struct timeval tv_start;
3727#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00003728#ifdef FEAT_PROFILE
3729 proftime_T wait_start;
3730#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731
Bram Moolenaar071d4272004-06-13 20:20:40 +00003732 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 if (p == NULL)
3734 return retval;
3735 fname_exp = fix_fname(p);
3736 vim_free(p);
3737 if (fname_exp == NULL)
3738 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 if (mch_isdir(fname_exp))
3740 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00003741 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003742 goto theend;
3743 }
3744
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003745#ifdef FEAT_AUTOCMD
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003746 /* Apply SourceCmd autocommands, they should get the file and source it. */
3747 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
3748 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
3749 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003750 {
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003751# ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003752 retval = aborting() ? FAIL : OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003753# else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003754 retval = OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003755# endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003756 goto theend;
3757 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003758
3759 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003760 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
3761#endif
3762
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003763#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00003764 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
3765#else
3766 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
3767#endif
3768 if (cookie.fp == NULL && check_other)
3769 {
3770 /*
3771 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
3772 * and ".exrc" by "_exrc" or vice versa.
3773 */
3774 p = gettail(fname_exp);
3775 if ((*p == '.' || *p == '_')
3776 && (STRICMP(p + 1, "vimrc") == 0
3777 || STRICMP(p + 1, "gvimrc") == 0
3778 || STRICMP(p + 1, "exrc") == 0))
3779 {
3780 if (*p == '_')
3781 *p = '.';
3782 else
3783 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003784#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
3786#else
3787 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
3788#endif
3789 }
3790 }
3791
3792 if (cookie.fp == NULL)
3793 {
3794 if (p_verbose > 0)
3795 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003796 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003797 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00003798 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 else
3800 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00003801 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003802 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 }
3804 goto theend;
3805 }
3806
3807 /*
3808 * The file exists.
3809 * - In verbose mode, give a message.
3810 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
3811 */
3812 if (p_verbose > 1)
3813 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003814 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003815 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00003816 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 else
3818 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00003819 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003820 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003822 if (is_vimrc == DOSO_VIMRC)
3823 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
3824 else if (is_vimrc == DOSO_GVIMRC)
3825 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003826
3827#ifdef USE_CRNL
3828 /* If no automatic file format: Set default to CR-NL. */
3829 if (*p_ffs == NUL)
3830 cookie.fileformat = EOL_DOS;
3831 else
3832 cookie.fileformat = EOL_UNKNOWN;
3833 cookie.error = FALSE;
3834#endif
3835
3836#ifdef USE_CR
3837 /* If no automatic file format: Set default to CR. */
3838 if (*p_ffs == NUL)
3839 cookie.fileformat = EOL_MAC;
3840 else
3841 cookie.fileformat = EOL_UNKNOWN;
3842 cookie.error = FALSE;
3843#endif
3844
3845 cookie.nextline = NULL;
3846 cookie.finished = FALSE;
3847
3848#ifdef FEAT_EVAL
3849 /*
3850 * Check if this script has a breakpoint.
3851 */
3852 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
3853 cookie.fname = fname_exp;
3854 cookie.dbg_tick = debug_tick;
3855
3856 cookie.level = ex_nesting_level;
3857#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003858
3859 /*
3860 * Keep the sourcing name/lnum, for recursive calls.
3861 */
3862 save_sourcing_name = sourcing_name;
3863 sourcing_name = fname_exp;
3864 save_sourcing_lnum = sourcing_lnum;
3865 sourcing_lnum = 0;
3866
Bram Moolenaar73881402009-02-04 16:50:47 +00003867#ifdef FEAT_MBYTE
3868 cookie.conv.vc_type = CONV_NONE; /* no conversion */
3869
3870 /* Read the first line so we can check for a UTF-8 BOM. */
3871 firstline = getsourceline(0, (void *)&cookie, 0);
3872 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
3873 && firstline[1] == 0xbb && firstline[2] == 0xbf)
3874 {
3875 /* Found BOM; setup conversion, skip over BOM and recode the line. */
3876 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
3877 p = string_convert(&cookie.conv, firstline + 3, NULL);
Bram Moolenaar4e2a5952009-02-05 19:48:25 +00003878 if (p == NULL)
3879 p = vim_strsave(firstline + 3);
Bram Moolenaar73881402009-02-04 16:50:47 +00003880 if (p != NULL)
3881 {
3882 vim_free(firstline);
3883 firstline = p;
3884 }
3885 }
3886#endif
3887
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01003889 if (time_fd != NULL)
3890 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891#endif
3892
3893#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00003894# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003895 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003896 prof_child_enter(&wait_start); /* entering a child now */
3897# endif
3898
3899 /* Don't use local function variables, if called from a function.
3900 * Also starts profiling timer for nested script. */
3901 save_funccalp = save_funccal();
3902
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 /*
3904 * Check if this script was sourced before to finds its SID.
3905 * If it's new, generate a new SID.
3906 */
3907 save_current_SID = current_SID;
3908# ifdef UNIX
3909 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
3910# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00003911 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
3912 {
3913 si = &SCRIPT_ITEM(current_SID);
3914 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003915 && (
3916# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00003917 /* Compare dev/ino when possible, it catches symbolic
3918 * links. Also compare file names, the inode may change
3919 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00003920 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003921 && (si->sn_dev == st.st_dev
3922 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00003924 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003925 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003926 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 if (current_SID == 0)
3928 {
3929 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003930 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
3931 == FAIL)
3932 goto almosttheend;
3933 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00003935 ++script_items.ga_len;
3936 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
3937# ifdef FEAT_PROFILE
3938 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003940 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00003941 si = &SCRIPT_ITEM(current_SID);
3942 si->sn_name = fname_exp;
3943 fname_exp = NULL;
3944# ifdef UNIX
3945 if (stat_ok)
3946 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00003947 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003948 si->sn_dev = st.st_dev;
3949 si->sn_ino = st.st_ino;
3950 }
3951 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00003952 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003953# endif
3954
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 /* Allocate the local script variables to use for this script. */
3956 new_script_vars(current_SID);
3957 }
3958
Bram Moolenaar05159a02005-02-26 23:04:13 +00003959# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003960 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003961 {
3962 int forceit;
3963
3964 /* Check if we do profiling for this script. */
3965 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
3966 {
3967 script_do_profile(si);
3968 si->sn_pr_force = forceit;
3969 }
3970 if (si->sn_prof_on)
3971 {
3972 ++si->sn_pr_count;
3973 profile_start(&si->sn_pr_start);
3974 profile_zero(&si->sn_pr_children);
3975 }
3976 }
3977# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003978#endif
3979
3980 /*
3981 * Call do_cmdline, which will call getsourceline() to get the lines.
3982 */
Bram Moolenaar73881402009-02-04 16:50:47 +00003983 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003984 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003986
3987#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003988 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003989 {
3990 /* Get "si" again, "script_items" may have been reallocated. */
3991 si = &SCRIPT_ITEM(current_SID);
3992 if (si->sn_prof_on)
3993 {
3994 profile_end(&si->sn_pr_start);
3995 profile_sub_wait(&wait_start, &si->sn_pr_start);
3996 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00003997 profile_self(&si->sn_pr_self, &si->sn_pr_start,
3998 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00003999 }
4000 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001#endif
4002
4003 if (got_int)
4004 EMSG(_(e_interr));
4005 sourcing_name = save_sourcing_name;
4006 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 if (p_verbose > 1)
4008 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004009 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004010 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004012 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004013 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 }
4015#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004016 if (time_fd != NULL)
4017 {
4018 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4019 time_msg((char *)IObuff, &tv_start);
4020 time_pop(&tv_rel);
4021 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022#endif
4023
4024#ifdef FEAT_EVAL
4025 /*
4026 * After a "finish" in debug mode, need to break at first command of next
4027 * sourced file.
4028 */
4029 if (save_debug_break_level > ex_nesting_level
4030 && debug_break_level == ex_nesting_level)
4031 ++debug_break_level;
4032#endif
4033
Bram Moolenaar05159a02005-02-26 23:04:13 +00004034#ifdef FEAT_EVAL
4035almosttheend:
4036 current_SID = save_current_SID;
4037 restore_funccal(save_funccalp);
4038# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004039 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004040 prof_child_exit(&wait_start); /* leaving a child now */
4041# endif
4042#endif
4043 fclose(cookie.fp);
4044 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004045 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004046#ifdef FEAT_MBYTE
4047 convert_setup(&cookie.conv, NULL, NULL);
4048#endif
4049
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050theend:
4051 vim_free(fname_exp);
4052 return retval;
4053}
4054
4055#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004056
Bram Moolenaar071d4272004-06-13 20:20:40 +00004057/*
4058 * ":scriptnames"
4059 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004060 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004061ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062{
4063 int i;
4064
Bram Moolenaar05159a02005-02-26 23:04:13 +00004065 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4066 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004067 {
4068 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4069 NameBuff, MAXPATHL, TRUE);
4070 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004071 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004072}
4073
4074# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4075/*
4076 * Fix slashes in the list of script names for 'shellslash'.
4077 */
4078 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004079scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080{
4081 int i;
4082
Bram Moolenaar05159a02005-02-26 23:04:13 +00004083 for (i = 1; i <= script_items.ga_len; ++i)
4084 if (SCRIPT_ITEM(i).sn_name != NULL)
4085 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004086}
4087# endif
4088
4089/*
4090 * Get a pointer to a script name. Used for ":verbose set".
4091 */
4092 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004093get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094{
4095 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004096 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004098 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004100 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004102 return (char_u *)_("environment variable");
4103 if (id == SID_ERROR)
4104 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004105 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004106}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004107
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004108# if defined(EXITFREE) || defined(PROTO)
4109 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004110free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004111{
4112 int i;
4113
4114 for (i = script_items.ga_len; i > 0; --i)
4115 vim_free(SCRIPT_ITEM(i).sn_name);
4116 ga_clear(&script_items);
4117}
4118# endif
4119
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120#endif
4121
4122#if defined(USE_CR) || defined(PROTO)
4123
4124# if defined(__MSL__) && (__MSL__ >= 22)
4125/*
4126 * Newer version of the Metrowerks library handle DOS and UNIX files
4127 * without help.
4128 * Test with earlier versions, MSL 2.2 is the library supplied with
4129 * Codewarrior Pro 2.
4130 */
4131 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004132fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133{
4134 return fgets(s, n, stream);
4135}
4136# else
4137/*
4138 * Version of fgets() which also works for lines ending in a <CR> only
4139 * (Macintosh format).
4140 * For older versions of the Metrowerks library.
4141 * At least CodeWarrior 9 needed this code.
4142 */
4143 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004144fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145{
4146 int c = 0;
4147 int char_read = 0;
4148
4149 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4150 {
4151 c = fgetc(stream);
4152 s[char_read++] = c;
4153 /* If the file is in DOS format, we need to skip a NL after a CR. I
4154 * thought it was the other way around, but this appears to work... */
4155 if (c == '\n')
4156 {
4157 c = fgetc(stream);
4158 if (c != '\r')
4159 ungetc(c, stream);
4160 }
4161 }
4162
4163 s[char_read] = 0;
4164 if (char_read == 0)
4165 return NULL;
4166
4167 if (feof(stream) && char_read == 1)
4168 return NULL;
4169
4170 return s;
4171}
4172# endif
4173#endif
4174
4175/*
4176 * Get one full line from a sourced file.
4177 * Called by do_cmdline() when it's called from do_source().
4178 *
4179 * Return a pointer to the line in allocated memory.
4180 * Return NULL for end-of-file or some error.
4181 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004183getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184{
4185 struct source_cookie *sp = (struct source_cookie *)cookie;
4186 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004187 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004188
4189#ifdef FEAT_EVAL
4190 /* If breakpoints have been added/deleted need to check for it. */
4191 if (sp->dbg_tick < debug_tick)
4192 {
4193 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4194 sp->dbg_tick = debug_tick;
4195 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004196# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004197 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004198 script_line_end();
4199# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200#endif
4201 /*
4202 * Get current line. If there is a read-ahead line, use it, otherwise get
4203 * one now.
4204 */
4205 if (sp->finished)
4206 line = NULL;
4207 else if (sp->nextline == NULL)
4208 line = get_one_sourceline(sp);
4209 else
4210 {
4211 line = sp->nextline;
4212 sp->nextline = NULL;
4213 ++sourcing_lnum;
4214 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004215#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004216 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004217 script_line_start();
4218#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219
4220 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4221 * contain the 'C' flag. */
4222 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4223 {
4224 /* compensate for the one line read-ahead */
4225 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004226
4227 /* Get the next line and concatenate it when it starts with a
4228 * backslash. We always need to read the next line, keep it in
4229 * sp->nextline. */
4230 sp->nextline = get_one_sourceline(sp);
4231 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004233 garray_T ga;
4234
Bram Moolenaarb549a732012-02-22 18:29:33 +01004235 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004236 ga_concat(&ga, line);
4237 ga_concat(&ga, p + 1);
4238 for (;;)
4239 {
4240 vim_free(sp->nextline);
4241 sp->nextline = get_one_sourceline(sp);
4242 if (sp->nextline == NULL)
4243 break;
4244 p = skipwhite(sp->nextline);
4245 if (*p != '\\')
4246 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004247 /* Adjust the growsize to the current length to speed up
4248 * concatenating many lines. */
4249 if (ga.ga_len > 400)
4250 {
4251 if (ga.ga_len > 8000)
4252 ga.ga_growsize = 8000;
4253 else
4254 ga.ga_growsize = ga.ga_len;
4255 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004256 ga_concat(&ga, p + 1);
4257 }
4258 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004260 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 }
4262 }
4263
4264#ifdef FEAT_MBYTE
4265 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4266 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004267 char_u *s;
4268
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 /* Convert the encoding of the script line. */
4270 s = string_convert(&sp->conv, line, NULL);
4271 if (s != NULL)
4272 {
4273 vim_free(line);
4274 line = s;
4275 }
4276 }
4277#endif
4278
4279#ifdef FEAT_EVAL
4280 /* Did we encounter a breakpoint? */
4281 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4282 {
4283 dbg_breakpoint(sp->fname, sourcing_lnum);
4284 /* Find next breakpoint. */
4285 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4286 sp->dbg_tick = debug_tick;
4287 }
4288#endif
4289
4290 return line;
4291}
4292
4293 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004294get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295{
4296 garray_T ga;
4297 int len;
4298 int c;
4299 char_u *buf;
4300#ifdef USE_CRNL
4301 int has_cr; /* CR-LF found */
4302#endif
4303#ifdef USE_CR
4304 char_u *scan;
4305#endif
4306 int have_read = FALSE;
4307
4308 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004309 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310
4311 /*
4312 * Loop until there is a finished line (or end-of-file).
4313 */
4314 sourcing_lnum++;
4315 for (;;)
4316 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004317 /* make room to read at least 120 (more) characters */
4318 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004319 break;
4320 buf = (char_u *)ga.ga_data;
4321
4322#ifdef USE_CR
4323 if (sp->fileformat == EOL_MAC)
4324 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004325 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4326 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327 break;
4328 }
4329 else
4330#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004331 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4332 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004333 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004334 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335#ifdef USE_CRNL
4336 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4337 * CTRL-Z by its own, or after a NL. */
4338 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4339 && sp->fileformat == EOL_DOS
4340 && buf[len - 1] == Ctrl_Z)
4341 {
4342 buf[len - 1] = NUL;
4343 break;
4344 }
4345#endif
4346
4347#ifdef USE_CR
4348 /* If the read doesn't stop on a new line, and there's
4349 * some CR then we assume a Mac format */
4350 if (sp->fileformat == EOL_UNKNOWN)
4351 {
4352 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4353 sp->fileformat = EOL_MAC;
4354 else
4355 sp->fileformat = EOL_UNIX;
4356 }
4357
4358 if (sp->fileformat == EOL_MAC)
4359 {
4360 scan = vim_strchr(buf, '\r');
4361
4362 if (scan != NULL)
4363 {
4364 *scan = '\n';
4365 if (*(scan + 1) != 0)
4366 {
4367 *(scan + 1) = 0;
4368 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4369 }
4370 }
4371 len = STRLEN(buf);
4372 }
4373#endif
4374
4375 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 ga.ga_len = len;
4377
4378 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004379 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 continue;
4381
4382 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4383 {
4384#ifdef USE_CRNL
4385 has_cr = (len >= 2 && buf[len - 2] == '\r');
4386 if (sp->fileformat == EOL_UNKNOWN)
4387 {
4388 if (has_cr)
4389 sp->fileformat = EOL_DOS;
4390 else
4391 sp->fileformat = EOL_UNIX;
4392 }
4393
4394 if (sp->fileformat == EOL_DOS)
4395 {
4396 if (has_cr) /* replace trailing CR */
4397 {
4398 buf[len - 2] = '\n';
4399 --len;
4400 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 }
4402 else /* lines like ":map xx yy^M" will have failed */
4403 {
4404 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004405 {
4406 msg_source(hl_attr(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004408 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 sp->error = TRUE;
4410 sp->fileformat = EOL_UNIX;
4411 }
4412 }
4413#endif
4414 /* The '\n' is escaped if there is an odd number of ^V's just
4415 * before it, first set "c" just before the 'V's and then check
4416 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
4417 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
4418 ;
4419 if ((len & 1) != (c & 1)) /* escaped NL, read more */
4420 {
4421 sourcing_lnum++;
4422 continue;
4423 }
4424
4425 buf[len - 1] = NUL; /* remove the NL */
4426 }
4427
4428 /*
4429 * Check for ^C here now and then, so recursive :so can be broken.
4430 */
4431 line_breakcheck();
4432 break;
4433 }
4434
4435 if (have_read)
4436 return (char_u *)ga.ga_data;
4437
4438 vim_free(ga.ga_data);
4439 return NULL;
4440}
4441
Bram Moolenaar05159a02005-02-26 23:04:13 +00004442#if defined(FEAT_PROFILE) || defined(PROTO)
4443/*
4444 * Called when starting to read a script line.
4445 * "sourcing_lnum" must be correct!
4446 * When skipping lines it may not actually be executed, but we won't find out
4447 * until later and we need to store the time now.
4448 */
4449 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004450script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004451{
4452 scriptitem_T *si;
4453 sn_prl_T *pp;
4454
4455 if (current_SID <= 0 || current_SID > script_items.ga_len)
4456 return;
4457 si = &SCRIPT_ITEM(current_SID);
4458 if (si->sn_prof_on && sourcing_lnum >= 1)
4459 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004460 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00004461 * here isn't counted. */
Bram Moolenaarcde88542015-08-11 19:14:00 +02004462 (void)ga_grow(&si->sn_prl_ga, (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00004463 si->sn_prl_idx = sourcing_lnum - 1;
4464 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
4465 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
4466 {
4467 /* Zero counters for a line that was not used before. */
4468 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
4469 pp->snp_count = 0;
4470 profile_zero(&pp->sn_prl_total);
4471 profile_zero(&pp->sn_prl_self);
4472 ++si->sn_prl_ga.ga_len;
4473 }
4474 si->sn_prl_execed = FALSE;
4475 profile_start(&si->sn_prl_start);
4476 profile_zero(&si->sn_prl_children);
4477 profile_get_wait(&si->sn_prl_wait);
4478 }
4479}
4480
4481/*
4482 * Called when actually executing a function line.
4483 */
4484 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004485script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004486{
4487 scriptitem_T *si;
4488
4489 if (current_SID <= 0 || current_SID > script_items.ga_len)
4490 return;
4491 si = &SCRIPT_ITEM(current_SID);
4492 if (si->sn_prof_on && si->sn_prl_idx >= 0)
4493 si->sn_prl_execed = TRUE;
4494}
4495
4496/*
4497 * Called when done with a function line.
4498 */
4499 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004500script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004501{
4502 scriptitem_T *si;
4503 sn_prl_T *pp;
4504
4505 if (current_SID <= 0 || current_SID > script_items.ga_len)
4506 return;
4507 si = &SCRIPT_ITEM(current_SID);
4508 if (si->sn_prof_on && si->sn_prl_idx >= 0
4509 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
4510 {
4511 if (si->sn_prl_execed)
4512 {
4513 pp = &PRL_ITEM(si, si->sn_prl_idx);
4514 ++pp->snp_count;
4515 profile_end(&si->sn_prl_start);
4516 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004517 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004518 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
4519 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004520 }
4521 si->sn_prl_idx = -1;
4522 }
4523}
4524#endif
4525
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526/*
4527 * ":scriptencoding": Set encoding conversion for a sourced script.
4528 * Without the multi-byte feature it's simply ignored.
4529 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004531ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532{
4533#ifdef FEAT_MBYTE
4534 struct source_cookie *sp;
4535 char_u *name;
4536
4537 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
4538 {
4539 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
4540 return;
4541 }
4542
4543 if (*eap->arg != NUL)
4544 {
4545 name = enc_canonize(eap->arg);
4546 if (name == NULL) /* out of memory */
4547 return;
4548 }
4549 else
4550 name = eap->arg;
4551
4552 /* Setup for conversion from the specified encoding to 'encoding'. */
4553 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
4554 convert_setup(&sp->conv, name, p_enc);
4555
4556 if (name != eap->arg)
4557 vim_free(name);
4558#endif
4559}
4560
4561#if defined(FEAT_EVAL) || defined(PROTO)
4562/*
4563 * ":finish": Mark a sourced file as finished.
4564 */
4565 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004566ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567{
4568 if (getline_equal(eap->getline, eap->cookie, getsourceline))
4569 do_finish(eap, FALSE);
4570 else
4571 EMSG(_("E168: :finish used outside of a sourced file"));
4572}
4573
4574/*
4575 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
4576 * Also called for a pending finish at the ":endtry" or after returning from
4577 * an extra do_cmdline(). "reanimate" is used in the latter case.
4578 */
4579 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004580do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004581{
4582 int idx;
4583
4584 if (reanimate)
4585 ((struct source_cookie *)getline_cookie(eap->getline,
4586 eap->cookie))->finished = FALSE;
4587
4588 /*
4589 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4590 * not in its finally clause (which then is to be executed next) is found.
4591 * In this case, make the ":finish" pending for execution at the ":endtry".
4592 * Otherwise, finish normally.
4593 */
4594 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4595 if (idx >= 0)
4596 {
4597 eap->cstack->cs_pending[idx] = CSTP_FINISH;
4598 report_make_pending(CSTP_FINISH, NULL);
4599 }
4600 else
4601 ((struct source_cookie *)getline_cookie(eap->getline,
4602 eap->cookie))->finished = TRUE;
4603}
4604
4605
4606/*
4607 * Return TRUE when a sourced file had the ":finish" command: Don't give error
4608 * message for missing ":endif".
4609 * Return FALSE when not sourcing a file.
4610 */
4611 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004612source_finished(
4613 char_u *(*fgetline)(int, void *, int),
4614 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615{
Bram Moolenaar89d40322006-08-29 15:30:07 +00004616 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00004618 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619}
4620#endif
4621
4622#if defined(FEAT_LISTCMDS) || defined(PROTO)
4623/*
4624 * ":checktime [buffer]"
4625 */
4626 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004627ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004628{
4629 buf_T *buf;
4630 int save_no_check_timestamps = no_check_timestamps;
4631
4632 no_check_timestamps = 0;
4633 if (eap->addr_count == 0) /* default is all buffers */
4634 check_timestamps(FALSE);
4635 else
4636 {
4637 buf = buflist_findnr((int)eap->line2);
4638 if (buf != NULL) /* cannot happen? */
4639 (void)buf_check_timestamp(buf, FALSE);
4640 }
4641 no_check_timestamps = save_no_check_timestamps;
4642}
4643#endif
4644
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4646 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004647# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004648static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004650 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004651get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004652{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004653 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004655 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004656 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004658# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00004659 if (loc != NULL)
4660 {
4661 char_u *p;
4662
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004663 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
4664 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 p = vim_strchr(loc, '=');
4666 if (p != NULL)
4667 {
4668 loc = ++p;
4669 while (*p != NUL) /* remove trailing newline */
4670 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004671 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 {
4673 *p = NUL;
4674 break;
4675 }
4676 ++p;
4677 }
4678 }
4679 }
4680# endif
4681
4682 return loc;
4683}
4684#endif
4685
4686
4687#ifdef WIN32
4688/*
4689 * On MS-Windows locale names are strings like "German_Germany.1252", but
4690 * gettext expects "de". Try to translate one into another here for a few
4691 * supported languages.
4692 */
4693 static char_u *
4694gettext_lang(char_u *name)
4695{
4696 int i;
4697 static char *(mtable[]) = {
4698 "afrikaans", "af",
4699 "czech", "cs",
4700 "dutch", "nl",
4701 "german", "de",
4702 "english_united kingdom", "en_GB",
4703 "spanish", "es",
4704 "french", "fr",
4705 "italian", "it",
4706 "japanese", "ja",
4707 "korean", "ko",
4708 "norwegian", "no",
4709 "polish", "pl",
4710 "russian", "ru",
4711 "slovak", "sk",
4712 "swedish", "sv",
4713 "ukrainian", "uk",
4714 "chinese_china", "zh_CN",
4715 "chinese_taiwan", "zh_TW",
4716 NULL};
4717
4718 for (i = 0; mtable[i] != NULL; i += 2)
4719 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004720 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00004721 return name;
4722}
4723#endif
4724
4725#if defined(FEAT_MULTI_LANG) || defined(PROTO)
4726/*
4727 * Obtain the current messages language. Used to set the default for
4728 * 'helplang'. May return NULL or an empty string.
4729 */
4730 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004731get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732{
4733 char_u *p;
4734
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004735# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004737 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738# else
4739 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004740 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
4741 * and LC_MONETARY may be set differently for a Japanese working in the
4742 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004743 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744# endif
4745# else
4746 p = mch_getenv((char_u *)"LC_ALL");
4747 if (p == NULL || *p == NUL)
4748 {
4749 p = mch_getenv((char_u *)"LC_MESSAGES");
4750 if (p == NULL || *p == NUL)
4751 p = mch_getenv((char_u *)"LANG");
4752 }
4753# endif
4754# ifdef WIN32
4755 p = gettext_lang(p);
4756# endif
4757 return p;
4758}
4759#endif
4760
Bram Moolenaardef9e822004-12-31 20:58:58 +00004761/* Complicated #if; matches with where get_mess_env() is used below. */
4762#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4763 && defined(LC_MESSAGES))) \
4764 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4765 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
4766 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004767static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768
4769/*
4770 * Get the language used for messages from the environment.
4771 */
4772 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004773get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774{
4775 char_u *p;
4776
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 {
4783 p = mch_getenv((char_u *)"LANG");
4784 if (p != NULL && VIM_ISDIGIT(*p))
4785 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004786# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004787 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004788 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789# endif
4790 }
4791 }
4792 return p;
4793}
4794#endif
4795
4796#if defined(FEAT_EVAL) || defined(PROTO)
4797
4798/*
4799 * Set the "v:lang" variable according to the current locale setting.
4800 * Also do "v:lc_time"and "v:ctype".
4801 */
4802 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004803set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804{
4805 char_u *loc;
4806
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004807# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004808 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809# else
4810 /* setlocale() not supported: use the default value */
4811 loc = (char_u *)"C";
4812# endif
4813 set_vim_var_string(VV_CTYPE, loc, -1);
4814
4815 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
4816 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004817# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004818 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819# else
4820 loc = get_mess_env();
4821# endif
4822 set_vim_var_string(VV_LANG, loc, -1);
4823
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004824# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004825 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004826# endif
4827 set_vim_var_string(VV_LC_TIME, loc, -1);
4828}
4829#endif
4830
4831#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4832 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
4833/*
4834 * ":language": Set the language (locale).
4835 */
4836 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004837ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004838{
4839 char *loc;
4840 char_u *p;
4841 char_u *name;
4842 int what = LC_ALL;
4843 char *whatstr = "";
4844#ifdef LC_MESSAGES
4845# define VIM_LC_MESSAGES LC_MESSAGES
4846#else
4847# define VIM_LC_MESSAGES 6789
4848#endif
4849
4850 name = eap->arg;
4851
4852 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
4853 * Allow abbreviation, but require at least 3 characters to avoid
4854 * confusion with a two letter language name "me" or "ct". */
4855 p = skiptowhite(eap->arg);
4856 if ((*p == NUL || vim_iswhite(*p)) && p - eap->arg >= 3)
4857 {
4858 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
4859 {
4860 what = VIM_LC_MESSAGES;
4861 name = skipwhite(p);
4862 whatstr = "messages ";
4863 }
4864 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
4865 {
4866 what = LC_CTYPE;
4867 name = skipwhite(p);
4868 whatstr = "ctype ";
4869 }
4870 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
4871 {
4872 what = LC_TIME;
4873 name = skipwhite(p);
4874 whatstr = "time ";
4875 }
4876 }
4877
4878 if (*name == NUL)
4879 {
4880#ifndef LC_MESSAGES
4881 if (what == VIM_LC_MESSAGES)
4882 p = get_mess_env();
4883 else
4884#endif
4885 p = (char_u *)setlocale(what, NULL);
4886 if (p == NULL || *p == NUL)
4887 p = (char_u *)"Unknown";
4888 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
4889 }
4890 else
4891 {
4892#ifndef LC_MESSAGES
4893 if (what == VIM_LC_MESSAGES)
4894 loc = "";
4895 else
4896#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004897 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004898 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004899#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
4900 /* Make sure strtod() uses a decimal point, not a comma. */
4901 setlocale(LC_NUMERIC, "C");
4902#endif
4903 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 if (loc == NULL)
4905 EMSG2(_("E197: Cannot set language to \"%s\""), name);
4906 else
4907 {
4908#ifdef HAVE_NL_MSG_CAT_CNTR
4909 /* Need to do this for GNU gettext, otherwise cached translations
4910 * will be used again. */
4911 extern int _nl_msg_cat_cntr;
4912
4913 ++_nl_msg_cat_cntr;
4914#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00004915 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
4917
4918 if (what != LC_TIME)
4919 {
4920 /* Tell gettext() what to translate to. It apparently doesn't
4921 * use the currently effective locale. Also do this when
4922 * FEAT_GETTEXT isn't defined, so that shell commands use this
4923 * value. */
4924 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004925 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02004927
4928 /* Clear $LANGUAGE because GNU gettext uses it. */
4929 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004930# ifdef WIN32
4931 /* Apparently MS-Windows printf() may cause a crash when
4932 * we give it 8-bit text while it's expecting text in the
4933 * current locale. This call avoids that. */
4934 setlocale(LC_CTYPE, "C");
4935# endif
4936 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 if (what != LC_CTYPE)
4938 {
4939 char_u *mname;
4940#ifdef WIN32
4941 mname = gettext_lang(name);
4942#else
4943 mname = name;
4944#endif
4945 vim_setenv((char_u *)"LC_MESSAGES", mname);
4946#ifdef FEAT_MULTI_LANG
4947 set_helplang_default(mname);
4948#endif
4949 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 }
4951
4952# ifdef FEAT_EVAL
4953 /* Set v:lang, v:lc_time and v:ctype to the final result. */
4954 set_lang_var();
4955# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02004956# ifdef FEAT_TITLE
4957 maketitle();
4958# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959 }
4960 }
4961}
4962
4963# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004964
4965static char_u **locales = NULL; /* Array of all available locales */
4966static int did_init_locales = FALSE;
4967
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004968static void init_locales(void);
4969static char_u **find_locales(void);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004970
4971/*
4972 * Lazy initialization of all available locales.
4973 */
4974 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004975init_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004976{
4977 if (!did_init_locales)
4978 {
4979 did_init_locales = TRUE;
4980 locales = find_locales();
4981 }
4982}
4983
4984/* Return an array of strings for all available locales + NULL for the
4985 * last element. Return NULL in case of error. */
4986 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004987find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004988{
4989 garray_T locales_ga;
4990 char_u *loc;
4991
4992 /* Find all available locales by running command "locale -a". If this
4993 * doesn't work we won't have completion. */
4994 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02004995 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004996 if (locale_a == NULL)
4997 return NULL;
4998 ga_init2(&locales_ga, sizeof(char_u *), 20);
4999
5000 /* Transform locale_a string where each locale is separated by "\n"
5001 * into an array of locale strings. */
5002 loc = (char_u *)strtok((char *)locale_a, "\n");
5003
5004 while (loc != NULL)
5005 {
5006 if (ga_grow(&locales_ga, 1) == FAIL)
5007 break;
5008 loc = vim_strsave(loc);
5009 if (loc == NULL)
5010 break;
5011
5012 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5013 loc = (char_u *)strtok(NULL, "\n");
5014 }
5015 vim_free(locale_a);
5016 if (ga_grow(&locales_ga, 1) == FAIL)
5017 {
5018 ga_clear(&locales_ga);
5019 return NULL;
5020 }
5021 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5022 return (char_u **)locales_ga.ga_data;
5023}
5024
5025# if defined(EXITFREE) || defined(PROTO)
5026 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005027free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005028{
5029 int i;
5030 if (locales != NULL)
5031 {
5032 for (i = 0; locales[i] != NULL; i++)
5033 vim_free(locales[i]);
5034 vim_free(locales);
5035 locales = NULL;
5036 }
5037}
5038# endif
5039
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040/*
5041 * Function given to ExpandGeneric() to obtain the possible arguments of the
5042 * ":language" command.
5043 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005045get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005046{
5047 if (idx == 0)
5048 return (char_u *)"messages";
5049 if (idx == 1)
5050 return (char_u *)"ctype";
5051 if (idx == 2)
5052 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005053
5054 init_locales();
5055 if (locales == NULL)
5056 return NULL;
5057 return locales[idx - 3];
5058}
5059
5060/*
5061 * Function given to ExpandGeneric() to obtain the available locales.
5062 */
5063 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005064get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005065{
5066 init_locales();
5067 if (locales == NULL)
5068 return NULL;
5069 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070}
5071# endif
5072
5073#endif