1 /* vi:set ts=8 sts=4 sw=4 noet: 2 * 3 * VIM - Vi IMproved by Bram Moolenaar 4 * 5 * Do ":help uganda" in Vim to read copying and usage conditions. 6 * Do ":help credits" in Vim to see a list of people who contributed. 7 * See README.txt for an overview of the Vim source code. 8 */ 9 10 /* 11 * misc2.c: Various functions. 12 */ 13 #include "vim.h" 14 15 static char_u *username = NULL; // cached result of mch_get_user_name() 16 17 static int coladvance2(pos_T *pos, int addspaces, int finetune, colnr_T wcol); 18 19 /* 20 * Return TRUE if in the current mode we need to use virtual. 21 */ 22 int 23 virtual_active(void) 24 { 25 // While an operator is being executed we return "virtual_op", because 26 // VIsual_active has already been reset, thus we can't check for "block" 27 // being used. 28 if (virtual_op != MAYBE) 29 return virtual_op; 30 return (ve_flags == VE_ALL 31 || ((ve_flags & VE_BLOCK) && VIsual_active && VIsual_mode == Ctrl_V) 32 || ((ve_flags & VE_INSERT) && (State & INSERT))); 33 } 34 35 /* 36 * Get the screen position of the cursor. 37 */ 38 int 39 getviscol(void) 40 { 41 colnr_T x; 42 43 getvvcol(curwin, &curwin->w_cursor, &x, NULL, NULL); 44 return (int)x; 45 } 46 47 /* 48 * Go to column "wcol", and add/insert white space as necessary to get the 49 * cursor in that column. 50 * The caller must have saved the cursor line for undo! 51 */ 52 int 53 coladvance_force(colnr_T wcol) 54 { 55 int rc = coladvance2(&curwin->w_cursor, TRUE, FALSE, wcol); 56 57 if (wcol == MAXCOL) 58 curwin->w_valid &= ~VALID_VIRTCOL; 59 else 60 { 61 // Virtcol is valid 62 curwin->w_valid |= VALID_VIRTCOL; 63 curwin->w_virtcol = wcol; 64 } 65 return rc; 66 } 67 68 /* 69 * Get the screen position of character col with a coladd in the cursor line. 70 */ 71 int 72 getviscol2(colnr_T col, colnr_T coladd UNUSED) 73 { 74 colnr_T x; 75 pos_T pos; 76 77 pos.lnum = curwin->w_cursor.lnum; 78 pos.col = col; 79 pos.coladd = coladd; 80 getvvcol(curwin, &pos, &x, NULL, NULL); 81 return (int)x; 82 } 83 84 /* 85 * Try to advance the Cursor to the specified screen column. 86 * If virtual editing: fine tune the cursor position. 87 * Note that all virtual positions off the end of a line should share 88 * a curwin->w_cursor.col value (n.b. this is equal to STRLEN(line)), 89 * beginning at coladd 0. 90 * 91 * return OK if desired column is reached, FAIL if not 92 */ 93 int 94 coladvance(colnr_T wcol) 95 { 96 int rc = getvpos(&curwin->w_cursor, wcol); 97 98 if (wcol == MAXCOL || rc == FAIL) 99 curwin->w_valid &= ~VALID_VIRTCOL; 100 else if (*ml_get_cursor() != TAB) 101 { 102 // Virtcol is valid when not on a TAB 103 curwin->w_valid |= VALID_VIRTCOL; 104 curwin->w_virtcol = wcol; 105 } 106 return rc; 107 } 108 109 /* 110 * Return in "pos" the position of the cursor advanced to screen column "wcol". 111 * return OK if desired column is reached, FAIL if not 112 */ 113 int 114 getvpos(pos_T *pos, colnr_T wcol) 115 { 116 return coladvance2(pos, FALSE, virtual_active(), wcol); 117 } 118 119 static int 120 coladvance2( 121 pos_T *pos, 122 int addspaces, // change the text to achieve our goal? 123 int finetune, // change char offset for the exact column 124 colnr_T wcol_arg) // column to move to (can be negative) 125 { 126 colnr_T wcol = wcol_arg; 127 int idx; 128 char_u *ptr; 129 char_u *line; 130 colnr_T col = 0; 131 int csize = 0; 132 int one_more; 133 #ifdef FEAT_LINEBREAK 134 int head = 0; 135 #endif 136 137 one_more = (State & INSERT) 138 || restart_edit != NUL 139 || (VIsual_active && *p_sel != 'o') 140 || ((ve_flags & VE_ONEMORE) && wcol < MAXCOL); 141 line = ml_get_buf(curbuf, pos->lnum, FALSE); 142 143 if (wcol >= MAXCOL) 144 { 145 idx = (int)STRLEN(line) - 1 + one_more; 146 col = wcol; 147 148 if ((addspaces || finetune) && !VIsual_active) 149 { 150 curwin->w_curswant = linetabsize(line) + one_more; 151 if (curwin->w_curswant > 0) 152 --curwin->w_curswant; 153 } 154 } 155 else 156 { 157 int width = curwin->w_width - win_col_off(curwin); 158 159 if (finetune 160 && curwin->w_p_wrap 161 && curwin->w_width != 0 162 && wcol >= (colnr_T)width) 163 { 164 csize = linetabsize(line); 165 if (csize > 0) 166 csize--; 167 168 if (wcol / width > (colnr_T)csize / width 169 && ((State & INSERT) == 0 || (int)wcol > csize + 1)) 170 { 171 // In case of line wrapping don't move the cursor beyond the 172 // right screen edge. In Insert mode allow going just beyond 173 // the last character (like what happens when typing and 174 // reaching the right window edge). 175 wcol = (csize / width + 1) * width - 1; 176 } 177 } 178 179 ptr = line; 180 while (col <= wcol && *ptr != NUL) 181 { 182 // Count a tab for what it's worth (if list mode not on) 183 #ifdef FEAT_LINEBREAK 184 csize = win_lbr_chartabsize(curwin, line, ptr, col, &head); 185 MB_PTR_ADV(ptr); 186 #else 187 csize = lbr_chartabsize_adv(line, &ptr, col); 188 #endif 189 col += csize; 190 } 191 idx = (int)(ptr - line); 192 /* 193 * Handle all the special cases. The virtual_active() check 194 * is needed to ensure that a virtual position off the end of 195 * a line has the correct indexing. The one_more comparison 196 * replaces an explicit add of one_more later on. 197 */ 198 if (col > wcol || (!virtual_active() && one_more == 0)) 199 { 200 idx -= 1; 201 # ifdef FEAT_LINEBREAK 202 // Don't count the chars from 'showbreak'. 203 csize -= head; 204 # endif 205 col -= csize; 206 } 207 208 if (virtual_active() 209 && addspaces 210 && wcol >= 0 211 && ((col != wcol && col != wcol + 1) || csize > 1)) 212 { 213 // 'virtualedit' is set: The difference between wcol and col is 214 // filled with spaces. 215 216 if (line[idx] == NUL) 217 { 218 // Append spaces 219 int correct = wcol - col; 220 char_u *newline = alloc(idx + correct + 1); 221 int t; 222 223 if (newline == NULL) 224 return FAIL; 225 226 for (t = 0; t < idx; ++t) 227 newline[t] = line[t]; 228 229 for (t = 0; t < correct; ++t) 230 newline[t + idx] = ' '; 231 232 newline[idx + correct] = NUL; 233 234 ml_replace(pos->lnum, newline, FALSE); 235 changed_bytes(pos->lnum, (colnr_T)idx); 236 idx += correct; 237 col = wcol; 238 } 239 else 240 { 241 // Break a tab 242 int linelen = (int)STRLEN(line); 243 int correct = wcol - col - csize + 1; // negative!! 244 char_u *newline; 245 int t, s = 0; 246 int v; 247 248 if (-correct > csize) 249 return FAIL; 250 251 newline = alloc(linelen + csize); 252 if (newline == NULL) 253 return FAIL; 254 255 for (t = 0; t < linelen; t++) 256 { 257 if (t != idx) 258 newline[s++] = line[t]; 259 else 260 for (v = 0; v < csize; v++) 261 newline[s++] = ' '; 262 } 263 264 newline[linelen + csize - 1] = NUL; 265 266 ml_replace(pos->lnum, newline, FALSE); 267 changed_bytes(pos->lnum, idx); 268 idx += (csize - 1 + correct); 269 col += correct; 270 } 271 } 272 } 273 274 if (idx < 0) 275 pos->col = 0; 276 else 277 pos->col = idx; 278 279 pos->coladd = 0; 280 281 if (finetune) 282 { 283 if (wcol == MAXCOL) 284 { 285 // The width of the last character is used to set coladd. 286 if (!one_more) 287 { 288 colnr_T scol, ecol; 289 290 getvcol(curwin, pos, &scol, NULL, &ecol); 291 pos->coladd = ecol - scol; 292 } 293 } 294 else 295 { 296 int b = (int)wcol - (int)col; 297 298 // The difference between wcol and col is used to set coladd. 299 if (b > 0 && b < (MAXCOL - 2 * curwin->w_width)) 300 pos->coladd = b; 301 302 col += b; 303 } 304 } 305 306 // prevent from moving onto a trail byte 307 if (has_mbyte) 308 mb_adjustpos(curbuf, pos); 309 310 if (wcol < 0 || col < wcol) 311 return FAIL; 312 return OK; 313 } 314 315 /* 316 * Increment the cursor position. See inc() for return values. 317 */ 318 int 319 inc_cursor(void) 320 { 321 return inc(&curwin->w_cursor); 322 } 323 324 /* 325 * Increment the line pointer "lp" crossing line boundaries as necessary. 326 * Return 1 when going to the next line. 327 * Return 2 when moving forward onto a NUL at the end of the line). 328 * Return -1 when at the end of file. 329 * Return 0 otherwise. 330 */ 331 int 332 inc(pos_T *lp) 333 { 334 char_u *p; 335 336 // when searching position may be set to end of a line 337 if (lp->col != MAXCOL) 338 { 339 p = ml_get_pos(lp); 340 if (*p != NUL) // still within line, move to next char (may be NUL) 341 { 342 if (has_mbyte) 343 { 344 int l = (*mb_ptr2len)(p); 345 346 lp->col += l; 347 return ((p[l] != NUL) ? 0 : 2); 348 } 349 lp->col++; 350 lp->coladd = 0; 351 return ((p[1] != NUL) ? 0 : 2); 352 } 353 } 354 if (lp->lnum != curbuf->b_ml.ml_line_count) // there is a next line 355 { 356 lp->col = 0; 357 lp->lnum++; 358 lp->coladd = 0; 359 return 1; 360 } 361 return -1; 362 } 363 364 /* 365 * incl(lp): same as inc(), but skip the NUL at the end of non-empty lines 366 */ 367 int 368 incl(pos_T *lp) 369 { 370 int r; 371 372 if ((r = inc(lp)) >= 1 && lp->col) 373 r = inc(lp); 374 return r; 375 } 376 377 /* 378 * dec(p) 379 * 380 * Decrement the line pointer 'p' crossing line boundaries as necessary. 381 * Return 1 when crossing a line, -1 when at start of file, 0 otherwise. 382 */ 383 int 384 dec_cursor(void) 385 { 386 return dec(&curwin->w_cursor); 387 } 388 389 int 390 dec(pos_T *lp) 391 { 392 char_u *p; 393 394 lp->coladd = 0; 395 if (lp->col == MAXCOL) 396 { 397 // past end of line 398 p = ml_get(lp->lnum); 399 lp->col = (colnr_T)STRLEN(p); 400 if (has_mbyte) 401 lp->col -= (*mb_head_off)(p, p + lp->col); 402 return 0; 403 } 404 405 if (lp->col > 0) 406 { 407 // still within line 408 lp->col--; 409 if (has_mbyte) 410 { 411 p = ml_get(lp->lnum); 412 lp->col -= (*mb_head_off)(p, p + lp->col); 413 } 414 return 0; 415 } 416 417 if (lp->lnum > 1) 418 { 419 // there is a prior line 420 lp->lnum--; 421 p = ml_get(lp->lnum); 422 lp->col = (colnr_T)STRLEN(p); 423 if (has_mbyte) 424 lp->col -= (*mb_head_off)(p, p + lp->col); 425 return 1; 426 } 427 428 // at start of file 429 return -1; 430 } 431 432 /* 433 * decl(lp): same as dec(), but skip the NUL at the end of non-empty lines 434 */ 435 int 436 decl(pos_T *lp) 437 { 438 int r; 439 440 if ((r = dec(lp)) == 1 && lp->col) 441 r = dec(lp); 442 return r; 443 } 444 445 /* 446 * Get the line number relative to the current cursor position, i.e. the 447 * difference between line number and cursor position. Only look for lines that 448 * can be visible, folded lines don't count. 449 */ 450 linenr_T 451 get_cursor_rel_lnum( 452 win_T *wp, 453 linenr_T lnum) // line number to get the result for 454 { 455 linenr_T cursor = wp->w_cursor.lnum; 456 linenr_T retval = 0; 457 458 #ifdef FEAT_FOLDING 459 if (hasAnyFolding(wp)) 460 { 461 if (lnum > cursor) 462 { 463 while (lnum > cursor) 464 { 465 (void)hasFoldingWin(wp, lnum, &lnum, NULL, TRUE, NULL); 466 // if lnum and cursor are in the same fold, 467 // now lnum <= cursor 468 if (lnum > cursor) 469 retval++; 470 lnum--; 471 } 472 } 473 else if (lnum < cursor) 474 { 475 while (lnum < cursor) 476 { 477 (void)hasFoldingWin(wp, lnum, NULL, &lnum, TRUE, NULL); 478 // if lnum and cursor are in the same fold, 479 // now lnum >= cursor 480 if (lnum < cursor) 481 retval--; 482 lnum++; 483 } 484 } 485 // else if (lnum == cursor) 486 // retval = 0; 487 } 488 else 489 #endif 490 retval = lnum - cursor; 491 492 return retval; 493 } 494 495 /* 496 * Make sure "pos.lnum" and "pos.col" are valid in "buf". 497 * This allows for the col to be on the NUL byte. 498 */ 499 void 500 check_pos(buf_T *buf, pos_T *pos) 501 { 502 char_u *line; 503 colnr_T len; 504 505 if (pos->lnum > buf->b_ml.ml_line_count) 506 pos->lnum = buf->b_ml.ml_line_count; 507 508 if (pos->col > 0) 509 { 510 line = ml_get_buf(buf, pos->lnum, FALSE); 511 len = (colnr_T)STRLEN(line); 512 if (pos->col > len) 513 pos->col = len; 514 } 515 } 516 517 /* 518 * Make sure curwin->w_cursor.lnum is valid. 519 */ 520 void 521 check_cursor_lnum(void) 522 { 523 if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count) 524 { 525 #ifdef FEAT_FOLDING 526 // If there is a closed fold at the end of the file, put the cursor in 527 // its first line. Otherwise in the last line. 528 if (!hasFolding(curbuf->b_ml.ml_line_count, 529 &curwin->w_cursor.lnum, NULL)) 530 #endif 531 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count; 532 } 533 if (curwin->w_cursor.lnum <= 0) 534 curwin->w_cursor.lnum = 1; 535 } 536 537 /* 538 * Make sure curwin->w_cursor.col is valid. 539 */ 540 void 541 check_cursor_col(void) 542 { 543 check_cursor_col_win(curwin); 544 } 545 546 /* 547 * Make sure win->w_cursor.col is valid. 548 */ 549 void 550 check_cursor_col_win(win_T *win) 551 { 552 colnr_T len; 553 colnr_T oldcol = win->w_cursor.col; 554 colnr_T oldcoladd = win->w_cursor.col + win->w_cursor.coladd; 555 556 len = (colnr_T)STRLEN(ml_get_buf(win->w_buffer, win->w_cursor.lnum, FALSE)); 557 if (len == 0) 558 win->w_cursor.col = 0; 559 else if (win->w_cursor.col >= len) 560 { 561 // Allow cursor past end-of-line when: 562 // - in Insert mode or restarting Insert mode 563 // - in Visual mode and 'selection' isn't "old" 564 // - 'virtualedit' is set 565 if ((State & INSERT) || restart_edit 566 || (VIsual_active && *p_sel != 'o') 567 || (ve_flags & VE_ONEMORE) 568 || virtual_active()) 569 win->w_cursor.col = len; 570 else 571 { 572 win->w_cursor.col = len - 1; 573 // Move the cursor to the head byte. 574 if (has_mbyte) 575 mb_adjustpos(win->w_buffer, &win->w_cursor); 576 } 577 } 578 else if (win->w_cursor.col < 0) 579 win->w_cursor.col = 0; 580 581 // If virtual editing is on, we can leave the cursor on the old position, 582 // only we must set it to virtual. But don't do it when at the end of the 583 // line. 584 if (oldcol == MAXCOL) 585 win->w_cursor.coladd = 0; 586 else if (ve_flags == VE_ALL) 587 { 588 if (oldcoladd > win->w_cursor.col) 589 { 590 win->w_cursor.coladd = oldcoladd - win->w_cursor.col; 591 592 // Make sure that coladd is not more than the char width. 593 // Not for the last character, coladd is then used when the cursor 594 // is actually after the last character. 595 if (win->w_cursor.col + 1 < len && win->w_cursor.coladd > 0) 596 { 597 int cs, ce; 598 599 getvcol(win, &win->w_cursor, &cs, NULL, &ce); 600 if (win->w_cursor.coladd > ce - cs) 601 win->w_cursor.coladd = ce - cs; 602 } 603 } 604 else 605 // avoid weird number when there is a miscalculation or overflow 606 win->w_cursor.coladd = 0; 607 } 608 } 609 610 /* 611 * make sure curwin->w_cursor in on a valid character 612 */ 613 void 614 check_cursor(void) 615 { 616 check_cursor_lnum(); 617 check_cursor_col(); 618 } 619 620 #if defined(FEAT_TEXTOBJ) || defined(PROTO) 621 /* 622 * Make sure curwin->w_cursor is not on the NUL at the end of the line. 623 * Allow it when in Visual mode and 'selection' is not "old". 624 */ 625 void 626 adjust_cursor_col(void) 627 { 628 if (curwin->w_cursor.col > 0 629 && (!VIsual_active || *p_sel == 'o') 630 && gchar_cursor() == NUL) 631 --curwin->w_cursor.col; 632 } 633 #endif 634 635 /* 636 * When curwin->w_leftcol has changed, adjust the cursor position. 637 * Return TRUE if the cursor was moved. 638 */ 639 int 640 leftcol_changed(void) 641 { 642 long lastcol; 643 colnr_T s, e; 644 int retval = FALSE; 645 long siso = get_sidescrolloff_value(); 646 647 changed_cline_bef_curs(); 648 lastcol = curwin->w_leftcol + curwin->w_width - curwin_col_off() - 1; 649 validate_virtcol(); 650 651 /* 652 * If the cursor is right or left of the screen, move it to last or first 653 * character. 654 */ 655 if (curwin->w_virtcol > (colnr_T)(lastcol - siso)) 656 { 657 retval = TRUE; 658 coladvance((colnr_T)(lastcol - siso)); 659 } 660 else if (curwin->w_virtcol < curwin->w_leftcol + siso) 661 { 662 retval = TRUE; 663 (void)coladvance((colnr_T)(curwin->w_leftcol + siso)); 664 } 665 666 /* 667 * If the start of the character under the cursor is not on the screen, 668 * advance the cursor one more char. If this fails (last char of the 669 * line) adjust the scrolling. 670 */ 671 getvvcol(curwin, &curwin->w_cursor, &s, NULL, &e); 672 if (e > (colnr_T)lastcol) 673 { 674 retval = TRUE; 675 coladvance(s - 1); 676 } 677 else if (s < curwin->w_leftcol) 678 { 679 retval = TRUE; 680 if (coladvance(e + 1) == FAIL) // there isn't another character 681 { 682 curwin->w_leftcol = s; // adjust w_leftcol instead 683 changed_cline_bef_curs(); 684 } 685 } 686 687 if (retval) 688 curwin->w_set_curswant = TRUE; 689 redraw_later(NOT_VALID); 690 return retval; 691 } 692 693 /********************************************************************** 694 * Various routines dealing with allocation and deallocation of memory. 695 */ 696 697 #if defined(MEM_PROFILE) || defined(PROTO) 698 699 # define MEM_SIZES 8200 700 static long_u mem_allocs[MEM_SIZES]; 701 static long_u mem_frees[MEM_SIZES]; 702 static long_u mem_allocated; 703 static long_u mem_freed; 704 static long_u mem_peak; 705 static long_u num_alloc; 706 static long_u num_freed; 707 708 static void 709 mem_pre_alloc_s(size_t *sizep) 710 { 711 *sizep += sizeof(size_t); 712 } 713 714 static void 715 mem_pre_alloc_l(size_t *sizep) 716 { 717 *sizep += sizeof(size_t); 718 } 719 720 static void 721 mem_post_alloc( 722 void **pp, 723 size_t size) 724 { 725 if (*pp == NULL) 726 return; 727 size -= sizeof(size_t); 728 *(long_u *)*pp = size; 729 if (size <= MEM_SIZES-1) 730 mem_allocs[size-1]++; 731 else 732 mem_allocs[MEM_SIZES-1]++; 733 mem_allocated += size; 734 if (mem_allocated - mem_freed > mem_peak) 735 mem_peak = mem_allocated - mem_freed; 736 num_alloc++; 737 *pp = (void *)((char *)*pp + sizeof(size_t)); 738 } 739 740 static void 741 mem_pre_free(void **pp) 742 { 743 long_u size; 744 745 *pp = (void *)((char *)*pp - sizeof(size_t)); 746 size = *(size_t *)*pp; 747 if (size <= MEM_SIZES-1) 748 mem_frees[size-1]++; 749 else 750 mem_frees[MEM_SIZES-1]++; 751 mem_freed += size; 752 num_freed++; 753 } 754 755 /* 756 * called on exit via atexit() 757 */ 758 void 759 vim_mem_profile_dump(void) 760 { 761 int i, j; 762 763 printf("\r\n"); 764 j = 0; 765 for (i = 0; i < MEM_SIZES - 1; i++) 766 { 767 if (mem_allocs[i] || mem_frees[i]) 768 { 769 if (mem_frees[i] > mem_allocs[i]) 770 printf("\r\n%s", _("ERROR: ")); 771 printf("[%4d / %4lu-%-4lu] ", i + 1, mem_allocs[i], mem_frees[i]); 772 j++; 773 if (j > 3) 774 { 775 j = 0; 776 printf("\r\n"); 777 } 778 } 779 } 780 781 i = MEM_SIZES - 1; 782 if (mem_allocs[i]) 783 { 784 printf("\r\n"); 785 if (mem_frees[i] > mem_allocs[i]) 786 puts(_("ERROR: ")); 787 printf("[>%d / %4lu-%-4lu]", i, mem_allocs[i], mem_frees[i]); 788 } 789 790 printf(_("\n[bytes] total alloc-freed %lu-%lu, in use %lu, peak use %lu\n"), 791 mem_allocated, mem_freed, mem_allocated - mem_freed, mem_peak); 792 printf(_("[calls] total re/malloc()'s %lu, total free()'s %lu\n\n"), 793 num_alloc, num_freed); 794 } 795 796 #endif // MEM_PROFILE 797 798 #ifdef FEAT_EVAL 799 int 800 alloc_does_fail(size_t size) 801 { 802 if (alloc_fail_countdown == 0) 803 { 804 if (--alloc_fail_repeat <= 0) 805 alloc_fail_id = 0; 806 do_outofmem_msg(size); 807 return TRUE; 808 } 809 --alloc_fail_countdown; 810 return FALSE; 811 } 812 #endif 813 814 /* 815 * Some memory is reserved for error messages and for being able to 816 * call mf_release_all(), which needs some memory for mf_trans_add(). 817 */ 818 #define KEEP_ROOM (2 * 8192L) 819 #define KEEP_ROOM_KB (KEEP_ROOM / 1024L) 820 821 /* 822 * The normal way to allocate memory. This handles an out-of-memory situation 823 * as well as possible, still returns NULL when we're completely out. 824 */ 825 void * 826 alloc(size_t size) 827 { 828 return lalloc(size, TRUE); 829 } 830 831 /* 832 * alloc() with an ID for alloc_fail(). 833 */ 834 void * 835 alloc_id(size_t size, alloc_id_T id UNUSED) 836 { 837 #ifdef FEAT_EVAL 838 if (alloc_fail_id == id && alloc_does_fail(size)) 839 return NULL; 840 #endif 841 return lalloc(size, TRUE); 842 } 843 844 /* 845 * Allocate memory and set all bytes to zero. 846 */ 847 void * 848 alloc_clear(size_t size) 849 { 850 void *p; 851 852 p = lalloc(size, TRUE); 853 if (p != NULL) 854 (void)vim_memset(p, 0, size); 855 return p; 856 } 857 858 /* 859 * Same as alloc_clear() but with allocation id for testing 860 */ 861 void * 862 alloc_clear_id(size_t size, alloc_id_T id UNUSED) 863 { 864 #ifdef FEAT_EVAL 865 if (alloc_fail_id == id && alloc_does_fail(size)) 866 return NULL; 867 #endif 868 return alloc_clear(size); 869 } 870 871 /* 872 * Allocate memory like lalloc() and set all bytes to zero. 873 */ 874 void * 875 lalloc_clear(size_t size, int message) 876 { 877 void *p; 878 879 p = lalloc(size, message); 880 if (p != NULL) 881 (void)vim_memset(p, 0, size); 882 return p; 883 } 884 885 /* 886 * Low level memory allocation function. 887 * This is used often, KEEP IT FAST! 888 */ 889 void * 890 lalloc(size_t size, int message) 891 { 892 void *p; // pointer to new storage space 893 static int releasing = FALSE; // don't do mf_release_all() recursive 894 int try_again; 895 #if defined(HAVE_AVAIL_MEM) 896 static size_t allocated = 0; // allocated since last avail check 897 #endif 898 899 // Safety check for allocating zero bytes 900 if (size == 0) 901 { 902 // Don't hide this message 903 emsg_silent = 0; 904 iemsg(_("E341: Internal error: lalloc(0, )")); 905 return NULL; 906 } 907 908 #ifdef MEM_PROFILE 909 mem_pre_alloc_l(&size); 910 #endif 911 912 /* 913 * Loop when out of memory: Try to release some memfile blocks and 914 * if some blocks are released call malloc again. 915 */ 916 for (;;) 917 { 918 /* 919 * Handle three kind of systems: 920 * 1. No check for available memory: Just return. 921 * 2. Slow check for available memory: call mch_avail_mem() after 922 * allocating KEEP_ROOM amount of memory. 923 * 3. Strict check for available memory: call mch_avail_mem() 924 */ 925 if ((p = malloc(size)) != NULL) 926 { 927 #ifndef HAVE_AVAIL_MEM 928 // 1. No check for available memory: Just return. 929 goto theend; 930 #else 931 // 2. Slow check for available memory: call mch_avail_mem() after 932 // allocating (KEEP_ROOM / 2) amount of memory. 933 allocated += size; 934 if (allocated < KEEP_ROOM / 2) 935 goto theend; 936 allocated = 0; 937 938 // 3. check for available memory: call mch_avail_mem() 939 if (mch_avail_mem(TRUE) < KEEP_ROOM_KB && !releasing) 940 { 941 free(p); // System is low... no go! 942 p = NULL; 943 } 944 else 945 goto theend; 946 #endif 947 } 948 /* 949 * Remember that mf_release_all() is being called to avoid an endless 950 * loop, because mf_release_all() may call alloc() recursively. 951 */ 952 if (releasing) 953 break; 954 releasing = TRUE; 955 956 clear_sb_text(TRUE); // free any scrollback text 957 try_again = mf_release_all(); // release as many blocks as possible 958 959 releasing = FALSE; 960 if (!try_again) 961 break; 962 } 963 964 if (message && p == NULL) 965 do_outofmem_msg(size); 966 967 theend: 968 #ifdef MEM_PROFILE 969 mem_post_alloc(&p, size); 970 #endif 971 return p; 972 } 973 974 /* 975 * lalloc() with an ID for alloc_fail(). 976 */ 977 #if defined(FEAT_SIGNS) || defined(PROTO) 978 void * 979 lalloc_id(size_t size, int message, alloc_id_T id UNUSED) 980 { 981 #ifdef FEAT_EVAL 982 if (alloc_fail_id == id && alloc_does_fail(size)) 983 return NULL; 984 #endif 985 return (lalloc(size, message)); 986 } 987 #endif 988 989 #if defined(MEM_PROFILE) || defined(PROTO) 990 /* 991 * realloc() with memory profiling. 992 */ 993 void * 994 mem_realloc(void *ptr, size_t size) 995 { 996 void *p; 997 998 mem_pre_free(&ptr); 999 mem_pre_alloc_s(&size); 1000 1001 p = realloc(ptr, size); 1002 1003 mem_post_alloc(&p, size); 1004 1005 return p; 1006 } 1007 #endif 1008 1009 /* 1010 * Avoid repeating the error message many times (they take 1 second each). 1011 * Did_outofmem_msg is reset when a character is read. 1012 */ 1013 void 1014 do_outofmem_msg(size_t size) 1015 { 1016 if (!did_outofmem_msg) 1017 { 1018 // Don't hide this message 1019 emsg_silent = 0; 1020 1021 // Must come first to avoid coming back here when printing the error 1022 // message fails, e.g. when setting v:errmsg. 1023 did_outofmem_msg = TRUE; 1024 1025 semsg(_("E342: Out of memory! (allocating %lu bytes)"), (long_u)size); 1026 1027 if (starting == NO_SCREEN) 1028 // Not even finished with initializations and already out of 1029 // memory? Then nothing is going to work, exit. 1030 mch_exit(123); 1031 } 1032 } 1033 1034 #if defined(EXITFREE) || defined(PROTO) 1035 1036 /* 1037 * Free everything that we allocated. 1038 * Can be used to detect memory leaks, e.g., with ccmalloc. 1039 * NOTE: This is tricky! Things are freed that functions depend on. Don't be 1040 * surprised if Vim crashes... 1041 * Some things can't be freed, esp. things local to a library function. 1042 */ 1043 void 1044 free_all_mem(void) 1045 { 1046 buf_T *buf, *nextbuf; 1047 1048 // When we cause a crash here it is caught and Vim tries to exit cleanly. 1049 // Don't try freeing everything again. 1050 if (entered_free_all_mem) 1051 return; 1052 entered_free_all_mem = TRUE; 1053 1054 // Don't want to trigger autocommands from here on. 1055 block_autocmds(); 1056 1057 // Close all tabs and windows. Reset 'equalalways' to avoid redraws. 1058 p_ea = FALSE; 1059 if (first_tabpage != NULL && first_tabpage->tp_next != NULL) 1060 do_cmdline_cmd((char_u *)"tabonly!"); 1061 if (!ONE_WINDOW) 1062 do_cmdline_cmd((char_u *)"only!"); 1063 1064 # if defined(FEAT_SPELL) 1065 // Free all spell info. 1066 spell_free_all(); 1067 # endif 1068 1069 # if defined(FEAT_BEVAL_TERM) 1070 ui_remove_balloon(); 1071 # endif 1072 # ifdef FEAT_PROP_POPUP 1073 if (curwin != NULL) 1074 close_all_popups(TRUE); 1075 # endif 1076 1077 // Clear user commands (before deleting buffers). 1078 ex_comclear(NULL); 1079 1080 // When exiting from mainerr_arg_missing curbuf has not been initialized, 1081 // and not much else. 1082 if (curbuf != NULL) 1083 { 1084 # ifdef FEAT_MENU 1085 // Clear menus. 1086 do_cmdline_cmd((char_u *)"aunmenu *"); 1087 # ifdef FEAT_MULTI_LANG 1088 do_cmdline_cmd((char_u *)"menutranslate clear"); 1089 # endif 1090 # endif 1091 // Clear mappings, abbreviations, breakpoints. 1092 do_cmdline_cmd((char_u *)"lmapclear"); 1093 do_cmdline_cmd((char_u *)"xmapclear"); 1094 do_cmdline_cmd((char_u *)"mapclear"); 1095 do_cmdline_cmd((char_u *)"mapclear!"); 1096 do_cmdline_cmd((char_u *)"abclear"); 1097 # if defined(FEAT_EVAL) 1098 do_cmdline_cmd((char_u *)"breakdel *"); 1099 # endif 1100 # if defined(FEAT_PROFILE) 1101 do_cmdline_cmd((char_u *)"profdel *"); 1102 # endif 1103 # if defined(FEAT_KEYMAP) 1104 do_cmdline_cmd((char_u *)"set keymap="); 1105 # endif 1106 } 1107 1108 # ifdef FEAT_TITLE 1109 free_titles(); 1110 # endif 1111 # if defined(FEAT_SEARCHPATH) 1112 free_findfile(); 1113 # endif 1114 1115 // Obviously named calls. 1116 free_all_autocmds(); 1117 clear_termcodes(); 1118 free_all_marks(); 1119 alist_clear(&global_alist); 1120 free_homedir(); 1121 free_users(); 1122 free_search_patterns(); 1123 free_old_sub(); 1124 free_last_insert(); 1125 free_insexpand_stuff(); 1126 free_prev_shellcmd(); 1127 free_regexp_stuff(); 1128 free_tag_stuff(); 1129 free_cd_dir(); 1130 # ifdef FEAT_SIGNS 1131 free_signs(); 1132 # endif 1133 # ifdef FEAT_EVAL 1134 set_expr_line(NULL); 1135 # endif 1136 # ifdef FEAT_DIFF 1137 if (curtab != NULL) 1138 diff_clear(curtab); 1139 # endif 1140 clear_sb_text(TRUE); // free any scrollback text 1141 1142 // Free some global vars. 1143 vim_free(username); 1144 # ifdef FEAT_CLIPBOARD 1145 vim_regfree(clip_exclude_prog); 1146 # endif 1147 vim_free(last_cmdline); 1148 vim_free(new_last_cmdline); 1149 set_keep_msg(NULL, 0); 1150 1151 // Clear cmdline history. 1152 p_hi = 0; 1153 init_history(); 1154 # ifdef FEAT_PROP_POPUP 1155 clear_global_prop_types(); 1156 # endif 1157 1158 # ifdef FEAT_QUICKFIX 1159 { 1160 win_T *win; 1161 tabpage_T *tab; 1162 1163 qf_free_all(NULL); 1164 // Free all location lists 1165 FOR_ALL_TAB_WINDOWS(tab, win) 1166 qf_free_all(win); 1167 } 1168 # endif 1169 1170 // Close all script inputs. 1171 close_all_scripts(); 1172 1173 if (curwin != NULL) 1174 // Destroy all windows. Must come before freeing buffers. 1175 win_free_all(); 1176 1177 // Free all option values. Must come after closing windows. 1178 free_all_options(); 1179 1180 // Free all buffers. Reset 'autochdir' to avoid accessing things that 1181 // were freed already. 1182 # ifdef FEAT_AUTOCHDIR 1183 p_acd = FALSE; 1184 # endif 1185 for (buf = firstbuf; buf != NULL; ) 1186 { 1187 bufref_T bufref; 1188 1189 set_bufref(&bufref, buf); 1190 nextbuf = buf->b_next; 1191 close_buffer(NULL, buf, DOBUF_WIPE, FALSE, FALSE); 1192 if (bufref_valid(&bufref)) 1193 buf = nextbuf; // didn't work, try next one 1194 else 1195 buf = firstbuf; 1196 } 1197 1198 # ifdef FEAT_ARABIC 1199 free_arshape_buf(); 1200 # endif 1201 1202 // Clear registers. 1203 clear_registers(); 1204 ResetRedobuff(); 1205 ResetRedobuff(); 1206 1207 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11) 1208 vim_free(serverDelayedStartName); 1209 # endif 1210 1211 // highlight info 1212 free_highlight(); 1213 1214 reset_last_sourcing(); 1215 1216 if (first_tabpage != NULL) 1217 { 1218 free_tabpage(first_tabpage); 1219 first_tabpage = NULL; 1220 } 1221 1222 # ifdef UNIX 1223 // Machine-specific free. 1224 mch_free_mem(); 1225 # endif 1226 1227 // message history 1228 for (;;) 1229 if (delete_first_msg() == FAIL) 1230 break; 1231 1232 # ifdef FEAT_JOB_CHANNEL 1233 channel_free_all(); 1234 # endif 1235 # ifdef FEAT_TIMERS 1236 timer_free_all(); 1237 # endif 1238 # ifdef FEAT_EVAL 1239 // must be after channel_free_all() with unrefs partials 1240 eval_clear(); 1241 # endif 1242 # ifdef FEAT_JOB_CHANNEL 1243 // must be after eval_clear() with unrefs jobs 1244 job_free_all(); 1245 # endif 1246 1247 free_termoptions(); 1248 1249 // screenlines (can't display anything now!) 1250 free_screenlines(); 1251 1252 # if defined(FEAT_SOUND) 1253 sound_free(); 1254 # endif 1255 # if defined(USE_XSMP) 1256 xsmp_close(); 1257 # endif 1258 # ifdef FEAT_GUI_GTK 1259 gui_mch_free_all(); 1260 # endif 1261 clear_hl_tables(); 1262 1263 vim_free(IObuff); 1264 vim_free(NameBuff); 1265 # ifdef FEAT_QUICKFIX 1266 check_quickfix_busy(); 1267 # endif 1268 } 1269 #endif 1270 1271 /* 1272 * Copy "string" into newly allocated memory. 1273 */ 1274 char_u * 1275 vim_strsave(char_u *string) 1276 { 1277 char_u *p; 1278 size_t len; 1279 1280 len = STRLEN(string) + 1; 1281 p = alloc(len); 1282 if (p != NULL) 1283 mch_memmove(p, string, len); 1284 return p; 1285 } 1286 1287 /* 1288 * Copy up to "len" bytes of "string" into newly allocated memory and 1289 * terminate with a NUL. 1290 * The allocated memory always has size "len + 1", also when "string" is 1291 * shorter. 1292 */ 1293 char_u * 1294 vim_strnsave(char_u *string, int len) 1295 { 1296 char_u *p; 1297 1298 p = alloc(len + 1); 1299 if (p != NULL) 1300 { 1301 STRNCPY(p, string, len); 1302 p[len] = NUL; 1303 } 1304 return p; 1305 } 1306 1307 /* 1308 * Copy "p[len]" into allocated memory, ignoring NUL characters. 1309 * Returns NULL when out of memory. 1310 */ 1311 char_u * 1312 vim_memsave(char_u *p, size_t len) 1313 { 1314 char_u *ret = alloc(len); 1315 1316 if (ret != NULL) 1317 mch_memmove(ret, p, len); 1318 return ret; 1319 } 1320 1321 /* 1322 * Same as vim_strsave(), but any characters found in esc_chars are preceded 1323 * by a backslash. 1324 */ 1325 char_u * 1326 vim_strsave_escaped(char_u *string, char_u *esc_chars) 1327 { 1328 return vim_strsave_escaped_ext(string, esc_chars, '\\', FALSE); 1329 } 1330 1331 /* 1332 * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape 1333 * characters where rem_backslash() would remove the backslash. 1334 * Escape the characters with "cc". 1335 */ 1336 char_u * 1337 vim_strsave_escaped_ext( 1338 char_u *string, 1339 char_u *esc_chars, 1340 int cc, 1341 int bsl) 1342 { 1343 char_u *p; 1344 char_u *p2; 1345 char_u *escaped_string; 1346 unsigned length; 1347 int l; 1348 1349 /* 1350 * First count the number of backslashes required. 1351 * Then allocate the memory and insert them. 1352 */ 1353 length = 1; // count the trailing NUL 1354 for (p = string; *p; p++) 1355 { 1356 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1) 1357 { 1358 length += l; // count a multibyte char 1359 p += l - 1; 1360 continue; 1361 } 1362 if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p))) 1363 ++length; // count a backslash 1364 ++length; // count an ordinary char 1365 } 1366 escaped_string = alloc(length); 1367 if (escaped_string != NULL) 1368 { 1369 p2 = escaped_string; 1370 for (p = string; *p; p++) 1371 { 1372 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1) 1373 { 1374 mch_memmove(p2, p, (size_t)l); 1375 p2 += l; 1376 p += l - 1; // skip multibyte char 1377 continue; 1378 } 1379 if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p))) 1380 *p2++ = cc; 1381 *p2++ = *p; 1382 } 1383 *p2 = NUL; 1384 } 1385 return escaped_string; 1386 } 1387 1388 /* 1389 * Return TRUE when 'shell' has "csh" in the tail. 1390 */ 1391 int 1392 csh_like_shell(void) 1393 { 1394 return (strstr((char *)gettail(p_sh), "csh") != NULL); 1395 } 1396 1397 /* 1398 * Escape "string" for use as a shell argument with system(). 1399 * This uses single quotes, except when we know we need to use double quotes 1400 * (MS-DOS and MS-Windows without 'shellslash' set). 1401 * Escape a newline, depending on the 'shell' option. 1402 * When "do_special" is TRUE also replace "!", "%", "#" and things starting 1403 * with "<" like "<cfile>". 1404 * When "do_newline" is FALSE do not escape newline unless it is csh shell. 1405 * Returns the result in allocated memory, NULL if we have run out. 1406 */ 1407 char_u * 1408 vim_strsave_shellescape(char_u *string, int do_special, int do_newline) 1409 { 1410 unsigned length; 1411 char_u *p; 1412 char_u *d; 1413 char_u *escaped_string; 1414 int l; 1415 int csh_like; 1416 1417 // Only csh and similar shells expand '!' within single quotes. For sh and 1418 // the like we must not put a backslash before it, it will be taken 1419 // literally. If do_special is set the '!' will be escaped twice. 1420 // Csh also needs to have "\n" escaped twice when do_special is set. 1421 csh_like = csh_like_shell(); 1422 1423 // First count the number of extra bytes required. 1424 length = (unsigned)STRLEN(string) + 3; // two quotes and a trailing NUL 1425 for (p = string; *p != NUL; MB_PTR_ADV(p)) 1426 { 1427 # ifdef MSWIN 1428 if (!p_ssl) 1429 { 1430 if (*p == '"') 1431 ++length; // " -> "" 1432 } 1433 else 1434 # endif 1435 if (*p == '\'') 1436 length += 3; // ' => '\'' 1437 if ((*p == '\n' && (csh_like || do_newline)) 1438 || (*p == '!' && (csh_like || do_special))) 1439 { 1440 ++length; // insert backslash 1441 if (csh_like && do_special) 1442 ++length; // insert backslash 1443 } 1444 if (do_special && find_cmdline_var(p, &l) >= 0) 1445 { 1446 ++length; // insert backslash 1447 p += l - 1; 1448 } 1449 } 1450 1451 // Allocate memory for the result and fill it. 1452 escaped_string = alloc(length); 1453 if (escaped_string != NULL) 1454 { 1455 d = escaped_string; 1456 1457 // add opening quote 1458 # ifdef MSWIN 1459 if (!p_ssl) 1460 *d++ = '"'; 1461 else 1462 # endif 1463 *d++ = '\''; 1464 1465 for (p = string; *p != NUL; ) 1466 { 1467 # ifdef MSWIN 1468 if (!p_ssl) 1469 { 1470 if (*p == '"') 1471 { 1472 *d++ = '"'; 1473 *d++ = '"'; 1474 ++p; 1475 continue; 1476 } 1477 } 1478 else 1479 # endif 1480 if (*p == '\'') 1481 { 1482 *d++ = '\''; 1483 *d++ = '\\'; 1484 *d++ = '\''; 1485 *d++ = '\''; 1486 ++p; 1487 continue; 1488 } 1489 if ((*p == '\n' && (csh_like || do_newline)) 1490 || (*p == '!' && (csh_like || do_special))) 1491 { 1492 *d++ = '\\'; 1493 if (csh_like && do_special) 1494 *d++ = '\\'; 1495 *d++ = *p++; 1496 continue; 1497 } 1498 if (do_special && find_cmdline_var(p, &l) >= 0) 1499 { 1500 *d++ = '\\'; // insert backslash 1501 while (--l >= 0) // copy the var 1502 *d++ = *p++; 1503 continue; 1504 } 1505 1506 MB_COPY_CHAR(p, d); 1507 } 1508 1509 // add terminating quote and finish with a NUL 1510 # ifdef MSWIN 1511 if (!p_ssl) 1512 *d++ = '"'; 1513 else 1514 # endif 1515 *d++ = '\''; 1516 *d = NUL; 1517 } 1518 1519 return escaped_string; 1520 } 1521 1522 /* 1523 * Like vim_strsave(), but make all characters uppercase. 1524 * This uses ASCII lower-to-upper case translation, language independent. 1525 */ 1526 char_u * 1527 vim_strsave_up(char_u *string) 1528 { 1529 char_u *p1; 1530 1531 p1 = vim_strsave(string); 1532 vim_strup(p1); 1533 return p1; 1534 } 1535 1536 /* 1537 * Like vim_strnsave(), but make all characters uppercase. 1538 * This uses ASCII lower-to-upper case translation, language independent. 1539 */ 1540 char_u * 1541 vim_strnsave_up(char_u *string, int len) 1542 { 1543 char_u *p1; 1544 1545 p1 = vim_strnsave(string, len); 1546 vim_strup(p1); 1547 return p1; 1548 } 1549 1550 /* 1551 * ASCII lower-to-upper case translation, language independent. 1552 */ 1553 void 1554 vim_strup( 1555 char_u *p) 1556 { 1557 char_u *p2; 1558 int c; 1559 1560 if (p != NULL) 1561 { 1562 p2 = p; 1563 while ((c = *p2) != NUL) 1564 #ifdef EBCDIC 1565 *p2++ = isalpha(c) ? toupper(c) : c; 1566 #else 1567 *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20); 1568 #endif 1569 } 1570 } 1571 1572 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO) 1573 /* 1574 * Make string "s" all upper-case and return it in allocated memory. 1575 * Handles multi-byte characters as well as possible. 1576 * Returns NULL when out of memory. 1577 */ 1578 char_u * 1579 strup_save(char_u *orig) 1580 { 1581 char_u *p; 1582 char_u *res; 1583 1584 res = p = vim_strsave(orig); 1585 1586 if (res != NULL) 1587 while (*p != NUL) 1588 { 1589 int l; 1590 1591 if (enc_utf8) 1592 { 1593 int c, uc; 1594 int newl; 1595 char_u *s; 1596 1597 c = utf_ptr2char(p); 1598 l = utf_ptr2len(p); 1599 if (c == 0) 1600 { 1601 // overlong sequence, use only the first byte 1602 c = *p; 1603 l = 1; 1604 } 1605 uc = utf_toupper(c); 1606 1607 // Reallocate string when byte count changes. This is rare, 1608 // thus it's OK to do another malloc()/free(). 1609 newl = utf_char2len(uc); 1610 if (newl != l) 1611 { 1612 s = alloc(STRLEN(res) + 1 + newl - l); 1613 if (s == NULL) 1614 { 1615 vim_free(res); 1616 return NULL; 1617 } 1618 mch_memmove(s, res, p - res); 1619 STRCPY(s + (p - res) + newl, p + l); 1620 p = s + (p - res); 1621 vim_free(res); 1622 res = s; 1623 } 1624 1625 utf_char2bytes(uc, p); 1626 p += newl; 1627 } 1628 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1) 1629 p += l; // skip multi-byte character 1630 else 1631 { 1632 *p = TOUPPER_LOC(*p); // note that toupper() can be a macro 1633 p++; 1634 } 1635 } 1636 1637 return res; 1638 } 1639 1640 /* 1641 * Make string "s" all lower-case and return it in allocated memory. 1642 * Handles multi-byte characters as well as possible. 1643 * Returns NULL when out of memory. 1644 */ 1645 char_u * 1646 strlow_save(char_u *orig) 1647 { 1648 char_u *p; 1649 char_u *res; 1650 1651 res = p = vim_strsave(orig); 1652 1653 if (res != NULL) 1654 while (*p != NUL) 1655 { 1656 int l; 1657 1658 if (enc_utf8) 1659 { 1660 int c, lc; 1661 int newl; 1662 char_u *s; 1663 1664 c = utf_ptr2char(p); 1665 l = utf_ptr2len(p); 1666 if (c == 0) 1667 { 1668 // overlong sequence, use only the first byte 1669 c = *p; 1670 l = 1; 1671 } 1672 lc = utf_tolower(c); 1673 1674 // Reallocate string when byte count changes. This is rare, 1675 // thus it's OK to do another malloc()/free(). 1676 newl = utf_char2len(lc); 1677 if (newl != l) 1678 { 1679 s = alloc(STRLEN(res) + 1 + newl - l); 1680 if (s == NULL) 1681 { 1682 vim_free(res); 1683 return NULL; 1684 } 1685 mch_memmove(s, res, p - res); 1686 STRCPY(s + (p - res) + newl, p + l); 1687 p = s + (p - res); 1688 vim_free(res); 1689 res = s; 1690 } 1691 1692 utf_char2bytes(lc, p); 1693 p += newl; 1694 } 1695 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1) 1696 p += l; // skip multi-byte character 1697 else 1698 { 1699 *p = TOLOWER_LOC(*p); // note that tolower() can be a macro 1700 p++; 1701 } 1702 } 1703 1704 return res; 1705 } 1706 #endif 1707 1708 /* 1709 * delete spaces at the end of a string 1710 */ 1711 void 1712 del_trailing_spaces(char_u *ptr) 1713 { 1714 char_u *q; 1715 1716 q = ptr + STRLEN(ptr); 1717 while (--q > ptr && VIM_ISWHITE(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V) 1718 *q = NUL; 1719 } 1720 1721 /* 1722 * Like strncpy(), but always terminate the result with one NUL. 1723 * "to" must be "len + 1" long! 1724 */ 1725 void 1726 vim_strncpy(char_u *to, char_u *from, size_t len) 1727 { 1728 STRNCPY(to, from, len); 1729 to[len] = NUL; 1730 } 1731 1732 /* 1733 * Like strcat(), but make sure the result fits in "tosize" bytes and is 1734 * always NUL terminated. "from" and "to" may overlap. 1735 */ 1736 void 1737 vim_strcat(char_u *to, char_u *from, size_t tosize) 1738 { 1739 size_t tolen = STRLEN(to); 1740 size_t fromlen = STRLEN(from); 1741 1742 if (tolen + fromlen + 1 > tosize) 1743 { 1744 mch_memmove(to + tolen, from, tosize - tolen - 1); 1745 to[tosize - 1] = NUL; 1746 } 1747 else 1748 mch_memmove(to + tolen, from, fromlen + 1); 1749 } 1750 1751 /* 1752 * Isolate one part of a string option where parts are separated with 1753 * "sep_chars". 1754 * The part is copied into "buf[maxlen]". 1755 * "*option" is advanced to the next part. 1756 * The length is returned. 1757 */ 1758 int 1759 copy_option_part( 1760 char_u **option, 1761 char_u *buf, 1762 int maxlen, 1763 char *sep_chars) 1764 { 1765 int len = 0; 1766 char_u *p = *option; 1767 1768 // skip '.' at start of option part, for 'suffixes' 1769 if (*p == '.') 1770 buf[len++] = *p++; 1771 while (*p != NUL && vim_strchr((char_u *)sep_chars, *p) == NULL) 1772 { 1773 /* 1774 * Skip backslash before a separator character and space. 1775 */ 1776 if (p[0] == '\\' && vim_strchr((char_u *)sep_chars, p[1]) != NULL) 1777 ++p; 1778 if (len < maxlen - 1) 1779 buf[len++] = *p; 1780 ++p; 1781 } 1782 buf[len] = NUL; 1783 1784 if (*p != NUL && *p != ',') // skip non-standard separator 1785 ++p; 1786 p = skip_to_option_part(p); // p points to next file name 1787 1788 *option = p; 1789 return len; 1790 } 1791 1792 /* 1793 * Replacement for free() that ignores NULL pointers. 1794 * Also skip free() when exiting for sure, this helps when we caught a deadly 1795 * signal that was caused by a crash in free(). 1796 * If you want to set NULL after calling this function, you should use 1797 * VIM_CLEAR() instead. 1798 */ 1799 void 1800 vim_free(void *x) 1801 { 1802 if (x != NULL && !really_exiting) 1803 { 1804 #ifdef MEM_PROFILE 1805 mem_pre_free(&x); 1806 #endif 1807 free(x); 1808 } 1809 } 1810 1811 #ifndef HAVE_MEMSET 1812 void * 1813 vim_memset(void *ptr, int c, size_t size) 1814 { 1815 char *p = ptr; 1816 1817 while (size-- > 0) 1818 *p++ = c; 1819 return ptr; 1820 } 1821 #endif 1822 1823 #if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO) 1824 /* 1825 * Compare two strings, ignoring case, using current locale. 1826 * Doesn't work for multi-byte characters. 1827 * return 0 for match, < 0 for smaller, > 0 for bigger 1828 */ 1829 int 1830 vim_stricmp(char *s1, char *s2) 1831 { 1832 int i; 1833 1834 for (;;) 1835 { 1836 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2); 1837 if (i != 0) 1838 return i; // this character different 1839 if (*s1 == NUL) 1840 break; // strings match until NUL 1841 ++s1; 1842 ++s2; 1843 } 1844 return 0; // strings match 1845 } 1846 #endif 1847 1848 #if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO) 1849 /* 1850 * Compare two strings, for length "len", ignoring case, using current locale. 1851 * Doesn't work for multi-byte characters. 1852 * return 0 for match, < 0 for smaller, > 0 for bigger 1853 */ 1854 int 1855 vim_strnicmp(char *s1, char *s2, size_t len) 1856 { 1857 int i; 1858 1859 while (len > 0) 1860 { 1861 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2); 1862 if (i != 0) 1863 return i; // this character different 1864 if (*s1 == NUL) 1865 break; // strings match until NUL 1866 ++s1; 1867 ++s2; 1868 --len; 1869 } 1870 return 0; // strings match 1871 } 1872 #endif 1873 1874 /* 1875 * Version of strchr() and strrchr() that handle unsigned char strings 1876 * with characters from 128 to 255 correctly. It also doesn't return a 1877 * pointer to the NUL at the end of the string. 1878 */ 1879 char_u * 1880 vim_strchr(char_u *string, int c) 1881 { 1882 char_u *p; 1883 int b; 1884 1885 p = string; 1886 if (enc_utf8 && c >= 0x80) 1887 { 1888 while (*p != NUL) 1889 { 1890 int l = utfc_ptr2len(p); 1891 1892 // Avoid matching an illegal byte here. 1893 if (utf_ptr2char(p) == c && l > 1) 1894 return p; 1895 p += l; 1896 } 1897 return NULL; 1898 } 1899 if (enc_dbcs != 0 && c > 255) 1900 { 1901 int n2 = c & 0xff; 1902 1903 c = ((unsigned)c >> 8) & 0xff; 1904 while ((b = *p) != NUL) 1905 { 1906 if (b == c && p[1] == n2) 1907 return p; 1908 p += (*mb_ptr2len)(p); 1909 } 1910 return NULL; 1911 } 1912 if (has_mbyte) 1913 { 1914 while ((b = *p) != NUL) 1915 { 1916 if (b == c) 1917 return p; 1918 p += (*mb_ptr2len)(p); 1919 } 1920 return NULL; 1921 } 1922 while ((b = *p) != NUL) 1923 { 1924 if (b == c) 1925 return p; 1926 ++p; 1927 } 1928 return NULL; 1929 } 1930 1931 /* 1932 * Version of strchr() that only works for bytes and handles unsigned char 1933 * strings with characters above 128 correctly. It also doesn't return a 1934 * pointer to the NUL at the end of the string. 1935 */ 1936 char_u * 1937 vim_strbyte(char_u *string, int c) 1938 { 1939 char_u *p = string; 1940 1941 while (*p != NUL) 1942 { 1943 if (*p == c) 1944 return p; 1945 ++p; 1946 } 1947 return NULL; 1948 } 1949 1950 /* 1951 * Search for last occurrence of "c" in "string". 1952 * Return NULL if not found. 1953 * Does not handle multi-byte char for "c"! 1954 */ 1955 char_u * 1956 vim_strrchr(char_u *string, int c) 1957 { 1958 char_u *retval = NULL; 1959 char_u *p = string; 1960 1961 while (*p) 1962 { 1963 if (*p == c) 1964 retval = p; 1965 MB_PTR_ADV(p); 1966 } 1967 return retval; 1968 } 1969 1970 /* 1971 * Vim's version of strpbrk(), in case it's missing. 1972 * Don't generate a prototype for this, causes problems when it's not used. 1973 */ 1974 #ifndef PROTO 1975 # ifndef HAVE_STRPBRK 1976 # ifdef vim_strpbrk 1977 # undef vim_strpbrk 1978 # endif 1979 char_u * 1980 vim_strpbrk(char_u *s, char_u *charset) 1981 { 1982 while (*s) 1983 { 1984 if (vim_strchr(charset, *s) != NULL) 1985 return s; 1986 MB_PTR_ADV(s); 1987 } 1988 return NULL; 1989 } 1990 # endif 1991 #endif 1992 1993 /* 1994 * Vim has its own isspace() function, because on some machines isspace() 1995 * can't handle characters above 128. 1996 */ 1997 int 1998 vim_isspace(int x) 1999 { 2000 return ((x >= 9 && x <= 13) || x == ' '); 2001 } 2002 2003 /************************************************************************ 2004 * Functions for handling growing arrays. 2005 */ 2006 2007 /* 2008 * Clear an allocated growing array. 2009 */ 2010 void 2011 ga_clear(garray_T *gap) 2012 { 2013 vim_free(gap->ga_data); 2014 ga_init(gap); 2015 } 2016 2017 /* 2018 * Clear a growing array that contains a list of strings. 2019 */ 2020 void 2021 ga_clear_strings(garray_T *gap) 2022 { 2023 int i; 2024 2025 for (i = 0; i < gap->ga_len; ++i) 2026 vim_free(((char_u **)(gap->ga_data))[i]); 2027 ga_clear(gap); 2028 } 2029 2030 /* 2031 * Initialize a growing array. Don't forget to set ga_itemsize and 2032 * ga_growsize! Or use ga_init2(). 2033 */ 2034 void 2035 ga_init(garray_T *gap) 2036 { 2037 gap->ga_data = NULL; 2038 gap->ga_maxlen = 0; 2039 gap->ga_len = 0; 2040 } 2041 2042 void 2043 ga_init2(garray_T *gap, int itemsize, int growsize) 2044 { 2045 ga_init(gap); 2046 gap->ga_itemsize = itemsize; 2047 gap->ga_growsize = growsize; 2048 } 2049 2050 /* 2051 * Make room in growing array "gap" for at least "n" items. 2052 * Return FAIL for failure, OK otherwise. 2053 */ 2054 int 2055 ga_grow(garray_T *gap, int n) 2056 { 2057 if (gap->ga_maxlen - gap->ga_len < n) 2058 return ga_grow_inner(gap, n); 2059 return OK; 2060 } 2061 2062 int 2063 ga_grow_inner(garray_T *gap, int n) 2064 { 2065 size_t old_len; 2066 size_t new_len; 2067 char_u *pp; 2068 2069 if (n < gap->ga_growsize) 2070 n = gap->ga_growsize; 2071 2072 // A linear growth is very inefficient when the array grows big. This 2073 // is a compromise between allocating memory that won't be used and too 2074 // many copy operations. A factor of 1.5 seems reasonable. 2075 if (n < gap->ga_len / 2) 2076 n = gap->ga_len / 2; 2077 2078 new_len = gap->ga_itemsize * (gap->ga_len + n); 2079 pp = vim_realloc(gap->ga_data, new_len); 2080 if (pp == NULL) 2081 return FAIL; 2082 old_len = gap->ga_itemsize * gap->ga_maxlen; 2083 vim_memset(pp + old_len, 0, new_len - old_len); 2084 gap->ga_maxlen = gap->ga_len + n; 2085 gap->ga_data = pp; 2086 return OK; 2087 } 2088 2089 #if defined(FEAT_EVAL) || defined(FEAT_SEARCHPATH) || defined(PROTO) 2090 /* 2091 * For a growing array that contains a list of strings: concatenate all the 2092 * strings with a separating "sep". 2093 * Returns NULL when out of memory. 2094 */ 2095 char_u * 2096 ga_concat_strings(garray_T *gap, char *sep) 2097 { 2098 int i; 2099 int len = 0; 2100 int sep_len = (int)STRLEN(sep); 2101 char_u *s; 2102 char_u *p; 2103 2104 for (i = 0; i < gap->ga_len; ++i) 2105 len += (int)STRLEN(((char_u **)(gap->ga_data))[i]) + sep_len; 2106 2107 s = alloc(len + 1); 2108 if (s != NULL) 2109 { 2110 *s = NUL; 2111 p = s; 2112 for (i = 0; i < gap->ga_len; ++i) 2113 { 2114 if (p != s) 2115 { 2116 STRCPY(p, sep); 2117 p += sep_len; 2118 } 2119 STRCPY(p, ((char_u **)(gap->ga_data))[i]); 2120 p += STRLEN(p); 2121 } 2122 } 2123 return s; 2124 } 2125 #endif 2126 2127 #if defined(FEAT_VIMINFO) || defined(FEAT_EVAL) || defined(PROTO) 2128 /* 2129 * Make a copy of string "p" and add it to "gap". 2130 * When out of memory nothing changes. 2131 */ 2132 void 2133 ga_add_string(garray_T *gap, char_u *p) 2134 { 2135 char_u *cp = vim_strsave(p); 2136 2137 if (cp != NULL) 2138 { 2139 if (ga_grow(gap, 1) == OK) 2140 ((char_u **)(gap->ga_data))[gap->ga_len++] = cp; 2141 else 2142 vim_free(cp); 2143 } 2144 } 2145 #endif 2146 2147 /* 2148 * Concatenate a string to a growarray which contains bytes. 2149 * When "s" is NULL does not do anything. 2150 * Note: Does NOT copy the NUL at the end! 2151 */ 2152 void 2153 ga_concat(garray_T *gap, char_u *s) 2154 { 2155 int len; 2156 2157 if (s == NULL || *s == NUL) 2158 return; 2159 len = (int)STRLEN(s); 2160 if (ga_grow(gap, len) == OK) 2161 { 2162 mch_memmove((char *)gap->ga_data + gap->ga_len, s, (size_t)len); 2163 gap->ga_len += len; 2164 } 2165 } 2166 2167 /* 2168 * Append one byte to a growarray which contains bytes. 2169 */ 2170 void 2171 ga_append(garray_T *gap, int c) 2172 { 2173 if (ga_grow(gap, 1) == OK) 2174 { 2175 *((char *)gap->ga_data + gap->ga_len) = c; 2176 ++gap->ga_len; 2177 } 2178 } 2179 2180 #if (defined(UNIX) && !defined(USE_SYSTEM)) || defined(MSWIN) \ 2181 || defined(PROTO) 2182 /* 2183 * Append the text in "gap" below the cursor line and clear "gap". 2184 */ 2185 void 2186 append_ga_line(garray_T *gap) 2187 { 2188 // Remove trailing CR. 2189 if (gap->ga_len > 0 2190 && !curbuf->b_p_bin 2191 && ((char_u *)gap->ga_data)[gap->ga_len - 1] == CAR) 2192 --gap->ga_len; 2193 ga_append(gap, NUL); 2194 ml_append(curwin->w_cursor.lnum++, gap->ga_data, 0, FALSE); 2195 gap->ga_len = 0; 2196 } 2197 #endif 2198 2199 /************************************************************************ 2200 * functions that use lookup tables for various things, generally to do with 2201 * special key codes. 2202 */ 2203 2204 /* 2205 * Some useful tables. 2206 */ 2207 2208 static struct modmasktable 2209 { 2210 short mod_mask; // Bit-mask for particular key modifier 2211 short mod_flag; // Bit(s) for particular key modifier 2212 char_u name; // Single letter name of modifier 2213 } mod_mask_table[] = 2214 { 2215 {MOD_MASK_ALT, MOD_MASK_ALT, (char_u)'M'}, 2216 {MOD_MASK_META, MOD_MASK_META, (char_u)'T'}, 2217 {MOD_MASK_CTRL, MOD_MASK_CTRL, (char_u)'C'}, 2218 {MOD_MASK_SHIFT, MOD_MASK_SHIFT, (char_u)'S'}, 2219 {MOD_MASK_MULTI_CLICK, MOD_MASK_2CLICK, (char_u)'2'}, 2220 {MOD_MASK_MULTI_CLICK, MOD_MASK_3CLICK, (char_u)'3'}, 2221 {MOD_MASK_MULTI_CLICK, MOD_MASK_4CLICK, (char_u)'4'}, 2222 #ifdef MACOS_X 2223 {MOD_MASK_CMD, MOD_MASK_CMD, (char_u)'D'}, 2224 #endif 2225 // 'A' must be the last one 2226 {MOD_MASK_ALT, MOD_MASK_ALT, (char_u)'A'}, 2227 {0, 0, NUL} 2228 // NOTE: when adding an entry, update MAX_KEY_NAME_LEN! 2229 }; 2230 2231 /* 2232 * Shifted key terminal codes and their unshifted equivalent. 2233 * Don't add mouse codes here, they are handled separately! 2234 */ 2235 #define MOD_KEYS_ENTRY_SIZE 5 2236 2237 static char_u modifier_keys_table[] = 2238 { 2239 // mod mask with modifier without modifier 2240 MOD_MASK_SHIFT, '&', '9', '@', '1', // begin 2241 MOD_MASK_SHIFT, '&', '0', '@', '2', // cancel 2242 MOD_MASK_SHIFT, '*', '1', '@', '4', // command 2243 MOD_MASK_SHIFT, '*', '2', '@', '5', // copy 2244 MOD_MASK_SHIFT, '*', '3', '@', '6', // create 2245 MOD_MASK_SHIFT, '*', '4', 'k', 'D', // delete char 2246 MOD_MASK_SHIFT, '*', '5', 'k', 'L', // delete line 2247 MOD_MASK_SHIFT, '*', '7', '@', '7', // end 2248 MOD_MASK_CTRL, KS_EXTRA, (int)KE_C_END, '@', '7', // end 2249 MOD_MASK_SHIFT, '*', '9', '@', '9', // exit 2250 MOD_MASK_SHIFT, '*', '0', '@', '0', // find 2251 MOD_MASK_SHIFT, '#', '1', '%', '1', // help 2252 MOD_MASK_SHIFT, '#', '2', 'k', 'h', // home 2253 MOD_MASK_CTRL, KS_EXTRA, (int)KE_C_HOME, 'k', 'h', // home 2254 MOD_MASK_SHIFT, '#', '3', 'k', 'I', // insert 2255 MOD_MASK_SHIFT, '#', '4', 'k', 'l', // left arrow 2256 MOD_MASK_CTRL, KS_EXTRA, (int)KE_C_LEFT, 'k', 'l', // left arrow 2257 MOD_MASK_SHIFT, '%', 'a', '%', '3', // message 2258 MOD_MASK_SHIFT, '%', 'b', '%', '4', // move 2259 MOD_MASK_SHIFT, '%', 'c', '%', '5', // next 2260 MOD_MASK_SHIFT, '%', 'd', '%', '7', // options 2261 MOD_MASK_SHIFT, '%', 'e', '%', '8', // previous 2262 MOD_MASK_SHIFT, '%', 'f', '%', '9', // print 2263 MOD_MASK_SHIFT, '%', 'g', '%', '0', // redo 2264 MOD_MASK_SHIFT, '%', 'h', '&', '3', // replace 2265 MOD_MASK_SHIFT, '%', 'i', 'k', 'r', // right arr. 2266 MOD_MASK_CTRL, KS_EXTRA, (int)KE_C_RIGHT, 'k', 'r', // right arr. 2267 MOD_MASK_SHIFT, '%', 'j', '&', '5', // resume 2268 MOD_MASK_SHIFT, '!', '1', '&', '6', // save 2269 MOD_MASK_SHIFT, '!', '2', '&', '7', // suspend 2270 MOD_MASK_SHIFT, '!', '3', '&', '8', // undo 2271 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_UP, 'k', 'u', // up arrow 2272 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_DOWN, 'k', 'd', // down arrow 2273 2274 // vt100 F1 2275 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF1, KS_EXTRA, (int)KE_XF1, 2276 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF2, KS_EXTRA, (int)KE_XF2, 2277 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF3, KS_EXTRA, (int)KE_XF3, 2278 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF4, KS_EXTRA, (int)KE_XF4, 2279 2280 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F1, 'k', '1', // F1 2281 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F2, 'k', '2', 2282 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F3, 'k', '3', 2283 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F4, 'k', '4', 2284 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F5, 'k', '5', 2285 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F6, 'k', '6', 2286 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F7, 'k', '7', 2287 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F8, 'k', '8', 2288 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F9, 'k', '9', 2289 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F10, 'k', ';', // F10 2290 2291 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F11, 'F', '1', 2292 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F12, 'F', '2', 2293 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F13, 'F', '3', 2294 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F14, 'F', '4', 2295 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F15, 'F', '5', 2296 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F16, 'F', '6', 2297 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F17, 'F', '7', 2298 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F18, 'F', '8', 2299 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F19, 'F', '9', 2300 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F20, 'F', 'A', 2301 2302 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F21, 'F', 'B', 2303 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F22, 'F', 'C', 2304 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F23, 'F', 'D', 2305 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F24, 'F', 'E', 2306 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F25, 'F', 'F', 2307 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F26, 'F', 'G', 2308 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F27, 'F', 'H', 2309 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F28, 'F', 'I', 2310 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F29, 'F', 'J', 2311 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F30, 'F', 'K', 2312 2313 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F31, 'F', 'L', 2314 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F32, 'F', 'M', 2315 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F33, 'F', 'N', 2316 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F34, 'F', 'O', 2317 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F35, 'F', 'P', 2318 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F36, 'F', 'Q', 2319 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F37, 'F', 'R', 2320 2321 // TAB pseudo code 2322 MOD_MASK_SHIFT, 'k', 'B', KS_EXTRA, (int)KE_TAB, 2323 2324 NUL 2325 }; 2326 2327 static struct key_name_entry 2328 { 2329 int key; // Special key code or ascii value 2330 char_u *name; // Name of key 2331 } key_names_table[] = 2332 { 2333 {' ', (char_u *)"Space"}, 2334 {TAB, (char_u *)"Tab"}, 2335 {K_TAB, (char_u *)"Tab"}, 2336 {NL, (char_u *)"NL"}, 2337 {NL, (char_u *)"NewLine"}, // Alternative name 2338 {NL, (char_u *)"LineFeed"}, // Alternative name 2339 {NL, (char_u *)"LF"}, // Alternative name 2340 {CAR, (char_u *)"CR"}, 2341 {CAR, (char_u *)"Return"}, // Alternative name 2342 {CAR, (char_u *)"Enter"}, // Alternative name 2343 {K_BS, (char_u *)"BS"}, 2344 {K_BS, (char_u *)"BackSpace"}, // Alternative name 2345 {ESC, (char_u *)"Esc"}, 2346 {CSI, (char_u *)"CSI"}, 2347 {K_CSI, (char_u *)"xCSI"}, 2348 {'|', (char_u *)"Bar"}, 2349 {'\\', (char_u *)"Bslash"}, 2350 {K_DEL, (char_u *)"Del"}, 2351 {K_DEL, (char_u *)"Delete"}, // Alternative name 2352 {K_KDEL, (char_u *)"kDel"}, 2353 {K_UP, (char_u *)"Up"}, 2354 {K_DOWN, (char_u *)"Down"}, 2355 {K_LEFT, (char_u *)"Left"}, 2356 {K_RIGHT, (char_u *)"Right"}, 2357 {K_XUP, (char_u *)"xUp"}, 2358 {K_XDOWN, (char_u *)"xDown"}, 2359 {K_XLEFT, (char_u *)"xLeft"}, 2360 {K_XRIGHT, (char_u *)"xRight"}, 2361 {K_PS, (char_u *)"PasteStart"}, 2362 {K_PE, (char_u *)"PasteEnd"}, 2363 2364 {K_F1, (char_u *)"F1"}, 2365 {K_F2, (char_u *)"F2"}, 2366 {K_F3, (char_u *)"F3"}, 2367 {K_F4, (char_u *)"F4"}, 2368 {K_F5, (char_u *)"F5"}, 2369 {K_F6, (char_u *)"F6"}, 2370 {K_F7, (char_u *)"F7"}, 2371 {K_F8, (char_u *)"F8"}, 2372 {K_F9, (char_u *)"F9"}, 2373 {K_F10, (char_u *)"F10"}, 2374 2375 {K_F11, (char_u *)"F11"}, 2376 {K_F12, (char_u *)"F12"}, 2377 {K_F13, (char_u *)"F13"}, 2378 {K_F14, (char_u *)"F14"}, 2379 {K_F15, (char_u *)"F15"}, 2380 {K_F16, (char_u *)"F16"}, 2381 {K_F17, (char_u *)"F17"}, 2382 {K_F18, (char_u *)"F18"}, 2383 {K_F19, (char_u *)"F19"}, 2384 {K_F20, (char_u *)"F20"}, 2385 2386 {K_F21, (char_u *)"F21"}, 2387 {K_F22, (char_u *)"F22"}, 2388 {K_F23, (char_u *)"F23"}, 2389 {K_F24, (char_u *)"F24"}, 2390 {K_F25, (char_u *)"F25"}, 2391 {K_F26, (char_u *)"F26"}, 2392 {K_F27, (char_u *)"F27"}, 2393 {K_F28, (char_u *)"F28"}, 2394 {K_F29, (char_u *)"F29"}, 2395 {K_F30, (char_u *)"F30"}, 2396 2397 {K_F31, (char_u *)"F31"}, 2398 {K_F32, (char_u *)"F32"}, 2399 {K_F33, (char_u *)"F33"}, 2400 {K_F34, (char_u *)"F34"}, 2401 {K_F35, (char_u *)"F35"}, 2402 {K_F36, (char_u *)"F36"}, 2403 {K_F37, (char_u *)"F37"}, 2404 2405 {K_XF1, (char_u *)"xF1"}, 2406 {K_XF2, (char_u *)"xF2"}, 2407 {K_XF3, (char_u *)"xF3"}, 2408 {K_XF4, (char_u *)"xF4"}, 2409 2410 {K_HELP, (char_u *)"Help"}, 2411 {K_UNDO, (char_u *)"Undo"}, 2412 {K_INS, (char_u *)"Insert"}, 2413 {K_INS, (char_u *)"Ins"}, // Alternative name 2414 {K_KINS, (char_u *)"kInsert"}, 2415 {K_HOME, (char_u *)"Home"}, 2416 {K_KHOME, (char_u *)"kHome"}, 2417 {K_XHOME, (char_u *)"xHome"}, 2418 {K_ZHOME, (char_u *)"zHome"}, 2419 {K_END, (char_u *)"End"}, 2420 {K_KEND, (char_u *)"kEnd"}, 2421 {K_XEND, (char_u *)"xEnd"}, 2422 {K_ZEND, (char_u *)"zEnd"}, 2423 {K_PAGEUP, (char_u *)"PageUp"}, 2424 {K_PAGEDOWN, (char_u *)"PageDown"}, 2425 {K_KPAGEUP, (char_u *)"kPageUp"}, 2426 {K_KPAGEDOWN, (char_u *)"kPageDown"}, 2427 2428 {K_KPLUS, (char_u *)"kPlus"}, 2429 {K_KMINUS, (char_u *)"kMinus"}, 2430 {K_KDIVIDE, (char_u *)"kDivide"}, 2431 {K_KMULTIPLY, (char_u *)"kMultiply"}, 2432 {K_KENTER, (char_u *)"kEnter"}, 2433 {K_KPOINT, (char_u *)"kPoint"}, 2434 2435 {K_K0, (char_u *)"k0"}, 2436 {K_K1, (char_u *)"k1"}, 2437 {K_K2, (char_u *)"k2"}, 2438 {K_K3, (char_u *)"k3"}, 2439 {K_K4, (char_u *)"k4"}, 2440 {K_K5, (char_u *)"k5"}, 2441 {K_K6, (char_u *)"k6"}, 2442 {K_K7, (char_u *)"k7"}, 2443 {K_K8, (char_u *)"k8"}, 2444 {K_K9, (char_u *)"k9"}, 2445 2446 {'<', (char_u *)"lt"}, 2447 2448 {K_MOUSE, (char_u *)"Mouse"}, 2449 #ifdef FEAT_MOUSE_NET 2450 {K_NETTERM_MOUSE, (char_u *)"NetMouse"}, 2451 #endif 2452 #ifdef FEAT_MOUSE_DEC 2453 {K_DEC_MOUSE, (char_u *)"DecMouse"}, 2454 #endif 2455 #ifdef FEAT_MOUSE_JSB 2456 {K_JSBTERM_MOUSE, (char_u *)"JsbMouse"}, 2457 #endif 2458 #ifdef FEAT_MOUSE_PTERM 2459 {K_PTERM_MOUSE, (char_u *)"PtermMouse"}, 2460 #endif 2461 #ifdef FEAT_MOUSE_URXVT 2462 {K_URXVT_MOUSE, (char_u *)"UrxvtMouse"}, 2463 #endif 2464 {K_SGR_MOUSE, (char_u *)"SgrMouse"}, 2465 {K_SGR_MOUSERELEASE, (char_u *)"SgrMouseRelelase"}, 2466 {K_LEFTMOUSE, (char_u *)"LeftMouse"}, 2467 {K_LEFTMOUSE_NM, (char_u *)"LeftMouseNM"}, 2468 {K_LEFTDRAG, (char_u *)"LeftDrag"}, 2469 {K_LEFTRELEASE, (char_u *)"LeftRelease"}, 2470 {K_LEFTRELEASE_NM, (char_u *)"LeftReleaseNM"}, 2471 {K_MOUSEMOVE, (char_u *)"MouseMove"}, 2472 {K_MIDDLEMOUSE, (char_u *)"MiddleMouse"}, 2473 {K_MIDDLEDRAG, (char_u *)"MiddleDrag"}, 2474 {K_MIDDLERELEASE, (char_u *)"MiddleRelease"}, 2475 {K_RIGHTMOUSE, (char_u *)"RightMouse"}, 2476 {K_RIGHTDRAG, (char_u *)"RightDrag"}, 2477 {K_RIGHTRELEASE, (char_u *)"RightRelease"}, 2478 {K_MOUSEDOWN, (char_u *)"ScrollWheelUp"}, 2479 {K_MOUSEUP, (char_u *)"ScrollWheelDown"}, 2480 {K_MOUSELEFT, (char_u *)"ScrollWheelRight"}, 2481 {K_MOUSERIGHT, (char_u *)"ScrollWheelLeft"}, 2482 {K_MOUSEDOWN, (char_u *)"MouseDown"}, // OBSOLETE: Use 2483 {K_MOUSEUP, (char_u *)"MouseUp"}, // ScrollWheelXXX instead 2484 {K_X1MOUSE, (char_u *)"X1Mouse"}, 2485 {K_X1DRAG, (char_u *)"X1Drag"}, 2486 {K_X1RELEASE, (char_u *)"X1Release"}, 2487 {K_X2MOUSE, (char_u *)"X2Mouse"}, 2488 {K_X2DRAG, (char_u *)"X2Drag"}, 2489 {K_X2RELEASE, (char_u *)"X2Release"}, 2490 {K_DROP, (char_u *)"Drop"}, 2491 {K_ZERO, (char_u *)"Nul"}, 2492 #ifdef FEAT_EVAL 2493 {K_SNR, (char_u *)"SNR"}, 2494 #endif 2495 {K_PLUG, (char_u *)"Plug"}, 2496 {K_CURSORHOLD, (char_u *)"CursorHold"}, 2497 {K_IGNORE, (char_u *)"Ignore"}, 2498 {0, NULL} 2499 // NOTE: When adding a long name update MAX_KEY_NAME_LEN. 2500 }; 2501 2502 #define KEY_NAMES_TABLE_LEN (sizeof(key_names_table) / sizeof(struct key_name_entry)) 2503 2504 /* 2505 * Return the modifier mask bit (MOD_MASK_*) which corresponds to the given 2506 * modifier name ('S' for Shift, 'C' for Ctrl etc). 2507 */ 2508 static int 2509 name_to_mod_mask(int c) 2510 { 2511 int i; 2512 2513 c = TOUPPER_ASC(c); 2514 for (i = 0; mod_mask_table[i].mod_mask != 0; i++) 2515 if (c == mod_mask_table[i].name) 2516 return mod_mask_table[i].mod_flag; 2517 return 0; 2518 } 2519 2520 /* 2521 * Check if if there is a special key code for "key" that includes the 2522 * modifiers specified. 2523 */ 2524 int 2525 simplify_key(int key, int *modifiers) 2526 { 2527 int i; 2528 int key0; 2529 int key1; 2530 2531 if (*modifiers & (MOD_MASK_SHIFT | MOD_MASK_CTRL | MOD_MASK_ALT)) 2532 { 2533 // TAB is a special case 2534 if (key == TAB && (*modifiers & MOD_MASK_SHIFT)) 2535 { 2536 *modifiers &= ~MOD_MASK_SHIFT; 2537 return K_S_TAB; 2538 } 2539 key0 = KEY2TERMCAP0(key); 2540 key1 = KEY2TERMCAP1(key); 2541 for (i = 0; modifier_keys_table[i] != NUL; i += MOD_KEYS_ENTRY_SIZE) 2542 if (key0 == modifier_keys_table[i + 3] 2543 && key1 == modifier_keys_table[i + 4] 2544 && (*modifiers & modifier_keys_table[i])) 2545 { 2546 *modifiers &= ~modifier_keys_table[i]; 2547 return TERMCAP2KEY(modifier_keys_table[i + 1], 2548 modifier_keys_table[i + 2]); 2549 } 2550 } 2551 return key; 2552 } 2553 2554 /* 2555 * Change <xHome> to <Home>, <xUp> to <Up>, etc. 2556 */ 2557 int 2558 handle_x_keys(int key) 2559 { 2560 switch (key) 2561 { 2562 case K_XUP: return K_UP; 2563 case K_XDOWN: return K_DOWN; 2564 case K_XLEFT: return K_LEFT; 2565 case K_XRIGHT: return K_RIGHT; 2566 case K_XHOME: return K_HOME; 2567 case K_ZHOME: return K_HOME; 2568 case K_XEND: return K_END; 2569 case K_ZEND: return K_END; 2570 case K_XF1: return K_F1; 2571 case K_XF2: return K_F2; 2572 case K_XF3: return K_F3; 2573 case K_XF4: return K_F4; 2574 case K_S_XF1: return K_S_F1; 2575 case K_S_XF2: return K_S_F2; 2576 case K_S_XF3: return K_S_F3; 2577 case K_S_XF4: return K_S_F4; 2578 } 2579 return key; 2580 } 2581 2582 /* 2583 * Return a string which contains the name of the given key when the given 2584 * modifiers are down. 2585 */ 2586 char_u * 2587 get_special_key_name(int c, int modifiers) 2588 { 2589 static char_u string[MAX_KEY_NAME_LEN + 1]; 2590 2591 int i, idx; 2592 int table_idx; 2593 char_u *s; 2594 2595 string[0] = '<'; 2596 idx = 1; 2597 2598 // Key that stands for a normal character. 2599 if (IS_SPECIAL(c) && KEY2TERMCAP0(c) == KS_KEY) 2600 c = KEY2TERMCAP1(c); 2601 2602 /* 2603 * Translate shifted special keys into unshifted keys and set modifier. 2604 * Same for CTRL and ALT modifiers. 2605 */ 2606 if (IS_SPECIAL(c)) 2607 { 2608 for (i = 0; modifier_keys_table[i] != 0; i += MOD_KEYS_ENTRY_SIZE) 2609 if ( KEY2TERMCAP0(c) == (int)modifier_keys_table[i + 1] 2610 && (int)KEY2TERMCAP1(c) == (int)modifier_keys_table[i + 2]) 2611 { 2612 modifiers |= modifier_keys_table[i]; 2613 c = TERMCAP2KEY(modifier_keys_table[i + 3], 2614 modifier_keys_table[i + 4]); 2615 break; 2616 } 2617 } 2618 2619 // try to find the key in the special key table 2620 table_idx = find_special_key_in_table(c); 2621 2622 /* 2623 * When not a known special key, and not a printable character, try to 2624 * extract modifiers. 2625 */ 2626 if (c > 0 && (*mb_char2len)(c) == 1) 2627 { 2628 if (table_idx < 0 2629 && (!vim_isprintc(c) || (c & 0x7f) == ' ') 2630 && (c & 0x80)) 2631 { 2632 c &= 0x7f; 2633 modifiers |= MOD_MASK_ALT; 2634 // try again, to find the un-alted key in the special key table 2635 table_idx = find_special_key_in_table(c); 2636 } 2637 if (table_idx < 0 && !vim_isprintc(c) && c < ' ') 2638 { 2639 #ifdef EBCDIC 2640 c = CtrlChar(c); 2641 #else 2642 c += '@'; 2643 #endif 2644 modifiers |= MOD_MASK_CTRL; 2645 } 2646 } 2647 2648 // translate the modifier into a string 2649 for (i = 0; mod_mask_table[i].name != 'A'; i++) 2650 if ((modifiers & mod_mask_table[i].mod_mask) 2651 == mod_mask_table[i].mod_flag) 2652 { 2653 string[idx++] = mod_mask_table[i].name; 2654 string[idx++] = (char_u)'-'; 2655 } 2656 2657 if (table_idx < 0) // unknown special key, may output t_xx 2658 { 2659 if (IS_SPECIAL(c)) 2660 { 2661 string[idx++] = 't'; 2662 string[idx++] = '_'; 2663 string[idx++] = KEY2TERMCAP0(c); 2664 string[idx++] = KEY2TERMCAP1(c); 2665 } 2666 // Not a special key, only modifiers, output directly 2667 else 2668 { 2669 if (has_mbyte && (*mb_char2len)(c) > 1) 2670 idx += (*mb_char2bytes)(c, string + idx); 2671 else if (vim_isprintc(c)) 2672 string[idx++] = c; 2673 else 2674 { 2675 s = transchar(c); 2676 while (*s) 2677 string[idx++] = *s++; 2678 } 2679 } 2680 } 2681 else // use name of special key 2682 { 2683 size_t len = STRLEN(key_names_table[table_idx].name); 2684 2685 if (len + idx + 2 <= MAX_KEY_NAME_LEN) 2686 { 2687 STRCPY(string + idx, key_names_table[table_idx].name); 2688 idx += (int)len; 2689 } 2690 } 2691 string[idx++] = '>'; 2692 string[idx] = NUL; 2693 return string; 2694 } 2695 2696 /* 2697 * Try translating a <> name at (*srcp)[] to dst[]. 2698 * Return the number of characters added to dst[], zero for no match. 2699 * If there is a match, srcp is advanced to after the <> name. 2700 * dst[] must be big enough to hold the result (up to six characters)! 2701 */ 2702 int 2703 trans_special( 2704 char_u **srcp, 2705 char_u *dst, 2706 int keycode, // prefer key code, e.g. K_DEL instead of DEL 2707 int in_string, // TRUE when inside a double quoted string 2708 int simplify, // simplify <C-H> and <A-x> 2709 int *did_simplify) // found <C-H> or <A-x> 2710 { 2711 int modifiers = 0; 2712 int key; 2713 2714 key = find_special_key(srcp, &modifiers, keycode, FALSE, in_string, 2715 simplify, did_simplify); 2716 if (key == 0) 2717 return 0; 2718 2719 return special_to_buf(key, modifiers, keycode, dst); 2720 } 2721 2722 /* 2723 * Put the character sequence for "key" with "modifiers" into "dst" and return 2724 * the resulting length. 2725 * When "keycode" is TRUE prefer key code, e.g. K_DEL instead of DEL. 2726 * The sequence is not NUL terminated. 2727 * This is how characters in a string are encoded. 2728 */ 2729 int 2730 special_to_buf(int key, int modifiers, int keycode, char_u *dst) 2731 { 2732 int dlen = 0; 2733 2734 // Put the appropriate modifier in a string 2735 if (modifiers != 0) 2736 { 2737 dst[dlen++] = K_SPECIAL; 2738 dst[dlen++] = KS_MODIFIER; 2739 dst[dlen++] = modifiers; 2740 } 2741 2742 if (IS_SPECIAL(key)) 2743 { 2744 dst[dlen++] = K_SPECIAL; 2745 dst[dlen++] = KEY2TERMCAP0(key); 2746 dst[dlen++] = KEY2TERMCAP1(key); 2747 } 2748 else if (has_mbyte && !keycode) 2749 dlen += (*mb_char2bytes)(key, dst + dlen); 2750 else if (keycode) 2751 dlen = (int)(add_char2buf(key, dst + dlen) - dst); 2752 else 2753 dst[dlen++] = key; 2754 2755 return dlen; 2756 } 2757 2758 /* 2759 * Try translating a <> name at (*srcp)[], return the key and modifiers. 2760 * srcp is advanced to after the <> name. 2761 * returns 0 if there is no match. 2762 */ 2763 int 2764 find_special_key( 2765 char_u **srcp, 2766 int *modp, 2767 int keycode, // prefer key code, e.g. K_DEL instead of DEL 2768 int keep_x_key, // don't translate xHome to Home key 2769 int in_string, // TRUE in string, double quote is escaped 2770 int simplify, // simplify <C-H> and <A-x> 2771 int *did_simplify) // found <C-H> or <A-x> 2772 { 2773 char_u *last_dash; 2774 char_u *end_of_name; 2775 char_u *src; 2776 char_u *bp; 2777 int modifiers; 2778 int bit; 2779 int key; 2780 uvarnumber_T n; 2781 int l; 2782 2783 src = *srcp; 2784 if (src[0] != '<') 2785 return 0; 2786 2787 // Find end of modifier list 2788 last_dash = src; 2789 for (bp = src + 1; *bp == '-' || vim_isIDc(*bp); bp++) 2790 { 2791 if (*bp == '-') 2792 { 2793 last_dash = bp; 2794 if (bp[1] != NUL) 2795 { 2796 if (has_mbyte) 2797 l = mb_ptr2len(bp + 1); 2798 else 2799 l = 1; 2800 // Anything accepted, like <C-?>. 2801 // <C-"> or <M-"> are not special in strings as " is 2802 // the string delimiter. With a backslash it works: <M-\"> 2803 if (!(in_string && bp[1] == '"') && bp[l + 1] == '>') 2804 bp += l; 2805 else if (in_string && bp[1] == '\\' && bp[2] == '"' 2806 && bp[3] == '>') 2807 bp += 2; 2808 } 2809 } 2810 if (bp[0] == 't' && bp[1] == '_' && bp[2] && bp[3]) 2811 bp += 3; // skip t_xx, xx may be '-' or '>' 2812 else if (STRNICMP(bp, "char-", 5) == 0) 2813 { 2814 vim_str2nr(bp + 5, NULL, &l, STR2NR_ALL, NULL, NULL, 0, TRUE); 2815 if (l == 0) 2816 { 2817 emsg(_(e_invarg)); 2818 return 0; 2819 } 2820 bp += l + 5; 2821 break; 2822 } 2823 } 2824 2825 if (*bp == '>') // found matching '>' 2826 { 2827 end_of_name = bp + 1; 2828 2829 // Which modifiers are given? 2830 modifiers = 0x0; 2831 for (bp = src + 1; bp < last_dash; bp++) 2832 { 2833 if (*bp != '-') 2834 { 2835 bit = name_to_mod_mask(*bp); 2836 if (bit == 0x0) 2837 break; // Illegal modifier name 2838 modifiers |= bit; 2839 } 2840 } 2841 2842 /* 2843 * Legal modifier name. 2844 */ 2845 if (bp >= last_dash) 2846 { 2847 if (STRNICMP(last_dash + 1, "char-", 5) == 0 2848 && VIM_ISDIGIT(last_dash[6])) 2849 { 2850 // <Char-123> or <Char-033> or <Char-0x33> 2851 vim_str2nr(last_dash + 6, NULL, &l, STR2NR_ALL, NULL, 2852 &n, 0, TRUE); 2853 if (l == 0) 2854 { 2855 emsg(_(e_invarg)); 2856 return 0; 2857 } 2858 key = (int)n; 2859 } 2860 else 2861 { 2862 int off = 1; 2863 2864 // Modifier with single letter, or special key name. 2865 if (in_string && last_dash[1] == '\\' && last_dash[2] == '"') 2866 off = 2; 2867 if (has_mbyte) 2868 l = mb_ptr2len(last_dash + off); 2869 else 2870 l = 1; 2871 if (modifiers != 0 && last_dash[l + off] == '>') 2872 key = PTR2CHAR(last_dash + off); 2873 else 2874 { 2875 key = get_special_key_code(last_dash + off); 2876 if (!keep_x_key) 2877 key = handle_x_keys(key); 2878 } 2879 } 2880 2881 /* 2882 * get_special_key_code() may return NUL for invalid 2883 * special key name. 2884 */ 2885 if (key != NUL) 2886 { 2887 /* 2888 * Only use a modifier when there is no special key code that 2889 * includes the modifier. 2890 */ 2891 key = simplify_key(key, &modifiers); 2892 2893 if (!keycode) 2894 { 2895 // don't want keycode, use single byte code 2896 if (key == K_BS) 2897 key = BS; 2898 else if (key == K_DEL || key == K_KDEL) 2899 key = DEL; 2900 } 2901 2902 // Normal Key with modifier: Try to make a single byte code. 2903 if (!IS_SPECIAL(key)) 2904 key = extract_modifiers(key, &modifiers, 2905 simplify, did_simplify); 2906 2907 *modp = modifiers; 2908 *srcp = end_of_name; 2909 return key; 2910 } 2911 } 2912 } 2913 return 0; 2914 } 2915 2916 /* 2917 * Try to include modifiers in the key. 2918 * Changes "Shift-a" to 'A', "Alt-A" to 0xc0, etc. 2919 * When "simplify" is FALSE don't do Ctrl and Alt. 2920 * When "simplify" is TRUE and Ctrl or Alt is removed from modifiers set 2921 * "did_simplify" when it's not NULL. 2922 */ 2923 int 2924 extract_modifiers(int key, int *modp, int simplify, int *did_simplify) 2925 { 2926 int modifiers = *modp; 2927 2928 #ifdef MACOS_X 2929 // Command-key really special, no fancynest 2930 if (!(modifiers & MOD_MASK_CMD)) 2931 #endif 2932 if ((modifiers & MOD_MASK_SHIFT) && ASCII_ISALPHA(key)) 2933 { 2934 key = TOUPPER_ASC(key); 2935 // With <C-S-a> and <A-S-a> we keep the shift modifier. 2936 // With <S-a> and <S-A> we don't keep the shift modifier. 2937 if (simplify || modifiers == MOD_MASK_SHIFT) 2938 modifiers &= ~MOD_MASK_SHIFT; 2939 } 2940 2941 // <C-H> and <C-h> mean the same thing, always use "H" 2942 if ((modifiers & MOD_MASK_CTRL) && ASCII_ISALPHA(key)) 2943 key = TOUPPER_ASC(key); 2944 2945 if (simplify && (modifiers & MOD_MASK_CTRL) 2946 #ifdef EBCDIC 2947 // TODO: EBCDIC Better use: 2948 // && (Ctrl_chr(key) || key == '?') 2949 // ??? 2950 && strchr("?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_", key) 2951 != NULL 2952 #else 2953 && ((key >= '?' && key <= '_') || ASCII_ISALPHA(key)) 2954 #endif 2955 ) 2956 { 2957 key = Ctrl_chr(key); 2958 modifiers &= ~MOD_MASK_CTRL; 2959 // <C-@> is <Nul> 2960 if (key == 0) 2961 key = K_ZERO; 2962 if (did_simplify != NULL) 2963 *did_simplify = TRUE; 2964 } 2965 2966 #ifdef MACOS_X 2967 // Command-key really special, no fancynest 2968 if (!(modifiers & MOD_MASK_CMD)) 2969 #endif 2970 if (simplify && (modifiers & MOD_MASK_ALT) && key < 0x80 2971 && !enc_dbcs) // avoid creating a lead byte 2972 { 2973 key |= 0x80; 2974 modifiers &= ~MOD_MASK_ALT; // remove the META modifier 2975 if (did_simplify != NULL) 2976 *did_simplify = TRUE; 2977 } 2978 2979 *modp = modifiers; 2980 return key; 2981 } 2982 2983 /* 2984 * Try to find key "c" in the special key table. 2985 * Return the index when found, -1 when not found. 2986 */ 2987 int 2988 find_special_key_in_table(int c) 2989 { 2990 int i; 2991 2992 for (i = 0; key_names_table[i].name != NULL; i++) 2993 if (c == key_names_table[i].key) 2994 break; 2995 if (key_names_table[i].name == NULL) 2996 i = -1; 2997 return i; 2998 } 2999 3000 /* 3001 * Find the special key with the given name (the given string does not have to 3002 * end with NUL, the name is assumed to end before the first non-idchar). 3003 * If the name starts with "t_" the next two characters are interpreted as a 3004 * termcap name. 3005 * Return the key code, or 0 if not found. 3006 */ 3007 int 3008 get_special_key_code(char_u *name) 3009 { 3010 char_u *table_name; 3011 char_u string[3]; 3012 int i, j; 3013 3014 /* 3015 * If it's <t_xx> we get the code for xx from the termcap 3016 */ 3017 if (name[0] == 't' && name[1] == '_' && name[2] != NUL && name[3] != NUL) 3018 { 3019 string[0] = name[2]; 3020 string[1] = name[3]; 3021 string[2] = NUL; 3022 if (add_termcap_entry(string, FALSE) == OK) 3023 return TERMCAP2KEY(name[2], name[3]); 3024 } 3025 else 3026 for (i = 0; key_names_table[i].name != NULL; i++) 3027 { 3028 table_name = key_names_table[i].name; 3029 for (j = 0; vim_isIDc(name[j]) && table_name[j] != NUL; j++) 3030 if (TOLOWER_ASC(table_name[j]) != TOLOWER_ASC(name[j])) 3031 break; 3032 if (!vim_isIDc(name[j]) && table_name[j] == NUL) 3033 return key_names_table[i].key; 3034 } 3035 return 0; 3036 } 3037 3038 char_u * 3039 get_key_name(int i) 3040 { 3041 if (i >= (int)KEY_NAMES_TABLE_LEN) 3042 return NULL; 3043 return key_names_table[i].name; 3044 } 3045 3046 /* 3047 * Return the current end-of-line type: EOL_DOS, EOL_UNIX or EOL_MAC. 3048 */ 3049 int 3050 get_fileformat(buf_T *buf) 3051 { 3052 int c = *buf->b_p_ff; 3053 3054 if (buf->b_p_bin || c == 'u') 3055 return EOL_UNIX; 3056 if (c == 'm') 3057 return EOL_MAC; 3058 return EOL_DOS; 3059 } 3060 3061 /* 3062 * Like get_fileformat(), but override 'fileformat' with "p" for "++opt=val" 3063 * argument. 3064 */ 3065 int 3066 get_fileformat_force( 3067 buf_T *buf, 3068 exarg_T *eap) // can be NULL! 3069 { 3070 int c; 3071 3072 if (eap != NULL && eap->force_ff != 0) 3073 c = eap->force_ff; 3074 else 3075 { 3076 if ((eap != NULL && eap->force_bin != 0) 3077 ? (eap->force_bin == FORCE_BIN) : buf->b_p_bin) 3078 return EOL_UNIX; 3079 c = *buf->b_p_ff; 3080 } 3081 if (c == 'u') 3082 return EOL_UNIX; 3083 if (c == 'm') 3084 return EOL_MAC; 3085 return EOL_DOS; 3086 } 3087 3088 /* 3089 * Set the current end-of-line type to EOL_DOS, EOL_UNIX or EOL_MAC. 3090 * Sets both 'textmode' and 'fileformat'. 3091 * Note: Does _not_ set global value of 'textmode'! 3092 */ 3093 void 3094 set_fileformat( 3095 int t, 3096 int opt_flags) // OPT_LOCAL and/or OPT_GLOBAL 3097 { 3098 char *p = NULL; 3099 3100 switch (t) 3101 { 3102 case EOL_DOS: 3103 p = FF_DOS; 3104 curbuf->b_p_tx = TRUE; 3105 break; 3106 case EOL_UNIX: 3107 p = FF_UNIX; 3108 curbuf->b_p_tx = FALSE; 3109 break; 3110 case EOL_MAC: 3111 p = FF_MAC; 3112 curbuf->b_p_tx = FALSE; 3113 break; 3114 } 3115 if (p != NULL) 3116 set_string_option_direct((char_u *)"ff", -1, (char_u *)p, 3117 OPT_FREE | opt_flags, 0); 3118 3119 // This may cause the buffer to become (un)modified. 3120 check_status(curbuf); 3121 redraw_tabline = TRUE; 3122 #ifdef FEAT_TITLE 3123 need_maketitle = TRUE; // set window title later 3124 #endif 3125 } 3126 3127 /* 3128 * Return the default fileformat from 'fileformats'. 3129 */ 3130 int 3131 default_fileformat(void) 3132 { 3133 switch (*p_ffs) 3134 { 3135 case 'm': return EOL_MAC; 3136 case 'd': return EOL_DOS; 3137 } 3138 return EOL_UNIX; 3139 } 3140 3141 /* 3142 * Call shell. Calls mch_call_shell, with 'shellxquote' added. 3143 */ 3144 int 3145 call_shell(char_u *cmd, int opt) 3146 { 3147 char_u *ncmd; 3148 int retval; 3149 #ifdef FEAT_PROFILE 3150 proftime_T wait_time; 3151 #endif 3152 3153 if (p_verbose > 3) 3154 { 3155 verbose_enter(); 3156 smsg(_("Calling shell to execute: \"%s\""), cmd == NULL ? p_sh : cmd); 3157 out_char('\n'); 3158 cursor_on(); 3159 verbose_leave(); 3160 } 3161 3162 #ifdef FEAT_PROFILE 3163 if (do_profiling == PROF_YES) 3164 prof_child_enter(&wait_time); 3165 #endif 3166 3167 if (*p_sh == NUL) 3168 { 3169 emsg(_(e_shellempty)); 3170 retval = -1; 3171 } 3172 else 3173 { 3174 #ifdef FEAT_GUI_MSWIN 3175 // Don't hide the pointer while executing a shell command. 3176 gui_mch_mousehide(FALSE); 3177 #endif 3178 #ifdef FEAT_GUI 3179 ++hold_gui_events; 3180 #endif 3181 // The external command may update a tags file, clear cached tags. 3182 tag_freematch(); 3183 3184 if (cmd == NULL || *p_sxq == NUL) 3185 retval = mch_call_shell(cmd, opt); 3186 else 3187 { 3188 char_u *ecmd = cmd; 3189 3190 if (*p_sxe != NUL && *p_sxq == '(') 3191 { 3192 ecmd = vim_strsave_escaped_ext(cmd, p_sxe, '^', FALSE); 3193 if (ecmd == NULL) 3194 ecmd = cmd; 3195 } 3196 ncmd = alloc(STRLEN(ecmd) + STRLEN(p_sxq) * 2 + 1); 3197 if (ncmd != NULL) 3198 { 3199 STRCPY(ncmd, p_sxq); 3200 STRCAT(ncmd, ecmd); 3201 // When 'shellxquote' is ( append ). 3202 // When 'shellxquote' is "( append )". 3203 STRCAT(ncmd, *p_sxq == '(' ? (char_u *)")" 3204 : *p_sxq == '"' && *(p_sxq+1) == '(' ? (char_u *)")\"" 3205 : p_sxq); 3206 retval = mch_call_shell(ncmd, opt); 3207 vim_free(ncmd); 3208 } 3209 else 3210 retval = -1; 3211 if (ecmd != cmd) 3212 vim_free(ecmd); 3213 } 3214 #ifdef FEAT_GUI 3215 --hold_gui_events; 3216 #endif 3217 /* 3218 * Check the window size, in case it changed while executing the 3219 * external command. 3220 */ 3221 shell_resized_check(); 3222 } 3223 3224 #ifdef FEAT_EVAL 3225 set_vim_var_nr(VV_SHELL_ERROR, (long)retval); 3226 # ifdef FEAT_PROFILE 3227 if (do_profiling == PROF_YES) 3228 prof_child_exit(&wait_time); 3229 # endif 3230 #endif 3231 3232 return retval; 3233 } 3234 3235 /* 3236 * VISUAL, SELECTMODE and OP_PENDING State are never set, they are equal to 3237 * NORMAL State with a condition. This function returns the real State. 3238 */ 3239 int 3240 get_real_state(void) 3241 { 3242 if (State & NORMAL) 3243 { 3244 if (VIsual_active) 3245 { 3246 if (VIsual_select) 3247 return SELECTMODE; 3248 return VISUAL; 3249 } 3250 else if (finish_op) 3251 return OP_PENDING; 3252 } 3253 return State; 3254 } 3255 3256 /* 3257 * Return TRUE if "p" points to just after a path separator. 3258 * Takes care of multi-byte characters. 3259 * "b" must point to the start of the file name 3260 */ 3261 int 3262 after_pathsep(char_u *b, char_u *p) 3263 { 3264 return p > b && vim_ispathsep(p[-1]) 3265 && (!has_mbyte || (*mb_head_off)(b, p - 1) == 0); 3266 } 3267 3268 /* 3269 * Return TRUE if file names "f1" and "f2" are in the same directory. 3270 * "f1" may be a short name, "f2" must be a full path. 3271 */ 3272 int 3273 same_directory(char_u *f1, char_u *f2) 3274 { 3275 char_u ffname[MAXPATHL]; 3276 char_u *t1; 3277 char_u *t2; 3278 3279 // safety check 3280 if (f1 == NULL || f2 == NULL) 3281 return FALSE; 3282 3283 (void)vim_FullName(f1, ffname, MAXPATHL, FALSE); 3284 t1 = gettail_sep(ffname); 3285 t2 = gettail_sep(f2); 3286 return (t1 - ffname == t2 - f2 3287 && pathcmp((char *)ffname, (char *)f2, (int)(t1 - ffname)) == 0); 3288 } 3289 3290 #if defined(FEAT_SESSION) || defined(FEAT_AUTOCHDIR) \ 3291 || defined(MSWIN) || defined(FEAT_GUI_MAC) || defined(FEAT_GUI_GTK) \ 3292 || defined(FEAT_NETBEANS_INTG) \ 3293 || defined(PROTO) 3294 /* 3295 * Change to a file's directory. 3296 * Caller must call shorten_fnames()! 3297 * Return OK or FAIL. 3298 */ 3299 int 3300 vim_chdirfile(char_u *fname, char *trigger_autocmd) 3301 { 3302 char_u old_dir[MAXPATHL]; 3303 char_u new_dir[MAXPATHL]; 3304 int res; 3305 3306 if (mch_dirname(old_dir, MAXPATHL) != OK) 3307 *old_dir = NUL; 3308 3309 vim_strncpy(new_dir, fname, MAXPATHL - 1); 3310 *gettail_sep(new_dir) = NUL; 3311 3312 if (pathcmp((char *)old_dir, (char *)new_dir, -1) == 0) 3313 // nothing to do 3314 res = OK; 3315 else 3316 { 3317 res = mch_chdir((char *)new_dir) == 0 ? OK : FAIL; 3318 3319 if (res == OK && trigger_autocmd != NULL) 3320 apply_autocmds(EVENT_DIRCHANGED, (char_u *)trigger_autocmd, 3321 new_dir, FALSE, curbuf); 3322 } 3323 return res; 3324 } 3325 #endif 3326 3327 #if defined(STAT_IGNORES_SLASH) || defined(PROTO) 3328 /* 3329 * Check if "name" ends in a slash and is not a directory. 3330 * Used for systems where stat() ignores a trailing slash on a file name. 3331 * The Vim code assumes a trailing slash is only ignored for a directory. 3332 */ 3333 static int 3334 illegal_slash(const char *name) 3335 { 3336 if (name[0] == NUL) 3337 return FALSE; // no file name is not illegal 3338 if (name[strlen(name) - 1] != '/') 3339 return FALSE; // no trailing slash 3340 if (mch_isdir((char_u *)name)) 3341 return FALSE; // trailing slash for a directory 3342 return TRUE; 3343 } 3344 3345 /* 3346 * Special implementation of mch_stat() for Solaris. 3347 */ 3348 int 3349 vim_stat(const char *name, stat_T *stp) 3350 { 3351 // On Solaris stat() accepts "file/" as if it was "file". Return -1 if 3352 // the name ends in "/" and it's not a directory. 3353 return illegal_slash(name) ? -1 : stat(name, stp); 3354 } 3355 #endif 3356 3357 #if defined(CURSOR_SHAPE) || defined(PROTO) 3358 3359 /* 3360 * Handling of cursor and mouse pointer shapes in various modes. 3361 */ 3362 3363 cursorentry_T shape_table[SHAPE_IDX_COUNT] = 3364 { 3365 // The values will be filled in from the 'guicursor' and 'mouseshape' 3366 // defaults when Vim starts. 3367 // Adjust the SHAPE_IDX_ defines when making changes! 3368 {0, 0, 0, 700L, 400L, 250L, 0, 0, "n", SHAPE_CURSOR+SHAPE_MOUSE}, 3369 {0, 0, 0, 700L, 400L, 250L, 0, 0, "v", SHAPE_CURSOR+SHAPE_MOUSE}, 3370 {0, 0, 0, 700L, 400L, 250L, 0, 0, "i", SHAPE_CURSOR+SHAPE_MOUSE}, 3371 {0, 0, 0, 700L, 400L, 250L, 0, 0, "r", SHAPE_CURSOR+SHAPE_MOUSE}, 3372 {0, 0, 0, 700L, 400L, 250L, 0, 0, "c", SHAPE_CURSOR+SHAPE_MOUSE}, 3373 {0, 0, 0, 700L, 400L, 250L, 0, 0, "ci", SHAPE_CURSOR+SHAPE_MOUSE}, 3374 {0, 0, 0, 700L, 400L, 250L, 0, 0, "cr", SHAPE_CURSOR+SHAPE_MOUSE}, 3375 {0, 0, 0, 700L, 400L, 250L, 0, 0, "o", SHAPE_CURSOR+SHAPE_MOUSE}, 3376 {0, 0, 0, 700L, 400L, 250L, 0, 0, "ve", SHAPE_CURSOR+SHAPE_MOUSE}, 3377 {0, 0, 0, 0L, 0L, 0L, 0, 0, "e", SHAPE_MOUSE}, 3378 {0, 0, 0, 0L, 0L, 0L, 0, 0, "s", SHAPE_MOUSE}, 3379 {0, 0, 0, 0L, 0L, 0L, 0, 0, "sd", SHAPE_MOUSE}, 3380 {0, 0, 0, 0L, 0L, 0L, 0, 0, "vs", SHAPE_MOUSE}, 3381 {0, 0, 0, 0L, 0L, 0L, 0, 0, "vd", SHAPE_MOUSE}, 3382 {0, 0, 0, 0L, 0L, 0L, 0, 0, "m", SHAPE_MOUSE}, 3383 {0, 0, 0, 0L, 0L, 0L, 0, 0, "ml", SHAPE_MOUSE}, 3384 {0, 0, 0, 100L, 100L, 100L, 0, 0, "sm", SHAPE_CURSOR}, 3385 }; 3386 3387 #ifdef FEAT_MOUSESHAPE 3388 /* 3389 * Table with names for mouse shapes. Keep in sync with all the tables for 3390 * mch_set_mouse_shape()!. 3391 */ 3392 static char * mshape_names[] = 3393 { 3394 "arrow", // default, must be the first one 3395 "blank", // hidden 3396 "beam", 3397 "updown", 3398 "udsizing", 3399 "leftright", 3400 "lrsizing", 3401 "busy", 3402 "no", 3403 "crosshair", 3404 "hand1", 3405 "hand2", 3406 "pencil", 3407 "question", 3408 "rightup-arrow", 3409 "up-arrow", 3410 NULL 3411 }; 3412 #endif 3413 3414 /* 3415 * Parse the 'guicursor' option ("what" is SHAPE_CURSOR) or 'mouseshape' 3416 * ("what" is SHAPE_MOUSE). 3417 * Returns error message for an illegal option, NULL otherwise. 3418 */ 3419 char * 3420 parse_shape_opt(int what) 3421 { 3422 char_u *modep; 3423 char_u *colonp; 3424 char_u *commap; 3425 char_u *slashp; 3426 char_u *p, *endp; 3427 int idx = 0; // init for GCC 3428 int all_idx; 3429 int len; 3430 int i; 3431 long n; 3432 int found_ve = FALSE; // found "ve" flag 3433 int round; 3434 3435 /* 3436 * First round: check for errors; second round: do it for real. 3437 */ 3438 for (round = 1; round <= 2; ++round) 3439 { 3440 /* 3441 * Repeat for all comma separated parts. 3442 */ 3443 #ifdef FEAT_MOUSESHAPE 3444 if (what == SHAPE_MOUSE) 3445 modep = p_mouseshape; 3446 else 3447 #endif 3448 modep = p_guicursor; 3449 while (*modep != NUL) 3450 { 3451 colonp = vim_strchr(modep, ':'); 3452 commap = vim_strchr(modep, ','); 3453 3454 if (colonp == NULL || (commap != NULL && commap < colonp)) 3455 return N_("E545: Missing colon"); 3456 if (colonp == modep) 3457 return N_("E546: Illegal mode"); 3458 3459 /* 3460 * Repeat for all mode's before the colon. 3461 * For the 'a' mode, we loop to handle all the modes. 3462 */ 3463 all_idx = -1; 3464 while (modep < colonp || all_idx >= 0) 3465 { 3466 if (all_idx < 0) 3467 { 3468 // Find the mode. 3469 if (modep[1] == '-' || modep[1] == ':') 3470 len = 1; 3471 else 3472 len = 2; 3473 if (len == 1 && TOLOWER_ASC(modep[0]) == 'a') 3474 all_idx = SHAPE_IDX_COUNT - 1; 3475 else 3476 { 3477 for (idx = 0; idx < SHAPE_IDX_COUNT; ++idx) 3478 if (STRNICMP(modep, shape_table[idx].name, len) 3479 == 0) 3480 break; 3481 if (idx == SHAPE_IDX_COUNT 3482 || (shape_table[idx].used_for & what) == 0) 3483 return N_("E546: Illegal mode"); 3484 if (len == 2 && modep[0] == 'v' && modep[1] == 'e') 3485 found_ve = TRUE; 3486 } 3487 modep += len + 1; 3488 } 3489 3490 if (all_idx >= 0) 3491 idx = all_idx--; 3492 else if (round == 2) 3493 { 3494 #ifdef FEAT_MOUSESHAPE 3495 if (what == SHAPE_MOUSE) 3496 { 3497 // Set the default, for the missing parts 3498 shape_table[idx].mshape = 0; 3499 } 3500 else 3501 #endif 3502 { 3503 // Set the defaults, for the missing parts 3504 shape_table[idx].shape = SHAPE_BLOCK; 3505 shape_table[idx].blinkwait = 700L; 3506 shape_table[idx].blinkon = 400L; 3507 shape_table[idx].blinkoff = 250L; 3508 } 3509 } 3510 3511 // Parse the part after the colon 3512 for (p = colonp + 1; *p && *p != ','; ) 3513 { 3514 #ifdef FEAT_MOUSESHAPE 3515 if (what == SHAPE_MOUSE) 3516 { 3517 for (i = 0; ; ++i) 3518 { 3519 if (mshape_names[i] == NULL) 3520 { 3521 if (!VIM_ISDIGIT(*p)) 3522 return N_("E547: Illegal mouseshape"); 3523 if (round == 2) 3524 shape_table[idx].mshape = 3525 getdigits(&p) + MSHAPE_NUMBERED; 3526 else 3527 (void)getdigits(&p); 3528 break; 3529 } 3530 len = (int)STRLEN(mshape_names[i]); 3531 if (STRNICMP(p, mshape_names[i], len) == 0) 3532 { 3533 if (round == 2) 3534 shape_table[idx].mshape = i; 3535 p += len; 3536 break; 3537 } 3538 } 3539 } 3540 else // if (what == SHAPE_MOUSE) 3541 #endif 3542 { 3543 /* 3544 * First handle the ones with a number argument. 3545 */ 3546 i = *p; 3547 len = 0; 3548 if (STRNICMP(p, "ver", 3) == 0) 3549 len = 3; 3550 else if (STRNICMP(p, "hor", 3) == 0) 3551 len = 3; 3552 else if (STRNICMP(p, "blinkwait", 9) == 0) 3553 len = 9; 3554 else if (STRNICMP(p, "blinkon", 7) == 0) 3555 len = 7; 3556 else if (STRNICMP(p, "blinkoff", 8) == 0) 3557 len = 8; 3558 if (len != 0) 3559 { 3560 p += len; 3561 if (!VIM_ISDIGIT(*p)) 3562 return N_("E548: digit expected"); 3563 n = getdigits(&p); 3564 if (len == 3) // "ver" or "hor" 3565 { 3566 if (n == 0) 3567 return N_("E549: Illegal percentage"); 3568 if (round == 2) 3569 { 3570 if (TOLOWER_ASC(i) == 'v') 3571 shape_table[idx].shape = SHAPE_VER; 3572 else 3573 shape_table[idx].shape = SHAPE_HOR; 3574 shape_table[idx].percentage = n; 3575 } 3576 } 3577 else if (round == 2) 3578 { 3579 if (len == 9) 3580 shape_table[idx].blinkwait = n; 3581 else if (len == 7) 3582 shape_table[idx].blinkon = n; 3583 else 3584 shape_table[idx].blinkoff = n; 3585 } 3586 } 3587 else if (STRNICMP(p, "block", 5) == 0) 3588 { 3589 if (round == 2) 3590 shape_table[idx].shape = SHAPE_BLOCK; 3591 p += 5; 3592 } 3593 else // must be a highlight group name then 3594 { 3595 endp = vim_strchr(p, '-'); 3596 if (commap == NULL) // last part 3597 { 3598 if (endp == NULL) 3599 endp = p + STRLEN(p); // find end of part 3600 } 3601 else if (endp > commap || endp == NULL) 3602 endp = commap; 3603 slashp = vim_strchr(p, '/'); 3604 if (slashp != NULL && slashp < endp) 3605 { 3606 // "group/langmap_group" 3607 i = syn_check_group(p, (int)(slashp - p)); 3608 p = slashp + 1; 3609 } 3610 if (round == 2) 3611 { 3612 shape_table[idx].id = syn_check_group(p, 3613 (int)(endp - p)); 3614 shape_table[idx].id_lm = shape_table[idx].id; 3615 if (slashp != NULL && slashp < endp) 3616 shape_table[idx].id = i; 3617 } 3618 p = endp; 3619 } 3620 } // if (what != SHAPE_MOUSE) 3621 3622 if (*p == '-') 3623 ++p; 3624 } 3625 } 3626 modep = p; 3627 if (*modep == ',') 3628 ++modep; 3629 } 3630 } 3631 3632 // If the 's' flag is not given, use the 'v' cursor for 's' 3633 if (!found_ve) 3634 { 3635 #ifdef FEAT_MOUSESHAPE 3636 if (what == SHAPE_MOUSE) 3637 { 3638 shape_table[SHAPE_IDX_VE].mshape = shape_table[SHAPE_IDX_V].mshape; 3639 } 3640 else 3641 #endif 3642 { 3643 shape_table[SHAPE_IDX_VE].shape = shape_table[SHAPE_IDX_V].shape; 3644 shape_table[SHAPE_IDX_VE].percentage = 3645 shape_table[SHAPE_IDX_V].percentage; 3646 shape_table[SHAPE_IDX_VE].blinkwait = 3647 shape_table[SHAPE_IDX_V].blinkwait; 3648 shape_table[SHAPE_IDX_VE].blinkon = 3649 shape_table[SHAPE_IDX_V].blinkon; 3650 shape_table[SHAPE_IDX_VE].blinkoff = 3651 shape_table[SHAPE_IDX_V].blinkoff; 3652 shape_table[SHAPE_IDX_VE].id = shape_table[SHAPE_IDX_V].id; 3653 shape_table[SHAPE_IDX_VE].id_lm = shape_table[SHAPE_IDX_V].id_lm; 3654 } 3655 } 3656 3657 return NULL; 3658 } 3659 3660 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \ 3661 || defined(FEAT_MOUSESHAPE) || defined(PROTO) 3662 /* 3663 * Return the index into shape_table[] for the current mode. 3664 * When "mouse" is TRUE, consider indexes valid for the mouse pointer. 3665 */ 3666 int 3667 get_shape_idx(int mouse) 3668 { 3669 #ifdef FEAT_MOUSESHAPE 3670 if (mouse && (State == HITRETURN || State == ASKMORE)) 3671 { 3672 # ifdef FEAT_GUI 3673 int x, y; 3674 gui_mch_getmouse(&x, &y); 3675 if (Y_2_ROW(y) == Rows - 1) 3676 return SHAPE_IDX_MOREL; 3677 # endif 3678 return SHAPE_IDX_MORE; 3679 } 3680 if (mouse && drag_status_line) 3681 return SHAPE_IDX_SDRAG; 3682 if (mouse && drag_sep_line) 3683 return SHAPE_IDX_VDRAG; 3684 #endif 3685 if (!mouse && State == SHOWMATCH) 3686 return SHAPE_IDX_SM; 3687 if (State & VREPLACE_FLAG) 3688 return SHAPE_IDX_R; 3689 if (State & REPLACE_FLAG) 3690 return SHAPE_IDX_R; 3691 if (State & INSERT) 3692 return SHAPE_IDX_I; 3693 if (State & CMDLINE) 3694 { 3695 if (cmdline_at_end()) 3696 return SHAPE_IDX_C; 3697 if (cmdline_overstrike()) 3698 return SHAPE_IDX_CR; 3699 return SHAPE_IDX_CI; 3700 } 3701 if (finish_op) 3702 return SHAPE_IDX_O; 3703 if (VIsual_active) 3704 { 3705 if (*p_sel == 'e') 3706 return SHAPE_IDX_VE; 3707 else 3708 return SHAPE_IDX_V; 3709 } 3710 return SHAPE_IDX_N; 3711 } 3712 #endif 3713 3714 # if defined(FEAT_MOUSESHAPE) || defined(PROTO) 3715 static int old_mouse_shape = 0; 3716 3717 /* 3718 * Set the mouse shape: 3719 * If "shape" is -1, use shape depending on the current mode, 3720 * depending on the current state. 3721 * If "shape" is -2, only update the shape when it's CLINE or STATUS (used 3722 * when the mouse moves off the status or command line). 3723 */ 3724 void 3725 update_mouseshape(int shape_idx) 3726 { 3727 int new_mouse_shape; 3728 3729 // Only works in GUI mode. 3730 if (!gui.in_use || gui.starting) 3731 return; 3732 3733 // Postpone the updating when more is to come. Speeds up executing of 3734 // mappings. 3735 if (shape_idx == -1 && char_avail()) 3736 { 3737 postponed_mouseshape = TRUE; 3738 return; 3739 } 3740 3741 // When ignoring the mouse don't change shape on the statusline. 3742 if (*p_mouse == NUL 3743 && (shape_idx == SHAPE_IDX_CLINE 3744 || shape_idx == SHAPE_IDX_STATUS 3745 || shape_idx == SHAPE_IDX_VSEP)) 3746 shape_idx = -2; 3747 3748 if (shape_idx == -2 3749 && old_mouse_shape != shape_table[SHAPE_IDX_CLINE].mshape 3750 && old_mouse_shape != shape_table[SHAPE_IDX_STATUS].mshape 3751 && old_mouse_shape != shape_table[SHAPE_IDX_VSEP].mshape) 3752 return; 3753 if (shape_idx < 0) 3754 new_mouse_shape = shape_table[get_shape_idx(TRUE)].mshape; 3755 else 3756 new_mouse_shape = shape_table[shape_idx].mshape; 3757 if (new_mouse_shape != old_mouse_shape) 3758 { 3759 mch_set_mouse_shape(new_mouse_shape); 3760 old_mouse_shape = new_mouse_shape; 3761 } 3762 postponed_mouseshape = FALSE; 3763 } 3764 # endif 3765 3766 #endif // CURSOR_SHAPE 3767 3768 3769 /* 3770 * Change directory to "new_dir". If FEAT_SEARCHPATH is defined, search 3771 * 'cdpath' for relative directory names, otherwise just mch_chdir(). 3772 */ 3773 int 3774 vim_chdir(char_u *new_dir) 3775 { 3776 #ifndef FEAT_SEARCHPATH 3777 return mch_chdir((char *)new_dir); 3778 #else 3779 char_u *dir_name; 3780 int r; 3781 3782 dir_name = find_directory_in_path(new_dir, (int)STRLEN(new_dir), 3783 FNAME_MESS, curbuf->b_ffname); 3784 if (dir_name == NULL) 3785 return -1; 3786 r = mch_chdir((char *)dir_name); 3787 vim_free(dir_name); 3788 return r; 3789 #endif 3790 } 3791 3792 /* 3793 * Get user name from machine-specific function. 3794 * Returns the user name in "buf[len]". 3795 * Some systems are quite slow in obtaining the user name (Windows NT), thus 3796 * cache the result. 3797 * Returns OK or FAIL. 3798 */ 3799 int 3800 get_user_name(char_u *buf, int len) 3801 { 3802 if (username == NULL) 3803 { 3804 if (mch_get_user_name(buf, len) == FAIL) 3805 return FAIL; 3806 username = vim_strsave(buf); 3807 } 3808 else 3809 vim_strncpy(buf, username, len - 1); 3810 return OK; 3811 } 3812 3813 #ifndef HAVE_QSORT 3814 /* 3815 * Our own qsort(), for systems that don't have it. 3816 * It's simple and slow. From the K&R C book. 3817 */ 3818 void 3819 qsort( 3820 void *base, 3821 size_t elm_count, 3822 size_t elm_size, 3823 int (*cmp)(const void *, const void *)) 3824 { 3825 char_u *buf; 3826 char_u *p1; 3827 char_u *p2; 3828 int i, j; 3829 int gap; 3830 3831 buf = alloc(elm_size); 3832 if (buf == NULL) 3833 return; 3834 3835 for (gap = elm_count / 2; gap > 0; gap /= 2) 3836 for (i = gap; i < elm_count; ++i) 3837 for (j = i - gap; j >= 0; j -= gap) 3838 { 3839 // Compare the elements. 3840 p1 = (char_u *)base + j * elm_size; 3841 p2 = (char_u *)base + (j + gap) * elm_size; 3842 if ((*cmp)((void *)p1, (void *)p2) <= 0) 3843 break; 3844 // Exchange the elements. 3845 mch_memmove(buf, p1, elm_size); 3846 mch_memmove(p1, p2, elm_size); 3847 mch_memmove(p2, buf, elm_size); 3848 } 3849 3850 vim_free(buf); 3851 } 3852 #endif 3853 3854 /* 3855 * Sort an array of strings. 3856 */ 3857 static int sort_compare(const void *s1, const void *s2); 3858 3859 static int 3860 sort_compare(const void *s1, const void *s2) 3861 { 3862 return STRCMP(*(char **)s1, *(char **)s2); 3863 } 3864 3865 void 3866 sort_strings( 3867 char_u **files, 3868 int count) 3869 { 3870 qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare); 3871 } 3872 3873 /* 3874 * The putenv() implementation below comes from the "screen" program. 3875 * Included with permission from Juergen Weigert. 3876 * See pty.c for the copyright notice. 3877 */ 3878 3879 /* 3880 * putenv -- put value into environment 3881 * 3882 * Usage: i = putenv (string) 3883 * int i; 3884 * char *string; 3885 * 3886 * where string is of the form <name>=<value>. 3887 * Putenv returns 0 normally, -1 on error (not enough core for malloc). 3888 * 3889 * Putenv may need to add a new name into the environment, or to 3890 * associate a value longer than the current value with a particular 3891 * name. So, to make life simpler, putenv() copies your entire 3892 * environment into the heap (i.e. malloc()) from the stack 3893 * (i.e. where it resides when your process is initiated) the first 3894 * time you call it. 3895 * 3896 * (history removed, not very interesting. See the "screen" sources.) 3897 */ 3898 3899 #if !defined(HAVE_SETENV) && !defined(HAVE_PUTENV) 3900 3901 #define EXTRASIZE 5 // increment to add to env. size 3902 3903 static int envsize = -1; // current size of environment 3904 extern char **environ; // the global which is your env. 3905 3906 static int findenv(char *name); // look for a name in the env. 3907 static int newenv(void); // copy env. from stack to heap 3908 static int moreenv(void); // incr. size of env. 3909 3910 int 3911 putenv(const char *string) 3912 { 3913 int i; 3914 char *p; 3915 3916 if (envsize < 0) 3917 { // first time putenv called 3918 if (newenv() < 0) // copy env. to heap 3919 return -1; 3920 } 3921 3922 i = findenv((char *)string); // look for name in environment 3923 3924 if (i < 0) 3925 { // name must be added 3926 for (i = 0; environ[i]; i++); 3927 if (i >= (envsize - 1)) 3928 { // need new slot 3929 if (moreenv() < 0) 3930 return -1; 3931 } 3932 p = alloc(strlen(string) + 1); 3933 if (p == NULL) // not enough core 3934 return -1; 3935 environ[i + 1] = 0; // new end of env. 3936 } 3937 else 3938 { // name already in env. 3939 p = vim_realloc(environ[i], strlen(string) + 1); 3940 if (p == NULL) 3941 return -1; 3942 } 3943 sprintf(p, "%s", string); // copy into env. 3944 environ[i] = p; 3945 3946 return 0; 3947 } 3948 3949 static int 3950 findenv(char *name) 3951 { 3952 char *namechar, *envchar; 3953 int i, found; 3954 3955 found = 0; 3956 for (i = 0; environ[i] && !found; i++) 3957 { 3958 envchar = environ[i]; 3959 namechar = name; 3960 while (*namechar && *namechar != '=' && (*namechar == *envchar)) 3961 { 3962 namechar++; 3963 envchar++; 3964 } 3965 found = ((*namechar == '\0' || *namechar == '=') && *envchar == '='); 3966 } 3967 return found ? i - 1 : -1; 3968 } 3969 3970 static int 3971 newenv(void) 3972 { 3973 char **env, *elem; 3974 int i, esize; 3975 3976 for (i = 0; environ[i]; i++) 3977 ; 3978 3979 esize = i + EXTRASIZE + 1; 3980 env = ALLOC_MULT(char *, esize); 3981 if (env == NULL) 3982 return -1; 3983 3984 for (i = 0; environ[i]; i++) 3985 { 3986 elem = alloc(strlen(environ[i]) + 1); 3987 if (elem == NULL) 3988 return -1; 3989 env[i] = elem; 3990 strcpy(elem, environ[i]); 3991 } 3992 3993 env[i] = 0; 3994 environ = env; 3995 envsize = esize; 3996 return 0; 3997 } 3998 3999 static int 4000 moreenv(void) 4001 { 4002 int esize; 4003 char **env; 4004 4005 esize = envsize + EXTRASIZE; 4006 env = vim_realloc((char *)environ, esize * sizeof (*env)); 4007 if (env == 0) 4008 return -1; 4009 environ = env; 4010 envsize = esize; 4011 return 0; 4012 } 4013 4014 # ifdef USE_VIMPTY_GETENV 4015 /* 4016 * Used for mch_getenv() for Mac. 4017 */ 4018 char_u * 4019 vimpty_getenv(const char_u *string) 4020 { 4021 int i; 4022 char_u *p; 4023 4024 if (envsize < 0) 4025 return NULL; 4026 4027 i = findenv((char *)string); 4028 4029 if (i < 0) 4030 return NULL; 4031 4032 p = vim_strchr((char_u *)environ[i], '='); 4033 return (p + 1); 4034 } 4035 # endif 4036 4037 #endif // !defined(HAVE_SETENV) && !defined(HAVE_PUTENV) 4038 4039 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO) 4040 /* 4041 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have 4042 * rights to write into. 4043 */ 4044 int 4045 filewritable(char_u *fname) 4046 { 4047 int retval = 0; 4048 #if defined(UNIX) || defined(VMS) 4049 int perm = 0; 4050 #endif 4051 4052 #if defined(UNIX) || defined(VMS) 4053 perm = mch_getperm(fname); 4054 #endif 4055 if ( 4056 # ifdef MSWIN 4057 mch_writable(fname) && 4058 # else 4059 # if defined(UNIX) || defined(VMS) 4060 (perm & 0222) && 4061 # endif 4062 # endif 4063 mch_access((char *)fname, W_OK) == 0 4064 ) 4065 { 4066 ++retval; 4067 if (mch_isdir(fname)) 4068 ++retval; 4069 } 4070 return retval; 4071 } 4072 #endif 4073 4074 #if defined(FEAT_SPELL) || defined(FEAT_PERSISTENT_UNDO) || defined(PROTO) 4075 /* 4076 * Read 2 bytes from "fd" and turn them into an int, MSB first. 4077 * Returns -1 when encountering EOF. 4078 */ 4079 int 4080 get2c(FILE *fd) 4081 { 4082 int c, n; 4083 4084 n = getc(fd); 4085 if (n == EOF) return -1; 4086 c = getc(fd); 4087 if (c == EOF) return -1; 4088 return (n << 8) + c; 4089 } 4090 4091 /* 4092 * Read 3 bytes from "fd" and turn them into an int, MSB first. 4093 * Returns -1 when encountering EOF. 4094 */ 4095 int 4096 get3c(FILE *fd) 4097 { 4098 int c, n; 4099 4100 n = getc(fd); 4101 if (n == EOF) return -1; 4102 c = getc(fd); 4103 if (c == EOF) return -1; 4104 n = (n << 8) + c; 4105 c = getc(fd); 4106 if (c == EOF) return -1; 4107 return (n << 8) + c; 4108 } 4109 4110 /* 4111 * Read 4 bytes from "fd" and turn them into an int, MSB first. 4112 * Returns -1 when encountering EOF. 4113 */ 4114 int 4115 get4c(FILE *fd) 4116 { 4117 int c; 4118 // Use unsigned rather than int otherwise result is undefined 4119 // when left-shift sets the MSB. 4120 unsigned n; 4121 4122 c = getc(fd); 4123 if (c == EOF) return -1; 4124 n = (unsigned)c; 4125 c = getc(fd); 4126 if (c == EOF) return -1; 4127 n = (n << 8) + (unsigned)c; 4128 c = getc(fd); 4129 if (c == EOF) return -1; 4130 n = (n << 8) + (unsigned)c; 4131 c = getc(fd); 4132 if (c == EOF) return -1; 4133 n = (n << 8) + (unsigned)c; 4134 return (int)n; 4135 } 4136 4137 /* 4138 * Read a string of length "cnt" from "fd" into allocated memory. 4139 * Returns NULL when out of memory or unable to read that many bytes. 4140 */ 4141 char_u * 4142 read_string(FILE *fd, int cnt) 4143 { 4144 char_u *str; 4145 int i; 4146 int c; 4147 4148 // allocate memory 4149 str = alloc(cnt + 1); 4150 if (str != NULL) 4151 { 4152 // Read the string. Quit when running into the EOF. 4153 for (i = 0; i < cnt; ++i) 4154 { 4155 c = getc(fd); 4156 if (c == EOF) 4157 { 4158 vim_free(str); 4159 return NULL; 4160 } 4161 str[i] = c; 4162 } 4163 str[i] = NUL; 4164 } 4165 return str; 4166 } 4167 4168 /* 4169 * Write a number to file "fd", MSB first, in "len" bytes. 4170 */ 4171 int 4172 put_bytes(FILE *fd, long_u nr, int len) 4173 { 4174 int i; 4175 4176 for (i = len - 1; i >= 0; --i) 4177 if (putc((int)(nr >> (i * 8)), fd) == EOF) 4178 return FAIL; 4179 return OK; 4180 } 4181 4182 #endif 4183 4184 #if defined(FEAT_QUICKFIX) || defined(FEAT_SPELL) || defined(PROTO) 4185 /* 4186 * Return TRUE if string "s" contains a non-ASCII character (128 or higher). 4187 * When "s" is NULL FALSE is returned. 4188 */ 4189 int 4190 has_non_ascii(char_u *s) 4191 { 4192 char_u *p; 4193 4194 if (s != NULL) 4195 for (p = s; *p != NUL; ++p) 4196 if (*p >= 128) 4197 return TRUE; 4198 return FALSE; 4199 } 4200 #endif 4201 4202 #ifndef PROTO // proto is defined in vim.h 4203 # ifdef ELAPSED_TIMEVAL 4204 /* 4205 * Return time in msec since "start_tv". 4206 */ 4207 long 4208 elapsed(struct timeval *start_tv) 4209 { 4210 struct timeval now_tv; 4211 4212 gettimeofday(&now_tv, NULL); 4213 return (now_tv.tv_sec - start_tv->tv_sec) * 1000L 4214 + (now_tv.tv_usec - start_tv->tv_usec) / 1000L; 4215 } 4216 # endif 4217 4218 # ifdef ELAPSED_TICKCOUNT 4219 /* 4220 * Return time in msec since "start_tick". 4221 */ 4222 long 4223 elapsed(DWORD start_tick) 4224 { 4225 DWORD now = GetTickCount(); 4226 4227 return (long)now - (long)start_tick; 4228 } 4229 # endif 4230 #endif 4231 4232 #if defined(FEAT_JOB_CHANNEL) \ 4233 || (defined(UNIX) && (!defined(USE_SYSTEM) \ 4234 || (defined(FEAT_GUI) && defined(FEAT_TERMINAL)))) \ 4235 || defined(PROTO) 4236 /* 4237 * Parse "cmd" and put the white-separated parts in "argv". 4238 * "argv" is an allocated array with "argc" entries and room for 4 more. 4239 * Returns FAIL when out of memory. 4240 */ 4241 int 4242 mch_parse_cmd(char_u *cmd, int use_shcf, char ***argv, int *argc) 4243 { 4244 int i; 4245 char_u *p, *d; 4246 int inquote; 4247 4248 /* 4249 * Do this loop twice: 4250 * 1: find number of arguments 4251 * 2: separate them and build argv[] 4252 */ 4253 for (i = 1; i <= 2; ++i) 4254 { 4255 p = skipwhite(cmd); 4256 inquote = FALSE; 4257 *argc = 0; 4258 while (*p != NUL) 4259 { 4260 if (i == 2) 4261 (*argv)[*argc] = (char *)p; 4262 ++*argc; 4263 d = p; 4264 while (*p != NUL && (inquote || (*p != ' ' && *p != TAB))) 4265 { 4266 if (p[0] == '"') 4267 // quotes surrounding an argument and are dropped 4268 inquote = !inquote; 4269 else 4270 { 4271 if (rem_backslash(p)) 4272 { 4273 // First pass: skip over "\ " and "\"". 4274 // Second pass: Remove the backslash. 4275 ++p; 4276 } 4277 if (i == 2) 4278 *d++ = *p; 4279 } 4280 ++p; 4281 } 4282 if (*p == NUL) 4283 { 4284 if (i == 2) 4285 *d++ = NUL; 4286 break; 4287 } 4288 if (i == 2) 4289 *d++ = NUL; 4290 p = skipwhite(p + 1); 4291 } 4292 if (*argv == NULL) 4293 { 4294 if (use_shcf) 4295 { 4296 // Account for possible multiple args in p_shcf. 4297 p = p_shcf; 4298 for (;;) 4299 { 4300 p = skiptowhite(p); 4301 if (*p == NUL) 4302 break; 4303 ++*argc; 4304 p = skipwhite(p); 4305 } 4306 } 4307 4308 *argv = ALLOC_MULT(char *, *argc + 4); 4309 if (*argv == NULL) // out of memory 4310 return FAIL; 4311 } 4312 } 4313 return OK; 4314 } 4315 4316 # if defined(FEAT_JOB_CHANNEL) || defined(PROTO) 4317 /* 4318 * Build "argv[argc]" from the string "cmd". 4319 * "argv[argc]" is set to NULL; 4320 * Return FAIL when out of memory. 4321 */ 4322 int 4323 build_argv_from_string(char_u *cmd, char ***argv, int *argc) 4324 { 4325 char_u *cmd_copy; 4326 int i; 4327 4328 // Make a copy, parsing will modify "cmd". 4329 cmd_copy = vim_strsave(cmd); 4330 if (cmd_copy == NULL 4331 || mch_parse_cmd(cmd_copy, FALSE, argv, argc) == FAIL) 4332 { 4333 vim_free(cmd_copy); 4334 return FAIL; 4335 } 4336 for (i = 0; i < *argc; i++) 4337 (*argv)[i] = (char *)vim_strsave((char_u *)(*argv)[i]); 4338 (*argv)[*argc] = NULL; 4339 vim_free(cmd_copy); 4340 return OK; 4341 } 4342 4343 /* 4344 * Build "argv[argc]" from the list "l". 4345 * "argv[argc]" is set to NULL; 4346 * Return FAIL when out of memory. 4347 */ 4348 int 4349 build_argv_from_list(list_T *l, char ***argv, int *argc) 4350 { 4351 listitem_T *li; 4352 char_u *s; 4353 4354 // Pass argv[] to mch_call_shell(). 4355 *argv = ALLOC_MULT(char *, l->lv_len + 1); 4356 if (*argv == NULL) 4357 return FAIL; 4358 *argc = 0; 4359 FOR_ALL_LIST_ITEMS(l, li) 4360 { 4361 s = tv_get_string_chk(&li->li_tv); 4362 if (s == NULL) 4363 { 4364 int i; 4365 4366 for (i = 0; i < *argc; ++i) 4367 VIM_CLEAR((*argv)[i]); 4368 return FAIL; 4369 } 4370 (*argv)[*argc] = (char *)vim_strsave(s); 4371 *argc += 1; 4372 } 4373 (*argv)[*argc] = NULL; 4374 return OK; 4375 } 4376 # endif 4377 #endif 4378 4379 /* 4380 * Change the behavior of vterm. 4381 * 0: As usual. 4382 * 1: Windows 10 version 1809 4383 * The bug causes unstable handling of ambiguous width character. 4384 * 2: Windows 10 version 1903 & 1909 4385 * Use the wrong result because each result is different. 4386 * 3: Windows 10 insider preview (current latest logic) 4387 */ 4388 int 4389 get_special_pty_type(void) 4390 { 4391 #ifdef MSWIN 4392 return get_conpty_type(); 4393 #else 4394 return 0; 4395 #endif 4396 } 4397