-
Notifications
You must be signed in to change notification settings - Fork 8
/
doclinks.lua
416 lines (390 loc) · 17.6 KB
/
doclinks.lua
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
--[[
Documentation link scanner for the syntax highlighters in the LXSH module.
Author: Peter Odding <peter@peterodding.com>
Last Change: July 16, 2011
URL: http://peterodding.com/code/lua/lxsh/
]]
local include_all_manpages = false
-- This script uses the LuaSocket module to download the
-- Lua 5.1 reference manual and the Lua/APR documentation.
local http = require 'socket.http'
-- Downloaded pages are cached in the following directory.
local tempdir = os.getenv('TEMP') or os.getenv('TMP') or '/tmp'
function message(...)
io.stderr:write(string.format(...), '\n')
end
function download(url)
local fname = tempdir .. '/' .. url:gsub('[^A-Za-z0-9_.-]', function(chr)
return string.format('%%%02x', chr:byte())
end)
local handle = io.open(fname)
if handle then
message("Using cached %s ..", url)
return handle:read '*a'
else
handle = io.open(fname, 'w')
message("Fetching %s ..", url)
local html = http.request(url)
handle:write(html)
handle:close()
return html
end
end
-- Manually defined documentation links (LPeg & C standard library). {{{1
local c_docs = {
abort = "http://linux.die.net/man/3/abort",
abs = "http://linux.die.net/man/3/abs",
acos = "http://linux.die.net/man/3/acos",
acosf = "http://linux.die.net/man/3/acosf",
acosl = "http://linux.die.net/man/3/acosl",
asctime = "http://linux.die.net/man/3/asctime",
asin = "http://linux.die.net/man/3/asin",
asinf = "http://linux.die.net/man/3/asinf",
asinl = "http://linux.die.net/man/3/asinl",
assert = "http://linux.die.net/man/3/assert",
atan = "http://linux.die.net/man/3/atan",
atan2 = "http://linux.die.net/man/3/atan2",
atan2f = "http://linux.die.net/man/3/atan2f",
atan2l = "http://linux.die.net/man/3/atan2l",
atanf = "http://linux.die.net/man/3/atanf",
atanl = "http://linux.die.net/man/3/atanl",
atexit = "http://linux.die.net/man/3/atexit",
atof = "http://linux.die.net/man/3/atof",
atoi = "http://linux.die.net/man/3/atoi",
atol = "http://linux.die.net/man/3/atol",
bsearch = "http://linux.die.net/man/3/bsearch",
calloc = "http://linux.die.net/man/3/calloc",
ceil = "http://linux.die.net/man/3/ceil",
ceilf = "http://linux.die.net/man/3/ceilf",
ceill = "http://linux.die.net/man/3/ceill",
clearerr = "http://linux.die.net/man/3/clearerr",
clock = "http://linux.die.net/man/3/clock",
cos = "http://linux.die.net/man/3/cos",
cosf = "http://linux.die.net/man/3/cosf",
cosh = "http://linux.die.net/man/3/cosh",
coshf = "http://linux.die.net/man/3/coshf",
coshl = "http://linux.die.net/man/3/coshl",
cosl = "http://linux.die.net/man/3/cosl",
ctime = "http://linux.die.net/man/3/ctime",
difftime = "http://linux.die.net/man/3/difftime",
div = "http://linux.die.net/man/3/div",
div_t = "http://linux.die.net/man/3/div_t",
EDOM = "http://linux.die.net/man/3/EDOM",
EILSEQ = "http://linux.die.net/man/3/EILSEQ",
ERANGE = "http://linux.die.net/man/3/ERANGE",
errno = "http://linux.die.net/man/3/errno",
exit = "http://linux.die.net/man/3/exit",
exp = "http://linux.die.net/man/3/exp",
expf = "http://linux.die.net/man/3/expf",
expl = "http://linux.die.net/man/3/expl",
fabs = "http://linux.die.net/man/3/fabs",
fabsf = "http://linux.die.net/man/3/fabsf",
fabsl = "http://linux.die.net/man/3/fabsl",
fclose = "http://linux.die.net/man/3/fclose",
feof = "http://linux.die.net/man/3/feof",
ferror = "http://linux.die.net/man/3/ferror",
fflush = "http://linux.die.net/man/3/fflush",
fgetc = "http://linux.die.net/man/3/fgetc",
fgetpos = "http://linux.die.net/man/3/fgetpos",
fgets = "http://linux.die.net/man/3/fgets",
floor = "http://linux.die.net/man/3/floor",
floorf = "http://linux.die.net/man/3/floorf",
floorl = "http://linux.die.net/man/3/floorl",
fmod = "http://linux.die.net/man/3/fmod",
fmodf = "http://linux.die.net/man/3/fmodf",
fmodl = "http://linux.die.net/man/3/fmodl",
fopen = "http://linux.die.net/man/3/fopen",
fpos_t = "http://linux.die.net/man/3/fpos_t",
fprintf = "http://linux.die.net/man/3/fprintf",
fputc = "http://linux.die.net/man/3/fputc",
fputs = "http://linux.die.net/man/3/fputs",
fread = "http://linux.die.net/man/3/fread",
free = "http://linux.die.net/man/3/free",
freopen = "http://linux.die.net/man/3/freopen",
frexp = "http://linux.die.net/man/3/frexp",
frexpf = "http://linux.die.net/man/3/frexpf",
frexpl = "http://linux.die.net/man/3/frexpl",
fscanf = "http://linux.die.net/man/3/fscanf",
fseek = "http://linux.die.net/man/3/fseek",
fsetpos = "http://linux.die.net/man/3/fsetpos",
ftell = "http://linux.die.net/man/3/ftell",
fwrite = "http://linux.die.net/man/3/fwrite",
getc = "http://linux.die.net/man/3/getc",
getchar = "http://linux.die.net/man/3/getchar",
getenv = "http://linux.die.net/man/3/getenv",
gets = "http://linux.die.net/man/3/gets",
gmtime = "http://linux.die.net/man/3/gmtime",
HUGE_VAL = "http://linux.die.net/man/3/HUGE_VAL",
isalnum = "http://linux.die.net/man/3/isalnum",
isalpha = "http://linux.die.net/man/3/isalpha",
iscntrl = "http://linux.die.net/man/3/iscntrl",
isdigit = "http://linux.die.net/man/3/isdigit",
isgraph = "http://linux.die.net/man/3/isgraph",
islower = "http://linux.die.net/man/3/islower",
isprint = "http://linux.die.net/man/3/isprint",
ispunct = "http://linux.die.net/man/3/ispunct",
isspace = "http://linux.die.net/man/3/isspace",
isupper = "http://linux.die.net/man/3/isupper",
isxdigit = "http://linux.die.net/man/3/isxdigit",
jmp_buf = "http://linux.die.net/man/3/jmp_buf",
labs = "http://linux.die.net/man/3/labs",
LC_ALL = "http://linux.die.net/man/3/LC_ALL",
LC_COLLATE = "http://linux.die.net/man/3/LC_COLLATE",
LC_CTYPE = "http://linux.die.net/man/3/LC_CTYPE",
LC_MONETARY = "http://linux.die.net/man/3/LC_MONETARY",
LC_NUMERIC = "http://linux.die.net/man/3/LC_NUMERIC",
LC_TIME = "http://linux.die.net/man/3/LC_TIME",
lconv = "http://linux.die.net/man/3/lconv",
ldexp = "http://linux.die.net/man/3/ldexp",
ldexpf = "http://linux.die.net/man/3/ldexpf",
ldexpl = "http://linux.die.net/man/3/ldexpl",
ldiv = "http://linux.die.net/man/3/ldiv",
ldiv_t = "http://linux.die.net/man/3/ldiv_t",
localeconv = "http://linux.die.net/man/3/localeconv",
localtime = "http://linux.die.net/man/3/localtime",
log = "http://linux.die.net/man/3/log",
log10 = "http://linux.die.net/man/3/log10",
log10f = "http://linux.die.net/man/3/log10f",
log10l = "http://linux.die.net/man/3/log10l",
logf = "http://linux.die.net/man/3/logf",
logl = "http://linux.die.net/man/3/logl",
longjmp = "http://linux.die.net/man/3/longjmp",
malloc = "http://linux.die.net/man/3/malloc",
mblen = "http://linux.die.net/man/3/mblen",
mbstowcs = "http://linux.die.net/man/3/mbstowcs",
mbtowc = "http://linux.die.net/man/3/mbtowc",
memchr = "http://linux.die.net/man/3/memchr",
memcmp = "http://linux.die.net/man/3/memcmp",
memcpy = "http://linux.die.net/man/3/memcpy",
memmove = "http://linux.die.net/man/3/memmove",
memset = "http://linux.die.net/man/3/memset",
mktime = "http://linux.die.net/man/3/mktime",
modf = "http://linux.die.net/man/3/modf",
modff = "http://linux.die.net/man/3/modff",
modfl = "http://linux.die.net/man/3/modfl",
perror = "http://linux.die.net/man/3/perror",
pow = "http://linux.die.net/man/3/pow",
powf = "http://linux.die.net/man/3/powf",
powl = "http://linux.die.net/man/3/powl",
printf = "http://linux.die.net/man/3/printf",
putc = "http://linux.die.net/man/3/putc",
putchar = "http://linux.die.net/man/3/putchar",
puts = "http://linux.die.net/man/3/puts",
qsort = "http://linux.die.net/man/3/qsort",
raise = "http://linux.die.net/man/3/raise",
rand = "http://linux.die.net/man/3/rand",
realloc = "http://linux.die.net/man/3/realloc",
remove = "http://linux.die.net/man/3/remove",
rename = "http://linux.die.net/man/3/rename",
rewind = "http://linux.die.net/man/3/rewind",
scanf = "http://linux.die.net/man/3/scanf",
setbuf = "http://linux.die.net/man/3/setbuf",
setjmp = "http://linux.die.net/man/3/setjmp",
setlocale = "http://linux.die.net/man/3/setlocale",
setvbuf = "http://linux.die.net/man/3/setvbuf",
SIG_DFL = "http://linux.die.net/man/3/SIG_DFL",
SIG_ERR = "http://linux.die.net/man/3/SIG_ERR",
SIG_IGN = "http://linux.die.net/man/3/SIG_IGN",
SIGABRT = "http://linux.die.net/man/3/SIGABRT",
SIGFPE = "http://linux.die.net/man/3/SIGFPE",
SIGILL = "http://linux.die.net/man/3/SIGILL",
SIGINT = "http://linux.die.net/man/3/SIGINT",
signal = "http://linux.die.net/man/3/signal",
SIGSEGV = "http://linux.die.net/man/3/SIGSEGV",
SIGTERM = "http://linux.die.net/man/3/SIGTERM",
sin = "http://linux.die.net/man/3/sin",
sinf = "http://linux.die.net/man/3/sinf",
sinh = "http://linux.die.net/man/3/sinh",
sinhf = "http://linux.die.net/man/3/sinhf",
sinhl = "http://linux.die.net/man/3/sinhl",
sinl = "http://linux.die.net/man/3/sinl",
sprintf = "http://linux.die.net/man/3/sprintf",
sqrt = "http://linux.die.net/man/3/sqrt",
sqrtf = "http://linux.die.net/man/3/sqrtf",
sqrtl = "http://linux.die.net/man/3/sqrtl",
srand = "http://linux.die.net/man/3/srand",
sscanf = "http://linux.die.net/man/3/sscanf",
stderr = "http://linux.die.net/man/3/stderr",
stdin = "http://linux.die.net/man/3/stdin",
stdout = "http://linux.die.net/man/3/stdout",
strcat = "http://linux.die.net/man/3/strcat",
strchr = "http://linux.die.net/man/3/strchr",
strcmp = "http://linux.die.net/man/3/strcmp",
strcoll = "http://linux.die.net/man/3/strcoll",
strcpy = "http://linux.die.net/man/3/strcpy",
strcspn = "http://linux.die.net/man/3/strcspn",
strerror = "http://linux.die.net/man/3/strerror",
strftime = "http://linux.die.net/man/3/strftime",
strlen = "http://linux.die.net/man/3/strlen",
strncat = "http://linux.die.net/man/3/strncat",
strncmp = "http://linux.die.net/man/3/strncmp",
strncpy = "http://linux.die.net/man/3/strncpy",
strpbrk = "http://linux.die.net/man/3/strpbrk",
strrchr = "http://linux.die.net/man/3/strrchr",
strspn = "http://linux.die.net/man/3/strspn",
strstr = "http://linux.die.net/man/3/strstr",
strtod = "http://linux.die.net/man/3/strtod",
strtok = "http://linux.die.net/man/3/strtok",
strtol = "http://linux.die.net/man/3/strtol",
strtoul = "http://linux.die.net/man/3/strtoul",
strxfrm = "http://linux.die.net/man/3/strxfrm",
system = "http://linux.die.net/man/3/system",
tan = "http://linux.die.net/man/3/tan",
tanf = "http://linux.die.net/man/3/tanf",
tanh = "http://linux.die.net/man/3/tanh",
tanhf = "http://linux.die.net/man/3/tanhf",
tanhl = "http://linux.die.net/man/3/tanhl",
tanl = "http://linux.die.net/man/3/tanl",
tmpfile = "http://linux.die.net/man/3/tmpfile",
tmpnam = "http://linux.die.net/man/3/tmpnam",
tolower = "http://linux.die.net/man/3/tolower",
toupper = "http://linux.die.net/man/3/toupper",
ungetc = "http://linux.die.net/man/3/ungetc",
va_arg = "http://linux.die.net/man/3/va_arg",
va_end = "http://linux.die.net/man/3/va_end",
va_list = "http://linux.die.net/man/3/va_list",
va_start = "http://linux.die.net/man/3/va_start",
vfprintf = "http://linux.die.net/man/3/vfprintf",
vprintf = "http://linux.die.net/man/3/vprintf",
vsprintf = "http://linux.die.net/man/3/vsprintf",
wchar_t = "http://linux.die.net/man/3/wchar_t",
wcstombs = "http://linux.die.net/man/3/wcstombs",
wctomb = "http://linux.die.net/man/3/wctomb",
}
local lua_docs = {
-- LPeg.
['lpeg.match'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#f-match',
['lpeg.type'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#f-type',
['lpeg.version'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#f-version',
['lpeg.setstack'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#f-setmaxstack',
['lpeg.P'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#op-p',
['lpeg.B'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#op-behind',
['lpeg.R'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#op-r',
['lpeg.S'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#op-s',
['lpeg.V'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#op-v',
['lpeg.locale'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#op-locale',
['lpeg.C'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-c',
['lpeg.Carg'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-arg',
['lpeg.Cb'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-b',
['lpeg.Cc'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-cc',
['lpeg.Cf'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-f',
['lpeg.Cg'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-g',
['lpeg.Cp'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-p',
['lpeg.Cs'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-s',
['lpeg.Ct'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-t',
['lpeg.Cmt'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#matchtime',
['lpeg.Cs'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-s',
['lpeg.Cs'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-s',
['lpeg.Cs'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-s',
['lpeg.Cs'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-s',
['lpeg.Cs'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-s',
['lpeg.Cs'] = 'http://www.inf.puc-rio.br/~roberto/lpeg/#cap-s',
-- LuaFileSystem.
['lfs.attributes'] = 'http://keplerproject.github.com/luafilesystem/manual.html#attributes',
['lfs.chdir'] = 'http://keplerproject.github.com/luafilesystem/manual.html#chdir',
['lfs.lock_dir'] = 'http://keplerproject.github.com/luafilesystem/manual.html#chdir',
['lfs.currentdir'] = 'http://keplerproject.github.com/luafilesystem/manual.html#currentdir',
['lfs.dir'] = 'http://keplerproject.github.com/luafilesystem/manual.html#dir',
['lfs.lock'] = 'http://keplerproject.github.com/luafilesystem/manual.html#lock',
['lfs.mkdir'] = 'http://keplerproject.github.com/luafilesystem/manual.html#mkdir',
['lfs.rmdir'] = 'http://keplerproject.github.com/luafilesystem/manual.html#rmdir',
['lfs.setmode'] = 'http://keplerproject.github.com/luafilesystem/manual.html#setmode',
['lfs.symlinkattributes'] = 'http://keplerproject.github.com/luafilesystem/manual.html#symlinkattributes',
['lfs.touch'] = 'http://keplerproject.github.com/luafilesystem/manual.html#touch',
['lfs.unlock'] = 'http://keplerproject.github.com/luafilesystem/manual.html#unlock',
}
-- Miscellaneous functions. {{{1
function compact(s) return s:gsub('%s+', '') end
function striphtml(s) return s:gsub('<[^>]*>', '') end
-- Scan the Lua reference manual for documentation links. {{{1
local lua_refman = 'http://www.lua.org/manual/5.1/manual.html'
for anchor in download(lua_refman):gmatch 'name="([^"]+)"' do
local id = anchor:gsub('^pdf%-', '')
if anchor:find '^pdf%-'
and not anchor:find '^pdf%-LUA_'
and not anchor:find '%.h$'
and not anchor:find 'luaopen'
and anchor ~= 'pdf-luai_apicheck'
and anchor ~= 'pdf-LUAL_BUFFERSIZE'
then
lua_docs[id] = lua_refman .. '#' .. anchor
elseif anchor:find '^luaL?_' or anchor:find '^pdf%-LUAL?_' then
c_docs[id] = lua_refman .. '#' .. anchor
end
end
-- Scan the Lua/APR manual for documentation links. {{{1
local lua_apr_docs = 'http://peterodding.com/code/lua/apr/docs/'
for id in download(lua_apr_docs):gmatch 'name="(apr%.[A-Za-z0-9_]+)"' do
lua_docs[id] = lua_apr_docs .. '#' .. id
end
-- Scan the LuaSocket reference manual. {{{1
local sections = 'dns ftp http ltn12 mime smtp socket tcp udp url'
local luasocket_root = 'http://w3.impa.br/~diego/software/luasocket/'
for section in sections:gmatch '%S+' do
local url = luasocket_root .. section .. '.html'
for anchor, fragment in download(url):gmatch '<p%s+class=name%s+id=([^>]+)>(.-)</p>' do
fragment = compact(striphtml(fragment))
local id = fragment:match '([A-Za-z_][A-Za-z_0-9.:]*)[({]'
if id then lua_docs[id] = url .. '#' .. anchor:gsub('[\'"]', '') end
end
end
-- Scan the Penlight function index. {{{1
local penlight = 'http://stevedonovan.github.com/Penlight/'
local source = download(penlight .. 'function_index.html')
for html in source:gmatch '<li>(.-)</li>' do
local url = html:match 'href="(.-)"'
local text = compact(striphtml(html))
local id, mod = text:match '([A-Za-z_][A-Za-z_0-9.:]*)%((.-)%)'
if url and id and mod then
lua_docs[mod .. '.' .. id] = penlight .. url
end
end
-- Scan section 3 (library calls) of the Linux man pages (disabled). {{{1
-- The following code is not enabled by default because it results in a 1,1 MB
-- Lua script which may be a bit much to commit or include in installations.
local manpages = 'http://linux.die.net/man/3/'
if include_all_manpages then
local source = download(manpages):match '<dl[^>]*>(.-)</dl>'
for id in source:gmatch 'href="([A-Za-z0-9_]+)"' do
c_docs[id] = manpages .. id
end
end
-- Generate the src/docs/*.lua scripts. {{{1
function sorted(input)
local keys = {}
for key in pairs(input) do table.insert(keys, key) end
table.sort(keys, function(a, b) return a:lower() < b:lower() end)
local index = 1
return function()
local key = keys[index]
index = index + 1
return key, input[key]
end
end
function dump(language, doclinks)
local lines = {}
for id, url in sorted(doclinks) do
if id:find '^[A-Za-z_][A-Za-z0-9_]*$' then
lines[#lines + 1] = string.format('%s=%q,', id, url)
else
lines[#lines + 1] = string.format('[%q]=%q,', id, url)
end
end
local outfile = 'src/docs/' .. language:lower() .. '.lua'
message("Generating %s ..", outfile)
local handle = assert(io.open(outfile, 'w'))
handle:write(string.format([=[
--[[
Documentation links for the %s syntax highlighter of the LXSH module.
Author: Peter Odding <peter@peterodding.com>
Last Change: %s
URL: http://peterodding.com/code/lua/lxsh/
Generated by http://github.com/xolox/lua-lxsh/blob/master/etc/doclinks.lua.
]]
return {
%s
}
]=], language, os.date '%B %d, %Y', table.concat(lines, '\n')))
end
dump('Lua', lua_docs)
dump('C', c_docs)