Mercurial > vim
annotate runtime/doc/pattern.txt @ 16533:5e25171e0e75 v8.1.1270
patch 8.1.1270: cannot see current match position
commit https://github.com/vim/vim/commit/9dfa3139198b38b28673e251a3756430065914e9
Author: Bram Moolenaar <Bram@vim.org>
Date: Sat May 4 21:08:40 2019 +0200
patch 8.1.1270: cannot see current match position
Problem: Cannot see current match position.
Solution: Show "3/44" when using the "n" command and "S" is not in
'shortmess'. (Christian Brabandt, closes #4317)
author | Bram Moolenaar <Bram@vim.org> |
---|---|
date | Sat, 04 May 2019 21:15:05 +0200 |
parents | c3c1abe7aff2 |
children | 0e473e9e70c2 |
rev | line source |
---|---|
15932 | 1 *pattern.txt* For Vim version 8.1. Last change: 2019 Feb 21 |
7 | 2 |
3 | |
4 VIM REFERENCE MANUAL by Bram Moolenaar | |
5 | |
6 | |
7 Patterns and search commands *pattern-searches* | |
8 | |
9 The very basics can be found in section |03.9| of the user manual. A few more | |
10 explanations are in chapter 27 |usr_27.txt|. | |
11 | |
12 1. Search commands |search-commands| | |
13 2. The definition of a pattern |search-pattern| | |
14 3. Magic |/magic| | |
15 4. Overview of pattern items |pattern-overview| | |
16 5. Multi items |pattern-multi-items| | |
17 6. Ordinary atoms |pattern-atoms| | |
18 7. Ignoring case in a pattern |/ignorecase| | |
714 | 19 8. Composing characters |patterns-composing| |
20 9. Compare with Perl patterns |perl-patterns| | |
21 10. Highlighting matches |match-highlight| | |
7 | 22 |
23 ============================================================================== | |
3153 | 24 1. Search commands *search-commands* |
7 | 25 |
26 */* | |
27 /{pattern}[/]<CR> Search forward for the [count]'th occurrence of | |
28 {pattern} |exclusive|. | |
29 | |
30 /{pattern}/{offset}<CR> Search forward for the [count]'th occurrence of | |
31 {pattern} and go |{offset}| lines up or down. | |
32 |linewise|. | |
33 | |
34 */<CR>* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
35 /<CR> Search forward for the [count]'th occurrence of the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
36 latest used pattern |last-pattern| with latest used |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
37 |{offset}|. |
7 | 38 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
39 //{offset}<CR> Search forward for the [count]'th occurrence of the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
40 latest used pattern |last-pattern| with new |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
41 |{offset}|. If {offset} is empty no offset is used. |
7 | 42 |
43 *?* | |
44 ?{pattern}[?]<CR> Search backward for the [count]'th previous | |
45 occurrence of {pattern} |exclusive|. | |
46 | |
47 ?{pattern}?{offset}<CR> Search backward for the [count]'th previous | |
48 occurrence of {pattern} and go |{offset}| lines up or | |
49 down |linewise|. | |
50 | |
51 *?<CR>* | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
52 ?<CR> Search backward for the [count]'th occurrence of the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
53 latest used pattern |last-pattern| with latest used |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
54 |{offset}|. |
7 | 55 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
56 ??{offset}<CR> Search backward for the [count]'th occurrence of the |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
57 latest used pattern |last-pattern| with new |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
58 |{offset}|. If {offset} is empty no offset is used. |
7 | 59 |
60 *n* | |
61 n Repeat the latest "/" or "?" [count] times. | |
6647 | 62 If the cursor doesn't move the search is repeated with |
63 count + 1. | |
7 | 64 |last-pattern| {Vi: no count} |
65 | |
66 *N* | |
67 N Repeat the latest "/" or "?" [count] times in | |
68 opposite direction. |last-pattern| {Vi: no count} | |
69 | |
70 *star* *E348* *E349* | |
71 * Search forward for the [count]'th occurrence of the | |
72 word nearest to the cursor. The word used for the | |
73 search is the first of: | |
74 1. the keyword under the cursor |'iskeyword'| | |
75 2. the first keyword after the cursor, in the | |
76 current line | |
77 3. the non-blank word under the cursor | |
78 4. the first non-blank word after the cursor, | |
79 in the current line | |
80 Only whole keywords are searched for, like with the | |
81 command "/\<keyword\>". |exclusive| {not in Vi} | |
82 'ignorecase' is used, 'smartcase' is not. | |
83 | |
84 *#* | |
85 # Same as "*", but search backward. The pound sign | |
86 (character 163) also works. If the "#" key works as | |
87 backspace, try using "stty erase <BS>" before starting | |
88 Vim (<BS> is CTRL-H or a real backspace). {not in Vi} | |
89 | |
90 *gstar* | |
91 g* Like "*", but don't put "\<" and "\>" around the word. | |
92 This makes the search also find matches that are not a | |
93 whole word. {not in Vi} | |
94 | |
95 *g#* | |
96 g# Like "#", but don't put "\<" and "\>" around the word. | |
97 This makes the search also find matches that are not a | |
98 whole word. {not in Vi} | |
99 | |
100 *gd* | |
101 gd Goto local Declaration. When the cursor is on a local | |
102 variable, this command will jump to its declaration. | |
103 First Vim searches for the start of the current | |
104 function, just like "[[". If it is not found the | |
105 search stops in line 1. If it is found, Vim goes back | |
106 until a blank line is found. From this position Vim | |
107 searches for the keyword under the cursor, like with | |
108 "*", but lines that look like a comment are ignored | |
109 (see 'comments' option). | |
110 Note that this is not guaranteed to work, Vim does not | |
111 really check the syntax, it only searches for a match | |
112 with the keyword. If included files also need to be | |
113 searched use the commands listed in |include-search|. | |
114 After this command |n| searches forward for the next | |
115 match (not backward). | |
116 {not in Vi} | |
117 | |
118 *gD* | |
119 gD Goto global Declaration. When the cursor is on a | |
120 global variable that is defined in the file, this | |
121 command will jump to its declaration. This works just | |
122 like "gd", except that the search for the keyword | |
123 always starts in line 1. {not in Vi} | |
124 | |
523 | 125 *1gd* |
126 1gd Like "gd", but ignore matches inside a {} block that | |
127 ends before the cursor position. {not in Vi} | |
128 | |
129 *1gD* | |
130 1gD Like "gD", but ignore matches inside a {} block that | |
131 ends before the cursor position. {not in Vi} | |
132 | |
7 | 133 *CTRL-C* |
134 CTRL-C Interrupt current (search) command. Use CTRL-Break on | |
135 MS-DOS |dos-CTRL-Break|. | |
136 In Normal mode, any pending command is aborted. | |
137 | |
138 *:noh* *:nohlsearch* | |
139 :noh[lsearch] Stop the highlighting for the 'hlsearch' option. It | |
140 is automatically turned back on when using a search | |
141 command, or setting the 'hlsearch' option. | |
142 This command doesn't work in an autocommand, because | |
143 the highlighting state is saved and restored when | |
144 executing autocommands |autocmd-searchpat|. | |
1620 | 145 Same thing for when invoking a user function. |
7 | 146 |
147 While typing the search pattern the current match will be shown if the | |
148 'incsearch' option is on. Remember that you still have to finish the search | |
149 command with <CR> to actually position the cursor at the displayed match. Or | |
150 use <Esc> to abandon the search. | |
151 | |
152 All matches for the last used search pattern will be highlighted if you set | |
153 the 'hlsearch' option. This can be suspended with the |:nohlsearch| command. | |
154 | |
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
155 When 'shortmess' does not include the "S" flag, Vim will automatically show an |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
156 index, on which the cursor is. This can look like this: > |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
157 |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
158 [1/5] Cursor is on first of 5 matches. |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
159 [1/>99] Cursor is on first of more than 99 matches. |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
160 [>99/>99] Cursor is after 99 match of more than 99 matches. |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
161 [?/??] Unknown how many matches exists, generating the |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
162 statistics was aborted because of search timeout. |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
163 |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
164 Note: the count does not take offset into account. |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
165 |
3153 | 166 When no match is found you get the error: *E486* Pattern not found |
167 Note that for the |:global| command this behaves like a normal message, for Vi | |
168 compatibility. For the |:s| command the "e" flag can be used to avoid the | |
169 error message |:s_flags|. | |
170 | |
7 | 171 *search-offset* *{offset}* |
172 These commands search for the specified pattern. With "/" and "?" an | |
173 additional offset may be given. There are two types of offsets: line offsets | |
174 and character offsets. {the character offsets are not in Vi} | |
175 | |
176 The offset gives the cursor position relative to the found match: | |
177 [num] [num] lines downwards, in column 1 | |
178 +[num] [num] lines downwards, in column 1 | |
179 -[num] [num] lines upwards, in column 1 | |
180 e[+num] [num] characters to the right of the end of the match | |
181 e[-num] [num] characters to the left of the end of the match | |
182 s[+num] [num] characters to the right of the start of the match | |
183 s[-num] [num] characters to the left of the start of the match | |
184 b[+num] [num] identical to s[+num] above (mnemonic: begin) | |
185 b[-num] [num] identical to s[-num] above (mnemonic: begin) | |
667 | 186 ;{pattern} perform another search, see |//;| |
7 | 187 |
188 If a '-' or '+' is given but [num] is omitted, a count of one will be used. | |
189 When including an offset with 'e', the search becomes inclusive (the | |
190 character the cursor lands on is included in operations). | |
191 | |
192 Examples: | |
193 | |
194 pattern cursor position ~ | |
195 /test/+1 one line below "test", in column 1 | |
196 /test/e on the last t of "test" | |
197 /test/s+2 on the 's' of "test" | |
198 /test/b-3 three characters before "test" | |
199 | |
200 If one of these commands is used after an operator, the characters between | |
201 the cursor position before and after the search is affected. However, if a | |
202 line offset is given, the whole lines between the two cursor positions are | |
203 affected. | |
204 | |
205 An example of how to search for matches with a pattern and change the match | |
206 with another word: > | |
207 /foo<CR> find "foo" | |
5663
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5487
diff
changeset
|
208 c//e<CR> change until end of match |
7 | 209 bar<Esc> type replacement |
210 //<CR> go to start of next match | |
5663
1dea14d4c738
Update runtime files. Add support for systemverilog.
Bram Moolenaar <bram@vim.org>
parents:
5487
diff
changeset
|
211 c//e<CR> change until end of match |
7 | 212 beep<Esc> type another replacement |
213 etc. | |
214 < | |
215 *//;* *E386* | |
216 A very special offset is ';' followed by another search command. For example: > | |
217 | |
218 /test 1/;/test | |
219 /test.*/+1;?ing? | |
220 | |
221 The first one first finds the next occurrence of "test 1", and then the first | |
222 occurrence of "test" after that. | |
223 | |
224 This is like executing two search commands after each other, except that: | |
225 - It can be used as a single motion command after an operator. | |
226 - The direction for a following "n" or "N" command comes from the first | |
227 search command. | |
228 - When an error occurs the cursor is not moved at all. | |
229 | |
230 *last-pattern* | |
231 The last used pattern and offset are remembered. They can be used to repeat | |
232 the search, possibly in another direction or with another count. Note that | |
233 two patterns are remembered: One for 'normal' search commands and one for the | |
234 substitute command ":s". Each time an empty pattern is given, the previously | |
2725 | 235 used pattern is used. However, if there is no previous search command, a |
236 previous substitute pattern is used, if possible. | |
7 | 237 |
238 The 'magic' option sticks with the last used pattern. If you change 'magic', | |
239 this will not change how the last used pattern will be interpreted. | |
240 The 'ignorecase' option does not do this. When 'ignorecase' is changed, it | |
241 will result in the pattern to match other text. | |
242 | |
243 All matches for the last used search pattern will be highlighted if you set | |
244 the 'hlsearch' option. | |
245 | |
246 To clear the last used search pattern: > | |
247 :let @/ = "" | |
248 This will not set the pattern to an empty string, because that would match | |
249 everywhere. The pattern is really cleared, like when starting Vim. | |
250 | |
133 | 251 The search usually skips matches that don't move the cursor. Whether the next |
7 | 252 match is found at the next character or after the skipped match depends on the |
253 'c' flag in 'cpoptions'. See |cpo-c|. | |
254 with 'c' flag: "/..." advances 1 to 3 characters | |
255 without 'c' flag: "/..." advances 1 character | |
256 The unpredictability with the 'c' flag is caused by starting the search in the | |
257 first column, skipping matches until one is found past the cursor position. | |
258 | |
133 | 259 When searching backwards, searching starts at the start of the line, using the |
260 'c' flag in 'cpoptions' as described above. Then the last match before the | |
261 cursor position is used. | |
262 | |
7 | 263 In Vi the ":tag" command sets the last search pattern when the tag is searched |
264 for. In Vim this is not done, the previous search pattern is still remembered, | |
265 unless the 't' flag is present in 'cpoptions'. The search pattern is always | |
266 put in the search history. | |
267 | |
268 If the 'wrapscan' option is on (which is the default), searches wrap around | |
269 the end of the buffer. If 'wrapscan' is not set, the backward search stops | |
270 at the beginning and the forward search stops at the end of the buffer. If | |
271 'wrapscan' is set and the pattern was not found the error message "pattern | |
272 not found" is given, and the cursor will not be moved. If 'wrapscan' is not | |
273 set the message becomes "search hit BOTTOM without match" when searching | |
274 forward, or "search hit TOP without match" when searching backward. If | |
275 wrapscan is set and the search wraps around the end of the file the message | |
276 "search hit TOP, continuing at BOTTOM" or "search hit BOTTOM, continuing at | |
277 TOP" is given when searching backwards or forwards respectively. This can be | |
278 switched off by setting the 's' flag in the 'shortmess' option. The highlight | |
279 method 'w' is used for this message (default: standout). | |
280 | |
281 *search-range* | |
625 | 282 You can limit the search command "/" to a certain range of lines by including |
283 \%>l items. For example, to match the word "limit" below line 199 and above | |
284 line 300: > | |
285 /\%>199l\%<300llimit | |
286 Also see |/\%>l|. | |
287 | |
288 Another way is to use the ":substitute" command with the 'c' flag. Example: > | |
7 | 289 :.,300s/Pattern//gc |
290 This command will search from the cursor position until line 300 for | |
291 "Pattern". At the match, you will be asked to type a character. Type 'q' to | |
292 stop at this match, type 'n' to find the next match. | |
293 | |
294 The "*", "#", "g*" and "g#" commands look for a word near the cursor in this | |
295 order, the first one that is found is used: | |
296 - The keyword currently under the cursor. | |
297 - The first keyword to the right of the cursor, in the same line. | |
298 - The WORD currently under the cursor. | |
299 - The first WORD to the right of the cursor, in the same line. | |
300 The keyword may only contain letters and characters in 'iskeyword'. | |
301 The WORD may contain any non-blanks (<Tab>s and/or <Space>s). | |
302 Note that if you type with ten fingers, the characters are easy to remember: | |
303 the "#" is under your left hand middle finger (search to the left and up) and | |
304 the "*" is under your right hand middle finger (search to the right and down). | |
305 (this depends on your keyboard layout though). | |
306 | |
14372 | 307 *E956* |
308 In very rare cases a regular expression is used recursively. This can happen | |
15033 | 309 when executing a pattern takes a long time and when checking for messages on |
14372 | 310 channels a callback is invoked that also uses a pattern or an autocommand is |
311 triggered. In most cases this should be fine, but if a pattern is in use when | |
312 it's used again it fails. Usually this means there is something wrong with | |
313 the pattern. | |
314 | |
16533
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
315 *E956* |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
316 In very rare cases a regular expression is used recursively. This can happen |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
317 when executing a pattern takes a long time and when checking for messages on |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
318 channels a callback is invoked that also uses a pattern or an autocommand is |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
319 triggered. In most cases this should be fine, but if a pattern is in use when |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
320 it's used again it fails. Usually this means there is something wrong with |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
321 the pattern. |
5e25171e0e75
patch 8.1.1270: cannot see current match position
Bram Moolenaar <Bram@vim.org>
parents:
15932
diff
changeset
|
322 |
7 | 323 ============================================================================== |
324 2. The definition of a pattern *search-pattern* *pattern* *[pattern]* | |
325 *regular-expression* *regexp* *Pattern* | |
190 | 326 *E76* *E383* *E476* |
7 | 327 |
328 For starters, read chapter 27 of the user manual |usr_27.txt|. | |
329 | |
330 */bar* */\bar* */pattern* | |
331 1. A pattern is one or more branches, separated by "\|". It matches anything | |
332 that matches one of the branches. Example: "foo\|beep" matches "foo" and | |
333 matches "beep". If more than one branch matches, the first one is used. | |
334 | |
335 pattern ::= branch | |
336 or branch \| branch | |
337 or branch \| branch \| branch | |
338 etc. | |
339 | |
340 */branch* */\&* | |
341 2. A branch is one or more concats, separated by "\&". It matches the last | |
342 concat, but only if all the preceding concats also match at the same | |
343 position. Examples: | |
344 "foobeep\&..." matches "foo" in "foobeep". | |
345 ".*Peter\&.*Bob" matches in a line containing both "Peter" and "Bob" | |
346 | |
347 branch ::= concat | |
348 or concat \& concat | |
349 or concat \& concat \& concat | |
350 etc. | |
351 | |
352 */concat* | |
353 3. A concat is one or more pieces, concatenated. It matches a match for the | |
354 first piece, followed by a match for the second piece, etc. Example: | |
355 "f[0-9]b", first matches "f", then a digit and then "b". | |
356 | |
357 concat ::= piece | |
358 or piece piece | |
359 or piece piece piece | |
360 etc. | |
361 | |
362 */piece* | |
363 4. A piece is an atom, possibly followed by a multi, an indication of how many | |
364 times the atom can be matched. Example: "a*" matches any sequence of "a" | |
365 characters: "", "a", "aa", etc. See |/multi|. | |
366 | |
367 piece ::= atom | |
368 or atom multi | |
369 | |
370 */atom* | |
371 5. An atom can be one of a long list of items. Many atoms match one character | |
372 in the text. It is often an ordinary character or a character class. | |
373 Braces can be used to make a pattern into an atom. The "\z(\)" construct | |
374 is only for syntax highlighting. | |
375 | |
376 atom ::= ordinary-atom |/ordinary-atom| | |
377 or \( pattern \) |/\(| | |
378 or \%( pattern \) |/\%(| | |
379 or \z( pattern \) |/\z(| | |
380 | |
381 | |
5146 | 382 */\%#=* *two-engines* *NFA* |
4444 | 383 Vim includes two regexp engines: |
384 1. An old, backtracking engine that supports everything. | |
10191
01521953bdf1
commit https://github.com/vim/vim/commit/220adb1e9f9e0b27d28185167d2730bf2f93057d
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
385 2. A new, NFA engine that works much faster on some patterns, possibly slower |
01521953bdf1
commit https://github.com/vim/vim/commit/220adb1e9f9e0b27d28185167d2730bf2f93057d
Christian Brabandt <cb@256bit.org>
parents:
9286
diff
changeset
|
386 on some patterns. |
4444 | 387 |
388 Vim will automatically select the right engine for you. However, if you run | |
389 into a problem or want to specifically select one engine or the other, you can | |
390 prepend one of the following to the pattern: | |
391 | |
392 \%#=0 Force automatic selection. Only has an effect when | |
393 'regexpengine' has been set to a non-zero value. | |
394 \%#=1 Force using the old engine. | |
395 \%#=2 Force using the NFA engine. | |
396 | |
397 You can also use the 'regexpengine' option to change the default. | |
398 | |
399 *E864* *E868* *E874* *E875* *E876* *E877* *E878* | |
400 If selecting the NFA engine and it runs into something that is not implemented | |
401 the pattern will not match. This is only useful when debugging Vim. | |
402 | |
7 | 403 ============================================================================== |
840 | 404 3. Magic */magic* |
405 | |
406 Some characters in the pattern are taken literally. They match with the same | |
407 character in the text. When preceded with a backslash however, these | |
408 characters get a special meaning. | |
409 | |
410 Other characters have a special meaning without a backslash. They need to be | |
411 preceded with a backslash to match literally. | |
412 | |
413 If a character is taken literally or not depends on the 'magic' option and the | |
414 items mentioned next. | |
415 */\m* */\M* | |
416 Use of "\m" makes the pattern after it be interpreted as if 'magic' is set, | |
417 ignoring the actual value of the 'magic' option. | |
418 Use of "\M" makes the pattern after it be interpreted as if 'nomagic' is used. | |
419 */\v* */\V* | |
15281 | 420 Use of "\v" means that after it, all ASCII characters except '0'-'9', 'a'-'z', |
421 'A'-'Z' and '_' have special meaning: "very magic" | |
840 | 422 |
15281 | 423 Use of "\V" means that after it, only a backslash and terminating character |
424 (usually / or ?) have special meaning: "very nomagic" | |
840 | 425 |
426 Examples: | |
427 after: \v \m \M \V matches ~ | |
428 'magic' 'nomagic' | |
429 $ $ $ \$ matches end-of-line | |
430 . . \. \. matches any character | |
431 * * \* \* any number of the previous atom | |
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
6697
diff
changeset
|
432 ~ ~ \~ \~ latest substitute string |
840 | 433 () \(\) \(\) \(\) grouping into an atom |
434 | \| \| \| separating alternatives | |
435 \a \a \a \a alphabetic character | |
436 \\ \\ \\ \\ literal backslash | |
437 \. \. . . literal dot | |
438 \{ { { { literal '{' | |
439 a a a a literal 'a' | |
440 | |
441 {only Vim supports \m, \M, \v and \V} | |
442 | |
443 It is recommended to always keep the 'magic' option at the default setting, | |
444 which is 'magic'. This avoids portability problems. To make a pattern immune | |
445 to the 'magic' option being set or not, put "\m" or "\M" at the start of the | |
446 pattern. | |
447 | |
448 ============================================================================== | |
7 | 449 4. Overview of pattern items *pattern-overview* |
4444 | 450 *E865* *E866* *E867* *E869* |
7 | 451 |
452 Overview of multi items. */multi* *E61* *E62* | |
4444 | 453 More explanation and examples below, follow the links. *E64* *E871* |
7 | 454 |
455 multi ~ | |
456 'magic' 'nomagic' matches of the preceding atom ~ | |
457 |/star| * \* 0 or more as many as possible | |
458 |/\+| \+ \+ 1 or more as many as possible (*) | |
459 |/\=| \= \= 0 or 1 as many as possible (*) | |
460 |/\?| \? \? 0 or 1 as many as possible (*) | |
461 | |
462 |/\{| \{n,m} \{n,m} n to m as many as possible (*) | |
463 \{n} \{n} n exactly (*) | |
464 \{n,} \{n,} at least n as many as possible (*) | |
465 \{,m} \{,m} 0 to m as many as possible (*) | |
466 \{} \{} 0 or more as many as possible (same as *) (*) | |
467 | |
468 |/\{-| \{-n,m} \{-n,m} n to m as few as possible (*) | |
469 \{-n} \{-n} n exactly (*) | |
470 \{-n,} \{-n,} at least n as few as possible (*) | |
471 \{-,m} \{-,m} 0 to m as few as possible (*) | |
472 \{-} \{-} 0 or more as few as possible (*) | |
473 | |
474 *E59* | |
475 |/\@>| \@> \@> 1, like matching a whole pattern (*) | |
476 |/\@=| \@= \@= nothing, requires a match |/zero-width| (*) | |
477 |/\@!| \@! \@! nothing, requires NO match |/zero-width| (*) | |
478 |/\@<=| \@<= \@<= nothing, requires a match behind |/zero-width| (*) | |
479 |/\@<!| \@<! \@<! nothing, requires NO match behind |/zero-width| (*) | |
480 | |
481 (*) {not in Vi} | |
482 | |
483 | |
484 Overview of ordinary atoms. */ordinary-atom* | |
485 More explanation and examples below, follow the links. | |
486 | |
487 ordinary atom ~ | |
488 magic nomagic matches ~ | |
489 |/^| ^ ^ start-of-line (at start of pattern) |/zero-width| | |
490 |/\^| \^ \^ literal '^' | |
491 |/\_^| \_^ \_^ start-of-line (used anywhere) |/zero-width| | |
492 |/$| $ $ end-of-line (at end of pattern) |/zero-width| | |
493 |/\$| \$ \$ literal '$' | |
494 |/\_$| \_$ \_$ end-of-line (used anywhere) |/zero-width| | |
495 |/.| . \. any single character (not an end-of-line) | |
496 |/\_.| \_. \_. any single character or end-of-line | |
497 |/\<| \< \< beginning of a word |/zero-width| | |
498 |/\>| \> \> end of a word |/zero-width| | |
499 |/\zs| \zs \zs anything, sets start of match | |
500 |/\ze| \ze \ze anything, sets end of match | |
501 |/\%^| \%^ \%^ beginning of file |/zero-width| *E71* | |
502 |/\%$| \%$ \%$ end of file |/zero-width| | |
640 | 503 |/\%V| \%V \%V inside Visual area |/zero-width| |
7 | 504 |/\%#| \%# \%# cursor position |/zero-width| |
640 | 505 |/\%'m| \%'m \%'m mark m position |/zero-width| |
7 | 506 |/\%l| \%23l \%23l in line 23 |/zero-width| |
507 |/\%c| \%23c \%23c in column 23 |/zero-width| | |
508 |/\%v| \%23v \%23v in virtual column 23 |/zero-width| | |
509 | |
20 | 510 Character classes {not in Vi}: */character-classes* |
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
6697
diff
changeset
|
511 magic nomagic matches ~ |
7 | 512 |/\i| \i \i identifier character (see 'isident' option) |
513 |/\I| \I \I like "\i", but excluding digits | |
514 |/\k| \k \k keyword character (see 'iskeyword' option) | |
515 |/\K| \K \K like "\k", but excluding digits | |
516 |/\f| \f \f file name character (see 'isfname' option) | |
517 |/\F| \F \F like "\f", but excluding digits | |
518 |/\p| \p \p printable character (see 'isprint' option) | |
519 |/\P| \P \P like "\p", but excluding digits | |
520 |/\s| \s \s whitespace character: <Space> and <Tab> | |
521 |/\S| \S \S non-whitespace character; opposite of \s | |
522 |/\d| \d \d digit: [0-9] | |
523 |/\D| \D \D non-digit: [^0-9] | |
524 |/\x| \x \x hex digit: [0-9A-Fa-f] | |
525 |/\X| \X \X non-hex digit: [^0-9A-Fa-f] | |
526 |/\o| \o \o octal digit: [0-7] | |
527 |/\O| \O \O non-octal digit: [^0-7] | |
528 |/\w| \w \w word character: [0-9A-Za-z_] | |
529 |/\W| \W \W non-word character: [^0-9A-Za-z_] | |
530 |/\h| \h \h head of word character: [A-Za-z_] | |
531 |/\H| \H \H non-head of word character: [^A-Za-z_] | |
532 |/\a| \a \a alphabetic character: [A-Za-z] | |
533 |/\A| \A \A non-alphabetic character: [^A-Za-z] | |
534 |/\l| \l \l lowercase character: [a-z] | |
535 |/\L| \L \L non-lowercase character: [^a-z] | |
536 |/\u| \u \u uppercase character: [A-Z] | |
537 |/\U| \U \U non-uppercase character [^A-Z] | |
538 |/\_| \_x \_x where x is any of the characters above: character | |
539 class with end-of-line included | |
540 (end of character classes) | |
541 | |
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
6697
diff
changeset
|
542 magic nomagic matches ~ |
7 | 543 |/\e| \e \e <Esc> |
544 |/\t| \t \t <Tab> | |
545 |/\r| \r \r <CR> | |
546 |/\b| \b \b <BS> | |
547 |/\n| \n \n end-of-line | |
548 |/~| ~ \~ last given substitute string | |
549 |/\1| \1 \1 same string as matched by first \(\) {not in Vi} | |
550 |/\2| \2 \2 Like "\1", but uses second \(\) | |
551 ... | |
552 |/\9| \9 \9 Like "\1", but uses ninth \(\) | |
553 *E68* | |
554 |/\z1| \z1 \z1 only for syntax highlighting, see |:syn-ext-match| | |
555 ... | |
556 |/\z1| \z9 \z9 only for syntax highlighting, see |:syn-ext-match| | |
557 | |
558 x x a character with no special meaning matches itself | |
559 | |
560 |/[]| [] \[] any character specified inside the [] | |
4119 | 561 |/\%[]| \%[] \%[] a sequence of optionally matched atoms |
7 | 562 |
1620 | 563 |/\c| \c \c ignore case, do not use the 'ignorecase' option |
564 |/\C| \C \C match case, do not use the 'ignorecase' option | |
4444 | 565 |/\Z| \Z \Z ignore differences in Unicode "combining characters". |
566 Useful when searching voweled Hebrew or Arabic text. | |
567 | |
7384
aea5ebf352c4
commit https://github.com/vim/vim/commit/256972a9849b5d575b62a6a71be5b6934b5b0e8b
Christian Brabandt <cb@256bit.org>
parents:
6697
diff
changeset
|
568 magic nomagic matches ~ |
7 | 569 |/\m| \m \m 'magic' on for the following chars in the pattern |
570 |/\M| \M \M 'magic' off for the following chars in the pattern | |
571 |/\v| \v \v the following chars in the pattern are "very magic" | |
572 |/\V| \V \V the following chars in the pattern are "very nomagic" | |
4444 | 573 |/\%#=| \%#=1 \%#=1 select regexp engine |/zero-width| |
7 | 574 |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
575 |/\%d| \%d \%d match specified decimal character (eg \%d123) |
24 | 576 |/\%x| \%x \%x match specified hex character (eg \%x2a) |
577 |/\%o| \%o \%o match specified octal character (eg \%o040) | |
578 |/\%u| \%u \%u match specified multibyte character (eg \%u20ac) | |
579 |/\%U| \%U \%U match specified large multibyte character (eg | |
580 \%U12345678) | |
5901 | 581 |/\%C| \%C \%C match any composing characters |
7 | 582 |
583 Example matches ~ | |
584 \<\I\i* or | |
585 \<\h\w* | |
586 \<[a-zA-Z_][a-zA-Z0-9_]* | |
587 An identifier (e.g., in a C program). | |
588 | |
589 \(\.$\|\. \) A period followed by <EOL> or a space. | |
590 | |
591 [.!?][])"']*\($\|[ ]\) A search pattern that finds the end of a sentence, | |
592 with almost the same definition as the ")" command. | |
593 | |
594 cat\Z Both "cat" and "càt" ("a" followed by 0x0300) | |
595 Does not match "càt" (character 0x00e0), even | |
596 though it may look the same. | |
597 | |
598 | |
599 ============================================================================== | |
600 5. Multi items *pattern-multi-items* | |
601 | |
602 An atom can be followed by an indication of how many times the atom can be | |
603 matched and in what way. This is called a multi. See |/multi| for an | |
604 overview. | |
605 | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
606 */star* */\star* |
7 | 607 * (use \* when 'magic' is not set) |
608 Matches 0 or more of the preceding atom, as many as possible. | |
609 Example 'nomagic' matches ~ | |
610 a* a\* "", "a", "aa", "aaa", etc. | |
611 .* \.\* anything, also an empty string, no end-of-line | |
612 \_.* \_.\* everything up to the end of the buffer | |
613 \_.*END \_.\*END everything up to and including the last "END" | |
614 in the buffer | |
615 | |
616 Exception: When "*" is used at the start of the pattern or just after | |
617 "^" it matches the star character. | |
618 | |
619 Be aware that repeating "\_." can match a lot of text and take a long | |
620 time. For example, "\_.*END" matches all text from the current | |
621 position to the last occurrence of "END" in the file. Since the "*" | |
622 will match as many as possible, this first skips over all lines until | |
623 the end of the file and then tries matching "END", backing up one | |
624 character at a time. | |
625 | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
626 */\+* |
7 | 627 \+ Matches 1 or more of the preceding atom, as many as possible. {not in |
628 Vi} | |
629 Example matches ~ | |
630 ^.\+$ any non-empty line | |
631 \s\+ white space of at least one character | |
632 | |
633 */\=* | |
634 \= Matches 0 or 1 of the preceding atom, as many as possible. {not in Vi} | |
635 Example matches ~ | |
636 foo\= "fo" and "foo" | |
637 | |
638 */\?* | |
639 \? Just like \=. Cannot be used when searching backwards with the "?" | |
640 command. {not in Vi} | |
641 | |
8951
0bdeaf7092bc
commit https://github.com/vim/vim/commit/aa3b15dbebf333282503d6031e2f9ba6ee4398ed
Christian Brabandt <cb@256bit.org>
parents:
8876
diff
changeset
|
642 */\{* *E60* *E554* *E870* |
7 | 643 \{n,m} Matches n to m of the preceding atom, as many as possible |
644 \{n} Matches n of the preceding atom | |
645 \{n,} Matches at least n of the preceding atom, as many as possible | |
646 \{,m} Matches 0 to m of the preceding atom, as many as possible | |
647 \{} Matches 0 or more of the preceding atom, as many as possible (like *) | |
648 */\{-* | |
649 \{-n,m} matches n to m of the preceding atom, as few as possible | |
650 \{-n} matches n of the preceding atom | |
651 \{-n,} matches at least n of the preceding atom, as few as possible | |
652 \{-,m} matches 0 to m of the preceding atom, as few as possible | |
653 \{-} matches 0 or more of the preceding atom, as few as possible | |
654 {Vi does not have any of these} | |
655 | |
168 | 656 n and m are positive decimal numbers or zero |
1125 | 657 *non-greedy* |
7 | 658 If a "-" appears immediately after the "{", then a shortest match |
659 first algorithm is used (see example below). In particular, "\{-}" is | |
660 the same as "*" but uses the shortest match first algorithm. BUT: A | |
661 match that starts earlier is preferred over a shorter match: "a\{-}b" | |
662 matches "aaab" in "xaaab". | |
663 | |
664 Example matches ~ | |
665 ab\{2,3}c "abbc" or "abbbc" | |
1620 | 666 a\{5} "aaaaa" |
667 ab\{2,}c "abbc", "abbbc", "abbbbc", etc. | |
668 ab\{,3}c "ac", "abc", "abbc" or "abbbc" | |
7 | 669 a[bc]\{3}d "abbbd", "abbcd", "acbcd", "acccd", etc. |
670 a\(bc\)\{1,2}d "abcd" or "abcbcd" | |
671 a[bc]\{-}[cd] "abc" in "abcd" | |
672 a[bc]*[cd] "abcd" in "abcd" | |
673 | |
674 The } may optionally be preceded with a backslash: \{n,m\}. | |
675 | |
676 */\@=* | |
677 \@= Matches the preceding atom with zero width. {not in Vi} | |
678 Like "(?=pattern)" in Perl. | |
679 Example matches ~ | |
680 foo\(bar\)\@= "foo" in "foobar" | |
681 foo\(bar\)\@=foo nothing | |
682 */zero-width* | |
683 When using "\@=" (or "^", "$", "\<", "\>") no characters are included | |
684 in the match. These items are only used to check if a match can be | |
685 made. This can be tricky, because a match with following items will | |
686 be done in the same position. The last example above will not match | |
687 "foobarfoo", because it tries match "foo" in the same position where | |
688 "bar" matched. | |
689 | |
690 Note that using "\&" works the same as using "\@=": "foo\&.." is the | |
691 same as "\(foo\)\@=..". But using "\&" is easier, you don't need the | |
692 braces. | |
693 | |
694 | |
695 */\@!* | |
696 \@! Matches with zero width if the preceding atom does NOT match at the | |
697 current position. |/zero-width| {not in Vi} | |
3513 | 698 Like "(?!pattern)" in Perl. |
7 | 699 Example matches ~ |
700 foo\(bar\)\@! any "foo" not followed by "bar" | |
3513 | 701 a.\{-}p\@! "a", "ap", "app", "appp", etc. not immediately |
2908 | 702 followed by a "p" |
7 | 703 if \(\(then\)\@!.\)*$ "if " not followed by "then" |
704 | |
705 Using "\@!" is tricky, because there are many places where a pattern | |
706 does not match. "a.*p\@!" will match from an "a" to the end of the | |
707 line, because ".*" can match all characters in the line and the "p" | |
708 doesn't match at the end of the line. "a.\{-}p\@!" will match any | |
3513 | 709 "a", "ap", "app", etc. that isn't followed by a "p", because the "." |
7 | 710 can match a "p" and "p\@!" doesn't match after that. |
711 | |
712 You can't use "\@!" to look for a non-match before the matching | |
713 position: "\(foo\)\@!bar" will match "bar" in "foobar", because at the | |
714 position where "bar" matches, "foo" does not match. To avoid matching | |
715 "foobar" you could use "\(foo\)\@!...bar", but that doesn't match a | |
237 | 716 bar at the start of a line. Use "\(foo\)\@<!bar". |
7 | 717 |
2788 | 718 Useful example: to find "foo" in a line that does not contain "bar": > |
719 /^\%(.*bar\)\@!.*\zsfoo | |
720 < This pattern first checks that there is not a single position in the | |
721 line where "bar" matches. If ".*bar" matches somewhere the \@! will | |
722 reject the pattern. When there is no match any "foo" will be found. | |
723 The "\zs" is to have the match start just before "foo". | |
724 | |
7 | 725 */\@<=* |
726 \@<= Matches with zero width if the preceding atom matches just before what | |
727 follows. |/zero-width| {not in Vi} | |
3513 | 728 Like "(?<=pattern)" in Perl, but Vim allows non-fixed-width patterns. |
7 | 729 Example matches ~ |
730 \(an\_s\+\)\@<=file "file" after "an" and white space or an | |
731 end-of-line | |
732 For speed it's often much better to avoid this multi. Try using "\zs" | |
733 instead |/\zs|. To match the same as the above example: | |
734 an\_s\+\zsfile | |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
735 At least set a limit for the look-behind, see below. |
7 | 736 |
737 "\@<=" and "\@<!" check for matches just before what follows. | |
738 Theoretically these matches could start anywhere before this position. | |
739 But to limit the time needed, only the line where what follows matches | |
740 is searched, and one line before that (if there is one). This should | |
741 be sufficient to match most things and not be too slow. | |
6153 | 742 |
743 In the old regexp engine the part of the pattern after "\@<=" and | |
744 "\@<!" are checked for a match first, thus things like "\1" don't work | |
745 to reference \(\) inside the preceding atom. It does work the other | |
746 way around: | |
747 Bad example matches ~ | |
748 \%#=1\1\@<=,\([a-z]\+\) ",abc" in "abc,abc" | |
749 | |
750 However, the new regexp engine works differently, it is better to not | |
751 rely on this behavior, do not use \@<= if it can be avoided: | |
752 Example matches ~ | |
753 \([a-z]\+\)\zs,\1 ",abc" in "abc,abc" | |
7 | 754 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
755 \@123<= |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
756 Like "\@<=" but only look back 123 bytes. This avoids trying lots |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
757 of matches that are known to fail and make executing the pattern very |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
758 slow. Example, check if there is a "<" just before "span": |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
759 /<\@1<=span |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
760 This will try matching "<" only one byte before "span", which is the |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
761 only place that works anyway. |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
762 After crossing a line boundary, the limit is relative to the end of |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
763 the line. Thus the characters at the start of the line with the match |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
764 are not counted (this is just to keep it simple). |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
765 The number zero is the same as no limit. |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
766 |
7 | 767 */\@<!* |
768 \@<! Matches with zero width if the preceding atom does NOT match just | |
769 before what follows. Thus this matches if there is no position in the | |
770 current or previous line where the atom matches such that it ends just | |
771 before what follows. |/zero-width| {not in Vi} | |
3513 | 772 Like "(?<!pattern)" in Perl, but Vim allows non-fixed-width patterns. |
7 | 773 The match with the preceding atom is made to end just before the match |
774 with what follows, thus an atom that ends in ".*" will work. | |
775 Warning: This can be slow (because many positions need to be checked | |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
776 for a match). Use a limit if you can, see below. |
7 | 777 Example matches ~ |
778 \(foo\)\@<!bar any "bar" that's not in "foobar" | |
1620 | 779 \(\/\/.*\)\@<!in "in" which is not after "//" |
7 | 780 |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
781 \@123<! |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
782 Like "\@<!" but only look back 123 bytes. This avoids trying lots of |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
783 matches that are known to fail and make executing the pattern very |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
784 slow. |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
785 |
7 | 786 */\@>* |
787 \@> Matches the preceding atom like matching a whole pattern. {not in Vi} | |
1620 | 788 Like "(?>pattern)" in Perl. |
7 | 789 Example matches ~ |
790 \(a*\)\@>a nothing (the "a*" takes all the "a"'s, there can't be | |
791 another one following) | |
792 | |
793 This matches the preceding atom as if it was a pattern by itself. If | |
794 it doesn't match, there is no retry with shorter sub-matches or | |
795 anything. Observe this difference: "a*b" and "a*ab" both match | |
796 "aaab", but in the second case the "a*" matches only the first two | |
797 "a"s. "\(a*\)\@>ab" will not match "aaab", because the "a*" matches | |
798 the "aaa" (as many "a"s as possible), thus the "ab" can't match. | |
799 | |
800 | |
801 ============================================================================== | |
802 6. Ordinary atoms *pattern-atoms* | |
803 | |
804 An ordinary atom can be: | |
805 | |
806 */^* | |
807 ^ At beginning of pattern or after "\|", "\(", "\%(" or "\n": matches | |
808 start-of-line; at other positions, matches literal '^'. |/zero-width| | |
809 Example matches ~ | |
810 ^beep( the start of the C function "beep" (probably). | |
811 | |
812 */\^* | |
813 \^ Matches literal '^'. Can be used at any position in the pattern. | |
814 | |
815 */\_^* | |
816 \_^ Matches start-of-line. |/zero-width| Can be used at any position in | |
817 the pattern. | |
818 Example matches ~ | |
819 \_s*\_^foo white space and blank lines and then "foo" at | |
820 start-of-line | |
821 | |
822 */$* | |
1620 | 823 $ At end of pattern or in front of "\|", "\)" or "\n" ('magic' on): |
7 | 824 matches end-of-line <EOL>; at other positions, matches literal '$'. |
825 |/zero-width| | |
826 | |
827 */\$* | |
828 \$ Matches literal '$'. Can be used at any position in the pattern. | |
829 | |
830 */\_$* | |
831 \_$ Matches end-of-line. |/zero-width| Can be used at any position in the | |
832 pattern. Note that "a\_$b" never matches, since "b" cannot match an | |
833 end-of-line. Use "a\nb" instead |/\n|. | |
834 Example matches ~ | |
835 foo\_$\_s* "foo" at end-of-line and following white space and | |
836 blank lines | |
837 | |
838 . (with 'nomagic': \.) */.* */\.* | |
839 Matches any single character, but not an end-of-line. | |
840 | |
841 */\_.* | |
842 \_. Matches any single character or end-of-line. | |
843 Careful: "\_.*" matches all text to the end of the buffer! | |
844 | |
845 */\<* | |
846 \< Matches the beginning of a word: The next char is the first char of a | |
847 word. The 'iskeyword' option specifies what is a word character. | |
848 |/zero-width| | |
849 | |
850 */\>* | |
851 \> Matches the end of a word: The previous char is the last char of a | |
237 | 852 word. The 'iskeyword' option specifies what is a word character. |
7 | 853 |/zero-width| |
854 | |
855 */\zs* | |
856 \zs Matches at any position, and sets the start of the match there: The | |
857 next char is the first char of the whole match. |/zero-width| | |
858 Example: > | |
859 /^\s*\zsif | |
860 < matches an "if" at the start of a line, ignoring white space. | |
861 Can be used multiple times, the last one encountered in a matching | |
237 | 862 branch is used. Example: > |
7 | 863 /\(.\{-}\zsFab\)\{3} |
864 < Finds the third occurrence of "Fab". | |
6180 | 865 This cannot be followed by a multi. *E888* |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
866 {not in Vi} {not available when compiled without the |+syntax| feature} |
7 | 867 */\ze* |
868 \ze Matches at any position, and sets the end of the match there: The | |
869 previous char is the last char of the whole match. |/zero-width| | |
870 Can be used multiple times, the last one encountered in a matching | |
871 branch is used. | |
872 Example: "end\ze\(if\|for\)" matches the "end" in "endif" and | |
873 "endfor". | |
6213 | 874 This cannot be followed by a multi. |E888| |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
875 {not in Vi} {not available when compiled without the |+syntax| feature} |
7 | 876 |
877 */\%^* *start-of-file* | |
878 \%^ Matches start of the file. When matching with a string, matches the | |
879 start of the string. {not in Vi} | |
880 For example, to find the first "VIM" in a file: > | |
881 /\%^\_.\{-}\zsVIM | |
882 < | |
883 */\%$* *end-of-file* | |
884 \%$ Matches end of the file. When matching with a string, matches the | |
885 end of the string. {not in Vi} | |
886 Note that this does NOT find the last "VIM" in a file: > | |
887 /VIM\_.\{-}\%$ | |
888 < It will find the next VIM, because the part after it will always | |
889 match. This one will find the last "VIM" in the file: > | |
890 /VIM\ze\(\(VIM\)\@!\_.\)*\%$ | |
891 < This uses |/\@!| to ascertain that "VIM" does NOT match in any | |
892 position after the first "VIM". | |
893 Searching from the end of the file backwards is easier! | |
894 | |
640 | 895 */\%V* |
896 \%V Match inside the Visual area. When Visual mode has already been | |
897 stopped match in the area that |gv| would reselect. | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
898 This is a |/zero-width| match. To make sure the whole pattern is |
11062 | 899 inside the Visual area put it at the start and just before the end of |
900 the pattern, e.g.: > | |
901 /\%Vfoo.*ba\%Vr | |
11160 | 902 < This also works if only "foo bar" was Visually selected. This: > |
903 /\%Vfoo.*bar\%V | |
11062 | 904 < would match "foo bar" if the Visual selection continues after the "r". |
905 Only works for the current buffer. | |
640 | 906 |
7 | 907 */\%#* *cursor-position* |
908 \%# Matches with the cursor position. Only works when matching in a | |
909 buffer displayed in a window. {not in Vi} | |
910 WARNING: When the cursor is moved after the pattern was used, the | |
911 result becomes invalid. Vim doesn't automatically update the matches. | |
912 This is especially relevant for syntax highlighting and 'hlsearch'. | |
913 In other words: When the cursor moves the display isn't updated for | |
914 this change. An update is done for lines which are changed (the whole | |
915 line is updated) or when using the |CTRL-L| command (the whole screen | |
916 is updated). Example, to highlight the word under the cursor: > | |
917 /\k*\%#\k* | |
918 < When 'hlsearch' is set and you move the cursor around and make changes | |
919 this will clearly show when the match is updated or not. | |
920 | |
640 | 921 */\%'m* */\%<'m* */\%>'m* |
922 \%'m Matches with the position of mark m. | |
923 \%<'m Matches before the position of mark m. | |
924 \%>'m Matches after the position of mark m. | |
925 Example, to highlight the text from mark 's to 'e: > | |
926 /.\%>'s.*\%<'e.. | |
927 < Note that two dots are required to include mark 'e in the match. That | |
928 is because "\%<'e" matches at the character before the 'e mark, and | |
929 since it's a |/zero-width| match it doesn't include that character. | |
930 {not in Vi} | |
931 WARNING: When the mark is moved after the pattern was used, the result | |
932 becomes invalid. Vim doesn't automatically update the matches. | |
651 | 933 Similar to moving the cursor for "\%#" |/\%#|. |
640 | 934 |
13231 | 935 */\%l* */\%>l* */\%<l* *E951* |
7 | 936 \%23l Matches in a specific line. |
625 | 937 \%<23l Matches above a specific line (lower line number). |
938 \%>23l Matches below a specific line (higher line number). | |
7 | 939 These three can be used to match specific lines in a buffer. The "23" |
940 can be any line number. The first line is 1. {not in Vi} | |
941 WARNING: When inserting or deleting lines Vim does not automatically | |
942 update the matches. This means Syntax highlighting quickly becomes | |
943 wrong. | |
944 Example, to highlight the line where the cursor currently is: > | |
945 :exe '/\%' . line(".") . 'l.*' | |
946 < When 'hlsearch' is set and you move the cursor around and make changes | |
947 this will clearly show when the match is updated or not. | |
948 | |
949 */\%c* */\%>c* */\%<c* | |
950 \%23c Matches in a specific column. | |
951 \%<23c Matches before a specific column. | |
952 \%>23c Matches after a specific column. | |
953 These three can be used to match specific columns in a buffer or | |
954 string. The "23" can be any column number. The first column is 1. | |
955 Actually, the column is the byte number (thus it's not exactly right | |
956 for multi-byte characters). {not in Vi} | |
957 WARNING: When inserting or deleting text Vim does not automatically | |
958 update the matches. This means Syntax highlighting quickly becomes | |
959 wrong. | |
960 Example, to highlight the column where the cursor currently is: > | |
961 :exe '/\%' . col(".") . 'c' | |
962 < When 'hlsearch' is set and you move the cursor around and make changes | |
963 this will clearly show when the match is updated or not. | |
964 Example for matching a single byte in column 44: > | |
965 /\%>43c.\%<46c | |
966 < Note that "\%<46c" matches in column 45 when the "." matches a byte in | |
967 column 44. | |
968 */\%v* */\%>v* */\%<v* | |
969 \%23v Matches in a specific virtual column. | |
970 \%<23v Matches before a specific virtual column. | |
971 \%>23v Matches after a specific virtual column. | |
972 These three can be used to match specific virtual columns in a buffer | |
973 or string. When not matching with a buffer in a window, the option | |
974 values of the current window are used (e.g., 'tabstop'). | |
975 The "23" can be any column number. The first column is 1. | |
976 Note that some virtual column positions will never match, because they | |
1270 | 977 are halfway through a tab or other character that occupies more than |
978 one screen character. {not in Vi} | |
7 | 979 WARNING: When inserting or deleting text Vim does not automatically |
283 | 980 update highlighted matches. This means Syntax highlighting quickly |
981 becomes wrong. | |
1620 | 982 Example, to highlight all the characters after virtual column 72: > |
7 | 983 /\%>72v.* |
984 < When 'hlsearch' is set and you move the cursor around and make changes | |
985 this will clearly show when the match is updated or not. | |
986 To match the text up to column 17: > | |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
987 /^.*\%17v |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
988 < Column 17 is not included, because this is a |/zero-width| match. To |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
989 include the column use: > |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
990 /^.*\%17v. |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
991 < This command does the same thing, but also matches when there is no |
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1702
diff
changeset
|
992 character in column 17: > |
9286
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
993 /^.*\%<18v. |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
994 < Note that without the "^" to anchor the match in the first column, |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
995 this will also highlight column 17: > |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
996 /.*\%17v |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
997 < Column 17 is highlighted by 'hlsearch' because there is another match |
64035abb986b
commit https://github.com/vim/vim/commit/c95a302a4c42ec8230473cd4a5e0064d0a143aa8
Christian Brabandt <cb@256bit.org>
parents:
9041
diff
changeset
|
998 where ".*" matches zero characters. |
7 | 999 < |
1000 | |
1001 Character classes: {not in Vi} | |
1002 \i identifier character (see 'isident' option) */\i* | |
1003 \I like "\i", but excluding digits */\I* | |
1004 \k keyword character (see 'iskeyword' option) */\k* | |
1005 \K like "\k", but excluding digits */\K* | |
1006 \f file name character (see 'isfname' option) */\f* | |
1007 \F like "\f", but excluding digits */\F* | |
1008 \p printable character (see 'isprint' option) */\p* | |
1009 \P like "\p", but excluding digits */\P* | |
1010 | |
1011 NOTE: the above also work for multi-byte characters. The ones below only | |
1012 match ASCII characters, as indicated by the range. | |
1013 | |
1014 *whitespace* *white-space* | |
1015 \s whitespace character: <Space> and <Tab> */\s* | |
1016 \S non-whitespace character; opposite of \s */\S* | |
1017 \d digit: [0-9] */\d* | |
1018 \D non-digit: [^0-9] */\D* | |
1019 \x hex digit: [0-9A-Fa-f] */\x* | |
1020 \X non-hex digit: [^0-9A-Fa-f] */\X* | |
1021 \o octal digit: [0-7] */\o* | |
1022 \O non-octal digit: [^0-7] */\O* | |
1023 \w word character: [0-9A-Za-z_] */\w* | |
1024 \W non-word character: [^0-9A-Za-z_] */\W* | |
1025 \h head of word character: [A-Za-z_] */\h* | |
1026 \H non-head of word character: [^A-Za-z_] */\H* | |
1027 \a alphabetic character: [A-Za-z] */\a* | |
1028 \A non-alphabetic character: [^A-Za-z] */\A* | |
1029 \l lowercase character: [a-z] */\l* | |
1030 \L non-lowercase character: [^a-z] */\L* | |
1031 \u uppercase character: [A-Z] */\u* | |
3224 | 1032 \U non-uppercase character: [^A-Z] */\U* |
7 | 1033 |
1034 NOTE: Using the atom is faster than the [] form. | |
1035 | |
1036 NOTE: 'ignorecase', "\c" and "\C" are not used by character classes. | |
1037 | |
1038 */\_* *E63* */\_i* */\_I* */\_k* */\_K* */\_f* */\_F* | |
1039 */\_p* */\_P* */\_s* */\_S* */\_d* */\_D* */\_x* */\_X* | |
1040 */\_o* */\_O* */\_w* */\_W* */\_h* */\_H* */\_a* */\_A* | |
1041 */\_l* */\_L* */\_u* */\_U* | |
1042 \_x Where "x" is any of the characters above: The character class with | |
1043 end-of-line added | |
1044 (end of character classes) | |
1045 | |
1046 \e matches <Esc> */\e* | |
1047 \t matches <Tab> */\t* | |
1048 \r matches <CR> */\r* | |
1049 \b matches <BS> */\b* | |
1050 \n matches an end-of-line */\n* | |
1051 When matching in a string instead of buffer text a literal newline | |
1052 character is matched. | |
1053 | |
1054 ~ matches the last given substitute string */~* */\~* | |
1055 | |
1056 \(\) A pattern enclosed by escaped parentheses. */\(* */\(\)* */\)* | |
4444 | 1057 E.g., "\(^a\)" matches 'a' at the start of a line. |
1058 *E51* *E54* *E55* *E872* *E873* | |
7 | 1059 |
1060 \1 Matches the same string that was matched by */\1* *E65* | |
1061 the first sub-expression in \( and \). {not in Vi} | |
1062 Example: "\([a-z]\).\1" matches "ata", "ehe", "tot", etc. | |
1063 \2 Like "\1", but uses second sub-expression, */\2* | |
1064 ... */\3* | |
1065 \9 Like "\1", but uses ninth sub-expression. */\9* | |
1066 Note: The numbering of groups is done based on which "\(" comes first | |
1067 in the pattern (going left to right), NOT based on what is matched | |
1068 first. | |
1069 | |
1070 \%(\) A pattern enclosed by escaped parentheses. */\%(\)* */\%(* *E53* | |
1071 Just like \(\), but without counting it as a sub-expression. This | |
1072 allows using more groups and it's a little bit faster. | |
1073 {not in Vi} | |
1074 | |
1075 x A single character, with no special meaning, matches itself | |
1076 | |
1077 */\* */\\* | |
1078 \x A backslash followed by a single character, with no special meaning, | |
1079 is reserved for future expansions | |
1080 | |
1081 [] (with 'nomagic': \[]) */[]* */\[]* */\_[]* */collection* | |
1082 \_[] | |
237 | 1083 A collection. This is a sequence of characters enclosed in brackets. |
7 | 1084 It matches any single character in the collection. |
1085 Example matches ~ | |
1086 [xyz] any 'x', 'y' or 'z' | |
1087 [a-zA-Z]$ any alphabetic character at the end of a line | |
1088 \c[a-z]$ same | |
4073 | 1089 [А-яЁё] Russian alphabet (with utf-8 and cp1251) |
1090 | |
1125 | 1091 */[\n]* |
7 | 1092 With "\_" prepended the collection also includes the end-of-line. |
1093 The same can be done by including "\n" in the collection. The | |
1094 end-of-line is also matched when the collection starts with "^"! Thus | |
1095 "\_[^ab]" matches the end-of-line and any character but "a" and "b". | |
1096 This makes it Vi compatible: Without the "\_" or "\n" the collection | |
1097 does not match an end-of-line. | |
484 | 1098 *E769* |
481 | 1099 When the ']' is not there Vim will not give an error message but |
484 | 1100 assume no collection is used. Useful to search for '['. However, you |
6697 | 1101 do get E769 for internal searching. And be aware that in a |
1102 `:substitute` command the whole command becomes the pattern. E.g. | |
1103 ":s/[/x/" searches for "[/x" and replaces it with nothing. It does | |
1104 not search for "[" and replaces it with "x"! | |
481 | 1105 |
11518 | 1106 *E944* *E945* |
7 | 1107 If the sequence begins with "^", it matches any single character NOT |
1108 in the collection: "[^xyz]" matches anything but 'x', 'y' and 'z'. | |
1109 - If two characters in the sequence are separated by '-', this is | |
1110 shorthand for the full list of ASCII characters between them. E.g., | |
11518 | 1111 "[0-9]" matches any decimal digit. If the starting character exceeds |
1112 the ending character, e.g. [c-a], E944 occurs. Non-ASCII characters | |
1113 can be used, but the character values must not be more than 256 apart | |
1114 in the old regexp engine. For example, searching by [\u3000-\u4000] | |
1115 after setting re=1 emits a E945 error. Prepending \%#=2 will fix it. | |
7 | 1116 - A character class expression is evaluated to the set of characters |
1117 belonging to that character class. The following character classes | |
1118 are supported: | |
11267
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1119 Name Func Contents ~ |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1120 *[:alnum:]* [:alnum:] isalnum ASCII letters and digits |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1121 *[:alpha:]* [:alpha:] isalpha ASCII letters |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1122 *[:blank:]* [:blank:] space and tab |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1123 *[:cntrl:]* [:cntrl:] iscntrl ASCII control characters |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1124 *[:digit:]* [:digit:] decimal digits '0' to '9' |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1125 *[:graph:]* [:graph:] isgraph ASCII printable characters excluding |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1126 space |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1127 *[:lower:]* [:lower:] (1) lowercase letters (all letters when |
7 | 1128 'ignorecase' is used) |
11267
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1129 *[:print:]* [:print:] (2) printable characters including space |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1130 *[:punct:]* [:punct:] ispunct ASCII punctuation characters |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1131 *[:space:]* [:space:] whitespace characters: space, tab, CR, |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1132 NL, vertical tab, form feed |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1133 *[:upper:]* [:upper:] (3) uppercase letters (all letters when |
7 | 1134 'ignorecase' is used) |
11267
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1135 *[:xdigit:]* [:xdigit:] hexadecimal digits: 0-9, a-f, A-F |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1136 *[:return:]* [:return:] the <CR> character |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1137 *[:tab:]* [:tab:] the <Tab> character |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1138 *[:escape:]* [:escape:] the <Esc> character |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1139 *[:backspace:]* [:backspace:] the <BS> character |
15709
2e2f07561f4b
patch 8.1.0862: no verbose version of character classes
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
1140 *[:ident:]* [:ident:] identifier character (same as "\i") |
2e2f07561f4b
patch 8.1.0862: no verbose version of character classes
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
1141 *[:keyword:]* [:keyword:] keyword character (same as "\k") |
2e2f07561f4b
patch 8.1.0862: no verbose version of character classes
Bram Moolenaar <Bram@vim.org>
parents:
15281
diff
changeset
|
1142 *[:fname:]* [:fname:] file name character (same as "\f") |
7 | 1143 The brackets in character class expressions are additional to the |
1144 brackets delimiting a collection. For example, the following is a | |
1145 plausible pattern for a UNIX filename: "[-./[:alnum:]_~]\+" That is, | |
1146 a list of at least one character, each of which is either '-', '.', | |
1147 '/', alphabetic, numeric, '_' or '~'. | |
7477
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1148 These items only work for 8-bit characters, except [:lower:] and |
05cf4cc72a9f
commit https://github.com/vim/vim/commit/fa7353428f705f7a13465a1943dddeede4083023
Christian Brabandt <cb@256bit.org>
parents:
7384
diff
changeset
|
1149 [:upper:] also work for multi-byte characters when using the new |
8876
47f17f66da3d
commit https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf
Christian Brabandt <cb@256bit.org>
parents:
7477
diff
changeset
|
1150 regexp engine. See |two-engines|. In the future these items may |
9041
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1151 work for multi-byte characters. For now, to get all "alpha" |
34c45ee4210d
commit https://github.com/vim/vim/commit/06481427005a9dae39721087df94855f7d4d1feb
Christian Brabandt <cb@256bit.org>
parents:
8951
diff
changeset
|
1152 characters you can use: [[:lower:][:upper:]]. |
11267
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1153 |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1154 The "Func" column shows what library function is used. The |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1155 implementation depends on the system. Otherwise: |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1156 (1) Uses islower() for ASCII and Vim builtin rules for other |
15878 | 1157 characters. |
11267
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1158 (2) Uses Vim builtin rules |
588de97b40e7
patch 8.0.0519: character classes are not well tested
Christian Brabandt <cb@256bit.org>
parents:
11160
diff
changeset
|
1159 (3) As with (1) but using isupper() |
168 | 1160 */[[=* *[==]* |
1161 - An equivalence class. This means that characters are matched that | |
2974 | 1162 have almost the same meaning, e.g., when ignoring accents. This |
1163 only works for Unicode, latin1 and latin9. The form is: | |
856 | 1164 [=a=] |
168 | 1165 */[[.* *[..]* |
1166 - A collation element. This currently simply accepts a single | |
1167 character in the form: | |
856 | 1168 [.a.] |
7 | 1169 */\]* |
1170 - To include a literal ']', '^', '-' or '\' in the collection, put a | |
1171 backslash before it: "[xyz\]]", "[\^xyz]", "[xy\-z]" and "[xyz\\]". | |
1172 (Note: POSIX does not support the use of a backslash this way). For | |
1173 ']' you can also make it the first character (following a possible | |
1174 "^"): "[]xyz]" or "[^]xyz]" {not in Vi}. | |
1175 For '-' you can also make it the first or last character: "[-xyz]", | |
1176 "[^-xyz]" or "[xyz-]". For '\' you can also let it be followed by | |
2290
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1177 any character that's not in "^]-\bdertnoUux". "[\xyz]" matches '\', |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1178 'x', 'y' and 'z'. It's better to use "\\" though, future expansions |
22529abcd646
Fixed ":s" message. Docs updates.
Bram Moolenaar <bram@vim.org>
parents:
2154
diff
changeset
|
1179 may use other characters after '\'. |
4339 | 1180 - Omitting the trailing ] is not considered an error. "[]" works like |
1181 "[]]", it matches the ']' character. | |
7 | 1182 - The following translations are accepted when the 'l' flag is not |
1183 included in 'cpoptions' {not in Vi}: | |
1184 \e <Esc> | |
1185 \t <Tab> | |
1186 \r <CR> (NOT end-of-line!) | |
1187 \b <BS> | |
1125 | 1188 \n line break, see above |/[\n]| |
24 | 1189 \d123 decimal number of character |
1190 \o40 octal number of character up to 0377 | |
1191 \x20 hexadecimal number of character up to 0xff | |
1192 \u20AC hex. number of multibyte character up to 0xffff | |
1193 \U1234 hex. number of multibyte character up to 0xffffffff | |
7 | 1194 NOTE: The other backslash codes mentioned above do not work inside |
1195 []! | |
1196 - Matching with a collection can be slow, because each character in | |
1197 the text has to be compared with each character in the collection. | |
1198 Use one of the other atoms above when possible. Example: "\d" is | |
13482
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
1199 much faster than "[0-9]" and matches the same characters. However, |
9eebe457eb3c
Update runtime files. Convert a couple of help files to utf-8.
Christian Brabandt <cb@256bit.org>
parents:
13231
diff
changeset
|
1200 the new |NFA| regexp engine deals with this better than the old one. |
7 | 1201 |
1202 */\%[]* *E69* *E70* *E369* | |
24 | 1203 \%[] A sequence of optionally matched atoms. This always matches. |
7 | 1204 It matches as much of the list of atoms it contains as possible. Thus |
1205 it stops at the first atom that doesn't match. For example: > | |
1206 /r\%[ead] | |
1207 < matches "r", "re", "rea" or "read". The longest that matches is used. | |
1208 To match the Ex command "function", where "fu" is required and | |
1209 "nction" is optional, this would work: > | |
1210 /\<fu\%[nction]\> | |
1211 < The end-of-word atom "\>" is used to avoid matching "fu" in "full". | |
1212 It gets more complicated when the atoms are not ordinary characters. | |
1213 You don't often have to use it, but it is possible. Example: > | |
1214 /\<r\%[[eo]ad]\> | |
1215 < Matches the words "r", "re", "ro", "rea", "roa", "read" and "road". | |
1125 | 1216 There can be no \(\), \%(\) or \z(\) items inside the [] and \%[] does |
1217 not nest. | |
1620 | 1218 To include a "[" use "[[]" and for "]" use []]", e.g.,: > |
1219 /index\%[[[]0[]]] | |
1220 < matches "index" "index[", "index[0" and "index[0]". | |
2570
71b56b4e7785
Make the references to features in the help more consistent. (Sylvain Hitier)
Bram Moolenaar <bram@vim.org>
parents:
2561
diff
changeset
|
1221 {not available when compiled without the |+syntax| feature} |
7 | 1222 |
140 | 1223 */\%d* */\%x* */\%o* */\%u* */\%U* *E678* |
24 | 1224 |
1225 \%d123 Matches the character specified with a decimal number. Must be | |
1226 followed by a non-digit. | |
1227 \%o40 Matches the character specified with an octal number up to 0377. | |
1228 Numbers below 040 must be followed by a non-octal digit or a non-digit. | |
1229 \%x2a Matches the character specified with up to two hexadecimal characters. | |
1230 \%u20AC Matches the character specified with up to four hexadecimal | |
1231 characters. | |
1232 \%U1234abcd Matches the character specified with up to eight hexadecimal | |
15932 | 1233 characters, up to 0x7fffffff |
7 | 1234 |
1235 ============================================================================== | |
1236 7. Ignoring case in a pattern */ignorecase* | |
1237 | |
1238 If the 'ignorecase' option is on, the case of normal letters is ignored. | |
1239 'smartcase' can be set to ignore case when the pattern contains lowercase | |
1240 letters only. | |
1241 */\c* */\C* | |
1242 When "\c" appears anywhere in the pattern, the whole pattern is handled like | |
1243 'ignorecase' is on. The actual value of 'ignorecase' and 'smartcase' is | |
1244 ignored. "\C" does the opposite: Force matching case for the whole pattern. | |
1245 {only Vim supports \c and \C} | |
1246 Note that 'ignorecase', "\c" and "\C" are not used for the character classes. | |
1247 | |
1248 Examples: | |
1249 pattern 'ignorecase' 'smartcase' matches ~ | |
1250 foo off - foo | |
1251 foo on - foo Foo FOO | |
1252 Foo on off foo Foo FOO | |
1253 Foo on on Foo | |
1254 \cfoo - - foo Foo FOO | |
1255 foo\C - - foo | |
1256 | |
1257 Technical detail: *NL-used-for-Nul* | |
1258 <Nul> characters in the file are stored as <NL> in memory. In the display | |
1259 they are shown as "^@". The translation is done when reading and writing | |
1260 files. To match a <Nul> with a search pattern you can just enter CTRL-@ or | |
1261 "CTRL-V 000". This is probably just what you expect. Internally the | |
1262 character is replaced with a <NL> in the search pattern. What is unusual is | |
1263 that typing CTRL-V CTRL-J also inserts a <NL>, thus also searches for a <Nul> | |
1264 in the file. {Vi cannot handle <Nul> characters in the file at all} | |
1265 | |
1266 *CR-used-for-NL* | |
1267 When 'fileformat' is "mac", <NL> characters in the file are stored as <CR> | |
1698 | 1268 characters internally. In the text they are shown as "^J". Otherwise this |
7 | 1269 works similar to the usage of <NL> for a <Nul>. |
1270 | |
1271 When working with expression evaluation, a <NL> character in the pattern | |
1272 matches a <NL> in the string. The use of "\n" (backslash n) to match a <NL> | |
1273 doesn't work there, it only works to match text in the buffer. | |
1274 | |
1275 *pattern-multi-byte* | |
1276 Patterns will also work with multi-byte characters, mostly as you would | |
1277 expect. But invalid bytes may cause trouble, a pattern with an invalid byte | |
1278 will probably never match. | |
1279 | |
1280 ============================================================================== | |
714 | 1281 8. Composing characters *patterns-composing* |
1282 | |
1283 */\Z* | |
5901 | 1284 When "\Z" appears anywhere in the pattern, all composing characters are |
1285 ignored. Thus only the base characters need to match, the composing | |
1286 characters may be different and the number of composing characters may differ. | |
1287 Only relevant when 'encoding' is "utf-8". | |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1288 Exception: If the pattern starts with one or more composing characters, these |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1289 must match. |
5901 | 1290 */\%C* |
1291 Use "\%C" to skip any composing characters. For example, the pattern "a" does | |
1292 not match in "càt" (where the a has the composing character 0x0300), but | |
1293 "a\%C" does. Note that this does not match "cát" (where the á is character | |
1294 0xe1, it does not have a compositing character). It does match "cat" (where | |
1295 the a is just an a). | |
714 | 1296 |
1297 When a composing character appears at the start of the pattern of after an | |
1298 item that doesn't include the composing character, a match is found at any | |
1299 character that includes this composing character. | |
1300 | |
1301 When using a dot and a composing character, this works the same as the | |
1302 composing character by itself, except that it doesn't matter what comes before | |
1303 this. | |
1304 | |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1305 The order of composing characters does not matter. Also, the text may have |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1306 more composing characters than the pattern, it still matches. But all |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1307 composing characters in the pattern must be found in the text. |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1308 |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1309 Suppose B is a base character and x and y are composing characters: |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1310 pattern text match ~ |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1311 Bxy Bxy yes (perfect match) |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1312 Bxy Byx yes (order ignored) |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1313 Bxy By no (x missing) |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1314 Bxy Bx no (y missing) |
4780 | 1315 Bx Bx yes (perfect match) |
4681
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1316 Bx By no (x missing) |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1317 Bx Bxy yes (extra y ignored) |
2eb30f341e8d
Updated runtime files and translations.
Bram Moolenaar <bram@vim.org>
parents:
4444
diff
changeset
|
1318 Bx Byx yes (extra y ignored) |
714 | 1319 |
1320 ============================================================================== | |
1321 9. Compare with Perl patterns *perl-patterns* | |
7 | 1322 |
1323 Vim's regexes are most similar to Perl's, in terms of what you can do. The | |
1324 difference between them is mostly just notation; here's a summary of where | |
1325 they differ: | |
1326 | |
1327 Capability in Vimspeak in Perlspeak ~ | |
1328 ---------------------------------------------------------------- | |
1329 force case insensitivity \c (?i) | |
1330 force case sensitivity \C (?-i) | |
714 | 1331 backref-less grouping \%(atom\) (?:atom) |
7 | 1332 conservative quantifiers \{-n,m} *?, +?, ??, {}? |
1333 0-width match atom\@= (?=atom) | |
1334 0-width non-match atom\@! (?!atom) | |
1335 0-width preceding match atom\@<= (?<=atom) | |
1336 0-width preceding non-match atom\@<! (?<!atom) | |
1337 match without retry atom\@> (?>atom) | |
1338 | |
1339 Vim and Perl handle newline characters inside a string a bit differently: | |
1340 | |
1341 In Perl, ^ and $ only match at the very beginning and end of the text, | |
1342 by default, but you can set the 'm' flag, which lets them match at | |
1343 embedded newlines as well. You can also set the 's' flag, which causes | |
1344 a . to match newlines as well. (Both these flags can be changed inside | |
1345 a pattern using the same syntax used for the i flag above, BTW.) | |
1346 | |
1347 On the other hand, Vim's ^ and $ always match at embedded newlines, and | |
1348 you get two separate atoms, \%^ and \%$, which only match at the very | |
1349 start and end of the text, respectively. Vim solves the second problem | |
1350 by giving you the \_ "modifier": put it in front of a . or a character | |
1351 class, and they will match newlines as well. | |
1352 | |
1353 Finally, these constructs are unique to Perl: | |
1354 - execution of arbitrary code in the regex: (?{perl code}) | |
1355 - conditional expressions: (?(condition)true-expr|false-expr) | |
1356 | |
1357 ...and these are unique to Vim: | |
1358 - changing the magic-ness of a pattern: \v \V \m \M | |
1359 (very useful for avoiding backslashitis) | |
1360 - sequence of optionally matching atoms: \%[atoms] | |
1361 - \& (which is to \| what "and" is to "or"; it forces several branches | |
1362 to match at one spot) | |
1363 - matching lines/columns by number: \%5l \%5c \%5v | |
714 | 1364 - setting the start and end of the match: \zs \ze |
7 | 1365 |
1366 ============================================================================== | |
714 | 1367 10. Highlighting matches *match-highlight* |
7 | 1368 |
1369 *:mat* *:match* | |
1370 :mat[ch] {group} /{pattern}/ | |
1371 Define a pattern to highlight in the current window. It will | |
1372 be highlighted with {group}. Example: > | |
1373 :highlight MyGroup ctermbg=green guibg=green | |
1374 :match MyGroup /TODO/ | |
1375 < Instead of // any character can be used to mark the start and | |
1376 end of the {pattern}. Watch out for using special characters, | |
1377 such as '"' and '|'. | |
699 | 1378 |
7 | 1379 {group} must exist at the moment this command is executed. |
699 | 1380 |
1381 The {group} highlighting still applies when a character is | |
1326 | 1382 to be highlighted for 'hlsearch', as the highlighting for |
1383 matches is given higher priority than that of 'hlsearch'. | |
1384 Syntax highlighting (see 'syntax') is also overruled by | |
1385 matches. | |
699 | 1386 |
7 | 1387 Note that highlighting the last used search pattern with |
1388 'hlsearch' is used in all windows, while the pattern defined | |
1389 with ":match" only exists in the current window. It is kept | |
1390 when switching to another buffer. | |
699 | 1391 |
1392 'ignorecase' does not apply, use |/\c| in the pattern to | |
1393 ignore case. Otherwise case is not ignored. | |
1394 | |
1620 | 1395 'redrawtime' defines the maximum time searched for pattern |
1396 matches. | |
1397 | |
1125 | 1398 When matching end-of-line and Vim redraws only part of the |
1399 display you may get unexpected results. That is because Vim | |
1400 looks for a match in the line where redrawing starts. | |
1401 | |
1620 | 1402 Also see |matcharg()| and |getmatches()|. The former returns |
1326 | 1403 the highlight group and pattern of a previous |:match| |
1404 command. The latter returns a list with highlight groups and | |
1405 patterns defined by both |matchadd()| and |:match|. | |
1406 | |
1407 Highlighting matches using |:match| are limited to three | |
5968 | 1408 matches (aside from |:match|, |:2match| and |:3match| are |
1326 | 1409 available). |matchadd()| does not have this limitation and in |
1410 addition makes it possible to prioritize matches. | |
819 | 1411 |
7 | 1412 Another example, which highlights all characters in virtual |
1413 column 72 and more: > | |
1414 :highlight rightMargin term=bold ctermfg=blue guifg=blue | |
1415 :match rightMargin /.\%>72v/ | |
1416 < To highlight all character that are in virtual column 7: > | |
1417 :highlight col8 ctermbg=grey guibg=grey | |
1418 :match col8 /\%<8v.\%>7v/ | |
1419 < Note the use of two items to also match a character that | |
1420 occupies more than one virtual column, such as a TAB. | |
1421 | |
1422 :mat[ch] | |
1423 :mat[ch] none | |
1424 Clear a previously defined match pattern. | |
1425 | |
699 | 1426 |
819 | 1427 :2mat[ch] {group} /{pattern}/ *:2match* |
699 | 1428 :2mat[ch] |
1429 :2mat[ch] none | |
819 | 1430 :3mat[ch] {group} /{pattern}/ *:3match* |
699 | 1431 :3mat[ch] |
1432 :3mat[ch] none | |
1433 Just like |:match| above, but set a separate match. Thus | |
1434 there can be three matches active at the same time. The match | |
1435 with the lowest number has priority if several match at the | |
1436 same position. | |
1437 The ":3match" command is used by the |matchparen| plugin. You | |
1438 are suggested to use ":match" for manual matching and | |
1439 ":2match" for another plugin. | |
1440 | |
1441 | |
14421 | 1442 vim:tw=78:ts=8:noet:ft=help:norl: |