build: Move the meta file parser to an helper module
The commit also re-work the build target so if the file are deleted, then they are created again. Using `file(COPY ...)` and `file(MAKE_DIRECTORY ...)` as done previously caused some file to be out of date or not being regenerated at all. This commit also fixes some broken target that depended on `file(` and `configure_file` CMake command not being part of any target. Fix #2342
This commit is contained in:
Emmanuel Lepage Vallee
parent
6ac8f30d62
commit
62c95d5fe6
|
|
@ -354,13 +354,20 @@ add_custom_target(lgi-check-run ALL
|
|||
|
||||
# {{{ Generate some aggregated documentation from lua script
|
||||
|
||||
file(MAKE_DIRECTORY ${BUILD_DIR}/script_files/)
|
||||
add_custom_target(setup_directories DEPENDS lgi-check-run)
|
||||
|
||||
add_custom_command(TARGET setup_directories
|
||||
COMMAND ${CMAKE_COMMAND} -E make_directory ${BUILD_DIR}/script_files/
|
||||
COMMAND ${CMAKE_COMMAND} -E make_directory ${BUILD_DIR}/docs/common/
|
||||
COMMAND ${CMAKE_COMMAND} -E make_directory ${BUILD_DIR}/doc/images/
|
||||
COMMAND ${CMAKE_COMMAND} -E copy ${SOURCE_DIR}/docs/_parser.lua ${BUILD_DIR}/docs/
|
||||
)
|
||||
|
||||
add_custom_command(
|
||||
OUTPUT ${BUILD_DIR}/docs/06-appearance.md
|
||||
COMMAND lua ${SOURCE_DIR}/docs/06-appearance.md.lua
|
||||
${BUILD_DIR}/docs/06-appearance.md
|
||||
DEPENDS lgi-check-run
|
||||
DEPENDS lgi-check-run ${SOURCE_DIR}/docs/06-appearance.md.lua
|
||||
)
|
||||
|
||||
add_custom_command(
|
||||
|
|
@ -370,6 +377,7 @@ add_custom_command(
|
|||
${BUILD_DIR}/docs/05-awesomerc.md ${SOURCE_DIR}/awesomerc.lua
|
||||
${BUILD_DIR}/awesomerc.lua
|
||||
${BUILD_DIR}/script_files/rc.lua
|
||||
DEPENDS ${SOURCE_DIR}/awesomerc.lua ${SOURCE_DIR}/docs/05-awesomerc.md.lua
|
||||
)
|
||||
|
||||
add_custom_command(
|
||||
|
|
@ -379,6 +387,7 @@ add_custom_command(
|
|||
|
||||
# Create a target for the auto-generated awesomerc.lua and other files
|
||||
add_custom_target(generate_awesomerc DEPENDS
|
||||
setup_directories
|
||||
${BUILD_DIR}/awesomerc.lua
|
||||
${BUILD_DIR}/script_files/theme.lua
|
||||
${BUILD_DIR}/script_files/rc.lua
|
||||
|
|
|
|||
|
|
@ -0,0 +1,196 @@
|
|||
local gio = require("lgi").Gio
|
||||
local gobject = require("lgi").GObject
|
||||
local glib = require("lgi").GLib
|
||||
|
||||
local name_attr = gio.FILE_ATTRIBUTE_STANDARD_NAME
|
||||
local type_attr = gio.FILE_ATTRIBUTE_STANDARD_TYPE
|
||||
|
||||
local module = {}
|
||||
|
||||
-- Like pairs(), but iterate over keys in a sorted manner. Does not support
|
||||
-- modifying the table while iterating.
|
||||
local function sorted_pairs(t)
|
||||
-- Collect all keys
|
||||
local keys = {}
|
||||
for k in pairs(t) do
|
||||
table.insert(keys, k)
|
||||
end
|
||||
|
||||
table.sort(keys)
|
||||
|
||||
-- return iterator function
|
||||
local i = 0
|
||||
return function()
|
||||
i = i + 1
|
||||
if keys[i] then
|
||||
return keys[i], t[keys[i]]
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
-- Recursive file scanner
|
||||
local function get_all_files(path, ext, ret)
|
||||
ret = ret or {}
|
||||
local enumerator = gio.File.new_for_path(path):enumerate_children(
|
||||
table.concat({name_attr, type_attr}, ",") , 0, nil, nil
|
||||
)
|
||||
|
||||
for file in function() return enumerator:next_file() end do
|
||||
local file_name = file:get_attribute_as_string(name_attr)
|
||||
local file_type = file:get_file_type()
|
||||
local match_ext = file_name:match("[.]"..ext.."$" or "")
|
||||
local fpath = enumerator:get_child(file):get_path()
|
||||
local is_test = fpath:match("/tests/")
|
||||
if file_type == "REGULAR" and match_ext and not is_test then
|
||||
table.insert(ret, fpath)
|
||||
elseif file_type == "DIRECTORY" then
|
||||
get_all_files(enumerator:get_child(file):get_path(), ext, ret)
|
||||
end
|
||||
end
|
||||
|
||||
return ret
|
||||
end
|
||||
|
||||
local function path_to_module(path)
|
||||
if path:match("[.]c$") then
|
||||
return path:gmatch("/([^./]+)[.]c$")()
|
||||
end
|
||||
|
||||
for _, module in ipairs {
|
||||
"awful", "wibox", "gears", "naughty", "menubar", "beautiful"
|
||||
} do
|
||||
local match = path:match("/"..module.."/([^.]+).lua")
|
||||
if match then
|
||||
return module.."."..match:gsub("/",".")
|
||||
end
|
||||
end
|
||||
|
||||
error("Cannot figure out module for " .. tostring(path))
|
||||
end
|
||||
|
||||
function module.path_to_html(path)
|
||||
local mod = path_to_module(path):gsub(".init", "")
|
||||
local f = assert(io.open(path))
|
||||
while true do
|
||||
local line = f:read()
|
||||
if not line then break end
|
||||
if line:match("@classmod") then
|
||||
f:close()
|
||||
return "../classes/".. mod ..".html#"
|
||||
end
|
||||
if line:match("@module") or line:match("@submodule") then
|
||||
f:close()
|
||||
return "../libraries/".. mod ..".html#"
|
||||
end
|
||||
end
|
||||
f:close()
|
||||
|
||||
error("Cannot figure out if module or class: " .. tostring(path))
|
||||
end
|
||||
|
||||
local function get_link(file, element)
|
||||
return table.concat {
|
||||
"<a href='",
|
||||
module.path_to_html(file),
|
||||
element,
|
||||
"'>",
|
||||
element:match("[. ](.+)"),
|
||||
"</a>"
|
||||
}
|
||||
end
|
||||
|
||||
local function parse_files(property_name, matcher)
|
||||
local exp1 = "--[ ]*@".. property_name .." ([^ \n]*)"
|
||||
local exp2 = matcher or "--[ ]*".. property_name ..".(.+)"
|
||||
|
||||
local ret = {}
|
||||
|
||||
local paths = get_all_files("./lib/", "lua")
|
||||
assert(paths)
|
||||
|
||||
for _, f in ipairs(get_all_files("./", "c")) do
|
||||
table.insert(paths, f)
|
||||
end
|
||||
|
||||
table.sort(paths)
|
||||
|
||||
-- Find all @beautiful doc entries
|
||||
for _,file in ipairs(paths) do
|
||||
local f = io.open(file)
|
||||
|
||||
local buffer = ""
|
||||
|
||||
for line in f:lines() do
|
||||
|
||||
local var = line:gmatch(exp1)()
|
||||
|
||||
-- There is no backward/forward pattern in lua
|
||||
if #line <= 1 then
|
||||
buffer = ""
|
||||
elseif #buffer and not var then
|
||||
buffer = buffer.."\n"..line
|
||||
elseif line:sub(1,3) == "---" or line:sub(1,3) == "/**" then
|
||||
buffer = line
|
||||
end
|
||||
|
||||
|
||||
if var then
|
||||
-- Get the @param, @see and @usage
|
||||
local params = ""
|
||||
for line in f:lines() do
|
||||
if line:sub(1,2) ~= "--" then
|
||||
break
|
||||
else
|
||||
params = params.."\n"..line
|
||||
end
|
||||
end
|
||||
|
||||
local name = var:gmatch(exp2)()
|
||||
if not name then
|
||||
print("WARNING:", var,
|
||||
"seems to be misformatted. Use `beautiful.namespace_name`"
|
||||
)
|
||||
else
|
||||
table.insert(ret, {
|
||||
file = file,
|
||||
name = name:gsub("_", "\\_"),
|
||||
link = get_link(file, var, var:match(exp3):gsub("_", "\\_")),
|
||||
desc = buffer:gmatch("[-*/ \n]+([^\n.]*)")() or "",
|
||||
mod = path_to_module(file),
|
||||
})
|
||||
end
|
||||
|
||||
buffer = ""
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return ret
|
||||
end
|
||||
|
||||
local function create_table(entries, columns)
|
||||
local lines = {}
|
||||
|
||||
for _, entry in ipairs(entries) do
|
||||
local line = " <tr>"
|
||||
|
||||
for _, column in ipairs(columns) do
|
||||
line = line.."<td>"..entry[column].."</td>"
|
||||
end
|
||||
|
||||
table.insert(lines, line.."</tr>\n")
|
||||
end
|
||||
|
||||
return [[<br \><br \><table class='widget_list' border=1>
|
||||
<tr style='font-weight: bold;'>
|
||||
<th align='center'>Name</th>
|
||||
<th align='center'>Description</th>
|
||||
</tr>]] .. table.concat(lines) .. "</table>\n"
|
||||
end
|
||||
|
||||
module.create_table = create_table
|
||||
module.parse_files = parse_files
|
||||
module.sorted_pairs = sorted_pairs
|
||||
module.get_all_files = get_all_files
|
||||
|
||||
return module
|
||||
Loading…
Reference in New Issue