blob: 827f9cdcdb8eec8d19980c72eb86008ae5176c1c [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 */
194 if (mesg == (char_u *)_(e_interr))
195 {
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 Moolenaarf9e3e092019-01-13 23:38:42 +0100524 emsg(_("E608: 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
890
891/*
Bram Moolenaar25e42232019-08-04 15:04:10 +0200892 * ":eval".
893 */
894 void
895ex_eval(exarg_T *eap)
896{
897 typval_T tv;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200898 evalarg_T evalarg;
Bram Moolenaarc3235272021-07-10 19:42:03 +0200899 int name_only = FALSE;
900 char_u *p;
901 long lnum = SOURCING_LNUM;
902
903 if (in_vim9script())
904 {
905 char_u *alias;
906
907 p = eap->arg;
908 get_name_len(&p, &alias, FALSE, FALSE);
909 name_only = ends_excmd2(eap->arg, skipwhite(p));
910 vim_free(alias);
911 }
Bram Moolenaar25e42232019-08-04 15:04:10 +0200912
Bram Moolenaare6b53242020-07-01 17:28:33 +0200913 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200914
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200915 if (eval0(eap->arg, &tv, eap, &evalarg) == OK)
Bram Moolenaarc3235272021-07-10 19:42:03 +0200916 {
Bram Moolenaar25e42232019-08-04 15:04:10 +0200917 clear_tv(&tv);
Bram Moolenaarc3235272021-07-10 19:42:03 +0200918 if (in_vim9script() && name_only && lnum == SOURCING_LNUM)
919 semsg(_(e_expression_without_effect_str), eap->arg);
920 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +0200921
922 clear_evalarg(&evalarg, eap);
Bram Moolenaar25e42232019-08-04 15:04:10 +0200923}
924
925/*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200926 * Start a new scope/block. Caller should have checked that cs_idx is not
927 * exceeding CSTACK_LEN.
928 */
929 static void
930enter_block(cstack_T *cstack)
931{
932 ++cstack->cs_idx;
Bram Moolenaar0abc6e42021-02-26 22:21:23 +0100933 if (in_vim9script() && current_sctx.sc_sid > 0)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200934 {
935 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
936
937 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200938 cstack->cs_block_id[cstack->cs_idx] = ++si->sn_last_block_id;
939 si->sn_current_block_id = si->sn_last_block_id;
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200940 }
Bram Moolenaar3e492c22021-01-27 21:37:13 +0100941 else
942 {
943 // Just in case in_vim9script() does not return the same value when the
944 // block ends.
945 cstack->cs_script_var_len[cstack->cs_idx] = 0;
946 cstack->cs_block_id[cstack->cs_idx] = 0;
947 }
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200948}
949
950 static void
951leave_block(cstack_T *cstack)
952{
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200953 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200954 {
Bram Moolenaard7475482020-10-10 20:31:37 +0200955 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200956 int i;
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200957 int func_defined =
958 cstack->cs_flags[cstack->cs_idx] & CSF_FUNC_DEF;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200959
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200960 for (i = cstack->cs_script_var_len[cstack->cs_idx];
Bram Moolenaard7475482020-10-10 20:31:37 +0200961 i < si->sn_var_vals.ga_len; ++i)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200962 {
963 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
Bram Moolenaard7475482020-10-10 20:31:37 +0200964
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200965 // sv_name is set to NULL if it was already removed. This happens
966 // when it was defined in an inner block and no functions were
967 // defined there.
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200968 if (sv->sv_name != NULL)
969 // Remove a variable declared inside the block, if it still
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200970 // exists, from sn_vars and move the value into sn_all_vars
971 // if "func_defined" is non-zero.
972 hide_script_var(si, i, func_defined);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200973 }
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200974
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200975 if (cstack->cs_idx == 0)
976 si->sn_current_block_id = 0;
977 else
978 si->sn_current_block_id = cstack->cs_block_id[cstack->cs_idx - 1];
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200979 }
980 --cstack->cs_idx;
981}
982
983/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984 * ":if".
985 */
986 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100987ex_if(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988{
989 int error;
990 int skip;
991 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +0100992 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993
994 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +0200995 eap->errmsg = _("E579: :if nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 else
997 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200998 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000999 cstack->cs_flags[cstack->cs_idx] = 0;
1000
1001 /*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001002 * Don't do something after an error, interrupt, or throw, or when
1003 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004 */
1005 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1006 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1007
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001008 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009
1010 if (!skip && !error)
1011 {
1012 if (result)
1013 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1014 }
1015 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001016 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1018 }
1019}
1020
1021/*
1022 * ":endif".
1023 */
1024 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001025ex_endif(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026{
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001027 cstack_T *cstack = eap->cstack;
1028
Bram Moolenaarfa984412021-03-25 22:15:28 +01001029 if (cmdmod_error())
1030 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 did_endif = TRUE;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001032 if (cstack->cs_idx < 0
1033 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001034 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001035 eap->errmsg = _(e_endif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036 else
1037 {
1038 /*
1039 * When debugging or a breakpoint was encountered, display the debug
1040 * prompt (if not already done). This shows the user that an ":endif"
1041 * is executed when the ":if" or a previous ":elseif" was not TRUE.
1042 * Handle a ">quit" debug command as if an interrupt had occurred before
1043 * the ":endif". That is, throw an interrupt exception if appropriate.
1044 * Doing this here prevents an exception for a parsing error being
1045 * discarded by throwing the interrupt exception later on.
1046 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001047 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001048 && dbg_check_skipped(eap))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001049 (void)do_intthrow(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001051 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 }
1053}
1054
1055/*
1056 * ":else" and ":elseif".
1057 */
1058 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001059ex_else(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060{
1061 int error;
1062 int skip;
1063 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001064 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065
1066 /*
1067 * Don't do something after an error, interrupt, or throw, or when there is
1068 * a surrounding conditional and it was not active.
1069 */
1070 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1071 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1072
1073 if (cstack->cs_idx < 0
Bram Moolenaar12805862005-01-05 22:16:17 +00001074 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001075 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 {
1077 if (eap->cmdidx == CMD_else)
1078 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001079 eap->errmsg = _(e_else_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001080 return;
1081 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001082 eap->errmsg = _(e_elseif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001083 skip = TRUE;
1084 }
1085 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
1086 {
1087 if (eap->cmdidx == CMD_else)
1088 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001089 eap->errmsg = _("E583: multiple :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090 return;
1091 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001092 eap->errmsg = _("E584: :elseif after :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 skip = TRUE;
1094 }
1095
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001096 // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
1098 {
1099 if (eap->errmsg == NULL)
1100 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001101 skip = TRUE; // don't evaluate an ":elseif"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 }
1103 else
1104 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1105
1106 /*
1107 * When debugging or a breakpoint was encountered, display the debug prompt
1108 * (if not already done). This shows the user that an ":else" or ":elseif"
1109 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle
1110 * a ">quit" debug command as if an interrupt had occurred before the
1111 * ":else" or ":elseif". That is, set "skip" and throw an interrupt
1112 * exception if appropriate. Doing this here prevents that an exception
1113 * for a parsing errors is discarded when throwing the interrupt exception
1114 * later on.
1115 */
1116 if (!skip && dbg_check_skipped(eap) && got_int)
1117 {
1118 (void)do_intthrow(cstack);
1119 skip = TRUE;
1120 }
1121
1122 if (eap->cmdidx == CMD_elseif)
1123 {
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001124 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001125
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001126 // When throwing error exceptions, we want to throw always the first
1127 // of several errors in a row. This is what actually happens when
1128 // a conditional error was detected above and there is another failure
1129 // when parsing the expression. Since the skip flag is set in this
1130 // case, the parsing error will be ignored by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001131 if (!skip && !error)
1132 {
1133 if (result)
1134 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1135 else
1136 cstack->cs_flags[cstack->cs_idx] = 0;
1137 }
1138 else if (eap->errmsg == NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001139 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001140 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1141 }
1142 else
1143 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1144}
1145
1146/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001147 * Handle ":while" and ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001148 */
1149 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001150ex_while(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151{
1152 int error;
1153 int skip;
1154 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001155 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156
1157 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001158 eap->errmsg = _("E585: :while/:for nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 else
1160 {
1161 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001162 * The loop flag is set when we have jumped back from the matching
1163 * ":endwhile" or ":endfor". When not set, need to initialise this
1164 * cstack entry.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001166 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001168 enter_block(cstack);
Bram Moolenaar12805862005-01-05 22:16:17 +00001169 ++cstack->cs_looplevel;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 cstack->cs_line[cstack->cs_idx] = -1;
1171 }
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001172 else
1173 {
1174 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
1175 {
1176 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
1177 int i;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001178 int func_defined = cstack->cs_flags[cstack->cs_idx]
1179 & CSF_FUNC_DEF;
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001180
1181 // Any variables defined in the previous round are no longer
1182 // visible.
1183 for (i = cstack->cs_script_var_len[cstack->cs_idx];
1184 i < si->sn_var_vals.ga_len; ++i)
1185 {
1186 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
1187
1188 // sv_name is set to NULL if it was already removed. This
1189 // happens when it was defined in an inner block and no
1190 // functions were defined there.
1191 if (sv->sv_name != NULL)
1192 // Remove a variable declared inside the block, if it
1193 // still exists, from sn_vars.
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001194 hide_script_var(si, i, func_defined);
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001195 }
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001196 }
1197 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001198 cstack->cs_flags[cstack->cs_idx] =
1199 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001200
1201 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001202 * Don't do something after an error, interrupt, or throw, or when
1203 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 */
1205 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1206 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
Bram Moolenaar12805862005-01-05 22:16:17 +00001207 if (eap->cmdidx == CMD_while)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001208 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001209 /*
1210 * ":while bool-expr"
1211 */
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001212 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 }
1214 else
1215 {
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001216 void *fi;
1217 evalarg_T evalarg;
1218
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001219 /*
1220 * ":for var in list-expr"
1221 */
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001222 fill_evalarg_from_eap(&evalarg, eap, skip);
Bram Moolenaar12805862005-01-05 22:16:17 +00001223 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
1224 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001225 // Jumping here from a ":continue" or ":endfor": use the
1226 // previously evaluated list.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001227 fi = cstack->cs_forinfo[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001228 error = FALSE;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001229
1230 // the "in expr" is not used, skip over it
1231 skip_for_lines(fi, &evalarg);
Bram Moolenaar12805862005-01-05 22:16:17 +00001232 }
1233 else
1234 {
Bram Moolenaard4ab8072021-07-08 19:22:12 +02001235 long save_lnum = SOURCING_LNUM;
1236
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001237 // Evaluate the argument and get the info in a structure.
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001238 fi = eval_for_line(eap->arg, &error, eap, &evalarg);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001239 cstack->cs_forinfo[cstack->cs_idx] = fi;
Bram Moolenaard4ab8072021-07-08 19:22:12 +02001240
1241 // Errors should use the first line number.
1242 SOURCING_LNUM = save_lnum;
Bram Moolenaar12805862005-01-05 22:16:17 +00001243 }
1244
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001245 // use the element at the start of the list and advance
Bram Moolenaar12805862005-01-05 22:16:17 +00001246 if (!error && fi != NULL && !skip)
1247 result = next_for_item(fi, eap->arg);
1248 else
1249 result = FALSE;
1250
1251 if (!result)
1252 {
1253 free_for_info(fi);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001254 cstack->cs_forinfo[cstack->cs_idx] = NULL;
Bram Moolenaar12805862005-01-05 22:16:17 +00001255 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001256 clear_evalarg(&evalarg, eap);
Bram Moolenaar12805862005-01-05 22:16:17 +00001257 }
1258
1259 /*
1260 * If this cstack entry was just initialised and is active, set the
1261 * loop flag, so do_cmdline() will set the line number in cs_line[].
1262 * If executing the command a second time, clear the loop flag.
1263 */
1264 if (!skip && !error && result)
1265 {
1266 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
1267 cstack->cs_lflags ^= CSL_HAD_LOOP;
1268 }
1269 else
1270 {
1271 cstack->cs_lflags &= ~CSL_HAD_LOOP;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001272 // If the ":while" evaluates to FALSE or ":for" is past the end of
1273 // the list, show the debug prompt at the ":endwhile"/":endfor" as
1274 // if there was a ":break" in a ":while"/":for" evaluating to
1275 // TRUE.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276 if (!skip && !error)
1277 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1278 }
1279 }
1280}
1281
1282/*
1283 * ":continue"
1284 */
1285 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001286ex_continue(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287{
1288 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001289 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290
Bram Moolenaar12805862005-01-05 22:16:17 +00001291 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001292 eap->errmsg = _(e_continue);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001293 else
1294 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001295 // Try to find the matching ":while". This might stop at a try
1296 // conditional not in its finally clause (which is then to be executed
Bram Moolenaarc3235272021-07-10 19:42:03 +02001297 // next). Therefore, inactivate all conditionals except the ":while"
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001298 // itself (if reached).
Bram Moolenaar12805862005-01-05 22:16:17 +00001299 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001300 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 {
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001302 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303
1304 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001305 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001306 * matching ":while".
1307 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001308 cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309 }
1310 else
1311 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001312 // If a try conditional not in its finally clause is reached first,
1313 // make the ":continue" pending for execution at the ":endtry".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 cstack->cs_pending[idx] = CSTP_CONTINUE;
1315 report_make_pending(CSTP_CONTINUE, NULL);
1316 }
1317 }
1318}
1319
1320/*
1321 * ":break"
1322 */
1323 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001324ex_break(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325{
1326 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001327 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328
Bram Moolenaar12805862005-01-05 22:16:17 +00001329 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001330 eap->errmsg = _(e_break);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 else
1332 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001333 // Inactivate conditionals until the matching ":while" or a try
1334 // conditional not in its finally clause (which is then to be
1335 // executed next) is found. In the latter case, make the ":break"
1336 // pending for execution at the ":endtry".
Bram Moolenaar12805862005-01-05 22:16:17 +00001337 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001338 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 {
1340 cstack->cs_pending[idx] = CSTP_BREAK;
1341 report_make_pending(CSTP_BREAK, NULL);
1342 }
1343 }
1344}
1345
1346/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001347 * ":endwhile" and ":endfor"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 */
1349 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001350ex_endwhile(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351{
Bram Moolenaarddef1292019-12-16 17:10:33 +01001352 cstack_T *cstack = eap->cstack;
1353 int idx;
1354 char *err;
1355 int csf;
1356 int fl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357
Bram Moolenaarfa984412021-03-25 22:15:28 +01001358 if (cmdmod_error())
1359 return;
1360
Bram Moolenaar12805862005-01-05 22:16:17 +00001361 if (eap->cmdidx == CMD_endwhile)
1362 {
1363 err = e_while;
1364 csf = CSF_WHILE;
1365 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 else
1367 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001368 err = e_for;
1369 csf = CSF_FOR;
1370 }
1371
1372 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001373 eap->errmsg = _(err);
Bram Moolenaar12805862005-01-05 22:16:17 +00001374 else
1375 {
1376 fl = cstack->cs_flags[cstack->cs_idx];
1377 if (!(fl & csf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001379 // If we are in a ":while" or ":for" but used the wrong endloop
1380 // command, do not rewind to the next enclosing ":for"/":while".
Bram Moolenaar12805862005-01-05 22:16:17 +00001381 if (fl & CSF_WHILE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001382 eap->errmsg = _("E732: Using :endfor with :while");
Bram Moolenaar12805862005-01-05 22:16:17 +00001383 else if (fl & CSF_FOR)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001384 eap->errmsg = _("E733: Using :endwhile with :for");
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00001385 }
1386 if (!(fl & (CSF_WHILE | CSF_FOR)))
1387 {
1388 if (!(fl & CSF_TRY))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001389 eap->errmsg = _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00001390 else if (fl & CSF_FINALLY)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001391 eap->errmsg = _(e_endtry);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001392 // Try to find the matching ":while" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393 for (idx = cstack->cs_idx; idx > 0; --idx)
1394 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001395 fl = cstack->cs_flags[idx];
1396 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001397 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001398 // Give up at a try conditional not in its finally clause.
1399 // Ignore the ":endwhile"/":endfor".
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001400 eap->errmsg = _(err);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001401 return;
1402 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001403 if (fl & csf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001404 break;
1405 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001406 // Cleanup and rewind all contained (and unclosed) conditionals.
Bram Moolenaar12805862005-01-05 22:16:17 +00001407 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001408 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1409 }
1410
1411 /*
1412 * When debugging or a breakpoint was encountered, display the debug
1413 * prompt (if not already done). This shows the user that an
Bram Moolenaar12805862005-01-05 22:16:17 +00001414 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
1415 * after a ":break". Handle a ">quit" debug command as if an
1416 * interrupt had occurred before the ":endwhile"/":endfor". That is,
1417 * throw an interrupt exception if appropriate. Doing this here
1418 * prevents that an exception for a parsing error is discarded when
1419 * throwing the interrupt exception later on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001420 */
1421 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1422 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1423 && dbg_check_skipped(eap))
1424 (void)do_intthrow(cstack);
1425
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001426 // Set loop flag, so do_cmdline() will jump back to the matching
1427 // ":while" or ":for".
Bram Moolenaar12805862005-01-05 22:16:17 +00001428 cstack->cs_lflags |= CSL_HAD_ENDLOOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429 }
1430}
1431
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001432/*
1433 * "{" start of a block in Vim9 script
1434 */
1435 void
1436ex_block(exarg_T *eap)
1437{
1438 cstack_T *cstack = eap->cstack;
1439
1440 if (cstack->cs_idx == CSTACK_LEN - 1)
1441 eap->errmsg = _("E579: block nesting too deep");
1442 else
1443 {
1444 enter_block(cstack);
1445 cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE;
1446 }
1447}
1448
1449/*
1450 * "}" end of a block in Vim9 script
1451 */
1452 void
1453ex_endblock(exarg_T *eap)
1454{
1455 cstack_T *cstack = eap->cstack;
1456
1457 if (cstack->cs_idx < 0
1458 || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0)
1459 eap->errmsg = _(e_endblock_without_block);
1460 else
1461 leave_block(cstack);
1462}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463
1464/*
1465 * ":throw expr"
1466 */
1467 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001468ex_throw(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001469{
1470 char_u *arg = eap->arg;
1471 char_u *value;
1472
1473 if (*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001474 value = eval_to_string_skip(arg, eap, eap->skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001475 else
1476 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001477 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478 value = NULL;
1479 }
1480
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001481 // On error or when an exception is thrown during argument evaluation, do
1482 // not throw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483 if (!eap->skip && value != NULL)
1484 {
1485 if (throw_exception(value, ET_USER, NULL) == FAIL)
1486 vim_free(value);
1487 else
1488 do_throw(eap->cstack);
1489 }
1490}
1491
1492/*
Bram Moolenaar269ec652004-07-29 08:43:53 +00001493 * Throw the current exception through the specified cstack. Common routine
1494 * for ":throw" (user exception) and error and interrupt exceptions. Also
1495 * used for rethrowing an uncaught exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001496 */
1497 void
Bram Moolenaarddef1292019-12-16 17:10:33 +01001498do_throw(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499{
1500 int idx;
1501 int inactivate_try = FALSE;
1502
1503 /*
1504 * Cleanup and inactivate up to the next surrounding try conditional that
1505 * is not in its finally clause. Normally, do not inactivate the try
1506 * conditional itself, so that its ACTIVE flag can be tested below. But
1507 * if a previous error or interrupt has not been converted to an exception,
1508 * inactivate the try conditional, too, as if the conversion had been done,
Bram Moolenaar269ec652004-07-29 08:43:53 +00001509 * and reset the did_emsg or got_int flag, so this won't happen again at
1510 * the next surrounding try conditional.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511 */
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001512#ifndef THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 if (did_emsg && !THROW_ON_ERROR)
1514 {
1515 inactivate_try = TRUE;
1516 did_emsg = FALSE;
1517 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001518#endif
1519#ifndef THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 if (got_int && !THROW_ON_INTERRUPT)
1521 {
1522 inactivate_try = TRUE;
1523 got_int = FALSE;
1524 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001525#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 idx = cleanup_conditionals(cstack, 0, inactivate_try);
1527 if (idx >= 0)
1528 {
1529 /*
1530 * If this try conditional is active and we are before its first
Bram Moolenaar269ec652004-07-29 08:43:53 +00001531 * ":catch", set THROWN so that the ":catch" commands will check
1532 * whether the exception matches. When the exception came from any of
1533 * the catch clauses, it will be made pending at the ":finally" (if
1534 * present) and rethrown at the ":endtry". This will also happen if
1535 * the try conditional is inactive. This is the case when we are
1536 * throwing an exception due to an error or interrupt on the way from
1537 * a preceding ":continue", ":break", ":return", ":finish", error or
1538 * interrupt (not converted to an exception) to the finally clause or
1539 * from a preceding throw of a user or error or interrupt exception to
1540 * the matching catch clause or the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 */
1542 if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1543 {
1544 if (cstack->cs_flags[idx] & CSF_ACTIVE)
1545 cstack->cs_flags[idx] |= CSF_THROWN;
1546 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001547 // THROWN may have already been set for a catchable exception
1548 // that has been discarded. Ensure it is reset for the new
1549 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 cstack->cs_flags[idx] &= ~CSF_THROWN;
1551 }
1552 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1553 cstack->cs_exception[idx] = current_exception;
1554 }
1555#if 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001556 // TODO: Add optimization below. Not yet done because of interface
1557 // problems to eval.c and ex_cmds2.c. (Servatius)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 else
1559 {
1560 /*
1561 * There are no catch clauses to check or finally clauses to execute.
1562 * End the current script or function. The exception will be rethrown
1563 * in the caller.
1564 */
1565 if (getline_equal(eap->getline, eap->cookie, get_func_line))
1566 current_funccal->returned = TRUE;
1567 elseif (eap->get_func_line == getsourceline)
1568 ((struct source_cookie *)eap->cookie)->finished = TRUE;
1569 }
1570#endif
1571
1572 did_throw = TRUE;
1573}
1574
1575/*
1576 * ":try"
1577 */
1578 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001579ex_try(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580{
1581 int skip;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001582 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001583
Bram Moolenaarfa984412021-03-25 22:15:28 +01001584 if (cmdmod_error())
1585 return;
1586
Bram Moolenaar071d4272004-06-13 20:20:40 +00001587 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001588 eap->errmsg = _("E601: :try nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 else
1590 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001591 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001592 ++cstack->cs_trylevel;
1593 cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1594 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1595
1596 /*
1597 * Don't do something after an error, interrupt, or throw, or when there
1598 * is a surrounding conditional and it was not active.
1599 */
1600 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1601 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1602
1603 if (!skip)
1604 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001605 // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch"
1606 // commands should check for a match if an exception is thrown and
1607 // that the finally clause needs to be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001608 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1609
1610 /*
1611 * ":silent!", even when used in a try conditional, disables
1612 * displaying of error messages and conversion of errors to
1613 * exceptions. When the silent commands again open a try
1614 * conditional, save "emsg_silent" and reset it so that errors are
1615 * again converted to exceptions. The value is restored when that
1616 * try conditional is left. If it is left normally, the commands
1617 * following the ":endtry" are again silent. If it is left by
1618 * a ":continue", ":break", ":return", or ":finish", the commands
1619 * executed next are again silent. If it is left due to an
1620 * aborting error, an interrupt, or an exception, restoring
1621 * "emsg_silent" does not matter since we are already in the
1622 * aborting state and/or the exception has already been thrown.
1623 * The effect is then just freeing the memory that was allocated
1624 * to save the value.
1625 */
1626 if (emsg_silent)
1627 {
1628 eslist_T *elem;
1629
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001630 elem = ALLOC_ONE(struct eslist_elem);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 if (elem == NULL)
Bram Moolenaare29a27f2021-07-20 21:07:36 +02001632 emsg(_(e_out_of_memory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001633 else
1634 {
1635 elem->saved_emsg_silent = emsg_silent;
1636 elem->next = cstack->cs_emsg_silent_list;
1637 cstack->cs_emsg_silent_list = elem;
1638 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1639 emsg_silent = 0;
1640 }
1641 }
1642 }
1643
1644 }
1645}
1646
1647/*
1648 * ":catch /{pattern}/" and ":catch"
1649 */
1650 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001651ex_catch(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001652{
1653 int idx = 0;
1654 int give_up = FALSE;
1655 int skip = FALSE;
1656 int caught = FALSE;
1657 char_u *end;
1658 int save_char = 0;
1659 char_u *save_cpo;
1660 regmatch_T regmatch;
1661 int prev_got_int;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001662 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 char_u *pat;
1664
Bram Moolenaarfa984412021-03-25 22:15:28 +01001665 if (cmdmod_error())
1666 return;
1667
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1669 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001670 eap->errmsg = _(e_catch);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 give_up = TRUE;
1672 }
1673 else
1674 {
1675 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1676 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001677 // Report what's missing if the matching ":try" is not in its
1678 // finally clause.
Bram Moolenaar12805862005-01-05 22:16:17 +00001679 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 skip = TRUE;
1681 }
1682 for (idx = cstack->cs_idx; idx > 0; --idx)
1683 if (cstack->cs_flags[idx] & CSF_TRY)
1684 break;
Bram Moolenaar41978282021-07-04 14:47:30 +02001685 if (cstack->cs_flags[idx] & CSF_TRY)
1686 cstack->cs_flags[idx] |= CSF_CATCH;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 if (cstack->cs_flags[idx] & CSF_FINALLY)
1688 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001689 // Give up for a ":catch" after ":finally" and ignore it.
1690 // Just parse.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001691 eap->errmsg = _("E604: :catch after :finally");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 give_up = TRUE;
1693 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001694 else
Bram Moolenaar12805862005-01-05 22:16:17 +00001695 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1696 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 }
1698
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001699 if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700 {
1701 pat = (char_u *)".*";
1702 end = NULL;
1703 eap->nextcmd = find_nextcmd(eap->arg);
1704 }
1705 else
1706 {
1707 pat = eap->arg + 1;
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001708 end = skip_regexp_err(pat, *eap->arg, TRUE);
1709 if (end == NULL)
1710 give_up = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 }
1712
1713 if (!give_up)
1714 {
1715 /*
1716 * Don't do something when no exception has been thrown or when the
1717 * corresponding try block never got active (because of an inactive
1718 * surrounding conditional or after an error or interrupt or throw).
1719 */
1720 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1721 skip = TRUE;
1722
1723 /*
1724 * Check for a match only if an exception is thrown but not caught by
1725 * a previous ":catch". An exception that has replaced a discarded
1726 * exception is not checked (THROWN is not set then).
1727 */
1728 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1729 && !(cstack->cs_flags[idx] & CSF_CAUGHT))
1730 {
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001731 if (end != NULL && *end != NUL
1732 && !ends_excmd2(end, skipwhite(end + 1)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001734 semsg(_(e_trailing_arg), end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001735 return;
1736 }
1737
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001738 // When debugging or a breakpoint was encountered, display the
1739 // debug prompt (if not already done) before checking for a match.
1740 // This is a helpful hint for the user when the regular expression
1741 // matching fails. Handle a ">quit" debug command as if an
1742 // interrupt had occurred before the ":catch". That is, discard
1743 // the original exception, replace it by an interrupt exception,
1744 // and don't catch it in this try block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745 if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1746 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001747 // Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1748 // while compiling it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 if (end != NULL)
1750 {
1751 save_char = *end;
1752 *end = NUL;
1753 }
1754 save_cpo = p_cpo;
Bram Moolenaare5a2dc82021-01-03 19:52:05 +01001755 p_cpo = empty_option;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001756 // Disable error messages, it will make current_exception
1757 // invalid.
Bram Moolenaar768ce242016-02-07 19:46:12 +01001758 ++emsg_off;
Bram Moolenaar150cc272007-08-01 13:47:46 +00001759 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
Bram Moolenaar768ce242016-02-07 19:46:12 +01001760 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 regmatch.rm_ic = FALSE;
1762 if (end != NULL)
1763 *end = save_char;
1764 p_cpo = save_cpo;
1765 if (regmatch.regprog == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001766 semsg(_(e_invarg2), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767 else
1768 {
1769 /*
1770 * Save the value of got_int and reset it. We don't want
1771 * a previous interruption cancel matching, only hitting
1772 * CTRL-C while matching should abort it.
1773 */
1774 prev_got_int = got_int;
1775 got_int = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001776 caught = vim_regexec_nl(&regmatch,
1777 (char_u *)current_exception->value, (colnr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001778 got_int |= prev_got_int;
Bram Moolenaar473de612013-06-08 18:19:48 +02001779 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 }
1781 }
1782 }
1783
1784 if (caught)
1785 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001786 // Make this ":catch" clause active and reset did_emsg, got_int,
1787 // and did_throw. Put the exception on the caught stack.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1789 did_emsg = got_int = did_throw = FALSE;
1790 catch_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001791 // It's mandatory that the current exception is stored in the cstack
1792 // so that it can be discarded at the next ":catch", ":finally", or
1793 // ":endtry" or when the catch clause is left by a ":continue",
1794 // ":break", ":return", ":finish", error, interrupt, or another
1795 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 if (cstack->cs_exception[cstack->cs_idx] != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001797 internal_error("ex_catch()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001798 }
1799 else
1800 {
1801 /*
1802 * If there is a preceding catch clause and it caught the exception,
1803 * finish the exception now. This happens also after errors except
1804 * when this ":catch" was after the ":finally" or not within
1805 * a ":try". Make the try conditional inactive so that the
1806 * following catch clauses are skipped. On an error or interrupt
1807 * after the preceding try block or catch clause was left by
1808 * a ":continue", ":break", ":return", or ":finish", discard the
1809 * pending action.
1810 */
1811 cleanup_conditionals(cstack, CSF_TRY, TRUE);
1812 }
1813 }
1814
1815 if (end != NULL)
1816 eap->nextcmd = find_nextcmd(end);
1817}
1818
1819/*
1820 * ":finally"
1821 */
1822 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001823ex_finally(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001824{
1825 int idx;
1826 int skip = FALSE;
1827 int pending = CSTP_NONE;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001828 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829
Bram Moolenaarfa984412021-03-25 22:15:28 +01001830 if (cmdmod_error())
1831 return;
1832
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001834 eap->errmsg = _(e_finally);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 else
1836 {
1837 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1838 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001839 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1841 if (cstack->cs_flags[idx] & CSF_TRY)
1842 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001843 // Make this error pending, so that the commands in the following
1844 // finally clause can be executed. This overrules also a pending
1845 // ":continue", ":break", ":return", or ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001846 pending = CSTP_ERROR;
1847 }
1848 else
1849 idx = cstack->cs_idx;
1850
1851 if (cstack->cs_flags[idx] & CSF_FINALLY)
1852 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001853 // Give up for a multiple ":finally" and ignore it.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001854 eap->errmsg = _(e_finally_dup);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001855 return;
1856 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001857 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
Bram Moolenaar12805862005-01-05 22:16:17 +00001858 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001859
1860 /*
1861 * Don't do something when the corresponding try block never got active
1862 * (because of an inactive surrounding conditional or after an error or
1863 * interrupt or throw) or for a ":finally" without ":try" or a multiple
1864 * ":finally". After every other error (did_emsg or the conditional
1865 * errors detected above) or after an interrupt (got_int) or an
1866 * exception (did_throw), the finally clause must be executed.
1867 */
1868 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1869
1870 if (!skip)
1871 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001872 // When debugging or a breakpoint was encountered, display the
1873 // debug prompt (if not already done). The user then knows that the
1874 // finally clause is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 if (dbg_check_skipped(eap))
1876 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001877 // Handle a ">quit" debug command as if an interrupt had
1878 // occurred before the ":finally". That is, discard the
1879 // original exception and replace it by an interrupt
1880 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001881 (void)do_intthrow(cstack);
1882 }
1883
1884 /*
1885 * If there is a preceding catch clause and it caught the exception,
1886 * finish the exception now. This happens also after errors except
1887 * when this is a multiple ":finally" or one not within a ":try".
1888 * After an error or interrupt, this also discards a pending
1889 * ":continue", ":break", ":finish", or ":return" from the preceding
1890 * try block or catch clause.
1891 */
1892 cleanup_conditionals(cstack, CSF_TRY, FALSE);
1893
1894 /*
1895 * Make did_emsg, got_int, did_throw pending. If set, they overrule
1896 * a pending ":continue", ":break", ":return", or ":finish". Then
1897 * we have particularly to discard a pending return value (as done
1898 * by the call to cleanup_conditionals() above when did_emsg or
1899 * got_int is set). The pending values are restored by the
1900 * ":endtry", except if there is a new error, interrupt, exception,
1901 * ":continue", ":break", ":return", or ":finish" in the following
Bram Moolenaar12805862005-01-05 22:16:17 +00001902 * finally clause. A missing ":endwhile", ":endfor" or ":endif"
1903 * detected here is treated as if did_emsg and did_throw had
1904 * already been set, respectively in case that the error is not
1905 * converted to an exception, did_throw had already been unset.
1906 * We must not set did_emsg here since that would suppress the
1907 * error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001908 */
1909 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1910 {
1911 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
1912 {
1913 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001914 cstack->cs_rettv[cstack->cs_idx]);
1915 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001916 }
1917 if (pending == CSTP_ERROR && !did_emsg)
1918 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
1919 else
1920 pending |= did_throw ? CSTP_THROW : 0;
1921 pending |= did_emsg ? CSTP_ERROR : 0;
1922 pending |= got_int ? CSTP_INTERRUPT : 0;
1923 cstack->cs_pending[cstack->cs_idx] = pending;
1924
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001925 // It's mandatory that the current exception is stored in the
1926 // cstack so that it can be rethrown at the ":endtry" or be
1927 // discarded if the finally clause is left by a ":continue",
1928 // ":break", ":return", ":finish", error, interrupt, or another
1929 // exception. When emsg() is called for a missing ":endif" or
1930 // a missing ":endwhile"/":endfor" detected here, the
1931 // exception will be discarded.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001932 if (did_throw && cstack->cs_exception[cstack->cs_idx]
1933 != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001934 internal_error("ex_finally()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001935 }
1936
1937 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001938 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001939 * got_int, and did_throw and make the finally clause active.
1940 * This will happen after emsg() has been called for a missing
Bram Moolenaar12805862005-01-05 22:16:17 +00001941 * ":endif" or a missing ":endwhile"/":endfor" detected here, so
1942 * that the following finally clause will be executed even then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001944 cstack->cs_lflags |= CSL_HAD_FINA;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001945 }
1946 }
1947}
1948
1949/*
1950 * ":endtry"
1951 */
1952 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001953ex_endtry(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954{
1955 int idx;
1956 int skip;
1957 int rethrow = FALSE;
1958 int pending = CSTP_NONE;
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001959 void *rettv = NULL;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001960 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961
Bram Moolenaarfa984412021-03-25 22:15:28 +01001962 if (cmdmod_error())
1963 return;
1964
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001966 eap->errmsg = _(e_no_endtry);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 else
1968 {
1969 /*
1970 * Don't do something after an error, interrupt or throw in the try
1971 * block, catch clause, or finally clause preceding this ":endtry" or
1972 * when an error or interrupt occurred after a ":continue", ":break",
1973 * ":return", or ":finish" in a try block or catch clause preceding this
1974 * ":endtry" or when the try block never got active (because of an
1975 * inactive surrounding conditional or after an error or interrupt or
1976 * throw) or when there is a surrounding conditional and it has been
1977 * made inactive by a ":continue", ":break", ":return", or ":finish" in
1978 * the finally clause. The latter case need not be tested since then
1979 * anything pending has already been discarded. */
Bram Moolenaar41978282021-07-04 14:47:30 +02001980 skip = did_emsg || got_int || did_throw
1981 || !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982
1983 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1984 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001985 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001986 // Find the matching ":try" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001987 idx = cstack->cs_idx;
1988 do
1989 --idx;
1990 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
Bram Moolenaar12805862005-01-05 22:16:17 +00001991 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1992 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 skip = TRUE;
1994
1995 /*
1996 * If an exception is being thrown, discard it to prevent it from
1997 * being rethrown at the end of this function. It would be
1998 * discarded by the error message, anyway. Resets did_throw.
1999 * This does not affect the script termination due to the error
2000 * since "trylevel" is decremented after emsg() has been called.
2001 */
2002 if (did_throw)
2003 discard_current_exception();
2004 }
2005 else
2006 {
2007 idx = cstack->cs_idx;
2008
Bram Moolenaar41978282021-07-04 14:47:30 +02002009 if (in_vim9script()
2010 && (cstack->cs_flags[idx] & (CSF_CATCH|CSF_FINALLY)) == 0)
2011 {
2012 // try/endtry without any catch or finally: give an error and
2013 // continue.
2014 eap->errmsg = _(e_missing_catch_or_finally);
2015 }
2016
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017 /*
2018 * If we stopped with the exception currently being thrown at this
2019 * try conditional since we didn't know that it doesn't have
2020 * a finally clause, we need to rethrow it after closing the try
2021 * conditional.
2022 */
2023 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
2024 && !(cstack->cs_flags[idx] & CSF_FINALLY))
2025 rethrow = TRUE;
2026 }
2027
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002028 // If there was no finally clause, show the user when debugging or
2029 // a breakpoint was encountered that the end of the try conditional has
2030 // been reached: display the debug prompt (if not already done). Do
2031 // this on normal control flow or when an exception was thrown, but not
2032 // on an interrupt or error not converted to an exception or when
2033 // a ":break", ":continue", ":return", or ":finish" is pending. These
2034 // actions are carried out immediately.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 if ((rethrow || (!skip
2036 && !(cstack->cs_flags[idx] & CSF_FINALLY)
2037 && !cstack->cs_pending[idx]))
2038 && dbg_check_skipped(eap))
2039 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002040 // Handle a ">quit" debug command as if an interrupt had occurred
2041 // before the ":endtry". That is, throw an interrupt exception and
2042 // set "skip" and "rethrow".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 if (got_int)
2044 {
2045 skip = TRUE;
2046 (void)do_intthrow(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002047 // The do_intthrow() call may have reset did_throw or
2048 // cstack->cs_pending[idx].
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 rethrow = FALSE;
2050 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY))
2051 rethrow = TRUE;
2052 }
2053 }
2054
2055 /*
2056 * If a ":return" is pending, we need to resume it after closing the
2057 * try conditional; remember the return value. If there was a finally
2058 * clause making an exception pending, we need to rethrow it. Make it
2059 * the exception currently being thrown.
2060 */
2061 if (!skip)
2062 {
2063 pending = cstack->cs_pending[idx];
2064 cstack->cs_pending[idx] = CSTP_NONE;
2065 if (pending == CSTP_RETURN)
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002066 rettv = cstack->cs_rettv[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002067 else if (pending & CSTP_THROW)
2068 current_exception = cstack->cs_exception[idx];
2069 }
2070
2071 /*
2072 * Discard anything pending on an error, interrupt, or throw in the
2073 * finally clause. If there was no ":finally", discard a pending
2074 * ":continue", ":break", ":return", or ":finish" if an error or
2075 * interrupt occurred afterwards, but before the ":endtry" was reached.
2076 * If an exception was caught by the last of the catch clauses and there
2077 * was no finally clause, finish the exception now. This happens also
2078 * after errors except when this ":endtry" is not within a ":try".
2079 * Restore "emsg_silent" if it has been reset by this try conditional.
2080 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002081 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002082
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002083 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 --cstack->cs_trylevel;
2085
2086 if (!skip)
2087 {
2088 report_resume_pending(pending,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002089 (pending == CSTP_RETURN) ? rettv :
Bram Moolenaar071d4272004-06-13 20:20:40 +00002090 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2091 switch (pending)
2092 {
2093 case CSTP_NONE:
2094 break;
2095
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002096 // Reactivate a pending ":continue", ":break", ":return",
2097 // ":finish" from the try block or a catch clause of this try
2098 // conditional. This is skipped, if there was an error in an
2099 // (unskipped) conditional command or an interrupt afterwards
2100 // or if the finally clause is present and executed a new error,
2101 // interrupt, throw, ":continue", ":break", ":return", or
2102 // ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 case CSTP_CONTINUE:
2104 ex_continue(eap);
2105 break;
2106 case CSTP_BREAK:
2107 ex_break(eap);
2108 break;
2109 case CSTP_RETURN:
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002110 do_return(eap, FALSE, FALSE, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 break;
2112 case CSTP_FINISH:
2113 do_finish(eap, FALSE);
2114 break;
2115
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002116 // When the finally clause was entered due to an error,
2117 // interrupt or throw (as opposed to a ":continue", ":break",
2118 // ":return", or ":finish"), restore the pending values of
2119 // did_emsg, got_int, and did_throw. This is skipped, if there
2120 // was a new error, interrupt, throw, ":continue", ":break",
2121 // ":return", or ":finish". in the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 default:
2123 if (pending & CSTP_ERROR)
2124 did_emsg = TRUE;
2125 if (pending & CSTP_INTERRUPT)
2126 got_int = TRUE;
2127 if (pending & CSTP_THROW)
2128 rethrow = TRUE;
2129 break;
2130 }
2131 }
2132
2133 if (rethrow)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002134 // Rethrow the current exception (within this cstack).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002135 do_throw(cstack);
2136 }
2137}
2138
2139/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002140 * enter_cleanup() and leave_cleanup()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002141 *
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002142 * Functions to be called before/after invoking a sequence of autocommands for
2143 * cleanup for a failed command. (Failure means here that a call to emsg()
2144 * has been made, an interrupt occurred, or there is an uncaught exception
2145 * from a previous autocommand execution of the same command.)
2146 *
2147 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same
2148 * pointer to leave_cleanup(). The cleanup_T structure stores the pending
2149 * error/interrupt/exception state.
2150 */
2151
2152/*
2153 * This function works a bit like ex_finally() except that there was not
2154 * actually an extra try block around the part that failed and an error or
2155 * interrupt has not (yet) been converted to an exception. This function
2156 * saves the error/interrupt/ exception state and prepares for the call to
2157 * do_cmdline() that is going to be made for the cleanup autocommand
2158 * execution.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002159 */
2160 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002161enter_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002162{
2163 int pending = CSTP_NONE;
2164
2165 /*
2166 * Postpone did_emsg, got_int, did_throw. The pending values will be
2167 * restored by leave_cleanup() except if there was an aborting error,
2168 * interrupt, or uncaught exception after this function ends.
2169 */
2170 if (did_emsg || got_int || did_throw || need_rethrow)
2171 {
2172 csp->pending = (did_emsg ? CSTP_ERROR : 0)
2173 | (got_int ? CSTP_INTERRUPT : 0)
2174 | (did_throw ? CSTP_THROW : 0)
2175 | (need_rethrow ? CSTP_THROW : 0);
2176
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002177 // If we are currently throwing an exception (did_throw), save it as
2178 // well. On an error not yet converted to an exception, update
2179 // "force_abort" and reset "cause_abort" (as do_errthrow() would do).
2180 // This is needed for the do_cmdline() call that is going to be made
2181 // for autocommand execution. We need not save *msg_list because
2182 // there is an extra instance for every call of do_cmdline(), anyway.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002183 if (did_throw || need_rethrow)
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002184 {
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002185 csp->exception = current_exception;
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002186 current_exception = NULL;
2187 }
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002188 else
2189 {
2190 csp->exception = NULL;
2191 if (did_emsg)
2192 {
2193 force_abort |= cause_abort;
2194 cause_abort = FALSE;
2195 }
2196 }
2197 did_emsg = got_int = did_throw = need_rethrow = FALSE;
2198
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002199 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002200 report_make_pending(pending, csp->exception);
2201 }
2202 else
2203 {
2204 csp->pending = CSTP_NONE;
2205 csp->exception = NULL;
2206 }
2207}
2208
2209/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002210 * See comment above enter_cleanup() for how this function is used.
2211 *
2212 * This function is a bit like ex_endtry() except that there was not actually
2213 * an extra try block around the part that failed and an error or interrupt
2214 * had not (yet) been converted to an exception when the cleanup autocommand
2215 * sequence was invoked.
2216 *
2217 * This function has to be called with the address of the cleanup_T structure
2218 * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2219 * exception state saved by that function - except there was an aborting
2220 * error, an interrupt or an uncaught exception during execution of the
2221 * cleanup autocommands. In the latter case, the saved error/interrupt/
2222 * exception state is discarded.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002223 */
2224 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002225leave_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002226{
2227 int pending = csp->pending;
2228
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002229 if (pending == CSTP_NONE) // nothing to do
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002230 return;
2231
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002232 // If there was an aborting error, an interrupt, or an uncaught exception
2233 // after the corresponding call to enter_cleanup(), discard what has been
2234 // made pending by it. Report this to the user if required by the
2235 // 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002236 if (aborting() || need_rethrow)
2237 {
2238 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002239 // Cancel the pending exception (includes report).
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002240 discard_exception((except_T *)csp->exception, FALSE);
2241 else
2242 report_discard_pending(pending, NULL);
2243
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002244 // If an error was about to be converted to an exception when
2245 // enter_cleanup() was called, free the message list.
Bram Moolenaar4632d292006-11-28 17:36:37 +00002246 if (msg_list != NULL)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +01002247 free_global_msglist();
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002248 }
2249
2250 /*
2251 * If there was no new error, interrupt, or throw between the calls
2252 * to enter_cleanup() and leave_cleanup(), restore the pending
2253 * error/interrupt/exception state.
2254 */
2255 else
2256 {
2257 /*
2258 * If there was an exception being thrown when enter_cleanup() was
2259 * called, we need to rethrow it. Make it the exception currently
2260 * being thrown.
2261 */
2262 if (pending & CSTP_THROW)
2263 current_exception = csp->exception;
2264
2265 /*
2266 * If an error was about to be converted to an exception when
2267 * enter_cleanup() was called, let "cause_abort" take the part of
2268 * "force_abort" (as done by cause_errthrow()).
2269 */
2270 else if (pending & CSTP_ERROR)
2271 {
2272 cause_abort = force_abort;
2273 force_abort = FALSE;
2274 }
2275
2276 /*
2277 * Restore the pending values of did_emsg, got_int, and did_throw.
2278 */
2279 if (pending & CSTP_ERROR)
2280 did_emsg = TRUE;
2281 if (pending & CSTP_INTERRUPT)
2282 got_int = TRUE;
2283 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002284 need_rethrow = TRUE; // did_throw will be set by do_one_cmd()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002285
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002286 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002287 report_resume_pending(pending,
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002288 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002289 }
2290}
2291
2292
2293/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 * Make conditionals inactive and discard what's pending in finally clauses
2295 * until the conditional type searched for or a try conditional not in its
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002296 * finally clause is reached. If this is in an active catch clause, finish
2297 * the caught exception.
2298 * Return the cstack index where the search stopped.
Bram Moolenaar12805862005-01-05 22:16:17 +00002299 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
2300 * the latter meaning the innermost try conditional not in its finally clause.
2301 * "inclusive" tells whether the conditional searched for should be made
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002302 * inactive itself (a try conditional not in its finally clause possibly find
Bram Moolenaar12805862005-01-05 22:16:17 +00002303 * before is always made inactive). If "inclusive" is TRUE and
2304 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
2305 * "emsg_silent", if reset when the try conditional finally reached was
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002306 * entered, is restored (used by ex_endtry()). This is normally done only
Bram Moolenaar12805862005-01-05 22:16:17 +00002307 * when such a try conditional is left.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308 */
2309 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002310cleanup_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002311 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002312 int searched_cond,
2313 int inclusive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314{
2315 int idx;
2316 int stop = FALSE;
2317
2318 for (idx = cstack->cs_idx; idx >= 0; --idx)
2319 {
2320 if (cstack->cs_flags[idx] & CSF_TRY)
2321 {
2322 /*
2323 * Discard anything pending in a finally clause and continue the
2324 * search. There may also be a pending ":continue", ":break",
2325 * ":return", or ":finish" before the finally clause. We must not
2326 * discard it, unless an error or interrupt occurred afterwards.
2327 */
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002328 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 {
2330 switch (cstack->cs_pending[idx])
2331 {
2332 case CSTP_NONE:
2333 break;
2334
2335 case CSTP_CONTINUE:
2336 case CSTP_BREAK:
2337 case CSTP_FINISH:
2338 report_discard_pending(cstack->cs_pending[idx], NULL);
2339 cstack->cs_pending[idx] = CSTP_NONE;
2340 break;
2341
2342 case CSTP_RETURN:
2343 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002344 cstack->cs_rettv[idx]);
2345 discard_pending_return(cstack->cs_rettv[idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 cstack->cs_pending[idx] = CSTP_NONE;
2347 break;
2348
2349 default:
2350 if (cstack->cs_flags[idx] & CSF_FINALLY)
2351 {
2352 if (cstack->cs_pending[idx] & CSTP_THROW)
2353 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002354 // Cancel the pending exception. This is in the
2355 // finally clause, so that the stack of the
2356 // caught exceptions is not involved.
Bram Moolenaar13656f02020-12-19 17:55:54 +01002357 discard_exception(
2358 (except_T *)cstack->cs_exception[idx],
Bram Moolenaar071d4272004-06-13 20:20:40 +00002359 FALSE);
2360 }
2361 else
2362 report_discard_pending(cstack->cs_pending[idx],
2363 NULL);
2364 cstack->cs_pending[idx] = CSTP_NONE;
2365 }
2366 break;
2367 }
2368 }
2369
2370 /*
2371 * Stop at a try conditional not in its finally clause. If this try
2372 * conditional is in an active catch clause, finish the caught
2373 * exception.
2374 */
2375 if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2376 {
2377 if ((cstack->cs_flags[idx] & CSF_ACTIVE)
2378 && (cstack->cs_flags[idx] & CSF_CAUGHT))
2379 finish_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002380 // Stop at this try conditional - except the try block never
2381 // got active (because of an inactive surrounding conditional
2382 // or when the ":try" appeared after an error or interrupt or
2383 // throw).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 if (cstack->cs_flags[idx] & CSF_TRUE)
2385 {
2386 if (searched_cond == 0 && !inclusive)
2387 break;
2388 stop = TRUE;
2389 }
2390 }
2391 }
2392
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002393 // Stop on the searched conditional type (even when the surrounding
2394 // conditional is not active or something has been made pending).
2395 // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2396 // check first whether "emsg_silent" needs to be restored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 if (cstack->cs_flags[idx] & searched_cond)
2398 {
2399 if (!inclusive)
2400 break;
2401 stop = TRUE;
2402 }
2403 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2404 if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2405 break;
2406
2407 /*
Bram Moolenaarccc18222007-05-10 18:25:20 +00002408 * When leaving a try conditional that reset "emsg_silent" on its
2409 * entry after saving the original value, restore that value here and
2410 * free the memory used to store it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 */
2412 if ((cstack->cs_flags[idx] & CSF_TRY)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002413 && (cstack->cs_flags[idx] & CSF_SILENT))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 {
2415 eslist_T *elem;
2416
2417 elem = cstack->cs_emsg_silent_list;
2418 cstack->cs_emsg_silent_list = elem->next;
2419 emsg_silent = elem->saved_emsg_silent;
2420 vim_free(elem);
2421 cstack->cs_flags[idx] &= ~CSF_SILENT;
2422 }
2423 if (stop)
2424 break;
2425 }
2426 return idx;
2427}
2428
2429/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002430 * Return an appropriate error message for a missing endwhile/endfor/endif.
2431 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002432 static char *
Bram Moolenaarddef1292019-12-16 17:10:33 +01002433get_end_emsg(cstack_T *cstack)
Bram Moolenaar12805862005-01-05 22:16:17 +00002434{
2435 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002436 return _(e_endwhile);
Bram Moolenaar12805862005-01-05 22:16:17 +00002437 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002438 return _(e_endfor);
2439 return _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00002440}
2441
2442
2443/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002444 * Rewind conditionals until index "idx" is reached. "cond_type" and
2445 * "cond_level" specify a conditional type and the address of a level variable
2446 * which is to be decremented with each skipped conditional of the specified
2447 * type.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002448 * Also free "for info" structures where needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002449 */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002450 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002451rewind_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002452 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002453 int idx,
2454 int cond_type,
2455 int *cond_level)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002456{
2457 while (cstack->cs_idx > idx)
2458 {
2459 if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2460 --*cond_level;
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002461 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2462 free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002463 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002464 }
2465}
2466
2467/*
2468 * ":endfunction" when not after a ":function"
2469 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002470 void
Bram Moolenaar6e949782020-04-13 17:21:00 +02002471ex_endfunction(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002472{
Bram Moolenaar6e949782020-04-13 17:21:00 +02002473 if (eap->cmdidx == CMD_enddef)
2474 emsg(_("E193: :enddef not inside a function"));
2475 else
2476 emsg(_("E193: :endfunction not inside a function"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477}
2478
2479/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002480 * Return TRUE if the string "p" looks like a ":while" or ":for" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002481 */
2482 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002483has_loop_cmd(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484{
Bram Moolenaared53fb92007-11-24 20:50:24 +00002485 int len;
2486
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002487 // skip modifiers, white space and ':'
Bram Moolenaared53fb92007-11-24 20:50:24 +00002488 for (;;)
2489 {
2490 while (*p == ' ' || *p == '\t' || *p == ':')
2491 ++p;
2492 len = modifier_len(p);
2493 if (len == 0)
2494 break;
2495 p += len;
2496 }
Bram Moolenaar12805862005-01-05 22:16:17 +00002497 if ((p[0] == 'w' && p[1] == 'h')
2498 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002499 return TRUE;
2500 return FALSE;
2501}
2502
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002503#endif // FEAT_EVAL