blob: c03c2405622b509adbc288e208b321b51125e20d [file] [log] [blame]
Bram Moolenaar071d4272004-06-13 20:20:40 +00001/* vi:set ts=8 sts=4 sw=4:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_cmds2.c: some more functions for command line commands
12 */
13
Bram Moolenaar071d4272004-06-13 20:20:40 +000014#include "vim.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000015#include "version.h"
16
Bram Moolenaarf28dbce2016-01-29 22:03:47 +010017static void cmd_source(char_u *fname, exarg_T *eap);
Bram Moolenaar071d4272004-06-13 20:20:40 +000018
Bram Moolenaar05159a02005-02-26 23:04:13 +000019#ifdef FEAT_EVAL
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000020/* Growarray to store info about already sourced scripts.
Bram Moolenaar05159a02005-02-26 23:04:13 +000021 * For Unix also store the dev/ino, so that we don't have to stat() each
22 * script when going through the list. */
23typedef struct scriptitem_S
24{
25 char_u *sn_name;
26# ifdef UNIX
Bram Moolenaarbf0c4522009-05-16 19:16:33 +000027 int sn_dev_valid;
28 dev_t sn_dev;
Bram Moolenaar05159a02005-02-26 23:04:13 +000029 ino_t sn_ino;
30# endif
31# ifdef FEAT_PROFILE
32 int sn_prof_on; /* TRUE when script is/was profiled */
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000033 int sn_pr_force; /* forceit: profile functions in this script */
Bram Moolenaar05159a02005-02-26 23:04:13 +000034 proftime_T sn_pr_child; /* time set when going into first child */
35 int sn_pr_nest; /* nesting for sn_pr_child */
36 /* profiling the script as a whole */
37 int sn_pr_count; /* nr of times sourced */
Bram Moolenaar8c8de832008-06-24 22:58:06 +000038 proftime_T sn_pr_total; /* time spent in script + children */
39 proftime_T sn_pr_self; /* time spent in script itself */
Bram Moolenaar05159a02005-02-26 23:04:13 +000040 proftime_T sn_pr_start; /* time at script start */
41 proftime_T sn_pr_children; /* time in children after script start */
42 /* profiling the script per line */
43 garray_T sn_prl_ga; /* things stored for every line */
44 proftime_T sn_prl_start; /* start time for current line */
45 proftime_T sn_prl_children; /* time spent in children for this line */
46 proftime_T sn_prl_wait; /* wait start time for current line */
47 int sn_prl_idx; /* index of line being timed; -1 if none */
48 int sn_prl_execed; /* line being timed was executed */
49# endif
50} scriptitem_T;
51
52static garray_T script_items = {0, 0, sizeof(scriptitem_T), 4, NULL};
53#define SCRIPT_ITEM(id) (((scriptitem_T *)script_items.ga_data)[(id) - 1])
54
55# ifdef FEAT_PROFILE
56/* Struct used in sn_prl_ga for every line of a script. */
57typedef struct sn_prl_S
58{
59 int snp_count; /* nr of times line was executed */
Bram Moolenaar8c8de832008-06-24 22:58:06 +000060 proftime_T sn_prl_total; /* time spent in a line + children */
61 proftime_T sn_prl_self; /* time spent in a line itself */
Bram Moolenaar05159a02005-02-26 23:04:13 +000062} sn_prl_T;
63
64# define PRL_ITEM(si, idx) (((sn_prl_T *)(si)->sn_prl_ga.ga_data)[(idx)])
65# endif
66#endif
67
Bram Moolenaar071d4272004-06-13 20:20:40 +000068#if defined(FEAT_EVAL) || defined(PROTO)
69static int debug_greedy = FALSE; /* batch mode debugging: don't save
70 and restore typeahead. */
Bram Moolenaarf1f60f82016-01-16 15:40:53 +010071static int get_maxbacktrace_level(void);
72static void do_setdebugtracelevel(char_u *arg);
73static void do_checkbacktracelevel(void);
74static void do_showbacktrace(char_u *cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +000075
76/*
77 * do_debug(): Debug mode.
78 * Repeatedly get Ex commands, until told to continue normal execution.
79 */
80 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010081do_debug(char_u *cmd)
Bram Moolenaar071d4272004-06-13 20:20:40 +000082{
83 int save_msg_scroll = msg_scroll;
84 int save_State = State;
85 int save_did_emsg = did_emsg;
86 int save_cmd_silent = cmd_silent;
87 int save_msg_silent = msg_silent;
88 int save_emsg_silent = emsg_silent;
89 int save_redir_off = redir_off;
90 tasave_T typeaheadbuf;
Bram Moolenaaree3f7a52008-01-01 13:17:56 +000091 int typeahead_saved = FALSE;
Bram Moolenaar383c6f52008-01-04 15:01:07 +000092 int save_ignore_script = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +000093 int save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +000094 int n;
95 char_u *cmdline = NULL;
96 char_u *p;
97 char *tail = NULL;
98 static int last_cmd = 0;
99#define CMD_CONT 1
100#define CMD_NEXT 2
101#define CMD_STEP 3
102#define CMD_FINISH 4
103#define CMD_QUIT 5
104#define CMD_INTERRUPT 6
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100105#define CMD_BACKTRACE 7
106#define CMD_FRAME 8
107#define CMD_UP 9
108#define CMD_DOWN 10
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110#ifdef ALWAYS_USE_GUI
111 /* Can't do this when there is no terminal for input/output. */
112 if (!gui.in_use)
113 {
114 /* Break as soon as possible. */
115 debug_break_level = 9999;
116 return;
117 }
118#endif
119
120 /* Make sure we are in raw mode and start termcap mode. Might have side
121 * effects... */
122 settmode(TMODE_RAW);
123 starttermcap();
124
125 ++RedrawingDisabled; /* don't redisplay the window */
126 ++no_wait_return; /* don't wait for return */
127 did_emsg = FALSE; /* don't use error from debugged stuff */
128 cmd_silent = FALSE; /* display commands */
129 msg_silent = FALSE; /* display messages */
130 emsg_silent = FALSE; /* display error messages */
131 redir_off = TRUE; /* don't redirect debug commands */
132
133 State = NORMAL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000134
135 if (!debug_did_msg)
136 MSG(_("Entering Debug mode. Type \"cont\" to continue."));
137 if (sourcing_name != NULL)
138 msg(sourcing_name);
139 if (sourcing_lnum != 0)
Bram Moolenaar555b2802005-05-19 21:08:39 +0000140 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141 else
Bram Moolenaar555b2802005-05-19 21:08:39 +0000142 smsg((char_u *)_("cmd: %s"), cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143
144 /*
145 * Repeat getting a command and executing it.
146 */
147 for (;;)
148 {
149 msg_scroll = TRUE;
150 need_wait_return = FALSE;
Bram Moolenaar85b11762016-02-27 18:13:23 +0100151
Bram Moolenaar071d4272004-06-13 20:20:40 +0000152 /* Save the current typeahead buffer and replace it with an empty one.
153 * This makes sure we get input from the user here and don't interfere
154 * with the commands being executed. Reset "ex_normal_busy" to avoid
155 * the side effects of using ":normal". Save the stuff buffer and make
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000156 * it empty. Set ignore_script to avoid reading from script input. */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157 save_ex_normal_busy = ex_normal_busy;
158 ex_normal_busy = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000159 if (!debug_greedy)
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000160 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000161 save_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000162 typeahead_saved = TRUE;
163 save_ignore_script = ignore_script;
164 ignore_script = TRUE;
165 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000166
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000167 cmdline = getcmdline_prompt('>', NULL, 0, EXPAND_NOTHING, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000168
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000169 if (typeahead_saved)
170 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171 restore_typeahead(&typeaheadbuf);
Bram Moolenaaree3f7a52008-01-01 13:17:56 +0000172 ignore_script = save_ignore_script;
173 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174 ex_normal_busy = save_ex_normal_busy;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000175
176 cmdline_row = msg_row;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100177 msg_starthere();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000178 if (cmdline != NULL)
179 {
180 /* If this is a debug command, set "last_cmd".
181 * If not, reset "last_cmd".
182 * For a blank line use previous command. */
183 p = skipwhite(cmdline);
184 if (*p != NUL)
185 {
186 switch (*p)
187 {
188 case 'c': last_cmd = CMD_CONT;
189 tail = "ont";
190 break;
191 case 'n': last_cmd = CMD_NEXT;
192 tail = "ext";
193 break;
194 case 's': last_cmd = CMD_STEP;
195 tail = "tep";
196 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100197 case 'f':
198 last_cmd = 0;
199 if (p[1] == 'r')
200 {
201 last_cmd = CMD_FRAME;
202 tail = "rame";
203 }
204 else
205 {
206 last_cmd = CMD_FINISH;
207 tail = "inish";
208 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000209 break;
210 case 'q': last_cmd = CMD_QUIT;
211 tail = "uit";
212 break;
213 case 'i': last_cmd = CMD_INTERRUPT;
214 tail = "nterrupt";
215 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100216 case 'b': last_cmd = CMD_BACKTRACE;
217 if (p[1] == 't')
218 tail = "t";
219 else
220 tail = "acktrace";
221 break;
222 case 'w': last_cmd = CMD_BACKTRACE;
223 tail = "here";
224 break;
225 case 'u': last_cmd = CMD_UP;
226 tail = "p";
227 break;
228 case 'd': last_cmd = CMD_DOWN;
229 tail = "own";
230 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000231 default: last_cmd = 0;
232 }
233 if (last_cmd != 0)
234 {
235 /* Check that the tail matches. */
236 ++p;
237 while (*p != NUL && *p == *tail)
238 {
239 ++p;
240 ++tail;
241 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100242 if (ASCII_ISALPHA(*p) && last_cmd != CMD_FRAME)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000243 last_cmd = 0;
244 }
245 }
246
247 if (last_cmd != 0)
248 {
249 /* Execute debug command: decided where to break next and
250 * return. */
251 switch (last_cmd)
252 {
253 case CMD_CONT:
254 debug_break_level = -1;
255 break;
256 case CMD_NEXT:
257 debug_break_level = ex_nesting_level;
258 break;
259 case CMD_STEP:
260 debug_break_level = 9999;
261 break;
262 case CMD_FINISH:
263 debug_break_level = ex_nesting_level - 1;
264 break;
265 case CMD_QUIT:
266 got_int = TRUE;
267 debug_break_level = -1;
268 break;
269 case CMD_INTERRUPT:
270 got_int = TRUE;
271 debug_break_level = 9999;
272 /* Do not repeat ">interrupt" cmd, continue stepping. */
273 last_cmd = CMD_STEP;
274 break;
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100275 case CMD_BACKTRACE:
276 do_showbacktrace(cmd);
277 continue;
278 case CMD_FRAME:
279 if (*p == NUL)
280 {
281 do_showbacktrace(cmd);
282 }
283 else
284 {
285 p = skipwhite(p);
286 do_setdebugtracelevel(p);
287 }
288 continue;
289 case CMD_UP:
290 debug_backtrace_level++;
291 do_checkbacktracelevel();
292 continue;
293 case CMD_DOWN:
294 debug_backtrace_level--;
295 do_checkbacktracelevel();
296 continue;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000297 }
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100298 /* Going out reset backtrace_level */
299 debug_backtrace_level = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000300 break;
301 }
302
303 /* don't debug this command */
304 n = debug_break_level;
305 debug_break_level = -1;
306 (void)do_cmdline(cmdline, getexline, NULL,
307 DOCMD_VERBOSE|DOCMD_EXCRESET);
308 debug_break_level = n;
309
310 vim_free(cmdline);
311 }
312 lines_left = Rows - 1;
313 }
314 vim_free(cmdline);
315
316 --RedrawingDisabled;
317 --no_wait_return;
318 redraw_all_later(NOT_VALID);
319 need_wait_return = FALSE;
320 msg_scroll = save_msg_scroll;
321 lines_left = Rows - 1;
322 State = save_State;
323 did_emsg = save_did_emsg;
324 cmd_silent = save_cmd_silent;
325 msg_silent = save_msg_silent;
326 emsg_silent = save_emsg_silent;
327 redir_off = save_redir_off;
328
329 /* Only print the message again when typing a command before coming back
330 * here. */
331 debug_did_msg = TRUE;
332}
333
Bram Moolenaarf1f60f82016-01-16 15:40:53 +0100334 static int
335get_maxbacktrace_level(void)
336{
337 char *p, *q;
338 int maxbacktrace = 1;
339
340 maxbacktrace = 0;
341 if (sourcing_name != NULL)
342 {
343 p = (char *)sourcing_name;
344 while ((q = strstr(p, "..")) != NULL)
345 {
346 p = q + 2;
347 maxbacktrace++;
348 }
349 }
350 return maxbacktrace;
351}
352
353 static void
354do_setdebugtracelevel(char_u *arg)
355{
356 int level;
357
358 level = atoi((char *)arg);
359 if (*arg == '+' || level < 0)
360 debug_backtrace_level += level;
361 else
362 debug_backtrace_level = level;
363
364 do_checkbacktracelevel();
365}
366
367 static void
368do_checkbacktracelevel(void)
369{
370 if (debug_backtrace_level < 0)
371 {
372 debug_backtrace_level = 0;
373 MSG(_("frame is zero"));
374 }
375 else
376 {
377 int max = get_maxbacktrace_level();
378
379 if (debug_backtrace_level > max)
380 {
381 debug_backtrace_level = max;
382 smsg((char_u *)_("frame at highest level: %d"), max);
383 }
384 }
385}
386
387 static void
388do_showbacktrace(char_u *cmd)
389{
390 char *cur;
391 char *next;
392 int i = 0;
393 int max = get_maxbacktrace_level();
394
395 if (sourcing_name != NULL)
396 {
397 cur = (char *)sourcing_name;
398 while (!got_int)
399 {
400 next = strstr(cur, "..");
401 if (next != NULL)
402 *next = NUL;
403 if (i == max - debug_backtrace_level)
404 smsg((char_u *)"->%d %s", max - i, cur);
405 else
406 smsg((char_u *)" %d %s", max - i, cur);
407 ++i;
408 if (next == NULL)
409 break;
410 *next = '.';
411 cur = next + 2;
412 }
413 }
414 if (sourcing_lnum != 0)
415 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
416 else
417 smsg((char_u *)_("cmd: %s"), cmd);
418}
419
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420/*
421 * ":debug".
422 */
423 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100424ex_debug(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000425{
426 int debug_break_level_save = debug_break_level;
427
428 debug_break_level = 9999;
429 do_cmdline_cmd(eap->arg);
430 debug_break_level = debug_break_level_save;
431}
432
433static char_u *debug_breakpoint_name = NULL;
434static linenr_T debug_breakpoint_lnum;
435
436/*
437 * When debugging or a breakpoint is set on a skipped command, no debug prompt
438 * is shown by do_one_cmd(). This situation is indicated by debug_skipped, and
439 * debug_skipped_name is then set to the source name in the breakpoint case. If
440 * a skipped command decides itself that a debug prompt should be displayed, it
441 * can do so by calling dbg_check_skipped().
442 */
443static int debug_skipped;
444static char_u *debug_skipped_name;
445
446/*
447 * Go to debug mode when a breakpoint was encountered or "ex_nesting_level" is
448 * at or below the break level. But only when the line is actually
449 * executed. Return TRUE and set breakpoint_name for skipped commands that
450 * decide to execute something themselves.
451 * Called from do_one_cmd() before executing a command.
452 */
453 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100454dbg_check_breakpoint(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455{
456 char_u *p;
457
458 debug_skipped = FALSE;
459 if (debug_breakpoint_name != NULL)
460 {
461 if (!eap->skip)
462 {
463 /* replace K_SNR with "<SNR>" */
464 if (debug_breakpoint_name[0] == K_SPECIAL
465 && debug_breakpoint_name[1] == KS_EXTRA
466 && debug_breakpoint_name[2] == (int)KE_SNR)
467 p = (char_u *)"<SNR>";
468 else
469 p = (char_u *)"";
Bram Moolenaar555b2802005-05-19 21:08:39 +0000470 smsg((char_u *)_("Breakpoint in \"%s%s\" line %ld"),
471 p,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000472 debug_breakpoint_name + (*p == NUL ? 0 : 3),
473 (long)debug_breakpoint_lnum);
474 debug_breakpoint_name = NULL;
475 do_debug(eap->cmd);
476 }
477 else
478 {
479 debug_skipped = TRUE;
480 debug_skipped_name = debug_breakpoint_name;
481 debug_breakpoint_name = NULL;
482 }
483 }
484 else if (ex_nesting_level <= debug_break_level)
485 {
486 if (!eap->skip)
487 do_debug(eap->cmd);
488 else
489 {
490 debug_skipped = TRUE;
491 debug_skipped_name = NULL;
492 }
493 }
494}
495
496/*
497 * Go to debug mode if skipped by dbg_check_breakpoint() because eap->skip was
498 * set. Return TRUE when the debug mode is entered this time.
499 */
500 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100501dbg_check_skipped(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000502{
503 int prev_got_int;
504
505 if (debug_skipped)
506 {
507 /*
508 * Save the value of got_int and reset it. We don't want a previous
509 * interruption cause flushing the input buffer.
510 */
511 prev_got_int = got_int;
512 got_int = FALSE;
513 debug_breakpoint_name = debug_skipped_name;
514 /* eap->skip is TRUE */
515 eap->skip = FALSE;
516 (void)dbg_check_breakpoint(eap);
517 eap->skip = TRUE;
518 got_int |= prev_got_int;
519 return TRUE;
520 }
521 return FALSE;
522}
523
524/*
525 * The list of breakpoints: dbg_breakp.
526 * This is a grow-array of structs.
527 */
528struct debuggy
529{
530 int dbg_nr; /* breakpoint number */
531 int dbg_type; /* DBG_FUNC or DBG_FILE */
532 char_u *dbg_name; /* function or file name */
533 regprog_T *dbg_prog; /* regexp program */
534 linenr_T dbg_lnum; /* line number in function or file */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000535 int dbg_forceit; /* ! used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000536};
537
538static garray_T dbg_breakp = {0, 0, sizeof(struct debuggy), 4, NULL};
Bram Moolenaar05159a02005-02-26 23:04:13 +0000539#define BREAKP(idx) (((struct debuggy *)dbg_breakp.ga_data)[idx])
540#define DEBUGGY(gap, idx) (((struct debuggy *)gap->ga_data)[idx])
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541static int last_breakp = 0; /* nr of last defined breakpoint */
542
Bram Moolenaar05159a02005-02-26 23:04:13 +0000543#ifdef FEAT_PROFILE
544/* Profiling uses file and func names similar to breakpoints. */
545static garray_T prof_ga = {0, 0, sizeof(struct debuggy), 4, NULL};
546#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000547#define DBG_FUNC 1
548#define DBG_FILE 2
549
Bram Moolenaarf28dbce2016-01-29 22:03:47 +0100550static int dbg_parsearg(char_u *arg, garray_T *gap);
551static linenr_T debuggy_find(int file,char_u *fname, linenr_T after, garray_T *gap, int *fp);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552
553/*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000554 * Parse the arguments of ":profile", ":breakadd" or ":breakdel" and put them
555 * in the entry just after the last one in dbg_breakp. Note that "dbg_name"
556 * is allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000557 * Returns FAIL for failure.
558 */
559 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100560dbg_parsearg(
561 char_u *arg,
562 garray_T *gap) /* either &dbg_breakp or &prof_ga */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563{
564 char_u *p = arg;
565 char_u *q;
566 struct debuggy *bp;
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000567 int here = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000568
Bram Moolenaar05159a02005-02-26 23:04:13 +0000569 if (ga_grow(gap, 1) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000570 return FAIL;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000571 bp = &DEBUGGY(gap, gap->ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572
573 /* Find "func" or "file". */
574 if (STRNCMP(p, "func", 4) == 0)
575 bp->dbg_type = DBG_FUNC;
576 else if (STRNCMP(p, "file", 4) == 0)
577 bp->dbg_type = DBG_FILE;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000578 else if (
579#ifdef FEAT_PROFILE
580 gap != &prof_ga &&
581#endif
582 STRNCMP(p, "here", 4) == 0)
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000583 {
584 if (curbuf->b_ffname == NULL)
585 {
586 EMSG(_(e_noname));
587 return FAIL;
588 }
589 bp->dbg_type = DBG_FILE;
590 here = TRUE;
591 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592 else
593 {
594 EMSG2(_(e_invarg2), p);
595 return FAIL;
596 }
597 p = skipwhite(p + 4);
598
599 /* Find optional line number. */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000600 if (here)
601 bp->dbg_lnum = curwin->w_cursor.lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000602 else if (
603#ifdef FEAT_PROFILE
604 gap != &prof_ga &&
605#endif
606 VIM_ISDIGIT(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607 {
608 bp->dbg_lnum = getdigits(&p);
609 p = skipwhite(p);
610 }
611 else
612 bp->dbg_lnum = 0;
613
614 /* Find the function or file name. Don't accept a function name with (). */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000615 if ((!here && *p == NUL)
616 || (here && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 || (bp->dbg_type == DBG_FUNC && strstr((char *)p, "()") != NULL))
618 {
619 EMSG2(_(e_invarg2), arg);
620 return FAIL;
621 }
622
623 if (bp->dbg_type == DBG_FUNC)
624 bp->dbg_name = vim_strsave(p);
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000625 else if (here)
626 bp->dbg_name = vim_strsave(curbuf->b_ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000627 else
628 {
629 /* Expand the file name in the same way as do_source(). This means
630 * doing it twice, so that $DIR/file gets expanded when $DIR is
631 * "~/dir". */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 q = expand_env_save(p);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 if (q == NULL)
634 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635 p = expand_env_save(q);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000636 vim_free(q);
637 if (p == NULL)
638 return FAIL;
Bram Moolenaar843ee412004-06-30 16:16:41 +0000639 if (*p != '*')
640 {
641 bp->dbg_name = fix_fname(p);
642 vim_free(p);
643 }
644 else
645 bp->dbg_name = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 }
647
648 if (bp->dbg_name == NULL)
649 return FAIL;
650 return OK;
651}
652
653/*
654 * ":breakadd".
655 */
656 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100657ex_breakadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658{
659 struct debuggy *bp;
660 char_u *pat;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000661 garray_T *gap;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662
Bram Moolenaar05159a02005-02-26 23:04:13 +0000663 gap = &dbg_breakp;
664#ifdef FEAT_PROFILE
665 if (eap->cmdidx == CMD_profile)
666 gap = &prof_ga;
667#endif
668
669 if (dbg_parsearg(eap->arg, gap) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000671 bp = &DEBUGGY(gap, gap->ga_len);
672 bp->dbg_forceit = eap->forceit;
673
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 pat = file_pat_to_reg_pat(bp->dbg_name, NULL, NULL, FALSE);
675 if (pat != NULL)
676 {
677 bp->dbg_prog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
678 vim_free(pat);
679 }
680 if (pat == NULL || bp->dbg_prog == NULL)
681 vim_free(bp->dbg_name);
682 else
683 {
684 if (bp->dbg_lnum == 0) /* default line number is 1 */
685 bp->dbg_lnum = 1;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000686#ifdef FEAT_PROFILE
687 if (eap->cmdidx != CMD_profile)
688#endif
689 {
690 DEBUGGY(gap, gap->ga_len).dbg_nr = ++last_breakp;
691 ++debug_tick;
692 }
693 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 }
695 }
696}
697
698/*
699 * ":debuggreedy".
700 */
701 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100702ex_debuggreedy(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703{
704 if (eap->addr_count == 0 || eap->line2 != 0)
705 debug_greedy = TRUE;
706 else
707 debug_greedy = FALSE;
708}
709
710/*
Bram Moolenaard9fba312005-06-26 22:34:35 +0000711 * ":breakdel" and ":profdel".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712 */
713 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100714ex_breakdel(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000715{
716 struct debuggy *bp, *bpi;
717 int nr;
718 int todel = -1;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000719 int del_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 int i;
721 linenr_T best_lnum = 0;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000722 garray_T *gap;
723
724 gap = &dbg_breakp;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000725 if (eap->cmdidx == CMD_profdel)
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200726 {
727#ifdef FEAT_PROFILE
Bram Moolenaard9fba312005-06-26 22:34:35 +0000728 gap = &prof_ga;
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200729#else
730 ex_ni(eap);
731 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000732#endif
Bram Moolenaar38bdbd62012-06-20 15:48:57 +0200733 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000734
735 if (vim_isdigit(*eap->arg))
736 {
737 /* ":breakdel {nr}" */
738 nr = atol((char *)eap->arg);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000739 for (i = 0; i < gap->ga_len; ++i)
740 if (DEBUGGY(gap, i).dbg_nr == nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000741 {
742 todel = i;
743 break;
744 }
745 }
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000746 else if (*eap->arg == '*')
747 {
748 todel = 0;
749 del_all = TRUE;
750 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751 else
752 {
753 /* ":breakdel {func|file} [lnum] {name}" */
Bram Moolenaard9fba312005-06-26 22:34:35 +0000754 if (dbg_parsearg(eap->arg, gap) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000755 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000756 bp = &DEBUGGY(gap, gap->ga_len);
757 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000758 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000759 bpi = &DEBUGGY(gap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000760 if (bp->dbg_type == bpi->dbg_type
761 && STRCMP(bp->dbg_name, bpi->dbg_name) == 0
762 && (bp->dbg_lnum == bpi->dbg_lnum
763 || (bp->dbg_lnum == 0
764 && (best_lnum == 0
765 || bpi->dbg_lnum < best_lnum))))
766 {
767 todel = i;
768 best_lnum = bpi->dbg_lnum;
769 }
770 }
771 vim_free(bp->dbg_name);
772 }
773
774 if (todel < 0)
775 EMSG2(_("E161: Breakpoint not found: %s"), eap->arg);
776 else
Bram Moolenaard9fba312005-06-26 22:34:35 +0000777 {
778 while (gap->ga_len > 0)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000779 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000780 vim_free(DEBUGGY(gap, todel).dbg_name);
Bram Moolenaar473de612013-06-08 18:19:48 +0200781 vim_regfree(DEBUGGY(gap, todel).dbg_prog);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000782 --gap->ga_len;
783 if (todel < gap->ga_len)
784 mch_memmove(&DEBUGGY(gap, todel), &DEBUGGY(gap, todel + 1),
785 (gap->ga_len - todel) * sizeof(struct debuggy));
786#ifdef FEAT_PROFILE
787 if (eap->cmdidx == CMD_breakdel)
788#endif
789 ++debug_tick;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000790 if (!del_all)
791 break;
792 }
Bram Moolenaard9fba312005-06-26 22:34:35 +0000793
794 /* If all breakpoints were removed clear the array. */
795 if (gap->ga_len == 0)
796 ga_clear(gap);
797 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798}
799
800/*
801 * ":breaklist".
802 */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000803 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100804ex_breaklist(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805{
806 struct debuggy *bp;
807 int i;
808
809 if (dbg_breakp.ga_len == 0)
810 MSG(_("No breakpoints defined"));
811 else
812 for (i = 0; i < dbg_breakp.ga_len; ++i)
813 {
814 bp = &BREAKP(i);
Bram Moolenaard58ea072011-06-26 04:25:30 +0200815 if (bp->dbg_type == DBG_FILE)
816 home_replace(NULL, bp->dbg_name, NameBuff, MAXPATHL, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 smsg((char_u *)_("%3d %s %s line %ld"),
818 bp->dbg_nr,
819 bp->dbg_type == DBG_FUNC ? "func" : "file",
Bram Moolenaard58ea072011-06-26 04:25:30 +0200820 bp->dbg_type == DBG_FUNC ? bp->dbg_name : NameBuff,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 (long)bp->dbg_lnum);
822 }
823}
824
825/*
826 * Find a breakpoint for a function or sourced file.
827 * Returns line number at which to break; zero when no matching breakpoint.
828 */
829 linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100830dbg_find_breakpoint(
831 int file, /* TRUE for a file, FALSE for a function */
832 char_u *fname, /* file or function name */
833 linenr_T after) /* after this line number */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000834{
Bram Moolenaar05159a02005-02-26 23:04:13 +0000835 return debuggy_find(file, fname, after, &dbg_breakp, NULL);
836}
837
838#if defined(FEAT_PROFILE) || defined(PROTO)
839/*
840 * Return TRUE if profiling is on for a function or sourced file.
841 */
842 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100843has_profiling(
844 int file, /* TRUE for a file, FALSE for a function */
845 char_u *fname, /* file or function name */
846 int *fp) /* return: forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000847{
848 return (debuggy_find(file, fname, (linenr_T)0, &prof_ga, fp)
849 != (linenr_T)0);
850}
851#endif
852
853/*
854 * Common code for dbg_find_breakpoint() and has_profiling().
855 */
856 static linenr_T
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100857debuggy_find(
858 int file, /* TRUE for a file, FALSE for a function */
859 char_u *fname, /* file or function name */
860 linenr_T after, /* after this line number */
861 garray_T *gap, /* either &dbg_breakp or &prof_ga */
862 int *fp) /* if not NULL: return forceit */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000863{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000864 struct debuggy *bp;
865 int i;
866 linenr_T lnum = 0;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 char_u *name = fname;
868 int prev_got_int;
869
Bram Moolenaar05159a02005-02-26 23:04:13 +0000870 /* Return quickly when there are no breakpoints. */
871 if (gap->ga_len == 0)
872 return (linenr_T)0;
873
Bram Moolenaar071d4272004-06-13 20:20:40 +0000874 /* Replace K_SNR in function name with "<SNR>". */
875 if (!file && fname[0] == K_SPECIAL)
876 {
877 name = alloc((unsigned)STRLEN(fname) + 3);
878 if (name == NULL)
879 name = fname;
880 else
881 {
882 STRCPY(name, "<SNR>");
883 STRCPY(name + 5, fname + 3);
884 }
885 }
886
Bram Moolenaar05159a02005-02-26 23:04:13 +0000887 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000889 /* Skip entries that are not useful or are for a line that is beyond
890 * an already found breakpoint. */
891 bp = &DEBUGGY(gap, i);
892 if (((bp->dbg_type == DBG_FILE) == file && (
893#ifdef FEAT_PROFILE
894 gap == &prof_ga ||
895#endif
896 (bp->dbg_lnum > after && (lnum == 0 || bp->dbg_lnum < lnum)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000897 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000898 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000899 * Save the value of got_int and reset it. We don't want a
900 * previous interruption cancel matching, only hitting CTRL-C
901 * while matching should abort it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 */
903 prev_got_int = got_int;
904 got_int = FALSE;
Bram Moolenaardffa5b82014-11-19 16:38:07 +0100905 if (vim_regexec_prog(&bp->dbg_prog, FALSE, name, (colnr_T)0))
Bram Moolenaar05159a02005-02-26 23:04:13 +0000906 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000907 lnum = bp->dbg_lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000908 if (fp != NULL)
909 *fp = bp->dbg_forceit;
910 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000911 got_int |= prev_got_int;
912 }
913 }
914 if (name != fname)
915 vim_free(name);
916
917 return lnum;
918}
919
920/*
921 * Called when a breakpoint was encountered.
922 */
923 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100924dbg_breakpoint(char_u *name, linenr_T lnum)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925{
926 /* We need to check if this line is actually executed in do_one_cmd() */
927 debug_breakpoint_name = name;
928 debug_breakpoint_lnum = lnum;
929}
Bram Moolenaar05159a02005-02-26 23:04:13 +0000930
931
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000932# if defined(FEAT_PROFILE) || defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000933/*
934 * Store the current time in "tm".
935 */
936 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100937profile_start(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000938{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000939# ifdef WIN3264
940 QueryPerformanceCounter(tm);
941# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000942 gettimeofday(tm, NULL);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000943# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000944}
945
946/*
947 * Compute the elapsed time from "tm" till now and store in "tm".
948 */
949 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100950profile_end(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000951{
952 proftime_T now;
953
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000954# ifdef WIN3264
955 QueryPerformanceCounter(&now);
956 tm->QuadPart = now.QuadPart - tm->QuadPart;
957# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000958 gettimeofday(&now, NULL);
959 tm->tv_usec = now.tv_usec - tm->tv_usec;
960 tm->tv_sec = now.tv_sec - tm->tv_sec;
961 if (tm->tv_usec < 0)
962 {
963 tm->tv_usec += 1000000;
964 --tm->tv_sec;
965 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000966# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000967}
968
969/*
970 * Subtract the time "tm2" from "tm".
971 */
972 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100973profile_sub(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000974{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000975# ifdef WIN3264
976 tm->QuadPart -= tm2->QuadPart;
977# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000978 tm->tv_usec -= tm2->tv_usec;
979 tm->tv_sec -= tm2->tv_sec;
980 if (tm->tv_usec < 0)
981 {
982 tm->tv_usec += 1000000;
983 --tm->tv_sec;
984 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000985# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000986}
987
988/*
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000989 * Return a string that represents the time in "tm".
990 * Uses a static buffer!
991 */
992 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100993profile_msg(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000994{
995 static char buf[50];
996
997# ifdef WIN3264
998 LARGE_INTEGER fr;
999
1000 QueryPerformanceFrequency(&fr);
1001 sprintf(buf, "%10.6lf", (double)tm->QuadPart / (double)fr.QuadPart);
1002# else
1003 sprintf(buf, "%3ld.%06ld", (long)tm->tv_sec, (long)tm->tv_usec);
Bram Moolenaar76929292008-01-06 19:07:36 +00001004# endif
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001005 return buf;
1006}
1007
Bram Moolenaar79c2c882016-02-07 21:19:28 +01001008# if defined(FEAT_FLOAT) || defined(PROTO)
1009/*
1010 * Return a float that represents the time in "tm".
1011 */
1012 float_T
1013profile_float(proftime_T *tm)
1014{
1015# ifdef WIN3264
1016 LARGE_INTEGER fr;
1017
1018 QueryPerformanceFrequency(&fr);
1019 return (float_T)tm->QuadPart / (float_T)fr.QuadPart;
1020# else
1021 return (float_T)tm->tv_sec + (float_T)tm->tv_usec / 1000000.0;
1022# endif
1023}
1024# endif
1025
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001026/*
Bram Moolenaar76929292008-01-06 19:07:36 +00001027 * Put the time "msec" past now in "tm".
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001028 */
Bram Moolenaar76929292008-01-06 19:07:36 +00001029 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001030profile_setlimit(long msec, proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001031{
1032 if (msec <= 0) /* no limit */
1033 profile_zero(tm);
1034 else
1035 {
1036# ifdef WIN3264
1037 LARGE_INTEGER fr;
1038
1039 QueryPerformanceCounter(tm);
1040 QueryPerformanceFrequency(&fr);
Bram Moolenaarb3c70982008-01-18 10:40:55 +00001041 tm->QuadPart += (LONGLONG)((double)msec / 1000.0 * (double)fr.QuadPart);
Bram Moolenaar76929292008-01-06 19:07:36 +00001042# else
1043 long usec;
1044
1045 gettimeofday(tm, NULL);
1046 usec = (long)tm->tv_usec + (long)msec * 1000;
1047 tm->tv_usec = usec % 1000000L;
1048 tm->tv_sec += usec / 1000000L;
1049# endif
1050 }
1051}
1052
1053/*
1054 * Return TRUE if the current time is past "tm".
1055 */
1056 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001057profile_passed_limit(proftime_T *tm)
Bram Moolenaar76929292008-01-06 19:07:36 +00001058{
1059 proftime_T now;
1060
1061# ifdef WIN3264
1062 if (tm->QuadPart == 0) /* timer was not set */
1063 return FALSE;
1064 QueryPerformanceCounter(&now);
1065 return (now.QuadPart > tm->QuadPart);
1066# else
1067 if (tm->tv_sec == 0) /* timer was not set */
1068 return FALSE;
1069 gettimeofday(&now, NULL);
1070 return (now.tv_sec > tm->tv_sec
1071 || (now.tv_sec == tm->tv_sec && now.tv_usec > tm->tv_usec));
1072# endif
1073}
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001074
1075/*
1076 * Set the time in "tm" to zero.
1077 */
1078 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001079profile_zero(proftime_T *tm)
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001080{
1081# ifdef WIN3264
1082 tm->QuadPart = 0;
1083# else
1084 tm->tv_usec = 0;
1085 tm->tv_sec = 0;
1086# endif
1087}
1088
Bram Moolenaar76929292008-01-06 19:07:36 +00001089# endif /* FEAT_PROFILE || FEAT_RELTIME */
1090
Bram Moolenaar975b5272016-03-15 23:10:59 +01001091# if defined(FEAT_TIMERS) || defined(PROTO)
1092static timer_T *first_timer = NULL;
1093static int last_timer_id = 0;
1094
1095/*
1096 * Insert a timer in the list of timers.
1097 */
1098 static void
1099insert_timer(timer_T *timer)
1100{
1101 timer->tr_next = first_timer;
1102 timer->tr_prev = NULL;
1103 if (first_timer != NULL)
1104 first_timer->tr_prev = timer;
1105 first_timer = timer;
1106}
1107
1108/*
1109 * Take a timer out of the list of timers.
1110 */
1111 static void
1112remove_timer(timer_T *timer)
1113{
1114 if (timer->tr_prev == NULL)
1115 first_timer = timer->tr_next;
1116 else
1117 timer->tr_prev->tr_next = timer->tr_next;
1118 if (timer->tr_next != NULL)
1119 timer->tr_next->tr_prev = timer->tr_prev;
1120}
1121
1122 static void
1123free_timer(timer_T *timer)
1124{
1125 vim_free(timer->tr_callback);
1126 partial_unref(timer->tr_partial);
1127 vim_free(timer);
1128}
1129
1130/*
1131 * Create a timer and return it. NULL if out of memory.
1132 * Caller should set the callback.
1133 */
1134 timer_T *
1135create_timer(long msec, int repeat)
1136{
1137 timer_T *timer = (timer_T *)alloc_clear(sizeof(timer_T));
1138
1139 if (timer == NULL)
1140 return NULL;
1141 timer->tr_id = ++last_timer_id;
1142 insert_timer(timer);
1143 if (repeat != 0)
1144 {
1145 timer->tr_repeat = repeat - 1;
1146 timer->tr_interval = msec;
1147 }
1148
1149 profile_setlimit(msec, &timer->tr_due);
1150 return timer;
1151}
1152
1153/*
1154 * Invoke the callback of "timer".
1155 */
1156 static void
1157timer_callback(timer_T *timer)
1158{
1159 typval_T rettv;
1160 int dummy;
1161 typval_T argv[2];
1162
1163 argv[0].v_type = VAR_NUMBER;
1164 argv[0].vval.v_number = timer->tr_id;
1165 argv[1].v_type = VAR_UNKNOWN;
1166
1167 call_func(timer->tr_callback, (int)STRLEN(timer->tr_callback),
1168 &rettv, 1, argv, 0L, 0L, &dummy, TRUE,
1169 timer->tr_partial, NULL);
1170 clear_tv(&rettv);
1171}
1172
1173/*
1174 * Call timers that are due.
1175 * Return the time in msec until the next timer is due.
1176 */
1177 long
1178check_due_timer()
1179{
1180 timer_T *timer;
1181 long this_due;
Bram Moolenaar597385a2016-03-16 23:24:43 +01001182 long next_due = -1;
Bram Moolenaar975b5272016-03-15 23:10:59 +01001183 proftime_T now;
1184 int did_one = FALSE;
1185# ifdef WIN3264
1186 LARGE_INTEGER fr;
1187
1188 QueryPerformanceFrequency(&fr);
1189# endif
1190 while (!got_int)
1191 {
1192 profile_start(&now);
1193 next_due = -1;
1194 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1195 {
1196# ifdef WIN3264
1197 this_due = (long)(((double)(timer->tr_due.QuadPart - now.QuadPart)
1198 / (double)fr.QuadPart) * 1000);
1199# else
1200 this_due = (timer->tr_due.tv_sec - now.tv_sec) * 1000
1201 + (timer->tr_due.tv_usec - now.tv_usec) / 1000;
1202# endif
1203 if (this_due <= 1)
1204 {
1205 remove_timer(timer);
1206 timer_callback(timer);
1207 did_one = TRUE;
1208 if (timer->tr_repeat != 0)
1209 {
1210 profile_setlimit(timer->tr_interval, &timer->tr_due);
1211 if (timer->tr_repeat > 0)
1212 --timer->tr_repeat;
1213 insert_timer(timer);
1214 }
1215 else
1216 free_timer(timer);
1217 /* the callback may do anything, start all over */
1218 break;
1219 }
1220 if (next_due == -1 || next_due > this_due)
1221 next_due = this_due;
1222 }
1223 if (timer == NULL)
1224 break;
1225 }
1226
1227 if (did_one)
1228 redraw_after_callback();
1229
1230 return next_due;
1231}
1232
1233/*
1234 * Find a timer by ID. Returns NULL if not found;
1235 */
1236 timer_T *
1237find_timer(int id)
1238{
1239 timer_T *timer;
1240
1241 for (timer = first_timer; timer != NULL; timer = timer->tr_next)
1242 if (timer->tr_id == id)
1243 break;
1244 return timer;
1245}
1246
1247
1248/*
1249 * Stop a timer and delete it.
1250 */
1251 void
1252stop_timer(timer_T *timer)
1253{
1254 remove_timer(timer);
1255 free_timer(timer);
1256}
1257# endif
1258
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001259#if defined(FEAT_SYN_HL) && defined(FEAT_RELTIME) && defined(FEAT_FLOAT)
1260# if defined(HAVE_MATH_H)
1261# include <math.h>
1262# endif
1263
1264/*
1265 * Divide the time "tm" by "count" and store in "tm2".
1266 */
1267 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001268profile_divide(proftime_T *tm, int count, proftime_T *tm2)
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001269{
1270 if (count == 0)
1271 profile_zero(tm2);
1272 else
1273 {
1274# ifdef WIN3264
1275 tm2->QuadPart = tm->QuadPart / count;
1276# else
1277 double usec = (tm->tv_sec * 1000000.0 + tm->tv_usec) / count;
1278
1279 tm2->tv_sec = floor(usec / 1000000.0);
Bram Moolenaara2e14fc2013-06-10 20:10:44 +02001280 tm2->tv_usec = vim_round(usec - (tm2->tv_sec * 1000000.0));
Bram Moolenaar8a7f5a22013-06-06 14:01:46 +02001281# endif
1282 }
1283}
1284#endif
1285
Bram Moolenaar76929292008-01-06 19:07:36 +00001286# if defined(FEAT_PROFILE) || defined(PROTO)
1287/*
1288 * Functions for profiling.
1289 */
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001290static void script_do_profile(scriptitem_T *si);
1291static void script_dump_profile(FILE *fd);
Bram Moolenaar76929292008-01-06 19:07:36 +00001292static proftime_T prof_wait_time;
1293
Bram Moolenaar433f7c82006-03-21 21:29:36 +00001294/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001295 * Add the time "tm2" to "tm".
1296 */
1297 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001298profile_add(proftime_T *tm, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001299{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001300# ifdef WIN3264
1301 tm->QuadPart += tm2->QuadPart;
1302# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001303 tm->tv_usec += tm2->tv_usec;
1304 tm->tv_sec += tm2->tv_sec;
1305 if (tm->tv_usec >= 1000000)
1306 {
1307 tm->tv_usec -= 1000000;
1308 ++tm->tv_sec;
1309 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001310# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001311}
1312
1313/*
Bram Moolenaar1056d982006-03-09 22:37:52 +00001314 * Add the "self" time from the total time and the children's time.
1315 */
1316 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001317profile_self(proftime_T *self, proftime_T *total, proftime_T *children)
Bram Moolenaar1056d982006-03-09 22:37:52 +00001318{
1319 /* Check that the result won't be negative. Can happen with recursive
1320 * calls. */
1321#ifdef WIN3264
1322 if (total->QuadPart <= children->QuadPart)
1323 return;
1324#else
1325 if (total->tv_sec < children->tv_sec
1326 || (total->tv_sec == children->tv_sec
1327 && total->tv_usec <= children->tv_usec))
1328 return;
1329#endif
1330 profile_add(self, total);
1331 profile_sub(self, children);
1332}
1333
1334/*
Bram Moolenaar05159a02005-02-26 23:04:13 +00001335 * Get the current waittime.
1336 */
1337 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001338profile_get_wait(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001339{
1340 *tm = prof_wait_time;
1341}
1342
1343/*
1344 * Subtract the passed waittime since "tm" from "tma".
1345 */
1346 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001347profile_sub_wait(proftime_T *tm, proftime_T *tma)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001348{
1349 proftime_T tm3 = prof_wait_time;
1350
1351 profile_sub(&tm3, tm);
1352 profile_sub(tma, &tm3);
1353}
1354
1355/*
1356 * Return TRUE if "tm1" and "tm2" are equal.
1357 */
1358 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001359profile_equal(proftime_T *tm1, proftime_T *tm2)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001360{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001361# ifdef WIN3264
1362 return (tm1->QuadPart == tm2->QuadPart);
1363# else
Bram Moolenaar05159a02005-02-26 23:04:13 +00001364 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001365# endif
1366}
1367
1368/*
1369 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
1370 */
1371 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001372profile_cmp(const proftime_T *tm1, const proftime_T *tm2)
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001373{
1374# ifdef WIN3264
1375 return (int)(tm2->QuadPart - tm1->QuadPart);
1376# else
1377 if (tm1->tv_sec == tm2->tv_sec)
1378 return tm2->tv_usec - tm1->tv_usec;
1379 return tm2->tv_sec - tm1->tv_sec;
1380# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001381}
1382
Bram Moolenaar05159a02005-02-26 23:04:13 +00001383static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001384static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001385
1386/*
1387 * ":profile cmd args"
1388 */
1389 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001390ex_profile(exarg_T *eap)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001391{
1392 char_u *e;
1393 int len;
1394
1395 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001396 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001397 e = skipwhite(e);
1398
1399 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1400 {
1401 vim_free(profile_fname);
Bram Moolenaard94682f2015-04-13 15:37:56 +02001402 profile_fname = expand_env_save_opt(e, TRUE);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001403 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001404 profile_zero(&prof_wait_time);
1405 set_vim_var_nr(VV_PROFILING, 1L);
1406 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001407 else if (do_profiling == PROF_NONE)
Bram Moolenaar54c1b492010-02-24 14:01:28 +01001408 EMSG(_("E750: First use \":profile start {fname}\""));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001409 else if (STRCMP(eap->arg, "pause") == 0)
1410 {
1411 if (do_profiling == PROF_YES)
1412 profile_start(&pause_time);
1413 do_profiling = PROF_PAUSED;
1414 }
1415 else if (STRCMP(eap->arg, "continue") == 0)
1416 {
1417 if (do_profiling == PROF_PAUSED)
1418 {
1419 profile_end(&pause_time);
1420 profile_add(&prof_wait_time, &pause_time);
1421 }
1422 do_profiling = PROF_YES;
1423 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001424 else
1425 {
1426 /* The rest is similar to ":breakadd". */
1427 ex_breakadd(eap);
1428 }
1429}
1430
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001431/* Command line expansion for :profile. */
1432static enum
1433{
1434 PEXP_SUBCMD, /* expand :profile sub-commands */
Bram Moolenaar49789dc2011-02-25 14:46:09 +01001435 PEXP_FUNC /* expand :profile func {funcname} */
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001436} pexpand_what;
1437
1438static char *pexpand_cmds[] = {
1439 "start",
1440#define PROFCMD_START 0
1441 "pause",
1442#define PROFCMD_PAUSE 1
1443 "continue",
1444#define PROFCMD_CONTINUE 2
1445 "func",
1446#define PROFCMD_FUNC 3
1447 "file",
1448#define PROFCMD_FILE 4
1449 NULL
1450#define PROFCMD_LAST 5
1451};
1452
1453/*
1454 * Function given to ExpandGeneric() to obtain the profile command
1455 * specific expansion.
1456 */
1457 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001458get_profile_name(expand_T *xp UNUSED, int idx)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001459{
1460 switch (pexpand_what)
1461 {
1462 case PEXP_SUBCMD:
1463 return (char_u *)pexpand_cmds[idx];
1464 /* case PEXP_FUNC: TODO */
1465 default:
1466 return NULL;
1467 }
1468}
1469
1470/*
1471 * Handle command line completion for :profile command.
1472 */
1473 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001474set_context_in_profile_cmd(expand_T *xp, char_u *arg)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001475{
1476 char_u *end_subcmd;
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001477
1478 /* Default: expand subcommands. */
1479 xp->xp_context = EXPAND_PROFILE;
1480 pexpand_what = PEXP_SUBCMD;
1481 xp->xp_pattern = arg;
1482
1483 end_subcmd = skiptowhite(arg);
1484 if (*end_subcmd == NUL)
1485 return;
1486
Bram Moolenaar8b9c05f2010-03-02 17:54:33 +01001487 if (end_subcmd - arg == 5 && STRNCMP(arg, "start", 5) == 0)
Bram Moolenaarf86f26c2010-02-03 15:14:22 +01001488 {
1489 xp->xp_context = EXPAND_FILES;
1490 xp->xp_pattern = skipwhite(end_subcmd);
1491 return;
1492 }
1493
1494 /* TODO: expand function names after "func" */
1495 xp->xp_context = EXPAND_NOTHING;
1496}
1497
Bram Moolenaar05159a02005-02-26 23:04:13 +00001498/*
1499 * Dump the profiling info.
1500 */
1501 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001502profile_dump(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001503{
1504 FILE *fd;
1505
1506 if (profile_fname != NULL)
1507 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001508 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001509 if (fd == NULL)
1510 EMSG2(_(e_notopen), profile_fname);
1511 else
1512 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001513 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001514 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001515 fclose(fd);
1516 }
1517 }
1518}
1519
1520/*
1521 * Start profiling script "fp".
1522 */
1523 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001524script_do_profile(scriptitem_T *si)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001525{
1526 si->sn_pr_count = 0;
1527 profile_zero(&si->sn_pr_total);
1528 profile_zero(&si->sn_pr_self);
1529
1530 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1531 si->sn_prl_idx = -1;
1532 si->sn_prof_on = TRUE;
1533 si->sn_pr_nest = 0;
1534}
1535
1536/*
1537 * save time when starting to invoke another script or function.
1538 */
1539 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001540script_prof_save(
1541 proftime_T *tm) /* place to store wait time */
Bram Moolenaar05159a02005-02-26 23:04:13 +00001542{
1543 scriptitem_T *si;
1544
1545 if (current_SID > 0 && current_SID <= script_items.ga_len)
1546 {
1547 si = &SCRIPT_ITEM(current_SID);
1548 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1549 profile_start(&si->sn_pr_child);
1550 }
1551 profile_get_wait(tm);
1552}
1553
1554/*
1555 * Count time spent in children after invoking another script or function.
1556 */
1557 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001558script_prof_restore(proftime_T *tm)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001559{
1560 scriptitem_T *si;
1561
1562 if (current_SID > 0 && current_SID <= script_items.ga_len)
1563 {
1564 si = &SCRIPT_ITEM(current_SID);
1565 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1566 {
1567 profile_end(&si->sn_pr_child);
1568 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1569 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1570 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1571 }
1572 }
1573}
1574
1575static proftime_T inchar_time;
1576
1577/*
1578 * Called when starting to wait for the user to type a character.
1579 */
1580 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001581prof_inchar_enter(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001582{
1583 profile_start(&inchar_time);
1584}
1585
1586/*
1587 * Called when finished waiting for the user to type a character.
1588 */
1589 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001590prof_inchar_exit(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001591{
1592 profile_end(&inchar_time);
1593 profile_add(&prof_wait_time, &inchar_time);
1594}
1595
1596/*
1597 * Dump the profiling results for all scripts in file "fd".
1598 */
1599 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001600script_dump_profile(FILE *fd)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001601{
1602 int id;
1603 scriptitem_T *si;
1604 int i;
1605 FILE *sfd;
1606 sn_prl_T *pp;
1607
1608 for (id = 1; id <= script_items.ga_len; ++id)
1609 {
1610 si = &SCRIPT_ITEM(id);
1611 if (si->sn_prof_on)
1612 {
1613 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1614 if (si->sn_pr_count == 1)
1615 fprintf(fd, "Sourced 1 time\n");
1616 else
1617 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1618 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1619 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1620 fprintf(fd, "\n");
1621 fprintf(fd, "count total (s) self (s)\n");
1622
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001623 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001624 if (sfd == NULL)
1625 fprintf(fd, "Cannot open file!\n");
1626 else
1627 {
1628 for (i = 0; i < si->sn_prl_ga.ga_len; ++i)
1629 {
1630 if (vim_fgets(IObuff, IOSIZE, sfd))
1631 break;
1632 pp = &PRL_ITEM(si, i);
1633 if (pp->snp_count > 0)
1634 {
1635 fprintf(fd, "%5d ", pp->snp_count);
1636 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1637 fprintf(fd, " ");
1638 else
1639 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1640 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1641 }
1642 else
1643 fprintf(fd, " ");
1644 fprintf(fd, "%s", IObuff);
1645 }
1646 fclose(sfd);
1647 }
1648 fprintf(fd, "\n");
1649 }
1650 }
1651}
1652
1653/*
1654 * Return TRUE when a function defined in the current script should be
1655 * profiled.
1656 */
1657 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001658prof_def_func(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001659{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00001660 if (current_SID > 0)
1661 return SCRIPT_ITEM(current_SID).sn_pr_force;
1662 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001663}
1664
1665# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001666#endif
1667
1668/*
1669 * If 'autowrite' option set, try to write the file.
1670 * Careful: autocommands may make "buf" invalid!
1671 *
1672 * return FAIL for failure, OK otherwise
1673 */
1674 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001675autowrite(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676{
Bram Moolenaar373154b2007-02-13 05:19:30 +00001677 int r;
1678
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 if (!(p_aw || p_awa) || !p_write
1680#ifdef FEAT_QUICKFIX
Bram Moolenaar373154b2007-02-13 05:19:30 +00001681 /* never autowrite a "nofile" or "nowrite" buffer */
1682 || bt_dontwrite(buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683#endif
Bram Moolenaar373154b2007-02-13 05:19:30 +00001684 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001685 return FAIL;
Bram Moolenaar373154b2007-02-13 05:19:30 +00001686 r = buf_write_all(buf, forceit);
1687
1688 /* Writing may succeed but the buffer still changed, e.g., when there is a
1689 * conversion error. We do want to return FAIL then. */
1690 if (buf_valid(buf) && bufIsChanged(buf))
1691 r = FAIL;
1692 return r;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693}
1694
1695/*
1696 * flush all buffers, except the ones that are readonly
1697 */
1698 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001699autowrite_all(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700{
1701 buf_T *buf;
1702
1703 if (!(p_aw || p_awa) || !p_write)
1704 return;
1705 for (buf = firstbuf; buf; buf = buf->b_next)
1706 if (bufIsChanged(buf) && !buf->b_p_ro)
1707 {
1708 (void)buf_write_all(buf, FALSE);
1709#ifdef FEAT_AUTOCMD
1710 /* an autocommand may have deleted the buffer */
1711 if (!buf_valid(buf))
1712 buf = firstbuf;
1713#endif
1714 }
1715}
1716
1717/*
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001718 * Return TRUE if buffer was changed and cannot be abandoned.
1719 * For flags use the CCGD_ values.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001722check_changed(buf_T *buf, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723{
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001724 int forceit = (flags & CCGD_FORCEIT);
1725
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 if ( !forceit
1727 && bufIsChanged(buf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001728 && ((flags & CCGD_MULTWIN) || buf->b_nwindows <= 1)
1729 && (!(flags & CCGD_AW) || autowrite(buf, forceit) == FAIL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 {
1731#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1732 if ((p_confirm || cmdmod.confirm) && p_write)
1733 {
1734 buf_T *buf2;
1735 int count = 0;
1736
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001737 if (flags & CCGD_ALLBUF)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001738 for (buf2 = firstbuf; buf2 != NULL; buf2 = buf2->b_next)
1739 if (bufIsChanged(buf2)
1740 && (buf2->b_ffname != NULL
1741# ifdef FEAT_BROWSE
1742 || cmdmod.browse
1743# endif
1744 ))
1745 ++count;
1746# ifdef FEAT_AUTOCMD
1747 if (!buf_valid(buf))
1748 /* Autocommand deleted buffer, oops! It's not changed now. */
1749 return FALSE;
1750# endif
1751 dialog_changed(buf, count > 1);
1752# ifdef FEAT_AUTOCMD
1753 if (!buf_valid(buf))
1754 /* Autocommand deleted buffer, oops! It's not changed now. */
1755 return FALSE;
1756# endif
1757 return bufIsChanged(buf);
1758 }
1759#endif
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001760 if (flags & CCGD_EXCMD)
1761 EMSG(_(e_nowrtmsg));
1762 else
1763 EMSG(_(e_nowrtmsg_nobang));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 return TRUE;
1765 }
1766 return FALSE;
1767}
1768
1769#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
1770
1771#if defined(FEAT_BROWSE) || defined(PROTO)
1772/*
1773 * When wanting to write a file without a file name, ask the user for a name.
1774 */
1775 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001776browse_save_fname(buf_T *buf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001777{
1778 if (buf->b_fname == NULL)
1779 {
1780 char_u *fname;
1781
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001782 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
1783 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 if (fname != NULL)
1785 {
1786 if (setfname(buf, fname, NULL, TRUE) == OK)
1787 buf->b_flags |= BF_NOTEDITED;
1788 vim_free(fname);
1789 }
1790 }
1791}
1792#endif
1793
1794/*
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02001795 * Ask the user what to do when abandoning a changed buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 * Must check 'write' option first!
1797 */
1798 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001799dialog_changed(
1800 buf_T *buf,
1801 int checkall) /* may abandon all changed buffers */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802{
Bram Moolenaard9462e32011-04-11 21:35:11 +02001803 char_u buff[DIALOG_MSG_SIZE];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 int ret;
1805 buf_T *buf2;
Bram Moolenaar8218f602012-04-25 17:32:18 +02001806 exarg_T ea;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00001808 dialog_msg(buff, _("Save changes to \"%s\"?"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 (buf->b_fname != NULL) ?
1810 buf->b_fname : (char_u *)_("Untitled"));
1811 if (checkall)
1812 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
1813 else
1814 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
1815
Bram Moolenaar8218f602012-04-25 17:32:18 +02001816 /* Init ea pseudo-structure, this is needed for the check_overwrite()
1817 * function. */
1818 ea.append = ea.forceit = FALSE;
1819
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 if (ret == VIM_YES)
1821 {
1822#ifdef FEAT_BROWSE
1823 /* May get file name, when there is none */
1824 browse_save_fname(buf);
1825#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02001826 if (buf->b_fname != NULL && check_overwrite(&ea, buf,
1827 buf->b_fname, buf->b_ffname, FALSE) == OK)
1828 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 (void)buf_write_all(buf, FALSE);
1830 }
1831 else if (ret == VIM_NO)
1832 {
1833 unchanged(buf, TRUE);
1834 }
1835 else if (ret == VIM_ALL)
1836 {
1837 /*
1838 * Write all modified files that can be written.
1839 * Skip readonly buffers, these need to be confirmed
1840 * individually.
1841 */
1842 for (buf2 = firstbuf; buf2 != NULL; buf2 = buf2->b_next)
1843 {
1844 if (bufIsChanged(buf2)
1845 && (buf2->b_ffname != NULL
1846#ifdef FEAT_BROWSE
1847 || cmdmod.browse
1848#endif
1849 )
1850 && !buf2->b_p_ro)
1851 {
1852#ifdef FEAT_BROWSE
1853 /* May get file name, when there is none */
1854 browse_save_fname(buf2);
1855#endif
Bram Moolenaar8218f602012-04-25 17:32:18 +02001856 if (buf2->b_fname != NULL && check_overwrite(&ea, buf2,
1857 buf2->b_fname, buf2->b_ffname, FALSE) == OK)
1858 /* didn't hit Cancel */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859 (void)buf_write_all(buf2, FALSE);
1860#ifdef FEAT_AUTOCMD
1861 /* an autocommand may have deleted the buffer */
1862 if (!buf_valid(buf2))
1863 buf2 = firstbuf;
1864#endif
1865 }
1866 }
1867 }
1868 else if (ret == VIM_DISCARDALL)
1869 {
1870 /*
1871 * mark all buffers as unchanged
1872 */
1873 for (buf2 = firstbuf; buf2 != NULL; buf2 = buf2->b_next)
1874 unchanged(buf2, TRUE);
1875 }
1876}
1877#endif
1878
1879/*
1880 * Return TRUE if the buffer "buf" can be abandoned, either by making it
1881 * hidden, autowriting it or unloading it.
1882 */
1883 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001884can_abandon(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885{
1886 return ( P_HID(buf)
1887 || !bufIsChanged(buf)
1888 || buf->b_nwindows > 1
1889 || autowrite(buf, forceit) == OK
1890 || forceit);
1891}
1892
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01001893static void add_bufnum(int *bufnrs, int *bufnump, int nr);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001894
1895/*
1896 * Add a buffer number to "bufnrs", unless it's already there.
1897 */
1898 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001899add_bufnum(int *bufnrs, int *bufnump, int nr)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001900{
1901 int i;
1902
1903 for (i = 0; i < *bufnump; ++i)
1904 if (bufnrs[i] == nr)
1905 return;
1906 bufnrs[*bufnump] = nr;
1907 *bufnump = *bufnump + 1;
1908}
1909
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910/*
1911 * Return TRUE if any buffer was changed and cannot be abandoned.
1912 * That changed buffer becomes the current buffer.
Bram Moolenaar027387f2016-01-02 22:25:52 +01001913 * When "unload" is true the current buffer is unloaded instead of making it
1914 * hidden. This is used for ":q!".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915 */
1916 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001917check_changed_any(
1918 int hidden, /* Only check hidden buffers */
1919 int unload)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920{
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001921 int ret = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922 buf_T *buf;
1923 int save;
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001924 int i;
1925 int bufnum = 0;
1926 int bufcount = 0;
1927 int *bufnrs;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928#ifdef FEAT_WINDOWS
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001929 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 win_T *wp;
1931#endif
1932
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001933 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1934 ++bufcount;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001936 if (bufcount == 0)
1937 return FALSE;
1938
1939 bufnrs = (int *)alloc(sizeof(int) * bufcount);
1940 if (bufnrs == NULL)
1941 return FALSE;
1942
1943 /* curbuf */
1944 bufnrs[bufnum++] = curbuf->b_fnum;
1945#ifdef FEAT_WINDOWS
1946 /* buf in curtab */
1947 FOR_ALL_WINDOWS(wp)
1948 if (wp->w_buffer != curbuf)
1949 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
1950
1951 /* buf in other tab */
1952 for (tp = first_tabpage; tp != NULL; tp = tp->tp_next)
1953 if (tp != curtab)
1954 for (wp = tp->tp_firstwin; wp != NULL; wp = wp->w_next)
1955 add_bufnum(bufnrs, &bufnum, wp->w_buffer->b_fnum);
1956#endif
1957 /* any other buf */
1958 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1959 add_bufnum(bufnrs, &bufnum, buf->b_fnum);
1960
1961 for (i = 0; i < bufnum; ++i)
1962 {
1963 buf = buflist_findnr(bufnrs[i]);
1964 if (buf == NULL)
1965 continue;
1966 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
1967 {
1968 /* Try auto-writing the buffer. If this fails but the buffer no
1969 * longer exists it's not changed, that's OK. */
Bram Moolenaar45d3b142013-11-09 03:31:51 +01001970 if (check_changed(buf, (p_awa ? CCGD_AW : 0)
1971 | CCGD_MULTWIN
1972 | CCGD_ALLBUF) && buf_valid(buf))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001973 break; /* didn't save - still changes */
1974 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975 }
1976
Bram Moolenaar970a1b82012-03-23 18:39:18 +01001977 if (i >= bufnum)
1978 goto theend;
1979
1980 ret = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 exiting = FALSE;
1982#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1983 /*
1984 * When ":confirm" used, don't give an error message.
1985 */
1986 if (!(p_confirm || cmdmod.confirm))
1987#endif
1988 {
1989 /* There must be a wait_return for this message, do_buffer()
1990 * may cause a redraw. But wait_return() is a no-op when vgetc()
1991 * is busy (Quit used from window menu), then make sure we don't
1992 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00001993 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994 {
1995 msg_row = cmdline_row;
1996 msg_col = 0;
1997 msg_didout = FALSE;
1998 }
1999 if (EMSG2(_("E162: No write since last change for buffer \"%s\""),
Bram Moolenaare1704ba2012-10-03 18:25:00 +02002000 buf_spname(buf) != NULL ? buf_spname(buf) : buf->b_fname))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002001 {
2002 save = no_wait_return;
2003 no_wait_return = FALSE;
2004 wait_return(FALSE);
2005 no_wait_return = save;
2006 }
2007 }
2008
2009#ifdef FEAT_WINDOWS
2010 /* Try to find a window that contains the buffer. */
2011 if (buf != curbuf)
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002012 FOR_ALL_TAB_WINDOWS(tp, wp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 if (wp->w_buffer == buf)
2014 {
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002015 goto_tabpage_win(tp, wp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016# ifdef FEAT_AUTOCMD
2017 /* Paranoia: did autocms wipe out the buffer with changes? */
2018 if (!buf_valid(buf))
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002019 {
2020 goto theend;
2021 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002022# endif
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002023 goto buf_found;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 }
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002025buf_found:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026#endif
2027
2028 /* Open the changed buffer in the current window. */
2029 if (buf != curbuf)
Bram Moolenaar027387f2016-01-02 22:25:52 +01002030 set_curbuf(buf, unload ? DOBUF_UNLOAD : DOBUF_GOTO);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031
Bram Moolenaar970a1b82012-03-23 18:39:18 +01002032theend:
2033 vim_free(bufnrs);
2034 return ret;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035}
2036
2037/*
2038 * return FAIL if there is no file name, OK if there is one
2039 * give error message for FAIL
2040 */
2041 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002042check_fname(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043{
2044 if (curbuf->b_ffname == NULL)
2045 {
2046 EMSG(_(e_noname));
2047 return FAIL;
2048 }
2049 return OK;
2050}
2051
2052/*
2053 * flush the contents of a buffer, unless it has no file name
2054 *
2055 * return FAIL for failure, OK otherwise
2056 */
2057 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002058buf_write_all(buf_T *buf, int forceit)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002059{
2060 int retval;
2061#ifdef FEAT_AUTOCMD
2062 buf_T *old_curbuf = curbuf;
2063#endif
2064
2065 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
2066 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
2067 FALSE, forceit, TRUE, FALSE));
2068#ifdef FEAT_AUTOCMD
2069 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002070 {
2071 msg_source(hl_attr(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002072 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00002073 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002074#endif
2075 return retval;
2076}
2077
2078/*
2079 * Code to handle the argument list.
2080 */
2081
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002082static char_u *do_one_arg(char_u *str);
2083static int do_arglist(char_u *str, int what, int after);
2084static void alist_check_arg_idx(void);
2085static int editing_arg_idx(win_T *win);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002086#ifdef FEAT_LISTCMDS
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01002087static int alist_add_list(int count, char_u **files, int after);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002088#endif
2089#define AL_SET 1
2090#define AL_ADD 2
2091#define AL_DEL 3
2092
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002094 * Isolate one argument, taking backticks.
2095 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 * Return a pointer to the start of the next argument.
2097 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002098 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002099do_one_arg(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100{
2101 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002102 int inbacktick;
2103
Bram Moolenaar071d4272004-06-13 20:20:40 +00002104 inbacktick = FALSE;
2105 for (p = str; *str; ++str)
2106 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002107 /* When the backslash is used for escaping the special meaning of a
2108 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 if (rem_backslash(str))
2110 {
2111 *p++ = *str++;
2112 *p++ = *str;
2113 }
2114 else
2115 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002116 /* An item ends at a space not in backticks */
2117 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002118 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002119 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00002120 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002121 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 }
2123 }
2124 str = skipwhite(str);
2125 *p = NUL;
2126
2127 return str;
2128}
2129
Bram Moolenaar86b68352004-12-27 21:59:20 +00002130/*
2131 * Separate the arguments in "str" and return a list of pointers in the
2132 * growarray "gap".
2133 */
2134 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002135get_arglist(garray_T *gap, char_u *str)
Bram Moolenaar86b68352004-12-27 21:59:20 +00002136{
2137 ga_init2(gap, (int)sizeof(char_u *), 20);
2138 while (*str != NUL)
2139 {
2140 if (ga_grow(gap, 1) == FAIL)
2141 {
2142 ga_clear(gap);
2143 return FAIL;
2144 }
2145 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
2146
2147 /* Isolate one argument, change it in-place, put a NUL after it. */
2148 str = do_one_arg(str);
2149 }
2150 return OK;
2151}
2152
Bram Moolenaar7df351e2006-01-23 22:30:28 +00002153#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002154/*
2155 * Parse a list of arguments (file names), expand them and return in
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002156 * "fnames[fcountp]". When "wig" is TRUE, removes files matching 'wildignore'.
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002157 * Return FAIL or OK.
2158 */
2159 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002160get_arglist_exp(
2161 char_u *str,
2162 int *fcountp,
2163 char_u ***fnamesp,
2164 int wig)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002165{
2166 garray_T ga;
2167 int i;
2168
2169 if (get_arglist(&ga, str) == FAIL)
2170 return FAIL;
Bram Moolenaar8f5c6f02012-06-29 12:57:06 +02002171 if (wig == TRUE)
2172 i = expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2173 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2174 else
2175 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
2176 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
2177
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002178 ga_clear(&ga);
2179 return i;
2180}
2181#endif
2182
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
2184/*
2185 * Redefine the argument list.
2186 */
2187 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002188set_arglist(char_u *str)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002189{
2190 do_arglist(str, AL_SET, 0);
2191}
2192#endif
2193
2194/*
2195 * "what" == AL_SET: Redefine the argument list to 'str'.
2196 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
2197 * "what" == AL_DEL: remove files in 'str' from the argument list.
2198 *
2199 * Return FAIL for failure, OK otherwise.
2200 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002201 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002202do_arglist(
2203 char_u *str,
Bram Moolenaarf1d25012016-03-03 12:22:53 +01002204 int what,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002205 int after UNUSED) /* 0 means before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206{
2207 garray_T new_ga;
2208 int exp_count;
2209 char_u **exp_files;
2210 int i;
2211#ifdef FEAT_LISTCMDS
2212 char_u *p;
2213 int match;
2214#endif
2215
2216 /*
Bram Moolenaar2faa29f2016-01-23 23:02:34 +01002217 * Set default argument for ":argadd" command.
2218 */
2219 if (what == AL_ADD && *str == NUL)
2220 {
2221 if (curbuf->b_ffname == NULL)
2222 return FAIL;
2223 str = curbuf->b_fname;
2224 }
2225
2226 /*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 * Collect all file name arguments in "new_ga".
2228 */
Bram Moolenaar86b68352004-12-27 21:59:20 +00002229 if (get_arglist(&new_ga, str) == FAIL)
2230 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002231
2232#ifdef FEAT_LISTCMDS
2233 if (what == AL_DEL)
2234 {
2235 regmatch_T regmatch;
2236 int didone;
2237
2238 /*
2239 * Delete the items: use each item as a regexp and find a match in the
2240 * argument list.
2241 */
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01002242 regmatch.rm_ic = p_fic; /* ignore case when 'fileignorecase' is set */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
2244 {
2245 p = ((char_u **)new_ga.ga_data)[i];
2246 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
2247 if (p == NULL)
2248 break;
2249 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
2250 if (regmatch.regprog == NULL)
2251 {
2252 vim_free(p);
2253 break;
2254 }
2255
2256 didone = FALSE;
2257 for (match = 0; match < ARGCOUNT; ++match)
2258 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
2259 (colnr_T)0))
2260 {
2261 didone = TRUE;
2262 vim_free(ARGLIST[match].ae_fname);
2263 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
2264 (ARGCOUNT - match - 1) * sizeof(aentry_T));
2265 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002266 if (curwin->w_arg_idx > match)
2267 --curwin->w_arg_idx;
2268 --match;
2269 }
2270
Bram Moolenaar473de612013-06-08 18:19:48 +02002271 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002272 vim_free(p);
2273 if (!didone)
2274 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
2275 }
2276 ga_clear(&new_ga);
2277 }
2278 else
2279#endif
2280 {
2281 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
2282 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
2283 ga_clear(&new_ga);
Bram Moolenaar2db5c3b2016-01-16 22:49:34 +01002284 if (i == FAIL || exp_count == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 {
2286 EMSG(_(e_nomatch));
2287 return FAIL;
2288 }
2289
2290#ifdef FEAT_LISTCMDS
2291 if (what == AL_ADD)
2292 {
2293 (void)alist_add_list(exp_count, exp_files, after);
2294 vim_free(exp_files);
2295 }
2296 else /* what == AL_SET */
2297#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00002298 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 }
2300
2301 alist_check_arg_idx();
2302
2303 return OK;
2304}
2305
2306/*
2307 * Check the validity of the arg_idx for each other window.
2308 */
2309 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002310alist_check_arg_idx(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002311{
2312#ifdef FEAT_WINDOWS
2313 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00002314 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315
Bram Moolenaarf740b292006-02-16 22:11:02 +00002316 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 if (win->w_alist == curwin->w_alist)
2318 check_arg_idx(win);
2319#else
2320 check_arg_idx(curwin);
2321#endif
2322}
2323
2324/*
Bram Moolenaarb8ff1fb2012-02-04 21:59:01 +01002325 * Return TRUE if window "win" is editing the file at the current argument
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002326 * index.
2327 */
2328 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002329editing_arg_idx(win_T *win)
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002330{
2331 return !(win->w_arg_idx >= WARGCOUNT(win)
2332 || (win->w_buffer->b_fnum
2333 != WARGLIST(win)[win->w_arg_idx].ae_fnum
2334 && (win->w_buffer->b_ffname == NULL
2335 || !(fullpathcmp(
2336 alist_name(&WARGLIST(win)[win->w_arg_idx]),
2337 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
2338}
2339
2340/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 * Check if window "win" is editing the w_arg_idx file in its argument list.
2342 */
2343 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002344check_arg_idx(win_T *win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002346 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347 {
2348 /* We are not editing the current entry in the argument list.
2349 * Set "arg_had_last" if we are editing the last one. */
2350 win->w_arg_idx_invalid = TRUE;
2351 if (win->w_arg_idx != WARGCOUNT(win) - 1
2352 && arg_had_last == FALSE
2353#ifdef FEAT_WINDOWS
2354 && ALIST(win) == &global_alist
2355#endif
2356 && GARGCOUNT > 0
2357 && win->w_arg_idx < GARGCOUNT
2358 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
2359 || (win->w_buffer->b_ffname != NULL
2360 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
2361 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
2362 arg_had_last = TRUE;
2363 }
2364 else
2365 {
2366 /* We are editing the current entry in the argument list.
2367 * Set "arg_had_last" if it's also the last one */
2368 win->w_arg_idx_invalid = FALSE;
2369 if (win->w_arg_idx == WARGCOUNT(win) - 1
2370#ifdef FEAT_WINDOWS
2371 && win->w_alist == &global_alist
2372#endif
2373 )
2374 arg_had_last = TRUE;
2375 }
2376}
2377
2378/*
2379 * ":args", ":argslocal" and ":argsglobal".
2380 */
2381 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002382ex_args(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383{
2384 int i;
2385
2386 if (eap->cmdidx != CMD_args)
2387 {
2388#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2389 alist_unlink(ALIST(curwin));
2390 if (eap->cmdidx == CMD_argglobal)
2391 ALIST(curwin) = &global_alist;
2392 else /* eap->cmdidx == CMD_arglocal */
2393 alist_new();
2394#else
2395 ex_ni(eap);
2396 return;
2397#endif
2398 }
2399
2400 if (!ends_excmd(*eap->arg))
2401 {
2402 /*
2403 * ":args file ..": define new argument list, handle like ":next"
2404 * Also for ":argslocal file .." and ":argsglobal file ..".
2405 */
2406 ex_next(eap);
2407 }
2408 else
2409#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2410 if (eap->cmdidx == CMD_args)
2411#endif
2412 {
2413 /*
2414 * ":args": list arguments.
2415 */
2416 if (ARGCOUNT > 0)
2417 {
2418 /* Overwrite the command, for a short list there is no scrolling
2419 * required and no wait_return(). */
2420 gotocmdline(TRUE);
2421 for (i = 0; i < ARGCOUNT; ++i)
2422 {
2423 if (i == curwin->w_arg_idx)
2424 msg_putchar('[');
2425 msg_outtrans(alist_name(&ARGLIST[i]));
2426 if (i == curwin->w_arg_idx)
2427 msg_putchar(']');
2428 msg_putchar(' ');
2429 }
2430 }
2431 }
2432#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
2433 else if (eap->cmdidx == CMD_arglocal)
2434 {
2435 garray_T *gap = &curwin->w_alist->al_ga;
2436
2437 /*
2438 * ":argslocal": make a local copy of the global argument list.
2439 */
2440 if (ga_grow(gap, GARGCOUNT) == OK)
2441 for (i = 0; i < GARGCOUNT; ++i)
2442 if (GARGLIST[i].ae_fname != NULL)
2443 {
2444 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
2445 vim_strsave(GARGLIST[i].ae_fname);
2446 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
2447 GARGLIST[i].ae_fnum;
2448 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 }
2450 }
2451#endif
2452}
2453
2454/*
2455 * ":previous", ":sprevious", ":Next" and ":sNext".
2456 */
2457 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002458ex_previous(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459{
2460 /* If past the last one already, go to the last one. */
2461 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
2462 do_argfile(eap, ARGCOUNT - 1);
2463 else
2464 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
2465}
2466
2467/*
2468 * ":rewind", ":first", ":sfirst" and ":srewind".
2469 */
2470 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002471ex_rewind(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472{
2473 do_argfile(eap, 0);
2474}
2475
2476/*
2477 * ":last" and ":slast".
2478 */
2479 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002480ex_last(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481{
2482 do_argfile(eap, ARGCOUNT - 1);
2483}
2484
2485/*
2486 * ":argument" and ":sargument".
2487 */
2488 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002489ex_argument(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490{
2491 int i;
2492
2493 if (eap->addr_count > 0)
2494 i = eap->line2 - 1;
2495 else
2496 i = curwin->w_arg_idx;
2497 do_argfile(eap, i);
2498}
2499
2500/*
2501 * Edit file "argn" of the argument lists.
2502 */
2503 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002504do_argfile(exarg_T *eap, int argn)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505{
2506 int other;
2507 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002508 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509
2510 if (argn < 0 || argn >= ARGCOUNT)
2511 {
2512 if (ARGCOUNT <= 1)
2513 EMSG(_("E163: There is only one file to edit"));
2514 else if (argn < 0)
2515 EMSG(_("E164: Cannot go before first file"));
2516 else
2517 EMSG(_("E165: Cannot go beyond last file"));
2518 }
2519 else
2520 {
2521 setpcmark();
2522#ifdef FEAT_GUI
2523 need_mouse_correct = TRUE;
2524#endif
2525
2526#ifdef FEAT_WINDOWS
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002527 /* split window or create new tab page first */
2528 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002529 {
2530 if (win_split(0, 0) == FAIL)
2531 return;
Bram Moolenaar3368ea22010-09-21 16:56:35 +02002532 RESET_BINDING(curwin);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002533 }
2534 else
2535#endif
2536 {
2537 /*
2538 * if 'hidden' set, only check for changed file when re-editing
2539 * the same buffer
2540 */
2541 other = TRUE;
2542 if (P_HID(curbuf))
2543 {
2544 p = fix_fname(alist_name(&ARGLIST[argn]));
2545 other = otherfile(p);
2546 vim_free(p);
2547 }
2548 if ((!P_HID(curbuf) || !other)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002549 && check_changed(curbuf, CCGD_AW
2550 | (other ? 0 : CCGD_MULTWIN)
2551 | (eap->forceit ? CCGD_FORCEIT : 0)
2552 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 return;
2554 }
2555
2556 curwin->w_arg_idx = argn;
2557 if (argn == ARGCOUNT - 1
2558#ifdef FEAT_WINDOWS
2559 && curwin->w_alist == &global_alist
2560#endif
2561 )
2562 arg_had_last = TRUE;
2563
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002564 /* Edit the file; always use the last known line number.
2565 * When it fails (e.g. Abort for already edited file) restore the
2566 * argument index. */
2567 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002568 eap, ECMD_LAST,
Bram Moolenaar701f7af2008-11-15 13:12:07 +00002569 (P_HID(curwin->w_buffer) ? ECMD_HIDE : 0)
2570 + (eap->forceit ? ECMD_FORCEIT : 0), curwin) == FAIL)
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002571 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002573 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 setmark('\'');
2575 }
2576}
2577
2578/*
2579 * ":next", and commands that behave like it.
2580 */
2581 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002582ex_next(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583{
2584 int i;
2585
2586 /*
2587 * check for changed buffer now, if this fails the argument list is not
2588 * redefined.
2589 */
2590 if ( P_HID(curbuf)
2591 || eap->cmdidx == CMD_snext
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002592 || !check_changed(curbuf, CCGD_AW
2593 | (eap->forceit ? CCGD_FORCEIT : 0)
2594 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 {
2596 if (*eap->arg != NUL) /* redefine file list */
2597 {
2598 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2599 return;
2600 i = 0;
2601 }
2602 else
2603 i = curwin->w_arg_idx + (int)eap->line2;
2604 do_argfile(eap, i);
2605 }
2606}
2607
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002608#if defined(FEAT_LISTCMDS) || defined(PROTO)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609/*
2610 * ":argedit"
2611 */
2612 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002613ex_argedit(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614{
2615 int fnum;
2616 int i;
2617 char_u *s;
2618
2619 /* Add the argument to the buffer list and get the buffer number. */
2620 fnum = buflist_add(eap->arg, BLN_LISTED);
2621
2622 /* Check if this argument is already in the argument list. */
2623 for (i = 0; i < ARGCOUNT; ++i)
2624 if (ARGLIST[i].ae_fnum == fnum)
2625 break;
2626 if (i == ARGCOUNT)
2627 {
2628 /* Can't find it, add it to the argument list. */
2629 s = vim_strsave(eap->arg);
2630 if (s == NULL)
2631 return;
2632 i = alist_add_list(1, &s,
2633 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2634 if (i < 0)
2635 return;
2636 curwin->w_arg_idx = i;
2637 }
2638
2639 alist_check_arg_idx();
2640
2641 /* Edit the argument. */
2642 do_argfile(eap, i);
2643}
2644
2645/*
2646 * ":argadd"
2647 */
2648 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002649ex_argadd(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650{
2651 do_arglist(eap->arg, AL_ADD,
2652 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2653#ifdef FEAT_TITLE
2654 maketitle();
2655#endif
2656}
2657
2658/*
2659 * ":argdelete"
2660 */
2661 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002662ex_argdelete(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002663{
2664 int i;
2665 int n;
2666
2667 if (eap->addr_count > 0)
2668 {
2669 /* ":1,4argdel": Delete all arguments in the range. */
2670 if (eap->line2 > ARGCOUNT)
2671 eap->line2 = ARGCOUNT;
2672 n = eap->line2 - eap->line1 + 1;
2673 if (*eap->arg != NUL || n <= 0)
2674 EMSG(_(e_invarg));
2675 else
2676 {
2677 for (i = eap->line1; i <= eap->line2; ++i)
2678 vim_free(ARGLIST[i - 1].ae_fname);
2679 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
2680 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
2681 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002682 if (curwin->w_arg_idx >= eap->line2)
2683 curwin->w_arg_idx -= n;
2684 else if (curwin->w_arg_idx > eap->line1)
2685 curwin->w_arg_idx = eap->line1;
Bram Moolenaar72defda2016-01-17 18:04:33 +01002686 if (ARGCOUNT == 0)
2687 curwin->w_arg_idx = 0;
2688 else if (curwin->w_arg_idx >= ARGCOUNT)
2689 curwin->w_arg_idx = ARGCOUNT - 1;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690 }
2691 }
2692 else if (*eap->arg == NUL)
2693 EMSG(_(e_argreq));
2694 else
2695 do_arglist(eap->arg, AL_DEL, 0);
2696#ifdef FEAT_TITLE
2697 maketitle();
2698#endif
2699}
2700
2701/*
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002702 * ":argdo", ":windo", ":bufdo", ":tabdo", ":cdo", ":ldo", ":cfdo" and ":lfdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 */
2704 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002705ex_listdo(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706{
2707 int i;
2708#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002709 win_T *wp;
2710 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711#endif
Bram Moolenaare25bb902015-02-27 20:33:37 +01002712 buf_T *buf = curbuf;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002713 int next_fnum = 0;
2714#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
2715 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002717 char_u *p_shm_save;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002718#ifdef FEAT_QUICKFIX
Bram Moolenaared84b762015-09-09 22:35:29 +02002719 int qf_size = 0;
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002720 int qf_idx;
2721#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722
2723#ifndef FEAT_WINDOWS
2724 if (eap->cmdidx == CMD_windo)
2725 {
2726 ex_ni(eap);
2727 return;
2728 }
2729#endif
2730
Bram Moolenaar0106e3d2016-02-23 18:55:43 +01002731#ifndef FEAT_QUICKFIX
2732 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo ||
2733 eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2734 {
2735 ex_ni(eap);
2736 return;
2737 }
2738#endif
2739
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002741 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00002742 /* Don't do syntax HL autocommands. Skipping the syntax file is a
2743 * great speed improvement. */
2744 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002745#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02002746#ifdef FEAT_CLIPBOARD
2747 start_global_changes();
2748#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749
2750 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002751 || eap->cmdidx == CMD_tabdo
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 || P_HID(curbuf)
Bram Moolenaar45d3b142013-11-09 03:31:51 +01002753 || !check_changed(curbuf, CCGD_AW
2754 | (eap->forceit ? CCGD_FORCEIT : 0)
2755 | CCGD_EXCMD))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002756 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 i = 0;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002758 /* start at the eap->line1 argument/window/buffer */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002759#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002760 wp = firstwin;
2761 tp = first_tabpage;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762#endif
Bram Moolenaara162bc52015-01-07 16:54:21 +01002763 switch (eap->cmdidx)
2764 {
2765#ifdef FEAT_WINDOWS
2766 case CMD_windo:
2767 for ( ; wp != NULL && i + 1 < eap->line1; wp = wp->w_next)
2768 i++;
2769 break;
2770 case CMD_tabdo:
2771 for( ; tp != NULL && i + 1 < eap->line1; tp = tp->tp_next)
2772 i++;
2773 break;
2774#endif
2775 case CMD_argdo:
2776 i = eap->line1 - 1;
2777 break;
Bram Moolenaara162bc52015-01-07 16:54:21 +01002778 default:
2779 break;
2780 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002781 /* set pcmark now */
2782 if (eap->cmdidx == CMD_bufdo)
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002783 {
Bram Moolenaare25bb902015-02-27 20:33:37 +01002784 /* Advance to the first listed buffer after "eap->line1". */
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002785 for (buf = firstbuf; buf != NULL && (buf->b_fnum < eap->line1
Bram Moolenaare25bb902015-02-27 20:33:37 +01002786 || !buf->b_p_bl); buf = buf->b_next)
2787 if (buf->b_fnum > eap->line2)
2788 {
2789 buf = NULL;
2790 break;
2791 }
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002792 if (buf != NULL)
Bram Moolenaare25bb902015-02-27 20:33:37 +01002793 goto_buffer(eap, DOBUF_FIRST, FORWARD, buf->b_fnum);
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002794 }
2795#ifdef FEAT_QUICKFIX
2796 else if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
2797 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2798 {
2799 qf_size = qf_get_size(eap);
2800 if (qf_size <= 0 || eap->line1 > qf_size)
2801 buf = NULL;
2802 else
2803 {
2804 ex_cc(eap);
2805
2806 buf = curbuf;
2807 i = eap->line1 - 1;
2808 if (eap->addr_count <= 0)
2809 /* default is all the quickfix/location list entries */
2810 eap->line2 = qf_size;
2811 }
2812 }
2813#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814 else
2815 setpcmark();
2816 listcmd_busy = TRUE; /* avoids setting pcmark below */
2817
Bram Moolenaare25bb902015-02-27 20:33:37 +01002818 while (!got_int && buf != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002819 {
2820 if (eap->cmdidx == CMD_argdo)
2821 {
2822 /* go to argument "i" */
2823 if (i == ARGCOUNT)
2824 break;
2825 /* Don't call do_argfile() when already there, it will try
2826 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002827 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002828 {
2829 /* Clear 'shm' to avoid that the file message overwrites
2830 * any output from the command. */
2831 p_shm_save = vim_strsave(p_shm);
2832 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002833 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002834 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
2835 vim_free(p_shm_save);
2836 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002837 if (curwin->w_arg_idx != i)
2838 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 }
2840#ifdef FEAT_WINDOWS
2841 else if (eap->cmdidx == CMD_windo)
2842 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002843 /* go to window "wp" */
2844 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002845 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002846 win_goto(wp);
Bram Moolenaar41423242007-05-03 20:11:13 +00002847 if (curwin != wp)
2848 break; /* something must be wrong */
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002849 wp = curwin->w_next;
2850 }
2851 else if (eap->cmdidx == CMD_tabdo)
2852 {
2853 /* go to window "tp" */
2854 if (!valid_tabpage(tp))
2855 break;
Bram Moolenaar49e649f2013-05-06 04:50:35 +02002856 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002857 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002858 }
2859#endif
2860 else if (eap->cmdidx == CMD_bufdo)
2861 {
2862 /* Remember the number of the next listed buffer, in case
2863 * ":bwipe" is used or autocommands do something strange. */
2864 next_fnum = -1;
2865 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
2866 if (buf->b_p_bl)
2867 {
2868 next_fnum = buf->b_fnum;
2869 break;
2870 }
2871 }
2872
Bram Moolenaara162bc52015-01-07 16:54:21 +01002873 ++i;
2874
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 /* execute the command */
2876 do_cmdline(eap->arg, eap->getline, eap->cookie,
2877 DOCMD_VERBOSE + DOCMD_NOWAIT);
2878
2879 if (eap->cmdidx == CMD_bufdo)
2880 {
2881 /* Done? */
Bram Moolenaara162bc52015-01-07 16:54:21 +01002882 if (next_fnum < 0 || next_fnum > eap->line2)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883 break;
2884 /* Check if the buffer still exists. */
2885 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2886 if (buf->b_fnum == next_fnum)
2887 break;
2888 if (buf == NULL)
2889 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002890
2891 /* Go to the next buffer. Clear 'shm' to avoid that the file
2892 * message overwrites any output from the command. */
2893 p_shm_save = vim_strsave(p_shm);
2894 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002896 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
2897 vim_free(p_shm_save);
2898
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002899 /* If autocommands took us elsewhere, quit here. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 if (curbuf->b_fnum != next_fnum)
2901 break;
2902 }
2903
Bram Moolenaaraa23b372015-09-08 18:46:31 +02002904#ifdef FEAT_QUICKFIX
2905 if (eap->cmdidx == CMD_cdo || eap->cmdidx == CMD_ldo
2906 || eap->cmdidx == CMD_cfdo || eap->cmdidx == CMD_lfdo)
2907 {
2908 if (i >= qf_size || i >= eap->line2)
2909 break;
2910
2911 qf_idx = qf_get_cur_idx(eap);
2912
2913 ex_cnext(eap);
2914
2915 /* If jumping to the next quickfix entry fails, quit here */
2916 if (qf_get_cur_idx(eap) == qf_idx)
2917 break;
2918 }
2919#endif
2920
Bram Moolenaar071d4272004-06-13 20:20:40 +00002921 if (eap->cmdidx == CMD_windo)
2922 {
2923 validate_cursor(); /* cursor may have moved */
2924#ifdef FEAT_SCROLLBIND
2925 /* required when 'scrollbind' has been set */
2926 if (curwin->w_p_scb)
2927 do_check_scrollbind(TRUE);
2928#endif
2929 }
Bram Moolenaara162bc52015-01-07 16:54:21 +01002930
2931#ifdef FEAT_WINDOWS
2932 if (eap->cmdidx == CMD_windo || eap->cmdidx == CMD_tabdo)
2933 if (i+1 > eap->line2)
2934 break;
2935#endif
2936 if (eap->cmdidx == CMD_argdo && i >= eap->line2)
2937 break;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 }
2939 listcmd_busy = FALSE;
2940 }
2941
2942#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00002943 if (save_ei != NULL)
2944 {
2945 au_event_restore(save_ei);
2946 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
2947 curbuf->b_fname, TRUE, curbuf);
2948 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949#endif
Bram Moolenaar6b1ee342014-08-06 18:17:11 +02002950#ifdef FEAT_CLIPBOARD
2951 end_global_changes();
2952#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953}
2954
2955/*
2956 * Add files[count] to the arglist of the current window after arg "after".
2957 * The file names in files[count] must have been allocated and are taken over.
2958 * Files[] itself is not taken over.
2959 * Returns index of first added argument. Returns -1 when failed (out of mem).
2960 */
2961 static int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002962alist_add_list(
2963 int count,
2964 char_u **files,
2965 int after) /* where to add: 0 = before first one */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002966{
2967 int i;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01002968 int old_argcount = ARGCOUNT;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969
2970 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
2971 {
2972 if (after < 0)
2973 after = 0;
2974 if (after > ARGCOUNT)
2975 after = ARGCOUNT;
2976 if (after < ARGCOUNT)
2977 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
2978 (ARGCOUNT - after) * sizeof(aentry_T));
2979 for (i = 0; i < count; ++i)
2980 {
2981 ARGLIST[after + i].ae_fname = files[i];
2982 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
2983 }
2984 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaara24f0a52016-01-17 19:39:00 +01002985 if (old_argcount > 0 && curwin->w_arg_idx >= after)
2986 curwin->w_arg_idx += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 return after;
2988 }
2989
2990 for (i = 0; i < count; ++i)
2991 vim_free(files[i]);
2992 return -1;
2993}
2994
2995#endif /* FEAT_LISTCMDS */
2996
2997#ifdef FEAT_EVAL
2998/*
2999 * ":compiler[!] {name}"
3000 */
3001 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003002ex_compiler(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003{
3004 char_u *buf;
3005 char_u *old_cur_comp = NULL;
3006 char_u *p;
3007
3008 if (*eap->arg == NUL)
3009 {
3010 /* List all compiler scripts. */
3011 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
3012 /* ) keep the indenter happy... */
3013 }
3014 else
3015 {
3016 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
3017 if (buf != NULL)
3018 {
3019 if (eap->forceit)
3020 {
3021 /* ":compiler! {name}" sets global options */
3022 do_cmdline_cmd((char_u *)
3023 "command -nargs=* CompilerSet set <args>");
3024 }
3025 else
3026 {
3027 /* ":compiler! {name}" sets local options.
3028 * To remain backwards compatible "current_compiler" is always
3029 * used. A user's compiler plugin may set it, the distributed
3030 * plugin will then skip the settings. Afterwards set
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003031 * "b:current_compiler" and restore "current_compiler".
3032 * Explicitly prepend "g:" to make it work in a function. */
3033 old_cur_comp = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 if (old_cur_comp != NULL)
3035 old_cur_comp = vim_strsave(old_cur_comp);
3036 do_cmdline_cmd((char_u *)
3037 "command -nargs=* CompilerSet setlocal <args>");
3038 }
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003039 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00003040 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041
3042 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003043 if (source_runtime(buf, DIP_ALL) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
3045 vim_free(buf);
3046
3047 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
3048
3049 /* Set "b:current_compiler" from "current_compiler". */
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003050 p = get_var_value((char_u *)"g:current_compiler");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003051 if (p != NULL)
3052 set_internal_string_var((char_u *)"b:current_compiler", p);
3053
3054 /* Restore "current_compiler" for ":compiler {name}". */
3055 if (!eap->forceit)
3056 {
3057 if (old_cur_comp != NULL)
3058 {
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003059 set_internal_string_var((char_u *)"g:current_compiler",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003060 old_cur_comp);
3061 vim_free(old_cur_comp);
3062 }
3063 else
Bram Moolenaar3d63e3f2010-01-19 16:13:50 +01003064 do_unlet((char_u *)"g:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003065 }
3066 }
3067 }
3068}
3069#endif
3070
3071/*
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003072 * ":runtime [what] {name}"
Bram Moolenaar071d4272004-06-13 20:20:40 +00003073 */
3074 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003075ex_runtime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003077 char_u *arg = eap->arg;
3078 char_u *p = skiptowhite(arg);
3079 int len = (int)(p - arg);
3080 int flags = eap->forceit ? DIP_ALL : 0;
3081
3082 if (STRNCMP(arg, "START", len) == 0)
3083 {
3084 flags += DIP_START + DIP_NORTP;
3085 arg = skipwhite(arg + len);
3086 }
3087 else if (STRNCMP(arg, "OPT", len) == 0)
3088 {
3089 flags += DIP_OPT + DIP_NORTP;
3090 arg = skipwhite(arg + len);
3091 }
3092 else if (STRNCMP(arg, "PACK", len) == 0)
3093 {
3094 flags += DIP_START + DIP_OPT + DIP_NORTP;
3095 arg = skipwhite(arg + len);
3096 }
3097 else if (STRNCMP(arg, "ALL", len) == 0)
3098 {
3099 flags += DIP_START + DIP_OPT;
3100 arg = skipwhite(arg + len);
3101 }
3102
3103 source_runtime(arg, flags);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003104}
3105
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003107source_callback(char_u *fname, void *cookie UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003109 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110}
3111
3112/*
3113 * Source the file "name" from all directories in 'runtimepath'.
3114 * "name" can contain wildcards.
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003115 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
Bram Moolenaar91715872016-03-03 17:13:03 +01003116 *
Bram Moolenaar071d4272004-06-13 20:20:40 +00003117 * return FAIL when no file could be sourced, OK otherwise.
3118 */
3119 int
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003120source_runtime(char_u *name, int flags)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003121{
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003122 return do_in_runtimepath(name, flags, source_callback, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123}
3124
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003125/*
3126 * Find the file "name" in all directories in "path" and invoke
3127 * "callback(fname, cookie)".
3128 * "name" can contain wildcards.
3129 * When "flags" has DIP_ALL: source all files, otherwise only the first one.
3130 * When "flags" has DIP_DIR: find directories instead of files.
3131 * When "flags" has DIP_ERR: give an error message if there is no match.
3132 *
3133 * return FAIL when no file could be sourced, OK otherwise.
3134 */
Bram Moolenaar6bef5302016-03-12 21:28:26 +01003135 int
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003136do_in_path(
3137 char_u *path,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003138 char_u *name,
Bram Moolenaar91715872016-03-03 17:13:03 +01003139 int flags,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003140 void (*callback)(char_u *fname, void *ck),
3141 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003142{
3143 char_u *rtp;
3144 char_u *np;
3145 char_u *buf;
3146 char_u *rtp_copy;
3147 char_u *tail;
3148 int num_files;
3149 char_u **files;
3150 int i;
3151 int did_one = FALSE;
3152#ifdef AMIGA
3153 struct Process *proc = (struct Process *)FindTask(0L);
3154 APTR save_winptr = proc->pr_WindowPtr;
3155
3156 /* Avoid a requester here for a volume that doesn't exist. */
3157 proc->pr_WindowPtr = (APTR)-1L;
3158#endif
3159
3160 /* Make a copy of 'runtimepath'. Invoking the callback may change the
3161 * value. */
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003162 rtp_copy = vim_strsave(path);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003163 buf = alloc(MAXPATHL);
3164 if (buf != NULL && rtp_copy != NULL)
3165 {
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003166 if (p_verbose > 1 && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003167 {
3168 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003169 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003170 (char *)name, (char *)path);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003171 verbose_leave();
3172 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00003173
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 /* Loop over all entries in 'runtimepath'. */
3175 rtp = rtp_copy;
Bram Moolenaar91715872016-03-03 17:13:03 +01003176 while (*rtp != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177 {
3178 /* Copy the path from 'runtimepath' to buf[]. */
3179 copy_option_part(&rtp, buf, MAXPATHL, ",");
Bram Moolenaarc09a6d62013-06-10 21:27:29 +02003180 if (name == NULL)
3181 {
3182 (*callback)(buf, (void *) &cookie);
3183 if (!did_one)
3184 did_one = (cookie == NULL);
3185 }
3186 else if (STRLEN(buf) + STRLEN(name) + 2 < MAXPATHL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 {
3188 add_pathsep(buf);
3189 tail = buf + STRLEN(buf);
3190
3191 /* Loop over all patterns in "name" */
3192 np = name;
Bram Moolenaar91715872016-03-03 17:13:03 +01003193 while (*np != NUL && ((flags & DIP_ALL) || !did_one))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 {
3195 /* Append the pattern from "name" to buf[]. */
3196 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
3197 "\t ");
3198
3199 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003200 {
3201 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003202 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003203 verbose_leave();
3204 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205
3206 /* Expand wildcards, invoke the callback for each match. */
3207 if (gen_expand_wildcards(1, &buf, &num_files, &files,
Bram Moolenaar91715872016-03-03 17:13:03 +01003208 (flags & DIP_DIR) ? EW_DIR : EW_FILE) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 {
3210 for (i = 0; i < num_files; ++i)
3211 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00003212 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 did_one = TRUE;
Bram Moolenaar91715872016-03-03 17:13:03 +01003214 if (!(flags & DIP_ALL))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 break;
3216 }
3217 FreeWild(num_files, files);
3218 }
3219 }
3220 }
3221 }
3222 }
3223 vim_free(buf);
3224 vim_free(rtp_copy);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003225 if (!did_one && name != NULL)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003226 {
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003227 char *basepath = path == p_rtp ? "runtimepath" : "packpath";
3228
3229 if (flags & DIP_ERR)
3230 EMSG3(_(e_dirnotf), basepath, name);
3231 else if (p_verbose > 0)
3232 {
3233 verbose_enter();
3234 smsg((char_u *)_("not found in '%s': \"%s\""), basepath, name);
3235 verbose_leave();
3236 }
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003237 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238
3239#ifdef AMIGA
3240 proc->pr_WindowPtr = save_winptr;
3241#endif
3242
3243 return did_one ? OK : FAIL;
3244}
3245
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003246/*
3247 * Find "name" in 'runtimepath'. When found, invoke the callback function for
3248 * it: callback(fname, "cookie")
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003249 * When "flags" has DIP_ALL repeat for all matches, otherwise only the first
3250 * one is used.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003251 * Returns OK when at least one match found, FAIL otherwise.
3252 *
3253 * If "name" is NULL calls callback for each entry in runtimepath. Cookie is
3254 * passed by reference in this case, setting it to NULL indicates that callback
3255 * has done its job.
3256 */
3257 int
3258do_in_runtimepath(
3259 char_u *name,
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003260 int flags,
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003261 void (*callback)(char_u *fname, void *ck),
3262 void *cookie)
3263{
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003264 int done = FAIL;
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003265 char_u *s;
3266 int len;
3267 char *start_dir = "pack/*/start/*/%s";
3268 char *opt_dir = "pack/*/opt/*/%s";
3269
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003270 if ((flags & DIP_NORTP) == 0)
3271 done = do_in_path(p_rtp, name, flags, callback, cookie);
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003272
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003273 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_START))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003274 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003275 len = (int)(STRLEN(start_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003276 s = alloc(len);
3277 if (s == NULL)
3278 return FAIL;
3279 vim_snprintf((char *)s, len, start_dir, name);
3280 done = do_in_path(p_pp, s, flags, callback, cookie);
3281 vim_free(s);
3282 }
3283
Bram Moolenaar8dcf2592016-03-12 22:47:14 +01003284 if ((done == FAIL || (flags & DIP_ALL)) && (flags & DIP_OPT))
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003285 {
Bram Moolenaar1c8b4ed2016-03-17 21:51:03 +01003286 len = (int)(STRLEN(opt_dir) + STRLEN(name));
Bram Moolenaar7f8989d2016-03-12 22:11:39 +01003287 s = alloc(len);
3288 if (s == NULL)
3289 return FAIL;
3290 vim_snprintf((char *)s, len, opt_dir, name);
3291 done = do_in_path(p_pp, s, flags, callback, cookie);
3292 vim_free(s);
3293 }
3294
3295 return done;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003296}
3297
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003298/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003299 * Expand wildcards in "pat" and invoke do_source() for each match.
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003300 */
3301 static void
Bram Moolenaarf3654822016-03-04 22:12:23 +01003302source_all_matches(char_u *pat)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003303{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003304 int num_files;
3305 char_u **files;
3306 int i;
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003307
Bram Moolenaarf3654822016-03-04 22:12:23 +01003308 if (gen_expand_wildcards(1, &pat, &num_files, &files, EW_FILE) == OK)
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003309 {
Bram Moolenaarf3654822016-03-04 22:12:23 +01003310 for (i = 0; i < num_files; ++i)
3311 (void)do_source(files[i], FALSE, DOSO_NONE);
3312 FreeWild(num_files, files);
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003313 }
Bram Moolenaar1bdd4262016-03-03 14:23:10 +01003314}
3315
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003316 static void
Bram Moolenaar91715872016-03-03 17:13:03 +01003317add_pack_plugin(char_u *fname, void *cookie)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003318{
Bram Moolenaarf3654822016-03-04 22:12:23 +01003319 char_u *p4, *p3, *p2, *p1, *p;
3320 char_u *insp;
Bram Moolenaar91715872016-03-03 17:13:03 +01003321 int c;
3322 char_u *new_rtp;
3323 int keep;
3324 int oldlen;
3325 int addlen;
3326 char_u *ffname = fix_fname(fname);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003327 int load_files = cookie != NULL;
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003328
Bram Moolenaar91715872016-03-03 17:13:03 +01003329 if (ffname == NULL)
3330 return;
Bram Moolenaar91715872016-03-03 17:13:03 +01003331 if (strstr((char *)p_rtp, (char *)ffname) == NULL)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003332 {
3333 /* directory not in 'runtimepath', add it */
Bram Moolenaarf3654822016-03-04 22:12:23 +01003334 p4 = p3 = p2 = p1 = get_past_head(ffname);
3335 for (p = p1; *p; mb_ptr_adv(p))
3336 if (vim_ispathsep_nocolon(*p))
3337 {
3338 p4 = p3; p3 = p2; p2 = p1; p1 = p;
3339 }
3340
3341 /* now we have:
Bram Moolenaaraf1a0e32016-03-09 22:19:26 +01003342 * rtp/pack/name/start/name
3343 * p4 p3 p2 p1
Bram Moolenaarf3654822016-03-04 22:12:23 +01003344 *
3345 * find the part up to "pack" in 'runtimepath' */
3346 c = *p4;
3347 *p4 = NUL;
3348 insp = (char_u *)strstr((char *)p_rtp, (char *)ffname);
3349 if (insp == NULL)
3350 /* not found, append at the end */
3351 insp = p_rtp + STRLEN(p_rtp);
3352 else
3353 {
3354 /* append after the matching directory. */
3355 insp += STRLEN(ffname);
3356 while (*insp != NUL && *insp != ',')
3357 ++insp;
3358 }
3359 *p4 = c;
3360
Bram Moolenaar1daae442016-02-22 23:25:25 +01003361 oldlen = (int)STRLEN(p_rtp);
Bram Moolenaar91715872016-03-03 17:13:03 +01003362 addlen = (int)STRLEN(ffname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003363 new_rtp = alloc(oldlen + addlen + 2);
3364 if (new_rtp == NULL)
Bram Moolenaarf3654822016-03-04 22:12:23 +01003365 goto theend;
3366 keep = (int)(insp - p_rtp);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003367 mch_memmove(new_rtp, p_rtp, keep);
3368 new_rtp[keep] = ',';
Bram Moolenaar91715872016-03-03 17:13:03 +01003369 mch_memmove(new_rtp + keep + 1, ffname, addlen + 1);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003370 if (p_rtp[keep] != NUL)
3371 mch_memmove(new_rtp + keep + 1 + addlen, p_rtp + keep,
3372 oldlen - keep + 1);
Bram Moolenaar863c1a92016-03-03 15:47:06 +01003373 set_option_value((char_u *)"rtp", 0L, new_rtp, 0);
3374 vim_free(new_rtp);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003375 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003376
Bram Moolenaarf3654822016-03-04 22:12:23 +01003377 if (load_files)
3378 {
3379 static char *plugpat = "%s/plugin/*.vim";
3380 static char *ftpat = "%s/ftdetect/*.vim";
3381 int len;
3382 char_u *pat;
3383
3384 len = (int)STRLEN(ffname) + (int)STRLEN(ftpat);
3385 pat = alloc(len);
3386 if (pat == NULL)
3387 goto theend;
3388 vim_snprintf((char *)pat, len, plugpat, ffname);
3389 source_all_matches(pat);
3390
3391#ifdef FEAT_AUTOCMD
3392 {
3393 char_u *cmd = vim_strsave((char_u *)"g:did_load_filetypes");
3394
3395 /* If runtime/filetype.vim wasn't loaded yet, the scripts will be
3396 * found when it loads. */
3397 if (cmd != NULL && eval_to_number(cmd) > 0)
3398 {
3399 do_cmdline_cmd((char_u *)"augroup filetypedetect");
3400 vim_snprintf((char *)pat, len, ftpat, ffname);
3401 source_all_matches(pat);
3402 do_cmdline_cmd((char_u *)"augroup END");
3403 }
3404 vim_free(cmd);
3405 }
3406#endif
Bram Moolenaarba8cd122016-03-19 14:16:39 +01003407 vim_free(pat);
Bram Moolenaarf3654822016-03-04 22:12:23 +01003408 }
3409
3410theend:
3411 vim_free(ffname);
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003412}
3413
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003414static int did_source_packages = FALSE;
3415
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003416/*
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003417 * ":packloadall"
Bram Moolenaarf3654822016-03-04 22:12:23 +01003418 * Find plugins in the package directories and source them.
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003419 */
3420 void
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003421ex_packloadall(exarg_T *eap)
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003422{
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003423 if (!did_source_packages || (eap != NULL && eap->forceit))
3424 {
3425 did_source_packages = TRUE;
3426 do_in_path(p_pp, (char_u *)"pack/*/start/*", DIP_ALL + DIP_DIR,
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003427 add_pack_plugin, p_pp);
Bram Moolenaar2d8f56a2016-03-12 20:34:27 +01003428 }
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01003429}
3430
3431/*
Bram Moolenaarf3654822016-03-04 22:12:23 +01003432 * ":packadd[!] {name}"
Bram Moolenaar91715872016-03-03 17:13:03 +01003433 */
3434 void
3435ex_packadd(exarg_T *eap)
3436{
3437 static char *plugpat = "pack/*/opt/%s";
3438 int len;
3439 char *pat;
3440
3441 len = (int)STRLEN(plugpat) + (int)STRLEN(eap->arg);
3442 pat = (char *)alloc(len);
3443 if (pat == NULL)
3444 return;
3445 vim_snprintf(pat, len, plugpat, eap->arg);
Bram Moolenaarbe82c252016-03-06 14:44:08 +01003446 do_in_path(p_pp, (char_u *)pat, DIP_ALL + DIP_DIR + DIP_ERR,
3447 add_pack_plugin, eap->forceit ? NULL : p_pp);
Bram Moolenaar91715872016-03-03 17:13:03 +01003448 vim_free(pat);
3449}
3450
Bram Moolenaar071d4272004-06-13 20:20:40 +00003451#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
3452/*
3453 * ":options"
3454 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003456ex_options(
3457 exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458{
3459 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
3460}
3461#endif
3462
3463/*
3464 * ":source {fname}"
3465 */
3466 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003467ex_source(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003468{
3469#ifdef FEAT_BROWSE
3470 if (cmdmod.browse)
3471 {
3472 char_u *fname = NULL;
3473
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00003474 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003475 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
3476 if (fname != NULL)
3477 {
3478 cmd_source(fname, eap);
3479 vim_free(fname);
3480 }
3481 }
3482 else
3483#endif
3484 cmd_source(eap->arg, eap);
3485}
3486
3487 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003488cmd_source(char_u *fname, exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489{
3490 if (*fname == NUL)
3491 EMSG(_(e_argreq));
3492
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 else if (eap != NULL && eap->forceit)
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02003494 /* ":source!": read Normal mode commands
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003495 * Need to execute the commands directly. This is required at least
3496 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003497 * - ":g" command busy
3498 * - after ":argdo", ":windo" or ":bufdo"
3499 * - another command follows
3500 * - inside a loop
3501 */
3502 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
3503#ifdef FEAT_EVAL
3504 || eap->cstack->cs_idx >= 0
3505#endif
3506 );
3507
3508 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003509 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003510 EMSG2(_(e_notopen), fname);
3511}
3512
3513/*
3514 * ":source" and associated commands.
3515 */
3516/*
3517 * Structure used to store info for each sourced file.
3518 * It is shared between do_source() and getsourceline().
3519 * This is required, because it needs to be handed to do_cmdline() and
3520 * sourcing can be done recursively.
3521 */
3522struct source_cookie
3523{
3524 FILE *fp; /* opened file for sourcing */
3525 char_u *nextline; /* if not NULL: line that was read ahead */
3526 int finished; /* ":finish" used */
Bram Moolenaar860cae12010-06-05 23:22:07 +02003527#if defined(USE_CRNL) || defined(USE_CR)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
3529 int error; /* TRUE if LF found after CR-LF */
3530#endif
3531#ifdef FEAT_EVAL
3532 linenr_T breakpoint; /* next line with breakpoint or zero */
3533 char_u *fname; /* name of sourced file */
3534 int dbg_tick; /* debug_tick when breakpoint was set */
3535 int level; /* top nesting level of sourced file */
3536#endif
3537#ifdef FEAT_MBYTE
3538 vimconv_T conv; /* type of conversion */
3539#endif
3540};
3541
3542#ifdef FEAT_EVAL
3543/*
3544 * Return the address holding the next breakpoint line for a source cookie.
3545 */
3546 linenr_T *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003547source_breakpoint(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548{
3549 return &((struct source_cookie *)cookie)->breakpoint;
3550}
3551
3552/*
3553 * Return the address holding the debug tick for a source cookie.
3554 */
3555 int *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003556source_dbg_tick(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003557{
3558 return &((struct source_cookie *)cookie)->dbg_tick;
3559}
3560
3561/*
3562 * Return the nesting level for a source cookie.
3563 */
3564 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003565source_level(void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566{
3567 return ((struct source_cookie *)cookie)->level;
3568}
3569#endif
3570
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01003571static char_u *get_one_sourceline(struct source_cookie *sp);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003572
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003573#if (defined(WIN32) && defined(FEAT_CSCOPE)) || defined(HAVE_FD_CLOEXEC)
3574# define USE_FOPEN_NOINH
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01003575static FILE *fopen_noinh_readbin(char *filename);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576
3577/*
3578 * Special function to open a file without handle inheritance.
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003579 * When possible the handle is closed on exec().
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 */
3581 static FILE *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003582fopen_noinh_readbin(char *filename)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583{
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003584# ifdef WIN32
Bram Moolenaar8d8ef0b2010-01-20 21:41:47 +01003585 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
3586# else
3587 int fd_tmp = mch_open(filename, O_RDONLY, 0);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003588# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589
3590 if (fd_tmp == -1)
3591 return NULL;
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003592
3593# ifdef HAVE_FD_CLOEXEC
3594 {
3595 int fdflags = fcntl(fd_tmp, F_GETFD);
3596 if (fdflags >= 0 && (fdflags & FD_CLOEXEC) == 0)
Bram Moolenaarcde88542015-08-11 19:14:00 +02003597 (void)fcntl(fd_tmp, F_SETFD, fdflags | FD_CLOEXEC);
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003598 }
3599# endif
3600
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 return fdopen(fd_tmp, READBIN);
3602}
3603#endif
3604
3605
3606/*
3607 * do_source: Read the file "fname" and execute its lines as EX commands.
3608 *
3609 * This function may be called recursively!
3610 *
3611 * return FAIL if file could not be opened, OK otherwise
3612 */
3613 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003614do_source(
3615 char_u *fname,
3616 int check_other, /* check for .vimrc and _vimrc */
3617 int is_vimrc) /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618{
3619 struct source_cookie cookie;
3620 char_u *save_sourcing_name;
3621 linenr_T save_sourcing_lnum;
3622 char_u *p;
3623 char_u *fname_exp;
Bram Moolenaar73881402009-02-04 16:50:47 +00003624 char_u *firstline = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003625 int retval = FAIL;
3626#ifdef FEAT_EVAL
3627 scid_T save_current_SID;
3628 static scid_T last_current_SID = 0;
3629 void *save_funccalp;
3630 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003631 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003632# ifdef UNIX
3633 struct stat st;
3634 int stat_ok;
3635# endif
3636#endif
3637#ifdef STARTUPTIME
3638 struct timeval tv_rel;
3639 struct timeval tv_start;
3640#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00003641#ifdef FEAT_PROFILE
3642 proftime_T wait_start;
3643#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003644
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 p = expand_env_save(fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646 if (p == NULL)
3647 return retval;
3648 fname_exp = fix_fname(p);
3649 vim_free(p);
3650 if (fname_exp == NULL)
3651 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652 if (mch_isdir(fname_exp))
3653 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00003654 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655 goto theend;
3656 }
3657
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003658#ifdef FEAT_AUTOCMD
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003659 /* Apply SourceCmd autocommands, they should get the file and source it. */
3660 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
3661 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
3662 FALSE, curbuf))
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003663 {
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003664# ifdef FEAT_EVAL
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003665 retval = aborting() ? FAIL : OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003666# else
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003667 retval = OK;
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003668# endif
Bram Moolenaarf33943e2008-01-15 21:17:30 +00003669 goto theend;
3670 }
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00003671
3672 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00003673 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
3674#endif
3675
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003676#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
3678#else
3679 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
3680#endif
3681 if (cookie.fp == NULL && check_other)
3682 {
3683 /*
3684 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
3685 * and ".exrc" by "_exrc" or vice versa.
3686 */
3687 p = gettail(fname_exp);
3688 if ((*p == '.' || *p == '_')
3689 && (STRICMP(p + 1, "vimrc") == 0
3690 || STRICMP(p + 1, "gvimrc") == 0
3691 || STRICMP(p + 1, "exrc") == 0))
3692 {
3693 if (*p == '_')
3694 *p = '.';
3695 else
3696 *p = '_';
Bram Moolenaar6b29b0e2010-01-19 16:22:03 +01003697#ifdef USE_FOPEN_NOINH
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
3699#else
3700 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
3701#endif
3702 }
3703 }
3704
3705 if (cookie.fp == NULL)
3706 {
3707 if (p_verbose > 0)
3708 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003709 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003710 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00003711 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 else
3713 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00003714 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003715 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 }
3717 goto theend;
3718 }
3719
3720 /*
3721 * The file exists.
3722 * - In verbose mode, give a message.
3723 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
3724 */
3725 if (p_verbose > 1)
3726 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003727 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00003729 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003730 else
3731 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00003732 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003733 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003735 if (is_vimrc == DOSO_VIMRC)
3736 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
3737 else if (is_vimrc == DOSO_GVIMRC)
3738 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739
3740#ifdef USE_CRNL
3741 /* If no automatic file format: Set default to CR-NL. */
3742 if (*p_ffs == NUL)
3743 cookie.fileformat = EOL_DOS;
3744 else
3745 cookie.fileformat = EOL_UNKNOWN;
3746 cookie.error = FALSE;
3747#endif
3748
3749#ifdef USE_CR
3750 /* If no automatic file format: Set default to CR. */
3751 if (*p_ffs == NUL)
3752 cookie.fileformat = EOL_MAC;
3753 else
3754 cookie.fileformat = EOL_UNKNOWN;
3755 cookie.error = FALSE;
3756#endif
3757
3758 cookie.nextline = NULL;
3759 cookie.finished = FALSE;
3760
3761#ifdef FEAT_EVAL
3762 /*
3763 * Check if this script has a breakpoint.
3764 */
3765 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
3766 cookie.fname = fname_exp;
3767 cookie.dbg_tick = debug_tick;
3768
3769 cookie.level = ex_nesting_level;
3770#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771
3772 /*
3773 * Keep the sourcing name/lnum, for recursive calls.
3774 */
3775 save_sourcing_name = sourcing_name;
3776 sourcing_name = fname_exp;
3777 save_sourcing_lnum = sourcing_lnum;
3778 sourcing_lnum = 0;
3779
Bram Moolenaar73881402009-02-04 16:50:47 +00003780#ifdef FEAT_MBYTE
3781 cookie.conv.vc_type = CONV_NONE; /* no conversion */
3782
3783 /* Read the first line so we can check for a UTF-8 BOM. */
3784 firstline = getsourceline(0, (void *)&cookie, 0);
3785 if (firstline != NULL && STRLEN(firstline) >= 3 && firstline[0] == 0xef
3786 && firstline[1] == 0xbb && firstline[2] == 0xbf)
3787 {
3788 /* Found BOM; setup conversion, skip over BOM and recode the line. */
3789 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
3790 p = string_convert(&cookie.conv, firstline + 3, NULL);
Bram Moolenaar4e2a5952009-02-05 19:48:25 +00003791 if (p == NULL)
3792 p = vim_strsave(firstline + 3);
Bram Moolenaar73881402009-02-04 16:50:47 +00003793 if (p != NULL)
3794 {
3795 vim_free(firstline);
3796 firstline = p;
3797 }
3798 }
3799#endif
3800
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01003802 if (time_fd != NULL)
3803 time_push(&tv_rel, &tv_start);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804#endif
3805
3806#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00003807# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003808 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003809 prof_child_enter(&wait_start); /* entering a child now */
3810# endif
3811
3812 /* Don't use local function variables, if called from a function.
3813 * Also starts profiling timer for nested script. */
3814 save_funccalp = save_funccal();
3815
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 /*
3817 * Check if this script was sourced before to finds its SID.
3818 * If it's new, generate a new SID.
3819 */
3820 save_current_SID = current_SID;
3821# ifdef UNIX
3822 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
3823# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00003824 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
3825 {
3826 si = &SCRIPT_ITEM(current_SID);
3827 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 && (
3829# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00003830 /* Compare dev/ino when possible, it catches symbolic
3831 * links. Also compare file names, the inode may change
3832 * when the file was edited. */
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00003833 ((stat_ok && si->sn_dev_valid)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003834 && (si->sn_dev == st.st_dev
3835 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00003836# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00003837 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003839 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 if (current_SID == 0)
3841 {
3842 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003843 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
3844 == FAIL)
3845 goto almosttheend;
3846 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003847 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00003848 ++script_items.ga_len;
3849 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
3850# ifdef FEAT_PROFILE
3851 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003852# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00003854 si = &SCRIPT_ITEM(current_SID);
3855 si->sn_name = fname_exp;
3856 fname_exp = NULL;
3857# ifdef UNIX
3858 if (stat_ok)
3859 {
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00003860 si->sn_dev_valid = TRUE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003861 si->sn_dev = st.st_dev;
3862 si->sn_ino = st.st_ino;
3863 }
3864 else
Bram Moolenaarbf0c4522009-05-16 19:16:33 +00003865 si->sn_dev_valid = FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003866# endif
3867
Bram Moolenaar071d4272004-06-13 20:20:40 +00003868 /* Allocate the local script variables to use for this script. */
3869 new_script_vars(current_SID);
3870 }
3871
Bram Moolenaar05159a02005-02-26 23:04:13 +00003872# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003873 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003874 {
3875 int forceit;
3876
3877 /* Check if we do profiling for this script. */
3878 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
3879 {
3880 script_do_profile(si);
3881 si->sn_pr_force = forceit;
3882 }
3883 if (si->sn_prof_on)
3884 {
3885 ++si->sn_pr_count;
3886 profile_start(&si->sn_pr_start);
3887 profile_zero(&si->sn_pr_children);
3888 }
3889 }
3890# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891#endif
3892
3893 /*
3894 * Call do_cmdline, which will call getsourceline() to get the lines.
3895 */
Bram Moolenaar73881402009-02-04 16:50:47 +00003896 do_cmdline(firstline, getsourceline, (void *)&cookie,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003897 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003898 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003899
3900#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003901 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003902 {
3903 /* Get "si" again, "script_items" may have been reallocated. */
3904 si = &SCRIPT_ITEM(current_SID);
3905 if (si->sn_prof_on)
3906 {
3907 profile_end(&si->sn_pr_start);
3908 profile_sub_wait(&wait_start, &si->sn_pr_start);
3909 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00003910 profile_self(&si->sn_pr_self, &si->sn_pr_start,
3911 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00003912 }
3913 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003914#endif
3915
3916 if (got_int)
3917 EMSG(_(e_interr));
3918 sourcing_name = save_sourcing_name;
3919 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003920 if (p_verbose > 1)
3921 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003922 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003923 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003924 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00003925 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003926 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 }
3928#ifdef STARTUPTIME
Bram Moolenaarc4e41982010-01-19 16:31:47 +01003929 if (time_fd != NULL)
3930 {
3931 vim_snprintf((char *)IObuff, IOSIZE, "sourcing %s", fname);
3932 time_msg((char *)IObuff, &tv_start);
3933 time_pop(&tv_rel);
3934 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935#endif
3936
3937#ifdef FEAT_EVAL
3938 /*
3939 * After a "finish" in debug mode, need to break at first command of next
3940 * sourced file.
3941 */
3942 if (save_debug_break_level > ex_nesting_level
3943 && debug_break_level == ex_nesting_level)
3944 ++debug_break_level;
3945#endif
3946
Bram Moolenaar05159a02005-02-26 23:04:13 +00003947#ifdef FEAT_EVAL
3948almosttheend:
3949 current_SID = save_current_SID;
3950 restore_funccal(save_funccalp);
3951# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003952 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003953 prof_child_exit(&wait_start); /* leaving a child now */
3954# endif
3955#endif
3956 fclose(cookie.fp);
3957 vim_free(cookie.nextline);
Bram Moolenaar73881402009-02-04 16:50:47 +00003958 vim_free(firstline);
Bram Moolenaar05159a02005-02-26 23:04:13 +00003959#ifdef FEAT_MBYTE
3960 convert_setup(&cookie.conv, NULL, NULL);
3961#endif
3962
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963theend:
3964 vim_free(fname_exp);
3965 return retval;
3966}
3967
3968#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00003969
Bram Moolenaar071d4272004-06-13 20:20:40 +00003970/*
3971 * ":scriptnames"
3972 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003974ex_scriptnames(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003975{
3976 int i;
3977
Bram Moolenaar05159a02005-02-26 23:04:13 +00003978 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
3979 if (SCRIPT_ITEM(i).sn_name != NULL)
Bram Moolenaard58ea072011-06-26 04:25:30 +02003980 {
3981 home_replace(NULL, SCRIPT_ITEM(i).sn_name,
3982 NameBuff, MAXPATHL, TRUE);
3983 smsg((char_u *)"%3d: %s", i, NameBuff);
Bram Moolenaar970a1b82012-03-23 18:39:18 +01003984 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985}
3986
3987# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
3988/*
3989 * Fix slashes in the list of script names for 'shellslash'.
3990 */
3991 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01003992scriptnames_slash_adjust(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993{
3994 int i;
3995
Bram Moolenaar05159a02005-02-26 23:04:13 +00003996 for (i = 1; i <= script_items.ga_len; ++i)
3997 if (SCRIPT_ITEM(i).sn_name != NULL)
3998 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999}
4000# endif
4001
4002/*
4003 * Get a pointer to a script name. Used for ":verbose set".
4004 */
4005 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004006get_scriptname(scid_T id)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007{
4008 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004009 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004011 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004013 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00004015 return (char_u *)_("environment variable");
4016 if (id == SID_ERROR)
4017 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00004018 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004019}
Bram Moolenaar05159a02005-02-26 23:04:13 +00004020
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004021# if defined(EXITFREE) || defined(PROTO)
4022 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004023free_scriptnames(void)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00004024{
4025 int i;
4026
4027 for (i = script_items.ga_len; i > 0; --i)
4028 vim_free(SCRIPT_ITEM(i).sn_name);
4029 ga_clear(&script_items);
4030}
4031# endif
4032
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033#endif
4034
4035#if defined(USE_CR) || defined(PROTO)
4036
4037# if defined(__MSL__) && (__MSL__ >= 22)
4038/*
4039 * Newer version of the Metrowerks library handle DOS and UNIX files
4040 * without help.
4041 * Test with earlier versions, MSL 2.2 is the library supplied with
4042 * Codewarrior Pro 2.
4043 */
4044 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004045fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046{
4047 return fgets(s, n, stream);
4048}
4049# else
4050/*
4051 * Version of fgets() which also works for lines ending in a <CR> only
4052 * (Macintosh format).
4053 * For older versions of the Metrowerks library.
4054 * At least CodeWarrior 9 needed this code.
4055 */
4056 char *
Bram Moolenaard14e00e2016-01-31 17:30:51 +01004057fgets_cr(char *s, int n, FILE *stream)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004058{
4059 int c = 0;
4060 int char_read = 0;
4061
4062 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
4063 {
4064 c = fgetc(stream);
4065 s[char_read++] = c;
4066 /* If the file is in DOS format, we need to skip a NL after a CR. I
4067 * thought it was the other way around, but this appears to work... */
4068 if (c == '\n')
4069 {
4070 c = fgetc(stream);
4071 if (c != '\r')
4072 ungetc(c, stream);
4073 }
4074 }
4075
4076 s[char_read] = 0;
4077 if (char_read == 0)
4078 return NULL;
4079
4080 if (feof(stream) && char_read == 1)
4081 return NULL;
4082
4083 return s;
4084}
4085# endif
4086#endif
4087
4088/*
4089 * Get one full line from a sourced file.
4090 * Called by do_cmdline() when it's called from do_source().
4091 *
4092 * Return a pointer to the line in allocated memory.
4093 * Return NULL for end-of-file or some error.
4094 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004096getsourceline(int c UNUSED, void *cookie, int indent UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097{
4098 struct source_cookie *sp = (struct source_cookie *)cookie;
4099 char_u *line;
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004100 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101
4102#ifdef FEAT_EVAL
4103 /* If breakpoints have been added/deleted need to check for it. */
4104 if (sp->dbg_tick < debug_tick)
4105 {
4106 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4107 sp->dbg_tick = debug_tick;
4108 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00004109# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004110 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004111 script_line_end();
4112# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113#endif
4114 /*
4115 * Get current line. If there is a read-ahead line, use it, otherwise get
4116 * one now.
4117 */
4118 if (sp->finished)
4119 line = NULL;
4120 else if (sp->nextline == NULL)
4121 line = get_one_sourceline(sp);
4122 else
4123 {
4124 line = sp->nextline;
4125 sp->nextline = NULL;
4126 ++sourcing_lnum;
4127 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004128#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00004129 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004130 script_line_start();
4131#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004132
4133 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
4134 * contain the 'C' flag. */
4135 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
4136 {
4137 /* compensate for the one line read-ahead */
4138 --sourcing_lnum;
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004139
4140 /* Get the next line and concatenate it when it starts with a
4141 * backslash. We always need to read the next line, keep it in
4142 * sp->nextline. */
4143 sp->nextline = get_one_sourceline(sp);
4144 if (sp->nextline != NULL && *(p = skipwhite(sp->nextline)) == '\\')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 {
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004146 garray_T ga;
4147
Bram Moolenaarb549a732012-02-22 18:29:33 +01004148 ga_init2(&ga, (int)sizeof(char_u), 400);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004149 ga_concat(&ga, line);
4150 ga_concat(&ga, p + 1);
4151 for (;;)
4152 {
4153 vim_free(sp->nextline);
4154 sp->nextline = get_one_sourceline(sp);
4155 if (sp->nextline == NULL)
4156 break;
4157 p = skipwhite(sp->nextline);
4158 if (*p != '\\')
4159 break;
Bram Moolenaarb549a732012-02-22 18:29:33 +01004160 /* Adjust the growsize to the current length to speed up
4161 * concatenating many lines. */
4162 if (ga.ga_len > 400)
4163 {
4164 if (ga.ga_len > 8000)
4165 ga.ga_growsize = 8000;
4166 else
4167 ga.ga_growsize = ga.ga_len;
4168 }
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004169 ga_concat(&ga, p + 1);
4170 }
4171 ga_append(&ga, NUL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004172 vim_free(line);
Bram Moolenaarb3a6bbc2012-02-05 23:10:30 +01004173 line = ga.ga_data;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 }
4175 }
4176
4177#ifdef FEAT_MBYTE
4178 if (line != NULL && sp->conv.vc_type != CONV_NONE)
4179 {
Bram Moolenaarc047b9a2012-02-11 20:40:55 +01004180 char_u *s;
4181
Bram Moolenaar071d4272004-06-13 20:20:40 +00004182 /* Convert the encoding of the script line. */
4183 s = string_convert(&sp->conv, line, NULL);
4184 if (s != NULL)
4185 {
4186 vim_free(line);
4187 line = s;
4188 }
4189 }
4190#endif
4191
4192#ifdef FEAT_EVAL
4193 /* Did we encounter a breakpoint? */
4194 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
4195 {
4196 dbg_breakpoint(sp->fname, sourcing_lnum);
4197 /* Find next breakpoint. */
4198 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
4199 sp->dbg_tick = debug_tick;
4200 }
4201#endif
4202
4203 return line;
4204}
4205
4206 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004207get_one_sourceline(struct source_cookie *sp)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004208{
4209 garray_T ga;
4210 int len;
4211 int c;
4212 char_u *buf;
4213#ifdef USE_CRNL
4214 int has_cr; /* CR-LF found */
4215#endif
4216#ifdef USE_CR
4217 char_u *scan;
4218#endif
4219 int have_read = FALSE;
4220
4221 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004222 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004223
4224 /*
4225 * Loop until there is a finished line (or end-of-file).
4226 */
4227 sourcing_lnum++;
4228 for (;;)
4229 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004230 /* make room to read at least 120 (more) characters */
4231 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004232 break;
4233 buf = (char_u *)ga.ga_data;
4234
4235#ifdef USE_CR
4236 if (sp->fileformat == EOL_MAC)
4237 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00004238 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4239 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 break;
4241 }
4242 else
4243#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00004244 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
4245 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004246 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00004247 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004248#ifdef USE_CRNL
4249 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
4250 * CTRL-Z by its own, or after a NL. */
4251 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
4252 && sp->fileformat == EOL_DOS
4253 && buf[len - 1] == Ctrl_Z)
4254 {
4255 buf[len - 1] = NUL;
4256 break;
4257 }
4258#endif
4259
4260#ifdef USE_CR
4261 /* If the read doesn't stop on a new line, and there's
4262 * some CR then we assume a Mac format */
4263 if (sp->fileformat == EOL_UNKNOWN)
4264 {
4265 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
4266 sp->fileformat = EOL_MAC;
4267 else
4268 sp->fileformat = EOL_UNIX;
4269 }
4270
4271 if (sp->fileformat == EOL_MAC)
4272 {
4273 scan = vim_strchr(buf, '\r');
4274
4275 if (scan != NULL)
4276 {
4277 *scan = '\n';
4278 if (*(scan + 1) != 0)
4279 {
4280 *(scan + 1) = 0;
4281 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
4282 }
4283 }
4284 len = STRLEN(buf);
4285 }
4286#endif
4287
4288 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 ga.ga_len = len;
4290
4291 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00004292 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004293 continue;
4294
4295 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
4296 {
4297#ifdef USE_CRNL
4298 has_cr = (len >= 2 && buf[len - 2] == '\r');
4299 if (sp->fileformat == EOL_UNKNOWN)
4300 {
4301 if (has_cr)
4302 sp->fileformat = EOL_DOS;
4303 else
4304 sp->fileformat = EOL_UNIX;
4305 }
4306
4307 if (sp->fileformat == EOL_DOS)
4308 {
4309 if (has_cr) /* replace trailing CR */
4310 {
4311 buf[len - 2] = '\n';
4312 --len;
4313 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 }
4315 else /* lines like ":map xx yy^M" will have failed */
4316 {
4317 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004318 {
4319 msg_source(hl_attr(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00004320 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00004321 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004322 sp->error = TRUE;
4323 sp->fileformat = EOL_UNIX;
4324 }
4325 }
4326#endif
4327 /* The '\n' is escaped if there is an odd number of ^V's just
4328 * before it, first set "c" just before the 'V's and then check
4329 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
4330 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
4331 ;
4332 if ((len & 1) != (c & 1)) /* escaped NL, read more */
4333 {
4334 sourcing_lnum++;
4335 continue;
4336 }
4337
4338 buf[len - 1] = NUL; /* remove the NL */
4339 }
4340
4341 /*
4342 * Check for ^C here now and then, so recursive :so can be broken.
4343 */
4344 line_breakcheck();
4345 break;
4346 }
4347
4348 if (have_read)
4349 return (char_u *)ga.ga_data;
4350
4351 vim_free(ga.ga_data);
4352 return NULL;
4353}
4354
Bram Moolenaar05159a02005-02-26 23:04:13 +00004355#if defined(FEAT_PROFILE) || defined(PROTO)
4356/*
4357 * Called when starting to read a script line.
4358 * "sourcing_lnum" must be correct!
4359 * When skipping lines it may not actually be executed, but we won't find out
4360 * until later and we need to store the time now.
4361 */
4362 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004363script_line_start(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004364{
4365 scriptitem_T *si;
4366 sn_prl_T *pp;
4367
4368 if (current_SID <= 0 || current_SID > script_items.ga_len)
4369 return;
4370 si = &SCRIPT_ITEM(current_SID);
4371 if (si->sn_prof_on && sourcing_lnum >= 1)
4372 {
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004373 /* Grow the array before starting the timer, so that the time spent
Bram Moolenaar05159a02005-02-26 23:04:13 +00004374 * here isn't counted. */
Bram Moolenaarcde88542015-08-11 19:14:00 +02004375 (void)ga_grow(&si->sn_prl_ga, (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
Bram Moolenaar05159a02005-02-26 23:04:13 +00004376 si->sn_prl_idx = sourcing_lnum - 1;
4377 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
4378 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
4379 {
4380 /* Zero counters for a line that was not used before. */
4381 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
4382 pp->snp_count = 0;
4383 profile_zero(&pp->sn_prl_total);
4384 profile_zero(&pp->sn_prl_self);
4385 ++si->sn_prl_ga.ga_len;
4386 }
4387 si->sn_prl_execed = FALSE;
4388 profile_start(&si->sn_prl_start);
4389 profile_zero(&si->sn_prl_children);
4390 profile_get_wait(&si->sn_prl_wait);
4391 }
4392}
4393
4394/*
4395 * Called when actually executing a function line.
4396 */
4397 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004398script_line_exec(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004399{
4400 scriptitem_T *si;
4401
4402 if (current_SID <= 0 || current_SID > script_items.ga_len)
4403 return;
4404 si = &SCRIPT_ITEM(current_SID);
4405 if (si->sn_prof_on && si->sn_prl_idx >= 0)
4406 si->sn_prl_execed = TRUE;
4407}
4408
4409/*
4410 * Called when done with a function line.
4411 */
4412 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004413script_line_end(void)
Bram Moolenaar05159a02005-02-26 23:04:13 +00004414{
4415 scriptitem_T *si;
4416 sn_prl_T *pp;
4417
4418 if (current_SID <= 0 || current_SID > script_items.ga_len)
4419 return;
4420 si = &SCRIPT_ITEM(current_SID);
4421 if (si->sn_prof_on && si->sn_prl_idx >= 0
4422 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
4423 {
4424 if (si->sn_prl_execed)
4425 {
4426 pp = &PRL_ITEM(si, si->sn_prl_idx);
4427 ++pp->snp_count;
4428 profile_end(&si->sn_prl_start);
4429 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004430 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00004431 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
4432 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00004433 }
4434 si->sn_prl_idx = -1;
4435 }
4436}
4437#endif
4438
Bram Moolenaar071d4272004-06-13 20:20:40 +00004439/*
4440 * ":scriptencoding": Set encoding conversion for a sourced script.
4441 * Without the multi-byte feature it's simply ignored.
4442 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004444ex_scriptencoding(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004445{
4446#ifdef FEAT_MBYTE
4447 struct source_cookie *sp;
4448 char_u *name;
4449
4450 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
4451 {
4452 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
4453 return;
4454 }
4455
4456 if (*eap->arg != NUL)
4457 {
4458 name = enc_canonize(eap->arg);
4459 if (name == NULL) /* out of memory */
4460 return;
4461 }
4462 else
4463 name = eap->arg;
4464
4465 /* Setup for conversion from the specified encoding to 'encoding'. */
4466 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
4467 convert_setup(&sp->conv, name, p_enc);
4468
4469 if (name != eap->arg)
4470 vim_free(name);
4471#endif
4472}
4473
4474#if defined(FEAT_EVAL) || defined(PROTO)
4475/*
4476 * ":finish": Mark a sourced file as finished.
4477 */
4478 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004479ex_finish(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004480{
4481 if (getline_equal(eap->getline, eap->cookie, getsourceline))
4482 do_finish(eap, FALSE);
4483 else
4484 EMSG(_("E168: :finish used outside of a sourced file"));
4485}
4486
4487/*
4488 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
4489 * Also called for a pending finish at the ":endtry" or after returning from
4490 * an extra do_cmdline(). "reanimate" is used in the latter case.
4491 */
4492 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004493do_finish(exarg_T *eap, int reanimate)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004494{
4495 int idx;
4496
4497 if (reanimate)
4498 ((struct source_cookie *)getline_cookie(eap->getline,
4499 eap->cookie))->finished = FALSE;
4500
4501 /*
4502 * Cleanup (and inactivate) conditionals, but stop when a try conditional
4503 * not in its finally clause (which then is to be executed next) is found.
4504 * In this case, make the ":finish" pending for execution at the ":endtry".
4505 * Otherwise, finish normally.
4506 */
4507 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
4508 if (idx >= 0)
4509 {
4510 eap->cstack->cs_pending[idx] = CSTP_FINISH;
4511 report_make_pending(CSTP_FINISH, NULL);
4512 }
4513 else
4514 ((struct source_cookie *)getline_cookie(eap->getline,
4515 eap->cookie))->finished = TRUE;
4516}
4517
4518
4519/*
4520 * Return TRUE when a sourced file had the ":finish" command: Don't give error
4521 * message for missing ":endif".
4522 * Return FALSE when not sourcing a file.
4523 */
4524 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004525source_finished(
4526 char_u *(*fgetline)(int, void *, int),
4527 void *cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528{
Bram Moolenaar89d40322006-08-29 15:30:07 +00004529 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00004531 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004532}
4533#endif
4534
4535#if defined(FEAT_LISTCMDS) || defined(PROTO)
4536/*
4537 * ":checktime [buffer]"
4538 */
4539 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004540ex_checktime(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541{
4542 buf_T *buf;
4543 int save_no_check_timestamps = no_check_timestamps;
4544
4545 no_check_timestamps = 0;
4546 if (eap->addr_count == 0) /* default is all buffers */
4547 check_timestamps(FALSE);
4548 else
4549 {
4550 buf = buflist_findnr((int)eap->line2);
4551 if (buf != NULL) /* cannot happen? */
4552 (void)buf_check_timestamp(buf, FALSE);
4553 }
4554 no_check_timestamps = save_no_check_timestamps;
4555}
4556#endif
4557
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4559 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004560# define HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004561static char_u *get_locale_val(int what);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004563 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004564get_locale_val(int what)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565{
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004566 char_u *loc;
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567
Bram Moolenaar48e330a2016-02-23 14:53:34 +01004568 /* Obtain the locale value from the libraries. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004569 loc = (char_u *)setlocale(what, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004570
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004571# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 if (loc != NULL)
4573 {
4574 char_u *p;
4575
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004576 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
4577 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 p = vim_strchr(loc, '=');
4579 if (p != NULL)
4580 {
4581 loc = ++p;
4582 while (*p != NUL) /* remove trailing newline */
4583 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004584 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585 {
4586 *p = NUL;
4587 break;
4588 }
4589 ++p;
4590 }
4591 }
4592 }
4593# endif
4594
4595 return loc;
4596}
4597#endif
4598
4599
4600#ifdef WIN32
4601/*
4602 * On MS-Windows locale names are strings like "German_Germany.1252", but
4603 * gettext expects "de". Try to translate one into another here for a few
4604 * supported languages.
4605 */
4606 static char_u *
4607gettext_lang(char_u *name)
4608{
4609 int i;
4610 static char *(mtable[]) = {
4611 "afrikaans", "af",
4612 "czech", "cs",
4613 "dutch", "nl",
4614 "german", "de",
4615 "english_united kingdom", "en_GB",
4616 "spanish", "es",
4617 "french", "fr",
4618 "italian", "it",
4619 "japanese", "ja",
4620 "korean", "ko",
4621 "norwegian", "no",
4622 "polish", "pl",
4623 "russian", "ru",
4624 "slovak", "sk",
4625 "swedish", "sv",
4626 "ukrainian", "uk",
4627 "chinese_china", "zh_CN",
4628 "chinese_taiwan", "zh_TW",
4629 NULL};
4630
4631 for (i = 0; mtable[i] != NULL; i += 2)
4632 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004633 return (char_u *)mtable[i + 1];
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 return name;
4635}
4636#endif
4637
4638#if defined(FEAT_MULTI_LANG) || defined(PROTO)
4639/*
4640 * Obtain the current messages language. Used to set the default for
4641 * 'helplang'. May return NULL or an empty string.
4642 */
4643 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004644get_mess_lang(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004645{
4646 char_u *p;
4647
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004648# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649# if defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004650 p = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004651# else
4652 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00004653 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
4654 * and LC_MONETARY may be set differently for a Japanese working in the
4655 * US. */
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004656 p = get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004657# endif
4658# else
4659 p = mch_getenv((char_u *)"LC_ALL");
4660 if (p == NULL || *p == NUL)
4661 {
4662 p = mch_getenv((char_u *)"LC_MESSAGES");
4663 if (p == NULL || *p == NUL)
4664 p = mch_getenv((char_u *)"LANG");
4665 }
4666# endif
4667# ifdef WIN32
4668 p = gettext_lang(p);
4669# endif
4670 return p;
4671}
4672#endif
4673
Bram Moolenaardef9e822004-12-31 20:58:58 +00004674/* Complicated #if; matches with where get_mess_env() is used below. */
4675#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4676 && defined(LC_MESSAGES))) \
4677 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4678 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
4679 && !defined(LC_MESSAGES))
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004680static char_u *get_mess_env(void);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004681
4682/*
4683 * Get the language used for messages from the environment.
4684 */
4685 static char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004686get_mess_env(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004687{
4688 char_u *p;
4689
4690 p = mch_getenv((char_u *)"LC_ALL");
4691 if (p == NULL || *p == NUL)
4692 {
4693 p = mch_getenv((char_u *)"LC_MESSAGES");
4694 if (p == NULL || *p == NUL)
4695 {
4696 p = mch_getenv((char_u *)"LANG");
4697 if (p != NULL && VIM_ISDIGIT(*p))
4698 p = NULL; /* ignore something like "1043" */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004699# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar071d4272004-06-13 20:20:40 +00004700 if (p == NULL || *p == NUL)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004701 p = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004702# endif
4703 }
4704 }
4705 return p;
4706}
4707#endif
4708
4709#if defined(FEAT_EVAL) || defined(PROTO)
4710
4711/*
4712 * Set the "v:lang" variable according to the current locale setting.
4713 * Also do "v:lc_time"and "v:ctype".
4714 */
4715 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004716set_lang_var(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004717{
4718 char_u *loc;
4719
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004720# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004721 loc = get_locale_val(LC_CTYPE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722# else
4723 /* setlocale() not supported: use the default value */
4724 loc = (char_u *)"C";
4725# endif
4726 set_vim_var_string(VV_CTYPE, loc, -1);
4727
4728 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
4729 * back to LC_CTYPE if it's empty. */
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004730# if defined(HAVE_GET_LOCALE_VAL) && defined(LC_MESSAGES)
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004731 loc = get_locale_val(LC_MESSAGES);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732# else
4733 loc = get_mess_env();
4734# endif
4735 set_vim_var_string(VV_LANG, loc, -1);
4736
Bram Moolenaar8765a4a2010-07-27 22:41:43 +02004737# ifdef HAVE_GET_LOCALE_VAL
Bram Moolenaar6aa2cd42016-02-16 15:06:59 +01004738 loc = get_locale_val(LC_TIME);
Bram Moolenaar071d4272004-06-13 20:20:40 +00004739# endif
4740 set_vim_var_string(VV_LC_TIME, loc, -1);
4741}
4742#endif
4743
4744#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4745 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
4746/*
4747 * ":language": Set the language (locale).
4748 */
4749 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004750ex_language(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751{
4752 char *loc;
4753 char_u *p;
4754 char_u *name;
4755 int what = LC_ALL;
4756 char *whatstr = "";
4757#ifdef LC_MESSAGES
4758# define VIM_LC_MESSAGES LC_MESSAGES
4759#else
4760# define VIM_LC_MESSAGES 6789
4761#endif
4762
4763 name = eap->arg;
4764
4765 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
4766 * Allow abbreviation, but require at least 3 characters to avoid
4767 * confusion with a two letter language name "me" or "ct". */
4768 p = skiptowhite(eap->arg);
4769 if ((*p == NUL || vim_iswhite(*p)) && p - eap->arg >= 3)
4770 {
4771 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
4772 {
4773 what = VIM_LC_MESSAGES;
4774 name = skipwhite(p);
4775 whatstr = "messages ";
4776 }
4777 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
4778 {
4779 what = LC_CTYPE;
4780 name = skipwhite(p);
4781 whatstr = "ctype ";
4782 }
4783 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
4784 {
4785 what = LC_TIME;
4786 name = skipwhite(p);
4787 whatstr = "time ";
4788 }
4789 }
4790
4791 if (*name == NUL)
4792 {
4793#ifndef LC_MESSAGES
4794 if (what == VIM_LC_MESSAGES)
4795 p = get_mess_env();
4796 else
4797#endif
4798 p = (char_u *)setlocale(what, NULL);
4799 if (p == NULL || *p == NUL)
4800 p = (char_u *)"Unknown";
4801 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
4802 }
4803 else
4804 {
4805#ifndef LC_MESSAGES
4806 if (what == VIM_LC_MESSAGES)
4807 loc = "";
4808 else
4809#endif
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004810 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004811 loc = setlocale(what, (char *)name);
Bram Moolenaar8c8de832008-06-24 22:58:06 +00004812#if defined(FEAT_FLOAT) && defined(LC_NUMERIC)
4813 /* Make sure strtod() uses a decimal point, not a comma. */
4814 setlocale(LC_NUMERIC, "C");
4815#endif
4816 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 if (loc == NULL)
4818 EMSG2(_("E197: Cannot set language to \"%s\""), name);
4819 else
4820 {
4821#ifdef HAVE_NL_MSG_CAT_CNTR
4822 /* Need to do this for GNU gettext, otherwise cached translations
4823 * will be used again. */
4824 extern int _nl_msg_cat_cntr;
4825
4826 ++_nl_msg_cat_cntr;
4827#endif
Bram Moolenaarb8017e72007-05-10 18:59:07 +00004828 /* Reset $LC_ALL, otherwise it would overrule everything. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
4830
4831 if (what != LC_TIME)
4832 {
4833 /* Tell gettext() what to translate to. It apparently doesn't
4834 * use the currently effective locale. Also do this when
4835 * FEAT_GETTEXT isn't defined, so that shell commands use this
4836 * value. */
4837 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004838 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00004839 vim_setenv((char_u *)"LANG", name);
Bram Moolenaare3a0b532013-06-28 20:36:30 +02004840
4841 /* Clear $LANGUAGE because GNU gettext uses it. */
4842 vim_setenv((char_u *)"LANGUAGE", (char_u *)"");
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004843# ifdef WIN32
4844 /* Apparently MS-Windows printf() may cause a crash when
4845 * we give it 8-bit text while it's expecting text in the
4846 * current locale. This call avoids that. */
4847 setlocale(LC_CTYPE, "C");
4848# endif
4849 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004850 if (what != LC_CTYPE)
4851 {
4852 char_u *mname;
4853#ifdef WIN32
4854 mname = gettext_lang(name);
4855#else
4856 mname = name;
4857#endif
4858 vim_setenv((char_u *)"LC_MESSAGES", mname);
4859#ifdef FEAT_MULTI_LANG
4860 set_helplang_default(mname);
4861#endif
4862 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 }
4864
4865# ifdef FEAT_EVAL
4866 /* Set v:lang, v:lc_time and v:ctype to the final result. */
4867 set_lang_var();
4868# endif
Bram Moolenaar6cc00c72011-10-20 21:41:09 +02004869# ifdef FEAT_TITLE
4870 maketitle();
4871# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00004872 }
4873 }
4874}
4875
4876# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004877
4878static char_u **locales = NULL; /* Array of all available locales */
4879static int did_init_locales = FALSE;
4880
Bram Moolenaarf28dbce2016-01-29 22:03:47 +01004881static void init_locales(void);
4882static char_u **find_locales(void);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004883
4884/*
4885 * Lazy initialization of all available locales.
4886 */
4887 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004888init_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004889{
4890 if (!did_init_locales)
4891 {
4892 did_init_locales = TRUE;
4893 locales = find_locales();
4894 }
4895}
4896
4897/* Return an array of strings for all available locales + NULL for the
4898 * last element. Return NULL in case of error. */
4899 static char_u **
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004900find_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004901{
4902 garray_T locales_ga;
4903 char_u *loc;
4904
4905 /* Find all available locales by running command "locale -a". If this
4906 * doesn't work we won't have completion. */
4907 char_u *locale_a = get_cmd_output((char_u *)"locale -a",
Bram Moolenaar39c29ed2014-04-05 19:44:40 +02004908 NULL, SHELL_SILENT, NULL);
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004909 if (locale_a == NULL)
4910 return NULL;
4911 ga_init2(&locales_ga, sizeof(char_u *), 20);
4912
4913 /* Transform locale_a string where each locale is separated by "\n"
4914 * into an array of locale strings. */
4915 loc = (char_u *)strtok((char *)locale_a, "\n");
4916
4917 while (loc != NULL)
4918 {
4919 if (ga_grow(&locales_ga, 1) == FAIL)
4920 break;
4921 loc = vim_strsave(loc);
4922 if (loc == NULL)
4923 break;
4924
4925 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len++] = loc;
4926 loc = (char_u *)strtok(NULL, "\n");
4927 }
4928 vim_free(locale_a);
4929 if (ga_grow(&locales_ga, 1) == FAIL)
4930 {
4931 ga_clear(&locales_ga);
4932 return NULL;
4933 }
4934 ((char_u **)locales_ga.ga_data)[locales_ga.ga_len] = NULL;
4935 return (char_u **)locales_ga.ga_data;
4936}
4937
4938# if defined(EXITFREE) || defined(PROTO)
4939 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004940free_locales(void)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004941{
4942 int i;
4943 if (locales != NULL)
4944 {
4945 for (i = 0; locales[i] != NULL; i++)
4946 vim_free(locales[i]);
4947 vim_free(locales);
4948 locales = NULL;
4949 }
4950}
4951# endif
4952
Bram Moolenaar071d4272004-06-13 20:20:40 +00004953/*
4954 * Function given to ExpandGeneric() to obtain the possible arguments of the
4955 * ":language" command.
4956 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00004957 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004958get_lang_arg(expand_T *xp UNUSED, int idx)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004959{
4960 if (idx == 0)
4961 return (char_u *)"messages";
4962 if (idx == 1)
4963 return (char_u *)"ctype";
4964 if (idx == 2)
4965 return (char_u *)"time";
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004966
4967 init_locales();
4968 if (locales == NULL)
4969 return NULL;
4970 return locales[idx - 3];
4971}
4972
4973/*
4974 * Function given to ExpandGeneric() to obtain the available locales.
4975 */
4976 char_u *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01004977get_locales(expand_T *xp UNUSED, int idx)
Bram Moolenaar9b486ca2011-05-19 18:26:40 +02004978{
4979 init_locales();
4980 if (locales == NULL)
4981 return NULL;
4982 return locales[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00004983}
4984# endif
4985
4986#endif