blob: 097280a671b3e07a5d74bb9bb990296a4f3a948e [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 Moolenaar8a5883b2016-11-10 20:20:05 +010018static int throw_exception(void *, except_type_T, char_u *);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +010019static char *get_end_emsg(struct condstack *cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +000020
21/*
22 * Exception handling terms:
23 *
24 * :try ":try" command \
25 * ... try block |
26 * :catch RE ":catch" command |
27 * ... catch clause |- try conditional
28 * :finally ":finally" command |
29 * ... finally clause |
30 * :endtry ":endtry" command /
31 *
32 * The try conditional may have any number of catch clauses and at most one
33 * finally clause. A ":throw" command can be inside the try block, a catch
34 * clause, the finally clause, or in a function called or script sourced from
35 * there or even outside the try conditional. Try conditionals may be nested.
36 */
37
38/*
39 * Configuration whether an exception is thrown on error or interrupt. When
40 * the preprocessor macros below evaluate to FALSE, an error (did_emsg) or
41 * interrupt (got_int) under an active try conditional terminates the script
42 * after the non-active finally clauses of all active try conditionals have been
43 * executed. Otherwise, errors and/or interrupts are converted into catchable
44 * exceptions (did_throw additionally set), which terminate the script only if
45 * not caught. For user exceptions, only did_throw is set. (Note: got_int can
Bram Moolenaar84a05ac2013-05-06 04:24:17 +020046 * be set asynchronously afterwards by a SIGINT, so did_throw && got_int is not
Bram Moolenaar071d4272004-06-13 20:20:40 +000047 * a reliant test that the exception currently being thrown is an interrupt
48 * exception. Similarly, did_emsg can be set afterwards on an error in an
49 * (unskipped) conditional command inside an inactive conditional, so did_throw
50 * && did_emsg is not a reliant test that the exception currently being thrown
51 * is an error exception.) - The macros can be defined as expressions checking
52 * for a variable that is allowed to be changed during execution of a script.
53 */
54#if 0
55/* Expressions used for testing during the development phase. */
56# define THROW_ON_ERROR (!eval_to_number("$VIMNOERRTHROW"))
57# define THROW_ON_INTERRUPT (!eval_to_number("$VIMNOINTTHROW"))
58# define THROW_TEST
59#else
60/* Values used for the Vim release. */
61# define THROW_ON_ERROR TRUE
Bram Moolenaaraf0167f2009-05-16 15:31:32 +000062# define THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +000063# define THROW_ON_INTERRUPT TRUE
Bram Moolenaaraf0167f2009-05-16 15:31:32 +000064# define THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +000065#endif
66
Bram Moolenaar071d4272004-06-13 20:20:40 +000067/*
68 * When several errors appear in a row, setting "force_abort" is delayed until
69 * the failing command returned. "cause_abort" is set to TRUE meanwhile, in
70 * order to indicate that situation. This is useful when "force_abort" was set
71 * during execution of a function call from an expression: the aborting of the
72 * expression evaluation is done without producing any error messages, but all
73 * error messages on parsing errors during the expression evaluation are given
74 * (even if a try conditional is active).
75 */
76static int cause_abort = FALSE;
77
78/*
Bram Moolenaarccc18222007-05-10 18:25:20 +000079 * Return TRUE when immediately aborting on error, or when an interrupt
Bram Moolenaar071d4272004-06-13 20:20:40 +000080 * occurred or an exception was thrown but not caught. Use for ":{range}call"
81 * to check whether an aborted function that does not handle a range itself
82 * should be called again for the next line in the range. Also used for
83 * cancelling expression evaluation after a function call caused an immediate
84 * abort. Note that the first emsg() call temporarily resets "force_abort"
85 * until the throw point for error messages has been reached. That is, during
86 * cancellation of an expression evaluation after an aborting function call or
87 * due to a parsing error, aborting() always returns the same value.
Bram Moolenaar67a2deb2019-11-25 00:05:32 +010088 * "got_int" is also set by calling interrupt().
Bram Moolenaar071d4272004-06-13 20:20:40 +000089 */
90 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +010091aborting(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +000092{
93 return (did_emsg && force_abort) || got_int || did_throw;
94}
95
96/*
97 * The value of "force_abort" is temporarily reset by the first emsg() call
98 * during an expression evaluation, and "cause_abort" is used instead. It might
99 * be necessary to restore "force_abort" even before the throw point for the
100 * error message has been reached. update_force_abort() should be called then.
101 */
102 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100103update_force_abort(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000104{
105 if (cause_abort)
106 force_abort = TRUE;
107}
108
109/*
110 * Return TRUE if a command with a subcommand resulting in "retcode" should
111 * abort the script processing. Can be used to suppress an autocommand after
112 * execution of a failing subcommand as long as the error message has not been
113 * displayed and actually caused the abortion.
114 */
115 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100116should_abort(int retcode)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000117{
118 return ((retcode == FAIL && trylevel != 0 && !emsg_silent) || aborting());
119}
120
121/*
122 * Return TRUE if a function with the "abort" flag should not be considered
123 * ended on an error. This means that parsing commands is continued in order
124 * to find finally clauses to be executed, and that some errors in skipped
125 * commands are still reported.
126 */
127 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100128aborted_in_try(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000129{
130 /* This function is only called after an error. In this case, "force_abort"
131 * determines whether searching for finally clauses is necessary. */
132 return force_abort;
133}
134
135/*
136 * cause_errthrow(): Cause a throw of an error exception if appropriate.
137 * Return TRUE if the error message should not be displayed by emsg().
138 * Sets "ignore", if the emsg() call should be ignored completely.
139 *
140 * When several messages appear in the same command, the first is usually the
141 * most specific one and used as the exception value. The "severe" flag can be
142 * set to TRUE, if a later but severer message should be used instead.
143 */
144 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100145cause_errthrow(
146 char_u *mesg,
147 int severe,
148 int *ignore)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000149{
150 struct msglist *elem;
151 struct msglist **plist;
152
153 /*
Bram Moolenaar57657d82006-04-21 22:12:41 +0000154 * Do nothing when displaying the interrupt message or reporting an
155 * uncaught exception (which has already been discarded then) at the top
156 * level. Also when no exception can be thrown. The message will be
157 * displayed by emsg().
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158 */
159 if (suppress_errthrow)
160 return FALSE;
161
162 /*
Bram Moolenaar57657d82006-04-21 22:12:41 +0000163 * If emsg() has not been called previously, temporarily reset
164 * "force_abort" until the throw point for error messages has been
165 * reached. This ensures that aborting() returns the same value for all
166 * errors that appear in the same command. This means particularly that
167 * for parsing errors during expression evaluation emsg() will be called
168 * multiply, even when the expression is evaluated from a finally clause
169 * that was activated due to an aborting error, interrupt, or exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000170 */
171 if (!did_emsg)
172 {
173 cause_abort = force_abort;
174 force_abort = FALSE;
175 }
176
177 /*
178 * If no try conditional is active and no exception is being thrown and
179 * there has not been an error in a try conditional or a throw so far, do
Bram Moolenaar57657d82006-04-21 22:12:41 +0000180 * nothing (for compatibility of non-EH scripts). The message will then
181 * be displayed by emsg(). When ":silent!" was used and we are not
182 * currently throwing an exception, do nothing. The message text will
183 * then be stored to v:errmsg by emsg() without displaying it.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184 */
185 if (((trylevel == 0 && !cause_abort) || emsg_silent) && !did_throw)
186 return FALSE;
187
188 /*
189 * Ignore an interrupt message when inside a try conditional or when an
Bram Moolenaar57657d82006-04-21 22:12:41 +0000190 * exception is being thrown or when an error in a try conditional or
191 * throw has been detected previously. This is important in order that an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000192 * interrupt exception is catchable by the innermost try conditional and
193 * not replaced by an interrupt message error exception.
194 */
195 if (mesg == (char_u *)_(e_interr))
196 {
197 *ignore = TRUE;
198 return TRUE;
199 }
200
201 /*
202 * Ensure that all commands in nested function calls and sourced files
203 * are aborted immediately.
204 */
205 cause_abort = TRUE;
206
207 /*
208 * When an exception is being thrown, some commands (like conditionals) are
209 * not skipped. Errors in those commands may affect what of the subsequent
210 * commands are regarded part of catch and finally clauses. Catching the
211 * exception would then cause execution of commands not intended by the
212 * user, who wouldn't even get aware of the problem. Therefor, discard the
213 * exception currently being thrown to prevent it from being caught. Just
214 * execute finally clauses and terminate.
215 */
216 if (did_throw)
217 {
218 /* When discarding an interrupt exception, reset got_int to prevent the
219 * same interrupt being converted to an exception again and discarding
220 * the error exception we are about to throw here. */
221 if (current_exception->type == ET_INTERRUPT)
222 got_int = FALSE;
223 discard_current_exception();
224 }
225
226#ifdef THROW_TEST
227 if (!THROW_ON_ERROR)
228 {
229 /*
230 * Print error message immediately without searching for a matching
231 * catch clause; just finally clauses are executed before the script
232 * is terminated.
233 */
234 return FALSE;
235 }
236 else
237#endif
238 {
239 /*
240 * Prepare the throw of an error exception, so that everything will
241 * be aborted (except for executing finally clauses), until the error
242 * exception is caught; if still uncaught at the top level, the error
243 * message will be displayed and the script processing terminated
244 * then. - This function has no access to the conditional stack.
245 * Thus, the actual throw is made after the failing command has
246 * returned. - Throw only the first of several errors in a row, except
247 * a severe error is following.
248 */
249 if (msg_list != NULL)
250 {
251 plist = msg_list;
252 while (*plist != NULL)
253 plist = &(*plist)->next;
254
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200255 elem = ALLOC_ONE(struct msglist);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000256 if (elem == NULL)
257 {
258 suppress_errthrow = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100259 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000260 }
261 else
262 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100263 elem->msg = (char *)vim_strsave(mesg);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264 if (elem->msg == NULL)
265 {
266 vim_free(elem);
267 suppress_errthrow = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100268 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000269 }
270 else
271 {
272 elem->next = NULL;
273 elem->throw_msg = NULL;
274 *plist = elem;
275 if (plist == msg_list || severe)
276 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100277 char *tmsg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000278
279 /* Skip the extra "Vim " prefix for message "E458". */
280 tmsg = elem->msg;
281 if (STRNCMP(tmsg, "Vim E", 5) == 0
282 && VIM_ISDIGIT(tmsg[5])
283 && VIM_ISDIGIT(tmsg[6])
284 && VIM_ISDIGIT(tmsg[7])
285 && tmsg[8] == ':'
286 && tmsg[9] == ' ')
287 (*msg_list)->throw_msg = &tmsg[4];
288 else
289 (*msg_list)->throw_msg = tmsg;
290 }
291 }
292 }
293 }
294 return TRUE;
295 }
296}
297
298/*
299 * Free a "msg_list" and the messages it contains.
300 */
301 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100302free_msglist(struct msglist *l)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303{
304 struct msglist *messages, *next;
305
306 messages = l;
307 while (messages != NULL)
308 {
309 next = messages->next;
310 vim_free(messages->msg);
311 vim_free(messages);
312 messages = next;
313 }
314}
315
316/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100317 * Free global "*msg_list" and the messages it contains, then set "*msg_list"
318 * to NULL.
319 */
320 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100321free_global_msglist(void)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100322{
323 free_msglist(*msg_list);
324 *msg_list = NULL;
325}
326
327/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000328 * Throw the message specified in the call to cause_errthrow() above as an
329 * error exception. If cstack is NULL, postpone the throw until do_cmdline()
330 * has returned (see do_one_cmd()).
331 */
332 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100333do_errthrow(struct condstack *cstack, char_u *cmdname)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000334{
335 /*
336 * Ensure that all commands in nested function calls and sourced files
337 * are aborted immediately.
338 */
339 if (cause_abort)
340 {
341 cause_abort = FALSE;
342 force_abort = TRUE;
343 }
344
345 /* If no exception is to be thrown or the conversion should be done after
346 * returning to a previous invocation of do_one_cmd(), do nothing. */
Bram Moolenaar4632d292006-11-28 17:36:37 +0000347 if (msg_list == NULL || *msg_list == NULL)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000348 return;
349
350 if (throw_exception(*msg_list, ET_ERROR, cmdname) == FAIL)
351 free_msglist(*msg_list);
352 else
353 {
354 if (cstack != NULL)
355 do_throw(cstack);
356 else
357 need_rethrow = TRUE;
358 }
359 *msg_list = NULL;
360}
361
362/*
363 * do_intthrow(): Replace the current exception by an interrupt or interrupt
364 * exception if appropriate. Return TRUE if the current exception is discarded,
365 * FALSE otherwise.
366 */
367 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100368do_intthrow(struct condstack *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000369{
370 /*
371 * If no interrupt occurred or no try conditional is active and no exception
372 * is being thrown, do nothing (for compatibility of non-EH scripts).
373 */
374 if (!got_int || (trylevel == 0 && !did_throw))
375 return FALSE;
376
377#ifdef THROW_TEST /* avoid warning for condition always true */
378 if (!THROW_ON_INTERRUPT)
379 {
380 /*
381 * The interrupt aborts everything except for executing finally clauses.
382 * Discard any user or error or interrupt exception currently being
383 * thrown.
384 */
385 if (did_throw)
386 discard_current_exception();
387 }
388 else
389#endif
390 {
391 /*
392 * Throw an interrupt exception, so that everything will be aborted
393 * (except for executing finally clauses), until the interrupt exception
394 * is caught; if still uncaught at the top level, the script processing
395 * will be terminated then. - If an interrupt exception is already
396 * being thrown, do nothing.
397 *
398 */
399 if (did_throw)
400 {
401 if (current_exception->type == ET_INTERRUPT)
402 return FALSE;
403
404 /* An interrupt exception replaces any user or error exception. */
405 discard_current_exception();
406 }
407 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) != FAIL)
408 do_throw(cstack);
409 }
410
411 return TRUE;
412}
413
Bram Moolenaar071d4272004-06-13 20:20:40 +0000414/*
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100415 * Get an exception message that is to be stored in current_exception->value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000416 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100417 char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100418get_exception_string(
419 void *value,
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100420 except_type_T type,
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100421 char_u *cmdname,
422 int *should_free)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000423{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100424 char *ret;
425 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000426 int cmdlen;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100427 char *p, *val;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000428
429 if (type == ET_ERROR)
430 {
Bram Moolenaar9ef00be2016-03-06 14:58:28 +0100431 *should_free = TRUE;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100432 mesg = ((struct msglist *)value)->throw_msg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000433 if (cmdname != NULL && *cmdname != NUL)
434 {
Bram Moolenaara93fa7e2006-04-17 22:14:47 +0000435 cmdlen = (int)STRLEN(cmdname);
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100436 ret = (char *)vim_strnsave((char_u *)"Vim(",
Bram Moolenaar071d4272004-06-13 20:20:40 +0000437 4 + cmdlen + 2 + (int)STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100438 if (ret == NULL)
439 return ret;
440 STRCPY(&ret[4], cmdname);
441 STRCPY(&ret[4 + cmdlen], "):");
442 val = ret + 4 + cmdlen + 2;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000443 }
444 else
445 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100446 ret = (char *)vim_strnsave((char_u *)"Vim:", 4 + (int)STRLEN(mesg));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100447 if (ret == NULL)
448 return ret;
449 val = ret + 4;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000450 }
451
452 /* msg_add_fname may have been used to prefix the message with a file
453 * name in quotes. In the exception value, put the file name in
454 * parentheses and move it to the end. */
455 for (p = mesg; ; p++)
456 {
457 if (*p == NUL
458 || (*p == 'E'
459 && VIM_ISDIGIT(p[1])
460 && (p[2] == ':'
461 || (VIM_ISDIGIT(p[2])
462 && (p[3] == ':'
463 || (VIM_ISDIGIT(p[3])
464 && p[4] == ':'))))))
465 {
Bram Moolenaar051b7822005-05-19 21:00:46 +0000466 if (*p == NUL || p == mesg)
467 STRCAT(val, mesg); /* 'E123' missing or at beginning */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000468 else
469 {
470 /* '"filename" E123: message text' */
471 if (mesg[0] != '"' || p-2 < &mesg[1] ||
472 p[-2] != '"' || p[-1] != ' ')
473 /* "E123:" is part of the file name. */
474 continue;
475
476 STRCAT(val, p);
477 p[-2] = NUL;
478 sprintf((char *)(val + STRLEN(p)), " (%s)", &mesg[1]);
479 p[-2] = '"';
480 }
481 break;
482 }
483 }
484 }
485 else
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100486 {
487 *should_free = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100488 ret = value;
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100489 }
490
491 return ret;
492}
493
494
495/*
496 * Throw a new exception. Return FAIL when out of memory or it was tried to
497 * throw an illegal user exception. "value" is the exception string for a
498 * user or interrupt exception, or points to a message list in case of an
499 * error exception.
500 */
501 static int
Bram Moolenaar8a5883b2016-11-10 20:20:05 +0100502throw_exception(void *value, except_type_T type, char_u *cmdname)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100503{
504 except_T *excp;
505 int should_free;
506
507 /*
508 * Disallow faking Interrupt or error exceptions as user exceptions. They
509 * would be treated differently from real interrupt or error exceptions
510 * when no active try block is found, see do_cmdline().
511 */
512 if (type == ET_USER)
513 {
514 if (STRNCMP((char_u *)value, "Vim", 3) == 0
515 && (((char_u *)value)[3] == NUL || ((char_u *)value)[3] == ':'
516 || ((char_u *)value)[3] == '('))
517 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100518 emsg(_("E608: Cannot :throw exceptions with 'Vim' prefix"));
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100519 goto fail;
520 }
521 }
522
Bram Moolenaarc799fe22019-05-28 23:08:19 +0200523 excp = ALLOC_ONE(except_T);
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100524 if (excp == NULL)
525 goto nomem;
526
527 if (type == ET_ERROR)
528 /* Store the original message and prefix the exception value with
529 * "Vim:" or, if a command name is given, "Vim(cmdname):". */
530 excp->messages = (struct msglist *)value;
531
532 excp->value = get_exception_string(value, type, cmdname, &should_free);
533 if (excp->value == NULL && should_free)
534 goto nomem;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000535
536 excp->type = type;
537 excp->throw_name = vim_strsave(sourcing_name == NULL
538 ? (char_u *)"" : sourcing_name);
539 if (excp->throw_name == NULL)
540 {
Bram Moolenaar9fee7d42013-11-28 17:04:43 +0100541 if (should_free)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000542 vim_free(excp->value);
543 goto nomem;
544 }
545 excp->throw_lnum = sourcing_lnum;
546
547 if (p_verbose >= 13 || debug_break_level > 0)
548 {
549 int save_msg_silent = msg_silent;
550
551 if (debug_break_level > 0)
552 msg_silent = FALSE; /* display messages */
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000553 else
554 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000555 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000556 if (debug_break_level > 0 || *p_vfile == NUL)
557 msg_scroll = TRUE; /* always scroll up, don't overwrite */
558
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100559 smsg(_("Exception thrown: %s"), excp->value);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100560 msg_puts("\n"); /* don't overwrite this either */
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000561
562 if (debug_break_level > 0 || *p_vfile == NUL)
563 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000564 --no_wait_return;
565 if (debug_break_level > 0)
566 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000567 else
568 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000569 }
570
571 current_exception = excp;
572 return OK;
573
574nomem:
575 vim_free(excp);
576 suppress_errthrow = TRUE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100577 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578fail:
579 current_exception = NULL;
580 return FAIL;
581}
582
583/*
584 * Discard an exception. "was_finished" is set when the exception has been
585 * caught and the catch clause has been ended normally.
586 */
587 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100588discard_exception(except_T *excp, int was_finished)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000589{
590 char_u *saved_IObuff;
591
592 if (excp == NULL)
593 {
Bram Moolenaar95f09602016-11-10 20:01:45 +0100594 internal_error("discard_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595 return;
596 }
597
598 if (p_verbose >= 13 || debug_break_level > 0)
599 {
600 int save_msg_silent = msg_silent;
601
602 saved_IObuff = vim_strsave(IObuff);
603 if (debug_break_level > 0)
604 msg_silent = FALSE; /* display messages */
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000605 else
606 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000607 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000608 if (debug_break_level > 0 || *p_vfile == NUL)
609 msg_scroll = TRUE; /* always scroll up, don't overwrite */
Bram Moolenaar051b7822005-05-19 21:00:46 +0000610 smsg(was_finished
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100611 ? _("Exception finished: %s")
612 : _("Exception discarded: %s"),
Bram Moolenaar071d4272004-06-13 20:20:40 +0000613 excp->value);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100614 msg_puts("\n"); /* don't overwrite this either */
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000615 if (debug_break_level > 0 || *p_vfile == NUL)
616 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000617 --no_wait_return;
618 if (debug_break_level > 0)
619 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000620 else
621 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000622 STRCPY(IObuff, saved_IObuff);
623 vim_free(saved_IObuff);
624 }
625 if (excp->type != ET_INTERRUPT)
626 vim_free(excp->value);
627 if (excp->type == ET_ERROR)
628 free_msglist(excp->messages);
629 vim_free(excp->throw_name);
630 vim_free(excp);
631}
632
633/*
634 * Discard the exception currently being thrown.
635 */
636 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100637discard_current_exception(void)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638{
Bram Moolenaarcae24be2017-07-10 22:12:10 +0200639 if (current_exception != NULL)
640 {
641 discard_exception(current_exception, FALSE);
642 current_exception = NULL;
643 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000644 did_throw = FALSE;
645 need_rethrow = FALSE;
646}
647
648/*
649 * Put an exception on the caught stack.
650 */
651 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100652catch_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000653{
654 excp->caught = caught_stack;
655 caught_stack = excp;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100656 set_vim_var_string(VV_EXCEPTION, (char_u *)excp->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 if (*excp->throw_name != NUL)
658 {
659 if (excp->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000660 vim_snprintf((char *)IObuff, IOSIZE, _("%s, line %ld"),
661 excp->throw_name, (long)excp->throw_lnum);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000662 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000663 vim_snprintf((char *)IObuff, IOSIZE, "%s", excp->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000664 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
665 }
666 else
667 /* throw_name not set on an exception from a command that was typed. */
668 set_vim_var_string(VV_THROWPOINT, NULL, -1);
669
670 if (p_verbose >= 13 || debug_break_level > 0)
671 {
672 int save_msg_silent = msg_silent;
673
674 if (debug_break_level > 0)
675 msg_silent = FALSE; /* display messages */
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000676 else
677 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000678 ++no_wait_return;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000679 if (debug_break_level > 0 || *p_vfile == NUL)
680 msg_scroll = TRUE; /* always scroll up, don't overwrite */
681
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100682 smsg(_("Exception caught: %s"), excp->value);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100683 msg_puts("\n"); /* don't overwrite this either */
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000684
685 if (debug_break_level > 0 || *p_vfile == NUL)
686 cmdline_row = msg_row;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 --no_wait_return;
688 if (debug_break_level > 0)
689 msg_silent = save_msg_silent;
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000690 else
691 verbose_leave();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000692 }
693}
694
695/*
696 * Remove an exception from the caught stack.
697 */
698 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100699finish_exception(except_T *excp)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700{
701 if (excp != caught_stack)
Bram Moolenaar95f09602016-11-10 20:01:45 +0100702 internal_error("finish_exception()");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000703 caught_stack = caught_stack->caught;
704 if (caught_stack != NULL)
705 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100706 set_vim_var_string(VV_EXCEPTION, (char_u *)caught_stack->value, -1);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 if (*caught_stack->throw_name != NUL)
708 {
709 if (caught_stack->throw_lnum != 0)
Bram Moolenaar051b7822005-05-19 21:00:46 +0000710 vim_snprintf((char *)IObuff, IOSIZE,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000711 _("%s, line %ld"), caught_stack->throw_name,
712 (long)caught_stack->throw_lnum);
713 else
Bram Moolenaar051b7822005-05-19 21:00:46 +0000714 vim_snprintf((char *)IObuff, IOSIZE, "%s",
715 caught_stack->throw_name);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000716 set_vim_var_string(VV_THROWPOINT, IObuff, -1);
717 }
718 else
719 /* throw_name not set on an exception from a command that was
720 * typed. */
721 set_vim_var_string(VV_THROWPOINT, NULL, -1);
722 }
723 else
724 {
725 set_vim_var_string(VV_EXCEPTION, NULL, -1);
726 set_vim_var_string(VV_THROWPOINT, NULL, -1);
727 }
728
729 /* Discard the exception, but use the finish message for 'verbose'. */
730 discard_exception(excp, TRUE);
731}
732
733/*
734 * Flags specifying the message displayed by report_pending.
735 */
736#define RP_MAKE 0
737#define RP_RESUME 1
738#define RP_DISCARD 2
739
740/*
741 * Report information about something pending in a finally clause if required by
742 * the 'verbose' option or when debugging. "action" tells whether something is
743 * made pending or something pending is resumed or discarded. "pending" tells
744 * what is pending. "value" specifies the return value for a pending ":return"
745 * or the exception value for a pending exception.
746 */
747 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100748report_pending(int action, int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100750 char *mesg;
Bram Moolenaar071d4272004-06-13 20:20:40 +0000751 char *s;
752 int save_msg_silent;
753
754
755 switch (action)
756 {
757 case RP_MAKE:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100758 mesg = _("%s made pending");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000759 break;
760 case RP_RESUME:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100761 mesg = _("%s resumed");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000762 break;
763 /* case RP_DISCARD: */
764 default:
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100765 mesg = _("%s discarded");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000766 break;
767 }
768
769 switch (pending)
770 {
771 case CSTP_NONE:
772 return;
773
774 case CSTP_CONTINUE:
775 s = ":continue";
776 break;
777 case CSTP_BREAK:
778 s = ":break";
779 break;
780 case CSTP_FINISH:
781 s = ":finish";
782 break;
783 case CSTP_RETURN:
784 /* ":return" command producing value, allocated */
785 s = (char *)get_return_cmd(value);
786 break;
787
788 default:
789 if (pending & CSTP_THROW)
790 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100791 vim_snprintf((char *)IObuff, IOSIZE, mesg, _("Exception"));
792 mesg = (char *)vim_strnsave(IObuff, (int)STRLEN(IObuff) + 4);
Bram Moolenaar071d4272004-06-13 20:20:40 +0000793 STRCAT(mesg, ": %s");
794 s = (char *)((except_T *)value)->value;
795 }
796 else if ((pending & CSTP_ERROR) && (pending & CSTP_INTERRUPT))
797 s = _("Error and interrupt");
798 else if (pending & CSTP_ERROR)
799 s = _("Error");
800 else /* if (pending & CSTP_INTERRUPT) */
801 s = _("Interrupt");
802 }
803
804 save_msg_silent = msg_silent;
805 if (debug_break_level > 0)
806 msg_silent = FALSE; /* display messages */
807 ++no_wait_return;
808 msg_scroll = TRUE; /* always scroll up, don't overwrite */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100809 smsg(mesg, s);
Bram Moolenaar32526b32019-01-19 17:43:09 +0100810 msg_puts("\n"); /* don't overwrite this either */
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 cmdline_row = msg_row;
812 --no_wait_return;
813 if (debug_break_level > 0)
814 msg_silent = save_msg_silent;
815
816 if (pending == CSTP_RETURN)
817 vim_free(s);
818 else if (pending & CSTP_THROW)
819 vim_free(mesg);
820}
821
822/*
823 * If something is made pending in a finally clause, report it if required by
824 * the 'verbose' option or when debugging.
825 */
826 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100827report_make_pending(int pending, void *value)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000828{
829 if (p_verbose >= 14 || debug_break_level > 0)
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000830 {
831 if (debug_break_level <= 0)
832 verbose_enter();
Bram Moolenaar071d4272004-06-13 20:20:40 +0000833 report_pending(RP_MAKE, pending, value);
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +0000834 if (debug_break_level <= 0)
835 verbose_leave();
836 }
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837}
838
839/*
840 * If something pending in a finally clause is resumed at the ":endtry", report
841 * it if required by the 'verbose' option or when debugging.
842 */
Bram Moolenaar5843f5f2019-08-20 20:13:45 +0200843 static void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100844report_resume_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_RESUME, 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 discarded, report it if required
858 * 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_discard_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_DISCARD, 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/*
Bram Moolenaar25e42232019-08-04 15:04:10 +0200875 * ":eval".
876 */
877 void
878ex_eval(exarg_T *eap)
879{
880 typval_T tv;
881
882 if (eval0(eap->arg, &tv, &eap->nextcmd, !eap->skip) == OK)
883 clear_tv(&tv);
884}
885
886/*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 * ":if".
888 */
889 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100890ex_if(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000891{
892 int error;
893 int skip;
894 int result;
895 struct condstack *cstack = eap->cstack;
896
897 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100898 eap->errmsg = N_("E579: :if nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000899 else
900 {
901 ++cstack->cs_idx;
902 cstack->cs_flags[cstack->cs_idx] = 0;
903
904 /*
905 * Don't do something after an error, interrupt, or throw, or when there
906 * is a surrounding conditional and it was not active.
907 */
908 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
909 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
910
911 result = eval_to_bool(eap->arg, &error, &eap->nextcmd, skip);
912
913 if (!skip && !error)
914 {
915 if (result)
916 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
917 }
918 else
919 /* set TRUE, so this conditional will never get active */
920 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
921 }
922}
923
924/*
925 * ":endif".
926 */
927 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100928ex_endif(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000929{
930 did_endif = TRUE;
931 if (eap->cstack->cs_idx < 0
Bram Moolenaarde8866b2005-01-06 23:24:37 +0000932 || (eap->cstack->cs_flags[eap->cstack->cs_idx]
933 & (CSF_WHILE | CSF_FOR | CSF_TRY)))
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100934 eap->errmsg = N_("E580: :endif without :if");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000935 else
936 {
937 /*
938 * When debugging or a breakpoint was encountered, display the debug
939 * prompt (if not already done). This shows the user that an ":endif"
940 * is executed when the ":if" or a previous ":elseif" was not TRUE.
941 * Handle a ">quit" debug command as if an interrupt had occurred before
942 * the ":endif". That is, throw an interrupt exception if appropriate.
943 * Doing this here prevents an exception for a parsing error being
944 * discarded by throwing the interrupt exception later on.
945 */
Bram Moolenaarf461c8e2005-06-25 23:04:51 +0000946 if (!(eap->cstack->cs_flags[eap->cstack->cs_idx] & CSF_TRUE)
947 && dbg_check_skipped(eap))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000948 (void)do_intthrow(eap->cstack);
949
950 --eap->cstack->cs_idx;
951 }
952}
953
954/*
955 * ":else" and ":elseif".
956 */
957 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +0100958ex_else(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000959{
960 int error;
961 int skip;
962 int result;
963 struct condstack *cstack = eap->cstack;
964
965 /*
966 * Don't do something after an error, interrupt, or throw, or when there is
967 * a surrounding conditional and it was not active.
968 */
969 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
970 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
971
972 if (cstack->cs_idx < 0
Bram Moolenaar12805862005-01-05 22:16:17 +0000973 || (cstack->cs_flags[cstack->cs_idx]
974 & (CSF_WHILE | CSF_FOR | CSF_TRY)))
Bram Moolenaar071d4272004-06-13 20:20:40 +0000975 {
976 if (eap->cmdidx == CMD_else)
977 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100978 eap->errmsg = N_("E581: :else without :if");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000979 return;
980 }
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100981 eap->errmsg = N_("E582: :elseif without :if");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000982 skip = TRUE;
983 }
984 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
985 {
986 if (eap->cmdidx == CMD_else)
987 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100988 eap->errmsg = N_("E583: multiple :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 return;
990 }
Bram Moolenaarf9e3e092019-01-13 23:38:42 +0100991 eap->errmsg = N_("E584: :elseif after :else");
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 skip = TRUE;
993 }
994
995 /* if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it */
996 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
997 {
998 if (eap->errmsg == NULL)
999 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1000 skip = TRUE; /* don't evaluate an ":elseif" */
1001 }
1002 else
1003 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1004
1005 /*
1006 * When debugging or a breakpoint was encountered, display the debug prompt
1007 * (if not already done). This shows the user that an ":else" or ":elseif"
1008 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle
1009 * a ">quit" debug command as if an interrupt had occurred before the
1010 * ":else" or ":elseif". That is, set "skip" and throw an interrupt
1011 * exception if appropriate. Doing this here prevents that an exception
1012 * for a parsing errors is discarded when throwing the interrupt exception
1013 * later on.
1014 */
1015 if (!skip && dbg_check_skipped(eap) && got_int)
1016 {
1017 (void)do_intthrow(cstack);
1018 skip = TRUE;
1019 }
1020
1021 if (eap->cmdidx == CMD_elseif)
1022 {
1023 result = eval_to_bool(eap->arg, &error, &eap->nextcmd, skip);
1024 /* When throwing error exceptions, we want to throw always the first
1025 * of several errors in a row. This is what actually happens when
1026 * a conditional error was detected above and there is another failure
1027 * when parsing the expression. Since the skip flag is set in this
1028 * case, the parsing error will be ignored by emsg(). */
1029
1030 if (!skip && !error)
1031 {
1032 if (result)
1033 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1034 else
1035 cstack->cs_flags[cstack->cs_idx] = 0;
1036 }
1037 else if (eap->errmsg == NULL)
1038 /* set TRUE, so this conditional will never get active */
1039 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1040 }
1041 else
1042 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1043}
1044
1045/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001046 * Handle ":while" and ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001047 */
1048 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001049ex_while(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001050{
1051 int error;
1052 int skip;
1053 int result;
1054 struct condstack *cstack = eap->cstack;
1055
1056 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001057 eap->errmsg = N_("E585: :while/:for nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 else
1059 {
1060 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001061 * The loop flag is set when we have jumped back from the matching
1062 * ":endwhile" or ":endfor". When not set, need to initialise this
1063 * cstack entry.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001065 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001066 {
1067 ++cstack->cs_idx;
Bram Moolenaar12805862005-01-05 22:16:17 +00001068 ++cstack->cs_looplevel;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001069 cstack->cs_line[cstack->cs_idx] = -1;
1070 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001071 cstack->cs_flags[cstack->cs_idx] =
1072 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073
1074 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001075 * Don't do something after an error, interrupt, or throw, or when
1076 * there is a surrounding conditional and it was not active.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001077 */
1078 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1079 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
Bram Moolenaar12805862005-01-05 22:16:17 +00001080 if (eap->cmdidx == CMD_while)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001081 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001082 /*
1083 * ":while bool-expr"
1084 */
1085 result = eval_to_bool(eap->arg, &error, &eap->nextcmd, skip);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001086 }
1087 else
1088 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001089 void *fi;
1090
1091 /*
1092 * ":for var in list-expr"
1093 */
1094 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
1095 {
1096 /* Jumping here from a ":continue" or ":endfor": use the
1097 * previously evaluated list. */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001098 fi = cstack->cs_forinfo[cstack->cs_idx];
Bram Moolenaar12805862005-01-05 22:16:17 +00001099 error = FALSE;
1100 }
1101 else
1102 {
1103 /* Evaluate the argument and get the info in a structure. */
1104 fi = eval_for_line(eap->arg, &error, &eap->nextcmd, skip);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001105 cstack->cs_forinfo[cstack->cs_idx] = fi;
Bram Moolenaar12805862005-01-05 22:16:17 +00001106 }
1107
1108 /* use the element at the start of the list and advance */
1109 if (!error && fi != NULL && !skip)
1110 result = next_for_item(fi, eap->arg);
1111 else
1112 result = FALSE;
1113
1114 if (!result)
1115 {
1116 free_for_info(fi);
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001117 cstack->cs_forinfo[cstack->cs_idx] = NULL;
Bram Moolenaar12805862005-01-05 22:16:17 +00001118 }
1119 }
1120
1121 /*
1122 * If this cstack entry was just initialised and is active, set the
1123 * loop flag, so do_cmdline() will set the line number in cs_line[].
1124 * If executing the command a second time, clear the loop flag.
1125 */
1126 if (!skip && !error && result)
1127 {
1128 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
1129 cstack->cs_lflags ^= CSL_HAD_LOOP;
1130 }
1131 else
1132 {
1133 cstack->cs_lflags &= ~CSL_HAD_LOOP;
1134 /* If the ":while" evaluates to FALSE or ":for" is past the end of
1135 * the list, show the debug prompt at the ":endwhile"/":endfor" as
1136 * if there was a ":break" in a ":while"/":for" evaluating to
1137 * TRUE. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001138 if (!skip && !error)
1139 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1140 }
1141 }
1142}
1143
1144/*
1145 * ":continue"
1146 */
1147 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001148ex_continue(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149{
1150 int idx;
1151 struct condstack *cstack = eap->cstack;
1152
Bram Moolenaar12805862005-01-05 22:16:17 +00001153 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001154 eap->errmsg = N_("E586: :continue without :while or :for");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001155 else
1156 {
1157 /* Try to find the matching ":while". This might stop at a try
1158 * conditional not in its finally clause (which is then to be executed
1159 * next). Therefor, inactivate all conditionals except the ":while"
1160 * itself (if reached). */
Bram Moolenaar12805862005-01-05 22:16:17 +00001161 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001162 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 {
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001164 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001165
1166 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001167 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00001168 * matching ":while".
1169 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001170 cstack->cs_lflags |= CSL_HAD_CONT; /* let do_cmdline() handle it */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001171 }
1172 else
1173 {
1174 /* If a try conditional not in its finally clause is reached first,
1175 * make the ":continue" pending for execution at the ":endtry". */
1176 cstack->cs_pending[idx] = CSTP_CONTINUE;
1177 report_make_pending(CSTP_CONTINUE, NULL);
1178 }
1179 }
1180}
1181
1182/*
1183 * ":break"
1184 */
1185 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001186ex_break(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001187{
1188 int idx;
1189 struct condstack *cstack = eap->cstack;
1190
Bram Moolenaar12805862005-01-05 22:16:17 +00001191 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001192 eap->errmsg = N_("E587: :break without :while or :for");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001193 else
1194 {
1195 /* Inactivate conditionals until the matching ":while" or a try
1196 * conditional not in its finally clause (which is then to be
1197 * executed next) is found. In the latter case, make the ":break"
1198 * pending for execution at the ":endtry". */
Bram Moolenaar12805862005-01-05 22:16:17 +00001199 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001200 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001201 {
1202 cstack->cs_pending[idx] = CSTP_BREAK;
1203 report_make_pending(CSTP_BREAK, NULL);
1204 }
1205 }
1206}
1207
1208/*
Bram Moolenaar12805862005-01-05 22:16:17 +00001209 * ":endwhile" and ":endfor"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001210 */
1211 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001212ex_endwhile(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213{
1214 struct condstack *cstack = eap->cstack;
Bram Moolenaar12805862005-01-05 22:16:17 +00001215 int idx;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001216 char *err;
Bram Moolenaar12805862005-01-05 22:16:17 +00001217 int csf;
1218 int fl;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219
Bram Moolenaar12805862005-01-05 22:16:17 +00001220 if (eap->cmdidx == CMD_endwhile)
1221 {
1222 err = e_while;
1223 csf = CSF_WHILE;
1224 }
Bram Moolenaar071d4272004-06-13 20:20:40 +00001225 else
1226 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001227 err = e_for;
1228 csf = CSF_FOR;
1229 }
1230
1231 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
1232 eap->errmsg = err;
1233 else
1234 {
1235 fl = cstack->cs_flags[cstack->cs_idx];
1236 if (!(fl & csf))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001237 {
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00001238 /* If we are in a ":while" or ":for" but used the wrong endloop
1239 * command, do not rewind to the next enclosing ":for"/":while". */
Bram Moolenaar12805862005-01-05 22:16:17 +00001240 if (fl & CSF_WHILE)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001241 eap->errmsg = _("E732: Using :endfor with :while");
Bram Moolenaar12805862005-01-05 22:16:17 +00001242 else if (fl & CSF_FOR)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001243 eap->errmsg = _("E733: Using :endwhile with :for");
Bram Moolenaar3a3a7232005-01-17 22:16:15 +00001244 }
1245 if (!(fl & (CSF_WHILE | CSF_FOR)))
1246 {
1247 if (!(fl & CSF_TRY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248 eap->errmsg = e_endif;
Bram Moolenaar12805862005-01-05 22:16:17 +00001249 else if (fl & CSF_FINALLY)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250 eap->errmsg = e_endtry;
Bram Moolenaar12805862005-01-05 22:16:17 +00001251 /* Try to find the matching ":while" and report what's missing. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 for (idx = cstack->cs_idx; idx > 0; --idx)
1253 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001254 fl = cstack->cs_flags[idx];
1255 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00001256 {
1257 /* Give up at a try conditional not in its finally clause.
Bram Moolenaar12805862005-01-05 22:16:17 +00001258 * Ignore the ":endwhile"/":endfor". */
1259 eap->errmsg = err;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001260 return;
1261 }
Bram Moolenaar12805862005-01-05 22:16:17 +00001262 if (fl & csf)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001263 break;
1264 }
1265 /* Cleanup and rewind all contained (and unclosed) conditionals. */
Bram Moolenaar12805862005-01-05 22:16:17 +00001266 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001267 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1268 }
1269
1270 /*
1271 * When debugging or a breakpoint was encountered, display the debug
1272 * prompt (if not already done). This shows the user that an
Bram Moolenaar12805862005-01-05 22:16:17 +00001273 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
1274 * after a ":break". Handle a ">quit" debug command as if an
1275 * interrupt had occurred before the ":endwhile"/":endfor". That is,
1276 * throw an interrupt exception if appropriate. Doing this here
1277 * prevents that an exception for a parsing error is discarded when
1278 * throwing the interrupt exception later on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279 */
1280 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1281 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1282 && dbg_check_skipped(eap))
1283 (void)do_intthrow(cstack);
1284
1285 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001286 * Set loop flag, so do_cmdline() will jump back to the matching
1287 * ":while" or ":for".
Bram Moolenaar071d4272004-06-13 20:20:40 +00001288 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001289 cstack->cs_lflags |= CSL_HAD_ENDLOOP;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 }
1291}
1292
1293
1294/*
1295 * ":throw expr"
1296 */
1297 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001298ex_throw(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001299{
1300 char_u *arg = eap->arg;
1301 char_u *value;
1302
1303 if (*arg != NUL && *arg != '|' && *arg != '\n')
1304 value = eval_to_string_skip(arg, &eap->nextcmd, eap->skip);
1305 else
1306 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001307 emsg(_(e_argreq));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 value = NULL;
1309 }
1310
1311 /* On error or when an exception is thrown during argument evaluation, do
1312 * not throw. */
1313 if (!eap->skip && value != NULL)
1314 {
1315 if (throw_exception(value, ET_USER, NULL) == FAIL)
1316 vim_free(value);
1317 else
1318 do_throw(eap->cstack);
1319 }
1320}
1321
1322/*
Bram Moolenaar269ec652004-07-29 08:43:53 +00001323 * Throw the current exception through the specified cstack. Common routine
1324 * for ":throw" (user exception) and error and interrupt exceptions. Also
1325 * used for rethrowing an uncaught exception.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001326 */
1327 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001328do_throw(struct condstack *cstack)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001329{
1330 int idx;
1331 int inactivate_try = FALSE;
1332
1333 /*
1334 * Cleanup and inactivate up to the next surrounding try conditional that
1335 * is not in its finally clause. Normally, do not inactivate the try
1336 * conditional itself, so that its ACTIVE flag can be tested below. But
1337 * if a previous error or interrupt has not been converted to an exception,
1338 * inactivate the try conditional, too, as if the conversion had been done,
Bram Moolenaar269ec652004-07-29 08:43:53 +00001339 * and reset the did_emsg or got_int flag, so this won't happen again at
1340 * the next surrounding try conditional.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 */
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001342#ifndef THROW_ON_ERROR_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001343 if (did_emsg && !THROW_ON_ERROR)
1344 {
1345 inactivate_try = TRUE;
1346 did_emsg = FALSE;
1347 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001348#endif
1349#ifndef THROW_ON_INTERRUPT_TRUE
Bram Moolenaar071d4272004-06-13 20:20:40 +00001350 if (got_int && !THROW_ON_INTERRUPT)
1351 {
1352 inactivate_try = TRUE;
1353 got_int = FALSE;
1354 }
Bram Moolenaaraf0167f2009-05-16 15:31:32 +00001355#endif
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 idx = cleanup_conditionals(cstack, 0, inactivate_try);
1357 if (idx >= 0)
1358 {
1359 /*
1360 * If this try conditional is active and we are before its first
Bram Moolenaar269ec652004-07-29 08:43:53 +00001361 * ":catch", set THROWN so that the ":catch" commands will check
1362 * whether the exception matches. When the exception came from any of
1363 * the catch clauses, it will be made pending at the ":finally" (if
1364 * present) and rethrown at the ":endtry". This will also happen if
1365 * the try conditional is inactive. This is the case when we are
1366 * throwing an exception due to an error or interrupt on the way from
1367 * a preceding ":continue", ":break", ":return", ":finish", error or
1368 * interrupt (not converted to an exception) to the finally clause or
1369 * from a preceding throw of a user or error or interrupt exception to
1370 * the matching catch clause or the finally clause.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001371 */
1372 if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1373 {
1374 if (cstack->cs_flags[idx] & CSF_ACTIVE)
1375 cstack->cs_flags[idx] |= CSF_THROWN;
1376 else
1377 /* THROWN may have already been set for a catchable exception
1378 * that has been discarded. Ensure it is reset for the new
1379 * exception. */
1380 cstack->cs_flags[idx] &= ~CSF_THROWN;
1381 }
1382 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1383 cstack->cs_exception[idx] = current_exception;
1384 }
1385#if 0
Bram Moolenaar269ec652004-07-29 08:43:53 +00001386 /* TODO: Add optimization below. Not yet done because of interface
1387 * problems to eval.c and ex_cmds2.c. (Servatius) */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001388 else
1389 {
1390 /*
1391 * There are no catch clauses to check or finally clauses to execute.
1392 * End the current script or function. The exception will be rethrown
1393 * in the caller.
1394 */
1395 if (getline_equal(eap->getline, eap->cookie, get_func_line))
1396 current_funccal->returned = TRUE;
1397 elseif (eap->get_func_line == getsourceline)
1398 ((struct source_cookie *)eap->cookie)->finished = TRUE;
1399 }
1400#endif
1401
1402 did_throw = TRUE;
1403}
1404
1405/*
1406 * ":try"
1407 */
1408 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001409ex_try(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410{
1411 int skip;
1412 struct condstack *cstack = eap->cstack;
1413
1414 if (cstack->cs_idx == CSTACK_LEN - 1)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001415 eap->errmsg = N_("E601: :try nesting too deep");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001416 else
1417 {
1418 ++cstack->cs_idx;
1419 ++cstack->cs_trylevel;
1420 cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1421 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1422
1423 /*
1424 * Don't do something after an error, interrupt, or throw, or when there
1425 * is a surrounding conditional and it was not active.
1426 */
1427 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1428 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1429
1430 if (!skip)
1431 {
1432 /* Set ACTIVE and TRUE. TRUE means that the corresponding ":catch"
1433 * commands should check for a match if an exception is thrown and
1434 * that the finally clause needs to be executed. */
1435 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1436
1437 /*
1438 * ":silent!", even when used in a try conditional, disables
1439 * displaying of error messages and conversion of errors to
1440 * exceptions. When the silent commands again open a try
1441 * conditional, save "emsg_silent" and reset it so that errors are
1442 * again converted to exceptions. The value is restored when that
1443 * try conditional is left. If it is left normally, the commands
1444 * following the ":endtry" are again silent. If it is left by
1445 * a ":continue", ":break", ":return", or ":finish", the commands
1446 * executed next are again silent. If it is left due to an
1447 * aborting error, an interrupt, or an exception, restoring
1448 * "emsg_silent" does not matter since we are already in the
1449 * aborting state and/or the exception has already been thrown.
1450 * The effect is then just freeing the memory that was allocated
1451 * to save the value.
1452 */
1453 if (emsg_silent)
1454 {
1455 eslist_T *elem;
1456
Bram Moolenaarc799fe22019-05-28 23:08:19 +02001457 elem = ALLOC_ONE(struct eslist_elem);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001458 if (elem == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001459 emsg(_(e_outofmem));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001460 else
1461 {
1462 elem->saved_emsg_silent = emsg_silent;
1463 elem->next = cstack->cs_emsg_silent_list;
1464 cstack->cs_emsg_silent_list = elem;
1465 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1466 emsg_silent = 0;
1467 }
1468 }
1469 }
1470
1471 }
1472}
1473
1474/*
1475 * ":catch /{pattern}/" and ":catch"
1476 */
1477 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001478ex_catch(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001479{
1480 int idx = 0;
1481 int give_up = FALSE;
1482 int skip = FALSE;
1483 int caught = FALSE;
1484 char_u *end;
1485 int save_char = 0;
1486 char_u *save_cpo;
1487 regmatch_T regmatch;
1488 int prev_got_int;
1489 struct condstack *cstack = eap->cstack;
1490 char_u *pat;
1491
1492 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1493 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001494 eap->errmsg = N_("E603: :catch without :try");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001495 give_up = TRUE;
1496 }
1497 else
1498 {
1499 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1500 {
1501 /* Report what's missing if the matching ":try" is not in its
1502 * finally clause. */
Bram Moolenaar12805862005-01-05 22:16:17 +00001503 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 skip = TRUE;
1505 }
1506 for (idx = cstack->cs_idx; idx > 0; --idx)
1507 if (cstack->cs_flags[idx] & CSF_TRY)
1508 break;
1509 if (cstack->cs_flags[idx] & CSF_FINALLY)
1510 {
1511 /* Give up for a ":catch" after ":finally" and ignore it.
1512 * Just parse. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001513 eap->errmsg = N_("E604: :catch after :finally");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001514 give_up = TRUE;
1515 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001516 else
Bram Moolenaar12805862005-01-05 22:16:17 +00001517 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1518 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 }
1520
1521 if (ends_excmd(*eap->arg)) /* no argument, catch all errors */
1522 {
1523 pat = (char_u *)".*";
1524 end = NULL;
1525 eap->nextcmd = find_nextcmd(eap->arg);
1526 }
1527 else
1528 {
1529 pat = eap->arg + 1;
1530 end = skip_regexp(pat, *eap->arg, TRUE, NULL);
1531 }
1532
1533 if (!give_up)
1534 {
1535 /*
1536 * Don't do something when no exception has been thrown or when the
1537 * corresponding try block never got active (because of an inactive
1538 * surrounding conditional or after an error or interrupt or throw).
1539 */
1540 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1541 skip = TRUE;
1542
1543 /*
1544 * Check for a match only if an exception is thrown but not caught by
1545 * a previous ":catch". An exception that has replaced a discarded
1546 * exception is not checked (THROWN is not set then).
1547 */
1548 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1549 && !(cstack->cs_flags[idx] & CSF_CAUGHT))
1550 {
1551 if (end != NULL && *end != NUL && !ends_excmd(*skipwhite(end + 1)))
1552 {
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001553 emsg(_(e_trailing));
Bram Moolenaar071d4272004-06-13 20:20:40 +00001554 return;
1555 }
1556
1557 /* When debugging or a breakpoint was encountered, display the
1558 * debug prompt (if not already done) before checking for a match.
1559 * This is a helpful hint for the user when the regular expression
1560 * matching fails. Handle a ">quit" debug command as if an
1561 * interrupt had occurred before the ":catch". That is, discard
1562 * the original exception, replace it by an interrupt exception,
1563 * and don't catch it in this try block. */
1564 if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1565 {
1566 /* Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1567 * while compiling it. */
1568 if (end != NULL)
1569 {
1570 save_char = *end;
1571 *end = NUL;
1572 }
1573 save_cpo = p_cpo;
1574 p_cpo = (char_u *)"";
Bram Moolenaar768ce242016-02-07 19:46:12 +01001575 /* Disable error messages, it will make current_exception
1576 * invalid. */
1577 ++emsg_off;
Bram Moolenaar150cc272007-08-01 13:47:46 +00001578 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
Bram Moolenaar768ce242016-02-07 19:46:12 +01001579 --emsg_off;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001580 regmatch.rm_ic = FALSE;
1581 if (end != NULL)
1582 *end = save_char;
1583 p_cpo = save_cpo;
1584 if (regmatch.regprog == NULL)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001585 semsg(_(e_invarg2), pat);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001586 else
1587 {
1588 /*
1589 * Save the value of got_int and reset it. We don't want
1590 * a previous interruption cancel matching, only hitting
1591 * CTRL-C while matching should abort it.
1592 */
1593 prev_got_int = got_int;
1594 got_int = FALSE;
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001595 caught = vim_regexec_nl(&regmatch,
1596 (char_u *)current_exception->value, (colnr_T)0);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001597 got_int |= prev_got_int;
Bram Moolenaar473de612013-06-08 18:19:48 +02001598 vim_regfree(regmatch.regprog);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 }
1600 }
1601 }
1602
1603 if (caught)
1604 {
1605 /* Make this ":catch" clause active and reset did_emsg, got_int,
1606 * and did_throw. Put the exception on the caught stack. */
1607 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1608 did_emsg = got_int = did_throw = FALSE;
1609 catch_exception((except_T *)cstack->cs_exception[idx]);
1610 /* It's mandatory that the current exception is stored in the cstack
1611 * so that it can be discarded at the next ":catch", ":finally", or
1612 * ":endtry" or when the catch clause is left by a ":continue",
1613 * ":break", ":return", ":finish", error, interrupt, or another
1614 * exception. */
1615 if (cstack->cs_exception[cstack->cs_idx] != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001616 internal_error("ex_catch()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001617 }
1618 else
1619 {
1620 /*
1621 * If there is a preceding catch clause and it caught the exception,
1622 * finish the exception now. This happens also after errors except
1623 * when this ":catch" was after the ":finally" or not within
1624 * a ":try". Make the try conditional inactive so that the
1625 * following catch clauses are skipped. On an error or interrupt
1626 * after the preceding try block or catch clause was left by
1627 * a ":continue", ":break", ":return", or ":finish", discard the
1628 * pending action.
1629 */
1630 cleanup_conditionals(cstack, CSF_TRY, TRUE);
1631 }
1632 }
1633
1634 if (end != NULL)
1635 eap->nextcmd = find_nextcmd(end);
1636}
1637
1638/*
1639 * ":finally"
1640 */
1641 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001642ex_finally(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643{
1644 int idx;
1645 int skip = FALSE;
1646 int pending = CSTP_NONE;
1647 struct condstack *cstack = eap->cstack;
1648
1649 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001650 eap->errmsg = N_("E606: :finally without :try");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001651 else
1652 {
1653 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1654 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001655 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656 for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1657 if (cstack->cs_flags[idx] & CSF_TRY)
1658 break;
1659 /* Make this error pending, so that the commands in the following
1660 * finally clause can be executed. This overrules also a pending
1661 * ":continue", ":break", ":return", or ":finish". */
1662 pending = CSTP_ERROR;
1663 }
1664 else
1665 idx = cstack->cs_idx;
1666
1667 if (cstack->cs_flags[idx] & CSF_FINALLY)
1668 {
1669 /* Give up for a multiple ":finally" and ignore it. */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001670 eap->errmsg = N_("E607: multiple :finally");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 return;
1672 }
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001673 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
Bram Moolenaar12805862005-01-05 22:16:17 +00001674 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001675
1676 /*
1677 * Don't do something when the corresponding try block never got active
1678 * (because of an inactive surrounding conditional or after an error or
1679 * interrupt or throw) or for a ":finally" without ":try" or a multiple
1680 * ":finally". After every other error (did_emsg or the conditional
1681 * errors detected above) or after an interrupt (got_int) or an
1682 * exception (did_throw), the finally clause must be executed.
1683 */
1684 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1685
1686 if (!skip)
1687 {
1688 /* When debugging or a breakpoint was encountered, display the
1689 * debug prompt (if not already done). The user then knows that the
1690 * finally clause is executed. */
1691 if (dbg_check_skipped(eap))
1692 {
1693 /* Handle a ">quit" debug command as if an interrupt had
1694 * occurred before the ":finally". That is, discard the
1695 * original exception and replace it by an interrupt
1696 * exception. */
1697 (void)do_intthrow(cstack);
1698 }
1699
1700 /*
1701 * If there is a preceding catch clause and it caught the exception,
1702 * finish the exception now. This happens also after errors except
1703 * when this is a multiple ":finally" or one not within a ":try".
1704 * After an error or interrupt, this also discards a pending
1705 * ":continue", ":break", ":finish", or ":return" from the preceding
1706 * try block or catch clause.
1707 */
1708 cleanup_conditionals(cstack, CSF_TRY, FALSE);
1709
1710 /*
1711 * Make did_emsg, got_int, did_throw pending. If set, they overrule
1712 * a pending ":continue", ":break", ":return", or ":finish". Then
1713 * we have particularly to discard a pending return value (as done
1714 * by the call to cleanup_conditionals() above when did_emsg or
1715 * got_int is set). The pending values are restored by the
1716 * ":endtry", except if there is a new error, interrupt, exception,
1717 * ":continue", ":break", ":return", or ":finish" in the following
Bram Moolenaar12805862005-01-05 22:16:17 +00001718 * finally clause. A missing ":endwhile", ":endfor" or ":endif"
1719 * detected here is treated as if did_emsg and did_throw had
1720 * already been set, respectively in case that the error is not
1721 * converted to an exception, did_throw had already been unset.
1722 * We must not set did_emsg here since that would suppress the
1723 * error message.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001724 */
1725 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1726 {
1727 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
1728 {
1729 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001730 cstack->cs_rettv[cstack->cs_idx]);
1731 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732 }
1733 if (pending == CSTP_ERROR && !did_emsg)
1734 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
1735 else
1736 pending |= did_throw ? CSTP_THROW : 0;
1737 pending |= did_emsg ? CSTP_ERROR : 0;
1738 pending |= got_int ? CSTP_INTERRUPT : 0;
1739 cstack->cs_pending[cstack->cs_idx] = pending;
1740
1741 /* It's mandatory that the current exception is stored in the
1742 * cstack so that it can be rethrown at the ":endtry" or be
1743 * discarded if the finally clause is left by a ":continue",
1744 * ":break", ":return", ":finish", error, interrupt, or another
1745 * exception. When emsg() is called for a missing ":endif" or
Bram Moolenaar12805862005-01-05 22:16:17 +00001746 * a missing ":endwhile"/":endfor" detected here, the
1747 * exception will be discarded. */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00001748 if (did_throw && cstack->cs_exception[cstack->cs_idx]
1749 != current_exception)
Bram Moolenaar95f09602016-11-10 20:01:45 +01001750 internal_error("ex_finally()");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001751 }
1752
1753 /*
Bram Moolenaar12805862005-01-05 22:16:17 +00001754 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
Bram Moolenaard4755bb2004-09-02 19:12:26 +00001755 * got_int, and did_throw and make the finally clause active.
1756 * This will happen after emsg() has been called for a missing
Bram Moolenaar12805862005-01-05 22:16:17 +00001757 * ":endif" or a missing ":endwhile"/":endfor" detected here, so
1758 * that the following finally clause will be executed even then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001759 */
Bram Moolenaar12805862005-01-05 22:16:17 +00001760 cstack->cs_lflags |= CSL_HAD_FINA;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001761 }
1762 }
1763}
1764
1765/*
1766 * ":endtry"
1767 */
1768 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001769ex_endtry(exarg_T *eap)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001770{
1771 int idx;
1772 int skip;
1773 int rethrow = FALSE;
1774 int pending = CSTP_NONE;
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001775 void *rettv = NULL;
Bram Moolenaar071d4272004-06-13 20:20:40 +00001776 struct condstack *cstack = eap->cstack;
1777
1778 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01001779 eap->errmsg = N_("E602: :endtry without :try");
Bram Moolenaar071d4272004-06-13 20:20:40 +00001780 else
1781 {
1782 /*
1783 * Don't do something after an error, interrupt or throw in the try
1784 * block, catch clause, or finally clause preceding this ":endtry" or
1785 * when an error or interrupt occurred after a ":continue", ":break",
1786 * ":return", or ":finish" in a try block or catch clause preceding this
1787 * ":endtry" or when the try block never got active (because of an
1788 * inactive surrounding conditional or after an error or interrupt or
1789 * throw) or when there is a surrounding conditional and it has been
1790 * made inactive by a ":continue", ":break", ":return", or ":finish" in
1791 * the finally clause. The latter case need not be tested since then
1792 * anything pending has already been discarded. */
1793 skip = did_emsg || got_int || did_throw ||
1794 !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1795
1796 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1797 {
Bram Moolenaar12805862005-01-05 22:16:17 +00001798 eap->errmsg = get_end_emsg(cstack);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001799 /* Find the matching ":try" and report what's missing. */
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 idx = cstack->cs_idx;
1801 do
1802 --idx;
1803 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
Bram Moolenaar12805862005-01-05 22:16:17 +00001804 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1805 &cstack->cs_looplevel);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001806 skip = TRUE;
1807
1808 /*
1809 * If an exception is being thrown, discard it to prevent it from
1810 * being rethrown at the end of this function. It would be
1811 * discarded by the error message, anyway. Resets did_throw.
1812 * This does not affect the script termination due to the error
1813 * since "trylevel" is decremented after emsg() has been called.
1814 */
1815 if (did_throw)
1816 discard_current_exception();
1817 }
1818 else
1819 {
1820 idx = cstack->cs_idx;
1821
1822 /*
1823 * If we stopped with the exception currently being thrown at this
1824 * try conditional since we didn't know that it doesn't have
1825 * a finally clause, we need to rethrow it after closing the try
1826 * conditional.
1827 */
1828 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
1829 && !(cstack->cs_flags[idx] & CSF_FINALLY))
1830 rethrow = TRUE;
1831 }
1832
1833 /* If there was no finally clause, show the user when debugging or
1834 * a breakpoint was encountered that the end of the try conditional has
1835 * been reached: display the debug prompt (if not already done). Do
1836 * this on normal control flow or when an exception was thrown, but not
1837 * on an interrupt or error not converted to an exception or when
1838 * a ":break", ":continue", ":return", or ":finish" is pending. These
1839 * actions are carried out immediately.
1840 */
1841 if ((rethrow || (!skip
1842 && !(cstack->cs_flags[idx] & CSF_FINALLY)
1843 && !cstack->cs_pending[idx]))
1844 && dbg_check_skipped(eap))
1845 {
1846 /* Handle a ">quit" debug command as if an interrupt had occurred
1847 * before the ":endtry". That is, throw an interrupt exception and
1848 * set "skip" and "rethrow". */
1849 if (got_int)
1850 {
1851 skip = TRUE;
1852 (void)do_intthrow(cstack);
1853 /* The do_intthrow() call may have reset did_throw or
1854 * cstack->cs_pending[idx].*/
1855 rethrow = FALSE;
1856 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY))
1857 rethrow = TRUE;
1858 }
1859 }
1860
1861 /*
1862 * If a ":return" is pending, we need to resume it after closing the
1863 * try conditional; remember the return value. If there was a finally
1864 * clause making an exception pending, we need to rethrow it. Make it
1865 * the exception currently being thrown.
1866 */
1867 if (!skip)
1868 {
1869 pending = cstack->cs_pending[idx];
1870 cstack->cs_pending[idx] = CSTP_NONE;
1871 if (pending == CSTP_RETURN)
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001872 rettv = cstack->cs_rettv[idx];
Bram Moolenaar071d4272004-06-13 20:20:40 +00001873 else if (pending & CSTP_THROW)
1874 current_exception = cstack->cs_exception[idx];
1875 }
1876
1877 /*
1878 * Discard anything pending on an error, interrupt, or throw in the
1879 * finally clause. If there was no ":finally", discard a pending
1880 * ":continue", ":break", ":return", or ":finish" if an error or
1881 * interrupt occurred afterwards, but before the ":endtry" was reached.
1882 * If an exception was caught by the last of the catch clauses and there
1883 * was no finally clause, finish the exception now. This happens also
1884 * after errors except when this ":endtry" is not within a ":try".
1885 * Restore "emsg_silent" if it has been reset by this try conditional.
1886 */
Bram Moolenaareb3593b2006-04-22 22:33:57 +00001887 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001888
1889 --cstack->cs_idx;
1890 --cstack->cs_trylevel;
1891
1892 if (!skip)
1893 {
1894 report_resume_pending(pending,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001895 (pending == CSTP_RETURN) ? rettv :
Bram Moolenaar071d4272004-06-13 20:20:40 +00001896 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
1897 switch (pending)
1898 {
1899 case CSTP_NONE:
1900 break;
1901
1902 /* Reactivate a pending ":continue", ":break", ":return",
1903 * ":finish" from the try block or a catch clause of this try
1904 * conditional. This is skipped, if there was an error in an
1905 * (unskipped) conditional command or an interrupt afterwards
1906 * or if the finally clause is present and executed a new error,
1907 * interrupt, throw, ":continue", ":break", ":return", or
1908 * ":finish". */
1909 case CSTP_CONTINUE:
1910 ex_continue(eap);
1911 break;
1912 case CSTP_BREAK:
1913 ex_break(eap);
1914 break;
1915 case CSTP_RETURN:
Bram Moolenaarfca34d62005-01-04 21:38:36 +00001916 do_return(eap, FALSE, FALSE, rettv);
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 break;
1918 case CSTP_FINISH:
1919 do_finish(eap, FALSE);
1920 break;
1921
1922 /* When the finally clause was entered due to an error,
1923 * interrupt or throw (as opposed to a ":continue", ":break",
1924 * ":return", or ":finish"), restore the pending values of
1925 * did_emsg, got_int, and did_throw. This is skipped, if there
1926 * was a new error, interrupt, throw, ":continue", ":break",
1927 * ":return", or ":finish". in the finally clause. */
1928 default:
1929 if (pending & CSTP_ERROR)
1930 did_emsg = TRUE;
1931 if (pending & CSTP_INTERRUPT)
1932 got_int = TRUE;
1933 if (pending & CSTP_THROW)
1934 rethrow = TRUE;
1935 break;
1936 }
1937 }
1938
1939 if (rethrow)
1940 /* Rethrow the current exception (within this cstack). */
1941 do_throw(cstack);
1942 }
1943}
1944
1945/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001946 * enter_cleanup() and leave_cleanup()
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001947 *
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001948 * Functions to be called before/after invoking a sequence of autocommands for
1949 * cleanup for a failed command. (Failure means here that a call to emsg()
1950 * has been made, an interrupt occurred, or there is an uncaught exception
1951 * from a previous autocommand execution of the same command.)
1952 *
1953 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same
1954 * pointer to leave_cleanup(). The cleanup_T structure stores the pending
1955 * error/interrupt/exception state.
1956 */
1957
1958/*
1959 * This function works a bit like ex_finally() except that there was not
1960 * actually an extra try block around the part that failed and an error or
1961 * interrupt has not (yet) been converted to an exception. This function
1962 * saves the error/interrupt/ exception state and prepares for the call to
1963 * do_cmdline() that is going to be made for the cleanup autocommand
1964 * execution.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001965 */
1966 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01001967enter_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001968{
1969 int pending = CSTP_NONE;
1970
1971 /*
1972 * Postpone did_emsg, got_int, did_throw. The pending values will be
1973 * restored by leave_cleanup() except if there was an aborting error,
1974 * interrupt, or uncaught exception after this function ends.
1975 */
1976 if (did_emsg || got_int || did_throw || need_rethrow)
1977 {
1978 csp->pending = (did_emsg ? CSTP_ERROR : 0)
1979 | (got_int ? CSTP_INTERRUPT : 0)
1980 | (did_throw ? CSTP_THROW : 0)
1981 | (need_rethrow ? CSTP_THROW : 0);
1982
1983 /* If we are currently throwing an exception (did_throw), save it as
1984 * well. On an error not yet converted to an exception, update
1985 * "force_abort" and reset "cause_abort" (as do_errthrow() would do).
1986 * This is needed for the do_cmdline() call that is going to be made
1987 * for autocommand execution. We need not save *msg_list because
1988 * there is an extra instance for every call of do_cmdline(), anyway.
1989 */
1990 if (did_throw || need_rethrow)
Bram Moolenaarcae24be2017-07-10 22:12:10 +02001991 {
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001992 csp->exception = current_exception;
Bram Moolenaarcae24be2017-07-10 22:12:10 +02001993 current_exception = NULL;
1994 }
Bram Moolenaarc0197e22004-09-13 20:26:32 +00001995 else
1996 {
1997 csp->exception = NULL;
1998 if (did_emsg)
1999 {
2000 force_abort |= cause_abort;
2001 cause_abort = FALSE;
2002 }
2003 }
2004 did_emsg = got_int = did_throw = need_rethrow = FALSE;
2005
2006 /* Report if required by the 'verbose' option or when debugging. */
2007 report_make_pending(pending, csp->exception);
2008 }
2009 else
2010 {
2011 csp->pending = CSTP_NONE;
2012 csp->exception = NULL;
2013 }
2014}
2015
2016/*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002017 * See comment above enter_cleanup() for how this function is used.
2018 *
2019 * This function is a bit like ex_endtry() except that there was not actually
2020 * an extra try block around the part that failed and an error or interrupt
2021 * had not (yet) been converted to an exception when the cleanup autocommand
2022 * sequence was invoked.
2023 *
2024 * This function has to be called with the address of the cleanup_T structure
2025 * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2026 * exception state saved by that function - except there was an aborting
2027 * error, an interrupt or an uncaught exception during execution of the
2028 * cleanup autocommands. In the latter case, the saved error/interrupt/
2029 * exception state is discarded.
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002030 */
2031 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002032leave_cleanup(cleanup_T *csp)
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002033{
2034 int pending = csp->pending;
2035
2036 if (pending == CSTP_NONE) /* nothing to do */
2037 return;
2038
2039 /* If there was an aborting error, an interrupt, or an uncaught exception
2040 * after the corresponding call to enter_cleanup(), discard what has been
2041 * made pending by it. Report this to the user if required by the
2042 * 'verbose' option or when debugging. */
2043 if (aborting() || need_rethrow)
2044 {
2045 if (pending & CSTP_THROW)
2046 /* Cancel the pending exception (includes report). */
2047 discard_exception((except_T *)csp->exception, FALSE);
2048 else
2049 report_discard_pending(pending, NULL);
2050
2051 /* If an error was about to be converted to an exception when
2052 * enter_cleanup() was called, free the message list. */
Bram Moolenaar4632d292006-11-28 17:36:37 +00002053 if (msg_list != NULL)
Bram Moolenaar9fee7d42013-11-28 17:04:43 +01002054 free_global_msglist();
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002055 }
2056
2057 /*
2058 * If there was no new error, interrupt, or throw between the calls
2059 * to enter_cleanup() and leave_cleanup(), restore the pending
2060 * error/interrupt/exception state.
2061 */
2062 else
2063 {
2064 /*
2065 * If there was an exception being thrown when enter_cleanup() was
2066 * called, we need to rethrow it. Make it the exception currently
2067 * being thrown.
2068 */
2069 if (pending & CSTP_THROW)
2070 current_exception = csp->exception;
2071
2072 /*
2073 * If an error was about to be converted to an exception when
2074 * enter_cleanup() was called, let "cause_abort" take the part of
2075 * "force_abort" (as done by cause_errthrow()).
2076 */
2077 else if (pending & CSTP_ERROR)
2078 {
2079 cause_abort = force_abort;
2080 force_abort = FALSE;
2081 }
2082
2083 /*
2084 * Restore the pending values of did_emsg, got_int, and did_throw.
2085 */
2086 if (pending & CSTP_ERROR)
2087 did_emsg = TRUE;
2088 if (pending & CSTP_INTERRUPT)
2089 got_int = TRUE;
2090 if (pending & CSTP_THROW)
2091 need_rethrow = TRUE; /* did_throw will be set by do_one_cmd() */
2092
2093 /* Report if required by the 'verbose' option or when debugging. */
2094 report_resume_pending(pending,
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002095 (pending & CSTP_THROW) ? (void *)current_exception : NULL);
Bram Moolenaarc0197e22004-09-13 20:26:32 +00002096 }
2097}
2098
2099
2100/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 * Make conditionals inactive and discard what's pending in finally clauses
2102 * until the conditional type searched for or a try conditional not in its
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002103 * finally clause is reached. If this is in an active catch clause, finish
2104 * the caught exception.
2105 * Return the cstack index where the search stopped.
Bram Moolenaar12805862005-01-05 22:16:17 +00002106 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
2107 * the latter meaning the innermost try conditional not in its finally clause.
2108 * "inclusive" tells whether the conditional searched for should be made
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002109 * inactive itself (a try conditional not in its finally clause possibly find
Bram Moolenaar12805862005-01-05 22:16:17 +00002110 * before is always made inactive). If "inclusive" is TRUE and
2111 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
2112 * "emsg_silent", if reset when the try conditional finally reached was
Bram Moolenaar84a05ac2013-05-06 04:24:17 +02002113 * entered, is restored (used by ex_endtry()). This is normally done only
Bram Moolenaar12805862005-01-05 22:16:17 +00002114 * when such a try conditional is left.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 */
2116 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002117cleanup_conditionals(
2118 struct condstack *cstack,
2119 int searched_cond,
2120 int inclusive)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121{
2122 int idx;
2123 int stop = FALSE;
2124
2125 for (idx = cstack->cs_idx; idx >= 0; --idx)
2126 {
2127 if (cstack->cs_flags[idx] & CSF_TRY)
2128 {
2129 /*
2130 * Discard anything pending in a finally clause and continue the
2131 * search. There may also be a pending ":continue", ":break",
2132 * ":return", or ":finish" before the finally clause. We must not
2133 * discard it, unless an error or interrupt occurred afterwards.
2134 */
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002135 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002136 {
2137 switch (cstack->cs_pending[idx])
2138 {
2139 case CSTP_NONE:
2140 break;
2141
2142 case CSTP_CONTINUE:
2143 case CSTP_BREAK:
2144 case CSTP_FINISH:
2145 report_discard_pending(cstack->cs_pending[idx], NULL);
2146 cstack->cs_pending[idx] = CSTP_NONE;
2147 break;
2148
2149 case CSTP_RETURN:
2150 report_discard_pending(CSTP_RETURN,
Bram Moolenaarfca34d62005-01-04 21:38:36 +00002151 cstack->cs_rettv[idx]);
2152 discard_pending_return(cstack->cs_rettv[idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002153 cstack->cs_pending[idx] = CSTP_NONE;
2154 break;
2155
2156 default:
2157 if (cstack->cs_flags[idx] & CSF_FINALLY)
2158 {
2159 if (cstack->cs_pending[idx] & CSTP_THROW)
2160 {
2161 /* Cancel the pending exception. This is in the
2162 * finally clause, so that the stack of the
2163 * caught exceptions is not involved. */
2164 discard_exception((except_T *)
2165 cstack->cs_exception[idx],
2166 FALSE);
2167 }
2168 else
2169 report_discard_pending(cstack->cs_pending[idx],
2170 NULL);
2171 cstack->cs_pending[idx] = CSTP_NONE;
2172 }
2173 break;
2174 }
2175 }
2176
2177 /*
2178 * Stop at a try conditional not in its finally clause. If this try
2179 * conditional is in an active catch clause, finish the caught
2180 * exception.
2181 */
2182 if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2183 {
2184 if ((cstack->cs_flags[idx] & CSF_ACTIVE)
2185 && (cstack->cs_flags[idx] & CSF_CAUGHT))
2186 finish_exception((except_T *)cstack->cs_exception[idx]);
2187 /* Stop at this try conditional - except the try block never
2188 * got active (because of an inactive surrounding conditional
2189 * or when the ":try" appeared after an error or interrupt or
2190 * throw). */
2191 if (cstack->cs_flags[idx] & CSF_TRUE)
2192 {
2193 if (searched_cond == 0 && !inclusive)
2194 break;
2195 stop = TRUE;
2196 }
2197 }
2198 }
2199
2200 /* Stop on the searched conditional type (even when the surrounding
2201 * conditional is not active or something has been made pending).
2202 * If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2203 * check first whether "emsg_silent" needs to be restored. */
2204 if (cstack->cs_flags[idx] & searched_cond)
2205 {
2206 if (!inclusive)
2207 break;
2208 stop = TRUE;
2209 }
2210 cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2211 if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2212 break;
2213
2214 /*
Bram Moolenaarccc18222007-05-10 18:25:20 +00002215 * When leaving a try conditional that reset "emsg_silent" on its
2216 * entry after saving the original value, restore that value here and
2217 * free the memory used to store it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 */
2219 if ((cstack->cs_flags[idx] & CSF_TRY)
Bram Moolenaarf461c8e2005-06-25 23:04:51 +00002220 && (cstack->cs_flags[idx] & CSF_SILENT))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002221 {
2222 eslist_T *elem;
2223
2224 elem = cstack->cs_emsg_silent_list;
2225 cstack->cs_emsg_silent_list = elem->next;
2226 emsg_silent = elem->saved_emsg_silent;
2227 vim_free(elem);
2228 cstack->cs_flags[idx] &= ~CSF_SILENT;
2229 }
2230 if (stop)
2231 break;
2232 }
2233 return idx;
2234}
2235
2236/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002237 * Return an appropriate error message for a missing endwhile/endfor/endif.
2238 */
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002239 static char *
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002240get_end_emsg(struct condstack *cstack)
Bram Moolenaar12805862005-01-05 22:16:17 +00002241{
2242 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
2243 return e_endwhile;
2244 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2245 return e_endfor;
2246 return e_endif;
2247}
2248
2249
2250/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002251 * Rewind conditionals until index "idx" is reached. "cond_type" and
2252 * "cond_level" specify a conditional type and the address of a level variable
2253 * which is to be decremented with each skipped conditional of the specified
2254 * type.
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002255 * Also free "for info" structures where needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 */
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002257 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002258rewind_conditionals(
2259 struct condstack *cstack,
2260 int idx,
2261 int cond_type,
2262 int *cond_level)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002263{
2264 while (cstack->cs_idx > idx)
2265 {
2266 if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2267 --*cond_level;
Bram Moolenaarde8866b2005-01-06 23:24:37 +00002268 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2269 free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 --cstack->cs_idx;
2271 }
2272}
2273
2274/*
2275 * ":endfunction" when not after a ":function"
2276 */
Bram Moolenaar071d4272004-06-13 20:20:40 +00002277 void
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002278ex_endfunction(exarg_T *eap UNUSED)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279{
Bram Moolenaarf9e3e092019-01-13 23:38:42 +01002280 emsg(_("E193: :endfunction not inside a function"));
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281}
2282
2283/*
Bram Moolenaar12805862005-01-05 22:16:17 +00002284 * Return TRUE if the string "p" looks like a ":while" or ":for" command.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 */
2286 int
Bram Moolenaar78c0b7d2016-01-30 15:52:46 +01002287has_loop_cmd(char_u *p)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288{
Bram Moolenaared53fb92007-11-24 20:50:24 +00002289 int len;
2290
2291 /* skip modifiers, white space and ':' */
2292 for (;;)
2293 {
2294 while (*p == ' ' || *p == '\t' || *p == ':')
2295 ++p;
2296 len = modifier_len(p);
2297 if (len == 0)
2298 break;
2299 p += len;
2300 }
Bram Moolenaar12805862005-01-05 22:16:17 +00002301 if ((p[0] == 'w' && p[1] == 'h')
2302 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
Bram Moolenaar071d4272004-06-13 20:20:40 +00002303 return TRUE;
2304 return FALSE;
2305}
2306
2307#endif /* FEAT_EVAL */