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