blob: 94338fcdb2c60aad68dd791fc39e30796d793eff [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;
915 if (in_vim9script())
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 Moolenaarfcdc5d82020-10-10 19:07:09 +0200923}
924
925 static void
926leave_block(cstack_T *cstack)
927{
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200928 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200929 {
Bram Moolenaard7475482020-10-10 20:31:37 +0200930 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200931 int i;
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200932 int func_defined =
933 cstack->cs_flags[cstack->cs_idx] & CSF_FUNC_DEF;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200934
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200935 for (i = cstack->cs_script_var_len[cstack->cs_idx];
Bram Moolenaard7475482020-10-10 20:31:37 +0200936 i < si->sn_var_vals.ga_len; ++i)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200937 {
938 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
Bram Moolenaard7475482020-10-10 20:31:37 +0200939
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200940 // sv_name is set to NULL if it was already removed. This happens
941 // when it was defined in an inner block and no functions were
942 // defined there.
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200943 if (sv->sv_name != NULL)
944 // Remove a variable declared inside the block, if it still
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200945 // exists, from sn_vars and move the value into sn_all_vars
946 // if "func_defined" is non-zero.
947 hide_script_var(si, i, func_defined);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200948 }
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200949
950 // TODO: is this needed?
951 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200952
953 if (cstack->cs_idx == 0)
954 si->sn_current_block_id = 0;
955 else
956 si->sn_current_block_id = cstack->cs_block_id[cstack->cs_idx - 1];
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200957 }
958 --cstack->cs_idx;
959}
960
961/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000962 * ":if".
963 */
964 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100965ex_if(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966{
967 int error;
968 int skip;
969 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +0100970 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971
972 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +0200973 eap->errmsg = _("E579: :if nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000974 else
975 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200976 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000977 cstack->cs_flags[cstack->cs_idx] = 0;
978
979 /*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200980 * Don't do something after an error, interrupt, or throw, or when
981 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 */
983 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
984 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
985
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200986 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000987
988 if (!skip && !error)
989 {
990 if (result)
991 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
992 }
993 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100994 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
996 }
997}
998
999/*
1000 * ":endif".
1001 */
1002 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001003ex_endif(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001004{
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001005 cstack_T *cstack = eap->cstack;
1006
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 did_endif = TRUE;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001008 if (cstack->cs_idx < 0
1009 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001010 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001011 eap->errmsg = _(e_endif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 else
1013 {
1014 /*
1015 * When debugging or a breakpoint was encountered, display the debug
1016 * prompt (if not already done). This shows the user that an ":endif"
1017 * is executed when the ":if" or a previous ":elseif" was not TRUE.
1018 * Handle a ">quit" debug command as if an interrupt had occurred before
1019 * the ":endif". That is, throw an interrupt exception if appropriate.
1020 * Doing this here prevents an exception for a parsing error being
1021 * discarded by throwing the interrupt exception later on.
1022 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001023 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001024 && dbg_check_skipped(eap))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001025 (void)do_intthrow(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001027 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001028 }
1029}
1030
1031/*
1032 * ":else" and ":elseif".
1033 */
1034 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001035ex_else(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036{
1037 int error;
1038 int skip;
1039 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001040 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041
1042 /*
1043 * Don't do something after an error, interrupt, or throw, or when there is
1044 * a surrounding conditional and it was not active.
1045 */
1046 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1047 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1048
1049 if (cstack->cs_idx < 0
Bram Moolenaar12805862005-01-05 22:16:17 +00001050 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001051 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001052 {
1053 if (eap->cmdidx == CMD_else)
1054 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001055 eap->errmsg = _(e_else_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056 return;
1057 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001058 eap->errmsg = _(e_elseif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001059 skip = TRUE;
1060 }
1061 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
1062 {
1063 if (eap->cmdidx == CMD_else)
1064 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001065 eap->errmsg = _("E583: multiple :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 return;
1067 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001068 eap->errmsg = _("E584: :elseif after :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 skip = TRUE;
1070 }
1071
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001072 // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
1074 {
1075 if (eap->errmsg == NULL)
1076 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001077 skip = TRUE; // don't evaluate an ":elseif"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001078 }
1079 else
1080 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1081
1082 /*
1083 * When debugging or a breakpoint was encountered, display the debug prompt
1084 * (if not already done). This shows the user that an ":else" or ":elseif"
1085 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle
1086 * a ">quit" debug command as if an interrupt had occurred before the
1087 * ":else" or ":elseif". That is, set "skip" and throw an interrupt
1088 * exception if appropriate. Doing this here prevents that an exception
1089 * for a parsing errors is discarded when throwing the interrupt exception
1090 * later on.
1091 */
1092 if (!skip && dbg_check_skipped(eap) && got_int)
1093 {
1094 (void)do_intthrow(cstack);
1095 skip = TRUE;
1096 }
1097
1098 if (eap->cmdidx == CMD_elseif)
1099 {
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001100 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001101
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001102 // When throwing error exceptions, we want to throw always the first
1103 // of several errors in a row. This is what actually happens when
1104 // a conditional error was detected above and there is another failure
1105 // when parsing the expression. Since the skip flag is set in this
1106 // case, the parsing error will be ignored by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 if (!skip && !error)
1108 {
1109 if (result)
1110 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1111 else
1112 cstack->cs_flags[cstack->cs_idx] = 0;
1113 }
1114 else if (eap->errmsg == NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001115 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1117 }
1118 else
1119 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1120}
1121
1122/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001123 * Handle ":while" and ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124 */
1125 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001126ex_while(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127{
1128 int error;
1129 int skip;
1130 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001131 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132
1133 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001134 eap->errmsg = _("E585: :while/:for nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135 else
1136 {
1137 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001138 * The loop flag is set when we have jumped back from the matching
1139 * ":endwhile" or ":endfor". When not set, need to initialise this
1140 * cstack entry.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001141 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001142 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001144 enter_block(cstack);
Bram Moolenaar12805862005-01-05 22:16:17 +00001145 ++cstack->cs_looplevel;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001146 cstack->cs_line[cstack->cs_idx] = -1;
1147 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001148 cstack->cs_flags[cstack->cs_idx] =
1149 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150
1151 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001152 * Don't do something after an error, interrupt, or throw, or when
1153 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001154 */
1155 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1156 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
Bram Moolenaar12805862005-01-05 22:16:17 +00001157 if (eap->cmdidx == CMD_while)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001158 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001159 /*
1160 * ":while bool-expr"
1161 */
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001162 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 }
1164 else
1165 {
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001166 void *fi;
1167 evalarg_T evalarg;
1168
1169 CLEAR_FIELD(evalarg);
1170 evalarg.eval_flags = skip ? 0 : EVAL_EVALUATE;
1171 if (getline_equal(eap->getline, eap->cookie, getsourceline))
1172 {
1173 evalarg.eval_getline = eap->getline;
1174 evalarg.eval_cookie = eap->cookie;
1175 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001176
1177 /*
1178 * ":for var in list-expr"
1179 */
1180 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
1181 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001182 // Jumping here from a ":continue" or ":endfor": use the
1183 // previously evaluated list.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001184 fi = cstack->cs_forinfo[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001185 error = FALSE;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001186
1187 // the "in expr" is not used, skip over it
1188 skip_for_lines(fi, &evalarg);
Bram Moolenaar12805862005-01-05 22:16:17 +00001189 }
1190 else
1191 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001192 // Evaluate the argument and get the info in a structure.
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001193 fi = eval_for_line(eap->arg, &error, eap, &evalarg);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001194 cstack->cs_forinfo[cstack->cs_idx] = fi;
Bram Moolenaar12805862005-01-05 22:16:17 +00001195 }
1196
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001197 // use the element at the start of the list and advance
Bram Moolenaar12805862005-01-05 22:16:17 +00001198 if (!error && fi != NULL && !skip)
1199 result = next_for_item(fi, eap->arg);
1200 else
1201 result = FALSE;
1202
1203 if (!result)
1204 {
1205 free_for_info(fi);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001206 cstack->cs_forinfo[cstack->cs_idx] = NULL;
Bram Moolenaar12805862005-01-05 22:16:17 +00001207 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001208 clear_evalarg(&evalarg, eap);
Bram Moolenaar12805862005-01-05 22:16:17 +00001209 }
1210
1211 /*
1212 * If this cstack entry was just initialised and is active, set the
1213 * loop flag, so do_cmdline() will set the line number in cs_line[].
1214 * If executing the command a second time, clear the loop flag.
1215 */
1216 if (!skip && !error && result)
1217 {
1218 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
1219 cstack->cs_lflags ^= CSL_HAD_LOOP;
1220 }
1221 else
1222 {
1223 cstack->cs_lflags &= ~CSL_HAD_LOOP;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001224 // If the ":while" evaluates to FALSE or ":for" is past the end of
1225 // the list, show the debug prompt at the ":endwhile"/":endfor" as
1226 // if there was a ":break" in a ":while"/":for" evaluating to
1227 // TRUE.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 if (!skip && !error)
1229 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1230 }
1231 }
1232}
1233
1234/*
1235 * ":continue"
1236 */
1237 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001238ex_continue(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239{
1240 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001241 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242
Bram Moolenaar12805862005-01-05 22:16:17 +00001243 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001244 eap->errmsg = _(e_continue);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001245 else
1246 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001247 // Try to find the matching ":while". This might stop at a try
1248 // conditional not in its finally clause (which is then to be executed
1249 // next). Therefor, inactivate all conditionals except the ":while"
1250 // itself (if reached).
Bram Moolenaar12805862005-01-05 22:16:17 +00001251 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001252 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001253 {
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001254 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255
1256 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001257 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258 * matching ":while".
1259 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001260 cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261 }
1262 else
1263 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001264 // If a try conditional not in its finally clause is reached first,
1265 // make the ":continue" pending for execution at the ":endtry".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266 cstack->cs_pending[idx] = CSTP_CONTINUE;
1267 report_make_pending(CSTP_CONTINUE, NULL);
1268 }
1269 }
1270}
1271
1272/*
1273 * ":break"
1274 */
1275 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001276ex_break(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001277{
1278 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001279 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280
Bram Moolenaar12805862005-01-05 22:16:17 +00001281 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001282 eap->errmsg = _(e_break);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001283 else
1284 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001285 // Inactivate conditionals until the matching ":while" or a try
1286 // conditional not in its finally clause (which is then to be
1287 // executed next) is found. In the latter case, make the ":break"
1288 // pending for execution at the ":endtry".
Bram Moolenaar12805862005-01-05 22:16:17 +00001289 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001290 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001291 {
1292 cstack->cs_pending[idx] = CSTP_BREAK;
1293 report_make_pending(CSTP_BREAK, NULL);
1294 }
1295 }
1296}
1297
1298/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001299 * ":endwhile" and ":endfor"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001300 */
1301 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001302ex_endwhile(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303{
Bram Moolenaarddef1292019-12-16 17:10:33 +01001304 cstack_T *cstack = eap->cstack;
1305 int idx;
1306 char *err;
1307 int csf;
1308 int fl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001309
Bram Moolenaar12805862005-01-05 22:16:17 +00001310 if (eap->cmdidx == CMD_endwhile)
1311 {
1312 err = e_while;
1313 csf = CSF_WHILE;
1314 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 else
1316 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001317 err = e_for;
1318 csf = CSF_FOR;
1319 }
1320
1321 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001322 eap->errmsg = _(err);
Bram Moolenaar12805862005-01-05 22:16:17 +00001323 else
1324 {
1325 fl = cstack->cs_flags[cstack->cs_idx];
1326 if (!(fl & csf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001327 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001328 // If we are in a ":while" or ":for" but used the wrong endloop
1329 // command, do not rewind to the next enclosing ":for"/":while".
Bram Moolenaar12805862005-01-05 22:16:17 +00001330 if (fl & CSF_WHILE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001331 eap->errmsg = _("E732: Using :endfor with :while");
Bram Moolenaar12805862005-01-05 22:16:17 +00001332 else if (fl & CSF_FOR)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001333 eap->errmsg = _("E733: Using :endwhile with :for");
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00001334 }
1335 if (!(fl & (CSF_WHILE | CSF_FOR)))
1336 {
1337 if (!(fl & CSF_TRY))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001338 eap->errmsg = _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00001339 else if (fl & CSF_FINALLY)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001340 eap->errmsg = _(e_endtry);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001341 // Try to find the matching ":while" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 for (idx = cstack->cs_idx; idx > 0; --idx)
1343 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001344 fl = cstack->cs_flags[idx];
1345 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001347 // Give up at a try conditional not in its finally clause.
1348 // Ignore the ":endwhile"/":endfor".
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001349 eap->errmsg = _(err);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 return;
1351 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001352 if (fl & csf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001353 break;
1354 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001355 // Cleanup and rewind all contained (and unclosed) conditionals.
Bram Moolenaar12805862005-01-05 22:16:17 +00001356 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1358 }
1359
1360 /*
1361 * When debugging or a breakpoint was encountered, display the debug
1362 * prompt (if not already done). This shows the user that an
Bram Moolenaar12805862005-01-05 22:16:17 +00001363 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
1364 * after a ":break". Handle a ">quit" debug command as if an
1365 * interrupt had occurred before the ":endwhile"/":endfor". That is,
1366 * throw an interrupt exception if appropriate. Doing this here
1367 * prevents that an exception for a parsing error is discarded when
1368 * throwing the interrupt exception later on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 */
1370 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1371 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1372 && dbg_check_skipped(eap))
1373 (void)do_intthrow(cstack);
1374
1375 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001376 * Set loop flag, so do_cmdline() will jump back to the matching
1377 * ":while" or ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001379 cstack->cs_lflags |= CSL_HAD_ENDLOOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001380 }
1381}
1382
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001383/*
1384 * "{" start of a block in Vim9 script
1385 */
1386 void
1387ex_block(exarg_T *eap)
1388{
1389 cstack_T *cstack = eap->cstack;
1390
1391 if (cstack->cs_idx == CSTACK_LEN - 1)
1392 eap->errmsg = _("E579: block nesting too deep");
1393 else
1394 {
1395 enter_block(cstack);
1396 cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE;
1397 }
1398}
1399
1400/*
1401 * "}" end of a block in Vim9 script
1402 */
1403 void
1404ex_endblock(exarg_T *eap)
1405{
1406 cstack_T *cstack = eap->cstack;
1407
1408 if (cstack->cs_idx < 0
1409 || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0)
1410 eap->errmsg = _(e_endblock_without_block);
1411 else
1412 leave_block(cstack);
1413}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001414
1415/*
1416 * ":throw expr"
1417 */
1418 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001419ex_throw(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001420{
1421 char_u *arg = eap->arg;
1422 char_u *value;
1423
1424 if (*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001425 value = eval_to_string_skip(arg, eap, eap->skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001426 else
1427 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001428 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001429 value = NULL;
1430 }
1431
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001432 // On error or when an exception is thrown during argument evaluation, do
1433 // not throw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001434 if (!eap->skip && value != NULL)
1435 {
1436 if (throw_exception(value, ET_USER, NULL) == FAIL)
1437 vim_free(value);
1438 else
1439 do_throw(eap->cstack);
1440 }
1441}
1442
1443/*
Bram Moolenaar269ec652004-07-29 08:43:53 +00001444 * Throw the current exception through the specified cstack. Common routine
1445 * for ":throw" (user exception) and error and interrupt exceptions. Also
1446 * used for rethrowing an uncaught exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 */
1448 void
Bram Moolenaarddef1292019-12-16 17:10:33 +01001449do_throw(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450{
1451 int idx;
1452 int inactivate_try = FALSE;
1453
1454 /*
1455 * Cleanup and inactivate up to the next surrounding try conditional that
1456 * is not in its finally clause. Normally, do not inactivate the try
1457 * conditional itself, so that its ACTIVE flag can be tested below. But
1458 * if a previous error or interrupt has not been converted to an exception,
1459 * inactivate the try conditional, too, as if the conversion had been done,
Bram Moolenaar269ec652004-07-29 08:43:53 +00001460 * and reset the did_emsg or got_int flag, so this won't happen again at
1461 * the next surrounding try conditional.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462 */
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001463#ifndef THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001464 if (did_emsg && !THROW_ON_ERROR)
1465 {
1466 inactivate_try = TRUE;
1467 did_emsg = FALSE;
1468 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001469#endif
1470#ifndef THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001471 if (got_int && !THROW_ON_INTERRUPT)
1472 {
1473 inactivate_try = TRUE;
1474 got_int = FALSE;
1475 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001476#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001477 idx = cleanup_conditionals(cstack, 0, inactivate_try);
1478 if (idx >= 0)
1479 {
1480 /*
1481 * If this try conditional is active and we are before its first
Bram Moolenaar269ec652004-07-29 08:43:53 +00001482 * ":catch", set THROWN so that the ":catch" commands will check
1483 * whether the exception matches. When the exception came from any of
1484 * the catch clauses, it will be made pending at the ":finally" (if
1485 * present) and rethrown at the ":endtry". This will also happen if
1486 * the try conditional is inactive. This is the case when we are
1487 * throwing an exception due to an error or interrupt on the way from
1488 * a preceding ":continue", ":break", ":return", ":finish", error or
1489 * interrupt (not converted to an exception) to the finally clause or
1490 * from a preceding throw of a user or error or interrupt exception to
1491 * the matching catch clause or the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001492 */
1493 if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1494 {
1495 if (cstack->cs_flags[idx] & CSF_ACTIVE)
1496 cstack->cs_flags[idx] |= CSF_THROWN;
1497 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001498 // THROWN may have already been set for a catchable exception
1499 // that has been discarded. Ensure it is reset for the new
1500 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 cstack->cs_flags[idx] &= ~CSF_THROWN;
1502 }
1503 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1504 cstack->cs_exception[idx] = current_exception;
1505 }
1506#if 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001507 // TODO: Add optimization below. Not yet done because of interface
1508 // problems to eval.c and ex_cmds2.c. (Servatius)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001509 else
1510 {
1511 /*
1512 * There are no catch clauses to check or finally clauses to execute.
1513 * End the current script or function. The exception will be rethrown
1514 * in the caller.
1515 */
1516 if (getline_equal(eap->getline, eap->cookie, get_func_line))
1517 current_funccal->returned = TRUE;
1518 elseif (eap->get_func_line == getsourceline)
1519 ((struct source_cookie *)eap->cookie)->finished = TRUE;
1520 }
1521#endif
1522
1523 did_throw = TRUE;
1524}
1525
1526/*
1527 * ":try"
1528 */
1529 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001530ex_try(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001531{
1532 int skip;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001533 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534
1535 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001536 eap->errmsg = _("E601: :try nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001537 else
1538 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001539 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 ++cstack->cs_trylevel;
1541 cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1542 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1543
1544 /*
1545 * Don't do something after an error, interrupt, or throw, or when there
1546 * is a surrounding conditional and it was not active.
1547 */
1548 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1549 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1550
1551 if (!skip)
1552 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001553 // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch"
1554 // commands should check for a match if an exception is thrown and
1555 // that the finally clause needs to be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1557
1558 /*
1559 * ":silent!", even when used in a try conditional, disables
1560 * displaying of error messages and conversion of errors to
1561 * exceptions. When the silent commands again open a try
1562 * conditional, save "emsg_silent" and reset it so that errors are
1563 * again converted to exceptions. The value is restored when that
1564 * try conditional is left. If it is left normally, the commands
1565 * following the ":endtry" are again silent. If it is left by
1566 * a ":continue", ":break", ":return", or ":finish", the commands
1567 * executed next are again silent. If it is left due to an
1568 * aborting error, an interrupt, or an exception, restoring
1569 * "emsg_silent" does not matter since we are already in the
1570 * aborting state and/or the exception has already been thrown.
1571 * The effect is then just freeing the memory that was allocated
1572 * to save the value.
1573 */
1574 if (emsg_silent)
1575 {
1576 eslist_T *elem;
1577
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001578 elem = ALLOC_ONE(struct eslist_elem);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001579 if (elem == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001580 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001581 else
1582 {
1583 elem->saved_emsg_silent = emsg_silent;
1584 elem->next = cstack->cs_emsg_silent_list;
1585 cstack->cs_emsg_silent_list = elem;
1586 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1587 emsg_silent = 0;
1588 }
1589 }
1590 }
1591
1592 }
1593}
1594
1595/*
1596 * ":catch /{pattern}/" and ":catch"
1597 */
1598 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001599ex_catch(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600{
1601 int idx = 0;
1602 int give_up = FALSE;
1603 int skip = FALSE;
1604 int caught = FALSE;
1605 char_u *end;
1606 int save_char = 0;
1607 char_u *save_cpo;
1608 regmatch_T regmatch;
1609 int prev_got_int;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001610 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 char_u *pat;
1612
1613 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1614 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001615 eap->errmsg = _(e_catch);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 give_up = TRUE;
1617 }
1618 else
1619 {
1620 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1621 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001622 // Report what's missing if the matching ":try" is not in its
1623 // finally clause.
Bram Moolenaar12805862005-01-05 22:16:17 +00001624 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001625 skip = TRUE;
1626 }
1627 for (idx = cstack->cs_idx; idx > 0; --idx)
1628 if (cstack->cs_flags[idx] & CSF_TRY)
1629 break;
1630 if (cstack->cs_flags[idx] & CSF_FINALLY)
1631 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001632 // Give up for a ":catch" after ":finally" and ignore it.
1633 // Just parse.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001634 eap->errmsg = _("E604: :catch after :finally");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001635 give_up = TRUE;
1636 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001637 else
Bram Moolenaar12805862005-01-05 22:16:17 +00001638 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1639 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 }
1641
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001642 if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 {
1644 pat = (char_u *)".*";
1645 end = NULL;
1646 eap->nextcmd = find_nextcmd(eap->arg);
1647 }
1648 else
1649 {
1650 pat = eap->arg + 1;
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001651 end = skip_regexp_err(pat, *eap->arg, TRUE);
1652 if (end == NULL)
1653 give_up = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001654 }
1655
1656 if (!give_up)
1657 {
1658 /*
1659 * Don't do something when no exception has been thrown or when the
1660 * corresponding try block never got active (because of an inactive
1661 * surrounding conditional or after an error or interrupt or throw).
1662 */
1663 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1664 skip = TRUE;
1665
1666 /*
1667 * Check for a match only if an exception is thrown but not caught by
1668 * a previous ":catch". An exception that has replaced a discarded
1669 * exception is not checked (THROWN is not set then).
1670 */
1671 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1672 && !(cstack->cs_flags[idx] & CSF_CAUGHT))
1673 {
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001674 if (end != NULL && *end != NUL
1675 && !ends_excmd2(end, skipwhite(end + 1)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001676 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001677 semsg(_(e_trailing_arg), end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001678 return;
1679 }
1680
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001681 // When debugging or a breakpoint was encountered, display the
1682 // debug prompt (if not already done) before checking for a match.
1683 // This is a helpful hint for the user when the regular expression
1684 // matching fails. Handle a ">quit" debug command as if an
1685 // interrupt had occurred before the ":catch". That is, discard
1686 // the original exception, replace it by an interrupt exception,
1687 // and don't catch it in this try block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1689 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001690 // Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1691 // while compiling it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001692 if (end != NULL)
1693 {
1694 save_char = *end;
1695 *end = NUL;
1696 }
1697 save_cpo = p_cpo;
Bram Moolenaare5a2dc82021-01-03 19:52:05 +01001698 p_cpo = empty_option;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001699 // Disable error messages, it will make current_exception
1700 // invalid.
Bram Moolenaar768ce242016-02-07 19:46:12 +01001701 ++emsg_off;
Bram Moolenaar150cc272007-08-01 13:47:46 +00001702 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
Bram Moolenaar768ce242016-02-07 19:46:12 +01001703 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 regmatch.rm_ic = FALSE;
1705 if (end != NULL)
1706 *end = save_char;
1707 p_cpo = save_cpo;
1708 if (regmatch.regprog == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001709 semsg(_(e_invarg2), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 else
1711 {
1712 /*
1713 * Save the value of got_int and reset it. We don't want
1714 * a previous interruption cancel matching, only hitting
1715 * CTRL-C while matching should abort it.
1716 */
1717 prev_got_int = got_int;
1718 got_int = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001719 caught = vim_regexec_nl(&regmatch,
1720 (char_u *)current_exception->value, (colnr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001721 got_int |= prev_got_int;
Bram Moolenaar473de612013-06-08 18:19:48 +02001722 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001723 }
1724 }
1725 }
1726
1727 if (caught)
1728 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001729 // Make this ":catch" clause active and reset did_emsg, got_int,
1730 // and did_throw. Put the exception on the caught stack.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1732 did_emsg = got_int = did_throw = FALSE;
1733 catch_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001734 // It's mandatory that the current exception is stored in the cstack
1735 // so that it can be discarded at the next ":catch", ":finally", or
1736 // ":endtry" or when the catch clause is left by a ":continue",
1737 // ":break", ":return", ":finish", error, interrupt, or another
1738 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 if (cstack->cs_exception[cstack->cs_idx] != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001740 internal_error("ex_catch()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001741 }
1742 else
1743 {
1744 /*
1745 * If there is a preceding catch clause and it caught the exception,
1746 * finish the exception now. This happens also after errors except
1747 * when this ":catch" was after the ":finally" or not within
1748 * a ":try". Make the try conditional inactive so that the
1749 * following catch clauses are skipped. On an error or interrupt
1750 * after the preceding try block or catch clause was left by
1751 * a ":continue", ":break", ":return", or ":finish", discard the
1752 * pending action.
1753 */
1754 cleanup_conditionals(cstack, CSF_TRY, TRUE);
1755 }
1756 }
1757
1758 if (end != NULL)
1759 eap->nextcmd = find_nextcmd(end);
1760}
1761
1762/*
1763 * ":finally"
1764 */
1765 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001766ex_finally(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001767{
1768 int idx;
1769 int skip = FALSE;
1770 int pending = CSTP_NONE;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001771 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772
1773 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001774 eap->errmsg = _(e_finally);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 else
1776 {
1777 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1778 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001779 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1781 if (cstack->cs_flags[idx] & CSF_TRY)
1782 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001783 // Make this error pending, so that the commands in the following
1784 // finally clause can be executed. This overrules also a pending
1785 // ":continue", ":break", ":return", or ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 pending = CSTP_ERROR;
1787 }
1788 else
1789 idx = cstack->cs_idx;
1790
1791 if (cstack->cs_flags[idx] & CSF_FINALLY)
1792 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001793 // Give up for a multiple ":finally" and ignore it.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001794 eap->errmsg = _(e_finally_dup);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001795 return;
1796 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001797 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
Bram Moolenaar12805862005-01-05 22:16:17 +00001798 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799
1800 /*
1801 * Don't do something when the corresponding try block never got active
1802 * (because of an inactive surrounding conditional or after an error or
1803 * interrupt or throw) or for a ":finally" without ":try" or a multiple
1804 * ":finally". After every other error (did_emsg or the conditional
1805 * errors detected above) or after an interrupt (got_int) or an
1806 * exception (did_throw), the finally clause must be executed.
1807 */
1808 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1809
1810 if (!skip)
1811 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001812 // When debugging or a breakpoint was encountered, display the
1813 // debug prompt (if not already done). The user then knows that the
1814 // finally clause is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 if (dbg_check_skipped(eap))
1816 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001817 // Handle a ">quit" debug command as if an interrupt had
1818 // occurred before the ":finally". That is, discard the
1819 // original exception and replace it by an interrupt
1820 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 (void)do_intthrow(cstack);
1822 }
1823
1824 /*
1825 * If there is a preceding catch clause and it caught the exception,
1826 * finish the exception now. This happens also after errors except
1827 * when this is a multiple ":finally" or one not within a ":try".
1828 * After an error or interrupt, this also discards a pending
1829 * ":continue", ":break", ":finish", or ":return" from the preceding
1830 * try block or catch clause.
1831 */
1832 cleanup_conditionals(cstack, CSF_TRY, FALSE);
1833
1834 /*
1835 * Make did_emsg, got_int, did_throw pending. If set, they overrule
1836 * a pending ":continue", ":break", ":return", or ":finish". Then
1837 * we have particularly to discard a pending return value (as done
1838 * by the call to cleanup_conditionals() above when did_emsg or
1839 * got_int is set). The pending values are restored by the
1840 * ":endtry", except if there is a new error, interrupt, exception,
1841 * ":continue", ":break", ":return", or ":finish" in the following
Bram Moolenaar12805862005-01-05 22:16:17 +00001842 * finally clause. A missing ":endwhile", ":endfor" or ":endif"
1843 * detected here is treated as if did_emsg and did_throw had
1844 * already been set, respectively in case that the error is not
1845 * converted to an exception, did_throw had already been unset.
1846 * We must not set did_emsg here since that would suppress the
1847 * error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001848 */
1849 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1850 {
1851 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
1852 {
1853 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001854 cstack->cs_rettv[cstack->cs_idx]);
1855 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001856 }
1857 if (pending == CSTP_ERROR && !did_emsg)
1858 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
1859 else
1860 pending |= did_throw ? CSTP_THROW : 0;
1861 pending |= did_emsg ? CSTP_ERROR : 0;
1862 pending |= got_int ? CSTP_INTERRUPT : 0;
1863 cstack->cs_pending[cstack->cs_idx] = pending;
1864
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001865 // It's mandatory that the current exception is stored in the
1866 // cstack so that it can be rethrown at the ":endtry" or be
1867 // discarded if the finally clause is left by a ":continue",
1868 // ":break", ":return", ":finish", error, interrupt, or another
1869 // exception. When emsg() is called for a missing ":endif" or
1870 // a missing ":endwhile"/":endfor" detected here, the
1871 // exception will be discarded.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001872 if (did_throw && cstack->cs_exception[cstack->cs_idx]
1873 != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001874 internal_error("ex_finally()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001875 }
1876
1877 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001878 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001879 * got_int, and did_throw and make the finally clause active.
1880 * This will happen after emsg() has been called for a missing
Bram Moolenaar12805862005-01-05 22:16:17 +00001881 * ":endif" or a missing ":endwhile"/":endfor" detected here, so
1882 * that the following finally clause will be executed even then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001884 cstack->cs_lflags |= CSL_HAD_FINA;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 }
1886 }
1887}
1888
1889/*
1890 * ":endtry"
1891 */
1892 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001893ex_endtry(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894{
1895 int idx;
1896 int skip;
1897 int rethrow = FALSE;
1898 int pending = CSTP_NONE;
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001899 void *rettv = NULL;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001900 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001901
1902 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001903 eap->errmsg = _(e_no_endtry);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001904 else
1905 {
1906 /*
1907 * Don't do something after an error, interrupt or throw in the try
1908 * block, catch clause, or finally clause preceding this ":endtry" or
1909 * when an error or interrupt occurred after a ":continue", ":break",
1910 * ":return", or ":finish" in a try block or catch clause preceding this
1911 * ":endtry" or when the try block never got active (because of an
1912 * inactive surrounding conditional or after an error or interrupt or
1913 * throw) or when there is a surrounding conditional and it has been
1914 * made inactive by a ":continue", ":break", ":return", or ":finish" in
1915 * the finally clause. The latter case need not be tested since then
1916 * anything pending has already been discarded. */
1917 skip = did_emsg || got_int || did_throw ||
1918 !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1919
1920 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1921 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001922 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001923 // Find the matching ":try" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 idx = cstack->cs_idx;
1925 do
1926 --idx;
1927 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
Bram Moolenaar12805862005-01-05 22:16:17 +00001928 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1929 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001930 skip = TRUE;
1931
1932 /*
1933 * If an exception is being thrown, discard it to prevent it from
1934 * being rethrown at the end of this function. It would be
1935 * discarded by the error message, anyway. Resets did_throw.
1936 * This does not affect the script termination due to the error
1937 * since "trylevel" is decremented after emsg() has been called.
1938 */
1939 if (did_throw)
1940 discard_current_exception();
1941 }
1942 else
1943 {
1944 idx = cstack->cs_idx;
1945
1946 /*
1947 * If we stopped with the exception currently being thrown at this
1948 * try conditional since we didn't know that it doesn't have
1949 * a finally clause, we need to rethrow it after closing the try
1950 * conditional.
1951 */
1952 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
1953 && !(cstack->cs_flags[idx] & CSF_FINALLY))
1954 rethrow = TRUE;
1955 }
1956
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001957 // If there was no finally clause, show the user when debugging or
1958 // a breakpoint was encountered that the end of the try conditional has
1959 // been reached: display the debug prompt (if not already done). Do
1960 // this on normal control flow or when an exception was thrown, but not
1961 // on an interrupt or error not converted to an exception or when
1962 // a ":break", ":continue", ":return", or ":finish" is pending. These
1963 // actions are carried out immediately.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 if ((rethrow || (!skip
1965 && !(cstack->cs_flags[idx] & CSF_FINALLY)
1966 && !cstack->cs_pending[idx]))
1967 && dbg_check_skipped(eap))
1968 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001969 // Handle a ">quit" debug command as if an interrupt had occurred
1970 // before the ":endtry". That is, throw an interrupt exception and
1971 // set "skip" and "rethrow".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001972 if (got_int)
1973 {
1974 skip = TRUE;
1975 (void)do_intthrow(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001976 // The do_intthrow() call may have reset did_throw or
1977 // cstack->cs_pending[idx].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001978 rethrow = FALSE;
1979 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY))
1980 rethrow = TRUE;
1981 }
1982 }
1983
1984 /*
1985 * If a ":return" is pending, we need to resume it after closing the
1986 * try conditional; remember the return value. If there was a finally
1987 * clause making an exception pending, we need to rethrow it. Make it
1988 * the exception currently being thrown.
1989 */
1990 if (!skip)
1991 {
1992 pending = cstack->cs_pending[idx];
1993 cstack->cs_pending[idx] = CSTP_NONE;
1994 if (pending == CSTP_RETURN)
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001995 rettv = cstack->cs_rettv[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 else if (pending & CSTP_THROW)
1997 current_exception = cstack->cs_exception[idx];
1998 }
1999
2000 /*
2001 * Discard anything pending on an error, interrupt, or throw in the
2002 * finally clause. If there was no ":finally", discard a pending
2003 * ":continue", ":break", ":return", or ":finish" if an error or
2004 * interrupt occurred afterwards, but before the ":endtry" was reached.
2005 * If an exception was caught by the last of the catch clauses and there
2006 * was no finally clause, finish the exception now. This happens also
2007 * after errors except when this ":endtry" is not within a ":try".
2008 * Restore "emsg_silent" if it has been reset by this try conditional.
2009 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002010 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002012 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 --cstack->cs_trylevel;
2014
2015 if (!skip)
2016 {
2017 report_resume_pending(pending,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002018 (pending == CSTP_RETURN) ? rettv :
Bram Moolenaar071d4272004-06-13 20:20:40 +00002019 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2020 switch (pending)
2021 {
2022 case CSTP_NONE:
2023 break;
2024
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002025 // Reactivate a pending ":continue", ":break", ":return",
2026 // ":finish" from the try block or a catch clause of this try
2027 // conditional. This is skipped, if there was an error in an
2028 // (unskipped) conditional command or an interrupt afterwards
2029 // or if the finally clause is present and executed a new error,
2030 // interrupt, throw, ":continue", ":break", ":return", or
2031 // ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032 case CSTP_CONTINUE:
2033 ex_continue(eap);
2034 break;
2035 case CSTP_BREAK:
2036 ex_break(eap);
2037 break;
2038 case CSTP_RETURN:
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002039 do_return(eap, FALSE, FALSE, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 break;
2041 case CSTP_FINISH:
2042 do_finish(eap, FALSE);
2043 break;
2044
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002045 // When the finally clause was entered due to an error,
2046 // interrupt or throw (as opposed to a ":continue", ":break",
2047 // ":return", or ":finish"), restore the pending values of
2048 // did_emsg, got_int, and did_throw. This is skipped, if there
2049 // was a new error, interrupt, throw, ":continue", ":break",
2050 // ":return", or ":finish". in the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051 default:
2052 if (pending & CSTP_ERROR)
2053 did_emsg = TRUE;
2054 if (pending & CSTP_INTERRUPT)
2055 got_int = TRUE;
2056 if (pending & CSTP_THROW)
2057 rethrow = TRUE;
2058 break;
2059 }
2060 }
2061
2062 if (rethrow)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002063 // Rethrow the current exception (within this cstack).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002064 do_throw(cstack);
2065 }
2066}
2067
2068/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002069 * enter_cleanup() and leave_cleanup()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002070 *
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002071 * Functions to be called before/after invoking a sequence of autocommands for
2072 * cleanup for a failed command. (Failure means here that a call to emsg()
2073 * has been made, an interrupt occurred, or there is an uncaught exception
2074 * from a previous autocommand execution of the same command.)
2075 *
2076 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same
2077 * pointer to leave_cleanup(). The cleanup_T structure stores the pending
2078 * error/interrupt/exception state.
2079 */
2080
2081/*
2082 * This function works a bit like ex_finally() except that there was not
2083 * actually an extra try block around the part that failed and an error or
2084 * interrupt has not (yet) been converted to an exception. This function
2085 * saves the error/interrupt/ exception state and prepares for the call to
2086 * do_cmdline() that is going to be made for the cleanup autocommand
2087 * execution.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002088 */
2089 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002090enter_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002091{
2092 int pending = CSTP_NONE;
2093
2094 /*
2095 * Postpone did_emsg, got_int, did_throw. The pending values will be
2096 * restored by leave_cleanup() except if there was an aborting error,
2097 * interrupt, or uncaught exception after this function ends.
2098 */
2099 if (did_emsg || got_int || did_throw || need_rethrow)
2100 {
2101 csp->pending = (did_emsg ? CSTP_ERROR : 0)
2102 | (got_int ? CSTP_INTERRUPT : 0)
2103 | (did_throw ? CSTP_THROW : 0)
2104 | (need_rethrow ? CSTP_THROW : 0);
2105
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002106 // If we are currently throwing an exception (did_throw), save it as
2107 // well. On an error not yet converted to an exception, update
2108 // "force_abort" and reset "cause_abort" (as do_errthrow() would do).
2109 // This is needed for the do_cmdline() call that is going to be made
2110 // for autocommand execution. We need not save *msg_list because
2111 // there is an extra instance for every call of do_cmdline(), anyway.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002112 if (did_throw || need_rethrow)
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002113 {
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002114 csp->exception = current_exception;
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002115 current_exception = NULL;
2116 }
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002117 else
2118 {
2119 csp->exception = NULL;
2120 if (did_emsg)
2121 {
2122 force_abort |= cause_abort;
2123 cause_abort = FALSE;
2124 }
2125 }
2126 did_emsg = got_int = did_throw = need_rethrow = FALSE;
2127
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002128 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002129 report_make_pending(pending, csp->exception);
2130 }
2131 else
2132 {
2133 csp->pending = CSTP_NONE;
2134 csp->exception = NULL;
2135 }
2136}
2137
2138/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002139 * See comment above enter_cleanup() for how this function is used.
2140 *
2141 * This function is a bit like ex_endtry() except that there was not actually
2142 * an extra try block around the part that failed and an error or interrupt
2143 * had not (yet) been converted to an exception when the cleanup autocommand
2144 * sequence was invoked.
2145 *
2146 * This function has to be called with the address of the cleanup_T structure
2147 * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2148 * exception state saved by that function - except there was an aborting
2149 * error, an interrupt or an uncaught exception during execution of the
2150 * cleanup autocommands. In the latter case, the saved error/interrupt/
2151 * exception state is discarded.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002152 */
2153 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002154leave_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002155{
2156 int pending = csp->pending;
2157
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002158 if (pending == CSTP_NONE) // nothing to do
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002159 return;
2160
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002161 // If there was an aborting error, an interrupt, or an uncaught exception
2162 // after the corresponding call to enter_cleanup(), discard what has been
2163 // made pending by it. Report this to the user if required by the
2164 // 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002165 if (aborting() || need_rethrow)
2166 {
2167 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002168 // Cancel the pending exception (includes report).
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002169 discard_exception((except_T *)csp->exception, FALSE);
2170 else
2171 report_discard_pending(pending, NULL);
2172
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002173 // If an error was about to be converted to an exception when
2174 // enter_cleanup() was called, free the message list.
Bram Moolenaar4632d292006-11-28 17:36:37 +00002175 if (msg_list != NULL)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +01002176 free_global_msglist();
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002177 }
2178
2179 /*
2180 * If there was no new error, interrupt, or throw between the calls
2181 * to enter_cleanup() and leave_cleanup(), restore the pending
2182 * error/interrupt/exception state.
2183 */
2184 else
2185 {
2186 /*
2187 * If there was an exception being thrown when enter_cleanup() was
2188 * called, we need to rethrow it. Make it the exception currently
2189 * being thrown.
2190 */
2191 if (pending & CSTP_THROW)
2192 current_exception = csp->exception;
2193
2194 /*
2195 * If an error was about to be converted to an exception when
2196 * enter_cleanup() was called, let "cause_abort" take the part of
2197 * "force_abort" (as done by cause_errthrow()).
2198 */
2199 else if (pending & CSTP_ERROR)
2200 {
2201 cause_abort = force_abort;
2202 force_abort = FALSE;
2203 }
2204
2205 /*
2206 * Restore the pending values of did_emsg, got_int, and did_throw.
2207 */
2208 if (pending & CSTP_ERROR)
2209 did_emsg = TRUE;
2210 if (pending & CSTP_INTERRUPT)
2211 got_int = TRUE;
2212 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002213 need_rethrow = TRUE; // did_throw will be set by do_one_cmd()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002214
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002215 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002216 report_resume_pending(pending,
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002217 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002218 }
2219}
2220
2221
2222/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002223 * Make conditionals inactive and discard what's pending in finally clauses
2224 * until the conditional type searched for or a try conditional not in its
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002225 * finally clause is reached. If this is in an active catch clause, finish
2226 * the caught exception.
2227 * Return the cstack index where the search stopped.
Bram Moolenaar12805862005-01-05 22:16:17 +00002228 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
2229 * the latter meaning the innermost try conditional not in its finally clause.
2230 * "inclusive" tells whether the conditional searched for should be made
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002231 * inactive itself (a try conditional not in its finally clause possibly find
Bram Moolenaar12805862005-01-05 22:16:17 +00002232 * before is always made inactive). If "inclusive" is TRUE and
2233 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
2234 * "emsg_silent", if reset when the try conditional finally reached was
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002235 * entered, is restored (used by ex_endtry()). This is normally done only
Bram Moolenaar12805862005-01-05 22:16:17 +00002236 * when such a try conditional is left.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002237 */
2238 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002239cleanup_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002240 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002241 int searched_cond,
2242 int inclusive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002243{
2244 int idx;
2245 int stop = FALSE;
2246
2247 for (idx = cstack->cs_idx; idx >= 0; --idx)
2248 {
2249 if (cstack->cs_flags[idx] & CSF_TRY)
2250 {
2251 /*
2252 * Discard anything pending in a finally clause and continue the
2253 * search. There may also be a pending ":continue", ":break",
2254 * ":return", or ":finish" before the finally clause. We must not
2255 * discard it, unless an error or interrupt occurred afterwards.
2256 */
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002257 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 {
2259 switch (cstack->cs_pending[idx])
2260 {
2261 case CSTP_NONE:
2262 break;
2263
2264 case CSTP_CONTINUE:
2265 case CSTP_BREAK:
2266 case CSTP_FINISH:
2267 report_discard_pending(cstack->cs_pending[idx], NULL);
2268 cstack->cs_pending[idx] = CSTP_NONE;
2269 break;
2270
2271 case CSTP_RETURN:
2272 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002273 cstack->cs_rettv[idx]);
2274 discard_pending_return(cstack->cs_rettv[idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 cstack->cs_pending[idx] = CSTP_NONE;
2276 break;
2277
2278 default:
2279 if (cstack->cs_flags[idx] & CSF_FINALLY)
2280 {
2281 if (cstack->cs_pending[idx] & CSTP_THROW)
2282 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002283 // Cancel the pending exception. This is in the
2284 // finally clause, so that the stack of the
2285 // caught exceptions is not involved.
Bram Moolenaar13656f02020-12-19 17:55:54 +01002286 discard_exception(
2287 (except_T *)cstack->cs_exception[idx],
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 FALSE);
2289 }
2290 else
2291 report_discard_pending(cstack->cs_pending[idx],
2292 NULL);
2293 cstack->cs_pending[idx] = CSTP_NONE;
2294 }
2295 break;
2296 }
2297 }
2298
2299 /*
2300 * Stop at a try conditional not in its finally clause. If this try
2301 * conditional is in an active catch clause, finish the caught
2302 * exception.
2303 */
2304 if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2305 {
2306 if ((cstack->cs_flags[idx] & CSF_ACTIVE)
2307 && (cstack->cs_flags[idx] & CSF_CAUGHT))
2308 finish_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002309 // Stop at this try conditional - except the try block never
2310 // got active (because of an inactive surrounding conditional
2311 // or when the ":try" appeared after an error or interrupt or
2312 // throw).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002313 if (cstack->cs_flags[idx] & CSF_TRUE)
2314 {
2315 if (searched_cond == 0 && !inclusive)
2316 break;
2317 stop = TRUE;
2318 }
2319 }
2320 }
2321
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002322 // Stop on the searched conditional type (even when the surrounding
2323 // conditional is not active or something has been made pending).
2324 // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2325 // check first whether "emsg_silent" needs to be restored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002326 if (cstack->cs_flags[idx] & searched_cond)
2327 {
2328 if (!inclusive)
2329 break;
2330 stop = TRUE;
2331 }
2332 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2333 if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2334 break;
2335
2336 /*
Bram Moolenaarccc18222007-05-10 18:25:20 +00002337 * When leaving a try conditional that reset "emsg_silent" on its
2338 * entry after saving the original value, restore that value here and
2339 * free the memory used to store it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 */
2341 if ((cstack->cs_flags[idx] & CSF_TRY)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002342 && (cstack->cs_flags[idx] & CSF_SILENT))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002343 {
2344 eslist_T *elem;
2345
2346 elem = cstack->cs_emsg_silent_list;
2347 cstack->cs_emsg_silent_list = elem->next;
2348 emsg_silent = elem->saved_emsg_silent;
2349 vim_free(elem);
2350 cstack->cs_flags[idx] &= ~CSF_SILENT;
2351 }
2352 if (stop)
2353 break;
2354 }
2355 return idx;
2356}
2357
2358/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002359 * Return an appropriate error message for a missing endwhile/endfor/endif.
2360 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002361 static char *
Bram Moolenaarddef1292019-12-16 17:10:33 +01002362get_end_emsg(cstack_T *cstack)
Bram Moolenaar12805862005-01-05 22:16:17 +00002363{
2364 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002365 return _(e_endwhile);
Bram Moolenaar12805862005-01-05 22:16:17 +00002366 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002367 return _(e_endfor);
2368 return _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00002369}
2370
2371
2372/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373 * Rewind conditionals until index "idx" is reached. "cond_type" and
2374 * "cond_level" specify a conditional type and the address of a level variable
2375 * which is to be decremented with each skipped conditional of the specified
2376 * type.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002377 * Also free "for info" structures where needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002379 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002380rewind_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002381 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002382 int idx,
2383 int cond_type,
2384 int *cond_level)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385{
2386 while (cstack->cs_idx > idx)
2387 {
2388 if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2389 --*cond_level;
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002390 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2391 free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002392 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 }
2394}
2395
2396/*
2397 * ":endfunction" when not after a ":function"
2398 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 void
Bram Moolenaar6e949782020-04-13 17:21:00 +02002400ex_endfunction(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401{
Bram Moolenaar6e949782020-04-13 17:21:00 +02002402 if (eap->cmdidx == CMD_enddef)
2403 emsg(_("E193: :enddef not inside a function"));
2404 else
2405 emsg(_("E193: :endfunction not inside a function"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406}
2407
2408/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002409 * Return TRUE if the string "p" looks like a ":while" or ":for" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002410 */
2411 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002412has_loop_cmd(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002413{
Bram Moolenaared53fb92007-11-24 20:50:24 +00002414 int len;
2415
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002416 // skip modifiers, white space and ':'
Bram Moolenaared53fb92007-11-24 20:50:24 +00002417 for (;;)
2418 {
2419 while (*p == ' ' || *p == '\t' || *p == ':')
2420 ++p;
2421 len = modifier_len(p);
2422 if (len == 0)
2423 break;
2424 p += len;
2425 }
Bram Moolenaar12805862005-01-05 22:16:17 +00002426 if ((p[0] == 'w' && p[1] == 'h')
2427 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 return TRUE;
2429 return FALSE;
2430}
2431
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002432#endif // FEAT_EVAL