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
|
--
-- This is file `tagpdf.lua',
-- generated with the docstrip utility.
--
-- The original source files were:
--
-- tagpdf-backend.dtx (with options: `lua')
--
-- Copyright (C) 2019-2023 Ulrike Fischer
--
-- It may be distributed and/or modified under the conditions of
-- the LaTeX Project Public License (LPPL), either version 1.3c of
-- this license or (at your option) any later version. The latest
-- version of this license is in the file:
--
-- https://www.latex-project.org/lppl.txt
--
-- This file is part of the "tagpdf bundle" (The Work in LPPL)
-- and all files in that bundle must be distributed together.
--
-- File: tagpdf-backend.dtx
-- tagpdf.lua
-- Ulrike Fischer
local ProvidesLuaModule = {
name = "tagpdf",
version = "0.98o", --TAGVERSION
date = "2023-11-13", --TAGDATE
description = "tagpdf lua code",
license = "The LATEX Project Public License 1.3c"
}
if luatexbase and luatexbase.provides_module then
luatexbase.provides_module (ProvidesLuaModule)
end
--[[
The code has quite probably a number of problems
- more variables should be local instead of global
- the naming is not always consistent due to the development of the code
- the traversing of the shipout box must be tested with more complicated setups
- it should probably handle more node types
-
--]]
--[[
the main table is named ltx.__tag. It contains the functions and also the data
collected during the compilation.
ltx.__tag.mc will contain mc connected data.
ltx.__tag.struct will contain structure related data.
ltx.__tag.page will contain page data
ltx.__tag.tables contains also data from mc and struct (from older code). This needs cleaning up.
There are certainly dublettes, but I don't dare yet ...
ltx.__tag.func will contain (public) functions.
ltx.__tag.trace will contain tracing/loging functions.
local funktions starts with __
functions meant for users will be in ltx.tag
functions
ltx.__tag.func.get_num_from (tag): takes a tag (string) and returns the id number
ltx.__tag.func.output_num_from (tag): takes a tag (string) and prints (to tex) the id number
ltx.__tag.func.get_tag_from (num): takes a num and returns the tag
ltx.__tag.func.output_tag_from (num): takes a num and prints (to tex) the tag
ltx.__tag.func.store_mc_data (num,key,data): stores key=data in ltx.__tag.mc[num]
ltx.__tag.func.store_mc_label (label,num): stores label=num in ltx.__tag.mc.labels
ltx.__tag.func.store_mc_kid (mcnum,kid,page): stores the mc-kids of mcnum on page page
ltx.__tag.func.store_mc_in_page(mcnum,mcpagecnt,page): stores in the page table the number of mcnum on this page
ltx.__tag.func.store_struct_mcabs (structnum,mcnum): stores relations structnum<->mcnum (abs)
ltx.__tag.func.mc_insert_kids (mcnum): inserts the /K entries for mcnum by wandering throught the [kids] table
ltx.__tag.func.mark_page_elements(box,mcpagecnt,mccntprev,mcopen,name,mctypeprev) : the main function
ltx.__tag.func.mark_shipout (): a wrapper around the core function which inserts the last EMC
ltx.__tag.func.fill_parent_tree_line (page): outputs the entries of the parenttree for this page
ltx.__tag.func.output_parenttree(): outputs the content of the parenttree
ltx.__tag.func.pdf_object_ref(name): outputs the object reference for the object name
ltx.__tag.func.markspaceon(), ltx.__tag.func.markspaceoff(): (de)activates the marking of positions for space chars
ltx.__tag.trace.show_mc_data (num,loglevel): shows ltx.__tag.mc[num] is the current log level is >= loglevel
ltx.__tag.trace.show_all_mc_data (max,loglevel): shows a maximum about mc's if the current log level is >= loglevel
ltx.__tag.trace.show_seq: shows a sequence (array)
ltx.__tag.trace.show_struct_data (num): shows data of structure num
ltx.__tag.trace.show_prop: shows a prop
ltx.__tag.trace.log
ltx.__tag.trace.showspaces : boolean
--]]
local mctypeattributeid = luatexbase.new_attribute ("g__tag_mc_type_attr")
local mccntattributeid = luatexbase.new_attribute ("g__tag_mc_cnt_attr")
local iwspaceattributeid = luatexbase.new_attribute ("g__tag_interwordspace_attr")
local iwfontattributeid = luatexbase.new_attribute ("g__tag_interwordfont_attr")
local tagunmarkedbool= token.create("g__tag_tagunmarked_bool")
local truebool = token.create("c_true_bool")
local catlatex = luatexbase.registernumber("catcodetable@latex")
local tableinsert = table.insert
local nodeid = node.id
local nodecopy = node.copy
local nodegetattribute = node.get_attribute
local nodesetattribute = node.set_attribute
local nodehasattribute = node.has_attribute
local nodenew = node.new
local nodetail = node.tail
local nodeslide = node.slide
local noderemove = node.remove
local nodetraverseid = node.traverse_id
local nodetraverse = node.traverse
local nodeinsertafter = node.insert_after
local nodeinsertbefore = node.insert_before
local pdfpageref = pdf.pageref
local fonthashes = fonts.hashes
local identifiers = fonthashes.identifiers
local fontid = font.id
local HLIST = node.id("hlist")
local VLIST = node.id("vlist")
local RULE = node.id("rule")
local DISC = node.id("disc")
local GLUE = node.id("glue")
local GLYPH = node.id("glyph")
local KERN = node.id("kern")
local PENALTY = node.id("penalty")
local LOCAL_PAR = node.id("local_par")
local MATH = node.id("math")
ltx = ltx or { }
ltx.__tag = ltx.__tag or { }
ltx.__tag.mc = ltx.__tag.mc or { } -- mc data
ltx.__tag.struct = ltx.__tag.struct or { } -- struct data
ltx.__tag.tables = ltx.__tag.tables or { } -- tables created with new prop and new seq.
-- wasn't a so great idea ...
-- g__tag_role_tags_seq used by tag<-> is in this tables!
-- used for pure lua tables too now!
ltx.__tag.page = ltx.__tag.page or { } -- page data, currently only i->{0->mcnum,1->mcnum,...}
ltx.__tag.trace = ltx.__tag.trace or { } -- show commands
ltx.__tag.func = ltx.__tag.func or { } -- functions
ltx.__tag.conf = ltx.__tag.conf or { } -- configuration variables
local __tag_log =
function (message,loglevel)
if (loglevel or 3) <= tex.count["l__tag_loglevel_int"] then
texio.write_nl("tagpdf: ".. message)
end
end
ltx.__tag.trace.log = __tag_log
function ltx.__tag.trace.show_seq (seq)
if (type(seq) == "table") then
for i,v in ipairs(seq) do
__tag_log ("[" .. i .. "] => " .. tostring(v),1)
end
else
__tag_log ("sequence " .. tostring(seq) .. " not found",1)
end
end
local __tag_pairs_prop =
function (prop)
local a = {}
for n in pairs(prop) do tableinsert(a, n) end
table.sort(a)
local i = 0 -- iterator variable
local iter = function () -- iterator function
i = i + 1
if a[i] == nil then return nil
else return a[i], prop[a[i]]
end
end
return iter
end
function ltx.__tag.trace.show_prop (prop)
if (type(prop) == "table") then
for i,v in __tag_pairs_prop (prop) do
__tag_log ("[" .. i .. "] => " .. tostring(v),1)
end
else
__tag_log ("prop " .. tostring(prop) .. " not found or not a table",1)
end
end
function ltx.__tag.trace.show_mc_data (num,loglevel)
if ltx.__tag and ltx.__tag.mc and ltx.__tag.mc[num] then
for k,v in pairs(ltx.__tag.mc[num]) do
__tag_log ("mc"..num..": "..tostring(k).."=>"..tostring(v),loglevel)
end
if ltx.__tag.mc[num]["kids"] then
__tag_log ("mc" .. num .. " has " .. #ltx.__tag.mc[num]["kids"] .. " kids",loglevel)
for k,v in ipairs(ltx.__tag.mc[num]["kids"]) do
__tag_log ("mc ".. num .. " kid "..k.." =>" .. v.kid.." on page " ..v.page,loglevel)
end
end
else
__tag_log ("mc"..num.." not found",loglevel)
end
end
function ltx.__tag.trace.show_all_mc_data (min,max,loglevel)
for i = min, max do
ltx.__tag.trace.show_mc_data (i,loglevel)
end
texio.write_nl("")
end
function ltx.__tag.trace.show_struct_data (num)
if ltx.__tag and ltx.__tag.struct and ltx.__tag.struct[num] then
for k,v in ipairs(ltx.__tag.struct[num]) do
__tag_log ("struct "..num..": "..tostring(k).."=>"..tostring(v),1)
end
else
__tag_log ("struct "..num.." not found ",1)
end
end
local __tag_get_mc_cnt_type_tag = function (n)
local mccnt = nodegetattribute(n,mccntattributeid) or -1
local mctype = nodegetattribute(n,mctypeattributeid) or -1
local tag = ltx.__tag.func.get_tag_from(mctype)
return mccnt,mctype,tag
end
local function __tag_get_mathsubtype (mathnode)
if mathnode.subtype == 0 then
subtype = "beginmath"
else
subtype = "endmath"
end
return subtype
end
ltx.__tag.tables.role_tag_attribute = {}
ltx.__tag.tables.role_attribute_tag = {}
local __tag_alloctag =
function (tag)
if not ltx.__tag.tables.role_tag_attribute[tag] then
table.insert(ltx.__tag.tables.role_attribute_tag,tag)
ltx.__tag.tables.role_tag_attribute[tag]=#ltx.__tag.tables.role_attribute_tag
__tag_log ("Add "..tag.." "..ltx.__tag.tables.role_tag_attribute[tag],3)
end
end
ltx.__tag.func.alloctag = __tag_alloctag
local __tag_get_num_from =
function (tag)
if ltx.__tag.tables.role_tag_attribute[tag] then
a= ltx.__tag.tables.role_tag_attribute[tag]
else
a= -1
end
return a
end
ltx.__tag.func.get_num_from = __tag_get_num_from
function ltx.__tag.func.output_num_from (tag)
local num = __tag_get_num_from (tag)
tex.sprint(catlatex,num)
if num == -1 then
__tag_log ("Unknown tag "..tag.." used")
end
end
local __tag_get_tag_from =
function (num)
if ltx.__tag.tables.role_attribute_tag[num] then
a = ltx.__tag.tables.role_attribute_tag[num]
else
a= "UNKNOWN"
end
return a
end
ltx.__tag.func.get_tag_from = __tag_get_tag_from
function ltx.__tag.func.output_tag_from (num)
tex.sprint(catlatex,__tag_get_tag_from (num))
end
function ltx.__tag.func.store_mc_data (num,key,data)
ltx.__tag.mc[num] = ltx.__tag.mc[num] or { }
ltx.__tag.mc[num][key] = data
__tag_log ("INFO TEX-STORE-MC-DATA: "..num.." => "..tostring(key).." => "..tostring(data),3)
end
function ltx.__tag.func.store_mc_label (label,num)
ltx.__tag.mc["labels"] = ltx.__tag.mc["labels"] or { }
ltx.__tag.mc.labels[label] = num
end
function ltx.__tag.func.store_mc_kid (mcnum,kid,page)
ltx.__tag.trace.log("INFO TAG-STORE-MC-KID: "..mcnum.." => " .. kid.." on page " .. page,3)
ltx.__tag.mc[mcnum]["kids"] = ltx.__tag.mc[mcnum]["kids"] or { }
local kidtable = {kid=kid,page=page}
tableinsert(ltx.__tag.mc[mcnum]["kids"], kidtable )
end
function ltx.__tag.func.mc_num_of_kids (mcnum)
local num = 0
if ltx.__tag.mc[mcnum] and ltx.__tag.mc[mcnum]["kids"] then
num = #ltx.__tag.mc[mcnum]["kids"]
end
ltx.__tag.trace.log ("INFO MC-KID-NUMBERS: " .. mcnum .. "has " .. num .. "KIDS",4)
return num
end
local __tag_backend_create_emc_node
if tex.outputmode == 0 then
if token.get_macro("c_sys_backend_str") == "dvipdfmx" then
function __tag_backend_create_emc_node ()
local emcnode = nodenew("whatsit","special")
emcnode.data = "pdf:code EMC"
return emcnode
end
else -- assume a dvips variant
function __tag_backend_create_emc_node ()
local emcnode = nodenew("whatsit","special")
emcnode.data = "ps:SDict begin mark /EMC pdfmark end"
return emcnode
end
end
else -- pdf mode
function __tag_backend_create_emc_node ()
local emcnode = nodenew("whatsit","pdf_literal")
emcnode.data = "EMC"
emcnode.mode=1
return emcnode
end
end
local function __tag_insert_emc_node (head,current)
local emcnode= __tag_backend_create_emc_node()
head = node.insert_before(head,current,emcnode)
return head
end
local __tag_backend_create_bmc_node
if tex.outputmode == 0 then
if token.get_macro("c_sys_backend_str") == "dvipdfmx" then
function __tag_backend_create_bmc_node (tag)
local bmcnode = nodenew("whatsit","special")
bmcnode.data = "pdf:code /"..tag.." BMC"
return bmcnode
end
else -- assume a dvips variant
function __tag_backend_create_bmc_node (tag)
local bmcnode = nodenew("whatsit","special")
bmcnode.data = "ps:SDict begin mark/"..tag.." BMC pdfmark end"
return bmcnode
end
end
else -- pdf mode
function __tag_backend_create_bmc_node (tag)
local bmcnode = nodenew("whatsit","pdf_literal")
bmcnode.data = "/"..tag.." BMC"
bmcnode.mode=1
return bmcnode
end
end
local function __tag_insert_bmc_node (head,current,tag)
local bmcnode = __tag_backend_create_bmc_node (tag)
head = node.insert_before(head,current,bmcnode)
return head
end
local __tag_backend_create_bdc_node
if tex.outputmode == 0 then
if token.get_macro("c_sys_backend_str") == "dvipdfmx" then
function __tag_backend_create_bdc_node (tag,dict)
local bdcnode = nodenew("whatsit","special")
bdcnode.data = "pdf:code /"..tag.."<<"..dict..">> BDC"
return bdcnode
end
else -- assume a dvips variant
function __tag_backend_create_bdc_node (tag,dict)
local bdcnode = nodenew("whatsit","special")
bdcnode.data = "ps:SDict begin mark/"..tag.."<<"..dict..">> BDC pdfmark end"
return bdcnode
end
end
else -- pdf mode
function __tag_backend_create_bdc_node (tag,dict)
local bdcnode = nodenew("whatsit","pdf_literal")
bdcnode.data = "/"..tag.."<<"..dict..">> BDC"
bdcnode.mode=1
return bdcnode
end
end
local function __tag_insert_bdc_node (head,current,tag,dict)
bdcnode= __tag_backend_create_bdc_node (tag,dict)
head = node.insert_before(head,current,bdcnode)
return head
end
local function __tag_pdf_object_ref (name)
local tokenname = 'c__pdf_backend_object_'..name..'_int'
local object = token.create(tokenname).index..' 0 R'
return object
end
ltx.__tag.func.pdf_object_ref=__tag_pdf_object_ref
local function __tag_show_spacemark (head,current,color,height)
local markcolor = color or "1 0 0"
local markheight = height or 10
local pdfstring
if tex.outputmode == 0 then
-- ignore dvi mode for now
else
pdfstring = node.new("whatsit","pdf_literal")
pdfstring.data =
string.format("q "..markcolor.." RG "..markcolor.." rg 0.4 w 0 %g m 0 %g l S Q",-3,markheight)
head = node.insert_after(head,current,pdfstring)
return head
end
end
local function __tag_fakespace()
tex.setattribute(iwspaceattributeid,1)
tex.setattribute(iwfontattributeid,font.current())
end
ltx.__tag.func.fakespace = __tag_fakespace
--[[ a function to mark up places where real space chars should be inserted
it only sets an attribute.
--]]
local function __tag_mark_spaces (head)
local inside_math = false
for n in nodetraverse(head) do
local id = n.id
if id == GLYPH then
local glyph = n
if glyph.next and (glyph.next.id == GLUE)
and not inside_math and (glyph.next.width >0)
then
nodesetattribute(glyph.next,iwspaceattributeid,1)
nodesetattribute(glyph.next,iwfontattributeid,glyph.font)
-- for debugging
if ltx.__tag.trace.showspaces then
__tag_show_spacemark (head,glyph)
end
elseif glyph.next and (glyph.next.id==KERN) and not inside_math then
local kern = glyph.next
if kern.next and (kern.next.id== GLUE) and (kern.next.width >0)
then
nodesetattribute(kern.next,iwspaceattributeid,1)
nodesetattribute(kern.next,iwfontattributeid,glyph.font)
end
end
-- look also back
if glyph.prev and (glyph.prev.id == GLUE)
and not inside_math
and (glyph.prev.width >0)
and not nodehasattribute(glyph.prev,iwspaceattributeid)
then
nodesetattribute(glyph.prev,iwspaceattributeid,1)
nodesetattribute(glyph.prev,iwfontattributeid,glyph.font)
-- for debugging
if ltx.__tag.trace.showspaces then
__tag_show_spacemark (head,glyph)
end
end
elseif id == PENALTY then
local glyph = n
-- ltx.__tag.trace.log ("PENALTY ".. n.subtype.."VALUE"..n.penalty,3)
if glyph.next and (glyph.next.id == GLUE)
and not inside_math and (glyph.next.width >0) and n.subtype==0
then
nodesetattribute(glyph.next,iwspaceattributeid,1)
-- nodesetattribute(glyph.next,iwfontattributeid,glyph.font)
-- for debugging
if ltx.__tag.trace.showspaces then
__tag_show_spacemark (head,glyph)
end
end
elseif id == MATH then
inside_math = (n.subtype == 0)
end
end
return head
end
local function __tag_activate_mark_space ()
if not luatexbase.in_callback ("pre_linebreak_filter","markspaces") then
luatexbase.add_to_callback("pre_linebreak_filter",__tag_mark_spaces,"markspaces")
luatexbase.add_to_callback("hpack_filter",__tag_mark_spaces,"markspaces")
end
end
ltx.__tag.func.markspaceon=__tag_activate_mark_space
local function __tag_deactivate_mark_space ()
if luatexbase.in_callback ("pre_linebreak_filter","markspaces") then
luatexbase.remove_from_callback("pre_linebreak_filter","markspaces")
luatexbase.remove_from_callback("hpack_filter","markspaces")
end
end
ltx.__tag.func.markspaceoff=__tag_deactivate_mark_space
local default_space_char = nodenew(GLYPH)
local default_fontid = fontid("TU/lmr/m/n/10")
default_space_char.char = 32
default_space_char.font = default_fontid
local function __tag_font_has_space (fontid)
t= fonts.hashes.identifiers[fontid]
if luaotfload.aux.slot_of_name(fontid,"space")
or t.characters and t.characters[32] and t.characters[32]["unicode"]==32
then
return true
else
return false
end
end
local function __tag_space_chars_shipout (box)
local head = box.head
if head then
for n in node.traverse(head) do
local spaceattr = nodegetattribute(n,iwspaceattributeid) or -1
if n.id == HLIST then -- enter the hlist
__tag_space_chars_shipout (n)
elseif n.id == VLIST then -- enter the vlist
__tag_space_chars_shipout (n)
elseif n.id == GLUE then
if ltx.__tag.trace.showspaces and spaceattr==1 then
__tag_show_spacemark (head,n,"0 1 0")
end
if spaceattr==1 then
local space
local space_char = node.copy(default_space_char)
local curfont = nodegetattribute(n,iwfontattributeid)
ltx.__tag.trace.log ("INFO SPACE-FUNCTION-FONT: ".. tostring(curfont),3)
if curfont and
-- luaotfload.aux.slot_of_name(curfont,"space")
__tag_font_has_space (curfont)
then
space_char.font=curfont
end
head, space = node.insert_before(head, n, space_char) --
n.width = n.width - space.width
space.attr = n.attr
end
end
end
box.head = head
end
end
function ltx.__tag.func.space_chars_shipout (box)
__tag_space_chars_shipout (box)
end
function ltx.__tag.func.mc_insert_kids (mcnum,single)
if ltx.__tag.mc[mcnum] then
ltx.__tag.trace.log("INFO TEX-MC-INSERT-KID-TEST: " .. mcnum,4)
if ltx.__tag.mc[mcnum]["kids"] then
if #ltx.__tag.mc[mcnum]["kids"] > 1 and single==1 then
tex.sprint("[")
end
for i,kidstable in ipairs( ltx.__tag.mc[mcnum]["kids"] ) do
local kidnum = kidstable["kid"]
local kidpage = kidstable["page"]
local kidpageobjnum = pdfpageref(kidpage)
ltx.__tag.trace.log("INFO TEX-MC-INSERT-KID: " .. mcnum ..
" insert KID " ..i..
" with num " .. kidnum ..
" on page " .. kidpage.."/"..kidpageobjnum,3)
tex.sprint(catlatex,"<</Type /MCR /Pg "..kidpageobjnum .. " 0 R /MCID "..kidnum.. ">> " )
end
if #ltx.__tag.mc[mcnum]["kids"] > 1 and single==1 then
tex.sprint("]")
end
else
-- this is typically not a problem, e.g. empty hbox in footer/header can
-- trigger this warning.
ltx.__tag.trace.log("WARN TEX-MC-INSERT-NO-KIDS: "..mcnum.." has no kids",2)
if single==1 then
tex.sprint("null")
end
end
else
ltx.__tag.trace.log("WARN TEX-MC-INSERT-MISSING: "..mcnum.." doesn't exist",0)
end
end
function ltx.__tag.func.store_struct_mcabs (structnum,mcnum)
ltx.__tag.struct[structnum]=ltx.__tag.struct[structnum] or { }
ltx.__tag.struct[structnum]["mc"]=ltx.__tag.struct[structnum]["mc"] or { }
-- a structure can contain more than on mc chunk, the content should be ordered
tableinsert(ltx.__tag.struct[structnum]["mc"],mcnum)
ltx.__tag.trace.log("INFO TEX-MC-INTO-STRUCT: "..
mcnum.." inserted in struct "..structnum,3)
-- but every mc can only be in one structure
ltx.__tag.mc[mcnum]= ltx.__tag.mc[mcnum] or { }
ltx.__tag.mc[mcnum]["parent"] = structnum
end
-- pay attention: lua counts arrays from 1, tex pages from one
-- mcid and arrays in pdf count from 0.
function ltx.__tag.func.store_mc_in_page (mcnum,mcpagecnt,page)
ltx.__tag.page[page] = ltx.__tag.page[page] or {}
ltx.__tag.page[page][mcpagecnt] = mcnum
ltx.__tag.trace.log("INFO TAG-MC-INTO-PAGE: page " .. page ..
": inserting MCID " .. mcpagecnt .. " => " .. mcnum,3)
end
local function __tag_update_mc_attributes (head,mcnum,type)
for n in node.traverse(head) do
node.set_attribute(n,mccntattributeid,mcnum)
node.set_attribute(n,mctypeattributeid,type)
if n.id == HLIST or n.id == VLIST then
__tag_update_mc_attributes (n.list,mcnum,type)
end
end
return head
end
ltx.__tag.func.update_mc_attributes = __tag_update_mc_attributes
--[[
Now follows the core function
It wades through the shipout box and checks the attributes
ARGUMENTS
box: is a box,
mcpagecnt: num, the current page cnt of mc (should start at -1 in shipout box), needed for recursion
mccntprev: num, the attribute cnt of the previous node/whatever - if different we have a chunk border
mcopen: num, records if some bdc/emc is open
These arguments are only needed for log messages, if not present are replaces by fix strings:
name: string to describe the box
mctypeprev: num, the type attribute of the previous node/whatever
there are lots of logging messages currently. Should be cleaned up in due course.
One should also find ways to make the function shorter.
--]]
function ltx.__tag.func.mark_page_elements (box,mcpagecnt,mccntprev,mcopen,name,mctypeprev)
local name = name or ("SOMEBOX")
local mctypeprev = mctypeprev or -1
local abspage = status.total_pages + 1 -- the real counter is increased
-- inside the box so one off
-- if the callback is not used. (???)
ltx.__tag.trace.log ("INFO TAG-ABSPAGE: " .. abspage,3)
ltx.__tag.trace.log ("INFO TAG-ARGS: pagecnt".. mcpagecnt..
" prev "..mccntprev ..
" type prev "..mctypeprev,4)
ltx.__tag.trace.log ("INFO TAG-TRAVERSING-BOX: ".. tostring(name)..
" TYPE ".. node.type(node.getid(box)),3)
local head = box.head -- ShipoutBox is a vlist?
if head then
mccnthead, mctypehead,taghead = __tag_get_mc_cnt_type_tag (head)
ltx.__tag.trace.log ("INFO TAG-HEAD: " ..
node.type(node.getid(head))..
" MC"..tostring(mccnthead)..
" => TAG " .. tostring(mctypehead)..
" => ".. tostring(taghead),3)
else
ltx.__tag.trace.log ("INFO TAG-NO-HEAD: head is "..
tostring(head),3)
end
for n in node.traverse(head) do
local mccnt, mctype, tag = __tag_get_mc_cnt_type_tag (n)
local spaceattr = nodegetattribute(n,iwspaceattributeid) or -1
ltx.__tag.trace.log ("INFO TAG-NODE: "..
node.type(node.getid(n))..
" MC".. tostring(mccnt)..
" => TAG ".. tostring(mctype)..
" => " .. tostring(tag),3)
if n.id == HLIST
then -- enter the hlist
mcopen,mcpagecnt,mccntprev,mctypeprev=
ltx.__tag.func.mark_page_elements (n,mcpagecnt,mccntprev,mcopen,"INTERNAL HLIST",mctypeprev)
elseif n.id == VLIST then -- enter the vlist
mcopen,mcpagecnt,mccntprev,mctypeprev=
ltx.__tag.func.mark_page_elements (n,mcpagecnt,mccntprev,mcopen,"INTERNAL VLIST",mctypeprev)
elseif n.id == GLUE and not n.leader then -- at glue real space chars are inserted, but this has
-- been done if the previous shipout wandering, so here it is ignored
elseif n.id == LOCAL_PAR then -- local_par is ignored
elseif n.id == PENALTY then -- penalty is ignored
elseif n.id == KERN then -- kern is ignored
ltx.__tag.trace.log ("INFO TAG-KERN-SUBTYPE: "..
node.type(node.getid(n)).." "..n.subtype,4)
else
-- math is currently only logged.
-- we could mark the whole as math
-- for inner processing the mlist_to_hlist callback is probably needed.
if n.id == MATH then
ltx.__tag.trace.log("INFO TAG-MATH-SUBTYPE: "..
node.type(node.getid(n)).." "..__tag_get_mathsubtype(n),4)
end
-- endmath
ltx.__tag.trace.log("INFO TAG-MC-COMPARE: current "..
mccnt.." prev "..mccntprev,4)
if mccnt~=mccntprev then -- a new mc chunk
ltx.__tag.trace.log ("INFO TAG-NEW-MC-NODE: "..
node.type(node.getid(n))..
" MC"..tostring(mccnt)..
" <=> PREVIOUS "..tostring(mccntprev),4)
if mcopen~=0 then -- there is a chunk open, close it (hope there is only one ...
box.list=__tag_insert_emc_node (box.list,n)
mcopen = mcopen - 1
ltx.__tag.trace.log ("INFO TAG-INSERT-EMC: " ..
mcpagecnt .. " MCOPEN = " .. mcopen,3)
if mcopen ~=0 then
ltx.__tag.trace.log ("WARN TAG-OPEN-MC: " .. mcopen,1)
end
end
if ltx.__tag.mc[mccnt] then
if ltx.__tag.mc[mccnt]["artifact"] then
ltx.__tag.trace.log("INFO TAG-INSERT-ARTIFACT: "..
tostring(ltx.__tag.mc[mccnt]["artifact"]),3)
if ltx.__tag.mc[mccnt]["artifact"] == "" then
box.list = __tag_insert_bmc_node (box.list,n,"Artifact")
else
box.list = __tag_insert_bdc_node (box.list,n,"Artifact", "/Type /"..ltx.__tag.mc[mccnt]["artifact"])
end
else
ltx.__tag.trace.log("INFO TAG-INSERT-TAG: "..
tostring(tag),3)
mcpagecnt = mcpagecnt +1
ltx.__tag.trace.log ("INFO TAG-INSERT-BDC: "..mcpagecnt,3)
local dict= "/MCID "..mcpagecnt
if ltx.__tag.mc[mccnt]["raw"] then
ltx.__tag.trace.log("INFO TAG-USE-RAW: "..
tostring(ltx.__tag.mc[mccnt]["raw"]),3)
dict= dict .. " " .. ltx.__tag.mc[mccnt]["raw"]
end
if ltx.__tag.mc[mccnt]["alt"] then
ltx.__tag.trace.log("INFO TAG-USE-ALT: "..
tostring(ltx.__tag.mc[mccnt]["alt"]),3)
dict= dict .. " " .. ltx.__tag.mc[mccnt]["alt"]
end
if ltx.__tag.mc[mccnt]["actualtext"] then
ltx.__tag.trace.log("INFO TAG-USE-ACTUALTEXT: "..
tostring(ltx.__tag.mc[mccnt]["actualtext"]),3)
dict= dict .. " " .. ltx.__tag.mc[mccnt]["actualtext"]
end
box.list = __tag_insert_bdc_node (box.list,n,tag, dict)
ltx.__tag.func.store_mc_kid (mccnt,mcpagecnt,abspage)
ltx.__tag.func.store_mc_in_page(mccnt,mcpagecnt,abspage)
ltx.__tag.trace.show_mc_data (mccnt,3)
end
mcopen = mcopen + 1
else
if tagunmarkedbool.mode == truebool.mode then
ltx.__tag.trace.log("INFO TAG-NOT-TAGGED: this has not been tagged, using artifact",2)
box.list = __tag_insert_bmc_node (box.list,n,"Artifact")
mcopen = mcopen + 1
else
ltx.__tag.trace.log("WARN TAG-NOT-TAGGED: this has not been tagged",1)
end
end
mccntprev = mccnt
end
end -- end if
end -- end for
if head then
mccnthead, mctypehead,taghead = __tag_get_mc_cnt_type_tag (head)
ltx.__tag.trace.log ("INFO TAG-ENDHEAD: " ..
node.type(node.getid(head))..
" MC"..tostring(mccnthead)..
" => TAG "..tostring(mctypehead)..
" => "..tostring(taghead),4)
else
ltx.__tag.trace.log ("INFO TAG-ENDHEAD: ".. tostring(head),4)
end
ltx.__tag.trace.log ("INFO TAG-QUITTING-BOX "..
tostring(name)..
" TYPE ".. node.type(node.getid(box)),4)
return mcopen,mcpagecnt,mccntprev,mctypeprev
end
function ltx.__tag.func.mark_shipout (box)
mcopen = ltx.__tag.func.mark_page_elements (box,-1,-100,0,"Shipout",-1)
if mcopen~=0 then -- there is a chunk open, close it (hope there is only one ...
local emcnode = __tag_backend_create_emc_node ()
local list = box.list
if list then
list = node.insert_after (list,node.tail(list),emcnode)
mcopen = mcopen - 1
ltx.__tag.trace.log ("INFO SHIPOUT-INSERT-LAST-EMC: MCOPEN " .. mcopen,3)
else
ltx.__tag.trace.log ("WARN SHIPOUT-UPS: this shouldn't happen",0)
end
if mcopen ~=0 then
ltx.__tag.trace.log ("WARN SHIPOUT-MC-OPEN: " .. mcopen,1)
end
end
end
function ltx.__tag.func.fill_parent_tree_line (page)
-- we need to get page-> i=kid -> mcnum -> structnum
-- pay attention: the kid numbers and the page number in the parent tree start with 0!
local numsentry =""
local pdfpage = page-1
if ltx.__tag.page[page] and ltx.__tag.page[page][0] then
mcchunks=#ltx.__tag.page[page]
ltx.__tag.trace.log("INFO PARENTTREE-NUM: page "..
page.." has "..mcchunks.."+1 Elements ",4)
for i=0,mcchunks do
-- what does this log??
ltx.__tag.trace.log("INFO PARENTTREE-CHUNKS: "..
ltx.__tag.page[page][i],4)
end
if mcchunks == 0 then
-- only one chunk so no need for an array
local mcnum = ltx.__tag.page[page][0]
local structnum = ltx.__tag.mc[mcnum]["parent"]
local propname = "g__tag_struct_"..structnum.."_prop"
--local objref = ltx.__tag.tables[propname]["objref"] or "XXXX"
local objref = __tag_pdf_object_ref('__tag/struct/'..structnum)
ltx.__tag.trace.log("INFO PARENTTREE-STRUCT-OBJREF: =====>"..
tostring(objref),5)
numsentry = pdfpage .. " [".. objref .. "]"
ltx.__tag.trace.log("INFO PARENTTREE-NUMENTRY: page " ..
page.. " num entry = ".. numsentry,3)
else
numsentry = pdfpage .. " ["
for i=0,mcchunks do
local mcnum = ltx.__tag.page[page][i]
local structnum = ltx.__tag.mc[mcnum]["parent"] or 0
local propname = "g__tag_struct_"..structnum.."_prop"
--local objref = ltx.__tag.tables[propname]["objref"] or "XXXX"
local objref = __tag_pdf_object_ref('__tag/struct/'..structnum)
numsentry = numsentry .. " ".. objref
end
numsentry = numsentry .. "] "
ltx.__tag.trace.log("INFO PARENTTREE-NUMENTRY: page " ..
page.. " num entry = ".. numsentry,3)
end
else
ltx.__tag.trace.log ("INFO PARENTTREE-NO-DATA: page "..page,3)
end
return numsentry
end
function ltx.__tag.func.output_parenttree (abspage)
for i=1,abspage do
line = ltx.__tag.func.fill_parent_tree_line (i) .. "^^J"
tex.sprint(catlatex,line)
end
end
--
-- End of File `tagpdf.lua'.
|