mirror of
https://github.com/neovim/neovim.git
synced 2024-12-24 13:15:09 -07:00
9beb40a4db
Problem: The documentation flow (`gen_vimdoc.py`) has several issues: - it's not very versatile - depends on doxygen - doesn't work well with Lua code as it requires an awkward filter script to convert it into pseudo-C. - The intermediate XML files and filters makes it too much like a rube goldberg machine. Solution: Re-implement the flow using Lua, LPEG and treesitter. - `gen_vimdoc.py` is now replaced with `gen_vimdoc.lua` and replicates a portion of the logic. - `lua2dox.lua` is gone! - No more XML files. - Doxygen is now longer used and instead we now use: - LPEG for comment parsing (see `scripts/luacats_grammar.lua` and `scripts/cdoc_grammar.lua`). - LPEG for C parsing (see `scripts/cdoc_parser.lua`) - Lua patterns for Lua parsing (see `scripts/luacats_parser.lua`). - Treesitter for Markdown parsing (see `scripts/text_utils.lua`). - The generated `runtime/doc/*.mpack` files have been removed. - `scripts/gen_eval_files.lua` now instead uses `scripts/cdoc_parser.lua` directly. - Text wrapping is implemented in `scripts/text_utils.lua` and appears to produce more consistent results (the main contributer to the diff of this change).
35 lines
1.3 KiB
Lua
35 lines
1.3 KiB
Lua
--- @meta
|
|
|
|
-- luacheck: no unused args
|
|
|
|
--- @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
|