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 char_u *ff_expand_buffer = NULL; /* used for expanding filenames */ 18 19 #if defined(FEAT_VIRTUALEDIT) || defined(PROTO) 20 static int coladvance2(pos_T *pos, int addspaces, int finetune, colnr_T wcol); 21 22 /* 23 * Return TRUE if in the current mode we need to use virtual. 24 */ 25 int 26 virtual_active(void) 27 { 28 /* While an operator is being executed we return "virtual_op", because 29 * VIsual_active has already been reset, thus we can't check for "block" 30 * being used. */ 31 if (virtual_op != MAYBE) 32 return virtual_op; 33 return (ve_flags == VE_ALL 34 || ((ve_flags & VE_BLOCK) && VIsual_active && VIsual_mode == Ctrl_V) 35 || ((ve_flags & VE_INSERT) && (State & INSERT))); 36 } 37 38 /* 39 * Get the screen position of the cursor. 40 */ 41 int 42 getviscol(void) 43 { 44 colnr_T x; 45 46 getvvcol(curwin, &curwin->w_cursor, &x, NULL, NULL); 47 return (int)x; 48 } 49 50 /* 51 * Get the screen position of character col with a coladd in the cursor line. 52 */ 53 int 54 getviscol2(colnr_T col, colnr_T coladd) 55 { 56 colnr_T x; 57 pos_T pos; 58 59 pos.lnum = curwin->w_cursor.lnum; 60 pos.col = col; 61 pos.coladd = coladd; 62 getvvcol(curwin, &pos, &x, NULL, NULL); 63 return (int)x; 64 } 65 66 /* 67 * Go to column "wcol", and add/insert white space as necessary to get the 68 * cursor in that column. 69 * The caller must have saved the cursor line for undo! 70 */ 71 int 72 coladvance_force(colnr_T wcol) 73 { 74 int rc = coladvance2(&curwin->w_cursor, TRUE, FALSE, wcol); 75 76 if (wcol == MAXCOL) 77 curwin->w_valid &= ~VALID_VIRTCOL; 78 else 79 { 80 /* Virtcol is valid */ 81 curwin->w_valid |= VALID_VIRTCOL; 82 curwin->w_virtcol = wcol; 83 } 84 return rc; 85 } 86 #endif 87 88 /* 89 * Try to advance the Cursor to the specified screen column. 90 * If virtual editing: fine tune the cursor position. 91 * Note that all virtual positions off the end of a line should share 92 * a curwin->w_cursor.col value (n.b. this is equal to STRLEN(line)), 93 * beginning at coladd 0. 94 * 95 * return OK if desired column is reached, FAIL if not 96 */ 97 int 98 coladvance(colnr_T wcol) 99 { 100 int rc = getvpos(&curwin->w_cursor, wcol); 101 102 if (wcol == MAXCOL || rc == FAIL) 103 curwin->w_valid &= ~VALID_VIRTCOL; 104 else if (*ml_get_cursor() != TAB) 105 { 106 /* Virtcol is valid when not on a TAB */ 107 curwin->w_valid |= VALID_VIRTCOL; 108 curwin->w_virtcol = wcol; 109 } 110 return rc; 111 } 112 113 /* 114 * Return in "pos" the position of the cursor advanced to screen column "wcol". 115 * return OK if desired column is reached, FAIL if not 116 */ 117 int 118 getvpos(pos_T *pos, colnr_T wcol) 119 { 120 #ifdef FEAT_VIRTUALEDIT 121 return coladvance2(pos, FALSE, virtual_active(), wcol); 122 } 123 124 static int 125 coladvance2( 126 pos_T *pos, 127 int addspaces, /* change the text to achieve our goal? */ 128 int finetune, /* change char offset for the exact column */ 129 colnr_T wcol) /* column to move to */ 130 { 131 #endif 132 int idx; 133 char_u *ptr; 134 char_u *line; 135 colnr_T col = 0; 136 int csize = 0; 137 int one_more; 138 #ifdef FEAT_LINEBREAK 139 int head = 0; 140 #endif 141 142 one_more = (State & INSERT) 143 || restart_edit != NUL 144 || (VIsual_active && *p_sel != 'o') 145 #ifdef FEAT_VIRTUALEDIT 146 || ((ve_flags & VE_ONEMORE) && wcol < MAXCOL) 147 #endif 148 ; 149 line = ml_get_buf(curbuf, pos->lnum, FALSE); 150 151 if (wcol >= MAXCOL) 152 { 153 idx = (int)STRLEN(line) - 1 + one_more; 154 col = wcol; 155 156 #ifdef FEAT_VIRTUALEDIT 157 if ((addspaces || finetune) && !VIsual_active) 158 { 159 curwin->w_curswant = linetabsize(line) + one_more; 160 if (curwin->w_curswant > 0) 161 --curwin->w_curswant; 162 } 163 #endif 164 } 165 else 166 { 167 #ifdef FEAT_VIRTUALEDIT 168 int width = W_WIDTH(curwin) - win_col_off(curwin); 169 170 if (finetune 171 && curwin->w_p_wrap 172 # ifdef FEAT_WINDOWS 173 && curwin->w_width != 0 174 # endif 175 && wcol >= (colnr_T)width) 176 { 177 csize = linetabsize(line); 178 if (csize > 0) 179 csize--; 180 181 if (wcol / width > (colnr_T)csize / width 182 && ((State & INSERT) == 0 || (int)wcol > csize + 1)) 183 { 184 /* In case of line wrapping don't move the cursor beyond the 185 * right screen edge. In Insert mode allow going just beyond 186 * the last character (like what happens when typing and 187 * reaching the right window edge). */ 188 wcol = (csize / width + 1) * width - 1; 189 } 190 } 191 #endif 192 193 ptr = line; 194 while (col <= wcol && *ptr != NUL) 195 { 196 /* Count a tab for what it's worth (if list mode not on) */ 197 #ifdef FEAT_LINEBREAK 198 csize = win_lbr_chartabsize(curwin, line, ptr, col, &head); 199 mb_ptr_adv(ptr); 200 #else 201 csize = lbr_chartabsize_adv(line, &ptr, col); 202 #endif 203 col += csize; 204 } 205 idx = (int)(ptr - line); 206 /* 207 * Handle all the special cases. The virtual_active() check 208 * is needed to ensure that a virtual position off the end of 209 * a line has the correct indexing. The one_more comparison 210 * replaces an explicit add of one_more later on. 211 */ 212 if (col > wcol || (!virtual_active() && one_more == 0)) 213 { 214 idx -= 1; 215 # ifdef FEAT_LINEBREAK 216 /* Don't count the chars from 'showbreak'. */ 217 csize -= head; 218 # endif 219 col -= csize; 220 } 221 222 #ifdef FEAT_VIRTUALEDIT 223 if (virtual_active() 224 && addspaces 225 && ((col != wcol && col != wcol + 1) || csize > 1)) 226 { 227 /* 'virtualedit' is set: The difference between wcol and col is 228 * filled with spaces. */ 229 230 if (line[idx] == NUL) 231 { 232 /* Append spaces */ 233 int correct = wcol - col; 234 char_u *newline = alloc(idx + correct + 1); 235 int t; 236 237 if (newline == NULL) 238 return FAIL; 239 240 for (t = 0; t < idx; ++t) 241 newline[t] = line[t]; 242 243 for (t = 0; t < correct; ++t) 244 newline[t + idx] = ' '; 245 246 newline[idx + correct] = NUL; 247 248 ml_replace(pos->lnum, newline, FALSE); 249 changed_bytes(pos->lnum, (colnr_T)idx); 250 idx += correct; 251 col = wcol; 252 } 253 else 254 { 255 /* Break a tab */ 256 int linelen = (int)STRLEN(line); 257 int correct = wcol - col - csize + 1; /* negative!! */ 258 char_u *newline; 259 int t, s = 0; 260 int v; 261 262 if (-correct > csize) 263 return FAIL; 264 265 newline = alloc(linelen + csize); 266 if (newline == NULL) 267 return FAIL; 268 269 for (t = 0; t < linelen; t++) 270 { 271 if (t != idx) 272 newline[s++] = line[t]; 273 else 274 for (v = 0; v < csize; v++) 275 newline[s++] = ' '; 276 } 277 278 newline[linelen + csize - 1] = NUL; 279 280 ml_replace(pos->lnum, newline, FALSE); 281 changed_bytes(pos->lnum, idx); 282 idx += (csize - 1 + correct); 283 col += correct; 284 } 285 } 286 #endif 287 } 288 289 if (idx < 0) 290 pos->col = 0; 291 else 292 pos->col = idx; 293 294 #ifdef FEAT_VIRTUALEDIT 295 pos->coladd = 0; 296 297 if (finetune) 298 { 299 if (wcol == MAXCOL) 300 { 301 /* The width of the last character is used to set coladd. */ 302 if (!one_more) 303 { 304 colnr_T scol, ecol; 305 306 getvcol(curwin, pos, &scol, NULL, &ecol); 307 pos->coladd = ecol - scol; 308 } 309 } 310 else 311 { 312 int b = (int)wcol - (int)col; 313 314 /* The difference between wcol and col is used to set coladd. */ 315 if (b > 0 && b < (MAXCOL - 2 * W_WIDTH(curwin))) 316 pos->coladd = b; 317 318 col += b; 319 } 320 } 321 #endif 322 323 #ifdef FEAT_MBYTE 324 /* prevent from moving onto a trail byte */ 325 if (has_mbyte) 326 mb_adjustpos(curbuf, pos); 327 #endif 328 329 if (col < wcol) 330 return FAIL; 331 return OK; 332 } 333 334 /* 335 * Increment the cursor position. See inc() for return values. 336 */ 337 int 338 inc_cursor(void) 339 { 340 return inc(&curwin->w_cursor); 341 } 342 343 /* 344 * Increment the line pointer "lp" crossing line boundaries as necessary. 345 * Return 1 when going to the next line. 346 * Return 2 when moving forward onto a NUL at the end of the line). 347 * Return -1 when at the end of file. 348 * Return 0 otherwise. 349 */ 350 int 351 inc(pos_T *lp) 352 { 353 char_u *p = ml_get_pos(lp); 354 355 if (*p != NUL) /* still within line, move to next char (may be NUL) */ 356 { 357 #ifdef FEAT_MBYTE 358 if (has_mbyte) 359 { 360 int l = (*mb_ptr2len)(p); 361 362 lp->col += l; 363 return ((p[l] != NUL) ? 0 : 2); 364 } 365 #endif 366 lp->col++; 367 #ifdef FEAT_VIRTUALEDIT 368 lp->coladd = 0; 369 #endif 370 return ((p[1] != NUL) ? 0 : 2); 371 } 372 if (lp->lnum != curbuf->b_ml.ml_line_count) /* there is a next line */ 373 { 374 lp->col = 0; 375 lp->lnum++; 376 #ifdef FEAT_VIRTUALEDIT 377 lp->coladd = 0; 378 #endif 379 return 1; 380 } 381 return -1; 382 } 383 384 /* 385 * incl(lp): same as inc(), but skip the NUL at the end of non-empty lines 386 */ 387 int 388 incl(pos_T *lp) 389 { 390 int r; 391 392 if ((r = inc(lp)) >= 1 && lp->col) 393 r = inc(lp); 394 return r; 395 } 396 397 /* 398 * dec(p) 399 * 400 * Decrement the line pointer 'p' crossing line boundaries as necessary. 401 * Return 1 when crossing a line, -1 when at start of file, 0 otherwise. 402 */ 403 int 404 dec_cursor(void) 405 { 406 return dec(&curwin->w_cursor); 407 } 408 409 int 410 dec(pos_T *lp) 411 { 412 char_u *p; 413 414 #ifdef FEAT_VIRTUALEDIT 415 lp->coladd = 0; 416 #endif 417 if (lp->col > 0) /* still within line */ 418 { 419 lp->col--; 420 #ifdef FEAT_MBYTE 421 if (has_mbyte) 422 { 423 p = ml_get(lp->lnum); 424 lp->col -= (*mb_head_off)(p, p + lp->col); 425 } 426 #endif 427 return 0; 428 } 429 if (lp->lnum > 1) /* there is a prior line */ 430 { 431 lp->lnum--; 432 p = ml_get(lp->lnum); 433 lp->col = (colnr_T)STRLEN(p); 434 #ifdef FEAT_MBYTE 435 if (has_mbyte) 436 lp->col -= (*mb_head_off)(p, p + lp->col); 437 #endif 438 return 1; 439 } 440 return -1; /* at start of file */ 441 } 442 443 /* 444 * decl(lp): same as dec(), but skip the NUL at the end of non-empty lines 445 */ 446 int 447 decl(pos_T *lp) 448 { 449 int r; 450 451 if ((r = dec(lp)) == 1 && lp->col) 452 r = dec(lp); 453 return r; 454 } 455 456 /* 457 * Get the line number relative to the current cursor position, i.e. the 458 * difference between line number and cursor position. Only look for lines that 459 * can be visible, folded lines don't count. 460 */ 461 linenr_T 462 get_cursor_rel_lnum( 463 win_T *wp, 464 linenr_T lnum) /* line number to get the result for */ 465 { 466 linenr_T cursor = wp->w_cursor.lnum; 467 linenr_T retval = 0; 468 469 #ifdef FEAT_FOLDING 470 if (hasAnyFolding(wp)) 471 { 472 if (lnum > cursor) 473 { 474 while (lnum > cursor) 475 { 476 (void)hasFoldingWin(wp, lnum, &lnum, NULL, TRUE, NULL); 477 /* if lnum and cursor are in the same fold, 478 * now lnum <= cursor */ 479 if (lnum > cursor) 480 retval++; 481 lnum--; 482 } 483 } 484 else if (lnum < cursor) 485 { 486 while (lnum < cursor) 487 { 488 (void)hasFoldingWin(wp, lnum, NULL, &lnum, TRUE, NULL); 489 /* if lnum and cursor are in the same fold, 490 * now lnum >= cursor */ 491 if (lnum < cursor) 492 retval--; 493 lnum++; 494 } 495 } 496 /* else if (lnum == cursor) 497 * retval = 0; 498 */ 499 } 500 else 501 #endif 502 retval = lnum - cursor; 503 504 return retval; 505 } 506 507 /* 508 * Make sure "pos.lnum" and "pos.col" are valid in "buf". 509 * This allows for the col to be on the NUL byte. 510 */ 511 void 512 check_pos(buf_T *buf, pos_T *pos) 513 { 514 char_u *line; 515 colnr_T len; 516 517 if (pos->lnum > buf->b_ml.ml_line_count) 518 pos->lnum = buf->b_ml.ml_line_count; 519 520 if (pos->col > 0) 521 { 522 line = ml_get_buf(buf, pos->lnum, FALSE); 523 len = (colnr_T)STRLEN(line); 524 if (pos->col > len) 525 pos->col = len; 526 } 527 } 528 529 /* 530 * Make sure curwin->w_cursor.lnum is valid. 531 */ 532 void 533 check_cursor_lnum(void) 534 { 535 if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count) 536 { 537 #ifdef FEAT_FOLDING 538 /* If there is a closed fold at the end of the file, put the cursor in 539 * its first line. Otherwise in the last line. */ 540 if (!hasFolding(curbuf->b_ml.ml_line_count, 541 &curwin->w_cursor.lnum, NULL)) 542 #endif 543 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count; 544 } 545 if (curwin->w_cursor.lnum <= 0) 546 curwin->w_cursor.lnum = 1; 547 } 548 549 /* 550 * Make sure curwin->w_cursor.col is valid. 551 */ 552 void 553 check_cursor_col(void) 554 { 555 check_cursor_col_win(curwin); 556 } 557 558 /* 559 * Make sure win->w_cursor.col is valid. 560 */ 561 void 562 check_cursor_col_win(win_T *win) 563 { 564 colnr_T len; 565 #ifdef FEAT_VIRTUALEDIT 566 colnr_T oldcol = win->w_cursor.col; 567 colnr_T oldcoladd = win->w_cursor.col + win->w_cursor.coladd; 568 #endif 569 570 len = (colnr_T)STRLEN(ml_get_buf(win->w_buffer, win->w_cursor.lnum, FALSE)); 571 if (len == 0) 572 win->w_cursor.col = 0; 573 else if (win->w_cursor.col >= len) 574 { 575 /* Allow cursor past end-of-line when: 576 * - in Insert mode or restarting Insert mode 577 * - in Visual mode and 'selection' isn't "old" 578 * - 'virtualedit' is set */ 579 if ((State & INSERT) || restart_edit 580 || (VIsual_active && *p_sel != 'o') 581 #ifdef FEAT_VIRTUALEDIT 582 || (ve_flags & VE_ONEMORE) 583 #endif 584 || virtual_active()) 585 win->w_cursor.col = len; 586 else 587 { 588 win->w_cursor.col = len - 1; 589 #ifdef FEAT_MBYTE 590 /* Move the cursor to the head byte. */ 591 if (has_mbyte) 592 mb_adjustpos(win->w_buffer, &win->w_cursor); 593 #endif 594 } 595 } 596 else if (win->w_cursor.col < 0) 597 win->w_cursor.col = 0; 598 599 #ifdef FEAT_VIRTUALEDIT 600 /* If virtual editing is on, we can leave the cursor on the old position, 601 * only we must set it to virtual. But don't do it when at the end of the 602 * line. */ 603 if (oldcol == MAXCOL) 604 win->w_cursor.coladd = 0; 605 else if (ve_flags == VE_ALL) 606 { 607 if (oldcoladd > win->w_cursor.col) 608 win->w_cursor.coladd = oldcoladd - win->w_cursor.col; 609 else 610 /* avoid weird number when there is a miscalculation or overflow */ 611 win->w_cursor.coladd = 0; 612 } 613 #endif 614 } 615 616 /* 617 * make sure curwin->w_cursor in on a valid character 618 */ 619 void 620 check_cursor(void) 621 { 622 check_cursor_lnum(); 623 check_cursor_col(); 624 } 625 626 #if defined(FEAT_TEXTOBJ) || defined(PROTO) 627 /* 628 * Make sure curwin->w_cursor is not on the NUL at the end of the line. 629 * Allow it when in Visual mode and 'selection' is not "old". 630 */ 631 void 632 adjust_cursor_col(void) 633 { 634 if (curwin->w_cursor.col > 0 635 && (!VIsual_active || *p_sel == 'o') 636 && gchar_cursor() == NUL) 637 --curwin->w_cursor.col; 638 } 639 #endif 640 641 /* 642 * When curwin->w_leftcol has changed, adjust the cursor position. 643 * Return TRUE if the cursor was moved. 644 */ 645 int 646 leftcol_changed(void) 647 { 648 long lastcol; 649 colnr_T s, e; 650 int retval = FALSE; 651 652 changed_cline_bef_curs(); 653 lastcol = curwin->w_leftcol + W_WIDTH(curwin) - curwin_col_off() - 1; 654 validate_virtcol(); 655 656 /* 657 * If the cursor is right or left of the screen, move it to last or first 658 * character. 659 */ 660 if (curwin->w_virtcol > (colnr_T)(lastcol - p_siso)) 661 { 662 retval = TRUE; 663 coladvance((colnr_T)(lastcol - p_siso)); 664 } 665 else if (curwin->w_virtcol < curwin->w_leftcol + p_siso) 666 { 667 retval = TRUE; 668 (void)coladvance((colnr_T)(curwin->w_leftcol + p_siso)); 669 } 670 671 /* 672 * If the start of the character under the cursor is not on the screen, 673 * advance the cursor one more char. If this fails (last char of the 674 * line) adjust the scrolling. 675 */ 676 getvvcol(curwin, &curwin->w_cursor, &s, NULL, &e); 677 if (e > (colnr_T)lastcol) 678 { 679 retval = TRUE; 680 coladvance(s - 1); 681 } 682 else if (s < curwin->w_leftcol) 683 { 684 retval = TRUE; 685 if (coladvance(e + 1) == FAIL) /* there isn't another character */ 686 { 687 curwin->w_leftcol = s; /* adjust w_leftcol instead */ 688 changed_cline_bef_curs(); 689 } 690 } 691 692 if (retval) 693 curwin->w_set_curswant = TRUE; 694 redraw_later(NOT_VALID); 695 return retval; 696 } 697 698 /********************************************************************** 699 * Various routines dealing with allocation and deallocation of memory. 700 */ 701 702 #if defined(MEM_PROFILE) || defined(PROTO) 703 704 # define MEM_SIZES 8200 705 static long_u mem_allocs[MEM_SIZES]; 706 static long_u mem_frees[MEM_SIZES]; 707 static long_u mem_allocated; 708 static long_u mem_freed; 709 static long_u mem_peak; 710 static long_u num_alloc; 711 static long_u num_freed; 712 713 static void mem_pre_alloc_s(size_t *sizep); 714 static void mem_pre_alloc_l(long_u *sizep); 715 static void mem_post_alloc(void **pp, size_t size); 716 static void mem_pre_free(void **pp); 717 718 static void 719 mem_pre_alloc_s(size_t *sizep) 720 { 721 *sizep += sizeof(size_t); 722 } 723 724 static void 725 mem_pre_alloc_l(long_u *sizep) 726 { 727 *sizep += sizeof(size_t); 728 } 729 730 static void 731 mem_post_alloc( 732 void **pp, 733 size_t size) 734 { 735 if (*pp == NULL) 736 return; 737 size -= sizeof(size_t); 738 *(long_u *)*pp = size; 739 if (size <= MEM_SIZES-1) 740 mem_allocs[size-1]++; 741 else 742 mem_allocs[MEM_SIZES-1]++; 743 mem_allocated += size; 744 if (mem_allocated - mem_freed > mem_peak) 745 mem_peak = mem_allocated - mem_freed; 746 num_alloc++; 747 *pp = (void *)((char *)*pp + sizeof(size_t)); 748 } 749 750 static void 751 mem_pre_free(void **pp) 752 { 753 long_u size; 754 755 *pp = (void *)((char *)*pp - sizeof(size_t)); 756 size = *(size_t *)*pp; 757 if (size <= MEM_SIZES-1) 758 mem_frees[size-1]++; 759 else 760 mem_frees[MEM_SIZES-1]++; 761 mem_freed += size; 762 num_freed++; 763 } 764 765 /* 766 * called on exit via atexit() 767 */ 768 void 769 vim_mem_profile_dump(void) 770 { 771 int i, j; 772 773 printf("\r\n"); 774 j = 0; 775 for (i = 0; i < MEM_SIZES - 1; i++) 776 { 777 if (mem_allocs[i] || mem_frees[i]) 778 { 779 if (mem_frees[i] > mem_allocs[i]) 780 printf("\r\n%s", _("ERROR: ")); 781 printf("[%4d / %4lu-%-4lu] ", i + 1, mem_allocs[i], mem_frees[i]); 782 j++; 783 if (j > 3) 784 { 785 j = 0; 786 printf("\r\n"); 787 } 788 } 789 } 790 791 i = MEM_SIZES - 1; 792 if (mem_allocs[i]) 793 { 794 printf("\r\n"); 795 if (mem_frees[i] > mem_allocs[i]) 796 puts(_("ERROR: ")); 797 printf("[>%d / %4lu-%-4lu]", i, mem_allocs[i], mem_frees[i]); 798 } 799 800 printf(_("\n[bytes] total alloc-freed %lu-%lu, in use %lu, peak use %lu\n"), 801 mem_allocated, mem_freed, mem_allocated - mem_freed, mem_peak); 802 printf(_("[calls] total re/malloc()'s %lu, total free()'s %lu\n\n"), 803 num_alloc, num_freed); 804 } 805 806 #endif /* MEM_PROFILE */ 807 808 #ifdef FEAT_EVAL 809 static int alloc_does_fail(long_u size); 810 811 static int 812 alloc_does_fail(long_u size) 813 { 814 if (alloc_fail_countdown == 0) 815 { 816 if (--alloc_fail_repeat <= 0) 817 alloc_fail_id = 0; 818 do_outofmem_msg(size); 819 return TRUE; 820 } 821 --alloc_fail_countdown; 822 return FALSE; 823 } 824 #endif 825 826 /* 827 * Some memory is reserved for error messages and for being able to 828 * call mf_release_all(), which needs some memory for mf_trans_add(). 829 */ 830 #define KEEP_ROOM (2 * 8192L) 831 #define KEEP_ROOM_KB (KEEP_ROOM / 1024L) 832 833 /* 834 * Note: if unsigned is 16 bits we can only allocate up to 64K with alloc(). 835 * Use lalloc for larger blocks. 836 */ 837 char_u * 838 alloc(unsigned size) 839 { 840 return (lalloc((long_u)size, TRUE)); 841 } 842 843 /* 844 * alloc() with an ID for alloc_fail(). 845 */ 846 char_u * 847 alloc_id(unsigned size, alloc_id_T id UNUSED) 848 { 849 #ifdef FEAT_EVAL 850 if (alloc_fail_id == id && alloc_does_fail((long_u)size)) 851 return NULL; 852 #endif 853 return (lalloc((long_u)size, TRUE)); 854 } 855 856 /* 857 * Allocate memory and set all bytes to zero. 858 */ 859 char_u * 860 alloc_clear(unsigned size) 861 { 862 char_u *p; 863 864 p = lalloc((long_u)size, TRUE); 865 if (p != NULL) 866 (void)vim_memset(p, 0, (size_t)size); 867 return p; 868 } 869 870 /* 871 * alloc() with check for maximum line length 872 */ 873 char_u * 874 alloc_check(unsigned size) 875 { 876 #if !defined(UNIX) 877 if (sizeof(int) == 2 && size > 0x7fff) 878 { 879 /* Don't hide this message */ 880 emsg_silent = 0; 881 EMSG(_("E340: Line is becoming too long")); 882 return NULL; 883 } 884 #endif 885 return (lalloc((long_u)size, TRUE)); 886 } 887 888 /* 889 * Allocate memory like lalloc() and set all bytes to zero. 890 */ 891 char_u * 892 lalloc_clear(long_u size, int message) 893 { 894 char_u *p; 895 896 p = (lalloc(size, message)); 897 if (p != NULL) 898 (void)vim_memset(p, 0, (size_t)size); 899 return p; 900 } 901 902 /* 903 * Low level memory allocation function. 904 * This is used often, KEEP IT FAST! 905 */ 906 char_u * 907 lalloc(long_u size, int message) 908 { 909 char_u *p; /* pointer to new storage space */ 910 static int releasing = FALSE; /* don't do mf_release_all() recursive */ 911 int try_again; 912 #if defined(HAVE_AVAIL_MEM) 913 static long_u allocated = 0; /* allocated since last avail check */ 914 #endif 915 916 /* Safety check for allocating zero bytes */ 917 if (size == 0) 918 { 919 /* Don't hide this message */ 920 emsg_silent = 0; 921 IEMSGN(_("E341: Internal error: lalloc(%ld, )"), size); 922 return NULL; 923 } 924 925 #ifdef MEM_PROFILE 926 mem_pre_alloc_l(&size); 927 #endif 928 929 /* 930 * Loop when out of memory: Try to release some memfile blocks and 931 * if some blocks are released call malloc again. 932 */ 933 for (;;) 934 { 935 /* 936 * Handle three kind of systems: 937 * 1. No check for available memory: Just return. 938 * 2. Slow check for available memory: call mch_avail_mem() after 939 * allocating KEEP_ROOM amount of memory. 940 * 3. Strict check for available memory: call mch_avail_mem() 941 */ 942 if ((p = (char_u *)malloc((size_t)size)) != NULL) 943 { 944 #ifndef HAVE_AVAIL_MEM 945 /* 1. No check for available memory: Just return. */ 946 goto theend; 947 #else 948 /* 2. Slow check for available memory: call mch_avail_mem() after 949 * allocating (KEEP_ROOM / 2) amount of memory. */ 950 allocated += size; 951 if (allocated < KEEP_ROOM / 2) 952 goto theend; 953 allocated = 0; 954 955 /* 3. check for available memory: call mch_avail_mem() */ 956 if (mch_avail_mem(TRUE) < KEEP_ROOM_KB && !releasing) 957 { 958 free((char *)p); /* System is low... no go! */ 959 p = NULL; 960 } 961 else 962 goto theend; 963 #endif 964 } 965 /* 966 * Remember that mf_release_all() is being called to avoid an endless 967 * loop, because mf_release_all() may call alloc() recursively. 968 */ 969 if (releasing) 970 break; 971 releasing = TRUE; 972 973 clear_sb_text(); /* free any scrollback text */ 974 try_again = mf_release_all(); /* release as many blocks as possible */ 975 976 releasing = FALSE; 977 if (!try_again) 978 break; 979 } 980 981 if (message && p == NULL) 982 do_outofmem_msg(size); 983 984 theend: 985 #ifdef MEM_PROFILE 986 mem_post_alloc((void **)&p, (size_t)size); 987 #endif 988 return p; 989 } 990 991 /* 992 * lalloc() with an ID for alloc_fail(). 993 */ 994 char_u * 995 lalloc_id(long_u size, int message, alloc_id_T id UNUSED) 996 { 997 #ifdef FEAT_EVAL 998 if (alloc_fail_id == id && alloc_does_fail(size)) 999 return NULL; 1000 #endif 1001 return (lalloc((long_u)size, message)); 1002 } 1003 1004 #if defined(MEM_PROFILE) || defined(PROTO) 1005 /* 1006 * realloc() with memory profiling. 1007 */ 1008 void * 1009 mem_realloc(void *ptr, size_t size) 1010 { 1011 void *p; 1012 1013 mem_pre_free(&ptr); 1014 mem_pre_alloc_s(&size); 1015 1016 p = realloc(ptr, size); 1017 1018 mem_post_alloc(&p, size); 1019 1020 return p; 1021 } 1022 #endif 1023 1024 /* 1025 * Avoid repeating the error message many times (they take 1 second each). 1026 * Did_outofmem_msg is reset when a character is read. 1027 */ 1028 void 1029 do_outofmem_msg(long_u size) 1030 { 1031 if (!did_outofmem_msg) 1032 { 1033 /* Don't hide this message */ 1034 emsg_silent = 0; 1035 1036 /* Must come first to avoid coming back here when printing the error 1037 * message fails, e.g. when setting v:errmsg. */ 1038 did_outofmem_msg = TRUE; 1039 1040 EMSGN(_("E342: Out of memory! (allocating %lu bytes)"), size); 1041 } 1042 } 1043 1044 #if defined(EXITFREE) || defined(PROTO) 1045 1046 # if defined(FEAT_SEARCHPATH) 1047 static void free_findfile(void); 1048 # endif 1049 1050 /* 1051 * Free everything that we allocated. 1052 * Can be used to detect memory leaks, e.g., with ccmalloc. 1053 * NOTE: This is tricky! Things are freed that functions depend on. Don't be 1054 * surprised if Vim crashes... 1055 * Some things can't be freed, esp. things local to a library function. 1056 */ 1057 void 1058 free_all_mem(void) 1059 { 1060 buf_T *buf, *nextbuf; 1061 1062 /* When we cause a crash here it is caught and Vim tries to exit cleanly. 1063 * Don't try freeing everything again. */ 1064 if (entered_free_all_mem) 1065 return; 1066 entered_free_all_mem = TRUE; 1067 1068 # ifdef FEAT_AUTOCMD 1069 /* Don't want to trigger autocommands from here on. */ 1070 block_autocmds(); 1071 # endif 1072 1073 # ifdef FEAT_WINDOWS 1074 /* Close all tabs and windows. Reset 'equalalways' to avoid redraws. */ 1075 p_ea = FALSE; 1076 if (first_tabpage->tp_next != NULL) 1077 do_cmdline_cmd((char_u *)"tabonly!"); 1078 if (!ONE_WINDOW) 1079 do_cmdline_cmd((char_u *)"only!"); 1080 # endif 1081 1082 # if defined(FEAT_SPELL) 1083 /* Free all spell info. */ 1084 spell_free_all(); 1085 # endif 1086 1087 # if defined(FEAT_USR_CMDS) 1088 /* Clear user commands (before deleting buffers). */ 1089 ex_comclear(NULL); 1090 # endif 1091 1092 # ifdef FEAT_MENU 1093 /* Clear menus. */ 1094 do_cmdline_cmd((char_u *)"aunmenu *"); 1095 # ifdef FEAT_MULTI_LANG 1096 do_cmdline_cmd((char_u *)"menutranslate clear"); 1097 # endif 1098 # endif 1099 1100 /* Clear mappings, abbreviations, breakpoints. */ 1101 do_cmdline_cmd((char_u *)"lmapclear"); 1102 do_cmdline_cmd((char_u *)"xmapclear"); 1103 do_cmdline_cmd((char_u *)"mapclear"); 1104 do_cmdline_cmd((char_u *)"mapclear!"); 1105 do_cmdline_cmd((char_u *)"abclear"); 1106 # if defined(FEAT_EVAL) 1107 do_cmdline_cmd((char_u *)"breakdel *"); 1108 # endif 1109 # if defined(FEAT_PROFILE) 1110 do_cmdline_cmd((char_u *)"profdel *"); 1111 # endif 1112 # if defined(FEAT_KEYMAP) 1113 do_cmdline_cmd((char_u *)"set keymap="); 1114 #endif 1115 1116 # ifdef FEAT_TITLE 1117 free_titles(); 1118 # endif 1119 # if defined(FEAT_SEARCHPATH) 1120 free_findfile(); 1121 # endif 1122 1123 /* Obviously named calls. */ 1124 # if defined(FEAT_AUTOCMD) 1125 free_all_autocmds(); 1126 # endif 1127 clear_termcodes(); 1128 free_all_options(); 1129 free_all_marks(); 1130 alist_clear(&global_alist); 1131 free_homedir(); 1132 # if defined(FEAT_CMDL_COMPL) 1133 free_users(); 1134 # endif 1135 free_search_patterns(); 1136 free_old_sub(); 1137 free_last_insert(); 1138 free_prev_shellcmd(); 1139 free_regexp_stuff(); 1140 free_tag_stuff(); 1141 free_cd_dir(); 1142 # ifdef FEAT_SIGNS 1143 free_signs(); 1144 # endif 1145 # ifdef FEAT_EVAL 1146 set_expr_line(NULL); 1147 # endif 1148 # ifdef FEAT_DIFF 1149 diff_clear(curtab); 1150 # endif 1151 clear_sb_text(); /* free any scrollback text */ 1152 1153 /* Free some global vars. */ 1154 vim_free(username); 1155 # ifdef FEAT_CLIPBOARD 1156 vim_regfree(clip_exclude_prog); 1157 # endif 1158 vim_free(last_cmdline); 1159 # ifdef FEAT_CMDHIST 1160 vim_free(new_last_cmdline); 1161 # endif 1162 set_keep_msg(NULL, 0); 1163 vim_free(ff_expand_buffer); 1164 1165 /* Clear cmdline history. */ 1166 p_hi = 0; 1167 # ifdef FEAT_CMDHIST 1168 init_history(); 1169 # endif 1170 1171 #ifdef FEAT_QUICKFIX 1172 { 1173 win_T *win; 1174 tabpage_T *tab; 1175 1176 qf_free_all(NULL); 1177 /* Free all location lists */ 1178 FOR_ALL_TAB_WINDOWS(tab, win) 1179 qf_free_all(win); 1180 } 1181 #endif 1182 1183 /* Close all script inputs. */ 1184 close_all_scripts(); 1185 1186 #if defined(FEAT_WINDOWS) 1187 /* Destroy all windows. Must come before freeing buffers. */ 1188 win_free_all(); 1189 #endif 1190 1191 /* Free all buffers. Reset 'autochdir' to avoid accessing things that 1192 * were freed already. */ 1193 #ifdef FEAT_AUTOCHDIR 1194 p_acd = FALSE; 1195 #endif 1196 for (buf = firstbuf; buf != NULL; ) 1197 { 1198 bufref_T bufref; 1199 1200 set_bufref(&bufref, buf); 1201 nextbuf = buf->b_next; 1202 close_buffer(NULL, buf, DOBUF_WIPE, FALSE); 1203 if (bufref_valid(&bufref)) 1204 buf = nextbuf; /* didn't work, try next one */ 1205 else 1206 buf = firstbuf; 1207 } 1208 1209 #ifdef FEAT_ARABIC 1210 free_cmdline_buf(); 1211 #endif 1212 1213 /* Clear registers. */ 1214 clear_registers(); 1215 ResetRedobuff(); 1216 ResetRedobuff(); 1217 1218 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11) 1219 vim_free(serverDelayedStartName); 1220 #endif 1221 1222 /* highlight info */ 1223 free_highlight(); 1224 1225 reset_last_sourcing(); 1226 1227 #ifdef FEAT_WINDOWS 1228 free_tabpage(first_tabpage); 1229 first_tabpage = NULL; 1230 #endif 1231 1232 # ifdef UNIX 1233 /* Machine-specific free. */ 1234 mch_free_mem(); 1235 # endif 1236 1237 /* message history */ 1238 for (;;) 1239 if (delete_first_msg() == FAIL) 1240 break; 1241 1242 # ifdef FEAT_JOB_CHANNEL 1243 channel_free_all(); 1244 # endif 1245 #ifdef FEAT_TIMERS 1246 timer_free_all(); 1247 #endif 1248 # ifdef FEAT_EVAL 1249 /* must be after channel_free_all() with unrefs partials */ 1250 eval_clear(); 1251 # endif 1252 # ifdef FEAT_JOB_CHANNEL 1253 /* must be after eval_clear() with unrefs jobs */ 1254 job_free_all(); 1255 # endif 1256 1257 free_termoptions(); 1258 1259 /* screenlines (can't display anything now!) */ 1260 free_screenlines(); 1261 1262 #if defined(USE_XSMP) 1263 xsmp_close(); 1264 #endif 1265 #ifdef FEAT_GUI_GTK 1266 gui_mch_free_all(); 1267 #endif 1268 clear_hl_tables(); 1269 1270 vim_free(IObuff); 1271 vim_free(NameBuff); 1272 } 1273 #endif 1274 1275 /* 1276 * Copy "string" into newly allocated memory. 1277 */ 1278 char_u * 1279 vim_strsave(char_u *string) 1280 { 1281 char_u *p; 1282 unsigned len; 1283 1284 len = (unsigned)STRLEN(string) + 1; 1285 p = alloc(len); 1286 if (p != NULL) 1287 mch_memmove(p, string, (size_t)len); 1288 return p; 1289 } 1290 1291 /* 1292 * Copy up to "len" bytes of "string" into newly allocated memory and 1293 * terminate with a NUL. 1294 * The allocated memory always has size "len + 1", also when "string" is 1295 * shorter. 1296 */ 1297 char_u * 1298 vim_strnsave(char_u *string, int len) 1299 { 1300 char_u *p; 1301 1302 p = alloc((unsigned)(len + 1)); 1303 if (p != NULL) 1304 { 1305 STRNCPY(p, string, len); 1306 p[len] = NUL; 1307 } 1308 return p; 1309 } 1310 1311 /* 1312 * Same as vim_strsave(), but any characters found in esc_chars are preceded 1313 * by a backslash. 1314 */ 1315 char_u * 1316 vim_strsave_escaped(char_u *string, char_u *esc_chars) 1317 { 1318 return vim_strsave_escaped_ext(string, esc_chars, '\\', FALSE); 1319 } 1320 1321 /* 1322 * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape 1323 * characters where rem_backslash() would remove the backslash. 1324 * Escape the characters with "cc". 1325 */ 1326 char_u * 1327 vim_strsave_escaped_ext( 1328 char_u *string, 1329 char_u *esc_chars, 1330 int cc, 1331 int bsl) 1332 { 1333 char_u *p; 1334 char_u *p2; 1335 char_u *escaped_string; 1336 unsigned length; 1337 #ifdef FEAT_MBYTE 1338 int l; 1339 #endif 1340 1341 /* 1342 * First count the number of backslashes required. 1343 * Then allocate the memory and insert them. 1344 */ 1345 length = 1; /* count the trailing NUL */ 1346 for (p = string; *p; p++) 1347 { 1348 #ifdef FEAT_MBYTE 1349 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1) 1350 { 1351 length += l; /* count a multibyte char */ 1352 p += l - 1; 1353 continue; 1354 } 1355 #endif 1356 if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p))) 1357 ++length; /* count a backslash */ 1358 ++length; /* count an ordinary char */ 1359 } 1360 escaped_string = alloc(length); 1361 if (escaped_string != NULL) 1362 { 1363 p2 = escaped_string; 1364 for (p = string; *p; p++) 1365 { 1366 #ifdef FEAT_MBYTE 1367 if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1) 1368 { 1369 mch_memmove(p2, p, (size_t)l); 1370 p2 += l; 1371 p += l - 1; /* skip multibyte char */ 1372 continue; 1373 } 1374 #endif 1375 if (vim_strchr(esc_chars, *p) != NULL || (bsl && rem_backslash(p))) 1376 *p2++ = cc; 1377 *p2++ = *p; 1378 } 1379 *p2 = NUL; 1380 } 1381 return escaped_string; 1382 } 1383 1384 /* 1385 * Return TRUE when 'shell' has "csh" in the tail. 1386 */ 1387 int 1388 csh_like_shell(void) 1389 { 1390 return (strstr((char *)gettail(p_sh), "csh") != NULL); 1391 } 1392 1393 /* 1394 * Escape "string" for use as a shell argument with system(). 1395 * This uses single quotes, except when we know we need to use double quotes 1396 * (MS-DOS and MS-Windows without 'shellslash' set). 1397 * Escape a newline, depending on the 'shell' option. 1398 * When "do_special" is TRUE also replace "!", "%", "#" and things starting 1399 * with "<" like "<cfile>". 1400 * When "do_newline" is FALSE do not escape newline unless it is csh shell. 1401 * Returns the result in allocated memory, NULL if we have run out. 1402 */ 1403 char_u * 1404 vim_strsave_shellescape(char_u *string, int do_special, int do_newline) 1405 { 1406 unsigned length; 1407 char_u *p; 1408 char_u *d; 1409 char_u *escaped_string; 1410 int l; 1411 int csh_like; 1412 1413 /* Only csh and similar shells expand '!' within single quotes. For sh and 1414 * the like we must not put a backslash before it, it will be taken 1415 * literally. If do_special is set the '!' will be escaped twice. 1416 * Csh also needs to have "\n" escaped twice when do_special is set. */ 1417 csh_like = csh_like_shell(); 1418 1419 /* First count the number of extra bytes required. */ 1420 length = (unsigned)STRLEN(string) + 3; /* two quotes and a trailing NUL */ 1421 for (p = string; *p != NUL; mb_ptr_adv(p)) 1422 { 1423 # ifdef WIN32 1424 if (!p_ssl) 1425 { 1426 if (*p == '"') 1427 ++length; /* " -> "" */ 1428 } 1429 else 1430 # endif 1431 if (*p == '\'') 1432 length += 3; /* ' => '\'' */ 1433 if ((*p == '\n' && (csh_like || do_newline)) 1434 || (*p == '!' && (csh_like || do_special))) 1435 { 1436 ++length; /* insert backslash */ 1437 if (csh_like && do_special) 1438 ++length; /* insert backslash */ 1439 } 1440 if (do_special && find_cmdline_var(p, &l) >= 0) 1441 { 1442 ++length; /* insert backslash */ 1443 p += l - 1; 1444 } 1445 } 1446 1447 /* Allocate memory for the result and fill it. */ 1448 escaped_string = alloc(length); 1449 if (escaped_string != NULL) 1450 { 1451 d = escaped_string; 1452 1453 /* add opening quote */ 1454 # ifdef WIN32 1455 if (!p_ssl) 1456 *d++ = '"'; 1457 else 1458 # endif 1459 *d++ = '\''; 1460 1461 for (p = string; *p != NUL; ) 1462 { 1463 # ifdef WIN32 1464 if (!p_ssl) 1465 { 1466 if (*p == '"') 1467 { 1468 *d++ = '"'; 1469 *d++ = '"'; 1470 ++p; 1471 continue; 1472 } 1473 } 1474 else 1475 # endif 1476 if (*p == '\'') 1477 { 1478 *d++ = '\''; 1479 *d++ = '\\'; 1480 *d++ = '\''; 1481 *d++ = '\''; 1482 ++p; 1483 continue; 1484 } 1485 if ((*p == '\n' && (csh_like || do_newline)) 1486 || (*p == '!' && (csh_like || do_special))) 1487 { 1488 *d++ = '\\'; 1489 if (csh_like && do_special) 1490 *d++ = '\\'; 1491 *d++ = *p++; 1492 continue; 1493 } 1494 if (do_special && find_cmdline_var(p, &l) >= 0) 1495 { 1496 *d++ = '\\'; /* insert backslash */ 1497 while (--l >= 0) /* copy the var */ 1498 *d++ = *p++; 1499 continue; 1500 } 1501 1502 MB_COPY_CHAR(p, d); 1503 } 1504 1505 /* add terminating quote and finish with a NUL */ 1506 # ifdef WIN32 1507 if (!p_ssl) 1508 *d++ = '"'; 1509 else 1510 # endif 1511 *d++ = '\''; 1512 *d = NUL; 1513 } 1514 1515 return escaped_string; 1516 } 1517 1518 /* 1519 * Like vim_strsave(), but make all characters uppercase. 1520 * This uses ASCII lower-to-upper case translation, language independent. 1521 */ 1522 char_u * 1523 vim_strsave_up(char_u *string) 1524 { 1525 char_u *p1; 1526 1527 p1 = vim_strsave(string); 1528 vim_strup(p1); 1529 return p1; 1530 } 1531 1532 /* 1533 * Like vim_strnsave(), but make all characters uppercase. 1534 * This uses ASCII lower-to-upper case translation, language independent. 1535 */ 1536 char_u * 1537 vim_strnsave_up(char_u *string, int len) 1538 { 1539 char_u *p1; 1540 1541 p1 = vim_strnsave(string, len); 1542 vim_strup(p1); 1543 return p1; 1544 } 1545 1546 /* 1547 * ASCII lower-to-upper case translation, language independent. 1548 */ 1549 void 1550 vim_strup( 1551 char_u *p) 1552 { 1553 char_u *p2; 1554 int c; 1555 1556 if (p != NULL) 1557 { 1558 p2 = p; 1559 while ((c = *p2) != NUL) 1560 #ifdef EBCDIC 1561 *p2++ = isalpha(c) ? toupper(c) : c; 1562 #else 1563 *p2++ = (c < 'a' || c > 'z') ? c : (c - 0x20); 1564 #endif 1565 } 1566 } 1567 1568 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO) 1569 /* 1570 * Make string "s" all upper-case and return it in allocated memory. 1571 * Handles multi-byte characters as well as possible. 1572 * Returns NULL when out of memory. 1573 */ 1574 char_u * 1575 strup_save(char_u *orig) 1576 { 1577 char_u *p; 1578 char_u *res; 1579 1580 res = p = vim_strsave(orig); 1581 1582 if (res != NULL) 1583 while (*p != NUL) 1584 { 1585 # ifdef FEAT_MBYTE 1586 int l; 1587 1588 if (enc_utf8) 1589 { 1590 int c, uc; 1591 int newl; 1592 char_u *s; 1593 1594 c = utf_ptr2char(p); 1595 uc = utf_toupper(c); 1596 1597 /* Reallocate string when byte count changes. This is rare, 1598 * thus it's OK to do another malloc()/free(). */ 1599 l = utf_ptr2len(p); 1600 newl = utf_char2len(uc); 1601 if (newl != l) 1602 { 1603 s = alloc((unsigned)STRLEN(res) + 1 + newl - l); 1604 if (s == NULL) 1605 break; 1606 mch_memmove(s, res, p - res); 1607 STRCPY(s + (p - res) + newl, p + l); 1608 p = s + (p - res); 1609 vim_free(res); 1610 res = s; 1611 } 1612 1613 utf_char2bytes(uc, p); 1614 p += newl; 1615 } 1616 else if (has_mbyte && (l = (*mb_ptr2len)(p)) > 1) 1617 p += l; /* skip multi-byte character */ 1618 else 1619 # endif 1620 { 1621 *p = TOUPPER_LOC(*p); /* note that toupper() can be a macro */ 1622 p++; 1623 } 1624 } 1625 1626 return res; 1627 } 1628 #endif 1629 1630 /* 1631 * delete spaces at the end of a string 1632 */ 1633 void 1634 del_trailing_spaces(char_u *ptr) 1635 { 1636 char_u *q; 1637 1638 q = ptr + STRLEN(ptr); 1639 while (--q > ptr && vim_iswhite(q[0]) && q[-1] != '\\' && q[-1] != Ctrl_V) 1640 *q = NUL; 1641 } 1642 1643 /* 1644 * Like strncpy(), but always terminate the result with one NUL. 1645 * "to" must be "len + 1" long! 1646 */ 1647 void 1648 vim_strncpy(char_u *to, char_u *from, size_t len) 1649 { 1650 STRNCPY(to, from, len); 1651 to[len] = NUL; 1652 } 1653 1654 /* 1655 * Like strcat(), but make sure the result fits in "tosize" bytes and is 1656 * always NUL terminated. 1657 */ 1658 void 1659 vim_strcat(char_u *to, char_u *from, size_t tosize) 1660 { 1661 size_t tolen = STRLEN(to); 1662 size_t fromlen = STRLEN(from); 1663 1664 if (tolen + fromlen + 1 > tosize) 1665 { 1666 mch_memmove(to + tolen, from, tosize - tolen - 1); 1667 to[tosize - 1] = NUL; 1668 } 1669 else 1670 STRCPY(to + tolen, from); 1671 } 1672 1673 /* 1674 * Isolate one part of a string option where parts are separated with 1675 * "sep_chars". 1676 * The part is copied into "buf[maxlen]". 1677 * "*option" is advanced to the next part. 1678 * The length is returned. 1679 */ 1680 int 1681 copy_option_part( 1682 char_u **option, 1683 char_u *buf, 1684 int maxlen, 1685 char *sep_chars) 1686 { 1687 int len = 0; 1688 char_u *p = *option; 1689 1690 /* skip '.' at start of option part, for 'suffixes' */ 1691 if (*p == '.') 1692 buf[len++] = *p++; 1693 while (*p != NUL && vim_strchr((char_u *)sep_chars, *p) == NULL) 1694 { 1695 /* 1696 * Skip backslash before a separator character and space. 1697 */ 1698 if (p[0] == '\\' && vim_strchr((char_u *)sep_chars, p[1]) != NULL) 1699 ++p; 1700 if (len < maxlen - 1) 1701 buf[len++] = *p; 1702 ++p; 1703 } 1704 buf[len] = NUL; 1705 1706 if (*p != NUL && *p != ',') /* skip non-standard separator */ 1707 ++p; 1708 p = skip_to_option_part(p); /* p points to next file name */ 1709 1710 *option = p; 1711 return len; 1712 } 1713 1714 /* 1715 * Replacement for free() that ignores NULL pointers. 1716 * Also skip free() when exiting for sure, this helps when we caught a deadly 1717 * signal that was caused by a crash in free(). 1718 */ 1719 void 1720 vim_free(void *x) 1721 { 1722 if (x != NULL && !really_exiting) 1723 { 1724 #ifdef MEM_PROFILE 1725 mem_pre_free(&x); 1726 #endif 1727 free(x); 1728 } 1729 } 1730 1731 #ifndef HAVE_MEMSET 1732 void * 1733 vim_memset(void *ptr, int c, size_t size) 1734 { 1735 char *p = ptr; 1736 1737 while (size-- > 0) 1738 *p++ = c; 1739 return ptr; 1740 } 1741 #endif 1742 1743 /* skipped when generating prototypes, the prototype is in vim.h */ 1744 #ifdef VIM_MEMMOVE 1745 /* 1746 * Version of memmove() that handles overlapping source and destination. 1747 * For systems that don't have a function that is guaranteed to do that (SYSV). 1748 */ 1749 void 1750 mch_memmove(void *src_arg, void *dst_arg, size_t len) 1751 { 1752 /* 1753 * A void doesn't have a size, we use char pointers. 1754 */ 1755 char *dst = dst_arg, *src = src_arg; 1756 1757 /* overlap, copy backwards */ 1758 if (dst > src && dst < src + len) 1759 { 1760 src += len; 1761 dst += len; 1762 while (len-- > 0) 1763 *--dst = *--src; 1764 } 1765 else /* copy forwards */ 1766 while (len-- > 0) 1767 *dst++ = *src++; 1768 } 1769 #endif 1770 1771 #if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO) 1772 /* 1773 * Compare two strings, ignoring case, using current locale. 1774 * Doesn't work for multi-byte characters. 1775 * return 0 for match, < 0 for smaller, > 0 for bigger 1776 */ 1777 int 1778 vim_stricmp(char *s1, char *s2) 1779 { 1780 int i; 1781 1782 for (;;) 1783 { 1784 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2); 1785 if (i != 0) 1786 return i; /* this character different */ 1787 if (*s1 == NUL) 1788 break; /* strings match until NUL */ 1789 ++s1; 1790 ++s2; 1791 } 1792 return 0; /* strings match */ 1793 } 1794 #endif 1795 1796 #if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO) 1797 /* 1798 * Compare two strings, for length "len", ignoring case, using current locale. 1799 * Doesn't work for multi-byte characters. 1800 * return 0 for match, < 0 for smaller, > 0 for bigger 1801 */ 1802 int 1803 vim_strnicmp(char *s1, char *s2, size_t len) 1804 { 1805 int i; 1806 1807 while (len > 0) 1808 { 1809 i = (int)TOLOWER_LOC(*s1) - (int)TOLOWER_LOC(*s2); 1810 if (i != 0) 1811 return i; /* this character different */ 1812 if (*s1 == NUL) 1813 break; /* strings match until NUL */ 1814 ++s1; 1815 ++s2; 1816 --len; 1817 } 1818 return 0; /* strings match */ 1819 } 1820 #endif 1821 1822 /* 1823 * Version of strchr() and strrchr() that handle unsigned char strings 1824 * with characters from 128 to 255 correctly. It also doesn't return a 1825 * pointer to the NUL at the end of the string. 1826 */ 1827 char_u * 1828 vim_strchr(char_u *string, int c) 1829 { 1830 char_u *p; 1831 int b; 1832 1833 p = string; 1834 #ifdef FEAT_MBYTE 1835 if (enc_utf8 && c >= 0x80) 1836 { 1837 while (*p != NUL) 1838 { 1839 int l = (*mb_ptr2len)(p); 1840 1841 /* Avoid matching an illegal byte here. */ 1842 if (utf_ptr2char(p) == c && l > 1) 1843 return p; 1844 p += l; 1845 } 1846 return NULL; 1847 } 1848 if (enc_dbcs != 0 && c > 255) 1849 { 1850 int n2 = c & 0xff; 1851 1852 c = ((unsigned)c >> 8) & 0xff; 1853 while ((b = *p) != NUL) 1854 { 1855 if (b == c && p[1] == n2) 1856 return p; 1857 p += (*mb_ptr2len)(p); 1858 } 1859 return NULL; 1860 } 1861 if (has_mbyte) 1862 { 1863 while ((b = *p) != NUL) 1864 { 1865 if (b == c) 1866 return p; 1867 p += (*mb_ptr2len)(p); 1868 } 1869 return NULL; 1870 } 1871 #endif 1872 while ((b = *p) != NUL) 1873 { 1874 if (b == c) 1875 return p; 1876 ++p; 1877 } 1878 return NULL; 1879 } 1880 1881 /* 1882 * Version of strchr() that only works for bytes and handles unsigned char 1883 * strings with characters above 128 correctly. It also doesn't return a 1884 * pointer to the NUL at the end of the string. 1885 */ 1886 char_u * 1887 vim_strbyte(char_u *string, int c) 1888 { 1889 char_u *p = string; 1890 1891 while (*p != NUL) 1892 { 1893 if (*p == c) 1894 return p; 1895 ++p; 1896 } 1897 return NULL; 1898 } 1899 1900 /* 1901 * Search for last occurrence of "c" in "string". 1902 * Return NULL if not found. 1903 * Does not handle multi-byte char for "c"! 1904 */ 1905 char_u * 1906 vim_strrchr(char_u *string, int c) 1907 { 1908 char_u *retval = NULL; 1909 char_u *p = string; 1910 1911 while (*p) 1912 { 1913 if (*p == c) 1914 retval = p; 1915 mb_ptr_adv(p); 1916 } 1917 return retval; 1918 } 1919 1920 /* 1921 * Vim's version of strpbrk(), in case it's missing. 1922 * Don't generate a prototype for this, causes problems when it's not used. 1923 */ 1924 #ifndef PROTO 1925 # ifndef HAVE_STRPBRK 1926 # ifdef vim_strpbrk 1927 # undef vim_strpbrk 1928 # endif 1929 char_u * 1930 vim_strpbrk(char_u *s, char_u *charset) 1931 { 1932 while (*s) 1933 { 1934 if (vim_strchr(charset, *s) != NULL) 1935 return s; 1936 mb_ptr_adv(s); 1937 } 1938 return NULL; 1939 } 1940 # endif 1941 #endif 1942 1943 /* 1944 * Vim has its own isspace() function, because on some machines isspace() 1945 * can't handle characters above 128. 1946 */ 1947 int 1948 vim_isspace(int x) 1949 { 1950 return ((x >= 9 && x <= 13) || x == ' '); 1951 } 1952 1953 /************************************************************************ 1954 * Functions for handling growing arrays. 1955 */ 1956 1957 /* 1958 * Clear an allocated growing array. 1959 */ 1960 void 1961 ga_clear(garray_T *gap) 1962 { 1963 vim_free(gap->ga_data); 1964 ga_init(gap); 1965 } 1966 1967 /* 1968 * Clear a growing array that contains a list of strings. 1969 */ 1970 void 1971 ga_clear_strings(garray_T *gap) 1972 { 1973 int i; 1974 1975 for (i = 0; i < gap->ga_len; ++i) 1976 vim_free(((char_u **)(gap->ga_data))[i]); 1977 ga_clear(gap); 1978 } 1979 1980 /* 1981 * Initialize a growing array. Don't forget to set ga_itemsize and 1982 * ga_growsize! Or use ga_init2(). 1983 */ 1984 void 1985 ga_init(garray_T *gap) 1986 { 1987 gap->ga_data = NULL; 1988 gap->ga_maxlen = 0; 1989 gap->ga_len = 0; 1990 } 1991 1992 void 1993 ga_init2(garray_T *gap, int itemsize, int growsize) 1994 { 1995 ga_init(gap); 1996 gap->ga_itemsize = itemsize; 1997 gap->ga_growsize = growsize; 1998 } 1999 2000 /* 2001 * Make room in growing array "gap" for at least "n" items. 2002 * Return FAIL for failure, OK otherwise. 2003 */ 2004 int 2005 ga_grow(garray_T *gap, int n) 2006 { 2007 size_t old_len; 2008 size_t new_len; 2009 char_u *pp; 2010 2011 if (gap->ga_maxlen - gap->ga_len < n) 2012 { 2013 if (n < gap->ga_growsize) 2014 n = gap->ga_growsize; 2015 new_len = gap->ga_itemsize * (gap->ga_len + n); 2016 pp = (gap->ga_data == NULL) 2017 ? alloc((unsigned)new_len) : vim_realloc(gap->ga_data, new_len); 2018 if (pp == NULL) 2019 return FAIL; 2020 old_len = gap->ga_itemsize * gap->ga_maxlen; 2021 vim_memset(pp + old_len, 0, new_len - old_len); 2022 gap->ga_maxlen = gap->ga_len + n; 2023 gap->ga_data = pp; 2024 } 2025 return OK; 2026 } 2027 2028 /* 2029 * For a growing array that contains a list of strings: concatenate all the 2030 * strings with a separating "sep". 2031 * Returns NULL when out of memory. 2032 */ 2033 char_u * 2034 ga_concat_strings(garray_T *gap, char *sep) 2035 { 2036 int i; 2037 int len = 0; 2038 int sep_len = (int)STRLEN(sep); 2039 char_u *s; 2040 char_u *p; 2041 2042 for (i = 0; i < gap->ga_len; ++i) 2043 len += (int)STRLEN(((char_u **)(gap->ga_data))[i]) + sep_len; 2044 2045 s = alloc(len + 1); 2046 if (s != NULL) 2047 { 2048 *s = NUL; 2049 p = s; 2050 for (i = 0; i < gap->ga_len; ++i) 2051 { 2052 if (p != s) 2053 { 2054 STRCPY(p, sep); 2055 p += sep_len; 2056 } 2057 STRCPY(p, ((char_u **)(gap->ga_data))[i]); 2058 p += STRLEN(p); 2059 } 2060 } 2061 return s; 2062 } 2063 2064 #if defined(FEAT_VIMINFO) || defined(PROTO) 2065 /* 2066 * Make a copy of string "p" and add it to "gap". 2067 * When out of memory nothing changes. 2068 */ 2069 void 2070 ga_add_string(garray_T *gap, char_u *p) 2071 { 2072 char_u *cp = vim_strsave(p); 2073 2074 if (cp != NULL) 2075 { 2076 if (ga_grow(gap, 1) == OK) 2077 ((char_u **)(gap->ga_data))[gap->ga_len++] = cp; 2078 else 2079 vim_free(cp); 2080 } 2081 } 2082 #endif 2083 2084 /* 2085 * Concatenate a string to a growarray which contains characters. 2086 * When "s" is NULL does not do anything. 2087 * Note: Does NOT copy the NUL at the end! 2088 */ 2089 void 2090 ga_concat(garray_T *gap, char_u *s) 2091 { 2092 int len; 2093 2094 if (s == NULL) 2095 return; 2096 len = (int)STRLEN(s); 2097 if (ga_grow(gap, len) == OK) 2098 { 2099 mch_memmove((char *)gap->ga_data + gap->ga_len, s, (size_t)len); 2100 gap->ga_len += len; 2101 } 2102 } 2103 2104 /* 2105 * Append one byte to a growarray which contains bytes. 2106 */ 2107 void 2108 ga_append(garray_T *gap, int c) 2109 { 2110 if (ga_grow(gap, 1) == OK) 2111 { 2112 *((char *)gap->ga_data + gap->ga_len) = c; 2113 ++gap->ga_len; 2114 } 2115 } 2116 2117 #if (defined(UNIX) && !defined(USE_SYSTEM)) || defined(WIN3264) \ 2118 || defined(PROTO) 2119 /* 2120 * Append the text in "gap" below the cursor line and clear "gap". 2121 */ 2122 void 2123 append_ga_line(garray_T *gap) 2124 { 2125 /* Remove trailing CR. */ 2126 if (gap->ga_len > 0 2127 && !curbuf->b_p_bin 2128 && ((char_u *)gap->ga_data)[gap->ga_len - 1] == CAR) 2129 --gap->ga_len; 2130 ga_append(gap, NUL); 2131 ml_append(curwin->w_cursor.lnum++, gap->ga_data, 0, FALSE); 2132 gap->ga_len = 0; 2133 } 2134 #endif 2135 2136 /************************************************************************ 2137 * functions that use lookup tables for various things, generally to do with 2138 * special key codes. 2139 */ 2140 2141 /* 2142 * Some useful tables. 2143 */ 2144 2145 static struct modmasktable 2146 { 2147 short mod_mask; /* Bit-mask for particular key modifier */ 2148 short mod_flag; /* Bit(s) for particular key modifier */ 2149 char_u name; /* Single letter name of modifier */ 2150 } mod_mask_table[] = 2151 { 2152 {MOD_MASK_ALT, MOD_MASK_ALT, (char_u)'M'}, 2153 {MOD_MASK_META, MOD_MASK_META, (char_u)'T'}, 2154 {MOD_MASK_CTRL, MOD_MASK_CTRL, (char_u)'C'}, 2155 {MOD_MASK_SHIFT, MOD_MASK_SHIFT, (char_u)'S'}, 2156 {MOD_MASK_MULTI_CLICK, MOD_MASK_2CLICK, (char_u)'2'}, 2157 {MOD_MASK_MULTI_CLICK, MOD_MASK_3CLICK, (char_u)'3'}, 2158 {MOD_MASK_MULTI_CLICK, MOD_MASK_4CLICK, (char_u)'4'}, 2159 #ifdef MACOS 2160 {MOD_MASK_CMD, MOD_MASK_CMD, (char_u)'D'}, 2161 #endif 2162 /* 'A' must be the last one */ 2163 {MOD_MASK_ALT, MOD_MASK_ALT, (char_u)'A'}, 2164 {0, 0, NUL} 2165 }; 2166 2167 /* 2168 * Shifted key terminal codes and their unshifted equivalent. 2169 * Don't add mouse codes here, they are handled separately! 2170 */ 2171 #define MOD_KEYS_ENTRY_SIZE 5 2172 2173 static char_u modifier_keys_table[] = 2174 { 2175 /* mod mask with modifier without modifier */ 2176 MOD_MASK_SHIFT, '&', '9', '@', '1', /* begin */ 2177 MOD_MASK_SHIFT, '&', '0', '@', '2', /* cancel */ 2178 MOD_MASK_SHIFT, '*', '1', '@', '4', /* command */ 2179 MOD_MASK_SHIFT, '*', '2', '@', '5', /* copy */ 2180 MOD_MASK_SHIFT, '*', '3', '@', '6', /* create */ 2181 MOD_MASK_SHIFT, '*', '4', 'k', 'D', /* delete char */ 2182 MOD_MASK_SHIFT, '*', '5', 'k', 'L', /* delete line */ 2183 MOD_MASK_SHIFT, '*', '7', '@', '7', /* end */ 2184 MOD_MASK_CTRL, KS_EXTRA, (int)KE_C_END, '@', '7', /* end */ 2185 MOD_MASK_SHIFT, '*', '9', '@', '9', /* exit */ 2186 MOD_MASK_SHIFT, '*', '0', '@', '0', /* find */ 2187 MOD_MASK_SHIFT, '#', '1', '%', '1', /* help */ 2188 MOD_MASK_SHIFT, '#', '2', 'k', 'h', /* home */ 2189 MOD_MASK_CTRL, KS_EXTRA, (int)KE_C_HOME, 'k', 'h', /* home */ 2190 MOD_MASK_SHIFT, '#', '3', 'k', 'I', /* insert */ 2191 MOD_MASK_SHIFT, '#', '4', 'k', 'l', /* left arrow */ 2192 MOD_MASK_CTRL, KS_EXTRA, (int)KE_C_LEFT, 'k', 'l', /* left arrow */ 2193 MOD_MASK_SHIFT, '%', 'a', '%', '3', /* message */ 2194 MOD_MASK_SHIFT, '%', 'b', '%', '4', /* move */ 2195 MOD_MASK_SHIFT, '%', 'c', '%', '5', /* next */ 2196 MOD_MASK_SHIFT, '%', 'd', '%', '7', /* options */ 2197 MOD_MASK_SHIFT, '%', 'e', '%', '8', /* previous */ 2198 MOD_MASK_SHIFT, '%', 'f', '%', '9', /* print */ 2199 MOD_MASK_SHIFT, '%', 'g', '%', '0', /* redo */ 2200 MOD_MASK_SHIFT, '%', 'h', '&', '3', /* replace */ 2201 MOD_MASK_SHIFT, '%', 'i', 'k', 'r', /* right arr. */ 2202 MOD_MASK_CTRL, KS_EXTRA, (int)KE_C_RIGHT, 'k', 'r', /* right arr. */ 2203 MOD_MASK_SHIFT, '%', 'j', '&', '5', /* resume */ 2204 MOD_MASK_SHIFT, '!', '1', '&', '6', /* save */ 2205 MOD_MASK_SHIFT, '!', '2', '&', '7', /* suspend */ 2206 MOD_MASK_SHIFT, '!', '3', '&', '8', /* undo */ 2207 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_UP, 'k', 'u', /* up arrow */ 2208 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_DOWN, 'k', 'd', /* down arrow */ 2209 2210 /* vt100 F1 */ 2211 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF1, KS_EXTRA, (int)KE_XF1, 2212 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF2, KS_EXTRA, (int)KE_XF2, 2213 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF3, KS_EXTRA, (int)KE_XF3, 2214 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_XF4, KS_EXTRA, (int)KE_XF4, 2215 2216 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F1, 'k', '1', /* F1 */ 2217 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F2, 'k', '2', 2218 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F3, 'k', '3', 2219 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F4, 'k', '4', 2220 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F5, 'k', '5', 2221 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F6, 'k', '6', 2222 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F7, 'k', '7', 2223 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F8, 'k', '8', 2224 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F9, 'k', '9', 2225 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F10, 'k', ';', /* F10 */ 2226 2227 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F11, 'F', '1', 2228 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F12, 'F', '2', 2229 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F13, 'F', '3', 2230 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F14, 'F', '4', 2231 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F15, 'F', '5', 2232 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F16, 'F', '6', 2233 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F17, 'F', '7', 2234 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F18, 'F', '8', 2235 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F19, 'F', '9', 2236 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F20, 'F', 'A', 2237 2238 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F21, 'F', 'B', 2239 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F22, 'F', 'C', 2240 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F23, 'F', 'D', 2241 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F24, 'F', 'E', 2242 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F25, 'F', 'F', 2243 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F26, 'F', 'G', 2244 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F27, 'F', 'H', 2245 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F28, 'F', 'I', 2246 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F29, 'F', 'J', 2247 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F30, 'F', 'K', 2248 2249 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F31, 'F', 'L', 2250 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F32, 'F', 'M', 2251 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F33, 'F', 'N', 2252 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F34, 'F', 'O', 2253 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F35, 'F', 'P', 2254 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F36, 'F', 'Q', 2255 MOD_MASK_SHIFT, KS_EXTRA, (int)KE_S_F37, 'F', 'R', 2256 2257 /* TAB pseudo code*/ 2258 MOD_MASK_SHIFT, 'k', 'B', KS_EXTRA, (int)KE_TAB, 2259 2260 NUL 2261 }; 2262 2263 static struct key_name_entry 2264 { 2265 int key; /* Special key code or ascii value */ 2266 char_u *name; /* Name of key */ 2267 } key_names_table[] = 2268 { 2269 {' ', (char_u *)"Space"}, 2270 {TAB, (char_u *)"Tab"}, 2271 {K_TAB, (char_u *)"Tab"}, 2272 {NL, (char_u *)"NL"}, 2273 {NL, (char_u *)"NewLine"}, /* Alternative name */ 2274 {NL, (char_u *)"LineFeed"}, /* Alternative name */ 2275 {NL, (char_u *)"LF"}, /* Alternative name */ 2276 {CAR, (char_u *)"CR"}, 2277 {CAR, (char_u *)"Return"}, /* Alternative name */ 2278 {CAR, (char_u *)"Enter"}, /* Alternative name */ 2279 {K_BS, (char_u *)"BS"}, 2280 {K_BS, (char_u *)"BackSpace"}, /* Alternative name */ 2281 {ESC, (char_u *)"Esc"}, 2282 {CSI, (char_u *)"CSI"}, 2283 {K_CSI, (char_u *)"xCSI"}, 2284 {'|', (char_u *)"Bar"}, 2285 {'\\', (char_u *)"Bslash"}, 2286 {K_DEL, (char_u *)"Del"}, 2287 {K_DEL, (char_u *)"Delete"}, /* Alternative name */ 2288 {K_KDEL, (char_u *)"kDel"}, 2289 {K_UP, (char_u *)"Up"}, 2290 {K_DOWN, (char_u *)"Down"}, 2291 {K_LEFT, (char_u *)"Left"}, 2292 {K_RIGHT, (char_u *)"Right"}, 2293 {K_XUP, (char_u *)"xUp"}, 2294 {K_XDOWN, (char_u *)"xDown"}, 2295 {K_XLEFT, (char_u *)"xLeft"}, 2296 {K_XRIGHT, (char_u *)"xRight"}, 2297 2298 {K_F1, (char_u *)"F1"}, 2299 {K_F2, (char_u *)"F2"}, 2300 {K_F3, (char_u *)"F3"}, 2301 {K_F4, (char_u *)"F4"}, 2302 {K_F5, (char_u *)"F5"}, 2303 {K_F6, (char_u *)"F6"}, 2304 {K_F7, (char_u *)"F7"}, 2305 {K_F8, (char_u *)"F8"}, 2306 {K_F9, (char_u *)"F9"}, 2307 {K_F10, (char_u *)"F10"}, 2308 2309 {K_F11, (char_u *)"F11"}, 2310 {K_F12, (char_u *)"F12"}, 2311 {K_F13, (char_u *)"F13"}, 2312 {K_F14, (char_u *)"F14"}, 2313 {K_F15, (char_u *)"F15"}, 2314 {K_F16, (char_u *)"F16"}, 2315 {K_F17, (char_u *)"F17"}, 2316 {K_F18, (char_u *)"F18"}, 2317 {K_F19, (char_u *)"F19"}, 2318 {K_F20, (char_u *)"F20"}, 2319 2320 {K_F21, (char_u *)"F21"}, 2321 {K_F22, (char_u *)"F22"}, 2322 {K_F23, (char_u *)"F23"}, 2323 {K_F24, (char_u *)"F24"}, 2324 {K_F25, (char_u *)"F25"}, 2325 {K_F26, (char_u *)"F26"}, 2326 {K_F27, (char_u *)"F27"}, 2327 {K_F28, (char_u *)"F28"}, 2328 {K_F29, (char_u *)"F29"}, 2329 {K_F30, (char_u *)"F30"}, 2330 2331 {K_F31, (char_u *)"F31"}, 2332 {K_F32, (char_u *)"F32"}, 2333 {K_F33, (char_u *)"F33"}, 2334 {K_F34, (char_u *)"F34"}, 2335 {K_F35, (char_u *)"F35"}, 2336 {K_F36, (char_u *)"F36"}, 2337 {K_F37, (char_u *)"F37"}, 2338 2339 {K_XF1, (char_u *)"xF1"}, 2340 {K_XF2, (char_u *)"xF2"}, 2341 {K_XF3, (char_u *)"xF3"}, 2342 {K_XF4, (char_u *)"xF4"}, 2343 2344 {K_HELP, (char_u *)"Help"}, 2345 {K_UNDO, (char_u *)"Undo"}, 2346 {K_INS, (char_u *)"Insert"}, 2347 {K_INS, (char_u *)"Ins"}, /* Alternative name */ 2348 {K_KINS, (char_u *)"kInsert"}, 2349 {K_HOME, (char_u *)"Home"}, 2350 {K_KHOME, (char_u *)"kHome"}, 2351 {K_XHOME, (char_u *)"xHome"}, 2352 {K_ZHOME, (char_u *)"zHome"}, 2353 {K_END, (char_u *)"End"}, 2354 {K_KEND, (char_u *)"kEnd"}, 2355 {K_XEND, (char_u *)"xEnd"}, 2356 {K_ZEND, (char_u *)"zEnd"}, 2357 {K_PAGEUP, (char_u *)"PageUp"}, 2358 {K_PAGEDOWN, (char_u *)"PageDown"}, 2359 {K_KPAGEUP, (char_u *)"kPageUp"}, 2360 {K_KPAGEDOWN, (char_u *)"kPageDown"}, 2361 2362 {K_KPLUS, (char_u *)"kPlus"}, 2363 {K_KMINUS, (char_u *)"kMinus"}, 2364 {K_KDIVIDE, (char_u *)"kDivide"}, 2365 {K_KMULTIPLY, (char_u *)"kMultiply"}, 2366 {K_KENTER, (char_u *)"kEnter"}, 2367 {K_KPOINT, (char_u *)"kPoint"}, 2368 2369 {K_K0, (char_u *)"k0"}, 2370 {K_K1, (char_u *)"k1"}, 2371 {K_K2, (char_u *)"k2"}, 2372 {K_K3, (char_u *)"k3"}, 2373 {K_K4, (char_u *)"k4"}, 2374 {K_K5, (char_u *)"k5"}, 2375 {K_K6, (char_u *)"k6"}, 2376 {K_K7, (char_u *)"k7"}, 2377 {K_K8, (char_u *)"k8"}, 2378 {K_K9, (char_u *)"k9"}, 2379 2380 {'<', (char_u *)"lt"}, 2381 2382 {K_MOUSE, (char_u *)"Mouse"}, 2383 #ifdef FEAT_MOUSE_NET 2384 {K_NETTERM_MOUSE, (char_u *)"NetMouse"}, 2385 #endif 2386 #ifdef FEAT_MOUSE_DEC 2387 {K_DEC_MOUSE, (char_u *)"DecMouse"}, 2388 #endif 2389 #ifdef FEAT_MOUSE_JSB 2390 {K_JSBTERM_MOUSE, (char_u *)"JsbMouse"}, 2391 #endif 2392 #ifdef FEAT_MOUSE_PTERM 2393 {K_PTERM_MOUSE, (char_u *)"PtermMouse"}, 2394 #endif 2395 #ifdef FEAT_MOUSE_URXVT 2396 {K_URXVT_MOUSE, (char_u *)"UrxvtMouse"}, 2397 #endif 2398 #ifdef FEAT_MOUSE_SGR 2399 {K_SGR_MOUSE, (char_u *)"SgrMouse"}, 2400 #endif 2401 {K_LEFTMOUSE, (char_u *)"LeftMouse"}, 2402 {K_LEFTMOUSE_NM, (char_u *)"LeftMouseNM"}, 2403 {K_LEFTDRAG, (char_u *)"LeftDrag"}, 2404 {K_LEFTRELEASE, (char_u *)"LeftRelease"}, 2405 {K_LEFTRELEASE_NM, (char_u *)"LeftReleaseNM"}, 2406 {K_MIDDLEMOUSE, (char_u *)"MiddleMouse"}, 2407 {K_MIDDLEDRAG, (char_u *)"MiddleDrag"}, 2408 {K_MIDDLERELEASE, (char_u *)"MiddleRelease"}, 2409 {K_RIGHTMOUSE, (char_u *)"RightMouse"}, 2410 {K_RIGHTDRAG, (char_u *)"RightDrag"}, 2411 {K_RIGHTRELEASE, (char_u *)"RightRelease"}, 2412 {K_MOUSEDOWN, (char_u *)"ScrollWheelUp"}, 2413 {K_MOUSEUP, (char_u *)"ScrollWheelDown"}, 2414 {K_MOUSELEFT, (char_u *)"ScrollWheelRight"}, 2415 {K_MOUSERIGHT, (char_u *)"ScrollWheelLeft"}, 2416 {K_MOUSEDOWN, (char_u *)"MouseDown"}, /* OBSOLETE: Use */ 2417 {K_MOUSEUP, (char_u *)"MouseUp"}, /* ScrollWheelXXX instead */ 2418 {K_X1MOUSE, (char_u *)"X1Mouse"}, 2419 {K_X1DRAG, (char_u *)"X1Drag"}, 2420 {K_X1RELEASE, (char_u *)"X1Release"}, 2421 {K_X2MOUSE, (char_u *)"X2Mouse"}, 2422 {K_X2DRAG, (char_u *)"X2Drag"}, 2423 {K_X2RELEASE, (char_u *)"X2Release"}, 2424 {K_DROP, (char_u *)"Drop"}, 2425 {K_ZERO, (char_u *)"Nul"}, 2426 #ifdef FEAT_EVAL 2427 {K_SNR, (char_u *)"SNR"}, 2428 #endif 2429 {K_PLUG, (char_u *)"Plug"}, 2430 {K_CURSORHOLD, (char_u *)"CursorHold"}, 2431 {0, NULL} 2432 }; 2433 2434 #define KEY_NAMES_TABLE_LEN (sizeof(key_names_table) / sizeof(struct key_name_entry)) 2435 2436 #ifdef FEAT_MOUSE 2437 static struct mousetable 2438 { 2439 int pseudo_code; /* Code for pseudo mouse event */ 2440 int button; /* Which mouse button is it? */ 2441 int is_click; /* Is it a mouse button click event? */ 2442 int is_drag; /* Is it a mouse drag event? */ 2443 } mouse_table[] = 2444 { 2445 {(int)KE_LEFTMOUSE, MOUSE_LEFT, TRUE, FALSE}, 2446 #ifdef FEAT_GUI 2447 {(int)KE_LEFTMOUSE_NM, MOUSE_LEFT, TRUE, FALSE}, 2448 #endif 2449 {(int)KE_LEFTDRAG, MOUSE_LEFT, FALSE, TRUE}, 2450 {(int)KE_LEFTRELEASE, MOUSE_LEFT, FALSE, FALSE}, 2451 #ifdef FEAT_GUI 2452 {(int)KE_LEFTRELEASE_NM, MOUSE_LEFT, FALSE, FALSE}, 2453 #endif 2454 {(int)KE_MIDDLEMOUSE, MOUSE_MIDDLE, TRUE, FALSE}, 2455 {(int)KE_MIDDLEDRAG, MOUSE_MIDDLE, FALSE, TRUE}, 2456 {(int)KE_MIDDLERELEASE, MOUSE_MIDDLE, FALSE, FALSE}, 2457 {(int)KE_RIGHTMOUSE, MOUSE_RIGHT, TRUE, FALSE}, 2458 {(int)KE_RIGHTDRAG, MOUSE_RIGHT, FALSE, TRUE}, 2459 {(int)KE_RIGHTRELEASE, MOUSE_RIGHT, FALSE, FALSE}, 2460 {(int)KE_X1MOUSE, MOUSE_X1, TRUE, FALSE}, 2461 {(int)KE_X1DRAG, MOUSE_X1, FALSE, TRUE}, 2462 {(int)KE_X1RELEASE, MOUSE_X1, FALSE, FALSE}, 2463 {(int)KE_X2MOUSE, MOUSE_X2, TRUE, FALSE}, 2464 {(int)KE_X2DRAG, MOUSE_X2, FALSE, TRUE}, 2465 {(int)KE_X2RELEASE, MOUSE_X2, FALSE, FALSE}, 2466 /* DRAG without CLICK */ 2467 {(int)KE_IGNORE, MOUSE_RELEASE, FALSE, TRUE}, 2468 /* RELEASE without CLICK */ 2469 {(int)KE_IGNORE, MOUSE_RELEASE, FALSE, FALSE}, 2470 {0, 0, 0, 0}, 2471 }; 2472 #endif /* FEAT_MOUSE */ 2473 2474 /* 2475 * Return the modifier mask bit (MOD_MASK_*) which corresponds to the given 2476 * modifier name ('S' for Shift, 'C' for Ctrl etc). 2477 */ 2478 int 2479 name_to_mod_mask(int c) 2480 { 2481 int i; 2482 2483 c = TOUPPER_ASC(c); 2484 for (i = 0; mod_mask_table[i].mod_mask != 0; i++) 2485 if (c == mod_mask_table[i].name) 2486 return mod_mask_table[i].mod_flag; 2487 return 0; 2488 } 2489 2490 /* 2491 * Check if if there is a special key code for "key" that includes the 2492 * modifiers specified. 2493 */ 2494 int 2495 simplify_key(int key, int *modifiers) 2496 { 2497 int i; 2498 int key0; 2499 int key1; 2500 2501 if (*modifiers & (MOD_MASK_SHIFT | MOD_MASK_CTRL | MOD_MASK_ALT)) 2502 { 2503 /* TAB is a special case */ 2504 if (key == TAB && (*modifiers & MOD_MASK_SHIFT)) 2505 { 2506 *modifiers &= ~MOD_MASK_SHIFT; 2507 return K_S_TAB; 2508 } 2509 key0 = KEY2TERMCAP0(key); 2510 key1 = KEY2TERMCAP1(key); 2511 for (i = 0; modifier_keys_table[i] != NUL; i += MOD_KEYS_ENTRY_SIZE) 2512 if (key0 == modifier_keys_table[i + 3] 2513 && key1 == modifier_keys_table[i + 4] 2514 && (*modifiers & modifier_keys_table[i])) 2515 { 2516 *modifiers &= ~modifier_keys_table[i]; 2517 return TERMCAP2KEY(modifier_keys_table[i + 1], 2518 modifier_keys_table[i + 2]); 2519 } 2520 } 2521 return key; 2522 } 2523 2524 /* 2525 * Change <xHome> to <Home>, <xUp> to <Up>, etc. 2526 */ 2527 int 2528 handle_x_keys(int key) 2529 { 2530 switch (key) 2531 { 2532 case K_XUP: return K_UP; 2533 case K_XDOWN: return K_DOWN; 2534 case K_XLEFT: return K_LEFT; 2535 case K_XRIGHT: return K_RIGHT; 2536 case K_XHOME: return K_HOME; 2537 case K_ZHOME: return K_HOME; 2538 case K_XEND: return K_END; 2539 case K_ZEND: return K_END; 2540 case K_XF1: return K_F1; 2541 case K_XF2: return K_F2; 2542 case K_XF3: return K_F3; 2543 case K_XF4: return K_F4; 2544 case K_S_XF1: return K_S_F1; 2545 case K_S_XF2: return K_S_F2; 2546 case K_S_XF3: return K_S_F3; 2547 case K_S_XF4: return K_S_F4; 2548 } 2549 return key; 2550 } 2551 2552 /* 2553 * Return a string which contains the name of the given key when the given 2554 * modifiers are down. 2555 */ 2556 char_u * 2557 get_special_key_name(int c, int modifiers) 2558 { 2559 static char_u string[MAX_KEY_NAME_LEN + 1]; 2560 2561 int i, idx; 2562 int table_idx; 2563 char_u *s; 2564 2565 string[0] = '<'; 2566 idx = 1; 2567 2568 /* Key that stands for a normal character. */ 2569 if (IS_SPECIAL(c) && KEY2TERMCAP0(c) == KS_KEY) 2570 c = KEY2TERMCAP1(c); 2571 2572 /* 2573 * Translate shifted special keys into unshifted keys and set modifier. 2574 * Same for CTRL and ALT modifiers. 2575 */ 2576 if (IS_SPECIAL(c)) 2577 { 2578 for (i = 0; modifier_keys_table[i] != 0; i += MOD_KEYS_ENTRY_SIZE) 2579 if ( KEY2TERMCAP0(c) == (int)modifier_keys_table[i + 1] 2580 && (int)KEY2TERMCAP1(c) == (int)modifier_keys_table[i + 2]) 2581 { 2582 modifiers |= modifier_keys_table[i]; 2583 c = TERMCAP2KEY(modifier_keys_table[i + 3], 2584 modifier_keys_table[i + 4]); 2585 break; 2586 } 2587 } 2588 2589 /* try to find the key in the special key table */ 2590 table_idx = find_special_key_in_table(c); 2591 2592 /* 2593 * When not a known special key, and not a printable character, try to 2594 * extract modifiers. 2595 */ 2596 if (c > 0 2597 #ifdef FEAT_MBYTE 2598 && (*mb_char2len)(c) == 1 2599 #endif 2600 ) 2601 { 2602 if (table_idx < 0 2603 && (!vim_isprintc(c) || (c & 0x7f) == ' ') 2604 && (c & 0x80)) 2605 { 2606 c &= 0x7f; 2607 modifiers |= MOD_MASK_ALT; 2608 /* try again, to find the un-alted key in the special key table */ 2609 table_idx = find_special_key_in_table(c); 2610 } 2611 if (table_idx < 0 && !vim_isprintc(c) && c < ' ') 2612 { 2613 #ifdef EBCDIC 2614 c = CtrlChar(c); 2615 #else 2616 c += '@'; 2617 #endif 2618 modifiers |= MOD_MASK_CTRL; 2619 } 2620 } 2621 2622 /* translate the modifier into a string */ 2623 for (i = 0; mod_mask_table[i].name != 'A'; i++) 2624 if ((modifiers & mod_mask_table[i].mod_mask) 2625 == mod_mask_table[i].mod_flag) 2626 { 2627 string[idx++] = mod_mask_table[i].name; 2628 string[idx++] = (char_u)'-'; 2629 } 2630 2631 if (table_idx < 0) /* unknown special key, may output t_xx */ 2632 { 2633 if (IS_SPECIAL(c)) 2634 { 2635 string[idx++] = 't'; 2636 string[idx++] = '_'; 2637 string[idx++] = KEY2TERMCAP0(c); 2638 string[idx++] = KEY2TERMCAP1(c); 2639 } 2640 /* Not a special key, only modifiers, output directly */ 2641 else 2642 { 2643 #ifdef FEAT_MBYTE 2644 if (has_mbyte && (*mb_char2len)(c) > 1) 2645 idx += (*mb_char2bytes)(c, string + idx); 2646 else 2647 #endif 2648 if (vim_isprintc(c)) 2649 string[idx++] = c; 2650 else 2651 { 2652 s = transchar(c); 2653 while (*s) 2654 string[idx++] = *s++; 2655 } 2656 } 2657 } 2658 else /* use name of special key */ 2659 { 2660 STRCPY(string + idx, key_names_table[table_idx].name); 2661 idx = (int)STRLEN(string); 2662 } 2663 string[idx++] = '>'; 2664 string[idx] = NUL; 2665 return string; 2666 } 2667 2668 /* 2669 * Try translating a <> name at (*srcp)[] to dst[]. 2670 * Return the number of characters added to dst[], zero for no match. 2671 * If there is a match, srcp is advanced to after the <> name. 2672 * dst[] must be big enough to hold the result (up to six characters)! 2673 */ 2674 int 2675 trans_special( 2676 char_u **srcp, 2677 char_u *dst, 2678 int keycode, /* prefer key code, e.g. K_DEL instead of DEL */ 2679 int in_string) /* TRUE when inside a double quoted string */ 2680 { 2681 int modifiers = 0; 2682 int key; 2683 int dlen = 0; 2684 2685 key = find_special_key(srcp, &modifiers, keycode, FALSE, in_string); 2686 if (key == 0) 2687 return 0; 2688 2689 /* Put the appropriate modifier in a string */ 2690 if (modifiers != 0) 2691 { 2692 dst[dlen++] = K_SPECIAL; 2693 dst[dlen++] = KS_MODIFIER; 2694 dst[dlen++] = modifiers; 2695 } 2696 2697 if (IS_SPECIAL(key)) 2698 { 2699 dst[dlen++] = K_SPECIAL; 2700 dst[dlen++] = KEY2TERMCAP0(key); 2701 dst[dlen++] = KEY2TERMCAP1(key); 2702 } 2703 #ifdef FEAT_MBYTE 2704 else if (has_mbyte && !keycode) 2705 dlen += (*mb_char2bytes)(key, dst + dlen); 2706 #endif 2707 else if (keycode) 2708 dlen = (int)(add_char2buf(key, dst + dlen) - dst); 2709 else 2710 dst[dlen++] = key; 2711 2712 return dlen; 2713 } 2714 2715 /* 2716 * Try translating a <> name at (*srcp)[], return the key and modifiers. 2717 * srcp is advanced to after the <> name. 2718 * returns 0 if there is no match. 2719 */ 2720 int 2721 find_special_key( 2722 char_u **srcp, 2723 int *modp, 2724 int keycode, /* prefer key code, e.g. K_DEL instead of DEL */ 2725 int keep_x_key, /* don't translate xHome to Home key */ 2726 int in_string) /* TRUE in string, double quote is escaped */ 2727 { 2728 char_u *last_dash; 2729 char_u *end_of_name; 2730 char_u *src; 2731 char_u *bp; 2732 int modifiers; 2733 int bit; 2734 int key; 2735 uvarnumber_T n; 2736 int l; 2737 2738 src = *srcp; 2739 if (src[0] != '<') 2740 return 0; 2741 2742 /* Find end of modifier list */ 2743 last_dash = src; 2744 for (bp = src + 1; *bp == '-' || vim_isIDc(*bp); bp++) 2745 { 2746 if (*bp == '-') 2747 { 2748 last_dash = bp; 2749 if (bp[1] != NUL) 2750 { 2751 #ifdef FEAT_MBYTE 2752 if (has_mbyte) 2753 l = mb_ptr2len(bp + 1); 2754 else 2755 #endif 2756 l = 1; 2757 /* Anything accepted, like <C-?>. 2758 * <C-"> or <M-"> are not special in strings as " is 2759 * the string delimiter. With a backslash it works: <M-\"> */ 2760 if (!(in_string && bp[1] == '"') && bp[2] == '>') 2761 bp += l; 2762 else if (in_string && bp[1] == '\\' && bp[2] == '"' 2763 && bp[3] == '>') 2764 bp += 2; 2765 } 2766 } 2767 if (bp[0] == 't' && bp[1] == '_' && bp[2] && bp[3]) 2768 bp += 3; /* skip t_xx, xx may be '-' or '>' */ 2769 else if (STRNICMP(bp, "char-", 5) == 0) 2770 { 2771 vim_str2nr(bp + 5, NULL, &l, STR2NR_ALL, NULL, NULL, 0); 2772 bp += l + 5; 2773 break; 2774 } 2775 } 2776 2777 if (*bp == '>') /* found matching '>' */ 2778 { 2779 end_of_name = bp + 1; 2780 2781 /* Which modifiers are given? */ 2782 modifiers = 0x0; 2783 for (bp = src + 1; bp < last_dash; bp++) 2784 { 2785 if (*bp != '-') 2786 { 2787 bit = name_to_mod_mask(*bp); 2788 if (bit == 0x0) 2789 break; /* Illegal modifier name */ 2790 modifiers |= bit; 2791 } 2792 } 2793 2794 /* 2795 * Legal modifier name. 2796 */ 2797 if (bp >= last_dash) 2798 { 2799 if (STRNICMP(last_dash + 1, "char-", 5) == 0 2800 && VIM_ISDIGIT(last_dash[6])) 2801 { 2802 /* <Char-123> or <Char-033> or <Char-0x33> */ 2803 vim_str2nr(last_dash + 6, NULL, NULL, STR2NR_ALL, NULL, &n, 0); 2804 key = (int)n; 2805 } 2806 else 2807 { 2808 int off = 1; 2809 2810 /* Modifier with single letter, or special key name. */ 2811 if (in_string && last_dash[1] == '\\' && last_dash[2] == '"') 2812 off = 2; 2813 #ifdef FEAT_MBYTE 2814 if (has_mbyte) 2815 l = mb_ptr2len(last_dash + off); 2816 else 2817 #endif 2818 l = 1; 2819 if (modifiers != 0 && last_dash[l + off] == '>') 2820 key = PTR2CHAR(last_dash + off); 2821 else 2822 { 2823 key = get_special_key_code(last_dash + off); 2824 if (!keep_x_key) 2825 key = handle_x_keys(key); 2826 } 2827 } 2828 2829 /* 2830 * get_special_key_code() may return NUL for invalid 2831 * special key name. 2832 */ 2833 if (key != NUL) 2834 { 2835 /* 2836 * Only use a modifier when there is no special key code that 2837 * includes the modifier. 2838 */ 2839 key = simplify_key(key, &modifiers); 2840 2841 if (!keycode) 2842 { 2843 /* don't want keycode, use single byte code */ 2844 if (key == K_BS) 2845 key = BS; 2846 else if (key == K_DEL || key == K_KDEL) 2847 key = DEL; 2848 } 2849 2850 /* 2851 * Normal Key with modifier: Try to make a single byte code. 2852 */ 2853 if (!IS_SPECIAL(key)) 2854 key = extract_modifiers(key, &modifiers); 2855 2856 *modp = modifiers; 2857 *srcp = end_of_name; 2858 return key; 2859 } 2860 } 2861 } 2862 return 0; 2863 } 2864 2865 /* 2866 * Try to include modifiers in the key. 2867 * Changes "Shift-a" to 'A', "Alt-A" to 0xc0, etc. 2868 */ 2869 int 2870 extract_modifiers(int key, int *modp) 2871 { 2872 int modifiers = *modp; 2873 2874 #ifdef MACOS 2875 /* Command-key really special, no fancynest */ 2876 if (!(modifiers & MOD_MASK_CMD)) 2877 #endif 2878 if ((modifiers & MOD_MASK_SHIFT) && ASCII_ISALPHA(key)) 2879 { 2880 key = TOUPPER_ASC(key); 2881 modifiers &= ~MOD_MASK_SHIFT; 2882 } 2883 if ((modifiers & MOD_MASK_CTRL) 2884 #ifdef EBCDIC 2885 /* * TODO: EBCDIC Better use: 2886 * && (Ctrl_chr(key) || key == '?') 2887 * ??? */ 2888 && strchr("?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_", key) 2889 != NULL 2890 #else 2891 && ((key >= '?' && key <= '_') || ASCII_ISALPHA(key)) 2892 #endif 2893 ) 2894 { 2895 key = Ctrl_chr(key); 2896 modifiers &= ~MOD_MASK_CTRL; 2897 /* <C-@> is <Nul> */ 2898 if (key == 0) 2899 key = K_ZERO; 2900 } 2901 #ifdef MACOS 2902 /* Command-key really special, no fancynest */ 2903 if (!(modifiers & MOD_MASK_CMD)) 2904 #endif 2905 if ((modifiers & MOD_MASK_ALT) && key < 0x80 2906 #ifdef FEAT_MBYTE 2907 && !enc_dbcs /* avoid creating a lead byte */ 2908 #endif 2909 ) 2910 { 2911 key |= 0x80; 2912 modifiers &= ~MOD_MASK_ALT; /* remove the META modifier */ 2913 } 2914 2915 *modp = modifiers; 2916 return key; 2917 } 2918 2919 /* 2920 * Try to find key "c" in the special key table. 2921 * Return the index when found, -1 when not found. 2922 */ 2923 int 2924 find_special_key_in_table(int c) 2925 { 2926 int i; 2927 2928 for (i = 0; key_names_table[i].name != NULL; i++) 2929 if (c == key_names_table[i].key) 2930 break; 2931 if (key_names_table[i].name == NULL) 2932 i = -1; 2933 return i; 2934 } 2935 2936 /* 2937 * Find the special key with the given name (the given string does not have to 2938 * end with NUL, the name is assumed to end before the first non-idchar). 2939 * If the name starts with "t_" the next two characters are interpreted as a 2940 * termcap name. 2941 * Return the key code, or 0 if not found. 2942 */ 2943 int 2944 get_special_key_code(char_u *name) 2945 { 2946 char_u *table_name; 2947 char_u string[3]; 2948 int i, j; 2949 2950 /* 2951 * If it's <t_xx> we get the code for xx from the termcap 2952 */ 2953 if (name[0] == 't' && name[1] == '_' && name[2] != NUL && name[3] != NUL) 2954 { 2955 string[0] = name[2]; 2956 string[1] = name[3]; 2957 string[2] = NUL; 2958 if (add_termcap_entry(string, FALSE) == OK) 2959 return TERMCAP2KEY(name[2], name[3]); 2960 } 2961 else 2962 for (i = 0; key_names_table[i].name != NULL; i++) 2963 { 2964 table_name = key_names_table[i].name; 2965 for (j = 0; vim_isIDc(name[j]) && table_name[j] != NUL; j++) 2966 if (TOLOWER_ASC(table_name[j]) != TOLOWER_ASC(name[j])) 2967 break; 2968 if (!vim_isIDc(name[j]) && table_name[j] == NUL) 2969 return key_names_table[i].key; 2970 } 2971 return 0; 2972 } 2973 2974 #if defined(FEAT_CMDL_COMPL) || defined(PROTO) 2975 char_u * 2976 get_key_name(int i) 2977 { 2978 if (i >= (int)KEY_NAMES_TABLE_LEN) 2979 return NULL; 2980 return key_names_table[i].name; 2981 } 2982 #endif 2983 2984 #if defined(FEAT_MOUSE) || defined(PROTO) 2985 /* 2986 * Look up the given mouse code to return the relevant information in the other 2987 * arguments. Return which button is down or was released. 2988 */ 2989 int 2990 get_mouse_button(int code, int *is_click, int *is_drag) 2991 { 2992 int i; 2993 2994 for (i = 0; mouse_table[i].pseudo_code; i++) 2995 if (code == mouse_table[i].pseudo_code) 2996 { 2997 *is_click = mouse_table[i].is_click; 2998 *is_drag = mouse_table[i].is_drag; 2999 return mouse_table[i].button; 3000 } 3001 return 0; /* Shouldn't get here */ 3002 } 3003 3004 /* 3005 * Return the appropriate pseudo mouse event token (KE_LEFTMOUSE etc) based on 3006 * the given information about which mouse button is down, and whether the 3007 * mouse was clicked, dragged or released. 3008 */ 3009 int 3010 get_pseudo_mouse_code( 3011 int button, /* eg MOUSE_LEFT */ 3012 int is_click, 3013 int is_drag) 3014 { 3015 int i; 3016 3017 for (i = 0; mouse_table[i].pseudo_code; i++) 3018 if (button == mouse_table[i].button 3019 && is_click == mouse_table[i].is_click 3020 && is_drag == mouse_table[i].is_drag) 3021 { 3022 #ifdef FEAT_GUI 3023 /* Trick: a non mappable left click and release has mouse_col -1 3024 * or added MOUSE_COLOFF. Used for 'mousefocus' in 3025 * gui_mouse_moved() */ 3026 if (mouse_col < 0 || mouse_col > MOUSE_COLOFF) 3027 { 3028 if (mouse_col < 0) 3029 mouse_col = 0; 3030 else 3031 mouse_col -= MOUSE_COLOFF; 3032 if (mouse_table[i].pseudo_code == (int)KE_LEFTMOUSE) 3033 return (int)KE_LEFTMOUSE_NM; 3034 if (mouse_table[i].pseudo_code == (int)KE_LEFTRELEASE) 3035 return (int)KE_LEFTRELEASE_NM; 3036 } 3037 #endif 3038 return mouse_table[i].pseudo_code; 3039 } 3040 return (int)KE_IGNORE; /* not recognized, ignore it */ 3041 } 3042 #endif /* FEAT_MOUSE */ 3043 3044 /* 3045 * Return the current end-of-line type: EOL_DOS, EOL_UNIX or EOL_MAC. 3046 */ 3047 int 3048 get_fileformat(buf_T *buf) 3049 { 3050 int c = *buf->b_p_ff; 3051 3052 if (buf->b_p_bin || c == 'u') 3053 return EOL_UNIX; 3054 if (c == 'm') 3055 return EOL_MAC; 3056 return EOL_DOS; 3057 } 3058 3059 /* 3060 * Like get_fileformat(), but override 'fileformat' with "p" for "++opt=val" 3061 * argument. 3062 */ 3063 int 3064 get_fileformat_force( 3065 buf_T *buf, 3066 exarg_T *eap) /* can be NULL! */ 3067 { 3068 int c; 3069 3070 if (eap != NULL && eap->force_ff != 0) 3071 c = eap->cmd[eap->force_ff]; 3072 else 3073 { 3074 if ((eap != NULL && eap->force_bin != 0) 3075 ? (eap->force_bin == FORCE_BIN) : buf->b_p_bin) 3076 return EOL_UNIX; 3077 c = *buf->b_p_ff; 3078 } 3079 if (c == 'u') 3080 return EOL_UNIX; 3081 if (c == 'm') 3082 return EOL_MAC; 3083 return EOL_DOS; 3084 } 3085 3086 /* 3087 * Set the current end-of-line type to EOL_DOS, EOL_UNIX or EOL_MAC. 3088 * Sets both 'textmode' and 'fileformat'. 3089 * Note: Does _not_ set global value of 'textmode'! 3090 */ 3091 void 3092 set_fileformat( 3093 int t, 3094 int opt_flags) /* OPT_LOCAL and/or OPT_GLOBAL */ 3095 { 3096 char *p = NULL; 3097 3098 switch (t) 3099 { 3100 case EOL_DOS: 3101 p = FF_DOS; 3102 curbuf->b_p_tx = TRUE; 3103 break; 3104 case EOL_UNIX: 3105 p = FF_UNIX; 3106 curbuf->b_p_tx = FALSE; 3107 break; 3108 case EOL_MAC: 3109 p = FF_MAC; 3110 curbuf->b_p_tx = FALSE; 3111 break; 3112 } 3113 if (p != NULL) 3114 set_string_option_direct((char_u *)"ff", -1, (char_u *)p, 3115 OPT_FREE | opt_flags, 0); 3116 3117 #ifdef FEAT_WINDOWS 3118 /* This may cause the buffer to become (un)modified. */ 3119 check_status(curbuf); 3120 redraw_tabline = TRUE; 3121 #endif 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((char_u *)_("Calling shell to execute: \"%s\""), 3157 cmd == NULL ? p_sh : cmd); 3158 out_char('\n'); 3159 cursor_on(); 3160 verbose_leave(); 3161 } 3162 3163 #ifdef FEAT_PROFILE 3164 if (do_profiling == PROF_YES) 3165 prof_child_enter(&wait_time); 3166 #endif 3167 3168 if (*p_sh == NUL) 3169 { 3170 EMSG(_(e_shellempty)); 3171 retval = -1; 3172 } 3173 else 3174 { 3175 #ifdef FEAT_GUI_MSWIN 3176 /* Don't hide the pointer while executing a shell command. */ 3177 gui_mch_mousehide(FALSE); 3178 #endif 3179 #ifdef FEAT_GUI 3180 ++hold_gui_events; 3181 #endif 3182 /* The external command may update a tags file, clear cached tags. */ 3183 tag_freematch(); 3184 3185 if (cmd == NULL || *p_sxq == NUL) 3186 retval = mch_call_shell(cmd, opt); 3187 else 3188 { 3189 char_u *ecmd = cmd; 3190 3191 if (*p_sxe != NUL && STRCMP(p_sxq, "(") == 0) 3192 { 3193 ecmd = vim_strsave_escaped_ext(cmd, p_sxe, '^', FALSE); 3194 if (ecmd == NULL) 3195 ecmd = cmd; 3196 } 3197 ncmd = alloc((unsigned)(STRLEN(ecmd) + STRLEN(p_sxq) * 2 + 1)); 3198 if (ncmd != NULL) 3199 { 3200 STRCPY(ncmd, p_sxq); 3201 STRCAT(ncmd, ecmd); 3202 /* When 'shellxquote' is ( append ). 3203 * When 'shellxquote' is "( append )". */ 3204 STRCAT(ncmd, STRCMP(p_sxq, "(") == 0 ? (char_u *)")" 3205 : STRCMP(p_sxq, "\"(") == 0 ? (char_u *)")\"" 3206 : p_sxq); 3207 retval = mch_call_shell(ncmd, opt); 3208 vim_free(ncmd); 3209 } 3210 else 3211 retval = -1; 3212 if (ecmd != cmd) 3213 vim_free(ecmd); 3214 } 3215 #ifdef FEAT_GUI 3216 --hold_gui_events; 3217 #endif 3218 /* 3219 * Check the window size, in case it changed while executing the 3220 * external command. 3221 */ 3222 shell_resized_check(); 3223 } 3224 3225 #ifdef FEAT_EVAL 3226 set_vim_var_nr(VV_SHELL_ERROR, (long)retval); 3227 # ifdef FEAT_PROFILE 3228 if (do_profiling == PROF_YES) 3229 prof_child_exit(&wait_time); 3230 # endif 3231 #endif 3232 3233 return retval; 3234 } 3235 3236 /* 3237 * VISUAL, SELECTMODE and OP_PENDING State are never set, they are equal to 3238 * NORMAL State with a condition. This function returns the real State. 3239 */ 3240 int 3241 get_real_state(void) 3242 { 3243 if (State & NORMAL) 3244 { 3245 if (VIsual_active) 3246 { 3247 if (VIsual_select) 3248 return SELECTMODE; 3249 return VISUAL; 3250 } 3251 else if (finish_op) 3252 return OP_PENDING; 3253 } 3254 return State; 3255 } 3256 3257 #if defined(FEAT_MBYTE) || defined(PROTO) 3258 /* 3259 * Return TRUE if "p" points to just after a path separator. 3260 * Takes care of multi-byte characters. 3261 * "b" must point to the start of the file name 3262 */ 3263 int 3264 after_pathsep(char_u *b, char_u *p) 3265 { 3266 return p > b && vim_ispathsep(p[-1]) 3267 && (!has_mbyte || (*mb_head_off)(b, p - 1) == 0); 3268 } 3269 #endif 3270 3271 /* 3272 * Return TRUE if file names "f1" and "f2" are in the same directory. 3273 * "f1" may be a short name, "f2" must be a full path. 3274 */ 3275 int 3276 same_directory(char_u *f1, char_u *f2) 3277 { 3278 char_u ffname[MAXPATHL]; 3279 char_u *t1; 3280 char_u *t2; 3281 3282 /* safety check */ 3283 if (f1 == NULL || f2 == NULL) 3284 return FALSE; 3285 3286 (void)vim_FullName(f1, ffname, MAXPATHL, FALSE); 3287 t1 = gettail_sep(ffname); 3288 t2 = gettail_sep(f2); 3289 return (t1 - ffname == t2 - f2 3290 && pathcmp((char *)ffname, (char *)f2, (int)(t1 - ffname)) == 0); 3291 } 3292 3293 #if defined(FEAT_SESSION) || defined(MSWIN) || defined(FEAT_GUI_MAC) \ 3294 || ((defined(FEAT_GUI_GTK)) \ 3295 && ( defined(FEAT_WINDOWS) || defined(FEAT_DND)) ) \ 3296 || defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG) \ 3297 || defined(PROTO) 3298 /* 3299 * Change to a file's directory. 3300 * Caller must call shorten_fnames()! 3301 * Return OK or FAIL. 3302 */ 3303 int 3304 vim_chdirfile(char_u *fname) 3305 { 3306 char_u dir[MAXPATHL]; 3307 3308 vim_strncpy(dir, fname, MAXPATHL - 1); 3309 *gettail_sep(dir) = NUL; 3310 return mch_chdir((char *)dir) == 0 ? OK : FAIL; 3311 } 3312 #endif 3313 3314 #if defined(STAT_IGNORES_SLASH) || defined(PROTO) 3315 /* 3316 * Check if "name" ends in a slash and is not a directory. 3317 * Used for systems where stat() ignores a trailing slash on a file name. 3318 * The Vim code assumes a trailing slash is only ignored for a directory. 3319 */ 3320 int 3321 illegal_slash(char *name) 3322 { 3323 if (name[0] == NUL) 3324 return FALSE; /* no file name is not illegal */ 3325 if (name[strlen(name) - 1] != '/') 3326 return FALSE; /* no trailing slash */ 3327 if (mch_isdir((char_u *)name)) 3328 return FALSE; /* trailing slash for a directory */ 3329 return TRUE; 3330 } 3331 #endif 3332 3333 #if defined(CURSOR_SHAPE) || defined(PROTO) 3334 3335 /* 3336 * Handling of cursor and mouse pointer shapes in various modes. 3337 */ 3338 3339 cursorentry_T shape_table[SHAPE_IDX_COUNT] = 3340 { 3341 /* The values will be filled in from the 'guicursor' and 'mouseshape' 3342 * defaults when Vim starts. 3343 * Adjust the SHAPE_IDX_ defines when making changes! */ 3344 {0, 0, 0, 700L, 400L, 250L, 0, 0, "n", SHAPE_CURSOR+SHAPE_MOUSE}, 3345 {0, 0, 0, 700L, 400L, 250L, 0, 0, "v", SHAPE_CURSOR+SHAPE_MOUSE}, 3346 {0, 0, 0, 700L, 400L, 250L, 0, 0, "i", SHAPE_CURSOR+SHAPE_MOUSE}, 3347 {0, 0, 0, 700L, 400L, 250L, 0, 0, "r", SHAPE_CURSOR+SHAPE_MOUSE}, 3348 {0, 0, 0, 700L, 400L, 250L, 0, 0, "c", SHAPE_CURSOR+SHAPE_MOUSE}, 3349 {0, 0, 0, 700L, 400L, 250L, 0, 0, "ci", SHAPE_CURSOR+SHAPE_MOUSE}, 3350 {0, 0, 0, 700L, 400L, 250L, 0, 0, "cr", SHAPE_CURSOR+SHAPE_MOUSE}, 3351 {0, 0, 0, 700L, 400L, 250L, 0, 0, "o", SHAPE_CURSOR+SHAPE_MOUSE}, 3352 {0, 0, 0, 700L, 400L, 250L, 0, 0, "ve", SHAPE_CURSOR+SHAPE_MOUSE}, 3353 {0, 0, 0, 0L, 0L, 0L, 0, 0, "e", SHAPE_MOUSE}, 3354 {0, 0, 0, 0L, 0L, 0L, 0, 0, "s", SHAPE_MOUSE}, 3355 {0, 0, 0, 0L, 0L, 0L, 0, 0, "sd", SHAPE_MOUSE}, 3356 {0, 0, 0, 0L, 0L, 0L, 0, 0, "vs", SHAPE_MOUSE}, 3357 {0, 0, 0, 0L, 0L, 0L, 0, 0, "vd", SHAPE_MOUSE}, 3358 {0, 0, 0, 0L, 0L, 0L, 0, 0, "m", SHAPE_MOUSE}, 3359 {0, 0, 0, 0L, 0L, 0L, 0, 0, "ml", SHAPE_MOUSE}, 3360 {0, 0, 0, 100L, 100L, 100L, 0, 0, "sm", SHAPE_CURSOR}, 3361 }; 3362 3363 #ifdef FEAT_MOUSESHAPE 3364 /* 3365 * Table with names for mouse shapes. Keep in sync with all the tables for 3366 * mch_set_mouse_shape()!. 3367 */ 3368 static char * mshape_names[] = 3369 { 3370 "arrow", /* default, must be the first one */ 3371 "blank", /* hidden */ 3372 "beam", 3373 "updown", 3374 "udsizing", 3375 "leftright", 3376 "lrsizing", 3377 "busy", 3378 "no", 3379 "crosshair", 3380 "hand1", 3381 "hand2", 3382 "pencil", 3383 "question", 3384 "rightup-arrow", 3385 "up-arrow", 3386 NULL 3387 }; 3388 #endif 3389 3390 /* 3391 * Parse the 'guicursor' option ("what" is SHAPE_CURSOR) or 'mouseshape' 3392 * ("what" is SHAPE_MOUSE). 3393 * Returns error message for an illegal option, NULL otherwise. 3394 */ 3395 char_u * 3396 parse_shape_opt(int what) 3397 { 3398 char_u *modep; 3399 char_u *colonp; 3400 char_u *commap; 3401 char_u *slashp; 3402 char_u *p, *endp; 3403 int idx = 0; /* init for GCC */ 3404 int all_idx; 3405 int len; 3406 int i; 3407 long n; 3408 int found_ve = FALSE; /* found "ve" flag */ 3409 int round; 3410 3411 /* 3412 * First round: check for errors; second round: do it for real. 3413 */ 3414 for (round = 1; round <= 2; ++round) 3415 { 3416 /* 3417 * Repeat for all comma separated parts. 3418 */ 3419 #ifdef FEAT_MOUSESHAPE 3420 if (what == SHAPE_MOUSE) 3421 modep = p_mouseshape; 3422 else 3423 #endif 3424 modep = p_guicursor; 3425 while (*modep != NUL) 3426 { 3427 colonp = vim_strchr(modep, ':'); 3428 if (colonp == NULL) 3429 return (char_u *)N_("E545: Missing colon"); 3430 if (colonp == modep) 3431 return (char_u *)N_("E546: Illegal mode"); 3432 commap = vim_strchr(modep, ','); 3433 3434 /* 3435 * Repeat for all mode's before the colon. 3436 * For the 'a' mode, we loop to handle all the modes. 3437 */ 3438 all_idx = -1; 3439 while (modep < colonp || all_idx >= 0) 3440 { 3441 if (all_idx < 0) 3442 { 3443 /* Find the mode. */ 3444 if (modep[1] == '-' || modep[1] == ':') 3445 len = 1; 3446 else 3447 len = 2; 3448 if (len == 1 && TOLOWER_ASC(modep[0]) == 'a') 3449 all_idx = SHAPE_IDX_COUNT - 1; 3450 else 3451 { 3452 for (idx = 0; idx < SHAPE_IDX_COUNT; ++idx) 3453 if (STRNICMP(modep, shape_table[idx].name, len) 3454 == 0) 3455 break; 3456 if (idx == SHAPE_IDX_COUNT 3457 || (shape_table[idx].used_for & what) == 0) 3458 return (char_u *)N_("E546: Illegal mode"); 3459 if (len == 2 && modep[0] == 'v' && modep[1] == 'e') 3460 found_ve = TRUE; 3461 } 3462 modep += len + 1; 3463 } 3464 3465 if (all_idx >= 0) 3466 idx = all_idx--; 3467 else if (round == 2) 3468 { 3469 #ifdef FEAT_MOUSESHAPE 3470 if (what == SHAPE_MOUSE) 3471 { 3472 /* Set the default, for the missing parts */ 3473 shape_table[idx].mshape = 0; 3474 } 3475 else 3476 #endif 3477 { 3478 /* Set the defaults, for the missing parts */ 3479 shape_table[idx].shape = SHAPE_BLOCK; 3480 shape_table[idx].blinkwait = 700L; 3481 shape_table[idx].blinkon = 400L; 3482 shape_table[idx].blinkoff = 250L; 3483 } 3484 } 3485 3486 /* Parse the part after the colon */ 3487 for (p = colonp + 1; *p && *p != ','; ) 3488 { 3489 #ifdef FEAT_MOUSESHAPE 3490 if (what == SHAPE_MOUSE) 3491 { 3492 for (i = 0; ; ++i) 3493 { 3494 if (mshape_names[i] == NULL) 3495 { 3496 if (!VIM_ISDIGIT(*p)) 3497 return (char_u *)N_("E547: Illegal mouseshape"); 3498 if (round == 2) 3499 shape_table[idx].mshape = 3500 getdigits(&p) + MSHAPE_NUMBERED; 3501 else 3502 (void)getdigits(&p); 3503 break; 3504 } 3505 len = (int)STRLEN(mshape_names[i]); 3506 if (STRNICMP(p, mshape_names[i], len) == 0) 3507 { 3508 if (round == 2) 3509 shape_table[idx].mshape = i; 3510 p += len; 3511 break; 3512 } 3513 } 3514 } 3515 else /* if (what == SHAPE_MOUSE) */ 3516 #endif 3517 { 3518 /* 3519 * First handle the ones with a number argument. 3520 */ 3521 i = *p; 3522 len = 0; 3523 if (STRNICMP(p, "ver", 3) == 0) 3524 len = 3; 3525 else if (STRNICMP(p, "hor", 3) == 0) 3526 len = 3; 3527 else if (STRNICMP(p, "blinkwait", 9) == 0) 3528 len = 9; 3529 else if (STRNICMP(p, "blinkon", 7) == 0) 3530 len = 7; 3531 else if (STRNICMP(p, "blinkoff", 8) == 0) 3532 len = 8; 3533 if (len != 0) 3534 { 3535 p += len; 3536 if (!VIM_ISDIGIT(*p)) 3537 return (char_u *)N_("E548: digit expected"); 3538 n = getdigits(&p); 3539 if (len == 3) /* "ver" or "hor" */ 3540 { 3541 if (n == 0) 3542 return (char_u *)N_("E549: Illegal percentage"); 3543 if (round == 2) 3544 { 3545 if (TOLOWER_ASC(i) == 'v') 3546 shape_table[idx].shape = SHAPE_VER; 3547 else 3548 shape_table[idx].shape = SHAPE_HOR; 3549 shape_table[idx].percentage = n; 3550 } 3551 } 3552 else if (round == 2) 3553 { 3554 if (len == 9) 3555 shape_table[idx].blinkwait = n; 3556 else if (len == 7) 3557 shape_table[idx].blinkon = n; 3558 else 3559 shape_table[idx].blinkoff = n; 3560 } 3561 } 3562 else if (STRNICMP(p, "block", 5) == 0) 3563 { 3564 if (round == 2) 3565 shape_table[idx].shape = SHAPE_BLOCK; 3566 p += 5; 3567 } 3568 else /* must be a highlight group name then */ 3569 { 3570 endp = vim_strchr(p, '-'); 3571 if (commap == NULL) /* last part */ 3572 { 3573 if (endp == NULL) 3574 endp = p + STRLEN(p); /* find end of part */ 3575 } 3576 else if (endp > commap || endp == NULL) 3577 endp = commap; 3578 slashp = vim_strchr(p, '/'); 3579 if (slashp != NULL && slashp < endp) 3580 { 3581 /* "group/langmap_group" */ 3582 i = syn_check_group(p, (int)(slashp - p)); 3583 p = slashp + 1; 3584 } 3585 if (round == 2) 3586 { 3587 shape_table[idx].id = syn_check_group(p, 3588 (int)(endp - p)); 3589 shape_table[idx].id_lm = shape_table[idx].id; 3590 if (slashp != NULL && slashp < endp) 3591 shape_table[idx].id = i; 3592 } 3593 p = endp; 3594 } 3595 } /* if (what != SHAPE_MOUSE) */ 3596 3597 if (*p == '-') 3598 ++p; 3599 } 3600 } 3601 modep = p; 3602 if (*modep == ',') 3603 ++modep; 3604 } 3605 } 3606 3607 /* If the 's' flag is not given, use the 'v' cursor for 's' */ 3608 if (!found_ve) 3609 { 3610 #ifdef FEAT_MOUSESHAPE 3611 if (what == SHAPE_MOUSE) 3612 { 3613 shape_table[SHAPE_IDX_VE].mshape = shape_table[SHAPE_IDX_V].mshape; 3614 } 3615 else 3616 #endif 3617 { 3618 shape_table[SHAPE_IDX_VE].shape = shape_table[SHAPE_IDX_V].shape; 3619 shape_table[SHAPE_IDX_VE].percentage = 3620 shape_table[SHAPE_IDX_V].percentage; 3621 shape_table[SHAPE_IDX_VE].blinkwait = 3622 shape_table[SHAPE_IDX_V].blinkwait; 3623 shape_table[SHAPE_IDX_VE].blinkon = 3624 shape_table[SHAPE_IDX_V].blinkon; 3625 shape_table[SHAPE_IDX_VE].blinkoff = 3626 shape_table[SHAPE_IDX_V].blinkoff; 3627 shape_table[SHAPE_IDX_VE].id = shape_table[SHAPE_IDX_V].id; 3628 shape_table[SHAPE_IDX_VE].id_lm = shape_table[SHAPE_IDX_V].id_lm; 3629 } 3630 } 3631 3632 return NULL; 3633 } 3634 3635 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \ 3636 || defined(FEAT_MOUSESHAPE) || defined(PROTO) 3637 /* 3638 * Return the index into shape_table[] for the current mode. 3639 * When "mouse" is TRUE, consider indexes valid for the mouse pointer. 3640 */ 3641 int 3642 get_shape_idx(int mouse) 3643 { 3644 #ifdef FEAT_MOUSESHAPE 3645 if (mouse && (State == HITRETURN || State == ASKMORE)) 3646 { 3647 # ifdef FEAT_GUI 3648 int x, y; 3649 gui_mch_getmouse(&x, &y); 3650 if (Y_2_ROW(y) == Rows - 1) 3651 return SHAPE_IDX_MOREL; 3652 # endif 3653 return SHAPE_IDX_MORE; 3654 } 3655 if (mouse && drag_status_line) 3656 return SHAPE_IDX_SDRAG; 3657 # ifdef FEAT_WINDOWS 3658 if (mouse && drag_sep_line) 3659 return SHAPE_IDX_VDRAG; 3660 # endif 3661 #endif 3662 if (!mouse && State == SHOWMATCH) 3663 return SHAPE_IDX_SM; 3664 #ifdef FEAT_VREPLACE 3665 if (State & VREPLACE_FLAG) 3666 return SHAPE_IDX_R; 3667 #endif 3668 if (State & REPLACE_FLAG) 3669 return SHAPE_IDX_R; 3670 if (State & INSERT) 3671 return SHAPE_IDX_I; 3672 if (State & CMDLINE) 3673 { 3674 if (cmdline_at_end()) 3675 return SHAPE_IDX_C; 3676 if (cmdline_overstrike()) 3677 return SHAPE_IDX_CR; 3678 return SHAPE_IDX_CI; 3679 } 3680 if (finish_op) 3681 return SHAPE_IDX_O; 3682 if (VIsual_active) 3683 { 3684 if (*p_sel == 'e') 3685 return SHAPE_IDX_VE; 3686 else 3687 return SHAPE_IDX_V; 3688 } 3689 return SHAPE_IDX_N; 3690 } 3691 #endif 3692 3693 # if defined(FEAT_MOUSESHAPE) || defined(PROTO) 3694 static int old_mouse_shape = 0; 3695 3696 /* 3697 * Set the mouse shape: 3698 * If "shape" is -1, use shape depending on the current mode, 3699 * depending on the current state. 3700 * If "shape" is -2, only update the shape when it's CLINE or STATUS (used 3701 * when the mouse moves off the status or command line). 3702 */ 3703 void 3704 update_mouseshape(int shape_idx) 3705 { 3706 int new_mouse_shape; 3707 3708 /* Only works in GUI mode. */ 3709 if (!gui.in_use || gui.starting) 3710 return; 3711 3712 /* Postpone the updating when more is to come. Speeds up executing of 3713 * mappings. */ 3714 if (shape_idx == -1 && char_avail()) 3715 { 3716 postponed_mouseshape = TRUE; 3717 return; 3718 } 3719 3720 /* When ignoring the mouse don't change shape on the statusline. */ 3721 if (*p_mouse == NUL 3722 && (shape_idx == SHAPE_IDX_CLINE 3723 || shape_idx == SHAPE_IDX_STATUS 3724 || shape_idx == SHAPE_IDX_VSEP)) 3725 shape_idx = -2; 3726 3727 if (shape_idx == -2 3728 && old_mouse_shape != shape_table[SHAPE_IDX_CLINE].mshape 3729 && old_mouse_shape != shape_table[SHAPE_IDX_STATUS].mshape 3730 && old_mouse_shape != shape_table[SHAPE_IDX_VSEP].mshape) 3731 return; 3732 if (shape_idx < 0) 3733 new_mouse_shape = shape_table[get_shape_idx(TRUE)].mshape; 3734 else 3735 new_mouse_shape = shape_table[shape_idx].mshape; 3736 if (new_mouse_shape != old_mouse_shape) 3737 { 3738 mch_set_mouse_shape(new_mouse_shape); 3739 old_mouse_shape = new_mouse_shape; 3740 } 3741 postponed_mouseshape = FALSE; 3742 } 3743 # endif 3744 3745 #endif /* CURSOR_SHAPE */ 3746 3747 3748 /* TODO: make some #ifdef for this */ 3749 /*--------[ file searching ]-------------------------------------------------*/ 3750 /* 3751 * File searching functions for 'path', 'tags' and 'cdpath' options. 3752 * External visible functions: 3753 * vim_findfile_init() creates/initialises the search context 3754 * vim_findfile_free_visited() free list of visited files/dirs of search 3755 * context 3756 * vim_findfile() find a file in the search context 3757 * vim_findfile_cleanup() cleanup/free search context created by 3758 * vim_findfile_init() 3759 * 3760 * All static functions and variables start with 'ff_' 3761 * 3762 * In general it works like this: 3763 * First you create yourself a search context by calling vim_findfile_init(). 3764 * It is possible to give a search context from a previous call to 3765 * vim_findfile_init(), so it can be reused. After this you call vim_findfile() 3766 * until you are satisfied with the result or it returns NULL. On every call it 3767 * returns the next file which matches the conditions given to 3768 * vim_findfile_init(). If it doesn't find a next file it returns NULL. 3769 * 3770 * It is possible to call vim_findfile_init() again to reinitialise your search 3771 * with some new parameters. Don't forget to pass your old search context to 3772 * it, so it can reuse it and especially reuse the list of already visited 3773 * directories. If you want to delete the list of already visited directories 3774 * simply call vim_findfile_free_visited(). 3775 * 3776 * When you are done call vim_findfile_cleanup() to free the search context. 3777 * 3778 * The function vim_findfile_init() has a long comment, which describes the 3779 * needed parameters. 3780 * 3781 * 3782 * 3783 * ATTENTION: 3784 * ========== 3785 * Also we use an allocated search context here, this functions are NOT 3786 * thread-safe!!!!! 3787 * 3788 * To minimize parameter passing (or because I'm to lazy), only the 3789 * external visible functions get a search context as a parameter. This is 3790 * then assigned to a static global, which is used throughout the local 3791 * functions. 3792 */ 3793 3794 /* 3795 * type for the directory search stack 3796 */ 3797 typedef struct ff_stack 3798 { 3799 struct ff_stack *ffs_prev; 3800 3801 /* the fix part (no wildcards) and the part containing the wildcards 3802 * of the search path 3803 */ 3804 char_u *ffs_fix_path; 3805 #ifdef FEAT_PATH_EXTRA 3806 char_u *ffs_wc_path; 3807 #endif 3808 3809 /* files/dirs found in the above directory, matched by the first wildcard 3810 * of wc_part 3811 */ 3812 char_u **ffs_filearray; 3813 int ffs_filearray_size; 3814 char_u ffs_filearray_cur; /* needed for partly handled dirs */ 3815 3816 /* to store status of partly handled directories 3817 * 0: we work on this directory for the first time 3818 * 1: this directory was partly searched in an earlier step 3819 */ 3820 int ffs_stage; 3821 3822 /* How deep are we in the directory tree? 3823 * Counts backward from value of level parameter to vim_findfile_init 3824 */ 3825 int ffs_level; 3826 3827 /* Did we already expand '**' to an empty string? */ 3828 int ffs_star_star_empty; 3829 } ff_stack_T; 3830 3831 /* 3832 * type for already visited directories or files. 3833 */ 3834 typedef struct ff_visited 3835 { 3836 struct ff_visited *ffv_next; 3837 3838 #ifdef FEAT_PATH_EXTRA 3839 /* Visited directories are different if the wildcard string are 3840 * different. So we have to save it. 3841 */ 3842 char_u *ffv_wc_path; 3843 #endif 3844 /* for unix use inode etc for comparison (needed because of links), else 3845 * use filename. 3846 */ 3847 #ifdef UNIX 3848 int ffv_dev_valid; /* ffv_dev and ffv_ino were set */ 3849 dev_t ffv_dev; /* device number */ 3850 ino_t ffv_ino; /* inode number */ 3851 #endif 3852 /* The memory for this struct is allocated according to the length of 3853 * ffv_fname. 3854 */ 3855 char_u ffv_fname[1]; /* actually longer */ 3856 } ff_visited_T; 3857 3858 /* 3859 * We might have to manage several visited lists during a search. 3860 * This is especially needed for the tags option. If tags is set to: 3861 * "./++/tags,./++/TAGS,++/tags" (replace + with *) 3862 * So we have to do 3 searches: 3863 * 1) search from the current files directory downward for the file "tags" 3864 * 2) search from the current files directory downward for the file "TAGS" 3865 * 3) search from Vims current directory downwards for the file "tags" 3866 * As you can see, the first and the third search are for the same file, so for 3867 * the third search we can use the visited list of the first search. For the 3868 * second search we must start from a empty visited list. 3869 * The struct ff_visited_list_hdr is used to manage a linked list of already 3870 * visited lists. 3871 */ 3872 typedef struct ff_visited_list_hdr 3873 { 3874 struct ff_visited_list_hdr *ffvl_next; 3875 3876 /* the filename the attached visited list is for */ 3877 char_u *ffvl_filename; 3878 3879 ff_visited_T *ffvl_visited_list; 3880 3881 } ff_visited_list_hdr_T; 3882 3883 3884 /* 3885 * '**' can be expanded to several directory levels. 3886 * Set the default maximum depth. 3887 */ 3888 #define FF_MAX_STAR_STAR_EXPAND ((char_u)30) 3889 3890 /* 3891 * The search context: 3892 * ffsc_stack_ptr: the stack for the dirs to search 3893 * ffsc_visited_list: the currently active visited list 3894 * ffsc_dir_visited_list: the currently active visited list for search dirs 3895 * ffsc_visited_lists_list: the list of all visited lists 3896 * ffsc_dir_visited_lists_list: the list of all visited lists for search dirs 3897 * ffsc_file_to_search: the file to search for 3898 * ffsc_start_dir: the starting directory, if search path was relative 3899 * ffsc_fix_path: the fix part of the given path (without wildcards) 3900 * Needed for upward search. 3901 * ffsc_wc_path: the part of the given path containing wildcards 3902 * ffsc_level: how many levels of dirs to search downwards 3903 * ffsc_stopdirs_v: array of stop directories for upward search 3904 * ffsc_find_what: FINDFILE_BOTH, FINDFILE_DIR or FINDFILE_FILE 3905 * ffsc_tagfile: searching for tags file, don't use 'suffixesadd' 3906 */ 3907 typedef struct ff_search_ctx_T 3908 { 3909 ff_stack_T *ffsc_stack_ptr; 3910 ff_visited_list_hdr_T *ffsc_visited_list; 3911 ff_visited_list_hdr_T *ffsc_dir_visited_list; 3912 ff_visited_list_hdr_T *ffsc_visited_lists_list; 3913 ff_visited_list_hdr_T *ffsc_dir_visited_lists_list; 3914 char_u *ffsc_file_to_search; 3915 char_u *ffsc_start_dir; 3916 char_u *ffsc_fix_path; 3917 #ifdef FEAT_PATH_EXTRA 3918 char_u *ffsc_wc_path; 3919 int ffsc_level; 3920 char_u **ffsc_stopdirs_v; 3921 #endif 3922 int ffsc_find_what; 3923 int ffsc_tagfile; 3924 } ff_search_ctx_T; 3925 3926 /* locally needed functions */ 3927 #ifdef FEAT_PATH_EXTRA 3928 static int ff_check_visited(ff_visited_T **, char_u *, char_u *); 3929 #else 3930 static int ff_check_visited(ff_visited_T **, char_u *); 3931 #endif 3932 static void vim_findfile_free_visited_list(ff_visited_list_hdr_T **list_headp); 3933 static void ff_free_visited_list(ff_visited_T *vl); 3934 static ff_visited_list_hdr_T* ff_get_visited_list(char_u *, ff_visited_list_hdr_T **list_headp); 3935 #ifdef FEAT_PATH_EXTRA 3936 static int ff_wc_equal(char_u *s1, char_u *s2); 3937 #endif 3938 3939 static void ff_push(ff_search_ctx_T *search_ctx, ff_stack_T *stack_ptr); 3940 static ff_stack_T *ff_pop(ff_search_ctx_T *search_ctx); 3941 static void ff_clear(ff_search_ctx_T *search_ctx); 3942 static void ff_free_stack_element(ff_stack_T *stack_ptr); 3943 #ifdef FEAT_PATH_EXTRA 3944 static ff_stack_T *ff_create_stack_element(char_u *, char_u *, int, int); 3945 #else 3946 static ff_stack_T *ff_create_stack_element(char_u *, int, int); 3947 #endif 3948 #ifdef FEAT_PATH_EXTRA 3949 static int ff_path_in_stoplist(char_u *, int, char_u **); 3950 #endif 3951 3952 static char_u e_pathtoolong[] = N_("E854: path too long for completion"); 3953 3954 #if 0 3955 /* 3956 * if someone likes findfirst/findnext, here are the functions 3957 * NOT TESTED!! 3958 */ 3959 3960 static void *ff_fn_search_context = NULL; 3961 3962 char_u * 3963 vim_findfirst(char_u *path, char_u *filename, int level) 3964 { 3965 ff_fn_search_context = 3966 vim_findfile_init(path, filename, NULL, level, TRUE, FALSE, 3967 ff_fn_search_context, rel_fname); 3968 if (NULL == ff_fn_search_context) 3969 return NULL; 3970 else 3971 return vim_findnext() 3972 } 3973 3974 char_u * 3975 vim_findnext(void) 3976 { 3977 char_u *ret = vim_findfile(ff_fn_search_context); 3978 3979 if (NULL == ret) 3980 { 3981 vim_findfile_cleanup(ff_fn_search_context); 3982 ff_fn_search_context = NULL; 3983 } 3984 return ret; 3985 } 3986 #endif 3987 3988 /* 3989 * Initialization routine for vim_findfile(). 3990 * 3991 * Returns the newly allocated search context or NULL if an error occurred. 3992 * 3993 * Don't forget to clean up by calling vim_findfile_cleanup() if you are done 3994 * with the search context. 3995 * 3996 * Find the file 'filename' in the directory 'path'. 3997 * The parameter 'path' may contain wildcards. If so only search 'level' 3998 * directories deep. The parameter 'level' is the absolute maximum and is 3999 * not related to restricts given to the '**' wildcard. If 'level' is 100 4000 * and you use '**200' vim_findfile() will stop after 100 levels. 4001 * 4002 * 'filename' cannot contain wildcards! It is used as-is, no backslashes to 4003 * escape special characters. 4004 * 4005 * If 'stopdirs' is not NULL and nothing is found downward, the search is 4006 * restarted on the next higher directory level. This is repeated until the 4007 * start-directory of a search is contained in 'stopdirs'. 'stopdirs' has the 4008 * format ";*<dirname>*\(;<dirname>\)*;\=$". 4009 * 4010 * If the 'path' is relative, the starting dir for the search is either VIM's 4011 * current dir or if the path starts with "./" the current files dir. 4012 * If the 'path' is absolute, the starting dir is that part of the path before 4013 * the first wildcard. 4014 * 4015 * Upward search is only done on the starting dir. 4016 * 4017 * If 'free_visited' is TRUE the list of already visited files/directories is 4018 * cleared. Set this to FALSE if you just want to search from another 4019 * directory, but want to be sure that no directory from a previous search is 4020 * searched again. This is useful if you search for a file at different places. 4021 * The list of visited files/dirs can also be cleared with the function 4022 * vim_findfile_free_visited(). 4023 * 4024 * Set the parameter 'find_what' to FINDFILE_DIR if you want to search for 4025 * directories only, FINDFILE_FILE for files only, FINDFILE_BOTH for both. 4026 * 4027 * A search context returned by a previous call to vim_findfile_init() can be 4028 * passed in the parameter "search_ctx_arg". This context is reused and 4029 * reinitialized with the new parameters. The list of already visited 4030 * directories from this context is only deleted if the parameter 4031 * "free_visited" is true. Be aware that the passed "search_ctx_arg" is freed 4032 * if the reinitialization fails. 4033 * 4034 * If you don't have a search context from a previous call "search_ctx_arg" 4035 * must be NULL. 4036 * 4037 * This function silently ignores a few errors, vim_findfile() will have 4038 * limited functionality then. 4039 */ 4040 void * 4041 vim_findfile_init( 4042 char_u *path, 4043 char_u *filename, 4044 char_u *stopdirs UNUSED, 4045 int level, 4046 int free_visited, 4047 int find_what, 4048 void *search_ctx_arg, 4049 int tagfile, /* expanding names of tags files */ 4050 char_u *rel_fname) /* file name to use for "." */ 4051 { 4052 #ifdef FEAT_PATH_EXTRA 4053 char_u *wc_part; 4054 #endif 4055 ff_stack_T *sptr; 4056 ff_search_ctx_T *search_ctx; 4057 4058 /* If a search context is given by the caller, reuse it, else allocate a 4059 * new one. 4060 */ 4061 if (search_ctx_arg != NULL) 4062 search_ctx = search_ctx_arg; 4063 else 4064 { 4065 search_ctx = (ff_search_ctx_T*)alloc((unsigned)sizeof(ff_search_ctx_T)); 4066 if (search_ctx == NULL) 4067 goto error_return; 4068 vim_memset(search_ctx, 0, sizeof(ff_search_ctx_T)); 4069 } 4070 search_ctx->ffsc_find_what = find_what; 4071 search_ctx->ffsc_tagfile = tagfile; 4072 4073 /* clear the search context, but NOT the visited lists */ 4074 ff_clear(search_ctx); 4075 4076 /* clear visited list if wanted */ 4077 if (free_visited == TRUE) 4078 vim_findfile_free_visited(search_ctx); 4079 else 4080 { 4081 /* Reuse old visited lists. Get the visited list for the given 4082 * filename. If no list for the current filename exists, creates a new 4083 * one. */ 4084 search_ctx->ffsc_visited_list = ff_get_visited_list(filename, 4085 &search_ctx->ffsc_visited_lists_list); 4086 if (search_ctx->ffsc_visited_list == NULL) 4087 goto error_return; 4088 search_ctx->ffsc_dir_visited_list = ff_get_visited_list(filename, 4089 &search_ctx->ffsc_dir_visited_lists_list); 4090 if (search_ctx->ffsc_dir_visited_list == NULL) 4091 goto error_return; 4092 } 4093 4094 if (ff_expand_buffer == NULL) 4095 { 4096 ff_expand_buffer = (char_u*)alloc(MAXPATHL); 4097 if (ff_expand_buffer == NULL) 4098 goto error_return; 4099 } 4100 4101 /* Store information on starting dir now if path is relative. 4102 * If path is absolute, we do that later. */ 4103 if (path[0] == '.' 4104 && (vim_ispathsep(path[1]) || path[1] == NUL) 4105 && (!tagfile || vim_strchr(p_cpo, CPO_DOTTAG) == NULL) 4106 && rel_fname != NULL) 4107 { 4108 int len = (int)(gettail(rel_fname) - rel_fname); 4109 4110 if (!vim_isAbsName(rel_fname) && len + 1 < MAXPATHL) 4111 { 4112 /* Make the start dir an absolute path name. */ 4113 vim_strncpy(ff_expand_buffer, rel_fname, len); 4114 search_ctx->ffsc_start_dir = FullName_save(ff_expand_buffer, FALSE); 4115 } 4116 else 4117 search_ctx->ffsc_start_dir = vim_strnsave(rel_fname, len); 4118 if (search_ctx->ffsc_start_dir == NULL) 4119 goto error_return; 4120 if (*++path != NUL) 4121 ++path; 4122 } 4123 else if (*path == NUL || !vim_isAbsName(path)) 4124 { 4125 #ifdef BACKSLASH_IN_FILENAME 4126 /* "c:dir" needs "c:" to be expanded, otherwise use current dir */ 4127 if (*path != NUL && path[1] == ':') 4128 { 4129 char_u drive[3]; 4130 4131 drive[0] = path[0]; 4132 drive[1] = ':'; 4133 drive[2] = NUL; 4134 if (vim_FullName(drive, ff_expand_buffer, MAXPATHL, TRUE) == FAIL) 4135 goto error_return; 4136 path += 2; 4137 } 4138 else 4139 #endif 4140 if (mch_dirname(ff_expand_buffer, MAXPATHL) == FAIL) 4141 goto error_return; 4142 4143 search_ctx->ffsc_start_dir = vim_strsave(ff_expand_buffer); 4144 if (search_ctx->ffsc_start_dir == NULL) 4145 goto error_return; 4146 4147 #ifdef BACKSLASH_IN_FILENAME 4148 /* A path that starts with "/dir" is relative to the drive, not to the 4149 * directory (but not for "//machine/dir"). Only use the drive name. */ 4150 if ((*path == '/' || *path == '\\') 4151 && path[1] != path[0] 4152 && search_ctx->ffsc_start_dir[1] == ':') 4153 search_ctx->ffsc_start_dir[2] = NUL; 4154 #endif 4155 } 4156 4157 #ifdef FEAT_PATH_EXTRA 4158 /* 4159 * If stopdirs are given, split them into an array of pointers. 4160 * If this fails (mem allocation), there is no upward search at all or a 4161 * stop directory is not recognized -> continue silently. 4162 * If stopdirs just contains a ";" or is empty, 4163 * search_ctx->ffsc_stopdirs_v will only contain a NULL pointer. This 4164 * is handled as unlimited upward search. See function 4165 * ff_path_in_stoplist() for details. 4166 */ 4167 if (stopdirs != NULL) 4168 { 4169 char_u *walker = stopdirs; 4170 int dircount; 4171 4172 while (*walker == ';') 4173 walker++; 4174 4175 dircount = 1; 4176 search_ctx->ffsc_stopdirs_v = 4177 (char_u **)alloc((unsigned)sizeof(char_u *)); 4178 4179 if (search_ctx->ffsc_stopdirs_v != NULL) 4180 { 4181 do 4182 { 4183 char_u *helper; 4184 void *ptr; 4185 4186 helper = walker; 4187 ptr = vim_realloc(search_ctx->ffsc_stopdirs_v, 4188 (dircount + 1) * sizeof(char_u *)); 4189 if (ptr) 4190 search_ctx->ffsc_stopdirs_v = ptr; 4191 else 4192 /* ignore, keep what we have and continue */ 4193 break; 4194 walker = vim_strchr(walker, ';'); 4195 if (walker) 4196 { 4197 search_ctx->ffsc_stopdirs_v[dircount-1] = 4198 vim_strnsave(helper, (int)(walker - helper)); 4199 walker++; 4200 } 4201 else 4202 /* this might be "", which means ascent till top 4203 * of directory tree. 4204 */ 4205 search_ctx->ffsc_stopdirs_v[dircount-1] = 4206 vim_strsave(helper); 4207 4208 dircount++; 4209 4210 } while (walker != NULL); 4211 search_ctx->ffsc_stopdirs_v[dircount-1] = NULL; 4212 } 4213 } 4214 #endif 4215 4216 #ifdef FEAT_PATH_EXTRA 4217 search_ctx->ffsc_level = level; 4218 4219 /* split into: 4220 * -fix path 4221 * -wildcard_stuff (might be NULL) 4222 */ 4223 wc_part = vim_strchr(path, '*'); 4224 if (wc_part != NULL) 4225 { 4226 int llevel; 4227 int len; 4228 char *errpt; 4229 4230 /* save the fix part of the path */ 4231 search_ctx->ffsc_fix_path = vim_strnsave(path, (int)(wc_part - path)); 4232 4233 /* 4234 * copy wc_path and add restricts to the '**' wildcard. 4235 * The octet after a '**' is used as a (binary) counter. 4236 * So '**3' is transposed to '**^C' ('^C' is ASCII value 3) 4237 * or '**76' is transposed to '**N'( 'N' is ASCII value 76). 4238 * For EBCDIC you get different character values. 4239 * If no restrict is given after '**' the default is used. 4240 * Due to this technique the path looks awful if you print it as a 4241 * string. 4242 */ 4243 len = 0; 4244 while (*wc_part != NUL) 4245 { 4246 if (len + 5 >= MAXPATHL) 4247 { 4248 EMSG(_(e_pathtoolong)); 4249 break; 4250 } 4251 if (STRNCMP(wc_part, "**", 2) == 0) 4252 { 4253 ff_expand_buffer[len++] = *wc_part++; 4254 ff_expand_buffer[len++] = *wc_part++; 4255 4256 llevel = strtol((char *)wc_part, &errpt, 10); 4257 if ((char_u *)errpt != wc_part && llevel > 0 && llevel < 255) 4258 ff_expand_buffer[len++] = llevel; 4259 else if ((char_u *)errpt != wc_part && llevel == 0) 4260 /* restrict is 0 -> remove already added '**' */ 4261 len -= 2; 4262 else 4263 ff_expand_buffer[len++] = FF_MAX_STAR_STAR_EXPAND; 4264 wc_part = (char_u *)errpt; 4265 if (*wc_part != NUL && !vim_ispathsep(*wc_part)) 4266 { 4267 EMSG2(_("E343: Invalid path: '**[number]' must be at the end of the path or be followed by '%s'."), PATHSEPSTR); 4268 goto error_return; 4269 } 4270 } 4271 else 4272 ff_expand_buffer[len++] = *wc_part++; 4273 } 4274 ff_expand_buffer[len] = NUL; 4275 search_ctx->ffsc_wc_path = vim_strsave(ff_expand_buffer); 4276 4277 if (search_ctx->ffsc_wc_path == NULL) 4278 goto error_return; 4279 } 4280 else 4281 #endif 4282 search_ctx->ffsc_fix_path = vim_strsave(path); 4283 4284 if (search_ctx->ffsc_start_dir == NULL) 4285 { 4286 /* store the fix part as startdir. 4287 * This is needed if the parameter path is fully qualified. 4288 */ 4289 search_ctx->ffsc_start_dir = vim_strsave(search_ctx->ffsc_fix_path); 4290 if (search_ctx->ffsc_start_dir == NULL) 4291 goto error_return; 4292 search_ctx->ffsc_fix_path[0] = NUL; 4293 } 4294 4295 /* create an absolute path */ 4296 if (STRLEN(search_ctx->ffsc_start_dir) 4297 + STRLEN(search_ctx->ffsc_fix_path) + 3 >= MAXPATHL) 4298 { 4299 EMSG(_(e_pathtoolong)); 4300 goto error_return; 4301 } 4302 STRCPY(ff_expand_buffer, search_ctx->ffsc_start_dir); 4303 add_pathsep(ff_expand_buffer); 4304 { 4305 int eb_len = (int)STRLEN(ff_expand_buffer); 4306 char_u *buf = alloc(eb_len 4307 + (int)STRLEN(search_ctx->ffsc_fix_path) + 1); 4308 4309 STRCPY(buf, ff_expand_buffer); 4310 STRCPY(buf + eb_len, search_ctx->ffsc_fix_path); 4311 if (mch_isdir(buf)) 4312 { 4313 STRCAT(ff_expand_buffer, search_ctx->ffsc_fix_path); 4314 add_pathsep(ff_expand_buffer); 4315 } 4316 #ifdef FEAT_PATH_EXTRA 4317 else 4318 { 4319 char_u *p = gettail(search_ctx->ffsc_fix_path); 4320 char_u *wc_path = NULL; 4321 char_u *temp = NULL; 4322 int len = 0; 4323 4324 if (p > search_ctx->ffsc_fix_path) 4325 { 4326 len = (int)(p - search_ctx->ffsc_fix_path) - 1; 4327 STRNCAT(ff_expand_buffer, search_ctx->ffsc_fix_path, len); 4328 add_pathsep(ff_expand_buffer); 4329 } 4330 else 4331 len = (int)STRLEN(search_ctx->ffsc_fix_path); 4332 4333 if (search_ctx->ffsc_wc_path != NULL) 4334 { 4335 wc_path = vim_strsave(search_ctx->ffsc_wc_path); 4336 temp = alloc((int)(STRLEN(search_ctx->ffsc_wc_path) 4337 + STRLEN(search_ctx->ffsc_fix_path + len) 4338 + 1)); 4339 if (temp == NULL || wc_path == NULL) 4340 { 4341 vim_free(buf); 4342 vim_free(temp); 4343 vim_free(wc_path); 4344 goto error_return; 4345 } 4346 4347 STRCPY(temp, search_ctx->ffsc_fix_path + len); 4348 STRCAT(temp, search_ctx->ffsc_wc_path); 4349 vim_free(search_ctx->ffsc_wc_path); 4350 vim_free(wc_path); 4351 search_ctx->ffsc_wc_path = temp; 4352 } 4353 } 4354 #endif 4355 vim_free(buf); 4356 } 4357 4358 sptr = ff_create_stack_element(ff_expand_buffer, 4359 #ifdef FEAT_PATH_EXTRA 4360 search_ctx->ffsc_wc_path, 4361 #endif 4362 level, 0); 4363 4364 if (sptr == NULL) 4365 goto error_return; 4366 4367 ff_push(search_ctx, sptr); 4368 4369 search_ctx->ffsc_file_to_search = vim_strsave(filename); 4370 if (search_ctx->ffsc_file_to_search == NULL) 4371 goto error_return; 4372 4373 return search_ctx; 4374 4375 error_return: 4376 /* 4377 * We clear the search context now! 4378 * Even when the caller gave us a (perhaps valid) context we free it here, 4379 * as we might have already destroyed it. 4380 */ 4381 vim_findfile_cleanup(search_ctx); 4382 return NULL; 4383 } 4384 4385 #if defined(FEAT_PATH_EXTRA) || defined(PROTO) 4386 /* 4387 * Get the stopdir string. Check that ';' is not escaped. 4388 */ 4389 char_u * 4390 vim_findfile_stopdir(char_u *buf) 4391 { 4392 char_u *r_ptr = buf; 4393 4394 while (*r_ptr != NUL && *r_ptr != ';') 4395 { 4396 if (r_ptr[0] == '\\' && r_ptr[1] == ';') 4397 { 4398 /* Overwrite the escape char, 4399 * use STRLEN(r_ptr) to move the trailing '\0'. */ 4400 STRMOVE(r_ptr, r_ptr + 1); 4401 r_ptr++; 4402 } 4403 r_ptr++; 4404 } 4405 if (*r_ptr == ';') 4406 { 4407 *r_ptr = 0; 4408 r_ptr++; 4409 } 4410 else if (*r_ptr == NUL) 4411 r_ptr = NULL; 4412 return r_ptr; 4413 } 4414 #endif 4415 4416 /* 4417 * Clean up the given search context. Can handle a NULL pointer. 4418 */ 4419 void 4420 vim_findfile_cleanup(void *ctx) 4421 { 4422 if (ctx == NULL) 4423 return; 4424 4425 vim_findfile_free_visited(ctx); 4426 ff_clear(ctx); 4427 vim_free(ctx); 4428 } 4429 4430 /* 4431 * Find a file in a search context. 4432 * The search context was created with vim_findfile_init() above. 4433 * Return a pointer to an allocated file name or NULL if nothing found. 4434 * To get all matching files call this function until you get NULL. 4435 * 4436 * If the passed search_context is NULL, NULL is returned. 4437 * 4438 * The search algorithm is depth first. To change this replace the 4439 * stack with a list (don't forget to leave partly searched directories on the 4440 * top of the list). 4441 */ 4442 char_u * 4443 vim_findfile(void *search_ctx_arg) 4444 { 4445 char_u *file_path; 4446 #ifdef FEAT_PATH_EXTRA 4447 char_u *rest_of_wildcards; 4448 char_u *path_end = NULL; 4449 #endif 4450 ff_stack_T *stackp; 4451 #if defined(FEAT_SEARCHPATH) || defined(FEAT_PATH_EXTRA) 4452 int len; 4453 #endif 4454 int i; 4455 char_u *p; 4456 #ifdef FEAT_SEARCHPATH 4457 char_u *suf; 4458 #endif 4459 ff_search_ctx_T *search_ctx; 4460 4461 if (search_ctx_arg == NULL) 4462 return NULL; 4463 4464 search_ctx = (ff_search_ctx_T *)search_ctx_arg; 4465 4466 /* 4467 * filepath is used as buffer for various actions and as the storage to 4468 * return a found filename. 4469 */ 4470 if ((file_path = alloc((int)MAXPATHL)) == NULL) 4471 return NULL; 4472 4473 #ifdef FEAT_PATH_EXTRA 4474 /* store the end of the start dir -- needed for upward search */ 4475 if (search_ctx->ffsc_start_dir != NULL) 4476 path_end = &search_ctx->ffsc_start_dir[ 4477 STRLEN(search_ctx->ffsc_start_dir)]; 4478 #endif 4479 4480 #ifdef FEAT_PATH_EXTRA 4481 /* upward search loop */ 4482 for (;;) 4483 { 4484 #endif 4485 /* downward search loop */ 4486 for (;;) 4487 { 4488 /* check if user user wants to stop the search*/ 4489 ui_breakcheck(); 4490 if (got_int) 4491 break; 4492 4493 /* get directory to work on from stack */ 4494 stackp = ff_pop(search_ctx); 4495 if (stackp == NULL) 4496 break; 4497 4498 /* 4499 * TODO: decide if we leave this test in 4500 * 4501 * GOOD: don't search a directory(-tree) twice. 4502 * BAD: - check linked list for every new directory entered. 4503 * - check for double files also done below 4504 * 4505 * Here we check if we already searched this directory. 4506 * We already searched a directory if: 4507 * 1) The directory is the same. 4508 * 2) We would use the same wildcard string. 4509 * 4510 * Good if you have links on same directory via several ways 4511 * or you have selfreferences in directories (e.g. SuSE Linux 6.3: 4512 * /etc/rc.d/init.d is linked to /etc/rc.d -> endless loop) 4513 * 4514 * This check is only needed for directories we work on for the 4515 * first time (hence stackp->ff_filearray == NULL) 4516 */ 4517 if (stackp->ffs_filearray == NULL 4518 && ff_check_visited(&search_ctx->ffsc_dir_visited_list 4519 ->ffvl_visited_list, 4520 stackp->ffs_fix_path 4521 #ifdef FEAT_PATH_EXTRA 4522 , stackp->ffs_wc_path 4523 #endif 4524 ) == FAIL) 4525 { 4526 #ifdef FF_VERBOSE 4527 if (p_verbose >= 5) 4528 { 4529 verbose_enter_scroll(); 4530 smsg((char_u *)"Already Searched: %s (%s)", 4531 stackp->ffs_fix_path, stackp->ffs_wc_path); 4532 /* don't overwrite this either */ 4533 msg_puts((char_u *)"\n"); 4534 verbose_leave_scroll(); 4535 } 4536 #endif 4537 ff_free_stack_element(stackp); 4538 continue; 4539 } 4540 #ifdef FF_VERBOSE 4541 else if (p_verbose >= 5) 4542 { 4543 verbose_enter_scroll(); 4544 smsg((char_u *)"Searching: %s (%s)", 4545 stackp->ffs_fix_path, stackp->ffs_wc_path); 4546 /* don't overwrite this either */ 4547 msg_puts((char_u *)"\n"); 4548 verbose_leave_scroll(); 4549 } 4550 #endif 4551 4552 /* check depth */ 4553 if (stackp->ffs_level <= 0) 4554 { 4555 ff_free_stack_element(stackp); 4556 continue; 4557 } 4558 4559 file_path[0] = NUL; 4560 4561 /* 4562 * If no filearray till now expand wildcards 4563 * The function expand_wildcards() can handle an array of paths 4564 * and all possible expands are returned in one array. We use this 4565 * to handle the expansion of '**' into an empty string. 4566 */ 4567 if (stackp->ffs_filearray == NULL) 4568 { 4569 char_u *dirptrs[2]; 4570 4571 /* we use filepath to build the path expand_wildcards() should 4572 * expand. 4573 */ 4574 dirptrs[0] = file_path; 4575 dirptrs[1] = NULL; 4576 4577 /* if we have a start dir copy it in */ 4578 if (!vim_isAbsName(stackp->ffs_fix_path) 4579 && search_ctx->ffsc_start_dir) 4580 { 4581 STRCPY(file_path, search_ctx->ffsc_start_dir); 4582 add_pathsep(file_path); 4583 } 4584 4585 /* append the fix part of the search path */ 4586 STRCAT(file_path, stackp->ffs_fix_path); 4587 add_pathsep(file_path); 4588 4589 #ifdef FEAT_PATH_EXTRA 4590 rest_of_wildcards = stackp->ffs_wc_path; 4591 if (*rest_of_wildcards != NUL) 4592 { 4593 len = (int)STRLEN(file_path); 4594 if (STRNCMP(rest_of_wildcards, "**", 2) == 0) 4595 { 4596 /* pointer to the restrict byte 4597 * The restrict byte is not a character! 4598 */ 4599 p = rest_of_wildcards + 2; 4600 4601 if (*p > 0) 4602 { 4603 (*p)--; 4604 file_path[len++] = '*'; 4605 } 4606 4607 if (*p == 0) 4608 { 4609 /* remove '**<numb> from wildcards */ 4610 STRMOVE(rest_of_wildcards, rest_of_wildcards + 3); 4611 } 4612 else 4613 rest_of_wildcards += 3; 4614 4615 if (stackp->ffs_star_star_empty == 0) 4616 { 4617 /* if not done before, expand '**' to empty */ 4618 stackp->ffs_star_star_empty = 1; 4619 dirptrs[1] = stackp->ffs_fix_path; 4620 } 4621 } 4622 4623 /* 4624 * Here we copy until the next path separator or the end of 4625 * the path. If we stop at a path separator, there is 4626 * still something else left. This is handled below by 4627 * pushing every directory returned from expand_wildcards() 4628 * on the stack again for further search. 4629 */ 4630 while (*rest_of_wildcards 4631 && !vim_ispathsep(*rest_of_wildcards)) 4632 file_path[len++] = *rest_of_wildcards++; 4633 4634 file_path[len] = NUL; 4635 if (vim_ispathsep(*rest_of_wildcards)) 4636 rest_of_wildcards++; 4637 } 4638 #endif 4639 4640 /* 4641 * Expand wildcards like "*" and "$VAR". 4642 * If the path is a URL don't try this. 4643 */ 4644 if (path_with_url(dirptrs[0])) 4645 { 4646 stackp->ffs_filearray = (char_u **) 4647 alloc((unsigned)sizeof(char *)); 4648 if (stackp->ffs_filearray != NULL 4649 && (stackp->ffs_filearray[0] 4650 = vim_strsave(dirptrs[0])) != NULL) 4651 stackp->ffs_filearray_size = 1; 4652 else 4653 stackp->ffs_filearray_size = 0; 4654 } 4655 else 4656 /* Add EW_NOTWILD because the expanded path may contain 4657 * wildcard characters that are to be taken literally. 4658 * This is a bit of a hack. */ 4659 expand_wildcards((dirptrs[1] == NULL) ? 1 : 2, dirptrs, 4660 &stackp->ffs_filearray_size, 4661 &stackp->ffs_filearray, 4662 EW_DIR|EW_ADDSLASH|EW_SILENT|EW_NOTWILD); 4663 4664 stackp->ffs_filearray_cur = 0; 4665 stackp->ffs_stage = 0; 4666 } 4667 #ifdef FEAT_PATH_EXTRA 4668 else 4669 rest_of_wildcards = &stackp->ffs_wc_path[ 4670 STRLEN(stackp->ffs_wc_path)]; 4671 #endif 4672 4673 if (stackp->ffs_stage == 0) 4674 { 4675 /* this is the first time we work on this directory */ 4676 #ifdef FEAT_PATH_EXTRA 4677 if (*rest_of_wildcards == NUL) 4678 #endif 4679 { 4680 /* 4681 * We don't have further wildcards to expand, so we have to 4682 * check for the final file now. 4683 */ 4684 for (i = stackp->ffs_filearray_cur; 4685 i < stackp->ffs_filearray_size; ++i) 4686 { 4687 if (!path_with_url(stackp->ffs_filearray[i]) 4688 && !mch_isdir(stackp->ffs_filearray[i])) 4689 continue; /* not a directory */ 4690 4691 /* prepare the filename to be checked for existence 4692 * below */ 4693 STRCPY(file_path, stackp->ffs_filearray[i]); 4694 add_pathsep(file_path); 4695 STRCAT(file_path, search_ctx->ffsc_file_to_search); 4696 4697 /* 4698 * Try without extra suffix and then with suffixes 4699 * from 'suffixesadd'. 4700 */ 4701 #ifdef FEAT_SEARCHPATH 4702 len = (int)STRLEN(file_path); 4703 if (search_ctx->ffsc_tagfile) 4704 suf = (char_u *)""; 4705 else 4706 suf = curbuf->b_p_sua; 4707 for (;;) 4708 #endif 4709 { 4710 /* if file exists and we didn't already find it */ 4711 if ((path_with_url(file_path) 4712 || (mch_getperm(file_path) >= 0 4713 && (search_ctx->ffsc_find_what 4714 == FINDFILE_BOTH 4715 || ((search_ctx->ffsc_find_what 4716 == FINDFILE_DIR) 4717 == mch_isdir(file_path))))) 4718 #ifndef FF_VERBOSE 4719 && (ff_check_visited( 4720 &search_ctx->ffsc_visited_list->ffvl_visited_list, 4721 file_path 4722 #ifdef FEAT_PATH_EXTRA 4723 , (char_u *)"" 4724 #endif 4725 ) == OK) 4726 #endif 4727 ) 4728 { 4729 #ifdef FF_VERBOSE 4730 if (ff_check_visited( 4731 &search_ctx->ffsc_visited_list->ffvl_visited_list, 4732 file_path 4733 #ifdef FEAT_PATH_EXTRA 4734 , (char_u *)"" 4735 #endif 4736 ) == FAIL) 4737 { 4738 if (p_verbose >= 5) 4739 { 4740 verbose_enter_scroll(); 4741 smsg((char_u *)"Already: %s", 4742 file_path); 4743 /* don't overwrite this either */ 4744 msg_puts((char_u *)"\n"); 4745 verbose_leave_scroll(); 4746 } 4747 continue; 4748 } 4749 #endif 4750 4751 /* push dir to examine rest of subdirs later */ 4752 stackp->ffs_filearray_cur = i + 1; 4753 ff_push(search_ctx, stackp); 4754 4755 if (!path_with_url(file_path)) 4756 simplify_filename(file_path); 4757 if (mch_dirname(ff_expand_buffer, MAXPATHL) 4758 == OK) 4759 { 4760 p = shorten_fname(file_path, 4761 ff_expand_buffer); 4762 if (p != NULL) 4763 STRMOVE(file_path, p); 4764 } 4765 #ifdef FF_VERBOSE 4766 if (p_verbose >= 5) 4767 { 4768 verbose_enter_scroll(); 4769 smsg((char_u *)"HIT: %s", file_path); 4770 /* don't overwrite this either */ 4771 msg_puts((char_u *)"\n"); 4772 verbose_leave_scroll(); 4773 } 4774 #endif 4775 return file_path; 4776 } 4777 4778 #ifdef FEAT_SEARCHPATH 4779 /* Not found or found already, try next suffix. */ 4780 if (*suf == NUL) 4781 break; 4782 copy_option_part(&suf, file_path + len, 4783 MAXPATHL - len, ","); 4784 #endif 4785 } 4786 } 4787 } 4788 #ifdef FEAT_PATH_EXTRA 4789 else 4790 { 4791 /* 4792 * still wildcards left, push the directories for further 4793 * search 4794 */ 4795 for (i = stackp->ffs_filearray_cur; 4796 i < stackp->ffs_filearray_size; ++i) 4797 { 4798 if (!mch_isdir(stackp->ffs_filearray[i])) 4799 continue; /* not a directory */ 4800 4801 ff_push(search_ctx, 4802 ff_create_stack_element( 4803 stackp->ffs_filearray[i], 4804 rest_of_wildcards, 4805 stackp->ffs_level - 1, 0)); 4806 } 4807 } 4808 #endif 4809 stackp->ffs_filearray_cur = 0; 4810 stackp->ffs_stage = 1; 4811 } 4812 4813 #ifdef FEAT_PATH_EXTRA 4814 /* 4815 * if wildcards contains '**' we have to descent till we reach the 4816 * leaves of the directory tree. 4817 */ 4818 if (STRNCMP(stackp->ffs_wc_path, "**", 2) == 0) 4819 { 4820 for (i = stackp->ffs_filearray_cur; 4821 i < stackp->ffs_filearray_size; ++i) 4822 { 4823 if (fnamecmp(stackp->ffs_filearray[i], 4824 stackp->ffs_fix_path) == 0) 4825 continue; /* don't repush same directory */ 4826 if (!mch_isdir(stackp->ffs_filearray[i])) 4827 continue; /* not a directory */ 4828 ff_push(search_ctx, 4829 ff_create_stack_element(stackp->ffs_filearray[i], 4830 stackp->ffs_wc_path, stackp->ffs_level - 1, 1)); 4831 } 4832 } 4833 #endif 4834 4835 /* we are done with the current directory */ 4836 ff_free_stack_element(stackp); 4837 4838 } 4839 4840 #ifdef FEAT_PATH_EXTRA 4841 /* If we reached this, we didn't find anything downwards. 4842 * Let's check if we should do an upward search. 4843 */ 4844 if (search_ctx->ffsc_start_dir 4845 && search_ctx->ffsc_stopdirs_v != NULL && !got_int) 4846 { 4847 ff_stack_T *sptr; 4848 4849 /* is the last starting directory in the stop list? */ 4850 if (ff_path_in_stoplist(search_ctx->ffsc_start_dir, 4851 (int)(path_end - search_ctx->ffsc_start_dir), 4852 search_ctx->ffsc_stopdirs_v) == TRUE) 4853 break; 4854 4855 /* cut of last dir */ 4856 while (path_end > search_ctx->ffsc_start_dir 4857 && vim_ispathsep(*path_end)) 4858 path_end--; 4859 while (path_end > search_ctx->ffsc_start_dir 4860 && !vim_ispathsep(path_end[-1])) 4861 path_end--; 4862 *path_end = 0; 4863 path_end--; 4864 4865 if (*search_ctx->ffsc_start_dir == 0) 4866 break; 4867 4868 STRCPY(file_path, search_ctx->ffsc_start_dir); 4869 add_pathsep(file_path); 4870 STRCAT(file_path, search_ctx->ffsc_fix_path); 4871 4872 /* create a new stack entry */ 4873 sptr = ff_create_stack_element(file_path, 4874 search_ctx->ffsc_wc_path, search_ctx->ffsc_level, 0); 4875 if (sptr == NULL) 4876 break; 4877 ff_push(search_ctx, sptr); 4878 } 4879 else 4880 break; 4881 } 4882 #endif 4883 4884 vim_free(file_path); 4885 return NULL; 4886 } 4887 4888 /* 4889 * Free the list of lists of visited files and directories 4890 * Can handle it if the passed search_context is NULL; 4891 */ 4892 void 4893 vim_findfile_free_visited(void *search_ctx_arg) 4894 { 4895 ff_search_ctx_T *search_ctx; 4896 4897 if (search_ctx_arg == NULL) 4898 return; 4899 4900 search_ctx = (ff_search_ctx_T *)search_ctx_arg; 4901 vim_findfile_free_visited_list(&search_ctx->ffsc_visited_lists_list); 4902 vim_findfile_free_visited_list(&search_ctx->ffsc_dir_visited_lists_list); 4903 } 4904 4905 static void 4906 vim_findfile_free_visited_list(ff_visited_list_hdr_T **list_headp) 4907 { 4908 ff_visited_list_hdr_T *vp; 4909 4910 while (*list_headp != NULL) 4911 { 4912 vp = (*list_headp)->ffvl_next; 4913 ff_free_visited_list((*list_headp)->ffvl_visited_list); 4914 4915 vim_free((*list_headp)->ffvl_filename); 4916 vim_free(*list_headp); 4917 *list_headp = vp; 4918 } 4919 *list_headp = NULL; 4920 } 4921 4922 static void 4923 ff_free_visited_list(ff_visited_T *vl) 4924 { 4925 ff_visited_T *vp; 4926 4927 while (vl != NULL) 4928 { 4929 vp = vl->ffv_next; 4930 #ifdef FEAT_PATH_EXTRA 4931 vim_free(vl->ffv_wc_path); 4932 #endif 4933 vim_free(vl); 4934 vl = vp; 4935 } 4936 vl = NULL; 4937 } 4938 4939 /* 4940 * Returns the already visited list for the given filename. If none is found it 4941 * allocates a new one. 4942 */ 4943 static ff_visited_list_hdr_T* 4944 ff_get_visited_list( 4945 char_u *filename, 4946 ff_visited_list_hdr_T **list_headp) 4947 { 4948 ff_visited_list_hdr_T *retptr = NULL; 4949 4950 /* check if a visited list for the given filename exists */ 4951 if (*list_headp != NULL) 4952 { 4953 retptr = *list_headp; 4954 while (retptr != NULL) 4955 { 4956 if (fnamecmp(filename, retptr->ffvl_filename) == 0) 4957 { 4958 #ifdef FF_VERBOSE 4959 if (p_verbose >= 5) 4960 { 4961 verbose_enter_scroll(); 4962 smsg((char_u *)"ff_get_visited_list: FOUND list for %s", 4963 filename); 4964 /* don't overwrite this either */ 4965 msg_puts((char_u *)"\n"); 4966 verbose_leave_scroll(); 4967 } 4968 #endif 4969 return retptr; 4970 } 4971 retptr = retptr->ffvl_next; 4972 } 4973 } 4974 4975 #ifdef FF_VERBOSE 4976 if (p_verbose >= 5) 4977 { 4978 verbose_enter_scroll(); 4979 smsg((char_u *)"ff_get_visited_list: new list for %s", filename); 4980 /* don't overwrite this either */ 4981 msg_puts((char_u *)"\n"); 4982 verbose_leave_scroll(); 4983 } 4984 #endif 4985 4986 /* 4987 * if we reach this we didn't find a list and we have to allocate new list 4988 */ 4989 retptr = (ff_visited_list_hdr_T*)alloc((unsigned)sizeof(*retptr)); 4990 if (retptr == NULL) 4991 return NULL; 4992 4993 retptr->ffvl_visited_list = NULL; 4994 retptr->ffvl_filename = vim_strsave(filename); 4995 if (retptr->ffvl_filename == NULL) 4996 { 4997 vim_free(retptr); 4998 return NULL; 4999 } 5000 retptr->ffvl_next = *list_headp; 5001 *list_headp = retptr; 5002 5003 return retptr; 5004 } 5005 5006 #ifdef FEAT_PATH_EXTRA 5007 /* 5008 * check if two wildcard paths are equal. Returns TRUE or FALSE. 5009 * They are equal if: 5010 * - both paths are NULL 5011 * - they have the same length 5012 * - char by char comparison is OK 5013 * - the only differences are in the counters behind a '**', so 5014 * '**\20' is equal to '**\24' 5015 */ 5016 static int 5017 ff_wc_equal(char_u *s1, char_u *s2) 5018 { 5019 int i, j; 5020 int c1 = NUL; 5021 int c2 = NUL; 5022 int prev1 = NUL; 5023 int prev2 = NUL; 5024 5025 if (s1 == s2) 5026 return TRUE; 5027 5028 if (s1 == NULL || s2 == NULL) 5029 return FALSE; 5030 5031 for (i = 0, j = 0; s1[i] != NUL && s2[j] != NUL;) 5032 { 5033 c1 = PTR2CHAR(s1 + i); 5034 c2 = PTR2CHAR(s2 + j); 5035 5036 if ((p_fic ? MB_TOLOWER(c1) != MB_TOLOWER(c2) : c1 != c2) 5037 && (prev1 != '*' || prev2 != '*')) 5038 return FALSE; 5039 prev2 = prev1; 5040 prev1 = c1; 5041 5042 i += MB_PTR2LEN(s1 + i); 5043 j += MB_PTR2LEN(s2 + j); 5044 } 5045 return s1[i] == s2[j]; 5046 } 5047 #endif 5048 5049 /* 5050 * maintains the list of already visited files and dirs 5051 * returns FAIL if the given file/dir is already in the list 5052 * returns OK if it is newly added 5053 * 5054 * TODO: What to do on memory allocation problems? 5055 * -> return TRUE - Better the file is found several times instead of 5056 * never. 5057 */ 5058 static int 5059 ff_check_visited( 5060 ff_visited_T **visited_list, 5061 char_u *fname 5062 #ifdef FEAT_PATH_EXTRA 5063 , char_u *wc_path 5064 #endif 5065 ) 5066 { 5067 ff_visited_T *vp; 5068 #ifdef UNIX 5069 stat_T st; 5070 int url = FALSE; 5071 #endif 5072 5073 /* For an URL we only compare the name, otherwise we compare the 5074 * device/inode (unix) or the full path name (not Unix). */ 5075 if (path_with_url(fname)) 5076 { 5077 vim_strncpy(ff_expand_buffer, fname, MAXPATHL - 1); 5078 #ifdef UNIX 5079 url = TRUE; 5080 #endif 5081 } 5082 else 5083 { 5084 ff_expand_buffer[0] = NUL; 5085 #ifdef UNIX 5086 if (mch_stat((char *)fname, &st) < 0) 5087 #else 5088 if (vim_FullName(fname, ff_expand_buffer, MAXPATHL, TRUE) == FAIL) 5089 #endif 5090 return FAIL; 5091 } 5092 5093 /* check against list of already visited files */ 5094 for (vp = *visited_list; vp != NULL; vp = vp->ffv_next) 5095 { 5096 if ( 5097 #ifdef UNIX 5098 !url ? (vp->ffv_dev_valid && vp->ffv_dev == st.st_dev 5099 && vp->ffv_ino == st.st_ino) 5100 : 5101 #endif 5102 fnamecmp(vp->ffv_fname, ff_expand_buffer) == 0 5103 ) 5104 { 5105 #ifdef FEAT_PATH_EXTRA 5106 /* are the wildcard parts equal */ 5107 if (ff_wc_equal(vp->ffv_wc_path, wc_path) == TRUE) 5108 #endif 5109 /* already visited */ 5110 return FAIL; 5111 } 5112 } 5113 5114 /* 5115 * New file/dir. Add it to the list of visited files/dirs. 5116 */ 5117 vp = (ff_visited_T *)alloc((unsigned)(sizeof(ff_visited_T) 5118 + STRLEN(ff_expand_buffer))); 5119 5120 if (vp != NULL) 5121 { 5122 #ifdef UNIX 5123 if (!url) 5124 { 5125 vp->ffv_dev_valid = TRUE; 5126 vp->ffv_ino = st.st_ino; 5127 vp->ffv_dev = st.st_dev; 5128 vp->ffv_fname[0] = NUL; 5129 } 5130 else 5131 { 5132 vp->ffv_dev_valid = FALSE; 5133 #endif 5134 STRCPY(vp->ffv_fname, ff_expand_buffer); 5135 #ifdef UNIX 5136 } 5137 #endif 5138 #ifdef FEAT_PATH_EXTRA 5139 if (wc_path != NULL) 5140 vp->ffv_wc_path = vim_strsave(wc_path); 5141 else 5142 vp->ffv_wc_path = NULL; 5143 #endif 5144 5145 vp->ffv_next = *visited_list; 5146 *visited_list = vp; 5147 } 5148 5149 return OK; 5150 } 5151 5152 /* 5153 * create stack element from given path pieces 5154 */ 5155 static ff_stack_T * 5156 ff_create_stack_element( 5157 char_u *fix_part, 5158 #ifdef FEAT_PATH_EXTRA 5159 char_u *wc_part, 5160 #endif 5161 int level, 5162 int star_star_empty) 5163 { 5164 ff_stack_T *new; 5165 5166 new = (ff_stack_T *)alloc((unsigned)sizeof(ff_stack_T)); 5167 if (new == NULL) 5168 return NULL; 5169 5170 new->ffs_prev = NULL; 5171 new->ffs_filearray = NULL; 5172 new->ffs_filearray_size = 0; 5173 new->ffs_filearray_cur = 0; 5174 new->ffs_stage = 0; 5175 new->ffs_level = level; 5176 new->ffs_star_star_empty = star_star_empty; 5177 5178 /* the following saves NULL pointer checks in vim_findfile */ 5179 if (fix_part == NULL) 5180 fix_part = (char_u *)""; 5181 new->ffs_fix_path = vim_strsave(fix_part); 5182 5183 #ifdef FEAT_PATH_EXTRA 5184 if (wc_part == NULL) 5185 wc_part = (char_u *)""; 5186 new->ffs_wc_path = vim_strsave(wc_part); 5187 #endif 5188 5189 if (new->ffs_fix_path == NULL 5190 #ifdef FEAT_PATH_EXTRA 5191 || new->ffs_wc_path == NULL 5192 #endif 5193 ) 5194 { 5195 ff_free_stack_element(new); 5196 new = NULL; 5197 } 5198 5199 return new; 5200 } 5201 5202 /* 5203 * Push a dir on the directory stack. 5204 */ 5205 static void 5206 ff_push(ff_search_ctx_T *search_ctx, ff_stack_T *stack_ptr) 5207 { 5208 /* check for NULL pointer, not to return an error to the user, but 5209 * to prevent a crash */ 5210 if (stack_ptr != NULL) 5211 { 5212 stack_ptr->ffs_prev = search_ctx->ffsc_stack_ptr; 5213 search_ctx->ffsc_stack_ptr = stack_ptr; 5214 } 5215 } 5216 5217 /* 5218 * Pop a dir from the directory stack. 5219 * Returns NULL if stack is empty. 5220 */ 5221 static ff_stack_T * 5222 ff_pop(ff_search_ctx_T *search_ctx) 5223 { 5224 ff_stack_T *sptr; 5225 5226 sptr = search_ctx->ffsc_stack_ptr; 5227 if (search_ctx->ffsc_stack_ptr != NULL) 5228 search_ctx->ffsc_stack_ptr = search_ctx->ffsc_stack_ptr->ffs_prev; 5229 5230 return sptr; 5231 } 5232 5233 /* 5234 * free the given stack element 5235 */ 5236 static void 5237 ff_free_stack_element(ff_stack_T *stack_ptr) 5238 { 5239 /* vim_free handles possible NULL pointers */ 5240 vim_free(stack_ptr->ffs_fix_path); 5241 #ifdef FEAT_PATH_EXTRA 5242 vim_free(stack_ptr->ffs_wc_path); 5243 #endif 5244 5245 if (stack_ptr->ffs_filearray != NULL) 5246 FreeWild(stack_ptr->ffs_filearray_size, stack_ptr->ffs_filearray); 5247 5248 vim_free(stack_ptr); 5249 } 5250 5251 /* 5252 * Clear the search context, but NOT the visited list. 5253 */ 5254 static void 5255 ff_clear(ff_search_ctx_T *search_ctx) 5256 { 5257 ff_stack_T *sptr; 5258 5259 /* clear up stack */ 5260 while ((sptr = ff_pop(search_ctx)) != NULL) 5261 ff_free_stack_element(sptr); 5262 5263 vim_free(search_ctx->ffsc_file_to_search); 5264 vim_free(search_ctx->ffsc_start_dir); 5265 vim_free(search_ctx->ffsc_fix_path); 5266 #ifdef FEAT_PATH_EXTRA 5267 vim_free(search_ctx->ffsc_wc_path); 5268 #endif 5269 5270 #ifdef FEAT_PATH_EXTRA 5271 if (search_ctx->ffsc_stopdirs_v != NULL) 5272 { 5273 int i = 0; 5274 5275 while (search_ctx->ffsc_stopdirs_v[i] != NULL) 5276 { 5277 vim_free(search_ctx->ffsc_stopdirs_v[i]); 5278 i++; 5279 } 5280 vim_free(search_ctx->ffsc_stopdirs_v); 5281 } 5282 search_ctx->ffsc_stopdirs_v = NULL; 5283 #endif 5284 5285 /* reset everything */ 5286 search_ctx->ffsc_file_to_search = NULL; 5287 search_ctx->ffsc_start_dir = NULL; 5288 search_ctx->ffsc_fix_path = NULL; 5289 #ifdef FEAT_PATH_EXTRA 5290 search_ctx->ffsc_wc_path = NULL; 5291 search_ctx->ffsc_level = 0; 5292 #endif 5293 } 5294 5295 #ifdef FEAT_PATH_EXTRA 5296 /* 5297 * check if the given path is in the stopdirs 5298 * returns TRUE if yes else FALSE 5299 */ 5300 static int 5301 ff_path_in_stoplist(char_u *path, int path_len, char_u **stopdirs_v) 5302 { 5303 int i = 0; 5304 5305 /* eat up trailing path separators, except the first */ 5306 while (path_len > 1 && vim_ispathsep(path[path_len - 1])) 5307 path_len--; 5308 5309 /* if no path consider it as match */ 5310 if (path_len == 0) 5311 return TRUE; 5312 5313 for (i = 0; stopdirs_v[i] != NULL; i++) 5314 { 5315 if ((int)STRLEN(stopdirs_v[i]) > path_len) 5316 { 5317 /* match for parent directory. So '/home' also matches 5318 * '/home/rks'. Check for PATHSEP in stopdirs_v[i], else 5319 * '/home/r' would also match '/home/rks' 5320 */ 5321 if (fnamencmp(stopdirs_v[i], path, path_len) == 0 5322 && vim_ispathsep(stopdirs_v[i][path_len])) 5323 return TRUE; 5324 } 5325 else 5326 { 5327 if (fnamecmp(stopdirs_v[i], path) == 0) 5328 return TRUE; 5329 } 5330 } 5331 return FALSE; 5332 } 5333 #endif 5334 5335 #if defined(FEAT_SEARCHPATH) || defined(PROTO) 5336 /* 5337 * Find the file name "ptr[len]" in the path. Also finds directory names. 5338 * 5339 * On the first call set the parameter 'first' to TRUE to initialize 5340 * the search. For repeating calls to FALSE. 5341 * 5342 * Repeating calls will return other files called 'ptr[len]' from the path. 5343 * 5344 * Only on the first call 'ptr' and 'len' are used. For repeating calls they 5345 * don't need valid values. 5346 * 5347 * If nothing found on the first call the option FNAME_MESS will issue the 5348 * message: 5349 * 'Can't find file "<file>" in path' 5350 * On repeating calls: 5351 * 'No more file "<file>" found in path' 5352 * 5353 * options: 5354 * FNAME_MESS give error message when not found 5355 * 5356 * Uses NameBuff[]! 5357 * 5358 * Returns an allocated string for the file name. NULL for error. 5359 * 5360 */ 5361 char_u * 5362 find_file_in_path( 5363 char_u *ptr, /* file name */ 5364 int len, /* length of file name */ 5365 int options, 5366 int first, /* use count'th matching file name */ 5367 char_u *rel_fname) /* file name searching relative to */ 5368 { 5369 return find_file_in_path_option(ptr, len, options, first, 5370 *curbuf->b_p_path == NUL ? p_path : curbuf->b_p_path, 5371 FINDFILE_BOTH, rel_fname, curbuf->b_p_sua); 5372 } 5373 5374 static char_u *ff_file_to_find = NULL; 5375 static void *fdip_search_ctx = NULL; 5376 5377 #if defined(EXITFREE) 5378 static void 5379 free_findfile(void) 5380 { 5381 vim_free(ff_file_to_find); 5382 vim_findfile_cleanup(fdip_search_ctx); 5383 } 5384 #endif 5385 5386 /* 5387 * Find the directory name "ptr[len]" in the path. 5388 * 5389 * options: 5390 * FNAME_MESS give error message when not found 5391 * FNAME_UNESC unescape backslashes. 5392 * 5393 * Uses NameBuff[]! 5394 * 5395 * Returns an allocated string for the file name. NULL for error. 5396 */ 5397 char_u * 5398 find_directory_in_path( 5399 char_u *ptr, /* file name */ 5400 int len, /* length of file name */ 5401 int options, 5402 char_u *rel_fname) /* file name searching relative to */ 5403 { 5404 return find_file_in_path_option(ptr, len, options, TRUE, p_cdpath, 5405 FINDFILE_DIR, rel_fname, (char_u *)""); 5406 } 5407 5408 char_u * 5409 find_file_in_path_option( 5410 char_u *ptr, /* file name */ 5411 int len, /* length of file name */ 5412 int options, 5413 int first, /* use count'th matching file name */ 5414 char_u *path_option, /* p_path or p_cdpath */ 5415 int find_what, /* FINDFILE_FILE, _DIR or _BOTH */ 5416 char_u *rel_fname, /* file name we are looking relative to. */ 5417 char_u *suffixes) /* list of suffixes, 'suffixesadd' option */ 5418 { 5419 static char_u *dir; 5420 static int did_findfile_init = FALSE; 5421 char_u save_char; 5422 char_u *file_name = NULL; 5423 char_u *buf = NULL; 5424 int rel_to_curdir; 5425 #ifdef AMIGA 5426 struct Process *proc = (struct Process *)FindTask(0L); 5427 APTR save_winptr = proc->pr_WindowPtr; 5428 5429 /* Avoid a requester here for a volume that doesn't exist. */ 5430 proc->pr_WindowPtr = (APTR)-1L; 5431 #endif 5432 5433 if (first == TRUE) 5434 { 5435 /* copy file name into NameBuff, expanding environment variables */ 5436 save_char = ptr[len]; 5437 ptr[len] = NUL; 5438 expand_env_esc(ptr, NameBuff, MAXPATHL, FALSE, TRUE, NULL); 5439 ptr[len] = save_char; 5440 5441 vim_free(ff_file_to_find); 5442 ff_file_to_find = vim_strsave(NameBuff); 5443 if (ff_file_to_find == NULL) /* out of memory */ 5444 { 5445 file_name = NULL; 5446 goto theend; 5447 } 5448 if (options & FNAME_UNESC) 5449 { 5450 /* Change all "\ " to " ". */ 5451 for (ptr = ff_file_to_find; *ptr != NUL; ++ptr) 5452 if (ptr[0] == '\\' && ptr[1] == ' ') 5453 mch_memmove(ptr, ptr + 1, STRLEN(ptr)); 5454 } 5455 } 5456 5457 rel_to_curdir = (ff_file_to_find[0] == '.' 5458 && (ff_file_to_find[1] == NUL 5459 || vim_ispathsep(ff_file_to_find[1]) 5460 || (ff_file_to_find[1] == '.' 5461 && (ff_file_to_find[2] == NUL 5462 || vim_ispathsep(ff_file_to_find[2]))))); 5463 if (vim_isAbsName(ff_file_to_find) 5464 /* "..", "../path", "." and "./path": don't use the path_option */ 5465 || rel_to_curdir 5466 #if defined(MSWIN) 5467 /* handle "\tmp" as absolute path */ 5468 || vim_ispathsep(ff_file_to_find[0]) 5469 /* handle "c:name" as absolute path */ 5470 || (ff_file_to_find[0] != NUL && ff_file_to_find[1] == ':') 5471 #endif 5472 #ifdef AMIGA 5473 /* handle ":tmp" as absolute path */ 5474 || ff_file_to_find[0] == ':' 5475 #endif 5476 ) 5477 { 5478 /* 5479 * Absolute path, no need to use "path_option". 5480 * If this is not a first call, return NULL. We already returned a 5481 * filename on the first call. 5482 */ 5483 if (first == TRUE) 5484 { 5485 int l; 5486 int run; 5487 5488 if (path_with_url(ff_file_to_find)) 5489 { 5490 file_name = vim_strsave(ff_file_to_find); 5491 goto theend; 5492 } 5493 5494 /* When FNAME_REL flag given first use the directory of the file. 5495 * Otherwise or when this fails use the current directory. */ 5496 for (run = 1; run <= 2; ++run) 5497 { 5498 l = (int)STRLEN(ff_file_to_find); 5499 if (run == 1 5500 && rel_to_curdir 5501 && (options & FNAME_REL) 5502 && rel_fname != NULL 5503 && STRLEN(rel_fname) + l < MAXPATHL) 5504 { 5505 STRCPY(NameBuff, rel_fname); 5506 STRCPY(gettail(NameBuff), ff_file_to_find); 5507 l = (int)STRLEN(NameBuff); 5508 } 5509 else 5510 { 5511 STRCPY(NameBuff, ff_file_to_find); 5512 run = 2; 5513 } 5514 5515 /* When the file doesn't exist, try adding parts of 5516 * 'suffixesadd'. */ 5517 buf = suffixes; 5518 for (;;) 5519 { 5520 if (mch_getperm(NameBuff) >= 0 5521 && (find_what == FINDFILE_BOTH 5522 || ((find_what == FINDFILE_DIR) 5523 == mch_isdir(NameBuff)))) 5524 { 5525 file_name = vim_strsave(NameBuff); 5526 goto theend; 5527 } 5528 if (*buf == NUL) 5529 break; 5530 copy_option_part(&buf, NameBuff + l, MAXPATHL - l, ","); 5531 } 5532 } 5533 } 5534 } 5535 else 5536 { 5537 /* 5538 * Loop over all paths in the 'path' or 'cdpath' option. 5539 * When "first" is set, first setup to the start of the option. 5540 * Otherwise continue to find the next match. 5541 */ 5542 if (first == TRUE) 5543 { 5544 /* vim_findfile_free_visited can handle a possible NULL pointer */ 5545 vim_findfile_free_visited(fdip_search_ctx); 5546 dir = path_option; 5547 did_findfile_init = FALSE; 5548 } 5549 5550 for (;;) 5551 { 5552 if (did_findfile_init) 5553 { 5554 file_name = vim_findfile(fdip_search_ctx); 5555 if (file_name != NULL) 5556 break; 5557 5558 did_findfile_init = FALSE; 5559 } 5560 else 5561 { 5562 char_u *r_ptr; 5563 5564 if (dir == NULL || *dir == NUL) 5565 { 5566 /* We searched all paths of the option, now we can 5567 * free the search context. */ 5568 vim_findfile_cleanup(fdip_search_ctx); 5569 fdip_search_ctx = NULL; 5570 break; 5571 } 5572 5573 if ((buf = alloc((int)(MAXPATHL))) == NULL) 5574 break; 5575 5576 /* copy next path */ 5577 buf[0] = 0; 5578 copy_option_part(&dir, buf, MAXPATHL, " ,"); 5579 5580 #ifdef FEAT_PATH_EXTRA 5581 /* get the stopdir string */ 5582 r_ptr = vim_findfile_stopdir(buf); 5583 #else 5584 r_ptr = NULL; 5585 #endif 5586 fdip_search_ctx = vim_findfile_init(buf, ff_file_to_find, 5587 r_ptr, 100, FALSE, find_what, 5588 fdip_search_ctx, FALSE, rel_fname); 5589 if (fdip_search_ctx != NULL) 5590 did_findfile_init = TRUE; 5591 vim_free(buf); 5592 } 5593 } 5594 } 5595 if (file_name == NULL && (options & FNAME_MESS)) 5596 { 5597 if (first == TRUE) 5598 { 5599 if (find_what == FINDFILE_DIR) 5600 EMSG2(_("E344: Can't find directory \"%s\" in cdpath"), 5601 ff_file_to_find); 5602 else 5603 EMSG2(_("E345: Can't find file \"%s\" in path"), 5604 ff_file_to_find); 5605 } 5606 else 5607 { 5608 if (find_what == FINDFILE_DIR) 5609 EMSG2(_("E346: No more directory \"%s\" found in cdpath"), 5610 ff_file_to_find); 5611 else 5612 EMSG2(_("E347: No more file \"%s\" found in path"), 5613 ff_file_to_find); 5614 } 5615 } 5616 5617 theend: 5618 #ifdef AMIGA 5619 proc->pr_WindowPtr = save_winptr; 5620 #endif 5621 return file_name; 5622 } 5623 5624 #endif /* FEAT_SEARCHPATH */ 5625 5626 /* 5627 * Change directory to "new_dir". If FEAT_SEARCHPATH is defined, search 5628 * 'cdpath' for relative directory names, otherwise just mch_chdir(). 5629 */ 5630 int 5631 vim_chdir(char_u *new_dir) 5632 { 5633 #ifndef FEAT_SEARCHPATH 5634 return mch_chdir((char *)new_dir); 5635 #else 5636 char_u *dir_name; 5637 int r; 5638 5639 dir_name = find_directory_in_path(new_dir, (int)STRLEN(new_dir), 5640 FNAME_MESS, curbuf->b_ffname); 5641 if (dir_name == NULL) 5642 return -1; 5643 r = mch_chdir((char *)dir_name); 5644 vim_free(dir_name); 5645 return r; 5646 #endif 5647 } 5648 5649 /* 5650 * Get user name from machine-specific function. 5651 * Returns the user name in "buf[len]". 5652 * Some systems are quite slow in obtaining the user name (Windows NT), thus 5653 * cache the result. 5654 * Returns OK or FAIL. 5655 */ 5656 int 5657 get_user_name(char_u *buf, int len) 5658 { 5659 if (username == NULL) 5660 { 5661 if (mch_get_user_name(buf, len) == FAIL) 5662 return FAIL; 5663 username = vim_strsave(buf); 5664 } 5665 else 5666 vim_strncpy(buf, username, len - 1); 5667 return OK; 5668 } 5669 5670 #ifndef HAVE_QSORT 5671 /* 5672 * Our own qsort(), for systems that don't have it. 5673 * It's simple and slow. From the K&R C book. 5674 */ 5675 void 5676 qsort( 5677 void *base, 5678 size_t elm_count, 5679 size_t elm_size, 5680 int (*cmp)(const void *, const void *)) 5681 { 5682 char_u *buf; 5683 char_u *p1; 5684 char_u *p2; 5685 int i, j; 5686 int gap; 5687 5688 buf = alloc((unsigned)elm_size); 5689 if (buf == NULL) 5690 return; 5691 5692 for (gap = elm_count / 2; gap > 0; gap /= 2) 5693 for (i = gap; i < elm_count; ++i) 5694 for (j = i - gap; j >= 0; j -= gap) 5695 { 5696 /* Compare the elements. */ 5697 p1 = (char_u *)base + j * elm_size; 5698 p2 = (char_u *)base + (j + gap) * elm_size; 5699 if ((*cmp)((void *)p1, (void *)p2) <= 0) 5700 break; 5701 /* Exchange the elements. */ 5702 mch_memmove(buf, p1, elm_size); 5703 mch_memmove(p1, p2, elm_size); 5704 mch_memmove(p2, buf, elm_size); 5705 } 5706 5707 vim_free(buf); 5708 } 5709 #endif 5710 5711 /* 5712 * Sort an array of strings. 5713 */ 5714 static int 5715 #ifdef __BORLANDC__ 5716 _RTLENTRYF 5717 #endif 5718 sort_compare(const void *s1, const void *s2); 5719 5720 static int 5721 #ifdef __BORLANDC__ 5722 _RTLENTRYF 5723 #endif 5724 sort_compare(const void *s1, const void *s2) 5725 { 5726 return STRCMP(*(char **)s1, *(char **)s2); 5727 } 5728 5729 void 5730 sort_strings( 5731 char_u **files, 5732 int count) 5733 { 5734 qsort((void *)files, (size_t)count, sizeof(char_u *), sort_compare); 5735 } 5736 5737 #if !defined(NO_EXPANDPATH) || defined(PROTO) 5738 /* 5739 * Compare path "p[]" to "q[]". 5740 * If "maxlen" >= 0 compare "p[maxlen]" to "q[maxlen]" 5741 * Return value like strcmp(p, q), but consider path separators. 5742 */ 5743 int 5744 pathcmp(const char *p, const char *q, int maxlen) 5745 { 5746 int i, j; 5747 int c1, c2; 5748 const char *s = NULL; 5749 5750 for (i = 0, j = 0; maxlen < 0 || (i < maxlen && j < maxlen);) 5751 { 5752 c1 = PTR2CHAR((char_u *)p + i); 5753 c2 = PTR2CHAR((char_u *)q + j); 5754 5755 /* End of "p": check if "q" also ends or just has a slash. */ 5756 if (c1 == NUL) 5757 { 5758 if (c2 == NUL) /* full match */ 5759 return 0; 5760 s = q; 5761 i = j; 5762 break; 5763 } 5764 5765 /* End of "q": check if "p" just has a slash. */ 5766 if (c2 == NUL) 5767 { 5768 s = p; 5769 break; 5770 } 5771 5772 if ((p_fic ? MB_TOUPPER(c1) != MB_TOUPPER(c2) : c1 != c2) 5773 #ifdef BACKSLASH_IN_FILENAME 5774 /* consider '/' and '\\' to be equal */ 5775 && !((c1 == '/' && c2 == '\\') 5776 || (c1 == '\\' && c2 == '/')) 5777 #endif 5778 ) 5779 { 5780 if (vim_ispathsep(c1)) 5781 return -1; 5782 if (vim_ispathsep(c2)) 5783 return 1; 5784 return p_fic ? MB_TOUPPER(c1) - MB_TOUPPER(c2) 5785 : c1 - c2; /* no match */ 5786 } 5787 5788 i += MB_PTR2LEN((char_u *)p + i); 5789 j += MB_PTR2LEN((char_u *)q + j); 5790 } 5791 if (s == NULL) /* "i" or "j" ran into "maxlen" */ 5792 return 0; 5793 5794 c1 = PTR2CHAR((char_u *)s + i); 5795 c2 = PTR2CHAR((char_u *)s + i + MB_PTR2LEN((char_u *)s + i)); 5796 /* ignore a trailing slash, but not "//" or ":/" */ 5797 if (c2 == NUL 5798 && i > 0 5799 && !after_pathsep((char_u *)s, (char_u *)s + i) 5800 #ifdef BACKSLASH_IN_FILENAME 5801 && (c1 == '/' || c1 == '\\') 5802 #else 5803 && c1 == '/' 5804 #endif 5805 ) 5806 return 0; /* match with trailing slash */ 5807 if (s == q) 5808 return -1; /* no match */ 5809 return 1; 5810 } 5811 #endif 5812 5813 /* 5814 * The putenv() implementation below comes from the "screen" program. 5815 * Included with permission from Juergen Weigert. 5816 * See pty.c for the copyright notice. 5817 */ 5818 5819 /* 5820 * putenv -- put value into environment 5821 * 5822 * Usage: i = putenv (string) 5823 * int i; 5824 * char *string; 5825 * 5826 * where string is of the form <name>=<value>. 5827 * Putenv returns 0 normally, -1 on error (not enough core for malloc). 5828 * 5829 * Putenv may need to add a new name into the environment, or to 5830 * associate a value longer than the current value with a particular 5831 * name. So, to make life simpler, putenv() copies your entire 5832 * environment into the heap (i.e. malloc()) from the stack 5833 * (i.e. where it resides when your process is initiated) the first 5834 * time you call it. 5835 * 5836 * (history removed, not very interesting. See the "screen" sources.) 5837 */ 5838 5839 #if !defined(HAVE_SETENV) && !defined(HAVE_PUTENV) 5840 5841 #define EXTRASIZE 5 /* increment to add to env. size */ 5842 5843 static int envsize = -1; /* current size of environment */ 5844 #ifndef MACOS_CLASSIC 5845 extern 5846 #endif 5847 char **environ; /* the global which is your env. */ 5848 5849 static int findenv(char *name); /* look for a name in the env. */ 5850 static int newenv(void); /* copy env. from stack to heap */ 5851 static int moreenv(void); /* incr. size of env. */ 5852 5853 int 5854 putenv(const char *string) 5855 { 5856 int i; 5857 char *p; 5858 5859 if (envsize < 0) 5860 { /* first time putenv called */ 5861 if (newenv() < 0) /* copy env. to heap */ 5862 return -1; 5863 } 5864 5865 i = findenv((char *)string); /* look for name in environment */ 5866 5867 if (i < 0) 5868 { /* name must be added */ 5869 for (i = 0; environ[i]; i++); 5870 if (i >= (envsize - 1)) 5871 { /* need new slot */ 5872 if (moreenv() < 0) 5873 return -1; 5874 } 5875 p = (char *)alloc((unsigned)(strlen(string) + 1)); 5876 if (p == NULL) /* not enough core */ 5877 return -1; 5878 environ[i + 1] = 0; /* new end of env. */ 5879 } 5880 else 5881 { /* name already in env. */ 5882 p = vim_realloc(environ[i], strlen(string) + 1); 5883 if (p == NULL) 5884 return -1; 5885 } 5886 sprintf(p, "%s", string); /* copy into env. */ 5887 environ[i] = p; 5888 5889 return 0; 5890 } 5891 5892 static int 5893 findenv(char *name) 5894 { 5895 char *namechar, *envchar; 5896 int i, found; 5897 5898 found = 0; 5899 for (i = 0; environ[i] && !found; i++) 5900 { 5901 envchar = environ[i]; 5902 namechar = name; 5903 while (*namechar && *namechar != '=' && (*namechar == *envchar)) 5904 { 5905 namechar++; 5906 envchar++; 5907 } 5908 found = ((*namechar == '\0' || *namechar == '=') && *envchar == '='); 5909 } 5910 return found ? i - 1 : -1; 5911 } 5912 5913 static int 5914 newenv(void) 5915 { 5916 char **env, *elem; 5917 int i, esize; 5918 5919 #ifdef MACOS 5920 /* for Mac a new, empty environment is created */ 5921 i = 0; 5922 #else 5923 for (i = 0; environ[i]; i++) 5924 ; 5925 #endif 5926 esize = i + EXTRASIZE + 1; 5927 env = (char **)alloc((unsigned)(esize * sizeof (elem))); 5928 if (env == NULL) 5929 return -1; 5930 5931 #ifndef MACOS 5932 for (i = 0; environ[i]; i++) 5933 { 5934 elem = (char *)alloc((unsigned)(strlen(environ[i]) + 1)); 5935 if (elem == NULL) 5936 return -1; 5937 env[i] = elem; 5938 strcpy(elem, environ[i]); 5939 } 5940 #endif 5941 5942 env[i] = 0; 5943 environ = env; 5944 envsize = esize; 5945 return 0; 5946 } 5947 5948 static int 5949 moreenv(void) 5950 { 5951 int esize; 5952 char **env; 5953 5954 esize = envsize + EXTRASIZE; 5955 env = (char **)vim_realloc((char *)environ, esize * sizeof (*env)); 5956 if (env == 0) 5957 return -1; 5958 environ = env; 5959 envsize = esize; 5960 return 0; 5961 } 5962 5963 # ifdef USE_VIMPTY_GETENV 5964 char_u * 5965 vimpty_getenv(const char_u *string) 5966 { 5967 int i; 5968 char_u *p; 5969 5970 if (envsize < 0) 5971 return NULL; 5972 5973 i = findenv((char *)string); 5974 5975 if (i < 0) 5976 return NULL; 5977 5978 p = vim_strchr((char_u *)environ[i], '='); 5979 return (p + 1); 5980 } 5981 # endif 5982 5983 #endif /* !defined(HAVE_SETENV) && !defined(HAVE_PUTENV) */ 5984 5985 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO) 5986 /* 5987 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have 5988 * rights to write into. 5989 */ 5990 int 5991 filewritable(char_u *fname) 5992 { 5993 int retval = 0; 5994 #if defined(UNIX) || defined(VMS) 5995 int perm = 0; 5996 #endif 5997 5998 #if defined(UNIX) || defined(VMS) 5999 perm = mch_getperm(fname); 6000 #endif 6001 #ifndef MACOS_CLASSIC /* TODO: get either mch_writable or mch_access */ 6002 if ( 6003 # ifdef WIN3264 6004 mch_writable(fname) && 6005 # else 6006 # if defined(UNIX) || defined(VMS) 6007 (perm & 0222) && 6008 # endif 6009 # endif 6010 mch_access((char *)fname, W_OK) == 0 6011 ) 6012 #endif 6013 { 6014 ++retval; 6015 if (mch_isdir(fname)) 6016 ++retval; 6017 } 6018 return retval; 6019 } 6020 #endif 6021 6022 #if defined(FEAT_SPELL) || defined(FEAT_PERSISTENT_UNDO) || defined(PROTO) 6023 /* 6024 * Read 2 bytes from "fd" and turn them into an int, MSB first. 6025 */ 6026 int 6027 get2c(FILE *fd) 6028 { 6029 int n; 6030 6031 n = getc(fd); 6032 n = (n << 8) + getc(fd); 6033 return n; 6034 } 6035 6036 /* 6037 * Read 3 bytes from "fd" and turn them into an int, MSB first. 6038 */ 6039 int 6040 get3c(FILE *fd) 6041 { 6042 int n; 6043 6044 n = getc(fd); 6045 n = (n << 8) + getc(fd); 6046 n = (n << 8) + getc(fd); 6047 return n; 6048 } 6049 6050 /* 6051 * Read 4 bytes from "fd" and turn them into an int, MSB first. 6052 */ 6053 int 6054 get4c(FILE *fd) 6055 { 6056 /* Use unsigned rather than int otherwise result is undefined 6057 * when left-shift sets the MSB. */ 6058 unsigned n; 6059 6060 n = (unsigned)getc(fd); 6061 n = (n << 8) + (unsigned)getc(fd); 6062 n = (n << 8) + (unsigned)getc(fd); 6063 n = (n << 8) + (unsigned)getc(fd); 6064 return (int)n; 6065 } 6066 6067 /* 6068 * Read 8 bytes from "fd" and turn them into a time_T, MSB first. 6069 */ 6070 time_T 6071 get8ctime(FILE *fd) 6072 { 6073 time_T n = 0; 6074 int i; 6075 6076 for (i = 0; i < 8; ++i) 6077 n = (n << 8) + getc(fd); 6078 return n; 6079 } 6080 6081 /* 6082 * Read a string of length "cnt" from "fd" into allocated memory. 6083 * Returns NULL when out of memory or unable to read that many bytes. 6084 */ 6085 char_u * 6086 read_string(FILE *fd, int cnt) 6087 { 6088 char_u *str; 6089 int i; 6090 int c; 6091 6092 /* allocate memory */ 6093 str = alloc((unsigned)cnt + 1); 6094 if (str != NULL) 6095 { 6096 /* Read the string. Quit when running into the EOF. */ 6097 for (i = 0; i < cnt; ++i) 6098 { 6099 c = getc(fd); 6100 if (c == EOF) 6101 { 6102 vim_free(str); 6103 return NULL; 6104 } 6105 str[i] = c; 6106 } 6107 str[i] = NUL; 6108 } 6109 return str; 6110 } 6111 6112 /* 6113 * Write a number to file "fd", MSB first, in "len" bytes. 6114 */ 6115 int 6116 put_bytes(FILE *fd, long_u nr, int len) 6117 { 6118 int i; 6119 6120 for (i = len - 1; i >= 0; --i) 6121 if (putc((int)(nr >> (i * 8)), fd) == EOF) 6122 return FAIL; 6123 return OK; 6124 } 6125 6126 #ifdef _MSC_VER 6127 # if (_MSC_VER <= 1200) 6128 /* This line is required for VC6 without the service pack. Also see the 6129 * matching #pragma below. */ 6130 # pragma optimize("", off) 6131 # endif 6132 #endif 6133 6134 /* 6135 * Write time_T to file "fd" in 8 bytes. 6136 * Returns FAIL when the write failed. 6137 */ 6138 int 6139 put_time(FILE *fd, time_T the_time) 6140 { 6141 char_u buf[8]; 6142 6143 time_to_bytes(the_time, buf); 6144 return fwrite(buf, (size_t)8, (size_t)1, fd) == 1 ? OK : FAIL; 6145 } 6146 6147 /* 6148 * Write time_T to "buf[8]". 6149 */ 6150 void 6151 time_to_bytes(time_T the_time, char_u *buf) 6152 { 6153 int c; 6154 int i; 6155 int bi = 0; 6156 time_T wtime = the_time; 6157 6158 /* time_T can be up to 8 bytes in size, more than long_u, thus we 6159 * can't use put_bytes() here. 6160 * Another problem is that ">>" may do an arithmetic shift that keeps the 6161 * sign. This happens for large values of wtime. A cast to long_u may 6162 * truncate if time_T is 8 bytes. So only use a cast when it is 4 bytes, 6163 * it's safe to assume that long_u is 4 bytes or more and when using 8 6164 * bytes the top bit won't be set. */ 6165 for (i = 7; i >= 0; --i) 6166 { 6167 if (i + 1 > (int)sizeof(time_T)) 6168 /* ">>" doesn't work well when shifting more bits than avail */ 6169 buf[bi++] = 0; 6170 else 6171 { 6172 #if defined(SIZEOF_TIME_T) && SIZEOF_TIME_T > 4 6173 c = (int)(wtime >> (i * 8)); 6174 #else 6175 c = (int)((long_u)wtime >> (i * 8)); 6176 #endif 6177 buf[bi++] = c; 6178 } 6179 } 6180 } 6181 6182 #ifdef _MSC_VER 6183 # if (_MSC_VER <= 1200) 6184 # pragma optimize("", on) 6185 # endif 6186 #endif 6187 6188 #endif 6189 6190 #if (defined(FEAT_MBYTE) && defined(FEAT_QUICKFIX)) \ 6191 || defined(FEAT_SPELL) || defined(PROTO) 6192 /* 6193 * Return TRUE if string "s" contains a non-ASCII character (128 or higher). 6194 * When "s" is NULL FALSE is returned. 6195 */ 6196 int 6197 has_non_ascii(char_u *s) 6198 { 6199 char_u *p; 6200 6201 if (s != NULL) 6202 for (p = s; *p != NUL; ++p) 6203 if (*p >= 128) 6204 return TRUE; 6205 return FALSE; 6206 } 6207 #endif 6208 6209 #if defined(MESSAGE_QUEUE) || defined(PROTO) 6210 /* 6211 * Process messages that have been queued for netbeans or clientserver. 6212 * Also check if any jobs have ended. 6213 * These functions can call arbitrary vimscript and should only be called when 6214 * it is safe to do so. 6215 */ 6216 void 6217 parse_queued_messages(void) 6218 { 6219 /* For Win32 mch_breakcheck() does not check for input, do it here. */ 6220 # if defined(WIN32) && defined(FEAT_JOB_CHANNEL) 6221 channel_handle_events(); 6222 # endif 6223 6224 # ifdef FEAT_NETBEANS_INTG 6225 /* Process the queued netbeans messages. */ 6226 netbeans_parse_messages(); 6227 # endif 6228 # ifdef FEAT_JOB_CHANNEL 6229 /* Write any buffer lines still to be written. */ 6230 channel_write_any_lines(); 6231 6232 /* Process the messages queued on channels. */ 6233 channel_parse_messages(); 6234 # endif 6235 # if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11) 6236 /* Process the queued clientserver messages. */ 6237 server_parse_messages(); 6238 # endif 6239 # ifdef FEAT_JOB_CHANNEL 6240 /* Check if any jobs have ended. */ 6241 job_check_ended(); 6242 # endif 6243 } 6244 #endif 6245 6246 #ifndef PROTO /* proto is defined in vim.h */ 6247 # ifdef ELAPSED_TIMEVAL 6248 /* 6249 * Return time in msec since "start_tv". 6250 */ 6251 long 6252 elapsed(struct timeval *start_tv) 6253 { 6254 struct timeval now_tv; 6255 6256 gettimeofday(&now_tv, NULL); 6257 return (now_tv.tv_sec - start_tv->tv_sec) * 1000L 6258 + (now_tv.tv_usec - start_tv->tv_usec) / 1000L; 6259 } 6260 # endif 6261 6262 # ifdef ELAPSED_TICKCOUNT 6263 /* 6264 * Return time in msec since "start_tick". 6265 */ 6266 long 6267 elapsed(DWORD start_tick) 6268 { 6269 DWORD now = GetTickCount(); 6270 6271 return (long)now - (long)start_tick; 6272 } 6273 # endif 6274 #endif 6275