summaryrefslogtreecommitdiff
path: root/manual/2html
diff options
context:
space:
mode:
authorRoberto Ierusalimschy <roberto@inf.puc-rio.br>2018-12-17 14:46:37 -0200
committerRoberto Ierusalimschy <roberto@inf.puc-rio.br>2018-12-17 14:46:37 -0200
commit063d4e4543088e7a21965bda8ee5a0f952a9029e (patch)
tree6c3f2f8e98c26f071a94a32f9f2754396a66a9de /manual/2html
parente354c6355e7f48e087678ec49e340ca0696725b1 (diff)
downloadlua-5.3.5.tar.gz
lua-5.3.5.tar.bz2
lua-5.3.5.zip
Lua 5.3.5 ported to gitv5.3.5
This is the first commit for the branch Lua 5.3. All source files were copied from the official distribution of 5.3.5 in the Lua site. The test files are the same of 5.3.4. The manual came from the previous RCS repository, revision 1.167.1.2.
Diffstat (limited to '')
-rwxr-xr-xmanual/2html518
1 files changed, 518 insertions, 0 deletions
diff --git a/manual/2html b/manual/2html
new file mode 100755
index 00000000..6a6740fb
--- /dev/null
+++ b/manual/2html
@@ -0,0 +1,518 @@
1#!/usr/bin/env lua5.2
2
3
4-- special marks:
5-- \1 - paragraph (empty line)
6-- \4 - remove spaces around it
7-- \3 - ref (followed by label|)
8
9---------------------------------------------------------------
10header = [[
11<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
12<html>
13
14<head>
15<title>Lua 5.3 Reference Manual</title>
16<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
17<link rel="stylesheet" href="lua.css">
18<link rel="stylesheet" href="manual.css">
19</head>
20
21<body bgcolor="#FFFFFF">
22
23<hr>
24<h1>
25<a href="http://www.lua.org/home.html"><img src="logo.gif" alt="[Lua logo]" border="0"></a>
26Lua 5.3 Reference Manual
27</h1>
28
29by Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes
30<p>
31<small>
32<a href="http://www.lua.org/copyright.html">Copyright</a>
33&copy; 2015 Lua.org, PUC-Rio. All rights reserved.
34</small>
35<hr>
36
37<!-- ====================================================================== -->
38<p>
39
40]]
41
42footer = "\n\n</body></html>\n\n"
43
44local seefmt = '(see %s)'
45
46if arg[1] == 'port' then
47 seefmt = '(ver %s)'
48 header = string.gsub(header, "by (.-)\n",
49 "%1\n<p>Tradu&ccedil;&atilde;o: S&eacute;rgio Queiroz de Medeiros", 1)
50 header = string.gsub(header, "Lua (%d+.%d+) Reference Manual",
51 "Manual de Refer&ecirc;ncia de Lua %1")
52 header = string.gsub(header, "All rights reserved",
53 "Todos os direitos reservados")
54end
55
56
57---------------------------------------------------------------
58
59local function compose (f,g)
60 assert(f and g)
61 return function (s) return g(f(s)) end
62end
63
64local function concat (f, g)
65 assert(f and g)
66 return function (s) return f(s) .. g(s) end
67end
68
69
70local Tag = {}
71
72
73setmetatable(Tag, {
74 __index = function (t, tag)
75 local v = function (n, att)
76 local e = ""
77 if type(att) == "table" then
78 for k,v in pairs(att) do e = string.format('%s %s="%s"', e, k, v) end
79 end
80 if n then
81 return string.format("<%s%s>%s</%s>", tag, e, n, tag)
82 else
83 return string.format("<%s%s>", tag, e)
84 end
85 end
86 t[tag] = v
87 return v
88 end
89})
90
91
92
93---------------------------------------------------------------
94local labels = {}
95
96
97local function anchor (text, label, link, textlink)
98 if labels[label] then
99 error("label " .. label .. " already defined")
100 end
101 labels[label] = {text = textlink, link = link}
102 return Tag.a(text, {name=link})
103end
104
105local function makeref (label)
106 assert(not string.find(label, "|"))
107 return string.format("\3%s\3", label)
108end
109
110local function ref (label)
111 local l = labels[label]
112 if not l then
113 io.stderr:write("label ", label, " undefined\n")
114 return "@@@@@@@"
115 else
116 return Tag.a(l.text, {href="#"..l.link})
117 end
118end
119
120---------------------------------------------------------------
121local function nopara (t)
122 t = string.gsub(t, "\1", "\n\n")
123 t = string.gsub(t, "<p>%s*</p>", "")
124 return t
125end
126
127local function fixpara (t)
128 t = string.gsub(t, "\1", "\n</p>\n\n<p>\n")
129 t = string.gsub(t, "<p>%s*</p>", "")
130 return t
131end
132
133local function antipara (t)
134 return "</p>\n" .. t .. "<p>"
135end
136
137
138Tag.pre = compose(Tag.pre, antipara)
139Tag.ul = compose(Tag.ul, antipara)
140
141---------------------------------------------------------------
142local Gfoots = 0
143local footnotes = {}
144
145local line = Tag.hr(nil)
146
147local function dischargefoots ()
148 if #footnotes == 0 then return "" end
149 local fn = table.concat(footnotes)
150 footnotes = {}
151 return line .. Tag.h3"footnotes:" .. fn .. line
152end
153
154
155local Glists = 0
156local listings = {}
157
158local function dischargelist ()
159 if #listings == 0 then return "" end
160 local l = listings
161 listings = {}
162 return line .. table.concat(l, line..line) .. line
163end
164
165---------------------------------------------------------------
166local counters = {
167h1 = {val = 1},
168h2 = {father = "h1", val = 1},
169h3 = {father = "h2", val = 1},
170listing = {father = "h1", val = 1},
171}
172
173local function inccounter (count)
174 counters[count].val = counters[count].val + 1
175 for c, v in pairs(counters) do
176 if v.father == count then v.val = 1 end
177 end
178end
179
180local function getcounter (count)
181 local c = counters[count]
182 if c.father then
183 return getcounter(c.father) .. "." .. c.val
184 else
185 return c.val .. ""
186 end
187end
188---------------------------------------------------------------
189
190
191local function fixed (x)
192 return function () return x end
193end
194
195local function id (x) return x end
196
197
198local function prepos (x, y)
199 assert(x and y)
200 return function (s) return string.format("%s%s%s", x, s, y) end
201end
202
203
204local rw = Tag.b
205
206
207
208
209local function LuaName (name)
210 return Tag.code(name)
211end
212
213
214local function getparam (s)
215 local i, e = string.find(s, "^[^%s@|]+|")
216 if not i then return nil, s
217 else return string.sub(s, i, e - 1), string.sub(s, e + 1)
218 end
219end
220
221
222local function gettitle (h)
223 local title, p = assert(string.match(h, "<title>(.-)</title>()"))
224 return title, string.sub(h, p)
225end
226
227local function getparamtitle (what, h, nonum)
228 local label, title, c, count
229 label, h = getparam(h)
230 title, h = gettitle(h)
231 if not nonum then
232 count = getcounter(what)
233 inccounter(what)
234 c = string.format("%s &ndash; ", count)
235 else
236 c = ""
237 end
238 label = label or count
239 if label then
240 title = anchor(title, label, count, "&sect;"..count)
241 end
242 title = string.format("%s%s", c, title)
243 return title, h
244end
245
246local function section (what, nonum)
247 return function (h)
248 local title
249 title, h = getparamtitle(what, h, nonum)
250 local fn = what == "h1" and dischargefoots() or ""
251 h = fixpara(Tag.p(h))
252 return "</p>\n" .. Tag[what](title) .. h .. fn ..
253 dischargelist() .. "<p>"
254 end
255end
256
257
258local function verbatim (s)
259 s = nopara(s)
260 s = string.gsub(s, "\n", "\n ")
261 s = string.gsub(s, "\n%s*$", "\n")
262 return Tag.pre(s)
263end
264
265
266local function verb (s)
267 return Tag.code(s)
268end
269
270
271local function lua2link (e)
272 return string.find(e, "luaL?_") and e or "pdf-"..e
273end
274
275
276local verbfixed = verb
277
278
279local Tex = {
280
281ANSI = function (func)
282 return "ISO&nbsp;C function " .. Tag.code(func)
283 end,
284At = fixed"@",
285B = Tag.b,
286bigskip = fixed"",
287bignum = id,
288C = fixed"",
289Ci = prepos("<!-- ", " -->"),
290CId = function (func)
291 return "C&nbsp;function " .. Tag.code(func)
292 end,
293chapter = section"h1",
294Char = compose(verbfixed, prepos("'", "'")),
295Cdots = fixed"&middot;&middot;&middot;",
296Close = fixed"}",
297col = Tag.td,
298defid = function (name)
299 local l = lua2link(name)
300 local c = Tag.code(name)
301 return anchor(c, l, l, c)
302 end,
303def = Tag.em,
304description = compose(nopara, Tag.ul),
305Em = fixed("\4" .. "&mdash;" .. "\4"),
306emph = Tag.em,
307emphx = Tag.em, -- emphasis plus index (if there was an index)
308En = fixed("&ndash;"),
309format = fixed"",
310["false"] = fixed(Tag.b"false"),
311id = Tag.code,
312idx = Tag.code,
313index = fixed"",
314Lidx = fixed"", -- Tag.code,
315ldots = fixed"...",
316x = id,
317itemize = compose(nopara, Tag.ul),
318leq = fixed"&le;",
319Lid = function (s)
320 return makeref(lua2link(s))
321 end,
322M = Tag.em,
323N = function (s) return (string.gsub(s, " ", "&nbsp;")) end,
324NE = id, -- tag"foreignphrase",
325num = id,
326["nil"] = fixed(Tag.b"nil"),
327Open = fixed"{",
328part = section("h1", true),
329Pat = compose(verbfixed, prepos("'", "'")),
330preface = section("h1", true),
331psect = section("h2", true),
332Q = prepos('"', '"'),
333refchp = makeref,
334refcode = makeref,
335refsec = makeref,
336
337pi = fixed"&pi;",
338rep = Tag.em, -- compose(prepos("&lt;", "&gt;"), Tag.em),
339Rw = rw,
340rw = rw,
341sb = Tag.sub,
342sp = Tag.sup,
343St = compose(verbfixed, prepos('"', '"')),
344sect1 = section"h1",
345sect2 = section"h2",
346sect3 = section"h3",
347sect4 = section("h4", true),
348simplesect = id,
349Tab2 = function (s) return Tag.table(s, {border=1}) end,
350row = Tag.tr,
351title = Tag.title,
352todo = Tag.todo,
353["true"] = fixed(Tag.b"true"),
354T = verb,
355
356item = function (s)
357 local t, p = string.match(s, "^([^\n|]+)|()")
358 if t then
359 s = string.sub(s, p)
360 s = Tag.b(t..": ") .. s
361 end
362 return Tag.li(fixpara(s))
363 end,
364
365verbatim = verbatim,
366
367manual = id,
368
369
370-- for the manual
371
372link =function (s)
373 local l, t = getparam(s)
374 assert(l)
375 return string.format("%s (%s)", t, makeref(l))
376end,
377
378see = function (s) return string.format(seefmt, makeref(s)) end,
379See = makeref,
380seeC = function (s)
381 return string.format(seefmt, makeref(s))
382 end,
383
384seeF = function (s)
385 return string.format(seefmt, makeref(lua2link(s)))
386 end,
387
388APIEntry = function (e)
389 local h, name
390 h, e = string.match(e, "^%s*(.-)%s*|(.*)$")
391 name = string.match(h, "(luaL?_[%w_]+)%)? +%(") or
392 string.match(h, "luaL?_[%w_]+")
393 local a = anchor(Tag.code(name), name, name, Tag.code(name))
394 local apiicmd, ne = string.match(e, "^(.-</span>)(.*)")
395--io.stderr:write(e)
396 if not apiicmd then
397 return antipara(Tag.hr() .. Tag.h3(a)) .. Tag.pre(h) .. e
398 else
399 return antipara(Tag.hr() .. Tag.h3(a)) .. apiicmd .. Tag.pre(h) .. ne
400 end
401end,
402
403LibEntry = function (e)
404 local h, name
405 h, e = string.match(e, "^(.-)|(.*)$")
406 name = string.gsub(h, " (.+", "")
407 local l = lua2link(name)
408 local a = anchor(Tag.code(h), l, l, Tag.code(name))
409 return Tag.hr() .. Tag.h3(a) .. e
410end,
411
412Produc = compose(nopara, Tag.pre),
413producname = prepos("\t", " ::= "),
414Or = fixed" | ",
415VerBar = fixed"&#124;", -- vertical bar
416OrNL = fixed" | \4",
417bnfNter = prepos("", ""),
418bnfopt = prepos("[", "]"),
419bnfrep = prepos("{", "}"),
420bnfter = compose(Tag.b, prepos("&lsquo;", "&rsquo;")),
421producbody = function (s)
422 s = string.gsub(s, "%s+", " ")
423 s = string.gsub(s, "\4", "\n\t\t")
424 return s
425 end,
426
427apii = function (s)
428 local pop,push,err = string.match(s, "^(.-),(.-),(.*)$")
429 if pop ~= "?" and string.find(pop, "%W") then
430 pop = "(" .. pop .. ")"
431 end
432 if push ~= "?" and string.find(push, "%W") then
433 push = "(" .. push .. ")"
434 end
435 err = (err == "-") and "&ndash;" or Tag.em(err)
436 return Tag.span(
437 string.format("[-%s, +%s, %s]", pop, push, err),
438 {class="apii"}
439 )
440 end,
441}
442
443local others = prepos("?? "," ??")
444
445local function trata (t)
446 t = string.gsub(t, "@(%w+)(%b{})", function (w, f)
447 f = trata(string.sub(f, 2, -2))
448 if type(Tex[w]) ~= "function" then
449 io.stderr:write(w .. "\n")
450 return others(f)
451 else
452 return Tex[w](f, w)
453 end
454 end)
455 return t
456end
457
458
459---------------------------------------------------------------------
460---------------------------------------------------------------------
461
462-- read whole book
463t = io.read"*a"
464
465t = string.gsub(t, "[<>&\128-\255]",
466 {["<"] = "&lt;",
467 [">"] = "&gt;",
468 ["&"] = "&amp;",
469 ["\170"] = "&ordf;",
470 ["\186"] = "&ordm;",
471 ["\192"] = "&Agrave;",
472 ["\193"] = "&Aacute;",
473 ["\194"] = "&Acirc;",
474 ["\195"] = "&Atilde;",
475 ["\199"] = "&Ccedil;",
476 ["\201"] = "&Eacute;",
477 ["\202"] = "&Ecirc;",
478 ["\205"] = "&Iacute;",
479 ["\211"] = "&Oacute;",
480 ["\212"] = "&Ocirc;",
481 ["\218"] = "&Uacute;",
482 ["\224"] = "&agrave;",
483 ["\225"] = "&aacute;",
484 ["\226"] = "&acirc;",
485 ["\227"] = "&atilde;",
486 ["\231"] = "&ccedil;",
487 ["\233"] = "&eacute;",
488 ["\234"] = "&ecirc;",
489 ["\237"] = "&iacute;",
490 ["\243"] = "&oacute;",
491 ["\244"] = "&ocirc;",
492 ["\245"] = "&otilde;",
493 ["\250"] = "&uacute;",
494 ["\252"] = "&uuml;"
495 })
496
497t = string.gsub(t, "\n\n+", "\1")
498
499
500
501-- complete macros with no arguments
502t = string.gsub(t, "(@%w+)([^{%w])", "%1{}%2")
503
504t = trata(t)
505
506-- correct references
507t = string.gsub(t, "\3(.-)\3", ref)
508
509-- remove extra space (??)
510t = string.gsub(t, "%s*\4%s*", "")
511
512t = nopara(t)
513
514-- HTML 3.2 does not need </p> (but complains when it is in wrong places :)
515t = string.gsub(t, "</p>", "")
516
517io.write(header, t, footer)
518
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-03-16 22:18:45 +0000