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
|
local fs = require 'bee.filesystem'
local fsu = require 'fs-utility'
local api = dofile('3rd/lovr-api/api/init.lua')
local metaPath = fs.path 'meta/3rd/lovr'
local libraryPath = metaPath / 'library'
fs.create_directories(libraryPath)
local knownTypes = {
['nil'] = 'nil',
['any'] = 'any',
['boolean'] = 'boolean',
['number'] = 'number',
['integer'] = 'integer',
['string'] = 'string',
['table'] = 'table',
['function'] = 'function',
['userdata'] = 'userdata',
['lightuserdata'] = 'lightuserdata',
['thread'] = 'thread',
['cdata'] = 'ffi.cdata*',
['light userdata'] = 'lightuserdata',
['Variant'] = 'any',
}
local function trim(name)
name = name:gsub('^%s+', '')
name = name:gsub('%s+$', '')
return name
end
---@param names string
local function getTypeName(names)
local types = {}
names = names:gsub('%sor%s', '|')
for name in names:gmatch '[^|]+' do
name = trim(name)
types[#types+1] = knownTypes[name] or ('lovr.' .. name)
end
return table.concat(types, '|')
end
local function formatIndex(key)
if key:match '^[%a_][%w_]*$' then
return key
end
return ('[%q]'):format(key)
end
local buildType
local function buildDocTable(tbl)
local fields = {}
for _, field in ipairs(tbl) do
if field.name ~= '...' then
fields[#fields+1] = ('%s: %s'):format(formatIndex(field.name), buildType(field))
end
end
return ('{%s}'):format(table.concat(fields, ', '))
end
function buildType(param)
if param.table then
return buildDocTable(param.table)
end
if param.type and param.type ~= '*' then
return getTypeName(param.type)
end
return 'any'
end
local function buildSuper(tp)
if not tp.supertypes then
return ''
end
local parents = {}
for _, parent in ipairs(tp.supertypes) do
parents[#parents+1] = getTypeName(parent)
end
return (': %s'):format(table.concat(parents, ', '))
end
local function buildDescription(desc)
if desc then
return ('---\n---%s\n---'):format(desc:gsub('([\r\n])', '%1---'))
else
return nil
end
end
local function buildDocFunc(variant)
local params = {}
local returns = {}
for _, param in ipairs(variant.arguments or {}) do
if param.name == '...' then
params[#params+1] = '...'
else
if param.name:find '^[\'"]' then
params[#params+1] = ('%s: %s|%q'):format(param.name:sub(2, -2), getTypeName(param.type), param.name)
else
params[#params+1] = ('%s: %s'):format(param.name, getTypeName(param.type))
end
end
end
for _, rtn in ipairs(variant.returns or {}) do
returns[#returns+1] = ('%s'):format(getTypeName(rtn.type))
end
return ('fun(%s)%s'):format(
table.concat(params, ', '),
#returns > 0 and (':' .. table.concat(returns, ', ')) or ''
)
end
local function buildMultiDocFunc(tp)
local cbs = {}
for _, variant in ipairs(tp.variants) do
cbs[#cbs+1] = buildDocFunc(variant)
end
return table.concat(cbs, '|')
end
local function buildFunction(func)
local text = {}
text[#text+1] = buildDescription(func.description)
for i = 2, #func.variants do
local variant = func.variants[i]
text[#text+1] = ('---@overload %s'):format(buildDocFunc(variant))
end
local params = {}
for _, param in ipairs(func.variants[1].arguments or {}) do
for paramName in param.name:gmatch '[%a_][%w_]*' do
params[#params+1] = paramName
text[#text+1] = ('---@param %s%s %s # %s'):format(
paramName,
param.default == nil and '' or '?',
buildType(param),
param.description
)
end
end
for _, rtn in ipairs(func.variants[1].returns or {}) do
for returnName in rtn.name:gmatch '[%a_][%w_]*' do
text[#text+1] = ('---@return %s %s # %s'):format(
buildType(rtn),
returnName,
rtn.description
)
end
end
text[#text+1] = ('function %s(%s) end'):format(
func.key,
table.concat(params, ', ')
)
return table.concat(text, '\n')
end
local function buildFile(defs)
local class = defs.key
local filePath = libraryPath / (class .. '.lua')
local text = {}
text[#text+1] = '---@meta'
text[#text+1] = ''
text[#text+1] = buildDescription(defs.description)
text[#text+1] = ('---@class %s'):format(class)
text[#text+1] = ('%s = {}'):format(class)
for _, func in ipairs(defs.functions or {}) do
text[#text+1] = ''
text[#text+1] = buildFunction(func)
end
for _, obj in ipairs(defs.objects or {}) do
local mark = {}
text[#text+1] = ''
text[#text+1] = buildDescription(obj.description)
text[#text+1] = ('---@class %s%s'):format(getTypeName(obj.name), buildSuper(obj))
text[#text+1] = ('local %s = {}'):format(obj.name)
for _, func in ipairs(obj.methods or {}) do
if not mark[func.name] then
mark[func.name] = true
text[#text+1] = ''
text[#text+1] = buildFunction(func)
end
end
end
for _, cb in ipairs(defs.callbacks or {}) do
text[#text+1] = ''
text[#text+1] = buildDescription(cb.description)
text[#text+1] = ('---@alias %s %s'):format(getTypeName(cb.name), buildMultiDocFunc(cb))
end
for _, enum in ipairs(defs.enums or {}) do
text[#text+1] = ''
text[#text+1] = buildDescription(enum.description)
text[#text+1] = ('---@class %s'):format(getTypeName(enum.name))
for _, constant in ipairs(enum.values) do
text[#text+1] = buildDescription(constant.description)
text[#text+1] = ('---@field %s integer'):format(formatIndex(constant.name))
end
end
if defs.version then
text[#text+1] = ''
text[#text+1] = ('return %s'):format(class)
end
text[#text+1] = ''
fsu.saveFile(filePath, table.concat(text, '\n'))
end
for _, module in ipairs(api.modules) do
buildFile(module)
end
|
