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