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