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
580
581
582
583
584
585
586
587
588
589
|
if not modules then modules = { } end modules ['node-spl'] = {
version = 1.001,
comment = "companion to node-spl.mkiv",
author = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
copyright = "PRAGMA ADE / ConTeXt Development Team",
license = "see context related readme files"
}
-- This module is dedicated to the oriental tex project and for
-- the moment is too experimental to be publicly supported.
--
-- We could cache solutions: say that we store the featureset and
-- all 'words' -> replacement ... so we create a large solution
-- database (per font)
--
-- This module can be optimized by using a dedicated dynamics handler
-- but I'll only do that when the rest of the code is stable.
--
-- Todo: bind setups to paragraph.
local gmatch, concat, format, remove = string.gmatch, table.concat, string.format, table.remove
local next, tostring, tonumber = next, tostring, tonumber
local utfchar = utf.char
local random = math.random
local variables = interfaces.variables
local trace_split = false trackers.register("parbuilders.solutions.splitters.splitter", function(v) trace_split = v end)
local trace_optimize = false trackers.register("parbuilders.solutions.splitters.optimizer", function(v) trace_optimize = v end)
local trace_colors = false trackers.register("parbuilders.solutions.splitters.colors", function(v) trace_colors = v end)
local trace_goodies = false trackers.register("fonts.goodies", function(v) trace_goodies = v end)
local report_fonts = logs.new("fonts")
local report_splitter = logs.new("splitter")
local report_optimizer = logs.new("optimizer")
local glyph = node.id("glyph")
local glue = node.id("glue")
local kern = node.id("kern")
local disc = node.id("disc")
local hlist = node.id("hlist")
local whatsit = node.id("whatsit")
local find_node_tail = node.tail or node.slide
local free_node = node.free
local free_nodelist = node.flush_list
local has_attribute = node.has_attribute
local set_attribute = node.set_attribute
local new_node = node.new
local copy_node = node.copy
local copy_nodelist = node.copy_list
local traverse_nodes = node.traverse
local traverse_ids = node.traverse_id
local protect_nodes = node.protect_glyphs
local hpack_nodes = node.hpack
local insert_node_before = node.insert_before
local insert_node_after = node.insert_after
local repack_hlist = nodes.repack_hlist
local starttiming = statistics.starttiming
local stoptiming = statistics.stoptiming
local process_characters = nodes.process_characters
local inject_kerns = nodes.inject_kerns
local set_dynamics = fonts.otf.set_dynamics
local fontdata = fonts.ids
parbuilders.solutions = parbuilders.solutions or { }
parbuilders.solutions.splitters = parbuilders.solutions.splitters or { }
local splitters = parbuilders.solutions.splitters
local preroll = true
local variant = "normal"
local split = attributes.private('splitter')
local cache = { }
local solutions = { } -- attribute sets
local variants = { }
local max_less = 0
local max_more = 0
local criterium = 0
local randomseed = nil
local optimize = nil -- set later
function splitters.setup(setups)
local method = aux.settings_to_hash(setups.method or "")
if method[variables.preroll] then
preroll = true
else
preroll = false
end
for k, v in next, method do
if variants[k] then
optimize = variants[k]
end
end
randomseed = tonumber(setups.randomseed)
criterium = tonumber(setups.criterium) or criterium
end
local function convert(featuresets,name,set,what)
local list, numbers = set[what], { }
if list then
local setups = fonts.define.specify.context_setups
for i=1,#list do
local feature = list[i]
local fs = featuresets[feature]
local fn = fs and fs.number
if not fn then
-- fall back on global features
fs = setups[feature]
fn = fs and fs.number
end
if fn then
numbers[#numbers+1] = fn
if trace_goodies or trace_optimize then
report_fonts("solution %s of '%s' uses feature '%s' with number %s",i,name,feature,fn)
end
else
report_fonts("solution %s has an invalid feature reference '%s'",i,name,tostring(feature))
end
end
return #numbers > 0 and numbers
end
end
local function initialize(goodies)
local solutions = goodies.solutions
if solutions then
local featuresets = goodies.featuresets
local goodiesname = goodies.name
if trace_goodies or trace_optimize then
report_fonts("checking solutions in '%s'",goodiesname)
end
for name, set in next, solutions do
set.less = convert(featuresets,name,set,"less")
set.more = convert(featuresets,name,set,"more")
end
end
end
fonts.goodies.register("solutions",initialize)
function splitters.define(name,parameters)
local setups = fonts.define.specify.context_setups
local settings = aux.settings_to_hash(parameters) -- todo: interfacing
local goodies, solution, less, more = settings.goodies, settings.solution, settings.less, settings.more
local less_set, more_set
local l = less and aux.settings_to_array(less)
local m = more and aux.settings_to_array(more)
if goodies then
goodies = fonts.goodies.get(goodies) -- also in tfmdata
if goodies then
local featuresets = goodies.featuresets
local solution = solution and goodies.solutions[solution]
if l and #l > 0 then
less_set = convert(featuresets,name,settings,"less") -- take from settings
else
less_set = solution and solution.less -- take from goodies
end
if m and #m > 0 then
more_set = convert(featuresets,name,settings,"more") -- take from settings
else
more_set = solution and solution.more -- take from goodies
end
end
else
if l then
for i=1,#l do
local ss = setups[l[i]]
if ss then
less_set[#less_set+1] = ss.number
end
end
end
if m then
for i=1,#m do
local ss = setups[m[i]]
if ss then
more_set[#more_set+1] = ss.number
end
end
end
end
if trace_optimize then
report_fonts("defining solutions '%s', less: '%s', more: '%s'",name,concat(less_set or {}," "),concat(more_set or {}," "))
end
solutions[#solutions+1] = {
solution = solution,
less = less_set or { },
more = more_set or { },
settings = settings, -- for tracing
}
--~ print(table.serialize(solutions[#solutions]))
tex.write(#solutions)
end
local user_node_one = nodes.register(new_node("whatsit",44)) user_node_one.user_id, user_node_one.type = 1, 100
local user_node_two = nodes.register(new_node("whatsit",44)) user_node_two.user_id, user_node_two.type = 2, 100
local text_node_trt = nodes.register(new_node("whatsit", 7)) text_node_trt.dir = "+TRT"
local fcs = (fonts.color and fonts.color.set) or function() end
local nofwords, noftries, nofadapted, nofkept, nofparagraphs = 0, 0, 0, 0, 0
function splitters.split(head)
-- quite fast
local current, done, rlmode, start, stop, attribute = head, false, false, nil, nil, 0
cache, max_less, max_more = { }, 0, 0
local function flush() -- we can move this
local font = start.font
local last = stop.next
local list = last and copy_nodelist(start,last) or copy_nodelist(start)
local n = #cache + 1
local user_one = copy_node(user_node_one)
local user_two = copy_node(user_node_two)
user_one.value, user_two.value = n, n
head, start = insert_node_before(head,start,user_one)
insert_node_after(head,stop,user_two)
if rlmode == "TRT" or rlmode == "+TRT" then
local dirnode = copy_node(text_node_trt)
list.prev = dirnode
dirnode.next = list
list = dirnode
end
local c = {
original = list,
attribute = attribute,
direction = rlmode,
font = font
}
if trace_split then
report_splitter( "cached %4i: font: %s, attribute: %s, word: %s, direction: %s", n,
font, attribute, nodes.list_to_utf(list,true), rlmode)
end
cache[n] = c
local solution = solutions[attribute]
local l, m = #solution.less, #solution.more
if l > max_less then max_less = l end
if m > max_more then max_more = m end
start, stop, done = nil, nil, true
end
while current do
local id = current.id
if id == glyph and current.subtype < 255 then
local a = has_attribute(current,split)
if not a then
start, stop = nil, nil
elseif not start then
start, stop, attribute = current, current, a
elseif a ~= attribute then
start, stop = nil, nil
else
stop = current
end
current = current.next
elseif id == disc then
start, stop, current = nil, nil, current.next
elseif id == whatsit then
if start then
flush()
end
local subtype = current.subtype
if subtype == 7 or subtype == 6 then
rlmode = current.dir
end
current = current.next
else
if start then
flush()
end
current = current.next
end
end
if start then
flush()
end
nofparagraphs = nofparagraphs + 1
nofwords = nofwords + #cache
return head, done
end
local function collect_words(list)
local words, word = { }, nil
for current in traverse_ids(whatsit,list) do
if current.subtype == 44 then
local user_id = current.user_id
if user_id == 1 then
word = { current.value, current, current }
words[#words+1] = word
elseif user_id == 2 then
word[3] = current
end
end
end
return words -- check for empty (elsewhere)
end
-- we could avoid a hpack but hpack is not that slow
local function doit(word,list,best,width,badness,line,set,listdir)
local changed = 0
local n = word[1]
local found = cache[n]
if found then
local original, attribute, direction = found.original, found.attribute, found.direction
local solution = solutions[attribute]
local features = solution and solution[set]
if features then
local featurenumber = features[best] -- not ok probably
if featurenumber then
noftries = noftries + 1
local first = copy_nodelist(original)
if not trace_colors then
for n in traverse_nodes(first) do -- maybe fast force so no attr needed
set_attribute(n,0,featurenumber) -- this forces dynamics
end
elseif set == "less" then
for n in traverse_nodes(first) do
fcs(n,"font:isol")
set_attribute(n,0,featurenumber)
end
else
for n in traverse_nodes(first) do
fcs(n,"font:medi")
set_attribute(n,0,featurenumber)
end
end
local font = found.font
local dynamics = found.dynamics
if not dynamics then -- we cache this
dynamics = fontdata[font].shared.dynamics
found.dynamics = dynamics
end
local processors = found[featurenumber]
if not processors then -- we cache this too
processors = set_dynamics(font,dynamics,featurenumber)
found[featurenumber] = processors
end
for i=1,#processors do -- often more than 1
first = processors[i](first,font,featurenumber) -- we can make a special one that already passes the dynamics
end
first = inject_kerns(first)
local h = word[2].next -- head of current word
local t = word[3].prev -- tail of current word
if first.id == whatsit then
local temp = first
first = first.next
free_node(temp)
end
local last = find_node_tail(first)
-- replace [u]h->t by [u]first->last
local next, prev = t.next, h.prev
prev.next, first.prev = first, prev
if next then
last.next, next.prev = next, last
end
-- check new pack
local temp, b = repack_hlist(list,width,'exactly',listdir)
if b > badness then
if trace_optimize then
report_optimizer("line %s, badness before: %s, after: %s, criterium: %s -> quit",line,badness,b,criterium)
end
-- remove last insert
prev.next, h.prev = h, prev
if next then
t.next, next.prev = next, t
else
t.next = nil
end
last.next = nil
free_nodelist(first)
else
if trace_optimize then
report_optimizer("line %s, badness before: %s, after: %s, criterium: %s -> continue",line,badness,b,criterium)
end
-- free old h->t
t.next = nil
free_nodelist(h)
changed, badness = changed + 1, b
end
if b <= criterium then
return true, changed
end
end
end
end
return false, changed
end
-- We repeat some code but adding yet another layer of indirectness is not
-- making things better.
variants[variables.normal] = function(words,list,best,width,badness,line,set,listdir)
local changed = 0
for i=1,#words do
local done, c = doit(words[i],list,best,width,badness,line,set,listdir)
changed = changed + c
if done then
break
end
end
if changed > 0 then
nofadapted = nofadapted + 1
-- todo: get rid of pack when ok because we already have packed and we only need the last b
local list, b = repack_hlist(list,width,'exactly',listdir)
return list, true, changed, b -- badness
else
nofkept = nofkept + 1
return list, false, 0, badness
end
end
variants[variables.reverse] = function(words,list,best,width,badness,line,set,listdir)
local changed = 0
for i=#words,1,-1 do
local done, c = doit(words[i],list,best,width,badness,line,set,listdir)
changed = changed + c
if done then
break
end
end
if changed > 0 then
nofadapted = nofadapted + 1
-- todo: get rid of pack when ok because we already have packed and we only need the last b
local list, b = repack_hlist(list,width,'exactly',listdir)
return list, true, changed, b -- badness
else
nofkept = nofkept + 1
return list, false, 0, badness
end
end
variants[variables.random] = function(words,list,best,width,badness,line,set,listdir)
local changed = 0
while #words > 0 do
local done, c = doit(remove(words,random(1,#words)),list,best,width,badness,line,set,listdir)
changed = changed + c
if done then
break
end
end
if changed > 0 then
nofadapted = nofadapted + 1
-- todo: get rid of pack when ok because we already have packed and we only need the last b
local list, b = repack_hlist(list,width,'exactly',listdir)
return list, true, changed, b -- badness
else
nofkept = nofkept + 1
return list, false, 0, badness
end
end
optimize = variants.normal -- the default
local function show_quality(current,what,line)
local set = current.glue_set
local sign = current.glue_sign
local order = current.glue_order
local amount = set * ((sign == 2 and -1) or 1)
report_optimizer("line %s, %s, amount %s, set %s, sign %s (%s), order %s",line,what,amount,set,sign,how,order)
end
function splitters.optimize(head)
local nc = #cache
if nc > 0 then
starttiming(splitters)
local listdir = nil -- todo ! ! !
if randomseed then
math.setrandomseedi(randomseed)
randomseed = nil
end
local line = 0
local tex_hbadness, tex_hfuzz = tex.hbadness, tex.hfuzz
tex.hbadness, tex.hfuzz = 10000, number.maxdimen
if trace_optimize then
report_optimizer("preroll: %s, variant: %s, preroll criterium: %s, cache size: %s",
tostring(preroll),variant,criterium,nc)
end
for current in traverse_ids(hlist,head) do
-- report_splitter("before: [%s] => %s",current.dir,nodes.tosequence(current.list,nil))
line = line + 1
local sign, dir, list, width = current.glue_sign, current.dir, current.list, current.width
local temp, badness = repack_hlist(list,width,'exactly',dir) -- it would be nice if the badness was stored in the node
if badness > 0 then
if sign == 0 then
if trace_optimize then
report_optimizer("line %s, badness %s, okay",line,badness)
end
else
local set, max
if sign == 1 then
if trace_optimize then
report_optimizer("line %s, badness %s, underfull, trying more",line,badness)
end
set, max = "more", max_more
else
if trace_optimize then
report_optimizer("line %s, badness %s, overfull, trying less",line,badness)
end
set, max = "less", max_less
end
-- we can keep the best variants
local lastbest, lastbadness = nil, badness
if preroll then
local bb, base
for i=1,max do
if base then
free_nodelist(base)
end
base = copy_nodelist(list)
local words = collect_words(base) -- beware: words is adapted
for j=i,max do
local temp, done, changes, b = optimize(words,base,j,width,badness,line,set,dir)
base = temp
if trace_optimize then
report_optimizer("line %s, alternative: %s.%s, changes: %s, badness %s",line,i,j,changes,b)
end
bb = b
if b <= criterium then
break
end
-- if done then
-- break
-- end
end
if bb and bb > criterium then -- needs checking
if not lastbest then
lastbest, lastbadness = i, bb
elseif bb > lastbadness then
lastbest, lastbadness = i, bb
end
else
break
end
end
free_nodelist(base)
end
local words = collect_words(list)
for best=lastbest or 1,max do
local temp, done, changes, b = optimize(words,list,best,width,badness,line,set,dir)
current.list = temp
if trace_optimize then
report_optimizer("line %s, alternative: %s, changes: %s, badness %s",line,best,changes,b)
end
if done then
if b <= criterium then -- was == 0
protect_nodes(list)
break
end
end
end
end
else
if trace_optimize then
report_optimizer("line %s, not bad enough",line)
end
end
-- we pack inside the outer hpack and that way keep the original wd/ht/dp as bonus
current.list = hpack_nodes(current.list,width,'exactly',listdir)
-- report_splitter("after: [%s] => %s",temp.dir,nodes.tosequence(temp.list,nil))
end
for i=1,nc do
local ci = cache[i]
free_nodelist(ci.original)
end
cache = { }
tex.hbadness, tex.hfuzz = tex_hbadness, tex_hfuzz
stoptiming(splitters)
end
end
statistics.register("optimizer statistics", function()
if nofwords > 0 then
local elapsed = statistics.elapsedtime(splitters)
local average = noftries/elapsed
return format("%s words identified in %s paragraphs, %s words retried, %s lines tried, %0.3f seconds used, %s adapted, %0.1f lines per second",
nofwords,nofparagraphs,noftries,nofadapted+nofkept,elapsed,nofadapted,average)
end
end)
function splitters.enable()
tasks.enableaction("processors", "parbuilders.solutions.splitters.split")
tasks.enableaction("finalizers", "parbuilders.solutions.splitters.optimize")
end
function splitters.disable()
tasks.disableaction("processors", "parbuilders.solutions.splitters.split")
tasks.disableaction("finalizers", "parbuilders.solutions.splitters.optimize")
end
|