xref: /vim-8.2.3635/src/edit.c (revision bb76f24a)
1 /* vi:set ts=8 sts=4 sw=4 noet:
2  *
3  * VIM - Vi IMproved	by Bram Moolenaar
4  *
5  * Do ":help uganda"  in Vim to read copying and usage conditions.
6  * Do ":help credits" in Vim to see a list of people who contributed.
7  * See README.txt for an overview of the Vim source code.
8  */
9 
10 /*
11  * edit.c: functions for Insert mode
12  */
13 
14 #include "vim.h"
15 
16 #ifdef FEAT_INS_EXPAND
17 /*
18  * definitions used for CTRL-X submode
19  */
20 #define CTRL_X_WANT_IDENT	0x100
21 
22 #define CTRL_X_NOT_DEFINED_YET	1
23 #define CTRL_X_SCROLL		2
24 #define CTRL_X_WHOLE_LINE	3
25 #define CTRL_X_FILES		4
26 #define CTRL_X_TAGS		(5 + CTRL_X_WANT_IDENT)
27 #define CTRL_X_PATH_PATTERNS	(6 + CTRL_X_WANT_IDENT)
28 #define CTRL_X_PATH_DEFINES	(7 + CTRL_X_WANT_IDENT)
29 #define CTRL_X_FINISHED		8
30 #define CTRL_X_DICTIONARY	(9 + CTRL_X_WANT_IDENT)
31 #define CTRL_X_THESAURUS	(10 + CTRL_X_WANT_IDENT)
32 #define CTRL_X_CMDLINE		11
33 #define CTRL_X_FUNCTION		12
34 #define CTRL_X_OMNI		13
35 #define CTRL_X_SPELL		14
36 #define CTRL_X_LOCAL_MSG	15	/* only used in "ctrl_x_msgs" */
37 #define CTRL_X_EVAL		16	/* for builtin function complete() */
38 
39 #define CTRL_X_MSG(i) ctrl_x_msgs[(i) & ~CTRL_X_WANT_IDENT]
40 #define CTRL_X_MODE_LINE_OR_EVAL(m) (m == CTRL_X_WHOLE_LINE || m == CTRL_X_EVAL)
41 
42 static char *ctrl_x_msgs[] =
43 {
44     N_(" Keyword completion (^N^P)"), /* ctrl_x_mode == 0, ^P/^N compl. */
45     N_(" ^X mode (^]^D^E^F^I^K^L^N^O^Ps^U^V^Y)"),
46     NULL,
47     N_(" Whole line completion (^L^N^P)"),
48     N_(" File name completion (^F^N^P)"),
49     N_(" Tag completion (^]^N^P)"),
50     N_(" Path pattern completion (^N^P)"),
51     N_(" Definition completion (^D^N^P)"),
52     NULL,
53     N_(" Dictionary completion (^K^N^P)"),
54     N_(" Thesaurus completion (^T^N^P)"),
55     N_(" Command-line completion (^V^N^P)"),
56     N_(" User defined completion (^U^N^P)"),
57     N_(" Omni completion (^O^N^P)"),
58     N_(" Spelling suggestion (s^N^P)"),
59     N_(" Keyword Local completion (^N^P)"),
60     NULL,   /* CTRL_X_EVAL doesn't use msg. */
61 };
62 
63 static char e_hitend[] = N_("Hit end of paragraph");
64 #ifdef FEAT_COMPL_FUNC
65 static char e_complwin[] = N_("E839: Completion function changed window");
66 static char e_compldel[] = N_("E840: Completion function deleted text");
67 #endif
68 
69 /*
70  * Structure used to store one match for insert completion.
71  */
72 typedef struct compl_S compl_T;
73 struct compl_S
74 {
75     compl_T	*cp_next;
76     compl_T	*cp_prev;
77     char_u	*cp_str;	/* matched text */
78     char	cp_icase;	/* TRUE or FALSE: ignore case */
79     char_u	*(cp_text[CPT_COUNT]);	/* text for the menu */
80     char_u	*cp_fname;	/* file containing the match, allocated when
81 				 * cp_flags has FREE_FNAME */
82     int		cp_flags;	/* ORIGINAL_TEXT, CONT_S_IPOS or FREE_FNAME */
83     int		cp_number;	/* sequence number */
84 };
85 
86 #define ORIGINAL_TEXT	(1)   /* the original text when the expansion begun */
87 #define FREE_FNAME	(2)
88 
89 /*
90  * All the current matches are stored in a list.
91  * "compl_first_match" points to the start of the list.
92  * "compl_curr_match" points to the currently selected entry.
93  * "compl_shown_match" is different from compl_curr_match during
94  * ins_compl_get_exp().
95  */
96 static compl_T    *compl_first_match = NULL;
97 static compl_T    *compl_curr_match = NULL;
98 static compl_T    *compl_shown_match = NULL;
99 
100 /* After using a cursor key <Enter> selects a match in the popup menu,
101  * otherwise it inserts a line break. */
102 static int	  compl_enter_selects = FALSE;
103 
104 /* When "compl_leader" is not NULL only matches that start with this string
105  * are used. */
106 static char_u	  *compl_leader = NULL;
107 
108 static int	  compl_get_longest = FALSE;	/* put longest common string
109 						   in compl_leader */
110 
111 static int	  compl_no_insert = FALSE;	/* FALSE: select & insert
112 						   TRUE: noinsert */
113 static int	  compl_no_select = FALSE;	/* FALSE: select & insert
114 						   TRUE: noselect */
115 
116 static int	  compl_used_match;	/* Selected one of the matches.  When
117 					   FALSE the match was edited or using
118 					   the longest common string. */
119 
120 static int	  compl_was_interrupted = FALSE;  /* didn't finish finding
121 						     completions. */
122 
123 static int	  compl_restarting = FALSE;	/* don't insert match */
124 
125 /* When the first completion is done "compl_started" is set.  When it's
126  * FALSE the word to be completed must be located. */
127 static int	  compl_started = FALSE;
128 
129 /* Set when doing something for completion that may call edit() recursively,
130  * which is not allowed. */
131 static int	  compl_busy = FALSE;
132 
133 static int	  compl_matches = 0;
134 static char_u	  *compl_pattern = NULL;
135 static int	  compl_direction = FORWARD;
136 static int	  compl_shows_dir = FORWARD;
137 static int	  compl_pending = 0;	    /* > 1 for postponed CTRL-N */
138 static pos_T	  compl_startpos;
139 static colnr_T	  compl_col = 0;	    /* column where the text starts
140 					     * that is being completed */
141 static char_u	  *compl_orig_text = NULL;  /* text as it was before
142 					     * completion started */
143 static int	  compl_cont_mode = 0;
144 static expand_T	  compl_xp;
145 
146 static int	  compl_opt_refresh_always = FALSE;
147 
148 static void ins_ctrl_x(void);
149 static int  has_compl_option(int dict_opt);
150 static int  ins_compl_accept_char(int c);
151 static int ins_compl_add(char_u *str, int len, int icase, char_u *fname, char_u **cptext, int cdir, int flags, int adup);
152 static int  ins_compl_equal(compl_T *match, char_u *str, int len);
153 static void ins_compl_longest_match(compl_T *match);
154 static void ins_compl_add_matches(int num_matches, char_u **matches, int icase);
155 static int  ins_compl_make_cyclic(void);
156 static void ins_compl_upd_pum(void);
157 static void ins_compl_del_pum(void);
158 static int  pum_wanted(void);
159 static int  pum_enough_matches(void);
160 static void ins_compl_dictionaries(char_u *dict, char_u *pat, int flags, int thesaurus);
161 static void ins_compl_files(int count, char_u **files, int thesaurus, int flags, regmatch_T *regmatch, char_u *buf, int *dir);
162 static char_u *find_line_end(char_u *ptr);
163 static void ins_compl_free(void);
164 static void ins_compl_clear(void);
165 static int  ins_compl_bs(void);
166 static int  ins_compl_need_restart(void);
167 static void ins_compl_new_leader(void);
168 static void ins_compl_addleader(int c);
169 static int  ins_compl_len(void);
170 static void ins_compl_restart(void);
171 static void ins_compl_set_original_text(char_u *str);
172 static void ins_compl_addfrommatch(void);
173 static int  ins_compl_prep(int c);
174 static void ins_compl_fixRedoBufForLeader(char_u *ptr_arg);
175 static buf_T *ins_compl_next_buf(buf_T *buf, int flag);
176 #if defined(FEAT_COMPL_FUNC) || defined(FEAT_EVAL)
177 static void ins_compl_add_list(list_T *list);
178 static void ins_compl_add_dict(dict_T *dict);
179 #endif
180 static int  ins_compl_get_exp(pos_T *ini);
181 static void ins_compl_delete(void);
182 static void ins_compl_insert(void);
183 static int  ins_compl_next(int allow_get_expansion, int count, int insert_match);
184 static int  ins_compl_key2dir(int c);
185 static int  ins_compl_pum_key(int c);
186 static int  ins_compl_key2count(int c);
187 static int  ins_compl_use_match(int c);
188 static int  ins_complete(int c, int enable_pum);
189 static void show_pum(int save_w_wrow);
190 static unsigned  quote_meta(char_u *dest, char_u *str, int len);
191 #endif /* FEAT_INS_EXPAND */
192 
193 #define BACKSPACE_CHAR		    1
194 #define BACKSPACE_WORD		    2
195 #define BACKSPACE_WORD_NOT_SPACE    3
196 #define BACKSPACE_LINE		    4
197 
198 static void ins_redraw(int ready);
199 static void ins_ctrl_v(void);
200 static void undisplay_dollar(void);
201 static void insert_special(int, int, int);
202 static void internal_format(int textwidth, int second_indent, int flags, int format_only, int c);
203 static void check_auto_format(int);
204 static void redo_literal(int c);
205 static void start_arrow(pos_T *end_insert_pos);
206 static void start_arrow_with_change(pos_T *end_insert_pos, int change);
207 static void start_arrow_common(pos_T *end_insert_pos, int change);
208 #ifdef FEAT_SPELL
209 static void check_spell_redraw(void);
210 static void spell_back_to_badword(void);
211 static int  spell_bad_len = 0;	/* length of located bad word */
212 #endif
213 static void stop_insert(pos_T *end_insert_pos, int esc, int nomove);
214 static int  echeck_abbr(int);
215 static int  replace_pop(void);
216 static void replace_join(int off);
217 static void replace_pop_ins(void);
218 #ifdef FEAT_MBYTE
219 static void mb_replace_pop_ins(int cc);
220 #endif
221 static void replace_flush(void);
222 static void replace_do_bs(int limit_col);
223 static int del_char_after_col(int limit_col);
224 #ifdef FEAT_CINDENT
225 static int cindent_on(void);
226 #endif
227 static void ins_reg(void);
228 static void ins_ctrl_g(void);
229 static void ins_ctrl_hat(void);
230 static int  ins_esc(long *count, int cmdchar, int nomove);
231 #ifdef FEAT_RIGHTLEFT
232 static void ins_ctrl_(void);
233 #endif
234 static int ins_start_select(int c);
235 static void ins_insert(int replaceState);
236 static void ins_ctrl_o(void);
237 static void ins_shift(int c, int lastc);
238 static void ins_del(void);
239 static int  ins_bs(int c, int mode, int *inserted_space_p);
240 #ifdef FEAT_MOUSE
241 static void ins_mouse(int c);
242 static void ins_mousescroll(int dir);
243 #endif
244 #if defined(FEAT_GUI_TABLINE) || defined(PROTO)
245 static void ins_tabline(int c);
246 #endif
247 static void ins_left(int end_change);
248 static void ins_home(int c);
249 static void ins_end(int c);
250 static void ins_s_left(void);
251 static void ins_right(int end_change);
252 static void ins_s_right(void);
253 static void ins_up(int startcol);
254 static void ins_pageup(void);
255 static void ins_down(int startcol);
256 static void ins_pagedown(void);
257 #ifdef FEAT_DND
258 static void ins_drop(void);
259 #endif
260 static int  ins_tab(void);
261 static int  ins_eol(int c);
262 #ifdef FEAT_DIGRAPHS
263 static int  ins_digraph(void);
264 #endif
265 static int  ins_ctrl_ey(int tc);
266 #ifdef FEAT_SMARTINDENT
267 static void ins_try_si(int c);
268 #endif
269 static colnr_T get_nolist_virtcol(void);
270 #ifdef FEAT_AUTOCMD
271 static char_u *do_insert_char_pre(int c);
272 #endif
273 
274 static colnr_T	Insstart_textlen;	/* length of line when insert started */
275 static colnr_T	Insstart_blank_vcol;	/* vcol for first inserted blank */
276 static int	update_Insstart_orig = TRUE; /* set Insstart_orig to Insstart */
277 
278 static char_u	*last_insert = NULL;	/* the text of the previous insert,
279 					   K_SPECIAL and CSI are escaped */
280 static int	last_insert_skip; /* nr of chars in front of previous insert */
281 static int	new_insert_skip;  /* nr of chars in front of current insert */
282 static int	did_restart_edit;	/* "restart_edit" when calling edit() */
283 
284 #ifdef FEAT_CINDENT
285 static int	can_cindent;		/* may do cindenting on this line */
286 #endif
287 
288 static int	old_indent = 0;		/* for ^^D command in insert mode */
289 
290 #ifdef FEAT_RIGHTLEFT
291 static int	revins_on;		/* reverse insert mode on */
292 static int	revins_chars;		/* how much to skip after edit */
293 static int	revins_legal;		/* was the last char 'legal'? */
294 static int	revins_scol;		/* start column of revins session */
295 #endif
296 
297 static int	ins_need_undo;		/* call u_save() before inserting a
298 					   char.  Set when edit() is called.
299 					   after that arrow_used is used. */
300 
301 static int	did_add_space = FALSE;	/* auto_format() added an extra space
302 					   under the cursor */
303 static int	dont_sync_undo = FALSE;	/* CTRL-G U prevents syncing undo for
304 					   the next left/right cursor */
305 
306 /*
307  * edit(): Start inserting text.
308  *
309  * "cmdchar" can be:
310  * 'i'	normal insert command
311  * 'a'	normal append command
312  * 'R'	replace command
313  * 'r'	"r<CR>" command: insert one <CR>.  Note: count can be > 1, for redo,
314  *	but still only one <CR> is inserted.  The <Esc> is not used for redo.
315  * 'g'	"gI" command.
316  * 'V'	"gR" command for Virtual Replace mode.
317  * 'v'	"gr" command for single character Virtual Replace mode.
318  *
319  * This function is not called recursively.  For CTRL-O commands, it returns
320  * and lets the caller handle the Normal-mode command.
321  *
322  * Return TRUE if a CTRL-O command caused the return (insert mode pending).
323  */
324     int
325 edit(
326     int		cmdchar,
327     int		startln,	/* if set, insert at start of line */
328     long	count)
329 {
330     int		c = 0;
331     char_u	*ptr;
332     int		lastc = 0;
333     int		mincol;
334     static linenr_T o_lnum = 0;
335     int		i;
336     int		did_backspace = TRUE;	    /* previous char was backspace */
337 #ifdef FEAT_CINDENT
338     int		line_is_white = FALSE;	    /* line is empty before insert */
339 #endif
340     linenr_T	old_topline = 0;	    /* topline before insertion */
341 #ifdef FEAT_DIFF
342     int		old_topfill = -1;
343 #endif
344     int		inserted_space = FALSE;     /* just inserted a space */
345     int		replaceState = REPLACE;
346     int		nomove = FALSE;		    /* don't move cursor on return */
347 
348     /* Remember whether editing was restarted after CTRL-O. */
349     did_restart_edit = restart_edit;
350 
351     /* sleep before redrawing, needed for "CTRL-O :" that results in an
352      * error message */
353     check_for_delay(TRUE);
354 
355     /* set Insstart_orig to Insstart */
356     update_Insstart_orig = TRUE;
357 
358 #ifdef HAVE_SANDBOX
359     /* Don't allow inserting in the sandbox. */
360     if (sandbox != 0)
361     {
362 	EMSG(_(e_sandbox));
363 	return FALSE;
364     }
365 #endif
366     /* Don't allow changes in the buffer while editing the cmdline.  The
367      * caller of getcmdline() may get confused. */
368     if (textlock != 0)
369     {
370 	EMSG(_(e_secure));
371 	return FALSE;
372     }
373 
374 #ifdef FEAT_INS_EXPAND
375     /* Don't allow recursive insert mode when busy with completion. */
376     if (compl_started || compl_busy || pum_visible())
377     {
378 	EMSG(_(e_secure));
379 	return FALSE;
380     }
381     ins_compl_clear();	    /* clear stuff for CTRL-X mode */
382 #endif
383 
384 #ifdef FEAT_AUTOCMD
385     /*
386      * Trigger InsertEnter autocommands.  Do not do this for "r<CR>" or "grx".
387      */
388     if (cmdchar != 'r' && cmdchar != 'v')
389     {
390 	pos_T   save_cursor = curwin->w_cursor;
391 
392 # ifdef FEAT_EVAL
393 	if (cmdchar == 'R')
394 	    ptr = (char_u *)"r";
395 	else if (cmdchar == 'V')
396 	    ptr = (char_u *)"v";
397 	else
398 	    ptr = (char_u *)"i";
399 	set_vim_var_string(VV_INSERTMODE, ptr, 1);
400 	set_vim_var_string(VV_CHAR, NULL, -1);  /* clear v:char */
401 # endif
402 	apply_autocmds(EVENT_INSERTENTER, NULL, NULL, FALSE, curbuf);
403 
404 	/* Make sure the cursor didn't move.  Do call check_cursor_col() in
405 	 * case the text was modified.  Since Insert mode was not started yet
406 	 * a call to check_cursor_col() may move the cursor, especially with
407 	 * the "A" command, thus set State to avoid that. Also check that the
408 	 * line number is still valid (lines may have been deleted).
409 	 * Do not restore if v:char was set to a non-empty string. */
410 	if (!equalpos(curwin->w_cursor, save_cursor)
411 # ifdef FEAT_EVAL
412 		&& *get_vim_var_str(VV_CHAR) == NUL
413 # endif
414 		&& save_cursor.lnum <= curbuf->b_ml.ml_line_count)
415 	{
416 	    int save_state = State;
417 
418 	    curwin->w_cursor = save_cursor;
419 	    State = INSERT;
420 	    check_cursor_col();
421 	    State = save_state;
422 	}
423     }
424 #endif
425 
426 #ifdef FEAT_CONCEAL
427     /* Check if the cursor line needs redrawing before changing State.  If
428      * 'concealcursor' is "n" it needs to be redrawn without concealing. */
429     conceal_check_cursur_line();
430 #endif
431 
432 #ifdef FEAT_MOUSE
433     /*
434      * When doing a paste with the middle mouse button, Insstart is set to
435      * where the paste started.
436      */
437     if (where_paste_started.lnum != 0)
438 	Insstart = where_paste_started;
439     else
440 #endif
441     {
442 	Insstart = curwin->w_cursor;
443 	if (startln)
444 	    Insstart.col = 0;
445     }
446     Insstart_textlen = (colnr_T)linetabsize(ml_get_curline());
447     Insstart_blank_vcol = MAXCOL;
448     if (!did_ai)
449 	ai_col = 0;
450 
451     if (cmdchar != NUL && restart_edit == 0)
452     {
453 	ResetRedobuff();
454 	AppendNumberToRedobuff(count);
455 #ifdef FEAT_VREPLACE
456 	if (cmdchar == 'V' || cmdchar == 'v')
457 	{
458 	    /* "gR" or "gr" command */
459 	    AppendCharToRedobuff('g');
460 	    AppendCharToRedobuff((cmdchar == 'v') ? 'r' : 'R');
461 	}
462 	else
463 #endif
464 	{
465 	    AppendCharToRedobuff(cmdchar);
466 	    if (cmdchar == 'g')		    /* "gI" command */
467 		AppendCharToRedobuff('I');
468 	    else if (cmdchar == 'r')	    /* "r<CR>" command */
469 		count = 1;		    /* insert only one <CR> */
470 	}
471     }
472 
473     if (cmdchar == 'R')
474     {
475 #ifdef FEAT_FKMAP
476 	if (p_fkmap && p_ri)
477 	{
478 	    beep_flush();
479 	    EMSG(farsi_text_3);	    /* encoded in Farsi */
480 	    State = INSERT;
481 	}
482 	else
483 #endif
484 	State = REPLACE;
485     }
486 #ifdef FEAT_VREPLACE
487     else if (cmdchar == 'V' || cmdchar == 'v')
488     {
489 	State = VREPLACE;
490 	replaceState = VREPLACE;
491 	orig_line_count = curbuf->b_ml.ml_line_count;
492 	vr_lines_changed = 1;
493     }
494 #endif
495     else
496 	State = INSERT;
497 
498     stop_insert_mode = FALSE;
499 
500     /*
501      * Need to recompute the cursor position, it might move when the cursor is
502      * on a TAB or special character.
503      */
504     curs_columns(TRUE);
505 
506     /*
507      * Enable langmap or IME, indicated by 'iminsert'.
508      * Note that IME may enabled/disabled without us noticing here, thus the
509      * 'iminsert' value may not reflect what is actually used.  It is updated
510      * when hitting <Esc>.
511      */
512     if (curbuf->b_p_iminsert == B_IMODE_LMAP)
513 	State |= LANGMAP;
514 #ifdef USE_IM_CONTROL
515     im_set_active(curbuf->b_p_iminsert == B_IMODE_IM);
516 #endif
517 
518 #ifdef FEAT_MOUSE
519     setmouse();
520 #endif
521 #ifdef FEAT_CMDL_INFO
522     clear_showcmd();
523 #endif
524 #ifdef FEAT_RIGHTLEFT
525     /* there is no reverse replace mode */
526     revins_on = (State == INSERT && p_ri);
527     if (revins_on)
528 	undisplay_dollar();
529     revins_chars = 0;
530     revins_legal = 0;
531     revins_scol = -1;
532 #endif
533 
534     /*
535      * Handle restarting Insert mode.
536      * Don't do this for "CTRL-O ." (repeat an insert): we get here with
537      * restart_edit non-zero, and something in the stuff buffer.
538      */
539     if (restart_edit != 0 && stuff_empty())
540     {
541 #ifdef FEAT_MOUSE
542 	/*
543 	 * After a paste we consider text typed to be part of the insert for
544 	 * the pasted text. You can backspace over the pasted text too.
545 	 */
546 	if (where_paste_started.lnum)
547 	    arrow_used = FALSE;
548 	else
549 #endif
550 	    arrow_used = TRUE;
551 	restart_edit = 0;
552 
553 	/*
554 	 * If the cursor was after the end-of-line before the CTRL-O and it is
555 	 * now at the end-of-line, put it after the end-of-line (this is not
556 	 * correct in very rare cases).
557 	 * Also do this if curswant is greater than the current virtual
558 	 * column.  Eg after "^O$" or "^O80|".
559 	 */
560 	validate_virtcol();
561 	update_curswant();
562 	if (((ins_at_eol && curwin->w_cursor.lnum == o_lnum)
563 		    || curwin->w_curswant > curwin->w_virtcol)
564 		&& *(ptr = ml_get_curline() + curwin->w_cursor.col) != NUL)
565 	{
566 	    if (ptr[1] == NUL)
567 		++curwin->w_cursor.col;
568 #ifdef FEAT_MBYTE
569 	    else if (has_mbyte)
570 	    {
571 		i = (*mb_ptr2len)(ptr);
572 		if (ptr[i] == NUL)
573 		    curwin->w_cursor.col += i;
574 	    }
575 #endif
576 	}
577 	ins_at_eol = FALSE;
578     }
579     else
580 	arrow_used = FALSE;
581 
582     /* we are in insert mode now, don't need to start it anymore */
583     need_start_insertmode = FALSE;
584 
585     /* Need to save the line for undo before inserting the first char. */
586     ins_need_undo = TRUE;
587 
588 #ifdef FEAT_MOUSE
589     where_paste_started.lnum = 0;
590 #endif
591 #ifdef FEAT_CINDENT
592     can_cindent = TRUE;
593 #endif
594 #ifdef FEAT_FOLDING
595     /* The cursor line is not in a closed fold, unless 'insertmode' is set or
596      * restarting. */
597     if (!p_im && did_restart_edit == 0)
598 	foldOpenCursor();
599 #endif
600 
601     /*
602      * If 'showmode' is set, show the current (insert/replace/..) mode.
603      * A warning message for changing a readonly file is given here, before
604      * actually changing anything.  It's put after the mode, if any.
605      */
606     i = 0;
607     if (p_smd && msg_silent == 0)
608 	i = showmode();
609 
610     if (!p_im && did_restart_edit == 0)
611 	change_warning(i == 0 ? 0 : i + 1);
612 
613 #ifdef CURSOR_SHAPE
614     ui_cursor_shape();		/* may show different cursor shape */
615 #endif
616 #ifdef FEAT_DIGRAPHS
617     do_digraph(-1);		/* clear digraphs */
618 #endif
619 
620     /*
621      * Get the current length of the redo buffer, those characters have to be
622      * skipped if we want to get to the inserted characters.
623      */
624     ptr = get_inserted();
625     if (ptr == NULL)
626 	new_insert_skip = 0;
627     else
628     {
629 	new_insert_skip = (int)STRLEN(ptr);
630 	vim_free(ptr);
631     }
632 
633     old_indent = 0;
634 
635     /*
636      * Main loop in Insert mode: repeat until Insert mode is left.
637      */
638     for (;;)
639     {
640 #ifdef FEAT_RIGHTLEFT
641 	if (!revins_legal)
642 	    revins_scol = -1;	    /* reset on illegal motions */
643 	else
644 	    revins_legal = 0;
645 #endif
646 	if (arrow_used)	    /* don't repeat insert when arrow key used */
647 	    count = 0;
648 
649 	if (update_Insstart_orig)
650 	    Insstart_orig = Insstart;
651 
652 	if (stop_insert_mode
653 #ifdef FEAT_INS_EXPAND
654 		&& !pum_visible()
655 #endif
656 		)
657 	{
658 	    /* ":stopinsert" used or 'insertmode' reset */
659 	    count = 0;
660 	    goto doESCkey;
661 	}
662 
663 	/* set curwin->w_curswant for next K_DOWN or K_UP */
664 	if (!arrow_used)
665 	    curwin->w_set_curswant = TRUE;
666 
667 	/* If there is no typeahead may check for timestamps (e.g., for when a
668 	 * menu invoked a shell command). */
669 	if (stuff_empty())
670 	{
671 	    did_check_timestamps = FALSE;
672 	    if (need_check_timestamps)
673 		check_timestamps(FALSE);
674 	}
675 
676 	/*
677 	 * When emsg() was called msg_scroll will have been set.
678 	 */
679 	msg_scroll = FALSE;
680 
681 #ifdef FEAT_GUI
682 	/* When 'mousefocus' is set a mouse movement may have taken us to
683 	 * another window.  "need_mouse_correct" may then be set because of an
684 	 * autocommand. */
685 	if (need_mouse_correct)
686 	    gui_mouse_correct();
687 #endif
688 
689 #ifdef FEAT_FOLDING
690 	/* Open fold at the cursor line, according to 'foldopen'. */
691 	if (fdo_flags & FDO_INSERT)
692 	    foldOpenCursor();
693 	/* Close folds where the cursor isn't, according to 'foldclose' */
694 	if (!char_avail())
695 	    foldCheckClose();
696 #endif
697 
698 	/*
699 	 * If we inserted a character at the last position of the last line in
700 	 * the window, scroll the window one line up. This avoids an extra
701 	 * redraw.
702 	 * This is detected when the cursor column is smaller after inserting
703 	 * something.
704 	 * Don't do this when the topline changed already, it has
705 	 * already been adjusted (by insertchar() calling open_line())).
706 	 */
707 	if (curbuf->b_mod_set
708 		&& curwin->w_p_wrap
709 		&& !did_backspace
710 		&& curwin->w_topline == old_topline
711 #ifdef FEAT_DIFF
712 		&& curwin->w_topfill == old_topfill
713 #endif
714 		)
715 	{
716 	    mincol = curwin->w_wcol;
717 	    validate_cursor_col();
718 
719 	    if ((int)curwin->w_wcol < mincol - curbuf->b_p_ts
720 		    && curwin->w_wrow == W_WINROW(curwin)
721 						 + curwin->w_height - 1 - p_so
722 		    && (curwin->w_cursor.lnum != curwin->w_topline
723 #ifdef FEAT_DIFF
724 			|| curwin->w_topfill > 0
725 #endif
726 		    ))
727 	    {
728 #ifdef FEAT_DIFF
729 		if (curwin->w_topfill > 0)
730 		    --curwin->w_topfill;
731 		else
732 #endif
733 #ifdef FEAT_FOLDING
734 		if (hasFolding(curwin->w_topline, NULL, &old_topline))
735 		    set_topline(curwin, old_topline + 1);
736 		else
737 #endif
738 		    set_topline(curwin, curwin->w_topline + 1);
739 	    }
740 	}
741 
742 	/* May need to adjust w_topline to show the cursor. */
743 	update_topline();
744 
745 	did_backspace = FALSE;
746 
747 	validate_cursor();		/* may set must_redraw */
748 
749 	/*
750 	 * Redraw the display when no characters are waiting.
751 	 * Also shows mode, ruler and positions cursor.
752 	 */
753 	ins_redraw(TRUE);
754 
755 #ifdef FEAT_SCROLLBIND
756 	if (curwin->w_p_scb)
757 	    do_check_scrollbind(TRUE);
758 #endif
759 
760 #ifdef FEAT_CURSORBIND
761 	if (curwin->w_p_crb)
762 	    do_check_cursorbind();
763 #endif
764 	update_curswant();
765 	old_topline = curwin->w_topline;
766 #ifdef FEAT_DIFF
767 	old_topfill = curwin->w_topfill;
768 #endif
769 
770 #ifdef USE_ON_FLY_SCROLL
771 	dont_scroll = FALSE;		/* allow scrolling here */
772 #endif
773 
774 	/*
775 	 * Get a character for Insert mode.  Ignore K_IGNORE.
776 	 */
777 	if (c != K_CURSORHOLD)
778 	    lastc = c;		/* remember the previous char for CTRL-D */
779 
780 	/* After using CTRL-G U the next cursor key will not break undo. */
781 	if (dont_sync_undo == MAYBE)
782 	    dont_sync_undo = TRUE;
783 	else
784 	    dont_sync_undo = FALSE;
785 	do
786 	{
787 	    c = safe_vgetc();
788 	} while (c == K_IGNORE);
789 
790 #ifdef FEAT_AUTOCMD
791 	/* Don't want K_CURSORHOLD for the second key, e.g., after CTRL-V. */
792 	did_cursorhold = TRUE;
793 #endif
794 
795 #ifdef FEAT_RIGHTLEFT
796 	if (p_hkmap && KeyTyped)
797 	    c = hkmap(c);		/* Hebrew mode mapping */
798 #endif
799 #ifdef FEAT_FKMAP
800 	if (p_fkmap && KeyTyped)
801 	    c = fkmap(c);		/* Farsi mode mapping */
802 #endif
803 
804 #ifdef FEAT_INS_EXPAND
805 	/*
806 	 * Special handling of keys while the popup menu is visible or wanted
807 	 * and the cursor is still in the completed word.  Only when there is
808 	 * a match, skip this when no matches were found.
809 	 */
810 	if (compl_started
811 		&& pum_wanted()
812 		&& curwin->w_cursor.col >= compl_col
813 		&& (compl_shown_match == NULL
814 		    || compl_shown_match != compl_shown_match->cp_next))
815 	{
816 	    /* BS: Delete one character from "compl_leader". */
817 	    if ((c == K_BS || c == Ctrl_H)
818 			&& curwin->w_cursor.col > compl_col
819 			&& (c = ins_compl_bs()) == NUL)
820 		continue;
821 
822 	    /* When no match was selected or it was edited. */
823 	    if (!compl_used_match)
824 	    {
825 		/* CTRL-L: Add one character from the current match to
826 		 * "compl_leader".  Except when at the original match and
827 		 * there is nothing to add, CTRL-L works like CTRL-P then. */
828 		if (c == Ctrl_L
829 			&& (!CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode)
830 			    || (int)STRLEN(compl_shown_match->cp_str)
831 					  > curwin->w_cursor.col - compl_col))
832 		{
833 		    ins_compl_addfrommatch();
834 		    continue;
835 		}
836 
837 		/* A non-white character that fits in with the current
838 		 * completion: Add to "compl_leader". */
839 		if (ins_compl_accept_char(c))
840 		{
841 #ifdef FEAT_AUTOCMD
842 		    /* Trigger InsertCharPre. */
843 		    char_u *str = do_insert_char_pre(c);
844 		    char_u *p;
845 
846 		    if (str != NULL)
847 		    {
848 			for (p = str; *p != NUL; mb_ptr_adv(p))
849 			    ins_compl_addleader(PTR2CHAR(p));
850 			vim_free(str);
851 		    }
852 		    else
853 #endif
854 			ins_compl_addleader(c);
855 		    continue;
856 		}
857 
858 		/* Pressing CTRL-Y selects the current match.  When
859 		 * compl_enter_selects is set the Enter key does the same. */
860 		if (c == Ctrl_Y || (compl_enter_selects
861 				   && (c == CAR || c == K_KENTER || c == NL)))
862 		{
863 		    ins_compl_delete();
864 		    ins_compl_insert();
865 		}
866 	    }
867 	}
868 
869 	/* Prepare for or stop CTRL-X mode.  This doesn't do completion, but
870 	 * it does fix up the text when finishing completion. */
871 	compl_get_longest = FALSE;
872 	if (ins_compl_prep(c))
873 	    continue;
874 #endif
875 
876 	/* CTRL-\ CTRL-N goes to Normal mode,
877 	 * CTRL-\ CTRL-G goes to mode selected with 'insertmode',
878 	 * CTRL-\ CTRL-O is like CTRL-O but without moving the cursor.  */
879 	if (c == Ctrl_BSL)
880 	{
881 	    /* may need to redraw when no more chars available now */
882 	    ins_redraw(FALSE);
883 	    ++no_mapping;
884 	    ++allow_keys;
885 	    c = plain_vgetc();
886 	    --no_mapping;
887 	    --allow_keys;
888 	    if (c != Ctrl_N && c != Ctrl_G && c != Ctrl_O)
889 	    {
890 		/* it's something else */
891 		vungetc(c);
892 		c = Ctrl_BSL;
893 	    }
894 	    else if (c == Ctrl_G && p_im)
895 		continue;
896 	    else
897 	    {
898 		if (c == Ctrl_O)
899 		{
900 		    ins_ctrl_o();
901 		    ins_at_eol = FALSE;	/* cursor keeps its column */
902 		    nomove = TRUE;
903 		}
904 		count = 0;
905 		goto doESCkey;
906 	    }
907 	}
908 
909 #ifdef FEAT_DIGRAPHS
910 	c = do_digraph(c);
911 #endif
912 
913 #ifdef FEAT_INS_EXPAND
914 	if ((c == Ctrl_V || c == Ctrl_Q) && ctrl_x_mode == CTRL_X_CMDLINE)
915 	    goto docomplete;
916 #endif
917 	if (c == Ctrl_V || c == Ctrl_Q)
918 	{
919 	    ins_ctrl_v();
920 	    c = Ctrl_V;	/* pretend CTRL-V is last typed character */
921 	    continue;
922 	}
923 
924 #ifdef FEAT_CINDENT
925 	if (cindent_on()
926 # ifdef FEAT_INS_EXPAND
927 		&& ctrl_x_mode == 0
928 # endif
929 	   )
930 	{
931 	    /* A key name preceded by a bang means this key is not to be
932 	     * inserted.  Skip ahead to the re-indenting below.
933 	     * A key name preceded by a star means that indenting has to be
934 	     * done before inserting the key. */
935 	    line_is_white = inindent(0);
936 	    if (in_cinkeys(c, '!', line_is_white))
937 		goto force_cindent;
938 	    if (can_cindent && in_cinkeys(c, '*', line_is_white)
939 							&& stop_arrow() == OK)
940 		do_c_expr_indent();
941 	}
942 #endif
943 
944 #ifdef FEAT_RIGHTLEFT
945 	if (curwin->w_p_rl)
946 	    switch (c)
947 	    {
948 		case K_LEFT:	c = K_RIGHT; break;
949 		case K_S_LEFT:	c = K_S_RIGHT; break;
950 		case K_C_LEFT:	c = K_C_RIGHT; break;
951 		case K_RIGHT:	c = K_LEFT; break;
952 		case K_S_RIGHT: c = K_S_LEFT; break;
953 		case K_C_RIGHT: c = K_C_LEFT; break;
954 	    }
955 #endif
956 
957 	/*
958 	 * If 'keymodel' contains "startsel", may start selection.  If it
959 	 * does, a CTRL-O and c will be stuffed, we need to get these
960 	 * characters.
961 	 */
962 	if (ins_start_select(c))
963 	    continue;
964 
965 	/*
966 	 * The big switch to handle a character in insert mode.
967 	 */
968 	switch (c)
969 	{
970 	case ESC:	/* End input mode */
971 	    if (echeck_abbr(ESC + ABBR_OFF))
972 		break;
973 	    /*FALLTHROUGH*/
974 
975 	case Ctrl_C:	/* End input mode */
976 #ifdef FEAT_CMDWIN
977 	    if (c == Ctrl_C && cmdwin_type != 0)
978 	    {
979 		/* Close the cmdline window. */
980 		cmdwin_result = K_IGNORE;
981 		got_int = FALSE; /* don't stop executing autocommands et al. */
982 		nomove = TRUE;
983 		goto doESCkey;
984 	    }
985 #endif
986 
987 #ifdef UNIX
988 do_intr:
989 #endif
990 	    /* when 'insertmode' set, and not halfway a mapping, don't leave
991 	     * Insert mode */
992 	    if (goto_im())
993 	    {
994 		if (got_int)
995 		{
996 		    (void)vgetc();		/* flush all buffers */
997 		    got_int = FALSE;
998 		}
999 		else
1000 		    vim_beep(BO_IM);
1001 		break;
1002 	    }
1003 doESCkey:
1004 	    /*
1005 	     * This is the ONLY return from edit()!
1006 	     */
1007 	    /* Always update o_lnum, so that a "CTRL-O ." that adds a line
1008 	     * still puts the cursor back after the inserted text. */
1009 	    if (ins_at_eol && gchar_cursor() == NUL)
1010 		o_lnum = curwin->w_cursor.lnum;
1011 
1012 	    if (ins_esc(&count, cmdchar, nomove))
1013 	    {
1014 #ifdef FEAT_AUTOCMD
1015 		if (cmdchar != 'r' && cmdchar != 'v')
1016 		    apply_autocmds(EVENT_INSERTLEAVE, NULL, NULL,
1017 							       FALSE, curbuf);
1018 		did_cursorhold = FALSE;
1019 #endif
1020 		return (c == Ctrl_O);
1021 	    }
1022 	    continue;
1023 
1024 	case Ctrl_Z:	/* suspend when 'insertmode' set */
1025 	    if (!p_im)
1026 		goto normalchar;	/* insert CTRL-Z as normal char */
1027 	    stuffReadbuff((char_u *)":st\r");
1028 	    c = Ctrl_O;
1029 	    /*FALLTHROUGH*/
1030 
1031 	case Ctrl_O:	/* execute one command */
1032 #ifdef FEAT_COMPL_FUNC
1033 	    if (ctrl_x_mode == CTRL_X_OMNI)
1034 		goto docomplete;
1035 #endif
1036 	    if (echeck_abbr(Ctrl_O + ABBR_OFF))
1037 		break;
1038 	    ins_ctrl_o();
1039 
1040 #ifdef FEAT_VIRTUALEDIT
1041 	    /* don't move the cursor left when 'virtualedit' has "onemore". */
1042 	    if (ve_flags & VE_ONEMORE)
1043 	    {
1044 		ins_at_eol = FALSE;
1045 		nomove = TRUE;
1046 	    }
1047 #endif
1048 	    count = 0;
1049 	    goto doESCkey;
1050 
1051 	case K_INS:	/* toggle insert/replace mode */
1052 	case K_KINS:
1053 	    ins_insert(replaceState);
1054 	    break;
1055 
1056 	case K_SELECT:	/* end of Select mode mapping - ignore */
1057 	    break;
1058 
1059 	case K_HELP:	/* Help key works like <ESC> <Help> */
1060 	case K_F1:
1061 	case K_XF1:
1062 	    stuffcharReadbuff(K_HELP);
1063 	    if (p_im)
1064 		need_start_insertmode = TRUE;
1065 	    goto doESCkey;
1066 
1067 #ifdef FEAT_NETBEANS_INTG
1068 	case K_F21:	/* NetBeans command */
1069 	    ++no_mapping;		/* don't map the next key hits */
1070 	    i = plain_vgetc();
1071 	    --no_mapping;
1072 	    netbeans_keycommand(i);
1073 	    break;
1074 #endif
1075 
1076 	case K_ZERO:	/* Insert the previously inserted text. */
1077 	case NUL:
1078 	case Ctrl_A:
1079 	    /* For ^@ the trailing ESC will end the insert, unless there is an
1080 	     * error.  */
1081 	    if (stuff_inserted(NUL, 1L, (c == Ctrl_A)) == FAIL
1082 						   && c != Ctrl_A && !p_im)
1083 		goto doESCkey;		/* quit insert mode */
1084 	    inserted_space = FALSE;
1085 	    break;
1086 
1087 	case Ctrl_R:	/* insert the contents of a register */
1088 	    ins_reg();
1089 	    auto_format(FALSE, TRUE);
1090 	    inserted_space = FALSE;
1091 	    break;
1092 
1093 	case Ctrl_G:	/* commands starting with CTRL-G */
1094 	    ins_ctrl_g();
1095 	    break;
1096 
1097 	case Ctrl_HAT:	/* switch input mode and/or langmap */
1098 	    ins_ctrl_hat();
1099 	    break;
1100 
1101 #ifdef FEAT_RIGHTLEFT
1102 	case Ctrl__:	/* switch between languages */
1103 	    if (!p_ari)
1104 		goto normalchar;
1105 	    ins_ctrl_();
1106 	    break;
1107 #endif
1108 
1109 	case Ctrl_D:	/* Make indent one shiftwidth smaller. */
1110 #if defined(FEAT_INS_EXPAND) && defined(FEAT_FIND_ID)
1111 	    if (ctrl_x_mode == CTRL_X_PATH_DEFINES)
1112 		goto docomplete;
1113 #endif
1114 	    /* FALLTHROUGH */
1115 
1116 	case Ctrl_T:	/* Make indent one shiftwidth greater. */
1117 # ifdef FEAT_INS_EXPAND
1118 	    if (c == Ctrl_T && ctrl_x_mode == CTRL_X_THESAURUS)
1119 	    {
1120 		if (has_compl_option(FALSE))
1121 		    goto docomplete;
1122 		break;
1123 	    }
1124 # endif
1125 	    ins_shift(c, lastc);
1126 	    auto_format(FALSE, TRUE);
1127 	    inserted_space = FALSE;
1128 	    break;
1129 
1130 	case K_DEL:	/* delete character under the cursor */
1131 	case K_KDEL:
1132 	    ins_del();
1133 	    auto_format(FALSE, TRUE);
1134 	    break;
1135 
1136 	case K_BS:	/* delete character before the cursor */
1137 	case Ctrl_H:
1138 	    did_backspace = ins_bs(c, BACKSPACE_CHAR, &inserted_space);
1139 	    auto_format(FALSE, TRUE);
1140 	    break;
1141 
1142 	case Ctrl_W:	/* delete word before the cursor */
1143 	    did_backspace = ins_bs(c, BACKSPACE_WORD, &inserted_space);
1144 	    auto_format(FALSE, TRUE);
1145 	    break;
1146 
1147 	case Ctrl_U:	/* delete all inserted text in current line */
1148 # ifdef FEAT_COMPL_FUNC
1149 	    /* CTRL-X CTRL-U completes with 'completefunc'. */
1150 	    if (ctrl_x_mode == CTRL_X_FUNCTION)
1151 		goto docomplete;
1152 # endif
1153 	    did_backspace = ins_bs(c, BACKSPACE_LINE, &inserted_space);
1154 	    auto_format(FALSE, TRUE);
1155 	    inserted_space = FALSE;
1156 	    break;
1157 
1158 #ifdef FEAT_MOUSE
1159 	case K_LEFTMOUSE:   /* mouse keys */
1160 	case K_LEFTMOUSE_NM:
1161 	case K_LEFTDRAG:
1162 	case K_LEFTRELEASE:
1163 	case K_LEFTRELEASE_NM:
1164 	case K_MIDDLEMOUSE:
1165 	case K_MIDDLEDRAG:
1166 	case K_MIDDLERELEASE:
1167 	case K_RIGHTMOUSE:
1168 	case K_RIGHTDRAG:
1169 	case K_RIGHTRELEASE:
1170 	case K_X1MOUSE:
1171 	case K_X1DRAG:
1172 	case K_X1RELEASE:
1173 	case K_X2MOUSE:
1174 	case K_X2DRAG:
1175 	case K_X2RELEASE:
1176 	    ins_mouse(c);
1177 	    break;
1178 
1179 	case K_MOUSEDOWN: /* Default action for scroll wheel up: scroll up */
1180 	    ins_mousescroll(MSCR_DOWN);
1181 	    break;
1182 
1183 	case K_MOUSEUP:	/* Default action for scroll wheel down: scroll down */
1184 	    ins_mousescroll(MSCR_UP);
1185 	    break;
1186 
1187 	case K_MOUSELEFT: /* Scroll wheel left */
1188 	    ins_mousescroll(MSCR_LEFT);
1189 	    break;
1190 
1191 	case K_MOUSERIGHT: /* Scroll wheel right */
1192 	    ins_mousescroll(MSCR_RIGHT);
1193 	    break;
1194 #endif
1195 #ifdef FEAT_GUI_TABLINE
1196 	case K_TABLINE:
1197 	case K_TABMENU:
1198 	    ins_tabline(c);
1199 	    break;
1200 #endif
1201 
1202 	case K_IGNORE:	/* Something mapped to nothing */
1203 	    break;
1204 
1205 #ifdef FEAT_AUTOCMD
1206 	case K_CURSORHOLD:	/* Didn't type something for a while. */
1207 	    apply_autocmds(EVENT_CURSORHOLDI, NULL, NULL, FALSE, curbuf);
1208 	    did_cursorhold = TRUE;
1209 	    break;
1210 #endif
1211 
1212 #ifdef FEAT_GUI_W32
1213 	    /* On Win32 ignore <M-F4>, we get it when closing the window was
1214 	     * cancelled. */
1215 	case K_F4:
1216 	    if (mod_mask != MOD_MASK_ALT)
1217 		goto normalchar;
1218 	    break;
1219 #endif
1220 
1221 #ifdef FEAT_GUI
1222 	case K_VER_SCROLLBAR:
1223 	    ins_scroll();
1224 	    break;
1225 
1226 	case K_HOR_SCROLLBAR:
1227 	    ins_horscroll();
1228 	    break;
1229 #endif
1230 
1231 	case K_HOME:	/* <Home> */
1232 	case K_KHOME:
1233 	case K_S_HOME:
1234 	case K_C_HOME:
1235 	    ins_home(c);
1236 	    break;
1237 
1238 	case K_END:	/* <End> */
1239 	case K_KEND:
1240 	case K_S_END:
1241 	case K_C_END:
1242 	    ins_end(c);
1243 	    break;
1244 
1245 	case K_LEFT:	/* <Left> */
1246 	    if (mod_mask & (MOD_MASK_SHIFT|MOD_MASK_CTRL))
1247 		ins_s_left();
1248 	    else
1249 		ins_left(dont_sync_undo == FALSE);
1250 	    break;
1251 
1252 	case K_S_LEFT:	/* <S-Left> */
1253 	case K_C_LEFT:
1254 	    ins_s_left();
1255 	    break;
1256 
1257 	case K_RIGHT:	/* <Right> */
1258 	    if (mod_mask & (MOD_MASK_SHIFT|MOD_MASK_CTRL))
1259 		ins_s_right();
1260 	    else
1261 		ins_right(dont_sync_undo == FALSE);
1262 	    break;
1263 
1264 	case K_S_RIGHT:	/* <S-Right> */
1265 	case K_C_RIGHT:
1266 	    ins_s_right();
1267 	    break;
1268 
1269 	case K_UP:	/* <Up> */
1270 #ifdef FEAT_INS_EXPAND
1271 	    if (pum_visible())
1272 		goto docomplete;
1273 #endif
1274 	    if (mod_mask & MOD_MASK_SHIFT)
1275 		ins_pageup();
1276 	    else
1277 		ins_up(FALSE);
1278 	    break;
1279 
1280 	case K_S_UP:	/* <S-Up> */
1281 	case K_PAGEUP:
1282 	case K_KPAGEUP:
1283 #ifdef FEAT_INS_EXPAND
1284 	    if (pum_visible())
1285 		goto docomplete;
1286 #endif
1287 	    ins_pageup();
1288 	    break;
1289 
1290 	case K_DOWN:	/* <Down> */
1291 #ifdef FEAT_INS_EXPAND
1292 	    if (pum_visible())
1293 		goto docomplete;
1294 #endif
1295 	    if (mod_mask & MOD_MASK_SHIFT)
1296 		ins_pagedown();
1297 	    else
1298 		ins_down(FALSE);
1299 	    break;
1300 
1301 	case K_S_DOWN:	/* <S-Down> */
1302 	case K_PAGEDOWN:
1303 	case K_KPAGEDOWN:
1304 #ifdef FEAT_INS_EXPAND
1305 	    if (pum_visible())
1306 		goto docomplete;
1307 #endif
1308 	    ins_pagedown();
1309 	    break;
1310 
1311 #ifdef FEAT_DND
1312 	case K_DROP:	/* drag-n-drop event */
1313 	    ins_drop();
1314 	    break;
1315 #endif
1316 
1317 	case K_S_TAB:	/* When not mapped, use like a normal TAB */
1318 	    c = TAB;
1319 	    /* FALLTHROUGH */
1320 
1321 	case TAB:	/* TAB or Complete patterns along path */
1322 #if defined(FEAT_INS_EXPAND) && defined(FEAT_FIND_ID)
1323 	    if (ctrl_x_mode == CTRL_X_PATH_PATTERNS)
1324 		goto docomplete;
1325 #endif
1326 	    inserted_space = FALSE;
1327 	    if (ins_tab())
1328 		goto normalchar;	/* insert TAB as a normal char */
1329 	    auto_format(FALSE, TRUE);
1330 	    break;
1331 
1332 	case K_KENTER:	/* <Enter> */
1333 	    c = CAR;
1334 	    /* FALLTHROUGH */
1335 	case CAR:
1336 	case NL:
1337 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
1338 	    /* In a quickfix window a <CR> jumps to the error under the
1339 	     * cursor. */
1340 	    if (bt_quickfix(curbuf) && c == CAR)
1341 	    {
1342 		if (curwin->w_llist_ref == NULL)    /* quickfix window */
1343 		    do_cmdline_cmd((char_u *)".cc");
1344 		else				    /* location list window */
1345 		    do_cmdline_cmd((char_u *)".ll");
1346 		break;
1347 	    }
1348 #endif
1349 #ifdef FEAT_CMDWIN
1350 	    if (cmdwin_type != 0)
1351 	    {
1352 		/* Execute the command in the cmdline window. */
1353 		cmdwin_result = CAR;
1354 		goto doESCkey;
1355 	    }
1356 #endif
1357 	    if (ins_eol(c) && !p_im)
1358 		goto doESCkey;	    /* out of memory */
1359 	    auto_format(FALSE, FALSE);
1360 	    inserted_space = FALSE;
1361 	    break;
1362 
1363 #if defined(FEAT_DIGRAPHS) || defined(FEAT_INS_EXPAND)
1364 	case Ctrl_K:	    /* digraph or keyword completion */
1365 # ifdef FEAT_INS_EXPAND
1366 	    if (ctrl_x_mode == CTRL_X_DICTIONARY)
1367 	    {
1368 		if (has_compl_option(TRUE))
1369 		    goto docomplete;
1370 		break;
1371 	    }
1372 # endif
1373 # ifdef FEAT_DIGRAPHS
1374 	    c = ins_digraph();
1375 	    if (c == NUL)
1376 		break;
1377 # endif
1378 	    goto normalchar;
1379 #endif
1380 
1381 #ifdef FEAT_INS_EXPAND
1382 	case Ctrl_X:	/* Enter CTRL-X mode */
1383 	    ins_ctrl_x();
1384 	    break;
1385 
1386 	case Ctrl_RSB:	/* Tag name completion after ^X */
1387 	    if (ctrl_x_mode != CTRL_X_TAGS)
1388 		goto normalchar;
1389 	    goto docomplete;
1390 
1391 	case Ctrl_F:	/* File name completion after ^X */
1392 	    if (ctrl_x_mode != CTRL_X_FILES)
1393 		goto normalchar;
1394 	    goto docomplete;
1395 
1396 	case 's':	/* Spelling completion after ^X */
1397 	case Ctrl_S:
1398 	    if (ctrl_x_mode != CTRL_X_SPELL)
1399 		goto normalchar;
1400 	    goto docomplete;
1401 #endif
1402 
1403 	case Ctrl_L:	/* Whole line completion after ^X */
1404 #ifdef FEAT_INS_EXPAND
1405 	    if (ctrl_x_mode != CTRL_X_WHOLE_LINE)
1406 #endif
1407 	    {
1408 		/* CTRL-L with 'insertmode' set: Leave Insert mode */
1409 		if (p_im)
1410 		{
1411 		    if (echeck_abbr(Ctrl_L + ABBR_OFF))
1412 			break;
1413 		    goto doESCkey;
1414 		}
1415 		goto normalchar;
1416 	    }
1417 #ifdef FEAT_INS_EXPAND
1418 	    /* FALLTHROUGH */
1419 
1420 	case Ctrl_P:	/* Do previous/next pattern completion */
1421 	case Ctrl_N:
1422 	    /* if 'complete' is empty then plain ^P is no longer special,
1423 	     * but it is under other ^X modes */
1424 	    if (*curbuf->b_p_cpt == NUL
1425 		    && ctrl_x_mode != 0
1426 		    && !(compl_cont_status & CONT_LOCAL))
1427 		goto normalchar;
1428 
1429 docomplete:
1430 	    compl_busy = TRUE;
1431 	    disable_fold_update++;  /* don't redraw folds here */
1432 	    if (ins_complete(c, TRUE) == FAIL)
1433 		compl_cont_status = 0;
1434 	    disable_fold_update--;
1435 	    compl_busy = FALSE;
1436 	    break;
1437 #endif /* FEAT_INS_EXPAND */
1438 
1439 	case Ctrl_Y:	/* copy from previous line or scroll down */
1440 	case Ctrl_E:	/* copy from next line	   or scroll up */
1441 	    c = ins_ctrl_ey(c);
1442 	    break;
1443 
1444 	  default:
1445 #ifdef UNIX
1446 	    if (c == intr_char)		/* special interrupt char */
1447 		goto do_intr;
1448 #endif
1449 
1450 normalchar:
1451 	    /*
1452 	     * Insert a normal character.
1453 	     */
1454 #ifdef FEAT_AUTOCMD
1455 	    if (!p_paste)
1456 	    {
1457 		/* Trigger InsertCharPre. */
1458 		char_u *str = do_insert_char_pre(c);
1459 		char_u *p;
1460 
1461 		if (str != NULL)
1462 		{
1463 		    if (*str != NUL && stop_arrow() != FAIL)
1464 		    {
1465 			/* Insert the new value of v:char literally. */
1466 			for (p = str; *p != NUL; mb_ptr_adv(p))
1467 			{
1468 			    c = PTR2CHAR(p);
1469 			    if (c == CAR || c == K_KENTER || c == NL)
1470 				ins_eol(c);
1471 			    else
1472 				ins_char(c);
1473 			}
1474 			AppendToRedobuffLit(str, -1);
1475 		    }
1476 		    vim_free(str);
1477 		    c = NUL;
1478 		}
1479 
1480 		/* If the new value is already inserted or an empty string
1481 		 * then don't insert any character. */
1482 		if (c == NUL)
1483 		    break;
1484 	    }
1485 #endif
1486 #ifdef FEAT_SMARTINDENT
1487 	    /* Try to perform smart-indenting. */
1488 	    ins_try_si(c);
1489 #endif
1490 
1491 	    if (c == ' ')
1492 	    {
1493 		inserted_space = TRUE;
1494 #ifdef FEAT_CINDENT
1495 		if (inindent(0))
1496 		    can_cindent = FALSE;
1497 #endif
1498 		if (Insstart_blank_vcol == MAXCOL
1499 			&& curwin->w_cursor.lnum == Insstart.lnum)
1500 		    Insstart_blank_vcol = get_nolist_virtcol();
1501 	    }
1502 
1503 	    /* Insert a normal character and check for abbreviations on a
1504 	     * special character.  Let CTRL-] expand abbreviations without
1505 	     * inserting it. */
1506 	    if (vim_iswordc(c) || (!echeck_abbr(
1507 #ifdef FEAT_MBYTE
1508 			/* Add ABBR_OFF for characters above 0x100, this is
1509 			 * what check_abbr() expects. */
1510 			(has_mbyte && c >= 0x100) ? (c + ABBR_OFF) :
1511 #endif
1512 		       c) && c != Ctrl_RSB))
1513 	    {
1514 		insert_special(c, FALSE, FALSE);
1515 #ifdef FEAT_RIGHTLEFT
1516 		revins_legal++;
1517 		revins_chars++;
1518 #endif
1519 	    }
1520 
1521 	    auto_format(FALSE, TRUE);
1522 
1523 #ifdef FEAT_FOLDING
1524 	    /* When inserting a character the cursor line must never be in a
1525 	     * closed fold. */
1526 	    foldOpenCursor();
1527 #endif
1528 	    break;
1529 	}   /* end of switch (c) */
1530 
1531 #ifdef FEAT_AUTOCMD
1532 	/* If typed something may trigger CursorHoldI again. */
1533 	if (c != K_CURSORHOLD
1534 # ifdef FEAT_COMPL_FUNC
1535 	    /* but not in CTRL-X mode, a script can't restore the state */
1536 	    && ctrl_x_mode == 0
1537 # endif
1538 	       )
1539 	    did_cursorhold = FALSE;
1540 #endif
1541 
1542 	/* If the cursor was moved we didn't just insert a space */
1543 	if (arrow_used)
1544 	    inserted_space = FALSE;
1545 
1546 #ifdef FEAT_CINDENT
1547 	if (can_cindent && cindent_on()
1548 # ifdef FEAT_INS_EXPAND
1549 		&& ctrl_x_mode == 0
1550 # endif
1551 	   )
1552 	{
1553 force_cindent:
1554 	    /*
1555 	     * Indent now if a key was typed that is in 'cinkeys'.
1556 	     */
1557 	    if (in_cinkeys(c, ' ', line_is_white))
1558 	    {
1559 		if (stop_arrow() == OK)
1560 		    /* re-indent the current line */
1561 		    do_c_expr_indent();
1562 	    }
1563 	}
1564 #endif /* FEAT_CINDENT */
1565 
1566     }	/* for (;;) */
1567     /* NOTREACHED */
1568 }
1569 
1570 /*
1571  * Redraw for Insert mode.
1572  * This is postponed until getting the next character to make '$' in the 'cpo'
1573  * option work correctly.
1574  * Only redraw when there are no characters available.  This speeds up
1575  * inserting sequences of characters (e.g., for CTRL-R).
1576  */
1577     static void
1578 ins_redraw(
1579     int		ready UNUSED)	    /* not busy with something */
1580 {
1581 #ifdef FEAT_CONCEAL
1582     linenr_T	conceal_old_cursor_line = 0;
1583     linenr_T	conceal_new_cursor_line = 0;
1584     int		conceal_update_lines = FALSE;
1585 #endif
1586 
1587     if (char_avail())
1588 	return;
1589 
1590 #if defined(FEAT_AUTOCMD) || defined(FEAT_CONCEAL)
1591     /* Trigger CursorMoved if the cursor moved.  Not when the popup menu is
1592      * visible, the command might delete it. */
1593     if (ready && (
1594 # ifdef FEAT_AUTOCMD
1595 		has_cursormovedI()
1596 # endif
1597 # if defined(FEAT_AUTOCMD) && defined(FEAT_CONCEAL)
1598 		||
1599 # endif
1600 # ifdef FEAT_CONCEAL
1601 		curwin->w_p_cole > 0
1602 # endif
1603 		)
1604 # ifdef FEAT_AUTOCMD
1605 	&& !equalpos(last_cursormoved, curwin->w_cursor)
1606 # endif
1607 # ifdef FEAT_INS_EXPAND
1608 	&& !pum_visible()
1609 # endif
1610        )
1611     {
1612 # ifdef FEAT_SYN_HL
1613 	/* Need to update the screen first, to make sure syntax
1614 	 * highlighting is correct after making a change (e.g., inserting
1615 	 * a "(".  The autocommand may also require a redraw, so it's done
1616 	 * again below, unfortunately. */
1617 	if (syntax_present(curwin) && must_redraw)
1618 	    update_screen(0);
1619 # endif
1620 # ifdef FEAT_AUTOCMD
1621 	if (has_cursormovedI())
1622 	{
1623 	    /* Make sure curswant is correct, an autocommand may call
1624 	     * getcurpos(). */
1625 	    update_curswant();
1626 	    apply_autocmds(EVENT_CURSORMOVEDI, NULL, NULL, FALSE, curbuf);
1627 	}
1628 # endif
1629 # ifdef FEAT_CONCEAL
1630 	if (curwin->w_p_cole > 0)
1631 	{
1632 #  ifdef FEAT_AUTOCMD
1633 	    conceal_old_cursor_line = last_cursormoved.lnum;
1634 #  endif
1635 	    conceal_new_cursor_line = curwin->w_cursor.lnum;
1636 	    conceal_update_lines = TRUE;
1637 	}
1638 # endif
1639 # ifdef FEAT_AUTOCMD
1640 	last_cursormoved = curwin->w_cursor;
1641 # endif
1642     }
1643 #endif
1644 
1645 #ifdef FEAT_AUTOCMD
1646     /* Trigger TextChangedI if b_changedtick differs. */
1647     if (ready && has_textchangedI()
1648 	    && last_changedtick != curbuf->b_changedtick
1649 # ifdef FEAT_INS_EXPAND
1650 	    && !pum_visible()
1651 # endif
1652 	    )
1653     {
1654 	if (last_changedtick_buf == curbuf)
1655 	    apply_autocmds(EVENT_TEXTCHANGEDI, NULL, NULL, FALSE, curbuf);
1656 	last_changedtick_buf = curbuf;
1657 	last_changedtick = curbuf->b_changedtick;
1658     }
1659 #endif
1660 
1661     if (must_redraw)
1662 	update_screen(0);
1663     else if (clear_cmdline || redraw_cmdline)
1664 	showmode();		/* clear cmdline and show mode */
1665 # if defined(FEAT_CONCEAL)
1666     if ((conceal_update_lines
1667 	    && (conceal_old_cursor_line != conceal_new_cursor_line
1668 		|| conceal_cursor_line(curwin)))
1669 	    || need_cursor_line_redraw)
1670     {
1671 	if (conceal_old_cursor_line != conceal_new_cursor_line)
1672 	    update_single_line(curwin, conceal_old_cursor_line);
1673 	update_single_line(curwin, conceal_new_cursor_line == 0
1674 		       ? curwin->w_cursor.lnum : conceal_new_cursor_line);
1675 	curwin->w_valid &= ~VALID_CROW;
1676     }
1677 # endif
1678     showruler(FALSE);
1679     setcursor();
1680     emsg_on_display = FALSE;	/* may remove error message now */
1681 }
1682 
1683 /*
1684  * Handle a CTRL-V or CTRL-Q typed in Insert mode.
1685  */
1686     static void
1687 ins_ctrl_v(void)
1688 {
1689     int		c;
1690     int		did_putchar = FALSE;
1691 
1692     /* may need to redraw when no more chars available now */
1693     ins_redraw(FALSE);
1694 
1695     if (redrawing() && !char_avail())
1696     {
1697 	edit_putchar('^', TRUE);
1698 	did_putchar = TRUE;
1699     }
1700     AppendToRedobuff((char_u *)CTRL_V_STR);	/* CTRL-V */
1701 
1702 #ifdef FEAT_CMDL_INFO
1703     add_to_showcmd_c(Ctrl_V);
1704 #endif
1705 
1706     c = get_literal();
1707     if (did_putchar)
1708 	/* when the line fits in 'columns' the '^' is at the start of the next
1709 	 * line and will not removed by the redraw */
1710 	edit_unputchar();
1711 #ifdef FEAT_CMDL_INFO
1712     clear_showcmd();
1713 #endif
1714     insert_special(c, FALSE, TRUE);
1715 #ifdef FEAT_RIGHTLEFT
1716     revins_chars++;
1717     revins_legal++;
1718 #endif
1719 }
1720 
1721 /*
1722  * Put a character directly onto the screen.  It's not stored in a buffer.
1723  * Used while handling CTRL-K, CTRL-V, etc. in Insert mode.
1724  */
1725 static int  pc_status;
1726 #define PC_STATUS_UNSET	0	/* pc_bytes was not set */
1727 #define PC_STATUS_RIGHT	1	/* right halve of double-wide char */
1728 #define PC_STATUS_LEFT	2	/* left halve of double-wide char */
1729 #define PC_STATUS_SET	3	/* pc_bytes was filled */
1730 static char_u pc_bytes[MB_MAXBYTES + 1]; /* saved bytes */
1731 static int  pc_attr;
1732 static int  pc_row;
1733 static int  pc_col;
1734 
1735     void
1736 edit_putchar(int c, int highlight)
1737 {
1738     int	    attr;
1739 
1740     if (ScreenLines != NULL)
1741     {
1742 	update_topline();	/* just in case w_topline isn't valid */
1743 	validate_cursor();
1744 	if (highlight)
1745 	    attr = hl_attr(HLF_8);
1746 	else
1747 	    attr = 0;
1748 	pc_row = W_WINROW(curwin) + curwin->w_wrow;
1749 	pc_col = W_WINCOL(curwin);
1750 #if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
1751 	pc_status = PC_STATUS_UNSET;
1752 #endif
1753 #ifdef FEAT_RIGHTLEFT
1754 	if (curwin->w_p_rl)
1755 	{
1756 	    pc_col += W_WIDTH(curwin) - 1 - curwin->w_wcol;
1757 # ifdef FEAT_MBYTE
1758 	    if (has_mbyte)
1759 	    {
1760 		int fix_col = mb_fix_col(pc_col, pc_row);
1761 
1762 		if (fix_col != pc_col)
1763 		{
1764 		    screen_putchar(' ', pc_row, fix_col, attr);
1765 		    --curwin->w_wcol;
1766 		    pc_status = PC_STATUS_RIGHT;
1767 		}
1768 	    }
1769 # endif
1770 	}
1771 	else
1772 #endif
1773 	{
1774 	    pc_col += curwin->w_wcol;
1775 #ifdef FEAT_MBYTE
1776 	    if (mb_lefthalve(pc_row, pc_col))
1777 		pc_status = PC_STATUS_LEFT;
1778 #endif
1779 	}
1780 
1781 	/* save the character to be able to put it back */
1782 #if defined(FEAT_RIGHTLEFT) || defined(FEAT_MBYTE)
1783 	if (pc_status == PC_STATUS_UNSET)
1784 #endif
1785 	{
1786 	    screen_getbytes(pc_row, pc_col, pc_bytes, &pc_attr);
1787 	    pc_status = PC_STATUS_SET;
1788 	}
1789 	screen_putchar(c, pc_row, pc_col, attr);
1790     }
1791 }
1792 
1793 /*
1794  * Undo the previous edit_putchar().
1795  */
1796     void
1797 edit_unputchar(void)
1798 {
1799     if (pc_status != PC_STATUS_UNSET && pc_row >= msg_scrolled)
1800     {
1801 #if defined(FEAT_MBYTE)
1802 	if (pc_status == PC_STATUS_RIGHT)
1803 	    ++curwin->w_wcol;
1804 	if (pc_status == PC_STATUS_RIGHT || pc_status == PC_STATUS_LEFT)
1805 	    redrawWinline(curwin->w_cursor.lnum, FALSE);
1806 	else
1807 #endif
1808 	    screen_puts(pc_bytes, pc_row - msg_scrolled, pc_col, pc_attr);
1809     }
1810 }
1811 
1812 /*
1813  * Called when p_dollar is set: display a '$' at the end of the changed text
1814  * Only works when cursor is in the line that changes.
1815  */
1816     void
1817 display_dollar(colnr_T col)
1818 {
1819     colnr_T save_col;
1820 
1821     if (!redrawing())
1822 	return;
1823 
1824     cursor_off();
1825     save_col = curwin->w_cursor.col;
1826     curwin->w_cursor.col = col;
1827 #ifdef FEAT_MBYTE
1828     if (has_mbyte)
1829     {
1830 	char_u *p;
1831 
1832 	/* If on the last byte of a multi-byte move to the first byte. */
1833 	p = ml_get_curline();
1834 	curwin->w_cursor.col -= (*mb_head_off)(p, p + col);
1835     }
1836 #endif
1837     curs_columns(FALSE);	    /* recompute w_wrow and w_wcol */
1838     if (curwin->w_wcol < W_WIDTH(curwin))
1839     {
1840 	edit_putchar('$', FALSE);
1841 	dollar_vcol = curwin->w_virtcol;
1842     }
1843     curwin->w_cursor.col = save_col;
1844 }
1845 
1846 /*
1847  * Call this function before moving the cursor from the normal insert position
1848  * in insert mode.
1849  */
1850     static void
1851 undisplay_dollar(void)
1852 {
1853     if (dollar_vcol >= 0)
1854     {
1855 	dollar_vcol = -1;
1856 	redrawWinline(curwin->w_cursor.lnum, FALSE);
1857     }
1858 }
1859 
1860 /*
1861  * Insert an indent (for <Tab> or CTRL-T) or delete an indent (for CTRL-D).
1862  * Keep the cursor on the same character.
1863  * type == INDENT_INC	increase indent (for CTRL-T or <Tab>)
1864  * type == INDENT_DEC	decrease indent (for CTRL-D)
1865  * type == INDENT_SET	set indent to "amount"
1866  * if round is TRUE, round the indent to 'shiftwidth' (only with _INC and _Dec).
1867  */
1868     void
1869 change_indent(
1870     int		type,
1871     int		amount,
1872     int		round,
1873     int		replaced,	/* replaced character, put on replace stack */
1874     int		call_changed_bytes)	/* call changed_bytes() */
1875 {
1876     int		vcol;
1877     int		last_vcol;
1878     int		insstart_less;		/* reduction for Insstart.col */
1879     int		new_cursor_col;
1880     int		i;
1881     char_u	*ptr;
1882     int		save_p_list;
1883     int		start_col;
1884     colnr_T	vc;
1885 #ifdef FEAT_VREPLACE
1886     colnr_T	orig_col = 0;		/* init for GCC */
1887     char_u	*new_line, *orig_line = NULL;	/* init for GCC */
1888 
1889     /* VREPLACE mode needs to know what the line was like before changing */
1890     if (State & VREPLACE_FLAG)
1891     {
1892 	orig_line = vim_strsave(ml_get_curline());  /* Deal with NULL below */
1893 	orig_col = curwin->w_cursor.col;
1894     }
1895 #endif
1896 
1897     /* for the following tricks we don't want list mode */
1898     save_p_list = curwin->w_p_list;
1899     curwin->w_p_list = FALSE;
1900     vc = getvcol_nolist(&curwin->w_cursor);
1901     vcol = vc;
1902 
1903     /*
1904      * For Replace mode we need to fix the replace stack later, which is only
1905      * possible when the cursor is in the indent.  Remember the number of
1906      * characters before the cursor if it's possible.
1907      */
1908     start_col = curwin->w_cursor.col;
1909 
1910     /* determine offset from first non-blank */
1911     new_cursor_col = curwin->w_cursor.col;
1912     beginline(BL_WHITE);
1913     new_cursor_col -= curwin->w_cursor.col;
1914 
1915     insstart_less = curwin->w_cursor.col;
1916 
1917     /*
1918      * If the cursor is in the indent, compute how many screen columns the
1919      * cursor is to the left of the first non-blank.
1920      */
1921     if (new_cursor_col < 0)
1922 	vcol = get_indent() - vcol;
1923 
1924     if (new_cursor_col > 0)	    /* can't fix replace stack */
1925 	start_col = -1;
1926 
1927     /*
1928      * Set the new indent.  The cursor will be put on the first non-blank.
1929      */
1930     if (type == INDENT_SET)
1931 	(void)set_indent(amount, call_changed_bytes ? SIN_CHANGED : 0);
1932     else
1933     {
1934 #ifdef FEAT_VREPLACE
1935 	int	save_State = State;
1936 
1937 	/* Avoid being called recursively. */
1938 	if (State & VREPLACE_FLAG)
1939 	    State = INSERT;
1940 #endif
1941 	shift_line(type == INDENT_DEC, round, 1, call_changed_bytes);
1942 #ifdef FEAT_VREPLACE
1943 	State = save_State;
1944 #endif
1945     }
1946     insstart_less -= curwin->w_cursor.col;
1947 
1948     /*
1949      * Try to put cursor on same character.
1950      * If the cursor is at or after the first non-blank in the line,
1951      * compute the cursor column relative to the column of the first
1952      * non-blank character.
1953      * If we are not in insert mode, leave the cursor on the first non-blank.
1954      * If the cursor is before the first non-blank, position it relative
1955      * to the first non-blank, counted in screen columns.
1956      */
1957     if (new_cursor_col >= 0)
1958     {
1959 	/*
1960 	 * When changing the indent while the cursor is touching it, reset
1961 	 * Insstart_col to 0.
1962 	 */
1963 	if (new_cursor_col == 0)
1964 	    insstart_less = MAXCOL;
1965 	new_cursor_col += curwin->w_cursor.col;
1966     }
1967     else if (!(State & INSERT))
1968 	new_cursor_col = curwin->w_cursor.col;
1969     else
1970     {
1971 	/*
1972 	 * Compute the screen column where the cursor should be.
1973 	 */
1974 	vcol = get_indent() - vcol;
1975 	curwin->w_virtcol = (colnr_T)((vcol < 0) ? 0 : vcol);
1976 
1977 	/*
1978 	 * Advance the cursor until we reach the right screen column.
1979 	 */
1980 	vcol = last_vcol = 0;
1981 	new_cursor_col = -1;
1982 	ptr = ml_get_curline();
1983 	while (vcol <= (int)curwin->w_virtcol)
1984 	{
1985 	    last_vcol = vcol;
1986 #ifdef FEAT_MBYTE
1987 	    if (has_mbyte && new_cursor_col >= 0)
1988 		new_cursor_col += (*mb_ptr2len)(ptr + new_cursor_col);
1989 	    else
1990 #endif
1991 		++new_cursor_col;
1992 	    vcol += lbr_chartabsize(ptr, ptr + new_cursor_col, (colnr_T)vcol);
1993 	}
1994 	vcol = last_vcol;
1995 
1996 	/*
1997 	 * May need to insert spaces to be able to position the cursor on
1998 	 * the right screen column.
1999 	 */
2000 	if (vcol != (int)curwin->w_virtcol)
2001 	{
2002 	    curwin->w_cursor.col = (colnr_T)new_cursor_col;
2003 	    i = (int)curwin->w_virtcol - vcol;
2004 	    ptr = alloc((unsigned)(i + 1));
2005 	    if (ptr != NULL)
2006 	    {
2007 		new_cursor_col += i;
2008 		ptr[i] = NUL;
2009 		while (--i >= 0)
2010 		    ptr[i] = ' ';
2011 		ins_str(ptr);
2012 		vim_free(ptr);
2013 	    }
2014 	}
2015 
2016 	/*
2017 	 * When changing the indent while the cursor is in it, reset
2018 	 * Insstart_col to 0.
2019 	 */
2020 	insstart_less = MAXCOL;
2021     }
2022 
2023     curwin->w_p_list = save_p_list;
2024 
2025     if (new_cursor_col <= 0)
2026 	curwin->w_cursor.col = 0;
2027     else
2028 	curwin->w_cursor.col = (colnr_T)new_cursor_col;
2029     curwin->w_set_curswant = TRUE;
2030     changed_cline_bef_curs();
2031 
2032     /*
2033      * May have to adjust the start of the insert.
2034      */
2035     if (State & INSERT)
2036     {
2037 	if (curwin->w_cursor.lnum == Insstart.lnum && Insstart.col != 0)
2038 	{
2039 	    if ((int)Insstart.col <= insstart_less)
2040 		Insstart.col = 0;
2041 	    else
2042 		Insstart.col -= insstart_less;
2043 	}
2044 	if ((int)ai_col <= insstart_less)
2045 	    ai_col = 0;
2046 	else
2047 	    ai_col -= insstart_less;
2048     }
2049 
2050     /*
2051      * For REPLACE mode, may have to fix the replace stack, if it's possible.
2052      * If the number of characters before the cursor decreased, need to pop a
2053      * few characters from the replace stack.
2054      * If the number of characters before the cursor increased, need to push a
2055      * few NULs onto the replace stack.
2056      */
2057     if (REPLACE_NORMAL(State) && start_col >= 0)
2058     {
2059 	while (start_col > (int)curwin->w_cursor.col)
2060 	{
2061 	    replace_join(0);	    /* remove a NUL from the replace stack */
2062 	    --start_col;
2063 	}
2064 	while (start_col < (int)curwin->w_cursor.col || replaced)
2065 	{
2066 	    replace_push(NUL);
2067 	    if (replaced)
2068 	    {
2069 		replace_push(replaced);
2070 		replaced = NUL;
2071 	    }
2072 	    ++start_col;
2073 	}
2074     }
2075 
2076 #ifdef FEAT_VREPLACE
2077     /*
2078      * For VREPLACE mode, we also have to fix the replace stack.  In this case
2079      * it is always possible because we backspace over the whole line and then
2080      * put it back again the way we wanted it.
2081      */
2082     if (State & VREPLACE_FLAG)
2083     {
2084 	/* If orig_line didn't allocate, just return.  At least we did the job,
2085 	 * even if you can't backspace. */
2086 	if (orig_line == NULL)
2087 	    return;
2088 
2089 	/* Save new line */
2090 	new_line = vim_strsave(ml_get_curline());
2091 	if (new_line == NULL)
2092 	    return;
2093 
2094 	/* We only put back the new line up to the cursor */
2095 	new_line[curwin->w_cursor.col] = NUL;
2096 
2097 	/* Put back original line */
2098 	ml_replace(curwin->w_cursor.lnum, orig_line, FALSE);
2099 	curwin->w_cursor.col = orig_col;
2100 
2101 	/* Backspace from cursor to start of line */
2102 	backspace_until_column(0);
2103 
2104 	/* Insert new stuff into line again */
2105 	ins_bytes(new_line);
2106 
2107 	vim_free(new_line);
2108     }
2109 #endif
2110 }
2111 
2112 /*
2113  * Truncate the space at the end of a line.  This is to be used only in an
2114  * insert mode.  It handles fixing the replace stack for REPLACE and VREPLACE
2115  * modes.
2116  */
2117     void
2118 truncate_spaces(char_u *line)
2119 {
2120     int	    i;
2121 
2122     /* find start of trailing white space */
2123     for (i = (int)STRLEN(line) - 1; i >= 0 && vim_iswhite(line[i]); i--)
2124     {
2125 	if (State & REPLACE_FLAG)
2126 	    replace_join(0);	    /* remove a NUL from the replace stack */
2127     }
2128     line[i + 1] = NUL;
2129 }
2130 
2131 #if defined(FEAT_VREPLACE) || defined(FEAT_INS_EXPAND) \
2132 	|| defined(FEAT_COMMENTS) || defined(PROTO)
2133 /*
2134  * Backspace the cursor until the given column.  Handles REPLACE and VREPLACE
2135  * modes correctly.  May also be used when not in insert mode at all.
2136  * Will attempt not to go before "col" even when there is a composing
2137  * character.
2138  */
2139     void
2140 backspace_until_column(int col)
2141 {
2142     while ((int)curwin->w_cursor.col > col)
2143     {
2144 	curwin->w_cursor.col--;
2145 	if (State & REPLACE_FLAG)
2146 	    replace_do_bs(col);
2147 	else if (!del_char_after_col(col))
2148 	    break;
2149     }
2150 }
2151 #endif
2152 
2153 /*
2154  * Like del_char(), but make sure not to go before column "limit_col".
2155  * Only matters when there are composing characters.
2156  * Return TRUE when something was deleted.
2157  */
2158    static int
2159 del_char_after_col(int limit_col UNUSED)
2160 {
2161 #ifdef FEAT_MBYTE
2162     if (enc_utf8 && limit_col >= 0)
2163     {
2164 	colnr_T ecol = curwin->w_cursor.col + 1;
2165 
2166 	/* Make sure the cursor is at the start of a character, but
2167 	 * skip forward again when going too far back because of a
2168 	 * composing character. */
2169 	mb_adjust_cursor();
2170 	while (curwin->w_cursor.col < (colnr_T)limit_col)
2171 	{
2172 	    int l = utf_ptr2len(ml_get_cursor());
2173 
2174 	    if (l == 0)  /* end of line */
2175 		break;
2176 	    curwin->w_cursor.col += l;
2177 	}
2178 	if (*ml_get_cursor() == NUL || curwin->w_cursor.col == ecol)
2179 	    return FALSE;
2180 	del_bytes((long)((int)ecol - curwin->w_cursor.col), FALSE, TRUE);
2181     }
2182     else
2183 #endif
2184 	(void)del_char(FALSE);
2185     return TRUE;
2186 }
2187 
2188 #if defined(FEAT_INS_EXPAND) || defined(PROTO)
2189 /*
2190  * CTRL-X pressed in Insert mode.
2191  */
2192     static void
2193 ins_ctrl_x(void)
2194 {
2195     /* CTRL-X after CTRL-X CTRL-V doesn't do anything, so that CTRL-X
2196      * CTRL-V works like CTRL-N */
2197     if (ctrl_x_mode != CTRL_X_CMDLINE)
2198     {
2199 	/* if the next ^X<> won't ADD nothing, then reset
2200 	 * compl_cont_status */
2201 	if (compl_cont_status & CONT_N_ADDS)
2202 	    compl_cont_status |= CONT_INTRPT;
2203 	else
2204 	    compl_cont_status = 0;
2205 	/* We're not sure which CTRL-X mode it will be yet */
2206 	ctrl_x_mode = CTRL_X_NOT_DEFINED_YET;
2207 	edit_submode = (char_u *)_(CTRL_X_MSG(ctrl_x_mode));
2208 	edit_submode_pre = NULL;
2209 	showmode();
2210     }
2211 }
2212 
2213 /*
2214  * Return TRUE if the 'dict' or 'tsr' option can be used.
2215  */
2216     static int
2217 has_compl_option(int dict_opt)
2218 {
2219     if (dict_opt ? (*curbuf->b_p_dict == NUL && *p_dict == NUL
2220 # ifdef FEAT_SPELL
2221 							&& !curwin->w_p_spell
2222 # endif
2223 							)
2224 		 : (*curbuf->b_p_tsr == NUL && *p_tsr == NUL))
2225     {
2226 	ctrl_x_mode = 0;
2227 	edit_submode = NULL;
2228 	msg_attr(dict_opt ? (char_u *)_("'dictionary' option is empty")
2229 			  : (char_u *)_("'thesaurus' option is empty"),
2230 							      hl_attr(HLF_E));
2231 	if (emsg_silent == 0)
2232 	{
2233 	    vim_beep(BO_COMPL);
2234 	    setcursor();
2235 	    out_flush();
2236 	    ui_delay(2000L, FALSE);
2237 	}
2238 	return FALSE;
2239     }
2240     return TRUE;
2241 }
2242 
2243 /*
2244  * Is the character 'c' a valid key to go to or keep us in CTRL-X mode?
2245  * This depends on the current mode.
2246  */
2247     int
2248 vim_is_ctrl_x_key(int c)
2249 {
2250     /* Always allow ^R - let it's results then be checked */
2251     if (c == Ctrl_R)
2252 	return TRUE;
2253 
2254     /* Accept <PageUp> and <PageDown> if the popup menu is visible. */
2255     if (ins_compl_pum_key(c))
2256 	return TRUE;
2257 
2258     switch (ctrl_x_mode)
2259     {
2260 	case 0:		    /* Not in any CTRL-X mode */
2261 	    return (c == Ctrl_N || c == Ctrl_P || c == Ctrl_X);
2262 	case CTRL_X_NOT_DEFINED_YET:
2263 	    return (   c == Ctrl_X || c == Ctrl_Y || c == Ctrl_E
2264 		    || c == Ctrl_L || c == Ctrl_F || c == Ctrl_RSB
2265 		    || c == Ctrl_I || c == Ctrl_D || c == Ctrl_P
2266 		    || c == Ctrl_N || c == Ctrl_T || c == Ctrl_V
2267 		    || c == Ctrl_Q || c == Ctrl_U || c == Ctrl_O
2268 		    || c == Ctrl_S || c == Ctrl_K || c == 's');
2269 	case CTRL_X_SCROLL:
2270 	    return (c == Ctrl_Y || c == Ctrl_E);
2271 	case CTRL_X_WHOLE_LINE:
2272 	    return (c == Ctrl_L || c == Ctrl_P || c == Ctrl_N);
2273 	case CTRL_X_FILES:
2274 	    return (c == Ctrl_F || c == Ctrl_P || c == Ctrl_N);
2275 	case CTRL_X_DICTIONARY:
2276 	    return (c == Ctrl_K || c == Ctrl_P || c == Ctrl_N);
2277 	case CTRL_X_THESAURUS:
2278 	    return (c == Ctrl_T || c == Ctrl_P || c == Ctrl_N);
2279 	case CTRL_X_TAGS:
2280 	    return (c == Ctrl_RSB || c == Ctrl_P || c == Ctrl_N);
2281 #ifdef FEAT_FIND_ID
2282 	case CTRL_X_PATH_PATTERNS:
2283 	    return (c == Ctrl_P || c == Ctrl_N);
2284 	case CTRL_X_PATH_DEFINES:
2285 	    return (c == Ctrl_D || c == Ctrl_P || c == Ctrl_N);
2286 #endif
2287 	case CTRL_X_CMDLINE:
2288 	    return (c == Ctrl_V || c == Ctrl_Q || c == Ctrl_P || c == Ctrl_N
2289 		    || c == Ctrl_X);
2290 #ifdef FEAT_COMPL_FUNC
2291 	case CTRL_X_FUNCTION:
2292 	    return (c == Ctrl_U || c == Ctrl_P || c == Ctrl_N);
2293 	case CTRL_X_OMNI:
2294 	    return (c == Ctrl_O || c == Ctrl_P || c == Ctrl_N);
2295 #endif
2296 	case CTRL_X_SPELL:
2297 	    return (c == Ctrl_S || c == Ctrl_P || c == Ctrl_N);
2298 	case CTRL_X_EVAL:
2299 	    return (c == Ctrl_P || c == Ctrl_N);
2300     }
2301     EMSG(_(e_internal));
2302     return FALSE;
2303 }
2304 
2305 /*
2306  * Return TRUE when character "c" is part of the item currently being
2307  * completed.  Used to decide whether to abandon complete mode when the menu
2308  * is visible.
2309  */
2310     static int
2311 ins_compl_accept_char(int c)
2312 {
2313     if (ctrl_x_mode & CTRL_X_WANT_IDENT)
2314 	/* When expanding an identifier only accept identifier chars. */
2315 	return vim_isIDc(c);
2316 
2317     switch (ctrl_x_mode)
2318     {
2319 	case CTRL_X_FILES:
2320 	    /* When expanding file name only accept file name chars. But not
2321 	     * path separators, so that "proto/<Tab>" expands files in
2322 	     * "proto", not "proto/" as a whole */
2323 	    return vim_isfilec(c) && !vim_ispathsep(c);
2324 
2325 	case CTRL_X_CMDLINE:
2326 	case CTRL_X_OMNI:
2327 	    /* Command line and Omni completion can work with just about any
2328 	     * printable character, but do stop at white space. */
2329 	    return vim_isprintc(c) && !vim_iswhite(c);
2330 
2331 	case CTRL_X_WHOLE_LINE:
2332 	    /* For while line completion a space can be part of the line. */
2333 	    return vim_isprintc(c);
2334     }
2335     return vim_iswordc(c);
2336 }
2337 
2338 /*
2339  * This is like ins_compl_add(), but if 'ic' and 'inf' are set, then the
2340  * case of the originally typed text is used, and the case of the completed
2341  * text is inferred, ie this tries to work out what case you probably wanted
2342  * the rest of the word to be in -- webb
2343  */
2344     int
2345 ins_compl_add_infercase(
2346     char_u	*str,
2347     int		len,
2348     int		icase,
2349     char_u	*fname,
2350     int		dir,
2351     int		flags)
2352 {
2353     char_u	*p;
2354     int		i, c;
2355     int		actual_len;		/* Take multi-byte characters */
2356     int		actual_compl_length;	/* into account. */
2357     int		min_len;
2358     int		*wca;			/* Wide character array. */
2359     int		has_lower = FALSE;
2360     int		was_letter = FALSE;
2361 
2362     if (p_ic && curbuf->b_p_inf && len > 0)
2363     {
2364 	/* Infer case of completed part. */
2365 
2366 	/* Find actual length of completion. */
2367 #ifdef FEAT_MBYTE
2368 	if (has_mbyte)
2369 	{
2370 	    p = str;
2371 	    actual_len = 0;
2372 	    while (*p != NUL)
2373 	    {
2374 		mb_ptr_adv(p);
2375 		++actual_len;
2376 	    }
2377 	}
2378 	else
2379 #endif
2380 	    actual_len = len;
2381 
2382 	/* Find actual length of original text. */
2383 #ifdef FEAT_MBYTE
2384 	if (has_mbyte)
2385 	{
2386 	    p = compl_orig_text;
2387 	    actual_compl_length = 0;
2388 	    while (*p != NUL)
2389 	    {
2390 		mb_ptr_adv(p);
2391 		++actual_compl_length;
2392 	    }
2393 	}
2394 	else
2395 #endif
2396 	    actual_compl_length = compl_length;
2397 
2398 	/* "actual_len" may be smaller than "actual_compl_length" when using
2399 	 * thesaurus, only use the minimum when comparing. */
2400 	min_len = actual_len < actual_compl_length
2401 					   ? actual_len : actual_compl_length;
2402 
2403 	/* Allocate wide character array for the completion and fill it. */
2404 	wca = (int *)alloc((unsigned)(actual_len * sizeof(int)));
2405 	if (wca != NULL)
2406 	{
2407 	    p = str;
2408 	    for (i = 0; i < actual_len; ++i)
2409 #ifdef FEAT_MBYTE
2410 		if (has_mbyte)
2411 		    wca[i] = mb_ptr2char_adv(&p);
2412 		else
2413 #endif
2414 		    wca[i] = *(p++);
2415 
2416 	    /* Rule 1: Were any chars converted to lower? */
2417 	    p = compl_orig_text;
2418 	    for (i = 0; i < min_len; ++i)
2419 	    {
2420 #ifdef FEAT_MBYTE
2421 		if (has_mbyte)
2422 		    c = mb_ptr2char_adv(&p);
2423 		else
2424 #endif
2425 		    c = *(p++);
2426 		if (MB_ISLOWER(c))
2427 		{
2428 		    has_lower = TRUE;
2429 		    if (MB_ISUPPER(wca[i]))
2430 		    {
2431 			/* Rule 1 is satisfied. */
2432 			for (i = actual_compl_length; i < actual_len; ++i)
2433 			    wca[i] = MB_TOLOWER(wca[i]);
2434 			break;
2435 		    }
2436 		}
2437 	    }
2438 
2439 	    /*
2440 	     * Rule 2: No lower case, 2nd consecutive letter converted to
2441 	     * upper case.
2442 	     */
2443 	    if (!has_lower)
2444 	    {
2445 		p = compl_orig_text;
2446 		for (i = 0; i < min_len; ++i)
2447 		{
2448 #ifdef FEAT_MBYTE
2449 		    if (has_mbyte)
2450 			c = mb_ptr2char_adv(&p);
2451 		    else
2452 #endif
2453 			c = *(p++);
2454 		    if (was_letter && MB_ISUPPER(c) && MB_ISLOWER(wca[i]))
2455 		    {
2456 			/* Rule 2 is satisfied. */
2457 			for (i = actual_compl_length; i < actual_len; ++i)
2458 			    wca[i] = MB_TOUPPER(wca[i]);
2459 			break;
2460 		    }
2461 		    was_letter = MB_ISLOWER(c) || MB_ISUPPER(c);
2462 		}
2463 	    }
2464 
2465 	    /* Copy the original case of the part we typed. */
2466 	    p = compl_orig_text;
2467 	    for (i = 0; i < min_len; ++i)
2468 	    {
2469 #ifdef FEAT_MBYTE
2470 		if (has_mbyte)
2471 		    c = mb_ptr2char_adv(&p);
2472 		else
2473 #endif
2474 		    c = *(p++);
2475 		if (MB_ISLOWER(c))
2476 		    wca[i] = MB_TOLOWER(wca[i]);
2477 		else if (MB_ISUPPER(c))
2478 		    wca[i] = MB_TOUPPER(wca[i]);
2479 	    }
2480 
2481 	    /*
2482 	     * Generate encoding specific output from wide character array.
2483 	     * Multi-byte characters can occupy up to five bytes more than
2484 	     * ASCII characters, and we also need one byte for NUL, so stay
2485 	     * six bytes away from the edge of IObuff.
2486 	     */
2487 	    p = IObuff;
2488 	    i = 0;
2489 	    while (i < actual_len && (p - IObuff + 6) < IOSIZE)
2490 #ifdef FEAT_MBYTE
2491 		if (has_mbyte)
2492 		    p += (*mb_char2bytes)(wca[i++], p);
2493 		else
2494 #endif
2495 		    *(p++) = wca[i++];
2496 	    *p = NUL;
2497 
2498 	    vim_free(wca);
2499 	}
2500 
2501 	return ins_compl_add(IObuff, len, icase, fname, NULL, dir,
2502 								flags, FALSE);
2503     }
2504     return ins_compl_add(str, len, icase, fname, NULL, dir, flags, FALSE);
2505 }
2506 
2507 /*
2508  * Add a match to the list of matches.
2509  * If the given string is already in the list of completions, then return
2510  * NOTDONE, otherwise add it to the list and return OK.  If there is an error,
2511  * maybe because alloc() returns NULL, then FAIL is returned.
2512  */
2513     static int
2514 ins_compl_add(
2515     char_u	*str,
2516     int		len,
2517     int		icase,
2518     char_u	*fname,
2519     char_u	**cptext,   /* extra text for popup menu or NULL */
2520     int		cdir,
2521     int		flags,
2522     int		adup)	    /* accept duplicate match */
2523 {
2524     compl_T	*match;
2525     int		dir = (cdir == 0 ? compl_direction : cdir);
2526 
2527     ui_breakcheck();
2528     if (got_int)
2529 	return FAIL;
2530     if (len < 0)
2531 	len = (int)STRLEN(str);
2532 
2533     /*
2534      * If the same match is already present, don't add it.
2535      */
2536     if (compl_first_match != NULL && !adup)
2537     {
2538 	match = compl_first_match;
2539 	do
2540 	{
2541 	    if (    !(match->cp_flags & ORIGINAL_TEXT)
2542 		    && STRNCMP(match->cp_str, str, len) == 0
2543 		    && match->cp_str[len] == NUL)
2544 		return NOTDONE;
2545 	    match = match->cp_next;
2546 	} while (match != NULL && match != compl_first_match);
2547     }
2548 
2549     /* Remove any popup menu before changing the list of matches. */
2550     ins_compl_del_pum();
2551 
2552     /*
2553      * Allocate a new match structure.
2554      * Copy the values to the new match structure.
2555      */
2556     match = (compl_T *)alloc_clear((unsigned)sizeof(compl_T));
2557     if (match == NULL)
2558 	return FAIL;
2559     match->cp_number = -1;
2560     if (flags & ORIGINAL_TEXT)
2561 	match->cp_number = 0;
2562     if ((match->cp_str = vim_strnsave(str, len)) == NULL)
2563     {
2564 	vim_free(match);
2565 	return FAIL;
2566     }
2567     match->cp_icase = icase;
2568 
2569     /* match-fname is:
2570      * - compl_curr_match->cp_fname if it is a string equal to fname.
2571      * - a copy of fname, FREE_FNAME is set to free later THE allocated mem.
2572      * - NULL otherwise.	--Acevedo */
2573     if (fname != NULL
2574 	    && compl_curr_match != NULL
2575 	    && compl_curr_match->cp_fname != NULL
2576 	    && STRCMP(fname, compl_curr_match->cp_fname) == 0)
2577 	match->cp_fname = compl_curr_match->cp_fname;
2578     else if (fname != NULL)
2579     {
2580 	match->cp_fname = vim_strsave(fname);
2581 	flags |= FREE_FNAME;
2582     }
2583     else
2584 	match->cp_fname = NULL;
2585     match->cp_flags = flags;
2586 
2587     if (cptext != NULL)
2588     {
2589 	int i;
2590 
2591 	for (i = 0; i < CPT_COUNT; ++i)
2592 	    if (cptext[i] != NULL && *cptext[i] != NUL)
2593 		match->cp_text[i] = vim_strsave(cptext[i]);
2594     }
2595 
2596     /*
2597      * Link the new match structure in the list of matches.
2598      */
2599     if (compl_first_match == NULL)
2600 	match->cp_next = match->cp_prev = NULL;
2601     else if (dir == FORWARD)
2602     {
2603 	match->cp_next = compl_curr_match->cp_next;
2604 	match->cp_prev = compl_curr_match;
2605     }
2606     else	/* BACKWARD */
2607     {
2608 	match->cp_next = compl_curr_match;
2609 	match->cp_prev = compl_curr_match->cp_prev;
2610     }
2611     if (match->cp_next)
2612 	match->cp_next->cp_prev = match;
2613     if (match->cp_prev)
2614 	match->cp_prev->cp_next = match;
2615     else	/* if there's nothing before, it is the first match */
2616 	compl_first_match = match;
2617     compl_curr_match = match;
2618 
2619     /*
2620      * Find the longest common string if still doing that.
2621      */
2622     if (compl_get_longest && (flags & ORIGINAL_TEXT) == 0)
2623 	ins_compl_longest_match(match);
2624 
2625     return OK;
2626 }
2627 
2628 /*
2629  * Return TRUE if "str[len]" matches with match->cp_str, considering
2630  * match->cp_icase.
2631  */
2632     static int
2633 ins_compl_equal(compl_T *match, char_u *str, int len)
2634 {
2635     if (match->cp_icase)
2636 	return STRNICMP(match->cp_str, str, (size_t)len) == 0;
2637     return STRNCMP(match->cp_str, str, (size_t)len) == 0;
2638 }
2639 
2640 /*
2641  * Reduce the longest common string for match "match".
2642  */
2643     static void
2644 ins_compl_longest_match(compl_T *match)
2645 {
2646     char_u	*p, *s;
2647     int		c1, c2;
2648     int		had_match;
2649 
2650     if (compl_leader == NULL)
2651     {
2652 	/* First match, use it as a whole. */
2653 	compl_leader = vim_strsave(match->cp_str);
2654 	if (compl_leader != NULL)
2655 	{
2656 	    had_match = (curwin->w_cursor.col > compl_col);
2657 	    ins_compl_delete();
2658 	    ins_bytes(compl_leader + ins_compl_len());
2659 	    ins_redraw(FALSE);
2660 
2661 	    /* When the match isn't there (to avoid matching itself) remove it
2662 	     * again after redrawing. */
2663 	    if (!had_match)
2664 		ins_compl_delete();
2665 	    compl_used_match = FALSE;
2666 	}
2667     }
2668     else
2669     {
2670 	/* Reduce the text if this match differs from compl_leader. */
2671 	p = compl_leader;
2672 	s = match->cp_str;
2673 	while (*p != NUL)
2674 	{
2675 #ifdef FEAT_MBYTE
2676 	    if (has_mbyte)
2677 	    {
2678 		c1 = mb_ptr2char(p);
2679 		c2 = mb_ptr2char(s);
2680 	    }
2681 	    else
2682 #endif
2683 	    {
2684 		c1 = *p;
2685 		c2 = *s;
2686 	    }
2687 	    if (match->cp_icase ? (MB_TOLOWER(c1) != MB_TOLOWER(c2))
2688 								 : (c1 != c2))
2689 		break;
2690 #ifdef FEAT_MBYTE
2691 	    if (has_mbyte)
2692 	    {
2693 		mb_ptr_adv(p);
2694 		mb_ptr_adv(s);
2695 	    }
2696 	    else
2697 #endif
2698 	    {
2699 		++p;
2700 		++s;
2701 	    }
2702 	}
2703 
2704 	if (*p != NUL)
2705 	{
2706 	    /* Leader was shortened, need to change the inserted text. */
2707 	    *p = NUL;
2708 	    had_match = (curwin->w_cursor.col > compl_col);
2709 	    ins_compl_delete();
2710 	    ins_bytes(compl_leader + ins_compl_len());
2711 	    ins_redraw(FALSE);
2712 
2713 	    /* When the match isn't there (to avoid matching itself) remove it
2714 	     * again after redrawing. */
2715 	    if (!had_match)
2716 		ins_compl_delete();
2717 	}
2718 
2719 	compl_used_match = FALSE;
2720     }
2721 }
2722 
2723 /*
2724  * Add an array of matches to the list of matches.
2725  * Frees matches[].
2726  */
2727     static void
2728 ins_compl_add_matches(
2729     int		num_matches,
2730     char_u	**matches,
2731     int		icase)
2732 {
2733     int		i;
2734     int		add_r = OK;
2735     int		dir = compl_direction;
2736 
2737     for (i = 0; i < num_matches && add_r != FAIL; i++)
2738 	if ((add_r = ins_compl_add(matches[i], -1, icase,
2739 					    NULL, NULL, dir, 0, FALSE)) == OK)
2740 	    /* if dir was BACKWARD then honor it just once */
2741 	    dir = FORWARD;
2742     FreeWild(num_matches, matches);
2743 }
2744 
2745 /* Make the completion list cyclic.
2746  * Return the number of matches (excluding the original).
2747  */
2748     static int
2749 ins_compl_make_cyclic(void)
2750 {
2751     compl_T *match;
2752     int	    count = 0;
2753 
2754     if (compl_first_match != NULL)
2755     {
2756 	/*
2757 	 * Find the end of the list.
2758 	 */
2759 	match = compl_first_match;
2760 	/* there's always an entry for the compl_orig_text, it doesn't count. */
2761 	while (match->cp_next != NULL && match->cp_next != compl_first_match)
2762 	{
2763 	    match = match->cp_next;
2764 	    ++count;
2765 	}
2766 	match->cp_next = compl_first_match;
2767 	compl_first_match->cp_prev = match;
2768     }
2769     return count;
2770 }
2771 
2772 /*
2773  * Set variables that store noselect and noinsert behavior from the
2774  * 'completeopt' value.
2775  */
2776     void
2777 completeopt_was_set(void)
2778 {
2779     compl_no_insert = FALSE;
2780     compl_no_select = FALSE;
2781     if (strstr((char *)p_cot, "noselect") != NULL)
2782 	compl_no_select = TRUE;
2783     if (strstr((char *)p_cot, "noinsert") != NULL)
2784 	compl_no_insert = TRUE;
2785 }
2786 
2787 /*
2788  * Start completion for the complete() function.
2789  * "startcol" is where the matched text starts (1 is first column).
2790  * "list" is the list of matches.
2791  */
2792     void
2793 set_completion(colnr_T startcol, list_T *list)
2794 {
2795     int save_w_wrow = curwin->w_wrow;
2796 
2797     /* If already doing completions stop it. */
2798     if (ctrl_x_mode != 0)
2799 	ins_compl_prep(' ');
2800     ins_compl_clear();
2801 
2802     if (stop_arrow() == FAIL)
2803 	return;
2804 
2805     compl_direction = FORWARD;
2806     if (startcol > curwin->w_cursor.col)
2807 	startcol = curwin->w_cursor.col;
2808     compl_col = startcol;
2809     compl_length = (int)curwin->w_cursor.col - (int)startcol;
2810     /* compl_pattern doesn't need to be set */
2811     compl_orig_text = vim_strnsave(ml_get_curline() + compl_col, compl_length);
2812     if (compl_orig_text == NULL || ins_compl_add(compl_orig_text,
2813 			-1, p_ic, NULL, NULL, 0, ORIGINAL_TEXT, FALSE) != OK)
2814 	return;
2815 
2816     ctrl_x_mode = CTRL_X_EVAL;
2817 
2818     ins_compl_add_list(list);
2819     compl_matches = ins_compl_make_cyclic();
2820     compl_started = TRUE;
2821     compl_used_match = TRUE;
2822     compl_cont_status = 0;
2823 
2824     compl_curr_match = compl_first_match;
2825     if (compl_no_insert || compl_no_select)
2826     {
2827 	ins_complete(K_DOWN, FALSE);
2828 	if (compl_no_select)
2829 	    /* Down/Up has no real effect. */
2830 	    ins_complete(K_UP, FALSE);
2831     }
2832     else
2833 	ins_complete(Ctrl_N, FALSE);
2834     compl_enter_selects = compl_no_insert;
2835 
2836     /* Lazily show the popup menu, unless we got interrupted. */
2837     if (!compl_interrupted)
2838 	show_pum(save_w_wrow);
2839     out_flush();
2840 }
2841 
2842 
2843 /* "compl_match_array" points the currently displayed list of entries in the
2844  * popup menu.  It is NULL when there is no popup menu. */
2845 static pumitem_T *compl_match_array = NULL;
2846 static int compl_match_arraysize;
2847 
2848 /*
2849  * Update the screen and when there is any scrolling remove the popup menu.
2850  */
2851     static void
2852 ins_compl_upd_pum(void)
2853 {
2854     int		h;
2855 
2856     if (compl_match_array != NULL)
2857     {
2858 	h = curwin->w_cline_height;
2859 	update_screen(0);
2860 	if (h != curwin->w_cline_height)
2861 	    ins_compl_del_pum();
2862     }
2863 }
2864 
2865 /*
2866  * Remove any popup menu.
2867  */
2868     static void
2869 ins_compl_del_pum(void)
2870 {
2871     if (compl_match_array != NULL)
2872     {
2873 	pum_undisplay();
2874 	vim_free(compl_match_array);
2875 	compl_match_array = NULL;
2876     }
2877 }
2878 
2879 /*
2880  * Return TRUE if the popup menu should be displayed.
2881  */
2882     static int
2883 pum_wanted(void)
2884 {
2885     /* 'completeopt' must contain "menu" or "menuone" */
2886     if (vim_strchr(p_cot, 'm') == NULL)
2887 	return FALSE;
2888 
2889     /* The display looks bad on a B&W display. */
2890     if (t_colors < 8
2891 #ifdef FEAT_GUI
2892 	    && !gui.in_use
2893 #endif
2894 	    )
2895 	return FALSE;
2896     return TRUE;
2897 }
2898 
2899 /*
2900  * Return TRUE if there are two or more matches to be shown in the popup menu.
2901  * One if 'completopt' contains "menuone".
2902  */
2903     static int
2904 pum_enough_matches(void)
2905 {
2906     compl_T     *compl;
2907     int		i;
2908 
2909     /* Don't display the popup menu if there are no matches or there is only
2910      * one (ignoring the original text). */
2911     compl = compl_first_match;
2912     i = 0;
2913     do
2914     {
2915 	if (compl == NULL
2916 		      || ((compl->cp_flags & ORIGINAL_TEXT) == 0 && ++i == 2))
2917 	    break;
2918 	compl = compl->cp_next;
2919     } while (compl != compl_first_match);
2920 
2921     if (strstr((char *)p_cot, "menuone") != NULL)
2922 	return (i >= 1);
2923     return (i >= 2);
2924 }
2925 
2926 /*
2927  * Show the popup menu for the list of matches.
2928  * Also adjusts "compl_shown_match" to an entry that is actually displayed.
2929  */
2930     void
2931 ins_compl_show_pum(void)
2932 {
2933     compl_T     *compl;
2934     compl_T     *shown_compl = NULL;
2935     int		did_find_shown_match = FALSE;
2936     int		shown_match_ok = FALSE;
2937     int		i;
2938     int		cur = -1;
2939     colnr_T	col;
2940     int		lead_len = 0;
2941 
2942     if (!pum_wanted() || !pum_enough_matches())
2943 	return;
2944 
2945 #if defined(FEAT_EVAL)
2946     /* Dirty hard-coded hack: remove any matchparen highlighting. */
2947     do_cmdline_cmd((char_u *)"if exists('g:loaded_matchparen')|3match none|endif");
2948 #endif
2949 
2950     /* Update the screen before drawing the popup menu over it. */
2951     update_screen(0);
2952 
2953     if (compl_match_array == NULL)
2954     {
2955 	/* Need to build the popup menu list. */
2956 	compl_match_arraysize = 0;
2957 	compl = compl_first_match;
2958 	if (compl_leader != NULL)
2959 	    lead_len = (int)STRLEN(compl_leader);
2960 	do
2961 	{
2962 	    if ((compl->cp_flags & ORIGINAL_TEXT) == 0
2963 		    && (compl_leader == NULL
2964 			|| ins_compl_equal(compl, compl_leader, lead_len)))
2965 		++compl_match_arraysize;
2966 	    compl = compl->cp_next;
2967 	} while (compl != NULL && compl != compl_first_match);
2968 	if (compl_match_arraysize == 0)
2969 	    return;
2970 	compl_match_array = (pumitem_T *)alloc_clear(
2971 				    (unsigned)(sizeof(pumitem_T)
2972 						    * compl_match_arraysize));
2973 	if (compl_match_array != NULL)
2974 	{
2975 	    /* If the current match is the original text don't find the first
2976 	     * match after it, don't highlight anything. */
2977 	    if (compl_shown_match->cp_flags & ORIGINAL_TEXT)
2978 		shown_match_ok = TRUE;
2979 
2980 	    i = 0;
2981 	    compl = compl_first_match;
2982 	    do
2983 	    {
2984 		if ((compl->cp_flags & ORIGINAL_TEXT) == 0
2985 			&& (compl_leader == NULL
2986 			    || ins_compl_equal(compl, compl_leader, lead_len)))
2987 		{
2988 		    if (!shown_match_ok)
2989 		    {
2990 			if (compl == compl_shown_match || did_find_shown_match)
2991 			{
2992 			    /* This item is the shown match or this is the
2993 			     * first displayed item after the shown match. */
2994 			    compl_shown_match = compl;
2995 			    did_find_shown_match = TRUE;
2996 			    shown_match_ok = TRUE;
2997 			}
2998 			else
2999 			    /* Remember this displayed match for when the
3000 			     * shown match is just below it. */
3001 			    shown_compl = compl;
3002 			cur = i;
3003 		    }
3004 
3005 		    if (compl->cp_text[CPT_ABBR] != NULL)
3006 			compl_match_array[i].pum_text =
3007 						     compl->cp_text[CPT_ABBR];
3008 		    else
3009 			compl_match_array[i].pum_text = compl->cp_str;
3010 		    compl_match_array[i].pum_kind = compl->cp_text[CPT_KIND];
3011 		    compl_match_array[i].pum_info = compl->cp_text[CPT_INFO];
3012 		    if (compl->cp_text[CPT_MENU] != NULL)
3013 			compl_match_array[i++].pum_extra =
3014 						     compl->cp_text[CPT_MENU];
3015 		    else
3016 			compl_match_array[i++].pum_extra = compl->cp_fname;
3017 		}
3018 
3019 		if (compl == compl_shown_match)
3020 		{
3021 		    did_find_shown_match = TRUE;
3022 
3023 		    /* When the original text is the shown match don't set
3024 		     * compl_shown_match. */
3025 		    if (compl->cp_flags & ORIGINAL_TEXT)
3026 			shown_match_ok = TRUE;
3027 
3028 		    if (!shown_match_ok && shown_compl != NULL)
3029 		    {
3030 			/* The shown match isn't displayed, set it to the
3031 			 * previously displayed match. */
3032 			compl_shown_match = shown_compl;
3033 			shown_match_ok = TRUE;
3034 		    }
3035 		}
3036 		compl = compl->cp_next;
3037 	    } while (compl != NULL && compl != compl_first_match);
3038 
3039 	    if (!shown_match_ok)    /* no displayed match at all */
3040 		cur = -1;
3041 	}
3042     }
3043     else
3044     {
3045 	/* popup menu already exists, only need to find the current item.*/
3046 	for (i = 0; i < compl_match_arraysize; ++i)
3047 	    if (compl_match_array[i].pum_text == compl_shown_match->cp_str
3048 		    || compl_match_array[i].pum_text
3049 				      == compl_shown_match->cp_text[CPT_ABBR])
3050 	    {
3051 		cur = i;
3052 		break;
3053 	    }
3054     }
3055 
3056     if (compl_match_array != NULL)
3057     {
3058 	/* In Replace mode when a $ is displayed at the end of the line only
3059 	 * part of the screen would be updated.  We do need to redraw here. */
3060 	dollar_vcol = -1;
3061 
3062 	/* Compute the screen column of the start of the completed text.
3063 	 * Use the cursor to get all wrapping and other settings right. */
3064 	col = curwin->w_cursor.col;
3065 	curwin->w_cursor.col = compl_col;
3066 	pum_display(compl_match_array, compl_match_arraysize, cur);
3067 	curwin->w_cursor.col = col;
3068     }
3069 }
3070 
3071 #define DICT_FIRST	(1)	/* use just first element in "dict" */
3072 #define DICT_EXACT	(2)	/* "dict" is the exact name of a file */
3073 
3074 /*
3075  * Add any identifiers that match the given pattern in the list of dictionary
3076  * files "dict_start" to the list of completions.
3077  */
3078     static void
3079 ins_compl_dictionaries(
3080     char_u	*dict_start,
3081     char_u	*pat,
3082     int		flags,		/* DICT_FIRST and/or DICT_EXACT */
3083     int		thesaurus)	/* Thesaurus completion */
3084 {
3085     char_u	*dict = dict_start;
3086     char_u	*ptr;
3087     char_u	*buf;
3088     regmatch_T	regmatch;
3089     char_u	**files;
3090     int		count;
3091     int		save_p_scs;
3092     int		dir = compl_direction;
3093 
3094     if (*dict == NUL)
3095     {
3096 #ifdef FEAT_SPELL
3097 	/* When 'dictionary' is empty and spell checking is enabled use
3098 	 * "spell". */
3099 	if (!thesaurus && curwin->w_p_spell)
3100 	    dict = (char_u *)"spell";
3101 	else
3102 #endif
3103 	    return;
3104     }
3105 
3106     buf = alloc(LSIZE);
3107     if (buf == NULL)
3108 	return;
3109     regmatch.regprog = NULL;	/* so that we can goto theend */
3110 
3111     /* If 'infercase' is set, don't use 'smartcase' here */
3112     save_p_scs = p_scs;
3113     if (curbuf->b_p_inf)
3114 	p_scs = FALSE;
3115 
3116     /* When invoked to match whole lines for CTRL-X CTRL-L adjust the pattern
3117      * to only match at the start of a line.  Otherwise just match the
3118      * pattern. Also need to double backslashes. */
3119     if (CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
3120     {
3121 	char_u *pat_esc = vim_strsave_escaped(pat, (char_u *)"\\");
3122 	size_t len;
3123 
3124 	if (pat_esc == NULL)
3125 	    goto theend;
3126 	len = STRLEN(pat_esc) + 10;
3127 	ptr = alloc((unsigned)len);
3128 	if (ptr == NULL)
3129 	{
3130 	    vim_free(pat_esc);
3131 	    goto theend;
3132 	}
3133 	vim_snprintf((char *)ptr, len, "^\\s*\\zs\\V%s", pat_esc);
3134 	regmatch.regprog = vim_regcomp(ptr, RE_MAGIC);
3135 	vim_free(pat_esc);
3136 	vim_free(ptr);
3137     }
3138     else
3139     {
3140 	regmatch.regprog = vim_regcomp(pat, p_magic ? RE_MAGIC : 0);
3141 	if (regmatch.regprog == NULL)
3142 	    goto theend;
3143     }
3144 
3145     /* ignore case depends on 'ignorecase', 'smartcase' and "pat" */
3146     regmatch.rm_ic = ignorecase(pat);
3147     while (*dict != NUL && !got_int && !compl_interrupted)
3148     {
3149 	/* copy one dictionary file name into buf */
3150 	if (flags == DICT_EXACT)
3151 	{
3152 	    count = 1;
3153 	    files = &dict;
3154 	}
3155 	else
3156 	{
3157 	    /* Expand wildcards in the dictionary name, but do not allow
3158 	     * backticks (for security, the 'dict' option may have been set in
3159 	     * a modeline). */
3160 	    copy_option_part(&dict, buf, LSIZE, ",");
3161 # ifdef FEAT_SPELL
3162 	    if (!thesaurus && STRCMP(buf, "spell") == 0)
3163 		count = -1;
3164 	    else
3165 # endif
3166 		if (vim_strchr(buf, '`') != NULL
3167 		    || expand_wildcards(1, &buf, &count, &files,
3168 						     EW_FILE|EW_SILENT) != OK)
3169 		count = 0;
3170 	}
3171 
3172 # ifdef FEAT_SPELL
3173 	if (count == -1)
3174 	{
3175 	    /* Complete from active spelling.  Skip "\<" in the pattern, we
3176 	     * don't use it as a RE. */
3177 	    if (pat[0] == '\\' && pat[1] == '<')
3178 		ptr = pat + 2;
3179 	    else
3180 		ptr = pat;
3181 	    spell_dump_compl(ptr, regmatch.rm_ic, &dir, 0);
3182 	}
3183 	else
3184 # endif
3185 	    if (count > 0)	/* avoid warning for using "files" uninit */
3186 	{
3187 	    ins_compl_files(count, files, thesaurus, flags,
3188 							&regmatch, buf, &dir);
3189 	    if (flags != DICT_EXACT)
3190 		FreeWild(count, files);
3191 	}
3192 	if (flags != 0)
3193 	    break;
3194     }
3195 
3196 theend:
3197     p_scs = save_p_scs;
3198     vim_regfree(regmatch.regprog);
3199     vim_free(buf);
3200 }
3201 
3202     static void
3203 ins_compl_files(
3204     int		count,
3205     char_u	**files,
3206     int		thesaurus,
3207     int		flags,
3208     regmatch_T	*regmatch,
3209     char_u	*buf,
3210     int		*dir)
3211 {
3212     char_u	*ptr;
3213     int		i;
3214     FILE	*fp;
3215     int		add_r;
3216 
3217     for (i = 0; i < count && !got_int && !compl_interrupted; i++)
3218     {
3219 	fp = mch_fopen((char *)files[i], "r");  /* open dictionary file */
3220 	if (flags != DICT_EXACT)
3221 	{
3222 	    vim_snprintf((char *)IObuff, IOSIZE,
3223 			      _("Scanning dictionary: %s"), (char *)files[i]);
3224 	    (void)msg_trunc_attr(IObuff, TRUE, hl_attr(HLF_R));
3225 	}
3226 
3227 	if (fp != NULL)
3228 	{
3229 	    /*
3230 	     * Read dictionary file line by line.
3231 	     * Check each line for a match.
3232 	     */
3233 	    while (!got_int && !compl_interrupted
3234 					    && !vim_fgets(buf, LSIZE, fp))
3235 	    {
3236 		ptr = buf;
3237 		while (vim_regexec(regmatch, buf, (colnr_T)(ptr - buf)))
3238 		{
3239 		    ptr = regmatch->startp[0];
3240 		    if (CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
3241 			ptr = find_line_end(ptr);
3242 		    else
3243 			ptr = find_word_end(ptr);
3244 		    add_r = ins_compl_add_infercase(regmatch->startp[0],
3245 					  (int)(ptr - regmatch->startp[0]),
3246 						     p_ic, files[i], *dir, 0);
3247 		    if (thesaurus)
3248 		    {
3249 			char_u *wstart;
3250 
3251 			/*
3252 			 * Add the other matches on the line
3253 			 */
3254 			ptr = buf;
3255 			while (!got_int)
3256 			{
3257 			    /* Find start of the next word.  Skip white
3258 			     * space and punctuation. */
3259 			    ptr = find_word_start(ptr);
3260 			    if (*ptr == NUL || *ptr == NL)
3261 				break;
3262 			    wstart = ptr;
3263 
3264 			    /* Find end of the word. */
3265 #ifdef FEAT_MBYTE
3266 			    if (has_mbyte)
3267 				/* Japanese words may have characters in
3268 				 * different classes, only separate words
3269 				 * with single-byte non-word characters. */
3270 				while (*ptr != NUL)
3271 				{
3272 				    int l = (*mb_ptr2len)(ptr);
3273 
3274 				    if (l < 2 && !vim_iswordc(*ptr))
3275 					break;
3276 				    ptr += l;
3277 				}
3278 			    else
3279 #endif
3280 				ptr = find_word_end(ptr);
3281 
3282 			    /* Add the word. Skip the regexp match. */
3283 			    if (wstart != regmatch->startp[0])
3284 				add_r = ins_compl_add_infercase(wstart,
3285 					(int)(ptr - wstart),
3286 					p_ic, files[i], *dir, 0);
3287 			}
3288 		    }
3289 		    if (add_r == OK)
3290 			/* if dir was BACKWARD then honor it just once */
3291 			*dir = FORWARD;
3292 		    else if (add_r == FAIL)
3293 			break;
3294 		    /* avoid expensive call to vim_regexec() when at end
3295 		     * of line */
3296 		    if (*ptr == '\n' || got_int)
3297 			break;
3298 		}
3299 		line_breakcheck();
3300 		ins_compl_check_keys(50);
3301 	    }
3302 	    fclose(fp);
3303 	}
3304     }
3305 }
3306 
3307 /*
3308  * Find the start of the next word.
3309  * Returns a pointer to the first char of the word.  Also stops at a NUL.
3310  */
3311     char_u *
3312 find_word_start(char_u *ptr)
3313 {
3314 #ifdef FEAT_MBYTE
3315     if (has_mbyte)
3316 	while (*ptr != NUL && *ptr != '\n' && mb_get_class(ptr) <= 1)
3317 	    ptr += (*mb_ptr2len)(ptr);
3318     else
3319 #endif
3320 	while (*ptr != NUL && *ptr != '\n' && !vim_iswordc(*ptr))
3321 	    ++ptr;
3322     return ptr;
3323 }
3324 
3325 /*
3326  * Find the end of the word.  Assumes it starts inside a word.
3327  * Returns a pointer to just after the word.
3328  */
3329     char_u *
3330 find_word_end(char_u *ptr)
3331 {
3332 #ifdef FEAT_MBYTE
3333     int		start_class;
3334 
3335     if (has_mbyte)
3336     {
3337 	start_class = mb_get_class(ptr);
3338 	if (start_class > 1)
3339 	    while (*ptr != NUL)
3340 	    {
3341 		ptr += (*mb_ptr2len)(ptr);
3342 		if (mb_get_class(ptr) != start_class)
3343 		    break;
3344 	    }
3345     }
3346     else
3347 #endif
3348 	while (vim_iswordc(*ptr))
3349 	    ++ptr;
3350     return ptr;
3351 }
3352 
3353 /*
3354  * Find the end of the line, omitting CR and NL at the end.
3355  * Returns a pointer to just after the line.
3356  */
3357     static char_u *
3358 find_line_end(char_u *ptr)
3359 {
3360     char_u	*s;
3361 
3362     s = ptr + STRLEN(ptr);
3363     while (s > ptr && (s[-1] == CAR || s[-1] == NL))
3364 	--s;
3365     return s;
3366 }
3367 
3368 /*
3369  * Free the list of completions
3370  */
3371     static void
3372 ins_compl_free(void)
3373 {
3374     compl_T *match;
3375     int	    i;
3376 
3377     vim_free(compl_pattern);
3378     compl_pattern = NULL;
3379     vim_free(compl_leader);
3380     compl_leader = NULL;
3381 
3382     if (compl_first_match == NULL)
3383 	return;
3384 
3385     ins_compl_del_pum();
3386     pum_clear();
3387 
3388     compl_curr_match = compl_first_match;
3389     do
3390     {
3391 	match = compl_curr_match;
3392 	compl_curr_match = compl_curr_match->cp_next;
3393 	vim_free(match->cp_str);
3394 	/* several entries may use the same fname, free it just once. */
3395 	if (match->cp_flags & FREE_FNAME)
3396 	    vim_free(match->cp_fname);
3397 	for (i = 0; i < CPT_COUNT; ++i)
3398 	    vim_free(match->cp_text[i]);
3399 	vim_free(match);
3400     } while (compl_curr_match != NULL && compl_curr_match != compl_first_match);
3401     compl_first_match = compl_curr_match = NULL;
3402     compl_shown_match = NULL;
3403 }
3404 
3405     static void
3406 ins_compl_clear(void)
3407 {
3408     compl_cont_status = 0;
3409     compl_started = FALSE;
3410     compl_matches = 0;
3411     vim_free(compl_pattern);
3412     compl_pattern = NULL;
3413     vim_free(compl_leader);
3414     compl_leader = NULL;
3415     edit_submode_extra = NULL;
3416     vim_free(compl_orig_text);
3417     compl_orig_text = NULL;
3418     compl_enter_selects = FALSE;
3419     /* clear v:completed_item */
3420     set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc());
3421 }
3422 
3423 /*
3424  * Return TRUE when Insert completion is active.
3425  */
3426     int
3427 ins_compl_active(void)
3428 {
3429     return compl_started;
3430 }
3431 
3432 /*
3433  * Delete one character before the cursor and show the subset of the matches
3434  * that match the word that is now before the cursor.
3435  * Returns the character to be used, NUL if the work is done and another char
3436  * to be got from the user.
3437  */
3438     static int
3439 ins_compl_bs(void)
3440 {
3441     char_u	*line;
3442     char_u	*p;
3443 
3444     line = ml_get_curline();
3445     p = line + curwin->w_cursor.col;
3446     mb_ptr_back(line, p);
3447 
3448     /* Stop completion when the whole word was deleted.  For Omni completion
3449      * allow the word to be deleted, we won't match everything. */
3450     if ((int)(p - line) - (int)compl_col < 0
3451 	    || ((int)(p - line) - (int)compl_col == 0
3452 		&& ctrl_x_mode != CTRL_X_OMNI) || ctrl_x_mode == CTRL_X_EVAL)
3453 	return K_BS;
3454 
3455     /* Deleted more than what was used to find matches or didn't finish
3456      * finding all matches: need to look for matches all over again. */
3457     if (curwin->w_cursor.col <= compl_col + compl_length
3458 						  || ins_compl_need_restart())
3459 	ins_compl_restart();
3460 
3461     vim_free(compl_leader);
3462     compl_leader = vim_strnsave(line + compl_col, (int)(p - line) - compl_col);
3463     if (compl_leader != NULL)
3464     {
3465 	ins_compl_new_leader();
3466 	if (compl_shown_match != NULL)
3467 	    /* Make sure current match is not a hidden item. */
3468 	    compl_curr_match = compl_shown_match;
3469 	return NUL;
3470     }
3471     return K_BS;
3472 }
3473 
3474 /*
3475  * Return TRUE when we need to find matches again, ins_compl_restart() is to
3476  * be called.
3477  */
3478     static int
3479 ins_compl_need_restart(void)
3480 {
3481     /* Return TRUE if we didn't complete finding matches or when the
3482      * 'completefunc' returned "always" in the "refresh" dictionary item. */
3483     return compl_was_interrupted
3484 	|| ((ctrl_x_mode == CTRL_X_FUNCTION || ctrl_x_mode == CTRL_X_OMNI)
3485 						  && compl_opt_refresh_always);
3486 }
3487 
3488 /*
3489  * Called after changing "compl_leader".
3490  * Show the popup menu with a different set of matches.
3491  * May also search for matches again if the previous search was interrupted.
3492  */
3493     static void
3494 ins_compl_new_leader(void)
3495 {
3496     ins_compl_del_pum();
3497     ins_compl_delete();
3498     ins_bytes(compl_leader + ins_compl_len());
3499     compl_used_match = FALSE;
3500 
3501     if (compl_started)
3502 	ins_compl_set_original_text(compl_leader);
3503     else
3504     {
3505 #ifdef FEAT_SPELL
3506 	spell_bad_len = 0;	/* need to redetect bad word */
3507 #endif
3508 	/*
3509 	 * Matches were cleared, need to search for them now.  First display
3510 	 * the changed text before the cursor.  Set "compl_restarting" to
3511 	 * avoid that the first match is inserted.
3512 	 */
3513 	update_screen(0);
3514 #ifdef FEAT_GUI
3515 	if (gui.in_use)
3516 	{
3517 	    /* Show the cursor after the match, not after the redrawn text. */
3518 	    setcursor();
3519 	    out_flush();
3520 	    gui_update_cursor(FALSE, FALSE);
3521 	}
3522 #endif
3523 	compl_restarting = TRUE;
3524 	if (ins_complete(Ctrl_N, TRUE) == FAIL)
3525 	    compl_cont_status = 0;
3526 	compl_restarting = FALSE;
3527     }
3528 
3529     compl_enter_selects = !compl_used_match;
3530 
3531     /* Show the popup menu with a different set of matches. */
3532     ins_compl_show_pum();
3533 
3534     /* Don't let Enter select the original text when there is no popup menu. */
3535     if (compl_match_array == NULL)
3536 	compl_enter_selects = FALSE;
3537 }
3538 
3539 /*
3540  * Return the length of the completion, from the completion start column to
3541  * the cursor column.  Making sure it never goes below zero.
3542  */
3543     static int
3544 ins_compl_len(void)
3545 {
3546     int off = (int)curwin->w_cursor.col - (int)compl_col;
3547 
3548     if (off < 0)
3549 	return 0;
3550     return off;
3551 }
3552 
3553 /*
3554  * Append one character to the match leader.  May reduce the number of
3555  * matches.
3556  */
3557     static void
3558 ins_compl_addleader(int c)
3559 {
3560 #ifdef FEAT_MBYTE
3561     int		cc;
3562 
3563     if (has_mbyte && (cc = (*mb_char2len)(c)) > 1)
3564     {
3565 	char_u	buf[MB_MAXBYTES + 1];
3566 
3567 	(*mb_char2bytes)(c, buf);
3568 	buf[cc] = NUL;
3569 	ins_char_bytes(buf, cc);
3570 	if (compl_opt_refresh_always)
3571 	    AppendToRedobuff(buf);
3572     }
3573     else
3574 #endif
3575     {
3576 	ins_char(c);
3577 	if (compl_opt_refresh_always)
3578 	    AppendCharToRedobuff(c);
3579     }
3580 
3581     /* If we didn't complete finding matches we must search again. */
3582     if (ins_compl_need_restart())
3583 	ins_compl_restart();
3584 
3585     /* When 'always' is set, don't reset compl_leader. While completing,
3586      * cursor doesn't point original position, changing compl_leader would
3587      * break redo. */
3588     if (!compl_opt_refresh_always)
3589     {
3590 	vim_free(compl_leader);
3591 	compl_leader = vim_strnsave(ml_get_curline() + compl_col,
3592 				     (int)(curwin->w_cursor.col - compl_col));
3593 	if (compl_leader != NULL)
3594 	    ins_compl_new_leader();
3595     }
3596 }
3597 
3598 /*
3599  * Setup for finding completions again without leaving CTRL-X mode.  Used when
3600  * BS or a key was typed while still searching for matches.
3601  */
3602     static void
3603 ins_compl_restart(void)
3604 {
3605     ins_compl_free();
3606     compl_started = FALSE;
3607     compl_matches = 0;
3608     compl_cont_status = 0;
3609     compl_cont_mode = 0;
3610 }
3611 
3612 /*
3613  * Set the first match, the original text.
3614  */
3615     static void
3616 ins_compl_set_original_text(char_u *str)
3617 {
3618     char_u	*p;
3619 
3620     /* Replace the original text entry. */
3621     if (compl_first_match->cp_flags & ORIGINAL_TEXT)	/* safety check */
3622     {
3623 	p = vim_strsave(str);
3624 	if (p != NULL)
3625 	{
3626 	    vim_free(compl_first_match->cp_str);
3627 	    compl_first_match->cp_str = p;
3628 	}
3629     }
3630 }
3631 
3632 /*
3633  * Append one character to the match leader.  May reduce the number of
3634  * matches.
3635  */
3636     static void
3637 ins_compl_addfrommatch(void)
3638 {
3639     char_u	*p;
3640     int		len = (int)curwin->w_cursor.col - (int)compl_col;
3641     int		c;
3642     compl_T	*cp;
3643 
3644     p = compl_shown_match->cp_str;
3645     if ((int)STRLEN(p) <= len)   /* the match is too short */
3646     {
3647 	/* When still at the original match use the first entry that matches
3648 	 * the leader. */
3649 	if (compl_shown_match->cp_flags & ORIGINAL_TEXT)
3650 	{
3651 	    p = NULL;
3652 	    for (cp = compl_shown_match->cp_next; cp != NULL
3653 				 && cp != compl_first_match; cp = cp->cp_next)
3654 	    {
3655 		if (compl_leader == NULL
3656 			|| ins_compl_equal(cp, compl_leader,
3657 						   (int)STRLEN(compl_leader)))
3658 		{
3659 		    p = cp->cp_str;
3660 		    break;
3661 		}
3662 	    }
3663 	    if (p == NULL || (int)STRLEN(p) <= len)
3664 		return;
3665 	}
3666 	else
3667 	    return;
3668     }
3669     p += len;
3670     c = PTR2CHAR(p);
3671     ins_compl_addleader(c);
3672 }
3673 
3674 /*
3675  * Prepare for Insert mode completion, or stop it.
3676  * Called just after typing a character in Insert mode.
3677  * Returns TRUE when the character is not to be inserted;
3678  */
3679     static int
3680 ins_compl_prep(int c)
3681 {
3682     char_u	*ptr;
3683     int		want_cindent;
3684     int		retval = FALSE;
3685 
3686     /* Forget any previous 'special' messages if this is actually
3687      * a ^X mode key - bar ^R, in which case we wait to see what it gives us.
3688      */
3689     if (c != Ctrl_R && vim_is_ctrl_x_key(c))
3690 	edit_submode_extra = NULL;
3691 
3692     /* Ignore end of Select mode mapping and mouse scroll buttons. */
3693     if (c == K_SELECT || c == K_MOUSEDOWN || c == K_MOUSEUP
3694 	    || c == K_MOUSELEFT || c == K_MOUSERIGHT)
3695 	return retval;
3696 
3697     /* Set "compl_get_longest" when finding the first matches. */
3698     if (ctrl_x_mode == CTRL_X_NOT_DEFINED_YET
3699 				      || (ctrl_x_mode == 0 && !compl_started))
3700     {
3701 	compl_get_longest = (strstr((char *)p_cot, "longest") != NULL);
3702 	compl_used_match = TRUE;
3703 
3704     }
3705 
3706     if (ctrl_x_mode == CTRL_X_NOT_DEFINED_YET)
3707     {
3708 	/*
3709 	 * We have just typed CTRL-X and aren't quite sure which CTRL-X mode
3710 	 * it will be yet.  Now we decide.
3711 	 */
3712 	switch (c)
3713 	{
3714 	    case Ctrl_E:
3715 	    case Ctrl_Y:
3716 		ctrl_x_mode = CTRL_X_SCROLL;
3717 		if (!(State & REPLACE_FLAG))
3718 		    edit_submode = (char_u *)_(" (insert) Scroll (^E/^Y)");
3719 		else
3720 		    edit_submode = (char_u *)_(" (replace) Scroll (^E/^Y)");
3721 		edit_submode_pre = NULL;
3722 		showmode();
3723 		break;
3724 	    case Ctrl_L:
3725 		ctrl_x_mode = CTRL_X_WHOLE_LINE;
3726 		break;
3727 	    case Ctrl_F:
3728 		ctrl_x_mode = CTRL_X_FILES;
3729 		break;
3730 	    case Ctrl_K:
3731 		ctrl_x_mode = CTRL_X_DICTIONARY;
3732 		break;
3733 	    case Ctrl_R:
3734 		/* Simply allow ^R to happen without affecting ^X mode */
3735 		break;
3736 	    case Ctrl_T:
3737 		ctrl_x_mode = CTRL_X_THESAURUS;
3738 		break;
3739 #ifdef FEAT_COMPL_FUNC
3740 	    case Ctrl_U:
3741 		ctrl_x_mode = CTRL_X_FUNCTION;
3742 		break;
3743 	    case Ctrl_O:
3744 		ctrl_x_mode = CTRL_X_OMNI;
3745 		break;
3746 #endif
3747 	    case 's':
3748 	    case Ctrl_S:
3749 		ctrl_x_mode = CTRL_X_SPELL;
3750 #ifdef FEAT_SPELL
3751 		++emsg_off;	/* Avoid getting the E756 error twice. */
3752 		spell_back_to_badword();
3753 		--emsg_off;
3754 #endif
3755 		break;
3756 	    case Ctrl_RSB:
3757 		ctrl_x_mode = CTRL_X_TAGS;
3758 		break;
3759 #ifdef FEAT_FIND_ID
3760 	    case Ctrl_I:
3761 	    case K_S_TAB:
3762 		ctrl_x_mode = CTRL_X_PATH_PATTERNS;
3763 		break;
3764 	    case Ctrl_D:
3765 		ctrl_x_mode = CTRL_X_PATH_DEFINES;
3766 		break;
3767 #endif
3768 	    case Ctrl_V:
3769 	    case Ctrl_Q:
3770 		ctrl_x_mode = CTRL_X_CMDLINE;
3771 		break;
3772 	    case Ctrl_P:
3773 	    case Ctrl_N:
3774 		/* ^X^P means LOCAL expansion if nothing interrupted (eg we
3775 		 * just started ^X mode, or there were enough ^X's to cancel
3776 		 * the previous mode, say ^X^F^X^X^P or ^P^X^X^X^P, see below)
3777 		 * do normal expansion when interrupting a different mode (say
3778 		 * ^X^F^X^P or ^P^X^X^P, see below)
3779 		 * nothing changes if interrupting mode 0, (eg, the flag
3780 		 * doesn't change when going to ADDING mode  -- Acevedo */
3781 		if (!(compl_cont_status & CONT_INTRPT))
3782 		    compl_cont_status |= CONT_LOCAL;
3783 		else if (compl_cont_mode != 0)
3784 		    compl_cont_status &= ~CONT_LOCAL;
3785 		/* FALLTHROUGH */
3786 	    default:
3787 		/* If we have typed at least 2 ^X's... for modes != 0, we set
3788 		 * compl_cont_status = 0 (eg, as if we had just started ^X
3789 		 * mode).
3790 		 * For mode 0, we set "compl_cont_mode" to an impossible
3791 		 * value, in both cases ^X^X can be used to restart the same
3792 		 * mode (avoiding ADDING mode).
3793 		 * Undocumented feature: In a mode != 0 ^X^P and ^X^X^P start
3794 		 * 'complete' and local ^P expansions respectively.
3795 		 * In mode 0 an extra ^X is needed since ^X^P goes to ADDING
3796 		 * mode  -- Acevedo */
3797 		if (c == Ctrl_X)
3798 		{
3799 		    if (compl_cont_mode != 0)
3800 			compl_cont_status = 0;
3801 		    else
3802 			compl_cont_mode = CTRL_X_NOT_DEFINED_YET;
3803 		}
3804 		ctrl_x_mode = 0;
3805 		edit_submode = NULL;
3806 		showmode();
3807 		break;
3808 	}
3809     }
3810     else if (ctrl_x_mode != 0)
3811     {
3812 	/* We're already in CTRL-X mode, do we stay in it? */
3813 	if (!vim_is_ctrl_x_key(c))
3814 	{
3815 	    if (ctrl_x_mode == CTRL_X_SCROLL)
3816 		ctrl_x_mode = 0;
3817 	    else
3818 		ctrl_x_mode = CTRL_X_FINISHED;
3819 	    edit_submode = NULL;
3820 	}
3821 	showmode();
3822     }
3823 
3824     if (compl_started || ctrl_x_mode == CTRL_X_FINISHED)
3825     {
3826 	/* Show error message from attempted keyword completion (probably
3827 	 * 'Pattern not found') until another key is hit, then go back to
3828 	 * showing what mode we are in. */
3829 	showmode();
3830 	if ((ctrl_x_mode == 0 && c != Ctrl_N && c != Ctrl_P && c != Ctrl_R
3831 						     && !ins_compl_pum_key(c))
3832 		|| ctrl_x_mode == CTRL_X_FINISHED)
3833 	{
3834 	    /* Get here when we have finished typing a sequence of ^N and
3835 	     * ^P or other completion characters in CTRL-X mode.  Free up
3836 	     * memory that was used, and make sure we can redo the insert. */
3837 	    if (compl_curr_match != NULL || compl_leader != NULL || c == Ctrl_E)
3838 	    {
3839 		/*
3840 		 * If any of the original typed text has been changed, eg when
3841 		 * ignorecase is set, we must add back-spaces to the redo
3842 		 * buffer.  We add as few as necessary to delete just the part
3843 		 * of the original text that has changed.
3844 		 * When using the longest match, edited the match or used
3845 		 * CTRL-E then don't use the current match.
3846 		 */
3847 		if (compl_curr_match != NULL && compl_used_match && c != Ctrl_E)
3848 		    ptr = compl_curr_match->cp_str;
3849 		else
3850 		    ptr = NULL;
3851 		ins_compl_fixRedoBufForLeader(ptr);
3852 	    }
3853 
3854 #ifdef FEAT_CINDENT
3855 	    want_cindent = (can_cindent && cindent_on());
3856 #endif
3857 	    /*
3858 	     * When completing whole lines: fix indent for 'cindent'.
3859 	     * Otherwise, break line if it's too long.
3860 	     */
3861 	    if (compl_cont_mode == CTRL_X_WHOLE_LINE)
3862 	    {
3863 #ifdef FEAT_CINDENT
3864 		/* re-indent the current line */
3865 		if (want_cindent)
3866 		{
3867 		    do_c_expr_indent();
3868 		    want_cindent = FALSE;	/* don't do it again */
3869 		}
3870 #endif
3871 	    }
3872 	    else
3873 	    {
3874 		int prev_col = curwin->w_cursor.col;
3875 
3876 		/* put the cursor on the last char, for 'tw' formatting */
3877 		if (prev_col > 0)
3878 		    dec_cursor();
3879 		if (stop_arrow() == OK)
3880 		    insertchar(NUL, 0, -1);
3881 		if (prev_col > 0
3882 			     && ml_get_curline()[curwin->w_cursor.col] != NUL)
3883 		    inc_cursor();
3884 	    }
3885 
3886 	    /* If the popup menu is displayed pressing CTRL-Y means accepting
3887 	     * the selection without inserting anything.  When
3888 	     * compl_enter_selects is set the Enter key does the same. */
3889 	    if ((c == Ctrl_Y || (compl_enter_selects
3890 				   && (c == CAR || c == K_KENTER || c == NL)))
3891 		    && pum_visible())
3892 		retval = TRUE;
3893 
3894 	    /* CTRL-E means completion is Ended, go back to the typed text.
3895 	     * but only do this, if the Popup is still visible */
3896 	    if (c == Ctrl_E)
3897 	    {
3898 		ins_compl_delete();
3899 		if (compl_leader != NULL)
3900 		    ins_bytes(compl_leader + ins_compl_len());
3901 		else if (compl_first_match != NULL)
3902 		    ins_bytes(compl_orig_text + ins_compl_len());
3903 		retval = TRUE;
3904 	    }
3905 
3906 	    auto_format(FALSE, TRUE);
3907 
3908 	    ins_compl_free();
3909 	    compl_started = FALSE;
3910 	    compl_matches = 0;
3911 	    if (!shortmess(SHM_COMPLETIONMENU))
3912 		msg_clr_cmdline();	/* necessary for "noshowmode" */
3913 	    ctrl_x_mode = 0;
3914 	    compl_enter_selects = FALSE;
3915 	    if (edit_submode != NULL)
3916 	    {
3917 		edit_submode = NULL;
3918 		showmode();
3919 	    }
3920 
3921 #ifdef FEAT_CMDWIN
3922 	    if (c == Ctrl_C && cmdwin_type != 0)
3923 		/* Avoid the popup menu remains displayed when leaving the
3924 		 * command line window. */
3925 		update_screen(0);
3926 #endif
3927 #ifdef FEAT_CINDENT
3928 	    /*
3929 	     * Indent now if a key was typed that is in 'cinkeys'.
3930 	     */
3931 	    if (want_cindent && in_cinkeys(KEY_COMPLETE, ' ', inindent(0)))
3932 		do_c_expr_indent();
3933 #endif
3934 #ifdef FEAT_AUTOCMD
3935 	    /* Trigger the CompleteDone event to give scripts a chance to act
3936 	     * upon the completion. */
3937 	    apply_autocmds(EVENT_COMPLETEDONE, NULL, NULL, FALSE, curbuf);
3938 #endif
3939 	}
3940     }
3941 #ifdef FEAT_AUTOCMD
3942     else if (ctrl_x_mode == CTRL_X_LOCAL_MSG)
3943 	/* Trigger the CompleteDone event to give scripts a chance to act
3944 	 * upon the (possibly failed) completion. */
3945 	apply_autocmds(EVENT_COMPLETEDONE, NULL, NULL, FALSE, curbuf);
3946 #endif
3947 
3948     /* reset continue_* if we left expansion-mode, if we stay they'll be
3949      * (re)set properly in ins_complete() */
3950     if (!vim_is_ctrl_x_key(c))
3951     {
3952 	compl_cont_status = 0;
3953 	compl_cont_mode = 0;
3954     }
3955 
3956     return retval;
3957 }
3958 
3959 /*
3960  * Fix the redo buffer for the completion leader replacing some of the typed
3961  * text.  This inserts backspaces and appends the changed text.
3962  * "ptr" is the known leader text or NUL.
3963  */
3964     static void
3965 ins_compl_fixRedoBufForLeader(char_u *ptr_arg)
3966 {
3967     int	    len;
3968     char_u  *p;
3969     char_u  *ptr = ptr_arg;
3970 
3971     if (ptr == NULL)
3972     {
3973 	if (compl_leader != NULL)
3974 	    ptr = compl_leader;
3975 	else
3976 	    return;  /* nothing to do */
3977     }
3978     if (compl_orig_text != NULL)
3979     {
3980 	p = compl_orig_text;
3981 	for (len = 0; p[len] != NUL && p[len] == ptr[len]; ++len)
3982 	    ;
3983 #ifdef FEAT_MBYTE
3984 	if (len > 0)
3985 	    len -= (*mb_head_off)(p, p + len);
3986 #endif
3987 	for (p += len; *p != NUL; mb_ptr_adv(p))
3988 	    AppendCharToRedobuff(K_BS);
3989     }
3990     else
3991 	len = 0;
3992     if (ptr != NULL)
3993 	AppendToRedobuffLit(ptr + len, -1);
3994 }
3995 
3996 /*
3997  * Loops through the list of windows, loaded-buffers or non-loaded-buffers
3998  * (depending on flag) starting from buf and looking for a non-scanned
3999  * buffer (other than curbuf).	curbuf is special, if it is called with
4000  * buf=curbuf then it has to be the first call for a given flag/expansion.
4001  *
4002  * Returns the buffer to scan, if any, otherwise returns curbuf -- Acevedo
4003  */
4004     static buf_T *
4005 ins_compl_next_buf(buf_T *buf, int flag)
4006 {
4007 #ifdef FEAT_WINDOWS
4008     static win_T *wp;
4009 #endif
4010 
4011     if (flag == 'w')		/* just windows */
4012     {
4013 #ifdef FEAT_WINDOWS
4014 	if (buf == curbuf)	/* first call for this flag/expansion */
4015 	    wp = curwin;
4016 	while ((wp = (wp->w_next != NULL ? wp->w_next : firstwin)) != curwin
4017 		&& wp->w_buffer->b_scanned)
4018 	    ;
4019 	buf = wp->w_buffer;
4020 #else
4021 	buf = curbuf;
4022 #endif
4023     }
4024     else
4025 	/* 'b' (just loaded buffers), 'u' (just non-loaded buffers) or 'U'
4026 	 * (unlisted buffers)
4027 	 * When completing whole lines skip unloaded buffers. */
4028 	while ((buf = (buf->b_next != NULL ? buf->b_next : firstbuf)) != curbuf
4029 		&& ((flag == 'U'
4030 			? buf->b_p_bl
4031 			: (!buf->b_p_bl
4032 			    || (buf->b_ml.ml_mfp == NULL) != (flag == 'u')))
4033 		    || buf->b_scanned))
4034 	    ;
4035     return buf;
4036 }
4037 
4038 #ifdef FEAT_COMPL_FUNC
4039 static void expand_by_function(int type, char_u *base);
4040 
4041 /*
4042  * Execute user defined complete function 'completefunc' or 'omnifunc', and
4043  * get matches in "matches".
4044  */
4045     static void
4046 expand_by_function(
4047     int		type,	    /* CTRL_X_OMNI or CTRL_X_FUNCTION */
4048     char_u	*base)
4049 {
4050     list_T      *matchlist = NULL;
4051     dict_T	*matchdict = NULL;
4052     char_u	*args[2];
4053     char_u	*funcname;
4054     pos_T	pos;
4055     win_T	*curwin_save;
4056     buf_T	*curbuf_save;
4057     typval_T	rettv;
4058 
4059     funcname = (type == CTRL_X_FUNCTION) ? curbuf->b_p_cfu : curbuf->b_p_ofu;
4060     if (*funcname == NUL)
4061 	return;
4062 
4063     /* Call 'completefunc' to obtain the list of matches. */
4064     args[0] = (char_u *)"0";
4065     args[1] = base;
4066 
4067     pos = curwin->w_cursor;
4068     curwin_save = curwin;
4069     curbuf_save = curbuf;
4070 
4071     /* Call a function, which returns a list or dict. */
4072     if (call_vim_function(funcname, 2, args, FALSE, FALSE, &rettv) == OK)
4073     {
4074 	switch (rettv.v_type)
4075 	{
4076 	    case VAR_LIST:
4077 		matchlist = rettv.vval.v_list;
4078 		break;
4079 	    case VAR_DICT:
4080 		matchdict = rettv.vval.v_dict;
4081 		break;
4082 	    default:
4083 		/* TODO: Give error message? */
4084 		clear_tv(&rettv);
4085 		break;
4086 	}
4087     }
4088 
4089     if (curwin_save != curwin || curbuf_save != curbuf)
4090     {
4091 	EMSG(_(e_complwin));
4092 	goto theend;
4093     }
4094     curwin->w_cursor = pos;	/* restore the cursor position */
4095     validate_cursor();
4096     if (!equalpos(curwin->w_cursor, pos))
4097     {
4098 	EMSG(_(e_compldel));
4099 	goto theend;
4100     }
4101 
4102     if (matchlist != NULL)
4103 	ins_compl_add_list(matchlist);
4104     else if (matchdict != NULL)
4105 	ins_compl_add_dict(matchdict);
4106 
4107 theend:
4108     if (matchdict != NULL)
4109 	dict_unref(matchdict);
4110     if (matchlist != NULL)
4111 	list_unref(matchlist);
4112 }
4113 #endif /* FEAT_COMPL_FUNC */
4114 
4115 #if defined(FEAT_COMPL_FUNC) || defined(FEAT_EVAL) || defined(PROTO)
4116 /*
4117  * Add completions from a list.
4118  */
4119     static void
4120 ins_compl_add_list(list_T *list)
4121 {
4122     listitem_T	*li;
4123     int		dir = compl_direction;
4124 
4125     /* Go through the List with matches and add each of them. */
4126     for (li = list->lv_first; li != NULL; li = li->li_next)
4127     {
4128 	if (ins_compl_add_tv(&li->li_tv, dir) == OK)
4129 	    /* if dir was BACKWARD then honor it just once */
4130 	    dir = FORWARD;
4131 	else if (did_emsg)
4132 	    break;
4133     }
4134 }
4135 
4136 /*
4137  * Add completions from a dict.
4138  */
4139     static void
4140 ins_compl_add_dict(dict_T *dict)
4141 {
4142     dictitem_T	*di_refresh;
4143     dictitem_T	*di_words;
4144 
4145     /* Check for optional "refresh" item. */
4146     compl_opt_refresh_always = FALSE;
4147     di_refresh = dict_find(dict, (char_u *)"refresh", 7);
4148     if (di_refresh != NULL && di_refresh->di_tv.v_type == VAR_STRING)
4149     {
4150 	char_u	*v = di_refresh->di_tv.vval.v_string;
4151 
4152 	if (v != NULL && STRCMP(v, (char_u *)"always") == 0)
4153 	    compl_opt_refresh_always = TRUE;
4154     }
4155 
4156     /* Add completions from a "words" list. */
4157     di_words = dict_find(dict, (char_u *)"words", 5);
4158     if (di_words != NULL && di_words->di_tv.v_type == VAR_LIST)
4159 	ins_compl_add_list(di_words->di_tv.vval.v_list);
4160 }
4161 
4162 /*
4163  * Add a match to the list of matches from a typeval_T.
4164  * If the given string is already in the list of completions, then return
4165  * NOTDONE, otherwise add it to the list and return OK.  If there is an error,
4166  * maybe because alloc() returns NULL, then FAIL is returned.
4167  */
4168     int
4169 ins_compl_add_tv(typval_T *tv, int dir)
4170 {
4171     char_u	*word;
4172     int		icase = FALSE;
4173     int		adup = FALSE;
4174     int		aempty = FALSE;
4175     char_u	*(cptext[CPT_COUNT]);
4176 
4177     if (tv->v_type == VAR_DICT && tv->vval.v_dict != NULL)
4178     {
4179 	word = get_dict_string(tv->vval.v_dict, (char_u *)"word", FALSE);
4180 	cptext[CPT_ABBR] = get_dict_string(tv->vval.v_dict,
4181 						     (char_u *)"abbr", FALSE);
4182 	cptext[CPT_MENU] = get_dict_string(tv->vval.v_dict,
4183 						     (char_u *)"menu", FALSE);
4184 	cptext[CPT_KIND] = get_dict_string(tv->vval.v_dict,
4185 						     (char_u *)"kind", FALSE);
4186 	cptext[CPT_INFO] = get_dict_string(tv->vval.v_dict,
4187 						     (char_u *)"info", FALSE);
4188 	if (get_dict_string(tv->vval.v_dict, (char_u *)"icase", FALSE) != NULL)
4189 	    icase = get_dict_number(tv->vval.v_dict, (char_u *)"icase");
4190 	if (get_dict_string(tv->vval.v_dict, (char_u *)"dup", FALSE) != NULL)
4191 	    adup = get_dict_number(tv->vval.v_dict, (char_u *)"dup");
4192 	if (get_dict_string(tv->vval.v_dict, (char_u *)"empty", FALSE) != NULL)
4193 	    aempty = get_dict_number(tv->vval.v_dict, (char_u *)"empty");
4194     }
4195     else
4196     {
4197 	word = get_tv_string_chk(tv);
4198 	vim_memset(cptext, 0, sizeof(cptext));
4199     }
4200     if (word == NULL || (!aempty && *word == NUL))
4201 	return FAIL;
4202     return ins_compl_add(word, -1, icase, NULL, cptext, dir, 0, adup);
4203 }
4204 #endif
4205 
4206 /*
4207  * Get the next expansion(s), using "compl_pattern".
4208  * The search starts at position "ini" in curbuf and in the direction
4209  * compl_direction.
4210  * When "compl_started" is FALSE start at that position, otherwise continue
4211  * where we stopped searching before.
4212  * This may return before finding all the matches.
4213  * Return the total number of matches or -1 if still unknown -- Acevedo
4214  */
4215     static int
4216 ins_compl_get_exp(pos_T *ini)
4217 {
4218     static pos_T	first_match_pos;
4219     static pos_T	last_match_pos;
4220     static char_u	*e_cpt = (char_u *)"";	/* curr. entry in 'complete' */
4221     static int		found_all = FALSE;	/* Found all matches of a
4222 						   certain type. */
4223     static buf_T	*ins_buf = NULL;	/* buffer being scanned */
4224 
4225     pos_T	*pos;
4226     char_u	**matches;
4227     int		save_p_scs;
4228     int		save_p_ws;
4229     int		save_p_ic;
4230     int		i;
4231     int		num_matches;
4232     int		len;
4233     int		found_new_match;
4234     int		type = ctrl_x_mode;
4235     char_u	*ptr;
4236     char_u	*dict = NULL;
4237     int		dict_f = 0;
4238     compl_T	*old_match;
4239     int		set_match_pos;
4240 
4241     if (!compl_started)
4242     {
4243 	FOR_ALL_BUFFERS(ins_buf)
4244 	    ins_buf->b_scanned = 0;
4245 	found_all = FALSE;
4246 	ins_buf = curbuf;
4247 	e_cpt = (compl_cont_status & CONT_LOCAL)
4248 					    ? (char_u *)"." : curbuf->b_p_cpt;
4249 	last_match_pos = first_match_pos = *ini;
4250     }
4251 
4252     old_match = compl_curr_match;	/* remember the last current match */
4253     pos = (compl_direction == FORWARD) ? &last_match_pos : &first_match_pos;
4254     /* For ^N/^P loop over all the flags/windows/buffers in 'complete' */
4255     for (;;)
4256     {
4257 	found_new_match = FAIL;
4258 	set_match_pos = FALSE;
4259 
4260 	/* For ^N/^P pick a new entry from e_cpt if compl_started is off,
4261 	 * or if found_all says this entry is done.  For ^X^L only use the
4262 	 * entries from 'complete' that look in loaded buffers. */
4263 	if ((ctrl_x_mode == 0 || CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
4264 					&& (!compl_started || found_all))
4265 	{
4266 	    found_all = FALSE;
4267 	    while (*e_cpt == ',' || *e_cpt == ' ')
4268 		e_cpt++;
4269 	    if (*e_cpt == '.' && !curbuf->b_scanned)
4270 	    {
4271 		ins_buf = curbuf;
4272 		first_match_pos = *ini;
4273 		/* So that ^N can match word immediately after cursor */
4274 		if (ctrl_x_mode == 0)
4275 		    dec(&first_match_pos);
4276 		last_match_pos = first_match_pos;
4277 		type = 0;
4278 
4279 		/* Remember the first match so that the loop stops when we
4280 		 * wrap and come back there a second time. */
4281 		set_match_pos = TRUE;
4282 	    }
4283 	    else if (vim_strchr((char_u *)"buwU", *e_cpt) != NULL
4284 		 && (ins_buf = ins_compl_next_buf(ins_buf, *e_cpt)) != curbuf)
4285 	    {
4286 		/* Scan a buffer, but not the current one. */
4287 		if (ins_buf->b_ml.ml_mfp != NULL)   /* loaded buffer */
4288 		{
4289 		    compl_started = TRUE;
4290 		    first_match_pos.col = last_match_pos.col = 0;
4291 		    first_match_pos.lnum = ins_buf->b_ml.ml_line_count + 1;
4292 		    last_match_pos.lnum = 0;
4293 		    type = 0;
4294 		}
4295 		else	/* unloaded buffer, scan like dictionary */
4296 		{
4297 		    found_all = TRUE;
4298 		    if (ins_buf->b_fname == NULL)
4299 			continue;
4300 		    type = CTRL_X_DICTIONARY;
4301 		    dict = ins_buf->b_fname;
4302 		    dict_f = DICT_EXACT;
4303 		}
4304 		vim_snprintf((char *)IObuff, IOSIZE, _("Scanning: %s"),
4305 			ins_buf->b_fname == NULL
4306 			    ? buf_spname(ins_buf)
4307 			    : ins_buf->b_sfname == NULL
4308 				? ins_buf->b_fname
4309 				: ins_buf->b_sfname);
4310 		(void)msg_trunc_attr(IObuff, TRUE, hl_attr(HLF_R));
4311 	    }
4312 	    else if (*e_cpt == NUL)
4313 		break;
4314 	    else
4315 	    {
4316 		if (CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
4317 		    type = -1;
4318 		else if (*e_cpt == 'k' || *e_cpt == 's')
4319 		{
4320 		    if (*e_cpt == 'k')
4321 			type = CTRL_X_DICTIONARY;
4322 		    else
4323 			type = CTRL_X_THESAURUS;
4324 		    if (*++e_cpt != ',' && *e_cpt != NUL)
4325 		    {
4326 			dict = e_cpt;
4327 			dict_f = DICT_FIRST;
4328 		    }
4329 		}
4330 #ifdef FEAT_FIND_ID
4331 		else if (*e_cpt == 'i')
4332 		    type = CTRL_X_PATH_PATTERNS;
4333 		else if (*e_cpt == 'd')
4334 		    type = CTRL_X_PATH_DEFINES;
4335 #endif
4336 		else if (*e_cpt == ']' || *e_cpt == 't')
4337 		{
4338 		    type = CTRL_X_TAGS;
4339 		    vim_snprintf((char *)IObuff, IOSIZE, _("Scanning tags."));
4340 		    (void)msg_trunc_attr(IObuff, TRUE, hl_attr(HLF_R));
4341 		}
4342 		else
4343 		    type = -1;
4344 
4345 		/* in any case e_cpt is advanced to the next entry */
4346 		(void)copy_option_part(&e_cpt, IObuff, IOSIZE, ",");
4347 
4348 		found_all = TRUE;
4349 		if (type == -1)
4350 		    continue;
4351 	    }
4352 	}
4353 
4354 	switch (type)
4355 	{
4356 	case -1:
4357 	    break;
4358 #ifdef FEAT_FIND_ID
4359 	case CTRL_X_PATH_PATTERNS:
4360 	case CTRL_X_PATH_DEFINES:
4361 	    find_pattern_in_path(compl_pattern, compl_direction,
4362 				 (int)STRLEN(compl_pattern), FALSE, FALSE,
4363 				 (type == CTRL_X_PATH_DEFINES
4364 				  && !(compl_cont_status & CONT_SOL))
4365 				 ? FIND_DEFINE : FIND_ANY, 1L, ACTION_EXPAND,
4366 				 (linenr_T)1, (linenr_T)MAXLNUM);
4367 	    break;
4368 #endif
4369 
4370 	case CTRL_X_DICTIONARY:
4371 	case CTRL_X_THESAURUS:
4372 	    ins_compl_dictionaries(
4373 		    dict != NULL ? dict
4374 			 : (type == CTRL_X_THESAURUS
4375 			     ? (*curbuf->b_p_tsr == NUL
4376 				 ? p_tsr
4377 				 : curbuf->b_p_tsr)
4378 			     : (*curbuf->b_p_dict == NUL
4379 				 ? p_dict
4380 				 : curbuf->b_p_dict)),
4381 			    compl_pattern,
4382 				 dict != NULL ? dict_f
4383 					       : 0, type == CTRL_X_THESAURUS);
4384 	    dict = NULL;
4385 	    break;
4386 
4387 	case CTRL_X_TAGS:
4388 	    /* set p_ic according to p_ic, p_scs and pat for find_tags(). */
4389 	    save_p_ic = p_ic;
4390 	    p_ic = ignorecase(compl_pattern);
4391 
4392 	    /* Find up to TAG_MANY matches.  Avoids that an enormous number
4393 	     * of matches is found when compl_pattern is empty */
4394 	    if (find_tags(compl_pattern, &num_matches, &matches,
4395 		    TAG_REGEXP | TAG_NAMES | TAG_NOIC |
4396 		    TAG_INS_COMP | (ctrl_x_mode ? TAG_VERBOSE : 0),
4397 		    TAG_MANY, curbuf->b_ffname) == OK && num_matches > 0)
4398 	    {
4399 		ins_compl_add_matches(num_matches, matches, p_ic);
4400 	    }
4401 	    p_ic = save_p_ic;
4402 	    break;
4403 
4404 	case CTRL_X_FILES:
4405 	    if (expand_wildcards(1, &compl_pattern, &num_matches, &matches,
4406 				  EW_FILE|EW_DIR|EW_ADDSLASH|EW_SILENT) == OK)
4407 	    {
4408 
4409 		/* May change home directory back to "~". */
4410 		tilde_replace(compl_pattern, num_matches, matches);
4411 		ins_compl_add_matches(num_matches, matches, p_fic || p_wic);
4412 	    }
4413 	    break;
4414 
4415 	case CTRL_X_CMDLINE:
4416 	    if (expand_cmdline(&compl_xp, compl_pattern,
4417 			(int)STRLEN(compl_pattern),
4418 					 &num_matches, &matches) == EXPAND_OK)
4419 		ins_compl_add_matches(num_matches, matches, FALSE);
4420 	    break;
4421 
4422 #ifdef FEAT_COMPL_FUNC
4423 	case CTRL_X_FUNCTION:
4424 	case CTRL_X_OMNI:
4425 	    expand_by_function(type, compl_pattern);
4426 	    break;
4427 #endif
4428 
4429 	case CTRL_X_SPELL:
4430 #ifdef FEAT_SPELL
4431 	    num_matches = expand_spelling(first_match_pos.lnum,
4432 						     compl_pattern, &matches);
4433 	    if (num_matches > 0)
4434 		ins_compl_add_matches(num_matches, matches, p_ic);
4435 #endif
4436 	    break;
4437 
4438 	default:	/* normal ^P/^N and ^X^L */
4439 	    /*
4440 	     * If 'infercase' is set, don't use 'smartcase' here
4441 	     */
4442 	    save_p_scs = p_scs;
4443 	    if (ins_buf->b_p_inf)
4444 		p_scs = FALSE;
4445 
4446 	    /*	Buffers other than curbuf are scanned from the beginning or the
4447 	     *	end but never from the middle, thus setting nowrapscan in this
4448 	     *	buffers is a good idea, on the other hand, we always set
4449 	     *	wrapscan for curbuf to avoid missing matches -- Acevedo,Webb */
4450 	    save_p_ws = p_ws;
4451 	    if (ins_buf != curbuf)
4452 		p_ws = FALSE;
4453 	    else if (*e_cpt == '.')
4454 		p_ws = TRUE;
4455 	    for (;;)
4456 	    {
4457 		int	flags = 0;
4458 
4459 		++msg_silent;  /* Don't want messages for wrapscan. */
4460 
4461 		/* CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode)
4462 		 * || word-wise search that
4463 		 * has added a word that was at the beginning of the line */
4464 		if (CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode)
4465 			|| (compl_cont_status & CONT_SOL))
4466 		    found_new_match = search_for_exact_line(ins_buf, pos,
4467 					      compl_direction, compl_pattern);
4468 		else
4469 		    found_new_match = searchit(NULL, ins_buf, pos,
4470 							      compl_direction,
4471 				 compl_pattern, 1L, SEARCH_KEEP + SEARCH_NFMSG,
4472 						  RE_LAST, (linenr_T)0, NULL);
4473 		--msg_silent;
4474 		if (!compl_started || set_match_pos)
4475 		{
4476 		    /* set "compl_started" even on fail */
4477 		    compl_started = TRUE;
4478 		    first_match_pos = *pos;
4479 		    last_match_pos = *pos;
4480 		    set_match_pos = FALSE;
4481 		}
4482 		else if (first_match_pos.lnum == last_match_pos.lnum
4483 				 && first_match_pos.col == last_match_pos.col)
4484 		    found_new_match = FAIL;
4485 		if (found_new_match == FAIL)
4486 		{
4487 		    if (ins_buf == curbuf)
4488 			found_all = TRUE;
4489 		    break;
4490 		}
4491 
4492 		/* when ADDING, the text before the cursor matches, skip it */
4493 		if (	(compl_cont_status & CONT_ADDING) && ins_buf == curbuf
4494 			&& ini->lnum == pos->lnum
4495 			&& ini->col  == pos->col)
4496 		    continue;
4497 		ptr = ml_get_buf(ins_buf, pos->lnum, FALSE) + pos->col;
4498 		if (CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
4499 		{
4500 		    if (compl_cont_status & CONT_ADDING)
4501 		    {
4502 			if (pos->lnum >= ins_buf->b_ml.ml_line_count)
4503 			    continue;
4504 			ptr = ml_get_buf(ins_buf, pos->lnum + 1, FALSE);
4505 			if (!p_paste)
4506 			    ptr = skipwhite(ptr);
4507 		    }
4508 		    len = (int)STRLEN(ptr);
4509 		}
4510 		else
4511 		{
4512 		    char_u	*tmp_ptr = ptr;
4513 
4514 		    if (compl_cont_status & CONT_ADDING)
4515 		    {
4516 			tmp_ptr += compl_length;
4517 			/* Skip if already inside a word. */
4518 			if (vim_iswordp(tmp_ptr))
4519 			    continue;
4520 			/* Find start of next word. */
4521 			tmp_ptr = find_word_start(tmp_ptr);
4522 		    }
4523 		    /* Find end of this word. */
4524 		    tmp_ptr = find_word_end(tmp_ptr);
4525 		    len = (int)(tmp_ptr - ptr);
4526 
4527 		    if ((compl_cont_status & CONT_ADDING)
4528 						       && len == compl_length)
4529 		    {
4530 			if (pos->lnum < ins_buf->b_ml.ml_line_count)
4531 			{
4532 			    /* Try next line, if any. the new word will be
4533 			     * "join" as if the normal command "J" was used.
4534 			     * IOSIZE is always greater than
4535 			     * compl_length, so the next STRNCPY always
4536 			     * works -- Acevedo */
4537 			    STRNCPY(IObuff, ptr, len);
4538 			    ptr = ml_get_buf(ins_buf, pos->lnum + 1, FALSE);
4539 			    tmp_ptr = ptr = skipwhite(ptr);
4540 			    /* Find start of next word. */
4541 			    tmp_ptr = find_word_start(tmp_ptr);
4542 			    /* Find end of next word. */
4543 			    tmp_ptr = find_word_end(tmp_ptr);
4544 			    if (tmp_ptr > ptr)
4545 			    {
4546 				if (*ptr != ')' && IObuff[len - 1] != TAB)
4547 				{
4548 				    if (IObuff[len - 1] != ' ')
4549 					IObuff[len++] = ' ';
4550 				    /* IObuf =~ "\k.* ", thus len >= 2 */
4551 				    if (p_js
4552 					&& (IObuff[len - 2] == '.'
4553 					    || (vim_strchr(p_cpo, CPO_JOINSP)
4554 								       == NULL
4555 						&& (IObuff[len - 2] == '?'
4556 						 || IObuff[len - 2] == '!'))))
4557 					IObuff[len++] = ' ';
4558 				}
4559 				/* copy as much as possible of the new word */
4560 				if (tmp_ptr - ptr >= IOSIZE - len)
4561 				    tmp_ptr = ptr + IOSIZE - len - 1;
4562 				STRNCPY(IObuff + len, ptr, tmp_ptr - ptr);
4563 				len += (int)(tmp_ptr - ptr);
4564 				flags |= CONT_S_IPOS;
4565 			    }
4566 			    IObuff[len] = NUL;
4567 			    ptr = IObuff;
4568 			}
4569 			if (len == compl_length)
4570 			    continue;
4571 		    }
4572 		}
4573 		if (ins_compl_add_infercase(ptr, len, p_ic,
4574 				 ins_buf == curbuf ? NULL : ins_buf->b_sfname,
4575 					   0, flags) != NOTDONE)
4576 		{
4577 		    found_new_match = OK;
4578 		    break;
4579 		}
4580 	    }
4581 	    p_scs = save_p_scs;
4582 	    p_ws = save_p_ws;
4583 	}
4584 
4585 	/* check if compl_curr_match has changed, (e.g. other type of
4586 	 * expansion added something) */
4587 	if (type != 0 && compl_curr_match != old_match)
4588 	    found_new_match = OK;
4589 
4590 	/* break the loop for specialized modes (use 'complete' just for the
4591 	 * generic ctrl_x_mode == 0) or when we've found a new match */
4592 	if ((ctrl_x_mode != 0 && !CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
4593 						   || found_new_match != FAIL)
4594 	{
4595 	    if (got_int)
4596 		break;
4597 	    /* Fill the popup menu as soon as possible. */
4598 	    if (type != -1)
4599 		ins_compl_check_keys(0);
4600 
4601 	    if ((ctrl_x_mode != 0 && !CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
4602 							 || compl_interrupted)
4603 		break;
4604 	    compl_started = TRUE;
4605 	}
4606 	else
4607 	{
4608 	    /* Mark a buffer scanned when it has been scanned completely */
4609 	    if (type == 0 || type == CTRL_X_PATH_PATTERNS)
4610 		ins_buf->b_scanned = TRUE;
4611 
4612 	    compl_started = FALSE;
4613 	}
4614     }
4615     compl_started = TRUE;
4616 
4617     if ((ctrl_x_mode == 0 || CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
4618 	    && *e_cpt == NUL)		/* Got to end of 'complete' */
4619 	found_new_match = FAIL;
4620 
4621     i = -1;		/* total of matches, unknown */
4622     if (found_new_match == FAIL
4623 	    || (ctrl_x_mode != 0 && !CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode)))
4624 	i = ins_compl_make_cyclic();
4625 
4626     /* If several matches were added (FORWARD) or the search failed and has
4627      * just been made cyclic then we have to move compl_curr_match to the next
4628      * or previous entry (if any) -- Acevedo */
4629     compl_curr_match = compl_direction == FORWARD ? old_match->cp_next
4630 							 : old_match->cp_prev;
4631     if (compl_curr_match == NULL)
4632 	compl_curr_match = old_match;
4633     return i;
4634 }
4635 
4636 /* Delete the old text being completed. */
4637     static void
4638 ins_compl_delete(void)
4639 {
4640     int	    i;
4641 
4642     /*
4643      * In insert mode: Delete the typed part.
4644      * In replace mode: Put the old characters back, if any.
4645      */
4646     i = compl_col + (compl_cont_status & CONT_ADDING ? compl_length : 0);
4647     backspace_until_column(i);
4648 
4649     /* TODO: is this sufficient for redrawing?  Redrawing everything causes
4650      * flicker, thus we can't do that. */
4651     changed_cline_bef_curs();
4652     /* clear v:completed_item */
4653     set_vim_var_dict(VV_COMPLETED_ITEM, dict_alloc());
4654 }
4655 
4656 /* Insert the new text being completed. */
4657     static void
4658 ins_compl_insert(void)
4659 {
4660     dict_T	*dict;
4661 
4662     ins_bytes(compl_shown_match->cp_str + ins_compl_len());
4663     if (compl_shown_match->cp_flags & ORIGINAL_TEXT)
4664 	compl_used_match = FALSE;
4665     else
4666 	compl_used_match = TRUE;
4667 
4668     /* Set completed item. */
4669     /* { word, abbr, menu, kind, info } */
4670     dict = dict_alloc();
4671     if (dict != NULL)
4672     {
4673 	dict_add_nr_str(dict, "word", 0L,
4674 		    EMPTY_IF_NULL(compl_shown_match->cp_str));
4675 	dict_add_nr_str(dict, "abbr", 0L,
4676 		    EMPTY_IF_NULL(compl_shown_match->cp_text[CPT_ABBR]));
4677 	dict_add_nr_str(dict, "menu", 0L,
4678 		    EMPTY_IF_NULL(compl_shown_match->cp_text[CPT_MENU]));
4679 	dict_add_nr_str(dict, "kind", 0L,
4680 		    EMPTY_IF_NULL(compl_shown_match->cp_text[CPT_KIND]));
4681 	dict_add_nr_str(dict, "info", 0L,
4682 		    EMPTY_IF_NULL(compl_shown_match->cp_text[CPT_INFO]));
4683     }
4684     set_vim_var_dict(VV_COMPLETED_ITEM, dict);
4685     compl_curr_match = compl_shown_match;
4686 }
4687 
4688 /*
4689  * Fill in the next completion in the current direction.
4690  * If "allow_get_expansion" is TRUE, then we may call ins_compl_get_exp() to
4691  * get more completions.  If it is FALSE, then we just do nothing when there
4692  * are no more completions in a given direction.  The latter case is used when
4693  * we are still in the middle of finding completions, to allow browsing
4694  * through the ones found so far.
4695  * Return the total number of matches, or -1 if still unknown -- webb.
4696  *
4697  * compl_curr_match is currently being used by ins_compl_get_exp(), so we use
4698  * compl_shown_match here.
4699  *
4700  * Note that this function may be called recursively once only.  First with
4701  * "allow_get_expansion" TRUE, which calls ins_compl_get_exp(), which in turn
4702  * calls this function with "allow_get_expansion" FALSE.
4703  */
4704     static int
4705 ins_compl_next(
4706     int	    allow_get_expansion,
4707     int	    count,		/* repeat completion this many times; should
4708 				   be at least 1 */
4709     int	    insert_match)	/* Insert the newly selected match */
4710 {
4711     int	    num_matches = -1;
4712     int	    i;
4713     int	    todo = count;
4714     compl_T *found_compl = NULL;
4715     int	    found_end = FALSE;
4716     int	    advance;
4717     int	    started = compl_started;
4718 
4719     /* When user complete function return -1 for findstart which is next
4720      * time of 'always', compl_shown_match become NULL. */
4721     if (compl_shown_match == NULL)
4722 	return -1;
4723 
4724     if (compl_leader != NULL
4725 			&& (compl_shown_match->cp_flags & ORIGINAL_TEXT) == 0)
4726     {
4727 	/* Set "compl_shown_match" to the actually shown match, it may differ
4728 	 * when "compl_leader" is used to omit some of the matches. */
4729 	while (!ins_compl_equal(compl_shown_match,
4730 				      compl_leader, (int)STRLEN(compl_leader))
4731 		&& compl_shown_match->cp_next != NULL
4732 		&& compl_shown_match->cp_next != compl_first_match)
4733 	    compl_shown_match = compl_shown_match->cp_next;
4734 
4735 	/* If we didn't find it searching forward, and compl_shows_dir is
4736 	 * backward, find the last match. */
4737 	if (compl_shows_dir == BACKWARD
4738 		&& !ins_compl_equal(compl_shown_match,
4739 				      compl_leader, (int)STRLEN(compl_leader))
4740 		&& (compl_shown_match->cp_next == NULL
4741 		    || compl_shown_match->cp_next == compl_first_match))
4742 	{
4743 	    while (!ins_compl_equal(compl_shown_match,
4744 				      compl_leader, (int)STRLEN(compl_leader))
4745 		    && compl_shown_match->cp_prev != NULL
4746 		    && compl_shown_match->cp_prev != compl_first_match)
4747 		compl_shown_match = compl_shown_match->cp_prev;
4748 	}
4749     }
4750 
4751     if (allow_get_expansion && insert_match
4752 	    && (!(compl_get_longest || compl_restarting) || compl_used_match))
4753 	/* Delete old text to be replaced */
4754 	ins_compl_delete();
4755 
4756     /* When finding the longest common text we stick at the original text,
4757      * don't let CTRL-N or CTRL-P move to the first match. */
4758     advance = count != 1 || !allow_get_expansion || !compl_get_longest;
4759 
4760     /* When restarting the search don't insert the first match either. */
4761     if (compl_restarting)
4762     {
4763 	advance = FALSE;
4764 	compl_restarting = FALSE;
4765     }
4766 
4767     /* Repeat this for when <PageUp> or <PageDown> is typed.  But don't wrap
4768      * around. */
4769     while (--todo >= 0)
4770     {
4771 	if (compl_shows_dir == FORWARD && compl_shown_match->cp_next != NULL)
4772 	{
4773 	    compl_shown_match = compl_shown_match->cp_next;
4774 	    found_end = (compl_first_match != NULL
4775 			   && (compl_shown_match->cp_next == compl_first_match
4776 			       || compl_shown_match == compl_first_match));
4777 	}
4778 	else if (compl_shows_dir == BACKWARD
4779 					&& compl_shown_match->cp_prev != NULL)
4780 	{
4781 	    found_end = (compl_shown_match == compl_first_match);
4782 	    compl_shown_match = compl_shown_match->cp_prev;
4783 	    found_end |= (compl_shown_match == compl_first_match);
4784 	}
4785 	else
4786 	{
4787 	    if (!allow_get_expansion)
4788 	    {
4789 		if (advance)
4790 		{
4791 		    if (compl_shows_dir == BACKWARD)
4792 			compl_pending -= todo + 1;
4793 		    else
4794 			compl_pending += todo + 1;
4795 		}
4796 		return -1;
4797 	    }
4798 
4799 	    if (!compl_no_select && advance)
4800 	    {
4801 		if (compl_shows_dir == BACKWARD)
4802 		    --compl_pending;
4803 		else
4804 		    ++compl_pending;
4805 	    }
4806 
4807 	    /* Find matches. */
4808 	    num_matches = ins_compl_get_exp(&compl_startpos);
4809 
4810 	    /* handle any pending completions */
4811 	    while (compl_pending != 0 && compl_direction == compl_shows_dir
4812 								   && advance)
4813 	    {
4814 		if (compl_pending > 0 && compl_shown_match->cp_next != NULL)
4815 		{
4816 		    compl_shown_match = compl_shown_match->cp_next;
4817 		    --compl_pending;
4818 		}
4819 		if (compl_pending < 0 && compl_shown_match->cp_prev != NULL)
4820 		{
4821 		    compl_shown_match = compl_shown_match->cp_prev;
4822 		    ++compl_pending;
4823 		}
4824 		else
4825 		    break;
4826 	    }
4827 	    found_end = FALSE;
4828 	}
4829 	if ((compl_shown_match->cp_flags & ORIGINAL_TEXT) == 0
4830 		&& compl_leader != NULL
4831 		&& !ins_compl_equal(compl_shown_match,
4832 				     compl_leader, (int)STRLEN(compl_leader)))
4833 	    ++todo;
4834 	else
4835 	    /* Remember a matching item. */
4836 	    found_compl = compl_shown_match;
4837 
4838 	/* Stop at the end of the list when we found a usable match. */
4839 	if (found_end)
4840 	{
4841 	    if (found_compl != NULL)
4842 	    {
4843 		compl_shown_match = found_compl;
4844 		break;
4845 	    }
4846 	    todo = 1;	    /* use first usable match after wrapping around */
4847 	}
4848     }
4849 
4850     /* Insert the text of the new completion, or the compl_leader. */
4851     if (compl_no_insert && !started)
4852     {
4853 	ins_bytes(compl_orig_text + ins_compl_len());
4854 	compl_used_match = FALSE;
4855     }
4856     else if (insert_match)
4857     {
4858 	if (!compl_get_longest || compl_used_match)
4859 	    ins_compl_insert();
4860 	else
4861 	    ins_bytes(compl_leader + ins_compl_len());
4862     }
4863     else
4864 	compl_used_match = FALSE;
4865 
4866     if (!allow_get_expansion)
4867     {
4868 	/* may undisplay the popup menu first */
4869 	ins_compl_upd_pum();
4870 
4871 	/* redraw to show the user what was inserted */
4872 	update_screen(0);
4873 
4874 	/* display the updated popup menu */
4875 	ins_compl_show_pum();
4876 #ifdef FEAT_GUI
4877 	if (gui.in_use)
4878 	{
4879 	    /* Show the cursor after the match, not after the redrawn text. */
4880 	    setcursor();
4881 	    out_flush();
4882 	    gui_update_cursor(FALSE, FALSE);
4883 	}
4884 #endif
4885 
4886 	/* Delete old text to be replaced, since we're still searching and
4887 	 * don't want to match ourselves!  */
4888 	ins_compl_delete();
4889     }
4890 
4891     /* Enter will select a match when the match wasn't inserted and the popup
4892      * menu is visible. */
4893     if (compl_no_insert && !started)
4894 	compl_enter_selects = TRUE;
4895     else
4896 	compl_enter_selects = !insert_match && compl_match_array != NULL;
4897 
4898     /*
4899      * Show the file name for the match (if any)
4900      * Truncate the file name to avoid a wait for return.
4901      */
4902     if (compl_shown_match->cp_fname != NULL)
4903     {
4904 	STRCPY(IObuff, "match in file ");
4905 	i = (vim_strsize(compl_shown_match->cp_fname) + 16) - sc_col;
4906 	if (i <= 0)
4907 	    i = 0;
4908 	else
4909 	    STRCAT(IObuff, "<");
4910 	STRCAT(IObuff, compl_shown_match->cp_fname + i);
4911 	msg(IObuff);
4912 	redraw_cmdline = FALSE;	    /* don't overwrite! */
4913     }
4914 
4915     return num_matches;
4916 }
4917 
4918 /*
4919  * Call this while finding completions, to check whether the user has hit a key
4920  * that should change the currently displayed completion, or exit completion
4921  * mode.  Also, when compl_pending is not zero, show a completion as soon as
4922  * possible. -- webb
4923  * "frequency" specifies out of how many calls we actually check.
4924  */
4925     void
4926 ins_compl_check_keys(int frequency)
4927 {
4928     static int	count = 0;
4929 
4930     int	    c;
4931 
4932     /* Don't check when reading keys from a script.  That would break the test
4933      * scripts */
4934     if (using_script())
4935 	return;
4936 
4937     /* Only do this at regular intervals */
4938     if (++count < frequency)
4939 	return;
4940     count = 0;
4941 
4942     /* Check for a typed key.  Do use mappings, otherwise vim_is_ctrl_x_key()
4943      * can't do its work correctly. */
4944     c = vpeekc_any();
4945     if (c != NUL)
4946     {
4947 	if (vim_is_ctrl_x_key(c) && c != Ctrl_X && c != Ctrl_R)
4948 	{
4949 	    c = safe_vgetc();	/* Eat the character */
4950 	    compl_shows_dir = ins_compl_key2dir(c);
4951 	    (void)ins_compl_next(FALSE, ins_compl_key2count(c),
4952 						    c != K_UP && c != K_DOWN);
4953 	}
4954 	else
4955 	{
4956 	    /* Need to get the character to have KeyTyped set.  We'll put it
4957 	     * back with vungetc() below.  But skip K_IGNORE. */
4958 	    c = safe_vgetc();
4959 	    if (c != K_IGNORE)
4960 	    {
4961 		/* Don't interrupt completion when the character wasn't typed,
4962 		 * e.g., when doing @q to replay keys. */
4963 		if (c != Ctrl_R && KeyTyped)
4964 		    compl_interrupted = TRUE;
4965 
4966 		vungetc(c);
4967 	    }
4968 	}
4969     }
4970     if (compl_pending != 0 && !got_int && !compl_no_insert)
4971     {
4972 	int todo = compl_pending > 0 ? compl_pending : -compl_pending;
4973 
4974 	compl_pending = 0;
4975 	(void)ins_compl_next(FALSE, todo, TRUE);
4976     }
4977 }
4978 
4979 /*
4980  * Decide the direction of Insert mode complete from the key typed.
4981  * Returns BACKWARD or FORWARD.
4982  */
4983     static int
4984 ins_compl_key2dir(int c)
4985 {
4986     if (c == Ctrl_P || c == Ctrl_L
4987 	    || c == K_PAGEUP || c == K_KPAGEUP || c == K_S_UP || c == K_UP)
4988 	return BACKWARD;
4989     return FORWARD;
4990 }
4991 
4992 /*
4993  * Return TRUE for keys that are used for completion only when the popup menu
4994  * is visible.
4995  */
4996     static int
4997 ins_compl_pum_key(int c)
4998 {
4999     return pum_visible() && (c == K_PAGEUP || c == K_KPAGEUP || c == K_S_UP
5000 		     || c == K_PAGEDOWN || c == K_KPAGEDOWN || c == K_S_DOWN
5001 		     || c == K_UP || c == K_DOWN);
5002 }
5003 
5004 /*
5005  * Decide the number of completions to move forward.
5006  * Returns 1 for most keys, height of the popup menu for page-up/down keys.
5007  */
5008     static int
5009 ins_compl_key2count(int c)
5010 {
5011     int		h;
5012 
5013     if (ins_compl_pum_key(c) && c != K_UP && c != K_DOWN)
5014     {
5015 	h = pum_get_height();
5016 	if (h > 3)
5017 	    h -= 2; /* keep some context */
5018 	return h;
5019     }
5020     return 1;
5021 }
5022 
5023 /*
5024  * Return TRUE if completion with "c" should insert the match, FALSE if only
5025  * to change the currently selected completion.
5026  */
5027     static int
5028 ins_compl_use_match(int c)
5029 {
5030     switch (c)
5031     {
5032 	case K_UP:
5033 	case K_DOWN:
5034 	case K_PAGEDOWN:
5035 	case K_KPAGEDOWN:
5036 	case K_S_DOWN:
5037 	case K_PAGEUP:
5038 	case K_KPAGEUP:
5039 	case K_S_UP:
5040 	    return FALSE;
5041     }
5042     return TRUE;
5043 }
5044 
5045 /*
5046  * Do Insert mode completion.
5047  * Called when character "c" was typed, which has a meaning for completion.
5048  * Returns OK if completion was done, FAIL if something failed (out of mem).
5049  */
5050     static int
5051 ins_complete(int c, int enable_pum)
5052 {
5053     char_u	*line;
5054     int		startcol = 0;	    /* column where searched text starts */
5055     colnr_T	curs_col;	    /* cursor column */
5056     int		n;
5057     int		save_w_wrow;
5058 
5059     compl_direction = ins_compl_key2dir(c);
5060     if (!compl_started)
5061     {
5062 	/* First time we hit ^N or ^P (in a row, I mean) */
5063 
5064 	did_ai = FALSE;
5065 #ifdef FEAT_SMARTINDENT
5066 	did_si = FALSE;
5067 	can_si = FALSE;
5068 	can_si_back = FALSE;
5069 #endif
5070 	if (stop_arrow() == FAIL)
5071 	    return FAIL;
5072 
5073 	line = ml_get(curwin->w_cursor.lnum);
5074 	curs_col = curwin->w_cursor.col;
5075 	compl_pending = 0;
5076 
5077 	/* If this same ctrl_x_mode has been interrupted use the text from
5078 	 * "compl_startpos" to the cursor as a pattern to add a new word
5079 	 * instead of expand the one before the cursor, in word-wise if
5080 	 * "compl_startpos" is not in the same line as the cursor then fix it
5081 	 * (the line has been split because it was longer than 'tw').  if SOL
5082 	 * is set then skip the previous pattern, a word at the beginning of
5083 	 * the line has been inserted, we'll look for that  -- Acevedo. */
5084 	if ((compl_cont_status & CONT_INTRPT) == CONT_INTRPT
5085 					    && compl_cont_mode == ctrl_x_mode)
5086 	{
5087 	    /*
5088 	     * it is a continued search
5089 	     */
5090 	    compl_cont_status &= ~CONT_INTRPT;	/* remove INTRPT */
5091 	    if (ctrl_x_mode == 0 || ctrl_x_mode == CTRL_X_PATH_PATTERNS
5092 					|| ctrl_x_mode == CTRL_X_PATH_DEFINES)
5093 	    {
5094 		if (compl_startpos.lnum != curwin->w_cursor.lnum)
5095 		{
5096 		    /* line (probably) wrapped, set compl_startpos to the
5097 		     * first non_blank in the line, if it is not a wordchar
5098 		     * include it to get a better pattern, but then we don't
5099 		     * want the "\\<" prefix, check it bellow */
5100 		    compl_col = (colnr_T)(skipwhite(line) - line);
5101 		    compl_startpos.col = compl_col;
5102 		    compl_startpos.lnum = curwin->w_cursor.lnum;
5103 		    compl_cont_status &= ~CONT_SOL;   /* clear SOL if present */
5104 		}
5105 		else
5106 		{
5107 		    /* S_IPOS was set when we inserted a word that was at the
5108 		     * beginning of the line, which means that we'll go to SOL
5109 		     * mode but first we need to redefine compl_startpos */
5110 		    if (compl_cont_status & CONT_S_IPOS)
5111 		    {
5112 			compl_cont_status |= CONT_SOL;
5113 			compl_startpos.col = (colnr_T)(skipwhite(
5114 						line + compl_length
5115 						+ compl_startpos.col) - line);
5116 		    }
5117 		    compl_col = compl_startpos.col;
5118 		}
5119 		compl_length = curwin->w_cursor.col - (int)compl_col;
5120 		/* IObuff is used to add a "word from the next line" would we
5121 		 * have enough space?  just being paranoid */
5122 #define	MIN_SPACE 75
5123 		if (compl_length > (IOSIZE - MIN_SPACE))
5124 		{
5125 		    compl_cont_status &= ~CONT_SOL;
5126 		    compl_length = (IOSIZE - MIN_SPACE);
5127 		    compl_col = curwin->w_cursor.col - compl_length;
5128 		}
5129 		compl_cont_status |= CONT_ADDING | CONT_N_ADDS;
5130 		if (compl_length < 1)
5131 		    compl_cont_status &= CONT_LOCAL;
5132 	    }
5133 	    else if (CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
5134 		compl_cont_status = CONT_ADDING | CONT_N_ADDS;
5135 	    else
5136 		compl_cont_status = 0;
5137 	}
5138 	else
5139 	    compl_cont_status &= CONT_LOCAL;
5140 
5141 	if (!(compl_cont_status & CONT_ADDING))	/* normal expansion */
5142 	{
5143 	    compl_cont_mode = ctrl_x_mode;
5144 	    if (ctrl_x_mode != 0)	/* Remove LOCAL if ctrl_x_mode != 0 */
5145 		compl_cont_status = 0;
5146 	    compl_cont_status |= CONT_N_ADDS;
5147 	    compl_startpos = curwin->w_cursor;
5148 	    startcol = (int)curs_col;
5149 	    compl_col = 0;
5150 	}
5151 
5152 	/* Work out completion pattern and original text -- webb */
5153 	if (ctrl_x_mode == 0 || (ctrl_x_mode & CTRL_X_WANT_IDENT))
5154 	{
5155 	    if ((compl_cont_status & CONT_SOL)
5156 		    || ctrl_x_mode == CTRL_X_PATH_DEFINES)
5157 	    {
5158 		if (!(compl_cont_status & CONT_ADDING))
5159 		{
5160 		    while (--startcol >= 0 && vim_isIDc(line[startcol]))
5161 			;
5162 		    compl_col += ++startcol;
5163 		    compl_length = curs_col - startcol;
5164 		}
5165 		if (p_ic)
5166 		    compl_pattern = str_foldcase(line + compl_col,
5167 						       compl_length, NULL, 0);
5168 		else
5169 		    compl_pattern = vim_strnsave(line + compl_col,
5170 								compl_length);
5171 		if (compl_pattern == NULL)
5172 		    return FAIL;
5173 	    }
5174 	    else if (compl_cont_status & CONT_ADDING)
5175 	    {
5176 		char_u	    *prefix = (char_u *)"\\<";
5177 
5178 		/* we need up to 2 extra chars for the prefix */
5179 		compl_pattern = alloc(quote_meta(NULL, line + compl_col,
5180 							   compl_length) + 2);
5181 		if (compl_pattern == NULL)
5182 		    return FAIL;
5183 		if (!vim_iswordp(line + compl_col)
5184 			|| (compl_col > 0
5185 			    && (
5186 #ifdef FEAT_MBYTE
5187 				vim_iswordp(mb_prevptr(line, line + compl_col))
5188 #else
5189 				vim_iswordc(line[compl_col - 1])
5190 #endif
5191 				)))
5192 		    prefix = (char_u *)"";
5193 		STRCPY((char *)compl_pattern, prefix);
5194 		(void)quote_meta(compl_pattern + STRLEN(prefix),
5195 					      line + compl_col, compl_length);
5196 	    }
5197 	    else if (--startcol < 0 ||
5198 #ifdef FEAT_MBYTE
5199 			   !vim_iswordp(mb_prevptr(line, line + startcol + 1))
5200 #else
5201 			   !vim_iswordc(line[startcol])
5202 #endif
5203 		    )
5204 	    {
5205 		/* Match any word of at least two chars */
5206 		compl_pattern = vim_strsave((char_u *)"\\<\\k\\k");
5207 		if (compl_pattern == NULL)
5208 		    return FAIL;
5209 		compl_col += curs_col;
5210 		compl_length = 0;
5211 	    }
5212 	    else
5213 	    {
5214 #ifdef FEAT_MBYTE
5215 		/* Search the point of change class of multibyte character
5216 		 * or not a word single byte character backward.  */
5217 		if (has_mbyte)
5218 		{
5219 		    int base_class;
5220 		    int head_off;
5221 
5222 		    startcol -= (*mb_head_off)(line, line + startcol);
5223 		    base_class = mb_get_class(line + startcol);
5224 		    while (--startcol >= 0)
5225 		    {
5226 			head_off = (*mb_head_off)(line, line + startcol);
5227 			if (base_class != mb_get_class(line + startcol
5228 								  - head_off))
5229 			    break;
5230 			startcol -= head_off;
5231 		    }
5232 		}
5233 		else
5234 #endif
5235 		    while (--startcol >= 0 && vim_iswordc(line[startcol]))
5236 			;
5237 		compl_col += ++startcol;
5238 		compl_length = (int)curs_col - startcol;
5239 		if (compl_length == 1)
5240 		{
5241 		    /* Only match word with at least two chars -- webb
5242 		     * there's no need to call quote_meta,
5243 		     * alloc(7) is enough  -- Acevedo
5244 		     */
5245 		    compl_pattern = alloc(7);
5246 		    if (compl_pattern == NULL)
5247 			return FAIL;
5248 		    STRCPY((char *)compl_pattern, "\\<");
5249 		    (void)quote_meta(compl_pattern + 2, line + compl_col, 1);
5250 		    STRCAT((char *)compl_pattern, "\\k");
5251 		}
5252 		else
5253 		{
5254 		    compl_pattern = alloc(quote_meta(NULL, line + compl_col,
5255 							   compl_length) + 2);
5256 		    if (compl_pattern == NULL)
5257 			return FAIL;
5258 		    STRCPY((char *)compl_pattern, "\\<");
5259 		    (void)quote_meta(compl_pattern + 2, line + compl_col,
5260 								compl_length);
5261 		}
5262 	    }
5263 	}
5264 	else if (CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
5265 	{
5266 	    compl_col = (colnr_T)(skipwhite(line) - line);
5267 	    compl_length = (int)curs_col - (int)compl_col;
5268 	    if (compl_length < 0)	/* cursor in indent: empty pattern */
5269 		compl_length = 0;
5270 	    if (p_ic)
5271 		compl_pattern = str_foldcase(line + compl_col, compl_length,
5272 								     NULL, 0);
5273 	    else
5274 		compl_pattern = vim_strnsave(line + compl_col, compl_length);
5275 	    if (compl_pattern == NULL)
5276 		return FAIL;
5277 	}
5278 	else if (ctrl_x_mode == CTRL_X_FILES)
5279 	{
5280 	    /* Go back to just before the first filename character. */
5281 	    if (startcol > 0)
5282 	    {
5283 		char_u	*p = line + startcol;
5284 
5285 		mb_ptr_back(line, p);
5286 		while (p > line && vim_isfilec(PTR2CHAR(p)))
5287 		    mb_ptr_back(line, p);
5288 		if (p == line && vim_isfilec(PTR2CHAR(p)))
5289 		    startcol = 0;
5290 		else
5291 		    startcol = (int)(p - line) + 1;
5292 	    }
5293 
5294 	    compl_col += startcol;
5295 	    compl_length = (int)curs_col - startcol;
5296 	    compl_pattern = addstar(line + compl_col, compl_length,
5297 								EXPAND_FILES);
5298 	    if (compl_pattern == NULL)
5299 		return FAIL;
5300 	}
5301 	else if (ctrl_x_mode == CTRL_X_CMDLINE)
5302 	{
5303 	    compl_pattern = vim_strnsave(line, curs_col);
5304 	    if (compl_pattern == NULL)
5305 		return FAIL;
5306 	    set_cmd_context(&compl_xp, compl_pattern,
5307 				  (int)STRLEN(compl_pattern), curs_col, FALSE);
5308 	    if (compl_xp.xp_context == EXPAND_UNSUCCESSFUL
5309 		    || compl_xp.xp_context == EXPAND_NOTHING)
5310 		/* No completion possible, use an empty pattern to get a
5311 		 * "pattern not found" message. */
5312 		compl_col = curs_col;
5313 	    else
5314 		compl_col = (int)(compl_xp.xp_pattern - compl_pattern);
5315 	    compl_length = curs_col - compl_col;
5316 	}
5317 	else if (ctrl_x_mode == CTRL_X_FUNCTION || ctrl_x_mode == CTRL_X_OMNI)
5318 	{
5319 #ifdef FEAT_COMPL_FUNC
5320 	    /*
5321 	     * Call user defined function 'completefunc' with "a:findstart"
5322 	     * set to 1 to obtain the length of text to use for completion.
5323 	     */
5324 	    char_u	*args[2];
5325 	    int		col;
5326 	    char_u	*funcname;
5327 	    pos_T	pos;
5328 	    win_T	*curwin_save;
5329 	    buf_T	*curbuf_save;
5330 
5331 	    /* Call 'completefunc' or 'omnifunc' and get pattern length as a
5332 	     * string */
5333 	    funcname = ctrl_x_mode == CTRL_X_FUNCTION
5334 					  ? curbuf->b_p_cfu : curbuf->b_p_ofu;
5335 	    if (*funcname == NUL)
5336 	    {
5337 		EMSG2(_(e_notset), ctrl_x_mode == CTRL_X_FUNCTION
5338 					     ? "completefunc" : "omnifunc");
5339 		return FAIL;
5340 	    }
5341 
5342 	    args[0] = (char_u *)"1";
5343 	    args[1] = NULL;
5344 	    pos = curwin->w_cursor;
5345 	    curwin_save = curwin;
5346 	    curbuf_save = curbuf;
5347 	    col = call_func_retnr(funcname, 2, args, FALSE);
5348 	    if (curwin_save != curwin || curbuf_save != curbuf)
5349 	    {
5350 		EMSG(_(e_complwin));
5351 		return FAIL;
5352 	    }
5353 	    curwin->w_cursor = pos;	/* restore the cursor position */
5354 	    validate_cursor();
5355 	    if (!equalpos(curwin->w_cursor, pos))
5356 	    {
5357 		EMSG(_(e_compldel));
5358 		return FAIL;
5359 	    }
5360 
5361 	    /* Return value -2 means the user complete function wants to
5362 	     * cancel the complete without an error.
5363 	     * Return value -3 does the same as -2 and leaves CTRL-X mode.*/
5364 	    if (col == -2)
5365 		return FAIL;
5366 	    if (col == -3)
5367 	    {
5368 		ctrl_x_mode = 0;
5369 		edit_submode = NULL;
5370 		if (!shortmess(SHM_COMPLETIONMENU))
5371 		    msg_clr_cmdline();
5372 		return FAIL;
5373 	    }
5374 
5375 	    /*
5376 	     * Reset extended parameters of completion, when start new
5377 	     * completion.
5378 	     */
5379 	    compl_opt_refresh_always = FALSE;
5380 
5381 	    if (col < 0)
5382 		col = curs_col;
5383 	    compl_col = col;
5384 	    if (compl_col > curs_col)
5385 		compl_col = curs_col;
5386 
5387 	    /* Setup variables for completion.  Need to obtain "line" again,
5388 	     * it may have become invalid. */
5389 	    line = ml_get(curwin->w_cursor.lnum);
5390 	    compl_length = curs_col - compl_col;
5391 	    compl_pattern = vim_strnsave(line + compl_col, compl_length);
5392 	    if (compl_pattern == NULL)
5393 #endif
5394 		return FAIL;
5395 	}
5396 	else if (ctrl_x_mode == CTRL_X_SPELL)
5397 	{
5398 #ifdef FEAT_SPELL
5399 	    if (spell_bad_len > 0)
5400 		compl_col = curs_col - spell_bad_len;
5401 	    else
5402 		compl_col = spell_word_start(startcol);
5403 	    if (compl_col >= (colnr_T)startcol)
5404 	    {
5405 		compl_length = 0;
5406 		compl_col = curs_col;
5407 	    }
5408 	    else
5409 	    {
5410 		spell_expand_check_cap(compl_col);
5411 		compl_length = (int)curs_col - compl_col;
5412 	    }
5413 	    /* Need to obtain "line" again, it may have become invalid. */
5414 	    line = ml_get(curwin->w_cursor.lnum);
5415 	    compl_pattern = vim_strnsave(line + compl_col, compl_length);
5416 	    if (compl_pattern == NULL)
5417 #endif
5418 		return FAIL;
5419 	}
5420 	else
5421 	{
5422 	    EMSG2(_(e_intern2), "ins_complete()");
5423 	    return FAIL;
5424 	}
5425 
5426 	if (compl_cont_status & CONT_ADDING)
5427 	{
5428 	    edit_submode_pre = (char_u *)_(" Adding");
5429 	    if (CTRL_X_MODE_LINE_OR_EVAL(ctrl_x_mode))
5430 	    {
5431 		/* Insert a new line, keep indentation but ignore 'comments' */
5432 #ifdef FEAT_COMMENTS
5433 		char_u *old = curbuf->b_p_com;
5434 
5435 		curbuf->b_p_com = (char_u *)"";
5436 #endif
5437 		compl_startpos.lnum = curwin->w_cursor.lnum;
5438 		compl_startpos.col = compl_col;
5439 		ins_eol('\r');
5440 #ifdef FEAT_COMMENTS
5441 		curbuf->b_p_com = old;
5442 #endif
5443 		compl_length = 0;
5444 		compl_col = curwin->w_cursor.col;
5445 	    }
5446 	}
5447 	else
5448 	{
5449 	    edit_submode_pre = NULL;
5450 	    compl_startpos.col = compl_col;
5451 	}
5452 
5453 	if (compl_cont_status & CONT_LOCAL)
5454 	    edit_submode = (char_u *)_(ctrl_x_msgs[CTRL_X_LOCAL_MSG]);
5455 	else
5456 	    edit_submode = (char_u *)_(CTRL_X_MSG(ctrl_x_mode));
5457 
5458 	/* If any of the original typed text has been changed we need to fix
5459 	 * the redo buffer. */
5460 	ins_compl_fixRedoBufForLeader(NULL);
5461 
5462 	/* Always add completion for the original text. */
5463 	vim_free(compl_orig_text);
5464 	compl_orig_text = vim_strnsave(line + compl_col, compl_length);
5465 	if (compl_orig_text == NULL || ins_compl_add(compl_orig_text,
5466 			-1, p_ic, NULL, NULL, 0, ORIGINAL_TEXT, FALSE) != OK)
5467 	{
5468 	    vim_free(compl_pattern);
5469 	    compl_pattern = NULL;
5470 	    vim_free(compl_orig_text);
5471 	    compl_orig_text = NULL;
5472 	    return FAIL;
5473 	}
5474 
5475 	/* showmode might reset the internal line pointers, so it must
5476 	 * be called before line = ml_get(), or when this address is no
5477 	 * longer needed.  -- Acevedo.
5478 	 */
5479 	edit_submode_extra = (char_u *)_("-- Searching...");
5480 	edit_submode_highl = HLF_COUNT;
5481 	showmode();
5482 	edit_submode_extra = NULL;
5483 	out_flush();
5484     }
5485 
5486     compl_shown_match = compl_curr_match;
5487     compl_shows_dir = compl_direction;
5488 
5489     /*
5490      * Find next match (and following matches).
5491      */
5492     save_w_wrow = curwin->w_wrow;
5493     n = ins_compl_next(TRUE, ins_compl_key2count(c), ins_compl_use_match(c));
5494 
5495     /* may undisplay the popup menu */
5496     ins_compl_upd_pum();
5497 
5498     if (n > 1)		/* all matches have been found */
5499 	compl_matches = n;
5500     compl_curr_match = compl_shown_match;
5501     compl_direction = compl_shows_dir;
5502 
5503     /* Eat the ESC that vgetc() returns after a CTRL-C to avoid leaving Insert
5504      * mode. */
5505     if (got_int && !global_busy)
5506     {
5507 	(void)vgetc();
5508 	got_int = FALSE;
5509     }
5510 
5511     /* we found no match if the list has only the "compl_orig_text"-entry */
5512     if (compl_first_match == compl_first_match->cp_next)
5513     {
5514 	edit_submode_extra = (compl_cont_status & CONT_ADDING)
5515 			&& compl_length > 1
5516 			     ? (char_u *)_(e_hitend) : (char_u *)_(e_patnotf);
5517 	edit_submode_highl = HLF_E;
5518 	/* remove N_ADDS flag, so next ^X<> won't try to go to ADDING mode,
5519 	 * because we couldn't expand anything at first place, but if we used
5520 	 * ^P, ^N, ^X^I or ^X^D we might want to add-expand a single-char-word
5521 	 * (such as M in M'exico) if not tried already.  -- Acevedo */
5522 	if (	   compl_length > 1
5523 		|| (compl_cont_status & CONT_ADDING)
5524 		|| (ctrl_x_mode != 0
5525 		    && ctrl_x_mode != CTRL_X_PATH_PATTERNS
5526 		    && ctrl_x_mode != CTRL_X_PATH_DEFINES))
5527 	    compl_cont_status &= ~CONT_N_ADDS;
5528     }
5529 
5530     if (compl_curr_match->cp_flags & CONT_S_IPOS)
5531 	compl_cont_status |= CONT_S_IPOS;
5532     else
5533 	compl_cont_status &= ~CONT_S_IPOS;
5534 
5535     if (edit_submode_extra == NULL)
5536     {
5537 	if (compl_curr_match->cp_flags & ORIGINAL_TEXT)
5538 	{
5539 	    edit_submode_extra = (char_u *)_("Back at original");
5540 	    edit_submode_highl = HLF_W;
5541 	}
5542 	else if (compl_cont_status & CONT_S_IPOS)
5543 	{
5544 	    edit_submode_extra = (char_u *)_("Word from other line");
5545 	    edit_submode_highl = HLF_COUNT;
5546 	}
5547 	else if (compl_curr_match->cp_next == compl_curr_match->cp_prev)
5548 	{
5549 	    edit_submode_extra = (char_u *)_("The only match");
5550 	    edit_submode_highl = HLF_COUNT;
5551 	}
5552 	else
5553 	{
5554 	    /* Update completion sequence number when needed. */
5555 	    if (compl_curr_match->cp_number == -1)
5556 	    {
5557 		int		number = 0;
5558 		compl_T		*match;
5559 
5560 		if (compl_direction == FORWARD)
5561 		{
5562 		    /* search backwards for the first valid (!= -1) number.
5563 		     * This should normally succeed already at the first loop
5564 		     * cycle, so it's fast! */
5565 		    for (match = compl_curr_match->cp_prev; match != NULL
5566 			    && match != compl_first_match;
5567 						       match = match->cp_prev)
5568 			if (match->cp_number != -1)
5569 			{
5570 			    number = match->cp_number;
5571 			    break;
5572 			}
5573 		    if (match != NULL)
5574 			/* go up and assign all numbers which are not assigned
5575 			 * yet */
5576 			for (match = match->cp_next;
5577 				match != NULL && match->cp_number == -1;
5578 						       match = match->cp_next)
5579 			    match->cp_number = ++number;
5580 		}
5581 		else /* BACKWARD */
5582 		{
5583 		    /* search forwards (upwards) for the first valid (!= -1)
5584 		     * number.  This should normally succeed already at the
5585 		     * first loop cycle, so it's fast! */
5586 		    for (match = compl_curr_match->cp_next; match != NULL
5587 			    && match != compl_first_match;
5588 						       match = match->cp_next)
5589 			if (match->cp_number != -1)
5590 			{
5591 			    number = match->cp_number;
5592 			    break;
5593 			}
5594 		    if (match != NULL)
5595 			/* go down and assign all numbers which are not
5596 			 * assigned yet */
5597 			for (match = match->cp_prev; match
5598 				&& match->cp_number == -1;
5599 						       match = match->cp_prev)
5600 			    match->cp_number = ++number;
5601 		}
5602 	    }
5603 
5604 	    /* The match should always have a sequence number now, this is
5605 	     * just a safety check. */
5606 	    if (compl_curr_match->cp_number != -1)
5607 	    {
5608 		/* Space for 10 text chars. + 2x10-digit no.s = 31.
5609 		 * Translations may need more than twice that. */
5610 		static char_u match_ref[81];
5611 
5612 		if (compl_matches > 0)
5613 		    vim_snprintf((char *)match_ref, sizeof(match_ref),
5614 				_("match %d of %d"),
5615 				compl_curr_match->cp_number, compl_matches);
5616 		else
5617 		    vim_snprintf((char *)match_ref, sizeof(match_ref),
5618 				_("match %d"),
5619 				compl_curr_match->cp_number);
5620 		edit_submode_extra = match_ref;
5621 		edit_submode_highl = HLF_R;
5622 		if (dollar_vcol >= 0)
5623 		    curs_columns(FALSE);
5624 	    }
5625 	}
5626     }
5627 
5628     /* Show a message about what (completion) mode we're in. */
5629     showmode();
5630     if (!shortmess(SHM_COMPLETIONMENU))
5631     {
5632 	if (edit_submode_extra != NULL)
5633 	{
5634 	    if (!p_smd)
5635 		msg_attr(edit_submode_extra,
5636 			edit_submode_highl < HLF_COUNT
5637 			? hl_attr(edit_submode_highl) : 0);
5638 	}
5639 	else
5640 	    msg_clr_cmdline();	/* necessary for "noshowmode" */
5641     }
5642 
5643     /* Show the popup menu, unless we got interrupted. */
5644     if (enable_pum && !compl_interrupted)
5645     {
5646 	show_pum(save_w_wrow);
5647     }
5648     compl_was_interrupted = compl_interrupted;
5649     compl_interrupted = FALSE;
5650 
5651     return OK;
5652 }
5653 
5654     static void
5655 show_pum(int save_w_wrow)
5656 {
5657   /* RedrawingDisabled may be set when invoked through complete(). */
5658   int n = RedrawingDisabled;
5659 
5660   RedrawingDisabled = 0;
5661 
5662   /* If the cursor moved we need to remove the pum first. */
5663   setcursor();
5664   if (save_w_wrow != curwin->w_wrow)
5665       ins_compl_del_pum();
5666 
5667   ins_compl_show_pum();
5668   setcursor();
5669   RedrawingDisabled = n;
5670 }
5671 
5672 /*
5673  * Looks in the first "len" chars. of "src" for search-metachars.
5674  * If dest is not NULL the chars. are copied there quoting (with
5675  * a backslash) the metachars, and dest would be NUL terminated.
5676  * Returns the length (needed) of dest
5677  */
5678     static unsigned
5679 quote_meta(char_u *dest, char_u *src, int len)
5680 {
5681     unsigned	m = (unsigned)len + 1;  /* one extra for the NUL */
5682 
5683     for ( ; --len >= 0; src++)
5684     {
5685 	switch (*src)
5686 	{
5687 	    case '.':
5688 	    case '*':
5689 	    case '[':
5690 		if (ctrl_x_mode == CTRL_X_DICTIONARY
5691 					   || ctrl_x_mode == CTRL_X_THESAURUS)
5692 		    break;
5693 	    case '~':
5694 		if (!p_magic)	/* quote these only if magic is set */
5695 		    break;
5696 	    case '\\':
5697 		if (ctrl_x_mode == CTRL_X_DICTIONARY
5698 					   || ctrl_x_mode == CTRL_X_THESAURUS)
5699 		    break;
5700 	    case '^':		/* currently it's not needed. */
5701 	    case '$':
5702 		m++;
5703 		if (dest != NULL)
5704 		    *dest++ = '\\';
5705 		break;
5706 	}
5707 	if (dest != NULL)
5708 	    *dest++ = *src;
5709 # ifdef FEAT_MBYTE
5710 	/* Copy remaining bytes of a multibyte character. */
5711 	if (has_mbyte)
5712 	{
5713 	    int i, mb_len;
5714 
5715 	    mb_len = (*mb_ptr2len)(src) - 1;
5716 	    if (mb_len > 0 && len >= mb_len)
5717 		for (i = 0; i < mb_len; ++i)
5718 		{
5719 		    --len;
5720 		    ++src;
5721 		    if (dest != NULL)
5722 			*dest++ = *src;
5723 		}
5724 	}
5725 # endif
5726     }
5727     if (dest != NULL)
5728 	*dest = NUL;
5729 
5730     return m;
5731 }
5732 #endif /* FEAT_INS_EXPAND */
5733 
5734 /*
5735  * Next character is interpreted literally.
5736  * A one, two or three digit decimal number is interpreted as its byte value.
5737  * If one or two digits are entered, the next character is given to vungetc().
5738  * For Unicode a character > 255 may be returned.
5739  */
5740     int
5741 get_literal(void)
5742 {
5743     int		cc;
5744     int		nc;
5745     int		i;
5746     int		hex = FALSE;
5747     int		octal = FALSE;
5748 #ifdef FEAT_MBYTE
5749     int		unicode = 0;
5750 #endif
5751 
5752     if (got_int)
5753 	return Ctrl_C;
5754 
5755 #ifdef FEAT_GUI
5756     /*
5757      * In GUI there is no point inserting the internal code for a special key.
5758      * It is more useful to insert the string "<KEY>" instead.	This would
5759      * probably be useful in a text window too, but it would not be
5760      * vi-compatible (maybe there should be an option for it?) -- webb
5761      */
5762     if (gui.in_use)
5763 	++allow_keys;
5764 #endif
5765 #ifdef USE_ON_FLY_SCROLL
5766     dont_scroll = TRUE;		/* disallow scrolling here */
5767 #endif
5768     ++no_mapping;		/* don't map the next key hits */
5769     cc = 0;
5770     i = 0;
5771     for (;;)
5772     {
5773 	nc = plain_vgetc();
5774 #ifdef FEAT_CMDL_INFO
5775 	if (!(State & CMDLINE)
5776 # ifdef FEAT_MBYTE
5777 		&& MB_BYTE2LEN_CHECK(nc) == 1
5778 # endif
5779 	   )
5780 	    add_to_showcmd(nc);
5781 #endif
5782 	if (nc == 'x' || nc == 'X')
5783 	    hex = TRUE;
5784 	else if (nc == 'o' || nc == 'O')
5785 	    octal = TRUE;
5786 #ifdef FEAT_MBYTE
5787 	else if (nc == 'u' || nc == 'U')
5788 	    unicode = nc;
5789 #endif
5790 	else
5791 	{
5792 	    if (hex
5793 #ifdef FEAT_MBYTE
5794 		    || unicode != 0
5795 #endif
5796 		    )
5797 	    {
5798 		if (!vim_isxdigit(nc))
5799 		    break;
5800 		cc = cc * 16 + hex2nr(nc);
5801 	    }
5802 	    else if (octal)
5803 	    {
5804 		if (nc < '0' || nc > '7')
5805 		    break;
5806 		cc = cc * 8 + nc - '0';
5807 	    }
5808 	    else
5809 	    {
5810 		if (!VIM_ISDIGIT(nc))
5811 		    break;
5812 		cc = cc * 10 + nc - '0';
5813 	    }
5814 
5815 	    ++i;
5816 	}
5817 
5818 	if (cc > 255
5819 #ifdef FEAT_MBYTE
5820 		&& unicode == 0
5821 #endif
5822 		)
5823 	    cc = 255;		/* limit range to 0-255 */
5824 	nc = 0;
5825 
5826 	if (hex)		/* hex: up to two chars */
5827 	{
5828 	    if (i >= 2)
5829 		break;
5830 	}
5831 #ifdef FEAT_MBYTE
5832 	else if (unicode)	/* Unicode: up to four or eight chars */
5833 	{
5834 	    if ((unicode == 'u' && i >= 4) || (unicode == 'U' && i >= 8))
5835 		break;
5836 	}
5837 #endif
5838 	else if (i >= 3)	/* decimal or octal: up to three chars */
5839 	    break;
5840     }
5841     if (i == 0)	    /* no number entered */
5842     {
5843 	if (nc == K_ZERO)   /* NUL is stored as NL */
5844 	{
5845 	    cc = '\n';
5846 	    nc = 0;
5847 	}
5848 	else
5849 	{
5850 	    cc = nc;
5851 	    nc = 0;
5852 	}
5853     }
5854 
5855     if (cc == 0)	/* NUL is stored as NL */
5856 	cc = '\n';
5857 #ifdef FEAT_MBYTE
5858     if (enc_dbcs && (cc & 0xff) == 0)
5859 	cc = '?';	/* don't accept an illegal DBCS char, the NUL in the
5860 			   second byte will cause trouble! */
5861 #endif
5862 
5863     --no_mapping;
5864 #ifdef FEAT_GUI
5865     if (gui.in_use)
5866 	--allow_keys;
5867 #endif
5868     if (nc)
5869 	vungetc(nc);
5870     got_int = FALSE;	    /* CTRL-C typed after CTRL-V is not an interrupt */
5871     return cc;
5872 }
5873 
5874 /*
5875  * Insert character, taking care of special keys and mod_mask
5876  */
5877     static void
5878 insert_special(
5879     int	    c,
5880     int	    allow_modmask,
5881     int	    ctrlv)	    /* c was typed after CTRL-V */
5882 {
5883     char_u  *p;
5884     int	    len;
5885 
5886     /*
5887      * Special function key, translate into "<Key>". Up to the last '>' is
5888      * inserted with ins_str(), so as not to replace characters in replace
5889      * mode.
5890      * Only use mod_mask for special keys, to avoid things like <S-Space>,
5891      * unless 'allow_modmask' is TRUE.
5892      */
5893 #ifdef MACOS
5894     /* Command-key never produces a normal key */
5895     if (mod_mask & MOD_MASK_CMD)
5896 	allow_modmask = TRUE;
5897 #endif
5898     if (IS_SPECIAL(c) || (mod_mask && allow_modmask))
5899     {
5900 	p = get_special_key_name(c, mod_mask);
5901 	len = (int)STRLEN(p);
5902 	c = p[len - 1];
5903 	if (len > 2)
5904 	{
5905 	    if (stop_arrow() == FAIL)
5906 		return;
5907 	    p[len - 1] = NUL;
5908 	    ins_str(p);
5909 	    AppendToRedobuffLit(p, -1);
5910 	    ctrlv = FALSE;
5911 	}
5912     }
5913     if (stop_arrow() == OK)
5914 	insertchar(c, ctrlv ? INSCHAR_CTRLV : 0, -1);
5915 }
5916 
5917 /*
5918  * Special characters in this context are those that need processing other
5919  * than the simple insertion that can be performed here. This includes ESC
5920  * which terminates the insert, and CR/NL which need special processing to
5921  * open up a new line. This routine tries to optimize insertions performed by
5922  * the "redo", "undo" or "put" commands, so it needs to know when it should
5923  * stop and defer processing to the "normal" mechanism.
5924  * '0' and '^' are special, because they can be followed by CTRL-D.
5925  */
5926 #ifdef EBCDIC
5927 # define ISSPECIAL(c)	((c) < ' ' || (c) == '0' || (c) == '^')
5928 #else
5929 # define ISSPECIAL(c)	((c) < ' ' || (c) >= DEL || (c) == '0' || (c) == '^')
5930 #endif
5931 
5932 #ifdef FEAT_MBYTE
5933 # define WHITECHAR(cc) (vim_iswhite(cc) && (!enc_utf8 || !utf_iscomposing(utf_ptr2char(ml_get_cursor() + 1))))
5934 #else
5935 # define WHITECHAR(cc) vim_iswhite(cc)
5936 #endif
5937 
5938 /*
5939  * "flags": INSCHAR_FORMAT - force formatting
5940  *	    INSCHAR_CTRLV  - char typed just after CTRL-V
5941  *	    INSCHAR_NO_FEX - don't use 'formatexpr'
5942  *
5943  *   NOTE: passes the flags value straight through to internal_format() which,
5944  *	   beside INSCHAR_FORMAT (above), is also looking for these:
5945  *	    INSCHAR_DO_COM   - format comments
5946  *	    INSCHAR_COM_LIST - format comments with num list or 2nd line indent
5947  */
5948     void
5949 insertchar(
5950     int		c,			/* character to insert or NUL */
5951     int		flags,			/* INSCHAR_FORMAT, etc. */
5952     int		second_indent)		/* indent for second line if >= 0 */
5953 {
5954     int		textwidth;
5955 #ifdef FEAT_COMMENTS
5956     char_u	*p;
5957 #endif
5958     int		fo_ins_blank;
5959     int		force_format = flags & INSCHAR_FORMAT;
5960 
5961     textwidth = comp_textwidth(force_format);
5962     fo_ins_blank = has_format_option(FO_INS_BLANK);
5963 
5964     /*
5965      * Try to break the line in two or more pieces when:
5966      * - Always do this if we have been called to do formatting only.
5967      * - Always do this when 'formatoptions' has the 'a' flag and the line
5968      *   ends in white space.
5969      * - Otherwise:
5970      *	 - Don't do this if inserting a blank
5971      *	 - Don't do this if an existing character is being replaced, unless
5972      *	   we're in VREPLACE mode.
5973      *	 - Do this if the cursor is not on the line where insert started
5974      *	 or - 'formatoptions' doesn't have 'l' or the line was not too long
5975      *	       before the insert.
5976      *	    - 'formatoptions' doesn't have 'b' or a blank was inserted at or
5977      *	      before 'textwidth'
5978      */
5979     if (textwidth > 0
5980 	    && (force_format
5981 		|| (!vim_iswhite(c)
5982 		    && !((State & REPLACE_FLAG)
5983 #ifdef FEAT_VREPLACE
5984 			&& !(State & VREPLACE_FLAG)
5985 #endif
5986 			&& *ml_get_cursor() != NUL)
5987 		    && (curwin->w_cursor.lnum != Insstart.lnum
5988 			|| ((!has_format_option(FO_INS_LONG)
5989 				|| Insstart_textlen <= (colnr_T)textwidth)
5990 			    && (!fo_ins_blank
5991 				|| Insstart_blank_vcol <= (colnr_T)textwidth
5992 			    ))))))
5993     {
5994 	/* Format with 'formatexpr' when it's set.  Use internal formatting
5995 	 * when 'formatexpr' isn't set or it returns non-zero. */
5996 #if defined(FEAT_EVAL)
5997 	int     do_internal = TRUE;
5998 	colnr_T virtcol = get_nolist_virtcol()
5999 				  + char2cells(c != NUL ? c : gchar_cursor());
6000 
6001 	if (*curbuf->b_p_fex != NUL && (flags & INSCHAR_NO_FEX) == 0
6002 		&& (force_format || virtcol > (colnr_T)textwidth))
6003 	{
6004 	    do_internal = (fex_format(curwin->w_cursor.lnum, 1L, c) != 0);
6005 	    /* It may be required to save for undo again, e.g. when setline()
6006 	     * was called. */
6007 	    ins_need_undo = TRUE;
6008 	}
6009 	if (do_internal)
6010 #endif
6011 	    internal_format(textwidth, second_indent, flags, c == NUL, c);
6012     }
6013 
6014     if (c == NUL)	    /* only formatting was wanted */
6015 	return;
6016 
6017 #ifdef FEAT_COMMENTS
6018     /* Check whether this character should end a comment. */
6019     if (did_ai && (int)c == end_comment_pending)
6020     {
6021 	char_u  *line;
6022 	char_u	lead_end[COM_MAX_LEN];	    /* end-comment string */
6023 	int	middle_len, end_len;
6024 	int	i;
6025 
6026 	/*
6027 	 * Need to remove existing (middle) comment leader and insert end
6028 	 * comment leader.  First, check what comment leader we can find.
6029 	 */
6030 	i = get_leader_len(line = ml_get_curline(), &p, FALSE, TRUE);
6031 	if (i > 0 && vim_strchr(p, COM_MIDDLE) != NULL)	/* Just checking */
6032 	{
6033 	    /* Skip middle-comment string */
6034 	    while (*p && p[-1] != ':')	/* find end of middle flags */
6035 		++p;
6036 	    middle_len = copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
6037 	    /* Don't count trailing white space for middle_len */
6038 	    while (middle_len > 0 && vim_iswhite(lead_end[middle_len - 1]))
6039 		--middle_len;
6040 
6041 	    /* Find the end-comment string */
6042 	    while (*p && p[-1] != ':')	/* find end of end flags */
6043 		++p;
6044 	    end_len = copy_option_part(&p, lead_end, COM_MAX_LEN, ",");
6045 
6046 	    /* Skip white space before the cursor */
6047 	    i = curwin->w_cursor.col;
6048 	    while (--i >= 0 && vim_iswhite(line[i]))
6049 		;
6050 	    i++;
6051 
6052 	    /* Skip to before the middle leader */
6053 	    i -= middle_len;
6054 
6055 	    /* Check some expected things before we go on */
6056 	    if (i >= 0 && lead_end[end_len - 1] == end_comment_pending)
6057 	    {
6058 		/* Backspace over all the stuff we want to replace */
6059 		backspace_until_column(i);
6060 
6061 		/*
6062 		 * Insert the end-comment string, except for the last
6063 		 * character, which will get inserted as normal later.
6064 		 */
6065 		ins_bytes_len(lead_end, end_len - 1);
6066 	    }
6067 	}
6068     }
6069     end_comment_pending = NUL;
6070 #endif
6071 
6072     did_ai = FALSE;
6073 #ifdef FEAT_SMARTINDENT
6074     did_si = FALSE;
6075     can_si = FALSE;
6076     can_si_back = FALSE;
6077 #endif
6078 
6079     /*
6080      * If there's any pending input, grab up to INPUT_BUFLEN at once.
6081      * This speeds up normal text input considerably.
6082      * Don't do this when 'cindent' or 'indentexpr' is set, because we might
6083      * need to re-indent at a ':', or any other character (but not what
6084      * 'paste' is set)..
6085      * Don't do this when there an InsertCharPre autocommand is defined,
6086      * because we need to fire the event for every character.
6087      */
6088 #ifdef USE_ON_FLY_SCROLL
6089     dont_scroll = FALSE;		/* allow scrolling here */
6090 #endif
6091 
6092     if (       !ISSPECIAL(c)
6093 #ifdef FEAT_MBYTE
6094 	    && (!has_mbyte || (*mb_char2len)(c) == 1)
6095 #endif
6096 	    && vpeekc() != NUL
6097 	    && !(State & REPLACE_FLAG)
6098 #ifdef FEAT_CINDENT
6099 	    && !cindent_on()
6100 #endif
6101 #ifdef FEAT_RIGHTLEFT
6102 	    && !p_ri
6103 #endif
6104 #ifdef FEAT_AUTOCMD
6105 	    && !has_insertcharpre()
6106 #endif
6107 	       )
6108     {
6109 #define INPUT_BUFLEN 100
6110 	char_u		buf[INPUT_BUFLEN + 1];
6111 	int		i;
6112 	colnr_T		virtcol = 0;
6113 
6114 	buf[0] = c;
6115 	i = 1;
6116 	if (textwidth > 0)
6117 	    virtcol = get_nolist_virtcol();
6118 	/*
6119 	 * Stop the string when:
6120 	 * - no more chars available
6121 	 * - finding a special character (command key)
6122 	 * - buffer is full
6123 	 * - running into the 'textwidth' boundary
6124 	 * - need to check for abbreviation: A non-word char after a word-char
6125 	 */
6126 	while (	   (c = vpeekc()) != NUL
6127 		&& !ISSPECIAL(c)
6128 #ifdef FEAT_MBYTE
6129 		&& (!has_mbyte || MB_BYTE2LEN_CHECK(c) == 1)
6130 #endif
6131 		&& i < INPUT_BUFLEN
6132 		&& (textwidth == 0
6133 		    || (virtcol += byte2cells(buf[i - 1])) < (colnr_T)textwidth)
6134 		&& !(!no_abbr && !vim_iswordc(c) && vim_iswordc(buf[i - 1])))
6135 	{
6136 #ifdef FEAT_RIGHTLEFT
6137 	    c = vgetc();
6138 	    if (p_hkmap && KeyTyped)
6139 		c = hkmap(c);		    /* Hebrew mode mapping */
6140 # ifdef FEAT_FKMAP
6141 	    if (p_fkmap && KeyTyped)
6142 		c = fkmap(c);		    /* Farsi mode mapping */
6143 # endif
6144 	    buf[i++] = c;
6145 #else
6146 	    buf[i++] = vgetc();
6147 #endif
6148 	}
6149 
6150 #ifdef FEAT_DIGRAPHS
6151 	do_digraph(-1);			/* clear digraphs */
6152 	do_digraph(buf[i-1]);		/* may be the start of a digraph */
6153 #endif
6154 	buf[i] = NUL;
6155 	ins_str(buf);
6156 	if (flags & INSCHAR_CTRLV)
6157 	{
6158 	    redo_literal(*buf);
6159 	    i = 1;
6160 	}
6161 	else
6162 	    i = 0;
6163 	if (buf[i] != NUL)
6164 	    AppendToRedobuffLit(buf + i, -1);
6165     }
6166     else
6167     {
6168 #ifdef FEAT_MBYTE
6169 	int		cc;
6170 
6171 	if (has_mbyte && (cc = (*mb_char2len)(c)) > 1)
6172 	{
6173 	    char_u	buf[MB_MAXBYTES + 1];
6174 
6175 	    (*mb_char2bytes)(c, buf);
6176 	    buf[cc] = NUL;
6177 	    ins_char_bytes(buf, cc);
6178 	    AppendCharToRedobuff(c);
6179 	}
6180 	else
6181 #endif
6182 	{
6183 	    ins_char(c);
6184 	    if (flags & INSCHAR_CTRLV)
6185 		redo_literal(c);
6186 	    else
6187 		AppendCharToRedobuff(c);
6188 	}
6189     }
6190 }
6191 
6192 /*
6193  * Format text at the current insert position.
6194  *
6195  * If the INSCHAR_COM_LIST flag is present, then the value of second_indent
6196  * will be the comment leader length sent to open_line().
6197  */
6198     static void
6199 internal_format(
6200     int		textwidth,
6201     int		second_indent,
6202     int		flags,
6203     int		format_only,
6204     int		c) /* character to be inserted (can be NUL) */
6205 {
6206     int		cc;
6207     int		save_char = NUL;
6208     int		haveto_redraw = FALSE;
6209     int		fo_ins_blank = has_format_option(FO_INS_BLANK);
6210 #ifdef FEAT_MBYTE
6211     int		fo_multibyte = has_format_option(FO_MBYTE_BREAK);
6212 #endif
6213     int		fo_white_par = has_format_option(FO_WHITE_PAR);
6214     int		first_line = TRUE;
6215 #ifdef FEAT_COMMENTS
6216     colnr_T	leader_len;
6217     int		no_leader = FALSE;
6218     int		do_comments = (flags & INSCHAR_DO_COM);
6219 #endif
6220 #ifdef FEAT_LINEBREAK
6221     int		has_lbr = curwin->w_p_lbr;
6222 
6223     /* make sure win_lbr_chartabsize() counts correctly */
6224     curwin->w_p_lbr = FALSE;
6225 #endif
6226 
6227     /*
6228      * When 'ai' is off we don't want a space under the cursor to be
6229      * deleted.  Replace it with an 'x' temporarily.
6230      */
6231     if (!curbuf->b_p_ai
6232 #ifdef FEAT_VREPLACE
6233 	    && !(State & VREPLACE_FLAG)
6234 #endif
6235 	    )
6236     {
6237 	cc = gchar_cursor();
6238 	if (vim_iswhite(cc))
6239 	{
6240 	    save_char = cc;
6241 	    pchar_cursor('x');
6242 	}
6243     }
6244 
6245     /*
6246      * Repeat breaking lines, until the current line is not too long.
6247      */
6248     while (!got_int)
6249     {
6250 	int	startcol;		/* Cursor column at entry */
6251 	int	wantcol;		/* column at textwidth border */
6252 	int	foundcol;		/* column for start of spaces */
6253 	int	end_foundcol = 0;	/* column for start of word */
6254 	colnr_T	len;
6255 	colnr_T	virtcol;
6256 #ifdef FEAT_VREPLACE
6257 	int	orig_col = 0;
6258 	char_u	*saved_text = NULL;
6259 #endif
6260 	colnr_T	col;
6261 	colnr_T	end_col;
6262 
6263 	virtcol = get_nolist_virtcol()
6264 		+ char2cells(c != NUL ? c : gchar_cursor());
6265 	if (virtcol <= (colnr_T)textwidth)
6266 	    break;
6267 
6268 #ifdef FEAT_COMMENTS
6269 	if (no_leader)
6270 	    do_comments = FALSE;
6271 	else if (!(flags & INSCHAR_FORMAT)
6272 				       && has_format_option(FO_WRAP_COMS))
6273 	    do_comments = TRUE;
6274 
6275 	/* Don't break until after the comment leader */
6276 	if (do_comments)
6277 	    leader_len = get_leader_len(ml_get_curline(), NULL, FALSE, TRUE);
6278 	else
6279 	    leader_len = 0;
6280 
6281 	/* If the line doesn't start with a comment leader, then don't
6282 	 * start one in a following broken line.  Avoids that a %word
6283 	 * moved to the start of the next line causes all following lines
6284 	 * to start with %. */
6285 	if (leader_len == 0)
6286 	    no_leader = TRUE;
6287 #endif
6288 	if (!(flags & INSCHAR_FORMAT)
6289 #ifdef FEAT_COMMENTS
6290 		&& leader_len == 0
6291 #endif
6292 		&& !has_format_option(FO_WRAP))
6293 
6294 	    break;
6295 	if ((startcol = curwin->w_cursor.col) == 0)
6296 	    break;
6297 
6298 	/* find column of textwidth border */
6299 	coladvance((colnr_T)textwidth);
6300 	wantcol = curwin->w_cursor.col;
6301 
6302 	curwin->w_cursor.col = startcol;
6303 	foundcol = 0;
6304 
6305 	/*
6306 	 * Find position to break at.
6307 	 * Stop at first entered white when 'formatoptions' has 'v'
6308 	 */
6309 	while ((!fo_ins_blank && !has_format_option(FO_INS_VI))
6310 		    || (flags & INSCHAR_FORMAT)
6311 		    || curwin->w_cursor.lnum != Insstart.lnum
6312 		    || curwin->w_cursor.col >= Insstart.col)
6313 	{
6314 	    if (curwin->w_cursor.col == startcol && c != NUL)
6315 		cc = c;
6316 	    else
6317 		cc = gchar_cursor();
6318 	    if (WHITECHAR(cc))
6319 	    {
6320 		/* remember position of blank just before text */
6321 		end_col = curwin->w_cursor.col;
6322 
6323 		/* find start of sequence of blanks */
6324 		while (curwin->w_cursor.col > 0 && WHITECHAR(cc))
6325 		{
6326 		    dec_cursor();
6327 		    cc = gchar_cursor();
6328 		}
6329 		if (curwin->w_cursor.col == 0 && WHITECHAR(cc))
6330 		    break;		/* only spaces in front of text */
6331 #ifdef FEAT_COMMENTS
6332 		/* Don't break until after the comment leader */
6333 		if (curwin->w_cursor.col < leader_len)
6334 		    break;
6335 #endif
6336 		if (has_format_option(FO_ONE_LETTER))
6337 		{
6338 		    /* do not break after one-letter words */
6339 		    if (curwin->w_cursor.col == 0)
6340 			break;	/* one-letter word at begin */
6341 #ifdef FEAT_COMMENTS
6342 		    /* do not break "#a b" when 'tw' is 2 */
6343 		    if (curwin->w_cursor.col <= leader_len)
6344 			break;
6345 #endif
6346 		    col = curwin->w_cursor.col;
6347 		    dec_cursor();
6348 		    cc = gchar_cursor();
6349 
6350 		    if (WHITECHAR(cc))
6351 			continue;	/* one-letter, continue */
6352 		    curwin->w_cursor.col = col;
6353 		}
6354 
6355 		inc_cursor();
6356 
6357 		end_foundcol = end_col + 1;
6358 		foundcol = curwin->w_cursor.col;
6359 		if (curwin->w_cursor.col <= (colnr_T)wantcol)
6360 		    break;
6361 	    }
6362 #ifdef FEAT_MBYTE
6363 	    else if (cc >= 0x100 && fo_multibyte)
6364 	    {
6365 		/* Break after or before a multi-byte character. */
6366 		if (curwin->w_cursor.col != startcol)
6367 		{
6368 #ifdef FEAT_COMMENTS
6369 		    /* Don't break until after the comment leader */
6370 		    if (curwin->w_cursor.col < leader_len)
6371 			break;
6372 #endif
6373 		    col = curwin->w_cursor.col;
6374 		    inc_cursor();
6375 		    /* Don't change end_foundcol if already set. */
6376 		    if (foundcol != curwin->w_cursor.col)
6377 		    {
6378 			foundcol = curwin->w_cursor.col;
6379 			end_foundcol = foundcol;
6380 			if (curwin->w_cursor.col <= (colnr_T)wantcol)
6381 			    break;
6382 		    }
6383 		    curwin->w_cursor.col = col;
6384 		}
6385 
6386 		if (curwin->w_cursor.col == 0)
6387 		    break;
6388 
6389 		col = curwin->w_cursor.col;
6390 
6391 		dec_cursor();
6392 		cc = gchar_cursor();
6393 
6394 		if (WHITECHAR(cc))
6395 		    continue;		/* break with space */
6396 #ifdef FEAT_COMMENTS
6397 		/* Don't break until after the comment leader */
6398 		if (curwin->w_cursor.col < leader_len)
6399 		    break;
6400 #endif
6401 
6402 		curwin->w_cursor.col = col;
6403 
6404 		foundcol = curwin->w_cursor.col;
6405 		end_foundcol = foundcol;
6406 		if (curwin->w_cursor.col <= (colnr_T)wantcol)
6407 		    break;
6408 	    }
6409 #endif
6410 	    if (curwin->w_cursor.col == 0)
6411 		break;
6412 	    dec_cursor();
6413 	}
6414 
6415 	if (foundcol == 0)		/* no spaces, cannot break line */
6416 	{
6417 	    curwin->w_cursor.col = startcol;
6418 	    break;
6419 	}
6420 
6421 	/* Going to break the line, remove any "$" now. */
6422 	undisplay_dollar();
6423 
6424 	/*
6425 	 * Offset between cursor position and line break is used by replace
6426 	 * stack functions.  VREPLACE does not use this, and backspaces
6427 	 * over the text instead.
6428 	 */
6429 #ifdef FEAT_VREPLACE
6430 	if (State & VREPLACE_FLAG)
6431 	    orig_col = startcol;	/* Will start backspacing from here */
6432 	else
6433 #endif
6434 	    replace_offset = startcol - end_foundcol;
6435 
6436 	/*
6437 	 * adjust startcol for spaces that will be deleted and
6438 	 * characters that will remain on top line
6439 	 */
6440 	curwin->w_cursor.col = foundcol;
6441 	while ((cc = gchar_cursor(), WHITECHAR(cc))
6442 		    && (!fo_white_par || curwin->w_cursor.col < startcol))
6443 	    inc_cursor();
6444 	startcol -= curwin->w_cursor.col;
6445 	if (startcol < 0)
6446 	    startcol = 0;
6447 
6448 #ifdef FEAT_VREPLACE
6449 	if (State & VREPLACE_FLAG)
6450 	{
6451 	    /*
6452 	     * In VREPLACE mode, we will backspace over the text to be
6453 	     * wrapped, so save a copy now to put on the next line.
6454 	     */
6455 	    saved_text = vim_strsave(ml_get_cursor());
6456 	    curwin->w_cursor.col = orig_col;
6457 	    if (saved_text == NULL)
6458 		break;	/* Can't do it, out of memory */
6459 	    saved_text[startcol] = NUL;
6460 
6461 	    /* Backspace over characters that will move to the next line */
6462 	    if (!fo_white_par)
6463 		backspace_until_column(foundcol);
6464 	}
6465 	else
6466 #endif
6467 	{
6468 	    /* put cursor after pos. to break line */
6469 	    if (!fo_white_par)
6470 		curwin->w_cursor.col = foundcol;
6471 	}
6472 
6473 	/*
6474 	 * Split the line just before the margin.
6475 	 * Only insert/delete lines, but don't really redraw the window.
6476 	 */
6477 	open_line(FORWARD, OPENLINE_DELSPACES + OPENLINE_MARKFIX
6478 		+ (fo_white_par ? OPENLINE_KEEPTRAIL : 0)
6479 #ifdef FEAT_COMMENTS
6480 		+ (do_comments ? OPENLINE_DO_COM : 0)
6481 		+ ((flags & INSCHAR_COM_LIST) ? OPENLINE_COM_LIST : 0)
6482 #endif
6483 		, ((flags & INSCHAR_COM_LIST) ? second_indent : old_indent));
6484 	if (!(flags & INSCHAR_COM_LIST))
6485 	    old_indent = 0;
6486 
6487 	replace_offset = 0;
6488 	if (first_line)
6489 	{
6490 	    if (!(flags & INSCHAR_COM_LIST))
6491 	    {
6492 		/*
6493 		 * This section is for auto-wrap of numeric lists.  When not
6494 		 * in insert mode (i.e. format_lines()), the INSCHAR_COM_LIST
6495 		 * flag will be set and open_line() will handle it (as seen
6496 		 * above).  The code here (and in get_number_indent()) will
6497 		 * recognize comments if needed...
6498 		 */
6499 		if (second_indent < 0 && has_format_option(FO_Q_NUMBER))
6500 		    second_indent =
6501 				 get_number_indent(curwin->w_cursor.lnum - 1);
6502 		if (second_indent >= 0)
6503 		{
6504 #ifdef FEAT_VREPLACE
6505 		    if (State & VREPLACE_FLAG)
6506 			change_indent(INDENT_SET, second_indent,
6507 							    FALSE, NUL, TRUE);
6508 		    else
6509 #endif
6510 #ifdef FEAT_COMMENTS
6511 			if (leader_len > 0 && second_indent - leader_len > 0)
6512 		    {
6513 			int i;
6514 			int padding = second_indent - leader_len;
6515 
6516 			/* We started at the first_line of a numbered list
6517 			 * that has a comment.  the open_line() function has
6518 			 * inserted the proper comment leader and positioned
6519 			 * the cursor at the end of the split line.  Now we
6520 			 * add the additional whitespace needed after the
6521 			 * comment leader for the numbered list.  */
6522 			for (i = 0; i < padding; i++)
6523 			    ins_str((char_u *)" ");
6524 			changed_bytes(curwin->w_cursor.lnum, leader_len);
6525 		    }
6526 		    else
6527 		    {
6528 #endif
6529 			(void)set_indent(second_indent, SIN_CHANGED);
6530 #ifdef FEAT_COMMENTS
6531 		    }
6532 #endif
6533 		}
6534 	    }
6535 	    first_line = FALSE;
6536 	}
6537 
6538 #ifdef FEAT_VREPLACE
6539 	if (State & VREPLACE_FLAG)
6540 	{
6541 	    /*
6542 	     * In VREPLACE mode we have backspaced over the text to be
6543 	     * moved, now we re-insert it into the new line.
6544 	     */
6545 	    ins_bytes(saved_text);
6546 	    vim_free(saved_text);
6547 	}
6548 	else
6549 #endif
6550 	{
6551 	    /*
6552 	     * Check if cursor is not past the NUL off the line, cindent
6553 	     * may have added or removed indent.
6554 	     */
6555 	    curwin->w_cursor.col += startcol;
6556 	    len = (colnr_T)STRLEN(ml_get_curline());
6557 	    if (curwin->w_cursor.col > len)
6558 		curwin->w_cursor.col = len;
6559 	}
6560 
6561 	haveto_redraw = TRUE;
6562 #ifdef FEAT_CINDENT
6563 	can_cindent = TRUE;
6564 #endif
6565 	/* moved the cursor, don't autoindent or cindent now */
6566 	did_ai = FALSE;
6567 #ifdef FEAT_SMARTINDENT
6568 	did_si = FALSE;
6569 	can_si = FALSE;
6570 	can_si_back = FALSE;
6571 #endif
6572 	line_breakcheck();
6573     }
6574 
6575     if (save_char != NUL)		/* put back space after cursor */
6576 	pchar_cursor(save_char);
6577 
6578 #ifdef FEAT_LINEBREAK
6579     curwin->w_p_lbr = has_lbr;
6580 #endif
6581     if (!format_only && haveto_redraw)
6582     {
6583 	update_topline();
6584 	redraw_curbuf_later(VALID);
6585     }
6586 }
6587 
6588 /*
6589  * Called after inserting or deleting text: When 'formatoptions' includes the
6590  * 'a' flag format from the current line until the end of the paragraph.
6591  * Keep the cursor at the same position relative to the text.
6592  * The caller must have saved the cursor line for undo, following ones will be
6593  * saved here.
6594  */
6595     void
6596 auto_format(
6597     int		trailblank,	/* when TRUE also format with trailing blank */
6598     int		prev_line)	/* may start in previous line */
6599 {
6600     pos_T	pos;
6601     colnr_T	len;
6602     char_u	*old;
6603     char_u	*new, *pnew;
6604     int		wasatend;
6605     int		cc;
6606 
6607     if (!has_format_option(FO_AUTO))
6608 	return;
6609 
6610     pos = curwin->w_cursor;
6611     old = ml_get_curline();
6612 
6613     /* may remove added space */
6614     check_auto_format(FALSE);
6615 
6616     /* Don't format in Insert mode when the cursor is on a trailing blank, the
6617      * user might insert normal text next.  Also skip formatting when "1" is
6618      * in 'formatoptions' and there is a single character before the cursor.
6619      * Otherwise the line would be broken and when typing another non-white
6620      * next they are not joined back together. */
6621     wasatend = (pos.col == (colnr_T)STRLEN(old));
6622     if (*old != NUL && !trailblank && wasatend)
6623     {
6624 	dec_cursor();
6625 	cc = gchar_cursor();
6626 	if (!WHITECHAR(cc) && curwin->w_cursor.col > 0
6627 					  && has_format_option(FO_ONE_LETTER))
6628 	    dec_cursor();
6629 	cc = gchar_cursor();
6630 	if (WHITECHAR(cc))
6631 	{
6632 	    curwin->w_cursor = pos;
6633 	    return;
6634 	}
6635 	curwin->w_cursor = pos;
6636     }
6637 
6638 #ifdef FEAT_COMMENTS
6639     /* With the 'c' flag in 'formatoptions' and 't' missing: only format
6640      * comments. */
6641     if (has_format_option(FO_WRAP_COMS) && !has_format_option(FO_WRAP)
6642 				     && get_leader_len(old, NULL, FALSE, TRUE) == 0)
6643 	return;
6644 #endif
6645 
6646     /*
6647      * May start formatting in a previous line, so that after "x" a word is
6648      * moved to the previous line if it fits there now.  Only when this is not
6649      * the start of a paragraph.
6650      */
6651     if (prev_line && !paragraph_start(curwin->w_cursor.lnum))
6652     {
6653 	--curwin->w_cursor.lnum;
6654 	if (u_save_cursor() == FAIL)
6655 	    return;
6656     }
6657 
6658     /*
6659      * Do the formatting and restore the cursor position.  "saved_cursor" will
6660      * be adjusted for the text formatting.
6661      */
6662     saved_cursor = pos;
6663     format_lines((linenr_T)-1, FALSE);
6664     curwin->w_cursor = saved_cursor;
6665     saved_cursor.lnum = 0;
6666 
6667     if (curwin->w_cursor.lnum > curbuf->b_ml.ml_line_count)
6668     {
6669 	/* "cannot happen" */
6670 	curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
6671 	coladvance((colnr_T)MAXCOL);
6672     }
6673     else
6674 	check_cursor_col();
6675 
6676     /* Insert mode: If the cursor is now after the end of the line while it
6677      * previously wasn't, the line was broken.  Because of the rule above we
6678      * need to add a space when 'w' is in 'formatoptions' to keep a paragraph
6679      * formatted. */
6680     if (!wasatend && has_format_option(FO_WHITE_PAR))
6681     {
6682 	new = ml_get_curline();
6683 	len = (colnr_T)STRLEN(new);
6684 	if (curwin->w_cursor.col == len)
6685 	{
6686 	    pnew = vim_strnsave(new, len + 2);
6687 	    pnew[len] = ' ';
6688 	    pnew[len + 1] = NUL;
6689 	    ml_replace(curwin->w_cursor.lnum, pnew, FALSE);
6690 	    /* remove the space later */
6691 	    did_add_space = TRUE;
6692 	}
6693 	else
6694 	    /* may remove added space */
6695 	    check_auto_format(FALSE);
6696     }
6697 
6698     check_cursor();
6699 }
6700 
6701 /*
6702  * When an extra space was added to continue a paragraph for auto-formatting,
6703  * delete it now.  The space must be under the cursor, just after the insert
6704  * position.
6705  */
6706     static void
6707 check_auto_format(
6708     int		end_insert)	    /* TRUE when ending Insert mode */
6709 {
6710     int		c = ' ';
6711     int		cc;
6712 
6713     if (did_add_space)
6714     {
6715 	cc = gchar_cursor();
6716 	if (!WHITECHAR(cc))
6717 	    /* Somehow the space was removed already. */
6718 	    did_add_space = FALSE;
6719 	else
6720 	{
6721 	    if (!end_insert)
6722 	    {
6723 		inc_cursor();
6724 		c = gchar_cursor();
6725 		dec_cursor();
6726 	    }
6727 	    if (c != NUL)
6728 	    {
6729 		/* The space is no longer at the end of the line, delete it. */
6730 		del_char(FALSE);
6731 		did_add_space = FALSE;
6732 	    }
6733 	}
6734     }
6735 }
6736 
6737 /*
6738  * Find out textwidth to be used for formatting:
6739  *	if 'textwidth' option is set, use it
6740  *	else if 'wrapmargin' option is set, use W_WIDTH(curwin) - 'wrapmargin'
6741  *	if invalid value, use 0.
6742  *	Set default to window width (maximum 79) for "gq" operator.
6743  */
6744     int
6745 comp_textwidth(
6746     int		ff)	/* force formatting (for "gq" command) */
6747 {
6748     int		textwidth;
6749 
6750     textwidth = curbuf->b_p_tw;
6751     if (textwidth == 0 && curbuf->b_p_wm)
6752     {
6753 	/* The width is the window width minus 'wrapmargin' minus all the
6754 	 * things that add to the margin. */
6755 	textwidth = W_WIDTH(curwin) - curbuf->b_p_wm;
6756 #ifdef FEAT_CMDWIN
6757 	if (cmdwin_type != 0)
6758 	    textwidth -= 1;
6759 #endif
6760 #ifdef FEAT_FOLDING
6761 	textwidth -= curwin->w_p_fdc;
6762 #endif
6763 #ifdef FEAT_SIGNS
6764 	if (signcolumn_on(curwin))
6765 	    textwidth -= 1;
6766 #endif
6767 	if (curwin->w_p_nu || curwin->w_p_rnu)
6768 	    textwidth -= 8;
6769     }
6770     if (textwidth < 0)
6771 	textwidth = 0;
6772     if (ff && textwidth == 0)
6773     {
6774 	textwidth = W_WIDTH(curwin) - 1;
6775 	if (textwidth > 79)
6776 	    textwidth = 79;
6777     }
6778     return textwidth;
6779 }
6780 
6781 /*
6782  * Put a character in the redo buffer, for when just after a CTRL-V.
6783  */
6784     static void
6785 redo_literal(int c)
6786 {
6787     char_u	buf[10];
6788 
6789     /* Only digits need special treatment.  Translate them into a string of
6790      * three digits. */
6791     if (VIM_ISDIGIT(c))
6792     {
6793 	vim_snprintf((char *)buf, sizeof(buf), "%03d", c);
6794 	AppendToRedobuff(buf);
6795     }
6796     else
6797 	AppendCharToRedobuff(c);
6798 }
6799 
6800 /*
6801  * start_arrow() is called when an arrow key is used in insert mode.
6802  * For undo/redo it resembles hitting the <ESC> key.
6803  */
6804     static void
6805 start_arrow(
6806     pos_T    *end_insert_pos)		/* can be NULL */
6807 {
6808     start_arrow_common(end_insert_pos, TRUE);
6809 }
6810 
6811 /*
6812  * Like start_arrow() but with end_change argument.
6813  * Will prepare for redo of CTRL-G U if "end_change" is FALSE.
6814  */
6815     static void
6816 start_arrow_with_change(
6817     pos_T    *end_insert_pos,		/* can be NULL */
6818     int	      end_change)		/* end undoable change */
6819 {
6820     start_arrow_common(end_insert_pos, end_change);
6821     if (!end_change)
6822     {
6823 	AppendCharToRedobuff(Ctrl_G);
6824 	AppendCharToRedobuff('U');
6825     }
6826 }
6827 
6828     static void
6829 start_arrow_common(
6830     pos_T    *end_insert_pos,		/* can be NULL */
6831     int	      end_change)		/* end undoable change */
6832 {
6833     if (!arrow_used && end_change)	/* something has been inserted */
6834     {
6835 	AppendToRedobuff(ESC_STR);
6836 	stop_insert(end_insert_pos, FALSE, FALSE);
6837 	arrow_used = TRUE;	/* this means we stopped the current insert */
6838     }
6839 #ifdef FEAT_SPELL
6840     check_spell_redraw();
6841 #endif
6842 }
6843 
6844 #ifdef FEAT_SPELL
6845 /*
6846  * If we skipped highlighting word at cursor, do it now.
6847  * It may be skipped again, thus reset spell_redraw_lnum first.
6848  */
6849     static void
6850 check_spell_redraw(void)
6851 {
6852     if (spell_redraw_lnum != 0)
6853     {
6854 	linenr_T	lnum = spell_redraw_lnum;
6855 
6856 	spell_redraw_lnum = 0;
6857 	redrawWinline(lnum, FALSE);
6858     }
6859 }
6860 
6861 /*
6862  * Called when starting CTRL_X_SPELL mode: Move backwards to a previous badly
6863  * spelled word, if there is one.
6864  */
6865     static void
6866 spell_back_to_badword(void)
6867 {
6868     pos_T	tpos = curwin->w_cursor;
6869 
6870     spell_bad_len = spell_move_to(curwin, BACKWARD, TRUE, TRUE, NULL);
6871     if (curwin->w_cursor.col != tpos.col)
6872 	start_arrow(&tpos);
6873 }
6874 #endif
6875 
6876 /*
6877  * stop_arrow() is called before a change is made in insert mode.
6878  * If an arrow key has been used, start a new insertion.
6879  * Returns FAIL if undo is impossible, shouldn't insert then.
6880  */
6881     int
6882 stop_arrow(void)
6883 {
6884     if (arrow_used)
6885     {
6886 	Insstart = curwin->w_cursor;	/* new insertion starts here */
6887 	if (Insstart.col > Insstart_orig.col && !ins_need_undo)
6888 	    /* Don't update the original insert position when moved to the
6889 	     * right, except when nothing was inserted yet. */
6890 	    update_Insstart_orig = FALSE;
6891 	Insstart_textlen = (colnr_T)linetabsize(ml_get_curline());
6892 
6893 	if (u_save_cursor() == OK)
6894 	{
6895 	    arrow_used = FALSE;
6896 	    ins_need_undo = FALSE;
6897 	}
6898 
6899 	ai_col = 0;
6900 #ifdef FEAT_VREPLACE
6901 	if (State & VREPLACE_FLAG)
6902 	{
6903 	    orig_line_count = curbuf->b_ml.ml_line_count;
6904 	    vr_lines_changed = 1;
6905 	}
6906 #endif
6907 	ResetRedobuff();
6908 	AppendToRedobuff((char_u *)"1i");   /* pretend we start an insertion */
6909 	new_insert_skip = 2;
6910     }
6911     else if (ins_need_undo)
6912     {
6913 	if (u_save_cursor() == OK)
6914 	    ins_need_undo = FALSE;
6915     }
6916 
6917 #ifdef FEAT_FOLDING
6918     /* Always open fold at the cursor line when inserting something. */
6919     foldOpenCursor();
6920 #endif
6921 
6922     return (arrow_used || ins_need_undo ? FAIL : OK);
6923 }
6924 
6925 /*
6926  * Do a few things to stop inserting.
6927  * "end_insert_pos" is where insert ended.  It is NULL when we already jumped
6928  * to another window/buffer.
6929  */
6930     static void
6931 stop_insert(
6932     pos_T	*end_insert_pos,
6933     int		esc,			/* called by ins_esc() */
6934     int		nomove)			/* <c-\><c-o>, don't move cursor */
6935 {
6936     int		cc;
6937     char_u	*ptr;
6938 
6939     stop_redo_ins();
6940     replace_flush();		/* abandon replace stack */
6941 
6942     /*
6943      * Save the inserted text for later redo with ^@ and CTRL-A.
6944      * Don't do it when "restart_edit" was set and nothing was inserted,
6945      * otherwise CTRL-O w and then <Left> will clear "last_insert".
6946      */
6947     ptr = get_inserted();
6948     if (did_restart_edit == 0 || (ptr != NULL
6949 				       && (int)STRLEN(ptr) > new_insert_skip))
6950     {
6951 	vim_free(last_insert);
6952 	last_insert = ptr;
6953 	last_insert_skip = new_insert_skip;
6954     }
6955     else
6956 	vim_free(ptr);
6957 
6958     if (!arrow_used && end_insert_pos != NULL)
6959     {
6960 	/* Auto-format now.  It may seem strange to do this when stopping an
6961 	 * insertion (or moving the cursor), but it's required when appending
6962 	 * a line and having it end in a space.  But only do it when something
6963 	 * was actually inserted, otherwise undo won't work. */
6964 	if (!ins_need_undo && has_format_option(FO_AUTO))
6965 	{
6966 	    pos_T   tpos = curwin->w_cursor;
6967 
6968 	    /* When the cursor is at the end of the line after a space the
6969 	     * formatting will move it to the following word.  Avoid that by
6970 	     * moving the cursor onto the space. */
6971 	    cc = 'x';
6972 	    if (curwin->w_cursor.col > 0 && gchar_cursor() == NUL)
6973 	    {
6974 		dec_cursor();
6975 		cc = gchar_cursor();
6976 		if (!vim_iswhite(cc))
6977 		    curwin->w_cursor = tpos;
6978 	    }
6979 
6980 	    auto_format(TRUE, FALSE);
6981 
6982 	    if (vim_iswhite(cc))
6983 	    {
6984 		if (gchar_cursor() != NUL)
6985 		    inc_cursor();
6986 #ifdef FEAT_VIRTUALEDIT
6987 		/* If the cursor is still at the same character, also keep
6988 		 * the "coladd". */
6989 		if (gchar_cursor() == NUL
6990 			&& curwin->w_cursor.lnum == tpos.lnum
6991 			&& curwin->w_cursor.col == tpos.col)
6992 		    curwin->w_cursor.coladd = tpos.coladd;
6993 #endif
6994 	    }
6995 	}
6996 
6997 	/* If a space was inserted for auto-formatting, remove it now. */
6998 	check_auto_format(TRUE);
6999 
7000 	/* If we just did an auto-indent, remove the white space from the end
7001 	 * of the line, and put the cursor back.
7002 	 * Do this when ESC was used or moving the cursor up/down.
7003 	 * Check for the old position still being valid, just in case the text
7004 	 * got changed unexpectedly. */
7005 	if (!nomove && did_ai && (esc || (vim_strchr(p_cpo, CPO_INDENT) == NULL
7006 			&& curwin->w_cursor.lnum != end_insert_pos->lnum))
7007 		&& end_insert_pos->lnum <= curbuf->b_ml.ml_line_count)
7008 	{
7009 	    pos_T	tpos = curwin->w_cursor;
7010 
7011 	    curwin->w_cursor = *end_insert_pos;
7012 	    check_cursor_col();  /* make sure it is not past the line */
7013 	    for (;;)
7014 	    {
7015 		if (gchar_cursor() == NUL && curwin->w_cursor.col > 0)
7016 		    --curwin->w_cursor.col;
7017 		cc = gchar_cursor();
7018 		if (!vim_iswhite(cc))
7019 		    break;
7020 		if (del_char(TRUE) == FAIL)
7021 		    break;  /* should not happen */
7022 	    }
7023 	    if (curwin->w_cursor.lnum != tpos.lnum)
7024 		curwin->w_cursor = tpos;
7025 	    else
7026 	    {
7027 		/* reset tpos, could have been invalidated in the loop above */
7028 		tpos = curwin->w_cursor;
7029 		tpos.col++;
7030 		if (cc != NUL && gchar_pos(&tpos) == NUL)
7031 		    ++curwin->w_cursor.col;	/* put cursor back on the NUL */
7032 	    }
7033 
7034 	    /* <C-S-Right> may have started Visual mode, adjust the position for
7035 	     * deleted characters. */
7036 	    if (VIsual_active && VIsual.lnum == curwin->w_cursor.lnum)
7037 	    {
7038 		int len = (int)STRLEN(ml_get_curline());
7039 
7040 		if (VIsual.col > len)
7041 		{
7042 		    VIsual.col = len;
7043 #ifdef FEAT_VIRTUALEDIT
7044 		    VIsual.coladd = 0;
7045 #endif
7046 		}
7047 	    }
7048 	}
7049     }
7050     did_ai = FALSE;
7051 #ifdef FEAT_SMARTINDENT
7052     did_si = FALSE;
7053     can_si = FALSE;
7054     can_si_back = FALSE;
7055 #endif
7056 
7057     /* Set '[ and '] to the inserted text.  When end_insert_pos is NULL we are
7058      * now in a different buffer. */
7059     if (end_insert_pos != NULL)
7060     {
7061 	curbuf->b_op_start = Insstart;
7062 	curbuf->b_op_start_orig = Insstart_orig;
7063 	curbuf->b_op_end = *end_insert_pos;
7064     }
7065 }
7066 
7067 /*
7068  * Set the last inserted text to a single character.
7069  * Used for the replace command.
7070  */
7071     void
7072 set_last_insert(int c)
7073 {
7074     char_u	*s;
7075 
7076     vim_free(last_insert);
7077     last_insert = alloc(MB_MAXBYTES * 3 + 5);
7078     if (last_insert != NULL)
7079     {
7080 	s = last_insert;
7081 	/* Use the CTRL-V only when entering a special char */
7082 	if (c < ' ' || c == DEL)
7083 	    *s++ = Ctrl_V;
7084 	s = add_char2buf(c, s);
7085 	*s++ = ESC;
7086 	*s++ = NUL;
7087 	last_insert_skip = 0;
7088     }
7089 }
7090 
7091 #if defined(EXITFREE) || defined(PROTO)
7092     void
7093 free_last_insert(void)
7094 {
7095     vim_free(last_insert);
7096     last_insert = NULL;
7097 # ifdef FEAT_INS_EXPAND
7098     vim_free(compl_orig_text);
7099     compl_orig_text = NULL;
7100 # endif
7101 }
7102 #endif
7103 
7104 /*
7105  * Add character "c" to buffer "s".  Escape the special meaning of K_SPECIAL
7106  * and CSI.  Handle multi-byte characters.
7107  * Returns a pointer to after the added bytes.
7108  */
7109     char_u *
7110 add_char2buf(int c, char_u *s)
7111 {
7112 #ifdef FEAT_MBYTE
7113     char_u	temp[MB_MAXBYTES + 1];
7114     int		i;
7115     int		len;
7116 
7117     len = (*mb_char2bytes)(c, temp);
7118     for (i = 0; i < len; ++i)
7119     {
7120 	c = temp[i];
7121 #endif
7122 	/* Need to escape K_SPECIAL and CSI like in the typeahead buffer. */
7123 	if (c == K_SPECIAL)
7124 	{
7125 	    *s++ = K_SPECIAL;
7126 	    *s++ = KS_SPECIAL;
7127 	    *s++ = KE_FILLER;
7128 	}
7129 #ifdef FEAT_GUI
7130 	else if (c == CSI)
7131 	{
7132 	    *s++ = CSI;
7133 	    *s++ = KS_EXTRA;
7134 	    *s++ = (int)KE_CSI;
7135 	}
7136 #endif
7137 	else
7138 	    *s++ = c;
7139 #ifdef FEAT_MBYTE
7140     }
7141 #endif
7142     return s;
7143 }
7144 
7145 /*
7146  * move cursor to start of line
7147  * if flags & BL_WHITE	move to first non-white
7148  * if flags & BL_SOL	move to first non-white if startofline is set,
7149  *			    otherwise keep "curswant" column
7150  * if flags & BL_FIX	don't leave the cursor on a NUL.
7151  */
7152     void
7153 beginline(int flags)
7154 {
7155     if ((flags & BL_SOL) && !p_sol)
7156 	coladvance(curwin->w_curswant);
7157     else
7158     {
7159 	curwin->w_cursor.col = 0;
7160 #ifdef FEAT_VIRTUALEDIT
7161 	curwin->w_cursor.coladd = 0;
7162 #endif
7163 
7164 	if (flags & (BL_WHITE | BL_SOL))
7165 	{
7166 	    char_u  *ptr;
7167 
7168 	    for (ptr = ml_get_curline(); vim_iswhite(*ptr)
7169 			       && !((flags & BL_FIX) && ptr[1] == NUL); ++ptr)
7170 		++curwin->w_cursor.col;
7171 	}
7172 	curwin->w_set_curswant = TRUE;
7173     }
7174 }
7175 
7176 /*
7177  * oneright oneleft cursor_down cursor_up
7178  *
7179  * Move one char {right,left,down,up}.
7180  * Doesn't move onto the NUL past the end of the line, unless it is allowed.
7181  * Return OK when successful, FAIL when we hit a line of file boundary.
7182  */
7183 
7184     int
7185 oneright(void)
7186 {
7187     char_u	*ptr;
7188     int		l;
7189 
7190 #ifdef FEAT_VIRTUALEDIT
7191     if (virtual_active())
7192     {
7193 	pos_T	prevpos = curwin->w_cursor;
7194 
7195 	/* Adjust for multi-wide char (excluding TAB) */
7196 	ptr = ml_get_cursor();
7197 	coladvance(getviscol() + ((*ptr != TAB && vim_isprintc(
7198 # ifdef FEAT_MBYTE
7199 			    (*mb_ptr2char)(ptr)
7200 # else
7201 			    *ptr
7202 # endif
7203 			    ))
7204 		    ? ptr2cells(ptr) : 1));
7205 	curwin->w_set_curswant = TRUE;
7206 	/* Return OK if the cursor moved, FAIL otherwise (at window edge). */
7207 	return (prevpos.col != curwin->w_cursor.col
7208 		    || prevpos.coladd != curwin->w_cursor.coladd) ? OK : FAIL;
7209     }
7210 #endif
7211 
7212     ptr = ml_get_cursor();
7213     if (*ptr == NUL)
7214 	return FAIL;	    /* already at the very end */
7215 
7216 #ifdef FEAT_MBYTE
7217     if (has_mbyte)
7218 	l = (*mb_ptr2len)(ptr);
7219     else
7220 #endif
7221 	l = 1;
7222 
7223     /* move "l" bytes right, but don't end up on the NUL, unless 'virtualedit'
7224      * contains "onemore". */
7225     if (ptr[l] == NUL
7226 #ifdef FEAT_VIRTUALEDIT
7227 	    && (ve_flags & VE_ONEMORE) == 0
7228 #endif
7229 	    )
7230 	return FAIL;
7231     curwin->w_cursor.col += l;
7232 
7233     curwin->w_set_curswant = TRUE;
7234     return OK;
7235 }
7236 
7237     int
7238 oneleft(void)
7239 {
7240 #ifdef FEAT_VIRTUALEDIT
7241     if (virtual_active())
7242     {
7243 	int width;
7244 	int v = getviscol();
7245 
7246 	if (v == 0)
7247 	    return FAIL;
7248 
7249 # ifdef FEAT_LINEBREAK
7250 	/* We might get stuck on 'showbreak', skip over it. */
7251 	width = 1;
7252 	for (;;)
7253 	{
7254 	    coladvance(v - width);
7255 	    /* getviscol() is slow, skip it when 'showbreak' is empty,
7256 	     * 'breakindent' is not set and there are no multi-byte
7257 	     * characters */
7258 	    if ((*p_sbr == NUL && !curwin->w_p_bri
7259 #  ifdef FEAT_MBYTE
7260 			&& !has_mbyte
7261 #  endif
7262 			) || getviscol() < v)
7263 		break;
7264 	    ++width;
7265 	}
7266 # else
7267 	coladvance(v - 1);
7268 # endif
7269 
7270 	if (curwin->w_cursor.coladd == 1)
7271 	{
7272 	    char_u *ptr;
7273 
7274 	    /* Adjust for multi-wide char (not a TAB) */
7275 	    ptr = ml_get_cursor();
7276 	    if (*ptr != TAB && vim_isprintc(
7277 #  ifdef FEAT_MBYTE
7278 			    (*mb_ptr2char)(ptr)
7279 #  else
7280 			    *ptr
7281 #  endif
7282 			    ) && ptr2cells(ptr) > 1)
7283 		curwin->w_cursor.coladd = 0;
7284 	}
7285 
7286 	curwin->w_set_curswant = TRUE;
7287 	return OK;
7288     }
7289 #endif
7290 
7291     if (curwin->w_cursor.col == 0)
7292 	return FAIL;
7293 
7294     curwin->w_set_curswant = TRUE;
7295     --curwin->w_cursor.col;
7296 
7297 #ifdef FEAT_MBYTE
7298     /* if the character on the left of the current cursor is a multi-byte
7299      * character, move to its first byte */
7300     if (has_mbyte)
7301 	mb_adjust_cursor();
7302 #endif
7303     return OK;
7304 }
7305 
7306     int
7307 cursor_up(
7308     long	n,
7309     int		upd_topline)	    /* When TRUE: update topline */
7310 {
7311     linenr_T	lnum;
7312 
7313     if (n > 0)
7314     {
7315 	lnum = curwin->w_cursor.lnum;
7316 	/* This fails if the cursor is already in the first line or the count
7317 	 * is larger than the line number and '-' is in 'cpoptions' */
7318 	if (lnum <= 1 || (n >= lnum && vim_strchr(p_cpo, CPO_MINUS) != NULL))
7319 	    return FAIL;
7320 	if (n >= lnum)
7321 	    lnum = 1;
7322 	else
7323 #ifdef FEAT_FOLDING
7324 	    if (hasAnyFolding(curwin))
7325 	{
7326 	    /*
7327 	     * Count each sequence of folded lines as one logical line.
7328 	     */
7329 	    /* go to the start of the current fold */
7330 	    (void)hasFolding(lnum, &lnum, NULL);
7331 
7332 	    while (n--)
7333 	    {
7334 		/* move up one line */
7335 		--lnum;
7336 		if (lnum <= 1)
7337 		    break;
7338 		/* If we entered a fold, move to the beginning, unless in
7339 		 * Insert mode or when 'foldopen' contains "all": it will open
7340 		 * in a moment. */
7341 		if (n > 0 || !((State & INSERT) || (fdo_flags & FDO_ALL)))
7342 		    (void)hasFolding(lnum, &lnum, NULL);
7343 	    }
7344 	    if (lnum < 1)
7345 		lnum = 1;
7346 	}
7347 	else
7348 #endif
7349 	    lnum -= n;
7350 	curwin->w_cursor.lnum = lnum;
7351     }
7352 
7353     /* try to advance to the column we want to be at */
7354     coladvance(curwin->w_curswant);
7355 
7356     if (upd_topline)
7357 	update_topline();	/* make sure curwin->w_topline is valid */
7358 
7359     return OK;
7360 }
7361 
7362 /*
7363  * Cursor down a number of logical lines.
7364  */
7365     int
7366 cursor_down(
7367     long	n,
7368     int		upd_topline)	    /* When TRUE: update topline */
7369 {
7370     linenr_T	lnum;
7371 
7372     if (n > 0)
7373     {
7374 	lnum = curwin->w_cursor.lnum;
7375 #ifdef FEAT_FOLDING
7376 	/* Move to last line of fold, will fail if it's the end-of-file. */
7377 	(void)hasFolding(lnum, NULL, &lnum);
7378 #endif
7379 	/* This fails if the cursor is already in the last line or would move
7380 	 * beyond the last line and '-' is in 'cpoptions' */
7381 	if (lnum >= curbuf->b_ml.ml_line_count
7382 		|| (lnum + n > curbuf->b_ml.ml_line_count
7383 		    && vim_strchr(p_cpo, CPO_MINUS) != NULL))
7384 	    return FAIL;
7385 	if (lnum + n >= curbuf->b_ml.ml_line_count)
7386 	    lnum = curbuf->b_ml.ml_line_count;
7387 	else
7388 #ifdef FEAT_FOLDING
7389 	if (hasAnyFolding(curwin))
7390 	{
7391 	    linenr_T	last;
7392 
7393 	    /* count each sequence of folded lines as one logical line */
7394 	    while (n--)
7395 	    {
7396 		if (hasFolding(lnum, NULL, &last))
7397 		    lnum = last + 1;
7398 		else
7399 		    ++lnum;
7400 		if (lnum >= curbuf->b_ml.ml_line_count)
7401 		    break;
7402 	    }
7403 	    if (lnum > curbuf->b_ml.ml_line_count)
7404 		lnum = curbuf->b_ml.ml_line_count;
7405 	}
7406 	else
7407 #endif
7408 	    lnum += n;
7409 	curwin->w_cursor.lnum = lnum;
7410     }
7411 
7412     /* try to advance to the column we want to be at */
7413     coladvance(curwin->w_curswant);
7414 
7415     if (upd_topline)
7416 	update_topline();	/* make sure curwin->w_topline is valid */
7417 
7418     return OK;
7419 }
7420 
7421 /*
7422  * Stuff the last inserted text in the read buffer.
7423  * Last_insert actually is a copy of the redo buffer, so we
7424  * first have to remove the command.
7425  */
7426     int
7427 stuff_inserted(
7428     int	    c,		/* Command character to be inserted */
7429     long    count,	/* Repeat this many times */
7430     int	    no_esc)	/* Don't add an ESC at the end */
7431 {
7432     char_u	*esc_ptr;
7433     char_u	*ptr;
7434     char_u	*last_ptr;
7435     char_u	last = NUL;
7436 
7437     ptr = get_last_insert();
7438     if (ptr == NULL)
7439     {
7440 	EMSG(_(e_noinstext));
7441 	return FAIL;
7442     }
7443 
7444     /* may want to stuff the command character, to start Insert mode */
7445     if (c != NUL)
7446 	stuffcharReadbuff(c);
7447     if ((esc_ptr = (char_u *)vim_strrchr(ptr, ESC)) != NULL)
7448 	*esc_ptr = NUL;	    /* remove the ESC */
7449 
7450     /* when the last char is either "0" or "^" it will be quoted if no ESC
7451      * comes after it OR if it will inserted more than once and "ptr"
7452      * starts with ^D.	-- Acevedo
7453      */
7454     last_ptr = (esc_ptr ? esc_ptr : ptr + STRLEN(ptr)) - 1;
7455     if (last_ptr >= ptr && (*last_ptr == '0' || *last_ptr == '^')
7456 	    && (no_esc || (*ptr == Ctrl_D && count > 1)))
7457     {
7458 	last = *last_ptr;
7459 	*last_ptr = NUL;
7460     }
7461 
7462     do
7463     {
7464 	stuffReadbuff(ptr);
7465 	/* a trailing "0" is inserted as "<C-V>048", "^" as "<C-V>^" */
7466 	if (last)
7467 	    stuffReadbuff((char_u *)(last == '0'
7468 			? IF_EB("\026\060\064\070", CTRL_V_STR "xf0")
7469 			: IF_EB("\026^", CTRL_V_STR "^")));
7470     }
7471     while (--count > 0);
7472 
7473     if (last)
7474 	*last_ptr = last;
7475 
7476     if (esc_ptr != NULL)
7477 	*esc_ptr = ESC;	    /* put the ESC back */
7478 
7479     /* may want to stuff a trailing ESC, to get out of Insert mode */
7480     if (!no_esc)
7481 	stuffcharReadbuff(ESC);
7482 
7483     return OK;
7484 }
7485 
7486     char_u *
7487 get_last_insert(void)
7488 {
7489     if (last_insert == NULL)
7490 	return NULL;
7491     return last_insert + last_insert_skip;
7492 }
7493 
7494 /*
7495  * Get last inserted string, and remove trailing <Esc>.
7496  * Returns pointer to allocated memory (must be freed) or NULL.
7497  */
7498     char_u *
7499 get_last_insert_save(void)
7500 {
7501     char_u	*s;
7502     int		len;
7503 
7504     if (last_insert == NULL)
7505 	return NULL;
7506     s = vim_strsave(last_insert + last_insert_skip);
7507     if (s != NULL)
7508     {
7509 	len = (int)STRLEN(s);
7510 	if (len > 0 && s[len - 1] == ESC)	/* remove trailing ESC */
7511 	    s[len - 1] = NUL;
7512     }
7513     return s;
7514 }
7515 
7516 /*
7517  * Check the word in front of the cursor for an abbreviation.
7518  * Called when the non-id character "c" has been entered.
7519  * When an abbreviation is recognized it is removed from the text and
7520  * the replacement string is inserted in typebuf.tb_buf[], followed by "c".
7521  */
7522     static int
7523 echeck_abbr(int c)
7524 {
7525     /* Don't check for abbreviation in paste mode, when disabled and just
7526      * after moving around with cursor keys. */
7527     if (p_paste || no_abbr || arrow_used)
7528 	return FALSE;
7529 
7530     return check_abbr(c, ml_get_curline(), curwin->w_cursor.col,
7531 		curwin->w_cursor.lnum == Insstart.lnum ? Insstart.col : 0);
7532 }
7533 
7534 /*
7535  * replace-stack functions
7536  *
7537  * When replacing characters, the replaced characters are remembered for each
7538  * new character.  This is used to re-insert the old text when backspacing.
7539  *
7540  * There is a NUL headed list of characters for each character that is
7541  * currently in the file after the insertion point.  When BS is used, one NUL
7542  * headed list is put back for the deleted character.
7543  *
7544  * For a newline, there are two NUL headed lists.  One contains the characters
7545  * that the NL replaced.  The extra one stores the characters after the cursor
7546  * that were deleted (always white space).
7547  *
7548  * Replace_offset is normally 0, in which case replace_push will add a new
7549  * character at the end of the stack.  If replace_offset is not 0, that many
7550  * characters will be left on the stack above the newly inserted character.
7551  */
7552 
7553 static char_u	*replace_stack = NULL;
7554 static long	replace_stack_nr = 0;	    /* next entry in replace stack */
7555 static long	replace_stack_len = 0;	    /* max. number of entries */
7556 
7557     void
7558 replace_push(
7559     int	    c)	    /* character that is replaced (NUL is none) */
7560 {
7561     char_u  *p;
7562 
7563     if (replace_stack_nr < replace_offset)	/* nothing to do */
7564 	return;
7565     if (replace_stack_len <= replace_stack_nr)
7566     {
7567 	replace_stack_len += 50;
7568 	p = lalloc(sizeof(char_u) * replace_stack_len, TRUE);
7569 	if (p == NULL)	    /* out of memory */
7570 	{
7571 	    replace_stack_len -= 50;
7572 	    return;
7573 	}
7574 	if (replace_stack != NULL)
7575 	{
7576 	    mch_memmove(p, replace_stack,
7577 				 (size_t)(replace_stack_nr * sizeof(char_u)));
7578 	    vim_free(replace_stack);
7579 	}
7580 	replace_stack = p;
7581     }
7582     p = replace_stack + replace_stack_nr - replace_offset;
7583     if (replace_offset)
7584 	mch_memmove(p + 1, p, (size_t)(replace_offset * sizeof(char_u)));
7585     *p = c;
7586     ++replace_stack_nr;
7587 }
7588 
7589 #if defined(FEAT_MBYTE) || defined(PROTO)
7590 /*
7591  * Push a character onto the replace stack.  Handles a multi-byte character in
7592  * reverse byte order, so that the first byte is popped off first.
7593  * Return the number of bytes done (includes composing characters).
7594  */
7595     int
7596 replace_push_mb(char_u *p)
7597 {
7598     int l = (*mb_ptr2len)(p);
7599     int j;
7600 
7601     for (j = l - 1; j >= 0; --j)
7602 	replace_push(p[j]);
7603     return l;
7604 }
7605 #endif
7606 
7607 /*
7608  * Pop one item from the replace stack.
7609  * return -1 if stack empty
7610  * return replaced character or NUL otherwise
7611  */
7612     static int
7613 replace_pop(void)
7614 {
7615     if (replace_stack_nr == 0)
7616 	return -1;
7617     return (int)replace_stack[--replace_stack_nr];
7618 }
7619 
7620 /*
7621  * Join the top two items on the replace stack.  This removes to "off"'th NUL
7622  * encountered.
7623  */
7624     static void
7625 replace_join(
7626     int	    off)	/* offset for which NUL to remove */
7627 {
7628     int	    i;
7629 
7630     for (i = replace_stack_nr; --i >= 0; )
7631 	if (replace_stack[i] == NUL && off-- <= 0)
7632 	{
7633 	    --replace_stack_nr;
7634 	    mch_memmove(replace_stack + i, replace_stack + i + 1,
7635 					      (size_t)(replace_stack_nr - i));
7636 	    return;
7637 	}
7638 }
7639 
7640 /*
7641  * Pop bytes from the replace stack until a NUL is found, and insert them
7642  * before the cursor.  Can only be used in REPLACE or VREPLACE mode.
7643  */
7644     static void
7645 replace_pop_ins(void)
7646 {
7647     int	    cc;
7648     int	    oldState = State;
7649 
7650     State = NORMAL;			/* don't want REPLACE here */
7651     while ((cc = replace_pop()) > 0)
7652     {
7653 #ifdef FEAT_MBYTE
7654 	mb_replace_pop_ins(cc);
7655 #else
7656 	ins_char(cc);
7657 #endif
7658 	dec_cursor();
7659     }
7660     State = oldState;
7661 }
7662 
7663 #ifdef FEAT_MBYTE
7664 /*
7665  * Insert bytes popped from the replace stack. "cc" is the first byte.  If it
7666  * indicates a multi-byte char, pop the other bytes too.
7667  */
7668     static void
7669 mb_replace_pop_ins(int cc)
7670 {
7671     int		n;
7672     char_u	buf[MB_MAXBYTES + 1];
7673     int		i;
7674     int		c;
7675 
7676     if (has_mbyte && (n = MB_BYTE2LEN(cc)) > 1)
7677     {
7678 	buf[0] = cc;
7679 	for (i = 1; i < n; ++i)
7680 	    buf[i] = replace_pop();
7681 	ins_bytes_len(buf, n);
7682     }
7683     else
7684 	ins_char(cc);
7685 
7686     if (enc_utf8)
7687 	/* Handle composing chars. */
7688 	for (;;)
7689 	{
7690 	    c = replace_pop();
7691 	    if (c == -1)	    /* stack empty */
7692 		break;
7693 	    if ((n = MB_BYTE2LEN(c)) == 1)
7694 	    {
7695 		/* Not a multi-byte char, put it back. */
7696 		replace_push(c);
7697 		break;
7698 	    }
7699 	    else
7700 	    {
7701 		buf[0] = c;
7702 		for (i = 1; i < n; ++i)
7703 		    buf[i] = replace_pop();
7704 		if (utf_iscomposing(utf_ptr2char(buf)))
7705 		    ins_bytes_len(buf, n);
7706 		else
7707 		{
7708 		    /* Not a composing char, put it back. */
7709 		    for (i = n - 1; i >= 0; --i)
7710 			replace_push(buf[i]);
7711 		    break;
7712 		}
7713 	    }
7714 	}
7715 }
7716 #endif
7717 
7718 /*
7719  * make the replace stack empty
7720  * (called when exiting replace mode)
7721  */
7722     static void
7723 replace_flush(void)
7724 {
7725     vim_free(replace_stack);
7726     replace_stack = NULL;
7727     replace_stack_len = 0;
7728     replace_stack_nr = 0;
7729 }
7730 
7731 /*
7732  * Handle doing a BS for one character.
7733  * cc < 0: replace stack empty, just move cursor
7734  * cc == 0: character was inserted, delete it
7735  * cc > 0: character was replaced, put cc (first byte of original char) back
7736  * and check for more characters to be put back
7737  * When "limit_col" is >= 0, don't delete before this column.  Matters when
7738  * using composing characters, use del_char_after_col() instead of del_char().
7739  */
7740     static void
7741 replace_do_bs(int limit_col)
7742 {
7743     int		cc;
7744 #ifdef FEAT_VREPLACE
7745     int		orig_len = 0;
7746     int		ins_len;
7747     int		orig_vcols = 0;
7748     colnr_T	start_vcol;
7749     char_u	*p;
7750     int		i;
7751     int		vcol;
7752 #endif
7753 
7754     cc = replace_pop();
7755     if (cc > 0)
7756     {
7757 #ifdef FEAT_VREPLACE
7758 	if (State & VREPLACE_FLAG)
7759 	{
7760 	    /* Get the number of screen cells used by the character we are
7761 	     * going to delete. */
7762 	    getvcol(curwin, &curwin->w_cursor, NULL, &start_vcol, NULL);
7763 	    orig_vcols = chartabsize(ml_get_cursor(), start_vcol);
7764 	}
7765 #endif
7766 #ifdef FEAT_MBYTE
7767 	if (has_mbyte)
7768 	{
7769 	    (void)del_char_after_col(limit_col);
7770 # ifdef FEAT_VREPLACE
7771 	    if (State & VREPLACE_FLAG)
7772 		orig_len = (int)STRLEN(ml_get_cursor());
7773 # endif
7774 	    replace_push(cc);
7775 	}
7776 	else
7777 #endif
7778 	{
7779 	    pchar_cursor(cc);
7780 #ifdef FEAT_VREPLACE
7781 	    if (State & VREPLACE_FLAG)
7782 		orig_len = (int)STRLEN(ml_get_cursor()) - 1;
7783 #endif
7784 	}
7785 	replace_pop_ins();
7786 
7787 #ifdef FEAT_VREPLACE
7788 	if (State & VREPLACE_FLAG)
7789 	{
7790 	    /* Get the number of screen cells used by the inserted characters */
7791 	    p = ml_get_cursor();
7792 	    ins_len = (int)STRLEN(p) - orig_len;
7793 	    vcol = start_vcol;
7794 	    for (i = 0; i < ins_len; ++i)
7795 	    {
7796 		vcol += chartabsize(p + i, vcol);
7797 #ifdef FEAT_MBYTE
7798 		i += (*mb_ptr2len)(p) - 1;
7799 #endif
7800 	    }
7801 	    vcol -= start_vcol;
7802 
7803 	    /* Delete spaces that were inserted after the cursor to keep the
7804 	     * text aligned. */
7805 	    curwin->w_cursor.col += ins_len;
7806 	    while (vcol > orig_vcols && gchar_cursor() == ' ')
7807 	    {
7808 		del_char(FALSE);
7809 		++orig_vcols;
7810 	    }
7811 	    curwin->w_cursor.col -= ins_len;
7812 	}
7813 #endif
7814 
7815 	/* mark the buffer as changed and prepare for displaying */
7816 	changed_bytes(curwin->w_cursor.lnum, curwin->w_cursor.col);
7817     }
7818     else if (cc == 0)
7819 	(void)del_char_after_col(limit_col);
7820 }
7821 
7822 #ifdef FEAT_CINDENT
7823 /*
7824  * Return TRUE if C-indenting is on.
7825  */
7826     static int
7827 cindent_on(void)
7828 {
7829     return (!p_paste && (curbuf->b_p_cin
7830 # ifdef FEAT_EVAL
7831 		    || *curbuf->b_p_inde != NUL
7832 # endif
7833 		    ));
7834 }
7835 #endif
7836 
7837 #if defined(FEAT_LISP) || defined(FEAT_CINDENT) || defined(PROTO)
7838 /*
7839  * Re-indent the current line, based on the current contents of it and the
7840  * surrounding lines. Fixing the cursor position seems really easy -- I'm very
7841  * confused what all the part that handles Control-T is doing that I'm not.
7842  * "get_the_indent" should be get_c_indent, get_expr_indent or get_lisp_indent.
7843  */
7844 
7845     void
7846 fixthisline(int (*get_the_indent)(void))
7847 {
7848     int amount = get_the_indent();
7849 
7850     if (amount >= 0)
7851     {
7852 	change_indent(INDENT_SET, amount, FALSE, 0, TRUE);
7853 	if (linewhite(curwin->w_cursor.lnum))
7854 	    did_ai = TRUE;	/* delete the indent if the line stays empty */
7855     }
7856 }
7857 
7858     void
7859 fix_indent(void)
7860 {
7861     if (p_paste)
7862 	return;
7863 # ifdef FEAT_LISP
7864     if (curbuf->b_p_lisp && curbuf->b_p_ai)
7865 	fixthisline(get_lisp_indent);
7866 # endif
7867 # if defined(FEAT_LISP) && defined(FEAT_CINDENT)
7868     else
7869 # endif
7870 # ifdef FEAT_CINDENT
7871 	if (cindent_on())
7872 	    do_c_expr_indent();
7873 # endif
7874 }
7875 
7876 #endif
7877 
7878 #ifdef FEAT_CINDENT
7879 /*
7880  * return TRUE if 'cinkeys' contains the key "keytyped",
7881  * when == '*':	    Only if key is preceded with '*'	(indent before insert)
7882  * when == '!':	    Only if key is preceded with '!'	(don't insert)
7883  * when == ' ':	    Only if key is not preceded with '*'(indent afterwards)
7884  *
7885  * "keytyped" can have a few special values:
7886  * KEY_OPEN_FORW
7887  * KEY_OPEN_BACK
7888  * KEY_COMPLETE	    just finished completion.
7889  *
7890  * If line_is_empty is TRUE accept keys with '0' before them.
7891  */
7892     int
7893 in_cinkeys(
7894     int		keytyped,
7895     int		when,
7896     int		line_is_empty)
7897 {
7898     char_u	*look;
7899     int		try_match;
7900     int		try_match_word;
7901     char_u	*p;
7902     char_u	*line;
7903     int		icase;
7904     int		i;
7905 
7906     if (keytyped == NUL)
7907 	/* Can happen with CTRL-Y and CTRL-E on a short line. */
7908 	return FALSE;
7909 
7910 #ifdef FEAT_EVAL
7911     if (*curbuf->b_p_inde != NUL)
7912 	look = curbuf->b_p_indk;	/* 'indentexpr' set: use 'indentkeys' */
7913     else
7914 #endif
7915 	look = curbuf->b_p_cink;	/* 'indentexpr' empty: use 'cinkeys' */
7916     while (*look)
7917     {
7918 	/*
7919 	 * Find out if we want to try a match with this key, depending on
7920 	 * 'when' and a '*' or '!' before the key.
7921 	 */
7922 	switch (when)
7923 	{
7924 	    case '*': try_match = (*look == '*'); break;
7925 	    case '!': try_match = (*look == '!'); break;
7926 	     default: try_match = (*look != '*'); break;
7927 	}
7928 	if (*look == '*' || *look == '!')
7929 	    ++look;
7930 
7931 	/*
7932 	 * If there is a '0', only accept a match if the line is empty.
7933 	 * But may still match when typing last char of a word.
7934 	 */
7935 	if (*look == '0')
7936 	{
7937 	    try_match_word = try_match;
7938 	    if (!line_is_empty)
7939 		try_match = FALSE;
7940 	    ++look;
7941 	}
7942 	else
7943 	    try_match_word = FALSE;
7944 
7945 	/*
7946 	 * does it look like a control character?
7947 	 */
7948 	if (*look == '^'
7949 #ifdef EBCDIC
7950 		&& (Ctrl_chr(look[1]) != 0)
7951 #else
7952 		&& look[1] >= '?' && look[1] <= '_'
7953 #endif
7954 		)
7955 	{
7956 	    if (try_match && keytyped == Ctrl_chr(look[1]))
7957 		return TRUE;
7958 	    look += 2;
7959 	}
7960 	/*
7961 	 * 'o' means "o" command, open forward.
7962 	 * 'O' means "O" command, open backward.
7963 	 */
7964 	else if (*look == 'o')
7965 	{
7966 	    if (try_match && keytyped == KEY_OPEN_FORW)
7967 		return TRUE;
7968 	    ++look;
7969 	}
7970 	else if (*look == 'O')
7971 	{
7972 	    if (try_match && keytyped == KEY_OPEN_BACK)
7973 		return TRUE;
7974 	    ++look;
7975 	}
7976 
7977 	/*
7978 	 * 'e' means to check for "else" at start of line and just before the
7979 	 * cursor.
7980 	 */
7981 	else if (*look == 'e')
7982 	{
7983 	    if (try_match && keytyped == 'e' && curwin->w_cursor.col >= 4)
7984 	    {
7985 		p = ml_get_curline();
7986 		if (skipwhite(p) == p + curwin->w_cursor.col - 4 &&
7987 			STRNCMP(p + curwin->w_cursor.col - 4, "else", 4) == 0)
7988 		    return TRUE;
7989 	    }
7990 	    ++look;
7991 	}
7992 
7993 	/*
7994 	 * ':' only causes an indent if it is at the end of a label or case
7995 	 * statement, or when it was before typing the ':' (to fix
7996 	 * class::method for C++).
7997 	 */
7998 	else if (*look == ':')
7999 	{
8000 	    if (try_match && keytyped == ':')
8001 	    {
8002 		p = ml_get_curline();
8003 		if (cin_iscase(p, FALSE) || cin_isscopedecl(p) || cin_islabel())
8004 		    return TRUE;
8005 		/* Need to get the line again after cin_islabel(). */
8006 		p = ml_get_curline();
8007 		if (curwin->w_cursor.col > 2
8008 			&& p[curwin->w_cursor.col - 1] == ':'
8009 			&& p[curwin->w_cursor.col - 2] == ':')
8010 		{
8011 		    p[curwin->w_cursor.col - 1] = ' ';
8012 		    i = (cin_iscase(p, FALSE) || cin_isscopedecl(p)
8013 							    || cin_islabel());
8014 		    p = ml_get_curline();
8015 		    p[curwin->w_cursor.col - 1] = ':';
8016 		    if (i)
8017 			return TRUE;
8018 		}
8019 	    }
8020 	    ++look;
8021 	}
8022 
8023 
8024 	/*
8025 	 * Is it a key in <>, maybe?
8026 	 */
8027 	else if (*look == '<')
8028 	{
8029 	    if (try_match)
8030 	    {
8031 		/*
8032 		 * make up some named keys <o>, <O>, <e>, <0>, <>>, <<>, <*>,
8033 		 * <:> and <!> so that people can re-indent on o, O, e, 0, <,
8034 		 * >, *, : and ! keys if they really really want to.
8035 		 */
8036 		if (vim_strchr((char_u *)"<>!*oOe0:", look[1]) != NULL
8037 						       && keytyped == look[1])
8038 		    return TRUE;
8039 
8040 		if (keytyped == get_special_key_code(look + 1))
8041 		    return TRUE;
8042 	    }
8043 	    while (*look && *look != '>')
8044 		look++;
8045 	    while (*look == '>')
8046 		look++;
8047 	}
8048 
8049 	/*
8050 	 * Is it a word: "=word"?
8051 	 */
8052 	else if (*look == '=' && look[1] != ',' && look[1] != NUL)
8053 	{
8054 	    ++look;
8055 	    if (*look == '~')
8056 	    {
8057 		icase = TRUE;
8058 		++look;
8059 	    }
8060 	    else
8061 		icase = FALSE;
8062 	    p = vim_strchr(look, ',');
8063 	    if (p == NULL)
8064 		p = look + STRLEN(look);
8065 	    if ((try_match || try_match_word)
8066 		    && curwin->w_cursor.col >= (colnr_T)(p - look))
8067 	    {
8068 		int		match = FALSE;
8069 
8070 #ifdef FEAT_INS_EXPAND
8071 		if (keytyped == KEY_COMPLETE)
8072 		{
8073 		    char_u	*s;
8074 
8075 		    /* Just completed a word, check if it starts with "look".
8076 		     * search back for the start of a word. */
8077 		    line = ml_get_curline();
8078 # ifdef FEAT_MBYTE
8079 		    if (has_mbyte)
8080 		    {
8081 			char_u	*n;
8082 
8083 			for (s = line + curwin->w_cursor.col; s > line; s = n)
8084 			{
8085 			    n = mb_prevptr(line, s);
8086 			    if (!vim_iswordp(n))
8087 				break;
8088 			}
8089 		    }
8090 		    else
8091 # endif
8092 			for (s = line + curwin->w_cursor.col; s > line; --s)
8093 			    if (!vim_iswordc(s[-1]))
8094 				break;
8095 		    if (s + (p - look) <= line + curwin->w_cursor.col
8096 			    && (icase
8097 				? MB_STRNICMP(s, look, p - look)
8098 				: STRNCMP(s, look, p - look)) == 0)
8099 			match = TRUE;
8100 		}
8101 		else
8102 #endif
8103 		    /* TODO: multi-byte */
8104 		    if (keytyped == (int)p[-1] || (icase && keytyped < 256
8105 			 && TOLOWER_LOC(keytyped) == TOLOWER_LOC((int)p[-1])))
8106 		{
8107 		    line = ml_get_cursor();
8108 		    if ((curwin->w_cursor.col == (colnr_T)(p - look)
8109 				|| !vim_iswordc(line[-(p - look) - 1]))
8110 			    && (icase
8111 				? MB_STRNICMP(line - (p - look), look, p - look)
8112 				: STRNCMP(line - (p - look), look, p - look))
8113 									 == 0)
8114 			match = TRUE;
8115 		}
8116 		if (match && try_match_word && !try_match)
8117 		{
8118 		    /* "0=word": Check if there are only blanks before the
8119 		     * word. */
8120 		    line = ml_get_curline();
8121 		    if ((int)(skipwhite(line) - line) !=
8122 				     (int)(curwin->w_cursor.col - (p - look)))
8123 			match = FALSE;
8124 		}
8125 		if (match)
8126 		    return TRUE;
8127 	    }
8128 	    look = p;
8129 	}
8130 
8131 	/*
8132 	 * ok, it's a boring generic character.
8133 	 */
8134 	else
8135 	{
8136 	    if (try_match && *look == keytyped)
8137 		return TRUE;
8138 	    ++look;
8139 	}
8140 
8141 	/*
8142 	 * Skip over ", ".
8143 	 */
8144 	look = skip_to_option_part(look);
8145     }
8146     return FALSE;
8147 }
8148 #endif /* FEAT_CINDENT */
8149 
8150 #if defined(FEAT_RIGHTLEFT) || defined(PROTO)
8151 /*
8152  * Map Hebrew keyboard when in hkmap mode.
8153  */
8154     int
8155 hkmap(int c)
8156 {
8157     if (p_hkmapp)   /* phonetic mapping, by Ilya Dogolazky */
8158     {
8159 	enum {hALEF=0, BET, GIMEL, DALET, HEI, VAV, ZAIN, HET, TET, IUD,
8160 	    KAFsofit, hKAF, LAMED, MEMsofit, MEM, NUNsofit, NUN, SAMEH, AIN,
8161 	    PEIsofit, PEI, ZADIsofit, ZADI, KOF, RESH, hSHIN, TAV};
8162 	static char_u map[26] =
8163 	    {(char_u)hALEF/*a*/, (char_u)BET  /*b*/, (char_u)hKAF    /*c*/,
8164 	     (char_u)DALET/*d*/, (char_u)-1   /*e*/, (char_u)PEIsofit/*f*/,
8165 	     (char_u)GIMEL/*g*/, (char_u)HEI  /*h*/, (char_u)IUD     /*i*/,
8166 	     (char_u)HET  /*j*/, (char_u)KOF  /*k*/, (char_u)LAMED   /*l*/,
8167 	     (char_u)MEM  /*m*/, (char_u)NUN  /*n*/, (char_u)SAMEH   /*o*/,
8168 	     (char_u)PEI  /*p*/, (char_u)-1   /*q*/, (char_u)RESH    /*r*/,
8169 	     (char_u)ZAIN /*s*/, (char_u)TAV  /*t*/, (char_u)TET     /*u*/,
8170 	     (char_u)VAV  /*v*/, (char_u)hSHIN/*w*/, (char_u)-1      /*x*/,
8171 	     (char_u)AIN  /*y*/, (char_u)ZADI /*z*/};
8172 
8173 	if (c == 'N' || c == 'M' || c == 'P' || c == 'C' || c == 'Z')
8174 	    return (int)(map[CharOrd(c)] - 1 + p_aleph);
8175 							    /* '-1'='sofit' */
8176 	else if (c == 'x')
8177 	    return 'X';
8178 	else if (c == 'q')
8179 	    return '\''; /* {geresh}={'} */
8180 	else if (c == 246)
8181 	    return ' ';  /* \"o --> ' ' for a german keyboard */
8182 	else if (c == 228)
8183 	    return ' ';  /* \"a --> ' '      -- / --	       */
8184 	else if (c == 252)
8185 	    return ' ';  /* \"u --> ' '      -- / --	       */
8186 #ifdef EBCDIC
8187 	else if (islower(c))
8188 #else
8189 	/* NOTE: islower() does not do the right thing for us on Linux so we
8190 	 * do this the same was as 5.7 and previous, so it works correctly on
8191 	 * all systems.  Specifically, the e.g. Delete and Arrow keys are
8192 	 * munged and won't work if e.g. searching for Hebrew text.
8193 	 */
8194 	else if (c >= 'a' && c <= 'z')
8195 #endif
8196 	    return (int)(map[CharOrdLow(c)] + p_aleph);
8197 	else
8198 	    return c;
8199     }
8200     else
8201     {
8202 	switch (c)
8203 	{
8204 	    case '`':	return ';';
8205 	    case '/':	return '.';
8206 	    case '\'':	return ',';
8207 	    case 'q':	return '/';
8208 	    case 'w':	return '\'';
8209 
8210 			/* Hebrew letters - set offset from 'a' */
8211 	    case ',':	c = '{'; break;
8212 	    case '.':	c = 'v'; break;
8213 	    case ';':	c = 't'; break;
8214 	    default: {
8215 			 static char str[] = "zqbcxlsjphmkwonu ydafe rig";
8216 
8217 #ifdef EBCDIC
8218 			 /* see note about islower() above */
8219 			 if (!islower(c))
8220 #else
8221 			 if (c < 'a' || c > 'z')
8222 #endif
8223 			     return c;
8224 			 c = str[CharOrdLow(c)];
8225 			 break;
8226 		     }
8227 	}
8228 
8229 	return (int)(CharOrdLow(c) + p_aleph);
8230     }
8231 }
8232 #endif
8233 
8234     static void
8235 ins_reg(void)
8236 {
8237     int		need_redraw = FALSE;
8238     int		regname;
8239     int		literally = 0;
8240     int		vis_active = VIsual_active;
8241 
8242     /*
8243      * If we are going to wait for a character, show a '"'.
8244      */
8245     pc_status = PC_STATUS_UNSET;
8246     if (redrawing() && !char_avail())
8247     {
8248 	/* may need to redraw when no more chars available now */
8249 	ins_redraw(FALSE);
8250 
8251 	edit_putchar('"', TRUE);
8252 #ifdef FEAT_CMDL_INFO
8253 	add_to_showcmd_c(Ctrl_R);
8254 #endif
8255     }
8256 
8257 #ifdef USE_ON_FLY_SCROLL
8258     dont_scroll = TRUE;		/* disallow scrolling here */
8259 #endif
8260 
8261     /*
8262      * Don't map the register name. This also prevents the mode message to be
8263      * deleted when ESC is hit.
8264      */
8265     ++no_mapping;
8266     regname = plain_vgetc();
8267     LANGMAP_ADJUST(regname, TRUE);
8268     if (regname == Ctrl_R || regname == Ctrl_O || regname == Ctrl_P)
8269     {
8270 	/* Get a third key for literal register insertion */
8271 	literally = regname;
8272 #ifdef FEAT_CMDL_INFO
8273 	add_to_showcmd_c(literally);
8274 #endif
8275 	regname = plain_vgetc();
8276 	LANGMAP_ADJUST(regname, TRUE);
8277     }
8278     --no_mapping;
8279 
8280 #ifdef FEAT_EVAL
8281     /* Don't call u_sync() while typing the expression or giving an error
8282      * message for it. Only call it explicitly. */
8283     ++no_u_sync;
8284     if (regname == '=')
8285     {
8286 # ifdef USE_IM_CONTROL
8287 	int	im_on = im_get_status();
8288 # endif
8289 	/* Sync undo when evaluating the expression calls setline() or
8290 	 * append(), so that it can be undone separately. */
8291 	u_sync_once = 2;
8292 
8293 	regname = get_expr_register();
8294 # ifdef USE_IM_CONTROL
8295 	/* Restore the Input Method. */
8296 	if (im_on)
8297 	    im_set_active(TRUE);
8298 # endif
8299     }
8300     if (regname == NUL || !valid_yank_reg(regname, FALSE))
8301     {
8302 	vim_beep(BO_REG);
8303 	need_redraw = TRUE;	/* remove the '"' */
8304     }
8305     else
8306     {
8307 #endif
8308 	if (literally == Ctrl_O || literally == Ctrl_P)
8309 	{
8310 	    /* Append the command to the redo buffer. */
8311 	    AppendCharToRedobuff(Ctrl_R);
8312 	    AppendCharToRedobuff(literally);
8313 	    AppendCharToRedobuff(regname);
8314 
8315 	    do_put(regname, BACKWARD, 1L,
8316 		 (literally == Ctrl_P ? PUT_FIXINDENT : 0) | PUT_CURSEND);
8317 	}
8318 	else if (insert_reg(regname, literally) == FAIL)
8319 	{
8320 	    vim_beep(BO_REG);
8321 	    need_redraw = TRUE;	/* remove the '"' */
8322 	}
8323 	else if (stop_insert_mode)
8324 	    /* When the '=' register was used and a function was invoked that
8325 	     * did ":stopinsert" then stuff_empty() returns FALSE but we won't
8326 	     * insert anything, need to remove the '"' */
8327 	    need_redraw = TRUE;
8328 
8329 #ifdef FEAT_EVAL
8330     }
8331     --no_u_sync;
8332     if (u_sync_once == 1)
8333 	ins_need_undo = TRUE;
8334     u_sync_once = 0;
8335 #endif
8336 #ifdef FEAT_CMDL_INFO
8337     clear_showcmd();
8338 #endif
8339 
8340     /* If the inserted register is empty, we need to remove the '"' */
8341     if (need_redraw || stuff_empty())
8342 	edit_unputchar();
8343 
8344     /* Disallow starting Visual mode here, would get a weird mode. */
8345     if (!vis_active && VIsual_active)
8346 	end_visual_mode();
8347 }
8348 
8349 /*
8350  * CTRL-G commands in Insert mode.
8351  */
8352     static void
8353 ins_ctrl_g(void)
8354 {
8355     int		c;
8356 
8357 #ifdef FEAT_INS_EXPAND
8358     /* Right after CTRL-X the cursor will be after the ruler. */
8359     setcursor();
8360 #endif
8361 
8362     /*
8363      * Don't map the second key. This also prevents the mode message to be
8364      * deleted when ESC is hit.
8365      */
8366     ++no_mapping;
8367     c = plain_vgetc();
8368     --no_mapping;
8369     switch (c)
8370     {
8371 	/* CTRL-G k and CTRL-G <Up>: cursor up to Insstart.col */
8372 	case K_UP:
8373 	case Ctrl_K:
8374 	case 'k': ins_up(TRUE);
8375 		  break;
8376 
8377 	/* CTRL-G j and CTRL-G <Down>: cursor down to Insstart.col */
8378 	case K_DOWN:
8379 	case Ctrl_J:
8380 	case 'j': ins_down(TRUE);
8381 		  break;
8382 
8383 	/* CTRL-G u: start new undoable edit */
8384 	case 'u': u_sync(TRUE);
8385 		  ins_need_undo = TRUE;
8386 
8387 		  /* Need to reset Insstart, esp. because a BS that joins
8388 		   * a line to the previous one must save for undo. */
8389 		  update_Insstart_orig = FALSE;
8390 		  Insstart = curwin->w_cursor;
8391 		  break;
8392 
8393 	/* CTRL-G U: do not break undo with the next char */
8394 	case 'U':
8395 		  /* Allow one left/right cursor movement with the next char,
8396 		   * without breaking undo. */
8397 		  dont_sync_undo = MAYBE;
8398 		  break;
8399 
8400 	/* Unknown CTRL-G command, reserved for future expansion. */
8401 	default:  vim_beep(BO_CTRLG);
8402     }
8403 }
8404 
8405 /*
8406  * CTRL-^ in Insert mode.
8407  */
8408     static void
8409 ins_ctrl_hat(void)
8410 {
8411     if (map_to_exists_mode((char_u *)"", LANGMAP, FALSE))
8412     {
8413 	/* ":lmap" mappings exists, Toggle use of ":lmap" mappings. */
8414 	if (State & LANGMAP)
8415 	{
8416 	    curbuf->b_p_iminsert = B_IMODE_NONE;
8417 	    State &= ~LANGMAP;
8418 	}
8419 	else
8420 	{
8421 	    curbuf->b_p_iminsert = B_IMODE_LMAP;
8422 	    State |= LANGMAP;
8423 #ifdef USE_IM_CONTROL
8424 	    im_set_active(FALSE);
8425 #endif
8426 	}
8427     }
8428 #ifdef USE_IM_CONTROL
8429     else
8430     {
8431 	/* There are no ":lmap" mappings, toggle IM */
8432 	if (im_get_status())
8433 	{
8434 	    curbuf->b_p_iminsert = B_IMODE_NONE;
8435 	    im_set_active(FALSE);
8436 	}
8437 	else
8438 	{
8439 	    curbuf->b_p_iminsert = B_IMODE_IM;
8440 	    State &= ~LANGMAP;
8441 	    im_set_active(TRUE);
8442 	}
8443     }
8444 #endif
8445     set_iminsert_global();
8446     showmode();
8447 #ifdef FEAT_GUI
8448     /* may show different cursor shape or color */
8449     if (gui.in_use)
8450 	gui_update_cursor(TRUE, FALSE);
8451 #endif
8452 #if defined(FEAT_WINDOWS) && defined(FEAT_KEYMAP)
8453     /* Show/unshow value of 'keymap' in status lines. */
8454     status_redraw_curbuf();
8455 #endif
8456 }
8457 
8458 /*
8459  * Handle ESC in insert mode.
8460  * Returns TRUE when leaving insert mode, FALSE when going to repeat the
8461  * insert.
8462  */
8463     static int
8464 ins_esc(
8465     long	*count,
8466     int		cmdchar,
8467     int		nomove)	    /* don't move cursor */
8468 {
8469     int		temp;
8470     static int	disabled_redraw = FALSE;
8471 
8472 #ifdef FEAT_SPELL
8473     check_spell_redraw();
8474 #endif
8475 #if defined(FEAT_HANGULIN)
8476 # if defined(ESC_CHG_TO_ENG_MODE)
8477     hangul_input_state_set(0);
8478 # endif
8479     if (composing_hangul)
8480     {
8481 	push_raw_key(composing_hangul_buffer, 2);
8482 	composing_hangul = 0;
8483     }
8484 #endif
8485 
8486     temp = curwin->w_cursor.col;
8487     if (disabled_redraw)
8488     {
8489 	--RedrawingDisabled;
8490 	disabled_redraw = FALSE;
8491     }
8492     if (!arrow_used)
8493     {
8494 	/*
8495 	 * Don't append the ESC for "r<CR>" and "grx".
8496 	 * When 'insertmode' is set only CTRL-L stops Insert mode.  Needed for
8497 	 * when "count" is non-zero.
8498 	 */
8499 	if (cmdchar != 'r' && cmdchar != 'v')
8500 	    AppendToRedobuff(p_im ? (char_u *)"\014" : ESC_STR);
8501 
8502 	/*
8503 	 * Repeating insert may take a long time.  Check for
8504 	 * interrupt now and then.
8505 	 */
8506 	if (*count > 0)
8507 	{
8508 	    line_breakcheck();
8509 	    if (got_int)
8510 		*count = 0;
8511 	}
8512 
8513 	if (--*count > 0)	/* repeat what was typed */
8514 	{
8515 	    /* Vi repeats the insert without replacing characters. */
8516 	    if (vim_strchr(p_cpo, CPO_REPLCNT) != NULL)
8517 		State &= ~REPLACE_FLAG;
8518 
8519 	    (void)start_redo_ins();
8520 	    if (cmdchar == 'r' || cmdchar == 'v')
8521 		stuffRedoReadbuff(ESC_STR);	/* no ESC in redo buffer */
8522 	    ++RedrawingDisabled;
8523 	    disabled_redraw = TRUE;
8524 	    return FALSE;	/* repeat the insert */
8525 	}
8526 	stop_insert(&curwin->w_cursor, TRUE, nomove);
8527 	undisplay_dollar();
8528     }
8529 
8530     /* When an autoindent was removed, curswant stays after the
8531      * indent */
8532     if (restart_edit == NUL && (colnr_T)temp == curwin->w_cursor.col)
8533 	curwin->w_set_curswant = TRUE;
8534 
8535     /* Remember the last Insert position in the '^ mark. */
8536     if (!cmdmod.keepjumps)
8537 	curbuf->b_last_insert = curwin->w_cursor;
8538 
8539     /*
8540      * The cursor should end up on the last inserted character.
8541      * Don't do it for CTRL-O, unless past the end of the line.
8542      */
8543     if (!nomove
8544 	    && (curwin->w_cursor.col != 0
8545 #ifdef FEAT_VIRTUALEDIT
8546 		|| curwin->w_cursor.coladd > 0
8547 #endif
8548 	       )
8549 	    && (restart_edit == NUL
8550 		   || (gchar_cursor() == NUL && !VIsual_active))
8551 #ifdef FEAT_RIGHTLEFT
8552 	    && !revins_on
8553 #endif
8554 				      )
8555     {
8556 #ifdef FEAT_VIRTUALEDIT
8557 	if (curwin->w_cursor.coladd > 0 || ve_flags == VE_ALL)
8558 	{
8559 	    oneleft();
8560 	    if (restart_edit != NUL)
8561 		++curwin->w_cursor.coladd;
8562 	}
8563 	else
8564 #endif
8565 	{
8566 	    --curwin->w_cursor.col;
8567 #ifdef FEAT_MBYTE
8568 	    /* Correct cursor for multi-byte character. */
8569 	    if (has_mbyte)
8570 		mb_adjust_cursor();
8571 #endif
8572 	}
8573     }
8574 
8575 #ifdef USE_IM_CONTROL
8576     /* Disable IM to allow typing English directly for Normal mode commands.
8577      * When ":lmap" is enabled don't change 'iminsert' (IM can be enabled as
8578      * well). */
8579     if (!(State & LANGMAP))
8580 	im_save_status(&curbuf->b_p_iminsert);
8581     im_set_active(FALSE);
8582 #endif
8583 
8584     State = NORMAL;
8585     /* need to position cursor again (e.g. when on a TAB ) */
8586     changed_cline_bef_curs();
8587 
8588 #ifdef FEAT_MOUSE
8589     setmouse();
8590 #endif
8591 #ifdef CURSOR_SHAPE
8592     ui_cursor_shape();		/* may show different cursor shape */
8593 #endif
8594 
8595     /*
8596      * When recording or for CTRL-O, need to display the new mode.
8597      * Otherwise remove the mode message.
8598      */
8599     if (Recording || restart_edit != NUL)
8600 	showmode();
8601     else if (p_smd)
8602 	MSG("");
8603 
8604     return TRUE;	    /* exit Insert mode */
8605 }
8606 
8607 #ifdef FEAT_RIGHTLEFT
8608 /*
8609  * Toggle language: hkmap and revins_on.
8610  * Move to end of reverse inserted text.
8611  */
8612     static void
8613 ins_ctrl_(void)
8614 {
8615     if (revins_on && revins_chars && revins_scol >= 0)
8616     {
8617 	while (gchar_cursor() != NUL && revins_chars--)
8618 	    ++curwin->w_cursor.col;
8619     }
8620     p_ri = !p_ri;
8621     revins_on = (State == INSERT && p_ri);
8622     if (revins_on)
8623     {
8624 	revins_scol = curwin->w_cursor.col;
8625 	revins_legal++;
8626 	revins_chars = 0;
8627 	undisplay_dollar();
8628     }
8629     else
8630 	revins_scol = -1;
8631 #ifdef FEAT_FKMAP
8632     if (p_altkeymap)
8633     {
8634 	/*
8635 	 * to be consistent also for redo command, using '.'
8636 	 * set arrow_used to true and stop it - causing to redo
8637 	 * characters entered in one mode (normal/reverse insert).
8638 	 */
8639 	arrow_used = TRUE;
8640 	(void)stop_arrow();
8641 	p_fkmap = curwin->w_p_rl ^ p_ri;
8642 	if (p_fkmap && p_ri)
8643 	    State = INSERT;
8644     }
8645     else
8646 #endif
8647 	p_hkmap = curwin->w_p_rl ^ p_ri;    /* be consistent! */
8648     showmode();
8649 }
8650 #endif
8651 
8652 /*
8653  * If 'keymodel' contains "startsel", may start selection.
8654  * Returns TRUE when a CTRL-O and other keys stuffed.
8655  */
8656     static int
8657 ins_start_select(int c)
8658 {
8659     if (km_startsel)
8660 	switch (c)
8661 	{
8662 	    case K_KHOME:
8663 	    case K_KEND:
8664 	    case K_PAGEUP:
8665 	    case K_KPAGEUP:
8666 	    case K_PAGEDOWN:
8667 	    case K_KPAGEDOWN:
8668 # ifdef MACOS
8669 	    case K_LEFT:
8670 	    case K_RIGHT:
8671 	    case K_UP:
8672 	    case K_DOWN:
8673 	    case K_END:
8674 	    case K_HOME:
8675 # endif
8676 		if (!(mod_mask & MOD_MASK_SHIFT))
8677 		    break;
8678 		/* FALLTHROUGH */
8679 	    case K_S_LEFT:
8680 	    case K_S_RIGHT:
8681 	    case K_S_UP:
8682 	    case K_S_DOWN:
8683 	    case K_S_END:
8684 	    case K_S_HOME:
8685 		/* Start selection right away, the cursor can move with
8686 		 * CTRL-O when beyond the end of the line. */
8687 		start_selection();
8688 
8689 		/* Execute the key in (insert) Select mode. */
8690 		stuffcharReadbuff(Ctrl_O);
8691 		if (mod_mask)
8692 		{
8693 		    char_u	    buf[4];
8694 
8695 		    buf[0] = K_SPECIAL;
8696 		    buf[1] = KS_MODIFIER;
8697 		    buf[2] = mod_mask;
8698 		    buf[3] = NUL;
8699 		    stuffReadbuff(buf);
8700 		}
8701 		stuffcharReadbuff(c);
8702 		return TRUE;
8703 	}
8704     return FALSE;
8705 }
8706 
8707 /*
8708  * <Insert> key in Insert mode: toggle insert/replace mode.
8709  */
8710     static void
8711 ins_insert(int replaceState)
8712 {
8713 #ifdef FEAT_FKMAP
8714     if (p_fkmap && p_ri)
8715     {
8716 	beep_flush();
8717 	EMSG(farsi_text_3);	/* encoded in Farsi */
8718 	return;
8719     }
8720 #endif
8721 
8722 #ifdef FEAT_AUTOCMD
8723 # ifdef FEAT_EVAL
8724     set_vim_var_string(VV_INSERTMODE,
8725 		   (char_u *)((State & REPLACE_FLAG) ? "i" :
8726 #  ifdef FEAT_VREPLACE
8727 			    replaceState == VREPLACE ? "v" :
8728 #  endif
8729 			    "r"), 1);
8730 # endif
8731     apply_autocmds(EVENT_INSERTCHANGE, NULL, NULL, FALSE, curbuf);
8732 #endif
8733     if (State & REPLACE_FLAG)
8734 	State = INSERT | (State & LANGMAP);
8735     else
8736 	State = replaceState | (State & LANGMAP);
8737     AppendCharToRedobuff(K_INS);
8738     showmode();
8739 #ifdef CURSOR_SHAPE
8740     ui_cursor_shape();		/* may show different cursor shape */
8741 #endif
8742 }
8743 
8744 /*
8745  * Pressed CTRL-O in Insert mode.
8746  */
8747     static void
8748 ins_ctrl_o(void)
8749 {
8750 #ifdef FEAT_VREPLACE
8751     if (State & VREPLACE_FLAG)
8752 	restart_edit = 'V';
8753     else
8754 #endif
8755 	if (State & REPLACE_FLAG)
8756 	restart_edit = 'R';
8757     else
8758 	restart_edit = 'I';
8759 #ifdef FEAT_VIRTUALEDIT
8760     if (virtual_active())
8761 	ins_at_eol = FALSE;	/* cursor always keeps its column */
8762     else
8763 #endif
8764 	ins_at_eol = (gchar_cursor() == NUL);
8765 }
8766 
8767 /*
8768  * If the cursor is on an indent, ^T/^D insert/delete one
8769  * shiftwidth.	Otherwise ^T/^D behave like a "<<" or ">>".
8770  * Always round the indent to 'shiftwidth', this is compatible
8771  * with vi.  But vi only supports ^T and ^D after an
8772  * autoindent, we support it everywhere.
8773  */
8774     static void
8775 ins_shift(int c, int lastc)
8776 {
8777     if (stop_arrow() == FAIL)
8778 	return;
8779     AppendCharToRedobuff(c);
8780 
8781     /*
8782      * 0^D and ^^D: remove all indent.
8783      */
8784     if (c == Ctrl_D && (lastc == '0' || lastc == '^')
8785 						  && curwin->w_cursor.col > 0)
8786     {
8787 	--curwin->w_cursor.col;
8788 	(void)del_char(FALSE);		/* delete the '^' or '0' */
8789 	/* In Replace mode, restore the characters that '^' or '0' replaced. */
8790 	if (State & REPLACE_FLAG)
8791 	    replace_pop_ins();
8792 	if (lastc == '^')
8793 	    old_indent = get_indent();	/* remember curr. indent */
8794 	change_indent(INDENT_SET, 0, TRUE, 0, TRUE);
8795     }
8796     else
8797 	change_indent(c == Ctrl_D ? INDENT_DEC : INDENT_INC, 0, TRUE, 0, TRUE);
8798 
8799     if (did_ai && *skipwhite(ml_get_curline()) != NUL)
8800 	did_ai = FALSE;
8801 #ifdef FEAT_SMARTINDENT
8802     did_si = FALSE;
8803     can_si = FALSE;
8804     can_si_back = FALSE;
8805 #endif
8806 #ifdef FEAT_CINDENT
8807     can_cindent = FALSE;	/* no cindenting after ^D or ^T */
8808 #endif
8809 }
8810 
8811     static void
8812 ins_del(void)
8813 {
8814     int	    temp;
8815 
8816     if (stop_arrow() == FAIL)
8817 	return;
8818     if (gchar_cursor() == NUL)		/* delete newline */
8819     {
8820 	temp = curwin->w_cursor.col;
8821 	if (!can_bs(BS_EOL)		/* only if "eol" included */
8822 		|| do_join(2, FALSE, TRUE, FALSE, FALSE) == FAIL)
8823 	    vim_beep(BO_BS);
8824 	else
8825 	    curwin->w_cursor.col = temp;
8826     }
8827     else if (del_char(FALSE) == FAIL)  /* delete char under cursor */
8828 	vim_beep(BO_BS);
8829     did_ai = FALSE;
8830 #ifdef FEAT_SMARTINDENT
8831     did_si = FALSE;
8832     can_si = FALSE;
8833     can_si_back = FALSE;
8834 #endif
8835     AppendCharToRedobuff(K_DEL);
8836 }
8837 
8838 static void ins_bs_one(colnr_T *vcolp);
8839 
8840 /*
8841  * Delete one character for ins_bs().
8842  */
8843     static void
8844 ins_bs_one(colnr_T *vcolp)
8845 {
8846     dec_cursor();
8847     getvcol(curwin, &curwin->w_cursor, vcolp, NULL, NULL);
8848     if (State & REPLACE_FLAG)
8849     {
8850 	/* Don't delete characters before the insert point when in
8851 	 * Replace mode */
8852 	if (curwin->w_cursor.lnum != Insstart.lnum
8853 		|| curwin->w_cursor.col >= Insstart.col)
8854 	    replace_do_bs(-1);
8855     }
8856     else
8857 	(void)del_char(FALSE);
8858 }
8859 
8860 /*
8861  * Handle Backspace, delete-word and delete-line in Insert mode.
8862  * Return TRUE when backspace was actually used.
8863  */
8864     static int
8865 ins_bs(
8866     int		c,
8867     int		mode,
8868     int		*inserted_space_p)
8869 {
8870     linenr_T	lnum;
8871     int		cc;
8872     int		temp = 0;	    /* init for GCC */
8873     colnr_T	save_col;
8874     colnr_T	mincol;
8875     int		did_backspace = FALSE;
8876     int		in_indent;
8877     int		oldState;
8878 #ifdef FEAT_MBYTE
8879     int		cpc[MAX_MCO];	    /* composing characters */
8880 #endif
8881 
8882     /*
8883      * can't delete anything in an empty file
8884      * can't backup past first character in buffer
8885      * can't backup past starting point unless 'backspace' > 1
8886      * can backup to a previous line if 'backspace' == 0
8887      */
8888     if (       bufempty()
8889 	    || (
8890 #ifdef FEAT_RIGHTLEFT
8891 		!revins_on &&
8892 #endif
8893 		((curwin->w_cursor.lnum == 1 && curwin->w_cursor.col == 0)
8894 		    || (!can_bs(BS_START)
8895 			&& (arrow_used
8896 			    || (curwin->w_cursor.lnum == Insstart_orig.lnum
8897 				&& curwin->w_cursor.col <= Insstart_orig.col)))
8898 		    || (!can_bs(BS_INDENT) && !arrow_used && ai_col > 0
8899 					 && curwin->w_cursor.col <= ai_col)
8900 		    || (!can_bs(BS_EOL) && curwin->w_cursor.col == 0))))
8901     {
8902 	vim_beep(BO_BS);
8903 	return FALSE;
8904     }
8905 
8906     if (stop_arrow() == FAIL)
8907 	return FALSE;
8908     in_indent = inindent(0);
8909 #ifdef FEAT_CINDENT
8910     if (in_indent)
8911 	can_cindent = FALSE;
8912 #endif
8913 #ifdef FEAT_COMMENTS
8914     end_comment_pending = NUL;	/* After BS, don't auto-end comment */
8915 #endif
8916 #ifdef FEAT_RIGHTLEFT
8917     if (revins_on)	    /* put cursor after last inserted char */
8918 	inc_cursor();
8919 #endif
8920 
8921 #ifdef FEAT_VIRTUALEDIT
8922     /* Virtualedit:
8923      *	BACKSPACE_CHAR eats a virtual space
8924      *	BACKSPACE_WORD eats all coladd
8925      *	BACKSPACE_LINE eats all coladd and keeps going
8926      */
8927     if (curwin->w_cursor.coladd > 0)
8928     {
8929 	if (mode == BACKSPACE_CHAR)
8930 	{
8931 	    --curwin->w_cursor.coladd;
8932 	    return TRUE;
8933 	}
8934 	if (mode == BACKSPACE_WORD)
8935 	{
8936 	    curwin->w_cursor.coladd = 0;
8937 	    return TRUE;
8938 	}
8939 	curwin->w_cursor.coladd = 0;
8940     }
8941 #endif
8942 
8943     /*
8944      * delete newline!
8945      */
8946     if (curwin->w_cursor.col == 0)
8947     {
8948 	lnum = Insstart.lnum;
8949 	if (curwin->w_cursor.lnum == lnum
8950 #ifdef FEAT_RIGHTLEFT
8951 			|| revins_on
8952 #endif
8953 				    )
8954 	{
8955 	    if (u_save((linenr_T)(curwin->w_cursor.lnum - 2),
8956 			       (linenr_T)(curwin->w_cursor.lnum + 1)) == FAIL)
8957 		return FALSE;
8958 	    --Insstart.lnum;
8959 	    Insstart.col = MAXCOL;
8960 	}
8961 	/*
8962 	 * In replace mode:
8963 	 * cc < 0: NL was inserted, delete it
8964 	 * cc >= 0: NL was replaced, put original characters back
8965 	 */
8966 	cc = -1;
8967 	if (State & REPLACE_FLAG)
8968 	    cc = replace_pop();	    /* returns -1 if NL was inserted */
8969 	/*
8970 	 * In replace mode, in the line we started replacing, we only move the
8971 	 * cursor.
8972 	 */
8973 	if ((State & REPLACE_FLAG) && curwin->w_cursor.lnum <= lnum)
8974 	{
8975 	    dec_cursor();
8976 	}
8977 	else
8978 	{
8979 #ifdef FEAT_VREPLACE
8980 	    if (!(State & VREPLACE_FLAG)
8981 				   || curwin->w_cursor.lnum > orig_line_count)
8982 #endif
8983 	    {
8984 		temp = gchar_cursor();	/* remember current char */
8985 		--curwin->w_cursor.lnum;
8986 
8987 		/* When "aw" is in 'formatoptions' we must delete the space at
8988 		 * the end of the line, otherwise the line will be broken
8989 		 * again when auto-formatting. */
8990 		if (has_format_option(FO_AUTO)
8991 					   && has_format_option(FO_WHITE_PAR))
8992 		{
8993 		    char_u  *ptr = ml_get_buf(curbuf, curwin->w_cursor.lnum,
8994 									TRUE);
8995 		    int	    len;
8996 
8997 		    len = (int)STRLEN(ptr);
8998 		    if (len > 0 && ptr[len - 1] == ' ')
8999 			ptr[len - 1] = NUL;
9000 		}
9001 
9002 		(void)do_join(2, FALSE, FALSE, FALSE, FALSE);
9003 		if (temp == NUL && gchar_cursor() != NUL)
9004 		    inc_cursor();
9005 	    }
9006 #ifdef FEAT_VREPLACE
9007 	    else
9008 		dec_cursor();
9009 #endif
9010 
9011 	    /*
9012 	     * In REPLACE mode we have to put back the text that was replaced
9013 	     * by the NL. On the replace stack is first a NUL-terminated
9014 	     * sequence of characters that were deleted and then the
9015 	     * characters that NL replaced.
9016 	     */
9017 	    if (State & REPLACE_FLAG)
9018 	    {
9019 		/*
9020 		 * Do the next ins_char() in NORMAL state, to
9021 		 * prevent ins_char() from replacing characters and
9022 		 * avoiding showmatch().
9023 		 */
9024 		oldState = State;
9025 		State = NORMAL;
9026 		/*
9027 		 * restore characters (blanks) deleted after cursor
9028 		 */
9029 		while (cc > 0)
9030 		{
9031 		    save_col = curwin->w_cursor.col;
9032 #ifdef FEAT_MBYTE
9033 		    mb_replace_pop_ins(cc);
9034 #else
9035 		    ins_char(cc);
9036 #endif
9037 		    curwin->w_cursor.col = save_col;
9038 		    cc = replace_pop();
9039 		}
9040 		/* restore the characters that NL replaced */
9041 		replace_pop_ins();
9042 		State = oldState;
9043 	    }
9044 	}
9045 	did_ai = FALSE;
9046     }
9047     else
9048     {
9049 	/*
9050 	 * Delete character(s) before the cursor.
9051 	 */
9052 #ifdef FEAT_RIGHTLEFT
9053 	if (revins_on)		/* put cursor on last inserted char */
9054 	    dec_cursor();
9055 #endif
9056 	mincol = 0;
9057 						/* keep indent */
9058 	if (mode == BACKSPACE_LINE
9059 		&& (curbuf->b_p_ai
9060 #ifdef FEAT_CINDENT
9061 		    || cindent_on()
9062 #endif
9063 		   )
9064 #ifdef FEAT_RIGHTLEFT
9065 		&& !revins_on
9066 #endif
9067 			    )
9068 	{
9069 	    save_col = curwin->w_cursor.col;
9070 	    beginline(BL_WHITE);
9071 	    if (curwin->w_cursor.col < save_col)
9072 		mincol = curwin->w_cursor.col;
9073 	    curwin->w_cursor.col = save_col;
9074 	}
9075 
9076 	/*
9077 	 * Handle deleting one 'shiftwidth' or 'softtabstop'.
9078 	 */
9079 	if (	   mode == BACKSPACE_CHAR
9080 		&& ((p_sta && in_indent)
9081 		    || (get_sts_value() != 0
9082 			&& curwin->w_cursor.col > 0
9083 			&& (*(ml_get_cursor() - 1) == TAB
9084 			    || (*(ml_get_cursor() - 1) == ' '
9085 				&& (!*inserted_space_p
9086 				    || arrow_used))))))
9087 	{
9088 	    int		ts;
9089 	    colnr_T	vcol;
9090 	    colnr_T	want_vcol;
9091 	    colnr_T	start_vcol;
9092 
9093 	    *inserted_space_p = FALSE;
9094 	    if (p_sta && in_indent)
9095 		ts = (int)get_sw_value(curbuf);
9096 	    else
9097 		ts = (int)get_sts_value();
9098 	    /* Compute the virtual column where we want to be.  Since
9099 	     * 'showbreak' may get in the way, need to get the last column of
9100 	     * the previous character. */
9101 	    getvcol(curwin, &curwin->w_cursor, &vcol, NULL, NULL);
9102 	    start_vcol = vcol;
9103 	    dec_cursor();
9104 	    getvcol(curwin, &curwin->w_cursor, NULL, NULL, &want_vcol);
9105 	    inc_cursor();
9106 	    want_vcol = (want_vcol / ts) * ts;
9107 
9108 	    /* delete characters until we are at or before want_vcol */
9109 	    while (vcol > want_vcol
9110 		    && (cc = *(ml_get_cursor() - 1), vim_iswhite(cc)))
9111 		ins_bs_one(&vcol);
9112 
9113 	    /* insert extra spaces until we are at want_vcol */
9114 	    while (vcol < want_vcol)
9115 	    {
9116 		/* Remember the first char we inserted */
9117 		if (curwin->w_cursor.lnum == Insstart_orig.lnum
9118 				   && curwin->w_cursor.col < Insstart_orig.col)
9119 		    Insstart_orig.col = curwin->w_cursor.col;
9120 
9121 #ifdef FEAT_VREPLACE
9122 		if (State & VREPLACE_FLAG)
9123 		    ins_char(' ');
9124 		else
9125 #endif
9126 		{
9127 		    ins_str((char_u *)" ");
9128 		    if ((State & REPLACE_FLAG))
9129 			replace_push(NUL);
9130 		}
9131 		getvcol(curwin, &curwin->w_cursor, &vcol, NULL, NULL);
9132 	    }
9133 
9134 	    /* If we are now back where we started delete one character.  Can
9135 	     * happen when using 'sts' and 'linebreak'. */
9136 	    if (vcol >= start_vcol)
9137 		ins_bs_one(&vcol);
9138 	}
9139 
9140 	/*
9141 	 * Delete upto starting point, start of line or previous word.
9142 	 */
9143 	else
9144 	{
9145 #ifdef FEAT_MBYTE
9146 	    int cclass = 0, prev_cclass = 0;
9147 
9148 	    if (has_mbyte)
9149 		cclass = mb_get_class(ml_get_cursor());
9150 #endif
9151 	    do
9152 	    {
9153 #ifdef FEAT_RIGHTLEFT
9154 		if (!revins_on) /* put cursor on char to be deleted */
9155 #endif
9156 		    dec_cursor();
9157 
9158 		cc = gchar_cursor();
9159 #ifdef FEAT_MBYTE
9160 		/* look multi-byte character class */
9161 		if (has_mbyte)
9162 		{
9163 		    prev_cclass = cclass;
9164 		    cclass = mb_get_class(ml_get_cursor());
9165 		}
9166 #endif
9167 
9168 		/* start of word? */
9169 		if (mode == BACKSPACE_WORD && !vim_isspace(cc))
9170 		{
9171 		    mode = BACKSPACE_WORD_NOT_SPACE;
9172 		    temp = vim_iswordc(cc);
9173 		}
9174 		/* end of word? */
9175 		else if (mode == BACKSPACE_WORD_NOT_SPACE
9176 			&& ((vim_isspace(cc) || vim_iswordc(cc) != temp)
9177 #ifdef FEAT_MBYTE
9178 			|| prev_cclass != cclass
9179 #endif
9180 			))
9181 		{
9182 #ifdef FEAT_RIGHTLEFT
9183 		    if (!revins_on)
9184 #endif
9185 			inc_cursor();
9186 #ifdef FEAT_RIGHTLEFT
9187 		    else if (State & REPLACE_FLAG)
9188 			dec_cursor();
9189 #endif
9190 		    break;
9191 		}
9192 		if (State & REPLACE_FLAG)
9193 		    replace_do_bs(-1);
9194 		else
9195 		{
9196 #ifdef FEAT_MBYTE
9197 		    if (enc_utf8 && p_deco)
9198 			(void)utfc_ptr2char(ml_get_cursor(), cpc);
9199 #endif
9200 		    (void)del_char(FALSE);
9201 #ifdef FEAT_MBYTE
9202 		    /*
9203 		     * If there are combining characters and 'delcombine' is set
9204 		     * move the cursor back.  Don't back up before the base
9205 		     * character.
9206 		     */
9207 		    if (enc_utf8 && p_deco && cpc[0] != NUL)
9208 			inc_cursor();
9209 #endif
9210 #ifdef FEAT_RIGHTLEFT
9211 		    if (revins_chars)
9212 		    {
9213 			revins_chars--;
9214 			revins_legal++;
9215 		    }
9216 		    if (revins_on && gchar_cursor() == NUL)
9217 			break;
9218 #endif
9219 		}
9220 		/* Just a single backspace?: */
9221 		if (mode == BACKSPACE_CHAR)
9222 		    break;
9223 	    } while (
9224 #ifdef FEAT_RIGHTLEFT
9225 		    revins_on ||
9226 #endif
9227 		    (curwin->w_cursor.col > mincol
9228 		    && (curwin->w_cursor.lnum != Insstart_orig.lnum
9229 			|| curwin->w_cursor.col != Insstart_orig.col)));
9230 	}
9231 	did_backspace = TRUE;
9232     }
9233 #ifdef FEAT_SMARTINDENT
9234     did_si = FALSE;
9235     can_si = FALSE;
9236     can_si_back = FALSE;
9237 #endif
9238     if (curwin->w_cursor.col <= 1)
9239 	did_ai = FALSE;
9240     /*
9241      * It's a little strange to put backspaces into the redo
9242      * buffer, but it makes auto-indent a lot easier to deal
9243      * with.
9244      */
9245     AppendCharToRedobuff(c);
9246 
9247     /* If deleted before the insertion point, adjust it */
9248     if (curwin->w_cursor.lnum == Insstart_orig.lnum
9249 				       && curwin->w_cursor.col < Insstart_orig.col)
9250 	Insstart_orig.col = curwin->w_cursor.col;
9251 
9252     /* vi behaviour: the cursor moves backward but the character that
9253      *		     was there remains visible
9254      * Vim behaviour: the cursor moves backward and the character that
9255      *		      was there is erased from the screen.
9256      * We can emulate the vi behaviour by pretending there is a dollar
9257      * displayed even when there isn't.
9258      *  --pkv Sun Jan 19 01:56:40 EST 2003 */
9259     if (vim_strchr(p_cpo, CPO_BACKSPACE) != NULL && dollar_vcol == -1)
9260 	dollar_vcol = curwin->w_virtcol;
9261 
9262 #ifdef FEAT_FOLDING
9263     /* When deleting a char the cursor line must never be in a closed fold.
9264      * E.g., when 'foldmethod' is indent and deleting the first non-white
9265      * char before a Tab. */
9266     if (did_backspace)
9267 	foldOpenCursor();
9268 #endif
9269 
9270     return did_backspace;
9271 }
9272 
9273 #ifdef FEAT_MOUSE
9274     static void
9275 ins_mouse(int c)
9276 {
9277     pos_T	tpos;
9278     win_T	*old_curwin = curwin;
9279 
9280 # ifdef FEAT_GUI
9281     /* When GUI is active, also move/paste when 'mouse' is empty */
9282     if (!gui.in_use)
9283 # endif
9284 	if (!mouse_has(MOUSE_INSERT))
9285 	    return;
9286 
9287     undisplay_dollar();
9288     tpos = curwin->w_cursor;
9289     if (do_mouse(NULL, c, BACKWARD, 1L, 0))
9290     {
9291 #ifdef FEAT_WINDOWS
9292 	win_T	*new_curwin = curwin;
9293 
9294 	if (curwin != old_curwin && win_valid(old_curwin))
9295 	{
9296 	    /* Mouse took us to another window.  We need to go back to the
9297 	     * previous one to stop insert there properly. */
9298 	    curwin = old_curwin;
9299 	    curbuf = curwin->w_buffer;
9300 	}
9301 #endif
9302 	start_arrow(curwin == old_curwin ? &tpos : NULL);
9303 #ifdef FEAT_WINDOWS
9304 	if (curwin != new_curwin && win_valid(new_curwin))
9305 	{
9306 	    curwin = new_curwin;
9307 	    curbuf = curwin->w_buffer;
9308 	}
9309 #endif
9310 # ifdef FEAT_CINDENT
9311 	can_cindent = TRUE;
9312 # endif
9313     }
9314 
9315 #ifdef FEAT_WINDOWS
9316     /* redraw status lines (in case another window became active) */
9317     redraw_statuslines();
9318 #endif
9319 }
9320 
9321     static void
9322 ins_mousescroll(int dir)
9323 {
9324     pos_T	tpos;
9325 # if defined(FEAT_WINDOWS)
9326     win_T	*old_curwin = curwin;
9327 # endif
9328 # ifdef FEAT_INS_EXPAND
9329     int		did_scroll = FALSE;
9330 # endif
9331 
9332     tpos = curwin->w_cursor;
9333 
9334 # ifdef FEAT_WINDOWS
9335     if (mouse_row >= 0 && mouse_col >= 0)
9336     {
9337 	int row, col;
9338 
9339 	row = mouse_row;
9340 	col = mouse_col;
9341 
9342 	/* find the window at the pointer coordinates */
9343 	curwin = mouse_find_win(&row, &col);
9344 	curbuf = curwin->w_buffer;
9345     }
9346     if (curwin == old_curwin)
9347 # endif
9348 	undisplay_dollar();
9349 
9350 # ifdef FEAT_INS_EXPAND
9351     /* Don't scroll the window in which completion is being done. */
9352     if (!pum_visible()
9353 #  if defined(FEAT_WINDOWS)
9354 	    || curwin != old_curwin
9355 #  endif
9356 	    )
9357 # endif
9358     {
9359 	if (dir == MSCR_DOWN || dir == MSCR_UP)
9360 	{
9361 	    if (mod_mask & (MOD_MASK_SHIFT | MOD_MASK_CTRL))
9362 		scroll_redraw(dir,
9363 			(long)(curwin->w_botline - curwin->w_topline));
9364 	    else
9365 		scroll_redraw(dir, 3L);
9366 	}
9367 #ifdef FEAT_GUI
9368 	else
9369 	{
9370 	    int val, step = 6;
9371 
9372 	    if (mod_mask & (MOD_MASK_SHIFT | MOD_MASK_CTRL))
9373 		step = W_WIDTH(curwin);
9374 	    val = curwin->w_leftcol + (dir == MSCR_RIGHT ? -step : step);
9375 	    if (val < 0)
9376 		val = 0;
9377 	    gui_do_horiz_scroll(val, TRUE);
9378 	}
9379 #endif
9380 # ifdef FEAT_INS_EXPAND
9381 	did_scroll = TRUE;
9382 # endif
9383     }
9384 
9385 # ifdef FEAT_WINDOWS
9386     curwin->w_redr_status = TRUE;
9387 
9388     curwin = old_curwin;
9389     curbuf = curwin->w_buffer;
9390 # endif
9391 
9392 # ifdef FEAT_INS_EXPAND
9393     /* The popup menu may overlay the window, need to redraw it.
9394      * TODO: Would be more efficient to only redraw the windows that are
9395      * overlapped by the popup menu. */
9396     if (pum_visible() && did_scroll)
9397     {
9398 	redraw_all_later(NOT_VALID);
9399 	ins_compl_show_pum();
9400     }
9401 # endif
9402 
9403     if (!equalpos(curwin->w_cursor, tpos))
9404     {
9405 	start_arrow(&tpos);
9406 # ifdef FEAT_CINDENT
9407 	can_cindent = TRUE;
9408 # endif
9409     }
9410 }
9411 #endif
9412 
9413 #if defined(FEAT_GUI_TABLINE) || defined(PROTO)
9414     static void
9415 ins_tabline(int c)
9416 {
9417     /* We will be leaving the current window, unless closing another tab. */
9418     if (c != K_TABMENU || current_tabmenu != TABLINE_MENU_CLOSE
9419 		|| (current_tab != 0 && current_tab != tabpage_index(curtab)))
9420     {
9421 	undisplay_dollar();
9422 	start_arrow(&curwin->w_cursor);
9423 # ifdef FEAT_CINDENT
9424 	can_cindent = TRUE;
9425 # endif
9426     }
9427 
9428     if (c == K_TABLINE)
9429 	goto_tabpage(current_tab);
9430     else
9431     {
9432 	handle_tabmenu();
9433 	redraw_statuslines();	/* will redraw the tabline when needed */
9434     }
9435 }
9436 #endif
9437 
9438 #if defined(FEAT_GUI) || defined(PROTO)
9439     void
9440 ins_scroll(void)
9441 {
9442     pos_T	tpos;
9443 
9444     undisplay_dollar();
9445     tpos = curwin->w_cursor;
9446     if (gui_do_scroll())
9447     {
9448 	start_arrow(&tpos);
9449 # ifdef FEAT_CINDENT
9450 	can_cindent = TRUE;
9451 # endif
9452     }
9453 }
9454 
9455     void
9456 ins_horscroll(void)
9457 {
9458     pos_T	tpos;
9459 
9460     undisplay_dollar();
9461     tpos = curwin->w_cursor;
9462     if (gui_do_horiz_scroll(scrollbar_value, FALSE))
9463     {
9464 	start_arrow(&tpos);
9465 # ifdef FEAT_CINDENT
9466 	can_cindent = TRUE;
9467 # endif
9468     }
9469 }
9470 #endif
9471 
9472     static void
9473 ins_left(
9474     int	    end_change) /* end undoable change */
9475 {
9476     pos_T	tpos;
9477 
9478 #ifdef FEAT_FOLDING
9479     if ((fdo_flags & FDO_HOR) && KeyTyped)
9480 	foldOpenCursor();
9481 #endif
9482     undisplay_dollar();
9483     tpos = curwin->w_cursor;
9484     if (oneleft() == OK)
9485     {
9486 #if defined(FEAT_XIM) && defined(FEAT_GUI_GTK)
9487 	/* Only call start_arrow() when not busy with preediting, it will
9488 	 * break undo.  K_LEFT is inserted in im_correct_cursor(). */
9489 	if (!im_is_preediting())
9490 #endif
9491 	{
9492 	    start_arrow_with_change(&tpos, end_change);
9493 	    if (!end_change)
9494 		AppendCharToRedobuff(K_LEFT);
9495 	}
9496 #ifdef FEAT_RIGHTLEFT
9497 	/* If exit reversed string, position is fixed */
9498 	if (revins_scol != -1 && (int)curwin->w_cursor.col >= revins_scol)
9499 	    revins_legal++;
9500 	revins_chars++;
9501 #endif
9502     }
9503 
9504     /*
9505      * if 'whichwrap' set for cursor in insert mode may go to
9506      * previous line
9507      */
9508     else if (vim_strchr(p_ww, '[') != NULL && curwin->w_cursor.lnum > 1)
9509     {
9510 	/* always break undo when moving upwards/downwards, else undo may break */
9511 	start_arrow(&tpos);
9512 	--(curwin->w_cursor.lnum);
9513 	coladvance((colnr_T)MAXCOL);
9514 	curwin->w_set_curswant = TRUE;	/* so we stay at the end */
9515     }
9516     else
9517 	vim_beep(BO_CRSR);
9518     dont_sync_undo = FALSE;
9519 }
9520 
9521     static void
9522 ins_home(int c)
9523 {
9524     pos_T	tpos;
9525 
9526 #ifdef FEAT_FOLDING
9527     if ((fdo_flags & FDO_HOR) && KeyTyped)
9528 	foldOpenCursor();
9529 #endif
9530     undisplay_dollar();
9531     tpos = curwin->w_cursor;
9532     if (c == K_C_HOME)
9533 	curwin->w_cursor.lnum = 1;
9534     curwin->w_cursor.col = 0;
9535 #ifdef FEAT_VIRTUALEDIT
9536     curwin->w_cursor.coladd = 0;
9537 #endif
9538     curwin->w_curswant = 0;
9539     start_arrow(&tpos);
9540 }
9541 
9542     static void
9543 ins_end(int c)
9544 {
9545     pos_T	tpos;
9546 
9547 #ifdef FEAT_FOLDING
9548     if ((fdo_flags & FDO_HOR) && KeyTyped)
9549 	foldOpenCursor();
9550 #endif
9551     undisplay_dollar();
9552     tpos = curwin->w_cursor;
9553     if (c == K_C_END)
9554 	curwin->w_cursor.lnum = curbuf->b_ml.ml_line_count;
9555     coladvance((colnr_T)MAXCOL);
9556     curwin->w_curswant = MAXCOL;
9557 
9558     start_arrow(&tpos);
9559 }
9560 
9561     static void
9562 ins_s_left(void)
9563 {
9564 #ifdef FEAT_FOLDING
9565     if ((fdo_flags & FDO_HOR) && KeyTyped)
9566 	foldOpenCursor();
9567 #endif
9568     undisplay_dollar();
9569     if (curwin->w_cursor.lnum > 1 || curwin->w_cursor.col > 0)
9570     {
9571 	start_arrow(&curwin->w_cursor);
9572 	(void)bck_word(1L, FALSE, FALSE);
9573 	curwin->w_set_curswant = TRUE;
9574     }
9575     else
9576 	vim_beep(BO_CRSR);
9577 }
9578 
9579     static void
9580 ins_right(
9581     int	    end_change) /* end undoable change */
9582 {
9583 #ifdef FEAT_FOLDING
9584     if ((fdo_flags & FDO_HOR) && KeyTyped)
9585 	foldOpenCursor();
9586 #endif
9587     undisplay_dollar();
9588     if (gchar_cursor() != NUL
9589 #ifdef FEAT_VIRTUALEDIT
9590 	    || virtual_active()
9591 #endif
9592 	    )
9593     {
9594 	start_arrow_with_change(&curwin->w_cursor, end_change);
9595 	if (!end_change)
9596 	    AppendCharToRedobuff(K_RIGHT);
9597 	curwin->w_set_curswant = TRUE;
9598 #ifdef FEAT_VIRTUALEDIT
9599 	if (virtual_active())
9600 	    oneright();
9601 	else
9602 #endif
9603 	{
9604 #ifdef FEAT_MBYTE
9605 	    if (has_mbyte)
9606 		curwin->w_cursor.col += (*mb_ptr2len)(ml_get_cursor());
9607 	    else
9608 #endif
9609 		++curwin->w_cursor.col;
9610 	}
9611 
9612 #ifdef FEAT_RIGHTLEFT
9613 	revins_legal++;
9614 	if (revins_chars)
9615 	    revins_chars--;
9616 #endif
9617     }
9618     /* if 'whichwrap' set for cursor in insert mode, may move the
9619      * cursor to the next line */
9620     else if (vim_strchr(p_ww, ']') != NULL
9621 	    && curwin->w_cursor.lnum < curbuf->b_ml.ml_line_count)
9622     {
9623 	start_arrow(&curwin->w_cursor);
9624 	curwin->w_set_curswant = TRUE;
9625 	++curwin->w_cursor.lnum;
9626 	curwin->w_cursor.col = 0;
9627     }
9628     else
9629 	vim_beep(BO_CRSR);
9630     dont_sync_undo = FALSE;
9631 }
9632 
9633     static void
9634 ins_s_right(void)
9635 {
9636 #ifdef FEAT_FOLDING
9637     if ((fdo_flags & FDO_HOR) && KeyTyped)
9638 	foldOpenCursor();
9639 #endif
9640     undisplay_dollar();
9641     if (curwin->w_cursor.lnum < curbuf->b_ml.ml_line_count
9642 	    || gchar_cursor() != NUL)
9643     {
9644 	start_arrow(&curwin->w_cursor);
9645 	(void)fwd_word(1L, FALSE, 0);
9646 	curwin->w_set_curswant = TRUE;
9647     }
9648     else
9649 	vim_beep(BO_CRSR);
9650 }
9651 
9652     static void
9653 ins_up(
9654     int		startcol)	/* when TRUE move to Insstart.col */
9655 {
9656     pos_T	tpos;
9657     linenr_T	old_topline = curwin->w_topline;
9658 #ifdef FEAT_DIFF
9659     int		old_topfill = curwin->w_topfill;
9660 #endif
9661 
9662     undisplay_dollar();
9663     tpos = curwin->w_cursor;
9664     if (cursor_up(1L, TRUE) == OK)
9665     {
9666 	if (startcol)
9667 	    coladvance(getvcol_nolist(&Insstart));
9668 	if (old_topline != curwin->w_topline
9669 #ifdef FEAT_DIFF
9670 		|| old_topfill != curwin->w_topfill
9671 #endif
9672 		)
9673 	    redraw_later(VALID);
9674 	start_arrow(&tpos);
9675 #ifdef FEAT_CINDENT
9676 	can_cindent = TRUE;
9677 #endif
9678     }
9679     else
9680 	vim_beep(BO_CRSR);
9681 }
9682 
9683     static void
9684 ins_pageup(void)
9685 {
9686     pos_T	tpos;
9687 
9688     undisplay_dollar();
9689 
9690 #ifdef FEAT_WINDOWS
9691     if (mod_mask & MOD_MASK_CTRL)
9692     {
9693 	/* <C-PageUp>: tab page back */
9694 	if (first_tabpage->tp_next != NULL)
9695 	{
9696 	    start_arrow(&curwin->w_cursor);
9697 	    goto_tabpage(-1);
9698 	}
9699 	return;
9700     }
9701 #endif
9702 
9703     tpos = curwin->w_cursor;
9704     if (onepage(BACKWARD, 1L) == OK)
9705     {
9706 	start_arrow(&tpos);
9707 #ifdef FEAT_CINDENT
9708 	can_cindent = TRUE;
9709 #endif
9710     }
9711     else
9712 	vim_beep(BO_CRSR);
9713 }
9714 
9715     static void
9716 ins_down(
9717     int		startcol)	/* when TRUE move to Insstart.col */
9718 {
9719     pos_T	tpos;
9720     linenr_T	old_topline = curwin->w_topline;
9721 #ifdef FEAT_DIFF
9722     int		old_topfill = curwin->w_topfill;
9723 #endif
9724 
9725     undisplay_dollar();
9726     tpos = curwin->w_cursor;
9727     if (cursor_down(1L, TRUE) == OK)
9728     {
9729 	if (startcol)
9730 	    coladvance(getvcol_nolist(&Insstart));
9731 	if (old_topline != curwin->w_topline
9732 #ifdef FEAT_DIFF
9733 		|| old_topfill != curwin->w_topfill
9734 #endif
9735 		)
9736 	    redraw_later(VALID);
9737 	start_arrow(&tpos);
9738 #ifdef FEAT_CINDENT
9739 	can_cindent = TRUE;
9740 #endif
9741     }
9742     else
9743 	vim_beep(BO_CRSR);
9744 }
9745 
9746     static void
9747 ins_pagedown(void)
9748 {
9749     pos_T	tpos;
9750 
9751     undisplay_dollar();
9752 
9753 #ifdef FEAT_WINDOWS
9754     if (mod_mask & MOD_MASK_CTRL)
9755     {
9756 	/* <C-PageDown>: tab page forward */
9757 	if (first_tabpage->tp_next != NULL)
9758 	{
9759 	    start_arrow(&curwin->w_cursor);
9760 	    goto_tabpage(0);
9761 	}
9762 	return;
9763     }
9764 #endif
9765 
9766     tpos = curwin->w_cursor;
9767     if (onepage(FORWARD, 1L) == OK)
9768     {
9769 	start_arrow(&tpos);
9770 #ifdef FEAT_CINDENT
9771 	can_cindent = TRUE;
9772 #endif
9773     }
9774     else
9775 	vim_beep(BO_CRSR);
9776 }
9777 
9778 #ifdef FEAT_DND
9779     static void
9780 ins_drop(void)
9781 {
9782     do_put('~', BACKWARD, 1L, PUT_CURSEND);
9783 }
9784 #endif
9785 
9786 /*
9787  * Handle TAB in Insert or Replace mode.
9788  * Return TRUE when the TAB needs to be inserted like a normal character.
9789  */
9790     static int
9791 ins_tab(void)
9792 {
9793     int		ind;
9794     int		i;
9795     int		temp;
9796 
9797     if (Insstart_blank_vcol == MAXCOL && curwin->w_cursor.lnum == Insstart.lnum)
9798 	Insstart_blank_vcol = get_nolist_virtcol();
9799     if (echeck_abbr(TAB + ABBR_OFF))
9800 	return FALSE;
9801 
9802     ind = inindent(0);
9803 #ifdef FEAT_CINDENT
9804     if (ind)
9805 	can_cindent = FALSE;
9806 #endif
9807 
9808     /*
9809      * When nothing special, insert TAB like a normal character
9810      */
9811     if (!curbuf->b_p_et
9812 	    && !(p_sta && ind && curbuf->b_p_ts != get_sw_value(curbuf))
9813 	    && get_sts_value() == 0)
9814 	return TRUE;
9815 
9816     if (stop_arrow() == FAIL)
9817 	return TRUE;
9818 
9819     did_ai = FALSE;
9820 #ifdef FEAT_SMARTINDENT
9821     did_si = FALSE;
9822     can_si = FALSE;
9823     can_si_back = FALSE;
9824 #endif
9825     AppendToRedobuff((char_u *)"\t");
9826 
9827     if (p_sta && ind)		/* insert tab in indent, use 'shiftwidth' */
9828 	temp = (int)get_sw_value(curbuf);
9829     else if (curbuf->b_p_sts != 0) /* use 'softtabstop' when set */
9830 	temp = (int)get_sts_value();
9831     else			/* otherwise use 'tabstop' */
9832 	temp = (int)curbuf->b_p_ts;
9833     temp -= get_nolist_virtcol() % temp;
9834 
9835     /*
9836      * Insert the first space with ins_char().	It will delete one char in
9837      * replace mode.  Insert the rest with ins_str(); it will not delete any
9838      * chars.  For VREPLACE mode, we use ins_char() for all characters.
9839      */
9840     ins_char(' ');
9841     while (--temp > 0)
9842     {
9843 #ifdef FEAT_VREPLACE
9844 	if (State & VREPLACE_FLAG)
9845 	    ins_char(' ');
9846 	else
9847 #endif
9848 	{
9849 	    ins_str((char_u *)" ");
9850 	    if (State & REPLACE_FLAG)	    /* no char replaced */
9851 		replace_push(NUL);
9852 	}
9853     }
9854 
9855     /*
9856      * When 'expandtab' not set: Replace spaces by TABs where possible.
9857      */
9858     if (!curbuf->b_p_et && (get_sts_value() || (p_sta && ind)))
9859     {
9860 	char_u		*ptr;
9861 #ifdef FEAT_VREPLACE
9862 	char_u		*saved_line = NULL;	/* init for GCC */
9863 	pos_T		pos;
9864 #endif
9865 	pos_T		fpos;
9866 	pos_T		*cursor;
9867 	colnr_T		want_vcol, vcol;
9868 	int		change_col = -1;
9869 	int		save_list = curwin->w_p_list;
9870 
9871 	/*
9872 	 * Get the current line.  For VREPLACE mode, don't make real changes
9873 	 * yet, just work on a copy of the line.
9874 	 */
9875 #ifdef FEAT_VREPLACE
9876 	if (State & VREPLACE_FLAG)
9877 	{
9878 	    pos = curwin->w_cursor;
9879 	    cursor = &pos;
9880 	    saved_line = vim_strsave(ml_get_curline());
9881 	    if (saved_line == NULL)
9882 		return FALSE;
9883 	    ptr = saved_line + pos.col;
9884 	}
9885 	else
9886 #endif
9887 	{
9888 	    ptr = ml_get_cursor();
9889 	    cursor = &curwin->w_cursor;
9890 	}
9891 
9892 	/* When 'L' is not in 'cpoptions' a tab always takes up 'ts' spaces. */
9893 	if (vim_strchr(p_cpo, CPO_LISTWM) == NULL)
9894 	    curwin->w_p_list = FALSE;
9895 
9896 	/* Find first white before the cursor */
9897 	fpos = curwin->w_cursor;
9898 	while (fpos.col > 0 && vim_iswhite(ptr[-1]))
9899 	{
9900 	    --fpos.col;
9901 	    --ptr;
9902 	}
9903 
9904 	/* In Replace mode, don't change characters before the insert point. */
9905 	if ((State & REPLACE_FLAG)
9906 		&& fpos.lnum == Insstart.lnum
9907 		&& fpos.col < Insstart.col)
9908 	{
9909 	    ptr += Insstart.col - fpos.col;
9910 	    fpos.col = Insstart.col;
9911 	}
9912 
9913 	/* compute virtual column numbers of first white and cursor */
9914 	getvcol(curwin, &fpos, &vcol, NULL, NULL);
9915 	getvcol(curwin, cursor, &want_vcol, NULL, NULL);
9916 
9917 	/* Use as many TABs as possible.  Beware of 'breakindent', 'showbreak'
9918 	 * and 'linebreak' adding extra virtual columns. */
9919 	while (vim_iswhite(*ptr))
9920 	{
9921 	    i = lbr_chartabsize(NULL, (char_u *)"\t", vcol);
9922 	    if (vcol + i > want_vcol)
9923 		break;
9924 	    if (*ptr != TAB)
9925 	    {
9926 		*ptr = TAB;
9927 		if (change_col < 0)
9928 		{
9929 		    change_col = fpos.col;  /* Column of first change */
9930 		    /* May have to adjust Insstart */
9931 		    if (fpos.lnum == Insstart.lnum && fpos.col < Insstart.col)
9932 			Insstart.col = fpos.col;
9933 		}
9934 	    }
9935 	    ++fpos.col;
9936 	    ++ptr;
9937 	    vcol += i;
9938 	}
9939 
9940 	if (change_col >= 0)
9941 	{
9942 	    int repl_off = 0;
9943 	    char_u *line = ptr;
9944 
9945 	    /* Skip over the spaces we need. */
9946 	    while (vcol < want_vcol && *ptr == ' ')
9947 	    {
9948 		vcol += lbr_chartabsize(line, ptr, vcol);
9949 		++ptr;
9950 		++repl_off;
9951 	    }
9952 	    if (vcol > want_vcol)
9953 	    {
9954 		/* Must have a char with 'showbreak' just before it. */
9955 		--ptr;
9956 		--repl_off;
9957 	    }
9958 	    fpos.col += repl_off;
9959 
9960 	    /* Delete following spaces. */
9961 	    i = cursor->col - fpos.col;
9962 	    if (i > 0)
9963 	    {
9964 		STRMOVE(ptr, ptr + i);
9965 		/* correct replace stack. */
9966 		if ((State & REPLACE_FLAG)
9967 #ifdef FEAT_VREPLACE
9968 			&& !(State & VREPLACE_FLAG)
9969 #endif
9970 			)
9971 		    for (temp = i; --temp >= 0; )
9972 			replace_join(repl_off);
9973 	    }
9974 #ifdef FEAT_NETBEANS_INTG
9975 	    if (netbeans_active())
9976 	    {
9977 		netbeans_removed(curbuf, fpos.lnum, cursor->col, (long)(i + 1));
9978 		netbeans_inserted(curbuf, fpos.lnum, cursor->col,
9979 							   (char_u *)"\t", 1);
9980 	    }
9981 #endif
9982 	    cursor->col -= i;
9983 
9984 #ifdef FEAT_VREPLACE
9985 	    /*
9986 	     * In VREPLACE mode, we haven't changed anything yet.  Do it now by
9987 	     * backspacing over the changed spacing and then inserting the new
9988 	     * spacing.
9989 	     */
9990 	    if (State & VREPLACE_FLAG)
9991 	    {
9992 		/* Backspace from real cursor to change_col */
9993 		backspace_until_column(change_col);
9994 
9995 		/* Insert each char in saved_line from changed_col to
9996 		 * ptr-cursor */
9997 		ins_bytes_len(saved_line + change_col,
9998 						    cursor->col - change_col);
9999 	    }
10000 #endif
10001 	}
10002 
10003 #ifdef FEAT_VREPLACE
10004 	if (State & VREPLACE_FLAG)
10005 	    vim_free(saved_line);
10006 #endif
10007 	curwin->w_p_list = save_list;
10008     }
10009 
10010     return FALSE;
10011 }
10012 
10013 /*
10014  * Handle CR or NL in insert mode.
10015  * Return TRUE when out of memory or can't undo.
10016  */
10017     static int
10018 ins_eol(int c)
10019 {
10020     int	    i;
10021 
10022     if (echeck_abbr(c + ABBR_OFF))
10023 	return FALSE;
10024     if (stop_arrow() == FAIL)
10025 	return TRUE;
10026     undisplay_dollar();
10027 
10028     /*
10029      * Strange Vi behaviour: In Replace mode, typing a NL will not delete the
10030      * character under the cursor.  Only push a NUL on the replace stack,
10031      * nothing to put back when the NL is deleted.
10032      */
10033     if ((State & REPLACE_FLAG)
10034 #ifdef FEAT_VREPLACE
10035 	    && !(State & VREPLACE_FLAG)
10036 #endif
10037 	    )
10038 	replace_push(NUL);
10039 
10040     /*
10041      * In VREPLACE mode, a NL replaces the rest of the line, and starts
10042      * replacing the next line, so we push all of the characters left on the
10043      * line onto the replace stack.  This is not done here though, it is done
10044      * in open_line().
10045      */
10046 
10047 #ifdef FEAT_VIRTUALEDIT
10048     /* Put cursor on NUL if on the last char and coladd is 1 (happens after
10049      * CTRL-O). */
10050     if (virtual_active() && curwin->w_cursor.coladd > 0)
10051 	coladvance(getviscol());
10052 #endif
10053 
10054 #ifdef FEAT_RIGHTLEFT
10055 # ifdef FEAT_FKMAP
10056     if (p_altkeymap && p_fkmap)
10057 	fkmap(NL);
10058 # endif
10059     /* NL in reverse insert will always start in the end of
10060      * current line. */
10061     if (revins_on)
10062 	curwin->w_cursor.col += (colnr_T)STRLEN(ml_get_cursor());
10063 #endif
10064 
10065     AppendToRedobuff(NL_STR);
10066     i = open_line(FORWARD,
10067 #ifdef FEAT_COMMENTS
10068 	    has_format_option(FO_RET_COMS) ? OPENLINE_DO_COM :
10069 #endif
10070 	    0, old_indent);
10071     old_indent = 0;
10072 #ifdef FEAT_CINDENT
10073     can_cindent = TRUE;
10074 #endif
10075 #ifdef FEAT_FOLDING
10076     /* When inserting a line the cursor line must never be in a closed fold. */
10077     foldOpenCursor();
10078 #endif
10079 
10080     return (!i);
10081 }
10082 
10083 #ifdef FEAT_DIGRAPHS
10084 /*
10085  * Handle digraph in insert mode.
10086  * Returns character still to be inserted, or NUL when nothing remaining to be
10087  * done.
10088  */
10089     static int
10090 ins_digraph(void)
10091 {
10092     int	    c;
10093     int	    cc;
10094     int	    did_putchar = FALSE;
10095 
10096     pc_status = PC_STATUS_UNSET;
10097     if (redrawing() && !char_avail())
10098     {
10099 	/* may need to redraw when no more chars available now */
10100 	ins_redraw(FALSE);
10101 
10102 	edit_putchar('?', TRUE);
10103 	did_putchar = TRUE;
10104 #ifdef FEAT_CMDL_INFO
10105 	add_to_showcmd_c(Ctrl_K);
10106 #endif
10107     }
10108 
10109 #ifdef USE_ON_FLY_SCROLL
10110     dont_scroll = TRUE;		/* disallow scrolling here */
10111 #endif
10112 
10113     /* don't map the digraph chars. This also prevents the
10114      * mode message to be deleted when ESC is hit */
10115     ++no_mapping;
10116     ++allow_keys;
10117     c = plain_vgetc();
10118     --no_mapping;
10119     --allow_keys;
10120     if (did_putchar)
10121 	/* when the line fits in 'columns' the '?' is at the start of the next
10122 	 * line and will not be removed by the redraw */
10123 	edit_unputchar();
10124 
10125     if (IS_SPECIAL(c) || mod_mask)	    /* special key */
10126     {
10127 #ifdef FEAT_CMDL_INFO
10128 	clear_showcmd();
10129 #endif
10130 	insert_special(c, TRUE, FALSE);
10131 	return NUL;
10132     }
10133     if (c != ESC)
10134     {
10135 	did_putchar = FALSE;
10136 	if (redrawing() && !char_avail())
10137 	{
10138 	    /* may need to redraw when no more chars available now */
10139 	    ins_redraw(FALSE);
10140 
10141 	    if (char2cells(c) == 1)
10142 	    {
10143 		ins_redraw(FALSE);
10144 		edit_putchar(c, TRUE);
10145 		did_putchar = TRUE;
10146 	    }
10147 #ifdef FEAT_CMDL_INFO
10148 	    add_to_showcmd_c(c);
10149 #endif
10150 	}
10151 	++no_mapping;
10152 	++allow_keys;
10153 	cc = plain_vgetc();
10154 	--no_mapping;
10155 	--allow_keys;
10156 	if (did_putchar)
10157 	    /* when the line fits in 'columns' the '?' is at the start of the
10158 	     * next line and will not be removed by a redraw */
10159 	    edit_unputchar();
10160 	if (cc != ESC)
10161 	{
10162 	    AppendToRedobuff((char_u *)CTRL_V_STR);
10163 	    c = getdigraph(c, cc, TRUE);
10164 #ifdef FEAT_CMDL_INFO
10165 	    clear_showcmd();
10166 #endif
10167 	    return c;
10168 	}
10169     }
10170 #ifdef FEAT_CMDL_INFO
10171     clear_showcmd();
10172 #endif
10173     return NUL;
10174 }
10175 #endif
10176 
10177 /*
10178  * Handle CTRL-E and CTRL-Y in Insert mode: copy char from other line.
10179  * Returns the char to be inserted, or NUL if none found.
10180  */
10181     int
10182 ins_copychar(linenr_T lnum)
10183 {
10184     int	    c;
10185     int	    temp;
10186     char_u  *ptr, *prev_ptr;
10187     char_u  *line;
10188 
10189     if (lnum < 1 || lnum > curbuf->b_ml.ml_line_count)
10190     {
10191 	vim_beep(BO_COPY);
10192 	return NUL;
10193     }
10194 
10195     /* try to advance to the cursor column */
10196     temp = 0;
10197     line = ptr = ml_get(lnum);
10198     prev_ptr = ptr;
10199     validate_virtcol();
10200     while ((colnr_T)temp < curwin->w_virtcol && *ptr != NUL)
10201     {
10202 	prev_ptr = ptr;
10203 	temp += lbr_chartabsize_adv(line, &ptr, (colnr_T)temp);
10204     }
10205     if ((colnr_T)temp > curwin->w_virtcol)
10206 	ptr = prev_ptr;
10207 
10208 #ifdef FEAT_MBYTE
10209     c = (*mb_ptr2char)(ptr);
10210 #else
10211     c = *ptr;
10212 #endif
10213     if (c == NUL)
10214 	vim_beep(BO_COPY);
10215     return c;
10216 }
10217 
10218 /*
10219  * CTRL-Y or CTRL-E typed in Insert mode.
10220  */
10221     static int
10222 ins_ctrl_ey(int tc)
10223 {
10224     int	    c = tc;
10225 
10226 #ifdef FEAT_INS_EXPAND
10227     if (ctrl_x_mode == CTRL_X_SCROLL)
10228     {
10229 	if (c == Ctrl_Y)
10230 	    scrolldown_clamp();
10231 	else
10232 	    scrollup_clamp();
10233 	redraw_later(VALID);
10234     }
10235     else
10236 #endif
10237     {
10238 	c = ins_copychar(curwin->w_cursor.lnum + (c == Ctrl_Y ? -1 : 1));
10239 	if (c != NUL)
10240 	{
10241 	    long	tw_save;
10242 
10243 	    /* The character must be taken literally, insert like it
10244 	     * was typed after a CTRL-V, and pretend 'textwidth'
10245 	     * wasn't set.  Digits, 'o' and 'x' are special after a
10246 	     * CTRL-V, don't use it for these. */
10247 	    if (c < 256 && !isalnum(c))
10248 		AppendToRedobuff((char_u *)CTRL_V_STR);	/* CTRL-V */
10249 	    tw_save = curbuf->b_p_tw;
10250 	    curbuf->b_p_tw = -1;
10251 	    insert_special(c, TRUE, FALSE);
10252 	    curbuf->b_p_tw = tw_save;
10253 #ifdef FEAT_RIGHTLEFT
10254 	    revins_chars++;
10255 	    revins_legal++;
10256 #endif
10257 	    c = Ctrl_V;	/* pretend CTRL-V is last character */
10258 	    auto_format(FALSE, TRUE);
10259 	}
10260     }
10261     return c;
10262 }
10263 
10264 #ifdef FEAT_SMARTINDENT
10265 /*
10266  * Try to do some very smart auto-indenting.
10267  * Used when inserting a "normal" character.
10268  */
10269     static void
10270 ins_try_si(int c)
10271 {
10272     pos_T	*pos, old_pos;
10273     char_u	*ptr;
10274     int		i;
10275     int		temp;
10276 
10277     /*
10278      * do some very smart indenting when entering '{' or '}'
10279      */
10280     if (((did_si || can_si_back) && c == '{') || (can_si && c == '}'))
10281     {
10282 	/*
10283 	 * for '}' set indent equal to indent of line containing matching '{'
10284 	 */
10285 	if (c == '}' && (pos = findmatch(NULL, '{')) != NULL)
10286 	{
10287 	    old_pos = curwin->w_cursor;
10288 	    /*
10289 	     * If the matching '{' has a ')' immediately before it (ignoring
10290 	     * white-space), then line up with the start of the line
10291 	     * containing the matching '(' if there is one.  This handles the
10292 	     * case where an "if (..\n..) {" statement continues over multiple
10293 	     * lines -- webb
10294 	     */
10295 	    ptr = ml_get(pos->lnum);
10296 	    i = pos->col;
10297 	    if (i > 0)		/* skip blanks before '{' */
10298 		while (--i > 0 && vim_iswhite(ptr[i]))
10299 		    ;
10300 	    curwin->w_cursor.lnum = pos->lnum;
10301 	    curwin->w_cursor.col = i;
10302 	    if (ptr[i] == ')' && (pos = findmatch(NULL, '(')) != NULL)
10303 		curwin->w_cursor = *pos;
10304 	    i = get_indent();
10305 	    curwin->w_cursor = old_pos;
10306 #ifdef FEAT_VREPLACE
10307 	    if (State & VREPLACE_FLAG)
10308 		change_indent(INDENT_SET, i, FALSE, NUL, TRUE);
10309 	    else
10310 #endif
10311 		(void)set_indent(i, SIN_CHANGED);
10312 	}
10313 	else if (curwin->w_cursor.col > 0)
10314 	{
10315 	    /*
10316 	     * when inserting '{' after "O" reduce indent, but not
10317 	     * more than indent of previous line
10318 	     */
10319 	    temp = TRUE;
10320 	    if (c == '{' && can_si_back && curwin->w_cursor.lnum > 1)
10321 	    {
10322 		old_pos = curwin->w_cursor;
10323 		i = get_indent();
10324 		while (curwin->w_cursor.lnum > 1)
10325 		{
10326 		    ptr = skipwhite(ml_get(--(curwin->w_cursor.lnum)));
10327 
10328 		    /* ignore empty lines and lines starting with '#'. */
10329 		    if (*ptr != '#' && *ptr != NUL)
10330 			break;
10331 		}
10332 		if (get_indent() >= i)
10333 		    temp = FALSE;
10334 		curwin->w_cursor = old_pos;
10335 	    }
10336 	    if (temp)
10337 		shift_line(TRUE, FALSE, 1, TRUE);
10338 	}
10339     }
10340 
10341     /*
10342      * set indent of '#' always to 0
10343      */
10344     if (curwin->w_cursor.col > 0 && can_si && c == '#')
10345     {
10346 	/* remember current indent for next line */
10347 	old_indent = get_indent();
10348 	(void)set_indent(0, SIN_CHANGED);
10349     }
10350 
10351     /* Adjust ai_col, the char at this position can be deleted. */
10352     if (ai_col > curwin->w_cursor.col)
10353 	ai_col = curwin->w_cursor.col;
10354 }
10355 #endif
10356 
10357 /*
10358  * Get the value that w_virtcol would have when 'list' is off.
10359  * Unless 'cpo' contains the 'L' flag.
10360  */
10361     static colnr_T
10362 get_nolist_virtcol(void)
10363 {
10364     if (curwin->w_p_list && vim_strchr(p_cpo, CPO_LISTWM) == NULL)
10365 	return getvcol_nolist(&curwin->w_cursor);
10366     validate_virtcol();
10367     return curwin->w_virtcol;
10368 }
10369 
10370 #ifdef FEAT_AUTOCMD
10371 /*
10372  * Handle the InsertCharPre autocommand.
10373  * "c" is the character that was typed.
10374  * Return a pointer to allocated memory with the replacement string.
10375  * Return NULL to continue inserting "c".
10376  */
10377     static char_u *
10378 do_insert_char_pre(int c)
10379 {
10380     char_u	*res;
10381     char_u	buf[MB_MAXBYTES + 1];
10382 
10383     /* Return quickly when there is nothing to do. */
10384     if (!has_insertcharpre())
10385 	return NULL;
10386 
10387 #ifdef FEAT_MBYTE
10388     if (has_mbyte)
10389 	buf[(*mb_char2bytes)(c, buf)] = NUL;
10390     else
10391 #endif
10392     {
10393 	buf[0] = c;
10394 	buf[1] = NUL;
10395     }
10396 
10397     /* Lock the text to avoid weird things from happening. */
10398     ++textlock;
10399     set_vim_var_string(VV_CHAR, buf, -1);  /* set v:char */
10400 
10401     res = NULL;
10402     if (apply_autocmds(EVENT_INSERTCHARPRE, NULL, NULL, FALSE, curbuf))
10403     {
10404 	/* Get the value of v:char.  It may be empty or more than one
10405 	 * character.  Only use it when changed, otherwise continue with the
10406 	 * original character to avoid breaking autoindent. */
10407 	if (STRCMP(buf, get_vim_var_str(VV_CHAR)) != 0)
10408 	    res = vim_strsave(get_vim_var_str(VV_CHAR));
10409     }
10410 
10411     set_vim_var_string(VV_CHAR, NULL, -1);  /* clear v:char */
10412     --textlock;
10413 
10414     return res;
10415 }
10416 #endif
10417