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 * message.c: functions for displaying messages on the command line 12 */ 13 14 #define MESSAGE_FILE /* don't include prototype for smsg() */ 15 #define USING_FLOAT_STUFF 16 17 #include "vim.h" 18 19 static void add_msg_hist(char_u *s, int len, int attr); 20 static void hit_return_msg(void); 21 static void msg_home_replace_attr(char_u *fname, int attr); 22 static void msg_puts_attr_len(char *str, int maxlen, int attr); 23 static void msg_puts_display(char_u *str, int maxlen, int attr, int recurse); 24 static void msg_scroll_up(void); 25 static void inc_msg_scrolled(void); 26 static void store_sb_text(char_u **sb_str, char_u *s, int attr, int *sb_col, int finish); 27 static void t_puts(int *t_col, char_u *t_s, char_u *s, int attr); 28 static void msg_puts_printf(char_u *str, int maxlen); 29 static int do_more_prompt(int typed_char); 30 static void msg_screen_putchar(int c, int attr); 31 static int msg_check_screen(void); 32 static void redir_write(char_u *s, int maxlen); 33 #ifdef FEAT_CON_DIALOG 34 static char_u *msg_show_console_dialog(char_u *message, char_u *buttons, int dfltbutton); 35 static int confirm_msg_used = FALSE; /* displaying confirm_msg */ 36 static char_u *confirm_msg = NULL; /* ":confirm" message */ 37 static char_u *confirm_msg_tail; /* tail of confirm_msg */ 38 #endif 39 #ifdef FEAT_JOB_CHANNEL 40 static int emsg_to_channel_log = FALSE; 41 #endif 42 43 struct msg_hist 44 { 45 struct msg_hist *next; 46 char_u *msg; 47 int attr; 48 }; 49 50 static struct msg_hist *first_msg_hist = NULL; 51 static struct msg_hist *last_msg_hist = NULL; 52 static int msg_hist_len = 0; 53 54 static FILE *verbose_fd = NULL; 55 static int verbose_did_open = FALSE; 56 57 /* 58 * When writing messages to the screen, there are many different situations. 59 * A number of variables is used to remember the current state: 60 * msg_didany TRUE when messages were written since the last time the 61 * user reacted to a prompt. 62 * Reset: After hitting a key for the hit-return prompt, 63 * hitting <CR> for the command line or input(). 64 * Set: When any message is written to the screen. 65 * msg_didout TRUE when something was written to the current line. 66 * Reset: When advancing to the next line, when the current 67 * text can be overwritten. 68 * Set: When any message is written to the screen. 69 * msg_nowait No extra delay for the last drawn message. 70 * Used in normal_cmd() before the mode message is drawn. 71 * emsg_on_display There was an error message recently. Indicates that there 72 * should be a delay before redrawing. 73 * msg_scroll The next message should not overwrite the current one. 74 * msg_scrolled How many lines the screen has been scrolled (because of 75 * messages). Used in update_screen() to scroll the screen 76 * back. Incremented each time the screen scrolls a line. 77 * msg_scrolled_ign TRUE when msg_scrolled is non-zero and msg_puts_attr() 78 * writes something without scrolling should not make 79 * need_wait_return to be set. This is a hack to make ":ts" 80 * work without an extra prompt. 81 * lines_left Number of lines available for messages before the 82 * more-prompt is to be given. -1 when not set. 83 * need_wait_return TRUE when the hit-return prompt is needed. 84 * Reset: After giving the hit-return prompt, when the user 85 * has answered some other prompt. 86 * Set: When the ruler or typeahead display is overwritten, 87 * scrolling the screen for some message. 88 * keep_msg Message to be displayed after redrawing the screen, in 89 * main_loop(). 90 * This is an allocated string or NULL when not used. 91 */ 92 93 /* 94 * msg(s) - displays the string 's' on the status line 95 * When terminal not initialized (yet) mch_errmsg(..) is used. 96 * return TRUE if wait_return not called 97 */ 98 int 99 msg(char *s) 100 { 101 return msg_attr_keep(s, 0, FALSE); 102 } 103 104 #if defined(FEAT_EVAL) || defined(FEAT_X11) || defined(USE_XSMP) \ 105 || defined(FEAT_GUI_GTK) || defined(PROTO) 106 /* 107 * Like msg() but keep it silent when 'verbosefile' is set. 108 */ 109 int 110 verb_msg(char *s) 111 { 112 int n; 113 114 verbose_enter(); 115 n = msg_attr_keep(s, 0, FALSE); 116 verbose_leave(); 117 118 return n; 119 } 120 #endif 121 122 int 123 msg_attr(char *s, int attr) 124 { 125 return msg_attr_keep(s, attr, FALSE); 126 } 127 128 int 129 msg_attr_keep( 130 char *s, 131 int attr, 132 int keep) /* TRUE: set keep_msg if it doesn't scroll */ 133 { 134 static int entered = 0; 135 int retval; 136 char_u *buf = NULL; 137 138 /* Skip messages not matching ":filter pattern". 139 * Don't filter when there is an error. */ 140 if (!emsg_on_display && message_filtered((char_u *)s)) 141 return TRUE; 142 143 #ifdef FEAT_EVAL 144 if (attr == 0) 145 set_vim_var_string(VV_STATUSMSG, (char_u *)s, -1); 146 #endif 147 148 /* 149 * It is possible that displaying a messages causes a problem (e.g., 150 * when redrawing the window), which causes another message, etc.. To 151 * break this loop, limit the recursiveness to 3 levels. 152 */ 153 if (entered >= 3) 154 return TRUE; 155 ++entered; 156 157 /* Add message to history (unless it's a repeated kept message or a 158 * truncated message) */ 159 if ((char_u *)s != keep_msg 160 || (*s != '<' 161 && last_msg_hist != NULL 162 && last_msg_hist->msg != NULL 163 && STRCMP(s, last_msg_hist->msg))) 164 add_msg_hist((char_u *)s, -1, attr); 165 166 #ifdef FEAT_JOB_CHANNEL 167 if (emsg_to_channel_log) 168 /* Write message in the channel log. */ 169 ch_log(NULL, "ERROR: %s", (char *)s); 170 #endif 171 172 /* When displaying keep_msg, don't let msg_start() free it, caller must do 173 * that. */ 174 if ((char_u *)s == keep_msg) 175 keep_msg = NULL; 176 177 /* Truncate the message if needed. */ 178 msg_start(); 179 buf = msg_strtrunc((char_u *)s, FALSE); 180 if (buf != NULL) 181 s = (char *)buf; 182 183 msg_outtrans_attr((char_u *)s, attr); 184 msg_clr_eos(); 185 retval = msg_end(); 186 187 if (keep && retval && vim_strsize((char_u *)s) 188 < (int)(Rows - cmdline_row - 1) * Columns + sc_col) 189 set_keep_msg((char_u *)s, 0); 190 191 vim_free(buf); 192 --entered; 193 return retval; 194 } 195 196 /* 197 * Truncate a string such that it can be printed without causing a scroll. 198 * Returns an allocated string or NULL when no truncating is done. 199 */ 200 char_u * 201 msg_strtrunc( 202 char_u *s, 203 int force) /* always truncate */ 204 { 205 char_u *buf = NULL; 206 int len; 207 int room; 208 209 /* May truncate message to avoid a hit-return prompt */ 210 if ((!msg_scroll && !need_wait_return && shortmess(SHM_TRUNCALL) 211 && !exmode_active && msg_silent == 0) || force) 212 { 213 len = vim_strsize(s); 214 if (msg_scrolled != 0) 215 /* Use all the columns. */ 216 room = (int)(Rows - msg_row) * Columns - 1; 217 else 218 /* Use up to 'showcmd' column. */ 219 room = (int)(Rows - msg_row - 1) * Columns + sc_col - 1; 220 if (len > room && room > 0) 221 { 222 if (enc_utf8) 223 /* may have up to 18 bytes per cell (6 per char, up to two 224 * composing chars) */ 225 len = (room + 2) * 18; 226 else if (enc_dbcs == DBCS_JPNU) 227 /* may have up to 2 bytes per cell for euc-jp */ 228 len = (room + 2) * 2; 229 else 230 len = room + 2; 231 buf = alloc(len); 232 if (buf != NULL) 233 trunc_string(s, buf, room, len); 234 } 235 } 236 return buf; 237 } 238 239 /* 240 * Truncate a string "s" to "buf" with cell width "room". 241 * "s" and "buf" may be equal. 242 */ 243 void 244 trunc_string( 245 char_u *s, 246 char_u *buf, 247 int room_in, 248 int buflen) 249 { 250 size_t room = room_in - 3; /* "..." takes 3 chars */ 251 size_t half; 252 size_t len = 0; 253 int e; 254 int i; 255 int n; 256 257 if (room_in < 3) 258 room = 0; 259 half = room / 2; 260 261 /* First part: Start of the string. */ 262 for (e = 0; len < half && e < buflen; ++e) 263 { 264 if (s[e] == NUL) 265 { 266 /* text fits without truncating! */ 267 buf[e] = NUL; 268 return; 269 } 270 n = ptr2cells(s + e); 271 if (len + n > half) 272 break; 273 len += n; 274 buf[e] = s[e]; 275 if (has_mbyte) 276 for (n = (*mb_ptr2len)(s + e); --n > 0; ) 277 { 278 if (++e == buflen) 279 break; 280 buf[e] = s[e]; 281 } 282 } 283 284 /* Last part: End of the string. */ 285 i = e; 286 if (enc_dbcs != 0) 287 { 288 /* For DBCS going backwards in a string is slow, but 289 * computing the cell width isn't too slow: go forward 290 * until the rest fits. */ 291 n = vim_strsize(s + i); 292 while (len + n > room) 293 { 294 n -= ptr2cells(s + i); 295 i += (*mb_ptr2len)(s + i); 296 } 297 } 298 else if (enc_utf8) 299 { 300 /* For UTF-8 we can go backwards easily. */ 301 half = i = (int)STRLEN(s); 302 for (;;) 303 { 304 do 305 half = half - utf_head_off(s, s + half - 1) - 1; 306 while (half > 0 && utf_iscomposing(utf_ptr2char(s + half))); 307 n = ptr2cells(s + half); 308 if (len + n > room || half == 0) 309 break; 310 len += n; 311 i = (int)half; 312 } 313 } 314 else 315 { 316 for (i = (int)STRLEN(s); len + (n = ptr2cells(s + i - 1)) <= room; --i) 317 len += n; 318 } 319 320 321 if (i <= e + 3) 322 { 323 /* text fits without truncating */ 324 if (s != buf) 325 { 326 len = STRLEN(s); 327 if (len >= (size_t)buflen) 328 len = buflen - 1; 329 len = len - e + 1; 330 if (len < 1) 331 buf[e - 1] = NUL; 332 else 333 mch_memmove(buf + e, s + e, len); 334 } 335 } 336 else if (e + 3 < buflen) 337 { 338 /* set the middle and copy the last part */ 339 mch_memmove(buf + e, "...", (size_t)3); 340 len = STRLEN(s + i) + 1; 341 if (len >= (size_t)buflen - e - 3) 342 len = buflen - e - 3 - 1; 343 mch_memmove(buf + e + 3, s + i, len); 344 buf[e + 3 + len - 1] = NUL; 345 } 346 else 347 { 348 /* can't fit in the "...", just truncate it */ 349 buf[e - 1] = NUL; 350 } 351 } 352 353 /* 354 * Automatic prototype generation does not understand this function. 355 * Note: Caller of smsg() and smsg_attr() must check the resulting string is 356 * shorter than IOSIZE!!! 357 */ 358 #ifndef PROTO 359 360 int vim_snprintf(char *str, size_t str_m, const char *fmt, ...); 361 362 int 363 # ifdef __BORLANDC__ 364 _RTLENTRYF 365 # endif 366 smsg(const char *s, ...) 367 { 368 va_list arglist; 369 370 va_start(arglist, s); 371 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist); 372 va_end(arglist); 373 return msg((char *)IObuff); 374 } 375 376 int 377 # ifdef __BORLANDC__ 378 _RTLENTRYF 379 # endif 380 smsg_attr(int attr, const char *s, ...) 381 { 382 va_list arglist; 383 384 va_start(arglist, s); 385 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist); 386 va_end(arglist); 387 return msg_attr((char *)IObuff, attr); 388 } 389 390 int 391 # ifdef __BORLANDC__ 392 _RTLENTRYF 393 # endif 394 smsg_attr_keep(int attr, const char *s, ...) 395 { 396 va_list arglist; 397 398 va_start(arglist, s); 399 vim_vsnprintf((char *)IObuff, IOSIZE, s, arglist); 400 va_end(arglist); 401 return msg_attr_keep((char *)IObuff, attr, TRUE); 402 } 403 404 #endif 405 406 /* 407 * Remember the last sourcing name/lnum used in an error message, so that it 408 * isn't printed each time when it didn't change. 409 */ 410 static int last_sourcing_lnum = 0; 411 static char_u *last_sourcing_name = NULL; 412 413 /* 414 * Reset the last used sourcing name/lnum. Makes sure it is displayed again 415 * for the next error message; 416 */ 417 void 418 reset_last_sourcing(void) 419 { 420 VIM_CLEAR(last_sourcing_name); 421 last_sourcing_lnum = 0; 422 } 423 424 /* 425 * Return TRUE if "sourcing_name" differs from "last_sourcing_name". 426 */ 427 static int 428 other_sourcing_name(void) 429 { 430 if (sourcing_name != NULL) 431 { 432 if (last_sourcing_name != NULL) 433 return STRCMP(sourcing_name, last_sourcing_name) != 0; 434 return TRUE; 435 } 436 return FALSE; 437 } 438 439 /* 440 * Get the message about the source, as used for an error message. 441 * Returns an allocated string with room for one more character. 442 * Returns NULL when no message is to be given. 443 */ 444 static char_u * 445 get_emsg_source(void) 446 { 447 char_u *Buf, *p; 448 449 if (sourcing_name != NULL && other_sourcing_name()) 450 { 451 p = (char_u *)_("Error detected while processing %s:"); 452 Buf = alloc((unsigned)(STRLEN(sourcing_name) + STRLEN(p))); 453 if (Buf != NULL) 454 sprintf((char *)Buf, (char *)p, sourcing_name); 455 return Buf; 456 } 457 return NULL; 458 } 459 460 /* 461 * Get the message about the source lnum, as used for an error message. 462 * Returns an allocated string with room for one more character. 463 * Returns NULL when no message is to be given. 464 */ 465 static char_u * 466 get_emsg_lnum(void) 467 { 468 char_u *Buf, *p; 469 470 /* lnum is 0 when executing a command from the command line 471 * argument, we don't want a line number then */ 472 if (sourcing_name != NULL 473 && (other_sourcing_name() || sourcing_lnum != last_sourcing_lnum) 474 && sourcing_lnum != 0) 475 { 476 p = (char_u *)_("line %4ld:"); 477 Buf = alloc((unsigned)(STRLEN(p) + 20)); 478 if (Buf != NULL) 479 sprintf((char *)Buf, (char *)p, (long)sourcing_lnum); 480 return Buf; 481 } 482 return NULL; 483 } 484 485 /* 486 * Display name and line number for the source of an error. 487 * Remember the file name and line number, so that for the next error the info 488 * is only displayed if it changed. 489 */ 490 void 491 msg_source(int attr) 492 { 493 char_u *p; 494 495 ++no_wait_return; 496 p = get_emsg_source(); 497 if (p != NULL) 498 { 499 msg_attr((char *)p, attr); 500 vim_free(p); 501 } 502 p = get_emsg_lnum(); 503 if (p != NULL) 504 { 505 msg_attr((char *)p, HL_ATTR(HLF_N)); 506 vim_free(p); 507 last_sourcing_lnum = sourcing_lnum; /* only once for each line */ 508 } 509 510 /* remember the last sourcing name printed, also when it's empty */ 511 if (sourcing_name == NULL || other_sourcing_name()) 512 { 513 vim_free(last_sourcing_name); 514 if (sourcing_name == NULL) 515 last_sourcing_name = NULL; 516 else 517 last_sourcing_name = vim_strsave(sourcing_name); 518 } 519 --no_wait_return; 520 } 521 522 /* 523 * Return TRUE if not giving error messages right now: 524 * If "emsg_off" is set: no error messages at the moment. 525 * If "msg" is in 'debug': do error message but without side effects. 526 * If "emsg_skip" is set: never do error messages. 527 */ 528 int 529 emsg_not_now(void) 530 { 531 if ((emsg_off > 0 && vim_strchr(p_debug, 'm') == NULL 532 && vim_strchr(p_debug, 't') == NULL) 533 #ifdef FEAT_EVAL 534 || emsg_skip > 0 535 #endif 536 ) 537 return TRUE; 538 return FALSE; 539 } 540 541 #if defined(FEAT_EVAL) || defined(PROTO) 542 static garray_T ignore_error_list = GA_EMPTY; 543 544 void 545 ignore_error_for_testing(char_u *error) 546 { 547 if (ignore_error_list.ga_itemsize == 0) 548 ga_init2(&ignore_error_list, sizeof(char_u *), 1); 549 550 if (STRCMP("RESET", error) == 0) 551 ga_clear_strings(&ignore_error_list); 552 else 553 ga_add_string(&ignore_error_list, error); 554 } 555 556 static int 557 ignore_error(char_u *msg) 558 { 559 int i; 560 561 for (i = 0; i < ignore_error_list.ga_len; ++i) 562 if (strstr((char *)msg, 563 (char *)((char_u **)(ignore_error_list.ga_data))[i]) != NULL) 564 return TRUE; 565 return FALSE; 566 } 567 #endif 568 569 #if !defined(HAVE_STRERROR) || defined(PROTO) 570 /* 571 * Replacement for perror() that behaves more or less like emsg() was called. 572 * v:errmsg will be set and called_emsg will be set. 573 */ 574 void 575 do_perror(char *msg) 576 { 577 perror(msg); 578 ++emsg_silent; 579 emsg(msg); 580 --emsg_silent; 581 } 582 #endif 583 584 /* 585 * emsg_core() - display an error message 586 * 587 * Rings the bell, if appropriate, and calls message() to do the real work 588 * When terminal not initialized (yet) mch_errmsg(..) is used. 589 * 590 * Return TRUE if wait_return not called. 591 * Note: caller must check 'emsg_not_now()' before calling this. 592 */ 593 static int 594 emsg_core(char_u *s) 595 { 596 int attr; 597 char_u *p; 598 int r; 599 #ifdef FEAT_EVAL 600 int ignore = FALSE; 601 int severe; 602 #endif 603 604 #ifdef FEAT_EVAL 605 /* When testing some errors are turned into a normal message. */ 606 if (ignore_error(s)) 607 /* don't call msg() if it results in a dialog */ 608 return msg_use_printf() ? FALSE : msg((char *)s); 609 #endif 610 611 called_emsg = TRUE; 612 613 #ifdef FEAT_EVAL 614 /* If "emsg_severe" is TRUE: When an error exception is to be thrown, 615 * prefer this message over previous messages for the same command. */ 616 severe = emsg_severe; 617 emsg_severe = FALSE; 618 #endif 619 620 if (!emsg_off || vim_strchr(p_debug, 't') != NULL) 621 { 622 #ifdef FEAT_EVAL 623 /* 624 * Cause a throw of an error exception if appropriate. Don't display 625 * the error message in this case. (If no matching catch clause will 626 * be found, the message will be displayed later on.) "ignore" is set 627 * when the message should be ignored completely (used for the 628 * interrupt message). 629 */ 630 if (cause_errthrow(s, severe, &ignore) == TRUE) 631 { 632 if (!ignore) 633 ++did_emsg; 634 return TRUE; 635 } 636 637 /* set "v:errmsg", also when using ":silent! cmd" */ 638 set_vim_var_string(VV_ERRMSG, s, -1); 639 #endif 640 641 /* 642 * When using ":silent! cmd" ignore error messages. 643 * But do write it to the redirection file. 644 */ 645 if (emsg_silent != 0) 646 { 647 if (emsg_noredir == 0) 648 { 649 msg_start(); 650 p = get_emsg_source(); 651 if (p != NULL) 652 { 653 STRCAT(p, "\n"); 654 redir_write(p, -1); 655 vim_free(p); 656 } 657 p = get_emsg_lnum(); 658 if (p != NULL) 659 { 660 STRCAT(p, "\n"); 661 redir_write(p, -1); 662 vim_free(p); 663 } 664 redir_write(s, -1); 665 } 666 #ifdef FEAT_JOB_CHANNEL 667 ch_log(NULL, "ERROR: %s", (char *)s); 668 #endif 669 return TRUE; 670 } 671 672 ex_exitval = 1; 673 674 /* Reset msg_silent, an error causes messages to be switched back on. 675 */ 676 msg_silent = 0; 677 cmd_silent = FALSE; 678 679 if (global_busy) /* break :global command */ 680 ++global_busy; 681 682 if (p_eb) 683 beep_flush(); /* also includes flush_buffers() */ 684 else 685 flush_buffers(FLUSH_MINIMAL); // flush internal buffers 686 ++did_emsg; // flag for DoOneCmd() 687 #ifdef FEAT_EVAL 688 did_uncaught_emsg = TRUE; 689 #endif 690 } 691 692 emsg_on_display = TRUE; /* remember there is an error message */ 693 ++msg_scroll; /* don't overwrite a previous message */ 694 attr = HL_ATTR(HLF_E); /* set highlight mode for error messages */ 695 if (msg_scrolled != 0) 696 need_wait_return = TRUE; /* needed in case emsg() is called after 697 * wait_return has reset need_wait_return 698 * and a redraw is expected because 699 * msg_scrolled is non-zero */ 700 701 #ifdef FEAT_JOB_CHANNEL 702 emsg_to_channel_log = TRUE; 703 #endif 704 /* 705 * Display name and line number for the source of the error. 706 */ 707 msg_source(attr); 708 709 /* 710 * Display the error message itself. 711 */ 712 msg_nowait = FALSE; /* wait for this msg */ 713 r = msg_attr((char *)s, attr); 714 715 #ifdef FEAT_JOB_CHANNEL 716 emsg_to_channel_log = FALSE; 717 #endif 718 return r; 719 } 720 721 /* 722 * Print an error message. 723 */ 724 int 725 emsg(char *s) 726 { 727 /* Skip this if not giving error messages at the moment. */ 728 if (!emsg_not_now()) 729 return emsg_core((char_u *)s); 730 return TRUE; /* no error messages at the moment */ 731 } 732 733 /* 734 * Print an error message with format string and variable arguments. 735 * Note: caller must not pass 'IObuff' as 1st argument. 736 */ 737 int 738 semsg(const char *s, ...) 739 { 740 /* Skip this if not giving error messages at the moment. */ 741 if (!emsg_not_now()) 742 { 743 va_list ap; 744 745 va_start(ap, s); 746 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap); 747 va_end(ap); 748 return emsg_core(IObuff); 749 } 750 return TRUE; /* no error messages at the moment */ 751 } 752 753 /* 754 * Same as emsg(...), but abort on error when ABORT_ON_INTERNAL_ERROR is 755 * defined. It is used for internal errors only, so that they can be 756 * detected when fuzzing vim. 757 */ 758 void 759 iemsg(char *s) 760 { 761 if (!emsg_not_now()) 762 emsg_core((char_u *)s); 763 #ifdef ABORT_ON_INTERNAL_ERROR 764 abort(); 765 #endif 766 } 767 768 /* 769 * Same as semsg(...) but abort on error when ABORT_ON_INTERNAL_ERROR is 770 * defined. It is used for internal errors only, so that they can be 771 * detected when fuzzing vim. 772 * Note: caller must not pass 'IObuff' as 1st argument. 773 */ 774 void 775 siemsg(const char *s, ...) 776 { 777 if (!emsg_not_now()) 778 { 779 va_list ap; 780 781 va_start(ap, s); 782 vim_vsnprintf((char *)IObuff, IOSIZE, s, ap); 783 va_end(ap); 784 emsg_core(IObuff); 785 } 786 #ifdef ABORT_ON_INTERNAL_ERROR 787 abort(); 788 #endif 789 } 790 791 /* 792 * Give an "Internal error" message. 793 */ 794 void 795 internal_error(char *where) 796 { 797 siemsg(_(e_intern2), where); 798 } 799 800 /* emsg3() and emsgn() are in misc2.c to avoid warnings for the prototypes. */ 801 802 void 803 emsg_invreg(int name) 804 { 805 semsg(_("E354: Invalid register name: '%s'"), transchar(name)); 806 } 807 808 /* 809 * Like msg(), but truncate to a single line if p_shm contains 't', or when 810 * "force" is TRUE. This truncates in another way as for normal messages. 811 * Careful: The string may be changed by msg_may_trunc()! 812 * Returns a pointer to the printed message, if wait_return() not called. 813 */ 814 char * 815 msg_trunc_attr(char *s, int force, int attr) 816 { 817 int n; 818 char *ts; 819 820 /* Add message to history before truncating */ 821 add_msg_hist((char_u *)s, -1, attr); 822 823 ts = (char *)msg_may_trunc(force, (char_u *)s); 824 825 msg_hist_off = TRUE; 826 n = msg_attr(ts, attr); 827 msg_hist_off = FALSE; 828 829 if (n) 830 return ts; 831 return NULL; 832 } 833 834 /* 835 * Check if message "s" should be truncated at the start (for filenames). 836 * Return a pointer to where the truncated message starts. 837 * Note: May change the message by replacing a character with '<'. 838 */ 839 char_u * 840 msg_may_trunc(int force, char_u *s) 841 { 842 int n; 843 int room; 844 845 room = (int)(Rows - cmdline_row - 1) * Columns + sc_col - 1; 846 if ((force || (shortmess(SHM_TRUNC) && !exmode_active)) 847 && (n = (int)STRLEN(s) - room) > 0) 848 { 849 if (has_mbyte) 850 { 851 int size = vim_strsize(s); 852 853 /* There may be room anyway when there are multibyte chars. */ 854 if (size <= room) 855 return s; 856 857 for (n = 0; size >= room; ) 858 { 859 size -= (*mb_ptr2cells)(s + n); 860 n += (*mb_ptr2len)(s + n); 861 } 862 --n; 863 } 864 s += n; 865 *s = '<'; 866 } 867 return s; 868 } 869 870 static void 871 add_msg_hist( 872 char_u *s, 873 int len, /* -1 for undetermined length */ 874 int attr) 875 { 876 struct msg_hist *p; 877 878 if (msg_hist_off || msg_silent != 0) 879 return; 880 881 /* Don't let the message history get too big */ 882 while (msg_hist_len > MAX_MSG_HIST_LEN) 883 (void)delete_first_msg(); 884 885 /* allocate an entry and add the message at the end of the history */ 886 p = (struct msg_hist *)alloc((int)sizeof(struct msg_hist)); 887 if (p != NULL) 888 { 889 if (len < 0) 890 len = (int)STRLEN(s); 891 /* remove leading and trailing newlines */ 892 while (len > 0 && *s == '\n') 893 { 894 ++s; 895 --len; 896 } 897 while (len > 0 && s[len - 1] == '\n') 898 --len; 899 p->msg = vim_strnsave(s, len); 900 p->next = NULL; 901 p->attr = attr; 902 if (last_msg_hist != NULL) 903 last_msg_hist->next = p; 904 last_msg_hist = p; 905 if (first_msg_hist == NULL) 906 first_msg_hist = last_msg_hist; 907 ++msg_hist_len; 908 } 909 } 910 911 /* 912 * Delete the first (oldest) message from the history. 913 * Returns FAIL if there are no messages. 914 */ 915 int 916 delete_first_msg(void) 917 { 918 struct msg_hist *p; 919 920 if (msg_hist_len <= 0) 921 return FAIL; 922 p = first_msg_hist; 923 first_msg_hist = p->next; 924 if (first_msg_hist == NULL) 925 last_msg_hist = NULL; /* history is empty */ 926 vim_free(p->msg); 927 vim_free(p); 928 --msg_hist_len; 929 return OK; 930 } 931 932 /* 933 * ":messages" command. 934 */ 935 void 936 ex_messages(exarg_T *eap) 937 { 938 struct msg_hist *p; 939 char_u *s; 940 int c = 0; 941 942 if (STRCMP(eap->arg, "clear") == 0) 943 { 944 int keep = eap->addr_count == 0 ? 0 : eap->line2; 945 946 while (msg_hist_len > keep) 947 (void)delete_first_msg(); 948 return; 949 } 950 951 if (*eap->arg != NUL) 952 { 953 emsg(_(e_invarg)); 954 return; 955 } 956 957 msg_hist_off = TRUE; 958 959 p = first_msg_hist; 960 if (eap->addr_count != 0) 961 { 962 /* Count total messages */ 963 for (; p != NULL && !got_int; p = p->next) 964 c++; 965 966 c -= eap->line2; 967 968 /* Skip without number of messages specified */ 969 for (p = first_msg_hist; p != NULL && !got_int && c > 0; 970 p = p->next, c--); 971 } 972 973 if (p == first_msg_hist) 974 { 975 s = mch_getenv((char_u *)"LANG"); 976 if (s != NULL && *s != NUL) 977 // The next comment is extracted by xgettext and put in po file for 978 // translators to read. 979 msg_attr( 980 // Translator: Please replace the name and email address 981 // with the appropriate text for your translation. 982 _("Messages maintainer: Bram Moolenaar <[email protected]>"), 983 HL_ATTR(HLF_T)); 984 } 985 986 /* Display what was not skipped. */ 987 for (; p != NULL && !got_int; p = p->next) 988 if (p->msg != NULL) 989 msg_attr((char *)p->msg, p->attr); 990 991 msg_hist_off = FALSE; 992 } 993 994 #if defined(FEAT_CON_DIALOG) || defined(FIND_REPLACE_DIALOG) || defined(PROTO) 995 /* 996 * Call this after prompting the user. This will avoid a hit-return message 997 * and a delay. 998 */ 999 void 1000 msg_end_prompt(void) 1001 { 1002 need_wait_return = FALSE; 1003 emsg_on_display = FALSE; 1004 cmdline_row = msg_row; 1005 msg_col = 0; 1006 msg_clr_eos(); 1007 lines_left = -1; 1008 } 1009 #endif 1010 1011 /* 1012 * Wait for the user to hit a key (normally Enter). 1013 * If "redraw" is TRUE, clear and redraw the screen. 1014 * If "redraw" is FALSE, just redraw the screen. 1015 * If "redraw" is -1, don't redraw at all. 1016 */ 1017 void 1018 wait_return(int redraw) 1019 { 1020 int c; 1021 int oldState; 1022 int tmpState; 1023 int had_got_int; 1024 int save_reg_recording; 1025 FILE *save_scriptout; 1026 1027 if (redraw == TRUE) 1028 must_redraw = CLEAR; 1029 1030 /* If using ":silent cmd", don't wait for a return. Also don't set 1031 * need_wait_return to do it later. */ 1032 if (msg_silent != 0) 1033 return; 1034 1035 /* 1036 * When inside vgetc(), we can't wait for a typed character at all. 1037 * With the global command (and some others) we only need one return at 1038 * the end. Adjust cmdline_row to avoid the next message overwriting the 1039 * last one. 1040 */ 1041 if (vgetc_busy > 0) 1042 return; 1043 need_wait_return = TRUE; 1044 if (no_wait_return) 1045 { 1046 if (!exmode_active) 1047 cmdline_row = msg_row; 1048 return; 1049 } 1050 1051 redir_off = TRUE; /* don't redirect this message */ 1052 oldState = State; 1053 if (quit_more) 1054 { 1055 c = CAR; /* just pretend CR was hit */ 1056 quit_more = FALSE; 1057 got_int = FALSE; 1058 } 1059 else if (exmode_active) 1060 { 1061 msg_puts(" "); /* make sure the cursor is on the right line */ 1062 c = CAR; /* no need for a return in ex mode */ 1063 got_int = FALSE; 1064 } 1065 else 1066 { 1067 /* Make sure the hit-return prompt is on screen when 'guioptions' was 1068 * just changed. */ 1069 screenalloc(FALSE); 1070 1071 State = HITRETURN; 1072 #ifdef FEAT_MOUSE 1073 setmouse(); 1074 #endif 1075 #ifdef USE_ON_FLY_SCROLL 1076 dont_scroll = TRUE; /* disallow scrolling here */ 1077 #endif 1078 cmdline_row = msg_row; 1079 1080 /* Avoid the sequence that the user types ":" at the hit-return prompt 1081 * to start an Ex command, but the file-changed dialog gets in the 1082 * way. */ 1083 if (need_check_timestamps) 1084 check_timestamps(FALSE); 1085 1086 hit_return_msg(); 1087 1088 do 1089 { 1090 /* Remember "got_int", if it is set vgetc() probably returns a 1091 * CTRL-C, but we need to loop then. */ 1092 had_got_int = got_int; 1093 1094 /* Don't do mappings here, we put the character back in the 1095 * typeahead buffer. */ 1096 ++no_mapping; 1097 ++allow_keys; 1098 1099 /* Temporarily disable Recording. If Recording is active, the 1100 * character will be recorded later, since it will be added to the 1101 * typebuf after the loop */ 1102 save_reg_recording = reg_recording; 1103 save_scriptout = scriptout; 1104 reg_recording = 0; 1105 scriptout = NULL; 1106 c = safe_vgetc(); 1107 if (had_got_int && !global_busy) 1108 got_int = FALSE; 1109 --no_mapping; 1110 --allow_keys; 1111 reg_recording = save_reg_recording; 1112 scriptout = save_scriptout; 1113 1114 #ifdef FEAT_CLIPBOARD 1115 /* Strange way to allow copying (yanking) a modeless selection at 1116 * the hit-enter prompt. Use CTRL-Y, because the same is used in 1117 * Cmdline-mode and it's harmless when there is no selection. */ 1118 if (c == Ctrl_Y && clip_star.state == SELECT_DONE) 1119 { 1120 clip_copy_modeless_selection(TRUE); 1121 c = K_IGNORE; 1122 } 1123 #endif 1124 1125 /* 1126 * Allow scrolling back in the messages. 1127 * Also accept scroll-down commands when messages fill the screen, 1128 * to avoid that typing one 'j' too many makes the messages 1129 * disappear. 1130 */ 1131 if (p_more && !p_cp) 1132 { 1133 if (c == 'b' || c == 'k' || c == 'u' || c == 'g' 1134 || c == K_UP || c == K_PAGEUP) 1135 { 1136 if (msg_scrolled > Rows) 1137 /* scroll back to show older messages */ 1138 do_more_prompt(c); 1139 else 1140 { 1141 msg_didout = FALSE; 1142 c = K_IGNORE; 1143 msg_col = 1144 #ifdef FEAT_RIGHTLEFT 1145 cmdmsg_rl ? Columns - 1 : 1146 #endif 1147 0; 1148 } 1149 if (quit_more) 1150 { 1151 c = CAR; /* just pretend CR was hit */ 1152 quit_more = FALSE; 1153 got_int = FALSE; 1154 } 1155 else if (c != K_IGNORE) 1156 { 1157 c = K_IGNORE; 1158 hit_return_msg(); 1159 } 1160 } 1161 else if (msg_scrolled > Rows - 2 1162 && (c == 'j' || c == 'd' || c == 'f' 1163 || c == K_DOWN || c == K_PAGEDOWN)) 1164 c = K_IGNORE; 1165 } 1166 } while ((had_got_int && c == Ctrl_C) 1167 || c == K_IGNORE 1168 #ifdef FEAT_GUI 1169 || c == K_VER_SCROLLBAR || c == K_HOR_SCROLLBAR 1170 #endif 1171 #ifdef FEAT_MOUSE 1172 || c == K_LEFTDRAG || c == K_LEFTRELEASE 1173 || c == K_MIDDLEDRAG || c == K_MIDDLERELEASE 1174 || c == K_RIGHTDRAG || c == K_RIGHTRELEASE 1175 || c == K_MOUSELEFT || c == K_MOUSERIGHT 1176 || c == K_MOUSEDOWN || c == K_MOUSEUP 1177 || c == K_MOUSEMOVE 1178 || (!mouse_has(MOUSE_RETURN) 1179 && mouse_row < msg_row 1180 && (c == K_LEFTMOUSE 1181 || c == K_MIDDLEMOUSE 1182 || c == K_RIGHTMOUSE 1183 || c == K_X1MOUSE 1184 || c == K_X2MOUSE)) 1185 #endif 1186 ); 1187 ui_breakcheck(); 1188 #ifdef FEAT_MOUSE 1189 /* 1190 * Avoid that the mouse-up event causes visual mode to start. 1191 */ 1192 if (c == K_LEFTMOUSE || c == K_MIDDLEMOUSE || c == K_RIGHTMOUSE 1193 || c == K_X1MOUSE || c == K_X2MOUSE) 1194 (void)jump_to_mouse(MOUSE_SETPOS, NULL, 0); 1195 else 1196 #endif 1197 if (vim_strchr((char_u *)"\r\n ", c) == NULL && c != Ctrl_C) 1198 { 1199 /* Put the character back in the typeahead buffer. Don't use the 1200 * stuff buffer, because lmaps wouldn't work. */ 1201 ins_char_typebuf(c); 1202 do_redraw = TRUE; /* need a redraw even though there is 1203 typeahead */ 1204 } 1205 } 1206 redir_off = FALSE; 1207 1208 /* 1209 * If the user hits ':', '?' or '/' we get a command line from the next 1210 * line. 1211 */ 1212 if (c == ':' || c == '?' || c == '/') 1213 { 1214 if (!exmode_active) 1215 cmdline_row = msg_row; 1216 skip_redraw = TRUE; /* skip redraw once */ 1217 do_redraw = FALSE; 1218 #ifdef FEAT_TERMINAL 1219 skip_term_loop = TRUE; 1220 #endif 1221 } 1222 1223 /* 1224 * If the window size changed set_shellsize() will redraw the screen. 1225 * Otherwise the screen is only redrawn if 'redraw' is set and no ':' 1226 * typed. 1227 */ 1228 tmpState = State; 1229 State = oldState; /* restore State before set_shellsize */ 1230 #ifdef FEAT_MOUSE 1231 setmouse(); 1232 #endif 1233 msg_check(); 1234 1235 #if defined(UNIX) || defined(VMS) 1236 /* 1237 * When switching screens, we need to output an extra newline on exit. 1238 */ 1239 if (swapping_screen() && !termcap_active) 1240 newline_on_exit = TRUE; 1241 #endif 1242 1243 need_wait_return = FALSE; 1244 did_wait_return = TRUE; 1245 emsg_on_display = FALSE; /* can delete error message now */ 1246 lines_left = -1; /* reset lines_left at next msg_start() */ 1247 reset_last_sourcing(); 1248 if (keep_msg != NULL && vim_strsize(keep_msg) >= 1249 (Rows - cmdline_row - 1) * Columns + sc_col) 1250 VIM_CLEAR(keep_msg); /* don't redisplay message, it's too long */ 1251 1252 if (tmpState == SETWSIZE) /* got resize event while in vgetc() */ 1253 { 1254 starttermcap(); /* start termcap before redrawing */ 1255 shell_resized(); 1256 } 1257 else if (!skip_redraw 1258 && (redraw == TRUE || (msg_scrolled != 0 && redraw != -1))) 1259 { 1260 starttermcap(); /* start termcap before redrawing */ 1261 redraw_later(VALID); 1262 } 1263 } 1264 1265 /* 1266 * Write the hit-return prompt. 1267 */ 1268 static void 1269 hit_return_msg(void) 1270 { 1271 int save_p_more = p_more; 1272 1273 p_more = FALSE; /* don't want see this message when scrolling back */ 1274 if (msg_didout) /* start on a new line */ 1275 msg_putchar('\n'); 1276 if (got_int) 1277 msg_puts(_("Interrupt: ")); 1278 1279 msg_puts_attr(_("Press ENTER or type command to continue"), HL_ATTR(HLF_R)); 1280 if (!msg_use_printf()) 1281 msg_clr_eos(); 1282 p_more = save_p_more; 1283 } 1284 1285 /* 1286 * Set "keep_msg" to "s". Free the old value and check for NULL pointer. 1287 */ 1288 void 1289 set_keep_msg(char_u *s, int attr) 1290 { 1291 vim_free(keep_msg); 1292 if (s != NULL && msg_silent == 0) 1293 keep_msg = vim_strsave(s); 1294 else 1295 keep_msg = NULL; 1296 keep_msg_more = FALSE; 1297 keep_msg_attr = attr; 1298 } 1299 1300 #if defined(FEAT_TERMRESPONSE) || defined(PROTO) 1301 /* 1302 * If there currently is a message being displayed, set "keep_msg" to it, so 1303 * that it will be displayed again after redraw. 1304 */ 1305 void 1306 set_keep_msg_from_hist(void) 1307 { 1308 if (keep_msg == NULL && last_msg_hist != NULL && msg_scrolled == 0 1309 && (State & NORMAL)) 1310 set_keep_msg(last_msg_hist->msg, last_msg_hist->attr); 1311 } 1312 #endif 1313 1314 /* 1315 * Prepare for outputting characters in the command line. 1316 */ 1317 void 1318 msg_start(void) 1319 { 1320 int did_return = FALSE; 1321 1322 if (!msg_silent) 1323 VIM_CLEAR(keep_msg); 1324 1325 #ifdef FEAT_EVAL 1326 if (need_clr_eos) 1327 { 1328 /* Halfway an ":echo" command and getting an (error) message: clear 1329 * any text from the command. */ 1330 need_clr_eos = FALSE; 1331 msg_clr_eos(); 1332 } 1333 #endif 1334 1335 if (!msg_scroll && full_screen) /* overwrite last message */ 1336 { 1337 msg_row = cmdline_row; 1338 msg_col = 1339 #ifdef FEAT_RIGHTLEFT 1340 cmdmsg_rl ? Columns - 1 : 1341 #endif 1342 0; 1343 } 1344 else if (msg_didout) /* start message on next line */ 1345 { 1346 msg_putchar('\n'); 1347 did_return = TRUE; 1348 if (exmode_active != EXMODE_NORMAL) 1349 cmdline_row = msg_row; 1350 } 1351 if (!msg_didany || lines_left < 0) 1352 msg_starthere(); 1353 if (msg_silent == 0) 1354 { 1355 msg_didout = FALSE; /* no output on current line yet */ 1356 cursor_off(); 1357 } 1358 1359 /* when redirecting, may need to start a new line. */ 1360 if (!did_return) 1361 redir_write((char_u *)"\n", -1); 1362 } 1363 1364 /* 1365 * Note that the current msg position is where messages start. 1366 */ 1367 void 1368 msg_starthere(void) 1369 { 1370 lines_left = cmdline_row; 1371 msg_didany = FALSE; 1372 } 1373 1374 void 1375 msg_putchar(int c) 1376 { 1377 msg_putchar_attr(c, 0); 1378 } 1379 1380 void 1381 msg_putchar_attr(int c, int attr) 1382 { 1383 char_u buf[MB_MAXBYTES + 1]; 1384 1385 if (IS_SPECIAL(c)) 1386 { 1387 buf[0] = K_SPECIAL; 1388 buf[1] = K_SECOND(c); 1389 buf[2] = K_THIRD(c); 1390 buf[3] = NUL; 1391 } 1392 else 1393 buf[(*mb_char2bytes)(c, buf)] = NUL; 1394 msg_puts_attr((char *)buf, attr); 1395 } 1396 1397 void 1398 msg_outnum(long n) 1399 { 1400 char buf[20]; 1401 1402 sprintf(buf, "%ld", n); 1403 msg_puts(buf); 1404 } 1405 1406 void 1407 msg_home_replace(char_u *fname) 1408 { 1409 msg_home_replace_attr(fname, 0); 1410 } 1411 1412 #if defined(FEAT_FIND_ID) || defined(PROTO) 1413 void 1414 msg_home_replace_hl(char_u *fname) 1415 { 1416 msg_home_replace_attr(fname, HL_ATTR(HLF_D)); 1417 } 1418 #endif 1419 1420 static void 1421 msg_home_replace_attr(char_u *fname, int attr) 1422 { 1423 char_u *name; 1424 1425 name = home_replace_save(NULL, fname); 1426 if (name != NULL) 1427 msg_outtrans_attr(name, attr); 1428 vim_free(name); 1429 } 1430 1431 /* 1432 * Output 'len' characters in 'str' (including NULs) with translation 1433 * if 'len' is -1, output upto a NUL character. 1434 * Use attributes 'attr'. 1435 * Return the number of characters it takes on the screen. 1436 */ 1437 int 1438 msg_outtrans(char_u *str) 1439 { 1440 return msg_outtrans_attr(str, 0); 1441 } 1442 1443 int 1444 msg_outtrans_attr(char_u *str, int attr) 1445 { 1446 return msg_outtrans_len_attr(str, (int)STRLEN(str), attr); 1447 } 1448 1449 int 1450 msg_outtrans_len(char_u *str, int len) 1451 { 1452 return msg_outtrans_len_attr(str, len, 0); 1453 } 1454 1455 /* 1456 * Output one character at "p". Return pointer to the next character. 1457 * Handles multi-byte characters. 1458 */ 1459 char_u * 1460 msg_outtrans_one(char_u *p, int attr) 1461 { 1462 int l; 1463 1464 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1) 1465 { 1466 msg_outtrans_len_attr(p, l, attr); 1467 return p + l; 1468 } 1469 msg_puts_attr((char *)transchar_byte(*p), attr); 1470 return p + 1; 1471 } 1472 1473 int 1474 msg_outtrans_len_attr(char_u *msgstr, int len, int attr) 1475 { 1476 int retval = 0; 1477 char_u *str = msgstr; 1478 char_u *plain_start = msgstr; 1479 char_u *s; 1480 int mb_l; 1481 int c; 1482 1483 /* if MSG_HIST flag set, add message to history */ 1484 if (attr & MSG_HIST) 1485 { 1486 add_msg_hist(str, len, attr); 1487 attr &= ~MSG_HIST; 1488 } 1489 1490 /* If the string starts with a composing character first draw a space on 1491 * which the composing char can be drawn. */ 1492 if (enc_utf8 && utf_iscomposing(utf_ptr2char(msgstr))) 1493 msg_puts_attr(" ", attr); 1494 1495 /* 1496 * Go over the string. Special characters are translated and printed. 1497 * Normal characters are printed several at a time. 1498 */ 1499 while (--len >= 0) 1500 { 1501 if (enc_utf8) 1502 /* Don't include composing chars after the end. */ 1503 mb_l = utfc_ptr2len_len(str, len + 1); 1504 else if (has_mbyte) 1505 mb_l = (*mb_ptr2len)(str); 1506 else 1507 mb_l = 1; 1508 if (has_mbyte && mb_l > 1) 1509 { 1510 c = (*mb_ptr2char)(str); 1511 if (vim_isprintc(c)) 1512 /* printable multi-byte char: count the cells. */ 1513 retval += (*mb_ptr2cells)(str); 1514 else 1515 { 1516 /* unprintable multi-byte char: print the printable chars so 1517 * far and the translation of the unprintable char. */ 1518 if (str > plain_start) 1519 msg_puts_attr_len((char *)plain_start, 1520 (int)(str - plain_start), attr); 1521 plain_start = str + mb_l; 1522 msg_puts_attr((char *)transchar(c), 1523 attr == 0 ? HL_ATTR(HLF_8) : attr); 1524 retval += char2cells(c); 1525 } 1526 len -= mb_l - 1; 1527 str += mb_l; 1528 } 1529 else 1530 { 1531 s = transchar_byte(*str); 1532 if (s[1] != NUL) 1533 { 1534 /* unprintable char: print the printable chars so far and the 1535 * translation of the unprintable char. */ 1536 if (str > plain_start) 1537 msg_puts_attr_len((char *)plain_start, 1538 (int)(str - plain_start), attr); 1539 plain_start = str + 1; 1540 msg_puts_attr((char *)s, attr == 0 ? HL_ATTR(HLF_8) : attr); 1541 retval += (int)STRLEN(s); 1542 } 1543 else 1544 ++retval; 1545 ++str; 1546 } 1547 } 1548 1549 if (str > plain_start) 1550 /* print the printable chars at the end */ 1551 msg_puts_attr_len((char *)plain_start, (int)(str - plain_start), attr); 1552 1553 return retval; 1554 } 1555 1556 #if defined(FEAT_QUICKFIX) || defined(PROTO) 1557 void 1558 msg_make(char_u *arg) 1559 { 1560 int i; 1561 static char_u *str = (char_u *)"eeffoc", *rs = (char_u *)"Plon#dqg#vxjduB"; 1562 1563 arg = skipwhite(arg); 1564 for (i = 5; *arg && i >= 0; --i) 1565 if (*arg++ != str[i]) 1566 break; 1567 if (i < 0) 1568 { 1569 msg_putchar('\n'); 1570 for (i = 0; rs[i]; ++i) 1571 msg_putchar(rs[i] - 3); 1572 } 1573 } 1574 #endif 1575 1576 /* 1577 * Output the string 'str' upto a NUL character. 1578 * Return the number of characters it takes on the screen. 1579 * 1580 * If K_SPECIAL is encountered, then it is taken in conjunction with the 1581 * following character and shown as <F1>, <S-Up> etc. Any other character 1582 * which is not printable shown in <> form. 1583 * If 'from' is TRUE (lhs of a mapping), a space is shown as <Space>. 1584 * If a character is displayed in one of these special ways, is also 1585 * highlighted (its highlight name is '8' in the p_hl variable). 1586 * Otherwise characters are not highlighted. 1587 * This function is used to show mappings, where we want to see how to type 1588 * the character/string -- webb 1589 */ 1590 int 1591 msg_outtrans_special( 1592 char_u *strstart, 1593 int from) /* TRUE for lhs of a mapping */ 1594 { 1595 char_u *str = strstart; 1596 int retval = 0; 1597 char *text; 1598 int attr; 1599 int len; 1600 1601 attr = HL_ATTR(HLF_8); 1602 while (*str != NUL) 1603 { 1604 /* Leading and trailing spaces need to be displayed in <> form. */ 1605 if ((str == strstart || str[1] == NUL) && *str == ' ') 1606 { 1607 text = "<Space>"; 1608 ++str; 1609 } 1610 else 1611 text = (char *)str2special(&str, from); 1612 len = vim_strsize((char_u *)text); 1613 /* Highlight special keys */ 1614 msg_puts_attr(text, len > 1 1615 && (*mb_ptr2len)((char_u *)text) <= 1 ? attr : 0); 1616 retval += len; 1617 } 1618 return retval; 1619 } 1620 1621 #if defined(FEAT_EVAL) || defined(PROTO) 1622 /* 1623 * Return the lhs or rhs of a mapping, with the key codes turned into printable 1624 * strings, in an allocated string. 1625 */ 1626 char_u * 1627 str2special_save( 1628 char_u *str, 1629 int is_lhs) /* TRUE for lhs, FALSE for rhs */ 1630 { 1631 garray_T ga; 1632 char_u *p = str; 1633 1634 ga_init2(&ga, 1, 40); 1635 while (*p != NUL) 1636 ga_concat(&ga, str2special(&p, is_lhs)); 1637 ga_append(&ga, NUL); 1638 return (char_u *)ga.ga_data; 1639 } 1640 #endif 1641 1642 /* 1643 * Return the printable string for the key codes at "*sp". 1644 * Used for translating the lhs or rhs of a mapping to printable chars. 1645 * Advances "sp" to the next code. 1646 */ 1647 char_u * 1648 str2special( 1649 char_u **sp, 1650 int from) /* TRUE for lhs of mapping */ 1651 { 1652 int c; 1653 static char_u buf[7]; 1654 char_u *str = *sp; 1655 int modifiers = 0; 1656 int special = FALSE; 1657 1658 if (has_mbyte) 1659 { 1660 char_u *p; 1661 1662 /* Try to un-escape a multi-byte character. Return the un-escaped 1663 * string if it is a multi-byte character. */ 1664 p = mb_unescape(sp); 1665 if (p != NULL) 1666 return p; 1667 } 1668 1669 c = *str; 1670 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL) 1671 { 1672 if (str[1] == KS_MODIFIER) 1673 { 1674 modifiers = str[2]; 1675 str += 3; 1676 c = *str; 1677 } 1678 if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL) 1679 { 1680 c = TO_SPECIAL(str[1], str[2]); 1681 str += 2; 1682 } 1683 if (IS_SPECIAL(c) || modifiers) /* special key */ 1684 special = TRUE; 1685 } 1686 1687 if (has_mbyte && !IS_SPECIAL(c)) 1688 { 1689 int len = (*mb_ptr2len)(str); 1690 1691 /* For multi-byte characters check for an illegal byte. */ 1692 if (has_mbyte && MB_BYTE2LEN(*str) > len) 1693 { 1694 transchar_nonprint(buf, c); 1695 *sp = str + 1; 1696 return buf; 1697 } 1698 /* Since 'special' is TRUE the multi-byte character 'c' will be 1699 * processed by get_special_key_name() */ 1700 c = (*mb_ptr2char)(str); 1701 *sp = str + len; 1702 } 1703 else 1704 *sp = str + 1; 1705 1706 /* Make unprintable characters in <> form, also <M-Space> and <Tab>. 1707 * Use <Space> only for lhs of a mapping. */ 1708 if (special || char2cells(c) > 1 || (from && c == ' ')) 1709 return get_special_key_name(c, modifiers); 1710 buf[0] = c; 1711 buf[1] = NUL; 1712 return buf; 1713 } 1714 1715 /* 1716 * Translate a key sequence into special key names. 1717 */ 1718 void 1719 str2specialbuf(char_u *sp, char_u *buf, int len) 1720 { 1721 char_u *s; 1722 1723 *buf = NUL; 1724 while (*sp) 1725 { 1726 s = str2special(&sp, FALSE); 1727 if ((int)(STRLEN(s) + STRLEN(buf)) < len) 1728 STRCAT(buf, s); 1729 } 1730 } 1731 1732 /* 1733 * print line for :print or :list command 1734 */ 1735 void 1736 msg_prt_line(char_u *s, int list) 1737 { 1738 int c; 1739 int col = 0; 1740 int n_extra = 0; 1741 int c_extra = 0; 1742 int c_final = 0; 1743 char_u *p_extra = NULL; /* init to make SASC shut up */ 1744 int n; 1745 int attr = 0; 1746 char_u *trail = NULL; 1747 int l; 1748 char_u buf[MB_MAXBYTES + 1]; 1749 1750 if (curwin->w_p_list) 1751 list = TRUE; 1752 1753 /* find start of trailing whitespace */ 1754 if (list && lcs_trail) 1755 { 1756 trail = s + STRLEN(s); 1757 while (trail > s && VIM_ISWHITE(trail[-1])) 1758 --trail; 1759 } 1760 1761 /* output a space for an empty line, otherwise the line will be 1762 * overwritten */ 1763 if (*s == NUL && !(list && lcs_eol != NUL)) 1764 msg_putchar(' '); 1765 1766 while (!got_int) 1767 { 1768 if (n_extra > 0) 1769 { 1770 --n_extra; 1771 if (n_extra == 0 && c_final) 1772 c = c_final; 1773 else if (c_extra) 1774 c = c_extra; 1775 else 1776 c = *p_extra++; 1777 } 1778 else if (has_mbyte && (l = (*mb_ptr2len)(s)) > 1) 1779 { 1780 col += (*mb_ptr2cells)(s); 1781 if (lcs_nbsp != NUL && list 1782 && (mb_ptr2char(s) == 160 1783 || mb_ptr2char(s) == 0x202f)) 1784 { 1785 mb_char2bytes(lcs_nbsp, buf); 1786 buf[(*mb_ptr2len)(buf)] = NUL; 1787 } 1788 else 1789 { 1790 mch_memmove(buf, s, (size_t)l); 1791 buf[l] = NUL; 1792 } 1793 msg_puts((char *)buf); 1794 s += l; 1795 continue; 1796 } 1797 else 1798 { 1799 attr = 0; 1800 c = *s++; 1801 if (c == TAB && (!list || lcs_tab1)) 1802 { 1803 /* tab amount depends on current column */ 1804 #ifdef FEAT_VARTABS 1805 n_extra = tabstop_padding(col, curbuf->b_p_ts, 1806 curbuf->b_p_vts_array) - 1; 1807 #else 1808 n_extra = curbuf->b_p_ts - col % curbuf->b_p_ts - 1; 1809 #endif 1810 if (!list) 1811 { 1812 c = ' '; 1813 c_extra = ' '; 1814 c_final = NUL; 1815 } 1816 else 1817 { 1818 c = (n_extra == 0 && lcs_tab3) ? lcs_tab3 : lcs_tab1; 1819 c_extra = lcs_tab2; 1820 c_final = lcs_tab3; 1821 attr = HL_ATTR(HLF_8); 1822 } 1823 } 1824 else if (c == 160 && list && lcs_nbsp != NUL) 1825 { 1826 c = lcs_nbsp; 1827 attr = HL_ATTR(HLF_8); 1828 } 1829 else if (c == NUL && list && lcs_eol != NUL) 1830 { 1831 p_extra = (char_u *)""; 1832 c_extra = NUL; 1833 c_final = NUL; 1834 n_extra = 1; 1835 c = lcs_eol; 1836 attr = HL_ATTR(HLF_AT); 1837 --s; 1838 } 1839 else if (c != NUL && (n = byte2cells(c)) > 1) 1840 { 1841 n_extra = n - 1; 1842 p_extra = transchar_byte(c); 1843 c_extra = NUL; 1844 c_final = NUL; 1845 c = *p_extra++; 1846 /* Use special coloring to be able to distinguish <hex> from 1847 * the same in plain text. */ 1848 attr = HL_ATTR(HLF_8); 1849 } 1850 else if (c == ' ' && trail != NULL && s > trail) 1851 { 1852 c = lcs_trail; 1853 attr = HL_ATTR(HLF_8); 1854 } 1855 else if (c == ' ' && list && lcs_space != NUL) 1856 { 1857 c = lcs_space; 1858 attr = HL_ATTR(HLF_8); 1859 } 1860 } 1861 1862 if (c == NUL) 1863 break; 1864 1865 msg_putchar_attr(c, attr); 1866 col++; 1867 } 1868 msg_clr_eos(); 1869 } 1870 1871 /* 1872 * Use screen_puts() to output one multi-byte character. 1873 * Return the pointer "s" advanced to the next character. 1874 */ 1875 static char_u * 1876 screen_puts_mbyte(char_u *s, int l, int attr) 1877 { 1878 int cw; 1879 1880 msg_didout = TRUE; /* remember that line is not empty */ 1881 cw = (*mb_ptr2cells)(s); 1882 if (cw > 1 && ( 1883 #ifdef FEAT_RIGHTLEFT 1884 cmdmsg_rl ? msg_col <= 1 : 1885 #endif 1886 msg_col == Columns - 1)) 1887 { 1888 /* Doesn't fit, print a highlighted '>' to fill it up. */ 1889 msg_screen_putchar('>', HL_ATTR(HLF_AT)); 1890 return s; 1891 } 1892 1893 screen_puts_len(s, l, msg_row, msg_col, attr); 1894 #ifdef FEAT_RIGHTLEFT 1895 if (cmdmsg_rl) 1896 { 1897 msg_col -= cw; 1898 if (msg_col == 0) 1899 { 1900 msg_col = Columns; 1901 ++msg_row; 1902 } 1903 } 1904 else 1905 #endif 1906 { 1907 msg_col += cw; 1908 if (msg_col >= Columns) 1909 { 1910 msg_col = 0; 1911 ++msg_row; 1912 } 1913 } 1914 return s + l; 1915 } 1916 1917 /* 1918 * Output a string to the screen at position msg_row, msg_col. 1919 * Update msg_row and msg_col for the next message. 1920 */ 1921 void 1922 msg_puts(char *s) 1923 { 1924 msg_puts_attr(s, 0); 1925 } 1926 1927 void 1928 msg_puts_title(char *s) 1929 { 1930 msg_puts_attr(s, HL_ATTR(HLF_T)); 1931 } 1932 1933 /* 1934 * Show a message in such a way that it always fits in the line. Cut out a 1935 * part in the middle and replace it with "..." when necessary. 1936 * Does not handle multi-byte characters! 1937 */ 1938 void 1939 msg_outtrans_long_attr(char_u *longstr, int attr) 1940 { 1941 msg_outtrans_long_len_attr(longstr, (int)STRLEN(longstr), attr); 1942 } 1943 1944 void 1945 msg_outtrans_long_len_attr(char_u *longstr, int len, int attr) 1946 { 1947 int slen = len; 1948 int room; 1949 1950 room = Columns - msg_col; 1951 if (len > room && room >= 20) 1952 { 1953 slen = (room - 3) / 2; 1954 msg_outtrans_len_attr(longstr, slen, attr); 1955 msg_puts_attr("...", HL_ATTR(HLF_8)); 1956 } 1957 msg_outtrans_len_attr(longstr + len - slen, slen, attr); 1958 } 1959 1960 /* 1961 * Basic function for writing a message with highlight attributes. 1962 */ 1963 void 1964 msg_puts_attr(char *s, int attr) 1965 { 1966 msg_puts_attr_len(s, -1, attr); 1967 } 1968 1969 /* 1970 * Like msg_puts_attr(), but with a maximum length "maxlen" (in bytes). 1971 * When "maxlen" is -1 there is no maximum length. 1972 * When "maxlen" is >= 0 the message is not put in the history. 1973 */ 1974 static void 1975 msg_puts_attr_len(char *str, int maxlen, int attr) 1976 { 1977 /* 1978 * If redirection is on, also write to the redirection file. 1979 */ 1980 redir_write((char_u *)str, maxlen); 1981 1982 /* 1983 * Don't print anything when using ":silent cmd". 1984 */ 1985 if (msg_silent != 0) 1986 return; 1987 1988 /* if MSG_HIST flag set, add message to history */ 1989 if ((attr & MSG_HIST) && maxlen < 0) 1990 { 1991 add_msg_hist((char_u *)str, -1, attr); 1992 attr &= ~MSG_HIST; 1993 } 1994 1995 /* 1996 * When writing something to the screen after it has scrolled, requires a 1997 * wait-return prompt later. Needed when scrolling, resetting 1998 * need_wait_return after some prompt, and then outputting something 1999 * without scrolling 2000 */ 2001 if (msg_scrolled != 0 && !msg_scrolled_ign) 2002 need_wait_return = TRUE; 2003 msg_didany = TRUE; /* remember that something was outputted */ 2004 2005 /* 2006 * If there is no valid screen, use fprintf so we can see error messages. 2007 * If termcap is not active, we may be writing in an alternate console 2008 * window, cursor positioning may not work correctly (window size may be 2009 * different, e.g. for Win32 console) or we just don't know where the 2010 * cursor is. 2011 */ 2012 if (msg_use_printf()) 2013 msg_puts_printf((char_u *)str, maxlen); 2014 else 2015 msg_puts_display((char_u *)str, maxlen, attr, FALSE); 2016 } 2017 2018 /* 2019 * The display part of msg_puts_attr_len(). 2020 * May be called recursively to display scroll-back text. 2021 */ 2022 static void 2023 msg_puts_display( 2024 char_u *str, 2025 int maxlen, 2026 int attr, 2027 int recurse) 2028 { 2029 char_u *s = str; 2030 char_u *t_s = str; /* string from "t_s" to "s" is still todo */ 2031 int t_col = 0; /* screen cells todo, 0 when "t_s" not used */ 2032 int l; 2033 int cw; 2034 char_u *sb_str = str; 2035 int sb_col = msg_col; 2036 int wrap; 2037 int did_last_char; 2038 2039 did_wait_return = FALSE; 2040 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL) 2041 { 2042 /* 2043 * We are at the end of the screen line when: 2044 * - When outputting a newline. 2045 * - When outputting a character in the last column. 2046 */ 2047 if (!recurse && msg_row >= Rows - 1 && (*s == '\n' || ( 2048 #ifdef FEAT_RIGHTLEFT 2049 cmdmsg_rl 2050 ? ( 2051 msg_col <= 1 2052 || (*s == TAB && msg_col <= 7) 2053 || (has_mbyte && (*mb_ptr2cells)(s) > 1 && msg_col <= 2)) 2054 : 2055 #endif 2056 (msg_col + t_col >= Columns - 1 2057 || (*s == TAB && msg_col + t_col >= ((Columns - 1) & ~7)) 2058 || (has_mbyte && (*mb_ptr2cells)(s) > 1 2059 && msg_col + t_col >= Columns - 2))))) 2060 { 2061 /* 2062 * The screen is scrolled up when at the last row (some terminals 2063 * scroll automatically, some don't. To avoid problems we scroll 2064 * ourselves). 2065 */ 2066 if (t_col > 0) 2067 /* output postponed text */ 2068 t_puts(&t_col, t_s, s, attr); 2069 2070 /* When no more prompt and no more room, truncate here */ 2071 if (msg_no_more && lines_left == 0) 2072 break; 2073 2074 /* Scroll the screen up one line. */ 2075 msg_scroll_up(); 2076 2077 msg_row = Rows - 2; 2078 if (msg_col >= Columns) /* can happen after screen resize */ 2079 msg_col = Columns - 1; 2080 2081 /* Display char in last column before showing more-prompt. */ 2082 if (*s >= ' ' 2083 #ifdef FEAT_RIGHTLEFT 2084 && !cmdmsg_rl 2085 #endif 2086 ) 2087 { 2088 if (has_mbyte) 2089 { 2090 if (enc_utf8 && maxlen >= 0) 2091 /* avoid including composing chars after the end */ 2092 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s)); 2093 else 2094 l = (*mb_ptr2len)(s); 2095 s = screen_puts_mbyte(s, l, attr); 2096 } 2097 else 2098 msg_screen_putchar(*s++, attr); 2099 did_last_char = TRUE; 2100 } 2101 else 2102 did_last_char = FALSE; 2103 2104 if (p_more) 2105 /* store text for scrolling back */ 2106 store_sb_text(&sb_str, s, attr, &sb_col, TRUE); 2107 2108 inc_msg_scrolled(); 2109 need_wait_return = TRUE; /* may need wait_return in main() */ 2110 redraw_cmdline = TRUE; 2111 if (cmdline_row > 0 && !exmode_active) 2112 --cmdline_row; 2113 2114 /* 2115 * If screen is completely filled and 'more' is set then wait 2116 * for a character. 2117 */ 2118 if (lines_left > 0) 2119 --lines_left; 2120 if (p_more && lines_left == 0 && State != HITRETURN 2121 && !msg_no_more && !exmode_active) 2122 { 2123 #ifdef FEAT_CON_DIALOG 2124 if (do_more_prompt(NUL)) 2125 s = confirm_msg_tail; 2126 #else 2127 (void)do_more_prompt(NUL); 2128 #endif 2129 if (quit_more) 2130 return; 2131 } 2132 2133 /* When we displayed a char in last column need to check if there 2134 * is still more. */ 2135 if (did_last_char) 2136 continue; 2137 } 2138 2139 wrap = *s == '\n' 2140 || msg_col + t_col >= Columns 2141 || (has_mbyte && (*mb_ptr2cells)(s) > 1 2142 && msg_col + t_col >= Columns - 1); 2143 if (t_col > 0 && (wrap || *s == '\r' || *s == '\b' 2144 || *s == '\t' || *s == BELL)) 2145 /* output any postponed text */ 2146 t_puts(&t_col, t_s, s, attr); 2147 2148 if (wrap && p_more && !recurse) 2149 /* store text for scrolling back */ 2150 store_sb_text(&sb_str, s, attr, &sb_col, TRUE); 2151 2152 if (*s == '\n') /* go to next line */ 2153 { 2154 msg_didout = FALSE; /* remember that line is empty */ 2155 #ifdef FEAT_RIGHTLEFT 2156 if (cmdmsg_rl) 2157 msg_col = Columns - 1; 2158 else 2159 #endif 2160 msg_col = 0; 2161 if (++msg_row >= Rows) /* safety check */ 2162 msg_row = Rows - 1; 2163 } 2164 else if (*s == '\r') /* go to column 0 */ 2165 { 2166 msg_col = 0; 2167 } 2168 else if (*s == '\b') /* go to previous char */ 2169 { 2170 if (msg_col) 2171 --msg_col; 2172 } 2173 else if (*s == TAB) /* translate Tab into spaces */ 2174 { 2175 do 2176 msg_screen_putchar(' ', attr); 2177 while (msg_col & 7); 2178 } 2179 else if (*s == BELL) /* beep (from ":sh") */ 2180 vim_beep(BO_SH); 2181 else 2182 { 2183 if (has_mbyte) 2184 { 2185 cw = (*mb_ptr2cells)(s); 2186 if (enc_utf8 && maxlen >= 0) 2187 /* avoid including composing chars after the end */ 2188 l = utfc_ptr2len_len(s, (int)((str + maxlen) - s)); 2189 else 2190 l = (*mb_ptr2len)(s); 2191 } 2192 else 2193 { 2194 cw = 1; 2195 l = 1; 2196 } 2197 2198 /* When drawing from right to left or when a double-wide character 2199 * doesn't fit, draw a single character here. Otherwise collect 2200 * characters and draw them all at once later. */ 2201 if ( 2202 # ifdef FEAT_RIGHTLEFT 2203 cmdmsg_rl || 2204 # endif 2205 (cw > 1 && msg_col + t_col >= Columns - 1)) 2206 { 2207 if (l > 1) 2208 s = screen_puts_mbyte(s, l, attr) - 1; 2209 else 2210 msg_screen_putchar(*s, attr); 2211 } 2212 else 2213 { 2214 /* postpone this character until later */ 2215 if (t_col == 0) 2216 t_s = s; 2217 t_col += cw; 2218 s += l - 1; 2219 } 2220 } 2221 ++s; 2222 } 2223 2224 /* output any postponed text */ 2225 if (t_col > 0) 2226 t_puts(&t_col, t_s, s, attr); 2227 if (p_more && !recurse) 2228 store_sb_text(&sb_str, s, attr, &sb_col, FALSE); 2229 2230 msg_check(); 2231 } 2232 2233 /* 2234 * Return TRUE when ":filter pattern" was used and "msg" does not match 2235 * "pattern". 2236 */ 2237 int 2238 message_filtered(char_u *msg) 2239 { 2240 int match; 2241 2242 if (cmdmod.filter_regmatch.regprog == NULL) 2243 return FALSE; 2244 match = vim_regexec(&cmdmod.filter_regmatch, msg, (colnr_T)0); 2245 return cmdmod.filter_force ? match : !match; 2246 } 2247 2248 /* 2249 * Scroll the screen up one line for displaying the next message line. 2250 */ 2251 static void 2252 msg_scroll_up(void) 2253 { 2254 #ifdef FEAT_GUI 2255 /* Remove the cursor before scrolling, ScreenLines[] is going 2256 * to become invalid. */ 2257 if (gui.in_use) 2258 gui_undraw_cursor(); 2259 #endif 2260 /* scrolling up always works */ 2261 mch_disable_flush(); 2262 screen_del_lines(0, 0, 1, (int)Rows, TRUE, 0, NULL); 2263 mch_enable_flush(); 2264 2265 if (!can_clear((char_u *)" ")) 2266 { 2267 /* Scrolling up doesn't result in the right background. Set the 2268 * background here. It's not efficient, but avoids that we have to do 2269 * it all over the code. */ 2270 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0); 2271 2272 /* Also clear the last char of the last but one line if it was not 2273 * cleared before to avoid a scroll-up. */ 2274 if (ScreenAttrs[LineOffset[Rows - 2] + Columns - 1] == (sattr_T)-1) 2275 screen_fill((int)Rows - 2, (int)Rows - 1, 2276 (int)Columns - 1, (int)Columns, ' ', ' ', 0); 2277 } 2278 } 2279 2280 /* 2281 * Increment "msg_scrolled". 2282 */ 2283 static void 2284 inc_msg_scrolled(void) 2285 { 2286 #ifdef FEAT_EVAL 2287 if (*get_vim_var_str(VV_SCROLLSTART) == NUL) 2288 { 2289 char_u *p = sourcing_name; 2290 char_u *tofree = NULL; 2291 int len; 2292 2293 /* v:scrollstart is empty, set it to the script/function name and line 2294 * number */ 2295 if (p == NULL) 2296 p = (char_u *)_("Unknown"); 2297 else 2298 { 2299 len = (int)STRLEN(p) + 40; 2300 tofree = alloc(len); 2301 if (tofree != NULL) 2302 { 2303 vim_snprintf((char *)tofree, len, _("%s line %ld"), 2304 p, (long)sourcing_lnum); 2305 p = tofree; 2306 } 2307 } 2308 set_vim_var_string(VV_SCROLLSTART, p, -1); 2309 vim_free(tofree); 2310 } 2311 #endif 2312 ++msg_scrolled; 2313 if (must_redraw < VALID) 2314 must_redraw = VALID; 2315 } 2316 2317 /* 2318 * To be able to scroll back at the "more" and "hit-enter" prompts we need to 2319 * store the displayed text and remember where screen lines start. 2320 */ 2321 typedef struct msgchunk_S msgchunk_T; 2322 struct msgchunk_S 2323 { 2324 msgchunk_T *sb_next; 2325 msgchunk_T *sb_prev; 2326 char sb_eol; /* TRUE when line ends after this text */ 2327 int sb_msg_col; /* column in which text starts */ 2328 int sb_attr; /* text attributes */ 2329 char_u sb_text[1]; /* text to be displayed, actually longer */ 2330 }; 2331 2332 static msgchunk_T *last_msgchunk = NULL; /* last displayed text */ 2333 2334 static msgchunk_T *msg_sb_start(msgchunk_T *mps); 2335 2336 typedef enum { 2337 SB_CLEAR_NONE = 0, 2338 SB_CLEAR_ALL, 2339 SB_CLEAR_CMDLINE_BUSY, 2340 SB_CLEAR_CMDLINE_DONE 2341 } sb_clear_T; 2342 2343 /* When to clear text on next msg. */ 2344 static sb_clear_T do_clear_sb_text = SB_CLEAR_NONE; 2345 2346 /* 2347 * Store part of a printed message for displaying when scrolling back. 2348 */ 2349 static void 2350 store_sb_text( 2351 char_u **sb_str, /* start of string */ 2352 char_u *s, /* just after string */ 2353 int attr, 2354 int *sb_col, 2355 int finish) /* line ends */ 2356 { 2357 msgchunk_T *mp; 2358 2359 if (do_clear_sb_text == SB_CLEAR_ALL 2360 || do_clear_sb_text == SB_CLEAR_CMDLINE_DONE) 2361 { 2362 clear_sb_text(do_clear_sb_text == SB_CLEAR_ALL); 2363 do_clear_sb_text = SB_CLEAR_NONE; 2364 } 2365 2366 if (s > *sb_str) 2367 { 2368 mp = (msgchunk_T *)alloc((int)(sizeof(msgchunk_T) + (s - *sb_str))); 2369 if (mp != NULL) 2370 { 2371 mp->sb_eol = finish; 2372 mp->sb_msg_col = *sb_col; 2373 mp->sb_attr = attr; 2374 vim_strncpy(mp->sb_text, *sb_str, s - *sb_str); 2375 2376 if (last_msgchunk == NULL) 2377 { 2378 last_msgchunk = mp; 2379 mp->sb_prev = NULL; 2380 } 2381 else 2382 { 2383 mp->sb_prev = last_msgchunk; 2384 last_msgchunk->sb_next = mp; 2385 last_msgchunk = mp; 2386 } 2387 mp->sb_next = NULL; 2388 } 2389 } 2390 else if (finish && last_msgchunk != NULL) 2391 last_msgchunk->sb_eol = TRUE; 2392 2393 *sb_str = s; 2394 *sb_col = 0; 2395 } 2396 2397 /* 2398 * Finished showing messages, clear the scroll-back text on the next message. 2399 */ 2400 void 2401 may_clear_sb_text(void) 2402 { 2403 do_clear_sb_text = SB_CLEAR_ALL; 2404 } 2405 2406 /* 2407 * Starting to edit the command line, do not clear messages now. 2408 */ 2409 void 2410 sb_text_start_cmdline(void) 2411 { 2412 do_clear_sb_text = SB_CLEAR_CMDLINE_BUSY; 2413 msg_sb_eol(); 2414 } 2415 2416 /* 2417 * Ending to edit the command line. Clear old lines but the last one later. 2418 */ 2419 void 2420 sb_text_end_cmdline(void) 2421 { 2422 do_clear_sb_text = SB_CLEAR_CMDLINE_DONE; 2423 } 2424 2425 /* 2426 * Clear any text remembered for scrolling back. 2427 * When "all" is FALSE keep the last line. 2428 * Called when redrawing the screen. 2429 */ 2430 void 2431 clear_sb_text(int all) 2432 { 2433 msgchunk_T *mp; 2434 msgchunk_T **lastp; 2435 2436 if (all) 2437 lastp = &last_msgchunk; 2438 else 2439 { 2440 if (last_msgchunk == NULL) 2441 return; 2442 lastp = &last_msgchunk->sb_prev; 2443 } 2444 2445 while (*lastp != NULL) 2446 { 2447 mp = (*lastp)->sb_prev; 2448 vim_free(*lastp); 2449 *lastp = mp; 2450 } 2451 } 2452 2453 /* 2454 * "g<" command. 2455 */ 2456 void 2457 show_sb_text(void) 2458 { 2459 msgchunk_T *mp; 2460 2461 /* Only show something if there is more than one line, otherwise it looks 2462 * weird, typing a command without output results in one line. */ 2463 mp = msg_sb_start(last_msgchunk); 2464 if (mp == NULL || mp->sb_prev == NULL) 2465 vim_beep(BO_MESS); 2466 else 2467 { 2468 do_more_prompt('G'); 2469 wait_return(FALSE); 2470 } 2471 } 2472 2473 /* 2474 * Move to the start of screen line in already displayed text. 2475 */ 2476 static msgchunk_T * 2477 msg_sb_start(msgchunk_T *mps) 2478 { 2479 msgchunk_T *mp = mps; 2480 2481 while (mp != NULL && mp->sb_prev != NULL && !mp->sb_prev->sb_eol) 2482 mp = mp->sb_prev; 2483 return mp; 2484 } 2485 2486 /* 2487 * Mark the last message chunk as finishing the line. 2488 */ 2489 void 2490 msg_sb_eol(void) 2491 { 2492 if (last_msgchunk != NULL) 2493 last_msgchunk->sb_eol = TRUE; 2494 } 2495 2496 /* 2497 * Display a screen line from previously displayed text at row "row". 2498 * Returns a pointer to the text for the next line (can be NULL). 2499 */ 2500 static msgchunk_T * 2501 disp_sb_line(int row, msgchunk_T *smp) 2502 { 2503 msgchunk_T *mp = smp; 2504 char_u *p; 2505 2506 for (;;) 2507 { 2508 msg_row = row; 2509 msg_col = mp->sb_msg_col; 2510 p = mp->sb_text; 2511 if (*p == '\n') /* don't display the line break */ 2512 ++p; 2513 msg_puts_display(p, -1, mp->sb_attr, TRUE); 2514 if (mp->sb_eol || mp->sb_next == NULL) 2515 break; 2516 mp = mp->sb_next; 2517 } 2518 return mp->sb_next; 2519 } 2520 2521 /* 2522 * Output any postponed text for msg_puts_attr_len(). 2523 */ 2524 static void 2525 t_puts( 2526 int *t_col, 2527 char_u *t_s, 2528 char_u *s, 2529 int attr) 2530 { 2531 /* output postponed text */ 2532 msg_didout = TRUE; /* remember that line is not empty */ 2533 screen_puts_len(t_s, (int)(s - t_s), msg_row, msg_col, attr); 2534 msg_col += *t_col; 2535 *t_col = 0; 2536 /* If the string starts with a composing character don't increment the 2537 * column position for it. */ 2538 if (enc_utf8 && utf_iscomposing(utf_ptr2char(t_s))) 2539 --msg_col; 2540 if (msg_col >= Columns) 2541 { 2542 msg_col = 0; 2543 ++msg_row; 2544 } 2545 } 2546 2547 /* 2548 * Returns TRUE when messages should be printed with mch_errmsg(). 2549 * This is used when there is no valid screen, so we can see error messages. 2550 * If termcap is not active, we may be writing in an alternate console 2551 * window, cursor positioning may not work correctly (window size may be 2552 * different, e.g. for Win32 console) or we just don't know where the 2553 * cursor is. 2554 */ 2555 int 2556 msg_use_printf(void) 2557 { 2558 return (!msg_check_screen() 2559 #if defined(WIN3264) && !defined(FEAT_GUI_MSWIN) 2560 || !termcap_active 2561 #endif 2562 || (swapping_screen() && !termcap_active) 2563 ); 2564 } 2565 2566 /* 2567 * Print a message when there is no valid screen. 2568 */ 2569 static void 2570 msg_puts_printf(char_u *str, int maxlen) 2571 { 2572 char_u *s = str; 2573 char_u buf[4]; 2574 char_u *p; 2575 #ifdef WIN3264 2576 # if !defined(FEAT_GUI_MSWIN) 2577 char_u *ccp = NULL; 2578 2579 # endif 2580 if (!(silent_mode && p_verbose == 0)) 2581 mch_settmode(TMODE_COOK); /* handle '\r' and '\n' correctly */ 2582 2583 # if !defined(FEAT_GUI_MSWIN) 2584 if (enc_codepage >= 0 && (int)GetConsoleCP() != enc_codepage) 2585 { 2586 int inlen = (int)STRLEN(str); 2587 int outlen; 2588 WCHAR *widestr = (WCHAR *)enc_to_utf16(str, &inlen); 2589 2590 if (widestr != NULL) 2591 { 2592 WideCharToMultiByte_alloc(GetConsoleCP(), 0, widestr, inlen, 2593 (LPSTR *)&ccp, &outlen, 0, 0); 2594 vim_free(widestr); 2595 s = str = ccp; 2596 } 2597 } 2598 # endif 2599 #endif 2600 while ((maxlen < 0 || (int)(s - str) < maxlen) && *s != NUL) 2601 { 2602 if (!(silent_mode && p_verbose == 0)) 2603 { 2604 /* NL --> CR NL translation (for Unix, not for "--version") */ 2605 p = &buf[0]; 2606 if (*s == '\n' && !info_message) 2607 *p++ = '\r'; 2608 #if defined(USE_CR) 2609 else 2610 #endif 2611 *p++ = *s; 2612 *p = '\0'; 2613 if (info_message) /* informative message, not an error */ 2614 mch_msg((char *)buf); 2615 else 2616 mch_errmsg((char *)buf); 2617 } 2618 2619 /* primitive way to compute the current column */ 2620 #ifdef FEAT_RIGHTLEFT 2621 if (cmdmsg_rl) 2622 { 2623 if (*s == '\r' || *s == '\n') 2624 msg_col = Columns - 1; 2625 else 2626 --msg_col; 2627 } 2628 else 2629 #endif 2630 { 2631 if (*s == '\r' || *s == '\n') 2632 msg_col = 0; 2633 else 2634 ++msg_col; 2635 } 2636 ++s; 2637 } 2638 msg_didout = TRUE; /* assume that line is not empty */ 2639 2640 #ifdef WIN3264 2641 # if !defined(FEAT_GUI_MSWIN) 2642 vim_free(ccp); 2643 # endif 2644 if (!(silent_mode && p_verbose == 0)) 2645 mch_settmode(TMODE_RAW); 2646 #endif 2647 } 2648 2649 /* 2650 * Show the more-prompt and handle the user response. 2651 * This takes care of scrolling back and displaying previously displayed text. 2652 * When at hit-enter prompt "typed_char" is the already typed character, 2653 * otherwise it's NUL. 2654 * Returns TRUE when jumping ahead to "confirm_msg_tail". 2655 */ 2656 static int 2657 do_more_prompt(int typed_char) 2658 { 2659 static int entered = FALSE; 2660 int used_typed_char = typed_char; 2661 int oldState = State; 2662 int c; 2663 #ifdef FEAT_CON_DIALOG 2664 int retval = FALSE; 2665 #endif 2666 int toscroll; 2667 msgchunk_T *mp_last = NULL; 2668 msgchunk_T *mp; 2669 int i; 2670 2671 /* We get called recursively when a timer callback outputs a message. In 2672 * that case don't show another prompt. Also when at the hit-Enter prompt 2673 * and nothing was typed. */ 2674 if (entered || (State == HITRETURN && typed_char == 0)) 2675 return FALSE; 2676 entered = TRUE; 2677 2678 if (typed_char == 'G') 2679 { 2680 /* "g<": Find first line on the last page. */ 2681 mp_last = msg_sb_start(last_msgchunk); 2682 for (i = 0; i < Rows - 2 && mp_last != NULL 2683 && mp_last->sb_prev != NULL; ++i) 2684 mp_last = msg_sb_start(mp_last->sb_prev); 2685 } 2686 2687 State = ASKMORE; 2688 #ifdef FEAT_MOUSE 2689 setmouse(); 2690 #endif 2691 if (typed_char == NUL) 2692 msg_moremsg(FALSE); 2693 for (;;) 2694 { 2695 /* 2696 * Get a typed character directly from the user. 2697 */ 2698 if (used_typed_char != NUL) 2699 { 2700 c = used_typed_char; /* was typed at hit-enter prompt */ 2701 used_typed_char = NUL; 2702 } 2703 else 2704 c = get_keystroke(); 2705 2706 #if defined(FEAT_MENU) && defined(FEAT_GUI) 2707 if (c == K_MENU) 2708 { 2709 int idx = get_menu_index(current_menu, ASKMORE); 2710 2711 /* Used a menu. If it starts with CTRL-Y, it must 2712 * be a "Copy" for the clipboard. Otherwise 2713 * assume that we end */ 2714 if (idx == MENU_INDEX_INVALID) 2715 continue; 2716 c = *current_menu->strings[idx]; 2717 if (c != NUL && current_menu->strings[idx][1] != NUL) 2718 ins_typebuf(current_menu->strings[idx] + 1, 2719 current_menu->noremap[idx], 0, TRUE, 2720 current_menu->silent[idx]); 2721 } 2722 #endif 2723 2724 toscroll = 0; 2725 switch (c) 2726 { 2727 case BS: /* scroll one line back */ 2728 case K_BS: 2729 case 'k': 2730 case K_UP: 2731 toscroll = -1; 2732 break; 2733 2734 case CAR: /* one extra line */ 2735 case NL: 2736 case 'j': 2737 case K_DOWN: 2738 toscroll = 1; 2739 break; 2740 2741 case 'u': /* Up half a page */ 2742 toscroll = -(Rows / 2); 2743 break; 2744 2745 case 'd': /* Down half a page */ 2746 toscroll = Rows / 2; 2747 break; 2748 2749 case 'b': /* one page back */ 2750 case K_PAGEUP: 2751 toscroll = -(Rows - 1); 2752 break; 2753 2754 case ' ': /* one extra page */ 2755 case 'f': 2756 case K_PAGEDOWN: 2757 case K_LEFTMOUSE: 2758 toscroll = Rows - 1; 2759 break; 2760 2761 case 'g': /* all the way back to the start */ 2762 toscroll = -999999; 2763 break; 2764 2765 case 'G': /* all the way to the end */ 2766 toscroll = 999999; 2767 lines_left = 999999; 2768 break; 2769 2770 case ':': /* start new command line */ 2771 #ifdef FEAT_CON_DIALOG 2772 if (!confirm_msg_used) 2773 #endif 2774 { 2775 /* Since got_int is set all typeahead will be flushed, but we 2776 * want to keep this ':', remember that in a special way. */ 2777 typeahead_noflush(':'); 2778 #ifdef FEAT_TERMINAL 2779 skip_term_loop = TRUE; 2780 #endif 2781 cmdline_row = Rows - 1; /* put ':' on this line */ 2782 skip_redraw = TRUE; /* skip redraw once */ 2783 need_wait_return = FALSE; /* don't wait in main() */ 2784 } 2785 /* FALLTHROUGH */ 2786 case 'q': /* quit */ 2787 case Ctrl_C: 2788 case ESC: 2789 #ifdef FEAT_CON_DIALOG 2790 if (confirm_msg_used) 2791 { 2792 /* Jump to the choices of the dialog. */ 2793 retval = TRUE; 2794 } 2795 else 2796 #endif 2797 { 2798 got_int = TRUE; 2799 quit_more = TRUE; 2800 } 2801 /* When there is some more output (wrapping line) display that 2802 * without another prompt. */ 2803 lines_left = Rows - 1; 2804 break; 2805 2806 #ifdef FEAT_CLIPBOARD 2807 case Ctrl_Y: 2808 /* Strange way to allow copying (yanking) a modeless 2809 * selection at the more prompt. Use CTRL-Y, 2810 * because the same is used in Cmdline-mode and at the 2811 * hit-enter prompt. However, scrolling one line up 2812 * might be expected... */ 2813 if (clip_star.state == SELECT_DONE) 2814 clip_copy_modeless_selection(TRUE); 2815 continue; 2816 #endif 2817 default: /* no valid response */ 2818 msg_moremsg(TRUE); 2819 continue; 2820 } 2821 2822 if (toscroll != 0) 2823 { 2824 if (toscroll < 0) 2825 { 2826 /* go to start of last line */ 2827 if (mp_last == NULL) 2828 mp = msg_sb_start(last_msgchunk); 2829 else if (mp_last->sb_prev != NULL) 2830 mp = msg_sb_start(mp_last->sb_prev); 2831 else 2832 mp = NULL; 2833 2834 /* go to start of line at top of the screen */ 2835 for (i = 0; i < Rows - 2 && mp != NULL && mp->sb_prev != NULL; 2836 ++i) 2837 mp = msg_sb_start(mp->sb_prev); 2838 2839 if (mp != NULL && mp->sb_prev != NULL) 2840 { 2841 /* Find line to be displayed at top. */ 2842 for (i = 0; i > toscroll; --i) 2843 { 2844 if (mp == NULL || mp->sb_prev == NULL) 2845 break; 2846 mp = msg_sb_start(mp->sb_prev); 2847 if (mp_last == NULL) 2848 mp_last = msg_sb_start(last_msgchunk); 2849 else 2850 mp_last = msg_sb_start(mp_last->sb_prev); 2851 } 2852 2853 if (toscroll == -1 && screen_ins_lines(0, 0, 1, 2854 (int)Rows, 0, NULL) == OK) 2855 { 2856 /* display line at top */ 2857 (void)disp_sb_line(0, mp); 2858 } 2859 else 2860 { 2861 /* redisplay all lines */ 2862 screenclear(); 2863 for (i = 0; mp != NULL && i < Rows - 1; ++i) 2864 { 2865 mp = disp_sb_line(i, mp); 2866 ++msg_scrolled; 2867 } 2868 } 2869 toscroll = 0; 2870 } 2871 } 2872 else 2873 { 2874 /* First display any text that we scrolled back. */ 2875 while (toscroll > 0 && mp_last != NULL) 2876 { 2877 /* scroll up, display line at bottom */ 2878 msg_scroll_up(); 2879 inc_msg_scrolled(); 2880 screen_fill((int)Rows - 2, (int)Rows - 1, 0, 2881 (int)Columns, ' ', ' ', 0); 2882 mp_last = disp_sb_line((int)Rows - 2, mp_last); 2883 --toscroll; 2884 } 2885 } 2886 2887 if (toscroll <= 0) 2888 { 2889 /* displayed the requested text, more prompt again */ 2890 screen_fill((int)Rows - 1, (int)Rows, 0, 2891 (int)Columns, ' ', ' ', 0); 2892 msg_moremsg(FALSE); 2893 continue; 2894 } 2895 2896 /* display more text, return to caller */ 2897 lines_left = toscroll; 2898 } 2899 2900 break; 2901 } 2902 2903 /* clear the --more-- message */ 2904 screen_fill((int)Rows - 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0); 2905 State = oldState; 2906 #ifdef FEAT_MOUSE 2907 setmouse(); 2908 #endif 2909 if (quit_more) 2910 { 2911 msg_row = Rows - 1; 2912 msg_col = 0; 2913 } 2914 #ifdef FEAT_RIGHTLEFT 2915 else if (cmdmsg_rl) 2916 msg_col = Columns - 1; 2917 #endif 2918 2919 entered = FALSE; 2920 #ifdef FEAT_CON_DIALOG 2921 return retval; 2922 #else 2923 return FALSE; 2924 #endif 2925 } 2926 2927 #if defined(USE_MCH_ERRMSG) || defined(PROTO) 2928 2929 #ifdef mch_errmsg 2930 # undef mch_errmsg 2931 #endif 2932 #ifdef mch_msg 2933 # undef mch_msg 2934 #endif 2935 2936 /* 2937 * Give an error message. To be used when the screen hasn't been initialized 2938 * yet. When stderr can't be used, collect error messages until the GUI has 2939 * started and they can be displayed in a message box. 2940 */ 2941 void 2942 mch_errmsg(char *str) 2943 { 2944 int len; 2945 2946 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) 2947 /* On Unix use stderr if it's a tty. 2948 * When not going to start the GUI also use stderr. 2949 * On Mac, when started from Finder, stderr is the console. */ 2950 if ( 2951 # ifdef UNIX 2952 # ifdef MACOS_X 2953 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0) 2954 # else 2955 isatty(2) 2956 # endif 2957 # ifdef FEAT_GUI 2958 || 2959 # endif 2960 # endif 2961 # ifdef FEAT_GUI 2962 !(gui.in_use || gui.starting) 2963 # endif 2964 ) 2965 { 2966 fprintf(stderr, "%s", str); 2967 return; 2968 } 2969 #endif 2970 2971 /* avoid a delay for a message that isn't there */ 2972 emsg_on_display = FALSE; 2973 2974 len = (int)STRLEN(str) + 1; 2975 if (error_ga.ga_growsize == 0) 2976 { 2977 error_ga.ga_growsize = 80; 2978 error_ga.ga_itemsize = 1; 2979 } 2980 if (ga_grow(&error_ga, len) == OK) 2981 { 2982 mch_memmove((char_u *)error_ga.ga_data + error_ga.ga_len, 2983 (char_u *)str, len); 2984 #ifdef UNIX 2985 /* remove CR characters, they are displayed */ 2986 { 2987 char_u *p; 2988 2989 p = (char_u *)error_ga.ga_data + error_ga.ga_len; 2990 for (;;) 2991 { 2992 p = vim_strchr(p, '\r'); 2993 if (p == NULL) 2994 break; 2995 *p = ' '; 2996 } 2997 } 2998 #endif 2999 --len; /* don't count the NUL at the end */ 3000 error_ga.ga_len += len; 3001 } 3002 } 3003 3004 /* 3005 * Give a message. To be used when the screen hasn't been initialized yet. 3006 * When there is no tty, collect messages until the GUI has started and they 3007 * can be displayed in a message box. 3008 */ 3009 void 3010 mch_msg(char *str) 3011 { 3012 #if (defined(UNIX) || defined(FEAT_GUI)) && !defined(ALWAYS_USE_GUI) 3013 /* On Unix use stdout if we have a tty. This allows "vim -h | more" and 3014 * uses mch_errmsg() when started from the desktop. 3015 * When not going to start the GUI also use stdout. 3016 * On Mac, when started from Finder, stderr is the console. */ 3017 if ( 3018 # ifdef UNIX 3019 # ifdef MACOS_X 3020 (isatty(2) && strcmp("/dev/console", ttyname(2)) != 0) 3021 # else 3022 isatty(2) 3023 # endif 3024 # ifdef FEAT_GUI 3025 || 3026 # endif 3027 # endif 3028 # ifdef FEAT_GUI 3029 !(gui.in_use || gui.starting) 3030 # endif 3031 ) 3032 { 3033 printf("%s", str); 3034 return; 3035 } 3036 # endif 3037 mch_errmsg(str); 3038 } 3039 #endif /* USE_MCH_ERRMSG */ 3040 3041 /* 3042 * Put a character on the screen at the current message position and advance 3043 * to the next position. Only for printable ASCII! 3044 */ 3045 static void 3046 msg_screen_putchar(int c, int attr) 3047 { 3048 msg_didout = TRUE; /* remember that line is not empty */ 3049 screen_putchar(c, msg_row, msg_col, attr); 3050 #ifdef FEAT_RIGHTLEFT 3051 if (cmdmsg_rl) 3052 { 3053 if (--msg_col == 0) 3054 { 3055 msg_col = Columns; 3056 ++msg_row; 3057 } 3058 } 3059 else 3060 #endif 3061 { 3062 if (++msg_col >= Columns) 3063 { 3064 msg_col = 0; 3065 ++msg_row; 3066 } 3067 } 3068 } 3069 3070 void 3071 msg_moremsg(int full) 3072 { 3073 int attr; 3074 char_u *s = (char_u *)_("-- More --"); 3075 3076 attr = HL_ATTR(HLF_M); 3077 screen_puts(s, (int)Rows - 1, 0, attr); 3078 if (full) 3079 screen_puts((char_u *) 3080 _(" SPACE/d/j: screen/page/line down, b/u/k: up, q: quit "), 3081 (int)Rows - 1, vim_strsize(s), attr); 3082 } 3083 3084 /* 3085 * Repeat the message for the current mode: ASKMORE, EXTERNCMD, CONFIRM or 3086 * exmode_active. 3087 */ 3088 void 3089 repeat_message(void) 3090 { 3091 if (State == ASKMORE) 3092 { 3093 msg_moremsg(TRUE); /* display --more-- message again */ 3094 msg_row = Rows - 1; 3095 } 3096 #ifdef FEAT_CON_DIALOG 3097 else if (State == CONFIRM) 3098 { 3099 display_confirm_msg(); /* display ":confirm" message again */ 3100 msg_row = Rows - 1; 3101 } 3102 #endif 3103 else if (State == EXTERNCMD) 3104 { 3105 windgoto(msg_row, msg_col); /* put cursor back */ 3106 } 3107 else if (State == HITRETURN || State == SETWSIZE) 3108 { 3109 if (msg_row == Rows - 1) 3110 { 3111 /* Avoid drawing the "hit-enter" prompt below the previous one, 3112 * overwrite it. Esp. useful when regaining focus and a 3113 * FocusGained autocmd exists but didn't draw anything. */ 3114 msg_didout = FALSE; 3115 msg_col = 0; 3116 msg_clr_eos(); 3117 } 3118 hit_return_msg(); 3119 msg_row = Rows - 1; 3120 } 3121 } 3122 3123 /* 3124 * msg_check_screen - check if the screen is initialized. 3125 * Also check msg_row and msg_col, if they are too big it may cause a crash. 3126 * While starting the GUI the terminal codes will be set for the GUI, but the 3127 * output goes to the terminal. Don't use the terminal codes then. 3128 */ 3129 static int 3130 msg_check_screen(void) 3131 { 3132 if (!full_screen || !screen_valid(FALSE)) 3133 return FALSE; 3134 3135 if (msg_row >= Rows) 3136 msg_row = Rows - 1; 3137 if (msg_col >= Columns) 3138 msg_col = Columns - 1; 3139 return TRUE; 3140 } 3141 3142 /* 3143 * Clear from current message position to end of screen. 3144 * Skip this when ":silent" was used, no need to clear for redirection. 3145 */ 3146 void 3147 msg_clr_eos(void) 3148 { 3149 if (msg_silent == 0) 3150 msg_clr_eos_force(); 3151 } 3152 3153 /* 3154 * Clear from current message position to end of screen. 3155 * Note: msg_col is not updated, so we remember the end of the message 3156 * for msg_check(). 3157 */ 3158 void 3159 msg_clr_eos_force(void) 3160 { 3161 if (msg_use_printf()) 3162 { 3163 if (full_screen) /* only when termcap codes are valid */ 3164 { 3165 if (*T_CD) 3166 out_str(T_CD); /* clear to end of display */ 3167 else if (*T_CE) 3168 out_str(T_CE); /* clear to end of line */ 3169 } 3170 } 3171 else 3172 { 3173 #ifdef FEAT_RIGHTLEFT 3174 if (cmdmsg_rl) 3175 { 3176 screen_fill(msg_row, msg_row + 1, 0, msg_col + 1, ' ', ' ', 0); 3177 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0); 3178 } 3179 else 3180 #endif 3181 { 3182 screen_fill(msg_row, msg_row + 1, msg_col, (int)Columns, 3183 ' ', ' ', 0); 3184 screen_fill(msg_row + 1, (int)Rows, 0, (int)Columns, ' ', ' ', 0); 3185 } 3186 } 3187 } 3188 3189 /* 3190 * Clear the command line. 3191 */ 3192 void 3193 msg_clr_cmdline(void) 3194 { 3195 msg_row = cmdline_row; 3196 msg_col = 0; 3197 msg_clr_eos_force(); 3198 } 3199 3200 /* 3201 * end putting a message on the screen 3202 * call wait_return if the message does not fit in the available space 3203 * return TRUE if wait_return not called. 3204 */ 3205 int 3206 msg_end(void) 3207 { 3208 /* 3209 * If the string is larger than the window, 3210 * or the ruler option is set and we run into it, 3211 * we have to redraw the window. 3212 * Do not do this if we are abandoning the file or editing the command line. 3213 */ 3214 if (!exiting && need_wait_return && !(State & CMDLINE)) 3215 { 3216 wait_return(FALSE); 3217 return FALSE; 3218 } 3219 out_flush(); 3220 return TRUE; 3221 } 3222 3223 /* 3224 * If the written message runs into the shown command or ruler, we have to 3225 * wait for hit-return and redraw the window later. 3226 */ 3227 void 3228 msg_check(void) 3229 { 3230 if (msg_row == Rows - 1 && msg_col >= sc_col) 3231 { 3232 need_wait_return = TRUE; 3233 redraw_cmdline = TRUE; 3234 } 3235 } 3236 3237 /* 3238 * May write a string to the redirection file. 3239 * When "maxlen" is -1 write the whole string, otherwise up to "maxlen" bytes. 3240 */ 3241 static void 3242 redir_write(char_u *str, int maxlen) 3243 { 3244 char_u *s = str; 3245 static int cur_col = 0; 3246 3247 /* Don't do anything for displaying prompts and the like. */ 3248 if (redir_off) 3249 return; 3250 3251 /* If 'verbosefile' is set prepare for writing in that file. */ 3252 if (*p_vfile != NUL && verbose_fd == NULL) 3253 verbose_open(); 3254 3255 if (redirecting()) 3256 { 3257 /* If the string doesn't start with CR or NL, go to msg_col */ 3258 if (*s != '\n' && *s != '\r') 3259 { 3260 while (cur_col < msg_col) 3261 { 3262 #ifdef FEAT_EVAL 3263 if (redir_execute) 3264 execute_redir_str((char_u *)" ", -1); 3265 else if (redir_reg) 3266 write_reg_contents(redir_reg, (char_u *)" ", -1, TRUE); 3267 else if (redir_vname) 3268 var_redir_str((char_u *)" ", -1); 3269 else 3270 #endif 3271 if (redir_fd != NULL) 3272 fputs(" ", redir_fd); 3273 if (verbose_fd != NULL) 3274 fputs(" ", verbose_fd); 3275 ++cur_col; 3276 } 3277 } 3278 3279 #ifdef FEAT_EVAL 3280 if (redir_execute) 3281 execute_redir_str(s, maxlen); 3282 else if (redir_reg) 3283 write_reg_contents(redir_reg, s, maxlen, TRUE); 3284 else if (redir_vname) 3285 var_redir_str(s, maxlen); 3286 #endif 3287 3288 /* Write and adjust the current column. */ 3289 while (*s != NUL && (maxlen < 0 || (int)(s - str) < maxlen)) 3290 { 3291 #ifdef FEAT_EVAL 3292 if (!redir_reg && !redir_vname && !redir_execute) 3293 #endif 3294 if (redir_fd != NULL) 3295 putc(*s, redir_fd); 3296 if (verbose_fd != NULL) 3297 putc(*s, verbose_fd); 3298 if (*s == '\r' || *s == '\n') 3299 cur_col = 0; 3300 else if (*s == '\t') 3301 cur_col += (8 - cur_col % 8); 3302 else 3303 ++cur_col; 3304 ++s; 3305 } 3306 3307 if (msg_silent != 0) /* should update msg_col */ 3308 msg_col = cur_col; 3309 } 3310 } 3311 3312 int 3313 redirecting(void) 3314 { 3315 return redir_fd != NULL || *p_vfile != NUL 3316 #ifdef FEAT_EVAL 3317 || redir_reg || redir_vname || redir_execute 3318 #endif 3319 ; 3320 } 3321 3322 /* 3323 * Before giving verbose message. 3324 * Must always be called paired with verbose_leave()! 3325 */ 3326 void 3327 verbose_enter(void) 3328 { 3329 if (*p_vfile != NUL) 3330 ++msg_silent; 3331 } 3332 3333 /* 3334 * After giving verbose message. 3335 * Must always be called paired with verbose_enter()! 3336 */ 3337 void 3338 verbose_leave(void) 3339 { 3340 if (*p_vfile != NUL) 3341 if (--msg_silent < 0) 3342 msg_silent = 0; 3343 } 3344 3345 /* 3346 * Like verbose_enter() and set msg_scroll when displaying the message. 3347 */ 3348 void 3349 verbose_enter_scroll(void) 3350 { 3351 if (*p_vfile != NUL) 3352 ++msg_silent; 3353 else 3354 /* always scroll up, don't overwrite */ 3355 msg_scroll = TRUE; 3356 } 3357 3358 /* 3359 * Like verbose_leave() and set cmdline_row when displaying the message. 3360 */ 3361 void 3362 verbose_leave_scroll(void) 3363 { 3364 if (*p_vfile != NUL) 3365 { 3366 if (--msg_silent < 0) 3367 msg_silent = 0; 3368 } 3369 else 3370 cmdline_row = msg_row; 3371 } 3372 3373 /* 3374 * Called when 'verbosefile' is set: stop writing to the file. 3375 */ 3376 void 3377 verbose_stop(void) 3378 { 3379 if (verbose_fd != NULL) 3380 { 3381 fclose(verbose_fd); 3382 verbose_fd = NULL; 3383 } 3384 verbose_did_open = FALSE; 3385 } 3386 3387 /* 3388 * Open the file 'verbosefile'. 3389 * Return FAIL or OK. 3390 */ 3391 int 3392 verbose_open(void) 3393 { 3394 if (verbose_fd == NULL && !verbose_did_open) 3395 { 3396 /* Only give the error message once. */ 3397 verbose_did_open = TRUE; 3398 3399 verbose_fd = mch_fopen((char *)p_vfile, "a"); 3400 if (verbose_fd == NULL) 3401 { 3402 semsg(_(e_notopen), p_vfile); 3403 return FAIL; 3404 } 3405 } 3406 return OK; 3407 } 3408 3409 /* 3410 * Give a warning message (for searching). 3411 * Use 'w' highlighting and may repeat the message after redrawing 3412 */ 3413 void 3414 give_warning(char_u *message, int hl) 3415 { 3416 /* Don't do this for ":silent". */ 3417 if (msg_silent != 0) 3418 return; 3419 3420 /* Don't want a hit-enter prompt here. */ 3421 ++no_wait_return; 3422 3423 #ifdef FEAT_EVAL 3424 set_vim_var_string(VV_WARNINGMSG, message, -1); 3425 #endif 3426 VIM_CLEAR(keep_msg); 3427 if (hl) 3428 keep_msg_attr = HL_ATTR(HLF_W); 3429 else 3430 keep_msg_attr = 0; 3431 if (msg_attr((char *)message, keep_msg_attr) && msg_scrolled == 0) 3432 set_keep_msg(message, keep_msg_attr); 3433 msg_didout = FALSE; /* overwrite this message */ 3434 msg_nowait = TRUE; /* don't wait for this message */ 3435 msg_col = 0; 3436 3437 --no_wait_return; 3438 } 3439 3440 #if defined(FEAT_EVAL) || defined(PROTO) 3441 void 3442 give_warning2(char_u *message, char_u *a1, int hl) 3443 { 3444 vim_snprintf((char *)IObuff, IOSIZE, (char *)message, a1); 3445 give_warning(IObuff, hl); 3446 } 3447 #endif 3448 3449 /* 3450 * Advance msg cursor to column "col". 3451 */ 3452 void 3453 msg_advance(int col) 3454 { 3455 if (msg_silent != 0) /* nothing to advance to */ 3456 { 3457 msg_col = col; /* for redirection, may fill it up later */ 3458 return; 3459 } 3460 if (col >= Columns) /* not enough room */ 3461 col = Columns - 1; 3462 #ifdef FEAT_RIGHTLEFT 3463 if (cmdmsg_rl) 3464 while (msg_col > Columns - col) 3465 msg_putchar(' '); 3466 else 3467 #endif 3468 while (msg_col < col) 3469 msg_putchar(' '); 3470 } 3471 3472 #if defined(FEAT_CON_DIALOG) || defined(PROTO) 3473 /* 3474 * Used for "confirm()" function, and the :confirm command prefix. 3475 * Versions which haven't got flexible dialogs yet, and console 3476 * versions, get this generic handler which uses the command line. 3477 * 3478 * type = one of: 3479 * VIM_QUESTION, VIM_INFO, VIM_WARNING, VIM_ERROR or VIM_GENERIC 3480 * title = title string (can be NULL for default) 3481 * (neither used in console dialogs at the moment) 3482 * 3483 * Format of the "buttons" string: 3484 * "Button1Name\nButton2Name\nButton3Name" 3485 * The first button should normally be the default/accept 3486 * The second button should be the 'Cancel' button 3487 * Other buttons- use your imagination! 3488 * A '&' in a button name becomes a shortcut, so each '&' should be before a 3489 * different letter. 3490 */ 3491 int 3492 do_dialog( 3493 int type UNUSED, 3494 char_u *title UNUSED, 3495 char_u *message, 3496 char_u *buttons, 3497 int dfltbutton, 3498 char_u *textfield UNUSED, /* IObuff for inputdialog(), NULL 3499 otherwise */ 3500 int ex_cmd) /* when TRUE pressing : accepts default and starts 3501 Ex command */ 3502 { 3503 int oldState; 3504 int retval = 0; 3505 char_u *hotkeys; 3506 int c; 3507 int i; 3508 3509 #ifndef NO_CONSOLE 3510 /* Don't output anything in silent mode ("ex -s") */ 3511 if (silent_mode) 3512 return dfltbutton; /* return default option */ 3513 #endif 3514 3515 #ifdef FEAT_GUI_DIALOG 3516 /* When GUI is running and 'c' not in 'guioptions', use the GUI dialog */ 3517 if (gui.in_use && vim_strchr(p_go, GO_CONDIALOG) == NULL) 3518 { 3519 c = gui_mch_dialog(type, title, message, buttons, dfltbutton, 3520 textfield, ex_cmd); 3521 /* avoid a hit-enter prompt without clearing the cmdline */ 3522 need_wait_return = FALSE; 3523 emsg_on_display = FALSE; 3524 cmdline_row = msg_row; 3525 3526 /* Flush output to avoid that further messages and redrawing is done 3527 * in the wrong order. */ 3528 out_flush(); 3529 gui_mch_update(); 3530 3531 return c; 3532 } 3533 #endif 3534 3535 oldState = State; 3536 State = CONFIRM; 3537 #ifdef FEAT_MOUSE 3538 setmouse(); 3539 #endif 3540 3541 /* 3542 * Since we wait for a keypress, don't make the 3543 * user press RETURN as well afterwards. 3544 */ 3545 ++no_wait_return; 3546 hotkeys = msg_show_console_dialog(message, buttons, dfltbutton); 3547 3548 if (hotkeys != NULL) 3549 { 3550 for (;;) 3551 { 3552 /* Get a typed character directly from the user. */ 3553 c = get_keystroke(); 3554 switch (c) 3555 { 3556 case CAR: /* User accepts default option */ 3557 case NL: 3558 retval = dfltbutton; 3559 break; 3560 case Ctrl_C: /* User aborts/cancels */ 3561 case ESC: 3562 retval = 0; 3563 break; 3564 default: /* Could be a hotkey? */ 3565 if (c < 0) /* special keys are ignored here */ 3566 continue; 3567 if (c == ':' && ex_cmd) 3568 { 3569 retval = dfltbutton; 3570 ins_char_typebuf(':'); 3571 break; 3572 } 3573 3574 /* Make the character lowercase, as chars in "hotkeys" are. */ 3575 c = MB_TOLOWER(c); 3576 retval = 1; 3577 for (i = 0; hotkeys[i]; ++i) 3578 { 3579 if (has_mbyte) 3580 { 3581 if ((*mb_ptr2char)(hotkeys + i) == c) 3582 break; 3583 i += (*mb_ptr2len)(hotkeys + i) - 1; 3584 } 3585 else 3586 if (hotkeys[i] == c) 3587 break; 3588 ++retval; 3589 } 3590 if (hotkeys[i]) 3591 break; 3592 /* No hotkey match, so keep waiting */ 3593 continue; 3594 } 3595 break; 3596 } 3597 3598 vim_free(hotkeys); 3599 } 3600 3601 State = oldState; 3602 #ifdef FEAT_MOUSE 3603 setmouse(); 3604 #endif 3605 --no_wait_return; 3606 msg_end_prompt(); 3607 3608 return retval; 3609 } 3610 3611 /* 3612 * Copy one character from "*from" to "*to", taking care of multi-byte 3613 * characters. Return the length of the character in bytes. 3614 */ 3615 static int 3616 copy_char( 3617 char_u *from, 3618 char_u *to, 3619 int lowercase) /* make character lower case */ 3620 { 3621 int len; 3622 int c; 3623 3624 if (has_mbyte) 3625 { 3626 if (lowercase) 3627 { 3628 c = MB_TOLOWER((*mb_ptr2char)(from)); 3629 return (*mb_char2bytes)(c, to); 3630 } 3631 else 3632 { 3633 len = (*mb_ptr2len)(from); 3634 mch_memmove(to, from, (size_t)len); 3635 return len; 3636 } 3637 } 3638 else 3639 { 3640 if (lowercase) 3641 *to = (char_u)TOLOWER_LOC(*from); 3642 else 3643 *to = *from; 3644 return 1; 3645 } 3646 } 3647 3648 /* 3649 * Format the dialog string, and display it at the bottom of 3650 * the screen. Return a string of hotkey chars (if defined) for 3651 * each 'button'. If a button has no hotkey defined, the first character of 3652 * the button is used. 3653 * The hotkeys can be multi-byte characters, but without combining chars. 3654 * 3655 * Returns an allocated string with hotkeys, or NULL for error. 3656 */ 3657 static char_u * 3658 msg_show_console_dialog( 3659 char_u *message, 3660 char_u *buttons, 3661 int dfltbutton) 3662 { 3663 int len = 0; 3664 #define HOTK_LEN (has_mbyte ? MB_MAXBYTES : 1) 3665 int lenhotkey = HOTK_LEN; /* count first button */ 3666 char_u *hotk = NULL; 3667 char_u *msgp = NULL; 3668 char_u *hotkp = NULL; 3669 char_u *r; 3670 int copy; 3671 #define HAS_HOTKEY_LEN 30 3672 char_u has_hotkey[HAS_HOTKEY_LEN]; 3673 int first_hotkey = FALSE; /* first char of button is hotkey */ 3674 int idx; 3675 3676 has_hotkey[0] = FALSE; 3677 3678 /* 3679 * First loop: compute the size of memory to allocate. 3680 * Second loop: copy to the allocated memory. 3681 */ 3682 for (copy = 0; copy <= 1; ++copy) 3683 { 3684 r = buttons; 3685 idx = 0; 3686 while (*r) 3687 { 3688 if (*r == DLG_BUTTON_SEP) 3689 { 3690 if (copy) 3691 { 3692 *msgp++ = ','; 3693 *msgp++ = ' '; /* '\n' -> ', ' */ 3694 3695 /* advance to next hotkey and set default hotkey */ 3696 if (has_mbyte) 3697 hotkp += STRLEN(hotkp); 3698 else 3699 ++hotkp; 3700 hotkp[copy_char(r + 1, hotkp, TRUE)] = NUL; 3701 if (dfltbutton) 3702 --dfltbutton; 3703 3704 /* If no hotkey is specified first char is used. */ 3705 if (idx < HAS_HOTKEY_LEN - 1 && !has_hotkey[++idx]) 3706 first_hotkey = TRUE; 3707 } 3708 else 3709 { 3710 len += 3; /* '\n' -> ', '; 'x' -> '(x)' */ 3711 lenhotkey += HOTK_LEN; /* each button needs a hotkey */ 3712 if (idx < HAS_HOTKEY_LEN - 1) 3713 has_hotkey[++idx] = FALSE; 3714 } 3715 } 3716 else if (*r == DLG_HOTKEY_CHAR || first_hotkey) 3717 { 3718 if (*r == DLG_HOTKEY_CHAR) 3719 ++r; 3720 first_hotkey = FALSE; 3721 if (copy) 3722 { 3723 if (*r == DLG_HOTKEY_CHAR) /* '&&a' -> '&a' */ 3724 *msgp++ = *r; 3725 else 3726 { 3727 /* '&a' -> '[a]' */ 3728 *msgp++ = (dfltbutton == 1) ? '[' : '('; 3729 msgp += copy_char(r, msgp, FALSE); 3730 *msgp++ = (dfltbutton == 1) ? ']' : ')'; 3731 3732 /* redefine hotkey */ 3733 hotkp[copy_char(r, hotkp, TRUE)] = NUL; 3734 } 3735 } 3736 else 3737 { 3738 ++len; /* '&a' -> '[a]' */ 3739 if (idx < HAS_HOTKEY_LEN - 1) 3740 has_hotkey[idx] = TRUE; 3741 } 3742 } 3743 else 3744 { 3745 /* everything else copy literally */ 3746 if (copy) 3747 msgp += copy_char(r, msgp, FALSE); 3748 } 3749 3750 /* advance to the next character */ 3751 MB_PTR_ADV(r); 3752 } 3753 3754 if (copy) 3755 { 3756 *msgp++ = ':'; 3757 *msgp++ = ' '; 3758 *msgp = NUL; 3759 } 3760 else 3761 { 3762 len += (int)(STRLEN(message) 3763 + 2 /* for the NL's */ 3764 + STRLEN(buttons) 3765 + 3); /* for the ": " and NUL */ 3766 lenhotkey++; /* for the NUL */ 3767 3768 /* If no hotkey is specified first char is used. */ 3769 if (!has_hotkey[0]) 3770 { 3771 first_hotkey = TRUE; 3772 len += 2; /* "x" -> "[x]" */ 3773 } 3774 3775 /* 3776 * Now allocate and load the strings 3777 */ 3778 vim_free(confirm_msg); 3779 confirm_msg = alloc(len); 3780 if (confirm_msg == NULL) 3781 return NULL; 3782 *confirm_msg = NUL; 3783 hotk = alloc(lenhotkey); 3784 if (hotk == NULL) 3785 return NULL; 3786 3787 *confirm_msg = '\n'; 3788 STRCPY(confirm_msg + 1, message); 3789 3790 msgp = confirm_msg + 1 + STRLEN(message); 3791 hotkp = hotk; 3792 3793 /* Define first default hotkey. Keep the hotkey string NUL 3794 * terminated to avoid reading past the end. */ 3795 hotkp[copy_char(buttons, hotkp, TRUE)] = NUL; 3796 3797 /* Remember where the choices start, displaying starts here when 3798 * "hotkp" typed at the more prompt. */ 3799 confirm_msg_tail = msgp; 3800 *msgp++ = '\n'; 3801 } 3802 } 3803 3804 display_confirm_msg(); 3805 return hotk; 3806 } 3807 3808 /* 3809 * Display the ":confirm" message. Also called when screen resized. 3810 */ 3811 void 3812 display_confirm_msg(void) 3813 { 3814 /* avoid that 'q' at the more prompt truncates the message here */ 3815 ++confirm_msg_used; 3816 if (confirm_msg != NULL) 3817 msg_puts_attr((char *)confirm_msg, HL_ATTR(HLF_M)); 3818 --confirm_msg_used; 3819 } 3820 3821 #endif /* FEAT_CON_DIALOG */ 3822 3823 #if defined(FEAT_CON_DIALOG) || defined(FEAT_GUI_DIALOG) 3824 3825 int 3826 vim_dialog_yesno( 3827 int type, 3828 char_u *title, 3829 char_u *message, 3830 int dflt) 3831 { 3832 if (do_dialog(type, 3833 title == NULL ? (char_u *)_("Question") : title, 3834 message, 3835 (char_u *)_("&Yes\n&No"), dflt, NULL, FALSE) == 1) 3836 return VIM_YES; 3837 return VIM_NO; 3838 } 3839 3840 int 3841 vim_dialog_yesnocancel( 3842 int type, 3843 char_u *title, 3844 char_u *message, 3845 int dflt) 3846 { 3847 switch (do_dialog(type, 3848 title == NULL ? (char_u *)_("Question") : title, 3849 message, 3850 (char_u *)_("&Yes\n&No\n&Cancel"), dflt, NULL, FALSE)) 3851 { 3852 case 1: return VIM_YES; 3853 case 2: return VIM_NO; 3854 } 3855 return VIM_CANCEL; 3856 } 3857 3858 int 3859 vim_dialog_yesnoallcancel( 3860 int type, 3861 char_u *title, 3862 char_u *message, 3863 int dflt) 3864 { 3865 switch (do_dialog(type, 3866 title == NULL ? (char_u *)"Question" : title, 3867 message, 3868 (char_u *)_("&Yes\n&No\nSave &All\n&Discard All\n&Cancel"), 3869 dflt, NULL, FALSE)) 3870 { 3871 case 1: return VIM_YES; 3872 case 2: return VIM_NO; 3873 case 3: return VIM_ALL; 3874 case 4: return VIM_DISCARDALL; 3875 } 3876 return VIM_CANCEL; 3877 } 3878 3879 #endif /* FEAT_GUI_DIALOG || FEAT_CON_DIALOG */ 3880 3881 #if defined(FEAT_BROWSE) || defined(PROTO) 3882 /* 3883 * Generic browse function. Calls gui_mch_browse() when possible. 3884 * Later this may pop-up a non-GUI file selector (external command?). 3885 */ 3886 char_u * 3887 do_browse( 3888 int flags, /* BROWSE_SAVE and BROWSE_DIR */ 3889 char_u *title, /* title for the window */ 3890 char_u *dflt, /* default file name (may include directory) */ 3891 char_u *ext, /* extension added */ 3892 char_u *initdir, /* initial directory, NULL for current dir or 3893 when using path from "dflt" */ 3894 char_u *filter, /* file name filter */ 3895 buf_T *buf) /* buffer to read/write for */ 3896 { 3897 char_u *fname; 3898 static char_u *last_dir = NULL; /* last used directory */ 3899 char_u *tofree = NULL; 3900 int save_browse = cmdmod.browse; 3901 3902 /* Must turn off browse to avoid that autocommands will get the 3903 * flag too! */ 3904 cmdmod.browse = FALSE; 3905 3906 if (title == NULL || *title == NUL) 3907 { 3908 if (flags & BROWSE_DIR) 3909 title = (char_u *)_("Select Directory dialog"); 3910 else if (flags & BROWSE_SAVE) 3911 title = (char_u *)_("Save File dialog"); 3912 else 3913 title = (char_u *)_("Open File dialog"); 3914 } 3915 3916 /* When no directory specified, use default file name, default dir, buffer 3917 * dir, last dir or current dir */ 3918 if ((initdir == NULL || *initdir == NUL) && dflt != NULL && *dflt != NUL) 3919 { 3920 if (mch_isdir(dflt)) /* default file name is a directory */ 3921 { 3922 initdir = dflt; 3923 dflt = NULL; 3924 } 3925 else if (gettail(dflt) != dflt) /* default file name includes a path */ 3926 { 3927 tofree = vim_strsave(dflt); 3928 if (tofree != NULL) 3929 { 3930 initdir = tofree; 3931 *gettail(initdir) = NUL; 3932 dflt = gettail(dflt); 3933 } 3934 } 3935 } 3936 3937 if (initdir == NULL || *initdir == NUL) 3938 { 3939 /* When 'browsedir' is a directory, use it */ 3940 if (STRCMP(p_bsdir, "last") != 0 3941 && STRCMP(p_bsdir, "buffer") != 0 3942 && STRCMP(p_bsdir, "current") != 0 3943 && mch_isdir(p_bsdir)) 3944 initdir = p_bsdir; 3945 /* When saving or 'browsedir' is "buffer", use buffer fname */ 3946 else if (((flags & BROWSE_SAVE) || *p_bsdir == 'b') 3947 && buf != NULL && buf->b_ffname != NULL) 3948 { 3949 if (dflt == NULL || *dflt == NUL) 3950 dflt = gettail(curbuf->b_ffname); 3951 tofree = vim_strsave(curbuf->b_ffname); 3952 if (tofree != NULL) 3953 { 3954 initdir = tofree; 3955 *gettail(initdir) = NUL; 3956 } 3957 } 3958 /* When 'browsedir' is "last", use dir from last browse */ 3959 else if (*p_bsdir == 'l') 3960 initdir = last_dir; 3961 /* When 'browsedir is "current", use current directory. This is the 3962 * default already, leave initdir empty. */ 3963 } 3964 3965 # ifdef FEAT_GUI 3966 if (gui.in_use) /* when this changes, also adjust f_has()! */ 3967 { 3968 if (filter == NULL 3969 # ifdef FEAT_EVAL 3970 && (filter = get_var_value((char_u *)"b:browsefilter")) == NULL 3971 && (filter = get_var_value((char_u *)"g:browsefilter")) == NULL 3972 # endif 3973 ) 3974 filter = BROWSE_FILTER_DEFAULT; 3975 if (flags & BROWSE_DIR) 3976 { 3977 # if defined(FEAT_GUI_GTK) || defined(WIN3264) 3978 /* For systems that have a directory dialog. */ 3979 fname = gui_mch_browsedir(title, initdir); 3980 # else 3981 /* Generic solution for selecting a directory: select a file and 3982 * remove the file name. */ 3983 fname = gui_mch_browse(0, title, dflt, ext, initdir, (char_u *)""); 3984 # endif 3985 # if !defined(FEAT_GUI_GTK) 3986 /* Win32 adds a dummy file name, others return an arbitrary file 3987 * name. GTK+ 2 returns only the directory, */ 3988 if (fname != NULL && *fname != NUL && !mch_isdir(fname)) 3989 { 3990 /* Remove the file name. */ 3991 char_u *tail = gettail_sep(fname); 3992 3993 if (tail == fname) 3994 *tail++ = '.'; /* use current dir */ 3995 *tail = NUL; 3996 } 3997 # endif 3998 } 3999 else 4000 fname = gui_mch_browse(flags & BROWSE_SAVE, 4001 title, dflt, ext, initdir, (char_u *)_(filter)); 4002 4003 /* We hang around in the dialog for a while, the user might do some 4004 * things to our files. The Win32 dialog allows deleting or renaming 4005 * a file, check timestamps. */ 4006 need_check_timestamps = TRUE; 4007 did_check_timestamps = FALSE; 4008 } 4009 else 4010 # endif 4011 { 4012 /* TODO: non-GUI file selector here */ 4013 emsg(_("E338: Sorry, no file browser in console mode")); 4014 fname = NULL; 4015 } 4016 4017 /* keep the directory for next time */ 4018 if (fname != NULL) 4019 { 4020 vim_free(last_dir); 4021 last_dir = vim_strsave(fname); 4022 if (last_dir != NULL && !(flags & BROWSE_DIR)) 4023 { 4024 *gettail(last_dir) = NUL; 4025 if (*last_dir == NUL) 4026 { 4027 /* filename only returned, must be in current dir */ 4028 vim_free(last_dir); 4029 last_dir = alloc(MAXPATHL); 4030 if (last_dir != NULL) 4031 mch_dirname(last_dir, MAXPATHL); 4032 } 4033 } 4034 } 4035 4036 vim_free(tofree); 4037 cmdmod.browse = save_browse; 4038 4039 return fname; 4040 } 4041 #endif 4042 4043 #if defined(FEAT_EVAL) 4044 static char *e_printf = N_("E766: Insufficient arguments for printf()"); 4045 4046 /* 4047 * Get number argument from "idxp" entry in "tvs". First entry is 1. 4048 */ 4049 static varnumber_T 4050 tv_nr(typval_T *tvs, int *idxp) 4051 { 4052 int idx = *idxp - 1; 4053 varnumber_T n = 0; 4054 int err = FALSE; 4055 4056 if (tvs[idx].v_type == VAR_UNKNOWN) 4057 emsg(_(e_printf)); 4058 else 4059 { 4060 ++*idxp; 4061 n = tv_get_number_chk(&tvs[idx], &err); 4062 if (err) 4063 n = 0; 4064 } 4065 return n; 4066 } 4067 4068 /* 4069 * Get string argument from "idxp" entry in "tvs". First entry is 1. 4070 * If "tofree" is NULL tv_get_string_chk() is used. Some types (e.g. List) 4071 * are not converted to a string. 4072 * If "tofree" is not NULL echo_string() is used. All types are converted to 4073 * a string with the same format as ":echo". The caller must free "*tofree". 4074 * Returns NULL for an error. 4075 */ 4076 static char * 4077 tv_str(typval_T *tvs, int *idxp, char_u **tofree) 4078 { 4079 int idx = *idxp - 1; 4080 char *s = NULL; 4081 static char_u numbuf[NUMBUFLEN]; 4082 4083 if (tvs[idx].v_type == VAR_UNKNOWN) 4084 emsg(_(e_printf)); 4085 else 4086 { 4087 ++*idxp; 4088 if (tofree != NULL) 4089 s = (char *)echo_string(&tvs[idx], tofree, numbuf, get_copyID()); 4090 else 4091 s = (char *)tv_get_string_chk(&tvs[idx]); 4092 } 4093 return s; 4094 } 4095 4096 # ifdef FEAT_FLOAT 4097 /* 4098 * Get float argument from "idxp" entry in "tvs". First entry is 1. 4099 */ 4100 static double 4101 tv_float(typval_T *tvs, int *idxp) 4102 { 4103 int idx = *idxp - 1; 4104 double f = 0; 4105 4106 if (tvs[idx].v_type == VAR_UNKNOWN) 4107 emsg(_(e_printf)); 4108 else 4109 { 4110 ++*idxp; 4111 if (tvs[idx].v_type == VAR_FLOAT) 4112 f = tvs[idx].vval.v_float; 4113 else if (tvs[idx].v_type == VAR_NUMBER) 4114 f = (double)tvs[idx].vval.v_number; 4115 else 4116 emsg(_("E807: Expected Float argument for printf()")); 4117 } 4118 return f; 4119 } 4120 # endif 4121 #endif 4122 4123 #ifdef FEAT_FLOAT 4124 /* 4125 * Return the representation of infinity for printf() function: 4126 * "-inf", "inf", "+inf", " inf", "-INF", "INF", "+INF" or " INF". 4127 */ 4128 static const char * 4129 infinity_str(int positive, 4130 char fmt_spec, 4131 int force_sign, 4132 int space_for_positive) 4133 { 4134 static const char *table[] = 4135 { 4136 "-inf", "inf", "+inf", " inf", 4137 "-INF", "INF", "+INF", " INF" 4138 }; 4139 int idx = positive * (1 + force_sign + force_sign * space_for_positive); 4140 4141 if (ASCII_ISUPPER(fmt_spec)) 4142 idx += 4; 4143 return table[idx]; 4144 } 4145 #endif 4146 4147 /* 4148 * This code was included to provide a portable vsnprintf() and snprintf(). 4149 * Some systems may provide their own, but we always use this one for 4150 * consistency. 4151 * 4152 * This code is based on snprintf.c - a portable implementation of snprintf 4153 * by Mark Martinec <[email protected]>, Version 2.2, 2000-10-06. 4154 * Included with permission. It was heavily modified to fit in Vim. 4155 * The original code, including useful comments, can be found here: 4156 * http://www.ijs.si/software/snprintf/ 4157 * 4158 * This snprintf() only supports the following conversion specifiers: 4159 * s, c, d, u, o, x, X, p (and synonyms: i, D, U, O - see below) 4160 * with flags: '-', '+', ' ', '0' and '#'. 4161 * An asterisk is supported for field width as well as precision. 4162 * 4163 * Limited support for floating point was added: 'f', 'F', 'e', 'E', 'g', 'G'. 4164 * 4165 * Length modifiers 'h' (short int) and 'l' (long int) and 'll' (long long int) 4166 * are supported. 4167 * 4168 * The locale is not used, the string is used as a byte string. This is only 4169 * relevant for double-byte encodings where the second byte may be '%'. 4170 * 4171 * It is permitted for "str_m" to be zero, and it is permitted to specify NULL 4172 * pointer for resulting string argument if "str_m" is zero (as per ISO C99). 4173 * 4174 * The return value is the number of characters which would be generated 4175 * for the given input, excluding the trailing NUL. If this value 4176 * is greater or equal to "str_m", not all characters from the result 4177 * have been stored in str, output bytes beyond the ("str_m"-1) -th character 4178 * are discarded. If "str_m" is greater than zero it is guaranteed 4179 * the resulting string will be NUL-terminated. 4180 */ 4181 4182 /* 4183 * When va_list is not supported we only define vim_snprintf(). 4184 * 4185 * vim_vsnprintf_typval() can be invoked with either "va_list" or a list of 4186 * "typval_T". When the latter is not used it must be NULL. 4187 */ 4188 4189 /* When generating prototypes all of this is skipped, cproto doesn't 4190 * understand this. */ 4191 #ifndef PROTO 4192 4193 /* Like vim_vsnprintf() but append to the string. */ 4194 int 4195 vim_snprintf_add(char *str, size_t str_m, const char *fmt, ...) 4196 { 4197 va_list ap; 4198 int str_l; 4199 size_t len = STRLEN(str); 4200 size_t space; 4201 4202 if (str_m <= len) 4203 space = 0; 4204 else 4205 space = str_m - len; 4206 va_start(ap, fmt); 4207 str_l = vim_vsnprintf(str + len, space, fmt, ap); 4208 va_end(ap); 4209 return str_l; 4210 } 4211 4212 int 4213 vim_snprintf(char *str, size_t str_m, const char *fmt, ...) 4214 { 4215 va_list ap; 4216 int str_l; 4217 4218 va_start(ap, fmt); 4219 str_l = vim_vsnprintf(str, str_m, fmt, ap); 4220 va_end(ap); 4221 return str_l; 4222 } 4223 4224 int 4225 vim_vsnprintf( 4226 char *str, 4227 size_t str_m, 4228 const char *fmt, 4229 va_list ap) 4230 { 4231 return vim_vsnprintf_typval(str, str_m, fmt, ap, NULL); 4232 } 4233 4234 int 4235 vim_vsnprintf_typval( 4236 char *str, 4237 size_t str_m, 4238 const char *fmt, 4239 va_list ap, 4240 typval_T *tvs) 4241 { 4242 size_t str_l = 0; 4243 const char *p = fmt; 4244 int arg_idx = 1; 4245 4246 if (p == NULL) 4247 p = ""; 4248 while (*p != NUL) 4249 { 4250 if (*p != '%') 4251 { 4252 char *q = strchr(p + 1, '%'); 4253 size_t n = (q == NULL) ? STRLEN(p) : (size_t)(q - p); 4254 4255 /* Copy up to the next '%' or NUL without any changes. */ 4256 if (str_l < str_m) 4257 { 4258 size_t avail = str_m - str_l; 4259 4260 mch_memmove(str + str_l, p, n > avail ? avail : n); 4261 } 4262 p += n; 4263 str_l += n; 4264 } 4265 else 4266 { 4267 size_t min_field_width = 0, precision = 0; 4268 int zero_padding = 0, precision_specified = 0, justify_left = 0; 4269 int alternate_form = 0, force_sign = 0; 4270 4271 /* If both the ' ' and '+' flags appear, the ' ' flag should be 4272 * ignored. */ 4273 int space_for_positive = 1; 4274 4275 /* allowed values: \0, h, l, L */ 4276 char length_modifier = '\0'; 4277 4278 /* temporary buffer for simple numeric->string conversion */ 4279 # if defined(FEAT_FLOAT) 4280 # define TMP_LEN 350 /* On my system 1e308 is the biggest number possible. 4281 * That sounds reasonable to use as the maximum 4282 * printable. */ 4283 # elif defined(FEAT_NUM64) 4284 # define TMP_LEN 66 4285 # else 4286 # define TMP_LEN 34 4287 # endif 4288 char tmp[TMP_LEN]; 4289 4290 /* string address in case of string argument */ 4291 const char *str_arg = NULL; 4292 4293 /* natural field width of arg without padding and sign */ 4294 size_t str_arg_l; 4295 4296 /* unsigned char argument value - only defined for c conversion. 4297 * N.B. standard explicitly states the char argument for the c 4298 * conversion is unsigned */ 4299 unsigned char uchar_arg; 4300 4301 /* number of zeros to be inserted for numeric conversions as 4302 * required by the precision or minimal field width */ 4303 size_t number_of_zeros_to_pad = 0; 4304 4305 /* index into tmp where zero padding is to be inserted */ 4306 size_t zero_padding_insertion_ind = 0; 4307 4308 /* current conversion specifier character */ 4309 char fmt_spec = '\0'; 4310 4311 /* buffer for 's' and 'S' specs */ 4312 char_u *tofree = NULL; 4313 4314 4315 p++; /* skip '%' */ 4316 4317 /* parse flags */ 4318 while (*p == '0' || *p == '-' || *p == '+' || *p == ' ' 4319 || *p == '#' || *p == '\'') 4320 { 4321 switch (*p) 4322 { 4323 case '0': zero_padding = 1; break; 4324 case '-': justify_left = 1; break; 4325 case '+': force_sign = 1; space_for_positive = 0; break; 4326 case ' ': force_sign = 1; 4327 /* If both the ' ' and '+' flags appear, the ' ' 4328 * flag should be ignored */ 4329 break; 4330 case '#': alternate_form = 1; break; 4331 case '\'': break; 4332 } 4333 p++; 4334 } 4335 /* If the '0' and '-' flags both appear, the '0' flag should be 4336 * ignored. */ 4337 4338 /* parse field width */ 4339 if (*p == '*') 4340 { 4341 int j; 4342 4343 p++; 4344 j = 4345 # if defined(FEAT_EVAL) 4346 tvs != NULL ? tv_nr(tvs, &arg_idx) : 4347 # endif 4348 va_arg(ap, int); 4349 if (j >= 0) 4350 min_field_width = j; 4351 else 4352 { 4353 min_field_width = -j; 4354 justify_left = 1; 4355 } 4356 } 4357 else if (VIM_ISDIGIT((int)(*p))) 4358 { 4359 /* size_t could be wider than unsigned int; make sure we treat 4360 * argument like common implementations do */ 4361 unsigned int uj = *p++ - '0'; 4362 4363 while (VIM_ISDIGIT((int)(*p))) 4364 uj = 10 * uj + (unsigned int)(*p++ - '0'); 4365 min_field_width = uj; 4366 } 4367 4368 /* parse precision */ 4369 if (*p == '.') 4370 { 4371 p++; 4372 precision_specified = 1; 4373 if (*p == '*') 4374 { 4375 int j; 4376 4377 j = 4378 # if defined(FEAT_EVAL) 4379 tvs != NULL ? tv_nr(tvs, &arg_idx) : 4380 # endif 4381 va_arg(ap, int); 4382 p++; 4383 if (j >= 0) 4384 precision = j; 4385 else 4386 { 4387 precision_specified = 0; 4388 precision = 0; 4389 } 4390 } 4391 else if (VIM_ISDIGIT((int)(*p))) 4392 { 4393 /* size_t could be wider than unsigned int; make sure we 4394 * treat argument like common implementations do */ 4395 unsigned int uj = *p++ - '0'; 4396 4397 while (VIM_ISDIGIT((int)(*p))) 4398 uj = 10 * uj + (unsigned int)(*p++ - '0'); 4399 precision = uj; 4400 } 4401 } 4402 4403 /* parse 'h', 'l' and 'll' length modifiers */ 4404 if (*p == 'h' || *p == 'l') 4405 { 4406 length_modifier = *p; 4407 p++; 4408 if (length_modifier == 'l' && *p == 'l') 4409 { 4410 /* double l = long long */ 4411 # ifdef FEAT_NUM64 4412 length_modifier = 'L'; 4413 # else 4414 length_modifier = 'l'; /* treat it as a single 'l' */ 4415 # endif 4416 p++; 4417 } 4418 } 4419 fmt_spec = *p; 4420 4421 /* common synonyms: */ 4422 switch (fmt_spec) 4423 { 4424 case 'i': fmt_spec = 'd'; break; 4425 case 'D': fmt_spec = 'd'; length_modifier = 'l'; break; 4426 case 'U': fmt_spec = 'u'; length_modifier = 'l'; break; 4427 case 'O': fmt_spec = 'o'; length_modifier = 'l'; break; 4428 default: break; 4429 } 4430 4431 # if defined(FEAT_EVAL) && defined(FEAT_NUM64) 4432 switch (fmt_spec) 4433 { 4434 case 'd': case 'u': case 'o': case 'x': case 'X': 4435 if (tvs != NULL && length_modifier == '\0') 4436 length_modifier = 'L'; 4437 } 4438 # endif 4439 4440 /* get parameter value, do initial processing */ 4441 switch (fmt_spec) 4442 { 4443 /* '%' and 'c' behave similar to 's' regarding flags and field 4444 * widths */ 4445 case '%': 4446 case 'c': 4447 case 's': 4448 case 'S': 4449 length_modifier = '\0'; 4450 str_arg_l = 1; 4451 switch (fmt_spec) 4452 { 4453 case '%': 4454 str_arg = p; 4455 break; 4456 4457 case 'c': 4458 { 4459 int j; 4460 4461 j = 4462 # if defined(FEAT_EVAL) 4463 tvs != NULL ? tv_nr(tvs, &arg_idx) : 4464 # endif 4465 va_arg(ap, int); 4466 /* standard demands unsigned char */ 4467 uchar_arg = (unsigned char)j; 4468 str_arg = (char *)&uchar_arg; 4469 break; 4470 } 4471 4472 case 's': 4473 case 'S': 4474 str_arg = 4475 # if defined(FEAT_EVAL) 4476 tvs != NULL ? tv_str(tvs, &arg_idx, &tofree) : 4477 # endif 4478 va_arg(ap, char *); 4479 if (str_arg == NULL) 4480 { 4481 str_arg = "[NULL]"; 4482 str_arg_l = 6; 4483 } 4484 /* make sure not to address string beyond the specified 4485 * precision !!! */ 4486 else if (!precision_specified) 4487 str_arg_l = strlen(str_arg); 4488 /* truncate string if necessary as requested by precision */ 4489 else if (precision == 0) 4490 str_arg_l = 0; 4491 else 4492 { 4493 /* Don't put the #if inside memchr(), it can be a 4494 * macro. */ 4495 /* memchr on HP does not like n > 2^31 !!! */ 4496 char *q = memchr(str_arg, '\0', 4497 precision <= (size_t)0x7fffffffL ? precision 4498 : (size_t)0x7fffffffL); 4499 str_arg_l = (q == NULL) ? precision 4500 : (size_t)(q - str_arg); 4501 } 4502 if (fmt_spec == 'S') 4503 { 4504 if (min_field_width != 0) 4505 min_field_width += STRLEN(str_arg) 4506 - mb_string2cells((char_u *)str_arg, -1); 4507 if (precision) 4508 { 4509 char_u *p1 = (char_u *)str_arg; 4510 size_t i; 4511 4512 for (i = 0; i < precision && *p1; i++) 4513 p1 += mb_ptr2len(p1); 4514 4515 str_arg_l = precision = p1 - (char_u *)str_arg; 4516 } 4517 } 4518 break; 4519 4520 default: 4521 break; 4522 } 4523 break; 4524 4525 case 'd': case 'u': 4526 case 'b': case 'B': 4527 case 'o': 4528 case 'x': case 'X': 4529 case 'p': 4530 { 4531 /* NOTE: the u, b, o, x, X and p conversion specifiers 4532 * imply the value is unsigned; d implies a signed 4533 * value */ 4534 4535 /* 0 if numeric argument is zero (or if pointer is 4536 * NULL for 'p'), +1 if greater than zero (or nonzero 4537 * for unsigned arguments), -1 if negative (unsigned 4538 * argument is never negative) */ 4539 int arg_sign = 0; 4540 4541 /* only defined for length modifier h, or for no 4542 * length modifiers */ 4543 int int_arg = 0; 4544 unsigned int uint_arg = 0; 4545 4546 /* only defined for length modifier l */ 4547 long int long_arg = 0; 4548 unsigned long int ulong_arg = 0; 4549 4550 # ifdef FEAT_NUM64 4551 /* only defined for length modifier ll */ 4552 varnumber_T llong_arg = 0; 4553 uvarnumber_T ullong_arg = 0; 4554 # endif 4555 4556 /* only defined for b conversion */ 4557 uvarnumber_T bin_arg = 0; 4558 4559 /* pointer argument value -only defined for p 4560 * conversion */ 4561 void *ptr_arg = NULL; 4562 4563 if (fmt_spec == 'p') 4564 { 4565 length_modifier = '\0'; 4566 ptr_arg = 4567 # if defined(FEAT_EVAL) 4568 tvs != NULL ? (void *)tv_str(tvs, &arg_idx, 4569 NULL) : 4570 # endif 4571 va_arg(ap, void *); 4572 if (ptr_arg != NULL) 4573 arg_sign = 1; 4574 } 4575 else if (fmt_spec == 'b' || fmt_spec == 'B') 4576 { 4577 bin_arg = 4578 # if defined(FEAT_EVAL) 4579 tvs != NULL ? 4580 (uvarnumber_T)tv_nr(tvs, &arg_idx) : 4581 # endif 4582 va_arg(ap, uvarnumber_T); 4583 if (bin_arg != 0) 4584 arg_sign = 1; 4585 } 4586 else if (fmt_spec == 'd') 4587 { 4588 /* signed */ 4589 switch (length_modifier) 4590 { 4591 case '\0': 4592 case 'h': 4593 /* char and short arguments are passed as int. */ 4594 int_arg = 4595 # if defined(FEAT_EVAL) 4596 tvs != NULL ? tv_nr(tvs, &arg_idx) : 4597 # endif 4598 va_arg(ap, int); 4599 if (int_arg > 0) 4600 arg_sign = 1; 4601 else if (int_arg < 0) 4602 arg_sign = -1; 4603 break; 4604 case 'l': 4605 long_arg = 4606 # if defined(FEAT_EVAL) 4607 tvs != NULL ? tv_nr(tvs, &arg_idx) : 4608 # endif 4609 va_arg(ap, long int); 4610 if (long_arg > 0) 4611 arg_sign = 1; 4612 else if (long_arg < 0) 4613 arg_sign = -1; 4614 break; 4615 # ifdef FEAT_NUM64 4616 case 'L': 4617 llong_arg = 4618 # if defined(FEAT_EVAL) 4619 tvs != NULL ? tv_nr(tvs, &arg_idx) : 4620 # endif 4621 va_arg(ap, varnumber_T); 4622 if (llong_arg > 0) 4623 arg_sign = 1; 4624 else if (llong_arg < 0) 4625 arg_sign = -1; 4626 break; 4627 # endif 4628 } 4629 } 4630 else 4631 { 4632 /* unsigned */ 4633 switch (length_modifier) 4634 { 4635 case '\0': 4636 case 'h': 4637 uint_arg = 4638 # if defined(FEAT_EVAL) 4639 tvs != NULL ? (unsigned) 4640 tv_nr(tvs, &arg_idx) : 4641 # endif 4642 va_arg(ap, unsigned int); 4643 if (uint_arg != 0) 4644 arg_sign = 1; 4645 break; 4646 case 'l': 4647 ulong_arg = 4648 # if defined(FEAT_EVAL) 4649 tvs != NULL ? (unsigned long) 4650 tv_nr(tvs, &arg_idx) : 4651 # endif 4652 va_arg(ap, unsigned long int); 4653 if (ulong_arg != 0) 4654 arg_sign = 1; 4655 break; 4656 # ifdef FEAT_NUM64 4657 case 'L': 4658 ullong_arg = 4659 # if defined(FEAT_EVAL) 4660 tvs != NULL ? (uvarnumber_T) 4661 tv_nr(tvs, &arg_idx) : 4662 # endif 4663 va_arg(ap, uvarnumber_T); 4664 if (ullong_arg != 0) 4665 arg_sign = 1; 4666 break; 4667 # endif 4668 } 4669 } 4670 4671 str_arg = tmp; 4672 str_arg_l = 0; 4673 4674 /* NOTE: 4675 * For d, i, u, o, x, and X conversions, if precision is 4676 * specified, the '0' flag should be ignored. This is so 4677 * with Solaris 2.6, Digital UNIX 4.0, HPUX 10, Linux, 4678 * FreeBSD, NetBSD; but not with Perl. 4679 */ 4680 if (precision_specified) 4681 zero_padding = 0; 4682 if (fmt_spec == 'd') 4683 { 4684 if (force_sign && arg_sign >= 0) 4685 tmp[str_arg_l++] = space_for_positive ? ' ' : '+'; 4686 /* leave negative numbers for sprintf to handle, to 4687 * avoid handling tricky cases like (short int)-32768 */ 4688 } 4689 else if (alternate_form) 4690 { 4691 if (arg_sign != 0 4692 && (fmt_spec == 'b' || fmt_spec == 'B' 4693 || fmt_spec == 'x' || fmt_spec == 'X') ) 4694 { 4695 tmp[str_arg_l++] = '0'; 4696 tmp[str_arg_l++] = fmt_spec; 4697 } 4698 /* alternate form should have no effect for p 4699 * conversion, but ... */ 4700 } 4701 4702 zero_padding_insertion_ind = str_arg_l; 4703 if (!precision_specified) 4704 precision = 1; /* default precision is 1 */ 4705 if (precision == 0 && arg_sign == 0) 4706 { 4707 /* When zero value is formatted with an explicit 4708 * precision 0, the resulting formatted string is 4709 * empty (d, i, u, b, B, o, x, X, p). */ 4710 } 4711 else 4712 { 4713 char f[6]; 4714 int f_l = 0; 4715 4716 /* construct a simple format string for sprintf */ 4717 f[f_l++] = '%'; 4718 if (!length_modifier) 4719 ; 4720 else if (length_modifier == 'L') 4721 { 4722 # ifdef FEAT_NUM64 4723 # ifdef WIN3264 4724 f[f_l++] = 'I'; 4725 f[f_l++] = '6'; 4726 f[f_l++] = '4'; 4727 # else 4728 f[f_l++] = 'l'; 4729 f[f_l++] = 'l'; 4730 # endif 4731 # else 4732 f[f_l++] = 'l'; 4733 # endif 4734 } 4735 else 4736 f[f_l++] = length_modifier; 4737 f[f_l++] = fmt_spec; 4738 f[f_l++] = '\0'; 4739 4740 if (fmt_spec == 'p') 4741 str_arg_l += sprintf(tmp + str_arg_l, f, ptr_arg); 4742 else if (fmt_spec == 'b' || fmt_spec == 'B') 4743 { 4744 char b[8 * sizeof(uvarnumber_T)]; 4745 size_t b_l = 0; 4746 uvarnumber_T bn = bin_arg; 4747 4748 do 4749 { 4750 b[sizeof(b) - ++b_l] = '0' + (bn & 0x1); 4751 bn >>= 1; 4752 } 4753 while (bn != 0); 4754 4755 memcpy(tmp + str_arg_l, b + sizeof(b) - b_l, b_l); 4756 str_arg_l += b_l; 4757 } 4758 else if (fmt_spec == 'd') 4759 { 4760 /* signed */ 4761 switch (length_modifier) 4762 { 4763 case '\0': 4764 case 'h': str_arg_l += sprintf( 4765 tmp + str_arg_l, f, int_arg); 4766 break; 4767 case 'l': str_arg_l += sprintf( 4768 tmp + str_arg_l, f, long_arg); 4769 break; 4770 # ifdef FEAT_NUM64 4771 case 'L': str_arg_l += sprintf( 4772 tmp + str_arg_l, f, llong_arg); 4773 break; 4774 # endif 4775 } 4776 } 4777 else 4778 { 4779 /* unsigned */ 4780 switch (length_modifier) 4781 { 4782 case '\0': 4783 case 'h': str_arg_l += sprintf( 4784 tmp + str_arg_l, f, uint_arg); 4785 break; 4786 case 'l': str_arg_l += sprintf( 4787 tmp + str_arg_l, f, ulong_arg); 4788 break; 4789 # ifdef FEAT_NUM64 4790 case 'L': str_arg_l += sprintf( 4791 tmp + str_arg_l, f, ullong_arg); 4792 break; 4793 # endif 4794 } 4795 } 4796 4797 /* include the optional minus sign and possible 4798 * "0x" in the region before the zero padding 4799 * insertion point */ 4800 if (zero_padding_insertion_ind < str_arg_l 4801 && tmp[zero_padding_insertion_ind] == '-') 4802 zero_padding_insertion_ind++; 4803 if (zero_padding_insertion_ind + 1 < str_arg_l 4804 && tmp[zero_padding_insertion_ind] == '0' 4805 && (tmp[zero_padding_insertion_ind + 1] == 'x' 4806 || tmp[zero_padding_insertion_ind + 1] == 'X')) 4807 zero_padding_insertion_ind += 2; 4808 } 4809 4810 { 4811 size_t num_of_digits = str_arg_l 4812 - zero_padding_insertion_ind; 4813 4814 if (alternate_form && fmt_spec == 'o' 4815 /* unless zero is already the first 4816 * character */ 4817 && !(zero_padding_insertion_ind < str_arg_l 4818 && tmp[zero_padding_insertion_ind] == '0')) 4819 { 4820 /* assure leading zero for alternate-form 4821 * octal numbers */ 4822 if (!precision_specified 4823 || precision < num_of_digits + 1) 4824 { 4825 /* precision is increased to force the 4826 * first character to be zero, except if a 4827 * zero value is formatted with an 4828 * explicit precision of zero */ 4829 precision = num_of_digits + 1; 4830 precision_specified = 1; 4831 } 4832 } 4833 /* zero padding to specified precision? */ 4834 if (num_of_digits < precision) 4835 number_of_zeros_to_pad = precision - num_of_digits; 4836 } 4837 /* zero padding to specified minimal field width? */ 4838 if (!justify_left && zero_padding) 4839 { 4840 int n = (int)(min_field_width - (str_arg_l 4841 + number_of_zeros_to_pad)); 4842 if (n > 0) 4843 number_of_zeros_to_pad += n; 4844 } 4845 break; 4846 } 4847 4848 # ifdef FEAT_FLOAT 4849 case 'f': 4850 case 'F': 4851 case 'e': 4852 case 'E': 4853 case 'g': 4854 case 'G': 4855 { 4856 /* Floating point. */ 4857 double f; 4858 double abs_f; 4859 char format[40]; 4860 int l; 4861 int remove_trailing_zeroes = FALSE; 4862 4863 f = 4864 # if defined(FEAT_EVAL) 4865 tvs != NULL ? tv_float(tvs, &arg_idx) : 4866 # endif 4867 va_arg(ap, double); 4868 abs_f = f < 0 ? -f : f; 4869 4870 if (fmt_spec == 'g' || fmt_spec == 'G') 4871 { 4872 /* Would be nice to use %g directly, but it prints 4873 * "1.0" as "1", we don't want that. */ 4874 if ((abs_f >= 0.001 && abs_f < 10000000.0) 4875 || abs_f == 0.0) 4876 fmt_spec = ASCII_ISUPPER(fmt_spec) ? 'F' : 'f'; 4877 else 4878 fmt_spec = fmt_spec == 'g' ? 'e' : 'E'; 4879 remove_trailing_zeroes = TRUE; 4880 } 4881 4882 if ((fmt_spec == 'f' || fmt_spec == 'F') && 4883 # ifdef VAX 4884 abs_f > 1.0e38 4885 # else 4886 abs_f > 1.0e307 4887 # endif 4888 ) 4889 { 4890 /* Avoid a buffer overflow */ 4891 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec, 4892 force_sign, space_for_positive)); 4893 str_arg_l = STRLEN(tmp); 4894 zero_padding = 0; 4895 } 4896 else 4897 { 4898 if (isnan(f)) 4899 { 4900 /* Not a number: nan or NAN */ 4901 STRCPY(tmp, ASCII_ISUPPER(fmt_spec) ? "NAN" 4902 : "nan"); 4903 str_arg_l = 3; 4904 zero_padding = 0; 4905 } 4906 else if (isinf(f)) 4907 { 4908 STRCPY(tmp, infinity_str(f > 0.0, fmt_spec, 4909 force_sign, space_for_positive)); 4910 str_arg_l = STRLEN(tmp); 4911 zero_padding = 0; 4912 } 4913 else 4914 { 4915 /* Regular float number */ 4916 format[0] = '%'; 4917 l = 1; 4918 if (force_sign) 4919 format[l++] = space_for_positive ? ' ' : '+'; 4920 if (precision_specified) 4921 { 4922 size_t max_prec = TMP_LEN - 10; 4923 4924 /* Make sure we don't get more digits than we 4925 * have room for. */ 4926 if ((fmt_spec == 'f' || fmt_spec == 'F') 4927 && abs_f > 1.0) 4928 max_prec -= (size_t)log10(abs_f); 4929 if (precision > max_prec) 4930 precision = max_prec; 4931 l += sprintf(format + l, ".%d", (int)precision); 4932 } 4933 format[l] = fmt_spec == 'F' ? 'f' : fmt_spec; 4934 format[l + 1] = NUL; 4935 4936 str_arg_l = sprintf(tmp, format, f); 4937 } 4938 4939 if (remove_trailing_zeroes) 4940 { 4941 int i; 4942 char *tp; 4943 4944 /* Using %g or %G: remove superfluous zeroes. */ 4945 if (fmt_spec == 'f' || fmt_spec == 'F') 4946 tp = tmp + str_arg_l - 1; 4947 else 4948 { 4949 tp = (char *)vim_strchr((char_u *)tmp, 4950 fmt_spec == 'e' ? 'e' : 'E'); 4951 if (tp != NULL) 4952 { 4953 /* Remove superfluous '+' and leading 4954 * zeroes from the exponent. */ 4955 if (tp[1] == '+') 4956 { 4957 /* Change "1.0e+07" to "1.0e07" */ 4958 STRMOVE(tp + 1, tp + 2); 4959 --str_arg_l; 4960 } 4961 i = (tp[1] == '-') ? 2 : 1; 4962 while (tp[i] == '0') 4963 { 4964 /* Change "1.0e07" to "1.0e7" */ 4965 STRMOVE(tp + i, tp + i + 1); 4966 --str_arg_l; 4967 } 4968 --tp; 4969 } 4970 } 4971 4972 if (tp != NULL && !precision_specified) 4973 /* Remove trailing zeroes, but keep the one 4974 * just after a dot. */ 4975 while (tp > tmp + 2 && *tp == '0' 4976 && tp[-1] != '.') 4977 { 4978 STRMOVE(tp, tp + 1); 4979 --tp; 4980 --str_arg_l; 4981 } 4982 } 4983 else 4984 { 4985 char *tp; 4986 4987 /* Be consistent: some printf("%e") use 1.0e+12 4988 * and some 1.0e+012. Remove one zero in the last 4989 * case. */ 4990 tp = (char *)vim_strchr((char_u *)tmp, 4991 fmt_spec == 'e' ? 'e' : 'E'); 4992 if (tp != NULL && (tp[1] == '+' || tp[1] == '-') 4993 && tp[2] == '0' 4994 && vim_isdigit(tp[3]) 4995 && vim_isdigit(tp[4])) 4996 { 4997 STRMOVE(tp + 2, tp + 3); 4998 --str_arg_l; 4999 } 5000 } 5001 } 5002 if (zero_padding && min_field_width > str_arg_l 5003 && (tmp[0] == '-' || force_sign)) 5004 { 5005 /* padding 0's should be inserted after the sign */ 5006 number_of_zeros_to_pad = min_field_width - str_arg_l; 5007 zero_padding_insertion_ind = 1; 5008 } 5009 str_arg = tmp; 5010 break; 5011 } 5012 # endif 5013 5014 default: 5015 /* unrecognized conversion specifier, keep format string 5016 * as-is */ 5017 zero_padding = 0; /* turn zero padding off for non-numeric 5018 conversion */ 5019 justify_left = 1; 5020 min_field_width = 0; /* reset flags */ 5021 5022 /* discard the unrecognized conversion, just keep * 5023 * the unrecognized conversion character */ 5024 str_arg = p; 5025 str_arg_l = 0; 5026 if (*p != NUL) 5027 str_arg_l++; /* include invalid conversion specifier 5028 unchanged if not at end-of-string */ 5029 break; 5030 } 5031 5032 if (*p != NUL) 5033 p++; /* step over the just processed conversion specifier */ 5034 5035 /* insert padding to the left as requested by min_field_width; 5036 * this does not include the zero padding in case of numerical 5037 * conversions*/ 5038 if (!justify_left) 5039 { 5040 /* left padding with blank or zero */ 5041 int pn = (int)(min_field_width - (str_arg_l + number_of_zeros_to_pad)); 5042 5043 if (pn > 0) 5044 { 5045 if (str_l < str_m) 5046 { 5047 size_t avail = str_m - str_l; 5048 5049 vim_memset(str + str_l, zero_padding ? '0' : ' ', 5050 (size_t)pn > avail ? avail 5051 : (size_t)pn); 5052 } 5053 str_l += pn; 5054 } 5055 } 5056 5057 /* zero padding as requested by the precision or by the minimal 5058 * field width for numeric conversions required? */ 5059 if (number_of_zeros_to_pad == 0) 5060 { 5061 /* will not copy first part of numeric right now, * 5062 * force it to be copied later in its entirety */ 5063 zero_padding_insertion_ind = 0; 5064 } 5065 else 5066 { 5067 /* insert first part of numerics (sign or '0x') before zero 5068 * padding */ 5069 int zn = (int)zero_padding_insertion_ind; 5070 5071 if (zn > 0) 5072 { 5073 if (str_l < str_m) 5074 { 5075 size_t avail = str_m - str_l; 5076 5077 mch_memmove(str + str_l, str_arg, 5078 (size_t)zn > avail ? avail 5079 : (size_t)zn); 5080 } 5081 str_l += zn; 5082 } 5083 5084 /* insert zero padding as requested by the precision or min 5085 * field width */ 5086 zn = (int)number_of_zeros_to_pad; 5087 if (zn > 0) 5088 { 5089 if (str_l < str_m) 5090 { 5091 size_t avail = str_m - str_l; 5092 5093 vim_memset(str + str_l, '0', 5094 (size_t)zn > avail ? avail 5095 : (size_t)zn); 5096 } 5097 str_l += zn; 5098 } 5099 } 5100 5101 /* insert formatted string 5102 * (or as-is conversion specifier for unknown conversions) */ 5103 { 5104 int sn = (int)(str_arg_l - zero_padding_insertion_ind); 5105 5106 if (sn > 0) 5107 { 5108 if (str_l < str_m) 5109 { 5110 size_t avail = str_m - str_l; 5111 5112 mch_memmove(str + str_l, 5113 str_arg + zero_padding_insertion_ind, 5114 (size_t)sn > avail ? avail : (size_t)sn); 5115 } 5116 str_l += sn; 5117 } 5118 } 5119 5120 /* insert right padding */ 5121 if (justify_left) 5122 { 5123 /* right blank padding to the field width */ 5124 int pn = (int)(min_field_width 5125 - (str_arg_l + number_of_zeros_to_pad)); 5126 5127 if (pn > 0) 5128 { 5129 if (str_l < str_m) 5130 { 5131 size_t avail = str_m - str_l; 5132 5133 vim_memset(str + str_l, ' ', 5134 (size_t)pn > avail ? avail 5135 : (size_t)pn); 5136 } 5137 str_l += pn; 5138 } 5139 } 5140 vim_free(tofree); 5141 } 5142 } 5143 5144 if (str_m > 0) 5145 { 5146 /* make sure the string is nul-terminated even at the expense of 5147 * overwriting the last character (shouldn't happen, but just in case) 5148 * */ 5149 str[str_l <= str_m - 1 ? str_l : str_m - 1] = '\0'; 5150 } 5151 5152 if (tvs != NULL && tvs[arg_idx - 1].v_type != VAR_UNKNOWN) 5153 emsg(_("E767: Too many arguments to printf()")); 5154 5155 /* Return the number of characters formatted (excluding trailing nul 5156 * character), that is, the number of characters that would have been 5157 * written to the buffer if it were large enough. */ 5158 return (int)str_l; 5159 } 5160 5161 #endif /* PROTO */ 5162