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
|
local lclient = require 'lclient'
local furi = require 'file-uri'
local ws = require 'workspace'
local files = require 'files'
local util = require 'utility'
local jsonb = require 'json-beautify'
local lang = require 'language'
local define = require 'proto.define'
local config = require 'config.config'
local await = require 'await'
local vm = require 'vm'
local guide = require 'parser.guide'
local getDesc = require 'core.hover.description'
local getLabel = require 'core.hover.label'
local doc2md = require 'cli.doc2md'
local progress = require 'progress'
local fs = require 'bee.filesystem'
local export = {}
---@async
local function packObject(source, mark)
if type(source) ~= 'table' then
return source
end
if not mark then
mark = {}
end
if mark[source] then
return
end
mark[source] = true
local new = {}
if (#source > 0 and next(source, #source) == nil)
or source.type == 'funcargs' then
new = {}
for i = 1, #source do
new[i] = packObject(source[i], mark)
end
else
for k, v in pairs(source) do
if k == 'type'
or k == 'name'
or k == 'start'
or k == 'finish'
or k == 'types' then
new[k] = packObject(v, mark)
end
end
if source.type == 'function' then
new['args'] = packObject(source.args, mark)
local _, _, max = vm.countReturnsOfFunction(source)
if max > 0 then
new.returns = {}
for i = 1, max do
local rtn = vm.getReturnOfFunction(source, i)
new.returns[i] = packObject(rtn)
end
end
new['view'] = getLabel(source)
end
if source.type == 'doc.type.table' then
new['fields'] = packObject(source.fields, mark)
end
if source.type == 'doc.field.name'
or source.type == 'doc.type.arg.name' then
new['[1]'] = packObject(source[1], mark)
new['view'] = source[1]
end
if source.type == 'doc.type.function' then
new['args'] = packObject(source.args, mark)
if source.returns then
new['returns'] = packObject(source.returns, mark)
end
end
if source.bindDocs then
new['desc'] = getDesc(source)
end
new['view'] = new['view'] or vm.getInfer(source):view(ws.rootUri)
end
return new
end
---@async
local function getExtends(source)
if source.type == 'doc.class' then
if not source.extends then
return nil
end
return packObject(source.extends)
end
if source.type == 'doc.alias' then
if not source.extends then
return nil
end
return packObject(source.extends)
end
end
---@async
---@param global vm.global
---@param results table
local function collectTypes(global, results)
if guide.isBasicType(global.name) then
return
end
local result = {
name = global.name,
type = 'type',
desc = nil,
defines = {},
fields = {},
}
for _, set in ipairs(global:getSets(ws.rootUri)) do
local uri = guide.getUri(set)
if files.isLibrary(uri) then
goto CONTINUE
end
result.defines[#result.defines+1] = {
type = set.type,
file = guide.getUri(set),
start = set.start,
finish = set.finish,
extends = getExtends(set),
}
result.desc = result.desc or getDesc(set)
::CONTINUE::
end
if #result.defines == 0 then
return
end
table.sort(result.defines, function (a, b)
if a.file ~= b.file then
return a.file < b.file
end
return a.start < b.start
end)
results[#results+1] = result
---@async
---@diagnostic disable-next-line: not-yieldable
vm.getClassFields(ws.rootUri, global, vm.ANY, function (source)
if source.type == 'doc.field' then
---@cast source parser.object
if files.isLibrary(guide.getUri(source)) then
return
end
local field = {}
result.fields[#result.fields+1] = field
if source.field.type == 'doc.field.name' then
field.name = source.field[1]
else
field.name = ('[%s]'):format(vm.getInfer(source.field):view(ws.rootUri))
end
field.type = source.type
field.file = guide.getUri(source)
field.start = source.start
field.finish = source.finish
field.desc = getDesc(source)
field.extends = packObject(source.extends)
return
end
if source.type == 'setfield'
or source.type == 'setmethod' then
---@cast source parser.object
if files.isLibrary(guide.getUri(source)) then
return
end
local field = {}
result.fields[#result.fields+1] = field
field.name = (source.field or source.method)[1]
field.type = source.type
field.file = guide.getUri(source)
field.start = source.start
field.finish = source.finish
field.desc = getDesc(source)
field.extends = packObject(source.value)
return
end
if source.type == 'tableindex' then
---@cast source parser.object
if source.index.type ~= 'string' then
return
end
if files.isLibrary(guide.getUri(source)) then
return
end
local field = {}
result.fields[#result.fields+1] = field
field.name = source.index[1]
field.type = source.type
field.file = guide.getUri(source)
field.start = source.start
field.finish = source.finish
field.desc = getDesc(source)
field.extends = packObject(source.value)
return
end
end)
table.sort(result.fields, function (a, b)
if a.name ~= b.name then
return a.name < b.name
end
if a.file ~= b.file then
return a.file < b.file
end
return a.start < b.start
end)
end
---@async
---@param global vm.global
---@param results table
local function collectVars(global, results)
local result = {
name = global:getCodeName(),
type = 'variable',
desc = nil,
defines = {},
}
for _, set in ipairs(global:getSets(ws.rootUri)) do
if set.type == 'setglobal'
or set.type == 'setfield'
or set.type == 'setmethod'
or set.type == 'setindex' then
result.defines[#result.defines+1] = {
type = set.type,
file = guide.getUri(set),
start = set.start,
finish = set.finish,
extends = packObject(set.value),
}
result.desc = result.desc or getDesc(set)
end
end
if #result.defines == 0 then
return
end
table.sort(result.defines, function (a, b)
if a.file ~= b.file then
return a.file < b.file
end
return a.start < b.start
end)
results[#results+1] = result
end
---@async
---@param callback fun(i, max)
function export.export(outputPath, callback)
local results = {}
local globals = vm.getAllGlobals()
local max = 0
for _ in pairs(globals) do
max = max + 1
end
local i = 0
for _, global in pairs(globals) do
if global.cate == 'variable' then
collectVars(global, results)
elseif global.cate == 'type' then
collectTypes(global, results)
end
i = i + 1
callback(i, max)
end
table.sort(results, function (a, b)
return a.name < b.name
end)
local docPath = outputPath .. '/doc.json'
jsonb.supportSparseArray = true
util.saveFile(docPath, jsonb.beautify(results))
local mdPath = doc2md.buildMD(outputPath)
return docPath, mdPath
end
---@async
---@param outputPath string
function export.makeDoc(outputPath)
ws.awaitReady(ws.rootUri)
local expandAlias = config.get(ws.rootUri, 'Lua.hover.expandAlias')
config.set(ws.rootUri, 'Lua.hover.expandAlias', false)
local _ <close> = function ()
config.set(ws.rootUri, 'Lua.hover.expandAlias', expandAlias)
end
await.sleep(0.1)
local prog <close> = progress.create(ws.rootUri, '正在生成文档...', 0)
local docPath, mdPath = export.export(outputPath, function (i, max)
prog:setMessage(('%d/%d'):format(i, max))
prog:setPercentage((i) / max * 100)
end)
return docPath, mdPath
end
function export.runCLI()
lang(LOCALE)
if type(DOC) ~= 'string' then
print(lang.script('CLI_CHECK_ERROR_TYPE', type(DOC)))
return
end
local rootUri = furi.encode(fs.absolute(fs.path(DOC)):string())
if not rootUri then
print(lang.script('CLI_CHECK_ERROR_URI', DOC))
return
end
print('root uri = ' .. rootUri)
util.enableCloseFunction()
local lastClock = os.clock()
---@async
lclient():start(function (client)
client:registerFakers()
client:initialize {
rootUri = rootUri,
}
io.write(lang.script('CLI_DOC_INITING'))
config.set(nil, 'Lua.diagnostics.enable', false)
config.set(nil, 'Lua.hover.expandAlias', false)
ws.awaitReady(rootUri)
await.sleep(0.1)
local docPath, mdPath = export.export(LOGPATH, function (i, max)
if os.clock() - lastClock > 0.2 then
lastClock = os.clock()
local output = '\x0D'
.. ('>'):rep(math.ceil(i / max * 20))
.. ('='):rep(20 - math.ceil(i / max * 20))
.. ' '
.. ('0'):rep(#tostring(max) - #tostring(i))
.. tostring(i) .. '/' .. tostring(max)
io.write(output)
end
end)
io.write('\x0D')
print(lang.script('CLI_DOC_DONE'
, ('[%s](%s)'):format(files.normalize(docPath), furi.encode(docPath))
, ('[%s](%s)'):format(files.normalize(mdPath), furi.encode(mdPath))
))
end)
end
return export
|