summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/context/base/node-ltp.lua
blob: e4956f7df8e56e54a8a84efbdbad06d0f4a9c40a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
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
if not modules then modules = { } end modules ['node-par'] = {
    version   = 1.001,
    comment   = "companion to node-par.mkiv",
    author    = "Hans Hagen",
    copyright = "ConTeXt Development Team",
    license   = "see context related readme files",
    comment   = "a translation of the built in parbuilder, initial convertsin by Taco Hoekwater",
}

-- todo: remove nest_stack from linebreak.w
-- todo: use ex field as signal (index in ?)
-- todo: attr driven unknown/on/off
-- todo: permit global steps i.e. using an attribute that sets min/max/step and overloads the font parameters
-- todo: split the three passes into three functions
-- todo: simplify the direction stack, no copy needed
-- todo: see if we can do without delta nodes (needs thinking)
-- todo: add more mkiv like tracing
-- todo: add a couple of plugin hooks
-- todo: maybe split expansion code paths
-- todo: fix line numbers (cur_list.pg_field needed)
-- todo: check and improve protrusion
-- todo: arabic etc (we could use pretty large scales there) .. marks and cursive

--[[

    This code is derived from traditional TeX and has bits of pdfTeX, Aleph (Omega), and of course LuaTeX. So,
    the basic algorithm for sure is not our work. On the other hand, the directional model in LuaTeX is cleaned
    up as is other code. And of course there are hooks for callbacks.

    The first version of the code below was a conversion of the C code that in turn was a conversion from the
    original Pascal code. Around September 2008 we experimented with cq. discussed possible approaches to improved
    typesetting of Arabic and as our policy is that extensions happen in Lua this means that we need a parbuilder
    in Lua. Taco's first conversion still looked quite C-ish and in the process of cleaning up we uncovered some odd
    bits and pieces in the original code as well. I did some first cleanup to get rid of C-artefacts, and Taco and I
    spent the usual amount of Skyping to sort out problems. At that point we diverted to other LuaTeX issues.

    A while later I decided to pick up this thread and decided to look into better ways to deal with font expansion
    (aka hz). I got it running using a simpler method. One reason why the built-in mechanims is slow is that there is
    lots of redudancy in calculations. Expanded widths are recalculated each time and because the hpakc routine does
    it again that gives some overhead. In the process extra fonts are created with different dimensions so that the
    backend can deal with it. The alternative method doesn't create fonts but passes an expansion factor to the
    pdf generator. The small patch needed for the backend code worked more or less okay but was never intergated into
    LuaTeX due to lack of time.

    This all happened in 2010 while listening to Peter Gabriels "Scratch My Back" and Camels "Rayaz" so it was a
    rather relaxed job.

    In 2012 I picked up this thread. Because both languages are similar but also quite different it took some time
    to get compatible output. Because the C code uses macros, careful checking was needed. Of course Lua's table model
    and local variables brought some work as well. And still the code looks a bit C-ish. We could not divert too much
    from the original model simply because it's well documented but future versions (or variants) might as well look
    different.

    Eventually I'll split this code into passes so that we can better see what happens, but first we need to reach
    a decent level of stability. The current expansion results are not the same as the built-in but that was never
    the objective. It all has to do with slightly different calculations.

    The original C-code related to protrusion and expansion is not that efficient as many (redundant) function
    calls take place in the linebreaker and packer. As most work related to fonts is done in the backend, we
    can simply stick to width calculations here. Also, it is no problem at all that we use floating point
    calculations (as Lua has only floats). The final result will look ok as the hpack will nicely compensate
    for rounding errors as it will normally distribute the content well enough. And let's admit: most texies
    won't see it anyway. As long as we're cross platform compatible it's fine.

    We use the table checked_expansion to keep track of font related parameters (per paragraph). The table is
    also the signal that we have adjustments > 1. In retrospect one might wonder if adjusting kerns is such a
    good idea because other spacing is also not treated. If we would stick to the regular hpack routine
    we do have to follow the same logic, but I decided to use a Lua hpacker so that constraint went away. And
    anyway, instead of doing a lookup in the kern table (that we don't have in node mode) the set kern value
    is used. Disabling kern scaling will become an option in Luatex some day. You can blame me for all errors
    that crept in and I know that there are some.

    To be honest, I slowly start to grasp the magic here as normally I start from scratch when implementing
    something (as it's the only way I can understand things). This time I had a recently acquired stack of
    Porcupine Tree disks to get me through, although I must admit that watching their dvd's is more fun
    than coding.

    Picking up this effort was inspired by discussions between Luigi Scarso and me about efficiency of Lua
    code and we needed some stress tests to compare regular LuaTeX and LuajitTeX. One of the tests was
    processing tufte.tex as that one has lots of hyphenations and is a tough one to get right.

    tufte: boxed 1000 times, no flushing in backend:

                           \testfeatureonce{1000}{\setbox0\hbox{\tufte}}
                           \testfeatureonce{1000}{\setbox0\vbox{\tufte}}
    \startparbuilder[basic]\testfeatureonce{1000}{\setbox0\vbox{\tufte}}\stopparbuilder

                method     normal   hz      comment

    luatex      tex hbox    9.64     9.64   baseline font feature processing, hyphenation etc: 9.74
                tex vbox    9.84    10.16   0.20 linebreak / 0.52 with hz -> 0.32 hz overhead (150pct more)
                lua vbox   17.28    18.43   7.64 linebreak / 8.79 with hz -> 1.33 hz overhead ( 20pct more)

    new laptop | no nuts
                            3.42            baseline
                            3.63            0.21 linebreak
                            7.38            3.96 linebreak

    new laptop | most nuts
                            2.45            baseline
                            2.53            0.08 linebreak
                            6.16            3.71 linebreak
                 ltp nuts   5.45            3.00 linebreak

    luajittex   tex hbox    6.33     6.33   baseline font feature processing, hyphenation etc: 6.33
                tex vbox    6.53     6.81   0.20 linebreak / 0.48 with hz -> 0.28 hz overhead (expected 0.32)
                lua vbox   11.06    11.81   4.53 linebreak / 5.28 with hz -> 0.75 hz overhead

    new laptop | no nuts
                            2.06            baseline
                            2.27            0.21 linebreak
                            3.95            1.89 linebreak

    new laptop | most nuts
                            1.25            baseline
                            1.30            0.05 linebreak
                            3.03            1.78 linebreak
                 ltp nuts   2.47            1.22 linebreak

    Interesting is that the runtime for the built-in parbuilder indeed increases much when expansion
    is enabled, but in the Lua variant the extra overhead is way less significant. This means that when we
    retrofit the same approach into the core, the overhead of expansion can be sort of nilled.

    In 2013 the expansion factor method became also used at the TeX end so then I could complete the code
    here, and indeed, expansions works quite well now (not compatible of course because we use floats at the
    Lua end. The Lua base variant is still slower but quite ok, especially if we go nuts.

    A next iteration will provide plug-ins and more control. I will also explore the possibility to avoid the
    redundant hpack calculations (easier now, although I've only done some quick and dirty experiments.)

]]--

local utfchar = utf.char
local write, write_nl = texio.write, texio.write_nl
local sub, format = string.sub, string.format
local round, floor = math.round, math.floor
local insert, remove = table.insert, table.remove

local fonts, nodes, node = fonts, nodes, node

local trace_basic         = false  trackers.register("builders.paragraphs.basic",       function(v) trace_basic       = v end)
local trace_lastlinefit   = false  trackers.register("builders.paragraphs.lastlinefit", function(v) trace_lastlinefit = v end)
local trace_adjusting     = false  trackers.register("builders.paragraphs.adjusting",   function(v) trace_adjusting   = v end)
local trace_protruding    = false  trackers.register("builders.paragraphs.protruding",  function(v) trace_protruding  = v end)
local trace_expansion     = false  trackers.register("builders.paragraphs.expansion",   function(v) trace_expansion   = v end)
local trace_quality       = false  trackers.register("builders.paragraphs.quality",     function(v) trace_quality     = v end)

local report_parbuilders  = logs.reporter("nodes","parbuilders")
local report_hpackers     = logs.reporter("nodes","hpackers")

local calculate_badness   = tex.badness
local texnest             = tex.nest
local texlists            = tex.lists

-- (t == 0 and 0) or (s <= 0 and 10000) or calculate_badness(t,s)

-- local function calculate_badness(t,s)
--     if t == 0 then
--         return 0
--     elseif s <= 0 then
--         return 10000 -- infinite_badness
--     else
--         local r
--         if t <= 7230584 then
--             r = (t * 297) / s
--         elseif s >= 1663497 then
--             r = t / (s / 297)
--         else
--             r = t
--         end
--         if r > 1290 then
--             return 10000 -- infinite_badness
--         else
--             return (r * r * r + 0x20000) / 0x40000
--         end
--     end
-- end

local parbuilders          = builders.paragraphs
local constructors         = parbuilders.constructors

local setmetatableindex    = table.setmetatableindex

local fonthashes           = fonts.hashes
local fontdata             = fonthashes.identifiers
local chardata             = fonthashes.characters
local quaddata             = fonthashes.quads
local parameters           = fonthashes.parameters

local nuts                 = nodes.nuts
local tonut                = nuts.tonut
local tonode               = nuts.tonode

local getfield             = nuts.getfield
local setfield             = nuts.setfield
local getid                = nuts.getid
local getsubtype           = nuts.getsubtype
local getnext              = nuts.getnext
local getprev              = nuts.getprev
local getlist              = nuts.getlist
local getfont              = nuts.getfont
local getchar              = nuts.getchar
local getattr              = nuts.getattr

local slide_nodelist       = nuts.slide -- get rid of this, probably ok > 78.2
local find_tail            = nuts.tail
local new_node             = nuts.new
local copy_node            = nuts.copy
local copy_nodelist        = nuts.copy_list
local flush_node           = nuts.free
local flush_nodelist       = nuts.flush_list
local hpack_nodes          = nuts.hpack
local xpack_nodes          = nuts.hpack
local replace_node         = nuts.replace
local insert_node_after    = nuts.insert_after
local insert_node_before   = nuts.insert_before
local traverse_by_id       = nuts.traverse_id

local setnodecolor         = nodes.tracers.colors.set

local nodepool             = nuts.pool

local nodecodes            = nodes.nodecodes
local whatcodes            = nodes.whatcodes
local kerncodes            = nodes.kerncodes
local glyphcodes           = nodes.glyphcodes
local gluecodes            = nodes.gluecodes
local margincodes          = nodes.margincodes
local disccodes            = nodes.disccodes
local mathcodes            = nodes.mathcodes
local fillcodes            = nodes.fillcodes

local temp_code            = nodecodes.temp
local glyph_code           = nodecodes.glyph
local ins_code             = nodecodes.ins
local mark_code            = nodecodes.mark
local adjust_code          = nodecodes.adjust
local penalty_code         = nodecodes.penalty
local whatsit_code         = nodecodes.whatsit
local disc_code            = nodecodes.disc
local math_code            = nodecodes.math
local kern_code            = nodecodes.kern
local glue_code            = nodecodes.glue
local hlist_code           = nodecodes.hlist
local vlist_code           = nodecodes.vlist
local unset_code           = nodecodes.unset
local marginkern_code      = nodecodes.marginkern

local leaders_code         = gluecodes.leaders

local localpar_code        = whatcodes.localpar
local dir_code             = whatcodes.dir
local pdfrefximage_code    = whatcodes.pdfrefximage
local pdfrefxform_code     = whatcodes.pdfrefxform

local kerning_code         = kerncodes.kerning -- font kern
local userkern_code        = kerncodes.userkern

local ligature_code        = glyphcodes.ligature

local stretch_orders       = nodes.fillcodes

local leftmargin_code      = margincodes.left
local rightmargin_code     = margincodes.right

local automatic_disc_code  = disccodes.automatic
local regular_disc_code    = disccodes.regular
local first_disc_code      = disccodes.first
local second_disc_code     = disccodes.second

local endmath_code         = mathcodes.endmath

local nosubtype_code       = 0

local unhyphenated_code    = nodecodes.unhyphenated or 1
local hyphenated_code      = nodecodes.hyphenated   or 2
local delta_code           = nodecodes.delta        or 3
local passive_code         = nodecodes.passive      or 4

local maxdimen             = number.maxdimen

local max_halfword         = 0x7FFFFFFF
local infinite_penalty     =  10000
local eject_penalty        = -10000
local infinite_badness     =  10000
local awful_badness        = 0x3FFFFFFF

local fit_very_loose_class = 0  -- fitness for lines stretching more than their stretchability
local fit_loose_class      = 1  -- fitness for lines stretching 0.5 to 1.0 of their stretchability
local fit_decent_class     = 2  -- fitness for all other lines
local fit_tight_class      = 3  -- fitness for lines shrinking 0.5 to 1.0 of their shrinkability

local new_penalty          = nodepool.penalty
local new_dir              = nodepool.textdir
local new_leftmarginkern   = nodepool.leftmarginkern
local new_rightmarginkern  = nodepool.rightmarginkern
local new_leftskip         = nodepool.leftskip
local new_rightskip        = nodepool.rightskip
local new_lineskip         = nodepool.lineskip
local new_baselineskip     = nodepool.baselineskip
local new_temp             = nodepool.temp
local new_rule             = nodepool.rule

local is_rotated           = nodes.is_rotated
local is_parallel          = nodes.textdir_is_parallel
local is_opposite          = nodes.textdir_is_opposite
local textdir_is_equal     = nodes.textdir_is_equal
local pardir_is_equal      = nodes.pardir_is_equal
local glyphdir_is_equal    = nodes.glyphdir_is_equal

local dir_pops             = nodes.dir_is_pop
local dir_negations        = nodes.dir_negation
local is_skipable          = nuts.protrusion_skippable

local a_fontkern           = attributes.private('fontkern')

-- helpers --

-- It makes more sense to move the somewhat messy dir state tracking
-- out of the main functions. First we create a stack allocator.

local function new_dir_stack(dir) -- also use elsewhere
    return { n = 0, dir }
end

-- The next function checks a dir node and returns the new dir state. By
-- using s static table we are quite efficient. This function is used
-- in the parbuilder.

local function checked_line_dir(stack,current)
    if not dir_pops[current] then
        local n = stack.n + 1
        stack.n = n
        stack[n] = current
        return getfield(current,"dir")
    elseif n > 0 then
        local n = stack.n
        local dirnode = stack[n]
        dirstack.n = n - 1
        return getfield(dirnode,"dir")
    else
        report_parbuilders("warning: missing pop node (%a)",1) -- in line ...
    end
end

-- The next function checks a dir nodes in a list and appends the negations
-- that are currently needed (some day LuaTeX will be more tolerant). We use
-- the negations for the next line.

local function inject_dirs_at_end_of_line(stack,current,start,stop)
    local e = start
    local n = stack.n
    local h = nil
    while start and start ~= stop do
        if getid(start) == whatsit_code and getsubtype(start) == dir_code then
            if not dir_pops[getfield(start,"dir")] then -- weird, what is this #
                n = n + 1
                stack[n] = start
            elseif n > 0 then
                n = n - 1
            else
                report_parbuilders("warning: missing pop node (%a)",2) -- in line ...
            end
        end
        start = getnext(start)
    end
    for i=n,1,-1 do
        h, current = insert_node_after(current,current,new_dir(dir_negations[getfield(stack[i],"dir")]))
    end
    stack.n = n
    return current
end

local function inject_dirs_at_begin_of_line(stack,current)
    local h = nil
    for i=stack.n,1,-1 do
        h, current = insert_node_after(current,current,new_dir(stack[i]))
    end
    stack.n = 0
    return current
end

-- diagnostics --

local dummy = function() end

local diagnostics = {
    start          = dummy,
    stop           = dummy,
    current_pass   = dummy,
    break_node     = dummy,
    feasible_break = dummy,
}

-- statistics --

local nofpars, noflines, nofprotrudedlines, nofadjustedlines = 0, 0, 0, 0

local function register_statistics(par)
    local statistics  = par.statistics
    nofpars           = nofpars           + 1
    noflines          = noflines          + statistics.noflines
    nofprotrudedlines = nofprotrudedlines + statistics.nofprotrudedlines
    nofadjustedlines  = nofadjustedlines  + statistics.nofadjustedlines
end

-- resolvers --

local get_whatsit_width      = nodes.whatsitters.getters.width
local get_whatsit_dimensions = nodes.whatsitters.getters.dimensions

-- expansion etc --

local function calculate_fraction(x,n,d,max_answer)
    local the_answer = x * n/d + 1/2 -- round ?
    if the_answer > max_answer then
        return  max_answer
    elseif the_answer < -max_answer then
        return -max_answer
    else
        return  the_answer
    end
end

local function check_shrinkage(par,n)
    -- called often, so maybe move inline -- use NORMAL
    if getfield(n,"shrink_order") ~= 0 and getfield(n,"shrink") ~= 0 then
        if par.no_shrink_error_yet then
            par.no_shrink_error_yet = false
            report_parbuilders("infinite glue shrinkage found in a paragraph and removed")
        end
        n = copy_node(n)
        setfield(n,"shrink_order",0)
    end
    return n
end

-- It doesn't really speed up much but the additional memory usage is
-- rather small so it doesn't hurt too much.

local expansions = { }
local nothing    = { stretch = 0, shrink = 0 }

setmetatableindex(expansions,function(t,font) -- we can store this in tfmdata if needed
    local expansion = parameters[font].expansion -- can be an extra hash
    if expansion and expansion.auto then
        local factors = { }
        local c = chardata[font]
        setmetatableindex(factors,function(t,char)
            local fc = c[char]
            local ef = fc.expansion_factor
            if ef and ef > 0 then
                local stretch = expansion.stretch
                local shrink  = expansion.shrink
                if stretch ~= 0 or shrink ~= 0 then
                    local factor  = ef / 1000
                    local ef_quad = factor * quaddata[font] / 1000
                    local v = {
                        glyphstretch = stretch * ef_quad,
                        glyphshrink  = shrink  * ef_quad,
                        factor       = factor,
                        stretch      = stretch,
                        shrink       = shrink,
                    }
                    t[char] = v
                    return v
                end
            end
            t[char] = nothing
            return nothing
        end)
        t[font] = factors
        return factors
    else
        t[font] = false
        return false
    end
end)

local function kern_stretch_shrink(p,d)
    local left = getprev(p)
    if left and getid(left) == glyph_code then -- how about disc nodes?
        local data = expansions[getfont(left)][getchar(left)]
        if data then
            local stretch = data.stretch
            local shrink  = data.shrink
            if stretch ~= 0 then
             -- stretch = data.factor * (d *  stretch - d)
                stretch = data.factor *  d * (stretch - 1)
            end
            if shrink ~= 0 then
             -- shrink = data.factor * (d *  shrink - d)
                shrink = data.factor *  d * (shrink - 1)
            end
            return stretch, shrink
        end
    end
    return 0, 0
end

local expand_kerns = false
----- expand_kerns = "both"

directives.register("builders.paragraphs.adjusting.kerns",function(v)
    if not v then
        expand_kerns = false
    elseif v == "stretch" or v == "shrink" then
        expand_kerns = v
    elseif v == "both" then
        expand_kerns = true
    else
        expand_kerns = toboolean(v,true) or false
    end
end)

-- state:

local function check_expand_pars(checked_expansion,f)
    local expansion = parameters[f].expansion
    if not expansion then
        checked_expansion[f] = false
        return false
    end
-- expansion.step = 1
    local step    = expansion.step    or 0
    local stretch = expansion.stretch or 0
    local shrink  = expansion.shrink  or 0
    if step == 0 or (stretch == 0 and schrink == 0) then
        checked_expansion[f] = false
        return false
    end
    local par = checked_expansion.par
    if par.cur_font_step < 0 then
        par.cur_font_step = step
    elseif par.cur_font_step ~= step then
        report_parbuilders("using fonts with different step of expansion in one paragraph is not allowed")
        checked_expansion[f] = false
        return false
    end
    if stretch == 0 then
        -- okay
    elseif par.max_stretch_ratio < 0 then
        par.max_stretch_ratio = stretch -- expansion_factor
    elseif par.max_stretch_ratio ~= stretch then
        report_parbuilders("using fonts with different stretch limit of expansion in one paragraph is not allowed")
        checked_expansion[f] = false
        return false
    end
    if shrink == 0 then
        -- okay
    elseif par.max_shrink_ratio < 0 then
        par.max_shrink_ratio = shrink -- - expansion_factor
    elseif par.max_shrink_ratio ~= shrink then
        report_parbuilders("using fonts with different shrink limit of expansion in one paragraph is not allowed")
        checked_expansion[f] = false
        return false
    end
    if trace_adjusting then
        report_parbuilders("expanding font %a using step %a, shrink %a and stretch %a",f,step,stretch,shrink)
    end
    local e = expansions[f]
    checked_expansion[f] = e
    return e
end

local function check_expand_lines(checked_expansion,f)
    local expansion = parameters[f].expansion
    if not expansion then
        checked_expansion[f] = false
        return false
    end
-- expansion.step = 1
    local step    = expansion.step    or 0
    local stretch = expansion.stretch or 0
    local shrink  = expansion.shrink  or 0
    if step == 0 or (stretch == 0 and schrink == 0) then
        checked_expansion[f] = false
        return false
    end
    if trace_adjusting then
        report_parbuilders("expanding font %a using step %a, shrink %a and stretch %a",f,step,stretch,shrink)
    end
    local e = expansions[f]
    checked_expansion[f] = e
    return e
end

-- protrusion

local function find(head) -- do we really want to recurse into an hlist?
    while head do
        local id = getid(head)
        if id == glyph_code then
            return head
        elseif id == hlist_code then
            local found = find(getlist(head))
            if found then
                return found
            else
                head = getnext(head)
            end
        elseif is_skipable(head) then
            head = getnext(head)
        else
            return head
        end
    end
    return nil
end

local function find_protchar_left(l) -- weird function
    local ln = getnext(l)
    if ln and getid(ln) == hlist_code and not getlist(ln) and getfield(ln,"width") == 0 and getfield(ln,"height") == 0 and getfield(ln,"depth") == 0 then
        l = getnext(l)
    else -- if d then -- was always true
        local id = getid(l)
        while ln and not (id == glyph_code or id < math_code) do -- is there always a glyph?
            l = ln
            ln = getnext(l)
            id = getid(ln)
        end
    end
 -- if getid(l) == glyph_code then
 --     return l
 -- end
    return find(l) or l
end

local function find(head,tail)
    local tail = tail or find_tail(head)
    while tail do
        local id = getid(tail)
        if id == glyph_code then
            return tail
        elseif id == hlist_code then
            local found = find(getlist(tail))
            if found then
                return found
            else
                tail = getprev(tail)
            end
        elseif is_skipable(tail) then
            tail = getprev(tail)
        else
            return tail
        end
    end
    return nil
end

local function find_protchar_right(l,r)
    return r and find(l,r) or r
end

local function left_pw(p)
    local font = getfont(p)
    local prot = chardata[font][getchar(p)].left_protruding
    if not prot or prot == 0 then
        return 0
    end
    return prot * quaddata[font] / 1000, p
end

local function right_pw(p)
    local font = getfont(p)
    local prot = chardata[font][getchar(p)].right_protruding
    if not prot or prot == 0 then
        return 0
    end
    return prot * quaddata[font] / 1000, p
end

-- par parameters

local function reset_meta(par)
    local active = {
        id          = hyphenated_code,
        line_number = max_halfword,
    }
    active.next = par.active -- head of metalist
    par.active  = active
    par.passive = nil
end

local function add_to_width(line_break_dir,checked_expansion,s) -- split into two loops (normal and expansion)
    local size           = 0
    local adjust_stretch = 0
    local adjust_shrink  = 0
    while s do
        local id = getid(s)
        if id == glyph_code then
            if is_rotated[line_break_dir] then -- can be shared
                size = size + getfield(s,"height") + getfield(s,"depth")
            else
                size = size + getfield(s,"width")
            end
            if checked_expansion then
                local data = checked_expansion[getfont(s)]
                if data then
                    data = data[getchar(s)]
                    if data then
                        adjust_stretch = adjust_stretch + data.glyphstretch
                        adjust_shrink  = adjust_shrink  + data.glyphshrink
                    end
                end
            end
        elseif id == hlist_code or id == vlist_code then
            if is_parallel[getfield(s,"dir")][line_break_dir] then
                size = size + getfield(s,"width")
            else
                size = size + getfield(s,"height") + getfield(s,"depth")
            end
        elseif id == kern_code then
            local kern = getfield(s,"kern")
            if kern ~= 0 then
                if checked_expansion and expand_kerns and (getsubtype(s) == kerning_code or getattr(a_fontkern)) then
                    local stretch, shrink = kern_stretch_shrink(s,kern)
                    if expand_kerns == "stretch" then
                        adjust_stretch = adjust_stretch + stretch
                    elseif expand_kerns == "shrink" then
                        adjust_shrink  = adjust_shrink  + shrink
                    else
                        adjust_stretch = adjust_stretch + stretch
                        adjust_shrink  = adjust_shrink  + shrink
                    end
                end
                size = size + kern
            end
        elseif id == rule_code then
            size = size + getfield(s,"width")
        elseif trace_unsupported then
            report_parbuilders("unsupported node at location %a",6)
        end
        s = getnext(s)
    end
    return size, adjust_stretch, adjust_shrink
end

local function compute_break_width(par,break_type,p) -- split in two
    local break_width = par.break_width
    if break_type > unhyphenated_code then
        local disc_width           = par.disc_width
        local checked_expansion    = par.checked_expansion
        local line_break_dir       = par.line_break_dir
        local break_size           = break_width.size           + disc_width.size
        local break_adjust_stretch = break_width.adjust_stretch + disc_width.adjust_stretch
        local break_adjust_shrink  = break_width.adjust_shrink  + disc_width.adjust_shrink
        local replace = getfield(p,"replace")
        if replace then
            local size, adjust_stretch, adjust_shrink = add_to_width(line_break_dir,checked_expansion,replace)
            break_size           = break_size           - size
            break_adjust_stretch = break_adjust_stretch - adjust_stretch
            break_adjust_shrink  = break_adjust_shrink  - adjust_shrink
        end
        local post = getfield(p,"post")
        if post then
            local size, adjust_stretch, adjust_shrink = add_to_width(line_break_dir,checked_expansion,post)
            break_size           = break_size           + size
            break_adjust_stretch = break_adjust_stretch + adjust_stretch
            break_adjust_shrink  = break_adjust_shrink  + adjust_shrink
        end
        break_width.size           = break_size
        break_width.adjust_stretch = break_adjust_stretch
        break_width.adjust_shrink  = break_adjust_shrink
        if not post then
            p = getnext(p)
        else
            return
        end
    end
    while p do -- skip spacing etc
        local id = getid(p)
        if id == glyph_code then
            return -- happens often
        elseif id == glue_code then
            local spec = getfield(p,"spec")
            local order = stretch_orders[getfield(spec,"stretch_order")]
            break_width.size   = break_width.size   - getfield(spec,"width")
            break_width[order] = break_width[order] - getfield(spec,"stretch")
            break_width.shrink = break_width.shrink - getfield(spec,"shrink")
        elseif id == penalty_code then
            -- do nothing
        elseif id == kern_code then
            if getsubtype(p) == userkern_code then
                break_width.size = break_width.size - getfield(p,"kern")
            else
                return
            end
        elseif id == math_code then
            break_width.size = break_width.size - getfield(p,"surround")
        else
            return
        end
        p = getnext(p)
    end
end

local function append_to_vlist(par, b)
    local prev_depth = par.prev_depth
    if prev_depth > par.ignored_dimen then
        if getid(b) == hlist_code then
            local d = getfield(par.baseline_skip,"width") - prev_depth - getfield(b,"height") -- deficiency of space between baselines
            local s = d < par.line_skip_limit and new_lineskip(par.lineskip) or new_baselineskip(d)
         -- local s = d < par.line_skip_limit
         -- if s then
         --     s = new_lineskip()
         --     setfield(s,"spec",tex.lineskip)
         -- else
         --     s = new_baselineskip(d)
         -- end
            local head_field = par.head_field
            if head_field then
                local n = slide_nodelist(head_field) -- todo: find_tail
                setfield(n,"next",s)
                setfield(s,"prev",n)
            else
                par.head_field = s
            end
        end
    end
    local head_field = par.head_field
    if head_field then
        local n = slide_nodelist(head_field) -- todo: find_tail
        setfield(n,"next",b)
        setfield(b,"prev",n)
    else
        par.head_field = b
    end
    if getid(b) == hlist_code then
        local pd = getfield(b,"depth")
        par.prev_depth = pd
        texnest[texnest.ptr].prevdepth = pd
    end
end

local function append_list(par, b)
    local head_field = par.head_field
    if head_field then
        local n = slide_nodelist(head_field) -- todo: find_tail
        setfield(n,"next",b)
        setfield(b,"prev",n)
    else
        par.head_field = b
    end
end

-- We can actually make par local to this module as we never break inside a break call and that way the
-- array is reused. At some point the information will be part of the paragraph spec as passed.

local hztolerance = 2500
local hzwarned    = false

local function used_skip(s)
    return s and (getfield(s,"width") ~= 0 or getfield(s,"stretch") ~= 0 or getfield(s,"shrink") ~= 0) and s or nil
end

local function initialize_line_break(head,display)

    local hang_indent    = tex.hangindent or 0
    local hsize          = tex.hsize or 0
    local hang_after     = tex.hangafter or 0
    local par_shape_ptr  = tex.parshape
    local left_skip      = tonut(tex.leftskip)  -- nodes
    local right_skip     = tonut(tex.rightskip) -- nodes
    local pretolerance   = tex.pretolerance
    local tolerance      = tex.tolerance
    local adjust_spacing = tex.pdfadjustspacing
    local protrude_chars = tex.pdfprotrudechars
    local last_line_fit  = tex.lastlinefit

    local newhead = new_temp()
    setfield(newhead,"next",head)

    local adjust_spacing_status = adjust_spacing > 1 and -1 or 0

    -- metatables

    local par = {
        head                         = newhead,
        head_field                   = nil,
        display                      = display,
        font_in_short_display        = 0,
        no_shrink_error_yet          = true,   -- have we complained about infinite shrinkage?
        second_pass                  = false,  -- is this our second attempt to break this paragraph?
        final_pass                   = false,  -- is this our final attempt to break this paragraph?
        threshold                    = 0,      -- maximum badness on feasible lines

        passive                      = nil,    -- most recent node on passive list
        printed_node                 = head,   -- most recent node that has been printed
        pass_number                  = 0,      -- the number of passive nodes allocated on this pass
        auto_breaking                = 0,      -- make auto_breaking accessible out of line_break

        active_width                 = { size = 0, stretch = 0, fi = 0, fil = 0, fill = 0, filll = 0, shrink = 0, adjust_stretch = 0, adjust_shrink = 0 },
        break_width                  = { size = 0, stretch = 0, fi = 0, fil = 0, fill = 0, filll = 0, shrink = 0, adjust_stretch = 0, adjust_shrink = 0 },
        disc_width                   = { size = 0,                                                                adjust_stretch = 0, adjust_shrink = 0 },
        fill_width                   = {           stretch = 0, fi = 0, fil = 0, fill = 0, filll = 0, shrink = 0                                        },
        background                   = { size = 0, stretch = 0, fi = 0, fil = 0, fill = 0, filll = 0, shrink = 0                                        },

        hang_indent                  = hang_indent,
        hsize                        = hsize,
        hang_after                   = hang_after,
        par_shape_ptr                = par_shape_ptr,
        left_skip                    = left_skip,
        right_skip                   = right_skip,
        pretolerance                 = pretolerance,
        tolerance                    = tolerance,

        protrude_chars               = protrude_chars,
        adjust_spacing               = adjust_spacing,
        max_stretch_ratio            = adjust_spacing_status,
        max_shrink_ratio             = adjust_spacing_status,
        cur_font_step                = adjust_spacing_status,
        checked_expansion            = false,
        tracing_paragraphs           = tex.tracingparagraphs > 0,

        emergency_stretch            = tex.emergencystretch     or 0,
        looseness                    = tex.looseness            or 0,
        line_penalty                 = tex.linepenalty          or 0,
        hyphen_penalty               = tex.hyphenpenalty        or 0,
        broken_penalty               = tex.brokenpenalty        or 0,
        inter_line_penalty           = tex.interlinepenalty     or 0,
        club_penalty                 = tex.clubpenalty          or 0,
        widow_penalty                = tex.widowpenalty         or 0,
        display_widow_penalty        = tex.displaywidowpenalty  or 0,
        ex_hyphen_penalty            = tex.exhyphenpenalty      or 0,

        adj_demerits                 = tex.adjdemerits          or 0,
        double_hyphen_demerits       = tex.doublehyphendemerits or 0,
        final_hyphen_demerits        = tex.finalhyphendemerits  or 0,

        first_line                   = 0, -- tex.nest[tex.nest.ptr].modeline, -- 0, -- cur_list.pg_field

        each_line_height             = tex.pdfeachlineheight    or 0, -- this will go away
        each_line_depth              = tex.pdfeachlinedepth     or 0, -- this will go away
        first_line_height            = tex.pdffirstlineheight   or 0, -- this will go away
        last_line_depth              = tex.pdflastlinedepth     or 0, -- this will go away
        ignored_dimen                = tex.pdfignoreddimen      or 0, -- this will go away

        baseline_skip                = tonut(tex.baselineskip),
        lineskip                     = tonut(tex.lineskip),
        line_skip_limit              = tex.lineskiplimit,

        prev_depth                   = texnest[texnest.ptr].prevdepth,

        final_par_glue               = slide_nodelist(head), -- todo: we know tail already, slow

        par_break_dir                = tex.pardir,
        line_break_dir               = tex.pardir,

        internal_pen_inter           = 0,   -- running localinterlinepenalty
        internal_pen_broken          = 0,   -- running localbrokenpenalty
        internal_left_box            = nil, -- running localleftbox
        internal_left_box_width      = 0,   -- running localleftbox width
        init_internal_left_box       = nil, -- running localleftbox
        init_internal_left_box_width = 0,   -- running localleftbox width
        internal_right_box           = nil, -- running localrightbox
        internal_right_box_width     = 0,   -- running localrightbox width

        best_place                   = { }, -- how to achieve minimal_demerits
        best_pl_line                 = { }, -- corresponding line number
        easy_line                    = 0,   -- line numbers easy_line are equivalent in break nodes
        last_special_line            = 0,   -- line numbers last_special_line all have the same width
        first_width                  = 0,   -- the width of all lines last_special_line, if no parshape has been specified
        second_width                 = 0,   -- the width of all lines last_special_line
        first_indent                 = 0,   -- left margin to go with first_width
        second_indent                = 0,   -- left margin to go with second_width

        best_bet                     = nil, -- use this passive node and its predecessors
        fewest_demerits              = 0,   -- the demerits associated with best_bet
        best_line                    = 0,   -- line number following the last line of the new paragraph
        line_diff                    = 0,   -- the difference between the current line number and the optimum best_line

        -- not yet used

        best_pl_short                = { }, -- shortfall corresponding to minimal_demerits
        best_pl_glue                 = { }, -- corresponding glue stretch or shrink
        do_last_line_fit             = false,
        last_line_fit                = last_line_fit,

        minimum_demerits             = awful_badness,

        minimal_demerits             = {

            [fit_very_loose_class] = awful_badness,
            [fit_loose_class]      = awful_badness,
            [fit_decent_class]     = awful_badness,
            [fit_tight_class]      = awful_badness,

        },

        prev_char_p                  = nil,

        statistics                   = {

            noflines          = 0,
            nofprotrudedlines = 0,
            nofadjustedlines  = 0,

        },

     -- -- just a thought ... parshape functions ... it would be nice to
     -- -- also store the height so far (probably not too hard) although
     -- -- in most cases we work on grids in such cases
     --
     -- adapt_width = function(par,line)
     --     -- carry attribute, so that we can accumulate
     --     local left  = 655360 * (line - 1)
     --     local right = 655360 * (line - 1)
     --     return left, right
     -- end

    }

    -- optimizers

    par.used_left_skip  = used_skip(par.left_skip)
    par.used_right_skip = used_skip(par.right_skip)

    -- so far

    if adjust_spacing > 1 then
        local checked_expansion = { par = par }
        setmetatableindex(checked_expansion,check_expand_pars)
        par.checked_expansion = checked_expansion

        if par.tolerance < hztolerance then
            if not hzwarned then
                report_parbuilders("setting tolerance to %a for hz",hztolerance)
                hzwarned = true
            end
            par.tolerance = hztolerance
        end

    end

    -- we need par for the error message

    local background = par.background

    local l = check_shrinkage(par,left_skip)
    local r = check_shrinkage(par,right_skip)
    local l_order = stretch_orders[getfield(l,"stretch_order")]
    local r_order = stretch_orders[getfield(r,"stretch_order")]

    background.size     = getfield(l,"width")   + getfield(r,"width")
    background.shrink   = getfield(l,"shrink")  + getfield(r,"shrink")
    background[l_order] = getfield(l,"stretch")
    background[r_order] = getfield(r,"stretch") + background[r_order]

    -- this will move up so that we can assign the whole par table

    if not par_shape_ptr then
        if hang_indent == 0 then
            par.second_width  = hsize
            par.second_indent = 0
        else
            local abs_hang_after  = hang_after >0 and hang_after  or -hang_after
            local abs_hang_indent = hang_indent>0 and hang_indent or -hang_indent
            par.last_special_line = abs_hang_after
            if hang_after < 0 then
                par.first_width = hsize - abs_hang_indent
                if hang_indent >= 0 then
                    par.first_indent = hang_indent
                else
                    par.first_indent = 0
                end
                par.second_width  = hsize
                par.second_indent = 0
            else
                par.first_width  = hsize
                par.first_indent = 0
                par.second_width = hsize - abs_hang_indent
                if hang_indent >= 0 then
                    par.second_indent = hang_indent
                else
                    par.second_indent = 0
                end
            end
        end
    else
        local last_special_line = #par_shape_ptr
        par.last_special_line = last_special_line
        local parshape = par_shape_ptr[last_special_line]
        par.second_width  = parshape[2]
        par.second_indent = parshape[1]
    end

    if par.looseness == 0 then
        par.easy_line = par.last_special_line
    else
        par.easy_line = max_halfword
    end

    if pretolerance >= 0 then
        par.threshold   = pretolerance
        par.second_pass = false
        par.final_pass  = false
    else
        par.threshold   = tolerance
        par.second_pass = true
        par.final_pass  = par.emergency_stretch <= 0
        if trace_basic then
            if par.final_pass then
                report_parbuilders("enabling second and final pass")
            else
                report_parbuilders("enabling second pass")
            end
        end
    end

    if last_line_fit > 0 then
        local spec          = par.final_par_glue.spec
        local stretch       = spec.stretch
        local stretch_order = spec.stretch_order
        if stretch > 0 and stretch_order > 0 and background.fi == 0 and background.fil == 0 and background.fill == 0 and background.filll == 0 then
            par.do_last_line_fit = true
            local si = stretch_orders[stretch_order]
            if trace_lastlinefit or trace_basic then
                report_parbuilders("enabling last line fit, stretch order %a set to %a, linefit is %a",si,stretch,last_line_fit)
            end
            par.fill_width[si] = stretch
        end
    end

    return par
end

-- there are still all kind of artefacts in here (a side effect I guess of pdftex,
-- etex, omega and other extensions that got obscured by patching)

local function post_line_break(par)

    local prevgraf       = texnest[texnest.ptr].prevgraf
    local current_line   = prevgraf + 1 -- the current line number being justified

    local adjust_spacing = par.adjust_spacing
    local protrude_chars = par.protrude_chars
    local statistics     = par.statistics

    local stack          = new_dir_stack()

    local leftskip       = par.used_left_skip -- used or normal ?
    local rightskip      = par.right_skip
    local parshape       = par.par_shape_ptr
    local ignored_dimen  = par.ignored_dimen

    local adapt_width    = par.adapt_width

    -- reverse the links of the relevant passive nodes, goto first breakpoint

    local current_break  = nil

    local break_node = par.best_bet.break_node
    repeat
        local first_break = break_node
        break_node = break_node.prev_break
        first_break.prev_break = current_break
        current_break = first_break
    until not break_node

    local head = par.head

    -- maybe : each_...

    while current_break do

        inject_dirs_at_begin_of_line(stack,head)

        local disc_break      = false
        local post_disc_break = false
        local glue_break      = false

        local lineend         = nil                     -- q lineend refers to the last node of the line (and paragraph)
        local lastnode        = current_break.cur_break -- r lastnode refers to the node after which the dir nodes should be closed

        if not lastnode then
            -- only at the end
            lastnode = slide_nodelist(head) -- todo: find_tail
            if lastnode == par.final_par_glue then
                lineend  = lastnode
                lastnode = getprev(lastnode)
            end
        else -- todo: use insert_list_after
            local id = getid(lastnode)
            if id == glue_code then
                -- lastnode is normal skip
                lastnode   = replace_node(lastnode,new_rightskip(rightskip))
                glue_break = true
                lineend    = lastnode
                lastnode   = getprev(r)
            elseif id == disc_code then
                local prevlast = getprev(lastnode)
                local nextlast = getnext(lastnode)
                local subtype  = getsubtype(lastnode)
                local pre      = getfield(lastnode,"pre")
                local post     = getfield(lastnode,"post")
                local replace  = getfield(lastnode,"replace")
                if subtype == second_disc_code then
                    if not (getid(prevlast) == disc_code and getsubtype(prevlast) == first_disc_code) then
                        report_parbuilders('unsupported disc at location %a',3)
                    end
                    if pre then
                        flush_nodelist(pre)
                        setfield(lastnode,"pre",nil)
                        pre = nil -- signal
                    end
                    if replace then
                        local n = find_tail(replace)
                        setfield(prevlast,"next",replace)
                        setfield(replace,"prev",prevlast)
                        setfield(n,"next",lastnode)
                        setfield(lastnode,"prev",n)
                        setfield(lastnode,"replace",nil)
                        replace = nil -- signal
                    end
                    local pre     = getfield(prevlast,"pre")
                    local post    = getfield(prevlast,"post")
                    local replace = getfield(prevlast,"replace")
                    if pre then
                        flush_nodelist(pre)
                        setfield(prevlast,"pre",nil)
                    end
                    if replace then
                        flush_nodelist(replace)
                        setfield(prevlast,"replace",nil)
                    end
                    if post then
                        flush_nodelist(post)
                        setfield(prevlast,"post",nil)
                    end
                elseif subtype == first_disc_code then
                    -- what is v ... next probably
                    if not (getid(v) == disc_code and getsubtype(v) == second_disc_code) then
                        report_parbuilders('unsupported disc at location %a',4)
                    end
                    setfield(nextlast,"subtype",regular_disc_code)
                    setfield(nextlast,"replace",post)
                    setfield(lastnode,"post",nil)
                end
                if replace then
                    setfield(lastnode,"replace",nil) -- free
                    flush_nodelist(replace)
                end
                if pre then
                    local n = find_tail(pre)
                    setfield(prevlast,"next",pre)
                    setfield(pre,"prev",prevlast)
                    setfield(n,"next",lastnode)
                    setfield(lastnode,"prev",n)
                    setfield(lastnode,"pre",nil)
                end
                if post then
                    local n = find_tail(post)
                    setfield(lastnode,"next",post)
                    setfield(post,"prev",lastnode)
                    setfield(n,"next",nextlast)
                    setfield(nextlast,"prev",n)
                    setfield(lastnode,"post",nil)
                    post_disc_break = true
                end
                disc_break = true
            elseif id == kern_code then
                setfield(lastnode,"kern",0)
            elseif getid(lastnode) == math_code then
                setfield(lastnode,"surround",0)
            end
        end
        lastnode = inject_dirs_at_end_of_line(stack,lastnode,getnext(head),current_break.cur_break)
        local rightbox = current_break.passive_right_box
        if rightbox then
            lastnode = insert_node_after(lastnode,lastnode,copy_node(rightbox))
        end
        if not lineend then
            lineend = lastnode
        end
        if lineend and lineend ~= head and protrude_chars > 0 then
            local id = getid(lineend)
            local c = (disc_break and (id == glyph_code or id ~= disc_code) and lineend) or getprev(lineend)
            local p = find_protchar_right(getnext(head),c)
            if p and getid(p) == glyph_code then
                local w, last_rightmost_char = right_pw(p)
                if last_rightmost_char and w ~= 0 then
                    -- so we inherit attributes, lineend is new pseudo head
                    lineend, c = insert_node_after(lineend,c,new_rightmarginkern(copy_node(last_rightmost_char),-w))
                end
            end
        end
        -- we finish the line
        local r = getnext(lineend)
        setfield(lineend,"next",nil)
        if not glue_break then
            if rightskip then
                insert_node_after(lineend,lineend,new_rightskip(right_skip)) -- lineend moves on as pseudo head
            end
        end
        -- each time ?
        local q = getnext(head)
        setfield(head,"next",r)
        if r then
            setfield(r,"prev",head)
        end
        -- insert leftbox (if needed after parindent)
        local leftbox = current_break.passive_left_box
        if leftbox then
            local first = getnext(q)
            if first and current_line == (par.first_line + 1) and getid(first) == hlist_code and not getlist(first) then
                insert_node_after(q,q,copy_node(leftbox))
            else
                q = insert_node_before(q,q,copy_node(leftbox))
            end
        end
        if protrude_chars > 0 then
            local p = find_protchar_left(q)
            if p and getid(p) == glyph_code then
                local w, last_leftmost_char = left_pw(p)
                if last_leftmost_char and w ~= 0 then
                    -- so we inherit attributes, q is pseudo head and moves back
                    q = insert_node_before(q,q,new_leftmarginkern(copy_node(last_leftmost_char),-w))
                end
            end
        end
        if leftskip then
            q = insert_node_before(q,q,new_leftskip(leftskip))
        end
        local cur_width, cur_indent
        if current_line > par.last_special_line then
            cur_indent = par.second_indent
            cur_width  = par.second_width
        elseif parshape then
            local shape = parshape[current_line]
            cur_indent = shape[1]
            cur_width  = shape[2]
        else
            cur_indent = par.first_indent
            cur_width  = par.first_width
        end

        if adapt_width then -- extension
            local l, r = adapt_width(par,current_line)
            cur_indent = cur_indent + l
            cur_width  = cur_width  - l - r
        end

        statistics.noflines = statistics.noflines + 1
        local finished_line = nil
        if adjust_spacing > 0 then
            statistics.nofadjustedlines = statistics.nofadjustedlines + 1
            finished_line = xpack_nodes(q,cur_width,"cal_expand_ratio",par.par_break_dir,par.first_line,current_line) -- ,current_break.analysis)
        else
            finished_line = xpack_nodes(q,cur_width,"exactly",par.par_break_dir,par.first_line,current_line) -- ,current_break.analysis)
        end
        if protrude_chars > 0 then
            statistics.nofprotrudedlines = statistics.nofprotrudedlines + 1
        end
        -- wrong:
        local adjust_head     = texlists.adjust_head
        local pre_adjust_head = texlists.pre_adjust_head
        --
        setfield(finished_line,"shift",cur_indent)
        -- this will probably go away:
        if par.each_line_height ~= ignored_dimen then
            setfield(finished_line,"height",par.each_line_height)
        end
        if par.each_line_depth ~= ignored_dimen then
            setfield(finished_line,"depth",par.each_line_depth)
        end
        if par.first_line_height ~= ignored_dimen and (current_line == par.first_line + 1) then
            setfield(finished_line,"height",par.first_line_height)
        end
        if par.last_line_depth ~= ignored_dimen and current_line + 1 == par.best_line then
            setfield(finished_line,"depth",par.last_line_depth)
        end
        --
        if texlists.pre_adjust_head ~= pre_adjust_head then
            append_list(par, texlists.pre_adjust_head)
            texlists.pre_adjust_head = pre_adjust_head
        end
        append_to_vlist(par,finished_line)
        if texlists.adjust_head ~= adjust_head then
            append_list(par, texlists.adjust_head)
            texlists.adjust_head = adjust_head
        end
        --
        local pen
        if current_line + 1 ~= par.best_line then
            if current_break.passive_pen_inter then
                pen = current_break.passive_pen_inter
            else
                pen = par.inter_line_penalty
            end
            if current_line == prevgraf + 1 then
                pen = pen + par.club_penalty
            end
            if current_line + 2 == par.best_line then
                if par.display then
                    pen = pen + par.display_widow_penalty
                else
                    pen = pen + par.widow_penalty
                end
            end
            if disc_break then
                if current_break.passive_pen_broken ~= 0 then
                    pen = pen + current_break.passive_pen_broken
                else
                    pen = pen + par.broken_penalty
                end
            end
            if pen ~= 0 then
                append_to_vlist(par,new_penalty(pen))
            end
        end
        current_line  = current_line + 1
        current_break = current_break.prev_break
        if current_break and not post_disc_break then
            local current = head
            local next    = nil
            while true do
                next = getnext(current)
                if next == current_break.cur_break or getid(next) == glyph_code then
                    break
                end
                local id      = getid(next)
                local subtype = getsubtype(next)
                if id == whatsit_code and subtype == localpar_code then
                    -- nothing
                elseif id < math_code then
                    -- messy criterium
                    break
elseif id == math_code then
    -- keep the math node
    setfield(next,"surround",0)
    break
                elseif id == kern_code and (subtype ~= userkern_code and not getattr(next,a_fontkern)) then
                    -- fontkerns and accent kerns as well as otf injections
                    break
                end
                current = next
            end
            if current ~= head then
                setfield(current,"next",nil)
                flush_nodelist(getnext(head))
                setfield(head,"next",next)
                if next then
                    setfield(next,"prev",head)
                end
            end
        end
    end
 -- if current_line ~= par.best_line then
 --     report_parbuilders("line breaking")
 -- end
    par.head = nil -- needs checking
    current_line = current_line - 1
    if trace_basic then
        report_parbuilders("paragraph broken into %a lines",current_line)
    end
    texnest[texnest.ptr].prevgraf  = current_line
end

local function wrap_up(par)
    if par.tracing_paragraphs then
        diagnostics.stop()
    end
    if par.do_last_line_fit then
        local best_bet     = par.best_bet
        local active_short = best_bet.active_short
        local active_glue  = best_bet.active_glue
        if active_short == 0 then
            if trace_lastlinefit then
                report_parbuilders("disabling last line fit, no active_short")
            end
            par.do_last_line_fit = false
        else
            local glue = par.final_par_glue
            local spec = copy_node(getfield(glue,"spec"))
            setfield(spec,"width",getfield(spec,"width") + active_short - active_glue)
            setfield(spec,"stretch",0)
        --  flush_node(getfield(glue,"spec")) -- brrr, when we do this we can get an "invalid id stretch message", maybe dec refcount
            setfield(glue,"spec",spec)
            if trace_lastlinefit then
                report_parbuilders("applying last line fit, short %a, glue %p",active_short,active_glue)
            end
        end
    end
    -- we have a bunch of glue and and temp nodes not freed
    local head = par.head
    if getid(head) == temp_code then
        par.head = getnext(head)
        flush_node(head)
    end
    post_line_break(par)
    reset_meta(par)
    register_statistics(par)
    return par.head_field
end

-- we could do active nodes differently ... table instead of linked list or a list
-- with prev nodes but it doesn't save much (as we still need to keep indices then
-- in next)

local function deactivate_node(par,prev_prev_r,prev_r,r,cur_active_width,checked_expansion) -- no need for adjust if disabled
    local active = par.active
    local active_width = par.active_width
    prev_r.next = r.next
    -- removes r
    -- r = nil
    if prev_r == active then
        r = active.next
        if r.id == delta_code then
            local aw = active_width.size    + r.size    active_width.size    = aw  cur_active_width.size    = aw
            local aw = active_width.stretch + r.stretch active_width.stretch = aw  cur_active_width.stretch = aw
            local aw = active_width.fi      + r.fi      active_width.fi      = aw  cur_active_width.fi      = aw
            local aw = active_width.fil     + r.fil     active_width.fil     = aw  cur_active_width.fil     = aw
            local aw = active_width.fill    + r.fill    active_width.fill    = aw  cur_active_width.fill    = aw
            local aw = active_width.filll   + r.filll   active_width.filll   = aw  cur_active_width.filll   = aw
            local aw = active_width.shrink  + r.shrink  active_width.shrink  = aw  cur_active_width.shrink  = aw
            if checked_expansion then
                local aw = active_width.adjust_stretch + r.adjust_stretch  active_width.adjust_stretch = aw  cur_active_width.adjust_stretch = aw
                local aw = active_width.adjust_shrink  + r.adjust_shrink   active_width.adjust_shrink  = aw  cur_active_width.adjust_shrink  = aw
            end
            active.next = r.next
            -- removes r
            -- r = nil
        end
    elseif prev_r.id == delta_code then
        r = prev_r.next
        if r == active then
            cur_active_width.size    = cur_active_width.size    - prev_r.size
            cur_active_width.stretch = cur_active_width.stretch - prev_r.stretch
            cur_active_width.fi      = cur_active_width.fi      - prev_r.fi
            cur_active_width.fil     = cur_active_width.fil     - prev_r.fil
            cur_active_width.fill    = cur_active_width.fill    - prev_r.fill
            cur_active_width.filll   = cur_active_width.filll   - prev_r.filll
            cur_active_width.shrink  = cur_active_width.shrink  - prev_r.shrink
            if checked_expansion then
                cur_active_width.adjust_stretch = cur_active_width.adjust_stretch - prev_r.adjust_stretch
                cur_active_width.adjust_shrink  = cur_active_width.adjust_shrink  - prev_r.adjust_shrink
            end
            prev_prev_r.next = active
            -- removes prev_r
            -- prev_r = nil
            prev_r = prev_prev_r
        elseif r.id == delta_code then
            local rn = r.size     cur_active_width.size    = cur_active_width.size    + rn  prev_r.size    = prev_r.size    + rn
            local rn = r.stretch  cur_active_width.stretch = cur_active_width.stretch + rn  prev_r.stretch = prev_r.stretch + rn
            local rn = r.fi       cur_active_width.fi      = cur_active_width.fi      + rn  prev_r.fi      = prev_r.fi      + rn
            local rn = r.fil      cur_active_width.fil     = cur_active_width.fil     + rn  prev_r.fil     = prev_r.fil     + rn
            local rn = r.fill     cur_active_width.fill    = cur_active_width.fill    + rn  prev_r.fill    = prev_r.fill    + rn
            local rn = r.filll    cur_active_width.filll   = cur_active_width.filll   + rn  prev_r.filll   = prev_r.fill    + rn
            local rn = r.shrink   cur_active_width.shrink  = cur_active_width.shrink  + rn  prev_r.shrink  = prev_r.shrink  + rn
            if checked_expansion then
                local rn = r.adjust_stretch  cur_active_width.adjust_stretch = cur_active_width.adjust_stretch + rn  prev_r.adjust_stretch = prev_r.adjust_stretch    + rn
                local rn = r.adjust_shrink   cur_active_width.adjust_shrink  = cur_active_width.adjust_shrink  + rn  prev_r.adjust_shrink  = prev_r.adjust_shrink     + rn
            end
            prev_r.next = r.next
            -- removes r
            -- r = nil
        end
    end
    return prev_r, r
end

local function lastlinecrap(shortfall,active_short,active_glue,cur_active_width,fill_width,last_line_fit)
    if active_short == 0 or active_glue <= 0 then
        return false, 0, fit_decent_class, 0, 0
    end
    if cur_active_width.fi ~= fill_width.fi or cur_active_width.fil ~= fill_width.fil or cur_active_width.fill ~= fill_width.fill or cur_active_width.filll ~= fill_width.filll then
        return false, 0, fit_decent_class, 0, 0
    end
    local adjustment = active_short > 0 and cur_active_width.stretch or cur_active_width.shrink
    if adjustment <= 0 then
        return false, 0, fit_decent_class, adjustment, 0
    end
    adjustment = calculate_fraction(adjustment,active_short,active_glue,maxdimen)
    if last_line_fit < 1000 then
        adjustment = calculate_fraction(adjustment,last_line_fit,1000,maxdimen) -- uses previous adjustment
    end
    local fit_class = fit_decent_class
    if adjustment > 0 then
        local stretch = cur_active_width.stretch
        if adjustment > shortfall then
            adjustment = shortfall
        end
        if adjustment > 7230584 and stretch < 1663497 then
            return true, fit_very_loose_class, shortfall, adjustment, infinite_badness
        end
     -- if adjustment == 0 then -- badness = 0
     --     return true, shortfall, fit_decent_class, 0, 0
     -- elseif stretch <= 0 then -- badness = 10000
     --     return true, shortfall, fit_very_loose_class, adjustment, 10000
     -- end
     -- local badness = (adjustment == 0 and 0) or (stretch <= 0 and 10000) or calculate_badness(adjustment,stretch)
        local badness = calculate_badness(adjustment,stretch)
        if badness > 99 then
            return true, shortfall, fit_very_loose_class, adjustment, badness
        elseif badness > 12 then
            return true, shortfall, fit_loose_class, adjustment, badness
        else
            return true, shortfall, fit_decent_class, adjustment, badness
        end
    elseif adjustment < 0 then
        local shrink = cur_active_width.shrink
        if -adjustment > shrink then
            adjustment = -shrink
        end
        local badness = calculate_badness(-adjustment,shrink)
        if badness > 12 then
            return true, shortfall, fit_tight_class, adjustment, badness
        else
            return true, shortfall, fit_decent_class, adjustment, badness
        end
    else
        return false, 0, fit_decent_class, 0, 0
    end
end

-- todo: statistics .. count tries and so

local trialcount = 0

local function try_break(pi, break_type, par, first_p, current, checked_expansion)

-- trialcount = trialcount + 1
-- print(trialcount,pi,break_type,current,nuts.tostring(current))

    if pi >= infinite_penalty then          -- this breakpoint is inhibited by infinite penalty
        local p_active = par.active
        return p_active, p_active and p_active.next
    elseif pi <= -infinite_penalty then     -- this breakpoint will be forced
        pi = eject_penalty
    end

    local prev_prev_r         = nil         -- a step behind prev_r, if type(prev_r)=delta_code
    local prev_r              = par.active  -- stays a step behind r
    local r                   = nil         -- runs through the active list
    local no_break_yet        = true        -- have we found a feasible break at current?
    local node_r_stays_active = false       -- should node r remain in the active list?
    local line_width          = 0           -- the current line will be justified to this width
    local line_number         = 0           -- line number of current active node
    local old_line_number     = 0           -- maximum line number in current equivalence class of lines

    local protrude_chars      = par.protrude_chars
    local checked_expansion   = par.checked_expansion
    local break_width         = par.break_width
    local active_width        = par.active_width
    local background          = par.background
    local minimal_demerits    = par.minimal_demerits
    local best_place          = par.best_place
    local best_pl_line        = par.best_pl_line
    local best_pl_short       = par.best_pl_short
    local best_pl_glue        = par.best_pl_glue
    local do_last_line_fit    = par.do_last_line_fit
    local final_pass          = par.final_pass
    local tracing_paragraphs  = par.tracing_paragraphs
 -- local par_active          = par.active

    local adapt_width         = par.adapt_width

    local parshape            = par.par_shape_ptr

    local cur_active_width = checked_expansion and { -- distance from current active node
        size           = active_width.size,
        stretch        = active_width.stretch,
        fi             = active_width.fi,
        fil            = active_width.fil,
        fill           = active_width.fill,
        filll          = active_width.filll,
        shrink         = active_width.shrink,
        adjust_stretch = active_width.adjust_stretch,
        adjust_shrink  = active_width.adjust_shrink,
    } or {
        size           = active_width.size,
        stretch        = active_width.stretch,
        fi             = active_width.fi,
        fil            = active_width.fil,
        fill           = active_width.fill,
        filll          = active_width.filll,
        shrink         = active_width.shrink,
    }

    while true do
        r = prev_r.next
        if r.id == delta_code then
            cur_active_width.size    = cur_active_width.size    + r.size
            cur_active_width.stretch = cur_active_width.stretch + r.stretch
            cur_active_width.fi      = cur_active_width.fi      + r.fi
            cur_active_width.fil     = cur_active_width.fil     + r.fil
            cur_active_width.fill    = cur_active_width.fill    + r.fill
            cur_active_width.filll   = cur_active_width.filll   + r.filll
            cur_active_width.shrink  = cur_active_width.shrink  + r.shrink
            if checked_expansion then
                cur_active_width.adjust_stretch = cur_active_width.adjust_stretch + r.adjust_stretch
                cur_active_width.adjust_shrink  = cur_active_width.adjust_shrink  + r.adjust_shrink
            end
            prev_prev_r = prev_r
            prev_r = r
        else
            line_number = r.line_number
            if line_number > old_line_number then
                local minimum_demerits = par.minimum_demerits
                if minimum_demerits < awful_badness and (old_line_number ~= par.easy_line or r == par.active) then
                    if no_break_yet then
                        no_break_yet = false
                        break_width.size    = background.size
                        break_width.stretch = background.stretch
                        break_width.fi      = background.fi
                        break_width.fil     = background.fil
                        break_width.fill    = background.fill
                        break_width.filll   = background.filll
                        break_width.shrink  = background.shrink
                        if checked_expansion then
                            break_width.adjust_stretch = 0
                            break_width.adjust_shrink  = 0
                        end
                        if current then
                            compute_break_width(par,break_type,current)
                        end
                    end
                    if prev_r.id == delta_code then
                        prev_r.size    = prev_r.size    - cur_active_width.size   + break_width.size
                        prev_r.stretch = prev_r.stretch - cur_active_width.stretc + break_width.stretch
                        prev_r.fi      = prev_r.fi      - cur_active_width.fi     + break_width.fi
                        prev_r.fil     = prev_r.fil     - cur_active_width.fil    + break_width.fil
                        prev_r.fill    = prev_r.fill    - cur_active_width.fill   + break_width.fill
                        prev_r.filll   = prev_r.filll   - cur_active_width.filll  + break_width.filll
                        prev_r.shrink  = prev_r.shrink  - cur_active_width.shrink + break_width.shrink
                        if checked_expansion then
                            prev_r.adjust_stretch = prev_r.adjust_stretch - cur_active_width.adjust_stretch + break_width.adjust_stretch
                            prev_r.adjust_shrink  = prev_r.adjust_shrink  - cur_active_width.adjust_shrink  + break_width.adjust_shrink
                        end
                    elseif prev_r == par.active then
                        active_width.size    = break_width.size
                        active_width.stretch = break_width.stretch
                        active_width.fi      = break_width.fi
                        active_width.fil     = break_width.fil
                        active_width.fill    = break_width.fill
                        active_width.filll   = break_width.filll
                        active_width.shrink  = break_width.shrink
                        if checked_expansion then
                            active_width.adjust_stretch = break_width.adjust_stretch
                            active_width.adjust_shrink  = break_width.adjust_shrink
                        end
                    else
                        local q = checked_expansion and {
                            id             = delta_code,
                            subtype        = nosubtype_code,
                            next           = r,
                            size           = break_width.size           - cur_active_width.size,
                            stretch        = break_width.stretch        - cur_active_width.stretch,
                            fi             = break_width.fi             - cur_active_width.fi,
                            fil            = break_width.fil            - cur_active_width.fil,
                            fill           = break_width.fill           - cur_active_width.fill,
                            filll          = break_width.filll          - cur_active_width.filll,
                            shrink         = break_width.shrink         - cur_active_width.shrink,
                            adjust_stretch = break_width.adjust_stretch - cur_active_width.adjust_stretch,
                            adjust_shrink  = break_width.adjust_shrink  - cur_active_width.adjust_shrink,
                        } or {
                            id             = delta_code,
                            subtype        = nosubtype_code,
                            next           = r,
                            size           = break_width.size           - cur_active_width.size,
                            stretch        = break_width.stretch        - cur_active_width.stretch,
                            fi             = break_width.fi             - cur_active_width.fi,
                            fil            = break_width.fil            - cur_active_width.fil,
                            fill           = break_width.fill           - cur_active_width.fill,
                            filll          = break_width.filll          - cur_active_width.filll,
                            shrink         = break_width.shrink         - cur_active_width.shrink,
                        }
                        prev_r.next = q
                        prev_prev_r = prev_r
                        prev_r = q
                    end
                    local adj_demerits     = par.adj_demerits
                    local abs_adj_demerits = adj_demerits > 0 and adj_demerits or -adj_demerits
                    if abs_adj_demerits >= awful_badness - minimum_demerits then
                        minimum_demerits = awful_badness - 1
                    else
                        minimum_demerits = minimum_demerits + abs_adj_demerits
                    end
                    for fit_class = fit_very_loose_class, fit_tight_class do
                        if minimal_demerits[fit_class] <= minimum_demerits then
                            -- insert a new active node from best_place[fit_class] to current
                            par.pass_number = par.pass_number + 1
                            local prev_break = best_place[fit_class]
                            local passive = {
                                id                          = passive_code,
                                subtype                     = nosubtype_code,
                                next                        = par.passive,
                                cur_break                   = current,
                                serial                      = par.pass_number,
                                prev_break                  = prev_break,
                                passive_pen_inter           = par.internal_pen_inter,
                                passive_pen_broken          = par.internal_pen_broken,
                                passive_last_left_box       = par.internal_left_box,
                                passive_last_left_box_width = par.internal_left_box_width,
                                passive_left_box            = prev_break and prev_break.passive_last_left_box or par.init_internal_left_box,
                                passive_left_box_width      = prev_break and prev_break.passive_last_left_box_width or par.init_internal_left_box_width,
                                passive_right_box           = par.internal_right_box,
                                passive_right_box_width     = par.internal_right_box_width,
-- analysis = table.fastcopy(cur_active_width),
                            }
                            par.passive = passive
                            local q = {
                                id             = break_type,
                                subtype        = fit_class,
                                break_node     = passive,
                                line_number    = best_pl_line[fit_class] + 1,
                                total_demerits = minimal_demerits[fit_class], --  or 0,
                                next           = r,
                            }
                            if do_last_line_fit then
                                local active_short = best_pl_short[fit_class]
                                local active_glue  = best_pl_glue[fit_class]
                                q.active_short = active_short
                                q.active_glue  = active_glue
                                if trace_lastlinefit then
                                    report_parbuilders("setting short to %i and glue to %p using class %a",active_short,active_glue,fit_class)
                                end
                            end
                         -- q.next = r -- already done
                            prev_r.next = q
                            prev_r = q
                            if tracing_paragraphs then
                                diagnostics.break_node(par,q,fit_class,break_type,current)
                            end
                        end
                        minimal_demerits[fit_class] = awful_badness
                    end
                    par.minimum_demerits = awful_badness
                    if r ~= par.active then
                        local q = checked_expansion and {
                            id             = delta_code,
                            subtype        = nosubtype_code,
                            next           = r,
                            size           = cur_active_width.size           - break_width.size,
                            stretch        = cur_active_width.stretch        - break_width.stretch,
                            fi             = cur_active_width.fi             - break_width.fi,
                            fil            = cur_active_width.fil            - break_width.fil,
                            fill           = cur_active_width.fill           - break_width.fill,
                            filll          = cur_active_width.filll          - break_width.filll,
                            shrink         = cur_active_width.shrink         - break_width.shrink,
                            adjust_stretch = cur_active_width.adjust_stretch - break_width.adjust_stretch,
                            adjust_shrink  = cur_active_width.adjust_shrink  - break_width.adjust_shrink,
                        } or {
                            id             = delta_code,
                            subtype        = nosubtype_code,
                            next           = r,
                            size           = cur_active_width.size           - break_width.size,
                            stretch        = cur_active_width.stretch        - break_width.stretch,
                            fi             = cur_active_width.fi             - break_width.fi,
                            fil            = cur_active_width.fil            - break_width.fil,
                            fill           = cur_active_width.fill           - break_width.fill,
                            filll          = cur_active_width.filll          - break_width.filll,
                            shrink         = cur_active_width.shrink         - break_width.shrink,
                        }
                     -- q.next = r -- already done
                        prev_r.next = q
                        prev_prev_r = prev_r
                        prev_r = q
                    end
                end
                if r == par.active then
                    return r, r and r.next -- p_active, n_active
                end
                if line_number > par.easy_line then
                    old_line_number = max_halfword - 1
                    line_width = par.second_width
                else
                    old_line_number = line_number
                    if line_number > par.last_special_line then
                        line_width = par.second_width
                    elseif parshape then
                        line_width = parshape[line_number][2]
                    else
                        line_width = par.first_width
                    end
                end
                if adapt_width then
                    local l, r = adapt_width(par,line_number)
                    line_width = line_width  - l - r
                end
            end
            local artificial_demerits = false -- has d been forced to zero
            local shortfall = line_width - cur_active_width.size - par.internal_right_box_width -- used in badness calculations
            if not r.break_node then
                shortfall = shortfall - par.init_internal_left_box_width
            else
                shortfall = shortfall - (r.break_node.passive_last_left_box_width or 0)
            end
            local pw, lp, rp -- used later on
            if protrude_chars > 1 then
                -- this is quite time consuming
                local b = r.break_node
                local l = b and b.cur_break or first_p
                local o = current and getprev(current)
                if current and getid(current) == disc_code and getfield(current,"pre") then
                    o = find_tail(getfield(current,"pre"))
                else
                    o = find_protchar_right(l,o)
                end
                if o and getid(o) == glyph_code then
                    pw, rp = right_pw(o)
                    shortfall = shortfall + pw
                end
                local id = getid(l)
                if id == glyph_code then
                    -- ok ?
                elseif id == disc_code and l.post then
                    l = l.post -- TODO: first char could be a disc
                else
                    l = find_protchar_left(l)
                end
                if l and getid(l) == glyph_code then
                    pw, lp = left_pw(l)
                    shortfall = shortfall + pw
                end
            end
            if checked_expansion and shortfall ~= 0 then
                local margin_kern_stretch = 0
                local margin_kern_shrink  = 0
                if protrude_chars > 1 then
                    if lp then
                        local data = expansions[getfont(lp)][getchar(lp)]
                        if data then
                            margin_kern_stretch, margin_kern_shrink = data.glyphstretch, data.glyphshrink
                        end
                    end
                    if rp then
                        local data = expansions[getfont(lp)][getchar(lp)]
                        if data then
                            margin_kern_stretch = margin_kern_stretch + data.glyphstretch
                            margin_kern_shrink  = margin_kern_shrink  + data.glyphshrink
                        end
                    end
                end
                local total = cur_active_width.adjust_stretch + margin_kern_stretch
                if shortfall > 0 and total > 0 then
                    if total > shortfall then
                        shortfall = total / (par.max_stretch_ratio / par.cur_font_step) / 2
                    else
                        shortfall = shortfall - total
                    end
                else
                    total = cur_active_width.adjust_shrink + margin_kern_shrink
                    if shortfall < 0 and total > 0 then
                        if total > - shortfall then
                            shortfall = - total / (par.max_shrink_ratio / par.cur_font_step) / 2
                        else
                            shortfall = shortfall + total
                        end
                    end
                end
            end
            local b = 0
            local g = 0
            local fit_class = fit_decent_class
            local found = false
            if shortfall > 0  then
                if cur_active_width.fi ~= 0 or cur_active_width.fil ~= 0 or cur_active_width.fill ~= 0 or cur_active_width.filll ~= 0 then
                    if not do_last_line_fit then
                        -- okay
                    elseif not current then
                        found, shortfall, fit_class, g, b = lastlinecrap(shortfall,r.active_short,r.active_glue,cur_active_width,par.fill_width,par.last_line_fit)
                    else
                        shortfall = 0
                    end
                else
                    local stretch = cur_active_width.stretch
                    if shortfall > 7230584 and stretch < 1663497 then
                        b = infinite_badness
                        fit_class = fit_very_loose_class
                    else
                        b = calculate_badness(shortfall,stretch)
                        if b > 99 then
                            fit_class = fit_very_loose_class
                        elseif b > 12 then
                            fit_class = fit_loose_class
                        else
                            fit_class = fit_decent_class
                        end
                    end
                end
            else
                local shrink = cur_active_width.shrink
                if -shortfall > shrink then
                    b = infinite_badness + 1
                else
                    b = calculate_badness(-shortfall,shrink)
                end
                if b > 12 then
                    fit_class = fit_tight_class
                else
                    fit_class = fit_decent_class
                end
            end
            if do_last_line_fit and not found then
                if not current then
                 -- g = 0
                    shortfall = 0
                elseif shortfall > 0 then
                    g = cur_active_width.stretch
                elseif shortfall < 0 then
                    g = cur_active_width.shrink
                else
                    g = 0
                end
            end
            -- ::FOUND::
            local continue_only = false -- brrr
            if b > infinite_badness or pi == eject_penalty then
                if final_pass and par.minimum_demerits == awful_badness and r.next == par.active and prev_r == par.active then
                    artificial_demerits = true -- set demerits zero, this break is forced
                    node_r_stays_active = false
                elseif b > par.threshold then
                    prev_r, r = deactivate_node(par,prev_prev_r,prev_r,r,cur_active_width,checked_expansion)
                    continue_only = true
                else
                    node_r_stays_active = false
                end
            else
                prev_r = r
                if b > par.threshold then
                    continue_only = true
                else
                    node_r_stays_active = true
                end
            end
            if not continue_only then
                local d = 0
                if not artificial_demerits then
                    d = par.line_penalty + b
                    if (d >= 0 and d or -d) >= 10000 then -- abs(d)
                        d = 100000000
                    else
                        d = d * d
                    end
                    if pi == 0 then
                        -- nothing
                    elseif pi > 0 then
                        d = d + pi * pi
                    elseif pi > eject_penalty then
                        d = d - pi * pi
                    end
                    if break_type == hyphenated_code and r.id == hyphenated_code then
                        if current then
                            d = d + par.double_hyphen_demerits
                        else
                            d = d + par.final_hyphen_demerits
                        end
                    end
                    local delta = fit_class - r.subtype
                    if (delta >= 0 and delta or -delta) > 1 then -- abs(delta)
                        d = d + par.adj_demerits
                    end
                end
                if tracing_paragraphs then
                    diagnostics.feasible_break(par,current,r,b,pi,d,artificial_demerits)
                end
                d = d + r.total_demerits -- this is the minimum total demerits from the beginning to current via r
                if d <= minimal_demerits[fit_class] then
                    minimal_demerits[fit_class] = d
                    best_place      [fit_class] = r.break_node
                    best_pl_line    [fit_class] = line_number
                    if do_last_line_fit then
                        best_pl_short[fit_class] = shortfall
                        best_pl_glue [fit_class] = g
                        if trace_lastlinefit then
                            report_parbuilders("storing last line fit short %a and glue %p in class %a",shortfall,g,fit_class)
                        end
                    end
                    if d < par.minimum_demerits then
                        par.minimum_demerits = d
                    end
                end
                if not node_r_stays_active then
                    prev_r, r = deactivate_node(par,prev_prev_r,prev_r,r,cur_active_width,checked_expansion)
                end
            end
        end
    end
end

-- we can call the normal one for simple box building in the otr so we need
-- frequent enabling/disabling

local dcolor = { [0] = "red", "green", "blue", "magenta", "cyan", "gray" }

local temp_head = new_temp()

function constructors.methods.basic(head,d)
    head = tonut(head)

    if trace_basic then
        report_parbuilders("starting at %a",head)
    end

    local par = initialize_line_break(head,d)

    local checked_expansion  = par.checked_expansion
    local active_width       = par.active_width
    local disc_width         = par.disc_width
    local background         = par.background
    local tracing_paragraphs = par.tracing_paragraphs

    local dirstack = new_dir_stack()

    if tracing_paragraphs then
        diagnostics.start()
        if par.pretolerance >= 0 then
            diagnostics.current_pass(par,"firstpass")
        end
    end

    while true do
        reset_meta(par)
        if par.threshold > infinite_badness then
            par.threshold = infinite_badness
        end
        par.active.next = {
            id             = unhyphenated_code,
            subtype        = fit_decent_class,
            next           = par.active,
            break_node     = nil,
            line_number    = par.first_line + 1,
            total_demerits = 0,
            active_short   = 0,
            active_glue    = 0,
        }
        active_width.size           = background.size
        active_width.stretch        = background.stretch
        active_width.fi             = background.fi
        active_width.fil            = background.fil
        active_width.fill           = background.fill
        active_width.filll          = background.filll
        active_width.shrink         = background.shrink

        if checked_expansion then
            active_width.adjust_stretch = 0
            active_width.adjust_shrink  = 0
        end

        par.passive                 = nil -- = 0
        par.printed_node            = temp_head -- only when tracing, shared
        par.pass_number             = 0
--         par.auto_breaking           = true

        setfield(temp_head,"next",head)

        local current               = head
        local first_p               = current

        local auto_breaking         = true

        par.font_in_short_display   = 0

        if current and getid(current) == whatsit_code and getsubtype(current) == localpar_code then
            par.init_internal_left_box       = getfield(current,"box_left")
            par.init_internal_left_box_width = getfield(current,"box_left_width")
            par.internal_pen_inter           = getfield(current,"pen_inter")
            par.internal_pen_broken          = getfield(current,"pen_broken")
            par.internal_left_box            = par.init_internal_left_box
            par.internal_left_box_width      = par.init_internal_left_box_width
            par.internal_right_box           = getfield(current,"box_right")
            par.internal_right_box_width     = getfield(current,"box_right_width")
        end

        -- all passes are combined in this loop so maybe we should split this into
        -- three function calls; we then also need to do the wrap_up elsewhere

        -- split into normal and expansion loop

        -- use an active local

        local fontexp, lastfont -- we can pass fontexp to calculate width if needed

        -- i flattened the inner loop over glyphs .. it looks nicer and the extra p_active ~= n_active
        -- test is fast enough (and try_break now returns the updated values); the kern helper has been
        -- inlined as it did a double check on id so in fact we had hardly any code to share

        local p_active    = par.active
        local n_active    = p_active and p_active.next
        local second_pass = par.second_pass

        trialcount = 0

        while current and p_active ~= n_active do
            local id = getid(current)
            if id == glyph_code then
                if is_rotated[par.line_break_dir] then
                    active_width.size = active_width.size + getfield(current,"height") + getfield(current,"depth")
                else
                    active_width.size = active_width.size + getfield(current,"width")
                end
                if checked_expansion then
                    local currentfont = getfont(current)
                    local data= checked_expansion[currentfont]
                    if data then
                        if currentfont ~= lastfont then
                            fontexps = checked_expansion[currentfont] -- a bit redundant for the par line packer
                            lastfont = currentfont
                        end
                        if fontexps then
                            local expansion = fontexps[getchar(current)]
                            if expansion then
                                active_width.adjust_stretch = active_width.adjust_stretch + expansion.glyphstretch
                                active_width.adjust_shrink  = active_width.adjust_shrink  + expansion.glyphshrink
                            end
                        end
                    end
                end
            elseif id == hlist_code or id == vlist_code then
                if is_parallel[getfield(current,"dir")][par.line_break_dir] then
                    active_width.size = active_width.size + getfield(current,"width")
                else
                    active_width.size = active_width.size + getfield(current,"depth") + getfield(current,"height")
                end
            elseif id == glue_code then
--                 if par.auto_breaking then
                if auto_breaking then
                    local prev_p = getprev(current)
                    if prev_p and prev_p ~= temp_head then
                        local id = getid(prev_p)
                        if id == glyph_code or
                            (id < math_code and (id ~= whatsit_code or getsubtype(prev_p) ~= dir_code)) or -- was: precedes_break(prev_p)
                            (id == kern_code and getsubtype(prev_p) ~= userkern_code) then
                            p_active, n_active = try_break(0, unhyphenated_code, par, first_p, current, checked_expansion)
                        end
                    end
                end
                local spec = check_shrinkage(par,getfield(current,"spec"))
                local order = stretch_orders[getfield(spec,"stretch_order")]
                setfield(current,"spec",spec)
                active_width.size   = active_width.size   + getfield(spec,"width")
                active_width[order] = active_width[order] + getfield(spec,"stretch")
                active_width.shrink = active_width.shrink + getfield(spec,"shrink")
            elseif id == disc_code then
                local subtype = getsubtype(current)
                if subtype ~= second_disc_code then
                    local line_break_dir = par.line_break_dir
                    if second_pass or subtype <= automatic_disc_code then
                        local actual_pen = subtype == automatic_disc_code and par.ex_hyphen_penalty or par.hyphen_penalty
                        local pre = getfield(current,"pre")
                        if not pre then    --  trivial pre-break
                            disc_width.size = 0
                            if checked_expansion then
                                disc_width.adjust_stretch = 0
                                disc_width.adjust_shrink  = 0
                            end
                            p_active, n_active = try_break(actual_pen, hyphenated_code, par, first_p, current, checked_expansion)
                        else
                            local size, adjust_stretch, adjust_shrink = add_to_width(line_break_dir,checked_expansion,pre)
                            disc_width.size   = size
                            active_width.size = active_width.size + size
                            if checked_expansion then
                                disc_width.adjust_stretch   = adjust_stretch
                                disc_width.adjust_shrink    = adjust_shrink
                                active_width.adjust_stretch = active_width.adjust_stretch + adjust_stretch
                                active_width.adjust_shrink  = active_width.adjust_shrink  + adjust_shrink
                            else
                             -- disc_width.adjust_stretch = 0
                             -- disc_width.adjust_shrink  = 0
                            end
                            p_active, n_active = try_break(actual_pen, hyphenated_code, par, first_p, current, checked_expansion)
                            if subtype == first_disc_code then
                                local cur_p_next = getnext(current)
                                if getid(cur_p_next) ~= disc_code or getsubtype(cur_p_next) ~= second_disc_code then
                                    report_parbuilders("unsupported disc at location %a",1)
                                else
                                    local pre = getfield(cur_p_next,"pre")
                                    if pre then
                                        local size, adjust_stretch, adjust_shrink = add_to_width(line_break_dir,checked_expansion,pre)
                                        disc_width.size = disc_width.size + size
                                        if checked_expansion then
                                            disc_width.adjust_stretch = disc_width.adjust_stretch + adjust_stretch
                                            disc_width.adjust_shrink  = disc_width.adjust_shrink  + adjust_shrink
                                        end
                                        p_active, n_active = try_break(actual_pen, hyphenated_code, par, first_p, cur_p_next, checked_expansion)
                                        --
                                        -- I will look into this some day ... comment in linebreak.w says that this fails,
                                        -- maybe this is what Taco means with his comment in the luatex manual.
                                        --
                                        -- do_one_seven_eight(sub_disc_width_from_active_width);
                                        -- do_one_seven_eight(reset_disc_width);
                                        -- s = vlink_no_break(vlink(current));
                                        -- add_to_widths(s, line_break_dir, pdf_adjust_spacing,disc_width);
                                        -- ext_try_break(...,first_p,vlink(current));
                                        --
                                    else
                                        report_parbuilders("unsupported disc at location %a",2)
                                    end
                                end
                            end
                            -- beware, we cannot restore to a saved value as the try_break adapts active_width
                            active_width.size = active_width.size - disc_width.size
                            if checked_expansion then
                                active_width.adjust_stretch = active_width.adjust_stretch - disc_width.adjust_stretch
                                active_width.adjust_shrink  = active_width.adjust_shrink  - disc_width.adjust_shrink
                            end
                        end
                    end
                    local replace = getfield(current,"replace")
                    if replace then
                        local size, adjust_stretch, adjust_shrink = add_to_width(line_break_dir,checked_expansion,replace)
                        active_width.size = active_width.size + size
                        if checked_expansion then
                            active_width.adjust_stretch = active_width.adjust_stretch + adjust_stretch
                            active_width.adjust_shrink  = active_width.adjust_shrink  + adjust_shrink
                        end
                    end
                end
            elseif id == kern_code then
                if getsubtype(current) == userkern_code then
                    local v = getnext(current)
--                     if par.auto_breaking and getid(v) == glue_code then
                    if auto_breaking and getid(v) == glue_code then
                        p_active, n_active = try_break(0, unhyphenated_code, par, first_p, current, checked_expansion)
                    end
                    local active_width = par.active_width
                    active_width.size = active_width.size + getfield(current,"kern")
                else
                    local kern = getfield(current,"kern")
                    if kern ~= 0 then
                        active_width.size = active_width.size + kern
                        if checked_expansion and expand_kerns and (getsubtype(current) == kerning_code or getattr(current,a_fontkern)) then
                            local stretch, shrink = kern_stretch_shrink(current,kern)
                            if expand_kerns == "stretch" then
                                active_width.adjust_stretch = active_width.adjust_stretch + stretch
                            elseif expand_kerns == "shrink" then
                                active_width.adjust_shrink  = active_width.adjust_shrink  + shrink
                            else
                                active_width.adjust_stretch = active_width.adjust_stretch + stretch
                                active_width.adjust_shrink  = active_width.adjust_shrink  + shrink
                            end
                        end
                    end
                end
            elseif id == math_code then
--                 par.auto_breaking = getsubtype(current) == endmath_code
                auto_breaking = getsubtype(current) == endmath_code
                local v = getnext(current)
--                 if par.auto_breaking and getid(v) == glue_code then
                if auto_breaking and getid(v) == glue_code then
                    p_active, n_active = try_break(0, unhyphenated_code, par, first_p, current, checked_expansion)
                end
                local active_width = par.active_width
                active_width.size = active_width.size + getfield(current,"surround")
            elseif id == rule_code then
                active_width.size = active_width.size + getfield(current,"width")
            elseif id == penalty_code then
                p_active, n_active = try_break(getfield(current,"penalty"), unhyphenated_code, par, first_p, current, checked_expansion)
            elseif id == whatsit_code then
                local subtype = getsubtype(current)
                if subtype == localpar_code then
                    par.internal_pen_inter       = getfield(current,"pen_inter")
                    par.internal_pen_broken      = getfield(current,"pen_broken")
                    par.internal_left_box        = getfield(current,"box_left")
                    par.internal_left_box_width  = getfield(current,"box_left_width")
                    par.internal_right_box       = getfield(current,"box_right")
                    par.internal_right_box_width = getfield(current,"box_right_width")
                elseif subtype == dir_code then
                    par.line_break_dir = checked_line_dir(dirstack) or par.line_break_dir
                else
                    local get_width = get_whatsit_width[subtype]
                    if get_width then
                        active_width.size = active_width.size + get_width(current,par.line_break_dir)
                    end
                end
            elseif trace_unsupported then
                if id == mark_code or id == ins_code or id == adjust_code then
                    -- skip
                else
                    report_parbuilders("node of type %a found in paragraph",type(id))
                end
            end
            current = getnext(current)
        end
        if not current then
            local p_active, n_active = try_break(eject_penalty, hyphenated_code, par, first_p, current, checked_expansion)
            if n_active ~= p_active then
                local r = n_active
                par.fewest_demerits = awful_badness
                repeat -- use local d
                    if r.id ~= delta_code and r.total_demerits < par.fewest_demerits then
                        par.fewest_demerits = r.total_demerits
                        par.best_bet = r
                    end
                    r = r.next
                until r == p_active
                par.best_line = par.best_bet.line_number
                local asked_looseness = par.looseness
                if asked_looseness == 0 then
                    return tonode(wrap_up(par))
                end
                local r = n_active
                local actual_looseness = 0
                -- minimize assignments to par but happens seldom
                repeat
                    if r.id ~= delta_code then
                        local line_diff = r.line_number - par.best_line
                        par.line_diff = line_diff
                        if (line_diff < actual_looseness and asked_looseness <= line_diff)   or
                           (line_diff > actual_looseness and asked_looseness >= line_diff) then
                            par.best_bet = r
                            actual_looseness = line_diff
                            par.fewest_demerits = r.total_demerits
                        elseif line_diff == actual_looseness and r.total_demerits < par.fewest_demerits then
                            par.best_bet = r
                            par.fewest_demerits = r.total_demerits
                        end
                    end
                    r = r.next
                until r == p_active
                par.best_line = par.best_bet.line_number
                if actual_looseness == asked_looseness or par.final_pass then
                    return tonode(wrap_up(par))
                end
            end
        end
        reset_meta(par) -- clean up the memory by removing the break nodes
        if not second_pass then
            if tracing_paragraphs then
                diagnostics.current_pass(par,"secondpass")
            end
            par.threshold   = par.tolerance
            par.second_pass = true
            par.final_pass  = par.emergency_stretch <= 0
        else
            if tracing_paragraphs then
                diagnostics.current_pass(par,"emergencypass")
            end
            par.background.stretch = par.background.stretch + par.emergency_stretch
            par.final_pass         = true
        end
    end
    return tonode(wrap_up(par))
end

-- standard tex logging .. will be adapted ..

local function write_esc(cs)
    local esc = tex.escapechar
    if esc then
        write("log",utfchar(esc),cs)
    else
        write("log",cs)
    end
end

function diagnostics.start()
end

function diagnostics.stop()
    write_nl("log",'')
end

function diagnostics.current_pass(par,what)
    write_nl("log",format("@%s",what))
end

local verbose    = false -- true

local function short_display(target,a,font_in_short_display)
    while a do
        local id = getid(a)
        if id == glyph_code then
            local font = getfont(a)
            if font ~= font_in_short_display then
                write(target,tex.fontidentifier(font) .. ' ')
                font_in_short_display = font
            end
            if getsubtype(a) == ligature_code then
                font_in_short_display = short_display(target,getfield(a,"components"),font_in_short_display)
            else
                write(target,utfchar(getchar(a)))
            end
        elseif id == disc_code then
            font_in_short_display = short_display(target,getfield(a,"pre"),font_in_short_display)
            font_in_short_display = short_display(target,getfield(a,"post"),font_in_short_display)
        elseif verbose then
            write(target,format("[%s]",nodecodes[id]))
        elseif id == rule_code then
            write(target,"|")
        elseif id == glue_code then
            if getfield(getfield(a,"spec"),"writable") then
                write(target," ")
            end
        elseif id == kern_code and (getsubtype(a) == userkern_code or getattr(a,a_fontkern)) then
            if verbose then
                write(target,"[|]")
            else
                write(target,"")
            end
        elseif id == math_code then
            write(target,"$")
        else
            write(target,"[]")
        end
        a = getnext(a)
    end
    return font_in_short_display
end

diagnostics.short_display = short_display

function diagnostics.break_node(par, q, fit_class, break_type, current) -- %d ?
    local passive = par.passive
    local typ_ind = break_type == hyphenated_code and '-' or ""
    if par.do_last_line_fit then
        local s = number.toscaled(q.active_short)
        local g = number.toscaled(q.active_glue)
        if current then
            write_nl("log",format("@@%d: line %d.%d%s t=%s s=%s g=%s",
                passive.serial or 0,q.line_number-1,fit_class,typ_ind,q.total_demerits,s,g))
        else
            write_nl("log",format("@@%d: line %d.%d%s t=%s s=%s a=%s",
                passive.serial or 0,q.line_number-1,fit_class,typ_ind,q.total_demerits,s,g))
        end
    else
        write_nl("log",format("@@%d: line %d.%d%s t=%s",
            passive.serial or 0,q.line_number-1,fit_class,typ_ind,q.total_demerits))
    end
    if not passive.prev_break then
        write("log"," -> @0")
    else
        write("log",format(" -> @%d", passive.prev_break.serial or 0))
    end
end

function diagnostics.feasible_break(par, current, r, b, pi, d, artificial_demerits)
    local printed_node = par.printed_node
    if printed_node ~= current then
        write_nl("log","")
        if not current then
            par.font_in_short_display = short_display("log",getnext(printed_node),par.font_in_short_display)
        else
            local save_link = getnext(current)
            setfield(current,"next",nil)
            write_nl("log","")
            par.font_in_short_display = short_display("log",getnext(printed_node),par.font_in_short_display)
            setfield(current,"next",save_link)
        end
        par.printed_node = current
    end
    write_nl("log","@")
    if not current then
        write_esc("par")
    else
        local id = getid(current)
        if id == glue_code then
            -- print nothing
        elseif id == penalty_code then
            write_esc("penalty")
        elseif id == disc_code then
            write_esc("discretionary")
        elseif id == kern_code then
            write_esc("kern")
        elseif id == math_code then
            write_esc("math")
        else
            write_esc("unknown")
        end
    end
    local via, badness, demerits = 0, '*', '*'
    if r.break_node then
        via = r.break_node.serial or 0
    end
    if b <= infinite_badness then
        badness = tonumber(d) -- format("%d", b)
    end
    if not artificial_demerits then
        demerits = tonumber(d) -- format("%d", d)
    end
    write("log",format(" via @%d b=%s p=%s d=%s", via, badness, pi, demerits))
end

-- reporting --

statistics.register("alternative parbuilders", function()
    if nofpars > 0 then
        return format("%s paragraphs, %s lines (%s protruded, %s adjusted)", nofpars, noflines, nofprotrudedlines, nofadjustedlines)
    end
end)

-- actually scaling kerns is not such a good idea and it will become
-- configureable

-- This is no way a replacement for the built in (fast) packer
-- it's just an alternative for special (testing) purposes.
--
-- We could use two hpacks: one to be used in the par builder
-- and one to be used for other purposes. The one in the par
-- builder is much more simple as it does not need the expansion
-- code but only need to register the effective expansion factor
-- with the glyph.

local function glyph_width_height_depth(curdir,pdir,p)
    local wd = getfield(p,"width")
    local ht = getfield(p,"height")
    local dp = getfield(p,"depth")
    if is_rotated[curdir] then
        if is_parallel[curdir][pdir] then
            local half = (ht + dp) / 2
            return wd, half, half
        else
            local half = wd / 2
            return ht + dp, half, half
        end
    elseif is_rotated[pdir] then
        if is_parallel[curdir][pdir] then
            local half = (ht + dp) / 2
            return wd, half, half
        else
            return ht + dp, wd, 0 -- weird
        end
    else
        if glyphdir_is_equal[curdir][pdir] then
            return wd, ht, dp
        elseif is_opposite[curdir][pdir] then
            return wd, dp, ht
        else -- can this happen?
            return ht + dp, wd, 0
        end
    end
end

local function pack_width_height_depth(curdir,pdir,p)
    local wd = getfield(p,"width")
    local ht = getfield(p,"height")
    local dp = getfield(p,"depth")
    if is_rotated[curdir] then
        if is_parallel[curdir][pdir] then
            local half = (ht + dp) / 2
            return wd, half, half
        else -- can this happen?
            local half = wd / 2
            return ht + dp, half, half
        end
    else
        if pardir_is_equal[curdir][pdir] then
            return wd, ht, dp
        elseif is_opposite[curdir][pdir] then
            return wd, dp, ht
        else -- weird dimensions, can this happen?
            return ht + dp, wd, 0
        end
    end
end

-- local function xpack(head,width,method,direction,analysis)
--
--     -- inspect(analysis)
--
--     local expansion         = method == "cal_expand_ratio"
--     local natural           = analysis.size
--     local font_stretch      = analysis.adjust_stretch
--     local font_shrink       = analysis.adjust_shrink
--     local font_expand_ratio = 0
--     local delta             = width - natural
--
--     local hlist             = new_node("hlist")
--
--     setfield(hlist,"list",head)
--     setfield(hlist,"dir",direction or tex.textdir)
--     setfield(hlist,"width",width)
--     setfield(hlist,"height",height)
--     setfield(hlist,"depth",depth)
--
--     if delta == 0 then
--
--         setfield(hlist,"glue_sign",0)
--         setfield(hlist,"glue_order",0)
--         setfield(hlist,"glue_set",0)
--
--     else
--
--         local order = analysis.filll ~= 0 and fillcodes.filll or
--                       analysis.fill  ~= 0 and fillcodes.fill  or
--                       analysis.fil   ~= 0 and fillcodes.fil   or
--                       analysis.fi    ~= 0 and fillcodes.fi    or 0
--
--         if delta > 0 then
--
--             if expansion and order == 0 and font_stretch > 0 then
--                 font_expand_ratio = (delta/font_stretch) * 1000
--             else
--                 local stretch = analysis.stretch
--                 if stretch ~= 0 then
--                     setfield(hlist,"glue_sign",1) -- stretch
--                     setfield(hlist,"glue_order",order)
--                     setfield(hlist,"glue_set",delta/stretch)
--                 else
--                     setfield(hlist,"glue_sign",0) -- nothing
--                     setfield(hlist,"glue_order",order)
--                     setfield(hlist,"glue_set",0)
--                 end
--             end
--
--         else
--
--             if expansion and order == 0 and font_shrink > 0 then
--                 font_expand_ratio = (delta/font_shrink) * 1000
--             else
--                 local shrink = analysis.shrink
--                 if shrink ~= 0 then
--                     setfield(hlist,"glue_sign",2) -- shrink
--                     setfield(hlist,"glue_order",order)
--                     setfield(hlist,"glue_set",-delta/stretch)
--                 else
--                     setfield(hlist,"glue_sign",0) -- nothing
--                     setfield(hlist,"glue_order",order)
--                     setfield(hlist,"glue_set",0)
--                 end
--             end
--
--         end
--
--     end
--
--     if not expansion or font_expand_ratio == 0 then
--         -- nothing
--     elseif font_expand_ratio > 0 then
--         if font_expand_ratio > 1000 then
--             font_expand_ratio = 1000
--         end
--         local current = head
--         while current do
--             local id = getid(current)
--             if id == glyph_code then
--                 local stretch, shrink = char_stretch_shrink(current) -- get only one
--                 if stretch then
--                     if trace_expansion then
--                         setnodecolor(g,"hz:positive")
--                     end
--                     current.expansion_factor = font_expand_ratio * stretch
--                 end
--             elseif id == kern_code then
--                 local kern = getfield(current,"kern")
--                 if kern ~= 0 and getsubtype(current) == kerning_code then
--                     setfield(current,"kern",font_expand_ratio * kern)
--                 end
--             end
--             current = getnext(current)
--         end
--     elseif font_expand_ratio < 0 then
--         if font_expand_ratio < -1000 then
--             font_expand_ratio = -1000
--         end
--         local current = head
--         while current do
--             local id = getid(current)
--             if id == glyph_code then
--                 local stretch, shrink = char_stretch_shrink(current) -- get only one
--                 if shrink then
--                     if trace_expansion then
--                         setnodecolor(g,"hz:negative")
--                     end
--                     current.expansion_factor = font_expand_ratio * shrink
--                 end
--             elseif id == kern_code then
--                 local kern = getfield(current,"kern")
--                 if kern ~= 0 and getsubtype(current) == kerning_code then
--                     setfield(current,"kern",font_expand_ratio * kern)
--                 end
--             end
--             current = getnext(current)
--         end
--     end
--     return hlist, 0
-- end

local function hpack(head,width,method,direction,firstline,line) -- fast version when head = nil

    -- we can pass the adjust_width and adjust_height so that we don't need to recalculate them but
    -- with the glue mess it's less trivial as we lack detail .. challenge

    local hlist = new_node("hlist")

    setfield(hlist,"dir",direction)

    if head == nil then
        setfield(hlist,"width",width)
        return hlist, 0
    else
        setfield(hlist,"list",head)
    end

    local cal_expand_ratio  = method == "cal_expand_ratio" or method == "subst_ex_font"

    direction               = direction or tex.textdir

    local line              = 0

    local height            = 0
    local depth             = 0
    local natural           = 0
    local font_stretch      = 0
    local font_shrink       = 0
    local font_expand_ratio = 0
    local last_badness      = 0
    local expansion_stack   = cal_expand_ratio and { } -- todo: optionally pass this
    local expansion_index   = 0
    local total_stretch     = { [0] = 0, 0, 0, 0, 0 }
    local total_shrink      = { [0] = 0, 0, 0, 0, 0 }

    local hpack_dir         = direction

    local adjust_head       = texlists.adjust_head
    local pre_adjust_head   = texlists.pre_adjust_head
    local adjust_tail       = adjust_head and slide_nodelist(adjust_head) -- todo: find_tail
    local pre_adjust_tail   = pre_adjust_head and slide_nodelist(pre_adjust_head) -- todo: find_tail

    new_dir_stack(hpack_dir)

    local checked_expansion = false

    if cal_expand_ratio then
        checked_expansion = { }
        setmetatableindex(checked_expansion,check_expand_lines)
    end

    -- this one also needs to check the font, so in the end indeed we might end up with two variants

    local fontexps, lastfont

    local function process(current) -- called nested in disc replace

        while current do
            local id = getid(current)
            if id == glyph_code then
                if cal_expand_ratio then
                    local currentfont = getfont(current)
                    if currentfont ~= lastfont then
                        fontexps = checked_expansion[currentfont] -- a bit redundant for the par line packer
                        lastfont = currentfont
                    end
                    if fontexps then
                        local expansion = fontexps[getchar(current)]
                        if expansion then
                            font_stretch = font_stretch + expansion.glyphstretch
                            font_shrink  = font_shrink  + expansion.glyphshrink
                            expansion_index = expansion_index + 1
                            expansion_stack[expansion_index] = current
                        end
                    end
                end
                -- use inline
                local wd, ht, dp = glyph_width_height_depth(hpack_dir,"TLT",current) -- was TRT ?
                natural = natural + wd
                if ht > height then
                    height = ht
                end
                if dp > depth then
                    depth = dp
                end
            elseif id == kern_code then
                local kern = getfield(current,"kern")
                if kern == 0 then
                    -- no kern
                elseif getsubtype(current) == kerning_code then -- check getfield(p,"kern")
                    if cal_expand_ratio then
                        local stretch, shrink = kern_stretch_shrink(current,kern)
                        font_stretch = font_stretch + stretch
                        font_shrink  = font_shrink + shrink
                        expansion_index = expansion_index + 1
                        expansion_stack[expansion_index] = current
                    end
                    natural = natural + kern
                else
                    natural = natural + kern
                end
            elseif id == disc_code then
                local subtype = getsubtype(current)
                if subtype ~= second_disc_code then
                    -- todo : local stretch, shrink = char_stretch_shrink(s)
                    local replace = getfield(current,"replace")
                    if replace then
                        process(replace)
                    end
                end
            elseif id == glue_code then
                local spec = getfield(current,"spec")
                natural = natural + getfield(spec,"width")
                local op = getfield(spec,"stretch_order")
                local om = getfield(spec,"shrink_order")
                total_stretch[op] = total_stretch[op] + getfield(spec,"stretch")
                total_shrink [om] = total_shrink [om] + getfield(spec,"shrink")
                if getsubtype(current) >= leaders_code then
                    local leader = getleader(current)
                    local ht = getfield(leader,"height")
                    local dp = getfield(leader,"depth")
                    if ht > height then
                        height = ht
                    end
                    if dp > depth then
                        depth = dp
                    end
                end
            elseif id == hlist_code or id == vlist_code then
                local sh = getfield(current,"shift")
                local wd, ht, dp = pack_width_height_depth(hpack_dir,getfield(current,"dir") or hpack_dir,current) -- added: or pack_dir
                local hs, ds = ht - sh, dp + sh
                natural = natural + wd
                if hs > height then
                    height = hs
                end
                if ds > depth then
                    depth = ds
                end
            elseif id == rule_code then
                local wd = getfield(current,"width")
                local ht = getfield(current,"height")
                local dp = getfield(current,"depth")
                natural = natural + wd
                if ht > height then
                    height = ht
                end
                if dp > depth then
                    depth = dp
                end
            elseif id == math_code then
                natural = natural + getfield(current,"surround")
            elseif id == unset_code then
                local wd = getfield(current,"width")
                local ht = getfield(current,"height")
                local dp = getfield(current,"depth")
                local sh = getfield(current,"shift")
                local hs = ht - sh
                local ds = dp + sh
                natural = natural + wd
                if hs > height then
                    height = hs
                end
                if ds > depth then
                    depth = ds
                end
            elseif id == ins_code or id == mark_code then
                local prev = getprev(current)
                local next = getnext(current)
                if adjust_tail then -- todo
                    if next then
                        setfield(next,"prev",prev)
                    end
                    if prev then
                        setfield(prev,"next",next)
                    end
                    setfield(current,"prev",adjust_tail)
                    setfield(current,"next",nil)
                    adjust_setfield(tail,"next",current)
                    adjust_tail = current
                else
                    adjust_head = current
                    adjust_tail = current
                    setfield(current,"prev",nil)
                    setfield(current,"next",nil)
                end
            elseif id == adjust_code then
                local list = getlist(current)
                if adjust_tail then
                    adjust_setfield(tail,"next",list)
                else
                    adjust_head = list
                end
                adjust_tail = slide_nodelist(list) -- find_tail(list)
            elseif id == whatsit_code then
                local subtype = getsubtype(current)
                if subtype == dir_code then
                    hpack_dir = checked_line_dir(stack,current) or hpack_dir
                else
                    local get_dimensions = get_whatsit_dimensions[subtype]
                    if get_dimensions then
                        local wd, ht, dp = get_dimensions(current,hpack_dir)
                        natural = natural + wd
                        if ht > height then
                            height = ht
                        end
                        if dp > depth then
                            depth = dp
                        end
                    end
                end
            elseif id == marginkern_code then
                local width = getfield(current,"width")
                if cal_expand_ratio then
                    -- is this ok?
                    local glyph = getfield(current,"glyph")
                    local char_pw = getsubtype(current) == leftmargin_code and left_pw or right_pw
                    font_stretch = font_stretch - width - char_pw(glyph)
                    font_shrink  = font_shrink  - width - char_pw(glyph)
                    expansion_index = expansion_index + 1
                    expansion_stack[expansion_index] = glyph
                end
                natural = natural + width
            end
            current = getnext(current)
        end

    end

    process(head)

    if adjust_tail then
        adjust_tail.next = nil -- todo
    end
    if pre_adjust_tail then
        pre_adjust_tail.next = nil -- todo
    end
    if method == "additional" then
        width = width + natural
    end

    setfield(hlist,"width",width)
    setfield(hlist,"height",height)
    setfield(hlist,"depth",depth)

    local delta  = width - natural
    if delta == 0 then
        setfield(hlist,"glue_sign",0)
        setfield(hlist,"glue_order",0)
        setfield(hlist,"glue_set",0)
    elseif delta > 0 then
        -- natural width smaller than requested width
        local order = (total_stretch[4] ~= 0 and 4 or total_stretch[3] ~= 0 and 3) or
                      (total_stretch[2] ~= 0 and 2 or total_stretch[1] ~= 0 and 1) or 0
        if cal_expand_ratio and order == 0 and font_stretch > 0 then -- check sign of font_stretch
            font_expand_ratio = delta/font_stretch

            if font_expand_ratio > 1 then
                font_expand_ratio = 1
            end

            local fontexps, lastfont
            for i=1,expansion_index do
                local g = expansion_stack[i]
                local e
                if getid(g) == glyph_code then
                    local currentfont = getfont(g)
                    if currentfont ~= lastfont then
                        fontexps = expansions[currentfont]
                        lastfont = currentfont
                    end
                    local data = fontexps[getchar(g)]
                    if trace_expansion then
                        setnodecolor(g,"hz:positive")
                    end
                    e = font_expand_ratio * data.glyphstretch / 1000
                else
                    local kern = getfield(g,"kern")
                    local stretch, shrink = kern_stretch_shrink(g,kern)
                    e = font_expand_ratio * stretch / 1000
                end
                setfield(g,"expansion_factor",e)
            end
        end
        local tso = total_stretch[order]
        if tso ~= 0 then
            setfield(hlist,"glue_sign",1)
            setfield(hlist,"glue_order",order)
            setfield(hlist,"glue_set",delta/tso)
        else
            setfield(hlist,"glue_sign",0)
            setfield(hlist,"glue_order",order)
            setfield(hlist,"glue_set",0)
        end
        if font_expand_ratio ~= 0 then
            -- todo
        elseif order == 0 then -- and getlist(hlist) then
            last_badness = calculate_badness(delta,total_stretch[0])
            if last_badness > tex.hbadness then
                if last_badness > 100 then
                    diagnostics.underfull_hbox(hlist,line,last_badness)
                else
                    diagnostics.loose_hbox(hlist,line,last_badness)
                end
            end
        end
    else
        -- natural width larger than requested width
        local order = total_shrink[4] ~= 0 and 4 or total_shrink[3] ~= 0 and 3
                   or total_shrink[2] ~= 0 and 2 or total_shrink[1] ~= 0 and 1 or 0
        if cal_expand_ratio and order == 0 and font_shrink > 0 then -- check sign of font_shrink
            font_expand_ratio = delta/font_shrink

            if font_expand_ratio < 1 then
                font_expand_ratio = -1
            end

            local fontexps, lastfont
            for i=1,expansion_index do
                local g = expansion_stack[i]
                local e
                if getid(g) == glyph_code then
                    local currentfont = getfont(g)
                    if currentfont ~= lastfont then
                        fontexps = expansions[currentfont]
                        lastfont = currentfont
                    end
                    local data = fontexps[getchar(g)]
                    if trace_expansion then
                        setnodecolor(g,"hz:negative")
                    end
                    e = font_expand_ratio * data.glyphshrink / 1000
                else
                    local kern = getfield(g,"kern")
                    local stretch, shrink = kern_stretch_shrink(g,kern)
                    e = font_expand_ratio * shrink / 1000
                end
                setfield(g,"expansion_factor",e)
            end
        end
        local tso = total_shrink[order]
        if tso ~= 0 then
            setfield(hlist,"glue_sign",2)
            setfield(hlist,"glue_order",order)
            setfield(hlist,"glue_set",-delta/tso)
        else
            setfield(hlist,"glue_sign",0)
            setfield(hlist,"glue_order",order)
            setfield(hlist,"glue_set",0)
        end
        if font_expand_ratio ~= 0 then
            -- todo
        elseif tso < -delta and order == 0 then -- and getlist(hlist) then
            last_badness = 1000000
            setfield(hlist,"glue_set",1)
            local fuzz = - delta - total_shrink[0]
            local hfuzz = tex.hfuzz
            if fuzz > hfuzz or tex.hbadness < 100 then
                local overfullrule = tex.overfullrule
                if fuzz > hfuzz and overfullrule > 0 then
                    -- weird, is always called and no rules shows up
                    setfield(slide_nodelist(list),"next",new_rule(overfullrule,nil,nil,hlist.dir)) -- todo: find_tail
                end
                diagnostics.overfull_hbox(hlist,line,-delta)
            end
        elseif order == 0 and getlist(hlist) and last_badness > tex.hbadness then
            diagnostics.bad_hbox(hlist,line,last_badness)
        end
    end
    return hlist, last_badness
end

xpack_nodes = hpack -- comment this for old fashioned expansion (we need to fix float mess)

constructors.methods.hpack = hpack

local function common_message(hlist,line,str)
    write_nl("")
    if status.output_active then -- unset
        write(str," has occurred while \\output is active")
    end
    local fileline = status.linenumber
    if line > 0 then
        write(str," in paragraph at lines ",fileline,"--",fileline+line-1)
    elseif line < 0 then
        write(str," in alignment at lines ",fileline,"--",fileline-line-1)
    else
        write(str," detected at line ",fileline)
    end
    write_nl("")
    diagnostics.short_display(hlist.list,false)
    write_nl("")
 -- diagnostics.start()
 -- show_box(hlist.list)
 -- diagnostics.stop()
end

function diagnostics.overfull_hbox(hlist,line,d)
    common_message(hlist,line,format("Overfull \\hbox (%spt too wide)",number.toscaled(d)))
end

function diagnostics.bad_hbox(hlist,line,b)
    common_message(hlist,line,format("Tight \\hbox (badness %i)",b))
end

function diagnostics.underfull_hbox(hlist,line,b)
    common_message(hlist,line,format("Underfull \\hbox (badness %i)",b))
end

function diagnostics.loose_hbox(hlist,line,b)
    common_message(hlist,line,format("Loose \\hbox (badness %i)",b))
end