1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
|
local function get_node_with_link(node,name)
if node:get_attribute("skipped") then return name end
return '<link linkend="'..node:get_name(true):gsub("%.","_"):gsub("#","_hash_")..'">'..name..'</link>'
end
para = function() return "</para>\n<para>" end
node_to_string = function(node,name)
if name then
return get_node_with_link(node,name)
else
return get_node_with_link(node,node:get_name())
end
end
code = function(text)
return "</para>\n\n<para><programlisting language=\"lua\">"..text.."</programlisting></para>\n\n<para>"
end
startlist = function() return "<itemizedlist>\n" end
endlist = function() return "</itemizedlist>\n" end
listel = function(text) return "<listitem><para>"..text.."</para></listitem>\n" end
emphasis = function(text) return "<emphasis>"..text.."</emphasis>" end
url = function(text,content)
if content then
return "<ulink url=\""..text.."\">"..content.."</ulink>"
else
return "<ulink url=\""..text.."\">"..text.."</ulink>"
end
end
require "content"
doc = require "core"
table = require "table"
dump = require("darktable.debug").dump
local parse_doc_node
local function sorted_pairs (t, f)
local a = {}
for n in pairs(t) do table.insert(a, n) end
table.sort(a, f)
local i = 0 -- iterator variable
local iter = function () -- iterator function
i = i + 1
if a[i] == nil then return nil
else return a[i], t[a[i]]
end
end
return iter
end
local function get_reported_type(node,simple)
local rtype = tostring(node:get_reported_type())
if not rtype then
doc.debug_print(node)
error("all types should have a reported type")
end
if rtype == "documentation node" then rtype = nil end
if rtype == "dt_singleton" then rtype = nil end
if rtype == "undocumented" then
io.stderr:write("warning, undocumented type for "..node:get_name(true).."\n")
end
if rtype == "nil" then
io.stderr:write("warning, documenting a nil for "..node:get_name(true).."\n")
end
if( rtype and not simple and doc.get_attribute(node,"signature")) then
rtype = rtype.."( "
local sig = doc.get_attribute(node,"signature")
for k,v in sorted_pairs(sig) do
if(doc.get_attribute(v,"is_self")) then
rtype = doc.get_short_name(v)..":"..rtype
elseif(doc.get_attribute(v,"optional")) then
rtype = rtype.."\n\t["..emphasis(get_node_with_link(v,doc.get_short_name(v))).." : "..get_reported_type(v,true).."]"
if next(sig,k) then
rtype = rtype..", "
end
else
rtype = rtype.."\n\t"..emphasis(get_node_with_link(v,doc.get_short_name(v))).." : "..get_reported_type(v,true)
if next(sig,k) then
rtype = rtype..", "
end
end
end
rtype = rtype.."\n)"
end
if(not simple and doc.get_attribute(node,"ret_val")) then
rtype = rtype.." : "..get_reported_type(doc.get_attribute(node,"ret_val",true))
end
return rtype
end
local function print_attributes(node)
local result = ""
for k2,v2 in sorted_pairs(node._luadoc_attributes) do
if not doc.get_attribute(doc.toplevel.attributes[k2],"internal_attr") then
if(type(v2) == "boolean") then
result = result..listel(emphasis(get_node_with_link(doc.toplevel.attributes[k2],k2)))
elseif type(v2) == "string" then
result = result..listel(emphasis(get_node_with_link(doc.toplevel.attributes[k2],k2).." : ")..v2)
elseif type(v2) == "table" and v2._luadoc_type then
result = result..listel(emphasis(get_node_with_link(doc.toplevel.attributes[k2],k2).." : ")..tostring(v2))
elseif type(v2) == "table" then
tmp = ""
for k,v in sorted_pairs(v2) do
tmp = tmp..listel(tostring(v));
end
result = result..listel(emphasis(get_node_with_link(doc.toplevel.attributes[k2],k2).." : ")..para()..startlist()..tmp..endlist())
elseif type(v2) == "number" then
result = result..listel(emphasis(get_node_with_link(doc.toplevel.attributes[k2],k2).." : ")..tostring(v2))
else
error("unhandle attribute type\n"..dump(v2,k2))
end
end
end
if result ~= "" then
-- synopsis was within the <entry> below
result = [[<informaltable frame="none" width="80%"><tgroup cols="2" colsep="0" rowsep="0">
<colspec colwidth="2*"/>
<colspec colwidth="8*"/>
<tbody><row>
<entry>Attributes:</entry>
<entry>]]..startlist()..result..endlist()..[[</entry>
</row></tbody>
</tgroup></informaltable>]]
end
return result
end
local function print_content(node)
local rtype = get_reported_type(node)
local result = ""
if rtype then
-- synopsis was here
result = result .."<synopsis>"..rtype.."</synopsis>\n"
end
result = result .."<para>"..doc.get_text(node).."</para>\n"
if doc.get_text(node) == "undocumented" then
io.stderr:write("warning, undocumented node "..node:get_name(true).."\n")
end
result = result ..print_attributes(node)
result = result.."\n"
local sig = doc.get_attribute(node,"signature")
local ret_val = doc.get_attribute(node,"ret_val")
if(sig or ret_val) then
result = result.."<variablelist>\n"
end
if(sig) then
for k,v in sorted_pairs(sig) do
result = result .. parse_doc_node(v,node,doc.get_short_name(v)).."\n";
end
end
if(ret_val) then
result = result .. parse_doc_node(ret_val,node,doc.get_short_name(ret_val)).."\n";
result = result.."\n"
end
if(sig or ret_val) then
result = result.."</variablelist>\n"
end
for k,v in doc.unskipped_children(node) do
result = result .. parse_doc_node(v,node,k).."\n";
end
return result;
end
local function depth(node)
if doc.get_name(node,true) == "" then return 0 end
return depth(doc.get_main_parent(node)) +1
end
parse_doc_node = function(node,parent,prev_name)
if node:get_attribute("skipped") == true then return "" end
local node_name
local parent_name = doc.get_name(parent)
local result = ""
if doc.is_main_parent(node,parent,prev_name) then
node_name = doc.get_name(node)
else
if parent_name == "" then
node_name = prev_name
else
node_name = doc.get_name(parent).."."..prev_name
end
end
local depth = depth(node);
--if depth > 5 then
-- error("too many tree depth for usermanual")
--end
if(node._luadoc_type == "param") then
local tmp_node = doc.get_main_parent(node)
while tmp_node:get_reported_type() == "function" do
tmp_node = doc.get_main_parent(tmp_node)
end
if(node:get_short_name() == "return") then
result = result ..'<varlistentry><term><emphasis>return</emphasis></term><listitem>\n'
else
node_name = doc.get_short_name(node)
if(doc.get_attribute(node,"optional")) then
node_name ="["..node_name.."]"
end
result = result ..'<varlistentry id="'..doc.get_name(node,true):gsub("%.","_"):gsub("#","_hash_")..'"><term>'..node_name.."</term><listitem>\n"
end
elseif depth ~= 0 then
--result = result..'<sect'..(depth+1)..' status="final" '
result = result..'<section status="final" '
if(doc.is_main_parent(node,parent,prev_name) ) then
result = result..'id="'..doc.get_name(node,true):gsub("%.","_"):gsub("#","_hash_")..'"'
end
result = result..'>\n'
result = result..'<title>'..node_name..'</title>\n'
result = result..'<indexterm>\n'
result = result..'<primary>Lua API</primary>\n'
if(doc.is_main_parent(node,parent,prev_name) ) then
result = result..'<secondary>'..node:get_short_name()..'</secondary>\n'
else
result = result..'<secondary>'..prev_name..'</secondary>\n'
end
result = result..'</indexterm>\n'
end
if(not doc.is_main_parent(node,parent,prev_name) ) then
result = result .. "<para>see "..get_node_with_link(node,doc.get_name(node)).."</para>\n"
else
result = result .. print_content(node,parent)
end
if(node._luadoc_type == "param") then
result = result..'</listitem></varlistentry>\n'
elseif depth ~= 0 then
--result = result..'</sect'..(depth+1)..'>\n'
result = result..'</section>\n'
end
return result;
end
M = {}
M.page_name = page_name
function M.get_doc()
return [[<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % darktable_dtd SYSTEM "../dtd/darktable.dtd">
%darktable_dtd;
]>
<article status="draft" id="lua_api"><title>Lua API</title>
<indexterm>
<primary>Lua API</primary>
</indexterm>
]]..parse_doc_node(doc.toplevel,nil,"").."</article>"
end
return M;
--
-- vim: shiftwidth=2 expandtab tabstop=2 cindent syntax=lua
|