summaryrefslogtreecommitdiff
path: root/tex/context/base/node-fin.lua
blob: e95725d29637e3cc0a128221008c120d6b19c8a3 (plain)
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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
if not modules then modules = { } end modules ['node-fin'] = {
    version   = 1.001,
    comment   = "companion to node-fin.mkiv",
    author    = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
    copyright = "PRAGMA ADE / ConTeXt Development Team",
    license   = "see context related readme files",
}

-- this module is being reconstructed
-- local functions, only slightly slower

local next, type, format = next, type, string.format

local attributes, nodes, node = attributes, nodes, node

local copy_node       = node.copy
local find_tail       = node.slide

local nodecodes       = nodes.nodecodes
local whatcodes       = nodes.whatcodes

local glyph_code      = nodecodes.glyph
local disc_code       = nodecodes.disc
local glue_code       = nodecodes.glue
local rule_code       = nodecodes.rule
local whatsit_code    = nodecodes.whatsit
local hlist_code      = nodecodes.hlist
local vlist_code      = nodecodes.vlist

local pdfliteral_code = whatcodes.pdfliteral

local states          = attributes.states
local numbers         = attributes.numbers
local a_trigger       = attributes.private('trigger')
local triggering      = false

local starttiming     = statistics.starttiming
local stoptiming      = statistics.stoptiming
local loadstripped    = utilities.lua.loadstripped
local unsetvalue      = attributes.unsetvalue

-- these two will be like trackers

function states.enabletriggering()
    triggering = true
end
function states.disabletriggering()
    triggering = false
end

-- the following code is no longer needed due to the new backend
-- but we keep it around for a while as an example
--
-- states.collected = states.collected or { }
--
-- storage.register("states/collected", states.collected, "states.collected")
--
-- local collected = states.collected
--
-- function states.collect(str)
--     collected[#collected+1] = str
-- end
--
-- function states.flush()
--     if #collected > 0 then
--         for i=1,#collected do
--             context(collected[i]) -- we're in context mode anyway
--         end
--         collected = { }
--         states.collected = collected
--     end
-- end
--
-- function states.check()
--     logs.report("states",concat(collected,"\n"))
-- end

-- we used to do the main processor loop here and call processor for each node
-- but eventually this was too much a slow down (1 sec on 23 for 120 pages mk)
-- so that we moved looping to the processor itself; this may lead to a bit of
-- duplicate code once that we have more state handlers

-- local function process_attribute(head,plugin) -- head,attribute,enabled,initializer,resolver,processor,finalizer
--     local namespace = plugin.namespace
--     if namespace.enabled ~= false then -- this test will go away
--         starttiming(attributes) -- in principle we could delegate this to the main caller
--         local done, used, ok = false, nil, false
--         local attribute = namespace.attribute or numbers[plugin.name] -- todo: plugin.attribute
--         local processor = plugin.processor
--         if processor then
--             local initializer = plugin.initializer
--             local resolver    = plugin.resolver
--             local inheritance = (resolver and resolver()) or nil -- -0x7FFFFFFF -- we can best use nil and skip !
--             if initializer then
--                 initializer(namespace,attribute,head)
--             end
--             head, ok = processor(namespace,attribute,head,inheritance)
--             if ok then
--                 local finalizer = plugin.finalizer
--                 if finalizer then
--                     head, ok, used = finalizer(namespace,attribute,head)
--                     if used then
--                         local flusher = plugin.flusher
--                         if flusher then
--                             head = flusher(namespace,attribute,head,used)
--                         end
--                     end
--                 end
--                 done = true
--             end
--         end
--         stoptiming(attributes)
--         return head, done
--     else
--         return head, false
--     end
-- end
--
-- function nodes.installattributehandler(plugin) -- we need to avoid this nested function
--     return function(head)
--         return process_attribute(head,plugin)
--     end
-- end

-- An experiment: lean and mean functions. It is not really faster but
-- with upcoming functionality it might make a difference, e.g. features
-- like 'casing' and 'italics' can be called a lot so there it makes sense.

nodes.plugindata = nil

local template = [[
local plugin = nodes.plugindata
local starttiming = statistics.starttiming
local stoptiming = statistics.stoptiming
local namespace = plugin.namespace
local attribute = namespace.attribute or attributes.numbers[plugin.name]
local processor = plugin.processor
local initializer = plugin.initializer
local resolver = plugin.resolver
local finalizer = plugin.finalizer
local flusher = plugin.flusher
if not processor then
    return function(head)
        return head, false
    end
elseif initializer or finalizer or resolver then
    return function(head)
        starttiming(attributes)
        local done, used, ok = false, nil, false
        local inheritance = (resolver and resolver()) or nil -- -0x7FFFFFFF -- we can best use nil and skip !
        if initializer then
            initializer(namespace,attribute,head)
        end
        head, ok = processor(namespace,attribute,head,inheritance)
        if ok then
            if finalizer then
                head, ok, used = finalizer(namespace,attribute,head)
                if used and flusher then
                    head = flusher(namespace,attribute,head,used)
                end
            end
            done = true
        end
        stoptiming(attributes)
        return head, done
    end
else
    return function(head)
        starttiming(attributes)
        local head, done = processor(namespace,attribute,head)
        stoptiming(attributes)
        return head, done
    end
end
nodes.plugindata = nil
]]

function nodes.installattributehandler(plugin)
    nodes.plugindata = plugin
    return loadstripped(template)()
end

-- the injectors

local insert_node_before = node.insert_before
local insert_node_after  = node.insert_after

local nsdata, nsnone, nslistwise, nsforced, nsselector, nstrigger
local current, current_selector, done = 0, 0, false -- nb, stack has a local current !
local nsbegin, nsend

function states.initialize(namespace,attribute,head)
    nsdata           = namespace.data
    nsnone           = namespace.none
    nsforced         = namespace.forced
    nsselector       = namespace.selector
    nslistwise       = namespace.listwise
    nstrigger        = triggering and namespace.triggering and a_trigger
    current          = 0
    current_selector = 0
    done             = false -- todo: done cleanup
    nsstep           = namespace.resolve_step
    if nsstep then
        nsbegin      = namespace.resolve_begin
        nsend        = namespace.resolve_end
        nspush       = namespace.push
        nspop        = namespace.pop
    end
end

function states.finalize(namespace,attribute,head) -- is this one ok?
    if current > 0 and nsnone then
        local id = head.id
        if id == hlist_code or id == vlist_code then
            local list = head.list
            if list then
                head.list = insert_node_before(list,list,copy_node(nsnone))
            end
        else
            head = insert_node_before(head,head,copy_node(nsnone))
        end
        return head, true, true
    end
    return head, false, false
end

-- disc nodes can be ignored
-- we need to deal with literals too (reset as well as oval)
-- if id == glyph_code or (id == whatsit_code and stack.subtype == pdfliteral_code) or (id == rule_code and stack.width ~= 0) or (id == glue_code and stack.leader) then

-- local function process(namespace,attribute,head,inheritance,default) -- one attribute
--     local stack, done = head, false
--     while stack do
--         local id = stack.id
--         if id == glyph_code or (id == rule_code and stack.width ~= 0) or (id == glue_code and stack.leader) then -- or disc_code
--             local c = stack[attribute]
--             if c then
--                 if default and c == inheritance then
--                     if current ~= default then
--                         head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                         current = default
--                         done = true
--                     end
--                 elseif current ~= c then
--                     head = insert_node_before(head,stack,copy_node(nsdata[c]))
--                     current = c
--                     done = true
--                 end
--                 -- here ? compare selective
--                 if id == glue_code then --leader
--                     -- same as *list
--                     local content = stack.leader
--                     if content then
--                         local savedcurrent = current
--                         local ci = content.id
--                         if ci == hlist_code or ci == vlist_code then
--                             -- else we reset inside a box unneeded, okay, the downside is
--                             -- that we trigger color in each repeated box, so there is room
--                             -- for improvement here
--                             current = 0
--                         end
--                         local ok = false
--                         if nstrigger and stack[nstrigger] then
--                             local outer = stack[attribute]
--                             if outer ~= inheritance then
--                                 stack.leader, ok = process(namespace,attribute,content,inheritance,outer)
--                             else
--                                 stack.leader, ok = process(namespace,attribute,content,inheritance,default)
--                             end
--                         else
--                             stack.leader, ok = process(namespace,attribute,content,inheritance,default)
--                         end
--                         current = savedcurrent
--                         done = done or ok
--                     end
--                 end
--             elseif default and inheritance then
--                 if current ~= default then
--                     head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                     current = default
--                     done = true
--                 end
--             elseif current > 0 then
--                 head = insert_node_before(head,stack,copy_node(nsnone))
--                 current = 0
--                 done = true
--             end
--         elseif id == hlist_code or id == vlist_code then
--             local content = stack.list
--             if content then
--                 local ok = false
--                 if nstrigger and stack[nstrigger] then
--                     local outer = stack[attribute]
--                     if outer ~= inheritance then
--                         stack.list, ok = process(namespace,attribute,content,inheritance,outer)
--                     else
--                         stack.list, ok = process(namespace,attribute,content,inheritance,default)
--                     end
--                 else
--                     stack.list, ok = process(namespace,attribute,content,inheritance,default)
--                 end
--                 done = done or ok
--             end
--         end
--         stack = stack.next
--     end
--     return head, done
-- end

-- local function process(namespace,attribute,head,inheritance,default) -- one attribute
--     local stack, done = head, false

--     local function check()
--         local c = stack[attribute]
--         if c then
--             if default and c == inheritance then
--                 if current ~= default then
--                     head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                     current = default
--                     done = true
--                 end
--             elseif current ~= c then
--                 head = insert_node_before(head,stack,copy_node(nsdata[c]))
--                 current = c
--                 done = true
--             end
--         elseif default and inheritance then
--             if current ~= default then
--                 head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                 current = default
--                 done = true
--             end
--         elseif current > 0 then
--             head = insert_node_before(head,stack,copy_node(nsnone))
--             current = 0
--             done = true
--         end
--         return c
--     end

--     local function nested(content)
--         if nstrigger and stack[nstrigger] then
--             local outer = stack[attribute]
--             if outer ~= inheritance then
--                 return process(namespace,attribute,content,inheritance,outer)
--             else
--                 return process(namespace,attribute,content,inheritance,default)
--             end
--         else
--             return process(namespace,attribute,content,inheritance,default)
--         end
--     end

--     while stack do
--         local id = stack.id
--         if id == glyph_code then
--             check()
--         elseif id == glue_code then
--             local content = stack.leader
--             if content and check() then
--                 local savedcurrent = current
--                 local ci = content.id
--                 if ci == hlist_code or ci == vlist_code then
--                     -- else we reset inside a box unneeded, okay, the downside is
--                     -- that we trigger color in each repeated box, so there is room
--                     -- for improvement here
--                     current = 0
--                 end

--                 local ok = false
--                 stack.leader, ok = nested(content)
--                 done = done or ok

--                 current = savedcurrent
--             end
--         elseif id == hlist_code or id == vlist_code then
--             local content = stack.list
--             if content then

--                 local ok = false
--                 stack.list, ok = nested(content)
--                 done = done or ok

--             end
--         elseif id == rule_code then
--             if stack.width ~= 0 then
--                 check()
--             end
--         end
--         stack = stack.next
--     end
--     return head, done
-- end

-- local function process(namespace,attribute,head,inheritance,default) -- one attribute
--     local stack, done = head, false
--     while stack do
--         local id = stack.id
--         if id == glyph_code then
--             -- begin of check
--             local c = stack[attribute]
--             if c then
--                 if default and c == inheritance then
--                     if current ~= default then
--                         head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                         current = default
--                         done = true
--                     end
--                 elseif current ~= c then
--                     head = insert_node_before(head,stack,copy_node(nsdata[c]))
--                     current = c
--                     done = true
--                 end
--             elseif default and inheritance then
--                 if current ~= default then
--                     head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                     current = default
--                     done = true
--                 end
--             elseif current > 0 then
--                 head = insert_node_before(head,stack,copy_node(nsnone))
--                 current = 0
--                 done = true
--             end
--             -- end of check
--         elseif id == glue_code then
--             local content = stack.leader
--             if content then
--                 -- begin of check
--                 local c = stack[attribute]
--                 if c then
--                     if default and c == inheritance then
--                         if current ~= default then
--                             head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                             current = default
--                             done = true
--                         end
--                     elseif current ~= c then
--                         head = insert_node_before(head,stack,copy_node(nsdata[c]))
--                         current = c
--                         done = true
--                     end
--                     -- begin special to this check
--                     local savedcurrent = current
--                     local ci = content.id
--                     if ci == hlist_code or ci == vlist_code then
--                         -- else we reset inside a box unneeded, okay, the downside is
--                         -- that we trigger color in each repeated box, so there is room
--                         -- for improvement here
--                         current = 0
--                     end
--                     -- begin nested --
--                     local ok = false
--                     if nstrigger and stack[nstrigger] then
--                         local outer = stack[attribute]
--                         if outer ~= inheritance then
--                             stack.leader, ok = process(namespace,attribute,content,inheritance,outer)
--                         else
--                             stack.leader, ok = process(namespace,attribute,content,inheritance,default)
--                         end
--                     else
--                         stack.leader, ok = process(namespace,attribute,content,inheritance,default)
--                     end
--                     -- end nested --
--                     done = done or ok
--                     current = savedcurrent
--                     -- end special to this check
--                 elseif default and inheritance then
--                     if current ~= default then
--                         head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                         current = default
--                         done = true
--                     end
--                 elseif current > 0 then
--                     head = insert_node_before(head,stack,copy_node(nsnone))
--                     current = 0
--                     done = true
--                 end
--                 -- end of check
--             end
--         elseif id == hlist_code or id == vlist_code then
--             local content = stack.list
--             if content then
--                 -- begin nested --
--                 local ok
--                 if nstrigger and stack[nstrigger] then
--                     local outer = stack[attribute]
--                     if outer ~= inheritance then
--                         stack.list, ok = process(namespace,attribute,content,inheritance,outer)
--                     else
--                         stack.list, ok = process(namespace,attribute,content,inheritance,default)
--                     end
--                 else
--                     stack.list, ok = process(namespace,attribute,content,inheritance,default)
--                 end
--                 -- end nested --
--                 done = done or ok
--             end
--         elseif id == rule_code then
--             if stack.width ~= 0 then
--                 -- begin of check
--                 local c = stack[attribute]
--                 if c then
--                     if default and c == inheritance then
--                         if current ~= default then
--                             head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                             current = default
--                             done = true
--                         end
--                     elseif current ~= c then
--                         head = insert_node_before(head,stack,copy_node(nsdata[c]))
--                         current = c
--                         done = true
--                     end
--                 elseif default and inheritance then
--                     if current ~= default then
--                         head = insert_node_before(head,stack,copy_node(nsdata[default]))
--                         current = default
--                         done = true
--                     end
--                 elseif current > 0 then
--                     head = insert_node_before(head,stack,copy_node(nsnone))
--                     current = 0
--                     done = true
--                 end
--                 -- end of check
--             end
--         end
--         stack = stack.next
--     end
--     return head, done
-- end

local function process(namespace,attribute,head,inheritance,default) -- one attribute
    local stack  = head
    local done   = false
    local check  = false
    local leader = nil
    while stack do
        local id = stack.id
        if id == glyph_code then
            check = true
        elseif id == glue_code then
            leader = stack.leader
            if leader then
                check = true
            end
        elseif id == hlist_code or id == vlist_code then
            local content = stack.list
            if content then
                -- begin nested --
                local ok
                if nstrigger and stack[nstrigger] then
                    local outer = stack[attribute]
                    if outer ~= inheritance then
                        stack.list, ok = process(namespace,attribute,content,inheritance,outer)
                    else
                        stack.list, ok = process(namespace,attribute,content,inheritance,default)
                    end
                else
                    stack.list, ok = process(namespace,attribute,content,inheritance,default)
                end
                -- end nested --
                done = done or ok
            end
        elseif id == rule_code then
            check = stack.width ~= 0
        end
        -- much faster this way than using a check() and nested() function
        if check then
            local c = stack[attribute]
            if c then
                if default and c == inheritance then
                    if current ~= default then
                        head = insert_node_before(head,stack,copy_node(nsdata[default]))
                        current = default
                        done = true
                    end
                elseif current ~= c then
                    head = insert_node_before(head,stack,copy_node(nsdata[c]))
                    current = c
                    done = true
                end
                if leader then
                    local savedcurrent = current
                    local ci = leader.id
                    if ci == hlist_code or ci == vlist_code then
                        -- else we reset inside a box unneeded, okay, the downside is
                        -- that we trigger color in each repeated box, so there is room
                        -- for improvement here
                        current = 0
                    end
                    -- begin nested --
                    local ok = false
                    if nstrigger and stack[nstrigger] then
                        local outer = stack[attribute]
                        if outer ~= inheritance then
                            stack.leader, ok = process(namespace,attribute,leader,inheritance,outer)
                        else
                            stack.leader, ok = process(namespace,attribute,leader,inheritance,default)
                        end
                    else
                        stack.leader, ok = process(namespace,attribute,leader,inheritance,default)
                    end
                    -- end nested --
                    done = done or ok
                    current = savedcurrent
                    leader = false
                end
            elseif default and inheritance then
                if current ~= default then
                    head = insert_node_before(head,stack,copy_node(nsdata[default]))
                    current = default
                    done = true
                end
            elseif current > 0 then
                head = insert_node_before(head,stack,copy_node(nsnone))
                current = 0
                done = true
            end
            check = false
        end
        stack = stack.next
    end
    return head, done
end

states.process = process

-- we can force a selector, e.g. document wide color spaces, saves a little
-- watch out, we need to check both the selector state (like colorspace) and
-- the main state (like color), otherwise we get into troubles when a selector
-- state changes while the main state stays the same (like two glyphs following
-- each other with the same color but different color spaces e.g. \showcolor)

-- local function selective(namespace,attribute,head,inheritance,default) -- two attributes
--     local stack, done = head, false
--     while stack do
--         local id = stack.id
--         -- we need to deal with literals too (reset as well as oval)
--         -- if id == glyph_code or (id == whatsit_code and stack.subtype == pdfliteral_code) or (id == rule_code and stack.width ~= 0) or (id == glue_code and stack.leader) then -- or disc_code
--         if id == glyph_code -- or id == disc_code
--                 or (id == rule_code and stack.width ~= 0) or (id == glue_code and stack.leader) then -- or disc_code
--             local c = stack[attribute]
--             if c then
--                 if default and c == inheritance then
--                     if current ~= default then
--                         local data = nsdata[default]
--                         head = insert_node_before(head,stack,copy_node(data[nsforced or stack[nsselector] or nsselector]))
--                         current = default
--                         done = true
--                     end
--                 else
--                     local s = stack[nsselector]
--                     if current ~= c or current_selector ~= s then
--                         local data = nsdata[c]
--                         head = insert_node_before(head,stack,copy_node(data[nsforced or stack[nsselector] or nsselector]))
--                         current = c
--                         current_selector = s
--                         done = true
--                     end
--                 end
--             elseif default and inheritance then
--                 if current ~= default then
--                     local data = nsdata[default]
--                     head = insert_node_before(head,stack,copy_node(data[nsforced or stack[nsselector] or nsselector]))
--                     current = default
--                     done = true
--                 end
--             elseif current > 0 then
--                 head = insert_node_before(head,stack,copy_node(nsnone))
--                 current, current_selector, done = 0, 0, true
--             end
--             if id == glue_code then -- leader
--                 -- same as *list
--                 local content = stack.leader
--                 if content then
--                     local savedcurrent = current
--                     local ci = content.id
--                     if ci == hlist_code or ci == vlist_code then
--                         -- else we reset inside a box unneeded, okay, the downside is
--                         -- that we trigger color in each repeated box, so there is room
--                         -- for improvement here
--                         current = 0
--                     end
--                     local ok = false
--                     if nstrigger and stack[nstrigger] then
--                         local outer = stack[attribute]
--                         if outer ~= inheritance then
--                             stack.leader, ok = selective(namespace,attribute,content,inheritance,outer)
--                         else
--                             stack.leader, ok = selective(namespace,attribute,content,inheritance,default)
--                         end
--                     else
--                         stack.leader, ok = selective(namespace,attribute,content,inheritance,default)
--                     end
--                     current = savedcurrent
--                     done = done or ok
--                 end
--             end
--         elseif id == hlist_code or id == vlist_code then
--             local content = stack.list
--             if content then
--                 local ok = false
--                 if nstrigger and stack[nstrigger] then
--                     local outer = stack[attribute]
--                     if outer ~= inheritance then
--                         stack.list, ok = selective(namespace,attribute,content,inheritance,outer)
--                     else
--                         stack.list, ok = selective(namespace,attribute,content,inheritance,default)
--                     end
--                 else
--                     stack.list, ok = selective(namespace,attribute,content,inheritance,default)
--                 end
--                 done = done or ok
--             end
--         end
--         stack = stack.next
--     end
--     return head, done
-- end

-- local function selective(namespace,attribute,head,inheritance,default) -- two attributes
--     local stack, done = head, false

--     local function check()
--         local c = stack[attribute]
--         if c then
--             if default and c == inheritance then
--                 if current ~= default then
--                     local data = nsdata[default]
--                     head = insert_node_before(head,stack,copy_node(data[nsforced or stack[nsselector] or nsselector]))
--                     current = default
--                     done = true
--                 end
--             else
--                 local s = stack[nsselector]
--                 if current ~= c or current_selector ~= s then
--                     local data = nsdata[c]
--                     head = insert_node_before(head,stack,copy_node(data[nsforced or stack[nsselector] or nsselector]))
--                     current = c
--                     current_selector = s
--                     done = true
--                 end
--             end
--         elseif default and inheritance then
--             if current ~= default then
--                 local data = nsdata[default]
--                 head = insert_node_before(head,stack,copy_node(data[nsforced or stack[nsselector] or nsselector]))
--                 current = default
--                 done = true
--             end
--         elseif current > 0 then
--             head = insert_node_before(head,stack,copy_node(nsnone))
--             current, current_selector, done = 0, 0, true
--         end
--         return c
--     end

--     local function nested(content)
--         if nstrigger and stack[nstrigger] then
--             local outer = stack[attribute]
--             if outer ~= inheritance then
--                 return selective(namespace,attribute,content,inheritance,outer)
--             else
--                 return selective(namespace,attribute,content,inheritance,default)
--             end
--         else
--             return selective(namespace,attribute,content,inheritance,default)
--         end
--     end

--     while stack do
--         local id = stack.id
--         if id == glyph_code then
--             check()
--         elseif id == glue_code then
--             local content = stack.leader
--             if content and check() then
--              -- local savedcurrent = current
--              -- local ci = content.id
--              -- if ci == hlist_code or ci == vlist_code then
--              --     -- else we reset inside a box unneeded, okay, the downside is
--              --     -- that we trigger color in each repeated box, so there is room
--              --     -- for improvement here
--              --     current = 0
--              -- end

--                 local ok = false
--                 stack.leader, ok = nested(content)
--                 done = done or ok

--              -- current = savedcurrent
--             end
--         elseif id == hlist_code or id == vlist_code then
--             local content = stack.list
--             if content then

--                 local ok = false
--                 stack.list, ok = nested(content)
--                 done = done or ok

--             end
--         elseif id == rule_code then
--             if stack.width ~= 0 then
--                 check()
--             end
--         end
--         stack = stack.next
--     end
--     return head, done
-- end

local function selective(namespace,attribute,head,inheritance,default) -- two attributes
    local stack  = head
    local done   = false
    local check  = false
    local leader = nil
    while stack do
        local id = stack.id
        if id == glyph_code then
            check = true
        elseif id == glue_code then
            leader = stack.leader
            if leader then
                check = true
            end
        elseif id == hlist_code or id == vlist_code then
            local content = stack.list
            if content then
                local ok = false
                -- begin nested
                if nstrigger and stack[nstrigger] then
                    local outer = stack[attribute]
                    if outer ~= inheritance then
                        stack.list, ok = selective(namespace,attribute,content,inheritance,outer)
                    else
                        stack.list, ok = selective(namespace,attribute,content,inheritance,default)
                    end
                else
                    stack.list, ok = selective(namespace,attribute,content,inheritance,default)
                end
                -- end nested
                done = done or ok
            end
        elseif id == rule_code then
            check = stack.width ~= 0
        end

        if check then
            local c = stack[attribute]
            if c then
                if default and c == inheritance then
                    if current ~= default then
                        local data = nsdata[default]
                        head = insert_node_before(head,stack,copy_node(data[nsforced or stack[nsselector] or nsselector]))
                        current = default
                        done = true
                    end
                else
                    local s = stack[nsselector]
                    if current ~= c or current_selector ~= s then
                        local data = nsdata[c]
                        head = insert_node_before(head,stack,copy_node(data[nsforced or stack[nsselector] or nsselector]))
                        current = c
                        current_selector = s
                        done = true
                    end
                end
                if leader then
                    local ok = false
                    -- begin nested
                    if nstrigger and stack[nstrigger] then
                        local outer = stack[attribute]
                        if outer ~= inheritance then
                            stack.leader, ok = selective(namespace,attribute,leader,inheritance,outer)
                        else
                            stack.leader, ok = selective(namespace,attribute,leader,inheritance,default)
                        end
                    else
                        stack.leader, ok = selective(namespace,attribute,leader,inheritance,default)
                    end
                    -- end nested
                    done = done or ok
                    leader = false
                end
            elseif default and inheritance then
                if current ~= default then
                    local data = nsdata[default]
                    head = insert_node_before(head,stack,copy_node(data[nsforced or stack[nsselector] or nsselector]))
                    current = default
                    done = true
                end
            elseif current > 0 then
                head = insert_node_before(head,stack,copy_node(nsnone))
                current, current_selector, done = 0, 0, true
            end
            check = false
        end

        stack = stack.next
    end
    return head, done
end

states.selective = selective

-- Ideally the next one should be merged with the previous but keeping it separate is
-- safer. We deal with two situations: efficient boxwise (layoutareas) and mixed layers
-- (as used in the stepper). In the stepper we cannot use the box branch as it involves
-- paragraph lines and then gets mixed up. A messy business (esp since we want to be
-- efficient).
--
-- Todo: make a better stacker. Keep track (in attribute) about nesting level. Not
-- entirely trivial and a generic solution is nicer (compares to the exporter).

-- local function stacked(namespace,attribute,head,default) -- no triggering, no inheritance, but list-wise
--     local stack, done = head, false
--     local current, depth = default or 0, 0
--
--     local function check()
--         local a = stack[attribute]
--         if a then
--             if current ~= a then
--                 head = insert_node_before(head,stack,copy_node(nsdata[a]))
--                 depth = depth + 1
--                 current, done = a, true
--             end
--         elseif default > 0 then
--             --
--         elseif current > 0 then
--             head = insert_node_before(head,stack,copy_node(nsnone))
--             depth = depth - 1
--             current, done = 0, true
--         end
--         return a
--     end
--
--     while stack do
--         local id = stack.id
--         if id == glyph_code then
--             check()
--         elseif id == glue_code then
--             local content = stack.leader
--             if content and check() then
--                 local ok = false
--                 stack.leader, ok = stacked(namespace,attribute,content,current)
--                 done = done or ok
--             end
--         elseif id == hlist_code or id == vlist_code then
--             local content = stack.list
--             if content then
--              -- the problem is that broken lines gets the attribute which can be a later one
--                 if nslistwise then
--                     local a = stack[attribute]
--                     if a and current ~= a and nslistwise[a] then -- viewerlayer / needs checking, see below
--                         local p = current
--                         current, done = a, true
--                         head = insert_node_before(head,stack,copy_node(nsdata[a]))
--                         stack.list = stacked(namespace,attribute,content,current)
--                         head, stack = insert_node_after(head,stack,copy_node(nsnone))
--                         current = p
--                     else
--                         local ok = false
--                         stack.list, ok = stacked(namespace,attribute,content,current)
--                         done = done or ok
--                     end
--                 else
--                     local ok = false
--                     stack.list, ok = stacked(namespace,attribute,content,current)
--                     done = done or ok
--                 end
--             end
--         elseif id == rule_code then
--             if stack.width ~= 0 then
--                 check()
--             end
--         end
--         stack = stack.next
--     end
--     while depth > 0 do
--         head = insert_node_after(head,stack,copy_node(nsnone))
--         depth = depth - 1
--     end
--     return head, done
-- end

local function stacked(namespace,attribute,head,default) -- no triggering, no inheritance, but list-wise
    local stack   = head
    local done    = false
    local current = default or 0
    local depth   = 0
    local check   = false
    local leader  = false
    while stack do
        local id = stack.id
        if id == glyph_code then
            check = true
        elseif id == glue_code then
            leader = stack.leader
            if leader then
                check = true
            end
        elseif id == hlist_code or id == vlist_code then
            local content = stack.list
            if content then
             -- the problem is that broken lines gets the attribute which can be a later one
                if nslistwise then
                    local a = stack[attribute]
                    if a and current ~= a and nslistwise[a] then -- viewerlayer / needs checking, see below
                        local p = current
                        current, done = a, true
                        head = insert_node_before(head,stack,copy_node(nsdata[a]))
                        stack.list = stacked(namespace,attribute,content,current)
                        head, stack = insert_node_after(head,stack,copy_node(nsnone))
                        current = p
                    else
                        local ok = false
                        stack.list, ok = stacked(namespace,attribute,content,current)
                        done = done or ok
                    end
                else
                    local ok = false
                    stack.list, ok = stacked(namespace,attribute,content,current)
                    done = done or ok
                end
            end
        elseif id == rule_code then
            check = stack.width ~= 0
        end

        if check then
            local a = stack[attribute]
            if a then
                if current ~= a then
                    head = insert_node_before(head,stack,copy_node(nsdata[a]))
                    depth = depth + 1
                    current, done = a, true
                end
                if leader then
                    local ok = false
                    stack.leader, ok = stacked(namespace,attribute,content,current)
                    done = done or ok
                    leader = false
                end
            elseif default > 0 then
                --
            elseif current > 0 then
                head = insert_node_before(head,stack,copy_node(nsnone))
                depth = depth - 1
                current, done = 0, true
            end
            check = false
        end

        stack = stack.next
    end
    while depth > 0 do
        head = insert_node_after(head,stack,copy_node(nsnone))
        depth = depth - 1
    end
    return head, done
end

states.stacked = stacked

-- experimental

-- local function stacker(namespace,attribute,head,default) -- no triggering, no inheritance, but list-wise
--     nsbegin()
--     local current, previous, done, okay = head, head, false, false
--     local attrib = default or unsetvalue
--
--     local function check()
--         local a = current[attribute] or unsetvalue
--         if a ~= attrib then
--             local n = nsstep(a)
--             if n then
--              -- !!!! TEST CODE !!!!
--              -- head = insert_node_before(head,current,copy_node(nsdata[tonumber(n)])) -- a
--                 head = insert_node_before(head,current,n) -- a
--             end
--             attrib, done, okay = a, true, true
--         end
--         return a
--     end
--
--     while current do
--         local id = current.id
--         if id == glyph_code then
--             check()
--         elseif id == glue_code then
--             local content = current.leader
--             if content and check() then
--                 -- tricky as a leader has to be a list so we cannot inject before
--                 local _, ok = stacker(namespace,attribute,content,attrib)
--                 done = done or ok
--             end
--         elseif id == hlist_code or id == vlist_code then
--             local content = current.list
--             if not content then
--                 -- skip
--             elseif nslistwise then
--                 local a = current[attribute]
--                 if a and attrib ~= a and nslistwise[a] then -- viewerlayer
--                     done = true
--                     head = insert_node_before(head,current,copy_node(nsdata[a]))
--                     current.list = stacker(namespace,attribute,content,a)
--                     head, current = insert_node_after(head,current,copy_node(nsnone))
--                 else
--                     local ok = false
--                     current.list, ok = stacker(namespace,attribute,content,attrib)
--                     done = done or ok
--                 end
--             else
--                 local ok = false
--                 current.list, ok = stacker(namespace,attribute,content,default)
--                 done = done or ok
--             end
--         elseif id == rule_code then
--             if current.width ~= 0 then
--                 check()
--             end
--         end
--         previous = current
--         current = current.next
--     end
--     if okay then
--         local n = nsend()
--         if n then
--              -- !!!! TEST CODE !!!!
--          -- head = insert_node_after(head,previous,copy_node(nsdata[tostring(n)]))
--             head = insert_node_after(head,previous,n)
--         end
--     end
--     return head, done
-- end

local function stacker(namespace,attribute,head,default) -- no triggering, no inheritance, but list-wise
    nsbegin()
    local current  = head
    local previous = head
    local done     = false
    local okay     = false
    local attrib   = default or unsetvalue
    local check    = false
    local leader   = false
    while current do
        local id = current.id
        if id == glyph_code then
            check = true
        elseif id == glue_code then
            leader = current.leader
            if leader then
                check = true
            end
        elseif id == hlist_code or id == vlist_code then
            local content = current.list
            if not content then
                -- skip
            elseif nslistwise then
                local a = current[attribute]
                if a and attrib ~= a and nslistwise[a] then -- viewerlayer
                    done = true
                    head = insert_node_before(head,current,copy_node(nsdata[a]))
                    current.list = stacker(namespace,attribute,content,a)
                    head, current = insert_node_after(head,current,copy_node(nsnone))
                else
                    local ok = false
                    current.list, ok = stacker(namespace,attribute,content,attrib)
                    done = done or ok
                end
            else
                local ok = false
                current.list, ok = stacker(namespace,attribute,content,default)
                done = done or ok
            end
        elseif id == rule_code then
            check = current.width ~= 0
        end

        if check then
            local a = current[attribute] or unsetvalue
            if a ~= attrib then
                local n = nsstep(a)
                if n then
                 -- !!!! TEST CODE !!!!
                 -- head = insert_node_before(head,current,copy_node(nsdata[tonumber(n)])) -- a
                    head = insert_node_before(head,current,n) -- a
                end
                attrib, done, okay = a, true, true
                if leader then
                    -- tricky as a leader has to be a list so we cannot inject before
                    local _, ok = stacker(namespace,attribute,leader,attrib)
                    done = done or ok
                    leader = false
                end
            end
            check = false
        end

        previous = current
        current = current.next
    end
    if okay then
        local n = nsend()
        if n then
             -- !!!! TEST CODE !!!!
         -- head = insert_node_after(head,previous,copy_node(nsdata[tostring(n)]))
            head = insert_node_after(head,previous,n)
        end
    end
    return head, done
end

states.stacker = stacker

-- -- --

statistics.register("attribute processing time", function()
    return statistics.elapsedseconds(attributes,"front- and backend")
end)