blob: a409379b6192eb010e539368baf97e33b1c761bd [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
LemonBoyeca7c602022-04-14 15:39:43 +010058 sctx_T script_ctx; // script context where it is 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},
Bram Moolenaar28e8f732022-02-09 12:58:20 +0000122 {"DirChangedPre", EVENT_DIRCHANGEDPRE},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100123 {"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},
Bram Moolenaarb53e13a2020-10-21 12:19:53 +0200151 {"InsertLeavePre", EVENT_INSERTLEAVEPRE},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100152 {"InsertCharPre", EVENT_INSERTCHARPRE},
153 {"MenuPopup", EVENT_MENUPOPUP},
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +0200154 {"ModeChanged", EVENT_MODECHANGED},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100155 {"OptionSet", EVENT_OPTIONSET},
156 {"QuickFixCmdPost", EVENT_QUICKFIXCMDPOST},
157 {"QuickFixCmdPre", EVENT_QUICKFIXCMDPRE},
158 {"QuitPre", EVENT_QUITPRE},
159 {"RemoteReply", EVENT_REMOTEREPLY},
Bram Moolenaar8aeec402019-09-15 23:02:04 +0200160 {"SafeState", EVENT_SAFESTATE},
Bram Moolenaar69198cb2019-09-16 21:58:13 +0200161 {"SafeStateAgain", EVENT_SAFESTATEAGAIN},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100162 {"SessionLoadPost", EVENT_SESSIONLOADPOST},
163 {"ShellCmdPost", EVENT_SHELLCMDPOST},
164 {"ShellFilterPost", EVENT_SHELLFILTERPOST},
Bram Moolenaarbe5ee862020-06-10 20:56:58 +0200165 {"SigUSR1", EVENT_SIGUSR1},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100166 {"SourceCmd", EVENT_SOURCECMD},
167 {"SourcePre", EVENT_SOURCEPRE},
168 {"SourcePost", EVENT_SOURCEPOST},
169 {"SpellFileMissing",EVENT_SPELLFILEMISSING},
170 {"StdinReadPost", EVENT_STDINREADPOST},
171 {"StdinReadPre", EVENT_STDINREADPRE},
172 {"SwapExists", EVENT_SWAPEXISTS},
173 {"Syntax", EVENT_SYNTAX},
174 {"TabNew", EVENT_TABNEW},
175 {"TabClosed", EVENT_TABCLOSED},
176 {"TabEnter", EVENT_TABENTER},
177 {"TabLeave", EVENT_TABLEAVE},
178 {"TermChanged", EVENT_TERMCHANGED},
179 {"TerminalOpen", EVENT_TERMINALOPEN},
Bram Moolenaar28ed4df2019-10-26 16:21:40 +0200180 {"TerminalWinOpen", EVENT_TERMINALWINOPEN},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100181 {"TermResponse", EVENT_TERMRESPONSE},
182 {"TextChanged", EVENT_TEXTCHANGED},
183 {"TextChangedI", EVENT_TEXTCHANGEDI},
184 {"TextChangedP", EVENT_TEXTCHANGEDP},
Shougo Matsushita4ccaedf2022-10-15 11:48:00 +0100185 {"TextChangedT", EVENT_TEXTCHANGEDT},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100186 {"User", EVENT_USER},
187 {"VimEnter", EVENT_VIMENTER},
188 {"VimLeave", EVENT_VIMLEAVE},
189 {"VimLeavePre", EVENT_VIMLEAVEPRE},
190 {"WinNew", EVENT_WINNEW},
naohiro ono23beefe2021-11-13 12:38:49 +0000191 {"WinClosed", EVENT_WINCLOSED},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100192 {"WinEnter", EVENT_WINENTER},
193 {"WinLeave", EVENT_WINLEAVE},
Bram Moolenaar35fc61c2022-11-22 12:40:50 +0000194 {"WinResized", EVENT_WINRESIZED},
LemonBoy09371822022-04-08 15:18:45 +0100195 {"WinScrolled", EVENT_WINSCROLLED},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100196 {"VimResized", EVENT_VIMRESIZED},
197 {"TextYankPost", EVENT_TEXTYANKPOST},
Bram Moolenaar100118c2020-12-11 19:30:34 +0100198 {"VimSuspend", EVENT_VIMSUSPEND},
199 {"VimResume", EVENT_VIMRESUME},
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100200 {NULL, (event_T)0}
201};
202
203static AutoPat *first_autopat[NUM_EVENTS] =
204{
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 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
210 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
211};
212
213static AutoPat *last_autopat[NUM_EVENTS] =
214{
215 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
216 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
217 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
218 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
219 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
220 NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
221};
222
kylo252ae6f1d82022-02-16 19:24:07 +0000223#define AUGROUP_DEFAULT (-1) // default autocmd group
224#define AUGROUP_ERROR (-2) // erroneous autocmd group
225#define AUGROUP_ALL (-3) // all autocmd groups
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100226
227/*
228 * struct used to keep status while executing autocommands for an event.
229 */
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100230struct AutoPatCmd_S
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100231{
232 AutoPat *curpat; // next AutoPat to examine
233 AutoCmd *nextcmd; // next AutoCmd to execute
234 int group; // group being used
235 char_u *fname; // fname to match with
236 char_u *sfname; // sfname to match with
237 char_u *tail; // tail of fname
238 event_T event; // current event
LemonBoyeca7c602022-04-14 15:39:43 +0100239 sctx_T script_ctx; // script context where it is defined
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100240 int arg_bufnr; // Initially equal to <abuf>, set to zero when
241 // buf is deleted.
LemonBoyeca7c602022-04-14 15:39:43 +0100242 AutoPatCmd_T *next; // chain of active apc-s for auto-invalidation
Bram Moolenaar1a47ae32019-12-29 23:04:25 +0100243};
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100244
LemonBoyeca7c602022-04-14 15:39:43 +0100245static AutoPatCmd_T *active_apc_list = NULL; // stack of active autocommands
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100246
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200247// Macro to loop over all the patterns for an autocmd event
248#define FOR_ALL_AUTOCMD_PATTERNS(event, ap) \
249 for ((ap) = first_autopat[(int)(event)]; (ap) != NULL; (ap) = (ap)->next)
250
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100251/*
252 * augroups stores a list of autocmd group names.
253 */
254static garray_T augroups = {0, 0, sizeof(char_u *), 10, NULL};
255#define AUGROUP_NAME(i) (((char_u **)augroups.ga_data)[i])
Bram Moolenaarc667da52019-11-30 20:52:27 +0100256// use get_deleted_augroup() to get this
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100257static char_u *deleted_augroup = NULL;
258
259/*
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100260 * The ID of the current group. Group 0 is the default one.
261 */
262static int current_augroup = AUGROUP_DEFAULT;
263
Bram Moolenaarc667da52019-11-30 20:52:27 +0100264static int au_need_clean = FALSE; // need to delete marked patterns
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100265
266static char_u *event_nr2name(event_T event);
267static int au_get_grouparg(char_u **argp);
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +0200268static 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 +0100269static int apply_autocmds_group(event_T event, char_u *fname, char_u *fname_io, int force, int group, buf_T *buf, exarg_T *eap);
LemonBoyeca7c602022-04-14 15:39:43 +0100270static void auto_next_pat(AutoPatCmd_T *apc, int stop_at_last);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100271static int au_find_group(char_u *name);
272
273static event_T last_event;
274static int last_group;
Bram Moolenaarc667da52019-11-30 20:52:27 +0100275static int autocmd_blocked = 0; // block all autocmds
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100276
277 static char_u *
278get_deleted_augroup(void)
279{
280 if (deleted_augroup == NULL)
281 deleted_augroup = (char_u *)_("--Deleted--");
282 return deleted_augroup;
283}
284
285/*
286 * Show the autocommands for one AutoPat.
287 */
288 static void
289show_autocmd(AutoPat *ap, event_T event)
290{
291 AutoCmd *ac;
292
293 // Check for "got_int" (here and at various places below), which is set
294 // when "q" has been hit for the "--more--" prompt
295 if (got_int)
296 return;
297 if (ap->pat == NULL) // pattern has been removed
298 return;
299
Bram Moolenaar3b014be2022-11-13 17:53:46 +0000300 // Make sure no info referenced by "ap" is cleared, e.g. when a timer
301 // clears an augroup. Jump to "theend" after this!
302 // "ap->pat" may be cleared anyway.
303 ++autocmd_busy;
304
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100305 msg_putchar('\n');
306 if (got_int)
Bram Moolenaar3b014be2022-11-13 17:53:46 +0000307 goto theend;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100308 if (event != last_event || ap->group != last_group)
309 {
310 if (ap->group != AUGROUP_DEFAULT)
311 {
312 if (AUGROUP_NAME(ap->group) == NULL)
313 msg_puts_attr((char *)get_deleted_augroup(), HL_ATTR(HLF_E));
314 else
315 msg_puts_attr((char *)AUGROUP_NAME(ap->group), HL_ATTR(HLF_T));
316 msg_puts(" ");
317 }
318 msg_puts_attr((char *)event_nr2name(event), HL_ATTR(HLF_T));
319 last_event = event;
320 last_group = ap->group;
321 msg_putchar('\n');
322 if (got_int)
Bram Moolenaar3b014be2022-11-13 17:53:46 +0000323 goto theend;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100324 }
Bram Moolenaar3b014be2022-11-13 17:53:46 +0000325
326 if (ap->pat == NULL)
327 goto theend; // timer might have cleared the pattern or group
328
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100329 msg_col = 4;
330 msg_outtrans(ap->pat);
331
332 for (ac = ap->cmds; ac != NULL; ac = ac->next)
333 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100334 if (ac->cmd == NULL) // skip removed commands
335 continue;
336
337 if (msg_col >= 14)
338 msg_putchar('\n');
339 msg_col = 14;
340 if (got_int)
Bram Moolenaar3b014be2022-11-13 17:53:46 +0000341 goto theend;
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100342 msg_outtrans(ac->cmd);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100343#ifdef FEAT_EVAL
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100344 if (p_verbose > 0)
345 last_set_msg(ac->script_ctx);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100346#endif
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100347 if (got_int)
Bram Moolenaar3b014be2022-11-13 17:53:46 +0000348 goto theend;
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100349 if (ac->next != NULL)
350 {
351 msg_putchar('\n');
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100352 if (got_int)
Bram Moolenaar3b014be2022-11-13 17:53:46 +0000353 goto theend;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100354 }
355 }
Bram Moolenaar3b014be2022-11-13 17:53:46 +0000356
357theend:
358 --autocmd_busy;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100359}
360
361/*
362 * Mark an autocommand pattern for deletion.
363 */
364 static void
365au_remove_pat(AutoPat *ap)
366{
367 VIM_CLEAR(ap->pat);
368 ap->buflocal_nr = -1;
369 au_need_clean = TRUE;
370}
371
372/*
373 * Mark all commands for a pattern for deletion.
374 */
375 static void
376au_remove_cmds(AutoPat *ap)
377{
378 AutoCmd *ac;
379
380 for (ac = ap->cmds; ac != NULL; ac = ac->next)
381 VIM_CLEAR(ac->cmd);
382 au_need_clean = TRUE;
383}
384
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200385// Delete one command from an autocmd pattern.
386static void au_del_cmd(AutoCmd *ac)
387{
388 VIM_CLEAR(ac->cmd);
389 au_need_clean = TRUE;
390}
391
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100392/*
393 * Cleanup autocommands and patterns that have been deleted.
394 * This is only done when not executing autocommands.
395 */
396 static void
397au_cleanup(void)
398{
399 AutoPat *ap, **prev_ap;
400 AutoCmd *ac, **prev_ac;
401 event_T event;
402
403 if (autocmd_busy || !au_need_clean)
404 return;
405
406 // loop over all events
=?UTF-8?q?Dundar=20G=C3=B6c?=dfa5e462021-10-02 11:26:51 +0100407 for (event = (event_T)0; (int)event < NUM_EVENTS;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100408 event = (event_T)((int)event + 1))
409 {
410 // loop over all autocommand patterns
411 prev_ap = &(first_autopat[(int)event]);
412 for (ap = *prev_ap; ap != NULL; ap = *prev_ap)
413 {
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200414 int has_cmd = FALSE;
415
Bram Moolenaar8f4aeb52019-04-04 15:40:56 +0200416 // loop over all commands for this pattern
417 prev_ac = &(ap->cmds);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100418 for (ac = *prev_ac; ac != NULL; ac = *prev_ac)
419 {
420 // remove the command if the pattern is to be deleted or when
421 // the command has been marked for deletion
422 if (ap->pat == NULL || ac->cmd == NULL)
423 {
424 *prev_ac = ac->next;
425 vim_free(ac->cmd);
426 vim_free(ac);
427 }
Bram Moolenaar8f4aeb52019-04-04 15:40:56 +0200428 else
429 {
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200430 has_cmd = TRUE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100431 prev_ac = &(ac->next);
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200432 }
433 }
434
Bram Moolenaar8f4aeb52019-04-04 15:40:56 +0200435 if (ap->pat != NULL && !has_cmd)
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200436 // Pattern was not marked for deletion, but all of its
437 // commands were. So mark the pattern for deletion.
438 au_remove_pat(ap);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100439
440 // remove the pattern if it has been marked for deletion
441 if (ap->pat == NULL)
442 {
443 if (ap->next == NULL)
444 {
445 if (prev_ap == &(first_autopat[(int)event]))
446 last_autopat[(int)event] = NULL;
447 else
448 // this depends on the "next" field being the first in
449 // the struct
450 last_autopat[(int)event] = (AutoPat *)prev_ap;
451 }
452 *prev_ap = ap->next;
453 vim_regfree(ap->reg_prog);
454 vim_free(ap);
455 }
456 else
457 prev_ap = &(ap->next);
458 }
459 }
460
461 au_need_clean = FALSE;
462}
463
464/*
465 * Called when buffer is freed, to remove/invalidate related buffer-local
466 * autocmds.
467 */
468 void
469aubuflocal_remove(buf_T *buf)
470{
LemonBoyeca7c602022-04-14 15:39:43 +0100471 AutoPat *ap;
472 event_T event;
473 AutoPatCmd_T *apc;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100474
475 // invalidate currently executing autocommands
476 for (apc = active_apc_list; apc; apc = apc->next)
477 if (buf->b_fnum == apc->arg_bufnr)
478 apc->arg_bufnr = 0;
479
480 // invalidate buflocals looping through events
=?UTF-8?q?Dundar=20G=C3=B6c?=dfa5e462021-10-02 11:26:51 +0100481 for (event = (event_T)0; (int)event < NUM_EVENTS;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100482 event = (event_T)((int)event + 1))
483 // loop over all autocommand patterns
Bram Moolenaaraeea7212020-04-02 18:50:46 +0200484 FOR_ALL_AUTOCMD_PATTERNS(event, ap)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100485 if (ap->buflocal_nr == buf->b_fnum)
486 {
487 au_remove_pat(ap);
488 if (p_verbose >= 6)
489 {
490 verbose_enter();
491 smsg(_("auto-removing autocommand: %s <buffer=%d>"),
492 event_nr2name(event), buf->b_fnum);
493 verbose_leave();
494 }
495 }
496 au_cleanup();
497}
498
499/*
500 * Add an autocmd group name.
501 * Return its ID. Returns AUGROUP_ERROR (< 0) for error.
502 */
503 static int
504au_new_group(char_u *name)
505{
506 int i;
507
508 i = au_find_group(name);
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100509 if (i != AUGROUP_ERROR)
510 return i;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100511
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100512 // the group doesn't exist yet, add it. First try using a free entry.
513 for (i = 0; i < augroups.ga_len; ++i)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100514 if (AUGROUP_NAME(i) == NULL)
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100515 break;
516 if (i == augroups.ga_len && ga_grow(&augroups, 1) == FAIL)
517 return AUGROUP_ERROR;
518
519 AUGROUP_NAME(i) = vim_strsave(name);
520 if (AUGROUP_NAME(i) == NULL)
521 return AUGROUP_ERROR;
522 if (i == augroups.ga_len)
523 ++augroups.ga_len;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100524
525 return i;
526}
527
528 static void
529au_del_group(char_u *name)
530{
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100531 int i;
532 event_T event;
533 AutoPat *ap;
534 int in_use = FALSE;
535
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100536
537 i = au_find_group(name);
538 if (i == AUGROUP_ERROR) // the group doesn't exist
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100539 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100540 semsg(_(e_no_such_group_str), name);
541 return;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100542 }
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100543 if (i == current_augroup)
544 {
545 emsg(_(e_cannot_delete_current_group));
546 return;
547 }
548
549 for (event = (event_T)0; (int)event < NUM_EVENTS;
550 event = (event_T)((int)event + 1))
551 {
552 FOR_ALL_AUTOCMD_PATTERNS(event, ap)
553 if (ap->group == i && ap->pat != NULL)
554 {
555 give_warning((char_u *)_("W19: Deleting augroup that is still in use"), TRUE);
556 in_use = TRUE;
557 event = NUM_EVENTS;
558 break;
559 }
560 }
561 vim_free(AUGROUP_NAME(i));
562 if (in_use)
563 AUGROUP_NAME(i) = get_deleted_augroup();
564 else
565 AUGROUP_NAME(i) = NULL;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100566}
567
568/*
569 * Find the ID of an autocmd group name.
570 * Return its ID. Returns AUGROUP_ERROR (< 0) for error.
571 */
572 static int
573au_find_group(char_u *name)
574{
575 int i;
576
577 for (i = 0; i < augroups.ga_len; ++i)
578 if (AUGROUP_NAME(i) != NULL && AUGROUP_NAME(i) != get_deleted_augroup()
579 && STRCMP(AUGROUP_NAME(i), name) == 0)
580 return i;
581 return AUGROUP_ERROR;
582}
583
584/*
585 * Return TRUE if augroup "name" exists.
586 */
587 int
588au_has_group(char_u *name)
589{
590 return au_find_group(name) != AUGROUP_ERROR;
591}
592
593/*
594 * ":augroup {name}".
595 */
596 void
597do_augroup(char_u *arg, int del_group)
598{
599 int i;
600
601 if (del_group)
602 {
603 if (*arg == NUL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000604 emsg(_(e_argument_required));
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100605 else
606 au_del_group(arg);
607 }
608 else if (STRICMP(arg, "end") == 0) // ":aug end": back to group 0
609 current_augroup = AUGROUP_DEFAULT;
610 else if (*arg) // ":aug xxx": switch to group xxx
611 {
612 i = au_new_group(arg);
613 if (i != AUGROUP_ERROR)
614 current_augroup = i;
615 }
616 else // ":aug": list the group names
617 {
618 msg_start();
619 for (i = 0; i < augroups.ga_len; ++i)
620 {
621 if (AUGROUP_NAME(i) != NULL)
622 {
623 msg_puts((char *)AUGROUP_NAME(i));
624 msg_puts(" ");
625 }
626 }
627 msg_clr_eos();
628 msg_end();
629 }
630}
631
Bram Moolenaare76062c2022-11-28 18:51:43 +0000632 void
633autocmd_init(void)
634{
635 CLEAR_FIELD(aucmd_win);
636}
637
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100638#if defined(EXITFREE) || defined(PROTO)
639 void
640free_all_autocmds(void)
641{
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100642 char_u *s;
643
644 for (current_augroup = -1; current_augroup < augroups.ga_len;
645 ++current_augroup)
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +0200646 do_autocmd(NULL, (char_u *)"", TRUE);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100647
Bram Moolenaare76062c2022-11-28 18:51:43 +0000648 for (int i = 0; i < augroups.ga_len; ++i)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100649 {
650 s = ((char_u **)(augroups.ga_data))[i];
651 if (s != get_deleted_augroup())
652 vim_free(s);
653 }
654 ga_clear(&augroups);
Bram Moolenaare76062c2022-11-28 18:51:43 +0000655
Bram Moolenaar84497cd2022-11-28 20:34:52 +0000656 // aucmd_win[] is freed in win_free_all()
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100657}
658#endif
659
660/*
Bram Moolenaare76062c2022-11-28 18:51:43 +0000661 * Return TRUE if "win" is an active entry in aucmd_win[].
662 */
663 int
664is_aucmd_win(win_T *win)
665{
666 for (int i = 0; i < AUCMD_WIN_COUNT; ++i)
667 if (aucmd_win[i].auc_win_used && aucmd_win[i].auc_win == win)
668 return TRUE;
669 return FALSE;
670}
671
672/*
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100673 * Return the event number for event name "start".
674 * Return NUM_EVENTS if the event name was not found.
675 * Return a pointer to the next event name in "end".
676 */
677 static event_T
678event_name2nr(char_u *start, char_u **end)
679{
680 char_u *p;
681 int i;
682 int len;
683
684 // the event name ends with end of line, '|', a blank or a comma
685 for (p = start; *p && !VIM_ISWHITE(*p) && *p != ',' && *p != '|'; ++p)
686 ;
687 for (i = 0; event_names[i].name != NULL; ++i)
688 {
689 len = (int)STRLEN(event_names[i].name);
690 if (len == p - start && STRNICMP(event_names[i].name, start, len) == 0)
691 break;
692 }
693 if (*p == ',')
694 ++p;
695 *end = p;
696 if (event_names[i].name == NULL)
697 return NUM_EVENTS;
698 return event_names[i].event;
699}
700
701/*
702 * Return the name for event "event".
703 */
704 static char_u *
705event_nr2name(event_T event)
706{
707 int i;
708
709 for (i = 0; event_names[i].name != NULL; ++i)
710 if (event_names[i].event == event)
711 return (char_u *)event_names[i].name;
712 return (char_u *)"Unknown";
713}
714
715/*
716 * Scan over the events. "*" stands for all events.
717 */
718 static char_u *
719find_end_event(
720 char_u *arg,
721 int have_group) // TRUE when group name was found
722{
723 char_u *pat;
724 char_u *p;
725
726 if (*arg == '*')
727 {
728 if (arg[1] && !VIM_ISWHITE(arg[1]))
729 {
Bram Moolenaar6d057012021-12-31 18:49:43 +0000730 semsg(_(e_illegal_character_after_star_str), arg);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100731 return NULL;
732 }
733 pat = arg + 1;
734 }
735 else
736 {
737 for (pat = arg; *pat && *pat != '|' && !VIM_ISWHITE(*pat); pat = p)
738 {
=?UTF-8?q?Dundar=20G=C3=B6c?=dfa5e462021-10-02 11:26:51 +0100739 if ((int)event_name2nr(pat, &p) >= NUM_EVENTS)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100740 {
741 if (have_group)
Bram Moolenaar6d057012021-12-31 18:49:43 +0000742 semsg(_(e_no_such_event_str), pat);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100743 else
Bram Moolenaar6d057012021-12-31 18:49:43 +0000744 semsg(_(e_no_such_group_or_event_str), pat);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100745 return NULL;
746 }
747 }
748 }
749 return pat;
750}
751
752/*
753 * Return TRUE if "event" is included in 'eventignore'.
754 */
755 static int
756event_ignored(event_T event)
757{
758 char_u *p = p_ei;
759
760 while (*p != NUL)
761 {
762 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
763 return TRUE;
764 if (event_name2nr(p, &p) == event)
765 return TRUE;
766 }
767
768 return FALSE;
769}
770
771/*
772 * Return OK when the contents of p_ei is valid, FAIL otherwise.
773 */
774 int
775check_ei(void)
776{
777 char_u *p = p_ei;
778
779 while (*p)
780 {
781 if (STRNICMP(p, "all", 3) == 0 && (p[3] == NUL || p[3] == ','))
782 {
783 p += 3;
784 if (*p == ',')
785 ++p;
786 }
787 else if (event_name2nr(p, &p) == NUM_EVENTS)
788 return FAIL;
789 }
790
791 return OK;
792}
793
794# if defined(FEAT_SYN_HL) || defined(PROTO)
795
796/*
797 * Add "what" to 'eventignore' to skip loading syntax highlighting for every
798 * buffer loaded into the window. "what" must start with a comma.
799 * Returns the old value of 'eventignore' in allocated memory.
800 */
801 char_u *
802au_event_disable(char *what)
803{
804 char_u *new_ei;
805 char_u *save_ei;
806
807 save_ei = vim_strsave(p_ei);
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100808 if (save_ei == NULL)
809 return NULL;
810
811 new_ei = vim_strnsave(p_ei, STRLEN(p_ei) + STRLEN(what));
812 if (new_ei == NULL)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100813 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100814 vim_free(save_ei);
815 return NULL;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100816 }
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100817
818 if (*what == ',' && *p_ei == NUL)
819 STRCPY(new_ei, what + 1);
820 else
821 STRCAT(new_ei, what);
822 set_string_option_direct((char_u *)"ei", -1, new_ei,
823 OPT_FREE, SID_NONE);
824 vim_free(new_ei);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100825 return save_ei;
826}
827
828 void
829au_event_restore(char_u *old_ei)
830{
831 if (old_ei != NULL)
832 {
833 set_string_option_direct((char_u *)"ei", -1, old_ei,
834 OPT_FREE, SID_NONE);
835 vim_free(old_ei);
836 }
837}
Bram Moolenaarc667da52019-11-30 20:52:27 +0100838# endif // FEAT_SYN_HL
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100839
840/*
841 * do_autocmd() -- implements the :autocmd command. Can be used in the
842 * following ways:
843 *
844 * :autocmd <event> <pat> <cmd> Add <cmd> to the list of commands that
845 * will be automatically executed for <event>
846 * when editing a file matching <pat>, in
847 * the current group.
848 * :autocmd <event> <pat> Show the autocommands associated with
849 * <event> and <pat>.
850 * :autocmd <event> Show the autocommands associated with
851 * <event>.
852 * :autocmd Show all autocommands.
853 * :autocmd! <event> <pat> <cmd> Remove all autocommands associated with
854 * <event> and <pat>, and add the command
855 * <cmd>, for the current group.
856 * :autocmd! <event> <pat> Remove all autocommands associated with
857 * <event> and <pat> for the current group.
858 * :autocmd! <event> Remove all autocommands associated with
859 * <event> for the current group.
860 * :autocmd! Remove ALL autocommands for the current
861 * group.
862 *
863 * Multiple events and patterns may be given separated by commas. Here are
864 * some examples:
865 * :autocmd bufread,bufenter *.c,*.h set tw=0 smartindent noic
866 * :autocmd bufleave * set tw=79 nosmartindent ic infercase
867 *
868 * :autocmd * *.c show all autocommands for *.c files.
869 *
870 * Mostly a {group} argument can optionally appear before <event>.
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +0200871 * "eap" can be NULL.
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100872 */
873 void
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +0200874do_autocmd(exarg_T *eap, char_u *arg_in, int forceit)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100875{
876 char_u *arg = arg_in;
877 char_u *pat;
878 char_u *envpat = NULL;
879 char_u *cmd;
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +0200880 int cmd_need_free = FALSE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100881 event_T event;
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +0200882 char_u *tofree = NULL;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100883 int nested = FALSE;
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200884 int once = FALSE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100885 int group;
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200886 int i;
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +0200887 int flags = 0;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100888
889 if (*arg == '|')
890 {
Bram Moolenaarb8e642f2021-11-20 10:38:25 +0000891 eap->nextcmd = arg + 1;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100892 arg = (char_u *)"";
893 group = AUGROUP_ALL; // no argument, use all groups
894 }
895 else
896 {
897 /*
898 * Check for a legal group name. If not, use AUGROUP_ALL.
899 */
900 group = au_get_grouparg(&arg);
901 if (arg == NULL) // out of memory
902 return;
903 }
904
905 /*
906 * Scan over the events.
907 * If we find an illegal name, return here, don't do anything.
908 */
909 pat = find_end_event(arg, group != AUGROUP_ALL);
910 if (pat == NULL)
911 return;
912
913 pat = skipwhite(pat);
914 if (*pat == '|')
915 {
Bram Moolenaarb8e642f2021-11-20 10:38:25 +0000916 eap->nextcmd = pat + 1;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100917 pat = (char_u *)"";
918 cmd = (char_u *)"";
919 }
920 else
921 {
922 /*
923 * Scan over the pattern. Put a NUL at the end.
924 */
925 cmd = pat;
926 while (*cmd && (!VIM_ISWHITE(*cmd) || cmd[-1] == '\\'))
927 cmd++;
928 if (*cmd)
929 *cmd++ = NUL;
930
931 // Expand environment variables in the pattern. Set 'shellslash', we
932 // want forward slashes here.
933 if (vim_strchr(pat, '$') != NULL || vim_strchr(pat, '~') != NULL)
934 {
935#ifdef BACKSLASH_IN_FILENAME
936 int p_ssl_save = p_ssl;
937
938 p_ssl = TRUE;
939#endif
940 envpat = expand_env_save(pat);
941#ifdef BACKSLASH_IN_FILENAME
942 p_ssl = p_ssl_save;
943#endif
944 if (envpat != NULL)
945 pat = envpat;
946 }
947
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100948 cmd = skipwhite(cmd);
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200949 for (i = 0; i < 2; i++)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100950 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100951 if (*cmd == NUL)
952 continue;
953
954 // Check for "++once" flag.
955 if (STRNCMP(cmd, "++once", 6) == 0 && VIM_ISWHITE(cmd[6]))
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200956 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100957 if (once)
958 semsg(_(e_duplicate_argument_str), "++once");
959 once = TRUE;
960 cmd = skipwhite(cmd + 6);
961 }
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200962
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100963 // Check for "++nested" flag.
964 if ((STRNCMP(cmd, "++nested", 8) == 0 && VIM_ISWHITE(cmd[8])))
965 {
966 if (nested)
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200967 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100968 semsg(_(e_duplicate_argument_str), "++nested");
969 return;
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200970 }
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100971 nested = TRUE;
972 cmd = skipwhite(cmd + 8);
973 }
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200974
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100975 // Check for the old "nested" flag in legacy script.
976 if (STRNCMP(cmd, "nested", 6) == 0 && VIM_ISWHITE(cmd[6]))
977 {
978 if (in_vim9script())
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200979 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100980 // If there ever is a :nested command this error should
981 // be removed and "nested" accepted as the start of the
982 // command.
983 emsg(_(e_invalid_command_nested_did_you_mean_plusplus_nested));
984 return;
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200985 }
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +0100986 if (nested)
987 {
988 semsg(_(e_duplicate_argument_str), "nested");
989 return;
990 }
991 nested = TRUE;
992 cmd = skipwhite(cmd + 6);
Bram Moolenaareb93f3f2019-04-04 15:04:56 +0200993 }
Bram Moolenaar3e460fd2019-01-26 16:21:07 +0100994 }
995
996 /*
997 * Find the start of the commands.
998 * Expand <sfile> in it.
999 */
1000 if (*cmd != NUL)
1001 {
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +02001002 if (eap != NULL)
1003 // Read a {} block if it follows.
1004 cmd = may_get_cmd_block(eap, cmd, &tofree, &flags);
1005
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001006 cmd = expand_sfile(cmd);
1007 if (cmd == NULL) // some error
1008 return;
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +02001009 cmd_need_free = TRUE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001010 }
1011 }
1012
1013 /*
1014 * Print header when showing autocommands.
1015 */
1016 if (!forceit && *cmd == NUL)
1017 // Highlight title
1018 msg_puts_title(_("\n--- Autocommands ---"));
1019
1020 /*
1021 * Loop over the events.
1022 */
1023 last_event = (event_T)-1; // for listing the event name
1024 last_group = AUGROUP_ERROR; // for listing the group name
1025 if (*arg == '*' || *arg == NUL || *arg == '|')
1026 {
Bram Moolenaarb6db1462021-12-24 19:24:47 +00001027 if (*cmd != NUL)
Bram Moolenaar9a046fd2021-01-28 13:47:59 +01001028 emsg(_(e_cannot_define_autocommands_for_all_events));
1029 else
=?UTF-8?q?Dundar=20G=C3=B6c?=dfa5e462021-10-02 11:26:51 +01001030 for (event = (event_T)0; (int)event < NUM_EVENTS;
Bram Moolenaar9a046fd2021-01-28 13:47:59 +01001031 event = (event_T)((int)event + 1))
1032 if (do_autocmd_event(event, pat,
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +02001033 once, nested, cmd, forceit, group, flags) == FAIL)
Bram Moolenaar9a046fd2021-01-28 13:47:59 +01001034 break;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001035 }
1036 else
1037 {
1038 while (*arg && *arg != '|' && !VIM_ISWHITE(*arg))
1039 if (do_autocmd_event(event_name2nr(arg, &arg), pat,
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +02001040 once, nested, cmd, forceit, group, flags) == FAIL)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001041 break;
1042 }
1043
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +02001044 if (cmd_need_free)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001045 vim_free(cmd);
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +02001046 vim_free(tofree);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001047 vim_free(envpat);
1048}
1049
1050/*
1051 * Find the group ID in a ":autocmd" or ":doautocmd" argument.
1052 * The "argp" argument is advanced to the following argument.
1053 *
1054 * Returns the group ID, AUGROUP_ERROR for error (out of memory).
1055 */
1056 static int
1057au_get_grouparg(char_u **argp)
1058{
1059 char_u *group_name;
1060 char_u *p;
1061 char_u *arg = *argp;
1062 int group = AUGROUP_ALL;
1063
1064 for (p = arg; *p && !VIM_ISWHITE(*p) && *p != '|'; ++p)
1065 ;
Yegappan Lakshmanan1cfb14a2023-01-09 19:04:23 +00001066 if (p <= arg)
1067 return AUGROUP_ALL;
1068
1069 group_name = vim_strnsave(arg, p - arg);
1070 if (group_name == NULL) // out of memory
1071 return AUGROUP_ERROR;
1072 group = au_find_group(group_name);
1073 if (group == AUGROUP_ERROR)
1074 group = AUGROUP_ALL; // no match, use all groups
1075 else
1076 *argp = skipwhite(p); // match, skip over group name
1077 vim_free(group_name);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001078 return group;
1079}
1080
1081/*
1082 * do_autocmd() for one event.
1083 * If *pat == NUL do for all patterns.
1084 * If *cmd == NUL show entries.
1085 * If forceit == TRUE delete entries.
1086 * If group is not AUGROUP_ALL, only use this group.
1087 */
1088 static int
1089do_autocmd_event(
1090 event_T event,
1091 char_u *pat,
Bram Moolenaareb93f3f2019-04-04 15:04:56 +02001092 int once,
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001093 int nested,
1094 char_u *cmd,
1095 int forceit,
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +02001096 int group,
1097 int flags)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001098{
1099 AutoPat *ap;
1100 AutoPat **prev_ap;
1101 AutoCmd *ac;
1102 AutoCmd **prev_ac;
1103 int brace_level;
1104 char_u *endpat;
1105 int findgroup;
1106 int allgroups;
1107 int patlen;
1108 int is_buflocal;
1109 int buflocal_nr;
Bram Moolenaarc667da52019-11-30 20:52:27 +01001110 char_u buflocal_pat[25]; // for "<buffer=X>"
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001111
1112 if (group == AUGROUP_ALL)
1113 findgroup = current_augroup;
1114 else
1115 findgroup = group;
1116 allgroups = (group == AUGROUP_ALL && !forceit && *cmd == NUL);
1117
1118 /*
1119 * Show or delete all patterns for an event.
1120 */
1121 if (*pat == NUL)
1122 {
Bram Moolenaaraeea7212020-04-02 18:50:46 +02001123 FOR_ALL_AUTOCMD_PATTERNS(event, ap)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001124 {
1125 if (forceit) // delete the AutoPat, if it's in the current group
1126 {
1127 if (ap->group == findgroup)
1128 au_remove_pat(ap);
1129 }
1130 else if (group == AUGROUP_ALL || ap->group == group)
1131 show_autocmd(ap, event);
1132 }
1133 }
1134
1135 /*
1136 * Loop through all the specified patterns.
1137 */
1138 for ( ; *pat; pat = (*endpat == ',' ? endpat + 1 : endpat))
1139 {
1140 /*
1141 * Find end of the pattern.
1142 * Watch out for a comma in braces, like "*.\{obj,o\}".
1143 */
1144 brace_level = 0;
1145 for (endpat = pat; *endpat && (*endpat != ',' || brace_level
1146 || (endpat > pat && endpat[-1] == '\\')); ++endpat)
1147 {
1148 if (*endpat == '{')
1149 brace_level++;
1150 else if (*endpat == '}')
1151 brace_level--;
1152 }
1153 if (pat == endpat) // ignore single comma
1154 continue;
1155 patlen = (int)(endpat - pat);
1156
1157 /*
1158 * detect special <buflocal[=X]> buffer-local patterns
1159 */
1160 is_buflocal = FALSE;
1161 buflocal_nr = 0;
1162
1163 if (patlen >= 8 && STRNCMP(pat, "<buffer", 7) == 0
1164 && pat[patlen - 1] == '>')
1165 {
1166 // "<buffer...>": Error will be printed only for addition.
1167 // printing and removing will proceed silently.
1168 is_buflocal = TRUE;
1169 if (patlen == 8)
1170 // "<buffer>"
1171 buflocal_nr = curbuf->b_fnum;
1172 else if (patlen > 9 && pat[7] == '=')
1173 {
1174 if (patlen == 13 && STRNICMP(pat, "<buffer=abuf>", 13) == 0)
1175 // "<buffer=abuf>"
1176 buflocal_nr = autocmd_bufnr;
1177 else if (skipdigits(pat + 8) == pat + patlen - 1)
1178 // "<buffer=123>"
1179 buflocal_nr = atoi((char *)pat + 8);
1180 }
1181 }
1182
1183 if (is_buflocal)
1184 {
1185 // normalize pat into standard "<buffer>#N" form
1186 sprintf((char *)buflocal_pat, "<buffer=%d>", buflocal_nr);
1187 pat = buflocal_pat; // can modify pat and patlen
1188 patlen = (int)STRLEN(buflocal_pat); // but not endpat
1189 }
1190
1191 /*
1192 * Find AutoPat entries with this pattern. When adding a command it
1193 * always goes at or after the last one, so start at the end.
1194 */
1195 if (!forceit && *cmd != NUL && last_autopat[(int)event] != NULL)
1196 prev_ap = &last_autopat[(int)event];
1197 else
1198 prev_ap = &first_autopat[(int)event];
1199 while ((ap = *prev_ap) != NULL)
1200 {
1201 if (ap->pat != NULL)
1202 {
Bram Moolenaarc667da52019-11-30 20:52:27 +01001203 /*
1204 * Accept a pattern when:
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001205 * - a group was specified and it's that group, or a group was
1206 * not specified and it's the current group, or a group was
1207 * not specified and we are listing
1208 * - the length of the pattern matches
1209 * - the pattern matches.
1210 * For <buffer[=X]>, this condition works because we normalize
1211 * all buffer-local patterns.
1212 */
1213 if ((allgroups || ap->group == findgroup)
1214 && ap->patlen == patlen
1215 && STRNCMP(pat, ap->pat, patlen) == 0)
1216 {
1217 /*
1218 * Remove existing autocommands.
1219 * If adding any new autocmd's for this AutoPat, don't
1220 * delete the pattern from the autopat list, append to
1221 * this list.
1222 */
1223 if (forceit)
1224 {
1225 if (*cmd != NUL && ap->next == NULL)
1226 {
1227 au_remove_cmds(ap);
1228 break;
1229 }
1230 au_remove_pat(ap);
1231 }
1232
1233 /*
1234 * Show autocmd's for this autopat, or buflocals <buffer=X>
1235 */
1236 else if (*cmd == NUL)
1237 show_autocmd(ap, event);
1238
1239 /*
1240 * Add autocmd to this autopat, if it's the last one.
1241 */
1242 else if (ap->next == NULL)
1243 break;
1244 }
1245 }
1246 prev_ap = &ap->next;
1247 }
1248
1249 /*
1250 * Add a new command.
1251 */
1252 if (*cmd != NUL)
1253 {
1254 /*
1255 * If the pattern we want to add a command to does appear at the
1256 * end of the list (or not is not in the list at all), add the
1257 * pattern at the end of the list.
1258 */
1259 if (ap == NULL)
1260 {
Bram Moolenaarc667da52019-11-30 20:52:27 +01001261 // refuse to add buffer-local ap if buffer number is invalid
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001262 if (is_buflocal && (buflocal_nr == 0
1263 || buflist_findnr(buflocal_nr) == NULL))
1264 {
Bram Moolenaarf1474d82021-12-31 19:59:55 +00001265 semsg(_(e_buffer_nr_invalid_buffer_number), buflocal_nr);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001266 return FAIL;
1267 }
1268
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001269 ap = ALLOC_ONE(AutoPat);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001270 if (ap == NULL)
1271 return FAIL;
1272 ap->pat = vim_strnsave(pat, patlen);
1273 ap->patlen = patlen;
1274 if (ap->pat == NULL)
1275 {
1276 vim_free(ap);
1277 return FAIL;
1278 }
1279
=?UTF-8?q?Magnus=20Gro=C3=9F?=25def2c2021-10-22 18:56:39 +01001280#ifdef FEAT_EVAL
1281 // need to initialize last_mode for the first ModeChanged
1282 // autocmd
1283 if (event == EVENT_MODECHANGED && !has_modechanged())
LemonBoy2bf52dd2022-04-09 18:17:34 +01001284 get_mode(last_mode);
=?UTF-8?q?Magnus=20Gro=C3=9F?=25def2c2021-10-22 18:56:39 +01001285#endif
Bram Moolenaar35fc61c2022-11-22 12:40:50 +00001286 // Initialize the fields checked by the WinScrolled and
1287 // WinResized trigger to prevent them from firing right after
1288 // the first autocmd is defined.
1289 if ((event == EVENT_WINSCROLLED || event == EVENT_WINRESIZED)
1290 && !(has_winscrolled() || has_winresized()))
LemonBoy09371822022-04-08 15:18:45 +01001291 {
Bram Moolenaar29967732022-11-20 12:11:45 +00001292 tabpage_T *save_curtab = curtab;
1293 tabpage_T *tp;
1294 FOR_ALL_TABPAGES(tp)
1295 {
1296 unuse_tabpage(curtab);
1297 use_tabpage(tp);
1298 snapshot_windows_scroll_size();
1299 }
1300 unuse_tabpage(curtab);
1301 use_tabpage(save_curtab);
LemonBoy09371822022-04-08 15:18:45 +01001302 }
=?UTF-8?q?Magnus=20Gro=C3=9F?=25def2c2021-10-22 18:56:39 +01001303
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001304 if (is_buflocal)
1305 {
1306 ap->buflocal_nr = buflocal_nr;
1307 ap->reg_prog = NULL;
1308 }
1309 else
1310 {
1311 char_u *reg_pat;
1312
1313 ap->buflocal_nr = 0;
1314 reg_pat = file_pat_to_reg_pat(pat, endpat,
1315 &ap->allow_dirs, TRUE);
1316 if (reg_pat != NULL)
1317 ap->reg_prog = vim_regcomp(reg_pat, RE_MAGIC);
1318 vim_free(reg_pat);
1319 if (reg_pat == NULL || ap->reg_prog == NULL)
1320 {
1321 vim_free(ap->pat);
1322 vim_free(ap);
1323 return FAIL;
1324 }
1325 }
1326 ap->cmds = NULL;
1327 *prev_ap = ap;
1328 last_autopat[(int)event] = ap;
1329 ap->next = NULL;
1330 if (group == AUGROUP_ALL)
1331 ap->group = current_augroup;
1332 else
1333 ap->group = group;
1334 }
1335
1336 /*
1337 * Add the autocmd at the end of the AutoCmd list.
1338 */
1339 prev_ac = &(ap->cmds);
1340 while ((ac = *prev_ac) != NULL)
1341 prev_ac = &ac->next;
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001342 ac = ALLOC_ONE(AutoCmd);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001343 if (ac == NULL)
1344 return FAIL;
1345 ac->cmd = vim_strsave(cmd);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001346 ac->script_ctx = current_sctx;
Bram Moolenaar73b8b0a2021-08-01 14:52:32 +02001347 if (flags & UC_VIM9)
1348 ac->script_ctx.sc_version = SCRIPT_VERSION_VIM9;
Bram Moolenaar9b8d6222020-12-28 18:26:00 +01001349#ifdef FEAT_EVAL
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01001350 ac->script_ctx.sc_lnum += SOURCING_LNUM;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001351#endif
1352 if (ac->cmd == NULL)
1353 {
1354 vim_free(ac);
1355 return FAIL;
1356 }
1357 ac->next = NULL;
1358 *prev_ac = ac;
Bram Moolenaareb93f3f2019-04-04 15:04:56 +02001359 ac->once = once;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001360 ac->nested = nested;
1361 }
1362 }
1363
1364 au_cleanup(); // may really delete removed patterns/commands now
1365 return OK;
1366}
1367
1368/*
1369 * Implementation of ":doautocmd [group] event [fname]".
1370 * Return OK for success, FAIL for failure;
1371 */
1372 int
1373do_doautocmd(
Bram Moolenaar1b154ea2021-08-07 13:59:43 +02001374 char_u *arg_start,
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001375 int do_msg, // give message for no matching autocmds?
1376 int *did_something)
1377{
Bram Moolenaar1b154ea2021-08-07 13:59:43 +02001378 char_u *arg = arg_start;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001379 char_u *fname;
1380 int nothing_done = TRUE;
1381 int group;
1382
1383 if (did_something != NULL)
1384 *did_something = FALSE;
1385
1386 /*
1387 * Check for a legal group name. If not, use AUGROUP_ALL.
1388 */
1389 group = au_get_grouparg(&arg);
1390 if (arg == NULL) // out of memory
1391 return FAIL;
1392
1393 if (*arg == '*')
1394 {
Bram Moolenaar6d057012021-12-31 18:49:43 +00001395 emsg(_(e_cant_execute_autocommands_for_all_events));
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001396 return FAIL;
1397 }
1398
1399 /*
1400 * Scan over the events.
1401 * If we find an illegal name, return here, don't do anything.
1402 */
1403 fname = find_end_event(arg, group != AUGROUP_ALL);
1404 if (fname == NULL)
1405 return FAIL;
1406
1407 fname = skipwhite(fname);
1408
1409 /*
1410 * Loop over the events.
1411 */
1412 while (*arg && !ends_excmd(*arg) && !VIM_ISWHITE(*arg))
1413 if (apply_autocmds_group(event_name2nr(arg, &arg),
1414 fname, NULL, TRUE, group, curbuf, NULL))
1415 nothing_done = FALSE;
1416
Bram Moolenaar1b154ea2021-08-07 13:59:43 +02001417 if (nothing_done && do_msg
1418#ifdef FEAT_EVAL
1419 && !aborting()
1420#endif
1421 )
1422 smsg(_("No matching autocommands: %s"), arg_start);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001423 if (did_something != NULL)
1424 *did_something = !nothing_done;
1425
1426#ifdef FEAT_EVAL
1427 return aborting() ? FAIL : OK;
1428#else
1429 return OK;
1430#endif
1431}
1432
1433/*
1434 * ":doautoall": execute autocommands for each loaded buffer.
1435 */
1436 void
1437ex_doautoall(exarg_T *eap)
1438{
Bram Moolenaar41cd8032021-03-13 15:47:56 +01001439 int retval = OK;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001440 aco_save_T aco;
1441 buf_T *buf;
1442 bufref_T bufref;
1443 char_u *arg = eap->arg;
1444 int call_do_modelines = check_nomodeline(&arg);
1445 int did_aucmd;
1446
1447 /*
1448 * This is a bit tricky: For some commands curwin->w_buffer needs to be
1449 * equal to curbuf, but for some buffers there may not be a window.
1450 * So we change the buffer for the current window for a moment. This
1451 * gives problems when the autocommands make changes to the list of
1452 * buffers or windows...
1453 */
1454 FOR_ALL_BUFFERS(buf)
1455 {
Bram Moolenaar41cd8032021-03-13 15:47:56 +01001456 // Only do loaded buffers and skip the current buffer, it's done last.
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001457 if (buf->b_ml.ml_mfp == NULL || buf == curbuf)
1458 continue;
1459
Bram Moolenaare76062c2022-11-28 18:51:43 +00001460 // Find a window for this buffer and save some values.
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001461 aucmd_prepbuf(&aco, buf);
Bram Moolenaare76062c2022-11-28 18:51:43 +00001462 if (curbuf != buf)
1463 {
1464 // Failed to find a window for this buffer. Better not execute
1465 // autocommands then.
1466 retval = FAIL;
1467 break;
1468 }
1469
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001470 set_bufref(&bufref, buf);
1471
1472 // execute the autocommands for this buffer
1473 retval = do_doautocmd(arg, FALSE, &did_aucmd);
1474
1475 if (call_do_modelines && did_aucmd)
1476 // Execute the modeline settings, but don't set window-local
1477 // options if we are using the current window for another
1478 // buffer.
Bram Moolenaare76062c2022-11-28 18:51:43 +00001479 do_modelines(is_aucmd_win(curwin) ? OPT_NOWIN : 0);
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001480
1481 // restore the current window
1482 aucmd_restbuf(&aco);
1483
1484 // stop if there is some error or buffer was deleted
1485 if (retval == FAIL || !bufref_valid(&bufref))
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001486 {
Yegappan Lakshmanane9dcf132022-09-24 11:30:41 +01001487 retval = FAIL;
1488 break;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001489 }
1490 }
1491
Bram Moolenaar41cd8032021-03-13 15:47:56 +01001492 // Execute autocommands for the current buffer last.
1493 if (retval == OK)
1494 {
1495 do_doautocmd(arg, FALSE, &did_aucmd);
1496 if (call_do_modelines && did_aucmd)
1497 do_modelines(0);
1498 }
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001499}
1500
1501/*
1502 * Check *argp for <nomodeline>. When it is present return FALSE, otherwise
1503 * return TRUE and advance *argp to after it.
1504 * Thus return TRUE when do_modelines() should be called.
1505 */
1506 int
1507check_nomodeline(char_u **argp)
1508{
1509 if (STRNCMP(*argp, "<nomodeline>", 12) == 0)
1510 {
1511 *argp = skipwhite(*argp + 12);
1512 return FALSE;
1513 }
1514 return TRUE;
1515}
1516
1517/*
1518 * Prepare for executing autocommands for (hidden) buffer "buf".
1519 * Search for a visible window containing the current buffer. If there isn't
Bram Moolenaare76062c2022-11-28 18:51:43 +00001520 * one then use an entry in "aucmd_win[]".
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001521 * Set "curbuf" and "curwin" to match "buf".
Bram Moolenaare76062c2022-11-28 18:51:43 +00001522 * When this fails "curbuf" is not equal "buf".
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001523 */
1524 void
1525aucmd_prepbuf(
1526 aco_save_T *aco, // structure to save values in
1527 buf_T *buf) // new curbuf
1528{
1529 win_T *win;
1530 int save_ea;
1531#ifdef FEAT_AUTOCHDIR
1532 int save_acd;
1533#endif
1534
1535 // Find a window that is for the new buffer
1536 if (buf == curbuf) // be quick when buf is curbuf
1537 win = curwin;
1538 else
1539 FOR_ALL_WINDOWS(win)
1540 if (win->w_buffer == buf)
1541 break;
1542
Bram Moolenaare76062c2022-11-28 18:51:43 +00001543 // Allocate a window when needed.
1544 win_T *auc_win = NULL;
1545 int auc_idx = AUCMD_WIN_COUNT;
1546 if (win == NULL)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001547 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00001548 for (auc_idx = 0; auc_idx < AUCMD_WIN_COUNT; ++auc_idx)
1549 if (!aucmd_win[auc_idx].auc_win_used)
1550 {
Bram Moolenaar84497cd2022-11-28 20:34:52 +00001551 if (aucmd_win[auc_idx].auc_win == NULL)
1552 aucmd_win[auc_idx].auc_win = win_alloc_popup_win();
1553 auc_win = aucmd_win[auc_idx].auc_win;
Bram Moolenaare76062c2022-11-28 18:51:43 +00001554 if (auc_win != NULL)
Bram Moolenaare76062c2022-11-28 18:51:43 +00001555 aucmd_win[auc_idx].auc_win_used = TRUE;
Bram Moolenaare76062c2022-11-28 18:51:43 +00001556 break;
1557 }
1558
1559 // If this fails (out of memory or using all AUCMD_WIN_COUNT
1560 // entries) then we can't reliable execute the autocmd, return with
1561 // "curbuf" unequal "buf".
1562 if (auc_win == NULL)
1563 return;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001564 }
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001565
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001566 aco->save_curwin_id = curwin->w_id;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001567 aco->save_curbuf = curbuf;
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001568 aco->save_prevwin_id = prevwin == NULL ? 0 : prevwin->w_id;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001569 if (win != NULL)
1570 {
1571 // There is a window for "buf" in the current tab page, make it the
1572 // curwin. This is preferred, it has the least side effects (esp. if
1573 // "buf" is curbuf).
Bram Moolenaare76062c2022-11-28 18:51:43 +00001574 aco->use_aucmd_win_idx = -1;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001575 curwin = win;
1576 }
1577 else
1578 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00001579 // There is no window for "buf", use "auc_win". To minimize the side
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001580 // effects, insert it in the current tab page.
1581 // Anything related to a window (e.g., setting folds) may have
1582 // unexpected results.
Bram Moolenaare76062c2022-11-28 18:51:43 +00001583 aco->use_aucmd_win_idx = auc_idx;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001584
Bram Moolenaare76062c2022-11-28 18:51:43 +00001585 win_init_popup_win(auc_win, buf);
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001586
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001587 aco->globaldir = globaldir;
1588 globaldir = NULL;
1589
Bram Moolenaare76062c2022-11-28 18:51:43 +00001590 // Split the current window, put the auc_win in the upper half.
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001591 // We don't want the BufEnter or WinEnter autocommands.
1592 block_autocmds();
1593 make_snapshot(SNAP_AUCMD_IDX);
1594 save_ea = p_ea;
1595 p_ea = FALSE;
1596
1597#ifdef FEAT_AUTOCHDIR
1598 // Prevent chdir() call in win_enter_ext(), through do_autochdir().
1599 save_acd = p_acd;
1600 p_acd = FALSE;
1601#endif
1602
Bram Moolenaardff97e62022-01-24 20:00:55 +00001603 // no redrawing and don't set the window title
1604 ++RedrawingDisabled;
Bram Moolenaare76062c2022-11-28 18:51:43 +00001605 (void)win_split_ins(0, WSP_TOP, auc_win, 0);
Bram Moolenaardff97e62022-01-24 20:00:55 +00001606 --RedrawingDisabled;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001607 (void)win_comp_pos(); // recompute window positions
1608 p_ea = save_ea;
1609#ifdef FEAT_AUTOCHDIR
1610 p_acd = save_acd;
1611#endif
1612 unblock_autocmds();
Bram Moolenaare76062c2022-11-28 18:51:43 +00001613 curwin = auc_win;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001614 }
1615 curbuf = buf;
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001616 aco->new_curwin_id = curwin->w_id;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001617 set_bufref(&aco->new_curbuf, curbuf);
Bram Moolenaarcb1956d2022-01-07 15:45:18 +00001618
1619 // disable the Visual area, the position may be invalid in another buffer
1620 aco->save_VIsual_active = VIsual_active;
1621 VIsual_active = FALSE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001622}
1623
1624/*
1625 * Cleanup after executing autocommands for a (hidden) buffer.
1626 * Restore the window as it was (if possible).
1627 */
1628 void
1629aucmd_restbuf(
1630 aco_save_T *aco) // structure holding saved values
1631{
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001632 int dummy;
1633 win_T *save_curwin;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001634
Bram Moolenaare76062c2022-11-28 18:51:43 +00001635 if (aco->use_aucmd_win_idx >= 0)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001636 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00001637 win_T *awp = aucmd_win[aco->use_aucmd_win_idx].auc_win;
1638
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001639 --curbuf->b_nwindows;
Bram Moolenaare76062c2022-11-28 18:51:43 +00001640 // Find "awp", it can't be closed, but it may be in another tab
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001641 // page. Do not trigger autocommands here.
1642 block_autocmds();
Bram Moolenaare76062c2022-11-28 18:51:43 +00001643 if (curwin != awp)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001644 {
1645 tabpage_T *tp;
1646 win_T *wp;
1647
1648 FOR_ALL_TAB_WINDOWS(tp, wp)
1649 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00001650 if (wp == awp)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001651 {
1652 if (tp != curtab)
1653 goto_tabpage_tp(tp, TRUE, TRUE);
Bram Moolenaare76062c2022-11-28 18:51:43 +00001654 win_goto(awp);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001655 goto win_found;
1656 }
1657 }
1658 }
1659win_found:
1660
1661 // Remove the window and frame from the tree of frames.
1662 (void)winframe_remove(curwin, &dummy, NULL);
1663 win_remove(curwin, NULL);
Bram Moolenaar84497cd2022-11-28 20:34:52 +00001664
1665 // The window is marked as not used, but it is not freed, it can be
1666 // used again.
Bram Moolenaare76062c2022-11-28 18:51:43 +00001667 aucmd_win[aco->use_aucmd_win_idx].auc_win_used = FALSE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001668 last_status(FALSE); // may need to remove last status line
1669
1670 if (!valid_tabpage_win(curtab))
1671 // no valid window in current tabpage
1672 close_tabpage(curtab);
1673
1674 restore_snapshot(SNAP_AUCMD_IDX, FALSE);
1675 (void)win_comp_pos(); // recompute window positions
1676 unblock_autocmds();
1677
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001678 save_curwin = win_find_by_id(aco->save_curwin_id);
1679 if (save_curwin != NULL)
1680 curwin = save_curwin;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001681 else
1682 // Hmm, original window disappeared. Just use the first one.
1683 curwin = firstwin;
Bram Moolenaarbdf931c2020-10-01 22:37:40 +02001684 curbuf = curwin->w_buffer;
1685#ifdef FEAT_JOB_CHANNEL
1686 // May need to restore insert mode for a prompt buffer.
1687 entering_window(curwin);
1688#endif
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001689 prevwin = win_find_by_id(aco->save_prevwin_id);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001690#ifdef FEAT_EVAL
Bram Moolenaare76062c2022-11-28 18:51:43 +00001691 vars_clear(&awp->w_vars->dv_hashtab); // free all w: variables
1692 hash_init(&awp->w_vars->dv_hashtab); // re-use the hashtab
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001693#endif
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001694 vim_free(globaldir);
1695 globaldir = aco->globaldir;
1696
1697 // the buffer contents may have changed
zeertzjq49f05242023-02-04 10:58:34 +00001698 VIsual_active = aco->save_VIsual_active;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001699 check_cursor();
1700 if (curwin->w_topline > curbuf->b_ml.ml_line_count)
1701 {
1702 curwin->w_topline = curbuf->b_ml.ml_line_count;
1703#ifdef FEAT_DIFF
1704 curwin->w_topfill = 0;
1705#endif
1706 }
1707#if defined(FEAT_GUI)
Bram Moolenaard2ff7052021-12-17 16:00:04 +00001708 if (gui.in_use)
1709 {
Bram Moolenaare76062c2022-11-28 18:51:43 +00001710 // Hide the scrollbars from the "awp" and update.
1711 gui_mch_enable_scrollbar(&awp->w_scrollbars[SBAR_LEFT], FALSE);
1712 gui_mch_enable_scrollbar(&awp->w_scrollbars[SBAR_RIGHT], FALSE);
Bram Moolenaard2ff7052021-12-17 16:00:04 +00001713 gui_may_update_scrollbars();
1714 }
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001715#endif
1716 }
1717 else
1718 {
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001719 // Restore curwin. Use the window ID, a window may have been closed
1720 // and the memory re-used for another one.
1721 save_curwin = win_find_by_id(aco->save_curwin_id);
1722 if (save_curwin != NULL)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001723 {
1724 // Restore the buffer which was previously edited by curwin, if
1725 // it was changed, we are still the same window and the buffer is
1726 // valid.
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001727 if (curwin->w_id == aco->new_curwin_id
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001728 && curbuf != aco->new_curbuf.br_buf
1729 && bufref_valid(&aco->new_curbuf)
1730 && aco->new_curbuf.br_buf->b_ml.ml_mfp != NULL)
1731 {
1732# if defined(FEAT_SYN_HL) || defined(FEAT_SPELL)
1733 if (curwin->w_s == &curbuf->b_s)
1734 curwin->w_s = &aco->new_curbuf.br_buf->b_s;
1735# endif
1736 --curbuf->b_nwindows;
1737 curbuf = aco->new_curbuf.br_buf;
1738 curwin->w_buffer = curbuf;
1739 ++curbuf->b_nwindows;
1740 }
1741
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001742 curwin = save_curwin;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001743 curbuf = curwin->w_buffer;
Bram Moolenaarcbcd9cb2020-11-07 16:58:59 +01001744 prevwin = win_find_by_id(aco->save_prevwin_id);
zeertzjq49f05242023-02-04 10:58:34 +00001745
Bram Moolenaar32aa1022019-11-02 22:54:41 +01001746 // In case the autocommand moves the cursor to a position that
1747 // does not exist in curbuf.
zeertzjq49f05242023-02-04 10:58:34 +00001748 VIsual_active = aco->save_VIsual_active;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001749 check_cursor();
1750 }
1751 }
Bram Moolenaarcb1956d2022-01-07 15:45:18 +00001752
Bram Moolenaarcb1956d2022-01-07 15:45:18 +00001753 VIsual_active = aco->save_VIsual_active;
zeertzjq49f05242023-02-04 10:58:34 +00001754 check_cursor(); // just in case lines got deleted
Bram Moolenaarcb1956d2022-01-07 15:45:18 +00001755 if (VIsual_active)
1756 check_pos(curbuf, &VIsual);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001757}
1758
1759static int autocmd_nested = FALSE;
1760
1761/*
1762 * Execute autocommands for "event" and file name "fname".
1763 * Return TRUE if some commands were executed.
1764 */
1765 int
1766apply_autocmds(
1767 event_T event,
1768 char_u *fname, // NULL or empty means use actual file name
1769 char_u *fname_io, // fname to use for <afile> on cmdline
1770 int force, // when TRUE, ignore autocmd_busy
1771 buf_T *buf) // buffer for <abuf>
1772{
1773 return apply_autocmds_group(event, fname, fname_io, force,
1774 AUGROUP_ALL, buf, NULL);
1775}
1776
1777/*
1778 * Like apply_autocmds(), but with extra "eap" argument. This takes care of
1779 * setting v:filearg.
1780 */
1781 int
1782apply_autocmds_exarg(
1783 event_T event,
1784 char_u *fname,
1785 char_u *fname_io,
1786 int force,
1787 buf_T *buf,
1788 exarg_T *eap)
1789{
1790 return apply_autocmds_group(event, fname, fname_io, force,
1791 AUGROUP_ALL, buf, eap);
1792}
1793
1794/*
1795 * Like apply_autocmds(), but handles the caller's retval. If the script
1796 * processing is being aborted or if retval is FAIL when inside a try
1797 * conditional, no autocommands are executed. If otherwise the autocommands
1798 * cause the script to be aborted, retval is set to FAIL.
1799 */
1800 int
1801apply_autocmds_retval(
1802 event_T event,
1803 char_u *fname, // NULL or empty means use actual file name
1804 char_u *fname_io, // fname to use for <afile> on cmdline
1805 int force, // when TRUE, ignore autocmd_busy
1806 buf_T *buf, // buffer for <abuf>
1807 int *retval) // pointer to caller's retval
1808{
1809 int did_cmd;
1810
1811#ifdef FEAT_EVAL
1812 if (should_abort(*retval))
1813 return FALSE;
1814#endif
1815
1816 did_cmd = apply_autocmds_group(event, fname, fname_io, force,
1817 AUGROUP_ALL, buf, NULL);
1818 if (did_cmd
1819#ifdef FEAT_EVAL
1820 && aborting()
1821#endif
1822 )
1823 *retval = FAIL;
1824 return did_cmd;
1825}
1826
1827/*
1828 * Return TRUE when there is a CursorHold autocommand defined.
1829 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +02001830 static int
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001831has_cursorhold(void)
1832{
Bram Moolenaar24959102022-05-07 20:01:16 +01001833 return (first_autopat[(int)(get_real_state() == MODE_NORMAL_BUSY
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001834 ? EVENT_CURSORHOLD : EVENT_CURSORHOLDI)] != NULL);
1835}
1836
1837/*
1838 * Return TRUE if the CursorHold event can be triggered.
1839 */
1840 int
1841trigger_cursorhold(void)
1842{
1843 int state;
1844
1845 if (!did_cursorhold
1846 && has_cursorhold()
1847 && reg_recording == 0
1848 && typebuf.tb_len == 0
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001849 && !ins_compl_active())
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001850 {
1851 state = get_real_state();
Bram Moolenaar24959102022-05-07 20:01:16 +01001852 if (state == MODE_NORMAL_BUSY || (state & MODE_INSERT) != 0)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001853 return TRUE;
1854 }
1855 return FALSE;
1856}
1857
1858/*
Bram Moolenaar35fc61c2022-11-22 12:40:50 +00001859 * Return TRUE when there is a WinResized autocommand defined.
1860 */
1861 int
1862has_winresized(void)
1863{
1864 return (first_autopat[(int)EVENT_WINRESIZED] != NULL);
1865}
1866
1867/*
LemonBoy09371822022-04-08 15:18:45 +01001868 * Return TRUE when there is a WinScrolled autocommand defined.
1869 */
1870 int
1871has_winscrolled(void)
1872{
1873 return (first_autopat[(int)EVENT_WINSCROLLED] != NULL);
1874}
1875
1876/*
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001877 * Return TRUE when there is a CursorMoved autocommand defined.
1878 */
1879 int
1880has_cursormoved(void)
1881{
1882 return (first_autopat[(int)EVENT_CURSORMOVED] != NULL);
1883}
1884
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001885/*
1886 * Return TRUE when there is a CursorMovedI autocommand defined.
1887 */
1888 int
1889has_cursormovedI(void)
1890{
1891 return (first_autopat[(int)EVENT_CURSORMOVEDI] != NULL);
1892}
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001893
1894/*
1895 * Return TRUE when there is a TextChanged autocommand defined.
1896 */
1897 int
1898has_textchanged(void)
1899{
1900 return (first_autopat[(int)EVENT_TEXTCHANGED] != NULL);
1901}
1902
1903/*
1904 * Return TRUE when there is a TextChangedI autocommand defined.
1905 */
1906 int
1907has_textchangedI(void)
1908{
1909 return (first_autopat[(int)EVENT_TEXTCHANGEDI] != NULL);
1910}
1911
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001912/*
1913 * Return TRUE when there is a TextChangedP autocommand defined.
1914 */
1915 int
1916has_textchangedP(void)
1917{
1918 return (first_autopat[(int)EVENT_TEXTCHANGEDP] != NULL);
1919}
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001920
1921/*
1922 * Return TRUE when there is an InsertCharPre autocommand defined.
1923 */
1924 int
1925has_insertcharpre(void)
1926{
1927 return (first_autopat[(int)EVENT_INSERTCHARPRE] != NULL);
1928}
1929
1930/*
1931 * Return TRUE when there is an CmdUndefined autocommand defined.
1932 */
1933 int
1934has_cmdundefined(void)
1935{
1936 return (first_autopat[(int)EVENT_CMDUNDEFINED] != NULL);
1937}
1938
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001939#if defined(FEAT_EVAL) || defined(PROTO)
1940/*
1941 * Return TRUE when there is a TextYankPost autocommand defined.
1942 */
1943 int
1944has_textyankpost(void)
1945{
1946 return (first_autopat[(int)EVENT_TEXTYANKPOST] != NULL);
1947}
1948#endif
1949
Bram Moolenaard7f246c2019-04-08 18:15:41 +02001950#if defined(FEAT_EVAL) || defined(PROTO)
1951/*
1952 * Return TRUE when there is a CompleteChanged autocommand defined.
1953 */
1954 int
1955has_completechanged(void)
1956{
1957 return (first_autopat[(int)EVENT_COMPLETECHANGED] != NULL);
1958}
1959#endif
1960
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02001961#if defined(FEAT_EVAL) || defined(PROTO)
1962/*
1963 * Return TRUE when there is a ModeChanged autocommand defined.
1964 */
1965 int
1966has_modechanged(void)
1967{
1968 return (first_autopat[(int)EVENT_MODECHANGED] != NULL);
1969}
1970#endif
1971
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001972/*
1973 * Execute autocommands for "event" and file name "fname".
1974 * Return TRUE if some commands were executed.
1975 */
1976 static int
1977apply_autocmds_group(
1978 event_T event,
1979 char_u *fname, // NULL or empty means use actual file name
1980 char_u *fname_io, // fname to use for <afile> on cmdline, NULL means
1981 // use fname
1982 int force, // when TRUE, ignore autocmd_busy
1983 int group, // group ID, or AUGROUP_ALL
1984 buf_T *buf, // buffer for <abuf>
1985 exarg_T *eap UNUSED) // command arguments
1986{
1987 char_u *sfname = NULL; // short file name
1988 char_u *tail;
1989 int save_changed;
1990 buf_T *old_curbuf;
1991 int retval = FALSE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01001992 char_u *save_autocmd_fname;
1993 int save_autocmd_fname_full;
1994 int save_autocmd_bufnr;
1995 char_u *save_autocmd_match;
1996 int save_autocmd_busy;
1997 int save_autocmd_nested;
1998 static int nesting = 0;
LemonBoyeca7c602022-04-14 15:39:43 +01001999 AutoPatCmd_T patcmd;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002000 AutoPat *ap;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002001 sctx_T save_current_sctx;
Bram Moolenaar9b8d6222020-12-28 18:26:00 +01002002#ifdef FEAT_EVAL
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002003 funccal_entry_T funccal_entry;
2004 char_u *save_cmdarg;
2005 long save_cmdbang;
2006#endif
2007 static int filechangeshell_busy = FALSE;
2008#ifdef FEAT_PROFILE
2009 proftime_T wait_time;
2010#endif
2011 int did_save_redobuff = FALSE;
2012 save_redo_T save_redo;
2013 int save_KeyTyped = KeyTyped;
ichizokc3f91c02021-12-17 09:44:33 +00002014 int save_did_emsg;
Bram Moolenaare31ee862020-01-07 20:59:34 +01002015 ESTACK_CHECK_DECLARATION
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002016
2017 /*
2018 * Quickly return if there are no autocommands for this event or
2019 * autocommands are blocked.
2020 */
2021 if (event == NUM_EVENTS || first_autopat[(int)event] == NULL
2022 || autocmd_blocked > 0)
2023 goto BYPASS_AU;
2024
2025 /*
2026 * When autocommands are busy, new autocommands are only executed when
2027 * explicitly enabled with the "nested" flag.
2028 */
2029 if (autocmd_busy && !(force || autocmd_nested))
2030 goto BYPASS_AU;
2031
2032#ifdef FEAT_EVAL
2033 /*
2034 * Quickly return when immediately aborting on error, or when an interrupt
2035 * occurred or an exception was thrown but not caught.
2036 */
2037 if (aborting())
2038 goto BYPASS_AU;
2039#endif
2040
2041 /*
2042 * FileChangedShell never nests, because it can create an endless loop.
2043 */
2044 if (filechangeshell_busy && (event == EVENT_FILECHANGEDSHELL
2045 || event == EVENT_FILECHANGEDSHELLPOST))
2046 goto BYPASS_AU;
2047
2048 /*
2049 * Ignore events in 'eventignore'.
2050 */
2051 if (event_ignored(event))
2052 goto BYPASS_AU;
2053
2054 /*
2055 * Allow nesting of autocommands, but restrict the depth, because it's
2056 * possible to create an endless loop.
2057 */
2058 if (nesting == 10)
2059 {
Bram Moolenaar6d057012021-12-31 18:49:43 +00002060 emsg(_(e_autocommand_nesting_too_deep));
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002061 goto BYPASS_AU;
2062 }
2063
2064 /*
2065 * Check if these autocommands are disabled. Used when doing ":all" or
2066 * ":ball".
2067 */
2068 if ( (autocmd_no_enter
2069 && (event == EVENT_WINENTER || event == EVENT_BUFENTER))
2070 || (autocmd_no_leave
2071 && (event == EVENT_WINLEAVE || event == EVENT_BUFLEAVE)))
2072 goto BYPASS_AU;
2073
Bram Moolenaarbb393d82022-12-09 12:21:50 +00002074 if (event == EVENT_CMDLINECHANGED)
2075 ++aucmd_cmdline_changed_count;
2076
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002077 /*
2078 * Save the autocmd_* variables and info about the current buffer.
2079 */
2080 save_autocmd_fname = autocmd_fname;
2081 save_autocmd_fname_full = autocmd_fname_full;
2082 save_autocmd_bufnr = autocmd_bufnr;
2083 save_autocmd_match = autocmd_match;
2084 save_autocmd_busy = autocmd_busy;
2085 save_autocmd_nested = autocmd_nested;
2086 save_changed = curbuf->b_changed;
2087 old_curbuf = curbuf;
2088
2089 /*
2090 * Set the file name to be used for <afile>.
2091 * Make a copy to avoid that changing a buffer name or directory makes it
2092 * invalid.
2093 */
2094 if (fname_io == NULL)
2095 {
2096 if (event == EVENT_COLORSCHEME || event == EVENT_COLORSCHEMEPRE
Bram Moolenaarbb393d82022-12-09 12:21:50 +00002097 || event == EVENT_OPTIONSET
2098 || event == EVENT_MODECHANGED)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002099 autocmd_fname = NULL;
2100 else if (fname != NULL && !ends_excmd(*fname))
2101 autocmd_fname = fname;
2102 else if (buf != NULL)
2103 autocmd_fname = buf->b_ffname;
2104 else
2105 autocmd_fname = NULL;
2106 }
2107 else
2108 autocmd_fname = fname_io;
2109 if (autocmd_fname != NULL)
2110 autocmd_fname = vim_strsave(autocmd_fname);
2111 autocmd_fname_full = FALSE; // call FullName_save() later
2112
2113 /*
2114 * Set the buffer number to be used for <abuf>.
2115 */
2116 if (buf == NULL)
2117 autocmd_bufnr = 0;
2118 else
2119 autocmd_bufnr = buf->b_fnum;
2120
2121 /*
2122 * When the file name is NULL or empty, use the file name of buffer "buf".
2123 * Always use the full path of the file name to match with, in case
2124 * "allow_dirs" is set.
2125 */
2126 if (fname == NULL || *fname == NUL)
2127 {
2128 if (buf == NULL)
2129 fname = NULL;
2130 else
2131 {
2132#ifdef FEAT_SYN_HL
2133 if (event == EVENT_SYNTAX)
2134 fname = buf->b_p_syn;
2135 else
2136#endif
2137 if (event == EVENT_FILETYPE)
2138 fname = buf->b_p_ft;
2139 else
2140 {
2141 if (buf->b_sfname != NULL)
2142 sfname = vim_strsave(buf->b_sfname);
2143 fname = buf->b_ffname;
2144 }
2145 }
2146 if (fname == NULL)
2147 fname = (char_u *)"";
2148 fname = vim_strsave(fname); // make a copy, so we can change it
2149 }
2150 else
2151 {
2152 sfname = vim_strsave(fname);
2153 // Don't try expanding FileType, Syntax, FuncUndefined, WindowID,
Bram Moolenaarf6246f52022-02-11 16:30:12 +00002154 // ColorScheme, QuickFixCmd*, DirChanged and similar.
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002155 if (event == EVENT_FILETYPE
2156 || event == EVENT_SYNTAX
2157 || event == EVENT_CMDLINECHANGED
2158 || event == EVENT_CMDLINEENTER
2159 || event == EVENT_CMDLINELEAVE
2160 || event == EVENT_CMDWINENTER
2161 || event == EVENT_CMDWINLEAVE
2162 || event == EVENT_CMDUNDEFINED
2163 || event == EVENT_FUNCUNDEFINED
2164 || event == EVENT_REMOTEREPLY
2165 || event == EVENT_SPELLFILEMISSING
2166 || event == EVENT_QUICKFIXCMDPRE
2167 || event == EVENT_COLORSCHEME
2168 || event == EVENT_COLORSCHEMEPRE
2169 || event == EVENT_OPTIONSET
2170 || event == EVENT_QUICKFIXCMDPOST
=?UTF-8?q?Magnus=20Gro=C3=9F?=f1e88762021-09-12 13:39:55 +02002171 || event == EVENT_DIRCHANGED
Bram Moolenaarf6246f52022-02-11 16:30:12 +00002172 || event == EVENT_DIRCHANGEDPRE
naohiro ono23beefe2021-11-13 12:38:49 +00002173 || event == EVENT_MODECHANGED
zeertzjqc601d982022-10-10 13:46:15 +01002174 || event == EVENT_MENUPOPUP
Bram Moolenaarf6246f52022-02-11 16:30:12 +00002175 || event == EVENT_USER
LemonBoy09371822022-04-08 15:18:45 +01002176 || event == EVENT_WINCLOSED
Bram Moolenaar35fc61c2022-11-22 12:40:50 +00002177 || event == EVENT_WINRESIZED
LemonBoy09371822022-04-08 15:18:45 +01002178 || event == EVENT_WINSCROLLED)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002179 {
2180 fname = vim_strsave(fname);
2181 autocmd_fname_full = TRUE; // don't expand it later
2182 }
2183 else
2184 fname = FullName_save(fname, FALSE);
2185 }
2186 if (fname == NULL) // out of memory
2187 {
2188 vim_free(sfname);
2189 retval = FALSE;
2190 goto BYPASS_AU;
2191 }
2192
2193#ifdef BACKSLASH_IN_FILENAME
2194 /*
2195 * Replace all backslashes with forward slashes. This makes the
2196 * autocommand patterns portable between Unix and MS-DOS.
2197 */
2198 if (sfname != NULL)
2199 forward_slash(sfname);
2200 forward_slash(fname);
2201#endif
2202
2203#ifdef VMS
2204 // remove version for correct match
2205 if (sfname != NULL)
2206 vms_remove_version(sfname);
2207 vms_remove_version(fname);
2208#endif
2209
2210 /*
2211 * Set the name to be used for <amatch>.
2212 */
2213 autocmd_match = fname;
2214
2215
2216 // Don't redraw while doing autocommands.
2217 ++RedrawingDisabled;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002218
2219 // name and lnum are filled in later
2220 estack_push(ETYPE_AUCMD, NULL, 0);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002221 ESTACK_CHECK_SETUP
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002222
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002223 save_current_sctx = current_sctx;
2224
Bram Moolenaar9b8d6222020-12-28 18:26:00 +01002225#ifdef FEAT_EVAL
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002226# ifdef FEAT_PROFILE
2227 if (do_profiling == PROF_YES)
2228 prof_child_enter(&wait_time); // doesn't count for the caller itself
2229# endif
2230
2231 // Don't use local function variables, if called from a function.
2232 save_funccal(&funccal_entry);
2233#endif
2234
2235 /*
2236 * When starting to execute autocommands, save the search patterns.
2237 */
2238 if (!autocmd_busy)
2239 {
2240 save_search_patterns();
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002241 if (!ins_compl_active())
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002242 {
2243 saveRedobuff(&save_redo);
2244 did_save_redobuff = TRUE;
2245 }
2246 did_filetype = keep_filetype;
2247 }
2248
2249 /*
2250 * Note that we are applying autocmds. Some commands need to know.
2251 */
2252 autocmd_busy = TRUE;
2253 filechangeshell_busy = (event == EVENT_FILECHANGEDSHELL);
2254 ++nesting; // see matching decrement below
2255
2256 // Remember that FileType was triggered. Used for did_filetype().
2257 if (event == EVENT_FILETYPE)
2258 did_filetype = TRUE;
2259
2260 tail = gettail(fname);
2261
2262 // Find first autocommand that matches
LemonBoyeca7c602022-04-14 15:39:43 +01002263 CLEAR_FIELD(patcmd);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002264 patcmd.curpat = first_autopat[(int)event];
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002265 patcmd.group = group;
2266 patcmd.fname = fname;
2267 patcmd.sfname = sfname;
2268 patcmd.tail = tail;
2269 patcmd.event = event;
2270 patcmd.arg_bufnr = autocmd_bufnr;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002271 auto_next_pat(&patcmd, FALSE);
2272
2273 // found one, start executing the autocommands
2274 if (patcmd.curpat != NULL)
2275 {
2276 // add to active_apc_list
2277 patcmd.next = active_apc_list;
2278 active_apc_list = &patcmd;
2279
2280#ifdef FEAT_EVAL
2281 // set v:cmdarg (only when there is a matching pattern)
2282 save_cmdbang = (long)get_vim_var_nr(VV_CMDBANG);
2283 if (eap != NULL)
2284 {
2285 save_cmdarg = set_cmdarg(eap, NULL);
2286 set_vim_var_nr(VV_CMDBANG, (long)eap->forceit);
2287 }
2288 else
2289 save_cmdarg = NULL; // avoid gcc warning
2290#endif
2291 retval = TRUE;
2292 // mark the last pattern, to avoid an endless loop when more patterns
2293 // are added when executing autocommands
2294 for (ap = patcmd.curpat; ap->next != NULL; ap = ap->next)
2295 ap->last = FALSE;
2296 ap->last = TRUE;
Bram Moolenaara68e5952019-04-25 22:22:01 +02002297
Bram Moolenaar5fa9f232022-07-23 09:06:48 +01002298 // Make sure cursor and topline are valid. The first time the current
2299 // values are saved, restored by reset_lnums(). When nested only the
2300 // values are corrected when needed.
Bram Moolenaar1e6bbfb2021-04-03 13:19:26 +02002301 if (nesting == 1)
Bram Moolenaar1e6bbfb2021-04-03 13:19:26 +02002302 check_lnums(TRUE);
Bram Moolenaar5fa9f232022-07-23 09:06:48 +01002303 else
2304 check_lnums_nested(TRUE);
Bram Moolenaara68e5952019-04-25 22:22:01 +02002305
ichizokc3f91c02021-12-17 09:44:33 +00002306 save_did_emsg = did_emsg;
2307
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002308 do_cmdline(NULL, getnextac, (void *)&patcmd,
2309 DOCMD_NOWAIT|DOCMD_VERBOSE|DOCMD_REPEAT);
Bram Moolenaara68e5952019-04-25 22:22:01 +02002310
ichizokc3f91c02021-12-17 09:44:33 +00002311 did_emsg += save_did_emsg;
2312
Bram Moolenaar1e6bbfb2021-04-03 13:19:26 +02002313 if (nesting == 1)
2314 // restore cursor and topline, unless they were changed
2315 reset_lnums();
Bram Moolenaara68e5952019-04-25 22:22:01 +02002316
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002317#ifdef FEAT_EVAL
2318 if (eap != NULL)
2319 {
2320 (void)set_cmdarg(NULL, save_cmdarg);
2321 set_vim_var_nr(VV_CMDBANG, save_cmdbang);
2322 }
2323#endif
2324 // delete from active_apc_list
2325 if (active_apc_list == &patcmd) // just in case
2326 active_apc_list = patcmd.next;
2327 }
2328
2329 --RedrawingDisabled;
2330 autocmd_busy = save_autocmd_busy;
2331 filechangeshell_busy = FALSE;
2332 autocmd_nested = save_autocmd_nested;
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002333 vim_free(SOURCING_NAME);
Bram Moolenaare31ee862020-01-07 20:59:34 +01002334 ESTACK_CHECK_NOW
Bram Moolenaar1a47ae32019-12-29 23:04:25 +01002335 estack_pop();
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002336 vim_free(autocmd_fname);
2337 autocmd_fname = save_autocmd_fname;
2338 autocmd_fname_full = save_autocmd_fname_full;
2339 autocmd_bufnr = save_autocmd_bufnr;
2340 autocmd_match = save_autocmd_match;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002341 current_sctx = save_current_sctx;
Bram Moolenaar9b8d6222020-12-28 18:26:00 +01002342#ifdef FEAT_EVAL
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002343 restore_funccal();
2344# ifdef FEAT_PROFILE
2345 if (do_profiling == PROF_YES)
2346 prof_child_exit(&wait_time);
2347# endif
2348#endif
2349 KeyTyped = save_KeyTyped;
2350 vim_free(fname);
2351 vim_free(sfname);
2352 --nesting; // see matching increment above
2353
2354 /*
2355 * When stopping to execute autocommands, restore the search patterns and
2356 * the redo buffer. Free any buffers in the au_pending_free_buf list and
2357 * free any windows in the au_pending_free_win list.
2358 */
2359 if (!autocmd_busy)
2360 {
2361 restore_search_patterns();
2362 if (did_save_redobuff)
2363 restoreRedobuff(&save_redo);
2364 did_filetype = FALSE;
2365 while (au_pending_free_buf != NULL)
2366 {
2367 buf_T *b = au_pending_free_buf->b_next;
Bram Moolenaar41cd8032021-03-13 15:47:56 +01002368
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002369 vim_free(au_pending_free_buf);
2370 au_pending_free_buf = b;
2371 }
2372 while (au_pending_free_win != NULL)
2373 {
2374 win_T *w = au_pending_free_win->w_next;
Bram Moolenaar41cd8032021-03-13 15:47:56 +01002375
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002376 vim_free(au_pending_free_win);
2377 au_pending_free_win = w;
2378 }
2379 }
2380
2381 /*
2382 * Some events don't set or reset the Changed flag.
2383 * Check if still in the same buffer!
2384 */
2385 if (curbuf == old_curbuf
2386 && (event == EVENT_BUFREADPOST
2387 || event == EVENT_BUFWRITEPOST
2388 || event == EVENT_FILEAPPENDPOST
2389 || event == EVENT_VIMLEAVE
2390 || event == EVENT_VIMLEAVEPRE))
2391 {
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002392 if (curbuf->b_changed != save_changed)
2393 need_maketitle = TRUE;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002394 curbuf->b_changed = save_changed;
2395 }
2396
2397 au_cleanup(); // may really delete removed patterns/commands now
2398
2399BYPASS_AU:
2400 // When wiping out a buffer make sure all its buffer-local autocommands
2401 // are deleted.
2402 if (event == EVENT_BUFWIPEOUT && buf != NULL)
2403 aubuflocal_remove(buf);
2404
2405 if (retval == OK && event == EVENT_FILETYPE)
2406 au_did_filetype = TRUE;
2407
2408 return retval;
2409}
2410
2411# ifdef FEAT_EVAL
2412static char_u *old_termresponse = NULL;
2413# endif
2414
2415/*
2416 * Block triggering autocommands until unblock_autocmd() is called.
2417 * Can be used recursively, so long as it's symmetric.
2418 */
2419 void
2420block_autocmds(void)
2421{
2422# ifdef FEAT_EVAL
2423 // Remember the value of v:termresponse.
2424 if (autocmd_blocked == 0)
2425 old_termresponse = get_vim_var_str(VV_TERMRESPONSE);
2426# endif
2427 ++autocmd_blocked;
2428}
2429
2430 void
2431unblock_autocmds(void)
2432{
2433 --autocmd_blocked;
2434
2435# ifdef FEAT_EVAL
2436 // When v:termresponse was set while autocommands were blocked, trigger
2437 // the autocommands now. Esp. useful when executing a shell command
2438 // during startup (vimdiff).
2439 if (autocmd_blocked == 0
2440 && get_vim_var_str(VV_TERMRESPONSE) != old_termresponse)
2441 apply_autocmds(EVENT_TERMRESPONSE, NULL, NULL, FALSE, curbuf);
2442# endif
2443}
2444
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002445 int
2446is_autocmd_blocked(void)
2447{
2448 return autocmd_blocked != 0;
2449}
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002450
2451/*
2452 * Find next autocommand pattern that matches.
2453 */
2454 static void
2455auto_next_pat(
LemonBoyeca7c602022-04-14 15:39:43 +01002456 AutoPatCmd_T *apc,
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002457 int stop_at_last) // stop when 'last' flag is set
2458{
2459 AutoPat *ap;
2460 AutoCmd *cp;
2461 char_u *name;
2462 char *s;
LemonBoyeca7c602022-04-14 15:39:43 +01002463 estack_T *entry;
2464 char_u *namep;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002465
LemonBoyeca7c602022-04-14 15:39:43 +01002466 entry = ((estack_T *)exestack.ga_data) + exestack.ga_len - 1;
2467
2468 // Clear the exestack entry for this ETYPE_AUCMD entry.
2469 VIM_CLEAR(entry->es_name);
2470 entry->es_info.aucmd = NULL;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002471
2472 for (ap = apc->curpat; ap != NULL && !got_int; ap = ap->next)
2473 {
2474 apc->curpat = NULL;
2475
2476 // Only use a pattern when it has not been removed, has commands and
2477 // the group matches. For buffer-local autocommands only check the
2478 // buffer number.
2479 if (ap->pat != NULL && ap->cmds != NULL
2480 && (apc->group == AUGROUP_ALL || apc->group == ap->group))
2481 {
2482 // execution-condition
2483 if (ap->buflocal_nr == 0
2484 ? (match_file_pat(NULL, &ap->reg_prog, apc->fname,
2485 apc->sfname, apc->tail, ap->allow_dirs))
2486 : ap->buflocal_nr == apc->arg_bufnr)
2487 {
2488 name = event_nr2name(apc->event);
2489 s = _("%s Autocommands for \"%s\"");
LemonBoyeca7c602022-04-14 15:39:43 +01002490 namep = alloc(STRLEN(s) + STRLEN(name) + ap->patlen + 1);
2491 if (namep != NULL)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002492 {
LemonBoyeca7c602022-04-14 15:39:43 +01002493 sprintf((char *)namep, s, (char *)name, (char *)ap->pat);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002494 if (p_verbose >= 8)
2495 {
2496 verbose_enter();
LemonBoyeca7c602022-04-14 15:39:43 +01002497 smsg(_("Executing %s"), namep);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002498 verbose_leave();
2499 }
2500 }
2501
LemonBoyeca7c602022-04-14 15:39:43 +01002502 // Update the exestack entry for this autocmd.
2503 entry->es_name = namep;
2504 entry->es_info.aucmd = apc;
2505
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002506 apc->curpat = ap;
2507 apc->nextcmd = ap->cmds;
2508 // mark last command
2509 for (cp = ap->cmds; cp->next != NULL; cp = cp->next)
2510 cp->last = FALSE;
2511 cp->last = TRUE;
2512 }
2513 line_breakcheck();
2514 if (apc->curpat != NULL) // found a match
2515 break;
2516 }
2517 if (stop_at_last && ap->last)
2518 break;
2519 }
2520}
2521
2522/*
LemonBoyeca7c602022-04-14 15:39:43 +01002523 * Get the script context where autocommand "acp" is defined.
2524 */
2525 sctx_T *
2526acp_script_ctx(AutoPatCmd_T *acp)
2527{
2528 return &acp->script_ctx;
2529}
2530
2531/*
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002532 * Get next autocommand command.
2533 * Called by do_cmdline() to get the next line for ":if".
2534 * Returns allocated string, or NULL for end of autocommands.
2535 */
2536 char_u *
Bram Moolenaar66250c92020-08-20 15:02:42 +02002537getnextac(
2538 int c UNUSED,
2539 void *cookie,
2540 int indent UNUSED,
2541 getline_opt_T options UNUSED)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002542{
LemonBoyeca7c602022-04-14 15:39:43 +01002543 AutoPatCmd_T *acp = (AutoPatCmd_T *)cookie;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002544 char_u *retval;
2545 AutoCmd *ac;
2546
2547 // Can be called again after returning the last line.
2548 if (acp->curpat == NULL)
2549 return NULL;
2550
2551 // repeat until we find an autocommand to execute
2552 for (;;)
2553 {
2554 // skip removed commands
2555 while (acp->nextcmd != NULL && acp->nextcmd->cmd == NULL)
2556 if (acp->nextcmd->last)
2557 acp->nextcmd = NULL;
2558 else
2559 acp->nextcmd = acp->nextcmd->next;
2560
2561 if (acp->nextcmd != NULL)
2562 break;
2563
2564 // at end of commands, find next pattern that matches
2565 if (acp->curpat->last)
2566 acp->curpat = NULL;
2567 else
2568 acp->curpat = acp->curpat->next;
2569 if (acp->curpat != NULL)
2570 auto_next_pat(acp, TRUE);
2571 if (acp->curpat == NULL)
2572 return NULL;
2573 }
2574
2575 ac = acp->nextcmd;
2576
2577 if (p_verbose >= 9)
2578 {
2579 verbose_enter_scroll();
2580 smsg(_("autocommand %s"), ac->cmd);
2581 msg_puts("\n"); // don't overwrite this either
2582 verbose_leave_scroll();
2583 }
2584 retval = vim_strsave(ac->cmd);
Bram Moolenaareb93f3f2019-04-04 15:04:56 +02002585 // Remove one-shot ("once") autocmd in anticipation of its execution.
2586 if (ac->once)
2587 au_del_cmd(ac);
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002588 autocmd_nested = ac->nested;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002589 current_sctx = ac->script_ctx;
LemonBoyeca7c602022-04-14 15:39:43 +01002590 acp->script_ctx = current_sctx;
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002591 if (ac->last)
2592 acp->nextcmd = NULL;
2593 else
2594 acp->nextcmd = ac->next;
2595 return retval;
2596}
2597
2598/*
2599 * Return TRUE if there is a matching autocommand for "fname".
2600 * To account for buffer-local autocommands, function needs to know
2601 * in which buffer the file will be opened.
2602 */
2603 int
2604has_autocmd(event_T event, char_u *sfname, buf_T *buf)
2605{
2606 AutoPat *ap;
2607 char_u *fname;
2608 char_u *tail = gettail(sfname);
2609 int retval = FALSE;
2610
2611 fname = FullName_save(sfname, FALSE);
2612 if (fname == NULL)
2613 return FALSE;
2614
2615#ifdef BACKSLASH_IN_FILENAME
2616 /*
2617 * Replace all backslashes with forward slashes. This makes the
2618 * autocommand patterns portable between Unix and MS-DOS.
2619 */
2620 sfname = vim_strsave(sfname);
2621 if (sfname != NULL)
2622 forward_slash(sfname);
2623 forward_slash(fname);
2624#endif
2625
Bram Moolenaaraeea7212020-04-02 18:50:46 +02002626 FOR_ALL_AUTOCMD_PATTERNS(event, ap)
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002627 if (ap->pat != NULL && ap->cmds != NULL
2628 && (ap->buflocal_nr == 0
2629 ? match_file_pat(NULL, &ap->reg_prog,
2630 fname, sfname, tail, ap->allow_dirs)
2631 : buf != NULL && ap->buflocal_nr == buf->b_fnum
2632 ))
2633 {
2634 retval = TRUE;
2635 break;
2636 }
2637
2638 vim_free(fname);
2639#ifdef BACKSLASH_IN_FILENAME
2640 vim_free(sfname);
2641#endif
2642
2643 return retval;
2644}
2645
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002646/*
2647 * Function given to ExpandGeneric() to obtain the list of autocommand group
2648 * names.
2649 */
2650 char_u *
2651get_augroup_name(expand_T *xp UNUSED, int idx)
2652{
2653 if (idx == augroups.ga_len) // add "END" add the end
2654 return (char_u *)"END";
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002655 if (idx < 0 || idx >= augroups.ga_len) // end of list
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002656 return NULL;
2657 if (AUGROUP_NAME(idx) == NULL || AUGROUP_NAME(idx) == get_deleted_augroup())
2658 // skip deleted entries
2659 return (char_u *)"";
2660 return AUGROUP_NAME(idx); // return a name
2661}
2662
2663static int include_groups = FALSE;
2664
2665 char_u *
2666set_context_in_autocmd(
2667 expand_T *xp,
2668 char_u *arg,
2669 int doautocmd) // TRUE for :doauto*, FALSE for :autocmd
2670{
2671 char_u *p;
2672 int group;
2673
2674 // check for a group name, skip it if present
2675 include_groups = FALSE;
2676 p = arg;
2677 group = au_get_grouparg(&arg);
2678 if (group == AUGROUP_ERROR)
2679 return NULL;
2680 // If there only is a group name that's what we expand.
2681 if (*arg == NUL && group != AUGROUP_ALL && !VIM_ISWHITE(arg[-1]))
2682 {
2683 arg = p;
2684 group = AUGROUP_ALL;
2685 }
2686
2687 // skip over event name
2688 for (p = arg; *p != NUL && !VIM_ISWHITE(*p); ++p)
2689 if (*p == ',')
2690 arg = p + 1;
2691 if (*p == NUL)
2692 {
2693 if (group == AUGROUP_ALL)
2694 include_groups = TRUE;
2695 xp->xp_context = EXPAND_EVENTS; // expand event name
2696 xp->xp_pattern = arg;
2697 return NULL;
2698 }
2699
2700 // skip over pattern
2701 arg = skipwhite(p);
2702 while (*arg && (!VIM_ISWHITE(*arg) || arg[-1] == '\\'))
2703 arg++;
2704 if (*arg)
2705 return arg; // expand (next) command
2706
2707 if (doautocmd)
2708 xp->xp_context = EXPAND_FILES; // expand file names
2709 else
2710 xp->xp_context = EXPAND_NOTHING; // pattern is not expanded
2711 return NULL;
2712}
2713
2714/*
2715 * Function given to ExpandGeneric() to obtain the list of event names.
2716 */
2717 char_u *
2718get_event_name(expand_T *xp UNUSED, int idx)
2719{
2720 if (idx < augroups.ga_len) // First list group names, if wanted
2721 {
2722 if (!include_groups || AUGROUP_NAME(idx) == NULL
2723 || AUGROUP_NAME(idx) == get_deleted_augroup())
2724 return (char_u *)""; // skip deleted entries
2725 return AUGROUP_NAME(idx); // return a name
2726 }
2727 return (char_u *)event_names[idx - augroups.ga_len].name;
2728}
2729
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01002730
2731#if defined(FEAT_EVAL) || defined(PROTO)
2732/*
2733 * Return TRUE if autocmd is supported.
2734 */
2735 int
2736autocmd_supported(char_u *name)
2737{
2738 char_u *p;
2739
2740 return (event_name2nr(name, &p) != NUM_EVENTS);
2741}
2742
2743/*
2744 * Return TRUE if an autocommand is defined for a group, event and
2745 * pattern: The group can be omitted to accept any group. "event" and "pattern"
2746 * can be NULL to accept any event and pattern. "pattern" can be NULL to accept
2747 * any pattern. Buffer-local patterns <buffer> or <buffer=N> are accepted.
2748 * Used for:
2749 * exists("#Group") or
2750 * exists("#Group#Event") or
2751 * exists("#Group#Event#pat") or
2752 * exists("#Event") or
2753 * exists("#Event#pat")
2754 */
2755 int
2756au_exists(char_u *arg)
2757{
2758 char_u *arg_save;
2759 char_u *pattern = NULL;
2760 char_u *event_name;
2761 char_u *p;
2762 event_T event;
2763 AutoPat *ap;
2764 buf_T *buflocal_buf = NULL;
2765 int group;
2766 int retval = FALSE;
2767
2768 // Make a copy so that we can change the '#' chars to a NUL.
2769 arg_save = vim_strsave(arg);
2770 if (arg_save == NULL)
2771 return FALSE;
2772 p = vim_strchr(arg_save, '#');
2773 if (p != NULL)
2774 *p++ = NUL;
2775
2776 // First, look for an autocmd group name
2777 group = au_find_group(arg_save);
2778 if (group == AUGROUP_ERROR)
2779 {
2780 // Didn't match a group name, assume the first argument is an event.
2781 group = AUGROUP_ALL;
2782 event_name = arg_save;
2783 }
2784 else
2785 {
2786 if (p == NULL)
2787 {
2788 // "Group": group name is present and it's recognized
2789 retval = TRUE;
2790 goto theend;
2791 }
2792
2793 // Must be "Group#Event" or "Group#Event#pat".
2794 event_name = p;
2795 p = vim_strchr(event_name, '#');
2796 if (p != NULL)
2797 *p++ = NUL; // "Group#Event#pat"
2798 }
2799
2800 pattern = p; // "pattern" is NULL when there is no pattern
2801
2802 // find the index (enum) for the event name
2803 event = event_name2nr(event_name, &p);
2804
2805 // return FALSE if the event name is not recognized
2806 if (event == NUM_EVENTS)
2807 goto theend;
2808
2809 // Find the first autocommand for this event.
2810 // If there isn't any, return FALSE;
2811 // If there is one and no pattern given, return TRUE;
2812 ap = first_autopat[(int)event];
2813 if (ap == NULL)
2814 goto theend;
2815
2816 // if pattern is "<buffer>", special handling is needed which uses curbuf
2817 // for pattern "<buffer=N>, fnamecmp() will work fine
2818 if (pattern != NULL && STRICMP(pattern, "<buffer>") == 0)
2819 buflocal_buf = curbuf;
2820
2821 // Check if there is an autocommand with the given pattern.
2822 for ( ; ap != NULL; ap = ap->next)
2823 // only use a pattern when it has not been removed and has commands.
2824 // For buffer-local autocommands, fnamecmp() works fine.
2825 if (ap->pat != NULL && ap->cmds != NULL
2826 && (group == AUGROUP_ALL || ap->group == group)
2827 && (pattern == NULL
2828 || (buflocal_buf == NULL
2829 ? fnamecmp(ap->pat, pattern) == 0
2830 : ap->buflocal_nr == buflocal_buf->b_fnum)))
2831 {
2832 retval = TRUE;
2833 break;
2834 }
2835
2836theend:
2837 vim_free(arg_save);
2838 return retval;
2839}
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002840
2841/*
2842 * autocmd_add() and autocmd_delete() functions
2843 */
2844 static void
2845autocmd_add_or_delete(typval_T *argvars, typval_T *rettv, int delete)
2846{
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002847 list_T *aucmd_list;
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002848 listitem_T *li;
2849 dict_T *event_dict;
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002850 dictitem_T *di;
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002851 char_u *event_name = NULL;
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002852 list_T *event_list;
2853 listitem_T *eli;
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002854 event_T event;
2855 char_u *group_name = NULL;
2856 int group;
2857 char_u *pat = NULL;
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002858 list_T *pat_list;
2859 listitem_T *pli;
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002860 char_u *cmd = NULL;
2861 char_u *end;
2862 int once;
2863 int nested;
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +01002864 int replace; // replace the cmd for a group/event
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002865 int retval = VVAL_TRUE;
2866 int save_augroup = current_augroup;
2867
2868 rettv->v_type = VAR_BOOL;
2869 rettv->vval.v_number = VVAL_FALSE;
2870
2871 if (check_for_list_arg(argvars, 0) == FAIL)
2872 return;
2873
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002874 aucmd_list = argvars[0].vval.v_list;
2875 if (aucmd_list == NULL)
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002876 return;
2877
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002878 FOR_ALL_LIST_ITEMS(aucmd_list, li)
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002879 {
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002880 VIM_CLEAR(group_name);
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002881 VIM_CLEAR(cmd);
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002882 event_name = NULL;
2883 event_list = NULL;
2884 pat = NULL;
2885 pat_list = NULL;
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002886
2887 if (li->li_tv.v_type != VAR_DICT)
2888 continue;
2889
2890 event_dict = li->li_tv.vval.v_dict;
2891 if (event_dict == NULL)
2892 continue;
2893
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002894 di = dict_find(event_dict, (char_u *)"event", -1);
2895 if (di != NULL)
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002896 {
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002897 if (di->di_tv.v_type == VAR_STRING)
2898 {
2899 event_name = di->di_tv.vval.v_string;
2900 if (event_name == NULL)
2901 {
2902 emsg(_(e_string_required));
2903 continue;
2904 }
2905 }
2906 else if (di->di_tv.v_type == VAR_LIST)
2907 {
2908 event_list = di->di_tv.vval.v_list;
2909 if (event_list == NULL)
2910 {
2911 emsg(_(e_list_required));
2912 continue;
2913 }
2914 }
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002915 else
2916 {
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002917 emsg(_(e_string_or_list_expected));
2918 continue;
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002919 }
2920 }
2921
Bram Moolenaard61efa52022-07-23 09:52:04 +01002922 group_name = dict_get_string(event_dict, "group", TRUE);
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002923 if (group_name == NULL || *group_name == NUL)
2924 // if the autocmd group name is not specified, then use the current
2925 // autocmd group
2926 group = current_augroup;
2927 else
2928 {
2929 group = au_find_group(group_name);
2930 if (group == AUGROUP_ERROR)
2931 {
2932 if (delete)
2933 {
2934 semsg(_(e_no_such_group_str), group_name);
2935 retval = VVAL_FALSE;
2936 break;
2937 }
2938 // group is not found, create it now
2939 group = au_new_group(group_name);
2940 if (group == AUGROUP_ERROR)
2941 {
2942 semsg(_(e_no_such_group_str), group_name);
2943 retval = VVAL_FALSE;
2944 break;
2945 }
2946
2947 current_augroup = group;
2948 }
2949 }
2950
2951 // if a buffer number is specified, then generate a pattern of the form
2952 // "<buffer=n>. Otherwise, use the pattern supplied by the user.
2953 if (dict_has_key(event_dict, "bufnr"))
2954 {
2955 varnumber_T bnum;
2956
Bram Moolenaard61efa52022-07-23 09:52:04 +01002957 bnum = dict_get_number_def(event_dict, "bufnr", -1);
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002958 if (bnum == -1)
2959 continue;
2960
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002961 vim_snprintf((char *)IObuff, IOSIZE, "<buffer=%d>", (int)bnum);
2962 pat = IObuff;
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002963 }
2964 else
2965 {
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002966 di = dict_find(event_dict, (char_u *)"pattern", -1);
2967 if (di != NULL)
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002968 {
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002969 if (di->di_tv.v_type == VAR_STRING)
2970 {
2971 pat = di->di_tv.vval.v_string;
2972 if (pat == NULL)
2973 {
2974 emsg(_(e_string_required));
2975 continue;
2976 }
2977 }
2978 else if (di->di_tv.v_type == VAR_LIST)
2979 {
2980 pat_list = di->di_tv.vval.v_list;
2981 if (pat_list == NULL)
2982 {
2983 emsg(_(e_list_required));
2984 continue;
2985 }
2986 }
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002987 else
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002988 {
2989 emsg(_(e_string_or_list_expected));
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002990 continue;
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002991 }
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002992 }
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01002993 else if (delete)
2994 pat = (char_u *)"";
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01002995 }
2996
Bram Moolenaard61efa52022-07-23 09:52:04 +01002997 once = dict_get_bool(event_dict, "once", FALSE);
2998 nested = dict_get_bool(event_dict, "nested", FALSE);
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +01002999 // if 'replace' is true, then remove all the commands associated with
3000 // this autocmd event/group and add the new command.
Bram Moolenaard61efa52022-07-23 09:52:04 +01003001 replace = dict_get_bool(event_dict, "replace", FALSE);
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003002
Bram Moolenaard61efa52022-07-23 09:52:04 +01003003 cmd = dict_get_string(event_dict, "cmd", TRUE);
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003004 if (cmd == NULL)
3005 {
3006 if (delete)
3007 cmd = vim_strsave((char_u *)"");
3008 else
3009 continue;
3010 }
3011
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003012 if (delete && (event_name == NULL
3013 || (event_name[0] == '*' && event_name[1] == NUL)))
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003014 {
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003015 // if the event name is not specified or '*', delete all the events
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003016 for (event = (event_T)0; (int)event < NUM_EVENTS;
3017 event = (event_T)((int)event + 1))
3018 {
3019 if (do_autocmd_event(event, pat, once, nested, cmd, delete,
3020 group, 0) == FAIL)
3021 {
3022 retval = VVAL_FALSE;
3023 break;
3024 }
3025 }
3026 }
3027 else
3028 {
Bram Moolenaar968443e2022-05-27 21:16:34 +01003029 char_u *p = NULL;
3030
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003031 eli = NULL;
3032 end = NULL;
3033 while (TRUE)
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003034 {
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003035 if (event_list != NULL)
3036 {
3037 if (eli == NULL)
3038 eli = event_list->lv_first;
3039 else
3040 eli = eli->li_next;
3041 if (eli == NULL)
3042 break;
3043 if (eli->li_tv.v_type != VAR_STRING
Bram Moolenaar882476a2022-06-01 16:02:38 +01003044 || (p = eli->li_tv.vval.v_string) == NULL)
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003045 {
3046 emsg(_(e_string_required));
Bram Moolenaar882476a2022-06-01 16:02:38 +01003047 break;
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003048 }
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003049 }
3050 else
3051 {
Bram Moolenaar882476a2022-06-01 16:02:38 +01003052 if (p == NULL)
3053 p = event_name;
3054 if (p == NULL || *p == NUL)
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003055 break;
3056 }
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003057
3058 event = event_name2nr(p, &end);
3059 if (event == NUM_EVENTS || *end != NUL)
3060 {
Bram Moolenaar882476a2022-06-01 16:02:38 +01003061 // this also catches something following a valid event name
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +01003062 semsg(_(e_no_such_event_str), p);
3063 retval = VVAL_FALSE;
3064 break;
3065 }
3066 if (pat != NULL)
3067 {
3068 if (do_autocmd_event(event, pat, once, nested, cmd,
3069 delete | replace, group, 0) == FAIL)
3070 {
3071 retval = VVAL_FALSE;
3072 break;
3073 }
3074 }
3075 else if (pat_list != NULL)
3076 {
3077 FOR_ALL_LIST_ITEMS(pat_list, pli)
3078 {
3079 if (pli->li_tv.v_type != VAR_STRING
3080 || pli->li_tv.vval.v_string == NULL)
3081 {
3082 emsg(_(e_string_required));
3083 continue;
3084 }
3085 if (do_autocmd_event(event,
3086 pli->li_tv.vval.v_string, once, nested,
3087 cmd, delete | replace, group, 0) ==
3088 FAIL)
3089 {
3090 retval = VVAL_FALSE;
3091 break;
3092 }
3093 }
3094 if (retval == VVAL_FALSE)
3095 break;
3096 }
3097 if (event_name != NULL)
3098 p = end;
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003099 }
3100 }
3101
3102 // if only the autocmd group name is specified for delete and the
3103 // autocmd event, pattern and cmd are not specified, then delete the
3104 // autocmd group.
3105 if (delete && group_name != NULL &&
3106 (event_name == NULL || event_name[0] == NUL)
3107 && (pat == NULL || pat[0] == NUL)
3108 && (cmd == NULL || cmd[0] == NUL))
3109 au_del_group(group_name);
3110 }
3111
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003112 VIM_CLEAR(group_name);
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003113 VIM_CLEAR(cmd);
3114
3115 current_augroup = save_augroup;
3116 rettv->vval.v_number = retval;
3117}
3118
3119/*
3120 * autocmd_add() function
3121 */
3122 void
3123f_autocmd_add(typval_T *argvars, typval_T *rettv)
3124{
3125 autocmd_add_or_delete(argvars, rettv, FALSE);
3126}
3127
3128/*
3129 * autocmd_delete() function
3130 */
3131 void
3132f_autocmd_delete(typval_T *argvars, typval_T *rettv)
3133{
3134 autocmd_add_or_delete(argvars, rettv, TRUE);
3135}
3136
3137/*
3138 * autocmd_get() function
3139 * Returns a List of autocmds.
3140 */
3141 void
3142f_autocmd_get(typval_T *argvars, typval_T *rettv)
3143{
3144 event_T event_arg = NUM_EVENTS;
3145 event_T event;
3146 AutoPat *ap;
3147 AutoCmd *ac;
3148 list_T *event_list;
3149 dict_T *event_dict;
3150 char_u *event_name = NULL;
3151 char_u *pat = NULL;
3152 char_u *name = NULL;
3153 int group = AUGROUP_ALL;
3154
Yegappan Lakshmananca195cc2022-06-14 13:42:26 +01003155 if (rettv_list_alloc(rettv) == FAIL)
3156 return;
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003157 if (check_for_opt_dict_arg(argvars, 0) == FAIL)
3158 return;
3159
3160 if (argvars[0].v_type == VAR_DICT)
3161 {
3162 // return only the autocmds in the specified group
3163 if (dict_has_key(argvars[0].vval.v_dict, "group"))
3164 {
Bram Moolenaard61efa52022-07-23 09:52:04 +01003165 name = dict_get_string(argvars[0].vval.v_dict, "group", TRUE);
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003166 if (name == NULL)
3167 return;
3168
3169 if (*name == NUL)
3170 group = AUGROUP_DEFAULT;
3171 else
3172 {
3173 group = au_find_group(name);
3174 if (group == AUGROUP_ERROR)
3175 {
3176 semsg(_(e_no_such_group_str), name);
3177 vim_free(name);
3178 return;
3179 }
3180 }
3181 vim_free(name);
3182 }
3183
3184 // return only the autocmds for the specified event
3185 if (dict_has_key(argvars[0].vval.v_dict, "event"))
3186 {
3187 int i;
3188
Bram Moolenaard61efa52022-07-23 09:52:04 +01003189 name = dict_get_string(argvars[0].vval.v_dict, "event", TRUE);
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003190 if (name == NULL)
3191 return;
3192
3193 if (name[0] == '*' && name[1] == NUL)
3194 event_arg = NUM_EVENTS;
3195 else
3196 {
3197 for (i = 0; event_names[i].name != NULL; i++)
3198 if (STRICMP(event_names[i].name, name) == 0)
3199 break;
3200 if (event_names[i].name == NULL)
3201 {
3202 semsg(_(e_no_such_event_str), name);
3203 vim_free(name);
3204 return;
3205 }
3206 event_arg = event_names[i].event;
3207 }
3208 vim_free(name);
3209 }
3210
3211 // return only the autocmds for the specified pattern
3212 if (dict_has_key(argvars[0].vval.v_dict, "pattern"))
3213 {
Bram Moolenaard61efa52022-07-23 09:52:04 +01003214 pat = dict_get_string(argvars[0].vval.v_dict, "pattern", TRUE);
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003215 if (pat == NULL)
3216 return;
3217 }
3218 }
3219
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003220 event_list = rettv->vval.v_list;
3221
3222 // iterate through all the autocmd events
3223 for (event = (event_T)0; (int)event < NUM_EVENTS;
3224 event = (event_T)((int)event + 1))
3225 {
3226 if (event_arg != NUM_EVENTS && event != event_arg)
3227 continue;
3228
3229 event_name = event_nr2name(event);
3230
3231 // iterate through all the patterns for this autocmd event
3232 FOR_ALL_AUTOCMD_PATTERNS(event, ap)
3233 {
3234 char_u *group_name;
3235
3236 if (group != AUGROUP_ALL && group != ap->group)
3237 continue;
3238
3239 if (pat != NULL && STRCMP(pat, ap->pat) != 0)
3240 continue;
3241
3242 group_name = get_augroup_name(NULL, ap->group);
3243
3244 // iterate through all the commands for this pattern and add one
3245 // item for each cmd.
3246 for (ac = ap->cmds; ac != NULL; ac = ac->next)
3247 {
3248 event_dict = dict_alloc();
Yegappan Lakshmanan00e977c2022-06-01 12:31:53 +01003249 if (event_dict == NULL
3250 || list_append_dict(event_list, event_dict) == FAIL)
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003251 return;
3252
Yegappan Lakshmanan00e977c2022-06-01 12:31:53 +01003253 if (dict_add_string(event_dict, "event", event_name) == FAIL
3254 || dict_add_string(event_dict, "group",
3255 group_name == NULL ? (char_u *)""
3256 : group_name) == FAIL
3257 || (ap->buflocal_nr != 0
3258 && (dict_add_number(event_dict, "bufnr",
3259 ap->buflocal_nr) == FAIL))
3260 || dict_add_string(event_dict, "pattern",
3261 ap->pat) == FAIL
3262 || dict_add_string(event_dict, "cmd", ac->cmd) == FAIL
3263 || dict_add_bool(event_dict, "once", ac->once) == FAIL
3264 || dict_add_bool(event_dict, "nested",
3265 ac->nested) == FAIL)
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01003266 return;
3267 }
3268 }
3269 }
3270
3271 vim_free(pat);
3272}
3273
Bram Moolenaar3e460fd2019-01-26 16:21:07 +01003274#endif