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