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