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