blob: 61d288157da8ec2d8e827aa73796205eff4c3bfa [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_eval.c: functions for Ex command line for the +eval feature.
12 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
17
Bram Moolenaarddef1292019-12-16 17:10:33 +010018static char *get_end_emsg(cstack_T *cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +000019
20/*
21 * Exception handling terms:
22 *
23 * :try ":try" command \
24 * ... try block |
25 * :catch RE ":catch" command |
26 * ... catch clause |- try conditional
27 * :finally ":finally" command |
28 * ... finally clause |
29 * :endtry ":endtry" command /
30 *
31 * The try conditional may have any number of catch clauses and at most one
32 * finally clause. A ":throw" command can be inside the try block, a catch
33 * clause, the finally clause, or in a function called or script sourced from
34 * there or even outside the try conditional. Try conditionals may be nested.
35 */
36
37/*
38 * Configuration whether an exception is thrown on error or interrupt. When
39 * the preprocessor macros below evaluate to FALSE, an error (did_emsg) or
40 * interrupt (got_int) under an active try conditional terminates the script
41 * after the non-active finally clauses of all active try conditionals have been
42 * executed. Otherwise, errors and/or interrupts are converted into catchable
43 * exceptions (did_throw additionally set), which terminate the script only if
44 * not caught. For user exceptions, only did_throw is set. (Note: got_int can
Bram Moolenaar84a05ac2013-05-06 04:24:17 +020045 * be set asynchronously afterwards by a SIGINT, so did_throw && got_int is not
Bram Moolenaar071d4272004-06-13 20:20:40 +000046 * a reliant test that the exception currently being thrown is an interrupt
47 * exception. Similarly, did_emsg can be set afterwards on an error in an
48 * (unskipped) conditional command inside an inactive conditional, so did_throw
49 * && did_emsg is not a reliant test that the exception currently being thrown
50 * is an error exception.) - The macros can be defined as expressions checking
51 * for a variable that is allowed to be changed during execution of a script.
52 */
53#if 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +010054// Expressions used for testing during the development phase.
Bram Moolenaar071d4272004-06-13 20:20:40 +000055# define THROW_ON_ERROR (!eval_to_number("$VIMNOERRTHROW"))
56# define THROW_ON_INTERRUPT (!eval_to_number("$VIMNOINTTHROW"))
57# define THROW_TEST
58#else
Bram Moolenaar217e1b82019-12-01 21:41:28 +010059// Values used for the Vim release.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060# define THROW_ON_ERROR TRUE
Bram Moolenaaraf0167f2009-05-16 15:31:32 +000061# define THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +000062# define THROW_ON_INTERRUPT TRUE
Bram Moolenaaraf0167f2009-05-16 15:31:32 +000063# define THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +000064#endif
65
Bram Moolenaar071d4272004-06-13 20:20:40 +000066/*
67 * When several errors appear in a row, setting "force_abort" is delayed until
68 * the failing command returned. "cause_abort" is set to TRUE meanwhile, in
69 * order to indicate that situation. This is useful when "force_abort" was set
70 * during execution of a function call from an expression: the aborting of the
71 * expression evaluation is done without producing any error messages, but all
72 * error messages on parsing errors during the expression evaluation are given
73 * (even if a try conditional is active).
74 */
75static int cause_abort = FALSE;
76
77/*
Bram Moolenaarccc18222007-05-10 18:25:20 +000078 * Return TRUE when immediately aborting on error, or when an interrupt
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 * occurred or an exception was thrown but not caught. Use for ":{range}call"
80 * to check whether an aborted function that does not handle a range itself
81 * should be called again for the next line in the range. Also used for
82 * cancelling expression evaluation after a function call caused an immediate
83 * abort. Note that the first emsg() call temporarily resets "force_abort"
84 * until the throw point for error messages has been reached. That is, during
85 * cancellation of an expression evaluation after an aborting function call or
86 * due to a parsing error, aborting() always returns the same value.
Bram Moolenaar67a2deb2019-11-25 00:05:32 +010087 * "got_int" is also set by calling interrupt().
Bram Moolenaar071d4272004-06-13 20:20:40 +000088 */
89 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010090aborting(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +000091{
92 return (did_emsg && force_abort) || got_int || did_throw;
93}
94
95/*
96 * The value of "force_abort" is temporarily reset by the first emsg() call
97 * during an expression evaluation, and "cause_abort" is used instead. It might
98 * be necessary to restore "force_abort" even before the throw point for the
99 * error message has been reached. update_force_abort() should be called then.
100 */
101 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100102update_force_abort(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103{
104 if (cause_abort)
105 force_abort = TRUE;
106}
107
108/*
109 * Return TRUE if a command with a subcommand resulting in "retcode" should
110 * abort the script processing. Can be used to suppress an autocommand after
111 * execution of a failing subcommand as long as the error message has not been
112 * displayed and actually caused the abortion.
113 */
114 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100115should_abort(int retcode)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116{
117 return ((retcode == FAIL && trylevel != 0 && !emsg_silent) || aborting());
118}
119
120/*
121 * Return TRUE if a function with the "abort" flag should not be considered
122 * ended on an error. This means that parsing commands is continued in order
123 * to find finally clauses to be executed, and that some errors in skipped
124 * commands are still reported.
125 */
126 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100127aborted_in_try(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100129 // This function is only called after an error. In this case, "force_abort"
130 // determines whether searching for finally clauses is necessary.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131 return force_abort;
132}
133
134/*
135 * cause_errthrow(): Cause a throw of an error exception if appropriate.
136 * Return TRUE if the error message should not be displayed by emsg().
137 * Sets "ignore", if the emsg() call should be ignored completely.
138 *
139 * When several messages appear in the same command, the first is usually the
140 * most specific one and used as the exception value. The "severe" flag can be
141 * set to TRUE, if a later but severer message should be used instead.
142 */
143 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100144cause_errthrow(
145 char_u *mesg,
146 int severe,
147 int *ignore)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148{
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200149 msglist_T *elem;
150 msglist_T **plist;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 /*
Bram Moolenaar57657d82006-04-21 22:12:41 +0000153 * Do nothing when displaying the interrupt message or reporting an
154 * uncaught exception (which has already been discarded then) at the top
155 * level. Also when no exception can be thrown. The message will be
156 * displayed by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157 */
158 if (suppress_errthrow)
159 return FALSE;
160
161 /*
Bram Moolenaar57657d82006-04-21 22:12:41 +0000162 * If emsg() has not been called previously, temporarily reset
163 * "force_abort" until the throw point for error messages has been
164 * reached. This ensures that aborting() returns the same value for all
165 * errors that appear in the same command. This means particularly that
166 * for parsing errors during expression evaluation emsg() will be called
167 * multiply, even when the expression is evaluated from a finally clause
168 * that was activated due to an aborting error, interrupt, or exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169 */
170 if (!did_emsg)
171 {
172 cause_abort = force_abort;
173 force_abort = FALSE;
174 }
175
176 /*
177 * If no try conditional is active and no exception is being thrown and
178 * there has not been an error in a try conditional or a throw so far, do
Bram Moolenaar57657d82006-04-21 22:12:41 +0000179 * nothing (for compatibility of non-EH scripts). The message will then
180 * be displayed by emsg(). When ":silent!" was used and we are not
181 * currently throwing an exception, do nothing. The message text will
182 * then be stored to v:errmsg by emsg() without displaying it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183 */
184 if (((trylevel == 0 && !cause_abort) || emsg_silent) && !did_throw)
185 return FALSE;
186
187 /*
188 * Ignore an interrupt message when inside a try conditional or when an
Bram Moolenaar57657d82006-04-21 22:12:41 +0000189 * exception is being thrown or when an error in a try conditional or
190 * throw has been detected previously. This is important in order that an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191 * interrupt exception is catchable by the innermost try conditional and
192 * not replaced by an interrupt message error exception.
193 */
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000194 if (mesg == (char_u *)_(e_interrupted))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195 {
196 *ignore = TRUE;
197 return TRUE;
198 }
199
200 /*
201 * Ensure that all commands in nested function calls and sourced files
202 * are aborted immediately.
203 */
204 cause_abort = TRUE;
205
206 /*
207 * When an exception is being thrown, some commands (like conditionals) are
208 * not skipped. Errors in those commands may affect what of the subsequent
209 * commands are regarded part of catch and finally clauses. Catching the
210 * exception would then cause execution of commands not intended by the
Bram Moolenaarc3235272021-07-10 19:42:03 +0200211 * user, who wouldn't even get aware of the problem. Therefore, discard the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 * exception currently being thrown to prevent it from being caught. Just
213 * execute finally clauses and terminate.
214 */
215 if (did_throw)
216 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100217 // When discarding an interrupt exception, reset got_int to prevent the
218 // same interrupt being converted to an exception again and discarding
219 // the error exception we are about to throw here.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220 if (current_exception->type == ET_INTERRUPT)
221 got_int = FALSE;
222 discard_current_exception();
223 }
224
225#ifdef THROW_TEST
226 if (!THROW_ON_ERROR)
227 {
228 /*
229 * Print error message immediately without searching for a matching
230 * catch clause; just finally clauses are executed before the script
231 * is terminated.
232 */
233 return FALSE;
234 }
235 else
236#endif
237 {
238 /*
239 * Prepare the throw of an error exception, so that everything will
240 * be aborted (except for executing finally clauses), until the error
241 * exception is caught; if still uncaught at the top level, the error
242 * message will be displayed and the script processing terminated
243 * then. - This function has no access to the conditional stack.
244 * Thus, the actual throw is made after the failing command has
245 * returned. - Throw only the first of several errors in a row, except
246 * a severe error is following.
247 */
248 if (msg_list != NULL)
249 {
250 plist = msg_list;
251 while (*plist != NULL)
252 plist = &(*plist)->next;
253
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200254 elem = ALLOC_CLEAR_ONE(msglist_T);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255 if (elem == NULL)
256 {
257 suppress_errthrow = TRUE;
Bram Moolenaare29a27f2021-07-20 21:07:36 +0200258 emsg(_(e_out_of_memory));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259 }
260 else
261 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100262 elem->msg = (char *)vim_strsave(mesg);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000263 if (elem->msg == NULL)
264 {
265 vim_free(elem);
266 suppress_errthrow = TRUE;
Bram Moolenaare29a27f2021-07-20 21:07:36 +0200267 emsg(_(e_out_of_memory));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268 }
269 else
270 {
271 elem->next = NULL;
272 elem->throw_msg = NULL;
273 *plist = elem;
274 if (plist == msg_list || severe)
275 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100276 char *tmsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100278 // Skip the extra "Vim " prefix for message "E458".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 tmsg = elem->msg;
280 if (STRNCMP(tmsg, "Vim E", 5) == 0
281 && VIM_ISDIGIT(tmsg[5])
282 && VIM_ISDIGIT(tmsg[6])
283 && VIM_ISDIGIT(tmsg[7])
284 && tmsg[8] == ':'
285 && tmsg[9] == ' ')
286 (*msg_list)->throw_msg = &tmsg[4];
287 else
288 (*msg_list)->throw_msg = tmsg;
289 }
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200290
291 // Get the source name and lnum now, it may change before
292 // reaching do_errthrow().
Bram Moolenaar4f25b1a2020-09-10 19:25:05 +0200293 elem->sfile = estack_sfile(ESTACK_NONE);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200294 elem->slnum = SOURCING_LNUM;
Bram Moolenaare8c46602021-04-05 22:27:37 +0200295 elem->msg_compiling = estack_compiling;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296 }
297 }
298 }
299 return TRUE;
300 }
301}
302
303/*
304 * Free a "msg_list" and the messages it contains.
305 */
306 static void
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200307free_msglist(msglist_T *l)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308{
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200309 msglist_T *messages, *next;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311 messages = l;
312 while (messages != NULL)
313 {
314 next = messages->next;
315 vim_free(messages->msg);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200316 vim_free(messages->sfile);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 vim_free(messages);
318 messages = next;
319 }
320}
321
322/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100323 * Free global "*msg_list" and the messages it contains, then set "*msg_list"
324 * to NULL.
325 */
326 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100327free_global_msglist(void)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100328{
329 free_msglist(*msg_list);
330 *msg_list = NULL;
331}
332
333/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334 * Throw the message specified in the call to cause_errthrow() above as an
335 * error exception. If cstack is NULL, postpone the throw until do_cmdline()
336 * has returned (see do_one_cmd()).
337 */
338 void
Bram Moolenaarddef1292019-12-16 17:10:33 +0100339do_errthrow(cstack_T *cstack, char_u *cmdname)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000340{
341 /*
342 * Ensure that all commands in nested function calls and sourced files
343 * are aborted immediately.
344 */
345 if (cause_abort)
346 {
347 cause_abort = FALSE;
348 force_abort = TRUE;
349 }
350
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100351 // If no exception is to be thrown or the conversion should be done after
352 // returning to a previous invocation of do_one_cmd(), do nothing.
Bram Moolenaar4632d292006-11-28 17:36:37 +0000353 if (msg_list == NULL || *msg_list == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 return;
355
356 if (throw_exception(*msg_list, ET_ERROR, cmdname) == FAIL)
357 free_msglist(*msg_list);
358 else
359 {
360 if (cstack != NULL)
361 do_throw(cstack);
362 else
363 need_rethrow = TRUE;
364 }
365 *msg_list = NULL;
366}
367
368/*
369 * do_intthrow(): Replace the current exception by an interrupt or interrupt
370 * exception if appropriate. Return TRUE if the current exception is discarded,
371 * FALSE otherwise.
372 */
373 int
Bram Moolenaarddef1292019-12-16 17:10:33 +0100374do_intthrow(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375{
376 /*
377 * If no interrupt occurred or no try conditional is active and no exception
378 * is being thrown, do nothing (for compatibility of non-EH scripts).
379 */
380 if (!got_int || (trylevel == 0 && !did_throw))
381 return FALSE;
382
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100383#ifdef THROW_TEST // avoid warning for condition always true
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 if (!THROW_ON_INTERRUPT)
385 {
386 /*
387 * The interrupt aborts everything except for executing finally clauses.
388 * Discard any user or error or interrupt exception currently being
389 * thrown.
390 */
391 if (did_throw)
392 discard_current_exception();
393 }
394 else
395#endif
396 {
397 /*
398 * Throw an interrupt exception, so that everything will be aborted
399 * (except for executing finally clauses), until the interrupt exception
400 * is caught; if still uncaught at the top level, the script processing
401 * will be terminated then. - If an interrupt exception is already
402 * being thrown, do nothing.
403 *
404 */
405 if (did_throw)
406 {
407 if (current_exception->type == ET_INTERRUPT)
408 return FALSE;
409
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100410 // An interrupt exception replaces any user or error exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411 discard_current_exception();
412 }
413 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) != FAIL)
414 do_throw(cstack);
415 }
416
417 return TRUE;
418}
419
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100421 * Get an exception message that is to be stored in current_exception->value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100423 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100424get_exception_string(
425 void *value,
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100426 except_type_T type,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100427 char_u *cmdname,
428 int *should_free)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100430 char *ret;
431 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432 int cmdlen;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100433 char *p, *val;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434
435 if (type == ET_ERROR)
436 {
Bram Moolenaar9ef00be2016-03-06 14:58:28 +0100437 *should_free = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200438 mesg = ((msglist_T *)value)->throw_msg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439 if (cmdname != NULL && *cmdname != NUL)
440 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000441 cmdlen = (int)STRLEN(cmdname);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100442 ret = (char *)vim_strnsave((char_u *)"Vim(",
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200443 4 + cmdlen + 2 + STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100444 if (ret == NULL)
445 return ret;
446 STRCPY(&ret[4], cmdname);
447 STRCPY(&ret[4 + cmdlen], "):");
448 val = ret + 4 + cmdlen + 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449 }
450 else
451 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200452 ret = (char *)vim_strnsave((char_u *)"Vim:", 4 + STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100453 if (ret == NULL)
454 return ret;
455 val = ret + 4;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456 }
457
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100458 // msg_add_fname may have been used to prefix the message with a file
459 // name in quotes. In the exception value, put the file name in
460 // parentheses and move it to the end.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461 for (p = mesg; ; p++)
462 {
463 if (*p == NUL
464 || (*p == 'E'
465 && VIM_ISDIGIT(p[1])
466 && (p[2] == ':'
467 || (VIM_ISDIGIT(p[2])
468 && (p[3] == ':'
469 || (VIM_ISDIGIT(p[3])
470 && p[4] == ':'))))))
471 {
Bram Moolenaar051b7822005-05-19 21:00:46 +0000472 if (*p == NUL || p == mesg)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100473 STRCAT(val, mesg); // 'E123' missing or at beginning
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474 else
475 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100476 // '"filename" E123: message text'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477 if (mesg[0] != '"' || p-2 < &mesg[1] ||
478 p[-2] != '"' || p[-1] != ' ')
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100479 // "E123:" is part of the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000480 continue;
481
482 STRCAT(val, p);
483 p[-2] = NUL;
484 sprintf((char *)(val + STRLEN(p)), " (%s)", &mesg[1]);
485 p[-2] = '"';
486 }
487 break;
488 }
489 }
490 }
491 else
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100492 {
493 *should_free = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100494 ret = value;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100495 }
496
497 return ret;
498}
499
500
501/*
502 * Throw a new exception. Return FAIL when out of memory or it was tried to
503 * throw an illegal user exception. "value" is the exception string for a
504 * user or interrupt exception, or points to a message list in case of an
505 * error exception.
506 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100507 int
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100508throw_exception(void *value, except_type_T type, char_u *cmdname)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100509{
510 except_T *excp;
511 int should_free;
512
513 /*
514 * Disallow faking Interrupt or error exceptions as user exceptions. They
515 * would be treated differently from real interrupt or error exceptions
516 * when no active try block is found, see do_cmdline().
517 */
518 if (type == ET_USER)
519 {
520 if (STRNCMP((char_u *)value, "Vim", 3) == 0
521 && (((char_u *)value)[3] == NUL || ((char_u *)value)[3] == ':'
522 || ((char_u *)value)[3] == '('))
523 {
Bram Moolenaard88be5b2022-01-04 19:57:55 +0000524 emsg(_(e_cannot_throw_exceptions_with_vim_prefix));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100525 goto fail;
526 }
527 }
528
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200529 excp = ALLOC_ONE(except_T);
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100530 if (excp == NULL)
531 goto nomem;
532
533 if (type == ET_ERROR)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100534 // Store the original message and prefix the exception value with
535 // "Vim:" or, if a command name is given, "Vim(cmdname):".
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200536 excp->messages = (msglist_T *)value;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100537
538 excp->value = get_exception_string(value, type, cmdname, &should_free);
539 if (excp->value == NULL && should_free)
540 goto nomem;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
542 excp->type = type;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200543 if (type == ET_ERROR && ((msglist_T *)value)->sfile != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200545 msglist_T *entry = (msglist_T *)value;
546
547 excp->throw_name = entry->sfile;
548 entry->sfile = NULL;
549 excp->throw_lnum = entry->slnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 }
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200551 else
552 {
Bram Moolenaar4f25b1a2020-09-10 19:25:05 +0200553 excp->throw_name = estack_sfile(ESTACK_NONE);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200554 if (excp->throw_name == NULL)
555 excp->throw_name = vim_strsave((char_u *)"");
556 if (excp->throw_name == NULL)
557 {
558 if (should_free)
559 vim_free(excp->value);
560 goto nomem;
561 }
562 excp->throw_lnum = SOURCING_LNUM;
563 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
565 if (p_verbose >= 13 || debug_break_level > 0)
566 {
567 int save_msg_silent = msg_silent;
568
569 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100570 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000571 else
572 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000574 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100575 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000576
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100577 smsg(_("Exception thrown: %s"), excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100578 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000579
580 if (debug_break_level > 0 || *p_vfile == NUL)
581 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582 --no_wait_return;
583 if (debug_break_level > 0)
584 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000585 else
586 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587 }
588
589 current_exception = excp;
590 return OK;
591
592nomem:
593 vim_free(excp);
594 suppress_errthrow = TRUE;
Bram Moolenaare29a27f2021-07-20 21:07:36 +0200595 emsg(_(e_out_of_memory));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596fail:
597 current_exception = NULL;
598 return FAIL;
599}
600
601/*
602 * Discard an exception. "was_finished" is set when the exception has been
603 * caught and the catch clause has been ended normally.
604 */
605 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100606discard_exception(except_T *excp, int was_finished)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607{
608 char_u *saved_IObuff;
609
Bram Moolenaar13656f02020-12-19 17:55:54 +0100610 if (current_exception == excp)
611 current_exception = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 if (excp == NULL)
613 {
Bram Moolenaar95f09602016-11-10 20:01:45 +0100614 internal_error("discard_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 return;
616 }
617
618 if (p_verbose >= 13 || debug_break_level > 0)
619 {
620 int save_msg_silent = msg_silent;
621
622 saved_IObuff = vim_strsave(IObuff);
623 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100624 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000625 else
626 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000627 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000628 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100629 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar051b7822005-05-19 21:00:46 +0000630 smsg(was_finished
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100631 ? _("Exception finished: %s")
632 : _("Exception discarded: %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100634 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000635 if (debug_break_level > 0 || *p_vfile == NUL)
636 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637 --no_wait_return;
638 if (debug_break_level > 0)
639 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000640 else
641 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642 STRCPY(IObuff, saved_IObuff);
643 vim_free(saved_IObuff);
644 }
645 if (excp->type != ET_INTERRUPT)
646 vim_free(excp->value);
647 if (excp->type == ET_ERROR)
648 free_msglist(excp->messages);
649 vim_free(excp->throw_name);
650 vim_free(excp);
651}
652
653/*
654 * Discard the exception currently being thrown.
655 */
656 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100657discard_current_exception(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658{
Bram Moolenaarcae24be2017-07-10 22:12:10 +0200659 if (current_exception != NULL)
Bram Moolenaarcae24be2017-07-10 22:12:10 +0200660 discard_exception(current_exception, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 did_throw = FALSE;
662 need_rethrow = FALSE;
663}
664
665/*
666 * Put an exception on the caught stack.
667 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100668 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100669catch_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670{
671 excp->caught = caught_stack;
672 caught_stack = excp;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100673 set_vim_var_string(VV_EXCEPTION, (char_u *)excp->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 if (*excp->throw_name != NUL)
675 {
676 if (excp->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000677 vim_snprintf((char *)IObuff, IOSIZE, _("%s, line %ld"),
678 excp->throw_name, (long)excp->throw_lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000680 vim_snprintf((char *)IObuff, IOSIZE, "%s", excp->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
682 }
683 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100684 // throw_name not set on an exception from a command that was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 set_vim_var_string(VV_THROWPOINT, NULL, -1);
686
687 if (p_verbose >= 13 || debug_break_level > 0)
688 {
689 int save_msg_silent = msg_silent;
690
691 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100692 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000693 else
694 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000696 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100697 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000698
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100699 smsg(_("Exception caught: %s"), excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100700 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000701
702 if (debug_break_level > 0 || *p_vfile == NUL)
703 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704 --no_wait_return;
705 if (debug_break_level > 0)
706 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000707 else
708 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 }
710}
711
712/*
713 * Remove an exception from the caught stack.
714 */
715 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100716finish_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717{
718 if (excp != caught_stack)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100719 internal_error("finish_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 caught_stack = caught_stack->caught;
721 if (caught_stack != NULL)
722 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100723 set_vim_var_string(VV_EXCEPTION, (char_u *)caught_stack->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724 if (*caught_stack->throw_name != NUL)
725 {
726 if (caught_stack->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000727 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 _("%s, line %ld"), caught_stack->throw_name,
729 (long)caught_stack->throw_lnum);
730 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000731 vim_snprintf((char *)IObuff, IOSIZE, "%s",
732 caught_stack->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
734 }
735 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100736 // throw_name not set on an exception from a command that was
737 // typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 set_vim_var_string(VV_THROWPOINT, NULL, -1);
739 }
740 else
741 {
742 set_vim_var_string(VV_EXCEPTION, NULL, -1);
743 set_vim_var_string(VV_THROWPOINT, NULL, -1);
744 }
745
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100746 // Discard the exception, but use the finish message for 'verbose'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747 discard_exception(excp, TRUE);
748}
749
750/*
751 * Flags specifying the message displayed by report_pending.
752 */
753#define RP_MAKE 0
754#define RP_RESUME 1
755#define RP_DISCARD 2
756
757/*
758 * Report information about something pending in a finally clause if required by
759 * the 'verbose' option or when debugging. "action" tells whether something is
760 * made pending or something pending is resumed or discarded. "pending" tells
761 * what is pending. "value" specifies the return value for a pending ":return"
762 * or the exception value for a pending exception.
763 */
764 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100765report_pending(int action, int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100767 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 char *s;
769 int save_msg_silent;
770
771
772 switch (action)
773 {
774 case RP_MAKE:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100775 mesg = _("%s made pending");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 break;
777 case RP_RESUME:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100778 mesg = _("%s resumed");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100780 // case RP_DISCARD:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 default:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100782 mesg = _("%s discarded");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 break;
784 }
785
786 switch (pending)
787 {
788 case CSTP_NONE:
789 return;
790
791 case CSTP_CONTINUE:
792 s = ":continue";
793 break;
794 case CSTP_BREAK:
795 s = ":break";
796 break;
797 case CSTP_FINISH:
798 s = ":finish";
799 break;
800 case CSTP_RETURN:
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100801 // ":return" command producing value, allocated
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 s = (char *)get_return_cmd(value);
803 break;
804
805 default:
806 if (pending & CSTP_THROW)
807 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100808 vim_snprintf((char *)IObuff, IOSIZE, mesg, _("Exception"));
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200809 mesg = (char *)vim_strnsave(IObuff, STRLEN(IObuff) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 STRCAT(mesg, ": %s");
811 s = (char *)((except_T *)value)->value;
812 }
813 else if ((pending & CSTP_ERROR) && (pending & CSTP_INTERRUPT))
814 s = _("Error and interrupt");
815 else if (pending & CSTP_ERROR)
816 s = _("Error");
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100817 else // if (pending & CSTP_INTERRUPT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 s = _("Interrupt");
819 }
820
821 save_msg_silent = msg_silent;
822 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100823 msg_silent = FALSE; // display messages
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824 ++no_wait_return;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100825 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100826 smsg(mesg, s);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100827 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 cmdline_row = msg_row;
829 --no_wait_return;
830 if (debug_break_level > 0)
831 msg_silent = save_msg_silent;
832
833 if (pending == CSTP_RETURN)
834 vim_free(s);
835 else if (pending & CSTP_THROW)
836 vim_free(mesg);
837}
838
839/*
840 * If something is made pending in a finally clause, report it if required by
841 * the 'verbose' option or when debugging.
842 */
843 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100844report_make_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845{
846 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000847 {
848 if (debug_break_level <= 0)
849 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 report_pending(RP_MAKE, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000851 if (debug_break_level <= 0)
852 verbose_leave();
853 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854}
855
856/*
857 * If something pending in a finally clause is resumed at the ":endtry", report
858 * it if required by the 'verbose' option or when debugging.
859 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200860 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100861report_resume_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862{
863 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000864 {
865 if (debug_break_level <= 0)
866 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 report_pending(RP_RESUME, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000868 if (debug_break_level <= 0)
869 verbose_leave();
870 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871}
872
873/*
874 * If something pending in a finally clause is discarded, report it if required
875 * by the 'verbose' option or when debugging.
876 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200877 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100878report_discard_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879{
880 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000881 {
882 if (debug_break_level <= 0)
883 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884 report_pending(RP_DISCARD, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000885 if (debug_break_level <= 0)
886 verbose_leave();
887 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888}
889
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000890/*
Bram Moolenaar0d032632022-05-17 12:45:15 +0100891 * Return TRUE if "arg" is only a variable, register, environment variable,
892 * option name or string.
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000893 */
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200894 int
895cmd_is_name_only(char_u *arg)
896{
897 char_u *p = arg;
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000898 char_u *alias = NULL;
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200899 int name_only = FALSE;
900
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000901 if (*p == '@')
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200902 {
903 ++p;
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000904 if (*p != NUL)
905 ++p;
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200906 }
Bram Moolenaar0d032632022-05-17 12:45:15 +0100907 else if (*p == '\'' || *p == '"')
908 {
909 int r;
910
911 if (*p == '"')
912 r = eval_string(&p, NULL, FALSE, FALSE);
913 else
914 r = eval_lit_string(&p, NULL, FALSE, FALSE);
915 if (r == FAIL)
916 return FALSE;
917 }
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000918 else
919 {
920 if (*p == '&')
921 {
922 ++p;
923 if (STRNCMP("l:", p, 2) == 0 || STRNCMP("g:", p, 2) == 0)
924 p += 2;
925 }
Bram Moolenaar65259b52021-11-23 14:52:06 +0000926 else if (*p == '$')
927 ++p;
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000928 get_name_len(&p, &alias, FALSE, FALSE);
929 }
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200930 name_only = ends_excmd2(arg, skipwhite(p));
931 vim_free(alias);
932 return name_only;
933}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934
935/*
Bram Moolenaar25e42232019-08-04 15:04:10 +0200936 * ":eval".
937 */
938 void
939ex_eval(exarg_T *eap)
940{
941 typval_T tv;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200942 evalarg_T evalarg;
Bram Moolenaarc3235272021-07-10 19:42:03 +0200943 int name_only = FALSE;
Bram Moolenaarc3235272021-07-10 19:42:03 +0200944 long lnum = SOURCING_LNUM;
945
946 if (in_vim9script())
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200947 name_only = cmd_is_name_only(eap->arg);
Bram Moolenaar25e42232019-08-04 15:04:10 +0200948
Bram Moolenaare6b53242020-07-01 17:28:33 +0200949 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200950
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200951 if (eval0(eap->arg, &tv, eap, &evalarg) == OK)
Bram Moolenaarc3235272021-07-10 19:42:03 +0200952 {
Bram Moolenaar25e42232019-08-04 15:04:10 +0200953 clear_tv(&tv);
Bram Moolenaarea720382022-05-05 16:08:55 +0100954 if (in_vim9script() && name_only
955 && (evalarg.eval_tofree == NULL
956 || ends_excmd2(evalarg.eval_tofree,
957 skipwhite(evalarg.eval_tofree))))
958 {
959 SOURCING_LNUM = lnum;
Bram Moolenaarc3235272021-07-10 19:42:03 +0200960 semsg(_(e_expression_without_effect_str), eap->arg);
Bram Moolenaarea720382022-05-05 16:08:55 +0100961 }
Bram Moolenaarc3235272021-07-10 19:42:03 +0200962 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +0200963
964 clear_evalarg(&evalarg, eap);
Bram Moolenaar25e42232019-08-04 15:04:10 +0200965}
966
967/*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200968 * Start a new scope/block. Caller should have checked that cs_idx is not
969 * exceeding CSTACK_LEN.
970 */
971 static void
972enter_block(cstack_T *cstack)
973{
974 ++cstack->cs_idx;
Bram Moolenaar0abc6e42021-02-26 22:21:23 +0100975 if (in_vim9script() && current_sctx.sc_sid > 0)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200976 {
977 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
978
979 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200980 cstack->cs_block_id[cstack->cs_idx] = ++si->sn_last_block_id;
981 si->sn_current_block_id = si->sn_last_block_id;
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200982 }
Bram Moolenaar3e492c22021-01-27 21:37:13 +0100983 else
984 {
985 // Just in case in_vim9script() does not return the same value when the
986 // block ends.
987 cstack->cs_script_var_len[cstack->cs_idx] = 0;
988 cstack->cs_block_id[cstack->cs_idx] = 0;
989 }
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200990}
991
992 static void
993leave_block(cstack_T *cstack)
994{
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200995 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200996 {
Bram Moolenaard7475482020-10-10 20:31:37 +0200997 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200998 int i;
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200999 int func_defined =
1000 cstack->cs_flags[cstack->cs_idx] & CSF_FUNC_DEF;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001001
Bram Moolenaar8d739de2020-10-14 19:39:19 +02001002 for (i = cstack->cs_script_var_len[cstack->cs_idx];
Bram Moolenaard7475482020-10-10 20:31:37 +02001003 i < si->sn_var_vals.ga_len; ++i)
Bram Moolenaar8d739de2020-10-14 19:39:19 +02001004 {
1005 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
Bram Moolenaard7475482020-10-10 20:31:37 +02001006
Bram Moolenaar39ca4122020-10-20 14:25:07 +02001007 // sv_name is set to NULL if it was already removed. This happens
1008 // when it was defined in an inner block and no functions were
1009 // defined there.
Bram Moolenaar8d739de2020-10-14 19:39:19 +02001010 if (sv->sv_name != NULL)
1011 // Remove a variable declared inside the block, if it still
Bram Moolenaar39ca4122020-10-20 14:25:07 +02001012 // exists, from sn_vars and move the value into sn_all_vars
1013 // if "func_defined" is non-zero.
1014 hide_script_var(si, i, func_defined);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001015 }
Bram Moolenaar8d739de2020-10-14 19:39:19 +02001016
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001017 if (cstack->cs_idx == 0)
1018 si->sn_current_block_id = 0;
1019 else
1020 si->sn_current_block_id = cstack->cs_block_id[cstack->cs_idx - 1];
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001021 }
1022 --cstack->cs_idx;
1023}
1024
1025/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026 * ":if".
1027 */
1028 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001029ex_if(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030{
1031 int error;
1032 int skip;
1033 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001034 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035
1036 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001037 eap->errmsg = _(e_if_nesting_too_deep);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 else
1039 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001040 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041 cstack->cs_flags[cstack->cs_idx] = 0;
1042
1043 /*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001044 * Don't do something after an error, interrupt, or throw, or when
1045 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001046 */
1047 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1048 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1049
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001050 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051
1052 if (!skip && !error)
1053 {
1054 if (result)
1055 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1056 }
1057 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001058 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1060 }
1061}
1062
1063/*
1064 * ":endif".
1065 */
1066 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001067ex_endif(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068{
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001069 cstack_T *cstack = eap->cstack;
1070
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001071 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001072 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 did_endif = TRUE;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001074 if (cstack->cs_idx < 0
1075 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001076 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001077 eap->errmsg = _(e_endif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 else
1079 {
1080 /*
1081 * When debugging or a breakpoint was encountered, display the debug
1082 * prompt (if not already done). This shows the user that an ":endif"
1083 * is executed when the ":if" or a previous ":elseif" was not TRUE.
1084 * Handle a ">quit" debug command as if an interrupt had occurred before
1085 * the ":endif". That is, throw an interrupt exception if appropriate.
1086 * Doing this here prevents an exception for a parsing error being
1087 * discarded by throwing the interrupt exception later on.
1088 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001089 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001090 && dbg_check_skipped(eap))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001091 (void)do_intthrow(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001092
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001093 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001094 }
1095}
1096
1097/*
1098 * ":else" and ":elseif".
1099 */
1100 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001101ex_else(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102{
1103 int error;
1104 int skip;
1105 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001106 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107
1108 /*
1109 * Don't do something after an error, interrupt, or throw, or when there is
1110 * a surrounding conditional and it was not active.
1111 */
1112 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1113 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1114
1115 if (cstack->cs_idx < 0
Bram Moolenaar12805862005-01-05 22:16:17 +00001116 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001117 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118 {
1119 if (eap->cmdidx == CMD_else)
1120 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001121 eap->errmsg = _(e_else_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 return;
1123 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001124 eap->errmsg = _(e_elseif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 skip = TRUE;
1126 }
1127 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
1128 {
1129 if (eap->cmdidx == CMD_else)
1130 {
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001131 eap->errmsg = _(e_multiple_else);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 return;
1133 }
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001134 eap->errmsg = _(e_elseif_after_else);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135 skip = TRUE;
1136 }
1137
Bram Moolenaar434725c2022-05-06 11:27:52 +01001138 if (cstack->cs_idx >= 0)
1139 {
1140 // Variables declared in the previous block can no longer be
1141 // used. Needs to be done before setting "cs_flags".
1142 leave_block(cstack);
1143 enter_block(cstack);
1144 }
Bram Moolenaar505ed0c2022-05-05 17:02:46 +01001145
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001146 // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
1148 {
1149 if (eap->errmsg == NULL)
1150 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001151 skip = TRUE; // don't evaluate an ":elseif"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 }
1153 else
1154 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1155
1156 /*
1157 * When debugging or a breakpoint was encountered, display the debug prompt
1158 * (if not already done). This shows the user that an ":else" or ":elseif"
1159 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle
1160 * a ">quit" debug command as if an interrupt had occurred before the
1161 * ":else" or ":elseif". That is, set "skip" and throw an interrupt
1162 * exception if appropriate. Doing this here prevents that an exception
1163 * for a parsing errors is discarded when throwing the interrupt exception
1164 * later on.
1165 */
1166 if (!skip && dbg_check_skipped(eap) && got_int)
1167 {
1168 (void)do_intthrow(cstack);
1169 skip = TRUE;
1170 }
1171
1172 if (eap->cmdidx == CMD_elseif)
1173 {
Bram Moolenaarfa010cd2022-04-03 16:13:07 +01001174 // When skipping we ignore most errors, but a missing expression is
1175 // wrong, perhaps it should have been "else".
1176 if (skip && ends_excmd(*eap->arg))
1177 semsg(_(e_invalid_expression_str), eap->arg);
1178 else
1179 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001180
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001181 // When throwing error exceptions, we want to throw always the first
1182 // of several errors in a row. This is what actually happens when
1183 // a conditional error was detected above and there is another failure
1184 // when parsing the expression. Since the skip flag is set in this
1185 // case, the parsing error will be ignored by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001186 if (!skip && !error)
1187 {
1188 if (result)
1189 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1190 else
1191 cstack->cs_flags[cstack->cs_idx] = 0;
1192 }
1193 else if (eap->errmsg == NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001194 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1196 }
1197 else
1198 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1199}
1200
1201/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001202 * Handle ":while" and ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001203 */
1204 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001205ex_while(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001206{
1207 int error;
1208 int skip;
1209 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001210 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001211
1212 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001213 eap->errmsg = _(e_while_for_nesting_too_deep);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001214 else
1215 {
1216 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001217 * The loop flag is set when we have jumped back from the matching
1218 * ":endwhile" or ":endfor". When not set, need to initialise this
1219 * cstack entry.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001221 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001222 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001223 enter_block(cstack);
Bram Moolenaar12805862005-01-05 22:16:17 +00001224 ++cstack->cs_looplevel;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 cstack->cs_line[cstack->cs_idx] = -1;
1226 }
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001227 else
1228 {
1229 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
1230 {
1231 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
1232 int i;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001233 int func_defined = cstack->cs_flags[cstack->cs_idx]
1234 & CSF_FUNC_DEF;
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001235
1236 // Any variables defined in the previous round are no longer
Bram Moolenaar7a53f292021-11-22 18:31:02 +00001237 // visible. Keep the first one for ":for", it is the loop
1238 // variable that we reuse every time around.
1239 for (i = cstack->cs_script_var_len[cstack->cs_idx]
1240 + (eap->cmdidx == CMD_while ? 0 : 1);
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001241 i < si->sn_var_vals.ga_len; ++i)
1242 {
1243 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
1244
1245 // sv_name is set to NULL if it was already removed. This
1246 // happens when it was defined in an inner block and no
1247 // functions were defined there.
1248 if (sv->sv_name != NULL)
1249 // Remove a variable declared inside the block, if it
1250 // still exists, from sn_vars.
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001251 hide_script_var(si, i, func_defined);
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001252 }
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001253 }
1254 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001255 cstack->cs_flags[cstack->cs_idx] =
1256 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001257
1258 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001259 * Don't do something after an error, interrupt, or throw, or when
1260 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261 */
1262 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1263 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
Bram Moolenaar12805862005-01-05 22:16:17 +00001264 if (eap->cmdidx == CMD_while)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001266 /*
1267 * ":while bool-expr"
1268 */
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001269 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 }
1271 else
1272 {
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001273 void *fi;
1274 evalarg_T evalarg;
1275
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001276 /*
1277 * ":for var in list-expr"
1278 */
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001279 fill_evalarg_from_eap(&evalarg, eap, skip);
Bram Moolenaar12805862005-01-05 22:16:17 +00001280 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
1281 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001282 // Jumping here from a ":continue" or ":endfor": use the
1283 // previously evaluated list.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001284 fi = cstack->cs_forinfo[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001285 error = FALSE;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001286
1287 // the "in expr" is not used, skip over it
1288 skip_for_lines(fi, &evalarg);
Bram Moolenaar12805862005-01-05 22:16:17 +00001289 }
1290 else
1291 {
Bram Moolenaard4ab8072021-07-08 19:22:12 +02001292 long save_lnum = SOURCING_LNUM;
1293
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001294 // Evaluate the argument and get the info in a structure.
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001295 fi = eval_for_line(eap->arg, &error, eap, &evalarg);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001296 cstack->cs_forinfo[cstack->cs_idx] = fi;
Bram Moolenaard4ab8072021-07-08 19:22:12 +02001297
1298 // Errors should use the first line number.
1299 SOURCING_LNUM = save_lnum;
Bram Moolenaar12805862005-01-05 22:16:17 +00001300 }
1301
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001302 // use the element at the start of the list and advance
Bram Moolenaar12805862005-01-05 22:16:17 +00001303 if (!error && fi != NULL && !skip)
1304 result = next_for_item(fi, eap->arg);
1305 else
1306 result = FALSE;
1307
1308 if (!result)
1309 {
1310 free_for_info(fi);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001311 cstack->cs_forinfo[cstack->cs_idx] = NULL;
Bram Moolenaar12805862005-01-05 22:16:17 +00001312 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001313 clear_evalarg(&evalarg, eap);
Bram Moolenaar12805862005-01-05 22:16:17 +00001314 }
1315
1316 /*
1317 * If this cstack entry was just initialised and is active, set the
1318 * loop flag, so do_cmdline() will set the line number in cs_line[].
1319 * If executing the command a second time, clear the loop flag.
1320 */
1321 if (!skip && !error && result)
1322 {
1323 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
1324 cstack->cs_lflags ^= CSL_HAD_LOOP;
1325 }
1326 else
1327 {
1328 cstack->cs_lflags &= ~CSL_HAD_LOOP;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001329 // If the ":while" evaluates to FALSE or ":for" is past the end of
1330 // the list, show the debug prompt at the ":endwhile"/":endfor" as
1331 // if there was a ":break" in a ":while"/":for" evaluating to
1332 // TRUE.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 if (!skip && !error)
1334 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1335 }
1336 }
1337}
1338
1339/*
1340 * ":continue"
1341 */
1342 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001343ex_continue(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001344{
1345 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001346 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347
Bram Moolenaar12805862005-01-05 22:16:17 +00001348 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar3a846e62022-01-01 16:21:00 +00001349 eap->errmsg = _(e_continue_without_while_or_for);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 else
1351 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001352 // Try to find the matching ":while". This might stop at a try
1353 // conditional not in its finally clause (which is then to be executed
Bram Moolenaarc3235272021-07-10 19:42:03 +02001354 // next). Therefore, inactivate all conditionals except the ":while"
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001355 // itself (if reached).
Bram Moolenaar12805862005-01-05 22:16:17 +00001356 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001357 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 {
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001359 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001360
1361 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001362 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 * matching ":while".
1364 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001365 cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 }
1367 else
1368 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001369 // If a try conditional not in its finally clause is reached first,
1370 // make the ":continue" pending for execution at the ":endtry".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 cstack->cs_pending[idx] = CSTP_CONTINUE;
1372 report_make_pending(CSTP_CONTINUE, NULL);
1373 }
1374 }
1375}
1376
1377/*
1378 * ":break"
1379 */
1380 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001381ex_break(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001382{
1383 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001384 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001385
Bram Moolenaar12805862005-01-05 22:16:17 +00001386 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar3a846e62022-01-01 16:21:00 +00001387 eap->errmsg = _(e_break_without_while_or_for);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 else
1389 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001390 // Inactivate conditionals until the matching ":while" or a try
1391 // conditional not in its finally clause (which is then to be
1392 // executed next) is found. In the latter case, make the ":break"
1393 // pending for execution at the ":endtry".
Bram Moolenaar12805862005-01-05 22:16:17 +00001394 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001395 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001396 {
1397 cstack->cs_pending[idx] = CSTP_BREAK;
1398 report_make_pending(CSTP_BREAK, NULL);
1399 }
1400 }
1401}
1402
1403/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001404 * ":endwhile" and ":endfor"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 */
1406 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001407ex_endwhile(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408{
Bram Moolenaarddef1292019-12-16 17:10:33 +01001409 cstack_T *cstack = eap->cstack;
1410 int idx;
1411 char *err;
1412 int csf;
1413 int fl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001415 if (cmdmod_error(TRUE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001416 return;
1417
Bram Moolenaar12805862005-01-05 22:16:17 +00001418 if (eap->cmdidx == CMD_endwhile)
1419 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001420 err = e_endwhile_without_while;
Bram Moolenaar12805862005-01-05 22:16:17 +00001421 csf = CSF_WHILE;
1422 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 else
1424 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001425 err = e_endfor_without_for;
Bram Moolenaar12805862005-01-05 22:16:17 +00001426 csf = CSF_FOR;
1427 }
1428
1429 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001430 eap->errmsg = _(err);
Bram Moolenaar12805862005-01-05 22:16:17 +00001431 else
1432 {
Bram Moolenaarcce81e92021-10-06 22:08:11 +01001433 fl = cstack->cs_flags[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001434 if (!(fl & csf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001436 // If we are in a ":while" or ":for" but used the wrong endloop
1437 // command, do not rewind to the next enclosing ":for"/":while".
Bram Moolenaar12805862005-01-05 22:16:17 +00001438 if (fl & CSF_WHILE)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001439 eap->errmsg = _(e_using_endfor_with_while);
Bram Moolenaar12805862005-01-05 22:16:17 +00001440 else if (fl & CSF_FOR)
Bram Moolenaara6f79292022-01-04 21:30:47 +00001441 eap->errmsg = _(e_using_endwhile_with_for);
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00001442 }
1443 if (!(fl & (CSF_WHILE | CSF_FOR)))
1444 {
1445 if (!(fl & CSF_TRY))
Bram Moolenaar1a992222021-12-31 17:25:48 +00001446 eap->errmsg = _(e_missing_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00001447 else if (fl & CSF_FINALLY)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001448 eap->errmsg = _(e_missing_endtry);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001449 // Try to find the matching ":while" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450 for (idx = cstack->cs_idx; idx > 0; --idx)
1451 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001452 fl = cstack->cs_flags[idx];
1453 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001455 // Give up at a try conditional not in its finally clause.
1456 // Ignore the ":endwhile"/":endfor".
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001457 eap->errmsg = _(err);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 return;
1459 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001460 if (fl & csf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 break;
1462 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001463 // Cleanup and rewind all contained (and unclosed) conditionals.
Bram Moolenaar12805862005-01-05 22:16:17 +00001464 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1466 }
1467
1468 /*
1469 * When debugging or a breakpoint was encountered, display the debug
1470 * prompt (if not already done). This shows the user that an
Bram Moolenaar12805862005-01-05 22:16:17 +00001471 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
1472 * after a ":break". Handle a ">quit" debug command as if an
1473 * interrupt had occurred before the ":endwhile"/":endfor". That is,
1474 * throw an interrupt exception if appropriate. Doing this here
1475 * prevents that an exception for a parsing error is discarded when
1476 * throwing the interrupt exception later on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001477 */
1478 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1479 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1480 && dbg_check_skipped(eap))
1481 (void)do_intthrow(cstack);
1482
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001483 // Set loop flag, so do_cmdline() will jump back to the matching
1484 // ":while" or ":for".
Bram Moolenaar12805862005-01-05 22:16:17 +00001485 cstack->cs_lflags |= CSL_HAD_ENDLOOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001486 }
1487}
1488
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001489/*
1490 * "{" start of a block in Vim9 script
1491 */
1492 void
1493ex_block(exarg_T *eap)
1494{
1495 cstack_T *cstack = eap->cstack;
1496
1497 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001498 eap->errmsg = _(e_block_nesting_too_deep);
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001499 else
1500 {
1501 enter_block(cstack);
1502 cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE;
1503 }
1504}
1505
1506/*
1507 * "}" end of a block in Vim9 script
1508 */
1509 void
1510ex_endblock(exarg_T *eap)
1511{
1512 cstack_T *cstack = eap->cstack;
1513
1514 if (cstack->cs_idx < 0
1515 || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0)
1516 eap->errmsg = _(e_endblock_without_block);
1517 else
1518 leave_block(cstack);
1519}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520
Bram Moolenaar63b91732021-08-05 20:40:03 +02001521 int
1522inside_block(exarg_T *eap)
1523{
1524 cstack_T *cstack = eap->cstack;
1525 int i;
1526
1527 for (i = 0; i <= cstack->cs_idx; ++i)
1528 if (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK)
1529 return TRUE;
1530 return FALSE;
1531}
1532
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533/*
1534 * ":throw expr"
1535 */
1536 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001537ex_throw(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538{
1539 char_u *arg = eap->arg;
1540 char_u *value;
1541
1542 if (*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001543 value = eval_to_string_skip(arg, eap, eap->skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 else
1545 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001546 emsg(_(e_argument_required));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 value = NULL;
1548 }
1549
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001550 // On error or when an exception is thrown during argument evaluation, do
1551 // not throw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 if (!eap->skip && value != NULL)
1553 {
1554 if (throw_exception(value, ET_USER, NULL) == FAIL)
1555 vim_free(value);
1556 else
1557 do_throw(eap->cstack);
1558 }
1559}
1560
1561/*
Bram Moolenaar269ec652004-07-29 08:43:53 +00001562 * Throw the current exception through the specified cstack. Common routine
1563 * for ":throw" (user exception) and error and interrupt exceptions. Also
1564 * used for rethrowing an uncaught exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 */
1566 void
Bram Moolenaarddef1292019-12-16 17:10:33 +01001567do_throw(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568{
1569 int idx;
1570 int inactivate_try = FALSE;
1571
1572 /*
1573 * Cleanup and inactivate up to the next surrounding try conditional that
1574 * is not in its finally clause. Normally, do not inactivate the try
1575 * conditional itself, so that its ACTIVE flag can be tested below. But
1576 * if a previous error or interrupt has not been converted to an exception,
1577 * inactivate the try conditional, too, as if the conversion had been done,
Bram Moolenaar269ec652004-07-29 08:43:53 +00001578 * and reset the did_emsg or got_int flag, so this won't happen again at
1579 * the next surrounding try conditional.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 */
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001581#ifndef THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 if (did_emsg && !THROW_ON_ERROR)
1583 {
1584 inactivate_try = TRUE;
1585 did_emsg = FALSE;
1586 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001587#endif
1588#ifndef THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 if (got_int && !THROW_ON_INTERRUPT)
1590 {
1591 inactivate_try = TRUE;
1592 got_int = FALSE;
1593 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001594#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001595 idx = cleanup_conditionals(cstack, 0, inactivate_try);
1596 if (idx >= 0)
1597 {
1598 /*
1599 * If this try conditional is active and we are before its first
Bram Moolenaar269ec652004-07-29 08:43:53 +00001600 * ":catch", set THROWN so that the ":catch" commands will check
1601 * whether the exception matches. When the exception came from any of
1602 * the catch clauses, it will be made pending at the ":finally" (if
1603 * present) and rethrown at the ":endtry". This will also happen if
1604 * the try conditional is inactive. This is the case when we are
1605 * throwing an exception due to an error or interrupt on the way from
1606 * a preceding ":continue", ":break", ":return", ":finish", error or
1607 * interrupt (not converted to an exception) to the finally clause or
1608 * from a preceding throw of a user or error or interrupt exception to
1609 * the matching catch clause or the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001610 */
1611 if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1612 {
1613 if (cstack->cs_flags[idx] & CSF_ACTIVE)
1614 cstack->cs_flags[idx] |= CSF_THROWN;
1615 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001616 // THROWN may have already been set for a catchable exception
1617 // that has been discarded. Ensure it is reset for the new
1618 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619 cstack->cs_flags[idx] &= ~CSF_THROWN;
1620 }
1621 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1622 cstack->cs_exception[idx] = current_exception;
1623 }
1624#if 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001625 // TODO: Add optimization below. Not yet done because of interface
1626 // problems to eval.c and ex_cmds2.c. (Servatius)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001627 else
1628 {
1629 /*
1630 * There are no catch clauses to check or finally clauses to execute.
1631 * End the current script or function. The exception will be rethrown
1632 * in the caller.
1633 */
1634 if (getline_equal(eap->getline, eap->cookie, get_func_line))
1635 current_funccal->returned = TRUE;
1636 elseif (eap->get_func_line == getsourceline)
1637 ((struct source_cookie *)eap->cookie)->finished = TRUE;
1638 }
1639#endif
1640
1641 did_throw = TRUE;
1642}
1643
1644/*
1645 * ":try"
1646 */
1647 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001648ex_try(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001649{
1650 int skip;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001651 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001653 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001654 return;
1655
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaard88be5b2022-01-04 19:57:55 +00001657 eap->errmsg = _(e_try_nesting_too_deep);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658 else
1659 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001660 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 ++cstack->cs_trylevel;
1662 cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1663 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1664
1665 /*
1666 * Don't do something after an error, interrupt, or throw, or when there
1667 * is a surrounding conditional and it was not active.
1668 */
1669 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1670 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1671
1672 if (!skip)
1673 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001674 // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch"
1675 // commands should check for a match if an exception is thrown and
1676 // that the finally clause needs to be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1678
1679 /*
1680 * ":silent!", even when used in a try conditional, disables
1681 * displaying of error messages and conversion of errors to
1682 * exceptions. When the silent commands again open a try
1683 * conditional, save "emsg_silent" and reset it so that errors are
1684 * again converted to exceptions. The value is restored when that
1685 * try conditional is left. If it is left normally, the commands
1686 * following the ":endtry" are again silent. If it is left by
1687 * a ":continue", ":break", ":return", or ":finish", the commands
1688 * executed next are again silent. If it is left due to an
1689 * aborting error, an interrupt, or an exception, restoring
1690 * "emsg_silent" does not matter since we are already in the
1691 * aborting state and/or the exception has already been thrown.
1692 * The effect is then just freeing the memory that was allocated
1693 * to save the value.
1694 */
1695 if (emsg_silent)
1696 {
1697 eslist_T *elem;
1698
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001699 elem = ALLOC_ONE(struct eslist_elem);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 if (elem == NULL)
Bram Moolenaare29a27f2021-07-20 21:07:36 +02001701 emsg(_(e_out_of_memory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 else
1703 {
1704 elem->saved_emsg_silent = emsg_silent;
1705 elem->next = cstack->cs_emsg_silent_list;
1706 cstack->cs_emsg_silent_list = elem;
1707 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1708 emsg_silent = 0;
1709 }
1710 }
1711 }
1712
1713 }
1714}
1715
1716/*
1717 * ":catch /{pattern}/" and ":catch"
1718 */
1719 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001720ex_catch(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721{
1722 int idx = 0;
1723 int give_up = FALSE;
1724 int skip = FALSE;
1725 int caught = FALSE;
1726 char_u *end;
1727 int save_char = 0;
1728 char_u *save_cpo;
1729 regmatch_T regmatch;
1730 int prev_got_int;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001731 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 char_u *pat;
1733
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001734 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001735 return;
1736
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1738 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001739 eap->errmsg = _(e_catch_without_try);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 give_up = TRUE;
1741 }
1742 else
1743 {
1744 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1745 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001746 // Report what's missing if the matching ":try" is not in its
1747 // finally clause.
Bram Moolenaar12805862005-01-05 22:16:17 +00001748 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 skip = TRUE;
1750 }
1751 for (idx = cstack->cs_idx; idx > 0; --idx)
1752 if (cstack->cs_flags[idx] & CSF_TRY)
1753 break;
Bram Moolenaar41978282021-07-04 14:47:30 +02001754 if (cstack->cs_flags[idx] & CSF_TRY)
1755 cstack->cs_flags[idx] |= CSF_CATCH;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756 if (cstack->cs_flags[idx] & CSF_FINALLY)
1757 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001758 // Give up for a ":catch" after ":finally" and ignore it.
1759 // Just parse.
Bram Moolenaard88be5b2022-01-04 19:57:55 +00001760 eap->errmsg = _(e_catch_after_finally);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 give_up = TRUE;
1762 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001763 else
Bram Moolenaar12805862005-01-05 22:16:17 +00001764 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1765 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766 }
1767
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001768 if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 {
1770 pat = (char_u *)".*";
1771 end = NULL;
1772 eap->nextcmd = find_nextcmd(eap->arg);
1773 }
1774 else
1775 {
1776 pat = eap->arg + 1;
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001777 end = skip_regexp_err(pat, *eap->arg, TRUE);
1778 if (end == NULL)
1779 give_up = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 }
1781
1782 if (!give_up)
1783 {
1784 /*
1785 * Don't do something when no exception has been thrown or when the
1786 * corresponding try block never got active (because of an inactive
1787 * surrounding conditional or after an error or interrupt or throw).
1788 */
1789 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1790 skip = TRUE;
1791
1792 /*
1793 * Check for a match only if an exception is thrown but not caught by
1794 * a previous ":catch". An exception that has replaced a discarded
1795 * exception is not checked (THROWN is not set then).
1796 */
1797 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1798 && !(cstack->cs_flags[idx] & CSF_CAUGHT))
1799 {
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001800 if (end != NULL && *end != NUL
1801 && !ends_excmd2(end, skipwhite(end + 1)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001802 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001803 semsg(_(e_trailing_characters_str), end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 return;
1805 }
1806
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001807 // When debugging or a breakpoint was encountered, display the
1808 // debug prompt (if not already done) before checking for a match.
1809 // This is a helpful hint for the user when the regular expression
1810 // matching fails. Handle a ">quit" debug command as if an
1811 // interrupt had occurred before the ":catch". That is, discard
1812 // the original exception, replace it by an interrupt exception,
1813 // and don't catch it in this try block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001814 if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1815 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001816 // Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1817 // while compiling it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 if (end != NULL)
1819 {
1820 save_char = *end;
1821 *end = NUL;
1822 }
1823 save_cpo = p_cpo;
Bram Moolenaare5a2dc82021-01-03 19:52:05 +01001824 p_cpo = empty_option;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001825 // Disable error messages, it will make current_exception
1826 // invalid.
Bram Moolenaar768ce242016-02-07 19:46:12 +01001827 ++emsg_off;
Bram Moolenaar150cc272007-08-01 13:47:46 +00001828 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
Bram Moolenaar768ce242016-02-07 19:46:12 +01001829 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 regmatch.rm_ic = FALSE;
1831 if (end != NULL)
1832 *end = save_char;
1833 p_cpo = save_cpo;
1834 if (regmatch.regprog == NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001835 semsg(_(e_invalid_argument_str), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 else
1837 {
1838 /*
1839 * Save the value of got_int and reset it. We don't want
1840 * a previous interruption cancel matching, only hitting
1841 * CTRL-C while matching should abort it.
1842 */
1843 prev_got_int = got_int;
1844 got_int = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001845 caught = vim_regexec_nl(&regmatch,
1846 (char_u *)current_exception->value, (colnr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001847 got_int |= prev_got_int;
Bram Moolenaar473de612013-06-08 18:19:48 +02001848 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849 }
1850 }
1851 }
1852
1853 if (caught)
1854 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001855 // Make this ":catch" clause active and reset did_emsg, got_int,
1856 // and did_throw. Put the exception on the caught stack.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1858 did_emsg = got_int = did_throw = FALSE;
1859 catch_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar28bf6492022-03-03 15:11:20 +00001860
1861 if (cstack->cs_idx >= 0
1862 && (cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1863 {
1864 // Variables declared in the previous block can no longer be
1865 // used.
1866 leave_block(cstack);
1867 enter_block(cstack);
1868 }
1869
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001870 // It's mandatory that the current exception is stored in the cstack
1871 // so that it can be discarded at the next ":catch", ":finally", or
1872 // ":endtry" or when the catch clause is left by a ":continue",
1873 // ":break", ":return", ":finish", error, interrupt, or another
1874 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 if (cstack->cs_exception[cstack->cs_idx] != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001876 internal_error("ex_catch()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877 }
1878 else
1879 {
1880 /*
1881 * If there is a preceding catch clause and it caught the exception,
1882 * finish the exception now. This happens also after errors except
1883 * when this ":catch" was after the ":finally" or not within
1884 * a ":try". Make the try conditional inactive so that the
1885 * following catch clauses are skipped. On an error or interrupt
1886 * after the preceding try block or catch clause was left by
1887 * a ":continue", ":break", ":return", or ":finish", discard the
1888 * pending action.
1889 */
1890 cleanup_conditionals(cstack, CSF_TRY, TRUE);
1891 }
1892 }
1893
1894 if (end != NULL)
1895 eap->nextcmd = find_nextcmd(end);
1896}
1897
1898/*
1899 * ":finally"
1900 */
1901 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001902ex_finally(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001903{
1904 int idx;
1905 int skip = FALSE;
1906 int pending = CSTP_NONE;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001907 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001909 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001910 return;
1911
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001913 eap->errmsg = _(e_finally_without_try);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 else
1915 {
1916 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1917 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001918 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1920 if (cstack->cs_flags[idx] & CSF_TRY)
1921 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001922 // Make this error pending, so that the commands in the following
1923 // finally clause can be executed. This overrules also a pending
1924 // ":continue", ":break", ":return", or ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 pending = CSTP_ERROR;
1926 }
1927 else
1928 idx = cstack->cs_idx;
1929
1930 if (cstack->cs_flags[idx] & CSF_FINALLY)
1931 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001932 // Give up for a multiple ":finally" and ignore it.
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001933 eap->errmsg = _(e_multiple_finally);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001934 return;
1935 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001936 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
Bram Moolenaar12805862005-01-05 22:16:17 +00001937 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001938
1939 /*
1940 * Don't do something when the corresponding try block never got active
1941 * (because of an inactive surrounding conditional or after an error or
1942 * interrupt or throw) or for a ":finally" without ":try" or a multiple
1943 * ":finally". After every other error (did_emsg or the conditional
1944 * errors detected above) or after an interrupt (got_int) or an
1945 * exception (did_throw), the finally clause must be executed.
1946 */
1947 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1948
1949 if (!skip)
1950 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001951 // When debugging or a breakpoint was encountered, display the
1952 // debug prompt (if not already done). The user then knows that the
1953 // finally clause is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 if (dbg_check_skipped(eap))
1955 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001956 // Handle a ">quit" debug command as if an interrupt had
1957 // occurred before the ":finally". That is, discard the
1958 // original exception and replace it by an interrupt
1959 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001960 (void)do_intthrow(cstack);
1961 }
1962
1963 /*
1964 * If there is a preceding catch clause and it caught the exception,
1965 * finish the exception now. This happens also after errors except
1966 * when this is a multiple ":finally" or one not within a ":try".
1967 * After an error or interrupt, this also discards a pending
1968 * ":continue", ":break", ":finish", or ":return" from the preceding
1969 * try block or catch clause.
1970 */
1971 cleanup_conditionals(cstack, CSF_TRY, FALSE);
1972
Bram Moolenaar28bf6492022-03-03 15:11:20 +00001973 if (cstack->cs_idx >= 0
1974 && (cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1975 {
1976 // Variables declared in the previous block can no longer be
1977 // used.
1978 leave_block(cstack);
1979 enter_block(cstack);
1980 }
1981
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 /*
1983 * Make did_emsg, got_int, did_throw pending. If set, they overrule
1984 * a pending ":continue", ":break", ":return", or ":finish". Then
1985 * we have particularly to discard a pending return value (as done
1986 * by the call to cleanup_conditionals() above when did_emsg or
1987 * got_int is set). The pending values are restored by the
1988 * ":endtry", except if there is a new error, interrupt, exception,
1989 * ":continue", ":break", ":return", or ":finish" in the following
Bram Moolenaar12805862005-01-05 22:16:17 +00001990 * finally clause. A missing ":endwhile", ":endfor" or ":endif"
1991 * detected here is treated as if did_emsg and did_throw had
1992 * already been set, respectively in case that the error is not
1993 * converted to an exception, did_throw had already been unset.
1994 * We must not set did_emsg here since that would suppress the
1995 * error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 */
1997 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1998 {
1999 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
2000 {
2001 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002002 cstack->cs_rettv[cstack->cs_idx]);
2003 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004 }
2005 if (pending == CSTP_ERROR && !did_emsg)
2006 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
2007 else
2008 pending |= did_throw ? CSTP_THROW : 0;
2009 pending |= did_emsg ? CSTP_ERROR : 0;
2010 pending |= got_int ? CSTP_INTERRUPT : 0;
2011 cstack->cs_pending[cstack->cs_idx] = pending;
2012
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002013 // It's mandatory that the current exception is stored in the
2014 // cstack so that it can be rethrown at the ":endtry" or be
2015 // discarded if the finally clause is left by a ":continue",
2016 // ":break", ":return", ":finish", error, interrupt, or another
2017 // exception. When emsg() is called for a missing ":endif" or
2018 // a missing ":endwhile"/":endfor" detected here, the
2019 // exception will be discarded.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002020 if (did_throw && cstack->cs_exception[cstack->cs_idx]
2021 != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01002022 internal_error("ex_finally()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 }
2024
2025 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00002026 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
Bram Moolenaard4755bb2004-09-02 19:12:26 +00002027 * got_int, and did_throw and make the finally clause active.
2028 * This will happen after emsg() has been called for a missing
Bram Moolenaar12805862005-01-05 22:16:17 +00002029 * ":endif" or a missing ":endwhile"/":endfor" detected here, so
2030 * that the following finally clause will be executed even then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 */
Bram Moolenaar12805862005-01-05 22:16:17 +00002032 cstack->cs_lflags |= CSL_HAD_FINA;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 }
2034 }
2035}
2036
2037/*
2038 * ":endtry"
2039 */
2040 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002041ex_endtry(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002042{
2043 int idx;
2044 int skip;
2045 int rethrow = FALSE;
2046 int pending = CSTP_NONE;
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002047 void *rettv = NULL;
Bram Moolenaarddef1292019-12-16 17:10:33 +01002048 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049
Bram Moolenaar917c46a2021-08-10 19:53:01 +02002050 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01002051 return;
2052
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00002054 eap->errmsg = _(e_endtry_without_try);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002055 else
2056 {
2057 /*
2058 * Don't do something after an error, interrupt or throw in the try
2059 * block, catch clause, or finally clause preceding this ":endtry" or
2060 * when an error or interrupt occurred after a ":continue", ":break",
2061 * ":return", or ":finish" in a try block or catch clause preceding this
2062 * ":endtry" or when the try block never got active (because of an
2063 * inactive surrounding conditional or after an error or interrupt or
2064 * throw) or when there is a surrounding conditional and it has been
2065 * made inactive by a ":continue", ":break", ":return", or ":finish" in
2066 * the finally clause. The latter case need not be tested since then
2067 * anything pending has already been discarded. */
Bram Moolenaar41978282021-07-04 14:47:30 +02002068 skip = did_emsg || got_int || did_throw
2069 || !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002070
2071 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
2072 {
Bram Moolenaar12805862005-01-05 22:16:17 +00002073 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaarcce81e92021-10-06 22:08:11 +01002074
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002075 // Find the matching ":try" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002076 idx = cstack->cs_idx;
2077 do
2078 --idx;
2079 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
Bram Moolenaar12805862005-01-05 22:16:17 +00002080 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
2081 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082 skip = TRUE;
2083
2084 /*
2085 * If an exception is being thrown, discard it to prevent it from
2086 * being rethrown at the end of this function. It would be
2087 * discarded by the error message, anyway. Resets did_throw.
2088 * This does not affect the script termination due to the error
2089 * since "trylevel" is decremented after emsg() has been called.
2090 */
2091 if (did_throw)
2092 discard_current_exception();
Bram Moolenaarcce81e92021-10-06 22:08:11 +01002093
2094 // report eap->errmsg, also when there already was an error
2095 did_emsg = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 }
2097 else
2098 {
2099 idx = cstack->cs_idx;
2100
rbtnn84934992021-08-07 13:26:53 +02002101 // Check the flags only when not in a skipped block.
2102 if (!skip && in_vim9script()
Bram Moolenaar41978282021-07-04 14:47:30 +02002103 && (cstack->cs_flags[idx] & (CSF_CATCH|CSF_FINALLY)) == 0)
2104 {
2105 // try/endtry without any catch or finally: give an error and
2106 // continue.
2107 eap->errmsg = _(e_missing_catch_or_finally);
2108 }
2109
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 /*
2111 * If we stopped with the exception currently being thrown at this
2112 * try conditional since we didn't know that it doesn't have
2113 * a finally clause, we need to rethrow it after closing the try
2114 * conditional.
2115 */
2116 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
2117 && !(cstack->cs_flags[idx] & CSF_FINALLY))
2118 rethrow = TRUE;
2119 }
2120
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002121 // If there was no finally clause, show the user when debugging or
2122 // a breakpoint was encountered that the end of the try conditional has
2123 // been reached: display the debug prompt (if not already done). Do
2124 // this on normal control flow or when an exception was thrown, but not
2125 // on an interrupt or error not converted to an exception or when
2126 // a ":break", ":continue", ":return", or ":finish" is pending. These
2127 // actions are carried out immediately.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 if ((rethrow || (!skip
2129 && !(cstack->cs_flags[idx] & CSF_FINALLY)
2130 && !cstack->cs_pending[idx]))
2131 && dbg_check_skipped(eap))
2132 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002133 // Handle a ">quit" debug command as if an interrupt had occurred
2134 // before the ":endtry". That is, throw an interrupt exception and
2135 // set "skip" and "rethrow".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 if (got_int)
2137 {
2138 skip = TRUE;
2139 (void)do_intthrow(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002140 // The do_intthrow() call may have reset did_throw or
2141 // cstack->cs_pending[idx].
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 rethrow = FALSE;
2143 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY))
2144 rethrow = TRUE;
2145 }
2146 }
2147
2148 /*
2149 * If a ":return" is pending, we need to resume it after closing the
2150 * try conditional; remember the return value. If there was a finally
2151 * clause making an exception pending, we need to rethrow it. Make it
2152 * the exception currently being thrown.
2153 */
2154 if (!skip)
2155 {
2156 pending = cstack->cs_pending[idx];
2157 cstack->cs_pending[idx] = CSTP_NONE;
2158 if (pending == CSTP_RETURN)
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002159 rettv = cstack->cs_rettv[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002160 else if (pending & CSTP_THROW)
2161 current_exception = cstack->cs_exception[idx];
2162 }
2163
2164 /*
2165 * Discard anything pending on an error, interrupt, or throw in the
2166 * finally clause. If there was no ":finally", discard a pending
2167 * ":continue", ":break", ":return", or ":finish" if an error or
2168 * interrupt occurred afterwards, but before the ":endtry" was reached.
2169 * If an exception was caught by the last of the catch clauses and there
2170 * was no finally clause, finish the exception now. This happens also
2171 * after errors except when this ":endtry" is not within a ":try".
2172 * Restore "emsg_silent" if it has been reset by this try conditional.
2173 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002174 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175
Bram Moolenaarcce81e92021-10-06 22:08:11 +01002176 if (cstack->cs_idx >= 0
2177 && (cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
2178 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002179 --cstack->cs_trylevel;
2180
2181 if (!skip)
2182 {
2183 report_resume_pending(pending,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002184 (pending == CSTP_RETURN) ? rettv :
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2186 switch (pending)
2187 {
2188 case CSTP_NONE:
2189 break;
2190
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002191 // Reactivate a pending ":continue", ":break", ":return",
2192 // ":finish" from the try block or a catch clause of this try
2193 // conditional. This is skipped, if there was an error in an
2194 // (unskipped) conditional command or an interrupt afterwards
2195 // or if the finally clause is present and executed a new error,
2196 // interrupt, throw, ":continue", ":break", ":return", or
2197 // ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 case CSTP_CONTINUE:
2199 ex_continue(eap);
2200 break;
2201 case CSTP_BREAK:
2202 ex_break(eap);
2203 break;
2204 case CSTP_RETURN:
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002205 do_return(eap, FALSE, FALSE, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 break;
2207 case CSTP_FINISH:
2208 do_finish(eap, FALSE);
2209 break;
2210
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002211 // When the finally clause was entered due to an error,
2212 // interrupt or throw (as opposed to a ":continue", ":break",
2213 // ":return", or ":finish"), restore the pending values of
2214 // did_emsg, got_int, and did_throw. This is skipped, if there
2215 // was a new error, interrupt, throw, ":continue", ":break",
2216 // ":return", or ":finish". in the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217 default:
2218 if (pending & CSTP_ERROR)
2219 did_emsg = TRUE;
2220 if (pending & CSTP_INTERRUPT)
2221 got_int = TRUE;
2222 if (pending & CSTP_THROW)
2223 rethrow = TRUE;
2224 break;
2225 }
2226 }
2227
2228 if (rethrow)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002229 // Rethrow the current exception (within this cstack).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002230 do_throw(cstack);
2231 }
2232}
2233
2234/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002235 * enter_cleanup() and leave_cleanup()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002236 *
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002237 * Functions to be called before/after invoking a sequence of autocommands for
2238 * cleanup for a failed command. (Failure means here that a call to emsg()
2239 * has been made, an interrupt occurred, or there is an uncaught exception
2240 * from a previous autocommand execution of the same command.)
2241 *
2242 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same
2243 * pointer to leave_cleanup(). The cleanup_T structure stores the pending
2244 * error/interrupt/exception state.
2245 */
2246
2247/*
2248 * This function works a bit like ex_finally() except that there was not
2249 * actually an extra try block around the part that failed and an error or
2250 * interrupt has not (yet) been converted to an exception. This function
2251 * saves the error/interrupt/ exception state and prepares for the call to
2252 * do_cmdline() that is going to be made for the cleanup autocommand
2253 * execution.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002254 */
2255 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002256enter_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002257{
2258 int pending = CSTP_NONE;
2259
2260 /*
2261 * Postpone did_emsg, got_int, did_throw. The pending values will be
2262 * restored by leave_cleanup() except if there was an aborting error,
2263 * interrupt, or uncaught exception after this function ends.
2264 */
2265 if (did_emsg || got_int || did_throw || need_rethrow)
2266 {
2267 csp->pending = (did_emsg ? CSTP_ERROR : 0)
2268 | (got_int ? CSTP_INTERRUPT : 0)
2269 | (did_throw ? CSTP_THROW : 0)
2270 | (need_rethrow ? CSTP_THROW : 0);
2271
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002272 // If we are currently throwing an exception (did_throw), save it as
2273 // well. On an error not yet converted to an exception, update
2274 // "force_abort" and reset "cause_abort" (as do_errthrow() would do).
2275 // This is needed for the do_cmdline() call that is going to be made
2276 // for autocommand execution. We need not save *msg_list because
2277 // there is an extra instance for every call of do_cmdline(), anyway.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002278 if (did_throw || need_rethrow)
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002279 {
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002280 csp->exception = current_exception;
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002281 current_exception = NULL;
2282 }
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002283 else
2284 {
2285 csp->exception = NULL;
2286 if (did_emsg)
2287 {
2288 force_abort |= cause_abort;
2289 cause_abort = FALSE;
2290 }
2291 }
2292 did_emsg = got_int = did_throw = need_rethrow = FALSE;
2293
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002294 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002295 report_make_pending(pending, csp->exception);
2296 }
2297 else
2298 {
2299 csp->pending = CSTP_NONE;
2300 csp->exception = NULL;
2301 }
2302}
2303
2304/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002305 * See comment above enter_cleanup() for how this function is used.
2306 *
2307 * This function is a bit like ex_endtry() except that there was not actually
2308 * an extra try block around the part that failed and an error or interrupt
2309 * had not (yet) been converted to an exception when the cleanup autocommand
2310 * sequence was invoked.
2311 *
2312 * This function has to be called with the address of the cleanup_T structure
2313 * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2314 * exception state saved by that function - except there was an aborting
2315 * error, an interrupt or an uncaught exception during execution of the
2316 * cleanup autocommands. In the latter case, the saved error/interrupt/
2317 * exception state is discarded.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002318 */
2319 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002320leave_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002321{
2322 int pending = csp->pending;
2323
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002324 if (pending == CSTP_NONE) // nothing to do
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002325 return;
2326
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002327 // If there was an aborting error, an interrupt, or an uncaught exception
2328 // after the corresponding call to enter_cleanup(), discard what has been
2329 // made pending by it. Report this to the user if required by the
2330 // 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002331 if (aborting() || need_rethrow)
2332 {
2333 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002334 // Cancel the pending exception (includes report).
=?UTF-8?q?Dundar=20G=C3=B6c?=420fabc2022-01-28 15:28:04 +00002335 discard_exception(csp->exception, FALSE);
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002336 else
2337 report_discard_pending(pending, NULL);
2338
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002339 // If an error was about to be converted to an exception when
2340 // enter_cleanup() was called, free the message list.
Bram Moolenaar4632d292006-11-28 17:36:37 +00002341 if (msg_list != NULL)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +01002342 free_global_msglist();
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002343 }
2344
2345 /*
2346 * If there was no new error, interrupt, or throw between the calls
2347 * to enter_cleanup() and leave_cleanup(), restore the pending
2348 * error/interrupt/exception state.
2349 */
2350 else
2351 {
2352 /*
2353 * If there was an exception being thrown when enter_cleanup() was
2354 * called, we need to rethrow it. Make it the exception currently
2355 * being thrown.
2356 */
2357 if (pending & CSTP_THROW)
2358 current_exception = csp->exception;
2359
2360 /*
2361 * If an error was about to be converted to an exception when
2362 * enter_cleanup() was called, let "cause_abort" take the part of
2363 * "force_abort" (as done by cause_errthrow()).
2364 */
2365 else if (pending & CSTP_ERROR)
2366 {
2367 cause_abort = force_abort;
2368 force_abort = FALSE;
2369 }
2370
2371 /*
2372 * Restore the pending values of did_emsg, got_int, and did_throw.
2373 */
2374 if (pending & CSTP_ERROR)
2375 did_emsg = TRUE;
2376 if (pending & CSTP_INTERRUPT)
2377 got_int = TRUE;
2378 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002379 need_rethrow = TRUE; // did_throw will be set by do_one_cmd()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002380
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002381 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002382 report_resume_pending(pending,
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002383 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002384 }
2385}
2386
2387
2388/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389 * Make conditionals inactive and discard what's pending in finally clauses
2390 * until the conditional type searched for or a try conditional not in its
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002391 * finally clause is reached. If this is in an active catch clause, finish
2392 * the caught exception.
2393 * Return the cstack index where the search stopped.
Bram Moolenaar12805862005-01-05 22:16:17 +00002394 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
2395 * the latter meaning the innermost try conditional not in its finally clause.
2396 * "inclusive" tells whether the conditional searched for should be made
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002397 * inactive itself (a try conditional not in its finally clause possibly find
Bram Moolenaar12805862005-01-05 22:16:17 +00002398 * before is always made inactive). If "inclusive" is TRUE and
2399 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
2400 * "emsg_silent", if reset when the try conditional finally reached was
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002401 * entered, is restored (used by ex_endtry()). This is normally done only
Bram Moolenaar12805862005-01-05 22:16:17 +00002402 * when such a try conditional is left.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 */
2404 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002405cleanup_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002406 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002407 int searched_cond,
2408 int inclusive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409{
2410 int idx;
2411 int stop = FALSE;
2412
2413 for (idx = cstack->cs_idx; idx >= 0; --idx)
2414 {
2415 if (cstack->cs_flags[idx] & CSF_TRY)
2416 {
2417 /*
2418 * Discard anything pending in a finally clause and continue the
2419 * search. There may also be a pending ":continue", ":break",
2420 * ":return", or ":finish" before the finally clause. We must not
2421 * discard it, unless an error or interrupt occurred afterwards.
2422 */
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002423 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002424 {
2425 switch (cstack->cs_pending[idx])
2426 {
2427 case CSTP_NONE:
2428 break;
2429
2430 case CSTP_CONTINUE:
2431 case CSTP_BREAK:
2432 case CSTP_FINISH:
2433 report_discard_pending(cstack->cs_pending[idx], NULL);
2434 cstack->cs_pending[idx] = CSTP_NONE;
2435 break;
2436
2437 case CSTP_RETURN:
2438 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002439 cstack->cs_rettv[idx]);
2440 discard_pending_return(cstack->cs_rettv[idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002441 cstack->cs_pending[idx] = CSTP_NONE;
2442 break;
2443
2444 default:
2445 if (cstack->cs_flags[idx] & CSF_FINALLY)
2446 {
Bram Moolenaara684a682021-10-04 18:52:19 +01002447 if ((cstack->cs_pending[idx] & CSTP_THROW)
2448 && cstack->cs_exception[idx] != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002450 // Cancel the pending exception. This is in the
2451 // finally clause, so that the stack of the
2452 // caught exceptions is not involved.
Bram Moolenaar13656f02020-12-19 17:55:54 +01002453 discard_exception(
2454 (except_T *)cstack->cs_exception[idx],
Bram Moolenaar071d4272004-06-13 20:20:40 +00002455 FALSE);
2456 }
2457 else
2458 report_discard_pending(cstack->cs_pending[idx],
2459 NULL);
2460 cstack->cs_pending[idx] = CSTP_NONE;
2461 }
2462 break;
2463 }
2464 }
2465
2466 /*
2467 * Stop at a try conditional not in its finally clause. If this try
2468 * conditional is in an active catch clause, finish the caught
2469 * exception.
2470 */
2471 if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2472 {
2473 if ((cstack->cs_flags[idx] & CSF_ACTIVE)
Bram Moolenaarf67d3fb2021-10-05 11:22:27 +01002474 && (cstack->cs_flags[idx] & CSF_CAUGHT)
2475 && !(cstack->cs_flags[idx] & CSF_FINISHED))
2476 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 finish_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaarf67d3fb2021-10-05 11:22:27 +01002478 cstack->cs_flags[idx] |= CSF_FINISHED;
2479 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002480 // Stop at this try conditional - except the try block never
2481 // got active (because of an inactive surrounding conditional
2482 // or when the ":try" appeared after an error or interrupt or
2483 // throw).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 if (cstack->cs_flags[idx] & CSF_TRUE)
2485 {
2486 if (searched_cond == 0 && !inclusive)
2487 break;
2488 stop = TRUE;
2489 }
2490 }
2491 }
2492
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002493 // Stop on the searched conditional type (even when the surrounding
2494 // conditional is not active or something has been made pending).
2495 // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2496 // check first whether "emsg_silent" needs to be restored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 if (cstack->cs_flags[idx] & searched_cond)
2498 {
2499 if (!inclusive)
2500 break;
2501 stop = TRUE;
2502 }
2503 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2504 if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2505 break;
2506
2507 /*
Bram Moolenaarccc18222007-05-10 18:25:20 +00002508 * When leaving a try conditional that reset "emsg_silent" on its
2509 * entry after saving the original value, restore that value here and
2510 * free the memory used to store it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 */
2512 if ((cstack->cs_flags[idx] & CSF_TRY)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002513 && (cstack->cs_flags[idx] & CSF_SILENT))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002514 {
2515 eslist_T *elem;
2516
2517 elem = cstack->cs_emsg_silent_list;
2518 cstack->cs_emsg_silent_list = elem->next;
2519 emsg_silent = elem->saved_emsg_silent;
2520 vim_free(elem);
2521 cstack->cs_flags[idx] &= ~CSF_SILENT;
2522 }
2523 if (stop)
2524 break;
2525 }
2526 return idx;
2527}
2528
2529/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002530 * Return an appropriate error message for a missing endwhile/endfor/endif.
2531 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002532 static char *
Bram Moolenaarddef1292019-12-16 17:10:33 +01002533get_end_emsg(cstack_T *cstack)
Bram Moolenaar12805862005-01-05 22:16:17 +00002534{
2535 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00002536 return _(e_missing_endwhile);
Bram Moolenaar12805862005-01-05 22:16:17 +00002537 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
Bram Moolenaar1a992222021-12-31 17:25:48 +00002538 return _(e_missing_endfor);
2539 return _(e_missing_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00002540}
2541
2542
2543/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544 * Rewind conditionals until index "idx" is reached. "cond_type" and
2545 * "cond_level" specify a conditional type and the address of a level variable
2546 * which is to be decremented with each skipped conditional of the specified
2547 * type.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002548 * Also free "for info" structures where needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549 */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002550 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002551rewind_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002552 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002553 int idx,
2554 int cond_type,
2555 int *cond_level)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556{
2557 while (cstack->cs_idx > idx)
2558 {
2559 if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2560 --*cond_level;
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002561 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2562 free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002563 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 }
2565}
2566
2567/*
Bram Moolenaar6d057012021-12-31 18:49:43 +00002568 * ":endfunction" or ":enddef" when not after a ":function"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 void
Bram Moolenaar6e949782020-04-13 17:21:00 +02002571ex_endfunction(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572{
Bram Moolenaar6e949782020-04-13 17:21:00 +02002573 if (eap->cmdidx == CMD_enddef)
Bram Moolenaar6d057012021-12-31 18:49:43 +00002574 semsg(_(e_str_not_inside_function), ":enddef");
Bram Moolenaar6e949782020-04-13 17:21:00 +02002575 else
Bram Moolenaar6d057012021-12-31 18:49:43 +00002576 semsg(_(e_str_not_inside_function), ":endfunction");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577}
2578
2579/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002580 * Return TRUE if the string "p" looks like a ":while" or ":for" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 */
2582 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002583has_loop_cmd(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002584{
Bram Moolenaared53fb92007-11-24 20:50:24 +00002585 int len;
2586
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002587 // skip modifiers, white space and ':'
Bram Moolenaared53fb92007-11-24 20:50:24 +00002588 for (;;)
2589 {
2590 while (*p == ' ' || *p == '\t' || *p == ':')
2591 ++p;
2592 len = modifier_len(p);
2593 if (len == 0)
2594 break;
2595 p += len;
2596 }
Bram Moolenaar12805862005-01-05 22:16:17 +00002597 if ((p[0] == 'w' && p[1] == 'h')
2598 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 return TRUE;
2600 return FALSE;
2601}
2602
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002603#endif // FEAT_EVAL