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
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
| | ;;; ox.el --- Export Framework for Org Mode -*- lexical-binding: t; -*-
;; Copyright (C) 2012-2024 Free Software Foundation, Inc.
;; Author: Nicolas Goaziou <mail@nicolasgoaziou.fr>
;; Maintainer: Ihor Radchenko <yantar92 at posteo dot net>
;; Keywords: outlines, hypermedia, calendar, wp
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; This library implements a generic export engine for Org, built on
;; its syntactical parser: Org Elements.
;;
;; Besides that parser, the generic exporter is made of three distinct
;; parts:
;;
;; - The communication channel consists of a property list, which is
;; created and updated during the process. Its use is to offer
;; every piece of information, would it be about initial environment
;; or contextual data, all in a single place.
;;
;; - The transcoder walks the parse tree, ignores or treat as plain
;; text elements and objects according to export options, and
;; eventually calls backend specific functions to do the real
;; transcoding, concatenating their return value along the way.
;;
;; - The filter system is activated at the very beginning and the very
;; end of the export process, and each time an element or an object
;; has been converted. It is the entry point to fine-tune standard
;; output from backend transcoders. See "The Filter System"
;; section for more information.
;;
;; The core functions is `org-export-as'. It returns the transcoded
;; buffer as a string. Its derivatives are `org-export-to-buffer' and
;; `org-export-to-file'.
;;
;; An export backend is defined with `org-export-define-backend'.
;; This function can also support specific buffer keywords, OPTION
;; keyword's items and filters. Refer to function's documentation for
;; more information.
;;
;; If the new backend shares most properties with another one,
;; `org-export-define-derived-backend' can be used to simplify the
;; process.
;;
;; Any backend can define its own variables. Among them, those
;; customizable should belong to the `org-export-BACKEND' group.
;;
;; Tools for common tasks across backends are implemented in the
;; following part of the file.
;;
;; Eventually, a dispatcher (`org-export-dispatch') is provided in the
;; last one.
;;
;; See <https://orgmode.org/worg/dev/org-export-reference.html> for
;; more information.
;;; Code:
(require 'org-macs)
(org-assert-version)
(require 'cl-lib)
(require 'ob-exp)
(require 'oc)
(require 'ol)
(require 'org-element)
(require 'org-macro)
(require 'tabulated-list)
(declare-function org-src-coderef-format "org-src" (&optional element))
(declare-function org-src-coderef-regexp "org-src" (fmt &optional label))
(declare-function org-publish "ox-publish" (project &optional force async))
(declare-function org-publish-all "ox-publish" (&optional force async))
(declare-function org-publish-current-file "ox-publish" (&optional force async))
(declare-function org-publish-current-project "ox-publish" (&optional force async))
(declare-function org-at-heading-p "org" (&optional _))
(declare-function org-back-to-heading "org" (&optional invisible-ok))
(declare-function org-next-visible-heading "org" (arg))
(defvar org-publish-project-alist)
(defvar org-table-number-fraction)
(defvar org-table-number-regexp)
\f
;;; Internal Variables
;;
;; Among internal variables, the most important is
;; `org-export-options-alist'. This variable define the global export
;; options, shared between every exporter, and how they are acquired.
(defconst org-export-max-depth 19
"Maximum nesting depth for headlines, counting from 0.")
(defconst org-export-options-alist
'((:title "TITLE" nil nil parse)
(:date "DATE" nil nil parse)
(:author "AUTHOR" nil user-full-name parse)
(:email "EMAIL" nil user-mail-address t)
(:language "LANGUAGE" nil org-export-default-language t)
(:select-tags "SELECT_TAGS" nil org-export-select-tags split)
(:exclude-tags "EXCLUDE_TAGS" nil org-export-exclude-tags split)
(:creator "CREATOR" nil org-export-creator-string)
(:headline-levels nil "H" org-export-headline-levels)
(:preserve-breaks nil "\\n" org-export-preserve-breaks)
(:section-numbers nil "num" org-export-with-section-numbers)
(:time-stamp-file nil "timestamp" org-export-timestamp-file)
(:with-archived-trees nil "arch" org-export-with-archived-trees)
(:with-author nil "author" org-export-with-author)
(:expand-links nil "expand-links" org-export-expand-links)
(:with-broken-links nil "broken-links" org-export-with-broken-links)
(:with-clocks nil "c" org-export-with-clocks)
(:with-creator nil "creator" org-export-with-creator)
(:with-date nil "date" org-export-with-date)
(:with-drawers nil "d" org-export-with-drawers)
(:with-email nil "email" org-export-with-email)
(:with-emphasize nil "*" org-export-with-emphasize)
(:with-entities nil "e" org-export-with-entities)
(:with-fixed-width nil ":" org-export-with-fixed-width)
(:with-footnotes nil "f" org-export-with-footnotes)
(:with-inlinetasks nil "inline" org-export-with-inlinetasks)
(:with-latex nil "tex" org-export-with-latex)
(:with-planning nil "p" org-export-with-planning)
(:with-priority nil "pri" org-export-with-priority)
(:with-properties nil "prop" org-export-with-properties)
(:with-smart-quotes nil "'" org-export-with-smart-quotes)
(:with-special-strings nil "-" org-export-with-special-strings)
(:with-special-rows nil nil nil)
(:with-statistics-cookies nil "stat" org-export-with-statistics-cookies)
(:with-sub-superscript nil "^" org-export-with-sub-superscripts)
(:with-toc nil "toc" org-export-with-toc)
(:with-tables nil "|" org-export-with-tables)
(:with-tags nil "tags" org-export-with-tags)
(:with-tasks nil "tasks" org-export-with-tasks)
(:with-timestamps nil "<" org-export-with-timestamps)
(:with-title nil "title" org-export-with-title)
(:with-todo-keywords nil "todo" org-export-with-todo-keywords)
;; Citations processing.
(:with-cite-processors nil nil org-export-process-citations)
(:cite-export "CITE_EXPORT" nil org-cite-export-processors))
"Alist between export properties and ways to set them.
The key of the alist is the property name, and the value is a list
like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
KEYWORD is a string representing a buffer keyword, or nil. Each
property defined this way can also be set, during subtree
export, through a headline property named after the keyword
with the \"EXPORT_\" prefix (i.e. DATE keyword and EXPORT_DATE
property).
OPTION is a string that could be found in an #+OPTIONS: line.
DEFAULT is the default value for the property.
BEHAVIOR determines how Org should handle multiple keywords for
the same property. It is a symbol among:
nil Keep old value and discard the new one.
t Replace old value with the new one.
`space' Concatenate the values, separating them with a space.
`newline' Concatenate the values, separating them with
a newline.
`split' Split values at white spaces, and cons them to the
previous list.
`parse' Parse value as a list of strings and Org objects,
which can then be transcoded with, e.g.,
`org-export-data'. It implies `space' behavior.
Values set through KEYWORD and OPTION have precedence over
DEFAULT.
All these properties should be backend agnostic. Backend
specific properties are set through `org-export-define-backend'.
Properties redefined there have precedence over these.")
(defconst org-export-filters-alist
'((:filter-body . org-export-filter-body-functions)
(:filter-bold . org-export-filter-bold-functions)
(:filter-babel-call . org-export-filter-babel-call-functions)
(:filter-center-block . org-export-filter-center-block-functions)
(:filter-clock . org-export-filter-clock-functions)
(:filter-code . org-export-filter-code-functions)
(:filter-diary-sexp . org-export-filter-diary-sexp-functions)
(:filter-drawer . org-export-filter-drawer-functions)
(:filter-dynamic-block . org-export-filter-dynamic-block-functions)
(:filter-entity . org-export-filter-entity-functions)
(:filter-example-block . org-export-filter-example-block-functions)
(:filter-export-block . org-export-filter-export-block-functions)
(:filter-export-snippet . org-export-filter-export-snippet-functions)
(:filter-final-output . org-export-filter-final-output-functions)
(:filter-fixed-width . org-export-filter-fixed-width-functions)
(:filter-footnote-definition . org-export-filter-footnote-definition-functions)
(:filter-footnote-reference . org-export-filter-footnote-reference-functions)
(:filter-headline . org-export-filter-headline-functions)
(:filter-horizontal-rule . org-export-filter-horizontal-rule-functions)
(:filter-inline-babel-call . org-export-filter-inline-babel-call-functions)
(:filter-inline-src-block . org-export-filter-inline-src-block-functions)
(:filter-inlinetask . org-export-filter-inlinetask-functions)
(:filter-italic . org-export-filter-italic-functions)
(:filter-item . org-export-filter-item-functions)
(:filter-keyword . org-export-filter-keyword-functions)
(:filter-latex-environment . org-export-filter-latex-environment-functions)
(:filter-latex-fragment . org-export-filter-latex-fragment-functions)
(:filter-line-break . org-export-filter-line-break-functions)
(:filter-link . org-export-filter-link-functions)
(:filter-node-property . org-export-filter-node-property-functions)
(:filter-options . org-export-filter-options-functions)
(:filter-paragraph . org-export-filter-paragraph-functions)
(:filter-parse-tree . org-export-filter-parse-tree-functions)
(:filter-plain-list . org-export-filter-plain-list-functions)
(:filter-plain-text . org-export-filter-plain-text-functions)
(:filter-planning . org-export-filter-planning-functions)
(:filter-property-drawer . org-export-filter-property-drawer-functions)
(:filter-quote-block . org-export-filter-quote-block-functions)
(:filter-radio-target . org-export-filter-radio-target-functions)
(:filter-section . org-export-filter-section-functions)
(:filter-special-block . org-export-filter-special-block-functions)
(:filter-src-block . org-export-filter-src-block-functions)
(:filter-statistics-cookie . org-export-filter-statistics-cookie-functions)
(:filter-strike-through . org-export-filter-strike-through-functions)
(:filter-subscript . org-export-filter-subscript-functions)
(:filter-superscript . org-export-filter-superscript-functions)
(:filter-table . org-export-filter-table-functions)
(:filter-table-cell . org-export-filter-table-cell-functions)
(:filter-table-row . org-export-filter-table-row-functions)
(:filter-target . org-export-filter-target-functions)
(:filter-timestamp . org-export-filter-timestamp-functions)
(:filter-underline . org-export-filter-underline-functions)
(:filter-verbatim . org-export-filter-verbatim-functions)
(:filter-verse-block . org-export-filter-verse-block-functions))
"Alist between filters properties and initial values.
The key of each association is a property name accessible through
the communication channel. Its value is a configurable global
variable defining initial filters.
This list is meant to install user specified filters. Backend
developers may install their own filters using
`org-export-define-backend'. Filters defined there will always
be prepended to the current list, so they always get applied
first.")
(defconst org-export-default-inline-image-rule
`(("file" .
,(format "\\.%s\\'"
(regexp-opt
'("png" "jpeg" "jpg" "gif" "tiff" "tif" "xbm"
"xpm" "pbm" "pgm" "ppm") t))))
"Default rule for link matching an inline image.
This rule applies to links with no description. By default, it
will be considered as an inline image if it targets a local file
whose extension is either \"png\", \"jpeg\", \"jpg\", \"gif\",
\"tiff\", \"tif\", \"xbm\", \"xpm\", \"pbm\", \"pgm\" or \"ppm\".
See `org-export-inline-image-p' for more information about
rules.")
(defvar org-export-async-debug nil
"Non-nil means asynchronous export process should leave data behind.
This data is found in the appropriate \"*Org Export Process*\"
buffer, and in files prefixed with \"org-export-process\" and
located in the directory defined by variable
`temporary-file-directory'.
When non-nil, it will also set `debug-on-error' to a non-nil
value in the external process.")
(defvar org-export-stack-contents nil
"Record asynchronously generated export results and processes.
This is an alist: its CAR is the source of the
result (destination file or buffer for a finished process,
original buffer for a running one) and its CDR is a list
containing the backend used, as a symbol, and either a process
or the time at which it finished. It is used to build the menu
from `org-export-stack'.")
(defvar org-export-registered-backends nil
"List of backends currently available in the exporter.
This variable is set with `org-export-define-backend' and
`org-export-define-derived-backend' functions.")
(defvar org-export-dispatch-last-action nil
"Last command called from the dispatcher.
The value should be a list. Its CAR is the action, as a symbol,
and its CDR is a list of export options.")
(defvar org-export-dispatch-last-position (make-marker)
"The position where the last export command was created using the dispatcher.
This marker will be used with `\\[universal-argument] C-c C-e' to make sure export repetition
uses the same subtree if the previous command was restricted to a subtree.")
;; For compatibility with Org < 8
(defvar org-export-current-backend nil
"Name, if any, of the backend used during an export process.
Its value is a symbol such as `html', `latex', `ascii', or nil if
the backend is anonymous (see `org-export-create-backend') or if
there is no export process in progress.
It can be used to teach Babel blocks how to act differently
according to the backend used.")
\f
;;; User-configurable Variables
;;
;; Configuration for the masses.
;;
;; They should never be accessed directly, as their value is to be
;; stored in a property list (cf. `org-export-options-alist').
;; Backends will read their value from there instead.
(defgroup org-export nil
"Options for exporting Org mode files."
:tag "Org Export"
:group 'org)
(defgroup org-export-general nil
"General options for export engine."
:tag "Org Export General"
:group 'org-export)
(defcustom org-export-with-archived-trees 'headline
"Whether sub-trees with the ARCHIVE tag should be exported.
This can have three different values:
nil Do not export, pretend this tree is not present.
t Do export the entire tree.
`headline' Only export the headline, but skip the tree below it.
This option can also be set with the OPTIONS keyword,
e.g. \"arch:nil\"."
:group 'org-export-general
:type '(choice
(const :tag "Not at all" nil)
(const :tag "Headline only" headline)
(const :tag "Entirely" t))
:safe (lambda (x) (memq x '(t nil headline))))
(defcustom org-export-with-author t
"Non-nil means insert author name into the exported file.
This option can also be set with the OPTIONS keyword,
e.g. \"author:nil\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-clocks nil
"Non-nil means export CLOCK keywords.
This option can also be set with the OPTIONS keyword,
e.g. \"c:t\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-creator nil
"Non-nil means the postamble should contain a creator sentence.
The sentence can be set in `org-export-creator-string', which
see.
This option can also be set with the OPTIONS keyword, e.g.,
\"creator:t\"."
:group 'org-export-general
:version "26.1"
:package-version '(Org . "8.3")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-date t
"Non-nil means insert date in the exported document.
This option can also be set with the OPTIONS keyword,
e.g. \"date:nil\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-process-citations t
"Non-nil means process citations using citation processors.
nil will leave citation processing to export backend."
:group 'org-export-general
:type 'boolean
:package-version '(Org . "9.7")
:safe #'booleanp)
(defcustom org-export-date-timestamp-format nil
"Timestamp format string to use for DATE keyword.
The format string, when specified, only applies if date consists
in a single timestamp. Otherwise its value will be ignored.
See `format-time-string' for details on how to build this
string."
:group 'org-export-general
:type '(choice
(string :tag "Timestamp format string")
(const :tag "No format string" nil))
:safe (lambda (x) (or (null x) (stringp x))))
(defcustom org-export-creator-string
(format "Emacs %s (Org mode %s)"
emacs-version
(if (fboundp 'org-version) (org-version) "unknown version"))
"Information about the creator of the document.
This option can also be set on with the CREATOR keyword."
:group 'org-export-general
:type '(string :tag "Creator string")
:safe #'stringp)
(defcustom org-export-with-drawers '(not "LOGBOOK")
"Non-nil means export contents of standard drawers.
When t, all drawers are exported. This may also be a list of
drawer names to export, as strings. If that list starts with
`not', only drawers with such names will be ignored.
This variable doesn't apply to properties drawers. See
`org-export-with-properties' instead.
This option can also be set with the OPTIONS keyword,
e.g. \"d:nil\"."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type '(choice
(const :tag "All drawers" t)
(const :tag "None" nil)
(repeat :tag "Selected drawers"
(string :tag "Drawer name"))
(list :tag "Ignored drawers"
(const :format "" not)
(repeat :tag "Specify names of drawers to ignore during export"
:inline t
(string :tag "Drawer name"))))
:safe (lambda (x) (or (booleanp x) (consp x))))
(defcustom org-export-with-email nil
"Non-nil means insert author email into the exported file.
This option can also be set with the OPTIONS keyword,
e.g. \"email:t\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-emphasize t
"Non-nil means interpret *word*, /word/, _word_ and +word+.
If the export target supports emphasizing text, the word will be
typeset in bold, italic, with an underline or strike-through,
respectively.
This option can also be set with the OPTIONS keyword,
e.g. \"*:nil\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-exclude-tags '("noexport")
"Tags that exclude a tree from export.
All trees carrying any of these tags will be excluded from
export. This is without condition, so even subtrees inside that
carry one of the `org-export-select-tags' will be removed.
This option can also be set with the EXCLUDE_TAGS keyword."
:group 'org-export-general
:type '(repeat (string :tag "Tag"))
:safe (lambda (x) (and (listp x) (cl-every #'stringp x))))
(defcustom org-export-with-fixed-width t
"Non-nil means export lines starting with \":\".
This option can also be set with the OPTIONS keyword,
e.g. \"::nil\"."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-footnotes t
"Non-nil means Org footnotes should be exported.
This option can also be set with the OPTIONS keyword,
e.g. \"f:nil\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-latex t
"Non-nil means process LaTeX environments and fragments.
This option can also be set with the OPTIONS line,
e.g. \"tex:verbatim\". Allowed values are:
nil Ignore math snippets.
`verbatim' Keep everything in verbatim.
t Allow export of math snippets."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type '(choice
(const :tag "Do not process math in any way" nil)
(const :tag "Interpret math snippets" t)
(const :tag "Leave math verbatim" verbatim))
:safe (lambda (x) (memq x '(t nil verbatim))))
(defcustom org-export-headline-levels 3
"The last level which is still exported as a headline.
Inferior levels will usually produce itemize or enumerate lists
when exported, but backend behavior may differ.
This option can also be set with the OPTIONS keyword,
e.g. \"H:2\"."
:group 'org-export-general
:type 'integer
:safe #'integerp)
(defcustom org-export-default-language "en"
"The default language for export and clocktable translations, as a string.
This may have an association in
`org-clock-clocktable-language-setup',
`org-export-smart-quotes-alist' and `org-export-dictionary'.
This option can also be set with the LANGUAGE keyword."
:group 'org-export-general
:type '(string :tag "Language")
:safe #'stringp)
(defcustom org-export-preserve-breaks nil
"Non-nil means preserve all line breaks when exporting.
This option can also be set with the OPTIONS keyword,
e.g. \"\\n:t\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-entities t
"Non-nil means interpret entities when exporting.
For example, HTML export converts \\alpha to α and \\AA to
Å.
For a list of supported names, see the constant `org-entities'
and the user option `org-entities-user'.
This option can also be set with the OPTIONS keyword,
e.g. \"e:nil\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-inlinetasks t
"Non-nil means inlinetasks should be exported.
This option can also be set with the OPTIONS keyword,
e.g. \"inline:nil\"."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-planning nil
"Non-nil means include planning info in export.
Planning info is the line containing either SCHEDULED:,
DEADLINE:, CLOSED: timestamps, or a combination of them.
This option can also be set with the OPTIONS keyword,
e.g. \"p:t\"."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-priority nil
"Non-nil means include priority cookies in export.
This option can also be set with the OPTIONS keyword,
e.g. \"pri:t\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-properties nil
"Non-nil means export contents of properties drawers.
When t, all properties are exported. This may also be a list of
properties to export, as strings.
This option can also be set with the OPTIONS keyword,
e.g. \"prop:t\"."
:group 'org-export-general
:version "26.1"
:package-version '(Org . "8.3")
:type '(choice
(const :tag "All properties" t)
(const :tag "None" nil)
(repeat :tag "Selected properties"
(string :tag "Property name")))
:safe (lambda (x) (or (booleanp x)
(and (listp x) (cl-every #'stringp x)))))
(defcustom org-export-with-section-numbers t
"Non-nil means add section numbers to headlines when exporting.
When set to an integer n, numbering will only happen for
headlines whose relative level is higher or equal to n.
This option can also be set with the OPTIONS keyword,
e.g. \"num:t\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-select-tags '("export")
"Tags that select a tree for export.
If any such tag is found in a buffer, all trees that do not carry
one of these tags will be ignored during export. Inside trees
that are selected like this, you can still deselect a subtree by
tagging it with one of the `org-export-exclude-tags'.
This option can also be set with the SELECT_TAGS keyword."
:group 'org-export-general
:type '(repeat (string :tag "Tag"))
:safe (lambda (x) (and (listp x) (cl-every #'stringp x))))
(defcustom org-export-with-smart-quotes nil
"Non-nil means activate smart quotes during export.
This option can also be set with the OPTIONS keyword,
e.g., \"\\=':t\".
When setting this to non-nil, you need to take care of
using the correct Babel package when exporting to LaTeX.
E.g., you can load Babel for french like this:
#+LATEX_HEADER: \\usepackage[french]{babel}"
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-special-strings t
"Non-nil means interpret \"\\-\", \"--\" and \"---\" for export.
When this option is turned on, these strings will be exported as:
Org HTML LaTeX UTF-8
-----+----------+--------+-------
\\- ­ \\-
-- – -- –
--- — --- —
... … \\ldots …
This option can also be set with the OPTIONS keyword,
e.g. \"-:nil\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-statistics-cookies t
"Non-nil means include statistics cookies in export.
This option can also be set with the OPTIONS keyword,
e.g. \"stat:nil\""
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-sub-superscripts t
"Non-nil means interpret \"_\" and \"^\" for export.
If you want to control how Org displays those characters, see
`org-use-sub-superscripts'.
When this option is turned on, you can use TeX-like syntax for
sub- and superscripts and see them exported correctly.
You can also set the option with #+OPTIONS: ^:t
See `org-use-sub-superscripts' docstring for more details."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type '(choice
(const :tag "Interpret them" t)
(const :tag "Curly brackets only" {})
(const :tag "Do not interpret them" nil))
:safe (lambda (x) (memq x '(t nil {}))))
(defcustom org-export-with-toc t
"Non-nil means create a table of contents in exported files.
The table of contents contains headlines with levels up to
`org-export-headline-levels'.
When this variable is set to an integer N, include levels up to
N in the table of contents. Although it may then be different
from `org-export-headline-levels', it is cannot be larger than
the number of headline levels.
When nil, no table of contents is created.
This option can also be set with the OPTIONS keyword,
e.g. \"toc:nil\" or \"toc:3\"."
:group 'org-export-general
:type '(choice
(const :tag "No Table of Contents" nil)
(const :tag "Full Table of Contents" t)
(integer :tag "TOC to level"))
:safe (lambda (x)
(or (booleanp x)
(integerp x))))
(defcustom org-export-with-tables t
"Non-nil means export tables.
This option can also be set with the OPTIONS keyword,
e.g. \"|:nil\"."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-tags t
"If nil, do not export tags, just remove them from headlines.
If this is the symbol `not-in-toc', tags will be removed from
table of contents entries, but still be shown in the headlines of
the document.
This option can also be set with the OPTIONS keyword,
e.g. \"tags:nil\"."
:group 'org-export-general
:type '(choice
(const :tag "Off" nil)
(const :tag "Not in TOC" not-in-toc)
(const :tag "On" t))
:safe (lambda (x) (memq x '(t nil not-in-toc))))
(defcustom org-export-with-tasks t
"Non-nil means include TODO items for export.
This may have the following values:
t include tasks independent of state.
`todo' include only tasks that are not yet done.
`done' include only tasks that are already done.
nil ignore all tasks.
list of keywords include tasks with these keywords.
This option can also be set with the OPTIONS keyword,
e.g. \"tasks:nil\"."
:group 'org-export-general
:type '(choice
(const :tag "All tasks" t)
(const :tag "No tasks" nil)
(const :tag "Not-done tasks" todo)
(const :tag "Only done tasks" done)
(repeat :tag "Specific TODO keywords"
(string :tag "Keyword")))
:safe (lambda (x) (or (memq x '(nil t todo done))
(and (listp x)
(cl-every #'stringp x)))))
(defcustom org-export-with-title t
"Non-nil means print title into the exported file.
This option can also be set with the OPTIONS keyword,
e.g. \"title:nil\"."
:group 'org-export-general
:version "26.1"
:package-version '(Org . "8.3")
:type 'boolean
:safe #'booleanp)
(defvaralias 'org-export-time-stamp-file 'org-export-timestamp-file)
(defcustom org-export-timestamp-file t
"Non-nil means insert a time stamp into the exported file.
The time stamp shows when the file was created. This option can
also be set with the OPTIONS keyword, e.g. \"timestamp:nil\"."
:group 'org-export-general
:type 'boolean
:safe #'booleanp)
(defcustom org-export-with-timestamps t
"Non-nil means allow timestamps in export.
It can be set to any of the following values:
t export all timestamps.
`active' export active timestamps only.
`inactive' export inactive timestamps only.
nil do not export timestamps
This only applies to timestamps isolated in a paragraph
containing only timestamps. Other timestamps are always
exported.
This option can also be set with the OPTIONS keyword, e.g.
\"<:nil\"."
:group 'org-export-general
:type '(choice
(const :tag "All timestamps" t)
(const :tag "Only active timestamps" active)
(const :tag "Only inactive timestamps" inactive)
(const :tag "No timestamp" nil))
:safe (lambda (x) (memq x '(t nil active inactive))))
(defcustom org-export-with-todo-keywords t
"Non-nil means include TODO keywords in export.
When nil, remove all these keywords from the export. This option
can also be set with the OPTIONS keyword, e.g. \"todo:nil\"."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-allow-bind-keywords nil
"Non-nil means BIND keywords can define local variable values.
This is a potential security risk, which is why the default value
is nil. You can also allow them through local buffer variables."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'boolean)
(defcustom org-export-with-broken-links nil
"Non-nil means do not raise an error on broken links.
When this variable is non-nil, broken links are ignored, without
stopping the export process. If it is set to `mark', broken
links are marked as such in the output, with a string like
[BROKEN LINK: path]
where PATH is the un-resolvable reference.
This option can also be set with the OPTIONS keyword, e.g.,
\"broken-links:mark\"."
:group 'org-export-general
:version "26.1"
:package-version '(Org . "9.0")
:type '(choice
(const :tag "Ignore broken links" t)
(const :tag "Mark broken links in output" mark)
(const :tag "Raise an error" nil)))
(defcustom org-export-expand-links t
"When non-nil, expand environment variables in file paths."
:group 'org-export-general
:package-version '(Org . "9.7")
:type 'boolean)
(defcustom org-export-snippet-translation-alist nil
"Alist between export snippets backends and exporter backends.
This variable allows providing shortcuts for export snippets.
For example, with:
(setq org-export-snippet-translation-alist
\\='((\"h\" . \"html\")))
the HTML backend will recognize the contents of \"@@h:<b>@@\" as
HTML code while every other backend will ignore it."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type '(repeat
(cons (string :tag "Shortcut")
(string :tag "Backend")))
:safe (lambda (x)
(and (listp x)
(cl-every #'consp x)
(cl-every #'stringp (mapcar #'car x))
(cl-every #'stringp (mapcar #'cdr x)))))
(defcustom org-export-global-macros nil
"Alist between macro names and expansion templates.
This variable defines macro expansion templates available
globally. Associations follow the pattern
(NAME . TEMPLATE)
where NAME is a string beginning with a letter and consisting of
alphanumeric characters only.
TEMPLATE is the string to which the macro is going to be
expanded. Inside, \"$1\", \"$2\"... are place-holders for
macro's arguments. Moreover, if the template starts with
\"(eval\", it will be parsed as an Elisp expression and evaluated
accordingly."
:group 'org-export-general
:version "26.1"
:package-version '(Org . "9.1")
:type '(repeat
(cons (string :tag "Name")
(string :tag "Template"))))
(defcustom org-export-coding-system nil
"Coding system for the exported file."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'coding-system)
(defcustom org-export-copy-to-kill-ring nil
"Non-nil means pushing export output to the kill ring.
This variable is ignored during asynchronous export."
:group 'org-export-general
:version "26.1"
:package-version '(Org . "8.3")
:type '(choice
(const :tag "Always" t)
(const :tag "When export is done interactively" if-interactive)
(const :tag "Never" nil)))
(defcustom org-export-initial-scope 'buffer
"The initial scope when exporting with `org-export-dispatch'.
This variable can be either set to `buffer' or `subtree'."
:group 'org-export-general
:type '(choice
(const :tag "Export current buffer" buffer)
(const :tag "Export current subtree" subtree)))
(defcustom org-export-show-temporary-export-buffer t
"Non-nil means show buffer after exporting to temp buffer.
When Org exports to a file, the buffer visiting that file is never
shown, but remains buried. However, when exporting to
a temporary buffer, that buffer is popped up in a second window.
When this variable is nil, the buffer remains buried also in
these cases."
:group 'org-export-general
:type 'boolean)
(defcustom org-export-body-only nil
"The initial \"Body only\" setting when exporting with `org-export-dispatch'.
Non-nil means only export body code, without the surrounding
template."
:group 'org-export-general
:package-version '(Org . "9.7")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-visible-only nil
"The initial \"Visible only\" setting when exporting with `org-export-dispatch'.
Non-nil means don't export the contents of hidden elements."
:group 'org-export-general
:package-version '(Org . "9.7")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-force-publishing nil
"The initial \"Force publishing\" setting for `org-export-dispatch'.
Non-nil means force all files in the project to be published."
:group 'org-export-general
:package-version '(Org . "9.7")
:type 'boolean
:safe #'booleanp)
(defcustom org-export-in-background nil
"Non-nil means export and publishing commands will run in background.
Results from an asynchronous export are never displayed
automatically. But you can retrieve them with `\\[org-export-stack]'."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'boolean)
(defcustom org-export-async-init-file nil
"File used to initialize external export process.
Value must be either nil or an absolute file name. When nil, the
external process is launched like a regular Emacs session,
loading user's initialization file and any site specific
configuration. If a file is provided, it, and only it, is loaded
at start-up.
Therefore, using a specific configuration makes the process to
load faster and the export more portable."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type '(choice
(const :tag "Regular startup" nil)
(file :tag "Specific start-up file" :must-match t)))
(defcustom org-export-dispatch-use-expert-ui nil
"Non-nil means using a non-intrusive `org-export-dispatch'.
In that case, no help buffer is displayed. Though, an indicator
for current export scope is added to the prompt (\"b\" when
output is restricted to body only, \"s\" when it is restricted to
the current subtree, \"v\" when only visible elements are
considered for export, \"f\" when publishing functions should be
passed the FORCE argument and \"a\" when the export should be
asynchronous). Also, [?] allows switching back to standard
mode."
:group 'org-export-general
:version "24.4"
:package-version '(Org . "8.0")
:type 'boolean)
\f
;;; Defining Backends
;;
;; An export backend is a structure with `org-export-backend' type
;; and `name', `parent', `transcoders', `options', `filters', `blocks'
;; and `menu' slots.
;;
;; At the lowest level, a backend is created with
;; `org-export-create-backend' function.
;;
;; A named backend can be registered with
;; `org-export-register-backend' function. A registered backend can
;; later be referred to by its name, with `org-export-get-backend'
;; function. Also, such a backend can become the parent of a derived
;; backend from which slot values will be inherited by default.
;; `org-export-derived-backend-p' can check if a given backend is
;; derived from a list of backend names.
;;
;; `org-export-get-all-transcoders', `org-export-get-all-options' and
;; `org-export-get-all-filters' return the full alist of transcoders,
;; options and filters, including those inherited from ancestors.
;;
;; At a higher level, `org-export-define-backend' is the standard way
;; to define an export backend. If the new backend is similar to
;; a registered backend, `org-export-define-derived-backend' may be
;; used instead.
;;
;; Eventually `org-export-barf-if-invalid-backend' returns an error
;; when a given backend hasn't been registered yet.
(cl-defstruct (org-export-backend (:constructor org-export-create-backend)
(:copier nil))
name parent transcoders options filters blocks menu)
;;;###autoload
(defun org-export-get-backend (name)
"Return export backend named after NAME.
NAME is a symbol. Return nil if no such backend is found."
(cl-find-if (lambda (b) (and (eq name (org-export-backend-name b))))
org-export-registered-backends))
(defun org-export-register-backend (backend)
"Register BACKEND as a known export backend.
BACKEND is a structure with `org-export-backend' type."
;; Refuse to register an unnamed backend.
(unless (org-export-backend-name backend)
(error "Cannot register a unnamed export backend"))
;; Refuse to register a backend with an unknown parent.
(let ((parent (org-export-backend-parent backend)))
(when (and parent (not (org-export-get-backend parent)))
(error "Cannot use unknown \"%s\" backend as a parent" parent)))
;; If a backend with the same name as BACKEND is already
;; registered, replace it with BACKEND. Otherwise, simply add
;; BACKEND to the list of registered backends.
(let ((old (org-export-get-backend (org-export-backend-name backend))))
(if old (setcar (memq old org-export-registered-backends) backend)
(push backend org-export-registered-backends))))
(defun org-export-barf-if-invalid-backend (backend)
"Signal an error if BACKEND isn't defined."
(unless (org-export-backend-p backend)
(error "Unknown \"%s\" backend: Aborting export" backend)))
;;;###autoload
(defun org-export-derived-backend-p (backend &rest backends)
"Non-nil if BACKEND is derived from one of BACKENDS.
BACKEND is an export backend, as returned by, e.g.,
`org-export-create-backend', or a symbol referring to
a registered backend. BACKENDS is constituted of symbols."
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
(when backend
(catch 'exit
(while (org-export-backend-parent backend)
(when (memq (org-export-backend-name backend) backends)
(throw 'exit t))
(setq backend
(org-export-get-backend (org-export-backend-parent backend))))
(memq (org-export-backend-name backend) backends))))
(defun org-export-get-all-transcoders (backend)
"Return full translation table for BACKEND.
BACKEND is an export backend, as return by, e.g,,
`org-export-create-backend'. Return value is an alist where
keys are element or object types, as symbols, and values are
transcoders.
Unlike to `org-export-backend-transcoders', this function
also returns transcoders inherited from parent backends,
if any."
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
(when backend
(let ((transcoders (org-export-backend-transcoders backend))
parent)
(while (setq parent (org-export-backend-parent backend))
(setq backend (if (symbolp parent) (org-export-get-backend parent) parent))
(setq transcoders
(append transcoders (org-export-backend-transcoders backend))))
transcoders)))
(defun org-export-get-all-options (backend)
"Return export options for BACKEND.
BACKEND is an export backend, as return by, e.g,,
`org-export-create-backend'. See `org-export-options-alist'
for the shape of the return value.
Unlike to `org-export-backend-options', this function also
returns options inherited from parent backends, if any.
Return nil if BACKEND is unknown."
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
(when backend
(let ((options (org-export-backend-options backend))
parent)
(while (setq parent (org-export-backend-parent backend))
(setq backend (org-export-get-backend parent))
(setq options (append options (org-export-backend-options backend))))
options)))
(defun org-export-get-all-filters (backend)
"Return complete list of filters for BACKEND.
BACKEND is an export backend, as return by, e.g,,
`org-export-create-backend'. Return value is an alist where
keys are symbols and values lists of functions.
Unlike to `org-export-backend-filters', this function also
returns filters inherited from parent backends, if any."
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
(when backend
(let ((filters (org-export-backend-filters backend))
parent)
(while (setq parent (org-export-backend-parent backend))
(setq backend (org-export-get-backend parent))
(setq filters (append filters (org-export-backend-filters backend))))
filters)))
(defun org-export-define-backend (backend transcoders &rest body)
"Define a new backend BACKEND.
TRANSCODERS is an alist between object or element types and
functions handling them.
These functions should return a string without any trailing
space, or nil. They must accept three arguments: the object or
element itself, its contents or nil when it isn't recursive and
the property list used as a communication channel.
Contents, when not nil, are stripped from any global indentation
\(although the relative one is preserved). They also always end
with a single newline character.
If, for a given type, no function is found, that element or
object type will simply be ignored, along with any blank line or
white space at its end. The same will happen if the function
returns the nil value. If that function returns the empty
string, the type will be ignored, but the blank lines or white
spaces will be kept.
In addition to element and object types, one function can be
associated to the `template' (or `inner-template') symbol and
another one to the `plain-text' symbol.
The former returns the final transcoded string, and can be used
to add a preamble and a postamble to document's body. It must
accept two arguments: the transcoded string and the property list
containing export options. A function associated to `template'
will not be applied if export has option \"body-only\".
A function associated to `inner-template' is always applied.
The latter, when defined, is to be called on every text not
recognized as an element or an object. It must accept two
arguments: the text string and the information channel. It is an
appropriate place to protect special chars relative to the
backend.
BODY can start with pre-defined keyword arguments. The following
keywords are understood:
:filters-alist
Alist between filters and function, or list of functions,
specific to the backend. See `org-export-filters-alist' for
a list of all allowed filters. Filters defined here
shouldn't make a backend test, as it may prevent backends
derived from this one to behave properly.
:menu-entry
Menu entry for the export dispatcher. It should be a list
like:
(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
where :
KEY is a free character selecting the backend.
DESCRIPTION-OR-ORDINAL is either a string or a number.
If it is a string, is will be used to name the backend in
its menu entry. If it is a number, the following menu will
be displayed as a sub-menu of the backend with the same
KEY. Also, the number will be used to determine in which
order such sub-menus will appear (lowest first).
ACTION-OR-MENU is either a function or an alist.
If it is an action, it will be called with four
arguments (booleans): ASYNC, SUBTREEP, VISIBLE-ONLY and
BODY-ONLY. See `org-export-as' for further explanations on
some of them.
If it is an alist, associations should follow the
pattern:
(KEY DESCRIPTION ACTION)
where KEY, DESCRIPTION and ACTION are described above.
Valid values include:
(?m \"My Special Backend\" my-special-export-function)
or
(?l \"Export to LaTeX\"
((?p \"As PDF file\" org-latex-export-to-pdf)
(?o \"As PDF file and open\"
(lambda (a s v b)
(if a (org-latex-export-to-pdf t s v b)
(org-open-file
(org-latex-export-to-pdf nil s v b)))))))
or the following, which will be added to the previous
sub-menu,
(?l 1
((?B \"As TEX buffer (Beamer)\" org-beamer-export-as-latex)
(?P \"As PDF file (Beamer)\" org-beamer-export-to-pdf)))
:options-alist
Alist between backend specific properties introduced in
communication channel and how their value are acquired. See
`org-export-options-alist' for more information about
structure of the values."
(declare (indent 1))
(let (filters menu-entry options)
(while (keywordp (car body))
(let ((keyword (pop body)))
(pcase keyword
(:filters-alist (setq filters (pop body)))
(:menu-entry (setq menu-entry (pop body)))
(:options-alist (setq options (pop body)))
(_ (error "Unknown keyword: %s" keyword)))))
(org-export-register-backend
(org-export-create-backend :name backend
:transcoders transcoders
:options options
:filters filters
:menu menu-entry))))
(defun org-export-define-derived-backend (child parent &rest body)
"Create a new backend as a variant of an existing one.
CHILD is the name of the derived backend. PARENT is the name of
the parent backend.
BODY can start with pre-defined keyword arguments. The following
keywords are understood:
:filters-alist
Alist of filters that will overwrite or complete filters
defined in PARENT backend. See `org-export-filters-alist'
for a list of allowed filters.
:menu-entry
Menu entry for the export dispatcher. See
`org-export-define-backend' for more information about the
expected value.
:options-alist
Alist of backend specific properties that will overwrite or
complete those defined in PARENT backend. Refer to
`org-export-options-alist' for more information about
structure of the values.
:translate-alist
Alist of element and object types and transcoders that will
overwrite or complete transcode table from PARENT backend.
Refer to `org-export-define-backend' for detailed information
about transcoders.
As an example, here is how one could define \"my-latex\" backend
as a variant of `latex' backend with a custom template function:
(org-export-define-derived-backend \\='my-latex \\='latex
:translate-alist \\='((template . my-latex-template-fun)))
The backend could then be called with, for example:
(org-export-to-buffer \\='my-latex \"*Test my-latex*\")"
(declare (indent 2))
(let (filters menu-entry options transcoders)
(while (keywordp (car body))
(let ((keyword (pop body)))
(pcase keyword
(:filters-alist (setq filters (pop body)))
(:menu-entry (setq menu-entry (pop body)))
(:options-alist (setq options (pop body)))
(:translate-alist (setq transcoders (pop body)))
(_ (error "Unknown keyword: %s" keyword)))))
(org-export-register-backend
(org-export-create-backend :name child
:parent parent
:transcoders transcoders
:options options
:filters filters
:menu menu-entry))))
\f
;;; The Communication Channel
;;
;; During export process, every function has access to a number of
;; properties. They are of two types:
;;
;; 1. Environment options are collected once at the very beginning of
;; the process, out of the original buffer and configuration.
;; Collecting them is handled by `org-export-get-environment'
;; function.
;;
;; Most environment options are defined through the
;; `org-export-options-alist' variable.
;;
;; 2. Tree properties are extracted directly from the parsed tree,
;; just before export, by `org-export--collect-tree-properties'.
;;;; Environment Options
;;
;; Environment options encompass all parameters defined outside the
;; scope of the parsed data. They come from five sources, in
;; increasing precedence order:
;;
;; - Global variables,
;; - Buffer's attributes,
;; - Options keyword symbols,
;; - Buffer keywords,
;; - Subtree properties.
;;
;; The central internal function with regards to environment options
;; is `org-export-get-environment'. It updates global variables with
;; "#+BIND:" keywords, then retrieve and prioritize properties from
;; the different sources.
;;
;; The internal functions doing the retrieval are:
;; `org-export--get-global-options',
;; `org-export--get-buffer-attributes',
;; `org-export--parse-option-keyword',
;; `org-export--get-subtree-options' and
;; `org-export--get-inbuffer-options'
;;
;; Also, `org-export--list-bound-variables' collects bound variables
;; along with their value in order to set them as buffer local
;; variables later in the process.
;;;###autoload
(defun org-export-get-environment (&optional backend subtreep ext-plist)
"Collect export options from the current buffer.
Optional argument BACKEND is an export backend, as returned by
`org-export-create-backend'.
When optional argument SUBTREEP is non-nil, assume the export is
done against the current sub-tree.
Third optional argument EXT-PLIST is a property list with
external parameters overriding Org default settings, but still
inferior to file-local settings."
;; First install #+BIND variables since these must be set before
;; global options are read.
(dolist (pair (org-export--list-bound-variables))
(set (make-local-variable (car pair)) (nth 1 pair)))
;; Get and prioritize export options...
(org-combine-plists
;; ... from global variables...
(org-export--get-global-options backend)
;; ... from an external property list...
ext-plist
;; ... from in-buffer settings...
(org-export--get-inbuffer-options backend)
;; ... and from subtree, when appropriate.
(and subtreep (org-export--get-subtree-options backend))))
(defun org-export--parse-option-keyword (options &optional backend)
"Parse an OPTIONS line and return values as a plist.
Optional argument BACKEND is an export backend, as returned by,
e.g., `org-export-create-backend'. It specifies which backend
specific items to read, if any."
(let ((line
(let (alist)
(with-temp-buffer
(insert options)
(goto-char (point-min))
(while (re-search-forward "\\s-*\\(.+?\\):" nil t)
(when (looking-at-p "\\S-")
(push (cons (match-string 1)
(read (current-buffer))) ; moves point
alist))))
alist))
;; Priority is given to backend specific options.
(all (append (org-export-get-all-options backend)
org-export-options-alist))
(plist))
(when line
(dolist (entry all plist)
(let ((item (nth 2 entry)))
(when item
(let ((v (assoc-string item line t)))
(when v (setq plist (plist-put plist (car entry) (cdr v)))))))))))
(defun org-export--get-subtree-options (&optional backend)
"Get export options in subtree at point.
Optional argument BACKEND is an export backend, as returned by,
e.g., `org-export-create-backend'. It specifies backend used
for export. Return options as a plist."
;; For each buffer keyword, create a headline property setting the
;; same property in communication channel. The name for the
;; property is the keyword with "EXPORT_" appended to it.
(org-with-wide-buffer
;; Make sure point is at a heading.
(org-back-to-heading t)
(let ((plist
;; EXPORT_OPTIONS are parsed in a non-standard way. Take
;; care of them right from the start.
(let ((o (org-entry-get (point) "EXPORT_OPTIONS" 'selective)))
(and o (org-export--parse-option-keyword o backend))))
;; Take care of EXPORT_TITLE. If it isn't defined, use
;; headline's title (with no todo keyword, priority cookie or
;; tag) as its fallback value.
(cache (list
(cons "TITLE"
(or (org-entry-get (point) "EXPORT_TITLE" 'selective)
(let ((case-fold-search nil))
(looking-at org-complex-heading-regexp)
(match-string-no-properties 4))))))
;; Look for both general keywords and backend specific
;; options, with priority given to the latter.
(options (append (org-export-get-all-options backend)
org-export-options-alist)))
;; Handle other keywords. Then return PLIST.
(dolist (option options plist)
(let ((property (car option))
(keyword (nth 1 option)))
(when keyword
(let ((value
(or (cdr (assoc keyword cache))
(let ((v (org-entry-get (point)
(concat "EXPORT_" keyword)
'selective)))
(push (cons keyword v) cache) v))))
(when value
(setq plist
(plist-put plist
property
(cl-case (nth 4 option)
(parse
(org-element-parse-secondary-string
value (org-element-restriction 'keyword)))
(split (split-string value))
(t value))))))))))))
(defun org-export--get-inbuffer-options (&optional backend)
"Return current buffer export options, as a plist.
Optional argument BACKEND, when non-nil, is an export backend,
as returned by, e.g., `org-export-create-backend'. It specifies
which backend specific options should also be read in the
process.
Assume buffer is in Org mode. Narrowing, if any, is ignored."
(let* ((case-fold-search t)
(options (append
;; Priority is given to backend specific options.
(org-export-get-all-options backend)
org-export-options-alist))
plist to-parse)
(let ((find-properties
(lambda (keyword)
;; Return all properties associated to KEYWORD.
(let (properties)
(dolist (option options properties)
(when (equal (nth 1 option) keyword)
(cl-pushnew (car option) properties)))))))
;; Read options in the current buffer and return value.
(dolist (entry (org-collect-keywords
(nconc (delq nil (mapcar #'cadr options))
'("FILETAGS" "OPTIONS"))))
(pcase entry
(`("OPTIONS" . ,values)
(setq plist
(apply #'org-combine-plists
plist
(mapcar (lambda (v)
(org-export--parse-option-keyword v backend))
values))))
(`("FILETAGS" . ,values)
(setq plist
(plist-put plist
:filetags
(org-uniquify
(cl-mapcan (lambda (v) (org-split-string v ":"))
values)))))
(`(,keyword . ,values)
(dolist (property (funcall find-properties keyword))
(setq plist
(plist-put
plist property
;; Handle value depending on specified BEHAVIOR.
(cl-case (nth 4 (assq property options))
(parse
(unless (memq property to-parse)
(push property to-parse))
;; Even if `parse' implies `space' behavior, we
;; separate line with "\n" so as to preserve
;; line-breaks.
(mapconcat #'identity values "\n"))
(space
(mapconcat #'identity values " "))
(newline
(mapconcat #'identity values "\n"))
(split
(cl-mapcan (lambda (v) (split-string v)) values))
((t)
(org-last values))
(otherwise
(car values)))))))))
;; Parse properties in TO-PARSE. Remove newline characters not
;; involved in line breaks to simulate `space' behavior.
;; Finally return options.
(dolist (p to-parse plist)
(let ((value (org-element-parse-secondary-string
(plist-get plist p)
(org-element-restriction 'keyword))))
(org-element-map value 'plain-text
(lambda (s)
(org-element-set
s (replace-regexp-in-string "\n" " " s))))
(setq plist (plist-put plist p value)))))))
(defun org-export--get-export-attributes
(&optional backend subtreep visible-only body-only)
"Return properties related to export process, as a plist.
Optional arguments BACKEND, SUBTREEP, VISIBLE-ONLY and BODY-ONLY
are like the arguments with the same names of function
`org-export-as'."
(list :export-options (delq nil
(list (and subtreep 'subtree)
(and visible-only 'visible-only)
(and body-only 'body-only)))
:back-end backend
:translate-alist (org-export-get-all-transcoders backend)
:exported-data (make-hash-table :test #'eq :size 4001)))
(defun org-export--get-buffer-attributes ()
"Return properties related to buffer attributes, as a plist."
(list :input-buffer (buffer-name (buffer-base-buffer))
:input-file (buffer-file-name (buffer-base-buffer))))
(defun org-export--get-global-options (&optional backend)
"Return global export options as a plist.
Optional argument BACKEND, if non-nil, is an export backend, as
returned by, e.g., `org-export-create-backend'. It specifies
which backend specific export options should also be read in the
process."
(let (plist
;; Priority is given to backend specific options.
(all (append (org-export-get-all-options backend)
org-export-options-alist)))
(dolist (cell all plist)
(let ((prop (car cell)))
(unless (plist-member plist prop)
(setq plist
(plist-put
plist
prop
;; Evaluate default value provided.
(let ((value (eval (nth 3 cell) t)))
(if (eq (nth 4 cell) 'parse)
(org-element-parse-secondary-string
value (org-element-restriction 'keyword))
value)))))))))
(defun org-export--list-bound-variables ()
"Return variables bound from BIND keywords in current buffer.
Also look for BIND keywords in setup files. The return value is
an alist where associations are (VARIABLE-NAME VALUE)."
(when org-export-allow-bind-keywords
(pcase (org-collect-keywords '("BIND"))
(`(("BIND" . ,values))
(mapcar (lambda (v) (read (format "(%s)" v)))
values)))))
;;;; Tree Properties
;;
;; Tree properties are information extracted from parse tree. They
;; are initialized at the beginning of the transcoding process by
;; `org-export--collect-tree-properties'.
;;
;; Dedicated functions focus on computing the value of specific tree
;; properties during initialization. Thus, `org-export--prune-tree'
;; lists elements and objects that should be skipped during export,
;; `org-export--get-min-level' gets the minimal exportable level, used
;; as a basis to compute relative level for headlines. Eventually
;; `org-export--collect-headline-numbering' builds an alist between
;; headlines and their numbering.
(defun org-export--collect-tree-properties (data info)
"Extract tree properties from parse tree.
DATA is the parse tree from which information is retrieved. INFO
is a list holding export options.
Following tree properties are set or updated:
`:parse-tree' Is simply set to DATA.
`:headline-offset' Offset between true level of headlines and
local level. An offset of -1 means a headline
of level 2 should be considered as a level
1 headline in the context.
`:headline-numbering' Alist of all headlines as key and the
associated numbering as value.
`:id-alist' Alist of all ID references as key and associated file
as value.
Return updated plist."
;; Install the parse tree in the communication channel.
(setq info (plist-put info :parse-tree data))
;; Compute `:headline-offset' in order to be able to use
;; `org-export-get-relative-level'.
(setq info
(plist-put info
:headline-offset
(- 1 (org-export--get-min-level data info))))
;; From now on, properties order doesn't matter: get the rest of the
;; tree properties.
(org-combine-plists
info
(list :headline-numbering (org-export--collect-headline-numbering data info)
:id-alist
(org-element-map data 'link
(lambda (l)
(and (string= (org-element-property :type l) "id")
(let* ((id (org-element-property :path l))
(file (car (org-id-find id))))
(and file (cons id (file-relative-name file))))))))))
(defun org-export--get-min-level (data options)
"Return minimum exportable headline's level in DATA.
DATA is parsed tree as returned by `org-element-parse-buffer'.
OPTIONS is a plist holding export options."
(catch 'exit
(let ((min-level 10000))
(dolist (datum (org-element-contents data))
(when (and (org-element-type-p datum 'headline)
(not (org-element-property :footnote-section-p datum))
(not (memq datum (plist-get options :ignore-list))))
(setq min-level (min (org-element-property :level datum) min-level))
(when (= min-level 1) (throw 'exit 1))))
;; If no headline was found, for the sake of consistency, set
;; minimum level to 1 nonetheless.
(if (= min-level 10000) 1 min-level))))
(defun org-export--collect-headline-numbering (data options)
"Return numbering of all exportable, numbered headlines in a parse tree.
DATA is the parse tree. OPTIONS is the plist holding export
options.
Return an alist whose key is a headline and value is its
associated numbering \(in the shape of a list of numbers) or nil
for a footnotes section."
(let ((numbering (make-vector org-export-max-depth 0)))
(org-element-map data 'headline
(lambda (headline)
(when (and (org-export-numbered-headline-p headline options)
(not (org-element-property :footnote-section-p headline)))
(let ((relative-level
(1- (org-export-get-relative-level headline options))))
(cons
headline
(cl-loop
for n across numbering
for idx from 0 to org-export-max-depth
when (< idx relative-level) collect n
when (= idx relative-level) collect (aset numbering idx (1+ n))
when (> idx relative-level) do (aset numbering idx 0))))))
options)))
(defun org-export--selected-trees (data info)
"List headlines and inlinetasks with a select tag in their tree.
DATA is parsed data as returned by `org-element-parse-buffer'.
INFO is a plist holding export options."
(let ((select (cl-mapcan (lambda (tag) (org-tags-expand tag t))
(plist-get info :select-tags))))
(if (cl-some (lambda (tag) (member tag select)) (plist-get info :filetags))
;; If FILETAGS contains a select tag, every headline or
;; inlinetask is returned.
(org-element-map data '(headline inlinetask) #'identity)
(letrec ((selected-trees nil)
(walk-data
(lambda (data genealogy)
(let ((type (org-element-type data)))
(cond
((memq type '(headline inlinetask))
(let ((tags (org-element-property :tags data)))
(if (cl-some (lambda (tag) (member tag select)) tags)
;; When a select tag is found, mark full
;; genealogy and every headline within the
;; tree as acceptable.
(setq selected-trees
(append
genealogy
(org-element-map data '(headline inlinetask)
#'identity)
selected-trees))
;; If at a headline, continue searching in
;; tree, recursively.
(when (eq type 'headline)
(dolist (el (org-element-contents data))
(funcall walk-data el (cons data genealogy)))))))
((or (eq type 'org-data)
(memq type org-element-greater-elements))
(dolist (el (org-element-contents data))
(funcall walk-data el genealogy))))))))
(funcall walk-data data nil)
selected-trees))))
(defun org-export--skip-p (datum options selected excluded)
"Non-nil when element or object DATUM should be skipped during export.
OPTIONS is the plist holding export options. SELECTED, when
non-nil, is a list of headlines or inlinetasks belonging to
a tree with a select tag. EXCLUDED is a list of tags, as
strings. Any headline or inlinetask marked with one of those is
not exported."
(cl-case (org-element-type datum)
((comment comment-block)
;; Skip all comments and comment blocks. Make to keep maximum
;; number of blank lines around the comment so as to preserve
;; local structure of the document upon interpreting it back into
;; Org syntax.
(let* ((previous (org-export-get-previous-element datum options))
(before (or (org-element-post-blank previous) 0))
(after (or (org-element-post-blank datum) 0)))
(when previous
(org-element-put-property previous :post-blank (max before after 1))))
t)
(clock (not (plist-get options :with-clocks)))
(drawer
(let ((with-drawers-p (plist-get options :with-drawers)))
(or (not with-drawers-p)
(and (consp with-drawers-p)
;; If `:with-drawers' value starts with `not', ignore
;; every drawer whose name belong to that list.
;; Otherwise, ignore drawers whose name isn't in that
;; list.
(let ((name (org-element-property :drawer-name datum)))
(if (eq (car with-drawers-p) 'not)
(member-ignore-case name (cdr with-drawers-p))
(not (member-ignore-case name with-drawers-p))))))))
(fixed-width (not (plist-get options :with-fixed-width)))
((footnote-definition footnote-reference)
(not (plist-get options :with-footnotes)))
((headline inlinetask)
(let ((with-tasks (plist-get options :with-tasks))
(todo (org-element-property :todo-keyword datum))
(todo-type (org-element-property :todo-type datum))
(archived (plist-get options :with-archived-trees))
(tags (org-export-get-tags datum options nil t)))
(or
(and (org-element-type-p datum 'inlinetask)
(not (plist-get options :with-inlinetasks)))
;; Ignore subtrees with an exclude tag.
(cl-some (lambda (tag) (member tag excluded)) tags)
;; When a select tag is present in the buffer, ignore any tree
;; without it.
(and selected (not (memq datum selected)))
;; Ignore commented sub-trees.
(org-element-property :commentedp datum)
;; Ignore archived subtrees if `:with-archived-trees' is nil.
(and (not archived) (org-element-property :archivedp datum))
;; Ignore tasks, if specified by `:with-tasks' property.
(and todo
(or (not with-tasks)
(and (memq with-tasks '(todo done))
(not (eq todo-type with-tasks)))
(and (consp with-tasks) (not (member todo with-tasks))))))))
((latex-environment latex-fragment) (not (plist-get options :with-latex)))
(node-property
(let ((properties-set (plist-get options :with-properties)))
(cond ((null properties-set) t)
((consp properties-set)
(not (member-ignore-case (org-element-property :key datum)
properties-set))))))
(planning (not (plist-get options :with-planning)))
(property-drawer (not (plist-get options :with-properties)))
(statistics-cookie (not (plist-get options :with-statistics-cookies)))
(table (not (plist-get options :with-tables)))
(table-cell
(and (org-export-table-has-special-column-p
(org-element-lineage datum 'table))
(org-export-first-sibling-p datum options)))
(table-row
(unless (plist-get options :with-special-rows)
(org-export-table-row-is-special-p datum options)))
(timestamp
;; `:with-timestamps' only applies to isolated timestamps
;; objects, i.e. timestamp objects in a paragraph containing only
;; timestamps and whitespaces.
(when (let ((parent (org-element-parent-element datum)))
(and (org-element-type-p parent '(paragraph verse-block))
(not (org-element-map parent
(cons 'plain-text
(remq 'timestamp org-element-all-objects))
(lambda (obj)
(or (not (stringp obj)) (org-string-nw-p obj)))
options t))))
(cl-case (plist-get options :with-timestamps)
((nil) t)
(active
(not (memq (org-element-property :type datum) '(active active-range))))
(inactive
(not (memq (org-element-property :type datum)
'(inactive inactive-range)))))))))
\f
;;; The Transcoder
;;
;; `org-export-data' reads a parse tree (obtained with, i.e.
;; `org-element-parse-buffer') and transcodes it into a specified
;; backend output. It takes care of filtering out elements or
;; objects according to export options and organizing the output blank
;; lines and white space are preserved. The function memoizes its
;; results, so it is cheap to call it within transcoders.
;;
;; It is possible to modify locally the backend used by
;; `org-export-data' or even use a temporary backend by using
;; `org-export-data-with-backend'.
;;
;; `org-export-transcoder' is an accessor returning appropriate
;; translator function for a given element or object.
(defun org-export-transcoder (blob info)
"Return appropriate transcoder for BLOB.
INFO is a plist containing export directives."
(let ((type (org-element-type blob)))
;; Return contents only for complete parse trees.
(if (eq type 'org-data) (lambda (_datum contents _info) contents)
(let ((transcoder (cdr (assq type (plist-get info :translate-alist)))))
(and (functionp transcoder) transcoder)))))
(defun org-export--keep-spaces (data info)
"Non-nil, when post-blank spaces after removing DATA should be preserved.
INFO is the info channel.
This function returns nil, when previous exported element already has
trailing spaces or when DATA does not have non-zero non-nil
`:post-blank' property.
When the return value is non-nil, it is a string containing the trailing
spaces."
;; When DATA is an object, interpret this as if DATA should be
;; ignored (see `org-export--prune-tree'). Keep spaces in place of
;; removed element, if necessary. Example: "Foo.[10%] Bar" would
;; become "Foo.Bar" if we do not keep spaces. Another example: "A
;; space@@ascii:*@@ character." should become "A space character"
;; in non-ASCII export.
(let ((post-blank (org-element-post-blank data)))
(unless (or (not post-blank)
(zerop post-blank)
(eq 'element (org-element-class data)))
(let ((previous (org-export-get-previous-element data info)))
(unless (or (not previous)
(pcase (org-element-type previous)
(`plain-text
(string-match-p
(rx (any " \t") eos) previous))
(_ (org-element-post-blank previous))))
;; When previous element does not have
;; trailing spaces, keep the trailing
;; spaces from DATA.
(make-string post-blank ?\s))))))
;;;###autoload
(defun org-export-data (data info)
"Convert DATA into current backend format.
DATA is a parse tree, an element or an object or a secondary
string. INFO is a plist holding export options.
The `:filter-parse-tree' filters are not applied.
Return a string."
(or (gethash data (plist-get info :exported-data))
;; Handle broken links according to
;; `org-export-with-broken-links'.
(cl-macrolet
((broken-link-handler
(&rest body)
`(condition-case err
(progn ,@body)
(org-link-broken
(pcase (plist-get info :with-broken-links)
(`nil (user-error "Unable to resolve link: %S" (nth 1 err)))
(`mark (org-export-data
(format "[BROKEN LINK: %s]" (nth 1 err)) info))
(_ nil))))))
(let* ((type (org-element-type data))
(parent (org-element-parent data))
(results
(cond
;; Ignored element/object.
((memq data (plist-get info :ignore-list)) nil)
;; Raw code.
((eq type 'raw) (car (org-element-contents data)))
;; Plain text.
((eq type 'plain-text)
(org-export-filter-apply-functions
(plist-get info :filter-plain-text)
(let ((transcoder (org-export-transcoder data info)))
(if transcoder (funcall transcoder data info) data))
info))
;; Secondary string.
((not type)
(mapconcat (lambda (obj) (org-export-data obj info)) data ""))
;; Element/Object without contents or, as a special
;; case, headline with archive tag and archived trees
;; restricted to title only.
((or (not (org-element-contents data))
(and (eq type 'headline)
(eq (plist-get info :with-archived-trees) 'headline)
(org-element-property :archivedp data)))
(let ((transcoder (org-export-transcoder data info)))
(and (functionp transcoder)
(if (eq type 'link)
(broken-link-handler
(funcall transcoder data nil info))
(funcall transcoder data nil info)))))
;; Element/Object with contents.
(t
(let ((transcoder (org-export-transcoder data info)))
(when transcoder
(let* ((greaterp (memq type org-element-greater-elements))
(objectp
(and (not greaterp)
(memq type org-element-recursive-objects)))
(contents
(mapconcat
(lambda (element) (org-export-data element info))
(org-element-contents
(if (or greaterp objectp) data
;; Elements directly containing
;; objects must have their indentation
;; normalized first.
(org-element-normalize-contents
data
;; When normalizing first paragraph
;; of an item or
;; a footnote-definition, ignore
;; first line's indentation.
(and
(eq type 'paragraph)
(org-element-type-p
parent '(footnote-definition item))
(eq (car (org-element-contents parent))
data)
(eq (org-element-property :pre-blank parent)
0)))))
"")))
(broken-link-handler
(funcall transcoder data
(if (not greaterp) contents
(org-element-normalize-string contents))
info)))))))))
;; Final result will be memoized before being returned.
(puthash
data
(cond
((not results) (or (org-export--keep-spaces data info) ""))
((memq type '(nil org-data plain-text raw)) results)
;; Append the same white space between elements or objects
;; as in the original buffer, and call appropriate filters.
(t
(org-export-filter-apply-functions
(plist-get info (intern (format ":filter-%s" type)))
(let ((blank (or (org-element-post-blank data) 0)))
(if (eq (org-element-class data parent) 'object)
(concat results (make-string blank ?\s))
(concat (org-element-normalize-string results)
(make-string blank ?\n))))
info)))
(plist-get info :exported-data))))))
(defun org-export-data-with-backend (data backend info)
"Convert DATA into BACKEND format.
DATA is an element, an object, a secondary string or a string.
BACKEND is a symbol. INFO is a plist used as a communication
channel.
Unlike to `org-export-with-backend', this function will
recursively convert DATA using BACKEND translation table."
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
;; Set-up a new communication channel with translations defined in
;; BACKEND as the translate table and a new hash table for
;; memoization.
(let ((new-info
(org-combine-plists
info
(list :back-end backend
:translate-alist (org-export-get-all-transcoders backend)
;; Size of the hash table is reduced since this
;; function will probably be used on small trees.
:exported-data (make-hash-table :test 'eq :size 401)))))
(prog1 (org-export-data data new-info)
;; Preserve `:internal-references', as those do not depend on
;; the backend used; we need to make sure that any new
;; reference when the temporary backend was active gets through
;; the default one.
(plist-put info :internal-references
(plist-get new-info :internal-references)))))
(defun org-export-expand (blob contents &optional with-affiliated)
"Expand a parsed element or object to its original state.
BLOB is either an element or an object. CONTENTS is its
contents, as a string or nil.
When optional argument WITH-AFFILIATED is non-nil, add affiliated
keywords before output."
(let ((type (org-element-type blob)))
(concat (and with-affiliated
(eq (org-element-class blob) 'element)
(org-element--interpret-affiliated-keywords blob))
(funcall (intern (format "org-element-%s-interpreter" type))
blob contents))))
\f
;;; The Filter System
;;
;; Filters allow end-users to tweak easily the transcoded output.
;; They are the functional counterpart of hooks, as every filter in
;; a set is applied to the return value of the previous one.
;;
;; Every set is backend agnostic. Although, a filter is always
;; called, in addition to the string it applies to, with the backend
;; used as argument, so it's easy for the end-user to add backend
;; specific filters in the set. The communication channel, as
;; a plist, is required as the third argument.
;;
;; From the developer side, filters sets can be installed in the
;; process with the help of `org-export-define-backend', which
;; internally stores filters as an alist. Each association has a key
;; among the following symbols and a function or a list of functions
;; as value.
;;
;; - `:filter-options' applies to the property list containing export
;; options. Unlike to other filters, functions in this list accept
;; two arguments instead of three: the property list containing
;; export options and the backend. Users can set its value through
;; `org-export-filter-options-functions' variable.
;;
;; - `:filter-parse-tree' applies directly to the complete parsed
;; tree. Users can set it through
;; `org-export-filter-parse-tree-functions' variable.
;;
;; - `:filter-body' applies to the body of the output, before template
;; translator chimes in. Users can set it through
;; `org-export-filter-body-functions' variable.
;;
;; - `:filter-final-output' applies to the final transcoded string.
;; Users can set it with `org-export-filter-final-output-functions'
;; variable.
;;
;; - `:filter-plain-text' applies to any string not recognized as Org
;; syntax. `org-export-filter-plain-text-functions' allows users to
;; configure it.
;;
;; - `:filter-TYPE' applies on the string returned after an element or
;; object of type TYPE has been transcoded. A user can modify
;; `org-export-filter-TYPE-functions' to install these filters.
;;
;; All filters sets are applied with
;; `org-export-filter-apply-functions' function. Filters in a set are
;; applied in a LIFO fashion. It allows developers to be sure that
;; their filters will be applied first.
;;
;; Filters properties are installed in communication channel with
;; `org-export-install-filters' function.
;;
;; Eventually, two hooks (`org-export-before-processing-hook' and
;; `org-export-before-parsing-hook') are run at the beginning of the
;; export process and just before parsing to allow for heavy structure
;; modifications.
;;;; Hooks
(defvar org-export-before-processing-functions nil
"Abnormal hook run at the beginning of the export process.
This is run before include keywords and macros are expanded and
Babel code blocks executed, on a copy of the original buffer
being exported. Visibility and narrowing are preserved. Point
is at the beginning of the buffer.
Every function in this hook will be called with one argument: the
backend currently used, as a symbol.")
(defvar org-export-before-parsing-functions nil
"Abnormal hook run before parsing an export buffer.
This is run after include keywords and macros have been expanded
and Babel code blocks executed, on a copy of the original buffer
being exported. Visibility and narrowing are preserved. Point
is at the beginning of the buffer.
Every function in this hook will be called with one argument: the
backend currently used, as a symbol.")
;;;; Special Filters
(defvar org-export-filter-options-functions nil
"List of functions applied to the export options.
Each filter is called with two arguments: the export options, as
a plist, and the backend, as a symbol. It must return
a property list containing export options.")
(defvar org-export-filter-parse-tree-functions nil
"List of functions applied to the parsed tree.
Each filter is called with three arguments: the parse tree, as
returned by `org-element-parse-buffer', the backend, as
a symbol, and the communication channel, as a plist. It must
return the modified parse tree to transcode.")
(defvar org-export-filter-plain-text-functions nil
"List of functions applied to plain text.
Each filter is called with three arguments: a string which
contains no Org syntax, the backend, as a symbol, and the
communication channel, as a plist. It must return a string or
nil.")
(defvar org-export-filter-body-functions nil
"List of functions applied to transcoded body.
Each filter is called with three arguments: a string which
contains no Org syntax, the backend, as a symbol, and the
communication channel, as a plist. It must return a string or
nil.")
(defvar org-export-filter-final-output-functions nil
"List of functions applied to the transcoded string.
Each filter is called with three arguments: the full transcoded
string, the backend, as a symbol, and the communication channel,
as a plist. It must return a string that will be used as the
final export output.")
;;;; Elements Filters
(defvar org-export-filter-babel-call-functions nil
"List of functions applied to a transcoded babel-call.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-center-block-functions nil
"List of functions applied to a transcoded center block.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-clock-functions nil
"List of functions applied to a transcoded clock.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-diary-sexp-functions nil
"List of functions applied to a transcoded diary-sexp.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-drawer-functions nil
"List of functions applied to a transcoded drawer.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-dynamic-block-functions nil
"List of functions applied to a transcoded dynamic-block.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-example-block-functions nil
"List of functions applied to a transcoded example-block.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-export-block-functions nil
"List of functions applied to a transcoded export-block.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-fixed-width-functions nil
"List of functions applied to a transcoded fixed-width.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-footnote-definition-functions nil
"List of functions applied to a transcoded footnote-definition.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-headline-functions nil
"List of functions applied to a transcoded headline.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-horizontal-rule-functions nil
"List of functions applied to a transcoded horizontal-rule.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-inlinetask-functions nil
"List of functions applied to a transcoded inlinetask.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-item-functions nil
"List of functions applied to a transcoded item.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-keyword-functions nil
"List of functions applied to a transcoded keyword.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-latex-environment-functions nil
"List of functions applied to a transcoded latex-environment.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-node-property-functions nil
"List of functions applied to a transcoded node-property.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-paragraph-functions nil
"List of functions applied to a transcoded paragraph.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-plain-list-functions nil
"List of functions applied to a transcoded plain-list.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-planning-functions nil
"List of functions applied to a transcoded planning.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-property-drawer-functions nil
"List of functions applied to a transcoded property-drawer.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-quote-block-functions nil
"List of functions applied to a transcoded quote block.
Each filter is called with three arguments: the transcoded quote
data, as a string, the backend, as a symbol, and the
communication channel, as a plist. It must return a string or
nil.")
(defvar org-export-filter-section-functions nil
"List of functions applied to a transcoded section.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-special-block-functions nil
"List of functions applied to a transcoded special block.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-src-block-functions nil
"List of functions applied to a transcoded src-block.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-table-functions nil
"List of functions applied to a transcoded table.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-table-cell-functions nil
"List of functions applied to a transcoded table-cell.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-table-row-functions nil
"List of functions applied to a transcoded table-row.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-verse-block-functions nil
"List of functions applied to a transcoded verse block.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
;;;; Objects Filters
(defvar org-export-filter-bold-functions nil
"List of functions applied to transcoded bold text.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-code-functions nil
"List of functions applied to transcoded code text.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-entity-functions nil
"List of functions applied to a transcoded entity.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-export-snippet-functions nil
"List of functions applied to a transcoded export-snippet.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-footnote-reference-functions nil
"List of functions applied to a transcoded footnote-reference.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-inline-babel-call-functions nil
"List of functions applied to a transcoded inline-babel-call.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-inline-src-block-functions nil
"List of functions applied to a transcoded inline-src-block.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-italic-functions nil
"List of functions applied to transcoded italic text.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-latex-fragment-functions nil
"List of functions applied to a transcoded latex-fragment.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-line-break-functions nil
"List of functions applied to a transcoded line-break.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-link-functions nil
"List of functions applied to a transcoded link.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-radio-target-functions nil
"List of functions applied to a transcoded radio-target.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-statistics-cookie-functions nil
"List of functions applied to a transcoded statistics-cookie.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-strike-through-functions nil
"List of functions applied to transcoded strike-through text.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-subscript-functions nil
"List of functions applied to a transcoded subscript.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-superscript-functions nil
"List of functions applied to a transcoded superscript.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-target-functions nil
"List of functions applied to a transcoded target.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-timestamp-functions nil
"List of functions applied to a transcoded timestamp.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-underline-functions nil
"List of functions applied to transcoded underline text.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
(defvar org-export-filter-verbatim-functions nil
"List of functions applied to transcoded verbatim text.
Each filter is called with three arguments: the transcoded data,
as a string, the backend, as a symbol, and the communication
channel, as a plist. It must return a string or nil.")
;;;; Filters Tools
;;
;; Internal function `org-export-install-filters' installs filters
;; hard-coded in backends (developer filters) and filters from global
;; variables (user filters) in the communication channel.
;;
;; Internal function `org-export-filter-apply-functions' takes care
;; about applying each filter in order to a given data. It ignores
;; filters returning a nil value but stops whenever a filter returns
;; an empty string.
(defun org-export-filter-apply-functions (filters value info)
"Call every function in FILTERS.
Functions are called with three arguments: a value, the export
backend name and the communication channel. First function in
FILTERS is called with VALUE as its first argument. Second
function in FILTERS is called with the previous result as its
value, etc.
Functions returning nil are skipped. Any function returning the
empty string ends the process, which returns the empty string.
Call is done in a LIFO fashion, to be sure that developer
specified filters, if any, are called first."
(catch :exit
(let* ((backend (plist-get info :back-end))
(backend-name (and backend (org-export-backend-name backend))))
(dolist (filter filters value)
(let ((result (funcall filter value backend-name info)))
(cond ((not result))
((equal result "") (throw :exit ""))
(t (setq value result))))))))
(defun org-export-install-filters (info)
"Install filters properties in communication channel.
INFO is a plist containing the current communication channel.
Return the updated communication channel."
(let (plist)
;; Install user-defined filters with `org-export-filters-alist'
;; and filters already in INFO (through ext-plist mechanism).
(dolist (p org-export-filters-alist)
(let* ((prop (car p))
(info-value (plist-get info prop))
(default-value (symbol-value (cdr p))))
(setq plist
(plist-put plist prop
;; Filters in INFO will be called
;; before those user provided.
(append (if (listp info-value) info-value
(list info-value))
default-value)))))
;; Prepend backend specific filters to that list.
(dolist (p (org-export-get-all-filters (plist-get info :back-end)))
;; Single values get consed, lists are appended.
(let ((key (car p)) (value (cdr p)))
(when value
(setq plist
(plist-put
plist key
(if (atom value) (cons value (plist-get plist key))
(append value (plist-get plist key))))))))
;; Return new communication channel.
(org-combine-plists info plist)))
\f
;;; Core functions
;;
;; This is the room for the main function, `org-export-as', along with
;; its derivative, `org-export-string-as'.
;; `org-export--copy-to-kill-ring-p' determines if output of these
;; function should be added to kill ring.
;;
;; Note that `org-export-as' doesn't really parse the current buffer,
;; but a copy of it (with the same buffer-local variables and
;; visibility), where macros and include keywords are expanded and
;; Babel blocks are executed, if appropriate.
;; `org-export-with-buffer-copy' macro prepares that copy.
;;
;; File inclusion is taken care of by
;; `org-export-expand-include-keyword' and
;; `org-export--prepare-file-contents'. Structure wise, including
;; a whole Org file in a buffer often makes little sense. For
;; example, if the file contains a headline and the include keyword
;; was within an item, the item should contain the headline. That's
;; why file inclusion should be done before any structure can be
;; associated to the file, that is before parsing.
;;
;; `org-export-insert-default-template' is a command to insert
;; a default template (or a backend specific template) at point or in
;; current subtree.
(defun org-export--set-variables (variable-alist)
"Set buffer-local variables according to VARIABLE-ALIST in current buffer."
(pcase-dolist (`(,var . ,val) variable-alist)
(set (make-local-variable var) val)))
(cl-defun org-export-copy-buffer (&key to-buffer drop-visibility
drop-narrowing drop-contents
drop-locals)
"Return a copy of the current buffer.
This function calls `org-element-copy-buffer', passing the same
arguments TO-BUFFER, DROP-VISIBILITY, DROP-NARROWING, DROP-CONTENTS,
and DROP-LOCALS.
In addition, buffer-local variables are set according to #+BIND:
keywords."
(let ((new-buf (org-element-copy-buffer
:to-buffer to-buffer
:drop-visibility drop-visibility
:drop-narrowing drop-narrowing
:drop-contents drop-contents
:drop-locals drop-locals)))
(let ((bind-variables (org-export--list-bound-variables)))
(with-current-buffer new-buf
(org-export--set-variables bind-variables)))
new-buf))
(cl-defmacro org-export-with-buffer-copy ( &rest body
&key to-buffer drop-visibility
drop-narrowing drop-contents
drop-locals
&allow-other-keys)
"Apply BODY in a copy of the current buffer.
This macro is like `org-element-with-buffer-copy', passing the same
arguments BODY, TO-BUFFER, DROP-VISIBILITY, DROP-NARROWING,
DROP-CONTENTS, and DROP-LOCALS.
In addition, buffer-local variables are set according to #+BIND:
keywords."
(declare (debug t))
;; Drop keyword arguments from BODY.
(while (keywordp (car body)) (pop body) (pop body))
(org-with-gensyms (bind-variables)
`(let ((,bind-variables (org-export--list-bound-variables)))
(org-element-with-buffer-copy
:to-buffer ,to-buffer
:drop-visibility ,drop-visibility
:drop-narrowing ,drop-narrowing
:drop-contents ,drop-contents
:drop-locals ,drop-locals
(org-export--set-variables ,bind-variables)
,@body))))
(defun org-export--delete-comment-trees ()
"Delete commented trees and commented inlinetasks in the buffer.
Narrowing, if any, is ignored."
(org-with-wide-buffer
(goto-char (point-min))
(let* ((case-fold-search t)
(regexp (concat org-outline-regexp-bol ".*" org-comment-string)))
(while (re-search-forward regexp nil t)
(let ((element (org-element-at-point)))
(when (org-element-property :commentedp element)
(delete-region (org-element-begin element)
(org-element-end element))))))))
(defun org-export--prune-tree (data info)
"Prune non exportable elements from DATA.
DATA is the parse tree to traverse. INFO is the plist holding
export info. Also set `:ignore-list' in INFO to a list of
objects which should be ignored during export, but not removed
from tree."
(letrec ((ignore nil)
;; First find trees containing a select tag, if any.
(selected (org-export--selected-trees data info))
;; List tags that prevent export of headlines.
(excluded (cl-mapcan (lambda (tag) (org-tags-expand tag t))
(plist-get info :exclude-tags)))
(walk-data
(lambda (data)
;; Prune non-exportable elements and objects from tree.
;; As a special case, special rows and cells from tables
;; are stored in IGNORE, as they still need to be
;; accessed during export.
(when data
(let ((type (org-element-type data)))
(if (org-export--skip-p data info selected excluded)
(if (memq type '(table-cell table-row)) (push data ignore)
(if-let ((keep-spaces (org-export--keep-spaces data info)))
;; Keep spaces in place of removed
;; element, if necessary.
;; Example: "Foo.[10%] Bar" would become
;; "Foo.Bar" if we do not keep spaces.
(org-element-set data keep-spaces)
(org-element-extract data)))
(if (and (eq type 'headline)
(eq (plist-get info :with-archived-trees)
'headline)
(org-element-property :archivedp data))
;; If headline is archived but tree below has
;; to be skipped, remove contents.
(org-element-set-contents data)
;; Move into recursive objects/elements.
(mapc walk-data (org-element-contents data)))
;; Move into secondary string, if any.
(dolist (p (cdr (assq type
org-element-secondary-value-alist)))
(mapc walk-data (org-element-property p data))))))))
(definitions
;; Collect definitions before possibly pruning them so as
;; to avoid parsing them again if they are required.
(org-element-map data '(footnote-definition footnote-reference)
(lambda (f)
(cond
((org-element-type-p f 'footnote-definition) f)
((and (eq 'inline (org-element-property :type f))
(org-element-property :label f))
f)
(t nil))))))
;; If a select tag is active, also ignore the section before the
;; first headline, if any.
(when selected
(let ((first-element (car (org-element-contents data))))
(when (org-element-type-p first-element 'section)
(org-element-extract first-element))))
;; Prune tree and communication channel.
(funcall walk-data data)
(dolist (entry (append
;; Priority is given to backend specific options.
(org-export-get-all-options (plist-get info :back-end))
org-export-options-alist))
(when (eq (nth 4 entry) 'parse)
(funcall walk-data (plist-get info (car entry)))))
(let ((missing (org-export--missing-definitions data definitions)))
(funcall walk-data missing)
(org-export--install-footnote-definitions missing data))
;; Eventually set `:ignore-list'.
(plist-put info :ignore-list ignore)))
(defun org-export--missing-definitions (tree definitions)
"List footnote definitions missing from TREE.
Missing definitions are searched within DEFINITIONS, which is
a list of footnote definitions or in the widened buffer."
(let* ((list-labels
(lambda (data)
;; List all footnote labels encountered in DATA. Inline
;; footnote references are ignored.
(org-element-map data 'footnote-reference
(lambda (reference)
(and (eq (org-element-property :type reference) 'standard)
(org-element-property :label reference))))))
defined undefined missing-definitions)
;; Partition DIRECT-REFERENCES between DEFINED and UNDEFINED
;; references.
(let ((known-definitions
(org-element-map tree '(footnote-reference footnote-definition)
(lambda (f)
(and (or (org-element-type-p f 'footnote-definition)
(eq (org-element-property :type f) 'inline))
(org-element-property :label f)))))
) ;; seen
(dolist (l (funcall list-labels tree))
(cond ;; ((member l seen))
((member l known-definitions) (push l defined))
(t (push l undefined)))))
;; Complete MISSING-DEFINITIONS by finding the definition of every
;; undefined label, first by looking into DEFINITIONS, then by
;; searching the widened buffer. This is a recursive process
;; since definitions found can themselves contain an undefined
;; reference.
(while undefined
(let* ((label (pop undefined))
(definition
(cond
((cl-some
(lambda (d) (and (equal (org-element-property :label d) label)
d))
definitions))
((pcase (org-footnote-get-definition label)
(`(,_ ,beg . ,_)
(org-with-wide-buffer
(goto-char beg)
(let ((datum (org-element-context)))
(if (org-element-type-p datum 'footnote-reference)
datum
;; Parse definition with contents.
(save-restriction
(narrow-to-region
(org-element-begin datum)
(org-element-end datum))
(org-element-map (org-element-parse-buffer nil nil 'defer)
'footnote-definition #'identity nil t))))))
(_ nil)))
(t (user-error "Definition not found for footnote %s" label)))))
(push label defined)
(push definition missing-definitions)
;; Look for footnote references within DEFINITION, since
;; we may need to also find their definition.
(dolist (l (funcall list-labels definition))
(unless (or (member l defined) ;Known label
(member l undefined)) ;Processed later
(push l undefined)))))
;; MISSING-DEFINITIONS may contain footnote references with inline
;; definitions. Make sure those are changed into real footnote
;; definitions.
(mapcar (lambda (d)
(if (org-element-type-p d 'footnote-definition) d
(let ((label (org-element-property :label d)))
(apply #'org-element-create
'footnote-definition `(:label ,label :post-blank 1)
(org-element-contents d)))))
missing-definitions)))
(defun org-export--install-footnote-definitions (definitions tree)
"Install footnote definitions in tree.
DEFINITIONS is the list of footnote definitions to install. TREE
is the parse tree.
If there is a footnote section in TREE, definitions found are
appended to it. If `org-footnote-section' is non-nil, a new
footnote section containing all definitions is inserted in TREE.
Otherwise, definitions are appended at the end of the section
containing their first reference."
(cond
((null definitions))
;; If there is a footnote section, insert definitions there.
((let ((footnote-section
(org-element-map tree 'headline
(lambda (h) (and (org-element-property :footnote-section-p h) h))
nil t)))
(and footnote-section
(apply #'org-element-adopt
footnote-section
(nreverse definitions)))))
;; If there should be a footnote section, create one containing all
;; the definitions at the end of the tree.
(org-footnote-section
(org-element-adopt
tree
(org-element-create 'headline
(list :footnote-section-p t
:level 1
:title org-footnote-section
:raw-value org-footnote-section)
(apply #'org-element-create
'section
nil
(nreverse definitions)))))
;; Otherwise add each definition at the end of the section where it
;; is first referenced.
(t
(letrec ((seen nil)
(insert-definitions
(lambda (data)
;; Insert footnote definitions in the same section as
;; their first reference in DATA.
(org-element-map data 'footnote-reference
(lambda (reference)
(when (eq (org-element-property :type reference) 'standard)
(let ((label (org-element-property :label reference)))
(unless (member label seen)
(push label seen)
(let ((definition
(cl-some
(lambda (d)
(and (equal (org-element-property :label d)
label)
d))
definitions)))
(org-element-adopt
(org-element-lineage reference 'section)
definition)
;; Also insert definitions for nested
;; references, if any.
(funcall insert-definitions definition))))))))))
(funcall insert-definitions tree)))))
(defun org-export--remove-uninterpreted-data (data info)
"Change uninterpreted elements back into Org syntax.
DATA is a parse tree or a secondary string. INFO is a plist
containing export options. It is modified by side effect and
returned by the function."
(org-element-map data
'(entity bold italic latex-environment latex-fragment strike-through
subscript superscript underline)
(lambda (datum)
(let* ((type (org-element-type datum))
(post-blank
(pcase (org-element-post-blank datum)
(`nil nil)
(n (make-string n (if (eq type 'latex-environment) ?\n ?\s)))))
(new
(cl-case type
;; ... entities...
(entity
(and (not (plist-get info :with-entities))
(list (concat (org-export-expand datum nil)
post-blank))))
;; ... emphasis...
((bold italic strike-through underline)
(and (not (plist-get info :with-emphasize))
(let ((marker (cl-case type
(bold "*")
(italic "/")
(strike-through "+")
(underline "_"))))
(append
(list marker)
(org-element-contents datum)
(list (concat marker post-blank))))))
;; ... LaTeX environments and fragments...
((latex-environment latex-fragment)
(and (eq (plist-get info :with-latex) 'verbatim)
(list (concat (org-export-expand datum nil)
post-blank))))
;; ... sub/superscripts...
((subscript superscript)
(let ((sub/super-p (plist-get info :with-sub-superscript))
(bracketp (org-element-property :use-brackets-p datum)))
(and (or (not sub/super-p)
(and (eq sub/super-p '{}) (not bracketp)))
(append
(list (concat (if (eq type 'subscript) "_" "^")
(and bracketp "{")))
(org-element-contents datum)
(list (concat (and bracketp "}")
post-blank)))))))))
(when new
;; Splice NEW at DATUM location in parse tree.
(dolist (e new (org-element-extract datum))
(unless (equal e "") (org-element-insert-before e datum))))))
info nil nil t)
;; Return modified parse tree.
data)
(defun org-export--expand-links (tree info)
"Modify TREE, expanding link paths according to `:expand-links' in INFO."
(when (plist-get info :expand-links)
(org-element-map tree 'link
(lambda (link)
(when (equal "file" (org-element-property :type link))
(org-element-put-property
link :path
(substitute-env-in-file-name
(org-element-property :path link)))))
info nil nil 'with-affiliated)))
;;;###autoload
(defun org-export-as
(backend &optional subtreep visible-only body-only ext-plist)
"Transcode current Org buffer into BACKEND code.
See info node `(org)Advanced Export Configuration' for the details of
the transcoding process.
BACKEND is either an export backend, as returned by, e.g.,
`org-export-create-backend', or a symbol referring to
a registered backend.
If narrowing is active in the current buffer, only transcode its
narrowed part.
If a region is active, transcode that region.
When optional argument SUBTREEP is non-nil, transcode the
sub-tree at point, extracting information from the headline
properties first.
When optional argument VISIBLE-ONLY is non-nil, don't export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only return body
code, without surrounding template.
Optional argument EXT-PLIST, when provided, is a property list
with external parameters overriding Org default settings, but
still inferior to file-local settings.
Return code as a string."
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
(org-export-barf-if-invalid-backend backend)
(org-fold-core-ignore-modifications
(save-excursion
(save-restriction
;; Narrow buffer to an appropriate region or subtree for
;; parsing. If parsing subtree, be sure to remove main
;; headline, planning data and property drawer.
(cond ((org-region-active-p)
(narrow-to-region (region-beginning) (region-end)))
(subtreep
(org-narrow-to-subtree)
(goto-char (point-min))
(org-end-of-meta-data)
;; Make the region include top heading in the subtree.
;; This way, we will be able to retrieve its export
;; options when calling
;; `org-export--get-subtree-options'.
(when (bolp) (backward-char))
(narrow-to-region (point) (point-max))))
;; Initialize communication channel with original buffer
;; attributes, unavailable in its copy.
(let* ((org-export-current-backend (org-export-backend-name backend))
(info (org-combine-plists
(org-export--get-export-attributes
backend subtreep visible-only body-only)
(org-export--get-buffer-attributes))))
;; Update communication channel and get parse tree. Buffer
;; isn't parsed directly. Instead, all buffer modifications
;; and consequent parsing are undertaken in a temporary copy.
(org-export-with-buffer-copy
(font-lock-mode -1)
(setq info (org-export--annotate-info
backend info subtreep visible-only ext-plist))
;; Eventually transcode TREE. Wrap the resulting string into
;; a template.
(let* ((body (org-element-normalize-string
(or (org-export-data (plist-get info :parse-tree) info)
"")))
(inner-template (cdr (assq 'inner-template
(plist-get info :translate-alist))))
(full-body (org-export-filter-apply-functions
(plist-get info :filter-body)
(if (not (functionp inner-template)) body
(funcall inner-template body info))
info))
(template (cdr (assq 'template
(plist-get info :translate-alist))))
(output
(if (or (not (functionp template)) body-only) full-body
(funcall template full-body info))))
;; Call citation export finalizer.
(when (plist-get info :with-cite-processors)
(setq output (org-cite-finalize-export output info)))
;; Remove all text properties since they cannot be
;; retrieved from an external process. Finally call
;; final-output filter and return result.
(org-no-properties
(org-export-filter-apply-functions
(plist-get info :filter-final-output)
output info)))))))))
(defun org-export--annotate-info (backend info &optional subtreep visible-only ext-plist)
"Annotate the INFO plist according to the BACKEND.
This is run in the context of the current buffer.
When optional argument SUBTREEP is non-nil, transcode the
sub-tree at point, extracting information from the headline
properties first.
When optional argument VISIBLE-ONLY is non-nil, don't process the
contents of hidden elements.
Optional argument EXT-PLIST, when provided, is a property list
with external parameters overriding Org default settings, but
still inferior to file-local settings."
(let ((parsed-keywords
(delq nil
(mapcar (lambda (o) (and (eq (nth 4 o) 'parse) (nth 1 o)))
(append (org-export-get-all-options backend)
org-export-options-alist))))
tree modified-tick)
;; Run first hook with current backend's name as argument.
(run-hook-with-args 'org-export-before-processing-hook
(org-export-backend-name backend))
(org-export-expand-include-keyword nil nil nil nil (plist-get info :expand-links))
(org-export--delete-comment-trees)
(org-macro-initialize-templates org-export-global-macros)
(org-macro-replace-all org-macro-templates parsed-keywords)
;; Refresh buffer properties and radio targets after previous
;; potentially invasive changes.
(org-set-regexps-and-options)
(org-update-radio-target-regexp)
(setq modified-tick (buffer-chars-modified-tick))
;; Possibly execute Babel code. Re-run a macro expansion
;; specifically for {{{results}}} since inline source blocks
;; may have generated some more. Refresh buffer properties
;; and radio targets another time.
(when org-export-use-babel
(org-babel-exp-process-buffer)
(org-macro-replace-all '(("results" . "$1")) parsed-keywords)
(unless (eq modified-tick (buffer-chars-modified-tick))
(org-set-regexps-and-options)
(org-update-radio-target-regexp))
(setq modified-tick (buffer-chars-modified-tick)))
;; Run last hook with current backend's name as argument.
;; Update buffer properties and radio targets one last time
;; before parsing.
(goto-char (point-min))
(save-excursion
(run-hook-with-args 'org-export-before-parsing-hook
(org-export-backend-name backend)))
(unless (eq modified-tick (buffer-chars-modified-tick))
(org-set-regexps-and-options)
(org-update-radio-target-regexp))
(setq modified-tick (buffer-chars-modified-tick))
;; Update communication channel with environment.
(setq info
(org-combine-plists
info (org-export-get-environment backend subtreep ext-plist)))
;; Pre-process citations environment, i.e. install
;; bibliography list, and citation processor in INFO.
(when (plist-get info :with-cite-processors)
(org-cite-store-bibliography info)
(org-cite-store-export-processor info))
;; De-activate uninterpreted data from parsed keywords.
(dolist (entry (append (org-export-get-all-options backend)
org-export-options-alist))
(pcase entry
(`(,p ,_ ,_ ,_ parse)
(let ((value (plist-get info p)))
(plist-put info
p
(org-export--remove-uninterpreted-data value info))))
(_ nil)))
;; Install user's and developer's filters.
(setq info (org-export-install-filters info))
;; Call options filters and update export options. We do not
;; use `org-export-filter-apply-functions' here since the
;; arity of such filters is different.
(let ((backend-name (org-export-backend-name backend)))
(dolist (filter (plist-get info :filter-options))
(let ((result (funcall filter info backend-name)))
(when result (setq info result)))))
;; Parse buffer.
(setq tree (org-element-parse-buffer nil visible-only 'defer))
;; Prune tree from non-exported elements and transform
;; uninterpreted elements or objects in both parse tree and
;; communication channel.
(org-export--prune-tree tree info)
(org-export--remove-uninterpreted-data tree info)
;; Expand environment variables in link paths.
(org-export--expand-links tree info)
;; Call parse tree filters.
(setq tree
(org-export-filter-apply-functions
(plist-get info :filter-parse-tree) tree info))
;; Now tree is complete, compute its properties and add them
;; to communication channel. This is responsible for setting
;; :parse-tree to TREE.
(setq info (org-export--collect-tree-properties tree info))
;; Process citations and bibliography. Replace each citation
;; and "print_bibliography" keyword in the parse tree with
;; the output of the selected citation export processor.
(when (plist-get info :with-cite-processors)
(org-cite-process-citations info)
(org-cite-process-bibliography info))
info))
;;;###autoload
(defun org-export-string-as (string backend &optional body-only ext-plist)
"Transcode STRING into BACKEND code.
BACKEND is either an export backend, as returned by, e.g.,
`org-export-create-backend', or a symbol referring to
a registered backend.
When optional argument BODY-ONLY is non-nil, only return body
code, without preamble nor postamble.
Optional argument EXT-PLIST, when provided, is a property list
with external parameters overriding Org default settings, but
still inferior to file-local settings.
Return code as a string."
(with-temp-buffer
(insert string)
(let ((org-inhibit-startup t)) (org-mode))
(org-export-as backend nil nil body-only ext-plist)))
;;;###autoload
(defun org-export-replace-region-by (backend)
"Replace the active region by its export to BACKEND.
BACKEND is either an export backend, as returned by, e.g.,
`org-export-create-backend', or a symbol referring to
a registered backend."
(unless (org-region-active-p) (user-error "No active region to replace"))
(insert
(org-export-string-as
(delete-and-extract-region (region-beginning) (region-end)) backend t)))
;;;###autoload
(defun org-export-insert-default-template (&optional backend subtreep)
"Insert all export keywords with default values at beginning of line.
BACKEND is a symbol referring to the name of a registered export
backend, for which specific export options should be added to
the template, or `default' for default template. When it is nil,
the user will be prompted for a category.
If SUBTREEP is non-nil, export configuration will be set up
locally for the subtree through node properties."
(interactive)
(unless (derived-mode-p 'org-mode) (user-error "Not in an Org mode buffer"))
(when (and subtreep (org-before-first-heading-p))
(user-error "No subtree to set export options for"))
(let ((node (and subtreep (save-excursion (org-back-to-heading t) (point))))
(backend
(or backend
(intern
(org-completing-read
"Options category: "
(cons "default"
(mapcar (lambda (b)
(symbol-name (org-export-backend-name b)))
org-export-registered-backends))
nil t))))
options keywords)
;; Populate OPTIONS and KEYWORDS.
(dolist (entry (cond ((eq backend 'default) org-export-options-alist)
((org-export-backend-p backend)
(org-export-backend-options backend))
(t (org-export-backend-options
(org-export-get-backend backend)))))
(let ((keyword (nth 1 entry))
(option (nth 2 entry)))
(cond
(keyword (unless (assoc keyword keywords)
(let ((value
(if (eq (nth 4 entry) 'split)
(mapconcat #'identity (eval (nth 3 entry) t) " ")
(eval (nth 3 entry) t))))
(push (cons keyword value) keywords))))
(option (unless (assoc option options)
(push (cons option (eval (nth 3 entry) t)) options))))))
;; Move to an appropriate location in order to insert options.
(unless subtreep (forward-line 0))
;; First (multiple) OPTIONS lines. Never go past fill-column.
(when options
(let ((items
(mapcar
(lambda (opt) (format "%s:%S" (car opt) (cdr opt)))
(sort options (lambda (k1 k2) (string< (car k1) (car k2)))))))
(if subtreep
(org-entry-put
node "EXPORT_OPTIONS" (mapconcat #'identity items " "))
(while items
(insert "#+options:")
(let ((width 10))
(while (and items
(< (+ width (length (car items)) 1) fill-column))
(let ((item (pop items)))
(insert " " item)
(cl-incf width (1+ (length item))))))
(insert "\n")))))
;; Then the rest of keywords, in the order specified in either
;; `org-export-options-alist' or respective export backends.
(dolist (key (nreverse keywords))
(let ((val (cond ((equal (car key) "DATE")
(or (cdr key)
(with-temp-buffer
(org-insert-timestamp nil))))
((equal (car key) "TITLE")
(or (let ((visited-file
(buffer-file-name (buffer-base-buffer))))
(and visited-file
(file-name-sans-extension
(file-name-nondirectory visited-file))))
(buffer-name (buffer-base-buffer))))
(t (cdr key)))))
(if subtreep (org-entry-put node (concat "EXPORT_" (car key)) val)
(insert
(format "#+%s:%s\n"
(downcase (car key))
(if (org-string-nw-p val) (format " %s" val) ""))))))))
(defun org-export-expand-include-keyword (&optional included dir footnotes includer-file expand-env)
"Expand every include keyword in buffer.
Optional argument INCLUDED is a list of included file names along
with their line restriction, when appropriate. It is used to
avoid infinite recursion.
Optional argument DIR is the current working directory. It is used to
properly resolve relative paths.
Optional argument FOOTNOTES is a hash-table used for
storing and resolving footnotes. It is created automatically.
Optional argument INCLUDER-FILE is the file path corresponding to the
buffer contents being included. It is used when current buffer does
not have `buffer-file-name' assigned.
When optional argument EXPAND-ENV is non-nil, expand environment
variables in include file names."
(let ((includer-file (or includer-file
(buffer-file-name (buffer-base-buffer))))
(case-fold-search t)
(file-prefix (make-hash-table :test #'equal))
(footnotes (or footnotes (make-hash-table :test #'equal)))
(include-re "^[ \t]*#\\+INCLUDE:"))
;; If :minlevel is not set the text-property
;; `:org-include-induced-level' will be used to determine the
;; relative level when expanding INCLUDE.
;; Only affects included Org documents.
(goto-char (point-min))
(while (re-search-forward include-re nil t)
(put-text-property (line-beginning-position) (line-end-position)
:org-include-induced-level
(1+ (org-reduced-level (or (org-current-level) 0)))))
;; Expand INCLUDE keywords.
(goto-char (point-min))
(while (re-search-forward include-re nil t)
(unless (org-in-commented-heading-p)
(let ((element (org-element-at-point)))
(when (org-element-type-p element 'keyword)
(forward-line 0)
;; Extract arguments from keyword's value.
(let* ((value (org-element-property :value element))
(parameters (org-export-parse-include-value value dir))
(file (if expand-env
(substitute-env-in-file-name
(plist-get parameters :file))
(plist-get parameters :file))))
;; Remove keyword.
(delete-region (point) (line-beginning-position 2))
(cond
((not file)) ; Do nothing.
((and (not (org-url-p file))
(not (file-readable-p file)))
(error "Cannot include file %s" file))
;; Check if files has already been parsed. Look after
;; inclusion lines too, as different parts of the same
;; file can be included too.
((member (list file (plist-get parameters :lines)) included)
(error "Recursive file inclusion: %s" file))
(t
(org-export--blindly-expand-include
parameters
:includer-file includer-file
:file-prefix file-prefix
:footnotes footnotes
:already-included included
:expand-env expand-env)
;; Expand footnotes after all files have been
;; included. Footnotes are stored at end of buffer.
(unless included
(org-with-wide-buffer
(goto-char (point-max))
(maphash (lambda (k v)
(insert (format "\n[fn:%s] %s\n" k v)))
footnotes))))))))))))
(defun org-export-parse-include-value (value &optional dir)
"Extract the various parameters from #+include: VALUE.
More specifically, this extracts the following parameters to a
plist: :file, :coding-system, :location, :only-contents, :lines,
:env, :minlevel, :args, and :block.
The :file parameter is expanded relative to DIR.
The :file, :block, and :args parameters are extracted
positionally, while the remaining parameters are extracted as
plist-style keywords.
Any remaining unmatched content is passed through
`org-babel-parse-header-arguments' (without evaluation) and
provided as the :unmatched parameter."
(let* (location
(coding-system
(and (string-match ":coding +\\(\\S-+\\)>" value)
(prog1 (intern (match-string 1 value))
(setq value (replace-match "" nil nil value)))))
(file
(and (string-match "^\\(\".+?\"\\|\\S-+\\)\\(?:\\s-+\\|$\\)" value)
(let ((matched (match-string 1 value)) stripped)
(setq value (replace-match "" nil nil value))
(when (string-match "\\(::\\(.*?\\)\\)\"?\\'"
matched)
(setq location (match-string 2 matched))
(setq matched
(replace-match "" nil nil matched 1)))
(setq stripped (org-strip-quotes matched))
(if (org-url-p stripped)
stripped
(expand-file-name stripped dir)))))
(only-contents
(and (string-match ":only-contents *\\([^: \r\t\n]\\S-*\\)?"
value)
(prog1 (org-not-nil (match-string 1 value))
(setq value (replace-match "" nil nil value)))))
(lines
(and (string-match
":lines +\"\\([0-9]*-[0-9]*\\)\""
value)
(prog1 (match-string 1 value)
(setq value (replace-match "" nil nil value)))))
(env (cond
((string-match "\\<example\\>" value) 'literal)
((string-match "\\<export\\(?: +\\(.*\\)\\)?" value)
'literal)
((string-match "\\<src\\(?: +\\(.*\\)\\)?" value)
'literal)))
;; Minimal level of included file defaults to the
;; child level of the current headline, if any, or
;; one. It only applies is the file is meant to be
;; included as an Org one.
(minlevel
(and (not env)
(if (string-match ":minlevel +\\([0-9]+\\)" value)
(prog1 (string-to-number (match-string 1 value))
(setq value (replace-match "" nil nil value)))
(get-text-property (point)
:org-include-induced-level))))
(args (and (eq env 'literal)
(prog1 (match-string 1 value)
(when (match-string 1 value)
(setq value (replace-match "" nil nil value 1))))))
(block (and (or (string-match "\"\\(\\S-+\\)\"" value)
(string-match "\\<\\(\\S-+\\)\\>" value))
(or (= (match-beginning 0) 0)
(not (= ?: (aref value (1- (match-beginning 0))))))
(prog1 (match-string 1 value)
(setq value (replace-match "" nil nil value))))))
(list :file file
:coding-system coding-system
:location location
:only-contents only-contents
:lines lines
:env env
:minlevel minlevel
:args args
:block block
:unmatched (org-babel-parse-header-arguments value t))))
(cl-defun org-export--blindly-expand-include
(parameters
&key includer-file file-prefix footnotes already-included expand-env)
"Unconditionally include reference defined by PARAMETERS in the buffer.
PARAMETERS is a plist of the form returned by `org-export-parse-include-value'.
INCLUDER-FILE is a path to the file where the include keyword is
being expanded. FILE-PREFIX is a hash-table of file and
prefixes, which can be provided to ensure consistent prefixing.
FOOTNOTES is a hash-table for storing and resolving footnotes,
which when provided allows footnotes to be handled appropriately.
ALREADY-INCLUDED is a list of included names along with their
line restriction which prevents recursion. EXPAND-ENV is a flag to
expand environment variables for #+INCLUDE keywords in the included
file."
(let* ((coding-system-for-read
(or (plist-get parameters :coding-system)
coding-system-for-read))
(file (plist-get parameters :file))
(lines (plist-get parameters :lines))
(args (plist-get parameters :args))
(block (plist-get parameters :block))
(ind (org-current-text-indentation)))
(cond
((eq (plist-get parameters :env) 'literal)
(insert
(let ((ind-str (make-string ind ?\s))
(arg-str (if (stringp args) (format " %s" args) ""))
(contents
(org-escape-code-in-string
(org-export--prepare-file-contents file lines))))
(format "%s#+BEGIN_%s%s\n%s%s#+END_%s\n"
ind-str block arg-str contents ind-str block))))
((stringp block)
(insert
(let ((ind-str (make-string ind ?\s))
(contents
(org-export--prepare-file-contents file lines)))
(format "%s#+BEGIN_%s\n%s%s#+END_%s\n"
ind-str block contents ind-str block))))
(t
(insert
(with-temp-buffer
(let ((org-inhibit-startup t)
(lines
(if-let ((location (plist-get parameters :location)))
(org-export--inclusion-absolute-lines
file location
(plist-get parameters :only-contents)
lines)
lines)))
(org-mode)
(insert
(org-export--prepare-file-contents
file lines ind (plist-get parameters :minlevel)
(and file-prefix
(or (gethash file file-prefix)
(puthash file
(hash-table-count file-prefix)
file-prefix)))
footnotes includer-file)))
(org-export-expand-include-keyword
(cons (list file lines) already-included)
(unless (org-url-p file)
(file-name-directory file))
footnotes includer-file expand-env)
(buffer-string)))))))
(defun org-export--inclusion-absolute-lines (file location only-contents lines)
"Resolve absolute lines for an included file with file-link.
FILE is string file-name of the file to include. LOCATION is a
string name within FILE to be included (located via
`org-link-search'). If ONLY-CONTENTS is non-nil only the
contents of the named element will be included, as determined
Org-Element. If LINES is non-nil only those lines are included.
Return a string of lines to be included in the format expected by
`org-export--prepare-file-contents'."
(with-temp-buffer
(insert (org-file-contents file))
(unless (eq major-mode 'org-mode)
(let ((org-inhibit-startup t)) (org-mode)))
(condition-case err
;; Enforce consistent search.
(let ((org-link-search-must-match-exact-headline nil))
(org-link-search location))
(error
(error "%s for %s::%s" (error-message-string err) file location)))
(let* ((element (org-element-at-point))
(contents-begin
(and only-contents (org-element-contents-begin element))))
(narrow-to-region
(or contents-begin (org-element-begin element))
(org-element-property (if contents-begin :contents-end :end) element))
(when (and only-contents
(org-element-type-p element '(headline inlinetask)))
;; Skip planning line and property-drawer.
(goto-char (point-min))
(when (looking-at-p org-planning-line-re) (forward-line))
(when (looking-at org-property-drawer-re) (goto-char (match-end 0)))
(unless (bolp) (forward-line))
(narrow-to-region (point) (point-max))))
(when lines
(org-skip-whitespace)
(forward-line 0)
(let* ((lines (split-string lines "-"))
(lbeg (string-to-number (car lines)))
(lend (string-to-number (cadr lines)))
(beg (if (zerop lbeg) (point-min)
(goto-char (point-min))
(forward-line (1- lbeg))
(point)))
(end (if (zerop lend) (point-max)
(goto-char beg)
(forward-line (1- lend))
(point))))
(narrow-to-region beg end)))
(let ((end (point-max)))
(goto-char (point-min))
(widen)
(let ((start-line (line-number-at-pos)))
(format "%d-%d"
start-line
(save-excursion
(+ start-line
(let ((counter 0))
(while (< (point) end) (cl-incf counter) (forward-line))
counter))))))))
(defun org-export--update-included-link (file-dir includer-dir)
"Update relative file name of link at point, if possible.
FILE-DIR is the directory of the file being included.
INCLUDER-DIR is the directory of the file where the inclusion is
going to happen.
Move point after the link."
(let* ((link (org-element-link-parser))
(path (org-element-property :path link)))
(if (or (not (string= "file" (org-element-property :type link)))
(file-remote-p path)
(file-name-absolute-p path))
(goto-char (org-element-end link))
(let ((new-path (file-relative-name (expand-file-name path file-dir)
includer-dir))
(new-link (org-element-copy link)))
(org-element-put-property new-link :path new-path)
(when (org-element-contents-begin link)
(org-element-adopt new-link
(buffer-substring
(org-element-contents-begin link)
(org-element-contents-end link))))
(delete-region (org-element-begin link)
(org-element-end link))
(insert (org-element-interpret-data new-link))))))
(defun org-export--prepare-file-contents
(file &optional lines ind minlevel id footnotes includer)
"Prepare contents of FILE for inclusion and return it as a string.
When optional argument LINES is a string specifying a range of
lines, include only those lines.
Optional argument IND, when non-nil, is an integer specifying the
global indentation of returned contents. Since its purpose is to
allow an included file to stay in the same environment it was
created (e.g., a list item), it doesn't apply past the first
headline encountered.
Optional argument MINLEVEL, when non-nil, is an integer
specifying the level that any top-level headline in the included
file should have.
Optional argument ID is an integer that will be inserted before
each footnote definition and reference if FILE is an Org file.
This is useful to avoid conflicts when more than one Org file
with footnotes is included in a document.
Optional argument FOOTNOTES is a hash-table to store footnotes in
the included document.
Optional argument INCLUDER is the file name where the inclusion
is to happen."
(with-temp-buffer
(insert (org-file-contents file))
(when lines
(let* ((lines (split-string lines "-"))
(lbeg (string-to-number (car lines)))
(lend (string-to-number (cadr lines)))
(beg (if (zerop lbeg) (point-min)
(goto-char (point-min))
(forward-line (1- lbeg))
(point)))
(end (if (zerop lend) (point-max)
(goto-char (point-min))
(forward-line (1- lend))
(point))))
(narrow-to-region beg end)))
;; Adapt all file links within the included document that contain
;; relative paths in order to make these paths relative to the
;; base document, or absolute.
(when includer
(let ((file-dir (file-name-directory file))
(includer-dir (file-name-directory includer)))
(unless (file-equal-p file-dir includer-dir)
(goto-char (point-min))
(unless (eq major-mode 'org-mode)
(let ((org-inhibit-startup t)) (org-mode))) ;set regexps
(let ((regexp (concat org-link-plain-re "\\|" org-link-angle-re)))
(while (re-search-forward org-link-any-re nil t)
(let ((link (save-excursion
(forward-char -1)
(org-element-context))))
(when (org-element-type-p link 'link)
;; Look for file links within link's description.
;; Org doesn't support such construct, but
;; `org-export-insert-image-links' may activate
;; them.
(let ((contents-begin
(org-element-contents-begin link))
(begin (org-element-begin link)))
(when contents-begin
(save-excursion
(goto-char (org-element-contents-end link))
(while (re-search-backward regexp contents-begin t)
(save-match-data
(org-export--update-included-link
file-dir includer-dir))
(goto-char (match-beginning 0)))))
;; Update current link, if necessary.
(when (string= "file" (org-element-property :type link))
(goto-char begin)
(org-export--update-included-link
file-dir includer-dir))))))))))
;; Remove blank lines at beginning and end of contents. The logic
;; behind that removal is that blank lines around include keyword
;; override blank lines in included file.
(goto-char (point-min))
(org-skip-whitespace)
(forward-line 0)
(delete-region (point-min) (point))
(goto-char (point-max))
(skip-chars-backward " \r\t\n")
(forward-line)
(delete-region (point) (point-max))
;; If IND is set, preserve indentation of include keyword until
;; the first headline encountered.
(when (and ind (> ind 0))
(unless (eq major-mode 'org-mode)
(let ((org-inhibit-startup t)) (org-mode)))
(goto-char (point-min))
(let ((ind-str (make-string ind ?\s)))
(while (not (or (eobp) (looking-at org-outline-regexp-bol)))
;; Do not move footnote definitions out of column 0.
(unless (and (looking-at org-footnote-definition-re)
(org-element-type-p
(org-element-at-point) 'footnote-definition))
(insert ind-str))
(forward-line))))
;; When MINLEVEL is specified, compute minimal level for headlines
;; in the file (CUR-MIN), and remove stars to each headline so
;; that headlines with minimal level have a level of MINLEVEL.
(when minlevel
(unless (eq major-mode 'org-mode)
(let ((org-inhibit-startup t)) (org-mode)))
(org-with-limited-levels
(let ((levels (org-map-entries
(lambda () (org-reduced-level (org-current-level))))))
(when levels
(let ((offset (- minlevel (apply #'min levels))))
(unless (zerop offset)
(when org-odd-levels-only (setq offset (* offset 2)))
;; Only change stars, don't bother moving whole
;; sections.
(org-map-entries
(lambda ()
(if (< offset 0) (delete-char (abs offset))
(insert (make-string offset ?*)))))))))))
;; Append ID to all footnote references and definitions, so they
;; become file specific and cannot collide with footnotes in other
;; included files. Further, collect relevant footnote definitions
;; outside of LINES, in order to reintroduce them later.
(when id
(let ((marker-min (point-min-marker))
(marker-max (point-max-marker))
(get-new-label
(lambda (label)
;; Generate new label from LABEL by prefixing it with
;; "-ID-".
(format "-%d-%s" id label)))
(set-new-label
(lambda (f old new)
;; Replace OLD label with NEW in footnote F.
(save-excursion
(goto-char (+ (org-element-begin f) 4))
(looking-at (regexp-quote old))
(replace-match new))))
(seen-alist))
(goto-char (point-min))
(while (re-search-forward org-footnote-re nil t)
(let ((footnote (save-excursion
(backward-char)
(org-element-context))))
(when (org-element-type-p
footnote '(footnote-definition footnote-reference))
(let* ((label (org-element-property :label footnote)))
;; Update the footnote-reference at point and collect
;; the new label, which is only used for footnotes
;; outsides LINES.
(when label
(let ((seen (cdr (assoc label seen-alist))))
(if seen (funcall set-new-label footnote label seen)
(let ((new (funcall get-new-label label)))
(push (cons label new) seen-alist)
(org-with-wide-buffer
(let* ((def (org-footnote-get-definition label))
(beg (nth 1 def)))
(when (and def
(or (< beg marker-min)
(>= beg marker-max)))
;; Store since footnote-definition is
;; outside of LINES.
(puthash new
(org-element-normalize-string (nth 3 def))
footnotes))))
(funcall set-new-label footnote label new)))))))))
(set-marker marker-min nil)
(set-marker marker-max nil)))
(org-element-normalize-string (buffer-string))))
(defun org-export--copy-to-kill-ring-p ()
"Return a non-nil value when output should be added to the kill ring.
See also `org-export-copy-to-kill-ring'."
(if (eq org-export-copy-to-kill-ring 'if-interactive)
(not (or executing-kbd-macro noninteractive))
(eq org-export-copy-to-kill-ring t)))
\f
;;; Tools For Backends
;;
;; A whole set of tools is available to help build new exporters. Any
;; function general enough to have its use across many backends
;; should be added here.
;;;; For Affiliated Keywords
;;
;; `org-export-read-attribute' reads a property from a given element
;; as a plist. It can be used to normalize affiliated keywords'
;; syntax.
;;
;; Since captions can span over multiple lines and accept dual values,
;; their internal representation is a bit tricky. Therefore,
;; `org-export-get-caption' transparently returns a given element's
;; caption as a secondary string.
(defun org-export-read-attribute (attribute element &optional property)
"Turn ATTRIBUTE property from ELEMENT into a plist.
When optional argument PROPERTY is non-nil, return the value of
that property within attributes.
This function assumes attributes are defined as \":keyword
value\" pairs. It is appropriate for `:attr_html' like
properties.
All values will become strings except the empty string and
\"nil\", which will become nil. Also, values containing only
double quotes will be read as-is, which means that \"\" value
will become the empty string."
(let* ((prepare-value
(lambda (str)
(save-match-data
(cond ((member str '(nil "" "nil")) nil)
((string-match "^\"\\(\"+\\)?\"$" str)
(or (match-string 1 str) ""))
(t str)))))
(attributes
(let ((value (org-element-property attribute element)))
(when value
(let ((s (mapconcat #'identity value " ")) result)
(while (string-match
"\\(?:^\\|[ \t]+\\)\\(:[-a-zA-Z0-9_]+\\)\\([ \t]+\\|$\\)"
s)
(let ((value (substring s 0 (match-beginning 0))))
(push (funcall prepare-value value) result))
(push (intern (match-string 1 s)) result)
(setq s (substring s (match-end 0))))
;; Ignore any string before first property with `cdr'.
(cdr (nreverse (cons (funcall prepare-value s) result))))))))
(if property (plist-get attributes property) attributes)))
(defun org-export-get-caption (element &optional short)
"Return caption from ELEMENT as a secondary string.
When optional argument SHORT is non-nil, return short caption, as
a secondary string, instead.
Caption lines are separated by a white space."
(let ((full-caption (org-element-property :caption element))
(get (if short #'cdr #'car))
caption)
(dolist (line full-caption)
(pcase (funcall get line)
(`nil nil)
(c
(setq caption
(if caption
(nconc caption (list " ") (copy-sequence c))
(copy-sequence c))))))
caption))
;;;; For Derived Backends
;;
;; `org-export-with-backend' is a function allowing to locally use
;; another backend to transcode some object or element. In a derived
;; backend, it may be used as a fall-back function once all specific
;; cases have been treated.
(defun org-export-with-backend (backend data &optional contents info)
"Call a transcoder from BACKEND on DATA.
BACKEND is an export backend, as returned by, e.g.,
`org-export-create-backend', or a symbol referring to
a registered backend. DATA is an Org element, object, secondary
string or string. CONTENTS, when non-nil, is the transcoded
contents of DATA element, as a string. INFO, when non-nil, is
the communication channel used for export, as a plist."
(when (symbolp backend) (setq backend (org-export-get-backend backend)))
(org-export-barf-if-invalid-backend backend)
(let ((type (org-element-type data)))
(when (memq type '(nil org-data raw))
(error "No foreign transcoder available"))
(let* ((all-transcoders (org-export-get-all-transcoders backend))
(transcoder (cdr (assq type all-transcoders))))
(unless (functionp transcoder) (error "No foreign transcoder available"))
(let ((new-info
(org-combine-plists
info (list
:back-end backend
:translate-alist all-transcoders
:exported-data (make-hash-table :test #'eq :size 401)))))
;; `:internal-references' are shared across backends.
(prog1 (if (eq type 'plain-text)
(funcall transcoder data new-info)
(funcall transcoder data contents new-info))
(plist-put info :internal-references
(plist-get new-info :internal-references)))))))
;;;; For Export Snippets
;;
;; Every export snippet is transmitted to the backend. Though, the
;; latter will only retain one type of export-snippet, ignoring
;; others, based on the former's target backend. The function
;; `org-export-snippet-backend' returns that backend for a given
;; export-snippet.
(defun org-export-snippet-backend (export-snippet)
"Return EXPORT-SNIPPET targeted backend as a symbol.
Translation, with `org-export-snippet-translation-alist', is
applied."
(let ((backend (org-element-property :back-end export-snippet)))
(intern
(or (cdr (assoc backend org-export-snippet-translation-alist))
backend))))
;;;; For Footnotes
;;
;; `org-export-collect-footnote-definitions' is a tool to list
;; actually used footnotes definitions in the whole parse tree, or in
;; a headline, in order to add footnote listings throughout the
;; transcoded data.
;;
;; `org-export-footnote-first-reference-p' is a predicate used by some
;; backends, when they need to attach the footnote definition only to
;; the first occurrence of the corresponding label.
;;
;; `org-export-get-footnote-definition' and
;; `org-export-get-footnote-number' provide easier access to
;; additional information relative to a footnote reference.
(defun org-export-get-footnote-definition (footnote-reference info)
"Return definition of FOOTNOTE-REFERENCE as parsed data.
INFO is the plist used as a communication channel. If no such
definition can be found, raise an error."
(let ((label (org-element-property :label footnote-reference)))
(if (not label) (org-element-contents footnote-reference)
(let ((cache (or (plist-get info :footnote-definition-cache)
(let ((hash (make-hash-table :test #'equal)))
;; Cache all the footnotes in document for
;; later search.
(org-element-map (plist-get info :parse-tree)
'(footnote-definition footnote-reference)
(lambda (f)
;; Skip any standard footnote reference
;; since those cannot contain a
;; definition.
(unless (eq (org-element-property :type f) 'standard)
(puthash
(cons :element (org-element-property :label f))
f
hash)))
info)
(plist-put info :footnote-definition-cache hash)
hash))))
(or
(gethash label cache)
(puthash label
(let ((hashed (gethash (cons :element label) cache)))
(when hashed
(or (org-element-contents hashed)
;; Even if the contents are empty, we can not
;; return nil since that would eventually raise
;; the error. Instead, return the equivalent
;; empty string.
"")))
cache)
(error "Definition not found for footnote %s" label))))))
(defun org-export--footnote-reference-map
(function data info &optional body-first)
"Apply FUNCTION on every footnote reference in DATA.
INFO is a plist containing export state. By default, as soon as
a new footnote reference is encountered, FUNCTION is called onto
its definition. However, if BODY-FIRST is non-nil, this step is
delayed until the end of the process."
(letrec ((definitions nil)
(seen-refs nil)
(search-ref
(lambda (data delayp)
;; Search footnote references through DATA, filling
;; SEEN-REFS along the way. When DELAYP is non-nil,
;; store footnote definitions so they can be entered
;; later.
(org-element-map data 'footnote-reference
(lambda (f)
(funcall function f)
(let ((--label (org-element-property :label f)))
(unless (and --label (member --label seen-refs))
(when --label (push --label seen-refs))
;; Search for subsequent references in footnote
;; definition so numbering follows reading
;; logic, unless DELAYP in non-nil.
(cond
(delayp
(push (org-export-get-footnote-definition f info)
definitions))
;; Do not force entering inline definitions,
;; since `org-element-map' already traverses
;; them at the right time.
((eq (org-element-property :type f) 'inline))
(t (funcall search-ref
(org-export-get-footnote-definition f info)
nil))))))
info nil
;; Don't enter footnote definitions since it will
;; happen when their first reference is found.
;; Moreover, if DELAYP is non-nil, make sure we
;; postpone entering definitions of inline references.
(if delayp '(footnote-definition footnote-reference)
'footnote-definition)))))
(funcall search-ref data body-first)
(funcall search-ref (nreverse definitions) nil)))
(defun org-export-collect-footnote-definitions (info &optional data body-first)
"Return an alist between footnote numbers, labels and definitions.
INFO is the current export state, as a plist.
Definitions are collected throughout the whole parse tree, or
DATA when non-nil.
Sorting is done by order of references. As soon as a new
reference is encountered, other references are searched within
its definition. However, if BODY-FIRST is non-nil, this step is
delayed after the whole tree is checked. This alters results
when references are found in footnote definitions.
Definitions either appear as Org data or as a secondary string
for inlined footnotes. Unreferenced definitions are ignored."
(let ((n 0) labels alist)
(org-export--footnote-reference-map
(lambda (f)
;; Collect footnote number, label and definition.
(let ((l (org-element-property :label f)))
(unless (and l (member l labels))
(cl-incf n)
(push (list n l (org-export-get-footnote-definition f info)) alist))
(when l (push l labels))))
(or data (plist-get info :parse-tree)) info body-first)
(nreverse alist)))
(defun org-export-footnote-first-reference-p
(footnote-reference info &optional data body-first)
"Non-nil when a footnote reference is the first one for its label.
FOOTNOTE-REFERENCE is the footnote reference being considered.
INFO is a plist containing current export state.
Search is done throughout the whole parse tree, or DATA when
non-nil.
By default, as soon as a new footnote reference is encountered,
other references are searched within its definition. However, if
BODY-FIRST is non-nil, this step is delayed after the whole tree
is checked. This alters results when references are found in
footnote definitions."
(let ((label (org-element-property :label footnote-reference)))
;; Anonymous footnotes are always a first reference.
(or (not label)
(catch 'exit
(org-export--footnote-reference-map
(lambda (f)
(let ((l (org-element-property :label f)))
(when (and l label (string= label l))
(throw 'exit (eq footnote-reference f)))))
(or data (plist-get info :parse-tree)) info body-first)))))
(defun org-export-get-footnote-number (footnote info &optional data body-first)
"Return number associated to a footnote.
FOOTNOTE is either a footnote reference or a footnote definition.
INFO is the plist containing export state.
Number is unique throughout the whole parse tree, or DATA, when
non-nil.
By default, as soon as a new footnote reference is encountered,
counting process moves into its definition. However, if
BODY-FIRST is non-nil, this step is delayed until the end of the
process, leading to a different order when footnotes are nested."
(let ((count 0)
(seen)
(label (org-element-property :label footnote)))
(catch 'exit
(org-export--footnote-reference-map
(lambda (f)
(let ((l (org-element-property :label f)))
(cond
;; Anonymous footnote match: return number.
((and (not l) (not label) (eq footnote f)) (throw 'exit (1+ count)))
;; Labels match: return number.
((and label l (string= label l)) (throw 'exit (1+ count)))
;; Otherwise store label and increase counter if label
;; wasn't encountered yet.
((not l) (cl-incf count))
((not (member l seen)) (push l seen) (cl-incf count)))))
(or data (plist-get info :parse-tree)) info body-first))))
;;;; For Headlines
;;
;; `org-export-get-relative-level' is a shortcut to get headline
;; level, relatively to the lower headline level in the parsed tree.
;;
;; `org-export-get-headline-number' returns the section number of an
;; headline, while `org-export-number-to-roman' allows it to be
;; converted to roman numbers. With an optional argument,
;; `org-export-get-headline-number' returns a number to unnumbered
;; headlines (used for internal id).
;;
;; `org-export-low-level-p', `org-export-first-sibling-p' and
;; `org-export-last-sibling-p' are three useful predicates when it
;; comes to fulfill the `:headline-levels' property.
;;
;; `org-export-get-tags', `org-export-get-category' and
;; `org-export-get-node-property' extract useful information from an
;; headline or a parent headline. They all handle inheritance.
;;
;; `org-export-get-alt-title' tries to retrieve an alternative title,
;; as a secondary string, suitable for table of contents. It falls
;; back onto default title.
(defun org-export-get-relative-level (headline info)
"Return HEADLINE relative level within current parsed tree.
INFO is a plist holding contextual information."
(+ (org-element-property :level headline)
(or (plist-get info :headline-offset) 0)))
(defun org-export-low-level-p (headline info)
"Non-nil when HEADLINE is considered as low level.
INFO is a plist used as a communication channel.
A low level headlines has a relative level greater than
`:headline-levels' property value.
Return value is the difference between HEADLINE relative level
and the last level being considered as high enough, or nil."
(let ((limit (plist-get info :headline-levels)))
(when (wholenump limit)
(let ((level (org-export-get-relative-level headline info)))
(and (> level limit) (- level limit))))))
(defun org-export-get-headline-number (headline info)
"Return numbered HEADLINE numbering as a list of numbers.
INFO is a plist holding contextual information."
(and (org-export-numbered-headline-p headline info)
(cdr (assq headline (plist-get info :headline-numbering)))))
(defun org-export-numbered-headline-p (headline info)
"Return a non-nil value if HEADLINE element should be numbered.
INFO is a plist used as a communication channel."
(unless (org-not-nil (org-export-get-node-property :UNNUMBERED headline t))
(let ((sec-num (plist-get info :section-numbers))
(level (org-export-get-relative-level headline info)))
(if (wholenump sec-num) (<= level sec-num) sec-num))))
(defun org-export-number-to-roman (n)
"Convert integer N into a roman numeral."
(let ((roman '((1000 . "M") (900 . "CM") (500 . "D") (400 . "CD")
( 100 . "C") ( 90 . "XC") ( 50 . "L") ( 40 . "XL")
( 10 . "X") ( 9 . "IX") ( 5 . "V") ( 4 . "IV")
( 1 . "I")))
(res ""))
(if (<= n 0)
(number-to-string n)
(while roman
(if (>= n (caar roman))
(setq n (- n (caar roman))
res (concat res (cdar roman)))
(pop roman)))
res)))
(defun org-export-get-tags (element info &optional tags inherited)
"Return list of tags associated to ELEMENT.
ELEMENT has either an `headline' or an `inlinetask' type. INFO
is a plist used as a communication channel.
When non-nil, optional argument TAGS should be a list of strings.
Any tag belonging to this list will also be removed.
When optional argument INHERITED is non-nil, tags can also be
inherited from parent headlines and FILETAGS keywords."
(cl-remove-if
(lambda (tag) (member tag tags))
(if (not inherited) (org-element-property :tags element)
;; Build complete list of inherited tags.
(let ((current-tag-list (org-element-property :tags element)))
(dolist (parent (org-element-lineage element))
(dolist (tag (org-element-property :tags parent))
(when (and (org-element-type-p parent '(headline inlinetask))
(not (member tag current-tag-list)))
(push tag current-tag-list))))
;; Add FILETAGS keywords and return results.
(org-uniquify (append (plist-get info :filetags) current-tag-list))))))
(defun org-export-get-node-property (property datum &optional inherited)
"Return node PROPERTY value for DATUM.
PROPERTY is an upcase symbol (e.g., `:COOKIE_DATA'). DATUM is an
element or object.
If optional argument INHERITED is non-nil, the value can be
inherited from a parent headline.
Return value is a string or nil."
(let ((headline (if (org-element-type-p datum 'headline) datum
(org-element-lineage datum 'headline))))
(if (not inherited) (org-element-property property datum)
(org-element-property-inherited property headline 'with-self nil nil t))))
(defun org-export-get-category (blob info)
"Return category for element or object BLOB.
INFO is a plist used as a communication channel.
CATEGORY is automatically inherited from a parent headline, from
#+CATEGORY: keyword or created out of original file name. If all
fail, the fall-back value is \"???\"."
(or (org-export-get-node-property :CATEGORY blob t)
(org-element-map (plist-get info :parse-tree) 'keyword
(lambda (kwd)
(when (equal (org-element-property :key kwd) "CATEGORY")
(org-element-property :value kwd)))
info 'first-match)
(let ((file (plist-get info :input-file)))
(and file (file-name-sans-extension (file-name-nondirectory file))))
"???"))
(defun org-export-get-alt-title (headline _)
"Return alternative title for HEADLINE, as a secondary string.
If no optional title is defined, fall-back to the regular title."
(let ((alt (org-element-property :ALT_TITLE headline)))
(if alt (org-element-parse-secondary-string
alt (org-element-restriction 'headline) headline)
(org-element-property :title headline))))
(defun org-export-first-sibling-p (blob info)
"Non-nil when BLOB is the first sibling in its parent.
BLOB is an element or an object. If BLOB is a headline, non-nil
means it is the first sibling in the sub-tree. INFO is a plist
used as a communication channel."
(org-element-type-p
(org-export-get-previous-element blob info)
'(nil section)))
(defun org-export-last-sibling-p (datum info)
"Non-nil when DATUM is the last sibling in its parent.
DATUM is an element or an object. INFO is a plist used as
a communication channel."
(let ((next (org-export-get-next-element datum info)))
(or (not next)
(and (org-element-type-p datum 'headline)
(> (org-element-property :level datum)
(org-element-property :level next))))))
;;;; For Keywords
;;
;; `org-export-get-date' returns a date appropriate for the document
;; to about to be exported. In particular, it takes care of
;; `org-export-date-timestamp-format'.
(defun org-export-get-date (info &optional fmt)
"Return date value for the current document.
INFO is a plist used as a communication channel. FMT, when
non-nil, is a time format string that will be applied on the date
if it consists in a single timestamp object. It defaults to
`org-export-date-timestamp-format' when nil.
A proper date can be a secondary string, a string or nil. It is
meant to be translated with `org-export-data' or alike."
(let ((date (plist-get info :date))
(fmt (or fmt org-export-date-timestamp-format)))
(cond ((not date) nil)
((and fmt
(not (cdr date))
(org-element-type-p (car date) 'timestamp))
(org-format-timestamp (car date) fmt))
(t date))))
;;;; For Links
;;
;; `org-export-custom-protocol-maybe' handles custom protocol defined
;; in `org-link-parameters'.
;;
;; `org-export-get-coderef-format' returns an appropriate format
;; string for coderefs.
;;
;; `org-export-inline-image-p' returns a non-nil value when the link
;; provided should be considered as an inline image.
;;
;; `org-export-resolve-fuzzy-link' searches destination of fuzzy links
;; (i.e. links with "fuzzy" as type) within the parsed tree, and
;; returns an appropriate unique identifier.
;;
;; `org-export-resolve-id-link' returns the first headline with
;; specified id or custom-id in parse tree, the path to the external
;; file with the id.
;;
;; `org-export-resolve-link' searches for the destination of a link
;; within the parsed tree and returns the element.
;;
;; `org-export-resolve-coderef' associates a reference to a line
;; number in the element it belongs, or returns the reference itself
;; when the element isn't numbered.
;;
;; `org-export-file-uri' expands a filename as stored in :path value
;; of a "file" link into a file URI.
;;
;; Broken links raise a `org-link-broken' error, which is caught by
;; `org-export-data' for further processing, depending on
;; `org-export-with-broken-links' value.
(define-error 'org-link-broken "Unable to resolve link; aborting")
(defun org-export-custom-protocol-maybe (link desc backend &optional info)
"Try exporting LINK object with a dedicated function.
DESC is its description, as a string, or nil. BACKEND is the
backend used for export, as a symbol.
Return output as a string, or nil if no protocol handles LINK.
A custom protocol has precedence over regular backend export.
The function ignores links with an implicit type (e.g.,
\"custom-id\")."
(let ((type (org-element-property :type link)))
(unless (or (member type '("coderef" "custom-id" "fuzzy" "radio" nil))
(not backend))
(let ((protocol (org-link-get-parameter type :export))
(path (org-element-property :path link)))
(and (functionp protocol)
(condition-case nil
(funcall protocol path desc backend info)
;; XXX: The function used (< Org 9.4) to accept only
;; three mandatory arguments. Type-specific `:export'
;; functions in the wild may not handle current
;; signature. Provide backward compatibility support
;; for them.
(wrong-number-of-arguments
(funcall protocol path desc backend))))))))
(defun org-export-get-coderef-format (path desc)
"Return format string for code reference link.
PATH is the link path. DESC is its description."
(save-match-data
(cond ((not desc) "%s")
((string-match (regexp-quote (concat "(" path ")")) desc)
(replace-match "%s" t t desc))
(t desc))))
(defun org-export-inline-image-p (link &optional rules)
"Non-nil if LINK object points to an inline image.
Optional argument is a set of RULES defining inline images. It
is an alist where associations have the following shape:
(TYPE . REGEXP)
Applying a rule means apply REGEXP against LINK's path when its
type is TYPE. The function will return a non-nil value if any of
the provided rules is non-nil. The default rule is
`org-export-default-inline-image-rule'.
This only applies to links without a description."
(and (not (org-element-contents link))
(let ((case-fold-search t))
(cl-some (lambda (rule)
(and (string= (org-element-property :type link) (car rule))
(string-match-p (cdr rule)
(org-element-property :path link))))
(or rules org-export-default-inline-image-rule)))))
(defun org-export-insert-image-links (data info &optional rules)
"Insert image links in DATA.
Org syntax does not support nested links. Nevertheless, some
export backends support images as descriptions of links. Since
images are really links to image files, we need to make an
exception about links nesting.
This function recognizes links whose contents are really images
and turn them into proper nested links. It is meant to be used
as a parse tree filter in backends supporting such constructs.
DATA is a parse tree. INFO is the current state of the export
process, as a plist.
A description is a valid images if it matches any rule in RULES,
if non-nil, or `org-export-default-inline-image-rule' otherwise.
See `org-export-inline-image-p' for more information about the
structure of RULES.
Return modified DATA."
(let ((link-re (format "\\`\\(?:%s\\|%s\\)\\'"
org-link-plain-re
org-link-angle-re))
(case-fold-search t))
(org-element-map data 'link
(lambda (l)
(let ((contents (org-element-interpret-data (org-element-contents l))))
(when (and (org-string-nw-p contents)
(string-match link-re contents))
(let ((type (match-string 1 contents))
(path (match-string 2 contents)))
(when (cl-some (lambda (rule)
(and (string= type (car rule))
(string-match-p (cdr rule) path)))
(or rules org-export-default-inline-image-rule))
;; Replace contents with image link.
(org-element-adopt
(org-element-set-contents l)
(with-temp-buffer
(save-excursion (insert contents))
(org-element-link-parser))))))))
info nil nil t))
data)
(defun org-export-resolve-coderef (ref info)
"Resolve a code reference REF.
INFO is a plist used as a communication channel.
Return associated line number in source code, or REF itself,
depending on src-block or example element's switches. Throw an
error if no block contains REF."
(or (org-element-map (plist-get info :parse-tree) '(example-block src-block)
(lambda (el)
(with-temp-buffer
(insert (org-trim (org-element-property :value el)))
(let* ((label-fmt (or (org-element-property :label-fmt el)
org-coderef-label-format))
(ref-re (org-src-coderef-regexp label-fmt ref)))
;; Element containing REF is found. Resolve it to
;; either a label or a line number, as needed.
(when (re-search-backward ref-re nil t)
(if (org-element-property :use-labels el) ref
(+ (or (org-export-get-loc el info) 0)
(line-number-at-pos)))))))
info 'first-match)
(signal 'org-link-broken (list ref))))
(defun org-export-search-cells (datum)
"List search cells for element or object DATUM.
A search cell follows the pattern (TYPE . SEARCH) where
TYPE is a symbol among `headline', `custom-id', `target' and
`other'.
SEARCH is the string a link is expected to match. More
accurately, it is
- headline's title, as a list of strings, if TYPE is
`headline'.
- CUSTOM_ID value, as a string, if TYPE is `custom-id'.
- target's or radio-target's name as a list of strings if
TYPE is `target'.
- NAME or RESULTS affiliated keyword if TYPE is `other'.
A search cell is the internal representation of a fuzzy link. It
ignores case, white spaces, and statistics cookies, if applicable."
(pcase (org-element-type datum)
(`headline
(let ((title (mapcar #'upcase
(split-string
(replace-regexp-in-string
"\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]" " "
(org-element-property :raw-value datum))))))
(delq nil
(list
(cons 'headline title)
(cons 'other title)
(let ((custom-id (org-element-property :custom-id datum)))
(and custom-id (cons 'custom-id custom-id)))))))
(`target
(list (cons 'target
(mapcar #'upcase
(split-string (org-element-property :value datum))))))
((and (let name (or (org-element-property :name datum)
(car (org-element-property :results datum))))
(guard name))
(list (cons 'other (split-string name))))
(_ nil)))
(defun org-export-string-to-search-cell (s)
"Return search cells associated to string S.
S is either the path of a fuzzy link or a search option, i.e., it
tries to match either a headline (through custom ID or title),
a target or a named element.
The title match is case-insensitive."
(pcase (string-to-char s)
(?* (list (cons 'headline (mapcar #'upcase (split-string (substring s 1))))))
(?# (list (cons 'custom-id (substring s 1))))
((let search (split-string s))
(cl-remove-duplicates
(list (cons 'target search)
(cons 'other search)
(cons 'target (mapcar #'upcase search))
(cons 'other (mapcar #'upcase search)))
:test #'equal))))
(defun org-export-match-search-cell-p (datum cells)
"Non-nil when DATUM matches search cells CELLS.
DATUM is an element or object. CELLS is a list of search cells,
as returned by `org-export-search-cells'."
(let ((targets (org-export-search-cells datum)))
(and targets (cl-some (lambda (cell) (member cell targets)) cells))))
(defun org-export-resolve-fuzzy-link (link info &rest pseudo-types)
"Return LINK destination.
INFO is a plist holding contextual information.
Return value can be an object or an element:
- If LINK path matches a target object (i.e. <<path>>) return it.
- If LINK path exactly matches the name or results affiliated keyword
(i.e. #+NAME: path or #+RESULTS: name) of an element, return that
element.
- If LINK path exactly matches any headline name, return that
element.
- Otherwise, throw an error.
PSEUDO-TYPES are pseudo-elements types, i.e., elements defined
specifically in an export backend, that could have a name
affiliated keyword.
Assume LINK type is \"fuzzy\". White spaces are not
significant."
(let* ((search-cells (org-export-string-to-search-cell
(org-element-property :path link)))
(link-cache (or (plist-get info :resolve-fuzzy-link-cache)
(let ((table (make-hash-table :test #'equal)))
;; Cache all the element search cells.
(org-element-map (plist-get info :parse-tree)
(append pseudo-types '(target) org-element-all-elements)
(lambda (datum)
(dolist (cell (org-export-search-cells datum))
(if (gethash cell table)
(push datum (gethash cell table))
(puthash cell (list datum) table)))))
(plist-put info :resolve-fuzzy-link-cache table)
table)))
(cached (gethash search-cells link-cache 'not-found)))
(if (not (eq cached 'not-found)) cached
(let ((matches
(let (result)
(dolist (search-cell search-cells)
(setq result
(nconc
result
(gethash search-cell link-cache))))
(delq nil result))))
(unless matches
(signal 'org-link-broken (list (org-element-property :path link))))
(puthash
search-cells
;; There can be multiple matches for un-typed searches, i.e.,
;; for searches not starting with # or *. In this case,
;; prioritize targets and names over headline titles.
;; Matching both a name and a target is not valid, and
;; therefore undefined.
(or (cl-some (lambda (datum)
(and (not (org-element-type-p datum 'headline))
datum))
matches)
(car matches))
link-cache)))))
(defun org-export-resolve-id-link (link info)
"Return headline referenced as LINK destination.
INFO is a plist used as a communication channel.
Return value can be the headline element matched in current parse
tree or a file name. Assume LINK type is either \"id\" or
\"custom-id\". Throw an error if no match is found."
(let ((id (org-element-property :path link)))
;; First check if id is within the current parse tree.
(or (let ((local-ids (or (plist-get info :id-local-cache)
(let ((table (make-hash-table :test #'equal)))
(org-element-map
(plist-get info :parse-tree)
'headline
(lambda (headline)
(let ((id (org-element-property :ID headline))
(custom-id (org-element-property :CUSTOM_ID headline)))
(when id
(unless (gethash id table)
(puthash id headline table)))
(when custom-id
(unless (gethash custom-id table)
(puthash custom-id headline table)))))
info)
(plist-put info :id-local-cache table)
table))))
(gethash id local-ids))
;; Otherwise, look for external files.
(cdr (assoc id (plist-get info :id-alist)))
(signal 'org-link-broken (list id)))))
(defun org-export-resolve-radio-link (link info)
"Return radio-target object referenced as LINK destination.
INFO is a plist used as a communication channel.
Return value can be a radio-target object or nil. Assume LINK
has type \"radio\"."
(let ((path (org-string-clean-whitespace (org-element-property :path link))))
(org-element-map (plist-get info :parse-tree) 'radio-target
(lambda (radio)
(and (org-string-equal-ignore-case
(org-string-clean-whitespace (org-element-property :value radio))
path)
radio))
info 'first-match)))
(defun org-export-resolve-link (link info)
"Return LINK destination.
LINK is a string or a link object.
INFO is a plist holding contextual information.
Return value can be an object or an element:
- If LINK path matches an ID or a custom ID, return the headline.
- If LINK path matches a fuzzy link, return its destination.
- Otherwise, throw an error."
;; Convert string links to link objects.
(when (stringp link)
(setq link (with-temp-buffer
(save-excursion
(insert (org-link-make-string link)))
(org-element-link-parser))))
(pcase (org-element-property :type link)
((or "custom-id" "id") (org-export-resolve-id-link link info))
("fuzzy" (org-export-resolve-fuzzy-link link info))
(_ (signal 'org-link-broken (list (org-element-property :path link))))))
(defun org-export-file-uri (filename)
"Return file URI associated to FILENAME."
(cond ((string-prefix-p "//" filename) (concat "file:" filename))
((not (file-name-absolute-p filename)) filename)
((file-remote-p filename) (concat "file:/" filename))
(t
(let ((fullname (expand-file-name filename)))
(concat (if (string-prefix-p "/" fullname) "file://" "file:///")
fullname)))))
(defun org-export-link-remote-p (link)
"Returns non-nil if the link refers to a remote resource."
(or (member (org-element-property :type link) '("http" "https" "ftp"))
(and (string= (org-element-property :type link) "file")
(file-remote-p (org-element-property :path link)))))
(defun org-export-link--remote-local-copy (link)
"Download the remote resource specified by LINK, and return its local path."
;; TODO work this into ol.el as a link parameter, say :download.
(let* ((location-type
(pcase (org-element-property :type link)
((or "http" "https" "ftp") 'url)
((and "file" (guard (file-remote-p
(org-element-property :path link))))
'file)
(_ (error "Cannot copy %s:%s to a local file"
(org-element-property :type link)
(org-element-property :path link)))))
(path
(pcase location-type
('url
(concat (org-element-property :type link)
":" (org-element-property :path link)))
('file
(org-element-property :path link)))))
(or (org-persist-read location-type path)
(org-persist-register location-type path
:write-immediately t))))
(require 'subr-x) ;; FIXME: For `thread-first' in Emacs 26.
(defun org-export-link-localise (link)
"Convert remote LINK to local link.
If LINK refers to a remote resource, modify it to point to a local
downloaded copy. Otherwise, return unchanged LINK."
(when (org-export-link-remote-p link)
(let* ((local-path (org-export-link--remote-local-copy link)))
(if local-path
(setcdr link
(thread-first (cadr link)
(plist-put :type "file")
(plist-put :path local-path)
(plist-put :raw-link (concat "file:" local-path))
list))
(display-warning
'(org export)
(format "unable to obtain local copy of %s"
(org-element-property :raw-link link))))))
link)
;;;; For References
;;
;; `org-export-get-reference' associate a unique reference for any
;; object or element. It uses `org-export-new-reference' and
;; `org-export-format-reference' to, respectively, generate new
;; internal references and turn them into a string suitable for
;; output.
;;
;; `org-export-get-ordinal' associates a sequence number to any object
;; or element.
(defun org-export-new-reference (references)
"Return a unique reference, among REFERENCES.
REFERENCES is an alist whose values are in-use references, as
numbers. Returns a number, which is the internal representation
of a reference. See also `org-export-format-reference'."
;; Generate random 7 digits hexadecimal numbers. Collisions
;; increase exponentially with the numbers of references. However,
;; the odds for encountering at least one collision with 1000 active
;; references in the same document are roughly 0.2%, so this
;; shouldn't be the bottleneck.
(let ((new (random #x10000000)))
(while (rassq new references) (setq new (random #x10000000)))
new))
(defun org-export-format-reference (reference)
"Format REFERENCE into a string.
REFERENCE is a number representing a reference, as returned by
`org-export-new-reference', which see."
(format "org%07x" reference))
(defun org-export-get-reference (datum info)
"Return a unique reference for DATUM, as a string.
DATUM is either an element or an object. INFO is the current
export state, as a plist.
References for the current document are stored in
`:internal-references' property. Its value is an alist with
associations of the following types:
(REFERENCE . DATUM) and (SEARCH-CELL . ID)
REFERENCE is the reference string to be used for object or
element DATUM. SEARCH-CELL is a search cell, as returned by
`org-export-search-cells'. ID is a number or a string uniquely
identifying DATUM within the document.
This function also checks `:crossrefs' property for search cells
matching DATUM before creating a new reference."
(let ((cache (plist-get info :internal-references)))
(or (car (rassq datum cache))
(let* ((crossrefs (plist-get info :crossrefs))
(cells (org-export-search-cells datum))
;; Preserve any pre-existing association between
;; a search cell and a reference, i.e., when some
;; previously published document referenced a location
;; within current file (see
;; `org-publish-resolve-external-link').
;;
;; However, there is no guarantee that search cells are
;; unique, e.g., there might be duplicate custom ID or
;; two headings with the same title in the file.
;;
;; As a consequence, before re-using any reference to
;; an element or object, we check that it doesn't refer
;; to a previous element or object.
(new (or (cl-some
(lambda (cell)
(let ((stored (cdr (assoc cell crossrefs))))
(when stored
(let ((old (org-export-format-reference stored)))
(and (not (assoc old cache)) stored)))))
cells)
(org-export-new-reference cache)))
(reference-string (org-export-format-reference new)))
;; Cache contains both data already associated to
;; a reference and in-use internal references, so as to make
;; unique references.
(dolist (cell cells) (push (cons cell new) cache))
;; Retain a direct association between reference string and
;; DATUM since (1) not every object or element can be given
;; a search cell (2) it permits quick lookup.
(push (cons reference-string datum) cache)
(plist-put info :internal-references cache)
reference-string))))
(defun org-export-get-ordinal (element info &optional types predicate)
"Return ordinal number of an element or object.
ELEMENT is the element or object considered. INFO is the plist
used as a communication channel.
Optional argument TYPES, when non-nil, is a list of element or
object types, as symbols, that should also be counted in.
Otherwise, only provided element's type is considered.
Optional argument PREDICATE is a function returning a non-nil
value if the current element or object should be counted in. It
accepts two arguments: the element or object being considered and
the plist used as a communication channel. This allows counting
only a certain type of object (i.e. inline images).
Return value is a list of numbers if ELEMENT is a headline or an
item. It is nil for keywords. It represents the footnote number
for footnote definitions and footnote references. If ELEMENT is
a target, return the same value as if ELEMENT was the closest
table, item or headline containing the target. In any other
case, return the sequence number of ELEMENT among elements or
objects of the same type."
;; Ordinal of a target object refer to the ordinal of the closest
;; table, item, or headline containing the object.
(when (org-element-type-p element 'target)
(setq element
(org-element-lineage
element
'(footnote-definition footnote-reference headline item table))))
(cl-case (org-element-type element)
;; Special case 1: A headline returns its number as a list.
(headline (org-export-get-headline-number element info))
;; Special case 2: An item returns its number as a list.
(item (let ((struct (org-element-property :structure element)))
(org-list-get-item-number
(org-element-begin element)
struct
(org-list-prevs-alist struct)
(org-list-parents-alist struct))))
((footnote-definition footnote-reference)
(org-export-get-footnote-number element info))
(otherwise
(let ((counter 0))
;; Increment counter until ELEMENT is found again.
(org-element-map (plist-get info :parse-tree)
(or (and types (cons (org-element-type element) types))
(org-element-type element))
(lambda (el)
(let ((cached (org-element-property :org-export--counter el)))
(cond
((and (eq element el)
(or (not predicate)
(funcall predicate el info)))
(1+ counter))
;; Use cached result.
((and cached
(equal predicate (car cached))
(equal types (cadr cached)))
(setq counter (nth 2 cached))
nil)
((not predicate)
(cl-incf counter)
(org-element-put-property
el :org-export--counter (list predicate types counter))
nil)
((funcall predicate el info)
(cl-incf counter)
(org-element-put-property
el :org-export--counter (list predicate types counter))
nil))))
info 'first-match)))))
;;;; For Raw objects
;;
;; `org-export-raw-string' builds a pseudo-object out of a string
;; that any export backend returns as-is.
;;;###autoload
(defun org-export-raw-string (s)
"Return a raw object containing string S.
A raw string is exported as-is, with no additional processing
from the export backend."
(unless (stringp s) (error "Wrong raw contents type: %S" s))
(org-element-create 'raw nil s))
;;;; For Src-Blocks
;;
;; `org-export-get-loc' counts number of code lines accumulated in
;; src-block or example-block elements with a "+n" switch until
;; a given element, excluded. Note: "-n" switches reset that count.
;;
;; `org-export-unravel-code' extracts source code (along with a code
;; references alist) from an `example-block' or `src-block' type
;; element.
;;
;; `org-export-format-code' applies a formatting function to each line
;; of code, providing relative line number and code reference when
;; appropriate. Since it doesn't access the original element from
;; which the source code is coming, it expects from the code calling
;; it to know if lines should be numbered and if code references
;; should appear.
;;
;; Eventually, `org-export-format-code-default' is a higher-level
;; function (it makes use of the two previous functions) which handles
;; line numbering and code references inclusion, and returns source
;; code in a format suitable for plain text or verbatim output.
(defun org-export-get-loc (element info)
"Return count of lines of code before ELEMENT.
ELEMENT is an example-block or src-block element. INFO is the
plist used as a communication channel.
Count includes every line of code in example-block or src-block
with a \"+n\" or \"-n\" switch before block. Return nil if
ELEMENT doesn't allow line numbering."
(pcase (org-element-property :number-lines element)
(`(new . ,n) n)
(`(continued . ,n)
(let ((loc 0))
(org-element-map (plist-get info :parse-tree) '(src-block example-block)
(lambda (el)
;; ELEMENT is reached: Quit loop and return locs.
(if (eq el element) (+ loc n)
;; Only count lines from src-block and example-block
;; elements with a "+n" or "-n" switch.
(let ((linum (org-element-property :number-lines el)))
(when linum
(let ((lines (org-count-lines
(org-element-property :value el))))
;; Accumulate locs or reset them.
(pcase linum
(`(new . ,n) (setq loc (+ n lines)))
(`(continued . ,n) (cl-incf loc (+ n lines)))))))
nil)) ;Return nil to stay in the loop.
info 'first-match)))))
(defun org-export-unravel-code (element)
"Clean source code and extract references out of it.
ELEMENT has either a `src-block' an `example-block' type.
Return a cons cell whose CAR is the source code, cleaned from any
reference, protective commas and spurious indentation, and CDR is
an alist between relative line number (integer) and name of code
reference on that line (string)."
(let* ((line 0) refs
(value (org-element-property :value element))
;; Remove global indentation from code, if necessary. Also
;; remove final newline character, since it doesn't belongs
;; to the code proper.
(code (replace-regexp-in-string
"\n\\'" ""
(if (org-src-preserve-indentation-p element) value
(org-remove-indentation value))))
;; Build a regexp matching a loc with a reference.
(ref-re (org-src-coderef-regexp (org-src-coderef-format element))))
;; Return value.
(cons
;; Code with references removed.
(mapconcat
(lambda (loc)
(cl-incf line)
(if (not (string-match ref-re loc)) loc
;; Ref line: remove ref, and add its position in REFS.
(push (cons line (match-string 3 loc)) refs)
(replace-match "" nil nil loc 1)))
(split-string code "\n") "\n")
;; Reference alist.
refs)))
(defun org-export-format-code (code fun &optional num-lines ref-alist)
"Format CODE by applying FUN line-wise and return it.
CODE is a string representing the code to format. FUN is
a function. It must accept three arguments: a line of
code (string), the current line number (integer) or nil and the
reference associated to the current line (string) or nil.
Optional argument NUM-LINES can be an integer representing the
number of code lines accumulated until the current code. Line
numbers passed to FUN will take it into account. If it is nil,
FUN's second argument will always be nil. This number can be
obtained with `org-export-get-loc' function.
Optional argument REF-ALIST can be an alist between relative line
number (i.e. ignoring NUM-LINES) and the name of the code
reference on it. If it is nil, FUN's third argument will always
be nil. It can be obtained through the use of
`org-export-unravel-code' function."
(let ((--locs (split-string code "\n"))
(--line 0))
(concat
(mapconcat
(lambda (--loc)
(cl-incf --line)
(let ((--ref (cdr (assq --line ref-alist))))
(funcall fun --loc (and num-lines (+ num-lines --line)) --ref)))
--locs "\n")
"\n")))
(defun org-export-format-code-default (element info)
"Return source code from ELEMENT, formatted in a standard way.
ELEMENT is either a `src-block' or `example-block' element. INFO
is a plist used as a communication channel.
This function takes care of line numbering and code references
inclusion. Line numbers, when applicable, appear at the
beginning of the line, separated from the code by two white
spaces. Code references, on the other hand, appear flushed to
the right, separated by six white spaces from the widest line of
code."
;; Extract code and references.
(let* ((code-info (org-export-unravel-code element))
(code (car code-info))
(code-lines (split-string code "\n")))
(if (null code-lines) ""
(let* ((refs (and (org-element-property :retain-labels element)
(cdr code-info)))
;; Handle line numbering.
(num-start (org-export-get-loc element info))
(num-fmt
(and num-start
(format "%%%ds "
(length (number-to-string
(+ (length code-lines) num-start))))))
;; Prepare references display, if required. Any reference
;; should start six columns after the widest line of code,
;; wrapped with parenthesis.
(max-width
(+ (apply #'max (mapcar #'length code-lines))
(if (not num-start) 0 (length (format num-fmt num-start))))))
(org-export-format-code
code
(lambda (loc line-num ref)
(let ((number-str (and num-fmt (format num-fmt line-num))))
(concat
number-str
loc
(and ref
(concat (make-string (- (+ 6 max-width)
(+ (length loc) (length number-str)))
?\s)
(format "(%s)" ref))))))
num-start refs)))))
;;;; For Tables
;;
;; `org-export-table-has-special-column-p' and
;; `org-export-table-row-is-special-p' are predicates used to look for
;; meta-information about the table structure.
;;
;; `org-export-table-cell-width', `org-export-table-cell-alignment'
;; and `org-export-table-cell-borders' extract information from
;; a table-cell element.
;;
;; `org-export-table-dimensions' gives the number on rows and columns
;; in the table, ignoring horizontal rules and special columns.
;; `org-export-table-cell-address', given a table-cell object, returns
;; the absolute address of a cell. On the other hand,
;; `org-export-get-table-cell-at' does the contrary.
;;
;; `org-export-table-cell-starts-colgroup-p',
;; `org-export-table-cell-ends-colgroup-p',
;; `org-export-table-row-starts-rowgroup-p',
;; `org-export-table-row-ends-rowgroup-p',
;; `org-export-table-row-starts-header-p',
;; `org-export-table-row-ends-header-p' and
;; `org-export-table-row-in-header-p' indicate position of current row
;; or cell within the table.
(defun org-export-table-has-special-column-p (table)
"Non-nil when TABLE has a special column.
All special columns will be ignored during export."
;; The table has a special column when every first cell of every row
;; has an empty value or contains a symbol among "/", "#", "!", "$",
;; "*" "_" and "^". Though, do not consider a first column
;; containing only empty cells as special.
(let ((special-column? 'empty))
(catch 'exit
(dolist (row (org-element-contents table))
(when (eq (org-element-property :type row) 'standard)
(let ((value (org-element-contents
(car (org-element-contents row)))))
(cond ((member value
'(("/") ("#") ("!") ("$") ("*") ("_") ("^")))
(setq special-column? 'special))
((null value))
(t (throw 'exit nil))))))
(eq special-column? 'special))))
(defun org-export-table-has-header-p (table info)
"Non-nil when TABLE has a header.
INFO is a plist used as a communication channel.
A table has a header when it contains at least two row groups."
(let* ((cache (or (plist-get info :table-header-cache)
(let ((table (make-hash-table :test #'eq)))
(plist-put info :table-header-cache table)
table)))
(cached (gethash table cache 'no-cache)))
(if (not (eq cached 'no-cache)) cached
(let ((rowgroup 1) row-flag)
(puthash table
(org-element-map table 'table-row
(lambda (row)
(cond
((> rowgroup 1) t)
((and row-flag
(eq (org-element-property :type row) 'rule))
(cl-incf rowgroup)
(setq row-flag nil))
((and (not row-flag)
(eq (org-element-property :type row) 'standard))
(setq row-flag t)
nil)))
info 'first-match)
cache)))))
(defun org-export-table-row-is-special-p (table-row _)
"Non-nil if TABLE-ROW is considered special."
(when (eq (org-element-property :type table-row) 'standard)
(let ((first-cell (org-element-contents
(car (org-element-contents table-row)))))
;; A row is special either when...
(or
;; ... it starts with a field only containing "/",
(equal first-cell '("/"))
;; ... the table contains a special column and the row start
;; with a marking character among, "^", "_", "$" or "!",
(and (org-export-table-has-special-column-p
(org-element-parent table-row))
(member first-cell '(("^") ("_") ("$") ("!"))))
;; ... it contains only alignment cookies and empty cells.
(let ((special-row-p 'empty))
(catch 'exit
(dolist (cell (org-element-contents table-row))
(let ((value (org-element-contents cell)))
;; Since VALUE is a secondary string, the following
;; checks avoid expanding it with `org-export-data'.
(cond ((not value))
((and (not (cdr value))
(stringp (car value))
(string-match "\\`<[lrc]?\\([0-9]+\\)?>\\'"
(car value)))
(setq special-row-p 'cookie))
(t (throw 'exit nil)))))
(eq special-row-p 'cookie)))))))
(defun org-export-table-row-group (table-row info)
"Return TABLE-ROW's group number, as an integer.
INFO is a plist used as the communication channel.
Return value is the group number, as an integer, or nil for
special rows and rows separators. First group is also table's
header."
(when (eq (org-element-property :type table-row) 'standard)
(let* ((cache (or (plist-get info :table-row-group-cache)
(let ((table (make-hash-table :test #'eq)))
(plist-put info :table-row-group-cache table)
table)))
(cached (gethash table-row cache 'no-cache)))
(if (not (eq cached 'no-cache)) cached
;; First time a row is queried, populate cache with all the
;; rows from the table.
(let ((group 0) row-flag)
(org-element-map (org-element-parent table-row) 'table-row
(lambda (row)
(if (eq (org-element-property :type row) 'rule)
(setq row-flag nil)
(unless row-flag (cl-incf group) (setq row-flag t))
(puthash row group cache)))
info))
(gethash table-row cache)))))
(defun org-export-table-cell-width (table-cell info)
"Return TABLE-CELL contents width.
INFO is a plist used as the communication channel.
Return value is the width given by the last width cookie in the
same column as TABLE-CELL, or nil."
(let* ((row (org-element-parent table-cell))
(table (org-element-parent row))
(cells (org-element-contents row))
(columns (length cells))
(column (- columns (length (memq table-cell cells))))
(cache (or (plist-get info :table-cell-width-cache)
(let ((table (make-hash-table :test #'eq)))
(plist-put info :table-cell-width-cache table)
table)))
(width-vector (or (gethash table cache)
(puthash table (make-vector columns 'empty) cache))))
;; Table rows may not have the same number of cells. Extend
;; WIDTH-VECTOR appropriately if we encounter a row larger than
;; expected.
(when (>= column (length width-vector))
(setq width-vector
(vconcat width-vector
(make-list (- (1+ column) (length width-vector))
'empty)))
(puthash table width-vector cache))
(pcase (aref width-vector column)
(`empty
(catch 'found
(dolist (row (org-element-contents table))
(when (org-export-table-row-is-special-p row info)
;; In a special row, try to find a width cookie at
;; COLUMN. The following checks avoid expanding
;; unnecessarily the cell with `org-export-data'.
(pcase (org-element-contents
(elt (org-element-contents row) column))
(`(,(and (pred stringp) cookie))
(when (string-match "\\`<[lrc]?\\([0-9]+\\)>\\'" cookie)
(let ((w (string-to-number (match-string 1 cookie))))
(throw 'found (aset width-vector column w))))))))
(aset width-vector column nil)))
(value value))))
(defun org-export-table-cell-alignment (table-cell info)
"Return TABLE-CELL contents alignment.
INFO is a plist used as the communication channel.
Return alignment as specified by the last alignment cookie in the
same column as TABLE-CELL. If no such cookie is found, a default
alignment value will be deduced from fraction of numbers in the
column (see `org-table-number-fraction' for more information).
Possible values are `left', `right' and `center'."
;; Load `org-table-number-fraction' and `org-table-number-regexp'.
(require 'org-table)
(let* ((row (org-element-parent table-cell))
(table (org-element-parent row))
(cells (org-element-contents row))
(columns (length cells))
(column (- columns (length (memq table-cell cells))))
(cache (or (plist-get info :table-cell-alignment-cache)
(let ((table (make-hash-table :test #'eq)))
(plist-put info :table-cell-alignment-cache table)
table)))
(align-vector (or (gethash table cache)
(puthash table (make-vector columns nil) cache))))
;; Table rows may not have the same number of cells. Extend
;; ALIGN-VECTOR appropriately if we encounter a row larger than
;; expected.
(when (>= column (length align-vector))
(setq align-vector
(vconcat align-vector
(make-list (- (1+ column) (length align-vector))
nil)))
(puthash table align-vector cache))
(or (aref align-vector column)
(let ((number-cells 0)
(total-cells 0)
cookie-align
previous-cell-number-p)
(dolist (row (org-element-contents (org-element-parent row)))
(cond
;; In a special row, try to find an alignment cookie at
;; COLUMN.
((org-export-table-row-is-special-p row info)
(let ((value (org-element-contents
(elt (org-element-contents row) column))))
;; Since VALUE is a secondary string, the following
;; checks avoid useless expansion through
;; `org-export-data'.
(when (and value
(not (cdr value))
(stringp (car value))
(string-match "\\`<\\([lrc]\\)?\\([0-9]+\\)?>\\'"
(car value))
(match-string 1 (car value)))
(setq cookie-align (match-string 1 (car value))))))
;; Ignore table rules.
((eq (org-element-property :type row) 'rule))
;; In a standard row, check if cell's contents are
;; expressing some kind of number. Increase NUMBER-CELLS
;; accordingly. Though, don't bother if an alignment
;; cookie has already defined cell's alignment.
((not cookie-align)
(let ((value (org-export-data
(org-element-contents
(elt (org-element-contents row) column))
info)))
(cl-incf total-cells)
;; Treat an empty cell as a number if it follows
;; a number.
(if (not (or (string-match org-table-number-regexp value)
(and (string= value "") previous-cell-number-p)))
(setq previous-cell-number-p nil)
(setq previous-cell-number-p t)
(cl-incf number-cells))))))
;; Return value. Alignment specified by cookies has
;; precedence over alignment deduced from cell's contents.
(aset align-vector
column
(cond ((equal cookie-align "l") 'left)
((equal cookie-align "r") 'right)
((equal cookie-align "c") 'center)
((>= (/ (float number-cells) total-cells)
org-table-number-fraction)
'right)
(t 'left)))))))
(defun org-export-table-cell-borders (table-cell info)
"Return TABLE-CELL borders.
INFO is a plist used as a communication channel.
Return value is a list of symbols, or nil. Possible values are:
`top', `bottom', `above', `below', `left' and `right'. Note:
`top' (resp. `bottom') only happen for a cell in the first
row (resp. last row) of the table, ignoring table rules, if any.
Returned borders ignore special rows."
(let* ((row (org-element-parent table-cell))
(table (org-element-lineage table-cell 'table))
borders)
;; Top/above border? TABLE-CELL has a border above when a rule
;; used to demarcate row groups can be found above. Hence,
;; finding a rule isn't sufficient to push `above' in BORDERS:
;; another regular row has to be found above that rule.
(let (rule-flag)
(catch 'exit
;; Look at every row before the current one.
(dolist (row (cdr (memq row (reverse (org-element-contents table)))))
(cond ((eq (org-element-property :type row) 'rule)
(setq rule-flag t))
((not (org-export-table-row-is-special-p row info))
(if rule-flag (throw 'exit (push 'above borders))
(throw 'exit nil)))))
;; No rule above, or rule found starts the table (ignoring any
;; special row): TABLE-CELL is at the top of the table.
(when rule-flag (push 'above borders))
(push 'top borders)))
;; Bottom/below border? TABLE-CELL has a border below when next
;; non-regular row below is a rule.
(let (rule-flag)
(catch 'exit
;; Look at every row after the current one.
(dolist (row (cdr (memq row (org-element-contents table))))
(cond ((eq (org-element-property :type row) 'rule)
(setq rule-flag t))
((not (org-export-table-row-is-special-p row info))
(if rule-flag (throw 'exit (push 'below borders))
(throw 'exit nil)))))
;; No rule below, or rule found ends the table (modulo some
;; special row): TABLE-CELL is at the bottom of the table.
(when rule-flag (push 'below borders))
(push 'bottom borders)))
;; Right/left borders? They can only be specified by column
;; groups. Column groups are defined in a row starting with "/".
;; Also a column groups row only contains "<", "<>", ">" or blank
;; cells.
(catch 'exit
(let ((column (let ((cells (org-element-contents row)))
(- (length cells) (length (memq table-cell cells))))))
;; Table rows are read in reverse order so last column groups
;; row has precedence over any previous one.
(dolist (row (reverse (org-element-contents table)))
(unless (eq (org-element-property :type row) 'rule)
(when (equal (org-element-contents
(car (org-element-contents row)))
'("/"))
(let ((column-groups
(mapcar
(lambda (cell)
(let ((value (org-element-contents cell)))
(when (member value '(("<") ("<>") (">") nil))
(car value))))
(org-element-contents row))))
;; There's a left border when previous cell, if
;; any, ends a group, or current one starts one.
(when (or (and (not (zerop column))
(member (elt column-groups (1- column))
'(">" "<>")))
(member (elt column-groups column) '("<" "<>")))
(push 'left borders))
;; There's a right border when next cell, if any,
;; starts a group, or current one ends one.
(when (or (and (/= (1+ column) (length column-groups))
(member (elt column-groups (1+ column))
'("<" "<>")))
(member (elt column-groups column) '(">" "<>")))
(push 'right borders))
(throw 'exit nil)))))))
;; Return value.
borders))
(defun org-export-table-cell-starts-colgroup-p (table-cell info)
"Non-nil when TABLE-CELL is at the beginning of a column group.
INFO is a plist used as a communication channel."
;; A cell starts a column group either when it is at the beginning
;; of a row (or after the special column, if any) or when it has
;; a left border.
(or (eq (org-element-map (org-element-parent table-cell) 'table-cell
'identity info 'first-match)
table-cell)
(memq 'left (org-export-table-cell-borders table-cell info))))
(defun org-export-table-cell-ends-colgroup-p (table-cell info)
"Non-nil when TABLE-CELL is at the end of a column group.
INFO is a plist used as a communication channel."
;; A cell ends a column group either when it is at the end of a row
;; or when it has a right border.
(or (eq (car (last (org-element-contents
(org-element-parent table-cell))))
table-cell)
(memq 'right (org-export-table-cell-borders table-cell info))))
(defun org-export-table-row-starts-rowgroup-p (table-row info)
"Non-nil when TABLE-ROW is at the beginning of a row group.
INFO is a plist used as a communication channel."
(unless (or (eq (org-element-property :type table-row) 'rule)
(org-export-table-row-is-special-p table-row info))
(let ((borders (org-export-table-cell-borders
(car (org-element-contents table-row)) info)))
(or (memq 'top borders) (memq 'above borders)))))
(defun org-export-table-row-ends-rowgroup-p (table-row info)
"Non-nil when TABLE-ROW is at the end of a row group.
INFO is a plist used as a communication channel."
(unless (or (eq (org-element-property :type table-row) 'rule)
(org-export-table-row-is-special-p table-row info))
(let ((borders (org-export-table-cell-borders
(car (org-element-contents table-row)) info)))
(or (memq 'bottom borders) (memq 'below borders)))))
(defun org-export-table-row-in-header-p (table-row info)
"Non-nil when TABLE-ROW is located within table's header.
INFO is a plist used as a communication channel. Always return
nil for special rows and rows separators."
(and (org-export-table-has-header-p
(org-element-lineage table-row 'table) info)
(eql (org-export-table-row-group table-row info) 1)))
(defun org-export-table-row-starts-header-p (table-row info)
"Non-nil when TABLE-ROW is the first table header's row.
INFO is a plist used as a communication channel."
(and (org-export-table-row-in-header-p table-row info)
(org-export-table-row-starts-rowgroup-p table-row info)))
(defun org-export-table-row-ends-header-p (table-row info)
"Non-nil when TABLE-ROW is the last table header's row.
INFO is a plist used as a communication channel."
(and (org-export-table-row-in-header-p table-row info)
(org-export-table-row-ends-rowgroup-p table-row info)))
(defun org-export-table-row-number (table-row info)
"Return TABLE-ROW number in the exported table.
INFO is a plist used as a communication channel. Return value is
zero-indexed and ignores separators. The function returns nil
when TABLE-ROW is a separator or when it is listed in :ignore-list
property of the INFO plist."
(when (eq (org-element-property :type table-row) 'standard)
(let* ((cache (or (plist-get info :table-row-number-cache)
(let ((table (make-hash-table :test #'eq)))
(plist-put info :table-row-number-cache table)
table)))
(cached (gethash table-row cache 'no-cache)))
(if (not (eq cached 'no-cache)) cached
;; First time a row is queried, populate cache with all the
;; rows from the table.
(let ((number -1))
(org-element-map (org-element-lineage table-row 'table) 'table-row
(lambda (row)
(when (eq (org-element-property :type row) 'standard)
(puthash row (cl-incf number) cache)))
info))
(gethash table-row cache)))))
(defun org-export-table-dimensions (table info)
"Return TABLE dimensions.
INFO is a plist used as a communication channel.
Return value is a CONS like (ROWS . COLUMNS) where
ROWS (resp. COLUMNS) is the number of exportable
rows (resp. columns)."
(let (first-row (columns 0) (rows 0))
;; Set number of rows, and extract first one.
(org-element-map table 'table-row
(lambda (row)
(when (eq (org-element-property :type row) 'standard)
(cl-incf rows)
(unless first-row (setq first-row row))))
info)
;; Set number of columns.
(org-element-map first-row 'table-cell (lambda (_) (cl-incf columns)) info)
;; Return value.
(cons rows columns)))
(defun org-export-table-cell-address (table-cell info)
"Return address of a regular TABLE-CELL object.
TABLE-CELL is the cell considered. INFO is a plist used as
a communication channel.
Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
zero-based index. Only exportable cells are considered. The
function returns nil for other cells."
(let* ((table-row (org-element-parent table-cell))
(row-number (org-export-table-row-number table-row info)))
(when row-number
(cons row-number
(let ((col-count 0))
(org-element-map table-row 'table-cell
(lambda (cell)
(if (eq cell table-cell) col-count (cl-incf col-count) nil))
info 'first-match))))))
(defun org-export-get-table-cell-at (address table info)
"Return regular table-cell object at ADDRESS in TABLE.
Address is a CONS cell (ROW . COLUMN), where ROW and COLUMN are
zero-based index. TABLE is a table type element. INFO is
a plist used as a communication channel.
If no table-cell, among exportable cells, is found at ADDRESS,
return nil."
(let ((column-pos (cdr address)) (column-count 0))
(org-element-map
;; Row at (car address) or nil.
(let ((row-pos (car address)) (row-count 0))
(org-element-map table 'table-row
(lambda (row)
(cond ((eq (org-element-property :type row) 'rule) nil)
((= row-count row-pos) row)
(t (cl-incf row-count) nil)))
info 'first-match))
'table-cell
(lambda (cell)
(if (= column-count column-pos) cell
(cl-incf column-count) nil))
info 'first-match)))
;;;; For Tables of Contents
;;
;; `org-export-collect-headlines' builds a list of all exportable
;; headline elements, maybe limited to a certain depth. One can then
;; easily parse it and transcode it.
;;
;; Building lists of tables, figures or listings is quite similar.
;; Once the generic function `org-export-collect-elements' is defined,
;; `org-export-collect-tables', `org-export-collect-figures' and
;; `org-export-collect-listings' can be derived from it.
;;
;; `org-export-toc-entry-backend' builds a special anonymous backend
;; useful to export table of contents' entries.
(defun org-export-collect-headlines (info &optional n scope)
"Collect headlines in order to build a table of contents.
INFO is a plist used as a communication channel.
When optional argument N is an integer, it specifies the depth of
the table of contents. Otherwise, it is set to the value of the
last headline level. See `org-export-headline-levels' for more
information.
Optional argument SCOPE, when non-nil, is an element. If it is
a headline, only children of SCOPE are collected. Otherwise,
collect children of the headline containing provided element. If
there is no such headline, collect all headlines. In any case,
argument N becomes relative to the level of that headline.
Return a list of all exportable headlines as parsed elements.
Footnote sections are ignored."
(let* ((scope (cond ((not scope) (plist-get info :parse-tree))
((org-element-type-p scope 'headline) scope)
((org-element-lineage scope 'headline))
(t (plist-get info :parse-tree))))
(limit (plist-get info :headline-levels))
(n (if (not (wholenump n)) limit
(min (if (org-element-type-p scope 'org-data) n
(+ (org-export-get-relative-level scope info) n))
limit))))
(org-element-map (org-element-contents scope) 'headline
(lambda (h)
(and (not (org-element-property :footnote-section-p h))
(not (equal "notoc"
(org-export-get-node-property :UNNUMBERED h t)))
(>= n (org-export-get-relative-level h info))
h))
info)))
(defun org-export-collect-elements (type info &optional predicate)
"Collect referenceable elements of a determined type.
TYPE can be a symbol or a list of symbols specifying element
types to search. Only elements with a caption are collected.
INFO is a plist used as a communication channel.
When non-nil, optional argument PREDICATE is a function accepting
one argument, an element of type TYPE. It returns a non-nil
value when that element should be collected.
Return a list of all elements found, in order of appearance."
(org-element-map (plist-get info :parse-tree) type
(lambda (element)
(and (org-element-property :caption element)
(or (not predicate) (funcall predicate element))
element))
info))
(defun org-export-collect-tables (info)
"Build a list of tables.
INFO is a plist used as a communication channel.
Return a list of table elements with a caption."
(org-export-collect-elements 'table info))
(defun org-export-collect-figures (info predicate)
"Build a list of figures.
INFO is a plist used as a communication channel. PREDICATE is
a function which accepts one argument: a paragraph element and
whose return value is non-nil when that element should be
collected.
A figure is a paragraph type element, with a caption, verifying
PREDICATE. The latter has to be provided since a \"figure\" is
a vague concept that may depend on backend.
Return a list of elements recognized as figures."
(org-export-collect-elements 'paragraph info predicate))
(defun org-export-collect-listings (info)
"Build a list of source blocks.
INFO is a plist used as a communication channel.
Return a list of `src-block' elements with a caption."
(org-export-collect-elements 'src-block info))
(defun org-export-excluded-from-toc-p (headline info)
"Non-nil if HEADLINE should be excluded from tables of contents.
INFO is a plist used as a communication channel.
Note that such headlines are already excluded from
`org-export-collect-headlines'. Therefore, this function is not
necessary if you only need to list headlines in the table of
contents. However, it is useful if some additional processing is
required on headlines excluded from table of contents."
(or (org-element-property :footnote-section-p headline)
(org-export-low-level-p headline info)
(equal "notoc" (org-export-get-node-property :UNNUMBERED headline t))))
(defun org-export-toc-entry-backend (parent &rest transcoders)
"Return an export backend appropriate for table of contents entries.
PARENT is an export backend the returned backend should inherit
from.
By default, the backend removes footnote references and targets.
It also changes links and radio targets into regular text.
TRANSCODERS optional argument, when non-nil, specifies additional
transcoders. A transcoder follows the pattern (TYPE . FUNCTION)
where type is an element or object type and FUNCTION the function
transcoding it."
(declare (indent 1))
(org-export-create-backend
:parent parent
:transcoders
(append transcoders
`((footnote-reference . ,#'ignore)
(link . ,(lambda (l c i)
(or c
(org-export-data
(org-element-property :raw-link l)
i))))
(radio-target . ,(lambda (_r c _) c))
(target . ,#'ignore)))))
;;;; Smart Quotes
;;
;; The main function for the smart quotes sub-system is
;; `org-export-activate-smart-quotes', which replaces every quote in
;; a given string from the parse tree with its "smart" counterpart.
;;
;; Dictionary for smart quotes is stored in
;; `org-export-smart-quotes-alist'.
(defcustom org-export-smart-quotes-alist
'(("ar"
(primary-opening
:utf-8 "«" :html "«" :latex "\\guillemotleft{}"
:texinfo "@guillemetleft{}")
(primary-closing
:utf-8 "»" :html "»" :latex "\\guillemotright{}"
:texinfo "@guillemetright{}")
(secondary-opening :utf-8 "‹" :html "‹" :latex "\\guilsinglleft{}"
:texinfo "@guilsinglleft{}")
(secondary-closing :utf-8 "›" :html "›" :latex "\\guilsinglright{}"
:texinfo "@guilsinglright{}")
(apostrophe :utf-8 "’" :html "’"))
("da"
;; one may use: »...«, "...", ›...‹, or '...'.
;; https://sproget.dk/raad-og-regler/retskrivningsregler/retskrivningsregler/a7-40-60/a7-58-anforselstegn/
;; LaTeX quotes require Babel!
(primary-opening
:utf-8 "»" :html "»" :latex ">>" :texinfo "@guillemetright{}")
(primary-closing
:utf-8 "«" :html "«" :latex "<<" :texinfo "@guillemetleft{}")
(secondary-opening
:utf-8 "›" :html "›" :latex "\\frq{}" :texinfo "@guilsinglright{}")
(secondary-closing
:utf-8 "‹" :html "‹" :latex "\\flq{}" :texinfo "@guilsingleft{}")
(apostrophe :utf-8 "’" :html "’"))
("de"
(primary-opening
:utf-8 "„" :html "„" :latex "\"`" :texinfo "@quotedblbase{}")
(primary-closing
:utf-8 "“" :html "“" :latex "\"'" :texinfo "@quotedblleft{}")
(secondary-opening
:utf-8 "‚" :html "‚" :latex "\\glq{}" :texinfo "@quotesinglbase{}")
(secondary-closing
:utf-8 "‘" :html "‘" :latex "\\grq{}" :texinfo "@quoteleft{}")
(apostrophe :utf-8 "’" :html "’"))
("el"
(primary-opening
:utf-8 "«" :html "«" :latex "\\guillemotleft{}"
:texinfo "@guillemetleft{}")
(primary-closing
:utf-8 "»" :html "»" :latex "\\guillemotright{}"
:texinfo "@guillemetright{}")
(secondary-opening :utf-8 "“" :html "“" :latex "``" :texinfo "``")
(secondary-closing :utf-8 "”" :html "”" :latex "''" :texinfo "''")
(apostrophe :utf-8 "’" :html "’"))
("en"
(primary-opening :utf-8 "“" :html "“" :latex "``" :texinfo "``")
(primary-closing :utf-8 "”" :html "”" :latex "''" :texinfo "''")
(secondary-opening :utf-8 "‘" :html "‘" :latex "`" :texinfo "`")
(secondary-closing :utf-8 "’" :html "’" :latex "'" :texinfo "'")
(apostrophe :utf-8 "’" :html "’"))
("es"
(primary-opening
:utf-8 "«" :html "«" :latex "\\guillemotleft{}"
:texinfo "@guillemetleft{}")
(primary-closing
:utf-8 "»" :html "»" :latex "\\guillemotright{}"
:texinfo "@guillemetright{}")
(secondary-opening :utf-8 "“" :html "“" :latex "``" :texinfo "``")
(secondary-closing :utf-8 "”" :html "”" :latex "''" :texinfo "''")
(apostrophe :utf-8 "’" :html "’"))
("fa"
(primary-opening
:utf-8 "«" :html "«" :latex "\\guillemotleft{}"
:texinfo "@guillemetleft{}")
(primary-closing
:utf-8 "»" :html "»" :latex "\\guillemotright{}"
:texinfo "@guillemetright{}")
(secondary-opening :utf-8 "‹" :html "‹" :latex "\\guilsinglleft{}"
:texinfo "@guilsinglleft{}")
(secondary-closing :utf-8 "›" :html "›" :latex "\\guilsinglright{}"
:texinfo "@guilsinglright{}")
(apostrophe :utf-8 "’" :html "’"))
("fr"
(primary-opening
:utf-8 "« " :html "« " :latex "\\og "
:texinfo "@guillemetleft{}@tie{}")
(primary-closing
:utf-8 " »" :html " »" :latex "\\fg{}"
:texinfo "@tie{}@guillemetright{}")
(secondary-opening :utf-8 "“" :html "“" :latex "``" :texinfo "``")
(secondary-closing :utf-8 "”" :html "”" :latex "''" :texinfo "''")
(apostrophe :utf-8 "’" :html "’"))
("is"
(primary-opening
:utf-8 "„" :html "„" :latex "\"`" :texinfo "@quotedblbase{}")
(primary-closing
:utf-8 "“" :html "“" :latex "\"'" :texinfo "@quotedblleft{}")
(secondary-opening
:utf-8 "‚" :html "‚" :latex "\\glq{}" :texinfo "@quotesinglbase{}")
(secondary-closing
:utf-8 "‘" :html "‘" :latex "\\grq{}" :texinfo "@quoteleft{}")
(apostrophe :utf-8 "’" :html "’"))
("it"
(primary-opening :utf-8 "“" :html "“" :latex "``" :texinfo "``")
(primary-closing :utf-8 "”" :html "”" :latex "''" :texinfo "''")
(secondary-opening :utf-8 "‘" :html "‘" :latex "`" :texinfo "`")
(secondary-closing :utf-8 "’" :html "’" :latex "'" :texinfo "'")
(apostrophe :utf-8 "’" :html "’"))
("no"
;; https://nn.wikipedia.org/wiki/Sitatteikn
(primary-opening
:utf-8 "«" :html "«" :latex "\\guillemotleft{}"
:texinfo "@guillemetleft{}")
(primary-closing
:utf-8 "»" :html "»" :latex "\\guillemotright{}"
:texinfo "@guillemetright{}")
(secondary-opening :utf-8 "‘" :html "‘" :latex "`" :texinfo "`")
(secondary-closing :utf-8 "’" :html "’" :latex "'" :texinfo "'")
(apostrophe :utf-8 "’" :html "’"))
("nb"
;; https://nn.wikipedia.org/wiki/Sitatteikn
(primary-opening
:utf-8 "«" :html "«" :latex "\\guillemotleft{}"
:texinfo "@guillemetleft{}")
(primary-closing
:utf-8 "»" :html "»" :latex "\\guillemotright{}"
:texinfo "@guillemetright{}")
(secondary-opening :utf-8 "‘" :html "‘" :latex "`" :texinfo "`")
(secondary-closing :utf-8 "’" :html "’" :latex "'" :texinfo "'")
(apostrophe :utf-8 "’" :html "’"))
("nn"
;; https://nn.wikipedia.org/wiki/Sitatteikn
(primary-opening
:utf-8 "«" :html "«" :latex "\\guillemotleft{}"
:texinfo "@guillemetleft{}")
(primary-closing
:utf-8 "»" :html "»" :latex "\\guillemotright{}"
:texinfo "@guillemetright{}")
(secondary-opening :utf-8 "‘" :html "‘" :latex "`" :texinfo "`")
(secondary-closing :utf-8 "’" :html "’" :latex "'" :texinfo "'")
(apostrophe :utf-8 "’" :html "’"))
("ro"
(primary-opening
:utf-8 "„" :html "„" :latex "\"`" :texinfo "@quotedblbase{}")
(primary-closing :utf-8 "”" :html "”" :latex "''" :texinfo "''")
(secondary-opening
:utf-8 "«" :html "«" :latex "\\guillemotleft{}"
:texinfo "@guillemetleft{}")
(secondary-closing
:utf-8 "»" :html "»" :latex "\\guillemotright{}"
:texinfo "@guillemetright{}")
(apostrophe :utf-8 "’" :html "’"))
("ru"
;; https://ru.wikipedia.org/wiki/%D0%9A%D0%B0%D0%B2%D1%8B%D1%87%D0%BA%D0%B8#.D0.9A.D0.B0.D0.B2.D1.8B.D1.87.D0.BA.D0.B8.2C_.D0.B8.D1.81.D0.BF.D0.BE.D0.BB.D1.8C.D0.B7.D1.83.D0.B5.D0.BC.D1.8B.D0.B5_.D0.B2_.D1.80.D1.83.D1.81.D1.81.D0.BA.D0.BE.D0.BC_.D1.8F.D0.B7.D1.8B.D0.BA.D0.B5
;; https://www.artlebedev.ru/kovodstvo/sections/104/
(primary-opening :utf-8 "«" :html "«" :latex "{}<<"
:texinfo "@guillemetleft{}")
(primary-closing :utf-8 "»" :html "»" :latex ">>{}"
:texinfo "@guillemetright{}")
(secondary-opening
:utf-8 "„" :html "„" :latex "\\glqq{}" :texinfo "@quotedblbase{}")
(secondary-closing
:utf-8 "“" :html "“" :latex "\\grqq{}" :texinfo "@quotedblleft{}")
(apostrophe :utf-8 "’" :html "'"))
("sl"
;; Based on https://sl.wikipedia.org/wiki/Narekovaj
(primary-opening :utf-8 "«" :html "«" :latex "{}<<"
:texinfo "@guillemetleft{}")
(primary-closing :utf-8 "»" :html "»" :latex ">>{}"
:texinfo "@guillemetright{}")
(secondary-opening
:utf-8 "„" :html "„" :latex "\\glqq{}" :texinfo "@quotedblbase{}")
(secondary-closing
:utf-8 "“" :html "“" :latex "\\grqq{}" :texinfo "@quotedblleft{}")
(apostrophe :utf-8 "’" :html "’"))
("sv"
;; Based on https://sv.wikipedia.org/wiki/Citattecken
(primary-opening :utf-8 "”" :html "”" :latex "’’" :texinfo "’’")
(primary-closing :utf-8 "”" :html "”" :latex "’’" :texinfo "’’")
(secondary-opening :utf-8 "’" :html "’" :latex "’" :texinfo "`")
(secondary-closing :utf-8 "’" :html "’" :latex "’" :texinfo "'")
(apostrophe :utf-8 "’" :html "’")))
"Smart quotes translations.
Alist whose CAR is a language string and CDR is an alist with
quote type as key and a plist associating various encodings to
their translation as value.
A quote type can be any symbol among `primary-opening',
`primary-closing', `secondary-opening', `secondary-closing' and
`apostrophe'.
Valid encodings include `:utf-8', `:html', `:latex' and
`:texinfo'.
If no translation is found, the quote character is left as-is."
:group 'org-export-general
:package-version '(Org . "9.7")
:type '(alist
:key-type
(string :tag "Language name")
:value-type
(alist
:key-type
(choice
(const :tag "Primary opening" primary-opening)
(const :tag "Primary closing" primary-closing)
(const :tag "Secondary opening" secondary-opening)
(const :tag "Secondary closing" secondary-closing)
(const :tag "Apostrophe" apostrophe))
:value-type
(plist
:key-type
(choice
(const :tag "UTF-8 ASCII translation" :utf-8)
(const :tag "HTML translation" :html)
(const :tag "LaTeX translation" :latex)
(const :tag "TeXInfo translation" :texinfo))
:value-type string))))
(defun org-export--smart-quote-status (s info)
"Return smart quote status at the beginning of string S.
INFO is the current export state, as a plist."
(let* ((parent (org-element-parent s))
(cache (or (plist-get info :smart-quote-cache)
(let ((table (make-hash-table :test #'eq)))
(plist-put info :smart-quote-cache table)
table)))
(value (gethash (cons parent (org-element-secondary-p s)) cache 'missing-data)))
(if (not (eq value 'missing-data)) (cdr (assq s value))
(let (level1-open full-status)
(org-element-map
(let ((secondary (org-element-secondary-p s)))
(if secondary (org-element-property secondary parent)
(org-element-contents parent)))
'plain-text
(lambda (text)
(let ((start 0) current-status)
(while (setq start (string-match "['\"]" text start))
(push
(cond
((equal (match-string 0 text) "\"")
(setf level1-open (not level1-open))
(if level1-open 'primary-opening 'primary-closing))
;; Not already in a level 1 quote: this is an
;; apostrophe.
((not level1-open) 'apostrophe)
;; Extract previous char and next char. As
;; a special case, they can also be set to `blank',
;; `no-blank' or nil. Then determine if current
;; match is allowed as an opening quote or a closing
;; quote.
(t
(let* ((previous
(if (> start 0) (substring text (1- start) start)
(let ((p (org-export-get-previous-element
text info)))
(cond ((not p) nil)
((stringp p) (substring p -1))
((memq (org-element-post-blank p)
'(0 nil))
'no-blank)
(t 'blank)))))
(next
(if (< (1+ start) (length text))
(substring text (1+ start) (+ start 2))
(let ((n (org-export-get-next-element text info)))
(cond ((not n) nil)
((stringp n) (substring n 0 1))
(t 'no-blank)))))
(allow-open
(and (if (stringp previous)
(string-match "\\s\"\\|\\s-\\|\\s("
previous)
(memq previous '(blank nil)))
(if (stringp next)
(string-match "\\w\\|\\s.\\|\\s_" next)
(eq next 'no-blank))))
(allow-close
(and (if (stringp previous)
(string-match "\\w\\|\\s.\\|\\s_" previous)
(eq previous 'no-blank))
(if (stringp next)
(string-match "\\s-\\|\\s)\\|\\s.\\|\\s\""
next)
(memq next '(blank nil))))))
(cond
((and allow-open allow-close) (error "Should not happen"))
(allow-open 'secondary-opening)
(allow-close 'secondary-closing)
(t 'apostrophe)))))
current-status)
(cl-incf start))
(when current-status
(push (cons text (nreverse current-status)) full-status))))
info nil org-element-recursive-objects)
;; When quotes are not balanced, treat them as apostrophes.
(setq full-status (nreverse full-status))
(let (primary-openings secondary-openings)
(dolist (substatus full-status)
(let ((status (cdr substatus)))
(while status
(pcase (car status)
(`apostrophe nil)
(`primary-opening
(push status primary-openings))
(`secondary-opening
(push status secondary-openings))
(`secondary-closing
(if secondary-openings
;; Remove matched opening.
(pop secondary-openings)
;; No matching openings for a given closing. Replace
;; it with apostrophe.
(setcar status 'apostrophe)))
(`primary-closing
(when secondary-openings
;; Some secondary opening quotes are not closed
;; within "...". Replace them all with apostrophes.
(dolist (opening secondary-openings)
(setcar opening 'apostrophe))
(setq secondary-openings nil))
(if primary-openings
;; Remove matched opening.
(pop primary-openings)
;; No matching openings for a given closing.
(error "This should no happen"))))
(setq status (cdr status)))))
(when primary-openings
;; Trailing unclosed "
(unless (= 1 (length primary-openings))
(error "This should not happen"))
;; Mark for not replacing.
(setcar (car primary-openings) nil)
;; Mark all the secondary openings and closings after
;; trailing unclosed " as apostrophes.
(let ((after-unbalanced-primary nil))
(dolist (substatus full-status)
(let ((status (cdr substatus)))
(while status
(when (eq status (car primary-openings))
(setq after-unbalanced-primary t))
(when after-unbalanced-primary
(when (memq (car status) '(secondary-opening secondary-closing))
(setcar status 'apostrophe)))
(setq status (cdr status))))))))
(puthash (cons parent (org-element-secondary-p s)) full-status cache)
(cdr (assq s full-status))))))
(defun org-export-activate-smart-quotes (s encoding info &optional original)
"Replace regular quotes with \"smart\" quotes in string S.
ENCODING is a symbol among `:html', `:latex', `:texinfo' and
`:utf-8'. INFO is a plist used as a communication channel.
The function has to retrieve information about string
surroundings in parse tree. It can only happen with an
unmodified string. Thus, if S has already been through another
process, a non-nil ORIGINAL optional argument will provide that
original string.
Return the new string."
(let ((quote-status
(copy-sequence (org-export--smart-quote-status (or original s) info))))
(replace-regexp-in-string
"['\"]"
(lambda (match)
(or (plist-get
(cdr (assq (pop quote-status)
(cdr (assoc (plist-get info :language)
org-export-smart-quotes-alist))))
encoding)
match))
s nil t)))
;;;; Topology
;;
;; Here are various functions to retrieve information about the
;; neighborhood of a given element or object. Neighbors of interest
;; are parent headline (`org-export-get-parent-headline'), first
;; element containing an object, (`org-element-parent-element'),
;; parent table (`org-export-get-parent-table'), previous element or
;; object (`org-export-get-previous-element') and next element or
;; object (`org-export-get-next-element').
(defun org-export-get-parent-headline (blob)
"Return BLOB parent headline or nil.
BLOB is the element or object being considered."
(org-element-lineage blob 'headline))
(defun org-export-get-parent-table (object)
"Return OBJECT parent table or nil.
OBJECT is either a `table-cell' or `table-element' type object."
(org-element-lineage object 'table))
(defun org-export-get-previous-element (blob info &optional n)
"Return previous element or object.
BLOB is an element or object. INFO is a plist used as
a communication channel. Return previous exportable element or
object, a string, or nil.
When optional argument N is a positive integer, return a list
containing up to N siblings before BLOB, from farthest to
closest. With any other non-nil value, return a list containing
all of them."
(let* ((secondary (org-element-secondary-p blob))
(parent (org-element-parent blob))
(siblings
(if secondary (org-element-property secondary parent)
(org-element-contents parent)))
prev)
(catch 'exit
(dolist (obj (cdr (memq blob (reverse siblings))) prev)
(cond ((memq obj (plist-get info :ignore-list)))
((null n) (throw 'exit obj))
((not (wholenump n)) (push obj prev))
((zerop n) (throw 'exit prev))
(t (cl-decf n) (push obj prev)))))))
(defun org-export-get-next-element (blob info &optional n)
"Return next element or object.
BLOB is an element or object. INFO is a plist used as
a communication channel. Return next exportable element or
object, a string, or nil.
When optional argument N is a positive integer, return a list
containing up to N siblings after BLOB, from closest to farthest.
With any other non-nil value, return a list containing all of
them."
(let* ((secondary (org-element-secondary-p blob))
(parent (org-element-parent blob))
(siblings
(cdr (memq blob
(if secondary (org-element-property secondary parent)
(org-element-contents parent)))))
next)
(catch 'exit
(dolist (obj siblings (nreverse next))
(cond ((memq obj (plist-get info :ignore-list)))
((null n) (throw 'exit obj))
((not (wholenump n)) (push obj next))
((zerop n) (throw 'exit (nreverse next)))
(t (cl-decf n) (push obj next)))))))
;;;; Translation
;;
;; `org-export-translate' translates a string according to the language
;; specified by the LANGUAGE keyword. `org-export-dictionary' contains
;; the dictionary used for the translation.
(defconst org-export-dictionary
'(("%e %n: %c"
("fr" :default "%e %n : %c" :html "%e %n : %c"))
("Author"
("ar" :default "تأليف")
("ca" :default "Autor")
("cs" :default "Autor")
("da" :default "Forfatter")
("de" :default "Autor")
("eo" :html "Aŭtoro")
("es" :default "Autor")
("et" :default "Autor")
("fa" :default "نویسنده")
("fi" :html "Tekijä")
("fr" :default "Auteur")
("hu" :default "Szerzõ")
("is" :html "Höfundur")
("it" :default "Autore")
("ja" :default "著者" :html "著者")
("nl" :default "Auteur")
("no" :default "Forfatter")
("nb" :default "Forfatter")
("nn" :default "Forfattar")
("pl" :default "Autor")
("pt_BR" :default "Autor")
("ro" :default "Autor")
("ru" :html "Автор" :utf-8 "Автор")
("sl" :default "Avtor")
("sv" :default "Författare")
("tr" :default "Yazar")
("uk" :html "Автор" :utf-8 "Автор")
("zh-CN" :html "作者" :utf-8 "作者")
("zh-TW" :html "作者" :utf-8 "作者"))
("Continued from previous page"
("ar" :default "تتمة الصفحة السابقة")
("cs" :default "Pokračování z předchozí strany")
("de" :default "Fortsetzung von vorheriger Seite")
("es" :html "Continúa de la página anterior" :ascii "Continua de la pagina anterior" :default "Continúa de la página anterior")
("et" :default "Jätk eelmisele leheküljele" :html "Jätk eelmisele leheküljele" :utf-8 "Jätk eelmisele leheküljele")
("fa" :default "ادامه از صفحهٔ قبل")
("fr" :default "Suite de la page précédente")
("it" :default "Continua da pagina precedente")
("ja" :default "前ページからの続き")
("nl" :default "Vervolg van vorige pagina")
("nn" :default "Held fram frå førre side")
("pl" :default "Ciąg dalszy poprzedniej strony")
("pt" :default "Continuação da página anterior")
("pt_BR" :html "Continuação da página anterior" :ascii "Continuacao da pagina anterior" :default "Continuação da página anterior")
("ro" :default "Continuare de pe pagina precedentă")
("ru" :html "(Продолжение)"
:utf-8 "(Продолжение)")
("sl" :default "Nadaljevanje s prejšnje strani")
("sv" :default "Fortsättning från föregående sida")
("tr" :default "Önceki sayfadan devam ediyor"))
("Continued on next page"
("ar" :default "التتمة في الصفحة التالية")
("cs" :default "Pokračuje na další stránce")
("de" :default "Fortsetzung nächste Seite")
("es" :html "Continúa en la siguiente página" :ascii "Continua en la siguiente pagina" :default "Continúa en la siguiente página")
("et" :default "Jätkub järgmisel leheküljel" :html "Jätkub järgmisel leheküljel" :utf-8 "Jätkub järgmisel leheküljel")
("fa" :default "ادامه در صفحهٔ بعد")
("fr" :default "Suite page suivante")
("it" :default "Continua alla pagina successiva")
("ja" :default "次ページに続く")
("nl" :default "Vervolg op volgende pagina")
("nn" :default "Held fram på neste side")
("pl" :default "Ciąg dalszy na następnej stronie")
("pt" :default "Continua na página seguinte")
("pt_BR" :html "Continua na próxima página" :ascii "Continua na proxima pagina" :default "Continua na próxima página")
("ro" :default "Continuare pe pagina următoare")
("ru" :html "(Продолжение следует)"
:utf-8 "(Продолжение следует)")
("sl" :default "Nadaljevanje na naslednji strani")
("sv" :default "Fortsätter på nästa sida")
("tr" :default "Devamı sonraki sayfada"))
("Created"
("cs" :default "Vytvořeno")
("et" :default "Loodud")
("fa" :default "ساخته شده")
("nl" :default "Gemaakt op") ;; must be followed by a date or date+time
("nn" :default "Oppretta")
("pl" :default "Wygenerowano o") ; must be followed by a date or date+time
("pt_BR" :default "Criado em")
("ro" :default "Creat")
("sl" :default "Ustvarjeno")
("sv" :default "Skapat")
("tr" :default "Oluşturuldu"))
("Date"
("ar" :default "بتاريخ")
("ca" :default "Data")
("cs" :default "Datum")
("da" :default "Dato")
("de" :default "Datum")
("eo" :default "Dato")
("es" :default "Fecha")
("et" :default "Kuupäev" :html "Kuupäev" :utf-8 "Kuupäev")
("fa" :default "تاریخ")
("fi" :html "Päivämäärä")
("hu" :html "Dátum")
("is" :default "Dagsetning")
("it" :default "Data")
("ja" :default "日付" :html "日付")
("nl" :default "Datum")
("no" :default "Dato")
("nb" :default "Dato")
("nn" :default "Dato")
("pl" :default "Data")
("ro" :default "Data")
("pt_BR" :default "Data")
("ru" :html "Дата" :utf-8 "Дата")
("sl" :default "Datum")
("sv" :default "Datum")
("tr" :default "Tarih")
("uk" :html "Дата" :utf-8 "Дата")
("zh-CN" :html "日期" :utf-8 "日期")
("zh-TW" :html "日期" :utf-8 "日期"))
("Equation"
("ar" :default "معادلة")
("cs" :default "Rovnice")
("da" :default "Ligning")
("de" :default "Gleichung")
("es" :ascii "Ecuacion" :html "Ecuación" :default "Ecuación")
("et" :default "Võrrand" :html "Võrrand" :utf-8 "Võrrand")
("fa" :default "معادله")
("fr" :ascii "Equation" :default "Équation")
("is" :default "Jafna")
("ja" :default "方程式")
("nl" :default "Vergelijking")
("no" :default "Ligning")
("nb" :default "Ligning")
("nn" :default "Likning")
("pl" :default "Równanie" :ascii "Rownanie")
("pt_BR" :html "Equação" :default "Equação" :ascii "Equacao")
("ro" :default "Ecuația")
("ru" :html "Уравнение"
:utf-8 "Уравнение")
("sl" :default "Enačba")
("sv" :default "Ekvation")
("tr" :default "Eşitlik")
("zh-CN" :html "方程" :utf-8 "方程"))
("Figure"
("ar" :default "شكل")
("cs" :default "Obrázek")
("da" :default "Figur")
("de" :default "Abbildung")
("es" :default "Figura")
("et" :default "Joonis")
("fa" :default "شکل")
("is" :default "Mynd")
("it" :default "Figura")
("ja" :default "図" :html "図")
("nl" :default "Figuur")
("no" :default "Illustrasjon")
("nb" :default "Illustrasjon")
("nn" :default "Illustrasjon")
("pl" :default "Obrazek") ; alternativly "Rysunek"
("pt_BR" :default "Figura")
("ro" :default "Imaginea")
("ru" :html "Рисунок" :utf-8 "Рисунок")
("sv" :default "Illustration")
("tr" :default "Şekil")
("zh-CN" :html "图" :utf-8 "图"))
("Figure %d:"
("ar" :default "شكل %d:")
("cs" :default "Obrázek %d:")
("da" :default "Figur %d")
("de" :default "Abbildung %d:")
("es" :default "Figura %d:")
("et" :default "Joonis %d:")
("fa" :default "شکل %d:")
("fr" :default "Figure %d :" :html "Figure %d :")
("is" :default "Mynd %d")
("it" :default "Figura %d:")
("ja" :default "図%d: " :html "図%d: ")
("nl" :default "Figuur %d:" :html "Figuur %d:")
("no" :default "Illustrasjon %d")
("nb" :default "Illustrasjon %d")
("nn" :default "Illustrasjon %d")
("pl" :default "Obrazek %d") ; alternativly "Rysunek %d"
("pt_BR" :default "Figura %d:")
("ro" :default "Imaginea %d:")
("ru" :html "Рис. %d.:" :utf-8 "Рис. %d.:")
("sl" :default "Slika %d")
("sv" :default "Illustration %d")
("tr" :default "Şekil %d:")
("zh-CN" :html "图%d " :utf-8 "图%d "))
("Footnotes"
("ar" :default "الهوامش")
("ca" :html "Peus de pàgina")
("cs" :default "Poznámky pod čarou")
("da" :default "Fodnoter")
("de" :html "Fußnoten" :default "Fußnoten")
("eo" :default "Piednotoj")
("es" :ascii "Notas al pie de pagina" :html "Notas al pie de página" :default "Notas al pie de página")
("et" :default "Allmärkused" :html "Allmärkused" :utf-8 "Allmärkused")
("fa" :default "پانوشتها")
("fi" :default "Alaviitteet")
("fr" :default "Notes de bas de page")
("hu" :html "Lábjegyzet")
("is" :html "Aftanmálsgreinar")
("it" :html "Note a piè di pagina")
("ja" :default "脚注" :html "脚注")
("nl" :default "Voetnoten")
("no" :default "Fotnoter")
("nb" :default "Fotnoter")
("nn" :default "Fotnotar")
("pl" :default "Przypis")
("pt_BR" :html "Notas de Rodapé" :default "Notas de Rodapé" :ascii "Notas de Rodape")
("ro" :default "Note de subsol")
("ru" :html "Сноски" :utf-8 "Сноски")
("sl" :default "Opombe")
("sv" :default "Fotnoter")
("tr" :default "Dipnotlar")
("uk" :html "Примітки"
:utf-8 "Примітки")
("zh-CN" :html "脚注" :utf-8 "脚注")
("zh-TW" :html "腳註" :utf-8 "腳註"))
("List of Listings"
("ar" :default "قائمة بالبرامج")
("cs" :default "Seznam programů")
("da" :default "Programmer")
("de" :default "Programmauflistungsverzeichnis")
("es" :ascii "Indice de Listados de programas" :html "Índice de Listados de programas" :default "Índice de Listados de programas")
("et" :default "Loendite nimekiri")
("fa" :default "فهرست برنامهریزیها")
("fr" :default "Liste des programmes")
("ja" :default "ソースコード目次")
("nl" :default "Lijst van programma's")
("nn" :default "Programliste")
("no" :default "Dataprogrammer")
("nb" :default "Dataprogrammer")
("pl" :default "Indeks") ; probably too vague but better than nothing
("pt_BR" :html "Índice de Listagens" :default "Índice de Listagens" :ascii "Indice de Listagens")
("ru" :html "Список распечаток"
:utf-8 "Список распечаток")
("sl" :default "Seznam programskih izpisov")
("sv" :default "Programlistningar")
("tr" :default "Program Listesi")
("zh-CN" :html "代码目录" :utf-8 "代码目录"))
("List of Tables"
("ar" :default "قائمة بالجداول")
("cs" :default "Seznam tabulek")
("da" :default "Tabeller")
("de" :default "Tabellenverzeichnis")
("es" :ascii "Indice de tablas" :html "Índice de tablas" :default "Índice de tablas")
("et" :default "Tabelite nimekiri")
("fa" :default "فهرست جدولها")
("fr" :default "Liste des tableaux")
("is" :default "Töfluskrá" :html "Töfluskrá")
("it" :default "Indice delle tabelle")
("ja" :default "表目次")
("nl" :default "Lijst van tabellen")
("no" :default "Tabeller")
("nb" :default "Tabeller")
("nn" :default "Tabeller")
("pl" :default "Indeks tabel")
("pt_BR" :html "Índice de Tabelas" :default "Índice de Tabelas" :ascii "Indice de Tabelas")
("ro" :default "Tabele")
("ru" :html "Список таблиц"
:utf-8 "Список таблиц")
("sl" :default "Seznam tabel")
("sv" :default "Tabeller")
("tr" :default "Tablo Listesi")
("zh-CN" :html "表格目录" :utf-8 "表格目录"))
("Listing"
("ar" :default "برنامج")
("cs" :default "Program")
("da" :default "Program")
("de" :default "Programmlisting")
("es" :default "Listado de programa")
("et" :default "Loend")
("fa" :default "برنامهریزی")
("fr" :default "Programme" :html "Programme")
("it" :default "Listato")
("ja" :default "ソースコード")
("nl" :default "Programma")
("nn" :default "Program")
("no" :default "Dataprogram")
("nb" :default "Dataprogram")
("pl" :default "Indeks")
("pt_BR" :default "Listagem")
("ro" :default "Lista")
("ru" :html "Распечатка"
:utf-8 "Распечатка")
("sl" :default "Izpis programa")
("sv" :default "Programlistning")
("tr" :default "Program")
("zh-CN" :html "代码" :utf-8 "代码"))
("Listing %d:"
("ar" :default "برنامج %d:")
("cs" :default "Program %d:")
("da" :default "Program %d")
("de" :default "Programmlisting %d")
("es" :default "Listado de programa %d")
("et" :default "Loend %d")
("fa" :default "برنامهریزی %d:")
("fr" :default "Programme %d :" :html "Programme %d :")
("it" :default "Listato %d :")
("ja" :default "ソースコード%d:")
("nl" :default "Programma %d:" :html "Programma %d:")
("nn" :default "Program %d:")
("no" :default "Dataprogram %d")
("nb" :default "Dataprogram %d")
("ro" :default "Lista %d")
("pl" :default "Indeks %d:")
("pt_BR" :default "Listagem %d:")
("ru" :html "Распечатка %d.:"
:utf-8 "Распечатка %d.:")
("sl" :default "Izpis programa %d")
("sv" :default "Programlistning %d:")
("tr" :default "Program %d:")
("zh-CN" :html "代码%d " :utf-8 "代码%d "))
("References"
("ar" :default "المراجع")
("cs" :default "Reference")
("de" :default "Quellen")
("es" :default "Referencias")
("et" :default "Viited")
("fa" :default "منابع")
("fr" :ascii "References" :default "Références")
("it" :default "Riferimenti")
("nl" :default "Bronverwijzingen")
("nn" :default "Kjelder")
("pl" :default "Odwołania") ; could be "Referencje" but I think its too englishy
("pt_BR" :html "Referências" :default "Referências" :ascii "Referencias")
("ro" :default "Bibliografie")
("sl" :default "Reference")
("sv" :default "Referenser")
("tr" :default "Referanslar"))
("See figure %s"
("cs" :default "Viz obrázek %s")
("et" :default "Vaata joonist %s")
("fa" :default "نمایش شکل %s")
("fr" :default "cf. figure %s"
:html "cf. figure %s" :latex "cf.~figure~%s")
("it" :default "Vedi figura %s")
("nl" :default "Zie figuur %s"
:html "Zie figuur %s" :latex "Zie figuur~%s")
("nn" :default "Sjå figur %s")
("pl" :default "Patrz obrazek %s") ; alternativly "Patrz rysunek %s"
("pt_BR" :default "Veja a figura %s")
("ro" :default "Vezi figura %s")
("sl" :default "Glej sliko %s")
("sv" :default "Se illustration %s")
("tr" :default "bkz. şekil %s"))
("See listing %s"
("cs" :default "Viz program %s")
("et" :default "Vaata loendit %s")
("fa" :default "نمایش برنامهریزی %s")
("fr" :default "cf. programme %s"
:html "cf. programme %s" :latex "cf.~programme~%s")
("nl" :default "Zie programma %s"
:html "Zie programma %s" :latex "Zie programma~%s")
("nn" :default "Sjå program %s")
("pl" :default "Patrz indeks %s")
("pt_BR" :default "Veja a listagem %s")
("ro" :default "Vezi tabelul %s")
("sl" :default "Glej izpis programa %s")
("sv" :default "Se programlistning %s")
("tr" :default "bkz. program %s"))
("See section %s"
("ar" :default "انظر قسم %s")
("cs" :default "Viz sekce %s")
("da" :default "jævnfør afsnit %s")
("de" :default "siehe Abschnitt %s")
("es" :ascii "Vea seccion %s" :html "Vea sección %s" :default "Vea sección %s")
("et" :default "Vaata peatükki %s" :html "Vaata peatükki %s" :utf-8 "Vaata peatükki %s")
("fa" :default "نمایش بخش %s")
("fr" :default "cf. section %s")
("it" :default "Vedi sezione %s")
("ja" :default "セクション %s を参照")
("nl" :default "Zie sectie %s"
:html "Zie sectie %s" :latex "Zie sectie~%s")
("nn" :default "Sjå del %s")
("pl" :default "Patrz sekcja %s") ; seems rough
("pt_BR" :html "Veja a seção %s" :default "Veja a seção %s"
:ascii "Veja a secao %s")
("ro" :default "Vezi secțiunea %s")
("ru" :html "См. раздел %s"
:utf-8 "См. раздел %s")
("sl" :default "Glej poglavje %d")
("sv" :default "Se avsnitt %s")
("tr" :default "bkz. bölüm %s")
("zh-CN" :html "参见第%s节" :utf-8 "参见第%s节"))
("See table %s"
("cs" :default "Viz tabulka %s")
("et" :default "Vaata tabelit %s")
("fa" :default "نمایش جدول %s")
("fr" :default "cf. tableau %s"
:html "cf. tableau %s" :latex "cf.~tableau~%s")
("it" :default "Vedi tabella %s")
("nl" :default "Zie tabel %s"
:html "Zie tabel %s" :latex "Zie tabel~%s")
("nn" :default "Sjå tabell %s")
("pl" :default "Patrz tabela %s")
("pt_BR" :default "Veja a tabela %s")
("ro" :default "Vezi tabelul %s")
("sl" :default "Glej tabelo %s")
("sv" :default "Se tabell %s")
("tr" :default "bkz. tablo %s"))
("Table"
("ar" :default "جدول")
("cs" :default "Tabulka")
("de" :default "Tabelle")
("es" :default "Tabla")
("et" :default "Tabel")
("fa" :default "جدول")
("fr" :default "Tableau")
("is" :default "Tafla")
("it" :default "Tabella")
("ja" :default "表" :html "表")
("nl" :default "Tabel")
("nn" :default "Tabell")
("pl" :default "Tabela")
("pt_BR" :default "Tabela")
("ro" :default "Tabel")
("ru" :html "Таблица"
:utf-8 "Таблица")
("sv" :default "Tabell")
("tr" :default "Tablo")
("zh-CN" :html "表" :utf-8 "表"))
("Table %d:"
("ar" :default "جدول %d:")
("cs" :default "Tabulka %d:")
("da" :default "Tabel %d")
("de" :default "Tabelle %d")
("es" :default "Tabla %d")
("et" :default "Tabel %d")
("fa" :default "جدول %d")
("fr" :default "Tableau %d :")
("is" :default "Tafla %d")
("it" :default "Tabella %d:")
("ja" :default "表%d:" :html "表%d:")
("nl" :default "Tabel %d:" :html "Tabel %d:")
("no" :default "Tabell %d")
("nb" :default "Tabell %d")
("nn" :default "Tabell %d")
("pl" :default "Tabela %d")
("pt_BR" :default "Tabela %d:")
("ro" :default "Tabel %d")
("ru" :html "Таблица %d.:"
:utf-8 "Таблица %d.:")
("sl" :default "Tabela %d")
("sv" :default "Tabell %d:")
("tr" :default "Tablo %d")
("zh-CN" :html "表%d " :utf-8 "表%d "))
("Table of Contents"
("ar" :default "قائمة المحتويات")
("ca" :html "Índex")
("cs" :default "Obsah")
("da" :default "Indhold")
("de" :default "Inhaltsverzeichnis")
("eo" :default "Enhavo")
("es" :ascii "Indice" :html "Índice" :default "Índice")
("et" :default "Sisukord")
("fa" :default "فهرست")
("fi" :html "Sisällysluettelo")
("fr" :ascii "Sommaire" :default "Table des matières")
("hu" :html "Tartalomjegyzék")
("is" :default "Efnisyfirlit")
("it" :default "Indice")
("ja" :default "目次" :html "目次")
("nl" :default "Inhoudsopgave")
("no" :default "Innhold")
("nb" :default "Innhold")
("nn" :default "Innhald")
("pl" :default "Spis treści" :html "Spis treści")
("pt_BR" :html "Índice" :utf-8 "Índice" :ascii "Indice")
("ro" :default "Cuprins")
("ru" :html "Содержание"
:utf-8 "Содержание")
("sl" :default "Kazalo")
("sv" :default "Innehåll")
("tr" :default "İçindekiler")
("uk" :html "Зміст" :utf-8 "Зміст")
("zh-CN" :html "目录" :utf-8 "目录")
("zh-TW" :html "目錄" :utf-8 "目錄"))
("Unknown reference"
("ar" :default "مرجع غير معرّف")
("da" :default "ukendt reference")
("de" :default "Unbekannter Verweis")
("es" :default "Referencia desconocida")
("et" :default "Tundmatu viide")
("fa" :default "منبع ناشناس")
("fr" :ascii "Destination inconnue" :default "Référence inconnue")
("it" :default "Riferimento sconosciuto")
("ja" :default "不明な参照先")
("nl" :default "Onbekende verwijzing")
("nn" :default "Ukjend kjelde")
("pl" :default "Nieznane odwołanie") ; alternatively "Nieokreślone odwołanie"
("pt_BR" :html "Referência desconhecida" :default "Referência desconhecida" :ascii "Referencia desconhecida")
("ro" :default "Referință necunoscută")
("ru" :html "Неизвестная ссылка"
:utf-8 "Неизвестная ссылка")
("sl" :default "Neznana referenca")
("sv" :default "Okänd referens")
("tr" :default "Bilinmeyen referans")
("zh-CN" :html "未知引用" :utf-8 "未知引用")))
"Dictionary for export engine.
Alist whose car is the string to translate and cdr is an alist
whose car is the language string and cdr is a plist whose
properties are possible charsets and values translated terms.
It is used as a database for `org-export-translate'. Since this
function returns the string as-is if no translation was found,
the variable only needs to record values different from the
entry.")
(defun org-export-translate (s encoding info)
"Translate string S according to language specification.
ENCODING is a symbol among `:ascii', `:html', `:latex', `:latin1'
and `:utf-8'. INFO is a plist used as a communication channel.
Translation depends on `:language' property. Return the
translated string. If no translation is found, try to fall back
to `:default' encoding. If it fails, return S."
(let* ((lang (plist-get info :language))
(translations (cdr (assoc lang
(cdr (assoc s org-export-dictionary))))))
(or (plist-get translations encoding)
(plist-get translations :default)
s)))
\f
;;; Asynchronous Export
;;
;; `org-export-async-start' is the entry point for asynchronous
;; export. It recreates current buffer (including visibility,
;; narrowing and visited file) in an external Emacs process, and
;; evaluates a command there. It then applies a function on the
;; returned results in the current process.
;;
;; At a higher level, `org-export-to-buffer' and `org-export-to-file'
;; allow exporting to a buffer or a file, asynchronously or not.
;;
;; `org-export-output-file-name' is an auxiliary function meant to be
;; used with `org-export-to-file'. With a given extension, it tries
;; to provide a canonical file name to write export output to.
;;
;; Asynchronously generated results are never displayed directly.
;; Instead, they are stored in `org-export-stack-contents'. They can
;; then be retrieved by calling `org-export-stack'.
;;
;; Export Stack is viewed through a dedicated major mode
;;`org-export-stack-mode' and tools: `org-export-stack-refresh',
;;`org-export-stack-remove', `org-export-stack-view' and
;;`org-export-stack-clear'.
;;
;; For backends, `org-export-add-to-stack' add a new source to stack.
;; It should be used whenever `org-export-async-start' is called.
(defun org-export-async-start (fun body)
"Call function FUN on the results returned by BODY evaluation.
FUN is an anonymous function of one argument. BODY should be a valid
ELisp source expression. BODY evaluation happens in an asynchronous process,
from a buffer which is an exact copy of the current one.
Use `org-export-add-to-stack' in FUN in order to register results
in the stack.
This is a low level function. See also `org-export-to-buffer'
and `org-export-to-file' for more specialized functions."
(declare (indent 1))
;; Write the full sexp evaluating BODY in a copy of the current
;; buffer to a temporary file, as it may be too long for program
;; args in `start-process'.
(with-temp-message "Initializing asynchronous export process"
(let ((copy-fun (org-element--generate-copy-script (current-buffer)))
(temp-file (make-temp-file "org-export-process")))
(let ((coding-system-for-write 'utf-8-emacs-unix))
(write-region
;; Null characters (from variable values) are inserted
;; within the file. As a consequence, coding system for
;; buffer contents could fail to be recognized properly.
(format ";; -*- coding: utf-8-emacs-unix; lexical-binding:t -*-\n%S"
`(with-temp-buffer
,(when org-export-async-debug '(setq debug-on-error t))
;; Ignore `kill-emacs-hook' and code evaluation
;; queries from Babel as we need a truly
;; non-interactive process.
(setq kill-emacs-hook nil
org-babel-confirm-evaluate-answer-no t)
;; Initialize export framework.
(require 'ox)
;; Re-create current buffer there.
(funcall ',copy-fun)
(restore-buffer-modified-p nil)
;; Sexp to evaluate in the buffer.
(print ,body)))
nil temp-file nil 'silent))
;; Start external process.
(let* ((process-connection-type nil)
(proc-buffer (generate-new-buffer-name "*Org Export Process*"))
(process
(apply
#'start-process
(append
(list "org-export-process"
proc-buffer
(expand-file-name invocation-name invocation-directory)
"--batch")
(if org-export-async-init-file
(list "-Q" "-l" org-export-async-init-file)
(list "-l" user-init-file))
(list "-l" temp-file)))))
;; Register running process in stack.
(org-export-add-to-stack (get-buffer proc-buffer) nil process)
;; Set-up sentinel in order to catch results.
(let ((handler fun))
(set-process-sentinel
process
(lambda (p _status)
(let ((proc-buffer (process-buffer p)))
(when (eq (process-status p) 'exit)
(unwind-protect
(if (zerop (process-exit-status p))
(unwind-protect
(let ((results
(with-current-buffer proc-buffer
(goto-char (point-max))
(backward-sexp)
(read (current-buffer)))))
(funcall handler results))
(unless org-export-async-debug
(and (get-buffer proc-buffer)
(kill-buffer proc-buffer))))
(org-export-add-to-stack proc-buffer nil p)
(ding)
(message "Process `%s' exited abnormally" p))
(unless org-export-async-debug
(delete-file temp-file))))))))))))
;;;###autoload
(defun org-export-to-buffer
(backend buffer
&optional async subtreep visible-only body-only ext-plist
post-process)
"Call `org-export-as' with output to a specified buffer.
BACKEND is either an export backend, as returned by, e.g.,
`org-export-create-backend', or a symbol referring to
a registered backend.
BUFFER is the name of the output buffer. If it already exists,
it will be erased first, otherwise, it will be created.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting buffer should then be accessible
through the `org-export-stack' interface. When ASYNC is nil, the
buffer is displayed if `org-export-show-temporary-export-buffer'
is non-nil.
Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
EXT-PLIST are similar to those used in `org-export-as', which
see.
Optional argument POST-PROCESS is a function which should accept
no argument. It is always called within the current process,
from BUFFER, with point at its beginning. Export backends can
use it to set a major mode there, e.g.,
(defun org-latex-export-as-latex
(&optional async subtreep visible-only body-only ext-plist)
(interactive)
(org-export-to-buffer \\='latex \"*Org LATEX Export*\"
async subtreep visible-only body-only ext-plist
#\\='LaTeX-mode))
When expressed as an anonymous function, using `lambda',
POST-PROCESS needs to be quoted.
This function returns BUFFER."
(declare (indent 2))
(if async
(org-export-async-start
(let ((cs buffer-file-coding-system))
(lambda (output)
(with-current-buffer (get-buffer-create buffer)
(erase-buffer)
(setq buffer-file-coding-system cs)
(insert output)
(goto-char (point-min))
(org-export-add-to-stack (current-buffer) backend)
(ignore-errors (funcall post-process)))))
`(org-export-as
',backend ,subtreep ,visible-only ,body-only ',ext-plist))
(let ((output
(org-export-as backend subtreep visible-only body-only ext-plist))
(buffer (get-buffer-create buffer))
(encoding buffer-file-coding-system))
(when (and (org-string-nw-p output) (org-export--copy-to-kill-ring-p))
(org-kill-new output))
(with-current-buffer buffer
(erase-buffer)
(setq buffer-file-coding-system encoding)
(insert output)
(goto-char (point-min))
(and (functionp post-process) (funcall post-process)))
(when org-export-show-temporary-export-buffer
(switch-to-buffer-other-window buffer))
buffer)))
;;;###autoload
(defun org-export-to-file
(backend file &optional async subtreep visible-only body-only ext-plist
post-process)
"Call `org-export-as' with output to a specified file.
BACKEND is either an export backend, as returned by, e.g.,
`org-export-create-backend', or a symbol referring to
a registered backend. FILE is the name of the output file, as
a string.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting buffer will then be accessible
through the `org-export-stack' interface.
Optional arguments SUBTREEP, VISIBLE-ONLY, BODY-ONLY and
EXT-PLIST are similar to those used in `org-export-as', which
see.
Optional argument POST-PROCESS is called with FILE as its
argument and happens asynchronously when ASYNC is non-nil. It
has to return a file name, or nil. Export backends can use this
to send the output file through additional processing, e.g,
(defun org-latex-export-to-latex
(&optional async subtreep visible-only body-only ext-plist)
(interactive)
(let ((outfile (org-export-output-file-name \".tex\" subtreep)))
(org-export-to-file \\='latex outfile
async subtreep visible-only body-only ext-plist
#\\='org-latex-compile)))
When expressed as an anonymous function, using `lambda',
POST-PROCESS needs to be quoted.
The function returns either a file name returned by POST-PROCESS,
or FILE."
(declare (indent 2))
(if (not (file-writable-p file)) (error "Output file not writable")
(let ((ext-plist (org-combine-plists `(:output-file ,file) ext-plist))
(encoding (or org-export-coding-system buffer-file-coding-system)))
(if async
(org-export-async-start
(lambda (file)
(org-export-add-to-stack (expand-file-name file) backend))
`(let ((output
(org-export-as
',backend ,subtreep ,visible-only ,body-only
',ext-plist)))
(with-temp-buffer
(insert output)
;; Ensure final newline. This is what was done
;; historically, when we used `write-file'.
;; Note that adding a newline is only safe for
;; non-binary data.
(unless (bolp) (insert "\n"))
(let ((coding-system-for-write ',encoding))
(write-region nil nil ,file)))
(or (ignore-errors (funcall ',post-process ,file)) ,file)))
(let ((output (org-export-as
backend subtreep visible-only body-only ext-plist)))
(with-temp-buffer
(insert output)
;; Ensure final newline. This is what was done
;; historically, when we used `write-file'.
;; Note that adding a newline is only safe for
;; non-binary data.
(unless (bolp) (insert "\n"))
(let ((coding-system-for-write encoding))
(write-region nil nil file)))
(when (and (org-export--copy-to-kill-ring-p) (org-string-nw-p output))
(org-kill-new output))
;; Get proper return value.
(or (and (functionp post-process) (funcall post-process file))
file))))))
(defun org-export-output-file-name (extension &optional subtreep pub-dir)
"Return output file's name according to buffer specifications.
EXTENSION is a string representing the output file extension,
with the leading dot.
With a non-nil optional argument SUBTREEP, try to determine
output file's name by looking for \"EXPORT_FILE_NAME\" property
of subtree at point.
When optional argument PUB-DIR is set, use it as the publishing
directory.
Return file name as a string."
(let* ((visited-file (buffer-file-name (buffer-base-buffer)))
(base-name
(concat
(file-name-sans-extension
(or
;; Check EXPORT_FILE_NAME subtree property.
(and subtreep (org-entry-get nil "EXPORT_FILE_NAME" 'selective))
;; Check #+EXPORT_FILE_NAME keyword.
(org-with-point-at (point-min)
(catch :found
(let ((case-fold-search t))
(while (re-search-forward
"^[ \t]*#\\+EXPORT_FILE_NAME:[ \t]+\\S-" nil t)
(let ((element (org-element-at-point)))
(when (org-element-type-p element 'keyword)
(throw :found
(org-element-property :value element))))))))
;; Extract from buffer's associated file, if any.
(and visited-file
(file-name-nondirectory
;; For a .gpg visited file, remove the .gpg extension:
(replace-regexp-in-string "\\.gpg\\'" "" visited-file)))
;; Can't determine file name on our own: ask user.
(read-file-name
"Output file: " pub-dir nil nil nil
(lambda (n) (string= extension (file-name-extension n t))))))
extension))
(output-file
;; Build file name. Enforce EXTENSION over whatever user
;; may have come up with. PUB-DIR, if defined, always has
;; precedence over any provided path.
(cond
(pub-dir (concat (file-name-as-directory pub-dir)
(file-name-nondirectory base-name)))
(t base-name))))
;; If writing to OUTPUT-FILE would overwrite original file, append
;; EXTENSION another time to final name.
(if (and visited-file (file-equal-p visited-file output-file))
(concat output-file extension)
output-file)))
(defun org-export-add-to-stack (source backend &optional process)
"Add a new result to export stack if not present already.
SOURCE is a buffer or a file name containing export results.
BACKEND is a symbol representing export backend used to generate
it.
Entries already pointing to SOURCE and unavailable entries are
removed beforehand. Return the new stack."
(setq org-export-stack-contents
(cons (list source backend (or process (current-time)))
(org-export-stack-remove source))))
(defun org-export-stack ()
"Menu for asynchronous export results and running processes."
(interactive)
(let ((buffer (get-buffer-create "*Org Export Stack*")))
(with-current-buffer buffer
(org-export-stack-mode)
(tabulated-list-print t))
(pop-to-buffer buffer))
(message "Type \"q\" to quit, \"?\" for help"))
(defun org-export-stack-clear ()
"Remove all entries from export stack."
(interactive)
(setq org-export-stack-contents nil))
(defun org-export-stack-refresh ()
"Refresh the export stack."
(interactive)
(tabulated-list-print t))
(defun org-export-stack-remove (&optional source)
"Remove export results at point from stack.
If optional argument SOURCE is non-nil, remove it instead."
(interactive)
(let ((source (or source (org-export--stack-source-at-point))))
(setq org-export-stack-contents
(cl-remove-if (lambda (el) (equal (car el) source))
org-export-stack-contents))))
(defun org-export-stack-view (&optional in-emacs)
"View export results at point in stack.
With an optional prefix argument IN-EMACS, force viewing files
within Emacs."
(interactive "P")
(let ((source (org-export--stack-source-at-point)))
(cond ((processp source)
(switch-to-buffer-other-window (process-buffer source)))
((bufferp source) (switch-to-buffer-other-window source))
(t (org-open-file source in-emacs)))))
(defvar org-export-stack-mode-map
(let ((km (make-sparse-keymap)))
(set-keymap-parent km tabulated-list-mode-map)
(define-key km " " #'next-line)
(define-key km "\C-n" #'next-line)
(define-key km [down] #'next-line)
(define-key km "\C-p" #'previous-line)
(define-key km "\C-?" #'previous-line)
(define-key km [up] #'previous-line)
(define-key km "C" #'org-export-stack-clear)
(define-key km "v" #'org-export-stack-view)
(define-key km (kbd "RET") #'org-export-stack-view)
(define-key km "d" #'org-export-stack-remove)
km)
"Keymap for Org Export Stack.")
(define-derived-mode org-export-stack-mode tabulated-list-mode "Org-Stack"
"Mode for displaying asynchronous export stack.
Type `\\[org-export-stack]' to visualize the asynchronous export
stack.
In an Org Export Stack buffer, use \
\\<org-export-stack-mode-map>`\\[org-export-stack-view]' to view export output
on current line, `\\[org-export-stack-remove]' to remove it from the stack and \
`\\[org-export-stack-clear]' to clear
stack completely.
Removing entries in a stack buffer does not affect files
or buffers, only display.
\\{org-export-stack-mode-map}"
(setq tabulated-list-format
(vector (list "#" 4 #'org-export--stack-num-predicate)
(list "Backend" 12 t)
(list "Age" 6 nil)
(list "Source" 0 nil)))
(setq tabulated-list-sort-key (cons "#" nil))
(setq tabulated-list-entries #'org-export--stack-generate)
(add-hook 'tabulated-list-revert-hook #'org-export--stack-generate nil t)
(add-hook 'post-command-hook #'org-export-stack-refresh nil t)
(tabulated-list-init-header))
(defun org-export--stack-generate ()
"Generate the asynchronous export stack for display.
Unavailable sources are removed from the list. Return a list
appropriate for `tabulated-list-print'."
;; Clear stack from exited processes, dead buffers or non-existent
;; files.
(setq org-export-stack-contents
(cl-remove-if-not
(lambda (el)
(if (processp (nth 2 el))
(buffer-live-p (process-buffer (nth 2 el)))
(let ((source (car el)))
(if (bufferp source) (buffer-live-p source)
(file-exists-p source)))))
org-export-stack-contents))
;; Update `tabulated-list-entries'.
(let ((counter 0))
(mapcar
(lambda (entry)
(let ((source (car entry)))
(list source
(vector
;; Counter.
(number-to-string (cl-incf counter))
;; Backend.
(if (nth 1 entry) (symbol-name (nth 1 entry)) "")
;; Age.
(let ((info (nth 2 entry)))
(if (processp info) (symbol-name (process-status info))
(format-seconds "%h:%.2m" (float-time (time-since info)))))
;; Source.
(if (stringp source) source (buffer-name source))))))
org-export-stack-contents)))
(defun org-export--stack-num-predicate (a b)
(< (string-to-number (aref (nth 1 a) 0))
(string-to-number (aref (nth 1 b) 0))))
(defun org-export--stack-source-at-point ()
"Return source from export results at point in stack."
(let ((source (car (nth (1- (org-current-line)) org-export-stack-contents))))
(if (not source) (error "Source unavailable, please refresh buffer")
(let ((source-name (if (stringp source) source (buffer-name source))))
(if (save-excursion
(forward-line 0)
(looking-at-p (concat ".* +" (regexp-quote source-name) "$")))
source
;; SOURCE is not consistent with current line. The stack
;; view is outdated.
(error (substitute-command-keys
"Source unavailable; type `\\[org-export-stack-refresh]' \
to refresh buffer")))))))
\f
;;; The Dispatcher
;;
;; `org-export-dispatch' is the standard interactive way to start an
;; export process. It uses `org-export--dispatch-ui' as a subroutine
;; for its interface, which, in turn, delegates response to key
;; pressed to `org-export--dispatch-action'.
;;;###autoload
(defun org-export-dispatch (&optional arg)
"Export dispatcher for Org mode.
It provides an access to common export related tasks in a buffer.
Its interface comes in two flavors: standard and expert.
While both share the same set of bindings, only the former
displays the valid keys associations in a dedicated buffer.
Scrolling (resp. line-wise motion) in this buffer is done with
SPC and DEL (resp. C-n and C-p) keys.
Set variable `org-export-dispatch-use-expert-ui' to switch to one
flavor or the other.
When ARG is `\\[universal-argument]', repeat the last export action, with the\
same
set of options used back then, on the current buffer.
When ARG is `\\[universal-argument] \\[universal-argument]', display the \
asynchronous export stack."
(interactive "P")
(let* ((input
(cond ((equal arg '(16)) '(stack))
((and arg org-export-dispatch-last-action))
(t (unwind-protect
(progn
;; Remember where we are
(move-marker org-export-dispatch-last-position
(point)
(org-base-buffer (current-buffer)))
;; Get and store an export command
(setq org-export-dispatch-last-action
(org-export--dispatch-ui
(list org-export-initial-scope
(and org-export-body-only 'body)
(and org-export-visible-only 'visible)
(and org-export-force-publishing 'force)
(and org-export-in-background 'async))
nil
org-export-dispatch-use-expert-ui)))
(and (get-buffer-window "*Org Export Dispatcher*" t)
(quit-window 'kill (get-buffer-window "*Org Export Dispatcher*" t)))
(and (get-buffer "*Org Export Dispatcher*")
(kill-buffer "*Org Export Dispatcher*"))))))
(action (car input))
(optns (cdr input)))
(unless (memq 'subtree optns)
(move-marker org-export-dispatch-last-position nil))
(cl-case action
;; First handle special hard-coded actions.
(template (org-export-insert-default-template nil optns))
(stack (org-export-stack))
(publish-current-file
(org-publish-current-file (memq 'force optns) (memq 'async optns)))
(publish-current-project
(org-publish-current-project (memq 'force optns) (memq 'async optns)))
(publish-choose-project
(org-publish (assoc (completing-read
"Publish project: "
org-publish-project-alist nil t)
org-publish-project-alist)
(memq 'force optns)
(memq 'async optns)))
(publish-all (org-publish-all (memq 'force optns) (memq 'async optns)))
(otherwise
(save-excursion
(when arg
;; Repeating command, maybe move cursor to restore subtree
;; context.
(if (eq (marker-buffer org-export-dispatch-last-position)
(org-base-buffer (current-buffer)))
(goto-char org-export-dispatch-last-position)
;; We are in a different buffer, forget position.
(move-marker org-export-dispatch-last-position nil)))
(funcall action
;; Return a symbol instead of a list to ease
;; asynchronous export macro use.
(and (memq 'async optns) t)
(and (memq 'subtree optns) t)
(and (memq 'visible optns) t)
(and (memq 'body optns) t)))))))
(defun org-export--dispatch-ui (options first-key expertp)
"Handle interface for `org-export-dispatch'.
OPTIONS is a list containing current interactive options set for
export. It can contain any of the following symbols:
`body' toggles a body-only export
`subtree' restricts export to current subtree
`visible' restricts export to visible part of buffer.
`force' force publishing files.
`async' use asynchronous export process
FIRST-KEY is the key pressed to select the first level menu. It
is nil when this menu hasn't been selected yet.
EXPERTP, when non-nil, triggers expert UI. In that case, no help
buffer is provided, but indications about currently active
options are given in the prompt. Moreover, [?] allows switching
back to standard interface."
(let* ((fontify-key
(lambda (key &optional access-key)
;; Fontify KEY string. Optional argument ACCESS-KEY, when
;; non-nil is the required first-level key to activate
;; KEY. When its value is t, activate KEY independently
;; on the first key, if any. A nil value means KEY will
;; only be activated at first level.
(if (or (eq access-key t) (eq access-key first-key))
(propertize key 'face 'org-dispatcher-highlight)
key)))
(fontify-value
(lambda (value)
;; Fontify VALUE string.
(propertize value 'face 'font-lock-variable-name-face)))
;; Prepare menu entries by extracting them from registered
;; backends and sorting them by access key and by ordinal,
;; if any.
(entries
(sort (sort (delq nil
(mapcar #'org-export-backend-menu
org-export-registered-backends))
(lambda (a b)
(let ((key-a (nth 1 a))
(key-b (nth 1 b)))
(cond ((and (numberp key-a) (numberp key-b))
(< key-a key-b))
((numberp key-b) t)))))
#'car-less-than-car))
;; Compute a list of allowed keys based on the first key
;; pressed, if any. Some keys
;; (?^B, ?^V, ?^S, ?^F, ?^A, ?&, ?# and ?q) are always
;; available.
(allowed-keys
(nconc (list 2 22 19 6 1)
(if (not first-key) (org-uniquify (mapcar #'car entries))
(let (sub-menu)
(dolist (entry entries (sort (mapcar #'car sub-menu) #'<))
(when (eq (car entry) first-key)
(setq sub-menu (append (nth 2 entry) sub-menu))))))
(cond ((eq first-key ?P) (list ?f ?p ?x ?a))
((not first-key) (list ?P)))
(list ?& ?#)
(when expertp (list ??))
(list ?q)))
;; Build the help menu for standard UI.
(help
(unless expertp
(concat
;; Options are hard-coded.
(format "[%s] Body only: %s [%s] Visible only: %s
\[%s] Export scope: %s [%s] Force publishing: %s
\[%s] Async export: %s\n\n"
(funcall fontify-key "C-b" t)
(funcall fontify-value
(if (memq 'body options) "On " "Off"))
(funcall fontify-key "C-v" t)
(funcall fontify-value
(if (memq 'visible options) "On " "Off"))
(funcall fontify-key "C-s" t)
(funcall fontify-value
(if (memq 'subtree options) "Subtree" "Buffer "))
(funcall fontify-key "C-f" t)
(funcall fontify-value
(if (memq 'force options) "On " "Off"))
(funcall fontify-key "C-a" t)
(funcall fontify-value
(if (memq 'async options) "On " "Off")))
;; Display registered backend entries. When a key
;; appears for the second time, do not create another
;; entry, but append its sub-menu to existing menu.
(let (last-key)
(mapconcat
(lambda (entry)
(let ((top-key (car entry)))
(concat
(unless (eq top-key last-key)
(setq last-key top-key)
(format "\n[%s] %s\n"
(funcall fontify-key (char-to-string top-key))
(nth 1 entry)))
(let ((sub-menu (nth 2 entry)))
(unless (functionp sub-menu)
;; Split sub-menu into two columns.
(let ((index -1))
(concat
(mapconcat
(lambda (sub-entry)
(cl-incf index)
(format
(if (zerop (mod index 2)) " [%s] %-26s"
"[%s] %s\n")
(funcall fontify-key
(char-to-string (car sub-entry))
top-key)
(nth 1 sub-entry)))
sub-menu "")
(when (zerop (mod index 2)) "\n"))))))))
entries ""))
;; Publishing menu is hard-coded.
(format "\n[%s] Publish
[%s] Current file [%s] Current project
[%s] Choose project [%s] All projects\n\n\n"
(funcall fontify-key "P")
(funcall fontify-key "f" ?P)
(funcall fontify-key "p" ?P)
(funcall fontify-key "x" ?P)
(funcall fontify-key "a" ?P))
(format "[%s] Export stack [%s] Insert template\n"
(funcall fontify-key "&" t)
(funcall fontify-key "#" t))
(format "[%s] %s"
(funcall fontify-key "q" t)
(if first-key "Main menu" "Exit")))))
;; Build prompts for both standard and expert UI.
(standard-prompt (unless expertp "Export command: "))
(expert-prompt
(when expertp
(format
"Export command (C-%s%s%s%s%s) [%s]: "
(if (memq 'body options) (funcall fontify-key "b" t) "b")
(if (memq 'visible options) (funcall fontify-key "v" t) "v")
(if (memq 'subtree options) (funcall fontify-key "s" t) "s")
(if (memq 'force options) (funcall fontify-key "f" t) "f")
(if (memq 'async options) (funcall fontify-key "a" t) "a")
(mapconcat (lambda (k)
;; Strip control characters.
(unless (< k 27) (char-to-string k)))
allowed-keys "")))))
;; With expert UI, just read key with a fancy prompt. In standard
;; UI, display an intrusive help buffer.
(if expertp
(org-export--dispatch-action
expert-prompt allowed-keys entries options first-key expertp)
(save-window-excursion
;; At first call, create frame layout in order to display menu.
(unless (get-buffer "*Org Export Dispatcher*")
(pop-to-buffer "*Org Export Dispatcher*" '(org-display-buffer-split))
(setq cursor-type nil)
(setq header-line-format
(let ((propertize-help-key
(lambda (key)
;; Add `face' *and* `font-lock-face' to "work
;; reliably in any buffer", per a comment in
;; `help--key-description-fontified'.
(propertize key
'font-lock-face 'help-key-binding
'face 'help-key-binding))))
(apply 'format
(cons "Use %s, %s, %s, or %s to navigate."
(mapcar propertize-help-key
(list "SPC" "DEL" "C-n" "C-p"))))))
;; Make sure that invisible cursor will not highlight square
;; brackets.
(set-syntax-table (copy-syntax-table))
(modify-syntax-entry ?\[ "w"))
;; At this point, the buffer containing the menu exists and is
;; visible in the current window. So, refresh it.
(with-current-buffer "*Org Export Dispatcher*"
;; Refresh help. Maintain display continuity by re-visiting
;; previous window position.
(let ((pt (point))
(wstart (window-start)))
(erase-buffer)
(insert help)
(goto-char pt)
(set-window-start nil wstart)))
(org-fit-window-to-buffer)
(org-export--dispatch-action
standard-prompt allowed-keys entries options first-key expertp)))))
(defun org-export--dispatch-action
(prompt allowed-keys entries options first-key expertp)
"Read a character from command input and act accordingly.
PROMPT is the displayed prompt, as a string. ALLOWED-KEYS is
a list of characters available at a given step in the process.
ENTRIES is a list of menu entries. OPTIONS, FIRST-KEY and
EXPERTP are the same as defined in `org-export--dispatch-ui',
which see.
Toggle export options when required. Otherwise, return value is
a list with action as CAR and a list of interactive export
options as CDR."
(let (key)
;; Scrolling: when in non-expert mode, act on motion keys (C-n,
;; C-p, SPC, DEL).
(while (and (setq key (read-char-exclusive prompt))
(not expertp)
;; FIXME: Don't use C-v (22) here, as it is used as a
;; modifier key in the export dispatch.
(memq key '(14 16 ?\s ?\d 134217846)))
(org-scroll key t))
(cond
;; Ignore undefined associations.
((not (memq key allowed-keys))
(ding)
(unless expertp (message "Invalid key") (sit-for 1))
(org-export--dispatch-ui options first-key expertp))
;; q key at first level aborts export. At second level, cancel
;; first key instead.
((eq key ?q) (if (not first-key) (user-error "Export aborted")
(org-export--dispatch-ui options nil expertp)))
;; Help key: Switch back to standard interface if expert UI was
;; active.
((eq key ??) (org-export--dispatch-ui options first-key nil))
;; Send request for template insertion along with export scope.
((eq key ?#) (cons 'template (memq 'subtree options)))
;; Switch to asynchronous export stack.
((eq key ?&) '(stack))
;; Toggle options: C-b (2) C-v (22) C-s (19) C-f (6) C-a (1).
((memq key '(2 22 19 6 1))
(org-export--dispatch-ui
(let ((option (cl-case key (2 'body) (22 'visible) (19 'subtree)
(6 'force) (1 'async))))
(if (memq option options) (remq option options)
(cons option options)))
first-key expertp))
;; Action selected: Send key and options back to
;; `org-export-dispatch'.
((or first-key (functionp (nth 2 (assq key entries))))
(cons (cond
((not first-key) (nth 2 (assq key entries)))
;; Publishing actions are hard-coded. Send a special
;; signal to `org-export-dispatch'.
((eq first-key ?P)
(cl-case key
(?f 'publish-current-file)
(?p 'publish-current-project)
(?x 'publish-choose-project)
(?a 'publish-all)))
;; Return first action associated to FIRST-KEY + KEY
;; path. Indeed, derived backends can share the same
;; FIRST-KEY.
(t (catch 'found
(dolist (entry (member (assq first-key entries) entries))
(let ((match (assq key (nth 2 entry))))
(when match (throw 'found (nth 2 match))))))))
options))
;; Otherwise, enter sub-menu.
(t (org-export--dispatch-ui options key expertp)))))
(provide 'ox)
;; Local variables:
;; generated-autoload-file: "org-loaddefs.el"
;; End:
;;; ox.el ends here
|