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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
|
local vm = require 'vm'
local ws = require 'workspace'
local markdown = require 'provider.markdown'
local config = require 'config'
local lang = require 'language'
local util = require 'utility'
local guide = require 'parser.guide'
local rpath = require 'workspace.require-path'
local furi = require 'file-uri'
local function collectRequire(mode, literal, uri)
local result, searchers
if mode == 'require' then
result, searchers = rpath.findUrisByRequireName(uri, literal)
elseif mode == 'dofile'
or mode == 'loadfile' then
result = ws.findUrisByFilePath(literal)
end
if result and #result > 0 then
local shows = {}
for i, uri in ipairs(result) do
local searcher = searchers and searchers[uri]
local path = ws.getRelativePath(uri)
if vm.isMetaFile(uri) then
shows[i] = ('* [[meta]](%s)'):format(uri)
elseif searcher then
searcher = searcher:gsub('^[/\\]+', '')
shows[i] = ('* [%s](%s) %s'):format(path, uri, lang.script('HOVER_USE_LUA_PATH', searcher))
else
shows[i] = ('* [%s](%s)'):format(path, uri)
end
end
table.sort(shows)
local md = markdown()
md:add('md', table.concat(shows, '\n'))
return md
end
end
local function asStringInRequire(source, literal)
local parent = source.parent
if parent and parent.type == 'callargs' then
local call = parent.parent
local func = call.node
local libName = vm.getLibraryName(func)
if not libName then
return
end
if libName == 'require'
or libName == 'dofile'
or libName == 'loadfile' then
return collectRequire(libName, literal, guide.getUri(source))
end
end
end
local function asStringView(source, literal)
-- 内部包含转义符?
if not source[2] then
return
end
local rawLen = source.finish - source.start - 2 * #source[2]
if config.get(guide.getUri(source), 'Lua.hover.viewString')
and (source[2] == '"' or source[2] == "'")
and rawLen > #literal then
local view = literal
local max = config.get(guide.getUri(source), 'Lua.hover.viewStringMax')
if #view > max then
view = view:sub(1, max) .. '...'
end
local md = markdown()
md:add('txt', view)
return md
end
end
local function asString(source)
local literal = guide.getLiteral(source)
if type(literal) ~= 'string' then
return nil
end
return asStringInRequire(source, literal)
or asStringView(source, literal)
end
---@param comment string
---@param suri uri
---@return string?
local function normalizeComment(comment, suri)
if not comment then
return nil
end
if comment:sub(1, 1) == '-' then
comment = comment:sub(2)
end
if comment:sub(1, 1) == '@' then
return nil
end
comment = comment:gsub('(%[.-%]%()(.-)(%))', function (left, path, right)
local scheme = furi.split(path)
if scheme
-- strange way to check `C:/xxx.lua`
and #scheme > 1 then
return
end
local absPath = ws.getAbsolutePath(suri:gsub('/[^/]+$', ''), path)
if not absPath then
return
end
local uri = furi.encode(absPath)
return left .. uri .. right
end)
return comment
end
local function getBindComment(source)
local uri = guide.getUri(source)
local lines = {}
for _, docComment in ipairs(source.bindComments) do
lines[#lines+1] = normalizeComment(docComment.comment.text, uri)
end
if not lines or #lines == 0 then
return nil
end
return table.concat(lines, '\n')
end
local function lookUpDocComments(source)
local docGroup = source.bindDocs
if not docGroup then
return
end
if source.type == 'setlocal'
or source.type == 'getlocal' then
source = source.node
end
if source.parent.type == 'funcargs' then
return
end
local uri = guide.getUri(source)
local lines = {}
for _, doc in ipairs(docGroup) do
if doc.type == 'doc.comment' then
lines[#lines+1] = normalizeComment(doc.comment.text, uri)
elseif doc.type == 'doc.type' then
if doc.comment then
lines[#lines+1] = normalizeComment(doc.comment.text, uri)
end
elseif doc.type == 'doc.class' then
for _, docComment in ipairs(doc.bindComments) do
lines[#lines+1] = normalizeComment(docComment.comment.text, uri)
end
end
end
if source.comment then
lines[#lines+1] = normalizeComment(source.comment.text, uri)
end
if not lines or #lines == 0 then
return nil
end
return table.concat(lines, '\n')
end
local function tryDocClassComment(source)
for _, def in ipairs(vm.getDefs(source)) do
if def.type == 'doc.class'
or def.type == 'doc.alias'
or def.type == 'doc.enum' then
local comment = getBindComment(def)
if comment then
return comment
end
end
end
end
local function tryDocModule(source)
if not source.module then
return
end
return collectRequire('require', source.module, guide.getUri(source))
end
local function buildEnumChunk(docType, name, uri)
if not docType then
return nil
end
local enums = {}
local types = {}
local lines = {}
for _, tp in ipairs(vm.getDefs(docType)) do
types[#types+1] = vm.getInfer(tp):view(guide.getUri(docType))
if tp.type == 'doc.type.string'
or tp.type == 'doc.type.integer'
or tp.type == 'doc.type.boolean'
or tp.type == 'doc.type.code' then
enums[#enums+1] = tp
end
local comment = tryDocClassComment(tp)
if comment then
for line in util.eachLine(comment) do
lines[#lines+1] = ('-- %s'):format(line)
end
end
end
if #enums == 0 then
return nil
end
lines[#lines+1] = ('%s:'):format(name)
for _, enum in ipairs(enums) do
local enumDes = (' %s %s'):format(
(enum.default and '->')
or (enum.additional and '+>')
or ' |',
vm.viewObject(enum, uri)
)
if enum.comment then
local first = true
local len = #enumDes
for comm in enum.comment:gmatch '[^\r\n]+' do
if first then
first = false
enumDes = ('%s -- %s'):format(enumDes, comm)
else
enumDes = ('%s\n%s -- %s'):format(enumDes, (' '):rep(len), comm)
end
end
end
lines[#lines+1] = enumDes
end
return table.concat(lines, '\n')
end
local function getBindEnums(source, docGroup)
if source.type ~= 'function' then
return
end
local uri = guide.getUri(source)
local mark = {}
local chunks = {}
local returnIndex = 0
for _, doc in ipairs(docGroup) do
if doc.type == 'doc.param' then
local name = doc.param[1]
if name == '...' then
name = '...(param)'
end
if mark[name] then
goto CONTINUE
end
mark[name] = true
chunks[#chunks+1] = buildEnumChunk(doc.extends, name, uri)
elseif doc.type == 'doc.return' then
for _, rtn in ipairs(doc.returns) do
returnIndex = returnIndex + 1
local name = rtn.name and rtn.name[1] or ('return #%d'):format(returnIndex)
if name == '...' then
name = '...(return)'
end
if mark[name] then
goto CONTINUE
end
mark[name] = true
chunks[#chunks+1] = buildEnumChunk(rtn, name, uri)
end
end
::CONTINUE::
end
if #chunks == 0 then
return nil
end
return table.concat(chunks, '\n\n')
end
local function tryDocFieldComment(source)
if source.type ~= 'doc.field' then
return
end
if source.comment then
return normalizeComment(source.comment.text, guide.getUri(source))
end
if source.bindGroup then
return getBindComment(source)
end
end
local function getFunctionComment(source)
local docGroup = source.bindDocs
if not docGroup then
return
end
local hasReturnComment = false
for _, doc in ipairs(source.bindDocs) do
if doc.type == 'doc.return' and doc.comment then
hasReturnComment = true
break
end
end
local uri = guide.getUri(source)
local md = markdown()
for _, doc in ipairs(docGroup) do
if doc.type == 'doc.comment' then
local comment = normalizeComment(doc.comment.text, uri)
md:add('md', comment)
elseif doc.type == 'doc.param' then
if doc.comment then
md:add('md', ('@*param* `%s` — %s'):format(
doc.param[1],
doc.comment.text
))
end
elseif doc.type == 'doc.return' then
if hasReturnComment then
local name = {}
for _, rtn in ipairs(doc.returns) do
if rtn.name then
name[#name+1] = rtn.name[1]
end
end
if doc.comment then
if #name == 0 then
md:add('md', ('@*return* — %s'):format(doc.comment.text))
else
md:add('md', ('@*return* `%s` — %s'):format(table.concat(name, ','), doc.comment.text))
end
else
if #name == 0 then
md:add('md', '@*return*')
else
md:add('md', ('@*return* `%s`'):format(table.concat(name, ',')))
end
end
end
elseif doc.type == 'doc.overload' then
md:splitLine()
end
end
local enums = getBindEnums(source, docGroup)
md:add('lua', enums)
local comment = md:string()
if comment == '' then
return nil
end
return comment
end
local function tryDocComment(source)
local md = markdown()
if source.type == 'function' then
local comment = getFunctionComment(source)
md:add('md', comment)
source = source.parent
end
local comment = lookUpDocComments(source)
md:add('md', comment)
if source.type == 'doc.alias' then
local enums = buildEnumChunk(source, source.alias[1], guide.getUri(source))
md:add('lua', enums)
end
if source.type == 'doc.enum' then
local enums = buildEnumChunk(source, source.enum[1], guide.getUri(source))
md:add('lua', enums)
end
local result = md:string()
if result == '' then
return nil
end
return result
end
local function tryDocOverloadToComment(source)
if source.type ~= 'doc.type.function' then
return
end
local doc = source.parent
if doc.type ~= 'doc.overload'
or not doc.bindSource then
return
end
local md = tryDocComment(doc.bindSource)
if md then
return md
end
end
local function tyrDocParamComment(source)
if source.type == 'setlocal'
or source.type == 'getlocal' then
source = source.node
end
if source.type ~= 'local' then
return
end
if source.parent.type ~= 'funcargs' then
return
end
if not source.bindDocs then
return
end
for i = #source.bindDocs, 1, -1 do
local doc = source.bindDocs[i]
if doc.type == 'doc.param'
and doc.param[1] == source[1]
and doc.comment then
return doc.comment.text
end
end
end
---@param source parser.object
local function tryDocEnum(source)
if source.type ~= 'doc.enum' then
return
end
local tbl = source.bindSource
if not tbl then
return
end
local md = markdown()
md:add('lua', '{')
for _, field in ipairs(tbl) do
if field.type == 'tablefield'
or field.type == 'tableindex' then
if not field.value then
goto CONTINUE
end
local key = guide.getKeyName(field)
if not key then
goto CONTINUE
end
if field.value.type == 'integer'
or field.value.type == 'string' then
md:add('lua', (' %s: %s = %s,'):format(key, field.value.type, field.value[1]))
end
if field.value.type == 'binary'
or field.value.type == 'unary' then
local number = vm.getNumber(field.value)
if number then
md:add('lua', (' %s: %s = %s,'):format(key, math.tointeger(number) and 'integer' or 'number', number))
end
end
::CONTINUE::
end
end
md:add('lua', '}')
return md:string()
end
return function (source)
if source.type == 'string' then
return asString(source)
end
if source.type == 'field' then
source = source.parent
end
return tryDocOverloadToComment(source)
or tryDocFieldComment(source)
or tyrDocParamComment(source)
or tryDocComment(source)
or tryDocClassComment(source)
or tryDocModule(source)
or tryDocEnum(source)
end
|