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