blob: 1af21c2a8e7b8574a3174677c6a238641ead8c47 [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
Bram Moolenaar13656f02020-12-19 17:55:54 +0100609 if (current_exception == excp)
610 current_exception = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 if (excp == NULL)
612 {
Bram Moolenaar95f09602016-11-10 20:01:45 +0100613 internal_error("discard_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000614 return;
615 }
616
617 if (p_verbose >= 13 || debug_break_level > 0)
618 {
619 int save_msg_silent = msg_silent;
620
621 saved_IObuff = vim_strsave(IObuff);
622 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100623 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000624 else
625 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000626 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000627 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100628 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar051b7822005-05-19 21:00:46 +0000629 smsg(was_finished
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100630 ? _("Exception finished: %s")
631 : _("Exception discarded: %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +0000632 excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100633 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000634 if (debug_break_level > 0 || *p_vfile == NUL)
635 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000636 --no_wait_return;
637 if (debug_break_level > 0)
638 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000639 else
640 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000641 STRCPY(IObuff, saved_IObuff);
642 vim_free(saved_IObuff);
643 }
644 if (excp->type != ET_INTERRUPT)
645 vim_free(excp->value);
646 if (excp->type == ET_ERROR)
647 free_msglist(excp->messages);
648 vim_free(excp->throw_name);
649 vim_free(excp);
650}
651
652/*
653 * Discard the exception currently being thrown.
654 */
655 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100656discard_current_exception(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657{
Bram Moolenaarcae24be2017-07-10 22:12:10 +0200658 if (current_exception != NULL)
Bram Moolenaarcae24be2017-07-10 22:12:10 +0200659 discard_exception(current_exception, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 did_throw = FALSE;
661 need_rethrow = FALSE;
662}
663
664/*
665 * Put an exception on the caught stack.
666 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100667 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100668catch_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669{
670 excp->caught = caught_stack;
671 caught_stack = excp;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100672 set_vim_var_string(VV_EXCEPTION, (char_u *)excp->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000673 if (*excp->throw_name != NUL)
674 {
675 if (excp->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000676 vim_snprintf((char *)IObuff, IOSIZE, _("%s, line %ld"),
677 excp->throw_name, (long)excp->throw_lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000679 vim_snprintf((char *)IObuff, IOSIZE, "%s", excp->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
681 }
682 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100683 // throw_name not set on an exception from a command that was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684 set_vim_var_string(VV_THROWPOINT, NULL, -1);
685
686 if (p_verbose >= 13 || debug_break_level > 0)
687 {
688 int save_msg_silent = msg_silent;
689
690 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100691 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000692 else
693 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000695 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100696 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000697
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100698 smsg(_("Exception caught: %s"), excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100699 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000700
701 if (debug_break_level > 0 || *p_vfile == NUL)
702 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 --no_wait_return;
704 if (debug_break_level > 0)
705 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000706 else
707 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 }
709}
710
711/*
712 * Remove an exception from the caught stack.
713 */
714 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100715finish_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716{
717 if (excp != caught_stack)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100718 internal_error("finish_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000719 caught_stack = caught_stack->caught;
720 if (caught_stack != NULL)
721 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100722 set_vim_var_string(VV_EXCEPTION, (char_u *)caught_stack->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 if (*caught_stack->throw_name != NUL)
724 {
725 if (caught_stack->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000726 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000727 _("%s, line %ld"), caught_stack->throw_name,
728 (long)caught_stack->throw_lnum);
729 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000730 vim_snprintf((char *)IObuff, IOSIZE, "%s",
731 caught_stack->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
733 }
734 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100735 // throw_name not set on an exception from a command that was
736 // typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000737 set_vim_var_string(VV_THROWPOINT, NULL, -1);
738 }
739 else
740 {
741 set_vim_var_string(VV_EXCEPTION, NULL, -1);
742 set_vim_var_string(VV_THROWPOINT, NULL, -1);
743 }
744
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100745 // Discard the exception, but use the finish message for 'verbose'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 discard_exception(excp, TRUE);
747}
748
749/*
750 * Flags specifying the message displayed by report_pending.
751 */
752#define RP_MAKE 0
753#define RP_RESUME 1
754#define RP_DISCARD 2
755
756/*
757 * Report information about something pending in a finally clause if required by
758 * the 'verbose' option or when debugging. "action" tells whether something is
759 * made pending or something pending is resumed or discarded. "pending" tells
760 * what is pending. "value" specifies the return value for a pending ":return"
761 * or the exception value for a pending exception.
762 */
763 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100764report_pending(int action, int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000765{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100766 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 char *s;
768 int save_msg_silent;
769
770
771 switch (action)
772 {
773 case RP_MAKE:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100774 mesg = _("%s made pending");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 break;
776 case RP_RESUME:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100777 mesg = _("%s resumed");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000778 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100779 // case RP_DISCARD:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000780 default:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100781 mesg = _("%s discarded");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 break;
783 }
784
785 switch (pending)
786 {
787 case CSTP_NONE:
788 return;
789
790 case CSTP_CONTINUE:
791 s = ":continue";
792 break;
793 case CSTP_BREAK:
794 s = ":break";
795 break;
796 case CSTP_FINISH:
797 s = ":finish";
798 break;
799 case CSTP_RETURN:
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100800 // ":return" command producing value, allocated
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801 s = (char *)get_return_cmd(value);
802 break;
803
804 default:
805 if (pending & CSTP_THROW)
806 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100807 vim_snprintf((char *)IObuff, IOSIZE, mesg, _("Exception"));
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200808 mesg = (char *)vim_strnsave(IObuff, STRLEN(IObuff) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000809 STRCAT(mesg, ": %s");
810 s = (char *)((except_T *)value)->value;
811 }
812 else if ((pending & CSTP_ERROR) && (pending & CSTP_INTERRUPT))
813 s = _("Error and interrupt");
814 else if (pending & CSTP_ERROR)
815 s = _("Error");
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100816 else // if (pending & CSTP_INTERRUPT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000817 s = _("Interrupt");
818 }
819
820 save_msg_silent = msg_silent;
821 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100822 msg_silent = FALSE; // display messages
Bram Moolenaar071d4272004-06-13 20:20:40 +0000823 ++no_wait_return;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100824 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100825 smsg(mesg, s);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100826 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar071d4272004-06-13 20:20:40 +0000827 cmdline_row = msg_row;
828 --no_wait_return;
829 if (debug_break_level > 0)
830 msg_silent = save_msg_silent;
831
832 if (pending == CSTP_RETURN)
833 vim_free(s);
834 else if (pending & CSTP_THROW)
835 vim_free(mesg);
836}
837
838/*
839 * If something is made pending in a finally clause, report it if required by
840 * the 'verbose' option or when debugging.
841 */
842 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100843report_make_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000844{
845 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000846 {
847 if (debug_break_level <= 0)
848 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000849 report_pending(RP_MAKE, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000850 if (debug_break_level <= 0)
851 verbose_leave();
852 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000853}
854
855/*
856 * If something pending in a finally clause is resumed at the ":endtry", report
857 * it if required by the 'verbose' option or when debugging.
858 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200859 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100860report_resume_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861{
862 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000863 {
864 if (debug_break_level <= 0)
865 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000866 report_pending(RP_RESUME, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000867 if (debug_break_level <= 0)
868 verbose_leave();
869 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870}
871
872/*
873 * If something pending in a finally clause is discarded, report it if required
874 * by the 'verbose' option or when debugging.
875 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200876 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100877report_discard_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000878{
879 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000880 {
881 if (debug_break_level <= 0)
882 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 report_pending(RP_DISCARD, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000884 if (debug_break_level <= 0)
885 verbose_leave();
886 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887}
888
889
890/*
Bram Moolenaar25e42232019-08-04 15:04:10 +0200891 * ":eval".
892 */
893 void
894ex_eval(exarg_T *eap)
895{
896 typval_T tv;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200897 evalarg_T evalarg;
Bram Moolenaar25e42232019-08-04 15:04:10 +0200898
Bram Moolenaare6b53242020-07-01 17:28:33 +0200899 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200900
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200901 if (eval0(eap->arg, &tv, eap, &evalarg) == OK)
Bram Moolenaar25e42232019-08-04 15:04:10 +0200902 clear_tv(&tv);
Bram Moolenaarb7a78f72020-06-28 18:43:40 +0200903
904 clear_evalarg(&evalarg, eap);
Bram Moolenaar25e42232019-08-04 15:04:10 +0200905}
906
907/*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200908 * Start a new scope/block. Caller should have checked that cs_idx is not
909 * exceeding CSTACK_LEN.
910 */
911 static void
912enter_block(cstack_T *cstack)
913{
914 ++cstack->cs_idx;
Bram Moolenaar0abc6e42021-02-26 22:21:23 +0100915 if (in_vim9script() && current_sctx.sc_sid > 0)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200916 {
917 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
918
919 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200920 cstack->cs_block_id[cstack->cs_idx] = ++si->sn_last_block_id;
921 si->sn_current_block_id = si->sn_last_block_id;
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200922 }
Bram Moolenaar3e492c22021-01-27 21:37:13 +0100923 else
924 {
925 // Just in case in_vim9script() does not return the same value when the
926 // block ends.
927 cstack->cs_script_var_len[cstack->cs_idx] = 0;
928 cstack->cs_block_id[cstack->cs_idx] = 0;
929 }
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200930}
931
932 static void
933leave_block(cstack_T *cstack)
934{
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200935 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200936 {
Bram Moolenaard7475482020-10-10 20:31:37 +0200937 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200938 int i;
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200939 int func_defined =
940 cstack->cs_flags[cstack->cs_idx] & CSF_FUNC_DEF;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200941
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200942 for (i = cstack->cs_script_var_len[cstack->cs_idx];
Bram Moolenaard7475482020-10-10 20:31:37 +0200943 i < si->sn_var_vals.ga_len; ++i)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200944 {
945 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
Bram Moolenaard7475482020-10-10 20:31:37 +0200946
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200947 // sv_name is set to NULL if it was already removed. This happens
948 // when it was defined in an inner block and no functions were
949 // defined there.
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200950 if (sv->sv_name != NULL)
951 // Remove a variable declared inside the block, if it still
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200952 // exists, from sn_vars and move the value into sn_all_vars
953 // if "func_defined" is non-zero.
954 hide_script_var(si, i, func_defined);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200955 }
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200956
957 // TODO: is this needed?
958 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200959
960 if (cstack->cs_idx == 0)
961 si->sn_current_block_id = 0;
962 else
963 si->sn_current_block_id = cstack->cs_block_id[cstack->cs_idx - 1];
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200964 }
965 --cstack->cs_idx;
966}
967
968/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969 * ":if".
970 */
971 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100972ex_if(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973{
974 int error;
975 int skip;
976 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +0100977 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000978
979 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +0200980 eap->errmsg = _("E579: :if nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000981 else
982 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200983 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984 cstack->cs_flags[cstack->cs_idx] = 0;
985
986 /*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200987 * Don't do something after an error, interrupt, or throw, or when
988 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 */
990 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
991 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
992
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200993 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000994
995 if (!skip && !error)
996 {
997 if (result)
998 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
999 }
1000 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001001 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001002 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1003 }
1004}
1005
1006/*
1007 * ":endif".
1008 */
1009 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001010ex_endif(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011{
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001012 cstack_T *cstack = eap->cstack;
1013
Bram Moolenaarfa984412021-03-25 22:15:28 +01001014 if (cmdmod_error())
1015 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016 did_endif = TRUE;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001017 if (cstack->cs_idx < 0
1018 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001019 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001020 eap->errmsg = _(e_endif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 else
1022 {
1023 /*
1024 * When debugging or a breakpoint was encountered, display the debug
1025 * prompt (if not already done). This shows the user that an ":endif"
1026 * is executed when the ":if" or a previous ":elseif" was not TRUE.
1027 * Handle a ">quit" debug command as if an interrupt had occurred before
1028 * the ":endif". That is, throw an interrupt exception if appropriate.
1029 * Doing this here prevents an exception for a parsing error being
1030 * discarded by throwing the interrupt exception later on.
1031 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001032 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001033 && dbg_check_skipped(eap))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001034 (void)do_intthrow(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001036 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 }
1038}
1039
1040/*
1041 * ":else" and ":elseif".
1042 */
1043 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001044ex_else(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045{
1046 int error;
1047 int skip;
1048 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001049 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050
1051 /*
1052 * Don't do something after an error, interrupt, or throw, or when there is
1053 * a surrounding conditional and it was not active.
1054 */
1055 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1056 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1057
1058 if (cstack->cs_idx < 0
Bram Moolenaar12805862005-01-05 22:16:17 +00001059 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001060 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 {
1062 if (eap->cmdidx == CMD_else)
1063 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001064 eap->errmsg = _(e_else_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001065 return;
1066 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001067 eap->errmsg = _(e_elseif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 skip = TRUE;
1069 }
1070 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
1071 {
1072 if (eap->cmdidx == CMD_else)
1073 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001074 eap->errmsg = _("E583: multiple :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 return;
1076 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001077 eap->errmsg = _("E584: :elseif after :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 skip = TRUE;
1079 }
1080
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001081 // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001082 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
1083 {
1084 if (eap->errmsg == NULL)
1085 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001086 skip = TRUE; // don't evaluate an ":elseif"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001087 }
1088 else
1089 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1090
1091 /*
1092 * When debugging or a breakpoint was encountered, display the debug prompt
1093 * (if not already done). This shows the user that an ":else" or ":elseif"
1094 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle
1095 * a ">quit" debug command as if an interrupt had occurred before the
1096 * ":else" or ":elseif". That is, set "skip" and throw an interrupt
1097 * exception if appropriate. Doing this here prevents that an exception
1098 * for a parsing errors is discarded when throwing the interrupt exception
1099 * later on.
1100 */
1101 if (!skip && dbg_check_skipped(eap) && got_int)
1102 {
1103 (void)do_intthrow(cstack);
1104 skip = TRUE;
1105 }
1106
1107 if (eap->cmdidx == CMD_elseif)
1108 {
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001109 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001110
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001111 // When throwing error exceptions, we want to throw always the first
1112 // of several errors in a row. This is what actually happens when
1113 // a conditional error was detected above and there is another failure
1114 // when parsing the expression. Since the skip flag is set in this
1115 // case, the parsing error will be ignored by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 if (!skip && !error)
1117 {
1118 if (result)
1119 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1120 else
1121 cstack->cs_flags[cstack->cs_idx] = 0;
1122 }
1123 else if (eap->errmsg == NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001124 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001125 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1126 }
1127 else
1128 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1129}
1130
1131/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001132 * Handle ":while" and ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001133 */
1134 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001135ex_while(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001136{
1137 int error;
1138 int skip;
1139 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001140 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141
1142 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001143 eap->errmsg = _("E585: :while/:for nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001144 else
1145 {
1146 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001147 * The loop flag is set when we have jumped back from the matching
1148 * ":endwhile" or ":endfor". When not set, need to initialise this
1149 * cstack entry.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001151 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001153 enter_block(cstack);
Bram Moolenaar12805862005-01-05 22:16:17 +00001154 ++cstack->cs_looplevel;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 cstack->cs_line[cstack->cs_idx] = -1;
1156 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001157 cstack->cs_flags[cstack->cs_idx] =
1158 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001159
1160 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001161 * Don't do something after an error, interrupt, or throw, or when
1162 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 */
1164 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1165 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
Bram Moolenaar12805862005-01-05 22:16:17 +00001166 if (eap->cmdidx == CMD_while)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001168 /*
1169 * ":while bool-expr"
1170 */
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001171 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001172 }
1173 else
1174 {
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001175 void *fi;
1176 evalarg_T evalarg;
1177
1178 CLEAR_FIELD(evalarg);
1179 evalarg.eval_flags = skip ? 0 : EVAL_EVALUATE;
1180 if (getline_equal(eap->getline, eap->cookie, getsourceline))
1181 {
1182 evalarg.eval_getline = eap->getline;
1183 evalarg.eval_cookie = eap->cookie;
1184 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001185
1186 /*
1187 * ":for var in list-expr"
1188 */
1189 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
1190 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001191 // Jumping here from a ":continue" or ":endfor": use the
1192 // previously evaluated list.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001193 fi = cstack->cs_forinfo[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001194 error = FALSE;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001195
1196 // the "in expr" is not used, skip over it
1197 skip_for_lines(fi, &evalarg);
Bram Moolenaar12805862005-01-05 22:16:17 +00001198 }
1199 else
1200 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001201 // Evaluate the argument and get the info in a structure.
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001202 fi = eval_for_line(eap->arg, &error, eap, &evalarg);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001203 cstack->cs_forinfo[cstack->cs_idx] = fi;
Bram Moolenaar12805862005-01-05 22:16:17 +00001204 }
1205
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001206 // use the element at the start of the list and advance
Bram Moolenaar12805862005-01-05 22:16:17 +00001207 if (!error && fi != NULL && !skip)
1208 result = next_for_item(fi, eap->arg);
1209 else
1210 result = FALSE;
1211
1212 if (!result)
1213 {
1214 free_for_info(fi);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001215 cstack->cs_forinfo[cstack->cs_idx] = NULL;
Bram Moolenaar12805862005-01-05 22:16:17 +00001216 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001217 clear_evalarg(&evalarg, eap);
Bram Moolenaar12805862005-01-05 22:16:17 +00001218 }
1219
1220 /*
1221 * If this cstack entry was just initialised and is active, set the
1222 * loop flag, so do_cmdline() will set the line number in cs_line[].
1223 * If executing the command a second time, clear the loop flag.
1224 */
1225 if (!skip && !error && result)
1226 {
1227 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
1228 cstack->cs_lflags ^= CSL_HAD_LOOP;
1229 }
1230 else
1231 {
1232 cstack->cs_lflags &= ~CSL_HAD_LOOP;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001233 // If the ":while" evaluates to FALSE or ":for" is past the end of
1234 // the list, show the debug prompt at the ":endwhile"/":endfor" as
1235 // if there was a ":break" in a ":while"/":for" evaluating to
1236 // TRUE.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 if (!skip && !error)
1238 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1239 }
1240 }
1241}
1242
1243/*
1244 * ":continue"
1245 */
1246 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001247ex_continue(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248{
1249 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001250 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251
Bram Moolenaar12805862005-01-05 22:16:17 +00001252 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001253 eap->errmsg = _(e_continue);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 else
1255 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001256 // Try to find the matching ":while". This might stop at a try
1257 // conditional not in its finally clause (which is then to be executed
1258 // next). Therefor, inactivate all conditionals except the ":while"
1259 // itself (if reached).
Bram Moolenaar12805862005-01-05 22:16:17 +00001260 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001261 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 {
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001263 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264
1265 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001266 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267 * matching ":while".
1268 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001269 cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001270 }
1271 else
1272 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001273 // If a try conditional not in its finally clause is reached first,
1274 // make the ":continue" pending for execution at the ":endtry".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 cstack->cs_pending[idx] = CSTP_CONTINUE;
1276 report_make_pending(CSTP_CONTINUE, NULL);
1277 }
1278 }
1279}
1280
1281/*
1282 * ":break"
1283 */
1284 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001285ex_break(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001286{
1287 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001288 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289
Bram Moolenaar12805862005-01-05 22:16:17 +00001290 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001291 eap->errmsg = _(e_break);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292 else
1293 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001294 // Inactivate conditionals until the matching ":while" or a try
1295 // conditional not in its finally clause (which is then to be
1296 // executed next) is found. In the latter case, make the ":break"
1297 // pending for execution at the ":endtry".
Bram Moolenaar12805862005-01-05 22:16:17 +00001298 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001299 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300 {
1301 cstack->cs_pending[idx] = CSTP_BREAK;
1302 report_make_pending(CSTP_BREAK, NULL);
1303 }
1304 }
1305}
1306
1307/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001308 * ":endwhile" and ":endfor"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309 */
1310 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001311ex_endwhile(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312{
Bram Moolenaarddef1292019-12-16 17:10:33 +01001313 cstack_T *cstack = eap->cstack;
1314 int idx;
1315 char *err;
1316 int csf;
1317 int fl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318
Bram Moolenaarfa984412021-03-25 22:15:28 +01001319 if (cmdmod_error())
1320 return;
1321
Bram Moolenaar12805862005-01-05 22:16:17 +00001322 if (eap->cmdidx == CMD_endwhile)
1323 {
1324 err = e_while;
1325 csf = CSF_WHILE;
1326 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327 else
1328 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001329 err = e_for;
1330 csf = CSF_FOR;
1331 }
1332
1333 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001334 eap->errmsg = _(err);
Bram Moolenaar12805862005-01-05 22:16:17 +00001335 else
1336 {
1337 fl = cstack->cs_flags[cstack->cs_idx];
1338 if (!(fl & csf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001340 // If we are in a ":while" or ":for" but used the wrong endloop
1341 // command, do not rewind to the next enclosing ":for"/":while".
Bram Moolenaar12805862005-01-05 22:16:17 +00001342 if (fl & CSF_WHILE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001343 eap->errmsg = _("E732: Using :endfor with :while");
Bram Moolenaar12805862005-01-05 22:16:17 +00001344 else if (fl & CSF_FOR)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001345 eap->errmsg = _("E733: Using :endwhile with :for");
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00001346 }
1347 if (!(fl & (CSF_WHILE | CSF_FOR)))
1348 {
1349 if (!(fl & CSF_TRY))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001350 eap->errmsg = _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00001351 else if (fl & CSF_FINALLY)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001352 eap->errmsg = _(e_endtry);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001353 // Try to find the matching ":while" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 for (idx = cstack->cs_idx; idx > 0; --idx)
1355 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001356 fl = cstack->cs_flags[idx];
1357 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001359 // Give up at a try conditional not in its finally clause.
1360 // Ignore the ":endwhile"/":endfor".
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001361 eap->errmsg = _(err);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001362 return;
1363 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001364 if (fl & csf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 break;
1366 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001367 // Cleanup and rewind all contained (and unclosed) conditionals.
Bram Moolenaar12805862005-01-05 22:16:17 +00001368 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1370 }
1371
1372 /*
1373 * When debugging or a breakpoint was encountered, display the debug
1374 * prompt (if not already done). This shows the user that an
Bram Moolenaar12805862005-01-05 22:16:17 +00001375 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
1376 * after a ":break". Handle a ">quit" debug command as if an
1377 * interrupt had occurred before the ":endwhile"/":endfor". That is,
1378 * throw an interrupt exception if appropriate. Doing this here
1379 * prevents that an exception for a parsing error is discarded when
1380 * throwing the interrupt exception later on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381 */
1382 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1383 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1384 && dbg_check_skipped(eap))
1385 (void)do_intthrow(cstack);
1386
1387 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001388 * Set loop flag, so do_cmdline() will jump back to the matching
1389 * ":while" or ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001390 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001391 cstack->cs_lflags |= CSL_HAD_ENDLOOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001392 }
1393}
1394
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001395/*
1396 * "{" start of a block in Vim9 script
1397 */
1398 void
1399ex_block(exarg_T *eap)
1400{
1401 cstack_T *cstack = eap->cstack;
1402
1403 if (cstack->cs_idx == CSTACK_LEN - 1)
1404 eap->errmsg = _("E579: block nesting too deep");
1405 else
1406 {
1407 enter_block(cstack);
1408 cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE;
1409 }
1410}
1411
1412/*
1413 * "}" end of a block in Vim9 script
1414 */
1415 void
1416ex_endblock(exarg_T *eap)
1417{
1418 cstack_T *cstack = eap->cstack;
1419
1420 if (cstack->cs_idx < 0
1421 || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0)
1422 eap->errmsg = _(e_endblock_without_block);
1423 else
1424 leave_block(cstack);
1425}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426
1427/*
1428 * ":throw expr"
1429 */
1430 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001431ex_throw(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001432{
1433 char_u *arg = eap->arg;
1434 char_u *value;
1435
1436 if (*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001437 value = eval_to_string_skip(arg, eap, eap->skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001438 else
1439 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001440 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001441 value = NULL;
1442 }
1443
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001444 // On error or when an exception is thrown during argument evaluation, do
1445 // not throw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 if (!eap->skip && value != NULL)
1447 {
1448 if (throw_exception(value, ET_USER, NULL) == FAIL)
1449 vim_free(value);
1450 else
1451 do_throw(eap->cstack);
1452 }
1453}
1454
1455/*
Bram Moolenaar269ec652004-07-29 08:43:53 +00001456 * Throw the current exception through the specified cstack. Common routine
1457 * for ":throw" (user exception) and error and interrupt exceptions. Also
1458 * used for rethrowing an uncaught exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459 */
1460 void
Bram Moolenaarddef1292019-12-16 17:10:33 +01001461do_throw(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462{
1463 int idx;
1464 int inactivate_try = FALSE;
1465
1466 /*
1467 * Cleanup and inactivate up to the next surrounding try conditional that
1468 * is not in its finally clause. Normally, do not inactivate the try
1469 * conditional itself, so that its ACTIVE flag can be tested below. But
1470 * if a previous error or interrupt has not been converted to an exception,
1471 * inactivate the try conditional, too, as if the conversion had been done,
Bram Moolenaar269ec652004-07-29 08:43:53 +00001472 * and reset the did_emsg or got_int flag, so this won't happen again at
1473 * the next surrounding try conditional.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474 */
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001475#ifndef THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001476 if (did_emsg && !THROW_ON_ERROR)
1477 {
1478 inactivate_try = TRUE;
1479 did_emsg = FALSE;
1480 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001481#endif
1482#ifndef THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483 if (got_int && !THROW_ON_INTERRUPT)
1484 {
1485 inactivate_try = TRUE;
1486 got_int = FALSE;
1487 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001488#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001489 idx = cleanup_conditionals(cstack, 0, inactivate_try);
1490 if (idx >= 0)
1491 {
1492 /*
1493 * If this try conditional is active and we are before its first
Bram Moolenaar269ec652004-07-29 08:43:53 +00001494 * ":catch", set THROWN so that the ":catch" commands will check
1495 * whether the exception matches. When the exception came from any of
1496 * the catch clauses, it will be made pending at the ":finally" (if
1497 * present) and rethrown at the ":endtry". This will also happen if
1498 * the try conditional is inactive. This is the case when we are
1499 * throwing an exception due to an error or interrupt on the way from
1500 * a preceding ":continue", ":break", ":return", ":finish", error or
1501 * interrupt (not converted to an exception) to the finally clause or
1502 * from a preceding throw of a user or error or interrupt exception to
1503 * the matching catch clause or the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 */
1505 if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1506 {
1507 if (cstack->cs_flags[idx] & CSF_ACTIVE)
1508 cstack->cs_flags[idx] |= CSF_THROWN;
1509 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001510 // THROWN may have already been set for a catchable exception
1511 // that has been discarded. Ensure it is reset for the new
1512 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001513 cstack->cs_flags[idx] &= ~CSF_THROWN;
1514 }
1515 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1516 cstack->cs_exception[idx] = current_exception;
1517 }
1518#if 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001519 // TODO: Add optimization below. Not yet done because of interface
1520 // problems to eval.c and ex_cmds2.c. (Servatius)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 else
1522 {
1523 /*
1524 * There are no catch clauses to check or finally clauses to execute.
1525 * End the current script or function. The exception will be rethrown
1526 * in the caller.
1527 */
1528 if (getline_equal(eap->getline, eap->cookie, get_func_line))
1529 current_funccal->returned = TRUE;
1530 elseif (eap->get_func_line == getsourceline)
1531 ((struct source_cookie *)eap->cookie)->finished = TRUE;
1532 }
1533#endif
1534
1535 did_throw = TRUE;
1536}
1537
1538/*
1539 * ":try"
1540 */
1541 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001542ex_try(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543{
1544 int skip;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001545 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001546
Bram Moolenaarfa984412021-03-25 22:15:28 +01001547 if (cmdmod_error())
1548 return;
1549
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001551 eap->errmsg = _("E601: :try nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 else
1553 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001554 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 ++cstack->cs_trylevel;
1556 cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1557 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1558
1559 /*
1560 * Don't do something after an error, interrupt, or throw, or when there
1561 * is a surrounding conditional and it was not active.
1562 */
1563 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1564 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1565
1566 if (!skip)
1567 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001568 // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch"
1569 // commands should check for a match if an exception is thrown and
1570 // that the finally clause needs to be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001571 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1572
1573 /*
1574 * ":silent!", even when used in a try conditional, disables
1575 * displaying of error messages and conversion of errors to
1576 * exceptions. When the silent commands again open a try
1577 * conditional, save "emsg_silent" and reset it so that errors are
1578 * again converted to exceptions. The value is restored when that
1579 * try conditional is left. If it is left normally, the commands
1580 * following the ":endtry" are again silent. If it is left by
1581 * a ":continue", ":break", ":return", or ":finish", the commands
1582 * executed next are again silent. If it is left due to an
1583 * aborting error, an interrupt, or an exception, restoring
1584 * "emsg_silent" does not matter since we are already in the
1585 * aborting state and/or the exception has already been thrown.
1586 * The effect is then just freeing the memory that was allocated
1587 * to save the value.
1588 */
1589 if (emsg_silent)
1590 {
1591 eslist_T *elem;
1592
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001593 elem = ALLOC_ONE(struct eslist_elem);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 if (elem == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001595 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001596 else
1597 {
1598 elem->saved_emsg_silent = emsg_silent;
1599 elem->next = cstack->cs_emsg_silent_list;
1600 cstack->cs_emsg_silent_list = elem;
1601 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1602 emsg_silent = 0;
1603 }
1604 }
1605 }
1606
1607 }
1608}
1609
1610/*
1611 * ":catch /{pattern}/" and ":catch"
1612 */
1613 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001614ex_catch(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615{
1616 int idx = 0;
1617 int give_up = FALSE;
1618 int skip = FALSE;
1619 int caught = FALSE;
1620 char_u *end;
1621 int save_char = 0;
1622 char_u *save_cpo;
1623 regmatch_T regmatch;
1624 int prev_got_int;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001625 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 char_u *pat;
1627
Bram Moolenaarfa984412021-03-25 22:15:28 +01001628 if (cmdmod_error())
1629 return;
1630
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1632 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001633 eap->errmsg = _(e_catch);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001634 give_up = TRUE;
1635 }
1636 else
1637 {
1638 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1639 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001640 // Report what's missing if the matching ":try" is not in its
1641 // finally clause.
Bram Moolenaar12805862005-01-05 22:16:17 +00001642 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 skip = TRUE;
1644 }
1645 for (idx = cstack->cs_idx; idx > 0; --idx)
1646 if (cstack->cs_flags[idx] & CSF_TRY)
1647 break;
1648 if (cstack->cs_flags[idx] & CSF_FINALLY)
1649 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001650 // Give up for a ":catch" after ":finally" and ignore it.
1651 // Just parse.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001652 eap->errmsg = _("E604: :catch after :finally");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001653 give_up = TRUE;
1654 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001655 else
Bram Moolenaar12805862005-01-05 22:16:17 +00001656 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1657 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001658 }
1659
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001660 if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors
Bram Moolenaar071d4272004-06-13 20:20:40 +00001661 {
1662 pat = (char_u *)".*";
1663 end = NULL;
1664 eap->nextcmd = find_nextcmd(eap->arg);
1665 }
1666 else
1667 {
1668 pat = eap->arg + 1;
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001669 end = skip_regexp_err(pat, *eap->arg, TRUE);
1670 if (end == NULL)
1671 give_up = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 }
1673
1674 if (!give_up)
1675 {
1676 /*
1677 * Don't do something when no exception has been thrown or when the
1678 * corresponding try block never got active (because of an inactive
1679 * surrounding conditional or after an error or interrupt or throw).
1680 */
1681 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1682 skip = TRUE;
1683
1684 /*
1685 * Check for a match only if an exception is thrown but not caught by
1686 * a previous ":catch". An exception that has replaced a discarded
1687 * exception is not checked (THROWN is not set then).
1688 */
1689 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1690 && !(cstack->cs_flags[idx] & CSF_CAUGHT))
1691 {
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001692 if (end != NULL && *end != NUL
1693 && !ends_excmd2(end, skipwhite(end + 1)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001694 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001695 semsg(_(e_trailing_arg), end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 return;
1697 }
1698
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001699 // When debugging or a breakpoint was encountered, display the
1700 // debug prompt (if not already done) before checking for a match.
1701 // This is a helpful hint for the user when the regular expression
1702 // matching fails. Handle a ">quit" debug command as if an
1703 // interrupt had occurred before the ":catch". That is, discard
1704 // the original exception, replace it by an interrupt exception,
1705 // and don't catch it in this try block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1707 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001708 // Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1709 // while compiling it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 if (end != NULL)
1711 {
1712 save_char = *end;
1713 *end = NUL;
1714 }
1715 save_cpo = p_cpo;
Bram Moolenaare5a2dc82021-01-03 19:52:05 +01001716 p_cpo = empty_option;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001717 // Disable error messages, it will make current_exception
1718 // invalid.
Bram Moolenaar768ce242016-02-07 19:46:12 +01001719 ++emsg_off;
Bram Moolenaar150cc272007-08-01 13:47:46 +00001720 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
Bram Moolenaar768ce242016-02-07 19:46:12 +01001721 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001722 regmatch.rm_ic = FALSE;
1723 if (end != NULL)
1724 *end = save_char;
1725 p_cpo = save_cpo;
1726 if (regmatch.regprog == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001727 semsg(_(e_invarg2), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 else
1729 {
1730 /*
1731 * Save the value of got_int and reset it. We don't want
1732 * a previous interruption cancel matching, only hitting
1733 * CTRL-C while matching should abort it.
1734 */
1735 prev_got_int = got_int;
1736 got_int = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001737 caught = vim_regexec_nl(&regmatch,
1738 (char_u *)current_exception->value, (colnr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 got_int |= prev_got_int;
Bram Moolenaar473de612013-06-08 18:19:48 +02001740 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 }
1742 }
1743 }
1744
1745 if (caught)
1746 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001747 // Make this ":catch" clause active and reset did_emsg, got_int,
1748 // and did_throw. Put the exception on the caught stack.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001749 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1750 did_emsg = got_int = did_throw = FALSE;
1751 catch_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001752 // It's mandatory that the current exception is stored in the cstack
1753 // so that it can be discarded at the next ":catch", ":finally", or
1754 // ":endtry" or when the catch clause is left by a ":continue",
1755 // ":break", ":return", ":finish", error, interrupt, or another
1756 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001757 if (cstack->cs_exception[cstack->cs_idx] != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001758 internal_error("ex_catch()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 }
1760 else
1761 {
1762 /*
1763 * If there is a preceding catch clause and it caught the exception,
1764 * finish the exception now. This happens also after errors except
1765 * when this ":catch" was after the ":finally" or not within
1766 * a ":try". Make the try conditional inactive so that the
1767 * following catch clauses are skipped. On an error or interrupt
1768 * after the preceding try block or catch clause was left by
1769 * a ":continue", ":break", ":return", or ":finish", discard the
1770 * pending action.
1771 */
1772 cleanup_conditionals(cstack, CSF_TRY, TRUE);
1773 }
1774 }
1775
1776 if (end != NULL)
1777 eap->nextcmd = find_nextcmd(end);
1778}
1779
1780/*
1781 * ":finally"
1782 */
1783 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001784ex_finally(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785{
1786 int idx;
1787 int skip = FALSE;
1788 int pending = CSTP_NONE;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001789 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001790
Bram Moolenaarfa984412021-03-25 22:15:28 +01001791 if (cmdmod_error())
1792 return;
1793
Bram Moolenaar071d4272004-06-13 20:20:40 +00001794 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001795 eap->errmsg = _(e_finally);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001796 else
1797 {
1798 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1799 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001800 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1802 if (cstack->cs_flags[idx] & CSF_TRY)
1803 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001804 // Make this error pending, so that the commands in the following
1805 // finally clause can be executed. This overrules also a pending
1806 // ":continue", ":break", ":return", or ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001807 pending = CSTP_ERROR;
1808 }
1809 else
1810 idx = cstack->cs_idx;
1811
1812 if (cstack->cs_flags[idx] & CSF_FINALLY)
1813 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001814 // Give up for a multiple ":finally" and ignore it.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001815 eap->errmsg = _(e_finally_dup);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001816 return;
1817 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001818 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
Bram Moolenaar12805862005-01-05 22:16:17 +00001819 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820
1821 /*
1822 * Don't do something when the corresponding try block never got active
1823 * (because of an inactive surrounding conditional or after an error or
1824 * interrupt or throw) or for a ":finally" without ":try" or a multiple
1825 * ":finally". After every other error (did_emsg or the conditional
1826 * errors detected above) or after an interrupt (got_int) or an
1827 * exception (did_throw), the finally clause must be executed.
1828 */
1829 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1830
1831 if (!skip)
1832 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001833 // When debugging or a breakpoint was encountered, display the
1834 // debug prompt (if not already done). The user then knows that the
1835 // finally clause is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 if (dbg_check_skipped(eap))
1837 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001838 // Handle a ">quit" debug command as if an interrupt had
1839 // occurred before the ":finally". That is, discard the
1840 // original exception and replace it by an interrupt
1841 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001842 (void)do_intthrow(cstack);
1843 }
1844
1845 /*
1846 * If there is a preceding catch clause and it caught the exception,
1847 * finish the exception now. This happens also after errors except
1848 * when this is a multiple ":finally" or one not within a ":try".
1849 * After an error or interrupt, this also discards a pending
1850 * ":continue", ":break", ":finish", or ":return" from the preceding
1851 * try block or catch clause.
1852 */
1853 cleanup_conditionals(cstack, CSF_TRY, FALSE);
1854
1855 /*
1856 * Make did_emsg, got_int, did_throw pending. If set, they overrule
1857 * a pending ":continue", ":break", ":return", or ":finish". Then
1858 * we have particularly to discard a pending return value (as done
1859 * by the call to cleanup_conditionals() above when did_emsg or
1860 * got_int is set). The pending values are restored by the
1861 * ":endtry", except if there is a new error, interrupt, exception,
1862 * ":continue", ":break", ":return", or ":finish" in the following
Bram Moolenaar12805862005-01-05 22:16:17 +00001863 * finally clause. A missing ":endwhile", ":endfor" or ":endif"
1864 * detected here is treated as if did_emsg and did_throw had
1865 * already been set, respectively in case that the error is not
1866 * converted to an exception, did_throw had already been unset.
1867 * We must not set did_emsg here since that would suppress the
1868 * error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 */
1870 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1871 {
1872 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
1873 {
1874 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001875 cstack->cs_rettv[cstack->cs_idx]);
1876 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877 }
1878 if (pending == CSTP_ERROR && !did_emsg)
1879 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
1880 else
1881 pending |= did_throw ? CSTP_THROW : 0;
1882 pending |= did_emsg ? CSTP_ERROR : 0;
1883 pending |= got_int ? CSTP_INTERRUPT : 0;
1884 cstack->cs_pending[cstack->cs_idx] = pending;
1885
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001886 // It's mandatory that the current exception is stored in the
1887 // cstack so that it can be rethrown at the ":endtry" or be
1888 // discarded if the finally clause is left by a ":continue",
1889 // ":break", ":return", ":finish", error, interrupt, or another
1890 // exception. When emsg() is called for a missing ":endif" or
1891 // a missing ":endwhile"/":endfor" detected here, the
1892 // exception will be discarded.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001893 if (did_throw && cstack->cs_exception[cstack->cs_idx]
1894 != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001895 internal_error("ex_finally()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 }
1897
1898 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001899 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001900 * got_int, and did_throw and make the finally clause active.
1901 * This will happen after emsg() has been called for a missing
Bram Moolenaar12805862005-01-05 22:16:17 +00001902 * ":endif" or a missing ":endwhile"/":endfor" detected here, so
1903 * that the following finally clause will be executed even then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001905 cstack->cs_lflags |= CSL_HAD_FINA;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906 }
1907 }
1908}
1909
1910/*
1911 * ":endtry"
1912 */
1913 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001914ex_endtry(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915{
1916 int idx;
1917 int skip;
1918 int rethrow = FALSE;
1919 int pending = CSTP_NONE;
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001920 void *rettv = NULL;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001921 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001922
Bram Moolenaarfa984412021-03-25 22:15:28 +01001923 if (cmdmod_error())
1924 return;
1925
Bram Moolenaar071d4272004-06-13 20:20:40 +00001926 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001927 eap->errmsg = _(e_no_endtry);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 else
1929 {
1930 /*
1931 * Don't do something after an error, interrupt or throw in the try
1932 * block, catch clause, or finally clause preceding this ":endtry" or
1933 * when an error or interrupt occurred after a ":continue", ":break",
1934 * ":return", or ":finish" in a try block or catch clause preceding this
1935 * ":endtry" or when the try block never got active (because of an
1936 * inactive surrounding conditional or after an error or interrupt or
1937 * throw) or when there is a surrounding conditional and it has been
1938 * made inactive by a ":continue", ":break", ":return", or ":finish" in
1939 * the finally clause. The latter case need not be tested since then
1940 * anything pending has already been discarded. */
1941 skip = did_emsg || got_int || did_throw ||
1942 !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1943
1944 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1945 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001946 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001947 // Find the matching ":try" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001948 idx = cstack->cs_idx;
1949 do
1950 --idx;
1951 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
Bram Moolenaar12805862005-01-05 22:16:17 +00001952 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1953 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 skip = TRUE;
1955
1956 /*
1957 * If an exception is being thrown, discard it to prevent it from
1958 * being rethrown at the end of this function. It would be
1959 * discarded by the error message, anyway. Resets did_throw.
1960 * This does not affect the script termination due to the error
1961 * since "trylevel" is decremented after emsg() has been called.
1962 */
1963 if (did_throw)
1964 discard_current_exception();
1965 }
1966 else
1967 {
1968 idx = cstack->cs_idx;
1969
1970 /*
1971 * If we stopped with the exception currently being thrown at this
1972 * try conditional since we didn't know that it doesn't have
1973 * a finally clause, we need to rethrow it after closing the try
1974 * conditional.
1975 */
1976 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
1977 && !(cstack->cs_flags[idx] & CSF_FINALLY))
1978 rethrow = TRUE;
1979 }
1980
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001981 // If there was no finally clause, show the user when debugging or
1982 // a breakpoint was encountered that the end of the try conditional has
1983 // been reached: display the debug prompt (if not already done). Do
1984 // this on normal control flow or when an exception was thrown, but not
1985 // on an interrupt or error not converted to an exception or when
1986 // a ":break", ":continue", ":return", or ":finish" is pending. These
1987 // actions are carried out immediately.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001988 if ((rethrow || (!skip
1989 && !(cstack->cs_flags[idx] & CSF_FINALLY)
1990 && !cstack->cs_pending[idx]))
1991 && dbg_check_skipped(eap))
1992 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001993 // Handle a ">quit" debug command as if an interrupt had occurred
1994 // before the ":endtry". That is, throw an interrupt exception and
1995 // set "skip" and "rethrow".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 if (got_int)
1997 {
1998 skip = TRUE;
1999 (void)do_intthrow(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002000 // The do_intthrow() call may have reset did_throw or
2001 // cstack->cs_pending[idx].
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 rethrow = FALSE;
2003 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY))
2004 rethrow = TRUE;
2005 }
2006 }
2007
2008 /*
2009 * If a ":return" is pending, we need to resume it after closing the
2010 * try conditional; remember the return value. If there was a finally
2011 * clause making an exception pending, we need to rethrow it. Make it
2012 * the exception currently being thrown.
2013 */
2014 if (!skip)
2015 {
2016 pending = cstack->cs_pending[idx];
2017 cstack->cs_pending[idx] = CSTP_NONE;
2018 if (pending == CSTP_RETURN)
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002019 rettv = cstack->cs_rettv[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 else if (pending & CSTP_THROW)
2021 current_exception = cstack->cs_exception[idx];
2022 }
2023
2024 /*
2025 * Discard anything pending on an error, interrupt, or throw in the
2026 * finally clause. If there was no ":finally", discard a pending
2027 * ":continue", ":break", ":return", or ":finish" if an error or
2028 * interrupt occurred afterwards, but before the ":endtry" was reached.
2029 * If an exception was caught by the last of the catch clauses and there
2030 * was no finally clause, finish the exception now. This happens also
2031 * after errors except when this ":endtry" is not within a ":try".
2032 * Restore "emsg_silent" if it has been reset by this try conditional.
2033 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002034 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002036 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037 --cstack->cs_trylevel;
2038
2039 if (!skip)
2040 {
2041 report_resume_pending(pending,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002042 (pending == CSTP_RETURN) ? rettv :
Bram Moolenaar071d4272004-06-13 20:20:40 +00002043 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2044 switch (pending)
2045 {
2046 case CSTP_NONE:
2047 break;
2048
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002049 // Reactivate a pending ":continue", ":break", ":return",
2050 // ":finish" from the try block or a catch clause of this try
2051 // conditional. This is skipped, if there was an error in an
2052 // (unskipped) conditional command or an interrupt afterwards
2053 // or if the finally clause is present and executed a new error,
2054 // interrupt, throw, ":continue", ":break", ":return", or
2055 // ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002056 case CSTP_CONTINUE:
2057 ex_continue(eap);
2058 break;
2059 case CSTP_BREAK:
2060 ex_break(eap);
2061 break;
2062 case CSTP_RETURN:
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002063 do_return(eap, FALSE, FALSE, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 break;
2065 case CSTP_FINISH:
2066 do_finish(eap, FALSE);
2067 break;
2068
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002069 // When the finally clause was entered due to an error,
2070 // interrupt or throw (as opposed to a ":continue", ":break",
2071 // ":return", or ":finish"), restore the pending values of
2072 // did_emsg, got_int, and did_throw. This is skipped, if there
2073 // was a new error, interrupt, throw, ":continue", ":break",
2074 // ":return", or ":finish". in the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002075 default:
2076 if (pending & CSTP_ERROR)
2077 did_emsg = TRUE;
2078 if (pending & CSTP_INTERRUPT)
2079 got_int = TRUE;
2080 if (pending & CSTP_THROW)
2081 rethrow = TRUE;
2082 break;
2083 }
2084 }
2085
2086 if (rethrow)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002087 // Rethrow the current exception (within this cstack).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 do_throw(cstack);
2089 }
2090}
2091
2092/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002093 * enter_cleanup() and leave_cleanup()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002094 *
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002095 * Functions to be called before/after invoking a sequence of autocommands for
2096 * cleanup for a failed command. (Failure means here that a call to emsg()
2097 * has been made, an interrupt occurred, or there is an uncaught exception
2098 * from a previous autocommand execution of the same command.)
2099 *
2100 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same
2101 * pointer to leave_cleanup(). The cleanup_T structure stores the pending
2102 * error/interrupt/exception state.
2103 */
2104
2105/*
2106 * This function works a bit like ex_finally() except that there was not
2107 * actually an extra try block around the part that failed and an error or
2108 * interrupt has not (yet) been converted to an exception. This function
2109 * saves the error/interrupt/ exception state and prepares for the call to
2110 * do_cmdline() that is going to be made for the cleanup autocommand
2111 * execution.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002112 */
2113 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002114enter_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002115{
2116 int pending = CSTP_NONE;
2117
2118 /*
2119 * Postpone did_emsg, got_int, did_throw. The pending values will be
2120 * restored by leave_cleanup() except if there was an aborting error,
2121 * interrupt, or uncaught exception after this function ends.
2122 */
2123 if (did_emsg || got_int || did_throw || need_rethrow)
2124 {
2125 csp->pending = (did_emsg ? CSTP_ERROR : 0)
2126 | (got_int ? CSTP_INTERRUPT : 0)
2127 | (did_throw ? CSTP_THROW : 0)
2128 | (need_rethrow ? CSTP_THROW : 0);
2129
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002130 // If we are currently throwing an exception (did_throw), save it as
2131 // well. On an error not yet converted to an exception, update
2132 // "force_abort" and reset "cause_abort" (as do_errthrow() would do).
2133 // This is needed for the do_cmdline() call that is going to be made
2134 // for autocommand execution. We need not save *msg_list because
2135 // there is an extra instance for every call of do_cmdline(), anyway.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002136 if (did_throw || need_rethrow)
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002137 {
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002138 csp->exception = current_exception;
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002139 current_exception = NULL;
2140 }
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002141 else
2142 {
2143 csp->exception = NULL;
2144 if (did_emsg)
2145 {
2146 force_abort |= cause_abort;
2147 cause_abort = FALSE;
2148 }
2149 }
2150 did_emsg = got_int = did_throw = need_rethrow = FALSE;
2151
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002152 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002153 report_make_pending(pending, csp->exception);
2154 }
2155 else
2156 {
2157 csp->pending = CSTP_NONE;
2158 csp->exception = NULL;
2159 }
2160}
2161
2162/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002163 * See comment above enter_cleanup() for how this function is used.
2164 *
2165 * This function is a bit like ex_endtry() except that there was not actually
2166 * an extra try block around the part that failed and an error or interrupt
2167 * had not (yet) been converted to an exception when the cleanup autocommand
2168 * sequence was invoked.
2169 *
2170 * This function has to be called with the address of the cleanup_T structure
2171 * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2172 * exception state saved by that function - except there was an aborting
2173 * error, an interrupt or an uncaught exception during execution of the
2174 * cleanup autocommands. In the latter case, the saved error/interrupt/
2175 * exception state is discarded.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002176 */
2177 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002178leave_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002179{
2180 int pending = csp->pending;
2181
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002182 if (pending == CSTP_NONE) // nothing to do
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002183 return;
2184
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002185 // If there was an aborting error, an interrupt, or an uncaught exception
2186 // after the corresponding call to enter_cleanup(), discard what has been
2187 // made pending by it. Report this to the user if required by the
2188 // 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002189 if (aborting() || need_rethrow)
2190 {
2191 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002192 // Cancel the pending exception (includes report).
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002193 discard_exception((except_T *)csp->exception, FALSE);
2194 else
2195 report_discard_pending(pending, NULL);
2196
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002197 // If an error was about to be converted to an exception when
2198 // enter_cleanup() was called, free the message list.
Bram Moolenaar4632d292006-11-28 17:36:37 +00002199 if (msg_list != NULL)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +01002200 free_global_msglist();
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002201 }
2202
2203 /*
2204 * If there was no new error, interrupt, or throw between the calls
2205 * to enter_cleanup() and leave_cleanup(), restore the pending
2206 * error/interrupt/exception state.
2207 */
2208 else
2209 {
2210 /*
2211 * If there was an exception being thrown when enter_cleanup() was
2212 * called, we need to rethrow it. Make it the exception currently
2213 * being thrown.
2214 */
2215 if (pending & CSTP_THROW)
2216 current_exception = csp->exception;
2217
2218 /*
2219 * If an error was about to be converted to an exception when
2220 * enter_cleanup() was called, let "cause_abort" take the part of
2221 * "force_abort" (as done by cause_errthrow()).
2222 */
2223 else if (pending & CSTP_ERROR)
2224 {
2225 cause_abort = force_abort;
2226 force_abort = FALSE;
2227 }
2228
2229 /*
2230 * Restore the pending values of did_emsg, got_int, and did_throw.
2231 */
2232 if (pending & CSTP_ERROR)
2233 did_emsg = TRUE;
2234 if (pending & CSTP_INTERRUPT)
2235 got_int = TRUE;
2236 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002237 need_rethrow = TRUE; // did_throw will be set by do_one_cmd()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002238
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002239 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002240 report_resume_pending(pending,
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002241 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002242 }
2243}
2244
2245
2246/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 * Make conditionals inactive and discard what's pending in finally clauses
2248 * until the conditional type searched for or a try conditional not in its
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002249 * finally clause is reached. If this is in an active catch clause, finish
2250 * the caught exception.
2251 * Return the cstack index where the search stopped.
Bram Moolenaar12805862005-01-05 22:16:17 +00002252 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
2253 * the latter meaning the innermost try conditional not in its finally clause.
2254 * "inclusive" tells whether the conditional searched for should be made
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002255 * inactive itself (a try conditional not in its finally clause possibly find
Bram Moolenaar12805862005-01-05 22:16:17 +00002256 * before is always made inactive). If "inclusive" is TRUE and
2257 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
2258 * "emsg_silent", if reset when the try conditional finally reached was
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002259 * entered, is restored (used by ex_endtry()). This is normally done only
Bram Moolenaar12805862005-01-05 22:16:17 +00002260 * when such a try conditional is left.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002261 */
2262 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002263cleanup_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002264 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002265 int searched_cond,
2266 int inclusive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002267{
2268 int idx;
2269 int stop = FALSE;
2270
2271 for (idx = cstack->cs_idx; idx >= 0; --idx)
2272 {
2273 if (cstack->cs_flags[idx] & CSF_TRY)
2274 {
2275 /*
2276 * Discard anything pending in a finally clause and continue the
2277 * search. There may also be a pending ":continue", ":break",
2278 * ":return", or ":finish" before the finally clause. We must not
2279 * discard it, unless an error or interrupt occurred afterwards.
2280 */
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002281 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002282 {
2283 switch (cstack->cs_pending[idx])
2284 {
2285 case CSTP_NONE:
2286 break;
2287
2288 case CSTP_CONTINUE:
2289 case CSTP_BREAK:
2290 case CSTP_FINISH:
2291 report_discard_pending(cstack->cs_pending[idx], NULL);
2292 cstack->cs_pending[idx] = CSTP_NONE;
2293 break;
2294
2295 case CSTP_RETURN:
2296 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002297 cstack->cs_rettv[idx]);
2298 discard_pending_return(cstack->cs_rettv[idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002299 cstack->cs_pending[idx] = CSTP_NONE;
2300 break;
2301
2302 default:
2303 if (cstack->cs_flags[idx] & CSF_FINALLY)
2304 {
2305 if (cstack->cs_pending[idx] & CSTP_THROW)
2306 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002307 // Cancel the pending exception. This is in the
2308 // finally clause, so that the stack of the
2309 // caught exceptions is not involved.
Bram Moolenaar13656f02020-12-19 17:55:54 +01002310 discard_exception(
2311 (except_T *)cstack->cs_exception[idx],
Bram Moolenaar071d4272004-06-13 20:20:40 +00002312 FALSE);
2313 }
2314 else
2315 report_discard_pending(cstack->cs_pending[idx],
2316 NULL);
2317 cstack->cs_pending[idx] = CSTP_NONE;
2318 }
2319 break;
2320 }
2321 }
2322
2323 /*
2324 * Stop at a try conditional not in its finally clause. If this try
2325 * conditional is in an active catch clause, finish the caught
2326 * exception.
2327 */
2328 if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2329 {
2330 if ((cstack->cs_flags[idx] & CSF_ACTIVE)
2331 && (cstack->cs_flags[idx] & CSF_CAUGHT))
2332 finish_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002333 // Stop at this try conditional - except the try block never
2334 // got active (because of an inactive surrounding conditional
2335 // or when the ":try" appeared after an error or interrupt or
2336 // throw).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002337 if (cstack->cs_flags[idx] & CSF_TRUE)
2338 {
2339 if (searched_cond == 0 && !inclusive)
2340 break;
2341 stop = TRUE;
2342 }
2343 }
2344 }
2345
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002346 // Stop on the searched conditional type (even when the surrounding
2347 // conditional is not active or something has been made pending).
2348 // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2349 // check first whether "emsg_silent" needs to be restored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002350 if (cstack->cs_flags[idx] & searched_cond)
2351 {
2352 if (!inclusive)
2353 break;
2354 stop = TRUE;
2355 }
2356 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2357 if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2358 break;
2359
2360 /*
Bram Moolenaarccc18222007-05-10 18:25:20 +00002361 * When leaving a try conditional that reset "emsg_silent" on its
2362 * entry after saving the original value, restore that value here and
2363 * free the memory used to store it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002364 */
2365 if ((cstack->cs_flags[idx] & CSF_TRY)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002366 && (cstack->cs_flags[idx] & CSF_SILENT))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 {
2368 eslist_T *elem;
2369
2370 elem = cstack->cs_emsg_silent_list;
2371 cstack->cs_emsg_silent_list = elem->next;
2372 emsg_silent = elem->saved_emsg_silent;
2373 vim_free(elem);
2374 cstack->cs_flags[idx] &= ~CSF_SILENT;
2375 }
2376 if (stop)
2377 break;
2378 }
2379 return idx;
2380}
2381
2382/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002383 * Return an appropriate error message for a missing endwhile/endfor/endif.
2384 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002385 static char *
Bram Moolenaarddef1292019-12-16 17:10:33 +01002386get_end_emsg(cstack_T *cstack)
Bram Moolenaar12805862005-01-05 22:16:17 +00002387{
2388 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002389 return _(e_endwhile);
Bram Moolenaar12805862005-01-05 22:16:17 +00002390 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002391 return _(e_endfor);
2392 return _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00002393}
2394
2395
2396/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002397 * Rewind conditionals until index "idx" is reached. "cond_type" and
2398 * "cond_level" specify a conditional type and the address of a level variable
2399 * which is to be decremented with each skipped conditional of the specified
2400 * type.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002401 * Also free "for info" structures where needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002403 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002404rewind_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002405 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002406 int idx,
2407 int cond_type,
2408 int *cond_level)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409{
2410 while (cstack->cs_idx > idx)
2411 {
2412 if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2413 --*cond_level;
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002414 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2415 free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002416 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002417 }
2418}
2419
2420/*
2421 * ":endfunction" when not after a ":function"
2422 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002423 void
Bram Moolenaar6e949782020-04-13 17:21:00 +02002424ex_endfunction(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425{
Bram Moolenaar6e949782020-04-13 17:21:00 +02002426 if (eap->cmdidx == CMD_enddef)
2427 emsg(_("E193: :enddef not inside a function"));
2428 else
2429 emsg(_("E193: :endfunction not inside a function"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430}
2431
2432/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002433 * Return TRUE if the string "p" looks like a ":while" or ":for" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002434 */
2435 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002436has_loop_cmd(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437{
Bram Moolenaared53fb92007-11-24 20:50:24 +00002438 int len;
2439
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002440 // skip modifiers, white space and ':'
Bram Moolenaared53fb92007-11-24 20:50:24 +00002441 for (;;)
2442 {
2443 while (*p == ' ' || *p == '\t' || *p == ':')
2444 ++p;
2445 len = modifier_len(p);
2446 if (len == 0)
2447 break;
2448 p += len;
2449 }
Bram Moolenaar12805862005-01-05 22:16:17 +00002450 if ((p[0] == 'w' && p[1] == 'h')
2451 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002452 return TRUE;
2453 return FALSE;
2454}
2455
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002456#endif // FEAT_EVAL