path: root/server/src/matcher/hover.lua

local findResult = require 'matcher.find_result'
local findLib    = require 'matcher.find_lib'

local OriginTypes = {
    ['any']      = true,
    ['nil']      = true,
    ['integer']  = true,
    ['number']   = true,
    ['boolean']  = true,
    ['string']   = true,
    ['thread']   = true,
    ['userdata'] = true,
    ['table']    = true,
    ['function'] = true,
}

local function buildLibArgs(lib, oo)
    if not lib.args then
        return ''
    end
    local start
    if oo then
        start = 2
    else
        start = 1
    end
    local strs = {}
    for i = start, #lib.args do
        local arg = lib.args[i]
        if arg.optional then
            if i > start then
                strs[#strs+1] = ' ['
            else
                strs[#strs+1] = '['
            end
        end
        if i > start then
            strs[#strs+1] = ', '
        end
        if arg.name then
            strs[#strs+1] = ('%s: '):format(arg.name)
        end
        if type(arg.type) == 'table' then
            strs[#strs+1] = table.concat(arg.type, '/')
        else
            strs[#strs+1] = arg.type or 'any'
        end
        if arg.default then
            strs[#strs+1] = ('(%q)'):format(arg.default)
        end
        if arg.optional == 'self' then
            strs[#strs+1] = ']'
        end
    end
    for _, arg in ipairs(lib.args) do
        if arg.optional == 'after' then
            strs[#strs+1] = ']'
        end
    end
    return table.concat(strs)
end

local function buildLibReturns(lib)
    if not lib.returns then
        return ''
    end
    local strs = {}
    for i, rtn in ipairs(lib.returns) do
        if rtn.optional then
            if i > 1 then
                strs[#strs+1] = ' ['
            else
                strs[#strs+1] = '['
            end
        end
        if i > 1 then
            strs[#strs+1] = ', '
        end
        if rtn.name then
            strs[#strs+1] = ('%s: '):format(rtn.name)
        end
        strs[#strs+1] = rtn.type or 'any'
        if rtn.default then
            strs[#strs+1] = ('(%q)'):format(rtn.default)
        end
        if rtn.optional == 'self' then
            strs[#strs+1] = ']'
        end
    end
    for _, rtn in ipairs(lib.returns) do
        if rtn.optional == 'after' then
            strs[#strs+1] = ']'
        end
    end
    return '\n  -> ' .. table.concat(strs)
end

local function buildEnum(lib)
    if not lib.enums then
        return ''
    end
    local container = table.container()
    for _, enum in ipairs(lib.enums) do
        if not enum.name or (not enum.enum and not enum.code) then
            goto NEXT_ENUM
        end
        if not container[enum.name] then
            container[enum.name] = {}
            if lib.args then
                for _, arg in ipairs(lib.args) do
                    if arg.name == enum.name then
                        container[enum.name].type = arg.type
                        break
                    end
                end
            end
            if lib.returns then
                for _, rtn in ipairs(lib.returns) do
                    if rtn.name == enum.name then
                        container[enum.name].type = rtn.type
                        break
                    end
                end
            end
        end
        table.insert(container[enum.name], enum)
        ::NEXT_ENUM::
    end
    local strs = {}
    for name, enums in pairs(container) do
        local tp
        if type(enums.type) == 'table' then
            tp = table.concat(enums.type, '/')
        else
            tp = enums.type
        end
        strs[#strs+1] = ('\n%s: %s'):format(name, tp or 'any')
        for _, enum in ipairs(enums) do
            if enum.default then
                strs[#strs+1] = '\n  -> '
            else
                strs[#strs+1] = '\n   | '
            end
            if enum.code then
                strs[#strs+1] = tostring(enum.code)
            else
                strs[#strs+1] = ('%q'):format(enum.enum)
            end
            if enum.description then
                strs[#strs+1] = ' -- ' .. enum.description
            end
        end
    end
    return table.concat(strs)
end

local function buildValueName(result, source)
    local func = result.value
    local declarat = func.declarat or source
    if declarat then
        local key
        if declarat.type == 'name' then
            key = declarat[1]
        elseif declarat.type == 'string' then
            key = ('%q'):format(declarat[1])
        elseif declarat.type == 'number' or declarat.type == 'boolean' then
            key = tostring(declarat[1])
        else
            key = '?'
        end

        local parentName = declarat.parentName

        if not parentName then
            return result.key or ''
        end

        if parentName == '?' then
            local parentType = result.parentValue and result.parentValue.type
            if parentType == 'table' then
            else
                parentName = '*' .. parentType
            end
        end
        if source.object then
            return parentName .. ':' .. key
        else
            if parentName then
                if declarat.index then
                    return parentName .. '[' .. key .. ']'
                else
                    return parentName .. '.' .. key
                end
            else
                return key
            end
        end
    end
    return result.key or ''
end

local function buildValueArgs(result, source)
    local func = result.value
    local names = {}
    local values = {}
    if func.args then
        for i, arg in ipairs(func.args) do
            if arg.type == '...' then
                names[i] = '...'
            else
                names[i] = arg.key
            end
        end
    end
    if func.argValues then
        for i, value in ipairs(func.argValues) do
            values[i] = value.type
        end
    end
    local strs = {}
    local start = 1
    if source.object then
        start = 2
    end
    for i = start, math.max(#names, #values) do
        local name = names[i] or '?'
        local value = values[i] or 'any'
        strs[#strs+1] = name .. ': ' .. value
    end
    return table.concat(strs, ', ')
end

local function buildValueReturns(result)
    local func = result.value
    if not func.hasReturn then
        return ''
    end
    local strs = {}
    for i, rtn in ipairs(func.returns) do
        strs[i] = rtn.type
    end
    return '\n  -> ' .. table.concat(strs, ', ')
end

local function getFunctionHover(name, result, source, lib, oo)
    local args = ''
    local returns
    local enum = ''
    local tip = ''
    if lib then
        args = buildLibArgs(lib, oo)
        returns = buildLibReturns(lib)
        enum = buildEnum(lib)
        tip = lib.description or ''
    else
        args = buildValueArgs(result, source)
        returns = buildValueReturns(result)
    end
    local title = ('function %s(%s)%s'):format(name, args, returns)
    return ([[
```lua
%s
```
%s
```lua
%s
```
]]):format(title, tip, enum)
end

local function findClass(result)
    -- 根据部分字段尝试找出自定义类型
    local metatable = result.value.metatable
    if not metatable or not metatable.child then
        return nil
    end
    -- 查找meta表的 __name 字段
    local name = metatable.child['__name']
    -- 值必须是字符串
    if name and name.value and type(name.value.value) == 'string' then
        return name.value.value
    end
    -- 查找meta表 __index 里的字段
    local index = metatable.child['__index']
    if index and index.value and index.value.child then
        for key, field in pairs(index.value.child) do
            -- 键值类型必须均为字符串
            if type(key) ~= 'string' then
                goto CONTINUE
            end
            if not field.value or type(field.value.value) ~= 'string' then
                goto CONTINUE
            end
            local lKey = key:lower()
            if lKey == 'type' or lKey == 'name' or lKey == 'class' then
                -- 必须只有过一次赋值
                local hasSet = false
                for _, info in ipairs(field) do
                    if info.type == 'set' then
                        if hasSet then
                            goto CONTINUE
                        end
                        hasSet = true
                    end
                end
                return field.value.value
            end
            ::CONTINUE::
        end
    end
    return nil
end

local function getValueHover(name, valueType, result, source, lib)
    if not lib then
        local class = findClass(result)
        if class then
            valueType = class
        end
    end

    if not OriginTypes[valueType] then
        valueType = '*' .. valueType
    end

    local value
    if lib then
        value = lib.value
    else
        value = result.value.value
    end

    local text
    if value == nil then
        text = ('%s %s'):format(valueType, name)
    else
        text = ('%s %s = %s'):format(valueType, name, value)
    end
    return ([[
```lua
%s
```
]]):format(text)
end

return function (vm, pos)
    local result, source = findResult(vm, pos)
    if not result then
        return nil
    end

    if not result.value then
        return
    end

    local lib, fullKey, oo = findLib(result)
    local valueType = lib and lib.type or result.value.type or 'nil'
    local name = fullKey or buildValueName(result, source)
    if valueType == 'function' then
        return getFunctionHover(name, result, source, lib, oo)
    else
        return getValueHover(name, valueType, result, source, lib)
    end
end