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