Vim
vim, string matching- About
- Patterns are run with matchstrpos(), so ^ and $ anchor at the ends of the text and items that need a buffer have no meaning. The base column is magic, the default.
- Verified on
- Vim 9.2.1352
Offsets are counted in bytes. - Found in
- vim, gvim
its own documentation - Flags
iignore case- Modes
- This page describes magic. very magic rows show where another mode reads a pattern differently.
Character classes 18 of 26
| Syntax | Matches | Notes | Try |
|---|---|---|---|
. |
Any characterAny single character. Whether that includes a newline depends on the dialect and its flags. | Matches a newline. |
test |
[abc]not[^abc] |
One of a set of characters | test | |
[a-z] |
One of a range of characters | test | |
[\]] |
Backslash escape inside a setInside a bracket expression a backslash takes the special meaning from the next character. Where this is missing, a backslash there is a member like any other. | test | |
| n/a | Class escape inside a setA class escape such as the one for a digit, used as a member of a bracket expression. | not in Vim Tried: |
who has it |
| n/a | Negated class escape inside a setA negated class escape, such as the one for anything but a digit, used as a member of a bracket expression. | not in Vim Tried: |
who has it |
\d[[:digit:]]not\D |
Digit | ASCII digits only: |
test |
\w[[:alnum:]_]not\W |
Word characterA letter, a digit or an underscore. | ASCII only: |
test |
\_s[[:space:]]not\S |
Whitespace | Does not match the no-break space. Does not match a vertical tab. The negated form |
test |
\s |
Horizontal whitespaceA space or a tab, but not a line break. | test | |
| n/a | Vertical whitespaceA line break character of any kind. | not in Vim Tried: |
who has it |
| n/a | Any character except newlineNever matches a newline, whatever the flags. | not in Vim Tried: |
who has it |
| n/a | Any line break sequenceOne line break, with CR LF taken as a single unit. | not in Vim Tried: |
who has it |
\anot\A |
Alphabetic character (shorthand) | test | |
\lnot\L |
Lowercase letter (shorthand) | test | |
\unot\U |
Uppercase letter (shorthand) | test | |
\xnot\X |
Hexadecimal digit (shorthand) | test | |
| n/a | Class intersectionCharacters that are in both classes. | not in Vim Tried: |
who has it |
| n/a | Class subtractionCharacters in the first class that are not in the second. | not in Vim Tried: |
who has it |
\hnot\H |
Head-of-word character (shorthand)A letter or the underscore: what a word may start with. | test | |
\onot\O |
Octal digit (shorthand) | test | |
\i |
Identifier characterA character allowed in an identifier. In Vim the set comes from the 'isident' option. | The set comes from the
|
test |
\k |
Keyword characterA character allowed in a keyword. In Vim the set comes from the 'iskeyword' option. | The set comes from the
|
test |
\f |
File name characterA character allowed in a file name. In Vim the set comes from the 'isfname' option. | The set comes from the
|
test |
\p |
Printable characterA character that is displayed as itself. In Vim the set comes from the 'isprint' option. | The set comes from the
|
test |
| n/a | Any single byteOne code unit, even where that is part of a longer character, and even a newline. | not in Vim Tried: |
who has it |
Anchors 8 of 14
| Syntax | Matches | Notes | Try |
|---|---|---|---|
^ |
Start of the text or lineStart of the text. With a multiline flag, or always in some dialects, also the start of each line. | test | |
$ |
End of the text or line | Matches only at the very end, not before a final newline. |
test |
\%^very magic %^ |
Start of the textStart of the text only, whatever the flags. | test | |
\%$very magic %$ |
End of the textThe very end of the text, whatever the flags. | test | |
| n/a | End of the text, or before a final newline | not in Vim Tried: |
who has it |
| n/a | Word boundaryThe position between a word character and a non-word character or an end of the text. | not in Vim Tried: |
who has it |
| n/a | Not a word boundary | not in Vim Tried: |
who has it |
\<very magic < |
Start of a word | test | |
\>very magic > |
End of a word | test | |
| n/a | Where the previous match endedThe position where the last match stopped, or the start of the text for the first match. | not in Vim Tried: |
who has it |
\zs |
Reset the start of the matchEverything matched so far is required but left out of the reported match. | test | |
| n/a | Start of symbolBefore a run of word and symbol characters, such as an identifier with an underscore in it. | not in Vim Tried: |
who has it |
| n/a | End of symbol | not in Vim Tried: |
who has it |
\%# |
Cursor positionWhere the editor's cursor is in the buffer being searched. | Only works when matching in a buffer displayed in a window. doc Not run on an engine: taken from the documentation. |
Quantifiers 8 of 9
| Syntax | Matches | Notes | Try |
|---|---|---|---|
X\=X\?X\{0,1\}very magic X?X= |
Zero or one | test | |
X* |
Zero or more | test | |
X\+X\{1,\}very magic X+ |
One or more | test | |
X\{N}X\{N\}very magic X{N} |
Exactly N times | test | |
X\{N,}X\{N,\}very magic X{N,} |
N or more times | test | |
X\{,M}X\{0,M\}very magic X{,M}X{0,M} |
At most M times | test | |
X\{N,M}X\{N,M\}very magic X{N,M} |
Between N and M times | test | |
X\{-}very magic X{-} |
Lazy quantifierRepeat as few times as possible instead of as many as possible. | test | |
| n/a | Possessive quantifierRepeat as many times as possible and never give any of it back. | not in Vim Tried: |
who has it |
Groups and alternation 5 of 16
| Syntax | Matches | Notes | Try |
|---|---|---|---|
\(X\)very magic (X) |
Capture group | test | |
\%(X\)very magic %(X) |
Non-capturing group | test | |
| n/a | Named capture group | not in Vim Tried: |
who has it |
X\|Yvery magic X|Y |
Alternation | Takes the first alternative that matches, even when a later one is longer. |
test |
\Nvery magic \N |
Backreference by numberThe same text that capture group N matched. | test | |
| n/a | Backreference by name | not in Vim Tried: |
who has it |
| n/a | Backreference by relative positionThe group N groups back from here. | not in Vim Tried: |
who has it |
X\@>very magic X@> |
Atomic groupOnce the group has matched, the engine never tries a different way to match it. | test | |
| n/a | Branch reset groupEvery alternative numbers its capture groups from the same start. | not in Vim Tried: |
who has it |
| n/a | ConditionalMatch one pattern if a capture group took part, otherwise another. | not in Vim Tried: |
who has it |
| n/a | Recurse into the whole pattern | not in Vim Tried: |
who has it |
| n/a | Call a group as a subroutineMatch the pattern of capture group N again at this point, not the text it matched. | not in Vim Tried: |
who has it |
| n/a | Comment | not in Vim Tried: |
who has it |
| n/a | Explicitly numbered groupA capture group that is given its number, whatever its position. | not in Vim Tried: |
who has it |
| n/a | Call an earlier group by relative positionMatch the pattern of the Nth group before this point again. | not in Vim Tried: |
who has it |
| n/a | Call a later group by relative positionMatch the pattern of the Nth group after this point here as well. | not in Vim Tried: |
who has it |
Lookaround 4 of 4
Escape sequences 10 of 16
| Syntax | Matches | Notes | Try |
|---|---|---|---|
\. |
Escape a special characterTake the next character literally. | test | |
| n/a | Quote a run of textTake everything between the markers literally. | not in Vim Tried: |
who has it |
\t |
Tab | test | |
\n |
Newline | test | |
\r |
Carriage return | test | |
| n/a | Form feed | not in Vim Tried: |
who has it |
| n/a | Vertical tab | not in Vim Tried: |
who has it |
| n/a | Alert (bell) | not in Vim Tried: |
who has it |
\b[\b] |
Backspace | test | |
\e |
Escape character | test | |
| n/a | Control characterThe control character typed as Ctrl plus the letter. | not in Vim Tried: |
who has it |
\%oOOO[\oOOO]very magic %oOOO |
Character by octal code | test | |
\%xHH[\xHH]very magic %xHH |
Character by two-digit hex code | test | |
\%uHHHH\%UHHHHHHHH[\uHHHH][\UHHHHHHHH]very magic %uHHHH%UHHHHHHHH |
Character by Unicode code point | test | |
| n/a | Character by Unicode name | not in Vim Tried: |
who has it |
\%d0\%x00\%o0\%u0000 |
NUL characterThe character with code 0. | NUL exists only in buffer text (stored there as a newline character; a Vim string cannot contain it), and the manual documents typing the character with CTRL-V 000 without singling out code 0 for these escapes. doc Not run on an engine: taken from the documentation. |
Flags and modes 1 of 14
| Syntax | Matches | Notes | Try |
|---|---|---|---|
flag i\c |
Ignore case | test | |
| n/a | MultilineThe line anchors also match at the start and end of every line. | not in Vim Tried: |
who has it |
| n/a | Dot matches newline | not in Vim Tried: |
who has it |
| n/a | Free spacingWhitespace in the pattern is ignored, and a # starts a comment. | not in Vim Tried: |
who has it |
| n/a | Swap greedy and lazy | not in Vim Tried: |
who has it |
| n/a | Turn a mode on inside the patternApplies from this point to the end of the pattern or the enclosing group. | not in Vim Tried: |
who has it |
| n/a | Turn a mode on in the middle of the patternThe mode applies from where the flag stands, not to what comes before it. Some dialects accept an inline flag only at the very start of the pattern. | not in Vim Tried: |
who has it |
| n/a | Turn a mode on for one group | not in Vim Tried: |
who has it |
| n/a | Turn a mode off inside the pattern | not in Vim Tried: |
who has it |
| n/a | ASCII-only classesMakes the shorthand classes such as the digit class match ASCII characters only. | not in Vim Tried: |
who has it |
| n/a | Unicode classesMakes the shorthand classes such as the digit class match by Unicode property. | not in Vim Tried: |
who has it |
| n/a | No automatic capturePlain parentheses group without capturing; only named groups capture. | not in Vim Tried: |
who has it |
| n/a | Locale-dependent classesClasses and case folding follow the current locale. | not in Vim No locale mode. doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Native character set rulesPerl's rules from before 5.14: the pattern and the text decide between native and Unicode rules. | not in Vim doc Not run on an engine: taken from the documentation. |
who has it |
POSIX named classes 1 of 1
| Syntax | Matches | Notes | Try |
|---|---|---|---|
[[:NAME:]]not[^[:NAME:]]very magic [[:NAME:]]not[^[:NAME:]] |
POSIX named classA named set of characters, written inside a bracket expression. | 12 names: Not here: |
test |
POSIX collating symbols 2 of 2
| Syntax | Matches | Notes | Try |
|---|---|---|---|
[[=X=]] |
Equivalence classEvery character that collates the same as X in the current locale. | test | |
[[.NAME.]] |
Collating symbol by nameA single collating element, written by its POSIX name inside a bracket expression. | In a set, the members written after a collating symbol are ignored: put the symbol last. 52 names: Not here: |
test |
Unicode properties 0 of 4
| Syntax | Matches | Notes | Try |
|---|---|---|---|
| n/a | Unicode general category | not in Vim Tried: |
who has it |
| n/a | Unicode script | not in Vim Tried: |
who has it |
| n/a | Extended grapheme clusterOne character as a reader sees it: a base character with its combining marks. | not in Vim Tried: |
who has it |
| n/a | Unicode text boundaryA boundary as Unicode's segmentation rules define it, which is not the same as a boundary between word and non-word characters. | not in Vim Tried: |
who has it |
Syntax table classes 0 of 2
| Syntax | Matches | Notes | Try |
|---|---|---|---|
| n/a | Syntax classA character with the given role in the syntax table: whitespace, word, symbol, punctuation, a bracket. | not in Vim Tried: |
who has it |
| n/a | Character categoryA character in one of the editor's character categories, most of which are scripts. | not in Vim Tried: |
who has it |
Host language 8 of 15
| Syntax | Matches | Notes | Try |
|---|---|---|---|
'PATTERN'/PATTERN/"PATTERN" |
Pattern in source codeHow a pattern is written where it is used: a regex literal with its delimiters, or the kind of string the documentation recommends. | No regex literal: a pattern is a string in an expression or sits between delimiters in a command, and doc Not run on an engine: taken from the documentation. |
|
:s/PATTERN/REPLACEMENT/FLAGSTEXT =~? PATTERNTEXT =~# PATTERN:set ignorecase |
Flags outside the patternWhere flags such as case-insensitive go when they are not written inside the pattern. | Case is the only matching flag: doc Not run on an engine: taken from the documentation. |
|
| n/a | Compile once and reuseBuild a pattern object and keep it. | not in Vim Every command and function takes the pattern as a string; the function list has no compiled pattern object. doc Not run on an engine: taken from the documentation. |
who has it |
TEXT =~ PATTERNmatch(TEXT, PATTERN)matchstr(TEXT, PATTERN)/PATTERN |
Search a textTest whether the pattern matches anywhere in a text, or get the first match. | None of these anchors. doc Not run on an engine: taken from the documentation. |
|
matchstrlist([TEXT], PATTERN)matchbufline(bufnr(), PATTERN, 1, '$') |
Every matchGet all the matches that do not overlap. | Both return a list of dictionaries with doc Not run on an engine: taken from the documentation. |
|
:s/PATTERN/REPLACEMENT/:%s/PATTERN/REPLACEMENT/gsubstitute(TEXT, PATTERN, REPLACEMENT, '')substitute(TEXT, PATTERN, REPLACEMENT, 'g') |
Replace matches |
doc Not run on an engine: taken from the documentation. |
|
matchlist(TEXT, PATTERN)[NUM]submatch(NUM) |
Captured group, in codeRead what a group captured after a match. | partial By number only, groups 1 to 9; Vim patterns have no named groups. doc Not run on an engine: taken from the documentation. |
|
\NUM |
Captured group, in replacement text | partial By number only, doc Not run on an engine: taken from the documentation. |
|
&\0 |
Whole match, in replacement text | A literal ampersand is doc Not run on an engine: taken from the documentation. |
|
| n/a | Match once until resetA match operator that succeeds one time only, until it is reset. | not in Vim doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Keep the position after a failed matchIn a repeated search, a failed match does not send the next one back to the start. | not in Vim A string has no stored search position; doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Keep the matched text for laterAsk for the matched text, and the text around it, to be saved. | not in Vim There are no match variables to switch on. doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Interpolate and compile only onceA pattern literal with variables in it is built the first time and never again. | not in Vim Patterns are ordinary strings, so there is no interpolating literal and no such flag among the doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Code inside a patternHost-language code that runs when the match reaches it. | not in Vim The manual lists execution of code in the regexp as unique to Perl. A replacement that starts with doc Not run on an engine: taken from the documentation. |
who has it |
| n/a | Pattern computed during the matchCode inside the pattern whose result is matched as a pattern at that point. | not in Vim doc Not run on an engine: taken from the documentation. |
who has it |
Every row was run on the engine named above, except the rows marked doc: those describe something no regex engine can run by itself, such as the syntax of the host language, and are taken from the documentation they link to. For a row marked "not in Vim", the spelling other dialects use was tried and the line starting "Tried" says what it did here; that shows the spelling does not work, not that no other spelling exists.