Merge pull request #34186 from bfredl/neotags

build: generate helptags without running "nvim" binary
This commit is contained in:
bfredl
2025-08-20 09:10:02 +02:00
committed by GitHub
6 changed files with 104 additions and 12 deletions

View File

@@ -8,6 +8,7 @@ pub fn build_nlua0(
use_luajit: bool,
ziglua: *std.Build.Dependency,
lpeg: *std.Build.Dependency,
libluv: *std.Build.Step.Compile,
) *std.Build.Step.Compile {
const options = b.addOptions();
options.addOption(bool, "use_luajit", use_luajit);
@@ -39,6 +40,7 @@ pub fn build_nlua0(
mod.addImport("embedded_data", embedded_data);
// addImport already links by itself. but we need headers as well..
mod.linkLibrary(ziglua.artifact("lua"));
mod.linkLibrary(libluv);
mod.addOptions("options", options);

78
src/gen/gen_helptags.lua Normal file
View File

@@ -0,0 +1,78 @@
-- Does the same as `nvim -c "helptags ++t doc" -c quit`
-- without needing to run a "nvim" binary, which is needed for cross-compiling.
local out = arg[1]
local dir = arg[2]
local dirfd = vim.uv.fs_opendir(dir, nil, 1)
local files = {}
while true do
local file = dirfd:readdir()
if file == nil then
break
end
if file[1].type == 'file' and vim.endswith(file[1].name, '.txt') then
table.insert(files, file[1].name)
end
end
local tags = {}
for _, fn in ipairs(files) do
local in_example = false
for line in io.lines(dir .. '/' .. fn) do
if in_example then
local first = string.sub(line, 1, 1)
if first ~= ' ' and first ~= '\t' and first ~= '' then
in_example = false
end
end
local chunks = vim.split(line, '*', { plain = true })
local next_valid = false
local n_chunks = #chunks
for i, chunk in ipairs(chunks) do
if next_valid and not in_example then
if #chunk > 0 and string.find(chunk, '[ \t|]') == nil then
local next = string.sub(chunks[i + 1], 1, 1)
if next == ' ' or next == '\t' or (i == n_chunks - 1 and next == '') then
table.insert(tags, { chunk, fn })
end
end
end
if i == n_chunks - 1 then
break
end
next_valid = false
local lastend = string.sub(chunk, -1) -- "" for empty string
if lastend == ' ' or lastend == '\t' or (i == 1 and lastend == '') then
next_valid = true
end
end
if line == '>' or vim.endswith(line, ' >') then
in_example = true
end
end
end
table.insert(tags, { 'help-tags', 'tags' })
table.sort(tags, function(a, b)
return a[1] < b[1]
end)
local f = io.open(out, 'w')
local lasttagname, lastfn = nil
for _, tag in ipairs(tags) do
local tagname, fn = unpack(tag)
if tagname == lasttagname then
error('duplicate tags in ' .. fn .. (lastfn ~= fn and (' and ' .. lastfn) or ''))
end
lasttagname, lastfn = tagname, fn
if tagname == 'help-tags' then
f:write(tagname .. '\t' .. fn .. '\t1\n')
else
local escaped = string.gsub(tagname, '[\\/]', '\\%0')
f:write(tagname .. '\t' .. fn .. '\t/*' .. escaped .. '*\n')
end
end
f:close()

View File

@@ -20,6 +20,7 @@ const Lua = ziglua.Lua;
extern "c" fn luaopen_mpack(ptr: *anyopaque) c_int;
extern "c" fn luaopen_lpeg(ptr: *anyopaque) c_int;
extern "c" fn luaopen_bit(ptr: *anyopaque) c_int;
extern "c" fn luaopen_luv(ptr: *anyopaque) c_int;
fn init() !*Lua {
// Initialize the Lua vm
@@ -56,6 +57,10 @@ fn init() !*Lua {
if (retval2 != 1) return error.LoadError;
lua.setField(-3, "lpeg");
const retval3 = luaopen_luv(lua);
if (retval3 != 1) return error.LoadError;
lua.setField(-3, "uv");
lua.pop(2);
if (!options.use_luajit) {