mirror of
https://github.com/neovim/neovim.git
synced 2025-11-04 01:34:25 +00:00
a6e74c1f0a
Co-authored-by: nuid64 <lvkuzvesov@proton.me> Co-authored-by: Mike Smith <10135646+mikesmithgh@users.noreply.github.com> Co-authored-by: XTY <xty@xty.io> Co-authored-by: Empa <emanuel@empa.xyz> Co-authored-by: kyu08 <49891479+kyu08@users.noreply.github.com>
37 lines
1.4 KiB
Lua
37 lines
1.4 KiB
Lua
--- @meta
|
|
|
|
-- luacheck: no unused args
|
|
|
|
--- @defgroup vim.regex
|
|
---
|
|
--- @brief Vim regexes can be used directly from Lua. Currently they only allow
|
|
--- matching within a single line.
|
|
|
|
--- Parse the Vim regex {re} and return a regex object. Regexes are "magic"
|
|
--- and case-sensitive by default, regardless of 'magic' and 'ignorecase'.
|
|
--- They can be controlled with flags, see |/magic| and |/ignorecase|.
|
|
--- @param re string
|
|
--- @return vim.regex
|
|
function vim.regex(re) end
|
|
|
|
--- @class vim.regex
|
|
local regex = {} -- luacheck: no unused
|
|
|
|
--- Match the string against the regex. If the string should match the regex
|
|
--- precisely, surround the regex with `^` and `$`. If there was a match, the
|
|
--- byte indices for the beginning and end of the match are returned. When
|
|
--- there is no match, `nil` is returned. Because any integer is "truthy",
|
|
--- `regex:match_str()` can be directly used as a condition in an if-statement.
|
|
--- @param str string
|
|
function regex:match_str(str) end
|
|
|
|
--- Match line {line_idx} (zero-based) in buffer {bufnr}. If {start} and {end}
|
|
--- are supplied, match only this byte index range. Otherwise see
|
|
--- |regex:match_str()|. If {start} is used, then the returned byte indices
|
|
--- will be relative {start}.
|
|
--- @param bufnr integer
|
|
--- @param line_idx integer
|
|
--- @param start? integer
|
|
--- @param end_? integer
|
|
function regex:match_line(bufnr, line_idx, start, end_) end
|