diff options
Diffstat (limited to '')
| -rw-r--r-- | MCServer/Plugins/APIDump/APIDump.deproj | 6 | ||||
| -rw-r--r-- | MCServer/Plugins/APIDump/main.lua | 144 |
2 files changed, 144 insertions, 6 deletions
diff --git a/MCServer/Plugins/APIDump/APIDump.deproj b/MCServer/Plugins/APIDump/APIDump.deproj new file mode 100644 index 000000000..0d6ad82fa --- /dev/null +++ b/MCServer/Plugins/APIDump/APIDump.deproj @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="utf-8"?> +<project> + <file> + <filename>main.lua</filename> + </file> +</project> diff --git a/MCServer/Plugins/APIDump/main.lua b/MCServer/Plugins/APIDump/main.lua index 853ff6301..d0a1da3b1 100644 --- a/MCServer/Plugins/APIDump/main.lua +++ b/MCServer/Plugins/APIDump/main.lua @@ -1,5 +1,7 @@ --- Global variables -PLUGIN = {}; -- Reference to own plugin object + +-- main.lua + +-- Implements the plugin entrypoint (in this case the entire plugin) @@ -7,8 +9,6 @@ PLUGIN = {}; -- Reference to own plugin object function Initialize(Plugin) - PLUGIN = Plugin - Plugin:SetName("APIDump") Plugin:SetVersion(1) @@ -17,6 +17,9 @@ function Initialize(Plugin) -- dump all available API functions and objects: DumpAPI(); + + -- Dump all available API objects in wiki-style tables: + DumpAPIWiki(); return true end @@ -33,9 +36,9 @@ function DumpAPI() if (type(v) == "table") then if (GetChar(i, 1) ~= ".") then if (v == _G) then - LOG(prefix .. i .. " == _G, CYCLE, ignoring"); + -- LOG(prefix .. i .. " == _G, CYCLE, ignoring"); elseif (v == _G.package) then - LOG(prefix .. i .. " == _G.package, ignoring"); + -- LOG(prefix .. i .. " == _G.package, ignoring"); else dump(prefix .. i .. ".", v, Output) end @@ -59,3 +62,132 @@ function DumpAPI() f:close(); LOG("API.txt written."); end + + + + +function DumpAPIWiki() + --[[ + We want an API table of the following shape: + local API = { + {"cCuboid", { + Functions = { + "Sort", + "IsInside" + }, + Constants = { + } + }}, + {"cBlockArea", { + Functions = { + "Clear", + "CopyFrom", + ... + } + Constants = { + {"baTypes", 0}, + {"baMetas", 1}, + ... + } + ... + }} + }; + local Globals = { + Functions = { + ... + }, + Constants = { + ... + } + }; + --]] + + LOG("Dumping all available functions and constants to API_wiki.txt..."); + + local Globals = {Functions = {}, Constants = {}}; + local API = {}; + + local function Add(a_APIContainer, a_ClassName, a_ClassObj) + if (type(a_ClassObj) == "function") then + table.insert(a_APIContainer.Functions, a_ClassName); + elseif (type(a_ClassObj) == "number") then + table.insert(a_APIContainer.Constants, {a_ClassName, a_ClassObj}); + end + end + + local function SortClass(a_ClassAPI) + -- Sort the function list and constant lists: + table.sort(a_ClassAPI.Functions); + table.sort(a_ClassAPI.Constants, + function(c1, c2) + return (c1[1] < c2[1]); + end + ); + end; + + local function ParseClass(a_ClassObj) + local res = {Functions = {}, Constants = {}}; + for i, v in pairs(a_ClassObj) do + Add(res, i, v); + end + + SortClass(res); + return res; + end + + for i, v in pairs(_G) do + if (type(v) == "table") then + -- It is a table - probably a class + local StartLetter = GetChar(i, 0); + if (StartLetter == "c") then + -- Starts with a "c", handle it as a MCS API class + table.insert(API, {i, ParseClass(v)}); + end + else + Add(Globals, i, v); + end + end + SortClass(Globals); + table.sort(API, + function(c1, c2) + return (c1[1] < c2[1]); + end + ); + + -- Now dump the whole thing into a file, formatted as a wiki table: + local function WriteClass(a_File, a_ClassAPI) + if (#a_ClassAPI.Functions > 0) then + a_File:write("Functions:\n"); + a_File:write("^ Function name ^ Parameters ^ Return value ^ Note ^\n"); + for i, n in ipairs(a_ClassAPI.Functions) do + a_File:write("| " .. n .. " | | | |\n"); + end + a_File:write("\n\n"); + end + + if (#a_ClassAPI.Constants > 0) then + a_File:write("Constants:\n"); + a_File:write("^ Constant ^ Value ^ Note ^\n"); + for i, n in ipairs(a_ClassAPI.Constants) do + a_File:write("| " .. n[1] .. " | " .. n[2] .. " | |\n"); + end + a_File:write("\n\n"); + end + end + + local f = io.open("API_wiki.txt", "w"); + for i, n in ipairs(API) do + f:write("Class " .. n[1] .. "\n"); + WriteClass(f, n[2]); + f:write("\n\n\n----------------\n"); + end + f:write("globals:\n"); + WriteClass(f, Globals); + f:close(); + + LOG("API_wiki.txt file written"); +end + + + + |