mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-07 03:48:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: added support for specifying types for lua2dox

Browse Source
This commit is contained in:
Folke Lemaitre
2022-09-28 13:22:08 +02:00
committed by Lewis Russell
parent 24a1c7f556
commit 1da7b4eb69
4 changed files with 78 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
runtime/doc/lsp.txt
View File

@@ -723,7 +723,7 @@ get_buffers_by_client_id({client_id})
• {client_id} (number) client id • {client_id} (number) client id
Return: ~ Return: ~
list of buffer ids (list) of buffer ids
get_client_by_id({client_id}) *vim.lsp.get_client_by_id()* get_client_by_id({client_id}) *vim.lsp.get_client_by_id()*
Gets a client by id, or nil if the id is invalid. The returned client may Gets a client by id, or nil if the id is invalid. The returned client may
@@ -1372,8 +1372,8 @@ apply_text_document_edit({text_document_edit}, {index}, {offset_encoding})
document. document.
Parameters: ~ Parameters: ~
• {text_document_edit} table: a `TextDocumentEdit` object • {text_document_edit} (table) a `TextDocumentEdit` object
• {index} number: Optional index of the edit, if from a • {index} (number) Optional index of the edit, if from a
list of edits (or nil, if not from a list) list of edits (or nil, if not from a list)
See also: ~ See also: ~
@@ -1463,7 +1463,7 @@ convert_signature_help_to_markdown_lines({signature_help}, {ft}, {triggers})
server. used to better determine parameter offsets server. used to better determine parameter offsets
Return: ~ Return: ~
list of lines of converted markdown. (list) of lines of converted markdown.
See also: ~ See also: ~
https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_signatureHelp https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_signatureHelp
@@ -1485,7 +1485,7 @@ get_effective_tabstop({bufnr}) *vim.lsp.util.get_effective_tabstop()*
Returns indentation size. Returns indentation size.
Parameters: ~ Parameters: ~
• {bufnr} (number|nil): Buffer handle, defaults to current • {bufnr} (number|nil) Buffer handle, defaults to current
Return: ~ Return: ~
(number) indentation size (number) indentation size
@@ -1589,7 +1589,7 @@ make_position_params({window}, {offset_encoding})
cursor position. cursor position.
Parameters: ~ Parameters: ~
• {window} number|nil: window handle or 0 for current, • {window} (number|nil) window handle or 0 for current,
defaults to current defaults to current
• {offset_encoding} (string) utf-8|utf-16|utf-32|nil defaults to • {offset_encoding} (string) utf-8|utf-16|utf-32|nil defaults to
`offset_encoding` of first client of buffer of `offset_encoding` of first client of buffer of
@@ -1609,7 +1609,7 @@ make_range_params({window}, {offset_encoding})
`textDocument/rangeFormatting`. `textDocument/rangeFormatting`.
Parameters: ~ Parameters: ~
• {window} number|nil: window handle or 0 for current, • {window} (number|nil) window handle or 0 for current,
defaults to current defaults to current
• {offset_encoding} "utf-8"|"utf-16"|"utf-32"|nil defaults to • {offset_encoding} "utf-8"|"utf-16"|"utf-32"|nil defaults to
`offset_encoding` of first client of buffer of `offset_encoding` of first client of buffer of
@@ -1624,7 +1624,7 @@ make_text_document_params({bufnr})
Creates a `TextDocumentIdentifier` object for the current buffer. Creates a `TextDocumentIdentifier` object for the current buffer.
Parameters: ~ Parameters: ~
• {bufnr} number|nil: Buffer handle, defaults to current • {bufnr} (number|nil) Buffer handle, defaults to current
Return: ~ Return: ~
`TextDocumentIdentifier` `TextDocumentIdentifier`
@@ -1854,7 +1854,7 @@ notify({method}, {params}) *vim.lsp.rpc.notify()*
Parameters: ~ Parameters: ~
• {method} (string) The invoked LSP method • {method} (string) The invoked LSP method
• {params} (table|nil): Parameters for the invoked LSP method • {params} (table|nil) Parameters for the invoked LSP method
Return: ~ Return: ~
(bool) `true` if notification could be sent, `false` if not (bool) `true` if notification could be sent, `false` if not

26
runtime/doc/lua.txt
View File

@@ -1482,7 +1482,7 @@ on_key({fn}, {ns_id}) *vim.on_key()*
{fn} will receive the keys after mappings have been evaluated {fn} will receive the keys after mappings have been evaluated
Parameters: ~ Parameters: ~
• {fn} function: Callback function. It should take one string • {fn} (function) Callback function. It should take one string
argument. On each key press, Nvim passes the key char to argument. On each key press, Nvim passes the key char to
fn(). |i_CTRL-V| If {fn} is nil, it removes the callback for fn(). |i_CTRL-V| If {fn} is nil, it removes the callback for
the associated {ns_id} the associated {ns_id}
@@ -1641,7 +1641,7 @@ gsplit({s}, {sep}, {plain}) *vim.gsplit()*
string.find) string.find)
Return: ~ Return: ~
fun():string Iterator over the split components (function) Iterator over the split components
See also: ~ See also: ~
|vim.split()| |vim.split()|
@@ -1665,8 +1665,8 @@ list_extend({dst}, {src}, {start}, {finish}) *vim.list_extend()*
Parameters: ~ Parameters: ~
• {dst} (table) List which will be modified and appended to • {dst} (table) List which will be modified and appended to
• {src} (table) List from which values will be inserted • {src} (table) List from which values will be inserted
• {start} (number) Start index on src. Defaults to 1 • {start} (number|nil) Start index on src. Defaults to 1
• {finish} (number) Final index on src. Defaults to `#src` • {finish} (number|nil) Final index on src. Defaults to `#src`
Return: ~ Return: ~
(table) dst (table) dst
@@ -1679,12 +1679,12 @@ list_slice({list}, {start}, {finish}) *vim.list_slice()*
(inclusive) (inclusive)
Parameters: ~ Parameters: ~
• {list} (table) Table • {list} (list) Table
• {start} (number) Start range of slice • {start} (number) Start range of slice
• {finish} (number) End range of slice • {finish} (number) End range of slice
Return: ~ Return: ~
any[] Copy of table sliced from start to finish (inclusive) (list) Copy of table sliced from start to finish (inclusive)
pesc({s}) *vim.pesc()* pesc({s}) *vim.pesc()*
Escapes magic chars in |lua-patterns|. Escapes magic chars in |lua-patterns|.
@@ -1717,7 +1717,7 @@ split({s}, {sep}, {kwargs}) *vim.split()*
Parameters: ~ Parameters: ~
• {s} (string) String to split • {s} (string) String to split
• {sep} (string) Separator or pattern • {sep} (string) Separator or pattern
• {kwargs} split_kwargs Keyword arguments: • {kwargs} (table|nil) Keyword arguments:
• plain: (boolean) If `true` use `sep` literally (passed to • plain: (boolean) If `true` use `sep` literally (passed to
string.find) string.find)
• trimempty: (boolean) If `true` remove empty items from the • trimempty: (boolean) If `true` remove empty items from the
@@ -1787,7 +1787,7 @@ tbl_deep_extend({behavior}, {...}) *vim.tbl_deep_extend()*
• {...} (table) Two or more map-like tables • {...} (table) Two or more map-like tables
Return: ~ Return: ~
table|table Merged table (table) Merged table
See also: ~ See also: ~
|vim.tbl_extend()| |vim.tbl_extend()|
@@ -1813,11 +1813,11 @@ tbl_filter({func}, {t}) *vim.tbl_filter()*
Filter a table using a predicate function Filter a table using a predicate function
Parameters: ~ Parameters: ~
• {func} function|table Function or callable table • {func} (function) Function
• {t} (table) Table • {t} (table) Table
Return: ~ Return: ~
any[] Table of filtered values (table) Table of filtered values
tbl_flatten({t}) *vim.tbl_flatten()* tbl_flatten({t}) *vim.tbl_flatten()*
Creates a copy of a list-like table such that any nested tables are Creates a copy of a list-like table such that any nested tables are
@@ -1883,7 +1883,7 @@ tbl_keys({t}) *vim.tbl_keys()*
• {t} (table) Table • {t} (table) Table
Return: ~ Return: ~
table[] List of keys (list) List of keys
See also: ~ See also: ~
From https://github.com/premake/premake-core/blob/master/src/base/table.lua From https://github.com/premake/premake-core/blob/master/src/base/table.lua
@@ -1892,7 +1892,7 @@ tbl_map({func}, {t}) *vim.tbl_map()*
Apply a function to all values of a table. Apply a function to all values of a table.
Parameters: ~ Parameters: ~
• {func} function|table Function or callable table • {func} (function) Function
• {t} (table) Table • {t} (table) Table
Return: ~ Return: ~
@@ -1906,7 +1906,7 @@ tbl_values({t}) *vim.tbl_values()*
• {t} (table) Table • {t} (table) Table
Return: ~ Return: ~
any[] List of values (list) List of values
trim({s}) *vim.trim()* trim({s}) *vim.trim()*
Trim whitespace (Lua pattern "%s") from both sides of a string. Trim whitespace (Lua pattern "%s") from both sides of a string.

30
runtime/lua/vim/shared.lua
View File

@@ -63,7 +63,7 @@ end)()
---@param s string String to split ---@param s string String to split
---@param sep string Separator or pattern ---@param sep string Separator or pattern
---@param plain boolean If `true` use `sep` literally (passed to string.find) ---@param plain boolean If `true` use `sep` literally (passed to string.find)
---@return fun():string Iterator over the split components ---@return fun():string (function) Iterator over the split components
function vim.gsplit(s, sep, plain) function vim.gsplit(s, sep, plain)
vim.validate({ s = { s, 's' }, sep = { sep, 's' }, plain = { plain, 'b', true } }) vim.validate({ s = { s, 's' }, sep = { sep, 's' }, plain = { plain, 'b', true } })
@@ -112,7 +112,7 @@ end
--- ---
---@param s string String to split ---@param s string String to split
---@param sep string Separator or pattern ---@param sep string Separator or pattern
---@param kwargs {plain: boolean, trimempty: boolean}|nil Keyword arguments: ---@param kwargs? {plain: boolean, trimempty: boolean} (table|nil) Keyword arguments:
--- - plain: (boolean) If `true` use `sep` literally (passed to string.find) --- - plain: (boolean) If `true` use `sep` literally (passed to string.find)
--- - trimempty: (boolean) If `true` remove empty items from the front --- - trimempty: (boolean) If `true` remove empty items from the front
--- and back of the list --- and back of the list
@@ -159,9 +159,9 @@ end
--- ---
---@see From https://github.com/premake/premake-core/blob/master/src/base/table.lua ---@see From https://github.com/premake/premake-core/blob/master/src/base/table.lua
--- ---
---@param t table<T, any> Table ---@param t table<T, any> (table) Table
---@generic T: table ---@generic T: table
---@return T[] List of keys ---@return T[] (list) List of keys
function vim.tbl_keys(t) function vim.tbl_keys(t)
assert(type(t) == 'table', string.format('Expected table, got %s', type(t))) assert(type(t) == 'table', string.format('Expected table, got %s', type(t)))
@@ -176,8 +176,8 @@ end
--- However, the order of the return table of values is not guaranteed. --- However, the order of the return table of values is not guaranteed.
--- ---
---@generic T ---@generic T
---@param t table<any, T> Table ---@param t table<any, T> (table) Table
---@return T[] List of values ---@return T[] (list) List of values
function vim.tbl_values(t) function vim.tbl_values(t)
assert(type(t) == 'table', string.format('Expected table, got %s', type(t))) assert(type(t) == 'table', string.format('Expected table, got %s', type(t)))
@@ -191,8 +191,8 @@ end
--- Apply a function to all values of a table. --- Apply a function to all values of a table.
--- ---
---@generic T ---@generic T
---@param func fun(value: T): any Function ---@param func fun(value: T): any (function) Function
---@param t table<any, T> Table ---@param t table<any, T> (table) Table
---@return table Table of transformed values ---@return table Table of transformed values
function vim.tbl_map(func, t) function vim.tbl_map(func, t)
vim.validate({ func = { func, 'c' }, t = { t, 't' } }) vim.validate({ func = { func, 'c' }, t = { t, 't' } })
@@ -207,9 +207,9 @@ end
--- Filter a table using a predicate function --- Filter a table using a predicate function
--- ---
---@generic T ---@generic T
---@param func fun(value: T): boolean Function ---@param func fun(value: T): boolean (function) Function
---@param t table<any, T> Table ---@param t table<any, T> (table) Table
---@return T[] Table of filtered values ---@return T[] (table) Table of filtered values
function vim.tbl_filter(func, t) function vim.tbl_filter(func, t)
vim.validate({ func = { func, 'c' }, t = { t, 't' } }) vim.validate({ func = { func, 'c' }, t = { t, 't' } })
@@ -313,12 +313,12 @@ end
--- ---
---@generic T1: table ---@generic T1: table
---@generic T2: table ---@generic T2: table
---@param behavior "error"|"keep"|"force" Decides what to do if a key is found in more than one map: ---@param behavior "error"|"keep"|"force" (string) Decides what to do if a key is found in more than one map:
--- - "error": raise an error --- - "error": raise an error
--- - "keep": use value from the leftmost map --- - "keep": use value from the leftmost map
--- - "force": use value from the rightmost map --- - "force": use value from the rightmost map
---@param ... T2 Two or more map-like tables ---@param ... T2 Two or more map-like tables
---@return T1|T2 Merged table ---@return T1|T2 (table) Merged table
function vim.tbl_deep_extend(behavior, ...) function vim.tbl_deep_extend(behavior, ...)
return tbl_extend(behavior, true, ...) return tbl_extend(behavior, true, ...)
end end
@@ -515,10 +515,10 @@ end
--- Creates a copy of a table containing only elements from start to end (inclusive) --- Creates a copy of a table containing only elements from start to end (inclusive)
--- ---
---@generic T ---@generic T
---@param list T[] Table ---@param list T[] (list) Table
---@param start number Start range of slice ---@param start number Start range of slice
---@param finish number End range of slice ---@param finish number End range of slice
---@return T[] Copy of table sliced from start to finish (inclusive) ---@return T[] (list) Copy of table sliced from start to finish (inclusive)
function vim.list_slice(list, start, finish) function vim.list_slice(list, start, finish)
local new_list = {} local new_list = {}
for i = start or 1, finish or #list do for i = start or 1, finish or #list do

69
scripts/lua2dox.lua
View File

@@ -159,6 +159,7 @@ end
--! \param Str --! \param Str
--! \param Pattern --! \param Pattern
--! \returns table of string fragments --! \returns table of string fragments
---@return string[]
local function string_split(Str, Pattern) local function string_split(Str, Pattern)
local splitStr = {} local splitStr = {}
local fpat = "(.-)" .. Pattern local fpat = "(.-)" .. Pattern
@@ -369,6 +370,9 @@ local function checkComment4fn(Fn_magic,MagicLines)
return fn_magic return fn_magic
end end
local types = {"number", "string", "table", "list", "boolean", "function"}
--! \brief run the filter --! \brief run the filter
function TLua2DoX_filter.readfile(this,AppStamp,Filename) function TLua2DoX_filter.readfile(this,AppStamp,Filename)
local inStream = TStream_Read() local inStream = TStream_Read()
@@ -408,6 +412,19 @@ function TLua2DoX_filter.readfile(this,AppStamp,Filename)
local magic = string.sub(line, 4 + offset) local magic = string.sub(line, 4 + offset)
local magic_split = string_split(magic, ' ') local magic_split = string_split(magic, ' ')
if magic_split[1] == 'param' then
for _, type in ipairs(types) do
magic = magic:gsub("^param%s+([a-zA-Z_?]+)%s+.*%((" .. type .. ")%)", "param %1 %2" )
magic = magic:gsub("^param%s+([a-zA-Z_?]+)%s+.*%((" .. type .. "|nil)%)", "param %1 %2" )
end
magic_split = string_split(magic, ' ')
elseif magic_split[1] == 'return' then
for _, type in ipairs(types) do
magic = magic:gsub("^return%s+.*%((" .. type .. ")%)", "return %1" )
magic = magic:gsub("^return%s+.*%((" .. type .. "|nil)%)", "return %1" )
end
magic_split = string_split(magic, ' ')
end
if magic_split[1] == "generic" then if magic_split[1] == "generic" then
local generic_name, generic_type = line:match("@generic%s*(%w+)%s*:?%s*(.*)") local generic_name, generic_type = line:match("@generic%s*(%w+)%s*:?%s*(.*)")
@@ -415,39 +432,35 @@ function TLua2DoX_filter.readfile(this,AppStamp,Filename)
generic_type = "any" generic_type = "any"
end end
generic[generic_name] = generic_type generic[generic_name] = generic_type
end else
local type_index = 2
local type_index = 2 if magic_split[1] == 'param' then
if magic_split[1] == 'param' then type_index = type_index + 1
type_index = type_index + 1
if magic_split[type_index] and magic_split[2]:find("%?$") then
magic_split[type_index] = magic_split[type_index] .. "|nil"
magic_split[2] = magic_split[2]:sub(1, -2)
end end
end
if magic_split[type_index] then if magic_split[type_index] then
for k, v in pairs(generic) do -- fix optional parameters
magic_split[type_index] = magic_split[type_index]:gsub(k, v) if magic_split[type_index] and magic_split[2]:find("%?$") then
if not magic_split[type_index]:find("nil") then
magic_split[type_index] = magic_split[type_index] .. "|nil"
end
magic_split[2] = magic_split[2]:sub(1, -2)
end
-- replace generic types
if magic_split[type_index] then
for k, v in pairs(generic) do
magic_split[type_index] = magic_split[type_index]:gsub(k, v)
end
end
-- surround some types by ()
for _, type in ipairs(types) do
magic_split[type_index] = magic_split[type_index]:gsub("^(" .. type .. "|nil):?$", "(%1)")
magic_split[type_index] = magic_split[type_index]:gsub("^(" .. type .. "):?$", "(%1)")
end
end end
end
if magic_split[type_index] == 'number' or magic = table.concat(magic_split, ' ')
magic_split[type_index] == 'number|nil' or
magic_split[type_index] == 'string' or
magic_split[type_index] == 'string|nil' or
magic_split[type_index] == 'table' or
magic_split[type_index] == 'table|nil' or
magic_split[type_index] == 'boolean' or
magic_split[type_index] == 'boolean|nil' or
magic_split[type_index] == 'function' or
magic_split[type_index] == 'function|nil'
then
magic_split[type_index] = '(' .. magic_split[type_index] .. ')'
end
magic = table.concat(magic_split, ' ')
if magic_split[1] ~= "generic" then
outStream:writeln('/// @' .. magic) outStream:writeln('/// @' .. magic)
fn_magic = checkComment4fn(fn_magic,magic) fn_magic = checkComment4fn(fn_magic,magic)
end end