xref: /vim-8.2.3635/src/ex_eval.c (revision 1a928c20)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
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 
18 static int	throw_exception(void *, except_type_T, char_u *);
19 static char	*get_end_emsg(cstack_T *cstack);
20 
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
46  * be set asynchronously afterwards by a SIGINT, so did_throw && got_int is not
47  * 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
62 # define THROW_ON_ERROR_TRUE
63 # define THROW_ON_INTERRUPT	TRUE
64 # define THROW_ON_INTERRUPT_TRUE
65 #endif
66 
67 /*
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  */
76 static int cause_abort = FALSE;
77 
78 /*
79  * Return TRUE when immediately aborting on error, or when an interrupt
80  * 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.
88  * "got_int" is also set by calling interrupt().
89  */
90     int
91 aborting(void)
92 {
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
103 update_force_abort(void)
104 {
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
116 should_abort(int retcode)
117 {
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
128 aborted_in_try(void)
129 {
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
145 cause_errthrow(
146     char_u	*mesg,
147     int		severe,
148     int		*ignore)
149 {
150     struct msglist *elem;
151     struct msglist **plist;
152 
153     /*
154      * 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().
158      */
159     if (suppress_errthrow)
160 	return FALSE;
161 
162     /*
163      * 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.
170      */
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
180      * 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.
184      */
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
190      * 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
192      * 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 
255 	    elem = ALLOC_ONE(struct msglist);
256 	    if (elem == NULL)
257 	    {
258 		suppress_errthrow = TRUE;
259 		emsg(_(e_outofmem));
260 	    }
261 	    else
262 	    {
263 		elem->msg = (char *)vim_strsave(mesg);
264 		if (elem->msg == NULL)
265 		{
266 		    vim_free(elem);
267 		    suppress_errthrow = TRUE;
268 		    emsg(_(e_outofmem));
269 		}
270 		else
271 		{
272 		    elem->next = NULL;
273 		    elem->throw_msg = NULL;
274 		    *plist = elem;
275 		    if (plist == msg_list || severe)
276 		    {
277 			char	    *tmsg;
278 
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
302 free_msglist(struct msglist *l)
303 {
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 /*
317  * Free global "*msg_list" and the messages it contains, then set "*msg_list"
318  * to NULL.
319  */
320     void
321 free_global_msglist(void)
322 {
323     free_msglist(*msg_list);
324     *msg_list = NULL;
325 }
326 
327 /*
328  * 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
333 do_errthrow(cstack_T *cstack, char_u *cmdname)
334 {
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.
347     if (msg_list == NULL || *msg_list == NULL)
348 	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
368 do_intthrow(cstack_T *cstack)
369 {
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 
414 /*
415  * Get an exception message that is to be stored in current_exception->value.
416  */
417     char *
418 get_exception_string(
419     void	*value,
420     except_type_T type,
421     char_u	*cmdname,
422     int		*should_free)
423 {
424     char	*ret;
425     char	*mesg;
426     int		cmdlen;
427     char	*p, *val;
428 
429     if (type == ET_ERROR)
430     {
431 	*should_free = TRUE;
432 	mesg = ((struct msglist *)value)->throw_msg;
433 	if (cmdname != NULL && *cmdname != NUL)
434 	{
435 	    cmdlen = (int)STRLEN(cmdname);
436 	    ret = (char *)vim_strnsave((char_u *)"Vim(",
437 					   4 + cmdlen + 2 + (int)STRLEN(mesg));
438 	    if (ret == NULL)
439 		return ret;
440 	    STRCPY(&ret[4], cmdname);
441 	    STRCPY(&ret[4 + cmdlen], "):");
442 	    val = ret + 4 + cmdlen + 2;
443 	}
444 	else
445 	{
446 	    ret = (char *)vim_strnsave((char_u *)"Vim:", 4 + (int)STRLEN(mesg));
447 	    if (ret == NULL)
448 		return ret;
449 	    val = ret + 4;
450 	}
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 	    {
466 		if (*p == NUL || p == mesg)
467 		    STRCAT(val, mesg);  // 'E123' missing or at beginning
468 		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
486     {
487 	*should_free = FALSE;
488 	ret = value;
489     }
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
502 throw_exception(void *value, except_type_T type, char_u *cmdname)
503 {
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 	{
518 	    emsg(_("E608: Cannot :throw exceptions with 'Vim' prefix"));
519 	    goto fail;
520 	}
521     }
522 
523     excp = ALLOC_ONE(except_T);
524     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;
535 
536     excp->type = type;
537     excp->throw_name = estack_sfile();
538     if (excp->throw_name == NULL)
539 	excp->throw_name = vim_strsave((char_u *)"");
540     if (excp->throw_name == NULL)
541     {
542 	if (should_free)
543 	    vim_free(excp->value);
544 	goto nomem;
545     }
546     excp->throw_lnum = SOURCING_LNUM;
547 
548     if (p_verbose >= 13 || debug_break_level > 0)
549     {
550 	int	save_msg_silent = msg_silent;
551 
552 	if (debug_break_level > 0)
553 	    msg_silent = FALSE;		// display messages
554 	else
555 	    verbose_enter();
556 	++no_wait_return;
557 	if (debug_break_level > 0 || *p_vfile == NUL)
558 	    msg_scroll = TRUE;	    // always scroll up, don't overwrite
559 
560 	smsg(_("Exception thrown: %s"), excp->value);
561 	msg_puts("\n");   // don't overwrite this either
562 
563 	if (debug_break_level > 0 || *p_vfile == NUL)
564 	    cmdline_row = msg_row;
565 	--no_wait_return;
566 	if (debug_break_level > 0)
567 	    msg_silent = save_msg_silent;
568 	else
569 	    verbose_leave();
570     }
571 
572     current_exception = excp;
573     return OK;
574 
575 nomem:
576     vim_free(excp);
577     suppress_errthrow = TRUE;
578     emsg(_(e_outofmem));
579 fail:
580     current_exception = NULL;
581     return FAIL;
582 }
583 
584 /*
585  * Discard an exception.  "was_finished" is set when the exception has been
586  * caught and the catch clause has been ended normally.
587  */
588     static void
589 discard_exception(except_T *excp, int was_finished)
590 {
591     char_u		*saved_IObuff;
592 
593     if (excp == NULL)
594     {
595 	internal_error("discard_exception()");
596 	return;
597     }
598 
599     if (p_verbose >= 13 || debug_break_level > 0)
600     {
601 	int	save_msg_silent = msg_silent;
602 
603 	saved_IObuff = vim_strsave(IObuff);
604 	if (debug_break_level > 0)
605 	    msg_silent = FALSE;		// display messages
606 	else
607 	    verbose_enter();
608 	++no_wait_return;
609 	if (debug_break_level > 0 || *p_vfile == NUL)
610 	    msg_scroll = TRUE;	    // always scroll up, don't overwrite
611 	smsg(was_finished
612 		    ? _("Exception finished: %s")
613 		    : _("Exception discarded: %s"),
614 		excp->value);
615 	msg_puts("\n");   // don't overwrite this either
616 	if (debug_break_level > 0 || *p_vfile == NUL)
617 	    cmdline_row = msg_row;
618 	--no_wait_return;
619 	if (debug_break_level > 0)
620 	    msg_silent = save_msg_silent;
621 	else
622 	    verbose_leave();
623 	STRCPY(IObuff, saved_IObuff);
624 	vim_free(saved_IObuff);
625     }
626     if (excp->type != ET_INTERRUPT)
627 	vim_free(excp->value);
628     if (excp->type == ET_ERROR)
629 	free_msglist(excp->messages);
630     vim_free(excp->throw_name);
631     vim_free(excp);
632 }
633 
634 /*
635  * Discard the exception currently being thrown.
636  */
637     void
638 discard_current_exception(void)
639 {
640     if (current_exception != NULL)
641     {
642 	discard_exception(current_exception, FALSE);
643 	current_exception = NULL;
644     }
645     did_throw = FALSE;
646     need_rethrow = FALSE;
647 }
648 
649 /*
650  * Put an exception on the caught stack.
651  */
652     static void
653 catch_exception(except_T *excp)
654 {
655     excp->caught = caught_stack;
656     caught_stack = excp;
657     set_vim_var_string(VV_EXCEPTION, (char_u *)excp->value, -1);
658     if (*excp->throw_name != NUL)
659     {
660 	if (excp->throw_lnum != 0)
661 	    vim_snprintf((char *)IObuff, IOSIZE, _("%s, line %ld"),
662 				    excp->throw_name, (long)excp->throw_lnum);
663 	else
664 	    vim_snprintf((char *)IObuff, IOSIZE, "%s", excp->throw_name);
665 	set_vim_var_string(VV_THROWPOINT, IObuff, -1);
666     }
667     else
668 	// throw_name not set on an exception from a command that was typed.
669 	set_vim_var_string(VV_THROWPOINT, NULL, -1);
670 
671     if (p_verbose >= 13 || debug_break_level > 0)
672     {
673 	int	save_msg_silent = msg_silent;
674 
675 	if (debug_break_level > 0)
676 	    msg_silent = FALSE;		// display messages
677 	else
678 	    verbose_enter();
679 	++no_wait_return;
680 	if (debug_break_level > 0 || *p_vfile == NUL)
681 	    msg_scroll = TRUE;	    // always scroll up, don't overwrite
682 
683 	smsg(_("Exception caught: %s"), excp->value);
684 	msg_puts("\n");   // don't overwrite this either
685 
686 	if (debug_break_level > 0 || *p_vfile == NUL)
687 	    cmdline_row = msg_row;
688 	--no_wait_return;
689 	if (debug_break_level > 0)
690 	    msg_silent = save_msg_silent;
691 	else
692 	    verbose_leave();
693     }
694 }
695 
696 /*
697  * Remove an exception from the caught stack.
698  */
699     static void
700 finish_exception(except_T *excp)
701 {
702     if (excp != caught_stack)
703 	internal_error("finish_exception()");
704     caught_stack = caught_stack->caught;
705     if (caught_stack != NULL)
706     {
707 	set_vim_var_string(VV_EXCEPTION, (char_u *)caught_stack->value, -1);
708 	if (*caught_stack->throw_name != NUL)
709 	{
710 	    if (caught_stack->throw_lnum != 0)
711 		vim_snprintf((char *)IObuff, IOSIZE,
712 			_("%s, line %ld"), caught_stack->throw_name,
713 			(long)caught_stack->throw_lnum);
714 	    else
715 		vim_snprintf((char *)IObuff, IOSIZE, "%s",
716 						    caught_stack->throw_name);
717 	    set_vim_var_string(VV_THROWPOINT, IObuff, -1);
718 	}
719 	else
720 	    // throw_name not set on an exception from a command that was
721 	    // typed.
722 	    set_vim_var_string(VV_THROWPOINT, NULL, -1);
723     }
724     else
725     {
726 	set_vim_var_string(VV_EXCEPTION, NULL, -1);
727 	set_vim_var_string(VV_THROWPOINT, NULL, -1);
728     }
729 
730     // Discard the exception, but use the finish message for 'verbose'.
731     discard_exception(excp, TRUE);
732 }
733 
734 /*
735  * Flags specifying the message displayed by report_pending.
736  */
737 #define RP_MAKE		0
738 #define RP_RESUME	1
739 #define RP_DISCARD	2
740 
741 /*
742  * Report information about something pending in a finally clause if required by
743  * the 'verbose' option or when debugging.  "action" tells whether something is
744  * made pending or something pending is resumed or discarded.  "pending" tells
745  * what is pending.  "value" specifies the return value for a pending ":return"
746  * or the exception value for a pending exception.
747  */
748     static void
749 report_pending(int action, int pending, void *value)
750 {
751     char	*mesg;
752     char	*s;
753     int		save_msg_silent;
754 
755 
756     switch (action)
757     {
758 	case RP_MAKE:
759 	    mesg = _("%s made pending");
760 	    break;
761 	case RP_RESUME:
762 	    mesg = _("%s resumed");
763 	    break;
764 	// case RP_DISCARD:
765 	default:
766 	    mesg = _("%s discarded");
767 	    break;
768     }
769 
770     switch (pending)
771     {
772 	case CSTP_NONE:
773 	    return;
774 
775 	case CSTP_CONTINUE:
776 	    s = ":continue";
777 	    break;
778 	case CSTP_BREAK:
779 	    s = ":break";
780 	    break;
781 	case CSTP_FINISH:
782 	    s = ":finish";
783 	    break;
784 	case CSTP_RETURN:
785 	    // ":return" command producing value, allocated
786 	    s = (char *)get_return_cmd(value);
787 	    break;
788 
789 	default:
790 	    if (pending & CSTP_THROW)
791 	    {
792 		vim_snprintf((char *)IObuff, IOSIZE, mesg, _("Exception"));
793 		mesg = (char *)vim_strnsave(IObuff, (int)STRLEN(IObuff) + 4);
794 		STRCAT(mesg, ": %s");
795 		s = (char *)((except_T *)value)->value;
796 	    }
797 	    else if ((pending & CSTP_ERROR) && (pending & CSTP_INTERRUPT))
798 		s = _("Error and interrupt");
799 	    else if (pending & CSTP_ERROR)
800 		s = _("Error");
801 	    else // if (pending & CSTP_INTERRUPT)
802 		s = _("Interrupt");
803     }
804 
805     save_msg_silent = msg_silent;
806     if (debug_break_level > 0)
807 	msg_silent = FALSE;	// display messages
808     ++no_wait_return;
809     msg_scroll = TRUE;		// always scroll up, don't overwrite
810     smsg(mesg, s);
811     msg_puts("\n");   // don't overwrite this either
812     cmdline_row = msg_row;
813     --no_wait_return;
814     if (debug_break_level > 0)
815 	msg_silent = save_msg_silent;
816 
817     if (pending == CSTP_RETURN)
818 	vim_free(s);
819     else if (pending & CSTP_THROW)
820 	vim_free(mesg);
821 }
822 
823 /*
824  * If something is made pending in a finally clause, report it if required by
825  * the 'verbose' option or when debugging.
826  */
827     void
828 report_make_pending(int pending, void *value)
829 {
830     if (p_verbose >= 14 || debug_break_level > 0)
831     {
832 	if (debug_break_level <= 0)
833 	    verbose_enter();
834 	report_pending(RP_MAKE, pending, value);
835 	if (debug_break_level <= 0)
836 	    verbose_leave();
837     }
838 }
839 
840 /*
841  * If something pending in a finally clause is resumed at the ":endtry", report
842  * it if required by the 'verbose' option or when debugging.
843  */
844     static void
845 report_resume_pending(int pending, void *value)
846 {
847     if (p_verbose >= 14 || debug_break_level > 0)
848     {
849 	if (debug_break_level <= 0)
850 	    verbose_enter();
851 	report_pending(RP_RESUME, pending, value);
852 	if (debug_break_level <= 0)
853 	    verbose_leave();
854     }
855 }
856 
857 /*
858  * If something pending in a finally clause is discarded, report it if required
859  * by the 'verbose' option or when debugging.
860  */
861     static void
862 report_discard_pending(int pending, void *value)
863 {
864     if (p_verbose >= 14 || debug_break_level > 0)
865     {
866 	if (debug_break_level <= 0)
867 	    verbose_enter();
868 	report_pending(RP_DISCARD, pending, value);
869 	if (debug_break_level <= 0)
870 	    verbose_leave();
871     }
872 }
873 
874 
875 /*
876  * ":eval".
877  */
878     void
879 ex_eval(exarg_T *eap)
880 {
881     typval_T	tv;
882 
883     if (eval0(eap->arg, &tv, &eap->nextcmd, !eap->skip) == OK)
884 	clear_tv(&tv);
885 }
886 
887 /*
888  * ":if".
889  */
890     void
891 ex_if(exarg_T *eap)
892 {
893     int		error;
894     int		skip;
895     int		result;
896     cstack_T	*cstack = eap->cstack;
897 
898     if (cstack->cs_idx == CSTACK_LEN - 1)
899 	eap->errmsg = N_("E579: :if nesting too deep");
900     else
901     {
902 	++cstack->cs_idx;
903 	cstack->cs_flags[cstack->cs_idx] = 0;
904 
905 	/*
906 	 * Don't do something after an error, interrupt, or throw, or when there
907 	 * is a surrounding conditional and it was not active.
908 	 */
909 	skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
910 		&& !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
911 
912 	result = eval_to_bool(eap->arg, &error, &eap->nextcmd, skip);
913 
914 	if (!skip && !error)
915 	{
916 	    if (result)
917 		cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
918 	}
919 	else
920 	    // set TRUE, so this conditional will never get active
921 	    cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
922     }
923 }
924 
925 /*
926  * ":endif".
927  */
928     void
929 ex_endif(exarg_T *eap)
930 {
931     did_endif = TRUE;
932     if (eap->cstack->cs_idx < 0
933 	    || (eap->cstack->cs_flags[eap->cstack->cs_idx]
934 					   & (CSF_WHILE | CSF_FOR | CSF_TRY)))
935 	eap->errmsg = N_("E580: :endif without :if");
936     else
937     {
938 	/*
939 	 * When debugging or a breakpoint was encountered, display the debug
940 	 * prompt (if not already done).  This shows the user that an ":endif"
941 	 * is executed when the ":if" or a previous ":elseif" was not TRUE.
942 	 * Handle a ">quit" debug command as if an interrupt had occurred before
943 	 * the ":endif".  That is, throw an interrupt exception if appropriate.
944 	 * Doing this here prevents an exception for a parsing error being
945 	 * discarded by throwing the interrupt exception later on.
946 	 */
947 	if (!(eap->cstack->cs_flags[eap->cstack->cs_idx] & CSF_TRUE)
948 						    && dbg_check_skipped(eap))
949 	    (void)do_intthrow(eap->cstack);
950 
951 	--eap->cstack->cs_idx;
952     }
953 }
954 
955 /*
956  * ":else" and ":elseif".
957  */
958     void
959 ex_else(exarg_T *eap)
960 {
961     int		error;
962     int		skip;
963     int		result;
964     cstack_T	*cstack = eap->cstack;
965 
966     /*
967      * Don't do something after an error, interrupt, or throw, or when there is
968      * a surrounding conditional and it was not active.
969      */
970     skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
971 	    && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
972 
973     if (cstack->cs_idx < 0
974 	    || (cstack->cs_flags[cstack->cs_idx]
975 					   & (CSF_WHILE | CSF_FOR | CSF_TRY)))
976     {
977 	if (eap->cmdidx == CMD_else)
978 	{
979 	    eap->errmsg = N_("E581: :else without :if");
980 	    return;
981 	}
982 	eap->errmsg = N_("E582: :elseif without :if");
983 	skip = TRUE;
984     }
985     else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
986     {
987 	if (eap->cmdidx == CMD_else)
988 	{
989 	    eap->errmsg = N_("E583: multiple :else");
990 	    return;
991 	}
992 	eap->errmsg = N_("E584: :elseif after :else");
993 	skip = TRUE;
994     }
995 
996     // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it
997     if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
998     {
999 	if (eap->errmsg == NULL)
1000 	    cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1001 	skip = TRUE;	// don't evaluate an ":elseif"
1002     }
1003     else
1004 	cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1005 
1006     /*
1007      * When debugging or a breakpoint was encountered, display the debug prompt
1008      * (if not already done).  This shows the user that an ":else" or ":elseif"
1009      * is executed when the ":if" or previous ":elseif" was not TRUE.  Handle
1010      * a ">quit" debug command as if an interrupt had occurred before the
1011      * ":else" or ":elseif".  That is, set "skip" and throw an interrupt
1012      * exception if appropriate.  Doing this here prevents that an exception
1013      * for a parsing errors is discarded when throwing the interrupt exception
1014      * later on.
1015      */
1016     if (!skip && dbg_check_skipped(eap) && got_int)
1017     {
1018 	(void)do_intthrow(cstack);
1019 	skip = TRUE;
1020     }
1021 
1022     if (eap->cmdidx == CMD_elseif)
1023     {
1024 	result = eval_to_bool(eap->arg, &error, &eap->nextcmd, skip);
1025 	// When throwing error exceptions, we want to throw always the first
1026 	// of several errors in a row.  This is what actually happens when
1027 	// a conditional error was detected above and there is another failure
1028 	// when parsing the expression.  Since the skip flag is set in this
1029 	// case, the parsing error will be ignored by emsg().
1030 
1031 	if (!skip && !error)
1032 	{
1033 	    if (result)
1034 		cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1035 	    else
1036 		cstack->cs_flags[cstack->cs_idx] = 0;
1037 	}
1038 	else if (eap->errmsg == NULL)
1039 	    // set TRUE, so this conditional will never get active
1040 	    cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1041     }
1042     else
1043 	cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1044 }
1045 
1046 /*
1047  * Handle ":while" and ":for".
1048  */
1049     void
1050 ex_while(exarg_T *eap)
1051 {
1052     int		error;
1053     int		skip;
1054     int		result;
1055     cstack_T	*cstack = eap->cstack;
1056 
1057     if (cstack->cs_idx == CSTACK_LEN - 1)
1058 	eap->errmsg = N_("E585: :while/:for nesting too deep");
1059     else
1060     {
1061 	/*
1062 	 * The loop flag is set when we have jumped back from the matching
1063 	 * ":endwhile" or ":endfor".  When not set, need to initialise this
1064 	 * cstack entry.
1065 	 */
1066 	if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
1067 	{
1068 	    ++cstack->cs_idx;
1069 	    ++cstack->cs_looplevel;
1070 	    cstack->cs_line[cstack->cs_idx] = -1;
1071 	}
1072 	cstack->cs_flags[cstack->cs_idx] =
1073 			       eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
1074 
1075 	/*
1076 	 * Don't do something after an error, interrupt, or throw, or when
1077 	 * there is a surrounding conditional and it was not active.
1078 	 */
1079 	skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1080 		&& !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1081 	if (eap->cmdidx == CMD_while)
1082 	{
1083 	    /*
1084 	     * ":while bool-expr"
1085 	     */
1086 	    result = eval_to_bool(eap->arg, &error, &eap->nextcmd, skip);
1087 	}
1088 	else
1089 	{
1090 	    void *fi;
1091 
1092 	    /*
1093 	     * ":for var in list-expr"
1094 	     */
1095 	    if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
1096 	    {
1097 		// Jumping here from a ":continue" or ":endfor": use the
1098 		// previously evaluated list.
1099 		fi = cstack->cs_forinfo[cstack->cs_idx];
1100 		error = FALSE;
1101 	    }
1102 	    else
1103 	    {
1104 		// Evaluate the argument and get the info in a structure.
1105 		fi = eval_for_line(eap->arg, &error, &eap->nextcmd, skip);
1106 		cstack->cs_forinfo[cstack->cs_idx] = fi;
1107 	    }
1108 
1109 	    // use the element at the start of the list and advance
1110 	    if (!error && fi != NULL && !skip)
1111 		result = next_for_item(fi, eap->arg);
1112 	    else
1113 		result = FALSE;
1114 
1115 	    if (!result)
1116 	    {
1117 		free_for_info(fi);
1118 		cstack->cs_forinfo[cstack->cs_idx] = NULL;
1119 	    }
1120 	}
1121 
1122 	/*
1123 	 * If this cstack entry was just initialised and is active, set the
1124 	 * loop flag, so do_cmdline() will set the line number in cs_line[].
1125 	 * If executing the command a second time, clear the loop flag.
1126 	 */
1127 	if (!skip && !error && result)
1128 	{
1129 	    cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
1130 	    cstack->cs_lflags ^= CSL_HAD_LOOP;
1131 	}
1132 	else
1133 	{
1134 	    cstack->cs_lflags &= ~CSL_HAD_LOOP;
1135 	    // If the ":while" evaluates to FALSE or ":for" is past the end of
1136 	    // the list, show the debug prompt at the ":endwhile"/":endfor" as
1137 	    // if there was a ":break" in a ":while"/":for" evaluating to
1138 	    // TRUE.
1139 	    if (!skip && !error)
1140 		cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1141 	}
1142     }
1143 }
1144 
1145 /*
1146  * ":continue"
1147  */
1148     void
1149 ex_continue(exarg_T *eap)
1150 {
1151     int		idx;
1152     cstack_T	*cstack = eap->cstack;
1153 
1154     if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
1155 	eap->errmsg = N_("E586: :continue without :while or :for");
1156     else
1157     {
1158 	// Try to find the matching ":while".  This might stop at a try
1159 	// conditional not in its finally clause (which is then to be executed
1160 	// next).  Therefor, inactivate all conditionals except the ":while"
1161 	// itself (if reached).
1162 	idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
1163 	if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
1164 	{
1165 	    rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1166 
1167 	    /*
1168 	     * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
1169 	     * matching ":while".
1170 	     */
1171 	    cstack->cs_lflags |= CSL_HAD_CONT;	// let do_cmdline() handle it
1172 	}
1173 	else
1174 	{
1175 	    // If a try conditional not in its finally clause is reached first,
1176 	    // make the ":continue" pending for execution at the ":endtry".
1177 	    cstack->cs_pending[idx] = CSTP_CONTINUE;
1178 	    report_make_pending(CSTP_CONTINUE, NULL);
1179 	}
1180     }
1181 }
1182 
1183 /*
1184  * ":break"
1185  */
1186     void
1187 ex_break(exarg_T *eap)
1188 {
1189     int		idx;
1190     cstack_T	*cstack = eap->cstack;
1191 
1192     if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
1193 	eap->errmsg = N_("E587: :break without :while or :for");
1194     else
1195     {
1196 	// Inactivate conditionals until the matching ":while" or a try
1197 	// conditional not in its finally clause (which is then to be
1198 	// executed next) is found.  In the latter case, make the ":break"
1199 	// pending for execution at the ":endtry".
1200 	idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
1201 	if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
1202 	{
1203 	    cstack->cs_pending[idx] = CSTP_BREAK;
1204 	    report_make_pending(CSTP_BREAK, NULL);
1205 	}
1206     }
1207 }
1208 
1209 /*
1210  * ":endwhile" and ":endfor"
1211  */
1212     void
1213 ex_endwhile(exarg_T *eap)
1214 {
1215     cstack_T	*cstack = eap->cstack;
1216     int		idx;
1217     char	*err;
1218     int		csf;
1219     int		fl;
1220 
1221     if (eap->cmdidx == CMD_endwhile)
1222     {
1223 	err = e_while;
1224 	csf = CSF_WHILE;
1225     }
1226     else
1227     {
1228 	err = e_for;
1229 	csf = CSF_FOR;
1230     }
1231 
1232     if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
1233 	eap->errmsg = err;
1234     else
1235     {
1236 	fl =  cstack->cs_flags[cstack->cs_idx];
1237 	if (!(fl & csf))
1238 	{
1239 	    // If we are in a ":while" or ":for" but used the wrong endloop
1240 	    // command, do not rewind to the next enclosing ":for"/":while".
1241 	    if (fl & CSF_WHILE)
1242 		eap->errmsg = _("E732: Using :endfor with :while");
1243 	    else if (fl & CSF_FOR)
1244 		eap->errmsg = _("E733: Using :endwhile with :for");
1245 	}
1246 	if (!(fl & (CSF_WHILE | CSF_FOR)))
1247 	{
1248 	    if (!(fl & CSF_TRY))
1249 		eap->errmsg = e_endif;
1250 	    else if (fl & CSF_FINALLY)
1251 		eap->errmsg = e_endtry;
1252 	    // Try to find the matching ":while" and report what's missing.
1253 	    for (idx = cstack->cs_idx; idx > 0; --idx)
1254 	    {
1255 		fl =  cstack->cs_flags[idx];
1256 		if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
1257 		{
1258 		    // Give up at a try conditional not in its finally clause.
1259 		    // Ignore the ":endwhile"/":endfor".
1260 		    eap->errmsg = err;
1261 		    return;
1262 		}
1263 		if (fl & csf)
1264 		    break;
1265 	    }
1266 	    // Cleanup and rewind all contained (and unclosed) conditionals.
1267 	    (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
1268 	    rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1269 	}
1270 
1271 	/*
1272 	 * When debugging or a breakpoint was encountered, display the debug
1273 	 * prompt (if not already done).  This shows the user that an
1274 	 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
1275 	 * after a ":break".  Handle a ">quit" debug command as if an
1276 	 * interrupt had occurred before the ":endwhile"/":endfor".  That is,
1277 	 * throw an interrupt exception if appropriate.  Doing this here
1278 	 * prevents that an exception for a parsing error is discarded when
1279 	 * throwing the interrupt exception later on.
1280 	 */
1281 	else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1282 		&& !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1283 		&& dbg_check_skipped(eap))
1284 	    (void)do_intthrow(cstack);
1285 
1286 	/*
1287 	 * Set loop flag, so do_cmdline() will jump back to the matching
1288 	 * ":while" or ":for".
1289 	 */
1290 	cstack->cs_lflags |= CSL_HAD_ENDLOOP;
1291     }
1292 }
1293 
1294 
1295 /*
1296  * ":throw expr"
1297  */
1298     void
1299 ex_throw(exarg_T *eap)
1300 {
1301     char_u	*arg = eap->arg;
1302     char_u	*value;
1303 
1304     if (*arg != NUL && *arg != '|' && *arg != '\n')
1305 	value = eval_to_string_skip(arg, &eap->nextcmd, eap->skip);
1306     else
1307     {
1308 	emsg(_(e_argreq));
1309 	value = NULL;
1310     }
1311 
1312     // On error or when an exception is thrown during argument evaluation, do
1313     // not throw.
1314     if (!eap->skip && value != NULL)
1315     {
1316 	if (throw_exception(value, ET_USER, NULL) == FAIL)
1317 	    vim_free(value);
1318 	else
1319 	    do_throw(eap->cstack);
1320     }
1321 }
1322 
1323 /*
1324  * Throw the current exception through the specified cstack.  Common routine
1325  * for ":throw" (user exception) and error and interrupt exceptions.  Also
1326  * used for rethrowing an uncaught exception.
1327  */
1328     void
1329 do_throw(cstack_T *cstack)
1330 {
1331     int		idx;
1332     int		inactivate_try = FALSE;
1333 
1334     /*
1335      * Cleanup and inactivate up to the next surrounding try conditional that
1336      * is not in its finally clause.  Normally, do not inactivate the try
1337      * conditional itself, so that its ACTIVE flag can be tested below.  But
1338      * if a previous error or interrupt has not been converted to an exception,
1339      * inactivate the try conditional, too, as if the conversion had been done,
1340      * and reset the did_emsg or got_int flag, so this won't happen again at
1341      * the next surrounding try conditional.
1342      */
1343 #ifndef THROW_ON_ERROR_TRUE
1344     if (did_emsg && !THROW_ON_ERROR)
1345     {
1346 	inactivate_try = TRUE;
1347 	did_emsg = FALSE;
1348     }
1349 #endif
1350 #ifndef THROW_ON_INTERRUPT_TRUE
1351     if (got_int && !THROW_ON_INTERRUPT)
1352     {
1353 	inactivate_try = TRUE;
1354 	got_int = FALSE;
1355     }
1356 #endif
1357     idx = cleanup_conditionals(cstack, 0, inactivate_try);
1358     if (idx >= 0)
1359     {
1360 	/*
1361 	 * If this try conditional is active and we are before its first
1362 	 * ":catch", set THROWN so that the ":catch" commands will check
1363 	 * whether the exception matches.  When the exception came from any of
1364 	 * the catch clauses, it will be made pending at the ":finally" (if
1365 	 * present) and rethrown at the ":endtry".  This will also happen if
1366 	 * the try conditional is inactive.  This is the case when we are
1367 	 * throwing an exception due to an error or interrupt on the way from
1368 	 * a preceding ":continue", ":break", ":return", ":finish", error or
1369 	 * interrupt (not converted to an exception) to the finally clause or
1370 	 * from a preceding throw of a user or error or interrupt exception to
1371 	 * the matching catch clause or the finally clause.
1372 	 */
1373 	if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1374 	{
1375 	    if (cstack->cs_flags[idx] & CSF_ACTIVE)
1376 		cstack->cs_flags[idx] |= CSF_THROWN;
1377 	    else
1378 		// THROWN may have already been set for a catchable exception
1379 		// that has been discarded.  Ensure it is reset for the new
1380 		// exception.
1381 		cstack->cs_flags[idx] &= ~CSF_THROWN;
1382 	}
1383 	cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1384 	cstack->cs_exception[idx] = current_exception;
1385     }
1386 #if 0
1387     // TODO: Add optimization below.  Not yet done because of interface
1388     // problems to eval.c and ex_cmds2.c. (Servatius)
1389     else
1390     {
1391 	/*
1392 	 * There are no catch clauses to check or finally clauses to execute.
1393 	 * End the current script or function.  The exception will be rethrown
1394 	 * in the caller.
1395 	 */
1396 	if (getline_equal(eap->getline, eap->cookie, get_func_line))
1397 	    current_funccal->returned = TRUE;
1398 	elseif (eap->get_func_line == getsourceline)
1399 	    ((struct source_cookie *)eap->cookie)->finished = TRUE;
1400     }
1401 #endif
1402 
1403     did_throw = TRUE;
1404 }
1405 
1406 /*
1407  * ":try"
1408  */
1409     void
1410 ex_try(exarg_T *eap)
1411 {
1412     int		skip;
1413     cstack_T	*cstack = eap->cstack;
1414 
1415     if (cstack->cs_idx == CSTACK_LEN - 1)
1416 	eap->errmsg = N_("E601: :try nesting too deep");
1417     else
1418     {
1419 	++cstack->cs_idx;
1420 	++cstack->cs_trylevel;
1421 	cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1422 	cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1423 
1424 	/*
1425 	 * Don't do something after an error, interrupt, or throw, or when there
1426 	 * is a surrounding conditional and it was not active.
1427 	 */
1428 	skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1429 		&& !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1430 
1431 	if (!skip)
1432 	{
1433 	    // Set ACTIVE and TRUE.  TRUE means that the corresponding ":catch"
1434 	    // commands should check for a match if an exception is thrown and
1435 	    // that the finally clause needs to be executed.
1436 	    cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1437 
1438 	    /*
1439 	     * ":silent!", even when used in a try conditional, disables
1440 	     * displaying of error messages and conversion of errors to
1441 	     * exceptions.  When the silent commands again open a try
1442 	     * conditional, save "emsg_silent" and reset it so that errors are
1443 	     * again converted to exceptions.  The value is restored when that
1444 	     * try conditional is left.  If it is left normally, the commands
1445 	     * following the ":endtry" are again silent.  If it is left by
1446 	     * a ":continue", ":break", ":return", or ":finish", the commands
1447 	     * executed next are again silent.  If it is left due to an
1448 	     * aborting error, an interrupt, or an exception, restoring
1449 	     * "emsg_silent" does not matter since we are already in the
1450 	     * aborting state and/or the exception has already been thrown.
1451 	     * The effect is then just freeing the memory that was allocated
1452 	     * to save the value.
1453 	     */
1454 	    if (emsg_silent)
1455 	    {
1456 		eslist_T	*elem;
1457 
1458 		elem = ALLOC_ONE(struct eslist_elem);
1459 		if (elem == NULL)
1460 		    emsg(_(e_outofmem));
1461 		else
1462 		{
1463 		    elem->saved_emsg_silent = emsg_silent;
1464 		    elem->next = cstack->cs_emsg_silent_list;
1465 		    cstack->cs_emsg_silent_list = elem;
1466 		    cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1467 		    emsg_silent = 0;
1468 		}
1469 	    }
1470 	}
1471 
1472     }
1473 }
1474 
1475 /*
1476  * ":catch /{pattern}/" and ":catch"
1477  */
1478     void
1479 ex_catch(exarg_T *eap)
1480 {
1481     int		idx = 0;
1482     int		give_up = FALSE;
1483     int		skip = FALSE;
1484     int		caught = FALSE;
1485     char_u	*end;
1486     int		save_char = 0;
1487     char_u	*save_cpo;
1488     regmatch_T	regmatch;
1489     int		prev_got_int;
1490     cstack_T	*cstack = eap->cstack;
1491     char_u	*pat;
1492 
1493     if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1494     {
1495 	eap->errmsg = N_("E603: :catch without :try");
1496 	give_up = TRUE;
1497     }
1498     else
1499     {
1500 	if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1501 	{
1502 	    // Report what's missing if the matching ":try" is not in its
1503 	    // finally clause.
1504 	    eap->errmsg = get_end_emsg(cstack);
1505 	    skip = TRUE;
1506 	}
1507 	for (idx = cstack->cs_idx; idx > 0; --idx)
1508 	    if (cstack->cs_flags[idx] & CSF_TRY)
1509 		break;
1510 	if (cstack->cs_flags[idx] & CSF_FINALLY)
1511 	{
1512 	    // Give up for a ":catch" after ":finally" and ignore it.
1513 	    // Just parse.
1514 	    eap->errmsg = N_("E604: :catch after :finally");
1515 	    give_up = TRUE;
1516 	}
1517 	else
1518 	    rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1519 						       &cstack->cs_looplevel);
1520     }
1521 
1522     if (ends_excmd(*eap->arg))	// no argument, catch all errors
1523     {
1524 	pat = (char_u *)".*";
1525 	end = NULL;
1526 	eap->nextcmd = find_nextcmd(eap->arg);
1527     }
1528     else
1529     {
1530 	pat = eap->arg + 1;
1531 	end = skip_regexp(pat, *eap->arg, TRUE, NULL);
1532     }
1533 
1534     if (!give_up)
1535     {
1536 	/*
1537 	 * Don't do something when no exception has been thrown or when the
1538 	 * corresponding try block never got active (because of an inactive
1539 	 * surrounding conditional or after an error or interrupt or throw).
1540 	 */
1541 	if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1542 	    skip = TRUE;
1543 
1544 	/*
1545 	 * Check for a match only if an exception is thrown but not caught by
1546 	 * a previous ":catch".  An exception that has replaced a discarded
1547 	 * exception is not checked (THROWN is not set then).
1548 	 */
1549 	if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1550 		&& !(cstack->cs_flags[idx] & CSF_CAUGHT))
1551 	{
1552 	    if (end != NULL && *end != NUL && !ends_excmd(*skipwhite(end + 1)))
1553 	    {
1554 		emsg(_(e_trailing));
1555 		return;
1556 	    }
1557 
1558 	    // When debugging or a breakpoint was encountered, display the
1559 	    // debug prompt (if not already done) before checking for a match.
1560 	    // This is a helpful hint for the user when the regular expression
1561 	    // matching fails.  Handle a ">quit" debug command as if an
1562 	    // interrupt had occurred before the ":catch".  That is, discard
1563 	    // the original exception, replace it by an interrupt exception,
1564 	    // and don't catch it in this try block.
1565 	    if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1566 	    {
1567 		// Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1568 		// while compiling it.
1569 		if (end != NULL)
1570 		{
1571 		    save_char = *end;
1572 		    *end = NUL;
1573 		}
1574 		save_cpo  = p_cpo;
1575 		p_cpo = (char_u *)"";
1576 		// Disable error messages, it will make current_exception
1577 		// invalid.
1578 		++emsg_off;
1579 		regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
1580 		--emsg_off;
1581 		regmatch.rm_ic = FALSE;
1582 		if (end != NULL)
1583 		    *end = save_char;
1584 		p_cpo = save_cpo;
1585 		if (regmatch.regprog == NULL)
1586 		    semsg(_(e_invarg2), pat);
1587 		else
1588 		{
1589 		    /*
1590 		     * Save the value of got_int and reset it.  We don't want
1591 		     * a previous interruption cancel matching, only hitting
1592 		     * CTRL-C while matching should abort it.
1593 		     */
1594 		    prev_got_int = got_int;
1595 		    got_int = FALSE;
1596 		    caught = vim_regexec_nl(&regmatch,
1597 			       (char_u *)current_exception->value, (colnr_T)0);
1598 		    got_int |= prev_got_int;
1599 		    vim_regfree(regmatch.regprog);
1600 		}
1601 	    }
1602 	}
1603 
1604 	if (caught)
1605 	{
1606 	    // Make this ":catch" clause active and reset did_emsg, got_int,
1607 	    // and did_throw.  Put the exception on the caught stack.
1608 	    cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1609 	    did_emsg = got_int = did_throw = FALSE;
1610 	    catch_exception((except_T *)cstack->cs_exception[idx]);
1611 	    // It's mandatory that the current exception is stored in the cstack
1612 	    // so that it can be discarded at the next ":catch", ":finally", or
1613 	    // ":endtry" or when the catch clause is left by a ":continue",
1614 	    // ":break", ":return", ":finish", error, interrupt, or another
1615 	    // exception.
1616 	    if (cstack->cs_exception[cstack->cs_idx] != current_exception)
1617 		internal_error("ex_catch()");
1618 	}
1619 	else
1620 	{
1621 	    /*
1622 	     * If there is a preceding catch clause and it caught the exception,
1623 	     * finish the exception now.  This happens also after errors except
1624 	     * when this ":catch" was after the ":finally" or not within
1625 	     * a ":try".  Make the try conditional inactive so that the
1626 	     * following catch clauses are skipped.  On an error or interrupt
1627 	     * after the preceding try block or catch clause was left by
1628 	     * a ":continue", ":break", ":return", or ":finish", discard the
1629 	     * pending action.
1630 	     */
1631 	    cleanup_conditionals(cstack, CSF_TRY, TRUE);
1632 	}
1633     }
1634 
1635     if (end != NULL)
1636 	eap->nextcmd = find_nextcmd(end);
1637 }
1638 
1639 /*
1640  * ":finally"
1641  */
1642     void
1643 ex_finally(exarg_T *eap)
1644 {
1645     int		idx;
1646     int		skip = FALSE;
1647     int		pending = CSTP_NONE;
1648     cstack_T	*cstack = eap->cstack;
1649 
1650     if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1651 	eap->errmsg = N_("E606: :finally without :try");
1652     else
1653     {
1654 	if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1655 	{
1656 	    eap->errmsg = get_end_emsg(cstack);
1657 	    for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1658 		if (cstack->cs_flags[idx] & CSF_TRY)
1659 		    break;
1660 	    // Make this error pending, so that the commands in the following
1661 	    // finally clause can be executed.  This overrules also a pending
1662 	    // ":continue", ":break", ":return", or ":finish".
1663 	    pending = CSTP_ERROR;
1664 	}
1665 	else
1666 	    idx = cstack->cs_idx;
1667 
1668 	if (cstack->cs_flags[idx] & CSF_FINALLY)
1669 	{
1670 	    // Give up for a multiple ":finally" and ignore it.
1671 	    eap->errmsg = N_("E607: multiple :finally");
1672 	    return;
1673 	}
1674 	rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1675 						       &cstack->cs_looplevel);
1676 
1677 	/*
1678 	 * Don't do something when the corresponding try block never got active
1679 	 * (because of an inactive surrounding conditional or after an error or
1680 	 * interrupt or throw) or for a ":finally" without ":try" or a multiple
1681 	 * ":finally".  After every other error (did_emsg or the conditional
1682 	 * errors detected above) or after an interrupt (got_int) or an
1683 	 * exception (did_throw), the finally clause must be executed.
1684 	 */
1685 	skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1686 
1687 	if (!skip)
1688 	{
1689 	    // When debugging or a breakpoint was encountered, display the
1690 	    // debug prompt (if not already done).  The user then knows that the
1691 	    // finally clause is executed.
1692 	    if (dbg_check_skipped(eap))
1693 	    {
1694 		// Handle a ">quit" debug command as if an interrupt had
1695 		// occurred before the ":finally".  That is, discard the
1696 		// original exception and replace it by an interrupt
1697 		// exception.
1698 		(void)do_intthrow(cstack);
1699 	    }
1700 
1701 	    /*
1702 	     * If there is a preceding catch clause and it caught the exception,
1703 	     * finish the exception now.  This happens also after errors except
1704 	     * when this is a multiple ":finally" or one not within a ":try".
1705 	     * After an error or interrupt, this also discards a pending
1706 	     * ":continue", ":break", ":finish", or ":return" from the preceding
1707 	     * try block or catch clause.
1708 	     */
1709 	    cleanup_conditionals(cstack, CSF_TRY, FALSE);
1710 
1711 	    /*
1712 	     * Make did_emsg, got_int, did_throw pending.  If set, they overrule
1713 	     * a pending ":continue", ":break", ":return", or ":finish".  Then
1714 	     * we have particularly to discard a pending return value (as done
1715 	     * by the call to cleanup_conditionals() above when did_emsg or
1716 	     * got_int is set).  The pending values are restored by the
1717 	     * ":endtry", except if there is a new error, interrupt, exception,
1718 	     * ":continue", ":break", ":return", or ":finish" in the following
1719 	     * finally clause.  A missing ":endwhile", ":endfor" or ":endif"
1720 	     * detected here is treated as if did_emsg and did_throw had
1721 	     * already been set, respectively in case that the error is not
1722 	     * converted to an exception, did_throw had already been unset.
1723 	     * We must not set did_emsg here since that would suppress the
1724 	     * error message.
1725 	     */
1726 	    if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1727 	    {
1728 		if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
1729 		{
1730 		    report_discard_pending(CSTP_RETURN,
1731 					   cstack->cs_rettv[cstack->cs_idx]);
1732 		    discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
1733 		}
1734 		if (pending == CSTP_ERROR && !did_emsg)
1735 		    pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
1736 		else
1737 		    pending |= did_throw ? CSTP_THROW : 0;
1738 		pending |= did_emsg  ? CSTP_ERROR     : 0;
1739 		pending |= got_int   ? CSTP_INTERRUPT : 0;
1740 		cstack->cs_pending[cstack->cs_idx] = pending;
1741 
1742 		// It's mandatory that the current exception is stored in the
1743 		// cstack so that it can be rethrown at the ":endtry" or be
1744 		// discarded if the finally clause is left by a ":continue",
1745 		// ":break", ":return", ":finish", error, interrupt, or another
1746 		// exception.  When emsg() is called for a missing ":endif" or
1747 		// a missing ":endwhile"/":endfor" detected here, the
1748 		// exception will be discarded.
1749 		if (did_throw && cstack->cs_exception[cstack->cs_idx]
1750 							 != current_exception)
1751 		    internal_error("ex_finally()");
1752 	    }
1753 
1754 	    /*
1755 	     * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
1756 	     * got_int, and did_throw and make the finally clause active.
1757 	     * This will happen after emsg() has been called for a missing
1758 	     * ":endif" or a missing ":endwhile"/":endfor" detected here, so
1759 	     * that the following finally clause will be executed even then.
1760 	     */
1761 	    cstack->cs_lflags |= CSL_HAD_FINA;
1762 	}
1763     }
1764 }
1765 
1766 /*
1767  * ":endtry"
1768  */
1769     void
1770 ex_endtry(exarg_T *eap)
1771 {
1772     int		idx;
1773     int		skip;
1774     int		rethrow = FALSE;
1775     int		pending = CSTP_NONE;
1776     void	*rettv = NULL;
1777     cstack_T	*cstack = eap->cstack;
1778 
1779     if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1780 	eap->errmsg = N_("E602: :endtry without :try");
1781     else
1782     {
1783 	/*
1784 	 * Don't do something after an error, interrupt or throw in the try
1785 	 * block, catch clause, or finally clause preceding this ":endtry" or
1786 	 * when an error or interrupt occurred after a ":continue", ":break",
1787 	 * ":return", or ":finish" in a try block or catch clause preceding this
1788 	 * ":endtry" or when the try block never got active (because of an
1789 	 * inactive surrounding conditional or after an error or interrupt or
1790 	 * throw) or when there is a surrounding conditional and it has been
1791 	 * made inactive by a ":continue", ":break", ":return", or ":finish" in
1792 	 * the finally clause.  The latter case need not be tested since then
1793 	 * anything pending has already been discarded. */
1794 	skip = did_emsg || got_int || did_throw ||
1795 	    !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1796 
1797 	if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1798 	{
1799 	    eap->errmsg = get_end_emsg(cstack);
1800 	    // Find the matching ":try" and report what's missing.
1801 	    idx = cstack->cs_idx;
1802 	    do
1803 		--idx;
1804 	    while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
1805 	    rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
1806 						       &cstack->cs_looplevel);
1807 	    skip = TRUE;
1808 
1809 	    /*
1810 	     * If an exception is being thrown, discard it to prevent it from
1811 	     * being rethrown at the end of this function.  It would be
1812 	     * discarded by the error message, anyway.  Resets did_throw.
1813 	     * This does not affect the script termination due to the error
1814 	     * since "trylevel" is decremented after emsg() has been called.
1815 	     */
1816 	    if (did_throw)
1817 		discard_current_exception();
1818 	}
1819 	else
1820 	{
1821 	    idx = cstack->cs_idx;
1822 
1823 	    /*
1824 	     * If we stopped with the exception currently being thrown at this
1825 	     * try conditional since we didn't know that it doesn't have
1826 	     * a finally clause, we need to rethrow it after closing the try
1827 	     * conditional.
1828 	     */
1829 	    if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
1830 		    && !(cstack->cs_flags[idx] & CSF_FINALLY))
1831 		rethrow = TRUE;
1832 	}
1833 
1834 	// If there was no finally clause, show the user when debugging or
1835 	// a breakpoint was encountered that the end of the try conditional has
1836 	// been reached: display the debug prompt (if not already done).  Do
1837 	// this on normal control flow or when an exception was thrown, but not
1838 	// on an interrupt or error not converted to an exception or when
1839 	// a ":break", ":continue", ":return", or ":finish" is pending.  These
1840 	// actions are carried out immediately.
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)
1872 		rettv = cstack->cs_rettv[idx];
1873 	    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 	 */
1887 	(void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
1888 
1889 	--cstack->cs_idx;
1890 	--cstack->cs_trylevel;
1891 
1892 	if (!skip)
1893 	{
1894 	    report_resume_pending(pending,
1895 		    (pending == CSTP_RETURN) ? rettv :
1896 		    (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:
1916 		    do_return(eap, FALSE, FALSE, rettv);
1917 		    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 /*
1946  * enter_cleanup() and leave_cleanup()
1947  *
1948  * 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.
1965  */
1966     void
1967 enter_cleanup(cleanup_T *csp)
1968 {
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 	if (did_throw || need_rethrow)
1990 	{
1991 	    csp->exception = current_exception;
1992 	    current_exception = NULL;
1993 	}
1994 	else
1995 	{
1996 	    csp->exception = NULL;
1997 	    if (did_emsg)
1998 	    {
1999 		force_abort |= cause_abort;
2000 		cause_abort = FALSE;
2001 	    }
2002 	}
2003 	did_emsg = got_int = did_throw = need_rethrow = FALSE;
2004 
2005 	// Report if required by the 'verbose' option or when debugging.
2006 	report_make_pending(pending, csp->exception);
2007     }
2008     else
2009     {
2010 	csp->pending = CSTP_NONE;
2011 	csp->exception = NULL;
2012     }
2013 }
2014 
2015 /*
2016  * See comment above enter_cleanup() for how this function is used.
2017  *
2018  * This function is a bit like ex_endtry() except that there was not actually
2019  * an extra try block around the part that failed and an error or interrupt
2020  * had not (yet) been converted to an exception when the cleanup autocommand
2021  * sequence was invoked.
2022  *
2023  * This function has to be called with the address of the cleanup_T structure
2024  * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2025  * exception state saved by that function - except there was an aborting
2026  * error, an interrupt or an uncaught exception during execution of the
2027  * cleanup autocommands.  In the latter case, the saved error/interrupt/
2028  * exception state is discarded.
2029  */
2030     void
2031 leave_cleanup(cleanup_T *csp)
2032 {
2033     int		pending = csp->pending;
2034 
2035     if (pending == CSTP_NONE)	// nothing to do
2036 	return;
2037 
2038     // If there was an aborting error, an interrupt, or an uncaught exception
2039     // after the corresponding call to enter_cleanup(), discard what has been
2040     // made pending by it.  Report this to the user if required by the
2041     // 'verbose' option or when debugging.
2042     if (aborting() || need_rethrow)
2043     {
2044 	if (pending & CSTP_THROW)
2045 	    // Cancel the pending exception (includes report).
2046 	    discard_exception((except_T *)csp->exception, FALSE);
2047 	else
2048 	    report_discard_pending(pending, NULL);
2049 
2050 	// If an error was about to be converted to an exception when
2051 	// enter_cleanup() was called, free the message list.
2052 	if (msg_list != NULL)
2053 	    free_global_msglist();
2054     }
2055 
2056     /*
2057      * If there was no new error, interrupt, or throw between the calls
2058      * to enter_cleanup() and leave_cleanup(), restore the pending
2059      * error/interrupt/exception state.
2060      */
2061     else
2062     {
2063 	/*
2064 	 * If there was an exception being thrown when enter_cleanup() was
2065 	 * called, we need to rethrow it.  Make it the exception currently
2066 	 * being thrown.
2067 	 */
2068 	if (pending & CSTP_THROW)
2069 	    current_exception = csp->exception;
2070 
2071 	/*
2072 	 * If an error was about to be converted to an exception when
2073 	 * enter_cleanup() was called, let "cause_abort" take the part of
2074 	 * "force_abort" (as done by cause_errthrow()).
2075 	 */
2076 	else if (pending & CSTP_ERROR)
2077 	{
2078 	    cause_abort = force_abort;
2079 	    force_abort = FALSE;
2080 	}
2081 
2082 	/*
2083 	 * Restore the pending values of did_emsg, got_int, and did_throw.
2084 	 */
2085 	if (pending & CSTP_ERROR)
2086 	    did_emsg = TRUE;
2087 	if (pending & CSTP_INTERRUPT)
2088 	    got_int = TRUE;
2089 	if (pending & CSTP_THROW)
2090 	    need_rethrow = TRUE;    // did_throw will be set by do_one_cmd()
2091 
2092 	// Report if required by the 'verbose' option or when debugging.
2093 	report_resume_pending(pending,
2094 		   (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2095     }
2096 }
2097 
2098 
2099 /*
2100  * Make conditionals inactive and discard what's pending in finally clauses
2101  * until the conditional type searched for or a try conditional not in its
2102  * finally clause is reached.  If this is in an active catch clause, finish
2103  * the caught exception.
2104  * Return the cstack index where the search stopped.
2105  * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
2106  * the latter meaning the innermost try conditional not in its finally clause.
2107  * "inclusive" tells whether the conditional searched for should be made
2108  * inactive itself (a try conditional not in its finally clause possibly find
2109  * before is always made inactive).  If "inclusive" is TRUE and
2110  * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
2111  * "emsg_silent", if reset when the try conditional finally reached was
2112  * entered, is restored (used by ex_endtry()).  This is normally done only
2113  * when such a try conditional is left.
2114  */
2115     int
2116 cleanup_conditionals(
2117     cstack_T   *cstack,
2118     int		searched_cond,
2119     int		inclusive)
2120 {
2121     int		idx;
2122     int		stop = FALSE;
2123 
2124     for (idx = cstack->cs_idx; idx >= 0; --idx)
2125     {
2126 	if (cstack->cs_flags[idx] & CSF_TRY)
2127 	{
2128 	    /*
2129 	     * Discard anything pending in a finally clause and continue the
2130 	     * search.  There may also be a pending ":continue", ":break",
2131 	     * ":return", or ":finish" before the finally clause.  We must not
2132 	     * discard it, unless an error or interrupt occurred afterwards.
2133 	     */
2134 	    if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
2135 	    {
2136 		switch (cstack->cs_pending[idx])
2137 		{
2138 		    case CSTP_NONE:
2139 			break;
2140 
2141 		    case CSTP_CONTINUE:
2142 		    case CSTP_BREAK:
2143 		    case CSTP_FINISH:
2144 			report_discard_pending(cstack->cs_pending[idx], NULL);
2145 			cstack->cs_pending[idx] = CSTP_NONE;
2146 			break;
2147 
2148 		    case CSTP_RETURN:
2149 			report_discard_pending(CSTP_RETURN,
2150 						      cstack->cs_rettv[idx]);
2151 			discard_pending_return(cstack->cs_rettv[idx]);
2152 			cstack->cs_pending[idx] = CSTP_NONE;
2153 			break;
2154 
2155 		    default:
2156 			if (cstack->cs_flags[idx] & CSF_FINALLY)
2157 			{
2158 			    if (cstack->cs_pending[idx] & CSTP_THROW)
2159 			    {
2160 				// Cancel the pending exception.  This is in the
2161 				// finally clause, so that the stack of the
2162 				// caught exceptions is not involved.
2163 				discard_exception((except_T *)
2164 					cstack->cs_exception[idx],
2165 					FALSE);
2166 			    }
2167 			    else
2168 				report_discard_pending(cstack->cs_pending[idx],
2169 					NULL);
2170 			    cstack->cs_pending[idx] = CSTP_NONE;
2171 			}
2172 			break;
2173 		}
2174 	    }
2175 
2176 	    /*
2177 	     * Stop at a try conditional not in its finally clause.  If this try
2178 	     * conditional is in an active catch clause, finish the caught
2179 	     * exception.
2180 	     */
2181 	    if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2182 	    {
2183 		if ((cstack->cs_flags[idx] & CSF_ACTIVE)
2184 			&& (cstack->cs_flags[idx] & CSF_CAUGHT))
2185 		    finish_exception((except_T *)cstack->cs_exception[idx]);
2186 		// Stop at this try conditional - except the try block never
2187 		// got active (because of an inactive surrounding conditional
2188 		// or when the ":try" appeared after an error or interrupt or
2189 		// throw).
2190 		if (cstack->cs_flags[idx] & CSF_TRUE)
2191 		{
2192 		    if (searched_cond == 0 && !inclusive)
2193 			break;
2194 		    stop = TRUE;
2195 		}
2196 	    }
2197 	}
2198 
2199 	// Stop on the searched conditional type (even when the surrounding
2200 	// conditional is not active or something has been made pending).
2201 	// If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2202 	// check first whether "emsg_silent" needs to be restored.
2203 	if (cstack->cs_flags[idx] & searched_cond)
2204 	{
2205 	    if (!inclusive)
2206 		break;
2207 	    stop = TRUE;
2208 	}
2209 	cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2210 	if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2211 	    break;
2212 
2213 	/*
2214 	 * When leaving a try conditional that reset "emsg_silent" on its
2215 	 * entry after saving the original value, restore that value here and
2216 	 * free the memory used to store it.
2217 	 */
2218 	if ((cstack->cs_flags[idx] & CSF_TRY)
2219 		&& (cstack->cs_flags[idx] & CSF_SILENT))
2220 	{
2221 	    eslist_T	*elem;
2222 
2223 	    elem = cstack->cs_emsg_silent_list;
2224 	    cstack->cs_emsg_silent_list = elem->next;
2225 	    emsg_silent = elem->saved_emsg_silent;
2226 	    vim_free(elem);
2227 	    cstack->cs_flags[idx] &= ~CSF_SILENT;
2228 	}
2229 	if (stop)
2230 	    break;
2231     }
2232     return idx;
2233 }
2234 
2235 /*
2236  * Return an appropriate error message for a missing endwhile/endfor/endif.
2237  */
2238    static char *
2239 get_end_emsg(cstack_T *cstack)
2240 {
2241     if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
2242 	return e_endwhile;
2243     if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2244 	return e_endfor;
2245     return e_endif;
2246 }
2247 
2248 
2249 /*
2250  * Rewind conditionals until index "idx" is reached.  "cond_type" and
2251  * "cond_level" specify a conditional type and the address of a level variable
2252  * which is to be decremented with each skipped conditional of the specified
2253  * type.
2254  * Also free "for info" structures where needed.
2255  */
2256     void
2257 rewind_conditionals(
2258     cstack_T   *cstack,
2259     int		idx,
2260     int		cond_type,
2261     int		*cond_level)
2262 {
2263     while (cstack->cs_idx > idx)
2264     {
2265 	if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2266 	    --*cond_level;
2267 	if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2268 	    free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
2269 	--cstack->cs_idx;
2270     }
2271 }
2272 
2273 /*
2274  * ":endfunction" when not after a ":function"
2275  */
2276     void
2277 ex_endfunction(exarg_T *eap UNUSED)
2278 {
2279     emsg(_("E193: :endfunction not inside a function"));
2280 }
2281 
2282 /*
2283  * Return TRUE if the string "p" looks like a ":while" or ":for" command.
2284  */
2285     int
2286 has_loop_cmd(char_u *p)
2287 {
2288     int		len;
2289 
2290     // skip modifiers, white space and ':'
2291     for (;;)
2292     {
2293 	while (*p == ' ' || *p == '\t' || *p == ':')
2294 	    ++p;
2295 	len = modifier_len(p);
2296 	if (len == 0)
2297 	    break;
2298 	p += len;
2299     }
2300     if ((p[0] == 'w' && p[1] == 'h')
2301 	    || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
2302 	return TRUE;
2303     return FALSE;
2304 }
2305 
2306 #endif // FEAT_EVAL
2307