summaryrefslogtreecommitdiff
path: root/script/src/core/hover/lib_function.lua
blob: 060873121f2ada36fa7584fe91c744e08694f816 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
local lang = require 'language'
local config = require 'config'
local function buildLibArgs(lib, object, select)
    if not lib.args then
        return ''
    end
    local start
    if object then
        start = 2
    else
        start = 1
    end
    local strs = {}
    local args = {}
    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

        local argStr = {}
        if i == select then
            argStr[#argStr+1] = '@ARG'
        end
        local name = ''
        if arg.name then
            name = ('%s: '):format(arg.name)
        end
        if type(arg.type) == 'table' then
            name = name .. table.concat(arg.type, '/')
        else
            name = name .. (arg.type or 'any')
        end
        argStr[#argStr+1] = name
        args[#args+1] = name
        if arg.default then
            argStr[#argStr+1] = ('(%q)'):format(arg.default)
        end
        if i == select then
            argStr[#argStr+1] = '@ARG'
        end

        for _, str in ipairs(argStr) do
            strs[#strs+1] = str
        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
    local text = table.concat(strs)
    local argLabel = {}
    for i = 1, 2 do
        local pos = text:find('@ARG', 1, true)
        if pos then
            if i == 1 then
                argLabel[i] = pos
            else
                argLabel[i] = pos - 1
            end
            text = text:sub(1, pos-1) .. text:sub(pos+4)
        end
    end
    if #argLabel == 0 then
        argLabel = nil
    end
    return text, argLabel, args
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] = ('\n% 3d. '):format(i)
        end
        if rtn.name then
            strs[#strs+1] = ('%s: '):format(rtn.name)
        end
        if type(rtn.type) == 'table' then
            strs[#strs+1] = table.concat(rtn.type, '/')
        else
            strs[#strs+1] = rtn.type or 'any'
        end
        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 = {}
    local raw = {}
    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')
        raw[name] = {}
        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] = tostring(enum.enum)
            end
            raw[name][#raw[name]+1] = strs[#strs]
            if enum.description then
                strs[#strs+1] = ' -- ' .. enum.description
            end
        end
    end
    return table.concat(strs), raw
end

local function buildDoc(lib)
    local doc = lib.doc
    if not doc then
        return
    end
    if lib.web then
        return lang.script(lib.web, doc)
    end
    local version = config.config.runtime.version
    if version == 'Lua 5.1' then
        return lang.script('HOVER_DOCUMENT_LUA51', doc)
    elseif version == 'Lua 5.2' then
        return lang.script('HOVER_DOCUMENT_LUA52', doc)
    elseif version == 'Lua 5.3' then
        return lang.script('HOVER_DOCUMENT_LUA53', doc)
    elseif version == 'Lua 5.4' then
        return lang.script('HOVER_DOCUMENT_LUA54', doc)
    elseif version == 'LuaJIT' then
        return lang.script('HOVER_DOCUMENT_LUAJIT', doc)
    end
end

return function (name, lib, object, select)
    local argStr, argLabel, args = buildLibArgs(lib, object, select)
    local returns = buildLibReturns(lib)
    local enum, rawEnum = buildEnum(lib)
    local tip = lib.description
    local doc = buildDoc(lib)
    return {
        label = ('function %s(%s)%s'):format(name, argStr, returns),
        name = name,
        argStr = argStr,
        returns = returns,
        description = tip,
        enum = enum,
        rawEnum = rawEnum,
        argLabel = argLabel,
        doc = doc,
        args = args,
    }
end