[教程源码] [Lua插件开发]07. 遍历获取LuaAuxLib函数库命令

-- 插件框架部分代码较多, 这里就不写了, 详见插件开发标准或本贴末尾的完整代码
function zimao.ScanLuaAuxLib()
    -- 以保护模式运行, 避免插件错误造成脚本终止
    try {
        function()
            -- 遍历LuaAuxLib内的内容
            for k, v in pairs(LuaAuxLib) do
                -- 使用自定义函数traceprint在按键精灵中打印函数名
                traceprint("名称: " .. k, "类型: " .. type(v))
            end
        end,
        catch {
            function (errors)
                traceprint("发生运行时错误！错误代码：ScanLuaAuxLib()，错误信息：", errors)
            end
        }
    }
end

local _zimao = {} --这是内部私有table函数
local zimao = {} --这是对外公开table函数
QMPlugin = zimao --通过这行代码, 实现将zimao表中所有函数对外公开

_zimao.version = "20220306" --插件版本号, 方便自己记忆

local function try(block) -- 保护执行函数
    local tablejoin = function (...)
        local result = {}
        for _, t in ipairs({...}) do
            if type(t) == "table" then
                for k, v in pairs(t) do
                    if type(k) == "number" then table.insert(result, v)
                    else result[k] = v end
                end
            else
                table.insert(result, t)
            end
        end
        return result
    end
         
    -- get the try function
    local try = block[1]
    assert(try)
     
    -- get catch and finally functions
    local funcs = tablejoin(block[2] or {}, block[3] or {})
     
    -- try to call it
    local result_error = {}
    local results = {pcall(try)}
    if not results[1] then
        -- run the catch function
        if funcs and funcs.catch then
            result_error = {funcs.catch(results[2])}
        end
    end
 
    -- run the finally function
    if funcs and funcs.finally then
        local result_fin = {funcs.finally(table.unpack(results))}
        if #result_fin > 0 then
            return table.unpack(result_fin)
        end
    end
 
    -- ok?
    if results[1] and #results > 1 then
        return table.unpack(results, 2, #results)
    else
        if #result_error > 0 then
            return table.unpack(result_error)
        else
            return nil
        end
    end
end
local function catch(block) --异常捕获函数
    return {catch = block[1]}
end
local function finally(block) --最终必定执行函数
    return {finally = block[1]}
end

-- 常用的内部函数, 不加入私有table中, 直接定义使用
local function traceprint(...)  --调用按键精灵的调试输出命令
    if QMPlugin then -- 在Lua调试环境下, QMPlugin变量的值是我们插件公开table函数值, 而在按键精灵调试运行环境下, 该变量值被替换为nil
        print(...)
    else
        -- 获取可变长参数的第一个参数值
        local line = select(1, ...)
        -- 如果第一个参数是字符串, 并且符合格式 _数字 , 则判定为行号意思
        if type(line) == "string" and line:match("^%_%d+$") then
            -- 第一个参数按照格式 _数字: 传入TracePrint中可实现打印行号功能
            LuaAuxLib.TracePrint(line .. ":", table.concat({...}, " ", 2, select("#", ...)))
        elseif line == ":" and #{...} > 1 then
            -- 第一个参数是冒号 : 时, 表示直接打印输出数据
            LuaAuxLib.TracePrint(":", table.concat({...}, " ", 2, select("#", ...)))
        else
            -- 其他的情况下则加上前缀后, 进行正常输出
            LuaAuxLib.TracePrint(":","紫猫学院测试插件：", ...)
        end
    end
end

-- 实现获取变量信息的插件函数, 需对外公开, 所以使用zimao前缀
function zimao.VarInfo(...)
    -- 防止无法获取nil参数
    local paramCount = select("#", ...)
    local varType, printStr, t = "", "", {}
    for i = 1, paramCount do
        local v = select(i, ...)
        try {
            function()
                varType = type(v)
                if varType == "table" then
                    printStr = "【" .. varType .." " .. tostring(#v) .. "】" .. LuaAuxLib.Encode_GetJsonLib():encode(v)
                elseif varType == "number" or varType == "string" then
                    printStr = "【" .. varType .." " .. tostring(#tostring(v)) .. "】" .. tostring(v)
                elseif varType == "boolean" or varType == "null" then
                    printStr = "【" .. varType .."】" .. tostring(v)
                else
                    printStr = "【" .. varType .."】 未知数据，无法查看！"
                end
                table.insert( t, #t + 1, printStr )
            end,
            catch {
                function (errors)
                    -- 下面这个traceprint是我们上面定义过的内部输出命令，注意大小写
                    traceprint("发生运行时错误！错误代码：VarInfo()，错误信息：", errors)
                end
            }
        }
    end
    printStr = table.concat( t, ", " )
    return printStr
end

-- 实现打印输出变量详细信息数据, 需对外公开
function zimao.TracePrint(...)
    -- 通过VarInfo函数获取参数的详细数据信息
    local info = zimao.VarInfo(...)
    try {
        function()
            -- 在保护模式下打印输出这个数据内容
            traceprint(info)
        end,
        catch {
            function (errors)
                traceprint("发生运行时错误！错误代码：TracePrint()，错误信息：", errors)
            end
        }
    }
end

function zimao.ScanLuaAuxLib()
    -- 以保护模式运行, 避免插件错误造成脚本终止
    try {
        function()
            -- 遍历LuaAuxLib内的内容
            for k, v in pairs(LuaAuxLib) do
                -- 使用自定义函数traceprint在按键精灵中打印函数名
                traceprint("名称: " .. k, "类型: " .. type(v))
            end
        end,
        catch {
            function (errors)
                traceprint("发生运行时错误！错误代码：ScanLuaAuxLib()，错误信息：", errors)
            end
        }
    }
end