blob: 37036903159a9fea6e2ce03c250ae044eb108335 [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
211 * user, who wouldn't even get aware of the problem. Therefor, discard the
212 * 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 Moolenaarf9e3e092019-01-13 23:38:42 +0100258 emsg(_(e_outofmem));
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 Moolenaarf9e3e092019-01-13 23:38:42 +0100267 emsg(_(e_outofmem));
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 Moolenaar071d4272004-06-13 20:20:40 +0000295 }
296 }
297 }
298 return TRUE;
299 }
300}
301
302/*
303 * Free a "msg_list" and the messages it contains.
304 */
305 static void
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200306free_msglist(msglist_T *l)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307{
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200308 msglist_T *messages, *next;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309
310 messages = l;
311 while (messages != NULL)
312 {
313 next = messages->next;
314 vim_free(messages->msg);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200315 vim_free(messages->sfile);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 vim_free(messages);
317 messages = next;
318 }
319}
320
321/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100322 * Free global "*msg_list" and the messages it contains, then set "*msg_list"
323 * to NULL.
324 */
325 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100326free_global_msglist(void)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100327{
328 free_msglist(*msg_list);
329 *msg_list = NULL;
330}
331
332/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 * Throw the message specified in the call to cause_errthrow() above as an
334 * error exception. If cstack is NULL, postpone the throw until do_cmdline()
335 * has returned (see do_one_cmd()).
336 */
337 void
Bram Moolenaarddef1292019-12-16 17:10:33 +0100338do_errthrow(cstack_T *cstack, char_u *cmdname)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339{
340 /*
341 * Ensure that all commands in nested function calls and sourced files
342 * are aborted immediately.
343 */
344 if (cause_abort)
345 {
346 cause_abort = FALSE;
347 force_abort = TRUE;
348 }
349
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100350 // If no exception is to be thrown or the conversion should be done after
351 // returning to a previous invocation of do_one_cmd(), do nothing.
Bram Moolenaar4632d292006-11-28 17:36:37 +0000352 if (msg_list == NULL || *msg_list == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353 return;
354
355 if (throw_exception(*msg_list, ET_ERROR, cmdname) == FAIL)
356 free_msglist(*msg_list);
357 else
358 {
359 if (cstack != NULL)
360 do_throw(cstack);
361 else
362 need_rethrow = TRUE;
363 }
364 *msg_list = NULL;
365}
366
367/*
368 * do_intthrow(): Replace the current exception by an interrupt or interrupt
369 * exception if appropriate. Return TRUE if the current exception is discarded,
370 * FALSE otherwise.
371 */
372 int
Bram Moolenaarddef1292019-12-16 17:10:33 +0100373do_intthrow(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374{
375 /*
376 * If no interrupt occurred or no try conditional is active and no exception
377 * is being thrown, do nothing (for compatibility of non-EH scripts).
378 */
379 if (!got_int || (trylevel == 0 && !did_throw))
380 return FALSE;
381
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100382#ifdef THROW_TEST // avoid warning for condition always true
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383 if (!THROW_ON_INTERRUPT)
384 {
385 /*
386 * The interrupt aborts everything except for executing finally clauses.
387 * Discard any user or error or interrupt exception currently being
388 * thrown.
389 */
390 if (did_throw)
391 discard_current_exception();
392 }
393 else
394#endif
395 {
396 /*
397 * Throw an interrupt exception, so that everything will be aborted
398 * (except for executing finally clauses), until the interrupt exception
399 * is caught; if still uncaught at the top level, the script processing
400 * will be terminated then. - If an interrupt exception is already
401 * being thrown, do nothing.
402 *
403 */
404 if (did_throw)
405 {
406 if (current_exception->type == ET_INTERRUPT)
407 return FALSE;
408
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100409 // An interrupt exception replaces any user or error exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410 discard_current_exception();
411 }
412 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) != FAIL)
413 do_throw(cstack);
414 }
415
416 return TRUE;
417}
418
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100420 * Get an exception message that is to be stored in current_exception->value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100422 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100423get_exception_string(
424 void *value,
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100425 except_type_T type,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100426 char_u *cmdname,
427 int *should_free)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100429 char *ret;
430 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431 int cmdlen;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100432 char *p, *val;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433
434 if (type == ET_ERROR)
435 {
Bram Moolenaar9ef00be2016-03-06 14:58:28 +0100436 *should_free = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200437 mesg = ((msglist_T *)value)->throw_msg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 if (cmdname != NULL && *cmdname != NUL)
439 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000440 cmdlen = (int)STRLEN(cmdname);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100441 ret = (char *)vim_strnsave((char_u *)"Vim(",
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200442 4 + cmdlen + 2 + STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100443 if (ret == NULL)
444 return ret;
445 STRCPY(&ret[4], cmdname);
446 STRCPY(&ret[4 + cmdlen], "):");
447 val = ret + 4 + cmdlen + 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448 }
449 else
450 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200451 ret = (char *)vim_strnsave((char_u *)"Vim:", 4 + STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100452 if (ret == NULL)
453 return ret;
454 val = ret + 4;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455 }
456
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100457 // msg_add_fname may have been used to prefix the message with a file
458 // name in quotes. In the exception value, put the file name in
459 // parentheses and move it to the end.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460 for (p = mesg; ; p++)
461 {
462 if (*p == NUL
463 || (*p == 'E'
464 && VIM_ISDIGIT(p[1])
465 && (p[2] == ':'
466 || (VIM_ISDIGIT(p[2])
467 && (p[3] == ':'
468 || (VIM_ISDIGIT(p[3])
469 && p[4] == ':'))))))
470 {
Bram Moolenaar051b7822005-05-19 21:00:46 +0000471 if (*p == NUL || p == mesg)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100472 STRCAT(val, mesg); // 'E123' missing or at beginning
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473 else
474 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100475 // '"filename" E123: message text'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476 if (mesg[0] != '"' || p-2 < &mesg[1] ||
477 p[-2] != '"' || p[-1] != ' ')
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100478 // "E123:" is part of the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 continue;
480
481 STRCAT(val, p);
482 p[-2] = NUL;
483 sprintf((char *)(val + STRLEN(p)), " (%s)", &mesg[1]);
484 p[-2] = '"';
485 }
486 break;
487 }
488 }
489 }
490 else
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100491 {
492 *should_free = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100493 ret = value;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100494 }
495
496 return ret;
497}
498
499
500/*
501 * Throw a new exception. Return FAIL when out of memory or it was tried to
502 * throw an illegal user exception. "value" is the exception string for a
503 * user or interrupt exception, or points to a message list in case of an
504 * error exception.
505 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100506 int
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100507throw_exception(void *value, except_type_T type, char_u *cmdname)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100508{
509 except_T *excp;
510 int should_free;
511
512 /*
513 * Disallow faking Interrupt or error exceptions as user exceptions. They
514 * would be treated differently from real interrupt or error exceptions
515 * when no active try block is found, see do_cmdline().
516 */
517 if (type == ET_USER)
518 {
519 if (STRNCMP((char_u *)value, "Vim", 3) == 0
520 && (((char_u *)value)[3] == NUL || ((char_u *)value)[3] == ':'
521 || ((char_u *)value)[3] == '('))
522 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100523 emsg(_("E608: Cannot :throw exceptions with 'Vim' prefix"));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100524 goto fail;
525 }
526 }
527
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200528 excp = ALLOC_ONE(except_T);
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100529 if (excp == NULL)
530 goto nomem;
531
532 if (type == ET_ERROR)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100533 // Store the original message and prefix the exception value with
534 // "Vim:" or, if a command name is given, "Vim(cmdname):".
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200535 excp->messages = (msglist_T *)value;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100536
537 excp->value = get_exception_string(value, type, cmdname, &should_free);
538 if (excp->value == NULL && should_free)
539 goto nomem;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541 excp->type = type;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200542 if (type == ET_ERROR && ((msglist_T *)value)->sfile != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200544 msglist_T *entry = (msglist_T *)value;
545
546 excp->throw_name = entry->sfile;
547 entry->sfile = NULL;
548 excp->throw_lnum = entry->slnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549 }
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200550 else
551 {
Bram Moolenaar4f25b1a2020-09-10 19:25:05 +0200552 excp->throw_name = estack_sfile(ESTACK_NONE);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200553 if (excp->throw_name == NULL)
554 excp->throw_name = vim_strsave((char_u *)"");
555 if (excp->throw_name == NULL)
556 {
557 if (should_free)
558 vim_free(excp->value);
559 goto nomem;
560 }
561 excp->throw_lnum = SOURCING_LNUM;
562 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563
564 if (p_verbose >= 13 || debug_break_level > 0)
565 {
566 int save_msg_silent = msg_silent;
567
568 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100569 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000570 else
571 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000573 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100574 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000575
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100576 smsg(_("Exception thrown: %s"), excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100577 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000578
579 if (debug_break_level > 0 || *p_vfile == NUL)
580 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581 --no_wait_return;
582 if (debug_break_level > 0)
583 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000584 else
585 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586 }
587
588 current_exception = excp;
589 return OK;
590
591nomem:
592 vim_free(excp);
593 suppress_errthrow = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100594 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595fail:
596 current_exception = NULL;
597 return FAIL;
598}
599
600/*
601 * Discard an exception. "was_finished" is set when the exception has been
602 * caught and the catch clause has been ended normally.
603 */
604 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100605discard_exception(except_T *excp, int was_finished)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606{
607 char_u *saved_IObuff;
608
609 if (excp == NULL)
610 {
Bram Moolenaar95f09602016-11-10 20:01:45 +0100611 internal_error("discard_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 return;
613 }
614
615 if (p_verbose >= 13 || debug_break_level > 0)
616 {
617 int save_msg_silent = msg_silent;
618
619 saved_IObuff = vim_strsave(IObuff);
620 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100621 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000622 else
623 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000625 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100626 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar051b7822005-05-19 21:00:46 +0000627 smsg(was_finished
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100628 ? _("Exception finished: %s")
629 : _("Exception discarded: %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630 excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100631 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000632 if (debug_break_level > 0 || *p_vfile == NUL)
633 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634 --no_wait_return;
635 if (debug_break_level > 0)
636 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000637 else
638 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 STRCPY(IObuff, saved_IObuff);
640 vim_free(saved_IObuff);
641 }
642 if (excp->type != ET_INTERRUPT)
643 vim_free(excp->value);
644 if (excp->type == ET_ERROR)
645 free_msglist(excp->messages);
646 vim_free(excp->throw_name);
647 vim_free(excp);
648}
649
650/*
651 * Discard the exception currently being thrown.
652 */
653 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100654discard_current_exception(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655{
Bram Moolenaarcae24be2017-07-10 22:12:10 +0200656 if (current_exception != NULL)
657 {
658 discard_exception(current_exception, FALSE);
659 current_exception = NULL;
660 }
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 Moolenaar25e42232019-08-04 15:04:10 +0200899
Bram Moolenaare6b53242020-07-01 17:28:33 +0200900 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200901
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200902 if (eval0(eap->arg, &tv, eap, &evalarg) == OK)
Bram Moolenaar25e42232019-08-04 15:04:10 +0200903 clear_tv(&tv);
Bram Moolenaarb7a78f72020-06-28 18:43:40 +0200904
905 clear_evalarg(&evalarg, eap);
Bram Moolenaar25e42232019-08-04 15:04:10 +0200906}
907
908/*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200909 * Start a new scope/block. Caller should have checked that cs_idx is not
910 * exceeding CSTACK_LEN.
911 */
912 static void
913enter_block(cstack_T *cstack)
914{
915 ++cstack->cs_idx;
916 if (in_vim9script())
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200917 {
918 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
919
920 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200921 cstack->cs_block_id[cstack->cs_idx] = ++si->sn_last_block_id;
922 si->sn_current_block_id = si->sn_last_block_id;
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200923 }
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200924}
925
926 static void
927leave_block(cstack_T *cstack)
928{
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200929 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200930 {
Bram Moolenaard7475482020-10-10 20:31:37 +0200931 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200932 int i;
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200933 int func_defined =
934 cstack->cs_flags[cstack->cs_idx] & CSF_FUNC_DEF;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200935
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200936 for (i = cstack->cs_script_var_len[cstack->cs_idx];
Bram Moolenaard7475482020-10-10 20:31:37 +0200937 i < si->sn_var_vals.ga_len; ++i)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200938 {
939 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
Bram Moolenaard7475482020-10-10 20:31:37 +0200940
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200941 // sv_name is set to NULL if it was already removed. This happens
942 // when it was defined in an inner block and no functions were
943 // defined there.
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200944 if (sv->sv_name != NULL)
945 // Remove a variable declared inside the block, if it still
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200946 // exists, from sn_vars and move the value into sn_all_vars
947 // if "func_defined" is non-zero.
948 hide_script_var(si, i, func_defined);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200949 }
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200950
951 // TODO: is this needed?
952 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200953
954 if (cstack->cs_idx == 0)
955 si->sn_current_block_id = 0;
956 else
957 si->sn_current_block_id = cstack->cs_block_id[cstack->cs_idx - 1];
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200958 }
959 --cstack->cs_idx;
960}
961
962/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 * ":if".
964 */
965 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100966ex_if(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000967{
968 int error;
969 int skip;
970 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +0100971 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972
973 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +0200974 eap->errmsg = _("E579: :if nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 else
976 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200977 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978 cstack->cs_flags[cstack->cs_idx] = 0;
979
980 /*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200981 * Don't do something after an error, interrupt, or throw, or when
982 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 */
984 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
985 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
986
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200987 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988
989 if (!skip && !error)
990 {
991 if (result)
992 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
993 }
994 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100995 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
997 }
998}
999
1000/*
1001 * ":endif".
1002 */
1003 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001004ex_endif(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005{
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001006 cstack_T *cstack = eap->cstack;
1007
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 did_endif = TRUE;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001009 if (cstack->cs_idx < 0
1010 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001011 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001012 eap->errmsg = _(e_endif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 else
1014 {
1015 /*
1016 * When debugging or a breakpoint was encountered, display the debug
1017 * prompt (if not already done). This shows the user that an ":endif"
1018 * is executed when the ":if" or a previous ":elseif" was not TRUE.
1019 * Handle a ">quit" debug command as if an interrupt had occurred before
1020 * the ":endif". That is, throw an interrupt exception if appropriate.
1021 * Doing this here prevents an exception for a parsing error being
1022 * discarded by throwing the interrupt exception later on.
1023 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001024 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001025 && dbg_check_skipped(eap))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001026 (void)do_intthrow(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001027
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001028 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 }
1030}
1031
1032/*
1033 * ":else" and ":elseif".
1034 */
1035 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001036ex_else(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037{
1038 int error;
1039 int skip;
1040 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001041 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042
1043 /*
1044 * Don't do something after an error, interrupt, or throw, or when there is
1045 * a surrounding conditional and it was not active.
1046 */
1047 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1048 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1049
1050 if (cstack->cs_idx < 0
Bram Moolenaar12805862005-01-05 22:16:17 +00001051 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001052 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001053 {
1054 if (eap->cmdidx == CMD_else)
1055 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001056 eap->errmsg = _(e_else_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 return;
1058 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001059 eap->errmsg = _(e_elseif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001060 skip = TRUE;
1061 }
1062 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
1063 {
1064 if (eap->cmdidx == CMD_else)
1065 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001066 eap->errmsg = _("E583: multiple :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 return;
1068 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001069 eap->errmsg = _("E584: :elseif after :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 skip = TRUE;
1071 }
1072
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001073 // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
1075 {
1076 if (eap->errmsg == NULL)
1077 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001078 skip = TRUE; // don't evaluate an ":elseif"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001079 }
1080 else
1081 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1082
1083 /*
1084 * When debugging or a breakpoint was encountered, display the debug prompt
1085 * (if not already done). This shows the user that an ":else" or ":elseif"
1086 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle
1087 * a ">quit" debug command as if an interrupt had occurred before the
1088 * ":else" or ":elseif". That is, set "skip" and throw an interrupt
1089 * exception if appropriate. Doing this here prevents that an exception
1090 * for a parsing errors is discarded when throwing the interrupt exception
1091 * later on.
1092 */
1093 if (!skip && dbg_check_skipped(eap) && got_int)
1094 {
1095 (void)do_intthrow(cstack);
1096 skip = TRUE;
1097 }
1098
1099 if (eap->cmdidx == CMD_elseif)
1100 {
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001101 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001102
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001103 // When throwing error exceptions, we want to throw always the first
1104 // of several errors in a row. This is what actually happens when
1105 // a conditional error was detected above and there is another failure
1106 // when parsing the expression. Since the skip flag is set in this
1107 // case, the parsing error will be ignored by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 if (!skip && !error)
1109 {
1110 if (result)
1111 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1112 else
1113 cstack->cs_flags[cstack->cs_idx] = 0;
1114 }
1115 else if (eap->errmsg == NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001116 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1118 }
1119 else
1120 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1121}
1122
1123/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001124 * Handle ":while" and ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 */
1126 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001127ex_while(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001128{
1129 int error;
1130 int skip;
1131 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001132 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133
1134 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001135 eap->errmsg = _("E585: :while/:for nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136 else
1137 {
1138 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001139 * The loop flag is set when we have jumped back from the matching
1140 * ":endwhile" or ":endfor". When not set, need to initialise this
1141 * cstack entry.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001143 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001145 enter_block(cstack);
Bram Moolenaar12805862005-01-05 22:16:17 +00001146 ++cstack->cs_looplevel;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 cstack->cs_line[cstack->cs_idx] = -1;
1148 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001149 cstack->cs_flags[cstack->cs_idx] =
1150 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001151
1152 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001153 * Don't do something after an error, interrupt, or throw, or when
1154 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 */
1156 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1157 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
Bram Moolenaar12805862005-01-05 22:16:17 +00001158 if (eap->cmdidx == CMD_while)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001160 /*
1161 * ":while bool-expr"
1162 */
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001163 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164 }
1165 else
1166 {
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001167 void *fi;
1168 evalarg_T evalarg;
1169
1170 CLEAR_FIELD(evalarg);
1171 evalarg.eval_flags = skip ? 0 : EVAL_EVALUATE;
1172 if (getline_equal(eap->getline, eap->cookie, getsourceline))
1173 {
1174 evalarg.eval_getline = eap->getline;
1175 evalarg.eval_cookie = eap->cookie;
1176 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001177
1178 /*
1179 * ":for var in list-expr"
1180 */
1181 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
1182 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001183 // Jumping here from a ":continue" or ":endfor": use the
1184 // previously evaluated list.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001185 fi = cstack->cs_forinfo[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001186 error = FALSE;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001187
1188 // the "in expr" is not used, skip over it
1189 skip_for_lines(fi, &evalarg);
Bram Moolenaar12805862005-01-05 22:16:17 +00001190 }
1191 else
1192 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001193 // Evaluate the argument and get the info in a structure.
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001194 fi = eval_for_line(eap->arg, &error, eap, &evalarg);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001195 cstack->cs_forinfo[cstack->cs_idx] = fi;
Bram Moolenaar12805862005-01-05 22:16:17 +00001196 }
1197
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001198 // use the element at the start of the list and advance
Bram Moolenaar12805862005-01-05 22:16:17 +00001199 if (!error && fi != NULL && !skip)
1200 result = next_for_item(fi, eap->arg);
1201 else
1202 result = FALSE;
1203
1204 if (!result)
1205 {
1206 free_for_info(fi);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001207 cstack->cs_forinfo[cstack->cs_idx] = NULL;
Bram Moolenaar12805862005-01-05 22:16:17 +00001208 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001209 clear_evalarg(&evalarg, eap);
Bram Moolenaar12805862005-01-05 22:16:17 +00001210 }
1211
1212 /*
1213 * If this cstack entry was just initialised and is active, set the
1214 * loop flag, so do_cmdline() will set the line number in cs_line[].
1215 * If executing the command a second time, clear the loop flag.
1216 */
1217 if (!skip && !error && result)
1218 {
1219 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
1220 cstack->cs_lflags ^= CSL_HAD_LOOP;
1221 }
1222 else
1223 {
1224 cstack->cs_lflags &= ~CSL_HAD_LOOP;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001225 // If the ":while" evaluates to FALSE or ":for" is past the end of
1226 // the list, show the debug prompt at the ":endwhile"/":endfor" as
1227 // if there was a ":break" in a ":while"/":for" evaluating to
1228 // TRUE.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 if (!skip && !error)
1230 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1231 }
1232 }
1233}
1234
1235/*
1236 * ":continue"
1237 */
1238 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001239ex_continue(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240{
1241 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001242 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001243
Bram Moolenaar12805862005-01-05 22:16:17 +00001244 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001245 eap->errmsg = _(e_continue);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 else
1247 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001248 // Try to find the matching ":while". This might stop at a try
1249 // conditional not in its finally clause (which is then to be executed
1250 // next). Therefor, inactivate all conditionals except the ":while"
1251 // itself (if reached).
Bram Moolenaar12805862005-01-05 22:16:17 +00001252 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001253 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 {
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001255 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256
1257 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001258 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001259 * matching ":while".
1260 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001261 cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 }
1263 else
1264 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001265 // If a try conditional not in its finally clause is reached first,
1266 // make the ":continue" pending for execution at the ":endtry".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267 cstack->cs_pending[idx] = CSTP_CONTINUE;
1268 report_make_pending(CSTP_CONTINUE, NULL);
1269 }
1270 }
1271}
1272
1273/*
1274 * ":break"
1275 */
1276 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001277ex_break(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278{
1279 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001280 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001281
Bram Moolenaar12805862005-01-05 22:16:17 +00001282 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001283 eap->errmsg = _(e_break);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001284 else
1285 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001286 // Inactivate conditionals until the matching ":while" or a try
1287 // conditional not in its finally clause (which is then to be
1288 // executed next) is found. In the latter case, make the ":break"
1289 // pending for execution at the ":endtry".
Bram Moolenaar12805862005-01-05 22:16:17 +00001290 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001291 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 {
1293 cstack->cs_pending[idx] = CSTP_BREAK;
1294 report_make_pending(CSTP_BREAK, NULL);
1295 }
1296 }
1297}
1298
1299/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001300 * ":endwhile" and ":endfor"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001301 */
1302 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001303ex_endwhile(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304{
Bram Moolenaarddef1292019-12-16 17:10:33 +01001305 cstack_T *cstack = eap->cstack;
1306 int idx;
1307 char *err;
1308 int csf;
1309 int fl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310
Bram Moolenaar12805862005-01-05 22:16:17 +00001311 if (eap->cmdidx == CMD_endwhile)
1312 {
1313 err = e_while;
1314 csf = CSF_WHILE;
1315 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 else
1317 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001318 err = e_for;
1319 csf = CSF_FOR;
1320 }
1321
1322 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001323 eap->errmsg = _(err);
Bram Moolenaar12805862005-01-05 22:16:17 +00001324 else
1325 {
1326 fl = cstack->cs_flags[cstack->cs_idx];
1327 if (!(fl & csf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001329 // If we are in a ":while" or ":for" but used the wrong endloop
1330 // command, do not rewind to the next enclosing ":for"/":while".
Bram Moolenaar12805862005-01-05 22:16:17 +00001331 if (fl & CSF_WHILE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001332 eap->errmsg = _("E732: Using :endfor with :while");
Bram Moolenaar12805862005-01-05 22:16:17 +00001333 else if (fl & CSF_FOR)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001334 eap->errmsg = _("E733: Using :endwhile with :for");
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00001335 }
1336 if (!(fl & (CSF_WHILE | CSF_FOR)))
1337 {
1338 if (!(fl & CSF_TRY))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001339 eap->errmsg = _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00001340 else if (fl & CSF_FINALLY)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001341 eap->errmsg = _(e_endtry);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001342 // Try to find the matching ":while" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 for (idx = cstack->cs_idx; idx > 0; --idx)
1344 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001345 fl = cstack->cs_flags[idx];
1346 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001348 // Give up at a try conditional not in its finally clause.
1349 // Ignore the ":endwhile"/":endfor".
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001350 eap->errmsg = _(err);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001351 return;
1352 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001353 if (fl & csf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 break;
1355 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001356 // Cleanup and rewind all contained (and unclosed) conditionals.
Bram Moolenaar12805862005-01-05 22:16:17 +00001357 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1359 }
1360
1361 /*
1362 * When debugging or a breakpoint was encountered, display the debug
1363 * prompt (if not already done). This shows the user that an
Bram Moolenaar12805862005-01-05 22:16:17 +00001364 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
1365 * after a ":break". Handle a ">quit" debug command as if an
1366 * interrupt had occurred before the ":endwhile"/":endfor". That is,
1367 * throw an interrupt exception if appropriate. Doing this here
1368 * prevents that an exception for a parsing error is discarded when
1369 * throwing the interrupt exception later on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 */
1371 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1372 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1373 && dbg_check_skipped(eap))
1374 (void)do_intthrow(cstack);
1375
1376 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001377 * Set loop flag, so do_cmdline() will jump back to the matching
1378 * ":while" or ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001379 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001380 cstack->cs_lflags |= CSL_HAD_ENDLOOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381 }
1382}
1383
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001384/*
1385 * "{" start of a block in Vim9 script
1386 */
1387 void
1388ex_block(exarg_T *eap)
1389{
1390 cstack_T *cstack = eap->cstack;
1391
1392 if (cstack->cs_idx == CSTACK_LEN - 1)
1393 eap->errmsg = _("E579: block nesting too deep");
1394 else
1395 {
1396 enter_block(cstack);
1397 cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE;
1398 }
1399}
1400
1401/*
1402 * "}" end of a block in Vim9 script
1403 */
1404 void
1405ex_endblock(exarg_T *eap)
1406{
1407 cstack_T *cstack = eap->cstack;
1408
1409 if (cstack->cs_idx < 0
1410 || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0)
1411 eap->errmsg = _(e_endblock_without_block);
1412 else
1413 leave_block(cstack);
1414}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415
1416/*
1417 * ":throw expr"
1418 */
1419 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001420ex_throw(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001421{
1422 char_u *arg = eap->arg;
1423 char_u *value;
1424
1425 if (*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001426 value = eval_to_string_skip(arg, eap, eap->skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001427 else
1428 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001429 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 value = NULL;
1431 }
1432
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001433 // On error or when an exception is thrown during argument evaluation, do
1434 // not throw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 if (!eap->skip && value != NULL)
1436 {
1437 if (throw_exception(value, ET_USER, NULL) == FAIL)
1438 vim_free(value);
1439 else
1440 do_throw(eap->cstack);
1441 }
1442}
1443
1444/*
Bram Moolenaar269ec652004-07-29 08:43:53 +00001445 * Throw the current exception through the specified cstack. Common routine
1446 * for ":throw" (user exception) and error and interrupt exceptions. Also
1447 * used for rethrowing an uncaught exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001448 */
1449 void
Bram Moolenaarddef1292019-12-16 17:10:33 +01001450do_throw(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451{
1452 int idx;
1453 int inactivate_try = FALSE;
1454
1455 /*
1456 * Cleanup and inactivate up to the next surrounding try conditional that
1457 * is not in its finally clause. Normally, do not inactivate the try
1458 * conditional itself, so that its ACTIVE flag can be tested below. But
1459 * if a previous error or interrupt has not been converted to an exception,
1460 * inactivate the try conditional, too, as if the conversion had been done,
Bram Moolenaar269ec652004-07-29 08:43:53 +00001461 * and reset the did_emsg or got_int flag, so this won't happen again at
1462 * the next surrounding try conditional.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001463 */
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001464#ifndef THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001465 if (did_emsg && !THROW_ON_ERROR)
1466 {
1467 inactivate_try = TRUE;
1468 did_emsg = FALSE;
1469 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001470#endif
1471#ifndef THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001472 if (got_int && !THROW_ON_INTERRUPT)
1473 {
1474 inactivate_try = TRUE;
1475 got_int = FALSE;
1476 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001477#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001478 idx = cleanup_conditionals(cstack, 0, inactivate_try);
1479 if (idx >= 0)
1480 {
1481 /*
1482 * If this try conditional is active and we are before its first
Bram Moolenaar269ec652004-07-29 08:43:53 +00001483 * ":catch", set THROWN so that the ":catch" commands will check
1484 * whether the exception matches. When the exception came from any of
1485 * the catch clauses, it will be made pending at the ":finally" (if
1486 * present) and rethrown at the ":endtry". This will also happen if
1487 * the try conditional is inactive. This is the case when we are
1488 * throwing an exception due to an error or interrupt on the way from
1489 * a preceding ":continue", ":break", ":return", ":finish", error or
1490 * interrupt (not converted to an exception) to the finally clause or
1491 * from a preceding throw of a user or error or interrupt exception to
1492 * the matching catch clause or the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001493 */
1494 if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1495 {
1496 if (cstack->cs_flags[idx] & CSF_ACTIVE)
1497 cstack->cs_flags[idx] |= CSF_THROWN;
1498 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001499 // THROWN may have already been set for a catchable exception
1500 // that has been discarded. Ensure it is reset for the new
1501 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001502 cstack->cs_flags[idx] &= ~CSF_THROWN;
1503 }
1504 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1505 cstack->cs_exception[idx] = current_exception;
1506 }
1507#if 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001508 // TODO: Add optimization below. Not yet done because of interface
1509 // problems to eval.c and ex_cmds2.c. (Servatius)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001510 else
1511 {
1512 /*
1513 * There are no catch clauses to check or finally clauses to execute.
1514 * End the current script or function. The exception will be rethrown
1515 * in the caller.
1516 */
1517 if (getline_equal(eap->getline, eap->cookie, get_func_line))
1518 current_funccal->returned = TRUE;
1519 elseif (eap->get_func_line == getsourceline)
1520 ((struct source_cookie *)eap->cookie)->finished = TRUE;
1521 }
1522#endif
1523
1524 did_throw = TRUE;
1525}
1526
1527/*
1528 * ":try"
1529 */
1530 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001531ex_try(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532{
1533 int skip;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001534 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535
1536 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001537 eap->errmsg = _("E601: :try nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 else
1539 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001540 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001541 ++cstack->cs_trylevel;
1542 cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1543 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1544
1545 /*
1546 * Don't do something after an error, interrupt, or throw, or when there
1547 * is a surrounding conditional and it was not active.
1548 */
1549 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1550 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1551
1552 if (!skip)
1553 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001554 // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch"
1555 // commands should check for a match if an exception is thrown and
1556 // that the finally clause needs to be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001557 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1558
1559 /*
1560 * ":silent!", even when used in a try conditional, disables
1561 * displaying of error messages and conversion of errors to
1562 * exceptions. When the silent commands again open a try
1563 * conditional, save "emsg_silent" and reset it so that errors are
1564 * again converted to exceptions. The value is restored when that
1565 * try conditional is left. If it is left normally, the commands
1566 * following the ":endtry" are again silent. If it is left by
1567 * a ":continue", ":break", ":return", or ":finish", the commands
1568 * executed next are again silent. If it is left due to an
1569 * aborting error, an interrupt, or an exception, restoring
1570 * "emsg_silent" does not matter since we are already in the
1571 * aborting state and/or the exception has already been thrown.
1572 * The effect is then just freeing the memory that was allocated
1573 * to save the value.
1574 */
1575 if (emsg_silent)
1576 {
1577 eslist_T *elem;
1578
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001579 elem = ALLOC_ONE(struct eslist_elem);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 if (elem == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001581 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 else
1583 {
1584 elem->saved_emsg_silent = emsg_silent;
1585 elem->next = cstack->cs_emsg_silent_list;
1586 cstack->cs_emsg_silent_list = elem;
1587 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1588 emsg_silent = 0;
1589 }
1590 }
1591 }
1592
1593 }
1594}
1595
1596/*
1597 * ":catch /{pattern}/" and ":catch"
1598 */
1599 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001600ex_catch(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601{
1602 int idx = 0;
1603 int give_up = FALSE;
1604 int skip = FALSE;
1605 int caught = FALSE;
1606 char_u *end;
1607 int save_char = 0;
1608 char_u *save_cpo;
1609 regmatch_T regmatch;
1610 int prev_got_int;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001611 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001612 char_u *pat;
1613
1614 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1615 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001616 eap->errmsg = _(e_catch);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617 give_up = TRUE;
1618 }
1619 else
1620 {
1621 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1622 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001623 // Report what's missing if the matching ":try" is not in its
1624 // finally clause.
Bram Moolenaar12805862005-01-05 22:16:17 +00001625 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 skip = TRUE;
1627 }
1628 for (idx = cstack->cs_idx; idx > 0; --idx)
1629 if (cstack->cs_flags[idx] & CSF_TRY)
1630 break;
1631 if (cstack->cs_flags[idx] & CSF_FINALLY)
1632 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001633 // Give up for a ":catch" after ":finally" and ignore it.
1634 // Just parse.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001635 eap->errmsg = _("E604: :catch after :finally");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001636 give_up = TRUE;
1637 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001638 else
Bram Moolenaar12805862005-01-05 22:16:17 +00001639 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1640 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641 }
1642
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001643 if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644 {
1645 pat = (char_u *)".*";
1646 end = NULL;
1647 eap->nextcmd = find_nextcmd(eap->arg);
1648 }
1649 else
1650 {
1651 pat = eap->arg + 1;
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001652 end = skip_regexp_err(pat, *eap->arg, TRUE);
1653 if (end == NULL)
1654 give_up = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001655 }
1656
1657 if (!give_up)
1658 {
1659 /*
1660 * Don't do something when no exception has been thrown or when the
1661 * corresponding try block never got active (because of an inactive
1662 * surrounding conditional or after an error or interrupt or throw).
1663 */
1664 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1665 skip = TRUE;
1666
1667 /*
1668 * Check for a match only if an exception is thrown but not caught by
1669 * a previous ":catch". An exception that has replaced a discarded
1670 * exception is not checked (THROWN is not set then).
1671 */
1672 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1673 && !(cstack->cs_flags[idx] & CSF_CAUGHT))
1674 {
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001675 if (end != NULL && *end != NUL
1676 && !ends_excmd2(end, skipwhite(end + 1)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001678 semsg(_(e_trailing_arg), end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001679 return;
1680 }
1681
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001682 // When debugging or a breakpoint was encountered, display the
1683 // debug prompt (if not already done) before checking for a match.
1684 // This is a helpful hint for the user when the regular expression
1685 // matching fails. Handle a ">quit" debug command as if an
1686 // interrupt had occurred before the ":catch". That is, discard
1687 // the original exception, replace it by an interrupt exception,
1688 // and don't catch it in this try block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1690 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001691 // Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1692 // while compiling it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693 if (end != NULL)
1694 {
1695 save_char = *end;
1696 *end = NUL;
1697 }
1698 save_cpo = p_cpo;
1699 p_cpo = (char_u *)"";
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001700 // Disable error messages, it will make current_exception
1701 // invalid.
Bram Moolenaar768ce242016-02-07 19:46:12 +01001702 ++emsg_off;
Bram Moolenaar150cc272007-08-01 13:47:46 +00001703 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
Bram Moolenaar768ce242016-02-07 19:46:12 +01001704 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 regmatch.rm_ic = FALSE;
1706 if (end != NULL)
1707 *end = save_char;
1708 p_cpo = save_cpo;
1709 if (regmatch.regprog == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001710 semsg(_(e_invarg2), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001711 else
1712 {
1713 /*
1714 * Save the value of got_int and reset it. We don't want
1715 * a previous interruption cancel matching, only hitting
1716 * CTRL-C while matching should abort it.
1717 */
1718 prev_got_int = got_int;
1719 got_int = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001720 caught = vim_regexec_nl(&regmatch,
1721 (char_u *)current_exception->value, (colnr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 got_int |= prev_got_int;
Bram Moolenaar473de612013-06-08 18:19:48 +02001723 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 }
1725 }
1726 }
1727
1728 if (caught)
1729 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001730 // Make this ":catch" clause active and reset did_emsg, got_int,
1731 // and did_throw. Put the exception on the caught stack.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1733 did_emsg = got_int = did_throw = FALSE;
1734 catch_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001735 // It's mandatory that the current exception is stored in the cstack
1736 // so that it can be discarded at the next ":catch", ":finally", or
1737 // ":endtry" or when the catch clause is left by a ":continue",
1738 // ":break", ":return", ":finish", error, interrupt, or another
1739 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001740 if (cstack->cs_exception[cstack->cs_idx] != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001741 internal_error("ex_catch()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001742 }
1743 else
1744 {
1745 /*
1746 * If there is a preceding catch clause and it caught the exception,
1747 * finish the exception now. This happens also after errors except
1748 * when this ":catch" was after the ":finally" or not within
1749 * a ":try". Make the try conditional inactive so that the
1750 * following catch clauses are skipped. On an error or interrupt
1751 * after the preceding try block or catch clause was left by
1752 * a ":continue", ":break", ":return", or ":finish", discard the
1753 * pending action.
1754 */
1755 cleanup_conditionals(cstack, CSF_TRY, TRUE);
1756 }
1757 }
1758
1759 if (end != NULL)
1760 eap->nextcmd = find_nextcmd(end);
1761}
1762
1763/*
1764 * ":finally"
1765 */
1766 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001767ex_finally(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001768{
1769 int idx;
1770 int skip = FALSE;
1771 int pending = CSTP_NONE;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001772 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773
1774 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001775 eap->errmsg = _(e_finally);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 else
1777 {
1778 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1779 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001780 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1782 if (cstack->cs_flags[idx] & CSF_TRY)
1783 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001784 // Make this error pending, so that the commands in the following
1785 // finally clause can be executed. This overrules also a pending
1786 // ":continue", ":break", ":return", or ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001787 pending = CSTP_ERROR;
1788 }
1789 else
1790 idx = cstack->cs_idx;
1791
1792 if (cstack->cs_flags[idx] & CSF_FINALLY)
1793 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001794 // Give up for a multiple ":finally" and ignore it.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001795 eap->errmsg = _(e_finally_dup);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 return;
1797 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001798 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
Bram Moolenaar12805862005-01-05 22:16:17 +00001799 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800
1801 /*
1802 * Don't do something when the corresponding try block never got active
1803 * (because of an inactive surrounding conditional or after an error or
1804 * interrupt or throw) or for a ":finally" without ":try" or a multiple
1805 * ":finally". After every other error (did_emsg or the conditional
1806 * errors detected above) or after an interrupt (got_int) or an
1807 * exception (did_throw), the finally clause must be executed.
1808 */
1809 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1810
1811 if (!skip)
1812 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001813 // When debugging or a breakpoint was encountered, display the
1814 // debug prompt (if not already done). The user then knows that the
1815 // finally clause is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816 if (dbg_check_skipped(eap))
1817 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001818 // Handle a ">quit" debug command as if an interrupt had
1819 // occurred before the ":finally". That is, discard the
1820 // original exception and replace it by an interrupt
1821 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822 (void)do_intthrow(cstack);
1823 }
1824
1825 /*
1826 * If there is a preceding catch clause and it caught the exception,
1827 * finish the exception now. This happens also after errors except
1828 * when this is a multiple ":finally" or one not within a ":try".
1829 * After an error or interrupt, this also discards a pending
1830 * ":continue", ":break", ":finish", or ":return" from the preceding
1831 * try block or catch clause.
1832 */
1833 cleanup_conditionals(cstack, CSF_TRY, FALSE);
1834
1835 /*
1836 * Make did_emsg, got_int, did_throw pending. If set, they overrule
1837 * a pending ":continue", ":break", ":return", or ":finish". Then
1838 * we have particularly to discard a pending return value (as done
1839 * by the call to cleanup_conditionals() above when did_emsg or
1840 * got_int is set). The pending values are restored by the
1841 * ":endtry", except if there is a new error, interrupt, exception,
1842 * ":continue", ":break", ":return", or ":finish" in the following
Bram Moolenaar12805862005-01-05 22:16:17 +00001843 * finally clause. A missing ":endwhile", ":endfor" or ":endif"
1844 * detected here is treated as if did_emsg and did_throw had
1845 * already been set, respectively in case that the error is not
1846 * converted to an exception, did_throw had already been unset.
1847 * We must not set did_emsg here since that would suppress the
1848 * error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849 */
1850 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1851 {
1852 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
1853 {
1854 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001855 cstack->cs_rettv[cstack->cs_idx]);
1856 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001857 }
1858 if (pending == CSTP_ERROR && !did_emsg)
1859 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
1860 else
1861 pending |= did_throw ? CSTP_THROW : 0;
1862 pending |= did_emsg ? CSTP_ERROR : 0;
1863 pending |= got_int ? CSTP_INTERRUPT : 0;
1864 cstack->cs_pending[cstack->cs_idx] = pending;
1865
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001866 // It's mandatory that the current exception is stored in the
1867 // cstack so that it can be rethrown at the ":endtry" or be
1868 // discarded if the finally clause is left by a ":continue",
1869 // ":break", ":return", ":finish", error, interrupt, or another
1870 // exception. When emsg() is called for a missing ":endif" or
1871 // a missing ":endwhile"/":endfor" detected here, the
1872 // exception will be discarded.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001873 if (did_throw && cstack->cs_exception[cstack->cs_idx]
1874 != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001875 internal_error("ex_finally()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001876 }
1877
1878 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001879 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001880 * got_int, and did_throw and make the finally clause active.
1881 * This will happen after emsg() has been called for a missing
Bram Moolenaar12805862005-01-05 22:16:17 +00001882 * ":endif" or a missing ":endwhile"/":endfor" detected here, so
1883 * that the following finally clause will be executed even then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001884 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001885 cstack->cs_lflags |= CSL_HAD_FINA;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001886 }
1887 }
1888}
1889
1890/*
1891 * ":endtry"
1892 */
1893 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001894ex_endtry(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001895{
1896 int idx;
1897 int skip;
1898 int rethrow = FALSE;
1899 int pending = CSTP_NONE;
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001900 void *rettv = NULL;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001901 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001902
1903 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001904 eap->errmsg = _(e_no_endtry);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 else
1906 {
1907 /*
1908 * Don't do something after an error, interrupt or throw in the try
1909 * block, catch clause, or finally clause preceding this ":endtry" or
1910 * when an error or interrupt occurred after a ":continue", ":break",
1911 * ":return", or ":finish" in a try block or catch clause preceding this
1912 * ":endtry" or when the try block never got active (because of an
1913 * inactive surrounding conditional or after an error or interrupt or
1914 * throw) or when there is a surrounding conditional and it has been
1915 * made inactive by a ":continue", ":break", ":return", or ":finish" in
1916 * the finally clause. The latter case need not be tested since then
1917 * anything pending has already been discarded. */
1918 skip = did_emsg || got_int || did_throw ||
1919 !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1920
1921 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1922 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001923 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001924 // Find the matching ":try" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001925 idx = cstack->cs_idx;
1926 do
1927 --idx;
1928 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
Bram Moolenaar12805862005-01-05 22:16:17 +00001929 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1930 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 skip = TRUE;
1932
1933 /*
1934 * If an exception is being thrown, discard it to prevent it from
1935 * being rethrown at the end of this function. It would be
1936 * discarded by the error message, anyway. Resets did_throw.
1937 * This does not affect the script termination due to the error
1938 * since "trylevel" is decremented after emsg() has been called.
1939 */
1940 if (did_throw)
1941 discard_current_exception();
1942 }
1943 else
1944 {
1945 idx = cstack->cs_idx;
1946
1947 /*
1948 * If we stopped with the exception currently being thrown at this
1949 * try conditional since we didn't know that it doesn't have
1950 * a finally clause, we need to rethrow it after closing the try
1951 * conditional.
1952 */
1953 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
1954 && !(cstack->cs_flags[idx] & CSF_FINALLY))
1955 rethrow = TRUE;
1956 }
1957
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001958 // If there was no finally clause, show the user when debugging or
1959 // a breakpoint was encountered that the end of the try conditional has
1960 // been reached: display the debug prompt (if not already done). Do
1961 // this on normal control flow or when an exception was thrown, but not
1962 // on an interrupt or error not converted to an exception or when
1963 // a ":break", ":continue", ":return", or ":finish" is pending. These
1964 // actions are carried out immediately.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001965 if ((rethrow || (!skip
1966 && !(cstack->cs_flags[idx] & CSF_FINALLY)
1967 && !cstack->cs_pending[idx]))
1968 && dbg_check_skipped(eap))
1969 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001970 // Handle a ">quit" debug command as if an interrupt had occurred
1971 // before the ":endtry". That is, throw an interrupt exception and
1972 // set "skip" and "rethrow".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 if (got_int)
1974 {
1975 skip = TRUE;
1976 (void)do_intthrow(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001977 // The do_intthrow() call may have reset did_throw or
1978 // cstack->cs_pending[idx].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001979 rethrow = FALSE;
1980 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY))
1981 rethrow = TRUE;
1982 }
1983 }
1984
1985 /*
1986 * If a ":return" is pending, we need to resume it after closing the
1987 * try conditional; remember the return value. If there was a finally
1988 * clause making an exception pending, we need to rethrow it. Make it
1989 * the exception currently being thrown.
1990 */
1991 if (!skip)
1992 {
1993 pending = cstack->cs_pending[idx];
1994 cstack->cs_pending[idx] = CSTP_NONE;
1995 if (pending == CSTP_RETURN)
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001996 rettv = cstack->cs_rettv[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 else if (pending & CSTP_THROW)
1998 current_exception = cstack->cs_exception[idx];
1999 }
2000
2001 /*
2002 * Discard anything pending on an error, interrupt, or throw in the
2003 * finally clause. If there was no ":finally", discard a pending
2004 * ":continue", ":break", ":return", or ":finish" if an error or
2005 * interrupt occurred afterwards, but before the ":endtry" was reached.
2006 * If an exception was caught by the last of the catch clauses and there
2007 * was no finally clause, finish the exception now. This happens also
2008 * after errors except when this ":endtry" is not within a ":try".
2009 * Restore "emsg_silent" if it has been reset by this try conditional.
2010 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002011 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002013 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 --cstack->cs_trylevel;
2015
2016 if (!skip)
2017 {
2018 report_resume_pending(pending,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002019 (pending == CSTP_RETURN) ? rettv :
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2021 switch (pending)
2022 {
2023 case CSTP_NONE:
2024 break;
2025
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002026 // Reactivate a pending ":continue", ":break", ":return",
2027 // ":finish" from the try block or a catch clause of this try
2028 // conditional. This is skipped, if there was an error in an
2029 // (unskipped) conditional command or an interrupt afterwards
2030 // or if the finally clause is present and executed a new error,
2031 // interrupt, throw, ":continue", ":break", ":return", or
2032 // ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 case CSTP_CONTINUE:
2034 ex_continue(eap);
2035 break;
2036 case CSTP_BREAK:
2037 ex_break(eap);
2038 break;
2039 case CSTP_RETURN:
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002040 do_return(eap, FALSE, FALSE, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002041 break;
2042 case CSTP_FINISH:
2043 do_finish(eap, FALSE);
2044 break;
2045
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002046 // When the finally clause was entered due to an error,
2047 // interrupt or throw (as opposed to a ":continue", ":break",
2048 // ":return", or ":finish"), restore the pending values of
2049 // did_emsg, got_int, and did_throw. This is skipped, if there
2050 // was a new error, interrupt, throw, ":continue", ":break",
2051 // ":return", or ":finish". in the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002052 default:
2053 if (pending & CSTP_ERROR)
2054 did_emsg = TRUE;
2055 if (pending & CSTP_INTERRUPT)
2056 got_int = TRUE;
2057 if (pending & CSTP_THROW)
2058 rethrow = TRUE;
2059 break;
2060 }
2061 }
2062
2063 if (rethrow)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002064 // Rethrow the current exception (within this cstack).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002065 do_throw(cstack);
2066 }
2067}
2068
2069/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002070 * enter_cleanup() and leave_cleanup()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002071 *
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002072 * Functions to be called before/after invoking a sequence of autocommands for
2073 * cleanup for a failed command. (Failure means here that a call to emsg()
2074 * has been made, an interrupt occurred, or there is an uncaught exception
2075 * from a previous autocommand execution of the same command.)
2076 *
2077 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same
2078 * pointer to leave_cleanup(). The cleanup_T structure stores the pending
2079 * error/interrupt/exception state.
2080 */
2081
2082/*
2083 * This function works a bit like ex_finally() except that there was not
2084 * actually an extra try block around the part that failed and an error or
2085 * interrupt has not (yet) been converted to an exception. This function
2086 * saves the error/interrupt/ exception state and prepares for the call to
2087 * do_cmdline() that is going to be made for the cleanup autocommand
2088 * execution.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002089 */
2090 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002091enter_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002092{
2093 int pending = CSTP_NONE;
2094
2095 /*
2096 * Postpone did_emsg, got_int, did_throw. The pending values will be
2097 * restored by leave_cleanup() except if there was an aborting error,
2098 * interrupt, or uncaught exception after this function ends.
2099 */
2100 if (did_emsg || got_int || did_throw || need_rethrow)
2101 {
2102 csp->pending = (did_emsg ? CSTP_ERROR : 0)
2103 | (got_int ? CSTP_INTERRUPT : 0)
2104 | (did_throw ? CSTP_THROW : 0)
2105 | (need_rethrow ? CSTP_THROW : 0);
2106
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002107 // If we are currently throwing an exception (did_throw), save it as
2108 // well. On an error not yet converted to an exception, update
2109 // "force_abort" and reset "cause_abort" (as do_errthrow() would do).
2110 // This is needed for the do_cmdline() call that is going to be made
2111 // for autocommand execution. We need not save *msg_list because
2112 // there is an extra instance for every call of do_cmdline(), anyway.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002113 if (did_throw || need_rethrow)
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002114 {
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002115 csp->exception = current_exception;
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002116 current_exception = NULL;
2117 }
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002118 else
2119 {
2120 csp->exception = NULL;
2121 if (did_emsg)
2122 {
2123 force_abort |= cause_abort;
2124 cause_abort = FALSE;
2125 }
2126 }
2127 did_emsg = got_int = did_throw = need_rethrow = FALSE;
2128
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002129 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002130 report_make_pending(pending, csp->exception);
2131 }
2132 else
2133 {
2134 csp->pending = CSTP_NONE;
2135 csp->exception = NULL;
2136 }
2137}
2138
2139/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002140 * See comment above enter_cleanup() for how this function is used.
2141 *
2142 * This function is a bit like ex_endtry() except that there was not actually
2143 * an extra try block around the part that failed and an error or interrupt
2144 * had not (yet) been converted to an exception when the cleanup autocommand
2145 * sequence was invoked.
2146 *
2147 * This function has to be called with the address of the cleanup_T structure
2148 * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2149 * exception state saved by that function - except there was an aborting
2150 * error, an interrupt or an uncaught exception during execution of the
2151 * cleanup autocommands. In the latter case, the saved error/interrupt/
2152 * exception state is discarded.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002153 */
2154 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002155leave_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002156{
2157 int pending = csp->pending;
2158
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002159 if (pending == CSTP_NONE) // nothing to do
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002160 return;
2161
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002162 // If there was an aborting error, an interrupt, or an uncaught exception
2163 // after the corresponding call to enter_cleanup(), discard what has been
2164 // made pending by it. Report this to the user if required by the
2165 // 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002166 if (aborting() || need_rethrow)
2167 {
2168 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002169 // Cancel the pending exception (includes report).
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002170 discard_exception((except_T *)csp->exception, FALSE);
2171 else
2172 report_discard_pending(pending, NULL);
2173
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002174 // If an error was about to be converted to an exception when
2175 // enter_cleanup() was called, free the message list.
Bram Moolenaar4632d292006-11-28 17:36:37 +00002176 if (msg_list != NULL)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +01002177 free_global_msglist();
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002178 }
2179
2180 /*
2181 * If there was no new error, interrupt, or throw between the calls
2182 * to enter_cleanup() and leave_cleanup(), restore the pending
2183 * error/interrupt/exception state.
2184 */
2185 else
2186 {
2187 /*
2188 * If there was an exception being thrown when enter_cleanup() was
2189 * called, we need to rethrow it. Make it the exception currently
2190 * being thrown.
2191 */
2192 if (pending & CSTP_THROW)
2193 current_exception = csp->exception;
2194
2195 /*
2196 * If an error was about to be converted to an exception when
2197 * enter_cleanup() was called, let "cause_abort" take the part of
2198 * "force_abort" (as done by cause_errthrow()).
2199 */
2200 else if (pending & CSTP_ERROR)
2201 {
2202 cause_abort = force_abort;
2203 force_abort = FALSE;
2204 }
2205
2206 /*
2207 * Restore the pending values of did_emsg, got_int, and did_throw.
2208 */
2209 if (pending & CSTP_ERROR)
2210 did_emsg = TRUE;
2211 if (pending & CSTP_INTERRUPT)
2212 got_int = TRUE;
2213 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002214 need_rethrow = TRUE; // did_throw will be set by do_one_cmd()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002215
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002216 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002217 report_resume_pending(pending,
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002218 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002219 }
2220}
2221
2222
2223/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 * Make conditionals inactive and discard what's pending in finally clauses
2225 * until the conditional type searched for or a try conditional not in its
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002226 * finally clause is reached. If this is in an active catch clause, finish
2227 * the caught exception.
2228 * Return the cstack index where the search stopped.
Bram Moolenaar12805862005-01-05 22:16:17 +00002229 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
2230 * the latter meaning the innermost try conditional not in its finally clause.
2231 * "inclusive" tells whether the conditional searched for should be made
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002232 * inactive itself (a try conditional not in its finally clause possibly find
Bram Moolenaar12805862005-01-05 22:16:17 +00002233 * before is always made inactive). If "inclusive" is TRUE and
2234 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
2235 * "emsg_silent", if reset when the try conditional finally reached was
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002236 * entered, is restored (used by ex_endtry()). This is normally done only
Bram Moolenaar12805862005-01-05 22:16:17 +00002237 * when such a try conditional is left.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002238 */
2239 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002240cleanup_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002241 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002242 int searched_cond,
2243 int inclusive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244{
2245 int idx;
2246 int stop = FALSE;
2247
2248 for (idx = cstack->cs_idx; idx >= 0; --idx)
2249 {
2250 if (cstack->cs_flags[idx] & CSF_TRY)
2251 {
2252 /*
2253 * Discard anything pending in a finally clause and continue the
2254 * search. There may also be a pending ":continue", ":break",
2255 * ":return", or ":finish" before the finally clause. We must not
2256 * discard it, unless an error or interrupt occurred afterwards.
2257 */
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002258 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002259 {
2260 switch (cstack->cs_pending[idx])
2261 {
2262 case CSTP_NONE:
2263 break;
2264
2265 case CSTP_CONTINUE:
2266 case CSTP_BREAK:
2267 case CSTP_FINISH:
2268 report_discard_pending(cstack->cs_pending[idx], NULL);
2269 cstack->cs_pending[idx] = CSTP_NONE;
2270 break;
2271
2272 case CSTP_RETURN:
2273 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002274 cstack->cs_rettv[idx]);
2275 discard_pending_return(cstack->cs_rettv[idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276 cstack->cs_pending[idx] = CSTP_NONE;
2277 break;
2278
2279 default:
2280 if (cstack->cs_flags[idx] & CSF_FINALLY)
2281 {
2282 if (cstack->cs_pending[idx] & CSTP_THROW)
2283 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002284 // Cancel the pending exception. This is in the
2285 // finally clause, so that the stack of the
2286 // caught exceptions is not involved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 discard_exception((except_T *)
2288 cstack->cs_exception[idx],
2289 FALSE);
2290 }
2291 else
2292 report_discard_pending(cstack->cs_pending[idx],
2293 NULL);
2294 cstack->cs_pending[idx] = CSTP_NONE;
2295 }
2296 break;
2297 }
2298 }
2299
2300 /*
2301 * Stop at a try conditional not in its finally clause. If this try
2302 * conditional is in an active catch clause, finish the caught
2303 * exception.
2304 */
2305 if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2306 {
2307 if ((cstack->cs_flags[idx] & CSF_ACTIVE)
2308 && (cstack->cs_flags[idx] & CSF_CAUGHT))
2309 finish_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002310 // Stop at this try conditional - except the try block never
2311 // got active (because of an inactive surrounding conditional
2312 // or when the ":try" appeared after an error or interrupt or
2313 // throw).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 if (cstack->cs_flags[idx] & CSF_TRUE)
2315 {
2316 if (searched_cond == 0 && !inclusive)
2317 break;
2318 stop = TRUE;
2319 }
2320 }
2321 }
2322
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002323 // Stop on the searched conditional type (even when the surrounding
2324 // conditional is not active or something has been made pending).
2325 // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2326 // check first whether "emsg_silent" needs to be restored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 if (cstack->cs_flags[idx] & searched_cond)
2328 {
2329 if (!inclusive)
2330 break;
2331 stop = TRUE;
2332 }
2333 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2334 if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2335 break;
2336
2337 /*
Bram Moolenaarccc18222007-05-10 18:25:20 +00002338 * When leaving a try conditional that reset "emsg_silent" on its
2339 * entry after saving the original value, restore that value here and
2340 * free the memory used to store it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 */
2342 if ((cstack->cs_flags[idx] & CSF_TRY)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002343 && (cstack->cs_flags[idx] & CSF_SILENT))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344 {
2345 eslist_T *elem;
2346
2347 elem = cstack->cs_emsg_silent_list;
2348 cstack->cs_emsg_silent_list = elem->next;
2349 emsg_silent = elem->saved_emsg_silent;
2350 vim_free(elem);
2351 cstack->cs_flags[idx] &= ~CSF_SILENT;
2352 }
2353 if (stop)
2354 break;
2355 }
2356 return idx;
2357}
2358
2359/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002360 * Return an appropriate error message for a missing endwhile/endfor/endif.
2361 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002362 static char *
Bram Moolenaarddef1292019-12-16 17:10:33 +01002363get_end_emsg(cstack_T *cstack)
Bram Moolenaar12805862005-01-05 22:16:17 +00002364{
2365 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002366 return _(e_endwhile);
Bram Moolenaar12805862005-01-05 22:16:17 +00002367 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002368 return _(e_endfor);
2369 return _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00002370}
2371
2372
2373/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374 * Rewind conditionals until index "idx" is reached. "cond_type" and
2375 * "cond_level" specify a conditional type and the address of a level variable
2376 * which is to be decremented with each skipped conditional of the specified
2377 * type.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002378 * Also free "for info" structures where needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002380 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002381rewind_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002382 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002383 int idx,
2384 int cond_type,
2385 int *cond_level)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386{
2387 while (cstack->cs_idx > idx)
2388 {
2389 if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2390 --*cond_level;
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002391 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2392 free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002393 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 }
2395}
2396
2397/*
2398 * ":endfunction" when not after a ":function"
2399 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 void
Bram Moolenaar6e949782020-04-13 17:21:00 +02002401ex_endfunction(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402{
Bram Moolenaar6e949782020-04-13 17:21:00 +02002403 if (eap->cmdidx == CMD_enddef)
2404 emsg(_("E193: :enddef not inside a function"));
2405 else
2406 emsg(_("E193: :endfunction not inside a function"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407}
2408
2409/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002410 * Return TRUE if the string "p" looks like a ":while" or ":for" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002411 */
2412 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002413has_loop_cmd(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414{
Bram Moolenaared53fb92007-11-24 20:50:24 +00002415 int len;
2416
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002417 // skip modifiers, white space and ':'
Bram Moolenaared53fb92007-11-24 20:50:24 +00002418 for (;;)
2419 {
2420 while (*p == ' ' || *p == '\t' || *p == ':')
2421 ++p;
2422 len = modifier_len(p);
2423 if (len == 0)
2424 break;
2425 p += len;
2426 }
Bram Moolenaar12805862005-01-05 22:16:17 +00002427 if ((p[0] == 'w' && p[1] == 'h')
2428 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 return TRUE;
2430 return FALSE;
2431}
2432
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002433#endif // FEAT_EVAL