blob: baf5de3419d3e86dd2f77e0d7ae1eda3bf3ac7bd [file] [log] [blame]
Bram Moolenaaredf3f972016-08-29 22:49:24 +02001/* vi:set ts=8 sts=4 sw=4 noet:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10/*
11 * ex_eval.c: functions for Ex command line for the +eval feature.
12 */
13
14#include "vim.h"
15
16#if defined(FEAT_EVAL) || defined(PROTO)
17
Bram Moolenaarddef1292019-12-16 17:10:33 +010018static char *get_end_emsg(cstack_T *cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +000019
20/*
21 * Exception handling terms:
22 *
23 * :try ":try" command \
24 * ... try block |
25 * :catch RE ":catch" command |
26 * ... catch clause |- try conditional
27 * :finally ":finally" command |
28 * ... finally clause |
29 * :endtry ":endtry" command /
30 *
31 * The try conditional may have any number of catch clauses and at most one
32 * finally clause. A ":throw" command can be inside the try block, a catch
33 * clause, the finally clause, or in a function called or script sourced from
34 * there or even outside the try conditional. Try conditionals may be nested.
35 */
36
37/*
38 * Configuration whether an exception is thrown on error or interrupt. When
39 * the preprocessor macros below evaluate to FALSE, an error (did_emsg) or
40 * interrupt (got_int) under an active try conditional terminates the script
41 * after the non-active finally clauses of all active try conditionals have been
42 * executed. Otherwise, errors and/or interrupts are converted into catchable
43 * exceptions (did_throw additionally set), which terminate the script only if
44 * not caught. For user exceptions, only did_throw is set. (Note: got_int can
Bram Moolenaar84a05ac2013-05-06 04:24:17 +020045 * be set asynchronously afterwards by a SIGINT, so did_throw && got_int is not
Bram Moolenaar071d4272004-06-13 20:20:40 +000046 * a reliant test that the exception currently being thrown is an interrupt
47 * exception. Similarly, did_emsg can be set afterwards on an error in an
48 * (unskipped) conditional command inside an inactive conditional, so did_throw
49 * && did_emsg is not a reliant test that the exception currently being thrown
50 * is an error exception.) - The macros can be defined as expressions checking
51 * for a variable that is allowed to be changed during execution of a script.
52 */
53#if 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +010054// Expressions used for testing during the development phase.
Bram Moolenaar071d4272004-06-13 20:20:40 +000055# define THROW_ON_ERROR (!eval_to_number("$VIMNOERRTHROW"))
56# define THROW_ON_INTERRUPT (!eval_to_number("$VIMNOINTTHROW"))
57# define THROW_TEST
58#else
Bram Moolenaar217e1b82019-12-01 21:41:28 +010059// Values used for the Vim release.
Bram Moolenaar071d4272004-06-13 20:20:40 +000060# define THROW_ON_ERROR TRUE
Bram Moolenaaraf0167f2009-05-16 15:31:32 +000061# define THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +000062# define THROW_ON_INTERRUPT TRUE
Bram Moolenaaraf0167f2009-05-16 15:31:32 +000063# define THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +000064#endif
65
Bram Moolenaar071d4272004-06-13 20:20:40 +000066/*
67 * When several errors appear in a row, setting "force_abort" is delayed until
68 * the failing command returned. "cause_abort" is set to TRUE meanwhile, in
69 * order to indicate that situation. This is useful when "force_abort" was set
70 * during execution of a function call from an expression: the aborting of the
71 * expression evaluation is done without producing any error messages, but all
72 * error messages on parsing errors during the expression evaluation are given
73 * (even if a try conditional is active).
74 */
75static int cause_abort = FALSE;
76
77/*
Bram Moolenaarccc18222007-05-10 18:25:20 +000078 * Return TRUE when immediately aborting on error, or when an interrupt
Bram Moolenaar071d4272004-06-13 20:20:40 +000079 * occurred or an exception was thrown but not caught. Use for ":{range}call"
80 * to check whether an aborted function that does not handle a range itself
81 * should be called again for the next line in the range. Also used for
82 * cancelling expression evaluation after a function call caused an immediate
83 * abort. Note that the first emsg() call temporarily resets "force_abort"
84 * until the throw point for error messages has been reached. That is, during
85 * cancellation of an expression evaluation after an aborting function call or
86 * due to a parsing error, aborting() always returns the same value.
Bram Moolenaar67a2deb2019-11-25 00:05:32 +010087 * "got_int" is also set by calling interrupt().
Bram Moolenaar071d4272004-06-13 20:20:40 +000088 */
89 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010090aborting(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +000091{
92 return (did_emsg && force_abort) || got_int || did_throw;
93}
94
95/*
96 * The value of "force_abort" is temporarily reset by the first emsg() call
97 * during an expression evaluation, and "cause_abort" is used instead. It might
98 * be necessary to restore "force_abort" even before the throw point for the
99 * error message has been reached. update_force_abort() should be called then.
100 */
101 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100102update_force_abort(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000103{
104 if (cause_abort)
105 force_abort = TRUE;
106}
107
108/*
109 * Return TRUE if a command with a subcommand resulting in "retcode" should
110 * abort the script processing. Can be used to suppress an autocommand after
111 * execution of a failing subcommand as long as the error message has not been
112 * displayed and actually caused the abortion.
113 */
114 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100115should_abort(int retcode)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000116{
117 return ((retcode == FAIL && trylevel != 0 && !emsg_silent) || aborting());
118}
119
120/*
121 * Return TRUE if a function with the "abort" flag should not be considered
122 * ended on an error. This means that parsing commands is continued in order
123 * to find finally clauses to be executed, and that some errors in skipped
124 * commands are still reported.
125 */
126 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100127aborted_in_try(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000128{
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100129 // This function is only called after an error. In this case, "force_abort"
130 // determines whether searching for finally clauses is necessary.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131 return force_abort;
132}
133
134/*
135 * cause_errthrow(): Cause a throw of an error exception if appropriate.
136 * Return TRUE if the error message should not be displayed by emsg().
137 * Sets "ignore", if the emsg() call should be ignored completely.
138 *
139 * When several messages appear in the same command, the first is usually the
140 * most specific one and used as the exception value. The "severe" flag can be
141 * set to TRUE, if a later but severer message should be used instead.
142 */
143 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100144cause_errthrow(
145 char_u *mesg,
146 int severe,
147 int *ignore)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148{
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200149 msglist_T *elem;
150 msglist_T **plist;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000151
152 /*
Bram Moolenaar57657d82006-04-21 22:12:41 +0000153 * Do nothing when displaying the interrupt message or reporting an
154 * uncaught exception (which has already been discarded then) at the top
155 * level. Also when no exception can be thrown. The message will be
156 * displayed by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +0000157 */
158 if (suppress_errthrow)
159 return FALSE;
160
161 /*
Bram Moolenaar57657d82006-04-21 22:12:41 +0000162 * If emsg() has not been called previously, temporarily reset
163 * "force_abort" until the throw point for error messages has been
164 * reached. This ensures that aborting() returns the same value for all
165 * errors that appear in the same command. This means particularly that
166 * for parsing errors during expression evaluation emsg() will be called
167 * multiply, even when the expression is evaluated from a finally clause
168 * that was activated due to an aborting error, interrupt, or exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000169 */
170 if (!did_emsg)
171 {
172 cause_abort = force_abort;
173 force_abort = FALSE;
174 }
175
176 /*
177 * If no try conditional is active and no exception is being thrown and
178 * there has not been an error in a try conditional or a throw so far, do
Bram Moolenaar57657d82006-04-21 22:12:41 +0000179 * nothing (for compatibility of non-EH scripts). The message will then
180 * be displayed by emsg(). When ":silent!" was used and we are not
181 * currently throwing an exception, do nothing. The message text will
182 * then be stored to v:errmsg by emsg() without displaying it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000183 */
184 if (((trylevel == 0 && !cause_abort) || emsg_silent) && !did_throw)
185 return FALSE;
186
187 /*
188 * Ignore an interrupt message when inside a try conditional or when an
Bram Moolenaar57657d82006-04-21 22:12:41 +0000189 * exception is being thrown or when an error in a try conditional or
190 * throw has been detected previously. This is important in order that an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000191 * interrupt exception is catchable by the innermost try conditional and
192 * not replaced by an interrupt message error exception.
193 */
194 if (mesg == (char_u *)_(e_interr))
195 {
196 *ignore = TRUE;
197 return TRUE;
198 }
199
200 /*
201 * Ensure that all commands in nested function calls and sourced files
202 * are aborted immediately.
203 */
204 cause_abort = TRUE;
205
206 /*
207 * When an exception is being thrown, some commands (like conditionals) are
208 * not skipped. Errors in those commands may affect what of the subsequent
209 * commands are regarded part of catch and finally clauses. Catching the
210 * exception would then cause execution of commands not intended by the
211 * user, who wouldn't even get aware of the problem. Therefor, discard the
212 * exception currently being thrown to prevent it from being caught. Just
213 * execute finally clauses and terminate.
214 */
215 if (did_throw)
216 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100217 // When discarding an interrupt exception, reset got_int to prevent the
218 // same interrupt being converted to an exception again and discarding
219 // the error exception we are about to throw here.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220 if (current_exception->type == ET_INTERRUPT)
221 got_int = FALSE;
222 discard_current_exception();
223 }
224
225#ifdef THROW_TEST
226 if (!THROW_ON_ERROR)
227 {
228 /*
229 * Print error message immediately without searching for a matching
230 * catch clause; just finally clauses are executed before the script
231 * is terminated.
232 */
233 return FALSE;
234 }
235 else
236#endif
237 {
238 /*
239 * Prepare the throw of an error exception, so that everything will
240 * be aborted (except for executing finally clauses), until the error
241 * exception is caught; if still uncaught at the top level, the error
242 * message will be displayed and the script processing terminated
243 * then. - This function has no access to the conditional stack.
244 * Thus, the actual throw is made after the failing command has
245 * returned. - Throw only the first of several errors in a row, except
246 * a severe error is following.
247 */
248 if (msg_list != NULL)
249 {
250 plist = msg_list;
251 while (*plist != NULL)
252 plist = &(*plist)->next;
253
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200254 elem = ALLOC_CLEAR_ONE(msglist_T);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255 if (elem == NULL)
256 {
257 suppress_errthrow = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100258 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259 }
260 else
261 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100262 elem->msg = (char *)vim_strsave(mesg);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000263 if (elem->msg == NULL)
264 {
265 vim_free(elem);
266 suppress_errthrow = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100267 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268 }
269 else
270 {
271 elem->next = NULL;
272 elem->throw_msg = NULL;
273 *plist = elem;
274 if (plist == msg_list || severe)
275 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100276 char *tmsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100278 // Skip the extra "Vim " prefix for message "E458".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 tmsg = elem->msg;
280 if (STRNCMP(tmsg, "Vim E", 5) == 0
281 && VIM_ISDIGIT(tmsg[5])
282 && VIM_ISDIGIT(tmsg[6])
283 && VIM_ISDIGIT(tmsg[7])
284 && tmsg[8] == ':'
285 && tmsg[9] == ' ')
286 (*msg_list)->throw_msg = &tmsg[4];
287 else
288 (*msg_list)->throw_msg = tmsg;
289 }
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200290
291 // Get the source name and lnum now, it may change before
292 // reaching do_errthrow().
Bram Moolenaar4f25b1a2020-09-10 19:25:05 +0200293 elem->sfile = estack_sfile(ESTACK_NONE);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200294 elem->slnum = SOURCING_LNUM;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 }
296 }
297 }
298 return TRUE;
299 }
300}
301
302/*
303 * Free a "msg_list" and the messages it contains.
304 */
305 static void
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200306free_msglist(msglist_T *l)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000307{
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200308 msglist_T *messages, *next;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000309
310 messages = l;
311 while (messages != NULL)
312 {
313 next = messages->next;
314 vim_free(messages->msg);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200315 vim_free(messages->sfile);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000316 vim_free(messages);
317 messages = next;
318 }
319}
320
321/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100322 * Free global "*msg_list" and the messages it contains, then set "*msg_list"
323 * to NULL.
324 */
325 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100326free_global_msglist(void)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100327{
328 free_msglist(*msg_list);
329 *msg_list = NULL;
330}
331
332/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 * Throw the message specified in the call to cause_errthrow() above as an
334 * error exception. If cstack is NULL, postpone the throw until do_cmdline()
335 * has returned (see do_one_cmd()).
336 */
337 void
Bram Moolenaarddef1292019-12-16 17:10:33 +0100338do_errthrow(cstack_T *cstack, char_u *cmdname)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000339{
340 /*
341 * Ensure that all commands in nested function calls and sourced files
342 * are aborted immediately.
343 */
344 if (cause_abort)
345 {
346 cause_abort = FALSE;
347 force_abort = TRUE;
348 }
349
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100350 // If no exception is to be thrown or the conversion should be done after
351 // returning to a previous invocation of do_one_cmd(), do nothing.
Bram Moolenaar4632d292006-11-28 17:36:37 +0000352 if (msg_list == NULL || *msg_list == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000353 return;
354
355 if (throw_exception(*msg_list, ET_ERROR, cmdname) == FAIL)
356 free_msglist(*msg_list);
357 else
358 {
359 if (cstack != NULL)
360 do_throw(cstack);
361 else
362 need_rethrow = TRUE;
363 }
364 *msg_list = NULL;
365}
366
367/*
368 * do_intthrow(): Replace the current exception by an interrupt or interrupt
369 * exception if appropriate. Return TRUE if the current exception is discarded,
370 * FALSE otherwise.
371 */
372 int
Bram Moolenaarddef1292019-12-16 17:10:33 +0100373do_intthrow(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000374{
375 /*
376 * If no interrupt occurred or no try conditional is active and no exception
377 * is being thrown, do nothing (for compatibility of non-EH scripts).
378 */
379 if (!got_int || (trylevel == 0 && !did_throw))
380 return FALSE;
381
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100382#ifdef THROW_TEST // avoid warning for condition always true
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383 if (!THROW_ON_INTERRUPT)
384 {
385 /*
386 * The interrupt aborts everything except for executing finally clauses.
387 * Discard any user or error or interrupt exception currently being
388 * thrown.
389 */
390 if (did_throw)
391 discard_current_exception();
392 }
393 else
394#endif
395 {
396 /*
397 * Throw an interrupt exception, so that everything will be aborted
398 * (except for executing finally clauses), until the interrupt exception
399 * is caught; if still uncaught at the top level, the script processing
400 * will be terminated then. - If an interrupt exception is already
401 * being thrown, do nothing.
402 *
403 */
404 if (did_throw)
405 {
406 if (current_exception->type == ET_INTERRUPT)
407 return FALSE;
408
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100409 // An interrupt exception replaces any user or error exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000410 discard_current_exception();
411 }
412 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) != FAIL)
413 do_throw(cstack);
414 }
415
416 return TRUE;
417}
418
Bram Moolenaar071d4272004-06-13 20:20:40 +0000419/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100420 * Get an exception message that is to be stored in current_exception->value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100422 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100423get_exception_string(
424 void *value,
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100425 except_type_T type,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100426 char_u *cmdname,
427 int *should_free)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100429 char *ret;
430 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000431 int cmdlen;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100432 char *p, *val;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433
434 if (type == ET_ERROR)
435 {
Bram Moolenaar9ef00be2016-03-06 14:58:28 +0100436 *should_free = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200437 mesg = ((msglist_T *)value)->throw_msg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438 if (cmdname != NULL && *cmdname != NUL)
439 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000440 cmdlen = (int)STRLEN(cmdname);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100441 ret = (char *)vim_strnsave((char_u *)"Vim(",
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200442 4 + cmdlen + 2 + STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100443 if (ret == NULL)
444 return ret;
445 STRCPY(&ret[4], cmdname);
446 STRCPY(&ret[4 + cmdlen], "):");
447 val = ret + 4 + cmdlen + 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000448 }
449 else
450 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200451 ret = (char *)vim_strnsave((char_u *)"Vim:", 4 + STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100452 if (ret == NULL)
453 return ret;
454 val = ret + 4;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000455 }
456
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100457 // msg_add_fname may have been used to prefix the message with a file
458 // name in quotes. In the exception value, put the file name in
459 // parentheses and move it to the end.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000460 for (p = mesg; ; p++)
461 {
462 if (*p == NUL
463 || (*p == 'E'
464 && VIM_ISDIGIT(p[1])
465 && (p[2] == ':'
466 || (VIM_ISDIGIT(p[2])
467 && (p[3] == ':'
468 || (VIM_ISDIGIT(p[3])
469 && p[4] == ':'))))))
470 {
Bram Moolenaar051b7822005-05-19 21:00:46 +0000471 if (*p == NUL || p == mesg)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100472 STRCAT(val, mesg); // 'E123' missing or at beginning
Bram Moolenaar071d4272004-06-13 20:20:40 +0000473 else
474 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100475 // '"filename" E123: message text'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000476 if (mesg[0] != '"' || p-2 < &mesg[1] ||
477 p[-2] != '"' || p[-1] != ' ')
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100478 // "E123:" is part of the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479 continue;
480
481 STRCAT(val, p);
482 p[-2] = NUL;
483 sprintf((char *)(val + STRLEN(p)), " (%s)", &mesg[1]);
484 p[-2] = '"';
485 }
486 break;
487 }
488 }
489 }
490 else
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100491 {
492 *should_free = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100493 ret = value;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100494 }
495
496 return ret;
497}
498
499
500/*
501 * Throw a new exception. Return FAIL when out of memory or it was tried to
502 * throw an illegal user exception. "value" is the exception string for a
503 * user or interrupt exception, or points to a message list in case of an
504 * error exception.
505 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100506 int
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100507throw_exception(void *value, except_type_T type, char_u *cmdname)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100508{
509 except_T *excp;
510 int should_free;
511
512 /*
513 * Disallow faking Interrupt or error exceptions as user exceptions. They
514 * would be treated differently from real interrupt or error exceptions
515 * when no active try block is found, see do_cmdline().
516 */
517 if (type == ET_USER)
518 {
519 if (STRNCMP((char_u *)value, "Vim", 3) == 0
520 && (((char_u *)value)[3] == NUL || ((char_u *)value)[3] == ':'
521 || ((char_u *)value)[3] == '('))
522 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100523 emsg(_("E608: Cannot :throw exceptions with 'Vim' prefix"));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100524 goto fail;
525 }
526 }
527
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200528 excp = ALLOC_ONE(except_T);
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100529 if (excp == NULL)
530 goto nomem;
531
532 if (type == ET_ERROR)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100533 // Store the original message and prefix the exception value with
534 // "Vim:" or, if a command name is given, "Vim(cmdname):".
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200535 excp->messages = (msglist_T *)value;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100536
537 excp->value = get_exception_string(value, type, cmdname, &should_free);
538 if (excp->value == NULL && should_free)
539 goto nomem;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000540
541 excp->type = type;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200542 if (type == ET_ERROR && ((msglist_T *)value)->sfile != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200544 msglist_T *entry = (msglist_T *)value;
545
546 excp->throw_name = entry->sfile;
547 entry->sfile = NULL;
548 excp->throw_lnum = entry->slnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000549 }
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200550 else
551 {
Bram Moolenaar4f25b1a2020-09-10 19:25:05 +0200552 excp->throw_name = estack_sfile(ESTACK_NONE);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200553 if (excp->throw_name == NULL)
554 excp->throw_name = vim_strsave((char_u *)"");
555 if (excp->throw_name == NULL)
556 {
557 if (should_free)
558 vim_free(excp->value);
559 goto nomem;
560 }
561 excp->throw_lnum = SOURCING_LNUM;
562 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563
564 if (p_verbose >= 13 || debug_break_level > 0)
565 {
566 int save_msg_silent = msg_silent;
567
568 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100569 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000570 else
571 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000572 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000573 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100574 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000575
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100576 smsg(_("Exception thrown: %s"), excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100577 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000578
579 if (debug_break_level > 0 || *p_vfile == NUL)
580 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000581 --no_wait_return;
582 if (debug_break_level > 0)
583 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000584 else
585 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000586 }
587
588 current_exception = excp;
589 return OK;
590
591nomem:
592 vim_free(excp);
593 suppress_errthrow = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100594 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595fail:
596 current_exception = NULL;
597 return FAIL;
598}
599
600/*
601 * Discard an exception. "was_finished" is set when the exception has been
602 * caught and the catch clause has been ended normally.
603 */
604 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100605discard_exception(except_T *excp, int was_finished)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000606{
607 char_u *saved_IObuff;
608
609 if (excp == NULL)
610 {
Bram Moolenaar95f09602016-11-10 20:01:45 +0100611 internal_error("discard_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 return;
613 }
614
615 if (p_verbose >= 13 || debug_break_level > 0)
616 {
617 int save_msg_silent = msg_silent;
618
619 saved_IObuff = vim_strsave(IObuff);
620 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100621 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000622 else
623 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000624 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000625 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100626 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar051b7822005-05-19 21:00:46 +0000627 smsg(was_finished
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100628 ? _("Exception finished: %s")
629 : _("Exception discarded: %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630 excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100631 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000632 if (debug_break_level > 0 || *p_vfile == NUL)
633 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634 --no_wait_return;
635 if (debug_break_level > 0)
636 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000637 else
638 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000639 STRCPY(IObuff, saved_IObuff);
640 vim_free(saved_IObuff);
641 }
642 if (excp->type != ET_INTERRUPT)
643 vim_free(excp->value);
644 if (excp->type == ET_ERROR)
645 free_msglist(excp->messages);
646 vim_free(excp->throw_name);
647 vim_free(excp);
648}
649
650/*
651 * Discard the exception currently being thrown.
652 */
653 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100654discard_current_exception(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000655{
Bram Moolenaarcae24be2017-07-10 22:12:10 +0200656 if (current_exception != NULL)
657 {
658 discard_exception(current_exception, FALSE);
659 current_exception = NULL;
660 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 did_throw = FALSE;
662 need_rethrow = FALSE;
663}
664
665/*
666 * Put an exception on the caught stack.
667 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100668 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100669catch_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670{
671 excp->caught = caught_stack;
672 caught_stack = excp;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100673 set_vim_var_string(VV_EXCEPTION, (char_u *)excp->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 if (*excp->throw_name != NUL)
675 {
676 if (excp->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000677 vim_snprintf((char *)IObuff, IOSIZE, _("%s, line %ld"),
678 excp->throw_name, (long)excp->throw_lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000680 vim_snprintf((char *)IObuff, IOSIZE, "%s", excp->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
682 }
683 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100684 // throw_name not set on an exception from a command that was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 set_vim_var_string(VV_THROWPOINT, NULL, -1);
686
687 if (p_verbose >= 13 || debug_break_level > 0)
688 {
689 int save_msg_silent = msg_silent;
690
691 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100692 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000693 else
694 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000696 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100697 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000698
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100699 smsg(_("Exception caught: %s"), excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100700 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000701
702 if (debug_break_level > 0 || *p_vfile == NUL)
703 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704 --no_wait_return;
705 if (debug_break_level > 0)
706 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000707 else
708 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 }
710}
711
712/*
713 * Remove an exception from the caught stack.
714 */
715 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100716finish_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717{
718 if (excp != caught_stack)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100719 internal_error("finish_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 caught_stack = caught_stack->caught;
721 if (caught_stack != NULL)
722 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100723 set_vim_var_string(VV_EXCEPTION, (char_u *)caught_stack->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724 if (*caught_stack->throw_name != NUL)
725 {
726 if (caught_stack->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000727 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 _("%s, line %ld"), caught_stack->throw_name,
729 (long)caught_stack->throw_lnum);
730 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000731 vim_snprintf((char *)IObuff, IOSIZE, "%s",
732 caught_stack->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
734 }
735 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100736 // throw_name not set on an exception from a command that was
737 // typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 set_vim_var_string(VV_THROWPOINT, NULL, -1);
739 }
740 else
741 {
742 set_vim_var_string(VV_EXCEPTION, NULL, -1);
743 set_vim_var_string(VV_THROWPOINT, NULL, -1);
744 }
745
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100746 // Discard the exception, but use the finish message for 'verbose'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747 discard_exception(excp, TRUE);
748}
749
750/*
751 * Flags specifying the message displayed by report_pending.
752 */
753#define RP_MAKE 0
754#define RP_RESUME 1
755#define RP_DISCARD 2
756
757/*
758 * Report information about something pending in a finally clause if required by
759 * the 'verbose' option or when debugging. "action" tells whether something is
760 * made pending or something pending is resumed or discarded. "pending" tells
761 * what is pending. "value" specifies the return value for a pending ":return"
762 * or the exception value for a pending exception.
763 */
764 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100765report_pending(int action, int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100767 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 char *s;
769 int save_msg_silent;
770
771
772 switch (action)
773 {
774 case RP_MAKE:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100775 mesg = _("%s made pending");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 break;
777 case RP_RESUME:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100778 mesg = _("%s resumed");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100780 // case RP_DISCARD:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 default:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100782 mesg = _("%s discarded");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 break;
784 }
785
786 switch (pending)
787 {
788 case CSTP_NONE:
789 return;
790
791 case CSTP_CONTINUE:
792 s = ":continue";
793 break;
794 case CSTP_BREAK:
795 s = ":break";
796 break;
797 case CSTP_FINISH:
798 s = ":finish";
799 break;
800 case CSTP_RETURN:
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100801 // ":return" command producing value, allocated
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 s = (char *)get_return_cmd(value);
803 break;
804
805 default:
806 if (pending & CSTP_THROW)
807 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100808 vim_snprintf((char *)IObuff, IOSIZE, mesg, _("Exception"));
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200809 mesg = (char *)vim_strnsave(IObuff, STRLEN(IObuff) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 STRCAT(mesg, ": %s");
811 s = (char *)((except_T *)value)->value;
812 }
813 else if ((pending & CSTP_ERROR) && (pending & CSTP_INTERRUPT))
814 s = _("Error and interrupt");
815 else if (pending & CSTP_ERROR)
816 s = _("Error");
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100817 else // if (pending & CSTP_INTERRUPT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 s = _("Interrupt");
819 }
820
821 save_msg_silent = msg_silent;
822 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100823 msg_silent = FALSE; // display messages
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824 ++no_wait_return;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100825 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100826 smsg(mesg, s);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100827 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 cmdline_row = msg_row;
829 --no_wait_return;
830 if (debug_break_level > 0)
831 msg_silent = save_msg_silent;
832
833 if (pending == CSTP_RETURN)
834 vim_free(s);
835 else if (pending & CSTP_THROW)
836 vim_free(mesg);
837}
838
839/*
840 * If something is made pending in a finally clause, report it if required by
841 * the 'verbose' option or when debugging.
842 */
843 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100844report_make_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845{
846 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000847 {
848 if (debug_break_level <= 0)
849 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 report_pending(RP_MAKE, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000851 if (debug_break_level <= 0)
852 verbose_leave();
853 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854}
855
856/*
857 * If something pending in a finally clause is resumed at the ":endtry", report
858 * it if required by the 'verbose' option or when debugging.
859 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200860 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100861report_resume_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862{
863 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000864 {
865 if (debug_break_level <= 0)
866 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 report_pending(RP_RESUME, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000868 if (debug_break_level <= 0)
869 verbose_leave();
870 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871}
872
873/*
874 * If something pending in a finally clause is discarded, report it if required
875 * by the 'verbose' option or when debugging.
876 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200877 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100878report_discard_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879{
880 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000881 {
882 if (debug_break_level <= 0)
883 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884 report_pending(RP_DISCARD, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000885 if (debug_break_level <= 0)
886 verbose_leave();
887 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888}
889
890
891/*
Bram Moolenaar25e42232019-08-04 15:04:10 +0200892 * ":eval".
893 */
894 void
895ex_eval(exarg_T *eap)
896{
897 typval_T tv;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200898 evalarg_T evalarg;
Bram Moolenaar25e42232019-08-04 15:04:10 +0200899
Bram Moolenaare6b53242020-07-01 17:28:33 +0200900 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200901
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200902 if (eval0(eap->arg, &tv, eap, &evalarg) == OK)
Bram Moolenaar25e42232019-08-04 15:04:10 +0200903 clear_tv(&tv);
Bram Moolenaarb7a78f72020-06-28 18:43:40 +0200904
905 clear_evalarg(&evalarg, eap);
Bram Moolenaar25e42232019-08-04 15:04:10 +0200906}
907
908/*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200909 * Start a new scope/block. Caller should have checked that cs_idx is not
910 * exceeding CSTACK_LEN.
911 */
912 static void
913enter_block(cstack_T *cstack)
914{
915 ++cstack->cs_idx;
916 if (in_vim9script())
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200917 {
918 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
919
920 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
921 cstack->cs_block_id[cstack->cs_idx] = ++si->sn_current_block_id;
922 }
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 Moolenaarfcdc5d82020-10-10 19:07:09 +0200932
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200933 for (i = cstack->cs_script_var_len[cstack->cs_idx];
Bram Moolenaard7475482020-10-10 20:31:37 +0200934 i < si->sn_var_vals.ga_len; ++i)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200935 {
936 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
Bram Moolenaard7475482020-10-10 20:31:37 +0200937
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200938 if (sv->sv_name != NULL)
939 // Remove a variable declared inside the block, if it still
940 // exists, from sn_vars and move the value into sn_all_vars.
941 hide_script_var(si, sv);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200942 }
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200943
944 // TODO: is this needed?
945 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200946 }
947 --cstack->cs_idx;
948}
949
950/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000951 * ":if".
952 */
953 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100954ex_if(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000955{
956 int error;
957 int skip;
958 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +0100959 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000960
961 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +0200962 eap->errmsg = _("E579: :if nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000963 else
964 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200965 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000966 cstack->cs_flags[cstack->cs_idx] = 0;
967
968 /*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200969 * Don't do something after an error, interrupt, or throw, or when
970 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971 */
972 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
973 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
974
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200975 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000976
977 if (!skip && !error)
978 {
979 if (result)
980 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
981 }
982 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100983 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +0000984 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
985 }
986}
987
988/*
989 * ":endif".
990 */
991 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100992ex_endif(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000993{
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200994 cstack_T *cstack = eap->cstack;
995
Bram Moolenaar071d4272004-06-13 20:20:40 +0000996 did_endif = TRUE;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200997 if (cstack->cs_idx < 0
998 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +0200999 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001000 eap->errmsg = _(e_endif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001001 else
1002 {
1003 /*
1004 * When debugging or a breakpoint was encountered, display the debug
1005 * prompt (if not already done). This shows the user that an ":endif"
1006 * is executed when the ":if" or a previous ":elseif" was not TRUE.
1007 * Handle a ">quit" debug command as if an interrupt had occurred before
1008 * the ":endif". That is, throw an interrupt exception if appropriate.
1009 * Doing this here prevents an exception for a parsing error being
1010 * discarded by throwing the interrupt exception later on.
1011 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001012 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001013 && dbg_check_skipped(eap))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001014 (void)do_intthrow(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001016 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017 }
1018}
1019
1020/*
1021 * ":else" and ":elseif".
1022 */
1023 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001024ex_else(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001025{
1026 int error;
1027 int skip;
1028 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001029 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001030
1031 /*
1032 * Don't do something after an error, interrupt, or throw, or when there is
1033 * a surrounding conditional and it was not active.
1034 */
1035 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1036 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1037
1038 if (cstack->cs_idx < 0
Bram Moolenaar12805862005-01-05 22:16:17 +00001039 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001040 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001041 {
1042 if (eap->cmdidx == CMD_else)
1043 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001044 eap->errmsg = _(e_else_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001045 return;
1046 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001047 eap->errmsg = _(e_elseif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 skip = TRUE;
1049 }
1050 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
1051 {
1052 if (eap->cmdidx == CMD_else)
1053 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001054 eap->errmsg = _("E583: multiple :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 return;
1056 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001057 eap->errmsg = _("E584: :elseif after :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 skip = TRUE;
1059 }
1060
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001061 // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001062 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
1063 {
1064 if (eap->errmsg == NULL)
1065 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001066 skip = TRUE; // don't evaluate an ":elseif"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001067 }
1068 else
1069 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1070
1071 /*
1072 * When debugging or a breakpoint was encountered, display the debug prompt
1073 * (if not already done). This shows the user that an ":else" or ":elseif"
1074 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle
1075 * a ">quit" debug command as if an interrupt had occurred before the
1076 * ":else" or ":elseif". That is, set "skip" and throw an interrupt
1077 * exception if appropriate. Doing this here prevents that an exception
1078 * for a parsing errors is discarded when throwing the interrupt exception
1079 * later on.
1080 */
1081 if (!skip && dbg_check_skipped(eap) && got_int)
1082 {
1083 (void)do_intthrow(cstack);
1084 skip = TRUE;
1085 }
1086
1087 if (eap->cmdidx == CMD_elseif)
1088 {
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001089 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001090
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001091 // When throwing error exceptions, we want to throw always the first
1092 // of several errors in a row. This is what actually happens when
1093 // a conditional error was detected above and there is another failure
1094 // when parsing the expression. Since the skip flag is set in this
1095 // case, the parsing error will be ignored by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 if (!skip && !error)
1097 {
1098 if (result)
1099 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1100 else
1101 cstack->cs_flags[cstack->cs_idx] = 0;
1102 }
1103 else if (eap->errmsg == NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001104 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1106 }
1107 else
1108 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1109}
1110
1111/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001112 * Handle ":while" and ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001113 */
1114 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001115ex_while(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001116{
1117 int error;
1118 int skip;
1119 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001120 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001121
1122 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001123 eap->errmsg = _("E585: :while/:for nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001124 else
1125 {
1126 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001127 * The loop flag is set when we have jumped back from the matching
1128 * ":endwhile" or ":endfor". When not set, need to initialise this
1129 * cstack entry.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001130 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001131 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001133 enter_block(cstack);
Bram Moolenaar12805862005-01-05 22:16:17 +00001134 ++cstack->cs_looplevel;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001135 cstack->cs_line[cstack->cs_idx] = -1;
1136 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001137 cstack->cs_flags[cstack->cs_idx] =
1138 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001139
1140 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001141 * Don't do something after an error, interrupt, or throw, or when
1142 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001143 */
1144 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1145 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
Bram Moolenaar12805862005-01-05 22:16:17 +00001146 if (eap->cmdidx == CMD_while)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001148 /*
1149 * ":while bool-expr"
1150 */
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001151 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 }
1153 else
1154 {
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001155 void *fi;
1156 evalarg_T evalarg;
1157
1158 CLEAR_FIELD(evalarg);
1159 evalarg.eval_flags = skip ? 0 : EVAL_EVALUATE;
1160 if (getline_equal(eap->getline, eap->cookie, getsourceline))
1161 {
1162 evalarg.eval_getline = eap->getline;
1163 evalarg.eval_cookie = eap->cookie;
1164 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001165
1166 /*
1167 * ":for var in list-expr"
1168 */
1169 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
1170 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001171 // Jumping here from a ":continue" or ":endfor": use the
1172 // previously evaluated list.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001173 fi = cstack->cs_forinfo[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001174 error = FALSE;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001175
1176 // the "in expr" is not used, skip over it
1177 skip_for_lines(fi, &evalarg);
Bram Moolenaar12805862005-01-05 22:16:17 +00001178 }
1179 else
1180 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001181 // Evaluate the argument and get the info in a structure.
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001182 fi = eval_for_line(eap->arg, &error, eap, &evalarg);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001183 cstack->cs_forinfo[cstack->cs_idx] = fi;
Bram Moolenaar12805862005-01-05 22:16:17 +00001184 }
1185
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001186 // use the element at the start of the list and advance
Bram Moolenaar12805862005-01-05 22:16:17 +00001187 if (!error && fi != NULL && !skip)
1188 result = next_for_item(fi, eap->arg);
1189 else
1190 result = FALSE;
1191
1192 if (!result)
1193 {
1194 free_for_info(fi);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001195 cstack->cs_forinfo[cstack->cs_idx] = NULL;
Bram Moolenaar12805862005-01-05 22:16:17 +00001196 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001197 clear_evalarg(&evalarg, eap);
Bram Moolenaar12805862005-01-05 22:16:17 +00001198 }
1199
1200 /*
1201 * If this cstack entry was just initialised and is active, set the
1202 * loop flag, so do_cmdline() will set the line number in cs_line[].
1203 * If executing the command a second time, clear the loop flag.
1204 */
1205 if (!skip && !error && result)
1206 {
1207 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
1208 cstack->cs_lflags ^= CSL_HAD_LOOP;
1209 }
1210 else
1211 {
1212 cstack->cs_lflags &= ~CSL_HAD_LOOP;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001213 // If the ":while" evaluates to FALSE or ":for" is past the end of
1214 // the list, show the debug prompt at the ":endwhile"/":endfor" as
1215 // if there was a ":break" in a ":while"/":for" evaluating to
1216 // TRUE.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001217 if (!skip && !error)
1218 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1219 }
1220 }
1221}
1222
1223/*
1224 * ":continue"
1225 */
1226 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001227ex_continue(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228{
1229 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001230 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231
Bram Moolenaar12805862005-01-05 22:16:17 +00001232 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001233 eap->errmsg = _(e_continue);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234 else
1235 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001236 // Try to find the matching ":while". This might stop at a try
1237 // conditional not in its finally clause (which is then to be executed
1238 // next). Therefor, inactivate all conditionals except the ":while"
1239 // itself (if reached).
Bram Moolenaar12805862005-01-05 22:16:17 +00001240 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001241 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242 {
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001243 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001244
1245 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001246 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001247 * matching ":while".
1248 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001249 cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 }
1251 else
1252 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001253 // If a try conditional not in its finally clause is reached first,
1254 // make the ":continue" pending for execution at the ":endtry".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 cstack->cs_pending[idx] = CSTP_CONTINUE;
1256 report_make_pending(CSTP_CONTINUE, NULL);
1257 }
1258 }
1259}
1260
1261/*
1262 * ":break"
1263 */
1264 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001265ex_break(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001266{
1267 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001268 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001269
Bram Moolenaar12805862005-01-05 22:16:17 +00001270 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001271 eap->errmsg = _(e_break);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 else
1273 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001274 // Inactivate conditionals until the matching ":while" or a try
1275 // conditional not in its finally clause (which is then to be
1276 // executed next) is found. In the latter case, make the ":break"
1277 // pending for execution at the ":endtry".
Bram Moolenaar12805862005-01-05 22:16:17 +00001278 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001279 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001280 {
1281 cstack->cs_pending[idx] = CSTP_BREAK;
1282 report_make_pending(CSTP_BREAK, NULL);
1283 }
1284 }
1285}
1286
1287/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001288 * ":endwhile" and ":endfor"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001289 */
1290 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001291ex_endwhile(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001292{
Bram Moolenaarddef1292019-12-16 17:10:33 +01001293 cstack_T *cstack = eap->cstack;
1294 int idx;
1295 char *err;
1296 int csf;
1297 int fl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001298
Bram Moolenaar12805862005-01-05 22:16:17 +00001299 if (eap->cmdidx == CMD_endwhile)
1300 {
1301 err = e_while;
1302 csf = CSF_WHILE;
1303 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001304 else
1305 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001306 err = e_for;
1307 csf = CSF_FOR;
1308 }
1309
1310 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001311 eap->errmsg = _(err);
Bram Moolenaar12805862005-01-05 22:16:17 +00001312 else
1313 {
1314 fl = cstack->cs_flags[cstack->cs_idx];
1315 if (!(fl & csf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001316 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001317 // If we are in a ":while" or ":for" but used the wrong endloop
1318 // command, do not rewind to the next enclosing ":for"/":while".
Bram Moolenaar12805862005-01-05 22:16:17 +00001319 if (fl & CSF_WHILE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001320 eap->errmsg = _("E732: Using :endfor with :while");
Bram Moolenaar12805862005-01-05 22:16:17 +00001321 else if (fl & CSF_FOR)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001322 eap->errmsg = _("E733: Using :endwhile with :for");
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00001323 }
1324 if (!(fl & (CSF_WHILE | CSF_FOR)))
1325 {
1326 if (!(fl & CSF_TRY))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001327 eap->errmsg = _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00001328 else if (fl & CSF_FINALLY)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001329 eap->errmsg = _(e_endtry);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001330 // Try to find the matching ":while" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001331 for (idx = cstack->cs_idx; idx > 0; --idx)
1332 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001333 fl = cstack->cs_flags[idx];
1334 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001335 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001336 // Give up at a try conditional not in its finally clause.
1337 // Ignore the ":endwhile"/":endfor".
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001338 eap->errmsg = _(err);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 return;
1340 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001341 if (fl & csf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 break;
1343 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001344 // Cleanup and rewind all contained (and unclosed) conditionals.
Bram Moolenaar12805862005-01-05 22:16:17 +00001345 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001346 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1347 }
1348
1349 /*
1350 * When debugging or a breakpoint was encountered, display the debug
1351 * prompt (if not already done). This shows the user that an
Bram Moolenaar12805862005-01-05 22:16:17 +00001352 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
1353 * after a ":break". Handle a ">quit" debug command as if an
1354 * interrupt had occurred before the ":endwhile"/":endfor". That is,
1355 * throw an interrupt exception if appropriate. Doing this here
1356 * prevents that an exception for a parsing error is discarded when
1357 * throwing the interrupt exception later on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 */
1359 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1360 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1361 && dbg_check_skipped(eap))
1362 (void)do_intthrow(cstack);
1363
1364 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001365 * Set loop flag, so do_cmdline() will jump back to the matching
1366 * ":while" or ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001368 cstack->cs_lflags |= CSL_HAD_ENDLOOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001369 }
1370}
1371
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001372/*
1373 * "{" start of a block in Vim9 script
1374 */
1375 void
1376ex_block(exarg_T *eap)
1377{
1378 cstack_T *cstack = eap->cstack;
1379
1380 if (cstack->cs_idx == CSTACK_LEN - 1)
1381 eap->errmsg = _("E579: block nesting too deep");
1382 else
1383 {
1384 enter_block(cstack);
1385 cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE;
1386 }
1387}
1388
1389/*
1390 * "}" end of a block in Vim9 script
1391 */
1392 void
1393ex_endblock(exarg_T *eap)
1394{
1395 cstack_T *cstack = eap->cstack;
1396
1397 if (cstack->cs_idx < 0
1398 || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0)
1399 eap->errmsg = _(e_endblock_without_block);
1400 else
1401 leave_block(cstack);
1402}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403
1404/*
1405 * ":throw expr"
1406 */
1407 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001408ex_throw(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409{
1410 char_u *arg = eap->arg;
1411 char_u *value;
1412
1413 if (*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001414 value = eval_to_string_skip(arg, eap, eap->skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415 else
1416 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001417 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418 value = NULL;
1419 }
1420
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001421 // On error or when an exception is thrown during argument evaluation, do
1422 // not throw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001423 if (!eap->skip && value != NULL)
1424 {
1425 if (throw_exception(value, ET_USER, NULL) == FAIL)
1426 vim_free(value);
1427 else
1428 do_throw(eap->cstack);
1429 }
1430}
1431
1432/*
Bram Moolenaar269ec652004-07-29 08:43:53 +00001433 * Throw the current exception through the specified cstack. Common routine
1434 * for ":throw" (user exception) and error and interrupt exceptions. Also
1435 * used for rethrowing an uncaught exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001436 */
1437 void
Bram Moolenaarddef1292019-12-16 17:10:33 +01001438do_throw(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001439{
1440 int idx;
1441 int inactivate_try = FALSE;
1442
1443 /*
1444 * Cleanup and inactivate up to the next surrounding try conditional that
1445 * is not in its finally clause. Normally, do not inactivate the try
1446 * conditional itself, so that its ACTIVE flag can be tested below. But
1447 * if a previous error or interrupt has not been converted to an exception,
1448 * inactivate the try conditional, too, as if the conversion had been done,
Bram Moolenaar269ec652004-07-29 08:43:53 +00001449 * and reset the did_emsg or got_int flag, so this won't happen again at
1450 * the next surrounding try conditional.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001451 */
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001452#ifndef THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453 if (did_emsg && !THROW_ON_ERROR)
1454 {
1455 inactivate_try = TRUE;
1456 did_emsg = FALSE;
1457 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001458#endif
1459#ifndef THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460 if (got_int && !THROW_ON_INTERRUPT)
1461 {
1462 inactivate_try = TRUE;
1463 got_int = FALSE;
1464 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001465#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001466 idx = cleanup_conditionals(cstack, 0, inactivate_try);
1467 if (idx >= 0)
1468 {
1469 /*
1470 * If this try conditional is active and we are before its first
Bram Moolenaar269ec652004-07-29 08:43:53 +00001471 * ":catch", set THROWN so that the ":catch" commands will check
1472 * whether the exception matches. When the exception came from any of
1473 * the catch clauses, it will be made pending at the ":finally" (if
1474 * present) and rethrown at the ":endtry". This will also happen if
1475 * the try conditional is inactive. This is the case when we are
1476 * throwing an exception due to an error or interrupt on the way from
1477 * a preceding ":continue", ":break", ":return", ":finish", error or
1478 * interrupt (not converted to an exception) to the finally clause or
1479 * from a preceding throw of a user or error or interrupt exception to
1480 * the matching catch clause or the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001481 */
1482 if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1483 {
1484 if (cstack->cs_flags[idx] & CSF_ACTIVE)
1485 cstack->cs_flags[idx] |= CSF_THROWN;
1486 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001487 // THROWN may have already been set for a catchable exception
1488 // that has been discarded. Ensure it is reset for the new
1489 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 cstack->cs_flags[idx] &= ~CSF_THROWN;
1491 }
1492 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1493 cstack->cs_exception[idx] = current_exception;
1494 }
1495#if 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001496 // TODO: Add optimization below. Not yet done because of interface
1497 // problems to eval.c and ex_cmds2.c. (Servatius)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001498 else
1499 {
1500 /*
1501 * There are no catch clauses to check or finally clauses to execute.
1502 * End the current script or function. The exception will be rethrown
1503 * in the caller.
1504 */
1505 if (getline_equal(eap->getline, eap->cookie, get_func_line))
1506 current_funccal->returned = TRUE;
1507 elseif (eap->get_func_line == getsourceline)
1508 ((struct source_cookie *)eap->cookie)->finished = TRUE;
1509 }
1510#endif
1511
1512 did_throw = TRUE;
1513}
1514
1515/*
1516 * ":try"
1517 */
1518 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001519ex_try(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520{
1521 int skip;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001522 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001523
1524 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001525 eap->errmsg = _("E601: :try nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001526 else
1527 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001528 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001529 ++cstack->cs_trylevel;
1530 cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1531 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1532
1533 /*
1534 * Don't do something after an error, interrupt, or throw, or when there
1535 * is a surrounding conditional and it was not active.
1536 */
1537 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1538 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1539
1540 if (!skip)
1541 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001542 // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch"
1543 // commands should check for a match if an exception is thrown and
1544 // that the finally clause needs to be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001545 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1546
1547 /*
1548 * ":silent!", even when used in a try conditional, disables
1549 * displaying of error messages and conversion of errors to
1550 * exceptions. When the silent commands again open a try
1551 * conditional, save "emsg_silent" and reset it so that errors are
1552 * again converted to exceptions. The value is restored when that
1553 * try conditional is left. If it is left normally, the commands
1554 * following the ":endtry" are again silent. If it is left by
1555 * a ":continue", ":break", ":return", or ":finish", the commands
1556 * executed next are again silent. If it is left due to an
1557 * aborting error, an interrupt, or an exception, restoring
1558 * "emsg_silent" does not matter since we are already in the
1559 * aborting state and/or the exception has already been thrown.
1560 * The effect is then just freeing the memory that was allocated
1561 * to save the value.
1562 */
1563 if (emsg_silent)
1564 {
1565 eslist_T *elem;
1566
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001567 elem = ALLOC_ONE(struct eslist_elem);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 if (elem == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001569 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001570 else
1571 {
1572 elem->saved_emsg_silent = emsg_silent;
1573 elem->next = cstack->cs_emsg_silent_list;
1574 cstack->cs_emsg_silent_list = elem;
1575 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1576 emsg_silent = 0;
1577 }
1578 }
1579 }
1580
1581 }
1582}
1583
1584/*
1585 * ":catch /{pattern}/" and ":catch"
1586 */
1587 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001588ex_catch(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589{
1590 int idx = 0;
1591 int give_up = FALSE;
1592 int skip = FALSE;
1593 int caught = FALSE;
1594 char_u *end;
1595 int save_char = 0;
1596 char_u *save_cpo;
1597 regmatch_T regmatch;
1598 int prev_got_int;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001599 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001600 char_u *pat;
1601
1602 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1603 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001604 eap->errmsg = _(e_catch);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001605 give_up = TRUE;
1606 }
1607 else
1608 {
1609 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1610 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001611 // Report what's missing if the matching ":try" is not in its
1612 // finally clause.
Bram Moolenaar12805862005-01-05 22:16:17 +00001613 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001614 skip = TRUE;
1615 }
1616 for (idx = cstack->cs_idx; idx > 0; --idx)
1617 if (cstack->cs_flags[idx] & CSF_TRY)
1618 break;
1619 if (cstack->cs_flags[idx] & CSF_FINALLY)
1620 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001621 // Give up for a ":catch" after ":finally" and ignore it.
1622 // Just parse.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001623 eap->errmsg = _("E604: :catch after :finally");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001624 give_up = TRUE;
1625 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001626 else
Bram Moolenaar12805862005-01-05 22:16:17 +00001627 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1628 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629 }
1630
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001631 if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors
Bram Moolenaar071d4272004-06-13 20:20:40 +00001632 {
1633 pat = (char_u *)".*";
1634 end = NULL;
1635 eap->nextcmd = find_nextcmd(eap->arg);
1636 }
1637 else
1638 {
1639 pat = eap->arg + 1;
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001640 end = skip_regexp_err(pat, *eap->arg, TRUE);
1641 if (end == NULL)
1642 give_up = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643 }
1644
1645 if (!give_up)
1646 {
1647 /*
1648 * Don't do something when no exception has been thrown or when the
1649 * corresponding try block never got active (because of an inactive
1650 * surrounding conditional or after an error or interrupt or throw).
1651 */
1652 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1653 skip = TRUE;
1654
1655 /*
1656 * Check for a match only if an exception is thrown but not caught by
1657 * a previous ":catch". An exception that has replaced a discarded
1658 * exception is not checked (THROWN is not set then).
1659 */
1660 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1661 && !(cstack->cs_flags[idx] & CSF_CAUGHT))
1662 {
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001663 if (end != NULL && *end != NUL
1664 && !ends_excmd2(end, skipwhite(end + 1)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 {
Bram Moolenaar2d06bfd2020-07-23 17:16:18 +02001666 semsg(_(e_trailing_arg), end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 return;
1668 }
1669
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001670 // When debugging or a breakpoint was encountered, display the
1671 // debug prompt (if not already done) before checking for a match.
1672 // This is a helpful hint for the user when the regular expression
1673 // matching fails. Handle a ">quit" debug command as if an
1674 // interrupt had occurred before the ":catch". That is, discard
1675 // the original exception, replace it by an interrupt exception,
1676 // and don't catch it in this try block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001677 if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1678 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001679 // Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1680 // while compiling it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681 if (end != NULL)
1682 {
1683 save_char = *end;
1684 *end = NUL;
1685 }
1686 save_cpo = p_cpo;
1687 p_cpo = (char_u *)"";
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001688 // Disable error messages, it will make current_exception
1689 // invalid.
Bram Moolenaar768ce242016-02-07 19:46:12 +01001690 ++emsg_off;
Bram Moolenaar150cc272007-08-01 13:47:46 +00001691 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
Bram Moolenaar768ce242016-02-07 19:46:12 +01001692 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001693 regmatch.rm_ic = FALSE;
1694 if (end != NULL)
1695 *end = save_char;
1696 p_cpo = save_cpo;
1697 if (regmatch.regprog == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001698 semsg(_(e_invarg2), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 else
1700 {
1701 /*
1702 * Save the value of got_int and reset it. We don't want
1703 * a previous interruption cancel matching, only hitting
1704 * CTRL-C while matching should abort it.
1705 */
1706 prev_got_int = got_int;
1707 got_int = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001708 caught = vim_regexec_nl(&regmatch,
1709 (char_u *)current_exception->value, (colnr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 got_int |= prev_got_int;
Bram Moolenaar473de612013-06-08 18:19:48 +02001711 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001712 }
1713 }
1714 }
1715
1716 if (caught)
1717 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001718 // Make this ":catch" clause active and reset did_emsg, got_int,
1719 // and did_throw. Put the exception on the caught stack.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001720 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1721 did_emsg = got_int = did_throw = FALSE;
1722 catch_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001723 // It's mandatory that the current exception is stored in the cstack
1724 // so that it can be discarded at the next ":catch", ":finally", or
1725 // ":endtry" or when the catch clause is left by a ":continue",
1726 // ":break", ":return", ":finish", error, interrupt, or another
1727 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 if (cstack->cs_exception[cstack->cs_idx] != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001729 internal_error("ex_catch()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730 }
1731 else
1732 {
1733 /*
1734 * If there is a preceding catch clause and it caught the exception,
1735 * finish the exception now. This happens also after errors except
1736 * when this ":catch" was after the ":finally" or not within
1737 * a ":try". Make the try conditional inactive so that the
1738 * following catch clauses are skipped. On an error or interrupt
1739 * after the preceding try block or catch clause was left by
1740 * a ":continue", ":break", ":return", or ":finish", discard the
1741 * pending action.
1742 */
1743 cleanup_conditionals(cstack, CSF_TRY, TRUE);
1744 }
1745 }
1746
1747 if (end != NULL)
1748 eap->nextcmd = find_nextcmd(end);
1749}
1750
1751/*
1752 * ":finally"
1753 */
1754 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001755ex_finally(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001756{
1757 int idx;
1758 int skip = FALSE;
1759 int pending = CSTP_NONE;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001760 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761
1762 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001763 eap->errmsg = _(e_finally);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001764 else
1765 {
1766 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1767 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001768 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001769 for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1770 if (cstack->cs_flags[idx] & CSF_TRY)
1771 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001772 // Make this error pending, so that the commands in the following
1773 // finally clause can be executed. This overrules also a pending
1774 // ":continue", ":break", ":return", or ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001775 pending = CSTP_ERROR;
1776 }
1777 else
1778 idx = cstack->cs_idx;
1779
1780 if (cstack->cs_flags[idx] & CSF_FINALLY)
1781 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001782 // Give up for a multiple ":finally" and ignore it.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001783 eap->errmsg = _(e_finally_dup);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 return;
1785 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001786 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
Bram Moolenaar12805862005-01-05 22:16:17 +00001787 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788
1789 /*
1790 * Don't do something when the corresponding try block never got active
1791 * (because of an inactive surrounding conditional or after an error or
1792 * interrupt or throw) or for a ":finally" without ":try" or a multiple
1793 * ":finally". After every other error (did_emsg or the conditional
1794 * errors detected above) or after an interrupt (got_int) or an
1795 * exception (did_throw), the finally clause must be executed.
1796 */
1797 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1798
1799 if (!skip)
1800 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001801 // When debugging or a breakpoint was encountered, display the
1802 // debug prompt (if not already done). The user then knows that the
1803 // finally clause is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001804 if (dbg_check_skipped(eap))
1805 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001806 // Handle a ">quit" debug command as if an interrupt had
1807 // occurred before the ":finally". That is, discard the
1808 // original exception and replace it by an interrupt
1809 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 (void)do_intthrow(cstack);
1811 }
1812
1813 /*
1814 * If there is a preceding catch clause and it caught the exception,
1815 * finish the exception now. This happens also after errors except
1816 * when this is a multiple ":finally" or one not within a ":try".
1817 * After an error or interrupt, this also discards a pending
1818 * ":continue", ":break", ":finish", or ":return" from the preceding
1819 * try block or catch clause.
1820 */
1821 cleanup_conditionals(cstack, CSF_TRY, FALSE);
1822
1823 /*
1824 * Make did_emsg, got_int, did_throw pending. If set, they overrule
1825 * a pending ":continue", ":break", ":return", or ":finish". Then
1826 * we have particularly to discard a pending return value (as done
1827 * by the call to cleanup_conditionals() above when did_emsg or
1828 * got_int is set). The pending values are restored by the
1829 * ":endtry", except if there is a new error, interrupt, exception,
1830 * ":continue", ":break", ":return", or ":finish" in the following
Bram Moolenaar12805862005-01-05 22:16:17 +00001831 * finally clause. A missing ":endwhile", ":endfor" or ":endif"
1832 * detected here is treated as if did_emsg and did_throw had
1833 * already been set, respectively in case that the error is not
1834 * converted to an exception, did_throw had already been unset.
1835 * We must not set did_emsg here since that would suppress the
1836 * error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 */
1838 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1839 {
1840 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
1841 {
1842 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001843 cstack->cs_rettv[cstack->cs_idx]);
1844 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001845 }
1846 if (pending == CSTP_ERROR && !did_emsg)
1847 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
1848 else
1849 pending |= did_throw ? CSTP_THROW : 0;
1850 pending |= did_emsg ? CSTP_ERROR : 0;
1851 pending |= got_int ? CSTP_INTERRUPT : 0;
1852 cstack->cs_pending[cstack->cs_idx] = pending;
1853
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001854 // It's mandatory that the current exception is stored in the
1855 // cstack so that it can be rethrown at the ":endtry" or be
1856 // discarded if the finally clause is left by a ":continue",
1857 // ":break", ":return", ":finish", error, interrupt, or another
1858 // exception. When emsg() is called for a missing ":endif" or
1859 // a missing ":endwhile"/":endfor" detected here, the
1860 // exception will be discarded.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001861 if (did_throw && cstack->cs_exception[cstack->cs_idx]
1862 != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001863 internal_error("ex_finally()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864 }
1865
1866 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001867 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001868 * got_int, and did_throw and make the finally clause active.
1869 * This will happen after emsg() has been called for a missing
Bram Moolenaar12805862005-01-05 22:16:17 +00001870 * ":endif" or a missing ":endwhile"/":endfor" detected here, so
1871 * that the following finally clause will be executed even then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001873 cstack->cs_lflags |= CSL_HAD_FINA;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 }
1875 }
1876}
1877
1878/*
1879 * ":endtry"
1880 */
1881 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001882ex_endtry(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001883{
1884 int idx;
1885 int skip;
1886 int rethrow = FALSE;
1887 int pending = CSTP_NONE;
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001888 void *rettv = NULL;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001889 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890
1891 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001892 eap->errmsg = _(e_no_endtry);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001893 else
1894 {
1895 /*
1896 * Don't do something after an error, interrupt or throw in the try
1897 * block, catch clause, or finally clause preceding this ":endtry" or
1898 * when an error or interrupt occurred after a ":continue", ":break",
1899 * ":return", or ":finish" in a try block or catch clause preceding this
1900 * ":endtry" or when the try block never got active (because of an
1901 * inactive surrounding conditional or after an error or interrupt or
1902 * throw) or when there is a surrounding conditional and it has been
1903 * made inactive by a ":continue", ":break", ":return", or ":finish" in
1904 * the finally clause. The latter case need not be tested since then
1905 * anything pending has already been discarded. */
1906 skip = did_emsg || got_int || did_throw ||
1907 !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1908
1909 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1910 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001911 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001912 // Find the matching ":try" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001913 idx = cstack->cs_idx;
1914 do
1915 --idx;
1916 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
Bram Moolenaar12805862005-01-05 22:16:17 +00001917 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1918 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 skip = TRUE;
1920
1921 /*
1922 * If an exception is being thrown, discard it to prevent it from
1923 * being rethrown at the end of this function. It would be
1924 * discarded by the error message, anyway. Resets did_throw.
1925 * This does not affect the script termination due to the error
1926 * since "trylevel" is decremented after emsg() has been called.
1927 */
1928 if (did_throw)
1929 discard_current_exception();
1930 }
1931 else
1932 {
1933 idx = cstack->cs_idx;
1934
1935 /*
1936 * If we stopped with the exception currently being thrown at this
1937 * try conditional since we didn't know that it doesn't have
1938 * a finally clause, we need to rethrow it after closing the try
1939 * conditional.
1940 */
1941 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
1942 && !(cstack->cs_flags[idx] & CSF_FINALLY))
1943 rethrow = TRUE;
1944 }
1945
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001946 // If there was no finally clause, show the user when debugging or
1947 // a breakpoint was encountered that the end of the try conditional has
1948 // been reached: display the debug prompt (if not already done). Do
1949 // this on normal control flow or when an exception was thrown, but not
1950 // on an interrupt or error not converted to an exception or when
1951 // a ":break", ":continue", ":return", or ":finish" is pending. These
1952 // actions are carried out immediately.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001953 if ((rethrow || (!skip
1954 && !(cstack->cs_flags[idx] & CSF_FINALLY)
1955 && !cstack->cs_pending[idx]))
1956 && dbg_check_skipped(eap))
1957 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001958 // Handle a ">quit" debug command as if an interrupt had occurred
1959 // before the ":endtry". That is, throw an interrupt exception and
1960 // set "skip" and "rethrow".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 if (got_int)
1962 {
1963 skip = TRUE;
1964 (void)do_intthrow(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001965 // The do_intthrow() call may have reset did_throw or
1966 // cstack->cs_pending[idx].
Bram Moolenaar071d4272004-06-13 20:20:40 +00001967 rethrow = FALSE;
1968 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY))
1969 rethrow = TRUE;
1970 }
1971 }
1972
1973 /*
1974 * If a ":return" is pending, we need to resume it after closing the
1975 * try conditional; remember the return value. If there was a finally
1976 * clause making an exception pending, we need to rethrow it. Make it
1977 * the exception currently being thrown.
1978 */
1979 if (!skip)
1980 {
1981 pending = cstack->cs_pending[idx];
1982 cstack->cs_pending[idx] = CSTP_NONE;
1983 if (pending == CSTP_RETURN)
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001984 rettv = cstack->cs_rettv[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001985 else if (pending & CSTP_THROW)
1986 current_exception = cstack->cs_exception[idx];
1987 }
1988
1989 /*
1990 * Discard anything pending on an error, interrupt, or throw in the
1991 * finally clause. If there was no ":finally", discard a pending
1992 * ":continue", ":break", ":return", or ":finish" if an error or
1993 * interrupt occurred afterwards, but before the ":endtry" was reached.
1994 * If an exception was caught by the last of the catch clauses and there
1995 * was no finally clause, finish the exception now. This happens also
1996 * after errors except when this ":endtry" is not within a ":try".
1997 * Restore "emsg_silent" if it has been reset by this try conditional.
1998 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001999 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002001 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 --cstack->cs_trylevel;
2003
2004 if (!skip)
2005 {
2006 report_resume_pending(pending,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002007 (pending == CSTP_RETURN) ? rettv :
Bram Moolenaar071d4272004-06-13 20:20:40 +00002008 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2009 switch (pending)
2010 {
2011 case CSTP_NONE:
2012 break;
2013
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002014 // Reactivate a pending ":continue", ":break", ":return",
2015 // ":finish" from the try block or a catch clause of this try
2016 // conditional. This is skipped, if there was an error in an
2017 // (unskipped) conditional command or an interrupt afterwards
2018 // or if the finally clause is present and executed a new error,
2019 // interrupt, throw, ":continue", ":break", ":return", or
2020 // ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021 case CSTP_CONTINUE:
2022 ex_continue(eap);
2023 break;
2024 case CSTP_BREAK:
2025 ex_break(eap);
2026 break;
2027 case CSTP_RETURN:
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002028 do_return(eap, FALSE, FALSE, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 break;
2030 case CSTP_FINISH:
2031 do_finish(eap, FALSE);
2032 break;
2033
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002034 // When the finally clause was entered due to an error,
2035 // interrupt or throw (as opposed to a ":continue", ":break",
2036 // ":return", or ":finish"), restore the pending values of
2037 // did_emsg, got_int, and did_throw. This is skipped, if there
2038 // was a new error, interrupt, throw, ":continue", ":break",
2039 // ":return", or ":finish". in the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 default:
2041 if (pending & CSTP_ERROR)
2042 did_emsg = TRUE;
2043 if (pending & CSTP_INTERRUPT)
2044 got_int = TRUE;
2045 if (pending & CSTP_THROW)
2046 rethrow = TRUE;
2047 break;
2048 }
2049 }
2050
2051 if (rethrow)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002052 // Rethrow the current exception (within this cstack).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002053 do_throw(cstack);
2054 }
2055}
2056
2057/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002058 * enter_cleanup() and leave_cleanup()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002059 *
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002060 * Functions to be called before/after invoking a sequence of autocommands for
2061 * cleanup for a failed command. (Failure means here that a call to emsg()
2062 * has been made, an interrupt occurred, or there is an uncaught exception
2063 * from a previous autocommand execution of the same command.)
2064 *
2065 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same
2066 * pointer to leave_cleanup(). The cleanup_T structure stores the pending
2067 * error/interrupt/exception state.
2068 */
2069
2070/*
2071 * This function works a bit like ex_finally() except that there was not
2072 * actually an extra try block around the part that failed and an error or
2073 * interrupt has not (yet) been converted to an exception. This function
2074 * saves the error/interrupt/ exception state and prepares for the call to
2075 * do_cmdline() that is going to be made for the cleanup autocommand
2076 * execution.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002077 */
2078 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002079enter_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002080{
2081 int pending = CSTP_NONE;
2082
2083 /*
2084 * Postpone did_emsg, got_int, did_throw. The pending values will be
2085 * restored by leave_cleanup() except if there was an aborting error,
2086 * interrupt, or uncaught exception after this function ends.
2087 */
2088 if (did_emsg || got_int || did_throw || need_rethrow)
2089 {
2090 csp->pending = (did_emsg ? CSTP_ERROR : 0)
2091 | (got_int ? CSTP_INTERRUPT : 0)
2092 | (did_throw ? CSTP_THROW : 0)
2093 | (need_rethrow ? CSTP_THROW : 0);
2094
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002095 // If we are currently throwing an exception (did_throw), save it as
2096 // well. On an error not yet converted to an exception, update
2097 // "force_abort" and reset "cause_abort" (as do_errthrow() would do).
2098 // This is needed for the do_cmdline() call that is going to be made
2099 // for autocommand execution. We need not save *msg_list because
2100 // there is an extra instance for every call of do_cmdline(), anyway.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002101 if (did_throw || need_rethrow)
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002102 {
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002103 csp->exception = current_exception;
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002104 current_exception = NULL;
2105 }
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002106 else
2107 {
2108 csp->exception = NULL;
2109 if (did_emsg)
2110 {
2111 force_abort |= cause_abort;
2112 cause_abort = FALSE;
2113 }
2114 }
2115 did_emsg = got_int = did_throw = need_rethrow = FALSE;
2116
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002117 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002118 report_make_pending(pending, csp->exception);
2119 }
2120 else
2121 {
2122 csp->pending = CSTP_NONE;
2123 csp->exception = NULL;
2124 }
2125}
2126
2127/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002128 * See comment above enter_cleanup() for how this function is used.
2129 *
2130 * This function is a bit like ex_endtry() except that there was not actually
2131 * an extra try block around the part that failed and an error or interrupt
2132 * had not (yet) been converted to an exception when the cleanup autocommand
2133 * sequence was invoked.
2134 *
2135 * This function has to be called with the address of the cleanup_T structure
2136 * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2137 * exception state saved by that function - except there was an aborting
2138 * error, an interrupt or an uncaught exception during execution of the
2139 * cleanup autocommands. In the latter case, the saved error/interrupt/
2140 * exception state is discarded.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002141 */
2142 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002143leave_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002144{
2145 int pending = csp->pending;
2146
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002147 if (pending == CSTP_NONE) // nothing to do
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002148 return;
2149
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002150 // If there was an aborting error, an interrupt, or an uncaught exception
2151 // after the corresponding call to enter_cleanup(), discard what has been
2152 // made pending by it. Report this to the user if required by the
2153 // 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002154 if (aborting() || need_rethrow)
2155 {
2156 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002157 // Cancel the pending exception (includes report).
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002158 discard_exception((except_T *)csp->exception, FALSE);
2159 else
2160 report_discard_pending(pending, NULL);
2161
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002162 // If an error was about to be converted to an exception when
2163 // enter_cleanup() was called, free the message list.
Bram Moolenaar4632d292006-11-28 17:36:37 +00002164 if (msg_list != NULL)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +01002165 free_global_msglist();
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002166 }
2167
2168 /*
2169 * If there was no new error, interrupt, or throw between the calls
2170 * to enter_cleanup() and leave_cleanup(), restore the pending
2171 * error/interrupt/exception state.
2172 */
2173 else
2174 {
2175 /*
2176 * If there was an exception being thrown when enter_cleanup() was
2177 * called, we need to rethrow it. Make it the exception currently
2178 * being thrown.
2179 */
2180 if (pending & CSTP_THROW)
2181 current_exception = csp->exception;
2182
2183 /*
2184 * If an error was about to be converted to an exception when
2185 * enter_cleanup() was called, let "cause_abort" take the part of
2186 * "force_abort" (as done by cause_errthrow()).
2187 */
2188 else if (pending & CSTP_ERROR)
2189 {
2190 cause_abort = force_abort;
2191 force_abort = FALSE;
2192 }
2193
2194 /*
2195 * Restore the pending values of did_emsg, got_int, and did_throw.
2196 */
2197 if (pending & CSTP_ERROR)
2198 did_emsg = TRUE;
2199 if (pending & CSTP_INTERRUPT)
2200 got_int = TRUE;
2201 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002202 need_rethrow = TRUE; // did_throw will be set by do_one_cmd()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002203
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002204 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002205 report_resume_pending(pending,
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002206 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002207 }
2208}
2209
2210
2211/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002212 * Make conditionals inactive and discard what's pending in finally clauses
2213 * until the conditional type searched for or a try conditional not in its
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002214 * finally clause is reached. If this is in an active catch clause, finish
2215 * the caught exception.
2216 * Return the cstack index where the search stopped.
Bram Moolenaar12805862005-01-05 22:16:17 +00002217 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
2218 * the latter meaning the innermost try conditional not in its finally clause.
2219 * "inclusive" tells whether the conditional searched for should be made
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002220 * inactive itself (a try conditional not in its finally clause possibly find
Bram Moolenaar12805862005-01-05 22:16:17 +00002221 * before is always made inactive). If "inclusive" is TRUE and
2222 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
2223 * "emsg_silent", if reset when the try conditional finally reached was
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002224 * entered, is restored (used by ex_endtry()). This is normally done only
Bram Moolenaar12805862005-01-05 22:16:17 +00002225 * when such a try conditional is left.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002226 */
2227 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002228cleanup_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002229 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002230 int searched_cond,
2231 int inclusive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232{
2233 int idx;
2234 int stop = FALSE;
2235
2236 for (idx = cstack->cs_idx; idx >= 0; --idx)
2237 {
2238 if (cstack->cs_flags[idx] & CSF_TRY)
2239 {
2240 /*
2241 * Discard anything pending in a finally clause and continue the
2242 * search. There may also be a pending ":continue", ":break",
2243 * ":return", or ":finish" before the finally clause. We must not
2244 * discard it, unless an error or interrupt occurred afterwards.
2245 */
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002246 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 {
2248 switch (cstack->cs_pending[idx])
2249 {
2250 case CSTP_NONE:
2251 break;
2252
2253 case CSTP_CONTINUE:
2254 case CSTP_BREAK:
2255 case CSTP_FINISH:
2256 report_discard_pending(cstack->cs_pending[idx], NULL);
2257 cstack->cs_pending[idx] = CSTP_NONE;
2258 break;
2259
2260 case CSTP_RETURN:
2261 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002262 cstack->cs_rettv[idx]);
2263 discard_pending_return(cstack->cs_rettv[idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 cstack->cs_pending[idx] = CSTP_NONE;
2265 break;
2266
2267 default:
2268 if (cstack->cs_flags[idx] & CSF_FINALLY)
2269 {
2270 if (cstack->cs_pending[idx] & CSTP_THROW)
2271 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002272 // Cancel the pending exception. This is in the
2273 // finally clause, so that the stack of the
2274 // caught exceptions is not involved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 discard_exception((except_T *)
2276 cstack->cs_exception[idx],
2277 FALSE);
2278 }
2279 else
2280 report_discard_pending(cstack->cs_pending[idx],
2281 NULL);
2282 cstack->cs_pending[idx] = CSTP_NONE;
2283 }
2284 break;
2285 }
2286 }
2287
2288 /*
2289 * Stop at a try conditional not in its finally clause. If this try
2290 * conditional is in an active catch clause, finish the caught
2291 * exception.
2292 */
2293 if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2294 {
2295 if ((cstack->cs_flags[idx] & CSF_ACTIVE)
2296 && (cstack->cs_flags[idx] & CSF_CAUGHT))
2297 finish_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002298 // Stop at this try conditional - except the try block never
2299 // got active (because of an inactive surrounding conditional
2300 // or when the ":try" appeared after an error or interrupt or
2301 // throw).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002302 if (cstack->cs_flags[idx] & CSF_TRUE)
2303 {
2304 if (searched_cond == 0 && !inclusive)
2305 break;
2306 stop = TRUE;
2307 }
2308 }
2309 }
2310
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002311 // Stop on the searched conditional type (even when the surrounding
2312 // conditional is not active or something has been made pending).
2313 // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2314 // check first whether "emsg_silent" needs to be restored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 if (cstack->cs_flags[idx] & searched_cond)
2316 {
2317 if (!inclusive)
2318 break;
2319 stop = TRUE;
2320 }
2321 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2322 if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2323 break;
2324
2325 /*
Bram Moolenaarccc18222007-05-10 18:25:20 +00002326 * When leaving a try conditional that reset "emsg_silent" on its
2327 * entry after saving the original value, restore that value here and
2328 * free the memory used to store it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002329 */
2330 if ((cstack->cs_flags[idx] & CSF_TRY)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002331 && (cstack->cs_flags[idx] & CSF_SILENT))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002332 {
2333 eslist_T *elem;
2334
2335 elem = cstack->cs_emsg_silent_list;
2336 cstack->cs_emsg_silent_list = elem->next;
2337 emsg_silent = elem->saved_emsg_silent;
2338 vim_free(elem);
2339 cstack->cs_flags[idx] &= ~CSF_SILENT;
2340 }
2341 if (stop)
2342 break;
2343 }
2344 return idx;
2345}
2346
2347/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002348 * Return an appropriate error message for a missing endwhile/endfor/endif.
2349 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002350 static char *
Bram Moolenaarddef1292019-12-16 17:10:33 +01002351get_end_emsg(cstack_T *cstack)
Bram Moolenaar12805862005-01-05 22:16:17 +00002352{
2353 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002354 return _(e_endwhile);
Bram Moolenaar12805862005-01-05 22:16:17 +00002355 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02002356 return _(e_endfor);
2357 return _(e_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00002358}
2359
2360
2361/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002362 * Rewind conditionals until index "idx" is reached. "cond_type" and
2363 * "cond_level" specify a conditional type and the address of a level variable
2364 * which is to be decremented with each skipped conditional of the specified
2365 * type.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002366 * Also free "for info" structures where needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002367 */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002368 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002369rewind_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002370 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002371 int idx,
2372 int cond_type,
2373 int *cond_level)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002374{
2375 while (cstack->cs_idx > idx)
2376 {
2377 if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2378 --*cond_level;
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002379 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2380 free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002381 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002382 }
2383}
2384
2385/*
2386 * ":endfunction" when not after a ":function"
2387 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002388 void
Bram Moolenaar6e949782020-04-13 17:21:00 +02002389ex_endfunction(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390{
Bram Moolenaar6e949782020-04-13 17:21:00 +02002391 if (eap->cmdidx == CMD_enddef)
2392 emsg(_("E193: :enddef not inside a function"));
2393 else
2394 emsg(_("E193: :endfunction not inside a function"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002395}
2396
2397/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002398 * Return TRUE if the string "p" looks like a ":while" or ":for" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002399 */
2400 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002401has_loop_cmd(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402{
Bram Moolenaared53fb92007-11-24 20:50:24 +00002403 int len;
2404
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002405 // skip modifiers, white space and ':'
Bram Moolenaared53fb92007-11-24 20:50:24 +00002406 for (;;)
2407 {
2408 while (*p == ' ' || *p == '\t' || *p == ':')
2409 ++p;
2410 len = modifier_len(p);
2411 if (len == 0)
2412 break;
2413 p += len;
2414 }
Bram Moolenaar12805862005-01-05 22:16:17 +00002415 if ((p[0] == 'w' && p[1] == 'h')
2416 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002417 return TRUE;
2418 return FALSE;
2419}
2420
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002421#endif // FEAT_EVAL