1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
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.
11 * misc2.c: Various functions.
15 static char_u
*username
= NULL
; /* cached result of mch_get_user_name() */
17 static char_u
*ff_expand_buffer
= NULL
; /* used for expanding filenames */
19 #if defined(FEAT_VIRTUALEDIT) || defined(PROTO)
20 static int coladvance2
__ARGS((pos_T
*pos
, int addspaces
, int finetune
, colnr_T wcol
));
23 * Return TRUE if in the current mode we need to use virtual.
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"
31 if (virtual_op
!= MAYBE
)
33 return (ve_flags
== VE_ALL
35 || ((ve_flags
& VE_BLOCK
) && VIsual_active
&& VIsual_mode
== Ctrl_V
)
37 || ((ve_flags
& VE_INSERT
) && (State
& INSERT
)));
41 * Get the screen position of the cursor.
48 getvvcol(curwin
, &curwin
->w_cursor
, &x
, NULL
, NULL
);
53 * Get the screen position of character col with a coladd in the cursor line.
56 getviscol2(col
, coladd
)
63 pos
.lnum
= curwin
->w_cursor
.lnum
;
66 getvvcol(curwin
, &pos
, &x
, NULL
, NULL
);
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!
76 coladvance_force(wcol
)
79 int rc
= coladvance2(&curwin
->w_cursor
, TRUE
, FALSE
, wcol
);
82 curwin
->w_valid
&= ~VALID_VIRTCOL
;
85 /* Virtcol is valid */
86 curwin
->w_valid
|= VALID_VIRTCOL
;
87 curwin
->w_virtcol
= wcol
;
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.
100 * return OK if desired column is reached, FAIL if not
106 int rc
= getvpos(&curwin
->w_cursor
, wcol
);
108 if (wcol
== MAXCOL
|| rc
== FAIL
)
109 curwin
->w_valid
&= ~VALID_VIRTCOL
;
110 else if (*ml_get_cursor() != TAB
)
112 /* Virtcol is valid when not on a TAB */
113 curwin
->w_valid
|= VALID_VIRTCOL
;
114 curwin
->w_virtcol
= wcol
;
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
128 #ifdef FEAT_VIRTUALEDIT
129 return coladvance2(pos
, FALSE
, virtual_active(), wcol
);
133 coladvance2(pos
, addspaces
, finetune
, wcol
)
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 */
146 #ifdef FEAT_LINEBREAK
150 one_more
= (State
& INSERT
)
151 || restart_edit
!= NUL
153 || (VIsual_active
&& *p_sel
!= 'o')
155 #ifdef FEAT_VIRTUALEDIT
156 || ((ve_flags
& VE_ONEMORE
) && wcol
< MAXCOL
)
159 line
= ml_get_curline();
163 idx
= (int)STRLEN(line
) - 1 + one_more
;
166 #ifdef FEAT_VIRTUALEDIT
167 if ((addspaces
|| finetune
) && !VIsual_active
)
169 curwin
->w_curswant
= linetabsize(line
) + one_more
;
170 if (curwin
->w_curswant
> 0)
171 --curwin
->w_curswant
;
177 #ifdef FEAT_VIRTUALEDIT
178 int width
= W_WIDTH(curwin
) - win_col_off(curwin
);
182 # ifdef FEAT_VERTSPLIT
183 && curwin
->w_width
!= 0
185 && wcol
>= (colnr_T
)width
)
187 csize
= linetabsize(line
);
191 if (wcol
/ width
> (colnr_T
)csize
/ width
192 && ((State
& INSERT
) == 0 || (int)wcol
> csize
+ 1))
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;
205 while (col
<= wcol
&& *ptr
!= NUL
)
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
);
212 csize
= lbr_chartabsize_adv(&ptr
, col
);
216 idx
= (int)(ptr
- line
);
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.
223 if (col
> wcol
|| (!virtual_active() && one_more
== 0))
226 # ifdef FEAT_LINEBREAK
227 /* Don't count the chars from 'showbreak'. */
233 #ifdef FEAT_VIRTUALEDIT
236 && ((col
!= wcol
&& col
!= wcol
+ 1) || csize
> 1))
238 /* 'virtualedit' is set: The difference between wcol and col is
239 * filled with spaces. */
241 if (line
[idx
] == NUL
)
244 int correct
= wcol
- col
;
245 char_u
*newline
= alloc(idx
+ correct
+ 1);
251 for (t
= 0; t
< idx
; ++t
)
252 newline
[t
] = line
[t
];
254 for (t
= 0; t
< correct
; ++t
)
255 newline
[t
+ idx
] = ' ';
257 newline
[idx
+ correct
] = NUL
;
259 ml_replace(pos
->lnum
, newline
, FALSE
);
260 changed_bytes(pos
->lnum
, (colnr_T
)idx
);
267 int linelen
= (int)STRLEN(line
);
268 int correct
= wcol
- col
- csize
+ 1; /* negative!! */
273 if (-correct
> csize
)
276 newline
= alloc(linelen
+ csize
);
280 for (t
= 0; t
< linelen
; t
++)
283 newline
[s
++] = line
[t
];
285 for (v
= 0; v
< csize
; v
++)
289 newline
[linelen
+ csize
- 1] = NUL
;
291 ml_replace(pos
->lnum
, newline
, FALSE
);
292 changed_bytes(pos
->lnum
, idx
);
293 idx
+= (csize
- 1 + correct
);
305 #ifdef FEAT_VIRTUALEDIT
312 /* The width of the last character is used to set coladd. */
317 getvcol(curwin
, pos
, &scol
, NULL
, &ecol
);
318 pos
->coladd
= ecol
- scol
;
323 int b
= (int)wcol
- (int)col
;
325 /* The difference between wcol and col is used to set coladd. */
326 if (b
> 0 && b
< (MAXCOL
- 2 * W_WIDTH(curwin
)))
335 /* prevent cursor from moving on the trail byte */
346 * Increment the cursor position. See inc() for return values.
351 return inc(&curwin
->w_cursor
);
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.
365 char_u
*p
= ml_get_pos(lp
);
367 if (*p
!= NUL
) /* still within line, move to next char (may be NUL) */
372 int l
= (*mb_ptr2len
)(p
);
375 return ((p
[l
] != NUL
) ? 0 : 2);
379 #ifdef FEAT_VIRTUALEDIT
382 return ((p
[1] != NUL
) ? 0 : 2);
384 if (lp
->lnum
!= curbuf
->b_ml
.ml_line_count
) /* there is a next line */
388 #ifdef FEAT_VIRTUALEDIT
397 * incl(lp): same as inc(), but skip the NUL at the end of non-empty lines
405 if ((r
= inc(lp
)) >= 1 && lp
->col
)
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.
419 return dec(&curwin
->w_cursor
);
428 #ifdef FEAT_VIRTUALEDIT
431 if (lp
->col
> 0) /* still within line */
437 p
= ml_get(lp
->lnum
);
438 lp
->col
-= (*mb_head_off
)(p
, p
+ lp
->col
);
443 if (lp
->lnum
> 1) /* there is a prior line */
446 p
= ml_get(lp
->lnum
);
447 lp
->col
= (colnr_T
)STRLEN(p
);
450 lp
->col
-= (*mb_head_off
)(p
, p
+ lp
->col
);
454 return -1; /* at start of file */
458 * decl(lp): same as dec(), but skip the NUL at the end of non-empty lines
466 if ((r
= dec(lp
)) == 1 && lp
->col
)
472 * Make sure curwin->w_cursor.lnum is valid.
477 if (curwin
->w_cursor
.lnum
> curbuf
->b_ml
.ml_line_count
)
480 /* If there is a closed fold at the end of the file, put the cursor in
481 * its first line. Otherwise in the last line. */
482 if (!hasFolding(curbuf
->b_ml
.ml_line_count
,
483 &curwin
->w_cursor
.lnum
, NULL
))
485 curwin
->w_cursor
.lnum
= curbuf
->b_ml
.ml_line_count
;
487 if (curwin
->w_cursor
.lnum
<= 0)
488 curwin
->w_cursor
.lnum
= 1;
492 * Make sure curwin->w_cursor.col is valid.
498 #ifdef FEAT_VIRTUALEDIT
499 colnr_T oldcol
= curwin
->w_cursor
.col
+ curwin
->w_cursor
.coladd
;
502 len
= (colnr_T
)STRLEN(ml_get_curline());
504 curwin
->w_cursor
.col
= 0;
505 else if (curwin
->w_cursor
.col
>= len
)
507 /* Allow cursor past end-of-line when:
508 * - in Insert mode or restarting Insert mode
509 * - in Visual mode and 'selection' isn't "old"
510 * - 'virtualedit' is set */
511 if ((State
& INSERT
) || restart_edit
513 || (VIsual_active
&& *p_sel
!= 'o')
515 #ifdef FEAT_VIRTUALEDIT
516 || (ve_flags
& VE_ONEMORE
)
519 curwin
->w_cursor
.col
= len
;
522 curwin
->w_cursor
.col
= len
- 1;
524 /* prevent cursor from moving on the trail byte */
531 #ifdef FEAT_VIRTUALEDIT
532 /* If virtual editing is on, we can leave the cursor on the old position,
533 * only we must set it to virtual. But don't do it when at the end of the
535 if (oldcol
== MAXCOL
)
536 curwin
->w_cursor
.coladd
= 0;
537 else if (ve_flags
== VE_ALL
)
538 curwin
->w_cursor
.coladd
= oldcol
- curwin
->w_cursor
.col
;
543 * make sure curwin->w_cursor in on a valid character
552 #if defined(FEAT_TEXTOBJ) || defined(PROTO)
554 * Make sure curwin->w_cursor is not on the NUL at the end of the line.
555 * Allow it when in Visual mode and 'selection' is not "old".
560 if (curwin
->w_cursor
.col
> 0
562 && (!VIsual_active
|| *p_sel
== 'o')
564 && gchar_cursor() == NUL
)
565 --curwin
->w_cursor
.col
;
570 * When curwin->w_leftcol has changed, adjust the cursor position.
571 * Return TRUE if the cursor was moved.
580 changed_cline_bef_curs();
581 lastcol
= curwin
->w_leftcol
+ W_WIDTH(curwin
) - curwin_col_off() - 1;
585 * If the cursor is right or left of the screen, move it to last or first
588 if (curwin
->w_virtcol
> (colnr_T
)(lastcol
- p_siso
))
591 coladvance((colnr_T
)(lastcol
- p_siso
));
593 else if (curwin
->w_virtcol
< curwin
->w_leftcol
+ p_siso
)
596 (void)coladvance((colnr_T
)(curwin
->w_leftcol
+ p_siso
));
600 * If the start of the character under the cursor is not on the screen,
601 * advance the cursor one more char. If this fails (last char of the
602 * line) adjust the scrolling.
604 getvvcol(curwin
, &curwin
->w_cursor
, &s
, NULL
, &e
);
605 if (e
> (colnr_T
)lastcol
)
610 else if (s
< curwin
->w_leftcol
)
613 if (coladvance(e
+ 1) == FAIL
) /* there isn't another character */
615 curwin
->w_leftcol
= s
; /* adjust w_leftcol instead */
616 changed_cline_bef_curs();
621 curwin
->w_set_curswant
= TRUE
;
622 redraw_later(NOT_VALID
);
626 /**********************************************************************
627 * Various routines dealing with allocation and deallocation of memory.
630 #if defined(MEM_PROFILE) || defined(PROTO)
632 # define MEM_SIZES 8200
633 static long_u mem_allocs
[MEM_SIZES
];
634 static long_u mem_frees
[MEM_SIZES
];
635 static long_u mem_allocated
;
636 static long_u mem_freed
;
637 static long_u mem_peak
;
638 static long_u num_alloc
;
639 static long_u num_freed
;
641 static void mem_pre_alloc_s
__ARGS((size_t *sizep
));
642 static void mem_pre_alloc_l
__ARGS((long_u
*sizep
));
643 static void mem_post_alloc
__ARGS((void **pp
, size_t size
));
644 static void mem_pre_free
__ARGS((void **pp
));
647 mem_pre_alloc_s(sizep
)
650 *sizep
+= sizeof(size_t);
654 mem_pre_alloc_l(sizep
)
657 *sizep
+= sizeof(size_t);
661 mem_post_alloc(pp
, size
)
667 size
-= sizeof(size_t);
668 *(long_u
*)*pp
= size
;
669 if (size
<= MEM_SIZES
-1)
670 mem_allocs
[size
-1]++;
672 mem_allocs
[MEM_SIZES
-1]++;
673 mem_allocated
+= size
;
674 if (mem_allocated
- mem_freed
> mem_peak
)
675 mem_peak
= mem_allocated
- mem_freed
;
677 *pp
= (void *)((char *)*pp
+ sizeof(size_t));
686 *pp
= (void *)((char *)*pp
- sizeof(size_t));
687 size
= *(size_t *)*pp
;
688 if (size
<= MEM_SIZES
-1)
691 mem_frees
[MEM_SIZES
-1]++;
697 * called on exit via atexit()
700 vim_mem_profile_dump()
706 for (i
= 0; i
< MEM_SIZES
- 1; i
++)
708 if (mem_allocs
[i
] || mem_frees
[i
])
710 if (mem_frees
[i
] > mem_allocs
[i
])
711 printf("\r\n%s", _("ERROR: "));
712 printf("[%4d / %4lu-%-4lu] ", i
+ 1, mem_allocs
[i
], mem_frees
[i
]);
726 if (mem_frees
[i
] > mem_allocs
[i
])
727 printf(_("ERROR: "));
728 printf("[>%d / %4lu-%-4lu]", i
, mem_allocs
[i
], mem_frees
[i
]);
731 printf(_("\n[bytes] total alloc-freed %lu-%lu, in use %lu, peak use %lu\n"),
732 mem_allocated
, mem_freed
, mem_allocated
- mem_freed
, mem_peak
);
733 printf(_("[calls] total re/malloc()'s %lu, total free()'s %lu\n\n"),
734 num_alloc
, num_freed
);
737 #endif /* MEM_PROFILE */
740 * Some memory is reserved for error messages and for being able to
741 * call mf_release_all(), which needs some memory for mf_trans_add().
743 #if defined(MSDOS) && !defined(DJGPP)
745 # define KEEP_ROOM 8192L
747 # define KEEP_ROOM (2 * 8192L)
751 * Note: if unsigned is 16 bits we can only allocate up to 64K with alloc().
752 * Use lalloc for larger blocks.
758 return (lalloc((long_u
)size
, TRUE
));
762 * Allocate memory and set all bytes to zero.
770 p
= (lalloc((long_u
)size
, TRUE
));
772 (void)vim_memset(p
, 0, (size_t)size
);
777 * alloc() with check for maximum line length
783 #if !defined(UNIX) && !defined(__EMX__)
784 if (sizeof(int) == 2 && size
> 0x7fff)
786 /* Don't hide this message */
788 EMSG(_("E340: Line is becoming too long"));
792 return (lalloc((long_u
)size
, TRUE
));
796 * Allocate memory like lalloc() and set all bytes to zero.
799 lalloc_clear(size
, message
)
805 p
= (lalloc(size
, message
));
807 (void)vim_memset(p
, 0, (size_t)size
);
812 * Low level memory allocation function.
813 * This is used often, KEEP IT FAST!
816 lalloc(size
, message
)
820 char_u
*p
; /* pointer to new storage space */
821 static int releasing
= FALSE
; /* don't do mf_release_all() recursive */
823 #if defined(HAVE_AVAIL_MEM) && !defined(SMALL_MEM)
824 static long_u allocated
= 0; /* allocated since last avail check */
827 /* Safety check for allocating zero bytes */
830 /* Don't hide this message */
832 EMSGN(_("E341: Internal error: lalloc(%ld, )"), size
);
837 mem_pre_alloc_l(&size
);
840 #if defined(MSDOS) && !defined(DJGPP)
841 if (size
>= 0xfff0) /* in MSDOS we can't deal with >64K blocks */
847 * Loop when out of memory: Try to release some memfile blocks and
848 * if some blocks are released call malloc again.
853 * Handle three kind of systems:
854 * 1. No check for available memory: Just return.
855 * 2. Slow check for available memory: call mch_avail_mem() after
856 * allocating KEEP_ROOM amount of memory.
857 * 3. Strict check for available memory: call mch_avail_mem()
859 if ((p
= (char_u
*)malloc((size_t)size
)) != NULL
)
861 #ifndef HAVE_AVAIL_MEM
862 /* 1. No check for available memory: Just return. */
866 /* 2. Slow check for available memory: call mch_avail_mem() after
867 * allocating (KEEP_ROOM / 2) amount of memory. */
869 if (allocated
< KEEP_ROOM
/ 2)
873 /* 3. check for available memory: call mch_avail_mem() */
874 if (mch_avail_mem(TRUE
) < KEEP_ROOM
&& !releasing
)
876 free((char *)p
); /* System is low... no go! */
884 * Remember that mf_release_all() is being called to avoid an endless
885 * loop, because mf_release_all() may call alloc() recursively.
891 clear_sb_text(); /* free any scrollback text */
892 try_again
= mf_release_all(); /* release as many blocks as possible */
894 try_again
|= garbage_collect(); /* cleanup recursive lists/dicts */
902 if (message
&& p
== NULL
)
903 do_outofmem_msg(size
);
907 mem_post_alloc((void **)&p
, (size_t)size
);
912 #if defined(MEM_PROFILE) || defined(PROTO)
914 * realloc() with memory profiling.
917 mem_realloc(ptr
, size
)
924 mem_pre_alloc_s(&size
);
926 p
= realloc(ptr
, size
);
928 mem_post_alloc(&p
, size
);
935 * Avoid repeating the error message many times (they take 1 second each).
936 * Did_outofmem_msg is reset when a character is read.
939 do_outofmem_msg(size
)
942 if (!did_outofmem_msg
)
944 /* Don't hide this message */
946 EMSGN(_("E342: Out of memory! (allocating %lu bytes)"), size
);
947 did_outofmem_msg
= TRUE
;
951 #if defined(EXITFREE) || defined(PROTO)
953 # if defined(FEAT_SEARCHPATH)
954 static void free_findfile
__ARGS((void));
958 * Free everything that we allocated.
959 * Can be used to detect memory leaks, e.g., with ccmalloc.
960 * NOTE: This is tricky! Things are freed that functions depend on. Don't be
961 * surprised if Vim crashes...
962 * Some things can't be freed, esp. things local to a library function.
967 buf_T
*buf
, *nextbuf
;
968 static int entered
= FALSE
;
970 /* When we cause a crash here it is caught and Vim tries to exit cleanly.
971 * Don't try freeing everything again. */
977 block_autocmds(); /* don't want to trigger autocommands here */
981 /* close all tabs and windows */
982 if (first_tabpage
->tp_next
!= NULL
)
983 do_cmdline_cmd((char_u
*)"tabonly!");
984 if (firstwin
!= lastwin
)
985 do_cmdline_cmd((char_u
*)"only!");
988 # if defined(FEAT_SPELL)
989 /* Free all spell info. */
993 # if defined(FEAT_USR_CMDS)
994 /* Clear user commands (before deleting buffers). */
1000 do_cmdline_cmd((char_u
*)"aunmenu *");
1003 /* Clear mappings, abbreviations, breakpoints. */
1004 do_cmdline_cmd((char_u
*)"mapclear");
1005 do_cmdline_cmd((char_u
*)"mapclear!");
1006 do_cmdline_cmd((char_u
*)"abclear");
1007 # if defined(FEAT_EVAL)
1008 do_cmdline_cmd((char_u
*)"breakdel *");
1010 # if defined(FEAT_PROFILE)
1011 do_cmdline_cmd((char_u
*)"profdel *");
1013 # if defined(FEAT_KEYMAP)
1014 do_cmdline_cmd((char_u
*)"set keymap=");
1020 # if defined(FEAT_SEARCHPATH)
1024 /* Obviously named calls. */
1025 # if defined(FEAT_AUTOCMD)
1026 free_all_autocmds();
1031 alist_clear(&global_alist
);
1033 free_search_patterns();
1036 free_prev_shellcmd();
1037 free_regexp_stuff();
1044 set_expr_line(NULL
);
1049 clear_sb_text(); /* free any scrollback text */
1051 /* Free some global vars. */
1053 # ifdef FEAT_CLIPBOARD
1054 vim_free(clip_exclude_prog
);
1056 vim_free(last_cmdline
);
1057 # ifdef FEAT_CMDHIST
1058 vim_free(new_last_cmdline
);
1060 set_keep_msg(NULL
, 0);
1061 vim_free(ff_expand_buffer
);
1063 /* Clear cmdline history. */
1065 # ifdef FEAT_CMDHIST
1069 #ifdef FEAT_QUICKFIX
1074 /* Free all location lists */
1075 FOR_ALL_WINDOWS(win
)
1080 /* Close all script inputs. */
1081 close_all_scripts();
1083 #if defined(FEAT_WINDOWS)
1084 /* Destroy all windows. Must come before freeing buffers. */
1088 /* Free all buffers. Reset 'autochdir' to avoid accessing things that
1089 * were freed already. */
1090 #ifdef FEAT_AUTOCHDIR
1093 for (buf
= firstbuf
; buf
!= NULL
; )
1095 nextbuf
= buf
->b_next
;
1096 close_buffer(NULL
, buf
, DOBUF_WIPE
);
1098 buf
= nextbuf
; /* didn't work, try next one */
1107 /* Clear registers. */
1112 #if defined(FEAT_CLIENTSERVER) && defined(FEAT_X11)
1113 vim_free(serverDelayedStartName
);
1116 /* highlight info */
1119 reset_last_sourcing();
1122 free_tabpage(first_tabpage
);
1123 first_tabpage
= NULL
;
1127 /* Machine-specific free. */
1131 /* message history */
1133 if (delete_first_msg() == FAIL
)
1142 /* screenlines (can't display anything now!) */
1145 #if defined(USE_XSMP)
1159 * copy a string into newly allocated memory
1168 len
= (unsigned)STRLEN(string
) + 1;
1171 mch_memmove(p
, string
, (size_t)len
);
1176 vim_strnsave(string
, len
)
1182 p
= alloc((unsigned)(len
+ 1));
1185 STRNCPY(p
, string
, len
);
1192 * Same as vim_strsave(), but any characters found in esc_chars are preceded
1196 vim_strsave_escaped(string
, esc_chars
)
1200 return vim_strsave_escaped_ext(string
, esc_chars
, '\\', FALSE
);
1204 * Same as vim_strsave_escaped(), but when "bsl" is TRUE also escape
1205 * characters where rem_backslash() would remove the backslash.
1206 * Escape the characters with "cc".
1209 vim_strsave_escaped_ext(string
, esc_chars
, cc
, bsl
)
1217 char_u
*escaped_string
;
1224 * First count the number of backslashes required.
1225 * Then allocate the memory and insert them.
1227 length
= 1; /* count the trailing NUL */
1228 for (p
= string
; *p
; p
++)
1231 if (has_mbyte
&& (l
= (*mb_ptr2len
)(p
)) > 1)
1233 length
+= l
; /* count a multibyte char */
1238 if (vim_strchr(esc_chars
, *p
) != NULL
|| (bsl
&& rem_backslash(p
)))
1239 ++length
; /* count a backslash */
1240 ++length
; /* count an ordinary char */
1242 escaped_string
= alloc(length
);
1243 if (escaped_string
!= NULL
)
1245 p2
= escaped_string
;
1246 for (p
= string
; *p
; p
++)
1249 if (has_mbyte
&& (l
= (*mb_ptr2len
)(p
)) > 1)
1251 mch_memmove(p2
, p
, (size_t)l
);
1253 p
+= l
- 1; /* skip multibyte char */
1257 if (vim_strchr(esc_chars
, *p
) != NULL
|| (bsl
&& rem_backslash(p
)))
1263 return escaped_string
;
1267 * Return TRUE when 'shell' has "csh" in the tail.
1272 return (strstr((char *)gettail(p_sh
), "csh") != NULL
);
1276 * Escape "string" for use as a shell argument with system().
1277 * This uses single quotes, except when we know we need to use double qoutes
1278 * (MS-DOS and MS-Windows without 'shellslash' set).
1279 * Escape a newline, depending on the 'shell' option.
1280 * When "do_special" is TRUE also replace "!", "%", "#" and things starting
1281 * with "<" like "<cfile>".
1282 * Returns the result in allocated memory, NULL if we have run out.
1285 vim_strsave_shellescape(string
, do_special
)
1292 char_u
*escaped_string
;
1296 /* Only csh and similar shells expand '!' within single quotes. For sh and
1297 * the like we must not put a backslash before it, it will be taken
1298 * literally. If do_special is set the '!' will be escaped twice.
1299 * Csh also needs to have "\n" escaped twice when do_special is set. */
1300 csh_like
= csh_like_shell();
1302 /* First count the number of extra bytes required. */
1303 length
= (unsigned)STRLEN(string
) + 3; /* two quotes and a trailing NUL */
1304 for (p
= string
; *p
!= NUL
; mb_ptr_adv(p
))
1306 # if defined(WIN32) || defined(WIN16) || defined(DOS)
1310 ++length
; /* " -> "" */
1315 length
+= 3; /* ' => '\'' */
1316 if (*p
== '\n' || (*p
== '!' && (csh_like
|| do_special
)))
1318 ++length
; /* insert backslash */
1319 if (csh_like
&& do_special
)
1320 ++length
; /* insert backslash */
1322 if (do_special
&& find_cmdline_var(p
, &l
) >= 0)
1324 ++length
; /* insert backslash */
1329 /* Allocate memory for the result and fill it. */
1330 escaped_string
= alloc(length
);
1331 if (escaped_string
!= NULL
)
1335 /* add opening quote */
1336 # if defined(WIN32) || defined(WIN16) || defined(DOS)
1343 for (p
= string
; *p
!= NUL
; )
1345 # if defined(WIN32) || defined(WIN16) || defined(DOS)
1367 if (*p
== '\n' || (*p
== '!' && (csh_like
|| do_special
)))
1370 if (csh_like
&& do_special
)
1375 if (do_special
&& find_cmdline_var(p
, &l
) >= 0)
1377 *d
++ = '\\'; /* insert backslash */
1378 while (--l
>= 0) /* copy the var */
1385 /* add terminating quote and finish with a NUL */
1386 # if defined(WIN32) || defined(WIN16) || defined(DOS)
1395 return escaped_string
;
1399 * Like vim_strsave(), but make all characters uppercase.
1400 * This uses ASCII lower-to-upper case translation, language independent.
1403 vim_strsave_up(string
)
1408 p1
= vim_strsave(string
);
1414 * Like vim_strnsave(), but make all characters uppercase.
1415 * This uses ASCII lower-to-upper case translation, language independent.
1418 vim_strnsave_up(string
, len
)
1424 p1
= vim_strnsave(string
, len
);
1430 * ASCII lower-to-upper case translation, language independent.
1442 while ((c
= *p2
) != NUL
)
1444 *p2
++ = isalpha(c
) ? toupper(c
) : c
;
1446 *p2
++ = (c
< 'a' || c
> 'z') ? c
: (c
- 0x20);
1451 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
1453 * Make string "s" all upper-case and return it in allocated memory.
1454 * Handles multi-byte characters as well as possible.
1455 * Returns NULL when out of memory.
1464 res
= p
= vim_strsave(orig
);
1478 c
= utf_ptr2char(p
);
1479 uc
= utf_toupper(c
);
1481 /* Reallocate string when byte count changes. This is rare,
1482 * thus it's OK to do another malloc()/free(). */
1484 nl
= utf_char2len(uc
);
1487 s
= alloc((unsigned)STRLEN(res
) + 1 + nl
- l
);
1490 mch_memmove(s
, res
, p
- res
);
1491 STRCPY(s
+ (p
- res
) + nl
, p
+ l
);
1497 utf_char2bytes(uc
, p
);
1500 else if (has_mbyte
&& (l
= (*mb_ptr2len
)(p
)) > 1)
1501 p
+= l
; /* skip multi-byte character */
1505 *p
= TOUPPER_LOC(*p
); /* note that toupper() can be a macro */
1515 * copy a space a number of times
1518 copy_spaces(ptr
, count
)
1529 #if defined(FEAT_VISUALEXTRA) || defined(PROTO)
1531 * Copy a character a number of times.
1532 * Does not work for multi-byte charactes!
1535 copy_chars(ptr
, count
, c
)
1549 * delete spaces at the end of a string
1552 del_trailing_spaces(ptr
)
1557 q
= ptr
+ STRLEN(ptr
);
1558 while (--q
> ptr
&& vim_iswhite(q
[0]) && q
[-1] != '\\' && q
[-1] != Ctrl_V
)
1563 * Like strncpy(), but always terminate the result with one NUL.
1564 * "to" must be "len + 1" long!
1567 vim_strncpy(to
, from
, len
)
1572 STRNCPY(to
, from
, len
);
1577 * Isolate one part of a string option where parts are separated with
1579 * The part is copied into "buf[maxlen]".
1580 * "*option" is advanced to the next part.
1581 * The length is returned.
1584 copy_option_part(option
, buf
, maxlen
, sep_chars
)
1591 char_u
*p
= *option
;
1593 /* skip '.' at start of option part, for 'suffixes' */
1596 while (*p
!= NUL
&& vim_strchr((char_u
*)sep_chars
, *p
) == NULL
)
1599 * Skip backslash before a separator character and space.
1601 if (p
[0] == '\\' && vim_strchr((char_u
*)sep_chars
, p
[1]) != NULL
)
1603 if (len
< maxlen
- 1)
1609 if (*p
!= NUL
&& *p
!= ',') /* skip non-standard separator */
1611 p
= skip_to_option_part(p
); /* p points to next file name */
1618 * Replacement for free() that ignores NULL pointers.
1619 * Also skip free() when exiting for sure, this helps when we caught a deadly
1620 * signal that was caused by a crash in free().
1626 if (x
!= NULL
&& !really_exiting
)
1637 vim_memset(ptr
, c
, size
)
1652 * Return zero when "b1" and "b2" are the same for "len" bytes.
1653 * Return non-zero otherwise.
1656 vim_memcmp(b1
, b2
, len
)
1661 char_u
*p1
= (char_u
*)b1
, *p2
= (char_u
*)b2
;
1663 for ( ; len
> 0; --len
)
1676 * Version of memmove() that handles overlapping source and destination.
1677 * For systems that don't have a function that is guaranteed to do that (SYSV).
1680 mch_memmove(dst_arg
, src_arg
, len
)
1681 void *src_arg
, *dst_arg
;
1685 * A void doesn't have a size, we use char pointers.
1687 char *dst
= dst_arg
, *src
= src_arg
;
1689 /* overlap, copy backwards */
1690 if (dst
> src
&& dst
< src
+ len
)
1697 else /* copy forwards */
1703 #if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP)) || defined(PROTO)
1705 * Compare two strings, ignoring case, using current locale.
1706 * Doesn't work for multi-byte characters.
1707 * return 0 for match, < 0 for smaller, > 0 for bigger
1718 i
= (int)TOLOWER_LOC(*s1
) - (int)TOLOWER_LOC(*s2
);
1720 return i
; /* this character different */
1722 break; /* strings match until NUL */
1726 return 0; /* strings match */
1730 #if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP)) || defined(PROTO)
1732 * Compare two strings, for length "len", ignoring case, using current locale.
1733 * Doesn't work for multi-byte characters.
1734 * return 0 for match, < 0 for smaller, > 0 for bigger
1737 vim_strnicmp(s1
, s2
, len
)
1746 i
= (int)TOLOWER_LOC(*s1
) - (int)TOLOWER_LOC(*s2
);
1748 return i
; /* this character different */
1750 break; /* strings match until NUL */
1755 return 0; /* strings match */
1759 #if 0 /* currently not used */
1761 * Check if string "s2" appears somewhere in "s1" while ignoring case.
1762 * Return NULL if not, a pointer to the first occurrence if it does.
1770 int len
= STRLEN(s2
);
1771 char_u
*end
= s1
+ STRLEN(s1
) - len
;
1773 for (p
= s1
; p
<= end
; ++p
)
1774 if (STRNICMP(p
, s2
, len
) == 0)
1781 * Version of strchr() and strrchr() that handle unsigned char strings
1782 * with characters from 128 to 255 correctly. It also doesn't return a
1783 * pointer to the NUL at the end of the string.
1786 vim_strchr(string
, c
)
1795 if (enc_utf8
&& c
>= 0x80)
1799 if (utf_ptr2char(p
) == c
)
1801 p
+= (*mb_ptr2len
)(p
);
1805 if (enc_dbcs
!= 0 && c
> 255)
1809 c
= ((unsigned)c
>> 8) & 0xff;
1810 while ((b
= *p
) != NUL
)
1812 if (b
== c
&& p
[1] == n2
)
1814 p
+= (*mb_ptr2len
)(p
);
1820 while ((b
= *p
) != NUL
)
1824 p
+= (*mb_ptr2len
)(p
);
1829 while ((b
= *p
) != NUL
)
1839 * Version of strchr() that only works for bytes and handles unsigned char
1840 * strings with characters above 128 correctly. It also doesn't return a
1841 * pointer to the NUL at the end of the string.
1844 vim_strbyte(string
, c
)
1860 * Search for last occurrence of "c" in "string".
1861 * Return NULL if not found.
1862 * Does not handle multi-byte char for "c"!
1865 vim_strrchr(string
, c
)
1869 char_u
*retval
= NULL
;
1882 * Vim's version of strpbrk(), in case it's missing.
1883 * Don't generate a prototype for this, causes problems when it's not used.
1886 # ifndef HAVE_STRPBRK
1891 vim_strpbrk(s
, charset
)
1897 if (vim_strchr(charset
, *s
) != NULL
)
1907 * Vim has its own isspace() function, because on some machines isspace()
1908 * can't handle characters above 128.
1914 return ((x
>= 9 && x
<= 13) || x
== ' ');
1917 /************************************************************************
1918 * Functions for handling growing arrays.
1922 * Clear an allocated growing array.
1928 vim_free(gap
->ga_data
);
1933 * Clear a growing array that contains a list of strings.
1936 ga_clear_strings(gap
)
1941 for (i
= 0; i
< gap
->ga_len
; ++i
)
1942 vim_free(((char_u
**)(gap
->ga_data
))[i
]);
1947 * Initialize a growing array. Don't forget to set ga_itemsize and
1948 * ga_growsize! Or use ga_init2().
1954 gap
->ga_data
= NULL
;
1960 ga_init2(gap
, itemsize
, growsize
)
1966 gap
->ga_itemsize
= itemsize
;
1967 gap
->ga_growsize
= growsize
;
1971 * Make room in growing array "gap" for at least "n" items.
1972 * Return FAIL for failure, OK otherwise.
1982 if (gap
->ga_maxlen
- gap
->ga_len
< n
)
1984 if (n
< gap
->ga_growsize
)
1985 n
= gap
->ga_growsize
;
1986 len
= gap
->ga_itemsize
* (gap
->ga_len
+ n
);
1987 pp
= alloc_clear((unsigned)len
);
1990 gap
->ga_maxlen
= gap
->ga_len
+ n
;
1991 if (gap
->ga_data
!= NULL
)
1993 mch_memmove(pp
, gap
->ga_data
,
1994 (size_t)(gap
->ga_itemsize
* gap
->ga_len
));
1995 vim_free(gap
->ga_data
);
2003 * Concatenate a string to a growarray which contains characters.
2004 * Note: Does NOT copy the NUL at the end!
2011 int len
= (int)STRLEN(s
);
2013 if (ga_grow(gap
, len
) == OK
)
2015 mch_memmove((char *)gap
->ga_data
+ gap
->ga_len
, s
, (size_t)len
);
2021 * Append one byte to a growarray which contains bytes.
2028 if (ga_grow(gap
, 1) == OK
)
2030 *((char *)gap
->ga_data
+ gap
->ga_len
) = c
;
2035 /************************************************************************
2036 * functions that use lookup tables for various things, generally to do with
2037 * special key codes.
2041 * Some useful tables.
2044 static struct modmasktable
2046 short mod_mask
; /* Bit-mask for particular key modifier */
2047 short mod_flag
; /* Bit(s) for particular key modifier */
2048 char_u name
; /* Single letter name of modifier */
2049 } mod_mask_table
[] =
2051 {MOD_MASK_ALT
, MOD_MASK_ALT
, (char_u
)'M'},
2052 {MOD_MASK_META
, MOD_MASK_META
, (char_u
)'T'},
2053 {MOD_MASK_CTRL
, MOD_MASK_CTRL
, (char_u
)'C'},
2054 {MOD_MASK_SHIFT
, MOD_MASK_SHIFT
, (char_u
)'S'},
2055 {MOD_MASK_MULTI_CLICK
, MOD_MASK_2CLICK
, (char_u
)'2'},
2056 {MOD_MASK_MULTI_CLICK
, MOD_MASK_3CLICK
, (char_u
)'3'},
2057 {MOD_MASK_MULTI_CLICK
, MOD_MASK_4CLICK
, (char_u
)'4'},
2059 {MOD_MASK_CMD
, MOD_MASK_CMD
, (char_u
)'D'},
2061 /* 'A' must be the last one */
2062 {MOD_MASK_ALT
, MOD_MASK_ALT
, (char_u
)'A'},
2067 * Shifted key terminal codes and their unshifted equivalent.
2068 * Don't add mouse codes here, they are handled separately!
2070 #define MOD_KEYS_ENTRY_SIZE 5
2072 static char_u modifier_keys_table
[] =
2074 /* mod mask with modifier without modifier */
2075 MOD_MASK_SHIFT
, '&', '9', '@', '1', /* begin */
2076 MOD_MASK_SHIFT
, '&', '0', '@', '2', /* cancel */
2077 MOD_MASK_SHIFT
, '*', '1', '@', '4', /* command */
2078 MOD_MASK_SHIFT
, '*', '2', '@', '5', /* copy */
2079 MOD_MASK_SHIFT
, '*', '3', '@', '6', /* create */
2080 MOD_MASK_SHIFT
, '*', '4', 'k', 'D', /* delete char */
2081 MOD_MASK_SHIFT
, '*', '5', 'k', 'L', /* delete line */
2082 MOD_MASK_SHIFT
, '*', '7', '@', '7', /* end */
2083 MOD_MASK_CTRL
, KS_EXTRA
, (int)KE_C_END
, '@', '7', /* end */
2084 MOD_MASK_SHIFT
, '*', '9', '@', '9', /* exit */
2085 MOD_MASK_SHIFT
, '*', '0', '@', '0', /* find */
2086 MOD_MASK_SHIFT
, '#', '1', '%', '1', /* help */
2087 MOD_MASK_SHIFT
, '#', '2', 'k', 'h', /* home */
2088 MOD_MASK_CTRL
, KS_EXTRA
, (int)KE_C_HOME
, 'k', 'h', /* home */
2089 MOD_MASK_SHIFT
, '#', '3', 'k', 'I', /* insert */
2090 MOD_MASK_SHIFT
, '#', '4', 'k', 'l', /* left arrow */
2091 MOD_MASK_CTRL
, KS_EXTRA
, (int)KE_C_LEFT
, 'k', 'l', /* left arrow */
2092 MOD_MASK_SHIFT
, '%', 'a', '%', '3', /* message */
2093 MOD_MASK_SHIFT
, '%', 'b', '%', '4', /* move */
2094 MOD_MASK_SHIFT
, '%', 'c', '%', '5', /* next */
2095 MOD_MASK_SHIFT
, '%', 'd', '%', '7', /* options */
2096 MOD_MASK_SHIFT
, '%', 'e', '%', '8', /* previous */
2097 MOD_MASK_SHIFT
, '%', 'f', '%', '9', /* print */
2098 MOD_MASK_SHIFT
, '%', 'g', '%', '0', /* redo */
2099 MOD_MASK_SHIFT
, '%', 'h', '&', '3', /* replace */
2100 MOD_MASK_SHIFT
, '%', 'i', 'k', 'r', /* right arr. */
2101 MOD_MASK_CTRL
, KS_EXTRA
, (int)KE_C_RIGHT
, 'k', 'r', /* right arr. */
2102 MOD_MASK_SHIFT
, '%', 'j', '&', '5', /* resume */
2103 MOD_MASK_SHIFT
, '!', '1', '&', '6', /* save */
2104 MOD_MASK_SHIFT
, '!', '2', '&', '7', /* suspend */
2105 MOD_MASK_SHIFT
, '!', '3', '&', '8', /* undo */
2106 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_UP
, 'k', 'u', /* up arrow */
2107 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_DOWN
, 'k', 'd', /* down arrow */
2110 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_XF1
, KS_EXTRA
, (int)KE_XF1
,
2111 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_XF2
, KS_EXTRA
, (int)KE_XF2
,
2112 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_XF3
, KS_EXTRA
, (int)KE_XF3
,
2113 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_XF4
, KS_EXTRA
, (int)KE_XF4
,
2115 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F1
, 'k', '1', /* F1 */
2116 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F2
, 'k', '2',
2117 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F3
, 'k', '3',
2118 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F4
, 'k', '4',
2119 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F5
, 'k', '5',
2120 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F6
, 'k', '6',
2121 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F7
, 'k', '7',
2122 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F8
, 'k', '8',
2123 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F9
, 'k', '9',
2124 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F10
, 'k', ';', /* F10 */
2126 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F11
, 'F', '1',
2127 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F12
, 'F', '2',
2128 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F13
, 'F', '3',
2129 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F14
, 'F', '4',
2130 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F15
, 'F', '5',
2131 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F16
, 'F', '6',
2132 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F17
, 'F', '7',
2133 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F18
, 'F', '8',
2134 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F19
, 'F', '9',
2135 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F20
, 'F', 'A',
2137 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F21
, 'F', 'B',
2138 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F22
, 'F', 'C',
2139 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F23
, 'F', 'D',
2140 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F24
, 'F', 'E',
2141 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F25
, 'F', 'F',
2142 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F26
, 'F', 'G',
2143 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F27
, 'F', 'H',
2144 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F28
, 'F', 'I',
2145 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F29
, 'F', 'J',
2146 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F30
, 'F', 'K',
2148 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F31
, 'F', 'L',
2149 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F32
, 'F', 'M',
2150 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F33
, 'F', 'N',
2151 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F34
, 'F', 'O',
2152 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F35
, 'F', 'P',
2153 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F36
, 'F', 'Q',
2154 MOD_MASK_SHIFT
, KS_EXTRA
, (int)KE_S_F37
, 'F', 'R',
2156 /* TAB pseudo code*/
2157 MOD_MASK_SHIFT
, 'k', 'B', KS_EXTRA
, (int)KE_TAB
,
2162 static struct key_name_entry
2164 int key
; /* Special key code or ascii value */
2165 char_u
*name
; /* Name of key */
2166 } key_names_table
[] =
2168 {' ', (char_u
*)"Space"},
2169 {TAB
, (char_u
*)"Tab"},
2170 {K_TAB
, (char_u
*)"Tab"},
2171 {NL
, (char_u
*)"NL"},
2172 {NL
, (char_u
*)"NewLine"}, /* Alternative name */
2173 {NL
, (char_u
*)"LineFeed"}, /* Alternative name */
2174 {NL
, (char_u
*)"LF"}, /* Alternative name */
2175 {CAR
, (char_u
*)"CR"},
2176 {CAR
, (char_u
*)"Return"}, /* Alternative name */
2177 {CAR
, (char_u
*)"Enter"}, /* Alternative name */
2178 {K_BS
, (char_u
*)"BS"},
2179 {K_BS
, (char_u
*)"BackSpace"}, /* Alternative name */
2180 {ESC
, (char_u
*)"Esc"},
2181 {CSI
, (char_u
*)"CSI"},
2182 {K_CSI
, (char_u
*)"xCSI"},
2183 {'|', (char_u
*)"Bar"},
2184 {'\\', (char_u
*)"Bslash"},
2185 {K_DEL
, (char_u
*)"Del"},
2186 {K_DEL
, (char_u
*)"Delete"}, /* Alternative name */
2187 {K_KDEL
, (char_u
*)"kDel"},
2188 {K_UP
, (char_u
*)"Up"},
2189 {K_DOWN
, (char_u
*)"Down"},
2190 {K_LEFT
, (char_u
*)"Left"},
2191 {K_RIGHT
, (char_u
*)"Right"},
2192 {K_XUP
, (char_u
*)"xUp"},
2193 {K_XDOWN
, (char_u
*)"xDown"},
2194 {K_XLEFT
, (char_u
*)"xLeft"},
2195 {K_XRIGHT
, (char_u
*)"xRight"},
2197 {K_F1
, (char_u
*)"F1"},
2198 {K_F2
, (char_u
*)"F2"},
2199 {K_F3
, (char_u
*)"F3"},
2200 {K_F4
, (char_u
*)"F4"},
2201 {K_F5
, (char_u
*)"F5"},
2202 {K_F6
, (char_u
*)"F6"},
2203 {K_F7
, (char_u
*)"F7"},
2204 {K_F8
, (char_u
*)"F8"},
2205 {K_F9
, (char_u
*)"F9"},
2206 {K_F10
, (char_u
*)"F10"},
2208 {K_F11
, (char_u
*)"F11"},
2209 {K_F12
, (char_u
*)"F12"},
2210 {K_F13
, (char_u
*)"F13"},
2211 {K_F14
, (char_u
*)"F14"},
2212 {K_F15
, (char_u
*)"F15"},
2213 {K_F16
, (char_u
*)"F16"},
2214 {K_F17
, (char_u
*)"F17"},
2215 {K_F18
, (char_u
*)"F18"},
2216 {K_F19
, (char_u
*)"F19"},
2217 {K_F20
, (char_u
*)"F20"},
2219 {K_F21
, (char_u
*)"F21"},
2220 {K_F22
, (char_u
*)"F22"},
2221 {K_F23
, (char_u
*)"F23"},
2222 {K_F24
, (char_u
*)"F24"},
2223 {K_F25
, (char_u
*)"F25"},
2224 {K_F26
, (char_u
*)"F26"},
2225 {K_F27
, (char_u
*)"F27"},
2226 {K_F28
, (char_u
*)"F28"},
2227 {K_F29
, (char_u
*)"F29"},
2228 {K_F30
, (char_u
*)"F30"},
2230 {K_F31
, (char_u
*)"F31"},
2231 {K_F32
, (char_u
*)"F32"},
2232 {K_F33
, (char_u
*)"F33"},
2233 {K_F34
, (char_u
*)"F34"},
2234 {K_F35
, (char_u
*)"F35"},
2235 {K_F36
, (char_u
*)"F36"},
2236 {K_F37
, (char_u
*)"F37"},
2238 {K_XF1
, (char_u
*)"xF1"},
2239 {K_XF2
, (char_u
*)"xF2"},
2240 {K_XF3
, (char_u
*)"xF3"},
2241 {K_XF4
, (char_u
*)"xF4"},
2243 {K_HELP
, (char_u
*)"Help"},
2244 {K_UNDO
, (char_u
*)"Undo"},
2245 {K_INS
, (char_u
*)"Insert"},
2246 {K_INS
, (char_u
*)"Ins"}, /* Alternative name */
2247 {K_KINS
, (char_u
*)"kInsert"},
2248 {K_HOME
, (char_u
*)"Home"},
2249 {K_KHOME
, (char_u
*)"kHome"},
2250 {K_XHOME
, (char_u
*)"xHome"},
2251 {K_ZHOME
, (char_u
*)"zHome"},
2252 {K_END
, (char_u
*)"End"},
2253 {K_KEND
, (char_u
*)"kEnd"},
2254 {K_XEND
, (char_u
*)"xEnd"},
2255 {K_ZEND
, (char_u
*)"zEnd"},
2256 {K_PAGEUP
, (char_u
*)"PageUp"},
2257 {K_PAGEDOWN
, (char_u
*)"PageDown"},
2258 {K_KPAGEUP
, (char_u
*)"kPageUp"},
2259 {K_KPAGEDOWN
, (char_u
*)"kPageDown"},
2261 {K_KPLUS
, (char_u
*)"kPlus"},
2262 {K_KMINUS
, (char_u
*)"kMinus"},
2263 {K_KDIVIDE
, (char_u
*)"kDivide"},
2264 {K_KMULTIPLY
, (char_u
*)"kMultiply"},
2265 {K_KENTER
, (char_u
*)"kEnter"},
2266 {K_KPOINT
, (char_u
*)"kPoint"},
2268 {K_K0
, (char_u
*)"k0"},
2269 {K_K1
, (char_u
*)"k1"},
2270 {K_K2
, (char_u
*)"k2"},
2271 {K_K3
, (char_u
*)"k3"},
2272 {K_K4
, (char_u
*)"k4"},
2273 {K_K5
, (char_u
*)"k5"},
2274 {K_K6
, (char_u
*)"k6"},
2275 {K_K7
, (char_u
*)"k7"},
2276 {K_K8
, (char_u
*)"k8"},
2277 {K_K9
, (char_u
*)"k9"},
2279 {'<', (char_u
*)"lt"},
2281 {K_MOUSE
, (char_u
*)"Mouse"},
2282 {K_NETTERM_MOUSE
, (char_u
*)"NetMouse"},
2283 {K_DEC_MOUSE
, (char_u
*)"DecMouse"},
2284 {K_JSBTERM_MOUSE
, (char_u
*)"JsbMouse"},
2285 {K_PTERM_MOUSE
, (char_u
*)"PtermMouse"},
2286 {K_LEFTMOUSE
, (char_u
*)"LeftMouse"},
2287 {K_LEFTMOUSE_NM
, (char_u
*)"LeftMouseNM"},
2288 {K_LEFTDRAG
, (char_u
*)"LeftDrag"},
2289 {K_LEFTRELEASE
, (char_u
*)"LeftRelease"},
2290 {K_LEFTRELEASE_NM
, (char_u
*)"LeftReleaseNM"},
2291 {K_MIDDLEMOUSE
, (char_u
*)"MiddleMouse"},
2292 {K_MIDDLEDRAG
, (char_u
*)"MiddleDrag"},
2293 {K_MIDDLERELEASE
, (char_u
*)"MiddleRelease"},
2294 {K_RIGHTMOUSE
, (char_u
*)"RightMouse"},
2295 {K_RIGHTDRAG
, (char_u
*)"RightDrag"},
2296 {K_RIGHTRELEASE
, (char_u
*)"RightRelease"},
2297 {K_MOUSEDOWN
, (char_u
*)"MouseDown"},
2298 {K_MOUSEUP
, (char_u
*)"MouseUp"},
2299 {K_X1MOUSE
, (char_u
*)"X1Mouse"},
2300 {K_X1DRAG
, (char_u
*)"X1Drag"},
2301 {K_X1RELEASE
, (char_u
*)"X1Release"},
2302 {K_X2MOUSE
, (char_u
*)"X2Mouse"},
2303 {K_X2DRAG
, (char_u
*)"X2Drag"},
2304 {K_X2RELEASE
, (char_u
*)"X2Release"},
2305 {K_DROP
, (char_u
*)"Drop"},
2306 {K_ZERO
, (char_u
*)"Nul"},
2308 {K_SNR
, (char_u
*)"SNR"},
2310 {K_PLUG
, (char_u
*)"Plug"},
2314 #define KEY_NAMES_TABLE_LEN (sizeof(key_names_table) / sizeof(struct key_name_entry))
2317 static struct mousetable
2319 int pseudo_code
; /* Code for pseudo mouse event */
2320 int button
; /* Which mouse button is it? */
2321 int is_click
; /* Is it a mouse button click event? */
2322 int is_drag
; /* Is it a mouse drag event? */
2325 {(int)KE_LEFTMOUSE
, MOUSE_LEFT
, TRUE
, FALSE
},
2327 {(int)KE_LEFTMOUSE_NM
, MOUSE_LEFT
, TRUE
, FALSE
},
2329 {(int)KE_LEFTDRAG
, MOUSE_LEFT
, FALSE
, TRUE
},
2330 {(int)KE_LEFTRELEASE
, MOUSE_LEFT
, FALSE
, FALSE
},
2332 {(int)KE_LEFTRELEASE_NM
, MOUSE_LEFT
, FALSE
, FALSE
},
2334 {(int)KE_MIDDLEMOUSE
, MOUSE_MIDDLE
, TRUE
, FALSE
},
2335 {(int)KE_MIDDLEDRAG
, MOUSE_MIDDLE
, FALSE
, TRUE
},
2336 {(int)KE_MIDDLERELEASE
, MOUSE_MIDDLE
, FALSE
, FALSE
},
2337 {(int)KE_RIGHTMOUSE
, MOUSE_RIGHT
, TRUE
, FALSE
},
2338 {(int)KE_RIGHTDRAG
, MOUSE_RIGHT
, FALSE
, TRUE
},
2339 {(int)KE_RIGHTRELEASE
, MOUSE_RIGHT
, FALSE
, FALSE
},
2340 {(int)KE_X1MOUSE
, MOUSE_X1
, TRUE
, FALSE
},
2341 {(int)KE_X1DRAG
, MOUSE_X1
, FALSE
, TRUE
},
2342 {(int)KE_X1RELEASE
, MOUSE_X1
, FALSE
, FALSE
},
2343 {(int)KE_X2MOUSE
, MOUSE_X2
, TRUE
, FALSE
},
2344 {(int)KE_X2DRAG
, MOUSE_X2
, FALSE
, TRUE
},
2345 {(int)KE_X2RELEASE
, MOUSE_X2
, FALSE
, FALSE
},
2346 /* DRAG without CLICK */
2347 {(int)KE_IGNORE
, MOUSE_RELEASE
, FALSE
, TRUE
},
2348 /* RELEASE without CLICK */
2349 {(int)KE_IGNORE
, MOUSE_RELEASE
, FALSE
, FALSE
},
2352 #endif /* FEAT_MOUSE */
2355 * Return the modifier mask bit (MOD_MASK_*) which corresponds to the given
2356 * modifier name ('S' for Shift, 'C' for Ctrl etc).
2365 for (i
= 0; mod_mask_table
[i
].mod_mask
!= 0; i
++)
2366 if (c
== mod_mask_table
[i
].name
)
2367 return mod_mask_table
[i
].mod_flag
;
2372 * Check if if there is a special key code for "key" that includes the
2373 * modifiers specified.
2376 simplify_key(key
, modifiers
)
2384 if (*modifiers
& (MOD_MASK_SHIFT
| MOD_MASK_CTRL
| MOD_MASK_ALT
))
2386 /* TAB is a special case */
2387 if (key
== TAB
&& (*modifiers
& MOD_MASK_SHIFT
))
2389 *modifiers
&= ~MOD_MASK_SHIFT
;
2392 key0
= KEY2TERMCAP0(key
);
2393 key1
= KEY2TERMCAP1(key
);
2394 for (i
= 0; modifier_keys_table
[i
] != NUL
; i
+= MOD_KEYS_ENTRY_SIZE
)
2395 if (key0
== modifier_keys_table
[i
+ 3]
2396 && key1
== modifier_keys_table
[i
+ 4]
2397 && (*modifiers
& modifier_keys_table
[i
]))
2399 *modifiers
&= ~modifier_keys_table
[i
];
2400 return TERMCAP2KEY(modifier_keys_table
[i
+ 1],
2401 modifier_keys_table
[i
+ 2]);
2408 * Change <xHome> to <Home>, <xUp> to <Up>, etc.
2416 case K_XUP
: return K_UP
;
2417 case K_XDOWN
: return K_DOWN
;
2418 case K_XLEFT
: return K_LEFT
;
2419 case K_XRIGHT
: return K_RIGHT
;
2420 case K_XHOME
: return K_HOME
;
2421 case K_ZHOME
: return K_HOME
;
2422 case K_XEND
: return K_END
;
2423 case K_ZEND
: return K_END
;
2424 case K_XF1
: return K_F1
;
2425 case K_XF2
: return K_F2
;
2426 case K_XF3
: return K_F3
;
2427 case K_XF4
: return K_F4
;
2428 case K_S_XF1
: return K_S_F1
;
2429 case K_S_XF2
: return K_S_F2
;
2430 case K_S_XF3
: return K_S_F3
;
2431 case K_S_XF4
: return K_S_F4
;
2437 * Return a string which contains the name of the given key when the given
2438 * modifiers are down.
2441 get_special_key_name(c
, modifiers
)
2445 static char_u string
[MAX_KEY_NAME_LEN
+ 1];
2454 /* Key that stands for a normal character. */
2455 if (IS_SPECIAL(c
) && KEY2TERMCAP0(c
) == KS_KEY
)
2456 c
= KEY2TERMCAP1(c
);
2459 * Translate shifted special keys into unshifted keys and set modifier.
2460 * Same for CTRL and ALT modifiers.
2464 for (i
= 0; modifier_keys_table
[i
] != 0; i
+= MOD_KEYS_ENTRY_SIZE
)
2465 if ( KEY2TERMCAP0(c
) == (int)modifier_keys_table
[i
+ 1]
2466 && (int)KEY2TERMCAP1(c
) == (int)modifier_keys_table
[i
+ 2])
2468 modifiers
|= modifier_keys_table
[i
];
2469 c
= TERMCAP2KEY(modifier_keys_table
[i
+ 3],
2470 modifier_keys_table
[i
+ 4]);
2475 /* try to find the key in the special key table */
2476 table_idx
= find_special_key_in_table(c
);
2479 * When not a known special key, and not a printable character, try to
2480 * extract modifiers.
2484 && (*mb_char2len
)(c
) == 1
2489 && (!vim_isprintc(c
) || (c
& 0x7f) == ' ')
2493 modifiers
|= MOD_MASK_ALT
;
2494 /* try again, to find the un-alted key in the special key table */
2495 table_idx
= find_special_key_in_table(c
);
2497 if (table_idx
< 0 && !vim_isprintc(c
) && c
< ' ')
2504 modifiers
|= MOD_MASK_CTRL
;
2508 /* translate the modifier into a string */
2509 for (i
= 0; mod_mask_table
[i
].name
!= 'A'; i
++)
2510 if ((modifiers
& mod_mask_table
[i
].mod_mask
)
2511 == mod_mask_table
[i
].mod_flag
)
2513 string
[idx
++] = mod_mask_table
[i
].name
;
2514 string
[idx
++] = (char_u
)'-';
2517 if (table_idx
< 0) /* unknown special key, may output t_xx */
2521 string
[idx
++] = 't';
2522 string
[idx
++] = '_';
2523 string
[idx
++] = KEY2TERMCAP0(c
);
2524 string
[idx
++] = KEY2TERMCAP1(c
);
2526 /* Not a special key, only modifiers, output directly */
2530 if (has_mbyte
&& (*mb_char2len
)(c
) > 1)
2531 idx
+= (*mb_char2bytes
)(c
, string
+ idx
);
2534 if (vim_isprintc(c
))
2540 string
[idx
++] = *s
++;
2544 else /* use name of special key */
2546 STRCPY(string
+ idx
, key_names_table
[table_idx
].name
);
2547 idx
= (int)STRLEN(string
);
2549 string
[idx
++] = '>';
2555 * Try translating a <> name at (*srcp)[] to dst[].
2556 * Return the number of characters added to dst[], zero for no match.
2557 * If there is a match, srcp is advanced to after the <> name.
2558 * dst[] must be big enough to hold the result (up to six characters)!
2561 trans_special(srcp
, dst
, keycode
)
2564 int keycode
; /* prefer key code, e.g. K_DEL instead of DEL */
2570 key
= find_special_key(srcp
, &modifiers
, keycode
, FALSE
);
2574 /* Put the appropriate modifier in a string */
2577 dst
[dlen
++] = K_SPECIAL
;
2578 dst
[dlen
++] = KS_MODIFIER
;
2579 dst
[dlen
++] = modifiers
;
2582 if (IS_SPECIAL(key
))
2584 dst
[dlen
++] = K_SPECIAL
;
2585 dst
[dlen
++] = KEY2TERMCAP0(key
);
2586 dst
[dlen
++] = KEY2TERMCAP1(key
);
2589 else if (has_mbyte
&& !keycode
)
2590 dlen
+= (*mb_char2bytes
)(key
, dst
+ dlen
);
2593 dlen
= (int)(add_char2buf(key
, dst
+ dlen
) - dst
);
2601 * Try translating a <> name at (*srcp)[], return the key and modifiers.
2602 * srcp is advanced to after the <> name.
2603 * returns 0 if there is no match.
2606 find_special_key(srcp
, modp
, keycode
, keep_x_key
)
2609 int keycode
; /* prefer key code, e.g. K_DEL instead of DEL */
2610 int keep_x_key
; /* don't translate xHome to Home key */
2613 char_u
*end_of_name
;
2625 /* Find end of modifier list */
2627 for (bp
= src
+ 1; *bp
== '-' || vim_isIDc(*bp
); bp
++)
2632 if (bp
[1] != NUL
&& bp
[2] == '>')
2633 ++bp
; /* anything accepted, like <C-?> */
2635 if (bp
[0] == 't' && bp
[1] == '_' && bp
[2] && bp
[3])
2636 bp
+= 3; /* skip t_xx, xx may be '-' or '>' */
2639 if (*bp
== '>') /* found matching '>' */
2641 end_of_name
= bp
+ 1;
2643 if (STRNICMP(src
+ 1, "char-", 5) == 0 && VIM_ISDIGIT(src
[6]))
2645 /* <Char-123> or <Char-033> or <Char-0x33> */
2646 vim_str2nr(src
+ 6, NULL
, NULL
, TRUE
, TRUE
, NULL
, &n
);
2648 *srcp
= end_of_name
;
2652 /* Which modifiers are given? */
2654 for (bp
= src
+ 1; bp
< last_dash
; bp
++)
2658 bit
= name_to_mod_mask(*bp
);
2660 break; /* Illegal modifier name */
2666 * Legal modifier name.
2668 if (bp
>= last_dash
)
2671 * Modifier with single letter, or special key name.
2673 if (modifiers
!= 0 && last_dash
[2] == '>')
2677 key
= get_special_key_code(last_dash
+ 1);
2679 key
= handle_x_keys(key
);
2683 * get_special_key_code() may return NUL for invalid
2689 * Only use a modifier when there is no special key code that
2690 * includes the modifier.
2692 key
= simplify_key(key
, &modifiers
);
2696 /* don't want keycode, use single byte code */
2699 else if (key
== K_DEL
|| key
== K_KDEL
)
2704 * Normal Key with modifier: Try to make a single byte code.
2706 if (!IS_SPECIAL(key
))
2707 key
= extract_modifiers(key
, &modifiers
);
2710 *srcp
= end_of_name
;
2719 * Try to include modifiers in the key.
2720 * Changes "Shift-a" to 'A', "Alt-A" to 0xc0, etc.
2723 extract_modifiers(key
, modp
)
2727 int modifiers
= *modp
;
2730 /* Command-key really special, No fancynest */
2731 if (!(modifiers
& MOD_MASK_CMD
))
2733 if ((modifiers
& MOD_MASK_SHIFT
) && ASCII_ISALPHA(key
))
2735 key
= TOUPPER_ASC(key
);
2736 modifiers
&= ~MOD_MASK_SHIFT
;
2738 if ((modifiers
& MOD_MASK_CTRL
)
2740 /* * TODO: EBCDIC Better use:
2741 * && (Ctrl_chr(key) || key == '?')
2743 && strchr("?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_", key
)
2746 && ((key
>= '?' && key
<= '_') || ASCII_ISALPHA(key
))
2750 key
= Ctrl_chr(key
);
2751 modifiers
&= ~MOD_MASK_CTRL
;
2752 /* <C-@> is <Nul> */
2757 /* Command-key really special, No fancynest */
2758 if (!(modifiers
& MOD_MASK_CMD
))
2760 if ((modifiers
& MOD_MASK_ALT
) && key
< 0x80
2762 && !enc_dbcs
/* avoid creating a lead byte */
2767 modifiers
&= ~MOD_MASK_ALT
; /* remove the META modifier */
2775 * Try to find key "c" in the special key table.
2776 * Return the index when found, -1 when not found.
2779 find_special_key_in_table(c
)
2784 for (i
= 0; key_names_table
[i
].name
!= NULL
; i
++)
2785 if (c
== key_names_table
[i
].key
)
2787 if (key_names_table
[i
].name
== NULL
)
2793 * Find the special key with the given name (the given string does not have to
2794 * end with NUL, the name is assumed to end before the first non-idchar).
2795 * If the name starts with "t_" the next two characters are interpreted as a
2797 * Return the key code, or 0 if not found.
2800 get_special_key_code(name
)
2808 * If it's <t_xx> we get the code for xx from the termcap
2810 if (name
[0] == 't' && name
[1] == '_' && name
[2] != NUL
&& name
[3] != NUL
)
2812 string
[0] = name
[2];
2813 string
[1] = name
[3];
2815 if (add_termcap_entry(string
, FALSE
) == OK
)
2816 return TERMCAP2KEY(name
[2], name
[3]);
2819 for (i
= 0; key_names_table
[i
].name
!= NULL
; i
++)
2821 table_name
= key_names_table
[i
].name
;
2822 for (j
= 0; vim_isIDc(name
[j
]) && table_name
[j
] != NUL
; j
++)
2823 if (TOLOWER_ASC(table_name
[j
]) != TOLOWER_ASC(name
[j
]))
2825 if (!vim_isIDc(name
[j
]) && table_name
[j
] == NUL
)
2826 return key_names_table
[i
].key
;
2831 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
2836 if (i
>= KEY_NAMES_TABLE_LEN
)
2838 return key_names_table
[i
].name
;
2842 #if defined(FEAT_MOUSE) || defined(PROTO)
2844 * Look up the given mouse code to return the relevant information in the other
2845 * arguments. Return which button is down or was released.
2848 get_mouse_button(code
, is_click
, is_drag
)
2855 for (i
= 0; mouse_table
[i
].pseudo_code
; i
++)
2856 if (code
== mouse_table
[i
].pseudo_code
)
2858 *is_click
= mouse_table
[i
].is_click
;
2859 *is_drag
= mouse_table
[i
].is_drag
;
2860 return mouse_table
[i
].button
;
2862 return 0; /* Shouldn't get here */
2866 * Return the appropriate pseudo mouse event token (KE_LEFTMOUSE etc) based on
2867 * the given information about which mouse button is down, and whether the
2868 * mouse was clicked, dragged or released.
2871 get_pseudo_mouse_code(button
, is_click
, is_drag
)
2872 int button
; /* eg MOUSE_LEFT */
2878 for (i
= 0; mouse_table
[i
].pseudo_code
; i
++)
2879 if (button
== mouse_table
[i
].button
2880 && is_click
== mouse_table
[i
].is_click
2881 && is_drag
== mouse_table
[i
].is_drag
)
2884 /* Trick: a non mappable left click and release has mouse_col -1
2885 * or added MOUSE_COLOFF. Used for 'mousefocus' in
2886 * gui_mouse_moved() */
2887 if (mouse_col
< 0 || mouse_col
> MOUSE_COLOFF
)
2892 mouse_col
-= MOUSE_COLOFF
;
2893 if (mouse_table
[i
].pseudo_code
== (int)KE_LEFTMOUSE
)
2894 return (int)KE_LEFTMOUSE_NM
;
2895 if (mouse_table
[i
].pseudo_code
== (int)KE_LEFTRELEASE
)
2896 return (int)KE_LEFTRELEASE_NM
;
2899 return mouse_table
[i
].pseudo_code
;
2901 return (int)KE_IGNORE
; /* not recognized, ignore it */
2903 #endif /* FEAT_MOUSE */
2906 * Return the current end-of-line type: EOL_DOS, EOL_UNIX or EOL_MAC.
2912 int c
= *buf
->b_p_ff
;
2914 if (buf
->b_p_bin
|| c
== 'u')
2922 * Like get_fileformat(), but override 'fileformat' with "p" for "++opt=val"
2926 get_fileformat_force(buf
, eap
)
2928 exarg_T
*eap
; /* can be NULL! */
2932 if (eap
!= NULL
&& eap
->force_ff
!= 0)
2933 c
= eap
->cmd
[eap
->force_ff
];
2936 if ((eap
!= NULL
&& eap
->force_bin
!= 0)
2937 ? (eap
->force_bin
== FORCE_BIN
) : buf
->b_p_bin
)
2949 * Set the current end-of-line type to EOL_DOS, EOL_UNIX or EOL_MAC.
2950 * Sets both 'textmode' and 'fileformat'.
2951 * Note: Does _not_ set global value of 'textmode'!
2954 set_fileformat(t
, opt_flags
)
2956 int opt_flags
; /* OPT_LOCAL and/or OPT_GLOBAL */
2964 curbuf
->b_p_tx
= TRUE
;
2968 curbuf
->b_p_tx
= FALSE
;
2972 curbuf
->b_p_tx
= FALSE
;
2976 set_string_option_direct((char_u
*)"ff", -1, (char_u
*)p
,
2977 OPT_FREE
| opt_flags
, 0);
2980 /* This may cause the buffer to become (un)modified. */
2981 check_status(curbuf
);
2982 redraw_tabline
= TRUE
;
2985 need_maketitle
= TRUE
; /* set window title later */
2990 * Return the default fileformat from 'fileformats'.
2993 default_fileformat()
2997 case 'm': return EOL_MAC
;
2998 case 'd': return EOL_DOS
;
3004 * Call shell. Calls mch_call_shell, with 'shellxquote' added.
3007 call_shell(cmd
, opt
)
3014 proftime_T wait_time
;
3020 smsg((char_u
*)_("Calling shell to execute: \"%s\""),
3021 cmd
== NULL
? p_sh
: cmd
);
3028 if (do_profiling
== PROF_YES
)
3029 prof_child_enter(&wait_time
);
3034 EMSG(_(e_shellempty
));
3039 #ifdef FEAT_GUI_MSWIN
3040 /* Don't hide the pointer while executing a shell command. */
3041 gui_mch_mousehide(FALSE
);
3046 /* The external command may update a tags file, clear cached tags. */
3049 if (cmd
== NULL
|| *p_sxq
== NUL
)
3050 retval
= mch_call_shell(cmd
, opt
);
3053 ncmd
= alloc((unsigned)(STRLEN(cmd
) + STRLEN(p_sxq
) * 2 + 1));
3056 STRCPY(ncmd
, p_sxq
);
3058 STRCAT(ncmd
, p_sxq
);
3059 retval
= mch_call_shell(ncmd
, opt
);
3069 * Check the window size, in case it changed while executing the
3072 shell_resized_check();
3076 set_vim_var_nr(VV_SHELL_ERROR
, (long)retval
);
3077 # ifdef FEAT_PROFILE
3078 if (do_profiling
== PROF_YES
)
3079 prof_child_exit(&wait_time
);
3087 * VISUAL, SELECTMODE and OP_PENDING State are never set, they are equal to
3088 * NORMAL State with a condition. This function returns the real State.
3110 #if defined(FEAT_MBYTE) || defined(PROTO)
3112 * Return TRUE if "p" points to just after a path separator.
3113 * Take care of multi-byte characters.
3114 * "b" must point to the start of the file name
3121 return vim_ispathsep(p
[-1])
3122 && (!has_mbyte
|| (*mb_head_off
)(b
, p
- 1) == 0);
3127 * Return TRUE if file names "f1" and "f2" are in the same directory.
3128 * "f1" may be a short name, "f2" must be a full path.
3131 same_directory(f1
, f2
)
3135 char_u ffname
[MAXPATHL
];
3140 if (f1
== NULL
|| f2
== NULL
)
3143 (void)vim_FullName(f1
, ffname
, MAXPATHL
, FALSE
);
3144 t1
= gettail_sep(ffname
);
3145 t2
= gettail_sep(f2
);
3146 return (t1
- ffname
== t2
- f2
3147 && pathcmp((char *)ffname
, (char *)f2
, (int)(t1
- ffname
)) == 0);
3150 #if defined(FEAT_SESSION) || defined(MSWIN) || defined(FEAT_GUI_MAC) \
3151 || ((defined(FEAT_GUI_GTK)) \
3152 && ( defined(FEAT_WINDOWS) || defined(FEAT_DND)) ) \
3153 || defined(FEAT_SUN_WORKSHOP) || defined(FEAT_NETBEANS_INTG) \
3156 * Change to a file's directory.
3157 * Caller must call shorten_fnames()!
3158 * Return OK or FAIL.
3161 vim_chdirfile(fname
)
3164 char_u dir
[MAXPATHL
];
3166 vim_strncpy(dir
, fname
, MAXPATHL
- 1);
3167 *gettail_sep(dir
) = NUL
;
3168 return mch_chdir((char *)dir
) == 0 ? OK
: FAIL
;
3172 #if defined(STAT_IGNORES_SLASH) || defined(PROTO)
3174 * Check if "name" ends in a slash and is not a directory.
3175 * Used for systems where stat() ignores a trailing slash on a file name.
3176 * The Vim code assumes a trailing slash is only ignored for a directory.
3183 return FALSE
; /* no file name is not illegal */
3184 if (name
[strlen(name
) - 1] != '/')
3185 return FALSE
; /* no trailing slash */
3186 if (mch_isdir((char_u
*)name
))
3187 return FALSE
; /* trailing slash for a directory */
3192 #if defined(CURSOR_SHAPE) || defined(PROTO)
3195 * Handling of cursor and mouse pointer shapes in various modes.
3198 cursorentry_T shape_table
[SHAPE_IDX_COUNT
] =
3200 /* The values will be filled in from the 'guicursor' and 'mouseshape'
3201 * defaults when Vim starts.
3202 * Adjust the SHAPE_IDX_ defines when making changes! */
3203 {0, 0, 0, 700L, 400L, 250L, 0, 0, "n", SHAPE_CURSOR
+SHAPE_MOUSE
},
3204 {0, 0, 0, 700L, 400L, 250L, 0, 0, "v", SHAPE_CURSOR
+SHAPE_MOUSE
},
3205 {0, 0, 0, 700L, 400L, 250L, 0, 0, "i", SHAPE_CURSOR
+SHAPE_MOUSE
},
3206 {0, 0, 0, 700L, 400L, 250L, 0, 0, "r", SHAPE_CURSOR
+SHAPE_MOUSE
},
3207 {0, 0, 0, 700L, 400L, 250L, 0, 0, "c", SHAPE_CURSOR
+SHAPE_MOUSE
},
3208 {0, 0, 0, 700L, 400L, 250L, 0, 0, "ci", SHAPE_CURSOR
+SHAPE_MOUSE
},
3209 {0, 0, 0, 700L, 400L, 250L, 0, 0, "cr", SHAPE_CURSOR
+SHAPE_MOUSE
},
3210 {0, 0, 0, 700L, 400L, 250L, 0, 0, "o", SHAPE_CURSOR
+SHAPE_MOUSE
},
3211 {0, 0, 0, 700L, 400L, 250L, 0, 0, "ve", SHAPE_CURSOR
+SHAPE_MOUSE
},
3212 {0, 0, 0, 0L, 0L, 0L, 0, 0, "e", SHAPE_MOUSE
},
3213 {0, 0, 0, 0L, 0L, 0L, 0, 0, "s", SHAPE_MOUSE
},
3214 {0, 0, 0, 0L, 0L, 0L, 0, 0, "sd", SHAPE_MOUSE
},
3215 {0, 0, 0, 0L, 0L, 0L, 0, 0, "vs", SHAPE_MOUSE
},
3216 {0, 0, 0, 0L, 0L, 0L, 0, 0, "vd", SHAPE_MOUSE
},
3217 {0, 0, 0, 0L, 0L, 0L, 0, 0, "m", SHAPE_MOUSE
},
3218 {0, 0, 0, 0L, 0L, 0L, 0, 0, "ml", SHAPE_MOUSE
},
3219 {0, 0, 0, 100L, 100L, 100L, 0, 0, "sm", SHAPE_CURSOR
},
3222 #ifdef FEAT_MOUSESHAPE
3224 * Table with names for mouse shapes. Keep in sync with all the tables for
3225 * mch_set_mouse_shape()!.
3227 static char * mshape_names
[] =
3229 "arrow", /* default, must be the first one */
3230 "blank", /* hidden */
3250 * Parse the 'guicursor' option ("what" is SHAPE_CURSOR) or 'mouseshape'
3251 * ("what" is SHAPE_MOUSE).
3252 * Returns error message for an illegal option, NULL otherwise.
3255 parse_shape_opt(what
)
3263 int idx
= 0; /* init for GCC */
3268 int found_ve
= FALSE
; /* found "ve" flag */
3272 * First round: check for errors; second round: do it for real.
3274 for (round
= 1; round
<= 2; ++round
)
3277 * Repeat for all comma separated parts.
3279 #ifdef FEAT_MOUSESHAPE
3280 if (what
== SHAPE_MOUSE
)
3281 modep
= p_mouseshape
;
3284 modep
= p_guicursor
;
3285 while (*modep
!= NUL
)
3287 colonp
= vim_strchr(modep
, ':');
3289 return (char_u
*)N_("E545: Missing colon");
3290 if (colonp
== modep
)
3291 return (char_u
*)N_("E546: Illegal mode");
3292 commap
= vim_strchr(modep
, ',');
3295 * Repeat for all mode's before the colon.
3296 * For the 'a' mode, we loop to handle all the modes.
3299 while (modep
< colonp
|| all_idx
>= 0)
3303 /* Find the mode. */
3304 if (modep
[1] == '-' || modep
[1] == ':')
3308 if (len
== 1 && TOLOWER_ASC(modep
[0]) == 'a')
3309 all_idx
= SHAPE_IDX_COUNT
- 1;
3312 for (idx
= 0; idx
< SHAPE_IDX_COUNT
; ++idx
)
3313 if (STRNICMP(modep
, shape_table
[idx
].name
, len
)
3316 if (idx
== SHAPE_IDX_COUNT
3317 || (shape_table
[idx
].used_for
& what
) == 0)
3318 return (char_u
*)N_("E546: Illegal mode");
3319 if (len
== 2 && modep
[0] == 'v' && modep
[1] == 'e')
3327 else if (round
== 2)
3329 #ifdef FEAT_MOUSESHAPE
3330 if (what
== SHAPE_MOUSE
)
3332 /* Set the default, for the missing parts */
3333 shape_table
[idx
].mshape
= 0;
3338 /* Set the defaults, for the missing parts */
3339 shape_table
[idx
].shape
= SHAPE_BLOCK
;
3340 shape_table
[idx
].blinkwait
= 700L;
3341 shape_table
[idx
].blinkon
= 400L;
3342 shape_table
[idx
].blinkoff
= 250L;
3346 /* Parse the part after the colon */
3347 for (p
= colonp
+ 1; *p
&& *p
!= ','; )
3349 #ifdef FEAT_MOUSESHAPE
3350 if (what
== SHAPE_MOUSE
)
3354 if (mshape_names
[i
] == NULL
)
3356 if (!VIM_ISDIGIT(*p
))
3357 return (char_u
*)N_("E547: Illegal mouseshape");
3359 shape_table
[idx
].mshape
=
3360 getdigits(&p
) + MSHAPE_NUMBERED
;
3362 (void)getdigits(&p
);
3365 len
= (int)STRLEN(mshape_names
[i
]);
3366 if (STRNICMP(p
, mshape_names
[i
], len
) == 0)
3369 shape_table
[idx
].mshape
= i
;
3375 else /* if (what == SHAPE_MOUSE) */
3379 * First handle the ones with a number argument.
3383 if (STRNICMP(p
, "ver", 3) == 0)
3385 else if (STRNICMP(p
, "hor", 3) == 0)
3387 else if (STRNICMP(p
, "blinkwait", 9) == 0)
3389 else if (STRNICMP(p
, "blinkon", 7) == 0)
3391 else if (STRNICMP(p
, "blinkoff", 8) == 0)
3396 if (!VIM_ISDIGIT(*p
))
3397 return (char_u
*)N_("E548: digit expected");
3399 if (len
== 3) /* "ver" or "hor" */
3402 return (char_u
*)N_("E549: Illegal percentage");
3405 if (TOLOWER_ASC(i
) == 'v')
3406 shape_table
[idx
].shape
= SHAPE_VER
;
3408 shape_table
[idx
].shape
= SHAPE_HOR
;
3409 shape_table
[idx
].percentage
= n
;
3412 else if (round
== 2)
3415 shape_table
[idx
].blinkwait
= n
;
3417 shape_table
[idx
].blinkon
= n
;
3419 shape_table
[idx
].blinkoff
= n
;
3422 else if (STRNICMP(p
, "block", 5) == 0)
3425 shape_table
[idx
].shape
= SHAPE_BLOCK
;
3428 else /* must be a highlight group name then */
3430 endp
= vim_strchr(p
, '-');
3431 if (commap
== NULL
) /* last part */
3434 endp
= p
+ STRLEN(p
); /* find end of part */
3436 else if (endp
> commap
|| endp
== NULL
)
3438 slashp
= vim_strchr(p
, '/');
3439 if (slashp
!= NULL
&& slashp
< endp
)
3441 /* "group/langmap_group" */
3442 i
= syn_check_group(p
, (int)(slashp
- p
));
3447 shape_table
[idx
].id
= syn_check_group(p
,
3449 shape_table
[idx
].id_lm
= shape_table
[idx
].id
;
3450 if (slashp
!= NULL
&& slashp
< endp
)
3451 shape_table
[idx
].id
= i
;
3455 } /* if (what != SHAPE_MOUSE) */
3467 /* If the 's' flag is not given, use the 'v' cursor for 's' */
3470 #ifdef FEAT_MOUSESHAPE
3471 if (what
== SHAPE_MOUSE
)
3473 shape_table
[SHAPE_IDX_VE
].mshape
= shape_table
[SHAPE_IDX_V
].mshape
;
3478 shape_table
[SHAPE_IDX_VE
].shape
= shape_table
[SHAPE_IDX_V
].shape
;
3479 shape_table
[SHAPE_IDX_VE
].percentage
=
3480 shape_table
[SHAPE_IDX_V
].percentage
;
3481 shape_table
[SHAPE_IDX_VE
].blinkwait
=
3482 shape_table
[SHAPE_IDX_V
].blinkwait
;
3483 shape_table
[SHAPE_IDX_VE
].blinkon
=
3484 shape_table
[SHAPE_IDX_V
].blinkon
;
3485 shape_table
[SHAPE_IDX_VE
].blinkoff
=
3486 shape_table
[SHAPE_IDX_V
].blinkoff
;
3487 shape_table
[SHAPE_IDX_VE
].id
= shape_table
[SHAPE_IDX_V
].id
;
3488 shape_table
[SHAPE_IDX_VE
].id_lm
= shape_table
[SHAPE_IDX_V
].id_lm
;
3495 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \
3496 || defined(FEAT_MOUSESHAPE) || defined(PROTO)
3498 * Return the index into shape_table[] for the current mode.
3499 * When "mouse" is TRUE, consider indexes valid for the mouse pointer.
3502 get_shape_idx(mouse
)
3505 #ifdef FEAT_MOUSESHAPE
3506 if (mouse
&& (State
== HITRETURN
|| State
== ASKMORE
))
3510 gui_mch_getmouse(&x
, &y
);
3511 if (Y_2_ROW(y
) == Rows
- 1)
3512 return SHAPE_IDX_MOREL
;
3514 return SHAPE_IDX_MORE
;
3516 if (mouse
&& drag_status_line
)
3517 return SHAPE_IDX_SDRAG
;
3518 # ifdef FEAT_VERTSPLIT
3519 if (mouse
&& drag_sep_line
)
3520 return SHAPE_IDX_VDRAG
;
3523 if (!mouse
&& State
== SHOWMATCH
)
3524 return SHAPE_IDX_SM
;
3525 #ifdef FEAT_VREPLACE
3526 if (State
& VREPLACE_FLAG
)
3529 if (State
& REPLACE_FLAG
)
3533 if (State
& CMDLINE
)
3535 if (cmdline_at_end())
3537 if (cmdline_overstrike())
3538 return SHAPE_IDX_CR
;
3539 return SHAPE_IDX_CI
;
3547 return SHAPE_IDX_VE
;
3556 # if defined(FEAT_MOUSESHAPE) || defined(PROTO)
3557 static int old_mouse_shape
= 0;
3560 * Set the mouse shape:
3561 * If "shape" is -1, use shape depending on the current mode,
3562 * depending on the current state.
3563 * If "shape" is -2, only update the shape when it's CLINE or STATUS (used
3564 * when the mouse moves off the status or command line).
3567 update_mouseshape(shape_idx
)
3570 int new_mouse_shape
;
3572 /* Only works in GUI mode. */
3573 if (!gui
.in_use
|| gui
.starting
)
3576 /* Postpone the updating when more is to come. Speeds up executing of
3578 if (shape_idx
== -1 && char_avail())
3580 postponed_mouseshape
= TRUE
;
3584 /* When ignoring the mouse don't change shape on the statusline. */
3586 && (shape_idx
== SHAPE_IDX_CLINE
3587 || shape_idx
== SHAPE_IDX_STATUS
3588 || shape_idx
== SHAPE_IDX_VSEP
))
3592 && old_mouse_shape
!= shape_table
[SHAPE_IDX_CLINE
].mshape
3593 && old_mouse_shape
!= shape_table
[SHAPE_IDX_STATUS
].mshape
3594 && old_mouse_shape
!= shape_table
[SHAPE_IDX_VSEP
].mshape
)
3597 new_mouse_shape
= shape_table
[get_shape_idx(TRUE
)].mshape
;
3599 new_mouse_shape
= shape_table
[shape_idx
].mshape
;
3600 if (new_mouse_shape
!= old_mouse_shape
)
3602 mch_set_mouse_shape(new_mouse_shape
);
3603 old_mouse_shape
= new_mouse_shape
;
3605 postponed_mouseshape
= FALSE
;
3609 #endif /* CURSOR_SHAPE */
3614 * Optional encryption support.
3615 * Mohsin Ahmed, mosh@sasi.com, 98-09-24
3616 * Based on zip/crypt sources.
3618 * NOTE FOR USA: Since 2000 exporting this code from the USA is allowed to
3619 * most countries. There are a few exceptions, but that still should not be a
3620 * problem since this code was originally created in Europe and India.
3625 typedef unsigned short ush
; /* unsigned 16-bit value */
3626 typedef unsigned long ulg
; /* unsigned 32-bit value */
3628 static void make_crc_tab
__ARGS((void));
3630 static ulg crc_32_tab
[256];
3633 * Fill the CRC table.
3639 static int done
= FALSE
;
3643 for (t
= 0; t
< 256; t
++)
3646 for (s
= 0; s
< 8; s
++)
3647 v
= (v
>> 1) ^ ((v
& 1) * (ulg
)0xedb88320L
);
3653 #define CRC32(c, b) (crc_32_tab[((int)(c) ^ (b)) & 0xff] ^ ((c) >> 8))
3656 static ulg keys
[3]; /* keys defining the pseudo-random sequence */
3659 * Return the next byte in the pseudo-random sequence
3666 temp
= (ush
)keys
[2] | 2;
3667 return (int)(((unsigned)(temp
* (temp
^ 1)) >> 8) & 0xff);
3671 * Update the encryption keys with the next byte of plain text
3675 int c
; /* byte of plain text */
3677 keys
[0] = CRC32(keys
[0], c
);
3678 keys
[1] += keys
[0] & 0xff;
3679 keys
[1] = keys
[1] * 134775813L + 1;
3680 keys
[2] = CRC32(keys
[2], (int)(keys
[1] >> 24));
3685 * Initialize the encryption keys and the random header according to
3686 * the given password.
3687 * If "passwd" is NULL or empty, don't do anything.
3690 crypt_init_keys(passwd
)
3691 char_u
*passwd
; /* password string with which to modify keys */
3693 if (passwd
!= NULL
&& *passwd
!= NUL
)
3696 keys
[0] = 305419896L;
3697 keys
[1] = 591751049L;
3698 keys
[2] = 878082192L;
3699 while (*passwd
!= '\0')
3700 update_keys((int)*passwd
++);
3705 * Ask the user for a crypt key.
3706 * When "store" is TRUE, the new key in stored in the 'key' option, and the
3707 * 'key' option value is returned: Don't free it.
3708 * When "store" is FALSE, the typed key is returned in allocated memory.
3709 * Returns NULL on failure.
3712 get_crypt_key(store
, twice
)
3714 int twice
; /* Ask for the key twice. */
3716 char_u
*p1
, *p2
= NULL
;
3719 for (round
= 0; ; ++round
)
3721 cmdline_star
= TRUE
;
3722 cmdline_row
= msg_row
;
3723 p1
= getcmdline_prompt(NUL
, round
== 0
3724 ? (char_u
*)_("Enter encryption key: ")
3725 : (char_u
*)_("Enter same key again: "), 0, EXPAND_NOTHING
,
3727 cmdline_star
= FALSE
;
3734 if (p2
!= NULL
&& STRCMP(p1
, p2
) != 0)
3736 MSG(_("Keys don't match!"));
3740 round
= -1; /* do it again */
3745 set_option_value((char_u
*)"key", 0L, p1
, OPT_LOCAL
);
3747 p1
= curbuf
->b_p_key
;
3754 /* since the user typed this, no need to wait for return */
3755 need_wait_return
= FALSE
;
3762 #endif /* FEAT_CRYPT */
3764 /* TODO: make some #ifdef for this */
3765 /*--------[ file searching ]-------------------------------------------------*/
3767 * File searching functions for 'path', 'tags' and 'cdpath' options.
3768 * External visible functions:
3769 * vim_findfile_init() creates/initialises the search context
3770 * vim_findfile_free_visited() free list of visited files/dirs of search
3772 * vim_findfile() find a file in the search context
3773 * vim_findfile_cleanup() cleanup/free search context created by
3774 * vim_findfile_init()
3776 * All static functions and variables start with 'ff_'
3778 * In general it works like this:
3779 * First you create yourself a search context by calling vim_findfile_init().
3780 * It is possible to give a search context from a previous call to
3781 * vim_findfile_init(), so it can be reused. After this you call vim_findfile()
3782 * until you are satisfied with the result or it returns NULL. On every call it
3783 * returns the next file which matches the conditions given to
3784 * vim_findfile_init(). If it doesn't find a next file it returns NULL.
3786 * It is possible to call vim_findfile_init() again to reinitialise your search
3787 * with some new parameters. Don't forget to pass your old search context to
3788 * it, so it can reuse it and especially reuse the list of already visited
3789 * directories. If you want to delete the list of already visited directories
3790 * simply call vim_findfile_free_visited().
3792 * When you are done call vim_findfile_cleanup() to free the search context.
3794 * The function vim_findfile_init() has a long comment, which describes the
3795 * needed parameters.
3801 * Also we use an allocated search context here, this functions are NOT
3804 * To minimize parameter passing (or because I'm to lazy), only the
3805 * external visible functions get a search context as a parameter. This is
3806 * then assigned to a static global, which is used throughout the local
3811 * type for the directory search stack
3813 typedef struct ff_stack
3815 struct ff_stack
*ffs_prev
;
3817 /* the fix part (no wildcards) and the part containing the wildcards
3818 * of the search path
3820 char_u
*ffs_fix_path
;
3821 #ifdef FEAT_PATH_EXTRA
3822 char_u
*ffs_wc_path
;
3825 /* files/dirs found in the above directory, matched by the first wildcard
3828 char_u
**ffs_filearray
;
3829 int ffs_filearray_size
;
3830 char_u ffs_filearray_cur
; /* needed for partly handled dirs */
3832 /* to store status of partly handled directories
3833 * 0: we work on this directory for the first time
3834 * 1: this directory was partly searched in an earlier step
3838 /* How deep are we in the directory tree?
3839 * Counts backward from value of level parameter to vim_findfile_init
3843 /* Did we already expand '**' to an empty string? */
3844 int ffs_star_star_empty
;
3848 * type for already visited directories or files.
3850 typedef struct ff_visited
3852 struct ff_visited
*ffv_next
;
3854 #ifdef FEAT_PATH_EXTRA
3855 /* Visited directories are different if the wildcard string are
3856 * different. So we have to save it.
3858 char_u
*ffv_wc_path
;
3860 /* for unix use inode etc for comparison (needed because of links), else
3864 int ffv_dev
; /* device number (-1 if not set) */
3865 ino_t ffv_ino
; /* inode number */
3867 /* The memory for this struct is allocated according to the length of
3870 char_u ffv_fname
[1]; /* actually longer */
3874 * We might have to manage several visited lists during a search.
3875 * This is especially needed for the tags option. If tags is set to:
3876 * "./++/tags,./++/TAGS,++/tags" (replace + with *)
3877 * So we have to do 3 searches:
3878 * 1) search from the current files directory downward for the file "tags"
3879 * 2) search from the current files directory downward for the file "TAGS"
3880 * 3) search from Vims current directory downwards for the file "tags"
3881 * As you can see, the first and the third search are for the same file, so for
3882 * the third search we can use the visited list of the first search. For the
3883 * second search we must start from a empty visited list.
3884 * The struct ff_visited_list_hdr is used to manage a linked list of already
3887 typedef struct ff_visited_list_hdr
3889 struct ff_visited_list_hdr
*ffvl_next
;
3891 /* the filename the attached visited list is for */
3892 char_u
*ffvl_filename
;
3894 ff_visited_T
*ffvl_visited_list
;
3896 } ff_visited_list_hdr_T
;
3900 * '**' can be expanded to several directory levels.
3901 * Set the default maximum depth.
3903 #define FF_MAX_STAR_STAR_EXPAND ((char_u)30)
3906 * The search context:
3907 * ffsc_stack_ptr: the stack for the dirs to search
3908 * ffsc_visited_list: the currently active visited list
3909 * ffsc_dir_visited_list: the currently active visited list for search dirs
3910 * ffsc_visited_lists_list: the list of all visited lists
3911 * ffsc_dir_visited_lists_list: the list of all visited lists for search dirs
3912 * ffsc_file_to_search: the file to search for
3913 * ffsc_start_dir: the starting directory, if search path was relative
3914 * ffsc_fix_path: the fix part of the given path (without wildcards)
3915 * Needed for upward search.
3916 * ffsc_wc_path: the part of the given path containing wildcards
3917 * ffsc_level: how many levels of dirs to search downwards
3918 * ffsc_stopdirs_v: array of stop directories for upward search
3919 * ffsc_find_what: FINDFILE_BOTH, FINDFILE_DIR or FINDFILE_FILE
3921 typedef struct ff_search_ctx_T
3923 ff_stack_T
*ffsc_stack_ptr
;
3924 ff_visited_list_hdr_T
*ffsc_visited_list
;
3925 ff_visited_list_hdr_T
*ffsc_dir_visited_list
;
3926 ff_visited_list_hdr_T
*ffsc_visited_lists_list
;
3927 ff_visited_list_hdr_T
*ffsc_dir_visited_lists_list
;
3928 char_u
*ffsc_file_to_search
;
3929 char_u
*ffsc_start_dir
;
3930 char_u
*ffsc_fix_path
;
3931 #ifdef FEAT_PATH_EXTRA
3932 char_u
*ffsc_wc_path
;
3934 char_u
**ffsc_stopdirs_v
;
3939 /* locally needed functions */
3940 #ifdef FEAT_PATH_EXTRA
3941 static int ff_check_visited
__ARGS((ff_visited_T
**, char_u
*, char_u
*));
3943 static int ff_check_visited
__ARGS((ff_visited_T
**, char_u
*));
3945 static void vim_findfile_free_visited_list
__ARGS((ff_visited_list_hdr_T
**list_headp
));
3946 static void ff_free_visited_list
__ARGS((ff_visited_T
*vl
));
3947 static ff_visited_list_hdr_T
* ff_get_visited_list
__ARGS((char_u
*, ff_visited_list_hdr_T
**list_headp
));
3948 #ifdef FEAT_PATH_EXTRA
3949 static int ff_wc_equal
__ARGS((char_u
*s1
, char_u
*s2
));
3952 static void ff_push
__ARGS((ff_search_ctx_T
*search_ctx
, ff_stack_T
*stack_ptr
));
3953 static ff_stack_T
*ff_pop
__ARGS((ff_search_ctx_T
*search_ctx
));
3954 static void ff_clear
__ARGS((ff_search_ctx_T
*search_ctx
));
3955 static void ff_free_stack_element
__ARGS((ff_stack_T
*stack_ptr
));
3956 #ifdef FEAT_PATH_EXTRA
3957 static ff_stack_T
*ff_create_stack_element
__ARGS((char_u
*, char_u
*, int, int));
3959 static ff_stack_T
*ff_create_stack_element
__ARGS((char_u
*, int, int));
3961 #ifdef FEAT_PATH_EXTRA
3962 static int ff_path_in_stoplist
__ARGS((char_u
*, int, char_u
**));
3967 * if someone likes findfirst/findnext, here are the functions
3971 static void *ff_fn_search_context
= NULL
;
3974 vim_findfirst(path
, filename
, level
)
3979 ff_fn_search_context
=
3980 vim_findfile_init(path
, filename
, NULL
, level
, TRUE
, FALSE
,
3981 ff_fn_search_context
, rel_fname
);
3982 if (NULL
== ff_fn_search_context
)
3985 return vim_findnext()
3991 char_u
*ret
= vim_findfile(ff_fn_search_context
);
3995 vim_findfile_cleanup(ff_fn_search_context
);
3996 ff_fn_search_context
= NULL
;
4003 * Initialization routine for vim_findfile.
4005 * Returns the newly allocated search context or NULL if an error occured.
4007 * Don't forget to clean up by calling vim_findfile_cleanup() if you are done
4008 * with the search context.
4010 * Find the file 'filename' in the directory 'path'.
4011 * The parameter 'path' may contain wildcards. If so only search 'level'
4012 * directories deep. The parameter 'level' is the absolute maximum and is
4013 * not related to restricts given to the '**' wildcard. If 'level' is 100
4014 * and you use '**200' vim_findfile() will stop after 100 levels.
4016 * 'filename' cannot contain wildcards! It is used as-is, no backslashes to
4017 * escape special characters.
4019 * If 'stopdirs' is not NULL and nothing is found downward, the search is
4020 * restarted on the next higher directory level. This is repeated until the
4021 * start-directory of a search is contained in 'stopdirs'. 'stopdirs' has the
4022 * format ";*<dirname>*\(;<dirname>\)*;\=$".
4024 * If the 'path' is relative, the starting dir for the search is either VIM's
4025 * current dir or if the path starts with "./" the current files dir.
4026 * If the 'path' is absolut, the starting dir is that part of the path before
4027 * the first wildcard.
4029 * Upward search is only done on the starting dir.
4031 * If 'free_visited' is TRUE the list of already visited files/directories is
4032 * cleared. Set this to FALSE if you just want to search from another
4033 * directory, but want to be sure that no directory from a previous search is
4034 * searched again. This is useful if you search for a file at different places.
4035 * The list of visited files/dirs can also be cleared with the function
4036 * vim_findfile_free_visited().
4038 * Set the parameter 'find_what' to FINDFILE_DIR if you want to search for
4039 * directories only, FINDFILE_FILE for files only, FINDFILE_BOTH for both.
4041 * A search context returned by a previous call to vim_findfile_init() can be
4042 * passed in the parameter "search_ctx_arg". This context is reused and
4043 * reinitialized with the new parameters. The list of already visited
4044 * directories from this context is only deleted if the parameter
4045 * "free_visited" is true. Be aware that the passed "search_ctx_arg" is freed
4046 * if the reinitialization fails.
4048 * If you don't have a search context from a previous call "search_ctx_arg"
4051 * This function silently ignores a few errors, vim_findfile() will have
4052 * limited functionality then.
4056 vim_findfile_init(path
, filename
, stopdirs
, level
, free_visited
, find_what
,
4057 search_ctx_arg
, tagfile
, rel_fname
)
4064 void *search_ctx_arg
;
4066 char_u
*rel_fname
; /* file name to use for "." */
4068 #ifdef FEAT_PATH_EXTRA
4072 ff_search_ctx_T
*search_ctx
;
4074 /* If a search context is given by the caller, reuse it, else allocate a
4077 if (search_ctx_arg
!= NULL
)
4078 search_ctx
= search_ctx_arg
;
4081 search_ctx
= (ff_search_ctx_T
*)alloc((unsigned)sizeof(ff_search_ctx_T
));
4082 if (search_ctx
== NULL
)
4084 memset(search_ctx
, 0, sizeof(ff_search_ctx_T
));
4086 search_ctx
->ffsc_find_what
= find_what
;
4088 /* clear the search context, but NOT the visited lists */
4089 ff_clear(search_ctx
);
4091 /* clear visited list if wanted */
4092 if (free_visited
== TRUE
)
4093 vim_findfile_free_visited(search_ctx
);
4096 /* Reuse old visited lists. Get the visited list for the given
4097 * filename. If no list for the current filename exists, creates a new
4099 search_ctx
->ffsc_visited_list
= ff_get_visited_list(filename
,
4100 &search_ctx
->ffsc_visited_lists_list
);
4101 if (search_ctx
->ffsc_visited_list
== NULL
)
4103 search_ctx
->ffsc_dir_visited_list
= ff_get_visited_list(filename
,
4104 &search_ctx
->ffsc_dir_visited_lists_list
);
4105 if (search_ctx
->ffsc_dir_visited_list
== NULL
)
4109 if (ff_expand_buffer
== NULL
)
4111 ff_expand_buffer
= (char_u
*)alloc(MAXPATHL
);
4112 if (ff_expand_buffer
== NULL
)
4116 /* Store information on starting dir now if path is relative.
4117 * If path is absolute, we do that later. */
4119 && (vim_ispathsep(path
[1]) || path
[1] == NUL
)
4120 && (!tagfile
|| vim_strchr(p_cpo
, CPO_DOTTAG
) == NULL
)
4121 && rel_fname
!= NULL
)
4123 int len
= (int)(gettail(rel_fname
) - rel_fname
);
4125 if (!vim_isAbsName(rel_fname
) && len
+ 1 < MAXPATHL
)
4127 /* Make the start dir an absolute path name. */
4128 vim_strncpy(ff_expand_buffer
, rel_fname
, len
);
4129 search_ctx
->ffsc_start_dir
= FullName_save(ff_expand_buffer
, FALSE
);
4132 search_ctx
->ffsc_start_dir
= vim_strnsave(rel_fname
, len
);
4133 if (search_ctx
->ffsc_start_dir
== NULL
)
4138 else if (*path
== NUL
|| !vim_isAbsName(path
))
4140 #ifdef BACKSLASH_IN_FILENAME
4141 /* "c:dir" needs "c:" to be expanded, otherwise use current dir */
4142 if (*path
!= NUL
&& path
[1] == ':')
4149 if (vim_FullName(drive
, ff_expand_buffer
, MAXPATHL
, TRUE
) == FAIL
)
4155 if (mch_dirname(ff_expand_buffer
, MAXPATHL
) == FAIL
)
4158 search_ctx
->ffsc_start_dir
= vim_strsave(ff_expand_buffer
);
4159 if (search_ctx
->ffsc_start_dir
== NULL
)
4162 #ifdef BACKSLASH_IN_FILENAME
4163 /* A path that starts with "/dir" is relative to the drive, not to the
4164 * directory (but not for "//machine/dir"). Only use the drive name. */
4165 if ((*path
== '/' || *path
== '\\')
4166 && path
[1] != path
[0]
4167 && search_ctx
->ffsc_start_dir
[1] == ':')
4168 search_ctx
->ffsc_start_dir
[2] = NUL
;
4172 #ifdef FEAT_PATH_EXTRA
4174 * If stopdirs are given, split them into an array of pointers.
4175 * If this fails (mem allocation), there is no upward search at all or a
4176 * stop directory is not recognized -> continue silently.
4177 * If stopdirs just contains a ";" or is empty,
4178 * search_ctx->ffsc_stopdirs_v will only contain a NULL pointer. This
4179 * is handled as unlimited upward search. See function
4180 * ff_path_in_stoplist() for details.
4182 if (stopdirs
!= NULL
)
4184 char_u
*walker
= stopdirs
;
4187 while (*walker
== ';')
4191 search_ctx
->ffsc_stopdirs_v
=
4192 (char_u
**)alloc((unsigned)sizeof(char_u
*));
4194 if (search_ctx
->ffsc_stopdirs_v
!= NULL
)
4202 ptr
= vim_realloc(search_ctx
->ffsc_stopdirs_v
,
4203 (dircount
+ 1) * sizeof(char_u
*));
4205 search_ctx
->ffsc_stopdirs_v
= ptr
;
4207 /* ignore, keep what we have and continue */
4209 walker
= vim_strchr(walker
, ';');
4212 search_ctx
->ffsc_stopdirs_v
[dircount
-1] =
4213 vim_strnsave(helper
, (int)(walker
- helper
));
4217 /* this might be "", which means ascent till top
4218 * of directory tree.
4220 search_ctx
->ffsc_stopdirs_v
[dircount
-1] =
4221 vim_strsave(helper
);
4225 } while (walker
!= NULL
);
4226 search_ctx
->ffsc_stopdirs_v
[dircount
-1] = NULL
;
4231 #ifdef FEAT_PATH_EXTRA
4232 search_ctx
->ffsc_level
= level
;
4236 * -wildcard_stuff (might be NULL)
4238 wc_part
= vim_strchr(path
, '*');
4239 if (wc_part
!= NULL
)
4245 /* save the fix part of the path */
4246 search_ctx
->ffsc_fix_path
= vim_strnsave(path
, (int)(wc_part
- path
));
4249 * copy wc_path and add restricts to the '**' wildcard.
4250 * The octet after a '**' is used as a (binary) counter.
4251 * So '**3' is transposed to '**^C' ('^C' is ASCII value 3)
4252 * or '**76' is transposed to '**N'( 'N' is ASCII value 76).
4253 * For EBCDIC you get different character values.
4254 * If no restrict is given after '**' the default is used.
4255 * Due to this technic the path looks awful if you print it as a
4259 while (*wc_part
!= NUL
)
4261 if (STRNCMP(wc_part
, "**", 2) == 0)
4263 ff_expand_buffer
[len
++] = *wc_part
++;
4264 ff_expand_buffer
[len
++] = *wc_part
++;
4266 llevel
= strtol((char *)wc_part
, &errpt
, 10);
4267 if ((char_u
*)errpt
!= wc_part
&& llevel
> 0 && llevel
< 255)
4268 ff_expand_buffer
[len
++] = llevel
;
4269 else if ((char_u
*)errpt
!= wc_part
&& llevel
== 0)
4270 /* restrict is 0 -> remove already added '**' */
4273 ff_expand_buffer
[len
++] = FF_MAX_STAR_STAR_EXPAND
;
4274 wc_part
= (char_u
*)errpt
;
4275 if (*wc_part
!= NUL
&& !vim_ispathsep(*wc_part
))
4277 EMSG2(_("E343: Invalid path: '**[number]' must be at the end of the path or be followed by '%s'."), PATHSEPSTR
);
4282 ff_expand_buffer
[len
++] = *wc_part
++;
4284 ff_expand_buffer
[len
] = NUL
;
4285 search_ctx
->ffsc_wc_path
= vim_strsave(ff_expand_buffer
);
4287 if (search_ctx
->ffsc_wc_path
== NULL
)
4292 search_ctx
->ffsc_fix_path
= vim_strsave(path
);
4294 if (search_ctx
->ffsc_start_dir
== NULL
)
4296 /* store the fix part as startdir.
4297 * This is needed if the parameter path is fully qualified.
4299 search_ctx
->ffsc_start_dir
= vim_strsave(search_ctx
->ffsc_fix_path
);
4300 if (search_ctx
->ffsc_start_dir
)
4301 search_ctx
->ffsc_fix_path
[0] = NUL
;
4304 /* create an absolute path */
4305 STRCPY(ff_expand_buffer
, search_ctx
->ffsc_start_dir
);
4306 add_pathsep(ff_expand_buffer
);
4307 STRCAT(ff_expand_buffer
, search_ctx
->ffsc_fix_path
);
4308 add_pathsep(ff_expand_buffer
);
4310 sptr
= ff_create_stack_element(ff_expand_buffer
,
4311 #ifdef FEAT_PATH_EXTRA
4312 search_ctx
->ffsc_wc_path
,
4319 ff_push(search_ctx
, sptr
);
4321 search_ctx
->ffsc_file_to_search
= vim_strsave(filename
);
4322 if (search_ctx
->ffsc_file_to_search
== NULL
)
4329 * We clear the search context now!
4330 * Even when the caller gave us a (perhaps valid) context we free it here,
4331 * as we might have already destroyed it.
4333 vim_findfile_cleanup(search_ctx
);
4337 #if defined(FEAT_PATH_EXTRA) || defined(PROTO)
4339 * Get the stopdir string. Check that ';' is not escaped.
4342 vim_findfile_stopdir(buf
)
4345 char_u
*r_ptr
= buf
;
4347 while (*r_ptr
!= NUL
&& *r_ptr
!= ';')
4349 if (r_ptr
[0] == '\\' && r_ptr
[1] == ';')
4351 /* overwrite the escape char,
4352 * use STRLEN(r_ptr) to move the trailing '\0'
4354 STRMOVE(r_ptr
, r_ptr
+ 1);
4364 else if (*r_ptr
== NUL
)
4371 * Clean up the given search context. Can handle a NULL pointer.
4374 vim_findfile_cleanup(ctx
)
4380 vim_findfile_free_visited(ctx
);
4386 * Find a file in a search context.
4387 * The search context was created with vim_findfile_init() above.
4388 * Return a pointer to an allocated file name or NULL if nothing found.
4389 * To get all matching files call this function until you get NULL.
4391 * If the passed search_context is NULL, NULL is returned.
4393 * The search algorithm is depth first. To change this replace the
4394 * stack with a list (don't forget to leave partly searched directories on the
4398 vim_findfile(search_ctx_arg
)
4399 void *search_ctx_arg
;
4402 #ifdef FEAT_PATH_EXTRA
4403 char_u
*rest_of_wildcards
;
4404 char_u
*path_end
= NULL
;
4407 #if defined(FEAT_SEARCHPATH) || defined(FEAT_PATH_EXTRA)
4412 #ifdef FEAT_SEARCHPATH
4415 ff_search_ctx_T
*search_ctx
;
4417 if (search_ctx_arg
== NULL
)
4420 search_ctx
= (ff_search_ctx_T
*)search_ctx_arg
;
4423 * filepath is used as buffer for various actions and as the storage to
4424 * return a found filename.
4426 if ((file_path
= alloc((int)MAXPATHL
)) == NULL
)
4429 #ifdef FEAT_PATH_EXTRA
4430 /* store the end of the start dir -- needed for upward search */
4431 if (search_ctx
->ffsc_start_dir
!= NULL
)
4432 path_end
= &search_ctx
->ffsc_start_dir
[
4433 STRLEN(search_ctx
->ffsc_start_dir
)];
4436 #ifdef FEAT_PATH_EXTRA
4437 /* upward search loop */
4441 /* downward search loop */
4444 /* check if user user wants to stop the search*/
4449 /* get directory to work on from stack */
4450 stackp
= ff_pop(search_ctx
);
4455 * TODO: decide if we leave this test in
4457 * GOOD: don't search a directory(-tree) twice.
4458 * BAD: - check linked list for every new directory entered.
4459 * - check for double files also done below
4461 * Here we check if we already searched this directory.
4462 * We already searched a directory if:
4463 * 1) The directory is the same.
4464 * 2) We would use the same wildcard string.
4466 * Good if you have links on same directory via several ways
4467 * or you have selfreferences in directories (e.g. SuSE Linux 6.3:
4468 * /etc/rc.d/init.d is linked to /etc/rc.d -> endless loop)
4470 * This check is only needed for directories we work on for the
4471 * first time (hence stackp->ff_filearray == NULL)
4473 if (stackp
->ffs_filearray
== NULL
4474 && ff_check_visited(&search_ctx
->ffsc_dir_visited_list
4475 ->ffvl_visited_list
,
4476 stackp
->ffs_fix_path
4477 #ifdef FEAT_PATH_EXTRA
4478 , stackp
->ffs_wc_path
4485 verbose_enter_scroll();
4486 smsg((char_u
*)"Already Searched: %s (%s)",
4487 stackp
->ffs_fix_path
, stackp
->ffs_wc_path
);
4488 /* don't overwrite this either */
4489 msg_puts((char_u
*)"\n");
4490 verbose_leave_scroll();
4493 ff_free_stack_element(stackp
);
4497 else if (p_verbose
>= 5)
4499 verbose_enter_scroll();
4500 smsg((char_u
*)"Searching: %s (%s)",
4501 stackp
->ffs_fix_path
, stackp
->ffs_wc_path
);
4502 /* don't overwrite this either */
4503 msg_puts((char_u
*)"\n");
4504 verbose_leave_scroll();
4509 if (stackp
->ffs_level
<= 0)
4511 ff_free_stack_element(stackp
);
4518 * If no filearray till now expand wildcards
4519 * The function expand_wildcards() can handle an array of paths
4520 * and all possible expands are returned in one array. We use this
4521 * to handle the expansion of '**' into an empty string.
4523 if (stackp
->ffs_filearray
== NULL
)
4527 /* we use filepath to build the path expand_wildcards() should
4530 dirptrs
[0] = file_path
;
4533 /* if we have a start dir copy it in */
4534 if (!vim_isAbsName(stackp
->ffs_fix_path
)
4535 && search_ctx
->ffsc_start_dir
)
4537 STRCPY(file_path
, search_ctx
->ffsc_start_dir
);
4538 add_pathsep(file_path
);
4541 /* append the fix part of the search path */
4542 STRCAT(file_path
, stackp
->ffs_fix_path
);
4543 add_pathsep(file_path
);
4545 #ifdef FEAT_PATH_EXTRA
4546 rest_of_wildcards
= stackp
->ffs_wc_path
;
4547 if (*rest_of_wildcards
!= NUL
)
4549 len
= (int)STRLEN(file_path
);
4550 if (STRNCMP(rest_of_wildcards
, "**", 2) == 0)
4552 /* pointer to the restrict byte
4553 * The restrict byte is not a character!
4555 p
= rest_of_wildcards
+ 2;
4560 file_path
[len
++] = '*';
4565 /* remove '**<numb> from wildcards */
4566 STRMOVE(rest_of_wildcards
, rest_of_wildcards
+ 3);
4569 rest_of_wildcards
+= 3;
4571 if (stackp
->ffs_star_star_empty
== 0)
4573 /* if not done before, expand '**' to empty */
4574 stackp
->ffs_star_star_empty
= 1;
4575 dirptrs
[1] = stackp
->ffs_fix_path
;
4580 * Here we copy until the next path separator or the end of
4581 * the path. If we stop at a path separator, there is
4582 * still something else left. This is handled below by
4583 * pushing every directory returned from expand_wildcards()
4584 * on the stack again for further search.
4586 while (*rest_of_wildcards
4587 && !vim_ispathsep(*rest_of_wildcards
))
4588 file_path
[len
++] = *rest_of_wildcards
++;
4590 file_path
[len
] = NUL
;
4591 if (vim_ispathsep(*rest_of_wildcards
))
4592 rest_of_wildcards
++;
4597 * Expand wildcards like "*" and "$VAR".
4598 * If the path is a URL don't try this.
4600 if (path_with_url(dirptrs
[0]))
4602 stackp
->ffs_filearray
= (char_u
**)
4603 alloc((unsigned)sizeof(char *));
4604 if (stackp
->ffs_filearray
!= NULL
4605 && (stackp
->ffs_filearray
[0]
4606 = vim_strsave(dirptrs
[0])) != NULL
)
4607 stackp
->ffs_filearray_size
= 1;
4609 stackp
->ffs_filearray_size
= 0;
4612 expand_wildcards((dirptrs
[1] == NULL
) ? 1 : 2, dirptrs
,
4613 &stackp
->ffs_filearray_size
,
4614 &stackp
->ffs_filearray
,
4615 EW_DIR
|EW_ADDSLASH
|EW_SILENT
);
4617 stackp
->ffs_filearray_cur
= 0;
4618 stackp
->ffs_stage
= 0;
4620 #ifdef FEAT_PATH_EXTRA
4622 rest_of_wildcards
= &stackp
->ffs_wc_path
[
4623 STRLEN(stackp
->ffs_wc_path
)];
4626 if (stackp
->ffs_stage
== 0)
4628 /* this is the first time we work on this directory */
4629 #ifdef FEAT_PATH_EXTRA
4630 if (*rest_of_wildcards
== NUL
)
4634 * we don't have further wildcards to expand, so we have to
4635 * check for the final file now
4637 for (i
= stackp
->ffs_filearray_cur
;
4638 i
< stackp
->ffs_filearray_size
; ++i
)
4640 if (!path_with_url(stackp
->ffs_filearray
[i
])
4641 && !mch_isdir(stackp
->ffs_filearray
[i
]))
4642 continue; /* not a directory */
4644 /* prepare the filename to be checked for existance
4646 STRCPY(file_path
, stackp
->ffs_filearray
[i
]);
4647 add_pathsep(file_path
);
4648 STRCAT(file_path
, search_ctx
->ffsc_file_to_search
);
4651 * Try without extra suffix and then with suffixes
4652 * from 'suffixesadd'.
4654 #ifdef FEAT_SEARCHPATH
4655 len
= (int)STRLEN(file_path
);
4656 suf
= curbuf
->b_p_sua
;
4660 /* if file exists and we didn't already find it */
4661 if ((path_with_url(file_path
)
4662 || (mch_getperm(file_path
) >= 0
4663 && (search_ctx
->ffsc_find_what
4665 || ((search_ctx
->ffsc_find_what
4667 == mch_isdir(file_path
)))))
4669 && (ff_check_visited(
4670 &search_ctx
->ffsc_visited_list
->ffvl_visited_list
,
4672 #ifdef FEAT_PATH_EXTRA
4680 if (ff_check_visited(
4681 &search_ctx
->ffsc_visited_list
->ffvl_visited_list
,
4683 #ifdef FEAT_PATH_EXTRA
4690 verbose_enter_scroll();
4691 smsg((char_u
*)"Already: %s",
4693 /* don't overwrite this either */
4694 msg_puts((char_u
*)"\n");
4695 verbose_leave_scroll();
4701 /* push dir to examine rest of subdirs later */
4702 stackp
->ffs_filearray_cur
= i
+ 1;
4703 ff_push(search_ctx
, stackp
);
4705 if (!path_with_url(file_path
))
4706 simplify_filename(file_path
);
4707 if (mch_dirname(ff_expand_buffer
, MAXPATHL
)
4710 p
= shorten_fname(file_path
,
4713 STRMOVE(file_path
, p
);
4718 verbose_enter_scroll();
4719 smsg((char_u
*)"HIT: %s", file_path
);
4720 /* don't overwrite this either */
4721 msg_puts((char_u
*)"\n");
4722 verbose_leave_scroll();
4728 #ifdef FEAT_SEARCHPATH
4729 /* Not found or found already, try next suffix. */
4732 copy_option_part(&suf
, file_path
+ len
,
4733 MAXPATHL
- len
, ",");
4738 #ifdef FEAT_PATH_EXTRA
4742 * still wildcards left, push the directories for further
4745 for (i
= stackp
->ffs_filearray_cur
;
4746 i
< stackp
->ffs_filearray_size
; ++i
)
4748 if (!mch_isdir(stackp
->ffs_filearray
[i
]))
4749 continue; /* not a directory */
4752 ff_create_stack_element(
4753 stackp
->ffs_filearray
[i
],
4755 stackp
->ffs_level
- 1, 0));
4759 stackp
->ffs_filearray_cur
= 0;
4760 stackp
->ffs_stage
= 1;
4763 #ifdef FEAT_PATH_EXTRA
4765 * if wildcards contains '**' we have to descent till we reach the
4766 * leaves of the directory tree.
4768 if (STRNCMP(stackp
->ffs_wc_path
, "**", 2) == 0)
4770 for (i
= stackp
->ffs_filearray_cur
;
4771 i
< stackp
->ffs_filearray_size
; ++i
)
4773 if (fnamecmp(stackp
->ffs_filearray
[i
],
4774 stackp
->ffs_fix_path
) == 0)
4775 continue; /* don't repush same directory */
4776 if (!mch_isdir(stackp
->ffs_filearray
[i
]))
4777 continue; /* not a directory */
4779 ff_create_stack_element(stackp
->ffs_filearray
[i
],
4780 stackp
->ffs_wc_path
, stackp
->ffs_level
- 1, 1));
4785 /* we are done with the current directory */
4786 ff_free_stack_element(stackp
);
4790 #ifdef FEAT_PATH_EXTRA
4791 /* If we reached this, we didn't find anything downwards.
4792 * Let's check if we should do an upward search.
4794 if (search_ctx
->ffsc_start_dir
4795 && search_ctx
->ffsc_stopdirs_v
!= NULL
&& !got_int
)
4799 /* is the last starting directory in the stop list? */
4800 if (ff_path_in_stoplist(search_ctx
->ffsc_start_dir
,
4801 (int)(path_end
- search_ctx
->ffsc_start_dir
),
4802 search_ctx
->ffsc_stopdirs_v
) == TRUE
)
4805 /* cut of last dir */
4806 while (path_end
> search_ctx
->ffsc_start_dir
4807 && vim_ispathsep(*path_end
))
4809 while (path_end
> search_ctx
->ffsc_start_dir
4810 && !vim_ispathsep(path_end
[-1]))
4815 if (*search_ctx
->ffsc_start_dir
== 0)
4818 STRCPY(file_path
, search_ctx
->ffsc_start_dir
);
4819 add_pathsep(file_path
);
4820 STRCAT(file_path
, search_ctx
->ffsc_fix_path
);
4822 /* create a new stack entry */
4823 sptr
= ff_create_stack_element(file_path
,
4824 search_ctx
->ffsc_wc_path
, search_ctx
->ffsc_level
, 0);
4827 ff_push(search_ctx
, sptr
);
4834 vim_free(file_path
);
4839 * Free the list of lists of visited files and directories
4840 * Can handle it if the passed search_context is NULL;
4843 vim_findfile_free_visited(search_ctx_arg
)
4844 void *search_ctx_arg
;
4846 ff_search_ctx_T
*search_ctx
;
4848 if (search_ctx_arg
== NULL
)
4851 search_ctx
= (ff_search_ctx_T
*)search_ctx_arg
;
4852 vim_findfile_free_visited_list(&search_ctx
->ffsc_visited_lists_list
);
4853 vim_findfile_free_visited_list(&search_ctx
->ffsc_dir_visited_lists_list
);
4857 vim_findfile_free_visited_list(list_headp
)
4858 ff_visited_list_hdr_T
**list_headp
;
4860 ff_visited_list_hdr_T
*vp
;
4862 while (*list_headp
!= NULL
)
4864 vp
= (*list_headp
)->ffvl_next
;
4865 ff_free_visited_list((*list_headp
)->ffvl_visited_list
);
4867 vim_free((*list_headp
)->ffvl_filename
);
4868 vim_free(*list_headp
);
4875 ff_free_visited_list(vl
)
4883 #ifdef FEAT_PATH_EXTRA
4884 vim_free(vl
->ffv_wc_path
);
4893 * Returns the already visited list for the given filename. If none is found it
4894 * allocates a new one.
4896 static ff_visited_list_hdr_T
*
4897 ff_get_visited_list(filename
, list_headp
)
4899 ff_visited_list_hdr_T
**list_headp
;
4901 ff_visited_list_hdr_T
*retptr
= NULL
;
4903 /* check if a visited list for the given filename exists */
4904 if (*list_headp
!= NULL
)
4906 retptr
= *list_headp
;
4907 while (retptr
!= NULL
)
4909 if (fnamecmp(filename
, retptr
->ffvl_filename
) == 0)
4914 verbose_enter_scroll();
4915 smsg((char_u
*)"ff_get_visited_list: FOUND list for %s",
4917 /* don't overwrite this either */
4918 msg_puts((char_u
*)"\n");
4919 verbose_leave_scroll();
4924 retptr
= retptr
->ffvl_next
;
4931 verbose_enter_scroll();
4932 smsg((char_u
*)"ff_get_visited_list: new list for %s", filename
);
4933 /* don't overwrite this either */
4934 msg_puts((char_u
*)"\n");
4935 verbose_leave_scroll();
4940 * if we reach this we didn't find a list and we have to allocate new list
4942 retptr
= (ff_visited_list_hdr_T
*)alloc((unsigned)sizeof(*retptr
));
4946 retptr
->ffvl_visited_list
= NULL
;
4947 retptr
->ffvl_filename
= vim_strsave(filename
);
4948 if (retptr
->ffvl_filename
== NULL
)
4953 retptr
->ffvl_next
= *list_headp
;
4954 *list_headp
= retptr
;
4959 #ifdef FEAT_PATH_EXTRA
4961 * check if two wildcard paths are equal. Returns TRUE or FALSE.
4962 * They are equal if:
4963 * - both paths are NULL
4964 * - they have the same length
4965 * - char by char comparison is OK
4966 * - the only differences are in the counters behind a '**', so
4967 * '**\20' is equal to '**\24'
4979 if (s1
== NULL
|| s2
== NULL
)
4982 if (STRLEN(s1
) != STRLEN(s2
))
4985 for (i
= 0; s1
[i
] != NUL
&& s2
[i
] != NUL
; i
++)
4988 #ifdef CASE_INSENSITIVE_FILENAME
4989 && TOUPPER_LOC(s1
[i
]) != TOUPPER_LOC(s2
[i
])
4994 if (s1
[i
-1] == '*' && s1
[i
-2] == '*')
5007 * maintains the list of already visited files and dirs
5008 * returns FAIL if the given file/dir is already in the list
5009 * returns OK if it is newly added
5011 * TODO: What to do on memory allocation problems?
5012 * -> return TRUE - Better the file is found several times instead of
5016 ff_check_visited(visited_list
, fname
5017 #ifdef FEAT_PATH_EXTRA
5021 ff_visited_T
**visited_list
;
5023 #ifdef FEAT_PATH_EXTRA
5033 /* For an URL we only compare the name, otherwise we compare the
5034 * device/inode (unix) or the full path name (not Unix). */
5035 if (path_with_url(fname
))
5037 vim_strncpy(ff_expand_buffer
, fname
, MAXPATHL
- 1);
5044 ff_expand_buffer
[0] = NUL
;
5046 if (mch_stat((char *)fname
, &st
) < 0)
5048 if (vim_FullName(fname
, ff_expand_buffer
, MAXPATHL
, TRUE
) == FAIL
)
5053 /* check against list of already visited files */
5054 for (vp
= *visited_list
; vp
!= NULL
; vp
= vp
->ffv_next
)
5059 ? (vp
->ffv_dev
== st
.st_dev
5060 && vp
->ffv_ino
== st
.st_ino
)
5063 fnamecmp(vp
->ffv_fname
, ff_expand_buffer
) == 0
5066 #ifdef FEAT_PATH_EXTRA
5067 /* are the wildcard parts equal */
5068 if (ff_wc_equal(vp
->ffv_wc_path
, wc_path
) == TRUE
)
5070 /* already visited */
5076 * New file/dir. Add it to the list of visited files/dirs.
5078 vp
= (ff_visited_T
*)alloc((unsigned)(sizeof(ff_visited_T
)
5079 + STRLEN(ff_expand_buffer
)));
5086 vp
->ffv_ino
= st
.st_ino
;
5087 vp
->ffv_dev
= st
.st_dev
;
5088 vp
->ffv_fname
[0] = NUL
;
5095 STRCPY(vp
->ffv_fname
, ff_expand_buffer
);
5099 #ifdef FEAT_PATH_EXTRA
5100 if (wc_path
!= NULL
)
5101 vp
->ffv_wc_path
= vim_strsave(wc_path
);
5103 vp
->ffv_wc_path
= NULL
;
5106 vp
->ffv_next
= *visited_list
;
5114 * create stack element from given path pieces
5117 ff_create_stack_element(fix_part
,
5118 #ifdef FEAT_PATH_EXTRA
5121 level
, star_star_empty
)
5123 #ifdef FEAT_PATH_EXTRA
5127 int star_star_empty
;
5131 new = (ff_stack_T
*)alloc((unsigned)sizeof(ff_stack_T
));
5135 new->ffs_prev
= NULL
;
5136 new->ffs_filearray
= NULL
;
5137 new->ffs_filearray_size
= 0;
5138 new->ffs_filearray_cur
= 0;
5140 new->ffs_level
= level
;
5141 new->ffs_star_star_empty
= star_star_empty
;;
5143 /* the following saves NULL pointer checks in vim_findfile */
5144 if (fix_part
== NULL
)
5145 fix_part
= (char_u
*)"";
5146 new->ffs_fix_path
= vim_strsave(fix_part
);
5148 #ifdef FEAT_PATH_EXTRA
5149 if (wc_part
== NULL
)
5150 wc_part
= (char_u
*)"";
5151 new->ffs_wc_path
= vim_strsave(wc_part
);
5154 if (new->ffs_fix_path
== NULL
5155 #ifdef FEAT_PATH_EXTRA
5156 || new->ffs_wc_path
== NULL
5160 ff_free_stack_element(new);
5168 * Push a dir on the directory stack.
5171 ff_push(search_ctx
, stack_ptr
)
5172 ff_search_ctx_T
*search_ctx
;
5173 ff_stack_T
*stack_ptr
;
5175 /* check for NULL pointer, not to return an error to the user, but
5176 * to prevent a crash */
5177 if (stack_ptr
!= NULL
)
5179 stack_ptr
->ffs_prev
= search_ctx
->ffsc_stack_ptr
;
5180 search_ctx
->ffsc_stack_ptr
= stack_ptr
;
5185 * Pop a dir from the directory stack.
5186 * Returns NULL if stack is empty.
5190 ff_search_ctx_T
*search_ctx
;
5194 sptr
= search_ctx
->ffsc_stack_ptr
;
5195 if (search_ctx
->ffsc_stack_ptr
!= NULL
)
5196 search_ctx
->ffsc_stack_ptr
= search_ctx
->ffsc_stack_ptr
->ffs_prev
;
5202 * free the given stack element
5205 ff_free_stack_element(stack_ptr
)
5206 ff_stack_T
*stack_ptr
;
5208 /* vim_free handles possible NULL pointers */
5209 vim_free(stack_ptr
->ffs_fix_path
);
5210 #ifdef FEAT_PATH_EXTRA
5211 vim_free(stack_ptr
->ffs_wc_path
);
5214 if (stack_ptr
->ffs_filearray
!= NULL
)
5215 FreeWild(stack_ptr
->ffs_filearray_size
, stack_ptr
->ffs_filearray
);
5217 vim_free(stack_ptr
);
5221 * Clear the search context, but NOT the visited list.
5224 ff_clear(search_ctx
)
5225 ff_search_ctx_T
*search_ctx
;
5229 /* clear up stack */
5230 while ((sptr
= ff_pop(search_ctx
)) != NULL
)
5231 ff_free_stack_element(sptr
);
5233 vim_free(search_ctx
->ffsc_file_to_search
);
5234 vim_free(search_ctx
->ffsc_start_dir
);
5235 vim_free(search_ctx
->ffsc_fix_path
);
5236 #ifdef FEAT_PATH_EXTRA
5237 vim_free(search_ctx
->ffsc_wc_path
);
5240 #ifdef FEAT_PATH_EXTRA
5241 if (search_ctx
->ffsc_stopdirs_v
!= NULL
)
5245 while (search_ctx
->ffsc_stopdirs_v
[i
] != NULL
)
5247 vim_free(search_ctx
->ffsc_stopdirs_v
[i
]);
5250 vim_free(search_ctx
->ffsc_stopdirs_v
);
5252 search_ctx
->ffsc_stopdirs_v
= NULL
;
5255 /* reset everything */
5256 search_ctx
->ffsc_file_to_search
= NULL
;
5257 search_ctx
->ffsc_start_dir
= NULL
;
5258 search_ctx
->ffsc_fix_path
= NULL
;
5259 #ifdef FEAT_PATH_EXTRA
5260 search_ctx
->ffsc_wc_path
= NULL
;
5261 search_ctx
->ffsc_level
= 0;
5265 #ifdef FEAT_PATH_EXTRA
5267 * check if the given path is in the stopdirs
5268 * returns TRUE if yes else FALSE
5271 ff_path_in_stoplist(path
, path_len
, stopdirs_v
)
5274 char_u
**stopdirs_v
;
5278 /* eat up trailing path separators, except the first */
5279 while (path_len
> 1 && vim_ispathsep(path
[path_len
- 1]))
5282 /* if no path consider it as match */
5286 for (i
= 0; stopdirs_v
[i
] != NULL
; i
++)
5288 if ((int)STRLEN(stopdirs_v
[i
]) > path_len
)
5290 /* match for parent directory. So '/home' also matches
5291 * '/home/rks'. Check for PATHSEP in stopdirs_v[i], else
5292 * '/home/r' would also match '/home/rks'
5294 if (fnamencmp(stopdirs_v
[i
], path
, path_len
) == 0
5295 && vim_ispathsep(stopdirs_v
[i
][path_len
]))
5300 if (fnamecmp(stopdirs_v
[i
], path
) == 0)
5308 #if defined(FEAT_SEARCHPATH) || defined(PROTO)
5310 * Find the file name "ptr[len]" in the path. Also finds directory names.
5312 * On the first call set the parameter 'first' to TRUE to initialize
5313 * the search. For repeating calls to FALSE.
5315 * Repeating calls will return other files called 'ptr[len]' from the path.
5317 * Only on the first call 'ptr' and 'len' are used. For repeating calls they
5318 * don't need valid values.
5320 * If nothing found on the first call the option FNAME_MESS will issue the
5322 * 'Can't find file "<file>" in path'
5323 * On repeating calls:
5324 * 'No more file "<file>" found in path'
5327 * FNAME_MESS give error message when not found
5331 * Returns an allocated string for the file name. NULL for error.
5335 find_file_in_path(ptr
, len
, options
, first
, rel_fname
)
5336 char_u
*ptr
; /* file name */
5337 int len
; /* length of file name */
5339 int first
; /* use count'th matching file name */
5340 char_u
*rel_fname
; /* file name searching relative to */
5342 return find_file_in_path_option(ptr
, len
, options
, first
,
5343 *curbuf
->b_p_path
== NUL
? p_path
: curbuf
->b_p_path
,
5344 FINDFILE_BOTH
, rel_fname
, curbuf
->b_p_sua
);
5347 static char_u
*ff_file_to_find
= NULL
;
5348 static void *fdip_search_ctx
= NULL
;
5350 #if defined(EXITFREE)
5354 vim_free(ff_file_to_find
);
5355 vim_findfile_cleanup(fdip_search_ctx
);
5360 * Find the directory name "ptr[len]" in the path.
5363 * FNAME_MESS give error message when not found
5367 * Returns an allocated string for the file name. NULL for error.
5370 find_directory_in_path(ptr
, len
, options
, rel_fname
)
5371 char_u
*ptr
; /* file name */
5372 int len
; /* length of file name */
5374 char_u
*rel_fname
; /* file name searching relative to */
5376 return find_file_in_path_option(ptr
, len
, options
, TRUE
, p_cdpath
,
5377 FINDFILE_DIR
, rel_fname
, (char_u
*)"");
5381 find_file_in_path_option(ptr
, len
, options
, first
, path_option
, find_what
, rel_fname
, suffixes
)
5382 char_u
*ptr
; /* file name */
5383 int len
; /* length of file name */
5385 int first
; /* use count'th matching file name */
5386 char_u
*path_option
; /* p_path or p_cdpath */
5387 int find_what
; /* FINDFILE_FILE, _DIR or _BOTH */
5388 char_u
*rel_fname
; /* file name we are looking relative to. */
5389 char_u
*suffixes
; /* list of suffixes, 'suffixesadd' option */
5392 static int did_findfile_init
= FALSE
;
5394 char_u
*file_name
= NULL
;
5398 struct Process
*proc
= (struct Process
*)FindTask(0L);
5399 APTR save_winptr
= proc
->pr_WindowPtr
;
5401 /* Avoid a requester here for a volume that doesn't exist. */
5402 proc
->pr_WindowPtr
= (APTR
)-1L;
5407 /* copy file name into NameBuff, expanding environment variables */
5408 save_char
= ptr
[len
];
5410 expand_env(ptr
, NameBuff
, MAXPATHL
);
5411 ptr
[len
] = save_char
;
5413 vim_free(ff_file_to_find
);
5414 ff_file_to_find
= vim_strsave(NameBuff
);
5415 if (ff_file_to_find
== NULL
) /* out of memory */
5422 rel_to_curdir
= (ff_file_to_find
[0] == '.'
5423 && (ff_file_to_find
[1] == NUL
5424 || vim_ispathsep(ff_file_to_find
[1])
5425 || (ff_file_to_find
[1] == '.'
5426 && (ff_file_to_find
[2] == NUL
5427 || vim_ispathsep(ff_file_to_find
[2])))));
5428 if (vim_isAbsName(ff_file_to_find
)
5429 /* "..", "../path", "." and "./path": don't use the path_option */
5431 #if defined(MSWIN) || defined(MSDOS) || defined(OS2)
5432 /* handle "\tmp" as absolute path */
5433 || vim_ispathsep(ff_file_to_find
[0])
5434 /* handle "c:name" as absulute path */
5435 || (ff_file_to_find
[0] != NUL
&& ff_file_to_find
[1] == ':')
5438 /* handle ":tmp" as absolute path */
5439 || ff_file_to_find
[0] == ':'
5444 * Absolute path, no need to use "path_option".
5445 * If this is not a first call, return NULL. We already returned a
5446 * filename on the first call.
5453 if (path_with_url(ff_file_to_find
))
5455 file_name
= vim_strsave(ff_file_to_find
);
5459 /* When FNAME_REL flag given first use the directory of the file.
5460 * Otherwise or when this fails use the current directory. */
5461 for (run
= 1; run
<= 2; ++run
)
5463 l
= (int)STRLEN(ff_file_to_find
);
5466 && (options
& FNAME_REL
)
5467 && rel_fname
!= NULL
5468 && STRLEN(rel_fname
) + l
< MAXPATHL
)
5470 STRCPY(NameBuff
, rel_fname
);
5471 STRCPY(gettail(NameBuff
), ff_file_to_find
);
5472 l
= (int)STRLEN(NameBuff
);
5476 STRCPY(NameBuff
, ff_file_to_find
);
5480 /* When the file doesn't exist, try adding parts of
5487 /* "C:" by itself will fail for mch_getperm(),
5488 * assume it's always valid. */
5489 (find_what
!= FINDFILE_FILE
&& NameBuff
[0] != NUL
5490 && NameBuff
[1] == ':'
5491 && NameBuff
[2] == NUL
) ||
5493 (mch_getperm(NameBuff
) >= 0
5494 && (find_what
== FINDFILE_BOTH
5495 || ((find_what
== FINDFILE_DIR
)
5496 == mch_isdir(NameBuff
)))))
5498 file_name
= vim_strsave(NameBuff
);
5503 copy_option_part(&buf
, NameBuff
+ l
, MAXPATHL
- l
, ",");
5511 * Loop over all paths in the 'path' or 'cdpath' option.
5512 * When "first" is set, first setup to the start of the option.
5513 * Otherwise continue to find the next match.
5517 /* vim_findfile_free_visited can handle a possible NULL pointer */
5518 vim_findfile_free_visited(fdip_search_ctx
);
5520 did_findfile_init
= FALSE
;
5525 if (did_findfile_init
)
5527 file_name
= vim_findfile(fdip_search_ctx
);
5528 if (file_name
!= NULL
)
5531 did_findfile_init
= FALSE
;
5537 if (dir
== NULL
|| *dir
== NUL
)
5539 /* We searched all paths of the option, now we can
5540 * free the search context. */
5541 vim_findfile_cleanup(fdip_search_ctx
);
5542 fdip_search_ctx
= NULL
;
5546 if ((buf
= alloc((int)(MAXPATHL
))) == NULL
)
5549 /* copy next path */
5551 copy_option_part(&dir
, buf
, MAXPATHL
, " ,");
5553 #ifdef FEAT_PATH_EXTRA
5554 /* get the stopdir string */
5555 r_ptr
= vim_findfile_stopdir(buf
);
5559 fdip_search_ctx
= vim_findfile_init(buf
, ff_file_to_find
,
5560 r_ptr
, 100, FALSE
, find_what
,
5561 fdip_search_ctx
, FALSE
, rel_fname
);
5562 if (fdip_search_ctx
!= NULL
)
5563 did_findfile_init
= TRUE
;
5568 if (file_name
== NULL
&& (options
& FNAME_MESS
))
5572 if (find_what
== FINDFILE_DIR
)
5573 EMSG2(_("E344: Can't find directory \"%s\" in cdpath"),
5576 EMSG2(_("E345: Can't find file \"%s\" in path"),
5581 if (find_what
== FINDFILE_DIR
)
5582 EMSG2(_("E346: No more directory \"%s\" found in cdpath"),
5585 EMSG2(_("E347: No more file \"%s\" found in path"),
5592 proc
->pr_WindowPtr
= save_winptr
;
5597 #endif /* FEAT_SEARCHPATH */
5600 * Change directory to "new_dir". If FEAT_SEARCHPATH is defined, search
5601 * 'cdpath' for relative directory names, otherwise just mch_chdir().
5607 #ifndef FEAT_SEARCHPATH
5608 return mch_chdir((char *)new_dir
);
5613 dir_name
= find_directory_in_path(new_dir
, (int)STRLEN(new_dir
),
5614 FNAME_MESS
, curbuf
->b_ffname
);
5615 if (dir_name
== NULL
)
5617 r
= mch_chdir((char *)dir_name
);
5624 * Get user name from machine-specific function.
5625 * Returns the user name in "buf[len]".
5626 * Some systems are quite slow in obtaining the user name (Windows NT), thus
5628 * Returns OK or FAIL.
5631 get_user_name(buf
, len
)
5635 if (username
== NULL
)
5637 if (mch_get_user_name(buf
, len
) == FAIL
)
5639 username
= vim_strsave(buf
);
5642 vim_strncpy(buf
, username
, len
- 1);
5648 * Our own qsort(), for systems that don't have it.
5649 * It's simple and slow. From the K&R C book.
5652 qsort(base
, elm_count
, elm_size
, cmp
)
5656 int (*cmp
) __ARGS((const void *, const void *));
5664 buf
= alloc((unsigned)elm_size
);
5668 for (gap
= elm_count
/ 2; gap
> 0; gap
/= 2)
5669 for (i
= gap
; i
< elm_count
; ++i
)
5670 for (j
= i
- gap
; j
>= 0; j
-= gap
)
5672 /* Compare the elements. */
5673 p1
= (char_u
*)base
+ j
* elm_size
;
5674 p2
= (char_u
*)base
+ (j
+ gap
) * elm_size
;
5675 if ((*cmp
)((void *)p1
, (void *)p2
) <= 0)
5677 /* Exchange the elemets. */
5678 mch_memmove(buf
, p1
, elm_size
);
5679 mch_memmove(p1
, p2
, elm_size
);
5680 mch_memmove(p2
, buf
, elm_size
);
5688 * Sort an array of strings.
5694 sort_compare
__ARGS((const void *s1
, const void *s2
));
5700 sort_compare(s1
, s2
)
5704 return STRCMP(*(char **)s1
, *(char **)s2
);
5708 sort_strings(files
, count
)
5712 qsort((void *)files
, (size_t)count
, sizeof(char_u
*), sort_compare
);
5715 #if !defined(NO_EXPANDPATH) || defined(PROTO)
5717 * Compare path "p[]" to "q[]".
5718 * If "maxlen" >= 0 compare "p[maxlen]" to "q[maxlen]"
5719 * Return value like strcmp(p, q), but consider path separators.
5722 pathcmp(p
, q
, maxlen
)
5727 const char *s
= NULL
;
5729 for (i
= 0; maxlen
< 0 || i
< maxlen
; ++i
)
5731 /* End of "p": check if "q" also ends or just has a slash. */
5734 if (q
[i
] == NUL
) /* full match */
5740 /* End of "q": check if "p" just has a slash. */
5748 #ifdef CASE_INSENSITIVE_FILENAME
5749 TOUPPER_LOC(p
[i
]) != TOUPPER_LOC(q
[i
])
5753 #ifdef BACKSLASH_IN_FILENAME
5754 /* consider '/' and '\\' to be equal */
5755 && !((p
[i
] == '/' && q
[i
] == '\\')
5756 || (p
[i
] == '\\' && q
[i
] == '/'))
5760 if (vim_ispathsep(p
[i
]))
5762 if (vim_ispathsep(q
[i
]))
5764 return ((char_u
*)p
)[i
] - ((char_u
*)q
)[i
]; /* no match */
5767 if (s
== NULL
) /* "i" ran into "maxlen" */
5770 /* ignore a trailing slash, but not "//" or ":/" */
5773 && !after_pathsep((char_u
*)s
, (char_u
*)s
+ i
)
5774 #ifdef BACKSLASH_IN_FILENAME
5775 && (s
[i
] == '/' || s
[i
] == '\\')
5780 return 0; /* match with trailing slash */
5782 return -1; /* no match */
5788 * The putenv() implementation below comes from the "screen" program.
5789 * Included with permission from Juergen Weigert.
5790 * See pty.c for the copyright notice.
5794 * putenv -- put value into environment
5796 * Usage: i = putenv (string)
5800 * where string is of the form <name>=<value>.
5801 * Putenv returns 0 normally, -1 on error (not enough core for malloc).
5803 * Putenv may need to add a new name into the environment, or to
5804 * associate a value longer than the current value with a particular
5805 * name. So, to make life simpler, putenv() copies your entire
5806 * environment into the heap (i.e. malloc()) from the stack
5807 * (i.e. where it resides when your process is initiated) the first
5810 * (history removed, not very interesting. See the "screen" sources.)
5813 #if !defined(HAVE_SETENV) && !defined(HAVE_PUTENV)
5815 #define EXTRASIZE 5 /* increment to add to env. size */
5817 static int envsize
= -1; /* current size of environment */
5818 #ifndef MACOS_CLASSIC
5821 char **environ
; /* the global which is your env. */
5823 static int findenv
__ARGS((char *name
)); /* look for a name in the env. */
5824 static int newenv
__ARGS((void)); /* copy env. from stack to heap */
5825 static int moreenv
__ARGS((void)); /* incr. size of env. */
5835 { /* first time putenv called */
5836 if (newenv() < 0) /* copy env. to heap */
5840 i
= findenv((char *)string
); /* look for name in environment */
5843 { /* name must be added */
5844 for (i
= 0; environ
[i
]; i
++);
5845 if (i
>= (envsize
- 1))
5846 { /* need new slot */
5850 p
= (char *)alloc((unsigned)(strlen(string
) + 1));
5851 if (p
== NULL
) /* not enough core */
5853 environ
[i
+ 1] = 0; /* new end of env. */
5856 { /* name already in env. */
5857 p
= vim_realloc(environ
[i
], strlen(string
) + 1);
5861 sprintf(p
, "%s", string
); /* copy into env. */
5871 char *namechar
, *envchar
;
5875 for (i
= 0; environ
[i
] && !found
; i
++)
5877 envchar
= environ
[i
];
5879 while (*namechar
&& *namechar
!= '=' && (*namechar
== *envchar
))
5884 found
= ((*namechar
== '\0' || *namechar
== '=') && *envchar
== '=');
5886 return found
? i
- 1 : -1;
5896 /* for Mac a new, empty environment is created */
5899 for (i
= 0; environ
[i
]; i
++)
5902 esize
= i
+ EXTRASIZE
+ 1;
5903 env
= (char **)alloc((unsigned)(esize
* sizeof (elem
)));
5908 for (i
= 0; environ
[i
]; i
++)
5910 elem
= (char *)alloc((unsigned)(strlen(environ
[i
]) + 1));
5914 strcpy(elem
, environ
[i
]);
5930 esize
= envsize
+ EXTRASIZE
;
5931 env
= (char **)vim_realloc((char *)environ
, esize
* sizeof (*env
));
5939 # ifdef USE_VIMPTY_GETENV
5941 vimpty_getenv(string
)
5942 const char_u
*string
;
5950 i
= findenv((char *)string
);
5955 p
= vim_strchr((char_u
*)environ
[i
], '=');
5960 #endif /* !defined(HAVE_SETENV) && !defined(HAVE_PUTENV) */
5962 #if defined(FEAT_EVAL) || defined(FEAT_SPELL) || defined(PROTO)
5964 * Return 0 for not writable, 1 for writable file, 2 for a dir which we have
5965 * rights to write into.
5972 #if defined(UNIX) || defined(VMS)
5976 #if defined(UNIX) || defined(VMS)
5977 perm
= mch_getperm(fname
);
5979 #ifndef MACOS_CLASSIC /* TODO: get either mch_writable or mch_access */
5982 mch_writable(fname
) &&
5984 # if defined(UNIX) || defined(VMS)
5988 mch_access((char *)fname
, W_OK
) == 0
5993 if (mch_isdir(fname
))
6001 * Print an error message with one or two "%s" and one or two string arguments.
6002 * This is not in message.c to avoid a warning for prototypes.
6006 char_u
*s
, *a1
, *a2
;
6009 return TRUE
; /* no error messages at the moment */
6010 #ifdef HAVE_STDARG_H
6011 vim_snprintf((char *)IObuff
, IOSIZE
, (char *)s
, a1
, a2
);
6013 vim_snprintf((char *)IObuff
, IOSIZE
, (char *)s
, (long_u
)a1
, (long_u
)a2
);
6015 return emsg(IObuff
);
6019 * Print an error message with one "%ld" and one long int argument.
6020 * This is not in message.c to avoid a warning for prototypes.
6028 return TRUE
; /* no error messages at the moment */
6029 vim_snprintf((char *)IObuff
, IOSIZE
, (char *)s
, n
);
6030 return emsg(IObuff
);