Mercurial > vim
annotate runtime/doc/insert.txt @ 18997:6b2d93436388 v8.2.0059
patch 8.2.0059: compiler warnings for unused variables in small build
Commit: https://github.com/vim/vim/commit/85b0957616e9d9d0edef44baa9fa6c6a2037782d
Author: Bram Moolenaar <Bram@vim.org>
Date: Mon Dec 30 10:57:00 2019 +0100
patch 8.2.0059: compiler warnings for unused variables in small build
Problem: Compiler warnings for unused variables in small build. (Tony
Mechelynck)
Solution: Add #ifdef.
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Mon, 30 Dec 2019 11:00:04 +0100 |
parents | 130acb903dbe |
children | a3fce2763e83 |
rev | line source |
---|---|
18879 | 1 *insert.txt* For Vim version 8.2. Last change: 2019 Nov 26 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 *Insert* *Insert-mode* | |
8 Inserting and replacing text *mode-ins-repl* | |
9 | |
10 Most of this file is about Insert and Replace mode. At the end are a few | |
11 commands for inserting text in other ways. | |
12 | |
13 An overview of the most often used commands can be found in chapter 24 of the | |
14 user manual |usr_24.txt|. | |
15 | |
16 1. Special keys |ins-special-keys| | |
17 2. Special special keys |ins-special-special| | |
18 3. 'textwidth' and 'wrapmargin' options |ins-textwidth| | |
19 4. 'expandtab', 'smarttab' and 'softtabstop' options |ins-expandtab| | |
20 5. Replace mode |Replace-mode| | |
21 6. Virtual Replace mode |Virtual-Replace-mode| | |
22 7. Insert mode completion |ins-completion| | |
23 8. Insert mode commands |inserting| | |
24 9. Ex insert commands |inserting-ex| | |
25 10. Inserting a file |inserting-file| | |
26 | |
27 Also see 'virtualedit', for moving the cursor to positions where there is no | |
28 character. Useful for editing a table. | |
29 | |
30 ============================================================================== | |
31 1. Special keys *ins-special-keys* | |
32 | |
33 In Insert and Replace mode, the following characters have a special meaning; | |
34 other characters are inserted directly. To insert one of these special | |
35 characters into the buffer, precede it with CTRL-V. To insert a <Nul> | |
36 character use "CTRL-V CTRL-@" or "CTRL-V 000". On some systems, you have to | |
37 use "CTRL-V 003" to insert a CTRL-C. Note: When CTRL-V is mapped you can | |
38 often use CTRL-Q instead |i_CTRL-Q|. | |
39 | |
40 If you are working in a special language mode when inserting text, see the | |
41 'langmap' option, |'langmap'|, on how to avoid switching this mode on and off | |
42 all the time. | |
43 | |
44 If you have 'insertmode' set, <Esc> and a few other keys get another meaning. | |
45 See |'insertmode'|. | |
46 | |
47 char action ~ | |
48 ----------------------------------------------------------------------- | |
49 *i_CTRL-[* *i_<Esc>* | |
50 <Esc> or CTRL-[ End insert or Replace mode, go back to Normal mode. Finish | |
51 abbreviation. | |
52 Note: If your <Esc> key is hard to hit on your keyboard, train | |
53 yourself to use CTRL-[. | |
6153 | 54 If Esc doesn't work and you are using a Mac, try CTRL-Esc. |
55 Or disable Listening under Accessibility preferences. | |
7 | 56 *i_CTRL-C* |
57 CTRL-C Quit insert mode, go back to Normal mode. Do not check for | |
140 | 58 abbreviations. Does not trigger the |InsertLeave| autocommand |
59 event. | |
7 | 60 |
61 *i_CTRL-@* | |
16610 | 62 CTRL-@ Insert previously inserted text and stop insert. |
63 | |
7 | 64 *i_CTRL-A* |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
65 CTRL-A Insert previously inserted text. |
7 | 66 |
67 *i_CTRL-H* *i_<BS>* *i_BS* | |
68 <BS> or CTRL-H Delete the character before the cursor (see |i_backspacing| | |
69 about joining lines). | |
70 See |:fixdel| if your <BS> key does not do what you want. | |
16610 | 71 |
7 | 72 *i_<Del>* *i_DEL* |
73 <Del> Delete the character under the cursor. If the cursor is at | |
74 the end of the line, and the 'backspace' option includes | |
75 "eol", delete the <EOL>; the next line is appended after the | |
76 current one. | |
77 See |:fixdel| if your <Del> key does not do what you want. | |
78 *i_CTRL-W* | |
79 CTRL-W Delete the word before the cursor (see |i_backspacing| about | |
80 joining lines). See the section "word motions", | |
81 |word-motions|, for the definition of a word. | |
82 *i_CTRL-U* | |
6823 | 83 CTRL-U Delete all entered characters before the cursor in the current |
6884 | 84 line. If there are no newly entered characters and |
85 'backspace' is not empty, delete all characters before the | |
6823 | 86 cursor in the current line. |
87 See |i_backspacing| about joining lines. | |
7 | 88 *i_CTRL-I* *i_<Tab>* *i_Tab* |
89 <Tab> or CTRL-I Insert a tab. If the 'expandtab' option is on, the | |
90 equivalent number of spaces is inserted (use CTRL-V <Tab> to | |
91 avoid the expansion; use CTRL-Q <Tab> if CTRL-V is mapped | |
92 |i_CTRL-Q|). See also the 'smarttab' option and | |
93 |ins-expandtab|. | |
94 *i_CTRL-J* *i_<NL>* | |
95 <NL> or CTRL-J Begin new line. | |
96 *i_CTRL-M* *i_<CR>* | |
97 <CR> or CTRL-M Begin new line. | |
98 *i_CTRL-K* | |
99 CTRL-K {char1} [char2] | |
100 Enter digraph (see |digraphs|). When {char1} is a special | |
101 key, the code for that key is inserted in <> form. For | |
102 example, the string "<S-Space>" can be entered by typing | |
103 <C-K><S-Space> (two keys). Neither char is considered for | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
104 mapping. |
7 | 105 |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
106 CTRL-N Find next keyword (see |i_CTRL-N|). |
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
107 CTRL-P Find previous keyword (see |i_CTRL-P|). |
7 | 108 |
18186 | 109 CTRL-R {register} *i_CTRL-R* |
7 | 110 Insert the contents of a register. Between typing CTRL-R and |
111 the second character, '"' will be displayed to indicate that | |
112 you are expected to enter the name of a register. | |
113 The text is inserted as if you typed it, but mappings and | |
114 abbreviations are not used. If you have options like | |
115 'textwidth', 'formatoptions', or 'autoindent' set, this will | |
116 influence what will be inserted. This is different from what | |
117 happens with the "p" command and pasting with the mouse. | |
118 Special registers: | |
119 '"' the unnamed register, containing the text of | |
120 the last delete or yank | |
121 '%' the current file name | |
122 '#' the alternate file name | |
123 '*' the clipboard contents (X11: primary selection) | |
124 '+' the clipboard contents | |
125 '/' the last search pattern | |
126 ':' the last command-line | |
127 '.' the last inserted text | |
128 '-' the last small (less than a line) delete | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
129 *i_CTRL-R_=* |
7 | 130 '=' the expression register: you are prompted to |
131 enter an expression (see |expression|) | |
36 | 132 Note that 0x80 (128 decimal) is used for |
667 | 133 special keys. E.g., you can use this to move |
134 the cursor up: | |
135 CTRL-R ="\<Up>" | |
136 Use CTRL-R CTRL-R to insert text literally. | |
714 | 137 When the result is a |List| the items are used |
138 as lines. They can have line breaks inside | |
139 too. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
140 When the result is a Float it's automatically |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
141 converted to a String. |
5130
71e066e10a47
updated for version 7.3.1308
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
142 When append() or setline() is invoked the undo |
71e066e10a47
updated for version 7.3.1308
Bram Moolenaar <bram@vim.org>
parents:
4869
diff
changeset
|
143 sequence will be broken. |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
144 See |registers| about registers. |
7 | 145 |
18186 | 146 CTRL-R CTRL-R {register} *i_CTRL-R_CTRL-R* |
7 | 147 Insert the contents of a register. Works like using a single |
148 CTRL-R, but the text is inserted literally, not as if typed. | |
149 This differs when the register contains characters like <BS>. | |
150 Example, where register a contains "ab^Hc": > | |
151 CTRL-R a results in "ac". | |
152 CTRL-R CTRL-R a results in "ab^Hc". | |
153 < Options 'textwidth', 'formatoptions', etc. still apply. If | |
7147
c590de398af9
commit https://github.com/vim/vim/commit/ca63501fbcd1cf9c8aa9ff12c093c95b62a89ed7
Christian Brabandt <cb@256bit.org>
parents:
7100
diff
changeset
|
154 you also want to avoid these, use CTRL-R CTRL-O, see below. |
7 | 155 The '.' register (last inserted text) is still inserted as |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
156 typed. |
7 | 157 |
18186 | 158 CTRL-R CTRL-O {register} *i_CTRL-R_CTRL-O* |
7 | 159 Insert the contents of a register literally and don't |
160 auto-indent. Does the same as pasting with the mouse | |
11347 | 161 |<MiddleMouse>|. When the register is linewise this will |
162 insert the text above the current line, like with `P`. | |
7 | 163 Does not replace characters! |
164 The '.' register (last inserted text) is still inserted as | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
165 typed. |
7 | 166 |
18186 | 167 CTRL-R CTRL-P {register} *i_CTRL-R_CTRL-P* |
7 | 168 Insert the contents of a register literally and fix the |
169 indent, like |[<MiddleMouse>|. | |
170 Does not replace characters! | |
171 The '.' register (last inserted text) is still inserted as | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
172 typed. |
7 | 173 |
174 *i_CTRL-T* | |
175 CTRL-T Insert one shiftwidth of indent at the start of the current | |
176 line. The indent is always rounded to a 'shiftwidth' (this is | |
16610 | 177 vi compatible). |
7 | 178 *i_CTRL-D* |
179 CTRL-D Delete one shiftwidth of indent at the start of the current | |
180 line. The indent is always rounded to a 'shiftwidth' (this is | |
16610 | 181 vi compatible). |
7 | 182 *i_0_CTRL-D* |
16610 | 183 0 CTRL-D Delete all indent in the current line. |
184 | |
7 | 185 *i_^_CTRL-D* |
186 ^ CTRL-D Delete all indent in the current line. The indent is | |
187 restored in the next line. This is useful when inserting a | |
16610 | 188 label. |
7 | 189 |
190 *i_CTRL-V* | |
191 CTRL-V Insert next non-digit literally. For special keys, the | |
192 terminal code is inserted. It's also possible to enter the | |
193 decimal, octal or hexadecimal value of a character | |
194 |i_CTRL-V_digit|. | |
195 The characters typed right after CTRL-V are not considered for | |
16610 | 196 mapping. |
7 | 197 Note: When CTRL-V is mapped (e.g., to paste text) you can |
198 often use CTRL-Q instead |i_CTRL-Q|. | |
18717
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
199 When |modifyOtherKeys| is enabled then special Escape sequence |
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
200 is converted back to what it was without |modifyOtherKeys|, |
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
201 unless the Shift key is also pressed. |
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
202 |
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
203 *i_CTRL-SHIFT-V* |
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
204 CTRL-SHIFT-V Works just like CTRL-V, unless |modifyOtherKeys| is active, |
14d2a210fab1
patch 8.1.2350: other text for CTRL-V in Insert mode with modifyOtherKeys
Bram Moolenaar <Bram@vim.org>
parents:
18396
diff
changeset
|
205 then it inserts the Escape sequence for a key with modifiers. |
7 | 206 |
207 *i_CTRL-Q* | |
208 CTRL-Q Same as CTRL-V. | |
209 Note: Some terminal connections may eat CTRL-Q, it doesn't | |
210 work then. It does work in the GUI. | |
211 | |
212 CTRL-X Enter CTRL-X mode. This is a sub-mode where commands can | |
236 | 213 be given to complete words or scroll the window. See |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
214 |i_CTRL-X| and |ins-completion|. |
7 | 215 |
216 *i_CTRL-E* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
217 CTRL-E Insert the character which is below the cursor. |
7 | 218 *i_CTRL-Y* |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
219 CTRL-Y Insert the character which is above the cursor. |
7 | 220 Note that for CTRL-E and CTRL-Y 'textwidth' is not used, to be |
221 able to copy characters from a long line. | |
222 | |
223 *i_CTRL-_* | |
224 CTRL-_ Switch between languages, as follows: | |
225 - When in a rightleft window, revins and nohkmap are toggled, | |
226 since English will likely be inserted in this case. | |
227 - When in a norightleft window, revins and hkmap are toggled, | |
228 since Hebrew will likely be inserted in this case. | |
229 | |
230 CTRL-_ moves the cursor to the end of the typed text. | |
231 | |
232 This command is only available when the 'allowrevins' option | |
233 is set. | |
234 Please refer to |rileft.txt| for more information about | |
235 right-to-left mode. | |
1121 | 236 Only if compiled with the |+rightleft| feature. |
237 | |
7 | 238 *i_CTRL-^* |
239 CTRL-^ Toggle the use of typing language characters. | |
240 When language |:lmap| mappings are defined: | |
241 - If 'iminsert' is 1 (langmap mappings used) it becomes 0 (no | |
242 langmap mappings used). | |
243 - If 'iminsert' has another value it becomes 1, thus langmap | |
244 mappings are enabled. | |
245 When no language mappings are defined: | |
246 - If 'iminsert' is 2 (Input Method used) it becomes 0 (no | |
247 Input Method used). | |
248 - If 'iminsert' has another value it becomes 2, thus the Input | |
249 Method is enabled. | |
250 When set to 1, the value of the "b:keymap_name" variable, the | |
251 'keymap' option or "<lang>" appears in the status line. | |
252 The language mappings are normally used to type characters | |
253 that are different from what the keyboard produces. The | |
254 'keymap' option can be used to install a whole number of them. | |
255 | |
256 *i_CTRL-]* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
257 CTRL-] Trigger abbreviation, without inserting a character. |
7 | 258 |
259 *i_<Insert>* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
260 <Insert> Toggle between Insert and Replace mode. |
7 | 261 ----------------------------------------------------------------------- |
262 | |
263 *i_backspacing* | |
264 The effect of the <BS>, CTRL-W, and CTRL-U depend on the 'backspace' option | |
265 (unless 'revins' is set). This is a comma separated list of items: | |
266 | |
267 item action ~ | |
268 indent allow backspacing over autoindent | |
269 eol allow backspacing over end-of-line (join lines) | |
270 start allow backspacing over the start position of insert; CTRL-W and | |
271 CTRL-U stop once at the start position | |
272 | |
273 When 'backspace' is empty, Vi compatible backspacing is used. You cannot | |
274 backspace over autoindent, before column 1 or before where insert started. | |
275 | |
276 For backwards compatibility the values "0", "1" and "2" are also allowed, see | |
277 |'backspace'|. | |
278 | |
279 If the 'backspace' option does contain "eol" and the cursor is in column 1 | |
280 when one of the three keys is used, the current line is joined with the | |
281 previous line. This effectively deletes the <EOL> in front of the cursor. | |
282 | |
283 *i_CTRL-V_digit* | |
284 With CTRL-V the decimal, octal or hexadecimal value of a character can be | |
285 entered directly. This way you can enter any character, except a line break | |
286 (<NL>, value 10). There are five ways to enter the character value: | |
287 | |
288 first char mode max nr of chars max value ~ | |
289 (none) decimal 3 255 | |
236 | 290 o or O octal 3 377 (255) |
7 | 291 x or X hexadecimal 2 ff (255) |
292 u hexadecimal 4 ffff (65535) | |
293 U hexadecimal 8 7fffffff (2147483647) | |
294 | |
295 Normally you would type the maximum number of characters. Thus to enter a | |
296 space (value 32) you would type <C-V>032. You can omit the leading zero, in | |
297 which case the character typed after the number must be a non-digit. This | |
298 happens for the other modes as well: As soon as you type a character that is | |
299 invalid for the mode, the value before it will be used and the "invalid" | |
300 character is dealt with in the normal way. | |
301 | |
302 If you enter a value of 10, it will end up in the file as a 0. The 10 is a | |
303 <NL>, which is used internally to represent the <Nul> character. When writing | |
304 the buffer to a file, the <NL> character is translated into <Nul>. The <NL> | |
305 character is written at the end of each line. Thus if you want to insert a | |
306 <NL> character in a file you will have to make a line break. | |
307 | |
308 *i_CTRL-X* *insert_expand* | |
309 CTRL-X enters a sub-mode where several commands can be used. Most of these | |
17809
59f8948b7590
patch 8.1.1901: the +insert_expand feature is not always available
Bram Moolenaar <Bram@vim.org>
parents:
17771
diff
changeset
|
310 commands do keyword completion; see |ins-completion|. |
7 | 311 |
312 Two commands can be used to scroll the window up or down, without exiting | |
313 insert mode: | |
314 | |
315 *i_CTRL-X_CTRL-E* | |
316 CTRL-X CTRL-E scroll window one line up. | |
816 | 317 When doing completion look here: |complete_CTRL-E| |
7 | 318 |
319 *i_CTRL-X_CTRL-Y* | |
320 CTRL-X CTRL-Y scroll window one line down. | |
816 | 321 When doing completion look here: |complete_CTRL-Y| |
7 | 322 |
323 After CTRL-X is pressed, each CTRL-E (CTRL-Y) scrolls the window up (down) by | |
324 one line unless that would cause the cursor to move from its current position | |
325 in the file. As soon as another key is pressed, CTRL-X mode is exited and | |
326 that key is interpreted as in Insert mode. | |
327 | |
328 | |
329 ============================================================================== | |
330 2. Special special keys *ins-special-special* | |
331 | |
332 The following keys are special. They stop the current insert, do something, | |
333 and then restart insertion. This means you can do something without getting | |
334 out of Insert mode. This is very handy if you prefer to use the Insert mode | |
335 all the time, just like editors that don't have a separate Normal mode. You | |
336 may also want to set the 'backspace' option to "indent,eol,start" and set the | |
337 'insertmode' option. You can use CTRL-O if you want to map a function key to | |
338 a command. | |
339 | |
340 The changes (inserted or deleted characters) before and after these keys can | |
341 be undone separately. Only the last change can be redone and always behaves | |
342 like an "i" command. | |
343 | |
344 char action ~ | |
345 ----------------------------------------------------------------------- | |
346 <Up> cursor one line up *i_<Up>* | |
347 <Down> cursor one line down *i_<Down>* | |
348 CTRL-G <Up> cursor one line up, insert start column *i_CTRL-G_<Up>* | |
349 CTRL-G k cursor one line up, insert start column *i_CTRL-G_k* | |
350 CTRL-G CTRL-K cursor one line up, insert start column *i_CTRL-G_CTRL-K* | |
351 CTRL-G <Down> cursor one line down, insert start column *i_CTRL-G_<Down>* | |
352 CTRL-G j cursor one line down, insert start column *i_CTRL-G_j* | |
353 CTRL-G CTRL-J cursor one line down, insert start column *i_CTRL-G_CTRL-J* | |
354 <Left> cursor one character left *i_<Left>* | |
355 <Right> cursor one character right *i_<Right>* | |
356 <S-Left> cursor one word back (like "b" command) *i_<S-Left>* | |
357 <C-Left> cursor one word back (like "b" command) *i_<C-Left>* | |
358 <S-Right> cursor one word forward (like "w" command) *i_<S-Right>* | |
359 <C-Right> cursor one word forward (like "w" command) *i_<C-Right>* | |
360 <Home> cursor to first char in the line *i_<Home>* | |
361 <End> cursor to after last char in the line *i_<End>* | |
362 <C-Home> cursor to first char in the file *i_<C-Home>* | |
363 <C-End> cursor to after last char in the file *i_<C-End>* | |
364 <LeftMouse> cursor to position of mouse click *i_<LeftMouse>* | |
365 <S-Up> move window one page up *i_<S-Up>* | |
366 <PageUp> move window one page up *i_<PageUp>* | |
367 <S-Down> move window one page down *i_<S-Down>* | |
368 <PageDown> move window one page down *i_<PageDown>* | |
2409
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
369 <ScrollWheelDown> move window three lines down *i_<ScrollWheelDown>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
370 <S-ScrollWheelDown> move window one page down *i_<S-ScrollWheelDown>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
371 <ScrollWheelUp> move window three lines up *i_<ScrollWheelUp>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
372 <S-ScrollWheelUp> move window one page up *i_<S-ScrollWheelUp>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
373 <ScrollWheelLeft> move window six columns left *i_<ScrollWheelLeft>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
374 <S-ScrollWheelLeft> move window one page left *i_<S-ScrollWheelLeft>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
375 <ScrollWheelRight> move window six columns right *i_<ScrollWheelRight>* |
0ca06a92adfb
Add support for horizontal scroll wheel. (Bjorn Winckler)
Bram Moolenaar <bram@vim.org>
parents:
2365
diff
changeset
|
376 <S-ScrollWheelRight> move window one page right *i_<S-ScrollWheelRight>* |
7 | 377 CTRL-O execute one command, return to Insert mode *i_CTRL-O* |
625 | 378 CTRL-\ CTRL-O like CTRL-O but don't move the cursor *i_CTRL-\_CTRL-O* |
477 | 379 CTRL-L when 'insertmode' is set: go to Normal mode *i_CTRL-L* |
7 | 380 CTRL-G u break undo sequence, start new change *i_CTRL-G_u* |
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
381 CTRL-G U don't break undo with next left/right cursor *i_CTRL-G_U* |
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
382 movement, if the cursor stays within |
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
383 same the line |
7 | 384 ----------------------------------------------------------------------- |
385 | |
386 Note: If the cursor keys take you out of Insert mode, check the 'noesckeys' | |
387 option. | |
388 | |
389 The CTRL-O command sometimes has a side effect: If the cursor was beyond the | |
390 end of the line, it will be put on the last character in the line. In | |
391 mappings it's often better to use <Esc> (first put an "x" in the text, <Esc> | |
477 | 392 will then always put the cursor on it). Or use CTRL-\ CTRL-O, but then |
4073 | 393 beware of the cursor possibly being beyond the end of the line. Note that the |
394 command following CTRL-\ CTRL-O can still move the cursor, it is not restored | |
395 to its original position. | |
7 | 396 |
2625 | 397 The CTRL-O command takes you to Normal mode. If you then use a command enter |
3492 | 398 Insert mode again it normally doesn't nest. Thus when typing "a<C-O>a" and |
399 then <Esc> takes you back to Normal mode, you do not need to type <Esc> twice. | |
400 An exception is when not typing the command, e.g. when executing a mapping or | |
401 sourcing a script. This makes mappings work that briefly switch to Insert | |
402 mode. | |
2625 | 403 |
7 | 404 The shifted cursor keys are not available on all terminals. |
405 | |
406 Another side effect is that a count specified before the "i" or "a" command is | |
407 ignored. That is because repeating the effect of the command after CTRL-O is | |
408 too complicated. | |
409 | |
410 An example for using CTRL-G u: > | |
411 | |
412 :inoremap <C-H> <C-G>u<C-H> | |
413 | |
414 This redefines the backspace key to start a new undo sequence. You can now | |
415 undo the effect of the backspace key, without changing what you typed before | |
3456 | 416 that, with CTRL-O u. Another example: > |
417 | |
418 :inoremap <CR> <C-]><C-G>u<CR> | |
419 | |
420 This breaks undo at each line break. It also expands abbreviations before | |
421 this. | |
7 | 422 |
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
423 An example for using CTRL-G U: > |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
424 |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
425 inoremap <Left> <C-G>U<Left> |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
426 inoremap <Right> <C-G>U<Right> |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
427 inoremap <expr> <Home> col('.') == match(getline('.'), '\S') + 1 ? |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
428 \ repeat('<C-G>U<Left>', col('.') - 1) : |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
429 \ (col('.') < match(getline('.'), '\S') ? |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
430 \ repeat('<C-G>U<Right>', match(getline('.'), '\S') + 0) : |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
431 \ repeat('<C-G>U<Left>', col('.') - 1 - match(getline('.'), '\S'))) |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
432 inoremap <expr> <End> repeat('<C-G>U<Right>', col('$') - col('.')) |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
433 inoremap ( ()<C-G>U<Left> |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
434 |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
435 This makes it possible to use the cursor keys in Insert mode, without breaking |
13125 | 436 the undo sequence and therefore using |.| (redo) will work as expected. |
14123 | 437 Also entering a text like (with the "(" mapping from above): |
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
438 |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
439 Lorem ipsum (dolor |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
440 |
14123 | 441 will be repeatable by using |.| to the expected |
7074
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
442 |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
443 Lorem ipsum (dolor) |
c8efa41dd451
commit https://github.com/vim/vim/commit/8b5f65a527c353b9942e362e719687c3a7592309
Christian Brabandt <cb@256bit.org>
parents:
6884
diff
changeset
|
444 |
10 | 445 Using CTRL-O splits undo: the text typed before and after it is undone |
446 separately. If you want to avoid this (e.g., in a mapping) you might be able | |
447 to use CTRL-R = |i_CTRL-R|. E.g., to call a function: > | |
448 :imap <F2> <C-R>=MyFunc()<CR> | |
449 | |
7 | 450 When the 'whichwrap' option is set appropriately, the <Left> and <Right> |
451 keys on the first/last character in the line make the cursor wrap to the | |
452 previous/next line. | |
453 | |
454 The CTRL-G j and CTRL-G k commands can be used to insert text in front of a | |
455 column. Example: > | |
456 int i; | |
457 int j; | |
236 | 458 Position the cursor on the first "int", type "istatic <C-G>j ". The |
7 | 459 result is: > |
460 static int i; | |
461 int j; | |
462 When inserting the same text in front of the column in every line, use the | |
463 Visual blockwise command "I" |v_b_I|. | |
464 | |
465 ============================================================================== | |
466 3. 'textwidth' and 'wrapmargin' options *ins-textwidth* | |
467 | |
468 The 'textwidth' option can be used to automatically break a line before it | |
469 gets too long. Set the 'textwidth' option to the desired maximum line | |
470 length. If you then type more characters (not spaces or tabs), the | |
471 last word will be put on a new line (unless it is the only word on the | |
472 line). If you set 'textwidth' to 0, this feature is disabled. | |
473 | |
474 The 'wrapmargin' option does almost the same. The difference is that | |
475 'textwidth' has a fixed width while 'wrapmargin' depends on the width of the | |
476 screen. When using 'wrapmargin' this is equal to using 'textwidth' with a | |
477 value equal to (columns - 'wrapmargin'), where columns is the width of the | |
478 screen. | |
479 | |
480 When 'textwidth' and 'wrapmargin' are both set, 'textwidth' is used. | |
481 | |
482 If you don't really want to break the line, but view the line wrapped at a | |
483 convenient place, see the 'linebreak' option. | |
484 | |
667 | 485 The line is only broken automatically when using Insert mode, or when |
7 | 486 appending to a line. When in replace mode and the line length is not |
487 changed, the line will not be broken. | |
488 | |
489 Long lines are broken if you enter a non-white character after the margin. | |
490 The situations where a line will be broken can be restricted by adding | |
491 characters to the 'formatoptions' option: | |
492 "l" Only break a line if it was not longer than 'textwidth' when the insert | |
493 started. | |
494 "v" Only break at a white character that has been entered during the | |
495 current insert command. This is mostly Vi-compatible. | |
496 "lv" Only break if the line was not longer than 'textwidth' when the insert | |
497 started and only at a white character that has been entered during the | |
498 current insert command. Only differs from "l" when entering non-white | |
499 characters while crossing the 'textwidth' boundary. | |
500 | |
667 | 501 Normally an internal function will be used to decide where to break the line. |
502 If you want to do it in a different way set the 'formatexpr' option to an | |
503 expression that will take care of the line break. | |
504 | |
7 | 505 If you want to format a block of text, you can use the "gq" operator. Type |
506 "gq" and a movement command to move the cursor to the end of the block. In | |
507 many cases, the command "gq}" will do what you want (format until the end of | |
508 paragraph). Alternatively, you can use "gqap", which will format the whole | |
509 paragraph, no matter where the cursor currently is. Or you can use Visual | |
510 mode: hit "v", move to the end of the block, and type "gq". See also |gq|. | |
511 | |
512 ============================================================================== | |
513 4. 'expandtab', 'smarttab' and 'softtabstop' options *ins-expandtab* | |
514 | |
515 If the 'expandtab' option is on, spaces will be used to fill the amount of | |
516 whitespace of the tab. If you want to enter a real <Tab>, type CTRL-V first | |
517 (use CTRL-Q when CTRL-V is mapped |i_CTRL-Q|). | |
518 The 'expandtab' option is off by default. Note that in Replace mode, a single | |
519 character is replaced with several spaces. The result of this is that the | |
520 number of characters in the line increases. Backspacing will delete one | |
521 space at a time. The original character will be put back for only one space | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
522 that you backspace over (the last one). |
7 | 523 |
524 *ins-smarttab* | |
525 When the 'smarttab' option is on, a <Tab> inserts 'shiftwidth' positions at | |
526 the beginning of a line and 'tabstop' positions in other places. This means | |
3682 | 527 that often spaces instead of a <Tab> character are inserted. When 'smarttab' |
7 | 528 is off, a <Tab> always inserts 'tabstop' positions, and 'shiftwidth' is only |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
529 used for ">>" and the like. |
7 | 530 |
531 *ins-softtabstop* | |
532 When the 'softtabstop' option is non-zero, a <Tab> inserts 'softtabstop' | |
533 positions, and a <BS> used to delete white space, will delete 'softtabstop' | |
534 positions. This feels like 'tabstop' was set to 'softtabstop', but a real | |
535 <Tab> character still takes 'tabstop' positions, so your file will still look | |
536 correct when used by other applications. | |
537 | |
538 If 'softtabstop' is non-zero, a <BS> will try to delete as much white space to | |
539 move to the previous 'softtabstop' position, except when the previously | |
540 inserted character is a space, then it will only delete the character before | |
541 the cursor. Otherwise you cannot always delete a single character before the | |
542 cursor. You will have to delete 'softtabstop' characters first, and then type | |
543 extra spaces to get where you want to be. | |
544 | |
545 ============================================================================== | |
546 5. Replace mode *Replace* *Replace-mode* *mode-replace* | |
547 | |
548 Enter Replace mode with the "R" command in normal mode. | |
549 | |
550 In Replace mode, one character in the line is deleted for every character you | |
551 type. If there is no character to delete (at the end of the line), the | |
552 typed character is appended (as in Insert mode). Thus the number of | |
553 characters in a line stays the same until you get to the end of the line. | |
554 If a <NL> is typed, a line break is inserted and no character is deleted. | |
555 | |
556 Be careful with <Tab> characters. If you type a normal printing character in | |
557 its place, the number of characters is still the same, but the number of | |
558 columns will become smaller. | |
559 | |
560 If you delete characters in Replace mode (with <BS>, CTRL-W, or CTRL-U), what | |
561 happens is that you delete the changes. The characters that were replaced | |
562 are restored. If you had typed past the existing text, the characters you | |
563 added are deleted. This is effectively a character-at-a-time undo. | |
564 | |
565 If the 'expandtab' option is on, a <Tab> will replace one character with | |
566 several spaces. The result of this is that the number of characters in the | |
567 line increases. Backspacing will delete one space at a time. The original | |
568 character will be put back for only one space that you backspace over (the | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
569 last one). |
7 | 570 |
571 ============================================================================== | |
572 6. Virtual Replace mode *vreplace-mode* *Virtual-Replace-mode* | |
573 | |
574 Enter Virtual Replace mode with the "gR" command in normal mode. | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
575 {not available when compiled without the |+vreplace| feature} |
7 | 576 |
577 Virtual Replace mode is similar to Replace mode, but instead of replacing | |
578 actual characters in the file, you are replacing screen real estate, so that | |
579 characters further on in the file never appear to move. | |
580 | |
581 So if you type a <Tab> it may replace several normal characters, and if you | |
582 type a letter on top of a <Tab> it may not replace anything at all, since the | |
583 <Tab> will still line up to the same place as before. | |
584 | |
585 Typing a <NL> still doesn't cause characters later in the file to appear to | |
586 move. The rest of the current line will be replaced by the <NL> (that is, | |
587 they are deleted), and replacing continues on the next line. A new line is | |
588 NOT inserted unless you go past the end of the file. | |
589 | |
590 Interesting effects are seen when using CTRL-T and CTRL-D. The characters | |
591 before the cursor are shifted sideways as normal, but characters later in the | |
592 line still remain still. CTRL-T will hide some of the old line under the | |
593 shifted characters, but CTRL-D will reveal them again. | |
594 | |
595 As with Replace mode, using <BS> etc will bring back the characters that were | |
596 replaced. This still works in conjunction with 'smartindent', CTRL-T and | |
597 CTRL-D, 'expandtab', 'smarttab', 'softtabstop', etc. | |
598 | |
599 In 'list' mode, Virtual Replace mode acts as if it was not in 'list' mode, | |
600 unless "L" is in 'cpoptions'. | |
601 | |
2581 | 602 Note that the only situations for which characters beyond the cursor should |
603 appear to move are in List mode |'list'|, and occasionally when 'wrap' is set | |
604 (and the line changes length to become shorter or wider than the width of the | |
605 screen). In other cases spaces may be inserted to avoid following characters | |
606 to move. | |
7 | 607 |
608 This mode is very useful for editing <Tab> separated columns in tables, for | |
609 entering new data while keeping all the columns aligned. | |
610 | |
611 ============================================================================== | |
612 7. Insert mode completion *ins-completion* | |
613 | |
449 | 614 In Insert and Replace mode, there are several commands to complete part of a |
7 | 615 keyword or line that has been typed. This is useful if you are using |
616 complicated keywords (e.g., function names with capitals and underscores). | |
617 | |
618 Completion can be done for: | |
619 | |
620 1. Whole lines |i_CTRL-X_CTRL-L| | |
621 2. keywords in the current file |i_CTRL-X_CTRL-N| | |
622 3. keywords in 'dictionary' |i_CTRL-X_CTRL-K| | |
623 4. keywords in 'thesaurus', thesaurus-style |i_CTRL-X_CTRL-T| | |
624 5. keywords in the current and included files |i_CTRL-X_CTRL-I| | |
625 6. tags |i_CTRL-X_CTRL-]| | |
626 7. file names |i_CTRL-X_CTRL-F| | |
627 8. definitions or macros |i_CTRL-X_CTRL-D| | |
628 9. Vim command-line |i_CTRL-X_CTRL-V| | |
449 | 629 10. User defined completion |i_CTRL-X_CTRL-U| |
523 | 630 11. omni completion |i_CTRL-X_CTRL-O| |
477 | 631 12. Spelling suggestions |i_CTRL-X_s| |
11473 | 632 13. keywords in 'complete' |i_CTRL-N| |i_CTRL-P| |
7 | 633 |
11473 | 634 All these, except CTRL-N and CTRL-P, are done in CTRL-X mode. This is a |
635 sub-mode of Insert and Replace modes. You enter CTRL-X mode by typing CTRL-X | |
636 and one of the CTRL-X commands. You exit CTRL-X mode by typing a key that is | |
637 not a valid CTRL-X mode command. Valid keys are the CTRL-X command itself, | |
638 CTRL-N (next), and CTRL-P (previous). | |
7 | 639 |
16127
0375e54f0adc
patch 8.1.1068: cannot get all the information about current completion
Bram Moolenaar <Bram@vim.org>
parents:
15729
diff
changeset
|
640 To get the current completion information, |complete_info()| can be used. |
7 | 641 Also see the 'infercase' option if you want to adjust the case of the match. |
642 | |
816 | 643 *complete_CTRL-E* |
644 When completion is active you can use CTRL-E to stop it and go back to the | |
843 | 645 originally typed text. The CTRL-E will not be inserted. |
816 | 646 |
647 *complete_CTRL-Y* | |
648 When the popup menu is displayed you can use CTRL-Y to stop completion and | |
649 accept the currently selected entry. The CTRL-Y is not inserted. Typing a | |
650 space, Enter, or some other unprintable character will leave completion mode | |
651 and insert that typed character. | |
652 | |
829 | 653 When the popup menu is displayed there are a few more special keys, see |
654 |popupmenu-keys|. | |
655 | |
7 | 656 Note: The keys that are valid in CTRL-X mode are not mapped. This allows for |
657 ":map ^F ^X^F" to work (where ^F is CTRL-F and ^X is CTRL-X). The key that | |
658 ends CTRL-X mode (any key that is not a valid CTRL-X mode command) is mapped. | |
659 Also, when doing completion with 'complete' mappings apply as usual. | |
660 | |
844 | 661 Note: While completion is active Insert mode can't be used recursively. |
662 Mappings that somehow invoke ":normal i.." will generate an E523 error. | |
663 | |
7 | 664 The following mappings are suggested to make typing the completion commands |
665 a bit easier (although they will hide other commands): > | |
666 :inoremap ^] ^X^] | |
667 :inoremap ^F ^X^F | |
668 :inoremap ^D ^X^D | |
669 :inoremap ^L ^X^L | |
670 | |
671 As a special case, typing CTRL-R to perform register insertion (see | |
672 |i_CTRL-R|) will not exit CTRL-X mode. This is primarily to allow the use of | |
673 the '=' register to call some function to determine the next operation. If | |
674 the contents of the register (or result of the '=' register evaluation) are | |
675 not valid CTRL-X mode keys, then CTRL-X mode will be exited as if those keys | |
676 had been typed. | |
677 | |
678 For example, the following will map <Tab> to either actually insert a <Tab> if | |
679 the current line is currently only whitespace, or start/continue a CTRL-N | |
680 completion operation: > | |
681 | |
682 function! CleverTab() | |
683 if strpart( getline('.'), 0, col('.')-1 ) =~ '^\s*$' | |
684 return "\<Tab>" | |
685 else | |
686 return "\<C-N>" | |
2120
f63ace015c63
Updated runtime and language files.
Bram Moolenaar <bram@zimbu.org>
parents:
2033
diff
changeset
|
687 endif |
7 | 688 endfunction |
689 inoremap <Tab> <C-R>=CleverTab()<CR> | |
690 | |
691 | |
692 | |
693 Completing whole lines *compl-whole-line* | |
694 | |
695 *i_CTRL-X_CTRL-L* | |
696 CTRL-X CTRL-L Search backwards for a line that starts with the | |
459 | 697 same characters as those in the current line before |
698 the cursor. Indent is ignored. The matching line is | |
7 | 699 inserted in front of the cursor. |
459 | 700 The 'complete' option is used to decide which buffers |
667 | 701 are searched for a match. Both loaded and unloaded |
702 buffers are used. | |
7 | 703 CTRL-L or |
704 CTRL-P Search backwards for next matching line. This line | |
705 replaces the previous matching line. | |
706 | |
707 CTRL-N Search forward for next matching line. This line | |
708 replaces the previous matching line. | |
709 | |
710 CTRL-X CTRL-L After expanding a line you can additionally get the | |
711 line next to it by typing CTRL-X CTRL-L again, unless | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
712 a double CTRL-X is used. Only works for loaded |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
713 buffers. |
7 | 714 |
715 Completing keywords in current file *compl-current* | |
716 | |
717 *i_CTRL-X_CTRL-P* | |
718 *i_CTRL-X_CTRL-N* | |
719 CTRL-X CTRL-N Search forwards for words that start with the keyword | |
720 in front of the cursor. The found keyword is inserted | |
721 in front of the cursor. | |
722 | |
723 CTRL-X CTRL-P Search backwards for words that start with the keyword | |
724 in front of the cursor. The found keyword is inserted | |
725 in front of the cursor. | |
726 | |
727 CTRL-N Search forward for next matching keyword. This | |
728 keyword replaces the previous matching keyword. | |
729 | |
730 CTRL-P Search backwards for next matching keyword. This | |
731 keyword replaces the previous matching keyword. | |
732 | |
733 CTRL-X CTRL-N or | |
734 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will | |
735 copy the words following the previous expansion in | |
736 other contexts unless a double CTRL-X is used. | |
737 | |
738 If there is a keyword in front of the cursor (a name made out of alphabetic | |
739 characters and characters in 'iskeyword'), it is used as the search pattern, | |
740 with "\<" prepended (meaning: start of a word). Otherwise "\<\k\k" is used | |
741 as search pattern (start of any keyword of at least two characters). | |
742 | |
743 In Replace mode, the number of characters that are replaced depends on the | |
744 length of the matched string. This works like typing the characters of the | |
745 matched string in Replace mode. | |
746 | |
747 If there is not a valid keyword character before the cursor, any keyword of | |
748 at least two characters is matched. | |
749 e.g., to get: | |
750 printf("(%g, %g, %g)", vector[0], vector[1], vector[2]); | |
751 just type: | |
752 printf("(%g, %g, %g)", vector[0], ^P[1], ^P[2]); | |
753 | |
523 | 754 The search wraps around the end of the file, the value of 'wrapscan' is not |
755 used here. | |
756 | |
7 | 757 Multiple repeats of the same completion are skipped; thus a different match |
758 will be inserted at each CTRL-N and CTRL-P (unless there is only one | |
759 matching keyword). | |
760 | |
761 Single character matches are never included, as they usually just get in | |
762 the way of what you were really after. | |
763 e.g., to get: | |
764 printf("name = %s\n", name); | |
765 just type: | |
766 printf("name = %s\n", n^P); | |
767 or even: | |
768 printf("name = %s\n", ^P); | |
769 The 'n' in '\n' is skipped. | |
770 | |
771 After expanding a word, you can use CTRL-X CTRL-P or CTRL-X CTRL-N to get the | |
772 word following the expansion in other contexts. These sequences search for | |
773 the text just expanded and further expand by getting an extra word. This is | |
774 useful if you need to repeat a sequence of complicated words. Although CTRL-P | |
775 and CTRL-N look just for strings of at least two characters, CTRL-X CTRL-P and | |
776 CTRL-X CTRL-N can be used to expand words of just one character. | |
777 e.g., to get: | |
778 México | |
779 you can type: | |
780 M^N^P^X^P^X^P | |
781 CTRL-N starts the expansion and then CTRL-P takes back the single character | |
782 "M", the next two CTRL-X CTRL-P's get the words "é" and ";xico". | |
783 | |
784 If the previous expansion was split, because it got longer than 'textwidth', | |
785 then just the text in the current line will be used. | |
786 | |
787 If the match found is at the end of a line, then the first word in the next | |
788 line will be inserted and the message "word from next line" displayed, if | |
789 this word is accepted the next CTRL-X CTRL-P or CTRL-X CTRL-N will search | |
790 for those lines starting with this word. | |
791 | |
792 | |
793 Completing keywords in 'dictionary' *compl-dictionary* | |
794 | |
795 *i_CTRL-X_CTRL-K* | |
796 CTRL-X CTRL-K Search the files given with the 'dictionary' option | |
797 for words that start with the keyword in front of the | |
798 cursor. This is like CTRL-N, but only the dictionary | |
799 files are searched, not the current file. The found | |
800 keyword is inserted in front of the cursor. This | |
801 could potentially be pretty slow, since all matches | |
802 are found before the first match is used. By default, | |
803 the 'dictionary' option is empty. | |
804 For suggestions where to find a list of words, see the | |
805 'dictionary' option. | |
806 | |
807 CTRL-K or | |
808 CTRL-N Search forward for next matching keyword. This | |
809 keyword replaces the previous matching keyword. | |
810 | |
811 CTRL-P Search backwards for next matching keyword. This | |
812 keyword replaces the previous matching keyword. | |
813 | |
814 *i_CTRL-X_CTRL-T* | |
236 | 815 CTRL-X CTRL-T Works as CTRL-X CTRL-K, but in a special way. It uses |
7 | 816 the 'thesaurus' option instead of 'dictionary'. If a |
817 match is found in the thesaurus file, all the | |
818 remaining words on the same line are included as | |
819 matches, even though they don't complete the word. | |
820 Thus a word can be completely replaced. | |
821 | |
822 For an example, imagine the 'thesaurus' file has a | |
823 line like this: > | |
824 angry furious mad enraged | |
825 < Placing the cursor after the letters "ang" and typing | |
826 CTRL-X CTRL-T would complete the word "angry"; | |
827 subsequent presses would change the word to "furious", | |
828 "mad" etc. | |
829 Other uses include translation between two languages, | |
830 or grouping API functions by keyword. | |
831 | |
832 CTRL-T or | |
833 CTRL-N Search forward for next matching keyword. This | |
834 keyword replaces the previous matching keyword. | |
835 | |
836 CTRL-P Search backwards for next matching keyword. This | |
837 keyword replaces the previous matching keyword. | |
838 | |
839 | |
840 Completing keywords in the current and included files *compl-keyword* | |
841 | |
842 The 'include' option is used to specify a line that contains an include file | |
843 name. The 'path' option is used to search for include files. | |
844 | |
845 *i_CTRL-X_CTRL-I* | |
846 CTRL-X CTRL-I Search for the first keyword in the current and | |
847 included files that starts with the same characters | |
848 as those before the cursor. The matched keyword is | |
849 inserted in front of the cursor. | |
850 | |
851 CTRL-N Search forwards for next matching keyword. This | |
852 keyword replaces the previous matching keyword. | |
853 Note: CTRL-I is the same as <Tab>, which is likely to | |
854 be typed after a successful completion, therefore | |
855 CTRL-I is not used for searching for the next match. | |
856 | |
857 CTRL-P Search backward for previous matching keyword. This | |
858 keyword replaces the previous matching keyword. | |
859 | |
860 CTRL-X CTRL-I Further use of CTRL-X CTRL-I will copy the words | |
861 following the previous expansion in other contexts | |
862 unless a double CTRL-X is used. | |
863 | |
864 Completing tags *compl-tag* | |
865 *i_CTRL-X_CTRL-]* | |
866 CTRL-X CTRL-] Search for the first tag that starts with the same | |
867 characters as before the cursor. The matching tag is | |
868 inserted in front of the cursor. Alphabetic | |
869 characters and characters in 'iskeyword' are used | |
870 to decide which characters are included in the tag | |
871 name (same as for a keyword). See also |CTRL-]|. | |
872 The 'showfulltag' option can be used to add context | |
873 from around the tag definition. | |
874 CTRL-] or | |
875 CTRL-N Search forwards for next matching tag. This tag | |
876 replaces the previous matching tag. | |
877 | |
878 CTRL-P Search backward for previous matching tag. This tag | |
879 replaces the previous matching tag. | |
880 | |
881 | |
882 Completing file names *compl-filename* | |
883 *i_CTRL-X_CTRL-F* | |
884 CTRL-X CTRL-F Search for the first file name that starts with the | |
885 same characters as before the cursor. The matching | |
886 file name is inserted in front of the cursor. | |
887 Alphabetic characters and characters in 'isfname' | |
888 are used to decide which characters are included in | |
889 the file name. Note: the 'path' option is not used | |
890 here (yet). | |
891 CTRL-F or | |
892 CTRL-N Search forwards for next matching file name. This | |
893 file name replaces the previous matching file name. | |
894 | |
895 CTRL-P Search backward for previous matching file name. | |
896 This file name replaces the previous matching file | |
897 name. | |
898 | |
899 | |
900 Completing definitions or macros *compl-define* | |
901 | |
902 The 'define' option is used to specify a line that contains a definition. | |
903 The 'include' option is used to specify a line that contains an include file | |
904 name. The 'path' option is used to search for include files. | |
905 | |
906 *i_CTRL-X_CTRL-D* | |
907 CTRL-X CTRL-D Search in the current and included files for the | |
908 first definition (or macro) name that starts with | |
909 the same characters as before the cursor. The found | |
910 definition name is inserted in front of the cursor. | |
911 CTRL-D or | |
912 CTRL-N Search forwards for next matching macro name. This | |
913 macro name replaces the previous matching macro | |
914 name. | |
915 | |
916 CTRL-P Search backward for previous matching macro name. | |
917 This macro name replaces the previous matching macro | |
918 name. | |
919 | |
920 CTRL-X CTRL-D Further use of CTRL-X CTRL-D will copy the words | |
921 following the previous expansion in other contexts | |
922 unless a double CTRL-X is used. | |
923 | |
924 | |
925 Completing Vim commands *compl-vim* | |
926 | |
927 Completion is context-sensitive. It works like on the Command-line. It | |
449 | 928 completes an Ex command as well as its arguments. This is useful when writing |
929 a Vim script. | |
7 | 930 |
931 *i_CTRL-X_CTRL-V* | |
932 CTRL-X CTRL-V Guess what kind of item is in front of the cursor and | |
933 find the first match for it. | |
934 Note: When CTRL-V is mapped you can often use CTRL-Q | |
1620 | 935 instead of |i_CTRL-Q|. |
7 | 936 CTRL-V or |
937 CTRL-N Search forwards for next match. This match replaces | |
938 the previous one. | |
939 | |
1620 | 940 CTRL-P Search backwards for previous match. This match |
7 | 941 replaces the previous one. |
942 | |
943 CTRL-X CTRL-V Further use of CTRL-X CTRL-V will do the same as | |
944 CTRL-V. This allows mapping a key to do Vim command | |
945 completion, for example: > | |
946 :imap <Tab> <C-X><C-V> | |
947 | |
449 | 948 User defined completion *compl-function* |
12 | 949 |
950 Completion is done by a function that can be defined by the user with the | |
648 | 951 'completefunc' option. See below for how the function is called and an |
952 example |complete-functions|. | |
12 | 953 |
954 *i_CTRL-X_CTRL-U* | |
955 CTRL-X CTRL-U Guess what kind of item is in front of the cursor and | |
956 find the first match for it. | |
957 CTRL-U or | |
958 CTRL-N Use the next match. This match replaces the previous | |
959 one. | |
960 | |
961 CTRL-P Use the previous match. This match replaces the | |
962 previous one. | |
963 | |
964 | |
523 | 965 Omni completion *compl-omni* |
449 | 966 |
502 | 967 Completion is done by a function that can be defined by the user with the |
523 | 968 'omnifunc' option. This is to be used for filetype-specific completion. |
502 | 969 |
648 | 970 See below for how the function is called and an example |complete-functions|. |
523 | 971 For remarks about specific filetypes see |compl-omni-filetypes|. |
859 | 972 More completion scripts will appear, check www.vim.org. Currently there is a |
973 first version for C++. | |
449 | 974 |
975 *i_CTRL-X_CTRL-O* | |
976 CTRL-X CTRL-O Guess what kind of item is in front of the cursor and | |
977 find the first match for it. | |
978 CTRL-O or | |
979 CTRL-N Use the next match. This match replaces the previous | |
980 one. | |
981 | |
982 CTRL-P Use the previous match. This match replaces the | |
983 previous one. | |
984 | |
985 | |
477 | 986 Spelling suggestions *compl-spelling* |
987 | |
483 | 988 A word before or at the cursor is located and correctly spelled words are |
989 suggested to replace it. If there is a badly spelled word in the line, before | |
990 or under the cursor, the cursor is moved to after it. Otherwise the word just | |
991 before the cursor is used for suggestions, even though it isn't badly spelled. | |
992 | |
477 | 993 NOTE: CTRL-S suspends display in many Unix terminals. Use 's' instead. Type |
994 CTRL-Q to resume displaying. | |
995 | |
996 *i_CTRL-X_CTRL-S* *i_CTRL-X_s* | |
997 CTRL-X CTRL-S or | |
998 CTRL-X s Locate the word in front of the cursor and find the | |
999 first spell suggestion for it. | |
1000 CTRL-S or | |
1001 CTRL-N Use the next suggestion. This replaces the previous | |
1002 one. Note that you can't use 's' here. | |
1003 | |
1004 CTRL-P Use the previous suggestion. This replaces the | |
1005 previous one. | |
1006 | |
1007 | |
7 | 1008 Completing keywords from different sources *compl-generic* |
1009 | |
1010 *i_CTRL-N* | |
1011 CTRL-N Find next match for words that start with the | |
1012 keyword in front of the cursor, looking in places | |
1013 specified with the 'complete' option. The found | |
1014 keyword is inserted in front of the cursor. | |
1015 | |
1016 *i_CTRL-P* | |
1017 CTRL-P Find previous match for words that start with the | |
1018 keyword in front of the cursor, looking in places | |
1019 specified with the 'complete' option. The found | |
1020 keyword is inserted in front of the cursor. | |
1021 | |
1022 CTRL-N Search forward for next matching keyword. This | |
1023 keyword replaces the previous matching keyword. | |
1024 | |
1025 CTRL-P Search backwards for next matching keyword. This | |
1026 keyword replaces the previous matching keyword. | |
1027 | |
1028 CTRL-X CTRL-N or | |
1029 CTRL-X CTRL-P Further use of CTRL-X CTRL-N or CTRL-X CTRL-P will | |
1030 copy the words following the previous expansion in | |
1031 other contexts unless a double CTRL-X is used. | |
1032 | |
519 | 1033 |
648 | 1034 FUNCTIONS FOR FINDING COMPLETIONS *complete-functions* |
1035 | |
1036 This applies to 'completefunc' and 'omnifunc'. | |
1037 | |
659 | 1038 The function is called in two different ways: |
1039 - First the function is called to find the start of the text to be completed. | |
1040 - Later the function is called to actually find the matches. | |
648 | 1041 |
1042 On the first invocation the arguments are: | |
1043 a:findstart 1 | |
1044 a:base empty | |
1045 | |
659 | 1046 The function must return the column where the completion starts. It must be a |
1047 number between zero and the cursor column "col('.')". This involves looking | |
1048 at the characters just before the cursor and including those characters that | |
1049 could be part of the completed item. The text between this column and the | |
14637 | 1050 cursor column will be replaced with the matches. If the returned value is |
1051 larger than the cursor column, the cursor column is used. | |
3526
dd6c2497c997
Fix more 'cpo' issues in runtime files.
Bram Moolenaar <bram@vim.org>
parents:
3492
diff
changeset
|
1052 |
14637 | 1053 Negative return values: |
1054 -2 To cancel silently and stay in completion mode. | |
1055 -3 To cancel silently and leave completion mode. | |
1056 Another negative value: completion starts at the cursor column | |
648 | 1057 |
1058 On the second invocation the arguments are: | |
1059 a:findstart 0 | |
659 | 1060 a:base the text with which matches should match; the text that was |
648 | 1061 located in the first call (can be empty) |
1062 | |
1063 The function must return a List with the matching words. These matches | |
1064 usually include the "a:base" text. When there are no matches return an empty | |
659 | 1065 List. |
3082 | 1066 |
1067 In order to return more information than the matching words, return a Dict | |
1068 that contains the List. The Dict can have these items: | |
1069 words The List of matching words (mandatory). | |
1070 refresh A string to control re-invocation of the function | |
1071 (optional). | |
1072 The only value currently recognized is "always", the | |
1073 effect is that the function is called whenever the | |
1074 leading text is changed. | |
15416
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1075 |
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1076 If you want to suppress the warning message for an empty result, return |
15729 | 1077 |v:none|. This is useful to implement asynchronous completion with |
1078 |complete()|. | |
15416
5f8ddd2a7b92
patch 8.1.0716: get warning message when 'completefunc' returns nothing
Bram Moolenaar <Bram@vim.org>
parents:
14637
diff
changeset
|
1079 |
3082 | 1080 Other items are ignored. |
1081 | |
3682 | 1082 For acting upon end of completion, see the |CompleteDone| autocommand event. |
1083 | |
3082 | 1084 For example, the function can contain this: > |
1085 let matches = ... list of words ... | |
1086 return {'words': matches, 'refresh': 'always'} | |
1087 < | |
723 | 1088 *complete-items* |
659 | 1089 Each list item can either be a string or a Dictionary. When it is a string it |
1090 is used as the completion. When it is a Dictionary it can contain these | |
1091 items: | |
819 | 1092 word the text that will be inserted, mandatory |
1093 abbr abbreviation of "word"; when not empty it is used in | |
1094 the menu instead of "word" | |
820 | 1095 menu extra text for the popup menu, displayed after "word" |
1096 or "abbr" | |
819 | 1097 info more information about the item, can be displayed in a |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1098 preview or popup window |
659 | 1099 kind single letter indicating the type of completion |
867 | 1100 icase when non-zero case is to be ignored when comparing |
1101 items to be equal; when omitted zero is used, thus | |
1102 items that only differ in case are added | |
16237
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1103 equal when non-zero, always treat this item to be equal when |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1104 comparing. Which means, "equal=1" disables filtering |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1105 of this item. |
841 | 1106 dup when non-zero this match will be added even when an |
1107 item with the same word is already present. | |
2642 | 1108 empty when non-zero this match will be added even when it is |
1109 an empty string | |
13238
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1110 user_data custom data which is associated with the item and |
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1111 available in |v:completed_item| |
659 | 1112 |
16237
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1113 All of these except "icase", "equal", "dup" and "empty" must be a string. If |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1114 an item does not meet these requirements then an error message is given and |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1115 further items in the list are not used. You can mix string and Dictionary |
56451a2677dc
patch 8.1.1123: no way to avoid filtering for autocomplete function
Bram Moolenaar <Bram@vim.org>
parents:
16208
diff
changeset
|
1116 items in the returned list. |
659 | 1117 |
1118 The "menu" item is used in the popup menu and may be truncated, thus it should | |
728 | 1119 be relatively short. The "info" item can be longer, it will be displayed in |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1120 the preview window when "preview" appears in 'completeopt' or in a popup |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1121 window when "popup" appears in 'completeopt'. In the preview window the |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1122 "info" item will also remain displayed after the popup menu has been removed. |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1123 This is useful for function arguments. Use a single space for "info" to |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1124 remove existing text in the preview window. The size of the preview window is |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1125 three lines, but 'previewheight' is used when it has a value of 1 or 2. |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1126 |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1127 *complete-popup* |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1128 When "popup" is in 'completeopt' a popup window is used to display the "info". |
17909 | 1129 Then the 'completepopup' option specifies the properties of the popup. This |
1130 is used when the info popup is created. The option is a comma separated list | |
1131 of values: | |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1132 height maximum height of the popup |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1133 width maximum width of the popup |
18053 | 1134 highlight highlight group of the popup (default is PmenuSel) |
17815
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1135 align "item" (default) or "menu" |
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1136 border "on" (default) or "off" |
17771
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1137 Example: > |
4bd21046902b
patch 8.1.1882: cannot specify properties of the info popup window
Bram Moolenaar <Bram@vim.org>
parents:
16610
diff
changeset
|
1138 :set completepopup=height:10,width:60,highlight:InfoPopup |
659 | 1139 |
17909 | 1140 When the "align" value is "item" then the popup is positioned close to the |
17815
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1141 selected item. Changing the selection will also move the popup. When "align" |
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1142 is "menu" then the popup is aligned with the top of the menu if the menu is |
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1143 below the text, and the bottom of the menu otherwise. |
9ec2526c04c5
patch 8.1.1904: cannot have an info popup align with the popup menu
Bram Moolenaar <Bram@vim.org>
parents:
17809
diff
changeset
|
1144 |
17909 | 1145 After the info popup is created it can be found with |popup_findinfo()| and |
1146 properties can be changed with |popup_setoptions()|. | |
1147 | |
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1148 *complete-popuphidden* |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1149 If the information for the popup is obtained asynchronously, use "popuphidden" |
18750 | 1150 in 'completeopt'. The info popup will then be initially hidden and |
18396
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1151 |popup_show()| must be called once it has been filled with the info. This can |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1152 be done with a |CompleteChanged| autocommand, something like this: > |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1153 set completeopt+=popuphidden |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1154 au CompleteChanged * call UpdateCompleteInfo() |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1155 func UpdateCompleteInfo() |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1156 " Cancel any pending info fetch |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1157 let item = v:event.completed_item |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1158 " Start fetching info for the item then call ShowCompleteInfo(info) |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1159 endfunc |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1160 func ShowCompleteInfo(info) |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1161 let id = popup_findinfo() |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1162 if id |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1163 call popup_settext(id, 'async info: ' .. a:info) |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1164 call popup_show(id) |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1165 endif |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1166 endfunc |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1167 |
ba5d8c5d77d7
patch 8.1.2192: cannot easily fill the info popup asynchronously
Bram Moolenaar <Bram@vim.org>
parents:
18186
diff
changeset
|
1168 < *complete-item-kind* |
659 | 1169 The "kind" item uses a single letter to indicate the kind of completion. This |
1170 may be used to show the completion differently (different color or icon). | |
1171 Currently these types can be used: | |
1172 v variable | |
1173 f function or method | |
728 | 1174 m member of a struct or class |
1175 t typedef | |
1176 d #define or macro | |
648 | 1177 |
1178 When searching for matches takes some time call |complete_add()| to add each | |
1179 match to the total list. These matches should then not appear in the returned | |
1180 list! Call |complete_check()| now and then to allow the user to press a key | |
1181 while still searching for matches. Stop searching when it returns non-zero. | |
1182 | |
2642 | 1183 *E839* *E840* |
1184 The function is allowed to move the cursor, it is restored afterwards. | |
1185 The function is not allowed to move to another window or delete text. | |
648 | 1186 |
1187 An example that completes the names of the months: > | |
1188 fun! CompleteMonths(findstart, base) | |
1189 if a:findstart | |
1190 " locate the start of the word | |
1191 let line = getline('.') | |
1192 let start = col('.') - 1 | |
1193 while start > 0 && line[start - 1] =~ '\a' | |
1194 let start -= 1 | |
1195 endwhile | |
1196 return start | |
1197 else | |
1198 " find months matching with "a:base" | |
1199 let res = [] | |
1200 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec") | |
1201 if m =~ '^' . a:base | |
1202 call add(res, m) | |
1203 endif | |
1204 endfor | |
1205 return res | |
1206 endif | |
1207 endfun | |
1208 set completefunc=CompleteMonths | |
1209 < | |
1210 The same, but now pretending searching for matches is slow: > | |
1211 fun! CompleteMonths(findstart, base) | |
1212 if a:findstart | |
1213 " locate the start of the word | |
1214 let line = getline('.') | |
1215 let start = col('.') - 1 | |
1216 while start > 0 && line[start - 1] =~ '\a' | |
1217 let start -= 1 | |
1218 endwhile | |
1219 return start | |
1220 else | |
1221 " find months matching with "a:base" | |
1222 for m in split("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec") | |
1223 if m =~ '^' . a:base | |
1224 call complete_add(m) | |
1225 endif | |
1226 sleep 300m " simulate searching for next match | |
1227 if complete_check() | |
1228 break | |
1229 endif | |
1230 endfor | |
1231 return [] | |
1232 endif | |
1233 endfun | |
1234 set completefunc=CompleteMonths | |
1235 < | |
1236 | |
540 | 1237 INSERT COMPLETION POPUP MENU *ins-completion-menu* |
620 | 1238 *popupmenu-completion* |
540 | 1239 Vim can display the matches in a simplistic popup menu. |
1240 | |
1241 The menu is used when: | |
715 | 1242 - The 'completeopt' option contains "menu" or "menuone". |
540 | 1243 - The terminal supports at least 8 colors. |
857 | 1244 - There are at least two matches. One if "menuone" is used. |
540 | 1245 |
765 | 1246 The 'pumheight' option can be used to set a maximum height. The default is to |
1247 use all space available. | |
13238
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1248 The 'pumwidth' option can be used to set a minimum width. The default is 15 |
e0dcfd3dbb52
patch 8.0.1493: completion items cannot be annotated
Christian Brabandt <cb@256bit.org>
parents:
13125
diff
changeset
|
1249 characters. |
765 | 1250 |
825 | 1251 There are three states: |
1252 1. A complete match has been inserted, e.g., after using CTRL-N or CTRL-P. | |
1253 2. A cursor key has been used to select another match. The match was not | |
1254 inserted then, only the entry in the popup menu is highlighted. | |
1255 3. Only part of a match has been inserted and characters were typed or the | |
1256 backspace key was used. The list of matches was then adjusted for what is | |
1257 in front of the cursor. | |
667 | 1258 |
682 | 1259 You normally start in the first state, with the first match being inserted. |
667 | 1260 When "longest" is in 'completeopt' and there is more than one match you start |
825 | 1261 in the third state. |
665 | 1262 |
825 | 1263 If you select another match, e.g., with CTRL-N or CTRL-P, you go to the first |
1264 state. This doesn't change the list of matches. | |
682 | 1265 |
825 | 1266 When you are back at the original text then you are in the third state. To |
715 | 1267 get there right away you can use a mapping that uses CTRL-P right after |
1268 starting the completion: > | |
1269 :imap <F7> <C-N><C-P> | |
793 | 1270 < |
1271 *popupmenu-keys* | |
667 | 1272 In the first state these keys have a special meaning: |
1273 <BS> and CTRL-H Delete one character, find the matches for the word before | |
1274 the cursor. This reduces the list of matches, often to one | |
682 | 1275 entry, and switches to the second state. |
825 | 1276 Any non-special character: |
1277 Stop completion without changing the match and insert the | |
1278 typed character. | |
665 | 1279 |
825 | 1280 In the second and third state these keys have a special meaning: |
659 | 1281 <BS> and CTRL-H Delete one character, find the matches for the shorter word |
1282 before the cursor. This may find more matches. | |
1283 CTRL-L Add one character from the current match, may reduce the | |
667 | 1284 number of matches. |
682 | 1285 any printable, non-white character: |
1286 Add this character and reduce the number of matches. | |
667 | 1287 |
825 | 1288 In all three states these can be used: |
816 | 1289 CTRL-Y Yes: Accept the currently selected match and stop completion. |
1121 | 1290 CTRL-E End completion, go back to what was there before selecting a |
1291 match (what was typed or longest common string). | |
682 | 1292 <PageUp> Select a match several entries back, but don't insert it. |
1293 <PageDown> Select a match several entries further, but don't insert it. | |
665 | 1294 <Up> Select the previous match, as if CTRL-P was used, but don't |
682 | 1295 insert it. |
665 | 1296 <Down> Select the next match, as if CTRL-N was used, but don't |
682 | 1297 insert it. |
1121 | 1298 <Space> or <Tab> Stop completion without changing the match and insert the |
825 | 1299 typed character. |
1300 | |
1203 | 1301 The behavior of the <Enter> key depends on the state you are in: |
825 | 1302 first state: Use the text as it is and insert a line break. |
1303 second state: Insert the currently selected match. | |
1304 third state: Use the text as it is and insert a line break. | |
1305 | |
1306 In other words: If you used the cursor keys to select another entry in the | |
1203 | 1307 list of matches then the <Enter> key inserts that match. If you typed |
1308 something else then <Enter> inserts a line break. | |
667 | 1309 |
540 | 1310 |
1311 The colors of the menu can be changed with these highlight groups: | |
1312 Pmenu normal item |hl-Pmenu| | |
1313 PmenuSel selected item |hl-PmenuSel| | |
1314 PmenuSbar scrollbar |hl-PmenuSbar| | |
1315 PmenuThumb thumb of the scrollbar |hl-PmenuThumb| | |
1316 | |
667 | 1317 There are no special mappings for when the popup menu is visible. However, |
1318 you can use an Insert mode mapping that checks the |pumvisible()| function to | |
1319 do something different. Example: > | |
1320 :inoremap <Down> <C-R>=pumvisible() ? "\<lt>C-N>" : "\<lt>Down>"<CR> | |
540 | 1321 |
723 | 1322 You can use of <expr> in mapping to have the popup menu used when typing a |
1323 character and some condition is met. For example, for typing a dot: > | |
1324 inoremap <expr> . MayComplete() | |
1325 func MayComplete() | |
1326 if (can complete) | |
1327 return ".\<C-X>\<C-O>" | |
1328 endif | |
1329 return '.' | |
1330 endfunc | |
1331 | |
1332 See |:map-<expr>| for more info. | |
1333 | |
667 | 1334 |
1335 FILETYPE-SPECIFIC REMARKS FOR OMNI COMPLETION *compl-omni-filetypes* | |
1336 | |
1337 The file used for {filetype} should be autoload/{filetype}complete.vim | |
1338 in 'runtimepath'. Thus for "java" it is autoload/javacomplete.vim. | |
519 | 1339 |
557 | 1340 |
523 | 1341 C *ft-c-omni* |
519 | 1342 |
523 | 1343 Completion of C code requires a tags file. You should use Exuberant ctags, |
1344 because it adds extra information that is needed for completion. You can find | |
1121 | 1345 it here: http://ctags.sourceforge.net/ Version 5.6 or later is recommended. |
1346 | |
523 | 1347 For version 5.5.4 you should add a patch that adds the "typename:" field: |
711 | 1348 ftp://ftp.vim.org/pub/vim/unstable/patches/ctags-5.5.4.patch |
659 | 1349 A compiled .exe for MS-Windows can be found at: |
12968 | 1350 http://ctags.sourceforge.net/ |
1351 https://github.com/universal-ctags/ctags-win32 | |
519 | 1352 |
1353 If you want to complete system functions you can do something like this. Use | |
1354 ctags to generate a tags file for all the system header files: > | |
1355 % ctags -R -f ~/.vim/systags /usr/include /usr/local/include | |
1356 In your vimrc file add this tags file to the 'tags' option: > | |
1357 set tags+=~/.vim/systags | |
1358 | |
1359 When using CTRL-X CTRL-O after a name without any "." or "->" it is completed | |
1360 from the tags file directly. This works for any identifier, also function | |
1361 names. If you want to complete a local variable name, which does not appear | |
1362 in the tags file, use CTRL-P instead. | |
1363 | |
1364 When using CTRL-X CTRL-O after something that has "." or "->" Vim will attempt | |
1365 to recognize the type of the variable and figure out what members it has. | |
1366 This means only members valid for the variable will be listed. | |
1367 | |
523 | 1368 When a member name already was complete, CTRL-X CTRL-O will add a "." or |
1369 "->" for composite types. | |
1370 | |
519 | 1371 Vim doesn't include a C compiler, only the most obviously formatted |
1372 declarations are recognized. Preprocessor stuff may cause confusion. | |
1373 When the same structure name appears in multiple places all possible members | |
1374 are included. | |
1375 | |
529 | 1376 |
625 | 1377 CSS *ft-css-omni* |
557 | 1378 |
1379 Complete properties and their appropriate values according to CSS 2.1 | |
818 | 1380 specification. |
557 | 1381 |
1382 | |
818 | 1383 HTML *ft-html-omni* |
1384 XHTML *ft-xhtml-omni* | |
529 | 1385 |
667 | 1386 CTRL-X CTRL-O provides completion of various elements of (X)HTML files. It is |
6051 | 1387 designed to support writing of XHTML 1.0 Strict files but will also work for |
667 | 1388 other versions of HTML. Features: |
529 | 1389 |
667 | 1390 - after "<" complete tag name depending on context (no div suggestion inside |
1391 of an a tag); '/>' indicates empty tags | |
1392 - inside of tag complete proper attributes (no width attribute for an a tag); | |
1393 show also type of attribute; '*' indicates required attributes | |
1394 - when attribute has limited number of possible values help to complete them | |
557 | 1395 - complete names of entities |
532 | 1396 - complete values of "class" and "id" attributes with data obtained from |
667 | 1397 <style> tag and included CSS files |
659 | 1398 - when completing value of "style" attribute or working inside of "style" tag |
532 | 1399 switch to |ft-css-omni| completion |
667 | 1400 - when completing values of events attributes or working inside of "script" |
1401 tag switch to |ft-javascript-omni| completion | |
532 | 1402 - when used after "</" CTRL-X CTRL-O will close the last opened tag |
529 | 1403 |
557 | 1404 Note: When used first time completion menu will be shown with little delay |
818 | 1405 - this is time needed for loading of data file. |
659 | 1406 Note: Completion may fail in badly formatted documents. In such case try to |
1407 run |:make| command to detect formatting problems. | |
557 | 1408 |
1409 | |
836 | 1410 HTML flavor *html-flavor* |
1411 | |
859 | 1412 The default HTML completion depends on the filetype. For HTML files it is |
1413 HTML 4.01 Transitional ('filetype' is "html"), for XHTML it is XHTML 1.0 | |
1414 Strict ('filetype' is "xhtml"). | |
836 | 1415 |
859 | 1416 When doing completion outside of any other tag you will have possibility to |
1417 choose DOCTYPE and the appropriate data file will be loaded and used for all | |
1418 next completions. | |
836 | 1419 |
859 | 1420 More about format of data file in |xml-omni-datafile|. Some of the data files |
1421 may be found on the Vim website (|www|). | |
836 | 1422 |
859 | 1423 Note that b:html_omni_flavor may point to a file with any XML data. This |
1424 makes possible to mix PHP (|ft-php-omni|) completion with any XML dialect | |
1425 (assuming you have data file for it). Without setting that variable XHTML 1.0 | |
1426 Strict will be used. | |
836 | 1427 |
1428 | |
818 | 1429 JAVASCRIPT *ft-javascript-omni* |
649 | 1430 |
659 | 1431 Completion of most elements of JavaScript language and DOM elements. |
649 | 1432 |
1433 Complete: | |
1434 | |
1435 - variables | |
667 | 1436 - function name; show function arguments |
649 | 1437 - function arguments |
1438 - properties of variables trying to detect type of variable | |
659 | 1439 - complete DOM objects and properties depending on context |
649 | 1440 - keywords of language |
1441 | |
659 | 1442 Completion works in separate JavaScript files (&ft==javascript), inside of |
1443 <script> tag of (X)HTML and in values of event attributes (including scanning | |
5220 | 1444 of external files). |
818 | 1445 |
649 | 1446 DOM compatibility |
1447 | |
1448 At the moment (beginning of 2006) there are two main browsers - MS Internet | |
1449 Explorer and Mozilla Firefox. These two applications are covering over 90% of | |
1450 market. Theoretically standards are created by W3C organisation | |
1451 (http://www.w3c.org) but they are not always followed/implemented. | |
1452 | |
818 | 1453 IE FF W3C Omni completion ~ |
1454 +/- +/- + + ~ | |
1455 + + - + ~ | |
1456 + - - - ~ | |
1457 - + - - ~ | |
649 | 1458 |
1459 Regardless from state of implementation in browsers but if element is defined | |
1460 in standards, completion plugin will place element in suggestion list. When | |
1461 both major engines implemented element, even if this is not in standards it | |
1462 will be suggested. All other elements are not placed in suggestion list. | |
1463 | |
1464 | |
818 | 1465 PHP *ft-php-omni* |
714 | 1466 |
1121 | 1467 Completion of PHP code requires a tags file for completion of data from |
1468 external files and for class aware completion. You should use Exuberant ctags | |
1469 version 5.5.4 or newer. You can find it here: http://ctags.sourceforge.net/ | |
714 | 1470 |
1471 Script completes: | |
1472 | |
1473 - after $ variables name | |
728 | 1474 - if variable was declared as object add "->", if tags file is available show |
1475 name of class | |
819 | 1476 - after "->" complete only function and variable names specific for given |
1477 class. To find class location and contents tags file is required. Because | |
1478 PHP isn't strongly typed language user can use @var tag to declare class: > | |
1479 | |
856 | 1480 /* @var $myVar myClass */ |
819 | 1481 $myVar-> |
1482 < | |
1483 Still, to find myClass contents tags file is required. | |
728 | 1484 |
843 | 1485 - function names with additional info: |
728 | 1486 - in case of built-in functions list of possible arguments and after | type |
1487 data returned by function | |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1488 - in case of user function arguments and name of file where function was |
728 | 1489 defined (if it is not current file) |
1490 | |
1491 - constants names | |
1492 - class names after "new" declaration | |
1493 | |
714 | 1494 |
1495 Note: when doing completion first time Vim will load all necessary data into | |
1496 memory. It may take several seconds. After next use of completion delay | |
728 | 1497 should not be noticeable. |
714 | 1498 |
1499 Script detects if cursor is inside <?php ?> tags. If it is outside it will | |
1500 automatically switch to HTML/CSS/JavaScript completion. Note: contrary to | |
1501 original HTML files completion of tags (and only tags) isn't context aware. | |
1502 | |
1503 | |
856 | 1504 RUBY *ft-ruby-omni* |
838 | 1505 |
1506 Completion of Ruby code requires that vim be built with |+ruby|. | |
1507 | |
1508 Ruby completion will parse your buffer on demand in order to provide a list of | |
1509 completions. These completions will be drawn from modules loaded by 'require' | |
1510 and modules defined in the current buffer. | |
1511 | |
1512 The completions provided by CTRL-X CTRL-O are sensitive to the context: | |
1513 | |
856 | 1514 CONTEXT COMPLETIONS PROVIDED ~ |
838 | 1515 |
1516 1. Not inside a class definition Classes, constants and globals | |
1517 | |
856 | 1518 2. Inside a class definition Methods or constants defined in the class |
838 | 1519 |
856 | 1520 3. After '.', '::' or ':' Methods applicable to the object being |
1521 dereferenced | |
838 | 1522 |
856 | 1523 4. After ':' or ':foo' Symbol name (beginning with 'foo') |
838 | 1524 |
1525 Notes: | |
1526 - Vim will load/evaluate code in order to provide completions. This may | |
13125 | 1527 cause some code execution, which may be a concern. This is no longer |
1121 | 1528 enabled by default, to enable this feature add > |
1529 let g:rubycomplete_buffer_loading = 1 | |
1530 <- In context 1 above, Vim can parse the entire buffer to add a list of | |
843 | 1531 classes to the completion results. This feature is turned off by default, |
1532 to enable it add > | |
1533 let g:rubycomplete_classes_in_global = 1 | |
1534 < to your vimrc | |
838 | 1535 - In context 2 above, anonymous classes are not supported. |
1536 - In context 3 above, Vim will attempt to determine the methods supported by | |
1537 the object. | |
1538 - Vim can detect and load the Rails environment for files within a rails | |
1539 project. The feature is disabled by default, to enable it add > | |
843 | 1540 let g:rubycomplete_rails = 1 |
1541 < to your vimrc | |
838 | 1542 |
1543 | |
625 | 1544 SYNTAX *ft-syntax-omni* |
1545 | |
1121 | 1546 Vim has the ability to color syntax highlight nearly 500 languages. Part of |
1547 this highlighting includes knowing what keywords are part of a language. Many | |
1548 filetypes already have custom completion scripts written for them, the | |
1549 syntaxcomplete plugin provides basic completion for all other filetypes. It | |
1550 does this by populating the omni completion list with the text Vim already | |
1551 knows how to color highlight. It can be used for any filetype and provides a | |
1552 minimal language-sensitive completion. | |
625 | 1553 |
702 | 1554 To enable syntax code completion you can run: > |
4869 | 1555 setlocal omnifunc=syntaxcomplete#Complete |
702 | 1556 |
4869 | 1557 You can automate this by placing the following in your |.vimrc| (after any |
702 | 1558 ":filetype" command): > |
1559 if has("autocmd") && exists("+omnifunc") | |
818 | 1560 autocmd Filetype * |
1561 \ if &omnifunc == "" | | |
1562 \ setlocal omnifunc=syntaxcomplete#Complete | | |
1563 \ endif | |
702 | 1564 endif |
1565 | |
1566 The above will set completion to this script only if a specific plugin does | |
1567 not already exist for that filetype. | |
1568 | |
1569 Each filetype can have a wide range of syntax items. The plugin allows you to | |
1570 customize which syntax groups to include or exclude from the list. Let's have | |
1571 a look at the PHP filetype to see how this works. | |
1572 | |
1573 If you edit a file called, index.php, run the following command: > | |
4869 | 1574 syntax list |
625 | 1575 |
2207
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1576 The first thing you will notice is that there are many different syntax groups. |
b17bbfa96fa0
Add the settabvar() and gettabvar() functions.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1577 The PHP language can include elements from different languages like HTML, |
702 | 1578 JavaScript and many more. The syntax plugin will only include syntax groups |
1579 that begin with the filetype, "php", in this case. For example these syntax | |
1580 groups are included by default with the PHP: phpEnvVar, phpIntVar, | |
1581 phpFunctions. | |
1582 | |
13125 | 1583 If you wish non-filetype syntax items to also be included, you can use a |
1584 regular expression syntax (added in version 13.0 of | |
14249
4543777545a3
Updated runtime and language files.
Christian Brabandt <cb@256bit.org>
parents:
14123
diff
changeset
|
1585 autoload/syntaxcomplete.vim) to add items. Looking at the output from |
13125 | 1586 ":syntax list" while editing a PHP file I can see some of these entries: > |
4869 | 1587 htmlArg,htmlTag,htmlTagName,javaScriptStatement,javaScriptGlobalObjects |
625 | 1588 |
4869 | 1589 To pick up any JavaScript and HTML keyword syntax groups while editing a PHP |
13125 | 1590 file, you can use 3 different regexs, one for each language. Or you can |
1591 simply restrict the include groups to a particular value, without using | |
4869 | 1592 a regex string: > |
1593 let g:omni_syntax_group_include_php = 'php\w\+,javaScript\w\+,html\w\+' | |
1594 let g:omni_syntax_group_include_php = 'phpFunctions,phpMethods' | |
1595 < | |
1596 The basic form of this variable is: > | |
1597 let g:omni_syntax_group_include_{filetype} = 'regex,comma,separated' | |
1598 | |
1599 The PHP language has an enormous number of items which it knows how to syntax | |
5220 | 1600 highlight. These items will be available within the omni completion list. |
4869 | 1601 |
1602 Some people may find this list unwieldy or are only interested in certain | |
1603 items. There are two ways to prune this list (if necessary). If you find | |
13125 | 1604 certain syntax groups you do not wish displayed you can use two different |
1605 methods to identify these groups. The first specifically lists the syntax | |
1606 groups by name. The second uses a regular expression to identify both | |
4869 | 1607 syntax groups. Simply add one the following to your vimrc: > |
1608 let g:omni_syntax_group_exclude_php = 'phpCoreConstant,phpConstant' | |
1609 let g:omni_syntax_group_exclude_php = 'php\w*Constant' | |
702 | 1610 |
1611 Add as many syntax groups to this list by comma separating them. The basic | |
1612 form of this variable is: > | |
4869 | 1613 let g:omni_syntax_group_exclude_{filetype} = 'regex,comma,separated' |
702 | 1614 |
1615 You can create as many of these variables as you need, varying only the | |
1616 filetype at the end of the variable name. | |
625 | 1617 |
1121 | 1618 The plugin uses the isKeyword option to determine where word boundaries are |
1619 for the syntax items. For example, in the Scheme language completion should | |
1620 include the "-", call-with-output-file. Depending on your filetype, this may | |
1621 not provide the words you are expecting. Setting the | |
1622 g:omni_syntax_use_iskeyword option to 0 will force the syntax plugin to break | |
1623 on word characters. This can be controlled adding the following to your | |
1624 vimrc: > | |
1625 let g:omni_syntax_use_iskeyword = 0 | |
1626 | |
2439 | 1627 For plugin developers, the plugin exposes a public function OmniSyntaxList. |
1628 This function can be used to request a List of syntax items. When editing a | |
13125 | 1629 SQL file (:e syntax.sql) you can use the ":syntax list" command to see the |
2439 | 1630 various groups and syntax items. For example: > |
13125 | 1631 syntax list |
2439 | 1632 |
13125 | 1633 Yields data similar to this: |
1634 sqlOperator xxx some prior all like and any escape exists in is not ~ | |
1635 or intersect minus between distinct ~ | |
1636 links to Operator ~ | |
1637 sqlType xxx varbit varchar nvarchar bigint int uniqueidentifier ~ | |
1638 date money long tinyint unsigned xml text smalldate ~ | |
1639 double datetime nchar smallint numeric time bit char ~ | |
1640 varbinary binary smallmoney ~ | |
1641 image float integer timestamp real decimal ~ | |
2439 | 1642 |
1643 There are two syntax groups listed here: sqlOperator and sqlType. To retrieve | |
13125 | 1644 a List of syntax items you can call OmniSyntaxList a number of different |
2439 | 1645 ways. To retrieve all syntax items regardless of syntax group: > |
1646 echo OmniSyntaxList( [] ) | |
1647 | |
1648 To retrieve only the syntax items for the sqlOperator syntax group: > | |
1649 echo OmniSyntaxList( ['sqlOperator'] ) | |
1650 | |
1651 To retrieve all syntax items for both the sqlOperator and sqlType groups: > | |
1652 echo OmniSyntaxList( ['sqlOperator', 'sqlType'] ) | |
1653 | |
4869 | 1654 A regular expression can also be used: > |
1655 echo OmniSyntaxList( ['sql\w\+'] ) | |
1656 | |
2439 | 1657 From within a plugin, you would typically assign the output to a List: > |
1658 let myKeywords = [] | |
1659 let myKeywords = OmniSyntaxList( ['sqlKeyword'] ) | |
1660 | |
625 | 1661 |
818 | 1662 SQL *ft-sql-omni* |
1663 | |
1664 Completion for the SQL language includes statements, functions, keywords. | |
1665 It will also dynamically complete tables, procedures, views and column lists | |
1666 with data pulled directly from within a database. For detailed instructions | |
1667 and a tutorial see |omni-sql-completion|. | |
1668 | |
819 | 1669 The SQL completion plugin can be used in conjunction with other completion |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1670 plugins. For example, the PHP filetype has its own completion plugin. |
819 | 1671 Since PHP is often used to generate dynamic website by accessing a database, |
1672 the SQL completion plugin can also be enabled. This allows you to complete | |
1673 PHP code and SQL code at the same time. | |
1674 | |
818 | 1675 |
625 | 1676 XML *ft-xml-omni* |
557 | 1677 |
859 | 1678 Vim 7 provides a mechanism for context aware completion of XML files. It |
1679 depends on a special |xml-omni-datafile| and two commands: |:XMLns| and | |
1680 |:XMLent|. Features are: | |
557 | 1681 |
859 | 1682 - after "<" complete the tag name, depending on context |
1683 - inside of a tag complete proper attributes | |
1684 - when an attribute has a limited number of possible values help to complete | |
557 | 1685 them |
859 | 1686 - complete names of entities (defined in |xml-omni-datafile| and in the |
1687 current file with "<!ENTITY" declarations) | |
557 | 1688 - when used after "</" CTRL-X CTRL-O will close the last opened tag |
1689 | |
625 | 1690 Format of XML data file *xml-omni-datafile* |
557 | 1691 |
859 | 1692 XML data files are stored in the "autoload/xml" directory in 'runtimepath'. |
1693 Vim distribution provides examples of data files in the | |
1694 "$VIMRUNTIME/autoload/xml" directory. They have a meaningful name which will | |
1695 be used in commands. It should be a unique name which will not create | |
1696 conflicts. For example, the name xhtml10s.vim means it is the data file for | |
1697 XHTML 1.0 Strict. | |
557 | 1698 |
859 | 1699 Each file contains a variable with a name like g:xmldata_xhtml10s . It is |
1700 a compound from two parts: | |
557 | 1701 |
859 | 1702 1. "g:xmldata_" general prefix, constant for all data files |
1703 2. "xhtml10s" the name of the file and the name of the described XML | |
1704 dialect; it will be used as an argument for the |:XMLns| | |
1705 command | |
557 | 1706 |
1707 Part two must be exactly the same as name of file. | |
1708 | |
859 | 1709 The variable is a |Dictionary|. Keys are tag names and each value is a two |
1710 element |List|. The first element of the List is also a List with the names | |
1711 of possible children. The second element is a |Dictionary| with the names of | |
1712 attributes as keys and the possible values of attributes as values. Example: > | |
557 | 1713 |
859 | 1714 let g:xmldata_crippled = { |
1715 \ "vimxmlentities": ["amp", "lt", "gt", "apos", "quot"], | |
1716 \ 'vimxmlroot': ['tag1'], | |
1717 \ 'tag1': | |
1718 \ [ ['childoftag1a', 'childoftag1b'], {'attroftag1a': [], | |
1719 \ 'attroftag1b': ['valueofattr1', 'valueofattr2']}], | |
1720 \ 'childoftag1a': | |
1721 \ [ [], {'attrofchild': ['attrofchild']}], | |
1722 \ 'childoftag1b': | |
1723 \ [ ['childoftag1a'], {'attrofchild': []}], | |
667 | 1724 \ "vimxmltaginfo": { |
859 | 1725 \ 'tag1': ['Menu info', 'Long information visible in preview window']}, |
1726 \ 'vimxmlattrinfo': { | |
1727 \ 'attrofchild': ['Menu info', 'Long information visible in preview window']}} | |
557 | 1728 |
859 | 1729 This example would be put in the "autoload/xml/crippled.vim" file and could |
1730 help to write this file: > | |
557 | 1731 |
859 | 1732 <tag1 attroftag1b="valueofattr1"> |
1733 <childoftag1a attrofchild> | |
1734 & < | |
1735 </childoftag1a> | |
1736 <childoftag1b attrofchild="5"> | |
1737 <childoftag1a> | |
1738 > ' " | |
1739 </childoftag1a> | |
1740 </childoftag1b> | |
1741 </tag1> | |
1742 | |
1743 In the example four special elements are visible: | |
1744 | |
1745 1. "vimxmlentities" - a special key with List containing entities of this XML | |
557 | 1746 dialect. |
859 | 1747 2. If the list containing possible values of attributes has one element and |
1748 this element is equal to the name of the attribute this attribute will be | |
1749 treated as boolean and inserted as 'attrname' and not as 'attrname="' | |
1750 3. "vimxmltaginfo" - a special key with a Dictionary containing tag | |
1751 names as keys and two element List as values, for additional menu info and | |
1752 the long description. | |
1753 4. "vimxmlattrinfo" - special key with Dictionary containing attribute names | |
1754 as keys and two element List as values, for additional menu info and long | |
667 | 1755 description. |
557 | 1756 |
859 | 1757 Note: Tag names in the data file MUST not contain a namespace description. |
1758 Check xsl.vim for an example. | |
1759 Note: All data and functions are publicly available as global | |
1760 variables/functions and can be used for personal editing functions. | |
557 | 1761 |
667 | 1762 |
856 | 1763 DTD -> Vim *dtd2vim* |
836 | 1764 |
859 | 1765 On |www| is the script |dtd2vim| which parses DTD and creates an XML data file |
836 | 1766 for Vim XML omni completion. |
1767 | |
1768 dtd2vim: http://www.vim.org/scripts/script.php?script_id=1462 | |
1769 | |
859 | 1770 Check the beginning of that file for usage details. |
1771 The script requires perl and: | |
836 | 1772 |
1773 perlSGML: http://savannah.nongnu.org/projects/perlsgml | |
1774 | |
1775 | |
557 | 1776 Commands |
1777 | |
625 | 1778 :XMLns {name} [{namespace}] *:XMLns* |
557 | 1779 |
859 | 1780 Vim has to know which data file should be used and with which namespace. For |
1781 loading of the data file and connecting data with the proper namespace use | |
1782 |:XMLns| command. The first (obligatory) argument is the name of the data | |
1783 (xhtml10s, xsl). The second argument is the code of namespace (h, xsl). When | |
1784 used without a second argument the dialect will be used as default - without | |
1785 namespace declaration. For example to use XML completion in .xsl files: > | |
557 | 1786 |
1787 :XMLns xhtml10s | |
1788 :XMLns xsl xsl | |
1789 | |
1790 | |
625 | 1791 :XMLent {name} *:XMLent* |
557 | 1792 |
859 | 1793 By default entities will be completed from the data file of the default |
1794 namespace. The XMLent command should be used in case when there is no default | |
1795 namespace: > | |
557 | 1796 |
625 | 1797 :XMLent xhtml10s |
557 | 1798 |
1799 Usage | |
1800 | |
859 | 1801 While used in this situation (after declarations from previous part, | is |
557 | 1802 cursor position): > |
1803 | |
625 | 1804 <| |
557 | 1805 |
859 | 1806 Will complete to an appropriate XHTML tag, and in this situation: > |
557 | 1807 |
625 | 1808 <xsl:| |
557 | 1809 |
859 | 1810 Will complete to an appropriate XSL tag. |
1811 | |
557 | 1812 |
859 | 1813 The script xmlcomplete.vim, provided through the |autoload| mechanism, |
1814 has the xmlcomplete#GetLastOpenTag() function which can be used in XML files | |
1815 to get the name of the last open tag (b:unaryTagsStack has to be defined): > | |
529 | 1816 |
625 | 1817 :echo xmlcomplete#GetLastOpenTag("b:unaryTagsStack") |
531 | 1818 |
529 | 1819 |
532 | 1820 |
7 | 1821 ============================================================================== |
1822 8. Insert mode commands *inserting* | |
1823 | |
1824 The following commands can be used to insert new text into the buffer. They | |
1825 can all be undone and repeated with the "." command. | |
1826 | |
1827 *a* | |
1828 a Append text after the cursor [count] times. If the | |
1829 cursor is in the first column of an empty line Insert | |
1830 starts there. But not when 'virtualedit' is set! | |
1831 | |
1832 *A* | |
1833 A Append text at the end of the line [count] times. | |
1834 | |
1835 <insert> or *i* *insert* *<Insert>* | |
1836 i Insert text before the cursor [count] times. | |
1837 When using CTRL-O in Insert mode |i_CTRL-O| the count | |
1838 is not supported. | |
1839 | |
1840 *I* | |
1841 I Insert text before the first non-blank in the line | |
1842 [count] times. | |
164 | 1843 When the 'H' flag is present in 'cpoptions' and the |
1844 line only contains blanks, insert start just before | |
1845 the last blank. | |
7 | 1846 |
1847 *gI* | |
16553
0e473e9e70c2
patch 8.1.1280: remarks about functionality not in Vi clutters the help
Bram Moolenaar <Bram@vim.org>
parents:
16267
diff
changeset
|
1848 gI Insert text in column 1 [count] times. |
7 | 1849 |
1850 *gi* | |
1851 gi Insert text in the same position as where Insert mode | |
1852 was stopped last time in the current buffer. | |
1853 This uses the |'^| mark. It's different from "`^i" | |
1854 when the mark is past the end of the line. | |
1855 The position is corrected for inserted/deleted lines, | |
1856 but NOT for inserted/deleted characters. | |
1857 When the |:keepjumps| command modifier is used the |'^| | |
9 | 1858 mark won't be changed. |
7 | 1859 |
1860 *o* | |
1861 o Begin a new line below the cursor and insert text, | |
16610 | 1862 repeat [count] times. |
164 | 1863 When the '#' flag is in 'cpoptions' the count is |
1864 ignored. | |
7 | 1865 |
1866 *O* | |
1867 O Begin a new line above the cursor and insert text, | |
16610 | 1868 repeat [count] times. |
164 | 1869 When the '#' flag is in 'cpoptions' the count is |
1870 ignored. | |
7 | 1871 |
1872 These commands are used to start inserting text. You can end insert mode with | |
1873 <Esc>. See |mode-ins-repl| for the other special characters in Insert mode. | |
1874 The effect of [count] takes place after Insert mode is exited. | |
1875 | |
1876 When 'autoindent' is on, the indent for a new line is obtained from the | |
1877 previous line. When 'smartindent' or 'cindent' is on, the indent for a line | |
1878 is automatically adjusted for C programs. | |
1879 | |
1880 'textwidth' can be set to the maximum width for a line. When a line becomes | |
1881 too long when appending characters a line break is automatically inserted. | |
1882 | |
1883 | |
1884 ============================================================================== | |
1885 9. Ex insert commands *inserting-ex* | |
1886 | |
1887 *:a* *:append* | |
167 | 1888 :{range}a[ppend][!] Insert several lines of text below the specified |
7 | 1889 line. If the {range} is missing, the text will be |
1890 inserted after the current line. | |
167 | 1891 Adding [!] toggles 'autoindent' for the time this |
1892 command is executed. | |
7 | 1893 |
1894 *:i* *:in* *:insert* | |
167 | 1895 :{range}i[nsert][!] Insert several lines of text above the specified |
7 | 1896 line. If the {range} is missing, the text will be |
1897 inserted before the current line. | |
167 | 1898 Adding [!] toggles 'autoindent' for the time this |
1899 command is executed. | |
7 | 1900 |
1901 These two commands will keep on asking for lines, until you type a line | |
1902 containing only a ".". Watch out for lines starting with a backslash, see | |
1903 |line-continuation|. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1904 |
2596 | 1905 When in Ex mode (see |-e|) a backslash at the end of the line can be used to |
1906 insert a NUL character. To be able to have a line ending in a backslash use | |
1907 two backslashes. This means that the number of backslashes is halved, but | |
1908 only at the end of the line. | |
1909 | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1910 NOTE: These commands cannot be used with |:global| or |:vglobal|. |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
1911 ":append" and ":insert" don't work properly in between ":if" and |
74 | 1912 ":endif", ":for" and ":endfor", ":while" and ":endwhile". |
7 | 1913 |
1914 *:start* *:startinsert* | |
1915 :star[tinsert][!] Start Insert mode just after executing this command. | |
1916 Works like typing "i" in Normal mode. When the ! is | |
1917 included it works like "A", append to the line. | |
1918 Otherwise insertion starts at the cursor position. | |
1919 Note that when using this command in a function or | |
1920 script, the insertion only starts after the function | |
1921 or script is finished. | |
446 | 1922 This command does not work from |:normal|. |
7 | 1923 |
1924 *:stopi* *:stopinsert* | |
1925 :stopi[nsert] Stop Insert mode as soon as possible. Works like | |
1926 typing <Esc> in Insert mode. | |
1927 Can be used in an autocommand, example: > | |
1928 :au BufEnter scratch stopinsert | |
14 | 1929 < |
1930 *replacing-ex* *:startreplace* | |
1931 :startr[eplace][!] Start Replace mode just after executing this command. | |
1932 Works just like typing "R" in Normal mode. When the | |
1933 ! is included it acts just like "$R" had been typed | |
1934 (ie. begin replace mode at the end-of-line). Other- | |
1935 wise replacement begins at the cursor position. | |
1936 Note that when using this command in a function or | |
1937 script that the replacement will only start after | |
1938 the function or script is finished. | |
7 | 1939 |
599 | 1940 *:startgreplace* |
1941 :startg[replace][!] Just like |:startreplace|, but use Virtual Replace | |
1942 mode, like with |gR|. | |
1943 | |
7 | 1944 ============================================================================== |
1945 10. Inserting a file *inserting-file* | |
1946 | |
1947 *:r* *:re* *:read* | |
819 | 1948 :r[ead] [++opt] [name] |
1949 Insert the file [name] (default: current file) below | |
7 | 1950 the cursor. |
819 | 1951 See |++opt| for the possible values of [++opt]. |
7 | 1952 |
819 | 1953 :{range}r[ead] [++opt] [name] |
1954 Insert the file [name] (default: current file) below | |
7 | 1955 the specified line. |
819 | 1956 See |++opt| for the possible values of [++opt]. |
7 | 1957 |
1958 *:r!* *:read!* | |
4278 | 1959 :[range]r[ead] [++opt] !{cmd} |
1960 Execute {cmd} and insert its standard output below | |
1121 | 1961 the cursor or the specified line. A temporary file is |
1962 used to store the output of the command which is then | |
1963 read into the buffer. 'shellredir' is used to save | |
1964 the output of the command, which can be set to include | |
1965 stderr or not. {cmd} is executed like with ":!{cmd}", | |
1966 any '!' is replaced with the previous command |:!|. | |
4278 | 1967 See |++opt| for the possible values of [++opt]. |
7 | 1968 |
1969 These commands insert the contents of a file, or the output of a command, | |
1970 into the buffer. They can be undone. They cannot be repeated with the "." | |
1971 command. They work on a line basis, insertion starts below the line in which | |
1972 the cursor is, or below the specified line. To insert text above the first | |
1973 line use the command ":0r {name}". | |
1974 | |
1975 After the ":read" command, the cursor is left on the first non-blank in the | |
1976 first new line. Unless in Ex mode, then the cursor is left on the last new | |
1977 line (sorry, this is Vi compatible). | |
1978 | |
1979 If a file name is given with ":r", it becomes the alternate file. This can be | |
1980 used, for example, when you want to edit that file instead: ":e! #". This can | |
1981 be switched off by removing the 'a' flag from the 'cpoptions' option. | |
1982 | |
819 | 1983 Of the [++opt] arguments one is specifically for ":read", the ++edit argument. |
1984 This is useful when the ":read" command is actually used to read a file into | |
1985 the buffer as if editing that file. Use this command in an empty buffer: > | |
1986 :read ++edit filename | |
1987 The effect is that the 'fileformat', 'fileencoding', 'bomb', etc. options are | |
1988 set to what has been detected for "filename". Note that a single empty line | |
1989 remains, you may want to delete it. | |
1990 | |
7 | 1991 *file-read* |
1992 The 'fileformat' option sets the <EOL> style for a file: | |
1993 'fileformat' characters name ~ | |
1994 "dos" <CR><NL> or <NL> DOS format | |
1995 "unix" <NL> Unix format | |
1996 "mac" <CR> Mac format | |
1997 Previously 'textmode' was used. It is obsolete now. | |
1998 | |
1999 If 'fileformat' is "dos", a <CR> in front of an <NL> is ignored and a CTRL-Z | |
2000 at the end of the file is ignored. | |
2001 | |
2002 If 'fileformat' is "mac", a <NL> in the file is internally represented by a | |
2003 <CR>. This is to avoid confusion with a <NL> which is used to represent a | |
2004 <NUL>. See |CR-used-for-NL|. | |
2005 | |
2006 If the 'fileformats' option is not empty Vim tries to recognize the type of | |
2007 <EOL> (see |file-formats|). However, the 'fileformat' option will not be | |
2008 changed, the detected format is only used while reading the file. | |
2009 A similar thing happens with 'fileencodings'. | |
2010 | |
18972 | 2011 The message "[dos format]" is shown if a file is read in DOS format, to remind |
2012 you that something unusual is done. | |
2013 On Macintosh and Win32 the message "[unix format]" is shown if a file is read | |
2014 in Unix format. | |
7 | 2015 On non-Macintosh systems, the message "[Mac format]" is shown if a file is |
2016 read in Mac format. | |
2017 | |
2018 An example on how to use ":r !": > | |
2019 :r !uuencode binfile binfile | |
2020 This command reads "binfile", uuencodes it and reads it into the current | |
2021 buffer. Useful when you are editing e-mail and want to include a binary | |
2022 file. | |
2023 | |
2024 *read-messages* | |
2025 When reading a file Vim will display a message with information about the read | |
2026 file. In the table is an explanation for some of the items. The others are | |
2027 self explanatory. Using the long or the short version depends on the | |
2028 'shortmess' option. | |
2029 | |
2030 long short meaning ~ | |
2031 [readonly] {RO} the file is write protected | |
2032 [fifo/socket] using a stream | |
2033 [fifo] using a fifo stream | |
2034 [socket] using a socket stream | |
2035 [CR missing] reading with "dos" 'fileformat' and a | |
2036 NL without a preceding CR was found. | |
2037 [NL found] reading with "mac" 'fileformat' and a | |
2038 NL was found (could be "unix" format) | |
2039 [long lines split] at least one line was split in two | |
2040 [NOT converted] conversion from 'fileencoding' to | |
2041 'encoding' was desired but not | |
2042 possible | |
2043 [converted] conversion from 'fileencoding' to | |
2044 'encoding' done | |
2045 [crypted] file was decrypted | |
2046 [READ ERRORS] not all of the file could be read | |
2047 | |
2048 | |
14421 | 2049 vim:tw=78:ts=8:noet:ft=help:norl: |