1 /* vi:set ts=8 sts=4 sw=4 noet: 2 * 3 * VIM - Vi IMproved by Bram Moolenaar 4 * 5 * Do ":help uganda" in Vim to read copying and usage conditions. 6 * Do ":help credits" in Vim to see a list of people who contributed. 7 * See README.txt for an overview of the Vim source code. 8 */ 9 10 /* 11 * ex_eval.c: functions for Ex command line for the +eval feature. 12 */ 13 14 #include "vim.h" 15 16 #if defined(FEAT_EVAL) || defined(PROTO) 17 18 static char *get_end_emsg(cstack_T *cstack); 19 20 /* 21 * Exception handling terms: 22 * 23 * :try ":try" command \ 24 * ... try block | 25 * :catch RE ":catch" command | 26 * ... catch clause |- try conditional 27 * :finally ":finally" command | 28 * ... finally clause | 29 * :endtry ":endtry" command / 30 * 31 * The try conditional may have any number of catch clauses and at most one 32 * finally clause. A ":throw" command can be inside the try block, a catch 33 * clause, the finally clause, or in a function called or script sourced from 34 * there or even outside the try conditional. Try conditionals may be nested. 35 */ 36 37 /* 38 * Configuration whether an exception is thrown on error or interrupt. When 39 * the preprocessor macros below evaluate to FALSE, an error (did_emsg) or 40 * interrupt (got_int) under an active try conditional terminates the script 41 * after the non-active finally clauses of all active try conditionals have been 42 * executed. Otherwise, errors and/or interrupts are converted into catchable 43 * exceptions (did_throw additionally set), which terminate the script only if 44 * not caught. For user exceptions, only did_throw is set. (Note: got_int can 45 * be set asynchronously afterwards by a SIGINT, so did_throw && got_int is not 46 * a reliant test that the exception currently being thrown is an interrupt 47 * exception. Similarly, did_emsg can be set afterwards on an error in an 48 * (unskipped) conditional command inside an inactive conditional, so did_throw 49 * && did_emsg is not a reliant test that the exception currently being thrown 50 * is an error exception.) - The macros can be defined as expressions checking 51 * for a variable that is allowed to be changed during execution of a script. 52 */ 53 #if 0 54 // Expressions used for testing during the development phase. 55 # define THROW_ON_ERROR (!eval_to_number("$VIMNOERRTHROW")) 56 # define THROW_ON_INTERRUPT (!eval_to_number("$VIMNOINTTHROW")) 57 # define THROW_TEST 58 #else 59 // Values used for the Vim release. 60 # define THROW_ON_ERROR TRUE 61 # define THROW_ON_ERROR_TRUE 62 # define THROW_ON_INTERRUPT TRUE 63 # define THROW_ON_INTERRUPT_TRUE 64 #endif 65 66 /* 67 * When several errors appear in a row, setting "force_abort" is delayed until 68 * the failing command returned. "cause_abort" is set to TRUE meanwhile, in 69 * order to indicate that situation. This is useful when "force_abort" was set 70 * during execution of a function call from an expression: the aborting of the 71 * expression evaluation is done without producing any error messages, but all 72 * error messages on parsing errors during the expression evaluation are given 73 * (even if a try conditional is active). 74 */ 75 static int cause_abort = FALSE; 76 77 /* 78 * Return TRUE when immediately aborting on error, or when an interrupt 79 * occurred or an exception was thrown but not caught. Use for ":{range}call" 80 * to check whether an aborted function that does not handle a range itself 81 * should be called again for the next line in the range. Also used for 82 * cancelling expression evaluation after a function call caused an immediate 83 * abort. Note that the first emsg() call temporarily resets "force_abort" 84 * until the throw point for error messages has been reached. That is, during 85 * cancellation of an expression evaluation after an aborting function call or 86 * due to a parsing error, aborting() always returns the same value. 87 * "got_int" is also set by calling interrupt(). 88 */ 89 int 90 aborting(void) 91 { 92 return (did_emsg && force_abort) || got_int || did_throw; 93 } 94 95 /* 96 * The value of "force_abort" is temporarily reset by the first emsg() call 97 * during an expression evaluation, and "cause_abort" is used instead. It might 98 * be necessary to restore "force_abort" even before the throw point for the 99 * error message has been reached. update_force_abort() should be called then. 100 */ 101 void 102 update_force_abort(void) 103 { 104 if (cause_abort) 105 force_abort = TRUE; 106 } 107 108 /* 109 * Return TRUE if a command with a subcommand resulting in "retcode" should 110 * abort the script processing. Can be used to suppress an autocommand after 111 * execution of a failing subcommand as long as the error message has not been 112 * displayed and actually caused the abortion. 113 */ 114 int 115 should_abort(int retcode) 116 { 117 return ((retcode == FAIL && trylevel != 0 && !emsg_silent) || aborting()); 118 } 119 120 /* 121 * Return TRUE if a function with the "abort" flag should not be considered 122 * ended on an error. This means that parsing commands is continued in order 123 * to find finally clauses to be executed, and that some errors in skipped 124 * commands are still reported. 125 */ 126 int 127 aborted_in_try(void) 128 { 129 // This function is only called after an error. In this case, "force_abort" 130 // determines whether searching for finally clauses is necessary. 131 return force_abort; 132 } 133 134 /* 135 * cause_errthrow(): Cause a throw of an error exception if appropriate. 136 * Return TRUE if the error message should not be displayed by emsg(). 137 * Sets "ignore", if the emsg() call should be ignored completely. 138 * 139 * When several messages appear in the same command, the first is usually the 140 * most specific one and used as the exception value. The "severe" flag can be 141 * set to TRUE, if a later but severer message should be used instead. 142 */ 143 int 144 cause_errthrow( 145 char_u *mesg, 146 int severe, 147 int *ignore) 148 { 149 msglist_T *elem; 150 msglist_T **plist; 151 152 /* 153 * Do nothing when displaying the interrupt message or reporting an 154 * uncaught exception (which has already been discarded then) at the top 155 * level. Also when no exception can be thrown. The message will be 156 * displayed by emsg(). 157 */ 158 if (suppress_errthrow) 159 return FALSE; 160 161 /* 162 * If emsg() has not been called previously, temporarily reset 163 * "force_abort" until the throw point for error messages has been 164 * reached. This ensures that aborting() returns the same value for all 165 * errors that appear in the same command. This means particularly that 166 * for parsing errors during expression evaluation emsg() will be called 167 * multiply, even when the expression is evaluated from a finally clause 168 * that was activated due to an aborting error, interrupt, or exception. 169 */ 170 if (!did_emsg) 171 { 172 cause_abort = force_abort; 173 force_abort = FALSE; 174 } 175 176 /* 177 * If no try conditional is active and no exception is being thrown and 178 * there has not been an error in a try conditional or a throw so far, do 179 * nothing (for compatibility of non-EH scripts). The message will then 180 * be displayed by emsg(). When ":silent!" was used and we are not 181 * currently throwing an exception, do nothing. The message text will 182 * then be stored to v:errmsg by emsg() without displaying it. 183 */ 184 if (((trylevel == 0 && !cause_abort) || emsg_silent) && !did_throw) 185 return FALSE; 186 187 /* 188 * Ignore an interrupt message when inside a try conditional or when an 189 * exception is being thrown or when an error in a try conditional or 190 * throw has been detected previously. This is important in order that an 191 * interrupt exception is catchable by the innermost try conditional and 192 * not replaced by an interrupt message error exception. 193 */ 194 if (mesg == (char_u *)_(e_interr)) 195 { 196 *ignore = TRUE; 197 return TRUE; 198 } 199 200 /* 201 * Ensure that all commands in nested function calls and sourced files 202 * are aborted immediately. 203 */ 204 cause_abort = TRUE; 205 206 /* 207 * When an exception is being thrown, some commands (like conditionals) are 208 * not skipped. Errors in those commands may affect what of the subsequent 209 * commands are regarded part of catch and finally clauses. Catching the 210 * exception would then cause execution of commands not intended by the 211 * user, who wouldn't even get aware of the problem. Therefor, discard the 212 * exception currently being thrown to prevent it from being caught. Just 213 * execute finally clauses and terminate. 214 */ 215 if (did_throw) 216 { 217 // When discarding an interrupt exception, reset got_int to prevent the 218 // same interrupt being converted to an exception again and discarding 219 // the error exception we are about to throw here. 220 if (current_exception->type == ET_INTERRUPT) 221 got_int = FALSE; 222 discard_current_exception(); 223 } 224 225 #ifdef THROW_TEST 226 if (!THROW_ON_ERROR) 227 { 228 /* 229 * Print error message immediately without searching for a matching 230 * catch clause; just finally clauses are executed before the script 231 * is terminated. 232 */ 233 return FALSE; 234 } 235 else 236 #endif 237 { 238 /* 239 * Prepare the throw of an error exception, so that everything will 240 * be aborted (except for executing finally clauses), until the error 241 * exception is caught; if still uncaught at the top level, the error 242 * message will be displayed and the script processing terminated 243 * then. - This function has no access to the conditional stack. 244 * Thus, the actual throw is made after the failing command has 245 * returned. - Throw only the first of several errors in a row, except 246 * a severe error is following. 247 */ 248 if (msg_list != NULL) 249 { 250 plist = msg_list; 251 while (*plist != NULL) 252 plist = &(*plist)->next; 253 254 elem = ALLOC_CLEAR_ONE(msglist_T); 255 if (elem == NULL) 256 { 257 suppress_errthrow = TRUE; 258 emsg(_(e_outofmem)); 259 } 260 else 261 { 262 elem->msg = (char *)vim_strsave(mesg); 263 if (elem->msg == NULL) 264 { 265 vim_free(elem); 266 suppress_errthrow = TRUE; 267 emsg(_(e_outofmem)); 268 } 269 else 270 { 271 elem->next = NULL; 272 elem->throw_msg = NULL; 273 *plist = elem; 274 if (plist == msg_list || severe) 275 { 276 char *tmsg; 277 278 // Skip the extra "Vim " prefix for message "E458". 279 tmsg = elem->msg; 280 if (STRNCMP(tmsg, "Vim E", 5) == 0 281 && VIM_ISDIGIT(tmsg[5]) 282 && VIM_ISDIGIT(tmsg[6]) 283 && VIM_ISDIGIT(tmsg[7]) 284 && tmsg[8] == ':' 285 && tmsg[9] == ' ') 286 (*msg_list)->throw_msg = &tmsg[4]; 287 else 288 (*msg_list)->throw_msg = tmsg; 289 } 290 291 // Get the source name and lnum now, it may change before 292 // reaching do_errthrow(). 293 elem->sfile = estack_sfile(ESTACK_NONE); 294 elem->slnum = SOURCING_LNUM; 295 } 296 } 297 } 298 return TRUE; 299 } 300 } 301 302 /* 303 * Free a "msg_list" and the messages it contains. 304 */ 305 static void 306 free_msglist(msglist_T *l) 307 { 308 msglist_T *messages, *next; 309 310 messages = l; 311 while (messages != NULL) 312 { 313 next = messages->next; 314 vim_free(messages->msg); 315 vim_free(messages->sfile); 316 vim_free(messages); 317 messages = next; 318 } 319 } 320 321 /* 322 * Free global "*msg_list" and the messages it contains, then set "*msg_list" 323 * to NULL. 324 */ 325 void 326 free_global_msglist(void) 327 { 328 free_msglist(*msg_list); 329 *msg_list = NULL; 330 } 331 332 /* 333 * Throw the message specified in the call to cause_errthrow() above as an 334 * error exception. If cstack is NULL, postpone the throw until do_cmdline() 335 * has returned (see do_one_cmd()). 336 */ 337 void 338 do_errthrow(cstack_T *cstack, char_u *cmdname) 339 { 340 /* 341 * Ensure that all commands in nested function calls and sourced files 342 * are aborted immediately. 343 */ 344 if (cause_abort) 345 { 346 cause_abort = FALSE; 347 force_abort = TRUE; 348 } 349 350 // If no exception is to be thrown or the conversion should be done after 351 // returning to a previous invocation of do_one_cmd(), do nothing. 352 if (msg_list == NULL || *msg_list == NULL) 353 return; 354 355 if (throw_exception(*msg_list, ET_ERROR, cmdname) == FAIL) 356 free_msglist(*msg_list); 357 else 358 { 359 if (cstack != NULL) 360 do_throw(cstack); 361 else 362 need_rethrow = TRUE; 363 } 364 *msg_list = NULL; 365 } 366 367 /* 368 * do_intthrow(): Replace the current exception by an interrupt or interrupt 369 * exception if appropriate. Return TRUE if the current exception is discarded, 370 * FALSE otherwise. 371 */ 372 int 373 do_intthrow(cstack_T *cstack) 374 { 375 /* 376 * If no interrupt occurred or no try conditional is active and no exception 377 * is being thrown, do nothing (for compatibility of non-EH scripts). 378 */ 379 if (!got_int || (trylevel == 0 && !did_throw)) 380 return FALSE; 381 382 #ifdef THROW_TEST // avoid warning for condition always true 383 if (!THROW_ON_INTERRUPT) 384 { 385 /* 386 * The interrupt aborts everything except for executing finally clauses. 387 * Discard any user or error or interrupt exception currently being 388 * thrown. 389 */ 390 if (did_throw) 391 discard_current_exception(); 392 } 393 else 394 #endif 395 { 396 /* 397 * Throw an interrupt exception, so that everything will be aborted 398 * (except for executing finally clauses), until the interrupt exception 399 * is caught; if still uncaught at the top level, the script processing 400 * will be terminated then. - If an interrupt exception is already 401 * being thrown, do nothing. 402 * 403 */ 404 if (did_throw) 405 { 406 if (current_exception->type == ET_INTERRUPT) 407 return FALSE; 408 409 // An interrupt exception replaces any user or error exception. 410 discard_current_exception(); 411 } 412 if (throw_exception("Vim:Interrupt", ET_INTERRUPT, NULL) != FAIL) 413 do_throw(cstack); 414 } 415 416 return TRUE; 417 } 418 419 /* 420 * Get an exception message that is to be stored in current_exception->value. 421 */ 422 char * 423 get_exception_string( 424 void *value, 425 except_type_T type, 426 char_u *cmdname, 427 int *should_free) 428 { 429 char *ret; 430 char *mesg; 431 int cmdlen; 432 char *p, *val; 433 434 if (type == ET_ERROR) 435 { 436 *should_free = TRUE; 437 mesg = ((msglist_T *)value)->throw_msg; 438 if (cmdname != NULL && *cmdname != NUL) 439 { 440 cmdlen = (int)STRLEN(cmdname); 441 ret = (char *)vim_strnsave((char_u *)"Vim(", 442 4 + cmdlen + 2 + STRLEN(mesg)); 443 if (ret == NULL) 444 return ret; 445 STRCPY(&ret[4], cmdname); 446 STRCPY(&ret[4 + cmdlen], "):"); 447 val = ret + 4 + cmdlen + 2; 448 } 449 else 450 { 451 ret = (char *)vim_strnsave((char_u *)"Vim:", 4 + STRLEN(mesg)); 452 if (ret == NULL) 453 return ret; 454 val = ret + 4; 455 } 456 457 // msg_add_fname may have been used to prefix the message with a file 458 // name in quotes. In the exception value, put the file name in 459 // parentheses and move it to the end. 460 for (p = mesg; ; p++) 461 { 462 if (*p == NUL 463 || (*p == 'E' 464 && VIM_ISDIGIT(p[1]) 465 && (p[2] == ':' 466 || (VIM_ISDIGIT(p[2]) 467 && (p[3] == ':' 468 || (VIM_ISDIGIT(p[3]) 469 && p[4] == ':')))))) 470 { 471 if (*p == NUL || p == mesg) 472 STRCAT(val, mesg); // 'E123' missing or at beginning 473 else 474 { 475 // '"filename" E123: message text' 476 if (mesg[0] != '"' || p-2 < &mesg[1] || 477 p[-2] != '"' || p[-1] != ' ') 478 // "E123:" is part of the file name. 479 continue; 480 481 STRCAT(val, p); 482 p[-2] = NUL; 483 sprintf((char *)(val + STRLEN(p)), " (%s)", &mesg[1]); 484 p[-2] = '"'; 485 } 486 break; 487 } 488 } 489 } 490 else 491 { 492 *should_free = FALSE; 493 ret = value; 494 } 495 496 return ret; 497 } 498 499 500 /* 501 * Throw a new exception. Return FAIL when out of memory or it was tried to 502 * throw an illegal user exception. "value" is the exception string for a 503 * user or interrupt exception, or points to a message list in case of an 504 * error exception. 505 */ 506 int 507 throw_exception(void *value, except_type_T type, char_u *cmdname) 508 { 509 except_T *excp; 510 int should_free; 511 512 /* 513 * Disallow faking Interrupt or error exceptions as user exceptions. They 514 * would be treated differently from real interrupt or error exceptions 515 * when no active try block is found, see do_cmdline(). 516 */ 517 if (type == ET_USER) 518 { 519 if (STRNCMP((char_u *)value, "Vim", 3) == 0 520 && (((char_u *)value)[3] == NUL || ((char_u *)value)[3] == ':' 521 || ((char_u *)value)[3] == '(')) 522 { 523 emsg(_("E608: Cannot :throw exceptions with 'Vim' prefix")); 524 goto fail; 525 } 526 } 527 528 excp = ALLOC_ONE(except_T); 529 if (excp == NULL) 530 goto nomem; 531 532 if (type == ET_ERROR) 533 // Store the original message and prefix the exception value with 534 // "Vim:" or, if a command name is given, "Vim(cmdname):". 535 excp->messages = (msglist_T *)value; 536 537 excp->value = get_exception_string(value, type, cmdname, &should_free); 538 if (excp->value == NULL && should_free) 539 goto nomem; 540 541 excp->type = type; 542 if (type == ET_ERROR && ((msglist_T *)value)->sfile != NULL) 543 { 544 msglist_T *entry = (msglist_T *)value; 545 546 excp->throw_name = entry->sfile; 547 entry->sfile = NULL; 548 excp->throw_lnum = entry->slnum; 549 } 550 else 551 { 552 excp->throw_name = estack_sfile(ESTACK_NONE); 553 if (excp->throw_name == NULL) 554 excp->throw_name = vim_strsave((char_u *)""); 555 if (excp->throw_name == NULL) 556 { 557 if (should_free) 558 vim_free(excp->value); 559 goto nomem; 560 } 561 excp->throw_lnum = SOURCING_LNUM; 562 } 563 564 if (p_verbose >= 13 || debug_break_level > 0) 565 { 566 int save_msg_silent = msg_silent; 567 568 if (debug_break_level > 0) 569 msg_silent = FALSE; // display messages 570 else 571 verbose_enter(); 572 ++no_wait_return; 573 if (debug_break_level > 0 || *p_vfile == NUL) 574 msg_scroll = TRUE; // always scroll up, don't overwrite 575 576 smsg(_("Exception thrown: %s"), excp->value); 577 msg_puts("\n"); // don't overwrite this either 578 579 if (debug_break_level > 0 || *p_vfile == NUL) 580 cmdline_row = msg_row; 581 --no_wait_return; 582 if (debug_break_level > 0) 583 msg_silent = save_msg_silent; 584 else 585 verbose_leave(); 586 } 587 588 current_exception = excp; 589 return OK; 590 591 nomem: 592 vim_free(excp); 593 suppress_errthrow = TRUE; 594 emsg(_(e_outofmem)); 595 fail: 596 current_exception = NULL; 597 return FAIL; 598 } 599 600 /* 601 * Discard an exception. "was_finished" is set when the exception has been 602 * caught and the catch clause has been ended normally. 603 */ 604 static void 605 discard_exception(except_T *excp, int was_finished) 606 { 607 char_u *saved_IObuff; 608 609 if (current_exception == excp) 610 current_exception = NULL; 611 if (excp == NULL) 612 { 613 internal_error("discard_exception()"); 614 return; 615 } 616 617 if (p_verbose >= 13 || debug_break_level > 0) 618 { 619 int save_msg_silent = msg_silent; 620 621 saved_IObuff = vim_strsave(IObuff); 622 if (debug_break_level > 0) 623 msg_silent = FALSE; // display messages 624 else 625 verbose_enter(); 626 ++no_wait_return; 627 if (debug_break_level > 0 || *p_vfile == NUL) 628 msg_scroll = TRUE; // always scroll up, don't overwrite 629 smsg(was_finished 630 ? _("Exception finished: %s") 631 : _("Exception discarded: %s"), 632 excp->value); 633 msg_puts("\n"); // don't overwrite this either 634 if (debug_break_level > 0 || *p_vfile == NUL) 635 cmdline_row = msg_row; 636 --no_wait_return; 637 if (debug_break_level > 0) 638 msg_silent = save_msg_silent; 639 else 640 verbose_leave(); 641 STRCPY(IObuff, saved_IObuff); 642 vim_free(saved_IObuff); 643 } 644 if (excp->type != ET_INTERRUPT) 645 vim_free(excp->value); 646 if (excp->type == ET_ERROR) 647 free_msglist(excp->messages); 648 vim_free(excp->throw_name); 649 vim_free(excp); 650 } 651 652 /* 653 * Discard the exception currently being thrown. 654 */ 655 void 656 discard_current_exception(void) 657 { 658 if (current_exception != NULL) 659 discard_exception(current_exception, FALSE); 660 did_throw = FALSE; 661 need_rethrow = FALSE; 662 } 663 664 /* 665 * Put an exception on the caught stack. 666 */ 667 void 668 catch_exception(except_T *excp) 669 { 670 excp->caught = caught_stack; 671 caught_stack = excp; 672 set_vim_var_string(VV_EXCEPTION, (char_u *)excp->value, -1); 673 if (*excp->throw_name != NUL) 674 { 675 if (excp->throw_lnum != 0) 676 vim_snprintf((char *)IObuff, IOSIZE, _("%s, line %ld"), 677 excp->throw_name, (long)excp->throw_lnum); 678 else 679 vim_snprintf((char *)IObuff, IOSIZE, "%s", excp->throw_name); 680 set_vim_var_string(VV_THROWPOINT, IObuff, -1); 681 } 682 else 683 // throw_name not set on an exception from a command that was typed. 684 set_vim_var_string(VV_THROWPOINT, NULL, -1); 685 686 if (p_verbose >= 13 || debug_break_level > 0) 687 { 688 int save_msg_silent = msg_silent; 689 690 if (debug_break_level > 0) 691 msg_silent = FALSE; // display messages 692 else 693 verbose_enter(); 694 ++no_wait_return; 695 if (debug_break_level > 0 || *p_vfile == NUL) 696 msg_scroll = TRUE; // always scroll up, don't overwrite 697 698 smsg(_("Exception caught: %s"), excp->value); 699 msg_puts("\n"); // don't overwrite this either 700 701 if (debug_break_level > 0 || *p_vfile == NUL) 702 cmdline_row = msg_row; 703 --no_wait_return; 704 if (debug_break_level > 0) 705 msg_silent = save_msg_silent; 706 else 707 verbose_leave(); 708 } 709 } 710 711 /* 712 * Remove an exception from the caught stack. 713 */ 714 static void 715 finish_exception(except_T *excp) 716 { 717 if (excp != caught_stack) 718 internal_error("finish_exception()"); 719 caught_stack = caught_stack->caught; 720 if (caught_stack != NULL) 721 { 722 set_vim_var_string(VV_EXCEPTION, (char_u *)caught_stack->value, -1); 723 if (*caught_stack->throw_name != NUL) 724 { 725 if (caught_stack->throw_lnum != 0) 726 vim_snprintf((char *)IObuff, IOSIZE, 727 _("%s, line %ld"), caught_stack->throw_name, 728 (long)caught_stack->throw_lnum); 729 else 730 vim_snprintf((char *)IObuff, IOSIZE, "%s", 731 caught_stack->throw_name); 732 set_vim_var_string(VV_THROWPOINT, IObuff, -1); 733 } 734 else 735 // throw_name not set on an exception from a command that was 736 // typed. 737 set_vim_var_string(VV_THROWPOINT, NULL, -1); 738 } 739 else 740 { 741 set_vim_var_string(VV_EXCEPTION, NULL, -1); 742 set_vim_var_string(VV_THROWPOINT, NULL, -1); 743 } 744 745 // Discard the exception, but use the finish message for 'verbose'. 746 discard_exception(excp, TRUE); 747 } 748 749 /* 750 * Flags specifying the message displayed by report_pending. 751 */ 752 #define RP_MAKE 0 753 #define RP_RESUME 1 754 #define RP_DISCARD 2 755 756 /* 757 * Report information about something pending in a finally clause if required by 758 * the 'verbose' option or when debugging. "action" tells whether something is 759 * made pending or something pending is resumed or discarded. "pending" tells 760 * what is pending. "value" specifies the return value for a pending ":return" 761 * or the exception value for a pending exception. 762 */ 763 static void 764 report_pending(int action, int pending, void *value) 765 { 766 char *mesg; 767 char *s; 768 int save_msg_silent; 769 770 771 switch (action) 772 { 773 case RP_MAKE: 774 mesg = _("%s made pending"); 775 break; 776 case RP_RESUME: 777 mesg = _("%s resumed"); 778 break; 779 // case RP_DISCARD: 780 default: 781 mesg = _("%s discarded"); 782 break; 783 } 784 785 switch (pending) 786 { 787 case CSTP_NONE: 788 return; 789 790 case CSTP_CONTINUE: 791 s = ":continue"; 792 break; 793 case CSTP_BREAK: 794 s = ":break"; 795 break; 796 case CSTP_FINISH: 797 s = ":finish"; 798 break; 799 case CSTP_RETURN: 800 // ":return" command producing value, allocated 801 s = (char *)get_return_cmd(value); 802 break; 803 804 default: 805 if (pending & CSTP_THROW) 806 { 807 vim_snprintf((char *)IObuff, IOSIZE, mesg, _("Exception")); 808 mesg = (char *)vim_strnsave(IObuff, STRLEN(IObuff) + 4); 809 STRCAT(mesg, ": %s"); 810 s = (char *)((except_T *)value)->value; 811 } 812 else if ((pending & CSTP_ERROR) && (pending & CSTP_INTERRUPT)) 813 s = _("Error and interrupt"); 814 else if (pending & CSTP_ERROR) 815 s = _("Error"); 816 else // if (pending & CSTP_INTERRUPT) 817 s = _("Interrupt"); 818 } 819 820 save_msg_silent = msg_silent; 821 if (debug_break_level > 0) 822 msg_silent = FALSE; // display messages 823 ++no_wait_return; 824 msg_scroll = TRUE; // always scroll up, don't overwrite 825 smsg(mesg, s); 826 msg_puts("\n"); // don't overwrite this either 827 cmdline_row = msg_row; 828 --no_wait_return; 829 if (debug_break_level > 0) 830 msg_silent = save_msg_silent; 831 832 if (pending == CSTP_RETURN) 833 vim_free(s); 834 else if (pending & CSTP_THROW) 835 vim_free(mesg); 836 } 837 838 /* 839 * If something is made pending in a finally clause, report it if required by 840 * the 'verbose' option or when debugging. 841 */ 842 void 843 report_make_pending(int pending, void *value) 844 { 845 if (p_verbose >= 14 || debug_break_level > 0) 846 { 847 if (debug_break_level <= 0) 848 verbose_enter(); 849 report_pending(RP_MAKE, pending, value); 850 if (debug_break_level <= 0) 851 verbose_leave(); 852 } 853 } 854 855 /* 856 * If something pending in a finally clause is resumed at the ":endtry", report 857 * it if required by the 'verbose' option or when debugging. 858 */ 859 static void 860 report_resume_pending(int pending, void *value) 861 { 862 if (p_verbose >= 14 || debug_break_level > 0) 863 { 864 if (debug_break_level <= 0) 865 verbose_enter(); 866 report_pending(RP_RESUME, pending, value); 867 if (debug_break_level <= 0) 868 verbose_leave(); 869 } 870 } 871 872 /* 873 * If something pending in a finally clause is discarded, report it if required 874 * by the 'verbose' option or when debugging. 875 */ 876 static void 877 report_discard_pending(int pending, void *value) 878 { 879 if (p_verbose >= 14 || debug_break_level > 0) 880 { 881 if (debug_break_level <= 0) 882 verbose_enter(); 883 report_pending(RP_DISCARD, pending, value); 884 if (debug_break_level <= 0) 885 verbose_leave(); 886 } 887 } 888 889 890 /* 891 * ":eval". 892 */ 893 void 894 ex_eval(exarg_T *eap) 895 { 896 typval_T tv; 897 evalarg_T evalarg; 898 899 fill_evalarg_from_eap(&evalarg, eap, eap->skip); 900 901 if (eval0(eap->arg, &tv, eap, &evalarg) == OK) 902 clear_tv(&tv); 903 904 clear_evalarg(&evalarg, eap); 905 } 906 907 /* 908 * Start a new scope/block. Caller should have checked that cs_idx is not 909 * exceeding CSTACK_LEN. 910 */ 911 static void 912 enter_block(cstack_T *cstack) 913 { 914 ++cstack->cs_idx; 915 if (in_vim9script() && current_sctx.sc_sid > 0) 916 { 917 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid); 918 919 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len; 920 cstack->cs_block_id[cstack->cs_idx] = ++si->sn_last_block_id; 921 si->sn_current_block_id = si->sn_last_block_id; 922 } 923 else 924 { 925 // Just in case in_vim9script() does not return the same value when the 926 // block ends. 927 cstack->cs_script_var_len[cstack->cs_idx] = 0; 928 cstack->cs_block_id[cstack->cs_idx] = 0; 929 } 930 } 931 932 static void 933 leave_block(cstack_T *cstack) 934 { 935 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid)) 936 { 937 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid); 938 int i; 939 int func_defined = 940 cstack->cs_flags[cstack->cs_idx] & CSF_FUNC_DEF; 941 942 for (i = cstack->cs_script_var_len[cstack->cs_idx]; 943 i < si->sn_var_vals.ga_len; ++i) 944 { 945 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i; 946 947 // sv_name is set to NULL if it was already removed. This happens 948 // when it was defined in an inner block and no functions were 949 // defined there. 950 if (sv->sv_name != NULL) 951 // Remove a variable declared inside the block, if it still 952 // exists, from sn_vars and move the value into sn_all_vars 953 // if "func_defined" is non-zero. 954 hide_script_var(si, i, func_defined); 955 } 956 957 // TODO: is this needed? 958 cstack->cs_script_var_len[cstack->cs_idx] = si->sn_var_vals.ga_len; 959 960 if (cstack->cs_idx == 0) 961 si->sn_current_block_id = 0; 962 else 963 si->sn_current_block_id = cstack->cs_block_id[cstack->cs_idx - 1]; 964 } 965 --cstack->cs_idx; 966 } 967 968 /* 969 * ":if". 970 */ 971 void 972 ex_if(exarg_T *eap) 973 { 974 int error; 975 int skip; 976 int result; 977 cstack_T *cstack = eap->cstack; 978 979 if (cstack->cs_idx == CSTACK_LEN - 1) 980 eap->errmsg = _("E579: :if nesting too deep"); 981 else 982 { 983 enter_block(cstack); 984 cstack->cs_flags[cstack->cs_idx] = 0; 985 986 /* 987 * Don't do something after an error, interrupt, or throw, or when 988 * there is a surrounding conditional and it was not active. 989 */ 990 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0 991 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE)); 992 993 result = eval_to_bool(eap->arg, &error, eap, skip); 994 995 if (!skip && !error) 996 { 997 if (result) 998 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE; 999 } 1000 else 1001 // set TRUE, so this conditional will never get active 1002 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE; 1003 } 1004 } 1005 1006 /* 1007 * ":endif". 1008 */ 1009 void 1010 ex_endif(exarg_T *eap) 1011 { 1012 cstack_T *cstack = eap->cstack; 1013 1014 did_endif = TRUE; 1015 if (cstack->cs_idx < 0 1016 || (cstack->cs_flags[cstack->cs_idx] 1017 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK))) 1018 eap->errmsg = _(e_endif_without_if); 1019 else 1020 { 1021 /* 1022 * When debugging or a breakpoint was encountered, display the debug 1023 * prompt (if not already done). This shows the user that an ":endif" 1024 * is executed when the ":if" or a previous ":elseif" was not TRUE. 1025 * Handle a ">quit" debug command as if an interrupt had occurred before 1026 * the ":endif". That is, throw an interrupt exception if appropriate. 1027 * Doing this here prevents an exception for a parsing error being 1028 * discarded by throwing the interrupt exception later on. 1029 */ 1030 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE) 1031 && dbg_check_skipped(eap)) 1032 (void)do_intthrow(cstack); 1033 1034 leave_block(cstack); 1035 } 1036 } 1037 1038 /* 1039 * ":else" and ":elseif". 1040 */ 1041 void 1042 ex_else(exarg_T *eap) 1043 { 1044 int error; 1045 int skip; 1046 int result; 1047 cstack_T *cstack = eap->cstack; 1048 1049 /* 1050 * Don't do something after an error, interrupt, or throw, or when there is 1051 * a surrounding conditional and it was not active. 1052 */ 1053 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0 1054 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE)); 1055 1056 if (cstack->cs_idx < 0 1057 || (cstack->cs_flags[cstack->cs_idx] 1058 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK))) 1059 { 1060 if (eap->cmdidx == CMD_else) 1061 { 1062 eap->errmsg = _(e_else_without_if); 1063 return; 1064 } 1065 eap->errmsg = _(e_elseif_without_if); 1066 skip = TRUE; 1067 } 1068 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE) 1069 { 1070 if (eap->cmdidx == CMD_else) 1071 { 1072 eap->errmsg = _("E583: multiple :else"); 1073 return; 1074 } 1075 eap->errmsg = _("E584: :elseif after :else"); 1076 skip = TRUE; 1077 } 1078 1079 // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it 1080 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE) 1081 { 1082 if (eap->errmsg == NULL) 1083 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE; 1084 skip = TRUE; // don't evaluate an ":elseif" 1085 } 1086 else 1087 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE; 1088 1089 /* 1090 * When debugging or a breakpoint was encountered, display the debug prompt 1091 * (if not already done). This shows the user that an ":else" or ":elseif" 1092 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle 1093 * a ">quit" debug command as if an interrupt had occurred before the 1094 * ":else" or ":elseif". That is, set "skip" and throw an interrupt 1095 * exception if appropriate. Doing this here prevents that an exception 1096 * for a parsing errors is discarded when throwing the interrupt exception 1097 * later on. 1098 */ 1099 if (!skip && dbg_check_skipped(eap) && got_int) 1100 { 1101 (void)do_intthrow(cstack); 1102 skip = TRUE; 1103 } 1104 1105 if (eap->cmdidx == CMD_elseif) 1106 { 1107 result = eval_to_bool(eap->arg, &error, eap, skip); 1108 1109 // When throwing error exceptions, we want to throw always the first 1110 // of several errors in a row. This is what actually happens when 1111 // a conditional error was detected above and there is another failure 1112 // when parsing the expression. Since the skip flag is set in this 1113 // case, the parsing error will be ignored by emsg(). 1114 if (!skip && !error) 1115 { 1116 if (result) 1117 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE; 1118 else 1119 cstack->cs_flags[cstack->cs_idx] = 0; 1120 } 1121 else if (eap->errmsg == NULL) 1122 // set TRUE, so this conditional will never get active 1123 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE; 1124 } 1125 else 1126 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE; 1127 } 1128 1129 /* 1130 * Handle ":while" and ":for". 1131 */ 1132 void 1133 ex_while(exarg_T *eap) 1134 { 1135 int error; 1136 int skip; 1137 int result; 1138 cstack_T *cstack = eap->cstack; 1139 1140 if (cstack->cs_idx == CSTACK_LEN - 1) 1141 eap->errmsg = _("E585: :while/:for nesting too deep"); 1142 else 1143 { 1144 /* 1145 * The loop flag is set when we have jumped back from the matching 1146 * ":endwhile" or ":endfor". When not set, need to initialise this 1147 * cstack entry. 1148 */ 1149 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0) 1150 { 1151 enter_block(cstack); 1152 ++cstack->cs_looplevel; 1153 cstack->cs_line[cstack->cs_idx] = -1; 1154 } 1155 cstack->cs_flags[cstack->cs_idx] = 1156 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR; 1157 1158 /* 1159 * Don't do something after an error, interrupt, or throw, or when 1160 * there is a surrounding conditional and it was not active. 1161 */ 1162 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0 1163 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE)); 1164 if (eap->cmdidx == CMD_while) 1165 { 1166 /* 1167 * ":while bool-expr" 1168 */ 1169 result = eval_to_bool(eap->arg, &error, eap, skip); 1170 } 1171 else 1172 { 1173 void *fi; 1174 evalarg_T evalarg; 1175 1176 CLEAR_FIELD(evalarg); 1177 evalarg.eval_flags = skip ? 0 : EVAL_EVALUATE; 1178 if (getline_equal(eap->getline, eap->cookie, getsourceline)) 1179 { 1180 evalarg.eval_getline = eap->getline; 1181 evalarg.eval_cookie = eap->cookie; 1182 } 1183 1184 /* 1185 * ":for var in list-expr" 1186 */ 1187 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0) 1188 { 1189 // Jumping here from a ":continue" or ":endfor": use the 1190 // previously evaluated list. 1191 fi = cstack->cs_forinfo[cstack->cs_idx]; 1192 error = FALSE; 1193 1194 // the "in expr" is not used, skip over it 1195 skip_for_lines(fi, &evalarg); 1196 } 1197 else 1198 { 1199 // Evaluate the argument and get the info in a structure. 1200 fi = eval_for_line(eap->arg, &error, eap, &evalarg); 1201 cstack->cs_forinfo[cstack->cs_idx] = fi; 1202 } 1203 1204 // use the element at the start of the list and advance 1205 if (!error && fi != NULL && !skip) 1206 result = next_for_item(fi, eap->arg); 1207 else 1208 result = FALSE; 1209 1210 if (!result) 1211 { 1212 free_for_info(fi); 1213 cstack->cs_forinfo[cstack->cs_idx] = NULL; 1214 } 1215 clear_evalarg(&evalarg, eap); 1216 } 1217 1218 /* 1219 * If this cstack entry was just initialised and is active, set the 1220 * loop flag, so do_cmdline() will set the line number in cs_line[]. 1221 * If executing the command a second time, clear the loop flag. 1222 */ 1223 if (!skip && !error && result) 1224 { 1225 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE); 1226 cstack->cs_lflags ^= CSL_HAD_LOOP; 1227 } 1228 else 1229 { 1230 cstack->cs_lflags &= ~CSL_HAD_LOOP; 1231 // If the ":while" evaluates to FALSE or ":for" is past the end of 1232 // the list, show the debug prompt at the ":endwhile"/":endfor" as 1233 // if there was a ":break" in a ":while"/":for" evaluating to 1234 // TRUE. 1235 if (!skip && !error) 1236 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE; 1237 } 1238 } 1239 } 1240 1241 /* 1242 * ":continue" 1243 */ 1244 void 1245 ex_continue(exarg_T *eap) 1246 { 1247 int idx; 1248 cstack_T *cstack = eap->cstack; 1249 1250 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0) 1251 eap->errmsg = _(e_continue); 1252 else 1253 { 1254 // Try to find the matching ":while". This might stop at a try 1255 // conditional not in its finally clause (which is then to be executed 1256 // next). Therefor, inactivate all conditionals except the ":while" 1257 // itself (if reached). 1258 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE); 1259 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR))) 1260 { 1261 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel); 1262 1263 /* 1264 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the 1265 * matching ":while". 1266 */ 1267 cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it 1268 } 1269 else 1270 { 1271 // If a try conditional not in its finally clause is reached first, 1272 // make the ":continue" pending for execution at the ":endtry". 1273 cstack->cs_pending[idx] = CSTP_CONTINUE; 1274 report_make_pending(CSTP_CONTINUE, NULL); 1275 } 1276 } 1277 } 1278 1279 /* 1280 * ":break" 1281 */ 1282 void 1283 ex_break(exarg_T *eap) 1284 { 1285 int idx; 1286 cstack_T *cstack = eap->cstack; 1287 1288 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0) 1289 eap->errmsg = _(e_break); 1290 else 1291 { 1292 // Inactivate conditionals until the matching ":while" or a try 1293 // conditional not in its finally clause (which is then to be 1294 // executed next) is found. In the latter case, make the ":break" 1295 // pending for execution at the ":endtry". 1296 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE); 1297 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR))) 1298 { 1299 cstack->cs_pending[idx] = CSTP_BREAK; 1300 report_make_pending(CSTP_BREAK, NULL); 1301 } 1302 } 1303 } 1304 1305 /* 1306 * ":endwhile" and ":endfor" 1307 */ 1308 void 1309 ex_endwhile(exarg_T *eap) 1310 { 1311 cstack_T *cstack = eap->cstack; 1312 int idx; 1313 char *err; 1314 int csf; 1315 int fl; 1316 1317 if (eap->cmdidx == CMD_endwhile) 1318 { 1319 err = e_while; 1320 csf = CSF_WHILE; 1321 } 1322 else 1323 { 1324 err = e_for; 1325 csf = CSF_FOR; 1326 } 1327 1328 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0) 1329 eap->errmsg = _(err); 1330 else 1331 { 1332 fl = cstack->cs_flags[cstack->cs_idx]; 1333 if (!(fl & csf)) 1334 { 1335 // If we are in a ":while" or ":for" but used the wrong endloop 1336 // command, do not rewind to the next enclosing ":for"/":while". 1337 if (fl & CSF_WHILE) 1338 eap->errmsg = _("E732: Using :endfor with :while"); 1339 else if (fl & CSF_FOR) 1340 eap->errmsg = _("E733: Using :endwhile with :for"); 1341 } 1342 if (!(fl & (CSF_WHILE | CSF_FOR))) 1343 { 1344 if (!(fl & CSF_TRY)) 1345 eap->errmsg = _(e_endif); 1346 else if (fl & CSF_FINALLY) 1347 eap->errmsg = _(e_endtry); 1348 // Try to find the matching ":while" and report what's missing. 1349 for (idx = cstack->cs_idx; idx > 0; --idx) 1350 { 1351 fl = cstack->cs_flags[idx]; 1352 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY)) 1353 { 1354 // Give up at a try conditional not in its finally clause. 1355 // Ignore the ":endwhile"/":endfor". 1356 eap->errmsg = _(err); 1357 return; 1358 } 1359 if (fl & csf) 1360 break; 1361 } 1362 // Cleanup and rewind all contained (and unclosed) conditionals. 1363 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE); 1364 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel); 1365 } 1366 1367 /* 1368 * When debugging or a breakpoint was encountered, display the debug 1369 * prompt (if not already done). This shows the user that an 1370 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or 1371 * after a ":break". Handle a ">quit" debug command as if an 1372 * interrupt had occurred before the ":endwhile"/":endfor". That is, 1373 * throw an interrupt exception if appropriate. Doing this here 1374 * prevents that an exception for a parsing error is discarded when 1375 * throwing the interrupt exception later on. 1376 */ 1377 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE 1378 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE) 1379 && dbg_check_skipped(eap)) 1380 (void)do_intthrow(cstack); 1381 1382 /* 1383 * Set loop flag, so do_cmdline() will jump back to the matching 1384 * ":while" or ":for". 1385 */ 1386 cstack->cs_lflags |= CSL_HAD_ENDLOOP; 1387 } 1388 } 1389 1390 /* 1391 * "{" start of a block in Vim9 script 1392 */ 1393 void 1394 ex_block(exarg_T *eap) 1395 { 1396 cstack_T *cstack = eap->cstack; 1397 1398 if (cstack->cs_idx == CSTACK_LEN - 1) 1399 eap->errmsg = _("E579: block nesting too deep"); 1400 else 1401 { 1402 enter_block(cstack); 1403 cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE; 1404 } 1405 } 1406 1407 /* 1408 * "}" end of a block in Vim9 script 1409 */ 1410 void 1411 ex_endblock(exarg_T *eap) 1412 { 1413 cstack_T *cstack = eap->cstack; 1414 1415 if (cstack->cs_idx < 0 1416 || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0) 1417 eap->errmsg = _(e_endblock_without_block); 1418 else 1419 leave_block(cstack); 1420 } 1421 1422 /* 1423 * ":throw expr" 1424 */ 1425 void 1426 ex_throw(exarg_T *eap) 1427 { 1428 char_u *arg = eap->arg; 1429 char_u *value; 1430 1431 if (*arg != NUL && *arg != '|' && *arg != '\n') 1432 value = eval_to_string_skip(arg, eap, eap->skip); 1433 else 1434 { 1435 emsg(_(e_argreq)); 1436 value = NULL; 1437 } 1438 1439 // On error or when an exception is thrown during argument evaluation, do 1440 // not throw. 1441 if (!eap->skip && value != NULL) 1442 { 1443 if (throw_exception(value, ET_USER, NULL) == FAIL) 1444 vim_free(value); 1445 else 1446 do_throw(eap->cstack); 1447 } 1448 } 1449 1450 /* 1451 * Throw the current exception through the specified cstack. Common routine 1452 * for ":throw" (user exception) and error and interrupt exceptions. Also 1453 * used for rethrowing an uncaught exception. 1454 */ 1455 void 1456 do_throw(cstack_T *cstack) 1457 { 1458 int idx; 1459 int inactivate_try = FALSE; 1460 1461 /* 1462 * Cleanup and inactivate up to the next surrounding try conditional that 1463 * is not in its finally clause. Normally, do not inactivate the try 1464 * conditional itself, so that its ACTIVE flag can be tested below. But 1465 * if a previous error or interrupt has not been converted to an exception, 1466 * inactivate the try conditional, too, as if the conversion had been done, 1467 * and reset the did_emsg or got_int flag, so this won't happen again at 1468 * the next surrounding try conditional. 1469 */ 1470 #ifndef THROW_ON_ERROR_TRUE 1471 if (did_emsg && !THROW_ON_ERROR) 1472 { 1473 inactivate_try = TRUE; 1474 did_emsg = FALSE; 1475 } 1476 #endif 1477 #ifndef THROW_ON_INTERRUPT_TRUE 1478 if (got_int && !THROW_ON_INTERRUPT) 1479 { 1480 inactivate_try = TRUE; 1481 got_int = FALSE; 1482 } 1483 #endif 1484 idx = cleanup_conditionals(cstack, 0, inactivate_try); 1485 if (idx >= 0) 1486 { 1487 /* 1488 * If this try conditional is active and we are before its first 1489 * ":catch", set THROWN so that the ":catch" commands will check 1490 * whether the exception matches. When the exception came from any of 1491 * the catch clauses, it will be made pending at the ":finally" (if 1492 * present) and rethrown at the ":endtry". This will also happen if 1493 * the try conditional is inactive. This is the case when we are 1494 * throwing an exception due to an error or interrupt on the way from 1495 * a preceding ":continue", ":break", ":return", ":finish", error or 1496 * interrupt (not converted to an exception) to the finally clause or 1497 * from a preceding throw of a user or error or interrupt exception to 1498 * the matching catch clause or the finally clause. 1499 */ 1500 if (!(cstack->cs_flags[idx] & CSF_CAUGHT)) 1501 { 1502 if (cstack->cs_flags[idx] & CSF_ACTIVE) 1503 cstack->cs_flags[idx] |= CSF_THROWN; 1504 else 1505 // THROWN may have already been set for a catchable exception 1506 // that has been discarded. Ensure it is reset for the new 1507 // exception. 1508 cstack->cs_flags[idx] &= ~CSF_THROWN; 1509 } 1510 cstack->cs_flags[idx] &= ~CSF_ACTIVE; 1511 cstack->cs_exception[idx] = current_exception; 1512 } 1513 #if 0 1514 // TODO: Add optimization below. Not yet done because of interface 1515 // problems to eval.c and ex_cmds2.c. (Servatius) 1516 else 1517 { 1518 /* 1519 * There are no catch clauses to check or finally clauses to execute. 1520 * End the current script or function. The exception will be rethrown 1521 * in the caller. 1522 */ 1523 if (getline_equal(eap->getline, eap->cookie, get_func_line)) 1524 current_funccal->returned = TRUE; 1525 elseif (eap->get_func_line == getsourceline) 1526 ((struct source_cookie *)eap->cookie)->finished = TRUE; 1527 } 1528 #endif 1529 1530 did_throw = TRUE; 1531 } 1532 1533 /* 1534 * ":try" 1535 */ 1536 void 1537 ex_try(exarg_T *eap) 1538 { 1539 int skip; 1540 cstack_T *cstack = eap->cstack; 1541 1542 if (cstack->cs_idx == CSTACK_LEN - 1) 1543 eap->errmsg = _("E601: :try nesting too deep"); 1544 else 1545 { 1546 enter_block(cstack); 1547 ++cstack->cs_trylevel; 1548 cstack->cs_flags[cstack->cs_idx] = CSF_TRY; 1549 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE; 1550 1551 /* 1552 * Don't do something after an error, interrupt, or throw, or when there 1553 * is a surrounding conditional and it was not active. 1554 */ 1555 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0 1556 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE)); 1557 1558 if (!skip) 1559 { 1560 // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch" 1561 // commands should check for a match if an exception is thrown and 1562 // that the finally clause needs to be executed. 1563 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE; 1564 1565 /* 1566 * ":silent!", even when used in a try conditional, disables 1567 * displaying of error messages and conversion of errors to 1568 * exceptions. When the silent commands again open a try 1569 * conditional, save "emsg_silent" and reset it so that errors are 1570 * again converted to exceptions. The value is restored when that 1571 * try conditional is left. If it is left normally, the commands 1572 * following the ":endtry" are again silent. If it is left by 1573 * a ":continue", ":break", ":return", or ":finish", the commands 1574 * executed next are again silent. If it is left due to an 1575 * aborting error, an interrupt, or an exception, restoring 1576 * "emsg_silent" does not matter since we are already in the 1577 * aborting state and/or the exception has already been thrown. 1578 * The effect is then just freeing the memory that was allocated 1579 * to save the value. 1580 */ 1581 if (emsg_silent) 1582 { 1583 eslist_T *elem; 1584 1585 elem = ALLOC_ONE(struct eslist_elem); 1586 if (elem == NULL) 1587 emsg(_(e_outofmem)); 1588 else 1589 { 1590 elem->saved_emsg_silent = emsg_silent; 1591 elem->next = cstack->cs_emsg_silent_list; 1592 cstack->cs_emsg_silent_list = elem; 1593 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT; 1594 emsg_silent = 0; 1595 } 1596 } 1597 } 1598 1599 } 1600 } 1601 1602 /* 1603 * ":catch /{pattern}/" and ":catch" 1604 */ 1605 void 1606 ex_catch(exarg_T *eap) 1607 { 1608 int idx = 0; 1609 int give_up = FALSE; 1610 int skip = FALSE; 1611 int caught = FALSE; 1612 char_u *end; 1613 int save_char = 0; 1614 char_u *save_cpo; 1615 regmatch_T regmatch; 1616 int prev_got_int; 1617 cstack_T *cstack = eap->cstack; 1618 char_u *pat; 1619 1620 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0) 1621 { 1622 eap->errmsg = _(e_catch); 1623 give_up = TRUE; 1624 } 1625 else 1626 { 1627 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY)) 1628 { 1629 // Report what's missing if the matching ":try" is not in its 1630 // finally clause. 1631 eap->errmsg = get_end_emsg(cstack); 1632 skip = TRUE; 1633 } 1634 for (idx = cstack->cs_idx; idx > 0; --idx) 1635 if (cstack->cs_flags[idx] & CSF_TRY) 1636 break; 1637 if (cstack->cs_flags[idx] & CSF_FINALLY) 1638 { 1639 // Give up for a ":catch" after ":finally" and ignore it. 1640 // Just parse. 1641 eap->errmsg = _("E604: :catch after :finally"); 1642 give_up = TRUE; 1643 } 1644 else 1645 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR, 1646 &cstack->cs_looplevel); 1647 } 1648 1649 if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors 1650 { 1651 pat = (char_u *)".*"; 1652 end = NULL; 1653 eap->nextcmd = find_nextcmd(eap->arg); 1654 } 1655 else 1656 { 1657 pat = eap->arg + 1; 1658 end = skip_regexp_err(pat, *eap->arg, TRUE); 1659 if (end == NULL) 1660 give_up = TRUE; 1661 } 1662 1663 if (!give_up) 1664 { 1665 /* 1666 * Don't do something when no exception has been thrown or when the 1667 * corresponding try block never got active (because of an inactive 1668 * surrounding conditional or after an error or interrupt or throw). 1669 */ 1670 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE)) 1671 skip = TRUE; 1672 1673 /* 1674 * Check for a match only if an exception is thrown but not caught by 1675 * a previous ":catch". An exception that has replaced a discarded 1676 * exception is not checked (THROWN is not set then). 1677 */ 1678 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN) 1679 && !(cstack->cs_flags[idx] & CSF_CAUGHT)) 1680 { 1681 if (end != NULL && *end != NUL 1682 && !ends_excmd2(end, skipwhite(end + 1))) 1683 { 1684 semsg(_(e_trailing_arg), end); 1685 return; 1686 } 1687 1688 // When debugging or a breakpoint was encountered, display the 1689 // debug prompt (if not already done) before checking for a match. 1690 // This is a helpful hint for the user when the regular expression 1691 // matching fails. Handle a ">quit" debug command as if an 1692 // interrupt had occurred before the ":catch". That is, discard 1693 // the original exception, replace it by an interrupt exception, 1694 // and don't catch it in this try block. 1695 if (!dbg_check_skipped(eap) || !do_intthrow(cstack)) 1696 { 1697 // Terminate the pattern and avoid the 'l' flag in 'cpoptions' 1698 // while compiling it. 1699 if (end != NULL) 1700 { 1701 save_char = *end; 1702 *end = NUL; 1703 } 1704 save_cpo = p_cpo; 1705 p_cpo = empty_option; 1706 // Disable error messages, it will make current_exception 1707 // invalid. 1708 ++emsg_off; 1709 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING); 1710 --emsg_off; 1711 regmatch.rm_ic = FALSE; 1712 if (end != NULL) 1713 *end = save_char; 1714 p_cpo = save_cpo; 1715 if (regmatch.regprog == NULL) 1716 semsg(_(e_invarg2), pat); 1717 else 1718 { 1719 /* 1720 * Save the value of got_int and reset it. We don't want 1721 * a previous interruption cancel matching, only hitting 1722 * CTRL-C while matching should abort it. 1723 */ 1724 prev_got_int = got_int; 1725 got_int = FALSE; 1726 caught = vim_regexec_nl(®match, 1727 (char_u *)current_exception->value, (colnr_T)0); 1728 got_int |= prev_got_int; 1729 vim_regfree(regmatch.regprog); 1730 } 1731 } 1732 } 1733 1734 if (caught) 1735 { 1736 // Make this ":catch" clause active and reset did_emsg, got_int, 1737 // and did_throw. Put the exception on the caught stack. 1738 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT; 1739 did_emsg = got_int = did_throw = FALSE; 1740 catch_exception((except_T *)cstack->cs_exception[idx]); 1741 // It's mandatory that the current exception is stored in the cstack 1742 // so that it can be discarded at the next ":catch", ":finally", or 1743 // ":endtry" or when the catch clause is left by a ":continue", 1744 // ":break", ":return", ":finish", error, interrupt, or another 1745 // exception. 1746 if (cstack->cs_exception[cstack->cs_idx] != current_exception) 1747 internal_error("ex_catch()"); 1748 } 1749 else 1750 { 1751 /* 1752 * If there is a preceding catch clause and it caught the exception, 1753 * finish the exception now. This happens also after errors except 1754 * when this ":catch" was after the ":finally" or not within 1755 * a ":try". Make the try conditional inactive so that the 1756 * following catch clauses are skipped. On an error or interrupt 1757 * after the preceding try block or catch clause was left by 1758 * a ":continue", ":break", ":return", or ":finish", discard the 1759 * pending action. 1760 */ 1761 cleanup_conditionals(cstack, CSF_TRY, TRUE); 1762 } 1763 } 1764 1765 if (end != NULL) 1766 eap->nextcmd = find_nextcmd(end); 1767 } 1768 1769 /* 1770 * ":finally" 1771 */ 1772 void 1773 ex_finally(exarg_T *eap) 1774 { 1775 int idx; 1776 int skip = FALSE; 1777 int pending = CSTP_NONE; 1778 cstack_T *cstack = eap->cstack; 1779 1780 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0) 1781 eap->errmsg = _(e_finally); 1782 else 1783 { 1784 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY)) 1785 { 1786 eap->errmsg = get_end_emsg(cstack); 1787 for (idx = cstack->cs_idx - 1; idx > 0; --idx) 1788 if (cstack->cs_flags[idx] & CSF_TRY) 1789 break; 1790 // Make this error pending, so that the commands in the following 1791 // finally clause can be executed. This overrules also a pending 1792 // ":continue", ":break", ":return", or ":finish". 1793 pending = CSTP_ERROR; 1794 } 1795 else 1796 idx = cstack->cs_idx; 1797 1798 if (cstack->cs_flags[idx] & CSF_FINALLY) 1799 { 1800 // Give up for a multiple ":finally" and ignore it. 1801 eap->errmsg = _(e_finally_dup); 1802 return; 1803 } 1804 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR, 1805 &cstack->cs_looplevel); 1806 1807 /* 1808 * Don't do something when the corresponding try block never got active 1809 * (because of an inactive surrounding conditional or after an error or 1810 * interrupt or throw) or for a ":finally" without ":try" or a multiple 1811 * ":finally". After every other error (did_emsg or the conditional 1812 * errors detected above) or after an interrupt (got_int) or an 1813 * exception (did_throw), the finally clause must be executed. 1814 */ 1815 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE); 1816 1817 if (!skip) 1818 { 1819 // When debugging or a breakpoint was encountered, display the 1820 // debug prompt (if not already done). The user then knows that the 1821 // finally clause is executed. 1822 if (dbg_check_skipped(eap)) 1823 { 1824 // Handle a ">quit" debug command as if an interrupt had 1825 // occurred before the ":finally". That is, discard the 1826 // original exception and replace it by an interrupt 1827 // exception. 1828 (void)do_intthrow(cstack); 1829 } 1830 1831 /* 1832 * If there is a preceding catch clause and it caught the exception, 1833 * finish the exception now. This happens also after errors except 1834 * when this is a multiple ":finally" or one not within a ":try". 1835 * After an error or interrupt, this also discards a pending 1836 * ":continue", ":break", ":finish", or ":return" from the preceding 1837 * try block or catch clause. 1838 */ 1839 cleanup_conditionals(cstack, CSF_TRY, FALSE); 1840 1841 /* 1842 * Make did_emsg, got_int, did_throw pending. If set, they overrule 1843 * a pending ":continue", ":break", ":return", or ":finish". Then 1844 * we have particularly to discard a pending return value (as done 1845 * by the call to cleanup_conditionals() above when did_emsg or 1846 * got_int is set). The pending values are restored by the 1847 * ":endtry", except if there is a new error, interrupt, exception, 1848 * ":continue", ":break", ":return", or ":finish" in the following 1849 * finally clause. A missing ":endwhile", ":endfor" or ":endif" 1850 * detected here is treated as if did_emsg and did_throw had 1851 * already been set, respectively in case that the error is not 1852 * converted to an exception, did_throw had already been unset. 1853 * We must not set did_emsg here since that would suppress the 1854 * error message. 1855 */ 1856 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw) 1857 { 1858 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN) 1859 { 1860 report_discard_pending(CSTP_RETURN, 1861 cstack->cs_rettv[cstack->cs_idx]); 1862 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]); 1863 } 1864 if (pending == CSTP_ERROR && !did_emsg) 1865 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0; 1866 else 1867 pending |= did_throw ? CSTP_THROW : 0; 1868 pending |= did_emsg ? CSTP_ERROR : 0; 1869 pending |= got_int ? CSTP_INTERRUPT : 0; 1870 cstack->cs_pending[cstack->cs_idx] = pending; 1871 1872 // It's mandatory that the current exception is stored in the 1873 // cstack so that it can be rethrown at the ":endtry" or be 1874 // discarded if the finally clause is left by a ":continue", 1875 // ":break", ":return", ":finish", error, interrupt, or another 1876 // exception. When emsg() is called for a missing ":endif" or 1877 // a missing ":endwhile"/":endfor" detected here, the 1878 // exception will be discarded. 1879 if (did_throw && cstack->cs_exception[cstack->cs_idx] 1880 != current_exception) 1881 internal_error("ex_finally()"); 1882 } 1883 1884 /* 1885 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg, 1886 * got_int, and did_throw and make the finally clause active. 1887 * This will happen after emsg() has been called for a missing 1888 * ":endif" or a missing ":endwhile"/":endfor" detected here, so 1889 * that the following finally clause will be executed even then. 1890 */ 1891 cstack->cs_lflags |= CSL_HAD_FINA; 1892 } 1893 } 1894 } 1895 1896 /* 1897 * ":endtry" 1898 */ 1899 void 1900 ex_endtry(exarg_T *eap) 1901 { 1902 int idx; 1903 int skip; 1904 int rethrow = FALSE; 1905 int pending = CSTP_NONE; 1906 void *rettv = NULL; 1907 cstack_T *cstack = eap->cstack; 1908 1909 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0) 1910 eap->errmsg = _(e_no_endtry); 1911 else 1912 { 1913 /* 1914 * Don't do something after an error, interrupt or throw in the try 1915 * block, catch clause, or finally clause preceding this ":endtry" or 1916 * when an error or interrupt occurred after a ":continue", ":break", 1917 * ":return", or ":finish" in a try block or catch clause preceding this 1918 * ":endtry" or when the try block never got active (because of an 1919 * inactive surrounding conditional or after an error or interrupt or 1920 * throw) or when there is a surrounding conditional and it has been 1921 * made inactive by a ":continue", ":break", ":return", or ":finish" in 1922 * the finally clause. The latter case need not be tested since then 1923 * anything pending has already been discarded. */ 1924 skip = did_emsg || got_int || did_throw || 1925 !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE); 1926 1927 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY)) 1928 { 1929 eap->errmsg = get_end_emsg(cstack); 1930 // Find the matching ":try" and report what's missing. 1931 idx = cstack->cs_idx; 1932 do 1933 --idx; 1934 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY)); 1935 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR, 1936 &cstack->cs_looplevel); 1937 skip = TRUE; 1938 1939 /* 1940 * If an exception is being thrown, discard it to prevent it from 1941 * being rethrown at the end of this function. It would be 1942 * discarded by the error message, anyway. Resets did_throw. 1943 * This does not affect the script termination due to the error 1944 * since "trylevel" is decremented after emsg() has been called. 1945 */ 1946 if (did_throw) 1947 discard_current_exception(); 1948 } 1949 else 1950 { 1951 idx = cstack->cs_idx; 1952 1953 /* 1954 * If we stopped with the exception currently being thrown at this 1955 * try conditional since we didn't know that it doesn't have 1956 * a finally clause, we need to rethrow it after closing the try 1957 * conditional. 1958 */ 1959 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE) 1960 && !(cstack->cs_flags[idx] & CSF_FINALLY)) 1961 rethrow = TRUE; 1962 } 1963 1964 // If there was no finally clause, show the user when debugging or 1965 // a breakpoint was encountered that the end of the try conditional has 1966 // been reached: display the debug prompt (if not already done). Do 1967 // this on normal control flow or when an exception was thrown, but not 1968 // on an interrupt or error not converted to an exception or when 1969 // a ":break", ":continue", ":return", or ":finish" is pending. These 1970 // actions are carried out immediately. 1971 if ((rethrow || (!skip 1972 && !(cstack->cs_flags[idx] & CSF_FINALLY) 1973 && !cstack->cs_pending[idx])) 1974 && dbg_check_skipped(eap)) 1975 { 1976 // Handle a ">quit" debug command as if an interrupt had occurred 1977 // before the ":endtry". That is, throw an interrupt exception and 1978 // set "skip" and "rethrow". 1979 if (got_int) 1980 { 1981 skip = TRUE; 1982 (void)do_intthrow(cstack); 1983 // The do_intthrow() call may have reset did_throw or 1984 // cstack->cs_pending[idx]. 1985 rethrow = FALSE; 1986 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY)) 1987 rethrow = TRUE; 1988 } 1989 } 1990 1991 /* 1992 * If a ":return" is pending, we need to resume it after closing the 1993 * try conditional; remember the return value. If there was a finally 1994 * clause making an exception pending, we need to rethrow it. Make it 1995 * the exception currently being thrown. 1996 */ 1997 if (!skip) 1998 { 1999 pending = cstack->cs_pending[idx]; 2000 cstack->cs_pending[idx] = CSTP_NONE; 2001 if (pending == CSTP_RETURN) 2002 rettv = cstack->cs_rettv[idx]; 2003 else if (pending & CSTP_THROW) 2004 current_exception = cstack->cs_exception[idx]; 2005 } 2006 2007 /* 2008 * Discard anything pending on an error, interrupt, or throw in the 2009 * finally clause. If there was no ":finally", discard a pending 2010 * ":continue", ":break", ":return", or ":finish" if an error or 2011 * interrupt occurred afterwards, but before the ":endtry" was reached. 2012 * If an exception was caught by the last of the catch clauses and there 2013 * was no finally clause, finish the exception now. This happens also 2014 * after errors except when this ":endtry" is not within a ":try". 2015 * Restore "emsg_silent" if it has been reset by this try conditional. 2016 */ 2017 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE); 2018 2019 leave_block(cstack); 2020 --cstack->cs_trylevel; 2021 2022 if (!skip) 2023 { 2024 report_resume_pending(pending, 2025 (pending == CSTP_RETURN) ? rettv : 2026 (pending & CSTP_THROW) ? (void *)current_exception : NULL); 2027 switch (pending) 2028 { 2029 case CSTP_NONE: 2030 break; 2031 2032 // Reactivate a pending ":continue", ":break", ":return", 2033 // ":finish" from the try block or a catch clause of this try 2034 // conditional. This is skipped, if there was an error in an 2035 // (unskipped) conditional command or an interrupt afterwards 2036 // or if the finally clause is present and executed a new error, 2037 // interrupt, throw, ":continue", ":break", ":return", or 2038 // ":finish". 2039 case CSTP_CONTINUE: 2040 ex_continue(eap); 2041 break; 2042 case CSTP_BREAK: 2043 ex_break(eap); 2044 break; 2045 case CSTP_RETURN: 2046 do_return(eap, FALSE, FALSE, rettv); 2047 break; 2048 case CSTP_FINISH: 2049 do_finish(eap, FALSE); 2050 break; 2051 2052 // When the finally clause was entered due to an error, 2053 // interrupt or throw (as opposed to a ":continue", ":break", 2054 // ":return", or ":finish"), restore the pending values of 2055 // did_emsg, got_int, and did_throw. This is skipped, if there 2056 // was a new error, interrupt, throw, ":continue", ":break", 2057 // ":return", or ":finish". in the finally clause. 2058 default: 2059 if (pending & CSTP_ERROR) 2060 did_emsg = TRUE; 2061 if (pending & CSTP_INTERRUPT) 2062 got_int = TRUE; 2063 if (pending & CSTP_THROW) 2064 rethrow = TRUE; 2065 break; 2066 } 2067 } 2068 2069 if (rethrow) 2070 // Rethrow the current exception (within this cstack). 2071 do_throw(cstack); 2072 } 2073 } 2074 2075 /* 2076 * enter_cleanup() and leave_cleanup() 2077 * 2078 * Functions to be called before/after invoking a sequence of autocommands for 2079 * cleanup for a failed command. (Failure means here that a call to emsg() 2080 * has been made, an interrupt occurred, or there is an uncaught exception 2081 * from a previous autocommand execution of the same command.) 2082 * 2083 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same 2084 * pointer to leave_cleanup(). The cleanup_T structure stores the pending 2085 * error/interrupt/exception state. 2086 */ 2087 2088 /* 2089 * This function works a bit like ex_finally() except that there was not 2090 * actually an extra try block around the part that failed and an error or 2091 * interrupt has not (yet) been converted to an exception. This function 2092 * saves the error/interrupt/ exception state and prepares for the call to 2093 * do_cmdline() that is going to be made for the cleanup autocommand 2094 * execution. 2095 */ 2096 void 2097 enter_cleanup(cleanup_T *csp) 2098 { 2099 int pending = CSTP_NONE; 2100 2101 /* 2102 * Postpone did_emsg, got_int, did_throw. The pending values will be 2103 * restored by leave_cleanup() except if there was an aborting error, 2104 * interrupt, or uncaught exception after this function ends. 2105 */ 2106 if (did_emsg || got_int || did_throw || need_rethrow) 2107 { 2108 csp->pending = (did_emsg ? CSTP_ERROR : 0) 2109 | (got_int ? CSTP_INTERRUPT : 0) 2110 | (did_throw ? CSTP_THROW : 0) 2111 | (need_rethrow ? CSTP_THROW : 0); 2112 2113 // If we are currently throwing an exception (did_throw), save it as 2114 // well. On an error not yet converted to an exception, update 2115 // "force_abort" and reset "cause_abort" (as do_errthrow() would do). 2116 // This is needed for the do_cmdline() call that is going to be made 2117 // for autocommand execution. We need not save *msg_list because 2118 // there is an extra instance for every call of do_cmdline(), anyway. 2119 if (did_throw || need_rethrow) 2120 { 2121 csp->exception = current_exception; 2122 current_exception = NULL; 2123 } 2124 else 2125 { 2126 csp->exception = NULL; 2127 if (did_emsg) 2128 { 2129 force_abort |= cause_abort; 2130 cause_abort = FALSE; 2131 } 2132 } 2133 did_emsg = got_int = did_throw = need_rethrow = FALSE; 2134 2135 // Report if required by the 'verbose' option or when debugging. 2136 report_make_pending(pending, csp->exception); 2137 } 2138 else 2139 { 2140 csp->pending = CSTP_NONE; 2141 csp->exception = NULL; 2142 } 2143 } 2144 2145 /* 2146 * See comment above enter_cleanup() for how this function is used. 2147 * 2148 * This function is a bit like ex_endtry() except that there was not actually 2149 * an extra try block around the part that failed and an error or interrupt 2150 * had not (yet) been converted to an exception when the cleanup autocommand 2151 * sequence was invoked. 2152 * 2153 * This function has to be called with the address of the cleanup_T structure 2154 * filled by enter_cleanup() as an argument; it restores the error/interrupt/ 2155 * exception state saved by that function - except there was an aborting 2156 * error, an interrupt or an uncaught exception during execution of the 2157 * cleanup autocommands. In the latter case, the saved error/interrupt/ 2158 * exception state is discarded. 2159 */ 2160 void 2161 leave_cleanup(cleanup_T *csp) 2162 { 2163 int pending = csp->pending; 2164 2165 if (pending == CSTP_NONE) // nothing to do 2166 return; 2167 2168 // If there was an aborting error, an interrupt, or an uncaught exception 2169 // after the corresponding call to enter_cleanup(), discard what has been 2170 // made pending by it. Report this to the user if required by the 2171 // 'verbose' option or when debugging. 2172 if (aborting() || need_rethrow) 2173 { 2174 if (pending & CSTP_THROW) 2175 // Cancel the pending exception (includes report). 2176 discard_exception((except_T *)csp->exception, FALSE); 2177 else 2178 report_discard_pending(pending, NULL); 2179 2180 // If an error was about to be converted to an exception when 2181 // enter_cleanup() was called, free the message list. 2182 if (msg_list != NULL) 2183 free_global_msglist(); 2184 } 2185 2186 /* 2187 * If there was no new error, interrupt, or throw between the calls 2188 * to enter_cleanup() and leave_cleanup(), restore the pending 2189 * error/interrupt/exception state. 2190 */ 2191 else 2192 { 2193 /* 2194 * If there was an exception being thrown when enter_cleanup() was 2195 * called, we need to rethrow it. Make it the exception currently 2196 * being thrown. 2197 */ 2198 if (pending & CSTP_THROW) 2199 current_exception = csp->exception; 2200 2201 /* 2202 * If an error was about to be converted to an exception when 2203 * enter_cleanup() was called, let "cause_abort" take the part of 2204 * "force_abort" (as done by cause_errthrow()). 2205 */ 2206 else if (pending & CSTP_ERROR) 2207 { 2208 cause_abort = force_abort; 2209 force_abort = FALSE; 2210 } 2211 2212 /* 2213 * Restore the pending values of did_emsg, got_int, and did_throw. 2214 */ 2215 if (pending & CSTP_ERROR) 2216 did_emsg = TRUE; 2217 if (pending & CSTP_INTERRUPT) 2218 got_int = TRUE; 2219 if (pending & CSTP_THROW) 2220 need_rethrow = TRUE; // did_throw will be set by do_one_cmd() 2221 2222 // Report if required by the 'verbose' option or when debugging. 2223 report_resume_pending(pending, 2224 (pending & CSTP_THROW) ? (void *)current_exception : NULL); 2225 } 2226 } 2227 2228 2229 /* 2230 * Make conditionals inactive and discard what's pending in finally clauses 2231 * until the conditional type searched for or a try conditional not in its 2232 * finally clause is reached. If this is in an active catch clause, finish 2233 * the caught exception. 2234 * Return the cstack index where the search stopped. 2235 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0, 2236 * the latter meaning the innermost try conditional not in its finally clause. 2237 * "inclusive" tells whether the conditional searched for should be made 2238 * inactive itself (a try conditional not in its finally clause possibly find 2239 * before is always made inactive). If "inclusive" is TRUE and 2240 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of 2241 * "emsg_silent", if reset when the try conditional finally reached was 2242 * entered, is restored (used by ex_endtry()). This is normally done only 2243 * when such a try conditional is left. 2244 */ 2245 int 2246 cleanup_conditionals( 2247 cstack_T *cstack, 2248 int searched_cond, 2249 int inclusive) 2250 { 2251 int idx; 2252 int stop = FALSE; 2253 2254 for (idx = cstack->cs_idx; idx >= 0; --idx) 2255 { 2256 if (cstack->cs_flags[idx] & CSF_TRY) 2257 { 2258 /* 2259 * Discard anything pending in a finally clause and continue the 2260 * search. There may also be a pending ":continue", ":break", 2261 * ":return", or ":finish" before the finally clause. We must not 2262 * discard it, unless an error or interrupt occurred afterwards. 2263 */ 2264 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY)) 2265 { 2266 switch (cstack->cs_pending[idx]) 2267 { 2268 case CSTP_NONE: 2269 break; 2270 2271 case CSTP_CONTINUE: 2272 case CSTP_BREAK: 2273 case CSTP_FINISH: 2274 report_discard_pending(cstack->cs_pending[idx], NULL); 2275 cstack->cs_pending[idx] = CSTP_NONE; 2276 break; 2277 2278 case CSTP_RETURN: 2279 report_discard_pending(CSTP_RETURN, 2280 cstack->cs_rettv[idx]); 2281 discard_pending_return(cstack->cs_rettv[idx]); 2282 cstack->cs_pending[idx] = CSTP_NONE; 2283 break; 2284 2285 default: 2286 if (cstack->cs_flags[idx] & CSF_FINALLY) 2287 { 2288 if (cstack->cs_pending[idx] & CSTP_THROW) 2289 { 2290 // Cancel the pending exception. This is in the 2291 // finally clause, so that the stack of the 2292 // caught exceptions is not involved. 2293 discard_exception( 2294 (except_T *)cstack->cs_exception[idx], 2295 FALSE); 2296 } 2297 else 2298 report_discard_pending(cstack->cs_pending[idx], 2299 NULL); 2300 cstack->cs_pending[idx] = CSTP_NONE; 2301 } 2302 break; 2303 } 2304 } 2305 2306 /* 2307 * Stop at a try conditional not in its finally clause. If this try 2308 * conditional is in an active catch clause, finish the caught 2309 * exception. 2310 */ 2311 if (!(cstack->cs_flags[idx] & CSF_FINALLY)) 2312 { 2313 if ((cstack->cs_flags[idx] & CSF_ACTIVE) 2314 && (cstack->cs_flags[idx] & CSF_CAUGHT)) 2315 finish_exception((except_T *)cstack->cs_exception[idx]); 2316 // Stop at this try conditional - except the try block never 2317 // got active (because of an inactive surrounding conditional 2318 // or when the ":try" appeared after an error or interrupt or 2319 // throw). 2320 if (cstack->cs_flags[idx] & CSF_TRUE) 2321 { 2322 if (searched_cond == 0 && !inclusive) 2323 break; 2324 stop = TRUE; 2325 } 2326 } 2327 } 2328 2329 // Stop on the searched conditional type (even when the surrounding 2330 // conditional is not active or something has been made pending). 2331 // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT, 2332 // check first whether "emsg_silent" needs to be restored. 2333 if (cstack->cs_flags[idx] & searched_cond) 2334 { 2335 if (!inclusive) 2336 break; 2337 stop = TRUE; 2338 } 2339 cstack->cs_flags[idx] &= ~CSF_ACTIVE; 2340 if (stop && searched_cond != (CSF_TRY | CSF_SILENT)) 2341 break; 2342 2343 /* 2344 * When leaving a try conditional that reset "emsg_silent" on its 2345 * entry after saving the original value, restore that value here and 2346 * free the memory used to store it. 2347 */ 2348 if ((cstack->cs_flags[idx] & CSF_TRY) 2349 && (cstack->cs_flags[idx] & CSF_SILENT)) 2350 { 2351 eslist_T *elem; 2352 2353 elem = cstack->cs_emsg_silent_list; 2354 cstack->cs_emsg_silent_list = elem->next; 2355 emsg_silent = elem->saved_emsg_silent; 2356 vim_free(elem); 2357 cstack->cs_flags[idx] &= ~CSF_SILENT; 2358 } 2359 if (stop) 2360 break; 2361 } 2362 return idx; 2363 } 2364 2365 /* 2366 * Return an appropriate error message for a missing endwhile/endfor/endif. 2367 */ 2368 static char * 2369 get_end_emsg(cstack_T *cstack) 2370 { 2371 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE) 2372 return _(e_endwhile); 2373 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR) 2374 return _(e_endfor); 2375 return _(e_endif); 2376 } 2377 2378 2379 /* 2380 * Rewind conditionals until index "idx" is reached. "cond_type" and 2381 * "cond_level" specify a conditional type and the address of a level variable 2382 * which is to be decremented with each skipped conditional of the specified 2383 * type. 2384 * Also free "for info" structures where needed. 2385 */ 2386 void 2387 rewind_conditionals( 2388 cstack_T *cstack, 2389 int idx, 2390 int cond_type, 2391 int *cond_level) 2392 { 2393 while (cstack->cs_idx > idx) 2394 { 2395 if (cstack->cs_flags[cstack->cs_idx] & cond_type) 2396 --*cond_level; 2397 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR) 2398 free_for_info(cstack->cs_forinfo[cstack->cs_idx]); 2399 leave_block(cstack); 2400 } 2401 } 2402 2403 /* 2404 * ":endfunction" when not after a ":function" 2405 */ 2406 void 2407 ex_endfunction(exarg_T *eap) 2408 { 2409 if (eap->cmdidx == CMD_enddef) 2410 emsg(_("E193: :enddef not inside a function")); 2411 else 2412 emsg(_("E193: :endfunction not inside a function")); 2413 } 2414 2415 /* 2416 * Return TRUE if the string "p" looks like a ":while" or ":for" command. 2417 */ 2418 int 2419 has_loop_cmd(char_u *p) 2420 { 2421 int len; 2422 2423 // skip modifiers, white space and ':' 2424 for (;;) 2425 { 2426 while (*p == ' ' || *p == '\t' || *p == ':') 2427 ++p; 2428 len = modifier_len(p); 2429 if (len == 0) 2430 break; 2431 p += len; 2432 } 2433 if ((p[0] == 'w' && p[1] == 'h') 2434 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r')) 2435 return TRUE; 2436 return FALSE; 2437 } 2438 2439 #endif // FEAT_EVAL 2440