/
base.lua
576 lines (524 loc) · 20.2 KB
/
base.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
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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
local class = pl.class()
class.type = "class"
class._name = "base"
class._initialized = false
class.deferredLegacyInit = {}
class.deferredInit = {}
class.pageTemplate = { frames = {}, firstContentFrame = nil }
class.defaultFrameset = {}
class.firstContentFrame = "page"
class.options = setmetatable({}, {
_opts = {},
__newindex = function (self, key, value)
local opts = getmetatable(self)._opts
if type(opts[key]) == "function" then
opts[key](class, value)
elseif type(value) == "function" then
opts[key] = value
elseif type(key) == "number" then
return nil
else
SU.error("Attempted to set an undeclared class option '" .. key .. "'")
end
end,
__index = function (self, key)
if key == "super" then return nil end
if type(key) == "number" then return nil end
local opt = getmetatable(self)._opts[key]
if type(opt) == "function" then
return opt(class)
elseif opt then
return opt
else
SU.error("Attempted to get an undeclared class option '" .. key .. "'")
end
end
})
class.hooks = {
newpage = {},
endpage = {},
finish = {},
}
class.packages = {}
function class:_init (options)
SILE.scratch.half_initialized_class = self
if self == options then options = {} end
SILE.languageSupport.loadLanguage('und') -- preload for unlocalized fallbacks
self:declareOptions()
self:registerRawHandlers()
self:declareSettings()
self:registerCommands()
self:setOptions(options)
self:declareFrames(self.defaultFrameset)
self:registerPostinit(function (self_)
if type(self.firstContentFrame) == "string" then
self_.pageTemplate.firstContentFrame = self_.pageTemplate.frames[self_.firstContentFrame]
end
local frame = self_:initialFrame()
SILE.typesetter = SILE.typesetters.base(frame)
SILE.typesetter:registerPageEndHook(function ()
SU.debug("frames", function ()
for _, v in pairs(SILE.frames) do SILE.outputter:debugFrame(v) end
return "Drew debug outlines around frames"
end)
end)
end)
end
function class:_post_init ()
self._initialized = true
for i, func in ipairs(self.deferredInit) do
func(self)
self.deferredInit[i] = nil
end
SILE.scratch.half_initialized_class = nil
end
function class:setOptions (options)
options = options or {}
options.papersize = options.papersize or "a4"
for option, value in pairs(options) do
self.options[option] = value
end
end
function class:declareOption (option, setter)
rawset(getmetatable(self.options)._opts, option, nil)
self.options[option] = setter
end
function class:declareOptions ()
self:declareOption("class", function (_, name)
if name then
if self._legacy then
self._name = name
elseif name ~= self._name then
SU.error("Cannot change class name after instantiation, derive a new class instead.")
end
end
return self._name
end)
self:declareOption("papersize", function (_, size)
if size then
self.papersize = size
SILE.documentState.paperSize = SILE.papersize(size)
SILE.documentState.orgPaperSize = SILE.documentState.paperSize
SILE.newFrame({
id = "page",
left = 0,
top = 0,
right = SILE.documentState.paperSize[1],
bottom = SILE.documentState.paperSize[2]
})
end
return self.papersize
end)
end
function class.declareSettings (_)
SILE.settings:declare({
parameter = "current.parindent",
type = "glue or nil",
default = nil,
help = "Glue at start of paragraph"
})
SILE.settings:declare({
parameter = "current.hangIndent",
type = "measurement or nil",
default = nil,
help = "Size of hanging indent"
})
SILE.settings:declare({
parameter = "current.hangAfter",
type = "integer or nil",
default = nil,
help = "Number of lines affected by handIndent"
})
end
function class:loadPackage (packname, options)
local pack = require(("packages.%s"):format(packname))
if type(pack) == "table" and pack.type == "package" then -- new package
self.packages[pack._name] = pack(options)
else -- legacy package
self:initPackage(pack, options)
end
end
function class:initPackage (pack, options)
SU.deprecated("class:initPackage(options)", "package(options)", "0.14.0", "0.16.0", [[
This package appears to be a legacy format package. It returns a table
an expects SILE to guess a bit about what to do. New packages inherit
from the base class and have a constructor function (_init) that
automatically handles setup.]])
if type(pack) == "table" then
if pack.exports then pl.tablex.update(self, pack.exports) end
if type(pack.declareSettings) == "function" then
pack.declareSettings(self)
end
if type(pack.registerRawHandlers) == "function" then
pack.registerRawHandlers(self)
end
if type(pack.registerCommands) == "function" then
pack.registerCommands(self)
end
if type(pack.init) == "function" then
self:registerPostinit(pack.init, options)
end
end
end
function class:registerLegacyPostinit (func, options)
if self._initialized then return func(self, options) end
table.insert(self.deferredLegacyInit, function (_)
func(self, options)
end)
end
function class:registerPostinit (func, options)
if self._initialized then return func(self, options) end
table.insert(self.deferredInit, function (_)
func(self, options)
end)
end
function class:registerHook (category, func)
for _, func_ in ipairs(self.hooks[category]) do
if func_ == func then
return
--[[ See https://github.com/sile-typesetter/sile/issues/1531
return SU.warn("Attempted to set the same function hook twice, probably unintended, skipping.")
-- If the same function signature is already set a package is probably being
-- re-initialized. Ditch the first instance of the hook so that it runs in
-- the order of last initialization.
self.hooks[category][_] = nil
]]
end
end
table.insert(self.hooks[category], func)
end
function class:runHooks (category, options)
for _, func in ipairs(self.hooks[category]) do
SU.debug("classhooks", "Running hook from", category, options and "with options " .. #options)
func(self, options)
end
end
function class.registerCommand (_, name, func, help, pack)
SILE.Commands[name] = func
if not pack then
local where = debug.getinfo(2).source
pack = where:match("(%w+).lua")
end
--if not help and not pack:match(".sil") then SU.error("Could not define command '"..name.."' (in package "..pack..") - no help text" ) end
SILE.Help[name] = {
description = help,
where = pack
}
end
function class.registerRawHandler (_, format, callback)
SILE.rawHandlers[format] = callback
end
function class:registerRawHandlers ()
self:registerRawHandler("text", function (_, content)
SILE.settings:temporarily(function()
SILE.settings:set("typesetter.parseppattern", "\n")
SILE.settings:set("typesetter.obeyspaces", true)
SILE.typesetter:typeset(content[1])
end)
end)
end
local function packOptions (options)
local relevant = pl.tablex.copy(options)
relevant.src = nil
relevant.format = nil
relevant.module = nil
relevant.require = nil
return relevant
end
function class:registerCommands ()
local function replaceProcessBy(replacement, tree)
if type(tree) ~= "table" then return tree end
local ret = pl.tablex.deepcopy(tree)
if tree.command == "process" then
return replacement
else
for i, child in ipairs(tree) do
ret[i] = replaceProcessBy(replacement, child)
end
return ret
end
end
self:registerCommand("define", function (options, content)
SU.required(options, "command", "defining command")
if type(content) == "function" then
-- A macro defined as a function can take no argument, so we register
-- it as-is.
self:registerCommand(options["command"], content)
return
elseif options.command == "process" then
SU.warn("Did you mean to re-definine the `\\process` macro? That probably won't go well.")
end
self:registerCommand(options["command"], function (_, inner_content)
SU.debug("macros", "Processing macro \\" .. options["command"])
local macroArg
if type(inner_content) == "function" then
macroArg = inner_content
elseif type(inner_content) == "table" then
macroArg = pl.tablex.copy(inner_content)
macroArg.command = nil
macroArg.id = nil
elseif inner_content == nil then
macroArg = {}
else
SU.error("Unhandled content type " .. type(inner_content) .. " passed to macro \\" .. options["command"], true)
end
-- Replace every occurrence of \process in `content` (the macro
-- body) with `macroArg`, then have SILE go through the new `content`.
local newContent = replaceProcessBy(macroArg, content)
SILE.process(newContent)
SU.debug("macros", "Finished processing \\" .. options["command"])
end, options.help, SILE.currentlyProcessingFile)
end, "Define a new macro. \\define[command=example]{ ... \\process }")
-- A utility function that allows SILE.call() to be used as a noop wrapper.
self:registerCommand("noop", function (_, content)
SILE.process(content)
end)
-- The document (SIL) or sile (XML) command is always the sigular leaf at the
-- top level of our AST. The work you might expect to see happen here is
-- actually handled by SILE.inputter:classInit() before we get here, so these
-- are just pass through functions. Theoretically, this could be a useful
-- point to hook into-especially for included documents.
self:registerCommand("document", function (_, content)
SILE.process(content)
end)
self:registerCommand("sile", function (_, content)
SILE.process(content)
end)
self:registerCommand("comment", function (_, _)
end, "Ignores any text within this command's body.")
self:registerCommand("process", function ()
SU.error("Encountered unsubstituted \\process.")
end, "Within a macro definition, processes the contents of the macro body.")
self:registerCommand("script", function (options, content)
local packopts = packOptions(options)
if SU.hasContent(content) then
return SILE.processString(content[1], options.format or "lua", nil, packopts)
elseif options.src then
return SILE.require(options.src)
else
SU.error("\\script function requires inline content or a src file path")
return SILE.processString(content[1], options.format or "lua", nil, packopts)
end
end, "Runs lua code. The code may be supplied either inline or using src=...")
self:registerCommand("include", function (options, content)
local packopts = packOptions(options)
if SU.hasContent(content) then
local doc = SU.contentToString(content)
return SILE.processString(doc, options.format, nil, packopts)
elseif options.src then
return SILE.processFile(options.src, options.format, packopts)
else
SU.error("\\include function requires inline content or a src file path")
end
end, "Includes a content file for processing.")
self:registerCommand("lua", function (options, content)
local packopts = packOptions(options)
if SU.hasContent(content) then
local doc = SU.contentToString(content)
return SILE.processString(doc, "lua", nil, packopts)
elseif options.src then
return SILE.processFile(options.src, "lua", packopts)
elseif options.require then
local module = SU.required(options, "require", "lua")
return require(module)
else
SU.error("\\lua function requires inline content or a src file path or a require module name")
end
end, "Run Lua code. The code may be supplied either inline, using require=... for a Lua module, or using src=... for a file path")
self:registerCommand("sil", function (options, content)
local packopts = packOptions(options)
if SU.hasContent(content) then
local doc = SU.contentToString(content)
return SILE.processString(doc, "sil")
elseif options.src then
return SILE.processFile(options.src, "sil", packopts)
else
SU.error("\\sil function requires inline content or a src file path")
end
end, "Process sil content. The content may be supplied either inline or using src=...")
self:registerCommand("xml", function (options, content)
local packopts = packOptions(options)
if SU.hasContent(content) then
local doc = SU.contentToString(content)
return SILE.processString(doc, "xml", nil, packopts)
elseif options.src then
return SILE.processFile(options.src, "xml", packopts)
else
SU.error("\\xml function requires inline content or a src file path")
end
end, "Process xml content. The content may be supplied either inline or using src=...")
self:registerCommand("use", function (options, content)
local packopts = packOptions(options)
if content[1] and string.len(content[1]) > 0 then
local doc = SU.contentToString(content)
SILE.processString(doc, "lua", nil, packopts)
else
if options.src then
SU.warn("Use of 'src' with \\use is discouraged because some of it's path handling\n will eventually be deprecated. Use 'module' instead when possible.")
SILE.processFile(options.src, "lua", packopts)
else
local module = SU.required(options, "module", "use")
SILE.use(module, packopts)
end
end
end, "Load and initialize a SILE module (can be a package, a shaper, a typesetter, or whatever). Use module=... to specif what to load or include module code inline.")
self:registerCommand("raw", function (options, content)
local rawtype = SU.required(options, "type", "raw")
local handler = SILE.rawHandlers[rawtype]
if not handler then SU.error("No inline handler for '"..rawtype.."'") end
handler(options, content)
end, "Invoke a raw passthrough handler")
self:registerCommand("pagetemplate", function (options, content)
SILE.typesetter:pushState()
SILE.documentState.thisPageTemplate = { frames = {} }
SILE.process(content)
SILE.documentState.thisPageTemplate.firstContentFrame = SILE.getFrame(options["first-content-frame"])
SILE.typesetter:initFrame(SILE.documentState.thisPageTemplate.firstContentFrame)
SILE.typesetter:popState()
end, "Defines a new page template for the current page and sets the typesetter to use it.")
self:registerCommand("frame", function (options, _)
SILE.documentState.thisPageTemplate.frames[options.id] = SILE.newFrame(options)
end, "Declares (or re-declares) a frame on this page.")
self:registerCommand("penalty", function (options, _)
if SU.boolean(options.vertical, false) and not SILE.typesetter:vmode() then
SILE.typesetter:leaveHmode()
end
if SILE.typesetter:vmode() then
SILE.typesetter:pushVpenalty({ penalty = tonumber(options.penalty) })
else
SILE.typesetter:pushPenalty({ penalty = tonumber(options.penalty) })
end
end, "Inserts a penalty node. Option is penalty= for the size of the penalty.")
self:registerCommand("discretionary", function (options, _)
local discretionary = SILE.nodefactory.discretionary({})
if options.prebreak then
SILE.call("hbox", {}, function () SILE.typesetter:typeset(options.prebreak) end)
discretionary.prebreak = { SILE.typesetter.state.nodes[#SILE.typesetter.state.nodes] }
SILE.typesetter.state.nodes[#SILE.typesetter.state.nodes] = nil
end
if options.postbreak then
SILE.call("hbox", {}, function () SILE.typesetter:typeset(options.postbreak) end)
discretionary.postbreak = { SILE.typesetter.state.nodes[#SILE.typesetter.state.nodes] }
SILE.typesetter.state.nodes[#SILE.typesetter.state.nodes] = nil
end
if options.replacement then
SILE.call("hbox", {}, function () SILE.typesetter:typeset(options.replacement) end)
discretionary.replacement = { SILE.typesetter.state.nodes[#SILE.typesetter.state.nodes] }
SILE.typesetter.state.nodes[#SILE.typesetter.state.nodes] = nil
end
table.insert(SILE.typesetter.state.nodes, discretionary)
end, "Inserts a discretionary node.")
self:registerCommand("glue", function (options, _)
local width = SU.cast("length", options.width):absolute()
SILE.typesetter:pushGlue(width)
end, "Inserts a glue node. The width option denotes the glue dimension.")
self:registerCommand("kern", function (options, _)
local width = SU.cast("length", options.width):absolute()
SILE.typesetter:pushHorizontal(SILE.nodefactory.kern(width))
end, "Inserts a glue node. The width option denotes the glue dimension.")
self:registerCommand("skip", function (options, _)
options.discardable = SU.boolean(options.discardable, false)
options.height = SILE.length(options.height):absolute()
SILE.typesetter:leaveHmode()
if options.discardable then
SILE.typesetter:pushVglue(options)
else
SILE.typesetter:pushExplicitVglue(options)
end
end, "Inserts vertical skip. The height options denotes the skip dimension.")
self:registerCommand("par", function (_, _)
SILE.typesetter:endline()
end, "Ends the current paragraph.")
end
function class:initialFrame ()
SILE.documentState.thisPageTemplate = pl.tablex.deepcopy(self.pageTemplate)
SILE.frames = { page = SILE.frames.page }
for k, v in pairs(SILE.documentState.thisPageTemplate.frames) do
SILE.frames[k] = v
end
if not SILE.documentState.thisPageTemplate.firstContentFrame then
SILE.documentState.thisPageTemplate.firstContentFrame = SILE.frames[self.firstContentFrame]
end
SILE.documentState.thisPageTemplate.firstContentFrame:invalidate()
return SILE.documentState.thisPageTemplate.firstContentFrame
end
function class:declareFrame (id, spec)
spec.id = id
if spec.solve then
self.pageTemplate.frames[id] = spec
else
self.pageTemplate.frames[id] = SILE.newFrame(spec)
end
-- next = spec.next,
-- left = spec.left and fW(spec.left),
-- right = spec.right and fW(spec.right),
-- top = spec.top and fH(spec.top),
-- bottom = spec.bottom and fH(spec.bottom),
-- height = spec.height and fH(spec.height),
-- width = spec.width and fH(spec.width),
-- id = id
-- })
end
function class:declareFrames (specs)
if specs then
for k, v in pairs(specs) do self:declareFrame(k, v) end
end
end
-- WARNING: not called as class method
function class.newPar (typesetter)
typesetter:pushGlue(SILE.settings:get("current.parindent") or SILE.settings:get("document.parindent"))
SILE.settings:set("current.parindent", nil)
local hangIndent = SILE.settings:get("current.hangIndent")
if hangIndent then
SILE.settings:set("linebreak.hangIndent", hangIndent)
end
local hangAfter = SILE.settings:get("current.hangAfter")
if hangAfter then
SILE.settings:set("linebreak.hangAfter", hangAfter)
end
end
-- WARNING: not called as class method
function class.endPar (typesetter)
typesetter:pushVglue(SILE.settings:get("document.parskip"))
if SILE.settings:get("current.hangIndent") then
SILE.settings:set("current.hangIndent", nil)
SILE.settings:set("linebreak.hangIndent", nil)
end
if SILE.settings:get("current.hangAfter") then
SILE.settings:set("current.hangAfter", nil)
SILE.settings:set("linebreak.hangAfter", nil)
end
end
function class:newPage ()
SILE.outputter:newPage()
self:runHooks("newpage")
-- Any other output-routiney things will be done here by inheritors
return self:initialFrame()
end
function class:endPage ()
SILE.typesetter.frame:leave(SILE.typesetter)
self:runHooks("endpage")
-- I'm trying to call up a new frame here, don't cause a page break in the current one
-- SILE.typesetter:leaveHmode()
-- Any other output-routiney things will be done here by inheritors
end
function class:finish ()
SILE.inputter:postamble()
SILE.call("vfill")
while not SILE.typesetter:isQueueEmpty() do
SILE.call("supereject")
SILE.typesetter:leaveHmode(true)
SILE.typesetter:buildPage()
if not SILE.typesetter:isQueueEmpty() then
SILE.typesetter:initNextFrame()
end
end
SILE.typesetter:runHooks("pageend") -- normally run by the typesetter
self:endPage()
if SILE.typesetter then
assert(SILE.typesetter:isQueueEmpty(), "queues not empty")
end
SILE.outputter:finish()
self:runHooks("finish")
end
return class