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