blob: 231e0f360d0cba5b82106e7950e4ce844dcf8171 [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 */
Bram Moolenaar436b5ad2021-12-31 22:49:24 +0000194 if (mesg == (char_u *)_(e_interrupted))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195 {
196 *ignore = TRUE;
197 return TRUE;
198 }
199
200 /*
201 * Ensure that all commands in nested function calls and sourced files
202 * are aborted immediately.
203 */
204 cause_abort = TRUE;
205
206 /*
207 * When an exception is being thrown, some commands (like conditionals) are
208 * not skipped. Errors in those commands may affect what of the subsequent
209 * commands are regarded part of catch and finally clauses. Catching the
210 * exception would then cause execution of commands not intended by the
Bram Moolenaarc3235272021-07-10 19:42:03 +0200211 * user, who wouldn't even get aware of the problem. Therefore, discard the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000212 * exception currently being thrown to prevent it from being caught. Just
213 * execute finally clauses and terminate.
214 */
215 if (did_throw)
216 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100217 // When discarding an interrupt exception, reset got_int to prevent the
218 // same interrupt being converted to an exception again and discarding
219 // the error exception we are about to throw here.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000220 if (current_exception->type == ET_INTERRUPT)
221 got_int = FALSE;
222 discard_current_exception();
223 }
224
225#ifdef THROW_TEST
226 if (!THROW_ON_ERROR)
227 {
228 /*
229 * Print error message immediately without searching for a matching
230 * catch clause; just finally clauses are executed before the script
231 * is terminated.
232 */
233 return FALSE;
234 }
235 else
236#endif
237 {
238 /*
239 * Prepare the throw of an error exception, so that everything will
240 * be aborted (except for executing finally clauses), until the error
241 * exception is caught; if still uncaught at the top level, the error
242 * message will be displayed and the script processing terminated
243 * then. - This function has no access to the conditional stack.
244 * Thus, the actual throw is made after the failing command has
245 * returned. - Throw only the first of several errors in a row, except
246 * a severe error is following.
247 */
248 if (msg_list != NULL)
249 {
250 plist = msg_list;
251 while (*plist != NULL)
252 plist = &(*plist)->next;
253
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200254 elem = ALLOC_CLEAR_ONE(msglist_T);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000255 if (elem == NULL)
256 {
257 suppress_errthrow = TRUE;
Bram Moolenaare29a27f2021-07-20 21:07:36 +0200258 emsg(_(e_out_of_memory));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000259 }
260 else
261 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100262 elem->msg = (char *)vim_strsave(mesg);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000263 if (elem->msg == NULL)
264 {
265 vim_free(elem);
266 suppress_errthrow = TRUE;
Bram Moolenaare29a27f2021-07-20 21:07:36 +0200267 emsg(_(e_out_of_memory));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000268 }
269 else
270 {
271 elem->next = NULL;
272 elem->throw_msg = NULL;
273 *plist = elem;
274 if (plist == msg_list || severe)
275 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100276 char *tmsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000277
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100278 // Skip the extra "Vim " prefix for message "E458".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 tmsg = elem->msg;
280 if (STRNCMP(tmsg, "Vim E", 5) == 0
281 && VIM_ISDIGIT(tmsg[5])
282 && VIM_ISDIGIT(tmsg[6])
283 && VIM_ISDIGIT(tmsg[7])
284 && tmsg[8] == ':'
285 && tmsg[9] == ' ')
286 (*msg_list)->throw_msg = &tmsg[4];
287 else
288 (*msg_list)->throw_msg = tmsg;
289 }
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200290
291 // Get the source name and lnum now, it may change before
292 // reaching do_errthrow().
Bram Moolenaar4f25b1a2020-09-10 19:25:05 +0200293 elem->sfile = estack_sfile(ESTACK_NONE);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200294 elem->slnum = SOURCING_LNUM;
Bram Moolenaare8c46602021-04-05 22:27:37 +0200295 elem->msg_compiling = estack_compiling;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000296 }
297 }
298 }
299 return TRUE;
300 }
301}
302
303/*
304 * Free a "msg_list" and the messages it contains.
305 */
306 static void
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200307free_msglist(msglist_T *l)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308{
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200309 msglist_T *messages, *next;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311 messages = l;
312 while (messages != NULL)
313 {
314 next = messages->next;
315 vim_free(messages->msg);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200316 vim_free(messages->sfile);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 vim_free(messages);
318 messages = next;
319 }
320}
321
322/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100323 * Free global "*msg_list" and the messages it contains, then set "*msg_list"
324 * to NULL.
325 */
326 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100327free_global_msglist(void)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100328{
329 free_msglist(*msg_list);
330 *msg_list = NULL;
331}
332
333/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334 * Throw the message specified in the call to cause_errthrow() above as an
335 * error exception. If cstack is NULL, postpone the throw until do_cmdline()
336 * has returned (see do_one_cmd()).
337 */
338 void
Bram Moolenaarddef1292019-12-16 17:10:33 +0100339do_errthrow(cstack_T *cstack, char_u *cmdname)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000340{
341 /*
342 * Ensure that all commands in nested function calls and sourced files
343 * are aborted immediately.
344 */
345 if (cause_abort)
346 {
347 cause_abort = FALSE;
348 force_abort = TRUE;
349 }
350
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100351 // If no exception is to be thrown or the conversion should be done after
352 // returning to a previous invocation of do_one_cmd(), do nothing.
Bram Moolenaar4632d292006-11-28 17:36:37 +0000353 if (msg_list == NULL || *msg_list == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000354 return;
355
356 if (throw_exception(*msg_list, ET_ERROR, cmdname) == FAIL)
357 free_msglist(*msg_list);
358 else
359 {
360 if (cstack != NULL)
361 do_throw(cstack);
362 else
363 need_rethrow = TRUE;
364 }
365 *msg_list = NULL;
366}
367
368/*
369 * do_intthrow(): Replace the current exception by an interrupt or interrupt
370 * exception if appropriate. Return TRUE if the current exception is discarded,
371 * FALSE otherwise.
372 */
373 int
Bram Moolenaarddef1292019-12-16 17:10:33 +0100374do_intthrow(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000375{
376 /*
377 * If no interrupt occurred or no try conditional is active and no exception
378 * is being thrown, do nothing (for compatibility of non-EH scripts).
379 */
380 if (!got_int || (trylevel == 0 && !did_throw))
381 return FALSE;
382
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100383#ifdef THROW_TEST // avoid warning for condition always true
Bram Moolenaar071d4272004-06-13 20:20:40 +0000384 if (!THROW_ON_INTERRUPT)
385 {
386 /*
387 * The interrupt aborts everything except for executing finally clauses.
388 * Discard any user or error or interrupt exception currently being
389 * thrown.
390 */
391 if (did_throw)
392 discard_current_exception();
393 }
394 else
395#endif
396 {
397 /*
398 * Throw an interrupt exception, so that everything will be aborted
399 * (except for executing finally clauses), until the interrupt exception
400 * is caught; if still uncaught at the top level, the script processing
401 * will be terminated then. - If an interrupt exception is already
402 * being thrown, do nothing.
403 *
404 */
405 if (did_throw)
406 {
407 if (current_exception->type == ET_INTERRUPT)
408 return FALSE;
409
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100410 // An interrupt exception replaces any user or error exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000411 discard_current_exception();
412 }
413 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) != FAIL)
414 do_throw(cstack);
415 }
416
417 return TRUE;
418}
419
Bram Moolenaar071d4272004-06-13 20:20:40 +0000420/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100421 * Get an exception message that is to be stored in current_exception->value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000422 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100423 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100424get_exception_string(
425 void *value,
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100426 except_type_T type,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100427 char_u *cmdname,
428 int *should_free)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000429{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100430 char *ret;
431 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000432 int cmdlen;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100433 char *p, *val;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000434
435 if (type == ET_ERROR)
436 {
Bram Moolenaar9ef00be2016-03-06 14:58:28 +0100437 *should_free = TRUE;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200438 mesg = ((msglist_T *)value)->throw_msg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000439 if (cmdname != NULL && *cmdname != NUL)
440 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000441 cmdlen = (int)STRLEN(cmdname);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100442 ret = (char *)vim_strnsave((char_u *)"Vim(",
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200443 4 + cmdlen + 2 + STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100444 if (ret == NULL)
445 return ret;
446 STRCPY(&ret[4], cmdname);
447 STRCPY(&ret[4 + cmdlen], "):");
448 val = ret + 4 + cmdlen + 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000449 }
450 else
451 {
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200452 ret = (char *)vim_strnsave((char_u *)"Vim:", 4 + STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100453 if (ret == NULL)
454 return ret;
455 val = ret + 4;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000456 }
457
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100458 // msg_add_fname may have been used to prefix the message with a file
459 // name in quotes. In the exception value, put the file name in
460 // parentheses and move it to the end.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000461 for (p = mesg; ; p++)
462 {
463 if (*p == NUL
464 || (*p == 'E'
465 && VIM_ISDIGIT(p[1])
466 && (p[2] == ':'
467 || (VIM_ISDIGIT(p[2])
468 && (p[3] == ':'
469 || (VIM_ISDIGIT(p[3])
470 && p[4] == ':'))))))
471 {
Bram Moolenaar051b7822005-05-19 21:00:46 +0000472 if (*p == NUL || p == mesg)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100473 STRCAT(val, mesg); // 'E123' missing or at beginning
Bram Moolenaar071d4272004-06-13 20:20:40 +0000474 else
475 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100476 // '"filename" E123: message text'
Bram Moolenaar071d4272004-06-13 20:20:40 +0000477 if (mesg[0] != '"' || p-2 < &mesg[1] ||
478 p[-2] != '"' || p[-1] != ' ')
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100479 // "E123:" is part of the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000480 continue;
481
482 STRCAT(val, p);
483 p[-2] = NUL;
484 sprintf((char *)(val + STRLEN(p)), " (%s)", &mesg[1]);
485 p[-2] = '"';
486 }
487 break;
488 }
489 }
490 }
491 else
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100492 {
493 *should_free = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100494 ret = value;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100495 }
496
497 return ret;
498}
499
500
501/*
502 * Throw a new exception. Return FAIL when out of memory or it was tried to
503 * throw an illegal user exception. "value" is the exception string for a
504 * user or interrupt exception, or points to a message list in case of an
505 * error exception.
506 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100507 int
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100508throw_exception(void *value, except_type_T type, char_u *cmdname)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100509{
510 except_T *excp;
511 int should_free;
512
513 /*
514 * Disallow faking Interrupt or error exceptions as user exceptions. They
515 * would be treated differently from real interrupt or error exceptions
516 * when no active try block is found, see do_cmdline().
517 */
518 if (type == ET_USER)
519 {
520 if (STRNCMP((char_u *)value, "Vim", 3) == 0
521 && (((char_u *)value)[3] == NUL || ((char_u *)value)[3] == ':'
522 || ((char_u *)value)[3] == '('))
523 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100524 emsg(_("E608: Cannot :throw exceptions with 'Vim' prefix"));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100525 goto fail;
526 }
527 }
528
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200529 excp = ALLOC_ONE(except_T);
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100530 if (excp == NULL)
531 goto nomem;
532
533 if (type == ET_ERROR)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100534 // Store the original message and prefix the exception value with
535 // "Vim:" or, if a command name is given, "Vim(cmdname):".
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200536 excp->messages = (msglist_T *)value;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100537
538 excp->value = get_exception_string(value, type, cmdname, &should_free);
539 if (excp->value == NULL && should_free)
540 goto nomem;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000541
542 excp->type = type;
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200543 if (type == ET_ERROR && ((msglist_T *)value)->sfile != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544 {
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200545 msglist_T *entry = (msglist_T *)value;
546
547 excp->throw_name = entry->sfile;
548 entry->sfile = NULL;
549 excp->throw_lnum = entry->slnum;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 }
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200551 else
552 {
Bram Moolenaar4f25b1a2020-09-10 19:25:05 +0200553 excp->throw_name = estack_sfile(ESTACK_NONE);
Bram Moolenaar25e0f582020-05-25 22:36:50 +0200554 if (excp->throw_name == NULL)
555 excp->throw_name = vim_strsave((char_u *)"");
556 if (excp->throw_name == NULL)
557 {
558 if (should_free)
559 vim_free(excp->value);
560 goto nomem;
561 }
562 excp->throw_lnum = SOURCING_LNUM;
563 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564
565 if (p_verbose >= 13 || debug_break_level > 0)
566 {
567 int save_msg_silent = msg_silent;
568
569 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100570 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000571 else
572 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000574 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100575 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000576
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100577 smsg(_("Exception thrown: %s"), excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100578 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000579
580 if (debug_break_level > 0 || *p_vfile == NUL)
581 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582 --no_wait_return;
583 if (debug_break_level > 0)
584 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000585 else
586 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000587 }
588
589 current_exception = excp;
590 return OK;
591
592nomem:
593 vim_free(excp);
594 suppress_errthrow = TRUE;
Bram Moolenaare29a27f2021-07-20 21:07:36 +0200595 emsg(_(e_out_of_memory));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000596fail:
597 current_exception = NULL;
598 return FAIL;
599}
600
601/*
602 * Discard an exception. "was_finished" is set when the exception has been
603 * caught and the catch clause has been ended normally.
604 */
605 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100606discard_exception(except_T *excp, int was_finished)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607{
608 char_u *saved_IObuff;
609
Bram Moolenaar13656f02020-12-19 17:55:54 +0100610 if (current_exception == excp)
611 current_exception = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000612 if (excp == NULL)
613 {
Bram Moolenaar95f09602016-11-10 20:01:45 +0100614 internal_error("discard_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615 return;
616 }
617
618 if (p_verbose >= 13 || debug_break_level > 0)
619 {
620 int save_msg_silent = msg_silent;
621
622 saved_IObuff = vim_strsave(IObuff);
623 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100624 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000625 else
626 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000627 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000628 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100629 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar051b7822005-05-19 21:00:46 +0000630 smsg(was_finished
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100631 ? _("Exception finished: %s")
632 : _("Exception discarded: %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100634 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000635 if (debug_break_level > 0 || *p_vfile == NUL)
636 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637 --no_wait_return;
638 if (debug_break_level > 0)
639 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000640 else
641 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000642 STRCPY(IObuff, saved_IObuff);
643 vim_free(saved_IObuff);
644 }
645 if (excp->type != ET_INTERRUPT)
646 vim_free(excp->value);
647 if (excp->type == ET_ERROR)
648 free_msglist(excp->messages);
649 vim_free(excp->throw_name);
650 vim_free(excp);
651}
652
653/*
654 * Discard the exception currently being thrown.
655 */
656 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100657discard_current_exception(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658{
Bram Moolenaarcae24be2017-07-10 22:12:10 +0200659 if (current_exception != NULL)
Bram Moolenaarcae24be2017-07-10 22:12:10 +0200660 discard_exception(current_exception, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000661 did_throw = FALSE;
662 need_rethrow = FALSE;
663}
664
665/*
666 * Put an exception on the caught stack.
667 */
Bram Moolenaar8a7d6542020-01-26 15:56:19 +0100668 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100669catch_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000670{
671 excp->caught = caught_stack;
672 caught_stack = excp;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100673 set_vim_var_string(VV_EXCEPTION, (char_u *)excp->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 if (*excp->throw_name != NUL)
675 {
676 if (excp->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000677 vim_snprintf((char *)IObuff, IOSIZE, _("%s, line %ld"),
678 excp->throw_name, (long)excp->throw_lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000680 vim_snprintf((char *)IObuff, IOSIZE, "%s", excp->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000681 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
682 }
683 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100684 // throw_name not set on an exception from a command that was typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000685 set_vim_var_string(VV_THROWPOINT, NULL, -1);
686
687 if (p_verbose >= 13 || debug_break_level > 0)
688 {
689 int save_msg_silent = msg_silent;
690
691 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100692 msg_silent = FALSE; // display messages
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000693 else
694 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000696 if (debug_break_level > 0 || *p_vfile == NUL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100697 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000698
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100699 smsg(_("Exception caught: %s"), excp->value);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100700 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000701
702 if (debug_break_level > 0 || *p_vfile == NUL)
703 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000704 --no_wait_return;
705 if (debug_break_level > 0)
706 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000707 else
708 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709 }
710}
711
712/*
713 * Remove an exception from the caught stack.
714 */
715 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100716finish_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000717{
718 if (excp != caught_stack)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100719 internal_error("finish_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 caught_stack = caught_stack->caught;
721 if (caught_stack != NULL)
722 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100723 set_vim_var_string(VV_EXCEPTION, (char_u *)caught_stack->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724 if (*caught_stack->throw_name != NUL)
725 {
726 if (caught_stack->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000727 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000728 _("%s, line %ld"), caught_stack->throw_name,
729 (long)caught_stack->throw_lnum);
730 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000731 vim_snprintf((char *)IObuff, IOSIZE, "%s",
732 caught_stack->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000733 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
734 }
735 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100736 // throw_name not set on an exception from a command that was
737 // typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000738 set_vim_var_string(VV_THROWPOINT, NULL, -1);
739 }
740 else
741 {
742 set_vim_var_string(VV_EXCEPTION, NULL, -1);
743 set_vim_var_string(VV_THROWPOINT, NULL, -1);
744 }
745
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100746 // Discard the exception, but use the finish message for 'verbose'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747 discard_exception(excp, TRUE);
748}
749
750/*
751 * Flags specifying the message displayed by report_pending.
752 */
753#define RP_MAKE 0
754#define RP_RESUME 1
755#define RP_DISCARD 2
756
757/*
758 * Report information about something pending in a finally clause if required by
759 * the 'verbose' option or when debugging. "action" tells whether something is
760 * made pending or something pending is resumed or discarded. "pending" tells
761 * what is pending. "value" specifies the return value for a pending ":return"
762 * or the exception value for a pending exception.
763 */
764 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100765report_pending(int action, int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100767 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000768 char *s;
769 int save_msg_silent;
770
771
772 switch (action)
773 {
774 case RP_MAKE:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100775 mesg = _("%s made pending");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000776 break;
777 case RP_RESUME:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100778 mesg = _("%s resumed");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000779 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100780 // case RP_DISCARD:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 default:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100782 mesg = _("%s discarded");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000783 break;
784 }
785
786 switch (pending)
787 {
788 case CSTP_NONE:
789 return;
790
791 case CSTP_CONTINUE:
792 s = ":continue";
793 break;
794 case CSTP_BREAK:
795 s = ":break";
796 break;
797 case CSTP_FINISH:
798 s = ":finish";
799 break;
800 case CSTP_RETURN:
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100801 // ":return" command producing value, allocated
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802 s = (char *)get_return_cmd(value);
803 break;
804
805 default:
806 if (pending & CSTP_THROW)
807 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100808 vim_snprintf((char *)IObuff, IOSIZE, mesg, _("Exception"));
Bram Moolenaar71ccd032020-06-12 22:59:11 +0200809 mesg = (char *)vim_strnsave(IObuff, STRLEN(IObuff) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 STRCAT(mesg, ": %s");
811 s = (char *)((except_T *)value)->value;
812 }
813 else if ((pending & CSTP_ERROR) && (pending & CSTP_INTERRUPT))
814 s = _("Error and interrupt");
815 else if (pending & CSTP_ERROR)
816 s = _("Error");
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100817 else // if (pending & CSTP_INTERRUPT)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 s = _("Interrupt");
819 }
820
821 save_msg_silent = msg_silent;
822 if (debug_break_level > 0)
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100823 msg_silent = FALSE; // display messages
Bram Moolenaar071d4272004-06-13 20:20:40 +0000824 ++no_wait_return;
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100825 msg_scroll = TRUE; // always scroll up, don't overwrite
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100826 smsg(mesg, s);
Bram Moolenaar217e1b82019-12-01 21:41:28 +0100827 msg_puts("\n"); // don't overwrite this either
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828 cmdline_row = msg_row;
829 --no_wait_return;
830 if (debug_break_level > 0)
831 msg_silent = save_msg_silent;
832
833 if (pending == CSTP_RETURN)
834 vim_free(s);
835 else if (pending & CSTP_THROW)
836 vim_free(mesg);
837}
838
839/*
840 * If something is made pending in a finally clause, report it if required by
841 * the 'verbose' option or when debugging.
842 */
843 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100844report_make_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000845{
846 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000847 {
848 if (debug_break_level <= 0)
849 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 report_pending(RP_MAKE, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000851 if (debug_break_level <= 0)
852 verbose_leave();
853 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854}
855
856/*
857 * If something pending in a finally clause is resumed at the ":endtry", report
858 * it if required by the 'verbose' option or when debugging.
859 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200860 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100861report_resume_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862{
863 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000864 {
865 if (debug_break_level <= 0)
866 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 report_pending(RP_RESUME, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000868 if (debug_break_level <= 0)
869 verbose_leave();
870 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000871}
872
873/*
874 * If something pending in a finally clause is discarded, report it if required
875 * by the 'verbose' option or when debugging.
876 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200877 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100878report_discard_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000879{
880 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000881 {
882 if (debug_break_level <= 0)
883 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000884 report_pending(RP_DISCARD, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000885 if (debug_break_level <= 0)
886 verbose_leave();
887 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888}
889
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000890/*
Bram Moolenaar65259b52021-11-23 14:52:06 +0000891 * Return TRUE if "arg" is only a variable, register, environment variable or
892 * option name.
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000893 */
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200894 int
895cmd_is_name_only(char_u *arg)
896{
897 char_u *p = arg;
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000898 char_u *alias = NULL;
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200899 int name_only = FALSE;
900
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000901 if (*p == '@')
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200902 {
903 ++p;
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000904 if (*p != NUL)
905 ++p;
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200906 }
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000907 else
908 {
909 if (*p == '&')
910 {
911 ++p;
912 if (STRNCMP("l:", p, 2) == 0 || STRNCMP("g:", p, 2) == 0)
913 p += 2;
914 }
Bram Moolenaar65259b52021-11-23 14:52:06 +0000915 else if (*p == '$')
916 ++p;
Bram Moolenaar7d5b8be2021-11-22 15:05:46 +0000917 get_name_len(&p, &alias, FALSE, FALSE);
918 }
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200919 name_only = ends_excmd2(arg, skipwhite(p));
920 vim_free(alias);
921 return name_only;
922}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000923
924/*
Bram Moolenaar25e42232019-08-04 15:04:10 +0200925 * ":eval".
926 */
927 void
928ex_eval(exarg_T *eap)
929{
930 typval_T tv;
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200931 evalarg_T evalarg;
Bram Moolenaarc3235272021-07-10 19:42:03 +0200932 int name_only = FALSE;
Bram Moolenaarc3235272021-07-10 19:42:03 +0200933 long lnum = SOURCING_LNUM;
934
935 if (in_vim9script())
Bram Moolenaar4799cef2021-08-25 22:37:36 +0200936 name_only = cmd_is_name_only(eap->arg);
Bram Moolenaar25e42232019-08-04 15:04:10 +0200937
Bram Moolenaare6b53242020-07-01 17:28:33 +0200938 fill_evalarg_from_eap(&evalarg, eap, eap->skip);
Bram Moolenaar5409f5d2020-06-24 18:37:35 +0200939
Bram Moolenaarb171fb12020-06-24 20:34:03 +0200940 if (eval0(eap->arg, &tv, eap, &evalarg) == OK)
Bram Moolenaarc3235272021-07-10 19:42:03 +0200941 {
Bram Moolenaar25e42232019-08-04 15:04:10 +0200942 clear_tv(&tv);
Bram Moolenaarc3235272021-07-10 19:42:03 +0200943 if (in_vim9script() && name_only && lnum == SOURCING_LNUM)
944 semsg(_(e_expression_without_effect_str), eap->arg);
945 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +0200946
947 clear_evalarg(&evalarg, eap);
Bram Moolenaar25e42232019-08-04 15:04:10 +0200948}
949
950/*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200951 * Start a new scope/block. Caller should have checked that cs_idx is not
952 * exceeding CSTACK_LEN.
953 */
954 static void
955enter_block(cstack_T *cstack)
956{
957 ++cstack->cs_idx;
Bram Moolenaar0abc6e42021-02-26 22:21:23 +0100958 if (in_vim9script() && current_sctx.sc_sid > 0)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200959 {
960 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
961
962 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
Bram Moolenaarfbbcd002020-10-15 12:46:44 +0200963 cstack->cs_block_id[cstack->cs_idx] = ++si->sn_last_block_id;
964 si->sn_current_block_id = si->sn_last_block_id;
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200965 }
Bram Moolenaar3e492c22021-01-27 21:37:13 +0100966 else
967 {
968 // Just in case in_vim9script() does not return the same value when the
969 // block ends.
970 cstack->cs_script_var_len[cstack->cs_idx] = 0;
971 cstack->cs_block_id[cstack->cs_idx] = 0;
972 }
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200973}
974
975 static void
976leave_block(cstack_T *cstack)
977{
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200978 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200979 {
Bram Moolenaard7475482020-10-10 20:31:37 +0200980 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200981 int i;
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200982 int func_defined =
983 cstack->cs_flags[cstack->cs_idx] & CSF_FUNC_DEF;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200984
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200985 for (i = cstack->cs_script_var_len[cstack->cs_idx];
Bram Moolenaard7475482020-10-10 20:31:37 +0200986 i < si->sn_var_vals.ga_len; ++i)
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200987 {
988 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
Bram Moolenaard7475482020-10-10 20:31:37 +0200989
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200990 // sv_name is set to NULL if it was already removed. This happens
991 // when it was defined in an inner block and no functions were
992 // defined there.
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200993 if (sv->sv_name != NULL)
994 // Remove a variable declared inside the block, if it still
Bram Moolenaar39ca4122020-10-20 14:25:07 +0200995 // exists, from sn_vars and move the value into sn_all_vars
996 // if "func_defined" is non-zero.
997 hide_script_var(si, i, func_defined);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +0200998 }
Bram Moolenaar8d739de2020-10-14 19:39:19 +0200999
Bram Moolenaarfbbcd002020-10-15 12:46:44 +02001000 if (cstack->cs_idx == 0)
1001 si->sn_current_block_id = 0;
1002 else
1003 si->sn_current_block_id = cstack->cs_block_id[cstack->cs_idx - 1];
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001004 }
1005 --cstack->cs_idx;
1006}
1007
1008/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001009 * ":if".
1010 */
1011 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001012ex_if(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013{
1014 int error;
1015 int skip;
1016 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001017 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018
1019 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001020 eap->errmsg = _(e_if_nesting_too_deep);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 else
1022 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001023 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001024 cstack->cs_flags[cstack->cs_idx] = 0;
1025
1026 /*
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001027 * Don't do something after an error, interrupt, or throw, or when
1028 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001029 */
1030 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1031 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1032
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001033 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001034
1035 if (!skip && !error)
1036 {
1037 if (result)
1038 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1039 }
1040 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001041 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001042 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1043 }
1044}
1045
1046/*
1047 * ":endif".
1048 */
1049 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001050ex_endif(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051{
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001052 cstack_T *cstack = eap->cstack;
1053
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001054 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001055 return;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001056 did_endif = TRUE;
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001057 if (cstack->cs_idx < 0
1058 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001059 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001060 eap->errmsg = _(e_endif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061 else
1062 {
1063 /*
1064 * When debugging or a breakpoint was encountered, display the debug
1065 * prompt (if not already done). This shows the user that an ":endif"
1066 * is executed when the ":if" or a previous ":elseif" was not TRUE.
1067 * Handle a ">quit" debug command as if an interrupt had occurred before
1068 * the ":endif". That is, throw an interrupt exception if appropriate.
1069 * Doing this here prevents an exception for a parsing error being
1070 * discarded by throwing the interrupt exception later on.
1071 */
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001072 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00001073 && dbg_check_skipped(eap))
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001074 (void)do_intthrow(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001076 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077 }
1078}
1079
1080/*
1081 * ":else" and ":elseif".
1082 */
1083 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001084ex_else(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001085{
1086 int error;
1087 int skip;
1088 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001089 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001090
1091 /*
1092 * Don't do something after an error, interrupt, or throw, or when there is
1093 * a surrounding conditional and it was not active.
1094 */
1095 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1096 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1097
1098 if (cstack->cs_idx < 0
Bram Moolenaar12805862005-01-05 22:16:17 +00001099 || (cstack->cs_flags[cstack->cs_idx]
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001100 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 {
1102 if (eap->cmdidx == CMD_else)
1103 {
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001104 eap->errmsg = _(e_else_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001105 return;
1106 }
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001107 eap->errmsg = _(e_elseif_without_if);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 skip = TRUE;
1109 }
1110 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
1111 {
1112 if (eap->cmdidx == CMD_else)
1113 {
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001114 eap->errmsg = _(e_multiple_else);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001115 return;
1116 }
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001117 eap->errmsg = _(e_elseif_after_else);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001118 skip = TRUE;
1119 }
1120
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001121 // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001122 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
1123 {
1124 if (eap->errmsg == NULL)
1125 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001126 skip = TRUE; // don't evaluate an ":elseif"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001127 }
1128 else
1129 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1130
1131 /*
1132 * When debugging or a breakpoint was encountered, display the debug prompt
1133 * (if not already done). This shows the user that an ":else" or ":elseif"
1134 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle
1135 * a ">quit" debug command as if an interrupt had occurred before the
1136 * ":else" or ":elseif". That is, set "skip" and throw an interrupt
1137 * exception if appropriate. Doing this here prevents that an exception
1138 * for a parsing errors is discarded when throwing the interrupt exception
1139 * later on.
1140 */
1141 if (!skip && dbg_check_skipped(eap) && got_int)
1142 {
1143 (void)do_intthrow(cstack);
1144 skip = TRUE;
1145 }
1146
1147 if (eap->cmdidx == CMD_elseif)
1148 {
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001149 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001150
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001151 // When throwing error exceptions, we want to throw always the first
1152 // of several errors in a row. This is what actually happens when
1153 // a conditional error was detected above and there is another failure
1154 // when parsing the expression. Since the skip flag is set in this
1155 // case, the parsing error will be ignored by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +00001156 if (!skip && !error)
1157 {
1158 if (result)
1159 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1160 else
1161 cstack->cs_flags[cstack->cs_idx] = 0;
1162 }
1163 else if (eap->errmsg == NULL)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001164 // set TRUE, so this conditional will never get active
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1166 }
1167 else
1168 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1169}
1170
1171/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001172 * Handle ":while" and ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 */
1174 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001175ex_while(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176{
1177 int error;
1178 int skip;
1179 int result;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001180 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001181
1182 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001183 eap->errmsg = _(e_while_for_nesting_too_deep);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001184 else
1185 {
1186 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001187 * The loop flag is set when we have jumped back from the matching
1188 * ":endwhile" or ":endfor". When not set, need to initialise this
1189 * cstack entry.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001190 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001191 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001192 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001193 enter_block(cstack);
Bram Moolenaar12805862005-01-05 22:16:17 +00001194 ++cstack->cs_looplevel;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001195 cstack->cs_line[cstack->cs_idx] = -1;
1196 }
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001197 else
1198 {
1199 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
1200 {
1201 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
1202 int i;
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001203 int func_defined = cstack->cs_flags[cstack->cs_idx]
1204 & CSF_FUNC_DEF;
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001205
1206 // Any variables defined in the previous round are no longer
Bram Moolenaar7a53f292021-11-22 18:31:02 +00001207 // visible. Keep the first one for ":for", it is the loop
1208 // variable that we reuse every time around.
1209 for (i = cstack->cs_script_var_len[cstack->cs_idx]
1210 + (eap->cmdidx == CMD_while ? 0 : 1);
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001211 i < si->sn_var_vals.ga_len; ++i)
1212 {
1213 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
1214
1215 // sv_name is set to NULL if it was already removed. This
1216 // happens when it was defined in an inner block and no
1217 // functions were defined there.
1218 if (sv->sv_name != NULL)
1219 // Remove a variable declared inside the block, if it
1220 // still exists, from sn_vars.
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001221 hide_script_var(si, i, func_defined);
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001222 }
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001223 }
1224 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001225 cstack->cs_flags[cstack->cs_idx] =
1226 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001227
1228 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001229 * Don't do something after an error, interrupt, or throw, or when
1230 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 */
1232 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1233 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
Bram Moolenaar12805862005-01-05 22:16:17 +00001234 if (eap->cmdidx == CMD_while)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001235 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001236 /*
1237 * ":while bool-expr"
1238 */
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001239 result = eval_to_bool(eap->arg, &error, eap, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001240 }
1241 else
1242 {
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001243 void *fi;
1244 evalarg_T evalarg;
1245
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001246 /*
1247 * ":for var in list-expr"
1248 */
Bram Moolenaar2eb6fc32021-07-25 14:13:53 +02001249 fill_evalarg_from_eap(&evalarg, eap, skip);
Bram Moolenaar12805862005-01-05 22:16:17 +00001250 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
1251 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001252 // Jumping here from a ":continue" or ":endfor": use the
1253 // previously evaluated list.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001254 fi = cstack->cs_forinfo[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001255 error = FALSE;
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001256
1257 // the "in expr" is not used, skip over it
1258 skip_for_lines(fi, &evalarg);
Bram Moolenaar12805862005-01-05 22:16:17 +00001259 }
1260 else
1261 {
Bram Moolenaard4ab8072021-07-08 19:22:12 +02001262 long save_lnum = SOURCING_LNUM;
1263
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001264 // Evaluate the argument and get the info in a structure.
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001265 fi = eval_for_line(eap->arg, &error, eap, &evalarg);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001266 cstack->cs_forinfo[cstack->cs_idx] = fi;
Bram Moolenaard4ab8072021-07-08 19:22:12 +02001267
1268 // Errors should use the first line number.
1269 SOURCING_LNUM = save_lnum;
Bram Moolenaar12805862005-01-05 22:16:17 +00001270 }
1271
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001272 // use the element at the start of the list and advance
Bram Moolenaar12805862005-01-05 22:16:17 +00001273 if (!error && fi != NULL && !skip)
1274 result = next_for_item(fi, eap->arg);
1275 else
1276 result = FALSE;
1277
1278 if (!result)
1279 {
1280 free_for_info(fi);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001281 cstack->cs_forinfo[cstack->cs_idx] = NULL;
Bram Moolenaar12805862005-01-05 22:16:17 +00001282 }
Bram Moolenaarb7a78f72020-06-28 18:43:40 +02001283 clear_evalarg(&evalarg, eap);
Bram Moolenaar12805862005-01-05 22:16:17 +00001284 }
1285
1286 /*
1287 * If this cstack entry was just initialised and is active, set the
1288 * loop flag, so do_cmdline() will set the line number in cs_line[].
1289 * If executing the command a second time, clear the loop flag.
1290 */
1291 if (!skip && !error && result)
1292 {
1293 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
1294 cstack->cs_lflags ^= CSL_HAD_LOOP;
1295 }
1296 else
1297 {
1298 cstack->cs_lflags &= ~CSL_HAD_LOOP;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001299 // If the ":while" evaluates to FALSE or ":for" is past the end of
1300 // the list, show the debug prompt at the ":endwhile"/":endfor" as
1301 // if there was a ":break" in a ":while"/":for" evaluating to
1302 // TRUE.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001303 if (!skip && !error)
1304 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1305 }
1306 }
1307}
1308
1309/*
1310 * ":continue"
1311 */
1312 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001313ex_continue(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314{
1315 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001316 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317
Bram Moolenaar12805862005-01-05 22:16:17 +00001318 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar3a846e62022-01-01 16:21:00 +00001319 eap->errmsg = _(e_continue_without_while_or_for);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001320 else
1321 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001322 // Try to find the matching ":while". This might stop at a try
1323 // conditional not in its finally clause (which is then to be executed
Bram Moolenaarc3235272021-07-10 19:42:03 +02001324 // next). Therefore, inactivate all conditionals except the ":while"
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001325 // itself (if reached).
Bram Moolenaar12805862005-01-05 22:16:17 +00001326 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001327 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001328 {
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001329 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001330
1331 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001332 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001333 * matching ":while".
1334 */
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001335 cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it
Bram Moolenaar071d4272004-06-13 20:20:40 +00001336 }
1337 else
1338 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001339 // If a try conditional not in its finally clause is reached first,
1340 // make the ":continue" pending for execution at the ":endtry".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 cstack->cs_pending[idx] = CSTP_CONTINUE;
1342 report_make_pending(CSTP_CONTINUE, NULL);
1343 }
1344 }
1345}
1346
1347/*
1348 * ":break"
1349 */
1350 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001351ex_break(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001352{
1353 int idx;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001354 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001355
Bram Moolenaar12805862005-01-05 22:16:17 +00001356 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar3a846e62022-01-01 16:21:00 +00001357 eap->errmsg = _(e_break_without_while_or_for);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001358 else
1359 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001360 // Inactivate conditionals until the matching ":while" or a try
1361 // conditional not in its finally clause (which is then to be
1362 // executed next) is found. In the latter case, make the ":break"
1363 // pending for execution at the ":endtry".
Bram Moolenaar12805862005-01-05 22:16:17 +00001364 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001365 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 {
1367 cstack->cs_pending[idx] = CSTP_BREAK;
1368 report_make_pending(CSTP_BREAK, NULL);
1369 }
1370 }
1371}
1372
1373/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001374 * ":endwhile" and ":endfor"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001375 */
1376 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001377ex_endwhile(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001378{
Bram Moolenaarddef1292019-12-16 17:10:33 +01001379 cstack_T *cstack = eap->cstack;
1380 int idx;
1381 char *err;
1382 int csf;
1383 int fl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001385 if (cmdmod_error(TRUE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001386 return;
1387
Bram Moolenaar12805862005-01-05 22:16:17 +00001388 if (eap->cmdidx == CMD_endwhile)
1389 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001390 err = e_endwhile_without_while;
Bram Moolenaar12805862005-01-05 22:16:17 +00001391 csf = CSF_WHILE;
1392 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001393 else
1394 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001395 err = e_endfor_without_for;
Bram Moolenaar12805862005-01-05 22:16:17 +00001396 csf = CSF_FOR;
1397 }
1398
1399 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001400 eap->errmsg = _(err);
Bram Moolenaar12805862005-01-05 22:16:17 +00001401 else
1402 {
Bram Moolenaarcce81e92021-10-06 22:08:11 +01001403 fl = cstack->cs_flags[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001404 if (!(fl & csf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001406 // If we are in a ":while" or ":for" but used the wrong endloop
1407 // command, do not rewind to the next enclosing ":for"/":while".
Bram Moolenaar12805862005-01-05 22:16:17 +00001408 if (fl & CSF_WHILE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001409 eap->errmsg = _("E732: Using :endfor with :while");
Bram Moolenaar12805862005-01-05 22:16:17 +00001410 else if (fl & CSF_FOR)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001411 eap->errmsg = _("E733: Using :endwhile with :for");
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00001412 }
1413 if (!(fl & (CSF_WHILE | CSF_FOR)))
1414 {
1415 if (!(fl & CSF_TRY))
Bram Moolenaar1a992222021-12-31 17:25:48 +00001416 eap->errmsg = _(e_missing_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00001417 else if (fl & CSF_FINALLY)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001418 eap->errmsg = _(e_missing_endtry);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001419 // Try to find the matching ":while" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001420 for (idx = cstack->cs_idx; idx > 0; --idx)
1421 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001422 fl = cstack->cs_flags[idx];
1423 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001425 // Give up at a try conditional not in its finally clause.
1426 // Ignore the ":endwhile"/":endfor".
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001427 eap->errmsg = _(err);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 return;
1429 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001430 if (fl & csf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 break;
1432 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001433 // Cleanup and rewind all contained (and unclosed) conditionals.
Bram Moolenaar12805862005-01-05 22:16:17 +00001434 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001435 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1436 }
1437
1438 /*
1439 * When debugging or a breakpoint was encountered, display the debug
1440 * prompt (if not already done). This shows the user that an
Bram Moolenaar12805862005-01-05 22:16:17 +00001441 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
1442 * after a ":break". Handle a ">quit" debug command as if an
1443 * interrupt had occurred before the ":endwhile"/":endfor". That is,
1444 * throw an interrupt exception if appropriate. Doing this here
1445 * prevents that an exception for a parsing error is discarded when
1446 * throwing the interrupt exception later on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001447 */
1448 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1449 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1450 && dbg_check_skipped(eap))
1451 (void)do_intthrow(cstack);
1452
Bram Moolenaar522eefd2021-03-26 18:49:22 +01001453 // Set loop flag, so do_cmdline() will jump back to the matching
1454 // ":while" or ":for".
Bram Moolenaar12805862005-01-05 22:16:17 +00001455 cstack->cs_lflags |= CSL_HAD_ENDLOOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 }
1457}
1458
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001459/*
1460 * "{" start of a block in Vim9 script
1461 */
1462 void
1463ex_block(exarg_T *eap)
1464{
1465 cstack_T *cstack = eap->cstack;
1466
1467 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar1d423ef2022-01-02 21:26:16 +00001468 eap->errmsg = _(e_block_nesting_too_deep);
Bram Moolenaar9becdf22020-10-10 21:33:48 +02001469 else
1470 {
1471 enter_block(cstack);
1472 cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE;
1473 }
1474}
1475
1476/*
1477 * "}" end of a block in Vim9 script
1478 */
1479 void
1480ex_endblock(exarg_T *eap)
1481{
1482 cstack_T *cstack = eap->cstack;
1483
1484 if (cstack->cs_idx < 0
1485 || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0)
1486 eap->errmsg = _(e_endblock_without_block);
1487 else
1488 leave_block(cstack);
1489}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490
Bram Moolenaar63b91732021-08-05 20:40:03 +02001491 int
1492inside_block(exarg_T *eap)
1493{
1494 cstack_T *cstack = eap->cstack;
1495 int i;
1496
1497 for (i = 0; i <= cstack->cs_idx; ++i)
1498 if (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK)
1499 return TRUE;
1500 return FALSE;
1501}
1502
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503/*
1504 * ":throw expr"
1505 */
1506 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001507ex_throw(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508{
1509 char_u *arg = eap->arg;
1510 char_u *value;
1511
1512 if (*arg != NUL && *arg != '|' && *arg != '\n')
Bram Moolenaarb171fb12020-06-24 20:34:03 +02001513 value = eval_to_string_skip(arg, eap, eap->skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514 else
1515 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001516 emsg(_(e_argument_required));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001517 value = NULL;
1518 }
1519
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001520 // On error or when an exception is thrown during argument evaluation, do
1521 // not throw.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 if (!eap->skip && value != NULL)
1523 {
1524 if (throw_exception(value, ET_USER, NULL) == FAIL)
1525 vim_free(value);
1526 else
1527 do_throw(eap->cstack);
1528 }
1529}
1530
1531/*
Bram Moolenaar269ec652004-07-29 08:43:53 +00001532 * Throw the current exception through the specified cstack. Common routine
1533 * for ":throw" (user exception) and error and interrupt exceptions. Also
1534 * used for rethrowing an uncaught exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535 */
1536 void
Bram Moolenaarddef1292019-12-16 17:10:33 +01001537do_throw(cstack_T *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538{
1539 int idx;
1540 int inactivate_try = FALSE;
1541
1542 /*
1543 * Cleanup and inactivate up to the next surrounding try conditional that
1544 * is not in its finally clause. Normally, do not inactivate the try
1545 * conditional itself, so that its ACTIVE flag can be tested below. But
1546 * if a previous error or interrupt has not been converted to an exception,
1547 * inactivate the try conditional, too, as if the conversion had been done,
Bram Moolenaar269ec652004-07-29 08:43:53 +00001548 * and reset the did_emsg or got_int flag, so this won't happen again at
1549 * the next surrounding try conditional.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001550 */
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001551#ifndef THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001552 if (did_emsg && !THROW_ON_ERROR)
1553 {
1554 inactivate_try = TRUE;
1555 did_emsg = FALSE;
1556 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001557#endif
1558#ifndef THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 if (got_int && !THROW_ON_INTERRUPT)
1560 {
1561 inactivate_try = TRUE;
1562 got_int = FALSE;
1563 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001564#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001565 idx = cleanup_conditionals(cstack, 0, inactivate_try);
1566 if (idx >= 0)
1567 {
1568 /*
1569 * If this try conditional is active and we are before its first
Bram Moolenaar269ec652004-07-29 08:43:53 +00001570 * ":catch", set THROWN so that the ":catch" commands will check
1571 * whether the exception matches. When the exception came from any of
1572 * the catch clauses, it will be made pending at the ":finally" (if
1573 * present) and rethrown at the ":endtry". This will also happen if
1574 * the try conditional is inactive. This is the case when we are
1575 * throwing an exception due to an error or interrupt on the way from
1576 * a preceding ":continue", ":break", ":return", ":finish", error or
1577 * interrupt (not converted to an exception) to the finally clause or
1578 * from a preceding throw of a user or error or interrupt exception to
1579 * the matching catch clause or the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 */
1581 if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1582 {
1583 if (cstack->cs_flags[idx] & CSF_ACTIVE)
1584 cstack->cs_flags[idx] |= CSF_THROWN;
1585 else
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001586 // THROWN may have already been set for a catchable exception
1587 // that has been discarded. Ensure it is reset for the new
1588 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001589 cstack->cs_flags[idx] &= ~CSF_THROWN;
1590 }
1591 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1592 cstack->cs_exception[idx] = current_exception;
1593 }
1594#if 0
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001595 // TODO: Add optimization below. Not yet done because of interface
1596 // problems to eval.c and ex_cmds2.c. (Servatius)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 else
1598 {
1599 /*
1600 * There are no catch clauses to check or finally clauses to execute.
1601 * End the current script or function. The exception will be rethrown
1602 * in the caller.
1603 */
1604 if (getline_equal(eap->getline, eap->cookie, get_func_line))
1605 current_funccal->returned = TRUE;
1606 elseif (eap->get_func_line == getsourceline)
1607 ((struct source_cookie *)eap->cookie)->finished = TRUE;
1608 }
1609#endif
1610
1611 did_throw = TRUE;
1612}
1613
1614/*
1615 * ":try"
1616 */
1617 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001618ex_try(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001619{
1620 int skip;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001621 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001622
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001623 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001624 return;
1625
Bram Moolenaar071d4272004-06-13 20:20:40 +00001626 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001627 eap->errmsg = _("E601: :try nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 else
1629 {
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02001630 enter_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001631 ++cstack->cs_trylevel;
1632 cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1633 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1634
1635 /*
1636 * Don't do something after an error, interrupt, or throw, or when there
1637 * is a surrounding conditional and it was not active.
1638 */
1639 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1640 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1641
1642 if (!skip)
1643 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001644 // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch"
1645 // commands should check for a match if an exception is thrown and
1646 // that the finally clause needs to be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1648
1649 /*
1650 * ":silent!", even when used in a try conditional, disables
1651 * displaying of error messages and conversion of errors to
1652 * exceptions. When the silent commands again open a try
1653 * conditional, save "emsg_silent" and reset it so that errors are
1654 * again converted to exceptions. The value is restored when that
1655 * try conditional is left. If it is left normally, the commands
1656 * following the ":endtry" are again silent. If it is left by
1657 * a ":continue", ":break", ":return", or ":finish", the commands
1658 * executed next are again silent. If it is left due to an
1659 * aborting error, an interrupt, or an exception, restoring
1660 * "emsg_silent" does not matter since we are already in the
1661 * aborting state and/or the exception has already been thrown.
1662 * The effect is then just freeing the memory that was allocated
1663 * to save the value.
1664 */
1665 if (emsg_silent)
1666 {
1667 eslist_T *elem;
1668
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001669 elem = ALLOC_ONE(struct eslist_elem);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 if (elem == NULL)
Bram Moolenaare29a27f2021-07-20 21:07:36 +02001671 emsg(_(e_out_of_memory));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 else
1673 {
1674 elem->saved_emsg_silent = emsg_silent;
1675 elem->next = cstack->cs_emsg_silent_list;
1676 cstack->cs_emsg_silent_list = elem;
1677 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1678 emsg_silent = 0;
1679 }
1680 }
1681 }
1682
1683 }
1684}
1685
1686/*
1687 * ":catch /{pattern}/" and ":catch"
1688 */
1689 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001690ex_catch(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691{
1692 int idx = 0;
1693 int give_up = FALSE;
1694 int skip = FALSE;
1695 int caught = FALSE;
1696 char_u *end;
1697 int save_char = 0;
1698 char_u *save_cpo;
1699 regmatch_T regmatch;
1700 int prev_got_int;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001701 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001702 char_u *pat;
1703
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001704 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001705 return;
1706
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1708 {
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001709 eap->errmsg = _(e_catch_without_try);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 give_up = TRUE;
1711 }
1712 else
1713 {
1714 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1715 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001716 // Report what's missing if the matching ":try" is not in its
1717 // finally clause.
Bram Moolenaar12805862005-01-05 22:16:17 +00001718 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001719 skip = TRUE;
1720 }
1721 for (idx = cstack->cs_idx; idx > 0; --idx)
1722 if (cstack->cs_flags[idx] & CSF_TRY)
1723 break;
Bram Moolenaar41978282021-07-04 14:47:30 +02001724 if (cstack->cs_flags[idx] & CSF_TRY)
1725 cstack->cs_flags[idx] |= CSF_CATCH;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 if (cstack->cs_flags[idx] & CSF_FINALLY)
1727 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001728 // Give up for a ":catch" after ":finally" and ignore it.
1729 // Just parse.
Bram Moolenaar8930caa2020-07-23 16:37:03 +02001730 eap->errmsg = _("E604: :catch after :finally");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731 give_up = TRUE;
1732 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001733 else
Bram Moolenaar12805862005-01-05 22:16:17 +00001734 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1735 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001736 }
1737
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001738 if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors
Bram Moolenaar071d4272004-06-13 20:20:40 +00001739 {
1740 pat = (char_u *)".*";
1741 end = NULL;
1742 eap->nextcmd = find_nextcmd(eap->arg);
1743 }
1744 else
1745 {
1746 pat = eap->arg + 1;
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001747 end = skip_regexp_err(pat, *eap->arg, TRUE);
1748 if (end == NULL)
1749 give_up = TRUE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001750 }
1751
1752 if (!give_up)
1753 {
1754 /*
1755 * Don't do something when no exception has been thrown or when the
1756 * corresponding try block never got active (because of an inactive
1757 * surrounding conditional or after an error or interrupt or throw).
1758 */
1759 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1760 skip = TRUE;
1761
1762 /*
1763 * Check for a match only if an exception is thrown but not caught by
1764 * a previous ":catch". An exception that has replaced a discarded
1765 * exception is not checked (THROWN is not set then).
1766 */
1767 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1768 && !(cstack->cs_flags[idx] & CSF_CAUGHT))
1769 {
Bram Moolenaar2c5ed4e2020-04-20 19:42:10 +02001770 if (end != NULL && *end != NUL
1771 && !ends_excmd2(end, skipwhite(end + 1)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 {
Bram Moolenaar74409f62022-01-01 15:58:22 +00001773 semsg(_(e_trailing_characters_str), end);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 return;
1775 }
1776
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001777 // When debugging or a breakpoint was encountered, display the
1778 // debug prompt (if not already done) before checking for a match.
1779 // This is a helpful hint for the user when the regular expression
1780 // matching fails. Handle a ">quit" debug command as if an
1781 // interrupt had occurred before the ":catch". That is, discard
1782 // the original exception, replace it by an interrupt exception,
1783 // and don't catch it in this try block.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1785 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001786 // Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1787 // while compiling it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001788 if (end != NULL)
1789 {
1790 save_char = *end;
1791 *end = NUL;
1792 }
1793 save_cpo = p_cpo;
Bram Moolenaare5a2dc82021-01-03 19:52:05 +01001794 p_cpo = empty_option;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001795 // Disable error messages, it will make current_exception
1796 // invalid.
Bram Moolenaar768ce242016-02-07 19:46:12 +01001797 ++emsg_off;
Bram Moolenaar150cc272007-08-01 13:47:46 +00001798 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
Bram Moolenaar768ce242016-02-07 19:46:12 +01001799 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 regmatch.rm_ic = FALSE;
1801 if (end != NULL)
1802 *end = save_char;
1803 p_cpo = save_cpo;
1804 if (regmatch.regprog == NULL)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001805 semsg(_(e_invalid_argument_str), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 else
1807 {
1808 /*
1809 * Save the value of got_int and reset it. We don't want
1810 * a previous interruption cancel matching, only hitting
1811 * CTRL-C while matching should abort it.
1812 */
1813 prev_got_int = got_int;
1814 got_int = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001815 caught = vim_regexec_nl(&regmatch,
1816 (char_u *)current_exception->value, (colnr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 got_int |= prev_got_int;
Bram Moolenaar473de612013-06-08 18:19:48 +02001818 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 }
1820 }
1821 }
1822
1823 if (caught)
1824 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001825 // Make this ":catch" clause active and reset did_emsg, got_int,
1826 // and did_throw. Put the exception on the caught stack.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1828 did_emsg = got_int = did_throw = FALSE;
1829 catch_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001830 // It's mandatory that the current exception is stored in the cstack
1831 // so that it can be discarded at the next ":catch", ":finally", or
1832 // ":endtry" or when the catch clause is left by a ":continue",
1833 // ":break", ":return", ":finish", error, interrupt, or another
1834 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001835 if (cstack->cs_exception[cstack->cs_idx] != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001836 internal_error("ex_catch()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 }
1838 else
1839 {
1840 /*
1841 * If there is a preceding catch clause and it caught the exception,
1842 * finish the exception now. This happens also after errors except
1843 * when this ":catch" was after the ":finally" or not within
1844 * a ":try". Make the try conditional inactive so that the
1845 * following catch clauses are skipped. On an error or interrupt
1846 * after the preceding try block or catch clause was left by
1847 * a ":continue", ":break", ":return", or ":finish", discard the
1848 * pending action.
1849 */
1850 cleanup_conditionals(cstack, CSF_TRY, TRUE);
1851 }
1852 }
1853
1854 if (end != NULL)
1855 eap->nextcmd = find_nextcmd(end);
1856}
1857
1858/*
1859 * ":finally"
1860 */
1861 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001862ex_finally(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001863{
1864 int idx;
1865 int skip = FALSE;
1866 int pending = CSTP_NONE;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001867 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001868
Bram Moolenaar917c46a2021-08-10 19:53:01 +02001869 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01001870 return;
1871
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001873 eap->errmsg = _(e_finally_without_try);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001874 else
1875 {
1876 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1877 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001878 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1880 if (cstack->cs_flags[idx] & CSF_TRY)
1881 break;
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001882 // Make this error pending, so that the commands in the following
1883 // finally clause can be executed. This overrules also a pending
1884 // ":continue", ":break", ":return", or ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001885 pending = CSTP_ERROR;
1886 }
1887 else
1888 idx = cstack->cs_idx;
1889
1890 if (cstack->cs_flags[idx] & CSF_FINALLY)
1891 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001892 // Give up for a multiple ":finally" and ignore it.
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00001893 eap->errmsg = _(e_multiple_finally);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001894 return;
1895 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001896 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
Bram Moolenaar12805862005-01-05 22:16:17 +00001897 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898
1899 /*
1900 * Don't do something when the corresponding try block never got active
1901 * (because of an inactive surrounding conditional or after an error or
1902 * interrupt or throw) or for a ":finally" without ":try" or a multiple
1903 * ":finally". After every other error (did_emsg or the conditional
1904 * errors detected above) or after an interrupt (got_int) or an
1905 * exception (did_throw), the finally clause must be executed.
1906 */
1907 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1908
1909 if (!skip)
1910 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001911 // When debugging or a breakpoint was encountered, display the
1912 // debug prompt (if not already done). The user then knows that the
1913 // finally clause is executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001914 if (dbg_check_skipped(eap))
1915 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001916 // Handle a ">quit" debug command as if an interrupt had
1917 // occurred before the ":finally". That is, discard the
1918 // original exception and replace it by an interrupt
1919 // exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001920 (void)do_intthrow(cstack);
1921 }
1922
1923 /*
1924 * If there is a preceding catch clause and it caught the exception,
1925 * finish the exception now. This happens also after errors except
1926 * when this is a multiple ":finally" or one not within a ":try".
1927 * After an error or interrupt, this also discards a pending
1928 * ":continue", ":break", ":finish", or ":return" from the preceding
1929 * try block or catch clause.
1930 */
1931 cleanup_conditionals(cstack, CSF_TRY, FALSE);
1932
1933 /*
1934 * Make did_emsg, got_int, did_throw pending. If set, they overrule
1935 * a pending ":continue", ":break", ":return", or ":finish". Then
1936 * we have particularly to discard a pending return value (as done
1937 * by the call to cleanup_conditionals() above when did_emsg or
1938 * got_int is set). The pending values are restored by the
1939 * ":endtry", except if there is a new error, interrupt, exception,
1940 * ":continue", ":break", ":return", or ":finish" in the following
Bram Moolenaar12805862005-01-05 22:16:17 +00001941 * finally clause. A missing ":endwhile", ":endfor" or ":endif"
1942 * detected here is treated as if did_emsg and did_throw had
1943 * already been set, respectively in case that the error is not
1944 * converted to an exception, did_throw had already been unset.
1945 * We must not set did_emsg here since that would suppress the
1946 * error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001947 */
1948 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1949 {
1950 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
1951 {
1952 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001953 cstack->cs_rettv[cstack->cs_idx]);
1954 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 }
1956 if (pending == CSTP_ERROR && !did_emsg)
1957 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
1958 else
1959 pending |= did_throw ? CSTP_THROW : 0;
1960 pending |= did_emsg ? CSTP_ERROR : 0;
1961 pending |= got_int ? CSTP_INTERRUPT : 0;
1962 cstack->cs_pending[cstack->cs_idx] = pending;
1963
Bram Moolenaar217e1b82019-12-01 21:41:28 +01001964 // It's mandatory that the current exception is stored in the
1965 // cstack so that it can be rethrown at the ":endtry" or be
1966 // discarded if the finally clause is left by a ":continue",
1967 // ":break", ":return", ":finish", error, interrupt, or another
1968 // exception. When emsg() is called for a missing ":endif" or
1969 // a missing ":endwhile"/":endfor" detected here, the
1970 // exception will be discarded.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001971 if (did_throw && cstack->cs_exception[cstack->cs_idx]
1972 != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001973 internal_error("ex_finally()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001974 }
1975
1976 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001977 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001978 * got_int, and did_throw and make the finally clause active.
1979 * This will happen after emsg() has been called for a missing
Bram Moolenaar12805862005-01-05 22:16:17 +00001980 * ":endif" or a missing ":endwhile"/":endfor" detected here, so
1981 * that the following finally clause will be executed even then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001983 cstack->cs_lflags |= CSL_HAD_FINA;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001984 }
1985 }
1986}
1987
1988/*
1989 * ":endtry"
1990 */
1991 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001992ex_endtry(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993{
1994 int idx;
1995 int skip;
1996 int rethrow = FALSE;
1997 int pending = CSTP_NONE;
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001998 void *rettv = NULL;
Bram Moolenaarddef1292019-12-16 17:10:33 +01001999 cstack_T *cstack = eap->cstack;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000
Bram Moolenaar917c46a2021-08-10 19:53:01 +02002001 if (cmdmod_error(FALSE))
Bram Moolenaarfa984412021-03-25 22:15:28 +01002002 return;
2003
Bram Moolenaar071d4272004-06-13 20:20:40 +00002004 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaar436b5ad2021-12-31 22:49:24 +00002005 eap->errmsg = _(e_endtry_without_try);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002006 else
2007 {
2008 /*
2009 * Don't do something after an error, interrupt or throw in the try
2010 * block, catch clause, or finally clause preceding this ":endtry" or
2011 * when an error or interrupt occurred after a ":continue", ":break",
2012 * ":return", or ":finish" in a try block or catch clause preceding this
2013 * ":endtry" or when the try block never got active (because of an
2014 * inactive surrounding conditional or after an error or interrupt or
2015 * throw) or when there is a surrounding conditional and it has been
2016 * made inactive by a ":continue", ":break", ":return", or ":finish" in
2017 * the finally clause. The latter case need not be tested since then
2018 * anything pending has already been discarded. */
Bram Moolenaar41978282021-07-04 14:47:30 +02002019 skip = did_emsg || got_int || did_throw
2020 || !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021
2022 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
2023 {
Bram Moolenaar12805862005-01-05 22:16:17 +00002024 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaarcce81e92021-10-06 22:08:11 +01002025
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002026 // Find the matching ":try" and report what's missing.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 idx = cstack->cs_idx;
2028 do
2029 --idx;
2030 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
Bram Moolenaar12805862005-01-05 22:16:17 +00002031 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
2032 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002033 skip = TRUE;
2034
2035 /*
2036 * If an exception is being thrown, discard it to prevent it from
2037 * being rethrown at the end of this function. It would be
2038 * discarded by the error message, anyway. Resets did_throw.
2039 * This does not affect the script termination due to the error
2040 * since "trylevel" is decremented after emsg() has been called.
2041 */
2042 if (did_throw)
2043 discard_current_exception();
Bram Moolenaarcce81e92021-10-06 22:08:11 +01002044
2045 // report eap->errmsg, also when there already was an error
2046 did_emsg = FALSE;
Bram Moolenaar071d4272004-06-13 20:20:40 +00002047 }
2048 else
2049 {
2050 idx = cstack->cs_idx;
2051
rbtnn84934992021-08-07 13:26:53 +02002052 // Check the flags only when not in a skipped block.
2053 if (!skip && in_vim9script()
Bram Moolenaar41978282021-07-04 14:47:30 +02002054 && (cstack->cs_flags[idx] & (CSF_CATCH|CSF_FINALLY)) == 0)
2055 {
2056 // try/endtry without any catch or finally: give an error and
2057 // continue.
2058 eap->errmsg = _(e_missing_catch_or_finally);
2059 }
2060
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 /*
2062 * If we stopped with the exception currently being thrown at this
2063 * try conditional since we didn't know that it doesn't have
2064 * a finally clause, we need to rethrow it after closing the try
2065 * conditional.
2066 */
2067 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
2068 && !(cstack->cs_flags[idx] & CSF_FINALLY))
2069 rethrow = TRUE;
2070 }
2071
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002072 // If there was no finally clause, show the user when debugging or
2073 // a breakpoint was encountered that the end of the try conditional has
2074 // been reached: display the debug prompt (if not already done). Do
2075 // this on normal control flow or when an exception was thrown, but not
2076 // on an interrupt or error not converted to an exception or when
2077 // a ":break", ":continue", ":return", or ":finish" is pending. These
2078 // actions are carried out immediately.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 if ((rethrow || (!skip
2080 && !(cstack->cs_flags[idx] & CSF_FINALLY)
2081 && !cstack->cs_pending[idx]))
2082 && dbg_check_skipped(eap))
2083 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002084 // Handle a ">quit" debug command as if an interrupt had occurred
2085 // before the ":endtry". That is, throw an interrupt exception and
2086 // set "skip" and "rethrow".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002087 if (got_int)
2088 {
2089 skip = TRUE;
2090 (void)do_intthrow(cstack);
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002091 // The do_intthrow() call may have reset did_throw or
2092 // cstack->cs_pending[idx].
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 rethrow = FALSE;
2094 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY))
2095 rethrow = TRUE;
2096 }
2097 }
2098
2099 /*
2100 * If a ":return" is pending, we need to resume it after closing the
2101 * try conditional; remember the return value. If there was a finally
2102 * clause making an exception pending, we need to rethrow it. Make it
2103 * the exception currently being thrown.
2104 */
2105 if (!skip)
2106 {
2107 pending = cstack->cs_pending[idx];
2108 cstack->cs_pending[idx] = CSTP_NONE;
2109 if (pending == CSTP_RETURN)
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002110 rettv = cstack->cs_rettv[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 else if (pending & CSTP_THROW)
2112 current_exception = cstack->cs_exception[idx];
2113 }
2114
2115 /*
2116 * Discard anything pending on an error, interrupt, or throw in the
2117 * finally clause. If there was no ":finally", discard a pending
2118 * ":continue", ":break", ":return", or ":finish" if an error or
2119 * interrupt occurred afterwards, but before the ":endtry" was reached.
2120 * If an exception was caught by the last of the catch clauses and there
2121 * was no finally clause, finish the exception now. This happens also
2122 * after errors except when this ":endtry" is not within a ":try".
2123 * Restore "emsg_silent" if it has been reset by this try conditional.
2124 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00002125 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126
Bram Moolenaarcce81e92021-10-06 22:08:11 +01002127 if (cstack->cs_idx >= 0
2128 && (cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
2129 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002130 --cstack->cs_trylevel;
2131
2132 if (!skip)
2133 {
2134 report_resume_pending(pending,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002135 (pending == CSTP_RETURN) ? rettv :
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2137 switch (pending)
2138 {
2139 case CSTP_NONE:
2140 break;
2141
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002142 // Reactivate a pending ":continue", ":break", ":return",
2143 // ":finish" from the try block or a catch clause of this try
2144 // conditional. This is skipped, if there was an error in an
2145 // (unskipped) conditional command or an interrupt afterwards
2146 // or if the finally clause is present and executed a new error,
2147 // interrupt, throw, ":continue", ":break", ":return", or
2148 // ":finish".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002149 case CSTP_CONTINUE:
2150 ex_continue(eap);
2151 break;
2152 case CSTP_BREAK:
2153 ex_break(eap);
2154 break;
2155 case CSTP_RETURN:
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002156 do_return(eap, FALSE, FALSE, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002157 break;
2158 case CSTP_FINISH:
2159 do_finish(eap, FALSE);
2160 break;
2161
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002162 // When the finally clause was entered due to an error,
2163 // interrupt or throw (as opposed to a ":continue", ":break",
2164 // ":return", or ":finish"), restore the pending values of
2165 // did_emsg, got_int, and did_throw. This is skipped, if there
2166 // was a new error, interrupt, throw, ":continue", ":break",
2167 // ":return", or ":finish". in the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 default:
2169 if (pending & CSTP_ERROR)
2170 did_emsg = TRUE;
2171 if (pending & CSTP_INTERRUPT)
2172 got_int = TRUE;
2173 if (pending & CSTP_THROW)
2174 rethrow = TRUE;
2175 break;
2176 }
2177 }
2178
2179 if (rethrow)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002180 // Rethrow the current exception (within this cstack).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002181 do_throw(cstack);
2182 }
2183}
2184
2185/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002186 * enter_cleanup() and leave_cleanup()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002187 *
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002188 * Functions to be called before/after invoking a sequence of autocommands for
2189 * cleanup for a failed command. (Failure means here that a call to emsg()
2190 * has been made, an interrupt occurred, or there is an uncaught exception
2191 * from a previous autocommand execution of the same command.)
2192 *
2193 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same
2194 * pointer to leave_cleanup(). The cleanup_T structure stores the pending
2195 * error/interrupt/exception state.
2196 */
2197
2198/*
2199 * This function works a bit like ex_finally() except that there was not
2200 * actually an extra try block around the part that failed and an error or
2201 * interrupt has not (yet) been converted to an exception. This function
2202 * saves the error/interrupt/ exception state and prepares for the call to
2203 * do_cmdline() that is going to be made for the cleanup autocommand
2204 * execution.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002205 */
2206 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002207enter_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002208{
2209 int pending = CSTP_NONE;
2210
2211 /*
2212 * Postpone did_emsg, got_int, did_throw. The pending values will be
2213 * restored by leave_cleanup() except if there was an aborting error,
2214 * interrupt, or uncaught exception after this function ends.
2215 */
2216 if (did_emsg || got_int || did_throw || need_rethrow)
2217 {
2218 csp->pending = (did_emsg ? CSTP_ERROR : 0)
2219 | (got_int ? CSTP_INTERRUPT : 0)
2220 | (did_throw ? CSTP_THROW : 0)
2221 | (need_rethrow ? CSTP_THROW : 0);
2222
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002223 // If we are currently throwing an exception (did_throw), save it as
2224 // well. On an error not yet converted to an exception, update
2225 // "force_abort" and reset "cause_abort" (as do_errthrow() would do).
2226 // This is needed for the do_cmdline() call that is going to be made
2227 // for autocommand execution. We need not save *msg_list because
2228 // there is an extra instance for every call of do_cmdline(), anyway.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002229 if (did_throw || need_rethrow)
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002230 {
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002231 csp->exception = current_exception;
Bram Moolenaarcae24be2017-07-10 22:12:10 +02002232 current_exception = NULL;
2233 }
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002234 else
2235 {
2236 csp->exception = NULL;
2237 if (did_emsg)
2238 {
2239 force_abort |= cause_abort;
2240 cause_abort = FALSE;
2241 }
2242 }
2243 did_emsg = got_int = did_throw = need_rethrow = FALSE;
2244
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002245 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002246 report_make_pending(pending, csp->exception);
2247 }
2248 else
2249 {
2250 csp->pending = CSTP_NONE;
2251 csp->exception = NULL;
2252 }
2253}
2254
2255/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002256 * See comment above enter_cleanup() for how this function is used.
2257 *
2258 * This function is a bit like ex_endtry() except that there was not actually
2259 * an extra try block around the part that failed and an error or interrupt
2260 * had not (yet) been converted to an exception when the cleanup autocommand
2261 * sequence was invoked.
2262 *
2263 * This function has to be called with the address of the cleanup_T structure
2264 * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2265 * exception state saved by that function - except there was an aborting
2266 * error, an interrupt or an uncaught exception during execution of the
2267 * cleanup autocommands. In the latter case, the saved error/interrupt/
2268 * exception state is discarded.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002269 */
2270 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002271leave_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002272{
2273 int pending = csp->pending;
2274
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002275 if (pending == CSTP_NONE) // nothing to do
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002276 return;
2277
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002278 // If there was an aborting error, an interrupt, or an uncaught exception
2279 // after the corresponding call to enter_cleanup(), discard what has been
2280 // made pending by it. Report this to the user if required by the
2281 // 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002282 if (aborting() || need_rethrow)
2283 {
2284 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002285 // Cancel the pending exception (includes report).
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002286 discard_exception((except_T *)csp->exception, FALSE);
2287 else
2288 report_discard_pending(pending, NULL);
2289
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002290 // If an error was about to be converted to an exception when
2291 // enter_cleanup() was called, free the message list.
Bram Moolenaar4632d292006-11-28 17:36:37 +00002292 if (msg_list != NULL)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +01002293 free_global_msglist();
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002294 }
2295
2296 /*
2297 * If there was no new error, interrupt, or throw between the calls
2298 * to enter_cleanup() and leave_cleanup(), restore the pending
2299 * error/interrupt/exception state.
2300 */
2301 else
2302 {
2303 /*
2304 * If there was an exception being thrown when enter_cleanup() was
2305 * called, we need to rethrow it. Make it the exception currently
2306 * being thrown.
2307 */
2308 if (pending & CSTP_THROW)
2309 current_exception = csp->exception;
2310
2311 /*
2312 * If an error was about to be converted to an exception when
2313 * enter_cleanup() was called, let "cause_abort" take the part of
2314 * "force_abort" (as done by cause_errthrow()).
2315 */
2316 else if (pending & CSTP_ERROR)
2317 {
2318 cause_abort = force_abort;
2319 force_abort = FALSE;
2320 }
2321
2322 /*
2323 * Restore the pending values of did_emsg, got_int, and did_throw.
2324 */
2325 if (pending & CSTP_ERROR)
2326 did_emsg = TRUE;
2327 if (pending & CSTP_INTERRUPT)
2328 got_int = TRUE;
2329 if (pending & CSTP_THROW)
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002330 need_rethrow = TRUE; // did_throw will be set by do_one_cmd()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002331
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002332 // Report if required by the 'verbose' option or when debugging.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002333 report_resume_pending(pending,
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002334 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002335 }
2336}
2337
2338
2339/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002340 * Make conditionals inactive and discard what's pending in finally clauses
2341 * until the conditional type searched for or a try conditional not in its
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002342 * finally clause is reached. If this is in an active catch clause, finish
2343 * the caught exception.
2344 * Return the cstack index where the search stopped.
Bram Moolenaar12805862005-01-05 22:16:17 +00002345 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
2346 * the latter meaning the innermost try conditional not in its finally clause.
2347 * "inclusive" tells whether the conditional searched for should be made
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002348 * inactive itself (a try conditional not in its finally clause possibly find
Bram Moolenaar12805862005-01-05 22:16:17 +00002349 * before is always made inactive). If "inclusive" is TRUE and
2350 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
2351 * "emsg_silent", if reset when the try conditional finally reached was
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002352 * entered, is restored (used by ex_endtry()). This is normally done only
Bram Moolenaar12805862005-01-05 22:16:17 +00002353 * when such a try conditional is left.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 */
2355 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002356cleanup_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002357 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002358 int searched_cond,
2359 int inclusive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002360{
2361 int idx;
2362 int stop = FALSE;
2363
2364 for (idx = cstack->cs_idx; idx >= 0; --idx)
2365 {
2366 if (cstack->cs_flags[idx] & CSF_TRY)
2367 {
2368 /*
2369 * Discard anything pending in a finally clause and continue the
2370 * search. There may also be a pending ":continue", ":break",
2371 * ":return", or ":finish" before the finally clause. We must not
2372 * discard it, unless an error or interrupt occurred afterwards.
2373 */
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002374 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002375 {
2376 switch (cstack->cs_pending[idx])
2377 {
2378 case CSTP_NONE:
2379 break;
2380
2381 case CSTP_CONTINUE:
2382 case CSTP_BREAK:
2383 case CSTP_FINISH:
2384 report_discard_pending(cstack->cs_pending[idx], NULL);
2385 cstack->cs_pending[idx] = CSTP_NONE;
2386 break;
2387
2388 case CSTP_RETURN:
2389 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002390 cstack->cs_rettv[idx]);
2391 discard_pending_return(cstack->cs_rettv[idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 cstack->cs_pending[idx] = CSTP_NONE;
2393 break;
2394
2395 default:
2396 if (cstack->cs_flags[idx] & CSF_FINALLY)
2397 {
Bram Moolenaara684a682021-10-04 18:52:19 +01002398 if ((cstack->cs_pending[idx] & CSTP_THROW)
2399 && cstack->cs_exception[idx] != NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002400 {
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002401 // Cancel the pending exception. This is in the
2402 // finally clause, so that the stack of the
2403 // caught exceptions is not involved.
Bram Moolenaar13656f02020-12-19 17:55:54 +01002404 discard_exception(
2405 (except_T *)cstack->cs_exception[idx],
Bram Moolenaar071d4272004-06-13 20:20:40 +00002406 FALSE);
2407 }
2408 else
2409 report_discard_pending(cstack->cs_pending[idx],
2410 NULL);
2411 cstack->cs_pending[idx] = CSTP_NONE;
2412 }
2413 break;
2414 }
2415 }
2416
2417 /*
2418 * Stop at a try conditional not in its finally clause. If this try
2419 * conditional is in an active catch clause, finish the caught
2420 * exception.
2421 */
2422 if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2423 {
2424 if ((cstack->cs_flags[idx] & CSF_ACTIVE)
Bram Moolenaarf67d3fb2021-10-05 11:22:27 +01002425 && (cstack->cs_flags[idx] & CSF_CAUGHT)
2426 && !(cstack->cs_flags[idx] & CSF_FINISHED))
2427 {
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 finish_exception((except_T *)cstack->cs_exception[idx]);
Bram Moolenaarf67d3fb2021-10-05 11:22:27 +01002429 cstack->cs_flags[idx] |= CSF_FINISHED;
2430 }
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002431 // Stop at this try conditional - except the try block never
2432 // got active (because of an inactive surrounding conditional
2433 // or when the ":try" appeared after an error or interrupt or
2434 // throw).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 if (cstack->cs_flags[idx] & CSF_TRUE)
2436 {
2437 if (searched_cond == 0 && !inclusive)
2438 break;
2439 stop = TRUE;
2440 }
2441 }
2442 }
2443
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002444 // Stop on the searched conditional type (even when the surrounding
2445 // conditional is not active or something has been made pending).
2446 // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2447 // check first whether "emsg_silent" needs to be restored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002448 if (cstack->cs_flags[idx] & searched_cond)
2449 {
2450 if (!inclusive)
2451 break;
2452 stop = TRUE;
2453 }
2454 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2455 if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2456 break;
2457
2458 /*
Bram Moolenaarccc18222007-05-10 18:25:20 +00002459 * When leaving a try conditional that reset "emsg_silent" on its
2460 * entry after saving the original value, restore that value here and
2461 * free the memory used to store it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002462 */
2463 if ((cstack->cs_flags[idx] & CSF_TRY)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002464 && (cstack->cs_flags[idx] & CSF_SILENT))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002465 {
2466 eslist_T *elem;
2467
2468 elem = cstack->cs_emsg_silent_list;
2469 cstack->cs_emsg_silent_list = elem->next;
2470 emsg_silent = elem->saved_emsg_silent;
2471 vim_free(elem);
2472 cstack->cs_flags[idx] &= ~CSF_SILENT;
2473 }
2474 if (stop)
2475 break;
2476 }
2477 return idx;
2478}
2479
2480/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002481 * Return an appropriate error message for a missing endwhile/endfor/endif.
2482 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002483 static char *
Bram Moolenaarddef1292019-12-16 17:10:33 +01002484get_end_emsg(cstack_T *cstack)
Bram Moolenaar12805862005-01-05 22:16:17 +00002485{
2486 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
Bram Moolenaar1a992222021-12-31 17:25:48 +00002487 return _(e_missing_endwhile);
Bram Moolenaar12805862005-01-05 22:16:17 +00002488 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
Bram Moolenaar1a992222021-12-31 17:25:48 +00002489 return _(e_missing_endfor);
2490 return _(e_missing_endif);
Bram Moolenaar12805862005-01-05 22:16:17 +00002491}
2492
2493
2494/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 * Rewind conditionals until index "idx" is reached. "cond_type" and
2496 * "cond_level" specify a conditional type and the address of a level variable
2497 * which is to be decremented with each skipped conditional of the specified
2498 * type.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002499 * Also free "for info" structures where needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500 */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002501 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002502rewind_conditionals(
Bram Moolenaarddef1292019-12-16 17:10:33 +01002503 cstack_T *cstack,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002504 int idx,
2505 int cond_type,
2506 int *cond_level)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002507{
2508 while (cstack->cs_idx > idx)
2509 {
2510 if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2511 --*cond_level;
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002512 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2513 free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
Bram Moolenaarfcdc5d82020-10-10 19:07:09 +02002514 leave_block(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 }
2516}
2517
2518/*
Bram Moolenaar6d057012021-12-31 18:49:43 +00002519 * ":endfunction" or ":enddef" when not after a ":function"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521 void
Bram Moolenaar6e949782020-04-13 17:21:00 +02002522ex_endfunction(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002523{
Bram Moolenaar6e949782020-04-13 17:21:00 +02002524 if (eap->cmdidx == CMD_enddef)
Bram Moolenaar6d057012021-12-31 18:49:43 +00002525 semsg(_(e_str_not_inside_function), ":enddef");
Bram Moolenaar6e949782020-04-13 17:21:00 +02002526 else
Bram Moolenaar6d057012021-12-31 18:49:43 +00002527 semsg(_(e_str_not_inside_function), ":endfunction");
Bram Moolenaar071d4272004-06-13 20:20:40 +00002528}
2529
2530/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002531 * Return TRUE if the string "p" looks like a ":while" or ":for" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002532 */
2533 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002534has_loop_cmd(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535{
Bram Moolenaared53fb92007-11-24 20:50:24 +00002536 int len;
2537
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002538 // skip modifiers, white space and ':'
Bram Moolenaared53fb92007-11-24 20:50:24 +00002539 for (;;)
2540 {
2541 while (*p == ' ' || *p == '\t' || *p == ':')
2542 ++p;
2543 len = modifier_len(p);
2544 if (len == 0)
2545 break;
2546 p += len;
2547 }
Bram Moolenaar12805862005-01-05 22:16:17 +00002548 if ((p[0] == 'w' && p[1] == 'h')
2549 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 return TRUE;
2551 return FALSE;
2552}
2553
Bram Moolenaar217e1b82019-12-01 21:41:28 +01002554#endif // FEAT_EVAL