-- main.lua -- Implements the plugin entrypoint (in this case the entire plugin) -- Global variables: g_Plugin = nil; function Initialize(Plugin) g_Plugin = Plugin; Plugin:SetName("APIDump"); Plugin:SetVersion(1); LOG("Initialized " .. Plugin:GetName() .. " v." .. Plugin:GetVersion()) -- dump all available API functions and objects: -- DumpAPITxt(); -- Dump all available API object in HTML format into a subfolder: DumpAPIHtml(); return true end function DumpAPITxt() LOG("Dumping all available functions to API.txt..."); function dump (prefix, a, Output) for i, v in pairs (a) do if (type(v) == "table") then if (GetChar(i, 1) ~= ".") then if (v == _G) then -- LOG(prefix .. i .. " == _G, CYCLE, ignoring"); elseif (v == _G.package) then -- LOG(prefix .. i .. " == _G.package, ignoring"); else dump(prefix .. i .. ".", v, Output) end end elseif (type(v) == "function") then if (string.sub(i, 1, 2) ~= "__") then table.insert(Output, prefix .. i .. "()"); end end end end local Output = {}; dump("", _G, Output); table.sort(Output); local f = io.open("API.txt", "w"); for i, n in ipairs(Output) do f:write(n, "\n"); end f:close(); LOG("API.txt written."); end function CreateAPITables() --[[ We want an API table of the following shape: local API = { { Name = "cCuboid", Functions = { {Name = "Sort"}, {Name = "IsInside"} }, Constants = { } }}, { Name = "cBlockArea", Functions = { {Name = "Clear"}, {Name = "CopyFrom"}, ... } Constants = { {Name = "baTypes", Value = 0}, {Name = "baMetas", Value = 1}, ... } ... }} }; local Globals = { Functions = { ... }, Constants = { ... } }; --]] 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, {Name = a_ClassName}); elseif (type(a_ClassObj) == "number") then table.insert(a_APIContainer.Constants, {Name = a_ClassName, Value = a_ClassObj}); end end local function SortClass(a_ClassAPI) -- Sort the function list and constant lists: table.sort(a_ClassAPI.Functions, function(f1, f2) return (f1.Name < f2.Name); end ); table.sort(a_ClassAPI.Constants, function(c1, c2) return (c1.Name < c2.Name); end ); end; local function ParseClass(a_ClassName, a_ClassObj) local res = {Name = a_ClassName, 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, ParseClass(i, v)); end else Add(Globals, i, v); end end SortClass(Globals); table.sort(API, function(c1, c2) return (c1.Name < c2.Name); end ); return API, Globals; end function DumpAPIHtml() LOG("Dumping all available functions and constants to API subfolder..."); local API, Globals = CreateAPITables(); Globals.Name = "Globals"; table.insert(API, Globals); -- Read in the descriptions: ReadDescriptions(API); -- Create a "class index" file, write each class as a link to that file, -- then dump class contents into class-specific file local f = io.open("API/index.html", "w"); if (f == nil) then -- Create the output folder os.execute("mkdir API"); local err; f, err = io.open("API/index.html", "w"); if (f == nil) then LOGINFO("Cannot output HTML API: " .. err); return; end end f:write([[MCServer API - class index "); f:close(); LOG("API subfolder written"); end function ReadDescriptions(a_API) local UnexportedDocumented = {}; -- List of API objects that are documented but not exported, simply a list of names for i, cls in ipairs(a_API) do local APIDesc = g_APIDesc.Classes[cls.Name]; if (APIDesc ~= nil) then cls.Desc = APIDesc.Desc; cls.Inherits = APIDesc.Inherits; if (APIDesc.Functions ~= nil) then -- Assign function descriptions: for j, func in ipairs(cls.Functions) do -- func is {"FuncName"}, add Parameters, Return and Notes from g_APIDesc local FnDesc = APIDesc.Functions[func.Name]; if (FnDesc ~= nil) then func.Params = FnDesc.Params; func.Return = FnDesc.Return; func.Notes = FnDesc.Notes; FnDesc.IsExported = true; end end -- for j, func -- Add all non-exported function descriptions to UnexportedDocumented: for j, func in pairs(APIDesc.Functions) do -- TODO end end -- if (APIDesc.Functions ~= nil) if (APIDesc.Constants ~= nil) then -- Assign constant descriptions: for j, cons in ipairs(cls.Constants) do local CnDesc = APIDesc.Constants[cons.Name]; if (CnDesc ~= nil) then cons.Notes = CnDesc.Notes; CnDesc.IsExported = true; end end -- for j, cons -- Add all non-exported constant descriptions to UnexportedDocumented: for j, cons in pairs(APIDesc.Constants) do -- TODO end end -- if (APIDesc.Constants ~= nil) end end -- for i, class end function WriteHtmlClass(a_ClassAPI, a_AllAPI) local cf, err = io.open("API/" .. a_ClassAPI.Name .. ".html", "w"); if (cf == nil) then return; end local function LinkifyString(a_String) -- TODO: Make a link out of anything with the special linkifying syntax {{link|title}} -- a_String:gsub("{{([^|]*)|([^}])*}}", "%2"); return a_String; end -- Returns the ClassAPI for the inherited class, or nil if not found local function FindInheritedClassAPI(a_AllAPI, a_InheritedClassName) if (a_InheritedClassName == nil) then return nil; end for i, cls in ipairs(a_AllAPI) do if (cls.Name == a_InheritedClassName) then return cls; end end return nil; end -- Writes a table containing all functions in the specified list, with an optional "inherited from" header when a_InheritedName is valid local function WriteFunctions(a_Functions, a_InheritedName) if (#a_Functions == 0) then return; end if (a_InheritedName ~= nil) then cf:write("

Functions inherited from " .. a_InheritedName .. "

"); end cf:write("\n"); for i, func in ipairs(a_Functions) do cf:write(""); cf:write(""); cf:write(""); cf:write("\n"); end cf:write("
NameParametersReturn valueNotes
" .. func.Name .. "" .. LinkifyString(func.Params or "").. "" .. LinkifyString(func.Return or "").. "" .. LinkifyString(func.Notes or "") .. "
\n"); end -- Build an array of inherited classes chain: local InheritanceChain = {}; local CurrInheritance = FindInheritedClassAPI(a_AllAPI, a_ClassAPI.Inherits); while (CurrInheritance ~= nil) do table.insert(InheritanceChain, CurrInheritance); CurrInheritance = FindInheritedClassAPI(a_AllAPI, CurrInheritance.Inherits); end cf:write([[MCServer API - ]] .. a_ClassAPI.Name .. [[

Contents

"); -- Write the class description: cf:write("

" .. a_ClassAPI.Name .. " class

\n"); if (a_ClassAPI.Desc ~= nil) then cf:write("

"); cf:write(a_ClassAPI.Desc); cf:write("

\n"); end; -- Write the inheritance, if available: if (a_ClassAPI.Inherits ~= nil) then cf:write("

Inheritance

\n"); for i, cls in ipairs(InheritanceChain) do cf:write("
  • " .. cls.Name .. "
  • "); end end -- Write the constants: cf:write("

    Constants

    \n"); cf:write("\n"); for i, cons in ipairs(a_ClassAPI.Constants) do cf:write(""); cf:write(""); cf:write("\n"); end cf:write("
    NameValueNotes
    " .. cons.Name .. "" .. cons.Value .. "" .. LinkifyString(cons.Notes or "") .. "
    \n"); -- Write the functions, including the inherited ones: cf:write("

    Functions

    \n"); WriteFunctions(a_ClassAPI.Functions, nil); for i, cls in ipairs(InheritanceChain) do WriteFunctions(cls.Functions, cls.Name); end cf:write(""); cf:close(); end