diff options
Diffstat (limited to 'runtime/lua/vim/_meta/lpeg.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/lpeg.lua | 103 |
1 files changed, 65 insertions, 38 deletions
diff --git a/runtime/lua/vim/_meta/lpeg.lua b/runtime/lua/vim/_meta/lpeg.lua index 42c9a6449e..1ce40f3340 100644 --- a/runtime/lua/vim/_meta/lpeg.lua +++ b/runtime/lua/vim/_meta/lpeg.lua @@ -1,11 +1,27 @@ --- @meta +error('Cannot require a meta file') --- These types were taken from https://github.com/LuaCATS/lpeg, with types being renamed to include --- the vim namespace and with some descriptions made less verbose. +-- These types were taken from https://github.com/LuaCATS/lpeg +-- (based on revision e6789e28e5b91a4a277a2a03081d708c403a3e34) +-- with types being renamed to include the vim namespace and with some descriptions made less verbose. + +--- @brief <pre>help +--- LPeg is a pattern-matching library for Lua, based on +--- Parsing Expression Grammars (https://bford.info/packrat/) (PEGs). +--- +--- *lua-lpeg* +--- *vim.lpeg.Pattern* +--- The LPeg library for parsing expression grammars is included as `vim.lpeg` +--- (https://www.inf.puc-rio.br/~roberto/lpeg/). +--- +--- In addition, its regex-like interface is available as |vim.re| +--- (https://www.inf.puc-rio.br/~roberto/lpeg/re.html). +--- +--- </pre> ---- *LPeg* is a new pattern-matching library for Lua, based on [Parsing Expression Grammars](https://bford.info/packrat/) (PEGs). vim.lpeg = {} +--- @nodoc --- @class vim.lpeg.Pattern --- @operator unm: vim.lpeg.Pattern --- @operator add(vim.lpeg.Pattern): vim.lpeg.Pattern @@ -32,11 +48,12 @@ local Pattern = {} --- matches anywhere. --- --- Example: +--- --- ```lua ---- local pattern = lpeg.R("az") ^ 1 * -1 ---- assert(pattern:match("hello") == 6) ---- assert(lpeg.match(pattern, "hello") == 6) ---- assert(pattern:match("1 hello") == nil) +--- local pattern = lpeg.R('az') ^ 1 * -1 +--- assert(pattern:match('hello') == 6) +--- assert(lpeg.match(pattern, 'hello') == 6) +--- assert(pattern:match('1 hello') == nil) --- ``` --- --- @param pattern vim.lpeg.Pattern @@ -55,11 +72,12 @@ function vim.lpeg.match(pattern, subject, init) end --- we must either write a loop in Lua or write a pattern that matches anywhere. --- --- Example: +--- --- ```lua ---- local pattern = lpeg.R("az") ^ 1 * -1 ---- assert(pattern:match("hello") == 6) ---- assert(lpeg.match(pattern, "hello") == 6) ---- assert(pattern:match("1 hello") == nil) +--- local pattern = lpeg.R('az') ^ 1 * -1 +--- assert(pattern:match('hello') == 6) +--- assert(lpeg.match(pattern, 'hello') == 6) +--- assert(pattern:match('1 hello') == nil) --- ``` --- --- @param subject string @@ -69,7 +87,8 @@ function Pattern:match(subject, init) end --- Returns the string `"pattern"` if the given value is a pattern, otherwise `nil`. --- ---- @return 'pattern'|nil +--- @param value vim.lpeg.Pattern|string|integer|boolean|table|function +--- @return "pattern"|nil function vim.lpeg.type(value) end --- Returns a string with the running version of LPeg. @@ -85,7 +104,7 @@ function vim.lpeg.version() end --- @param max integer function vim.lpeg.setmaxstack(max) end ---- Converts the given value into a proper pattern. This following rules are applied: +--- Converts the given value into a proper pattern. The following rules are applied: --- * If the argument is a pattern, it is returned unmodified. --- * If the argument is a string, it is translated to a pattern that matches the string literally. --- * If the argument is a non-negative number `n`, the result is a pattern that matches exactly `n` characters. @@ -95,7 +114,7 @@ function vim.lpeg.setmaxstack(max) end --- * If the argument is a boolean, the result is a pattern that always succeeds or always fails --- (according to the boolean value), without consuming any input. --- * If the argument is a table, it is interpreted as a grammar (see Grammars). ---- * If the argument is a function, returns a pattern equivalent to a match-time captureover the empty string. +--- * If the argument is a function, returns a pattern equivalent to a match-time capture over the empty string. --- --- @param value vim.lpeg.Pattern|string|integer|boolean|table|function --- @return vim.lpeg.Pattern @@ -103,7 +122,7 @@ function vim.lpeg.P(value) end --- Returns a pattern that matches only if the input string at the current position is preceded by `patt`. --- Pattern `patt` must match only strings with some fixed length, and it cannot contain captures. ---- Like the and predicate, this pattern never consumes any input, independently of success or failure. +--- Like the `and` predicate, this pattern never consumes any input, independently of success or failure. --- --- @param pattern vim.lpeg.Pattern --- @return vim.lpeg.Pattern @@ -111,13 +130,14 @@ function vim.lpeg.B(pattern) end --- Returns a pattern that matches any single character belonging to one of the given ranges. --- Each `range` is a string `xy` of length 2, representing all characters with code between the codes of ---- `x` and `y` (both inclusive). As an example, the pattern `lpeg.R("09")` matches any digit, and ---- `lpeg.R("az", "AZ")` matches any ASCII letter. +--- `x` and `y` (both inclusive). As an example, the pattern `lpeg.R('09')` matches any digit, and +--- `lpeg.R('az', 'AZ')` matches any ASCII letter. --- --- Example: +--- --- ```lua ---- local pattern = lpeg.R("az") ^ 1 * -1 ---- assert(pattern:match("hello") == 6) +--- local pattern = lpeg.R('az') ^ 1 * -1 +--- assert(pattern:match('hello') == 6) --- ``` --- --- @param ... string @@ -125,9 +145,9 @@ function vim.lpeg.B(pattern) end function vim.lpeg.R(...) end --- Returns a pattern that matches any single character that appears in the given string (the `S` stands for Set). ---- As an example, the pattern `lpeg.S("+-*/")` matches any arithmetic operator. Note that, if `s` is a character +--- As an example, the pattern `lpeg.S('+-*/')` matches any arithmetic operator. Note that, if `s` is a character --- (that is, a string of length 1), then `lpeg.P(s)` is equivalent to `lpeg.S(s)` which is equivalent to ---- `lpeg.R(s..s)`. Note also that both `lpeg.S("")` and `lpeg.R()` are patterns that always fail. +--- `lpeg.R(s..s)`. Note also that both `lpeg.S('')` and `lpeg.R()` are patterns that always fail. --- --- @param string string --- @return vim.lpeg.Pattern @@ -137,8 +157,9 @@ function vim.lpeg.S(string) end --- for a grammar. The created non-terminal refers to the rule indexed by `v` in the enclosing grammar. --- --- Example: +--- --- ```lua ---- local b = lpeg.P({"(" * ((1 - lpeg.S "()") + lpeg.V(1)) ^ 0 * ")"}) +--- local b = lpeg.P({'(' * ((1 - lpeg.S '()') + lpeg.V(1)) ^ 0 * ')'}) --- assert(b:match('((string))') == 11) --- assert(b:match('(') == nil) --- ``` @@ -147,6 +168,7 @@ function vim.lpeg.S(string) end --- @return vim.lpeg.Pattern function vim.lpeg.V(v) end +--- @nodoc --- @class vim.lpeg.Locale --- @field alnum userdata --- @field alpha userdata @@ -168,14 +190,15 @@ function vim.lpeg.V(v) end --- that table. --- --- Example: +--- --- ```lua --- lpeg.locale(lpeg) ---- local space = lpeg.space^0 ---- local name = lpeg.C(lpeg.alpha^1) * space ---- local sep = lpeg.S(",;") * space ---- local pair = lpeg.Cg(name * "=" * space * name) * sep^-1 ---- local list = lpeg.Cf(lpeg.Ct("") * pair^0, rawset) ---- local t = list:match("a=b, c = hi; next = pi") +--- local space = lpeg.space ^ 0 +--- local name = lpeg.C(lpeg.alpha ^ 1) * space +--- local sep = lpeg.S(',;') * space +--- local pair = lpeg.Cg(name * '=' * space * name) * sep ^ -1 +--- local list = lpeg.Cf(lpeg.Ct('') * pair ^ 0, rawset) +--- local t = list:match('a=b, c = hi; next = pi') --- assert(t.a == 'b') --- assert(t.c == 'hi') --- assert(t.next == 'pi') @@ -191,11 +214,12 @@ function vim.lpeg.locale(tab) end --- The captured value is a string. If `patt` has other captures, their values are returned after this one. --- --- Example: +--- --- ```lua --- local function split (s, sep) --- sep = lpeg.P(sep) ---- local elem = lpeg.C((1 - sep)^0) ---- local p = elem * (sep * elem)^0 +--- local elem = lpeg.C((1 - sep) ^ 0) +--- local p = elem * (sep * elem) ^ 0 --- return lpeg.match(p, s) --- end --- local a, b, c = split('a,b,c', ',') @@ -241,12 +265,13 @@ function vim.lpeg.Cc(...) end --- becomes the captured value. --- --- Example: +--- --- ```lua ---- local number = lpeg.R("09") ^ 1 / tonumber ---- local list = number * ("," * number) ^ 0 +--- local number = lpeg.R('09') ^ 1 / tonumber +--- local list = number * (',' * number) ^ 0 --- local function add(acc, newvalue) return acc + newvalue end --- local sum = lpeg.Cf(list, add) ---- assert(sum:match("10,30,43") == 83) +--- assert(sum:match('10,30,43') == 83) --- ``` --- --- @param patt vim.lpeg.Pattern @@ -267,10 +292,11 @@ function vim.lpeg.Cg(patt, name) end --- subject where the match occurs. The captured value is a number. --- --- Example: +--- --- ```lua --- local I = lpeg.Cp() --- local function anywhere(p) return lpeg.P({I * p * I + 1 * lpeg.V(1)}) end ---- local match_start, match_end = anywhere("world"):match("hello world!") +--- local match_start, match_end = anywhere('world'):match('hello world!') --- assert(match_start == 7) --- assert(match_end == 12) --- ``` @@ -285,10 +311,11 @@ function vim.lpeg.Cp() end --- value is the string resulting from all replacements. --- --- Example: +--- --- ```lua --- local function gsub (s, patt, repl) --- patt = lpeg.P(patt) ---- patt = lpeg.Cs((patt / repl + 1)^0) +--- patt = lpeg.Cs((patt / repl + 1) ^ 0) --- return lpeg.match(patt, s) --- end --- assert(gsub('Hello, xxx!', 'xxx', 'World') == 'Hello, World!') @@ -312,9 +339,9 @@ function vim.lpeg.Ct(patt) end --- and then calls `function`. The given function gets as arguments the entire subject, the current position --- (after the match of `patt`), plus any capture values produced by `patt`. The first value returned by `function` --- defines how the match happens. If the call returns a number, the match succeeds and the returned number ---- becomes the new current position. (Assuming a subject sand current position i, the returned number must be ---- in the range [i, len(s) + 1].) If the call returns true, the match succeeds without consuming any input ---- (so, to return true is equivalent to return i). If the call returns false, nil, or no value, the match fails. +--- becomes the new current position. (Assuming a subject sand current position `i`, the returned number must be +--- in the range `[i, len(s) + 1]`.) If the call returns `true`, the match succeeds without consuming any input +--- (so, to return true is equivalent to return `i`). If the call returns `false`, `nil`, or no value, the match fails. --- Any extra values returned by the function become the values produced by the capture. --- --- @param patt vim.lpeg.Pattern |