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
577
578
579
|
if not modules then modules = { } end modules ['typo-mar'] = {
version = 1.001,
comment = "companion to typo-mar.mkiv",
author = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
copyright = "PRAGMA ADE / ConTeXt Development Team",
license = "see context related readme files"
}
-- todo:
--
-- * autoleft/right depending on available space (or distance to margin)
-- * stack across paragraphs, but that is messy and one should reconsider
-- using margin data then as also vertical spacing kicks in
-- * floating margin data, with close-to-call anchoring
local format = string.format
local insert, remove = table.insert, table.remove
local setmetatable, next = setmetatable, next
local attributes, nodes, node, variables = attributes, nodes, node, variables
local trace_margindata = false trackers.register("typesetters.margindata", function(v) trace_margindata = v end)
local report_margindata = logs.reporter("typesetters","margindata")
local tasks = nodes.tasks
local prependaction = tasks.prependaction
local disableaction = tasks.disableaction
local enableaction = tasks.enableaction
local variables = interfaces.variables
local conditionals = tex.conditionals
local v_top = variables.top
local v_depth = variables.depth
local v_local = variables["local"]
local v_global = variables["global"]
local v_left = variables.left
local v_right = variables.right
local v_flushleft = variables.flushleft
local v_flushright = variables.flushright
local v_inner = variables.inner
local v_outer = variables.outer
local v_margin = variables.margin
local v_edge = variables.edge
local v_default = variables.default
local v_normal = variables.normal
local v_yes = variables.yes
local v_first = variables.first
local has_attribute = node.has_attribute
local set_attribute = node.set_attribute
local unset_attribute = node.unset_attribute
local copy_node_list = node.copy_list
local slide_nodes = node.slide
local hpack_nodes = node.hpack -- nodes.fasthpack not really faster here
local traverse_id = node.traverse_id
local free_node_list = node.flush_list
local link_nodes = nodes.link
local nodecodes = nodes.nodecodes
local listcodes = nodes.listcodes
local gluecodes = nodes.gluecodes
local whatsitcodes = nodes.whatsitcodes
local hlist_code = nodecodes.hlist
local vlist_code = nodecodes.vlist
local glue_code = nodecodes.glue
local whatsit_code = nodecodes.whatsit
local line_code = listcodes.line
local leftskip_code = gluecodes.leftskip
local rightskip_code = gluecodes.rightskip
local userdefined_code = whatsitcodes.userdefined
local nodepool = nodes.pool
local new_kern = nodepool.kern
local new_stretch = nodepool.stretch
local new_usernumber = nodepool.usernumber
local texcount = tex.count
local texdimen = tex.dimen
local texbox = tex.box
local isleftpage = layouts.status.isleftpage
local a_margindata = attributes.private("margindata")
local inline_mark = nodepool.userids["margins.inline"]
local margins = { }
typesetters.margins = margins
local locations = { v_left, v_right, v_inner, v_outer } -- order might change
local categories = { }
local displaystore = { } -- [category][location][scope]
local inlinestore = { } -- [number]
local nofsaved = 0
local nofstored = 0
local nofinlined = 0
local nofdelayed = 0
local mt1 = {
__index = function(t,location)
local v = { [v_local] = { }, [v_global] = { } }
t[location] = v
return v
end
}
local mt2 = {
__index = function(stores,category)
categories[#categories+1] = category
local v = { }
setmetatable(v,mt1)
stores[category] = v
return v
end
}
setmetatable(displaystore,mt2)
local defaults = {
__index = {
location = v_left,
align = v_normal,
method = "",
name = "",
threshold = 0, -- .25ex
margin = v_normal,
scope = v_global,
distance = 0,
hoffset = 0,
voffset = 0,
category = v_default,
line = 0,
vstack = 0,
dy = 0,
baseline = false,
inline = false,
}
}
local enablelocal, enableglobal -- forward reference (delayed initialization)
function margins.save(t)
setmetatable(t,defaults)
local inline = t.inline
local location = t.location
local category = t.category
local scope = t.scope
local store
if inline then
store = inlinestore
else
store = displaystore[category][location]
if not store then
report_margindata("invalid location: %s",location)
return
end
store = store[scope]
end
if not store then
report_margindata("invalid scope: %s",scope)
return
end
if enablelocal and scope == "local" then
enablelocal()
end
if enableglobal and scope == "global" then
enableglobal()
end
nofsaved = nofsaved + 1
nofstored = nofstored + 1
local name = t.name
if name and name ~= "" then
for i=#store,1,-1 do
local si = store[i]
if si.name == name then
local s = remove(store,i)
free_node_list(s.box)
end
end
end
-- better make a new table and make t entry in t
t.box = copy_node_list(texbox[t.number])
t.n = nofsaved
-- used later (we will clean up this natural mess later)
-- nice is to make a special status table mechanism
local leftmargindistance = texdimen.naturalleftmargindistance
local rightmargindistance = texdimen.naturalrightmargindistance
t.strutdepth = texbox.strutbox.depth
t.strutheight = texbox.strutbox.height
t.leftskip = tex.leftskip.width
t.rightskip = tex.rightskip.width
t.leftmargindistance = leftmargindistance
t.rightmargindistance = rightmargindistance
t.leftedgedistance = texdimen.naturalleftedgedistance
+ texdimen.leftmarginwidth
+ leftmargindistance
t.rightedgedistance = texdimen.naturalrightedgedistance
+ texdimen.rightmarginwidth
+ rightmargindistance
t.lineheight = texdimen.lineheight
--
-- t.realpageno = texcount.realpageno
if inline then
context(new_usernumber(inline_mark,nofsaved))
store[nofsaved] = t -- no insert
nofinlined = nofinlined + 1
else
insert(store,t)
end
if trace_margindata then
report_margindata("saved: %s, location: %s, scope: %s, inline: %s",nofsaved,location,scope,tostring(inline))
end
end
-- Actually it's an advantage to have them all anchored left (tags and such)
-- we could keep them in store and flush in stage two but we might want to
-- do more before that so we need the content to be there unless we can be
-- sure that we flush this first which might not be the case in the future.
--
-- When the prototype inner/outer code that was part of this proved to be
-- okay it was moved elsewhere.
local status, nofstatus = { }, 0
local function realign(current,candidate)
local location = candidate.location
local margin = candidate.margin
local hoffset = candidate.hoffset
local distance = candidate.distance
local hsize = candidate.hsize
local width = candidate.width
local align = candidate.align
-- local realpageno = candidate.realpageno
local leftpage = isleftpage(false,true)
local delta = 0
local leftdelta = 0
local rightdelta = 0
local leftdistance = distance
local rightdistance = distance
if margin == v_normal then
--
elseif margin == v_local then
leftdelta = - candidate.leftskip
rightdelta = candidate.rightskip
elseif margin == v_margin then
leftdistance = candidate.leftmargindistance
rightdistance = candidate.rightmargindistance
elseif margin == v_edge then
leftdistance = candidate.leftedgedistance
rightdistance = candidate.rightedgedistance
end
if leftpage then
leftdistance, rightdistance = rightdistance, leftdistance
end
if location == v_left then
delta = hoffset + width + leftdistance + leftdelta
elseif location == v_right then
delta = -hoffset - hsize - rightdistance + rightdelta
elseif location == v_inner then
if leftpage then
delta = -hoffset - hsize - rightdistance + rightdelta
else
delta = hoffset + width + leftdistance + leftdelta
end
elseif location == v_outer then
if leftpage then
delta = hoffset + width + leftdistance + leftdelta
else
delta = -hoffset - hsize - rightdistance + rightdelta
end
end
-- we assume that list is a hbox, otherwise we had to take the whole current
-- in order to get it right
current.width = 0
current.list = hpack_nodes(link_nodes(new_kern(-delta),current.list,new_kern(delta)))
current.width = 0
if trace_margindata then
report_margindata("realigned: %s, location: %s, margin: %s",candidate.n,location,margin)
end
end
local function realigned(current,a)
local candidate = status[a]
realign(current,candidate)
nofdelayed = nofdelayed - 1
status[a] = nil
return true
end
local stacked = { }
local function resetstacked()
for i=1,#locations do
stacked[locations[i]] = false
end
end
resetstacked()
local function inject(parent,head,candidate)
local box = candidate.box
local width = box.width
local height = box.height
local depth = box.depth
local shift = box.shift
local stack = candidate.stack
local location = candidate.location
local method = candidate.method
local voffset = candidate.voffset
local line = candidate.line
local baseline = candidate.baseline
local offset = stacked[location]
local firstonstack = offset == false
nofstatus = nofstatus + 1
nofdelayed = nofdelayed + 1
status[nofstatus] = candidate
-- yet untested
if baseline == true then
baseline = false
-- hbox vtop
--~ for h in traverse_id(hlist_code,box.list.list) do
--~ baseline = h.height
--~ break
--~ end
end
candidate.width = width
candidate.hsize = parent.width -- we can also pass textwidth
if firstonstack then
offset = 0
else
offset = offset + height
end
if stack == v_yes then
offset = offset + candidate.dy
shift = shift + offset
end
-- -- --
-- Maybe we also need to patch offset when we apply methods, but how ...
-- This needs a bit of playing as it depends on the stack setting of the
-- following which we don't know yet ... so, consider stacking partially
-- experimental.
-- -- --
if method == v_top then
local delta = height - parent.height
if trace_margindata then
report_margindata("top aligned: %s, amount: %s",candidate.n,delta)
end
if delta < candidate.threshold then
shift = shift + voffset + delta
end
elseif method == v_first then
if baseline then
shift = shift + voffset + height - baseline -- option
else
shift = shift + voffset -- normal
end
elseif method == v_depth then
local delta = candidate.strutdepth
if trace_margindata then
report_margindata("depth aligned, amount: %s",candidate.n,delta)
end
shift = shift + voffset + delta
elseif method == v_height then
local delta = - candidate.strutheight
if trace_margindata then
report_margindata("height aligned, amount: %s",candidate.n,delta)
end
shift = shift + voffset + delta
elseif voffset ~= 0 then
shift = shift + voffset
end
-- -- --
if line ~= 0 then
local delta = line * candidate.lineheight
shift = shift + delta
offset = offset + delta
end
box.shift = shift
box.width = 0
if head then
head.prev = box
box.next = head
end
head = box
set_attribute(box,a_margindata,nofstatus)
if trace_margindata then
report_margindata("injected: %s, location: %s",candidate.n,location)
end
-- we need to add line etc to offset as well
offset = offset + depth
stacked[location] = offset
return head
end
local function flushinline(parent,head,done)
local current = head
while current and nofinlined > 0 do
local id = current.id
if id == whatsit_code then
if current.subtype == userdefined_code and current.user_id == inline_mark then
local n = current.value
local candidate = inlinestore[n]
if candidate then -- no vpack, as we want to realign
inlinestore[n] = nil
nofinlined = nofinlined - 1
head = inject(parent,head,candidate) -- maybe return applied offset
done = true
nofstored = nofstored - 1
end
end
elseif id == hlist_code or id == vlist_code then
-- optional (but sometimes needed)
current.list, done = flushinline(current,current.list,done)
end
current = current.next
end
return head, done
end
local function flushed(scope,parent) -- current is hlist
local done = false
local head = parent.list
for c=1,#categories do
local category = categories[c]
for l=1,#locations do
local location = locations[l]
local store = displaystore[category][location][scope]
while true do
local candidate = remove(store,1)
if candidate then -- no vpack, as we want to realign
head = inject(parent,head,candidate) -- maybe return applied offset
done = true
nofstored = nofstored - 1
else
break
end
end
end
end
if nofinlined > 0 then
if done then
parent.list = head
end
head, done = flushinline(parent,head,false)
end
if done then
parent.list = hpack_nodes(head,parent.width,"exactly")
resetstacked()
end
return done
end
-- only when group : vbox|vmode_par
-- only when subtype : line, box (no indent alignment cell)
local function handler(scope,head,group)
if nofstored > 0 then
-- if trace_margindata then
-- report_margindata("flushing stage one, stored: %s, scope: %s, delayed: %s, group: %s",nofstored,scope,nofdelayed,group)
-- end
local current = head
local done = false
while current do
local id = current.id
if (id == vlist_code or id == hlist_code) and not has_attribute(current,a_margindata) then
if flushed(scope,current) then
set_attribute(current,a_margindata,0) -- signal to prevent duplicate processing
if nofstored <= 0 then
break
end
done = true
end
end
current = current.next
end
-- if done then
-- resetstacked()
-- end
return head, done
else
return head, false
end
end
function margins.localhandler(head,group)
if conditionals.inhibitmargindata then
return head, false
elseif nofstored > 0 then
return handler("local",head,group)
else
return head, false
end
end
function margins.globalhandler(head,group)
--~ print(group)
if conditionals.inhibitmargindata then
return head, false
elseif nofstored > 0 and group == "hmode_par" then
return handler("global",head,group)
else
return head, false
end
end
local function finalhandler(head)
if nofdelayed > 0 then
local current = head
local done = false
while current do
local id = current.id
if id == hlist_code then
local a = has_attribute(current,a_margindata)
if not a or a == 0 then
finalhandler(current.list)
elseif realigned(current,a) then
done = true
if nofdelayed == 0 then
return head, true
end
end
elseif id == vlist_code then
finalhandler(current.list)
end
current = current.next
end
return head, done
else
return head, false
end
end
function margins.finalhandler(head)
if nofdelayed > 0 then
-- if trace_margindata then
-- report_margindata("flushing stage two, instore: %s, delayed: %s",nofstored,nofdelayed)
-- end
return finalhandler(head)
else
return head, false
end
end
prependaction("finalizers", "lists", "typesetters.margins.localhandler")
prependaction("vboxbuilders", "normalizers", "typesetters.margins.localhandler")
prependaction("mvlbuilders", "normalizers", "typesetters.margins.globalhandler")
prependaction("shipouts", "normalizers", "typesetters.margins.finalhandler")
disableaction("finalizers", "typesetters.margins.localhandler")
disableaction("vboxbuilders", "typesetters.margins.localhandler")
disableaction("mvlbuilders", "typesetters.margins.globalhandler")
disableaction("shipouts", "typesetters.margins.finalhandler")
enablelocal = function()
enableaction("finalizers", "typesetters.margins.localhandler")
enableaction("vboxbuilders", "typesetters.margins.localhandler")
enableaction("shipouts", "typesetters.margins.finalhandler")
enablelocal = nil
end
enableglobal = function()
enableaction("mvlbuilders", "typesetters.margins.globalhandler")
enableaction("shipouts", "typesetters.margins.finalhandler")
enableglobal = nil
end
statistics.register("margin data", function()
if nofsaved > 0 then
return format("%s entries, %s pending",nofsaved,nofdelayed)
else
return nil
end
end)
|