1edf3f97aSBram Moolenaar /* vi:set ts=8 sts=4 sw=4 noet:
2071d4279SBram Moolenaar *
3071d4279SBram Moolenaar * VIM - Vi IMproved by Bram Moolenaar
4071d4279SBram Moolenaar *
5071d4279SBram Moolenaar * Do ":help uganda" in Vim to read copying and usage conditions.
6071d4279SBram Moolenaar * Do ":help credits" in Vim to see a list of people who contributed.
7071d4279SBram Moolenaar * See README.txt for an overview of the Vim source code.
8071d4279SBram Moolenaar */
9071d4279SBram Moolenaar
10071d4279SBram Moolenaar /*
11071d4279SBram Moolenaar * ex_eval.c: functions for Ex command line for the +eval feature.
12071d4279SBram Moolenaar */
13071d4279SBram Moolenaar
14071d4279SBram Moolenaar #include "vim.h"
15071d4279SBram Moolenaar
16071d4279SBram Moolenaar #if defined(FEAT_EVAL) || defined(PROTO)
17071d4279SBram Moolenaar
18ddef1291SBram Moolenaar static char *get_end_emsg(cstack_T *cstack);
19071d4279SBram Moolenaar
20071d4279SBram Moolenaar /*
21071d4279SBram Moolenaar * Exception handling terms:
22071d4279SBram Moolenaar *
23071d4279SBram Moolenaar * :try ":try" command \
24071d4279SBram Moolenaar * ... try block |
25071d4279SBram Moolenaar * :catch RE ":catch" command |
26071d4279SBram Moolenaar * ... catch clause |- try conditional
27071d4279SBram Moolenaar * :finally ":finally" command |
28071d4279SBram Moolenaar * ... finally clause |
29071d4279SBram Moolenaar * :endtry ":endtry" command /
30071d4279SBram Moolenaar *
31071d4279SBram Moolenaar * The try conditional may have any number of catch clauses and at most one
32071d4279SBram Moolenaar * finally clause. A ":throw" command can be inside the try block, a catch
33071d4279SBram Moolenaar * clause, the finally clause, or in a function called or script sourced from
34071d4279SBram Moolenaar * there or even outside the try conditional. Try conditionals may be nested.
35071d4279SBram Moolenaar */
36071d4279SBram Moolenaar
37071d4279SBram Moolenaar /*
38071d4279SBram Moolenaar * Configuration whether an exception is thrown on error or interrupt. When
39071d4279SBram Moolenaar * the preprocessor macros below evaluate to FALSE, an error (did_emsg) or
40071d4279SBram Moolenaar * interrupt (got_int) under an active try conditional terminates the script
41071d4279SBram Moolenaar * after the non-active finally clauses of all active try conditionals have been
42071d4279SBram Moolenaar * executed. Otherwise, errors and/or interrupts are converted into catchable
43071d4279SBram Moolenaar * exceptions (did_throw additionally set), which terminate the script only if
44071d4279SBram Moolenaar * not caught. For user exceptions, only did_throw is set. (Note: got_int can
4584a05accSBram Moolenaar * be set asynchronously afterwards by a SIGINT, so did_throw && got_int is not
46071d4279SBram Moolenaar * a reliant test that the exception currently being thrown is an interrupt
47071d4279SBram Moolenaar * exception. Similarly, did_emsg can be set afterwards on an error in an
48071d4279SBram Moolenaar * (unskipped) conditional command inside an inactive conditional, so did_throw
49071d4279SBram Moolenaar * && did_emsg is not a reliant test that the exception currently being thrown
50071d4279SBram Moolenaar * is an error exception.) - The macros can be defined as expressions checking
51071d4279SBram Moolenaar * for a variable that is allowed to be changed during execution of a script.
52071d4279SBram Moolenaar */
53071d4279SBram Moolenaar #if 0
54217e1b83SBram Moolenaar // Expressions used for testing during the development phase.
55071d4279SBram Moolenaar # define THROW_ON_ERROR (!eval_to_number("$VIMNOERRTHROW"))
56071d4279SBram Moolenaar # define THROW_ON_INTERRUPT (!eval_to_number("$VIMNOINTTHROW"))
57071d4279SBram Moolenaar # define THROW_TEST
58071d4279SBram Moolenaar #else
59217e1b83SBram Moolenaar // Values used for the Vim release.
60071d4279SBram Moolenaar # define THROW_ON_ERROR TRUE
61af0167faSBram Moolenaar # define THROW_ON_ERROR_TRUE
62071d4279SBram Moolenaar # define THROW_ON_INTERRUPT TRUE
63af0167faSBram Moolenaar # define THROW_ON_INTERRUPT_TRUE
64071d4279SBram Moolenaar #endif
65071d4279SBram Moolenaar
66071d4279SBram Moolenaar /*
67071d4279SBram Moolenaar * When several errors appear in a row, setting "force_abort" is delayed until
68071d4279SBram Moolenaar * the failing command returned. "cause_abort" is set to TRUE meanwhile, in
69071d4279SBram Moolenaar * order to indicate that situation. This is useful when "force_abort" was set
70071d4279SBram Moolenaar * during execution of a function call from an expression: the aborting of the
71071d4279SBram Moolenaar * expression evaluation is done without producing any error messages, but all
72071d4279SBram Moolenaar * error messages on parsing errors during the expression evaluation are given
73071d4279SBram Moolenaar * (even if a try conditional is active).
74071d4279SBram Moolenaar */
75071d4279SBram Moolenaar static int cause_abort = FALSE;
76071d4279SBram Moolenaar
77071d4279SBram Moolenaar /*
78ccc18222SBram Moolenaar * Return TRUE when immediately aborting on error, or when an interrupt
79071d4279SBram Moolenaar * occurred or an exception was thrown but not caught. Use for ":{range}call"
80071d4279SBram Moolenaar * to check whether an aborted function that does not handle a range itself
81071d4279SBram Moolenaar * should be called again for the next line in the range. Also used for
82071d4279SBram Moolenaar * cancelling expression evaluation after a function call caused an immediate
83071d4279SBram Moolenaar * abort. Note that the first emsg() call temporarily resets "force_abort"
84071d4279SBram Moolenaar * until the throw point for error messages has been reached. That is, during
85071d4279SBram Moolenaar * cancellation of an expression evaluation after an aborting function call or
86071d4279SBram Moolenaar * due to a parsing error, aborting() always returns the same value.
8767a2deb9SBram Moolenaar * "got_int" is also set by calling interrupt().
88071d4279SBram Moolenaar */
89071d4279SBram Moolenaar int
aborting(void)9078c0b7d4SBram Moolenaar aborting(void)
91071d4279SBram Moolenaar {
92071d4279SBram Moolenaar return (did_emsg && force_abort) || got_int || did_throw;
93071d4279SBram Moolenaar }
94071d4279SBram Moolenaar
95071d4279SBram Moolenaar /*
96071d4279SBram Moolenaar * The value of "force_abort" is temporarily reset by the first emsg() call
97071d4279SBram Moolenaar * during an expression evaluation, and "cause_abort" is used instead. It might
98071d4279SBram Moolenaar * be necessary to restore "force_abort" even before the throw point for the
99071d4279SBram Moolenaar * error message has been reached. update_force_abort() should be called then.
100071d4279SBram Moolenaar */
101071d4279SBram Moolenaar void
update_force_abort(void)10278c0b7d4SBram Moolenaar update_force_abort(void)
103071d4279SBram Moolenaar {
104071d4279SBram Moolenaar if (cause_abort)
105071d4279SBram Moolenaar force_abort = TRUE;
106071d4279SBram Moolenaar }
107071d4279SBram Moolenaar
108071d4279SBram Moolenaar /*
109071d4279SBram Moolenaar * Return TRUE if a command with a subcommand resulting in "retcode" should
110071d4279SBram Moolenaar * abort the script processing. Can be used to suppress an autocommand after
111071d4279SBram Moolenaar * execution of a failing subcommand as long as the error message has not been
112071d4279SBram Moolenaar * displayed and actually caused the abortion.
113071d4279SBram Moolenaar */
114071d4279SBram Moolenaar int
should_abort(int retcode)11578c0b7d4SBram Moolenaar should_abort(int retcode)
116071d4279SBram Moolenaar {
117071d4279SBram Moolenaar return ((retcode == FAIL && trylevel != 0 && !emsg_silent) || aborting());
118071d4279SBram Moolenaar }
119071d4279SBram Moolenaar
120071d4279SBram Moolenaar /*
121071d4279SBram Moolenaar * Return TRUE if a function with the "abort" flag should not be considered
122071d4279SBram Moolenaar * ended on an error. This means that parsing commands is continued in order
123071d4279SBram Moolenaar * to find finally clauses to be executed, and that some errors in skipped
124071d4279SBram Moolenaar * commands are still reported.
125071d4279SBram Moolenaar */
126071d4279SBram Moolenaar int
aborted_in_try(void)12778c0b7d4SBram Moolenaar aborted_in_try(void)
128071d4279SBram Moolenaar {
129217e1b83SBram Moolenaar // This function is only called after an error. In this case, "force_abort"
130217e1b83SBram Moolenaar // determines whether searching for finally clauses is necessary.
131071d4279SBram Moolenaar return force_abort;
132071d4279SBram Moolenaar }
133071d4279SBram Moolenaar
134071d4279SBram Moolenaar /*
135071d4279SBram Moolenaar * cause_errthrow(): Cause a throw of an error exception if appropriate.
136071d4279SBram Moolenaar * Return TRUE if the error message should not be displayed by emsg().
137071d4279SBram Moolenaar * Sets "ignore", if the emsg() call should be ignored completely.
138071d4279SBram Moolenaar *
139071d4279SBram Moolenaar * When several messages appear in the same command, the first is usually the
140071d4279SBram Moolenaar * most specific one and used as the exception value. The "severe" flag can be
141071d4279SBram Moolenaar * set to TRUE, if a later but severer message should be used instead.
142071d4279SBram Moolenaar */
143071d4279SBram Moolenaar int
cause_errthrow(char_u * mesg,int severe,int * ignore)14478c0b7d4SBram Moolenaar cause_errthrow(
14578c0b7d4SBram Moolenaar char_u *mesg,
14678c0b7d4SBram Moolenaar int severe,
14778c0b7d4SBram Moolenaar int *ignore)
148071d4279SBram Moolenaar {
14925e0f586SBram Moolenaar msglist_T *elem;
15025e0f586SBram Moolenaar msglist_T **plist;
151071d4279SBram Moolenaar
152071d4279SBram Moolenaar /*
15357657d85SBram Moolenaar * Do nothing when displaying the interrupt message or reporting an
15457657d85SBram Moolenaar * uncaught exception (which has already been discarded then) at the top
15557657d85SBram Moolenaar * level. Also when no exception can be thrown. The message will be
15657657d85SBram Moolenaar * displayed by emsg().
157071d4279SBram Moolenaar */
158071d4279SBram Moolenaar if (suppress_errthrow)
159071d4279SBram Moolenaar return FALSE;
160071d4279SBram Moolenaar
161071d4279SBram Moolenaar /*
16257657d85SBram Moolenaar * If emsg() has not been called previously, temporarily reset
16357657d85SBram Moolenaar * "force_abort" until the throw point for error messages has been
16457657d85SBram Moolenaar * reached. This ensures that aborting() returns the same value for all
16557657d85SBram Moolenaar * errors that appear in the same command. This means particularly that
16657657d85SBram Moolenaar * for parsing errors during expression evaluation emsg() will be called
16757657d85SBram Moolenaar * multiply, even when the expression is evaluated from a finally clause
16857657d85SBram Moolenaar * that was activated due to an aborting error, interrupt, or exception.
169071d4279SBram Moolenaar */
170071d4279SBram Moolenaar if (!did_emsg)
171071d4279SBram Moolenaar {
172071d4279SBram Moolenaar cause_abort = force_abort;
173071d4279SBram Moolenaar force_abort = FALSE;
174071d4279SBram Moolenaar }
175071d4279SBram Moolenaar
176071d4279SBram Moolenaar /*
177071d4279SBram Moolenaar * If no try conditional is active and no exception is being thrown and
178071d4279SBram Moolenaar * there has not been an error in a try conditional or a throw so far, do
17957657d85SBram Moolenaar * nothing (for compatibility of non-EH scripts). The message will then
18057657d85SBram Moolenaar * be displayed by emsg(). When ":silent!" was used and we are not
18157657d85SBram Moolenaar * currently throwing an exception, do nothing. The message text will
18257657d85SBram Moolenaar * then be stored to v:errmsg by emsg() without displaying it.
183071d4279SBram Moolenaar */
184071d4279SBram Moolenaar if (((trylevel == 0 && !cause_abort) || emsg_silent) && !did_throw)
185071d4279SBram Moolenaar return FALSE;
186071d4279SBram Moolenaar
187071d4279SBram Moolenaar /*
188071d4279SBram Moolenaar * Ignore an interrupt message when inside a try conditional or when an
18957657d85SBram Moolenaar * exception is being thrown or when an error in a try conditional or
19057657d85SBram Moolenaar * throw has been detected previously. This is important in order that an
191071d4279SBram Moolenaar * interrupt exception is catchable by the innermost try conditional and
192071d4279SBram Moolenaar * not replaced by an interrupt message error exception.
193071d4279SBram Moolenaar */
194071d4279SBram Moolenaar if (mesg == (char_u *)_(e_interr))
195071d4279SBram Moolenaar {
196071d4279SBram Moolenaar *ignore = TRUE;
197071d4279SBram Moolenaar return TRUE;
198071d4279SBram Moolenaar }
199071d4279SBram Moolenaar
200071d4279SBram Moolenaar /*
201071d4279SBram Moolenaar * Ensure that all commands in nested function calls and sourced files
202071d4279SBram Moolenaar * are aborted immediately.
203071d4279SBram Moolenaar */
204071d4279SBram Moolenaar cause_abort = TRUE;
205071d4279SBram Moolenaar
206071d4279SBram Moolenaar /*
207071d4279SBram Moolenaar * When an exception is being thrown, some commands (like conditionals) are
208071d4279SBram Moolenaar * not skipped. Errors in those commands may affect what of the subsequent
209071d4279SBram Moolenaar * commands are regarded part of catch and finally clauses. Catching the
210071d4279SBram Moolenaar * exception would then cause execution of commands not intended by the
211c323527dSBram Moolenaar * user, who wouldn't even get aware of the problem. Therefore, discard the
212071d4279SBram Moolenaar * exception currently being thrown to prevent it from being caught. Just
213071d4279SBram Moolenaar * execute finally clauses and terminate.
214071d4279SBram Moolenaar */
215071d4279SBram Moolenaar if (did_throw)
216071d4279SBram Moolenaar {
217217e1b83SBram Moolenaar // When discarding an interrupt exception, reset got_int to prevent the
218217e1b83SBram Moolenaar // same interrupt being converted to an exception again and discarding
219217e1b83SBram Moolenaar // the error exception we are about to throw here.
220071d4279SBram Moolenaar if (current_exception->type == ET_INTERRUPT)
221071d4279SBram Moolenaar got_int = FALSE;
222071d4279SBram Moolenaar discard_current_exception();
223071d4279SBram Moolenaar }
224071d4279SBram Moolenaar
225071d4279SBram Moolenaar #ifdef THROW_TEST
226071d4279SBram Moolenaar if (!THROW_ON_ERROR)
227071d4279SBram Moolenaar {
228071d4279SBram Moolenaar /*
229071d4279SBram Moolenaar * Print error message immediately without searching for a matching
230071d4279SBram Moolenaar * catch clause; just finally clauses are executed before the script
231071d4279SBram Moolenaar * is terminated.
232071d4279SBram Moolenaar */
233071d4279SBram Moolenaar return FALSE;
234071d4279SBram Moolenaar }
235071d4279SBram Moolenaar else
236071d4279SBram Moolenaar #endif
237071d4279SBram Moolenaar {
238071d4279SBram Moolenaar /*
239071d4279SBram Moolenaar * Prepare the throw of an error exception, so that everything will
240071d4279SBram Moolenaar * be aborted (except for executing finally clauses), until the error
241071d4279SBram Moolenaar * exception is caught; if still uncaught at the top level, the error
242071d4279SBram Moolenaar * message will be displayed and the script processing terminated
243071d4279SBram Moolenaar * then. - This function has no access to the conditional stack.
244071d4279SBram Moolenaar * Thus, the actual throw is made after the failing command has
245071d4279SBram Moolenaar * returned. - Throw only the first of several errors in a row, except
246071d4279SBram Moolenaar * a severe error is following.
247071d4279SBram Moolenaar */
248071d4279SBram Moolenaar if (msg_list != NULL)
249071d4279SBram Moolenaar {
250071d4279SBram Moolenaar plist = msg_list;
251071d4279SBram Moolenaar while (*plist != NULL)
252071d4279SBram Moolenaar plist = &(*plist)->next;
253071d4279SBram Moolenaar
25425e0f586SBram Moolenaar elem = ALLOC_CLEAR_ONE(msglist_T);
255071d4279SBram Moolenaar if (elem == NULL)
256071d4279SBram Moolenaar {
257071d4279SBram Moolenaar suppress_errthrow = TRUE;
258e29a27f6SBram Moolenaar emsg(_(e_out_of_memory));
259071d4279SBram Moolenaar }
260071d4279SBram Moolenaar else
261071d4279SBram Moolenaar {
262f9e3e09fSBram Moolenaar elem->msg = (char *)vim_strsave(mesg);
263071d4279SBram Moolenaar if (elem->msg == NULL)
264071d4279SBram Moolenaar {
265071d4279SBram Moolenaar vim_free(elem);
266071d4279SBram Moolenaar suppress_errthrow = TRUE;
267e29a27f6SBram Moolenaar emsg(_(e_out_of_memory));
268071d4279SBram Moolenaar }
269071d4279SBram Moolenaar else
270071d4279SBram Moolenaar {
271071d4279SBram Moolenaar elem->next = NULL;
272071d4279SBram Moolenaar elem->throw_msg = NULL;
273071d4279SBram Moolenaar *plist = elem;
274071d4279SBram Moolenaar if (plist == msg_list || severe)
275071d4279SBram Moolenaar {
276f9e3e09fSBram Moolenaar char *tmsg;
277071d4279SBram Moolenaar
278217e1b83SBram Moolenaar // Skip the extra "Vim " prefix for message "E458".
279071d4279SBram Moolenaar tmsg = elem->msg;
280071d4279SBram Moolenaar if (STRNCMP(tmsg, "Vim E", 5) == 0
281071d4279SBram Moolenaar && VIM_ISDIGIT(tmsg[5])
282071d4279SBram Moolenaar && VIM_ISDIGIT(tmsg[6])
283071d4279SBram Moolenaar && VIM_ISDIGIT(tmsg[7])
284071d4279SBram Moolenaar && tmsg[8] == ':'
285071d4279SBram Moolenaar && tmsg[9] == ' ')
286071d4279SBram Moolenaar (*msg_list)->throw_msg = &tmsg[4];
287071d4279SBram Moolenaar else
288071d4279SBram Moolenaar (*msg_list)->throw_msg = tmsg;
289071d4279SBram Moolenaar }
29025e0f586SBram Moolenaar
29125e0f586SBram Moolenaar // Get the source name and lnum now, it may change before
29225e0f586SBram Moolenaar // reaching do_errthrow().
2934f25b1abSBram Moolenaar elem->sfile = estack_sfile(ESTACK_NONE);
29425e0f586SBram Moolenaar elem->slnum = SOURCING_LNUM;
295e8c4660aSBram Moolenaar elem->msg_compiling = estack_compiling;
296071d4279SBram Moolenaar }
297071d4279SBram Moolenaar }
298071d4279SBram Moolenaar }
299071d4279SBram Moolenaar return TRUE;
300071d4279SBram Moolenaar }
301071d4279SBram Moolenaar }
302071d4279SBram Moolenaar
303071d4279SBram Moolenaar /*
304071d4279SBram Moolenaar * Free a "msg_list" and the messages it contains.
305071d4279SBram Moolenaar */
306071d4279SBram Moolenaar static void
free_msglist(msglist_T * l)30725e0f586SBram Moolenaar free_msglist(msglist_T *l)
308071d4279SBram Moolenaar {
30925e0f586SBram Moolenaar msglist_T *messages, *next;
310071d4279SBram Moolenaar
311071d4279SBram Moolenaar messages = l;
312071d4279SBram Moolenaar while (messages != NULL)
313071d4279SBram Moolenaar {
314071d4279SBram Moolenaar next = messages->next;
315071d4279SBram Moolenaar vim_free(messages->msg);
31625e0f586SBram Moolenaar vim_free(messages->sfile);
317071d4279SBram Moolenaar vim_free(messages);
318071d4279SBram Moolenaar messages = next;
319071d4279SBram Moolenaar }
320071d4279SBram Moolenaar }
321071d4279SBram Moolenaar
322071d4279SBram Moolenaar /*
3239fee7d47SBram Moolenaar * Free global "*msg_list" and the messages it contains, then set "*msg_list"
3249fee7d47SBram Moolenaar * to NULL.
3259fee7d47SBram Moolenaar */
3269fee7d47SBram Moolenaar void
free_global_msglist(void)32778c0b7d4SBram Moolenaar free_global_msglist(void)
3289fee7d47SBram Moolenaar {
3299fee7d47SBram Moolenaar free_msglist(*msg_list);
3309fee7d47SBram Moolenaar *msg_list = NULL;
3319fee7d47SBram Moolenaar }
3329fee7d47SBram Moolenaar
3339fee7d47SBram Moolenaar /*
334071d4279SBram Moolenaar * Throw the message specified in the call to cause_errthrow() above as an
335071d4279SBram Moolenaar * error exception. If cstack is NULL, postpone the throw until do_cmdline()
336071d4279SBram Moolenaar * has returned (see do_one_cmd()).
337071d4279SBram Moolenaar */
338071d4279SBram Moolenaar void
do_errthrow(cstack_T * cstack,char_u * cmdname)339ddef1291SBram Moolenaar do_errthrow(cstack_T *cstack, char_u *cmdname)
340071d4279SBram Moolenaar {
341071d4279SBram Moolenaar /*
342071d4279SBram Moolenaar * Ensure that all commands in nested function calls and sourced files
343071d4279SBram Moolenaar * are aborted immediately.
344071d4279SBram Moolenaar */
345071d4279SBram Moolenaar if (cause_abort)
346071d4279SBram Moolenaar {
347071d4279SBram Moolenaar cause_abort = FALSE;
348071d4279SBram Moolenaar force_abort = TRUE;
349071d4279SBram Moolenaar }
350071d4279SBram Moolenaar
351217e1b83SBram Moolenaar // If no exception is to be thrown or the conversion should be done after
352217e1b83SBram Moolenaar // returning to a previous invocation of do_one_cmd(), do nothing.
3534632d298SBram Moolenaar if (msg_list == NULL || *msg_list == NULL)
354071d4279SBram Moolenaar return;
355071d4279SBram Moolenaar
356071d4279SBram Moolenaar if (throw_exception(*msg_list, ET_ERROR, cmdname) == FAIL)
357071d4279SBram Moolenaar free_msglist(*msg_list);
358071d4279SBram Moolenaar else
359071d4279SBram Moolenaar {
360071d4279SBram Moolenaar if (cstack != NULL)
361071d4279SBram Moolenaar do_throw(cstack);
362071d4279SBram Moolenaar else
363071d4279SBram Moolenaar need_rethrow = TRUE;
364071d4279SBram Moolenaar }
365071d4279SBram Moolenaar *msg_list = NULL;
366071d4279SBram Moolenaar }
367071d4279SBram Moolenaar
368071d4279SBram Moolenaar /*
369071d4279SBram Moolenaar * do_intthrow(): Replace the current exception by an interrupt or interrupt
370071d4279SBram Moolenaar * exception if appropriate. Return TRUE if the current exception is discarded,
371071d4279SBram Moolenaar * FALSE otherwise.
372071d4279SBram Moolenaar */
373071d4279SBram Moolenaar int
do_intthrow(cstack_T * cstack)374ddef1291SBram Moolenaar do_intthrow(cstack_T *cstack)
375071d4279SBram Moolenaar {
376071d4279SBram Moolenaar /*
377071d4279SBram Moolenaar * If no interrupt occurred or no try conditional is active and no exception
378071d4279SBram Moolenaar * is being thrown, do nothing (for compatibility of non-EH scripts).
379071d4279SBram Moolenaar */
380071d4279SBram Moolenaar if (!got_int || (trylevel == 0 && !did_throw))
381071d4279SBram Moolenaar return FALSE;
382071d4279SBram Moolenaar
383217e1b83SBram Moolenaar #ifdef THROW_TEST // avoid warning for condition always true
384071d4279SBram Moolenaar if (!THROW_ON_INTERRUPT)
385071d4279SBram Moolenaar {
386071d4279SBram Moolenaar /*
387071d4279SBram Moolenaar * The interrupt aborts everything except for executing finally clauses.
388071d4279SBram Moolenaar * Discard any user or error or interrupt exception currently being
389071d4279SBram Moolenaar * thrown.
390071d4279SBram Moolenaar */
391071d4279SBram Moolenaar if (did_throw)
392071d4279SBram Moolenaar discard_current_exception();
393071d4279SBram Moolenaar }
394071d4279SBram Moolenaar else
395071d4279SBram Moolenaar #endif
396071d4279SBram Moolenaar {
397071d4279SBram Moolenaar /*
398071d4279SBram Moolenaar * Throw an interrupt exception, so that everything will be aborted
399071d4279SBram Moolenaar * (except for executing finally clauses), until the interrupt exception
400071d4279SBram Moolenaar * is caught; if still uncaught at the top level, the script processing
401071d4279SBram Moolenaar * will be terminated then. - If an interrupt exception is already
402071d4279SBram Moolenaar * being thrown, do nothing.
403071d4279SBram Moolenaar *
404071d4279SBram Moolenaar */
405071d4279SBram Moolenaar if (did_throw)
406071d4279SBram Moolenaar {
407071d4279SBram Moolenaar if (current_exception->type == ET_INTERRUPT)
408071d4279SBram Moolenaar return FALSE;
409071d4279SBram Moolenaar
410217e1b83SBram Moolenaar // An interrupt exception replaces any user or error exception.
411071d4279SBram Moolenaar discard_current_exception();
412071d4279SBram Moolenaar }
413071d4279SBram Moolenaar if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) != FAIL)
414071d4279SBram Moolenaar do_throw(cstack);
415071d4279SBram Moolenaar }
416071d4279SBram Moolenaar
417071d4279SBram Moolenaar return TRUE;
418071d4279SBram Moolenaar }
419071d4279SBram Moolenaar
420071d4279SBram Moolenaar /*
4219fee7d47SBram Moolenaar * Get an exception message that is to be stored in current_exception->value.
422071d4279SBram Moolenaar */
423f9e3e09fSBram Moolenaar char *
get_exception_string(void * value,except_type_T type,char_u * cmdname,int * should_free)42478c0b7d4SBram Moolenaar get_exception_string(
42578c0b7d4SBram Moolenaar void *value,
4268a5883b7SBram Moolenaar except_type_T type,
42778c0b7d4SBram Moolenaar char_u *cmdname,
42878c0b7d4SBram Moolenaar int *should_free)
429071d4279SBram Moolenaar {
430f9e3e09fSBram Moolenaar char *ret;
431f9e3e09fSBram Moolenaar char *mesg;
432071d4279SBram Moolenaar int cmdlen;
433f9e3e09fSBram Moolenaar char *p, *val;
434071d4279SBram Moolenaar
435071d4279SBram Moolenaar if (type == ET_ERROR)
436071d4279SBram Moolenaar {
4379ef00be2SBram Moolenaar *should_free = TRUE;
43825e0f586SBram Moolenaar mesg = ((msglist_T *)value)->throw_msg;
439071d4279SBram Moolenaar if (cmdname != NULL && *cmdname != NUL)
440071d4279SBram Moolenaar {
441a93fa7eeSBram Moolenaar cmdlen = (int)STRLEN(cmdname);
442f9e3e09fSBram Moolenaar ret = (char *)vim_strnsave((char_u *)"Vim(",
44371ccd03eSBram Moolenaar 4 + cmdlen + 2 + STRLEN(mesg));
4449fee7d47SBram Moolenaar if (ret == NULL)
4459fee7d47SBram Moolenaar return ret;
4469fee7d47SBram Moolenaar STRCPY(&ret[4], cmdname);
4479fee7d47SBram Moolenaar STRCPY(&ret[4 + cmdlen], "):");
4489fee7d47SBram Moolenaar val = ret + 4 + cmdlen + 2;
449071d4279SBram Moolenaar }
450071d4279SBram Moolenaar else
451071d4279SBram Moolenaar {
45271ccd03eSBram Moolenaar ret = (char *)vim_strnsave((char_u *)"Vim:", 4 + STRLEN(mesg));
4539fee7d47SBram Moolenaar if (ret == NULL)
4549fee7d47SBram Moolenaar return ret;
4559fee7d47SBram Moolenaar val = ret + 4;
456071d4279SBram Moolenaar }
457071d4279SBram Moolenaar
458217e1b83SBram Moolenaar // msg_add_fname may have been used to prefix the message with a file
459217e1b83SBram Moolenaar // name in quotes. In the exception value, put the file name in
460217e1b83SBram Moolenaar // parentheses and move it to the end.
461071d4279SBram Moolenaar for (p = mesg; ; p++)
462071d4279SBram Moolenaar {
463071d4279SBram Moolenaar if (*p == NUL
464071d4279SBram Moolenaar || (*p == 'E'
465071d4279SBram Moolenaar && VIM_ISDIGIT(p[1])
466071d4279SBram Moolenaar && (p[2] == ':'
467071d4279SBram Moolenaar || (VIM_ISDIGIT(p[2])
468071d4279SBram Moolenaar && (p[3] == ':'
469071d4279SBram Moolenaar || (VIM_ISDIGIT(p[3])
470071d4279SBram Moolenaar && p[4] == ':'))))))
471071d4279SBram Moolenaar {
472051b782fSBram Moolenaar if (*p == NUL || p == mesg)
473217e1b83SBram Moolenaar STRCAT(val, mesg); // 'E123' missing or at beginning
474071d4279SBram Moolenaar else
475071d4279SBram Moolenaar {
476217e1b83SBram Moolenaar // '"filename" E123: message text'
477071d4279SBram Moolenaar if (mesg[0] != '"' || p-2 < &mesg[1] ||
478071d4279SBram Moolenaar p[-2] != '"' || p[-1] != ' ')
479217e1b83SBram Moolenaar // "E123:" is part of the file name.
480071d4279SBram Moolenaar continue;
481071d4279SBram Moolenaar
482071d4279SBram Moolenaar STRCAT(val, p);
483071d4279SBram Moolenaar p[-2] = NUL;
484071d4279SBram Moolenaar sprintf((char *)(val + STRLEN(p)), " (%s)", &mesg[1]);
485071d4279SBram Moolenaar p[-2] = '"';
486071d4279SBram Moolenaar }
487071d4279SBram Moolenaar break;
488071d4279SBram Moolenaar }
489071d4279SBram Moolenaar }
490071d4279SBram Moolenaar }
491071d4279SBram Moolenaar else
4929fee7d47SBram Moolenaar {
4939fee7d47SBram Moolenaar *should_free = FALSE;
494f9e3e09fSBram Moolenaar ret = value;
4959fee7d47SBram Moolenaar }
4969fee7d47SBram Moolenaar
4979fee7d47SBram Moolenaar return ret;
4989fee7d47SBram Moolenaar }
4999fee7d47SBram Moolenaar
5009fee7d47SBram Moolenaar
5019fee7d47SBram Moolenaar /*
5029fee7d47SBram Moolenaar * Throw a new exception. Return FAIL when out of memory or it was tried to
5039fee7d47SBram Moolenaar * throw an illegal user exception. "value" is the exception string for a
5049fee7d47SBram Moolenaar * user or interrupt exception, or points to a message list in case of an
5059fee7d47SBram Moolenaar * error exception.
5069fee7d47SBram Moolenaar */
5078a7d6542SBram Moolenaar int
throw_exception(void * value,except_type_T type,char_u * cmdname)5088a5883b7SBram Moolenaar throw_exception(void *value, except_type_T type, char_u *cmdname)
5099fee7d47SBram Moolenaar {
5109fee7d47SBram Moolenaar except_T *excp;
5119fee7d47SBram Moolenaar int should_free;
5129fee7d47SBram Moolenaar
5139fee7d47SBram Moolenaar /*
5149fee7d47SBram Moolenaar * Disallow faking Interrupt or error exceptions as user exceptions. They
5159fee7d47SBram Moolenaar * would be treated differently from real interrupt or error exceptions
5169fee7d47SBram Moolenaar * when no active try block is found, see do_cmdline().
5179fee7d47SBram Moolenaar */
5189fee7d47SBram Moolenaar if (type == ET_USER)
5199fee7d47SBram Moolenaar {
5209fee7d47SBram Moolenaar if (STRNCMP((char_u *)value, "Vim", 3) == 0
5219fee7d47SBram Moolenaar && (((char_u *)value)[3] == NUL || ((char_u *)value)[3] == ':'
5229fee7d47SBram Moolenaar || ((char_u *)value)[3] == '('))
5239fee7d47SBram Moolenaar {
524f9e3e09fSBram Moolenaar emsg(_("E608: Cannot :throw exceptions with 'Vim' prefix"));
5259fee7d47SBram Moolenaar goto fail;
5269fee7d47SBram Moolenaar }
5279fee7d47SBram Moolenaar }
5289fee7d47SBram Moolenaar
529c799fe20SBram Moolenaar excp = ALLOC_ONE(except_T);
5309fee7d47SBram Moolenaar if (excp == NULL)
5319fee7d47SBram Moolenaar goto nomem;
5329fee7d47SBram Moolenaar
5339fee7d47SBram Moolenaar if (type == ET_ERROR)
534217e1b83SBram Moolenaar // Store the original message and prefix the exception value with
535217e1b83SBram Moolenaar // "Vim:" or, if a command name is given, "Vim(cmdname):".
53625e0f586SBram Moolenaar excp->messages = (msglist_T *)value;
5379fee7d47SBram Moolenaar
5389fee7d47SBram Moolenaar excp->value = get_exception_string(value, type, cmdname, &should_free);
5399fee7d47SBram Moolenaar if (excp->value == NULL && should_free)
5409fee7d47SBram Moolenaar goto nomem;
541071d4279SBram Moolenaar
542071d4279SBram Moolenaar excp->type = type;
54325e0f586SBram Moolenaar if (type == ET_ERROR && ((msglist_T *)value)->sfile != NULL)
54425e0f586SBram Moolenaar {
54525e0f586SBram Moolenaar msglist_T *entry = (msglist_T *)value;
54625e0f586SBram Moolenaar
54725e0f586SBram Moolenaar excp->throw_name = entry->sfile;
54825e0f586SBram Moolenaar entry->sfile = NULL;
54925e0f586SBram Moolenaar excp->throw_lnum = entry->slnum;
55025e0f586SBram Moolenaar }
55125e0f586SBram Moolenaar else
55225e0f586SBram Moolenaar {
5534f25b1abSBram Moolenaar excp->throw_name = estack_sfile(ESTACK_NONE);
5541a47ae32SBram Moolenaar if (excp->throw_name == NULL)
5551a47ae32SBram Moolenaar excp->throw_name = vim_strsave((char_u *)"");
556071d4279SBram Moolenaar if (excp->throw_name == NULL)
557071d4279SBram Moolenaar {
5589fee7d47SBram Moolenaar if (should_free)
559071d4279SBram Moolenaar vim_free(excp->value);
560071d4279SBram Moolenaar goto nomem;
561071d4279SBram Moolenaar }
5621a47ae32SBram Moolenaar excp->throw_lnum = SOURCING_LNUM;
56325e0f586SBram Moolenaar }
564071d4279SBram Moolenaar
565071d4279SBram Moolenaar if (p_verbose >= 13 || debug_break_level > 0)
566071d4279SBram Moolenaar {
567071d4279SBram Moolenaar int save_msg_silent = msg_silent;
568071d4279SBram Moolenaar
569071d4279SBram Moolenaar if (debug_break_level > 0)
570217e1b83SBram Moolenaar msg_silent = FALSE; // display messages
5715c06f8b0SBram Moolenaar else
5725c06f8b0SBram Moolenaar verbose_enter();
573071d4279SBram Moolenaar ++no_wait_return;
5745c06f8b0SBram Moolenaar if (debug_break_level > 0 || *p_vfile == NUL)
575217e1b83SBram Moolenaar msg_scroll = TRUE; // always scroll up, don't overwrite
5765c06f8b0SBram Moolenaar
577f9e3e09fSBram Moolenaar smsg(_("Exception thrown: %s"), excp->value);
578217e1b83SBram Moolenaar msg_puts("\n"); // don't overwrite this either
5795c06f8b0SBram Moolenaar
5805c06f8b0SBram Moolenaar if (debug_break_level > 0 || *p_vfile == NUL)
581071d4279SBram Moolenaar cmdline_row = msg_row;
582071d4279SBram Moolenaar --no_wait_return;
583071d4279SBram Moolenaar if (debug_break_level > 0)
584071d4279SBram Moolenaar msg_silent = save_msg_silent;
5855c06f8b0SBram Moolenaar else
5865c06f8b0SBram Moolenaar verbose_leave();
587071d4279SBram Moolenaar }
588071d4279SBram Moolenaar
589071d4279SBram Moolenaar current_exception = excp;
590071d4279SBram Moolenaar return OK;
591071d4279SBram Moolenaar
592071d4279SBram Moolenaar nomem:
593071d4279SBram Moolenaar vim_free(excp);
594071d4279SBram Moolenaar suppress_errthrow = TRUE;
595e29a27f6SBram Moolenaar emsg(_(e_out_of_memory));
596071d4279SBram Moolenaar fail:
597071d4279SBram Moolenaar current_exception = NULL;
598071d4279SBram Moolenaar return FAIL;
599071d4279SBram Moolenaar }
600071d4279SBram Moolenaar
601071d4279SBram Moolenaar /*
602071d4279SBram Moolenaar * Discard an exception. "was_finished" is set when the exception has been
603071d4279SBram Moolenaar * caught and the catch clause has been ended normally.
604071d4279SBram Moolenaar */
605071d4279SBram Moolenaar static void
discard_exception(except_T * excp,int was_finished)60678c0b7d4SBram Moolenaar discard_exception(except_T *excp, int was_finished)
607071d4279SBram Moolenaar {
608071d4279SBram Moolenaar char_u *saved_IObuff;
609071d4279SBram Moolenaar
61013656f02SBram Moolenaar if (current_exception == excp)
61113656f02SBram Moolenaar current_exception = NULL;
612071d4279SBram Moolenaar if (excp == NULL)
613071d4279SBram Moolenaar {
61495f09603SBram Moolenaar internal_error("discard_exception()");
615071d4279SBram Moolenaar return;
616071d4279SBram Moolenaar }
617071d4279SBram Moolenaar
618071d4279SBram Moolenaar if (p_verbose >= 13 || debug_break_level > 0)
619071d4279SBram Moolenaar {
620071d4279SBram Moolenaar int save_msg_silent = msg_silent;
621071d4279SBram Moolenaar
622071d4279SBram Moolenaar saved_IObuff = vim_strsave(IObuff);
623071d4279SBram Moolenaar if (debug_break_level > 0)
624217e1b83SBram Moolenaar msg_silent = FALSE; // display messages
6255c06f8b0SBram Moolenaar else
6265c06f8b0SBram Moolenaar verbose_enter();
627071d4279SBram Moolenaar ++no_wait_return;
6285c06f8b0SBram Moolenaar if (debug_break_level > 0 || *p_vfile == NUL)
629217e1b83SBram Moolenaar msg_scroll = TRUE; // always scroll up, don't overwrite
630051b782fSBram Moolenaar smsg(was_finished
631f9e3e09fSBram Moolenaar ? _("Exception finished: %s")
632f9e3e09fSBram Moolenaar : _("Exception discarded: %s"),
633071d4279SBram Moolenaar excp->value);
634217e1b83SBram Moolenaar msg_puts("\n"); // don't overwrite this either
6355c06f8b0SBram Moolenaar if (debug_break_level > 0 || *p_vfile == NUL)
636071d4279SBram Moolenaar cmdline_row = msg_row;
637071d4279SBram Moolenaar --no_wait_return;
638071d4279SBram Moolenaar if (debug_break_level > 0)
639071d4279SBram Moolenaar msg_silent = save_msg_silent;
6405c06f8b0SBram Moolenaar else
6415c06f8b0SBram Moolenaar verbose_leave();
642071d4279SBram Moolenaar STRCPY(IObuff, saved_IObuff);
643071d4279SBram Moolenaar vim_free(saved_IObuff);
644071d4279SBram Moolenaar }
645071d4279SBram Moolenaar if (excp->type != ET_INTERRUPT)
646071d4279SBram Moolenaar vim_free(excp->value);
647071d4279SBram Moolenaar if (excp->type == ET_ERROR)
648071d4279SBram Moolenaar free_msglist(excp->messages);
649071d4279SBram Moolenaar vim_free(excp->throw_name);
650071d4279SBram Moolenaar vim_free(excp);
651071d4279SBram Moolenaar }
652071d4279SBram Moolenaar
653071d4279SBram Moolenaar /*
654071d4279SBram Moolenaar * Discard the exception currently being thrown.
655071d4279SBram Moolenaar */
656071d4279SBram Moolenaar void
discard_current_exception(void)65778c0b7d4SBram Moolenaar discard_current_exception(void)
658071d4279SBram Moolenaar {
659cae24be4SBram Moolenaar if (current_exception != NULL)
660071d4279SBram Moolenaar discard_exception(current_exception, FALSE);
661071d4279SBram Moolenaar did_throw = FALSE;
662071d4279SBram Moolenaar need_rethrow = FALSE;
663071d4279SBram Moolenaar }
664071d4279SBram Moolenaar
665071d4279SBram Moolenaar /*
666071d4279SBram Moolenaar * Put an exception on the caught stack.
667071d4279SBram Moolenaar */
6688a7d6542SBram Moolenaar void
catch_exception(except_T * excp)66978c0b7d4SBram Moolenaar catch_exception(except_T *excp)
670071d4279SBram Moolenaar {
671071d4279SBram Moolenaar excp->caught = caught_stack;
672071d4279SBram Moolenaar caught_stack = excp;
673f9e3e09fSBram Moolenaar set_vim_var_string(VV_EXCEPTION, (char_u *)excp->value, -1);
674071d4279SBram Moolenaar if (*excp->throw_name != NUL)
675071d4279SBram Moolenaar {
676071d4279SBram Moolenaar if (excp->throw_lnum != 0)
677051b782fSBram Moolenaar vim_snprintf((char *)IObuff, IOSIZE, _("%s, line %ld"),
678051b782fSBram Moolenaar excp->throw_name, (long)excp->throw_lnum);
679071d4279SBram Moolenaar else
680051b782fSBram Moolenaar vim_snprintf((char *)IObuff, IOSIZE, "%s", excp->throw_name);
681071d4279SBram Moolenaar set_vim_var_string(VV_THROWPOINT, IObuff, -1);
682071d4279SBram Moolenaar }
683071d4279SBram Moolenaar else
684217e1b83SBram Moolenaar // throw_name not set on an exception from a command that was typed.
685071d4279SBram Moolenaar set_vim_var_string(VV_THROWPOINT, NULL, -1);
686071d4279SBram Moolenaar
687071d4279SBram Moolenaar if (p_verbose >= 13 || debug_break_level > 0)
688071d4279SBram Moolenaar {
689071d4279SBram Moolenaar int save_msg_silent = msg_silent;
690071d4279SBram Moolenaar
691071d4279SBram Moolenaar if (debug_break_level > 0)
692217e1b83SBram Moolenaar msg_silent = FALSE; // display messages
6935c06f8b0SBram Moolenaar else
6945c06f8b0SBram Moolenaar verbose_enter();
695071d4279SBram Moolenaar ++no_wait_return;
6965c06f8b0SBram Moolenaar if (debug_break_level > 0 || *p_vfile == NUL)
697217e1b83SBram Moolenaar msg_scroll = TRUE; // always scroll up, don't overwrite
6985c06f8b0SBram Moolenaar
699f9e3e09fSBram Moolenaar smsg(_("Exception caught: %s"), excp->value);
700217e1b83SBram Moolenaar msg_puts("\n"); // don't overwrite this either
7015c06f8b0SBram Moolenaar
7025c06f8b0SBram Moolenaar if (debug_break_level > 0 || *p_vfile == NUL)
703071d4279SBram Moolenaar cmdline_row = msg_row;
704071d4279SBram Moolenaar --no_wait_return;
705071d4279SBram Moolenaar if (debug_break_level > 0)
706071d4279SBram Moolenaar msg_silent = save_msg_silent;
7075c06f8b0SBram Moolenaar else
7085c06f8b0SBram Moolenaar verbose_leave();
709071d4279SBram Moolenaar }
710071d4279SBram Moolenaar }
711071d4279SBram Moolenaar
712071d4279SBram Moolenaar /*
713071d4279SBram Moolenaar * Remove an exception from the caught stack.
714071d4279SBram Moolenaar */
715071d4279SBram Moolenaar static void
finish_exception(except_T * excp)71678c0b7d4SBram Moolenaar finish_exception(except_T *excp)
717071d4279SBram Moolenaar {
718071d4279SBram Moolenaar if (excp != caught_stack)
71995f09603SBram Moolenaar internal_error("finish_exception()");
720071d4279SBram Moolenaar caught_stack = caught_stack->caught;
721071d4279SBram Moolenaar if (caught_stack != NULL)
722071d4279SBram Moolenaar {
723f9e3e09fSBram Moolenaar set_vim_var_string(VV_EXCEPTION, (char_u *)caught_stack->value, -1);
724071d4279SBram Moolenaar if (*caught_stack->throw_name != NUL)
725071d4279SBram Moolenaar {
726071d4279SBram Moolenaar if (caught_stack->throw_lnum != 0)
727051b782fSBram Moolenaar vim_snprintf((char *)IObuff, IOSIZE,
728071d4279SBram Moolenaar _("%s, line %ld"), caught_stack->throw_name,
729071d4279SBram Moolenaar (long)caught_stack->throw_lnum);
730071d4279SBram Moolenaar else
731051b782fSBram Moolenaar vim_snprintf((char *)IObuff, IOSIZE, "%s",
732051b782fSBram Moolenaar caught_stack->throw_name);
733071d4279SBram Moolenaar set_vim_var_string(VV_THROWPOINT, IObuff, -1);
734071d4279SBram Moolenaar }
735071d4279SBram Moolenaar else
736217e1b83SBram Moolenaar // throw_name not set on an exception from a command that was
737217e1b83SBram Moolenaar // typed.
738071d4279SBram Moolenaar set_vim_var_string(VV_THROWPOINT, NULL, -1);
739071d4279SBram Moolenaar }
740071d4279SBram Moolenaar else
741071d4279SBram Moolenaar {
742071d4279SBram Moolenaar set_vim_var_string(VV_EXCEPTION, NULL, -1);
743071d4279SBram Moolenaar set_vim_var_string(VV_THROWPOINT, NULL, -1);
744071d4279SBram Moolenaar }
745071d4279SBram Moolenaar
746217e1b83SBram Moolenaar // Discard the exception, but use the finish message for 'verbose'.
747071d4279SBram Moolenaar discard_exception(excp, TRUE);
748071d4279SBram Moolenaar }
749071d4279SBram Moolenaar
750071d4279SBram Moolenaar /*
751071d4279SBram Moolenaar * Flags specifying the message displayed by report_pending.
752071d4279SBram Moolenaar */
753071d4279SBram Moolenaar #define RP_MAKE 0
754071d4279SBram Moolenaar #define RP_RESUME 1
755071d4279SBram Moolenaar #define RP_DISCARD 2
756071d4279SBram Moolenaar
757071d4279SBram Moolenaar /*
758071d4279SBram Moolenaar * Report information about something pending in a finally clause if required by
759071d4279SBram Moolenaar * the 'verbose' option or when debugging. "action" tells whether something is
760071d4279SBram Moolenaar * made pending or something pending is resumed or discarded. "pending" tells
761071d4279SBram Moolenaar * what is pending. "value" specifies the return value for a pending ":return"
762071d4279SBram Moolenaar * or the exception value for a pending exception.
763071d4279SBram Moolenaar */
764071d4279SBram Moolenaar static void
report_pending(int action,int pending,void * value)76578c0b7d4SBram Moolenaar report_pending(int action, int pending, void *value)
766071d4279SBram Moolenaar {
767f9e3e09fSBram Moolenaar char *mesg;
768071d4279SBram Moolenaar char *s;
769071d4279SBram Moolenaar int save_msg_silent;
770071d4279SBram Moolenaar
771071d4279SBram Moolenaar
772071d4279SBram Moolenaar switch (action)
773071d4279SBram Moolenaar {
774071d4279SBram Moolenaar case RP_MAKE:
775f9e3e09fSBram Moolenaar mesg = _("%s made pending");
776071d4279SBram Moolenaar break;
777071d4279SBram Moolenaar case RP_RESUME:
778f9e3e09fSBram Moolenaar mesg = _("%s resumed");
779071d4279SBram Moolenaar break;
780217e1b83SBram Moolenaar // case RP_DISCARD:
781071d4279SBram Moolenaar default:
782f9e3e09fSBram Moolenaar mesg = _("%s discarded");
783071d4279SBram Moolenaar break;
784071d4279SBram Moolenaar }
785071d4279SBram Moolenaar
786071d4279SBram Moolenaar switch (pending)
787071d4279SBram Moolenaar {
788071d4279SBram Moolenaar case CSTP_NONE:
789071d4279SBram Moolenaar return;
790071d4279SBram Moolenaar
791071d4279SBram Moolenaar case CSTP_CONTINUE:
792071d4279SBram Moolenaar s = ":continue";
793071d4279SBram Moolenaar break;
794071d4279SBram Moolenaar case CSTP_BREAK:
795071d4279SBram Moolenaar s = ":break";
796071d4279SBram Moolenaar break;
797071d4279SBram Moolenaar case CSTP_FINISH:
798071d4279SBram Moolenaar s = ":finish";
799071d4279SBram Moolenaar break;
800071d4279SBram Moolenaar case CSTP_RETURN:
801217e1b83SBram Moolenaar // ":return" command producing value, allocated
802071d4279SBram Moolenaar s = (char *)get_return_cmd(value);
803071d4279SBram Moolenaar break;
804071d4279SBram Moolenaar
805071d4279SBram Moolenaar default:
806071d4279SBram Moolenaar if (pending & CSTP_THROW)
807071d4279SBram Moolenaar {
808f9e3e09fSBram Moolenaar vim_snprintf((char *)IObuff, IOSIZE, mesg, _("Exception"));
80971ccd03eSBram Moolenaar mesg = (char *)vim_strnsave(IObuff, STRLEN(IObuff) + 4);
810071d4279SBram Moolenaar STRCAT(mesg, ": %s");
811071d4279SBram Moolenaar s = (char *)((except_T *)value)->value;
812071d4279SBram Moolenaar }
813071d4279SBram Moolenaar else if ((pending & CSTP_ERROR) && (pending & CSTP_INTERRUPT))
814071d4279SBram Moolenaar s = _("Error and interrupt");
815071d4279SBram Moolenaar else if (pending & CSTP_ERROR)
816071d4279SBram Moolenaar s = _("Error");
817217e1b83SBram Moolenaar else // if (pending & CSTP_INTERRUPT)
818071d4279SBram Moolenaar s = _("Interrupt");
819071d4279SBram Moolenaar }
820071d4279SBram Moolenaar
821071d4279SBram Moolenaar save_msg_silent = msg_silent;
822071d4279SBram Moolenaar if (debug_break_level > 0)
823217e1b83SBram Moolenaar msg_silent = FALSE; // display messages
824071d4279SBram Moolenaar ++no_wait_return;
825217e1b83SBram Moolenaar msg_scroll = TRUE; // always scroll up, don't overwrite
826f9e3e09fSBram Moolenaar smsg(mesg, s);
827217e1b83SBram Moolenaar msg_puts("\n"); // don't overwrite this either
828071d4279SBram Moolenaar cmdline_row = msg_row;
829071d4279SBram Moolenaar --no_wait_return;
830071d4279SBram Moolenaar if (debug_break_level > 0)
831071d4279SBram Moolenaar msg_silent = save_msg_silent;
832071d4279SBram Moolenaar
833071d4279SBram Moolenaar if (pending == CSTP_RETURN)
834071d4279SBram Moolenaar vim_free(s);
835071d4279SBram Moolenaar else if (pending & CSTP_THROW)
836071d4279SBram Moolenaar vim_free(mesg);
837071d4279SBram Moolenaar }
838071d4279SBram Moolenaar
839071d4279SBram Moolenaar /*
840071d4279SBram Moolenaar * If something is made pending in a finally clause, report it if required by
841071d4279SBram Moolenaar * the 'verbose' option or when debugging.
842071d4279SBram Moolenaar */
843071d4279SBram Moolenaar void
report_make_pending(int pending,void * value)84478c0b7d4SBram Moolenaar report_make_pending(int pending, void *value)
845071d4279SBram Moolenaar {
846071d4279SBram Moolenaar if (p_verbose >= 14 || debug_break_level > 0)
8475c06f8b0SBram Moolenaar {
8485c06f8b0SBram Moolenaar if (debug_break_level <= 0)
8495c06f8b0SBram Moolenaar verbose_enter();
850071d4279SBram Moolenaar report_pending(RP_MAKE, pending, value);
8515c06f8b0SBram Moolenaar if (debug_break_level <= 0)
8525c06f8b0SBram Moolenaar verbose_leave();
8535c06f8b0SBram Moolenaar }
854071d4279SBram Moolenaar }
855071d4279SBram Moolenaar
856071d4279SBram Moolenaar /*
857071d4279SBram Moolenaar * If something pending in a finally clause is resumed at the ":endtry", report
858071d4279SBram Moolenaar * it if required by the 'verbose' option or when debugging.
859071d4279SBram Moolenaar */
8605843f5f3SBram Moolenaar static void
report_resume_pending(int pending,void * value)86178c0b7d4SBram Moolenaar report_resume_pending(int pending, void *value)
862071d4279SBram Moolenaar {
863071d4279SBram Moolenaar if (p_verbose >= 14 || debug_break_level > 0)
8645c06f8b0SBram Moolenaar {
8655c06f8b0SBram Moolenaar if (debug_break_level <= 0)
8665c06f8b0SBram Moolenaar verbose_enter();
867071d4279SBram Moolenaar report_pending(RP_RESUME, pending, value);
8685c06f8b0SBram Moolenaar if (debug_break_level <= 0)
8695c06f8b0SBram Moolenaar verbose_leave();
8705c06f8b0SBram Moolenaar }
871071d4279SBram Moolenaar }
872071d4279SBram Moolenaar
873071d4279SBram Moolenaar /*
874071d4279SBram Moolenaar * If something pending in a finally clause is discarded, report it if required
875071d4279SBram Moolenaar * by the 'verbose' option or when debugging.
876071d4279SBram Moolenaar */
8775843f5f3SBram Moolenaar static void
report_discard_pending(int pending,void * value)87878c0b7d4SBram Moolenaar report_discard_pending(int pending, void *value)
879071d4279SBram Moolenaar {
880071d4279SBram Moolenaar if (p_verbose >= 14 || debug_break_level > 0)
8815c06f8b0SBram Moolenaar {
8825c06f8b0SBram Moolenaar if (debug_break_level <= 0)
8835c06f8b0SBram Moolenaar verbose_enter();
884071d4279SBram Moolenaar report_pending(RP_DISCARD, pending, value);
8855c06f8b0SBram Moolenaar if (debug_break_level <= 0)
8865c06f8b0SBram Moolenaar verbose_leave();
8875c06f8b0SBram Moolenaar }
888071d4279SBram Moolenaar }
889071d4279SBram Moolenaar
8904799cef8SBram Moolenaar int
cmd_is_name_only(char_u * arg)8914799cef8SBram Moolenaar cmd_is_name_only(char_u *arg)
8924799cef8SBram Moolenaar {
8934799cef8SBram Moolenaar char_u *p = arg;
8944799cef8SBram Moolenaar char_u *alias;
8954799cef8SBram Moolenaar int name_only = FALSE;
8964799cef8SBram Moolenaar
8974799cef8SBram Moolenaar if (*p == '&')
8984799cef8SBram Moolenaar {
8994799cef8SBram Moolenaar ++p;
9004799cef8SBram Moolenaar if (STRNCMP("l:", p, 2) == 0 || STRNCMP("g:", p, 2) == 0)
9014799cef8SBram Moolenaar p += 2;
9024799cef8SBram Moolenaar }
9034799cef8SBram Moolenaar else if (*p == '@')
9044799cef8SBram Moolenaar ++p;
9054799cef8SBram Moolenaar get_name_len(&p, &alias, FALSE, FALSE);
9064799cef8SBram Moolenaar name_only = ends_excmd2(arg, skipwhite(p));
9074799cef8SBram Moolenaar vim_free(alias);
9084799cef8SBram Moolenaar return name_only;
9094799cef8SBram Moolenaar }
910071d4279SBram Moolenaar
911071d4279SBram Moolenaar /*
91225e42231SBram Moolenaar * ":eval".
91325e42231SBram Moolenaar */
91425e42231SBram Moolenaar void
ex_eval(exarg_T * eap)91525e42231SBram Moolenaar ex_eval(exarg_T *eap)
91625e42231SBram Moolenaar {
91725e42231SBram Moolenaar typval_T tv;
9185409f5d8SBram Moolenaar evalarg_T evalarg;
919c323527dSBram Moolenaar int name_only = FALSE;
920c323527dSBram Moolenaar long lnum = SOURCING_LNUM;
921c323527dSBram Moolenaar
922c323527dSBram Moolenaar if (in_vim9script())
9234799cef8SBram Moolenaar name_only = cmd_is_name_only(eap->arg);
92425e42231SBram Moolenaar
925e6b5324eSBram Moolenaar fill_evalarg_from_eap(&evalarg, eap, eap->skip);
9265409f5d8SBram Moolenaar
927b171fb17SBram Moolenaar if (eval0(eap->arg, &tv, eap, &evalarg) == OK)
928c323527dSBram Moolenaar {
92925e42231SBram Moolenaar clear_tv(&tv);
930c323527dSBram Moolenaar if (in_vim9script() && name_only && lnum == SOURCING_LNUM)
931c323527dSBram Moolenaar semsg(_(e_expression_without_effect_str), eap->arg);
932c323527dSBram Moolenaar }
933b7a78f7aSBram Moolenaar
934b7a78f7aSBram Moolenaar clear_evalarg(&evalarg, eap);
93525e42231SBram Moolenaar }
93625e42231SBram Moolenaar
93725e42231SBram Moolenaar /*
938fcdc5d83SBram Moolenaar * Start a new scope/block. Caller should have checked that cs_idx is not
939fcdc5d83SBram Moolenaar * exceeding CSTACK_LEN.
940fcdc5d83SBram Moolenaar */
941fcdc5d83SBram Moolenaar static void
enter_block(cstack_T * cstack)942fcdc5d83SBram Moolenaar enter_block(cstack_T *cstack)
943fcdc5d83SBram Moolenaar {
944fcdc5d83SBram Moolenaar ++cstack->cs_idx;
9450abc6e47SBram Moolenaar if (in_vim9script() && current_sctx.sc_sid > 0)
9468d739de4SBram Moolenaar {
9478d739de4SBram Moolenaar scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
9488d739de4SBram Moolenaar
9498d739de4SBram Moolenaar cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len;
950fbbcd003SBram Moolenaar cstack->cs_block_id[cstack->cs_idx] = ++si->sn_last_block_id;
951fbbcd003SBram Moolenaar si->sn_current_block_id = si->sn_last_block_id;
9528d739de4SBram Moolenaar }
9533e492c2dSBram Moolenaar else
9543e492c2dSBram Moolenaar {
9553e492c2dSBram Moolenaar // Just in case in_vim9script() does not return the same value when the
9563e492c2dSBram Moolenaar // block ends.
9573e492c2dSBram Moolenaar cstack->cs_script_var_len[cstack->cs_idx] = 0;
9583e492c2dSBram Moolenaar cstack->cs_block_id[cstack->cs_idx] = 0;
9593e492c2dSBram Moolenaar }
960fcdc5d83SBram Moolenaar }
961fcdc5d83SBram Moolenaar
962fcdc5d83SBram Moolenaar static void
leave_block(cstack_T * cstack)963fcdc5d83SBram Moolenaar leave_block(cstack_T *cstack)
964fcdc5d83SBram Moolenaar {
9658d739de4SBram Moolenaar if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
966fcdc5d83SBram Moolenaar {
967fcdc5d83SBram Moolenaar scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
9688d739de4SBram Moolenaar int i;
96939ca4127SBram Moolenaar int func_defined =
97039ca4127SBram Moolenaar cstack->cs_flags[cstack->cs_idx] & CSF_FUNC_DEF;
971fcdc5d83SBram Moolenaar
972fcdc5d83SBram Moolenaar for (i = cstack->cs_script_var_len[cstack->cs_idx];
973fcdc5d83SBram Moolenaar i < si->sn_var_vals.ga_len; ++i)
974fcdc5d83SBram Moolenaar {
975fcdc5d83SBram Moolenaar svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
976fcdc5d83SBram Moolenaar
97739ca4127SBram Moolenaar // sv_name is set to NULL if it was already removed. This happens
97839ca4127SBram Moolenaar // when it was defined in an inner block and no functions were
97939ca4127SBram Moolenaar // defined there.
980d747548cSBram Moolenaar if (sv->sv_name != NULL)
981fcdc5d83SBram Moolenaar // Remove a variable declared inside the block, if it still
98239ca4127SBram Moolenaar // exists, from sn_vars and move the value into sn_all_vars
98339ca4127SBram Moolenaar // if "func_defined" is non-zero.
98439ca4127SBram Moolenaar hide_script_var(si, i, func_defined);
985d747548cSBram Moolenaar }
9868d739de4SBram Moolenaar
987fbbcd003SBram Moolenaar if (cstack->cs_idx == 0)
988fbbcd003SBram Moolenaar si->sn_current_block_id = 0;
989fbbcd003SBram Moolenaar else
990fbbcd003SBram Moolenaar si->sn_current_block_id = cstack->cs_block_id[cstack->cs_idx - 1];
991fcdc5d83SBram Moolenaar }
992fcdc5d83SBram Moolenaar --cstack->cs_idx;
993fcdc5d83SBram Moolenaar }
994fcdc5d83SBram Moolenaar
995fcdc5d83SBram Moolenaar /*
996071d4279SBram Moolenaar * ":if".
997071d4279SBram Moolenaar */
998071d4279SBram Moolenaar void
ex_if(exarg_T * eap)99978c0b7d4SBram Moolenaar ex_if(exarg_T *eap)
1000071d4279SBram Moolenaar {
1001071d4279SBram Moolenaar int error;
1002071d4279SBram Moolenaar int skip;
1003071d4279SBram Moolenaar int result;
1004ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1005071d4279SBram Moolenaar
1006071d4279SBram Moolenaar if (cstack->cs_idx == CSTACK_LEN - 1)
10078930caaaSBram Moolenaar eap->errmsg = _("E579: :if nesting too deep");
1008071d4279SBram Moolenaar else
1009071d4279SBram Moolenaar {
1010fcdc5d83SBram Moolenaar enter_block(cstack);
1011071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] = 0;
1012071d4279SBram Moolenaar
1013071d4279SBram Moolenaar /*
1014fcdc5d83SBram Moolenaar * Don't do something after an error, interrupt, or throw, or when
1015fcdc5d83SBram Moolenaar * there is a surrounding conditional and it was not active.
1016071d4279SBram Moolenaar */
1017071d4279SBram Moolenaar skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1018071d4279SBram Moolenaar && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1019071d4279SBram Moolenaar
1020b171fb17SBram Moolenaar result = eval_to_bool(eap->arg, &error, eap, skip);
1021071d4279SBram Moolenaar
1022071d4279SBram Moolenaar if (!skip && !error)
1023071d4279SBram Moolenaar {
1024071d4279SBram Moolenaar if (result)
1025071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1026071d4279SBram Moolenaar }
1027071d4279SBram Moolenaar else
1028217e1b83SBram Moolenaar // set TRUE, so this conditional will never get active
1029071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1030071d4279SBram Moolenaar }
1031071d4279SBram Moolenaar }
1032071d4279SBram Moolenaar
1033071d4279SBram Moolenaar /*
1034071d4279SBram Moolenaar * ":endif".
1035071d4279SBram Moolenaar */
1036071d4279SBram Moolenaar void
ex_endif(exarg_T * eap)103778c0b7d4SBram Moolenaar ex_endif(exarg_T *eap)
1038071d4279SBram Moolenaar {
1039fcdc5d83SBram Moolenaar cstack_T *cstack = eap->cstack;
1040fcdc5d83SBram Moolenaar
1041917c46abSBram Moolenaar if (cmdmod_error(FALSE))
1042fa984418SBram Moolenaar return;
1043071d4279SBram Moolenaar did_endif = TRUE;
1044fcdc5d83SBram Moolenaar if (cstack->cs_idx < 0
1045fcdc5d83SBram Moolenaar || (cstack->cs_flags[cstack->cs_idx]
10469becdf2bSBram Moolenaar & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
10478930caaaSBram Moolenaar eap->errmsg = _(e_endif_without_if);
1048071d4279SBram Moolenaar else
1049071d4279SBram Moolenaar {
1050071d4279SBram Moolenaar /*
1051071d4279SBram Moolenaar * When debugging or a breakpoint was encountered, display the debug
1052071d4279SBram Moolenaar * prompt (if not already done). This shows the user that an ":endif"
1053071d4279SBram Moolenaar * is executed when the ":if" or a previous ":elseif" was not TRUE.
1054071d4279SBram Moolenaar * Handle a ">quit" debug command as if an interrupt had occurred before
1055071d4279SBram Moolenaar * the ":endif". That is, throw an interrupt exception if appropriate.
1056071d4279SBram Moolenaar * Doing this here prevents an exception for a parsing error being
1057071d4279SBram Moolenaar * discarded by throwing the interrupt exception later on.
1058071d4279SBram Moolenaar */
1059fcdc5d83SBram Moolenaar if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
1060f461c8e7SBram Moolenaar && dbg_check_skipped(eap))
1061fcdc5d83SBram Moolenaar (void)do_intthrow(cstack);
1062071d4279SBram Moolenaar
1063fcdc5d83SBram Moolenaar leave_block(cstack);
1064071d4279SBram Moolenaar }
1065071d4279SBram Moolenaar }
1066071d4279SBram Moolenaar
1067071d4279SBram Moolenaar /*
1068071d4279SBram Moolenaar * ":else" and ":elseif".
1069071d4279SBram Moolenaar */
1070071d4279SBram Moolenaar void
ex_else(exarg_T * eap)107178c0b7d4SBram Moolenaar ex_else(exarg_T *eap)
1072071d4279SBram Moolenaar {
1073071d4279SBram Moolenaar int error;
1074071d4279SBram Moolenaar int skip;
1075071d4279SBram Moolenaar int result;
1076ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1077071d4279SBram Moolenaar
1078071d4279SBram Moolenaar /*
1079071d4279SBram Moolenaar * Don't do something after an error, interrupt, or throw, or when there is
1080071d4279SBram Moolenaar * a surrounding conditional and it was not active.
1081071d4279SBram Moolenaar */
1082071d4279SBram Moolenaar skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1083071d4279SBram Moolenaar && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1084071d4279SBram Moolenaar
1085071d4279SBram Moolenaar if (cstack->cs_idx < 0
10861280586eSBram Moolenaar || (cstack->cs_flags[cstack->cs_idx]
10879becdf2bSBram Moolenaar & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK)))
1088071d4279SBram Moolenaar {
1089071d4279SBram Moolenaar if (eap->cmdidx == CMD_else)
1090071d4279SBram Moolenaar {
10918930caaaSBram Moolenaar eap->errmsg = _(e_else_without_if);
1092071d4279SBram Moolenaar return;
1093071d4279SBram Moolenaar }
10948930caaaSBram Moolenaar eap->errmsg = _(e_elseif_without_if);
1095071d4279SBram Moolenaar skip = TRUE;
1096071d4279SBram Moolenaar }
1097071d4279SBram Moolenaar else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE)
1098071d4279SBram Moolenaar {
1099071d4279SBram Moolenaar if (eap->cmdidx == CMD_else)
1100071d4279SBram Moolenaar {
11018930caaaSBram Moolenaar eap->errmsg = _("E583: multiple :else");
1102071d4279SBram Moolenaar return;
1103071d4279SBram Moolenaar }
11048930caaaSBram Moolenaar eap->errmsg = _("E584: :elseif after :else");
1105071d4279SBram Moolenaar skip = TRUE;
1106071d4279SBram Moolenaar }
1107071d4279SBram Moolenaar
1108217e1b83SBram Moolenaar // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it
1109071d4279SBram Moolenaar if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE)
1110071d4279SBram Moolenaar {
1111071d4279SBram Moolenaar if (eap->errmsg == NULL)
1112071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1113217e1b83SBram Moolenaar skip = TRUE; // don't evaluate an ":elseif"
1114071d4279SBram Moolenaar }
1115071d4279SBram Moolenaar else
1116071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE;
1117071d4279SBram Moolenaar
1118071d4279SBram Moolenaar /*
1119071d4279SBram Moolenaar * When debugging or a breakpoint was encountered, display the debug prompt
1120071d4279SBram Moolenaar * (if not already done). This shows the user that an ":else" or ":elseif"
1121071d4279SBram Moolenaar * is executed when the ":if" or previous ":elseif" was not TRUE. Handle
1122071d4279SBram Moolenaar * a ">quit" debug command as if an interrupt had occurred before the
1123071d4279SBram Moolenaar * ":else" or ":elseif". That is, set "skip" and throw an interrupt
1124071d4279SBram Moolenaar * exception if appropriate. Doing this here prevents that an exception
1125071d4279SBram Moolenaar * for a parsing errors is discarded when throwing the interrupt exception
1126071d4279SBram Moolenaar * later on.
1127071d4279SBram Moolenaar */
1128071d4279SBram Moolenaar if (!skip && dbg_check_skipped(eap) && got_int)
1129071d4279SBram Moolenaar {
1130071d4279SBram Moolenaar (void)do_intthrow(cstack);
1131071d4279SBram Moolenaar skip = TRUE;
1132071d4279SBram Moolenaar }
1133071d4279SBram Moolenaar
1134071d4279SBram Moolenaar if (eap->cmdidx == CMD_elseif)
1135071d4279SBram Moolenaar {
1136b171fb17SBram Moolenaar result = eval_to_bool(eap->arg, &error, eap, skip);
11372c5ed4e3SBram Moolenaar
1138217e1b83SBram Moolenaar // When throwing error exceptions, we want to throw always the first
1139217e1b83SBram Moolenaar // of several errors in a row. This is what actually happens when
1140217e1b83SBram Moolenaar // a conditional error was detected above and there is another failure
1141217e1b83SBram Moolenaar // when parsing the expression. Since the skip flag is set in this
1142217e1b83SBram Moolenaar // case, the parsing error will be ignored by emsg().
1143071d4279SBram Moolenaar if (!skip && !error)
1144071d4279SBram Moolenaar {
1145071d4279SBram Moolenaar if (result)
1146071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE;
1147071d4279SBram Moolenaar else
1148071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] = 0;
1149071d4279SBram Moolenaar }
1150071d4279SBram Moolenaar else if (eap->errmsg == NULL)
1151217e1b83SBram Moolenaar // set TRUE, so this conditional will never get active
1152071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] = CSF_TRUE;
1153071d4279SBram Moolenaar }
1154071d4279SBram Moolenaar else
1155071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE;
1156071d4279SBram Moolenaar }
1157071d4279SBram Moolenaar
1158071d4279SBram Moolenaar /*
11591280586eSBram Moolenaar * Handle ":while" and ":for".
1160071d4279SBram Moolenaar */
1161071d4279SBram Moolenaar void
ex_while(exarg_T * eap)116278c0b7d4SBram Moolenaar ex_while(exarg_T *eap)
1163071d4279SBram Moolenaar {
1164071d4279SBram Moolenaar int error;
1165071d4279SBram Moolenaar int skip;
1166071d4279SBram Moolenaar int result;
1167ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1168071d4279SBram Moolenaar
1169071d4279SBram Moolenaar if (cstack->cs_idx == CSTACK_LEN - 1)
11708930caaaSBram Moolenaar eap->errmsg = _("E585: :while/:for nesting too deep");
1171071d4279SBram Moolenaar else
1172071d4279SBram Moolenaar {
1173071d4279SBram Moolenaar /*
11741280586eSBram Moolenaar * The loop flag is set when we have jumped back from the matching
11751280586eSBram Moolenaar * ":endwhile" or ":endfor". When not set, need to initialise this
11761280586eSBram Moolenaar * cstack entry.
1177071d4279SBram Moolenaar */
11781280586eSBram Moolenaar if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0)
1179071d4279SBram Moolenaar {
1180fcdc5d83SBram Moolenaar enter_block(cstack);
11811280586eSBram Moolenaar ++cstack->cs_looplevel;
1182071d4279SBram Moolenaar cstack->cs_line[cstack->cs_idx] = -1;
1183071d4279SBram Moolenaar }
1184522eefd9SBram Moolenaar else
1185522eefd9SBram Moolenaar {
1186522eefd9SBram Moolenaar if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid))
1187522eefd9SBram Moolenaar {
1188522eefd9SBram Moolenaar scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid);
1189522eefd9SBram Moolenaar int i;
11902eb6fc3bSBram Moolenaar int func_defined = cstack->cs_flags[cstack->cs_idx]
11912eb6fc3bSBram Moolenaar & CSF_FUNC_DEF;
1192522eefd9SBram Moolenaar
1193522eefd9SBram Moolenaar // Any variables defined in the previous round are no longer
1194*ee56f3f1SBram Moolenaar // visible. Keep the first one, it is the loop variable that
1195*ee56f3f1SBram Moolenaar // we reuse every time around.
1196*ee56f3f1SBram Moolenaar for (i = cstack->cs_script_var_len[cstack->cs_idx] + 1;
1197522eefd9SBram Moolenaar i < si->sn_var_vals.ga_len; ++i)
1198522eefd9SBram Moolenaar {
1199522eefd9SBram Moolenaar svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i;
1200522eefd9SBram Moolenaar
1201522eefd9SBram Moolenaar // sv_name is set to NULL if it was already removed. This
1202522eefd9SBram Moolenaar // happens when it was defined in an inner block and no
1203522eefd9SBram Moolenaar // functions were defined there.
1204522eefd9SBram Moolenaar if (sv->sv_name != NULL)
1205522eefd9SBram Moolenaar // Remove a variable declared inside the block, if it
1206522eefd9SBram Moolenaar // still exists, from sn_vars.
12072eb6fc3bSBram Moolenaar hide_script_var(si, i, func_defined);
1208522eefd9SBram Moolenaar }
1209522eefd9SBram Moolenaar }
1210522eefd9SBram Moolenaar }
12111280586eSBram Moolenaar cstack->cs_flags[cstack->cs_idx] =
12121280586eSBram Moolenaar eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR;
1213071d4279SBram Moolenaar
1214071d4279SBram Moolenaar /*
12151280586eSBram Moolenaar * Don't do something after an error, interrupt, or throw, or when
12161280586eSBram Moolenaar * there is a surrounding conditional and it was not active.
1217071d4279SBram Moolenaar */
1218071d4279SBram Moolenaar skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1219071d4279SBram Moolenaar && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
12201280586eSBram Moolenaar if (eap->cmdidx == CMD_while)
1221071d4279SBram Moolenaar {
12221280586eSBram Moolenaar /*
12231280586eSBram Moolenaar * ":while bool-expr"
12241280586eSBram Moolenaar */
1225b171fb17SBram Moolenaar result = eval_to_bool(eap->arg, &error, eap, skip);
1226071d4279SBram Moolenaar }
1227071d4279SBram Moolenaar else
1228071d4279SBram Moolenaar {
12291280586eSBram Moolenaar void *fi;
1230b7a78f7aSBram Moolenaar evalarg_T evalarg;
1231b7a78f7aSBram Moolenaar
1232522eefd9SBram Moolenaar /*
1233522eefd9SBram Moolenaar * ":for var in list-expr"
1234522eefd9SBram Moolenaar */
12352eb6fc3bSBram Moolenaar fill_evalarg_from_eap(&evalarg, eap, skip);
12361280586eSBram Moolenaar if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0)
12371280586eSBram Moolenaar {
1238217e1b83SBram Moolenaar // Jumping here from a ":continue" or ":endfor": use the
1239217e1b83SBram Moolenaar // previously evaluated list.
1240de8866baSBram Moolenaar fi = cstack->cs_forinfo[cstack->cs_idx];
12411280586eSBram Moolenaar error = FALSE;
1242b7a78f7aSBram Moolenaar
1243b7a78f7aSBram Moolenaar // the "in expr" is not used, skip over it
1244b7a78f7aSBram Moolenaar skip_for_lines(fi, &evalarg);
12451280586eSBram Moolenaar }
12461280586eSBram Moolenaar else
12471280586eSBram Moolenaar {
1248d4ab807dSBram Moolenaar long save_lnum = SOURCING_LNUM;
1249d4ab807dSBram Moolenaar
1250217e1b83SBram Moolenaar // Evaluate the argument and get the info in a structure.
1251b7a78f7aSBram Moolenaar fi = eval_for_line(eap->arg, &error, eap, &evalarg);
1252de8866baSBram Moolenaar cstack->cs_forinfo[cstack->cs_idx] = fi;
1253d4ab807dSBram Moolenaar
1254d4ab807dSBram Moolenaar // Errors should use the first line number.
1255d4ab807dSBram Moolenaar SOURCING_LNUM = save_lnum;
12561280586eSBram Moolenaar }
12571280586eSBram Moolenaar
1258217e1b83SBram Moolenaar // use the element at the start of the list and advance
12591280586eSBram Moolenaar if (!error && fi != NULL && !skip)
12601280586eSBram Moolenaar result = next_for_item(fi, eap->arg);
12611280586eSBram Moolenaar else
12621280586eSBram Moolenaar result = FALSE;
12631280586eSBram Moolenaar
12641280586eSBram Moolenaar if (!result)
12651280586eSBram Moolenaar {
12661280586eSBram Moolenaar free_for_info(fi);
1267de8866baSBram Moolenaar cstack->cs_forinfo[cstack->cs_idx] = NULL;
12681280586eSBram Moolenaar }
1269b7a78f7aSBram Moolenaar clear_evalarg(&evalarg, eap);
12701280586eSBram Moolenaar }
12711280586eSBram Moolenaar
12721280586eSBram Moolenaar /*
12731280586eSBram Moolenaar * If this cstack entry was just initialised and is active, set the
12741280586eSBram Moolenaar * loop flag, so do_cmdline() will set the line number in cs_line[].
12751280586eSBram Moolenaar * If executing the command a second time, clear the loop flag.
12761280586eSBram Moolenaar */
12771280586eSBram Moolenaar if (!skip && !error && result)
12781280586eSBram Moolenaar {
12791280586eSBram Moolenaar cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE);
12801280586eSBram Moolenaar cstack->cs_lflags ^= CSL_HAD_LOOP;
12811280586eSBram Moolenaar }
12821280586eSBram Moolenaar else
12831280586eSBram Moolenaar {
12841280586eSBram Moolenaar cstack->cs_lflags &= ~CSL_HAD_LOOP;
1285217e1b83SBram Moolenaar // If the ":while" evaluates to FALSE or ":for" is past the end of
1286217e1b83SBram Moolenaar // the list, show the debug prompt at the ":endwhile"/":endfor" as
1287217e1b83SBram Moolenaar // if there was a ":break" in a ":while"/":for" evaluating to
1288217e1b83SBram Moolenaar // TRUE.
1289071d4279SBram Moolenaar if (!skip && !error)
1290071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE;
1291071d4279SBram Moolenaar }
1292071d4279SBram Moolenaar }
1293071d4279SBram Moolenaar }
1294071d4279SBram Moolenaar
1295071d4279SBram Moolenaar /*
1296071d4279SBram Moolenaar * ":continue"
1297071d4279SBram Moolenaar */
1298071d4279SBram Moolenaar void
ex_continue(exarg_T * eap)129978c0b7d4SBram Moolenaar ex_continue(exarg_T *eap)
1300071d4279SBram Moolenaar {
1301071d4279SBram Moolenaar int idx;
1302ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1303071d4279SBram Moolenaar
13041280586eSBram Moolenaar if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
13058930caaaSBram Moolenaar eap->errmsg = _(e_continue);
1306071d4279SBram Moolenaar else
1307071d4279SBram Moolenaar {
1308217e1b83SBram Moolenaar // Try to find the matching ":while". This might stop at a try
1309217e1b83SBram Moolenaar // conditional not in its finally clause (which is then to be executed
1310c323527dSBram Moolenaar // next). Therefore, inactivate all conditionals except the ":while"
1311217e1b83SBram Moolenaar // itself (if reached).
13121280586eSBram Moolenaar idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
1313eb3593b3SBram Moolenaar if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
1314071d4279SBram Moolenaar {
1315071d4279SBram Moolenaar rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1316071d4279SBram Moolenaar
1317071d4279SBram Moolenaar /*
13181280586eSBram Moolenaar * Set CSL_HAD_CONT, so do_cmdline() will jump back to the
1319071d4279SBram Moolenaar * matching ":while".
1320071d4279SBram Moolenaar */
1321217e1b83SBram Moolenaar cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it
1322071d4279SBram Moolenaar }
1323071d4279SBram Moolenaar else
1324071d4279SBram Moolenaar {
1325217e1b83SBram Moolenaar // If a try conditional not in its finally clause is reached first,
1326217e1b83SBram Moolenaar // make the ":continue" pending for execution at the ":endtry".
1327071d4279SBram Moolenaar cstack->cs_pending[idx] = CSTP_CONTINUE;
1328071d4279SBram Moolenaar report_make_pending(CSTP_CONTINUE, NULL);
1329071d4279SBram Moolenaar }
1330071d4279SBram Moolenaar }
1331071d4279SBram Moolenaar }
1332071d4279SBram Moolenaar
1333071d4279SBram Moolenaar /*
1334071d4279SBram Moolenaar * ":break"
1335071d4279SBram Moolenaar */
1336071d4279SBram Moolenaar void
ex_break(exarg_T * eap)133778c0b7d4SBram Moolenaar ex_break(exarg_T *eap)
1338071d4279SBram Moolenaar {
1339071d4279SBram Moolenaar int idx;
1340ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1341071d4279SBram Moolenaar
13421280586eSBram Moolenaar if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
13438930caaaSBram Moolenaar eap->errmsg = _(e_break);
1344071d4279SBram Moolenaar else
1345071d4279SBram Moolenaar {
1346217e1b83SBram Moolenaar // Inactivate conditionals until the matching ":while" or a try
1347217e1b83SBram Moolenaar // conditional not in its finally clause (which is then to be
1348217e1b83SBram Moolenaar // executed next) is found. In the latter case, make the ":break"
1349217e1b83SBram Moolenaar // pending for execution at the ":endtry".
13501280586eSBram Moolenaar idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE);
1351eb3593b3SBram Moolenaar if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR)))
1352071d4279SBram Moolenaar {
1353071d4279SBram Moolenaar cstack->cs_pending[idx] = CSTP_BREAK;
1354071d4279SBram Moolenaar report_make_pending(CSTP_BREAK, NULL);
1355071d4279SBram Moolenaar }
1356071d4279SBram Moolenaar }
1357071d4279SBram Moolenaar }
1358071d4279SBram Moolenaar
1359071d4279SBram Moolenaar /*
13601280586eSBram Moolenaar * ":endwhile" and ":endfor"
1361071d4279SBram Moolenaar */
1362071d4279SBram Moolenaar void
ex_endwhile(exarg_T * eap)136378c0b7d4SBram Moolenaar ex_endwhile(exarg_T *eap)
1364071d4279SBram Moolenaar {
1365ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1366071d4279SBram Moolenaar int idx;
1367f9e3e09fSBram Moolenaar char *err;
13681280586eSBram Moolenaar int csf;
13691280586eSBram Moolenaar int fl;
1370071d4279SBram Moolenaar
1371917c46abSBram Moolenaar if (cmdmod_error(TRUE))
1372fa984418SBram Moolenaar return;
1373fa984418SBram Moolenaar
13741280586eSBram Moolenaar if (eap->cmdidx == CMD_endwhile)
13751280586eSBram Moolenaar {
13761280586eSBram Moolenaar err = e_while;
13771280586eSBram Moolenaar csf = CSF_WHILE;
13781280586eSBram Moolenaar }
1379071d4279SBram Moolenaar else
1380071d4279SBram Moolenaar {
13811280586eSBram Moolenaar err = e_for;
13821280586eSBram Moolenaar csf = CSF_FOR;
13831280586eSBram Moolenaar }
13841280586eSBram Moolenaar
13851280586eSBram Moolenaar if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0)
13868930caaaSBram Moolenaar eap->errmsg = _(err);
13871280586eSBram Moolenaar else
1388071d4279SBram Moolenaar {
13891280586eSBram Moolenaar fl = cstack->cs_flags[cstack->cs_idx];
13901280586eSBram Moolenaar if (!(fl & csf))
13911280586eSBram Moolenaar {
1392217e1b83SBram Moolenaar // If we are in a ":while" or ":for" but used the wrong endloop
1393217e1b83SBram Moolenaar // command, do not rewind to the next enclosing ":for"/":while".
13941280586eSBram Moolenaar if (fl & CSF_WHILE)
1395f9e3e09fSBram Moolenaar eap->errmsg = _("E732: Using :endfor with :while");
13961280586eSBram Moolenaar else if (fl & CSF_FOR)
1397f9e3e09fSBram Moolenaar eap->errmsg = _("E733: Using :endwhile with :for");
13983a3a7234SBram Moolenaar }
13993a3a7234SBram Moolenaar if (!(fl & (CSF_WHILE | CSF_FOR)))
14003a3a7234SBram Moolenaar {
14013a3a7234SBram Moolenaar if (!(fl & CSF_TRY))
14028930caaaSBram Moolenaar eap->errmsg = _(e_endif);
14031280586eSBram Moolenaar else if (fl & CSF_FINALLY)
14048930caaaSBram Moolenaar eap->errmsg = _(e_endtry);
1405217e1b83SBram Moolenaar // Try to find the matching ":while" and report what's missing.
1406071d4279SBram Moolenaar for (idx = cstack->cs_idx; idx > 0; --idx)
1407071d4279SBram Moolenaar {
14081280586eSBram Moolenaar fl = cstack->cs_flags[idx];
14091280586eSBram Moolenaar if ((fl & CSF_TRY) && !(fl & CSF_FINALLY))
1410071d4279SBram Moolenaar {
1411217e1b83SBram Moolenaar // Give up at a try conditional not in its finally clause.
1412217e1b83SBram Moolenaar // Ignore the ":endwhile"/":endfor".
14138930caaaSBram Moolenaar eap->errmsg = _(err);
1414071d4279SBram Moolenaar return;
1415071d4279SBram Moolenaar }
14161280586eSBram Moolenaar if (fl & csf)
1417071d4279SBram Moolenaar break;
1418071d4279SBram Moolenaar }
1419217e1b83SBram Moolenaar // Cleanup and rewind all contained (and unclosed) conditionals.
14201280586eSBram Moolenaar (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE);
1421071d4279SBram Moolenaar rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel);
1422071d4279SBram Moolenaar }
1423071d4279SBram Moolenaar
1424071d4279SBram Moolenaar /*
1425071d4279SBram Moolenaar * When debugging or a breakpoint was encountered, display the debug
1426071d4279SBram Moolenaar * prompt (if not already done). This shows the user that an
14271280586eSBram Moolenaar * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or
14281280586eSBram Moolenaar * after a ":break". Handle a ">quit" debug command as if an
14291280586eSBram Moolenaar * interrupt had occurred before the ":endwhile"/":endfor". That is,
14301280586eSBram Moolenaar * throw an interrupt exception if appropriate. Doing this here
14311280586eSBram Moolenaar * prevents that an exception for a parsing error is discarded when
14321280586eSBram Moolenaar * throwing the interrupt exception later on.
1433071d4279SBram Moolenaar */
1434071d4279SBram Moolenaar else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE
1435071d4279SBram Moolenaar && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE)
1436071d4279SBram Moolenaar && dbg_check_skipped(eap))
1437071d4279SBram Moolenaar (void)do_intthrow(cstack);
1438071d4279SBram Moolenaar
1439522eefd9SBram Moolenaar // Set loop flag, so do_cmdline() will jump back to the matching
1440522eefd9SBram Moolenaar // ":while" or ":for".
14411280586eSBram Moolenaar cstack->cs_lflags |= CSL_HAD_ENDLOOP;
1442071d4279SBram Moolenaar }
1443071d4279SBram Moolenaar }
1444071d4279SBram Moolenaar
14459becdf2bSBram Moolenaar /*
14469becdf2bSBram Moolenaar * "{" start of a block in Vim9 script
14479becdf2bSBram Moolenaar */
14489becdf2bSBram Moolenaar void
ex_block(exarg_T * eap)14499becdf2bSBram Moolenaar ex_block(exarg_T *eap)
14509becdf2bSBram Moolenaar {
14519becdf2bSBram Moolenaar cstack_T *cstack = eap->cstack;
14529becdf2bSBram Moolenaar
14539becdf2bSBram Moolenaar if (cstack->cs_idx == CSTACK_LEN - 1)
14549becdf2bSBram Moolenaar eap->errmsg = _("E579: block nesting too deep");
14559becdf2bSBram Moolenaar else
14569becdf2bSBram Moolenaar {
14579becdf2bSBram Moolenaar enter_block(cstack);
14589becdf2bSBram Moolenaar cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE;
14599becdf2bSBram Moolenaar }
14609becdf2bSBram Moolenaar }
14619becdf2bSBram Moolenaar
14629becdf2bSBram Moolenaar /*
14639becdf2bSBram Moolenaar * "}" end of a block in Vim9 script
14649becdf2bSBram Moolenaar */
14659becdf2bSBram Moolenaar void
ex_endblock(exarg_T * eap)14669becdf2bSBram Moolenaar ex_endblock(exarg_T *eap)
14679becdf2bSBram Moolenaar {
14689becdf2bSBram Moolenaar cstack_T *cstack = eap->cstack;
14699becdf2bSBram Moolenaar
14709becdf2bSBram Moolenaar if (cstack->cs_idx < 0
14719becdf2bSBram Moolenaar || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0)
14729becdf2bSBram Moolenaar eap->errmsg = _(e_endblock_without_block);
14739becdf2bSBram Moolenaar else
14749becdf2bSBram Moolenaar leave_block(cstack);
14759becdf2bSBram Moolenaar }
1476071d4279SBram Moolenaar
147763b91736SBram Moolenaar int
inside_block(exarg_T * eap)147863b91736SBram Moolenaar inside_block(exarg_T *eap)
147963b91736SBram Moolenaar {
148063b91736SBram Moolenaar cstack_T *cstack = eap->cstack;
148163b91736SBram Moolenaar int i;
148263b91736SBram Moolenaar
148363b91736SBram Moolenaar for (i = 0; i <= cstack->cs_idx; ++i)
148463b91736SBram Moolenaar if (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK)
148563b91736SBram Moolenaar return TRUE;
148663b91736SBram Moolenaar return FALSE;
148763b91736SBram Moolenaar }
148863b91736SBram Moolenaar
1489071d4279SBram Moolenaar /*
1490071d4279SBram Moolenaar * ":throw expr"
1491071d4279SBram Moolenaar */
1492071d4279SBram Moolenaar void
ex_throw(exarg_T * eap)149378c0b7d4SBram Moolenaar ex_throw(exarg_T *eap)
1494071d4279SBram Moolenaar {
1495071d4279SBram Moolenaar char_u *arg = eap->arg;
1496071d4279SBram Moolenaar char_u *value;
1497071d4279SBram Moolenaar
1498071d4279SBram Moolenaar if (*arg != NUL && *arg != '|' && *arg != '\n')
1499b171fb17SBram Moolenaar value = eval_to_string_skip(arg, eap, eap->skip);
1500071d4279SBram Moolenaar else
1501071d4279SBram Moolenaar {
1502f9e3e09fSBram Moolenaar emsg(_(e_argreq));
1503071d4279SBram Moolenaar value = NULL;
1504071d4279SBram Moolenaar }
1505071d4279SBram Moolenaar
1506217e1b83SBram Moolenaar // On error or when an exception is thrown during argument evaluation, do
1507217e1b83SBram Moolenaar // not throw.
1508071d4279SBram Moolenaar if (!eap->skip && value != NULL)
1509071d4279SBram Moolenaar {
1510071d4279SBram Moolenaar if (throw_exception(value, ET_USER, NULL) == FAIL)
1511071d4279SBram Moolenaar vim_free(value);
1512071d4279SBram Moolenaar else
1513071d4279SBram Moolenaar do_throw(eap->cstack);
1514071d4279SBram Moolenaar }
1515071d4279SBram Moolenaar }
1516071d4279SBram Moolenaar
1517071d4279SBram Moolenaar /*
1518269ec658SBram Moolenaar * Throw the current exception through the specified cstack. Common routine
1519269ec658SBram Moolenaar * for ":throw" (user exception) and error and interrupt exceptions. Also
1520269ec658SBram Moolenaar * used for rethrowing an uncaught exception.
1521071d4279SBram Moolenaar */
1522071d4279SBram Moolenaar void
do_throw(cstack_T * cstack)1523ddef1291SBram Moolenaar do_throw(cstack_T *cstack)
1524071d4279SBram Moolenaar {
1525071d4279SBram Moolenaar int idx;
1526071d4279SBram Moolenaar int inactivate_try = FALSE;
1527071d4279SBram Moolenaar
1528071d4279SBram Moolenaar /*
1529071d4279SBram Moolenaar * Cleanup and inactivate up to the next surrounding try conditional that
1530071d4279SBram Moolenaar * is not in its finally clause. Normally, do not inactivate the try
1531071d4279SBram Moolenaar * conditional itself, so that its ACTIVE flag can be tested below. But
1532071d4279SBram Moolenaar * if a previous error or interrupt has not been converted to an exception,
1533071d4279SBram Moolenaar * inactivate the try conditional, too, as if the conversion had been done,
1534269ec658SBram Moolenaar * and reset the did_emsg or got_int flag, so this won't happen again at
1535269ec658SBram Moolenaar * the next surrounding try conditional.
1536071d4279SBram Moolenaar */
1537af0167faSBram Moolenaar #ifndef THROW_ON_ERROR_TRUE
1538071d4279SBram Moolenaar if (did_emsg && !THROW_ON_ERROR)
1539071d4279SBram Moolenaar {
1540071d4279SBram Moolenaar inactivate_try = TRUE;
1541071d4279SBram Moolenaar did_emsg = FALSE;
1542071d4279SBram Moolenaar }
1543af0167faSBram Moolenaar #endif
1544af0167faSBram Moolenaar #ifndef THROW_ON_INTERRUPT_TRUE
1545071d4279SBram Moolenaar if (got_int && !THROW_ON_INTERRUPT)
1546071d4279SBram Moolenaar {
1547071d4279SBram Moolenaar inactivate_try = TRUE;
1548071d4279SBram Moolenaar got_int = FALSE;
1549071d4279SBram Moolenaar }
1550af0167faSBram Moolenaar #endif
1551071d4279SBram Moolenaar idx = cleanup_conditionals(cstack, 0, inactivate_try);
1552071d4279SBram Moolenaar if (idx >= 0)
1553071d4279SBram Moolenaar {
1554071d4279SBram Moolenaar /*
1555071d4279SBram Moolenaar * If this try conditional is active and we are before its first
1556269ec658SBram Moolenaar * ":catch", set THROWN so that the ":catch" commands will check
1557269ec658SBram Moolenaar * whether the exception matches. When the exception came from any of
1558269ec658SBram Moolenaar * the catch clauses, it will be made pending at the ":finally" (if
1559269ec658SBram Moolenaar * present) and rethrown at the ":endtry". This will also happen if
1560269ec658SBram Moolenaar * the try conditional is inactive. This is the case when we are
1561269ec658SBram Moolenaar * throwing an exception due to an error or interrupt on the way from
1562269ec658SBram Moolenaar * a preceding ":continue", ":break", ":return", ":finish", error or
1563269ec658SBram Moolenaar * interrupt (not converted to an exception) to the finally clause or
1564269ec658SBram Moolenaar * from a preceding throw of a user or error or interrupt exception to
1565269ec658SBram Moolenaar * the matching catch clause or the finally clause.
1566071d4279SBram Moolenaar */
1567071d4279SBram Moolenaar if (!(cstack->cs_flags[idx] & CSF_CAUGHT))
1568071d4279SBram Moolenaar {
1569071d4279SBram Moolenaar if (cstack->cs_flags[idx] & CSF_ACTIVE)
1570071d4279SBram Moolenaar cstack->cs_flags[idx] |= CSF_THROWN;
1571071d4279SBram Moolenaar else
1572217e1b83SBram Moolenaar // THROWN may have already been set for a catchable exception
1573217e1b83SBram Moolenaar // that has been discarded. Ensure it is reset for the new
1574217e1b83SBram Moolenaar // exception.
1575071d4279SBram Moolenaar cstack->cs_flags[idx] &= ~CSF_THROWN;
1576071d4279SBram Moolenaar }
1577071d4279SBram Moolenaar cstack->cs_flags[idx] &= ~CSF_ACTIVE;
1578071d4279SBram Moolenaar cstack->cs_exception[idx] = current_exception;
1579071d4279SBram Moolenaar }
1580071d4279SBram Moolenaar #if 0
1581217e1b83SBram Moolenaar // TODO: Add optimization below. Not yet done because of interface
1582217e1b83SBram Moolenaar // problems to eval.c and ex_cmds2.c. (Servatius)
1583071d4279SBram Moolenaar else
1584071d4279SBram Moolenaar {
1585071d4279SBram Moolenaar /*
1586071d4279SBram Moolenaar * There are no catch clauses to check or finally clauses to execute.
1587071d4279SBram Moolenaar * End the current script or function. The exception will be rethrown
1588071d4279SBram Moolenaar * in the caller.
1589071d4279SBram Moolenaar */
1590071d4279SBram Moolenaar if (getline_equal(eap->getline, eap->cookie, get_func_line))
1591071d4279SBram Moolenaar current_funccal->returned = TRUE;
1592071d4279SBram Moolenaar elseif (eap->get_func_line == getsourceline)
1593071d4279SBram Moolenaar ((struct source_cookie *)eap->cookie)->finished = TRUE;
1594071d4279SBram Moolenaar }
1595071d4279SBram Moolenaar #endif
1596071d4279SBram Moolenaar
1597071d4279SBram Moolenaar did_throw = TRUE;
1598071d4279SBram Moolenaar }
1599071d4279SBram Moolenaar
1600071d4279SBram Moolenaar /*
1601071d4279SBram Moolenaar * ":try"
1602071d4279SBram Moolenaar */
1603071d4279SBram Moolenaar void
ex_try(exarg_T * eap)160478c0b7d4SBram Moolenaar ex_try(exarg_T *eap)
1605071d4279SBram Moolenaar {
1606071d4279SBram Moolenaar int skip;
1607ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1608071d4279SBram Moolenaar
1609917c46abSBram Moolenaar if (cmdmod_error(FALSE))
1610fa984418SBram Moolenaar return;
1611fa984418SBram Moolenaar
1612071d4279SBram Moolenaar if (cstack->cs_idx == CSTACK_LEN - 1)
16138930caaaSBram Moolenaar eap->errmsg = _("E601: :try nesting too deep");
1614071d4279SBram Moolenaar else
1615071d4279SBram Moolenaar {
1616fcdc5d83SBram Moolenaar enter_block(cstack);
1617071d4279SBram Moolenaar ++cstack->cs_trylevel;
1618071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] = CSF_TRY;
1619071d4279SBram Moolenaar cstack->cs_pending[cstack->cs_idx] = CSTP_NONE;
1620071d4279SBram Moolenaar
1621071d4279SBram Moolenaar /*
1622071d4279SBram Moolenaar * Don't do something after an error, interrupt, or throw, or when there
1623071d4279SBram Moolenaar * is a surrounding conditional and it was not active.
1624071d4279SBram Moolenaar */
1625071d4279SBram Moolenaar skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0
1626071d4279SBram Moolenaar && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE));
1627071d4279SBram Moolenaar
1628071d4279SBram Moolenaar if (!skip)
1629071d4279SBram Moolenaar {
1630217e1b83SBram Moolenaar // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch"
1631217e1b83SBram Moolenaar // commands should check for a match if an exception is thrown and
1632217e1b83SBram Moolenaar // that the finally clause needs to be executed.
1633071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE;
1634071d4279SBram Moolenaar
1635071d4279SBram Moolenaar /*
1636071d4279SBram Moolenaar * ":silent!", even when used in a try conditional, disables
1637071d4279SBram Moolenaar * displaying of error messages and conversion of errors to
1638071d4279SBram Moolenaar * exceptions. When the silent commands again open a try
1639071d4279SBram Moolenaar * conditional, save "emsg_silent" and reset it so that errors are
1640071d4279SBram Moolenaar * again converted to exceptions. The value is restored when that
1641071d4279SBram Moolenaar * try conditional is left. If it is left normally, the commands
1642071d4279SBram Moolenaar * following the ":endtry" are again silent. If it is left by
1643071d4279SBram Moolenaar * a ":continue", ":break", ":return", or ":finish", the commands
1644071d4279SBram Moolenaar * executed next are again silent. If it is left due to an
1645071d4279SBram Moolenaar * aborting error, an interrupt, or an exception, restoring
1646071d4279SBram Moolenaar * "emsg_silent" does not matter since we are already in the
1647071d4279SBram Moolenaar * aborting state and/or the exception has already been thrown.
1648071d4279SBram Moolenaar * The effect is then just freeing the memory that was allocated
1649071d4279SBram Moolenaar * to save the value.
1650071d4279SBram Moolenaar */
1651071d4279SBram Moolenaar if (emsg_silent)
1652071d4279SBram Moolenaar {
1653071d4279SBram Moolenaar eslist_T *elem;
1654071d4279SBram Moolenaar
1655c799fe20SBram Moolenaar elem = ALLOC_ONE(struct eslist_elem);
1656071d4279SBram Moolenaar if (elem == NULL)
1657e29a27f6SBram Moolenaar emsg(_(e_out_of_memory));
1658071d4279SBram Moolenaar else
1659071d4279SBram Moolenaar {
1660071d4279SBram Moolenaar elem->saved_emsg_silent = emsg_silent;
1661071d4279SBram Moolenaar elem->next = cstack->cs_emsg_silent_list;
1662071d4279SBram Moolenaar cstack->cs_emsg_silent_list = elem;
1663071d4279SBram Moolenaar cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT;
1664071d4279SBram Moolenaar emsg_silent = 0;
1665071d4279SBram Moolenaar }
1666071d4279SBram Moolenaar }
1667071d4279SBram Moolenaar }
1668071d4279SBram Moolenaar
1669071d4279SBram Moolenaar }
1670071d4279SBram Moolenaar }
1671071d4279SBram Moolenaar
1672071d4279SBram Moolenaar /*
1673071d4279SBram Moolenaar * ":catch /{pattern}/" and ":catch"
1674071d4279SBram Moolenaar */
1675071d4279SBram Moolenaar void
ex_catch(exarg_T * eap)167678c0b7d4SBram Moolenaar ex_catch(exarg_T *eap)
1677071d4279SBram Moolenaar {
1678071d4279SBram Moolenaar int idx = 0;
1679071d4279SBram Moolenaar int give_up = FALSE;
1680071d4279SBram Moolenaar int skip = FALSE;
1681071d4279SBram Moolenaar int caught = FALSE;
1682071d4279SBram Moolenaar char_u *end;
1683071d4279SBram Moolenaar int save_char = 0;
1684071d4279SBram Moolenaar char_u *save_cpo;
1685071d4279SBram Moolenaar regmatch_T regmatch;
1686071d4279SBram Moolenaar int prev_got_int;
1687ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1688071d4279SBram Moolenaar char_u *pat;
1689071d4279SBram Moolenaar
1690917c46abSBram Moolenaar if (cmdmod_error(FALSE))
1691fa984418SBram Moolenaar return;
1692fa984418SBram Moolenaar
1693071d4279SBram Moolenaar if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
1694071d4279SBram Moolenaar {
16958930caaaSBram Moolenaar eap->errmsg = _(e_catch);
1696071d4279SBram Moolenaar give_up = TRUE;
1697071d4279SBram Moolenaar }
1698071d4279SBram Moolenaar else
1699071d4279SBram Moolenaar {
1700071d4279SBram Moolenaar if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1701071d4279SBram Moolenaar {
1702217e1b83SBram Moolenaar // Report what's missing if the matching ":try" is not in its
1703217e1b83SBram Moolenaar // finally clause.
17041280586eSBram Moolenaar eap->errmsg = get_end_emsg(cstack);
1705071d4279SBram Moolenaar skip = TRUE;
1706071d4279SBram Moolenaar }
1707071d4279SBram Moolenaar for (idx = cstack->cs_idx; idx > 0; --idx)
1708071d4279SBram Moolenaar if (cstack->cs_flags[idx] & CSF_TRY)
1709071d4279SBram Moolenaar break;
17104197828dSBram Moolenaar if (cstack->cs_flags[idx] & CSF_TRY)
17114197828dSBram Moolenaar cstack->cs_flags[idx] |= CSF_CATCH;
1712071d4279SBram Moolenaar if (cstack->cs_flags[idx] & CSF_FINALLY)
1713071d4279SBram Moolenaar {
1714217e1b83SBram Moolenaar // Give up for a ":catch" after ":finally" and ignore it.
1715217e1b83SBram Moolenaar // Just parse.
17168930caaaSBram Moolenaar eap->errmsg = _("E604: :catch after :finally");
1717071d4279SBram Moolenaar give_up = TRUE;
1718071d4279SBram Moolenaar }
1719de8866baSBram Moolenaar else
17201280586eSBram Moolenaar rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
17211280586eSBram Moolenaar &cstack->cs_looplevel);
1722071d4279SBram Moolenaar }
1723071d4279SBram Moolenaar
17242c5ed4e3SBram Moolenaar if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors
1725071d4279SBram Moolenaar {
1726071d4279SBram Moolenaar pat = (char_u *)".*";
1727071d4279SBram Moolenaar end = NULL;
1728071d4279SBram Moolenaar eap->nextcmd = find_nextcmd(eap->arg);
1729071d4279SBram Moolenaar }
1730071d4279SBram Moolenaar else
1731071d4279SBram Moolenaar {
1732071d4279SBram Moolenaar pat = eap->arg + 1;
17332c5ed4e3SBram Moolenaar end = skip_regexp_err(pat, *eap->arg, TRUE);
17342c5ed4e3SBram Moolenaar if (end == NULL)
17352c5ed4e3SBram Moolenaar give_up = TRUE;
1736071d4279SBram Moolenaar }
1737071d4279SBram Moolenaar
1738071d4279SBram Moolenaar if (!give_up)
1739071d4279SBram Moolenaar {
1740071d4279SBram Moolenaar /*
1741071d4279SBram Moolenaar * Don't do something when no exception has been thrown or when the
1742071d4279SBram Moolenaar * corresponding try block never got active (because of an inactive
1743071d4279SBram Moolenaar * surrounding conditional or after an error or interrupt or throw).
1744071d4279SBram Moolenaar */
1745071d4279SBram Moolenaar if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE))
1746071d4279SBram Moolenaar skip = TRUE;
1747071d4279SBram Moolenaar
1748071d4279SBram Moolenaar /*
1749071d4279SBram Moolenaar * Check for a match only if an exception is thrown but not caught by
1750071d4279SBram Moolenaar * a previous ":catch". An exception that has replaced a discarded
1751071d4279SBram Moolenaar * exception is not checked (THROWN is not set then).
1752071d4279SBram Moolenaar */
1753071d4279SBram Moolenaar if (!skip && (cstack->cs_flags[idx] & CSF_THROWN)
1754071d4279SBram Moolenaar && !(cstack->cs_flags[idx] & CSF_CAUGHT))
1755071d4279SBram Moolenaar {
17562c5ed4e3SBram Moolenaar if (end != NULL && *end != NUL
17572c5ed4e3SBram Moolenaar && !ends_excmd2(end, skipwhite(end + 1)))
1758071d4279SBram Moolenaar {
17592d06bfdeSBram Moolenaar semsg(_(e_trailing_arg), end);
1760071d4279SBram Moolenaar return;
1761071d4279SBram Moolenaar }
1762071d4279SBram Moolenaar
1763217e1b83SBram Moolenaar // When debugging or a breakpoint was encountered, display the
1764217e1b83SBram Moolenaar // debug prompt (if not already done) before checking for a match.
1765217e1b83SBram Moolenaar // This is a helpful hint for the user when the regular expression
1766217e1b83SBram Moolenaar // matching fails. Handle a ">quit" debug command as if an
1767217e1b83SBram Moolenaar // interrupt had occurred before the ":catch". That is, discard
1768217e1b83SBram Moolenaar // the original exception, replace it by an interrupt exception,
1769217e1b83SBram Moolenaar // and don't catch it in this try block.
1770071d4279SBram Moolenaar if (!dbg_check_skipped(eap) || !do_intthrow(cstack))
1771071d4279SBram Moolenaar {
1772217e1b83SBram Moolenaar // Terminate the pattern and avoid the 'l' flag in 'cpoptions'
1773217e1b83SBram Moolenaar // while compiling it.
1774071d4279SBram Moolenaar if (end != NULL)
1775071d4279SBram Moolenaar {
1776071d4279SBram Moolenaar save_char = *end;
1777071d4279SBram Moolenaar *end = NUL;
1778071d4279SBram Moolenaar }
1779071d4279SBram Moolenaar save_cpo = p_cpo;
1780e5a2dc87SBram Moolenaar p_cpo = empty_option;
1781217e1b83SBram Moolenaar // Disable error messages, it will make current_exception
1782217e1b83SBram Moolenaar // invalid.
1783768ce243SBram Moolenaar ++emsg_off;
1784150cc270SBram Moolenaar regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
1785768ce243SBram Moolenaar --emsg_off;
1786071d4279SBram Moolenaar regmatch.rm_ic = FALSE;
1787071d4279SBram Moolenaar if (end != NULL)
1788071d4279SBram Moolenaar *end = save_char;
1789071d4279SBram Moolenaar p_cpo = save_cpo;
1790071d4279SBram Moolenaar if (regmatch.regprog == NULL)
1791f9e3e09fSBram Moolenaar semsg(_(e_invarg2), pat);
1792071d4279SBram Moolenaar else
1793071d4279SBram Moolenaar {
1794071d4279SBram Moolenaar /*
1795071d4279SBram Moolenaar * Save the value of got_int and reset it. We don't want
1796071d4279SBram Moolenaar * a previous interruption cancel matching, only hitting
1797071d4279SBram Moolenaar * CTRL-C while matching should abort it.
1798071d4279SBram Moolenaar */
1799071d4279SBram Moolenaar prev_got_int = got_int;
1800071d4279SBram Moolenaar got_int = FALSE;
1801f9e3e09fSBram Moolenaar caught = vim_regexec_nl(®match,
1802f9e3e09fSBram Moolenaar (char_u *)current_exception->value, (colnr_T)0);
1803071d4279SBram Moolenaar got_int |= prev_got_int;
1804473de61bSBram Moolenaar vim_regfree(regmatch.regprog);
1805071d4279SBram Moolenaar }
1806071d4279SBram Moolenaar }
1807071d4279SBram Moolenaar }
1808071d4279SBram Moolenaar
1809071d4279SBram Moolenaar if (caught)
1810071d4279SBram Moolenaar {
1811217e1b83SBram Moolenaar // Make this ":catch" clause active and reset did_emsg, got_int,
1812217e1b83SBram Moolenaar // and did_throw. Put the exception on the caught stack.
1813071d4279SBram Moolenaar cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT;
1814071d4279SBram Moolenaar did_emsg = got_int = did_throw = FALSE;
1815071d4279SBram Moolenaar catch_exception((except_T *)cstack->cs_exception[idx]);
1816217e1b83SBram Moolenaar // It's mandatory that the current exception is stored in the cstack
1817217e1b83SBram Moolenaar // so that it can be discarded at the next ":catch", ":finally", or
1818217e1b83SBram Moolenaar // ":endtry" or when the catch clause is left by a ":continue",
1819217e1b83SBram Moolenaar // ":break", ":return", ":finish", error, interrupt, or another
1820217e1b83SBram Moolenaar // exception.
1821071d4279SBram Moolenaar if (cstack->cs_exception[cstack->cs_idx] != current_exception)
182295f09603SBram Moolenaar internal_error("ex_catch()");
1823071d4279SBram Moolenaar }
1824071d4279SBram Moolenaar else
1825071d4279SBram Moolenaar {
1826071d4279SBram Moolenaar /*
1827071d4279SBram Moolenaar * If there is a preceding catch clause and it caught the exception,
1828071d4279SBram Moolenaar * finish the exception now. This happens also after errors except
1829071d4279SBram Moolenaar * when this ":catch" was after the ":finally" or not within
1830071d4279SBram Moolenaar * a ":try". Make the try conditional inactive so that the
1831071d4279SBram Moolenaar * following catch clauses are skipped. On an error or interrupt
1832071d4279SBram Moolenaar * after the preceding try block or catch clause was left by
1833071d4279SBram Moolenaar * a ":continue", ":break", ":return", or ":finish", discard the
1834071d4279SBram Moolenaar * pending action.
1835071d4279SBram Moolenaar */
1836071d4279SBram Moolenaar cleanup_conditionals(cstack, CSF_TRY, TRUE);
1837071d4279SBram Moolenaar }
1838071d4279SBram Moolenaar }
1839071d4279SBram Moolenaar
1840071d4279SBram Moolenaar if (end != NULL)
1841071d4279SBram Moolenaar eap->nextcmd = find_nextcmd(end);
1842071d4279SBram Moolenaar }
1843071d4279SBram Moolenaar
1844071d4279SBram Moolenaar /*
1845071d4279SBram Moolenaar * ":finally"
1846071d4279SBram Moolenaar */
1847071d4279SBram Moolenaar void
ex_finally(exarg_T * eap)184878c0b7d4SBram Moolenaar ex_finally(exarg_T *eap)
1849071d4279SBram Moolenaar {
1850071d4279SBram Moolenaar int idx;
1851071d4279SBram Moolenaar int skip = FALSE;
1852071d4279SBram Moolenaar int pending = CSTP_NONE;
1853ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1854071d4279SBram Moolenaar
1855917c46abSBram Moolenaar if (cmdmod_error(FALSE))
1856fa984418SBram Moolenaar return;
1857fa984418SBram Moolenaar
1858071d4279SBram Moolenaar if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
18598930caaaSBram Moolenaar eap->errmsg = _(e_finally);
1860071d4279SBram Moolenaar else
1861071d4279SBram Moolenaar {
1862071d4279SBram Moolenaar if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
1863071d4279SBram Moolenaar {
18641280586eSBram Moolenaar eap->errmsg = get_end_emsg(cstack);
1865071d4279SBram Moolenaar for (idx = cstack->cs_idx - 1; idx > 0; --idx)
1866071d4279SBram Moolenaar if (cstack->cs_flags[idx] & CSF_TRY)
1867071d4279SBram Moolenaar break;
1868217e1b83SBram Moolenaar // Make this error pending, so that the commands in the following
1869217e1b83SBram Moolenaar // finally clause can be executed. This overrules also a pending
1870217e1b83SBram Moolenaar // ":continue", ":break", ":return", or ":finish".
1871071d4279SBram Moolenaar pending = CSTP_ERROR;
1872071d4279SBram Moolenaar }
1873071d4279SBram Moolenaar else
1874071d4279SBram Moolenaar idx = cstack->cs_idx;
1875071d4279SBram Moolenaar
1876071d4279SBram Moolenaar if (cstack->cs_flags[idx] & CSF_FINALLY)
1877071d4279SBram Moolenaar {
1878217e1b83SBram Moolenaar // Give up for a multiple ":finally" and ignore it.
18798930caaaSBram Moolenaar eap->errmsg = _(e_finally_dup);
1880071d4279SBram Moolenaar return;
1881071d4279SBram Moolenaar }
18821280586eSBram Moolenaar rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
18831280586eSBram Moolenaar &cstack->cs_looplevel);
1884071d4279SBram Moolenaar
1885071d4279SBram Moolenaar /*
1886071d4279SBram Moolenaar * Don't do something when the corresponding try block never got active
1887071d4279SBram Moolenaar * (because of an inactive surrounding conditional or after an error or
1888071d4279SBram Moolenaar * interrupt or throw) or for a ":finally" without ":try" or a multiple
1889071d4279SBram Moolenaar * ":finally". After every other error (did_emsg or the conditional
1890071d4279SBram Moolenaar * errors detected above) or after an interrupt (got_int) or an
1891071d4279SBram Moolenaar * exception (did_throw), the finally clause must be executed.
1892071d4279SBram Moolenaar */
1893071d4279SBram Moolenaar skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
1894071d4279SBram Moolenaar
1895071d4279SBram Moolenaar if (!skip)
1896071d4279SBram Moolenaar {
1897217e1b83SBram Moolenaar // When debugging or a breakpoint was encountered, display the
1898217e1b83SBram Moolenaar // debug prompt (if not already done). The user then knows that the
1899217e1b83SBram Moolenaar // finally clause is executed.
1900071d4279SBram Moolenaar if (dbg_check_skipped(eap))
1901071d4279SBram Moolenaar {
1902217e1b83SBram Moolenaar // Handle a ">quit" debug command as if an interrupt had
1903217e1b83SBram Moolenaar // occurred before the ":finally". That is, discard the
1904217e1b83SBram Moolenaar // original exception and replace it by an interrupt
1905217e1b83SBram Moolenaar // exception.
1906071d4279SBram Moolenaar (void)do_intthrow(cstack);
1907071d4279SBram Moolenaar }
1908071d4279SBram Moolenaar
1909071d4279SBram Moolenaar /*
1910071d4279SBram Moolenaar * If there is a preceding catch clause and it caught the exception,
1911071d4279SBram Moolenaar * finish the exception now. This happens also after errors except
1912071d4279SBram Moolenaar * when this is a multiple ":finally" or one not within a ":try".
1913071d4279SBram Moolenaar * After an error or interrupt, this also discards a pending
1914071d4279SBram Moolenaar * ":continue", ":break", ":finish", or ":return" from the preceding
1915071d4279SBram Moolenaar * try block or catch clause.
1916071d4279SBram Moolenaar */
1917071d4279SBram Moolenaar cleanup_conditionals(cstack, CSF_TRY, FALSE);
1918071d4279SBram Moolenaar
1919071d4279SBram Moolenaar /*
1920071d4279SBram Moolenaar * Make did_emsg, got_int, did_throw pending. If set, they overrule
1921071d4279SBram Moolenaar * a pending ":continue", ":break", ":return", or ":finish". Then
1922071d4279SBram Moolenaar * we have particularly to discard a pending return value (as done
1923071d4279SBram Moolenaar * by the call to cleanup_conditionals() above when did_emsg or
1924071d4279SBram Moolenaar * got_int is set). The pending values are restored by the
1925071d4279SBram Moolenaar * ":endtry", except if there is a new error, interrupt, exception,
1926071d4279SBram Moolenaar * ":continue", ":break", ":return", or ":finish" in the following
19271280586eSBram Moolenaar * finally clause. A missing ":endwhile", ":endfor" or ":endif"
19281280586eSBram Moolenaar * detected here is treated as if did_emsg and did_throw had
19291280586eSBram Moolenaar * already been set, respectively in case that the error is not
19301280586eSBram Moolenaar * converted to an exception, did_throw had already been unset.
19311280586eSBram Moolenaar * We must not set did_emsg here since that would suppress the
19321280586eSBram Moolenaar * error message.
1933071d4279SBram Moolenaar */
1934071d4279SBram Moolenaar if (pending == CSTP_ERROR || did_emsg || got_int || did_throw)
1935071d4279SBram Moolenaar {
1936071d4279SBram Moolenaar if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN)
1937071d4279SBram Moolenaar {
1938071d4279SBram Moolenaar report_discard_pending(CSTP_RETURN,
1939fca34d6dSBram Moolenaar cstack->cs_rettv[cstack->cs_idx]);
1940fca34d6dSBram Moolenaar discard_pending_return(cstack->cs_rettv[cstack->cs_idx]);
1941071d4279SBram Moolenaar }
1942071d4279SBram Moolenaar if (pending == CSTP_ERROR && !did_emsg)
1943071d4279SBram Moolenaar pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0;
1944071d4279SBram Moolenaar else
1945071d4279SBram Moolenaar pending |= did_throw ? CSTP_THROW : 0;
1946071d4279SBram Moolenaar pending |= did_emsg ? CSTP_ERROR : 0;
1947071d4279SBram Moolenaar pending |= got_int ? CSTP_INTERRUPT : 0;
1948071d4279SBram Moolenaar cstack->cs_pending[cstack->cs_idx] = pending;
1949071d4279SBram Moolenaar
1950217e1b83SBram Moolenaar // It's mandatory that the current exception is stored in the
1951217e1b83SBram Moolenaar // cstack so that it can be rethrown at the ":endtry" or be
1952217e1b83SBram Moolenaar // discarded if the finally clause is left by a ":continue",
1953217e1b83SBram Moolenaar // ":break", ":return", ":finish", error, interrupt, or another
1954217e1b83SBram Moolenaar // exception. When emsg() is called for a missing ":endif" or
1955217e1b83SBram Moolenaar // a missing ":endwhile"/":endfor" detected here, the
1956217e1b83SBram Moolenaar // exception will be discarded.
1957de8866baSBram Moolenaar if (did_throw && cstack->cs_exception[cstack->cs_idx]
1958de8866baSBram Moolenaar != current_exception)
195995f09603SBram Moolenaar internal_error("ex_finally()");
1960071d4279SBram Moolenaar }
1961071d4279SBram Moolenaar
1962071d4279SBram Moolenaar /*
19631280586eSBram Moolenaar * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg,
1964d4755bb0SBram Moolenaar * got_int, and did_throw and make the finally clause active.
1965d4755bb0SBram Moolenaar * This will happen after emsg() has been called for a missing
19661280586eSBram Moolenaar * ":endif" or a missing ":endwhile"/":endfor" detected here, so
19671280586eSBram Moolenaar * that the following finally clause will be executed even then.
1968071d4279SBram Moolenaar */
19691280586eSBram Moolenaar cstack->cs_lflags |= CSL_HAD_FINA;
1970071d4279SBram Moolenaar }
1971071d4279SBram Moolenaar }
1972071d4279SBram Moolenaar }
1973071d4279SBram Moolenaar
1974071d4279SBram Moolenaar /*
1975071d4279SBram Moolenaar * ":endtry"
1976071d4279SBram Moolenaar */
1977071d4279SBram Moolenaar void
ex_endtry(exarg_T * eap)197878c0b7d4SBram Moolenaar ex_endtry(exarg_T *eap)
1979071d4279SBram Moolenaar {
1980071d4279SBram Moolenaar int idx;
1981071d4279SBram Moolenaar int skip;
1982071d4279SBram Moolenaar int rethrow = FALSE;
1983071d4279SBram Moolenaar int pending = CSTP_NONE;
1984fca34d6dSBram Moolenaar void *rettv = NULL;
1985ddef1291SBram Moolenaar cstack_T *cstack = eap->cstack;
1986071d4279SBram Moolenaar
1987917c46abSBram Moolenaar if (cmdmod_error(FALSE))
1988fa984418SBram Moolenaar return;
1989fa984418SBram Moolenaar
1990071d4279SBram Moolenaar if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0)
19918930caaaSBram Moolenaar eap->errmsg = _(e_no_endtry);
1992071d4279SBram Moolenaar else
1993071d4279SBram Moolenaar {
1994071d4279SBram Moolenaar /*
1995071d4279SBram Moolenaar * Don't do something after an error, interrupt or throw in the try
1996071d4279SBram Moolenaar * block, catch clause, or finally clause preceding this ":endtry" or
1997071d4279SBram Moolenaar * when an error or interrupt occurred after a ":continue", ":break",
1998071d4279SBram Moolenaar * ":return", or ":finish" in a try block or catch clause preceding this
1999071d4279SBram Moolenaar * ":endtry" or when the try block never got active (because of an
2000071d4279SBram Moolenaar * inactive surrounding conditional or after an error or interrupt or
2001071d4279SBram Moolenaar * throw) or when there is a surrounding conditional and it has been
2002071d4279SBram Moolenaar * made inactive by a ":continue", ":break", ":return", or ":finish" in
2003071d4279SBram Moolenaar * the finally clause. The latter case need not be tested since then
2004071d4279SBram Moolenaar * anything pending has already been discarded. */
20054197828dSBram Moolenaar skip = did_emsg || got_int || did_throw
20064197828dSBram Moolenaar || !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE);
2007071d4279SBram Moolenaar
2008071d4279SBram Moolenaar if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
2009071d4279SBram Moolenaar {
20101280586eSBram Moolenaar eap->errmsg = get_end_emsg(cstack);
2011cce81e96SBram Moolenaar
2012217e1b83SBram Moolenaar // Find the matching ":try" and report what's missing.
2013071d4279SBram Moolenaar idx = cstack->cs_idx;
2014071d4279SBram Moolenaar do
2015071d4279SBram Moolenaar --idx;
2016071d4279SBram Moolenaar while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY));
20171280586eSBram Moolenaar rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR,
20181280586eSBram Moolenaar &cstack->cs_looplevel);
2019071d4279SBram Moolenaar skip = TRUE;
2020071d4279SBram Moolenaar
2021071d4279SBram Moolenaar /*
2022071d4279SBram Moolenaar * If an exception is being thrown, discard it to prevent it from
2023071d4279SBram Moolenaar * being rethrown at the end of this function. It would be
2024071d4279SBram Moolenaar * discarded by the error message, anyway. Resets did_throw.
2025071d4279SBram Moolenaar * This does not affect the script termination due to the error
2026071d4279SBram Moolenaar * since "trylevel" is decremented after emsg() has been called.
2027071d4279SBram Moolenaar */
2028071d4279SBram Moolenaar if (did_throw)
2029071d4279SBram Moolenaar discard_current_exception();
2030cce81e96SBram Moolenaar
2031cce81e96SBram Moolenaar // report eap->errmsg, also when there already was an error
2032cce81e96SBram Moolenaar did_emsg = FALSE;
2033071d4279SBram Moolenaar }
2034071d4279SBram Moolenaar else
2035071d4279SBram Moolenaar {
2036071d4279SBram Moolenaar idx = cstack->cs_idx;
2037071d4279SBram Moolenaar
203884934998Srbtnn // Check the flags only when not in a skipped block.
203984934998Srbtnn if (!skip && in_vim9script()
20404197828dSBram Moolenaar && (cstack->cs_flags[idx] & (CSF_CATCH|CSF_FINALLY)) == 0)
20414197828dSBram Moolenaar {
20424197828dSBram Moolenaar // try/endtry without any catch or finally: give an error and
20434197828dSBram Moolenaar // continue.
20444197828dSBram Moolenaar eap->errmsg = _(e_missing_catch_or_finally);
20454197828dSBram Moolenaar }
20464197828dSBram Moolenaar
2047071d4279SBram Moolenaar /*
2048071d4279SBram Moolenaar * If we stopped with the exception currently being thrown at this
2049071d4279SBram Moolenaar * try conditional since we didn't know that it doesn't have
2050071d4279SBram Moolenaar * a finally clause, we need to rethrow it after closing the try
2051071d4279SBram Moolenaar * conditional.
2052071d4279SBram Moolenaar */
2053071d4279SBram Moolenaar if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE)
2054071d4279SBram Moolenaar && !(cstack->cs_flags[idx] & CSF_FINALLY))
2055071d4279SBram Moolenaar rethrow = TRUE;
2056071d4279SBram Moolenaar }
2057071d4279SBram Moolenaar
2058217e1b83SBram Moolenaar // If there was no finally clause, show the user when debugging or
2059217e1b83SBram Moolenaar // a breakpoint was encountered that the end of the try conditional has
2060217e1b83SBram Moolenaar // been reached: display the debug prompt (if not already done). Do
2061217e1b83SBram Moolenaar // this on normal control flow or when an exception was thrown, but not
2062217e1b83SBram Moolenaar // on an interrupt or error not converted to an exception or when
2063217e1b83SBram Moolenaar // a ":break", ":continue", ":return", or ":finish" is pending. These
2064217e1b83SBram Moolenaar // actions are carried out immediately.
2065071d4279SBram Moolenaar if ((rethrow || (!skip
2066071d4279SBram Moolenaar && !(cstack->cs_flags[idx] & CSF_FINALLY)
2067071d4279SBram Moolenaar && !cstack->cs_pending[idx]))
2068071d4279SBram Moolenaar && dbg_check_skipped(eap))
2069071d4279SBram Moolenaar {
2070217e1b83SBram Moolenaar // Handle a ">quit" debug command as if an interrupt had occurred
2071217e1b83SBram Moolenaar // before the ":endtry". That is, throw an interrupt exception and
2072217e1b83SBram Moolenaar // set "skip" and "rethrow".
2073071d4279SBram Moolenaar if (got_int)
2074071d4279SBram Moolenaar {
2075071d4279SBram Moolenaar skip = TRUE;
2076071d4279SBram Moolenaar (void)do_intthrow(cstack);
2077217e1b83SBram Moolenaar // The do_intthrow() call may have reset did_throw or
2078217e1b83SBram Moolenaar // cstack->cs_pending[idx].
2079071d4279SBram Moolenaar rethrow = FALSE;
2080071d4279SBram Moolenaar if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY))
2081071d4279SBram Moolenaar rethrow = TRUE;
2082071d4279SBram Moolenaar }
2083071d4279SBram Moolenaar }
2084071d4279SBram Moolenaar
2085071d4279SBram Moolenaar /*
2086071d4279SBram Moolenaar * If a ":return" is pending, we need to resume it after closing the
2087071d4279SBram Moolenaar * try conditional; remember the return value. If there was a finally
2088071d4279SBram Moolenaar * clause making an exception pending, we need to rethrow it. Make it
2089071d4279SBram Moolenaar * the exception currently being thrown.
2090071d4279SBram Moolenaar */
2091071d4279SBram Moolenaar if (!skip)
2092071d4279SBram Moolenaar {
2093071d4279SBram Moolenaar pending = cstack->cs_pending[idx];
2094071d4279SBram Moolenaar cstack->cs_pending[idx] = CSTP_NONE;
2095071d4279SBram Moolenaar if (pending == CSTP_RETURN)
2096fca34d6dSBram Moolenaar rettv = cstack->cs_rettv[idx];
2097071d4279SBram Moolenaar else if (pending & CSTP_THROW)
2098071d4279SBram Moolenaar current_exception = cstack->cs_exception[idx];
2099071d4279SBram Moolenaar }
2100071d4279SBram Moolenaar
2101071d4279SBram Moolenaar /*
2102071d4279SBram Moolenaar * Discard anything pending on an error, interrupt, or throw in the
2103071d4279SBram Moolenaar * finally clause. If there was no ":finally", discard a pending
2104071d4279SBram Moolenaar * ":continue", ":break", ":return", or ":finish" if an error or
2105071d4279SBram Moolenaar * interrupt occurred afterwards, but before the ":endtry" was reached.
2106071d4279SBram Moolenaar * If an exception was caught by the last of the catch clauses and there
2107071d4279SBram Moolenaar * was no finally clause, finish the exception now. This happens also
2108071d4279SBram Moolenaar * after errors except when this ":endtry" is not within a ":try".
2109071d4279SBram Moolenaar * Restore "emsg_silent" if it has been reset by this try conditional.
2110071d4279SBram Moolenaar */
2111eb3593b3SBram Moolenaar (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE);
2112071d4279SBram Moolenaar
2113cce81e96SBram Moolenaar if (cstack->cs_idx >= 0
2114cce81e96SBram Moolenaar && (cstack->cs_flags[cstack->cs_idx] & CSF_TRY))
2115fcdc5d83SBram Moolenaar leave_block(cstack);
2116071d4279SBram Moolenaar --cstack->cs_trylevel;
2117071d4279SBram Moolenaar
2118071d4279SBram Moolenaar if (!skip)
2119071d4279SBram Moolenaar {
2120071d4279SBram Moolenaar report_resume_pending(pending,
2121fca34d6dSBram Moolenaar (pending == CSTP_RETURN) ? rettv :
2122071d4279SBram Moolenaar (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2123071d4279SBram Moolenaar switch (pending)
2124071d4279SBram Moolenaar {
2125071d4279SBram Moolenaar case CSTP_NONE:
2126071d4279SBram Moolenaar break;
2127071d4279SBram Moolenaar
2128217e1b83SBram Moolenaar // Reactivate a pending ":continue", ":break", ":return",
2129217e1b83SBram Moolenaar // ":finish" from the try block or a catch clause of this try
2130217e1b83SBram Moolenaar // conditional. This is skipped, if there was an error in an
2131217e1b83SBram Moolenaar // (unskipped) conditional command or an interrupt afterwards
2132217e1b83SBram Moolenaar // or if the finally clause is present and executed a new error,
2133217e1b83SBram Moolenaar // interrupt, throw, ":continue", ":break", ":return", or
2134217e1b83SBram Moolenaar // ":finish".
2135071d4279SBram Moolenaar case CSTP_CONTINUE:
2136071d4279SBram Moolenaar ex_continue(eap);
2137071d4279SBram Moolenaar break;
2138071d4279SBram Moolenaar case CSTP_BREAK:
2139071d4279SBram Moolenaar ex_break(eap);
2140071d4279SBram Moolenaar break;
2141071d4279SBram Moolenaar case CSTP_RETURN:
2142fca34d6dSBram Moolenaar do_return(eap, FALSE, FALSE, rettv);
2143071d4279SBram Moolenaar break;
2144071d4279SBram Moolenaar case CSTP_FINISH:
2145071d4279SBram Moolenaar do_finish(eap, FALSE);
2146071d4279SBram Moolenaar break;
2147071d4279SBram Moolenaar
2148217e1b83SBram Moolenaar // When the finally clause was entered due to an error,
2149217e1b83SBram Moolenaar // interrupt or throw (as opposed to a ":continue", ":break",
2150217e1b83SBram Moolenaar // ":return", or ":finish"), restore the pending values of
2151217e1b83SBram Moolenaar // did_emsg, got_int, and did_throw. This is skipped, if there
2152217e1b83SBram Moolenaar // was a new error, interrupt, throw, ":continue", ":break",
2153217e1b83SBram Moolenaar // ":return", or ":finish". in the finally clause.
2154071d4279SBram Moolenaar default:
2155071d4279SBram Moolenaar if (pending & CSTP_ERROR)
2156071d4279SBram Moolenaar did_emsg = TRUE;
2157071d4279SBram Moolenaar if (pending & CSTP_INTERRUPT)
2158071d4279SBram Moolenaar got_int = TRUE;
2159071d4279SBram Moolenaar if (pending & CSTP_THROW)
2160071d4279SBram Moolenaar rethrow = TRUE;
2161071d4279SBram Moolenaar break;
2162071d4279SBram Moolenaar }
2163071d4279SBram Moolenaar }
2164071d4279SBram Moolenaar
2165071d4279SBram Moolenaar if (rethrow)
2166217e1b83SBram Moolenaar // Rethrow the current exception (within this cstack).
2167071d4279SBram Moolenaar do_throw(cstack);
2168071d4279SBram Moolenaar }
2169071d4279SBram Moolenaar }
2170071d4279SBram Moolenaar
2171071d4279SBram Moolenaar /*
2172293ee4d4SBram Moolenaar * enter_cleanup() and leave_cleanup()
2173c0197e28SBram Moolenaar *
2174293ee4d4SBram Moolenaar * Functions to be called before/after invoking a sequence of autocommands for
2175293ee4d4SBram Moolenaar * cleanup for a failed command. (Failure means here that a call to emsg()
2176293ee4d4SBram Moolenaar * has been made, an interrupt occurred, or there is an uncaught exception
2177293ee4d4SBram Moolenaar * from a previous autocommand execution of the same command.)
2178293ee4d4SBram Moolenaar *
2179293ee4d4SBram Moolenaar * Call enter_cleanup() with a pointer to a cleanup_T and pass the same
2180293ee4d4SBram Moolenaar * pointer to leave_cleanup(). The cleanup_T structure stores the pending
2181293ee4d4SBram Moolenaar * error/interrupt/exception state.
2182293ee4d4SBram Moolenaar */
2183293ee4d4SBram Moolenaar
2184293ee4d4SBram Moolenaar /*
2185293ee4d4SBram Moolenaar * This function works a bit like ex_finally() except that there was not
2186293ee4d4SBram Moolenaar * actually an extra try block around the part that failed and an error or
2187293ee4d4SBram Moolenaar * interrupt has not (yet) been converted to an exception. This function
2188293ee4d4SBram Moolenaar * saves the error/interrupt/ exception state and prepares for the call to
2189293ee4d4SBram Moolenaar * do_cmdline() that is going to be made for the cleanup autocommand
2190293ee4d4SBram Moolenaar * execution.
2191c0197e28SBram Moolenaar */
2192c0197e28SBram Moolenaar void
enter_cleanup(cleanup_T * csp)219378c0b7d4SBram Moolenaar enter_cleanup(cleanup_T *csp)
2194c0197e28SBram Moolenaar {
2195c0197e28SBram Moolenaar int pending = CSTP_NONE;
2196c0197e28SBram Moolenaar
2197c0197e28SBram Moolenaar /*
2198c0197e28SBram Moolenaar * Postpone did_emsg, got_int, did_throw. The pending values will be
2199c0197e28SBram Moolenaar * restored by leave_cleanup() except if there was an aborting error,
2200c0197e28SBram Moolenaar * interrupt, or uncaught exception after this function ends.
2201c0197e28SBram Moolenaar */
2202c0197e28SBram Moolenaar if (did_emsg || got_int || did_throw || need_rethrow)
2203c0197e28SBram Moolenaar {
2204c0197e28SBram Moolenaar csp->pending = (did_emsg ? CSTP_ERROR : 0)
2205c0197e28SBram Moolenaar | (got_int ? CSTP_INTERRUPT : 0)
2206c0197e28SBram Moolenaar | (did_throw ? CSTP_THROW : 0)
2207c0197e28SBram Moolenaar | (need_rethrow ? CSTP_THROW : 0);
2208c0197e28SBram Moolenaar
2209217e1b83SBram Moolenaar // If we are currently throwing an exception (did_throw), save it as
2210217e1b83SBram Moolenaar // well. On an error not yet converted to an exception, update
2211217e1b83SBram Moolenaar // "force_abort" and reset "cause_abort" (as do_errthrow() would do).
2212217e1b83SBram Moolenaar // This is needed for the do_cmdline() call that is going to be made
2213217e1b83SBram Moolenaar // for autocommand execution. We need not save *msg_list because
2214217e1b83SBram Moolenaar // there is an extra instance for every call of do_cmdline(), anyway.
2215c0197e28SBram Moolenaar if (did_throw || need_rethrow)
2216cae24be4SBram Moolenaar {
2217c0197e28SBram Moolenaar csp->exception = current_exception;
2218cae24be4SBram Moolenaar current_exception = NULL;
2219cae24be4SBram Moolenaar }
2220c0197e28SBram Moolenaar else
2221c0197e28SBram Moolenaar {
2222c0197e28SBram Moolenaar csp->exception = NULL;
2223c0197e28SBram Moolenaar if (did_emsg)
2224c0197e28SBram Moolenaar {
2225c0197e28SBram Moolenaar force_abort |= cause_abort;
2226c0197e28SBram Moolenaar cause_abort = FALSE;
2227c0197e28SBram Moolenaar }
2228c0197e28SBram Moolenaar }
2229c0197e28SBram Moolenaar did_emsg = got_int = did_throw = need_rethrow = FALSE;
2230c0197e28SBram Moolenaar
2231217e1b83SBram Moolenaar // Report if required by the 'verbose' option or when debugging.
2232c0197e28SBram Moolenaar report_make_pending(pending, csp->exception);
2233c0197e28SBram Moolenaar }
2234c0197e28SBram Moolenaar else
2235c0197e28SBram Moolenaar {
2236c0197e28SBram Moolenaar csp->pending = CSTP_NONE;
2237c0197e28SBram Moolenaar csp->exception = NULL;
2238c0197e28SBram Moolenaar }
2239c0197e28SBram Moolenaar }
2240c0197e28SBram Moolenaar
2241c0197e28SBram Moolenaar /*
2242293ee4d4SBram Moolenaar * See comment above enter_cleanup() for how this function is used.
2243293ee4d4SBram Moolenaar *
2244293ee4d4SBram Moolenaar * This function is a bit like ex_endtry() except that there was not actually
2245293ee4d4SBram Moolenaar * an extra try block around the part that failed and an error or interrupt
2246293ee4d4SBram Moolenaar * had not (yet) been converted to an exception when the cleanup autocommand
2247293ee4d4SBram Moolenaar * sequence was invoked.
2248293ee4d4SBram Moolenaar *
2249293ee4d4SBram Moolenaar * This function has to be called with the address of the cleanup_T structure
2250293ee4d4SBram Moolenaar * filled by enter_cleanup() as an argument; it restores the error/interrupt/
2251293ee4d4SBram Moolenaar * exception state saved by that function - except there was an aborting
2252293ee4d4SBram Moolenaar * error, an interrupt or an uncaught exception during execution of the
2253293ee4d4SBram Moolenaar * cleanup autocommands. In the latter case, the saved error/interrupt/
2254293ee4d4SBram Moolenaar * exception state is discarded.
2255c0197e28SBram Moolenaar */
2256c0197e28SBram Moolenaar void
leave_cleanup(cleanup_T * csp)225778c0b7d4SBram Moolenaar leave_cleanup(cleanup_T *csp)
2258c0197e28SBram Moolenaar {
2259c0197e28SBram Moolenaar int pending = csp->pending;
2260c0197e28SBram Moolenaar
2261217e1b83SBram Moolenaar if (pending == CSTP_NONE) // nothing to do
2262c0197e28SBram Moolenaar return;
2263c0197e28SBram Moolenaar
2264217e1b83SBram Moolenaar // If there was an aborting error, an interrupt, or an uncaught exception
2265217e1b83SBram Moolenaar // after the corresponding call to enter_cleanup(), discard what has been
2266217e1b83SBram Moolenaar // made pending by it. Report this to the user if required by the
2267217e1b83SBram Moolenaar // 'verbose' option or when debugging.
2268c0197e28SBram Moolenaar if (aborting() || need_rethrow)
2269c0197e28SBram Moolenaar {
2270c0197e28SBram Moolenaar if (pending & CSTP_THROW)
2271217e1b83SBram Moolenaar // Cancel the pending exception (includes report).
2272c0197e28SBram Moolenaar discard_exception((except_T *)csp->exception, FALSE);
2273c0197e28SBram Moolenaar else
2274c0197e28SBram Moolenaar report_discard_pending(pending, NULL);
2275c0197e28SBram Moolenaar
2276217e1b83SBram Moolenaar // If an error was about to be converted to an exception when
2277217e1b83SBram Moolenaar // enter_cleanup() was called, free the message list.
22784632d298SBram Moolenaar if (msg_list != NULL)
22799fee7d47SBram Moolenaar free_global_msglist();
22804632d298SBram Moolenaar }
2281c0197e28SBram Moolenaar
2282c0197e28SBram Moolenaar /*
2283c0197e28SBram Moolenaar * If there was no new error, interrupt, or throw between the calls
2284c0197e28SBram Moolenaar * to enter_cleanup() and leave_cleanup(), restore the pending
2285c0197e28SBram Moolenaar * error/interrupt/exception state.
2286c0197e28SBram Moolenaar */
2287c0197e28SBram Moolenaar else
2288c0197e28SBram Moolenaar {
2289c0197e28SBram Moolenaar /*
2290c0197e28SBram Moolenaar * If there was an exception being thrown when enter_cleanup() was
2291c0197e28SBram Moolenaar * called, we need to rethrow it. Make it the exception currently
2292c0197e28SBram Moolenaar * being thrown.
2293c0197e28SBram Moolenaar */
2294c0197e28SBram Moolenaar if (pending & CSTP_THROW)
2295c0197e28SBram Moolenaar current_exception = csp->exception;
2296c0197e28SBram Moolenaar
2297c0197e28SBram Moolenaar /*
2298c0197e28SBram Moolenaar * If an error was about to be converted to an exception when
2299c0197e28SBram Moolenaar * enter_cleanup() was called, let "cause_abort" take the part of
2300c0197e28SBram Moolenaar * "force_abort" (as done by cause_errthrow()).
2301c0197e28SBram Moolenaar */
2302c0197e28SBram Moolenaar else if (pending & CSTP_ERROR)
2303c0197e28SBram Moolenaar {
2304c0197e28SBram Moolenaar cause_abort = force_abort;
2305c0197e28SBram Moolenaar force_abort = FALSE;
2306c0197e28SBram Moolenaar }
2307c0197e28SBram Moolenaar
2308c0197e28SBram Moolenaar /*
2309c0197e28SBram Moolenaar * Restore the pending values of did_emsg, got_int, and did_throw.
2310c0197e28SBram Moolenaar */
2311c0197e28SBram Moolenaar if (pending & CSTP_ERROR)
2312c0197e28SBram Moolenaar did_emsg = TRUE;
2313c0197e28SBram Moolenaar if (pending & CSTP_INTERRUPT)
2314c0197e28SBram Moolenaar got_int = TRUE;
2315c0197e28SBram Moolenaar if (pending & CSTP_THROW)
2316217e1b83SBram Moolenaar need_rethrow = TRUE; // did_throw will be set by do_one_cmd()
2317c0197e28SBram Moolenaar
2318217e1b83SBram Moolenaar // Report if required by the 'verbose' option or when debugging.
2319c0197e28SBram Moolenaar report_resume_pending(pending,
2320c0197e28SBram Moolenaar (pending & CSTP_THROW) ? (void *)current_exception : NULL);
2321c0197e28SBram Moolenaar }
2322c0197e28SBram Moolenaar }
2323c0197e28SBram Moolenaar
2324c0197e28SBram Moolenaar
2325c0197e28SBram Moolenaar /*
2326071d4279SBram Moolenaar * Make conditionals inactive and discard what's pending in finally clauses
2327071d4279SBram Moolenaar * until the conditional type searched for or a try conditional not in its
2328de8866baSBram Moolenaar * finally clause is reached. If this is in an active catch clause, finish
2329de8866baSBram Moolenaar * the caught exception.
2330de8866baSBram Moolenaar * Return the cstack index where the search stopped.
23311280586eSBram Moolenaar * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0,
23321280586eSBram Moolenaar * the latter meaning the innermost try conditional not in its finally clause.
23331280586eSBram Moolenaar * "inclusive" tells whether the conditional searched for should be made
233484a05accSBram Moolenaar * inactive itself (a try conditional not in its finally clause possibly find
23351280586eSBram Moolenaar * before is always made inactive). If "inclusive" is TRUE and
23361280586eSBram Moolenaar * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of
23371280586eSBram Moolenaar * "emsg_silent", if reset when the try conditional finally reached was
233884a05accSBram Moolenaar * entered, is restored (used by ex_endtry()). This is normally done only
23391280586eSBram Moolenaar * when such a try conditional is left.
2340071d4279SBram Moolenaar */
2341071d4279SBram Moolenaar int
cleanup_conditionals(cstack_T * cstack,int searched_cond,int inclusive)234278c0b7d4SBram Moolenaar cleanup_conditionals(
2343ddef1291SBram Moolenaar cstack_T *cstack,
234478c0b7d4SBram Moolenaar int searched_cond,
234578c0b7d4SBram Moolenaar int inclusive)
2346071d4279SBram Moolenaar {
2347071d4279SBram Moolenaar int idx;
2348071d4279SBram Moolenaar int stop = FALSE;
2349071d4279SBram Moolenaar
2350071d4279SBram Moolenaar for (idx = cstack->cs_idx; idx >= 0; --idx)
2351071d4279SBram Moolenaar {
2352071d4279SBram Moolenaar if (cstack->cs_flags[idx] & CSF_TRY)
2353071d4279SBram Moolenaar {
2354071d4279SBram Moolenaar /*
2355071d4279SBram Moolenaar * Discard anything pending in a finally clause and continue the
2356071d4279SBram Moolenaar * search. There may also be a pending ":continue", ":break",
2357071d4279SBram Moolenaar * ":return", or ":finish" before the finally clause. We must not
2358071d4279SBram Moolenaar * discard it, unless an error or interrupt occurred afterwards.
2359071d4279SBram Moolenaar */
2360f461c8e7SBram Moolenaar if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY))
2361071d4279SBram Moolenaar {
2362071d4279SBram Moolenaar switch (cstack->cs_pending[idx])
2363071d4279SBram Moolenaar {
2364071d4279SBram Moolenaar case CSTP_NONE:
2365071d4279SBram Moolenaar break;
2366071d4279SBram Moolenaar
2367071d4279SBram Moolenaar case CSTP_CONTINUE:
2368071d4279SBram Moolenaar case CSTP_BREAK:
2369071d4279SBram Moolenaar case CSTP_FINISH:
2370071d4279SBram Moolenaar report_discard_pending(cstack->cs_pending[idx], NULL);
2371071d4279SBram Moolenaar cstack->cs_pending[idx] = CSTP_NONE;
2372071d4279SBram Moolenaar break;
2373071d4279SBram Moolenaar
2374071d4279SBram Moolenaar case CSTP_RETURN:
2375071d4279SBram Moolenaar report_discard_pending(CSTP_RETURN,
2376fca34d6dSBram Moolenaar cstack->cs_rettv[idx]);
2377fca34d6dSBram Moolenaar discard_pending_return(cstack->cs_rettv[idx]);
2378071d4279SBram Moolenaar cstack->cs_pending[idx] = CSTP_NONE;
2379071d4279SBram Moolenaar break;
2380071d4279SBram Moolenaar
2381071d4279SBram Moolenaar default:
2382071d4279SBram Moolenaar if (cstack->cs_flags[idx] & CSF_FINALLY)
2383071d4279SBram Moolenaar {
2384a684a684SBram Moolenaar if ((cstack->cs_pending[idx] & CSTP_THROW)
2385a684a684SBram Moolenaar && cstack->cs_exception[idx] != NULL)
2386071d4279SBram Moolenaar {
2387217e1b83SBram Moolenaar // Cancel the pending exception. This is in the
2388217e1b83SBram Moolenaar // finally clause, so that the stack of the
2389217e1b83SBram Moolenaar // caught exceptions is not involved.
239013656f02SBram Moolenaar discard_exception(
239113656f02SBram Moolenaar (except_T *)cstack->cs_exception[idx],
2392071d4279SBram Moolenaar FALSE);
2393071d4279SBram Moolenaar }
2394071d4279SBram Moolenaar else
2395071d4279SBram Moolenaar report_discard_pending(cstack->cs_pending[idx],
2396071d4279SBram Moolenaar NULL);
2397071d4279SBram Moolenaar cstack->cs_pending[idx] = CSTP_NONE;
2398071d4279SBram Moolenaar }
2399071d4279SBram Moolenaar break;
2400071d4279SBram Moolenaar }
2401071d4279SBram Moolenaar }
2402071d4279SBram Moolenaar
2403071d4279SBram Moolenaar /*
2404071d4279SBram Moolenaar * Stop at a try conditional not in its finally clause. If this try
2405071d4279SBram Moolenaar * conditional is in an active catch clause, finish the caught
2406071d4279SBram Moolenaar * exception.
2407071d4279SBram Moolenaar */
2408071d4279SBram Moolenaar if (!(cstack->cs_flags[idx] & CSF_FINALLY))
2409071d4279SBram Moolenaar {
2410071d4279SBram Moolenaar if ((cstack->cs_flags[idx] & CSF_ACTIVE)
2411f67d3fb7SBram Moolenaar && (cstack->cs_flags[idx] & CSF_CAUGHT)
2412f67d3fb7SBram Moolenaar && !(cstack->cs_flags[idx] & CSF_FINISHED))
2413f67d3fb7SBram Moolenaar {
2414071d4279SBram Moolenaar finish_exception((except_T *)cstack->cs_exception[idx]);
2415f67d3fb7SBram Moolenaar cstack->cs_flags[idx] |= CSF_FINISHED;
2416f67d3fb7SBram Moolenaar }
2417217e1b83SBram Moolenaar // Stop at this try conditional - except the try block never
2418217e1b83SBram Moolenaar // got active (because of an inactive surrounding conditional
2419217e1b83SBram Moolenaar // or when the ":try" appeared after an error or interrupt or
2420217e1b83SBram Moolenaar // throw).
2421071d4279SBram Moolenaar if (cstack->cs_flags[idx] & CSF_TRUE)
2422071d4279SBram Moolenaar {
2423071d4279SBram Moolenaar if (searched_cond == 0 && !inclusive)
2424071d4279SBram Moolenaar break;
2425071d4279SBram Moolenaar stop = TRUE;
2426071d4279SBram Moolenaar }
2427071d4279SBram Moolenaar }
2428071d4279SBram Moolenaar }
2429071d4279SBram Moolenaar
2430217e1b83SBram Moolenaar // Stop on the searched conditional type (even when the surrounding
2431217e1b83SBram Moolenaar // conditional is not active or something has been made pending).
2432217e1b83SBram Moolenaar // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT,
2433217e1b83SBram Moolenaar // check first whether "emsg_silent" needs to be restored.
2434071d4279SBram Moolenaar if (cstack->cs_flags[idx] & searched_cond)
2435071d4279SBram Moolenaar {
2436071d4279SBram Moolenaar if (!inclusive)
2437071d4279SBram Moolenaar break;
2438071d4279SBram Moolenaar stop = TRUE;
2439071d4279SBram Moolenaar }
2440071d4279SBram Moolenaar cstack->cs_flags[idx] &= ~CSF_ACTIVE;
2441071d4279SBram Moolenaar if (stop && searched_cond != (CSF_TRY | CSF_SILENT))
2442071d4279SBram Moolenaar break;
2443071d4279SBram Moolenaar
2444071d4279SBram Moolenaar /*
2445ccc18222SBram Moolenaar * When leaving a try conditional that reset "emsg_silent" on its
2446ccc18222SBram Moolenaar * entry after saving the original value, restore that value here and
2447ccc18222SBram Moolenaar * free the memory used to store it.
2448071d4279SBram Moolenaar */
2449071d4279SBram Moolenaar if ((cstack->cs_flags[idx] & CSF_TRY)
2450071d4279SBram Moolenaar && (cstack->cs_flags[idx] & CSF_SILENT))
2451071d4279SBram Moolenaar {
2452071d4279SBram Moolenaar eslist_T *elem;
2453071d4279SBram Moolenaar
2454071d4279SBram Moolenaar elem = cstack->cs_emsg_silent_list;
2455071d4279SBram Moolenaar cstack->cs_emsg_silent_list = elem->next;
2456071d4279SBram Moolenaar emsg_silent = elem->saved_emsg_silent;
2457071d4279SBram Moolenaar vim_free(elem);
2458071d4279SBram Moolenaar cstack->cs_flags[idx] &= ~CSF_SILENT;
2459071d4279SBram Moolenaar }
2460071d4279SBram Moolenaar if (stop)
2461071d4279SBram Moolenaar break;
2462071d4279SBram Moolenaar }
2463071d4279SBram Moolenaar return idx;
2464071d4279SBram Moolenaar }
2465071d4279SBram Moolenaar
2466071d4279SBram Moolenaar /*
24671280586eSBram Moolenaar * Return an appropriate error message for a missing endwhile/endfor/endif.
24681280586eSBram Moolenaar */
2469f9e3e09fSBram Moolenaar static char *
get_end_emsg(cstack_T * cstack)2470ddef1291SBram Moolenaar get_end_emsg(cstack_T *cstack)
24711280586eSBram Moolenaar {
24721280586eSBram Moolenaar if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE)
24738930caaaSBram Moolenaar return _(e_endwhile);
24741280586eSBram Moolenaar if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
24758930caaaSBram Moolenaar return _(e_endfor);
24768930caaaSBram Moolenaar return _(e_endif);
24771280586eSBram Moolenaar }
24781280586eSBram Moolenaar
24791280586eSBram Moolenaar
24801280586eSBram Moolenaar /*
2481071d4279SBram Moolenaar * Rewind conditionals until index "idx" is reached. "cond_type" and
2482071d4279SBram Moolenaar * "cond_level" specify a conditional type and the address of a level variable
2483071d4279SBram Moolenaar * which is to be decremented with each skipped conditional of the specified
2484071d4279SBram Moolenaar * type.
2485de8866baSBram Moolenaar * Also free "for info" structures where needed.
2486071d4279SBram Moolenaar */
2487de8866baSBram Moolenaar void
rewind_conditionals(cstack_T * cstack,int idx,int cond_type,int * cond_level)248878c0b7d4SBram Moolenaar rewind_conditionals(
2489ddef1291SBram Moolenaar cstack_T *cstack,
249078c0b7d4SBram Moolenaar int idx,
249178c0b7d4SBram Moolenaar int cond_type,
249278c0b7d4SBram Moolenaar int *cond_level)
2493071d4279SBram Moolenaar {
2494071d4279SBram Moolenaar while (cstack->cs_idx > idx)
2495071d4279SBram Moolenaar {
2496071d4279SBram Moolenaar if (cstack->cs_flags[cstack->cs_idx] & cond_type)
2497071d4279SBram Moolenaar --*cond_level;
2498de8866baSBram Moolenaar if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR)
2499de8866baSBram Moolenaar free_for_info(cstack->cs_forinfo[cstack->cs_idx]);
2500fcdc5d83SBram Moolenaar leave_block(cstack);
2501071d4279SBram Moolenaar }
2502071d4279SBram Moolenaar }
2503071d4279SBram Moolenaar
2504071d4279SBram Moolenaar /*
2505071d4279SBram Moolenaar * ":endfunction" when not after a ":function"
2506071d4279SBram Moolenaar */
2507071d4279SBram Moolenaar void
ex_endfunction(exarg_T * eap)25086e949784SBram Moolenaar ex_endfunction(exarg_T *eap)
2509071d4279SBram Moolenaar {
25106e949784SBram Moolenaar if (eap->cmdidx == CMD_enddef)
25116e949784SBram Moolenaar emsg(_("E193: :enddef not inside a function"));
25126e949784SBram Moolenaar else
2513f9e3e09fSBram Moolenaar emsg(_("E193: :endfunction not inside a function"));
2514071d4279SBram Moolenaar }
2515071d4279SBram Moolenaar
2516071d4279SBram Moolenaar /*
25171280586eSBram Moolenaar * Return TRUE if the string "p" looks like a ":while" or ":for" command.
2518071d4279SBram Moolenaar */
2519071d4279SBram Moolenaar int
has_loop_cmd(char_u * p)252078c0b7d4SBram Moolenaar has_loop_cmd(char_u *p)
2521071d4279SBram Moolenaar {
2522ed53fb9aSBram Moolenaar int len;
2523ed53fb9aSBram Moolenaar
2524217e1b83SBram Moolenaar // skip modifiers, white space and ':'
2525ed53fb9aSBram Moolenaar for (;;)
2526ed53fb9aSBram Moolenaar {
2527ed53fb9aSBram Moolenaar while (*p == ' ' || *p == '\t' || *p == ':')
2528ed53fb9aSBram Moolenaar ++p;
2529ed53fb9aSBram Moolenaar len = modifier_len(p);
2530ed53fb9aSBram Moolenaar if (len == 0)
2531ed53fb9aSBram Moolenaar break;
2532ed53fb9aSBram Moolenaar p += len;
2533ed53fb9aSBram Moolenaar }
25341280586eSBram Moolenaar if ((p[0] == 'w' && p[1] == 'h')
25351280586eSBram Moolenaar || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r'))
2536071d4279SBram Moolenaar return TRUE;
2537071d4279SBram Moolenaar return FALSE;
2538071d4279SBram Moolenaar }
2539071d4279SBram Moolenaar
2540217e1b83SBram Moolenaar #endif // FEAT_EVAL
2541