Add command line completion to :macaction command
[MacVim.git] / src / ex_getln.c
blob2f362b6487e32519fe76349ce81827c7297b5c4b
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.
8 */
11 * ex_getln.c: Functions for entering and editing an Ex command line.
14 #include "vim.h"
17 * Variables shared between getcmdline(), redrawcmdline() and others.
18 * These need to be saved when using CTRL-R |, that's why they are in a
19 * structure.
21 struct cmdline_info
23 char_u *cmdbuff; /* pointer to command line buffer */
24 int cmdbufflen; /* length of cmdbuff */
25 int cmdlen; /* number of chars in command line */
26 int cmdpos; /* current cursor position */
27 int cmdspos; /* cursor column on screen */
28 int cmdfirstc; /* ':', '/', '?', '=' or NUL */
29 int cmdindent; /* number of spaces before cmdline */
30 char_u *cmdprompt; /* message in front of cmdline */
31 int cmdattr; /* attributes for prompt */
32 int overstrike; /* Typing mode on the command line. Shared by
33 getcmdline() and put_on_cmdline(). */
34 int xp_context; /* type of expansion */
35 # ifdef FEAT_EVAL
36 char_u *xp_arg; /* user-defined expansion arg */
37 int input_fn; /* when TRUE Invoked for input() function */
38 # endif
41 static struct cmdline_info ccline; /* current cmdline_info */
43 static int cmd_showtail; /* Only show path tail in lists ? */
45 #ifdef FEAT_EVAL
46 static int new_cmdpos; /* position set by set_cmdline_pos() */
47 #endif
49 #ifdef FEAT_CMDHIST
50 typedef struct hist_entry
52 int hisnum; /* identifying number */
53 char_u *hisstr; /* actual entry, separator char after the NUL */
54 } histentry_T;
56 static histentry_T *(history[HIST_COUNT]) = {NULL, NULL, NULL, NULL, NULL};
57 static int hisidx[HIST_COUNT] = {-1, -1, -1, -1, -1}; /* lastused entry */
58 static int hisnum[HIST_COUNT] = {0, 0, 0, 0, 0};
59 /* identifying (unique) number of newest history entry */
60 static int hislen = 0; /* actual length of history tables */
62 static int hist_char2type __ARGS((int c));
64 static int in_history __ARGS((int, char_u *, int));
65 # ifdef FEAT_EVAL
66 static int calc_hist_idx __ARGS((int histype, int num));
67 # endif
68 #endif
70 #ifdef FEAT_RIGHTLEFT
71 static int cmd_hkmap = 0; /* Hebrew mapping during command line */
72 #endif
74 #ifdef FEAT_FKMAP
75 static int cmd_fkmap = 0; /* Farsi mapping during command line */
76 #endif
78 static int cmdline_charsize __ARGS((int idx));
79 static void set_cmdspos __ARGS((void));
80 static void set_cmdspos_cursor __ARGS((void));
81 #ifdef FEAT_MBYTE
82 static void correct_cmdspos __ARGS((int idx, int cells));
83 #endif
84 static void alloc_cmdbuff __ARGS((int len));
85 static int realloc_cmdbuff __ARGS((int len));
86 static void draw_cmdline __ARGS((int start, int len));
87 static void save_cmdline __ARGS((struct cmdline_info *ccp));
88 static void restore_cmdline __ARGS((struct cmdline_info *ccp));
89 static int cmdline_paste __ARGS((int regname, int literally, int remcr));
90 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
91 static void redrawcmd_preedit __ARGS((void));
92 #endif
93 #ifdef FEAT_WILDMENU
94 static void cmdline_del __ARGS((int from));
95 #endif
96 static void redrawcmdprompt __ARGS((void));
97 static void cursorcmd __ARGS((void));
98 static int ccheck_abbr __ARGS((int));
99 static int nextwild __ARGS((expand_T *xp, int type, int options));
100 static void escape_fname __ARGS((char_u **pp));
101 static int showmatches __ARGS((expand_T *xp, int wildmenu));
102 static void set_expand_context __ARGS((expand_T *xp));
103 static int ExpandFromContext __ARGS((expand_T *xp, char_u *, int *, char_u ***, int));
104 static int expand_showtail __ARGS((expand_T *xp));
105 #ifdef FEAT_CMDL_COMPL
106 static int expand_shellcmd __ARGS((char_u *filepat, int *num_file, char_u ***file, int flagsarg));
107 static int ExpandRTDir __ARGS((char_u *pat, int *num_file, char_u ***file, char *dirname));
108 # if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL)
109 static int ExpandUserDefined __ARGS((expand_T *xp, regmatch_T *regmatch, int *num_file, char_u ***file));
110 static int ExpandUserList __ARGS((expand_T *xp, int *num_file, char_u ***file));
111 # endif
112 #endif
114 #ifdef FEAT_CMDWIN
115 static int ex_window __ARGS((void));
116 #endif
119 * getcmdline() - accept a command line starting with firstc.
121 * firstc == ':' get ":" command line.
122 * firstc == '/' or '?' get search pattern
123 * firstc == '=' get expression
124 * firstc == '@' get text for input() function
125 * firstc == '>' get text for debug mode
126 * firstc == NUL get text for :insert command
127 * firstc == -1 like NUL, and break on CTRL-C
129 * The line is collected in ccline.cmdbuff, which is reallocated to fit the
130 * command line.
132 * Careful: getcmdline() can be called recursively!
134 * Return pointer to allocated string if there is a commandline, NULL
135 * otherwise.
137 /*ARGSUSED*/
138 char_u *
139 getcmdline(firstc, count, indent)
140 int firstc;
141 long count; /* only used for incremental search */
142 int indent; /* indent for inside conditionals */
144 int c;
145 int i;
146 int j;
147 int gotesc = FALSE; /* TRUE when <ESC> just typed */
148 int do_abbr; /* when TRUE check for abbr. */
149 #ifdef FEAT_CMDHIST
150 char_u *lookfor = NULL; /* string to match */
151 int hiscnt; /* current history line in use */
152 int histype; /* history type to be used */
153 #endif
154 #ifdef FEAT_SEARCH_EXTRA
155 pos_T old_cursor;
156 colnr_T old_curswant;
157 colnr_T old_leftcol;
158 linenr_T old_topline;
159 # ifdef FEAT_DIFF
160 int old_topfill;
161 # endif
162 linenr_T old_botline;
163 int did_incsearch = FALSE;
164 int incsearch_postponed = FALSE;
165 #endif
166 int did_wild_list = FALSE; /* did wild_list() recently */
167 int wim_index = 0; /* index in wim_flags[] */
168 int res;
169 int save_msg_scroll = msg_scroll;
170 int save_State = State; /* remember State when called */
171 int some_key_typed = FALSE; /* one of the keys was typed */
172 #ifdef FEAT_MOUSE
173 /* mouse drag and release events are ignored, unless they are
174 * preceded with a mouse down event */
175 int ignore_drag_release = TRUE;
176 #endif
177 #ifdef FEAT_EVAL
178 int break_ctrl_c = FALSE;
179 #endif
180 expand_T xpc;
181 long *b_im_ptr = NULL;
182 #if defined(FEAT_WILDMENU) || defined(FEAT_EVAL) || defined(FEAT_SEARCH_EXTRA)
183 /* Everything that may work recursively should save and restore the
184 * current command line in save_ccline. That includes update_screen(), a
185 * custom status line may invoke ":normal". */
186 struct cmdline_info save_ccline;
187 #endif
189 #ifdef FEAT_SNIFF
190 want_sniff_request = 0;
191 #endif
192 #ifdef FEAT_EVAL
193 if (firstc == -1)
195 firstc = NUL;
196 break_ctrl_c = TRUE;
198 #endif
199 #ifdef FEAT_RIGHTLEFT
200 /* start without Hebrew mapping for a command line */
201 if (firstc == ':' || firstc == '=' || firstc == '>')
202 cmd_hkmap = 0;
203 #endif
205 ccline.overstrike = FALSE; /* always start in insert mode */
206 #ifdef FEAT_SEARCH_EXTRA
207 old_cursor = curwin->w_cursor; /* needs to be restored later */
208 old_curswant = curwin->w_curswant;
209 old_leftcol = curwin->w_leftcol;
210 old_topline = curwin->w_topline;
211 # ifdef FEAT_DIFF
212 old_topfill = curwin->w_topfill;
213 # endif
214 old_botline = curwin->w_botline;
215 #endif
218 * set some variables for redrawcmd()
220 ccline.cmdfirstc = (firstc == '@' ? 0 : firstc);
221 ccline.cmdindent = (firstc > 0 ? indent : 0);
223 /* alloc initial ccline.cmdbuff */
224 alloc_cmdbuff(exmode_active ? 250 : indent + 1);
225 if (ccline.cmdbuff == NULL)
226 return NULL; /* out of memory */
227 ccline.cmdlen = ccline.cmdpos = 0;
228 ccline.cmdbuff[0] = NUL;
230 /* autoindent for :insert and :append */
231 if (firstc <= 0)
233 copy_spaces(ccline.cmdbuff, indent);
234 ccline.cmdbuff[indent] = NUL;
235 ccline.cmdpos = indent;
236 ccline.cmdspos = indent;
237 ccline.cmdlen = indent;
240 ExpandInit(&xpc);
242 #ifdef FEAT_RIGHTLEFT
243 if (curwin->w_p_rl && *curwin->w_p_rlc == 's'
244 && (firstc == '/' || firstc == '?'))
245 cmdmsg_rl = TRUE;
246 else
247 cmdmsg_rl = FALSE;
248 #endif
250 redir_off = TRUE; /* don't redirect the typed command */
251 if (!cmd_silent)
253 i = msg_scrolled;
254 msg_scrolled = 0; /* avoid wait_return message */
255 gotocmdline(TRUE);
256 msg_scrolled += i;
257 redrawcmdprompt(); /* draw prompt or indent */
258 set_cmdspos();
260 xpc.xp_context = EXPAND_NOTHING;
261 xpc.xp_backslash = XP_BS_NONE;
262 #ifndef BACKSLASH_IN_FILENAME
263 xpc.xp_shell = FALSE;
264 #endif
266 #if defined(FEAT_EVAL)
267 if (ccline.input_fn)
269 xpc.xp_context = ccline.xp_context;
270 xpc.xp_pattern = ccline.cmdbuff;
271 # if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
272 xpc.xp_arg = ccline.xp_arg;
273 # endif
275 #endif
278 * Avoid scrolling when called by a recursive do_cmdline(), e.g. when
279 * doing ":@0" when register 0 doesn't contain a CR.
281 msg_scroll = FALSE;
283 State = CMDLINE;
285 if (firstc == '/' || firstc == '?' || firstc == '@')
287 /* Use ":lmap" mappings for search pattern and input(). */
288 if (curbuf->b_p_imsearch == B_IMODE_USE_INSERT)
289 b_im_ptr = &curbuf->b_p_iminsert;
290 else
291 b_im_ptr = &curbuf->b_p_imsearch;
292 if (*b_im_ptr == B_IMODE_LMAP)
293 State |= LANGMAP;
294 #ifdef USE_IM_CONTROL
295 im_set_active(*b_im_ptr == B_IMODE_IM);
296 #endif
298 #ifdef USE_IM_CONTROL
299 else if (p_imcmdline)
300 im_set_active(TRUE);
301 #endif
303 #ifdef FEAT_MOUSE
304 setmouse();
305 #endif
306 #ifdef CURSOR_SHAPE
307 ui_cursor_shape(); /* may show different cursor shape */
308 #endif
310 /* When inside an autocommand for writing "exiting" may be set and
311 * terminal mode set to cooked. Need to set raw mode here then. */
312 settmode(TMODE_RAW);
314 #ifdef FEAT_CMDHIST
315 init_history();
316 hiscnt = hislen; /* set hiscnt to impossible history value */
317 histype = hist_char2type(firstc);
318 #endif
320 #ifdef FEAT_DIGRAPHS
321 do_digraph(-1); /* init digraph typahead */
322 #endif
325 * Collect the command string, handling editing keys.
327 for (;;)
329 redir_off = TRUE; /* Don't redirect the typed command.
330 Repeated, because a ":redir" inside
331 completion may switch it on. */
332 #ifdef USE_ON_FLY_SCROLL
333 dont_scroll = FALSE; /* allow scrolling here */
334 #endif
335 quit_more = FALSE; /* reset after CTRL-D which had a more-prompt */
337 cursorcmd(); /* set the cursor on the right spot */
339 /* Get a character. Ignore K_IGNORE, it should not do anything, such
340 * as stop completion. */
343 c = safe_vgetc();
344 } while (c == K_IGNORE);
346 if (KeyTyped)
348 some_key_typed = TRUE;
349 #ifdef FEAT_RIGHTLEFT
350 if (cmd_hkmap)
351 c = hkmap(c);
352 # ifdef FEAT_FKMAP
353 if (cmd_fkmap)
354 c = cmdl_fkmap(c);
355 # endif
356 if (cmdmsg_rl && !KeyStuffed)
358 /* Invert horizontal movements and operations. Only when
359 * typed by the user directly, not when the result of a
360 * mapping. */
361 switch (c)
363 case K_RIGHT: c = K_LEFT; break;
364 case K_S_RIGHT: c = K_S_LEFT; break;
365 case K_C_RIGHT: c = K_C_LEFT; break;
366 case K_LEFT: c = K_RIGHT; break;
367 case K_S_LEFT: c = K_S_RIGHT; break;
368 case K_C_LEFT: c = K_C_RIGHT; break;
371 #endif
375 * Ignore got_int when CTRL-C was typed here.
376 * Don't ignore it in :global, we really need to break then, e.g., for
377 * ":g/pat/normal /pat" (without the <CR>).
378 * Don't ignore it for the input() function.
380 if ((c == Ctrl_C
381 #ifdef UNIX
382 || c == intr_char
383 #endif
385 #if defined(FEAT_EVAL) || defined(FEAT_CRYPT)
386 && firstc != '@'
387 #endif
388 #ifdef FEAT_EVAL
389 && !break_ctrl_c
390 #endif
391 && !global_busy)
392 got_int = FALSE;
394 #ifdef FEAT_CMDHIST
395 /* free old command line when finished moving around in the history
396 * list */
397 if (lookfor != NULL
398 && c != K_S_DOWN && c != K_S_UP
399 && c != K_DOWN && c != K_UP
400 && c != K_PAGEDOWN && c != K_PAGEUP
401 && c != K_KPAGEDOWN && c != K_KPAGEUP
402 && c != K_LEFT && c != K_RIGHT
403 && (xpc.xp_numfiles > 0 || (c != Ctrl_P && c != Ctrl_N)))
405 vim_free(lookfor);
406 lookfor = NULL;
408 #endif
411 * <S-Tab> works like CTRL-P (unless 'wc' is <S-Tab>).
413 if (c != p_wc && c == K_S_TAB && xpc.xp_numfiles != -1)
414 c = Ctrl_P;
416 #ifdef FEAT_WILDMENU
417 /* Special translations for 'wildmenu' */
418 if (did_wild_list && p_wmnu)
420 if (c == K_LEFT)
421 c = Ctrl_P;
422 else if (c == K_RIGHT)
423 c = Ctrl_N;
425 /* Hitting CR after "emenu Name.": complete submenu */
426 if (xpc.xp_context == EXPAND_MENUNAMES && p_wmnu
427 && ccline.cmdpos > 1
428 && ccline.cmdbuff[ccline.cmdpos - 1] == '.'
429 && ccline.cmdbuff[ccline.cmdpos - 2] != '\\'
430 && (c == '\n' || c == '\r' || c == K_KENTER))
431 c = K_DOWN;
432 #endif
434 /* free expanded names when finished walking through matches */
435 if (xpc.xp_numfiles != -1
436 && !(c == p_wc && KeyTyped) && c != p_wcm
437 && c != Ctrl_N && c != Ctrl_P && c != Ctrl_A
438 && c != Ctrl_L)
440 (void)ExpandOne(&xpc, NULL, NULL, 0, WILD_FREE);
441 did_wild_list = FALSE;
442 #ifdef FEAT_WILDMENU
443 if (!p_wmnu || (c != K_UP && c != K_DOWN))
444 #endif
445 xpc.xp_context = EXPAND_NOTHING;
446 wim_index = 0;
447 #ifdef FEAT_WILDMENU
448 if (p_wmnu && wild_menu_showing != 0)
450 int skt = KeyTyped;
451 int old_RedrawingDisabled = RedrawingDisabled;
453 if (ccline.input_fn)
454 RedrawingDisabled = 0;
456 if (wild_menu_showing == WM_SCROLLED)
458 /* Entered command line, move it up */
459 cmdline_row--;
460 redrawcmd();
462 else if (save_p_ls != -1)
464 /* restore 'laststatus' and 'winminheight' */
465 p_ls = save_p_ls;
466 p_wmh = save_p_wmh;
467 last_status(FALSE);
468 save_cmdline(&save_ccline);
469 update_screen(VALID); /* redraw the screen NOW */
470 restore_cmdline(&save_ccline);
471 redrawcmd();
472 save_p_ls = -1;
474 else
476 # ifdef FEAT_VERTSPLIT
477 win_redraw_last_status(topframe);
478 # else
479 lastwin->w_redr_status = TRUE;
480 # endif
481 redraw_statuslines();
483 KeyTyped = skt;
484 wild_menu_showing = 0;
485 if (ccline.input_fn)
486 RedrawingDisabled = old_RedrawingDisabled;
488 #endif
491 #ifdef FEAT_WILDMENU
492 /* Special translations for 'wildmenu' */
493 if (xpc.xp_context == EXPAND_MENUNAMES && p_wmnu)
495 /* Hitting <Down> after "emenu Name.": complete submenu */
496 if (c == K_DOWN && ccline.cmdpos > 0
497 && ccline.cmdbuff[ccline.cmdpos - 1] == '.')
498 c = p_wc;
499 else if (c == K_UP)
501 /* Hitting <Up>: Remove one submenu name in front of the
502 * cursor */
503 int found = FALSE;
505 j = (int)(xpc.xp_pattern - ccline.cmdbuff);
506 i = 0;
507 while (--j > 0)
509 /* check for start of menu name */
510 if (ccline.cmdbuff[j] == ' '
511 && ccline.cmdbuff[j - 1] != '\\')
513 i = j + 1;
514 break;
516 /* check for start of submenu name */
517 if (ccline.cmdbuff[j] == '.'
518 && ccline.cmdbuff[j - 1] != '\\')
520 if (found)
522 i = j + 1;
523 break;
525 else
526 found = TRUE;
529 if (i > 0)
530 cmdline_del(i);
531 c = p_wc;
532 xpc.xp_context = EXPAND_NOTHING;
535 if ((xpc.xp_context == EXPAND_FILES
536 || xpc.xp_context == EXPAND_SHELLCMD) && p_wmnu)
538 char_u upseg[5];
540 upseg[0] = PATHSEP;
541 upseg[1] = '.';
542 upseg[2] = '.';
543 upseg[3] = PATHSEP;
544 upseg[4] = NUL;
546 if (c == K_DOWN
547 && ccline.cmdpos > 0
548 && ccline.cmdbuff[ccline.cmdpos - 1] == PATHSEP
549 && (ccline.cmdpos < 3
550 || ccline.cmdbuff[ccline.cmdpos - 2] != '.'
551 || ccline.cmdbuff[ccline.cmdpos - 3] != '.'))
553 /* go down a directory */
554 c = p_wc;
556 else if (STRNCMP(xpc.xp_pattern, upseg + 1, 3) == 0 && c == K_DOWN)
558 /* If in a direct ancestor, strip off one ../ to go down */
559 int found = FALSE;
561 j = ccline.cmdpos;
562 i = (int)(xpc.xp_pattern - ccline.cmdbuff);
563 while (--j > i)
565 #ifdef FEAT_MBYTE
566 if (has_mbyte)
567 j -= (*mb_head_off)(ccline.cmdbuff, ccline.cmdbuff + j);
568 #endif
569 if (vim_ispathsep(ccline.cmdbuff[j]))
571 found = TRUE;
572 break;
575 if (found
576 && ccline.cmdbuff[j - 1] == '.'
577 && ccline.cmdbuff[j - 2] == '.'
578 && (vim_ispathsep(ccline.cmdbuff[j - 3]) || j == i + 2))
580 cmdline_del(j - 2);
581 c = p_wc;
584 else if (c == K_UP)
586 /* go up a directory */
587 int found = FALSE;
589 j = ccline.cmdpos - 1;
590 i = (int)(xpc.xp_pattern - ccline.cmdbuff);
591 while (--j > i)
593 #ifdef FEAT_MBYTE
594 if (has_mbyte)
595 j -= (*mb_head_off)(ccline.cmdbuff, ccline.cmdbuff + j);
596 #endif
597 if (vim_ispathsep(ccline.cmdbuff[j])
598 #ifdef BACKSLASH_IN_FILENAME
599 && vim_strchr(" *?[{`$%#", ccline.cmdbuff[j + 1])
600 == NULL
601 #endif
604 if (found)
606 i = j + 1;
607 break;
609 else
610 found = TRUE;
614 if (!found)
615 j = i;
616 else if (STRNCMP(ccline.cmdbuff + j, upseg, 4) == 0)
617 j += 4;
618 else if (STRNCMP(ccline.cmdbuff + j, upseg + 1, 3) == 0
619 && j == i)
620 j += 3;
621 else
622 j = 0;
623 if (j > 0)
625 /* TODO this is only for DOS/UNIX systems - need to put in
626 * machine-specific stuff here and in upseg init */
627 cmdline_del(j);
628 put_on_cmdline(upseg + 1, 3, FALSE);
630 else if (ccline.cmdpos > i)
631 cmdline_del(i);
632 c = p_wc;
635 #if 0 /* If enabled <Down> on a file takes you _completely_ out of wildmenu */
636 if (p_wmnu
637 && (xpc.xp_context == EXPAND_FILES
638 || xpc.xp_context == EXPAND_MENUNAMES)
639 && (c == K_UP || c == K_DOWN))
640 xpc.xp_context = EXPAND_NOTHING;
641 #endif
643 #endif /* FEAT_WILDMENU */
645 /* CTRL-\ CTRL-N goes to Normal mode, CTRL-\ CTRL-G goes to Insert
646 * mode when 'insertmode' is set, CTRL-\ e prompts for an expression. */
647 if (c == Ctrl_BSL)
649 ++no_mapping;
650 ++allow_keys;
651 c = plain_vgetc();
652 --no_mapping;
653 --allow_keys;
654 /* CTRL-\ e doesn't work when obtaining an expression. */
655 if (c != Ctrl_N && c != Ctrl_G
656 && (c != 'e' || ccline.cmdfirstc == '='))
658 vungetc(c);
659 c = Ctrl_BSL;
661 #ifdef FEAT_EVAL
662 else if (c == 'e')
664 char_u *p = NULL;
667 * Replace the command line with the result of an expression.
668 * Need to save and restore the current command line, to be
669 * able to enter a new one...
671 if (ccline.cmdpos == ccline.cmdlen)
672 new_cmdpos = 99999; /* keep it at the end */
673 else
674 new_cmdpos = ccline.cmdpos;
676 save_cmdline(&save_ccline);
677 c = get_expr_register();
678 restore_cmdline(&save_ccline);
679 if (c == '=')
681 /* Need to save and restore ccline. And set "textlock"
682 * to avoid nasty things like going to another buffer when
683 * evaluating an expression. */
684 save_cmdline(&save_ccline);
685 ++textlock;
686 p = get_expr_line();
687 --textlock;
688 restore_cmdline(&save_ccline);
690 if (p != NULL && realloc_cmdbuff((int)STRLEN(p) + 1) == OK)
692 ccline.cmdlen = (int)STRLEN(p);
693 STRCPY(ccline.cmdbuff, p);
694 vim_free(p);
696 /* Restore the cursor or use the position set with
697 * set_cmdline_pos(). */
698 if (new_cmdpos > ccline.cmdlen)
699 ccline.cmdpos = ccline.cmdlen;
700 else
701 ccline.cmdpos = new_cmdpos;
703 KeyTyped = FALSE; /* Don't do p_wc completion. */
704 redrawcmd();
705 goto cmdline_changed;
708 beep_flush();
709 c = ESC;
711 #endif
712 else
714 if (c == Ctrl_G && p_im && restart_edit == 0)
715 restart_edit = 'a';
716 gotesc = TRUE; /* will free ccline.cmdbuff after putting it
717 in history */
718 goto returncmd; /* back to Normal mode */
722 #ifdef FEAT_CMDWIN
723 if (c == cedit_key || c == K_CMDWIN)
726 * Open a window to edit the command line (and history).
728 c = ex_window();
729 some_key_typed = TRUE;
731 # ifdef FEAT_DIGRAPHS
732 else
733 # endif
734 #endif
735 #ifdef FEAT_DIGRAPHS
736 c = do_digraph(c);
737 #endif
739 if (c == '\n' || c == '\r' || c == K_KENTER || (c == ESC
740 && (!KeyTyped || vim_strchr(p_cpo, CPO_ESC) != NULL)))
742 /* In Ex mode a backslash escapes a newline. */
743 if (exmode_active
744 && c != ESC
745 && ccline.cmdpos == ccline.cmdlen
746 && ccline.cmdpos > 0
747 && ccline.cmdbuff[ccline.cmdpos - 1] == '\\')
749 if (c == K_KENTER)
750 c = '\n';
752 else
754 gotesc = FALSE; /* Might have typed ESC previously, don't
755 truncate the cmdline now. */
756 if (ccheck_abbr(c + ABBR_OFF))
757 goto cmdline_changed;
758 if (!cmd_silent)
760 windgoto(msg_row, 0);
761 out_flush();
763 break;
768 * Completion for 'wildchar' or 'wildcharm' key.
769 * - hitting <ESC> twice means: abandon command line.
770 * - wildcard expansion is only done when the 'wildchar' key is really
771 * typed, not when it comes from a macro
773 if ((c == p_wc && !gotesc && KeyTyped) || c == p_wcm)
775 if (xpc.xp_numfiles > 0) /* typed p_wc at least twice */
777 /* if 'wildmode' contains "list" may still need to list */
778 if (xpc.xp_numfiles > 1
779 && !did_wild_list
780 && (wim_flags[wim_index] & WIM_LIST))
782 (void)showmatches(&xpc, FALSE);
783 redrawcmd();
784 did_wild_list = TRUE;
786 if (wim_flags[wim_index] & WIM_LONGEST)
787 res = nextwild(&xpc, WILD_LONGEST, WILD_NO_BEEP);
788 else if (wim_flags[wim_index] & WIM_FULL)
789 res = nextwild(&xpc, WILD_NEXT, WILD_NO_BEEP);
790 else
791 res = OK; /* don't insert 'wildchar' now */
793 else /* typed p_wc first time */
795 wim_index = 0;
796 j = ccline.cmdpos;
797 /* if 'wildmode' first contains "longest", get longest
798 * common part */
799 if (wim_flags[0] & WIM_LONGEST)
800 res = nextwild(&xpc, WILD_LONGEST, WILD_NO_BEEP);
801 else
802 res = nextwild(&xpc, WILD_EXPAND_KEEP, WILD_NO_BEEP);
804 /* if interrupted while completing, behave like it failed */
805 if (got_int)
807 (void)vpeekc(); /* remove <C-C> from input stream */
808 got_int = FALSE; /* don't abandon the command line */
809 (void)ExpandOne(&xpc, NULL, NULL, 0, WILD_FREE);
810 #ifdef FEAT_WILDMENU
811 xpc.xp_context = EXPAND_NOTHING;
812 #endif
813 goto cmdline_changed;
816 /* when more than one match, and 'wildmode' first contains
817 * "list", or no change and 'wildmode' contains "longest,list",
818 * list all matches */
819 if (res == OK && xpc.xp_numfiles > 1)
821 /* a "longest" that didn't do anything is skipped (but not
822 * "list:longest") */
823 if (wim_flags[0] == WIM_LONGEST && ccline.cmdpos == j)
824 wim_index = 1;
825 if ((wim_flags[wim_index] & WIM_LIST)
826 #ifdef FEAT_WILDMENU
827 || (p_wmnu && (wim_flags[wim_index] & WIM_FULL) != 0)
828 #endif
831 if (!(wim_flags[0] & WIM_LONGEST))
833 #ifdef FEAT_WILDMENU
834 int p_wmnu_save = p_wmnu;
835 p_wmnu = 0;
836 #endif
837 nextwild(&xpc, WILD_PREV, 0); /* remove match */
838 #ifdef FEAT_WILDMENU
839 p_wmnu = p_wmnu_save;
840 #endif
842 #ifdef FEAT_WILDMENU
843 (void)showmatches(&xpc, p_wmnu
844 && ((wim_flags[wim_index] & WIM_LIST) == 0));
845 #else
846 (void)showmatches(&xpc, FALSE);
847 #endif
848 redrawcmd();
849 did_wild_list = TRUE;
850 if (wim_flags[wim_index] & WIM_LONGEST)
851 nextwild(&xpc, WILD_LONGEST, WILD_NO_BEEP);
852 else if (wim_flags[wim_index] & WIM_FULL)
853 nextwild(&xpc, WILD_NEXT, WILD_NO_BEEP);
855 else
856 vim_beep();
858 #ifdef FEAT_WILDMENU
859 else if (xpc.xp_numfiles == -1)
860 xpc.xp_context = EXPAND_NOTHING;
861 #endif
863 if (wim_index < 3)
864 ++wim_index;
865 if (c == ESC)
866 gotesc = TRUE;
867 if (res == OK)
868 goto cmdline_changed;
871 gotesc = FALSE;
873 /* <S-Tab> goes to last match, in a clumsy way */
874 if (c == K_S_TAB && KeyTyped)
876 if (nextwild(&xpc, WILD_EXPAND_KEEP, 0) == OK
877 && nextwild(&xpc, WILD_PREV, 0) == OK
878 && nextwild(&xpc, WILD_PREV, 0) == OK)
879 goto cmdline_changed;
882 if (c == NUL || c == K_ZERO) /* NUL is stored as NL */
883 c = NL;
885 do_abbr = TRUE; /* default: check for abbreviation */
888 * Big switch for a typed command line character.
890 switch (c)
892 case K_BS:
893 case Ctrl_H:
894 case K_DEL:
895 case K_KDEL:
896 case Ctrl_W:
897 #ifdef FEAT_FKMAP
898 if (cmd_fkmap && c == K_BS)
899 c = K_DEL;
900 #endif
901 if (c == K_KDEL)
902 c = K_DEL;
905 * delete current character is the same as backspace on next
906 * character, except at end of line
908 if (c == K_DEL && ccline.cmdpos != ccline.cmdlen)
909 ++ccline.cmdpos;
910 #ifdef FEAT_MBYTE
911 if (has_mbyte && c == K_DEL)
912 ccline.cmdpos += mb_off_next(ccline.cmdbuff,
913 ccline.cmdbuff + ccline.cmdpos);
914 #endif
915 if (ccline.cmdpos > 0)
917 char_u *p;
919 j = ccline.cmdpos;
920 p = ccline.cmdbuff + j;
921 #ifdef FEAT_MBYTE
922 if (has_mbyte)
924 p = mb_prevptr(ccline.cmdbuff, p);
925 if (c == Ctrl_W)
927 while (p > ccline.cmdbuff && vim_isspace(*p))
928 p = mb_prevptr(ccline.cmdbuff, p);
929 i = mb_get_class(p);
930 while (p > ccline.cmdbuff && mb_get_class(p) == i)
931 p = mb_prevptr(ccline.cmdbuff, p);
932 if (mb_get_class(p) != i)
933 p += (*mb_ptr2len)(p);
936 else
937 #endif
938 if (c == Ctrl_W)
940 while (p > ccline.cmdbuff && vim_isspace(p[-1]))
941 --p;
942 i = vim_iswordc(p[-1]);
943 while (p > ccline.cmdbuff && !vim_isspace(p[-1])
944 && vim_iswordc(p[-1]) == i)
945 --p;
947 else
948 --p;
949 ccline.cmdpos = (int)(p - ccline.cmdbuff);
950 ccline.cmdlen -= j - ccline.cmdpos;
951 i = ccline.cmdpos;
952 while (i < ccline.cmdlen)
953 ccline.cmdbuff[i++] = ccline.cmdbuff[j++];
955 /* Truncate at the end, required for multi-byte chars. */
956 ccline.cmdbuff[ccline.cmdlen] = NUL;
957 redrawcmd();
959 else if (ccline.cmdlen == 0 && c != Ctrl_W
960 && ccline.cmdprompt == NULL && indent == 0)
962 /* In ex and debug mode it doesn't make sense to return. */
963 if (exmode_active
964 #ifdef FEAT_EVAL
965 || ccline.cmdfirstc == '>'
966 #endif
968 goto cmdline_not_changed;
970 vim_free(ccline.cmdbuff); /* no commandline to return */
971 ccline.cmdbuff = NULL;
972 if (!cmd_silent)
974 #ifdef FEAT_RIGHTLEFT
975 if (cmdmsg_rl)
976 msg_col = Columns;
977 else
978 #endif
979 msg_col = 0;
980 msg_putchar(' '); /* delete ':' */
982 redraw_cmdline = TRUE;
983 goto returncmd; /* back to cmd mode */
985 goto cmdline_changed;
987 case K_INS:
988 case K_KINS:
989 #ifdef FEAT_FKMAP
990 /* if Farsi mode set, we are in reverse insert mode -
991 Do not change the mode */
992 if (cmd_fkmap)
993 beep_flush();
994 else
995 #endif
996 ccline.overstrike = !ccline.overstrike;
997 #ifdef CURSOR_SHAPE
998 ui_cursor_shape(); /* may show different cursor shape */
999 #endif
1000 goto cmdline_not_changed;
1002 case Ctrl_HAT:
1003 if (map_to_exists_mode((char_u *)"", LANGMAP, FALSE))
1005 /* ":lmap" mappings exists, toggle use of mappings. */
1006 State ^= LANGMAP;
1007 #ifdef USE_IM_CONTROL
1008 im_set_active(FALSE); /* Disable input method */
1009 #endif
1010 if (b_im_ptr != NULL)
1012 if (State & LANGMAP)
1013 *b_im_ptr = B_IMODE_LMAP;
1014 else
1015 *b_im_ptr = B_IMODE_NONE;
1018 #ifdef USE_IM_CONTROL
1019 else
1021 /* There are no ":lmap" mappings, toggle IM. When
1022 * 'imdisable' is set don't try getting the status, it's
1023 * always off. */
1024 if ((p_imdisable && b_im_ptr != NULL)
1025 ? *b_im_ptr == B_IMODE_IM : im_get_status())
1027 im_set_active(FALSE); /* Disable input method */
1028 if (b_im_ptr != NULL)
1029 *b_im_ptr = B_IMODE_NONE;
1031 else
1033 im_set_active(TRUE); /* Enable input method */
1034 if (b_im_ptr != NULL)
1035 *b_im_ptr = B_IMODE_IM;
1038 #endif
1039 if (b_im_ptr != NULL)
1041 if (b_im_ptr == &curbuf->b_p_iminsert)
1042 set_iminsert_global();
1043 else
1044 set_imsearch_global();
1046 #ifdef CURSOR_SHAPE
1047 ui_cursor_shape(); /* may show different cursor shape */
1048 #endif
1049 #if defined(FEAT_WINDOWS) && defined(FEAT_KEYMAP)
1050 /* Show/unshow value of 'keymap' in status lines later. */
1051 status_redraw_curbuf();
1052 #endif
1053 goto cmdline_not_changed;
1055 /* case '@': only in very old vi */
1056 case Ctrl_U:
1057 /* delete all characters left of the cursor */
1058 j = ccline.cmdpos;
1059 ccline.cmdlen -= j;
1060 i = ccline.cmdpos = 0;
1061 while (i < ccline.cmdlen)
1062 ccline.cmdbuff[i++] = ccline.cmdbuff[j++];
1063 /* Truncate at the end, required for multi-byte chars. */
1064 ccline.cmdbuff[ccline.cmdlen] = NUL;
1065 redrawcmd();
1066 goto cmdline_changed;
1068 #ifdef FEAT_CLIPBOARD
1069 case Ctrl_Y:
1070 /* Copy the modeless selection, if there is one. */
1071 if (clip_star.state != SELECT_CLEARED)
1073 if (clip_star.state == SELECT_DONE)
1074 clip_copy_modeless_selection(TRUE);
1075 goto cmdline_not_changed;
1077 break;
1078 #endif
1080 case ESC: /* get here if p_wc != ESC or when ESC typed twice */
1081 case Ctrl_C:
1082 /* In exmode it doesn't make sense to return. Except when
1083 * ":normal" runs out of characters. */
1084 if (exmode_active
1085 #ifdef FEAT_EX_EXTRA
1086 && (ex_normal_busy == 0 || typebuf.tb_len > 0)
1087 #endif
1089 goto cmdline_not_changed;
1091 gotesc = TRUE; /* will free ccline.cmdbuff after
1092 putting it in history */
1093 goto returncmd; /* back to cmd mode */
1095 case Ctrl_R: /* insert register */
1096 #ifdef USE_ON_FLY_SCROLL
1097 dont_scroll = TRUE; /* disallow scrolling here */
1098 #endif
1099 putcmdline('"', TRUE);
1100 ++no_mapping;
1101 i = c = plain_vgetc(); /* CTRL-R <char> */
1102 if (i == Ctrl_O)
1103 i = Ctrl_R; /* CTRL-R CTRL-O == CTRL-R CTRL-R */
1104 if (i == Ctrl_R)
1105 c = plain_vgetc(); /* CTRL-R CTRL-R <char> */
1106 --no_mapping;
1107 #ifdef FEAT_EVAL
1109 * Insert the result of an expression.
1110 * Need to save the current command line, to be able to enter
1111 * a new one...
1113 new_cmdpos = -1;
1114 if (c == '=')
1116 if (ccline.cmdfirstc == '=')/* can't do this recursively */
1118 beep_flush();
1119 c = ESC;
1121 else
1123 save_cmdline(&save_ccline);
1124 c = get_expr_register();
1125 restore_cmdline(&save_ccline);
1128 #endif
1129 if (c != ESC) /* use ESC to cancel inserting register */
1131 cmdline_paste(c, i == Ctrl_R, FALSE);
1133 #ifdef FEAT_EVAL
1134 /* When there was a serious error abort getting the
1135 * command line. */
1136 if (aborting())
1138 gotesc = TRUE; /* will free ccline.cmdbuff after
1139 putting it in history */
1140 goto returncmd; /* back to cmd mode */
1142 #endif
1143 KeyTyped = FALSE; /* Don't do p_wc completion. */
1144 #ifdef FEAT_EVAL
1145 if (new_cmdpos >= 0)
1147 /* set_cmdline_pos() was used */
1148 if (new_cmdpos > ccline.cmdlen)
1149 ccline.cmdpos = ccline.cmdlen;
1150 else
1151 ccline.cmdpos = new_cmdpos;
1153 #endif
1155 redrawcmd();
1156 goto cmdline_changed;
1158 case Ctrl_D:
1159 if (showmatches(&xpc, FALSE) == EXPAND_NOTHING)
1160 break; /* Use ^D as normal char instead */
1162 redrawcmd();
1163 continue; /* don't do incremental search now */
1165 case K_RIGHT:
1166 case K_S_RIGHT:
1167 case K_C_RIGHT:
1170 if (ccline.cmdpos >= ccline.cmdlen)
1171 break;
1172 i = cmdline_charsize(ccline.cmdpos);
1173 if (KeyTyped && ccline.cmdspos + i >= Columns * Rows)
1174 break;
1175 ccline.cmdspos += i;
1176 #ifdef FEAT_MBYTE
1177 if (has_mbyte)
1178 ccline.cmdpos += (*mb_ptr2len)(ccline.cmdbuff
1179 + ccline.cmdpos);
1180 else
1181 #endif
1182 ++ccline.cmdpos;
1184 while ((c == K_S_RIGHT || c == K_C_RIGHT
1185 || (mod_mask & (MOD_MASK_SHIFT|MOD_MASK_CTRL)))
1186 && ccline.cmdbuff[ccline.cmdpos] != ' ');
1187 #ifdef FEAT_MBYTE
1188 if (has_mbyte)
1189 set_cmdspos_cursor();
1190 #endif
1191 goto cmdline_not_changed;
1193 case K_LEFT:
1194 case K_S_LEFT:
1195 case K_C_LEFT:
1196 if (ccline.cmdpos == 0)
1197 goto cmdline_not_changed;
1200 --ccline.cmdpos;
1201 #ifdef FEAT_MBYTE
1202 if (has_mbyte) /* move to first byte of char */
1203 ccline.cmdpos -= (*mb_head_off)(ccline.cmdbuff,
1204 ccline.cmdbuff + ccline.cmdpos);
1205 #endif
1206 ccline.cmdspos -= cmdline_charsize(ccline.cmdpos);
1208 while (ccline.cmdpos > 0
1209 && (c == K_S_LEFT || c == K_C_LEFT
1210 || (mod_mask & (MOD_MASK_SHIFT|MOD_MASK_CTRL)))
1211 && ccline.cmdbuff[ccline.cmdpos - 1] != ' ');
1212 #ifdef FEAT_MBYTE
1213 if (has_mbyte)
1214 set_cmdspos_cursor();
1215 #endif
1216 goto cmdline_not_changed;
1218 case K_IGNORE:
1219 /* Ignore mouse event or ex_window() result. */
1220 goto cmdline_not_changed;
1222 #ifdef FEAT_GUI_W32
1223 /* On Win32 ignore <M-F4>, we get it when closing the window was
1224 * cancelled. */
1225 case K_F4:
1226 if (mod_mask == MOD_MASK_ALT)
1228 redrawcmd(); /* somehow the cmdline is cleared */
1229 goto cmdline_not_changed;
1231 break;
1232 #endif
1234 #ifdef FEAT_MOUSE
1235 case K_MIDDLEDRAG:
1236 case K_MIDDLERELEASE:
1237 goto cmdline_not_changed; /* Ignore mouse */
1239 case K_MIDDLEMOUSE:
1240 # ifdef FEAT_GUI
1241 /* When GUI is active, also paste when 'mouse' is empty */
1242 if (!gui.in_use)
1243 # endif
1244 if (!mouse_has(MOUSE_COMMAND))
1245 goto cmdline_not_changed; /* Ignore mouse */
1246 # ifdef FEAT_CLIPBOARD
1247 if (clip_star.available)
1248 cmdline_paste('*', TRUE, TRUE);
1249 else
1250 # endif
1251 cmdline_paste(0, TRUE, TRUE);
1252 redrawcmd();
1253 goto cmdline_changed;
1255 # ifdef FEAT_DND
1256 case K_DROP:
1257 cmdline_paste('~', TRUE, FALSE);
1258 redrawcmd();
1259 goto cmdline_changed;
1260 # endif
1262 case K_LEFTDRAG:
1263 case K_LEFTRELEASE:
1264 case K_RIGHTDRAG:
1265 case K_RIGHTRELEASE:
1266 /* Ignore drag and release events when the button-down wasn't
1267 * seen before. */
1268 if (ignore_drag_release)
1269 goto cmdline_not_changed;
1270 /* FALLTHROUGH */
1271 case K_LEFTMOUSE:
1272 case K_RIGHTMOUSE:
1273 if (c == K_LEFTRELEASE || c == K_RIGHTRELEASE)
1274 ignore_drag_release = TRUE;
1275 else
1276 ignore_drag_release = FALSE;
1277 # ifdef FEAT_GUI
1278 /* When GUI is active, also move when 'mouse' is empty */
1279 if (!gui.in_use)
1280 # endif
1281 if (!mouse_has(MOUSE_COMMAND))
1282 goto cmdline_not_changed; /* Ignore mouse */
1283 # ifdef FEAT_CLIPBOARD
1284 if (mouse_row < cmdline_row && clip_star.available)
1286 int button, is_click, is_drag;
1289 * Handle modeless selection.
1291 button = get_mouse_button(KEY2TERMCAP1(c),
1292 &is_click, &is_drag);
1293 if (mouse_model_popup() && button == MOUSE_LEFT
1294 && (mod_mask & MOD_MASK_SHIFT))
1296 /* Translate shift-left to right button. */
1297 button = MOUSE_RIGHT;
1298 mod_mask &= ~MOD_MASK_SHIFT;
1300 clip_modeless(button, is_click, is_drag);
1301 goto cmdline_not_changed;
1303 # endif
1305 set_cmdspos();
1306 for (ccline.cmdpos = 0; ccline.cmdpos < ccline.cmdlen;
1307 ++ccline.cmdpos)
1309 i = cmdline_charsize(ccline.cmdpos);
1310 if (mouse_row <= cmdline_row + ccline.cmdspos / Columns
1311 && mouse_col < ccline.cmdspos % Columns + i)
1312 break;
1313 # ifdef FEAT_MBYTE
1314 if (has_mbyte)
1316 /* Count ">" for double-wide char that doesn't fit. */
1317 correct_cmdspos(ccline.cmdpos, i);
1318 ccline.cmdpos += (*mb_ptr2len)(ccline.cmdbuff
1319 + ccline.cmdpos) - 1;
1321 # endif
1322 ccline.cmdspos += i;
1324 goto cmdline_not_changed;
1326 /* Mouse scroll wheel: ignored here */
1327 case K_MOUSEDOWN:
1328 case K_MOUSEUP:
1329 /* Alternate buttons ignored here */
1330 case K_X1MOUSE:
1331 case K_X1DRAG:
1332 case K_X1RELEASE:
1333 case K_X2MOUSE:
1334 case K_X2DRAG:
1335 case K_X2RELEASE:
1336 goto cmdline_not_changed;
1338 #endif /* FEAT_MOUSE */
1340 #ifdef FEAT_GUI
1341 case K_LEFTMOUSE_NM: /* mousefocus click, ignored */
1342 case K_LEFTRELEASE_NM:
1343 goto cmdline_not_changed;
1345 case K_VER_SCROLLBAR:
1346 if (msg_scrolled == 0)
1348 gui_do_scroll();
1349 redrawcmd();
1351 goto cmdline_not_changed;
1353 case K_HOR_SCROLLBAR:
1354 if (msg_scrolled == 0)
1356 gui_do_horiz_scroll();
1357 redrawcmd();
1359 goto cmdline_not_changed;
1360 #endif
1361 #ifdef FEAT_GUI_TABLINE
1362 case K_TABLINE:
1363 case K_TABMENU:
1364 /* Don't want to change any tabs here. Make sure the same tab
1365 * is still selected. */
1366 if (gui_use_tabline())
1367 gui_mch_set_curtab(tabpage_index(curtab));
1368 goto cmdline_not_changed;
1369 #endif
1371 case K_SELECT: /* end of Select mode mapping - ignore */
1372 goto cmdline_not_changed;
1374 case Ctrl_B: /* begin of command line */
1375 case K_HOME:
1376 case K_KHOME:
1377 case K_S_HOME:
1378 case K_C_HOME:
1379 ccline.cmdpos = 0;
1380 set_cmdspos();
1381 goto cmdline_not_changed;
1383 case Ctrl_E: /* end of command line */
1384 case K_END:
1385 case K_KEND:
1386 case K_S_END:
1387 case K_C_END:
1388 ccline.cmdpos = ccline.cmdlen;
1389 set_cmdspos_cursor();
1390 goto cmdline_not_changed;
1392 case Ctrl_A: /* all matches */
1393 if (nextwild(&xpc, WILD_ALL, 0) == FAIL)
1394 break;
1395 goto cmdline_changed;
1397 case Ctrl_L:
1398 #ifdef FEAT_SEARCH_EXTRA
1399 if (p_is && !cmd_silent && (firstc == '/' || firstc == '?'))
1401 /* Add a character from under the cursor for 'incsearch' */
1402 if (did_incsearch
1403 && !equalpos(curwin->w_cursor, old_cursor))
1405 c = gchar_cursor();
1406 if (c != NUL)
1408 if (c == firstc || vim_strchr((char_u *)(
1409 p_magic ? "\\^$.*[" : "\\^$"), c)
1410 != NULL)
1412 /* put a backslash before special characters */
1413 stuffcharReadbuff(c);
1414 c = '\\';
1416 break;
1419 goto cmdline_not_changed;
1421 #endif
1423 /* completion: longest common part */
1424 if (nextwild(&xpc, WILD_LONGEST, 0) == FAIL)
1425 break;
1426 goto cmdline_changed;
1428 case Ctrl_N: /* next match */
1429 case Ctrl_P: /* previous match */
1430 if (xpc.xp_numfiles > 0)
1432 if (nextwild(&xpc, (c == Ctrl_P) ? WILD_PREV : WILD_NEXT, 0)
1433 == FAIL)
1434 break;
1435 goto cmdline_changed;
1438 #ifdef FEAT_CMDHIST
1439 case K_UP:
1440 case K_DOWN:
1441 case K_S_UP:
1442 case K_S_DOWN:
1443 case K_PAGEUP:
1444 case K_KPAGEUP:
1445 case K_PAGEDOWN:
1446 case K_KPAGEDOWN:
1447 if (hislen == 0 || firstc == NUL) /* no history */
1448 goto cmdline_not_changed;
1450 i = hiscnt;
1452 /* save current command string so it can be restored later */
1453 if (lookfor == NULL)
1455 if ((lookfor = vim_strsave(ccline.cmdbuff)) == NULL)
1456 goto cmdline_not_changed;
1457 lookfor[ccline.cmdpos] = NUL;
1460 j = (int)STRLEN(lookfor);
1461 for (;;)
1463 /* one step backwards */
1464 if (c == K_UP|| c == K_S_UP || c == Ctrl_P
1465 || c == K_PAGEUP || c == K_KPAGEUP)
1467 if (hiscnt == hislen) /* first time */
1468 hiscnt = hisidx[histype];
1469 else if (hiscnt == 0 && hisidx[histype] != hislen - 1)
1470 hiscnt = hislen - 1;
1471 else if (hiscnt != hisidx[histype] + 1)
1472 --hiscnt;
1473 else /* at top of list */
1475 hiscnt = i;
1476 break;
1479 else /* one step forwards */
1481 /* on last entry, clear the line */
1482 if (hiscnt == hisidx[histype])
1484 hiscnt = hislen;
1485 break;
1488 /* not on a history line, nothing to do */
1489 if (hiscnt == hislen)
1490 break;
1491 if (hiscnt == hislen - 1) /* wrap around */
1492 hiscnt = 0;
1493 else
1494 ++hiscnt;
1496 if (hiscnt < 0 || history[histype][hiscnt].hisstr == NULL)
1498 hiscnt = i;
1499 break;
1501 if ((c != K_UP && c != K_DOWN)
1502 || hiscnt == i
1503 || STRNCMP(history[histype][hiscnt].hisstr,
1504 lookfor, (size_t)j) == 0)
1505 break;
1508 if (hiscnt != i) /* jumped to other entry */
1510 char_u *p;
1511 int len;
1512 int old_firstc;
1514 vim_free(ccline.cmdbuff);
1515 if (hiscnt == hislen)
1516 p = lookfor; /* back to the old one */
1517 else
1518 p = history[histype][hiscnt].hisstr;
1520 if (histype == HIST_SEARCH
1521 && p != lookfor
1522 && (old_firstc = p[STRLEN(p) + 1]) != firstc)
1524 /* Correct for the separator character used when
1525 * adding the history entry vs the one used now.
1526 * First loop: count length.
1527 * Second loop: copy the characters. */
1528 for (i = 0; i <= 1; ++i)
1530 len = 0;
1531 for (j = 0; p[j] != NUL; ++j)
1533 /* Replace old sep with new sep, unless it is
1534 * escaped. */
1535 if (p[j] == old_firstc
1536 && (j == 0 || p[j - 1] != '\\'))
1538 if (i > 0)
1539 ccline.cmdbuff[len] = firstc;
1541 else
1543 /* Escape new sep, unless it is already
1544 * escaped. */
1545 if (p[j] == firstc
1546 && (j == 0 || p[j - 1] != '\\'))
1548 if (i > 0)
1549 ccline.cmdbuff[len] = '\\';
1550 ++len;
1552 if (i > 0)
1553 ccline.cmdbuff[len] = p[j];
1555 ++len;
1557 if (i == 0)
1559 alloc_cmdbuff(len);
1560 if (ccline.cmdbuff == NULL)
1561 goto returncmd;
1564 ccline.cmdbuff[len] = NUL;
1566 else
1568 alloc_cmdbuff((int)STRLEN(p));
1569 if (ccline.cmdbuff == NULL)
1570 goto returncmd;
1571 STRCPY(ccline.cmdbuff, p);
1574 ccline.cmdpos = ccline.cmdlen = (int)STRLEN(ccline.cmdbuff);
1575 redrawcmd();
1576 goto cmdline_changed;
1578 beep_flush();
1579 goto cmdline_not_changed;
1580 #endif
1582 case Ctrl_V:
1583 case Ctrl_Q:
1584 #ifdef FEAT_MOUSE
1585 ignore_drag_release = TRUE;
1586 #endif
1587 putcmdline('^', TRUE);
1588 c = get_literal(); /* get next (two) character(s) */
1589 do_abbr = FALSE; /* don't do abbreviation now */
1590 #ifdef FEAT_MBYTE
1591 /* may need to remove ^ when composing char was typed */
1592 if (enc_utf8 && utf_iscomposing(c) && !cmd_silent)
1594 draw_cmdline(ccline.cmdpos, ccline.cmdlen - ccline.cmdpos);
1595 msg_putchar(' ');
1596 cursorcmd();
1598 #endif
1599 break;
1601 #ifdef FEAT_DIGRAPHS
1602 case Ctrl_K:
1603 #ifdef FEAT_MOUSE
1604 ignore_drag_release = TRUE;
1605 #endif
1606 putcmdline('?', TRUE);
1607 #ifdef USE_ON_FLY_SCROLL
1608 dont_scroll = TRUE; /* disallow scrolling here */
1609 #endif
1610 c = get_digraph(TRUE);
1611 if (c != NUL)
1612 break;
1614 redrawcmd();
1615 goto cmdline_not_changed;
1616 #endif /* FEAT_DIGRAPHS */
1618 #ifdef FEAT_RIGHTLEFT
1619 case Ctrl__: /* CTRL-_: switch language mode */
1620 if (!p_ari)
1621 break;
1622 #ifdef FEAT_FKMAP
1623 if (p_altkeymap)
1625 cmd_fkmap = !cmd_fkmap;
1626 if (cmd_fkmap) /* in Farsi always in Insert mode */
1627 ccline.overstrike = FALSE;
1629 else /* Hebrew is default */
1630 #endif
1631 cmd_hkmap = !cmd_hkmap;
1632 goto cmdline_not_changed;
1633 #endif
1635 default:
1636 #ifdef UNIX
1637 if (c == intr_char)
1639 gotesc = TRUE; /* will free ccline.cmdbuff after
1640 putting it in history */
1641 goto returncmd; /* back to Normal mode */
1643 #endif
1645 * Normal character with no special meaning. Just set mod_mask
1646 * to 0x0 so that typing Shift-Space in the GUI doesn't enter
1647 * the string <S-Space>. This should only happen after ^V.
1649 if (!IS_SPECIAL(c))
1650 mod_mask = 0x0;
1651 break;
1654 * End of switch on command line character.
1655 * We come here if we have a normal character.
1658 if (do_abbr && (IS_SPECIAL(c) || !vim_iswordc(c)) && ccheck_abbr(
1659 #ifdef FEAT_MBYTE
1660 /* Add ABBR_OFF for characters above 0x100, this is
1661 * what check_abbr() expects. */
1662 (has_mbyte && c >= 0x100) ? (c + ABBR_OFF) :
1663 #endif
1665 goto cmdline_changed;
1668 * put the character in the command line
1670 if (IS_SPECIAL(c) || mod_mask != 0)
1671 put_on_cmdline(get_special_key_name(c, mod_mask), -1, TRUE);
1672 else
1674 #ifdef FEAT_MBYTE
1675 if (has_mbyte)
1677 j = (*mb_char2bytes)(c, IObuff);
1678 IObuff[j] = NUL; /* exclude composing chars */
1679 put_on_cmdline(IObuff, j, TRUE);
1681 else
1682 #endif
1684 IObuff[0] = c;
1685 put_on_cmdline(IObuff, 1, TRUE);
1688 goto cmdline_changed;
1691 * This part implements incremental searches for "/" and "?"
1692 * Jump to cmdline_not_changed when a character has been read but the command
1693 * line did not change. Then we only search and redraw if something changed in
1694 * the past.
1695 * Jump to cmdline_changed when the command line did change.
1696 * (Sorry for the goto's, I know it is ugly).
1698 cmdline_not_changed:
1699 #ifdef FEAT_SEARCH_EXTRA
1700 if (!incsearch_postponed)
1701 continue;
1702 #endif
1704 cmdline_changed:
1705 #ifdef FEAT_SEARCH_EXTRA
1707 * 'incsearch' highlighting.
1709 if (p_is && !cmd_silent && (firstc == '/' || firstc == '?'))
1711 pos_T end_pos;
1712 #ifdef FEAT_RELTIME
1713 proftime_T tm;
1714 #endif
1716 /* if there is a character waiting, search and redraw later */
1717 if (char_avail())
1719 incsearch_postponed = TRUE;
1720 continue;
1722 incsearch_postponed = FALSE;
1723 curwin->w_cursor = old_cursor; /* start at old position */
1725 /* If there is no command line, don't do anything */
1726 if (ccline.cmdlen == 0)
1727 i = 0;
1728 else
1730 cursor_off(); /* so the user knows we're busy */
1731 out_flush();
1732 ++emsg_off; /* So it doesn't beep if bad expr */
1733 #ifdef FEAT_RELTIME
1734 /* Set the time limit to half a second. */
1735 profile_setlimit(500L, &tm);
1736 #endif
1737 i = do_search(NULL, firstc, ccline.cmdbuff, count,
1738 SEARCH_KEEP + SEARCH_OPT + SEARCH_NOOF + SEARCH_PEEK,
1739 #ifdef FEAT_RELTIME
1741 #else
1742 NULL
1743 #endif
1745 --emsg_off;
1746 /* if interrupted while searching, behave like it failed */
1747 if (got_int)
1749 (void)vpeekc(); /* remove <C-C> from input stream */
1750 got_int = FALSE; /* don't abandon the command line */
1751 i = 0;
1753 else if (char_avail())
1754 /* cancelled searching because a char was typed */
1755 incsearch_postponed = TRUE;
1757 if (i != 0)
1758 highlight_match = TRUE; /* highlight position */
1759 else
1760 highlight_match = FALSE; /* remove highlight */
1762 /* first restore the old curwin values, so the screen is
1763 * positioned in the same way as the actual search command */
1764 curwin->w_leftcol = old_leftcol;
1765 curwin->w_topline = old_topline;
1766 # ifdef FEAT_DIFF
1767 curwin->w_topfill = old_topfill;
1768 # endif
1769 curwin->w_botline = old_botline;
1770 changed_cline_bef_curs();
1771 update_topline();
1773 if (i != 0)
1775 pos_T save_pos = curwin->w_cursor;
1778 * First move cursor to end of match, then to the start. This
1779 * moves the whole match onto the screen when 'nowrap' is set.
1781 curwin->w_cursor.lnum += search_match_lines;
1782 curwin->w_cursor.col = search_match_endcol;
1783 if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
1785 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
1786 coladvance((colnr_T)MAXCOL);
1788 validate_cursor();
1789 end_pos = curwin->w_cursor;
1790 curwin->w_cursor = save_pos;
1792 else
1793 end_pos = curwin->w_cursor; /* shutup gcc 4 */
1795 validate_cursor();
1796 # ifdef FEAT_WINDOWS
1797 /* May redraw the status line to show the cursor position. */
1798 if (p_ru && curwin->w_status_height > 0)
1799 curwin->w_redr_status = TRUE;
1800 # endif
1802 save_cmdline(&save_ccline);
1803 update_screen(SOME_VALID);
1804 restore_cmdline(&save_ccline);
1806 /* Leave it at the end to make CTRL-R CTRL-W work. */
1807 if (i != 0)
1808 curwin->w_cursor = end_pos;
1810 msg_starthere();
1811 redrawcmdline();
1812 did_incsearch = TRUE;
1814 #else /* FEAT_SEARCH_EXTRA */
1816 #endif
1818 #ifdef FEAT_RIGHTLEFT
1819 if (cmdmsg_rl
1820 # ifdef FEAT_ARABIC
1821 || (p_arshape && !p_tbidi && enc_utf8)
1822 # endif
1824 /* Always redraw the whole command line to fix shaping and
1825 * right-left typing. Not efficient, but it works. */
1826 redrawcmd();
1827 #endif
1830 returncmd:
1832 #ifdef FEAT_RIGHTLEFT
1833 cmdmsg_rl = FALSE;
1834 #endif
1836 #ifdef FEAT_FKMAP
1837 cmd_fkmap = 0;
1838 #endif
1840 ExpandCleanup(&xpc);
1842 #ifdef FEAT_SEARCH_EXTRA
1843 if (did_incsearch)
1845 curwin->w_cursor = old_cursor;
1846 curwin->w_curswant = old_curswant;
1847 curwin->w_leftcol = old_leftcol;
1848 curwin->w_topline = old_topline;
1849 # ifdef FEAT_DIFF
1850 curwin->w_topfill = old_topfill;
1851 # endif
1852 curwin->w_botline = old_botline;
1853 highlight_match = FALSE;
1854 validate_cursor(); /* needed for TAB */
1855 redraw_later(SOME_VALID);
1857 #endif
1859 if (ccline.cmdbuff != NULL)
1862 * Put line in history buffer (":" and "=" only when it was typed).
1864 #ifdef FEAT_CMDHIST
1865 if (ccline.cmdlen && firstc != NUL
1866 && (some_key_typed || histype == HIST_SEARCH))
1868 add_to_history(histype, ccline.cmdbuff, TRUE,
1869 histype == HIST_SEARCH ? firstc : NUL);
1870 if (firstc == ':')
1872 vim_free(new_last_cmdline);
1873 new_last_cmdline = vim_strsave(ccline.cmdbuff);
1876 #endif
1878 if (gotesc) /* abandon command line */
1880 vim_free(ccline.cmdbuff);
1881 ccline.cmdbuff = NULL;
1882 if (msg_scrolled == 0)
1883 compute_cmdrow();
1884 MSG("");
1885 redraw_cmdline = TRUE;
1890 * If the screen was shifted up, redraw the whole screen (later).
1891 * If the line is too long, clear it, so ruler and shown command do
1892 * not get printed in the middle of it.
1894 msg_check();
1895 msg_scroll = save_msg_scroll;
1896 redir_off = FALSE;
1898 /* When the command line was typed, no need for a wait-return prompt. */
1899 if (some_key_typed)
1900 need_wait_return = FALSE;
1902 State = save_State;
1903 #ifdef USE_IM_CONTROL
1904 if (b_im_ptr != NULL && *b_im_ptr != B_IMODE_LMAP)
1905 im_save_status(b_im_ptr);
1906 im_set_active(FALSE);
1907 #endif
1908 #ifdef FEAT_MOUSE
1909 setmouse();
1910 #endif
1911 #ifdef CURSOR_SHAPE
1912 ui_cursor_shape(); /* may show different cursor shape */
1913 #endif
1916 char_u *p = ccline.cmdbuff;
1918 /* Make ccline empty, getcmdline() may try to use it. */
1919 ccline.cmdbuff = NULL;
1920 return p;
1924 #if (defined(FEAT_CRYPT) || defined(FEAT_EVAL)) || defined(PROTO)
1926 * Get a command line with a prompt.
1927 * This is prepared to be called recursively from getcmdline() (e.g. by
1928 * f_input() when evaluating an expression from CTRL-R =).
1929 * Returns the command line in allocated memory, or NULL.
1931 char_u *
1932 getcmdline_prompt(firstc, prompt, attr, xp_context, xp_arg)
1933 int firstc;
1934 char_u *prompt; /* command line prompt */
1935 int attr; /* attributes for prompt */
1936 int xp_context; /* type of expansion */
1937 char_u *xp_arg; /* user-defined expansion argument */
1939 char_u *s;
1940 struct cmdline_info save_ccline;
1941 int msg_col_save = msg_col;
1943 save_cmdline(&save_ccline);
1944 ccline.cmdprompt = prompt;
1945 ccline.cmdattr = attr;
1946 # ifdef FEAT_EVAL
1947 ccline.xp_context = xp_context;
1948 ccline.xp_arg = xp_arg;
1949 ccline.input_fn = (firstc == '@');
1950 # endif
1951 s = getcmdline(firstc, 1L, 0);
1952 restore_cmdline(&save_ccline);
1953 /* Restore msg_col, the prompt from input() may have changed it. */
1954 msg_col = msg_col_save;
1956 return s;
1958 #endif
1961 * Return TRUE when the text must not be changed and we can't switch to
1962 * another window or buffer. Used when editing the command line, evaluating
1963 * 'balloonexpr', etc.
1966 text_locked()
1968 #ifdef FEAT_CMDWIN
1969 if (cmdwin_type != 0)
1970 return TRUE;
1971 #endif
1972 return textlock != 0;
1976 * Give an error message for a command that isn't allowed while the cmdline
1977 * window is open or editing the cmdline in another way.
1979 void
1980 text_locked_msg()
1982 #ifdef FEAT_CMDWIN
1983 if (cmdwin_type != 0)
1984 EMSG(_(e_cmdwin));
1985 else
1986 #endif
1987 EMSG(_(e_secure));
1990 #if defined(FEAT_AUTOCMD) || defined(PROTO)
1992 * Check if "curbuf_lock" is set and return TRUE when it is and give an error
1993 * message.
1996 curbuf_locked()
1998 if (curbuf_lock > 0)
2000 EMSG(_("E788: Not allowed to edit another buffer now"));
2001 return TRUE;
2003 return FALSE;
2005 #endif
2007 static int
2008 cmdline_charsize(idx)
2009 int idx;
2011 #if defined(FEAT_CRYPT) || defined(FEAT_EVAL)
2012 if (cmdline_star > 0) /* showing '*', always 1 position */
2013 return 1;
2014 #endif
2015 return ptr2cells(ccline.cmdbuff + idx);
2019 * Compute the offset of the cursor on the command line for the prompt and
2020 * indent.
2022 static void
2023 set_cmdspos()
2025 if (ccline.cmdfirstc != NUL)
2026 ccline.cmdspos = 1 + ccline.cmdindent;
2027 else
2028 ccline.cmdspos = 0 + ccline.cmdindent;
2032 * Compute the screen position for the cursor on the command line.
2034 static void
2035 set_cmdspos_cursor()
2037 int i, m, c;
2039 set_cmdspos();
2040 if (KeyTyped)
2042 m = Columns * Rows;
2043 if (m < 0) /* overflow, Columns or Rows at weird value */
2044 m = MAXCOL;
2046 else
2047 m = MAXCOL;
2048 for (i = 0; i < ccline.cmdlen && i < ccline.cmdpos; ++i)
2050 c = cmdline_charsize(i);
2051 #ifdef FEAT_MBYTE
2052 /* Count ">" for double-wide multi-byte char that doesn't fit. */
2053 if (has_mbyte)
2054 correct_cmdspos(i, c);
2055 #endif
2056 /* If the cmdline doesn't fit, put cursor on last visible char. */
2057 if ((ccline.cmdspos += c) >= m)
2059 ccline.cmdpos = i - 1;
2060 ccline.cmdspos -= c;
2061 break;
2063 #ifdef FEAT_MBYTE
2064 if (has_mbyte)
2065 i += (*mb_ptr2len)(ccline.cmdbuff + i) - 1;
2066 #endif
2070 #ifdef FEAT_MBYTE
2072 * Check if the character at "idx", which is "cells" wide, is a multi-byte
2073 * character that doesn't fit, so that a ">" must be displayed.
2075 static void
2076 correct_cmdspos(idx, cells)
2077 int idx;
2078 int cells;
2080 if ((*mb_ptr2len)(ccline.cmdbuff + idx) > 1
2081 && (*mb_ptr2cells)(ccline.cmdbuff + idx) > 1
2082 && ccline.cmdspos % Columns + cells > Columns)
2083 ccline.cmdspos++;
2085 #endif
2088 * Get an Ex command line for the ":" command.
2090 /* ARGSUSED */
2091 char_u *
2092 getexline(c, dummy, indent)
2093 int c; /* normally ':', NUL for ":append" */
2094 void *dummy; /* cookie not used */
2095 int indent; /* indent for inside conditionals */
2097 /* When executing a register, remove ':' that's in front of each line. */
2098 if (exec_from_reg && vpeekc() == ':')
2099 (void)vgetc();
2100 return getcmdline(c, 1L, indent);
2104 * Get an Ex command line for Ex mode.
2105 * In Ex mode we only use the OS supplied line editing features and no
2106 * mappings or abbreviations.
2107 * Returns a string in allocated memory or NULL.
2109 /* ARGSUSED */
2110 char_u *
2111 getexmodeline(promptc, dummy, indent)
2112 int promptc; /* normally ':', NUL for ":append" and '?' for
2113 :s prompt */
2114 void *dummy; /* cookie not used */
2115 int indent; /* indent for inside conditionals */
2117 garray_T line_ga;
2118 char_u *pend;
2119 int startcol = 0;
2120 int c1 = 0;
2121 int escaped = FALSE; /* CTRL-V typed */
2122 int vcol = 0;
2123 char_u *p;
2124 int prev_char;
2126 /* Switch cursor on now. This avoids that it happens after the "\n", which
2127 * confuses the system function that computes tabstops. */
2128 cursor_on();
2130 /* always start in column 0; write a newline if necessary */
2131 compute_cmdrow();
2132 if ((msg_col || msg_didout) && promptc != '?')
2133 msg_putchar('\n');
2134 if (promptc == ':')
2136 /* indent that is only displayed, not in the line itself */
2137 if (p_prompt)
2138 msg_putchar(':');
2139 while (indent-- > 0)
2140 msg_putchar(' ');
2141 startcol = msg_col;
2144 ga_init2(&line_ga, 1, 30);
2146 /* autoindent for :insert and :append is in the line itself */
2147 if (promptc <= 0)
2149 vcol = indent;
2150 while (indent >= 8)
2152 ga_append(&line_ga, TAB);
2153 msg_puts((char_u *)" ");
2154 indent -= 8;
2156 while (indent-- > 0)
2158 ga_append(&line_ga, ' ');
2159 msg_putchar(' ');
2162 ++no_mapping;
2163 ++allow_keys;
2166 * Get the line, one character at a time.
2168 got_int = FALSE;
2169 while (!got_int)
2171 if (ga_grow(&line_ga, 40) == FAIL)
2172 break;
2173 pend = (char_u *)line_ga.ga_data + line_ga.ga_len;
2175 /* Get one character at a time. Don't use inchar(), it can't handle
2176 * special characters. */
2177 prev_char = c1;
2178 c1 = vgetc();
2181 * Handle line editing.
2182 * Previously this was left to the system, putting the terminal in
2183 * cooked mode, but then CTRL-D and CTRL-T can't be used properly.
2185 if (got_int)
2187 msg_putchar('\n');
2188 break;
2191 if (!escaped)
2193 /* CR typed means "enter", which is NL */
2194 if (c1 == '\r')
2195 c1 = '\n';
2197 if (c1 == BS || c1 == K_BS
2198 || c1 == DEL || c1 == K_DEL || c1 == K_KDEL)
2200 if (line_ga.ga_len > 0)
2202 --line_ga.ga_len;
2203 goto redraw;
2205 continue;
2208 if (c1 == Ctrl_U)
2210 msg_col = startcol;
2211 msg_clr_eos();
2212 line_ga.ga_len = 0;
2213 continue;
2216 if (c1 == Ctrl_T)
2218 p = (char_u *)line_ga.ga_data;
2219 p[line_ga.ga_len] = NUL;
2220 indent = get_indent_str(p, 8);
2221 indent += curbuf->b_p_sw - indent % curbuf->b_p_sw;
2222 add_indent:
2223 while (get_indent_str(p, 8) < indent)
2225 char_u *s = skipwhite(p);
2227 ga_grow(&line_ga, 1);
2228 mch_memmove(s + 1, s, line_ga.ga_len - (s - p) + 1);
2229 *s = ' ';
2230 ++line_ga.ga_len;
2232 redraw:
2233 /* redraw the line */
2234 msg_col = startcol;
2235 vcol = 0;
2236 for (p = (char_u *)line_ga.ga_data;
2237 p < (char_u *)line_ga.ga_data + line_ga.ga_len; ++p)
2239 if (*p == TAB)
2243 msg_putchar(' ');
2244 } while (++vcol % 8);
2246 else
2248 msg_outtrans_len(p, 1);
2249 vcol += char2cells(*p);
2252 msg_clr_eos();
2253 windgoto(msg_row, msg_col);
2254 continue;
2257 if (c1 == Ctrl_D)
2259 /* Delete one shiftwidth. */
2260 p = (char_u *)line_ga.ga_data;
2261 if (prev_char == '0' || prev_char == '^')
2263 if (prev_char == '^')
2264 ex_keep_indent = TRUE;
2265 indent = 0;
2266 p[--line_ga.ga_len] = NUL;
2268 else
2270 p[line_ga.ga_len] = NUL;
2271 indent = get_indent_str(p, 8);
2272 --indent;
2273 indent -= indent % curbuf->b_p_sw;
2275 while (get_indent_str(p, 8) > indent)
2277 char_u *s = skipwhite(p);
2279 mch_memmove(s - 1, s, line_ga.ga_len - (s - p) + 1);
2280 --line_ga.ga_len;
2282 goto add_indent;
2285 if (c1 == Ctrl_V || c1 == Ctrl_Q)
2287 escaped = TRUE;
2288 continue;
2291 /* Ignore special key codes: mouse movement, K_IGNORE, etc. */
2292 if (IS_SPECIAL(c1))
2293 continue;
2296 if (IS_SPECIAL(c1))
2297 c1 = '?';
2298 ((char_u *)line_ga.ga_data)[line_ga.ga_len] = c1;
2299 if (c1 == '\n')
2300 msg_putchar('\n');
2301 else if (c1 == TAB)
2303 /* Don't use chartabsize(), 'ts' can be different */
2306 msg_putchar(' ');
2307 } while (++vcol % 8);
2309 else
2311 msg_outtrans_len(
2312 ((char_u *)line_ga.ga_data) + line_ga.ga_len, 1);
2313 vcol += char2cells(c1);
2315 ++line_ga.ga_len;
2316 escaped = FALSE;
2318 windgoto(msg_row, msg_col);
2319 pend = (char_u *)(line_ga.ga_data) + line_ga.ga_len;
2321 /* we are done when a NL is entered, but not when it comes after a
2322 * backslash */
2323 if (line_ga.ga_len > 0 && pend[-1] == '\n'
2324 && (line_ga.ga_len <= 1 || pend[-2] != '\\'))
2326 --line_ga.ga_len;
2327 --pend;
2328 *pend = NUL;
2329 break;
2333 --no_mapping;
2334 --allow_keys;
2336 /* make following messages go to the next line */
2337 msg_didout = FALSE;
2338 msg_col = 0;
2339 if (msg_row < Rows - 1)
2340 ++msg_row;
2341 emsg_on_display = FALSE; /* don't want ui_delay() */
2343 if (got_int)
2344 ga_clear(&line_ga);
2346 return (char_u *)line_ga.ga_data;
2349 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \
2350 || defined(FEAT_MOUSESHAPE) || defined(PROTO)
2352 * Return TRUE if ccline.overstrike is on.
2355 cmdline_overstrike()
2357 return ccline.overstrike;
2361 * Return TRUE if the cursor is at the end of the cmdline.
2364 cmdline_at_end()
2366 return (ccline.cmdpos >= ccline.cmdlen);
2368 #endif
2370 #if (defined(FEAT_XIM) && (defined(FEAT_GUI_GTK))) || defined(PROTO)
2372 * Return the virtual column number at the current cursor position.
2373 * This is used by the IM code to obtain the start of the preedit string.
2375 colnr_T
2376 cmdline_getvcol_cursor()
2378 if (ccline.cmdbuff == NULL || ccline.cmdpos > ccline.cmdlen)
2379 return MAXCOL;
2381 # ifdef FEAT_MBYTE
2382 if (has_mbyte)
2384 colnr_T col;
2385 int i = 0;
2387 for (col = 0; i < ccline.cmdpos; ++col)
2388 i += (*mb_ptr2len)(ccline.cmdbuff + i);
2390 return col;
2392 else
2393 # endif
2394 return ccline.cmdpos;
2396 #endif
2398 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
2400 * If part of the command line is an IM preedit string, redraw it with
2401 * IM feedback attributes. The cursor position is restored after drawing.
2403 static void
2404 redrawcmd_preedit()
2406 if ((State & CMDLINE)
2407 && xic != NULL
2408 /* && im_get_status() doesn't work when using SCIM */
2409 && !p_imdisable
2410 && im_is_preediting())
2412 int cmdpos = 0;
2413 int cmdspos;
2414 int old_row;
2415 int old_col;
2416 colnr_T col;
2418 old_row = msg_row;
2419 old_col = msg_col;
2420 cmdspos = ((ccline.cmdfirstc != NUL) ? 1 : 0) + ccline.cmdindent;
2422 # ifdef FEAT_MBYTE
2423 if (has_mbyte)
2425 for (col = 0; col < preedit_start_col
2426 && cmdpos < ccline.cmdlen; ++col)
2428 cmdspos += (*mb_ptr2cells)(ccline.cmdbuff + cmdpos);
2429 cmdpos += (*mb_ptr2len)(ccline.cmdbuff + cmdpos);
2432 else
2433 # endif
2435 cmdspos += preedit_start_col;
2436 cmdpos += preedit_start_col;
2439 msg_row = cmdline_row + (cmdspos / (int)Columns);
2440 msg_col = cmdspos % (int)Columns;
2441 if (msg_row >= Rows)
2442 msg_row = Rows - 1;
2444 for (col = 0; cmdpos < ccline.cmdlen; ++col)
2446 int char_len;
2447 int char_attr;
2449 char_attr = im_get_feedback_attr(col);
2450 if (char_attr < 0)
2451 break; /* end of preedit string */
2453 # ifdef FEAT_MBYTE
2454 if (has_mbyte)
2455 char_len = (*mb_ptr2len)(ccline.cmdbuff + cmdpos);
2456 else
2457 # endif
2458 char_len = 1;
2460 msg_outtrans_len_attr(ccline.cmdbuff + cmdpos, char_len, char_attr);
2461 cmdpos += char_len;
2464 msg_row = old_row;
2465 msg_col = old_col;
2468 #endif /* FEAT_XIM && FEAT_GUI_GTK */
2471 * Allocate a new command line buffer.
2472 * Assigns the new buffer to ccline.cmdbuff and ccline.cmdbufflen.
2473 * Returns the new value of ccline.cmdbuff and ccline.cmdbufflen.
2475 static void
2476 alloc_cmdbuff(len)
2477 int len;
2480 * give some extra space to avoid having to allocate all the time
2482 if (len < 80)
2483 len = 100;
2484 else
2485 len += 20;
2487 ccline.cmdbuff = alloc(len); /* caller should check for out-of-memory */
2488 ccline.cmdbufflen = len;
2492 * Re-allocate the command line to length len + something extra.
2493 * return FAIL for failure, OK otherwise
2495 static int
2496 realloc_cmdbuff(len)
2497 int len;
2499 char_u *p;
2501 p = ccline.cmdbuff;
2502 alloc_cmdbuff(len); /* will get some more */
2503 if (ccline.cmdbuff == NULL) /* out of memory */
2505 ccline.cmdbuff = p; /* keep the old one */
2506 return FAIL;
2508 mch_memmove(ccline.cmdbuff, p, (size_t)ccline.cmdlen + 1);
2509 vim_free(p);
2510 return OK;
2513 #if defined(FEAT_ARABIC) || defined(PROTO)
2514 static char_u *arshape_buf = NULL;
2516 # if defined(EXITFREE) || defined(PROTO)
2517 void
2518 free_cmdline_buf()
2520 vim_free(arshape_buf);
2522 # endif
2523 #endif
2526 * Draw part of the cmdline at the current cursor position. But draw stars
2527 * when cmdline_star is TRUE.
2529 static void
2530 draw_cmdline(start, len)
2531 int start;
2532 int len;
2534 #if defined(FEAT_CRYPT) || defined(FEAT_EVAL)
2535 int i;
2537 if (cmdline_star > 0)
2538 for (i = 0; i < len; ++i)
2540 msg_putchar('*');
2541 # ifdef FEAT_MBYTE
2542 if (has_mbyte)
2543 i += (*mb_ptr2len)(ccline.cmdbuff + start + i) - 1;
2544 # endif
2546 else
2547 #endif
2548 #ifdef FEAT_ARABIC
2549 if (p_arshape && !p_tbidi && enc_utf8 && len > 0)
2551 static int buflen = 0;
2552 char_u *p;
2553 int j;
2554 int newlen = 0;
2555 int mb_l;
2556 int pc, pc1 = 0;
2557 int prev_c = 0;
2558 int prev_c1 = 0;
2559 int u8c;
2560 int u8cc[MAX_MCO];
2561 int nc = 0;
2564 * Do arabic shaping into a temporary buffer. This is very
2565 * inefficient!
2567 if (len * 2 + 2 > buflen)
2569 /* Re-allocate the buffer. We keep it around to avoid a lot of
2570 * alloc()/free() calls. */
2571 vim_free(arshape_buf);
2572 buflen = len * 2 + 2;
2573 arshape_buf = alloc(buflen);
2574 if (arshape_buf == NULL)
2575 return; /* out of memory */
2578 if (utf_iscomposing(utf_ptr2char(ccline.cmdbuff + start)))
2580 /* Prepend a space to draw the leading composing char on. */
2581 arshape_buf[0] = ' ';
2582 newlen = 1;
2585 for (j = start; j < start + len; j += mb_l)
2587 p = ccline.cmdbuff + j;
2588 u8c = utfc_ptr2char_len(p, u8cc, start + len - j);
2589 mb_l = utfc_ptr2len_len(p, start + len - j);
2590 if (ARABIC_CHAR(u8c))
2592 /* Do Arabic shaping. */
2593 if (cmdmsg_rl)
2595 /* displaying from right to left */
2596 pc = prev_c;
2597 pc1 = prev_c1;
2598 prev_c1 = u8cc[0];
2599 if (j + mb_l >= start + len)
2600 nc = NUL;
2601 else
2602 nc = utf_ptr2char(p + mb_l);
2604 else
2606 /* displaying from left to right */
2607 if (j + mb_l >= start + len)
2608 pc = NUL;
2609 else
2611 int pcc[MAX_MCO];
2613 pc = utfc_ptr2char_len(p + mb_l, pcc,
2614 start + len - j - mb_l);
2615 pc1 = pcc[0];
2617 nc = prev_c;
2619 prev_c = u8c;
2621 u8c = arabic_shape(u8c, NULL, &u8cc[0], pc, pc1, nc);
2623 newlen += (*mb_char2bytes)(u8c, arshape_buf + newlen);
2624 if (u8cc[0] != 0)
2626 newlen += (*mb_char2bytes)(u8cc[0], arshape_buf + newlen);
2627 if (u8cc[1] != 0)
2628 newlen += (*mb_char2bytes)(u8cc[1],
2629 arshape_buf + newlen);
2632 else
2634 prev_c = u8c;
2635 mch_memmove(arshape_buf + newlen, p, mb_l);
2636 newlen += mb_l;
2640 msg_outtrans_len(arshape_buf, newlen);
2642 else
2643 #endif
2644 msg_outtrans_len(ccline.cmdbuff + start, len);
2648 * Put a character on the command line. Shifts the following text to the
2649 * right when "shift" is TRUE. Used for CTRL-V, CTRL-K, etc.
2650 * "c" must be printable (fit in one display cell)!
2652 void
2653 putcmdline(c, shift)
2654 int c;
2655 int shift;
2657 if (cmd_silent)
2658 return;
2659 msg_no_more = TRUE;
2660 msg_putchar(c);
2661 if (shift)
2662 draw_cmdline(ccline.cmdpos, ccline.cmdlen - ccline.cmdpos);
2663 msg_no_more = FALSE;
2664 cursorcmd();
2668 * Undo a putcmdline(c, FALSE).
2670 void
2671 unputcmdline()
2673 if (cmd_silent)
2674 return;
2675 msg_no_more = TRUE;
2676 if (ccline.cmdlen == ccline.cmdpos)
2677 msg_putchar(' ');
2678 else
2679 draw_cmdline(ccline.cmdpos, 1);
2680 msg_no_more = FALSE;
2681 cursorcmd();
2685 * Put the given string, of the given length, onto the command line.
2686 * If len is -1, then STRLEN() is used to calculate the length.
2687 * If 'redraw' is TRUE then the new part of the command line, and the remaining
2688 * part will be redrawn, otherwise it will not. If this function is called
2689 * twice in a row, then 'redraw' should be FALSE and redrawcmd() should be
2690 * called afterwards.
2693 put_on_cmdline(str, len, redraw)
2694 char_u *str;
2695 int len;
2696 int redraw;
2698 int retval;
2699 int i;
2700 int m;
2701 int c;
2703 if (len < 0)
2704 len = (int)STRLEN(str);
2706 /* Check if ccline.cmdbuff needs to be longer */
2707 if (ccline.cmdlen + len + 1 >= ccline.cmdbufflen)
2708 retval = realloc_cmdbuff(ccline.cmdlen + len);
2709 else
2710 retval = OK;
2711 if (retval == OK)
2713 if (!ccline.overstrike)
2715 mch_memmove(ccline.cmdbuff + ccline.cmdpos + len,
2716 ccline.cmdbuff + ccline.cmdpos,
2717 (size_t)(ccline.cmdlen - ccline.cmdpos));
2718 ccline.cmdlen += len;
2720 else
2722 #ifdef FEAT_MBYTE
2723 if (has_mbyte)
2725 /* Count nr of characters in the new string. */
2726 m = 0;
2727 for (i = 0; i < len; i += (*mb_ptr2len)(str + i))
2728 ++m;
2729 /* Count nr of bytes in cmdline that are overwritten by these
2730 * characters. */
2731 for (i = ccline.cmdpos; i < ccline.cmdlen && m > 0;
2732 i += (*mb_ptr2len)(ccline.cmdbuff + i))
2733 --m;
2734 if (i < ccline.cmdlen)
2736 mch_memmove(ccline.cmdbuff + ccline.cmdpos + len,
2737 ccline.cmdbuff + i, (size_t)(ccline.cmdlen - i));
2738 ccline.cmdlen += ccline.cmdpos + len - i;
2740 else
2741 ccline.cmdlen = ccline.cmdpos + len;
2743 else
2744 #endif
2745 if (ccline.cmdpos + len > ccline.cmdlen)
2746 ccline.cmdlen = ccline.cmdpos + len;
2748 mch_memmove(ccline.cmdbuff + ccline.cmdpos, str, (size_t)len);
2749 ccline.cmdbuff[ccline.cmdlen] = NUL;
2751 #ifdef FEAT_MBYTE
2752 if (enc_utf8)
2754 /* When the inserted text starts with a composing character,
2755 * backup to the character before it. There could be two of them.
2757 i = 0;
2758 c = utf_ptr2char(ccline.cmdbuff + ccline.cmdpos);
2759 while (ccline.cmdpos > 0 && utf_iscomposing(c))
2761 i = (*mb_head_off)(ccline.cmdbuff,
2762 ccline.cmdbuff + ccline.cmdpos - 1) + 1;
2763 ccline.cmdpos -= i;
2764 len += i;
2765 c = utf_ptr2char(ccline.cmdbuff + ccline.cmdpos);
2767 # ifdef FEAT_ARABIC
2768 if (i == 0 && ccline.cmdpos > 0 && arabic_maycombine(c))
2770 /* Check the previous character for Arabic combining pair. */
2771 i = (*mb_head_off)(ccline.cmdbuff,
2772 ccline.cmdbuff + ccline.cmdpos - 1) + 1;
2773 if (arabic_combine(utf_ptr2char(ccline.cmdbuff
2774 + ccline.cmdpos - i), c))
2776 ccline.cmdpos -= i;
2777 len += i;
2779 else
2780 i = 0;
2782 # endif
2783 if (i != 0)
2785 /* Also backup the cursor position. */
2786 i = ptr2cells(ccline.cmdbuff + ccline.cmdpos);
2787 ccline.cmdspos -= i;
2788 msg_col -= i;
2789 if (msg_col < 0)
2791 msg_col += Columns;
2792 --msg_row;
2796 #endif
2798 if (redraw && !cmd_silent)
2800 msg_no_more = TRUE;
2801 i = cmdline_row;
2802 draw_cmdline(ccline.cmdpos, ccline.cmdlen - ccline.cmdpos);
2803 /* Avoid clearing the rest of the line too often. */
2804 if (cmdline_row != i || ccline.overstrike)
2805 msg_clr_eos();
2806 msg_no_more = FALSE;
2808 #ifdef FEAT_FKMAP
2810 * If we are in Farsi command mode, the character input must be in
2811 * Insert mode. So do not advance the cmdpos.
2813 if (!cmd_fkmap)
2814 #endif
2816 if (KeyTyped)
2818 m = Columns * Rows;
2819 if (m < 0) /* overflow, Columns or Rows at weird value */
2820 m = MAXCOL;
2822 else
2823 m = MAXCOL;
2824 for (i = 0; i < len; ++i)
2826 c = cmdline_charsize(ccline.cmdpos);
2827 #ifdef FEAT_MBYTE
2828 /* count ">" for a double-wide char that doesn't fit. */
2829 if (has_mbyte)
2830 correct_cmdspos(ccline.cmdpos, c);
2831 #endif
2832 /* Stop cursor at the end of the screen */
2833 if (ccline.cmdspos + c >= m)
2834 break;
2835 ccline.cmdspos += c;
2836 #ifdef FEAT_MBYTE
2837 if (has_mbyte)
2839 c = (*mb_ptr2len)(ccline.cmdbuff + ccline.cmdpos) - 1;
2840 if (c > len - i - 1)
2841 c = len - i - 1;
2842 ccline.cmdpos += c;
2843 i += c;
2845 #endif
2846 ++ccline.cmdpos;
2850 if (redraw)
2851 msg_check();
2852 return retval;
2855 static struct cmdline_info prev_ccline;
2856 static int prev_ccline_used = FALSE;
2859 * Save ccline, because obtaining the "=" register may execute "normal :cmd"
2860 * and overwrite it. But get_cmdline_str() may need it, thus make it
2861 * available globally in prev_ccline.
2863 static void
2864 save_cmdline(ccp)
2865 struct cmdline_info *ccp;
2867 if (!prev_ccline_used)
2869 vim_memset(&prev_ccline, 0, sizeof(struct cmdline_info));
2870 prev_ccline_used = TRUE;
2872 *ccp = prev_ccline;
2873 prev_ccline = ccline;
2874 ccline.cmdbuff = NULL;
2875 ccline.cmdprompt = NULL;
2879 * Restore ccline after it has been saved with save_cmdline().
2881 static void
2882 restore_cmdline(ccp)
2883 struct cmdline_info *ccp;
2885 ccline = prev_ccline;
2886 prev_ccline = *ccp;
2889 #if defined(FEAT_EVAL) || defined(PROTO)
2891 * Save the command line into allocated memory. Returns a pointer to be
2892 * passed to restore_cmdline_alloc() later.
2893 * Returns NULL when failed.
2895 char_u *
2896 save_cmdline_alloc()
2898 struct cmdline_info *p;
2900 p = (struct cmdline_info *)alloc((unsigned)sizeof(struct cmdline_info));
2901 if (p != NULL)
2902 save_cmdline(p);
2903 return (char_u *)p;
2907 * Restore the command line from the return value of save_cmdline_alloc().
2909 void
2910 restore_cmdline_alloc(p)
2911 char_u *p;
2913 if (p != NULL)
2915 restore_cmdline((struct cmdline_info *)p);
2916 vim_free(p);
2919 #endif
2922 * paste a yank register into the command line.
2923 * used by CTRL-R command in command-line mode
2924 * insert_reg() can't be used here, because special characters from the
2925 * register contents will be interpreted as commands.
2927 * return FAIL for failure, OK otherwise
2929 static int
2930 cmdline_paste(regname, literally, remcr)
2931 int regname;
2932 int literally; /* Insert text literally instead of "as typed" */
2933 int remcr; /* remove trailing CR */
2935 long i;
2936 char_u *arg;
2937 char_u *p;
2938 int allocated;
2939 struct cmdline_info save_ccline;
2941 /* check for valid regname; also accept special characters for CTRL-R in
2942 * the command line */
2943 if (regname != Ctrl_F && regname != Ctrl_P && regname != Ctrl_W
2944 && regname != Ctrl_A && !valid_yank_reg(regname, FALSE))
2945 return FAIL;
2947 /* A register containing CTRL-R can cause an endless loop. Allow using
2948 * CTRL-C to break the loop. */
2949 line_breakcheck();
2950 if (got_int)
2951 return FAIL;
2953 #ifdef FEAT_CLIPBOARD
2954 regname = may_get_selection(regname);
2955 #endif
2957 /* Need to save and restore ccline. And set "textlock" to avoid nasty
2958 * things like going to another buffer when evaluating an expression. */
2959 save_cmdline(&save_ccline);
2960 ++textlock;
2961 i = get_spec_reg(regname, &arg, &allocated, TRUE);
2962 --textlock;
2963 restore_cmdline(&save_ccline);
2965 if (i)
2967 /* Got the value of a special register in "arg". */
2968 if (arg == NULL)
2969 return FAIL;
2971 /* When 'incsearch' is set and CTRL-R CTRL-W used: skip the duplicate
2972 * part of the word. */
2973 p = arg;
2974 if (p_is && regname == Ctrl_W)
2976 char_u *w;
2977 int len;
2979 /* Locate start of last word in the cmd buffer. */
2980 for (w = ccline.cmdbuff + ccline.cmdlen; w > ccline.cmdbuff; )
2982 #ifdef FEAT_MBYTE
2983 if (has_mbyte)
2985 len = (*mb_head_off)(ccline.cmdbuff, w - 1) + 1;
2986 if (!vim_iswordc(mb_ptr2char(w - len)))
2987 break;
2988 w -= len;
2990 else
2991 #endif
2993 if (!vim_iswordc(w[-1]))
2994 break;
2995 --w;
2998 len = (int)((ccline.cmdbuff + ccline.cmdlen) - w);
2999 if (p_ic ? STRNICMP(w, arg, len) == 0 : STRNCMP(w, arg, len) == 0)
3000 p += len;
3003 cmdline_paste_str(p, literally);
3004 if (allocated)
3005 vim_free(arg);
3006 return OK;
3009 return cmdline_paste_reg(regname, literally, remcr);
3013 * Put a string on the command line.
3014 * When "literally" is TRUE, insert literally.
3015 * When "literally" is FALSE, insert as typed, but don't leave the command
3016 * line.
3018 void
3019 cmdline_paste_str(s, literally)
3020 char_u *s;
3021 int literally;
3023 int c, cv;
3025 if (literally)
3026 put_on_cmdline(s, -1, TRUE);
3027 else
3028 while (*s != NUL)
3030 cv = *s;
3031 if (cv == Ctrl_V && s[1])
3032 ++s;
3033 #ifdef FEAT_MBYTE
3034 if (has_mbyte)
3036 c = mb_ptr2char(s);
3037 s += mb_char2len(c);
3039 else
3040 #endif
3041 c = *s++;
3042 if (cv == Ctrl_V || c == ESC || c == Ctrl_C || c == CAR || c == NL
3043 #ifdef UNIX
3044 || c == intr_char
3045 #endif
3046 || (c == Ctrl_BSL && *s == Ctrl_N))
3047 stuffcharReadbuff(Ctrl_V);
3048 stuffcharReadbuff(c);
3052 #ifdef FEAT_WILDMENU
3054 * Delete characters on the command line, from "from" to the current
3055 * position.
3057 static void
3058 cmdline_del(from)
3059 int from;
3061 mch_memmove(ccline.cmdbuff + from, ccline.cmdbuff + ccline.cmdpos,
3062 (size_t)(ccline.cmdlen - ccline.cmdpos + 1));
3063 ccline.cmdlen -= ccline.cmdpos - from;
3064 ccline.cmdpos = from;
3066 #endif
3069 * this function is called when the screen size changes and with incremental
3070 * search
3072 void
3073 redrawcmdline()
3075 if (cmd_silent)
3076 return;
3077 need_wait_return = FALSE;
3078 compute_cmdrow();
3079 redrawcmd();
3080 cursorcmd();
3083 static void
3084 redrawcmdprompt()
3086 int i;
3088 if (cmd_silent)
3089 return;
3090 if (ccline.cmdfirstc != NUL)
3091 msg_putchar(ccline.cmdfirstc);
3092 if (ccline.cmdprompt != NULL)
3094 msg_puts_attr(ccline.cmdprompt, ccline.cmdattr);
3095 ccline.cmdindent = msg_col + (msg_row - cmdline_row) * Columns;
3096 /* do the reverse of set_cmdspos() */
3097 if (ccline.cmdfirstc != NUL)
3098 --ccline.cmdindent;
3100 else
3101 for (i = ccline.cmdindent; i > 0; --i)
3102 msg_putchar(' ');
3106 * Redraw what is currently on the command line.
3108 void
3109 redrawcmd()
3111 if (cmd_silent)
3112 return;
3114 /* when 'incsearch' is set there may be no command line while redrawing */
3115 if (ccline.cmdbuff == NULL)
3117 windgoto(cmdline_row, 0);
3118 msg_clr_eos();
3119 return;
3122 msg_start();
3123 redrawcmdprompt();
3125 /* Don't use more prompt, truncate the cmdline if it doesn't fit. */
3126 msg_no_more = TRUE;
3127 draw_cmdline(0, ccline.cmdlen);
3128 msg_clr_eos();
3129 msg_no_more = FALSE;
3131 set_cmdspos_cursor();
3134 * An emsg() before may have set msg_scroll. This is used in normal mode,
3135 * in cmdline mode we can reset them now.
3137 msg_scroll = FALSE; /* next message overwrites cmdline */
3139 /* Typing ':' at the more prompt may set skip_redraw. We don't want this
3140 * in cmdline mode */
3141 skip_redraw = FALSE;
3144 void
3145 compute_cmdrow()
3147 if (exmode_active || msg_scrolled != 0)
3148 cmdline_row = Rows - 1;
3149 else
3150 cmdline_row = W_WINROW(lastwin) + lastwin->w_height
3151 + W_STATUS_HEIGHT(lastwin);
3154 static void
3155 cursorcmd()
3157 if (cmd_silent)
3158 return;
3160 #ifdef FEAT_RIGHTLEFT
3161 if (cmdmsg_rl)
3163 msg_row = cmdline_row + (ccline.cmdspos / (int)(Columns - 1));
3164 msg_col = (int)Columns - (ccline.cmdspos % (int)(Columns - 1)) - 1;
3165 if (msg_row <= 0)
3166 msg_row = Rows - 1;
3168 else
3169 #endif
3171 msg_row = cmdline_row + (ccline.cmdspos / (int)Columns);
3172 msg_col = ccline.cmdspos % (int)Columns;
3173 if (msg_row >= Rows)
3174 msg_row = Rows - 1;
3177 windgoto(msg_row, msg_col);
3178 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
3179 redrawcmd_preedit();
3180 #endif
3181 #ifdef MCH_CURSOR_SHAPE
3182 mch_update_cursor();
3183 #endif
3186 void
3187 gotocmdline(clr)
3188 int clr;
3190 msg_start();
3191 #ifdef FEAT_RIGHTLEFT
3192 if (cmdmsg_rl)
3193 msg_col = Columns - 1;
3194 else
3195 #endif
3196 msg_col = 0; /* always start in column 0 */
3197 if (clr) /* clear the bottom line(s) */
3198 msg_clr_eos(); /* will reset clear_cmdline */
3199 windgoto(cmdline_row, 0);
3203 * Check the word in front of the cursor for an abbreviation.
3204 * Called when the non-id character "c" has been entered.
3205 * When an abbreviation is recognized it is removed from the text with
3206 * backspaces and the replacement string is inserted, followed by "c".
3208 static int
3209 ccheck_abbr(c)
3210 int c;
3212 if (p_paste || no_abbr) /* no abbreviations or in paste mode */
3213 return FALSE;
3215 return check_abbr(c, ccline.cmdbuff, ccline.cmdpos, 0);
3219 * Return FAIL if this is not an appropriate context in which to do
3220 * completion of anything, return OK if it is (even if there are no matches).
3221 * For the caller, this means that the character is just passed through like a
3222 * normal character (instead of being expanded). This allows :s/^I^D etc.
3224 static int
3225 nextwild(xp, type, options)
3226 expand_T *xp;
3227 int type;
3228 int options; /* extra options for ExpandOne() */
3230 int i, j;
3231 char_u *p1;
3232 char_u *p2;
3233 int oldlen;
3234 int difflen;
3235 int v;
3237 if (xp->xp_numfiles == -1)
3239 set_expand_context(xp);
3240 cmd_showtail = expand_showtail(xp);
3243 if (xp->xp_context == EXPAND_UNSUCCESSFUL)
3245 beep_flush();
3246 return OK; /* Something illegal on command line */
3248 if (xp->xp_context == EXPAND_NOTHING)
3250 /* Caller can use the character as a normal char instead */
3251 return FAIL;
3254 MSG_PUTS("..."); /* show that we are busy */
3255 out_flush();
3257 i = (int)(xp->xp_pattern - ccline.cmdbuff);
3258 oldlen = ccline.cmdpos - i;
3260 if (type == WILD_NEXT || type == WILD_PREV)
3263 * Get next/previous match for a previous expanded pattern.
3265 p2 = ExpandOne(xp, NULL, NULL, 0, type);
3267 else
3270 * Translate string into pattern and expand it.
3272 if ((p1 = addstar(&ccline.cmdbuff[i], oldlen, xp->xp_context)) == NULL)
3273 p2 = NULL;
3274 else
3276 p2 = ExpandOne(xp, p1, vim_strnsave(&ccline.cmdbuff[i], oldlen),
3277 WILD_HOME_REPLACE|WILD_ADD_SLASH|WILD_SILENT|WILD_ESCAPE
3278 |options, type);
3279 vim_free(p1);
3280 /* longest match: make sure it is not shorter (happens with :help */
3281 if (p2 != NULL && type == WILD_LONGEST)
3283 for (j = 0; j < oldlen; ++j)
3284 if (ccline.cmdbuff[i + j] == '*'
3285 || ccline.cmdbuff[i + j] == '?')
3286 break;
3287 if ((int)STRLEN(p2) < j)
3289 vim_free(p2);
3290 p2 = NULL;
3296 if (p2 != NULL && !got_int)
3298 difflen = (int)STRLEN(p2) - oldlen;
3299 if (ccline.cmdlen + difflen > ccline.cmdbufflen - 4)
3301 v = realloc_cmdbuff(ccline.cmdlen + difflen);
3302 xp->xp_pattern = ccline.cmdbuff + i;
3304 else
3305 v = OK;
3306 if (v == OK)
3308 mch_memmove(&ccline.cmdbuff[ccline.cmdpos + difflen],
3309 &ccline.cmdbuff[ccline.cmdpos],
3310 (size_t)(ccline.cmdlen - ccline.cmdpos + 1));
3311 mch_memmove(&ccline.cmdbuff[i], p2, STRLEN(p2));
3312 ccline.cmdlen += difflen;
3313 ccline.cmdpos += difflen;
3316 vim_free(p2);
3318 redrawcmd();
3319 cursorcmd();
3321 /* When expanding a ":map" command and no matches are found, assume that
3322 * the key is supposed to be inserted literally */
3323 if (xp->xp_context == EXPAND_MAPPINGS && p2 == NULL)
3324 return FAIL;
3326 if (xp->xp_numfiles <= 0 && p2 == NULL)
3327 beep_flush();
3328 else if (xp->xp_numfiles == 1)
3329 /* free expanded pattern */
3330 (void)ExpandOne(xp, NULL, NULL, 0, WILD_FREE);
3332 return OK;
3336 * Do wildcard expansion on the string 'str'.
3337 * Chars that should not be expanded must be preceded with a backslash.
3338 * Return a pointer to alloced memory containing the new string.
3339 * Return NULL for failure.
3341 * "orig" is the originally expanded string, copied to allocated memory. It
3342 * should either be kept in orig_save or freed. When "mode" is WILD_NEXT or
3343 * WILD_PREV "orig" should be NULL.
3345 * Results are cached in xp->xp_files and xp->xp_numfiles, except when "mode"
3346 * is WILD_EXPAND_FREE or WILD_ALL.
3348 * mode = WILD_FREE: just free previously expanded matches
3349 * mode = WILD_EXPAND_FREE: normal expansion, do not keep matches
3350 * mode = WILD_EXPAND_KEEP: normal expansion, keep matches
3351 * mode = WILD_NEXT: use next match in multiple match, wrap to first
3352 * mode = WILD_PREV: use previous match in multiple match, wrap to first
3353 * mode = WILD_ALL: return all matches concatenated
3354 * mode = WILD_LONGEST: return longest matched part
3356 * options = WILD_LIST_NOTFOUND: list entries without a match
3357 * options = WILD_HOME_REPLACE: do home_replace() for buffer names
3358 * options = WILD_USE_NL: Use '\n' for WILD_ALL
3359 * options = WILD_NO_BEEP: Don't beep for multiple matches
3360 * options = WILD_ADD_SLASH: add a slash after directory names
3361 * options = WILD_KEEP_ALL: don't remove 'wildignore' entries
3362 * options = WILD_SILENT: don't print warning messages
3363 * options = WILD_ESCAPE: put backslash before special chars
3365 * The variables xp->xp_context and xp->xp_backslash must have been set!
3367 char_u *
3368 ExpandOne(xp, str, orig, options, mode)
3369 expand_T *xp;
3370 char_u *str;
3371 char_u *orig; /* allocated copy of original of expanded string */
3372 int options;
3373 int mode;
3375 char_u *ss = NULL;
3376 static int findex;
3377 static char_u *orig_save = NULL; /* kept value of orig */
3378 int orig_saved = FALSE;
3379 int i;
3380 long_u len;
3381 int non_suf_match; /* number without matching suffix */
3384 * first handle the case of using an old match
3386 if (mode == WILD_NEXT || mode == WILD_PREV)
3388 if (xp->xp_numfiles > 0)
3390 if (mode == WILD_PREV)
3392 if (findex == -1)
3393 findex = xp->xp_numfiles;
3394 --findex;
3396 else /* mode == WILD_NEXT */
3397 ++findex;
3400 * When wrapping around, return the original string, set findex to
3401 * -1.
3403 if (findex < 0)
3405 if (orig_save == NULL)
3406 findex = xp->xp_numfiles - 1;
3407 else
3408 findex = -1;
3410 if (findex >= xp->xp_numfiles)
3412 if (orig_save == NULL)
3413 findex = 0;
3414 else
3415 findex = -1;
3417 #ifdef FEAT_WILDMENU
3418 if (p_wmnu)
3419 win_redr_status_matches(xp, xp->xp_numfiles, xp->xp_files,
3420 findex, cmd_showtail);
3421 #endif
3422 if (findex == -1)
3423 return vim_strsave(orig_save);
3424 return vim_strsave(xp->xp_files[findex]);
3426 else
3427 return NULL;
3430 /* free old names */
3431 if (xp->xp_numfiles != -1 && mode != WILD_ALL && mode != WILD_LONGEST)
3433 FreeWild(xp->xp_numfiles, xp->xp_files);
3434 xp->xp_numfiles = -1;
3435 vim_free(orig_save);
3436 orig_save = NULL;
3438 findex = 0;
3440 if (mode == WILD_FREE) /* only release file name */
3441 return NULL;
3443 if (xp->xp_numfiles == -1)
3445 vim_free(orig_save);
3446 orig_save = orig;
3447 orig_saved = TRUE;
3450 * Do the expansion.
3452 if (ExpandFromContext(xp, str, &xp->xp_numfiles, &xp->xp_files,
3453 options) == FAIL)
3455 #ifdef FNAME_ILLEGAL
3456 /* Illegal file name has been silently skipped. But when there
3457 * are wildcards, the real problem is that there was no match,
3458 * causing the pattern to be added, which has illegal characters.
3460 if (!(options & WILD_SILENT) && (options & WILD_LIST_NOTFOUND))
3461 EMSG2(_(e_nomatch2), str);
3462 #endif
3464 else if (xp->xp_numfiles == 0)
3466 if (!(options & WILD_SILENT))
3467 EMSG2(_(e_nomatch2), str);
3469 else
3471 /* Escape the matches for use on the command line. */
3472 ExpandEscape(xp, str, xp->xp_numfiles, xp->xp_files, options);
3475 * Check for matching suffixes in file names.
3477 if (mode != WILD_ALL && mode != WILD_LONGEST)
3479 if (xp->xp_numfiles)
3480 non_suf_match = xp->xp_numfiles;
3481 else
3482 non_suf_match = 1;
3483 if ((xp->xp_context == EXPAND_FILES
3484 || xp->xp_context == EXPAND_DIRECTORIES)
3485 && xp->xp_numfiles > 1)
3488 * More than one match; check suffix.
3489 * The files will have been sorted on matching suffix in
3490 * expand_wildcards, only need to check the first two.
3492 non_suf_match = 0;
3493 for (i = 0; i < 2; ++i)
3494 if (match_suffix(xp->xp_files[i]))
3495 ++non_suf_match;
3497 if (non_suf_match != 1)
3499 /* Can we ever get here unless it's while expanding
3500 * interactively? If not, we can get rid of this all
3501 * together. Don't really want to wait for this message
3502 * (and possibly have to hit return to continue!).
3504 if (!(options & WILD_SILENT))
3505 EMSG(_(e_toomany));
3506 else if (!(options & WILD_NO_BEEP))
3507 beep_flush();
3509 if (!(non_suf_match != 1 && mode == WILD_EXPAND_FREE))
3510 ss = vim_strsave(xp->xp_files[0]);
3515 /* Find longest common part */
3516 if (mode == WILD_LONGEST && xp->xp_numfiles > 0)
3518 for (len = 0; xp->xp_files[0][len]; ++len)
3520 for (i = 0; i < xp->xp_numfiles; ++i)
3522 #ifdef CASE_INSENSITIVE_FILENAME
3523 if (xp->xp_context == EXPAND_DIRECTORIES
3524 || xp->xp_context == EXPAND_FILES
3525 || xp->xp_context == EXPAND_SHELLCMD
3526 || xp->xp_context == EXPAND_BUFFERS)
3528 if (TOLOWER_LOC(xp->xp_files[i][len]) !=
3529 TOLOWER_LOC(xp->xp_files[0][len]))
3530 break;
3532 else
3533 #endif
3534 if (xp->xp_files[i][len] != xp->xp_files[0][len])
3535 break;
3537 if (i < xp->xp_numfiles)
3539 if (!(options & WILD_NO_BEEP))
3540 vim_beep();
3541 break;
3544 ss = alloc((unsigned)len + 1);
3545 if (ss)
3546 vim_strncpy(ss, xp->xp_files[0], (size_t)len);
3547 findex = -1; /* next p_wc gets first one */
3550 /* Concatenate all matching names */
3551 if (mode == WILD_ALL && xp->xp_numfiles > 0)
3553 len = 0;
3554 for (i = 0; i < xp->xp_numfiles; ++i)
3555 len += (long_u)STRLEN(xp->xp_files[i]) + 1;
3556 ss = lalloc(len, TRUE);
3557 if (ss != NULL)
3559 *ss = NUL;
3560 for (i = 0; i < xp->xp_numfiles; ++i)
3562 STRCAT(ss, xp->xp_files[i]);
3563 if (i != xp->xp_numfiles - 1)
3564 STRCAT(ss, (options & WILD_USE_NL) ? "\n" : " ");
3569 if (mode == WILD_EXPAND_FREE || mode == WILD_ALL)
3570 ExpandCleanup(xp);
3572 /* Free "orig" if it wasn't stored in "orig_save". */
3573 if (!orig_saved)
3574 vim_free(orig);
3576 return ss;
3580 * Prepare an expand structure for use.
3582 void
3583 ExpandInit(xp)
3584 expand_T *xp;
3586 xp->xp_backslash = XP_BS_NONE;
3587 #ifndef BACKSLASH_IN_FILENAME
3588 xp->xp_shell = FALSE;
3589 #endif
3590 xp->xp_numfiles = -1;
3591 xp->xp_files = NULL;
3592 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
3593 xp->xp_arg = NULL;
3594 #endif
3598 * Cleanup an expand structure after use.
3600 void
3601 ExpandCleanup(xp)
3602 expand_T *xp;
3604 if (xp->xp_numfiles >= 0)
3606 FreeWild(xp->xp_numfiles, xp->xp_files);
3607 xp->xp_numfiles = -1;
3611 void
3612 ExpandEscape(xp, str, numfiles, files, options)
3613 expand_T *xp;
3614 char_u *str;
3615 int numfiles;
3616 char_u **files;
3617 int options;
3619 int i;
3620 char_u *p;
3623 * May change home directory back to "~"
3625 if (options & WILD_HOME_REPLACE)
3626 tilde_replace(str, numfiles, files);
3628 if (options & WILD_ESCAPE)
3630 if (xp->xp_context == EXPAND_FILES
3631 || xp->xp_context == EXPAND_SHELLCMD
3632 || xp->xp_context == EXPAND_BUFFERS
3633 || xp->xp_context == EXPAND_DIRECTORIES)
3636 * Insert a backslash into a file name before a space, \, %, #
3637 * and wildmatch characters, except '~'.
3639 for (i = 0; i < numfiles; ++i)
3641 /* for ":set path=" we need to escape spaces twice */
3642 if (xp->xp_backslash == XP_BS_THREE)
3644 p = vim_strsave_escaped(files[i], (char_u *)" ");
3645 if (p != NULL)
3647 vim_free(files[i]);
3648 files[i] = p;
3649 #if defined(BACKSLASH_IN_FILENAME)
3650 p = vim_strsave_escaped(files[i], (char_u *)" ");
3651 if (p != NULL)
3653 vim_free(files[i]);
3654 files[i] = p;
3656 #endif
3659 #ifdef BACKSLASH_IN_FILENAME
3661 char_u buf[20];
3662 int j = 0;
3664 /* Don't escape '[' and '{' if they are in 'isfname'. */
3665 for (p = PATH_ESC_CHARS; *p != NUL; ++p)
3666 if ((*p != '[' && *p != '{') || !vim_isfilec(*p))
3667 buf[j++] = *p;
3668 buf[j] = NUL;
3669 p = vim_strsave_escaped(files[i], buf);
3671 #else
3672 p = vim_strsave_escaped(files[i],
3673 xp->xp_shell ? SHELL_ESC_CHARS : PATH_ESC_CHARS);
3674 #endif
3675 if (p != NULL)
3677 vim_free(files[i]);
3678 files[i] = p;
3681 /* If 'str' starts with "\~", replace "~" at start of
3682 * files[i] with "\~". */
3683 if (str[0] == '\\' && str[1] == '~' && files[i][0] == '~')
3684 escape_fname(&files[i]);
3686 xp->xp_backslash = XP_BS_NONE;
3688 /* If the first file starts with a '+' escape it. Otherwise it
3689 * could be seen as "+cmd". */
3690 if (*files[0] == '+')
3691 escape_fname(&files[0]);
3693 else if (xp->xp_context == EXPAND_TAGS)
3696 * Insert a backslash before characters in a tag name that
3697 * would terminate the ":tag" command.
3699 for (i = 0; i < numfiles; ++i)
3701 p = vim_strsave_escaped(files[i], (char_u *)"\\|\"");
3702 if (p != NULL)
3704 vim_free(files[i]);
3705 files[i] = p;
3713 * Put a backslash before the file name in "pp", which is in allocated memory.
3715 static void
3716 escape_fname(pp)
3717 char_u **pp;
3719 char_u *p;
3721 p = alloc((unsigned)(STRLEN(*pp) + 2));
3722 if (p != NULL)
3724 p[0] = '\\';
3725 STRCPY(p + 1, *pp);
3726 vim_free(*pp);
3727 *pp = p;
3732 * For each file name in files[num_files]:
3733 * If 'orig_pat' starts with "~/", replace the home directory with "~".
3735 void
3736 tilde_replace(orig_pat, num_files, files)
3737 char_u *orig_pat;
3738 int num_files;
3739 char_u **files;
3741 int i;
3742 char_u *p;
3744 if (orig_pat[0] == '~' && vim_ispathsep(orig_pat[1]))
3746 for (i = 0; i < num_files; ++i)
3748 p = home_replace_save(NULL, files[i]);
3749 if (p != NULL)
3751 vim_free(files[i]);
3752 files[i] = p;
3759 * Show all matches for completion on the command line.
3760 * Returns EXPAND_NOTHING when the character that triggered expansion should
3761 * be inserted like a normal character.
3763 /*ARGSUSED*/
3764 static int
3765 showmatches(xp, wildmenu)
3766 expand_T *xp;
3767 int wildmenu;
3769 #define L_SHOWFILE(m) (showtail ? sm_gettail(files_found[m]) : files_found[m])
3770 int num_files;
3771 char_u **files_found;
3772 int i, j, k;
3773 int maxlen;
3774 int lines;
3775 int columns;
3776 char_u *p;
3777 int lastlen;
3778 int attr;
3779 int showtail;
3781 if (xp->xp_numfiles == -1)
3783 set_expand_context(xp);
3784 i = expand_cmdline(xp, ccline.cmdbuff, ccline.cmdpos,
3785 &num_files, &files_found);
3786 showtail = expand_showtail(xp);
3787 if (i != EXPAND_OK)
3788 return i;
3791 else
3793 num_files = xp->xp_numfiles;
3794 files_found = xp->xp_files;
3795 showtail = cmd_showtail;
3798 #ifdef FEAT_WILDMENU
3799 if (!wildmenu)
3801 #endif
3802 msg_didany = FALSE; /* lines_left will be set */
3803 msg_start(); /* prepare for paging */
3804 msg_putchar('\n');
3805 out_flush();
3806 cmdline_row = msg_row;
3807 msg_didany = FALSE; /* lines_left will be set again */
3808 msg_start(); /* prepare for paging */
3809 #ifdef FEAT_WILDMENU
3811 #endif
3813 if (got_int)
3814 got_int = FALSE; /* only int. the completion, not the cmd line */
3815 #ifdef FEAT_WILDMENU
3816 else if (wildmenu)
3817 win_redr_status_matches(xp, num_files, files_found, 0, showtail);
3818 #endif
3819 else
3821 /* find the length of the longest file name */
3822 maxlen = 0;
3823 for (i = 0; i < num_files; ++i)
3825 if (!showtail && (xp->xp_context == EXPAND_FILES
3826 || xp->xp_context == EXPAND_SHELLCMD
3827 || xp->xp_context == EXPAND_BUFFERS))
3829 home_replace(NULL, files_found[i], NameBuff, MAXPATHL, TRUE);
3830 j = vim_strsize(NameBuff);
3832 else
3833 j = vim_strsize(L_SHOWFILE(i));
3834 if (j > maxlen)
3835 maxlen = j;
3838 if (xp->xp_context == EXPAND_TAGS_LISTFILES)
3839 lines = num_files;
3840 else
3842 /* compute the number of columns and lines for the listing */
3843 maxlen += 2; /* two spaces between file names */
3844 columns = ((int)Columns + 2) / maxlen;
3845 if (columns < 1)
3846 columns = 1;
3847 lines = (num_files + columns - 1) / columns;
3850 attr = hl_attr(HLF_D); /* find out highlighting for directories */
3852 if (xp->xp_context == EXPAND_TAGS_LISTFILES)
3854 MSG_PUTS_ATTR(_("tagname"), hl_attr(HLF_T));
3855 msg_clr_eos();
3856 msg_advance(maxlen - 3);
3857 MSG_PUTS_ATTR(_(" kind file\n"), hl_attr(HLF_T));
3860 /* list the files line by line */
3861 for (i = 0; i < lines; ++i)
3863 lastlen = 999;
3864 for (k = i; k < num_files; k += lines)
3866 if (xp->xp_context == EXPAND_TAGS_LISTFILES)
3868 msg_outtrans_attr(files_found[k], hl_attr(HLF_D));
3869 p = files_found[k] + STRLEN(files_found[k]) + 1;
3870 msg_advance(maxlen + 1);
3871 msg_puts(p);
3872 msg_advance(maxlen + 3);
3873 msg_puts_long_attr(p + 2, hl_attr(HLF_D));
3874 break;
3876 for (j = maxlen - lastlen; --j >= 0; )
3877 msg_putchar(' ');
3878 if (xp->xp_context == EXPAND_FILES
3879 || xp->xp_context == EXPAND_SHELLCMD
3880 || xp->xp_context == EXPAND_BUFFERS)
3882 /* highlight directories */
3883 j = (mch_isdir(files_found[k]));
3884 if (showtail)
3885 p = L_SHOWFILE(k);
3886 else
3888 home_replace(NULL, files_found[k], NameBuff, MAXPATHL,
3889 TRUE);
3890 p = NameBuff;
3893 else
3895 j = FALSE;
3896 p = L_SHOWFILE(k);
3898 lastlen = msg_outtrans_attr(p, j ? attr : 0);
3900 if (msg_col > 0) /* when not wrapped around */
3902 msg_clr_eos();
3903 msg_putchar('\n');
3905 out_flush(); /* show one line at a time */
3906 if (got_int)
3908 got_int = FALSE;
3909 break;
3914 * we redraw the command below the lines that we have just listed
3915 * This is a bit tricky, but it saves a lot of screen updating.
3917 cmdline_row = msg_row; /* will put it back later */
3920 if (xp->xp_numfiles == -1)
3921 FreeWild(num_files, files_found);
3923 return EXPAND_OK;
3927 * Private gettail for showmatches() (and win_redr_status_matches()):
3928 * Find tail of file name path, but ignore trailing "/".
3930 char_u *
3931 sm_gettail(s)
3932 char_u *s;
3934 char_u *p;
3935 char_u *t = s;
3936 int had_sep = FALSE;
3938 for (p = s; *p != NUL; )
3940 if (vim_ispathsep(*p)
3941 #ifdef BACKSLASH_IN_FILENAME
3942 && !rem_backslash(p)
3943 #endif
3945 had_sep = TRUE;
3946 else if (had_sep)
3948 t = p;
3949 had_sep = FALSE;
3951 mb_ptr_adv(p);
3953 return t;
3957 * Return TRUE if we only need to show the tail of completion matches.
3958 * When not completing file names or there is a wildcard in the path FALSE is
3959 * returned.
3961 static int
3962 expand_showtail(xp)
3963 expand_T *xp;
3965 char_u *s;
3966 char_u *end;
3968 /* When not completing file names a "/" may mean something different. */
3969 if (xp->xp_context != EXPAND_FILES
3970 && xp->xp_context != EXPAND_SHELLCMD
3971 && xp->xp_context != EXPAND_DIRECTORIES)
3972 return FALSE;
3974 end = gettail(xp->xp_pattern);
3975 if (end == xp->xp_pattern) /* there is no path separator */
3976 return FALSE;
3978 for (s = xp->xp_pattern; s < end; s++)
3980 /* Skip escaped wildcards. Only when the backslash is not a path
3981 * separator, on DOS the '*' "path\*\file" must not be skipped. */
3982 if (rem_backslash(s))
3983 ++s;
3984 else if (vim_strchr((char_u *)"*?[", *s) != NULL)
3985 return FALSE;
3987 return TRUE;
3991 * Prepare a string for expansion.
3992 * When expanding file names: The string will be used with expand_wildcards().
3993 * Copy the file name into allocated memory and add a '*' at the end.
3994 * When expanding other names: The string will be used with regcomp(). Copy
3995 * the name into allocated memory and prepend "^".
3997 char_u *
3998 addstar(fname, len, context)
3999 char_u *fname;
4000 int len;
4001 int context; /* EXPAND_FILES etc. */
4003 char_u *retval;
4004 int i, j;
4005 int new_len;
4006 char_u *tail;
4008 if (context != EXPAND_FILES
4009 && context != EXPAND_SHELLCMD
4010 && context != EXPAND_DIRECTORIES)
4013 * Matching will be done internally (on something other than files).
4014 * So we convert the file-matching-type wildcards into our kind for
4015 * use with vim_regcomp(). First work out how long it will be:
4018 /* For help tags the translation is done in find_help_tags().
4019 * For a tag pattern starting with "/" no translation is needed. */
4020 if (context == EXPAND_HELP
4021 || context == EXPAND_COLORS
4022 || context == EXPAND_COMPILER
4023 || (context == EXPAND_TAGS && fname[0] == '/'))
4024 retval = vim_strnsave(fname, len);
4025 else
4027 new_len = len + 2; /* +2 for '^' at start, NUL at end */
4028 for (i = 0; i < len; i++)
4030 if (fname[i] == '*' || fname[i] == '~')
4031 new_len++; /* '*' needs to be replaced by ".*"
4032 '~' needs to be replaced by "\~" */
4034 /* Buffer names are like file names. "." should be literal */
4035 if (context == EXPAND_BUFFERS && fname[i] == '.')
4036 new_len++; /* "." becomes "\." */
4038 /* Custom expansion takes care of special things, match
4039 * backslashes literally (perhaps also for other types?) */
4040 if ((context == EXPAND_USER_DEFINED
4041 || context == EXPAND_USER_LIST) && fname[i] == '\\')
4042 new_len++; /* '\' becomes "\\" */
4044 retval = alloc(new_len);
4045 if (retval != NULL)
4047 retval[0] = '^';
4048 j = 1;
4049 for (i = 0; i < len; i++, j++)
4051 /* Skip backslash. But why? At least keep it for custom
4052 * expansion. */
4053 if (context != EXPAND_USER_DEFINED
4054 && context != EXPAND_USER_LIST
4055 && fname[i] == '\\'
4056 && ++i == len)
4057 break;
4059 switch (fname[i])
4061 case '*': retval[j++] = '.';
4062 break;
4063 case '~': retval[j++] = '\\';
4064 break;
4065 case '?': retval[j] = '.';
4066 continue;
4067 case '.': if (context == EXPAND_BUFFERS)
4068 retval[j++] = '\\';
4069 break;
4070 case '\\': if (context == EXPAND_USER_DEFINED
4071 || context == EXPAND_USER_LIST)
4072 retval[j++] = '\\';
4073 break;
4075 retval[j] = fname[i];
4077 retval[j] = NUL;
4081 else
4083 retval = alloc(len + 4);
4084 if (retval != NULL)
4086 vim_strncpy(retval, fname, len);
4089 * Don't add a star to *, ~, ~user, $var or `cmd`.
4090 * * would become **, which walks the whole tree.
4091 * ~ would be at the start of the file name, but not the tail.
4092 * $ could be anywhere in the tail.
4093 * ` could be anywhere in the file name.
4094 * When the name ends in '$' don't add a star, remove the '$'.
4096 tail = gettail(retval);
4097 if ((*retval != '~' || tail != retval)
4098 && (len == 0 || retval[len - 1] != '*')
4099 && vim_strchr(tail, '$') == NULL
4100 && vim_strchr(retval, '`') == NULL)
4101 retval[len++] = '*';
4102 else if (len > 0 && retval[len - 1] == '$')
4103 --len;
4104 retval[len] = NUL;
4107 return retval;
4111 * Must parse the command line so far to work out what context we are in.
4112 * Completion can then be done based on that context.
4113 * This routine sets the variables:
4114 * xp->xp_pattern The start of the pattern to be expanded within
4115 * the command line (ends at the cursor).
4116 * xp->xp_context The type of thing to expand. Will be one of:
4118 * EXPAND_UNSUCCESSFUL Used sometimes when there is something illegal on
4119 * the command line, like an unknown command. Caller
4120 * should beep.
4121 * EXPAND_NOTHING Unrecognised context for completion, use char like
4122 * a normal char, rather than for completion. eg
4123 * :s/^I/
4124 * EXPAND_COMMANDS Cursor is still touching the command, so complete
4125 * it.
4126 * EXPAND_BUFFERS Complete file names for :buf and :sbuf commands.
4127 * EXPAND_FILES After command with XFILE set, or after setting
4128 * with P_EXPAND set. eg :e ^I, :w>>^I
4129 * EXPAND_DIRECTORIES In some cases this is used instead of the latter
4130 * when we know only directories are of interest. eg
4131 * :set dir=^I
4132 * EXPAND_SHELLCMD After ":!cmd", ":r !cmd" or ":w !cmd".
4133 * EXPAND_SETTINGS Complete variable names. eg :set d^I
4134 * EXPAND_BOOL_SETTINGS Complete boolean variables only, eg :set no^I
4135 * EXPAND_TAGS Complete tags from the files in p_tags. eg :ta a^I
4136 * EXPAND_TAGS_LISTFILES As above, but list filenames on ^D, after :tselect
4137 * EXPAND_HELP Complete tags from the file 'helpfile'/tags
4138 * EXPAND_EVENTS Complete event names
4139 * EXPAND_SYNTAX Complete :syntax command arguments
4140 * EXPAND_HIGHLIGHT Complete highlight (syntax) group names
4141 * EXPAND_AUGROUP Complete autocommand group names
4142 * EXPAND_USER_VARS Complete user defined variable names, eg :unlet a^I
4143 * EXPAND_MAPPINGS Complete mapping and abbreviation names,
4144 * eg :unmap a^I , :cunab x^I
4145 * EXPAND_FUNCTIONS Complete internal or user defined function names,
4146 * eg :call sub^I
4147 * EXPAND_USER_FUNC Complete user defined function names, eg :delf F^I
4148 * EXPAND_EXPRESSION Complete internal or user defined function/variable
4149 * names in expressions, eg :while s^I
4150 * EXPAND_ENV_VARS Complete environment variable names
4152 static void
4153 set_expand_context(xp)
4154 expand_T *xp;
4156 /* only expansion for ':', '>' and '=' command-lines */
4157 if (ccline.cmdfirstc != ':'
4158 #ifdef FEAT_EVAL
4159 && ccline.cmdfirstc != '>' && ccline.cmdfirstc != '='
4160 && !ccline.input_fn
4161 #endif
4164 xp->xp_context = EXPAND_NOTHING;
4165 return;
4167 set_cmd_context(xp, ccline.cmdbuff, ccline.cmdlen, ccline.cmdpos);
4170 void
4171 set_cmd_context(xp, str, len, col)
4172 expand_T *xp;
4173 char_u *str; /* start of command line */
4174 int len; /* length of command line (excl. NUL) */
4175 int col; /* position of cursor */
4177 int old_char = NUL;
4178 char_u *nextcomm;
4181 * Avoid a UMR warning from Purify, only save the character if it has been
4182 * written before.
4184 if (col < len)
4185 old_char = str[col];
4186 str[col] = NUL;
4187 nextcomm = str;
4189 #ifdef FEAT_EVAL
4190 if (ccline.cmdfirstc == '=')
4192 # ifdef FEAT_CMDL_COMPL
4193 /* pass CMD_SIZE because there is no real command */
4194 set_context_for_expression(xp, str, CMD_SIZE);
4195 # endif
4197 else if (ccline.input_fn)
4199 xp->xp_context = ccline.xp_context;
4200 xp->xp_pattern = ccline.cmdbuff;
4201 # if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
4202 xp->xp_arg = ccline.xp_arg;
4203 # endif
4205 else
4206 #endif
4207 while (nextcomm != NULL)
4208 nextcomm = set_one_cmd_context(xp, nextcomm);
4210 str[col] = old_char;
4214 * Expand the command line "str" from context "xp".
4215 * "xp" must have been set by set_cmd_context().
4216 * xp->xp_pattern points into "str", to where the text that is to be expanded
4217 * starts.
4218 * Returns EXPAND_UNSUCCESSFUL when there is something illegal before the
4219 * cursor.
4220 * Returns EXPAND_NOTHING when there is nothing to expand, might insert the
4221 * key that triggered expansion literally.
4222 * Returns EXPAND_OK otherwise.
4225 expand_cmdline(xp, str, col, matchcount, matches)
4226 expand_T *xp;
4227 char_u *str; /* start of command line */
4228 int col; /* position of cursor */
4229 int *matchcount; /* return: nr of matches */
4230 char_u ***matches; /* return: array of pointers to matches */
4232 char_u *file_str = NULL;
4234 if (xp->xp_context == EXPAND_UNSUCCESSFUL)
4236 beep_flush();
4237 return EXPAND_UNSUCCESSFUL; /* Something illegal on command line */
4239 if (xp->xp_context == EXPAND_NOTHING)
4241 /* Caller can use the character as a normal char instead */
4242 return EXPAND_NOTHING;
4245 /* add star to file name, or convert to regexp if not exp. files. */
4246 file_str = addstar(xp->xp_pattern,
4247 (int)(str + col - xp->xp_pattern), xp->xp_context);
4248 if (file_str == NULL)
4249 return EXPAND_UNSUCCESSFUL;
4251 /* find all files that match the description */
4252 if (ExpandFromContext(xp, file_str, matchcount, matches,
4253 WILD_ADD_SLASH|WILD_SILENT) == FAIL)
4255 *matchcount = 0;
4256 *matches = NULL;
4258 vim_free(file_str);
4260 return EXPAND_OK;
4263 #ifdef FEAT_MULTI_LANG
4265 * Cleanup matches for help tags: remove "@en" if "en" is the only language.
4267 static void cleanup_help_tags __ARGS((int num_file, char_u **file));
4269 static void
4270 cleanup_help_tags(num_file, file)
4271 int num_file;
4272 char_u **file;
4274 int i, j;
4275 int len;
4277 for (i = 0; i < num_file; ++i)
4279 len = (int)STRLEN(file[i]) - 3;
4280 if (len > 0 && STRCMP(file[i] + len, "@en") == 0)
4282 /* Sorting on priority means the same item in another language may
4283 * be anywhere. Search all items for a match up to the "@en". */
4284 for (j = 0; j < num_file; ++j)
4285 if (j != i
4286 && (int)STRLEN(file[j]) == len + 3
4287 && STRNCMP(file[i], file[j], len + 1) == 0)
4288 break;
4289 if (j == num_file)
4290 file[i][len] = NUL;
4294 #endif
4297 * Do the expansion based on xp->xp_context and "pat".
4299 static int
4300 ExpandFromContext(xp, pat, num_file, file, options)
4301 expand_T *xp;
4302 char_u *pat;
4303 int *num_file;
4304 char_u ***file;
4305 int options;
4307 #ifdef FEAT_CMDL_COMPL
4308 regmatch_T regmatch;
4309 #endif
4310 int ret;
4311 int flags;
4313 flags = EW_DIR; /* include directories */
4314 if (options & WILD_LIST_NOTFOUND)
4315 flags |= EW_NOTFOUND;
4316 if (options & WILD_ADD_SLASH)
4317 flags |= EW_ADDSLASH;
4318 if (options & WILD_KEEP_ALL)
4319 flags |= EW_KEEPALL;
4320 if (options & WILD_SILENT)
4321 flags |= EW_SILENT;
4323 if (xp->xp_context == EXPAND_FILES || xp->xp_context == EXPAND_DIRECTORIES)
4326 * Expand file or directory names.
4328 int free_pat = FALSE;
4329 int i;
4331 /* for ":set path=" and ":set tags=" halve backslashes for escaped
4332 * space */
4333 if (xp->xp_backslash != XP_BS_NONE)
4335 free_pat = TRUE;
4336 pat = vim_strsave(pat);
4337 for (i = 0; pat[i]; ++i)
4338 if (pat[i] == '\\')
4340 if (xp->xp_backslash == XP_BS_THREE
4341 && pat[i + 1] == '\\'
4342 && pat[i + 2] == '\\'
4343 && pat[i + 3] == ' ')
4344 mch_memmove(pat + i, pat + i + 3,
4345 STRLEN(pat + i + 3) + 1);
4346 if (xp->xp_backslash == XP_BS_ONE
4347 && pat[i + 1] == ' ')
4348 mch_memmove(pat + i, pat + i + 1, STRLEN(pat + i));
4352 if (xp->xp_context == EXPAND_FILES)
4353 flags |= EW_FILE;
4354 else
4355 flags = (flags | EW_DIR) & ~EW_FILE;
4356 ret = expand_wildcards(1, &pat, num_file, file, flags);
4357 if (free_pat)
4358 vim_free(pat);
4359 return ret;
4362 *file = (char_u **)"";
4363 *num_file = 0;
4364 if (xp->xp_context == EXPAND_HELP)
4366 if (find_help_tags(pat, num_file, file, FALSE) == OK)
4368 #ifdef FEAT_MULTI_LANG
4369 cleanup_help_tags(*num_file, *file);
4370 #endif
4371 return OK;
4373 return FAIL;
4376 #ifndef FEAT_CMDL_COMPL
4377 return FAIL;
4378 #else
4379 if (xp->xp_context == EXPAND_SHELLCMD)
4380 return expand_shellcmd(pat, num_file, file, flags);
4381 if (xp->xp_context == EXPAND_OLD_SETTING)
4382 return ExpandOldSetting(num_file, file);
4383 if (xp->xp_context == EXPAND_BUFFERS)
4384 return ExpandBufnames(pat, num_file, file, options);
4385 if (xp->xp_context == EXPAND_TAGS
4386 || xp->xp_context == EXPAND_TAGS_LISTFILES)
4387 return expand_tags(xp->xp_context == EXPAND_TAGS, pat, num_file, file);
4388 if (xp->xp_context == EXPAND_COLORS)
4389 return ExpandRTDir(pat, num_file, file, "colors");
4390 if (xp->xp_context == EXPAND_COMPILER)
4391 return ExpandRTDir(pat, num_file, file, "compiler");
4392 # if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL)
4393 if (xp->xp_context == EXPAND_USER_LIST)
4394 return ExpandUserList(xp, num_file, file);
4395 # endif
4397 regmatch.regprog = vim_regcomp(pat, p_magic ? RE_MAGIC : 0);
4398 if (regmatch.regprog == NULL)
4399 return FAIL;
4401 /* set ignore-case according to p_ic, p_scs and pat */
4402 regmatch.rm_ic = ignorecase(pat);
4404 if (xp->xp_context == EXPAND_SETTINGS
4405 || xp->xp_context == EXPAND_BOOL_SETTINGS)
4406 ret = ExpandSettings(xp, &regmatch, num_file, file);
4407 else if (xp->xp_context == EXPAND_MAPPINGS)
4408 ret = ExpandMappings(&regmatch, num_file, file);
4409 # if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL)
4410 else if (xp->xp_context == EXPAND_USER_DEFINED)
4411 ret = ExpandUserDefined(xp, &regmatch, num_file, file);
4412 # endif
4413 else
4415 static struct expgen
4417 int context;
4418 char_u *((*func)__ARGS((expand_T *, int)));
4419 int ic;
4420 } tab[] =
4422 {EXPAND_COMMANDS, get_command_name, FALSE},
4423 #ifdef FEAT_USR_CMDS
4424 {EXPAND_USER_COMMANDS, get_user_commands, FALSE},
4425 {EXPAND_USER_CMD_FLAGS, get_user_cmd_flags, FALSE},
4426 {EXPAND_USER_NARGS, get_user_cmd_nargs, FALSE},
4427 {EXPAND_USER_COMPLETE, get_user_cmd_complete, FALSE},
4428 #endif
4429 #ifdef FEAT_EVAL
4430 {EXPAND_USER_VARS, get_user_var_name, FALSE},
4431 {EXPAND_FUNCTIONS, get_function_name, FALSE},
4432 {EXPAND_USER_FUNC, get_user_func_name, FALSE},
4433 {EXPAND_EXPRESSION, get_expr_name, FALSE},
4434 #endif
4435 #ifdef FEAT_MENU
4436 {EXPAND_MENUS, get_menu_name, FALSE},
4437 {EXPAND_MENUNAMES, get_menu_names, FALSE},
4438 #endif
4439 #ifdef FEAT_SYN_HL
4440 {EXPAND_SYNTAX, get_syntax_name, TRUE},
4441 #endif
4442 {EXPAND_HIGHLIGHT, get_highlight_name, TRUE},
4443 #ifdef FEAT_AUTOCMD
4444 {EXPAND_EVENTS, get_event_name, TRUE},
4445 {EXPAND_AUGROUP, get_augroup_name, TRUE},
4446 #endif
4447 #if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4448 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
4449 {EXPAND_LANGUAGE, get_lang_arg, TRUE},
4450 #endif
4451 {EXPAND_ENV_VARS, get_env_name, TRUE},
4452 #ifdef FEAT_GUI_MACVIM
4453 {EXPAND_MACACTION, get_macaction_name, FALSE},
4454 #endif
4456 int i;
4459 * Find a context in the table and call the ExpandGeneric() with the
4460 * right function to do the expansion.
4462 ret = FAIL;
4463 for (i = 0; i < sizeof(tab) / sizeof(struct expgen); ++i)
4464 if (xp->xp_context == tab[i].context)
4466 if (tab[i].ic)
4467 regmatch.rm_ic = TRUE;
4468 ret = ExpandGeneric(xp, &regmatch, num_file, file, tab[i].func);
4469 break;
4473 vim_free(regmatch.regprog);
4475 return ret;
4476 #endif /* FEAT_CMDL_COMPL */
4479 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
4481 * Expand a list of names.
4483 * Generic function for command line completion. It calls a function to
4484 * obtain strings, one by one. The strings are matched against a regexp
4485 * program. Matching strings are copied into an array, which is returned.
4487 * Returns OK when no problems encountered, FAIL for error (out of memory).
4490 ExpandGeneric(xp, regmatch, num_file, file, func)
4491 expand_T *xp;
4492 regmatch_T *regmatch;
4493 int *num_file;
4494 char_u ***file;
4495 char_u *((*func)__ARGS((expand_T *, int)));
4496 /* returns a string from the list */
4498 int i;
4499 int count = 0;
4500 int round;
4501 char_u *str;
4503 /* do this loop twice:
4504 * round == 0: count the number of matching names
4505 * round == 1: copy the matching names into allocated memory
4507 for (round = 0; round <= 1; ++round)
4509 for (i = 0; ; ++i)
4511 str = (*func)(xp, i);
4512 if (str == NULL) /* end of list */
4513 break;
4514 if (*str == NUL) /* skip empty strings */
4515 continue;
4517 if (vim_regexec(regmatch, str, (colnr_T)0))
4519 if (round)
4521 str = vim_strsave_escaped(str, (char_u *)" \t\\.");
4522 (*file)[count] = str;
4523 #ifdef FEAT_MENU
4524 if (func == get_menu_names && str != NULL)
4526 /* test for separator added by get_menu_names() */
4527 str += STRLEN(str) - 1;
4528 if (*str == '\001')
4529 *str = '.';
4531 #endif
4533 ++count;
4536 if (round == 0)
4538 if (count == 0)
4539 return OK;
4540 *num_file = count;
4541 *file = (char_u **)alloc((unsigned)(count * sizeof(char_u *)));
4542 if (*file == NULL)
4544 *file = (char_u **)"";
4545 return FAIL;
4547 count = 0;
4551 /* Sort the results. Keep menu's in the specified order. */
4552 if (xp->xp_context != EXPAND_MENUNAMES && xp->xp_context != EXPAND_MENUS)
4553 sort_strings(*file, *num_file);
4555 #ifdef FEAT_CMDL_COMPL
4556 /* Reset the variables used for special highlight names expansion, so that
4557 * they don't show up when getting normal highlight names by ID. */
4558 reset_expand_highlight();
4559 #endif
4561 return OK;
4565 * Complete a shell command.
4566 * Returns FAIL or OK;
4568 static int
4569 expand_shellcmd(filepat, num_file, file, flagsarg)
4570 char_u *filepat; /* pattern to match with command names */
4571 int *num_file; /* return: number of matches */
4572 char_u ***file; /* return: array with matches */
4573 int flagsarg; /* EW_ flags */
4575 char_u *pat;
4576 int i;
4577 char_u *path;
4578 int mustfree = FALSE;
4579 garray_T ga;
4580 char_u *buf = alloc(MAXPATHL);
4581 size_t l;
4582 char_u *s, *e;
4583 int flags = flagsarg;
4584 int ret;
4586 if (buf == NULL)
4587 return FAIL;
4589 /* for ":set path=" and ":set tags=" halve backslashes for escaped
4590 * space */
4591 pat = vim_strsave(filepat);
4592 for (i = 0; pat[i]; ++i)
4593 if (pat[i] == '\\' && pat[i + 1] == ' ')
4594 mch_memmove(pat + i, pat + i + 1, STRLEN(pat + i));
4596 flags |= EW_FILE | EW_EXEC;
4598 /* For an absolute name we don't use $PATH. */
4599 if (mch_isFullName(pat))
4600 path = (char_u *)" ";
4601 else if ((pat[0] == '.' && (vim_ispathsep(pat[1])
4602 || (pat[1] == '.' && vim_ispathsep(pat[2])))))
4603 path = (char_u *)".";
4604 else
4605 path = vim_getenv((char_u *)"PATH", &mustfree);
4608 * Go over all directories in $PATH. Expand matches in that directory and
4609 * collect them in "ga".
4611 ga_init2(&ga, (int)sizeof(char *), 10);
4612 for (s = path; *s != NUL; s = e)
4614 if (*s == ' ')
4615 ++s; /* Skip space used for absolute path name. */
4617 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
4618 e = vim_strchr(s, ';');
4619 #else
4620 e = vim_strchr(s, ':');
4621 #endif
4622 if (e == NULL)
4623 e = s + STRLEN(s);
4625 l = e - s;
4626 if (l > MAXPATHL - 5)
4627 break;
4628 vim_strncpy(buf, s, l);
4629 add_pathsep(buf);
4630 l = STRLEN(buf);
4631 vim_strncpy(buf + l, pat, MAXPATHL - 1 - l);
4633 /* Expand matches in one directory of $PATH. */
4634 ret = expand_wildcards(1, &buf, num_file, file, flags);
4635 if (ret == OK)
4637 if (ga_grow(&ga, *num_file) == FAIL)
4638 FreeWild(*num_file, *file);
4639 else
4641 for (i = 0; i < *num_file; ++i)
4643 s = (*file)[i];
4644 if (STRLEN(s) > l)
4646 /* Remove the path again. */
4647 mch_memmove(s, s + l, STRLEN(s + l) + 1);
4648 ((char_u **)ga.ga_data)[ga.ga_len++] = s;
4650 else
4651 vim_free(s);
4653 vim_free(*file);
4656 if (*e != NUL)
4657 ++e;
4659 *file = ga.ga_data;
4660 *num_file = ga.ga_len;
4662 vim_free(buf);
4663 vim_free(pat);
4664 if (mustfree)
4665 vim_free(path);
4666 return OK;
4670 # if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL)
4671 static void * call_user_expand_func __ARGS((void *(*user_expand_func) __ARGS((char_u *, int, char_u **, int)), expand_T *xp, int *num_file, char_u ***file));
4674 * Call "user_expand_func()" to invoke a user defined VimL function and return
4675 * the result (either a string or a List).
4677 static void *
4678 call_user_expand_func(user_expand_func, xp, num_file, file)
4679 void *(*user_expand_func) __ARGS((char_u *, int, char_u **, int));
4680 expand_T *xp;
4681 int *num_file;
4682 char_u ***file;
4684 char_u keep;
4685 char_u num[50];
4686 char_u *args[3];
4687 int save_current_SID = current_SID;
4688 void *ret;
4689 struct cmdline_info save_ccline;
4691 if (xp->xp_arg == NULL || xp->xp_arg[0] == '\0')
4692 return NULL;
4693 *num_file = 0;
4694 *file = NULL;
4696 if (ccline.cmdbuff == NULL)
4698 /* Completion from Insert mode, pass fake arguments. */
4699 keep = 0;
4700 sprintf((char *)num, "%d", (int)STRLEN(xp->xp_pattern));
4701 args[1] = xp->xp_pattern;
4703 else
4705 /* Completion on the command line, pass real arguments. */
4706 keep = ccline.cmdbuff[ccline.cmdlen];
4707 ccline.cmdbuff[ccline.cmdlen] = 0;
4708 sprintf((char *)num, "%d", ccline.cmdpos);
4709 args[1] = ccline.cmdbuff;
4711 args[0] = xp->xp_pattern;
4712 args[2] = num;
4714 /* Save the cmdline, we don't know what the function may do. */
4715 save_ccline = ccline;
4716 ccline.cmdbuff = NULL;
4717 ccline.cmdprompt = NULL;
4718 current_SID = xp->xp_scriptID;
4720 ret = user_expand_func(xp->xp_arg, 3, args, FALSE);
4722 ccline = save_ccline;
4723 current_SID = save_current_SID;
4724 if (ccline.cmdbuff != NULL)
4725 ccline.cmdbuff[ccline.cmdlen] = keep;
4727 return ret;
4731 * Expand names with a function defined by the user.
4733 static int
4734 ExpandUserDefined(xp, regmatch, num_file, file)
4735 expand_T *xp;
4736 regmatch_T *regmatch;
4737 int *num_file;
4738 char_u ***file;
4740 char_u *retstr;
4741 char_u *s;
4742 char_u *e;
4743 char_u keep;
4744 garray_T ga;
4746 retstr = call_user_expand_func(call_func_retstr, xp, num_file, file);
4747 if (retstr == NULL)
4748 return FAIL;
4750 ga_init2(&ga, (int)sizeof(char *), 3);
4751 for (s = retstr; *s != NUL; s = e)
4753 e = vim_strchr(s, '\n');
4754 if (e == NULL)
4755 e = s + STRLEN(s);
4756 keep = *e;
4757 *e = 0;
4759 if (xp->xp_pattern[0] && vim_regexec(regmatch, s, (colnr_T)0) == 0)
4761 *e = keep;
4762 if (*e != NUL)
4763 ++e;
4764 continue;
4767 if (ga_grow(&ga, 1) == FAIL)
4768 break;
4770 ((char_u **)ga.ga_data)[ga.ga_len] = vim_strnsave(s, (int)(e - s));
4771 ++ga.ga_len;
4773 *e = keep;
4774 if (*e != NUL)
4775 ++e;
4777 vim_free(retstr);
4778 *file = ga.ga_data;
4779 *num_file = ga.ga_len;
4780 return OK;
4784 * Expand names with a list returned by a function defined by the user.
4786 static int
4787 ExpandUserList(xp, num_file, file)
4788 expand_T *xp;
4789 int *num_file;
4790 char_u ***file;
4792 list_T *retlist;
4793 listitem_T *li;
4794 garray_T ga;
4796 retlist = call_user_expand_func(call_func_retlist, xp, num_file, file);
4797 if (retlist == NULL)
4798 return FAIL;
4800 ga_init2(&ga, (int)sizeof(char *), 3);
4801 /* Loop over the items in the list. */
4802 for (li = retlist->lv_first; li != NULL; li = li->li_next)
4804 if (li->li_tv.v_type != VAR_STRING)
4805 continue; /* Skip non-string items */
4807 if (ga_grow(&ga, 1) == FAIL)
4808 break;
4810 ((char_u **)ga.ga_data)[ga.ga_len] =
4811 vim_strsave(li->li_tv.vval.v_string);
4812 ++ga.ga_len;
4814 list_unref(retlist);
4816 *file = ga.ga_data;
4817 *num_file = ga.ga_len;
4818 return OK;
4820 #endif
4823 * Expand color scheme names: 'runtimepath'/colors/{pat}.vim
4824 * or compiler names.
4826 static int
4827 ExpandRTDir(pat, num_file, file, dirname)
4828 char_u *pat;
4829 int *num_file;
4830 char_u ***file;
4831 char *dirname; /* "colors" or "compiler" */
4833 char_u *all;
4834 char_u *s;
4835 char_u *e;
4836 garray_T ga;
4838 *num_file = 0;
4839 *file = NULL;
4840 s = alloc((unsigned)(STRLEN(pat) + STRLEN(dirname) + 7));
4841 if (s == NULL)
4842 return FAIL;
4843 sprintf((char *)s, "%s/%s*.vim", dirname, pat);
4844 all = globpath(p_rtp, s);
4845 vim_free(s);
4846 if (all == NULL)
4847 return FAIL;
4849 ga_init2(&ga, (int)sizeof(char *), 3);
4850 for (s = all; *s != NUL; s = e)
4852 e = vim_strchr(s, '\n');
4853 if (e == NULL)
4854 e = s + STRLEN(s);
4855 if (ga_grow(&ga, 1) == FAIL)
4856 break;
4857 if (e - 4 > s && STRNICMP(e - 4, ".vim", 4) == 0)
4859 for (s = e - 4; s > all; mb_ptr_back(all, s))
4860 if (*s == '\n' || vim_ispathsep(*s))
4861 break;
4862 ++s;
4863 ((char_u **)ga.ga_data)[ga.ga_len] =
4864 vim_strnsave(s, (int)(e - s - 4));
4865 ++ga.ga_len;
4867 if (*e != NUL)
4868 ++e;
4870 vim_free(all);
4871 *file = ga.ga_data;
4872 *num_file = ga.ga_len;
4873 return OK;
4876 #endif
4878 #if defined(FEAT_CMDL_COMPL) || defined(FEAT_EVAL) || defined(PROTO)
4880 * Expand "file" for all comma-separated directories in "path".
4881 * Returns an allocated string with all matches concatenated, separated by
4882 * newlines. Returns NULL for an error or no matches.
4884 char_u *
4885 globpath(path, file)
4886 char_u *path;
4887 char_u *file;
4889 expand_T xpc;
4890 char_u *buf;
4891 garray_T ga;
4892 int i;
4893 int len;
4894 int num_p;
4895 char_u **p;
4896 char_u *cur = NULL;
4898 buf = alloc(MAXPATHL);
4899 if (buf == NULL)
4900 return NULL;
4902 ExpandInit(&xpc);
4903 xpc.xp_context = EXPAND_FILES;
4905 ga_init2(&ga, 1, 100);
4907 /* Loop over all entries in {path}. */
4908 while (*path != NUL)
4910 /* Copy one item of the path to buf[] and concatenate the file name. */
4911 copy_option_part(&path, buf, MAXPATHL, ",");
4912 if (STRLEN(buf) + STRLEN(file) + 2 < MAXPATHL)
4914 add_pathsep(buf);
4915 STRCAT(buf, file);
4916 if (ExpandFromContext(&xpc, buf, &num_p, &p, WILD_SILENT) != FAIL
4917 && num_p > 0)
4919 ExpandEscape(&xpc, buf, num_p, p, WILD_SILENT);
4920 for (len = 0, i = 0; i < num_p; ++i)
4921 len += (int)STRLEN(p[i]) + 1;
4923 /* Concatenate new results to previous ones. */
4924 if (ga_grow(&ga, len) == OK)
4926 cur = (char_u *)ga.ga_data + ga.ga_len;
4927 for (i = 0; i < num_p; ++i)
4929 STRCPY(cur, p[i]);
4930 cur += STRLEN(p[i]);
4931 *cur++ = '\n';
4933 ga.ga_len += len;
4935 FreeWild(num_p, p);
4939 if (cur != NULL)
4940 *--cur = 0; /* Replace trailing newline with NUL */
4942 vim_free(buf);
4943 return (char_u *)ga.ga_data;
4946 #endif
4948 #if defined(FEAT_CMDHIST) || defined(PROTO)
4950 /*********************************
4951 * Command line history stuff *
4952 *********************************/
4955 * Translate a history character to the associated type number.
4957 static int
4958 hist_char2type(c)
4959 int c;
4961 if (c == ':')
4962 return HIST_CMD;
4963 if (c == '=')
4964 return HIST_EXPR;
4965 if (c == '@')
4966 return HIST_INPUT;
4967 if (c == '>')
4968 return HIST_DEBUG;
4969 return HIST_SEARCH; /* must be '?' or '/' */
4973 * Table of history names.
4974 * These names are used in :history and various hist...() functions.
4975 * It is sufficient to give the significant prefix of a history name.
4978 static char *(history_names[]) =
4980 "cmd",
4981 "search",
4982 "expr",
4983 "input",
4984 "debug",
4985 NULL
4989 * init_history() - Initialize the command line history.
4990 * Also used to re-allocate the history when the size changes.
4992 void
4993 init_history()
4995 int newlen; /* new length of history table */
4996 histentry_T *temp;
4997 int i;
4998 int j;
4999 int type;
5002 * If size of history table changed, reallocate it
5004 newlen = (int)p_hi;
5005 if (newlen != hislen) /* history length changed */
5007 for (type = 0; type < HIST_COUNT; ++type) /* adjust the tables */
5009 if (newlen)
5011 temp = (histentry_T *)lalloc(
5012 (long_u)(newlen * sizeof(histentry_T)), TRUE);
5013 if (temp == NULL) /* out of memory! */
5015 if (type == 0) /* first one: just keep the old length */
5017 newlen = hislen;
5018 break;
5020 /* Already changed one table, now we can only have zero
5021 * length for all tables. */
5022 newlen = 0;
5023 type = -1;
5024 continue;
5027 else
5028 temp = NULL;
5029 if (newlen == 0 || temp != NULL)
5031 if (hisidx[type] < 0) /* there are no entries yet */
5033 for (i = 0; i < newlen; ++i)
5035 temp[i].hisnum = 0;
5036 temp[i].hisstr = NULL;
5039 else if (newlen > hislen) /* array becomes bigger */
5041 for (i = 0; i <= hisidx[type]; ++i)
5042 temp[i] = history[type][i];
5043 j = i;
5044 for ( ; i <= newlen - (hislen - hisidx[type]); ++i)
5046 temp[i].hisnum = 0;
5047 temp[i].hisstr = NULL;
5049 for ( ; j < hislen; ++i, ++j)
5050 temp[i] = history[type][j];
5052 else /* array becomes smaller or 0 */
5054 j = hisidx[type];
5055 for (i = newlen - 1; ; --i)
5057 if (i >= 0) /* copy newest entries */
5058 temp[i] = history[type][j];
5059 else /* remove older entries */
5060 vim_free(history[type][j].hisstr);
5061 if (--j < 0)
5062 j = hislen - 1;
5063 if (j == hisidx[type])
5064 break;
5066 hisidx[type] = newlen - 1;
5068 vim_free(history[type]);
5069 history[type] = temp;
5072 hislen = newlen;
5077 * Check if command line 'str' is already in history.
5078 * If 'move_to_front' is TRUE, matching entry is moved to end of history.
5080 static int
5081 in_history(type, str, move_to_front)
5082 int type;
5083 char_u *str;
5084 int move_to_front; /* Move the entry to the front if it exists */
5086 int i;
5087 int last_i = -1;
5089 if (hisidx[type] < 0)
5090 return FALSE;
5091 i = hisidx[type];
5094 if (history[type][i].hisstr == NULL)
5095 return FALSE;
5096 if (STRCMP(str, history[type][i].hisstr) == 0)
5098 if (!move_to_front)
5099 return TRUE;
5100 last_i = i;
5101 break;
5103 if (--i < 0)
5104 i = hislen - 1;
5105 } while (i != hisidx[type]);
5107 if (last_i >= 0)
5109 str = history[type][i].hisstr;
5110 while (i != hisidx[type])
5112 if (++i >= hislen)
5113 i = 0;
5114 history[type][last_i] = history[type][i];
5115 last_i = i;
5117 history[type][i].hisstr = str;
5118 history[type][i].hisnum = ++hisnum[type];
5119 return TRUE;
5121 return FALSE;
5125 * Convert history name (from table above) to its HIST_ equivalent.
5126 * When "name" is empty, return "cmd" history.
5127 * Returns -1 for unknown history name.
5130 get_histtype(name)
5131 char_u *name;
5133 int i;
5134 int len = (int)STRLEN(name);
5136 /* No argument: use current history. */
5137 if (len == 0)
5138 return hist_char2type(ccline.cmdfirstc);
5140 for (i = 0; history_names[i] != NULL; ++i)
5141 if (STRNICMP(name, history_names[i], len) == 0)
5142 return i;
5144 if (vim_strchr((char_u *)":=@>?/", name[0]) != NULL && name[1] == NUL)
5145 return hist_char2type(name[0]);
5147 return -1;
5150 static int last_maptick = -1; /* last seen maptick */
5153 * Add the given string to the given history. If the string is already in the
5154 * history then it is moved to the front. "histype" may be one of he HIST_
5155 * values.
5157 void
5158 add_to_history(histype, new_entry, in_map, sep)
5159 int histype;
5160 char_u *new_entry;
5161 int in_map; /* consider maptick when inside a mapping */
5162 int sep; /* separator character used (search hist) */
5164 histentry_T *hisptr;
5165 int len;
5167 if (hislen == 0) /* no history */
5168 return;
5171 * Searches inside the same mapping overwrite each other, so that only
5172 * the last line is kept. Be careful not to remove a line that was moved
5173 * down, only lines that were added.
5175 if (histype == HIST_SEARCH && in_map)
5177 if (maptick == last_maptick)
5179 /* Current line is from the same mapping, remove it */
5180 hisptr = &history[HIST_SEARCH][hisidx[HIST_SEARCH]];
5181 vim_free(hisptr->hisstr);
5182 hisptr->hisstr = NULL;
5183 hisptr->hisnum = 0;
5184 --hisnum[histype];
5185 if (--hisidx[HIST_SEARCH] < 0)
5186 hisidx[HIST_SEARCH] = hislen - 1;
5188 last_maptick = -1;
5190 if (!in_history(histype, new_entry, TRUE))
5192 if (++hisidx[histype] == hislen)
5193 hisidx[histype] = 0;
5194 hisptr = &history[histype][hisidx[histype]];
5195 vim_free(hisptr->hisstr);
5197 /* Store the separator after the NUL of the string. */
5198 len = (int)STRLEN(new_entry);
5199 hisptr->hisstr = vim_strnsave(new_entry, len + 2);
5200 if (hisptr->hisstr != NULL)
5201 hisptr->hisstr[len + 1] = sep;
5203 hisptr->hisnum = ++hisnum[histype];
5204 if (histype == HIST_SEARCH && in_map)
5205 last_maptick = maptick;
5209 #if defined(FEAT_EVAL) || defined(PROTO)
5212 * Get identifier of newest history entry.
5213 * "histype" may be one of the HIST_ values.
5216 get_history_idx(histype)
5217 int histype;
5219 if (hislen == 0 || histype < 0 || histype >= HIST_COUNT
5220 || hisidx[histype] < 0)
5221 return -1;
5223 return history[histype][hisidx[histype]].hisnum;
5226 static struct cmdline_info *get_ccline_ptr __ARGS((void));
5229 * Get pointer to the command line info to use. cmdline_paste() may clear
5230 * ccline and put the previous value in prev_ccline.
5232 static struct cmdline_info *
5233 get_ccline_ptr()
5235 if ((State & CMDLINE) == 0)
5236 return NULL;
5237 if (ccline.cmdbuff != NULL)
5238 return &ccline;
5239 if (prev_ccline_used && prev_ccline.cmdbuff != NULL)
5240 return &prev_ccline;
5241 return NULL;
5245 * Get the current command line in allocated memory.
5246 * Only works when the command line is being edited.
5247 * Returns NULL when something is wrong.
5249 char_u *
5250 get_cmdline_str()
5252 struct cmdline_info *p = get_ccline_ptr();
5254 if (p == NULL)
5255 return NULL;
5256 return vim_strnsave(p->cmdbuff, p->cmdlen);
5260 * Get the current command line position, counted in bytes.
5261 * Zero is the first position.
5262 * Only works when the command line is being edited.
5263 * Returns -1 when something is wrong.
5266 get_cmdline_pos()
5268 struct cmdline_info *p = get_ccline_ptr();
5270 if (p == NULL)
5271 return -1;
5272 return p->cmdpos;
5276 * Set the command line byte position to "pos". Zero is the first position.
5277 * Only works when the command line is being edited.
5278 * Returns 1 when failed, 0 when OK.
5281 set_cmdline_pos(pos)
5282 int pos;
5284 struct cmdline_info *p = get_ccline_ptr();
5286 if (p == NULL)
5287 return 1;
5289 /* The position is not set directly but after CTRL-\ e or CTRL-R = has
5290 * changed the command line. */
5291 if (pos < 0)
5292 new_cmdpos = 0;
5293 else
5294 new_cmdpos = pos;
5295 return 0;
5299 * Get the current command-line type.
5300 * Returns ':' or '/' or '?' or '@' or '>' or '-'
5301 * Only works when the command line is being edited.
5302 * Returns NUL when something is wrong.
5305 get_cmdline_type()
5307 struct cmdline_info *p = get_ccline_ptr();
5309 if (p == NULL)
5310 return NUL;
5311 if (p->cmdfirstc == NUL)
5312 return (p->input_fn) ? '@' : '-';
5313 return p->cmdfirstc;
5317 * Calculate history index from a number:
5318 * num > 0: seen as identifying number of a history entry
5319 * num < 0: relative position in history wrt newest entry
5320 * "histype" may be one of the HIST_ values.
5322 static int
5323 calc_hist_idx(histype, num)
5324 int histype;
5325 int num;
5327 int i;
5328 histentry_T *hist;
5329 int wrapped = FALSE;
5331 if (hislen == 0 || histype < 0 || histype >= HIST_COUNT
5332 || (i = hisidx[histype]) < 0 || num == 0)
5333 return -1;
5335 hist = history[histype];
5336 if (num > 0)
5338 while (hist[i].hisnum > num)
5339 if (--i < 0)
5341 if (wrapped)
5342 break;
5343 i += hislen;
5344 wrapped = TRUE;
5346 if (hist[i].hisnum == num && hist[i].hisstr != NULL)
5347 return i;
5349 else if (-num <= hislen)
5351 i += num + 1;
5352 if (i < 0)
5353 i += hislen;
5354 if (hist[i].hisstr != NULL)
5355 return i;
5357 return -1;
5361 * Get a history entry by its index.
5362 * "histype" may be one of the HIST_ values.
5364 char_u *
5365 get_history_entry(histype, idx)
5366 int histype;
5367 int idx;
5369 idx = calc_hist_idx(histype, idx);
5370 if (idx >= 0)
5371 return history[histype][idx].hisstr;
5372 else
5373 return (char_u *)"";
5377 * Clear all entries of a history.
5378 * "histype" may be one of the HIST_ values.
5381 clr_history(histype)
5382 int histype;
5384 int i;
5385 histentry_T *hisptr;
5387 if (hislen != 0 && histype >= 0 && histype < HIST_COUNT)
5389 hisptr = history[histype];
5390 for (i = hislen; i--;)
5392 vim_free(hisptr->hisstr);
5393 hisptr->hisnum = 0;
5394 hisptr++->hisstr = NULL;
5396 hisidx[histype] = -1; /* mark history as cleared */
5397 hisnum[histype] = 0; /* reset identifier counter */
5398 return OK;
5400 return FAIL;
5404 * Remove all entries matching {str} from a history.
5405 * "histype" may be one of the HIST_ values.
5408 del_history_entry(histype, str)
5409 int histype;
5410 char_u *str;
5412 regmatch_T regmatch;
5413 histentry_T *hisptr;
5414 int idx;
5415 int i;
5416 int last;
5417 int found = FALSE;
5419 regmatch.regprog = NULL;
5420 regmatch.rm_ic = FALSE; /* always match case */
5421 if (hislen != 0
5422 && histype >= 0
5423 && histype < HIST_COUNT
5424 && *str != NUL
5425 && (idx = hisidx[histype]) >= 0
5426 && (regmatch.regprog = vim_regcomp(str, RE_MAGIC + RE_STRING))
5427 != NULL)
5429 i = last = idx;
5432 hisptr = &history[histype][i];
5433 if (hisptr->hisstr == NULL)
5434 break;
5435 if (vim_regexec(&regmatch, hisptr->hisstr, (colnr_T)0))
5437 found = TRUE;
5438 vim_free(hisptr->hisstr);
5439 hisptr->hisstr = NULL;
5440 hisptr->hisnum = 0;
5442 else
5444 if (i != last)
5446 history[histype][last] = *hisptr;
5447 hisptr->hisstr = NULL;
5448 hisptr->hisnum = 0;
5450 if (--last < 0)
5451 last += hislen;
5453 if (--i < 0)
5454 i += hislen;
5455 } while (i != idx);
5456 if (history[histype][idx].hisstr == NULL)
5457 hisidx[histype] = -1;
5459 vim_free(regmatch.regprog);
5460 return found;
5464 * Remove an indexed entry from a history.
5465 * "histype" may be one of the HIST_ values.
5468 del_history_idx(histype, idx)
5469 int histype;
5470 int idx;
5472 int i, j;
5474 i = calc_hist_idx(histype, idx);
5475 if (i < 0)
5476 return FALSE;
5477 idx = hisidx[histype];
5478 vim_free(history[histype][i].hisstr);
5480 /* When deleting the last added search string in a mapping, reset
5481 * last_maptick, so that the last added search string isn't deleted again.
5483 if (histype == HIST_SEARCH && maptick == last_maptick && i == idx)
5484 last_maptick = -1;
5486 while (i != idx)
5488 j = (i + 1) % hislen;
5489 history[histype][i] = history[histype][j];
5490 i = j;
5492 history[histype][i].hisstr = NULL;
5493 history[histype][i].hisnum = 0;
5494 if (--i < 0)
5495 i += hislen;
5496 hisidx[histype] = i;
5497 return TRUE;
5500 #endif /* FEAT_EVAL */
5502 #if defined(FEAT_CRYPT) || defined(PROTO)
5504 * Very specific function to remove the value in ":set key=val" from the
5505 * history.
5507 void
5508 remove_key_from_history()
5510 char_u *p;
5511 int i;
5513 i = hisidx[HIST_CMD];
5514 if (i < 0)
5515 return;
5516 p = history[HIST_CMD][i].hisstr;
5517 if (p != NULL)
5518 for ( ; *p; ++p)
5519 if (STRNCMP(p, "key", 3) == 0 && !isalpha(p[3]))
5521 p = vim_strchr(p + 3, '=');
5522 if (p == NULL)
5523 break;
5524 ++p;
5525 for (i = 0; p[i] && !vim_iswhite(p[i]); ++i)
5526 if (p[i] == '\\' && p[i + 1])
5527 ++i;
5528 mch_memmove(p, p + i, STRLEN(p + i) + 1);
5529 --p;
5532 #endif
5534 #endif /* FEAT_CMDHIST */
5536 #if defined(FEAT_QUICKFIX) || defined(FEAT_CMDHIST) || defined(PROTO)
5538 * Get indices "num1,num2" that specify a range within a list (not a range of
5539 * text lines in a buffer!) from a string. Used for ":history" and ":clist".
5540 * Returns OK if parsed successfully, otherwise FAIL.
5543 get_list_range(str, num1, num2)
5544 char_u **str;
5545 int *num1;
5546 int *num2;
5548 int len;
5549 int first = FALSE;
5550 long num;
5552 *str = skipwhite(*str);
5553 if (**str == '-' || vim_isdigit(**str)) /* parse "from" part of range */
5555 vim_str2nr(*str, NULL, &len, FALSE, FALSE, &num, NULL);
5556 *str += len;
5557 *num1 = (int)num;
5558 first = TRUE;
5560 *str = skipwhite(*str);
5561 if (**str == ',') /* parse "to" part of range */
5563 *str = skipwhite(*str + 1);
5564 vim_str2nr(*str, NULL, &len, FALSE, FALSE, &num, NULL);
5565 if (len > 0)
5567 *num2 = (int)num;
5568 *str = skipwhite(*str + len);
5570 else if (!first) /* no number given at all */
5571 return FAIL;
5573 else if (first) /* only one number given */
5574 *num2 = *num1;
5575 return OK;
5577 #endif
5579 #if defined(FEAT_CMDHIST) || defined(PROTO)
5581 * :history command - print a history
5583 void
5584 ex_history(eap)
5585 exarg_T *eap;
5587 histentry_T *hist;
5588 int histype1 = HIST_CMD;
5589 int histype2 = HIST_CMD;
5590 int hisidx1 = 1;
5591 int hisidx2 = -1;
5592 int idx;
5593 int i, j, k;
5594 char_u *end;
5595 char_u *arg = eap->arg;
5597 if (hislen == 0)
5599 MSG(_("'history' option is zero"));
5600 return;
5603 if (!(VIM_ISDIGIT(*arg) || *arg == '-' || *arg == ','))
5605 end = arg;
5606 while (ASCII_ISALPHA(*end)
5607 || vim_strchr((char_u *)":=@>/?", *end) != NULL)
5608 end++;
5609 i = *end;
5610 *end = NUL;
5611 histype1 = get_histtype(arg);
5612 if (histype1 == -1)
5614 if (STRICMP(arg, "all") == 0)
5616 histype1 = 0;
5617 histype2 = HIST_COUNT-1;
5619 else
5621 *end = i;
5622 EMSG(_(e_trailing));
5623 return;
5626 else
5627 histype2 = histype1;
5628 *end = i;
5630 else
5631 end = arg;
5632 if (!get_list_range(&end, &hisidx1, &hisidx2) || *end != NUL)
5634 EMSG(_(e_trailing));
5635 return;
5638 for (; !got_int && histype1 <= histype2; ++histype1)
5640 STRCPY(IObuff, "\n # ");
5641 STRCAT(STRCAT(IObuff, history_names[histype1]), " history");
5642 MSG_PUTS_TITLE(IObuff);
5643 idx = hisidx[histype1];
5644 hist = history[histype1];
5645 j = hisidx1;
5646 k = hisidx2;
5647 if (j < 0)
5648 j = (-j > hislen) ? 0 : hist[(hislen+j+idx+1) % hislen].hisnum;
5649 if (k < 0)
5650 k = (-k > hislen) ? 0 : hist[(hislen+k+idx+1) % hislen].hisnum;
5651 if (idx >= 0 && j <= k)
5652 for (i = idx + 1; !got_int; ++i)
5654 if (i == hislen)
5655 i = 0;
5656 if (hist[i].hisstr != NULL
5657 && hist[i].hisnum >= j && hist[i].hisnum <= k)
5659 msg_putchar('\n');
5660 sprintf((char *)IObuff, "%c%6d ", i == idx ? '>' : ' ',
5661 hist[i].hisnum);
5662 if (vim_strsize(hist[i].hisstr) > (int)Columns - 10)
5663 trunc_string(hist[i].hisstr, IObuff + STRLEN(IObuff),
5664 (int)Columns - 10);
5665 else
5666 STRCAT(IObuff, hist[i].hisstr);
5667 msg_outtrans(IObuff);
5668 out_flush();
5670 if (i == idx)
5671 break;
5675 #endif
5677 #if (defined(FEAT_VIMINFO) && defined(FEAT_CMDHIST)) || defined(PROTO)
5678 static char_u **viminfo_history[HIST_COUNT] = {NULL, NULL, NULL, NULL};
5679 static int viminfo_hisidx[HIST_COUNT] = {0, 0, 0, 0};
5680 static int viminfo_hislen[HIST_COUNT] = {0, 0, 0, 0};
5681 static int viminfo_add_at_front = FALSE;
5683 static int hist_type2char __ARGS((int type, int use_question));
5686 * Translate a history type number to the associated character.
5688 static int
5689 hist_type2char(type, use_question)
5690 int type;
5691 int use_question; /* use '?' instead of '/' */
5693 if (type == HIST_CMD)
5694 return ':';
5695 if (type == HIST_SEARCH)
5697 if (use_question)
5698 return '?';
5699 else
5700 return '/';
5702 if (type == HIST_EXPR)
5703 return '=';
5704 return '@';
5708 * Prepare for reading the history from the viminfo file.
5709 * This allocates history arrays to store the read history lines.
5711 void
5712 prepare_viminfo_history(asklen)
5713 int asklen;
5715 int i;
5716 int num;
5717 int type;
5718 int len;
5720 init_history();
5721 viminfo_add_at_front = (asklen != 0);
5722 if (asklen > hislen)
5723 asklen = hislen;
5725 for (type = 0; type < HIST_COUNT; ++type)
5728 * Count the number of empty spaces in the history list. If there are
5729 * more spaces available than we request, then fill them up.
5731 for (i = 0, num = 0; i < hislen; i++)
5732 if (history[type][i].hisstr == NULL)
5733 num++;
5734 len = asklen;
5735 if (num > len)
5736 len = num;
5737 if (len <= 0)
5738 viminfo_history[type] = NULL;
5739 else
5740 viminfo_history[type] =
5741 (char_u **)lalloc((long_u)(len * sizeof(char_u *)), FALSE);
5742 if (viminfo_history[type] == NULL)
5743 len = 0;
5744 viminfo_hislen[type] = len;
5745 viminfo_hisidx[type] = 0;
5750 * Accept a line from the viminfo, store it in the history array when it's
5751 * new.
5754 read_viminfo_history(virp)
5755 vir_T *virp;
5757 int type;
5758 long_u len;
5759 char_u *val;
5760 char_u *p;
5762 type = hist_char2type(virp->vir_line[0]);
5763 if (viminfo_hisidx[type] < viminfo_hislen[type])
5765 val = viminfo_readstring(virp, 1, TRUE);
5766 if (val != NULL && *val != NUL)
5768 if (!in_history(type, val + (type == HIST_SEARCH),
5769 viminfo_add_at_front))
5771 /* Need to re-allocate to append the separator byte. */
5772 len = STRLEN(val);
5773 p = lalloc(len + 2, TRUE);
5774 if (p != NULL)
5776 if (type == HIST_SEARCH)
5778 /* Search entry: Move the separator from the first
5779 * column to after the NUL. */
5780 mch_memmove(p, val + 1, (size_t)len);
5781 p[len] = (*val == ' ' ? NUL : *val);
5783 else
5785 /* Not a search entry: No separator in the viminfo
5786 * file, add a NUL separator. */
5787 mch_memmove(p, val, (size_t)len + 1);
5788 p[len + 1] = NUL;
5790 viminfo_history[type][viminfo_hisidx[type]++] = p;
5794 vim_free(val);
5796 return viminfo_readline(virp);
5799 void
5800 finish_viminfo_history()
5802 int idx;
5803 int i;
5804 int type;
5806 for (type = 0; type < HIST_COUNT; ++type)
5808 if (history[type] == NULL)
5809 return;
5810 idx = hisidx[type] + viminfo_hisidx[type];
5811 if (idx >= hislen)
5812 idx -= hislen;
5813 else if (idx < 0)
5814 idx = hislen - 1;
5815 if (viminfo_add_at_front)
5816 hisidx[type] = idx;
5817 else
5819 if (hisidx[type] == -1)
5820 hisidx[type] = hislen - 1;
5823 if (history[type][idx].hisstr != NULL)
5824 break;
5825 if (++idx == hislen)
5826 idx = 0;
5827 } while (idx != hisidx[type]);
5828 if (idx != hisidx[type] && --idx < 0)
5829 idx = hislen - 1;
5831 for (i = 0; i < viminfo_hisidx[type]; i++)
5833 vim_free(history[type][idx].hisstr);
5834 history[type][idx].hisstr = viminfo_history[type][i];
5835 if (--idx < 0)
5836 idx = hislen - 1;
5838 idx += 1;
5839 idx %= hislen;
5840 for (i = 0; i < viminfo_hisidx[type]; i++)
5842 history[type][idx++].hisnum = ++hisnum[type];
5843 idx %= hislen;
5845 vim_free(viminfo_history[type]);
5846 viminfo_history[type] = NULL;
5850 void
5851 write_viminfo_history(fp)
5852 FILE *fp;
5854 int i;
5855 int type;
5856 int num_saved;
5857 char_u *p;
5858 int c;
5860 init_history();
5861 if (hislen == 0)
5862 return;
5863 for (type = 0; type < HIST_COUNT; ++type)
5865 num_saved = get_viminfo_parameter(hist_type2char(type, FALSE));
5866 if (num_saved == 0)
5867 continue;
5868 if (num_saved < 0) /* Use default */
5869 num_saved = hislen;
5870 fprintf(fp, _("\n# %s History (newest to oldest):\n"),
5871 type == HIST_CMD ? _("Command Line") :
5872 type == HIST_SEARCH ? _("Search String") :
5873 type == HIST_EXPR ? _("Expression") :
5874 _("Input Line"));
5875 if (num_saved > hislen)
5876 num_saved = hislen;
5877 i = hisidx[type];
5878 if (i >= 0)
5879 while (num_saved--)
5881 p = history[type][i].hisstr;
5882 if (p != NULL)
5884 fputc(hist_type2char(type, TRUE), fp);
5885 /* For the search history: put the separator in the second
5886 * column; use a space if there isn't one. */
5887 if (type == HIST_SEARCH)
5889 c = p[STRLEN(p) + 1];
5890 putc(c == NUL ? ' ' : c, fp);
5892 viminfo_writestring(fp, p);
5894 if (--i < 0)
5895 i = hislen - 1;
5899 #endif /* FEAT_VIMINFO */
5901 #if defined(FEAT_FKMAP) || defined(PROTO)
5903 * Write a character at the current cursor+offset position.
5904 * It is directly written into the command buffer block.
5906 void
5907 cmd_pchar(c, offset)
5908 int c, offset;
5910 if (ccline.cmdpos + offset >= ccline.cmdlen || ccline.cmdpos + offset < 0)
5912 EMSG(_("E198: cmd_pchar beyond the command length"));
5913 return;
5915 ccline.cmdbuff[ccline.cmdpos + offset] = (char_u)c;
5916 ccline.cmdbuff[ccline.cmdlen] = NUL;
5920 cmd_gchar(offset)
5921 int offset;
5923 if (ccline.cmdpos + offset >= ccline.cmdlen || ccline.cmdpos + offset < 0)
5925 /* EMSG(_("cmd_gchar beyond the command length")); */
5926 return NUL;
5928 return (int)ccline.cmdbuff[ccline.cmdpos + offset];
5930 #endif
5932 #if defined(FEAT_CMDWIN) || defined(PROTO)
5934 * Open a window on the current command line and history. Allow editing in
5935 * the window. Returns when the window is closed.
5936 * Returns:
5937 * CR if the command is to be executed
5938 * Ctrl_C if it is to be abandoned
5939 * K_IGNORE if editing continues
5941 static int
5942 ex_window()
5944 struct cmdline_info save_ccline;
5945 buf_T *old_curbuf = curbuf;
5946 win_T *old_curwin = curwin;
5947 buf_T *bp;
5948 win_T *wp;
5949 int i;
5950 linenr_T lnum;
5951 int histtype;
5952 garray_T winsizes;
5953 char_u typestr[2];
5954 int save_restart_edit = restart_edit;
5955 int save_State = State;
5956 int save_exmode = exmode_active;
5957 #ifdef FEAT_RIGHTLEFT
5958 int save_cmdmsg_rl = cmdmsg_rl;
5959 #endif
5961 /* Can't do this recursively. Can't do it when typing a password. */
5962 if (cmdwin_type != 0
5963 # if defined(FEAT_CRYPT) || defined(FEAT_EVAL)
5964 || cmdline_star > 0
5965 # endif
5968 beep_flush();
5969 return K_IGNORE;
5972 /* Save current window sizes. */
5973 win_size_save(&winsizes);
5975 # ifdef FEAT_AUTOCMD
5976 /* Don't execute autocommands while creating the window. */
5977 block_autocmds();
5978 # endif
5979 /* don't use a new tab page */
5980 cmdmod.tab = 0;
5982 /* Create a window for the command-line buffer. */
5983 if (win_split((int)p_cwh, WSP_BOT) == FAIL)
5985 beep_flush();
5986 # ifdef FEAT_AUTOCMD
5987 unblock_autocmds();
5988 # endif
5989 return K_IGNORE;
5991 cmdwin_type = ccline.cmdfirstc;
5992 if (cmdwin_type == NUL)
5993 cmdwin_type = '-';
5995 /* Create the command-line buffer empty. */
5996 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_ONE, ECMD_HIDE);
5997 (void)setfname(curbuf, (char_u *)"command-line", NULL, TRUE);
5998 set_option_value((char_u *)"bt", 0L, (char_u *)"nofile", OPT_LOCAL);
5999 set_option_value((char_u *)"swf", 0L, NULL, OPT_LOCAL);
6000 curbuf->b_p_ma = TRUE;
6001 # ifdef FEAT_RIGHTLEFT
6002 curwin->w_p_rl = cmdmsg_rl;
6003 cmdmsg_rl = FALSE;
6004 # endif
6005 # ifdef FEAT_SCROLLBIND
6006 curwin->w_p_scb = FALSE;
6007 # endif
6009 # ifdef FEAT_AUTOCMD
6010 /* Do execute autocommands for setting the filetype (load syntax). */
6011 unblock_autocmds();
6012 # endif
6014 /* Showing the prompt may have set need_wait_return, reset it. */
6015 need_wait_return = FALSE;
6017 histtype = hist_char2type(ccline.cmdfirstc);
6018 if (histtype == HIST_CMD || histtype == HIST_DEBUG)
6020 if (p_wc == TAB)
6022 add_map((char_u *)"<buffer> <Tab> <C-X><C-V>", INSERT);
6023 add_map((char_u *)"<buffer> <Tab> a<C-X><C-V>", NORMAL);
6025 set_option_value((char_u *)"ft", 0L, (char_u *)"vim", OPT_LOCAL);
6028 /* Reset 'textwidth' after setting 'filetype' (the Vim filetype plugin
6029 * sets 'textwidth' to 78). */
6030 curbuf->b_p_tw = 0;
6032 /* Fill the buffer with the history. */
6033 init_history();
6034 if (hislen > 0)
6036 i = hisidx[histtype];
6037 if (i >= 0)
6039 lnum = 0;
6042 if (++i == hislen)
6043 i = 0;
6044 if (history[histtype][i].hisstr != NULL)
6045 ml_append(lnum++, history[histtype][i].hisstr,
6046 (colnr_T)0, FALSE);
6048 while (i != hisidx[histtype]);
6052 /* Replace the empty last line with the current command-line and put the
6053 * cursor there. */
6054 ml_replace(curbuf->b_ml.ml_line_count, ccline.cmdbuff, TRUE);
6055 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
6056 curwin->w_cursor.col = ccline.cmdpos;
6057 changed_line_abv_curs();
6058 invalidate_botline();
6059 redraw_later(SOME_VALID);
6061 /* Save the command line info, can be used recursively. */
6062 save_ccline = ccline;
6063 ccline.cmdbuff = NULL;
6064 ccline.cmdprompt = NULL;
6066 /* No Ex mode here! */
6067 exmode_active = 0;
6069 State = NORMAL;
6070 # ifdef FEAT_MOUSE
6071 setmouse();
6072 # endif
6074 # ifdef FEAT_AUTOCMD
6075 /* Trigger CmdwinEnter autocommands. */
6076 typestr[0] = cmdwin_type;
6077 typestr[1] = NUL;
6078 apply_autocmds(EVENT_CMDWINENTER, typestr, typestr, FALSE, curbuf);
6079 if (restart_edit != 0) /* autocmd with ":startinsert" */
6080 stuffcharReadbuff(K_NOP);
6081 # endif
6083 i = RedrawingDisabled;
6084 RedrawingDisabled = 0;
6087 * Call the main loop until <CR> or CTRL-C is typed.
6089 cmdwin_result = 0;
6090 main_loop(TRUE, FALSE);
6092 RedrawingDisabled = i;
6094 # ifdef FEAT_AUTOCMD
6095 /* Trigger CmdwinLeave autocommands. */
6096 apply_autocmds(EVENT_CMDWINLEAVE, typestr, typestr, FALSE, curbuf);
6097 # endif
6099 /* Restore the command line info. */
6100 ccline = save_ccline;
6101 cmdwin_type = 0;
6103 exmode_active = save_exmode;
6105 /* Safety check: The old window or buffer was deleted: It's a a bug when
6106 * this happens! */
6107 if (!win_valid(old_curwin) || !buf_valid(old_curbuf))
6109 cmdwin_result = Ctrl_C;
6110 EMSG(_("E199: Active window or buffer deleted"));
6112 else
6114 # if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6115 /* autocmds may abort script processing */
6116 if (aborting() && cmdwin_result != K_IGNORE)
6117 cmdwin_result = Ctrl_C;
6118 # endif
6119 /* Set the new command line from the cmdline buffer. */
6120 vim_free(ccline.cmdbuff);
6121 if (cmdwin_result == K_XF1 || cmdwin_result == K_XF2) /* :qa[!] typed */
6123 char *p = (cmdwin_result == K_XF2) ? "qa" : "qa!";
6125 if (histtype == HIST_CMD)
6127 /* Execute the command directly. */
6128 ccline.cmdbuff = vim_strsave((char_u *)p);
6129 cmdwin_result = CAR;
6131 else
6133 /* First need to cancel what we were doing. */
6134 ccline.cmdbuff = NULL;
6135 stuffcharReadbuff(':');
6136 stuffReadbuff((char_u *)p);
6137 stuffcharReadbuff(CAR);
6140 else if (cmdwin_result == K_XF2) /* :qa typed */
6142 ccline.cmdbuff = vim_strsave((char_u *)"qa");
6143 cmdwin_result = CAR;
6145 else
6146 ccline.cmdbuff = vim_strsave(ml_get_curline());
6147 if (ccline.cmdbuff == NULL)
6148 cmdwin_result = Ctrl_C;
6149 else
6151 ccline.cmdlen = (int)STRLEN(ccline.cmdbuff);
6152 ccline.cmdbufflen = ccline.cmdlen + 1;
6153 ccline.cmdpos = curwin->w_cursor.col;
6154 if (ccline.cmdpos > ccline.cmdlen)
6155 ccline.cmdpos = ccline.cmdlen;
6156 if (cmdwin_result == K_IGNORE)
6158 set_cmdspos_cursor();
6159 redrawcmd();
6163 # ifdef FEAT_AUTOCMD
6164 /* Don't execute autocommands while deleting the window. */
6165 block_autocmds();
6166 # endif
6167 wp = curwin;
6168 bp = curbuf;
6169 win_goto(old_curwin);
6170 win_close(wp, TRUE);
6171 close_buffer(NULL, bp, DOBUF_WIPE);
6173 /* Restore window sizes. */
6174 win_size_restore(&winsizes);
6176 # ifdef FEAT_AUTOCMD
6177 unblock_autocmds();
6178 # endif
6181 ga_clear(&winsizes);
6182 restart_edit = save_restart_edit;
6183 # ifdef FEAT_RIGHTLEFT
6184 cmdmsg_rl = save_cmdmsg_rl;
6185 # endif
6187 State = save_State;
6188 # ifdef FEAT_MOUSE
6189 setmouse();
6190 # endif
6192 return cmdwin_result;
6194 #endif /* FEAT_CMDWIN */
6197 * Used for commands that either take a simple command string argument, or:
6198 * cmd << endmarker
6199 * {script}
6200 * endmarker
6201 * Returns a pointer to allocated memory with {script} or NULL.
6203 char_u *
6204 script_get(eap, cmd)
6205 exarg_T *eap;
6206 char_u *cmd;
6208 char_u *theline;
6209 char *end_pattern = NULL;
6210 char dot[] = ".";
6211 garray_T ga;
6213 if (cmd[0] != '<' || cmd[1] != '<' || eap->getline == NULL)
6214 return NULL;
6216 ga_init2(&ga, 1, 0x400);
6218 if (cmd[2] != NUL)
6219 end_pattern = (char *)skipwhite(cmd + 2);
6220 else
6221 end_pattern = dot;
6223 for (;;)
6225 theline = eap->getline(
6226 #ifdef FEAT_EVAL
6227 eap->cstack->cs_looplevel > 0 ? -1 :
6228 #endif
6229 NUL, eap->cookie, 0);
6231 if (theline == NULL || STRCMP(end_pattern, theline) == 0)
6232 break;
6234 ga_concat(&ga, theline);
6235 ga_append(&ga, '\n');
6236 vim_free(theline);
6238 ga_append(&ga, NUL);
6240 return (char_u *)ga.ga_data;