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
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
|
% \iffalse meta-comment
%
%% File: tagpdf-struct.dtx
%
% 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.
%
% -----------------------------------------------------------------------
%
% The development version of the bundle can be found at
%
% https://github.com/u-fischer/tagpdf
%
% for those people who are interested.
%<*driver>
\DocumentMetadata{}
\documentclass{l3doc}
\usepackage{array,booktabs,caption}
\hypersetup{pdfauthor=Ulrike Fischer,
pdftitle=tagpdf-tree module (tagpdf)}
\begin{document}
\DocInput{\jobname.dtx}
\end{document}
%</driver>
% \fi
% \title{^^A
% The \pkg{tagpdf-struct} module\\ Commands to create the structure ^^A
% \\ Part of the tagpdf package
% }
%
% \author{^^A
% Ulrike Fischer\thanks
% {^^A
% E-mail:
% \href{mailto:fischer@troubleshooting-tex.de}
% {fischer@troubleshooting-tex.de}^^A
% }^^A
% }
%
% \date{Version 0.98d, released 2023-02-15}
% \maketitle
% \begin{documentation}
% \section{Public Commands}
% \begin{function}{\tag_struct_begin:n,\tag_struct_end:}
% \begin{syntax}
% \cs{tag_struct_begin:n}\Arg{key-values}\\
% \cs{tag_struct_end:}
% \end{syntax}
% These commands start and end a new structure.
% They don't start a group. They set all their values globally.
% \end{function}
% \begin{function}{\tag_struct_use:n}
% \begin{syntax}
% \cs{tag_struct_use:n}\Arg{label}
% \end{syntax}
% These commands insert a structure previously stashed away as kid
% into the currently active structure.
% A structure should be used only once,
% if the structure already has a parent a warning is issued.
% \end{function}
% \begin{function}{\tag_struct_object_ref:n,\tag_struct_object_ref:e}
% \begin{syntax}
% \cs{tag_struct_object_ref:n}\Arg{struct number}
% \end{syntax}
% This is a small wrapper around |\pdf_object_ref:n| to retrieve the
% object reference of the structure with the number \meta{struct number}.
% This number can be retrieved and stored for the current structure
% for example with \cs{tag_get:n}\Arg{struct_num}. Be aware that it can only
% be used if the structure has already been created and that it doesn't check
% if the object actually exists!
% \end{function}
%
% The following two functions are used to add annotations. They must be used
% together and with care to get the same numbers. Perhaps some improvements are needed
% here.
% \begin{function}{\tag_struct_insert_annot:nn}
% \begin{syntax}
% \cs{tag_struct_insert_annot:nn}\Arg{object reference}\Arg{struct parent number}
% \end{syntax}
% This inserts an annotation in the structure. \meta{object reference}
% is there reference to the annotation. \meta{struct parent number}
% should be the same number as had been inserted with \cs{tag_struct_parent_int:}
% as |StructParent| value to the dictionary of the annotion.
% The command will increase the value of the counter
% used by \cs{tag_struct_parent_int:}.
% \end{function}
% \begin{function}{\tag_struct_parent_int:}
% \begin{syntax}
% \cs{tag_struct_parent_int:}
% \end{syntax}
% This gives back the next free /StructParent number (assuming that it is
% together with \cs{tag_struct_insert_annot:nn} which will increase the number.
% \end{function}
% \section{Public keys}
% \subsection{Keys for the structure commands}
% \begin{function}{tag (struct-key)}
% This is required. The value of the key is normally one of the
% standard types listed in the main tagpdf documentation.
% It is possible to setup new tags/types.
% The value can also be of the form |type/NS|, where |NS| is the
% shorthand of a declared name space.
% Currently the names spaces |pdf|, |pdf2|, |mathml| and |user| are defined.
% This allows to use a different name space than
% the one connected by default to the tag. But normally this should not be needed.
% \end{function}
% \begin{function}{stash (struct-key)}
% Normally a new structure inserts itself as a kid
% into the currently active structure. This key prohibits this.
% The structure is nevertheless from now on
% \enquote{the current active structure}
% and parent for following marked content and structures.
% \end{function}
% \begin{function}{label (struct-key)}
% This key sets a label by which
% one can refer to the structure. It is e.g.
% used by \cs{tag_struct_use:n} (where a real label is actually not
% needed as you can only use structures already defined), and by the
% |ref| key (which can refer to future structures).
% Internally the label name will start with \texttt{tagpdfstruct-} and it stores
% the two attributs |tagstruct| (the structure number) and |tagstructobj| (the
% object reference).
% \end{function}
% \begin{function}{parent (struct-key)}
% By default a structure is added as kid to the currently active structure.
% With the parent key one can choose another parent. The value is a structure number which
% must refer to an already existing, previously created structure. Such a structure
% number can for example be have been stored with \cs{tag_get:n}, but one can also use
% a label on the parent structure and then use
% \cs{ref_value:nn}|{tagpdfstruct-label}{tagstruct}| to retrieve it.
% \end{function}
% \begin{function}{title (struct-key),title-o (struct-key)}
% This keys allows to set the dictionary entry
% \texttt{/Title} in the structure object.
% The value is handled as verbatim string and hex encoded.
% Commands are not expanded. |title-o| will expand the value once.
% \end{function}
%
% \begin{function}{alt (struct-key)}
% This key inserts an \texttt{/Alt} value in the dictionary of structure object.
% The value is handled as verbatim string and hex encoded.
% The value will be expanded first once.
% \end{function}
% \begin{function}{actualtext (struct-key)}
% This key inserts an \texttt{/ActualText} value in the dictionary of structure object.
% The value is handled as verbatim string and hex encoded.
% The value will be expanded first once.
% \end{function}
% \begin{function}{lang (struct-key)}
% This key allows to set the language for a structure element. The value should be a bcp-identifier,
% e.g. |de-De|.
% \end{function}
% \begin{function}{ref (struct-key)}
% This key allows to add references to other structure elements,
% it adds the |/Ref| array to the structure.
% The value should be a comma separated list of structure labels
% set with the |label| key. e.g. |ref={label1,label2}|.
% \end{function}
% \begin{function}{E (struct-key)}
% This key sets the |/E| key, the expanded form of an
% abbreviation or an acronym
% (I couldn't think of a better name, so I sticked to E).
% \end{function}
% \begin{function}{AF (struct-key),AFinline (struct-key),AFinline-o (struct-key)}
% \begin{syntax}
% AF = \meta{object name}\\
% AF-inline = \meta{text content}\\
% \end{syntax}
% These keys allows to reference an associated file in the structure element.
% The value \meta{object name} should be the name of an object pointing
% to the \texttt{/Filespec} dictionary as expected by
% |\pdf_object_ref:n| from a current \texttt{l3kernel}.
%
% The value |AF-inline| is some text,
% which is embedded in the PDF as a text file with mime type text/plain.
% |AF-inline-o| is like |AF-inline| but expands the value once.
%
% Future versions will perhaps extend this to more mime types, but it is
% still a research task to find out what is really needed.
%
% |AF| can be used more than once, to associate more than one file. The inline
% keys can be used only once per structure. Additional calls are ignored.
% \end{function}
%
% \begin{function}{attribute (struct-key)}
% This key takes as argument a comma list of attribute names
% (use braces to protect the commas from the external key-val parser)
% and allows to add one or more attribute dictionary entries in
% the structure object. As an example
% \begin{verbatim}
% \tagstructbegin{tag=TH,attribute= TH-row}
% \end{verbatim}
% Attribute names and their content must be declared first in \cs{tagpdfsetup}.
%
% \end{function}
%
% \begin{function}{attribute-class (struct-key)}
% This key takes as argument a comma list of attribute class names
% (use braces to protect the commas from the external key-val parser)
% and allows to add one or more attribute classes to the structure object.
%
% Attribute class names and their content
% must be declared first in \cs{tagpdfsetup}.
% \end{function}
% \subsection{Setup keys}
% \begin{function}{newattribute (setup-key)}
% \begin{syntax}
% newattribute = \Arg{name}\Arg{Content}
% \end{syntax}
% This key can be used in the setup command \cs{tagpdfsetup} and allow to declare a
% new attribute, which can be used as attribute or attribute class.
% The value are two brace groups, the first contains the name, the second the content.
% \begin{verbatim}
% \tagpdfsetup
% {
% newattribute =
% {TH-col}{/O /Table /Scope /Column},
% newattribute =
% {TH-row}{/O /Table /Scope /Row},
% }
% \end{verbatim}
%
% \end{function}
% \begin{function}{root-AF (setup-key)}
% \begin{syntax}
% root-AF = \meta{object name}
% \end{syntax}
% This key can be used in the setup command \cs{tagpdfsetup} and allows
% to add associated files to the root structure. Like |AF| it can be used more than
% once to add more than one file.
% \end{function}
% \end{documentation}
% \begin{implementation}
% \begin{macrocode}
%<@@=tag>
%<*header>
\ProvidesExplPackage {tagpdf-struct-code} {2023-02-15} {0.98d}
{part of tagpdf - code related to storing structure}
%</header>
% \end{macrocode}
% \section{Variables}
% \begin{variable}{\c@g_@@_struct_abs_int}
% Every structure will have a unique, absolute number.
% I will use a latex counter for the structure count
% to have a chance to avoid double structures in align etc.
%
% \begin{macrocode}
%<base>\newcounter { g_@@_struct_abs_int }
%<base>\int_gzero:N \c@g_@@_struct_abs_int
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\g_@@_struct_objR_seq}
% a sequence to store mapping between the
% structure number and the object number.
% We assume that structure numbers are assign
% consecutively and so the index of the seq can be used.
% A seq allows easy mapping over the structures.
% \begin{macrocode}
%<*package>
\@@_seq_new:N \g_@@_struct_objR_seq
% \end{macrocode}
% \end{variable}
% \begin{variable}{\g_@@_struct_cont_mc_prop}
% in generic mode it can happen after
% a page break that we have to inject into a structure
% sequence an additional mc after. We will store this additional
% info in a property. The key is the absolut mc num, the value the pdf directory.
% \begin{macrocode}
\@@_prop_new:N \g_@@_struct_cont_mc_prop
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\g_@@_struct_stack_seq}
% A stack sequence for the structure stack.
% When a sequence is opened it's number is put on the stack.
% \begin{macrocode}
\seq_new:N \g_@@_struct_stack_seq
\seq_gpush:Nn \g_@@_struct_stack_seq {0}
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\g_@@_struct_tag_stack_seq}
% We will perhaps also need the tags. While it is possible to get them from the
% numbered stack, lets build a tag stack too.
% \begin{macrocode}
\seq_new:N \g_@@_struct_tag_stack_seq
\seq_gpush:Nn \g_@@_struct_tag_stack_seq {{Root}{StructTreeRoot}}
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\g_@@_struct_tag_NS_prop}
% For the parent-child check, we need the tag and NS of every structure
% \begin{macrocode}
\prop_new:N\g_@@_struct_tag_NS_prop
% \end{macrocode}
% \end{variable}
%
%
% \begin{variable}{\g_@@_struct_stack_current_tl,\l_@@_struct_stack_parent_tmpa_tl}
% The global variable will hold the current structure number. It is already
% defined in \texttt{tagpdf-base}.
% The local temporary variable will hold the parent when we fetch it from the stack.
% \begin{macrocode}
%</package>
%<base>\tl_new:N \g_@@_struct_stack_current_tl
%<base>\tl_gset:Nn \g_@@_struct_stack_current_tl {\int_use:N\c@g_@@_struct_abs_int}
%<*package>
\tl_new:N \l_@@_struct_stack_parent_tmpa_tl
% \end{macrocode}
% \end{variable}
%
% I will need at least one structure: the StructTreeRoot
% normally it should have only one kid, e.g. the document element.
% The data of the StructTreeRoot and the StructElem are in properties:
% |\g_@@_struct_0_prop| for the root and
% |\g_@@_struct_N_prop|, $N \geq =1$ for the other.
%
% This creates quite a number of properties, so perhaps we will have to
% do this more efficiently in the future.
%
% All properties have at least the keys
% \begin{description}
% \item[Type] StructTreeRoot or StructElem
% \end{description}
% and the keys from the two following lists
% (the root has a special set of properties).
% the values of the prop should be already escaped properly
% when the entries are created (title,lange,alt,E,actualtext)
% \begin{variable}
% {
% \c_@@_struct_StructTreeRoot_entries_seq,
% \c_@@_struct_StructElem_entries_seq
% }
% These seq contain the keys we support in the two object types.
% They are currently no longer used, but are provided as documentation and
% for potential future checks.
% They should be adapted if there are changes in the PDF format.
% \begin{macrocode}
\seq_const_from_clist:Nn \c_@@_struct_StructTreeRoot_entries_seq
{%p. 857/858
Type, % always /StructTreeRoot
K, % kid, dictionary or array of dictionaries
IDTree, % currently unused
ParentTree, % required,obj ref to the parent tree
ParentTreeNextKey, % optional
RoleMap,
ClassMap,
Namespaces,
AF %pdf 2.0
}
\seq_const_from_clist:Nn \c_@@_struct_StructElem_entries_seq
{%p 858 f
Type, %always /StructElem
S, %tag/type
P, %parent
ID, %optional
Ref, %optional, pdf 2.0 Use?
Pg, %obj num of starting page, optional
K, %kids
A, %attributes, probably unused
C, %class ""
%R, %attribute revision number, irrelevant for us as we
% don't update/change existing PDF and (probably)
% deprecated in PDF 2.0
T, %title, value in () or <>
Lang, %language
Alt, % value in () or <>
E, % abreviation
ActualText,
AF, %pdf 2.0, array of dict, associated files
NS, %pdf 2.0, dict, namespace
PhoneticAlphabet, %pdf 2.0
Phoneme %pdf 2.0
}
% \end{macrocode}
% \end{variable}
%
% \subsection{Variables used by the keys}
% \begin{variable}{\g_@@_struct_tag_tl,\g_@@_struct_tag_NS_tl}
% Use by the tag key to store the tag and the namespace.
% \begin{macrocode}
\tl_new:N \g_@@_struct_tag_tl
\tl_new:N \g_@@_struct_tag_NS_tl
% \end{macrocode}
% \end{variable}
% \begin{variable}{\l_@@_struct_key_label_tl}
% This will hold the label value.
% \begin{macrocode}
\tl_new:N \l_@@_struct_key_label_tl
% \end{macrocode}
% \end{variable}
% \begin{variable}{\l_@@_struct_elem_stash_bool}
% This will keep track of the stash status
% \begin{macrocode}
\bool_new:N \l_@@_struct_elem_stash_bool
% \end{macrocode}
% \end{variable}
%
% \subsection{Variables used by tagging code of basic elements}
%
% \begin{variable}{\g_@@_struct_dest_num_prop}
% This variable records for (some or all, not clear yet)
% destination names the related structure number to allow
% to reference them in a Ref. The key is the destination.
% It is currently used by the toc-tagging and sec-tagging code.
% \begin{macrocode}
\prop_new:N \g_@@_struct_dest_num_prop
% \end{macrocode}
% \end{variable}
%
% \begin{variable}{\g_@@_struct_ref_by_dest_prop}
% This variable contains structures whose Ref key should be updated
% at the end to point to structured related with this destination.
% As this is probably need in other places too, it is not only a toc-variable.
% \begin{macrocode}
\prop_new:N \g_@@_struct_ref_by_dest_prop
% \end{macrocode}
% \end{variable}
%
% \section{Commands}
%
% The properties must be in some places handled expandably.
% So I need an output handler for each prop, to get expandable output
% see \url{https://tex.stackexchange.com/questions/424208}.
% There is probably room here for a more efficient implementation.
% TODO check if this can now be implemented with the pdfdict commands.
% The property contains currently non pdf keys, but e.g. object numbers are
% perhaps no longer needed as we have named object anyway.
%
% \begin{macro}{\@@_struct_output_prop_aux:nn,\@@_new_output_prop_handler:n}
% \begin{macrocode}
\cs_new:Npn \@@_struct_output_prop_aux:nn #1 #2 %#1 num, #2 key
{
\prop_if_in:cnT
{ g_@@_struct_#1_prop }
{ #2 }
{
\c_space_tl/#2~ \prop_item:cn{ g_@@_struct_#1_prop } { #2 }
}
}
\cs_new_protected:Npn \@@_new_output_prop_handler:n #1
{
\cs_new:cn { @@_struct_output_prop_#1:n }
{
\@@_struct_output_prop_aux:nn {#1}{##1}
}
}
% \end{macrocode}
% \end{macro}
%
% \subsection{Initialization of the StructTreeRoot}
% The first structure element, the StructTreeRoot is special, so
% created manually. The underlying object is |@@/struct/0| which is currently
% created in the tree code (TODO move it here).
% The |ParentTree| and |RoleMap| entries are added at begin document
% in the tree code as they refer to object which are setup in other parts of the
% code. This avoid timing issues.
%
% \begin{macrocode}
\tl_gset:Nn \g_@@_struct_stack_current_tl {0}
% \end{macrocode}
% \begin{macro}{\@@_pdf_name_e:n}
% \begin{macrocode}
\cs_new:Npn \@@_pdf_name_e:n #1{\pdf_name_from_unicode_e:n{#1}}
% \end{macrocode}
% \end{macro}
%
% \begin{variable}{g_@@_struct_0_prop,g_@@_struct_kids_0_seq}
% \begin{macrocode}
\@@_prop_new:c { g_@@_struct_0_prop }
\@@_new_output_prop_handler:n {0}
\@@_seq_new:c { g_@@_struct_kids_0_seq }
\@@_prop_gput:cnx
{ g_@@_struct_0_prop }
{ Type }
{ \pdf_name_from_unicode_e:n {StructTreeRoot} }
\@@_prop_gput:cnx
{ g_@@_struct_0_prop }
{ S }
{ \pdf_name_from_unicode_e:n {StructTreeRoot} }
\prop_gput:Nnn \g_@@_struct_tag_NS_prop {0}{{StructTreeRoot}{pdf}}
% \end{macrocode}
% Namespaces are pdf 2.0 but it doesn't harm
% to have an empty entry. We could add a test, but if the code moves into
% the kernel, timing could get tricky.
% \begin{macrocode}
\@@_prop_gput:cnx
{ g_@@_struct_0_prop }
{ Namespaces }
{ \pdf_object_ref:n { @@/tree/namespaces } }
% \end{macrocode}
% \end{variable}
%
% \subsection{Adding the /ID key}
% Every structure gets automatically an ID which is currently
% simply calculated from the structure number.
% \begin{macro}{\@@_struct_get_id:n}
% \begin{macrocode}
\cs_new:Npn \@@_struct_get_id:n #1 %#1=struct num
{
(
ID.
\prg_replicate:nn
{ \int_abs:n{\g_@@_tree_id_pad_int - \tl_count:e { \int_to_arabic:n { #1 } }} }
{ 0 }
\int_to_arabic:n { #1 }
)
}
% \end{macrocode}
% \end{macro}
%
% \subsection{Filling in the tag info}
% \begin{macro}{\@@_struct_set_tag_info:nnn }
% This adds or updates the tag info to a structure given by a number.
% We need also the original data, so we store both.
% \begin{macrocode}
\pdf_version_compare:NnTF < {2.0}
{
\cs_new_protected:Npn \@@_struct_set_tag_info:nnn #1 #2 #3
%#1 structure number, #2 tag, #3 NS
{
\@@_prop_gput:cnx
{ g_@@_struct_#1_prop }
{ S }
{ \pdf_name_from_unicode_e:n {#2} } %
\prop_gput:Nnn \g_@@_struct_tag_NS_prop {#1}{{#2}{#3}}
}
}
{
\cs_new_protected:Npn \@@_struct_set_tag_info:nnn #1 #2 #3
{
\@@_prop_gput:cnx
{ g_@@_struct_#1_prop }
{ S }
{ \pdf_name_from_unicode_e:n {#2} } %
\prop_get:NnNT \g_@@_role_NS_prop {#3} \l_@@_get_tmpc_tl
{
\@@_prop_gput:cnx
{ g_@@_struct_#1_prop }
{ NS }
{ \l_@@_get_tmpc_tl } %
}
\prop_gput:Nnn \g_@@_struct_tag_NS_prop {#1}{{#2}{#3}}
}
}
\cs_generate_variant:Nn \@@_struct_set_tag_info:nnn {eVV}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_struct_get_tag_info:nNN}
% We also need a way to get the tag info back from parent structures.
% \begin{macrocode}
\cs_new_protected:Npn \@@_struct_get_tag_info:nNN #1 #2 #3
%#1 struct num, #2 tlvar for tag , #3 tlvar for NS
{
\prop_get:NnNTF \g_@@_struct_tag_NS_prop {#1}\l_@@_get_tmpc_tl
{
\tl_set:Nx #2{\exp_last_unbraced:NV\use_i:nn \l_@@_get_tmpc_tl}
\tl_set:Nx #3{\exp_last_unbraced:NV\use_ii:nn \l_@@_get_tmpc_tl}
}
{
\tl_clear:N#2
\tl_clear:N#3
}
}
\cs_generate_variant:Nn\@@_struct_get_tag_info:nNN {eNN}
% \end{macrocode}
% \end{macro}
% \subsection{Handlings kids}
% Commands to store the kids. Kids in a structure can be a reference to a mc-chunk,
% an object reference to another structure element, or a object reference to an
% annotation (through an OBJR object).
% \begin{macro}{\@@_struct_kid_mc_gput_right:nn,\@@_struct_kid_mc_gput_right:nx}
% The command to store an mc-chunk, this is a dictionary of type MCR.
% It would be possible to write out the content directly as unnamed object
% and to store only the object reference, but probably this would be slower,
% and the PDF is more readable like this.
% The code doesn't try to avoid the use of the /Pg key by checking page numbers.
% That imho only slows down without much gain.
% In generic mode the page break code will perhaps to have to insert
% an additional mcid after an existing one. For this we use a property list
% At first an auxiliary to write the MCID dict. This should normally be expanded!
% \begin{macrocode}
\cs_new:Npn \@@_struct_mcid_dict:n #1 %#1 MCID absnum
{
<<
/Type \c_space_tl /MCR \c_space_tl
/Pg
\c_space_tl
\pdf_pageobject_ref:n { \@@_ref_value:enn{mcid-#1}{tagabspage}{1} }
/MCID \c_space_tl \@@_ref_value:enn{mcid-#1}{tagmcid}{1}
>>
}
% \end{macrocode}
% \begin{macrocode}
\cs_new_protected:Npn \@@_struct_kid_mc_gput_right:nn #1 #2 %#1 structure num, #2 MCID absnum%
{
\@@_seq_gput_right:cx
{ g_@@_struct_kids_#1_seq }
{
\@@_struct_mcid_dict:n {#2}
}
\@@_seq_gput_right:cn
{ g_@@_struct_kids_#1_seq }
{
\prop_item:Nn \g_@@_struct_cont_mc_prop {#2}
}
}
\cs_generate_variant:Nn \@@_struct_kid_mc_gput_right:nn {nx}
% \end{macrocode}
% \end{macro}
% \begin{macro}
% {
% \@@_struct_kid_struct_gput_right:nn,\@@_struct_kid_struct_gput_right:xx
% }
% This commands adds a structure as kid. We only need to record the object
% reference in the sequence.
% \begin{macrocode}
\cs_new_protected:Npn\@@_struct_kid_struct_gput_right:nn #1 #2 %#1 num of parent struct, #2 kid struct
{
\@@_seq_gput_right:cx
{ g_@@_struct_kids_#1_seq }
{
\pdf_object_ref:n { @@/struct/#2 }
}
}
\cs_generate_variant:Nn \@@_struct_kid_struct_gput_right:nn {xx}
% \end{macrocode}
% \end{macro}
% \begin{macro}
% {\@@_struct_kid_OBJR_gput_right:nnn,\@@_struct_kid_OBJR_gput_right:xxx}
% At last the command to add an OBJR object. This has to write an object first.
% The first argument is the number of the parent structure, the second the
% (expanded) object reference of the annotation. The last argument is the page
% object reference
%
% \begin{macrocode}
\cs_new_protected:Npn\@@_struct_kid_OBJR_gput_right:nnn #1 #2 #3 %#1 num of parent struct,
%#2 obj reference
%#3 page object reference
{
\pdf_object_unnamed_write:nn
{ dict }
{
/Type/OBJR/Obj~#2/Pg~#3
}
\@@_seq_gput_right:cx
{ g_@@_struct_kids_#1_seq }
{
\pdf_object_ref_last:
}
}
\cs_generate_variant:Nn\@@_struct_kid_OBJR_gput_right:nnn { xxx }
% \end{macrocode}
% \end{macro}
% \begin{macro}
% {\@@_struct_exchange_kid_command:N, \@@_struct_exchange_kid_command:c}
% In luamode it can happen that a single kid in a structure is split at a page
% break into two or more mcid. In this case the lua code has to convert
% put the dictionary of the kid into an array. See issue 13 at tagpdf repo.
% We exchange the dummy command for the kids to mark this case.
% \begin{macrocode}
\cs_new_protected:Npn\@@_struct_exchange_kid_command:N #1 %#1 = seq var
{
\seq_gpop_left:NN #1 \l_@@_tmpa_tl
\regex_replace_once:nnN
{ \c{\@@_mc_insert_mcid_kids:n} }
{ \c{\@@_mc_insert_mcid_single_kids:n} }
\l_@@_tmpa_tl
\seq_gput_left:NV #1 \l_@@_tmpa_tl
}
\cs_generate_variant:Nn\@@_struct_exchange_kid_command:N { c }
% \end{macrocode}
% \end{macro}
% \begin{macro}{ \@@_struct_fill_kid_key:n }
% This command adds the kid info to the K entry. In lua mode the
% content contains commands which are expanded later. The argument is the structure
% number.
%
% \begin{macrocode}
\cs_new_protected:Npn \@@_struct_fill_kid_key:n #1 %#1 is the struct num
{
\bool_if:NF\g_@@_mode_lua_bool
{
\seq_clear:N \l_@@_tmpa_seq
\seq_map_inline:cn { g_@@_struct_kids_#1_seq }
{ \seq_put_right:Nx \l_@@_tmpa_seq { ##1 } }
%\seq_show:c { g_@@_struct_kids_#1_seq }
%\seq_show:N \l_@@_tmpa_seq
\seq_remove_all:Nn \l_@@_tmpa_seq {}
%\seq_show:N \l_@@_tmpa_seq
\seq_gset_eq:cN { g_@@_struct_kids_#1_seq } \l_@@_tmpa_seq
}
\int_case:nnF
{
\seq_count:c
{
g_@@_struct_kids_#1_seq
}
}
{
{ 0 }
{ } %no kids, do nothing
{ 1 } % 1 kid, insert
{
% in this case we need a special command in
% luamode to get the array right. See issue #13
\bool_if:NT\g_@@_mode_lua_bool
{
\@@_struct_exchange_kid_command:c
{g_@@_struct_kids_#1_seq}
}
\@@_prop_gput:cnx { g_@@_struct_#1_prop } {K}
{
\seq_item:cn
{
g_@@_struct_kids_#1_seq
}
{1}
}
} %
}
{ %many kids, use an array
\@@_prop_gput:cnx { g_@@_struct_#1_prop } {K}
{
[
\seq_use:cn
{
g_@@_struct_kids_#1_seq
}
{
\c_space_tl
}
]
}
}
}
% \end{macrocode}
% \end{macro}
% \subsection{Output of the object}
% \begin{macro}{\@@_struct_get_dict_content:nN}
% This maps the dictionary content of a structure into a tl-var.
% Basically it does what |\pdfdict_use:n| does.
% TODO!! this looks over-complicated. Check if it can be done with pdfdict now.
% \begin{macrocode}
\cs_new_protected:Npn \@@_struct_get_dict_content:nN #1 #2 %#1: stucture num
{
\tl_clear:N #2
\seq_map_inline:cn
{
c_@@_struct_
\int_compare:nNnTF{#1}={0}{StructTreeRoot}{StructElem}
_entries_seq
}
{
\tl_put_right:Nx
#2
{
\prop_if_in:cnT
{ g_@@_struct_#1_prop }
{ ##1 }
{
\c_space_tl/##1~
% \end{macrocode}
% Some keys needs the option to format the key, e.g. add brackets for an
% array
% \begin{macrocode}
\cs_if_exist_use:cTF {@@_struct_format_##1:e}
{
{ \prop_item:cn{ g_@@_struct_#1_prop } { ##1 } }
}
{
\prop_item:cn{ g_@@_struct_#1_prop } { ##1 }
}
}
}
}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{\@@_struct_format_Ref:n}
% Ref is an array, we store only the content to be able to extend it
% so the formatting command adds the brackets:
% \begin{macrocode}
\cs_new:Nn\__tag_struct_format_Ref:n{[#1]}
\cs_generate_variant:Nn\__tag_struct_format_Ref:n{e}
% \end{macrocode}
% \end{macro}
% \begin{macro}{\@@_struct_write_obj:n}
% This writes out the structure object.
% This is done in the finish code, in the tree module and
% guarded by the tree boolean.
% \begin{macrocode}
\cs_new_protected:Npn \@@_struct_write_obj:n #1 % #1 is the struct num
{
\pdf_object_if_exist:nTF { @@/struct/#1 }
{
\@@_struct_fill_kid_key:n { #1 }
\@@_struct_get_dict_content:nN { #1 } \l_@@_tmpa_tl
\exp_args:Nx
\pdf_object_write:nnx
{ @@/struct/#1 }
{dict}
{
\l_@@_tmpa_tl\c_space_tl
/ID~\@@_struct_get_id:n{#1}
}
}
{
\msg_error:nnn { tag } { struct-no-objnum } { #1}
}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{\@@_struct_insert_annot:nn}
% This is the command to insert an annotation into the structure.
% It can probably be used for xform too.
%
% Annotations used as structure content must
% \begin{enumerate}
% \item add a StructParent integer to their dictionary
% \item push the object reference as OBJR object in the structure
% \item Add a Structparent/obj-nr reference to the parent tree.
% \end{enumerate}
% For a link this looks like this
% \begin{verbatim}
% \tag_struct_begin:n { tag=Link }
% \tag_mc_begin:n { tag=Link }
% (1) \pdfannot_dict_put:nnx
% { link/URI }
% { StructParent }
% { \int_use:N\c@g_@@_parenttree_obj_int }
% <start link> link text <stop link>
% (2+3) \@@_struct_insert_annot:nn {obj ref}{parent num}
% \tag_mc_end:
% \tag_struct_end:
% \end{verbatim}
% \begin{macrocode}
\cs_new_protected:Npn \@@_struct_insert_annot:nn #1 #2 %#1 object reference to the annotation/xform
%#2 structparent number
{
\bool_if:NT \g_@@_active_struct_bool
{
%get the number of the parent structure:
\seq_get:NNF
\g_@@_struct_stack_seq
\l_@@_struct_stack_parent_tmpa_tl
{
\msg_error:nn { tag } { struct-faulty-nesting }
}
%put the obj number of the annot in the kid entry, this also creates
%the OBJR object
\ref_label:nn {__tag_objr_page_#2 }{ tagabspage }
\@@_struct_kid_OBJR_gput_right:xxx
{
\l_@@_struct_stack_parent_tmpa_tl
}
{
#1 %
}
{
\pdf_pageobject_ref:n { \@@_ref_value:nnn {__tag_objr_page_#2 }{ tagabspage }{1} }
}
% add the parent obj number to the parent tree:
\exp_args:Nnx
\@@_parenttree_add_objr:nn
{
#2
}
{
\pdf_object_ref:e { @@/struct/\l_@@_struct_stack_parent_tmpa_tl }
}
% increase the int:
\stepcounter{ g_@@_parenttree_obj_int }
}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_get_data_struct_tag:}
% this command allows \cs{tag_get:n} to get the current
% structure tag with the keyword |struct_tag|.
% \begin{macrocode}
\cs_new:Npn \@@_get_data_struct_tag:
{
\exp_args:Ne
\tl_tail:n
{
\prop_item:cn {g_@@_struct_\g_@@_struct_stack_current_tl _prop}{S}
}
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_get_data_struct_id:}
% this command allows \cs{tag_get:n} to get the current
% structure id with the keyword |struct_id|.
% \begin{macrocode}
\cs_new:Npn \@@_get_data_struct_id:
{
\@@_struct_get_id:n {\g_@@_struct_stack_current_tl}
}
%</package>
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_get_data_struct_num:}
% this command allows \cs{tag_get:n} to get the current
% structure number with the keyword |struct_num|. We will need to handle nesting
% \begin{macrocode}
%<*base>
\cs_new:Npn \@@_get_data_struct_num:
{
\g_@@_struct_stack_current_tl
}
%</base>
% \end{macrocode}
% \end{macro}
%
% \section{Keys}
% This are the keys for the user commands.
% we store the tag in a variable. But we should be careful, it is only reliable
% at the begin.
% \begin{macro}
% {
% label (struct-key),
% stash (struct-key),
% parent (struct-key),
% tag (struct-key),
% title (struct-key),
% title-o (struct-key),
% alt (struct-key),
% actualtext (struct-key),
% lang (struct-key),
% ref (struct-key),
% E (struct-key)
% }
% \begin{macrocode}
%<*package>
\keys_define:nn { @@ / struct }
{
label .tl_set:N = \l_@@_struct_key_label_tl,
stash .bool_set:N = \l_@@_struct_elem_stash_bool,
parent .code:n =
{
\bool_lazy_and:nnTF
{
\prop_if_exist_p:c { g_@@_struct_\int_eval:n {#1}_prop }
}
{
\int_compare_p:nNn {#1}<{\c@g_@@_struct_abs_int}
}
{ \tl_set:Nx \l_@@_struct_stack_parent_tmpa_tl { \int_eval:n {#1} } }
{
\msg_warning:nnxx { tag } { struct-unknown }
{ \int_eval:n {#1} }
{ parent~key~ignored }
}
},
parent .default:n = {-1},
tag .code:n = % S property
{
\seq_set_split:Nne \l_@@_tmpa_seq { / } {#1/\prop_item:Ne\g__tag_role_tags_NS_prop{#1}}
\tl_gset:Nx \g_@@_struct_tag_tl { \seq_item:Nn\l_@@_tmpa_seq {1} }
\tl_gset:Nx \g_@@_struct_tag_NS_tl{ \seq_item:Nn\l_@@_tmpa_seq {2} }
\@@_check_structure_tag:N \g_@@_struct_tag_tl
},
title .code:n = % T property
{
\str_set_convert:Nnnn
\l_@@_tmpa_str
{ #1 }
{ default }
{ utf16/hex }
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ T }
{ <\l_@@_tmpa_str> }
},
title-o .code:n = % T property
{
\str_set_convert:Nonn
\l_@@_tmpa_str
{ #1 }
{ default }
{ utf16/hex }
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ T }
{ <\l_@@_tmpa_str> }
},
alt .code:n = % Alt property
{
\str_set_convert:Noon
\l_@@_tmpa_str
{ #1 }
{ default }
{ utf16/hex }
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ Alt }
{ <\l_@@_tmpa_str> }
},
alttext .meta:n = {alt=#1},
actualtext .code:n = % ActualText property
{
\str_set_convert:Noon
\l_@@_tmpa_str
{ #1 }
{ default }
{ utf16/hex }
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ ActualText }
{ <\l_@@_tmpa_str>}
},
lang .code:n = % Lang property
{
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ Lang }
{ (#1) }
},
% \end{macrocode}
% Ref is an array, the brackets are added through the formatting command.
% \begin{macrocode}
ref .code:n = % ref property
{
\tl_clear:N\l_@@_tmpa_tl
\clist_map_inline:on {#1}
{
\tl_put_right:Nx \l_@@_tmpa_tl
{~\ref_value:nn{tagpdfstruct-##1}{tagstructobj} }
}
\@@_struct_gput_data_ref:ee { \int_eval:n {\c@g_@@_struct_abs_int} } {\l_@@_tmpa_tl}
},
E .code:n = % E property
{
\str_set_convert:Nnon
\l_@@_tmpa_str
{ #1 }
{ default }
{ utf16/hex }
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ E }
{ <\l_@@_tmpa_str> }
},
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{AF (struct-key),AFinline (struct-key),AFinline-o (struct-key)}
% keys for the AF keys (associated files). They use commands from l3pdffile!
% The stream variants use txt as extension to get the mimetype.
% TODO: check if this should be configurable. For math we will perhaps need another
% extension.
% AF is an array and can be used more than once, so we store it in a tl.
% which is expanded.
% AFinline currently uses the fix extention txt.
% texsource is a special variant which creates a tex-file, it expects a
% tl-var as value (e.g. from math grabbing)
%
% \begin{variable}{\g_@@_struct_AFobj_int}
% This variable is used to number the AF-object names
% \begin{macrocode}
\int_new:N\g_@@_struct_AFobj_int
% \end{macrocode}
% \end{variable}
%
% \begin{macrocode}
\cs_if_free:NTF \pdffile_embed_stream:nnN
{
\cs_new_protected:Npn \@@_struct_add_inline_AF:nn #1 #2
% #1 content, #2 extension
{
\group_begin:
\int_gincr:N \g_@@_struct_AFobj_int
\pdf_object_if_exist:eF {@@/fileobj\int_use:N\g_@@_struct_AFobj_int}
{
\pdffile_embed_stream:nxx
{#1}
{tag-AFfile\int_use:N\g_@@_struct_AFobj_int.#2}
{@@/fileobj\int_use:N\g_@@_struct_AFobj_int}
\@@_struct_add_AF:ee
{ \int_eval:n {\c@g_@@_struct_abs_int} }
{ \pdf_object_ref:e {@@/fileobj\int_use:N\g_@@_struct_AFobj_int} }
\@@_prop_gput:cnx
{ g_@@_struct_\int_use:N\c@g_@@_struct_abs_int _prop }
{ AF }
{
[
\tl_use:c
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_AF_tl }
]
}
}
\group_end:
}
}
{
\cs_generate_variant:Nn \pdffile_embed_stream:nnN {nxN}
\cs_new_protected:Npn \@@_struct_add_inline_AF:nn #1 #2
% #1 content, #2 extension
{
\group_begin:
\int_gincr:N \g_@@_struct_AFobj_int
\pdffile_embed_stream:nxN
{#1}
{tag-AFfile\int_use:N\g_@@_struct_AFobj_int.#2}
\l_@@_tmpa_tl
\@@_struct_add_AF:ee
{ \int_eval:n {\c@g_@@_struct_abs_int} }
{ \l_@@_tmpa_tl }
\@@_prop_gput:cnx
{ g_@@_struct_\int_use:N\c@g_@@_struct_abs_int _prop }
{ AF }
{
[
\tl_use:c
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_AF_tl }
]
}
\group_end:
}
}
\cs_generate_variant:Nn \@@_struct_add_inline_AF:nn {on}
% \end{macrocode}
%
% \begin{macrocode}
\cs_new_protected:Npn \@@_struct_add_AF:nn #1 #2 % #1 struct num #2 object reference
{
\tl_if_exist:cTF
{
g_@@_struct_#1_AF_tl
}
{
\tl_gput_right:cx
{ g_@@_struct_#1_AF_tl }
{ \c_space_tl #2 }
}
{
\tl_new:c
{ g_@@_struct_#1_AF_tl }
\tl_gset:cx
{ g_@@_struct_#1_AF_tl }
{ #2 }
}
}
\cs_generate_variant:Nn \@@_struct_add_AF:nn {en,ee}
\keys_define:nn { @@ / struct }
{
AF .code:n = % AF property
{
\pdf_object_if_exist:nTF {#1}
{
\@@_struct_add_AF:ee { \int_eval:n {\c@g_@@_struct_abs_int} }{\pdf_object_ref:n {#1}}
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ AF }
{
[
\tl_use:c
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_AF_tl }
]
}
}
{
}
},
,AFinline .code:n =
{
\@@_struct_add_inline_AF:nn {#1}{txt}
}
,AFinline-o .code:n =
{
\@@_struct_add_inline_AF:on {#1}{txt}
}
,texsource .code:n =
{
\group_begin:
\pdfdict_put:nnn { l_pdffile/Filespec }{AFRelationship} { /Source }
% \end{macrocode}
% we set the mime type as pdfresources uses currently text/plain
% \begin{macrocode}
\pdfdict_put:nnx
{ l_pdffile }{Subtype}
{ \pdf_name_from_unicode_e:n{application/x-tex} }
\@@_struct_add_inline_AF:on {#1}{tex}
\group_end:
}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{root-AF (setup-key)}
% The root structure can take AF keys too, so we provide a key for it.
% This key is used with |\tagpdfsetup|, not in a structure!
% \begin{macrocode}
\keys_define:nn { @@ / setup }
{
root-AF .code:n =
{
\pdf_object_if_exist:nTF {#1}
{
\@@_struct_add_AF:ee { 0 }{\pdf_object_ref:n {#1}}
\@@_prop_gput:cnx
{ g_@@_struct_0_prop }
{ AF }
{
[
\tl_use:c
{ g_@@_struct_0_AF_tl }
]
}
}
{
}
},
}
%</package>
% \end{macrocode}
% \end{macro}
% \section{User commands}
%
% \begin{macro}{\tag_struct_begin:n,\tag_struct_end:}
% \begin{macrocode}
%<base>\cs_new_protected:Npn \tag_struct_begin:n #1 {\int_gincr:N \c@g_@@_struct_abs_int}
%<base>\cs_new_protected:Npn \tag_struct_end:{}
%<*package|debug>
%<package>\cs_set_protected:Npn \tag_struct_begin:n #1 %#1 key-val
%<debug>\cs_set_protected:Npn \tag_struct_begin:n #1 %#1 key-val
{
%<package>\@@_check_if_active_struct:T
%<debug>\@@_check_if_active_struct:TF
{
\group_begin:
\int_gincr:N \c@g_@@_struct_abs_int
\@@_prop_new:c { g_@@_struct_\int_eval:n { \c@g_@@_struct_abs_int }_prop }
\@@_new_output_prop_handler:n {\int_eval:n { \c@g_@@_struct_abs_int }}
\@@_seq_new:c { g_@@_struct_kids_\int_eval:n { \c@g_@@_struct_abs_int }_seq}
\exp_args:Ne
\pdf_object_new:n
{ @@/struct/\int_eval:n { \c@g_@@_struct_abs_int } }
\@@_prop_gput:cno
{ g_@@_struct_\int_eval:n { \c@g_@@_struct_abs_int }_prop }
{ Type }
{ /StructElem }
\tl_set:Nn \l_@@_struct_stack_parent_tmpa_tl {-1}
\keys_set:nn { @@ / struct} { #1 }
% \end{macrocode}
% \begin{macrocode}
\@@_struct_set_tag_info:eVV
{ \int_eval:n {\c@g_@@_struct_abs_int} }
\g_@@_struct_tag_tl
\g_@@_struct_tag_NS_tl
\@@_check_structure_has_tag:n { \int_eval:n {\c@g_@@_struct_abs_int} }
\tl_if_empty:NF
\l_@@_struct_key_label_tl
{
\@@_ref_label:en{tagpdfstruct-\l_@@_struct_key_label_tl}{struct}
}
% \end{macrocode}
% The structure number of the parent is either taken from the stack or
% has been set with the parent key.
% \begin{macrocode}
\int_compare:nNnT { \l_@@_struct_stack_parent_tmpa_tl } = { -1 }
{
\seq_get:NNF
\g_@@_struct_stack_seq
\l_@@_struct_stack_parent_tmpa_tl
{
\msg_error:nn { tag } { struct-faulty-nesting }
}
}
\seq_gpush:NV \g_@@_struct_stack_seq \c@g_@@_struct_abs_int
\@@_role_get:VVN
\g_@@_struct_tag_tl
\g_@@_struct_tag_NS_tl
\l_@@_get_tmpc_tl
\seq_gpush:Nx \g_@@_struct_tag_stack_seq
{{\g_@@_struct_tag_tl}{\l_@@_get_tmpc_tl}}
\tl_gset:NV \g_@@_struct_stack_current_tl \c@g_@@_struct_abs_int
%\seq_show:N \g_@@_struct_stack_seq
\bool_if:NF
\l_@@_struct_elem_stash_bool
{
% \end{macrocode}
% check if the tag can be used inside the parent. It only makes sense,
% if the structure is actually used here, so it is guarded by the stash boolean.
% For now we ignore the namespace!
% \begin{macrocode}
\@@_struct_get_tag_info:eNN
{\l_@@_struct_stack_parent_tmpa_tl}
\l_@@_get_parent_tmpa_tl
\l_@@_get_parent_tmpb_tl
\@@_check_parent_child:VVVVN
\l_@@_get_parent_tmpa_tl
\l_@@_get_parent_tmpb_tl
\g_@@_struct_tag_tl
\g_@@_struct_tag_NS_tl
\l_@@_parent_child_check_tl
\int_compare:nNnT {\l_@@_parent_child_check_tl}<0
{
\msg_warning:nnxxx
{ tag }
{role-parent-child}
{ \l_@@_get_parent_tmpa_tl/\l_@@_get_parent_tmpb_tl }
{ \g_@@_struct_tag_tl/\g_@@_struct_tag_NS_tl }
{ not~allowed~(struct~\g_@@_struct_stack_current_tl) }
\cs_set_eq:NN \l_@@_role_remap_tag_tl \g_@@_struct_tag_tl
\cs_set_eq:NN \l_@@_role_remap_NS_tl \g_@@_struct_tag_NS_tl
\@@_role_remap:
\cs_gset_eq:NN \g_@@_struct_tag_tl \l_@@_role_remap_tag_tl
\cs_gset_eq:NN \g_@@_struct_tag_NS_tl \l_@@_role_remap_NS_tl
\@@_struct_set_tag_info:eVV
{ \int_eval:n {\c@g_@@_struct_abs_int} }
\g_@@_struct_tag_tl
\g_@@_struct_tag_NS_tl
}
% \end{macrocode}
% Set the Parent.
% \begin{macrocode}
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ P }
{
\pdf_object_ref:e { @@/struct/\l_@@_struct_stack_parent_tmpa_tl }
}
%record this structure as kid:
%\tl_show:N \g_@@_struct_stack_current_tl
%\tl_show:N \l_@@_struct_stack_parent_tmpa_tl
\@@_struct_kid_struct_gput_right:xx
{ \l_@@_struct_stack_parent_tmpa_tl }
{ \g_@@_struct_stack_current_tl }
%\prop_show:c { g_@@_struct_\g_@@_struct_stack_current_tl _prop }
%\seq_show:c {g_@@_struct_kids_\l_@@_struct_stack_parent_tmpa_tl _seq}
}
%\prop_show:c { g_@@_struct_\g_@@_struct_stack_current_tl _prop }
%\seq_show:c {g_@@_struct_kids_\l_@@_struct_stack_parent_tmpa_tl _seq}
%<debug> \@@_debug_struct_begin_insert:n { #1 }
\group_end:
}
%<debug>{ \@@_debug_struct_begin_ignore:n { #1 }}
}
%<package>\cs_set_protected:Nn \tag_struct_end:
%<debug>\cs_set_protected:Nn \tag_struct_end:
{ %take the current structure num from the stack:
%the objects are written later, lua mode hasn't all needed info yet
%\seq_show:N \g_@@_struct_stack_seq
%<package>\@@_check_if_active_struct:T
%<debug>\@@_check_if_active_struct:TF
{
\seq_gpop:NN \g_@@_struct_tag_stack_seq \l_@@_tmpa_tl
\seq_gpop:NNTF \g_@@_struct_stack_seq \l_@@_tmpa_tl
{
\@@_check_info_closing_struct:o { \g_@@_struct_stack_current_tl }
}
{ \@@_check_no_open_struct: }
% get the previous one, shouldn't be empty as the root should be there
\seq_get:NNTF \g_@@_struct_stack_seq \l_@@_tmpa_tl
{
\tl_gset:NV \g_@@_struct_stack_current_tl \l_@@_tmpa_tl
}
{
\@@_check_no_open_struct:
}
\seq_get:NNT \g_@@_struct_tag_stack_seq \l_@@_tmpa_tl
{
\tl_gset:Nx \g_@@_struct_tag_tl
{ \exp_last_unbraced:NV\use_i:nn \l_@@_tmpa_tl }
}
%<debug>\@@_debug_struct_end_insert:
}
%<debug>{\@@_debug_struct_end_ignore:}
}
%</package|debug>
% \end{macrocode}
% \end{macro}
% \begin{macro}{\tag_struct_use:n}
% This command allows to use a stashed structure in another place.
% TODO: decide how it should be guarded. Probably by the struct-check.
% \begin{macrocode}
%<base>\cs_new_protected:Npn \tag_struct_use:n #1 {}
%<*package>
\cs_set_protected:Npn \tag_struct_use:n #1 %#1 is the label
{
\@@_check_if_active_struct:T
{
\prop_if_exist:cTF
{ g_@@_struct_\@@_ref_value:enn{tagpdfstruct-#1}{tagstruct}{unknown}_prop } %
{
\@@_check_struct_used:n {#1}
%add the label structure as kid to the current structure (can be the root)
\@@_struct_kid_struct_gput_right:xx
{ \g_@@_struct_stack_current_tl }
{ \@@_ref_value:enn{tagpdfstruct-#1}{tagstruct}{0} }
%add the current structure to the labeled one as parents
\@@_prop_gput:cnx
{ g_@@_struct_\@@_ref_value:enn{tagpdfstruct-#1}{tagstruct}{0}_prop }
{ P }
{
\pdf_object_ref:e { @@/struct/\g_@@_struct_stack_current_tl }
}
% \end{macrocode}
% check if the tag is allowed as child. Here we have to retrieve the
% tag info for the child, while the data for the parent is in
% the global tl-vars:
% \begin{macrocode}
\@@_struct_get_tag_info:eNN
{\__tag_ref_value:enn{tagpdfstruct-#1}{tagstruct}{0}}
\l_@@_tmpa_tl
\l_@@_tmpb_tl
\@@_check_parent_child:VVVVN
\g_@@_struct_tag_tl
\g_@@_struct_tag_NS_tl
\l_@@_tmpa_tl
\l_@@_tmpb_tl
\l_@@_parent_child_check_tl
\int_compare:nNnT {\l_@@_parent_child_check_tl}<0
{
\cs_set_eq:NN \l_@@_role_remap_tag_tl \g_@@_struct_tag_tl
\cs_set_eq:NN \l_@@_role_remap_NS_tl \g_@@_struct_tag_NS_tl
\@@_role_remap:
\cs_gset_eq:NN \g_@@_struct_tag_tl \l_@@_role_remap_tag_tl
\cs_gset_eq:NN \g_@@_struct_tag_NS_tl \l_@@_role_remap_NS_tl
\@@_struct_set_tag_info:eVV
{ \int_eval:n {\c@g_@@_struct_abs_int} }
\g_@@_struct_tag_tl
\g_@@_struct_tag_NS_tl
}
}
{
\msg_warning:nnn{ tag }{struct-label-unknown}{#1}
}
}
}
%</package>
% \end{macrocode}
% \end{macro}
%
% \begin{macro}[EXP]{\tag_struct_object_ref:n}
% This is a command that allows to reference a structure. The argument is the
% number which can be get for the current structure with |\tag_get:n{struct_num}|
% TODO check if it should be in base too.
% \begin{macrocode}
%<*package>
\cs_new:Npn \tag_struct_object_ref:n #1
{
\pdf_object_ref:n {@@/struct/#1}
}
\cs_generate_variant:Nn \tag_struct_object_ref:n {e}
% \end{macrocode}
%
% \end{macro}
%
% \begin{macro}{\tag_struct_gput:nnn}
% This is a command that allows to update the data of a structure.
% The first argument is the
% number of the structure, the second a keyword referring to a function,
% the third the value. Currently the only keyword is \texttt{ref}
% \begin{macrocode}
\cs_new_protected:Npn \tag_struct_gput:nnn #1 #2 #3
{
\cs_if_exist_use:cF {@@_struct_gput_data_#2:nn}
{ %warning??
\use_none:nn
}
{#1}{#3}
}
\cs_generate_variant:Nn \tag_struct_gput:nnn {ene,nne}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@@_struct_gput_data_ref:nn}
% \begin{macrocode}
\cs_new_protected:Npn \@@_struct_gput_data_ref:nn #1 #2
% #1 receiving struct num, #2 list of object ref
{
\prop_get:cnN
{ g_@@_struct_#1_prop }
{Ref}
\l_@@_get_tmpc_tl
\@@_prop_gput:cnx
{ g_@@_struct_#1_prop }
{ Ref }
{ \quark_if_no_value:NF\l_@@_get_tmpc_tl { \l_@@_get_tmpc_tl\c_space_tl }#2 }
}
\cs_generate_variant:Nn \@@_struct_gput_data_ref:nn {ee}
% \end{macrocode}
% \end{macro}
% \begin{macro}
% {
% \tag_struct_insert_annot:nn,
% \tag_struct_insert_annot:xx
% }
% \begin{macro}[EXP]
% {
% \tag_struct_parent_int:
% }
% This are the user command to insert annotations. They must be used
% together to get the numbers right. They use a counter to the
% |StructParent| and \cs{tag_struct_insert_annot:nn} increases the
% counter given back by \cs{tag_struct_parent_int:}.
%
% It must be used together with |\tag_struct_parent_int:| to insert an
% annotation.
% TODO: decide how it should be guarded if tagging is deactivated.
% \begin{macrocode}
\cs_new_protected:Npn \tag_struct_insert_annot:nn #1 #2 %#1 should be an object reference
%#2 struct parent num
{
\@@_check_if_active_struct:T
{
\@@_struct_insert_annot:nn {#1}{#2}
}
}
\cs_generate_variant:Nn \tag_struct_insert_annot:nn {xx}
\cs_new:Npn \tag_struct_parent_int: {\int_use:c { c@g_@@_parenttree_obj_int }}
%</package>
% \end{macrocode}
% \end{macro}
% \end{macro}
% \section{Attributes and attribute classes}
% \begin{macrocode}
%<*header>
\ProvidesExplPackage {tagpdf-attr-code} {2023-02-15} {0.98d}
{part of tagpdf - code related to attributes and attribute classes}
%</header>
% \end{macrocode}
% \subsection{Variables}
% \begin{variable}
% {
% ,\g_@@_attr_entries_prop
% ,\g_@@_attr_class_used_seq
% ,\g_@@_attr_objref_prop
% ,\l_@@_attr_value_tl
% }
% |\g_@@_attr_entries_prop| will store attribute names and their dictionary content.\\
% |\g_@@_attr_class_used_seq| will hold the attributes which have been used as
% class name.
% |\l_@@_attr_value_tl| is used to build the attribute array or key.
% Everytime an attribute is used for the first time, and object is created
% with its content, the name-object reference relation is stored in
% |\g_@@_attr_objref_prop|
% \begin{macrocode}
%<*package>
\prop_new:N \g_@@_attr_entries_prop
\seq_new:N \g_@@_attr_class_used_seq
\tl_new:N \l_@@_attr_value_tl
\prop_new:N \g_@@_attr_objref_prop %will contain obj num of used attributes
% \end{macrocode}
% \end{variable}
% \subsection{Commands and keys}
% \begin{macro}{\@@_attr_new_entry:nn,newattribute (setup-key)}
% This allows to define attributes. Defined attributes
% are stored in a global property. |newattribute| expects
% two brace group, the name and the content. The content typically
% needs an |/O| key for the owner. An example look like
% this.
% \begin{verbatim}
% \tagpdfsetup
% {
% newattribute =
% {TH-col}{/O /Table /Scope /Column},
% newattribute =
% {TH-row}{/O /Table /Scope /Row},
% }
% \end{verbatim}
% \begin{macrocode}
\cs_new_protected:Npn \@@_attr_new_entry:nn #1 #2 %#1:name, #2: content
{
\prop_gput:Nen \g_@@_attr_entries_prop
{\pdf_name_from_unicode_e:n{#1}}{#2}
}
\keys_define:nn { @@ / setup }
{
newattribute .code:n =
{
\@@_attr_new_entry:nn #1
}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{attribute-class (struct-key)}
% attribute-class has to store the used attribute names so that
% they can be added to the ClassMap later.
% \begin{macrocode}
\keys_define:nn { @@ / struct }
{
attribute-class .code:n =
{
\clist_set:Nx \l_@@_tmpa_clist { #1 }
\seq_set_from_clist:NN \l_@@_tmpb_seq \l_@@_tmpa_clist
% \end{macrocode}
% we convert the names into pdf names with slash
% \begin{macrocode}
\seq_set_map_x:NNn \l_@@_tmpa_seq \l_@@_tmpb_seq
{
\pdf_name_from_unicode_e:n {##1}
}
\seq_map_inline:Nn \l_@@_tmpa_seq
{
\prop_if_in:NnF \g_@@_attr_entries_prop {##1}
{
\msg_error:nnn { tag } { attr-unknown } { ##1 }
}
\seq_gput_left:Nn\g_@@_attr_class_used_seq { ##1}
}
\tl_set:Nx \l_@@_tmpa_tl
{
\int_compare:nT { \seq_count:N \l_@@_tmpa_seq > 1 }{[}
\seq_use:Nn \l_@@_tmpa_seq { \c_space_tl }
\int_compare:nT { \seq_count:N \l_@@_tmpa_seq > 1 }{]}
}
\int_compare:nT { \seq_count:N \l_@@_tmpa_seq > 0 }
{
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ C }
{ \l_@@_tmpa_tl }
%\prop_show:c { g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
}
}
}
% \end{macrocode}
% \end{macro}
% \begin{macro}{attribute (struct-key)}
% \begin{macrocode}
\keys_define:nn { @@ / struct }
{
attribute .code:n = % A property (attribute, value currently a dictionary)
{
\clist_set:Nx \l_@@_tmpa_clist { #1 }
\clist_if_empty:NF \l_@@_tmpa_clist
{
\seq_set_from_clist:NN \l_@@_tmpb_seq \l_@@_tmpa_clist
% \end{macrocode}
% we convert the names into pdf names with slash
% \begin{macrocode}
\seq_set_map_x:NNn \l_@@_tmpa_seq \l_@@_tmpb_seq
{
\pdf_name_from_unicode_e:n {##1}
}
\tl_set:Nx \l_@@_attr_value_tl
{
\int_compare:nT { \seq_count:N \l_@@_tmpa_seq > 1 }{[}%]
}
\seq_map_inline:Nn \l_@@_tmpa_seq
{
\prop_if_in:NnF \g_@@_attr_entries_prop {##1}
{
\msg_error:nnn { tag } { attr-unknown } { ##1 }
}
\prop_if_in:NnF \g_@@_attr_objref_prop {##1}
{%\prop_show:N \g_@@_attr_entries_prop
\pdf_object_unnamed_write:nx
{ dict }
{
\prop_item:Nn\g_@@_attr_entries_prop {##1}
}
\prop_gput:Nnx \g_@@_attr_objref_prop {##1} {\pdf_object_ref_last:}
}
\tl_put_right:Nx \l_@@_attr_value_tl
{
\c_space_tl
\prop_item:Nn \g_@@_attr_objref_prop {##1}
}
% \tl_show:N \l_@@_attr_value_tl
}
\tl_put_right:Nx \l_@@_attr_value_tl
{ %[
\int_compare:nT { \seq_count:N \l_@@_tmpa_seq > 1 }{]}%
}
% \tl_show:N \l_@@_attr_value_tl
\@@_prop_gput:cnx
{ g_@@_struct_\int_eval:n {\c@g_@@_struct_abs_int}_prop }
{ A }
{ \l_@@_attr_value_tl }
}
},
}
%</package>
% \end{macrocode}
% \end{macro}
% \end{implementation}
|