blob: 6396ee115e6547d576c2b5c9af1256e82f35460e [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
14#if defined(WIN32) && defined(FEAT_CSCOPE)
Bram Moolenaar362e1a32006-03-06 23:29:24 +000015# include "vimio.h"
Bram Moolenaar071d4272004-06-13 20:20:40 +000016#endif
17
18#include "vim.h"
19
20#if defined(WIN32) && defined(FEAT_CSCOPE)
21# include <fcntl.h>
22#endif
23
24#include "version.h"
25
26static void cmd_source __ARGS((char_u *fname, exarg_T *eap));
27
Bram Moolenaar05159a02005-02-26 23:04:13 +000028#ifdef FEAT_EVAL
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000029/* Growarray to store info about already sourced scripts.
Bram Moolenaar05159a02005-02-26 23:04:13 +000030 * For Unix also store the dev/ino, so that we don't have to stat() each
31 * script when going through the list. */
32typedef struct scriptitem_S
33{
34 char_u *sn_name;
35# ifdef UNIX
36 int sn_dev;
37 ino_t sn_ino;
38# endif
39# ifdef FEAT_PROFILE
40 int sn_prof_on; /* TRUE when script is/was profiled */
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +000041 int sn_pr_force; /* forceit: profile functions in this script */
Bram Moolenaar05159a02005-02-26 23:04:13 +000042 proftime_T sn_pr_child; /* time set when going into first child */
43 int sn_pr_nest; /* nesting for sn_pr_child */
44 /* profiling the script as a whole */
45 int sn_pr_count; /* nr of times sourced */
46 proftime_T sn_pr_total; /* time spend in script + children */
47 proftime_T sn_pr_self; /* time spend in script itself */
48 proftime_T sn_pr_start; /* time at script start */
49 proftime_T sn_pr_children; /* time in children after script start */
50 /* profiling the script per line */
51 garray_T sn_prl_ga; /* things stored for every line */
52 proftime_T sn_prl_start; /* start time for current line */
53 proftime_T sn_prl_children; /* time spent in children for this line */
54 proftime_T sn_prl_wait; /* wait start time for current line */
55 int sn_prl_idx; /* index of line being timed; -1 if none */
56 int sn_prl_execed; /* line being timed was executed */
57# endif
58} scriptitem_T;
59
60static garray_T script_items = {0, 0, sizeof(scriptitem_T), 4, NULL};
61#define SCRIPT_ITEM(id) (((scriptitem_T *)script_items.ga_data)[(id) - 1])
62
63# ifdef FEAT_PROFILE
64/* Struct used in sn_prl_ga for every line of a script. */
65typedef struct sn_prl_S
66{
67 int snp_count; /* nr of times line was executed */
68 proftime_T sn_prl_total; /* time spend in a line + children */
69 proftime_T sn_prl_self; /* time spend in a line itself */
70} sn_prl_T;
71
72# define PRL_ITEM(si, idx) (((sn_prl_T *)(si)->sn_prl_ga.ga_data)[(idx)])
73# endif
74#endif
75
Bram Moolenaar071d4272004-06-13 20:20:40 +000076#if defined(FEAT_EVAL) || defined(PROTO)
77static int debug_greedy = FALSE; /* batch mode debugging: don't save
78 and restore typeahead. */
79
80/*
81 * do_debug(): Debug mode.
82 * Repeatedly get Ex commands, until told to continue normal execution.
83 */
84 void
85do_debug(cmd)
86 char_u *cmd;
87{
88 int save_msg_scroll = msg_scroll;
89 int save_State = State;
90 int save_did_emsg = did_emsg;
91 int save_cmd_silent = cmd_silent;
92 int save_msg_silent = msg_silent;
93 int save_emsg_silent = emsg_silent;
94 int save_redir_off = redir_off;
95 tasave_T typeaheadbuf;
96# ifdef FEAT_EX_EXTRA
97 int save_ex_normal_busy;
98# endif
99 int n;
100 char_u *cmdline = NULL;
101 char_u *p;
102 char *tail = NULL;
103 static int last_cmd = 0;
104#define CMD_CONT 1
105#define CMD_NEXT 2
106#define CMD_STEP 3
107#define CMD_FINISH 4
108#define CMD_QUIT 5
109#define CMD_INTERRUPT 6
110
111#ifdef ALWAYS_USE_GUI
112 /* Can't do this when there is no terminal for input/output. */
113 if (!gui.in_use)
114 {
115 /* Break as soon as possible. */
116 debug_break_level = 9999;
117 return;
118 }
119#endif
120
121 /* Make sure we are in raw mode and start termcap mode. Might have side
122 * effects... */
123 settmode(TMODE_RAW);
124 starttermcap();
125
126 ++RedrawingDisabled; /* don't redisplay the window */
127 ++no_wait_return; /* don't wait for return */
128 did_emsg = FALSE; /* don't use error from debugged stuff */
129 cmd_silent = FALSE; /* display commands */
130 msg_silent = FALSE; /* display messages */
131 emsg_silent = FALSE; /* display error messages */
132 redir_off = TRUE; /* don't redirect debug commands */
133
134 State = NORMAL;
135#ifdef FEAT_SNIFF
136 want_sniff_request = 0; /* No K_SNIFF wanted */
137#endif
138
139 if (!debug_did_msg)
140 MSG(_("Entering Debug mode. Type \"cont\" to continue."));
141 if (sourcing_name != NULL)
142 msg(sourcing_name);
143 if (sourcing_lnum != 0)
Bram Moolenaar555b2802005-05-19 21:08:39 +0000144 smsg((char_u *)_("line %ld: %s"), (long)sourcing_lnum, cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145 else
Bram Moolenaar555b2802005-05-19 21:08:39 +0000146 smsg((char_u *)_("cmd: %s"), cmd);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000147
148 /*
149 * Repeat getting a command and executing it.
150 */
151 for (;;)
152 {
153 msg_scroll = TRUE;
154 need_wait_return = FALSE;
155#ifdef FEAT_SNIFF
156 ProcessSniffRequests();
157#endif
158 /* Save the current typeahead buffer and replace it with an empty one.
159 * This makes sure we get input from the user here and don't interfere
160 * with the commands being executed. Reset "ex_normal_busy" to avoid
161 * the side effects of using ":normal". Save the stuff buffer and make
162 * it empty. */
163# ifdef FEAT_EX_EXTRA
164 save_ex_normal_busy = ex_normal_busy;
165 ex_normal_busy = 0;
166# endif
167 if (!debug_greedy)
168 save_typeahead(&typeaheadbuf);
169
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +0000170 cmdline = getcmdline_prompt('>', NULL, 0, EXPAND_NOTHING, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171
172 if (!debug_greedy)
173 restore_typeahead(&typeaheadbuf);
174# ifdef FEAT_EX_EXTRA
175 ex_normal_busy = save_ex_normal_busy;
176# endif
177
178 cmdline_row = msg_row;
179 if (cmdline != NULL)
180 {
181 /* If this is a debug command, set "last_cmd".
182 * If not, reset "last_cmd".
183 * For a blank line use previous command. */
184 p = skipwhite(cmdline);
185 if (*p != NUL)
186 {
187 switch (*p)
188 {
189 case 'c': last_cmd = CMD_CONT;
190 tail = "ont";
191 break;
192 case 'n': last_cmd = CMD_NEXT;
193 tail = "ext";
194 break;
195 case 's': last_cmd = CMD_STEP;
196 tail = "tep";
197 break;
198 case 'f': last_cmd = CMD_FINISH;
199 tail = "inish";
200 break;
201 case 'q': last_cmd = CMD_QUIT;
202 tail = "uit";
203 break;
204 case 'i': last_cmd = CMD_INTERRUPT;
205 tail = "nterrupt";
206 break;
207 default: last_cmd = 0;
208 }
209 if (last_cmd != 0)
210 {
211 /* Check that the tail matches. */
212 ++p;
213 while (*p != NUL && *p == *tail)
214 {
215 ++p;
216 ++tail;
217 }
218 if (ASCII_ISALPHA(*p))
219 last_cmd = 0;
220 }
221 }
222
223 if (last_cmd != 0)
224 {
225 /* Execute debug command: decided where to break next and
226 * return. */
227 switch (last_cmd)
228 {
229 case CMD_CONT:
230 debug_break_level = -1;
231 break;
232 case CMD_NEXT:
233 debug_break_level = ex_nesting_level;
234 break;
235 case CMD_STEP:
236 debug_break_level = 9999;
237 break;
238 case CMD_FINISH:
239 debug_break_level = ex_nesting_level - 1;
240 break;
241 case CMD_QUIT:
242 got_int = TRUE;
243 debug_break_level = -1;
244 break;
245 case CMD_INTERRUPT:
246 got_int = TRUE;
247 debug_break_level = 9999;
248 /* Do not repeat ">interrupt" cmd, continue stepping. */
249 last_cmd = CMD_STEP;
250 break;
251 }
252 break;
253 }
254
255 /* don't debug this command */
256 n = debug_break_level;
257 debug_break_level = -1;
258 (void)do_cmdline(cmdline, getexline, NULL,
259 DOCMD_VERBOSE|DOCMD_EXCRESET);
260 debug_break_level = n;
261
262 vim_free(cmdline);
263 }
264 lines_left = Rows - 1;
265 }
266 vim_free(cmdline);
267
268 --RedrawingDisabled;
269 --no_wait_return;
270 redraw_all_later(NOT_VALID);
271 need_wait_return = FALSE;
272 msg_scroll = save_msg_scroll;
273 lines_left = Rows - 1;
274 State = save_State;
275 did_emsg = save_did_emsg;
276 cmd_silent = save_cmd_silent;
277 msg_silent = save_msg_silent;
278 emsg_silent = save_emsg_silent;
279 redir_off = save_redir_off;
280
281 /* Only print the message again when typing a command before coming back
282 * here. */
283 debug_did_msg = TRUE;
284}
285
286/*
287 * ":debug".
288 */
289 void
290ex_debug(eap)
291 exarg_T *eap;
292{
293 int debug_break_level_save = debug_break_level;
294
295 debug_break_level = 9999;
296 do_cmdline_cmd(eap->arg);
297 debug_break_level = debug_break_level_save;
298}
299
300static char_u *debug_breakpoint_name = NULL;
301static linenr_T debug_breakpoint_lnum;
302
303/*
304 * When debugging or a breakpoint is set on a skipped command, no debug prompt
305 * is shown by do_one_cmd(). This situation is indicated by debug_skipped, and
306 * debug_skipped_name is then set to the source name in the breakpoint case. If
307 * a skipped command decides itself that a debug prompt should be displayed, it
308 * can do so by calling dbg_check_skipped().
309 */
310static int debug_skipped;
311static char_u *debug_skipped_name;
312
313/*
314 * Go to debug mode when a breakpoint was encountered or "ex_nesting_level" is
315 * at or below the break level. But only when the line is actually
316 * executed. Return TRUE and set breakpoint_name for skipped commands that
317 * decide to execute something themselves.
318 * Called from do_one_cmd() before executing a command.
319 */
320 void
321dbg_check_breakpoint(eap)
322 exarg_T *eap;
323{
324 char_u *p;
325
326 debug_skipped = FALSE;
327 if (debug_breakpoint_name != NULL)
328 {
329 if (!eap->skip)
330 {
331 /* replace K_SNR with "<SNR>" */
332 if (debug_breakpoint_name[0] == K_SPECIAL
333 && debug_breakpoint_name[1] == KS_EXTRA
334 && debug_breakpoint_name[2] == (int)KE_SNR)
335 p = (char_u *)"<SNR>";
336 else
337 p = (char_u *)"";
Bram Moolenaar555b2802005-05-19 21:08:39 +0000338 smsg((char_u *)_("Breakpoint in \"%s%s\" line %ld"),
339 p,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000340 debug_breakpoint_name + (*p == NUL ? 0 : 3),
341 (long)debug_breakpoint_lnum);
342 debug_breakpoint_name = NULL;
343 do_debug(eap->cmd);
344 }
345 else
346 {
347 debug_skipped = TRUE;
348 debug_skipped_name = debug_breakpoint_name;
349 debug_breakpoint_name = NULL;
350 }
351 }
352 else if (ex_nesting_level <= debug_break_level)
353 {
354 if (!eap->skip)
355 do_debug(eap->cmd);
356 else
357 {
358 debug_skipped = TRUE;
359 debug_skipped_name = NULL;
360 }
361 }
362}
363
364/*
365 * Go to debug mode if skipped by dbg_check_breakpoint() because eap->skip was
366 * set. Return TRUE when the debug mode is entered this time.
367 */
368 int
369dbg_check_skipped(eap)
370 exarg_T *eap;
371{
372 int prev_got_int;
373
374 if (debug_skipped)
375 {
376 /*
377 * Save the value of got_int and reset it. We don't want a previous
378 * interruption cause flushing the input buffer.
379 */
380 prev_got_int = got_int;
381 got_int = FALSE;
382 debug_breakpoint_name = debug_skipped_name;
383 /* eap->skip is TRUE */
384 eap->skip = FALSE;
385 (void)dbg_check_breakpoint(eap);
386 eap->skip = TRUE;
387 got_int |= prev_got_int;
388 return TRUE;
389 }
390 return FALSE;
391}
392
393/*
394 * The list of breakpoints: dbg_breakp.
395 * This is a grow-array of structs.
396 */
397struct debuggy
398{
399 int dbg_nr; /* breakpoint number */
400 int dbg_type; /* DBG_FUNC or DBG_FILE */
401 char_u *dbg_name; /* function or file name */
402 regprog_T *dbg_prog; /* regexp program */
403 linenr_T dbg_lnum; /* line number in function or file */
Bram Moolenaar05159a02005-02-26 23:04:13 +0000404 int dbg_forceit; /* ! used */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405};
406
407static garray_T dbg_breakp = {0, 0, sizeof(struct debuggy), 4, NULL};
Bram Moolenaar05159a02005-02-26 23:04:13 +0000408#define BREAKP(idx) (((struct debuggy *)dbg_breakp.ga_data)[idx])
409#define DEBUGGY(gap, idx) (((struct debuggy *)gap->ga_data)[idx])
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410static int last_breakp = 0; /* nr of last defined breakpoint */
411
Bram Moolenaar05159a02005-02-26 23:04:13 +0000412#ifdef FEAT_PROFILE
413/* Profiling uses file and func names similar to breakpoints. */
414static garray_T prof_ga = {0, 0, sizeof(struct debuggy), 4, NULL};
415#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416#define DBG_FUNC 1
417#define DBG_FILE 2
418
Bram Moolenaar05159a02005-02-26 23:04:13 +0000419static int dbg_parsearg __ARGS((char_u *arg, garray_T *gap));
420static linenr_T debuggy_find __ARGS((int file,char_u *fname, linenr_T after, garray_T *gap, int *fp));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421
422/*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000423 * Parse the arguments of ":profile", ":breakadd" or ":breakdel" and put them
424 * in the entry just after the last one in dbg_breakp. Note that "dbg_name"
425 * is allocated.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000426 * Returns FAIL for failure.
427 */
428 static int
Bram Moolenaar05159a02005-02-26 23:04:13 +0000429dbg_parsearg(arg, gap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000430 char_u *arg;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000431 garray_T *gap; /* either &dbg_breakp or &prof_ga */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432{
433 char_u *p = arg;
434 char_u *q;
435 struct debuggy *bp;
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000436 int here = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437
Bram Moolenaar05159a02005-02-26 23:04:13 +0000438 if (ga_grow(gap, 1) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439 return FAIL;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000440 bp = &DEBUGGY(gap, gap->ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000441
442 /* Find "func" or "file". */
443 if (STRNCMP(p, "func", 4) == 0)
444 bp->dbg_type = DBG_FUNC;
445 else if (STRNCMP(p, "file", 4) == 0)
446 bp->dbg_type = DBG_FILE;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000447 else if (
448#ifdef FEAT_PROFILE
449 gap != &prof_ga &&
450#endif
451 STRNCMP(p, "here", 4) == 0)
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000452 {
453 if (curbuf->b_ffname == NULL)
454 {
455 EMSG(_(e_noname));
456 return FAIL;
457 }
458 bp->dbg_type = DBG_FILE;
459 here = TRUE;
460 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461 else
462 {
463 EMSG2(_(e_invarg2), p);
464 return FAIL;
465 }
466 p = skipwhite(p + 4);
467
468 /* Find optional line number. */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000469 if (here)
470 bp->dbg_lnum = curwin->w_cursor.lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000471 else if (
472#ifdef FEAT_PROFILE
473 gap != &prof_ga &&
474#endif
475 VIM_ISDIGIT(*p))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476 {
477 bp->dbg_lnum = getdigits(&p);
478 p = skipwhite(p);
479 }
480 else
481 bp->dbg_lnum = 0;
482
483 /* Find the function or file name. Don't accept a function name with (). */
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000484 if ((!here && *p == NUL)
485 || (here && *p != NUL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000486 || (bp->dbg_type == DBG_FUNC && strstr((char *)p, "()") != NULL))
487 {
488 EMSG2(_(e_invarg2), arg);
489 return FAIL;
490 }
491
492 if (bp->dbg_type == DBG_FUNC)
493 bp->dbg_name = vim_strsave(p);
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000494 else if (here)
495 bp->dbg_name = vim_strsave(curbuf->b_ffname);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000496 else
497 {
498 /* Expand the file name in the same way as do_source(). This means
499 * doing it twice, so that $DIR/file gets expanded when $DIR is
500 * "~/dir". */
501#ifdef RISCOS
502 q = mch_munge_fname(p);
503#else
504 q = expand_env_save(p);
505#endif
506 if (q == NULL)
507 return FAIL;
508#ifdef RISCOS
509 p = mch_munge_fname(q);
510#else
511 p = expand_env_save(q);
512#endif
513 vim_free(q);
514 if (p == NULL)
515 return FAIL;
Bram Moolenaar843ee412004-06-30 16:16:41 +0000516 if (*p != '*')
517 {
518 bp->dbg_name = fix_fname(p);
519 vim_free(p);
520 }
521 else
522 bp->dbg_name = p;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000523 }
524
525 if (bp->dbg_name == NULL)
526 return FAIL;
527 return OK;
528}
529
530/*
531 * ":breakadd".
532 */
533 void
534ex_breakadd(eap)
535 exarg_T *eap;
536{
537 struct debuggy *bp;
538 char_u *pat;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000539 garray_T *gap;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
Bram Moolenaar05159a02005-02-26 23:04:13 +0000541 gap = &dbg_breakp;
542#ifdef FEAT_PROFILE
543 if (eap->cmdidx == CMD_profile)
544 gap = &prof_ga;
545#endif
546
547 if (dbg_parsearg(eap->arg, gap) == OK)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000548 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000549 bp = &DEBUGGY(gap, gap->ga_len);
550 bp->dbg_forceit = eap->forceit;
551
Bram Moolenaar071d4272004-06-13 20:20:40 +0000552 pat = file_pat_to_reg_pat(bp->dbg_name, NULL, NULL, FALSE);
553 if (pat != NULL)
554 {
555 bp->dbg_prog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
556 vim_free(pat);
557 }
558 if (pat == NULL || bp->dbg_prog == NULL)
559 vim_free(bp->dbg_name);
560 else
561 {
562 if (bp->dbg_lnum == 0) /* default line number is 1 */
563 bp->dbg_lnum = 1;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000564#ifdef FEAT_PROFILE
565 if (eap->cmdidx != CMD_profile)
566#endif
567 {
568 DEBUGGY(gap, gap->ga_len).dbg_nr = ++last_breakp;
569 ++debug_tick;
570 }
571 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572 }
573 }
574}
575
576/*
577 * ":debuggreedy".
578 */
579 void
580ex_debuggreedy(eap)
581 exarg_T *eap;
582{
583 if (eap->addr_count == 0 || eap->line2 != 0)
584 debug_greedy = TRUE;
585 else
586 debug_greedy = FALSE;
587}
588
589/*
Bram Moolenaard9fba312005-06-26 22:34:35 +0000590 * ":breakdel" and ":profdel".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000591 */
592 void
593ex_breakdel(eap)
594 exarg_T *eap;
595{
596 struct debuggy *bp, *bpi;
597 int nr;
598 int todel = -1;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000599 int del_all = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000600 int i;
601 linenr_T best_lnum = 0;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000602 garray_T *gap;
603
604 gap = &dbg_breakp;
605#ifdef FEAT_PROFILE
606 if (eap->cmdidx == CMD_profdel)
607 gap = &prof_ga;
608#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +0000609
610 if (vim_isdigit(*eap->arg))
611 {
612 /* ":breakdel {nr}" */
613 nr = atol((char *)eap->arg);
Bram Moolenaard9fba312005-06-26 22:34:35 +0000614 for (i = 0; i < gap->ga_len; ++i)
615 if (DEBUGGY(gap, i).dbg_nr == nr)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616 {
617 todel = i;
618 break;
619 }
620 }
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000621 else if (*eap->arg == '*')
622 {
623 todel = 0;
624 del_all = TRUE;
625 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626 else
627 {
628 /* ":breakdel {func|file} [lnum] {name}" */
Bram Moolenaard9fba312005-06-26 22:34:35 +0000629 if (dbg_parsearg(eap->arg, gap) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630 return;
Bram Moolenaard9fba312005-06-26 22:34:35 +0000631 bp = &DEBUGGY(gap, gap->ga_len);
632 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000634 bpi = &DEBUGGY(gap, i);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000635 if (bp->dbg_type == bpi->dbg_type
636 && STRCMP(bp->dbg_name, bpi->dbg_name) == 0
637 && (bp->dbg_lnum == bpi->dbg_lnum
638 || (bp->dbg_lnum == 0
639 && (best_lnum == 0
640 || bpi->dbg_lnum < best_lnum))))
641 {
642 todel = i;
643 best_lnum = bpi->dbg_lnum;
644 }
645 }
646 vim_free(bp->dbg_name);
647 }
648
649 if (todel < 0)
650 EMSG2(_("E161: Breakpoint not found: %s"), eap->arg);
651 else
Bram Moolenaard9fba312005-06-26 22:34:35 +0000652 {
653 while (gap->ga_len > 0)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000654 {
Bram Moolenaard9fba312005-06-26 22:34:35 +0000655 vim_free(DEBUGGY(gap, todel).dbg_name);
656 vim_free(DEBUGGY(gap, todel).dbg_prog);
657 --gap->ga_len;
658 if (todel < gap->ga_len)
659 mch_memmove(&DEBUGGY(gap, todel), &DEBUGGY(gap, todel + 1),
660 (gap->ga_len - todel) * sizeof(struct debuggy));
661#ifdef FEAT_PROFILE
662 if (eap->cmdidx == CMD_breakdel)
663#endif
664 ++debug_tick;
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000665 if (!del_all)
666 break;
667 }
Bram Moolenaard9fba312005-06-26 22:34:35 +0000668
669 /* If all breakpoints were removed clear the array. */
670 if (gap->ga_len == 0)
671 ga_clear(gap);
672 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673}
674
675/*
676 * ":breaklist".
677 */
678/*ARGSUSED*/
679 void
680ex_breaklist(eap)
681 exarg_T *eap;
682{
683 struct debuggy *bp;
684 int i;
685
686 if (dbg_breakp.ga_len == 0)
687 MSG(_("No breakpoints defined"));
688 else
689 for (i = 0; i < dbg_breakp.ga_len; ++i)
690 {
691 bp = &BREAKP(i);
692 smsg((char_u *)_("%3d %s %s line %ld"),
693 bp->dbg_nr,
694 bp->dbg_type == DBG_FUNC ? "func" : "file",
695 bp->dbg_name,
696 (long)bp->dbg_lnum);
697 }
698}
699
700/*
701 * Find a breakpoint for a function or sourced file.
702 * Returns line number at which to break; zero when no matching breakpoint.
703 */
704 linenr_T
705dbg_find_breakpoint(file, fname, after)
706 int file; /* TRUE for a file, FALSE for a function */
707 char_u *fname; /* file or function name */
708 linenr_T after; /* after this line number */
709{
Bram Moolenaar05159a02005-02-26 23:04:13 +0000710 return debuggy_find(file, fname, after, &dbg_breakp, NULL);
711}
712
713#if defined(FEAT_PROFILE) || defined(PROTO)
714/*
715 * Return TRUE if profiling is on for a function or sourced file.
716 */
717 int
718has_profiling(file, fname, fp)
719 int file; /* TRUE for a file, FALSE for a function */
720 char_u *fname; /* file or function name */
721 int *fp; /* return: forceit */
722{
723 return (debuggy_find(file, fname, (linenr_T)0, &prof_ga, fp)
724 != (linenr_T)0);
725}
726#endif
727
728/*
729 * Common code for dbg_find_breakpoint() and has_profiling().
730 */
731 static linenr_T
732debuggy_find(file, fname, after, gap, fp)
733 int file; /* TRUE for a file, FALSE for a function */
734 char_u *fname; /* file or function name */
735 linenr_T after; /* after this line number */
736 garray_T *gap; /* either &dbg_breakp or &prof_ga */
737 int *fp; /* if not NULL: return forceit */
738{
Bram Moolenaar071d4272004-06-13 20:20:40 +0000739 struct debuggy *bp;
740 int i;
741 linenr_T lnum = 0;
742 regmatch_T regmatch;
743 char_u *name = fname;
744 int prev_got_int;
745
Bram Moolenaar05159a02005-02-26 23:04:13 +0000746 /* Return quickly when there are no breakpoints. */
747 if (gap->ga_len == 0)
748 return (linenr_T)0;
749
Bram Moolenaar071d4272004-06-13 20:20:40 +0000750 /* Replace K_SNR in function name with "<SNR>". */
751 if (!file && fname[0] == K_SPECIAL)
752 {
753 name = alloc((unsigned)STRLEN(fname) + 3);
754 if (name == NULL)
755 name = fname;
756 else
757 {
758 STRCPY(name, "<SNR>");
759 STRCPY(name + 5, fname + 3);
760 }
761 }
762
Bram Moolenaar05159a02005-02-26 23:04:13 +0000763 for (i = 0; i < gap->ga_len; ++i)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 {
Bram Moolenaar05159a02005-02-26 23:04:13 +0000765 /* Skip entries that are not useful or are for a line that is beyond
766 * an already found breakpoint. */
767 bp = &DEBUGGY(gap, i);
768 if (((bp->dbg_type == DBG_FILE) == file && (
769#ifdef FEAT_PROFILE
770 gap == &prof_ga ||
771#endif
772 (bp->dbg_lnum > after && (lnum == 0 || bp->dbg_lnum < lnum)))))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000773 {
774 regmatch.regprog = bp->dbg_prog;
775 regmatch.rm_ic = FALSE;
776 /*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000777 * Save the value of got_int and reset it. We don't want a
778 * previous interruption cancel matching, only hitting CTRL-C
779 * while matching should abort it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 */
781 prev_got_int = got_int;
782 got_int = FALSE;
783 if (vim_regexec(&regmatch, name, (colnr_T)0))
Bram Moolenaar05159a02005-02-26 23:04:13 +0000784 {
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785 lnum = bp->dbg_lnum;
Bram Moolenaar05159a02005-02-26 23:04:13 +0000786 if (fp != NULL)
787 *fp = bp->dbg_forceit;
788 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000789 got_int |= prev_got_int;
790 }
791 }
792 if (name != fname)
793 vim_free(name);
794
795 return lnum;
796}
797
798/*
799 * Called when a breakpoint was encountered.
800 */
801 void
802dbg_breakpoint(name, lnum)
803 char_u *name;
804 linenr_T lnum;
805{
806 /* We need to check if this line is actually executed in do_one_cmd() */
807 debug_breakpoint_name = name;
808 debug_breakpoint_lnum = lnum;
809}
Bram Moolenaar05159a02005-02-26 23:04:13 +0000810
811
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000812# if defined(FEAT_PROFILE) || defined(FEAT_RELTIME) || defined(PROTO)
Bram Moolenaar05159a02005-02-26 23:04:13 +0000813/*
814 * Store the current time in "tm".
815 */
816 void
817profile_start(tm)
818 proftime_T *tm;
819{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000820# ifdef WIN3264
821 QueryPerformanceCounter(tm);
822# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000823 gettimeofday(tm, NULL);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000824# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000825}
826
827/*
828 * Compute the elapsed time from "tm" till now and store in "tm".
829 */
830 void
831profile_end(tm)
832 proftime_T *tm;
833{
834 proftime_T now;
835
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000836# ifdef WIN3264
837 QueryPerformanceCounter(&now);
838 tm->QuadPart = now.QuadPart - tm->QuadPart;
839# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000840 gettimeofday(&now, NULL);
841 tm->tv_usec = now.tv_usec - tm->tv_usec;
842 tm->tv_sec = now.tv_sec - tm->tv_sec;
843 if (tm->tv_usec < 0)
844 {
845 tm->tv_usec += 1000000;
846 --tm->tv_sec;
847 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000848# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000849}
850
851/*
852 * Subtract the time "tm2" from "tm".
853 */
854 void
855profile_sub(tm, tm2)
856 proftime_T *tm, *tm2;
857{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000858# ifdef WIN3264
859 tm->QuadPart -= tm2->QuadPart;
860# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000861 tm->tv_usec -= tm2->tv_usec;
862 tm->tv_sec -= tm2->tv_sec;
863 if (tm->tv_usec < 0)
864 {
865 tm->tv_usec += 1000000;
866 --tm->tv_sec;
867 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000868# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000869}
870
871/*
Bram Moolenaar433f7c82006-03-21 21:29:36 +0000872 * Return a string that represents the time in "tm".
873 * Uses a static buffer!
874 */
875 char *
876profile_msg(tm)
877 proftime_T *tm;
878{
879 static char buf[50];
880
881# ifdef WIN3264
882 LARGE_INTEGER fr;
883
884 QueryPerformanceFrequency(&fr);
885 sprintf(buf, "%10.6lf", (double)tm->QuadPart / (double)fr.QuadPart);
886# else
887 sprintf(buf, "%3ld.%06ld", (long)tm->tv_sec, (long)tm->tv_usec);
888#endif
889 return buf;
890}
891
892# endif /* FEAT_PROFILE || FEAT_RELTIME */
893
894# if defined(FEAT_PROFILE) || defined(PROTO)
895/*
896 * Functions for profiling.
897 */
898static void script_do_profile __ARGS((scriptitem_T *si));
899static void script_dump_profile __ARGS((FILE *fd));
900static proftime_T prof_wait_time;
901
902/*
903 * Set the time in "tm" to zero.
904 */
905 void
906profile_zero(tm)
907 proftime_T *tm;
908{
909# ifdef WIN3264
910 tm->QuadPart = 0;
911# else
912 tm->tv_usec = 0;
913 tm->tv_sec = 0;
914# endif
915}
916
917/*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000918 * Add the time "tm2" to "tm".
919 */
920 void
921profile_add(tm, tm2)
922 proftime_T *tm, *tm2;
923{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000924# ifdef WIN3264
925 tm->QuadPart += tm2->QuadPart;
926# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000927 tm->tv_usec += tm2->tv_usec;
928 tm->tv_sec += tm2->tv_sec;
929 if (tm->tv_usec >= 1000000)
930 {
931 tm->tv_usec -= 1000000;
932 ++tm->tv_sec;
933 }
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000934# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +0000935}
936
937/*
Bram Moolenaar1056d982006-03-09 22:37:52 +0000938 * Add the "self" time from the total time and the children's time.
939 */
940 void
941profile_self(self, total, children)
942 proftime_T *self, *total, *children;
943{
944 /* Check that the result won't be negative. Can happen with recursive
945 * calls. */
946#ifdef WIN3264
947 if (total->QuadPart <= children->QuadPart)
948 return;
949#else
950 if (total->tv_sec < children->tv_sec
951 || (total->tv_sec == children->tv_sec
952 && total->tv_usec <= children->tv_usec))
953 return;
954#endif
955 profile_add(self, total);
956 profile_sub(self, children);
957}
958
959/*
Bram Moolenaar05159a02005-02-26 23:04:13 +0000960 * Get the current waittime.
961 */
962 void
963profile_get_wait(tm)
964 proftime_T *tm;
965{
966 *tm = prof_wait_time;
967}
968
969/*
970 * Subtract the passed waittime since "tm" from "tma".
971 */
972 void
973profile_sub_wait(tm, tma)
974 proftime_T *tm, *tma;
975{
976 proftime_T tm3 = prof_wait_time;
977
978 profile_sub(&tm3, tm);
979 profile_sub(tma, &tm3);
980}
981
982/*
983 * Return TRUE if "tm1" and "tm2" are equal.
984 */
985 int
986profile_equal(tm1, tm2)
987 proftime_T *tm1, *tm2;
988{
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000989# ifdef WIN3264
990 return (tm1->QuadPart == tm2->QuadPart);
991# else
Bram Moolenaar05159a02005-02-26 23:04:13 +0000992 return (tm1->tv_usec == tm2->tv_usec && tm1->tv_sec == tm2->tv_sec);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +0000993# endif
994}
995
996/*
997 * Return <0, 0 or >0 if "tm1" < "tm2", "tm1" == "tm2" or "tm1" > "tm2"
998 */
999 int
1000profile_cmp(tm1, tm2)
1001 proftime_T *tm1, *tm2;
1002{
1003# ifdef WIN3264
1004 return (int)(tm2->QuadPart - tm1->QuadPart);
1005# else
1006 if (tm1->tv_sec == tm2->tv_sec)
1007 return tm2->tv_usec - tm1->tv_usec;
1008 return tm2->tv_sec - tm1->tv_sec;
1009# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00001010}
1011
Bram Moolenaar05159a02005-02-26 23:04:13 +00001012static char_u *profile_fname = NULL;
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001013static proftime_T pause_time;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001014
1015/*
1016 * ":profile cmd args"
1017 */
1018 void
1019ex_profile(eap)
1020 exarg_T *eap;
1021{
1022 char_u *e;
1023 int len;
1024
1025 e = skiptowhite(eap->arg);
Bram Moolenaara93fa7e2006-04-17 22:14:47 +00001026 len = (int)(e - eap->arg);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001027 e = skipwhite(e);
1028
1029 if (len == 5 && STRNCMP(eap->arg, "start", 5) == 0 && *e != NUL)
1030 {
1031 vim_free(profile_fname);
1032 profile_fname = vim_strsave(e);
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001033 do_profiling = PROF_YES;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001034 profile_zero(&prof_wait_time);
1035 set_vim_var_nr(VV_PROFILING, 1L);
1036 }
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001037 else if (do_profiling == PROF_NONE)
Bram Moolenaar05159a02005-02-26 23:04:13 +00001038 EMSG(_("E750: First use :profile start <fname>"));
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001039 else if (STRCMP(eap->arg, "pause") == 0)
1040 {
1041 if (do_profiling == PROF_YES)
1042 profile_start(&pause_time);
1043 do_profiling = PROF_PAUSED;
1044 }
1045 else if (STRCMP(eap->arg, "continue") == 0)
1046 {
1047 if (do_profiling == PROF_PAUSED)
1048 {
1049 profile_end(&pause_time);
1050 profile_add(&prof_wait_time, &pause_time);
1051 }
1052 do_profiling = PROF_YES;
1053 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00001054 else
1055 {
1056 /* The rest is similar to ":breakadd". */
1057 ex_breakadd(eap);
1058 }
1059}
1060
1061/*
1062 * Dump the profiling info.
1063 */
1064 void
1065profile_dump()
1066{
1067 FILE *fd;
1068
1069 if (profile_fname != NULL)
1070 {
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001071 fd = mch_fopen((char *)profile_fname, "w");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001072 if (fd == NULL)
1073 EMSG2(_(e_notopen), profile_fname);
1074 else
1075 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00001076 script_dump_profile(fd);
Bram Moolenaar8cd06ca2005-02-28 22:44:58 +00001077 func_dump_profile(fd);
Bram Moolenaar05159a02005-02-26 23:04:13 +00001078 fclose(fd);
1079 }
1080 }
1081}
1082
1083/*
1084 * Start profiling script "fp".
1085 */
1086 static void
1087script_do_profile(si)
1088 scriptitem_T *si;
1089{
1090 si->sn_pr_count = 0;
1091 profile_zero(&si->sn_pr_total);
1092 profile_zero(&si->sn_pr_self);
1093
1094 ga_init2(&si->sn_prl_ga, sizeof(sn_prl_T), 100);
1095 si->sn_prl_idx = -1;
1096 si->sn_prof_on = TRUE;
1097 si->sn_pr_nest = 0;
1098}
1099
1100/*
1101 * save time when starting to invoke another script or function.
1102 */
1103 void
1104script_prof_save(tm)
1105 proftime_T *tm; /* place to store wait time */
1106{
1107 scriptitem_T *si;
1108
1109 if (current_SID > 0 && current_SID <= script_items.ga_len)
1110 {
1111 si = &SCRIPT_ITEM(current_SID);
1112 if (si->sn_prof_on && si->sn_pr_nest++ == 0)
1113 profile_start(&si->sn_pr_child);
1114 }
1115 profile_get_wait(tm);
1116}
1117
1118/*
1119 * Count time spent in children after invoking another script or function.
1120 */
1121 void
1122script_prof_restore(tm)
1123 proftime_T *tm;
1124{
1125 scriptitem_T *si;
1126
1127 if (current_SID > 0 && current_SID <= script_items.ga_len)
1128 {
1129 si = &SCRIPT_ITEM(current_SID);
1130 if (si->sn_prof_on && --si->sn_pr_nest == 0)
1131 {
1132 profile_end(&si->sn_pr_child);
1133 profile_sub_wait(tm, &si->sn_pr_child); /* don't count wait time */
1134 profile_add(&si->sn_pr_children, &si->sn_pr_child);
1135 profile_add(&si->sn_prl_children, &si->sn_pr_child);
1136 }
1137 }
1138}
1139
1140static proftime_T inchar_time;
1141
1142/*
1143 * Called when starting to wait for the user to type a character.
1144 */
1145 void
1146prof_inchar_enter()
1147{
1148 profile_start(&inchar_time);
1149}
1150
1151/*
1152 * Called when finished waiting for the user to type a character.
1153 */
1154 void
1155prof_inchar_exit()
1156{
1157 profile_end(&inchar_time);
1158 profile_add(&prof_wait_time, &inchar_time);
1159}
1160
1161/*
1162 * Dump the profiling results for all scripts in file "fd".
1163 */
1164 static void
1165script_dump_profile(fd)
1166 FILE *fd;
1167{
1168 int id;
1169 scriptitem_T *si;
1170 int i;
1171 FILE *sfd;
1172 sn_prl_T *pp;
1173
1174 for (id = 1; id <= script_items.ga_len; ++id)
1175 {
1176 si = &SCRIPT_ITEM(id);
1177 if (si->sn_prof_on)
1178 {
1179 fprintf(fd, "SCRIPT %s\n", si->sn_name);
1180 if (si->sn_pr_count == 1)
1181 fprintf(fd, "Sourced 1 time\n");
1182 else
1183 fprintf(fd, "Sourced %d times\n", si->sn_pr_count);
1184 fprintf(fd, "Total time: %s\n", profile_msg(&si->sn_pr_total));
1185 fprintf(fd, " Self time: %s\n", profile_msg(&si->sn_pr_self));
1186 fprintf(fd, "\n");
1187 fprintf(fd, "count total (s) self (s)\n");
1188
Bram Moolenaarbfd8fc02005-09-20 23:22:24 +00001189 sfd = mch_fopen((char *)si->sn_name, "r");
Bram Moolenaar05159a02005-02-26 23:04:13 +00001190 if (sfd == NULL)
1191 fprintf(fd, "Cannot open file!\n");
1192 else
1193 {
1194 for (i = 0; i < si->sn_prl_ga.ga_len; ++i)
1195 {
1196 if (vim_fgets(IObuff, IOSIZE, sfd))
1197 break;
1198 pp = &PRL_ITEM(si, i);
1199 if (pp->snp_count > 0)
1200 {
1201 fprintf(fd, "%5d ", pp->snp_count);
1202 if (profile_equal(&pp->sn_prl_total, &pp->sn_prl_self))
1203 fprintf(fd, " ");
1204 else
1205 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_total));
1206 fprintf(fd, "%s ", profile_msg(&pp->sn_prl_self));
1207 }
1208 else
1209 fprintf(fd, " ");
1210 fprintf(fd, "%s", IObuff);
1211 }
1212 fclose(sfd);
1213 }
1214 fprintf(fd, "\n");
1215 }
1216 }
1217}
1218
1219/*
1220 * Return TRUE when a function defined in the current script should be
1221 * profiled.
1222 */
1223 int
1224prof_def_func()
1225{
Bram Moolenaar53180ce2005-07-05 21:48:14 +00001226 if (current_SID > 0)
1227 return SCRIPT_ITEM(current_SID).sn_pr_force;
1228 return FALSE;
Bram Moolenaar05159a02005-02-26 23:04:13 +00001229}
1230
1231# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001232#endif
1233
1234/*
1235 * If 'autowrite' option set, try to write the file.
1236 * Careful: autocommands may make "buf" invalid!
1237 *
1238 * return FAIL for failure, OK otherwise
1239 */
1240 int
1241autowrite(buf, forceit)
1242 buf_T *buf;
1243 int forceit;
1244{
1245 if (!(p_aw || p_awa) || !p_write
1246#ifdef FEAT_QUICKFIX
1247 /* never autowrite a "nofile" or "nowrite" buffer */
1248 || bt_dontwrite(buf)
1249#endif
1250 || (!forceit && buf->b_p_ro) || buf->b_ffname == NULL)
1251 return FAIL;
1252 return buf_write_all(buf, forceit);
1253}
1254
1255/*
1256 * flush all buffers, except the ones that are readonly
1257 */
1258 void
1259autowrite_all()
1260{
1261 buf_T *buf;
1262
1263 if (!(p_aw || p_awa) || !p_write)
1264 return;
1265 for (buf = firstbuf; buf; buf = buf->b_next)
1266 if (bufIsChanged(buf) && !buf->b_p_ro)
1267 {
1268 (void)buf_write_all(buf, FALSE);
1269#ifdef FEAT_AUTOCMD
1270 /* an autocommand may have deleted the buffer */
1271 if (!buf_valid(buf))
1272 buf = firstbuf;
1273#endif
1274 }
1275}
1276
1277/*
1278 * return TRUE if buffer was changed and cannot be abandoned.
1279 */
1280/*ARGSUSED*/
1281 int
1282check_changed(buf, checkaw, mult_win, forceit, allbuf)
1283 buf_T *buf;
1284 int checkaw; /* do autowrite if buffer was changed */
1285 int mult_win; /* check also when several wins for the buf */
1286 int forceit;
1287 int allbuf; /* may write all buffers */
1288{
1289 if ( !forceit
1290 && bufIsChanged(buf)
1291 && (mult_win || buf->b_nwindows <= 1)
1292 && (!checkaw || autowrite(buf, forceit) == FAIL))
1293 {
1294#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1295 if ((p_confirm || cmdmod.confirm) && p_write)
1296 {
1297 buf_T *buf2;
1298 int count = 0;
1299
1300 if (allbuf)
1301 for (buf2 = firstbuf; buf2 != NULL; buf2 = buf2->b_next)
1302 if (bufIsChanged(buf2)
1303 && (buf2->b_ffname != NULL
1304# ifdef FEAT_BROWSE
1305 || cmdmod.browse
1306# endif
1307 ))
1308 ++count;
1309# ifdef FEAT_AUTOCMD
1310 if (!buf_valid(buf))
1311 /* Autocommand deleted buffer, oops! It's not changed now. */
1312 return FALSE;
1313# endif
1314 dialog_changed(buf, count > 1);
1315# ifdef FEAT_AUTOCMD
1316 if (!buf_valid(buf))
1317 /* Autocommand deleted buffer, oops! It's not changed now. */
1318 return FALSE;
1319# endif
1320 return bufIsChanged(buf);
1321 }
1322#endif
1323 EMSG(_(e_nowrtmsg));
1324 return TRUE;
1325 }
1326 return FALSE;
1327}
1328
1329#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG) || defined(PROTO)
1330
1331#if defined(FEAT_BROWSE) || defined(PROTO)
1332/*
1333 * When wanting to write a file without a file name, ask the user for a name.
1334 */
1335 void
1336browse_save_fname(buf)
1337 buf_T *buf;
1338{
1339 if (buf->b_fname == NULL)
1340 {
1341 char_u *fname;
1342
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001343 fname = do_browse(BROWSE_SAVE, (char_u *)_("Save As"),
1344 NULL, NULL, NULL, NULL, buf);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 if (fname != NULL)
1346 {
1347 if (setfname(buf, fname, NULL, TRUE) == OK)
1348 buf->b_flags |= BF_NOTEDITED;
1349 vim_free(fname);
1350 }
1351 }
1352}
1353#endif
1354
1355/*
1356 * Ask the user what to do when abondoning a changed buffer.
1357 * Must check 'write' option first!
1358 */
1359 void
1360dialog_changed(buf, checkall)
1361 buf_T *buf;
1362 int checkall; /* may abandon all changed buffers */
1363{
1364 char_u buff[IOSIZE];
1365 int ret;
1366 buf_T *buf2;
1367
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00001368 dialog_msg(buff, _("Save changes to \"%s\"?"),
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 (buf->b_fname != NULL) ?
1370 buf->b_fname : (char_u *)_("Untitled"));
1371 if (checkall)
1372 ret = vim_dialog_yesnoallcancel(VIM_QUESTION, NULL, buff, 1);
1373 else
1374 ret = vim_dialog_yesnocancel(VIM_QUESTION, NULL, buff, 1);
1375
1376 if (ret == VIM_YES)
1377 {
1378#ifdef FEAT_BROWSE
1379 /* May get file name, when there is none */
1380 browse_save_fname(buf);
1381#endif
1382 if (buf->b_fname != NULL) /* didn't hit Cancel */
1383 (void)buf_write_all(buf, FALSE);
1384 }
1385 else if (ret == VIM_NO)
1386 {
1387 unchanged(buf, TRUE);
1388 }
1389 else if (ret == VIM_ALL)
1390 {
1391 /*
1392 * Write all modified files that can be written.
1393 * Skip readonly buffers, these need to be confirmed
1394 * individually.
1395 */
1396 for (buf2 = firstbuf; buf2 != NULL; buf2 = buf2->b_next)
1397 {
1398 if (bufIsChanged(buf2)
1399 && (buf2->b_ffname != NULL
1400#ifdef FEAT_BROWSE
1401 || cmdmod.browse
1402#endif
1403 )
1404 && !buf2->b_p_ro)
1405 {
1406#ifdef FEAT_BROWSE
1407 /* May get file name, when there is none */
1408 browse_save_fname(buf2);
1409#endif
1410 if (buf2->b_fname != NULL) /* didn't hit Cancel */
1411 (void)buf_write_all(buf2, FALSE);
1412#ifdef FEAT_AUTOCMD
1413 /* an autocommand may have deleted the buffer */
1414 if (!buf_valid(buf2))
1415 buf2 = firstbuf;
1416#endif
1417 }
1418 }
1419 }
1420 else if (ret == VIM_DISCARDALL)
1421 {
1422 /*
1423 * mark all buffers as unchanged
1424 */
1425 for (buf2 = firstbuf; buf2 != NULL; buf2 = buf2->b_next)
1426 unchanged(buf2, TRUE);
1427 }
1428}
1429#endif
1430
1431/*
1432 * Return TRUE if the buffer "buf" can be abandoned, either by making it
1433 * hidden, autowriting it or unloading it.
1434 */
1435 int
1436can_abandon(buf, forceit)
1437 buf_T *buf;
1438 int forceit;
1439{
1440 return ( P_HID(buf)
1441 || !bufIsChanged(buf)
1442 || buf->b_nwindows > 1
1443 || autowrite(buf, forceit) == OK
1444 || forceit);
1445}
1446
1447/*
1448 * Return TRUE if any buffer was changed and cannot be abandoned.
1449 * That changed buffer becomes the current buffer.
1450 */
1451 int
1452check_changed_any(hidden)
1453 int hidden; /* Only check hidden buffers */
1454{
1455 buf_T *buf;
1456 int save;
1457#ifdef FEAT_WINDOWS
1458 win_T *wp;
1459#endif
1460
1461 for (;;)
1462 {
1463 /* check curbuf first: if it was changed we can't abandon it */
1464 if (!hidden && curbufIsChanged())
1465 buf = curbuf;
1466 else
1467 {
1468 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
1469 if ((!hidden || buf->b_nwindows == 0) && bufIsChanged(buf))
1470 break;
1471 }
1472 if (buf == NULL) /* No buffers changed */
1473 return FALSE;
1474
1475 if (check_changed(buf, p_awa, TRUE, FALSE, TRUE) && buf_valid(buf))
1476 break; /* didn't save - still changes */
1477 }
1478
1479 exiting = FALSE;
1480#if defined(FEAT_GUI_DIALOG) || defined(FEAT_CON_DIALOG)
1481 /*
1482 * When ":confirm" used, don't give an error message.
1483 */
1484 if (!(p_confirm || cmdmod.confirm))
1485#endif
1486 {
1487 /* There must be a wait_return for this message, do_buffer()
1488 * may cause a redraw. But wait_return() is a no-op when vgetc()
1489 * is busy (Quit used from window menu), then make sure we don't
1490 * cause a scroll up. */
Bram Moolenaar61660ea2006-04-07 21:40:07 +00001491 if (vgetc_busy > 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 {
1493 msg_row = cmdline_row;
1494 msg_col = 0;
1495 msg_didout = FALSE;
1496 }
1497 if (EMSG2(_("E162: No write since last change for buffer \"%s\""),
1498 buf_spname(buf) != NULL ? (char_u *)buf_spname(buf) :
1499 buf->b_fname))
1500 {
1501 save = no_wait_return;
1502 no_wait_return = FALSE;
1503 wait_return(FALSE);
1504 no_wait_return = save;
1505 }
1506 }
1507
1508#ifdef FEAT_WINDOWS
1509 /* Try to find a window that contains the buffer. */
1510 if (buf != curbuf)
1511 for (wp = firstwin; wp != NULL; wp = wp->w_next)
1512 if (wp->w_buffer == buf)
1513 {
1514 win_goto(wp);
1515# ifdef FEAT_AUTOCMD
1516 /* Paranoia: did autocms wipe out the buffer with changes? */
1517 if (!buf_valid(buf))
1518 return TRUE;
1519# endif
1520 break;
1521 }
1522#endif
1523
1524 /* Open the changed buffer in the current window. */
1525 if (buf != curbuf)
1526 set_curbuf(buf, DOBUF_GOTO);
1527
1528 return TRUE;
1529}
1530
1531/*
1532 * return FAIL if there is no file name, OK if there is one
1533 * give error message for FAIL
1534 */
1535 int
1536check_fname()
1537{
1538 if (curbuf->b_ffname == NULL)
1539 {
1540 EMSG(_(e_noname));
1541 return FAIL;
1542 }
1543 return OK;
1544}
1545
1546/*
1547 * flush the contents of a buffer, unless it has no file name
1548 *
1549 * return FAIL for failure, OK otherwise
1550 */
1551 int
1552buf_write_all(buf, forceit)
1553 buf_T *buf;
1554 int forceit;
1555{
1556 int retval;
1557#ifdef FEAT_AUTOCMD
1558 buf_T *old_curbuf = curbuf;
1559#endif
1560
1561 retval = (buf_write(buf, buf->b_ffname, buf->b_fname,
1562 (linenr_T)1, buf->b_ml.ml_line_count, NULL,
1563 FALSE, forceit, TRUE, FALSE));
1564#ifdef FEAT_AUTOCMD
1565 if (curbuf != old_curbuf)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00001566 {
1567 msg_source(hl_attr(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 MSG(_("Warning: Entered other buffer unexpectedly (check autocommands)"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00001569 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570#endif
1571 return retval;
1572}
1573
1574/*
1575 * Code to handle the argument list.
1576 */
1577
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001578static char_u *do_one_arg __ARGS((char_u *str));
1579static int do_arglist __ARGS((char_u *str, int what, int after));
1580static void alist_check_arg_idx __ARGS((void));
1581static int editing_arg_idx __ARGS((win_T *win));
1582#ifdef FEAT_LISTCMDS
1583static int alist_add_list __ARGS((int count, char_u **files, int after));
1584#endif
1585#define AL_SET 1
1586#define AL_ADD 2
1587#define AL_DEL 3
1588
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589/*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001590 * Isolate one argument, taking backticks.
1591 * Changes the argument in-place, puts a NUL after it. Backticks remain.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 * Return a pointer to the start of the next argument.
1593 */
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001594 static char_u *
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595do_one_arg(str)
1596 char_u *str;
1597{
1598 char_u *p;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 int inbacktick;
1600
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 inbacktick = FALSE;
1602 for (p = str; *str; ++str)
1603 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001604 /* When the backslash is used for escaping the special meaning of a
1605 * character we need to keep it until wildcard expansion. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001606 if (rem_backslash(str))
1607 {
1608 *p++ = *str++;
1609 *p++ = *str;
1610 }
1611 else
1612 {
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001613 /* An item ends at a space not in backticks */
1614 if (!inbacktick && vim_isspace(*str))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001616 if (*str == '`')
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617 inbacktick ^= TRUE;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001618 *p++ = *str;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 }
1620 }
1621 str = skipwhite(str);
1622 *p = NUL;
1623
1624 return str;
1625}
1626
Bram Moolenaar86b68352004-12-27 21:59:20 +00001627/*
1628 * Separate the arguments in "str" and return a list of pointers in the
1629 * growarray "gap".
1630 */
1631 int
1632get_arglist(gap, str)
1633 garray_T *gap;
1634 char_u *str;
1635{
1636 ga_init2(gap, (int)sizeof(char_u *), 20);
1637 while (*str != NUL)
1638 {
1639 if (ga_grow(gap, 1) == FAIL)
1640 {
1641 ga_clear(gap);
1642 return FAIL;
1643 }
1644 ((char_u **)gap->ga_data)[gap->ga_len++] = str;
1645
1646 /* Isolate one argument, change it in-place, put a NUL after it. */
1647 str = do_one_arg(str);
1648 }
1649 return OK;
1650}
1651
Bram Moolenaar7df351e2006-01-23 22:30:28 +00001652#if defined(FEAT_QUICKFIX) || defined(FEAT_SYN_HL) || defined(PROTO)
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00001653/*
1654 * Parse a list of arguments (file names), expand them and return in
1655 * "fnames[fcountp]".
1656 * Return FAIL or OK.
1657 */
1658 int
1659get_arglist_exp(str, fcountp, fnamesp)
1660 char_u *str;
1661 int *fcountp;
1662 char_u ***fnamesp;
1663{
1664 garray_T ga;
1665 int i;
1666
1667 if (get_arglist(&ga, str) == FAIL)
1668 return FAIL;
1669 i = gen_expand_wildcards(ga.ga_len, (char_u **)ga.ga_data,
1670 fcountp, fnamesp, EW_FILE|EW_NOTFOUND);
1671 ga_clear(&ga);
1672 return i;
1673}
1674#endif
1675
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676#if defined(FEAT_GUI) || defined(FEAT_CLIENTSERVER) || defined(PROTO)
1677/*
1678 * Redefine the argument list.
1679 */
1680 void
1681set_arglist(str)
1682 char_u *str;
1683{
1684 do_arglist(str, AL_SET, 0);
1685}
1686#endif
1687
1688/*
1689 * "what" == AL_SET: Redefine the argument list to 'str'.
1690 * "what" == AL_ADD: add files in 'str' to the argument list after "after".
1691 * "what" == AL_DEL: remove files in 'str' from the argument list.
1692 *
1693 * Return FAIL for failure, OK otherwise.
1694 */
1695/*ARGSUSED*/
1696 static int
1697do_arglist(str, what, after)
1698 char_u *str;
1699 int what;
1700 int after; /* 0 means before first one */
1701{
1702 garray_T new_ga;
1703 int exp_count;
1704 char_u **exp_files;
1705 int i;
1706#ifdef FEAT_LISTCMDS
1707 char_u *p;
1708 int match;
1709#endif
1710
1711 /*
1712 * Collect all file name arguments in "new_ga".
1713 */
Bram Moolenaar86b68352004-12-27 21:59:20 +00001714 if (get_arglist(&new_ga, str) == FAIL)
1715 return FAIL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716
1717#ifdef FEAT_LISTCMDS
1718 if (what == AL_DEL)
1719 {
1720 regmatch_T regmatch;
1721 int didone;
1722
1723 /*
1724 * Delete the items: use each item as a regexp and find a match in the
1725 * argument list.
1726 */
1727#ifdef CASE_INSENSITIVE_FILENAME
1728 regmatch.rm_ic = TRUE; /* Always ignore case */
1729#else
1730 regmatch.rm_ic = FALSE; /* Never ignore case */
1731#endif
1732 for (i = 0; i < new_ga.ga_len && !got_int; ++i)
1733 {
1734 p = ((char_u **)new_ga.ga_data)[i];
1735 p = file_pat_to_reg_pat(p, NULL, NULL, FALSE);
1736 if (p == NULL)
1737 break;
1738 regmatch.regprog = vim_regcomp(p, p_magic ? RE_MAGIC : 0);
1739 if (regmatch.regprog == NULL)
1740 {
1741 vim_free(p);
1742 break;
1743 }
1744
1745 didone = FALSE;
1746 for (match = 0; match < ARGCOUNT; ++match)
1747 if (vim_regexec(&regmatch, alist_name(&ARGLIST[match]),
1748 (colnr_T)0))
1749 {
1750 didone = TRUE;
1751 vim_free(ARGLIST[match].ae_fname);
1752 mch_memmove(ARGLIST + match, ARGLIST + match + 1,
1753 (ARGCOUNT - match - 1) * sizeof(aentry_T));
1754 --ALIST(curwin)->al_ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 if (curwin->w_arg_idx > match)
1756 --curwin->w_arg_idx;
1757 --match;
1758 }
1759
1760 vim_free(regmatch.regprog);
1761 vim_free(p);
1762 if (!didone)
1763 EMSG2(_(e_nomatch2), ((char_u **)new_ga.ga_data)[i]);
1764 }
1765 ga_clear(&new_ga);
1766 }
1767 else
1768#endif
1769 {
1770 i = expand_wildcards(new_ga.ga_len, (char_u **)new_ga.ga_data,
1771 &exp_count, &exp_files, EW_DIR|EW_FILE|EW_ADDSLASH|EW_NOTFOUND);
1772 ga_clear(&new_ga);
1773 if (i == FAIL)
1774 return FAIL;
1775 if (exp_count == 0)
1776 {
1777 EMSG(_(e_nomatch));
1778 return FAIL;
1779 }
1780
1781#ifdef FEAT_LISTCMDS
1782 if (what == AL_ADD)
1783 {
1784 (void)alist_add_list(exp_count, exp_files, after);
1785 vim_free(exp_files);
1786 }
1787 else /* what == AL_SET */
1788#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00001789 alist_set(ALIST(curwin), exp_count, exp_files, FALSE, NULL, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790 }
1791
1792 alist_check_arg_idx();
1793
1794 return OK;
1795}
1796
1797/*
1798 * Check the validity of the arg_idx for each other window.
1799 */
1800 static void
1801alist_check_arg_idx()
1802{
1803#ifdef FEAT_WINDOWS
1804 win_T *win;
Bram Moolenaarf740b292006-02-16 22:11:02 +00001805 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806
Bram Moolenaarf740b292006-02-16 22:11:02 +00001807 FOR_ALL_TAB_WINDOWS(tp, win)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001808 if (win->w_alist == curwin->w_alist)
1809 check_arg_idx(win);
1810#else
1811 check_arg_idx(curwin);
1812#endif
1813}
1814
1815/*
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001816 * Return TRUE if window "win" is editing then file at the current argument
1817 * index.
1818 */
1819 static int
1820editing_arg_idx(win)
1821 win_T *win;
1822{
1823 return !(win->w_arg_idx >= WARGCOUNT(win)
1824 || (win->w_buffer->b_fnum
1825 != WARGLIST(win)[win->w_arg_idx].ae_fnum
1826 && (win->w_buffer->b_ffname == NULL
1827 || !(fullpathcmp(
1828 alist_name(&WARGLIST(win)[win->w_arg_idx]),
1829 win->w_buffer->b_ffname, TRUE) & FPC_SAME))));
1830}
1831
1832/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 * Check if window "win" is editing the w_arg_idx file in its argument list.
1834 */
1835 void
1836check_arg_idx(win)
1837 win_T *win;
1838{
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001839 if (WARGCOUNT(win) > 1 && !editing_arg_idx(win))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 {
1841 /* We are not editing the current entry in the argument list.
1842 * Set "arg_had_last" if we are editing the last one. */
1843 win->w_arg_idx_invalid = TRUE;
1844 if (win->w_arg_idx != WARGCOUNT(win) - 1
1845 && arg_had_last == FALSE
1846#ifdef FEAT_WINDOWS
1847 && ALIST(win) == &global_alist
1848#endif
1849 && GARGCOUNT > 0
1850 && win->w_arg_idx < GARGCOUNT
1851 && (win->w_buffer->b_fnum == GARGLIST[GARGCOUNT - 1].ae_fnum
1852 || (win->w_buffer->b_ffname != NULL
1853 && (fullpathcmp(alist_name(&GARGLIST[GARGCOUNT - 1]),
1854 win->w_buffer->b_ffname, TRUE) & FPC_SAME))))
1855 arg_had_last = TRUE;
1856 }
1857 else
1858 {
1859 /* We are editing the current entry in the argument list.
1860 * Set "arg_had_last" if it's also the last one */
1861 win->w_arg_idx_invalid = FALSE;
1862 if (win->w_arg_idx == WARGCOUNT(win) - 1
1863#ifdef FEAT_WINDOWS
1864 && win->w_alist == &global_alist
1865#endif
1866 )
1867 arg_had_last = TRUE;
1868 }
1869}
1870
1871/*
1872 * ":args", ":argslocal" and ":argsglobal".
1873 */
1874 void
1875ex_args(eap)
1876 exarg_T *eap;
1877{
1878 int i;
1879
1880 if (eap->cmdidx != CMD_args)
1881 {
1882#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
1883 alist_unlink(ALIST(curwin));
1884 if (eap->cmdidx == CMD_argglobal)
1885 ALIST(curwin) = &global_alist;
1886 else /* eap->cmdidx == CMD_arglocal */
1887 alist_new();
1888#else
1889 ex_ni(eap);
1890 return;
1891#endif
1892 }
1893
1894 if (!ends_excmd(*eap->arg))
1895 {
1896 /*
1897 * ":args file ..": define new argument list, handle like ":next"
1898 * Also for ":argslocal file .." and ":argsglobal file ..".
1899 */
1900 ex_next(eap);
1901 }
1902 else
1903#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
1904 if (eap->cmdidx == CMD_args)
1905#endif
1906 {
1907 /*
1908 * ":args": list arguments.
1909 */
1910 if (ARGCOUNT > 0)
1911 {
1912 /* Overwrite the command, for a short list there is no scrolling
1913 * required and no wait_return(). */
1914 gotocmdline(TRUE);
1915 for (i = 0; i < ARGCOUNT; ++i)
1916 {
1917 if (i == curwin->w_arg_idx)
1918 msg_putchar('[');
1919 msg_outtrans(alist_name(&ARGLIST[i]));
1920 if (i == curwin->w_arg_idx)
1921 msg_putchar(']');
1922 msg_putchar(' ');
1923 }
1924 }
1925 }
1926#if defined(FEAT_WINDOWS) && defined(FEAT_LISTCMDS)
1927 else if (eap->cmdidx == CMD_arglocal)
1928 {
1929 garray_T *gap = &curwin->w_alist->al_ga;
1930
1931 /*
1932 * ":argslocal": make a local copy of the global argument list.
1933 */
1934 if (ga_grow(gap, GARGCOUNT) == OK)
1935 for (i = 0; i < GARGCOUNT; ++i)
1936 if (GARGLIST[i].ae_fname != NULL)
1937 {
1938 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fname =
1939 vim_strsave(GARGLIST[i].ae_fname);
1940 AARGLIST(curwin->w_alist)[gap->ga_len].ae_fnum =
1941 GARGLIST[i].ae_fnum;
1942 ++gap->ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 }
1944 }
1945#endif
1946}
1947
1948/*
1949 * ":previous", ":sprevious", ":Next" and ":sNext".
1950 */
1951 void
1952ex_previous(eap)
1953 exarg_T *eap;
1954{
1955 /* If past the last one already, go to the last one. */
1956 if (curwin->w_arg_idx - (int)eap->line2 >= ARGCOUNT)
1957 do_argfile(eap, ARGCOUNT - 1);
1958 else
1959 do_argfile(eap, curwin->w_arg_idx - (int)eap->line2);
1960}
1961
1962/*
1963 * ":rewind", ":first", ":sfirst" and ":srewind".
1964 */
1965 void
1966ex_rewind(eap)
1967 exarg_T *eap;
1968{
1969 do_argfile(eap, 0);
1970}
1971
1972/*
1973 * ":last" and ":slast".
1974 */
1975 void
1976ex_last(eap)
1977 exarg_T *eap;
1978{
1979 do_argfile(eap, ARGCOUNT - 1);
1980}
1981
1982/*
1983 * ":argument" and ":sargument".
1984 */
1985 void
1986ex_argument(eap)
1987 exarg_T *eap;
1988{
1989 int i;
1990
1991 if (eap->addr_count > 0)
1992 i = eap->line2 - 1;
1993 else
1994 i = curwin->w_arg_idx;
1995 do_argfile(eap, i);
1996}
1997
1998/*
1999 * Edit file "argn" of the argument lists.
2000 */
2001 void
2002do_argfile(eap, argn)
2003 exarg_T *eap;
2004 int argn;
2005{
2006 int other;
2007 char_u *p;
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002008 int old_arg_idx = curwin->w_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009
2010 if (argn < 0 || argn >= ARGCOUNT)
2011 {
2012 if (ARGCOUNT <= 1)
2013 EMSG(_("E163: There is only one file to edit"));
2014 else if (argn < 0)
2015 EMSG(_("E164: Cannot go before first file"));
2016 else
2017 EMSG(_("E165: Cannot go beyond last file"));
2018 }
2019 else
2020 {
2021 setpcmark();
2022#ifdef FEAT_GUI
2023 need_mouse_correct = TRUE;
2024#endif
2025
2026#ifdef FEAT_WINDOWS
Bram Moolenaardf1bdc92006-02-23 21:32:16 +00002027 /* split window or create new tab page first */
2028 if (*eap->cmd == 's' || cmdmod.tab != 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 {
2030 if (win_split(0, 0) == FAIL)
2031 return;
2032# ifdef FEAT_SCROLLBIND
2033 curwin->w_p_scb = FALSE;
2034# endif
2035 }
2036 else
2037#endif
2038 {
2039 /*
2040 * if 'hidden' set, only check for changed file when re-editing
2041 * the same buffer
2042 */
2043 other = TRUE;
2044 if (P_HID(curbuf))
2045 {
2046 p = fix_fname(alist_name(&ARGLIST[argn]));
2047 other = otherfile(p);
2048 vim_free(p);
2049 }
2050 if ((!P_HID(curbuf) || !other)
2051 && check_changed(curbuf, TRUE, !other, eap->forceit, FALSE))
2052 return;
2053 }
2054
2055 curwin->w_arg_idx = argn;
2056 if (argn == ARGCOUNT - 1
2057#ifdef FEAT_WINDOWS
2058 && curwin->w_alist == &global_alist
2059#endif
2060 )
2061 arg_had_last = TRUE;
2062
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002063 /* Edit the file; always use the last known line number.
2064 * When it fails (e.g. Abort for already edited file) restore the
2065 * argument index. */
2066 if (do_ecmd(0, alist_name(&ARGLIST[curwin->w_arg_idx]), NULL,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 eap, ECMD_LAST,
2068 (P_HID(curwin->w_buffer) ? ECMD_HIDE : 0) +
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002069 (eap->forceit ? ECMD_FORCEIT : 0)) == FAIL)
2070 curwin->w_arg_idx = old_arg_idx;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002071 /* like Vi: set the mark where the cursor is in the file. */
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002072 else if (eap->cmdidx != CMD_argdo)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002073 setmark('\'');
2074 }
2075}
2076
2077/*
2078 * ":next", and commands that behave like it.
2079 */
2080 void
2081ex_next(eap)
2082 exarg_T *eap;
2083{
2084 int i;
2085
2086 /*
2087 * check for changed buffer now, if this fails the argument list is not
2088 * redefined.
2089 */
2090 if ( P_HID(curbuf)
2091 || eap->cmdidx == CMD_snext
2092 || !check_changed(curbuf, TRUE, FALSE, eap->forceit, FALSE))
2093 {
2094 if (*eap->arg != NUL) /* redefine file list */
2095 {
2096 if (do_arglist(eap->arg, AL_SET, 0) == FAIL)
2097 return;
2098 i = 0;
2099 }
2100 else
2101 i = curwin->w_arg_idx + (int)eap->line2;
2102 do_argfile(eap, i);
2103 }
2104}
2105
2106#ifdef FEAT_LISTCMDS
2107/*
2108 * ":argedit"
2109 */
2110 void
2111ex_argedit(eap)
2112 exarg_T *eap;
2113{
2114 int fnum;
2115 int i;
2116 char_u *s;
2117
2118 /* Add the argument to the buffer list and get the buffer number. */
2119 fnum = buflist_add(eap->arg, BLN_LISTED);
2120
2121 /* Check if this argument is already in the argument list. */
2122 for (i = 0; i < ARGCOUNT; ++i)
2123 if (ARGLIST[i].ae_fnum == fnum)
2124 break;
2125 if (i == ARGCOUNT)
2126 {
2127 /* Can't find it, add it to the argument list. */
2128 s = vim_strsave(eap->arg);
2129 if (s == NULL)
2130 return;
2131 i = alist_add_list(1, &s,
2132 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2133 if (i < 0)
2134 return;
2135 curwin->w_arg_idx = i;
2136 }
2137
2138 alist_check_arg_idx();
2139
2140 /* Edit the argument. */
2141 do_argfile(eap, i);
2142}
2143
2144/*
2145 * ":argadd"
2146 */
2147 void
2148ex_argadd(eap)
2149 exarg_T *eap;
2150{
2151 do_arglist(eap->arg, AL_ADD,
2152 eap->addr_count > 0 ? (int)eap->line2 : curwin->w_arg_idx + 1);
2153#ifdef FEAT_TITLE
2154 maketitle();
2155#endif
2156}
2157
2158/*
2159 * ":argdelete"
2160 */
2161 void
2162ex_argdelete(eap)
2163 exarg_T *eap;
2164{
2165 int i;
2166 int n;
2167
2168 if (eap->addr_count > 0)
2169 {
2170 /* ":1,4argdel": Delete all arguments in the range. */
2171 if (eap->line2 > ARGCOUNT)
2172 eap->line2 = ARGCOUNT;
2173 n = eap->line2 - eap->line1 + 1;
2174 if (*eap->arg != NUL || n <= 0)
2175 EMSG(_(e_invarg));
2176 else
2177 {
2178 for (i = eap->line1; i <= eap->line2; ++i)
2179 vim_free(ARGLIST[i - 1].ae_fname);
2180 mch_memmove(ARGLIST + eap->line1 - 1, ARGLIST + eap->line2,
2181 (size_t)((ARGCOUNT - eap->line2) * sizeof(aentry_T)));
2182 ALIST(curwin)->al_ga.ga_len -= n;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002183 if (curwin->w_arg_idx >= eap->line2)
2184 curwin->w_arg_idx -= n;
2185 else if (curwin->w_arg_idx > eap->line1)
2186 curwin->w_arg_idx = eap->line1;
2187 }
2188 }
2189 else if (*eap->arg == NUL)
2190 EMSG(_(e_argreq));
2191 else
2192 do_arglist(eap->arg, AL_DEL, 0);
2193#ifdef FEAT_TITLE
2194 maketitle();
2195#endif
2196}
2197
2198/*
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002199 * ":argdo", ":windo", ":bufdo", ":tabdo"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 */
2201 void
2202ex_listdo(eap)
2203 exarg_T *eap;
2204{
2205 int i;
2206#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002207 win_T *wp;
2208 tabpage_T *tp;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002209#endif
2210 buf_T *buf;
2211 int next_fnum = 0;
2212#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
2213 char_u *save_ei = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002214#endif
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002215 char_u *p_shm_save;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002216
2217#ifndef FEAT_WINDOWS
2218 if (eap->cmdidx == CMD_windo)
2219 {
2220 ex_ni(eap);
2221 return;
2222 }
2223#endif
2224
2225#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002226 if (eap->cmdidx != CMD_windo && eap->cmdidx != CMD_tabdo)
Bram Moolenaardcaf10e2005-01-21 11:55:25 +00002227 /* Don't do syntax HL autocommands. Skipping the syntax file is a
2228 * great speed improvement. */
2229 save_ei = au_event_disable(",Syntax");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230#endif
2231
2232 if (eap->cmdidx == CMD_windo
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002233 || eap->cmdidx == CMD_tabdo
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 || P_HID(curbuf)
2235 || !check_changed(curbuf, TRUE, FALSE, eap->forceit, FALSE))
2236 {
2237 /* start at the first argument/window/buffer */
2238 i = 0;
2239#ifdef FEAT_WINDOWS
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002240 wp = firstwin;
2241 tp = first_tabpage;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242#endif
2243 /* set pcmark now */
2244 if (eap->cmdidx == CMD_bufdo)
2245 goto_buffer(eap, DOBUF_FIRST, FORWARD, 0);
2246 else
2247 setpcmark();
2248 listcmd_busy = TRUE; /* avoids setting pcmark below */
2249
2250 while (!got_int)
2251 {
2252 if (eap->cmdidx == CMD_argdo)
2253 {
2254 /* go to argument "i" */
2255 if (i == ARGCOUNT)
2256 break;
2257 /* Don't call do_argfile() when already there, it will try
2258 * reloading the file. */
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002259 if (curwin->w_arg_idx != i || !editing_arg_idx(curwin))
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002260 {
2261 /* Clear 'shm' to avoid that the file message overwrites
2262 * any output from the command. */
2263 p_shm_save = vim_strsave(p_shm);
2264 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 do_argfile(eap, i);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002266 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
2267 vim_free(p_shm_save);
2268 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 if (curwin->w_arg_idx != i)
2270 break;
2271 ++i;
2272 }
2273#ifdef FEAT_WINDOWS
2274 else if (eap->cmdidx == CMD_windo)
2275 {
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002276 /* go to window "wp" */
2277 if (!win_valid(wp))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002278 break;
Bram Moolenaar32466aa2006-02-24 23:53:04 +00002279 win_goto(wp);
2280 wp = curwin->w_next;
2281 }
2282 else if (eap->cmdidx == CMD_tabdo)
2283 {
2284 /* go to window "tp" */
2285 if (!valid_tabpage(tp))
2286 break;
2287 goto_tabpage_tp(tp);
2288 tp = tp->tp_next;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002289 }
2290#endif
2291 else if (eap->cmdidx == CMD_bufdo)
2292 {
2293 /* Remember the number of the next listed buffer, in case
2294 * ":bwipe" is used or autocommands do something strange. */
2295 next_fnum = -1;
2296 for (buf = curbuf->b_next; buf != NULL; buf = buf->b_next)
2297 if (buf->b_p_bl)
2298 {
2299 next_fnum = buf->b_fnum;
2300 break;
2301 }
2302 }
2303
2304 /* execute the command */
2305 do_cmdline(eap->arg, eap->getline, eap->cookie,
2306 DOCMD_VERBOSE + DOCMD_NOWAIT);
2307
2308 if (eap->cmdidx == CMD_bufdo)
2309 {
2310 /* Done? */
2311 if (next_fnum < 0)
2312 break;
2313 /* Check if the buffer still exists. */
2314 for (buf = firstbuf; buf != NULL; buf = buf->b_next)
2315 if (buf->b_fnum == next_fnum)
2316 break;
2317 if (buf == NULL)
2318 break;
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002319
2320 /* Go to the next buffer. Clear 'shm' to avoid that the file
2321 * message overwrites any output from the command. */
2322 p_shm_save = vim_strsave(p_shm);
2323 set_option_value((char_u *)"shm", 0L, (char_u *)"", 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 goto_buffer(eap, DOBUF_FIRST, FORWARD, next_fnum);
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002325 set_option_value((char_u *)"shm", 0L, p_shm_save, 0);
2326 vim_free(p_shm_save);
2327
Bram Moolenaar071d4272004-06-13 20:20:40 +00002328 /* If autocommands took us elsewhere, quit here */
2329 if (curbuf->b_fnum != next_fnum)
2330 break;
2331 }
2332
2333 if (eap->cmdidx == CMD_windo)
2334 {
2335 validate_cursor(); /* cursor may have moved */
2336#ifdef FEAT_SCROLLBIND
2337 /* required when 'scrollbind' has been set */
2338 if (curwin->w_p_scb)
2339 do_check_scrollbind(TRUE);
2340#endif
2341 }
2342 }
2343 listcmd_busy = FALSE;
2344 }
2345
2346#if defined(FEAT_AUTOCMD) && defined(FEAT_SYN_HL)
Bram Moolenaar6ac54292005-02-02 23:07:25 +00002347 if (save_ei != NULL)
2348 {
2349 au_event_restore(save_ei);
2350 apply_autocmds(EVENT_SYNTAX, curbuf->b_p_syn,
2351 curbuf->b_fname, TRUE, curbuf);
2352 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353#endif
2354}
2355
2356/*
2357 * Add files[count] to the arglist of the current window after arg "after".
2358 * The file names in files[count] must have been allocated and are taken over.
2359 * Files[] itself is not taken over.
2360 * Returns index of first added argument. Returns -1 when failed (out of mem).
2361 */
2362 static int
2363alist_add_list(count, files, after)
2364 int count;
2365 char_u **files;
2366 int after; /* where to add: 0 = before first one */
2367{
2368 int i;
2369
2370 if (ga_grow(&ALIST(curwin)->al_ga, count) == OK)
2371 {
2372 if (after < 0)
2373 after = 0;
2374 if (after > ARGCOUNT)
2375 after = ARGCOUNT;
2376 if (after < ARGCOUNT)
2377 mch_memmove(&(ARGLIST[after + count]), &(ARGLIST[after]),
2378 (ARGCOUNT - after) * sizeof(aentry_T));
2379 for (i = 0; i < count; ++i)
2380 {
2381 ARGLIST[after + i].ae_fname = files[i];
2382 ARGLIST[after + i].ae_fnum = buflist_add(files[i], BLN_LISTED);
2383 }
2384 ALIST(curwin)->al_ga.ga_len += count;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 if (curwin->w_arg_idx >= after)
2386 ++curwin->w_arg_idx;
2387 return after;
2388 }
2389
2390 for (i = 0; i < count; ++i)
2391 vim_free(files[i]);
2392 return -1;
2393}
2394
2395#endif /* FEAT_LISTCMDS */
2396
2397#ifdef FEAT_EVAL
2398/*
2399 * ":compiler[!] {name}"
2400 */
2401 void
2402ex_compiler(eap)
2403 exarg_T *eap;
2404{
2405 char_u *buf;
2406 char_u *old_cur_comp = NULL;
2407 char_u *p;
2408
2409 if (*eap->arg == NUL)
2410 {
2411 /* List all compiler scripts. */
2412 do_cmdline_cmd((char_u *)"echo globpath(&rtp, 'compiler/*.vim')");
2413 /* ) keep the indenter happy... */
2414 }
2415 else
2416 {
2417 buf = alloc((unsigned)(STRLEN(eap->arg) + 14));
2418 if (buf != NULL)
2419 {
2420 if (eap->forceit)
2421 {
2422 /* ":compiler! {name}" sets global options */
2423 do_cmdline_cmd((char_u *)
2424 "command -nargs=* CompilerSet set <args>");
2425 }
2426 else
2427 {
2428 /* ":compiler! {name}" sets local options.
2429 * To remain backwards compatible "current_compiler" is always
2430 * used. A user's compiler plugin may set it, the distributed
2431 * plugin will then skip the settings. Afterwards set
2432 * "b:current_compiler" and restore "current_compiler". */
2433 old_cur_comp = get_var_value((char_u *)"current_compiler");
2434 if (old_cur_comp != NULL)
2435 old_cur_comp = vim_strsave(old_cur_comp);
2436 do_cmdline_cmd((char_u *)
2437 "command -nargs=* CompilerSet setlocal <args>");
2438 }
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00002439 do_unlet((char_u *)"current_compiler", TRUE);
2440 do_unlet((char_u *)"b:current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441
2442 sprintf((char *)buf, "compiler/%s.vim", eap->arg);
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00002443 if (source_runtime(buf, TRUE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 EMSG2(_("E666: compiler not supported: %s"), eap->arg);
2445 vim_free(buf);
2446
2447 do_cmdline_cmd((char_u *)":delcommand CompilerSet");
2448
2449 /* Set "b:current_compiler" from "current_compiler". */
2450 p = get_var_value((char_u *)"current_compiler");
2451 if (p != NULL)
2452 set_internal_string_var((char_u *)"b:current_compiler", p);
2453
2454 /* Restore "current_compiler" for ":compiler {name}". */
2455 if (!eap->forceit)
2456 {
2457 if (old_cur_comp != NULL)
2458 {
2459 set_internal_string_var((char_u *)"current_compiler",
2460 old_cur_comp);
2461 vim_free(old_cur_comp);
2462 }
2463 else
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00002464 do_unlet((char_u *)"current_compiler", TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 }
2466 }
2467 }
2468}
2469#endif
2470
2471/*
2472 * ":runtime {name}"
2473 */
2474 void
2475ex_runtime(eap)
2476 exarg_T *eap;
2477{
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00002478 source_runtime(eap->arg, eap->forceit);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479}
2480
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002481static void source_callback __ARGS((char_u *fname, void *cookie));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002482
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002483/*ARGSUSED*/
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 static void
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002485source_callback(fname, cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002486 char_u *fname;
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002487 void *cookie;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488{
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002489 (void)do_source(fname, FALSE, DOSO_NONE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002490}
2491
2492/*
2493 * Source the file "name" from all directories in 'runtimepath'.
2494 * "name" can contain wildcards.
2495 * When "all" is TRUE, source all files, otherwise only the first one.
2496 * return FAIL when no file could be sourced, OK otherwise.
2497 */
2498 int
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00002499source_runtime(name, all)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500 char_u *name;
2501 int all;
2502{
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002503 return do_in_runtimepath(name, all, source_callback, NULL);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504}
2505
2506/*
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002507 * Find "name" in 'runtimepath'. When found, invoke the callback function for
2508 * it: callback(fname, "cookie")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 * When "all" is TRUE repeat for all matches, otherwise only the first one is
2510 * used.
2511 * Returns OK when at least one match found, FAIL otherwise.
2512 */
2513 int
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002514do_in_runtimepath(name, all, callback, cookie)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 char_u *name;
2516 int all;
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002517 void (*callback)__ARGS((char_u *fname, void *ck));
2518 void *cookie;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002519{
2520 char_u *rtp;
2521 char_u *np;
2522 char_u *buf;
2523 char_u *rtp_copy;
2524 char_u *tail;
2525 int num_files;
2526 char_u **files;
2527 int i;
2528 int did_one = FALSE;
2529#ifdef AMIGA
2530 struct Process *proc = (struct Process *)FindTask(0L);
2531 APTR save_winptr = proc->pr_WindowPtr;
2532
2533 /* Avoid a requester here for a volume that doesn't exist. */
2534 proc->pr_WindowPtr = (APTR)-1L;
2535#endif
2536
2537 /* Make a copy of 'runtimepath'. Invoking the callback may change the
2538 * value. */
2539 rtp_copy = vim_strsave(p_rtp);
2540 buf = alloc(MAXPATHL);
2541 if (buf != NULL && rtp_copy != NULL)
2542 {
2543 if (p_verbose > 1)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002544 {
2545 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002546 smsg((char_u *)_("Searching for \"%s\" in \"%s\""),
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 (char *)name, (char *)p_rtp);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002548 verbose_leave();
2549 }
Bram Moolenaar34cdc3e2005-05-18 22:24:46 +00002550
Bram Moolenaar071d4272004-06-13 20:20:40 +00002551 /* Loop over all entries in 'runtimepath'. */
2552 rtp = rtp_copy;
2553 while (*rtp != NUL && (all || !did_one))
2554 {
2555 /* Copy the path from 'runtimepath' to buf[]. */
2556 copy_option_part(&rtp, buf, MAXPATHL, ",");
2557 if (STRLEN(buf) + STRLEN(name) + 2 < MAXPATHL)
2558 {
2559 add_pathsep(buf);
2560 tail = buf + STRLEN(buf);
2561
2562 /* Loop over all patterns in "name" */
2563 np = name;
2564 while (*np != NUL && (all || !did_one))
2565 {
2566 /* Append the pattern from "name" to buf[]. */
2567 copy_option_part(&np, tail, (int)(MAXPATHL - (tail - buf)),
2568 "\t ");
2569
2570 if (p_verbose > 2)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002571 {
2572 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002573 smsg((char_u *)_("Searching for \"%s\""), buf);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002574 verbose_leave();
2575 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002576
2577 /* Expand wildcards, invoke the callback for each match. */
2578 if (gen_expand_wildcards(1, &buf, &num_files, &files,
2579 EW_FILE) == OK)
2580 {
2581 for (i = 0; i < num_files; ++i)
2582 {
Bram Moolenaar13fcaaf2005-04-15 21:13:42 +00002583 (*callback)(files[i], cookie);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584 did_one = TRUE;
2585 if (!all)
2586 break;
2587 }
2588 FreeWild(num_files, files);
2589 }
2590 }
2591 }
2592 }
2593 }
2594 vim_free(buf);
2595 vim_free(rtp_copy);
2596 if (p_verbose > 0 && !did_one)
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002597 {
2598 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00002599 smsg((char_u *)_("not found in 'runtimepath': \"%s\""), name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002600 verbose_leave();
2601 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002602
2603#ifdef AMIGA
2604 proc->pr_WindowPtr = save_winptr;
2605#endif
2606
2607 return did_one ? OK : FAIL;
2608}
2609
2610#if defined(FEAT_EVAL) && defined(FEAT_AUTOCMD)
2611/*
2612 * ":options"
2613 */
2614/*ARGSUSED*/
2615 void
2616ex_options(eap)
2617 exarg_T *eap;
2618{
2619 cmd_source((char_u *)SYS_OPTWIN_FILE, NULL);
2620}
2621#endif
2622
2623/*
2624 * ":source {fname}"
2625 */
2626 void
2627ex_source(eap)
2628 exarg_T *eap;
2629{
2630#ifdef FEAT_BROWSE
2631 if (cmdmod.browse)
2632 {
2633 char_u *fname = NULL;
2634
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00002635 fname = do_browse(0, (char_u *)_("Source Vim script"), eap->arg,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002636 NULL, NULL, BROWSE_FILTER_MACROS, NULL);
2637 if (fname != NULL)
2638 {
2639 cmd_source(fname, eap);
2640 vim_free(fname);
2641 }
2642 }
2643 else
2644#endif
2645 cmd_source(eap->arg, eap);
2646}
2647
2648 static void
2649cmd_source(fname, eap)
2650 char_u *fname;
2651 exarg_T *eap;
2652{
2653 if (*fname == NUL)
2654 EMSG(_(e_argreq));
2655
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 else if (eap != NULL && eap->forceit)
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002657 /* ":source!": read Normal mdoe commands
2658 * Need to execute the commands directly. This is required at least
2659 * for:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 * - ":g" command busy
2661 * - after ":argdo", ":windo" or ":bufdo"
2662 * - another command follows
2663 * - inside a loop
2664 */
2665 openscript(fname, global_busy || listcmd_busy || eap->nextcmd != NULL
2666#ifdef FEAT_EVAL
2667 || eap->cstack->cs_idx >= 0
2668#endif
2669 );
2670
2671 /* ":source" read ex commands */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002672 else if (do_source(fname, FALSE, DOSO_NONE) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002673 EMSG2(_(e_notopen), fname);
2674}
2675
2676/*
2677 * ":source" and associated commands.
2678 */
2679/*
2680 * Structure used to store info for each sourced file.
2681 * It is shared between do_source() and getsourceline().
2682 * This is required, because it needs to be handed to do_cmdline() and
2683 * sourcing can be done recursively.
2684 */
2685struct source_cookie
2686{
2687 FILE *fp; /* opened file for sourcing */
2688 char_u *nextline; /* if not NULL: line that was read ahead */
2689 int finished; /* ":finish" used */
2690#if defined (USE_CRNL) || defined (USE_CR)
2691 int fileformat; /* EOL_UNKNOWN, EOL_UNIX or EOL_DOS */
2692 int error; /* TRUE if LF found after CR-LF */
2693#endif
2694#ifdef FEAT_EVAL
2695 linenr_T breakpoint; /* next line with breakpoint or zero */
2696 char_u *fname; /* name of sourced file */
2697 int dbg_tick; /* debug_tick when breakpoint was set */
2698 int level; /* top nesting level of sourced file */
2699#endif
2700#ifdef FEAT_MBYTE
2701 vimconv_T conv; /* type of conversion */
2702#endif
2703};
2704
2705#ifdef FEAT_EVAL
2706/*
2707 * Return the address holding the next breakpoint line for a source cookie.
2708 */
2709 linenr_T *
2710source_breakpoint(cookie)
2711 void *cookie;
2712{
2713 return &((struct source_cookie *)cookie)->breakpoint;
2714}
2715
2716/*
2717 * Return the address holding the debug tick for a source cookie.
2718 */
2719 int *
2720source_dbg_tick(cookie)
2721 void *cookie;
2722{
2723 return &((struct source_cookie *)cookie)->dbg_tick;
2724}
2725
2726/*
2727 * Return the nesting level for a source cookie.
2728 */
2729 int
2730source_level(cookie)
2731 void *cookie;
2732{
2733 return ((struct source_cookie *)cookie)->level;
2734}
2735#endif
2736
2737static char_u *get_one_sourceline __ARGS((struct source_cookie *sp));
2738
Bram Moolenaar071d4272004-06-13 20:20:40 +00002739#if defined(WIN32) && defined(FEAT_CSCOPE)
2740static FILE *fopen_noinh_readbin __ARGS((char *filename));
2741
2742/*
2743 * Special function to open a file without handle inheritance.
2744 */
2745 static FILE *
2746fopen_noinh_readbin(filename)
2747 char *filename;
2748{
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00002749 int fd_tmp = mch_open(filename, O_RDONLY | O_BINARY | O_NOINHERIT, 0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750
2751 if (fd_tmp == -1)
2752 return NULL;
2753 return fdopen(fd_tmp, READBIN);
2754}
2755#endif
2756
2757
2758/*
2759 * do_source: Read the file "fname" and execute its lines as EX commands.
2760 *
2761 * This function may be called recursively!
2762 *
2763 * return FAIL if file could not be opened, OK otherwise
2764 */
2765 int
2766do_source(fname, check_other, is_vimrc)
2767 char_u *fname;
2768 int check_other; /* check for .vimrc and _vimrc */
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002769 int is_vimrc; /* DOSO_ value */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770{
2771 struct source_cookie cookie;
2772 char_u *save_sourcing_name;
2773 linenr_T save_sourcing_lnum;
2774 char_u *p;
2775 char_u *fname_exp;
2776 int retval = FAIL;
2777#ifdef FEAT_EVAL
2778 scid_T save_current_SID;
2779 static scid_T last_current_SID = 0;
2780 void *save_funccalp;
2781 int save_debug_break_level = debug_break_level;
Bram Moolenaar05159a02005-02-26 23:04:13 +00002782 scriptitem_T *si = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783# ifdef UNIX
2784 struct stat st;
2785 int stat_ok;
2786# endif
2787#endif
2788#ifdef STARTUPTIME
2789 struct timeval tv_rel;
2790 struct timeval tv_start;
2791#endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00002792#ifdef FEAT_PROFILE
2793 proftime_T wait_start;
2794#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795
2796#ifdef RISCOS
2797 p = mch_munge_fname(fname);
2798#else
2799 p = expand_env_save(fname);
2800#endif
2801 if (p == NULL)
2802 return retval;
2803 fname_exp = fix_fname(p);
2804 vim_free(p);
2805 if (fname_exp == NULL)
2806 return retval;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 if (mch_isdir(fname_exp))
2808 {
Bram Moolenaar555b2802005-05-19 21:08:39 +00002809 smsg((char_u *)_("Cannot source a directory: \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 goto theend;
2811 }
2812
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002813#ifdef FEAT_AUTOCMD
Bram Moolenaar8dd1aa52007-01-16 20:33:19 +00002814 /* Apply SourceCmd autocommands, they should get the file and source it. */
2815 if (has_autocmd(EVENT_SOURCECMD, fname_exp, NULL)
2816 && apply_autocmds(EVENT_SOURCECMD, fname_exp, fname_exp,
2817 FALSE, curbuf))
2818# ifdef FEAT_EVAL
2819 return aborting() ? FAIL : OK;
2820# else
2821 return OK;
2822# endif
2823
2824 /* Apply SourcePre autocommands, they may get the file. */
Bram Moolenaar1f35bf92006-03-07 22:38:47 +00002825 apply_autocmds(EVENT_SOURCEPRE, fname_exp, fname_exp, FALSE, curbuf);
2826#endif
2827
Bram Moolenaar071d4272004-06-13 20:20:40 +00002828#if defined(WIN32) && defined(FEAT_CSCOPE)
2829 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
2830#else
2831 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
2832#endif
2833 if (cookie.fp == NULL && check_other)
2834 {
2835 /*
2836 * Try again, replacing file name ".vimrc" by "_vimrc" or vice versa,
2837 * and ".exrc" by "_exrc" or vice versa.
2838 */
2839 p = gettail(fname_exp);
2840 if ((*p == '.' || *p == '_')
2841 && (STRICMP(p + 1, "vimrc") == 0
2842 || STRICMP(p + 1, "gvimrc") == 0
2843 || STRICMP(p + 1, "exrc") == 0))
2844 {
2845 if (*p == '_')
2846 *p = '.';
2847 else
2848 *p = '_';
2849#if defined(WIN32) && defined(FEAT_CSCOPE)
2850 cookie.fp = fopen_noinh_readbin((char *)fname_exp);
2851#else
2852 cookie.fp = mch_fopen((char *)fname_exp, READBIN);
2853#endif
2854 }
2855 }
2856
2857 if (cookie.fp == NULL)
2858 {
2859 if (p_verbose > 0)
2860 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002861 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002862 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00002863 smsg((char_u *)_("could not source \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864 else
2865 smsg((char_u *)_("line %ld: could not source \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00002866 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002867 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 }
2869 goto theend;
2870 }
2871
2872 /*
2873 * The file exists.
2874 * - In verbose mode, give a message.
2875 * - For a vimrc file, may want to set 'compatible', call vimrc_found().
2876 */
2877 if (p_verbose > 1)
2878 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002879 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002880 if (sourcing_name == NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00002881 smsg((char_u *)_("sourcing \"%s\""), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 else
2883 smsg((char_u *)_("line %ld: sourcing \"%s\""),
Bram Moolenaar555b2802005-05-19 21:08:39 +00002884 sourcing_lnum, fname);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00002885 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 }
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002887 if (is_vimrc == DOSO_VIMRC)
2888 vimrc_found(fname_exp, (char_u *)"MYVIMRC");
2889 else if (is_vimrc == DOSO_GVIMRC)
2890 vimrc_found(fname_exp, (char_u *)"MYGVIMRC");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891
2892#ifdef USE_CRNL
2893 /* If no automatic file format: Set default to CR-NL. */
2894 if (*p_ffs == NUL)
2895 cookie.fileformat = EOL_DOS;
2896 else
2897 cookie.fileformat = EOL_UNKNOWN;
2898 cookie.error = FALSE;
2899#endif
2900
2901#ifdef USE_CR
2902 /* If no automatic file format: Set default to CR. */
2903 if (*p_ffs == NUL)
2904 cookie.fileformat = EOL_MAC;
2905 else
2906 cookie.fileformat = EOL_UNKNOWN;
2907 cookie.error = FALSE;
2908#endif
2909
2910 cookie.nextline = NULL;
2911 cookie.finished = FALSE;
2912
2913#ifdef FEAT_EVAL
2914 /*
2915 * Check if this script has a breakpoint.
2916 */
2917 cookie.breakpoint = dbg_find_breakpoint(TRUE, fname_exp, (linenr_T)0);
2918 cookie.fname = fname_exp;
2919 cookie.dbg_tick = debug_tick;
2920
2921 cookie.level = ex_nesting_level;
2922#endif
2923#ifdef FEAT_MBYTE
2924 cookie.conv.vc_type = CONV_NONE; /* no conversion */
2925
2926 /* Try reading the first few bytes to check for a UTF-8 BOM. */
2927 {
2928 char_u buf[3];
2929
2930 if (fread((char *)buf, sizeof(char_u), (size_t)3, cookie.fp)
2931 == (size_t)3
2932 && buf[0] == 0xef && buf[1] == 0xbb && buf[2] == 0xbf)
2933 /* Found BOM, setup conversion and skip over it. */
2934 convert_setup(&cookie.conv, (char_u *)"utf-8", p_enc);
2935 else
2936 /* No BOM found, rewind. */
2937 fseek(cookie.fp, 0L, SEEK_SET);
2938 }
2939#endif
2940
2941 /*
2942 * Keep the sourcing name/lnum, for recursive calls.
2943 */
2944 save_sourcing_name = sourcing_name;
2945 sourcing_name = fname_exp;
2946 save_sourcing_lnum = sourcing_lnum;
2947 sourcing_lnum = 0;
2948
2949#ifdef STARTUPTIME
2950 time_push(&tv_rel, &tv_start);
2951#endif
2952
2953#ifdef FEAT_EVAL
Bram Moolenaar05159a02005-02-26 23:04:13 +00002954# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00002955 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00002956 prof_child_enter(&wait_start); /* entering a child now */
2957# endif
2958
2959 /* Don't use local function variables, if called from a function.
2960 * Also starts profiling timer for nested script. */
2961 save_funccalp = save_funccal();
2962
Bram Moolenaar071d4272004-06-13 20:20:40 +00002963 /*
2964 * Check if this script was sourced before to finds its SID.
2965 * If it's new, generate a new SID.
2966 */
2967 save_current_SID = current_SID;
2968# ifdef UNIX
2969 stat_ok = (mch_stat((char *)fname_exp, &st) >= 0);
2970# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00002971 for (current_SID = script_items.ga_len; current_SID > 0; --current_SID)
2972 {
2973 si = &SCRIPT_ITEM(current_SID);
2974 if (si->sn_name != NULL
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 && (
2976# ifdef UNIX
Bram Moolenaar7c626922005-02-07 22:01:03 +00002977 /* Compare dev/ino when possible, it catches symbolic
2978 * links. Also compare file names, the inode may change
2979 * when the file was edited. */
Bram Moolenaar05159a02005-02-26 23:04:13 +00002980 ((stat_ok && si->sn_dev != -1)
2981 && (si->sn_dev == st.st_dev
2982 && si->sn_ino == st.st_ino)) ||
Bram Moolenaar071d4272004-06-13 20:20:40 +00002983# endif
Bram Moolenaar05159a02005-02-26 23:04:13 +00002984 fnamecmp(si->sn_name, fname_exp) == 0))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 break;
Bram Moolenaar05159a02005-02-26 23:04:13 +00002986 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 if (current_SID == 0)
2988 {
2989 current_SID = ++last_current_SID;
Bram Moolenaar05159a02005-02-26 23:04:13 +00002990 if (ga_grow(&script_items, (int)(current_SID - script_items.ga_len))
2991 == FAIL)
2992 goto almosttheend;
2993 while (script_items.ga_len < current_SID)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002994 {
Bram Moolenaar05159a02005-02-26 23:04:13 +00002995 ++script_items.ga_len;
2996 SCRIPT_ITEM(script_items.ga_len).sn_name = NULL;
2997# ifdef FEAT_PROFILE
2998 SCRIPT_ITEM(script_items.ga_len).sn_prof_on = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00003001 si = &SCRIPT_ITEM(current_SID);
3002 si->sn_name = fname_exp;
3003 fname_exp = NULL;
3004# ifdef UNIX
3005 if (stat_ok)
3006 {
3007 si->sn_dev = st.st_dev;
3008 si->sn_ino = st.st_ino;
3009 }
3010 else
3011 si->sn_dev = -1;
3012# endif
3013
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 /* Allocate the local script variables to use for this script. */
3015 new_script_vars(current_SID);
3016 }
3017
Bram Moolenaar05159a02005-02-26 23:04:13 +00003018# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003019 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003020 {
3021 int forceit;
3022
3023 /* Check if we do profiling for this script. */
3024 if (!si->sn_prof_on && has_profiling(TRUE, si->sn_name, &forceit))
3025 {
3026 script_do_profile(si);
3027 si->sn_pr_force = forceit;
3028 }
3029 if (si->sn_prof_on)
3030 {
3031 ++si->sn_pr_count;
3032 profile_start(&si->sn_pr_start);
3033 profile_zero(&si->sn_pr_children);
3034 }
3035 }
3036# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037#endif
3038
3039 /*
3040 * Call do_cmdline, which will call getsourceline() to get the lines.
3041 */
3042 do_cmdline(NULL, getsourceline, (void *)&cookie,
3043 DOCMD_VERBOSE|DOCMD_NOWAIT|DOCMD_REPEAT);
3044
3045 retval = OK;
Bram Moolenaar05159a02005-02-26 23:04:13 +00003046
3047#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003048 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003049 {
3050 /* Get "si" again, "script_items" may have been reallocated. */
3051 si = &SCRIPT_ITEM(current_SID);
3052 if (si->sn_prof_on)
3053 {
3054 profile_end(&si->sn_pr_start);
3055 profile_sub_wait(&wait_start, &si->sn_pr_start);
3056 profile_add(&si->sn_pr_total, &si->sn_pr_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00003057 profile_self(&si->sn_pr_self, &si->sn_pr_start,
3058 &si->sn_pr_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00003059 }
3060 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061#endif
3062
3063 if (got_int)
3064 EMSG(_(e_interr));
3065 sourcing_name = save_sourcing_name;
3066 sourcing_lnum = save_sourcing_lnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003067 if (p_verbose > 1)
3068 {
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003069 verbose_enter();
Bram Moolenaar555b2802005-05-19 21:08:39 +00003070 smsg((char_u *)_("finished sourcing %s"), fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 if (sourcing_name != NULL)
Bram Moolenaar555b2802005-05-19 21:08:39 +00003072 smsg((char_u *)_("continuing in %s"), sourcing_name);
Bram Moolenaar54ee7752005-05-31 22:22:17 +00003073 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 }
3075#ifdef STARTUPTIME
Bram Moolenaar555b2802005-05-19 21:08:39 +00003076 vim_snprintf(IObuff, IOSIZE, "sourcing %s", fname);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003077 time_msg(IObuff, &tv_start);
3078 time_pop(&tv_rel);
3079#endif
3080
3081#ifdef FEAT_EVAL
3082 /*
3083 * After a "finish" in debug mode, need to break at first command of next
3084 * sourced file.
3085 */
3086 if (save_debug_break_level > ex_nesting_level
3087 && debug_break_level == ex_nesting_level)
3088 ++debug_break_level;
3089#endif
3090
Bram Moolenaar05159a02005-02-26 23:04:13 +00003091#ifdef FEAT_EVAL
3092almosttheend:
3093 current_SID = save_current_SID;
3094 restore_funccal(save_funccalp);
3095# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003096 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003097 prof_child_exit(&wait_start); /* leaving a child now */
3098# endif
3099#endif
3100 fclose(cookie.fp);
3101 vim_free(cookie.nextline);
3102#ifdef FEAT_MBYTE
3103 convert_setup(&cookie.conv, NULL, NULL);
3104#endif
3105
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106theend:
3107 vim_free(fname_exp);
3108 return retval;
3109}
3110
3111#if defined(FEAT_EVAL) || defined(PROTO)
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00003112
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113/*
3114 * ":scriptnames"
3115 */
3116/*ARGSUSED*/
3117 void
3118ex_scriptnames(eap)
3119 exarg_T *eap;
3120{
3121 int i;
3122
Bram Moolenaar05159a02005-02-26 23:04:13 +00003123 for (i = 1; i <= script_items.ga_len && !got_int; ++i)
3124 if (SCRIPT_ITEM(i).sn_name != NULL)
3125 smsg((char_u *)"%3d: %s", i, SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003126}
3127
3128# if defined(BACKSLASH_IN_FILENAME) || defined(PROTO)
3129/*
3130 * Fix slashes in the list of script names for 'shellslash'.
3131 */
3132 void
3133scriptnames_slash_adjust()
3134{
3135 int i;
3136
Bram Moolenaar05159a02005-02-26 23:04:13 +00003137 for (i = 1; i <= script_items.ga_len; ++i)
3138 if (SCRIPT_ITEM(i).sn_name != NULL)
3139 slash_adjust(SCRIPT_ITEM(i).sn_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003140}
3141# endif
3142
3143/*
3144 * Get a pointer to a script name. Used for ":verbose set".
3145 */
3146 char_u *
3147get_scriptname(id)
3148 scid_T id;
3149{
3150 if (id == SID_MODELINE)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003151 return (char_u *)_("modeline");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003152 if (id == SID_CMDARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003153 return (char_u *)_("--cmd argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003154 if (id == SID_CARG)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003155 return (char_u *)_("-c argument");
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 if (id == SID_ENV)
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003157 return (char_u *)_("environment variable");
3158 if (id == SID_ERROR)
3159 return (char_u *)_("error handler");
Bram Moolenaar05159a02005-02-26 23:04:13 +00003160 return SCRIPT_ITEM(id).sn_name;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161}
Bram Moolenaar05159a02005-02-26 23:04:13 +00003162
Bram Moolenaar1ec484f2005-06-24 23:07:47 +00003163# if defined(EXITFREE) || defined(PROTO)
3164 void
3165free_scriptnames()
3166{
3167 int i;
3168
3169 for (i = script_items.ga_len; i > 0; --i)
3170 vim_free(SCRIPT_ITEM(i).sn_name);
3171 ga_clear(&script_items);
3172}
3173# endif
3174
Bram Moolenaar071d4272004-06-13 20:20:40 +00003175#endif
3176
3177#if defined(USE_CR) || defined(PROTO)
3178
3179# if defined(__MSL__) && (__MSL__ >= 22)
3180/*
3181 * Newer version of the Metrowerks library handle DOS and UNIX files
3182 * without help.
3183 * Test with earlier versions, MSL 2.2 is the library supplied with
3184 * Codewarrior Pro 2.
3185 */
3186 char *
3187fgets_cr(s, n, stream)
3188 char *s;
3189 int n;
3190 FILE *stream;
3191{
3192 return fgets(s, n, stream);
3193}
3194# else
3195/*
3196 * Version of fgets() which also works for lines ending in a <CR> only
3197 * (Macintosh format).
3198 * For older versions of the Metrowerks library.
3199 * At least CodeWarrior 9 needed this code.
3200 */
3201 char *
3202fgets_cr(s, n, stream)
3203 char *s;
3204 int n;
3205 FILE *stream;
3206{
3207 int c = 0;
3208 int char_read = 0;
3209
3210 while (!feof(stream) && c != '\r' && c != '\n' && char_read < n - 1)
3211 {
3212 c = fgetc(stream);
3213 s[char_read++] = c;
3214 /* If the file is in DOS format, we need to skip a NL after a CR. I
3215 * thought it was the other way around, but this appears to work... */
3216 if (c == '\n')
3217 {
3218 c = fgetc(stream);
3219 if (c != '\r')
3220 ungetc(c, stream);
3221 }
3222 }
3223
3224 s[char_read] = 0;
3225 if (char_read == 0)
3226 return NULL;
3227
3228 if (feof(stream) && char_read == 1)
3229 return NULL;
3230
3231 return s;
3232}
3233# endif
3234#endif
3235
3236/*
3237 * Get one full line from a sourced file.
3238 * Called by do_cmdline() when it's called from do_source().
3239 *
3240 * Return a pointer to the line in allocated memory.
3241 * Return NULL for end-of-file or some error.
3242 */
3243/* ARGSUSED */
3244 char_u *
3245getsourceline(c, cookie, indent)
3246 int c; /* not used */
3247 void *cookie;
3248 int indent; /* not used */
3249{
3250 struct source_cookie *sp = (struct source_cookie *)cookie;
3251 char_u *line;
3252 char_u *p, *s;
3253
3254#ifdef FEAT_EVAL
3255 /* If breakpoints have been added/deleted need to check for it. */
3256 if (sp->dbg_tick < debug_tick)
3257 {
3258 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
3259 sp->dbg_tick = debug_tick;
3260 }
Bram Moolenaar05159a02005-02-26 23:04:13 +00003261# ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003262 if (do_profiling == PROF_YES)
Bram Moolenaar05159a02005-02-26 23:04:13 +00003263 script_line_end();
3264# endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003265#endif
3266 /*
3267 * Get current line. If there is a read-ahead line, use it, otherwise get
3268 * one now.
3269 */
3270 if (sp->finished)
3271 line = NULL;
3272 else if (sp->nextline == NULL)
3273 line = get_one_sourceline(sp);
3274 else
3275 {
3276 line = sp->nextline;
3277 sp->nextline = NULL;
3278 ++sourcing_lnum;
3279 }
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003280#ifdef FEAT_PROFILE
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00003281 if (line != NULL && do_profiling == PROF_YES)
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003282 script_line_start();
3283#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284
3285 /* Only concatenate lines starting with a \ when 'cpoptions' doesn't
3286 * contain the 'C' flag. */
3287 if (line != NULL && (vim_strchr(p_cpo, CPO_CONCAT) == NULL))
3288 {
3289 /* compensate for the one line read-ahead */
3290 --sourcing_lnum;
3291 for (;;)
3292 {
3293 sp->nextline = get_one_sourceline(sp);
3294 if (sp->nextline == NULL)
3295 break;
3296 p = skipwhite(sp->nextline);
3297 if (*p != '\\')
3298 break;
3299 s = alloc((int)(STRLEN(line) + STRLEN(p)));
3300 if (s == NULL) /* out of memory */
3301 break;
3302 STRCPY(s, line);
3303 STRCAT(s, p + 1);
3304 vim_free(line);
3305 line = s;
3306 vim_free(sp->nextline);
3307 }
3308 }
3309
3310#ifdef FEAT_MBYTE
3311 if (line != NULL && sp->conv.vc_type != CONV_NONE)
3312 {
3313 /* Convert the encoding of the script line. */
3314 s = string_convert(&sp->conv, line, NULL);
3315 if (s != NULL)
3316 {
3317 vim_free(line);
3318 line = s;
3319 }
3320 }
3321#endif
3322
3323#ifdef FEAT_EVAL
3324 /* Did we encounter a breakpoint? */
3325 if (sp->breakpoint != 0 && sp->breakpoint <= sourcing_lnum)
3326 {
3327 dbg_breakpoint(sp->fname, sourcing_lnum);
3328 /* Find next breakpoint. */
3329 sp->breakpoint = dbg_find_breakpoint(TRUE, sp->fname, sourcing_lnum);
3330 sp->dbg_tick = debug_tick;
3331 }
3332#endif
3333
3334 return line;
3335}
3336
3337 static char_u *
3338get_one_sourceline(sp)
3339 struct source_cookie *sp;
3340{
3341 garray_T ga;
3342 int len;
3343 int c;
3344 char_u *buf;
3345#ifdef USE_CRNL
3346 int has_cr; /* CR-LF found */
3347#endif
3348#ifdef USE_CR
3349 char_u *scan;
3350#endif
3351 int have_read = FALSE;
3352
3353 /* use a growarray to store the sourced line */
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003354 ga_init2(&ga, 1, 250);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355
3356 /*
3357 * Loop until there is a finished line (or end-of-file).
3358 */
3359 sourcing_lnum++;
3360 for (;;)
3361 {
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003362 /* make room to read at least 120 (more) characters */
3363 if (ga_grow(&ga, 120) == FAIL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003364 break;
3365 buf = (char_u *)ga.ga_data;
3366
3367#ifdef USE_CR
3368 if (sp->fileformat == EOL_MAC)
3369 {
Bram Moolenaar86b68352004-12-27 21:59:20 +00003370 if (fgets_cr((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
3371 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003372 break;
3373 }
3374 else
3375#endif
Bram Moolenaar86b68352004-12-27 21:59:20 +00003376 if (fgets((char *)buf + ga.ga_len, ga.ga_maxlen - ga.ga_len,
3377 sp->fp) == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 break;
Bram Moolenaar6ac54292005-02-02 23:07:25 +00003379 len = ga.ga_len + (int)STRLEN(buf + ga.ga_len);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380#ifdef USE_CRNL
3381 /* Ignore a trailing CTRL-Z, when in Dos mode. Only recognize the
3382 * CTRL-Z by its own, or after a NL. */
3383 if ( (len == 1 || (len >= 2 && buf[len - 2] == '\n'))
3384 && sp->fileformat == EOL_DOS
3385 && buf[len - 1] == Ctrl_Z)
3386 {
3387 buf[len - 1] = NUL;
3388 break;
3389 }
3390#endif
3391
3392#ifdef USE_CR
3393 /* If the read doesn't stop on a new line, and there's
3394 * some CR then we assume a Mac format */
3395 if (sp->fileformat == EOL_UNKNOWN)
3396 {
3397 if (buf[len - 1] != '\n' && vim_strchr(buf, '\r') != NULL)
3398 sp->fileformat = EOL_MAC;
3399 else
3400 sp->fileformat = EOL_UNIX;
3401 }
3402
3403 if (sp->fileformat == EOL_MAC)
3404 {
3405 scan = vim_strchr(buf, '\r');
3406
3407 if (scan != NULL)
3408 {
3409 *scan = '\n';
3410 if (*(scan + 1) != 0)
3411 {
3412 *(scan + 1) = 0;
3413 fseek(sp->fp, (long)(scan - buf - len + 1), SEEK_CUR);
3414 }
3415 }
3416 len = STRLEN(buf);
3417 }
3418#endif
3419
3420 have_read = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003421 ga.ga_len = len;
3422
3423 /* If the line was longer than the buffer, read more. */
Bram Moolenaar86b68352004-12-27 21:59:20 +00003424 if (ga.ga_maxlen - ga.ga_len == 1 && buf[len - 1] != '\n')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 continue;
3426
3427 if (len >= 1 && buf[len - 1] == '\n') /* remove trailing NL */
3428 {
3429#ifdef USE_CRNL
3430 has_cr = (len >= 2 && buf[len - 2] == '\r');
3431 if (sp->fileformat == EOL_UNKNOWN)
3432 {
3433 if (has_cr)
3434 sp->fileformat = EOL_DOS;
3435 else
3436 sp->fileformat = EOL_UNIX;
3437 }
3438
3439 if (sp->fileformat == EOL_DOS)
3440 {
3441 if (has_cr) /* replace trailing CR */
3442 {
3443 buf[len - 2] = '\n';
3444 --len;
3445 --ga.ga_len;
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446 }
3447 else /* lines like ":map xx yy^M" will have failed */
3448 {
3449 if (!sp->error)
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00003450 {
3451 msg_source(hl_attr(HLF_W));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 EMSG(_("W15: Warning: Wrong line separator, ^M may be missing"));
Bram Moolenaar2df6dcc2004-07-12 15:53:54 +00003453 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003454 sp->error = TRUE;
3455 sp->fileformat = EOL_UNIX;
3456 }
3457 }
3458#endif
3459 /* The '\n' is escaped if there is an odd number of ^V's just
3460 * before it, first set "c" just before the 'V's and then check
3461 * len&c parities (is faster than ((len-c)%2 == 0)) -- Acevedo */
3462 for (c = len - 2; c >= 0 && buf[c] == Ctrl_V; c--)
3463 ;
3464 if ((len & 1) != (c & 1)) /* escaped NL, read more */
3465 {
3466 sourcing_lnum++;
3467 continue;
3468 }
3469
3470 buf[len - 1] = NUL; /* remove the NL */
3471 }
3472
3473 /*
3474 * Check for ^C here now and then, so recursive :so can be broken.
3475 */
3476 line_breakcheck();
3477 break;
3478 }
3479
3480 if (have_read)
3481 return (char_u *)ga.ga_data;
3482
3483 vim_free(ga.ga_data);
3484 return NULL;
3485}
3486
Bram Moolenaar05159a02005-02-26 23:04:13 +00003487#if defined(FEAT_PROFILE) || defined(PROTO)
3488/*
3489 * Called when starting to read a script line.
3490 * "sourcing_lnum" must be correct!
3491 * When skipping lines it may not actually be executed, but we won't find out
3492 * until later and we need to store the time now.
3493 */
3494 void
3495script_line_start()
3496{
3497 scriptitem_T *si;
3498 sn_prl_T *pp;
3499
3500 if (current_SID <= 0 || current_SID > script_items.ga_len)
3501 return;
3502 si = &SCRIPT_ITEM(current_SID);
3503 if (si->sn_prof_on && sourcing_lnum >= 1)
3504 {
3505 /* Grow the array before starting the timer, so that the time spend
3506 * here isn't counted. */
3507 ga_grow(&si->sn_prl_ga, (int)(sourcing_lnum - si->sn_prl_ga.ga_len));
3508 si->sn_prl_idx = sourcing_lnum - 1;
3509 while (si->sn_prl_ga.ga_len <= si->sn_prl_idx
3510 && si->sn_prl_ga.ga_len < si->sn_prl_ga.ga_maxlen)
3511 {
3512 /* Zero counters for a line that was not used before. */
3513 pp = &PRL_ITEM(si, si->sn_prl_ga.ga_len);
3514 pp->snp_count = 0;
3515 profile_zero(&pp->sn_prl_total);
3516 profile_zero(&pp->sn_prl_self);
3517 ++si->sn_prl_ga.ga_len;
3518 }
3519 si->sn_prl_execed = FALSE;
3520 profile_start(&si->sn_prl_start);
3521 profile_zero(&si->sn_prl_children);
3522 profile_get_wait(&si->sn_prl_wait);
3523 }
3524}
3525
3526/*
3527 * Called when actually executing a function line.
3528 */
3529 void
3530script_line_exec()
3531{
3532 scriptitem_T *si;
3533
3534 if (current_SID <= 0 || current_SID > script_items.ga_len)
3535 return;
3536 si = &SCRIPT_ITEM(current_SID);
3537 if (si->sn_prof_on && si->sn_prl_idx >= 0)
3538 si->sn_prl_execed = TRUE;
3539}
3540
3541/*
3542 * Called when done with a function line.
3543 */
3544 void
3545script_line_end()
3546{
3547 scriptitem_T *si;
3548 sn_prl_T *pp;
3549
3550 if (current_SID <= 0 || current_SID > script_items.ga_len)
3551 return;
3552 si = &SCRIPT_ITEM(current_SID);
3553 if (si->sn_prof_on && si->sn_prl_idx >= 0
3554 && si->sn_prl_idx < si->sn_prl_ga.ga_len)
3555 {
3556 if (si->sn_prl_execed)
3557 {
3558 pp = &PRL_ITEM(si, si->sn_prl_idx);
3559 ++pp->snp_count;
3560 profile_end(&si->sn_prl_start);
3561 profile_sub_wait(&si->sn_prl_wait, &si->sn_prl_start);
Bram Moolenaar05159a02005-02-26 23:04:13 +00003562 profile_add(&pp->sn_prl_total, &si->sn_prl_start);
Bram Moolenaar1056d982006-03-09 22:37:52 +00003563 profile_self(&pp->sn_prl_self, &si->sn_prl_start,
3564 &si->sn_prl_children);
Bram Moolenaar05159a02005-02-26 23:04:13 +00003565 }
3566 si->sn_prl_idx = -1;
3567 }
3568}
3569#endif
3570
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571/*
3572 * ":scriptencoding": Set encoding conversion for a sourced script.
3573 * Without the multi-byte feature it's simply ignored.
3574 */
3575/*ARGSUSED*/
3576 void
3577ex_scriptencoding(eap)
3578 exarg_T *eap;
3579{
3580#ifdef FEAT_MBYTE
3581 struct source_cookie *sp;
3582 char_u *name;
3583
3584 if (!getline_equal(eap->getline, eap->cookie, getsourceline))
3585 {
3586 EMSG(_("E167: :scriptencoding used outside of a sourced file"));
3587 return;
3588 }
3589
3590 if (*eap->arg != NUL)
3591 {
3592 name = enc_canonize(eap->arg);
3593 if (name == NULL) /* out of memory */
3594 return;
3595 }
3596 else
3597 name = eap->arg;
3598
3599 /* Setup for conversion from the specified encoding to 'encoding'. */
3600 sp = (struct source_cookie *)getline_cookie(eap->getline, eap->cookie);
3601 convert_setup(&sp->conv, name, p_enc);
3602
3603 if (name != eap->arg)
3604 vim_free(name);
3605#endif
3606}
3607
3608#if defined(FEAT_EVAL) || defined(PROTO)
3609/*
3610 * ":finish": Mark a sourced file as finished.
3611 */
3612 void
3613ex_finish(eap)
3614 exarg_T *eap;
3615{
3616 if (getline_equal(eap->getline, eap->cookie, getsourceline))
3617 do_finish(eap, FALSE);
3618 else
3619 EMSG(_("E168: :finish used outside of a sourced file"));
3620}
3621
3622/*
3623 * Mark a sourced file as finished. Possibly makes the ":finish" pending.
3624 * Also called for a pending finish at the ":endtry" or after returning from
3625 * an extra do_cmdline(). "reanimate" is used in the latter case.
3626 */
3627 void
3628do_finish(eap, reanimate)
3629 exarg_T *eap;
3630 int reanimate;
3631{
3632 int idx;
3633
3634 if (reanimate)
3635 ((struct source_cookie *)getline_cookie(eap->getline,
3636 eap->cookie))->finished = FALSE;
3637
3638 /*
3639 * Cleanup (and inactivate) conditionals, but stop when a try conditional
3640 * not in its finally clause (which then is to be executed next) is found.
3641 * In this case, make the ":finish" pending for execution at the ":endtry".
3642 * Otherwise, finish normally.
3643 */
3644 idx = cleanup_conditionals(eap->cstack, 0, TRUE);
3645 if (idx >= 0)
3646 {
3647 eap->cstack->cs_pending[idx] = CSTP_FINISH;
3648 report_make_pending(CSTP_FINISH, NULL);
3649 }
3650 else
3651 ((struct source_cookie *)getline_cookie(eap->getline,
3652 eap->cookie))->finished = TRUE;
3653}
3654
3655
3656/*
3657 * Return TRUE when a sourced file had the ":finish" command: Don't give error
3658 * message for missing ":endif".
3659 * Return FALSE when not sourcing a file.
3660 */
3661 int
Bram Moolenaar89d40322006-08-29 15:30:07 +00003662source_finished(fgetline, cookie)
3663 char_u *(*fgetline) __ARGS((int, void *, int));
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 void *cookie;
3665{
Bram Moolenaar89d40322006-08-29 15:30:07 +00003666 return (getline_equal(fgetline, cookie, getsourceline)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 && ((struct source_cookie *)getline_cookie(
Bram Moolenaar89d40322006-08-29 15:30:07 +00003668 fgetline, cookie))->finished);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669}
3670#endif
3671
3672#if defined(FEAT_LISTCMDS) || defined(PROTO)
3673/*
3674 * ":checktime [buffer]"
3675 */
3676 void
3677ex_checktime(eap)
3678 exarg_T *eap;
3679{
3680 buf_T *buf;
3681 int save_no_check_timestamps = no_check_timestamps;
3682
3683 no_check_timestamps = 0;
3684 if (eap->addr_count == 0) /* default is all buffers */
3685 check_timestamps(FALSE);
3686 else
3687 {
3688 buf = buflist_findnr((int)eap->line2);
3689 if (buf != NULL) /* cannot happen? */
3690 (void)buf_check_timestamp(buf, FALSE);
3691 }
3692 no_check_timestamps = save_no_check_timestamps;
3693}
3694#endif
3695
Bram Moolenaar071d4272004-06-13 20:20:40 +00003696#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
3697 && (defined(FEAT_EVAL) || defined(FEAT_MULTI_LANG))
3698static char *get_locale_val __ARGS((int what));
3699
3700 static char *
3701get_locale_val(what)
3702 int what;
3703{
3704 char *loc;
3705
3706 /* Obtain the locale value from the libraries. For DJGPP this is
3707 * redefined and it doesn't use the arguments. */
3708 loc = setlocale(what, NULL);
3709
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003710# ifdef WIN32
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 if (loc != NULL)
3712 {
3713 char_u *p;
3714
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003715 /* setocale() returns something like "LC_COLLATE=<name>;LC_..." when
3716 * one of the values (e.g., LC_CTYPE) differs. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00003717 p = vim_strchr(loc, '=');
3718 if (p != NULL)
3719 {
3720 loc = ++p;
3721 while (*p != NUL) /* remove trailing newline */
3722 {
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003723 if (*p < ' ' || *p == ';')
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 {
3725 *p = NUL;
3726 break;
3727 }
3728 ++p;
3729 }
3730 }
3731 }
3732# endif
3733
3734 return loc;
3735}
3736#endif
3737
3738
3739#ifdef WIN32
3740/*
3741 * On MS-Windows locale names are strings like "German_Germany.1252", but
3742 * gettext expects "de". Try to translate one into another here for a few
3743 * supported languages.
3744 */
3745 static char_u *
3746gettext_lang(char_u *name)
3747{
3748 int i;
3749 static char *(mtable[]) = {
3750 "afrikaans", "af",
3751 "czech", "cs",
3752 "dutch", "nl",
3753 "german", "de",
3754 "english_united kingdom", "en_GB",
3755 "spanish", "es",
3756 "french", "fr",
3757 "italian", "it",
3758 "japanese", "ja",
3759 "korean", "ko",
3760 "norwegian", "no",
3761 "polish", "pl",
3762 "russian", "ru",
3763 "slovak", "sk",
3764 "swedish", "sv",
3765 "ukrainian", "uk",
3766 "chinese_china", "zh_CN",
3767 "chinese_taiwan", "zh_TW",
3768 NULL};
3769
3770 for (i = 0; mtable[i] != NULL; i += 2)
3771 if (STRNICMP(mtable[i], name, STRLEN(mtable[i])) == 0)
3772 return mtable[i + 1];
3773 return name;
3774}
3775#endif
3776
3777#if defined(FEAT_MULTI_LANG) || defined(PROTO)
3778/*
3779 * Obtain the current messages language. Used to set the default for
3780 * 'helplang'. May return NULL or an empty string.
3781 */
3782 char_u *
3783get_mess_lang()
3784{
3785 char_u *p;
3786
3787# if (defined(HAVE_LOCALE_H) || defined(X_LOCALE))
3788# if defined(LC_MESSAGES)
3789 p = (char_u *)get_locale_val(LC_MESSAGES);
3790# else
3791 /* This is necessary for Win32, where LC_MESSAGES is not defined and $LANG
Bram Moolenaar61660ea2006-04-07 21:40:07 +00003792 * may be set to the LCID number. LC_COLLATE is the best guess, LC_TIME
3793 * and LC_MONETARY may be set differently for a Japanese working in the
3794 * US. */
3795 p = (char_u *)get_locale_val(LC_COLLATE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796# endif
3797# else
3798 p = mch_getenv((char_u *)"LC_ALL");
3799 if (p == NULL || *p == NUL)
3800 {
3801 p = mch_getenv((char_u *)"LC_MESSAGES");
3802 if (p == NULL || *p == NUL)
3803 p = mch_getenv((char_u *)"LANG");
3804 }
3805# endif
3806# ifdef WIN32
3807 p = gettext_lang(p);
3808# endif
3809 return p;
3810}
3811#endif
3812
Bram Moolenaardef9e822004-12-31 20:58:58 +00003813/* Complicated #if; matches with where get_mess_env() is used below. */
3814#if (defined(FEAT_EVAL) && !((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
3815 && defined(LC_MESSAGES))) \
3816 || ((defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
3817 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE)) \
3818 && !defined(LC_MESSAGES))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819static char_u *get_mess_env __ARGS((void));
3820
3821/*
3822 * Get the language used for messages from the environment.
3823 */
3824 static char_u *
3825get_mess_env()
3826{
3827 char_u *p;
3828
3829 p = mch_getenv((char_u *)"LC_ALL");
3830 if (p == NULL || *p == NUL)
3831 {
3832 p = mch_getenv((char_u *)"LC_MESSAGES");
3833 if (p == NULL || *p == NUL)
3834 {
3835 p = mch_getenv((char_u *)"LANG");
3836 if (p != NULL && VIM_ISDIGIT(*p))
3837 p = NULL; /* ignore something like "1043" */
3838# if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
3839 if (p == NULL || *p == NUL)
3840 p = (char_u *)get_locale_val(LC_CTYPE);
3841# endif
3842 }
3843 }
3844 return p;
3845}
3846#endif
3847
3848#if defined(FEAT_EVAL) || defined(PROTO)
3849
3850/*
3851 * Set the "v:lang" variable according to the current locale setting.
3852 * Also do "v:lc_time"and "v:ctype".
3853 */
3854 void
3855set_lang_var()
3856{
3857 char_u *loc;
3858
3859# if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
3860 loc = (char_u *)get_locale_val(LC_CTYPE);
3861# else
3862 /* setlocale() not supported: use the default value */
3863 loc = (char_u *)"C";
3864# endif
3865 set_vim_var_string(VV_CTYPE, loc, -1);
3866
3867 /* When LC_MESSAGES isn't defined use the value from $LC_MESSAGES, fall
3868 * back to LC_CTYPE if it's empty. */
3869# if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) && defined(LC_MESSAGES)
3870 loc = (char_u *)get_locale_val(LC_MESSAGES);
3871# else
3872 loc = get_mess_env();
3873# endif
3874 set_vim_var_string(VV_LANG, loc, -1);
3875
3876# if defined(HAVE_LOCALE_H) || defined(X_LOCALE)
3877 loc = (char_u *)get_locale_val(LC_TIME);
3878# endif
3879 set_vim_var_string(VV_LC_TIME, loc, -1);
3880}
3881#endif
3882
3883#if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
3884 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
3885/*
3886 * ":language": Set the language (locale).
3887 */
3888 void
3889ex_language(eap)
3890 exarg_T *eap;
3891{
3892 char *loc;
3893 char_u *p;
3894 char_u *name;
3895 int what = LC_ALL;
3896 char *whatstr = "";
3897#ifdef LC_MESSAGES
3898# define VIM_LC_MESSAGES LC_MESSAGES
3899#else
3900# define VIM_LC_MESSAGES 6789
3901#endif
3902
3903 name = eap->arg;
3904
3905 /* Check for "messages {name}", "ctype {name}" or "time {name}" argument.
3906 * Allow abbreviation, but require at least 3 characters to avoid
3907 * confusion with a two letter language name "me" or "ct". */
3908 p = skiptowhite(eap->arg);
3909 if ((*p == NUL || vim_iswhite(*p)) && p - eap->arg >= 3)
3910 {
3911 if (STRNICMP(eap->arg, "messages", p - eap->arg) == 0)
3912 {
3913 what = VIM_LC_MESSAGES;
3914 name = skipwhite(p);
3915 whatstr = "messages ";
3916 }
3917 else if (STRNICMP(eap->arg, "ctype", p - eap->arg) == 0)
3918 {
3919 what = LC_CTYPE;
3920 name = skipwhite(p);
3921 whatstr = "ctype ";
3922 }
3923 else if (STRNICMP(eap->arg, "time", p - eap->arg) == 0)
3924 {
3925 what = LC_TIME;
3926 name = skipwhite(p);
3927 whatstr = "time ";
3928 }
3929 }
3930
3931 if (*name == NUL)
3932 {
3933#ifndef LC_MESSAGES
3934 if (what == VIM_LC_MESSAGES)
3935 p = get_mess_env();
3936 else
3937#endif
3938 p = (char_u *)setlocale(what, NULL);
3939 if (p == NULL || *p == NUL)
3940 p = (char_u *)"Unknown";
3941 smsg((char_u *)_("Current %slanguage: \"%s\""), whatstr, p);
3942 }
3943 else
3944 {
3945#ifndef LC_MESSAGES
3946 if (what == VIM_LC_MESSAGES)
3947 loc = "";
3948 else
3949#endif
3950 loc = setlocale(what, (char *)name);
3951 if (loc == NULL)
3952 EMSG2(_("E197: Cannot set language to \"%s\""), name);
3953 else
3954 {
3955#ifdef HAVE_NL_MSG_CAT_CNTR
3956 /* Need to do this for GNU gettext, otherwise cached translations
3957 * will be used again. */
3958 extern int _nl_msg_cat_cntr;
3959
3960 ++_nl_msg_cat_cntr;
3961#endif
3962 /* Reset $LC_ALL, otherwise it would overrule everyting. */
3963 vim_setenv((char_u *)"LC_ALL", (char_u *)"");
3964
3965 if (what != LC_TIME)
3966 {
3967 /* Tell gettext() what to translate to. It apparently doesn't
3968 * use the currently effective locale. Also do this when
3969 * FEAT_GETTEXT isn't defined, so that shell commands use this
3970 * value. */
3971 if (what == LC_ALL)
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003972 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 vim_setenv((char_u *)"LANG", name);
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003974# ifdef WIN32
3975 /* Apparently MS-Windows printf() may cause a crash when
3976 * we give it 8-bit text while it's expecting text in the
3977 * current locale. This call avoids that. */
3978 setlocale(LC_CTYPE, "C");
3979# endif
3980 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981 if (what != LC_CTYPE)
3982 {
3983 char_u *mname;
3984#ifdef WIN32
3985 mname = gettext_lang(name);
3986#else
3987 mname = name;
3988#endif
3989 vim_setenv((char_u *)"LC_MESSAGES", mname);
3990#ifdef FEAT_MULTI_LANG
3991 set_helplang_default(mname);
3992#endif
3993 }
3994
3995 /* Set $LC_CTYPE, because it overrules $LANG, and
3996 * gtk_set_locale() calls setlocale() again. gnome_init()
3997 * sets $LC_CTYPE to "en_US" (that's a bug!). */
3998 if (what != VIM_LC_MESSAGES)
3999 vim_setenv((char_u *)"LC_CTYPE", name);
4000# ifdef FEAT_GUI_GTK
4001 /* Let GTK know what locale we're using. Not sure this is
4002 * really needed... */
4003 if (gui.in_use)
4004 (void)gtk_set_locale();
4005# endif
4006 }
4007
4008# ifdef FEAT_EVAL
4009 /* Set v:lang, v:lc_time and v:ctype to the final result. */
4010 set_lang_var();
4011# endif
4012 }
4013 }
4014}
4015
4016# if defined(FEAT_CMDL_COMPL) || defined(PROTO)
4017/*
4018 * Function given to ExpandGeneric() to obtain the possible arguments of the
4019 * ":language" command.
4020 */
4021/*ARGSUSED*/
4022 char_u *
4023get_lang_arg(xp, idx)
4024 expand_T *xp;
4025 int idx;
4026{
4027 if (idx == 0)
4028 return (char_u *)"messages";
4029 if (idx == 1)
4030 return (char_u *)"ctype";
4031 if (idx == 2)
4032 return (char_u *)"time";
4033 return NULL;
4034}
4035# endif
4036
4037#endif