rufus-lua-win 5.1.5

data/vendor/lua/lib/lua/luadoc/doclet/debug.lua

@@ -0,0 +1,46 @@
+-----------------------------------------------------------------
+-- LuaDoc debugging facilities.
+-- @release $Id: debug.lua,v 1.3 2007/04/18 14:28:39 tomas Exp $
+-----------------------------------------------------------------
+
+module "luadoc.doclet.debug"
+
+function printline()
+	print(string.rep('-', 79))
+end
+
+-----------------------------------------------------------------
+-- Print debug information about document
+-- @param doc Table with the structured documentation.
+
+function start (doc)
+	print("Files:")
+	for _, filepath in ipairs(doc.files) do
+		print('\t', filepath)
+	end
+	printline()
+
+	print("Modules:")
+	for _, modulename in ipairs(doc.modules) do
+		print('\t', modulename)
+	end
+	printline()
+	
+	for i, v in pairs(doc.files) do
+		print('\t', i, v)
+	end
+	printline()
+	for i, v in pairs(doc.files[doc.files[1]]) do
+		print(i, v)
+	end
+	
+	printline()
+	for i, v in pairs(doc.files[doc.files[1]].doc[1]) do
+		print(i, v)
+	end
+	printline()
+	print("Params")
+	for i, v in pairs(doc.files[doc.files[1]].doc[1].param) do
+		print(i, v)
+	end
+end

data/vendor/lua/lib/lua/luadoc/doclet/formatter.lua

@@ -0,0 +1,84 @@
+-------------------------------------------------------------------------------
+-- Doclet to format source code according to LuaDoc standard tags. This doclet
+-- (re)write .lua files adding missing standard tags. Texts are formatted to
+-- 80 columns and function parameters are added based on code analysis.
+--
+-- @release $Id: formatter.lua,v 1.5 2007/04/18 14:28:39 tomas Exp $
+-------------------------------------------------------------------------------
+
+local util = require "luadoc.util"
+local assert, ipairs, pairs, type = assert, ipairs, pairs, type
+local string = require"string"
+local table = require"table"
+
+module "luadoc.doclet.formatter"
+
+options = {
+	output_dir = "./",
+}
+
+-------------------------------------------------------------------------------
+-- Assembly the output filename for an input file.
+-- TODO: change the name of this function
+function out_file (filename)
+	local h = filename
+	h = options.output_dir..h
+	return h
+end
+
+-------------------------------------------------------------------------------
+-- Generate a new lua file for each input lua file. If the user does not 
+-- specify a different output directory input files will be rewritten.
+-- @param doc documentation table
+
+function start (doc)
+	local todo = "<TODO>"
+	
+	-- Process files
+	for i, file_doc in ipairs(doc.files) do
+		-- assembly the filename
+		local filename = out_file(file_doc.name)
+		luadoc.logger:info(string.format("generating file `%s'", filename))
+
+		-- TODO: confirm file overwrite
+		local f = lfs.open(filename, "w")
+		assert(f, string.format("could not open `%s' for writing", filename))
+
+		for _, block in ipairs(file_doc.doc) do
+
+			-- write reorganized comments
+			f:write(string.rep("-", 80).."\n")
+			
+			-- description
+			f:write(util.comment(util.wrap(block.description, 77)))
+			f:write("\n")
+			
+			if block.class == "function" then
+				-- parameters
+				table.foreachi(block.param, function (_, param_name)
+					f:write(util.comment(util.wrap(string.format("@param %s %s", param_name, block.param[param_name] or todo), 77)))
+					f:write("\n")
+				end)
+				
+				-- return
+				if type(block.ret) == "table" then
+					table.foreachi(block.ret, function (_, ret)
+						f:write(util.comment(util.wrap(string.format("@return %s", ret), 77)).."\n")
+					end)
+				else
+					f:write(util.comment(util.wrap(string.format("@return %s", block.ret or todo), 77)).."\n")
+				end
+			end
+			
+			-- TODO: usage
+			-- TODO: see
+
+			-- write code
+			for _, line in ipairs(block.code) do
+				f:write(line.."\n")
+			end
+		end
+		
+		f:close()
+	end
+end

data/vendor/lua/lib/lua/luadoc/doclet/html.lua

@@ -0,0 +1,289 @@
+-------------------------------------------------------------------------------
+-- Doclet that generates HTML output. This doclet generates a set of html files
+-- based on a group of templates. The main templates are:
+-- <ul>
+-- <li>index.lp: index of modules and files;</li>
+-- <li>file.lp: documentation for a lua file;</li>
+-- <li>module.lp: documentation for a lua module;</li>
+-- <li>function.lp: documentation for a lua function. This is a
+-- sub-template used by the others.</li>
+-- </ul>
+--
+-- @release $Id: html.lua,v 1.29 2007/12/21 17:50:48 tomas Exp $
+-------------------------------------------------------------------------------
+
+local assert, getfenv, ipairs, loadstring, pairs, setfenv, tostring, tonumber, type = assert, getfenv, ipairs, loadstring, pairs, setfenv, tostring, tonumber, type
+local io = require"io"
+local lfs = require "lfs"
+local lp = require "luadoc.lp"
+local luadoc = require"luadoc"
+local package = package
+local string = require"string"
+local table = require"table"
+
+module "luadoc.doclet.html"
+
+-------------------------------------------------------------------------------
+-- Looks for a file `name' in given path. Removed from compat-5.1
+-- @param path String with the path.
+-- @param name String with the name to look for.
+-- @return String with the complete path of the file found
+--	or nil in case the file is not found.
+
+local function search (path, name)
+  for c in string.gfind(path, "[^;]+") do
+    c = string.gsub(c, "%?", name)
+    local f = io.open(c)
+    if f then   -- file exist?
+      f:close()
+      return c
+    end
+  end
+  return nil    -- file not found
+end
+
+-------------------------------------------------------------------------------
+-- Include the result of a lp template into the current stream.
+
+function include (template, env)
+	-- template_dir is relative to package.path
+	local templatepath = options.template_dir .. template
+
+	-- search using package.path (modified to search .lp instead of .lua
+	local search_path = string.gsub(package.path, "%.lua", "")
+	local templatepath = search(search_path, templatepath)
+	assert(templatepath, string.format("template `%s' not found", template))
+
+	env = env or {}
+	env.table = table
+	env.io = io
+	env.lp = lp
+	env.ipairs = ipairs
+	env.tonumber = tonumber
+	env.tostring = tostring
+	env.type = type
+	env.luadoc = luadoc
+	env.options = options
+
+	return lp.include(templatepath, env)
+end
+
+-------------------------------------------------------------------------------
+-- Returns a link to a html file, appending "../" to the link to make it right.
+-- @param html Name of the html file to link to
+-- @return link to the html file
+
+function link (html, from)
+	local h = html
+	from = from or ""
+	string.gsub(from, "/", function () h = "../" .. h end)
+	return h
+end
+
+-------------------------------------------------------------------------------
+-- Returns the name of the html file to be generated from a module.
+-- Files with "lua" or "luadoc" extensions are replaced by "html" extension.
+-- @param modulename Name of the module to be processed, may be a .lua file or
+-- a .luadoc file.
+-- @return name of the generated html file for the module
+
+function module_link (modulename, doc, from)
+	-- TODO: replace "." by "/" to create directories?
+	-- TODO: how to deal with module names with "/"?
+	assert(modulename)
+	assert(doc)
+	from = from or ""
+
+	if doc.modules[modulename] == nil then
+--		logger:error(string.format("unresolved reference to module `%s'", modulename))
+		return
+	end
+
+	local href = "modules/" .. modulename .. ".html"
+	string.gsub(from, "/", function () href = "../" .. href end)
+	return href
+end
+
+-------------------------------------------------------------------------------
+-- Returns the name of the html file to be generated from a lua(doc) file.
+-- Files with "lua" or "luadoc" extensions are replaced by "html" extension.
+-- @param to Name of the file to be processed, may be a .lua file or
+-- a .luadoc file.
+-- @param from path of where am I, based on this we append ..'s to the
+-- beginning of path
+-- @return name of the generated html file
+
+function file_link (to, from)
+	assert(to)
+	from = from or ""
+
+	local href = to
+	href = string.gsub(href, "lua$", "html")
+	href = string.gsub(href, "luadoc$", "html")
+	href = "files/" .. href
+	string.gsub(from, "/", function () href = "../" .. href end)
+	return href
+end
+
+-------------------------------------------------------------------------------
+-- Returns a link to a function or to a table
+-- @param fname name of the function or table to link to.
+-- @param doc documentation table
+-- @param kind String specying the kinf of element to link ("functions" or "tables").
+
+function link_to (fname, doc, module_doc, file_doc, from, kind)
+	assert(fname)
+	assert(doc)
+	from = from or ""
+	kind = kind or "functions"
+
+	if file_doc then
+		for _, func_name in pairs(file_doc[kind]) do
+			if func_name == fname then
+				return file_link(file_doc.name, from) .. "#" .. fname
+			end
+		end
+	end
+
+	local _, _, modulename, fname = string.find(fname, "^(.-)[%.%:]?([^%.%:]*)$")
+	assert(fname)
+
+	-- if fname does not specify a module, use the module_doc
+	if string.len(modulename) == 0 and module_doc then
+		modulename = module_doc.name
+	end
+
+	local module_doc = doc.modules[modulename]
+	if not module_doc then
+--		logger:error(string.format("unresolved reference to function `%s': module `%s' not found", fname, modulename))
+		return
+	end
+
+	for _, func_name in pairs(module_doc[kind]) do
+		if func_name == fname then
+			return module_link(modulename, doc, from) .. "#" .. fname
+		end
+	end
+
+--	logger:error(string.format("unresolved reference to function `%s' of module `%s'", fname, modulename))
+end
+
+-------------------------------------------------------------------------------
+-- Make a link to a file, module or function
+
+function symbol_link (symbol, doc, module_doc, file_doc, from)
+	assert(symbol)
+	assert(doc)
+
+	local href =
+--		file_link(symbol, from) or
+		module_link(symbol, doc, from) or
+		link_to(symbol, doc, module_doc, file_doc, from, "functions") or
+		link_to(symbol, doc, module_doc, file_doc, from, "tables")
+
+	if not href then
+		logger:error(string.format("unresolved reference to symbol `%s'", symbol))
+	end
+
+	return href or ""
+end
+
+-------------------------------------------------------------------------------
+-- Assembly the output filename for an input file.
+-- TODO: change the name of this function
+function out_file (filename)
+	local h = filename
+	h = string.gsub(h, "lua$", "html")
+	h = string.gsub(h, "luadoc$", "html")
+	h = "files/" .. h
+--	h = options.output_dir .. string.gsub (h, "^.-([%w_]+%.html)$", "%1")
+	h = options.output_dir .. h
+	return h
+end
+
+-------------------------------------------------------------------------------
+-- Assembly the output filename for a module.
+-- TODO: change the name of this function
+function out_module (modulename)
+	local h = modulename .. ".html"
+	h = "modules/" .. h
+	h = options.output_dir .. h
+	return h
+end
+
+-------------------------------------------------------------------------------
+-- Update a table to make all string values refelect html tags for linebreaks
+-- a leading spaces.
+function fixhtmltable (doc)
+    for k,v in pairs(doc) do
+        if type(v) == "string" then
+            -- update string value
+            local s = string.gsub(v, "\n", "<br/>")
+            s = string.gsub(s, "<br/> ", "<br/>&nbsp")
+            while string.find(s, "&nbsp ") do
+                s = string.gsub(s, "&nbsp ", "&nbsp&nbsp")
+            end
+            doc[k] = s
+        elseif type(v) == "table" then
+            -- recurse update table
+            fixhtmltable(v)
+        end
+    end
+end
+
+-----------------------------------------------------------------
+-- Generate the output.
+-- @param doc Table with the structured documentation.
+
+function start (doc)
+    -- Pre proces doc table, replacing linebreaks and leading space by html equiv.
+    fixhtmltable(doc)
+	-- Generate index file
+	if (#doc.files > 0 or #doc.modules > 0) and (not options.noindexpage) then
+		local filename = options.output_dir.."index.html"
+		logger:info(string.format("generating file `%s'", filename))
+		local f = lfs.open(filename, "w")
+		assert(f, string.format("could not open `%s' for writing", filename))
+		io.output(f)
+		include("index.lp", { doc = doc })
+		f:close()
+	end
+
+	-- Process modules
+	if not options.nomodules then
+		for _, modulename in ipairs(doc.modules) do
+			local module_doc = doc.modules[modulename]
+			-- assembly the filename
+			local filename = out_module(modulename)
+			logger:info(string.format("generating file `%s'", filename))
+
+			local f = lfs.open(filename, "w")
+			assert(f, string.format("could not open `%s' for writing", filename))
+			io.output(f)
+			include("module.lp", { doc = doc, module_doc = module_doc })
+			f:close()
+		end
+	end
+
+	-- Process files
+	if not options.nofiles then
+		for _, filepath in ipairs(doc.files) do
+			local file_doc = doc.files[filepath]
+			-- assembly the filename
+			local filename = out_file(file_doc.name)
+			logger:info(string.format("generating file `%s'", filename))
+
+			local f = lfs.open(filename, "w")
+			assert(f, string.format("could not open `%s' for writing", filename))
+			io.output(f)
+			include("file.lp", { doc = doc, file_doc = file_doc} )
+			f:close()
+		end
+	end
+
+	-- copy extra files
+	local f = lfs.open(options.output_dir.."luadoc.css", "w")
+	io.output(f)
+	include("luadoc.css")
+	f:close()
+end

data/vendor/lua/lib/lua/luadoc/doclet/html/file.lp

@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html>
+<head>
+    <title>Luadocs for <%= file_doc.name %></title>
+    <link rel="stylesheet" href="<%=luadoc.doclet.html.link('luadoc.css', 'files/'..file_doc.name)%>" type="text/css" />
+    <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
+</head>
+
+<body>
+<div id="container">
+
+<div id="product">
+    <div id="product_logo"></div>
+    <div id="product_name"><big><b></b></big></div>
+    <div id="product_description"></div>
+</div> <!-- id="product" -->
+
+<div id="main">
+
+<div id="navigation">
+<%=luadoc.doclet.html.include("menu.lp", { doc=doc, file_doc=file_doc })%>
+
+</div> <!-- id="navigation" -->
+
+<div id="content">
+
+<h1>File <code><%=file_doc.name%></code></h1>
+
+<%if file_doc.description then%>
+<p><%=file_doc.description%></p>
+<%end%>
+<%if file_doc.author then%>
+<p><b><%= #file_doc.author>1 and "Authors" or "Author" %>:</b>
+<table class="authors_list">
+<%for _, author in ipairs(file_doc.author) do%>
+    <tr><td class="name"><%= author %></td></tr>
+<%end%>
+</table>
+</p>
+<%end%>
+<%if file_doc.copyright then%>
+<p>Copyright &copy;<%=file_doc.copyright%></p>
+<%end%>
+<%if file_doc.release then%>
+<p><small><b>Release:</b> <%=file_doc.release%></small></p>
+<%end%>
+
+<%if #file_doc.functions > 0 then%>
+<h2>Functions</h2>
+<table class="function_list">
+<%for _, func_name in ipairs(file_doc.functions) do
+  local func_data = file_doc.functions[func_name]%>
+    <tr>
+    <td class="name" nowrap><%=func_data.private and "local " or ""%><a href="#<%=func_name%>"><%=func_name%></a>&nbsp;(<%=table.concat(func_data.param, ", ")%>)</td>
+    <td class="summary"><%=func_data.summary%></td>
+    </tr>
+<%end%>
+</table>
+<%end%>
+
+
+<%if #file_doc.tables > 0 then%>
+<h2>Tables</h2>
+<table class="table_list">
+<%for _, tab_name in ipairs(file_doc.tables) do%>
+    <tr>
+    <td class="name" nowrap><a href="#<%=tab_name%>"><%=tab_name%></a></td>
+    <td class="summary"><%=file_doc.tables[tab_name].summary%></td>
+    </tr>
+<%end%>
+</table>
+<%end%>
+
+
+<br/>
+<br/>
+
+
+
+<%if #file_doc.functions > 0 then%>
+<h2><a name="functions"></a>Functions</h2>
+<dl class="function">
+<%for _, func_name in ipairs(file_doc.functions) do%>
+<%=luadoc.doclet.html.include("function.lp", { doc=doc, file_doc=file_doc, func=file_doc.functions[func_name] })%>
+<%end%>
+</dl>
+<%end%>
+
+
+<%if #file_doc.tables > 0 then%>
+<h2><a name="tables"></a>Tables</h2>
+<dl class="table">
+<%for _, tab_name in ipairs(file_doc.tables) do%>
+<%=luadoc.doclet.html.include("table.lp", { doc=doc, file_doc=file_doc, tab=file_doc.tables[tab_name] })%>
+<%end%>
+</dl>
+<%end%>
+
+
+
+</div> <!-- id="content" -->
+
+</div> <!-- id="main" -->
+
+<div id="about">
+    <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
+</div> <!-- id="about" -->
+
+</div> <!-- id="container" -->
+</body>
+</html>