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 if (cmdmod_error()) 1015 return; 1016 did_endif = TRUE; 1017 if (cstack->cs_idx < 0 1018 || (cstack->cs_flags[cstack->cs_idx] 1019 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK))) 1020 eap->errmsg = _(e_endif_without_if); 1021 else 1022 { 1023 /* 1024 * When debugging or a breakpoint was encountered, display the debug 1025 * prompt (if not already done). This shows the user that an ":endif" 1026 * is executed when the ":if" or a previous ":elseif" was not TRUE. 1027 * Handle a ">quit" debug command as if an interrupt had occurred before 1028 * the ":endif". That is, throw an interrupt exception if appropriate. 1029 * Doing this here prevents an exception for a parsing error being 1030 * discarded by throwing the interrupt exception later on. 1031 */ 1032 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE) 1033 && dbg_check_skipped(eap)) 1034 (void)do_intthrow(cstack); 1035 1036 leave_block(cstack); 1037 } 1038 } 1039 1040 /* 1041 * ":else" and ":elseif". 1042 */ 1043 void 1044 ex_else(exarg_T *eap) 1045 { 1046 int error; 1047 int skip; 1048 int result; 1049 cstack_T *cstack = eap->cstack; 1050 1051 /* 1052 * Don't do something after an error, interrupt, or throw, or when there is 1053 * a surrounding conditional and it was not active. 1054 */ 1055 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0 1056 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE)); 1057 1058 if (cstack->cs_idx < 0 1059 || (cstack->cs_flags[cstack->cs_idx] 1060 & (CSF_WHILE | CSF_FOR | CSF_TRY | CSF_BLOCK))) 1061 { 1062 if (eap->cmdidx == CMD_else) 1063 { 1064 eap->errmsg = _(e_else_without_if); 1065 return; 1066 } 1067 eap->errmsg = _(e_elseif_without_if); 1068 skip = TRUE; 1069 } 1070 else if (cstack->cs_flags[cstack->cs_idx] & CSF_ELSE) 1071 { 1072 if (eap->cmdidx == CMD_else) 1073 { 1074 eap->errmsg = _("E583: multiple :else"); 1075 return; 1076 } 1077 eap->errmsg = _("E584: :elseif after :else"); 1078 skip = TRUE; 1079 } 1080 1081 // if skipping or the ":if" was TRUE, reset ACTIVE, otherwise set it 1082 if (skip || cstack->cs_flags[cstack->cs_idx] & CSF_TRUE) 1083 { 1084 if (eap->errmsg == NULL) 1085 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE; 1086 skip = TRUE; // don't evaluate an ":elseif" 1087 } 1088 else 1089 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE; 1090 1091 /* 1092 * When debugging or a breakpoint was encountered, display the debug prompt 1093 * (if not already done). This shows the user that an ":else" or ":elseif" 1094 * is executed when the ":if" or previous ":elseif" was not TRUE. Handle 1095 * a ">quit" debug command as if an interrupt had occurred before the 1096 * ":else" or ":elseif". That is, set "skip" and throw an interrupt 1097 * exception if appropriate. Doing this here prevents that an exception 1098 * for a parsing errors is discarded when throwing the interrupt exception 1099 * later on. 1100 */ 1101 if (!skip && dbg_check_skipped(eap) && got_int) 1102 { 1103 (void)do_intthrow(cstack); 1104 skip = TRUE; 1105 } 1106 1107 if (eap->cmdidx == CMD_elseif) 1108 { 1109 result = eval_to_bool(eap->arg, &error, eap, skip); 1110 1111 // When throwing error exceptions, we want to throw always the first 1112 // of several errors in a row. This is what actually happens when 1113 // a conditional error was detected above and there is another failure 1114 // when parsing the expression. Since the skip flag is set in this 1115 // case, the parsing error will be ignored by emsg(). 1116 if (!skip && !error) 1117 { 1118 if (result) 1119 cstack->cs_flags[cstack->cs_idx] = CSF_ACTIVE | CSF_TRUE; 1120 else 1121 cstack->cs_flags[cstack->cs_idx] = 0; 1122 } 1123 else if (eap->errmsg == NULL) 1124 // set TRUE, so this conditional will never get active 1125 cstack->cs_flags[cstack->cs_idx] = CSF_TRUE; 1126 } 1127 else 1128 cstack->cs_flags[cstack->cs_idx] |= CSF_ELSE; 1129 } 1130 1131 /* 1132 * Handle ":while" and ":for". 1133 */ 1134 void 1135 ex_while(exarg_T *eap) 1136 { 1137 int error; 1138 int skip; 1139 int result; 1140 cstack_T *cstack = eap->cstack; 1141 1142 if (cstack->cs_idx == CSTACK_LEN - 1) 1143 eap->errmsg = _("E585: :while/:for nesting too deep"); 1144 else 1145 { 1146 /* 1147 * The loop flag is set when we have jumped back from the matching 1148 * ":endwhile" or ":endfor". When not set, need to initialise this 1149 * cstack entry. 1150 */ 1151 if ((cstack->cs_lflags & CSL_HAD_LOOP) == 0) 1152 { 1153 enter_block(cstack); 1154 ++cstack->cs_looplevel; 1155 cstack->cs_line[cstack->cs_idx] = -1; 1156 } 1157 else 1158 { 1159 if (in_vim9script() && SCRIPT_ID_VALID(current_sctx.sc_sid)) 1160 { 1161 scriptitem_T *si = SCRIPT_ITEM(current_sctx.sc_sid); 1162 int i; 1163 1164 // Any variables defined in the previous round are no longer 1165 // visible. 1166 for (i = cstack->cs_script_var_len[cstack->cs_idx]; 1167 i < si->sn_var_vals.ga_len; ++i) 1168 { 1169 svar_T *sv = ((svar_T *)si->sn_var_vals.ga_data) + i; 1170 1171 // sv_name is set to NULL if it was already removed. This 1172 // happens when it was defined in an inner block and no 1173 // functions were defined there. 1174 if (sv->sv_name != NULL) 1175 // Remove a variable declared inside the block, if it 1176 // still exists, from sn_vars. 1177 hide_script_var(si, i, FALSE); 1178 } 1179 cstack->cs_script_var_len[cstack->cs_idx] = 1180 si->sn_var_vals.ga_len; 1181 } 1182 } 1183 cstack->cs_flags[cstack->cs_idx] = 1184 eap->cmdidx == CMD_while ? CSF_WHILE : CSF_FOR; 1185 1186 /* 1187 * Don't do something after an error, interrupt, or throw, or when 1188 * there is a surrounding conditional and it was not active. 1189 */ 1190 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0 1191 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE)); 1192 if (eap->cmdidx == CMD_while) 1193 { 1194 /* 1195 * ":while bool-expr" 1196 */ 1197 result = eval_to_bool(eap->arg, &error, eap, skip); 1198 } 1199 else 1200 { 1201 void *fi; 1202 evalarg_T evalarg; 1203 1204 /* 1205 * ":for var in list-expr" 1206 */ 1207 CLEAR_FIELD(evalarg); 1208 evalarg.eval_flags = skip ? 0 : EVAL_EVALUATE; 1209 if (getline_equal(eap->getline, eap->cookie, getsourceline)) 1210 { 1211 evalarg.eval_getline = eap->getline; 1212 evalarg.eval_cookie = eap->cookie; 1213 } 1214 1215 if ((cstack->cs_lflags & CSL_HAD_LOOP) != 0) 1216 { 1217 // Jumping here from a ":continue" or ":endfor": use the 1218 // previously evaluated list. 1219 fi = cstack->cs_forinfo[cstack->cs_idx]; 1220 error = FALSE; 1221 1222 // the "in expr" is not used, skip over it 1223 skip_for_lines(fi, &evalarg); 1224 } 1225 else 1226 { 1227 // Evaluate the argument and get the info in a structure. 1228 fi = eval_for_line(eap->arg, &error, eap, &evalarg); 1229 cstack->cs_forinfo[cstack->cs_idx] = fi; 1230 } 1231 1232 // use the element at the start of the list and advance 1233 if (!error && fi != NULL && !skip) 1234 result = next_for_item(fi, eap->arg); 1235 else 1236 result = FALSE; 1237 1238 if (!result) 1239 { 1240 free_for_info(fi); 1241 cstack->cs_forinfo[cstack->cs_idx] = NULL; 1242 } 1243 clear_evalarg(&evalarg, eap); 1244 } 1245 1246 /* 1247 * If this cstack entry was just initialised and is active, set the 1248 * loop flag, so do_cmdline() will set the line number in cs_line[]. 1249 * If executing the command a second time, clear the loop flag. 1250 */ 1251 if (!skip && !error && result) 1252 { 1253 cstack->cs_flags[cstack->cs_idx] |= (CSF_ACTIVE | CSF_TRUE); 1254 cstack->cs_lflags ^= CSL_HAD_LOOP; 1255 } 1256 else 1257 { 1258 cstack->cs_lflags &= ~CSL_HAD_LOOP; 1259 // If the ":while" evaluates to FALSE or ":for" is past the end of 1260 // the list, show the debug prompt at the ":endwhile"/":endfor" as 1261 // if there was a ":break" in a ":while"/":for" evaluating to 1262 // TRUE. 1263 if (!skip && !error) 1264 cstack->cs_flags[cstack->cs_idx] |= CSF_TRUE; 1265 } 1266 } 1267 } 1268 1269 /* 1270 * ":continue" 1271 */ 1272 void 1273 ex_continue(exarg_T *eap) 1274 { 1275 int idx; 1276 cstack_T *cstack = eap->cstack; 1277 1278 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0) 1279 eap->errmsg = _(e_continue); 1280 else 1281 { 1282 // Try to find the matching ":while". This might stop at a try 1283 // conditional not in its finally clause (which is then to be executed 1284 // next). Therefor, inactivate all conditionals except the ":while" 1285 // itself (if reached). 1286 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE); 1287 if (idx >= 0 && (cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR))) 1288 { 1289 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel); 1290 1291 /* 1292 * Set CSL_HAD_CONT, so do_cmdline() will jump back to the 1293 * matching ":while". 1294 */ 1295 cstack->cs_lflags |= CSL_HAD_CONT; // let do_cmdline() handle it 1296 } 1297 else 1298 { 1299 // If a try conditional not in its finally clause is reached first, 1300 // make the ":continue" pending for execution at the ":endtry". 1301 cstack->cs_pending[idx] = CSTP_CONTINUE; 1302 report_make_pending(CSTP_CONTINUE, NULL); 1303 } 1304 } 1305 } 1306 1307 /* 1308 * ":break" 1309 */ 1310 void 1311 ex_break(exarg_T *eap) 1312 { 1313 int idx; 1314 cstack_T *cstack = eap->cstack; 1315 1316 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0) 1317 eap->errmsg = _(e_break); 1318 else 1319 { 1320 // Inactivate conditionals until the matching ":while" or a try 1321 // conditional not in its finally clause (which is then to be 1322 // executed next) is found. In the latter case, make the ":break" 1323 // pending for execution at the ":endtry". 1324 idx = cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, TRUE); 1325 if (idx >= 0 && !(cstack->cs_flags[idx] & (CSF_WHILE | CSF_FOR))) 1326 { 1327 cstack->cs_pending[idx] = CSTP_BREAK; 1328 report_make_pending(CSTP_BREAK, NULL); 1329 } 1330 } 1331 } 1332 1333 /* 1334 * ":endwhile" and ":endfor" 1335 */ 1336 void 1337 ex_endwhile(exarg_T *eap) 1338 { 1339 cstack_T *cstack = eap->cstack; 1340 int idx; 1341 char *err; 1342 int csf; 1343 int fl; 1344 1345 if (cmdmod_error()) 1346 return; 1347 1348 if (eap->cmdidx == CMD_endwhile) 1349 { 1350 err = e_while; 1351 csf = CSF_WHILE; 1352 } 1353 else 1354 { 1355 err = e_for; 1356 csf = CSF_FOR; 1357 } 1358 1359 if (cstack->cs_looplevel <= 0 || cstack->cs_idx < 0) 1360 eap->errmsg = _(err); 1361 else 1362 { 1363 fl = cstack->cs_flags[cstack->cs_idx]; 1364 if (!(fl & csf)) 1365 { 1366 // If we are in a ":while" or ":for" but used the wrong endloop 1367 // command, do not rewind to the next enclosing ":for"/":while". 1368 if (fl & CSF_WHILE) 1369 eap->errmsg = _("E732: Using :endfor with :while"); 1370 else if (fl & CSF_FOR) 1371 eap->errmsg = _("E733: Using :endwhile with :for"); 1372 } 1373 if (!(fl & (CSF_WHILE | CSF_FOR))) 1374 { 1375 if (!(fl & CSF_TRY)) 1376 eap->errmsg = _(e_endif); 1377 else if (fl & CSF_FINALLY) 1378 eap->errmsg = _(e_endtry); 1379 // Try to find the matching ":while" and report what's missing. 1380 for (idx = cstack->cs_idx; idx > 0; --idx) 1381 { 1382 fl = cstack->cs_flags[idx]; 1383 if ((fl & CSF_TRY) && !(fl & CSF_FINALLY)) 1384 { 1385 // Give up at a try conditional not in its finally clause. 1386 // Ignore the ":endwhile"/":endfor". 1387 eap->errmsg = _(err); 1388 return; 1389 } 1390 if (fl & csf) 1391 break; 1392 } 1393 // Cleanup and rewind all contained (and unclosed) conditionals. 1394 (void)cleanup_conditionals(cstack, CSF_WHILE | CSF_FOR, FALSE); 1395 rewind_conditionals(cstack, idx, CSF_TRY, &cstack->cs_trylevel); 1396 } 1397 1398 /* 1399 * When debugging or a breakpoint was encountered, display the debug 1400 * prompt (if not already done). This shows the user that an 1401 * ":endwhile"/":endfor" is executed when the ":while" was not TRUE or 1402 * after a ":break". Handle a ">quit" debug command as if an 1403 * interrupt had occurred before the ":endwhile"/":endfor". That is, 1404 * throw an interrupt exception if appropriate. Doing this here 1405 * prevents that an exception for a parsing error is discarded when 1406 * throwing the interrupt exception later on. 1407 */ 1408 else if (cstack->cs_flags[cstack->cs_idx] & CSF_TRUE 1409 && !(cstack->cs_flags[cstack->cs_idx] & CSF_ACTIVE) 1410 && dbg_check_skipped(eap)) 1411 (void)do_intthrow(cstack); 1412 1413 // Set loop flag, so do_cmdline() will jump back to the matching 1414 // ":while" or ":for". 1415 cstack->cs_lflags |= CSL_HAD_ENDLOOP; 1416 } 1417 } 1418 1419 /* 1420 * "{" start of a block in Vim9 script 1421 */ 1422 void 1423 ex_block(exarg_T *eap) 1424 { 1425 cstack_T *cstack = eap->cstack; 1426 1427 if (cstack->cs_idx == CSTACK_LEN - 1) 1428 eap->errmsg = _("E579: block nesting too deep"); 1429 else 1430 { 1431 enter_block(cstack); 1432 cstack->cs_flags[cstack->cs_idx] = CSF_BLOCK | CSF_ACTIVE | CSF_TRUE; 1433 } 1434 } 1435 1436 /* 1437 * "}" end of a block in Vim9 script 1438 */ 1439 void 1440 ex_endblock(exarg_T *eap) 1441 { 1442 cstack_T *cstack = eap->cstack; 1443 1444 if (cstack->cs_idx < 0 1445 || (cstack->cs_flags[cstack->cs_idx] & CSF_BLOCK) == 0) 1446 eap->errmsg = _(e_endblock_without_block); 1447 else 1448 leave_block(cstack); 1449 } 1450 1451 /* 1452 * ":throw expr" 1453 */ 1454 void 1455 ex_throw(exarg_T *eap) 1456 { 1457 char_u *arg = eap->arg; 1458 char_u *value; 1459 1460 if (*arg != NUL && *arg != '|' && *arg != '\n') 1461 value = eval_to_string_skip(arg, eap, eap->skip); 1462 else 1463 { 1464 emsg(_(e_argreq)); 1465 value = NULL; 1466 } 1467 1468 // On error or when an exception is thrown during argument evaluation, do 1469 // not throw. 1470 if (!eap->skip && value != NULL) 1471 { 1472 if (throw_exception(value, ET_USER, NULL) == FAIL) 1473 vim_free(value); 1474 else 1475 do_throw(eap->cstack); 1476 } 1477 } 1478 1479 /* 1480 * Throw the current exception through the specified cstack. Common routine 1481 * for ":throw" (user exception) and error and interrupt exceptions. Also 1482 * used for rethrowing an uncaught exception. 1483 */ 1484 void 1485 do_throw(cstack_T *cstack) 1486 { 1487 int idx; 1488 int inactivate_try = FALSE; 1489 1490 /* 1491 * Cleanup and inactivate up to the next surrounding try conditional that 1492 * is not in its finally clause. Normally, do not inactivate the try 1493 * conditional itself, so that its ACTIVE flag can be tested below. But 1494 * if a previous error or interrupt has not been converted to an exception, 1495 * inactivate the try conditional, too, as if the conversion had been done, 1496 * and reset the did_emsg or got_int flag, so this won't happen again at 1497 * the next surrounding try conditional. 1498 */ 1499 #ifndef THROW_ON_ERROR_TRUE 1500 if (did_emsg && !THROW_ON_ERROR) 1501 { 1502 inactivate_try = TRUE; 1503 did_emsg = FALSE; 1504 } 1505 #endif 1506 #ifndef THROW_ON_INTERRUPT_TRUE 1507 if (got_int && !THROW_ON_INTERRUPT) 1508 { 1509 inactivate_try = TRUE; 1510 got_int = FALSE; 1511 } 1512 #endif 1513 idx = cleanup_conditionals(cstack, 0, inactivate_try); 1514 if (idx >= 0) 1515 { 1516 /* 1517 * If this try conditional is active and we are before its first 1518 * ":catch", set THROWN so that the ":catch" commands will check 1519 * whether the exception matches. When the exception came from any of 1520 * the catch clauses, it will be made pending at the ":finally" (if 1521 * present) and rethrown at the ":endtry". This will also happen if 1522 * the try conditional is inactive. This is the case when we are 1523 * throwing an exception due to an error or interrupt on the way from 1524 * a preceding ":continue", ":break", ":return", ":finish", error or 1525 * interrupt (not converted to an exception) to the finally clause or 1526 * from a preceding throw of a user or error or interrupt exception to 1527 * the matching catch clause or the finally clause. 1528 */ 1529 if (!(cstack->cs_flags[idx] & CSF_CAUGHT)) 1530 { 1531 if (cstack->cs_flags[idx] & CSF_ACTIVE) 1532 cstack->cs_flags[idx] |= CSF_THROWN; 1533 else 1534 // THROWN may have already been set for a catchable exception 1535 // that has been discarded. Ensure it is reset for the new 1536 // exception. 1537 cstack->cs_flags[idx] &= ~CSF_THROWN; 1538 } 1539 cstack->cs_flags[idx] &= ~CSF_ACTIVE; 1540 cstack->cs_exception[idx] = current_exception; 1541 } 1542 #if 0 1543 // TODO: Add optimization below. Not yet done because of interface 1544 // problems to eval.c and ex_cmds2.c. (Servatius) 1545 else 1546 { 1547 /* 1548 * There are no catch clauses to check or finally clauses to execute. 1549 * End the current script or function. The exception will be rethrown 1550 * in the caller. 1551 */ 1552 if (getline_equal(eap->getline, eap->cookie, get_func_line)) 1553 current_funccal->returned = TRUE; 1554 elseif (eap->get_func_line == getsourceline) 1555 ((struct source_cookie *)eap->cookie)->finished = TRUE; 1556 } 1557 #endif 1558 1559 did_throw = TRUE; 1560 } 1561 1562 /* 1563 * ":try" 1564 */ 1565 void 1566 ex_try(exarg_T *eap) 1567 { 1568 int skip; 1569 cstack_T *cstack = eap->cstack; 1570 1571 if (cmdmod_error()) 1572 return; 1573 1574 if (cstack->cs_idx == CSTACK_LEN - 1) 1575 eap->errmsg = _("E601: :try nesting too deep"); 1576 else 1577 { 1578 enter_block(cstack); 1579 ++cstack->cs_trylevel; 1580 cstack->cs_flags[cstack->cs_idx] = CSF_TRY; 1581 cstack->cs_pending[cstack->cs_idx] = CSTP_NONE; 1582 1583 /* 1584 * Don't do something after an error, interrupt, or throw, or when there 1585 * is a surrounding conditional and it was not active. 1586 */ 1587 skip = did_emsg || got_int || did_throw || (cstack->cs_idx > 0 1588 && !(cstack->cs_flags[cstack->cs_idx - 1] & CSF_ACTIVE)); 1589 1590 if (!skip) 1591 { 1592 // Set ACTIVE and TRUE. TRUE means that the corresponding ":catch" 1593 // commands should check for a match if an exception is thrown and 1594 // that the finally clause needs to be executed. 1595 cstack->cs_flags[cstack->cs_idx] |= CSF_ACTIVE | CSF_TRUE; 1596 1597 /* 1598 * ":silent!", even when used in a try conditional, disables 1599 * displaying of error messages and conversion of errors to 1600 * exceptions. When the silent commands again open a try 1601 * conditional, save "emsg_silent" and reset it so that errors are 1602 * again converted to exceptions. The value is restored when that 1603 * try conditional is left. If it is left normally, the commands 1604 * following the ":endtry" are again silent. If it is left by 1605 * a ":continue", ":break", ":return", or ":finish", the commands 1606 * executed next are again silent. If it is left due to an 1607 * aborting error, an interrupt, or an exception, restoring 1608 * "emsg_silent" does not matter since we are already in the 1609 * aborting state and/or the exception has already been thrown. 1610 * The effect is then just freeing the memory that was allocated 1611 * to save the value. 1612 */ 1613 if (emsg_silent) 1614 { 1615 eslist_T *elem; 1616 1617 elem = ALLOC_ONE(struct eslist_elem); 1618 if (elem == NULL) 1619 emsg(_(e_outofmem)); 1620 else 1621 { 1622 elem->saved_emsg_silent = emsg_silent; 1623 elem->next = cstack->cs_emsg_silent_list; 1624 cstack->cs_emsg_silent_list = elem; 1625 cstack->cs_flags[cstack->cs_idx] |= CSF_SILENT; 1626 emsg_silent = 0; 1627 } 1628 } 1629 } 1630 1631 } 1632 } 1633 1634 /* 1635 * ":catch /{pattern}/" and ":catch" 1636 */ 1637 void 1638 ex_catch(exarg_T *eap) 1639 { 1640 int idx = 0; 1641 int give_up = FALSE; 1642 int skip = FALSE; 1643 int caught = FALSE; 1644 char_u *end; 1645 int save_char = 0; 1646 char_u *save_cpo; 1647 regmatch_T regmatch; 1648 int prev_got_int; 1649 cstack_T *cstack = eap->cstack; 1650 char_u *pat; 1651 1652 if (cmdmod_error()) 1653 return; 1654 1655 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0) 1656 { 1657 eap->errmsg = _(e_catch); 1658 give_up = TRUE; 1659 } 1660 else 1661 { 1662 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY)) 1663 { 1664 // Report what's missing if the matching ":try" is not in its 1665 // finally clause. 1666 eap->errmsg = get_end_emsg(cstack); 1667 skip = TRUE; 1668 } 1669 for (idx = cstack->cs_idx; idx > 0; --idx) 1670 if (cstack->cs_flags[idx] & CSF_TRY) 1671 break; 1672 if (cstack->cs_flags[idx] & CSF_FINALLY) 1673 { 1674 // Give up for a ":catch" after ":finally" and ignore it. 1675 // Just parse. 1676 eap->errmsg = _("E604: :catch after :finally"); 1677 give_up = TRUE; 1678 } 1679 else 1680 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR, 1681 &cstack->cs_looplevel); 1682 } 1683 1684 if (ends_excmd2(eap->cmd, eap->arg)) // no argument, catch all errors 1685 { 1686 pat = (char_u *)".*"; 1687 end = NULL; 1688 eap->nextcmd = find_nextcmd(eap->arg); 1689 } 1690 else 1691 { 1692 pat = eap->arg + 1; 1693 end = skip_regexp_err(pat, *eap->arg, TRUE); 1694 if (end == NULL) 1695 give_up = TRUE; 1696 } 1697 1698 if (!give_up) 1699 { 1700 /* 1701 * Don't do something when no exception has been thrown or when the 1702 * corresponding try block never got active (because of an inactive 1703 * surrounding conditional or after an error or interrupt or throw). 1704 */ 1705 if (!did_throw || !(cstack->cs_flags[idx] & CSF_TRUE)) 1706 skip = TRUE; 1707 1708 /* 1709 * Check for a match only if an exception is thrown but not caught by 1710 * a previous ":catch". An exception that has replaced a discarded 1711 * exception is not checked (THROWN is not set then). 1712 */ 1713 if (!skip && (cstack->cs_flags[idx] & CSF_THROWN) 1714 && !(cstack->cs_flags[idx] & CSF_CAUGHT)) 1715 { 1716 if (end != NULL && *end != NUL 1717 && !ends_excmd2(end, skipwhite(end + 1))) 1718 { 1719 semsg(_(e_trailing_arg), end); 1720 return; 1721 } 1722 1723 // When debugging or a breakpoint was encountered, display the 1724 // debug prompt (if not already done) before checking for a match. 1725 // This is a helpful hint for the user when the regular expression 1726 // matching fails. Handle a ">quit" debug command as if an 1727 // interrupt had occurred before the ":catch". That is, discard 1728 // the original exception, replace it by an interrupt exception, 1729 // and don't catch it in this try block. 1730 if (!dbg_check_skipped(eap) || !do_intthrow(cstack)) 1731 { 1732 // Terminate the pattern and avoid the 'l' flag in 'cpoptions' 1733 // while compiling it. 1734 if (end != NULL) 1735 { 1736 save_char = *end; 1737 *end = NUL; 1738 } 1739 save_cpo = p_cpo; 1740 p_cpo = empty_option; 1741 // Disable error messages, it will make current_exception 1742 // invalid. 1743 ++emsg_off; 1744 regmatch.regprog = vim_regcomp(pat, RE_MAGIC + RE_STRING); 1745 --emsg_off; 1746 regmatch.rm_ic = FALSE; 1747 if (end != NULL) 1748 *end = save_char; 1749 p_cpo = save_cpo; 1750 if (regmatch.regprog == NULL) 1751 semsg(_(e_invarg2), pat); 1752 else 1753 { 1754 /* 1755 * Save the value of got_int and reset it. We don't want 1756 * a previous interruption cancel matching, only hitting 1757 * CTRL-C while matching should abort it. 1758 */ 1759 prev_got_int = got_int; 1760 got_int = FALSE; 1761 caught = vim_regexec_nl(®match, 1762 (char_u *)current_exception->value, (colnr_T)0); 1763 got_int |= prev_got_int; 1764 vim_regfree(regmatch.regprog); 1765 } 1766 } 1767 } 1768 1769 if (caught) 1770 { 1771 // Make this ":catch" clause active and reset did_emsg, got_int, 1772 // and did_throw. Put the exception on the caught stack. 1773 cstack->cs_flags[idx] |= CSF_ACTIVE | CSF_CAUGHT; 1774 did_emsg = got_int = did_throw = FALSE; 1775 catch_exception((except_T *)cstack->cs_exception[idx]); 1776 // It's mandatory that the current exception is stored in the cstack 1777 // so that it can be discarded at the next ":catch", ":finally", or 1778 // ":endtry" or when the catch clause is left by a ":continue", 1779 // ":break", ":return", ":finish", error, interrupt, or another 1780 // exception. 1781 if (cstack->cs_exception[cstack->cs_idx] != current_exception) 1782 internal_error("ex_catch()"); 1783 } 1784 else 1785 { 1786 /* 1787 * If there is a preceding catch clause and it caught the exception, 1788 * finish the exception now. This happens also after errors except 1789 * when this ":catch" was after the ":finally" or not within 1790 * a ":try". Make the try conditional inactive so that the 1791 * following catch clauses are skipped. On an error or interrupt 1792 * after the preceding try block or catch clause was left by 1793 * a ":continue", ":break", ":return", or ":finish", discard the 1794 * pending action. 1795 */ 1796 cleanup_conditionals(cstack, CSF_TRY, TRUE); 1797 } 1798 } 1799 1800 if (end != NULL) 1801 eap->nextcmd = find_nextcmd(end); 1802 } 1803 1804 /* 1805 * ":finally" 1806 */ 1807 void 1808 ex_finally(exarg_T *eap) 1809 { 1810 int idx; 1811 int skip = FALSE; 1812 int pending = CSTP_NONE; 1813 cstack_T *cstack = eap->cstack; 1814 1815 if (cmdmod_error()) 1816 return; 1817 1818 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0) 1819 eap->errmsg = _(e_finally); 1820 else 1821 { 1822 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY)) 1823 { 1824 eap->errmsg = get_end_emsg(cstack); 1825 for (idx = cstack->cs_idx - 1; idx > 0; --idx) 1826 if (cstack->cs_flags[idx] & CSF_TRY) 1827 break; 1828 // Make this error pending, so that the commands in the following 1829 // finally clause can be executed. This overrules also a pending 1830 // ":continue", ":break", ":return", or ":finish". 1831 pending = CSTP_ERROR; 1832 } 1833 else 1834 idx = cstack->cs_idx; 1835 1836 if (cstack->cs_flags[idx] & CSF_FINALLY) 1837 { 1838 // Give up for a multiple ":finally" and ignore it. 1839 eap->errmsg = _(e_finally_dup); 1840 return; 1841 } 1842 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR, 1843 &cstack->cs_looplevel); 1844 1845 /* 1846 * Don't do something when the corresponding try block never got active 1847 * (because of an inactive surrounding conditional or after an error or 1848 * interrupt or throw) or for a ":finally" without ":try" or a multiple 1849 * ":finally". After every other error (did_emsg or the conditional 1850 * errors detected above) or after an interrupt (got_int) or an 1851 * exception (did_throw), the finally clause must be executed. 1852 */ 1853 skip = !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE); 1854 1855 if (!skip) 1856 { 1857 // When debugging or a breakpoint was encountered, display the 1858 // debug prompt (if not already done). The user then knows that the 1859 // finally clause is executed. 1860 if (dbg_check_skipped(eap)) 1861 { 1862 // Handle a ">quit" debug command as if an interrupt had 1863 // occurred before the ":finally". That is, discard the 1864 // original exception and replace it by an interrupt 1865 // exception. 1866 (void)do_intthrow(cstack); 1867 } 1868 1869 /* 1870 * If there is a preceding catch clause and it caught the exception, 1871 * finish the exception now. This happens also after errors except 1872 * when this is a multiple ":finally" or one not within a ":try". 1873 * After an error or interrupt, this also discards a pending 1874 * ":continue", ":break", ":finish", or ":return" from the preceding 1875 * try block or catch clause. 1876 */ 1877 cleanup_conditionals(cstack, CSF_TRY, FALSE); 1878 1879 /* 1880 * Make did_emsg, got_int, did_throw pending. If set, they overrule 1881 * a pending ":continue", ":break", ":return", or ":finish". Then 1882 * we have particularly to discard a pending return value (as done 1883 * by the call to cleanup_conditionals() above when did_emsg or 1884 * got_int is set). The pending values are restored by the 1885 * ":endtry", except if there is a new error, interrupt, exception, 1886 * ":continue", ":break", ":return", or ":finish" in the following 1887 * finally clause. A missing ":endwhile", ":endfor" or ":endif" 1888 * detected here is treated as if did_emsg and did_throw had 1889 * already been set, respectively in case that the error is not 1890 * converted to an exception, did_throw had already been unset. 1891 * We must not set did_emsg here since that would suppress the 1892 * error message. 1893 */ 1894 if (pending == CSTP_ERROR || did_emsg || got_int || did_throw) 1895 { 1896 if (cstack->cs_pending[cstack->cs_idx] == CSTP_RETURN) 1897 { 1898 report_discard_pending(CSTP_RETURN, 1899 cstack->cs_rettv[cstack->cs_idx]); 1900 discard_pending_return(cstack->cs_rettv[cstack->cs_idx]); 1901 } 1902 if (pending == CSTP_ERROR && !did_emsg) 1903 pending |= (THROW_ON_ERROR) ? CSTP_THROW : 0; 1904 else 1905 pending |= did_throw ? CSTP_THROW : 0; 1906 pending |= did_emsg ? CSTP_ERROR : 0; 1907 pending |= got_int ? CSTP_INTERRUPT : 0; 1908 cstack->cs_pending[cstack->cs_idx] = pending; 1909 1910 // It's mandatory that the current exception is stored in the 1911 // cstack so that it can be rethrown at the ":endtry" or be 1912 // discarded if the finally clause is left by a ":continue", 1913 // ":break", ":return", ":finish", error, interrupt, or another 1914 // exception. When emsg() is called for a missing ":endif" or 1915 // a missing ":endwhile"/":endfor" detected here, the 1916 // exception will be discarded. 1917 if (did_throw && cstack->cs_exception[cstack->cs_idx] 1918 != current_exception) 1919 internal_error("ex_finally()"); 1920 } 1921 1922 /* 1923 * Set CSL_HAD_FINA, so do_cmdline() will reset did_emsg, 1924 * got_int, and did_throw and make the finally clause active. 1925 * This will happen after emsg() has been called for a missing 1926 * ":endif" or a missing ":endwhile"/":endfor" detected here, so 1927 * that the following finally clause will be executed even then. 1928 */ 1929 cstack->cs_lflags |= CSL_HAD_FINA; 1930 } 1931 } 1932 } 1933 1934 /* 1935 * ":endtry" 1936 */ 1937 void 1938 ex_endtry(exarg_T *eap) 1939 { 1940 int idx; 1941 int skip; 1942 int rethrow = FALSE; 1943 int pending = CSTP_NONE; 1944 void *rettv = NULL; 1945 cstack_T *cstack = eap->cstack; 1946 1947 if (cmdmod_error()) 1948 return; 1949 1950 if (cstack->cs_trylevel <= 0 || cstack->cs_idx < 0) 1951 eap->errmsg = _(e_no_endtry); 1952 else 1953 { 1954 /* 1955 * Don't do something after an error, interrupt or throw in the try 1956 * block, catch clause, or finally clause preceding this ":endtry" or 1957 * when an error or interrupt occurred after a ":continue", ":break", 1958 * ":return", or ":finish" in a try block or catch clause preceding this 1959 * ":endtry" or when the try block never got active (because of an 1960 * inactive surrounding conditional or after an error or interrupt or 1961 * throw) or when there is a surrounding conditional and it has been 1962 * made inactive by a ":continue", ":break", ":return", or ":finish" in 1963 * the finally clause. The latter case need not be tested since then 1964 * anything pending has already been discarded. */ 1965 skip = did_emsg || got_int || did_throw || 1966 !(cstack->cs_flags[cstack->cs_idx] & CSF_TRUE); 1967 1968 if (!(cstack->cs_flags[cstack->cs_idx] & CSF_TRY)) 1969 { 1970 eap->errmsg = get_end_emsg(cstack); 1971 // Find the matching ":try" and report what's missing. 1972 idx = cstack->cs_idx; 1973 do 1974 --idx; 1975 while (idx > 0 && !(cstack->cs_flags[idx] & CSF_TRY)); 1976 rewind_conditionals(cstack, idx, CSF_WHILE | CSF_FOR, 1977 &cstack->cs_looplevel); 1978 skip = TRUE; 1979 1980 /* 1981 * If an exception is being thrown, discard it to prevent it from 1982 * being rethrown at the end of this function. It would be 1983 * discarded by the error message, anyway. Resets did_throw. 1984 * This does not affect the script termination due to the error 1985 * since "trylevel" is decremented after emsg() has been called. 1986 */ 1987 if (did_throw) 1988 discard_current_exception(); 1989 } 1990 else 1991 { 1992 idx = cstack->cs_idx; 1993 1994 /* 1995 * If we stopped with the exception currently being thrown at this 1996 * try conditional since we didn't know that it doesn't have 1997 * a finally clause, we need to rethrow it after closing the try 1998 * conditional. 1999 */ 2000 if (did_throw && (cstack->cs_flags[idx] & CSF_TRUE) 2001 && !(cstack->cs_flags[idx] & CSF_FINALLY)) 2002 rethrow = TRUE; 2003 } 2004 2005 // If there was no finally clause, show the user when debugging or 2006 // a breakpoint was encountered that the end of the try conditional has 2007 // been reached: display the debug prompt (if not already done). Do 2008 // this on normal control flow or when an exception was thrown, but not 2009 // on an interrupt or error not converted to an exception or when 2010 // a ":break", ":continue", ":return", or ":finish" is pending. These 2011 // actions are carried out immediately. 2012 if ((rethrow || (!skip 2013 && !(cstack->cs_flags[idx] & CSF_FINALLY) 2014 && !cstack->cs_pending[idx])) 2015 && dbg_check_skipped(eap)) 2016 { 2017 // Handle a ">quit" debug command as if an interrupt had occurred 2018 // before the ":endtry". That is, throw an interrupt exception and 2019 // set "skip" and "rethrow". 2020 if (got_int) 2021 { 2022 skip = TRUE; 2023 (void)do_intthrow(cstack); 2024 // The do_intthrow() call may have reset did_throw or 2025 // cstack->cs_pending[idx]. 2026 rethrow = FALSE; 2027 if (did_throw && !(cstack->cs_flags[idx] & CSF_FINALLY)) 2028 rethrow = TRUE; 2029 } 2030 } 2031 2032 /* 2033 * If a ":return" is pending, we need to resume it after closing the 2034 * try conditional; remember the return value. If there was a finally 2035 * clause making an exception pending, we need to rethrow it. Make it 2036 * the exception currently being thrown. 2037 */ 2038 if (!skip) 2039 { 2040 pending = cstack->cs_pending[idx]; 2041 cstack->cs_pending[idx] = CSTP_NONE; 2042 if (pending == CSTP_RETURN) 2043 rettv = cstack->cs_rettv[idx]; 2044 else if (pending & CSTP_THROW) 2045 current_exception = cstack->cs_exception[idx]; 2046 } 2047 2048 /* 2049 * Discard anything pending on an error, interrupt, or throw in the 2050 * finally clause. If there was no ":finally", discard a pending 2051 * ":continue", ":break", ":return", or ":finish" if an error or 2052 * interrupt occurred afterwards, but before the ":endtry" was reached. 2053 * If an exception was caught by the last of the catch clauses and there 2054 * was no finally clause, finish the exception now. This happens also 2055 * after errors except when this ":endtry" is not within a ":try". 2056 * Restore "emsg_silent" if it has been reset by this try conditional. 2057 */ 2058 (void)cleanup_conditionals(cstack, CSF_TRY | CSF_SILENT, TRUE); 2059 2060 leave_block(cstack); 2061 --cstack->cs_trylevel; 2062 2063 if (!skip) 2064 { 2065 report_resume_pending(pending, 2066 (pending == CSTP_RETURN) ? rettv : 2067 (pending & CSTP_THROW) ? (void *)current_exception : NULL); 2068 switch (pending) 2069 { 2070 case CSTP_NONE: 2071 break; 2072 2073 // Reactivate a pending ":continue", ":break", ":return", 2074 // ":finish" from the try block or a catch clause of this try 2075 // conditional. This is skipped, if there was an error in an 2076 // (unskipped) conditional command or an interrupt afterwards 2077 // or if the finally clause is present and executed a new error, 2078 // interrupt, throw, ":continue", ":break", ":return", or 2079 // ":finish". 2080 case CSTP_CONTINUE: 2081 ex_continue(eap); 2082 break; 2083 case CSTP_BREAK: 2084 ex_break(eap); 2085 break; 2086 case CSTP_RETURN: 2087 do_return(eap, FALSE, FALSE, rettv); 2088 break; 2089 case CSTP_FINISH: 2090 do_finish(eap, FALSE); 2091 break; 2092 2093 // When the finally clause was entered due to an error, 2094 // interrupt or throw (as opposed to a ":continue", ":break", 2095 // ":return", or ":finish"), restore the pending values of 2096 // did_emsg, got_int, and did_throw. This is skipped, if there 2097 // was a new error, interrupt, throw, ":continue", ":break", 2098 // ":return", or ":finish". in the finally clause. 2099 default: 2100 if (pending & CSTP_ERROR) 2101 did_emsg = TRUE; 2102 if (pending & CSTP_INTERRUPT) 2103 got_int = TRUE; 2104 if (pending & CSTP_THROW) 2105 rethrow = TRUE; 2106 break; 2107 } 2108 } 2109 2110 if (rethrow) 2111 // Rethrow the current exception (within this cstack). 2112 do_throw(cstack); 2113 } 2114 } 2115 2116 /* 2117 * enter_cleanup() and leave_cleanup() 2118 * 2119 * Functions to be called before/after invoking a sequence of autocommands for 2120 * cleanup for a failed command. (Failure means here that a call to emsg() 2121 * has been made, an interrupt occurred, or there is an uncaught exception 2122 * from a previous autocommand execution of the same command.) 2123 * 2124 * Call enter_cleanup() with a pointer to a cleanup_T and pass the same 2125 * pointer to leave_cleanup(). The cleanup_T structure stores the pending 2126 * error/interrupt/exception state. 2127 */ 2128 2129 /* 2130 * This function works a bit like ex_finally() except that there was not 2131 * actually an extra try block around the part that failed and an error or 2132 * interrupt has not (yet) been converted to an exception. This function 2133 * saves the error/interrupt/ exception state and prepares for the call to 2134 * do_cmdline() that is going to be made for the cleanup autocommand 2135 * execution. 2136 */ 2137 void 2138 enter_cleanup(cleanup_T *csp) 2139 { 2140 int pending = CSTP_NONE; 2141 2142 /* 2143 * Postpone did_emsg, got_int, did_throw. The pending values will be 2144 * restored by leave_cleanup() except if there was an aborting error, 2145 * interrupt, or uncaught exception after this function ends. 2146 */ 2147 if (did_emsg || got_int || did_throw || need_rethrow) 2148 { 2149 csp->pending = (did_emsg ? CSTP_ERROR : 0) 2150 | (got_int ? CSTP_INTERRUPT : 0) 2151 | (did_throw ? CSTP_THROW : 0) 2152 | (need_rethrow ? CSTP_THROW : 0); 2153 2154 // If we are currently throwing an exception (did_throw), save it as 2155 // well. On an error not yet converted to an exception, update 2156 // "force_abort" and reset "cause_abort" (as do_errthrow() would do). 2157 // This is needed for the do_cmdline() call that is going to be made 2158 // for autocommand execution. We need not save *msg_list because 2159 // there is an extra instance for every call of do_cmdline(), anyway. 2160 if (did_throw || need_rethrow) 2161 { 2162 csp->exception = current_exception; 2163 current_exception = NULL; 2164 } 2165 else 2166 { 2167 csp->exception = NULL; 2168 if (did_emsg) 2169 { 2170 force_abort |= cause_abort; 2171 cause_abort = FALSE; 2172 } 2173 } 2174 did_emsg = got_int = did_throw = need_rethrow = FALSE; 2175 2176 // Report if required by the 'verbose' option or when debugging. 2177 report_make_pending(pending, csp->exception); 2178 } 2179 else 2180 { 2181 csp->pending = CSTP_NONE; 2182 csp->exception = NULL; 2183 } 2184 } 2185 2186 /* 2187 * See comment above enter_cleanup() for how this function is used. 2188 * 2189 * This function is a bit like ex_endtry() except that there was not actually 2190 * an extra try block around the part that failed and an error or interrupt 2191 * had not (yet) been converted to an exception when the cleanup autocommand 2192 * sequence was invoked. 2193 * 2194 * This function has to be called with the address of the cleanup_T structure 2195 * filled by enter_cleanup() as an argument; it restores the error/interrupt/ 2196 * exception state saved by that function - except there was an aborting 2197 * error, an interrupt or an uncaught exception during execution of the 2198 * cleanup autocommands. In the latter case, the saved error/interrupt/ 2199 * exception state is discarded. 2200 */ 2201 void 2202 leave_cleanup(cleanup_T *csp) 2203 { 2204 int pending = csp->pending; 2205 2206 if (pending == CSTP_NONE) // nothing to do 2207 return; 2208 2209 // If there was an aborting error, an interrupt, or an uncaught exception 2210 // after the corresponding call to enter_cleanup(), discard what has been 2211 // made pending by it. Report this to the user if required by the 2212 // 'verbose' option or when debugging. 2213 if (aborting() || need_rethrow) 2214 { 2215 if (pending & CSTP_THROW) 2216 // Cancel the pending exception (includes report). 2217 discard_exception((except_T *)csp->exception, FALSE); 2218 else 2219 report_discard_pending(pending, NULL); 2220 2221 // If an error was about to be converted to an exception when 2222 // enter_cleanup() was called, free the message list. 2223 if (msg_list != NULL) 2224 free_global_msglist(); 2225 } 2226 2227 /* 2228 * If there was no new error, interrupt, or throw between the calls 2229 * to enter_cleanup() and leave_cleanup(), restore the pending 2230 * error/interrupt/exception state. 2231 */ 2232 else 2233 { 2234 /* 2235 * If there was an exception being thrown when enter_cleanup() was 2236 * called, we need to rethrow it. Make it the exception currently 2237 * being thrown. 2238 */ 2239 if (pending & CSTP_THROW) 2240 current_exception = csp->exception; 2241 2242 /* 2243 * If an error was about to be converted to an exception when 2244 * enter_cleanup() was called, let "cause_abort" take the part of 2245 * "force_abort" (as done by cause_errthrow()). 2246 */ 2247 else if (pending & CSTP_ERROR) 2248 { 2249 cause_abort = force_abort; 2250 force_abort = FALSE; 2251 } 2252 2253 /* 2254 * Restore the pending values of did_emsg, got_int, and did_throw. 2255 */ 2256 if (pending & CSTP_ERROR) 2257 did_emsg = TRUE; 2258 if (pending & CSTP_INTERRUPT) 2259 got_int = TRUE; 2260 if (pending & CSTP_THROW) 2261 need_rethrow = TRUE; // did_throw will be set by do_one_cmd() 2262 2263 // Report if required by the 'verbose' option or when debugging. 2264 report_resume_pending(pending, 2265 (pending & CSTP_THROW) ? (void *)current_exception : NULL); 2266 } 2267 } 2268 2269 2270 /* 2271 * Make conditionals inactive and discard what's pending in finally clauses 2272 * until the conditional type searched for or a try conditional not in its 2273 * finally clause is reached. If this is in an active catch clause, finish 2274 * the caught exception. 2275 * Return the cstack index where the search stopped. 2276 * Values used for "searched_cond" are (CSF_WHILE | CSF_FOR) or CSF_TRY or 0, 2277 * the latter meaning the innermost try conditional not in its finally clause. 2278 * "inclusive" tells whether the conditional searched for should be made 2279 * inactive itself (a try conditional not in its finally clause possibly find 2280 * before is always made inactive). If "inclusive" is TRUE and 2281 * "searched_cond" is CSF_TRY|CSF_SILENT, the saved former value of 2282 * "emsg_silent", if reset when the try conditional finally reached was 2283 * entered, is restored (used by ex_endtry()). This is normally done only 2284 * when such a try conditional is left. 2285 */ 2286 int 2287 cleanup_conditionals( 2288 cstack_T *cstack, 2289 int searched_cond, 2290 int inclusive) 2291 { 2292 int idx; 2293 int stop = FALSE; 2294 2295 for (idx = cstack->cs_idx; idx >= 0; --idx) 2296 { 2297 if (cstack->cs_flags[idx] & CSF_TRY) 2298 { 2299 /* 2300 * Discard anything pending in a finally clause and continue the 2301 * search. There may also be a pending ":continue", ":break", 2302 * ":return", or ":finish" before the finally clause. We must not 2303 * discard it, unless an error or interrupt occurred afterwards. 2304 */ 2305 if (did_emsg || got_int || (cstack->cs_flags[idx] & CSF_FINALLY)) 2306 { 2307 switch (cstack->cs_pending[idx]) 2308 { 2309 case CSTP_NONE: 2310 break; 2311 2312 case CSTP_CONTINUE: 2313 case CSTP_BREAK: 2314 case CSTP_FINISH: 2315 report_discard_pending(cstack->cs_pending[idx], NULL); 2316 cstack->cs_pending[idx] = CSTP_NONE; 2317 break; 2318 2319 case CSTP_RETURN: 2320 report_discard_pending(CSTP_RETURN, 2321 cstack->cs_rettv[idx]); 2322 discard_pending_return(cstack->cs_rettv[idx]); 2323 cstack->cs_pending[idx] = CSTP_NONE; 2324 break; 2325 2326 default: 2327 if (cstack->cs_flags[idx] & CSF_FINALLY) 2328 { 2329 if (cstack->cs_pending[idx] & CSTP_THROW) 2330 { 2331 // Cancel the pending exception. This is in the 2332 // finally clause, so that the stack of the 2333 // caught exceptions is not involved. 2334 discard_exception( 2335 (except_T *)cstack->cs_exception[idx], 2336 FALSE); 2337 } 2338 else 2339 report_discard_pending(cstack->cs_pending[idx], 2340 NULL); 2341 cstack->cs_pending[idx] = CSTP_NONE; 2342 } 2343 break; 2344 } 2345 } 2346 2347 /* 2348 * Stop at a try conditional not in its finally clause. If this try 2349 * conditional is in an active catch clause, finish the caught 2350 * exception. 2351 */ 2352 if (!(cstack->cs_flags[idx] & CSF_FINALLY)) 2353 { 2354 if ((cstack->cs_flags[idx] & CSF_ACTIVE) 2355 && (cstack->cs_flags[idx] & CSF_CAUGHT)) 2356 finish_exception((except_T *)cstack->cs_exception[idx]); 2357 // Stop at this try conditional - except the try block never 2358 // got active (because of an inactive surrounding conditional 2359 // or when the ":try" appeared after an error or interrupt or 2360 // throw). 2361 if (cstack->cs_flags[idx] & CSF_TRUE) 2362 { 2363 if (searched_cond == 0 && !inclusive) 2364 break; 2365 stop = TRUE; 2366 } 2367 } 2368 } 2369 2370 // Stop on the searched conditional type (even when the surrounding 2371 // conditional is not active or something has been made pending). 2372 // If "inclusive" is TRUE and "searched_cond" is CSF_TRY|CSF_SILENT, 2373 // check first whether "emsg_silent" needs to be restored. 2374 if (cstack->cs_flags[idx] & searched_cond) 2375 { 2376 if (!inclusive) 2377 break; 2378 stop = TRUE; 2379 } 2380 cstack->cs_flags[idx] &= ~CSF_ACTIVE; 2381 if (stop && searched_cond != (CSF_TRY | CSF_SILENT)) 2382 break; 2383 2384 /* 2385 * When leaving a try conditional that reset "emsg_silent" on its 2386 * entry after saving the original value, restore that value here and 2387 * free the memory used to store it. 2388 */ 2389 if ((cstack->cs_flags[idx] & CSF_TRY) 2390 && (cstack->cs_flags[idx] & CSF_SILENT)) 2391 { 2392 eslist_T *elem; 2393 2394 elem = cstack->cs_emsg_silent_list; 2395 cstack->cs_emsg_silent_list = elem->next; 2396 emsg_silent = elem->saved_emsg_silent; 2397 vim_free(elem); 2398 cstack->cs_flags[idx] &= ~CSF_SILENT; 2399 } 2400 if (stop) 2401 break; 2402 } 2403 return idx; 2404 } 2405 2406 /* 2407 * Return an appropriate error message for a missing endwhile/endfor/endif. 2408 */ 2409 static char * 2410 get_end_emsg(cstack_T *cstack) 2411 { 2412 if (cstack->cs_flags[cstack->cs_idx] & CSF_WHILE) 2413 return _(e_endwhile); 2414 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR) 2415 return _(e_endfor); 2416 return _(e_endif); 2417 } 2418 2419 2420 /* 2421 * Rewind conditionals until index "idx" is reached. "cond_type" and 2422 * "cond_level" specify a conditional type and the address of a level variable 2423 * which is to be decremented with each skipped conditional of the specified 2424 * type. 2425 * Also free "for info" structures where needed. 2426 */ 2427 void 2428 rewind_conditionals( 2429 cstack_T *cstack, 2430 int idx, 2431 int cond_type, 2432 int *cond_level) 2433 { 2434 while (cstack->cs_idx > idx) 2435 { 2436 if (cstack->cs_flags[cstack->cs_idx] & cond_type) 2437 --*cond_level; 2438 if (cstack->cs_flags[cstack->cs_idx] & CSF_FOR) 2439 free_for_info(cstack->cs_forinfo[cstack->cs_idx]); 2440 leave_block(cstack); 2441 } 2442 } 2443 2444 /* 2445 * ":endfunction" when not after a ":function" 2446 */ 2447 void 2448 ex_endfunction(exarg_T *eap) 2449 { 2450 if (eap->cmdidx == CMD_enddef) 2451 emsg(_("E193: :enddef not inside a function")); 2452 else 2453 emsg(_("E193: :endfunction not inside a function")); 2454 } 2455 2456 /* 2457 * Return TRUE if the string "p" looks like a ":while" or ":for" command. 2458 */ 2459 int 2460 has_loop_cmd(char_u *p) 2461 { 2462 int len; 2463 2464 // skip modifiers, white space and ':' 2465 for (;;) 2466 { 2467 while (*p == ' ' || *p == '\t' || *p == ':') 2468 ++p; 2469 len = modifier_len(p); 2470 if (len == 0) 2471 break; 2472 p += len; 2473 } 2474 if ((p[0] == 'w' && p[1] == 'h') 2475 || (p[0] == 'f' && p[1] == 'o' && p[2] == 'r')) 2476 return TRUE; 2477 return FALSE; 2478 } 2479 2480 #endif // FEAT_EVAL 2481