blob: 152dabde7d1d57851c232fd8a7a2d8b93abce7c6 [file] [log] [blame]
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001/* vi:set ts=8 sts=4 sw=4 noet:
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 * autocmd.c: Autocommand related functions
12 */
13
14#include "vim.h"
15
16/*
17 * The autocommands are stored in a list for each event.
18 * Autocommands for the same pattern, that are consecutive, are joined
19 * together, to avoid having to match the pattern too often.
20 * The result is an array of Autopat lists, which point to AutoCmd lists:
21 *
22 * last_autopat[0] -----------------------------+
23 * V
24 * first_autopat[0] --> Autopat.next --> Autopat.next --> NULL
25 * Autopat.cmds Autopat.cmds
26 * | |
27 * V V
28 * AutoCmd.next AutoCmd.next
29 * | |
30 * V V
31 * AutoCmd.next NULL
32 * |
33 * V
34 * NULL
35 *
36 * last_autopat[1] --------+
37 * V
38 * first_autopat[1] --> Autopat.next --> NULL
39 * Autopat.cmds
40 * |
41 * V
42 * AutoCmd.next
43 * |
44 * V
45 * NULL
46 * etc.
47 *
48 * The order of AutoCmds is important, this is the order in which they were
49 * defined and will have to be executed.
50 */
51typedef struct AutoCmd
52{
53 char_u *cmd; // The command to be executed (NULL
54 // when command has been removed).
Bram Moolenaareb93f3f2019-04-04 15:04:56 +020055 char once; // "One shot": removed after execution
Bram Moolenaar3e460fd2019-01-26 16:21:07 +010056 char nested; // If autocommands nest here.
57 char last; // last command in list
58#ifdef FEAT_EVAL
59 sctx_T script_ctx; // script context where defined
60#endif
61 struct AutoCmd *next; // next AutoCmd in list
62} AutoCmd;
63
64typedef struct AutoPat
65{
66 struct AutoPat *next; // Next AutoPat in AutoPat list; MUST
67 // be the first entry.
68 char_u *pat; // pattern as typed (NULL when pattern
69 // has been removed)
70 regprog_T *reg_prog; // compiled regprog for pattern
71 AutoCmd *cmds; // list of commands to do
72 int group; // group ID
73 int patlen; // strlen() of pat
74 int buflocal_nr; // !=0 for buffer-local AutoPat
75 char allow_dirs; // Pattern may match whole path
76 char last; // last pattern for apply_autocmds()
77} AutoPat;
78
79static struct event_name
80{
81 char *name; // event name
82 event_T event; // event number
83} event_names[] =
84{
85 {"BufAdd", EVENT_BUFADD},
86 {"BufCreate", EVENT_BUFADD},
87 {"BufDelete", EVENT_BUFDELETE},
88 {"BufEnter", EVENT_BUFENTER},
89 {"BufFilePost", EVENT_BUFFILEPOST},
90 {"BufFilePre", EVENT_BUFFILEPRE},
91 {"BufHidden", EVENT_BUFHIDDEN},
92 {"BufLeave", EVENT_BUFLEAVE},
93 {"BufNew", EVENT_BUFNEW},
94 {"BufNewFile", EVENT_BUFNEWFILE},
95 {"BufRead", EVENT_BUFREADPOST},
96 {"BufReadCmd", EVENT_BUFREADCMD},
97 {"BufReadPost", EVENT_BUFREADPOST},
98 {"BufReadPre", EVENT_BUFREADPRE},
99 {"BufUnload", EVENT_BUFUNLOAD},
100 {"BufWinEnter", EVENT_BUFWINENTER},
101 {"BufWinLeave", EVENT_BUFWINLEAVE},
102 {"BufWipeout", EVENT_BUFWIPEOUT},
103 {"BufWrite", EVENT_BUFWRITEPRE},
104 {"BufWritePost", EVENT_BUFWRITEPOST},
105 {"BufWritePre", EVENT_BUFWRITEPRE},
106 {"BufWriteCmd", EVENT_BUFWRITECMD},
107 {"CmdlineChanged", EVENT_CMDLINECHANGED},
108 {"CmdlineEnter", EVENT_CMDLINEENTER},
109 {"CmdlineLeave", EVENT_CMDLINELEAVE},
110 {"CmdwinEnter", EVENT_CMDWINENTER},
111 {"CmdwinLeave", EVENT_CMDWINLEAVE},
112 {"CmdUndefined", EVENT_CMDUNDEFINED},
113 {"ColorScheme", EVENT_COLORSCHEME},
114 {"ColorSchemePre", EVENT_COLORSCHEMEPRE},
Bram Moolenaard7f246c2019-04-08 18:15:41 +0200115 {"CompleteChanged", EVENT_COMPLETECHANGED},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100116 {"CompleteDone", EVENT_COMPLETEDONE},
117 {"CursorHold", EVENT_CURSORHOLD},
118 {"CursorHoldI", EVENT_CURSORHOLDI},
119 {"CursorMoved", EVENT_CURSORMOVED},
120 {"CursorMovedI", EVENT_CURSORMOVEDI},
121 {"DiffUpdated", EVENT_DIFFUPDATED},
122 {"DirChanged", EVENT_DIRCHANGED},
123 {"EncodingChanged", EVENT_ENCODINGCHANGED},
124 {"ExitPre", EVENT_EXITPRE},
125 {"FileEncoding", EVENT_ENCODINGCHANGED},
126 {"FileAppendPost", EVENT_FILEAPPENDPOST},
127 {"FileAppendPre", EVENT_FILEAPPENDPRE},
128 {"FileAppendCmd", EVENT_FILEAPPENDCMD},
129 {"FileChangedShell",EVENT_FILECHANGEDSHELL},
130 {"FileChangedShellPost",EVENT_FILECHANGEDSHELLPOST},
131 {"FileChangedRO", EVENT_FILECHANGEDRO},
132 {"FileReadPost", EVENT_FILEREADPOST},
133 {"FileReadPre", EVENT_FILEREADPRE},
134 {"FileReadCmd", EVENT_FILEREADCMD},
135 {"FileType", EVENT_FILETYPE},
136 {"FileWritePost", EVENT_FILEWRITEPOST},
137 {"FileWritePre", EVENT_FILEWRITEPRE},
138 {"FileWriteCmd", EVENT_FILEWRITECMD},
139 {"FilterReadPost", EVENT_FILTERREADPOST},
140 {"FilterReadPre", EVENT_FILTERREADPRE},
141 {"FilterWritePost", EVENT_FILTERWRITEPOST},
142 {"FilterWritePre", EVENT_FILTERWRITEPRE},
143 {"FocusGained", EVENT_FOCUSGAINED},
144 {"FocusLost", EVENT_FOCUSLOST},
145 {"FuncUndefined", EVENT_FUNCUNDEFINED},
146 {"GUIEnter", EVENT_GUIENTER},
147 {"GUIFailed", EVENT_GUIFAILED},
148 {"InsertChange", EVENT_INSERTCHANGE},
149 {"InsertEnter", EVENT_INSERTENTER},
150 {"InsertLeave", EVENT_INSERTLEAVE},
151 {"InsertCharPre", EVENT_INSERTCHARPRE},
152 {"MenuPopup", EVENT_MENUPOPUP},
153 {"OptionSet", EVENT_OPTIONSET},
154 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
155 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
156 {"QuitPre", EVENT_QUITPRE},
157 {"RemoteReply", EVENT_REMOTEREPLY},
158 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
159 {"ShellCmdPost", EVENT_SHELLCMDPOST},
160 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
161 {"SourceCmd", EVENT_SOURCECMD},
162 {"SourcePre", EVENT_SOURCEPRE},
163 {"SourcePost", EVENT_SOURCEPOST},
164 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
165 {"StdinReadPost", EVENT_STDINREADPOST},
166 {"StdinReadPre", EVENT_STDINREADPRE},
167 {"SwapExists", EVENT_SWAPEXISTS},
168 {"Syntax", EVENT_SYNTAX},
169 {"TabNew", EVENT_TABNEW},
170 {"TabClosed", EVENT_TABCLOSED},
171 {"TabEnter", EVENT_TABENTER},
172 {"TabLeave", EVENT_TABLEAVE},
173 {"TermChanged", EVENT_TERMCHANGED},
174 {"TerminalOpen", EVENT_TERMINALOPEN},
175 {"TermResponse", EVENT_TERMRESPONSE},
176 {"TextChanged", EVENT_TEXTCHANGED},
177 {"TextChangedI", EVENT_TEXTCHANGEDI},
178 {"TextChangedP", EVENT_TEXTCHANGEDP},
179 {"User", EVENT_USER},
180 {"VimEnter", EVENT_VIMENTER},
181 {"VimLeave", EVENT_VIMLEAVE},
182 {"VimLeavePre", EVENT_VIMLEAVEPRE},
183 {"WinNew", EVENT_WINNEW},
184 {"WinEnter", EVENT_WINENTER},
185 {"WinLeave", EVENT_WINLEAVE},
186 {"VimResized", EVENT_VIMRESIZED},
187 {"TextYankPost", EVENT_TEXTYANKPOST},
188 {NULL, (event_T)0}
189};
190
191static AutoPat *first_autopat[NUM_EVENTS] =
192{
193 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
194 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
195 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
196 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
197 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
198 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
199};
200
201static AutoPat *last_autopat[NUM_EVENTS] =
202{
203 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
204 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
205 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
206 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
207 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
208 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
209};
210
211#define AUGROUP_DEFAULT -1 // default autocmd group
212#define AUGROUP_ERROR -2 // erroneous autocmd group
213#define AUGROUP_ALL -3 // all autocmd groups
214
215/*
216 * struct used to keep status while executing autocommands for an event.
217 */
218typedef struct AutoPatCmd
219{
220 AutoPat *curpat; // next AutoPat to examine
221 AutoCmd *nextcmd; // next AutoCmd to execute
222 int group; // group being used
223 char_u *fname; // fname to match with
224 char_u *sfname; // sfname to match with
225 char_u *tail; // tail of fname
226 event_T event; // current event
227 int arg_bufnr; // Initially equal to <abuf>, set to zero when
228 // buf is deleted.
229 struct AutoPatCmd *next; // chain of active apc-s for auto-invalidation
230} AutoPatCmd;
231
232static AutoPatCmd *active_apc_list = NULL; /* stack of active autocommands */
233
234/*
235 * augroups stores a list of autocmd group names.
236 */
237static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
238#define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
239/* use get_deleted_augroup() to get this */
240static char_u *deleted_augroup = NULL;
241
242/*
243 * Set by the apply_autocmds_group function if the given event is equal to
244 * EVENT_FILETYPE. Used by the readfile function in order to determine if
245 * EVENT_BUFREADPOST triggered the EVENT_FILETYPE.
246 *
247 * Relying on this value requires one to reset it prior calling
248 * apply_autocmds_group.
249 */
250int au_did_filetype INIT(= FALSE);
251
252/*
253 * The ID of the current group. Group 0 is the default one.
254 */
255static int current_augroup = AUGROUP_DEFAULT;
256
257static int au_need_clean = FALSE; /* need to delete marked patterns */
258
259static char_u *event_nr2name(event_T event);
260static int au_get_grouparg(char_u **argp);
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200261static int do_autocmd_event(event_T event, char_u *pat, int once, int nested, char_u *cmd, int forceit, int group);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100262static int apply_autocmds_group(event_T event, char_u *fname, char_u *fname_io, int force, int group, buf_T *buf, exarg_T *eap);
263static void auto_next_pat(AutoPatCmd *apc, int stop_at_last);
264static int au_find_group(char_u *name);
265
266static event_T last_event;
267static int last_group;
268static int autocmd_blocked = 0; /* block all autocmds */
269
270 static char_u *
271get_deleted_augroup(void)
272{
273 if (deleted_augroup == NULL)
274 deleted_augroup = (char_u *)_("--Deleted--");
275 return deleted_augroup;
276}
277
278/*
279 * Show the autocommands for one AutoPat.
280 */
281 static void
282show_autocmd(AutoPat *ap, event_T event)
283{
284 AutoCmd *ac;
285
286 // Check for "got_int" (here and at various places below), which is set
287 // when "q" has been hit for the "--more--" prompt
288 if (got_int)
289 return;
290 if (ap->pat == NULL) // pattern has been removed
291 return;
292
293 msg_putchar('\n');
294 if (got_int)
295 return;
296 if (event != last_event || ap->group != last_group)
297 {
298 if (ap->group != AUGROUP_DEFAULT)
299 {
300 if (AUGROUP_NAME(ap->group) == NULL)
301 msg_puts_attr((char *)get_deleted_augroup(), HL_ATTR(HLF_E));
302 else
303 msg_puts_attr((char *)AUGROUP_NAME(ap->group), HL_ATTR(HLF_T));
304 msg_puts(" ");
305 }
306 msg_puts_attr((char *)event_nr2name(event), HL_ATTR(HLF_T));
307 last_event = event;
308 last_group = ap->group;
309 msg_putchar('\n');
310 if (got_int)
311 return;
312 }
313 msg_col = 4;
314 msg_outtrans(ap->pat);
315
316 for (ac = ap->cmds; ac != NULL; ac = ac->next)
317 {
318 if (ac->cmd != NULL) // skip removed commands
319 {
320 if (msg_col >= 14)
321 msg_putchar('\n');
322 msg_col = 14;
323 if (got_int)
324 return;
325 msg_outtrans(ac->cmd);
326#ifdef FEAT_EVAL
327 if (p_verbose > 0)
328 last_set_msg(ac->script_ctx);
329#endif
330 if (got_int)
331 return;
332 if (ac->next != NULL)
333 {
334 msg_putchar('\n');
335 if (got_int)
336 return;
337 }
338 }
339 }
340}
341
342/*
343 * Mark an autocommand pattern for deletion.
344 */
345 static void
346au_remove_pat(AutoPat *ap)
347{
348 VIM_CLEAR(ap->pat);
349 ap->buflocal_nr = -1;
350 au_need_clean = TRUE;
351}
352
353/*
354 * Mark all commands for a pattern for deletion.
355 */
356 static void
357au_remove_cmds(AutoPat *ap)
358{
359 AutoCmd *ac;
360
361 for (ac = ap->cmds; ac != NULL; ac = ac->next)
362 VIM_CLEAR(ac->cmd);
363 au_need_clean = TRUE;
364}
365
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200366// Delete one command from an autocmd pattern.
367static void au_del_cmd(AutoCmd *ac)
368{
369 VIM_CLEAR(ac->cmd);
370 au_need_clean = TRUE;
371}
372
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100373/*
374 * Cleanup autocommands and patterns that have been deleted.
375 * This is only done when not executing autocommands.
376 */
377 static void
378au_cleanup(void)
379{
380 AutoPat *ap, **prev_ap;
381 AutoCmd *ac, **prev_ac;
382 event_T event;
383
384 if (autocmd_busy || !au_need_clean)
385 return;
386
387 // loop over all events
388 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
389 event = (event_T)((int)event + 1))
390 {
391 // loop over all autocommand patterns
392 prev_ap = &(first_autopat[(int)event]);
393 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
394 {
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200395 int has_cmd = FALSE;
396
Bram Moolenaar8f4aeb52019-04-04 15:40:56 +0200397 // loop over all commands for this pattern
398 prev_ac = &(ap->cmds);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100399 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
400 {
401 // remove the command if the pattern is to be deleted or when
402 // the command has been marked for deletion
403 if (ap->pat == NULL || ac->cmd == NULL)
404 {
405 *prev_ac = ac->next;
406 vim_free(ac->cmd);
407 vim_free(ac);
408 }
Bram Moolenaar8f4aeb52019-04-04 15:40:56 +0200409 else
410 {
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200411 has_cmd = TRUE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100412 prev_ac = &(ac->next);
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200413 }
414 }
415
Bram Moolenaar8f4aeb52019-04-04 15:40:56 +0200416 if (ap->pat != NULL && !has_cmd)
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200417 // Pattern was not marked for deletion, but all of its
418 // commands were. So mark the pattern for deletion.
419 au_remove_pat(ap);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100420
421 // remove the pattern if it has been marked for deletion
422 if (ap->pat == NULL)
423 {
424 if (ap->next == NULL)
425 {
426 if (prev_ap == &(first_autopat[(int)event]))
427 last_autopat[(int)event] = NULL;
428 else
429 // this depends on the "next" field being the first in
430 // the struct
431 last_autopat[(int)event] = (AutoPat *)prev_ap;
432 }
433 *prev_ap = ap->next;
434 vim_regfree(ap->reg_prog);
435 vim_free(ap);
436 }
437 else
438 prev_ap = &(ap->next);
439 }
440 }
441
442 au_need_clean = FALSE;
443}
444
445/*
446 * Called when buffer is freed, to remove/invalidate related buffer-local
447 * autocmds.
448 */
449 void
450aubuflocal_remove(buf_T *buf)
451{
452 AutoPat *ap;
453 event_T event;
454 AutoPatCmd *apc;
455
456 // invalidate currently executing autocommands
457 for (apc = active_apc_list; apc; apc = apc->next)
458 if (buf->b_fnum == apc->arg_bufnr)
459 apc->arg_bufnr = 0;
460
461 // invalidate buflocals looping through events
462 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
463 event = (event_T)((int)event + 1))
464 // loop over all autocommand patterns
465 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
466 if (ap->buflocal_nr == buf->b_fnum)
467 {
468 au_remove_pat(ap);
469 if (p_verbose >= 6)
470 {
471 verbose_enter();
472 smsg(_("auto-removing autocommand: %s <buffer=%d>"),
473 event_nr2name(event), buf->b_fnum);
474 verbose_leave();
475 }
476 }
477 au_cleanup();
478}
479
480/*
481 * Add an autocmd group name.
482 * Return its ID. Returns AUGROUP_ERROR (< 0) for error.
483 */
484 static int
485au_new_group(char_u *name)
486{
487 int i;
488
489 i = au_find_group(name);
490 if (i == AUGROUP_ERROR) // the group doesn't exist yet, add it
491 {
492 // First try using a free entry.
493 for (i = 0; i < augroups.ga_len; ++i)
494 if (AUGROUP_NAME(i) == NULL)
495 break;
496 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
497 return AUGROUP_ERROR;
498
499 AUGROUP_NAME(i) = vim_strsave(name);
500 if (AUGROUP_NAME(i) == NULL)
501 return AUGROUP_ERROR;
502 if (i == augroups.ga_len)
503 ++augroups.ga_len;
504 }
505
506 return i;
507}
508
509 static void
510au_del_group(char_u *name)
511{
512 int i;
513
514 i = au_find_group(name);
515 if (i == AUGROUP_ERROR) // the group doesn't exist
516 semsg(_("E367: No such group: \"%s\""), name);
517 else if (i == current_augroup)
518 emsg(_("E936: Cannot delete the current group"));
519 else
520 {
521 event_T event;
522 AutoPat *ap;
523 int in_use = FALSE;
524
525 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
526 event = (event_T)((int)event + 1))
527 {
528 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
529 if (ap->group == i && ap->pat != NULL)
530 {
531 give_warning((char_u *)_("W19: Deleting augroup that is still in use"), TRUE);
532 in_use = TRUE;
533 event = NUM_EVENTS;
534 break;
535 }
536 }
537 vim_free(AUGROUP_NAME(i));
538 if (in_use)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100539 AUGROUP_NAME(i) = get_deleted_augroup();
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100540 else
541 AUGROUP_NAME(i) = NULL;
542 }
543}
544
545/*
546 * Find the ID of an autocmd group name.
547 * Return its ID. Returns AUGROUP_ERROR (< 0) for error.
548 */
549 static int
550au_find_group(char_u *name)
551{
552 int i;
553
554 for (i = 0; i < augroups.ga_len; ++i)
555 if (AUGROUP_NAME(i) != NULL && AUGROUP_NAME(i) != get_deleted_augroup()
556 && STRCMP(AUGROUP_NAME(i), name) == 0)
557 return i;
558 return AUGROUP_ERROR;
559}
560
561/*
562 * Return TRUE if augroup "name" exists.
563 */
564 int
565au_has_group(char_u *name)
566{
567 return au_find_group(name) != AUGROUP_ERROR;
568}
569
570/*
571 * ":augroup {name}".
572 */
573 void
574do_augroup(char_u *arg, int del_group)
575{
576 int i;
577
578 if (del_group)
579 {
580 if (*arg == NUL)
581 emsg(_(e_argreq));
582 else
583 au_del_group(arg);
584 }
585 else if (STRICMP(arg, "end") == 0) // ":aug end": back to group 0
586 current_augroup = AUGROUP_DEFAULT;
587 else if (*arg) // ":aug xxx": switch to group xxx
588 {
589 i = au_new_group(arg);
590 if (i != AUGROUP_ERROR)
591 current_augroup = i;
592 }
593 else // ":aug": list the group names
594 {
595 msg_start();
596 for (i = 0; i < augroups.ga_len; ++i)
597 {
598 if (AUGROUP_NAME(i) != NULL)
599 {
600 msg_puts((char *)AUGROUP_NAME(i));
601 msg_puts(" ");
602 }
603 }
604 msg_clr_eos();
605 msg_end();
606 }
607}
608
609#if defined(EXITFREE) || defined(PROTO)
610 void
611free_all_autocmds(void)
612{
613 int i;
614 char_u *s;
615
616 for (current_augroup = -1; current_augroup < augroups.ga_len;
617 ++current_augroup)
618 do_autocmd((char_u *)"", TRUE);
619
620 for (i = 0; i < augroups.ga_len; ++i)
621 {
622 s = ((char_u **)(augroups.ga_data))[i];
623 if (s != get_deleted_augroup())
624 vim_free(s);
625 }
626 ga_clear(&augroups);
627}
628#endif
629
630/*
631 * Return the event number for event name "start".
632 * Return NUM_EVENTS if the event name was not found.
633 * Return a pointer to the next event name in "end".
634 */
635 static event_T
636event_name2nr(char_u *start, char_u **end)
637{
638 char_u *p;
639 int i;
640 int len;
641
642 // the event name ends with end of line, '|', a blank or a comma
643 for (p = start; *p && !VIM_ISWHITE(*p) && *p != ',' && *p != '|'; ++p)
644 ;
645 for (i = 0; event_names[i].name != NULL; ++i)
646 {
647 len = (int)STRLEN(event_names[i].name);
648 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
649 break;
650 }
651 if (*p == ',')
652 ++p;
653 *end = p;
654 if (event_names[i].name == NULL)
655 return NUM_EVENTS;
656 return event_names[i].event;
657}
658
659/*
660 * Return the name for event "event".
661 */
662 static char_u *
663event_nr2name(event_T event)
664{
665 int i;
666
667 for (i = 0; event_names[i].name != NULL; ++i)
668 if (event_names[i].event == event)
669 return (char_u *)event_names[i].name;
670 return (char_u *)"Unknown";
671}
672
673/*
674 * Scan over the events. "*" stands for all events.
675 */
676 static char_u *
677find_end_event(
678 char_u *arg,
679 int have_group) // TRUE when group name was found
680{
681 char_u *pat;
682 char_u *p;
683
684 if (*arg == '*')
685 {
686 if (arg[1] && !VIM_ISWHITE(arg[1]))
687 {
688 semsg(_("E215: Illegal character after *: %s"), arg);
689 return NULL;
690 }
691 pat = arg + 1;
692 }
693 else
694 {
695 for (pat = arg; *pat && *pat != '|' && !VIM_ISWHITE(*pat); pat = p)
696 {
697 if ((int)event_name2nr(pat, &p) >= (int)NUM_EVENTS)
698 {
699 if (have_group)
700 semsg(_("E216: No such event: %s"), pat);
701 else
702 semsg(_("E216: No such group or event: %s"), pat);
703 return NULL;
704 }
705 }
706 }
707 return pat;
708}
709
710/*
711 * Return TRUE if "event" is included in 'eventignore'.
712 */
713 static int
714event_ignored(event_T event)
715{
716 char_u *p = p_ei;
717
718 while (*p != NUL)
719 {
720 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
721 return TRUE;
722 if (event_name2nr(p, &p) == event)
723 return TRUE;
724 }
725
726 return FALSE;
727}
728
729/*
730 * Return OK when the contents of p_ei is valid, FAIL otherwise.
731 */
732 int
733check_ei(void)
734{
735 char_u *p = p_ei;
736
737 while (*p)
738 {
739 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
740 {
741 p += 3;
742 if (*p == ',')
743 ++p;
744 }
745 else if (event_name2nr(p, &p) == NUM_EVENTS)
746 return FAIL;
747 }
748
749 return OK;
750}
751
752# if defined(FEAT_SYN_HL) || defined(PROTO)
753
754/*
755 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
756 * buffer loaded into the window. "what" must start with a comma.
757 * Returns the old value of 'eventignore' in allocated memory.
758 */
759 char_u *
760au_event_disable(char *what)
761{
762 char_u *new_ei;
763 char_u *save_ei;
764
765 save_ei = vim_strsave(p_ei);
766 if (save_ei != NULL)
767 {
768 new_ei = vim_strnsave(p_ei, (int)(STRLEN(p_ei) + STRLEN(what)));
769 if (new_ei != NULL)
770 {
771 if (*what == ',' && *p_ei == NUL)
772 STRCPY(new_ei, what + 1);
773 else
774 STRCAT(new_ei, what);
775 set_string_option_direct((char_u *)"ei", -1, new_ei,
776 OPT_FREE, SID_NONE);
777 vim_free(new_ei);
778 }
779 }
780 return save_ei;
781}
782
783 void
784au_event_restore(char_u *old_ei)
785{
786 if (old_ei != NULL)
787 {
788 set_string_option_direct((char_u *)"ei", -1, old_ei,
789 OPT_FREE, SID_NONE);
790 vim_free(old_ei);
791 }
792}
793# endif /* FEAT_SYN_HL */
794
795/*
796 * do_autocmd() -- implements the :autocmd command. Can be used in the
797 * following ways:
798 *
799 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
800 * will be automatically executed for <event>
801 * when editing a file matching <pat>, in
802 * the current group.
803 * :autocmd <event> <pat> Show the autocommands associated with
804 * <event> and <pat>.
805 * :autocmd <event> Show the autocommands associated with
806 * <event>.
807 * :autocmd Show all autocommands.
808 * :autocmd! <event> <pat> <cmd> Remove all autocommands associated with
809 * <event> and <pat>, and add the command
810 * <cmd>, for the current group.
811 * :autocmd! <event> <pat> Remove all autocommands associated with
812 * <event> and <pat> for the current group.
813 * :autocmd! <event> Remove all autocommands associated with
814 * <event> for the current group.
815 * :autocmd! Remove ALL autocommands for the current
816 * group.
817 *
818 * Multiple events and patterns may be given separated by commas. Here are
819 * some examples:
820 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
821 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
822 *
823 * :autocmd * *.c show all autocommands for *.c files.
824 *
825 * Mostly a {group} argument can optionally appear before <event>.
826 */
827 void
828do_autocmd(char_u *arg_in, int forceit)
829{
830 char_u *arg = arg_in;
831 char_u *pat;
832 char_u *envpat = NULL;
833 char_u *cmd;
834 event_T event;
835 int need_free = FALSE;
836 int nested = FALSE;
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200837 int once = FALSE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100838 int group;
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200839 int i;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100840
841 if (*arg == '|')
842 {
843 arg = (char_u *)"";
844 group = AUGROUP_ALL; // no argument, use all groups
845 }
846 else
847 {
848 /*
849 * Check for a legal group name. If not, use AUGROUP_ALL.
850 */
851 group = au_get_grouparg(&arg);
852 if (arg == NULL) // out of memory
853 return;
854 }
855
856 /*
857 * Scan over the events.
858 * If we find an illegal name, return here, don't do anything.
859 */
860 pat = find_end_event(arg, group != AUGROUP_ALL);
861 if (pat == NULL)
862 return;
863
864 pat = skipwhite(pat);
865 if (*pat == '|')
866 {
867 pat = (char_u *)"";
868 cmd = (char_u *)"";
869 }
870 else
871 {
872 /*
873 * Scan over the pattern. Put a NUL at the end.
874 */
875 cmd = pat;
876 while (*cmd && (!VIM_ISWHITE(*cmd) || cmd[-1] == '\\'))
877 cmd++;
878 if (*cmd)
879 *cmd++ = NUL;
880
881 // Expand environment variables in the pattern. Set 'shellslash', we
882 // want forward slashes here.
883 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
884 {
885#ifdef BACKSLASH_IN_FILENAME
886 int p_ssl_save = p_ssl;
887
888 p_ssl = TRUE;
889#endif
890 envpat = expand_env_save(pat);
891#ifdef BACKSLASH_IN_FILENAME
892 p_ssl = p_ssl_save;
893#endif
894 if (envpat != NULL)
895 pat = envpat;
896 }
897
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100898 cmd = skipwhite(cmd);
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200899 for (i = 0; i < 2; i++)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100900 {
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200901 if (*cmd != NUL)
902 {
903 // Check for "++once" flag.
904 if (STRNCMP(cmd, "++once", 6) == 0 && VIM_ISWHITE(cmd[6]))
905 {
906 if (once)
907 semsg(_(e_duparg2), "++once");
908 once = TRUE;
909 cmd = skipwhite(cmd + 6);
910 }
911
912 // Check for "++nested" flag.
913 if ((STRNCMP(cmd, "++nested", 8) == 0 && VIM_ISWHITE(cmd[8])))
914 {
915 if (nested)
916 semsg(_(e_duparg2), "++nested");
917 nested = TRUE;
918 cmd = skipwhite(cmd + 8);
919 }
920
921 // Check for the old "nested" flag.
922 if (STRNCMP(cmd, "nested", 6) == 0 && VIM_ISWHITE(cmd[6]))
923 {
924 if (nested)
925 semsg(_(e_duparg2), "nested");
926 nested = TRUE;
927 cmd = skipwhite(cmd + 6);
928 }
929 }
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100930 }
931
932 /*
933 * Find the start of the commands.
934 * Expand <sfile> in it.
935 */
936 if (*cmd != NUL)
937 {
938 cmd = expand_sfile(cmd);
939 if (cmd == NULL) // some error
940 return;
941 need_free = TRUE;
942 }
943 }
944
945 /*
946 * Print header when showing autocommands.
947 */
948 if (!forceit && *cmd == NUL)
949 // Highlight title
950 msg_puts_title(_("\n--- Autocommands ---"));
951
952 /*
953 * Loop over the events.
954 */
955 last_event = (event_T)-1; // for listing the event name
956 last_group = AUGROUP_ERROR; // for listing the group name
957 if (*arg == '*' || *arg == NUL || *arg == '|')
958 {
959 for (event = (event_T)0; (int)event < (int)NUM_EVENTS;
960 event = (event_T)((int)event + 1))
961 if (do_autocmd_event(event, pat,
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200962 once, nested, cmd, forceit, group) == FAIL)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100963 break;
964 }
965 else
966 {
967 while (*arg && *arg != '|' && !VIM_ISWHITE(*arg))
968 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200969 once, nested, cmd, forceit, group) == FAIL)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100970 break;
971 }
972
973 if (need_free)
974 vim_free(cmd);
975 vim_free(envpat);
976}
977
978/*
979 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
980 * The "argp" argument is advanced to the following argument.
981 *
982 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
983 */
984 static int
985au_get_grouparg(char_u **argp)
986{
987 char_u *group_name;
988 char_u *p;
989 char_u *arg = *argp;
990 int group = AUGROUP_ALL;
991
992 for (p = arg; *p && !VIM_ISWHITE(*p) && *p != '|'; ++p)
993 ;
994 if (p > arg)
995 {
996 group_name = vim_strnsave(arg, (int)(p - arg));
997 if (group_name == NULL) // out of memory
998 return AUGROUP_ERROR;
999 group = au_find_group(group_name);
1000 if (group == AUGROUP_ERROR)
1001 group = AUGROUP_ALL; // no match, use all groups
1002 else
1003 *argp = skipwhite(p); // match, skip over group name
1004 vim_free(group_name);
1005 }
1006 return group;
1007}
1008
1009/*
1010 * do_autocmd() for one event.
1011 * If *pat == NUL do for all patterns.
1012 * If *cmd == NUL show entries.
1013 * If forceit == TRUE delete entries.
1014 * If group is not AUGROUP_ALL, only use this group.
1015 */
1016 static int
1017do_autocmd_event(
1018 event_T event,
1019 char_u *pat,
Bram Moolenaareb93f3f2019-04-04 15:04:56 +02001020 int once,
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001021 int nested,
1022 char_u *cmd,
1023 int forceit,
1024 int group)
1025{
1026 AutoPat *ap;
1027 AutoPat **prev_ap;
1028 AutoCmd *ac;
1029 AutoCmd **prev_ac;
1030 int brace_level;
1031 char_u *endpat;
1032 int findgroup;
1033 int allgroups;
1034 int patlen;
1035 int is_buflocal;
1036 int buflocal_nr;
1037 char_u buflocal_pat[25]; /* for "<buffer=X>" */
1038
1039 if (group == AUGROUP_ALL)
1040 findgroup = current_augroup;
1041 else
1042 findgroup = group;
1043 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
1044
1045 /*
1046 * Show or delete all patterns for an event.
1047 */
1048 if (*pat == NUL)
1049 {
1050 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
1051 {
1052 if (forceit) // delete the AutoPat, if it's in the current group
1053 {
1054 if (ap->group == findgroup)
1055 au_remove_pat(ap);
1056 }
1057 else if (group == AUGROUP_ALL || ap->group == group)
1058 show_autocmd(ap, event);
1059 }
1060 }
1061
1062 /*
1063 * Loop through all the specified patterns.
1064 */
1065 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
1066 {
1067 /*
1068 * Find end of the pattern.
1069 * Watch out for a comma in braces, like "*.\{obj,o\}".
1070 */
1071 brace_level = 0;
1072 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
1073 || (endpat > pat && endpat[-1] == '\\')); ++endpat)
1074 {
1075 if (*endpat == '{')
1076 brace_level++;
1077 else if (*endpat == '}')
1078 brace_level--;
1079 }
1080 if (pat == endpat) // ignore single comma
1081 continue;
1082 patlen = (int)(endpat - pat);
1083
1084 /*
1085 * detect special <buflocal[=X]> buffer-local patterns
1086 */
1087 is_buflocal = FALSE;
1088 buflocal_nr = 0;
1089
1090 if (patlen >= 8 && STRNCMP(pat, "<buffer", 7) == 0
1091 && pat[patlen - 1] == '>')
1092 {
1093 // "<buffer...>": Error will be printed only for addition.
1094 // printing and removing will proceed silently.
1095 is_buflocal = TRUE;
1096 if (patlen == 8)
1097 // "<buffer>"
1098 buflocal_nr = curbuf->b_fnum;
1099 else if (patlen > 9 && pat[7] == '=')
1100 {
1101 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13) == 0)
1102 // "<buffer=abuf>"
1103 buflocal_nr = autocmd_bufnr;
1104 else if (skipdigits(pat + 8) == pat + patlen - 1)
1105 // "<buffer=123>"
1106 buflocal_nr = atoi((char *)pat + 8);
1107 }
1108 }
1109
1110 if (is_buflocal)
1111 {
1112 // normalize pat into standard "<buffer>#N" form
1113 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
1114 pat = buflocal_pat; // can modify pat and patlen
1115 patlen = (int)STRLEN(buflocal_pat); // but not endpat
1116 }
1117
1118 /*
1119 * Find AutoPat entries with this pattern. When adding a command it
1120 * always goes at or after the last one, so start at the end.
1121 */
1122 if (!forceit && *cmd != NUL && last_autopat[(int)event] != NULL)
1123 prev_ap = &last_autopat[(int)event];
1124 else
1125 prev_ap = &first_autopat[(int)event];
1126 while ((ap = *prev_ap) != NULL)
1127 {
1128 if (ap->pat != NULL)
1129 {
1130 /* Accept a pattern when:
1131 * - a group was specified and it's that group, or a group was
1132 * not specified and it's the current group, or a group was
1133 * not specified and we are listing
1134 * - the length of the pattern matches
1135 * - the pattern matches.
1136 * For <buffer[=X]>, this condition works because we normalize
1137 * all buffer-local patterns.
1138 */
1139 if ((allgroups || ap->group == findgroup)
1140 && ap->patlen == patlen
1141 && STRNCMP(pat, ap->pat, patlen) == 0)
1142 {
1143 /*
1144 * Remove existing autocommands.
1145 * If adding any new autocmd's for this AutoPat, don't
1146 * delete the pattern from the autopat list, append to
1147 * this list.
1148 */
1149 if (forceit)
1150 {
1151 if (*cmd != NUL && ap->next == NULL)
1152 {
1153 au_remove_cmds(ap);
1154 break;
1155 }
1156 au_remove_pat(ap);
1157 }
1158
1159 /*
1160 * Show autocmd's for this autopat, or buflocals <buffer=X>
1161 */
1162 else if (*cmd == NUL)
1163 show_autocmd(ap, event);
1164
1165 /*
1166 * Add autocmd to this autopat, if it's the last one.
1167 */
1168 else if (ap->next == NULL)
1169 break;
1170 }
1171 }
1172 prev_ap = &ap->next;
1173 }
1174
1175 /*
1176 * Add a new command.
1177 */
1178 if (*cmd != NUL)
1179 {
1180 /*
1181 * If the pattern we want to add a command to does appear at the
1182 * end of the list (or not is not in the list at all), add the
1183 * pattern at the end of the list.
1184 */
1185 if (ap == NULL)
1186 {
1187 /* refuse to add buffer-local ap if buffer number is invalid */
1188 if (is_buflocal && (buflocal_nr == 0
1189 || buflist_findnr(buflocal_nr) == NULL))
1190 {
1191 semsg(_("E680: <buffer=%d>: invalid buffer number "),
1192 buflocal_nr);
1193 return FAIL;
1194 }
1195
Bram Moolenaar964b3742019-05-24 18:54:09 +02001196 ap = (AutoPat *)alloc(sizeof(AutoPat));
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001197 if (ap == NULL)
1198 return FAIL;
1199 ap->pat = vim_strnsave(pat, patlen);
1200 ap->patlen = patlen;
1201 if (ap->pat == NULL)
1202 {
1203 vim_free(ap);
1204 return FAIL;
1205 }
1206
1207 if (is_buflocal)
1208 {
1209 ap->buflocal_nr = buflocal_nr;
1210 ap->reg_prog = NULL;
1211 }
1212 else
1213 {
1214 char_u *reg_pat;
1215
1216 ap->buflocal_nr = 0;
1217 reg_pat = file_pat_to_reg_pat(pat, endpat,
1218 &ap->allow_dirs, TRUE);
1219 if (reg_pat != NULL)
1220 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
1221 vim_free(reg_pat);
1222 if (reg_pat == NULL || ap->reg_prog == NULL)
1223 {
1224 vim_free(ap->pat);
1225 vim_free(ap);
1226 return FAIL;
1227 }
1228 }
1229 ap->cmds = NULL;
1230 *prev_ap = ap;
1231 last_autopat[(int)event] = ap;
1232 ap->next = NULL;
1233 if (group == AUGROUP_ALL)
1234 ap->group = current_augroup;
1235 else
1236 ap->group = group;
1237 }
1238
1239 /*
1240 * Add the autocmd at the end of the AutoCmd list.
1241 */
1242 prev_ac = &(ap->cmds);
1243 while ((ac = *prev_ac) != NULL)
1244 prev_ac = &ac->next;
Bram Moolenaar964b3742019-05-24 18:54:09 +02001245 ac = (AutoCmd *)alloc(sizeof(AutoCmd));
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001246 if (ac == NULL)
1247 return FAIL;
1248 ac->cmd = vim_strsave(cmd);
1249#ifdef FEAT_EVAL
1250 ac->script_ctx = current_sctx;
1251 ac->script_ctx.sc_lnum += sourcing_lnum;
1252#endif
1253 if (ac->cmd == NULL)
1254 {
1255 vim_free(ac);
1256 return FAIL;
1257 }
1258 ac->next = NULL;
1259 *prev_ac = ac;
Bram Moolenaareb93f3f2019-04-04 15:04:56 +02001260 ac->once = once;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001261 ac->nested = nested;
1262 }
1263 }
1264
1265 au_cleanup(); // may really delete removed patterns/commands now
1266 return OK;
1267}
1268
1269/*
1270 * Implementation of ":doautocmd [group] event [fname]".
1271 * Return OK for success, FAIL for failure;
1272 */
1273 int
1274do_doautocmd(
1275 char_u *arg,
1276 int do_msg, // give message for no matching autocmds?
1277 int *did_something)
1278{
1279 char_u *fname;
1280 int nothing_done = TRUE;
1281 int group;
1282
1283 if (did_something != NULL)
1284 *did_something = FALSE;
1285
1286 /*
1287 * Check for a legal group name. If not, use AUGROUP_ALL.
1288 */
1289 group = au_get_grouparg(&arg);
1290 if (arg == NULL) // out of memory
1291 return FAIL;
1292
1293 if (*arg == '*')
1294 {
1295 emsg(_("E217: Can't execute autocommands for ALL events"));
1296 return FAIL;
1297 }
1298
1299 /*
1300 * Scan over the events.
1301 * If we find an illegal name, return here, don't do anything.
1302 */
1303 fname = find_end_event(arg, group != AUGROUP_ALL);
1304 if (fname == NULL)
1305 return FAIL;
1306
1307 fname = skipwhite(fname);
1308
1309 /*
1310 * Loop over the events.
1311 */
1312 while (*arg && !ends_excmd(*arg) && !VIM_ISWHITE(*arg))
1313 if (apply_autocmds_group(event_name2nr(arg, &arg),
1314 fname, NULL, TRUE, group, curbuf, NULL))
1315 nothing_done = FALSE;
1316
1317 if (nothing_done && do_msg)
1318 msg(_("No matching autocommands"));
1319 if (did_something != NULL)
1320 *did_something = !nothing_done;
1321
1322#ifdef FEAT_EVAL
1323 return aborting() ? FAIL : OK;
1324#else
1325 return OK;
1326#endif
1327}
1328
1329/*
1330 * ":doautoall": execute autocommands for each loaded buffer.
1331 */
1332 void
1333ex_doautoall(exarg_T *eap)
1334{
1335 int retval;
1336 aco_save_T aco;
1337 buf_T *buf;
1338 bufref_T bufref;
1339 char_u *arg = eap->arg;
1340 int call_do_modelines = check_nomodeline(&arg);
1341 int did_aucmd;
1342
1343 /*
1344 * This is a bit tricky: For some commands curwin->w_buffer needs to be
1345 * equal to curbuf, but for some buffers there may not be a window.
1346 * So we change the buffer for the current window for a moment. This
1347 * gives problems when the autocommands make changes to the list of
1348 * buffers or windows...
1349 */
1350 FOR_ALL_BUFFERS(buf)
1351 {
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001352 if (buf->b_ml.ml_mfp != NULL && !bt_popup(buf))
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001353 {
1354 // find a window for this buffer and save some values
1355 aucmd_prepbuf(&aco, buf);
1356 set_bufref(&bufref, buf);
1357
1358 // execute the autocommands for this buffer
1359 retval = do_doautocmd(arg, FALSE, &did_aucmd);
1360
1361 if (call_do_modelines && did_aucmd)
1362 {
1363 // Execute the modeline settings, but don't set window-local
1364 // options if we are using the current window for another
1365 // buffer.
1366 do_modelines(curwin == aucmd_win ? OPT_NOWIN : 0);
1367 }
1368
1369 // restore the current window
1370 aucmd_restbuf(&aco);
1371
1372 // stop if there is some error or buffer was deleted
1373 if (retval == FAIL || !bufref_valid(&bufref))
1374 break;
1375 }
1376 }
1377
1378 check_cursor(); // just in case lines got deleted
1379}
1380
1381/*
1382 * Check *argp for <nomodeline>. When it is present return FALSE, otherwise
1383 * return TRUE and advance *argp to after it.
1384 * Thus return TRUE when do_modelines() should be called.
1385 */
1386 int
1387check_nomodeline(char_u **argp)
1388{
1389 if (STRNCMP(*argp, "<nomodeline>", 12) == 0)
1390 {
1391 *argp = skipwhite(*argp + 12);
1392 return FALSE;
1393 }
1394 return TRUE;
1395}
1396
1397/*
1398 * Prepare for executing autocommands for (hidden) buffer "buf".
1399 * Search for a visible window containing the current buffer. If there isn't
1400 * one then use "aucmd_win".
1401 * Set "curbuf" and "curwin" to match "buf".
1402 */
1403 void
1404aucmd_prepbuf(
1405 aco_save_T *aco, // structure to save values in
1406 buf_T *buf) // new curbuf
1407{
1408 win_T *win;
1409 int save_ea;
1410#ifdef FEAT_AUTOCHDIR
1411 int save_acd;
1412#endif
1413
1414 // Find a window that is for the new buffer
1415 if (buf == curbuf) // be quick when buf is curbuf
1416 win = curwin;
1417 else
1418 FOR_ALL_WINDOWS(win)
1419 if (win->w_buffer == buf)
1420 break;
1421
1422 // Allocate "aucmd_win" when needed. If this fails (out of memory) fall
1423 // back to using the current window.
1424 if (win == NULL && aucmd_win == NULL)
1425 {
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001426 aucmd_win = win_alloc_popup_win();
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001427 if (aucmd_win == NULL)
1428 win = curwin;
1429 }
1430 if (win == NULL && aucmd_win_used)
1431 // Strange recursive autocommand, fall back to using the current
1432 // window. Expect a few side effects...
1433 win = curwin;
1434
1435 aco->save_curwin = curwin;
1436 aco->save_curbuf = curbuf;
1437 aco->save_prevwin = prevwin;
1438 if (win != NULL)
1439 {
1440 // There is a window for "buf" in the current tab page, make it the
1441 // curwin. This is preferred, it has the least side effects (esp. if
1442 // "buf" is curbuf).
1443 aco->use_aucmd_win = FALSE;
1444 curwin = win;
1445 }
1446 else
1447 {
1448 // There is no window for "buf", use "aucmd_win". To minimize the side
1449 // effects, insert it in the current tab page.
1450 // Anything related to a window (e.g., setting folds) may have
1451 // unexpected results.
1452 aco->use_aucmd_win = TRUE;
1453 aucmd_win_used = TRUE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001454
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001455 win_init_popup_win(aucmd_win, buf);
1456
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001457 aco->globaldir = globaldir;
1458 globaldir = NULL;
1459
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001460 // Split the current window, put the aucmd_win in the upper half.
1461 // We don't want the BufEnter or WinEnter autocommands.
1462 block_autocmds();
1463 make_snapshot(SNAP_AUCMD_IDX);
1464 save_ea = p_ea;
1465 p_ea = FALSE;
1466
1467#ifdef FEAT_AUTOCHDIR
1468 // Prevent chdir() call in win_enter_ext(), through do_autochdir().
1469 save_acd = p_acd;
1470 p_acd = FALSE;
1471#endif
1472
1473 (void)win_split_ins(0, WSP_TOP, aucmd_win, 0);
1474 (void)win_comp_pos(); // recompute window positions
1475 p_ea = save_ea;
1476#ifdef FEAT_AUTOCHDIR
1477 p_acd = save_acd;
1478#endif
1479 unblock_autocmds();
1480 curwin = aucmd_win;
1481 }
1482 curbuf = buf;
1483 aco->new_curwin = curwin;
1484 set_bufref(&aco->new_curbuf, curbuf);
1485}
1486
1487/*
1488 * Cleanup after executing autocommands for a (hidden) buffer.
1489 * Restore the window as it was (if possible).
1490 */
1491 void
1492aucmd_restbuf(
1493 aco_save_T *aco) // structure holding saved values
1494{
1495 int dummy;
1496
1497 if (aco->use_aucmd_win)
1498 {
1499 --curbuf->b_nwindows;
1500 // Find "aucmd_win", it can't be closed, but it may be in another tab
1501 // page. Do not trigger autocommands here.
1502 block_autocmds();
1503 if (curwin != aucmd_win)
1504 {
1505 tabpage_T *tp;
1506 win_T *wp;
1507
1508 FOR_ALL_TAB_WINDOWS(tp, wp)
1509 {
1510 if (wp == aucmd_win)
1511 {
1512 if (tp != curtab)
1513 goto_tabpage_tp(tp, TRUE, TRUE);
1514 win_goto(aucmd_win);
1515 goto win_found;
1516 }
1517 }
1518 }
1519win_found:
1520
1521 // Remove the window and frame from the tree of frames.
1522 (void)winframe_remove(curwin, &dummy, NULL);
1523 win_remove(curwin, NULL);
1524 aucmd_win_used = FALSE;
1525 last_status(FALSE); // may need to remove last status line
1526
1527 if (!valid_tabpage_win(curtab))
1528 // no valid window in current tabpage
1529 close_tabpage(curtab);
1530
1531 restore_snapshot(SNAP_AUCMD_IDX, FALSE);
1532 (void)win_comp_pos(); // recompute window positions
1533 unblock_autocmds();
1534
1535 if (win_valid(aco->save_curwin))
1536 curwin = aco->save_curwin;
1537 else
1538 // Hmm, original window disappeared. Just use the first one.
1539 curwin = firstwin;
1540 if (win_valid(aco->save_prevwin))
1541 prevwin = aco->save_prevwin;
1542#ifdef FEAT_EVAL
1543 vars_clear(&aucmd_win->w_vars->dv_hashtab); // free all w: variables
1544 hash_init(&aucmd_win->w_vars->dv_hashtab); // re-use the hashtab
1545#endif
1546 curbuf = curwin->w_buffer;
1547
1548 vim_free(globaldir);
1549 globaldir = aco->globaldir;
1550
1551 // the buffer contents may have changed
1552 check_cursor();
1553 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
1554 {
1555 curwin->w_topline = curbuf->b_ml.ml_line_count;
1556#ifdef FEAT_DIFF
1557 curwin->w_topfill = 0;
1558#endif
1559 }
1560#if defined(FEAT_GUI)
1561 // Hide the scrollbars from the aucmd_win and update.
1562 gui_mch_enable_scrollbar(&aucmd_win->w_scrollbars[SBAR_LEFT], FALSE);
1563 gui_mch_enable_scrollbar(&aucmd_win->w_scrollbars[SBAR_RIGHT], FALSE);
1564 gui_may_update_scrollbars();
1565#endif
1566 }
1567 else
1568 {
1569 // restore curwin
1570 if (win_valid(aco->save_curwin))
1571 {
1572 // Restore the buffer which was previously edited by curwin, if
1573 // it was changed, we are still the same window and the buffer is
1574 // valid.
1575 if (curwin == aco->new_curwin
1576 && curbuf != aco->new_curbuf.br_buf
1577 && bufref_valid(&aco->new_curbuf)
1578 && aco->new_curbuf.br_buf->b_ml.ml_mfp != NULL)
1579 {
1580# if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
1581 if (curwin->w_s == &curbuf->b_s)
1582 curwin->w_s = &aco->new_curbuf.br_buf->b_s;
1583# endif
1584 --curbuf->b_nwindows;
1585 curbuf = aco->new_curbuf.br_buf;
1586 curwin->w_buffer = curbuf;
1587 ++curbuf->b_nwindows;
1588 }
1589
1590 curwin = aco->save_curwin;
1591 curbuf = curwin->w_buffer;
1592 if (win_valid(aco->save_prevwin))
1593 prevwin = aco->save_prevwin;
1594 // In case the autocommand move the cursor to a position that that
1595 // not exist in curbuf.
1596 check_cursor();
1597 }
1598 }
1599}
1600
1601static int autocmd_nested = FALSE;
1602
1603/*
1604 * Execute autocommands for "event" and file name "fname".
1605 * Return TRUE if some commands were executed.
1606 */
1607 int
1608apply_autocmds(
1609 event_T event,
1610 char_u *fname, // NULL or empty means use actual file name
1611 char_u *fname_io, // fname to use for <afile> on cmdline
1612 int force, // when TRUE, ignore autocmd_busy
1613 buf_T *buf) // buffer for <abuf>
1614{
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001615 if (bt_popup(buf))
1616 return FALSE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001617 return apply_autocmds_group(event, fname, fname_io, force,
1618 AUGROUP_ALL, buf, NULL);
1619}
1620
1621/*
1622 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
1623 * setting v:filearg.
1624 */
1625 int
1626apply_autocmds_exarg(
1627 event_T event,
1628 char_u *fname,
1629 char_u *fname_io,
1630 int force,
1631 buf_T *buf,
1632 exarg_T *eap)
1633{
1634 return apply_autocmds_group(event, fname, fname_io, force,
1635 AUGROUP_ALL, buf, eap);
1636}
1637
1638/*
1639 * Like apply_autocmds(), but handles the caller's retval. If the script
1640 * processing is being aborted or if retval is FAIL when inside a try
1641 * conditional, no autocommands are executed. If otherwise the autocommands
1642 * cause the script to be aborted, retval is set to FAIL.
1643 */
1644 int
1645apply_autocmds_retval(
1646 event_T event,
1647 char_u *fname, // NULL or empty means use actual file name
1648 char_u *fname_io, // fname to use for <afile> on cmdline
1649 int force, // when TRUE, ignore autocmd_busy
1650 buf_T *buf, // buffer for <abuf>
1651 int *retval) // pointer to caller's retval
1652{
1653 int did_cmd;
1654
1655#ifdef FEAT_EVAL
1656 if (should_abort(*retval))
1657 return FALSE;
1658#endif
1659
1660 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
1661 AUGROUP_ALL, buf, NULL);
1662 if (did_cmd
1663#ifdef FEAT_EVAL
1664 && aborting()
1665#endif
1666 )
1667 *retval = FAIL;
1668 return did_cmd;
1669}
1670
1671/*
1672 * Return TRUE when there is a CursorHold autocommand defined.
1673 */
1674 int
1675has_cursorhold(void)
1676{
1677 return (first_autopat[(int)(get_real_state() == NORMAL_BUSY
1678 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
1679}
1680
1681/*
1682 * Return TRUE if the CursorHold event can be triggered.
1683 */
1684 int
1685trigger_cursorhold(void)
1686{
1687 int state;
1688
1689 if (!did_cursorhold
1690 && has_cursorhold()
1691 && reg_recording == 0
1692 && typebuf.tb_len == 0
1693#ifdef FEAT_INS_EXPAND
1694 && !ins_compl_active()
1695#endif
1696 )
1697 {
1698 state = get_real_state();
1699 if (state == NORMAL_BUSY || (state & INSERT) != 0)
1700 return TRUE;
1701 }
1702 return FALSE;
1703}
1704
1705/*
1706 * Return TRUE when there is a CursorMoved autocommand defined.
1707 */
1708 int
1709has_cursormoved(void)
1710{
1711 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
1712}
1713
1714#if defined(FEAT_CONCEAL) || defined(PROTO)
1715/*
1716 * Return TRUE when there is a CursorMovedI autocommand defined.
1717 */
1718 int
1719has_cursormovedI(void)
1720{
1721 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
1722}
1723#endif
1724
1725/*
1726 * Return TRUE when there is a TextChanged autocommand defined.
1727 */
1728 int
1729has_textchanged(void)
1730{
1731 return (first_autopat[(int)EVENT_TEXTCHANGED] != NULL);
1732}
1733
1734/*
1735 * Return TRUE when there is a TextChangedI autocommand defined.
1736 */
1737 int
1738has_textchangedI(void)
1739{
1740 return (first_autopat[(int)EVENT_TEXTCHANGEDI] != NULL);
1741}
1742
1743#if defined(FEAT_INS_EXPAND) || defined(PROTO)
1744/*
1745 * Return TRUE when there is a TextChangedP autocommand defined.
1746 */
1747 int
1748has_textchangedP(void)
1749{
1750 return (first_autopat[(int)EVENT_TEXTCHANGEDP] != NULL);
1751}
1752#endif
1753
1754/*
1755 * Return TRUE when there is an InsertCharPre autocommand defined.
1756 */
1757 int
1758has_insertcharpre(void)
1759{
1760 return (first_autopat[(int)EVENT_INSERTCHARPRE] != NULL);
1761}
1762
1763/*
1764 * Return TRUE when there is an CmdUndefined autocommand defined.
1765 */
1766 int
1767has_cmdundefined(void)
1768{
1769 return (first_autopat[(int)EVENT_CMDUNDEFINED] != NULL);
1770}
1771
1772/*
1773 * Return TRUE when there is an FuncUndefined autocommand defined.
1774 */
1775 int
1776has_funcundefined(void)
1777{
1778 return (first_autopat[(int)EVENT_FUNCUNDEFINED] != NULL);
1779}
1780
1781#if defined(FEAT_EVAL) || defined(PROTO)
1782/*
1783 * Return TRUE when there is a TextYankPost autocommand defined.
1784 */
1785 int
1786has_textyankpost(void)
1787{
1788 return (first_autopat[(int)EVENT_TEXTYANKPOST] != NULL);
1789}
1790#endif
1791
Bram Moolenaard7f246c2019-04-08 18:15:41 +02001792#if defined(FEAT_EVAL) || defined(PROTO)
1793/*
1794 * Return TRUE when there is a CompleteChanged autocommand defined.
1795 */
1796 int
1797has_completechanged(void)
1798{
1799 return (first_autopat[(int)EVENT_COMPLETECHANGED] != NULL);
1800}
1801#endif
1802
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001803/*
1804 * Execute autocommands for "event" and file name "fname".
1805 * Return TRUE if some commands were executed.
1806 */
1807 static int
1808apply_autocmds_group(
1809 event_T event,
1810 char_u *fname, // NULL or empty means use actual file name
1811 char_u *fname_io, // fname to use for <afile> on cmdline, NULL means
1812 // use fname
1813 int force, // when TRUE, ignore autocmd_busy
1814 int group, // group ID, or AUGROUP_ALL
1815 buf_T *buf, // buffer for <abuf>
1816 exarg_T *eap UNUSED) // command arguments
1817{
1818 char_u *sfname = NULL; // short file name
1819 char_u *tail;
1820 int save_changed;
1821 buf_T *old_curbuf;
1822 int retval = FALSE;
1823 char_u *save_sourcing_name;
1824 linenr_T save_sourcing_lnum;
1825 char_u *save_autocmd_fname;
1826 int save_autocmd_fname_full;
1827 int save_autocmd_bufnr;
1828 char_u *save_autocmd_match;
1829 int save_autocmd_busy;
1830 int save_autocmd_nested;
1831 static int nesting = 0;
1832 AutoPatCmd patcmd;
1833 AutoPat *ap;
1834#ifdef FEAT_EVAL
1835 sctx_T save_current_sctx;
1836 funccal_entry_T funccal_entry;
1837 char_u *save_cmdarg;
1838 long save_cmdbang;
1839#endif
1840 static int filechangeshell_busy = FALSE;
1841#ifdef FEAT_PROFILE
1842 proftime_T wait_time;
1843#endif
1844 int did_save_redobuff = FALSE;
1845 save_redo_T save_redo;
1846 int save_KeyTyped = KeyTyped;
1847
1848 /*
1849 * Quickly return if there are no autocommands for this event or
1850 * autocommands are blocked.
1851 */
1852 if (event == NUM_EVENTS || first_autopat[(int)event] == NULL
1853 || autocmd_blocked > 0)
1854 goto BYPASS_AU;
1855
1856 /*
1857 * When autocommands are busy, new autocommands are only executed when
1858 * explicitly enabled with the "nested" flag.
1859 */
1860 if (autocmd_busy && !(force || autocmd_nested))
1861 goto BYPASS_AU;
1862
1863#ifdef FEAT_EVAL
1864 /*
1865 * Quickly return when immediately aborting on error, or when an interrupt
1866 * occurred or an exception was thrown but not caught.
1867 */
1868 if (aborting())
1869 goto BYPASS_AU;
1870#endif
1871
1872 /*
1873 * FileChangedShell never nests, because it can create an endless loop.
1874 */
1875 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
1876 || event == EVENT_FILECHANGEDSHELLPOST))
1877 goto BYPASS_AU;
1878
1879 /*
1880 * Ignore events in 'eventignore'.
1881 */
1882 if (event_ignored(event))
1883 goto BYPASS_AU;
1884
1885 /*
1886 * Allow nesting of autocommands, but restrict the depth, because it's
1887 * possible to create an endless loop.
1888 */
1889 if (nesting == 10)
1890 {
1891 emsg(_("E218: autocommand nesting too deep"));
1892 goto BYPASS_AU;
1893 }
1894
1895 /*
1896 * Check if these autocommands are disabled. Used when doing ":all" or
1897 * ":ball".
1898 */
1899 if ( (autocmd_no_enter
1900 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
1901 || (autocmd_no_leave
1902 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
1903 goto BYPASS_AU;
1904
1905 /*
1906 * Save the autocmd_* variables and info about the current buffer.
1907 */
1908 save_autocmd_fname = autocmd_fname;
1909 save_autocmd_fname_full = autocmd_fname_full;
1910 save_autocmd_bufnr = autocmd_bufnr;
1911 save_autocmd_match = autocmd_match;
1912 save_autocmd_busy = autocmd_busy;
1913 save_autocmd_nested = autocmd_nested;
1914 save_changed = curbuf->b_changed;
1915 old_curbuf = curbuf;
1916
1917 /*
1918 * Set the file name to be used for <afile>.
1919 * Make a copy to avoid that changing a buffer name or directory makes it
1920 * invalid.
1921 */
1922 if (fname_io == NULL)
1923 {
1924 if (event == EVENT_COLORSCHEME || event == EVENT_COLORSCHEMEPRE
1925 || event == EVENT_OPTIONSET)
1926 autocmd_fname = NULL;
1927 else if (fname != NULL && !ends_excmd(*fname))
1928 autocmd_fname = fname;
1929 else if (buf != NULL)
1930 autocmd_fname = buf->b_ffname;
1931 else
1932 autocmd_fname = NULL;
1933 }
1934 else
1935 autocmd_fname = fname_io;
1936 if (autocmd_fname != NULL)
1937 autocmd_fname = vim_strsave(autocmd_fname);
1938 autocmd_fname_full = FALSE; // call FullName_save() later
1939
1940 /*
1941 * Set the buffer number to be used for <abuf>.
1942 */
1943 if (buf == NULL)
1944 autocmd_bufnr = 0;
1945 else
1946 autocmd_bufnr = buf->b_fnum;
1947
1948 /*
1949 * When the file name is NULL or empty, use the file name of buffer "buf".
1950 * Always use the full path of the file name to match with, in case
1951 * "allow_dirs" is set.
1952 */
1953 if (fname == NULL || *fname == NUL)
1954 {
1955 if (buf == NULL)
1956 fname = NULL;
1957 else
1958 {
1959#ifdef FEAT_SYN_HL
1960 if (event == EVENT_SYNTAX)
1961 fname = buf->b_p_syn;
1962 else
1963#endif
1964 if (event == EVENT_FILETYPE)
1965 fname = buf->b_p_ft;
1966 else
1967 {
1968 if (buf->b_sfname != NULL)
1969 sfname = vim_strsave(buf->b_sfname);
1970 fname = buf->b_ffname;
1971 }
1972 }
1973 if (fname == NULL)
1974 fname = (char_u *)"";
1975 fname = vim_strsave(fname); // make a copy, so we can change it
1976 }
1977 else
1978 {
1979 sfname = vim_strsave(fname);
1980 // Don't try expanding FileType, Syntax, FuncUndefined, WindowID,
1981 // ColorScheme, QuickFixCmd* or DirChanged
1982 if (event == EVENT_FILETYPE
1983 || event == EVENT_SYNTAX
1984 || event == EVENT_CMDLINECHANGED
1985 || event == EVENT_CMDLINEENTER
1986 || event == EVENT_CMDLINELEAVE
1987 || event == EVENT_CMDWINENTER
1988 || event == EVENT_CMDWINLEAVE
1989 || event == EVENT_CMDUNDEFINED
1990 || event == EVENT_FUNCUNDEFINED
1991 || event == EVENT_REMOTEREPLY
1992 || event == EVENT_SPELLFILEMISSING
1993 || event == EVENT_QUICKFIXCMDPRE
1994 || event == EVENT_COLORSCHEME
1995 || event == EVENT_COLORSCHEMEPRE
1996 || event == EVENT_OPTIONSET
1997 || event == EVENT_QUICKFIXCMDPOST
1998 || event == EVENT_DIRCHANGED)
1999 {
2000 fname = vim_strsave(fname);
2001 autocmd_fname_full = TRUE; // don't expand it later
2002 }
2003 else
2004 fname = FullName_save(fname, FALSE);
2005 }
2006 if (fname == NULL) // out of memory
2007 {
2008 vim_free(sfname);
2009 retval = FALSE;
2010 goto BYPASS_AU;
2011 }
2012
2013#ifdef BACKSLASH_IN_FILENAME
2014 /*
2015 * Replace all backslashes with forward slashes. This makes the
2016 * autocommand patterns portable between Unix and MS-DOS.
2017 */
2018 if (sfname != NULL)
2019 forward_slash(sfname);
2020 forward_slash(fname);
2021#endif
2022
2023#ifdef VMS
2024 // remove version for correct match
2025 if (sfname != NULL)
2026 vms_remove_version(sfname);
2027 vms_remove_version(fname);
2028#endif
2029
2030 /*
2031 * Set the name to be used for <amatch>.
2032 */
2033 autocmd_match = fname;
2034
2035
2036 // Don't redraw while doing autocommands.
2037 ++RedrawingDisabled;
2038 save_sourcing_name = sourcing_name;
2039 sourcing_name = NULL; // don't free this one
2040 save_sourcing_lnum = sourcing_lnum;
2041 sourcing_lnum = 0; // no line number here
2042
2043#ifdef FEAT_EVAL
2044 save_current_sctx = current_sctx;
2045
2046# ifdef FEAT_PROFILE
2047 if (do_profiling == PROF_YES)
2048 prof_child_enter(&wait_time); // doesn't count for the caller itself
2049# endif
2050
2051 // Don't use local function variables, if called from a function.
2052 save_funccal(&funccal_entry);
2053#endif
2054
2055 /*
2056 * When starting to execute autocommands, save the search patterns.
2057 */
2058 if (!autocmd_busy)
2059 {
2060 save_search_patterns();
2061#ifdef FEAT_INS_EXPAND
2062 if (!ins_compl_active())
2063#endif
2064 {
2065 saveRedobuff(&save_redo);
2066 did_save_redobuff = TRUE;
2067 }
2068 did_filetype = keep_filetype;
2069 }
2070
2071 /*
2072 * Note that we are applying autocmds. Some commands need to know.
2073 */
2074 autocmd_busy = TRUE;
2075 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
2076 ++nesting; // see matching decrement below
2077
2078 // Remember that FileType was triggered. Used for did_filetype().
2079 if (event == EVENT_FILETYPE)
2080 did_filetype = TRUE;
2081
2082 tail = gettail(fname);
2083
2084 // Find first autocommand that matches
2085 patcmd.curpat = first_autopat[(int)event];
2086 patcmd.nextcmd = NULL;
2087 patcmd.group = group;
2088 patcmd.fname = fname;
2089 patcmd.sfname = sfname;
2090 patcmd.tail = tail;
2091 patcmd.event = event;
2092 patcmd.arg_bufnr = autocmd_bufnr;
2093 patcmd.next = NULL;
2094 auto_next_pat(&patcmd, FALSE);
2095
2096 // found one, start executing the autocommands
2097 if (patcmd.curpat != NULL)
2098 {
2099 // add to active_apc_list
2100 patcmd.next = active_apc_list;
2101 active_apc_list = &patcmd;
2102
2103#ifdef FEAT_EVAL
2104 // set v:cmdarg (only when there is a matching pattern)
2105 save_cmdbang = (long)get_vim_var_nr(VV_CMDBANG);
2106 if (eap != NULL)
2107 {
2108 save_cmdarg = set_cmdarg(eap, NULL);
2109 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
2110 }
2111 else
2112 save_cmdarg = NULL; // avoid gcc warning
2113#endif
2114 retval = TRUE;
2115 // mark the last pattern, to avoid an endless loop when more patterns
2116 // are added when executing autocommands
2117 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
2118 ap->last = FALSE;
2119 ap->last = TRUE;
Bram Moolenaara68e5952019-04-25 22:22:01 +02002120
2121 // make sure cursor and topline are valid
2122 check_lnums(TRUE);
2123
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002124 do_cmdline(NULL, getnextac, (void *)&patcmd,
2125 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
Bram Moolenaara68e5952019-04-25 22:22:01 +02002126
2127 // restore cursor and topline, unless they were changed
2128 reset_lnums();
2129
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002130#ifdef FEAT_EVAL
2131 if (eap != NULL)
2132 {
2133 (void)set_cmdarg(NULL, save_cmdarg);
2134 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
2135 }
2136#endif
2137 // delete from active_apc_list
2138 if (active_apc_list == &patcmd) // just in case
2139 active_apc_list = patcmd.next;
2140 }
2141
2142 --RedrawingDisabled;
2143 autocmd_busy = save_autocmd_busy;
2144 filechangeshell_busy = FALSE;
2145 autocmd_nested = save_autocmd_nested;
2146 vim_free(sourcing_name);
2147 sourcing_name = save_sourcing_name;
2148 sourcing_lnum = save_sourcing_lnum;
2149 vim_free(autocmd_fname);
2150 autocmd_fname = save_autocmd_fname;
2151 autocmd_fname_full = save_autocmd_fname_full;
2152 autocmd_bufnr = save_autocmd_bufnr;
2153 autocmd_match = save_autocmd_match;
2154#ifdef FEAT_EVAL
2155 current_sctx = save_current_sctx;
2156 restore_funccal();
2157# ifdef FEAT_PROFILE
2158 if (do_profiling == PROF_YES)
2159 prof_child_exit(&wait_time);
2160# endif
2161#endif
2162 KeyTyped = save_KeyTyped;
2163 vim_free(fname);
2164 vim_free(sfname);
2165 --nesting; // see matching increment above
2166
2167 /*
2168 * When stopping to execute autocommands, restore the search patterns and
2169 * the redo buffer. Free any buffers in the au_pending_free_buf list and
2170 * free any windows in the au_pending_free_win list.
2171 */
2172 if (!autocmd_busy)
2173 {
2174 restore_search_patterns();
2175 if (did_save_redobuff)
2176 restoreRedobuff(&save_redo);
2177 did_filetype = FALSE;
2178 while (au_pending_free_buf != NULL)
2179 {
2180 buf_T *b = au_pending_free_buf->b_next;
2181 vim_free(au_pending_free_buf);
2182 au_pending_free_buf = b;
2183 }
2184 while (au_pending_free_win != NULL)
2185 {
2186 win_T *w = au_pending_free_win->w_next;
2187 vim_free(au_pending_free_win);
2188 au_pending_free_win = w;
2189 }
2190 }
2191
2192 /*
2193 * Some events don't set or reset the Changed flag.
2194 * Check if still in the same buffer!
2195 */
2196 if (curbuf == old_curbuf
2197 && (event == EVENT_BUFREADPOST
2198 || event == EVENT_BUFWRITEPOST
2199 || event == EVENT_FILEAPPENDPOST
2200 || event == EVENT_VIMLEAVE
2201 || event == EVENT_VIMLEAVEPRE))
2202 {
2203#ifdef FEAT_TITLE
2204 if (curbuf->b_changed != save_changed)
2205 need_maketitle = TRUE;
2206#endif
2207 curbuf->b_changed = save_changed;
2208 }
2209
2210 au_cleanup(); // may really delete removed patterns/commands now
2211
2212BYPASS_AU:
2213 // When wiping out a buffer make sure all its buffer-local autocommands
2214 // are deleted.
2215 if (event == EVENT_BUFWIPEOUT && buf != NULL)
2216 aubuflocal_remove(buf);
2217
2218 if (retval == OK && event == EVENT_FILETYPE)
2219 au_did_filetype = TRUE;
2220
2221 return retval;
2222}
2223
2224# ifdef FEAT_EVAL
2225static char_u *old_termresponse = NULL;
2226# endif
2227
2228/*
2229 * Block triggering autocommands until unblock_autocmd() is called.
2230 * Can be used recursively, so long as it's symmetric.
2231 */
2232 void
2233block_autocmds(void)
2234{
2235# ifdef FEAT_EVAL
2236 // Remember the value of v:termresponse.
2237 if (autocmd_blocked == 0)
2238 old_termresponse = get_vim_var_str(VV_TERMRESPONSE);
2239# endif
2240 ++autocmd_blocked;
2241}
2242
2243 void
2244unblock_autocmds(void)
2245{
2246 --autocmd_blocked;
2247
2248# ifdef FEAT_EVAL
2249 // When v:termresponse was set while autocommands were blocked, trigger
2250 // the autocommands now. Esp. useful when executing a shell command
2251 // during startup (vimdiff).
2252 if (autocmd_blocked == 0
2253 && get_vim_var_str(VV_TERMRESPONSE) != old_termresponse)
2254 apply_autocmds(EVENT_TERMRESPONSE, NULL, NULL, FALSE, curbuf);
2255# endif
2256}
2257
2258#if defined(FEAT_EVAL) && (defined(FEAT_XIM) || defined(IME_WITHOUT_XIM)) \
2259 || defined(PROTO)
2260 int
2261is_autocmd_blocked(void)
2262{
2263 return autocmd_blocked != 0;
2264}
2265#endif
2266
2267/*
2268 * Find next autocommand pattern that matches.
2269 */
2270 static void
2271auto_next_pat(
2272 AutoPatCmd *apc,
2273 int stop_at_last) // stop when 'last' flag is set
2274{
2275 AutoPat *ap;
2276 AutoCmd *cp;
2277 char_u *name;
2278 char *s;
2279
2280 VIM_CLEAR(sourcing_name);
2281
2282 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
2283 {
2284 apc->curpat = NULL;
2285
2286 // Only use a pattern when it has not been removed, has commands and
2287 // the group matches. For buffer-local autocommands only check the
2288 // buffer number.
2289 if (ap->pat != NULL && ap->cmds != NULL
2290 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
2291 {
2292 // execution-condition
2293 if (ap->buflocal_nr == 0
2294 ? (match_file_pat(NULL, &ap->reg_prog, apc->fname,
2295 apc->sfname, apc->tail, ap->allow_dirs))
2296 : ap->buflocal_nr == apc->arg_bufnr)
2297 {
2298 name = event_nr2name(apc->event);
2299 s = _("%s Autocommands for \"%s\"");
Bram Moolenaar964b3742019-05-24 18:54:09 +02002300 sourcing_name = alloc(STRLEN(s)
2301 + STRLEN(name) + ap->patlen + 1);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002302 if (sourcing_name != NULL)
2303 {
2304 sprintf((char *)sourcing_name, s,
2305 (char *)name, (char *)ap->pat);
2306 if (p_verbose >= 8)
2307 {
2308 verbose_enter();
2309 smsg(_("Executing %s"), sourcing_name);
2310 verbose_leave();
2311 }
2312 }
2313
2314 apc->curpat = ap;
2315 apc->nextcmd = ap->cmds;
2316 // mark last command
2317 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
2318 cp->last = FALSE;
2319 cp->last = TRUE;
2320 }
2321 line_breakcheck();
2322 if (apc->curpat != NULL) // found a match
2323 break;
2324 }
2325 if (stop_at_last && ap->last)
2326 break;
2327 }
2328}
2329
2330/*
2331 * Get next autocommand command.
2332 * Called by do_cmdline() to get the next line for ":if".
2333 * Returns allocated string, or NULL for end of autocommands.
2334 */
2335 char_u *
2336getnextac(int c UNUSED, void *cookie, int indent UNUSED)
2337{
2338 AutoPatCmd *acp = (AutoPatCmd *)cookie;
2339 char_u *retval;
2340 AutoCmd *ac;
2341
2342 // Can be called again after returning the last line.
2343 if (acp->curpat == NULL)
2344 return NULL;
2345
2346 // repeat until we find an autocommand to execute
2347 for (;;)
2348 {
2349 // skip removed commands
2350 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
2351 if (acp->nextcmd->last)
2352 acp->nextcmd = NULL;
2353 else
2354 acp->nextcmd = acp->nextcmd->next;
2355
2356 if (acp->nextcmd != NULL)
2357 break;
2358
2359 // at end of commands, find next pattern that matches
2360 if (acp->curpat->last)
2361 acp->curpat = NULL;
2362 else
2363 acp->curpat = acp->curpat->next;
2364 if (acp->curpat != NULL)
2365 auto_next_pat(acp, TRUE);
2366 if (acp->curpat == NULL)
2367 return NULL;
2368 }
2369
2370 ac = acp->nextcmd;
2371
2372 if (p_verbose >= 9)
2373 {
2374 verbose_enter_scroll();
2375 smsg(_("autocommand %s"), ac->cmd);
2376 msg_puts("\n"); // don't overwrite this either
2377 verbose_leave_scroll();
2378 }
2379 retval = vim_strsave(ac->cmd);
Bram Moolenaareb93f3f2019-04-04 15:04:56 +02002380 // Remove one-shot ("once") autocmd in anticipation of its execution.
2381 if (ac->once)
2382 au_del_cmd(ac);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002383 autocmd_nested = ac->nested;
2384#ifdef FEAT_EVAL
2385 current_sctx = ac->script_ctx;
2386#endif
2387 if (ac->last)
2388 acp->nextcmd = NULL;
2389 else
2390 acp->nextcmd = ac->next;
2391 return retval;
2392}
2393
2394/*
2395 * Return TRUE if there is a matching autocommand for "fname".
2396 * To account for buffer-local autocommands, function needs to know
2397 * in which buffer the file will be opened.
2398 */
2399 int
2400has_autocmd(event_T event, char_u *sfname, buf_T *buf)
2401{
2402 AutoPat *ap;
2403 char_u *fname;
2404 char_u *tail = gettail(sfname);
2405 int retval = FALSE;
2406
2407 fname = FullName_save(sfname, FALSE);
2408 if (fname == NULL)
2409 return FALSE;
2410
2411#ifdef BACKSLASH_IN_FILENAME
2412 /*
2413 * Replace all backslashes with forward slashes. This makes the
2414 * autocommand patterns portable between Unix and MS-DOS.
2415 */
2416 sfname = vim_strsave(sfname);
2417 if (sfname != NULL)
2418 forward_slash(sfname);
2419 forward_slash(fname);
2420#endif
2421
2422 for (ap = first_autopat[(int)event]; ap != NULL; ap = ap->next)
2423 if (ap->pat != NULL && ap->cmds != NULL
2424 && (ap->buflocal_nr == 0
2425 ? match_file_pat(NULL, &ap->reg_prog,
2426 fname, sfname, tail, ap->allow_dirs)
2427 : buf != NULL && ap->buflocal_nr == buf->b_fnum
2428 ))
2429 {
2430 retval = TRUE;
2431 break;
2432 }
2433
2434 vim_free(fname);
2435#ifdef BACKSLASH_IN_FILENAME
2436 vim_free(sfname);
2437#endif
2438
2439 return retval;
2440}
2441
2442#if defined(FEAT_CMDL_COMPL) || defined(PROTO)
2443/*
2444 * Function given to ExpandGeneric() to obtain the list of autocommand group
2445 * names.
2446 */
2447 char_u *
2448get_augroup_name(expand_T *xp UNUSED, int idx)
2449{
2450 if (idx == augroups.ga_len) // add "END" add the end
2451 return (char_u *)"END";
2452 if (idx >= augroups.ga_len) // end of list
2453 return NULL;
2454 if (AUGROUP_NAME(idx) == NULL || AUGROUP_NAME(idx) == get_deleted_augroup())
2455 // skip deleted entries
2456 return (char_u *)"";
2457 return AUGROUP_NAME(idx); // return a name
2458}
2459
2460static int include_groups = FALSE;
2461
2462 char_u *
2463set_context_in_autocmd(
2464 expand_T *xp,
2465 char_u *arg,
2466 int doautocmd) // TRUE for :doauto*, FALSE for :autocmd
2467{
2468 char_u *p;
2469 int group;
2470
2471 // check for a group name, skip it if present
2472 include_groups = FALSE;
2473 p = arg;
2474 group = au_get_grouparg(&arg);
2475 if (group == AUGROUP_ERROR)
2476 return NULL;
2477 // If there only is a group name that's what we expand.
2478 if (*arg == NUL && group != AUGROUP_ALL && !VIM_ISWHITE(arg[-1]))
2479 {
2480 arg = p;
2481 group = AUGROUP_ALL;
2482 }
2483
2484 // skip over event name
2485 for (p = arg; *p != NUL && !VIM_ISWHITE(*p); ++p)
2486 if (*p == ',')
2487 arg = p + 1;
2488 if (*p == NUL)
2489 {
2490 if (group == AUGROUP_ALL)
2491 include_groups = TRUE;
2492 xp->xp_context = EXPAND_EVENTS; // expand event name
2493 xp->xp_pattern = arg;
2494 return NULL;
2495 }
2496
2497 // skip over pattern
2498 arg = skipwhite(p);
2499 while (*arg && (!VIM_ISWHITE(*arg) || arg[-1] == '\\'))
2500 arg++;
2501 if (*arg)
2502 return arg; // expand (next) command
2503
2504 if (doautocmd)
2505 xp->xp_context = EXPAND_FILES; // expand file names
2506 else
2507 xp->xp_context = EXPAND_NOTHING; // pattern is not expanded
2508 return NULL;
2509}
2510
2511/*
2512 * Function given to ExpandGeneric() to obtain the list of event names.
2513 */
2514 char_u *
2515get_event_name(expand_T *xp UNUSED, int idx)
2516{
2517 if (idx < augroups.ga_len) // First list group names, if wanted
2518 {
2519 if (!include_groups || AUGROUP_NAME(idx) == NULL
2520 || AUGROUP_NAME(idx) == get_deleted_augroup())
2521 return (char_u *)""; // skip deleted entries
2522 return AUGROUP_NAME(idx); // return a name
2523 }
2524 return (char_u *)event_names[idx - augroups.ga_len].name;
2525}
2526
2527#endif // FEAT_CMDL_COMPL
2528
2529#if defined(FEAT_EVAL) || defined(PROTO)
2530/*
2531 * Return TRUE if autocmd is supported.
2532 */
2533 int
2534autocmd_supported(char_u *name)
2535{
2536 char_u *p;
2537
2538 return (event_name2nr(name, &p) != NUM_EVENTS);
2539}
2540
2541/*
2542 * Return TRUE if an autocommand is defined for a group, event and
2543 * pattern: The group can be omitted to accept any group. "event" and "pattern"
2544 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
2545 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
2546 * Used for:
2547 * exists("#Group") or
2548 * exists("#Group#Event") or
2549 * exists("#Group#Event#pat") or
2550 * exists("#Event") or
2551 * exists("#Event#pat")
2552 */
2553 int
2554au_exists(char_u *arg)
2555{
2556 char_u *arg_save;
2557 char_u *pattern = NULL;
2558 char_u *event_name;
2559 char_u *p;
2560 event_T event;
2561 AutoPat *ap;
2562 buf_T *buflocal_buf = NULL;
2563 int group;
2564 int retval = FALSE;
2565
2566 // Make a copy so that we can change the '#' chars to a NUL.
2567 arg_save = vim_strsave(arg);
2568 if (arg_save == NULL)
2569 return FALSE;
2570 p = vim_strchr(arg_save, '#');
2571 if (p != NULL)
2572 *p++ = NUL;
2573
2574 // First, look for an autocmd group name
2575 group = au_find_group(arg_save);
2576 if (group == AUGROUP_ERROR)
2577 {
2578 // Didn't match a group name, assume the first argument is an event.
2579 group = AUGROUP_ALL;
2580 event_name = arg_save;
2581 }
2582 else
2583 {
2584 if (p == NULL)
2585 {
2586 // "Group": group name is present and it's recognized
2587 retval = TRUE;
2588 goto theend;
2589 }
2590
2591 // Must be "Group#Event" or "Group#Event#pat".
2592 event_name = p;
2593 p = vim_strchr(event_name, '#');
2594 if (p != NULL)
2595 *p++ = NUL; // "Group#Event#pat"
2596 }
2597
2598 pattern = p; // "pattern" is NULL when there is no pattern
2599
2600 // find the index (enum) for the event name
2601 event = event_name2nr(event_name, &p);
2602
2603 // return FALSE if the event name is not recognized
2604 if (event == NUM_EVENTS)
2605 goto theend;
2606
2607 // Find the first autocommand for this event.
2608 // If there isn't any, return FALSE;
2609 // If there is one and no pattern given, return TRUE;
2610 ap = first_autopat[(int)event];
2611 if (ap == NULL)
2612 goto theend;
2613
2614 // if pattern is "<buffer>", special handling is needed which uses curbuf
2615 // for pattern "<buffer=N>, fnamecmp() will work fine
2616 if (pattern != NULL && STRICMP(pattern, "<buffer>") == 0)
2617 buflocal_buf = curbuf;
2618
2619 // Check if there is an autocommand with the given pattern.
2620 for ( ; ap != NULL; ap = ap->next)
2621 // only use a pattern when it has not been removed and has commands.
2622 // For buffer-local autocommands, fnamecmp() works fine.
2623 if (ap->pat != NULL && ap->cmds != NULL
2624 && (group == AUGROUP_ALL || ap->group == group)
2625 && (pattern == NULL
2626 || (buflocal_buf == NULL
2627 ? fnamecmp(ap->pat, pattern) == 0
2628 : ap->buflocal_nr == buflocal_buf->b_fnum)))
2629 {
2630 retval = TRUE;
2631 break;
2632 }
2633
2634theend:
2635 vim_free(arg_save);
2636 return retval;
2637}
2638#endif