Patch 7.1.045
[MacVim.git] / src / ex_getln.c
blob206da806517d4d892ac70cdc2c92d31c341f57f6
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 */
338 c = safe_vgetc();
339 if (KeyTyped)
341 some_key_typed = TRUE;
342 #ifdef FEAT_RIGHTLEFT
343 if (cmd_hkmap)
344 c = hkmap(c);
345 # ifdef FEAT_FKMAP
346 if (cmd_fkmap)
347 c = cmdl_fkmap(c);
348 # endif
349 if (cmdmsg_rl && !KeyStuffed)
351 /* Invert horizontal movements and operations. Only when
352 * typed by the user directly, not when the result of a
353 * mapping. */
354 switch (c)
356 case K_RIGHT: c = K_LEFT; break;
357 case K_S_RIGHT: c = K_S_LEFT; break;
358 case K_C_RIGHT: c = K_C_LEFT; break;
359 case K_LEFT: c = K_RIGHT; break;
360 case K_S_LEFT: c = K_S_RIGHT; break;
361 case K_C_LEFT: c = K_C_RIGHT; break;
364 #endif
368 * Ignore got_int when CTRL-C was typed here.
369 * Don't ignore it in :global, we really need to break then, e.g., for
370 * ":g/pat/normal /pat" (without the <CR>).
371 * Don't ignore it for the input() function.
373 if ((c == Ctrl_C
374 #ifdef UNIX
375 || c == intr_char
376 #endif
378 #if defined(FEAT_EVAL) || defined(FEAT_CRYPT)
379 && firstc != '@'
380 #endif
381 #ifdef FEAT_EVAL
382 && !break_ctrl_c
383 #endif
384 && !global_busy)
385 got_int = FALSE;
387 #ifdef FEAT_CMDHIST
388 /* free old command line when finished moving around in the history
389 * list */
390 if (lookfor != NULL
391 && c != K_S_DOWN && c != K_S_UP
392 && c != K_DOWN && c != K_UP
393 && c != K_PAGEDOWN && c != K_PAGEUP
394 && c != K_KPAGEDOWN && c != K_KPAGEUP
395 && c != K_LEFT && c != K_RIGHT
396 && (xpc.xp_numfiles > 0 || (c != Ctrl_P && c != Ctrl_N)))
398 vim_free(lookfor);
399 lookfor = NULL;
401 #endif
404 * <S-Tab> works like CTRL-P (unless 'wc' is <S-Tab>).
406 if (c != p_wc && c == K_S_TAB && xpc.xp_numfiles != -1)
407 c = Ctrl_P;
409 #ifdef FEAT_WILDMENU
410 /* Special translations for 'wildmenu' */
411 if (did_wild_list && p_wmnu)
413 if (c == K_LEFT)
414 c = Ctrl_P;
415 else if (c == K_RIGHT)
416 c = Ctrl_N;
418 /* Hitting CR after "emenu Name.": complete submenu */
419 if (xpc.xp_context == EXPAND_MENUNAMES && p_wmnu
420 && ccline.cmdpos > 1
421 && ccline.cmdbuff[ccline.cmdpos - 1] == '.'
422 && ccline.cmdbuff[ccline.cmdpos - 2] != '\\'
423 && (c == '\n' || c == '\r' || c == K_KENTER))
424 c = K_DOWN;
425 #endif
427 /* free expanded names when finished walking through matches */
428 if (xpc.xp_numfiles != -1
429 && !(c == p_wc && KeyTyped) && c != p_wcm
430 && c != Ctrl_N && c != Ctrl_P && c != Ctrl_A
431 && c != Ctrl_L)
433 (void)ExpandOne(&xpc, NULL, NULL, 0, WILD_FREE);
434 did_wild_list = FALSE;
435 #ifdef FEAT_WILDMENU
436 if (!p_wmnu || (c != K_UP && c != K_DOWN))
437 #endif
438 xpc.xp_context = EXPAND_NOTHING;
439 wim_index = 0;
440 #ifdef FEAT_WILDMENU
441 if (p_wmnu && wild_menu_showing != 0)
443 int skt = KeyTyped;
444 int old_RedrawingDisabled = RedrawingDisabled;
446 if (ccline.input_fn)
447 RedrawingDisabled = 0;
449 if (wild_menu_showing == WM_SCROLLED)
451 /* Entered command line, move it up */
452 cmdline_row--;
453 redrawcmd();
455 else if (save_p_ls != -1)
457 /* restore 'laststatus' and 'winminheight' */
458 p_ls = save_p_ls;
459 p_wmh = save_p_wmh;
460 last_status(FALSE);
461 save_cmdline(&save_ccline);
462 update_screen(VALID); /* redraw the screen NOW */
463 restore_cmdline(&save_ccline);
464 redrawcmd();
465 save_p_ls = -1;
467 else
469 # ifdef FEAT_VERTSPLIT
470 win_redraw_last_status(topframe);
471 # else
472 lastwin->w_redr_status = TRUE;
473 # endif
474 redraw_statuslines();
476 KeyTyped = skt;
477 wild_menu_showing = 0;
478 if (ccline.input_fn)
479 RedrawingDisabled = old_RedrawingDisabled;
481 #endif
484 #ifdef FEAT_WILDMENU
485 /* Special translations for 'wildmenu' */
486 if (xpc.xp_context == EXPAND_MENUNAMES && p_wmnu)
488 /* Hitting <Down> after "emenu Name.": complete submenu */
489 if (c == K_DOWN && ccline.cmdpos > 0
490 && ccline.cmdbuff[ccline.cmdpos - 1] == '.')
491 c = p_wc;
492 else if (c == K_UP)
494 /* Hitting <Up>: Remove one submenu name in front of the
495 * cursor */
496 int found = FALSE;
498 j = (int)(xpc.xp_pattern - ccline.cmdbuff);
499 i = 0;
500 while (--j > 0)
502 /* check for start of menu name */
503 if (ccline.cmdbuff[j] == ' '
504 && ccline.cmdbuff[j - 1] != '\\')
506 i = j + 1;
507 break;
509 /* check for start of submenu name */
510 if (ccline.cmdbuff[j] == '.'
511 && ccline.cmdbuff[j - 1] != '\\')
513 if (found)
515 i = j + 1;
516 break;
518 else
519 found = TRUE;
522 if (i > 0)
523 cmdline_del(i);
524 c = p_wc;
525 xpc.xp_context = EXPAND_NOTHING;
528 if ((xpc.xp_context == EXPAND_FILES
529 || xpc.xp_context == EXPAND_SHELLCMD) && p_wmnu)
531 char_u upseg[5];
533 upseg[0] = PATHSEP;
534 upseg[1] = '.';
535 upseg[2] = '.';
536 upseg[3] = PATHSEP;
537 upseg[4] = NUL;
539 if (c == K_DOWN
540 && ccline.cmdpos > 0
541 && ccline.cmdbuff[ccline.cmdpos - 1] == PATHSEP
542 && (ccline.cmdpos < 3
543 || ccline.cmdbuff[ccline.cmdpos - 2] != '.'
544 || ccline.cmdbuff[ccline.cmdpos - 3] != '.'))
546 /* go down a directory */
547 c = p_wc;
549 else if (STRNCMP(xpc.xp_pattern, upseg + 1, 3) == 0 && c == K_DOWN)
551 /* If in a direct ancestor, strip off one ../ to go down */
552 int found = FALSE;
554 j = ccline.cmdpos;
555 i = (int)(xpc.xp_pattern - ccline.cmdbuff);
556 while (--j > i)
558 #ifdef FEAT_MBYTE
559 if (has_mbyte)
560 j -= (*mb_head_off)(ccline.cmdbuff, ccline.cmdbuff + j);
561 #endif
562 if (vim_ispathsep(ccline.cmdbuff[j]))
564 found = TRUE;
565 break;
568 if (found
569 && ccline.cmdbuff[j - 1] == '.'
570 && ccline.cmdbuff[j - 2] == '.'
571 && (vim_ispathsep(ccline.cmdbuff[j - 3]) || j == i + 2))
573 cmdline_del(j - 2);
574 c = p_wc;
577 else if (c == K_UP)
579 /* go up a directory */
580 int found = FALSE;
582 j = ccline.cmdpos - 1;
583 i = (int)(xpc.xp_pattern - ccline.cmdbuff);
584 while (--j > i)
586 #ifdef FEAT_MBYTE
587 if (has_mbyte)
588 j -= (*mb_head_off)(ccline.cmdbuff, ccline.cmdbuff + j);
589 #endif
590 if (vim_ispathsep(ccline.cmdbuff[j])
591 #ifdef BACKSLASH_IN_FILENAME
592 && vim_strchr(" *?[{`$%#", ccline.cmdbuff[j + 1])
593 == NULL
594 #endif
597 if (found)
599 i = j + 1;
600 break;
602 else
603 found = TRUE;
607 if (!found)
608 j = i;
609 else if (STRNCMP(ccline.cmdbuff + j, upseg, 4) == 0)
610 j += 4;
611 else if (STRNCMP(ccline.cmdbuff + j, upseg + 1, 3) == 0
612 && j == i)
613 j += 3;
614 else
615 j = 0;
616 if (j > 0)
618 /* TODO this is only for DOS/UNIX systems - need to put in
619 * machine-specific stuff here and in upseg init */
620 cmdline_del(j);
621 put_on_cmdline(upseg + 1, 3, FALSE);
623 else if (ccline.cmdpos > i)
624 cmdline_del(i);
625 c = p_wc;
628 #if 0 /* If enabled <Down> on a file takes you _completely_ out of wildmenu */
629 if (p_wmnu
630 && (xpc.xp_context == EXPAND_FILES
631 || xpc.xp_context == EXPAND_MENUNAMES)
632 && (c == K_UP || c == K_DOWN))
633 xpc.xp_context = EXPAND_NOTHING;
634 #endif
636 #endif /* FEAT_WILDMENU */
638 /* CTRL-\ CTRL-N goes to Normal mode, CTRL-\ CTRL-G goes to Insert
639 * mode when 'insertmode' is set, CTRL-\ e prompts for an expression. */
640 if (c == Ctrl_BSL)
642 ++no_mapping;
643 ++allow_keys;
644 c = safe_vgetc();
645 --no_mapping;
646 --allow_keys;
647 /* CTRL-\ e doesn't work when obtaining an expression. */
648 if (c != Ctrl_N && c != Ctrl_G
649 && (c != 'e' || ccline.cmdfirstc == '='))
651 vungetc(c);
652 c = Ctrl_BSL;
654 #ifdef FEAT_EVAL
655 else if (c == 'e')
657 char_u *p = NULL;
660 * Replace the command line with the result of an expression.
661 * Need to save and restore the current command line, to be
662 * able to enter a new one...
664 if (ccline.cmdpos == ccline.cmdlen)
665 new_cmdpos = 99999; /* keep it at the end */
666 else
667 new_cmdpos = ccline.cmdpos;
669 save_cmdline(&save_ccline);
670 c = get_expr_register();
671 restore_cmdline(&save_ccline);
672 if (c == '=')
674 /* Need to save and restore ccline. And set "textlock"
675 * to avoid nasty things like going to another buffer when
676 * evaluating an expression. */
677 save_cmdline(&save_ccline);
678 ++textlock;
679 p = get_expr_line();
680 --textlock;
681 restore_cmdline(&save_ccline);
683 if (p != NULL && realloc_cmdbuff((int)STRLEN(p) + 1) == OK)
685 ccline.cmdlen = (int)STRLEN(p);
686 STRCPY(ccline.cmdbuff, p);
687 vim_free(p);
689 /* Restore the cursor or use the position set with
690 * set_cmdline_pos(). */
691 if (new_cmdpos > ccline.cmdlen)
692 ccline.cmdpos = ccline.cmdlen;
693 else
694 ccline.cmdpos = new_cmdpos;
696 KeyTyped = FALSE; /* Don't do p_wc completion. */
697 redrawcmd();
698 goto cmdline_changed;
701 beep_flush();
702 c = ESC;
704 #endif
705 else
707 if (c == Ctrl_G && p_im && restart_edit == 0)
708 restart_edit = 'a';
709 gotesc = TRUE; /* will free ccline.cmdbuff after putting it
710 in history */
711 goto returncmd; /* back to Normal mode */
715 #ifdef FEAT_CMDWIN
716 if (c == cedit_key || c == K_CMDWIN)
719 * Open a window to edit the command line (and history).
721 c = ex_window();
722 some_key_typed = TRUE;
724 # ifdef FEAT_DIGRAPHS
725 else
726 # endif
727 #endif
728 #ifdef FEAT_DIGRAPHS
729 c = do_digraph(c);
730 #endif
732 if (c == '\n' || c == '\r' || c == K_KENTER || (c == ESC
733 && (!KeyTyped || vim_strchr(p_cpo, CPO_ESC) != NULL)))
735 /* In Ex mode a backslash escapes a newline. */
736 if (exmode_active
737 && c != ESC
738 && ccline.cmdpos == ccline.cmdlen
739 && ccline.cmdpos > 0
740 && ccline.cmdbuff[ccline.cmdpos - 1] == '\\')
742 if (c == K_KENTER)
743 c = '\n';
745 else
747 gotesc = FALSE; /* Might have typed ESC previously, don't
748 truncate the cmdline now. */
749 if (ccheck_abbr(c + ABBR_OFF))
750 goto cmdline_changed;
751 if (!cmd_silent)
753 windgoto(msg_row, 0);
754 out_flush();
756 break;
761 * Completion for 'wildchar' or 'wildcharm' key.
762 * - hitting <ESC> twice means: abandon command line.
763 * - wildcard expansion is only done when the 'wildchar' key is really
764 * typed, not when it comes from a macro
766 if ((c == p_wc && !gotesc && KeyTyped) || c == p_wcm)
768 if (xpc.xp_numfiles > 0) /* typed p_wc at least twice */
770 /* if 'wildmode' contains "list" may still need to list */
771 if (xpc.xp_numfiles > 1
772 && !did_wild_list
773 && (wim_flags[wim_index] & WIM_LIST))
775 (void)showmatches(&xpc, FALSE);
776 redrawcmd();
777 did_wild_list = TRUE;
779 if (wim_flags[wim_index] & WIM_LONGEST)
780 res = nextwild(&xpc, WILD_LONGEST, WILD_NO_BEEP);
781 else if (wim_flags[wim_index] & WIM_FULL)
782 res = nextwild(&xpc, WILD_NEXT, WILD_NO_BEEP);
783 else
784 res = OK; /* don't insert 'wildchar' now */
786 else /* typed p_wc first time */
788 wim_index = 0;
789 j = ccline.cmdpos;
790 /* if 'wildmode' first contains "longest", get longest
791 * common part */
792 if (wim_flags[0] & WIM_LONGEST)
793 res = nextwild(&xpc, WILD_LONGEST, WILD_NO_BEEP);
794 else
795 res = nextwild(&xpc, WILD_EXPAND_KEEP, WILD_NO_BEEP);
797 /* if interrupted while completing, behave like it failed */
798 if (got_int)
800 (void)vpeekc(); /* remove <C-C> from input stream */
801 got_int = FALSE; /* don't abandon the command line */
802 (void)ExpandOne(&xpc, NULL, NULL, 0, WILD_FREE);
803 #ifdef FEAT_WILDMENU
804 xpc.xp_context = EXPAND_NOTHING;
805 #endif
806 goto cmdline_changed;
809 /* when more than one match, and 'wildmode' first contains
810 * "list", or no change and 'wildmode' contains "longest,list",
811 * list all matches */
812 if (res == OK && xpc.xp_numfiles > 1)
814 /* a "longest" that didn't do anything is skipped (but not
815 * "list:longest") */
816 if (wim_flags[0] == WIM_LONGEST && ccline.cmdpos == j)
817 wim_index = 1;
818 if ((wim_flags[wim_index] & WIM_LIST)
819 #ifdef FEAT_WILDMENU
820 || (p_wmnu && (wim_flags[wim_index] & WIM_FULL) != 0)
821 #endif
824 if (!(wim_flags[0] & WIM_LONGEST))
826 #ifdef FEAT_WILDMENU
827 int p_wmnu_save = p_wmnu;
828 p_wmnu = 0;
829 #endif
830 nextwild(&xpc, WILD_PREV, 0); /* remove match */
831 #ifdef FEAT_WILDMENU
832 p_wmnu = p_wmnu_save;
833 #endif
835 #ifdef FEAT_WILDMENU
836 (void)showmatches(&xpc, p_wmnu
837 && ((wim_flags[wim_index] & WIM_LIST) == 0));
838 #else
839 (void)showmatches(&xpc, FALSE);
840 #endif
841 redrawcmd();
842 did_wild_list = TRUE;
843 if (wim_flags[wim_index] & WIM_LONGEST)
844 nextwild(&xpc, WILD_LONGEST, WILD_NO_BEEP);
845 else if (wim_flags[wim_index] & WIM_FULL)
846 nextwild(&xpc, WILD_NEXT, WILD_NO_BEEP);
848 else
849 vim_beep();
851 #ifdef FEAT_WILDMENU
852 else if (xpc.xp_numfiles == -1)
853 xpc.xp_context = EXPAND_NOTHING;
854 #endif
856 if (wim_index < 3)
857 ++wim_index;
858 if (c == ESC)
859 gotesc = TRUE;
860 if (res == OK)
861 goto cmdline_changed;
864 gotesc = FALSE;
866 /* <S-Tab> goes to last match, in a clumsy way */
867 if (c == K_S_TAB && KeyTyped)
869 if (nextwild(&xpc, WILD_EXPAND_KEEP, 0) == OK
870 && nextwild(&xpc, WILD_PREV, 0) == OK
871 && nextwild(&xpc, WILD_PREV, 0) == OK)
872 goto cmdline_changed;
875 if (c == NUL || c == K_ZERO) /* NUL is stored as NL */
876 c = NL;
878 do_abbr = TRUE; /* default: check for abbreviation */
881 * Big switch for a typed command line character.
883 switch (c)
885 case K_BS:
886 case Ctrl_H:
887 case K_DEL:
888 case K_KDEL:
889 case Ctrl_W:
890 #ifdef FEAT_FKMAP
891 if (cmd_fkmap && c == K_BS)
892 c = K_DEL;
893 #endif
894 if (c == K_KDEL)
895 c = K_DEL;
898 * delete current character is the same as backspace on next
899 * character, except at end of line
901 if (c == K_DEL && ccline.cmdpos != ccline.cmdlen)
902 ++ccline.cmdpos;
903 #ifdef FEAT_MBYTE
904 if (has_mbyte && c == K_DEL)
905 ccline.cmdpos += mb_off_next(ccline.cmdbuff,
906 ccline.cmdbuff + ccline.cmdpos);
907 #endif
908 if (ccline.cmdpos > 0)
910 char_u *p;
912 j = ccline.cmdpos;
913 p = ccline.cmdbuff + j;
914 #ifdef FEAT_MBYTE
915 if (has_mbyte)
917 p = mb_prevptr(ccline.cmdbuff, p);
918 if (c == Ctrl_W)
920 while (p > ccline.cmdbuff && vim_isspace(*p))
921 p = mb_prevptr(ccline.cmdbuff, p);
922 i = mb_get_class(p);
923 while (p > ccline.cmdbuff && mb_get_class(p) == i)
924 p = mb_prevptr(ccline.cmdbuff, p);
925 if (mb_get_class(p) != i)
926 p += (*mb_ptr2len)(p);
929 else
930 #endif
931 if (c == Ctrl_W)
933 while (p > ccline.cmdbuff && vim_isspace(p[-1]))
934 --p;
935 i = vim_iswordc(p[-1]);
936 while (p > ccline.cmdbuff && !vim_isspace(p[-1])
937 && vim_iswordc(p[-1]) == i)
938 --p;
940 else
941 --p;
942 ccline.cmdpos = (int)(p - ccline.cmdbuff);
943 ccline.cmdlen -= j - ccline.cmdpos;
944 i = ccline.cmdpos;
945 while (i < ccline.cmdlen)
946 ccline.cmdbuff[i++] = ccline.cmdbuff[j++];
948 /* Truncate at the end, required for multi-byte chars. */
949 ccline.cmdbuff[ccline.cmdlen] = NUL;
950 redrawcmd();
952 else if (ccline.cmdlen == 0 && c != Ctrl_W
953 && ccline.cmdprompt == NULL && indent == 0)
955 /* In ex and debug mode it doesn't make sense to return. */
956 if (exmode_active
957 #ifdef FEAT_EVAL
958 || ccline.cmdfirstc == '>'
959 #endif
961 goto cmdline_not_changed;
963 vim_free(ccline.cmdbuff); /* no commandline to return */
964 ccline.cmdbuff = NULL;
965 if (!cmd_silent)
967 #ifdef FEAT_RIGHTLEFT
968 if (cmdmsg_rl)
969 msg_col = Columns;
970 else
971 #endif
972 msg_col = 0;
973 msg_putchar(' '); /* delete ':' */
975 redraw_cmdline = TRUE;
976 goto returncmd; /* back to cmd mode */
978 goto cmdline_changed;
980 case K_INS:
981 case K_KINS:
982 #ifdef FEAT_FKMAP
983 /* if Farsi mode set, we are in reverse insert mode -
984 Do not change the mode */
985 if (cmd_fkmap)
986 beep_flush();
987 else
988 #endif
989 ccline.overstrike = !ccline.overstrike;
990 #ifdef CURSOR_SHAPE
991 ui_cursor_shape(); /* may show different cursor shape */
992 #endif
993 goto cmdline_not_changed;
995 case Ctrl_HAT:
996 if (map_to_exists_mode((char_u *)"", LANGMAP, FALSE))
998 /* ":lmap" mappings exists, toggle use of mappings. */
999 State ^= LANGMAP;
1000 #ifdef USE_IM_CONTROL
1001 im_set_active(FALSE); /* Disable input method */
1002 #endif
1003 if (b_im_ptr != NULL)
1005 if (State & LANGMAP)
1006 *b_im_ptr = B_IMODE_LMAP;
1007 else
1008 *b_im_ptr = B_IMODE_NONE;
1011 #ifdef USE_IM_CONTROL
1012 else
1014 /* There are no ":lmap" mappings, toggle IM. When
1015 * 'imdisable' is set don't try getting the status, it's
1016 * always off. */
1017 if ((p_imdisable && b_im_ptr != NULL)
1018 ? *b_im_ptr == B_IMODE_IM : im_get_status())
1020 im_set_active(FALSE); /* Disable input method */
1021 if (b_im_ptr != NULL)
1022 *b_im_ptr = B_IMODE_NONE;
1024 else
1026 im_set_active(TRUE); /* Enable input method */
1027 if (b_im_ptr != NULL)
1028 *b_im_ptr = B_IMODE_IM;
1031 #endif
1032 if (b_im_ptr != NULL)
1034 if (b_im_ptr == &curbuf->b_p_iminsert)
1035 set_iminsert_global();
1036 else
1037 set_imsearch_global();
1039 #ifdef CURSOR_SHAPE
1040 ui_cursor_shape(); /* may show different cursor shape */
1041 #endif
1042 #if defined(FEAT_WINDOWS) && defined(FEAT_KEYMAP)
1043 /* Show/unshow value of 'keymap' in status lines later. */
1044 status_redraw_curbuf();
1045 #endif
1046 goto cmdline_not_changed;
1048 /* case '@': only in very old vi */
1049 case Ctrl_U:
1050 /* delete all characters left of the cursor */
1051 j = ccline.cmdpos;
1052 ccline.cmdlen -= j;
1053 i = ccline.cmdpos = 0;
1054 while (i < ccline.cmdlen)
1055 ccline.cmdbuff[i++] = ccline.cmdbuff[j++];
1056 /* Truncate at the end, required for multi-byte chars. */
1057 ccline.cmdbuff[ccline.cmdlen] = NUL;
1058 redrawcmd();
1059 goto cmdline_changed;
1061 #ifdef FEAT_CLIPBOARD
1062 case Ctrl_Y:
1063 /* Copy the modeless selection, if there is one. */
1064 if (clip_star.state != SELECT_CLEARED)
1066 if (clip_star.state == SELECT_DONE)
1067 clip_copy_modeless_selection(TRUE);
1068 goto cmdline_not_changed;
1070 break;
1071 #endif
1073 case ESC: /* get here if p_wc != ESC or when ESC typed twice */
1074 case Ctrl_C:
1075 /* In exmode it doesn't make sense to return. Except when
1076 * ":normal" runs out of characters. */
1077 if (exmode_active
1078 #ifdef FEAT_EX_EXTRA
1079 && (ex_normal_busy == 0 || typebuf.tb_len > 0)
1080 #endif
1082 goto cmdline_not_changed;
1084 gotesc = TRUE; /* will free ccline.cmdbuff after
1085 putting it in history */
1086 goto returncmd; /* back to cmd mode */
1088 case Ctrl_R: /* insert register */
1089 #ifdef USE_ON_FLY_SCROLL
1090 dont_scroll = TRUE; /* disallow scrolling here */
1091 #endif
1092 putcmdline('"', TRUE);
1093 ++no_mapping;
1094 i = c = safe_vgetc(); /* CTRL-R <char> */
1095 if (i == Ctrl_O)
1096 i = Ctrl_R; /* CTRL-R CTRL-O == CTRL-R CTRL-R */
1097 if (i == Ctrl_R)
1098 c = safe_vgetc(); /* CTRL-R CTRL-R <char> */
1099 --no_mapping;
1100 #ifdef FEAT_EVAL
1102 * Insert the result of an expression.
1103 * Need to save the current command line, to be able to enter
1104 * a new one...
1106 new_cmdpos = -1;
1107 if (c == '=')
1109 if (ccline.cmdfirstc == '=')/* can't do this recursively */
1111 beep_flush();
1112 c = ESC;
1114 else
1116 save_cmdline(&save_ccline);
1117 c = get_expr_register();
1118 restore_cmdline(&save_ccline);
1121 #endif
1122 if (c != ESC) /* use ESC to cancel inserting register */
1124 cmdline_paste(c, i == Ctrl_R, FALSE);
1126 #ifdef FEAT_EVAL
1127 /* When there was a serious error abort getting the
1128 * command line. */
1129 if (aborting())
1131 gotesc = TRUE; /* will free ccline.cmdbuff after
1132 putting it in history */
1133 goto returncmd; /* back to cmd mode */
1135 #endif
1136 KeyTyped = FALSE; /* Don't do p_wc completion. */
1137 #ifdef FEAT_EVAL
1138 if (new_cmdpos >= 0)
1140 /* set_cmdline_pos() was used */
1141 if (new_cmdpos > ccline.cmdlen)
1142 ccline.cmdpos = ccline.cmdlen;
1143 else
1144 ccline.cmdpos = new_cmdpos;
1146 #endif
1148 redrawcmd();
1149 goto cmdline_changed;
1151 case Ctrl_D:
1152 if (showmatches(&xpc, FALSE) == EXPAND_NOTHING)
1153 break; /* Use ^D as normal char instead */
1155 redrawcmd();
1156 continue; /* don't do incremental search now */
1158 case K_RIGHT:
1159 case K_S_RIGHT:
1160 case K_C_RIGHT:
1163 if (ccline.cmdpos >= ccline.cmdlen)
1164 break;
1165 i = cmdline_charsize(ccline.cmdpos);
1166 if (KeyTyped && ccline.cmdspos + i >= Columns * Rows)
1167 break;
1168 ccline.cmdspos += i;
1169 #ifdef FEAT_MBYTE
1170 if (has_mbyte)
1171 ccline.cmdpos += (*mb_ptr2len)(ccline.cmdbuff
1172 + ccline.cmdpos);
1173 else
1174 #endif
1175 ++ccline.cmdpos;
1177 while ((c == K_S_RIGHT || c == K_C_RIGHT
1178 || (mod_mask & (MOD_MASK_SHIFT|MOD_MASK_CTRL)))
1179 && ccline.cmdbuff[ccline.cmdpos] != ' ');
1180 #ifdef FEAT_MBYTE
1181 if (has_mbyte)
1182 set_cmdspos_cursor();
1183 #endif
1184 goto cmdline_not_changed;
1186 case K_LEFT:
1187 case K_S_LEFT:
1188 case K_C_LEFT:
1191 if (ccline.cmdpos == 0)
1192 break;
1193 --ccline.cmdpos;
1194 #ifdef FEAT_MBYTE
1195 if (has_mbyte) /* move to first byte of char */
1196 ccline.cmdpos -= (*mb_head_off)(ccline.cmdbuff,
1197 ccline.cmdbuff + ccline.cmdpos);
1198 #endif
1199 ccline.cmdspos -= cmdline_charsize(ccline.cmdpos);
1201 while ((c == K_S_LEFT || c == K_C_LEFT
1202 || (mod_mask & (MOD_MASK_SHIFT|MOD_MASK_CTRL)))
1203 && ccline.cmdbuff[ccline.cmdpos - 1] != ' ');
1204 #ifdef FEAT_MBYTE
1205 if (has_mbyte)
1206 set_cmdspos_cursor();
1207 #endif
1208 goto cmdline_not_changed;
1210 case K_IGNORE:
1211 goto cmdline_not_changed; /* Ignore mouse */
1213 #ifdef FEAT_GUI_W32
1214 /* On Win32 ignore <M-F4>, we get it when closing the window was
1215 * cancelled. */
1216 case K_F4:
1217 if (mod_mask == MOD_MASK_ALT)
1219 redrawcmd(); /* somehow the cmdline is cleared */
1220 goto cmdline_not_changed;
1222 break;
1223 #endif
1225 #ifdef FEAT_MOUSE
1226 case K_MIDDLEDRAG:
1227 case K_MIDDLERELEASE:
1228 goto cmdline_not_changed; /* Ignore mouse */
1230 case K_MIDDLEMOUSE:
1231 # ifdef FEAT_GUI
1232 /* When GUI is active, also paste when 'mouse' is empty */
1233 if (!gui.in_use)
1234 # endif
1235 if (!mouse_has(MOUSE_COMMAND))
1236 goto cmdline_not_changed; /* Ignore mouse */
1237 # ifdef FEAT_CLIPBOARD
1238 if (clip_star.available)
1239 cmdline_paste('*', TRUE, TRUE);
1240 else
1241 # endif
1242 cmdline_paste(0, TRUE, TRUE);
1243 redrawcmd();
1244 goto cmdline_changed;
1246 # ifdef FEAT_DND
1247 case K_DROP:
1248 cmdline_paste('~', TRUE, FALSE);
1249 redrawcmd();
1250 goto cmdline_changed;
1251 # endif
1253 case K_LEFTDRAG:
1254 case K_LEFTRELEASE:
1255 case K_RIGHTDRAG:
1256 case K_RIGHTRELEASE:
1257 /* Ignore drag and release events when the button-down wasn't
1258 * seen before. */
1259 if (ignore_drag_release)
1260 goto cmdline_not_changed;
1261 /* FALLTHROUGH */
1262 case K_LEFTMOUSE:
1263 case K_RIGHTMOUSE:
1264 if (c == K_LEFTRELEASE || c == K_RIGHTRELEASE)
1265 ignore_drag_release = TRUE;
1266 else
1267 ignore_drag_release = FALSE;
1268 # ifdef FEAT_GUI
1269 /* When GUI is active, also move when 'mouse' is empty */
1270 if (!gui.in_use)
1271 # endif
1272 if (!mouse_has(MOUSE_COMMAND))
1273 goto cmdline_not_changed; /* Ignore mouse */
1274 # ifdef FEAT_CLIPBOARD
1275 if (mouse_row < cmdline_row && clip_star.available)
1277 int button, is_click, is_drag;
1280 * Handle modeless selection.
1282 button = get_mouse_button(KEY2TERMCAP1(c),
1283 &is_click, &is_drag);
1284 if (mouse_model_popup() && button == MOUSE_LEFT
1285 && (mod_mask & MOD_MASK_SHIFT))
1287 /* Translate shift-left to right button. */
1288 button = MOUSE_RIGHT;
1289 mod_mask &= ~MOD_MASK_SHIFT;
1291 clip_modeless(button, is_click, is_drag);
1292 goto cmdline_not_changed;
1294 # endif
1296 set_cmdspos();
1297 for (ccline.cmdpos = 0; ccline.cmdpos < ccline.cmdlen;
1298 ++ccline.cmdpos)
1300 i = cmdline_charsize(ccline.cmdpos);
1301 if (mouse_row <= cmdline_row + ccline.cmdspos / Columns
1302 && mouse_col < ccline.cmdspos % Columns + i)
1303 break;
1304 # ifdef FEAT_MBYTE
1305 if (has_mbyte)
1307 /* Count ">" for double-wide char that doesn't fit. */
1308 correct_cmdspos(ccline.cmdpos, i);
1309 ccline.cmdpos += (*mb_ptr2len)(ccline.cmdbuff
1310 + ccline.cmdpos) - 1;
1312 # endif
1313 ccline.cmdspos += i;
1315 goto cmdline_not_changed;
1317 /* Mouse scroll wheel: ignored here */
1318 case K_MOUSEDOWN:
1319 case K_MOUSEUP:
1320 /* Alternate buttons ignored here */
1321 case K_X1MOUSE:
1322 case K_X1DRAG:
1323 case K_X1RELEASE:
1324 case K_X2MOUSE:
1325 case K_X2DRAG:
1326 case K_X2RELEASE:
1327 goto cmdline_not_changed;
1329 #endif /* FEAT_MOUSE */
1331 #ifdef FEAT_GUI
1332 case K_LEFTMOUSE_NM: /* mousefocus click, ignored */
1333 case K_LEFTRELEASE_NM:
1334 goto cmdline_not_changed;
1336 case K_VER_SCROLLBAR:
1337 if (msg_scrolled == 0)
1339 gui_do_scroll();
1340 redrawcmd();
1342 goto cmdline_not_changed;
1344 case K_HOR_SCROLLBAR:
1345 if (msg_scrolled == 0)
1347 gui_do_horiz_scroll();
1348 redrawcmd();
1350 goto cmdline_not_changed;
1351 #endif
1352 #ifdef FEAT_GUI_TABLINE
1353 case K_TABLINE:
1354 case K_TABMENU:
1355 /* Don't want to change any tabs here. Make sure the same tab
1356 * is still selected. */
1357 if (gui_use_tabline())
1358 gui_mch_set_curtab(tabpage_index(curtab));
1359 goto cmdline_not_changed;
1360 #endif
1362 case K_SELECT: /* end of Select mode mapping - ignore */
1363 goto cmdline_not_changed;
1365 case Ctrl_B: /* begin of command line */
1366 case K_HOME:
1367 case K_KHOME:
1368 case K_S_HOME:
1369 case K_C_HOME:
1370 ccline.cmdpos = 0;
1371 set_cmdspos();
1372 goto cmdline_not_changed;
1374 case Ctrl_E: /* end of command line */
1375 case K_END:
1376 case K_KEND:
1377 case K_S_END:
1378 case K_C_END:
1379 ccline.cmdpos = ccline.cmdlen;
1380 set_cmdspos_cursor();
1381 goto cmdline_not_changed;
1383 case Ctrl_A: /* all matches */
1384 if (nextwild(&xpc, WILD_ALL, 0) == FAIL)
1385 break;
1386 goto cmdline_changed;
1388 case Ctrl_L:
1389 #ifdef FEAT_SEARCH_EXTRA
1390 if (p_is && !cmd_silent && (firstc == '/' || firstc == '?'))
1392 /* Add a character from under the cursor for 'incsearch' */
1393 if (did_incsearch
1394 && !equalpos(curwin->w_cursor, old_cursor))
1396 c = gchar_cursor();
1397 if (c != NUL)
1399 if (c == firstc || vim_strchr((char_u *)(
1400 p_magic ? "\\^$.*[" : "\\^$"), c)
1401 != NULL)
1403 /* put a backslash before special characters */
1404 stuffcharReadbuff(c);
1405 c = '\\';
1407 break;
1410 goto cmdline_not_changed;
1412 #endif
1414 /* completion: longest common part */
1415 if (nextwild(&xpc, WILD_LONGEST, 0) == FAIL)
1416 break;
1417 goto cmdline_changed;
1419 case Ctrl_N: /* next match */
1420 case Ctrl_P: /* previous match */
1421 if (xpc.xp_numfiles > 0)
1423 if (nextwild(&xpc, (c == Ctrl_P) ? WILD_PREV : WILD_NEXT, 0)
1424 == FAIL)
1425 break;
1426 goto cmdline_changed;
1429 #ifdef FEAT_CMDHIST
1430 case K_UP:
1431 case K_DOWN:
1432 case K_S_UP:
1433 case K_S_DOWN:
1434 case K_PAGEUP:
1435 case K_KPAGEUP:
1436 case K_PAGEDOWN:
1437 case K_KPAGEDOWN:
1438 if (hislen == 0 || firstc == NUL) /* no history */
1439 goto cmdline_not_changed;
1441 i = hiscnt;
1443 /* save current command string so it can be restored later */
1444 if (lookfor == NULL)
1446 if ((lookfor = vim_strsave(ccline.cmdbuff)) == NULL)
1447 goto cmdline_not_changed;
1448 lookfor[ccline.cmdpos] = NUL;
1451 j = (int)STRLEN(lookfor);
1452 for (;;)
1454 /* one step backwards */
1455 if (c == K_UP|| c == K_S_UP || c == Ctrl_P
1456 || c == K_PAGEUP || c == K_KPAGEUP)
1458 if (hiscnt == hislen) /* first time */
1459 hiscnt = hisidx[histype];
1460 else if (hiscnt == 0 && hisidx[histype] != hislen - 1)
1461 hiscnt = hislen - 1;
1462 else if (hiscnt != hisidx[histype] + 1)
1463 --hiscnt;
1464 else /* at top of list */
1466 hiscnt = i;
1467 break;
1470 else /* one step forwards */
1472 /* on last entry, clear the line */
1473 if (hiscnt == hisidx[histype])
1475 hiscnt = hislen;
1476 break;
1479 /* not on a history line, nothing to do */
1480 if (hiscnt == hislen)
1481 break;
1482 if (hiscnt == hislen - 1) /* wrap around */
1483 hiscnt = 0;
1484 else
1485 ++hiscnt;
1487 if (hiscnt < 0 || history[histype][hiscnt].hisstr == NULL)
1489 hiscnt = i;
1490 break;
1492 if ((c != K_UP && c != K_DOWN)
1493 || hiscnt == i
1494 || STRNCMP(history[histype][hiscnt].hisstr,
1495 lookfor, (size_t)j) == 0)
1496 break;
1499 if (hiscnt != i) /* jumped to other entry */
1501 char_u *p;
1502 int len;
1503 int old_firstc;
1505 vim_free(ccline.cmdbuff);
1506 if (hiscnt == hislen)
1507 p = lookfor; /* back to the old one */
1508 else
1509 p = history[histype][hiscnt].hisstr;
1511 if (histype == HIST_SEARCH
1512 && p != lookfor
1513 && (old_firstc = p[STRLEN(p) + 1]) != firstc)
1515 /* Correct for the separator character used when
1516 * adding the history entry vs the one used now.
1517 * First loop: count length.
1518 * Second loop: copy the characters. */
1519 for (i = 0; i <= 1; ++i)
1521 len = 0;
1522 for (j = 0; p[j] != NUL; ++j)
1524 /* Replace old sep with new sep, unless it is
1525 * escaped. */
1526 if (p[j] == old_firstc
1527 && (j == 0 || p[j - 1] != '\\'))
1529 if (i > 0)
1530 ccline.cmdbuff[len] = firstc;
1532 else
1534 /* Escape new sep, unless it is already
1535 * escaped. */
1536 if (p[j] == firstc
1537 && (j == 0 || p[j - 1] != '\\'))
1539 if (i > 0)
1540 ccline.cmdbuff[len] = '\\';
1541 ++len;
1543 if (i > 0)
1544 ccline.cmdbuff[len] = p[j];
1546 ++len;
1548 if (i == 0)
1550 alloc_cmdbuff(len);
1551 if (ccline.cmdbuff == NULL)
1552 goto returncmd;
1555 ccline.cmdbuff[len] = NUL;
1557 else
1559 alloc_cmdbuff((int)STRLEN(p));
1560 if (ccline.cmdbuff == NULL)
1561 goto returncmd;
1562 STRCPY(ccline.cmdbuff, p);
1565 ccline.cmdpos = ccline.cmdlen = (int)STRLEN(ccline.cmdbuff);
1566 redrawcmd();
1567 goto cmdline_changed;
1569 beep_flush();
1570 goto cmdline_not_changed;
1571 #endif
1573 case Ctrl_V:
1574 case Ctrl_Q:
1575 #ifdef FEAT_MOUSE
1576 ignore_drag_release = TRUE;
1577 #endif
1578 putcmdline('^', TRUE);
1579 c = get_literal(); /* get next (two) character(s) */
1580 do_abbr = FALSE; /* don't do abbreviation now */
1581 #ifdef FEAT_MBYTE
1582 /* may need to remove ^ when composing char was typed */
1583 if (enc_utf8 && utf_iscomposing(c) && !cmd_silent)
1585 draw_cmdline(ccline.cmdpos, ccline.cmdlen - ccline.cmdpos);
1586 msg_putchar(' ');
1587 cursorcmd();
1589 #endif
1590 break;
1592 #ifdef FEAT_DIGRAPHS
1593 case Ctrl_K:
1594 #ifdef FEAT_MOUSE
1595 ignore_drag_release = TRUE;
1596 #endif
1597 putcmdline('?', TRUE);
1598 #ifdef USE_ON_FLY_SCROLL
1599 dont_scroll = TRUE; /* disallow scrolling here */
1600 #endif
1601 c = get_digraph(TRUE);
1602 if (c != NUL)
1603 break;
1605 redrawcmd();
1606 goto cmdline_not_changed;
1607 #endif /* FEAT_DIGRAPHS */
1609 #ifdef FEAT_RIGHTLEFT
1610 case Ctrl__: /* CTRL-_: switch language mode */
1611 if (!p_ari)
1612 break;
1613 #ifdef FEAT_FKMAP
1614 if (p_altkeymap)
1616 cmd_fkmap = !cmd_fkmap;
1617 if (cmd_fkmap) /* in Farsi always in Insert mode */
1618 ccline.overstrike = FALSE;
1620 else /* Hebrew is default */
1621 #endif
1622 cmd_hkmap = !cmd_hkmap;
1623 goto cmdline_not_changed;
1624 #endif
1626 default:
1627 #ifdef UNIX
1628 if (c == intr_char)
1630 gotesc = TRUE; /* will free ccline.cmdbuff after
1631 putting it in history */
1632 goto returncmd; /* back to Normal mode */
1634 #endif
1636 * Normal character with no special meaning. Just set mod_mask
1637 * to 0x0 so that typing Shift-Space in the GUI doesn't enter
1638 * the string <S-Space>. This should only happen after ^V.
1640 if (!IS_SPECIAL(c))
1641 mod_mask = 0x0;
1642 break;
1645 * End of switch on command line character.
1646 * We come here if we have a normal character.
1649 if (do_abbr && (IS_SPECIAL(c) || !vim_iswordc(c)) && ccheck_abbr(
1650 #ifdef FEAT_MBYTE
1651 /* Add ABBR_OFF for characters above 0x100, this is
1652 * what check_abbr() expects. */
1653 (has_mbyte && c >= 0x100) ? (c + ABBR_OFF) :
1654 #endif
1656 goto cmdline_changed;
1659 * put the character in the command line
1661 if (IS_SPECIAL(c) || mod_mask != 0)
1662 put_on_cmdline(get_special_key_name(c, mod_mask), -1, TRUE);
1663 else
1665 #ifdef FEAT_MBYTE
1666 if (has_mbyte)
1668 j = (*mb_char2bytes)(c, IObuff);
1669 IObuff[j] = NUL; /* exclude composing chars */
1670 put_on_cmdline(IObuff, j, TRUE);
1672 else
1673 #endif
1675 IObuff[0] = c;
1676 put_on_cmdline(IObuff, 1, TRUE);
1679 goto cmdline_changed;
1682 * This part implements incremental searches for "/" and "?"
1683 * Jump to cmdline_not_changed when a character has been read but the command
1684 * line did not change. Then we only search and redraw if something changed in
1685 * the past.
1686 * Jump to cmdline_changed when the command line did change.
1687 * (Sorry for the goto's, I know it is ugly).
1689 cmdline_not_changed:
1690 #ifdef FEAT_SEARCH_EXTRA
1691 if (!incsearch_postponed)
1692 continue;
1693 #endif
1695 cmdline_changed:
1696 #ifdef FEAT_SEARCH_EXTRA
1698 * 'incsearch' highlighting.
1700 if (p_is && !cmd_silent && (firstc == '/' || firstc == '?'))
1702 pos_T end_pos;
1704 /* if there is a character waiting, search and redraw later */
1705 if (char_avail())
1707 incsearch_postponed = TRUE;
1708 continue;
1710 incsearch_postponed = FALSE;
1711 curwin->w_cursor = old_cursor; /* start at old position */
1713 /* If there is no command line, don't do anything */
1714 if (ccline.cmdlen == 0)
1715 i = 0;
1716 else
1718 cursor_off(); /* so the user knows we're busy */
1719 out_flush();
1720 ++emsg_off; /* So it doesn't beep if bad expr */
1721 i = do_search(NULL, firstc, ccline.cmdbuff, count,
1722 SEARCH_KEEP + SEARCH_OPT + SEARCH_NOOF + SEARCH_PEEK);
1723 --emsg_off;
1724 /* if interrupted while searching, behave like it failed */
1725 if (got_int)
1727 (void)vpeekc(); /* remove <C-C> from input stream */
1728 got_int = FALSE; /* don't abandon the command line */
1729 i = 0;
1731 else if (char_avail())
1732 /* cancelled searching because a char was typed */
1733 incsearch_postponed = TRUE;
1735 if (i != 0)
1736 highlight_match = TRUE; /* highlight position */
1737 else
1738 highlight_match = FALSE; /* remove highlight */
1740 /* first restore the old curwin values, so the screen is
1741 * positioned in the same way as the actual search command */
1742 curwin->w_leftcol = old_leftcol;
1743 curwin->w_topline = old_topline;
1744 # ifdef FEAT_DIFF
1745 curwin->w_topfill = old_topfill;
1746 # endif
1747 curwin->w_botline = old_botline;
1748 changed_cline_bef_curs();
1749 update_topline();
1751 if (i != 0)
1753 pos_T save_pos = curwin->w_cursor;
1756 * First move cursor to end of match, then to the start. This
1757 * moves the whole match onto the screen when 'nowrap' is set.
1759 curwin->w_cursor.lnum += search_match_lines;
1760 curwin->w_cursor.col = search_match_endcol;
1761 if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
1763 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
1764 coladvance((colnr_T)MAXCOL);
1766 validate_cursor();
1767 end_pos = curwin->w_cursor;
1768 curwin->w_cursor = save_pos;
1770 else
1771 end_pos = curwin->w_cursor; /* shutup gcc 4 */
1773 validate_cursor();
1774 # ifdef FEAT_WINDOWS
1775 /* May redraw the status line to show the cursor position. */
1776 if (p_ru && curwin->w_status_height > 0)
1777 curwin->w_redr_status = TRUE;
1778 # endif
1780 save_cmdline(&save_ccline);
1781 update_screen(SOME_VALID);
1782 restore_cmdline(&save_ccline);
1784 /* Leave it at the end to make CTRL-R CTRL-W work. */
1785 if (i != 0)
1786 curwin->w_cursor = end_pos;
1788 msg_starthere();
1789 redrawcmdline();
1790 did_incsearch = TRUE;
1792 #else /* FEAT_SEARCH_EXTRA */
1794 #endif
1796 #ifdef FEAT_RIGHTLEFT
1797 if (cmdmsg_rl
1798 # ifdef FEAT_ARABIC
1799 || (p_arshape && !p_tbidi && enc_utf8)
1800 # endif
1802 /* Always redraw the whole command line to fix shaping and
1803 * right-left typing. Not efficient, but it works. */
1804 redrawcmd();
1805 #endif
1808 returncmd:
1810 #ifdef FEAT_RIGHTLEFT
1811 cmdmsg_rl = FALSE;
1812 #endif
1814 #ifdef FEAT_FKMAP
1815 cmd_fkmap = 0;
1816 #endif
1818 ExpandCleanup(&xpc);
1820 #ifdef FEAT_SEARCH_EXTRA
1821 if (did_incsearch)
1823 curwin->w_cursor = old_cursor;
1824 curwin->w_curswant = old_curswant;
1825 curwin->w_leftcol = old_leftcol;
1826 curwin->w_topline = old_topline;
1827 # ifdef FEAT_DIFF
1828 curwin->w_topfill = old_topfill;
1829 # endif
1830 curwin->w_botline = old_botline;
1831 highlight_match = FALSE;
1832 validate_cursor(); /* needed for TAB */
1833 redraw_later(SOME_VALID);
1835 #endif
1837 if (ccline.cmdbuff != NULL)
1840 * Put line in history buffer (":" and "=" only when it was typed).
1842 #ifdef FEAT_CMDHIST
1843 if (ccline.cmdlen && firstc != NUL
1844 && (some_key_typed || histype == HIST_SEARCH))
1846 add_to_history(histype, ccline.cmdbuff, TRUE,
1847 histype == HIST_SEARCH ? firstc : NUL);
1848 if (firstc == ':')
1850 vim_free(new_last_cmdline);
1851 new_last_cmdline = vim_strsave(ccline.cmdbuff);
1854 #endif
1856 if (gotesc) /* abandon command line */
1858 vim_free(ccline.cmdbuff);
1859 ccline.cmdbuff = NULL;
1860 if (msg_scrolled == 0)
1861 compute_cmdrow();
1862 MSG("");
1863 redraw_cmdline = TRUE;
1868 * If the screen was shifted up, redraw the whole screen (later).
1869 * If the line is too long, clear it, so ruler and shown command do
1870 * not get printed in the middle of it.
1872 msg_check();
1873 msg_scroll = save_msg_scroll;
1874 redir_off = FALSE;
1876 /* When the command line was typed, no need for a wait-return prompt. */
1877 if (some_key_typed)
1878 need_wait_return = FALSE;
1880 State = save_State;
1881 #ifdef USE_IM_CONTROL
1882 if (b_im_ptr != NULL && *b_im_ptr != B_IMODE_LMAP)
1883 im_save_status(b_im_ptr);
1884 im_set_active(FALSE);
1885 #endif
1886 #ifdef FEAT_MOUSE
1887 setmouse();
1888 #endif
1889 #ifdef CURSOR_SHAPE
1890 ui_cursor_shape(); /* may show different cursor shape */
1891 #endif
1894 char_u *p = ccline.cmdbuff;
1896 /* Make ccline empty, getcmdline() may try to use it. */
1897 ccline.cmdbuff = NULL;
1898 return p;
1902 #if (defined(FEAT_CRYPT) || defined(FEAT_EVAL)) || defined(PROTO)
1904 * Get a command line with a prompt.
1905 * This is prepared to be called recursively from getcmdline() (e.g. by
1906 * f_input() when evaluating an expression from CTRL-R =).
1907 * Returns the command line in allocated memory, or NULL.
1909 char_u *
1910 getcmdline_prompt(firstc, prompt, attr, xp_context, xp_arg)
1911 int firstc;
1912 char_u *prompt; /* command line prompt */
1913 int attr; /* attributes for prompt */
1914 int xp_context; /* type of expansion */
1915 char_u *xp_arg; /* user-defined expansion argument */
1917 char_u *s;
1918 struct cmdline_info save_ccline;
1919 int msg_col_save = msg_col;
1921 save_cmdline(&save_ccline);
1922 ccline.cmdprompt = prompt;
1923 ccline.cmdattr = attr;
1924 # ifdef FEAT_EVAL
1925 ccline.xp_context = xp_context;
1926 ccline.xp_arg = xp_arg;
1927 ccline.input_fn = (firstc == '@');
1928 # endif
1929 s = getcmdline(firstc, 1L, 0);
1930 restore_cmdline(&save_ccline);
1931 /* Restore msg_col, the prompt from input() may have changed it. */
1932 msg_col = msg_col_save;
1934 return s;
1936 #endif
1939 * Return TRUE when the text must not be changed and we can't switch to
1940 * another window or buffer. Used when editing the command line, evaluating
1941 * 'balloonexpr', etc.
1944 text_locked()
1946 #ifdef FEAT_CMDWIN
1947 if (cmdwin_type != 0)
1948 return TRUE;
1949 #endif
1950 return textlock != 0;
1954 * Give an error message for a command that isn't allowed while the cmdline
1955 * window is open or editing the cmdline in another way.
1957 void
1958 text_locked_msg()
1960 #ifdef FEAT_CMDWIN
1961 if (cmdwin_type != 0)
1962 EMSG(_(e_cmdwin));
1963 else
1964 #endif
1965 EMSG(_(e_secure));
1968 #if defined(FEAT_AUTOCMD) || defined(PROTO)
1970 * Check if "curbuf_lock" is set and return TRUE when it is and give an error
1971 * message.
1974 curbuf_locked()
1976 if (curbuf_lock > 0)
1978 EMSG(_("E788: Not allowed to edit another buffer now"));
1979 return TRUE;
1981 return FALSE;
1983 #endif
1985 static int
1986 cmdline_charsize(idx)
1987 int idx;
1989 #if defined(FEAT_CRYPT) || defined(FEAT_EVAL)
1990 if (cmdline_star > 0) /* showing '*', always 1 position */
1991 return 1;
1992 #endif
1993 return ptr2cells(ccline.cmdbuff + idx);
1997 * Compute the offset of the cursor on the command line for the prompt and
1998 * indent.
2000 static void
2001 set_cmdspos()
2003 if (ccline.cmdfirstc != NUL)
2004 ccline.cmdspos = 1 + ccline.cmdindent;
2005 else
2006 ccline.cmdspos = 0 + ccline.cmdindent;
2010 * Compute the screen position for the cursor on the command line.
2012 static void
2013 set_cmdspos_cursor()
2015 int i, m, c;
2017 set_cmdspos();
2018 if (KeyTyped)
2020 m = Columns * Rows;
2021 if (m < 0) /* overflow, Columns or Rows at weird value */
2022 m = MAXCOL;
2024 else
2025 m = MAXCOL;
2026 for (i = 0; i < ccline.cmdlen && i < ccline.cmdpos; ++i)
2028 c = cmdline_charsize(i);
2029 #ifdef FEAT_MBYTE
2030 /* Count ">" for double-wide multi-byte char that doesn't fit. */
2031 if (has_mbyte)
2032 correct_cmdspos(i, c);
2033 #endif
2034 /* If the cmdline doesn't fit, put cursor on last visible char. */
2035 if ((ccline.cmdspos += c) >= m)
2037 ccline.cmdpos = i - 1;
2038 ccline.cmdspos -= c;
2039 break;
2041 #ifdef FEAT_MBYTE
2042 if (has_mbyte)
2043 i += (*mb_ptr2len)(ccline.cmdbuff + i) - 1;
2044 #endif
2048 #ifdef FEAT_MBYTE
2050 * Check if the character at "idx", which is "cells" wide, is a multi-byte
2051 * character that doesn't fit, so that a ">" must be displayed.
2053 static void
2054 correct_cmdspos(idx, cells)
2055 int idx;
2056 int cells;
2058 if ((*mb_ptr2len)(ccline.cmdbuff + idx) > 1
2059 && (*mb_ptr2cells)(ccline.cmdbuff + idx) > 1
2060 && ccline.cmdspos % Columns + cells > Columns)
2061 ccline.cmdspos++;
2063 #endif
2066 * Get an Ex command line for the ":" command.
2068 /* ARGSUSED */
2069 char_u *
2070 getexline(c, dummy, indent)
2071 int c; /* normally ':', NUL for ":append" */
2072 void *dummy; /* cookie not used */
2073 int indent; /* indent for inside conditionals */
2075 /* When executing a register, remove ':' that's in front of each line. */
2076 if (exec_from_reg && vpeekc() == ':')
2077 (void)vgetc();
2078 return getcmdline(c, 1L, indent);
2082 * Get an Ex command line for Ex mode.
2083 * In Ex mode we only use the OS supplied line editing features and no
2084 * mappings or abbreviations.
2085 * Returns a string in allocated memory or NULL.
2087 /* ARGSUSED */
2088 char_u *
2089 getexmodeline(promptc, dummy, indent)
2090 int promptc; /* normally ':', NUL for ":append" and '?' for
2091 :s prompt */
2092 void *dummy; /* cookie not used */
2093 int indent; /* indent for inside conditionals */
2095 garray_T line_ga;
2096 char_u *pend;
2097 int startcol = 0;
2098 int c1 = 0;
2099 int escaped = FALSE; /* CTRL-V typed */
2100 int vcol = 0;
2101 char_u *p;
2102 int prev_char;
2104 /* Switch cursor on now. This avoids that it happens after the "\n", which
2105 * confuses the system function that computes tabstops. */
2106 cursor_on();
2108 /* always start in column 0; write a newline if necessary */
2109 compute_cmdrow();
2110 if ((msg_col || msg_didout) && promptc != '?')
2111 msg_putchar('\n');
2112 if (promptc == ':')
2114 /* indent that is only displayed, not in the line itself */
2115 if (p_prompt)
2116 msg_putchar(':');
2117 while (indent-- > 0)
2118 msg_putchar(' ');
2119 startcol = msg_col;
2122 ga_init2(&line_ga, 1, 30);
2124 /* autoindent for :insert and :append is in the line itself */
2125 if (promptc <= 0)
2127 vcol = indent;
2128 while (indent >= 8)
2130 ga_append(&line_ga, TAB);
2131 msg_puts((char_u *)" ");
2132 indent -= 8;
2134 while (indent-- > 0)
2136 ga_append(&line_ga, ' ');
2137 msg_putchar(' ');
2140 ++no_mapping;
2141 ++allow_keys;
2144 * Get the line, one character at a time.
2146 got_int = FALSE;
2147 while (!got_int)
2149 if (ga_grow(&line_ga, 40) == FAIL)
2150 break;
2151 pend = (char_u *)line_ga.ga_data + line_ga.ga_len;
2153 /* Get one character at a time. Don't use inchar(), it can't handle
2154 * special characters. */
2155 prev_char = c1;
2156 c1 = vgetc();
2159 * Handle line editing.
2160 * Previously this was left to the system, putting the terminal in
2161 * cooked mode, but then CTRL-D and CTRL-T can't be used properly.
2163 if (got_int)
2165 msg_putchar('\n');
2166 break;
2169 if (!escaped)
2171 /* CR typed means "enter", which is NL */
2172 if (c1 == '\r')
2173 c1 = '\n';
2175 if (c1 == BS || c1 == K_BS
2176 || c1 == DEL || c1 == K_DEL || c1 == K_KDEL)
2178 if (line_ga.ga_len > 0)
2180 --line_ga.ga_len;
2181 goto redraw;
2183 continue;
2186 if (c1 == Ctrl_U)
2188 msg_col = startcol;
2189 msg_clr_eos();
2190 line_ga.ga_len = 0;
2191 continue;
2194 if (c1 == Ctrl_T)
2196 p = (char_u *)line_ga.ga_data;
2197 p[line_ga.ga_len] = NUL;
2198 indent = get_indent_str(p, 8);
2199 indent += curbuf->b_p_sw - indent % curbuf->b_p_sw;
2200 add_indent:
2201 while (get_indent_str(p, 8) < indent)
2203 char_u *s = skipwhite(p);
2205 ga_grow(&line_ga, 1);
2206 mch_memmove(s + 1, s, line_ga.ga_len - (s - p) + 1);
2207 *s = ' ';
2208 ++line_ga.ga_len;
2210 redraw:
2211 /* redraw the line */
2212 msg_col = startcol;
2213 vcol = 0;
2214 for (p = (char_u *)line_ga.ga_data;
2215 p < (char_u *)line_ga.ga_data + line_ga.ga_len; ++p)
2217 if (*p == TAB)
2221 msg_putchar(' ');
2222 } while (++vcol % 8);
2224 else
2226 msg_outtrans_len(p, 1);
2227 vcol += char2cells(*p);
2230 msg_clr_eos();
2231 windgoto(msg_row, msg_col);
2232 continue;
2235 if (c1 == Ctrl_D)
2237 /* Delete one shiftwidth. */
2238 p = (char_u *)line_ga.ga_data;
2239 if (prev_char == '0' || prev_char == '^')
2241 if (prev_char == '^')
2242 ex_keep_indent = TRUE;
2243 indent = 0;
2244 p[--line_ga.ga_len] = NUL;
2246 else
2248 p[line_ga.ga_len] = NUL;
2249 indent = get_indent_str(p, 8);
2250 --indent;
2251 indent -= indent % curbuf->b_p_sw;
2253 while (get_indent_str(p, 8) > indent)
2255 char_u *s = skipwhite(p);
2257 mch_memmove(s - 1, s, line_ga.ga_len - (s - p) + 1);
2258 --line_ga.ga_len;
2260 goto add_indent;
2263 if (c1 == Ctrl_V || c1 == Ctrl_Q)
2265 escaped = TRUE;
2266 continue;
2269 /* Ignore special key codes: mouse movement, K_IGNORE, etc. */
2270 if (IS_SPECIAL(c1))
2271 continue;
2274 if (IS_SPECIAL(c1))
2275 c1 = '?';
2276 ((char_u *)line_ga.ga_data)[line_ga.ga_len] = c1;
2277 if (c1 == '\n')
2278 msg_putchar('\n');
2279 else if (c1 == TAB)
2281 /* Don't use chartabsize(), 'ts' can be different */
2284 msg_putchar(' ');
2285 } while (++vcol % 8);
2287 else
2289 msg_outtrans_len(
2290 ((char_u *)line_ga.ga_data) + line_ga.ga_len, 1);
2291 vcol += char2cells(c1);
2293 ++line_ga.ga_len;
2294 escaped = FALSE;
2296 windgoto(msg_row, msg_col);
2297 pend = (char_u *)(line_ga.ga_data) + line_ga.ga_len;
2299 /* we are done when a NL is entered, but not when it comes after a
2300 * backslash */
2301 if (line_ga.ga_len > 0 && pend[-1] == '\n'
2302 && (line_ga.ga_len <= 1 || pend[-2] != '\\'))
2304 --line_ga.ga_len;
2305 --pend;
2306 *pend = NUL;
2307 break;
2311 --no_mapping;
2312 --allow_keys;
2314 /* make following messages go to the next line */
2315 msg_didout = FALSE;
2316 msg_col = 0;
2317 if (msg_row < Rows - 1)
2318 ++msg_row;
2319 emsg_on_display = FALSE; /* don't want ui_delay() */
2321 if (got_int)
2322 ga_clear(&line_ga);
2324 return (char_u *)line_ga.ga_data;
2327 # if defined(MCH_CURSOR_SHAPE) || defined(FEAT_GUI) \
2328 || defined(FEAT_MOUSESHAPE) || defined(PROTO)
2330 * Return TRUE if ccline.overstrike is on.
2333 cmdline_overstrike()
2335 return ccline.overstrike;
2339 * Return TRUE if the cursor is at the end of the cmdline.
2342 cmdline_at_end()
2344 return (ccline.cmdpos >= ccline.cmdlen);
2346 #endif
2348 #if (defined(FEAT_XIM) && (defined(FEAT_GUI_GTK))) || defined(PROTO)
2350 * Return the virtual column number at the current cursor position.
2351 * This is used by the IM code to obtain the start of the preedit string.
2353 colnr_T
2354 cmdline_getvcol_cursor()
2356 if (ccline.cmdbuff == NULL || ccline.cmdpos > ccline.cmdlen)
2357 return MAXCOL;
2359 # ifdef FEAT_MBYTE
2360 if (has_mbyte)
2362 colnr_T col;
2363 int i = 0;
2365 for (col = 0; i < ccline.cmdpos; ++col)
2366 i += (*mb_ptr2len)(ccline.cmdbuff + i);
2368 return col;
2370 else
2371 # endif
2372 return ccline.cmdpos;
2374 #endif
2376 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
2378 * If part of the command line is an IM preedit string, redraw it with
2379 * IM feedback attributes. The cursor position is restored after drawing.
2381 static void
2382 redrawcmd_preedit()
2384 if ((State & CMDLINE)
2385 && xic != NULL
2386 /* && im_get_status() doesn't work when using SCIM */
2387 && !p_imdisable
2388 && im_is_preediting())
2390 int cmdpos = 0;
2391 int cmdspos;
2392 int old_row;
2393 int old_col;
2394 colnr_T col;
2396 old_row = msg_row;
2397 old_col = msg_col;
2398 cmdspos = ((ccline.cmdfirstc != NUL) ? 1 : 0) + ccline.cmdindent;
2400 # ifdef FEAT_MBYTE
2401 if (has_mbyte)
2403 for (col = 0; col < preedit_start_col
2404 && cmdpos < ccline.cmdlen; ++col)
2406 cmdspos += (*mb_ptr2cells)(ccline.cmdbuff + cmdpos);
2407 cmdpos += (*mb_ptr2len)(ccline.cmdbuff + cmdpos);
2410 else
2411 # endif
2413 cmdspos += preedit_start_col;
2414 cmdpos += preedit_start_col;
2417 msg_row = cmdline_row + (cmdspos / (int)Columns);
2418 msg_col = cmdspos % (int)Columns;
2419 if (msg_row >= Rows)
2420 msg_row = Rows - 1;
2422 for (col = 0; cmdpos < ccline.cmdlen; ++col)
2424 int char_len;
2425 int char_attr;
2427 char_attr = im_get_feedback_attr(col);
2428 if (char_attr < 0)
2429 break; /* end of preedit string */
2431 # ifdef FEAT_MBYTE
2432 if (has_mbyte)
2433 char_len = (*mb_ptr2len)(ccline.cmdbuff + cmdpos);
2434 else
2435 # endif
2436 char_len = 1;
2438 msg_outtrans_len_attr(ccline.cmdbuff + cmdpos, char_len, char_attr);
2439 cmdpos += char_len;
2442 msg_row = old_row;
2443 msg_col = old_col;
2446 #endif /* FEAT_XIM && FEAT_GUI_GTK */
2449 * Allocate a new command line buffer.
2450 * Assigns the new buffer to ccline.cmdbuff and ccline.cmdbufflen.
2451 * Returns the new value of ccline.cmdbuff and ccline.cmdbufflen.
2453 static void
2454 alloc_cmdbuff(len)
2455 int len;
2458 * give some extra space to avoid having to allocate all the time
2460 if (len < 80)
2461 len = 100;
2462 else
2463 len += 20;
2465 ccline.cmdbuff = alloc(len); /* caller should check for out-of-memory */
2466 ccline.cmdbufflen = len;
2470 * Re-allocate the command line to length len + something extra.
2471 * return FAIL for failure, OK otherwise
2473 static int
2474 realloc_cmdbuff(len)
2475 int len;
2477 char_u *p;
2479 p = ccline.cmdbuff;
2480 alloc_cmdbuff(len); /* will get some more */
2481 if (ccline.cmdbuff == NULL) /* out of memory */
2483 ccline.cmdbuff = p; /* keep the old one */
2484 return FAIL;
2486 mch_memmove(ccline.cmdbuff, p, (size_t)ccline.cmdlen + 1);
2487 vim_free(p);
2488 return OK;
2491 #if defined(FEAT_ARABIC) || defined(PROTO)
2492 static char_u *arshape_buf = NULL;
2494 # if defined(EXITFREE) || defined(PROTO)
2495 void
2496 free_cmdline_buf()
2498 vim_free(arshape_buf);
2500 # endif
2501 #endif
2504 * Draw part of the cmdline at the current cursor position. But draw stars
2505 * when cmdline_star is TRUE.
2507 static void
2508 draw_cmdline(start, len)
2509 int start;
2510 int len;
2512 #if defined(FEAT_CRYPT) || defined(FEAT_EVAL)
2513 int i;
2515 if (cmdline_star > 0)
2516 for (i = 0; i < len; ++i)
2518 msg_putchar('*');
2519 # ifdef FEAT_MBYTE
2520 if (has_mbyte)
2521 i += (*mb_ptr2len)(ccline.cmdbuff + start + i) - 1;
2522 # endif
2524 else
2525 #endif
2526 #ifdef FEAT_ARABIC
2527 if (p_arshape && !p_tbidi && enc_utf8 && len > 0)
2529 static int buflen = 0;
2530 char_u *p;
2531 int j;
2532 int newlen = 0;
2533 int mb_l;
2534 int pc, pc1 = 0;
2535 int prev_c = 0;
2536 int prev_c1 = 0;
2537 int u8c;
2538 int u8cc[MAX_MCO];
2539 int nc = 0;
2542 * Do arabic shaping into a temporary buffer. This is very
2543 * inefficient!
2545 if (len * 2 + 2 > buflen)
2547 /* Re-allocate the buffer. We keep it around to avoid a lot of
2548 * alloc()/free() calls. */
2549 vim_free(arshape_buf);
2550 buflen = len * 2 + 2;
2551 arshape_buf = alloc(buflen);
2552 if (arshape_buf == NULL)
2553 return; /* out of memory */
2556 if (utf_iscomposing(utf_ptr2char(ccline.cmdbuff + start)))
2558 /* Prepend a space to draw the leading composing char on. */
2559 arshape_buf[0] = ' ';
2560 newlen = 1;
2563 for (j = start; j < start + len; j += mb_l)
2565 p = ccline.cmdbuff + j;
2566 u8c = utfc_ptr2char_len(p, u8cc, start + len - j);
2567 mb_l = utfc_ptr2len_len(p, start + len - j);
2568 if (ARABIC_CHAR(u8c))
2570 /* Do Arabic shaping. */
2571 if (cmdmsg_rl)
2573 /* displaying from right to left */
2574 pc = prev_c;
2575 pc1 = prev_c1;
2576 prev_c1 = u8cc[0];
2577 if (j + mb_l >= start + len)
2578 nc = NUL;
2579 else
2580 nc = utf_ptr2char(p + mb_l);
2582 else
2584 /* displaying from left to right */
2585 if (j + mb_l >= start + len)
2586 pc = NUL;
2587 else
2589 int pcc[MAX_MCO];
2591 pc = utfc_ptr2char_len(p + mb_l, pcc,
2592 start + len - j - mb_l);
2593 pc1 = pcc[0];
2595 nc = prev_c;
2597 prev_c = u8c;
2599 u8c = arabic_shape(u8c, NULL, &u8cc[0], pc, pc1, nc);
2601 newlen += (*mb_char2bytes)(u8c, arshape_buf + newlen);
2602 if (u8cc[0] != 0)
2604 newlen += (*mb_char2bytes)(u8cc[0], arshape_buf + newlen);
2605 if (u8cc[1] != 0)
2606 newlen += (*mb_char2bytes)(u8cc[1],
2607 arshape_buf + newlen);
2610 else
2612 prev_c = u8c;
2613 mch_memmove(arshape_buf + newlen, p, mb_l);
2614 newlen += mb_l;
2618 msg_outtrans_len(arshape_buf, newlen);
2620 else
2621 #endif
2622 msg_outtrans_len(ccline.cmdbuff + start, len);
2626 * Put a character on the command line. Shifts the following text to the
2627 * right when "shift" is TRUE. Used for CTRL-V, CTRL-K, etc.
2628 * "c" must be printable (fit in one display cell)!
2630 void
2631 putcmdline(c, shift)
2632 int c;
2633 int shift;
2635 if (cmd_silent)
2636 return;
2637 msg_no_more = TRUE;
2638 msg_putchar(c);
2639 if (shift)
2640 draw_cmdline(ccline.cmdpos, ccline.cmdlen - ccline.cmdpos);
2641 msg_no_more = FALSE;
2642 cursorcmd();
2646 * Undo a putcmdline(c, FALSE).
2648 void
2649 unputcmdline()
2651 if (cmd_silent)
2652 return;
2653 msg_no_more = TRUE;
2654 if (ccline.cmdlen == ccline.cmdpos)
2655 msg_putchar(' ');
2656 else
2657 draw_cmdline(ccline.cmdpos, 1);
2658 msg_no_more = FALSE;
2659 cursorcmd();
2663 * Put the given string, of the given length, onto the command line.
2664 * If len is -1, then STRLEN() is used to calculate the length.
2665 * If 'redraw' is TRUE then the new part of the command line, and the remaining
2666 * part will be redrawn, otherwise it will not. If this function is called
2667 * twice in a row, then 'redraw' should be FALSE and redrawcmd() should be
2668 * called afterwards.
2671 put_on_cmdline(str, len, redraw)
2672 char_u *str;
2673 int len;
2674 int redraw;
2676 int retval;
2677 int i;
2678 int m;
2679 int c;
2681 if (len < 0)
2682 len = (int)STRLEN(str);
2684 /* Check if ccline.cmdbuff needs to be longer */
2685 if (ccline.cmdlen + len + 1 >= ccline.cmdbufflen)
2686 retval = realloc_cmdbuff(ccline.cmdlen + len);
2687 else
2688 retval = OK;
2689 if (retval == OK)
2691 if (!ccline.overstrike)
2693 mch_memmove(ccline.cmdbuff + ccline.cmdpos + len,
2694 ccline.cmdbuff + ccline.cmdpos,
2695 (size_t)(ccline.cmdlen - ccline.cmdpos));
2696 ccline.cmdlen += len;
2698 else
2700 #ifdef FEAT_MBYTE
2701 if (has_mbyte)
2703 /* Count nr of characters in the new string. */
2704 m = 0;
2705 for (i = 0; i < len; i += (*mb_ptr2len)(str + i))
2706 ++m;
2707 /* Count nr of bytes in cmdline that are overwritten by these
2708 * characters. */
2709 for (i = ccline.cmdpos; i < ccline.cmdlen && m > 0;
2710 i += (*mb_ptr2len)(ccline.cmdbuff + i))
2711 --m;
2712 if (i < ccline.cmdlen)
2714 mch_memmove(ccline.cmdbuff + ccline.cmdpos + len,
2715 ccline.cmdbuff + i, (size_t)(ccline.cmdlen - i));
2716 ccline.cmdlen += ccline.cmdpos + len - i;
2718 else
2719 ccline.cmdlen = ccline.cmdpos + len;
2721 else
2722 #endif
2723 if (ccline.cmdpos + len > ccline.cmdlen)
2724 ccline.cmdlen = ccline.cmdpos + len;
2726 mch_memmove(ccline.cmdbuff + ccline.cmdpos, str, (size_t)len);
2727 ccline.cmdbuff[ccline.cmdlen] = NUL;
2729 #ifdef FEAT_MBYTE
2730 if (enc_utf8)
2732 /* When the inserted text starts with a composing character,
2733 * backup to the character before it. There could be two of them.
2735 i = 0;
2736 c = utf_ptr2char(ccline.cmdbuff + ccline.cmdpos);
2737 while (ccline.cmdpos > 0 && utf_iscomposing(c))
2739 i = (*mb_head_off)(ccline.cmdbuff,
2740 ccline.cmdbuff + ccline.cmdpos - 1) + 1;
2741 ccline.cmdpos -= i;
2742 len += i;
2743 c = utf_ptr2char(ccline.cmdbuff + ccline.cmdpos);
2745 # ifdef FEAT_ARABIC
2746 if (i == 0 && ccline.cmdpos > 0 && arabic_maycombine(c))
2748 /* Check the previous character for Arabic combining pair. */
2749 i = (*mb_head_off)(ccline.cmdbuff,
2750 ccline.cmdbuff + ccline.cmdpos - 1) + 1;
2751 if (arabic_combine(utf_ptr2char(ccline.cmdbuff
2752 + ccline.cmdpos - i), c))
2754 ccline.cmdpos -= i;
2755 len += i;
2757 else
2758 i = 0;
2760 # endif
2761 if (i != 0)
2763 /* Also backup the cursor position. */
2764 i = ptr2cells(ccline.cmdbuff + ccline.cmdpos);
2765 ccline.cmdspos -= i;
2766 msg_col -= i;
2767 if (msg_col < 0)
2769 msg_col += Columns;
2770 --msg_row;
2774 #endif
2776 if (redraw && !cmd_silent)
2778 msg_no_more = TRUE;
2779 i = cmdline_row;
2780 draw_cmdline(ccline.cmdpos, ccline.cmdlen - ccline.cmdpos);
2781 /* Avoid clearing the rest of the line too often. */
2782 if (cmdline_row != i || ccline.overstrike)
2783 msg_clr_eos();
2784 msg_no_more = FALSE;
2786 #ifdef FEAT_FKMAP
2788 * If we are in Farsi command mode, the character input must be in
2789 * Insert mode. So do not advance the cmdpos.
2791 if (!cmd_fkmap)
2792 #endif
2794 if (KeyTyped)
2796 m = Columns * Rows;
2797 if (m < 0) /* overflow, Columns or Rows at weird value */
2798 m = MAXCOL;
2800 else
2801 m = MAXCOL;
2802 for (i = 0; i < len; ++i)
2804 c = cmdline_charsize(ccline.cmdpos);
2805 #ifdef FEAT_MBYTE
2806 /* count ">" for a double-wide char that doesn't fit. */
2807 if (has_mbyte)
2808 correct_cmdspos(ccline.cmdpos, c);
2809 #endif
2810 /* Stop cursor at the end of the screen */
2811 if (ccline.cmdspos + c >= m)
2812 break;
2813 ccline.cmdspos += c;
2814 #ifdef FEAT_MBYTE
2815 if (has_mbyte)
2817 c = (*mb_ptr2len)(ccline.cmdbuff + ccline.cmdpos) - 1;
2818 if (c > len - i - 1)
2819 c = len - i - 1;
2820 ccline.cmdpos += c;
2821 i += c;
2823 #endif
2824 ++ccline.cmdpos;
2828 if (redraw)
2829 msg_check();
2830 return retval;
2833 static struct cmdline_info prev_ccline;
2834 static int prev_ccline_used = FALSE;
2837 * Save ccline, because obtaining the "=" register may execute "normal :cmd"
2838 * and overwrite it. But get_cmdline_str() may need it, thus make it
2839 * available globally in prev_ccline.
2841 static void
2842 save_cmdline(ccp)
2843 struct cmdline_info *ccp;
2845 if (!prev_ccline_used)
2847 vim_memset(&prev_ccline, 0, sizeof(struct cmdline_info));
2848 prev_ccline_used = TRUE;
2850 *ccp = prev_ccline;
2851 prev_ccline = ccline;
2852 ccline.cmdbuff = NULL;
2853 ccline.cmdprompt = NULL;
2857 * Restore ccline after it has been saved with save_cmdline().
2859 static void
2860 restore_cmdline(ccp)
2861 struct cmdline_info *ccp;
2863 ccline = prev_ccline;
2864 prev_ccline = *ccp;
2867 #if defined(FEAT_EVAL) || defined(PROTO)
2869 * Save the command line into allocated memory. Returns a pointer to be
2870 * passed to restore_cmdline_alloc() later.
2871 * Returns NULL when failed.
2873 char_u *
2874 save_cmdline_alloc()
2876 struct cmdline_info *p;
2878 p = (struct cmdline_info *)alloc((unsigned)sizeof(struct cmdline_info));
2879 if (p != NULL)
2880 save_cmdline(p);
2881 return (char_u *)p;
2885 * Restore the command line from the return value of save_cmdline_alloc().
2887 void
2888 restore_cmdline_alloc(p)
2889 char_u *p;
2891 if (p != NULL)
2893 restore_cmdline((struct cmdline_info *)p);
2894 vim_free(p);
2897 #endif
2900 * paste a yank register into the command line.
2901 * used by CTRL-R command in command-line mode
2902 * insert_reg() can't be used here, because special characters from the
2903 * register contents will be interpreted as commands.
2905 * return FAIL for failure, OK otherwise
2907 static int
2908 cmdline_paste(regname, literally, remcr)
2909 int regname;
2910 int literally; /* Insert text literally instead of "as typed" */
2911 int remcr; /* remove trailing CR */
2913 long i;
2914 char_u *arg;
2915 char_u *p;
2916 int allocated;
2917 struct cmdline_info save_ccline;
2919 /* check for valid regname; also accept special characters for CTRL-R in
2920 * the command line */
2921 if (regname != Ctrl_F && regname != Ctrl_P && regname != Ctrl_W
2922 && regname != Ctrl_A && !valid_yank_reg(regname, FALSE))
2923 return FAIL;
2925 /* A register containing CTRL-R can cause an endless loop. Allow using
2926 * CTRL-C to break the loop. */
2927 line_breakcheck();
2928 if (got_int)
2929 return FAIL;
2931 #ifdef FEAT_CLIPBOARD
2932 regname = may_get_selection(regname);
2933 #endif
2935 /* Need to save and restore ccline. And set "textlock" to avoid nasty
2936 * things like going to another buffer when evaluating an expression. */
2937 save_cmdline(&save_ccline);
2938 ++textlock;
2939 i = get_spec_reg(regname, &arg, &allocated, TRUE);
2940 --textlock;
2941 restore_cmdline(&save_ccline);
2943 if (i)
2945 /* Got the value of a special register in "arg". */
2946 if (arg == NULL)
2947 return FAIL;
2949 /* When 'incsearch' is set and CTRL-R CTRL-W used: skip the duplicate
2950 * part of the word. */
2951 p = arg;
2952 if (p_is && regname == Ctrl_W)
2954 char_u *w;
2955 int len;
2957 /* Locate start of last word in the cmd buffer. */
2958 for (w = ccline.cmdbuff + ccline.cmdlen; w > ccline.cmdbuff; )
2960 #ifdef FEAT_MBYTE
2961 if (has_mbyte)
2963 len = (*mb_head_off)(ccline.cmdbuff, w - 1) + 1;
2964 if (!vim_iswordc(mb_ptr2char(w - len)))
2965 break;
2966 w -= len;
2968 else
2969 #endif
2971 if (!vim_iswordc(w[-1]))
2972 break;
2973 --w;
2976 len = (int)((ccline.cmdbuff + ccline.cmdlen) - w);
2977 if (p_ic ? STRNICMP(w, arg, len) == 0 : STRNCMP(w, arg, len) == 0)
2978 p += len;
2981 cmdline_paste_str(p, literally);
2982 if (allocated)
2983 vim_free(arg);
2984 return OK;
2987 return cmdline_paste_reg(regname, literally, remcr);
2991 * Put a string on the command line.
2992 * When "literally" is TRUE, insert literally.
2993 * When "literally" is FALSE, insert as typed, but don't leave the command
2994 * line.
2996 void
2997 cmdline_paste_str(s, literally)
2998 char_u *s;
2999 int literally;
3001 int c, cv;
3003 if (literally)
3004 put_on_cmdline(s, -1, TRUE);
3005 else
3006 while (*s != NUL)
3008 cv = *s;
3009 if (cv == Ctrl_V && s[1])
3010 ++s;
3011 #ifdef FEAT_MBYTE
3012 if (has_mbyte)
3014 c = mb_ptr2char(s);
3015 s += mb_char2len(c);
3017 else
3018 #endif
3019 c = *s++;
3020 if (cv == Ctrl_V || c == ESC || c == Ctrl_C || c == CAR || c == NL
3021 #ifdef UNIX
3022 || c == intr_char
3023 #endif
3024 || (c == Ctrl_BSL && *s == Ctrl_N))
3025 stuffcharReadbuff(Ctrl_V);
3026 stuffcharReadbuff(c);
3030 #ifdef FEAT_WILDMENU
3032 * Delete characters on the command line, from "from" to the current
3033 * position.
3035 static void
3036 cmdline_del(from)
3037 int from;
3039 mch_memmove(ccline.cmdbuff + from, ccline.cmdbuff + ccline.cmdpos,
3040 (size_t)(ccline.cmdlen - ccline.cmdpos + 1));
3041 ccline.cmdlen -= ccline.cmdpos - from;
3042 ccline.cmdpos = from;
3044 #endif
3047 * this function is called when the screen size changes and with incremental
3048 * search
3050 void
3051 redrawcmdline()
3053 if (cmd_silent)
3054 return;
3055 need_wait_return = FALSE;
3056 compute_cmdrow();
3057 redrawcmd();
3058 cursorcmd();
3061 static void
3062 redrawcmdprompt()
3064 int i;
3066 if (cmd_silent)
3067 return;
3068 if (ccline.cmdfirstc != NUL)
3069 msg_putchar(ccline.cmdfirstc);
3070 if (ccline.cmdprompt != NULL)
3072 msg_puts_attr(ccline.cmdprompt, ccline.cmdattr);
3073 ccline.cmdindent = msg_col + (msg_row - cmdline_row) * Columns;
3074 /* do the reverse of set_cmdspos() */
3075 if (ccline.cmdfirstc != NUL)
3076 --ccline.cmdindent;
3078 else
3079 for (i = ccline.cmdindent; i > 0; --i)
3080 msg_putchar(' ');
3084 * Redraw what is currently on the command line.
3086 void
3087 redrawcmd()
3089 if (cmd_silent)
3090 return;
3092 /* when 'incsearch' is set there may be no command line while redrawing */
3093 if (ccline.cmdbuff == NULL)
3095 windgoto(cmdline_row, 0);
3096 msg_clr_eos();
3097 return;
3100 msg_start();
3101 redrawcmdprompt();
3103 /* Don't use more prompt, truncate the cmdline if it doesn't fit. */
3104 msg_no_more = TRUE;
3105 draw_cmdline(0, ccline.cmdlen);
3106 msg_clr_eos();
3107 msg_no_more = FALSE;
3109 set_cmdspos_cursor();
3112 * An emsg() before may have set msg_scroll. This is used in normal mode,
3113 * in cmdline mode we can reset them now.
3115 msg_scroll = FALSE; /* next message overwrites cmdline */
3117 /* Typing ':' at the more prompt may set skip_redraw. We don't want this
3118 * in cmdline mode */
3119 skip_redraw = FALSE;
3122 void
3123 compute_cmdrow()
3125 if (exmode_active || msg_scrolled != 0)
3126 cmdline_row = Rows - 1;
3127 else
3128 cmdline_row = W_WINROW(lastwin) + lastwin->w_height
3129 + W_STATUS_HEIGHT(lastwin);
3132 static void
3133 cursorcmd()
3135 if (cmd_silent)
3136 return;
3138 #ifdef FEAT_RIGHTLEFT
3139 if (cmdmsg_rl)
3141 msg_row = cmdline_row + (ccline.cmdspos / (int)(Columns - 1));
3142 msg_col = (int)Columns - (ccline.cmdspos % (int)(Columns - 1)) - 1;
3143 if (msg_row <= 0)
3144 msg_row = Rows - 1;
3146 else
3147 #endif
3149 msg_row = cmdline_row + (ccline.cmdspos / (int)Columns);
3150 msg_col = ccline.cmdspos % (int)Columns;
3151 if (msg_row >= Rows)
3152 msg_row = Rows - 1;
3155 windgoto(msg_row, msg_col);
3156 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
3157 redrawcmd_preedit();
3158 #endif
3159 #ifdef MCH_CURSOR_SHAPE
3160 mch_update_cursor();
3161 #endif
3164 void
3165 gotocmdline(clr)
3166 int clr;
3168 msg_start();
3169 #ifdef FEAT_RIGHTLEFT
3170 if (cmdmsg_rl)
3171 msg_col = Columns - 1;
3172 else
3173 #endif
3174 msg_col = 0; /* always start in column 0 */
3175 if (clr) /* clear the bottom line(s) */
3176 msg_clr_eos(); /* will reset clear_cmdline */
3177 windgoto(cmdline_row, 0);
3181 * Check the word in front of the cursor for an abbreviation.
3182 * Called when the non-id character "c" has been entered.
3183 * When an abbreviation is recognized it is removed from the text with
3184 * backspaces and the replacement string is inserted, followed by "c".
3186 static int
3187 ccheck_abbr(c)
3188 int c;
3190 if (p_paste || no_abbr) /* no abbreviations or in paste mode */
3191 return FALSE;
3193 return check_abbr(c, ccline.cmdbuff, ccline.cmdpos, 0);
3197 * Return FAIL if this is not an appropriate context in which to do
3198 * completion of anything, return OK if it is (even if there are no matches).
3199 * For the caller, this means that the character is just passed through like a
3200 * normal character (instead of being expanded). This allows :s/^I^D etc.
3202 static int
3203 nextwild(xp, type, options)
3204 expand_T *xp;
3205 int type;
3206 int options; /* extra options for ExpandOne() */
3208 int i, j;
3209 char_u *p1;
3210 char_u *p2;
3211 int oldlen;
3212 int difflen;
3213 int v;
3215 if (xp->xp_numfiles == -1)
3217 set_expand_context(xp);
3218 cmd_showtail = expand_showtail(xp);
3221 if (xp->xp_context == EXPAND_UNSUCCESSFUL)
3223 beep_flush();
3224 return OK; /* Something illegal on command line */
3226 if (xp->xp_context == EXPAND_NOTHING)
3228 /* Caller can use the character as a normal char instead */
3229 return FAIL;
3232 MSG_PUTS("..."); /* show that we are busy */
3233 out_flush();
3235 i = (int)(xp->xp_pattern - ccline.cmdbuff);
3236 oldlen = ccline.cmdpos - i;
3238 if (type == WILD_NEXT || type == WILD_PREV)
3241 * Get next/previous match for a previous expanded pattern.
3243 p2 = ExpandOne(xp, NULL, NULL, 0, type);
3245 else
3248 * Translate string into pattern and expand it.
3250 if ((p1 = addstar(&ccline.cmdbuff[i], oldlen, xp->xp_context)) == NULL)
3251 p2 = NULL;
3252 else
3254 p2 = ExpandOne(xp, p1, vim_strnsave(&ccline.cmdbuff[i], oldlen),
3255 WILD_HOME_REPLACE|WILD_ADD_SLASH|WILD_SILENT|WILD_ESCAPE
3256 |options, type);
3257 vim_free(p1);
3258 /* longest match: make sure it is not shorter (happens with :help */
3259 if (p2 != NULL && type == WILD_LONGEST)
3261 for (j = 0; j < oldlen; ++j)
3262 if (ccline.cmdbuff[i + j] == '*'
3263 || ccline.cmdbuff[i + j] == '?')
3264 break;
3265 if ((int)STRLEN(p2) < j)
3267 vim_free(p2);
3268 p2 = NULL;
3274 if (p2 != NULL && !got_int)
3276 difflen = (int)STRLEN(p2) - oldlen;
3277 if (ccline.cmdlen + difflen > ccline.cmdbufflen - 4)
3279 v = realloc_cmdbuff(ccline.cmdlen + difflen);
3280 xp->xp_pattern = ccline.cmdbuff + i;
3282 else
3283 v = OK;
3284 if (v == OK)
3286 mch_memmove(&ccline.cmdbuff[ccline.cmdpos + difflen],
3287 &ccline.cmdbuff[ccline.cmdpos],
3288 (size_t)(ccline.cmdlen - ccline.cmdpos + 1));
3289 mch_memmove(&ccline.cmdbuff[i], p2, STRLEN(p2));
3290 ccline.cmdlen += difflen;
3291 ccline.cmdpos += difflen;
3294 vim_free(p2);
3296 redrawcmd();
3297 cursorcmd();
3299 /* When expanding a ":map" command and no matches are found, assume that
3300 * the key is supposed to be inserted literally */
3301 if (xp->xp_context == EXPAND_MAPPINGS && p2 == NULL)
3302 return FAIL;
3304 if (xp->xp_numfiles <= 0 && p2 == NULL)
3305 beep_flush();
3306 else if (xp->xp_numfiles == 1)
3307 /* free expanded pattern */
3308 (void)ExpandOne(xp, NULL, NULL, 0, WILD_FREE);
3310 return OK;
3314 * Do wildcard expansion on the string 'str'.
3315 * Chars that should not be expanded must be preceded with a backslash.
3316 * Return a pointer to alloced memory containing the new string.
3317 * Return NULL for failure.
3319 * Results are cached in xp->xp_files and xp->xp_numfiles, except when "mode"
3320 * is WILD_EXPAND_FREE or WILD_ALL.
3322 * mode = WILD_FREE: just free previously expanded matches
3323 * mode = WILD_EXPAND_FREE: normal expansion, do not keep matches
3324 * mode = WILD_EXPAND_KEEP: normal expansion, keep matches
3325 * mode = WILD_NEXT: use next match in multiple match, wrap to first
3326 * mode = WILD_PREV: use previous match in multiple match, wrap to first
3327 * mode = WILD_ALL: return all matches concatenated
3328 * mode = WILD_LONGEST: return longest matched part
3330 * options = WILD_LIST_NOTFOUND: list entries without a match
3331 * options = WILD_HOME_REPLACE: do home_replace() for buffer names
3332 * options = WILD_USE_NL: Use '\n' for WILD_ALL
3333 * options = WILD_NO_BEEP: Don't beep for multiple matches
3334 * options = WILD_ADD_SLASH: add a slash after directory names
3335 * options = WILD_KEEP_ALL: don't remove 'wildignore' entries
3336 * options = WILD_SILENT: don't print warning messages
3337 * options = WILD_ESCAPE: put backslash before special chars
3339 * The variables xp->xp_context and xp->xp_backslash must have been set!
3341 char_u *
3342 ExpandOne(xp, str, orig, options, mode)
3343 expand_T *xp;
3344 char_u *str;
3345 char_u *orig; /* allocated copy of original of expanded string */
3346 int options;
3347 int mode;
3349 char_u *ss = NULL;
3350 static int findex;
3351 static char_u *orig_save = NULL; /* kept value of orig */
3352 int i;
3353 long_u len;
3354 int non_suf_match; /* number without matching suffix */
3357 * first handle the case of using an old match
3359 if (mode == WILD_NEXT || mode == WILD_PREV)
3361 if (xp->xp_numfiles > 0)
3363 if (mode == WILD_PREV)
3365 if (findex == -1)
3366 findex = xp->xp_numfiles;
3367 --findex;
3369 else /* mode == WILD_NEXT */
3370 ++findex;
3373 * When wrapping around, return the original string, set findex to
3374 * -1.
3376 if (findex < 0)
3378 if (orig_save == NULL)
3379 findex = xp->xp_numfiles - 1;
3380 else
3381 findex = -1;
3383 if (findex >= xp->xp_numfiles)
3385 if (orig_save == NULL)
3386 findex = 0;
3387 else
3388 findex = -1;
3390 #ifdef FEAT_WILDMENU
3391 if (p_wmnu)
3392 win_redr_status_matches(xp, xp->xp_numfiles, xp->xp_files,
3393 findex, cmd_showtail);
3394 #endif
3395 if (findex == -1)
3396 return vim_strsave(orig_save);
3397 return vim_strsave(xp->xp_files[findex]);
3399 else
3400 return NULL;
3403 /* free old names */
3404 if (xp->xp_numfiles != -1 && mode != WILD_ALL && mode != WILD_LONGEST)
3406 FreeWild(xp->xp_numfiles, xp->xp_files);
3407 xp->xp_numfiles = -1;
3408 vim_free(orig_save);
3409 orig_save = NULL;
3411 findex = 0;
3413 if (mode == WILD_FREE) /* only release file name */
3414 return NULL;
3416 if (xp->xp_numfiles == -1)
3418 vim_free(orig_save);
3419 orig_save = orig;
3422 * Do the expansion.
3424 if (ExpandFromContext(xp, str, &xp->xp_numfiles, &xp->xp_files,
3425 options) == FAIL)
3427 #ifdef FNAME_ILLEGAL
3428 /* Illegal file name has been silently skipped. But when there
3429 * are wildcards, the real problem is that there was no match,
3430 * causing the pattern to be added, which has illegal characters.
3432 if (!(options & WILD_SILENT) && (options & WILD_LIST_NOTFOUND))
3433 EMSG2(_(e_nomatch2), str);
3434 #endif
3436 else if (xp->xp_numfiles == 0)
3438 if (!(options & WILD_SILENT))
3439 EMSG2(_(e_nomatch2), str);
3441 else
3443 /* Escape the matches for use on the command line. */
3444 ExpandEscape(xp, str, xp->xp_numfiles, xp->xp_files, options);
3447 * Check for matching suffixes in file names.
3449 if (mode != WILD_ALL && mode != WILD_LONGEST)
3451 if (xp->xp_numfiles)
3452 non_suf_match = xp->xp_numfiles;
3453 else
3454 non_suf_match = 1;
3455 if ((xp->xp_context == EXPAND_FILES
3456 || xp->xp_context == EXPAND_DIRECTORIES)
3457 && xp->xp_numfiles > 1)
3460 * More than one match; check suffix.
3461 * The files will have been sorted on matching suffix in
3462 * expand_wildcards, only need to check the first two.
3464 non_suf_match = 0;
3465 for (i = 0; i < 2; ++i)
3466 if (match_suffix(xp->xp_files[i]))
3467 ++non_suf_match;
3469 if (non_suf_match != 1)
3471 /* Can we ever get here unless it's while expanding
3472 * interactively? If not, we can get rid of this all
3473 * together. Don't really want to wait for this message
3474 * (and possibly have to hit return to continue!).
3476 if (!(options & WILD_SILENT))
3477 EMSG(_(e_toomany));
3478 else if (!(options & WILD_NO_BEEP))
3479 beep_flush();
3481 if (!(non_suf_match != 1 && mode == WILD_EXPAND_FREE))
3482 ss = vim_strsave(xp->xp_files[0]);
3487 /* Find longest common part */
3488 if (mode == WILD_LONGEST && xp->xp_numfiles > 0)
3490 for (len = 0; xp->xp_files[0][len]; ++len)
3492 for (i = 0; i < xp->xp_numfiles; ++i)
3494 #ifdef CASE_INSENSITIVE_FILENAME
3495 if (xp->xp_context == EXPAND_DIRECTORIES
3496 || xp->xp_context == EXPAND_FILES
3497 || xp->xp_context == EXPAND_SHELLCMD
3498 || xp->xp_context == EXPAND_BUFFERS)
3500 if (TOLOWER_LOC(xp->xp_files[i][len]) !=
3501 TOLOWER_LOC(xp->xp_files[0][len]))
3502 break;
3504 else
3505 #endif
3506 if (xp->xp_files[i][len] != xp->xp_files[0][len])
3507 break;
3509 if (i < xp->xp_numfiles)
3511 if (!(options & WILD_NO_BEEP))
3512 vim_beep();
3513 break;
3516 ss = alloc((unsigned)len + 1);
3517 if (ss)
3518 vim_strncpy(ss, xp->xp_files[0], (size_t)len);
3519 findex = -1; /* next p_wc gets first one */
3522 /* Concatenate all matching names */
3523 if (mode == WILD_ALL && xp->xp_numfiles > 0)
3525 len = 0;
3526 for (i = 0; i < xp->xp_numfiles; ++i)
3527 len += (long_u)STRLEN(xp->xp_files[i]) + 1;
3528 ss = lalloc(len, TRUE);
3529 if (ss != NULL)
3531 *ss = NUL;
3532 for (i = 0; i < xp->xp_numfiles; ++i)
3534 STRCAT(ss, xp->xp_files[i]);
3535 if (i != xp->xp_numfiles - 1)
3536 STRCAT(ss, (options & WILD_USE_NL) ? "\n" : " ");
3541 if (mode == WILD_EXPAND_FREE || mode == WILD_ALL)
3542 ExpandCleanup(xp);
3544 return ss;
3548 * Prepare an expand structure for use.
3550 void
3551 ExpandInit(xp)
3552 expand_T *xp;
3554 xp->xp_backslash = XP_BS_NONE;
3555 #ifndef BACKSLASH_IN_FILENAME
3556 xp->xp_shell = FALSE;
3557 #endif
3558 xp->xp_numfiles = -1;
3559 xp->xp_files = NULL;
3560 #if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL) && defined(FEAT_CMDL_COMPL)
3561 xp->xp_arg = NULL;
3562 #endif
3566 * Cleanup an expand structure after use.
3568 void
3569 ExpandCleanup(xp)
3570 expand_T *xp;
3572 if (xp->xp_numfiles >= 0)
3574 FreeWild(xp->xp_numfiles, xp->xp_files);
3575 xp->xp_numfiles = -1;
3579 void
3580 ExpandEscape(xp, str, numfiles, files, options)
3581 expand_T *xp;
3582 char_u *str;
3583 int numfiles;
3584 char_u **files;
3585 int options;
3587 int i;
3588 char_u *p;
3591 * May change home directory back to "~"
3593 if (options & WILD_HOME_REPLACE)
3594 tilde_replace(str, numfiles, files);
3596 if (options & WILD_ESCAPE)
3598 if (xp->xp_context == EXPAND_FILES
3599 || xp->xp_context == EXPAND_SHELLCMD
3600 || xp->xp_context == EXPAND_BUFFERS
3601 || xp->xp_context == EXPAND_DIRECTORIES)
3604 * Insert a backslash into a file name before a space, \, %, #
3605 * and wildmatch characters, except '~'.
3607 for (i = 0; i < numfiles; ++i)
3609 /* for ":set path=" we need to escape spaces twice */
3610 if (xp->xp_backslash == XP_BS_THREE)
3612 p = vim_strsave_escaped(files[i], (char_u *)" ");
3613 if (p != NULL)
3615 vim_free(files[i]);
3616 files[i] = p;
3617 #if defined(BACKSLASH_IN_FILENAME)
3618 p = vim_strsave_escaped(files[i], (char_u *)" ");
3619 if (p != NULL)
3621 vim_free(files[i]);
3622 files[i] = p;
3624 #endif
3627 #ifdef BACKSLASH_IN_FILENAME
3629 char_u buf[20];
3630 int j = 0;
3632 /* Don't escape '[' and '{' if they are in 'isfname'. */
3633 for (p = PATH_ESC_CHARS; *p != NUL; ++p)
3634 if ((*p != '[' && *p != '{') || !vim_isfilec(*p))
3635 buf[j++] = *p;
3636 buf[j] = NUL;
3637 p = vim_strsave_escaped(files[i], buf);
3639 #else
3640 p = vim_strsave_escaped(files[i],
3641 xp->xp_shell ? SHELL_ESC_CHARS : PATH_ESC_CHARS);
3642 #endif
3643 if (p != NULL)
3645 vim_free(files[i]);
3646 files[i] = p;
3649 /* If 'str' starts with "\~", replace "~" at start of
3650 * files[i] with "\~". */
3651 if (str[0] == '\\' && str[1] == '~' && files[i][0] == '~')
3652 escape_fname(&files[i]);
3654 xp->xp_backslash = XP_BS_NONE;
3656 /* If the first file starts with a '+' escape it. Otherwise it
3657 * could be seen as "+cmd". */
3658 if (*files[0] == '+')
3659 escape_fname(&files[0]);
3661 else if (xp->xp_context == EXPAND_TAGS)
3664 * Insert a backslash before characters in a tag name that
3665 * would terminate the ":tag" command.
3667 for (i = 0; i < numfiles; ++i)
3669 p = vim_strsave_escaped(files[i], (char_u *)"\\|\"");
3670 if (p != NULL)
3672 vim_free(files[i]);
3673 files[i] = p;
3681 * Put a backslash before the file name in "pp", which is in allocated memory.
3683 static void
3684 escape_fname(pp)
3685 char_u **pp;
3687 char_u *p;
3689 p = alloc((unsigned)(STRLEN(*pp) + 2));
3690 if (p != NULL)
3692 p[0] = '\\';
3693 STRCPY(p + 1, *pp);
3694 vim_free(*pp);
3695 *pp = p;
3700 * For each file name in files[num_files]:
3701 * If 'orig_pat' starts with "~/", replace the home directory with "~".
3703 void
3704 tilde_replace(orig_pat, num_files, files)
3705 char_u *orig_pat;
3706 int num_files;
3707 char_u **files;
3709 int i;
3710 char_u *p;
3712 if (orig_pat[0] == '~' && vim_ispathsep(orig_pat[1]))
3714 for (i = 0; i < num_files; ++i)
3716 p = home_replace_save(NULL, files[i]);
3717 if (p != NULL)
3719 vim_free(files[i]);
3720 files[i] = p;
3727 * Show all matches for completion on the command line.
3728 * Returns EXPAND_NOTHING when the character that triggered expansion should
3729 * be inserted like a normal character.
3731 /*ARGSUSED*/
3732 static int
3733 showmatches(xp, wildmenu)
3734 expand_T *xp;
3735 int wildmenu;
3737 #define L_SHOWFILE(m) (showtail ? sm_gettail(files_found[m]) : files_found[m])
3738 int num_files;
3739 char_u **files_found;
3740 int i, j, k;
3741 int maxlen;
3742 int lines;
3743 int columns;
3744 char_u *p;
3745 int lastlen;
3746 int attr;
3747 int showtail;
3749 if (xp->xp_numfiles == -1)
3751 set_expand_context(xp);
3752 i = expand_cmdline(xp, ccline.cmdbuff, ccline.cmdpos,
3753 &num_files, &files_found);
3754 showtail = expand_showtail(xp);
3755 if (i != EXPAND_OK)
3756 return i;
3759 else
3761 num_files = xp->xp_numfiles;
3762 files_found = xp->xp_files;
3763 showtail = cmd_showtail;
3766 #ifdef FEAT_WILDMENU
3767 if (!wildmenu)
3769 #endif
3770 msg_didany = FALSE; /* lines_left will be set */
3771 msg_start(); /* prepare for paging */
3772 msg_putchar('\n');
3773 out_flush();
3774 cmdline_row = msg_row;
3775 msg_didany = FALSE; /* lines_left will be set again */
3776 msg_start(); /* prepare for paging */
3777 #ifdef FEAT_WILDMENU
3779 #endif
3781 if (got_int)
3782 got_int = FALSE; /* only int. the completion, not the cmd line */
3783 #ifdef FEAT_WILDMENU
3784 else if (wildmenu)
3785 win_redr_status_matches(xp, num_files, files_found, 0, showtail);
3786 #endif
3787 else
3789 /* find the length of the longest file name */
3790 maxlen = 0;
3791 for (i = 0; i < num_files; ++i)
3793 if (!showtail && (xp->xp_context == EXPAND_FILES
3794 || xp->xp_context == EXPAND_SHELLCMD
3795 || xp->xp_context == EXPAND_BUFFERS))
3797 home_replace(NULL, files_found[i], NameBuff, MAXPATHL, TRUE);
3798 j = vim_strsize(NameBuff);
3800 else
3801 j = vim_strsize(L_SHOWFILE(i));
3802 if (j > maxlen)
3803 maxlen = j;
3806 if (xp->xp_context == EXPAND_TAGS_LISTFILES)
3807 lines = num_files;
3808 else
3810 /* compute the number of columns and lines for the listing */
3811 maxlen += 2; /* two spaces between file names */
3812 columns = ((int)Columns + 2) / maxlen;
3813 if (columns < 1)
3814 columns = 1;
3815 lines = (num_files + columns - 1) / columns;
3818 attr = hl_attr(HLF_D); /* find out highlighting for directories */
3820 if (xp->xp_context == EXPAND_TAGS_LISTFILES)
3822 MSG_PUTS_ATTR(_("tagname"), hl_attr(HLF_T));
3823 msg_clr_eos();
3824 msg_advance(maxlen - 3);
3825 MSG_PUTS_ATTR(_(" kind file\n"), hl_attr(HLF_T));
3828 /* list the files line by line */
3829 for (i = 0; i < lines; ++i)
3831 lastlen = 999;
3832 for (k = i; k < num_files; k += lines)
3834 if (xp->xp_context == EXPAND_TAGS_LISTFILES)
3836 msg_outtrans_attr(files_found[k], hl_attr(HLF_D));
3837 p = files_found[k] + STRLEN(files_found[k]) + 1;
3838 msg_advance(maxlen + 1);
3839 msg_puts(p);
3840 msg_advance(maxlen + 3);
3841 msg_puts_long_attr(p + 2, hl_attr(HLF_D));
3842 break;
3844 for (j = maxlen - lastlen; --j >= 0; )
3845 msg_putchar(' ');
3846 if (xp->xp_context == EXPAND_FILES
3847 || xp->xp_context == EXPAND_SHELLCMD
3848 || xp->xp_context == EXPAND_BUFFERS)
3850 /* highlight directories */
3851 j = (mch_isdir(files_found[k]));
3852 if (showtail)
3853 p = L_SHOWFILE(k);
3854 else
3856 home_replace(NULL, files_found[k], NameBuff, MAXPATHL,
3857 TRUE);
3858 p = NameBuff;
3861 else
3863 j = FALSE;
3864 p = L_SHOWFILE(k);
3866 lastlen = msg_outtrans_attr(p, j ? attr : 0);
3868 if (msg_col > 0) /* when not wrapped around */
3870 msg_clr_eos();
3871 msg_putchar('\n');
3873 out_flush(); /* show one line at a time */
3874 if (got_int)
3876 got_int = FALSE;
3877 break;
3882 * we redraw the command below the lines that we have just listed
3883 * This is a bit tricky, but it saves a lot of screen updating.
3885 cmdline_row = msg_row; /* will put it back later */
3888 if (xp->xp_numfiles == -1)
3889 FreeWild(num_files, files_found);
3891 return EXPAND_OK;
3895 * Private gettail for showmatches() (and win_redr_status_matches()):
3896 * Find tail of file name path, but ignore trailing "/".
3898 char_u *
3899 sm_gettail(s)
3900 char_u *s;
3902 char_u *p;
3903 char_u *t = s;
3904 int had_sep = FALSE;
3906 for (p = s; *p != NUL; )
3908 if (vim_ispathsep(*p)
3909 #ifdef BACKSLASH_IN_FILENAME
3910 && !rem_backslash(p)
3911 #endif
3913 had_sep = TRUE;
3914 else if (had_sep)
3916 t = p;
3917 had_sep = FALSE;
3919 mb_ptr_adv(p);
3921 return t;
3925 * Return TRUE if we only need to show the tail of completion matches.
3926 * When not completing file names or there is a wildcard in the path FALSE is
3927 * returned.
3929 static int
3930 expand_showtail(xp)
3931 expand_T *xp;
3933 char_u *s;
3934 char_u *end;
3936 /* When not completing file names a "/" may mean something different. */
3937 if (xp->xp_context != EXPAND_FILES
3938 && xp->xp_context != EXPAND_SHELLCMD
3939 && xp->xp_context != EXPAND_DIRECTORIES)
3940 return FALSE;
3942 end = gettail(xp->xp_pattern);
3943 if (end == xp->xp_pattern) /* there is no path separator */
3944 return FALSE;
3946 for (s = xp->xp_pattern; s < end; s++)
3948 /* Skip escaped wildcards. Only when the backslash is not a path
3949 * separator, on DOS the '*' "path\*\file" must not be skipped. */
3950 if (rem_backslash(s))
3951 ++s;
3952 else if (vim_strchr((char_u *)"*?[", *s) != NULL)
3953 return FALSE;
3955 return TRUE;
3959 * Prepare a string for expansion.
3960 * When expanding file names: The string will be used with expand_wildcards().
3961 * Copy the file name into allocated memory and add a '*' at the end.
3962 * When expanding other names: The string will be used with regcomp(). Copy
3963 * the name into allocated memory and prepend "^".
3965 char_u *
3966 addstar(fname, len, context)
3967 char_u *fname;
3968 int len;
3969 int context; /* EXPAND_FILES etc. */
3971 char_u *retval;
3972 int i, j;
3973 int new_len;
3974 char_u *tail;
3976 if (context != EXPAND_FILES
3977 && context != EXPAND_SHELLCMD
3978 && context != EXPAND_DIRECTORIES)
3981 * Matching will be done internally (on something other than files).
3982 * So we convert the file-matching-type wildcards into our kind for
3983 * use with vim_regcomp(). First work out how long it will be:
3986 /* For help tags the translation is done in find_help_tags().
3987 * For a tag pattern starting with "/" no translation is needed. */
3988 if (context == EXPAND_HELP
3989 || context == EXPAND_COLORS
3990 || context == EXPAND_COMPILER
3991 || (context == EXPAND_TAGS && fname[0] == '/'))
3992 retval = vim_strnsave(fname, len);
3993 else
3995 new_len = len + 2; /* +2 for '^' at start, NUL at end */
3996 for (i = 0; i < len; i++)
3998 if (fname[i] == '*' || fname[i] == '~')
3999 new_len++; /* '*' needs to be replaced by ".*"
4000 '~' needs to be replaced by "\~" */
4002 /* Buffer names are like file names. "." should be literal */
4003 if (context == EXPAND_BUFFERS && fname[i] == '.')
4004 new_len++; /* "." becomes "\." */
4006 /* Custom expansion takes care of special things, match
4007 * backslashes literally (perhaps also for other types?) */
4008 if ((context == EXPAND_USER_DEFINED
4009 || context == EXPAND_USER_LIST) && fname[i] == '\\')
4010 new_len++; /* '\' becomes "\\" */
4012 retval = alloc(new_len);
4013 if (retval != NULL)
4015 retval[0] = '^';
4016 j = 1;
4017 for (i = 0; i < len; i++, j++)
4019 /* Skip backslash. But why? At least keep it for custom
4020 * expansion. */
4021 if (context != EXPAND_USER_DEFINED
4022 && context != EXPAND_USER_LIST
4023 && fname[i] == '\\'
4024 && ++i == len)
4025 break;
4027 switch (fname[i])
4029 case '*': retval[j++] = '.';
4030 break;
4031 case '~': retval[j++] = '\\';
4032 break;
4033 case '?': retval[j] = '.';
4034 continue;
4035 case '.': if (context == EXPAND_BUFFERS)
4036 retval[j++] = '\\';
4037 break;
4038 case '\\': if (context == EXPAND_USER_DEFINED
4039 || context == EXPAND_USER_LIST)
4040 retval[j++] = '\\';
4041 break;
4043 retval[j] = fname[i];
4045 retval[j] = NUL;
4049 else
4051 retval = alloc(len + 4);
4052 if (retval != NULL)
4054 vim_strncpy(retval, fname, len);
4057 * Don't add a star to *, ~, ~user, $var or `cmd`.
4058 * * would become **, which walks the whole tree.
4059 * ~ would be at the start of the file name, but not the tail.
4060 * $ could be anywhere in the tail.
4061 * ` could be anywhere in the file name.
4063 tail = gettail(retval);
4064 if ((*retval != '~' || tail != retval)
4065 && (len == 0 || retval[len - 1] != '*')
4066 && vim_strchr(tail, '$') == NULL
4067 && vim_strchr(retval, '`') == NULL)
4068 retval[len++] = '*';
4069 retval[len] = NUL;
4072 return retval;
4076 * Must parse the command line so far to work out what context we are in.
4077 * Completion can then be done based on that context.
4078 * This routine sets the variables:
4079 * xp->xp_pattern The start of the pattern to be expanded within
4080 * the command line (ends at the cursor).
4081 * xp->xp_context The type of thing to expand. Will be one of:
4083 * EXPAND_UNSUCCESSFUL Used sometimes when there is something illegal on
4084 * the command line, like an unknown command. Caller
4085 * should beep.
4086 * EXPAND_NOTHING Unrecognised context for completion, use char like
4087 * a normal char, rather than for completion. eg
4088 * :s/^I/
4089 * EXPAND_COMMANDS Cursor is still touching the command, so complete
4090 * it.
4091 * EXPAND_BUFFERS Complete file names for :buf and :sbuf commands.
4092 * EXPAND_FILES After command with XFILE set, or after setting
4093 * with P_EXPAND set. eg :e ^I, :w>>^I
4094 * EXPAND_DIRECTORIES In some cases this is used instead of the latter
4095 * when we know only directories are of interest. eg
4096 * :set dir=^I
4097 * EXPAND_SHELLCMD After ":!cmd", ":r !cmd" or ":w !cmd".
4098 * EXPAND_SETTINGS Complete variable names. eg :set d^I
4099 * EXPAND_BOOL_SETTINGS Complete boolean variables only, eg :set no^I
4100 * EXPAND_TAGS Complete tags from the files in p_tags. eg :ta a^I
4101 * EXPAND_TAGS_LISTFILES As above, but list filenames on ^D, after :tselect
4102 * EXPAND_HELP Complete tags from the file 'helpfile'/tags
4103 * EXPAND_EVENTS Complete event names
4104 * EXPAND_SYNTAX Complete :syntax command arguments
4105 * EXPAND_HIGHLIGHT Complete highlight (syntax) group names
4106 * EXPAND_AUGROUP Complete autocommand group names
4107 * EXPAND_USER_VARS Complete user defined variable names, eg :unlet a^I
4108 * EXPAND_MAPPINGS Complete mapping and abbreviation names,
4109 * eg :unmap a^I , :cunab x^I
4110 * EXPAND_FUNCTIONS Complete internal or user defined function names,
4111 * eg :call sub^I
4112 * EXPAND_USER_FUNC Complete user defined function names, eg :delf F^I
4113 * EXPAND_EXPRESSION Complete internal or user defined function/variable
4114 * names in expressions, eg :while s^I
4115 * EXPAND_ENV_VARS Complete environment variable names
4117 static void
4118 set_expand_context(xp)
4119 expand_T *xp;
4121 /* only expansion for ':', '>' and '=' command-lines */
4122 if (ccline.cmdfirstc != ':'
4123 #ifdef FEAT_EVAL
4124 && ccline.cmdfirstc != '>' && ccline.cmdfirstc != '='
4125 && !ccline.input_fn
4126 #endif
4129 xp->xp_context = EXPAND_NOTHING;
4130 return;
4132 set_cmd_context(xp, ccline.cmdbuff, ccline.cmdlen, ccline.cmdpos);
4135 void
4136 set_cmd_context(xp, str, len, col)
4137 expand_T *xp;
4138 char_u *str; /* start of command line */
4139 int len; /* length of command line (excl. NUL) */
4140 int col; /* position of cursor */
4142 int old_char = NUL;
4143 char_u *nextcomm;
4146 * Avoid a UMR warning from Purify, only save the character if it has been
4147 * written before.
4149 if (col < len)
4150 old_char = str[col];
4151 str[col] = NUL;
4152 nextcomm = str;
4154 #ifdef FEAT_EVAL
4155 if (ccline.cmdfirstc == '=')
4157 # ifdef FEAT_CMDL_COMPL
4158 /* pass CMD_SIZE because there is no real command */
4159 set_context_for_expression(xp, str, CMD_SIZE);
4160 # endif
4162 else if (ccline.input_fn)
4164 xp->xp_context = ccline.xp_context;
4165 xp->xp_pattern = ccline.cmdbuff;
4166 # if defined(FEAT_USR_CMDS) && defined(FEAT_CMDL_COMPL)
4167 xp->xp_arg = ccline.xp_arg;
4168 # endif
4170 else
4171 #endif
4172 while (nextcomm != NULL)
4173 nextcomm = set_one_cmd_context(xp, nextcomm);
4175 str[col] = old_char;
4179 * Expand the command line "str" from context "xp".
4180 * "xp" must have been set by set_cmd_context().
4181 * xp->xp_pattern points into "str", to where the text that is to be expanded
4182 * starts.
4183 * Returns EXPAND_UNSUCCESSFUL when there is something illegal before the
4184 * cursor.
4185 * Returns EXPAND_NOTHING when there is nothing to expand, might insert the
4186 * key that triggered expansion literally.
4187 * Returns EXPAND_OK otherwise.
4190 expand_cmdline(xp, str, col, matchcount, matches)
4191 expand_T *xp;
4192 char_u *str; /* start of command line */
4193 int col; /* position of cursor */
4194 int *matchcount; /* return: nr of matches */
4195 char_u ***matches; /* return: array of pointers to matches */
4197 char_u *file_str = NULL;
4199 if (xp->xp_context == EXPAND_UNSUCCESSFUL)
4201 beep_flush();
4202 return EXPAND_UNSUCCESSFUL; /* Something illegal on command line */
4204 if (xp->xp_context == EXPAND_NOTHING)
4206 /* Caller can use the character as a normal char instead */
4207 return EXPAND_NOTHING;
4210 /* add star to file name, or convert to regexp if not exp. files. */
4211 file_str = addstar(xp->xp_pattern,
4212 (int)(str + col - xp->xp_pattern), xp->xp_context);
4213 if (file_str == NULL)
4214 return EXPAND_UNSUCCESSFUL;
4216 /* find all files that match the description */
4217 if (ExpandFromContext(xp, file_str, matchcount, matches,
4218 WILD_ADD_SLASH|WILD_SILENT) == FAIL)
4220 *matchcount = 0;
4221 *matches = NULL;
4223 vim_free(file_str);
4225 return EXPAND_OK;
4228 #ifdef FEAT_MULTI_LANG
4230 * Cleanup matches for help tags: remove "@en" if "en" is the only language.
4232 static void cleanup_help_tags __ARGS((int num_file, char_u **file));
4234 static void
4235 cleanup_help_tags(num_file, file)
4236 int num_file;
4237 char_u **file;
4239 int i, j;
4240 int len;
4242 for (i = 0; i < num_file; ++i)
4244 len = (int)STRLEN(file[i]) - 3;
4245 if (len > 0 && STRCMP(file[i] + len, "@en") == 0)
4247 /* Sorting on priority means the same item in another language may
4248 * be anywhere. Search all items for a match up to the "@en". */
4249 for (j = 0; j < num_file; ++j)
4250 if (j != i
4251 && (int)STRLEN(file[j]) == len + 3
4252 && STRNCMP(file[i], file[j], len + 1) == 0)
4253 break;
4254 if (j == num_file)
4255 file[i][len] = NUL;
4259 #endif
4262 * Do the expansion based on xp->xp_context and "pat".
4264 static int
4265 ExpandFromContext(xp, pat, num_file, file, options)
4266 expand_T *xp;
4267 char_u *pat;
4268 int *num_file;
4269 char_u ***file;
4270 int options;
4272 #ifdef FEAT_CMDL_COMPL
4273 regmatch_T regmatch;
4274 #endif
4275 int ret;
4276 int flags;
4278 flags = EW_DIR; /* include directories */
4279 if (options & WILD_LIST_NOTFOUND)
4280 flags |= EW_NOTFOUND;
4281 if (options & WILD_ADD_SLASH)
4282 flags |= EW_ADDSLASH;
4283 if (options & WILD_KEEP_ALL)
4284 flags |= EW_KEEPALL;
4285 if (options & WILD_SILENT)
4286 flags |= EW_SILENT;
4288 if (xp->xp_context == EXPAND_FILES || xp->xp_context == EXPAND_DIRECTORIES)
4291 * Expand file or directory names.
4293 int free_pat = FALSE;
4294 int i;
4296 /* for ":set path=" and ":set tags=" halve backslashes for escaped
4297 * space */
4298 if (xp->xp_backslash != XP_BS_NONE)
4300 free_pat = TRUE;
4301 pat = vim_strsave(pat);
4302 for (i = 0; pat[i]; ++i)
4303 if (pat[i] == '\\')
4305 if (xp->xp_backslash == XP_BS_THREE
4306 && pat[i + 1] == '\\'
4307 && pat[i + 2] == '\\'
4308 && pat[i + 3] == ' ')
4309 STRCPY(pat + i, pat + i + 3);
4310 if (xp->xp_backslash == XP_BS_ONE
4311 && pat[i + 1] == ' ')
4312 STRCPY(pat + i, pat + i + 1);
4316 if (xp->xp_context == EXPAND_FILES)
4317 flags |= EW_FILE;
4318 else
4319 flags = (flags | EW_DIR) & ~EW_FILE;
4320 ret = expand_wildcards(1, &pat, num_file, file, flags);
4321 if (free_pat)
4322 vim_free(pat);
4323 return ret;
4326 *file = (char_u **)"";
4327 *num_file = 0;
4328 if (xp->xp_context == EXPAND_HELP)
4330 if (find_help_tags(pat, num_file, file, FALSE) == OK)
4332 #ifdef FEAT_MULTI_LANG
4333 cleanup_help_tags(*num_file, *file);
4334 #endif
4335 return OK;
4337 return FAIL;
4340 #ifndef FEAT_CMDL_COMPL
4341 return FAIL;
4342 #else
4343 if (xp->xp_context == EXPAND_SHELLCMD)
4344 return expand_shellcmd(pat, num_file, file, flags);
4345 if (xp->xp_context == EXPAND_OLD_SETTING)
4346 return ExpandOldSetting(num_file, file);
4347 if (xp->xp_context == EXPAND_BUFFERS)
4348 return ExpandBufnames(pat, num_file, file, options);
4349 if (xp->xp_context == EXPAND_TAGS
4350 || xp->xp_context == EXPAND_TAGS_LISTFILES)
4351 return expand_tags(xp->xp_context == EXPAND_TAGS, pat, num_file, file);
4352 if (xp->xp_context == EXPAND_COLORS)
4353 return ExpandRTDir(pat, num_file, file, "colors");
4354 if (xp->xp_context == EXPAND_COMPILER)
4355 return ExpandRTDir(pat, num_file, file, "compiler");
4356 # if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL)
4357 if (xp->xp_context == EXPAND_USER_LIST)
4358 return ExpandUserList(xp, num_file, file);
4359 # endif
4361 regmatch.regprog = vim_regcomp(pat, p_magic ? RE_MAGIC : 0);
4362 if (regmatch.regprog == NULL)
4363 return FAIL;
4365 /* set ignore-case according to p_ic, p_scs and pat */
4366 regmatch.rm_ic = ignorecase(pat);
4368 if (xp->xp_context == EXPAND_SETTINGS
4369 || xp->xp_context == EXPAND_BOOL_SETTINGS)
4370 ret = ExpandSettings(xp, &regmatch, num_file, file);
4371 else if (xp->xp_context == EXPAND_MAPPINGS)
4372 ret = ExpandMappings(&regmatch, num_file, file);
4373 # if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL)
4374 else if (xp->xp_context == EXPAND_USER_DEFINED)
4375 ret = ExpandUserDefined(xp, &regmatch, num_file, file);
4376 # endif
4377 else
4379 static struct expgen
4381 int context;
4382 char_u *((*func)__ARGS((expand_T *, int)));
4383 int ic;
4384 } tab[] =
4386 {EXPAND_COMMANDS, get_command_name, FALSE},
4387 #ifdef FEAT_USR_CMDS
4388 {EXPAND_USER_COMMANDS, get_user_commands, FALSE},
4389 {EXPAND_USER_CMD_FLAGS, get_user_cmd_flags, FALSE},
4390 {EXPAND_USER_NARGS, get_user_cmd_nargs, FALSE},
4391 {EXPAND_USER_COMPLETE, get_user_cmd_complete, FALSE},
4392 #endif
4393 #ifdef FEAT_EVAL
4394 {EXPAND_USER_VARS, get_user_var_name, FALSE},
4395 {EXPAND_FUNCTIONS, get_function_name, FALSE},
4396 {EXPAND_USER_FUNC, get_user_func_name, FALSE},
4397 {EXPAND_EXPRESSION, get_expr_name, FALSE},
4398 #endif
4399 #ifdef FEAT_MENU
4400 {EXPAND_MENUS, get_menu_name, FALSE},
4401 {EXPAND_MENUNAMES, get_menu_names, FALSE},
4402 #endif
4403 #ifdef FEAT_SYN_HL
4404 {EXPAND_SYNTAX, get_syntax_name, TRUE},
4405 #endif
4406 {EXPAND_HIGHLIGHT, get_highlight_name, TRUE},
4407 #ifdef FEAT_AUTOCMD
4408 {EXPAND_EVENTS, get_event_name, TRUE},
4409 {EXPAND_AUGROUP, get_augroup_name, TRUE},
4410 #endif
4411 #if (defined(HAVE_LOCALE_H) || defined(X_LOCALE)) \
4412 && (defined(FEAT_GETTEXT) || defined(FEAT_MBYTE))
4413 {EXPAND_LANGUAGE, get_lang_arg, TRUE},
4414 #endif
4415 {EXPAND_ENV_VARS, get_env_name, TRUE},
4417 int i;
4420 * Find a context in the table and call the ExpandGeneric() with the
4421 * right function to do the expansion.
4423 ret = FAIL;
4424 for (i = 0; i < sizeof(tab) / sizeof(struct expgen); ++i)
4425 if (xp->xp_context == tab[i].context)
4427 if (tab[i].ic)
4428 regmatch.rm_ic = TRUE;
4429 ret = ExpandGeneric(xp, &regmatch, num_file, file, tab[i].func);
4430 break;
4434 vim_free(regmatch.regprog);
4436 return ret;
4437 #endif /* FEAT_CMDL_COMPL */
4440 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
4442 * Expand a list of names.
4444 * Generic function for command line completion. It calls a function to
4445 * obtain strings, one by one. The strings are matched against a regexp
4446 * program. Matching strings are copied into an array, which is returned.
4448 * Returns OK when no problems encountered, FAIL for error (out of memory).
4451 ExpandGeneric(xp, regmatch, num_file, file, func)
4452 expand_T *xp;
4453 regmatch_T *regmatch;
4454 int *num_file;
4455 char_u ***file;
4456 char_u *((*func)__ARGS((expand_T *, int)));
4457 /* returns a string from the list */
4459 int i;
4460 int count = 0;
4461 int round;
4462 char_u *str;
4464 /* do this loop twice:
4465 * round == 0: count the number of matching names
4466 * round == 1: copy the matching names into allocated memory
4468 for (round = 0; round <= 1; ++round)
4470 for (i = 0; ; ++i)
4472 str = (*func)(xp, i);
4473 if (str == NULL) /* end of list */
4474 break;
4475 if (*str == NUL) /* skip empty strings */
4476 continue;
4478 if (vim_regexec(regmatch, str, (colnr_T)0))
4480 if (round)
4482 str = vim_strsave_escaped(str, (char_u *)" \t\\.");
4483 (*file)[count] = str;
4484 #ifdef FEAT_MENU
4485 if (func == get_menu_names && str != NULL)
4487 /* test for separator added by get_menu_names() */
4488 str += STRLEN(str) - 1;
4489 if (*str == '\001')
4490 *str = '.';
4492 #endif
4494 ++count;
4497 if (round == 0)
4499 if (count == 0)
4500 return OK;
4501 *num_file = count;
4502 *file = (char_u **)alloc((unsigned)(count * sizeof(char_u *)));
4503 if (*file == NULL)
4505 *file = (char_u **)"";
4506 return FAIL;
4508 count = 0;
4512 /* Sort the results. Keep menu's in the specified order. */
4513 if (xp->xp_context != EXPAND_MENUNAMES && xp->xp_context != EXPAND_MENUS)
4514 sort_strings(*file, *num_file);
4516 #ifdef FEAT_CMDL_COMPL
4517 /* Reset the variables used for special highlight names expansion, so that
4518 * they don't show up when getting normal highlight names by ID. */
4519 reset_expand_highlight();
4520 #endif
4522 return OK;
4526 * Complete a shell command.
4527 * Returns FAIL or OK;
4529 static int
4530 expand_shellcmd(filepat, num_file, file, flagsarg)
4531 char_u *filepat; /* pattern to match with command names */
4532 int *num_file; /* return: number of matches */
4533 char_u ***file; /* return: array with matches */
4534 int flagsarg; /* EW_ flags */
4536 char_u *pat;
4537 int i;
4538 char_u *path;
4539 int mustfree = FALSE;
4540 garray_T ga;
4541 char_u *buf = alloc(MAXPATHL);
4542 size_t l;
4543 char_u *s, *e;
4544 int flags = flagsarg;
4545 int ret;
4547 if (buf == NULL)
4548 return FAIL;
4550 /* for ":set path=" and ":set tags=" halve backslashes for escaped
4551 * space */
4552 pat = vim_strsave(filepat);
4553 for (i = 0; pat[i]; ++i)
4554 if (pat[i] == '\\' && pat[i + 1] == ' ')
4555 STRCPY(pat + i, pat + i + 1);
4557 flags |= EW_FILE | EW_EXEC;
4559 /* For an absolute name we don't use $PATH. */
4560 if (mch_isFullName(pat))
4561 path = (char_u *)" ";
4562 else if ((pat[0] == '.' && (vim_ispathsep(pat[1])
4563 || (pat[1] == '.' && vim_ispathsep(pat[2])))))
4564 path = (char_u *)".";
4565 else
4566 path = vim_getenv((char_u *)"PATH", &mustfree);
4569 * Go over all directories in $PATH. Expand matches in that directory and
4570 * collect them in "ga".
4572 ga_init2(&ga, (int)sizeof(char *), 10);
4573 for (s = path; *s != NUL; s = e)
4575 if (*s == ' ')
4576 ++s; /* Skip space used for absolute path name. */
4578 #if defined(MSDOS) || defined(MSWIN) || defined(OS2)
4579 e = vim_strchr(s, ';');
4580 #else
4581 e = vim_strchr(s, ':');
4582 #endif
4583 if (e == NULL)
4584 e = s + STRLEN(s);
4586 l = e - s;
4587 if (l > MAXPATHL - 5)
4588 break;
4589 vim_strncpy(buf, s, l);
4590 add_pathsep(buf);
4591 l = STRLEN(buf);
4592 vim_strncpy(buf + l, pat, MAXPATHL - 1 - l);
4594 /* Expand matches in one directory of $PATH. */
4595 ret = expand_wildcards(1, &buf, num_file, file, flags);
4596 if (ret == OK)
4598 if (ga_grow(&ga, *num_file) == FAIL)
4599 FreeWild(*num_file, *file);
4600 else
4602 for (i = 0; i < *num_file; ++i)
4604 s = (*file)[i];
4605 if (STRLEN(s) > l)
4607 /* Remove the path again. */
4608 mch_memmove(s, s + l, STRLEN(s + l) + 1);
4609 ((char_u **)ga.ga_data)[ga.ga_len++] = s;
4611 else
4612 vim_free(s);
4614 vim_free(*file);
4617 if (*e != NUL)
4618 ++e;
4620 *file = ga.ga_data;
4621 *num_file = ga.ga_len;
4623 vim_free(buf);
4624 vim_free(pat);
4625 if (mustfree)
4626 vim_free(path);
4627 return OK;
4631 # if defined(FEAT_USR_CMDS) && defined(FEAT_EVAL)
4632 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));
4635 * call "user_expand_func()" to invoke a user defined VimL function and return
4636 * the result (either a string or a List).
4638 static void *
4639 call_user_expand_func(user_expand_func, xp, num_file, file)
4640 void *(*user_expand_func) __ARGS((char_u *, int, char_u **, int));
4641 expand_T *xp;
4642 int *num_file;
4643 char_u ***file;
4645 char_u keep;
4646 char_u num[50];
4647 char_u *args[3];
4648 int save_current_SID = current_SID;
4649 void *ret;
4650 struct cmdline_info save_ccline;
4652 if (xp->xp_arg == NULL || xp->xp_arg[0] == '\0')
4653 return NULL;
4654 *num_file = 0;
4655 *file = NULL;
4657 keep = ccline.cmdbuff[ccline.cmdlen];
4658 ccline.cmdbuff[ccline.cmdlen] = 0;
4659 sprintf((char *)num, "%d", ccline.cmdpos);
4660 args[0] = xp->xp_pattern;
4661 args[1] = ccline.cmdbuff;
4662 args[2] = num;
4664 /* Save the cmdline, we don't know what the function may do. */
4665 save_ccline = ccline;
4666 ccline.cmdbuff = NULL;
4667 ccline.cmdprompt = NULL;
4668 current_SID = xp->xp_scriptID;
4670 ret = user_expand_func(xp->xp_arg, 3, args, FALSE);
4672 ccline = save_ccline;
4673 current_SID = save_current_SID;
4675 ccline.cmdbuff[ccline.cmdlen] = keep;
4677 return ret;
4681 * Expand names with a function defined by the user.
4683 static int
4684 ExpandUserDefined(xp, regmatch, num_file, file)
4685 expand_T *xp;
4686 regmatch_T *regmatch;
4687 int *num_file;
4688 char_u ***file;
4690 char_u *retstr;
4691 char_u *s;
4692 char_u *e;
4693 char_u keep;
4694 garray_T ga;
4696 retstr = call_user_expand_func(call_func_retstr, xp, num_file, file);
4697 if (retstr == NULL)
4698 return FAIL;
4700 ga_init2(&ga, (int)sizeof(char *), 3);
4701 for (s = retstr; *s != NUL; s = e)
4703 e = vim_strchr(s, '\n');
4704 if (e == NULL)
4705 e = s + STRLEN(s);
4706 keep = *e;
4707 *e = 0;
4709 if (xp->xp_pattern[0] && vim_regexec(regmatch, s, (colnr_T)0) == 0)
4711 *e = keep;
4712 if (*e != NUL)
4713 ++e;
4714 continue;
4717 if (ga_grow(&ga, 1) == FAIL)
4718 break;
4720 ((char_u **)ga.ga_data)[ga.ga_len] = vim_strnsave(s, (int)(e - s));
4721 ++ga.ga_len;
4723 *e = keep;
4724 if (*e != NUL)
4725 ++e;
4727 vim_free(retstr);
4728 *file = ga.ga_data;
4729 *num_file = ga.ga_len;
4730 return OK;
4734 * Expand names with a list returned by a function defined by the user.
4736 static int
4737 ExpandUserList(xp, num_file, file)
4738 expand_T *xp;
4739 int *num_file;
4740 char_u ***file;
4742 list_T *retlist;
4743 listitem_T *li;
4744 garray_T ga;
4746 retlist = call_user_expand_func(call_func_retlist, xp, num_file, file);
4747 if (retlist == NULL)
4748 return FAIL;
4750 ga_init2(&ga, (int)sizeof(char *), 3);
4751 /* Loop over the items in the list. */
4752 for (li = retlist->lv_first; li != NULL; li = li->li_next)
4754 if (li->li_tv.v_type != VAR_STRING)
4755 continue; /* Skip non-string items */
4757 if (ga_grow(&ga, 1) == FAIL)
4758 break;
4760 ((char_u **)ga.ga_data)[ga.ga_len] =
4761 vim_strsave(li->li_tv.vval.v_string);
4762 ++ga.ga_len;
4764 list_unref(retlist);
4766 *file = ga.ga_data;
4767 *num_file = ga.ga_len;
4768 return OK;
4770 #endif
4773 * Expand color scheme names: 'runtimepath'/colors/{pat}.vim
4774 * or compiler names.
4776 static int
4777 ExpandRTDir(pat, num_file, file, dirname)
4778 char_u *pat;
4779 int *num_file;
4780 char_u ***file;
4781 char *dirname; /* "colors" or "compiler" */
4783 char_u *all;
4784 char_u *s;
4785 char_u *e;
4786 garray_T ga;
4788 *num_file = 0;
4789 *file = NULL;
4790 s = alloc((unsigned)(STRLEN(pat) + STRLEN(dirname) + 7));
4791 if (s == NULL)
4792 return FAIL;
4793 sprintf((char *)s, "%s/%s*.vim", dirname, pat);
4794 all = globpath(p_rtp, s);
4795 vim_free(s);
4796 if (all == NULL)
4797 return FAIL;
4799 ga_init2(&ga, (int)sizeof(char *), 3);
4800 for (s = all; *s != NUL; s = e)
4802 e = vim_strchr(s, '\n');
4803 if (e == NULL)
4804 e = s + STRLEN(s);
4805 if (ga_grow(&ga, 1) == FAIL)
4806 break;
4807 if (e - 4 > s && STRNICMP(e - 4, ".vim", 4) == 0)
4809 for (s = e - 4; s > all; mb_ptr_back(all, s))
4810 if (*s == '\n' || vim_ispathsep(*s))
4811 break;
4812 ++s;
4813 ((char_u **)ga.ga_data)[ga.ga_len] =
4814 vim_strnsave(s, (int)(e - s - 4));
4815 ++ga.ga_len;
4817 if (*e != NUL)
4818 ++e;
4820 vim_free(all);
4821 *file = ga.ga_data;
4822 *num_file = ga.ga_len;
4823 return OK;
4826 #endif
4828 #if defined(FEAT_CMDL_COMPL) || defined(FEAT_EVAL) || defined(PROTO)
4830 * Expand "file" for all comma-separated directories in "path".
4831 * Returns an allocated string with all matches concatenated, separated by
4832 * newlines. Returns NULL for an error or no matches.
4834 char_u *
4835 globpath(path, file)
4836 char_u *path;
4837 char_u *file;
4839 expand_T xpc;
4840 char_u *buf;
4841 garray_T ga;
4842 int i;
4843 int len;
4844 int num_p;
4845 char_u **p;
4846 char_u *cur = NULL;
4848 buf = alloc(MAXPATHL);
4849 if (buf == NULL)
4850 return NULL;
4852 ExpandInit(&xpc);
4853 xpc.xp_context = EXPAND_FILES;
4855 ga_init2(&ga, 1, 100);
4857 /* Loop over all entries in {path}. */
4858 while (*path != NUL)
4860 /* Copy one item of the path to buf[] and concatenate the file name. */
4861 copy_option_part(&path, buf, MAXPATHL, ",");
4862 if (STRLEN(buf) + STRLEN(file) + 2 < MAXPATHL)
4864 add_pathsep(buf);
4865 STRCAT(buf, file);
4866 if (ExpandFromContext(&xpc, buf, &num_p, &p, WILD_SILENT) != FAIL
4867 && num_p > 0)
4869 ExpandEscape(&xpc, buf, num_p, p, WILD_SILENT);
4870 for (len = 0, i = 0; i < num_p; ++i)
4871 len += (int)STRLEN(p[i]) + 1;
4873 /* Concatenate new results to previous ones. */
4874 if (ga_grow(&ga, len) == OK)
4876 cur = (char_u *)ga.ga_data + ga.ga_len;
4877 for (i = 0; i < num_p; ++i)
4879 STRCPY(cur, p[i]);
4880 cur += STRLEN(p[i]);
4881 *cur++ = '\n';
4883 ga.ga_len += len;
4885 FreeWild(num_p, p);
4889 if (cur != NULL)
4890 *--cur = 0; /* Replace trailing newline with NUL */
4892 vim_free(buf);
4893 return (char_u *)ga.ga_data;
4896 #endif
4898 #if defined(FEAT_CMDHIST) || defined(PROTO)
4900 /*********************************
4901 * Command line history stuff *
4902 *********************************/
4905 * Translate a history character to the associated type number.
4907 static int
4908 hist_char2type(c)
4909 int c;
4911 if (c == ':')
4912 return HIST_CMD;
4913 if (c == '=')
4914 return HIST_EXPR;
4915 if (c == '@')
4916 return HIST_INPUT;
4917 if (c == '>')
4918 return HIST_DEBUG;
4919 return HIST_SEARCH; /* must be '?' or '/' */
4923 * Table of history names.
4924 * These names are used in :history and various hist...() functions.
4925 * It is sufficient to give the significant prefix of a history name.
4928 static char *(history_names[]) =
4930 "cmd",
4931 "search",
4932 "expr",
4933 "input",
4934 "debug",
4935 NULL
4939 * init_history() - Initialize the command line history.
4940 * Also used to re-allocate the history when the size changes.
4942 void
4943 init_history()
4945 int newlen; /* new length of history table */
4946 histentry_T *temp;
4947 int i;
4948 int j;
4949 int type;
4952 * If size of history table changed, reallocate it
4954 newlen = (int)p_hi;
4955 if (newlen != hislen) /* history length changed */
4957 for (type = 0; type < HIST_COUNT; ++type) /* adjust the tables */
4959 if (newlen)
4961 temp = (histentry_T *)lalloc(
4962 (long_u)(newlen * sizeof(histentry_T)), TRUE);
4963 if (temp == NULL) /* out of memory! */
4965 if (type == 0) /* first one: just keep the old length */
4967 newlen = hislen;
4968 break;
4970 /* Already changed one table, now we can only have zero
4971 * length for all tables. */
4972 newlen = 0;
4973 type = -1;
4974 continue;
4977 else
4978 temp = NULL;
4979 if (newlen == 0 || temp != NULL)
4981 if (hisidx[type] < 0) /* there are no entries yet */
4983 for (i = 0; i < newlen; ++i)
4985 temp[i].hisnum = 0;
4986 temp[i].hisstr = NULL;
4989 else if (newlen > hislen) /* array becomes bigger */
4991 for (i = 0; i <= hisidx[type]; ++i)
4992 temp[i] = history[type][i];
4993 j = i;
4994 for ( ; i <= newlen - (hislen - hisidx[type]); ++i)
4996 temp[i].hisnum = 0;
4997 temp[i].hisstr = NULL;
4999 for ( ; j < hislen; ++i, ++j)
5000 temp[i] = history[type][j];
5002 else /* array becomes smaller or 0 */
5004 j = hisidx[type];
5005 for (i = newlen - 1; ; --i)
5007 if (i >= 0) /* copy newest entries */
5008 temp[i] = history[type][j];
5009 else /* remove older entries */
5010 vim_free(history[type][j].hisstr);
5011 if (--j < 0)
5012 j = hislen - 1;
5013 if (j == hisidx[type])
5014 break;
5016 hisidx[type] = newlen - 1;
5018 vim_free(history[type]);
5019 history[type] = temp;
5022 hislen = newlen;
5027 * Check if command line 'str' is already in history.
5028 * If 'move_to_front' is TRUE, matching entry is moved to end of history.
5030 static int
5031 in_history(type, str, move_to_front)
5032 int type;
5033 char_u *str;
5034 int move_to_front; /* Move the entry to the front if it exists */
5036 int i;
5037 int last_i = -1;
5039 if (hisidx[type] < 0)
5040 return FALSE;
5041 i = hisidx[type];
5044 if (history[type][i].hisstr == NULL)
5045 return FALSE;
5046 if (STRCMP(str, history[type][i].hisstr) == 0)
5048 if (!move_to_front)
5049 return TRUE;
5050 last_i = i;
5051 break;
5053 if (--i < 0)
5054 i = hislen - 1;
5055 } while (i != hisidx[type]);
5057 if (last_i >= 0)
5059 str = history[type][i].hisstr;
5060 while (i != hisidx[type])
5062 if (++i >= hislen)
5063 i = 0;
5064 history[type][last_i] = history[type][i];
5065 last_i = i;
5067 history[type][i].hisstr = str;
5068 history[type][i].hisnum = ++hisnum[type];
5069 return TRUE;
5071 return FALSE;
5075 * Convert history name (from table above) to its HIST_ equivalent.
5076 * When "name" is empty, return "cmd" history.
5077 * Returns -1 for unknown history name.
5080 get_histtype(name)
5081 char_u *name;
5083 int i;
5084 int len = (int)STRLEN(name);
5086 /* No argument: use current history. */
5087 if (len == 0)
5088 return hist_char2type(ccline.cmdfirstc);
5090 for (i = 0; history_names[i] != NULL; ++i)
5091 if (STRNICMP(name, history_names[i], len) == 0)
5092 return i;
5094 if (vim_strchr((char_u *)":=@>?/", name[0]) != NULL && name[1] == NUL)
5095 return hist_char2type(name[0]);
5097 return -1;
5100 static int last_maptick = -1; /* last seen maptick */
5103 * Add the given string to the given history. If the string is already in the
5104 * history then it is moved to the front. "histype" may be one of he HIST_
5105 * values.
5107 void
5108 add_to_history(histype, new_entry, in_map, sep)
5109 int histype;
5110 char_u *new_entry;
5111 int in_map; /* consider maptick when inside a mapping */
5112 int sep; /* separator character used (search hist) */
5114 histentry_T *hisptr;
5115 int len;
5117 if (hislen == 0) /* no history */
5118 return;
5121 * Searches inside the same mapping overwrite each other, so that only
5122 * the last line is kept. Be careful not to remove a line that was moved
5123 * down, only lines that were added.
5125 if (histype == HIST_SEARCH && in_map)
5127 if (maptick == last_maptick)
5129 /* Current line is from the same mapping, remove it */
5130 hisptr = &history[HIST_SEARCH][hisidx[HIST_SEARCH]];
5131 vim_free(hisptr->hisstr);
5132 hisptr->hisstr = NULL;
5133 hisptr->hisnum = 0;
5134 --hisnum[histype];
5135 if (--hisidx[HIST_SEARCH] < 0)
5136 hisidx[HIST_SEARCH] = hislen - 1;
5138 last_maptick = -1;
5140 if (!in_history(histype, new_entry, TRUE))
5142 if (++hisidx[histype] == hislen)
5143 hisidx[histype] = 0;
5144 hisptr = &history[histype][hisidx[histype]];
5145 vim_free(hisptr->hisstr);
5147 /* Store the separator after the NUL of the string. */
5148 len = (int)STRLEN(new_entry);
5149 hisptr->hisstr = vim_strnsave(new_entry, len + 2);
5150 if (hisptr->hisstr != NULL)
5151 hisptr->hisstr[len + 1] = sep;
5153 hisptr->hisnum = ++hisnum[histype];
5154 if (histype == HIST_SEARCH && in_map)
5155 last_maptick = maptick;
5159 #if defined(FEAT_EVAL) || defined(PROTO)
5162 * Get identifier of newest history entry.
5163 * "histype" may be one of the HIST_ values.
5166 get_history_idx(histype)
5167 int histype;
5169 if (hislen == 0 || histype < 0 || histype >= HIST_COUNT
5170 || hisidx[histype] < 0)
5171 return -1;
5173 return history[histype][hisidx[histype]].hisnum;
5176 static struct cmdline_info *get_ccline_ptr __ARGS((void));
5179 * Get pointer to the command line info to use. cmdline_paste() may clear
5180 * ccline and put the previous value in prev_ccline.
5182 static struct cmdline_info *
5183 get_ccline_ptr()
5185 if ((State & CMDLINE) == 0)
5186 return NULL;
5187 if (ccline.cmdbuff != NULL)
5188 return &ccline;
5189 if (prev_ccline_used && prev_ccline.cmdbuff != NULL)
5190 return &prev_ccline;
5191 return NULL;
5195 * Get the current command line in allocated memory.
5196 * Only works when the command line is being edited.
5197 * Returns NULL when something is wrong.
5199 char_u *
5200 get_cmdline_str()
5202 struct cmdline_info *p = get_ccline_ptr();
5204 if (p == NULL)
5205 return NULL;
5206 return vim_strnsave(p->cmdbuff, p->cmdlen);
5210 * Get the current command line position, counted in bytes.
5211 * Zero is the first position.
5212 * Only works when the command line is being edited.
5213 * Returns -1 when something is wrong.
5216 get_cmdline_pos()
5218 struct cmdline_info *p = get_ccline_ptr();
5220 if (p == NULL)
5221 return -1;
5222 return p->cmdpos;
5226 * Set the command line byte position to "pos". Zero is the first position.
5227 * Only works when the command line is being edited.
5228 * Returns 1 when failed, 0 when OK.
5231 set_cmdline_pos(pos)
5232 int pos;
5234 struct cmdline_info *p = get_ccline_ptr();
5236 if (p == NULL)
5237 return 1;
5239 /* The position is not set directly but after CTRL-\ e or CTRL-R = has
5240 * changed the command line. */
5241 if (pos < 0)
5242 new_cmdpos = 0;
5243 else
5244 new_cmdpos = pos;
5245 return 0;
5249 * Get the current command-line type.
5250 * Returns ':' or '/' or '?' or '@' or '>' or '-'
5251 * Only works when the command line is being edited.
5252 * Returns NUL when something is wrong.
5255 get_cmdline_type()
5257 struct cmdline_info *p = get_ccline_ptr();
5259 if (p == NULL)
5260 return NUL;
5261 if (p->cmdfirstc == NUL)
5262 return (p->input_fn) ? '@' : '-';
5263 return p->cmdfirstc;
5267 * Calculate history index from a number:
5268 * num > 0: seen as identifying number of a history entry
5269 * num < 0: relative position in history wrt newest entry
5270 * "histype" may be one of the HIST_ values.
5272 static int
5273 calc_hist_idx(histype, num)
5274 int histype;
5275 int num;
5277 int i;
5278 histentry_T *hist;
5279 int wrapped = FALSE;
5281 if (hislen == 0 || histype < 0 || histype >= HIST_COUNT
5282 || (i = hisidx[histype]) < 0 || num == 0)
5283 return -1;
5285 hist = history[histype];
5286 if (num > 0)
5288 while (hist[i].hisnum > num)
5289 if (--i < 0)
5291 if (wrapped)
5292 break;
5293 i += hislen;
5294 wrapped = TRUE;
5296 if (hist[i].hisnum == num && hist[i].hisstr != NULL)
5297 return i;
5299 else if (-num <= hislen)
5301 i += num + 1;
5302 if (i < 0)
5303 i += hislen;
5304 if (hist[i].hisstr != NULL)
5305 return i;
5307 return -1;
5311 * Get a history entry by its index.
5312 * "histype" may be one of the HIST_ values.
5314 char_u *
5315 get_history_entry(histype, idx)
5316 int histype;
5317 int idx;
5319 idx = calc_hist_idx(histype, idx);
5320 if (idx >= 0)
5321 return history[histype][idx].hisstr;
5322 else
5323 return (char_u *)"";
5327 * Clear all entries of a history.
5328 * "histype" may be one of the HIST_ values.
5331 clr_history(histype)
5332 int histype;
5334 int i;
5335 histentry_T *hisptr;
5337 if (hislen != 0 && histype >= 0 && histype < HIST_COUNT)
5339 hisptr = history[histype];
5340 for (i = hislen; i--;)
5342 vim_free(hisptr->hisstr);
5343 hisptr->hisnum = 0;
5344 hisptr++->hisstr = NULL;
5346 hisidx[histype] = -1; /* mark history as cleared */
5347 hisnum[histype] = 0; /* reset identifier counter */
5348 return OK;
5350 return FAIL;
5354 * Remove all entries matching {str} from a history.
5355 * "histype" may be one of the HIST_ values.
5358 del_history_entry(histype, str)
5359 int histype;
5360 char_u *str;
5362 regmatch_T regmatch;
5363 histentry_T *hisptr;
5364 int idx;
5365 int i;
5366 int last;
5367 int found = FALSE;
5369 regmatch.regprog = NULL;
5370 regmatch.rm_ic = FALSE; /* always match case */
5371 if (hislen != 0
5372 && histype >= 0
5373 && histype < HIST_COUNT
5374 && *str != NUL
5375 && (idx = hisidx[histype]) >= 0
5376 && (regmatch.regprog = vim_regcomp(str, RE_MAGIC + RE_STRING))
5377 != NULL)
5379 i = last = idx;
5382 hisptr = &history[histype][i];
5383 if (hisptr->hisstr == NULL)
5384 break;
5385 if (vim_regexec(&regmatch, hisptr->hisstr, (colnr_T)0))
5387 found = TRUE;
5388 vim_free(hisptr->hisstr);
5389 hisptr->hisstr = NULL;
5390 hisptr->hisnum = 0;
5392 else
5394 if (i != last)
5396 history[histype][last] = *hisptr;
5397 hisptr->hisstr = NULL;
5398 hisptr->hisnum = 0;
5400 if (--last < 0)
5401 last += hislen;
5403 if (--i < 0)
5404 i += hislen;
5405 } while (i != idx);
5406 if (history[histype][idx].hisstr == NULL)
5407 hisidx[histype] = -1;
5409 vim_free(regmatch.regprog);
5410 return found;
5414 * Remove an indexed entry from a history.
5415 * "histype" may be one of the HIST_ values.
5418 del_history_idx(histype, idx)
5419 int histype;
5420 int idx;
5422 int i, j;
5424 i = calc_hist_idx(histype, idx);
5425 if (i < 0)
5426 return FALSE;
5427 idx = hisidx[histype];
5428 vim_free(history[histype][i].hisstr);
5430 /* When deleting the last added search string in a mapping, reset
5431 * last_maptick, so that the last added search string isn't deleted again.
5433 if (histype == HIST_SEARCH && maptick == last_maptick && i == idx)
5434 last_maptick = -1;
5436 while (i != idx)
5438 j = (i + 1) % hislen;
5439 history[histype][i] = history[histype][j];
5440 i = j;
5442 history[histype][i].hisstr = NULL;
5443 history[histype][i].hisnum = 0;
5444 if (--i < 0)
5445 i += hislen;
5446 hisidx[histype] = i;
5447 return TRUE;
5450 #endif /* FEAT_EVAL */
5452 #if defined(FEAT_CRYPT) || defined(PROTO)
5454 * Very specific function to remove the value in ":set key=val" from the
5455 * history.
5457 void
5458 remove_key_from_history()
5460 char_u *p;
5461 int i;
5463 i = hisidx[HIST_CMD];
5464 if (i < 0)
5465 return;
5466 p = history[HIST_CMD][i].hisstr;
5467 if (p != NULL)
5468 for ( ; *p; ++p)
5469 if (STRNCMP(p, "key", 3) == 0 && !isalpha(p[3]))
5471 p = vim_strchr(p + 3, '=');
5472 if (p == NULL)
5473 break;
5474 ++p;
5475 for (i = 0; p[i] && !vim_iswhite(p[i]); ++i)
5476 if (p[i] == '\\' && p[i + 1])
5477 ++i;
5478 mch_memmove(p, p + i, STRLEN(p + i) + 1);
5479 --p;
5482 #endif
5484 #endif /* FEAT_CMDHIST */
5486 #if defined(FEAT_QUICKFIX) || defined(FEAT_CMDHIST) || defined(PROTO)
5488 * Get indices "num1,num2" that specify a range within a list (not a range of
5489 * text lines in a buffer!) from a string. Used for ":history" and ":clist".
5490 * Returns OK if parsed successfully, otherwise FAIL.
5493 get_list_range(str, num1, num2)
5494 char_u **str;
5495 int *num1;
5496 int *num2;
5498 int len;
5499 int first = FALSE;
5500 long num;
5502 *str = skipwhite(*str);
5503 if (**str == '-' || vim_isdigit(**str)) /* parse "from" part of range */
5505 vim_str2nr(*str, NULL, &len, FALSE, FALSE, &num, NULL);
5506 *str += len;
5507 *num1 = (int)num;
5508 first = TRUE;
5510 *str = skipwhite(*str);
5511 if (**str == ',') /* parse "to" part of range */
5513 *str = skipwhite(*str + 1);
5514 vim_str2nr(*str, NULL, &len, FALSE, FALSE, &num, NULL);
5515 if (len > 0)
5517 *num2 = (int)num;
5518 *str = skipwhite(*str + len);
5520 else if (!first) /* no number given at all */
5521 return FAIL;
5523 else if (first) /* only one number given */
5524 *num2 = *num1;
5525 return OK;
5527 #endif
5529 #if defined(FEAT_CMDHIST) || defined(PROTO)
5531 * :history command - print a history
5533 void
5534 ex_history(eap)
5535 exarg_T *eap;
5537 histentry_T *hist;
5538 int histype1 = HIST_CMD;
5539 int histype2 = HIST_CMD;
5540 int hisidx1 = 1;
5541 int hisidx2 = -1;
5542 int idx;
5543 int i, j, k;
5544 char_u *end;
5545 char_u *arg = eap->arg;
5547 if (hislen == 0)
5549 MSG(_("'history' option is zero"));
5550 return;
5553 if (!(VIM_ISDIGIT(*arg) || *arg == '-' || *arg == ','))
5555 end = arg;
5556 while (ASCII_ISALPHA(*end)
5557 || vim_strchr((char_u *)":=@>/?", *end) != NULL)
5558 end++;
5559 i = *end;
5560 *end = NUL;
5561 histype1 = get_histtype(arg);
5562 if (histype1 == -1)
5564 if (STRICMP(arg, "all") == 0)
5566 histype1 = 0;
5567 histype2 = HIST_COUNT-1;
5569 else
5571 *end = i;
5572 EMSG(_(e_trailing));
5573 return;
5576 else
5577 histype2 = histype1;
5578 *end = i;
5580 else
5581 end = arg;
5582 if (!get_list_range(&end, &hisidx1, &hisidx2) || *end != NUL)
5584 EMSG(_(e_trailing));
5585 return;
5588 for (; !got_int && histype1 <= histype2; ++histype1)
5590 STRCPY(IObuff, "\n # ");
5591 STRCAT(STRCAT(IObuff, history_names[histype1]), " history");
5592 MSG_PUTS_TITLE(IObuff);
5593 idx = hisidx[histype1];
5594 hist = history[histype1];
5595 j = hisidx1;
5596 k = hisidx2;
5597 if (j < 0)
5598 j = (-j > hislen) ? 0 : hist[(hislen+j+idx+1) % hislen].hisnum;
5599 if (k < 0)
5600 k = (-k > hislen) ? 0 : hist[(hislen+k+idx+1) % hislen].hisnum;
5601 if (idx >= 0 && j <= k)
5602 for (i = idx + 1; !got_int; ++i)
5604 if (i == hislen)
5605 i = 0;
5606 if (hist[i].hisstr != NULL
5607 && hist[i].hisnum >= j && hist[i].hisnum <= k)
5609 msg_putchar('\n');
5610 sprintf((char *)IObuff, "%c%6d ", i == idx ? '>' : ' ',
5611 hist[i].hisnum);
5612 if (vim_strsize(hist[i].hisstr) > (int)Columns - 10)
5613 trunc_string(hist[i].hisstr, IObuff + STRLEN(IObuff),
5614 (int)Columns - 10);
5615 else
5616 STRCAT(IObuff, hist[i].hisstr);
5617 msg_outtrans(IObuff);
5618 out_flush();
5620 if (i == idx)
5621 break;
5625 #endif
5627 #if (defined(FEAT_VIMINFO) && defined(FEAT_CMDHIST)) || defined(PROTO)
5628 static char_u **viminfo_history[HIST_COUNT] = {NULL, NULL, NULL, NULL};
5629 static int viminfo_hisidx[HIST_COUNT] = {0, 0, 0, 0};
5630 static int viminfo_hislen[HIST_COUNT] = {0, 0, 0, 0};
5631 static int viminfo_add_at_front = FALSE;
5633 static int hist_type2char __ARGS((int type, int use_question));
5636 * Translate a history type number to the associated character.
5638 static int
5639 hist_type2char(type, use_question)
5640 int type;
5641 int use_question; /* use '?' instead of '/' */
5643 if (type == HIST_CMD)
5644 return ':';
5645 if (type == HIST_SEARCH)
5647 if (use_question)
5648 return '?';
5649 else
5650 return '/';
5652 if (type == HIST_EXPR)
5653 return '=';
5654 return '@';
5658 * Prepare for reading the history from the viminfo file.
5659 * This allocates history arrays to store the read history lines.
5661 void
5662 prepare_viminfo_history(asklen)
5663 int asklen;
5665 int i;
5666 int num;
5667 int type;
5668 int len;
5670 init_history();
5671 viminfo_add_at_front = (asklen != 0);
5672 if (asklen > hislen)
5673 asklen = hislen;
5675 for (type = 0; type < HIST_COUNT; ++type)
5678 * Count the number of empty spaces in the history list. If there are
5679 * more spaces available than we request, then fill them up.
5681 for (i = 0, num = 0; i < hislen; i++)
5682 if (history[type][i].hisstr == NULL)
5683 num++;
5684 len = asklen;
5685 if (num > len)
5686 len = num;
5687 if (len <= 0)
5688 viminfo_history[type] = NULL;
5689 else
5690 viminfo_history[type] =
5691 (char_u **)lalloc((long_u)(len * sizeof(char_u *)), FALSE);
5692 if (viminfo_history[type] == NULL)
5693 len = 0;
5694 viminfo_hislen[type] = len;
5695 viminfo_hisidx[type] = 0;
5700 * Accept a line from the viminfo, store it in the history array when it's
5701 * new.
5704 read_viminfo_history(virp)
5705 vir_T *virp;
5707 int type;
5708 long_u len;
5709 char_u *val;
5710 char_u *p;
5712 type = hist_char2type(virp->vir_line[0]);
5713 if (viminfo_hisidx[type] < viminfo_hislen[type])
5715 val = viminfo_readstring(virp, 1, TRUE);
5716 if (val != NULL && *val != NUL)
5718 if (!in_history(type, val + (type == HIST_SEARCH),
5719 viminfo_add_at_front))
5721 /* Need to re-allocate to append the separator byte. */
5722 len = STRLEN(val);
5723 p = lalloc(len + 2, TRUE);
5724 if (p != NULL)
5726 if (type == HIST_SEARCH)
5728 /* Search entry: Move the separator from the first
5729 * column to after the NUL. */
5730 mch_memmove(p, val + 1, (size_t)len);
5731 p[len] = (*val == ' ' ? NUL : *val);
5733 else
5735 /* Not a search entry: No separator in the viminfo
5736 * file, add a NUL separator. */
5737 mch_memmove(p, val, (size_t)len + 1);
5738 p[len + 1] = NUL;
5740 viminfo_history[type][viminfo_hisidx[type]++] = p;
5744 vim_free(val);
5746 return viminfo_readline(virp);
5749 void
5750 finish_viminfo_history()
5752 int idx;
5753 int i;
5754 int type;
5756 for (type = 0; type < HIST_COUNT; ++type)
5758 if (history[type] == NULL)
5759 return;
5760 idx = hisidx[type] + viminfo_hisidx[type];
5761 if (idx >= hislen)
5762 idx -= hislen;
5763 else if (idx < 0)
5764 idx = hislen - 1;
5765 if (viminfo_add_at_front)
5766 hisidx[type] = idx;
5767 else
5769 if (hisidx[type] == -1)
5770 hisidx[type] = hislen - 1;
5773 if (history[type][idx].hisstr != NULL)
5774 break;
5775 if (++idx == hislen)
5776 idx = 0;
5777 } while (idx != hisidx[type]);
5778 if (idx != hisidx[type] && --idx < 0)
5779 idx = hislen - 1;
5781 for (i = 0; i < viminfo_hisidx[type]; i++)
5783 vim_free(history[type][idx].hisstr);
5784 history[type][idx].hisstr = viminfo_history[type][i];
5785 if (--idx < 0)
5786 idx = hislen - 1;
5788 idx += 1;
5789 idx %= hislen;
5790 for (i = 0; i < viminfo_hisidx[type]; i++)
5792 history[type][idx++].hisnum = ++hisnum[type];
5793 idx %= hislen;
5795 vim_free(viminfo_history[type]);
5796 viminfo_history[type] = NULL;
5800 void
5801 write_viminfo_history(fp)
5802 FILE *fp;
5804 int i;
5805 int type;
5806 int num_saved;
5807 char_u *p;
5808 int c;
5810 init_history();
5811 if (hislen == 0)
5812 return;
5813 for (type = 0; type < HIST_COUNT; ++type)
5815 num_saved = get_viminfo_parameter(hist_type2char(type, FALSE));
5816 if (num_saved == 0)
5817 continue;
5818 if (num_saved < 0) /* Use default */
5819 num_saved = hislen;
5820 fprintf(fp, _("\n# %s History (newest to oldest):\n"),
5821 type == HIST_CMD ? _("Command Line") :
5822 type == HIST_SEARCH ? _("Search String") :
5823 type == HIST_EXPR ? _("Expression") :
5824 _("Input Line"));
5825 if (num_saved > hislen)
5826 num_saved = hislen;
5827 i = hisidx[type];
5828 if (i >= 0)
5829 while (num_saved--)
5831 p = history[type][i].hisstr;
5832 if (p != NULL)
5834 fputc(hist_type2char(type, TRUE), fp);
5835 /* For the search history: put the separator in the second
5836 * column; use a space if there isn't one. */
5837 if (type == HIST_SEARCH)
5839 c = p[STRLEN(p) + 1];
5840 putc(c == NUL ? ' ' : c, fp);
5842 viminfo_writestring(fp, p);
5844 if (--i < 0)
5845 i = hislen - 1;
5849 #endif /* FEAT_VIMINFO */
5851 #if defined(FEAT_FKMAP) || defined(PROTO)
5853 * Write a character at the current cursor+offset position.
5854 * It is directly written into the command buffer block.
5856 void
5857 cmd_pchar(c, offset)
5858 int c, offset;
5860 if (ccline.cmdpos + offset >= ccline.cmdlen || ccline.cmdpos + offset < 0)
5862 EMSG(_("E198: cmd_pchar beyond the command length"));
5863 return;
5865 ccline.cmdbuff[ccline.cmdpos + offset] = (char_u)c;
5866 ccline.cmdbuff[ccline.cmdlen] = NUL;
5870 cmd_gchar(offset)
5871 int offset;
5873 if (ccline.cmdpos + offset >= ccline.cmdlen || ccline.cmdpos + offset < 0)
5875 /* EMSG(_("cmd_gchar beyond the command length")); */
5876 return NUL;
5878 return (int)ccline.cmdbuff[ccline.cmdpos + offset];
5880 #endif
5882 #if defined(FEAT_CMDWIN) || defined(PROTO)
5884 * Open a window on the current command line and history. Allow editing in
5885 * the window. Returns when the window is closed.
5886 * Returns:
5887 * CR if the command is to be executed
5888 * Ctrl_C if it is to be abandoned
5889 * K_IGNORE if editing continues
5891 static int
5892 ex_window()
5894 struct cmdline_info save_ccline;
5895 buf_T *old_curbuf = curbuf;
5896 win_T *old_curwin = curwin;
5897 buf_T *bp;
5898 win_T *wp;
5899 int i;
5900 linenr_T lnum;
5901 int histtype;
5902 garray_T winsizes;
5903 char_u typestr[2];
5904 int save_restart_edit = restart_edit;
5905 int save_State = State;
5906 int save_exmode = exmode_active;
5907 #ifdef FEAT_RIGHTLEFT
5908 int save_cmdmsg_rl = cmdmsg_rl;
5909 #endif
5911 /* Can't do this recursively. Can't do it when typing a password. */
5912 if (cmdwin_type != 0
5913 # if defined(FEAT_CRYPT) || defined(FEAT_EVAL)
5914 || cmdline_star > 0
5915 # endif
5918 beep_flush();
5919 return K_IGNORE;
5922 /* Save current window sizes. */
5923 win_size_save(&winsizes);
5925 # ifdef FEAT_AUTOCMD
5926 /* Don't execute autocommands while creating the window. */
5927 ++autocmd_block;
5928 # endif
5929 /* don't use a new tab page */
5930 cmdmod.tab = 0;
5932 /* Create a window for the command-line buffer. */
5933 if (win_split((int)p_cwh, WSP_BOT) == FAIL)
5935 beep_flush();
5936 return K_IGNORE;
5938 cmdwin_type = ccline.cmdfirstc;
5939 if (cmdwin_type == NUL)
5940 cmdwin_type = '-';
5942 /* Create the command-line buffer empty. */
5943 (void)do_ecmd(0, NULL, NULL, NULL, ECMD_ONE, ECMD_HIDE);
5944 (void)setfname(curbuf, (char_u *)"command-line", NULL, TRUE);
5945 set_option_value((char_u *)"bt", 0L, (char_u *)"nofile", OPT_LOCAL);
5946 set_option_value((char_u *)"swf", 0L, NULL, OPT_LOCAL);
5947 curbuf->b_p_ma = TRUE;
5948 # ifdef FEAT_RIGHTLEFT
5949 curwin->w_p_rl = cmdmsg_rl;
5950 cmdmsg_rl = FALSE;
5951 # endif
5952 # ifdef FEAT_SCROLLBIND
5953 curwin->w_p_scb = FALSE;
5954 # endif
5956 # ifdef FEAT_AUTOCMD
5957 /* Do execute autocommands for setting the filetype (load syntax). */
5958 --autocmd_block;
5959 # endif
5961 /* Showing the prompt may have set need_wait_return, reset it. */
5962 need_wait_return = FALSE;
5964 histtype = hist_char2type(ccline.cmdfirstc);
5965 if (histtype == HIST_CMD || histtype == HIST_DEBUG)
5967 if (p_wc == TAB)
5969 add_map((char_u *)"<buffer> <Tab> <C-X><C-V>", INSERT);
5970 add_map((char_u *)"<buffer> <Tab> a<C-X><C-V>", NORMAL);
5972 set_option_value((char_u *)"ft", 0L, (char_u *)"vim", OPT_LOCAL);
5975 /* Reset 'textwidth' after setting 'filetype' (the Vim filetype plugin
5976 * sets 'textwidth' to 78). */
5977 curbuf->b_p_tw = 0;
5979 /* Fill the buffer with the history. */
5980 init_history();
5981 if (hislen > 0)
5983 i = hisidx[histtype];
5984 if (i >= 0)
5986 lnum = 0;
5989 if (++i == hislen)
5990 i = 0;
5991 if (history[histtype][i].hisstr != NULL)
5992 ml_append(lnum++, history[histtype][i].hisstr,
5993 (colnr_T)0, FALSE);
5995 while (i != hisidx[histtype]);
5999 /* Replace the empty last line with the current command-line and put the
6000 * cursor there. */
6001 ml_replace(curbuf->b_ml.ml_line_count, ccline.cmdbuff, TRUE);
6002 curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
6003 curwin->w_cursor.col = ccline.cmdpos;
6004 changed_line_abv_curs();
6005 invalidate_botline();
6006 redraw_later(SOME_VALID);
6008 /* Save the command line info, can be used recursively. */
6009 save_ccline = ccline;
6010 ccline.cmdbuff = NULL;
6011 ccline.cmdprompt = NULL;
6013 /* No Ex mode here! */
6014 exmode_active = 0;
6016 State = NORMAL;
6017 # ifdef FEAT_MOUSE
6018 setmouse();
6019 # endif
6021 # ifdef FEAT_AUTOCMD
6022 /* Trigger CmdwinEnter autocommands. */
6023 typestr[0] = cmdwin_type;
6024 typestr[1] = NUL;
6025 apply_autocmds(EVENT_CMDWINENTER, typestr, typestr, FALSE, curbuf);
6026 if (restart_edit != 0) /* autocmd with ":startinsert" */
6027 stuffcharReadbuff(K_NOP);
6028 # endif
6030 i = RedrawingDisabled;
6031 RedrawingDisabled = 0;
6034 * Call the main loop until <CR> or CTRL-C is typed.
6036 cmdwin_result = 0;
6037 main_loop(TRUE, FALSE);
6039 RedrawingDisabled = i;
6041 # ifdef FEAT_AUTOCMD
6042 /* Trigger CmdwinLeave autocommands. */
6043 apply_autocmds(EVENT_CMDWINLEAVE, typestr, typestr, FALSE, curbuf);
6044 # endif
6046 /* Restore the command line info. */
6047 ccline = save_ccline;
6048 cmdwin_type = 0;
6050 exmode_active = save_exmode;
6052 /* Safety check: The old window or buffer was deleted: It's a a bug when
6053 * this happens! */
6054 if (!win_valid(old_curwin) || !buf_valid(old_curbuf))
6056 cmdwin_result = Ctrl_C;
6057 EMSG(_("E199: Active window or buffer deleted"));
6059 else
6061 # if defined(FEAT_AUTOCMD) && defined(FEAT_EVAL)
6062 /* autocmds may abort script processing */
6063 if (aborting() && cmdwin_result != K_IGNORE)
6064 cmdwin_result = Ctrl_C;
6065 # endif
6066 /* Set the new command line from the cmdline buffer. */
6067 vim_free(ccline.cmdbuff);
6068 if (cmdwin_result == K_XF1 || cmdwin_result == K_XF2) /* :qa[!] typed */
6070 char *p = (cmdwin_result == K_XF2) ? "qa" : "qa!";
6072 if (histtype == HIST_CMD)
6074 /* Execute the command directly. */
6075 ccline.cmdbuff = vim_strsave((char_u *)p);
6076 cmdwin_result = CAR;
6078 else
6080 /* First need to cancel what we were doing. */
6081 ccline.cmdbuff = NULL;
6082 stuffcharReadbuff(':');
6083 stuffReadbuff((char_u *)p);
6084 stuffcharReadbuff(CAR);
6087 else if (cmdwin_result == K_XF2) /* :qa typed */
6089 ccline.cmdbuff = vim_strsave((char_u *)"qa");
6090 cmdwin_result = CAR;
6092 else
6093 ccline.cmdbuff = vim_strsave(ml_get_curline());
6094 if (ccline.cmdbuff == NULL)
6095 cmdwin_result = Ctrl_C;
6096 else
6098 ccline.cmdlen = (int)STRLEN(ccline.cmdbuff);
6099 ccline.cmdbufflen = ccline.cmdlen + 1;
6100 ccline.cmdpos = curwin->w_cursor.col;
6101 if (ccline.cmdpos > ccline.cmdlen)
6102 ccline.cmdpos = ccline.cmdlen;
6103 if (cmdwin_result == K_IGNORE)
6105 set_cmdspos_cursor();
6106 redrawcmd();
6110 # ifdef FEAT_AUTOCMD
6111 /* Don't execute autocommands while deleting the window. */
6112 ++autocmd_block;
6113 # endif
6114 wp = curwin;
6115 bp = curbuf;
6116 win_goto(old_curwin);
6117 win_close(wp, TRUE);
6118 close_buffer(NULL, bp, DOBUF_WIPE);
6120 /* Restore window sizes. */
6121 win_size_restore(&winsizes);
6123 # ifdef FEAT_AUTOCMD
6124 --autocmd_block;
6125 # endif
6128 ga_clear(&winsizes);
6129 restart_edit = save_restart_edit;
6130 # ifdef FEAT_RIGHTLEFT
6131 cmdmsg_rl = save_cmdmsg_rl;
6132 # endif
6134 State = save_State;
6135 # ifdef FEAT_MOUSE
6136 setmouse();
6137 # endif
6139 return cmdwin_result;
6141 #endif /* FEAT_CMDWIN */
6144 * Used for commands that either take a simple command string argument, or:
6145 * cmd << endmarker
6146 * {script}
6147 * endmarker
6148 * Returns a pointer to allocated memory with {script} or NULL.
6150 char_u *
6151 script_get(eap, cmd)
6152 exarg_T *eap;
6153 char_u *cmd;
6155 char_u *theline;
6156 char *end_pattern = NULL;
6157 char dot[] = ".";
6158 garray_T ga;
6160 if (cmd[0] != '<' || cmd[1] != '<' || eap->getline == NULL)
6161 return NULL;
6163 ga_init2(&ga, 1, 0x400);
6165 if (cmd[2] != NUL)
6166 end_pattern = (char *)skipwhite(cmd + 2);
6167 else
6168 end_pattern = dot;
6170 for (;;)
6172 theline = eap->getline(
6173 #ifdef FEAT_EVAL
6174 eap->cstack->cs_looplevel > 0 ? -1 :
6175 #endif
6176 NUL, eap->cookie, 0);
6178 if (theline == NULL || STRCMP(end_pattern, theline) == 0)
6179 break;
6181 ga_concat(&ga, theline);
6182 ga_append(&ga, '\n');
6183 vim_free(theline);
6185 ga_append(&ga, NUL);
6187 return (char_u *)ga.ga_data;