path: root/server/src/core/completion.lua

local findSource = require 'core.find_source'
local getFunctionHover = require 'core.hover.function'
local getFunctionHoverAsLib = require 'core.hover.lib_function'
local sourceMgr = require 'vm.source'
local config = require 'config'
local State

local CompletionItemKind = {
    Text = 1,
    Method = 2,
    Function = 3,
    Constructor = 4,
    Field = 5,
    Variable = 6,
    Class = 7,
    Interface = 8,
    Module = 9,
    Property = 10,
    Unit = 11,
    Value = 12,
    Enum = 13,
    Keyword = 14,
    Snippet = 15,
    Color = 16,
    File = 17,
    Reference = 18,
    Folder = 19,
    EnumMember = 20,
    Constant = 21,
    Struct = 22,
    Event = 23,
    Operator = 24,
    TypeParameter = 25,
}

local KEYS = {'and', 'break', 'do', 'else', 'elseif', 'end', 'false', 'for', 'function', 'goto', 'if', 'in', 'local', 'nil', 'not', 'or', 'repeat', 'return', 'then', 'true', 'until', 'while'}
local KEYMAP = {}
for _, k in ipairs(KEYS) do
    KEYMAP[k] = true
end

local EMMY_KEYWORD = {'class', 'type', 'alias', 'param', 'return', 'field', 'generic', 'vararg', 'language', 'see'}

local function matchKey(me, other)
    if me == other then
        return true
    end
    if me == '' then
        return true
    end
    if #me > #other then
        return false
    end
    local lMe = me:lower()
    local lOther = other:lower()
    if lMe:sub(1, 1) ~= lOther:sub(1, 1) then
        return false
    end
    if lMe == lOther:sub(1, #lMe) then
        return true
    end
    local used = {}
    local cur = 1
    local lookup
    local researched
    for i = 1, #lMe do
        local c = lMe:sub(i, i)
        -- 1. 看当前字符是否匹配
        if c == lOther:sub(cur, cur) then
            used[cur] = true
            goto NEXT
        end
        -- 2. 看前一个字符是否匹配
        if not used[cur-1] then
            if c == lOther:sub(cur-1, cur-1) then
                used[cur-1] = true
                goto NEXT
            end
        end
        -- 3. 向后找这个字
        lookup = lOther:find(c, cur+1, true)
        if lookup then
            cur = lookup
            used[cur] = true
            goto NEXT
        end

        -- 4. 重新搜索整个字符串，但是只允许1次，否则失败.如果找不到也失败
        if researched then
            return false
        else
            researched = true
            for j = 1, cur - 2 do
                if c == lOther:sub(j, j) then
                    used[j] = true
                    goto NEXT
                end
            end
            return false
        end
        -- 5. 找到下一个可用的字，如果超出长度且把自己所有字都用尽就算成功
        ::NEXT::
        repeat
            cur = cur + 1
        until not used[cur]
        if cur > #lOther then
            return i == #lMe
        end
    end
    return true
end

local function getDucumentation(name, value)
    if value:getType() == 'function' then
        local lib = value:getLib()
        local hover
        if lib then
            hover = getFunctionHoverAsLib(name, lib)
        else
            hover = getFunctionHover(name, value:getFunction())
        end
        if not hover then
            return nil
        end
        local text = ([[
```lua
%s
```
%s
```lua
%s
```
]]):format(hover.label or '', hover.description or '', hover.enum or '')
        return {
            kind = 'markdown',
            value = text,
        }
    end
    return nil
end

local function getDetail(value)
    local literal = value:getLiteral()
    local tp = type(literal)
    if tp == 'boolean' then
        return ('= %q'):format(literal)
    elseif tp == 'string' then
        return ('= %q'):format(literal)
    elseif tp == 'number' then
        if math.type(literal) == 'integer' then
            return ('= %q'):format(literal)
        else
            local str = ('= %.16f'):format(literal)
            local dot = str:find('.', 1, true)
            local suffix = str:find('[0]+$', dot + 2)
            if suffix then
                return str:sub(1, suffix - 1)
            else
                return str
            end
        end
    end
    return nil
end

local function getKind(cata, value)
    if value:getType() == 'function' then
        local func = value:getFunction()
        if func and func:getObject() then
            return CompletionItemKind.Method
        else
            return CompletionItemKind.Function
        end
    end
    if cata == 'field' then
        local literal = value:getLiteral()
        local tp = type(literal)
        if tp == 'number' or tp == 'integer' or tp == 'string' then
            return CompletionItemKind.Enum
        end
    end
    return nil
end

local function getValueData(cata, name, value)
    return {
        documentation = getDucumentation(name, value),
        detail = getDetail(value),
        kind = getKind(cata, value),
    }
end

local function searchLocals(vm, source, word, callback)
    vm:eachSource(function (src)
        local loc = src:bindLocal()
        if not loc then
            return
        end

        if      src.start <= source.start
            and loc:close() >= source.finish
            and matchKey(word, loc:getName())
        then
            callback(loc:getName(), src, CompletionItemKind.Variable, getValueData('local', loc:getName(), loc:getValue()))
        end
    end)
end

local function sortPairs(t)
    local keys = {}
    for k in pairs(t) do
        keys[#keys+1] = k
    end
    table.sort(keys)
    local i = 0
    return function ()
        i = i + 1
        local k = keys[i]
        return k, t[k]
    end
end

local function searchFieldsByInfo(parent, word, source, map)
    parent:eachInfo(function (info, src)
        local k = info[1]
        if src == source then
            return
        end
        if map[k] then
            return
        end
        if KEYMAP[k] then
            return
        end
        if info.type ~= 'set child' and info.type ~= 'get child' then
            return
        end
        if type(k) ~= 'string' then
            return
        end
        local v = parent:getChild(k)
        if not v then
            return
        end
        if source:get 'object' and v:getType() ~= 'function' then
            return
        end
        if matchKey(word, k) then
            map[k] = v
        end
    end)
end

local function searchFieldsByChild(parent, word, source, map)
    parent:eachChild(function (k, v)
        if map[k] then
            return
        end
        if KEYMAP[k] then
            return
        end
        if not v:getLib() then
            return
        end
        if type(k) ~= 'string' then
            return
        end
        if source:get 'object' and v:getType() ~= 'function' then
            return
        end
        if matchKey(word, k) then
            map[k] = v
        end
    end)
end

local function searchFields(vm, source, word, callback)
    local parent = source:get 'parent'
    if not parent then
        return
    end
    local map = {}
    local current = parent
    for _ = 1, 3 do
        searchFieldsByInfo(current, word, source, map)
        current = current:getMetaMethod('__index')
        if not current then
            break
        end
    end
    searchFieldsByChild(parent, word, source, map)
    for k, v in sortPairs(map) do
        callback(k, nil, CompletionItemKind.Field, getValueData('field', k, v))
    end
end

local function searchIndex(vm, source, word, callback)
    vm:eachSource(function (src)
        if src:get 'table index' then
            if matchKey(word, src[1]) then
                callback(src[1], src, CompletionItemKind.Property)
            end
        end
    end)
end

local function searchCloseGlobal(vm, source, word, callback)
    local loc = source:bindLocal()
    if not loc then
        return
    end
    local close = loc:close()
    -- 因为闭包的关系落在局部变量finish到close范围内的全局变量一定能访问到该局部变量

    vm:eachSource(function (src)
        if      (src:get 'global' or src:bindLocal())
            and src.start >= source.finish
            and src.finish <= close
        then
            if matchKey(word, src[1]) then
                callback(src[1], src, CompletionItemKind.Variable)
            end
        end
    end)
end

local function searchKeyWords(vm, source, word, callback)
    for _, key in ipairs(KEYS) do
        if matchKey(word, key) then
            callback(key, nil, CompletionItemKind.Keyword)
        end
    end
end

local function searchGlobals(vm, source, word, callback)
    local global = vm.env:getValue()
    local map = {}
    local current = global
    for _ = 1, 3 do
        searchFieldsByInfo(current, word, source, map)
        current = current:getMetaMethod('__index')
        if not current then
            break
        end
    end
    searchFieldsByChild(global, word, source, map)
    for k, v in sortPairs(map) do
        callback(k, nil, CompletionItemKind.Field, getValueData('field', k, v))
    end
end

local function searchAsGlobal(vm, source, word, callback)
    if word == '' then
        return
    end
    searchLocals(vm, source, word, callback)
    searchFields(vm, source, word, callback)
    searchKeyWords(vm, source, word, callback)
end

local function searchAsKeyowrd(vm, source, word, callback)
    searchLocals(vm, source, word, callback)
    searchGlobals(vm, source, word, callback)
    searchKeyWords(vm, source, word, callback)
end

local function searchAsSuffix(vm, source, word, callback)
    searchFields(vm, source, word, callback)
end

local function searchAsIndex(vm, source, word, callback)
    searchLocals(vm, source, word, callback)
    searchIndex(vm, source, word, callback)
    searchFields(vm, source, word, callback)
end

local function searchAsLocal(vm, source, word, callback)
    searchCloseGlobal(vm, source, word, callback)
    -- 特殊支持 local function
    if matchKey(word, 'function') then
        callback('function', nil, CompletionItemKind.Keyword)
    end
    -- 特殊支持 local *toclose
    if word == '' and config.config.runtime.version == 'Lua 5.4' then
        callback('*toclose', nil, CompletionItemKind.Keyword)
    end
end

local function searchAsArg(vm, source, word, callback)
    searchCloseGlobal(vm, source, word, callback)
end

local function searchEmmyKeyword(vm, source, word, callback)
    for _, kw in ipairs(EMMY_KEYWORD) do
        if matchKey(word, kw) then
            callback(kw, nil, CompletionItemKind.Keyword)
        end
    end
end

local function searchEmmyClass(vm, source, word, callback)
    local classes = {}
    vm.emmyMgr:eachClass(function (class)
        if matchKey(word, class:getName()) then
            classes[#classes+1] = class
        end
    end)
    table.sort(classes, function (a, b)
        return a:getName() < b:getName()
    end)
    for _, class in ipairs(classes) do
        callback(class:getName(), class:getSource(), CompletionItemKind.Class)
    end
end

local function searchSource(vm, source, word, callback)
    if source.type == 'keyword' then
        searchAsKeyowrd(vm, source, word, callback)
        return
    end
    if source:get 'table index' then
        searchAsIndex(vm, source, word, callback)
        return
    end
    if source:get 'arg' then
        searchAsArg(vm, source, word, callback)
        return
    end
    if source:get 'global' then
        searchAsGlobal(vm, source, word, callback)
        return
    end
    if source:action() == 'local' then
        searchAsLocal(vm, source, word, callback)
        return
    end
    if source:bindLocal() then
        searchAsGlobal(vm, source, word, callback)
        return
    end
    if source:get 'simple' then
        searchAsSuffix(vm, source, word, callback)
        return
    end
    if source.type == 'emmyIncomplete' then
        searchEmmyKeyword(vm, source, word, callback)
        State.ignoreText = true
        return
    end
    if source:get 'target class' then
        searchEmmyClass(vm, source, word, callback)
        State.ignoreText = true
        return
    end
end

local function searchInRequire(vm, select, source, callback)
    if select ~= 1 then
        return
    end
    if not vm.lsp or not vm.lsp.workspace then
        return
    end
    if source.type ~= 'string' then
        return
    end
    local list, map = vm.lsp.workspace:matchPath(vm.uri, source[1])
    if not list then
        return
    end
    for _, str in ipairs(list) do
        callback(str, nil, CompletionItemKind.Reference, {
            documentation = map[str],
            textEdit = {
                -- TODO 坑爹自动完成的字符串里面不能包含符号
                -- 这里长字符串会出问题，不过暂时先这样吧
                start = source.start + 1,
                finish = source.finish - 1,
                newText = str,
            }
        })
    end
end

local function searchCallArg(vm, source, word, callback, pos)
    local results = {}
    vm:eachSource(function (src)
        if      src.type == 'call'
            and src.start <= pos
            and src.finish >= pos
        then
            results[#results+1] = src
        end
    end)
    if #results == 0 then
        return nil
    end
    -- 可能处于 'func1(func2(' 的嵌套中，将最近的call放到最前面
    table.sort(results, function (a, b)
        return a.start > b.start
    end)
    local call = results[1]
    local args = call:bindCall()
    if not args then
        return
    end

    local value = call:findCallFunction()
    if not value then
        return
    end

    local lib = value:getLib()
    if not lib then
        return
    end

    local select = #args + 1
    for i, arg in ipairs(args) do
        if arg.start <= pos and arg.finish >= pos - 1 then
            select = i
            break
        end
    end

    -- 根据参数位置找枚举值
    if lib.args and lib.enums then
        local arg = lib.args[select]
        local name = arg and arg.name
        for _, enum in ipairs(lib.enums) do
            if enum.name == name and enum.enum then
                if matchKey(word, enum.enum) then
                    local label, textEdit
                    if source.type ~= arg.type then
                        label = ('%q'):format(enum.enum)
                    end
                    if source.type ~= 'call' then
                        textEdit = {
                            start = source.start,
                            finish = source.finish,
                            newText = ('%q'):format(enum.enum),
                        }
                    end
                    callback(enum.enum, nil, CompletionItemKind.EnumMember, {
                        label = label,
                        documentation = enum.description,
                        textEdit = textEdit,
                    })
                end
            end
        end
    end

    -- 搜索特殊函数
    if lib.special == 'require' then
        searchInRequire(vm, select, source, callback)
    end
end

local function searchAllWords(vm, source, word, callback, pos)
    if word == '' then
        return
    end
    if source.type == 'string' then
        return
    end
    vm:eachSource(function (src)
        if      src.type == 'name'
            and not (src.start <= pos and src.finish >= pos)
            and matchKey(word, src[1])
        then
            callback(src[1], src, CompletionItemKind.Text)
        end
    end)
end

local function searchSpecialHashSign(vm, pos, callback)
    -- 尝试 XXX[#XXX+1]
    -- 1. 搜索 []
    local index
    vm:eachSource(function (src)
        if      src.type == 'index'
            and src.start <= pos
            and src.finish >= pos
        then
            index = src
            return true
        end
    end)
    if not index then
        return nil
    end
    -- 2. [] 内部只能有一个 #
    local inside = index[1]
    if not inside then
        return nil
    end
    if inside.op ~= '#' then
        return nil
    end
    -- 3. [] 左侧必须是纯 name 构成的 simple ,且index 是 simple 的最后一项
    local simple = index:get 'simple'
    if not simple then
        return nil
    end
    if simple[#simple] ~= index then
        return nil
    end
    local chars = {}
    for i = 1, #simple - 1 do
        local src = simple[i]
        if src.type == 'name' then
            chars[#chars+1] = src[1]
        elseif src.type == '.' then
            chars[#chars+1] = '.'
        else
            return nil
        end
    end
    -- 4. 创建代码片段
    if simple:get 'as action' then
        local label = table.concat(chars) .. '+1'
        callback(label, nil, CompletionItemKind.Snippet, {
            textEdit = {
                start = inside.start + 1,
                finish = index.finish,
                newText = ('%s] = '):format(label),
            },
        })
    else
        local label = table.concat(chars)
        callback(label, nil, CompletionItemKind.Snippet, {
            textEdit = {
                start = inside.start + 1,
                finish = index.finish,
                newText = ('%s]'):format(label),
            },
        })
    end
end

local function searchSpecial(vm, source, word, callback, pos)
    searchSpecialHashSign(vm, pos, callback)
end

local function makeList(source, pos, word)
    local list = {}
    local mark = {}
    return function (name, src, kind, data)
        if src == source then
            return
        end
        if word == name then
            if src and src.start <= pos and src.finish >= pos then
                return
            end
        end
        if mark[name] then
            return
        end
        mark[name] = true
        if not data then
            data = {}
        end
        if not data.label then
            data.label = name
        end
        if not data.kind then
            data.kind = kind
        end
        list[#list+1] = data
    end, list
end

local function searchToclose(text, source, word, callback)
    local pos = source.start
    if text:sub(pos-1, pos-1) ~= '*' then
        return false
    end
    if not matchKey(word, 'toclose') then
        return false
    end
    for i = pos-1, 1, -1 do
        if text:sub(i, i):match '[^%s%c]' then
            if text:sub(i - #'local' + 1, i) == 'local' then
                callback('toclose', nil, CompletionItemKind.Keyword)
                return true
            else
                return false
            end
        end
    end
    return false
end

local function keywordSource(vm, word, pos)
    if not KEYMAP[word] then
        return nil
    end
    return vm:instantSource {
        type   = 'keyword',
        start  = pos,
        finish = pos + #word - 1,
        [1]    = word,
    }
end

local function findStartPos(pos, buf)
    local res = nil
    for i = pos, 1, -1 do
        local c = buf:sub(i, i)
        if c:find '[%w_]' then
            res = i
        else
            break
        end
    end
    if not res then
        for i = pos, 1, -1 do
            local c = buf:sub(i, i)
            if c == '.' or c == ':' or c == '|' then
                res = i
                break
            elseif c == '#' or c == '@' then
                res = i + 1
                break
            elseif c:find '[%s%c]' then
            else
                break
            end
        end
    end
    if not res then
        return pos
    end
    return res
end

local function findWord(position, text)
    local word = text
    for i = position, 1, -1 do
        local c = text:sub(i, i)
        if not c:find '[%w_]' then
            word = text:sub(i+1, position)
            break
        end
    end
    return word:match('^([%w_]*)')
end

local function getSource(vm, pos, text, filter)
    local word = findWord(pos, text)
    local source = findSource(vm, pos, filter)
    if source then
        return source, pos, word
    end
    pos = findStartPos(pos, text)
    source = findSource(vm, pos,   filter)
          or keywordSource(vm, word, pos)
    return source, pos, word
end

return function (vm, text, pos, oldText)
    local filter = {
        ['name']           = true,
        ['string']         = true,
        ['.']              = true,
        [':']              = true,
        ['emmyName']       = true,
        ['emmyIncomplete'] = true,
        ['call']           = true,
    }
    local source, pos, word = getSource(vm, pos, text, filter)
    if not source then
        return nil
    end
    if oldText then
        local oldWord = oldText:sub(source.start, source.finish)
        if word:sub(1, #oldWord) ~= oldWord then
            return nil
        end
    end
    State = {}
    local callback, list = makeList(source, pos, word)
    if searchToclose(text, source, word, callback) then
        return list
    end
    searchSpecial(vm, source, word, callback, pos)
    searchCallArg(vm, source, word, callback, pos)
    searchSource(vm, source, word, callback)
    if not oldText or #list > 0 then
        if not State.ignoreText then
            searchAllWords(vm, source, word, callback, pos)
        end
    end

    if #list == 0 then
        return nil
    end

    return list
end