blob: 8a11fbbe9f7e06c8568b2fd7b060d931fc110ab1 [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_cmds2.c: some more functions for command line commands
12 */
13
Bram Moolenaar071d4272004-06-13 20:20:40 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010017static void cmd_source(char_u *fname, exarg_T *eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +000018
Bram Moolenaar05159a02005-02-26 23:04:13 +000019#ifdef FEAT_EVAL
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000020/* Growarray to store info about already sourced scripts.
Bram Moolenaar05159a02005-02-26 23:04:13 +000021 * For Unix also store the dev/ino, so that we don't have to stat() each
22 * script when going through the list. */
23typedef struct scriptitem_S
24{
25 char_u *sn_name;
26# ifdef UNIX
Bram Moolenaarbf0c4522009-05-16 19:16:33 +000027 int sn_dev_valid;
28 dev_t sn_dev;
Bram Moolenaar05159a02005-02-26 23:04:13 +000029 ino_t sn_ino;
30# endif
31# ifdef FEAT_PROFILE
32 int sn_prof_on; /* TRUE when script is/was profiled */
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000033 int sn_pr_force; /* forceit: profile functions in this script */
Bram Moolenaar05159a02005-02-26 23:04:13 +000034 proftime_T sn_pr_child; /* time set when going into first child */
35 int sn_pr_nest; /* nesting for sn_pr_child */
36 /* profiling the script as a whole */
37 int sn_pr_count; /* nr of times sourced */
Bram Moolenaar8c8de832008-06-24 22:58:06 +000038 proftime_T sn_pr_total; /* time spent in script + children */
39 proftime_T sn_pr_self; /* time spent in script itself */
Bram Moolenaar05159a02005-02-26 23:04:13 +000040 proftime_T sn_pr_start; /* time at script start */
41 proftime_T sn_pr_children; /* time in children after script start */
42 /* profiling the script per line */
43 garray_T sn_prl_ga; /* things stored for every line */
44 proftime_T sn_prl_start; /* start time for current line */
45 proftime_T sn_prl_children; /* time spent in children for this line */
46 proftime_T sn_prl_wait; /* wait start time for current line */
47 int sn_prl_idx; /* index of line being timed; -1 if none */
48 int sn_prl_execed; /* line being timed was executed */
49# endif
50} scriptitem_T;
51
52static garray_T script_items = {0, 0, sizeof(scriptitem_T), 4, NULL};
53#define SCRIPT_ITEM(id) (((scriptitem_T *)script_items.ga_data)[(id) - 1])
54
55# ifdef FEAT_PROFILE
56/* Struct used in sn_prl_ga for every line of a script. */
57typedef struct sn_prl_S
58{
59 int snp_count; /* nr of times line was executed */
Bram Moolenaar8c8de832008-06-24 22:58:06 +000060 proftime_T sn_prl_total; /* time spent in a line + children */
61 proftime_T sn_prl_self; /* time spent in a line itself */
Bram Moolenaar05159a02005-02-26 23:04:13 +000062} sn_prl_T;
63
64# define PRL_ITEM(si, idx) (((sn_prl_T *)(si)->sn_prl_ga.ga_data)[(idx)])
65# endif
66#endif
67
Bram Moolenaar071d4272004-06-13 20:20:40 +000068#if defined(FEAT_EVAL) || defined(PROTO)
69static int debug_greedy = FALSE; /* batch mode debugging: don't save
70 and restore typeahead. */
Bram Moolenaarf1f60f82016-01-16 15:40:53 +010071static int get_maxbacktrace_level(void);
72static void do_setdebugtracelevel(char_u *arg);
73static void do_checkbacktracelevel(void);
74static void do_showbacktrace(char_u *cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +000075
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;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001091static long last_timer_id = 0;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001092
Bram Moolenaar75537a92016-09-05 22:45:28 +02001093# ifdef WIN3264
1094# define GET_TIMEDIFF(timer, now) \
1095 (long)(((double)(timer->tr_due.QuadPart - now.QuadPart) \
Bram Moolenaara7c023e2016-10-12 12:13:35 +02001096 / (double)fr.QuadPart) * 1000)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001097# else
1098# define GET_TIMEDIFF(timer, now) \
1099 (timer->tr_due.tv_sec - now.tv_sec) * 1000 \
Bram Moolenaara7c023e2016-10-12 12:13:35 +02001100 + (timer->tr_due.tv_usec - now.tv_usec) / 1000
Bram Moolenaar75537a92016-09-05 22:45:28 +02001101# endif
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001102
Bram Moolenaar975b5272016-03-15 23:10:59 +01001103/*
1104 * Insert a timer in the list of timers.
1105 */
1106 static void
1107insert_timer(timer_T *timer)
1108{
1109 timer->tr_next = first_timer;
1110 timer->tr_prev = NULL;
1111 if (first_timer != NULL)
1112 first_timer->tr_prev = timer;
1113 first_timer = timer;
Bram Moolenaar4231da42016-06-02 14:30:04 +02001114 did_add_timer = TRUE;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001115}
1116
1117/*
1118 * Take a timer out of the list of timers.
1119 */
1120 static void
1121remove_timer(timer_T *timer)
1122{
1123 if (timer->tr_prev == NULL)
1124 first_timer = timer->tr_next;
1125 else
1126 timer->tr_prev->tr_next = timer->tr_next;
1127 if (timer->tr_next != NULL)
1128 timer->tr_next->tr_prev = timer->tr_prev;
1129}
1130
1131 static void
1132free_timer(timer_T *timer)
1133{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001134 free_callback(timer->tr_callback, timer->tr_partial);
1135 vim_free(timer);
Bram Moolenaar975b5272016-03-15 23:10:59 +01001136}
1137
1138/*
1139 * Create a timer and return it. NULL if out of memory.
1140 * Caller should set the callback.
1141 */
1142 timer_T *
1143create_timer(long msec, int repeat)
1144{
1145 timer_T *timer = (timer_T *)alloc_clear(sizeof(timer_T));
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001146 long prev_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001147
1148 if (timer == NULL)
1149 return NULL;
Bram Moolenaaree39ef02016-09-10 19:17:42 +02001150 if (++last_timer_id <= prev_id)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001151 /* Overflow! Might cause duplicates... */
1152 last_timer_id = 0;
1153 timer->tr_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001154 insert_timer(timer);
1155 if (repeat != 0)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001156 timer->tr_repeat = repeat - 1;
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001157 timer->tr_interval = msec;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001158
1159 profile_setlimit(msec, &timer->tr_due);
1160 return timer;
1161}
1162
1163/*
1164 * Invoke the callback of "timer".
1165 */
1166 static void
1167timer_callback(timer_T *timer)
1168{
1169 typval_T rettv;
1170 int dummy;
1171 typval_T argv[2];
1172
1173 argv[0].v_type = VAR_NUMBER;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001174 argv[0].vval.v_number = (varnumber_T)timer->tr_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001175 argv[1].v_type = VAR_UNKNOWN;
1176
1177 call_func(timer->tr_callback, (int)STRLEN(timer->tr_callback),
Bram Moolenaardf48fb42016-07-22 21:50:18 +02001178 &rettv, 1, argv, NULL, 0L, 0L, &dummy, TRUE,
Bram Moolenaar975b5272016-03-15 23:10:59 +01001179 timer->tr_partial, NULL);
1180 clear_tv(&rettv);
1181}
1182
1183/*
1184 * Call timers that are due.
1185 * Return the time in msec until the next timer is due.
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001186 * Returns -1 if there are no pending timers.
Bram Moolenaar975b5272016-03-15 23:10:59 +01001187 */
1188 long
Bram Moolenaarcf089462016-06-12 21:18:43 +02001189check_due_timer(void)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001190{
1191 timer_T *timer;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001192 timer_T *timer_next;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001193 long this_due;
Bram Moolenaar597385a2016-03-16 23:24:43 +01001194 long next_due = -1;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001195 proftime_T now;
1196 int did_one = FALSE;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001197 long current_id = last_timer_id;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001198# ifdef WIN3264
1199 LARGE_INTEGER fr;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001200# endif
Bram Moolenaar975b5272016-03-15 23:10:59 +01001201
Bram Moolenaarc577d812017-07-08 22:37:34 +02001202 /* Don't run any timers while exiting or dealing with an error. */
1203 if (exiting || aborting())
Bram Moolenaarc4f83382017-07-07 14:50:44 +02001204 return next_due;
1205
Bram Moolenaarc577d812017-07-08 22:37:34 +02001206# ifdef WIN3264
Bram Moolenaar975b5272016-03-15 23:10:59 +01001207 QueryPerformanceFrequency(&fr);
1208# endif
Bram Moolenaar75537a92016-09-05 22:45:28 +02001209 profile_start(&now);
1210 for (timer = first_timer; timer != NULL && !got_int; timer = timer_next)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001211 {
Bram Moolenaar75537a92016-09-05 22:45:28 +02001212 timer_next = timer->tr_next;
Bram Moolenaar417ccd72016-09-01 21:26:20 +02001213
Bram Moolenaar75537a92016-09-05 22:45:28 +02001214 if (timer->tr_id == -1 || timer->tr_firing || timer->tr_paused)
1215 continue;
1216 this_due = GET_TIMEDIFF(timer, now);
1217 if (this_due <= 1)
1218 {
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001219 int save_timer_busy = timer_busy;
1220 int save_vgetc_busy = vgetc_busy;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001221 int did_emsg_save = did_emsg;
1222 int called_emsg_save = called_emsg;
1223 int did_throw_save = did_throw;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001224
1225 timer_busy = timer_busy > 0 || vgetc_busy > 0;
1226 vgetc_busy = 0;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001227 called_emsg = FALSE;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001228 timer->tr_firing = TRUE;
1229 timer_callback(timer);
1230 timer->tr_firing = FALSE;
1231 timer_next = timer->tr_next;
1232 did_one = TRUE;
Bram Moolenaar1e8e1452017-06-24 16:03:06 +02001233 timer_busy = save_timer_busy;
1234 vgetc_busy = save_vgetc_busy;
Bram Moolenaarc577d812017-07-08 22:37:34 +02001235 if (called_emsg)
1236 {
1237 ++timer->tr_emsg_count;
Bram Moolenaarcae24be2017-07-10 22:12:10 +02001238 if (!did_throw_save && did_throw && current_exception != NULL)
Bram Moolenaarc577d812017-07-08 22:37:34 +02001239 discard_current_exception();
1240 }
1241 did_emsg = did_emsg_save;
1242 called_emsg = called_emsg_save;
Bram Moolenaar75537a92016-09-05 22:45:28 +02001243
1244 /* Only fire the timer again if it repeats and stop_timer() wasn't
1245 * called while inside the callback (tr_id == -1). */
Bram Moolenaarc577d812017-07-08 22:37:34 +02001246 if (timer->tr_repeat != 0 && timer->tr_id != -1
1247 && timer->tr_emsg_count < 3)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001248 {
1249 profile_setlimit(timer->tr_interval, &timer->tr_due);
1250 this_due = GET_TIMEDIFF(timer, now);
1251 if (this_due < 1)
1252 this_due = 1;
1253 if (timer->tr_repeat > 0)
1254 --timer->tr_repeat;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001255 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001256 else
1257 {
1258 this_due = -1;
1259 remove_timer(timer);
1260 free_timer(timer);
1261 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001262 }
Bram Moolenaar75537a92016-09-05 22:45:28 +02001263 if (this_due > 0 && (next_due == -1 || next_due > this_due))
1264 next_due = this_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001265 }
1266
1267 if (did_one)
1268 redraw_after_callback();
1269
Bram Moolenaar75537a92016-09-05 22:45:28 +02001270 return current_id != last_timer_id ? 1 : next_due;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001271}
1272
1273/*
1274 * Find a timer by ID. Returns NULL if not found;
1275 */
1276 timer_T *
Bram Moolenaar75537a92016-09-05 22:45:28 +02001277find_timer(long id)
Bram Moolenaar975b5272016-03-15 23:10:59 +01001278{
1279 timer_T *timer;
1280
Bram Moolenaar75537a92016-09-05 22:45:28 +02001281 if (id >= 0)
1282 {
1283 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1284 if (timer->tr_id == id)
1285 return timer;
1286 }
1287 return NULL;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001288}
1289
1290
1291/*
1292 * Stop a timer and delete it.
1293 */
1294 void
1295stop_timer(timer_T *timer)
1296{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001297 if (timer->tr_firing)
1298 /* Free the timer after the callback returns. */
1299 timer->tr_id = -1;
1300 else
1301 {
1302 remove_timer(timer);
1303 free_timer(timer);
1304 }
Bram Moolenaar975b5272016-03-15 23:10:59 +01001305}
Bram Moolenaare3188e22016-05-31 21:13:04 +02001306
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001307 void
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001308stop_all_timers(void)
1309{
Bram Moolenaar75537a92016-09-05 22:45:28 +02001310 timer_T *timer;
1311 timer_T *timer_next;
1312
1313 for (timer = first_timer; timer != NULL; timer = timer_next)
1314 {
1315 timer_next = timer->tr_next;
1316 stop_timer(timer);
1317 }
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001318}
1319
1320 void
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001321add_timer_info(typval_T *rettv, timer_T *timer)
1322{
1323 list_T *list = rettv->vval.v_list;
1324 dict_T *dict = dict_alloc();
1325 dictitem_T *di;
1326 long remaining;
1327 proftime_T now;
Bram Moolenaar00ff3802016-08-06 22:27:28 +02001328# ifdef WIN3264
1329 LARGE_INTEGER fr;
1330#endif
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001331
1332 if (dict == NULL)
1333 return;
1334 list_append_dict(list, dict);
1335
Bram Moolenaar75537a92016-09-05 22:45:28 +02001336 dict_add_nr_str(dict, "id", timer->tr_id, NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001337 dict_add_nr_str(dict, "time", (long)timer->tr_interval, NULL);
1338
1339 profile_start(&now);
1340# ifdef WIN3264
Bram Moolenaar00ff3802016-08-06 22:27:28 +02001341 QueryPerformanceFrequency(&fr);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001342# endif
Bram Moolenaar75537a92016-09-05 22:45:28 +02001343 remaining = GET_TIMEDIFF(timer, now);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001344 dict_add_nr_str(dict, "remaining", (long)remaining, NULL);
1345
1346 dict_add_nr_str(dict, "repeat",
1347 (long)(timer->tr_repeat < 0 ? -1 : timer->tr_repeat + 1), NULL);
Bram Moolenaarb73598e2016-08-07 18:22:53 +02001348 dict_add_nr_str(dict, "paused", (long)(timer->tr_paused), NULL);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001349
1350 di = dictitem_alloc((char_u *)"callback");
1351 if (di != NULL)
1352 {
1353 if (dict_add(dict, di) == FAIL)
1354 vim_free(di);
1355 else if (timer->tr_partial != NULL)
1356 {
1357 di->di_tv.v_type = VAR_PARTIAL;
1358 di->di_tv.vval.v_partial = timer->tr_partial;
1359 ++timer->tr_partial->pt_refcount;
1360 }
1361 else
1362 {
1363 di->di_tv.v_type = VAR_FUNC;
1364 di->di_tv.vval.v_string = vim_strsave(timer->tr_callback);
1365 }
1366 di->di_tv.v_lock = 0;
1367 }
1368}
1369
1370 void
1371add_timer_info_all(typval_T *rettv)
1372{
1373 timer_T *timer;
1374
1375 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
Bram Moolenaar75537a92016-09-05 22:45:28 +02001376 if (timer->tr_id != -1)
1377 add_timer_info(rettv, timer);
Bram Moolenaar8e97bd72016-08-06 22:05:07 +02001378}
1379
Bram Moolenaare3188e22016-05-31 21:13:04 +02001380/*
1381 * Mark references in partials of timers.
1382 */
1383 int
1384set_ref_in_timer(int copyID)
1385{
1386 int abort = FALSE;
1387 timer_T *timer;
1388 typval_T tv;
1389
1390 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1391 {
Bram Moolenaar1e96d9b2016-07-29 22:15:09 +02001392 if (timer->tr_partial != NULL)
1393 {
1394 tv.v_type = VAR_PARTIAL;
1395 tv.vval.v_partial = timer->tr_partial;
1396 }
1397 else
1398 {
1399 tv.v_type = VAR_FUNC;
1400 tv.vval.v_string = timer->tr_callback;
1401 }
Bram Moolenaare3188e22016-05-31 21:13:04 +02001402 abort = abort || set_ref_in_item(&tv, copyID, NULL, NULL);
1403 }
1404 return abort;
1405}
Bram Moolenaar623e2632016-07-30 22:47:56 +02001406
1407# if defined(EXITFREE) || defined(PROTO)
1408 void
1409timer_free_all()
1410{
1411 timer_T *timer;
1412
1413 while (first_timer != NULL)
1414 {
1415 timer = first_timer;
1416 remove_timer(timer);
1417 free_timer(timer);
1418 }
1419}
1420# endif
Bram Moolenaar975b5272016-03-15 23:10:59 +01001421# endif
1422
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001423#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1424# if defined(HAVE_MATH_H)
1425# include <math.h>
1426# endif
1427
1428/*
1429 * Divide the time "tm" by "count" and store in "tm2".
1430 */
1431 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001432profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001433{
1434 if (count == 0)
1435 profile_zero(tm2);
1436 else
1437 {
1438# ifdef WIN3264
1439 tm2->QuadPart = tm->QuadPart / count;
1440# else
1441 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1442
1443 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001444 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001445# endif
1446 }
1447}
1448#endif
1449
Bram Moolenaar76929292008-01-06 19:07:36 +00001450# if defined(FEAT_PROFILE) || defined(PROTO)
1451/*
1452 * Functions for profiling.
1453 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001454static void script_do_profile(scriptitem_T *si);
1455static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001456static proftime_T prof_wait_time;
1457
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001458/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001459 * Add the time "tm2" to "tm".
1460 */
1461 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001462profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001463{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001464# ifdef WIN3264
1465 tm->QuadPart += tm2->QuadPart;
1466# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001467 tm->tv_usec += tm2->tv_usec;
1468 tm->tv_sec += tm2->tv_sec;
1469 if (tm->tv_usec >= 1000000)
1470 {
1471 tm->tv_usec -= 1000000;
1472 ++tm->tv_sec;
1473 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001474# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001475}
1476
1477/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001478 * Add the "self" time from the total time and the children's time.
1479 */
1480 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001481profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001482{
1483 /* Check that the result won't be negative. Can happen with recursive
1484 * calls. */
1485#ifdef WIN3264
1486 if (total->QuadPart <= children->QuadPart)
1487 return;
1488#else
1489 if (total->tv_sec < children->tv_sec
1490 || (total->tv_sec == children->tv_sec
1491 && total->tv_usec <= children->tv_usec))
1492 return;
1493#endif
1494 profile_add(self, total);
1495 profile_sub(self, children);
1496}
1497
1498/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001499 * Get the current waittime.
1500 */
1501 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001502profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001503{
1504 *tm = prof_wait_time;
1505}
1506
1507/*
1508 * Subtract the passed waittime since "tm" from "tma".
1509 */
1510 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001511profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001512{
1513 proftime_T tm3 = prof_wait_time;
1514
1515 profile_sub(&tm3, tm);
1516 profile_sub(tma, &tm3);
1517}
1518
1519/*
1520 * Return TRUE if "tm1" and "tm2" are equal.
1521 */
1522 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001523profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001524{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001525# ifdef WIN3264
1526 return (tm1->QuadPart == tm2->QuadPart);
1527# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001528 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001529# endif
1530}
1531
1532/*
1533 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1534 */
1535 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001536profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001537{
1538# ifdef WIN3264
1539 return (int)(tm2->QuadPart - tm1->QuadPart);
1540# else
1541 if (tm1->tv_sec == tm2->tv_sec)
1542 return tm2->tv_usec - tm1->tv_usec;
1543 return tm2->tv_sec - tm1->tv_sec;
1544# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001545}
1546
Bram Moolenaar05159a02005-02-26 23:04:13 +00001547static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001548static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001549
1550/*
1551 * ":profile cmd args"
1552 */
1553 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001554ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001555{
1556 char_u *e;
1557 int len;
1558
1559 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001560 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001561 e = skipwhite(e);
1562
1563 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1564 {
1565 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001566 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001567 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001568 profile_zero(&prof_wait_time);
1569 set_vim_var_nr(VV_PROFILING, 1L);
1570 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001571 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001572 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001573 else if (STRCMP(eap->arg, "pause") == 0)
1574 {
1575 if (do_profiling == PROF_YES)
1576 profile_start(&pause_time);
1577 do_profiling = PROF_PAUSED;
1578 }
1579 else if (STRCMP(eap->arg, "continue") == 0)
1580 {
1581 if (do_profiling == PROF_PAUSED)
1582 {
1583 profile_end(&pause_time);
1584 profile_add(&prof_wait_time, &pause_time);
1585 }
1586 do_profiling = PROF_YES;
1587 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001588 else
1589 {
1590 /* The rest is similar to ":breakadd". */
1591 ex_breakadd(eap);
1592 }
1593}
1594
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001595/* Command line expansion for :profile. */
1596static enum
1597{
1598 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001599 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001600} pexpand_what;
1601
1602static char *pexpand_cmds[] = {
1603 "start",
1604#define PROFCMD_START 0
1605 "pause",
1606#define PROFCMD_PAUSE 1
1607 "continue",
1608#define PROFCMD_CONTINUE 2
1609 "func",
1610#define PROFCMD_FUNC 3
1611 "file",
1612#define PROFCMD_FILE 4
1613 NULL
1614#define PROFCMD_LAST 5
1615};
1616
1617/*
1618 * Function given to ExpandGeneric() to obtain the profile command
1619 * specific expansion.
1620 */
1621 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001622get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001623{
1624 switch (pexpand_what)
1625 {
1626 case PEXP_SUBCMD:
1627 return (char_u *)pexpand_cmds[idx];
1628 /* case PEXP_FUNC: TODO */
1629 default:
1630 return NULL;
1631 }
1632}
1633
1634/*
1635 * Handle command line completion for :profile command.
1636 */
1637 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001638set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001639{
1640 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001641
1642 /* Default: expand subcommands. */
1643 xp->xp_context = EXPAND_PROFILE;
1644 pexpand_what = PEXP_SUBCMD;
1645 xp->xp_pattern = arg;
1646
1647 end_subcmd = skiptowhite(arg);
1648 if (*end_subcmd == NUL)
1649 return;
1650
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001651 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001652 {
1653 xp->xp_context = EXPAND_FILES;
1654 xp->xp_pattern = skipwhite(end_subcmd);
1655 return;
1656 }
1657
1658 /* TODO: expand function names after "func" */
1659 xp->xp_context = EXPAND_NOTHING;
1660}
1661
Bram Moolenaar05159a02005-02-26 23:04:13 +00001662/*
1663 * Dump the profiling info.
1664 */
1665 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001666profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001667{
1668 FILE *fd;
1669
1670 if (profile_fname != NULL)
1671 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001672 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001673 if (fd == NULL)
1674 EMSG2(_(e_notopen), profile_fname);
1675 else
1676 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001677 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001678 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001679 fclose(fd);
1680 }
1681 }
1682}
1683
1684/*
1685 * Start profiling script "fp".
1686 */
1687 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001688script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001689{
1690 si->sn_pr_count = 0;
1691 profile_zero(&si->sn_pr_total);
1692 profile_zero(&si->sn_pr_self);
1693
1694 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1695 si->sn_prl_idx = -1;
1696 si->sn_prof_on = TRUE;
1697 si->sn_pr_nest = 0;
1698}
1699
1700/*
1701 * save time when starting to invoke another script or function.
1702 */
1703 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001704script_prof_save(
1705 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001706{
1707 scriptitem_T *si;
1708
1709 if (current_SID > 0 && current_SID <= script_items.ga_len)
1710 {
1711 si = &SCRIPT_ITEM(current_SID);
1712 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1713 profile_start(&si->sn_pr_child);
1714 }
1715 profile_get_wait(tm);
1716}
1717
1718/*
1719 * Count time spent in children after invoking another script or function.
1720 */
1721 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001722script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001723{
1724 scriptitem_T *si;
1725
1726 if (current_SID > 0 && current_SID <= script_items.ga_len)
1727 {
1728 si = &SCRIPT_ITEM(current_SID);
1729 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1730 {
1731 profile_end(&si->sn_pr_child);
1732 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1733 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1734 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1735 }
1736 }
1737}
1738
1739static proftime_T inchar_time;
1740
1741/*
1742 * Called when starting to wait for the user to type a character.
1743 */
1744 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001745prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001746{
1747 profile_start(&inchar_time);
1748}
1749
1750/*
1751 * Called when finished waiting for the user to type a character.
1752 */
1753 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001754prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001755{
1756 profile_end(&inchar_time);
1757 profile_add(&prof_wait_time, &inchar_time);
1758}
1759
1760/*
1761 * Dump the profiling results for all scripts in file "fd".
1762 */
1763 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001764script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001765{
1766 int id;
1767 scriptitem_T *si;
1768 int i;
1769 FILE *sfd;
1770 sn_prl_T *pp;
1771
1772 for (id = 1; id <= script_items.ga_len; ++id)
1773 {
1774 si = &SCRIPT_ITEM(id);
1775 if (si->sn_prof_on)
1776 {
1777 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1778 if (si->sn_pr_count == 1)
1779 fprintf(fd, "Sourced 1 time\n");
1780 else
1781 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1782 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1783 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1784 fprintf(fd, "\n");
1785 fprintf(fd, "count total (s) self (s)\n");
1786
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001787 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001788 if (sfd == NULL)
1789 fprintf(fd, "Cannot open file!\n");
1790 else
1791 {
1792 for (i = 0; i < si->sn_prl_ga.ga_len; ++i)
1793 {
1794 if (vim_fgets(IObuff, IOSIZE, sfd))
1795 break;
1796 pp = &PRL_ITEM(si, i);
1797 if (pp->snp_count > 0)
1798 {
1799 fprintf(fd, "%5d ", pp->snp_count);
1800 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1801 fprintf(fd, " ");
1802 else
1803 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1804 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1805 }
1806 else
1807 fprintf(fd, " ");
1808 fprintf(fd, "%s", IObuff);
1809 }
1810 fclose(sfd);
1811 }
1812 fprintf(fd, "\n");
1813 }
1814 }
1815}
1816
1817/*
1818 * Return TRUE when a function defined in the current script should be
1819 * profiled.
1820 */
1821 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001822prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001823{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00001824 if (current_SID > 0)
1825 return SCRIPT_ITEM(current_SID).sn_pr_force;
1826 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001827}
1828
1829# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830#endif
1831
1832/*
1833 * If 'autowrite' option set, try to write the file.
1834 * Careful: autocommands may make "buf" invalid!
1835 *
1836 * return FAIL for failure, OK otherwise
1837 */
1838 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001839autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840{
Bram Moolenaar373154b2007-02-13 05:19:30 +00001841 int r;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001842 bufref_T bufref;
Bram Moolenaar373154b2007-02-13 05:19:30 +00001843
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 if (!(p_aw || p_awa) || !p_write
1845#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00001846 /* never autowrite a "nofile" or "nowrite" buffer */
1847 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00001849 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 return FAIL;
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001851 set_bufref(&bufref, buf);
Bram Moolenaar373154b2007-02-13 05:19:30 +00001852 r = buf_write_all(buf, forceit);
1853
1854 /* Writing may succeed but the buffer still changed, e.g., when there is a
1855 * conversion error. We do want to return FAIL then. */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001856 if (bufref_valid(&bufref) && bufIsChanged(buf))
Bram Moolenaar373154b2007-02-13 05:19:30 +00001857 r = FAIL;
1858 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859}
1860
1861/*
1862 * flush all buffers, except the ones that are readonly
1863 */
1864 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001865autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866{
1867 buf_T *buf;
1868
1869 if (!(p_aw || p_awa) || !p_write)
1870 return;
Bram Moolenaar29323592016-07-24 22:04:11 +02001871 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 if (bufIsChanged(buf) && !buf->b_p_ro)
1873 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001874#ifdef FEAT_AUTOCMD
1875 bufref_T bufref;
1876
1877 set_bufref(&bufref, buf);
1878#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 (void)buf_write_all(buf, FALSE);
1880#ifdef FEAT_AUTOCMD
1881 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001882 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 buf = firstbuf;
1884#endif
1885 }
1886}
1887
1888/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001889 * Return TRUE if buffer was changed and cannot be abandoned.
1890 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001891 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001892 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001893check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894{
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001895 int forceit = (flags & CCGD_FORCEIT);
1896#ifdef FEAT_AUTOCMD
1897 bufref_T bufref;
1898
1899 set_bufref(&bufref, buf);
1900#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001901
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902 if ( !forceit
1903 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001904 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
1905 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906 {
1907#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1908 if ((p_confirm || cmdmod.confirm) && p_write)
1909 {
1910 buf_T *buf2;
1911 int count = 0;
1912
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001913 if (flags & CCGD_ALLBUF)
Bram Moolenaar29323592016-07-24 22:04:11 +02001914 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915 if (bufIsChanged(buf2)
1916 && (buf2->b_ffname != NULL
1917# ifdef FEAT_BROWSE
1918 || cmdmod.browse
1919# endif
1920 ))
1921 ++count;
1922# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001923 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 /* Autocommand deleted buffer, oops! It's not changed now. */
1925 return FALSE;
1926# endif
1927 dialog_changed(buf, count > 1);
1928# ifdef FEAT_AUTOCMD
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02001929 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 /* Autocommand deleted buffer, oops! It's not changed now. */
1931 return FALSE;
1932# endif
1933 return bufIsChanged(buf);
1934 }
1935#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001936 if (flags & CCGD_EXCMD)
1937 EMSG(_(e_nowrtmsg));
1938 else
1939 EMSG(_(e_nowrtmsg_nobang));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 return TRUE;
1941 }
1942 return FALSE;
1943}
1944
1945#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
1946
1947#if defined(FEAT_BROWSE) || defined(PROTO)
1948/*
1949 * When wanting to write a file without a file name, ask the user for a name.
1950 */
1951 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001952browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953{
1954 if (buf->b_fname == NULL)
1955 {
1956 char_u *fname;
1957
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001958 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
1959 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960 if (fname != NULL)
1961 {
1962 if (setfname(buf, fname, NULL, TRUE) == OK)
1963 buf->b_flags |= BF_NOTEDITED;
1964 vim_free(fname);
1965 }
1966 }
1967}
1968#endif
1969
1970/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02001971 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 * Must check 'write' option first!
1973 */
1974 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001975dialog_changed(
1976 buf_T *buf,
1977 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978{
Bram Moolenaard9462e32011-04-11 21:35:11 +02001979 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001980 int ret;
1981 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02001982 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00001984 dialog_msg(buff, _("Save changes to \"%s\"?"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 (buf->b_fname != NULL) ?
1986 buf->b_fname : (char_u *)_("Untitled"));
1987 if (checkall)
1988 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
1989 else
1990 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
1991
Bram Moolenaar8218f602012-04-25 17:32:18 +02001992 /* Init ea pseudo-structure, this is needed for the check_overwrite()
1993 * function. */
1994 ea.append = ea.forceit = FALSE;
1995
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 if (ret == VIM_YES)
1997 {
1998#ifdef FEAT_BROWSE
1999 /* May get file name, when there is none */
2000 browse_save_fname(buf);
2001#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002002 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
2003 buf->b_fname, buf->b_ffname, FALSE) == OK)
2004 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 (void)buf_write_all(buf, FALSE);
2006 }
2007 else if (ret == VIM_NO)
2008 {
2009 unchanged(buf, TRUE);
2010 }
2011 else if (ret == VIM_ALL)
2012 {
2013 /*
2014 * Write all modified files that can be written.
2015 * Skip readonly buffers, these need to be confirmed
2016 * individually.
2017 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002018 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019 {
2020 if (bufIsChanged(buf2)
2021 && (buf2->b_ffname != NULL
2022#ifdef FEAT_BROWSE
2023 || cmdmod.browse
2024#endif
2025 )
2026 && !buf2->b_p_ro)
2027 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002028#ifdef FEAT_AUTOCMD
2029 bufref_T bufref;
2030
2031 set_bufref(&bufref, buf2);
2032#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033#ifdef FEAT_BROWSE
2034 /* May get file name, when there is none */
2035 browse_save_fname(buf2);
2036#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02002037 if (buf2->b_fname != NULL && check_overwrite(&ea, buf2,
2038 buf2->b_fname, buf2->b_ffname, FALSE) == OK)
2039 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 (void)buf_write_all(buf2, FALSE);
2041#ifdef FEAT_AUTOCMD
2042 /* an autocommand may have deleted the buffer */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002043 if (!bufref_valid(&bufref))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 buf2 = firstbuf;
2045#endif
2046 }
2047 }
2048 }
2049 else if (ret == VIM_DISCARDALL)
2050 {
2051 /*
2052 * mark all buffers as unchanged
2053 */
Bram Moolenaar29323592016-07-24 22:04:11 +02002054 FOR_ALL_BUFFERS(buf2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 unchanged(buf2, TRUE);
2056 }
2057}
2058#endif
2059
2060/*
2061 * Return TRUE if the buffer "buf" can be abandoned, either by making it
2062 * hidden, autowriting it or unloading it.
2063 */
2064 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002065can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002066{
Bram Moolenaareb44a682017-08-03 22:44:55 +02002067 return ( buf_hide(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 || !bufIsChanged(buf)
2069 || buf->b_nwindows > 1
2070 || autowrite(buf, forceit) == OK
2071 || forceit);
2072}
2073
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002074static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002075
2076/*
2077 * Add a buffer number to "bufnrs", unless it's already there.
2078 */
2079 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002080add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002081{
2082 int i;
2083
2084 for (i = 0; i < *bufnump; ++i)
2085 if (bufnrs[i] == nr)
2086 return;
2087 bufnrs[*bufnump] = nr;
2088 *bufnump = *bufnump + 1;
2089}
2090
Bram Moolenaar071d4272004-06-13 20:20:40 +00002091/*
2092 * Return TRUE if any buffer was changed and cannot be abandoned.
2093 * That changed buffer becomes the current buffer.
Bram Moolenaar027387f2016-01-02 22:25:52 +01002094 * When "unload" is true the current buffer is unloaded instead of making it
2095 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 */
2097 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002098check_changed_any(
2099 int hidden, /* Only check hidden buffers */
2100 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002102 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 buf_T *buf;
2104 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002105 int i;
2106 int bufnum = 0;
2107 int bufcount = 0;
2108 int *bufnrs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109#ifdef FEAT_WINDOWS
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002110 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 win_T *wp;
2112#endif
2113
Bram Moolenaar29323592016-07-24 22:04:11 +02002114 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002115 ++bufcount;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002117 if (bufcount == 0)
2118 return FALSE;
2119
2120 bufnrs = (int *)alloc(sizeof(int) * bufcount);
2121 if (bufnrs == NULL)
2122 return FALSE;
2123
2124 /* curbuf */
2125 bufnrs[bufnum++] = curbuf->b_fnum;
2126#ifdef FEAT_WINDOWS
2127 /* buf in curtab */
2128 FOR_ALL_WINDOWS(wp)
2129 if (wp->w_buffer != curbuf)
2130 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2131
2132 /* buf in other tab */
Bram Moolenaar29323592016-07-24 22:04:11 +02002133 FOR_ALL_TABPAGES(tp)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002134 if (tp != curtab)
2135 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
2136 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
2137#endif
2138 /* any other buf */
Bram Moolenaar29323592016-07-24 22:04:11 +02002139 FOR_ALL_BUFFERS(buf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002140 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
2141
2142 for (i = 0; i < bufnum; ++i)
2143 {
2144 buf = buflist_findnr(bufnrs[i]);
2145 if (buf == NULL)
2146 continue;
2147 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
2148 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002149 bufref_T bufref;
2150
2151 set_bufref(&bufref, buf);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002152 /* Try auto-writing the buffer. If this fails but the buffer no
2153 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002154 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
2155 | CCGD_MULTWIN
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002156 | CCGD_ALLBUF) && bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002157 break; /* didn't save - still changes */
2158 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002159 }
2160
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002161 if (i >= bufnum)
2162 goto theend;
2163
2164 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 exiting = FALSE;
2166#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
2167 /*
2168 * When ":confirm" used, don't give an error message.
2169 */
2170 if (!(p_confirm || cmdmod.confirm))
2171#endif
2172 {
2173 /* There must be a wait_return for this message, do_buffer()
2174 * may cause a redraw. But wait_return() is a no-op when vgetc()
2175 * is busy (Quit used from window menu), then make sure we don't
2176 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00002177 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002178 {
2179 msg_row = cmdline_row;
2180 msg_col = 0;
2181 msg_didout = FALSE;
2182 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002183 if (
2184#ifdef FEAT_TERMINAL
2185 term_job_running(buf->b_term)
2186 ? EMSG2(_("E947: Job still running in buffer \"%s\""),
2187 buf->b_fname)
2188 :
2189#endif
2190 EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002191 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 {
2193 save = no_wait_return;
2194 no_wait_return = FALSE;
2195 wait_return(FALSE);
2196 no_wait_return = save;
2197 }
2198 }
2199
2200#ifdef FEAT_WINDOWS
2201 /* Try to find a window that contains the buffer. */
2202 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002203 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002204 if (wp->w_buffer == buf)
2205 {
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002206# ifdef FEAT_AUTOCMD
2207 bufref_T bufref;
2208
2209 set_bufref(&bufref, buf);
2210# endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002211 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212# ifdef FEAT_AUTOCMD
2213 /* Paranoia: did autocms wipe out the buffer with changes? */
Bram Moolenaar7c0a2f32016-07-10 22:11:16 +02002214 if (!bufref_valid(&bufref))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002215 {
2216 goto theend;
2217 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218# endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002219 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002220 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002221buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002222#endif
2223
2224 /* Open the changed buffer in the current window. */
2225 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002226 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002228theend:
2229 vim_free(bufnrs);
2230 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231}
2232
2233/*
2234 * return FAIL if there is no file name, OK if there is one
2235 * give error message for FAIL
2236 */
2237 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002238check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239{
2240 if (curbuf->b_ffname == NULL)
2241 {
2242 EMSG(_(e_noname));
2243 return FAIL;
2244 }
2245 return OK;
2246}
2247
2248/*
2249 * flush the contents of a buffer, unless it has no file name
2250 *
2251 * return FAIL for failure, OK otherwise
2252 */
2253 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002254buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255{
2256 int retval;
2257#ifdef FEAT_AUTOCMD
2258 buf_T *old_curbuf = curbuf;
2259#endif
2260
2261 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2262 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2263 FALSE, forceit, TRUE, FALSE));
2264#ifdef FEAT_AUTOCMD
2265 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002266 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01002267 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002268 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002269 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270#endif
2271 return retval;
2272}
2273
2274/*
2275 * Code to handle the argument list.
2276 */
2277
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002278static char_u *do_one_arg(char_u *str);
2279static int do_arglist(char_u *str, int what, int after);
2280static void alist_check_arg_idx(void);
2281static int editing_arg_idx(win_T *win);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002282#ifdef FEAT_LISTCMDS
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002283static int alist_add_list(int count, char_u **files, int after);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002284#endif
2285#define AL_SET 1
2286#define AL_ADD 2
2287#define AL_DEL 3
2288
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002290 * Isolate one argument, taking backticks.
2291 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 * Return a pointer to the start of the next argument.
2293 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002294 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002295do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002296{
2297 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002298 int inbacktick;
2299
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 inbacktick = FALSE;
2301 for (p = str; *str; ++str)
2302 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002303 /* When the backslash is used for escaping the special meaning of a
2304 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002305 if (rem_backslash(str))
2306 {
2307 *p++ = *str++;
2308 *p++ = *str;
2309 }
2310 else
2311 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002312 /* An item ends at a space not in backticks */
2313 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002315 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002316 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002317 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 }
2319 }
2320 str = skipwhite(str);
2321 *p = NUL;
2322
2323 return str;
2324}
2325
Bram Moolenaar86b68352004-12-27 21:59:20 +00002326/*
2327 * Separate the arguments in "str" and return a list of pointers in the
2328 * growarray "gap".
2329 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002330 static int
2331get_arglist(garray_T *gap, char_u *str, int escaped)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002332{
2333 ga_init2(gap, (int)sizeof(char_u *), 20);
2334 while (*str != NUL)
2335 {
2336 if (ga_grow(gap, 1) == FAIL)
2337 {
2338 ga_clear(gap);
2339 return FAIL;
2340 }
2341 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2342
Bram Moolenaar398ee732017-08-03 14:29:14 +02002343 /* If str is escaped, don't handle backslashes or spaces */
2344 if (!escaped)
2345 return OK;
2346
Bram Moolenaar86b68352004-12-27 21:59:20 +00002347 /* Isolate one argument, change it in-place, put a NUL after it. */
2348 str = do_one_arg(str);
2349 }
2350 return OK;
2351}
2352
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002353#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002354/*
2355 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002356 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002357 * Return FAIL or OK.
2358 */
2359 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002360get_arglist_exp(
2361 char_u *str,
2362 int *fcountp,
2363 char_u ***fnamesp,
2364 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002365{
2366 garray_T ga;
2367 int i;
2368
Bram Moolenaar398ee732017-08-03 14:29:14 +02002369 if (get_arglist(&ga, str, TRUE) == FAIL)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002370 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002371 if (wig == TRUE)
2372 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2373 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2374 else
2375 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2376 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2377
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002378 ga_clear(&ga);
2379 return i;
2380}
2381#endif
2382
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
2384/*
2385 * Redefine the argument list.
2386 */
2387 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002388set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389{
2390 do_arglist(str, AL_SET, 0);
2391}
2392#endif
2393
2394/*
2395 * "what" == AL_SET: Redefine the argument list to 'str'.
2396 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2397 * "what" == AL_DEL: remove files in 'str' from the argument list.
2398 *
2399 * Return FAIL for failure, OK otherwise.
2400 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002402do_arglist(
2403 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002404 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002405 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406{
2407 garray_T new_ga;
2408 int exp_count;
2409 char_u **exp_files;
2410 int i;
2411#ifdef FEAT_LISTCMDS
2412 char_u *p;
2413 int match;
2414#endif
Bram Moolenaar398ee732017-08-03 14:29:14 +02002415 int arg_escaped = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002416
2417 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002418 * Set default argument for ":argadd" command.
2419 */
2420 if (what == AL_ADD && *str == NUL)
2421 {
2422 if (curbuf->b_ffname == NULL)
2423 return FAIL;
2424 str = curbuf->b_fname;
Bram Moolenaar398ee732017-08-03 14:29:14 +02002425 arg_escaped = FALSE;
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002426 }
2427
2428 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 * Collect all file name arguments in "new_ga".
2430 */
Bram Moolenaar398ee732017-08-03 14:29:14 +02002431 if (get_arglist(&new_ga, str, arg_escaped) == FAIL)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002432 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433
2434#ifdef FEAT_LISTCMDS
2435 if (what == AL_DEL)
2436 {
2437 regmatch_T regmatch;
2438 int didone;
2439
2440 /*
2441 * Delete the items: use each item as a regexp and find a match in the
2442 * argument list.
2443 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002444 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002445 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2446 {
2447 p = ((char_u **)new_ga.ga_data)[i];
2448 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2449 if (p == NULL)
2450 break;
2451 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2452 if (regmatch.regprog == NULL)
2453 {
2454 vim_free(p);
2455 break;
2456 }
2457
2458 didone = FALSE;
2459 for (match = 0; match < ARGCOUNT; ++match)
2460 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2461 (colnr_T)0))
2462 {
2463 didone = TRUE;
2464 vim_free(ARGLIST[match].ae_fname);
2465 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2466 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2467 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 if (curwin->w_arg_idx > match)
2469 --curwin->w_arg_idx;
2470 --match;
2471 }
2472
Bram Moolenaar473de612013-06-08 18:19:48 +02002473 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002474 vim_free(p);
2475 if (!didone)
2476 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2477 }
2478 ga_clear(&new_ga);
2479 }
2480 else
2481#endif
2482 {
2483 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2484 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2485 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002486 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002487 {
2488 EMSG(_(e_nomatch));
2489 return FAIL;
2490 }
2491
2492#ifdef FEAT_LISTCMDS
2493 if (what == AL_ADD)
2494 {
2495 (void)alist_add_list(exp_count, exp_files, after);
2496 vim_free(exp_files);
2497 }
2498 else /* what == AL_SET */
2499#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00002500 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 }
2502
2503 alist_check_arg_idx();
2504
2505 return OK;
2506}
2507
2508/*
2509 * Check the validity of the arg_idx for each other window.
2510 */
2511 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002512alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002513{
2514#ifdef FEAT_WINDOWS
2515 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002516 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517
Bram Moolenaarf740b292006-02-16 22:11:02 +00002518 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519 if (win->w_alist == curwin->w_alist)
2520 check_arg_idx(win);
2521#else
2522 check_arg_idx(curwin);
2523#endif
2524}
2525
2526/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002527 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002528 * index.
2529 */
2530 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002531editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002532{
2533 return !(win->w_arg_idx >= WARGCOUNT(win)
2534 || (win->w_buffer->b_fnum
2535 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2536 && (win->w_buffer->b_ffname == NULL
2537 || !(fullpathcmp(
2538 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2539 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2540}
2541
2542/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002543 * Check if window "win" is editing the w_arg_idx file in its argument list.
2544 */
2545 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002546check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002548 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 {
2550 /* We are not editing the current entry in the argument list.
2551 * Set "arg_had_last" if we are editing the last one. */
2552 win->w_arg_idx_invalid = TRUE;
2553 if (win->w_arg_idx != WARGCOUNT(win) - 1
2554 && arg_had_last == FALSE
2555#ifdef FEAT_WINDOWS
2556 && ALIST(win) == &global_alist
2557#endif
2558 && GARGCOUNT > 0
2559 && win->w_arg_idx < GARGCOUNT
2560 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2561 || (win->w_buffer->b_ffname != NULL
2562 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2563 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2564 arg_had_last = TRUE;
2565 }
2566 else
2567 {
2568 /* We are editing the current entry in the argument list.
2569 * Set "arg_had_last" if it's also the last one */
2570 win->w_arg_idx_invalid = FALSE;
2571 if (win->w_arg_idx == WARGCOUNT(win) - 1
2572#ifdef FEAT_WINDOWS
2573 && win->w_alist == &global_alist
2574#endif
2575 )
2576 arg_had_last = TRUE;
2577 }
2578}
2579
2580/*
2581 * ":args", ":argslocal" and ":argsglobal".
2582 */
2583 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002584ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002585{
2586 int i;
2587
2588 if (eap->cmdidx != CMD_args)
2589 {
2590#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2591 alist_unlink(ALIST(curwin));
2592 if (eap->cmdidx == CMD_argglobal)
2593 ALIST(curwin) = &global_alist;
2594 else /* eap->cmdidx == CMD_arglocal */
2595 alist_new();
2596#else
2597 ex_ni(eap);
2598 return;
2599#endif
2600 }
2601
2602 if (!ends_excmd(*eap->arg))
2603 {
2604 /*
2605 * ":args file ..": define new argument list, handle like ":next"
2606 * Also for ":argslocal file .." and ":argsglobal file ..".
2607 */
2608 ex_next(eap);
2609 }
2610 else
2611#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2612 if (eap->cmdidx == CMD_args)
2613#endif
2614 {
2615 /*
2616 * ":args": list arguments.
2617 */
2618 if (ARGCOUNT > 0)
2619 {
2620 /* Overwrite the command, for a short list there is no scrolling
2621 * required and no wait_return(). */
2622 gotocmdline(TRUE);
2623 for (i = 0; i < ARGCOUNT; ++i)
2624 {
2625 if (i == curwin->w_arg_idx)
2626 msg_putchar('[');
2627 msg_outtrans(alist_name(&ARGLIST[i]));
2628 if (i == curwin->w_arg_idx)
2629 msg_putchar(']');
2630 msg_putchar(' ');
2631 }
2632 }
2633 }
2634#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2635 else if (eap->cmdidx == CMD_arglocal)
2636 {
2637 garray_T *gap = &curwin->w_alist->al_ga;
2638
2639 /*
2640 * ":argslocal": make a local copy of the global argument list.
2641 */
2642 if (ga_grow(gap, GARGCOUNT) == OK)
2643 for (i = 0; i < GARGCOUNT; ++i)
2644 if (GARGLIST[i].ae_fname != NULL)
2645 {
2646 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2647 vim_strsave(GARGLIST[i].ae_fname);
2648 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2649 GARGLIST[i].ae_fnum;
2650 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 }
2652 }
2653#endif
2654}
2655
2656/*
2657 * ":previous", ":sprevious", ":Next" and ":sNext".
2658 */
2659 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002660ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661{
2662 /* If past the last one already, go to the last one. */
2663 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2664 do_argfile(eap, ARGCOUNT - 1);
2665 else
2666 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2667}
2668
2669/*
2670 * ":rewind", ":first", ":sfirst" and ":srewind".
2671 */
2672 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002673ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674{
2675 do_argfile(eap, 0);
2676}
2677
2678/*
2679 * ":last" and ":slast".
2680 */
2681 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002682ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683{
2684 do_argfile(eap, ARGCOUNT - 1);
2685}
2686
2687/*
2688 * ":argument" and ":sargument".
2689 */
2690 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002691ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692{
2693 int i;
2694
2695 if (eap->addr_count > 0)
2696 i = eap->line2 - 1;
2697 else
2698 i = curwin->w_arg_idx;
2699 do_argfile(eap, i);
2700}
2701
2702/*
2703 * Edit file "argn" of the argument lists.
2704 */
2705 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002706do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707{
2708 int other;
2709 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002710 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711
2712 if (argn < 0 || argn >= ARGCOUNT)
2713 {
2714 if (ARGCOUNT <= 1)
2715 EMSG(_("E163: There is only one file to edit"));
2716 else if (argn < 0)
2717 EMSG(_("E164: Cannot go before first file"));
2718 else
2719 EMSG(_("E165: Cannot go beyond last file"));
2720 }
2721 else
2722 {
2723 setpcmark();
2724#ifdef FEAT_GUI
2725 need_mouse_correct = TRUE;
2726#endif
2727
2728#ifdef FEAT_WINDOWS
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002729 /* split window or create new tab page first */
2730 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002731 {
2732 if (win_split(0, 0) == FAIL)
2733 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002734 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002735 }
2736 else
2737#endif
2738 {
2739 /*
2740 * if 'hidden' set, only check for changed file when re-editing
2741 * the same buffer
2742 */
2743 other = TRUE;
Bram Moolenaareb44a682017-08-03 22:44:55 +02002744 if (buf_hide(curbuf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745 {
2746 p = fix_fname(alist_name(&ARGLIST[argn]));
2747 other = otherfile(p);
2748 vim_free(p);
2749 }
Bram Moolenaareb44a682017-08-03 22:44:55 +02002750 if ((!buf_hide(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002751 && check_changed(curbuf, CCGD_AW
2752 | (other ? 0 : CCGD_MULTWIN)
2753 | (eap->forceit ? CCGD_FORCEIT : 0)
2754 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 return;
2756 }
2757
2758 curwin->w_arg_idx = argn;
2759 if (argn == ARGCOUNT - 1
2760#ifdef FEAT_WINDOWS
2761 && curwin->w_alist == &global_alist
2762#endif
2763 )
2764 arg_had_last = TRUE;
2765
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002766 /* Edit the file; always use the last known line number.
2767 * When it fails (e.g. Abort for already edited file) restore the
2768 * argument index. */
2769 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 eap, ECMD_LAST,
Bram Moolenaareb44a682017-08-03 22:44:55 +02002771 (buf_hide(curwin->w_buffer) ? ECMD_HIDE : 0)
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002772 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002773 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002774 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002775 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 setmark('\'');
2777 }
2778}
2779
2780/*
2781 * ":next", and commands that behave like it.
2782 */
2783 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002784ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002785{
2786 int i;
2787
2788 /*
2789 * check for changed buffer now, if this fails the argument list is not
2790 * redefined.
2791 */
Bram Moolenaareb44a682017-08-03 22:44:55 +02002792 if ( buf_hide(curbuf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002794 || !check_changed(curbuf, CCGD_AW
2795 | (eap->forceit ? CCGD_FORCEIT : 0)
2796 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 {
2798 if (*eap->arg != NUL) /* redefine file list */
2799 {
2800 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2801 return;
2802 i = 0;
2803 }
2804 else
2805 i = curwin->w_arg_idx + (int)eap->line2;
2806 do_argfile(eap, i);
2807 }
2808}
2809
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002810#if defined(FEAT_LISTCMDS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811/*
2812 * ":argedit"
2813 */
2814 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002815ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816{
Bram Moolenaar90305c62017-07-16 15:31:17 +02002817 int i = eap->addr_count ? (int)eap->line2 : curwin->w_arg_idx + 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002818
Bram Moolenaar90305c62017-07-16 15:31:17 +02002819 if (do_arglist(eap->arg, AL_ADD, i) == FAIL)
2820 return;
2821#ifdef FEAT_TITLE
2822 maketitle();
2823#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002824
Bram Moolenaar90305c62017-07-16 15:31:17 +02002825 if (curwin->w_arg_idx == 0 && (curbuf->b_ml.ml_flags & ML_EMPTY)
2826 && curbuf->b_ffname == NULL)
2827 i = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828 /* Edit the argument. */
Bram Moolenaar90305c62017-07-16 15:31:17 +02002829 if (i < ARGCOUNT)
2830 do_argfile(eap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831}
2832
2833/*
2834 * ":argadd"
2835 */
2836 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002837ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838{
2839 do_arglist(eap->arg, AL_ADD,
2840 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2841#ifdef FEAT_TITLE
2842 maketitle();
2843#endif
2844}
2845
2846/*
2847 * ":argdelete"
2848 */
2849 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002850ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851{
2852 int i;
2853 int n;
2854
2855 if (eap->addr_count > 0)
2856 {
2857 /* ":1,4argdel": Delete all arguments in the range. */
2858 if (eap->line2 > ARGCOUNT)
2859 eap->line2 = ARGCOUNT;
2860 n = eap->line2 - eap->line1 + 1;
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01002861 if (*eap->arg != NUL)
2862 /* Can't have both a range and an argument. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863 EMSG(_(e_invarg));
Bram Moolenaar69a92fb2017-03-09 15:58:30 +01002864 else if (n <= 0)
2865 {
2866 /* Don't give an error for ":%argdel" if the list is empty. */
2867 if (eap->line1 != 1 || eap->line2 != 0)
2868 EMSG(_(e_invrange));
2869 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 else
2871 {
2872 for (i = eap->line1; i <= eap->line2; ++i)
2873 vim_free(ARGLIST[i - 1].ae_fname);
2874 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
2875 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
2876 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 if (curwin->w_arg_idx >= eap->line2)
2878 curwin->w_arg_idx -= n;
2879 else if (curwin->w_arg_idx > eap->line1)
2880 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01002881 if (ARGCOUNT == 0)
2882 curwin->w_arg_idx = 0;
2883 else if (curwin->w_arg_idx >= ARGCOUNT)
2884 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002885 }
2886 }
2887 else if (*eap->arg == NUL)
2888 EMSG(_(e_argreq));
2889 else
2890 do_arglist(eap->arg, AL_DEL, 0);
2891#ifdef FEAT_TITLE
2892 maketitle();
2893#endif
2894}
2895
2896/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002897 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898 */
2899 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002900ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901{
2902 int i;
2903#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002904 win_T *wp;
2905 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906#endif
Bram Moolenaare25bb902015-02-27 20:33:37 +01002907 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002908 int next_fnum = 0;
2909#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
2910 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002912 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002913#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02002914 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002915 int qf_idx;
2916#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002917
2918#ifndef FEAT_WINDOWS
2919 if (eap->cmdidx == CMD_windo)
2920 {
2921 ex_ni(eap);
2922 return;
2923 }
2924#endif
2925
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002926#ifndef FEAT_QUICKFIX
2927 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
2928 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2929 {
2930 ex_ni(eap);
2931 return;
2932 }
2933#endif
2934
Bram Moolenaar071d4272004-06-13 20:20:40 +00002935#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002936 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00002937 /* Don't do syntax HL autocommands. Skipping the syntax file is a
2938 * great speed improvement. */
2939 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02002941#ifdef FEAT_CLIPBOARD
2942 start_global_changes();
2943#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002944
2945 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002946 || eap->cmdidx == CMD_tabdo
Bram Moolenaareb44a682017-08-03 22:44:55 +02002947 || buf_hide(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002948 || !check_changed(curbuf, CCGD_AW
2949 | (eap->forceit ? CCGD_FORCEIT : 0)
2950 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002953 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002954#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002955 wp = firstwin;
2956 tp = first_tabpage;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957#endif
Bram Moolenaara162bc52015-01-07 16:54:21 +01002958 switch (eap->cmdidx)
2959 {
2960#ifdef FEAT_WINDOWS
2961 case CMD_windo:
2962 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
2963 i++;
2964 break;
2965 case CMD_tabdo:
2966 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
2967 i++;
2968 break;
2969#endif
2970 case CMD_argdo:
2971 i = eap->line1 - 1;
2972 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002973 default:
2974 break;
2975 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 /* set pcmark now */
2977 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002978 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01002979 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002980 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01002981 || !buf->b_p_bl); buf = buf->b_next)
2982 if (buf->b_fnum > eap->line2)
2983 {
2984 buf = NULL;
2985 break;
2986 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002987 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01002988 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002989 }
2990#ifdef FEAT_QUICKFIX
2991 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
2992 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2993 {
2994 qf_size = qf_get_size(eap);
2995 if (qf_size <= 0 || eap->line1 > qf_size)
2996 buf = NULL;
2997 else
2998 {
2999 ex_cc(eap);
3000
3001 buf = curbuf;
3002 i = eap->line1 - 1;
3003 if (eap->addr_count <= 0)
3004 /* default is all the quickfix/location list entries */
3005 eap->line2 = qf_size;
3006 }
3007 }
3008#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 else
3010 setpcmark();
3011 listcmd_busy = TRUE; /* avoids setting pcmark below */
3012
Bram Moolenaare25bb902015-02-27 20:33:37 +01003013 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 {
3015 if (eap->cmdidx == CMD_argdo)
3016 {
3017 /* go to argument "i" */
3018 if (i == ARGCOUNT)
3019 break;
3020 /* Don't call do_argfile() when already there, it will try
3021 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003022 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003023 {
3024 /* Clear 'shm' to avoid that the file message overwrites
3025 * any output from the command. */
3026 p_shm_save = vim_strsave(p_shm);
3027 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003029 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3030 vim_free(p_shm_save);
3031 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 if (curwin->w_arg_idx != i)
3033 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 }
3035#ifdef FEAT_WINDOWS
3036 else if (eap->cmdidx == CMD_windo)
3037 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003038 /* go to window "wp" */
3039 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003041 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00003042 if (curwin != wp)
3043 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003044 wp = curwin->w_next;
3045 }
3046 else if (eap->cmdidx == CMD_tabdo)
3047 {
3048 /* go to window "tp" */
3049 if (!valid_tabpage(tp))
3050 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02003051 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003052 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003053 }
3054#endif
3055 else if (eap->cmdidx == CMD_bufdo)
3056 {
3057 /* Remember the number of the next listed buffer, in case
3058 * ":bwipe" is used or autocommands do something strange. */
3059 next_fnum = -1;
3060 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
3061 if (buf->b_p_bl)
3062 {
3063 next_fnum = buf->b_fnum;
3064 break;
3065 }
3066 }
3067
Bram Moolenaara162bc52015-01-07 16:54:21 +01003068 ++i;
3069
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 /* execute the command */
3071 do_cmdline(eap->arg, eap->getline, eap->cookie,
3072 DOCMD_VERBOSE + DOCMD_NOWAIT);
3073
3074 if (eap->cmdidx == CMD_bufdo)
3075 {
3076 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01003077 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003078 break;
3079 /* Check if the buffer still exists. */
Bram Moolenaar29323592016-07-24 22:04:11 +02003080 FOR_ALL_BUFFERS(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003081 if (buf->b_fnum == next_fnum)
3082 break;
3083 if (buf == NULL)
3084 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003085
3086 /* Go to the next buffer. Clear 'shm' to avoid that the file
3087 * message overwrites any output from the command. */
3088 p_shm_save = vim_strsave(p_shm);
3089 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003091 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
3092 vim_free(p_shm_save);
3093
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003094 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003095 if (curbuf->b_fnum != next_fnum)
3096 break;
3097 }
3098
Bram Moolenaaraa23b372015-09-08 18:46:31 +02003099#ifdef FEAT_QUICKFIX
3100 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
3101 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
3102 {
3103 if (i >= qf_size || i >= eap->line2)
3104 break;
3105
3106 qf_idx = qf_get_cur_idx(eap);
3107
3108 ex_cnext(eap);
3109
3110 /* If jumping to the next quickfix entry fails, quit here */
3111 if (qf_get_cur_idx(eap) == qf_idx)
3112 break;
3113 }
3114#endif
3115
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 if (eap->cmdidx == CMD_windo)
3117 {
3118 validate_cursor(); /* cursor may have moved */
3119#ifdef FEAT_SCROLLBIND
3120 /* required when 'scrollbind' has been set */
3121 if (curwin->w_p_scb)
3122 do_check_scrollbind(TRUE);
3123#endif
3124 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01003125
3126#ifdef FEAT_WINDOWS
3127 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
3128 if (i+1 > eap->line2)
3129 break;
3130#endif
3131 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
3132 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 }
3134 listcmd_busy = FALSE;
3135 }
3136
3137#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003138 if (save_ei != NULL)
3139 {
3140 au_event_restore(save_ei);
3141 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
3142 curbuf->b_fname, TRUE, curbuf);
3143 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02003145#ifdef FEAT_CLIPBOARD
3146 end_global_changes();
3147#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148}
3149
3150/*
3151 * Add files[count] to the arglist of the current window after arg "after".
3152 * The file names in files[count] must have been allocated and are taken over.
3153 * Files[] itself is not taken over.
3154 * Returns index of first added argument. Returns -1 when failed (out of mem).
3155 */
3156 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003157alist_add_list(
3158 int count,
3159 char_u **files,
3160 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161{
3162 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003163 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164
3165 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
3166 {
3167 if (after < 0)
3168 after = 0;
3169 if (after > ARGCOUNT)
3170 after = ARGCOUNT;
3171 if (after < ARGCOUNT)
3172 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
3173 (ARGCOUNT - after) * sizeof(aentry_T));
3174 for (i = 0; i < count; ++i)
3175 {
3176 ARGLIST[after + i].ae_fname = files[i];
3177 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
3178 }
3179 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01003180 if (old_argcount > 0 && curwin->w_arg_idx >= after)
3181 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 return after;
3183 }
3184
3185 for (i = 0; i < count; ++i)
3186 vim_free(files[i]);
3187 return -1;
3188}
3189
3190#endif /* FEAT_LISTCMDS */
3191
3192#ifdef FEAT_EVAL
3193/*
3194 * ":compiler[!] {name}"
3195 */
3196 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003197ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003198{
3199 char_u *buf;
3200 char_u *old_cur_comp = NULL;
3201 char_u *p;
3202
3203 if (*eap->arg == NUL)
3204 {
3205 /* List all compiler scripts. */
3206 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3207 /* ) keep the indenter happy... */
3208 }
3209 else
3210 {
3211 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3212 if (buf != NULL)
3213 {
3214 if (eap->forceit)
3215 {
3216 /* ":compiler! {name}" sets global options */
3217 do_cmdline_cmd((char_u *)
3218 "command -nargs=* CompilerSet set <args>");
3219 }
3220 else
3221 {
3222 /* ":compiler! {name}" sets local options.
3223 * To remain backwards compatible "current_compiler" is always
3224 * used. A user's compiler plugin may set it, the distributed
3225 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003226 * "b:current_compiler" and restore "current_compiler".
3227 * Explicitly prepend "g:" to make it work in a function. */
3228 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003229 if (old_cur_comp != NULL)
3230 old_cur_comp = vim_strsave(old_cur_comp);
3231 do_cmdline_cmd((char_u *)
3232 "command -nargs=* CompilerSet setlocal <args>");
3233 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003234 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003235 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236
3237 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003238 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3240 vim_free(buf);
3241
3242 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3243
3244 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003245 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 if (p != NULL)
3247 set_internal_string_var((char_u *)"b:current_compiler", p);
3248
3249 /* Restore "current_compiler" for ":compiler {name}". */
3250 if (!eap->forceit)
3251 {
3252 if (old_cur_comp != NULL)
3253 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003254 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003255 old_cur_comp);
3256 vim_free(old_cur_comp);
3257 }
3258 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003259 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 }
3261 }
3262 }
3263}
3264#endif
3265
3266/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003267 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003268 */
3269 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003270ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003272 char_u *arg = eap->arg;
3273 char_u *p = skiptowhite(arg);
3274 int len = (int)(p - arg);
3275 int flags = eap->forceit ? DIP_ALL : 0;
3276
3277 if (STRNCMP(arg, "START", len) == 0)
3278 {
3279 flags += DIP_START + DIP_NORTP;
3280 arg = skipwhite(arg + len);
3281 }
3282 else if (STRNCMP(arg, "OPT", len) == 0)
3283 {
3284 flags += DIP_OPT + DIP_NORTP;
3285 arg = skipwhite(arg + len);
3286 }
3287 else if (STRNCMP(arg, "PACK", len) == 0)
3288 {
3289 flags += DIP_START + DIP_OPT + DIP_NORTP;
3290 arg = skipwhite(arg + len);
3291 }
3292 else if (STRNCMP(arg, "ALL", len) == 0)
3293 {
3294 flags += DIP_START + DIP_OPT;
3295 arg = skipwhite(arg + len);
3296 }
3297
3298 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299}
3300
Bram Moolenaar071d4272004-06-13 20:20:40 +00003301 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003302source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003304 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305}
3306
3307/*
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003308 * Find the file "name" in all directories in "path" and invoke
3309 * "callback(fname, cookie)".
3310 * "name" can contain wildcards.
3311 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3312 * When "flags" has DIP_DIR: find directories instead of files.
3313 * When "flags" has DIP_ERR: give an error message if there is no match.
3314 *
3315 * return FAIL when no file could be sourced, OK otherwise.
3316 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003317 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003318do_in_path(
3319 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003320 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003321 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003322 void (*callback)(char_u *fname, void *ck),
3323 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003324{
3325 char_u *rtp;
3326 char_u *np;
3327 char_u *buf;
3328 char_u *rtp_copy;
3329 char_u *tail;
3330 int num_files;
3331 char_u **files;
3332 int i;
3333 int did_one = FALSE;
3334#ifdef AMIGA
3335 struct Process *proc = (struct Process *)FindTask(0L);
3336 APTR save_winptr = proc->pr_WindowPtr;
3337
3338 /* Avoid a requester here for a volume that doesn't exist. */
3339 proc->pr_WindowPtr = (APTR)-1L;
3340#endif
3341
3342 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3343 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003344 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 buf = alloc(MAXPATHL);
3346 if (buf != NULL && rtp_copy != NULL)
3347 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003348 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003349 {
3350 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003351 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003352 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003353 verbose_leave();
3354 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003355
Bram Moolenaar071d4272004-06-13 20:20:40 +00003356 /* Loop over all entries in 'runtimepath'. */
3357 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003358 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003359 {
Bram Moolenaar66459b72016-08-06 19:01:55 +02003360 size_t buflen;
3361
Bram Moolenaar071d4272004-06-13 20:20:40 +00003362 /* Copy the path from 'runtimepath' to buf[]. */
3363 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaar66459b72016-08-06 19:01:55 +02003364 buflen = STRLEN(buf);
3365
3366 /* Skip after or non-after directories. */
3367 if (flags & (DIP_NOAFTER | DIP_AFTER))
3368 {
3369 int is_after = buflen >= 5
3370 && STRCMP(buf + buflen - 5, "after") == 0;
3371
3372 if ((is_after && (flags & DIP_NOAFTER))
3373 || (!is_after && (flags & DIP_AFTER)))
3374 continue;
3375 }
3376
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003377 if (name == NULL)
3378 {
3379 (*callback)(buf, (void *) &cookie);
3380 if (!did_one)
3381 did_one = (cookie == NULL);
3382 }
Bram Moolenaar66459b72016-08-06 19:01:55 +02003383 else if (buflen + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 {
3385 add_pathsep(buf);
3386 tail = buf + STRLEN(buf);
3387
3388 /* Loop over all patterns in "name" */
3389 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003390 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 {
3392 /* Append the pattern from "name" to buf[]. */
3393 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3394 "\t ");
3395
3396 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003397 {
3398 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003399 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003400 verbose_leave();
3401 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402
3403 /* Expand wildcards, invoke the callback for each match. */
3404 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003405 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003406 {
3407 for (i = 0; i < num_files; ++i)
3408 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003409 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003410 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003411 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 break;
3413 }
3414 FreeWild(num_files, files);
3415 }
3416 }
3417 }
3418 }
3419 }
3420 vim_free(buf);
3421 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003422 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003423 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003424 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3425
3426 if (flags & DIP_ERR)
3427 EMSG3(_(e_dirnotf), basepath, name);
3428 else if (p_verbose > 0)
3429 {
3430 verbose_enter();
3431 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3432 verbose_leave();
3433 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003434 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435
3436#ifdef AMIGA
3437 proc->pr_WindowPtr = save_winptr;
3438#endif
3439
3440 return did_one ? OK : FAIL;
3441}
3442
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003443/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003444 * Find "name" in "path". When found, invoke the callback function for
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003445 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003446 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3447 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003448 * Returns OK when at least one match found, FAIL otherwise.
3449 *
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003450 * If "name" is NULL calls callback for each entry in "path". Cookie is
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003451 * passed by reference in this case, setting it to NULL indicates that callback
3452 * has done its job.
3453 */
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003454 static int
3455do_in_path_and_pp(
3456 char_u *path,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003457 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003458 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003459 void (*callback)(char_u *fname, void *ck),
3460 void *cookie)
3461{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003462 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003463 char_u *s;
3464 int len;
3465 char *start_dir = "pack/*/start/*/%s";
3466 char *opt_dir = "pack/*/opt/*/%s";
3467
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003468 if ((flags & DIP_NORTP) == 0)
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003469 done = do_in_path(path, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003470
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003471 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003472 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003473 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003474 s = alloc(len);
3475 if (s == NULL)
3476 return FAIL;
3477 vim_snprintf((char *)s, len, start_dir, name);
3478 done = do_in_path(p_pp, s, flags, callback, cookie);
3479 vim_free(s);
3480 }
3481
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003482 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003483 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003484 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003485 s = alloc(len);
3486 if (s == NULL)
3487 return FAIL;
3488 vim_snprintf((char *)s, len, opt_dir, name);
3489 done = do_in_path(p_pp, s, flags, callback, cookie);
3490 vim_free(s);
3491 }
3492
3493 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003494}
3495
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003496/*
Bram Moolenaar07ecfa62017-06-27 14:43:55 +02003497 * Just like do_in_path_and_pp(), using 'runtimepath' for "path".
3498 */
3499 int
3500do_in_runtimepath(
3501 char_u *name,
3502 int flags,
3503 void (*callback)(char_u *fname, void *ck),
3504 void *cookie)
3505{
3506 return do_in_path_and_pp(p_rtp, name, flags, callback, cookie);
3507}
3508
3509/*
3510 * Source the file "name" from all directories in 'runtimepath'.
3511 * "name" can contain wildcards.
3512 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3513 *
3514 * return FAIL when no file could be sourced, OK otherwise.
3515 */
3516 int
3517source_runtime(char_u *name, int flags)
3518{
3519 return source_in_path(p_rtp, name, flags);
3520}
3521
3522/*
3523 * Just like source_runtime(), but use "path" instead of 'runtimepath'.
3524 */
3525 int
3526source_in_path(char_u *path, char_u *name, int flags)
3527{
3528 return do_in_path_and_pp(path, name, flags, source_callback, NULL);
3529}
3530
3531
3532/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003533 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003534 */
3535 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003536source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003537{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003538 int num_files;
3539 char_u **files;
3540 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003541
Bram Moolenaarf3654822016-03-04 22:12:23 +01003542 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003543 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003544 for (i = 0; i < num_files; ++i)
3545 (void)do_source(files[i], FALSE, DOSO_NONE);
3546 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003547 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003548}
3549
Bram Moolenaar49b27322016-04-05 21:13:00 +02003550/* used for "cookie" of add_pack_plugin() */
3551static int APP_ADD_DIR;
3552static int APP_LOAD;
3553static int APP_BOTH;
3554
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003555 static void
Bram Moolenaar91715872016-03-03 17:13:03 +01003556add_pack_plugin(char_u *fname, void *cookie)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003557{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003558 char_u *p4, *p3, *p2, *p1, *p;
3559 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003560 int c;
3561 char_u *new_rtp;
3562 int keep;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003563 size_t oldlen;
3564 size_t addlen;
Bram Moolenaara5702442016-05-24 19:37:29 +02003565 char_u *afterdir;
Bram Moolenaarb0550662016-05-31 21:37:36 +02003566 size_t afterlen = 0;
Bram Moolenaar91715872016-03-03 17:13:03 +01003567 char_u *ffname = fix_fname(fname);
Bram Moolenaarfef524b2016-07-02 22:07:22 +02003568 size_t fname_len;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003569 char_u *buf = NULL;
3570 char_u *rtp_ffname;
3571 int match;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003572
Bram Moolenaar91715872016-03-03 17:13:03 +01003573 if (ffname == NULL)
3574 return;
Bram Moolenaar49b27322016-04-05 21:13:00 +02003575 if (cookie != &APP_LOAD && strstr((char *)p_rtp, (char *)ffname) == NULL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003576 {
Bram Moolenaara5702442016-05-24 19:37:29 +02003577 /* directory is not yet in 'runtimepath', add it */
Bram Moolenaarf3654822016-03-04 22:12:23 +01003578 p4 = p3 = p2 = p1 = get_past_head(ffname);
Bram Moolenaar91acfff2017-03-12 19:22:36 +01003579 for (p = p1; *p; MB_PTR_ADV(p))
Bram Moolenaarf3654822016-03-04 22:12:23 +01003580 if (vim_ispathsep_nocolon(*p))
3581 {
3582 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3583 }
3584
3585 /* now we have:
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +01003586 * rtp/pack/name/start/name
3587 * p4 p3 p2 p1
Bram Moolenaarf3654822016-03-04 22:12:23 +01003588 *
3589 * find the part up to "pack" in 'runtimepath' */
3590 c = *p4;
3591 *p4 = NUL;
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003592
3593 /* Find "ffname" in "p_rtp", ignoring '/' vs '\' differences. */
3594 fname_len = STRLEN(ffname);
3595 insp = p_rtp;
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003596 buf = alloc(MAXPATHL);
3597 if (buf == NULL)
3598 goto theend;
3599 while (*insp != NUL)
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003600 {
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003601 copy_option_part(&insp, buf, MAXPATHL, ",");
3602 add_pathsep(buf);
3603 rtp_ffname = fix_fname(buf);
3604 if (rtp_ffname == NULL)
3605 goto theend;
3606 match = vim_fnamencmp(rtp_ffname, ffname, fname_len) == 0;
3607 vim_free(rtp_ffname);
3608 if (match)
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003609 break;
Bram Moolenaar4c5717e2016-07-01 15:39:40 +02003610 }
3611
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003612 if (*insp == NUL)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003613 /* not found, append at the end */
3614 insp = p_rtp + STRLEN(p_rtp);
3615 else
Bram Moolenaarf3654822016-03-04 22:12:23 +01003616 /* append after the matching directory. */
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003617 --insp;
Bram Moolenaarf3654822016-03-04 22:12:23 +01003618 *p4 = c;
3619
Bram Moolenaara5702442016-05-24 19:37:29 +02003620 /* check if rtp/pack/name/start/name/after exists */
3621 afterdir = concat_fnames(ffname, (char_u *)"after", TRUE);
3622 if (afterdir != NULL && mch_isdir(afterdir))
3623 afterlen = STRLEN(afterdir) + 1; /* add one for comma */
3624
Bram Moolenaarb0550662016-05-31 21:37:36 +02003625 oldlen = STRLEN(p_rtp);
3626 addlen = STRLEN(ffname) + 1; /* add one for comma */
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003627 new_rtp = alloc((int)(oldlen + addlen + afterlen + 1));
3628 /* add one for NUL */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003629 if (new_rtp == NULL)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003630 goto theend;
3631 keep = (int)(insp - p_rtp);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003632 mch_memmove(new_rtp, p_rtp, keep);
3633 new_rtp[keep] = ',';
Bram Moolenaara5702442016-05-24 19:37:29 +02003634 mch_memmove(new_rtp + keep + 1, ffname, addlen);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003635 if (p_rtp[keep] != NUL)
Bram Moolenaara5702442016-05-24 19:37:29 +02003636 mch_memmove(new_rtp + keep + addlen, p_rtp + keep,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003637 oldlen - keep + 1);
Bram Moolenaara5702442016-05-24 19:37:29 +02003638 if (afterlen > 0)
3639 {
3640 STRCAT(new_rtp, ",");
3641 STRCAT(new_rtp, afterdir);
3642 }
Bram Moolenaar863c1a92016-03-03 15:47:06 +01003643 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3644 vim_free(new_rtp);
Bram Moolenaara5702442016-05-24 19:37:29 +02003645 vim_free(afterdir);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003646 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003647
Bram Moolenaar49b27322016-04-05 21:13:00 +02003648 if (cookie != &APP_ADD_DIR)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003649 {
Bram Moolenaar71fb0c12016-04-02 22:44:16 +02003650 static char *plugpat = "%s/plugin/**/*.vim";
Bram Moolenaarf3654822016-03-04 22:12:23 +01003651 static char *ftpat = "%s/ftdetect/*.vim";
3652 int len;
3653 char_u *pat;
3654
3655 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3656 pat = alloc(len);
3657 if (pat == NULL)
3658 goto theend;
3659 vim_snprintf((char *)pat, len, plugpat, ffname);
3660 source_all_matches(pat);
3661
3662#ifdef FEAT_AUTOCMD
3663 {
3664 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3665
3666 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3667 * found when it loads. */
3668 if (cmd != NULL && eval_to_number(cmd) > 0)
3669 {
3670 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3671 vim_snprintf((char *)pat, len, ftpat, ffname);
3672 source_all_matches(pat);
3673 do_cmdline_cmd((char_u *)"augroup END");
3674 }
3675 vim_free(cmd);
3676 }
3677#endif
Bram Moolenaarba8cd122016-03-19 14:16:39 +01003678 vim_free(pat);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003679 }
3680
3681theend:
Bram Moolenaar2f9e5752017-02-05 16:07:54 +01003682 vim_free(buf);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003683 vim_free(ffname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003684}
3685
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003686/*
3687 * Add all packages in the "start" directory to 'runtimepath'.
3688 */
3689 void
3690add_pack_start_dirs(void)
3691{
3692 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3693 add_pack_plugin, &APP_ADD_DIR);
3694}
3695
3696/*
3697 * Load plugins from all packages in the "start" directory.
3698 */
3699 void
3700load_start_packages(void)
3701{
3702 did_source_packages = TRUE;
3703 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
3704 add_pack_plugin, &APP_LOAD);
3705}
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003706
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003707/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003708 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003709 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003710 */
3711 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003712ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003713{
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003714 if (!did_source_packages || eap->forceit)
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003715 {
Bram Moolenaar49b27322016-04-05 21:13:00 +02003716 /* First do a round to add all directories to 'runtimepath', then load
3717 * the plugins. This allows for plugins to use an autoload directory
3718 * of another plugin. */
Bram Moolenaarce876aa2017-06-04 17:47:42 +02003719 add_pack_start_dirs();
3720 load_start_packages();
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003721 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003722}
3723
3724/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003725 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003726 */
3727 void
3728ex_packadd(exarg_T *eap)
3729{
3730 static char *plugpat = "pack/*/opt/%s";
3731 int len;
3732 char *pat;
3733
3734 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg);
3735 pat = (char *)alloc(len);
3736 if (pat == NULL)
3737 return;
3738 vim_snprintf(pat, len, plugpat, eap->arg);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003739 do_in_path(p_pp, (char_u *)pat, DIP_ALL + DIP_DIR + DIP_ERR,
Bram Moolenaar49b27322016-04-05 21:13:00 +02003740 add_pack_plugin, eap->forceit ? &APP_ADD_DIR : &APP_BOTH);
Bram Moolenaar91715872016-03-03 17:13:03 +01003741 vim_free(pat);
3742}
3743
Bram Moolenaar071d4272004-06-13 20:20:40 +00003744#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
3745/*
3746 * ":options"
3747 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003749ex_options(
3750 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751{
Bram Moolenaarab6c8582017-08-11 17:15:09 +02003752 vim_setenv((char_u *)"OPTWIN_CMD", (char_u *)(cmdmod.tab ? "tab" : ""));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003753 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3754}
3755#endif
3756
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01003757#if defined(FEAT_PYTHON3) || defined(FEAT_PYTHON) || defined(PROTO)
3758
3759# if (defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)) || defined(PROTO)
3760/*
3761 * Detect Python 3 or 2, and initialize 'pyxversion'.
3762 */
3763 void
3764init_pyxversion(void)
3765{
3766 if (p_pyx == 0)
3767 {
3768 if (python3_enabled(FALSE))
3769 p_pyx = 3;
3770 else if (python_enabled(FALSE))
3771 p_pyx = 2;
3772 }
3773}
3774# endif
3775
3776/*
3777 * Does a file contain one of the following strings at the beginning of any
3778 * line?
3779 * "#!(any string)python2" => returns 2
3780 * "#!(any string)python3" => returns 3
3781 * "# requires python 2.x" => returns 2
3782 * "# requires python 3.x" => returns 3
3783 * otherwise return 0.
3784 */
3785 static int
3786requires_py_version(char_u *filename)
3787{
3788 FILE *file;
3789 int requires_py_version = 0;
3790 int i, lines;
3791
3792 lines = (int)p_mls;
3793 if (lines < 0)
3794 lines = 5;
3795
3796 file = mch_fopen((char *)filename, "r");
3797 if (file != NULL)
3798 {
3799 for (i = 0; i < lines; i++)
3800 {
3801 if (vim_fgets(IObuff, IOSIZE, file))
3802 break;
3803 if (i == 0 && IObuff[0] == '#' && IObuff[1] == '!')
3804 {
3805 /* Check shebang. */
3806 if (strstr((char *)IObuff + 2, "python2") != NULL)
3807 {
3808 requires_py_version = 2;
3809 break;
3810 }
3811 if (strstr((char *)IObuff + 2, "python3") != NULL)
3812 {
3813 requires_py_version = 3;
3814 break;
3815 }
3816 }
3817 IObuff[21] = '\0';
3818 if (STRCMP("# requires python 2.x", IObuff) == 0)
3819 {
3820 requires_py_version = 2;
3821 break;
3822 }
3823 if (STRCMP("# requires python 3.x", IObuff) == 0)
3824 {
3825 requires_py_version = 3;
3826 break;
3827 }
3828 }
3829 fclose(file);
3830 }
3831 return requires_py_version;
3832}
3833
3834
3835/*
3836 * Source a python file using the requested python version.
3837 */
3838 static void
3839source_pyx_file(exarg_T *eap, char_u *fname)
3840{
3841 exarg_T ex;
3842 int v = requires_py_version(fname);
3843
3844# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
3845 init_pyxversion();
3846# endif
3847 if (v == 0)
3848 {
3849# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
3850 /* user didn't choose a preference, 'pyx' is used */
3851 v = p_pyx;
3852# elif defined(FEAT_PYTHON)
3853 v = 2;
3854# elif defined(FEAT_PYTHON3)
3855 v = 3;
3856# endif
3857 }
3858
3859 /*
3860 * now source, if required python version is not supported show
3861 * unobtrusive message.
3862 */
3863 if (eap == NULL)
3864 vim_memset(&ex, 0, sizeof(ex));
3865 else
3866 ex = *eap;
3867 ex.arg = fname;
3868 ex.cmd = (char_u *)(v == 2 ? "pyfile" : "pyfile3");
3869
3870 if (v == 2)
3871 {
3872# ifdef FEAT_PYTHON
3873 ex_pyfile(&ex);
3874# else
3875 vim_snprintf((char *)IObuff, IOSIZE,
3876 _("W20: Required python version 2.x not supported, ignoring file: %s"),
3877 fname);
3878 MSG(IObuff);
3879# endif
3880 return;
3881 }
3882 else
3883 {
3884# ifdef FEAT_PYTHON3
3885 ex_py3file(&ex);
3886# else
3887 vim_snprintf((char *)IObuff, IOSIZE,
3888 _("W21: Required python version 3.x not supported, ignoring file: %s"),
3889 fname);
3890 MSG(IObuff);
3891# endif
3892 return;
3893 }
3894}
3895
3896/*
3897 * ":pyxfile {fname}"
3898 */
3899 void
3900ex_pyxfile(exarg_T *eap)
3901{
3902 source_pyx_file(eap, eap->arg);
3903}
3904
3905/*
3906 * ":pyx"
3907 */
3908 void
3909ex_pyx(exarg_T *eap)
3910{
3911# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
3912 init_pyxversion();
3913 if (p_pyx == 2)
3914 ex_python(eap);
3915 else
3916 ex_py3(eap);
3917# elif defined(FEAT_PYTHON)
3918 ex_python(eap);
3919# elif defined(FEAT_PYTHON3)
3920 ex_py3(eap);
3921# endif
3922}
3923
3924/*
3925 * ":pyxdo"
3926 */
3927 void
3928ex_pyxdo(exarg_T *eap)
3929{
3930# if defined(FEAT_PYTHON) && defined(FEAT_PYTHON3)
3931 init_pyxversion();
3932 if (p_pyx == 2)
3933 ex_pydo(eap);
3934 else
3935 ex_py3do(eap);
3936# elif defined(FEAT_PYTHON)
3937 ex_pydo(eap);
3938# elif defined(FEAT_PYTHON3)
3939 ex_py3do(eap);
3940# endif
3941}
3942
3943#endif
3944
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945/*
3946 * ":source {fname}"
3947 */
3948 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003949ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950{
3951#ifdef FEAT_BROWSE
3952 if (cmdmod.browse)
3953 {
3954 char_u *fname = NULL;
3955
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003956 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
3958 if (fname != NULL)
3959 {
3960 cmd_source(fname, eap);
3961 vim_free(fname);
3962 }
3963 }
3964 else
3965#endif
3966 cmd_source(eap->arg, eap);
3967}
3968
3969 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003970cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971{
3972 if (*fname == NUL)
3973 EMSG(_(e_argreq));
3974
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02003976 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003977 * Need to execute the commands directly. This is required at least
3978 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003979 * - ":g" command busy
3980 * - after ":argdo", ":windo" or ":bufdo"
3981 * - another command follows
3982 * - inside a loop
3983 */
3984 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
3985#ifdef FEAT_EVAL
3986 || eap->cstack->cs_idx >= 0
3987#endif
3988 );
3989
3990 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003991 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 EMSG2(_(e_notopen), fname);
3993}
3994
3995/*
3996 * ":source" and associated commands.
3997 */
3998/*
3999 * Structure used to store info for each sourced file.
4000 * It is shared between do_source() and getsourceline().
4001 * This is required, because it needs to be handed to do_cmdline() and
4002 * sourcing can be done recursively.
4003 */
4004struct source_cookie
4005{
4006 FILE *fp; /* opened file for sourcing */
4007 char_u *nextline; /* if not NULL: line that was read ahead */
4008 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02004009#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
4011 int error; /* TRUE if LF found after CR-LF */
4012#endif
4013#ifdef FEAT_EVAL
4014 linenr_T breakpoint; /* next line with breakpoint or zero */
4015 char_u *fname; /* name of sourced file */
4016 int dbg_tick; /* debug_tick when breakpoint was set */
4017 int level; /* top nesting level of sourced file */
4018#endif
4019#ifdef FEAT_MBYTE
4020 vimconv_T conv; /* type of conversion */
4021#endif
4022};
4023
4024#ifdef FEAT_EVAL
4025/*
4026 * Return the address holding the next breakpoint line for a source cookie.
4027 */
4028 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004029source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030{
4031 return &((struct source_cookie *)cookie)->breakpoint;
4032}
4033
4034/*
4035 * Return the address holding the debug tick for a source cookie.
4036 */
4037 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004038source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039{
4040 return &((struct source_cookie *)cookie)->dbg_tick;
4041}
4042
4043/*
4044 * Return the nesting level for a source cookie.
4045 */
4046 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004047source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048{
4049 return ((struct source_cookie *)cookie)->level;
4050}
4051#endif
4052
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004053static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004054
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004055#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
4056# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004057static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058
4059/*
4060 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004061 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 */
4063 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004064fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004065{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004066# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01004067 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
4068# else
4069 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004070# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004071
4072 if (fd_tmp == -1)
4073 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004074
4075# ifdef HAVE_FD_CLOEXEC
4076 {
4077 int fdflags = fcntl(fd_tmp, F_GETFD);
4078 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02004079 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004080 }
4081# endif
4082
Bram Moolenaar071d4272004-06-13 20:20:40 +00004083 return fdopen(fd_tmp, READBIN);
4084}
4085#endif
4086
4087
4088/*
4089 * do_source: Read the file "fname" and execute its lines as EX commands.
4090 *
4091 * This function may be called recursively!
4092 *
4093 * return FAIL if file could not be opened, OK otherwise
4094 */
4095 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004096do_source(
4097 char_u *fname,
4098 int check_other, /* check for .vimrc and _vimrc */
4099 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100{
4101 struct source_cookie cookie;
4102 char_u *save_sourcing_name;
4103 linenr_T save_sourcing_lnum;
4104 char_u *p;
4105 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00004106 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004107 int retval = FAIL;
4108#ifdef FEAT_EVAL
4109 scid_T save_current_SID;
4110 static scid_T last_current_SID = 0;
4111 void *save_funccalp;
4112 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004113 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004114# ifdef UNIX
Bram Moolenaar8767f522016-07-01 17:17:39 +02004115 stat_T st;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004116 int stat_ok;
4117# endif
4118#endif
4119#ifdef STARTUPTIME
4120 struct timeval tv_rel;
4121 struct timeval tv_start;
4122#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004123#ifdef FEAT_PROFILE
4124 proftime_T wait_start;
4125#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004126
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 if (p == NULL)
4129 return retval;
4130 fname_exp = fix_fname(p);
4131 vim_free(p);
4132 if (fname_exp == NULL)
4133 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004134 if (mch_isdir(fname_exp))
4135 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00004136 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004137 goto theend;
4138 }
4139
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004140#ifdef FEAT_AUTOCMD
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004141 /* Apply SourceCmd autocommands, they should get the file and source it. */
4142 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
4143 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
4144 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004145 {
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004146# ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004147 retval = aborting() ? FAIL : OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004148# else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004149 retval = OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004150# endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00004151 goto theend;
4152 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00004153
4154 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00004155 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
4156#endif
4157
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004158#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004159 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4160#else
4161 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4162#endif
4163 if (cookie.fp == NULL && check_other)
4164 {
4165 /*
4166 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
4167 * and ".exrc" by "_exrc" or vice versa.
4168 */
4169 p = gettail(fname_exp);
4170 if ((*p == '.' || *p == '_')
4171 && (STRICMP(p + 1, "vimrc") == 0
4172 || STRICMP(p + 1, "gvimrc") == 0
4173 || STRICMP(p + 1, "exrc") == 0))
4174 {
4175 if (*p == '_')
4176 *p = '.';
4177 else
4178 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01004179#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
4181#else
4182 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
4183#endif
4184 }
4185 }
4186
4187 if (cookie.fp == NULL)
4188 {
4189 if (p_verbose > 0)
4190 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004191 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004193 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 else
4195 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004196 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004197 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 }
4199 goto theend;
4200 }
4201
4202 /*
4203 * The file exists.
4204 * - In verbose mode, give a message.
4205 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
4206 */
4207 if (p_verbose > 1)
4208 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004209 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004210 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004211 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004212 else
4213 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00004214 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004215 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004217 if (is_vimrc == DOSO_VIMRC)
4218 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
4219 else if (is_vimrc == DOSO_GVIMRC)
4220 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004221
4222#ifdef USE_CRNL
4223 /* If no automatic file format: Set default to CR-NL. */
4224 if (*p_ffs == NUL)
4225 cookie.fileformat = EOL_DOS;
4226 else
4227 cookie.fileformat = EOL_UNKNOWN;
4228 cookie.error = FALSE;
4229#endif
4230
4231#ifdef USE_CR
4232 /* If no automatic file format: Set default to CR. */
4233 if (*p_ffs == NUL)
4234 cookie.fileformat = EOL_MAC;
4235 else
4236 cookie.fileformat = EOL_UNKNOWN;
4237 cookie.error = FALSE;
4238#endif
4239
4240 cookie.nextline = NULL;
4241 cookie.finished = FALSE;
4242
4243#ifdef FEAT_EVAL
4244 /*
4245 * Check if this script has a breakpoint.
4246 */
4247 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
4248 cookie.fname = fname_exp;
4249 cookie.dbg_tick = debug_tick;
4250
4251 cookie.level = ex_nesting_level;
4252#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253
4254 /*
4255 * Keep the sourcing name/lnum, for recursive calls.
4256 */
4257 save_sourcing_name = sourcing_name;
4258 sourcing_name = fname_exp;
4259 save_sourcing_lnum = sourcing_lnum;
4260 sourcing_lnum = 0;
4261
Bram Moolenaar73881402009-02-04 16:50:47 +00004262#ifdef FEAT_MBYTE
4263 cookie.conv.vc_type = CONV_NONE; /* no conversion */
4264
4265 /* Read the first line so we can check for a UTF-8 BOM. */
4266 firstline = getsourceline(0, (void *)&cookie, 0);
4267 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
4268 && firstline[1] == 0xbb && firstline[2] == 0xbf)
4269 {
4270 /* Found BOM; setup conversion, skip over BOM and recode the line. */
4271 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
4272 p = string_convert(&cookie.conv, firstline + 3, NULL);
Bram Moolenaar4e2a5952009-02-05 19:48:25 +00004273 if (p == NULL)
4274 p = vim_strsave(firstline + 3);
Bram Moolenaar73881402009-02-04 16:50:47 +00004275 if (p != NULL)
4276 {
4277 vim_free(firstline);
4278 firstline = p;
4279 }
4280 }
4281#endif
4282
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004284 if (time_fd != NULL)
4285 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004286#endif
4287
4288#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00004289# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004290 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004291 prof_child_enter(&wait_start); /* entering a child now */
4292# endif
4293
4294 /* Don't use local function variables, if called from a function.
4295 * Also starts profiling timer for nested script. */
4296 save_funccalp = save_funccal();
4297
Bram Moolenaar071d4272004-06-13 20:20:40 +00004298 /*
4299 * Check if this script was sourced before to finds its SID.
4300 * If it's new, generate a new SID.
4301 */
4302 save_current_SID = current_SID;
4303# ifdef UNIX
4304 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
4305# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004306 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
4307 {
4308 si = &SCRIPT_ITEM(current_SID);
4309 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 && (
4311# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00004312 /* Compare dev/ino when possible, it catches symbolic
4313 * links. Also compare file names, the inode may change
4314 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004315 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004316 && (si->sn_dev == st.st_dev
4317 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00004319 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004321 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 if (current_SID == 0)
4323 {
4324 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004325 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
4326 == FAIL)
4327 goto almosttheend;
4328 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00004330 ++script_items.ga_len;
4331 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
4332# ifdef FEAT_PROFILE
4333 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004334# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004336 si = &SCRIPT_ITEM(current_SID);
4337 si->sn_name = fname_exp;
4338 fname_exp = NULL;
4339# ifdef UNIX
4340 if (stat_ok)
4341 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004342 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004343 si->sn_dev = st.st_dev;
4344 si->sn_ino = st.st_ino;
4345 }
4346 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00004347 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004348# endif
4349
Bram Moolenaar071d4272004-06-13 20:20:40 +00004350 /* Allocate the local script variables to use for this script. */
4351 new_script_vars(current_SID);
4352 }
4353
Bram Moolenaar05159a02005-02-26 23:04:13 +00004354# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004355 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004356 {
4357 int forceit;
4358
4359 /* Check if we do profiling for this script. */
4360 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
4361 {
4362 script_do_profile(si);
4363 si->sn_pr_force = forceit;
4364 }
4365 if (si->sn_prof_on)
4366 {
4367 ++si->sn_pr_count;
4368 profile_start(&si->sn_pr_start);
4369 profile_zero(&si->sn_pr_children);
4370 }
4371 }
4372# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004373#endif
4374
4375 /*
4376 * Call do_cmdline, which will call getsourceline() to get the lines.
4377 */
Bram Moolenaar73881402009-02-04 16:50:47 +00004378 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00004381
4382#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004383 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004384 {
4385 /* Get "si" again, "script_items" may have been reallocated. */
4386 si = &SCRIPT_ITEM(current_SID);
4387 if (si->sn_prof_on)
4388 {
4389 profile_end(&si->sn_pr_start);
4390 profile_sub_wait(&wait_start, &si->sn_pr_start);
4391 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004392 profile_self(&si->sn_pr_self, &si->sn_pr_start,
4393 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004394 }
4395 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396#endif
4397
4398 if (got_int)
4399 EMSG(_(e_interr));
4400 sourcing_name = save_sourcing_name;
4401 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004402 if (p_verbose > 1)
4403 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004404 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00004405 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00004407 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00004408 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00004409 }
4410#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01004411 if (time_fd != NULL)
4412 {
4413 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
4414 time_msg((char *)IObuff, &tv_start);
4415 time_pop(&tv_rel);
4416 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004417#endif
4418
4419#ifdef FEAT_EVAL
4420 /*
4421 * After a "finish" in debug mode, need to break at first command of next
4422 * sourced file.
4423 */
4424 if (save_debug_break_level > ex_nesting_level
4425 && debug_break_level == ex_nesting_level)
4426 ++debug_break_level;
4427#endif
4428
Bram Moolenaar05159a02005-02-26 23:04:13 +00004429#ifdef FEAT_EVAL
4430almosttheend:
4431 current_SID = save_current_SID;
4432 restore_funccal(save_funccalp);
4433# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004434 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004435 prof_child_exit(&wait_start); /* leaving a child now */
4436# endif
4437#endif
4438 fclose(cookie.fp);
4439 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00004440 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004441#ifdef FEAT_MBYTE
4442 convert_setup(&cookie.conv, NULL, NULL);
4443#endif
4444
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445theend:
4446 vim_free(fname_exp);
4447 return retval;
4448}
4449
4450#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004451
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452/*
4453 * ":scriptnames"
4454 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004456ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004457{
4458 int i;
4459
Bram Moolenaar05159a02005-02-26 23:04:13 +00004460 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
4461 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02004462 {
4463 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
4464 NameBuff, MAXPATHL, TRUE);
4465 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01004466 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004467}
4468
4469# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
4470/*
4471 * Fix slashes in the list of script names for 'shellslash'.
4472 */
4473 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004474scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004475{
4476 int i;
4477
Bram Moolenaar05159a02005-02-26 23:04:13 +00004478 for (i = 1; i <= script_items.ga_len; ++i)
4479 if (SCRIPT_ITEM(i).sn_name != NULL)
4480 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481}
4482# endif
4483
4484/*
4485 * Get a pointer to a script name. Used for ":verbose set".
4486 */
4487 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004488get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489{
4490 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004491 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004493 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004495 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004496 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004497 return (char_u *)_("environment variable");
4498 if (id == SID_ERROR)
4499 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004500 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004501}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004502
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004503# if defined(EXITFREE) || defined(PROTO)
4504 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004505free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004506{
4507 int i;
4508
4509 for (i = script_items.ga_len; i > 0; --i)
4510 vim_free(SCRIPT_ITEM(i).sn_name);
4511 ga_clear(&script_items);
4512}
4513# endif
4514
Bram Moolenaar071d4272004-06-13 20:20:40 +00004515#endif
4516
4517#if defined(USE_CR) || defined(PROTO)
4518
4519# if defined(__MSL__) && (__MSL__ >= 22)
4520/*
4521 * Newer version of the Metrowerks library handle DOS and UNIX files
4522 * without help.
4523 * Test with earlier versions, MSL 2.2 is the library supplied with
4524 * Codewarrior Pro 2.
4525 */
4526 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004527fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528{
4529 return fgets(s, n, stream);
4530}
4531# else
4532/*
4533 * Version of fgets() which also works for lines ending in a <CR> only
4534 * (Macintosh format).
4535 * For older versions of the Metrowerks library.
4536 * At least CodeWarrior 9 needed this code.
4537 */
4538 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004539fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540{
4541 int c = 0;
4542 int char_read = 0;
4543
4544 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4545 {
4546 c = fgetc(stream);
4547 s[char_read++] = c;
4548 /* If the file is in DOS format, we need to skip a NL after a CR. I
4549 * thought it was the other way around, but this appears to work... */
4550 if (c == '\n')
4551 {
4552 c = fgetc(stream);
4553 if (c != '\r')
4554 ungetc(c, stream);
4555 }
4556 }
4557
4558 s[char_read] = 0;
4559 if (char_read == 0)
4560 return NULL;
4561
4562 if (feof(stream) && char_read == 1)
4563 return NULL;
4564
4565 return s;
4566}
4567# endif
4568#endif
4569
4570/*
4571 * Get one full line from a sourced file.
4572 * Called by do_cmdline() when it's called from do_source().
4573 *
4574 * Return a pointer to the line in allocated memory.
4575 * Return NULL for end-of-file or some error.
4576 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004578getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579{
4580 struct source_cookie *sp = (struct source_cookie *)cookie;
4581 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004582 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583
4584#ifdef FEAT_EVAL
4585 /* If breakpoints have been added/deleted need to check for it. */
4586 if (sp->dbg_tick < debug_tick)
4587 {
4588 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4589 sp->dbg_tick = debug_tick;
4590 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004591# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004592 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004593 script_line_end();
4594# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004595#endif
4596 /*
4597 * Get current line. If there is a read-ahead line, use it, otherwise get
4598 * one now.
4599 */
4600 if (sp->finished)
4601 line = NULL;
4602 else if (sp->nextline == NULL)
4603 line = get_one_sourceline(sp);
4604 else
4605 {
4606 line = sp->nextline;
4607 sp->nextline = NULL;
4608 ++sourcing_lnum;
4609 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004610#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004611 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004612 script_line_start();
4613#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614
4615 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4616 * contain the 'C' flag. */
4617 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4618 {
4619 /* compensate for the one line read-ahead */
4620 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004621
4622 /* Get the next line and concatenate it when it starts with a
4623 * backslash. We always need to read the next line, keep it in
4624 * sp->nextline. */
4625 sp->nextline = get_one_sourceline(sp);
4626 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004627 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004628 garray_T ga;
4629
Bram Moolenaarb549a732012-02-22 18:29:33 +01004630 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004631 ga_concat(&ga, line);
4632 ga_concat(&ga, p + 1);
4633 for (;;)
4634 {
4635 vim_free(sp->nextline);
4636 sp->nextline = get_one_sourceline(sp);
4637 if (sp->nextline == NULL)
4638 break;
4639 p = skipwhite(sp->nextline);
4640 if (*p != '\\')
4641 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004642 /* Adjust the growsize to the current length to speed up
4643 * concatenating many lines. */
4644 if (ga.ga_len > 400)
4645 {
4646 if (ga.ga_len > 8000)
4647 ga.ga_growsize = 8000;
4648 else
4649 ga.ga_growsize = ga.ga_len;
4650 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004651 ga_concat(&ga, p + 1);
4652 }
4653 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004655 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004656 }
4657 }
4658
4659#ifdef FEAT_MBYTE
4660 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4661 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004662 char_u *s;
4663
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 /* Convert the encoding of the script line. */
4665 s = string_convert(&sp->conv, line, NULL);
4666 if (s != NULL)
4667 {
4668 vim_free(line);
4669 line = s;
4670 }
4671 }
4672#endif
4673
4674#ifdef FEAT_EVAL
4675 /* Did we encounter a breakpoint? */
4676 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4677 {
4678 dbg_breakpoint(sp->fname, sourcing_lnum);
4679 /* Find next breakpoint. */
4680 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4681 sp->dbg_tick = debug_tick;
4682 }
4683#endif
4684
4685 return line;
4686}
4687
4688 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004689get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004690{
4691 garray_T ga;
4692 int len;
4693 int c;
4694 char_u *buf;
4695#ifdef USE_CRNL
4696 int has_cr; /* CR-LF found */
4697#endif
4698#ifdef USE_CR
4699 char_u *scan;
4700#endif
4701 int have_read = FALSE;
4702
4703 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004704 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705
4706 /*
4707 * Loop until there is a finished line (or end-of-file).
4708 */
4709 sourcing_lnum++;
4710 for (;;)
4711 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004712 /* make room to read at least 120 (more) characters */
4713 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 break;
4715 buf = (char_u *)ga.ga_data;
4716
4717#ifdef USE_CR
4718 if (sp->fileformat == EOL_MAC)
4719 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004720 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4721 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 break;
4723 }
4724 else
4725#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004726 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4727 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004729 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730#ifdef USE_CRNL
4731 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4732 * CTRL-Z by its own, or after a NL. */
4733 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4734 && sp->fileformat == EOL_DOS
4735 && buf[len - 1] == Ctrl_Z)
4736 {
4737 buf[len - 1] = NUL;
4738 break;
4739 }
4740#endif
4741
4742#ifdef USE_CR
4743 /* If the read doesn't stop on a new line, and there's
4744 * some CR then we assume a Mac format */
4745 if (sp->fileformat == EOL_UNKNOWN)
4746 {
4747 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4748 sp->fileformat = EOL_MAC;
4749 else
4750 sp->fileformat = EOL_UNIX;
4751 }
4752
4753 if (sp->fileformat == EOL_MAC)
4754 {
4755 scan = vim_strchr(buf, '\r');
4756
4757 if (scan != NULL)
4758 {
4759 *scan = '\n';
4760 if (*(scan + 1) != 0)
4761 {
4762 *(scan + 1) = 0;
4763 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4764 }
4765 }
4766 len = STRLEN(buf);
4767 }
4768#endif
4769
4770 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004771 ga.ga_len = len;
4772
4773 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004774 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 continue;
4776
4777 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4778 {
4779#ifdef USE_CRNL
4780 has_cr = (len >= 2 && buf[len - 2] == '\r');
4781 if (sp->fileformat == EOL_UNKNOWN)
4782 {
4783 if (has_cr)
4784 sp->fileformat = EOL_DOS;
4785 else
4786 sp->fileformat = EOL_UNIX;
4787 }
4788
4789 if (sp->fileformat == EOL_DOS)
4790 {
4791 if (has_cr) /* replace trailing CR */
4792 {
4793 buf[len - 2] = '\n';
4794 --len;
4795 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796 }
4797 else /* lines like ":map xx yy^M" will have failed */
4798 {
4799 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004800 {
Bram Moolenaar8820b482017-03-16 17:23:31 +01004801 msg_source(HL_ATTR(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004803 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 sp->error = TRUE;
4805 sp->fileformat = EOL_UNIX;
4806 }
4807 }
4808#endif
4809 /* The '\n' is escaped if there is an odd number of ^V's just
4810 * before it, first set "c" just before the 'V's and then check
4811 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
4812 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
4813 ;
4814 if ((len & 1) != (c & 1)) /* escaped NL, read more */
4815 {
4816 sourcing_lnum++;
4817 continue;
4818 }
4819
4820 buf[len - 1] = NUL; /* remove the NL */
4821 }
4822
4823 /*
4824 * Check for ^C here now and then, so recursive :so can be broken.
4825 */
4826 line_breakcheck();
4827 break;
4828 }
4829
4830 if (have_read)
4831 return (char_u *)ga.ga_data;
4832
4833 vim_free(ga.ga_data);
4834 return NULL;
4835}
4836
Bram Moolenaar05159a02005-02-26 23:04:13 +00004837#if defined(FEAT_PROFILE) || defined(PROTO)
4838/*
4839 * Called when starting to read a script line.
4840 * "sourcing_lnum" must be correct!
4841 * When skipping lines it may not actually be executed, but we won't find out
4842 * until later and we need to store the time now.
4843 */
4844 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004845script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004846{
4847 scriptitem_T *si;
4848 sn_prl_T *pp;
4849
4850 if (current_SID <= 0 || current_SID > script_items.ga_len)
4851 return;
4852 si = &SCRIPT_ITEM(current_SID);
4853 if (si->sn_prof_on && sourcing_lnum >= 1)
4854 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004855 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00004856 * here isn't counted. */
Bram Moolenaarcde88542015-08-11 19:14:00 +02004857 (void)ga_grow(&si->sn_prl_ga, (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00004858 si->sn_prl_idx = sourcing_lnum - 1;
4859 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
4860 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
4861 {
4862 /* Zero counters for a line that was not used before. */
4863 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
4864 pp->snp_count = 0;
4865 profile_zero(&pp->sn_prl_total);
4866 profile_zero(&pp->sn_prl_self);
4867 ++si->sn_prl_ga.ga_len;
4868 }
4869 si->sn_prl_execed = FALSE;
4870 profile_start(&si->sn_prl_start);
4871 profile_zero(&si->sn_prl_children);
4872 profile_get_wait(&si->sn_prl_wait);
4873 }
4874}
4875
4876/*
4877 * Called when actually executing a function line.
4878 */
4879 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004880script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004881{
4882 scriptitem_T *si;
4883
4884 if (current_SID <= 0 || current_SID > script_items.ga_len)
4885 return;
4886 si = &SCRIPT_ITEM(current_SID);
4887 if (si->sn_prof_on && si->sn_prl_idx >= 0)
4888 si->sn_prl_execed = TRUE;
4889}
4890
4891/*
4892 * Called when done with a function line.
4893 */
4894 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004895script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004896{
4897 scriptitem_T *si;
4898 sn_prl_T *pp;
4899
4900 if (current_SID <= 0 || current_SID > script_items.ga_len)
4901 return;
4902 si = &SCRIPT_ITEM(current_SID);
4903 if (si->sn_prof_on && si->sn_prl_idx >= 0
4904 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
4905 {
4906 if (si->sn_prl_execed)
4907 {
4908 pp = &PRL_ITEM(si, si->sn_prl_idx);
4909 ++pp->snp_count;
4910 profile_end(&si->sn_prl_start);
4911 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004912 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004913 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
4914 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004915 }
4916 si->sn_prl_idx = -1;
4917 }
4918}
4919#endif
4920
Bram Moolenaar071d4272004-06-13 20:20:40 +00004921/*
4922 * ":scriptencoding": Set encoding conversion for a sourced script.
4923 * Without the multi-byte feature it's simply ignored.
4924 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004926ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004927{
4928#ifdef FEAT_MBYTE
4929 struct source_cookie *sp;
4930 char_u *name;
4931
4932 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
4933 {
4934 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
4935 return;
4936 }
4937
4938 if (*eap->arg != NUL)
4939 {
4940 name = enc_canonize(eap->arg);
4941 if (name == NULL) /* out of memory */
4942 return;
4943 }
4944 else
4945 name = eap->arg;
4946
4947 /* Setup for conversion from the specified encoding to 'encoding'. */
4948 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
4949 convert_setup(&sp->conv, name, p_enc);
4950
4951 if (name != eap->arg)
4952 vim_free(name);
4953#endif
4954}
4955
4956#if defined(FEAT_EVAL) || defined(PROTO)
4957/*
4958 * ":finish": Mark a sourced file as finished.
4959 */
4960 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004961ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004962{
4963 if (getline_equal(eap->getline, eap->cookie, getsourceline))
4964 do_finish(eap, FALSE);
4965 else
4966 EMSG(_("E168: :finish used outside of a sourced file"));
4967}
4968
4969/*
4970 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
4971 * Also called for a pending finish at the ":endtry" or after returning from
4972 * an extra do_cmdline(). "reanimate" is used in the latter case.
4973 */
4974 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004975do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976{
4977 int idx;
4978
4979 if (reanimate)
4980 ((struct source_cookie *)getline_cookie(eap->getline,
4981 eap->cookie))->finished = FALSE;
4982
4983 /*
4984 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4985 * not in its finally clause (which then is to be executed next) is found.
4986 * In this case, make the ":finish" pending for execution at the ":endtry".
4987 * Otherwise, finish normally.
4988 */
4989 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4990 if (idx >= 0)
4991 {
4992 eap->cstack->cs_pending[idx] = CSTP_FINISH;
4993 report_make_pending(CSTP_FINISH, NULL);
4994 }
4995 else
4996 ((struct source_cookie *)getline_cookie(eap->getline,
4997 eap->cookie))->finished = TRUE;
4998}
4999
5000
5001/*
5002 * Return TRUE when a sourced file had the ":finish" command: Don't give error
5003 * message for missing ":endif".
5004 * Return FALSE when not sourcing a file.
5005 */
5006 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005007source_finished(
5008 char_u *(*fgetline)(int, void *, int),
5009 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005010{
Bram Moolenaar89d40322006-08-29 15:30:07 +00005011 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005012 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00005013 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005014}
5015#endif
5016
5017#if defined(FEAT_LISTCMDS) || defined(PROTO)
5018/*
5019 * ":checktime [buffer]"
5020 */
5021 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005022ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023{
5024 buf_T *buf;
5025 int save_no_check_timestamps = no_check_timestamps;
5026
5027 no_check_timestamps = 0;
5028 if (eap->addr_count == 0) /* default is all buffers */
5029 check_timestamps(FALSE);
5030 else
5031 {
5032 buf = buflist_findnr((int)eap->line2);
5033 if (buf != NULL) /* cannot happen? */
5034 (void)buf_check_timestamp(buf, FALSE);
5035 }
5036 no_check_timestamps = save_no_check_timestamps;
5037}
5038#endif
5039
Bram Moolenaar071d4272004-06-13 20:20:40 +00005040#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5041 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005042# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005043static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005044
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005045 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005046get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005047{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005048 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049
Bram Moolenaar48e330a2016-02-23 14:53:34 +01005050 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005051 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005052
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005053# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00005054 if (loc != NULL)
5055 {
5056 char_u *p;
5057
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005058 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
5059 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005060 p = vim_strchr(loc, '=');
5061 if (p != NULL)
5062 {
5063 loc = ++p;
5064 while (*p != NUL) /* remove trailing newline */
5065 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005066 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00005067 {
5068 *p = NUL;
5069 break;
5070 }
5071 ++p;
5072 }
5073 }
5074 }
5075# endif
5076
5077 return loc;
5078}
5079#endif
5080
5081
5082#ifdef WIN32
5083/*
5084 * On MS-Windows locale names are strings like "German_Germany.1252", but
5085 * gettext expects "de". Try to translate one into another here for a few
5086 * supported languages.
5087 */
5088 static char_u *
5089gettext_lang(char_u *name)
5090{
5091 int i;
5092 static char *(mtable[]) = {
5093 "afrikaans", "af",
5094 "czech", "cs",
5095 "dutch", "nl",
5096 "german", "de",
5097 "english_united kingdom", "en_GB",
5098 "spanish", "es",
5099 "french", "fr",
5100 "italian", "it",
5101 "japanese", "ja",
5102 "korean", "ko",
5103 "norwegian", "no",
5104 "polish", "pl",
5105 "russian", "ru",
5106 "slovak", "sk",
5107 "swedish", "sv",
5108 "ukrainian", "uk",
5109 "chinese_china", "zh_CN",
5110 "chinese_taiwan", "zh_TW",
5111 NULL};
5112
5113 for (i = 0; mtable[i] != NULL; i += 2)
5114 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005115 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 return name;
5117}
5118#endif
5119
5120#if defined(FEAT_MULTI_LANG) || defined(PROTO)
5121/*
5122 * Obtain the current messages language. Used to set the default for
5123 * 'helplang'. May return NULL or an empty string.
5124 */
5125 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005126get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127{
5128 char_u *p;
5129
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005130# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005131# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005132 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005133# else
5134 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00005135 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
5136 * and LC_MONETARY may be set differently for a Japanese working in the
5137 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005138 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139# endif
5140# else
5141 p = mch_getenv((char_u *)"LC_ALL");
5142 if (p == NULL || *p == NUL)
5143 {
5144 p = mch_getenv((char_u *)"LC_MESSAGES");
5145 if (p == NULL || *p == NUL)
5146 p = mch_getenv((char_u *)"LANG");
5147 }
5148# endif
5149# ifdef WIN32
5150 p = gettext_lang(p);
5151# endif
5152 return p;
5153}
5154#endif
5155
Bram Moolenaardef9e822004-12-31 20:58:58 +00005156/* Complicated #if; matches with where get_mess_env() is used below. */
5157#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5158 && defined(LC_MESSAGES))) \
5159 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5160 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
5161 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01005162static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163
5164/*
5165 * Get the language used for messages from the environment.
5166 */
5167 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005168get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169{
5170 char_u *p;
5171
5172 p = mch_getenv((char_u *)"LC_ALL");
5173 if (p == NULL || *p == NUL)
5174 {
5175 p = mch_getenv((char_u *)"LC_MESSAGES");
5176 if (p == NULL || *p == NUL)
5177 {
5178 p = mch_getenv((char_u *)"LANG");
5179 if (p != NULL && VIM_ISDIGIT(*p))
5180 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005181# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005183 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184# endif
5185 }
5186 }
5187 return p;
5188}
5189#endif
5190
5191#if defined(FEAT_EVAL) || defined(PROTO)
5192
5193/*
5194 * Set the "v:lang" variable according to the current locale setting.
5195 * Also do "v:lc_time"and "v:ctype".
5196 */
5197 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005198set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005199{
5200 char_u *loc;
5201
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005202# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005203 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005204# else
5205 /* setlocale() not supported: use the default value */
5206 loc = (char_u *)"C";
5207# endif
5208 set_vim_var_string(VV_CTYPE, loc, -1);
5209
5210 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
5211 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005212# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005213 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214# else
5215 loc = get_mess_env();
5216# endif
5217 set_vim_var_string(VV_LANG, loc, -1);
5218
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02005219# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01005220 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221# endif
5222 set_vim_var_string(VV_LC_TIME, loc, -1);
5223}
5224#endif
5225
5226#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
5227 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
5228/*
5229 * ":language": Set the language (locale).
5230 */
5231 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005232ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233{
5234 char *loc;
5235 char_u *p;
5236 char_u *name;
5237 int what = LC_ALL;
5238 char *whatstr = "";
5239#ifdef LC_MESSAGES
5240# define VIM_LC_MESSAGES LC_MESSAGES
5241#else
5242# define VIM_LC_MESSAGES 6789
5243#endif
5244
5245 name = eap->arg;
5246
5247 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
5248 * Allow abbreviation, but require at least 3 characters to avoid
5249 * confusion with a two letter language name "me" or "ct". */
5250 p = skiptowhite(eap->arg);
Bram Moolenaar1c465442017-03-12 20:10:05 +01005251 if ((*p == NUL || VIM_ISWHITE(*p)) && p - eap->arg >= 3)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 {
5253 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
5254 {
5255 what = VIM_LC_MESSAGES;
5256 name = skipwhite(p);
5257 whatstr = "messages ";
5258 }
5259 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
5260 {
5261 what = LC_CTYPE;
5262 name = skipwhite(p);
5263 whatstr = "ctype ";
5264 }
5265 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
5266 {
5267 what = LC_TIME;
5268 name = skipwhite(p);
5269 whatstr = "time ";
5270 }
5271 }
5272
5273 if (*name == NUL)
5274 {
5275#ifndef LC_MESSAGES
5276 if (what == VIM_LC_MESSAGES)
5277 p = get_mess_env();
5278 else
5279#endif
5280 p = (char_u *)setlocale(what, NULL);
5281 if (p == NULL || *p == NUL)
5282 p = (char_u *)"Unknown";
5283 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
5284 }
5285 else
5286 {
5287#ifndef LC_MESSAGES
5288 if (what == VIM_LC_MESSAGES)
5289 loc = "";
5290 else
5291#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005292 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00005294#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
5295 /* Make sure strtod() uses a decimal point, not a comma. */
5296 setlocale(LC_NUMERIC, "C");
5297#endif
5298 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299 if (loc == NULL)
5300 EMSG2(_("E197: Cannot set language to \"%s\""), name);
5301 else
5302 {
5303#ifdef HAVE_NL_MSG_CAT_CNTR
5304 /* Need to do this for GNU gettext, otherwise cached translations
5305 * will be used again. */
5306 extern int _nl_msg_cat_cntr;
5307
5308 ++_nl_msg_cat_cntr;
5309#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00005310 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005311 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
5312
5313 if (what != LC_TIME)
5314 {
5315 /* Tell gettext() what to translate to. It apparently doesn't
5316 * use the currently effective locale. Also do this when
5317 * FEAT_GETTEXT isn't defined, so that shell commands use this
5318 * value. */
5319 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005320 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00005321 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02005322
5323 /* Clear $LANGUAGE because GNU gettext uses it. */
5324 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005325# ifdef WIN32
5326 /* Apparently MS-Windows printf() may cause a crash when
5327 * we give it 8-bit text while it's expecting text in the
5328 * current locale. This call avoids that. */
5329 setlocale(LC_CTYPE, "C");
5330# endif
5331 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 if (what != LC_CTYPE)
5333 {
5334 char_u *mname;
5335#ifdef WIN32
5336 mname = gettext_lang(name);
5337#else
5338 mname = name;
5339#endif
5340 vim_setenv((char_u *)"LC_MESSAGES", mname);
5341#ifdef FEAT_MULTI_LANG
5342 set_helplang_default(mname);
5343#endif
5344 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00005345 }
5346
5347# ifdef FEAT_EVAL
5348 /* Set v:lang, v:lc_time and v:ctype to the final result. */
5349 set_lang_var();
5350# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02005351# ifdef FEAT_TITLE
5352 maketitle();
5353# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354 }
5355 }
5356}
5357
5358# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005359
5360static char_u **locales = NULL; /* Array of all available locales */
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005361
5362# ifndef WIN32
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005363static int did_init_locales = FALSE;
5364
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005365/* Return an array of strings for all available locales + NULL for the
5366 * last element. Return NULL in case of error. */
5367 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005368find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005369{
5370 garray_T locales_ga;
5371 char_u *loc;
5372
5373 /* Find all available locales by running command "locale -a". If this
5374 * doesn't work we won't have completion. */
5375 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02005376 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005377 if (locale_a == NULL)
5378 return NULL;
5379 ga_init2(&locales_ga, sizeof(char_u *), 20);
5380
5381 /* Transform locale_a string where each locale is separated by "\n"
5382 * into an array of locale strings. */
5383 loc = (char_u *)strtok((char *)locale_a, "\n");
5384
5385 while (loc != NULL)
5386 {
5387 if (ga_grow(&locales_ga, 1) == FAIL)
5388 break;
5389 loc = vim_strsave(loc);
5390 if (loc == NULL)
5391 break;
5392
5393 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
5394 loc = (char_u *)strtok(NULL, "\n");
5395 }
5396 vim_free(locale_a);
5397 if (ga_grow(&locales_ga, 1) == FAIL)
5398 {
5399 ga_clear(&locales_ga);
5400 return NULL;
5401 }
5402 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
5403 return (char_u **)locales_ga.ga_data;
5404}
Bram Moolenaarb8f7bd62017-01-12 20:28:25 +01005405# endif
5406
5407/*
5408 * Lazy initialization of all available locales.
5409 */
5410 static void
5411init_locales(void)
5412{
5413# ifndef WIN32
5414 if (!did_init_locales)
5415 {
5416 did_init_locales = TRUE;
5417 locales = find_locales();
5418 }
5419# endif
5420}
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005421
5422# if defined(EXITFREE) || defined(PROTO)
5423 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005424free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005425{
5426 int i;
5427 if (locales != NULL)
5428 {
5429 for (i = 0; locales[i] != NULL; i++)
5430 vim_free(locales[i]);
5431 vim_free(locales);
5432 locales = NULL;
5433 }
5434}
5435# endif
5436
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437/*
5438 * Function given to ExpandGeneric() to obtain the possible arguments of the
5439 * ":language" command.
5440 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00005441 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005442get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005443{
5444 if (idx == 0)
5445 return (char_u *)"messages";
5446 if (idx == 1)
5447 return (char_u *)"ctype";
5448 if (idx == 2)
5449 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005450
5451 init_locales();
5452 if (locales == NULL)
5453 return NULL;
5454 return locales[idx - 3];
5455}
5456
5457/*
5458 * Function given to ExpandGeneric() to obtain the available locales.
5459 */
5460 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01005461get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02005462{
5463 init_locales();
5464 if (locales == NULL)
5465 return NULL;
5466 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467}
5468# endif
5469
5470#endif