1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
|
% \iffalse meta-comment
%
% Copyright (C) 2017-2018 by F. Pantigny
% -----------------------------------
%
% This file may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in:
%
% http://www.latex-project.org/lppl.txt
%
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
%
% \fi
% \iffalse
\def\myfileversion{1.9}
\def\myfiledate{2018/08/17}
%
%
%<*batchfile>
\begingroup
\input l3docstrip.tex
\keepsilent
\usedir{tex/latex/witharrows}
\preamble
Copyright (C) 2017-2018 by F. Pantigny
-----------------------------------
This file may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
of this license or (at your option) any later version.
The latest version of this license is in:
http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of LaTeX
version 2005/12/01 or later.
\endpreamble
\askforoverwritefalse
\endgroup
%</batchfile>
%
%<@@=wa>
%<*driver>
\documentclass[dvipsnames]{l3doc}% dvipsnames is for xcolor (loaded by Tikz, loaded by witharrows)
\usepackage{xltxtra}
\usepackage{geometry}
\geometry{left=2.8cm,right=2.8cm,top=2.5cm,bottom=2.5cm,papersize={21cm,29.7cm}}
\usepackage[footnotehyper]{witharrows}
\usetikzlibrary{calc}
\usepackage{mathtools}
\usepackage{amsfonts}
\usepackage[only,llbracket,rrbracket]{stmaryrd}
\NewDocumentEnvironment {scope} {} {} {}
\def\interitem{\vskip 7mm plus 2 mm minus 3mm}
\def\emphase{\bgroup\color{RoyalPurple}\let\next=}
\fvset{commandchars=\~\#\@,formatcom={\color{gray}}}
\DeclareMathOperator{\re}{Re}
\parindent 0pt
\DisableCrossrefs
\begin{document}
\DocInput{witharrows.dtx}
\end{document}
%</driver>
% \fi
% \VerbatimFootnotes
% \title{The package \pkg{witharrows}\thanks{This document corresponds to the version~\myfileversion\space of \pkg{witharrows},
% at the date of~\myfiledate.}} \author{F. Pantigny \\ \texttt{fpantigny@wanadoo.fr}}
%
% \maketitle
%
% \begin{abstract}
% The LaTeX package \pkg{witharrows} provides an environment |{WithArrows}| which is similar to environment
% |{aligned}| of \pkg{amsmath} (and \pkg{mathtools}) but gives the possibility to draw arrows on the right side of
% the alignment. These arrows are usually used to give explanations concerning the mathematical calculus presented.
% \end{abstract}
%
%
% \vskip1cm
% This package can be used with |xelatex|, |lualatex|, |pdflatex| but also by the classical workflow
% |latex|-|dvips|-|ps2pdf| (or Adobe Distiller). Two compilations may be necessary. This package requires the
% packages \pkg{expl3}, \pkg{xparse} and \pkg{tikz}. The following Tikz libraries \pkg{arrows.meta} and
% \pkg{bending} are also required.
%
% \bigskip
% This package provides an environment |{WithArrows}| to construct alignments of equations with arrows for the
% explanations on the right side:
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = (a+1)^2 ~emphase#\Arrow{we expand}@ \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow{we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
%
%
%
% \medskip
% The arrow has been drawn with the command |\Arrow| on the row from which it starts. The command |\Arrow| must be used
% in the second column (the best way is to put it at the end of the second cell of the row as in the previous example).
%
% \medskip
% The environment |{WithArrows}| bears similarities with the environment |{aligned}| of |amsmath| (and
% |mathtools|). The extension \pkg{witharrows} also provides an environment |{DispWithArrows}| which is similar to
% the environment |{align}| of |amsmath|: cf. p. \pageref{DispWithArrows}.
%
%
% \section{Options for the shape of the arrows}
%
% The command |\Arrow| has several options. These options can be put between square brackets, before, or after the
% mandatory argument.
%
% The option |jump| gives the number\footnote{It's not possible to give a non-positive value to |jump|. See
% below (p.~\pageref{Backwards}) the way to draw an arrow which goes backwards.} of rows the arrow must jump (the
% default value is, of course,~$1$).
%
%
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = \bigl((a+b)+1\bigr)^2 \Arrow[~emphase#jump=2@]{we expand} \\
% & = (a+b)^2 + 2(a+b) +1 \\
% & = a^2 + 2ab + b^2 + 2a + 2b +1
% \end{WithArrows}$
% \end{Verbatim}
%
%
%
% $\begin{WithArrows}
% A & = \bigl((a+b)+1\bigr)^2 \Arrow[jump=2]{we expand} \\
% & = (a+b)^2 + 2(a+b) +1 \\
% & = a^2 + 2ab + b^2 + 2a + 2b +1
% \end{WithArrows}$
%
%
% \interitem
% It's possible to put several arrows which start from the same row.
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = \bigl((a+b)+1\bigr)^2 ~emphase#\Arrow{}\Arrow{}[jump=2]@ \\
% & = (a+b)^2 + 2(a+b) +1 \\
% & = a^2 + 2ab + b^2 + 2a + 2b +1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = \bigl((a+b)+1\bigr)^2 \Arrow{}\Arrow{}[jump=2] \\
% & = (a+b)^2 + 2(a+b) +1 \\
% & = a^2 + 2ab + b^2 + 2a + 2b +1
% \end{WithArrows}$
%
% \interitem
% The option |xoffset| shifts the arrows to the right (we usually don't want the arrows to be stucked on the text).
% The default value of |xoffset| is $3$~mm.
%
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = \bigl((a+b)+1\bigr)^2
% \Arrow[~emphase#xoffset=1cm@]{with \texttt{xoffset=1cm}} \\
% & = (a+b)^2 + 2(a+b) +1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = \bigl((a+b)+1\bigr)^2
% \Arrow[xoffset=1cm]{with \texttt{xoffset=1cm}} \\
% & = (a+b)^2 + 2(a+b) +1
% \end{WithArrows}$
%
%
% \interitem
% The arrows are drawn with Tikz. That's why the command |\Arrow| has an option |tikz| which can be used to give to
% the arrow (in fact, the command |\path| of Tikz) the options proposed by Tikz for such an arrow. The following
% example gives an thick arrow.
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow[~emphase#tikz=thick@]{we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow[tikz=thick]{we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
%
% \interitem
% It's also possible to change the arrowheads. For example, we can draw an arrow which goes backwards with the Tikz
% option~|<-|.
% \label{Backwards}
%
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow~emphase#[tikz=<-]@{we factorize} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow[tikz=<-]{we factorize} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
%
% \interitem
% It's also possible to suppress both tips of the arrow with the Tikz option |-|.
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow[~emphase#tikz=-@]{very classical} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow[tikz=-]{very classical} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
%
% \interitem
% In order to have straight arrows instead of curved ones, we must use the Tikz option ``|bend left = 0|''.
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow~emphase#[tikz={bend left=0}]@{we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow[tikz={bend left=0}]{we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
%
% \smallskip
% In fact, it's possible to change more drastically the shape or the arrows with the option |TikzCode| presented
% p.~\pageref{TikzCode}.
%
% \interitem
% One of the most useful options is ``|text width|'' to control the width of the text associated to the arrow.
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = \bigl((a+b)+1\bigr)^2
% \Arrow[jump=2,~emphase#tikz={text width=5.3cm}@]{We have done...} \\
% & = (a+b)^2 + 2(a+b) +1 \\
% & = a^2 + 2ab + b^2 + 2a + 2b +1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = \bigl((a+b)+1\bigr)^2
% \Arrow[jump=2,tikz={text width=5.3cm}]{We have done a two-stages expansion but it would have been clever
% to expand with the multinomial theorem.} \\
% & = (a+b)^2 + 2(a+b) +1 \\
% & = a^2 + 2ab + b^2 + 2a + 2b +1
% \end{WithArrows}$
%
% \bigskip
% In the environments |{DispWithArrows}| and |{DispWithArrows*}|, there is an option |wrap-line|. With this option,
% the lines of the labels are automaticly wrapped on the right: see p.~\pageref{wrap-lines}.
%
% \interitem
% If we want to change the font of the text associated to the arrow, we can, of course, put a command like
% |\bfseries|, |\large| or |\sffamily| at the beginning of the text. But, by default, the texts are composed with a
% combination of |\small| and |\itshape|. When adding |\bfseries| at the beginning of the text, we won't suppress
% the |\small| and the |\itshape| and we will consequently have a text in a bold, italic and small font.
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow{~emphase#\bfseries@ we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow{\bfseries we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
%
% \interitem
% If we put commands |\\| in the text to force newlines, a command of font placed in the beginning of the text will
% have effect only until the first command |\\| (like in an environment |{tabular}|). That's why Tikz gives a option
% |font| to modify the font of the whole text. Nevertheless, if we use the option |tikz={font={\bfseries}}|, the
% default specification of |\small| and |\itshape| will be overwritten.
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow[~emphase#tikz={font={\bfseries}}@]{we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow[tikz={font={\bfseries}}]{we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
%
% \medskip
% If we want exactly the same result as previously, we have to give to the option |font| the value
% |{\itshape\small\bfseries}|.
%
%
% \interitem
% Almost all the options can be given directly to the environment |{WithArrows}| (between square brackets). In this
% case, they apply to all the arrows of the environment.\footnote{They also apply to the nested environments
% |{WithArrows}| (with the logical exceptions of |interline|, |CodeBefore| and |CodeAfter|).}
% %
% \begin{Verbatim}
% $\begin{WithArrows}[~emphase#tikz=blue@]
% A & = \bigl((a+b)+1\bigr)^2 \Arrow{First expansion.} \\
% & = (a+b)^2 + 2(a+b) +1 \Arrow{Second expansion.} \\
% & = a^2 + 2ab + b^2 + 2a + 2b +1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}[tikz=blue]
% A & = \bigl((a+b)+1\bigr)^2 \Arrow{First expansion.} \\
% & = (a+b)^2 + 2(a+b) +1 \Arrow{Second expansion.} \\
% & = a^2 + 2ab + b^2 + 2a + 2b +1
% \end{WithArrows}$
%
%
% \interitem
% The environment |{WithArrows}| has an option |displaystyle|. With this option, all the elements are composed in
% |\displaystyle| (like in an environment |{aligned}| of \pkg{amsmath}).
%
% \medskip
% Without the option |displaystyle|:
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% \int_0^1 (x+1)^2 dx
% & = \int_0^1 (x^2+2x+1) dx
% \Arrow{linearity of integration} \\
% & = \int_0^1 x^2 dx + 2 \int_0^1 x dx + \int_0^1 dx \\
% & = \frac13 + 2\frac12 + 1 \\
% & = \frac73
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% \int_0^1 (x+1)^2 dx
% & = \int_0^1 (x^2+2x+1) dx
% \Arrow{linearity of integration} \\
% & = \int_0^1 x^2 dx + 2 \int_0^1 x dx + \int_0^1 dx \\
% & = \frac13 + 2\frac12 + 1 \\
% & = \frac73
% \end{WithArrows}$
%
%
% \medskip
% The same example with the option |displaystyle|:\par\nobreak
%
% $\begin{WithArrows}[displaystyle]
% \int_0^1 (x+1)^2 dx
% & = \int_0^1 (x^2+2x+1) dx
% \Arrow{linearity of integration} \\
% & = \int_0^1 x^2 dx + 2 \int_0^1 x dx + \int_0^1 dx \\
% & = \frac13 + 2\frac12 + 1 \\
% & = \frac73
% \end{WithArrows}$
%
% \interitem
% The version 1.3 of \pkg{witharrows} give two options for a fine tuning of the arrows:
%
% \begin{itemize}
% \item the option |ystart| set the vertical distance between the base line of the text and the start of the arrow
% (default value: 0.4 ex);
% \item the option |ygap| set the vertical distance between two consecutive arrows (default value: 0.4~ex).
% \end{itemize}
%
%
% \bigskip
% $\begin{WithArrows}[interline=1mm]
% (\cos x + \sin x)^2 & = \cos^2 x +2 \cos x \sin x + \sin^2 x\Arrow{}\tikz[remember picture] \coordinate (A) ; \\
% & = \cos^2x + \sin^2x + 2\sin x\cos x \Arrow{} \\
% & = 1 + \sin(2x)
% \end{WithArrows}$
%
% \begin{tikzpicture}[remember picture,overlay,blue]
% \draw (wa-\WithArrowsLastEnv-1-r.south) to ++(1,0) coordinate (B) to ++(0.1,0) ;;
% \draw (A) to ++(1,0) coordinate (C) to ++(0.1,0) ;;
% \draw (B) -- (C) ;
% \draw[<-] (B) to ++(0,0.2) ;
% \draw[<-] (C) to ++(0,-0.2) ;
% \path (C) node[right=1mm] {\texttt{ystart}} ;
% \draw (wa-\WithArrowsLastEnv-2-r.north) to ++(3,0) coordinate (E) to ++(0.1,0);
% \draw (wa-\WithArrowsLastEnv-2-r.south) to ++(3,0) coordinate (F) to ++(0.1,0);
% \draw (E) -- (F) ;
% \draw[<-] (E) to ++(0,0.2) ;
% \draw[<-] (F) to ++(0,-0.2) ;
% \path (F) node[right=1mm] {\texttt{ygap}} ;
% \end{tikzpicture}
%
%
% \bigskip
% \emph{Remark}: It's also possible to use the options ``|shorten <|'' and ``|shorten >|'' of Tikz (via the option
% |tikz| of \pkg{witharrows}).
%
%
% \interitem
% Almost all the options can also be set at the document level with the command |\WithArrowsOptions|. In this case,
% the scope of the declarations is the current TeX group (these declarations are ``semi-global''). For example, if
% we want all the environments |{WithArrows}| composed in |\displaystyle| with blue arrows, we can write
% |\WithArrowsOptions{displaystyle,tikz=blue}|.\footnote{Since version 1.4 of \pkg{witharrows}, it's no longer possible
% to give these options directly when loading the package, \emph{i.e.} with the command |\usepackage| in the preamble.}
%
% \begin{Verbatim}
% ~emphase#\WithArrowsOptions{displaystyle,tikz=blue}@
% $\begin{WithArrows}
% \sum_{i=1}^n (x_i+1)^2
% & = \sum_{i=1}^n (x_i^2+2x_i+1) \Arrow{by linearity}\\
% & = \sum_{i=1}^n x_i^2 + 2\sum_{i=1}^nx_i+ n
% \end{WithArrows}$
% \end{Verbatim}
%
% \begin{scope}
% \WithArrowsOptions{displaystyle,tikz=blue}
% $\begin{WithArrows}
% \sum_{i=1}^n (x_i+1)^2
% & = \sum_{i=1}^n (x_i^2+2x_i+1) \Arrow{by linearity}\\
% & = \sum_{i=1}^n x_i^2 + 2\sum_{i=1}^nx_i+ n
% \end{WithArrows}$
% \end{scope}
%
%
% \interitem
% The command |\Arrow| is recognized only in the environments |{WithArrows}|. If we have a command |\Arrow|
% previously defined, it's possible to go on using it outside the environments |{WithArrows}|.
%
% However, a previouly defined command |\Arrow| may still be useful in an environment |{WithArrows}|. If we want to
% use it in such an environment, it's possible to change the name of the command |\Arrow| of the package
% \pkg{witharrows}: there is an option |CommandName| for this purpose. The new name of the command must be given to
% the option \emph{without} the leading backslash.
% %
% \begin{Verbatim}
% \NewDocumentCommand {\Arrow} {} {\longmapsto}
% $\begin{WithArrows}[~emphase#CommandName=Explanation@]
% f & = \bigl(x \Arrow (x+1)^2\bigr)
% ~emphase#\Explanation{we work directly on fonctions}@\\
% & = \bigl(x \Arrow x^2+2x+1\bigr)
% \end{WithArrows}$
% \end{Verbatim}
% %
% \begin{scope}
% \NewDocumentCommand {\Arrow} {} {\longmapsto}
% $\begin{WithArrows}[CommandName=Explanation]
% f & = \bigl(x \Arrow (x+1)^2\bigr)
% \Explanation{we work directly on fonctions}\\
% & = \bigl(x \Arrow x^2+2x+1\bigr)
% \end{WithArrows}$
% \end{scope}
%
%
% \interitem
% The environment |{WithArrows}| gives also two options |CodeBefore| and |CodeAfter| for LaTeX code that will be
% executed at the beginning and at the end of the environment. Theses options are not designed to be hooks (they
% are avalaible only at the environment level and they are not applied to the nested environments).
% %
% \begin{Verbatim}
% $\begin{WithArrows}[~emphase#CodeBefore = \color{blue}@]
% A & = (a+b)^2 \Arrow{we expand} \\
% & = a^2 + 2ab + b^2
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}[CodeBefore = \color{blue}]
% A & = (a+b)^2 \Arrow{we expand} \\
% & = a^2 + 2ab + b^2
% \end{WithArrows}$
%
% \medskip
% Special commands are available in |CodeAfter| : a command |\NbLines| which gives the number of lines (=rows) of
% the current environment (this is a command and not a counter), a special form of the command |\Arrow| and the
% command |\MultiArrow| : these commands are described in the section concerning the nested environments,
% p.~\pageref{NestedEnv}.
%
%
% \section{Precise positioning of the arrows}
%
%
% The environment |{WithArrows}| defines, during the composition of the array, two series of nodes materialized in
% red in the following example.\footnote{The option |shownodes| can be used to materialize the nodes. The
% nodes are in fact Tikz nodes of shape ``rectangle'', but with zero width. An arrow between two nodes starts at
% the \emph{south} anchor of the first node and arrives at the \emph{north} anchor of the second node.}
%
% \smallskip
% $\begin{WithArrows}[displaystyle,shownodes]
% I
% & = \int_{\frac{\pi}4}^0 \ln\Bigl(1+\tan\left(\tfrac{\pi}4-u\right)\Bigr)(-d u) \\
% & = \int_0^{\frac{\pi}4} \ln\Bigl(1+\tan\left(\tfrac{\pi}4-u\right)\Bigr)d u \\
% & = \int_0^{\frac{\pi}4}\ln\left(1+\frac{1-\tan u}{1+\tan u}\right)\, d u \\
% & =\int_0^{\frac{\pi}4}\ln\left(\frac{1+\tan u+1-\tan u}{1+\tan u}\right) d u \\
% & =\int_0^{\frac{\pi}4} \ln\left(\frac2{1+\tan u}\right)\, d u\\
% & =\int_0^{\frac{\pi}4}\bigl(\ln2-\ln(1+\tan u)\bigr)\, d u \\
% & =\frac{\pi}4\ln2-\int_0^{\frac{\pi}4}\ln(1+\tan u)\, d u \\
% & =\frac{\pi}4\ln2-I
% \end{WithArrows}$
%
% \bigskip
% The nodes of the left are at the end of each line of text. These nodes will be called \emph{left nodes}. The
% nodes of the right side are aligned vertically on the right side of the array. These nodes will be called
% \emph{right nodes}.
%
% By default, the arrows use the right nodes. We will say that they are in |rr| mode ($r$ for \emph{right}). These
% arrows are |vertical| (we will say that an arrow is \emph{vertical} when its two ends have the same abscissa).
%
%
% \smallskip
% However, it's possible to use the left nodes, or a combination of left and right nodes, with one of the options
% |lr|, |rl| and |ll| ($l$ for \emph{left}). Those arrows are, usually, not vertical.
%
%
% Therefore
% $\begin{WithArrows}[displaystyle]
% I
% & = \int_{\frac{\pi}4}^0 \ln\Bigl(1+\tan\left(\tfrac{\pi}4-u\right)\Bigr)(-d u)
% \Arrow[lr]{This arrow uses the \texttt{lr} option.}\\
% & = \int_0^{\frac{\pi}4} \ln\Bigl(1+\tan\left(\tfrac{\pi}4-u\right)\Bigr)d u \\
% & = \int_0^{\frac{\pi}4}\ln\left(1+\frac{1-\tan u}{1+\tan u}\right)\, d u \\
% & =\int_0^{\frac{\pi}4}\ln\left(\frac{1+\tan u+1-\tan u}{1+\tan u}\right) d u
% \Arrow[ll,jump=2,tikz={text width = 5cm}]{This arrow uses a \texttt{ll} option and a \texttt{jump} equal to $2$}\\
% & =\int_0^{\frac{\pi}4} \ln\left(\frac2{1+\tan u}\right)\, d u\\
% & =\int_0^{\frac{\pi}4}\bigl(\ln2-\ln(1+\tan u)\bigr)\, d u \\
% & =\frac{\pi}4\ln2-\int_0^{\frac{\pi}4}\ln(1+\tan u)\, d u \\
% & =\frac{\pi}4\ln2-I
% \end{WithArrows}$
%
%
%
% \interitem
% There is also an option called \texttt{i} ($i$ for \emph{intermediate}). With this option, the arrow is vertical
% and at the leftmost position.
%
% \begin{Verbatim}
% $\begin{WithArrows}
% (a+b)(a+ib)(a-b)(a-ib)
% & = (a+b)(a-b)\cdot(a+ib)(a-ib) \\
% & = (a^2-b^2)(a^2+b^2) \Arrow~emphase#[i]@{because $(x-y)(x+y)=x^2-y^2$}\\
% & = a^4-b^4
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% (a+b)(a+ib)(a-b)(a-ib)
% & = (a+b)(a-b)\cdot(a+ib)(a-ib) \\
% & = (a^2-b^2)(a^2+b^2) \Arrow[i]{because $(x-y)(x+y)=x^2-y^2$}\\
% & = a^4-b^4
% \end{WithArrows}$
%
%
% \interitem
% The environment |{WithArrows}| gives also a |group| option. With this option, \emph{all} the arrows of the
% environment are grouped on a same vertical line and at a leftmost position.
% %
% \begin{Verbatim}[formatcom=\small\color{gray}]
% $\begin{WithArrows}[~emphase#displaystyle,group@]
% 2xy'-3y=\sqrt x
% & \Longleftrightarrow 2x(K'y_0+Ky_0')-3Ky_0 = \sqrt x \\
% & \Longleftrightarrow 2xK'y_0 + K(2xy_0'-3y_0) = \sqrt x \\
% & \Longleftrightarrow 2x K'y_0 = \sqrt x \Arrow{...}\\
% ...
% \end{WithArrows}$
% \end{Verbatim}
%
%
% $\begin{WithArrows}[displaystyle,group]
% 2xy'-3y=\sqrt x
% & \Longleftrightarrow 2x(K'y_0+Ky_0')-3Ky_0 = \sqrt x \\
% & \Longleftrightarrow 2xK'y_0 + K(2xy_0'-3y_0) = \sqrt x \\
% & \Longleftrightarrow 2x K'y_0 = \sqrt x \Arrow{We replace $y_0$ by its value.}\\
% & \Longleftrightarrow 2xK'x^{\frac32} = x^{\frac12} \Arrow{simplification of the $x$}\\
% & \Longleftrightarrow K' = \tfrac1{2x^2} \Arrow{antiderivation}\\
% & \Longleftrightarrow K = -\tfrac1{2x}
% \end{WithArrows}$
%
%
% \bigskip
% The environment |{WithArrows}| gives also a |groups| option (with a \emph{s} in the name). With this option, the
% arrows are divided into several ``groups''. Each group is a set of connected\footnote{More precisely: for each
% arrow $a$, we note $i(a)$ the number of its initial row and $f(a)$ the number of its final line; for two arrows
% $a$ and $b$, we say that $a \sim b$ when
% $\llbracket i(a),f(a)\rrbracket \cap \llbracket i(b),f(b)\rrbracket \neq \varnothing$; the groups are the
% equivalence classes of the transitive closure of $\sim$.} arrows. All the arrows of a given group are grouped on
% a same vertical line and at a leftmost position.
%
% \bigskip
% $\begin{WithArrows}[groups]
% A & = B \Arrow{one} \\
% & = C+D \Arrow{two} \\
% & = D' \\
% & = E+F+G+H+I \\
% & = K + L + M \Arrow{three}\\
% & = N \Arrow{four}\\
% & = O
% \end{WithArrows}$
%
% \bigskip
% If desired, the option |group| or the option |groups| can be given to the command |\WithArrowsOptions| so that it will become
% the default value. In this case, it's still possible to come back to the default behaviour for a given
% environment |{WithArrows}| with the option |rr|: |\begin{WithArrows}[rr]|
%
%
% \section{Comparison with the environment \{aligned\}}
%
% |{WithArrows}| bears similarities with the environment |{aligned}| of the extension \pkg{amsmath}. These are only
% similarities because |{WithArrows}| has not been written upon the environment |{aligned}|.\footnote{In fact, it's
% possible to use the package \pkg{witharrows} without the package \pkg{amsmath}.}
%
% \interitem
% As in the environments of \pkg{amsmath}, it's possible to change the spacing between two given rows with the
% option of the command |\\| of end of line (it's also possible to use |\\*| but is has exactly the same effect as
% |\\| since an environment |{WithArrows}| is always unbreakable).
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow{we expand} ~emphase#\\[2ex]@
% & = a^2 + 2a + 1
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow{we expand} \\*[2ex]
% \noalign{\vspace{3mm}}
% & = a^2 + 2a + 1
% \end{WithArrows}$
%
%
% \interitem
% In the environments of \pkg{amsmath} (or \pkg{mathtools}), the spacing between rows is fixed by a parameter
% called |\jot| (it's a dimension and not a skip). That's also the case for the environment |{WithArrows}|. An
% option |jot| has been given to the environment |{WithArrows}| in order to change the value of this parameter
% |\jot| for an given environment.\footnote{It's also possible to change |\jot| with the environment |{spreadlines}|
% of \pkg{mathtools}.}
% %
% \begin{Verbatim}
% $\begin{WithArrows}[displaystyle,~emphase#jot=2ex@]
% F & = \frac12G \Arrow{we expand}\\
% & = H + \frac12K \Arrow{we go on}\\
% & = K
% \end{WithArrows}$
% \end{Verbatim}
%
%
% $\begin{WithArrows}[displaystyle,jot=2ex]
% F & = \frac12G \Arrow{we expand}\\
% & = H + \frac12K \Arrow{we go on}\\
% & = K
% \end{WithArrows}$
%
%
% \bigskip
% However, this new value of |\jot| will also be used in other alignments included in the
% environment~|{WithArrows}|:
% %
% \begin{Verbatim}
% $\begin{WithArrows}[jot=2ex]
% \varphi(x,y) = 0 & \Leftrightarrow (x+y)^2 + (x+2y)^2 = 0
% \Arrow{$x$ and $y$ are real}\\
% & \Leftrightarrow \left\{
% \begin{aligned}
% x+y & = 0 \\
% x+2y & = 0
% \end{aligned}
% \right.
% \end{WithArrows}$
% \end{Verbatim}
%
%
% $\begin{WithArrows}[jot=2ex]
% \varphi(x,y) = 0 & \Leftrightarrow (x+y)^2 + (x+2y)^2 = 0
% \Arrow{$x$ and $y$ are real}\\
% & \Leftrightarrow \left\{
% \begin{aligned}
% x+y & = 0 \\
% x+2y & = 0
% \end{aligned}
% \right.
% \end{WithArrows}$
%
% \bigskip
% Maybe this doesn't correspond to the desired outcome. That's why an option |interline| is proposed. It's possible
% to use a skip (=glue) for this option.
% %
% \begin{Verbatim}
% $\begin{WithArrows}[~emphase#interline=2ex@]
% \varphi(x,y) = 0 & \Leftrightarrow (x+y)^2 + (x+2y)^2 = 0
% \Arrow{$x$ and $y$ are real}\\
% & \Leftrightarrow \left\{
% \begin{aligned}
% x+y & = 0 \\
% x+2y & = 0 \\
% \end{aligned}
% \right.
% \end{WithArrows}$
% \end{Verbatim}
%
%
% $\begin{WithArrows}[interline=2ex]
% \varphi(x,y) = 0 & \Leftrightarrow (x+y)^2 + (x+2y)^2 = 0
% \Arrow{$x$ and $y$ are real}\\
% & \Leftrightarrow \left\{
% \begin{aligned}
% x+y & = 0 \\
% x+2y & = 0 \\
% \end{aligned}
% \right.
% \end{WithArrows}$
%
%
% \interitem
% Like the environment |{aligned}|, |{WithArrows}| has an option of placement which can assume the values |t|, |c|
% or |b|. However, the default value is not |c| but |t|. If desired, it's possible to have the |c| value as the
% default with the command |\WithArrowsOptions{c}| at the beginning of the document.
% %
% \begin{Verbatim}
% So\enskip
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow{we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
% \end{Verbatim}
%
% So\enskip
% $\begin{WithArrows}
% A & = (a+1)^2 \Arrow{we expand} \\
% & = a^2 + 2a + 1
% \end{WithArrows}$
%
% \bigskip
% The value |c| may be useful, for example, if we want to add curly braces:
%
% \smallskip
% \begin{Verbatim}
% On pose\enskip $~emphase#\left\{@
% \begin{WithArrows}[~emphase#c@]
% f(x) & = 3x^3+2x^2-x+4
% \Arrow[tikz=-]{both are polynoms}\\
% g(x) & = 5x^2-5x+6
% \end{WithArrows}
% ~emphase#\right.@$
% \end{Verbatim}
%
%
% On pose\enskip $\left\{
% \begin{WithArrows}[c]
% f(x) & = 3x^3+2x^2-x+4
% \Arrow[tikz=-]{both are polynoms}\\
% g(x) & = 5x^2-5x+6
% \end{WithArrows}
% \right.$
%
%
% \interitem
% Unlike |{aligned}|, the environment |{WithArrows}| uses |\textstyle| by default.
%
% Once again, it's possible to change this behaviour with |\WithArrowsOptions|:
%
% \quad |\WithArrowsOptions{displaystyle}|.
%
%
% \smallskip
% The following example is composed with |{aligned}|:\par\nobreak
%
% \smallskip
% $\left\{
% \begin{aligned}
% \sum_{i=1}^n (x_i+1)^2
% & = \sum_{i=1}^n (x_i^2 + 2x_i+1) \\
% & = \sum_{i=1}^n x_i^2 + 2 \sum_{i=1}^nx_i + n
% \end{aligned}
% \right.$
%
%
% \medskip
% The following is composed with |{WithArrows}[c,displaystyle]|. The results are strictly identical.\footnote{In
% versions of \pkg{amsmath} older than the 5~nov.~2016, an thin space was added on the left of an environment
% |{aligned}|. The new versions do not add this space and neither do |{WithArrows}|.}\par\nobreak
%
% \smallskip
% $\left\{
% \begin{WithArrows}[c,displaystyle]
% \sum_{i=1}^n (x_i+1)^2
% & = \sum_{i=1}^n (x_i^2 + 2x_i+1) \\
% & = \sum_{i=1}^n x_i^2 + 2 \sum_{i=1}^nx_i + n
% \end{WithArrows}
% \right.$
%
%
% \section{Arrows in nested environments}
%
% \label{NestedEnv}
%
% The environments |{WithArrows}| can be nested. In this case, the options given to the encompassing environment
% applies also to the inner ones (with logical exceptions for |interline|, |CodeBefore| and |CodeAfter|). The
% command |Arrow| can be used as usual in each environment |{WithArrows}|.
%
% \begin{Verbatim}[formatcom=\small\color{gray}]
% $~emphase#\begin{WithArrows}@
% \varphi(x,y)=0
% & \Leftrightarrow (x+2y)^2+(2x+4y)^2 = 0 \Arrow{the numbers are real}\\
% & \Leftrightarrow
% \left\{~emphase#\begin{WithArrows}@[c]
% x+2y & = 0 \\
% 2x+4y & = 0
% ~emphase#\end{WithArrows}@\right. \\
% & \Leftrightarrow
% \left\{~emphase#\begin{WithArrows}@[c]
% x+2y & = 0 \Arrow[tikz=-]{the same equation}\\
% x+2y & = 0
% ~emphase#\end{WithArrows}@\right. \\
% & \Leftrightarrow x+2y=0
% ~emphase#\end{WithArrows}@$
% \end{Verbatim}
%
% $\begin{WithArrows}
% \varphi(x,y)=0
% & \Leftrightarrow (x+2y)^2+(2x+4y)^2 = 0 \Arrow{the numbers are real}\\
% & \Leftrightarrow
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \\
% 2x+4y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \Arrow[tikz=-]{the same equation}\\
% x+2y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow x+2y=0
% \end{WithArrows}$
%
% \bigskip
% However, one may want to draw an arrow between rows that are not in the same environment. For example, one may want
% to draw the following arrow :
%
% \bigskip
% $\begin{WithArrows}[CodeAfter = {\Arrow[v]{1-2}{2-2}{Division by $2$}}]
% \varphi(x,y)=0
% & \Leftrightarrow (x+2y)^2+(2x+4y)^2 = 0 \\
% & \Leftrightarrow
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \\
% 2x+4y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \\
% x+2y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow x+2y=0
% \end{WithArrows}$
%
%
% \bigskip
% Such a construction is possible by using |\Arrow| in the |CodeAfter| option. Indeed, in |CodeAfter|, a special
% version of |\Arrow| is available (we will call it ``|\Arrow| in |CodeAfter|'').
%
% \smallskip
% A command |\Arrow| in |CodeAfter| takes three arguments :
% \begin{itemize}
% \item a specification of the start row of the arrow ;
% \item a specification of the end row of the arrow ;
% \item the label of the arrow.
% \end{itemize}
% As usual, it's also possible to give options within square brackets before or after the three arguments. However,
% these options are limited (see below).
%
% \bigskip
% The specification of the row is constructed with the position of the concerned environment in the nesting tree,
% followed (after an hyphen) by the number of the row.
%
% \bigskip
% In the previous example, there are two environments |{WithArrows}| nested in the main environment |{WithArrows}|.
%
% $\begin{WithArrows}[TikzCode = {\path (#1) to node {#3} (#2) ; }]
% \varphi(x,y)=0
% & \Leftrightarrow (x+2y)^2+(2x+4y)^2 = 0 \\
% & \Leftrightarrow \color{blue}
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \Arrow{environment number 1}\\
% 2x+4y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow \color{red}
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \Arrow{environment number 2}\\
% x+2y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow x+2y=0
% \end{WithArrows}$
%
% \bigskip
% The arrow we want to draw starts in the row~$2$ of the sub-environment number~$1$ (and therefore, the
% specification is |1-2|) and ends in the row~$2$ of the sub-environment number~$2$ (and therefore, the
% specification is |2-2|). We can draw the arrow with the following command |\Arrow| in |CodeAfter| :
% \begin{Verbatim}
% $\begin{WithArrows}[~emphase#CodeAfter = {\Arrow{1-2}{2-2}{Division by $2$}}@]
% \varphi(x,y)=0
% & \Leftrightarrow (x+2y)^2+(2x+4y)^2 = 0 \\
% .........
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}[CodeAfter = {\Arrow{1-2}{2-2}{Division by $2$}}]
% \varphi(x,y)=0
% & \Leftrightarrow (x+2y)^2+(2x+4y)^2 = 0 \\
% & \Leftrightarrow
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \\
% 2x+4y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \\
% x+2y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow x+2y=0
% \end{WithArrows}$
%
% \bigskip
% The options allowed for a command |\Arrow| in |CodeAfter| are : |ll|, |lr|, |rl|, |rr|, |v|, |xoffset|, |tikz|
% and |TikzCode|. Except |v|, which is specific to |\Arrow| in |CodeAfter|, all these options have their usual
% meaning.
%
% With the option |v|, the arrow drawn is vertical to an abscissa computed with the start row and the end row
% only : the intermediate lines are not taken into account unlike with the option |i|. Currently, the option |i| is
% not available for the command~|\Arrow| in |CodeAfter|. However, it's always possible to translate an arrow with
% |xoffset| (or |xshift| of Tikz).
% \begin{Verbatim}
% $\begin{WithArrows}[CodeAfter = {\Arrow~emphase#[v]@{1-2}{2-2}{Division by $2$}}]
% \varphi(x,y)=0
% & \Leftrightarrow (x+2y)^2+(2x+4y)^2 = 0 \\
% .........
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}[CodeAfter = {\Arrow[v]{1-2}{2-2}{Division by $2$}}]
% \varphi(x,y)=0
% & \Leftrightarrow (x+2y)^2+(2x+4y)^2 = 0 \\
% & \Leftrightarrow
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \\
% 2x+4y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow
% \left\{\begin{WithArrows}[c]
% x+2y & = 0 \\
% x+2y & = 0
% \end{WithArrows}\right. \\
% & \Leftrightarrow x+2y=0
% \end{WithArrows}$
%
%
% \interitem
% The package \pkg{witharrows} gives also another command available only in |CodeAfter|: the command
% |\MultiArrow|. This command draws a ``rak''. The list of the rows of the environment concerned by this rak are
% given in the first argument of the command |\MultiArrow|. This list is given with the syntax of the list in a
% |\foreach| command of \pkg{pgfkeys}.
%
%
% \begin{Verbatim}
% $\begin{WithArrows}[tikz = rounded corners,
% CodeAfter = {~emphase#\MultiArrow{1,...,4}{text}@}]
% A & = B \\
% & = C \\
% & = D \\
% & = E \\
% & = F
% \end{WithArrows}$
% \end{Verbatim}
%
%
% $\begin{WithArrows}[tikz = rounded corners,
% CodeAfter = {\MultiArrow{1,...,4}{text}}]
% A & = B \\
% & = C \\
% & = D \\
% & = E \\
% & = F
% \end{WithArrows}$
%
% \medskip
% As of now, there is no option available for the command |\MultiArrow| (maybe in a future release).
%
%
% \bigskip
% \section{Arrows from outside environments \{WithArrows\}}
%
% If someone wants to draw arrows from outside the environments |{WithArrows}|, he can use the Tikz nodes created
% in the environments.
%
% The Tikz name of a node created by \pkg{witharrows} is prefixed by |wa-|. Then, we have a list of numbers which
% give the position in the nesting tree and the row number in the environment. At the end, we have the suffixe |l|
% for a ``left node'' and |r| for a ``right node''.
%
% \smallskip
% For illustrative purposes, we give an example of nested environments |{WithArrows}|, and, for each ``right
% node'', the name of that node.\footnote{There is an option |shownodenames| to show the names of these nodes.}
%
% \medskip
% \[\begin{WithArrows}[shownodes,shownodenames]
% A & \vartriangleleft B+B+B+B+B+B+B+B+B+B+B+B+B \\
% & \vartriangleleft \left\{
% \begin{WithArrows}[c]
% C & \vartriangleleft D \\
% E & \vartriangleleft F
% \end{WithArrows}
% \right. \\
% & \vartriangleleft
% \left\{
% \begin{WithArrows}[c]
% G & \vartriangleleft H+H+H+H+H+H+H \\
% I & \vartriangleleft
% \left\{
% \begin{WithArrows}
% J &\vartriangleleft K \\
% L &\vartriangleleft M
% \end{WithArrows}
% \right.
% \end{WithArrows}
% \right. \\
% & \vartriangleleft
% \left\{
% \begin{WithArrows}[c]
% N & \vartriangleleft O \\
% P & \vartriangleleft Q
% \end{WithArrows}
% \right.
% \end{WithArrows}\]
%
% \medskip
% The package \pkg{witharrows} provides some tools facilitating the use of these nodes:
% \begin{itemize}
% \item the command |\WithArrowsLastEnv| gives the number of the last environment of level~$0$;
%
% \item a name can be given to a given environment with the option |name| and, in this case, the nodes created in
% the environment will have aliases constructed with this name;
%
% \item the Tikz style |WithArrows/arrow| is the style used by \pkg{witharrows} when drawing an arrow\footnote{More
% precisely, this style is given to the Tikz option ``|every path|'' before drawing the arrow with the code of the
% option |TikzCode|. This style is modified (in TeX scopes) by the option |tikz| of \pkg{witharrows}.};
%
% \item the Tikz style |WithArrows/arrow/tips| is the style for the tip of the arrow (loaded by |WithArrows/arrow|).
% \end{itemize}
%
% For example, we can draw an arrow from \texttt{wa-\WithArrowsLastEnv-2-1-2-r.south} to
% \texttt{wa-\WithArrowsLastEnv-3-2-r.north} with the following Tikz command.
%
% \begin{Verbatim}
% \begin{tikzpicture}[remember picture,overlay]
% \draw [WithArrows/arrow]
% ([xshift=3mm]wa-\WithArrowsLastEnv-2-1-2-r.south)
% to ([xshift=3mm]wa-\WithArrowsLastEnv-3-2-r.north) ;
% \end{tikzpicture}
% \end{Verbatim}
%
% \[\begin{WithArrows}
% A & \vartriangleleft B+B+B+B+B+B+B+B+B+B+B+B+B \\
% & \vartriangleleft \left\{
% \begin{WithArrows}[c]
% C & \vartriangleleft D \\
% E & \vartriangleleft F
% \end{WithArrows}
% \right. \\
% & \vartriangleleft
% \left\{
% \begin{WithArrows}[c]
% G & \vartriangleleft H+H+H+H+H+H+H \\
% I & \vartriangleleft
% \left\{
% \begin{WithArrows}
% J &\vartriangleleft K \\
% L &\vartriangleleft M
% \end{WithArrows}
% \right.
% \end{WithArrows}
% \right. \\
% & \vartriangleleft
% \left\{
% \begin{WithArrows}[c]
% N & \vartriangleleft O \\
% P & \vartriangleleft Q
% \end{WithArrows}
% \right.
% \end{WithArrows}\]
%
% \begin{tikzpicture}[remember picture,overlay]
% \draw [WithArrows/arrow]
% ([xshift=3mm]wa-\WithArrowsLastEnv-2-1-2-r.south)
% to ([xshift=3mm]wa-\WithArrowsLastEnv-3-2-r.north) ;
% \end{tikzpicture}
%
% \medskip
% In this case, it would be easier to use a command |\Arrow| in |CodeAfter| but this is an example to explain how
% the Tikz nodes created by \pkg{witharrows} can be used.
%
% \bigskip
% In the following example, we create two environments |{WithArrows}| named ``|first|'' and ``|second|'' and we
% draw a line between a node of the first and a node of the second.
%
% \begin{Verbatim}
% $\begin{WithArrows}[~emphase#name=first@]
% A & = B \\
% & = C
% \end{WithArrows}$
%
% \bigskip
% $\begin{WithArrows}[~emphase#name=second@]
% A' & = B' \\
% & = C'
% \end{WithArrows}$
%
% \begin{tikzpicture}[remember picture,overlay]
% \draw [WithArrows/arrow]
% ($(~emphase#first@-1-r.south)+(3mm,0)$)
% to ($(~emphase#second@-1-r.north)+(3mm,0)$) ;
% \end{tikzpicture}
% \end{Verbatim}
%
%
% \begin{center}
% $\begin{WithArrows}[name=first]
% A & = B \\
% & = C
% \end{WithArrows}$
%
% \bigskip
% $\begin{WithArrows}[name=second]
% A' & = B' \\
% & = C'
% \end{WithArrows}$
% \end{center}
%
% \begin{tikzpicture}[remember picture,overlay]
% \draw [WithArrows/arrow]
% ($(first-1-r.south)+(3mm,0)$)
% to ($(second-1-r.north)+(3mm,0)$) ;
% \end{tikzpicture}
%
% \section{The environment \{DispWithArrows\}}
% \label{DispWithArrows}
%
% As previously said, the environment |{WithArrows}| bears similarities with the environment |{aligned}| of
% |amsmath| (and |mathtools|). This extension also provides an environment |{DispWithArrows}| which is similar to
% the environments |{align}| and |{flalign}| of |amsmath|.
%
% \medskip
% The environment |{DispWithArrows}| must be used \emph{outside} math mode.
% \begin{Verbatim}
% \begin{~emphase#DispWithArrows@}
% A & = (a+1)^2 \Arrow{we expand} \\
% & = a^2 + 2a + 1
% \end{~emphase#DispWithArrows@}
% \end{Verbatim}
%
% \begin{DispWithArrows}
% A & = (a+1)^2 \Arrow{we expand} \\
% & = a^2 + 2a + 1
% \end{DispWithArrows}
%
% \medskip
% It's possible to use the command |\notag| (or |\nonumber|) to suppress a tag.
%
% It's possible to use the command |\tag| to put a special tag (e.g. $\star$).\footnote{If \pkg{amsmath} (or
% \pkg{mathtools}) is loaded, it's also possible to use |\tag*| which, as in \pkg{amsmath}, typesets the tag
% without the parenthesis.}
%
% It's also possible to put a label to the line of an equation with the command |\label|.\footnote{As in the
% environment |{align}| of \pkg{amsmath}, it's not possible to put two commands |\label| in the same line.}
%
% These commands must be in the second column of the environment.
% \begin{Verbatim}
% \begin{DispWithArrows}
% A & = (a+1)^2 \Arrow{we expand} ~emphase#\notag@ \\
% & = a^2 + 2a + 1 ~emphase#\tag{$\star$} \label{my-equation}@
% \end{DispWithArrows}
% \end{Verbatim}
%
% \begin{DispWithArrows}
% A & = (a+1)^2 \Arrow{we expand} \notag \\
% & = a^2 + 2a + 1 \tag{$\star$} \label{my-equation}
% \end{DispWithArrows}
% A link to the equation \eqref{my-equation}. This link has been composed with |\eqref{my-equation}| (the command
% |\eqref| is a command of \pkg{amsmath}).
%
% \medskip
% It's also possible to suppress all the autogenerated numbers with the option |notag| (or |nonumber|), at the
% global or environment level. There is also an environment |{DispWithArrows*}| which suppresses all these
% numbers.\footnote{Even in this case, it's possible to put a ``manual tag'' with the command |\tag|.}
% \begin{Verbatim}
% \begin{~emphase#DispWithArrows*@}
% A & = (a+1)^2 \Arrow{we expand} \\
% & = a^2 + 2a + 1
% \end{~emphase#DispWithArrows*@}
% \end{Verbatim}
%
% \begin{DispWithArrows*}
% A & = (a+1)^2 \Arrow{we expand} \\
% & = a^2 + 2a + 1
% \end{DispWithArrows*}
%
% \medskip
% With the option |fleqn|, the environment is composed flush left (in a way similar to the option |fleqn| of the
% standard classes of LaTeX). In this case, the left margin can be controlled with the option |mathindent| (with a
% name inspired by the parameter |\mathindent| of standard LaTeX). The default value of this parameter is 25~pt.
%
% \begin{Verbatim}
% \begin{DispWithArrows}[~emphase#fleqn,mathindent = 1cm@]
% A & = (a+1)^2 \Arrow{we expand} \\
% & = a^2 + 2a + 1
% \end{DispWithArrows}
% \end{Verbatim}
%
% \begin{DispWithArrows}[fleqn,mathindent = 1cm]
% A & = (a+1)^2 \Arrow{we expand} \\
% & = a^2 + 2a + 1
% \end{DispWithArrows}
%
% \medskip
% \emph{Remark} : By design, the option |fleqn| of \pkg{witharrows} is independant of the option |fleqn| of LaTeX.
% Indeed, since the environments of \pkg{witharrows} are meant to be used with arrows on the right side, the
% user may want to use \pkg{witharrows} with the option |fleqn| (in order to have more space on the right of the
% equations for the arrows) while still centering the classical equations.
%
% \bigskip
% If the package \pkg{amsmath} is loaded, it's possible to use the environment |{subequations}| and the command
% |\intertext| in the environments |{DispWithArrows}| and |{DispWithArrows*}| (and even the |\intertext| of
% \pkg{nccmath} if this package is loaded).
%
% If the option |leqno| is used (for the document or when the package \pkg{amsmath} is loaded), the labels will be
% composed on the left also for the environments |{DispWithArrows}| et |{DispWithArrows*}|.
%
% \bigskip
% The environment |{DispWithArrows}| is similar to the environment |{align}| of \pkg{amsmath}. However,
% |{DispWithArrows}| is not constructed upon |{align}| (in fact, it's possible to use \pkg{witharrows} without
% \pkg{amsmath}).
%
% There are differences between |{DispWithArrows}| and |{align}|.
% \begin{itemize}
% \item The environment |{DispWithArrows}| allows only two columns.
% \item With |{DispWithArrows}|, there is no control of a collision between an equation and its tag.
% \item An environment |{DispWithArrows}| is always unbreakable (even with |\allowdisplaybreaks| of \pkg{amsmath}).
% \item The commands |\label|, |\tag|, |\notag|, |\nonumber| are allowed only in the second column.
% \item
% \begin{bfseries}
% Last but not least, by default, the elements of a \texttt{\{DispWithArrows\}} are composed in \texttt{textstyle} and not in
% \texttt{displaystyle} (it's possible to change this point with the option \texttt{displaystyle}).
% \end{bfseries}
% \end{itemize}
%
% \bigskip
% Concerning the references, the package \pkg{witharrows} is compatible with the extensions \pkg{autonum},
% \pkg{cleveref}, \pkg{fancyref}, \pkg{hyperref}, \pkg{prettyref}, \pkg{refstyle}, \pkg{typedref} and
% \pkg{varioref}, and with the options |showonlyrefs| and |showmanualtags| of \pkg{mathtools}.\footnote{We recall
% that \pkg{varioref}, \pkg{hyperref}, \pkg{cleveref} and \pkg{autonum} must be loaded in this order. The package
% \pkg{witharrows} can be loaded anywhere.}
%
% It is not compatible with \pkg{showkeys} (not all the labels are shown).
%
% \bigskip
% The environments |{DispWithArrows}| and |{DispWithArrows*}| provide an option |wrap-lines|. With this option,
% the lines of the label are automaticly wrapped on the right.\label{wrap-lines}
%
% \begin{Verbatim}
% \begin{DispWithArrows*}[displaystyle,~emphase#wrap-lines@]
% S_n
% & = \frac1n \Re \left(\sum_{k=0}^{n-1}\bigl(e^{i\frac{\pi}{2n}}\bigr)^k\right)
% \Arrow{sum of terms of a geometric progression of ratio $e^{i\frac{2\pi}n}$}\\
% & = \frac1n \Re \left( \frac{1-\bigl(e^{i\frac{\pi}{2n}}\bigr)^n}
% {1-e^{i\frac{\pi}{2n}}}\right)
% \Arrow{This line has been wrapped automaticly.} \\
% & = \frac1n \Re \left(\frac{1-i}{1-e^{i\frac{\pi}{2n}}}\right)
% \end{DispWithArrows*}
% \end{Verbatim}
%
%
% \begin{DispWithArrows*}[displaystyle,wrap-lines]
% S_n
% & = \frac1n \Re \left(\sum_{k=0}^{n-1}\bigl(e^{i\frac{\pi}{2n}}\bigr)^k\right)
% \Arrow{sum of terms of a geometric progression of ratio $e^{i\frac{2\pi}n}$}\\
% & = \frac1n \Re \left( \frac{1-\bigl(e^{i\frac{\pi}{2n}}\bigr)^n}{1-e^{i\frac{\pi}{2n}}}\right)
% \Arrow{This line has been wrapped automaticly.} \\
% & = \frac1n \Re \left(\frac{1-i}{1-e^{i\frac{\pi}{2n}}}\right)
% \end{DispWithArrows*}
%
% \bigskip
% The option |wrap-lines| doesn't apply to the environments |{WithArrows}| nested in an environment
% |{DispWithArrows}| or |{DispWithArrows*}|. However, it applies to the instructions |\Arrow| and |\MultiArrow| of
% the |CodeAfter| of the environments |{DispWithArrows}| or |{DispWithArrows*}|.
%
% \section{Advanced features}
%
%
% \subsection{The option TikzCode : how to change the shape of the arrows}
%
% \label{TikzCode}
%
% The option |TikzCode| allows the user to change the shape of the arrows.\footnote{If the option |wrap-lines| is
% used in an environment |{DispWithArrows}| or |{DispWithArrows*}|, the option |TikzCode| will have no effect for
% the arrows of this environment but only for the arrows in the nested environments |{WithArrows}|.}
%
% \smallskip
% The value of this option must be a valid Tikz drawing instruction (with the final semi-colon) with three markers
% |#1|, |#2| and |#3| for the start point, the end point and the label of the arrow.
%
% \bigskip
% By default, the value is the following:
%
% \smallskip
% \qquad \verb|\draw (#1) to node {#3} (#2) ;|
%
%
% \bigskip
% In the following example, we replace this default path by a path with three segments (and the node overwriting
% the second segment).
% \begin{Verbatim}
% \begin{WithArrows}[ygap=5pt,interline=4mm,
% ~emphase#TikzCode = {\draw[rounded corners]@
% ~emphase# (~#1) -- ($(~#1) + (5mm,0)$)@
% ~emphase# -- node[circle,@
% ~emphase# draw,@
% ~emphase# auto = false,@
% ~emphase# fill = gray!50,@
% ~emphase# inner sep = 1pt] {\tiny ~#3}@
% ~emphase# ($(~#2) + (5mm,0)$)@
% ~emphase# -- (~#2) ; }@]
% E & \Longleftrightarrow 3 (2x+4) = 6 \Arrow{$\div 3$} \\
% & \Longleftrightarrow 2x+4 = 2 \Arrow{$-4$} \\
% & \Longleftrightarrow 2x = -2 \Arrow{$\div 2$} \\
% & \Longleftrightarrow x = -1
% \end{WithArrows}
% \end{Verbatim}
%
%
% \[\begin{WithArrows}[ygap=5pt,
% interline=4mm,
% TikzCode = {\draw[rounded corners]
% (#1)
% --
% ($(#1) + (5mm,0)$)
% -- node[circle,
% draw,
% auto=false,
% fill=gray!50,
% inner sep = 1pt] {\tiny #3}
% ($(#2) + (5mm,0)$)
% --
% (#2) ; }]
% E & \Longleftrightarrow 3 (2x+4) = 6
% \Arrow{$\div 3$}\\
% & \Longleftrightarrow 2x+4 = 2
% \Arrow{$-4$}\\
% & \Longleftrightarrow 2x = -2
% \Arrow{$\div 2$} \\
% & \Longleftrightarrow 2x = -1
% \end{WithArrows}\]
%
% \bigskip
% \subsection{Footnotes in the environments of witharrows}
%
% If you want to put footnotes in an environment |{WithArrows}| or |{DispWithArrows}|, you can use a pair
% |\footnotemark|--|\footnotetext|.
%
% \smallskip
% It's also possible to extract the footnotes with the help of the package \pkg{footnote} or the package \pkg{footnotehyper}.
%
% \smallskip
% If \pkg{witharrows} is loaded with the option |footnote| (with |\usepackage[footnote]{witharrows}| or with
% |\PassOptionsToPackage|), the package \pkg{footnote} is loaded (if it is not yet loaded) and it is used to
% extract the footnotes.
%
% \smallskip
% If \pkg{witharrows} is loaded with the option |footnotehyper|, the package \pkg{footnotehyper} is loaded (if it
% is not yet loaded) ant it is used to extract footnotes.
%
% \smallskip
% Caution: The packages \pkg{footnote} and \pkg{footnotehyper} are incompatible. The package \pkg{footnotehyper} is the
% successor of the package \pkg{footnote} and should be used preferently. The package \pkg{footnote} has some
% drawbacks, in particular: it must be loaded after the package \pkg{xcolor} and it is not perfectly compatible
% with \pkg{hyperref}.
%
% \medskip
% In this document, the package \pkg{witharrows} has been loaded with the option |footnotehyper| and we give an
% example with a footnote in the label of an arrow:
%
% \smallskip
% $\begin{WithArrows}
% A & = (a+b)^2
% \Arrow{We expand\,\footnote{A footnote.}} \\
% & = a^2+b^2+2ab
% \end{WithArrows}$
%
%
% \section{Examples}
%
% \subsection{With only one column}
%
% It's possible to use the environment |{WithArrows}| with making use of the left column only, or the right column
% only.
% %
% \begin{Verbatim}
% $\begin{WithArrows}
% &f(x) \ge g(x) \Arrow{by squaring both sides} \\
% & f(x)^2 \ge g(x)^2 \Arrow{by moving to left side} \\
% & f(x)^2 - g(x)^2 \ge 0
% \end{WithArrows}$
% \end{Verbatim}
%
% $\begin{WithArrows}
% &f(x) \ge g(x) \Arrow{by squaring both sides} \\
% & f(x)^2 \ge g(x)^2 \Arrow{by moving to left side} \\
% & f(x)^2 - g(x)^2 \ge 0
% \end{WithArrows}$
%
% \bigskip
% \subsection{MoveEqLeft}
%
% It's possible to use |\MoveEqLeft| of \pkg{mathtools} (if we don't want ampersand on the first line):
% %
% \begin{Verbatim}[formatcom=\small\color{gray}]
% $\begin{WithArrows}[interline=0.5ex]
% ~emphase#\MoveEqLeft@ \arccos(x) = \arcsin \frac45 + \arcsin \frac5{13}
% \Arrow{because both are in $[-\frac{\pi}2,\frac{\pi}2]$} \\
% & \Leftrightarrow x = \sin\left(\arcsin\frac45 + \arcsin\frac5{13}\right) \\
% & \Leftrightarrow x = \frac45\cos\arcsin\frac5{13} + \frac5{13} \cos\arcsin\frac45
% \Arrow{$\forall x \in [-1,1], \cos(\arcsin x) = \sqrt{1-x^2}$} \\
% & \Leftrightarrow x = \frac45\sqrt{1-\bigl(\frac5{13}\bigr)^2}
% + \frac5{13}\sqrt{1-\bigl(\frac45\bigr)^2}
% \end{WithArrows}$
% \end{Verbatim}
%
%
% \medskip
% $\begin{WithArrows}[interline=0.5ex]
% \MoveEqLeft \arccos(x) = \arcsin \frac45 + \arcsin \frac5{13}
% \Arrow{because both are in $[-\frac{\pi}2,\frac{\pi}2]$} \\
% & \Leftrightarrow x = \sin\left(\arcsin\frac45 + \arcsin\frac5{13}\right) \\
% & \Leftrightarrow x = \frac45\cos\arcsin\frac5{13} + \frac5{13} \cos\arcsin\frac45
% \Arrow{$\forall x \in [-1,1], \cos(\arcsin x) = \sqrt{1-x^2}$} \\
% & \Leftrightarrow x = \frac45\sqrt{1-\bigl(\frac5{13}\bigr)^2}
% + \frac5{13}\sqrt{1-\bigl(\frac45\bigr)^2}
% \end{WithArrows}$
%
%
% \bigskip
% \subsection{Modifying the shape of the nodes}
%
% It's possible to change the shape of the labels, which are Tikz nodes, by modifying the key ``|every node|'' of
% Tikz.
%
% \begin{Verbatim}
% \begin{WithArrows}[%
% interline = 4mm,
% tikz = {~emphase#every node/.style = {circle,@
% ~emphase# draw,@
% ~emphase# auto = false,@
% ~emphase# fill = gray!50,@
% ~emphase# inner sep = 1pt,@
% ~emphase# font = \tiny}@}]
% E & \Longleftrightarrow 3 (2x+4) = 6
% \Arrow{$\div 3$}\\
% & \Longleftrightarrow 2x+4 = 2
% \Arrow{$-4$}\\
% & \Longleftrightarrow 2x = -2
% \Arrow{$\div 2$} \\
% & \Longleftrightarrow 2x = -1
% \end{WithArrows}
% \end{Verbatim}
%
% \[\begin{WithArrows}[%
% interline = 4mm,
% tikz = {every node/.style = {circle,
% draw,
% auto = false,
% fill = gray!50,
% inner sep = 1pt,
% font = \tiny}}]
% E & \Longleftrightarrow 3 (2x+4) = 6
% \Arrow{$\div 3$}\\
% & \Longleftrightarrow 2x+4 = 2
% \Arrow{$-4$}\\
% & \Longleftrightarrow 2x = -2
% \Arrow{$\div 2$} \\
% & \Longleftrightarrow 2x = -1
% \end{WithArrows}\]
%
%
% \bigskip
% \subsection{Examples with the option TikzCode}
%
% We recall that the option |TikzCode| is the Tikz code used by \pkg{witharrows} to draw the arrows.
%
% \smallskip
% The value by defaut of |TikzCode| is \verb|\draw (#1) to node {#3} (#2) ;| where the three markers |#1|, |#2| and
% |#3| represent the start row, the end row and the label of the arrow.
%
%
% \bigskip
% \subsubsection{Example 1}
% In the following example, we define the value of |TikzCode| with two instructions |\path| : the first instruction
% draws the arrow itself and the second puts the label in a Tikz node in the rectangle delimited by the arrow.
%
% \begin{Verbatim}
% $\begin{WithArrows}[
% displaystyle,
% ygap = 2mm,
% ystart = 0mm,
% ~emphase#TikzCode = {\draw (~#1) -- ++(4.5cm,0) |- (~#2) ;@
% ~emphase# \path (~#1) -- (~#2) @
% ~emphase# node[text width = 4.2cm, right, midway] {~#3} ;}@]
% S_n
% & = \frac1n \sum_{k=0}^{n-1}\cos\bigl(\tfrac{\pi}2\cdot\tfrac kn\bigr)
% ...........
% \end{Verbatim}
%
%
% \bigskip
% $\begin{WithArrows}[
% displaystyle,
% ygap = 2mm,
% ystart = 0mm,
% TikzCode = {\draw (#1) -- ++(4.5cm,0) |- (#2) ;
% \path (#1) -- (#2)
% node[text width = 4.2cm, right, midway] {#3} ;}]
% S_n
% & = \frac1n \sum_{k=0}^{n-1}\cos\bigl(\tfrac{\pi}2\cdot\tfrac kn\bigr)
% \Arrow{$\cos x = \Re(e^{ix})$}\\
% & = \frac1n\sum_{k=0}^{n-1} \Re\left(e^{i\frac{k\pi}{2n}}\right)
% \Arrow{$\Re(z+z')=\Re(z)+\Re(z')$}\\
% & = \frac1n \Re\left(\sum_{k=0}^{n-1} e^{i\frac{k\pi}{2n}}\right)
% \Arrow{$\exp$ is a morphism for $\times$ et $+$} \\
% & = \frac1n \Re \left(\sum_{k=0}^{n-1}\bigl(e^{i\frac{\pi}{2n}}\bigr)^k\right)
% \Arrow{sum of terms of a geometric progression of ratio $e^{i\frac{2\pi}n}$}\\
% & = \frac1n \Re \left( \frac{1-\bigl(e^{i\frac{\pi}{2n}}\bigr)^n}{1-e^{i\frac{\pi}{2n}}}\right)\\
% & = \frac1n \Re \left(\frac{1-i}{1-e^{i\frac{\pi}{2n}}}\right)
% \end{WithArrows}$
%
% \bigskip
% \subsubsection{Example 2}
%
% In the following example, we change the shape of the arrow depending on wether the start row is longer than the
% end row or not. This example requires the Tikz library \pkg{calc}.
%
% \begin{Verbatim}
% \begin{WithArrows}[ll,interline=5mm,xoffset=5mm,
% ~emphase#TikzCode = {\draw[rounded corners,@
% ~emphase# every node/.style = {circle,@
% ~emphase# draw,@
% ~emphase# auto = false,@
% ~emphase# inner sep = 1pt,@
% ~emphase# fill = gray!50,@
% ~emphase# font = \tiny }]@
% ~emphase# let \p1 = (~#1),@
% ~emphase# \p2 = (~#2)@
% ~emphase# in \ifdim \x1 > \x2@
% ~emphase# (\p1) -- node {~#3} (\x1,\y2) -- (\p2)@
% ~emphase# \else@
% ~emphase# (\p1) -- (\x2,\y1) -- node {~#3} (\p2)@
% ~emphase# \fi ;}@]
% E & \Longleftrightarrow \frac{(x+4)}3 + \frac{5x+3}5 = 7
% \Arrow{$\times 15$}\\
% & \Longleftrightarrow 5(x+4) + 3(5x+3) = 105 \\
% & \Longleftrightarrow 5x+20 + 15x+9 = 105 \\
% & \Longleftrightarrow 20x+29 = 105
% \Arrow{$-29$}\\
% & \Longleftrightarrow 20x = 76
% \Arrow{$\div 20$}\\
% & \Longleftrightarrow x = \frac{38}{10}
% \end{WithArrows}
% \end{Verbatim}
%
%
% \[\begin{WithArrows}[ll,interline=5mm,xoffset=5mm,
% TikzCode = {\draw[rounded corners,
% every node/.style = {circle,
% draw,
% auto = false,
% inner sep = 1pt,
% fill = gray!50,
% font = \tiny}]
% let \p1 = (#1),
% \p2 = (#2)
% in \ifdim \x1 > \x2
% (\p1) -- node {#3} (\x1,\y2) -- (\p2)
% \else
% (\p1) -- (\x2,\y1) -- node {#3} (\p2)
% \fi ;}]
% E & \Longleftrightarrow \frac{(x+4)}3 + \frac{5x+3}5 = 7
% \Arrow{$\times 15$}\\
% & \Longleftrightarrow 5(x+4) + 3(5x+3) = 105 \\
% & \Longleftrightarrow 5x+20 + 15x+9 = 105 \\
% & \Longleftrightarrow 20x+29 = 105
% \Arrow{$-29$}\\
% & \Longleftrightarrow 20x = 76
% \Arrow{$\div 20$}\\
% & \Longleftrightarrow x = \frac{38}{10}
% \end{WithArrows}\]
%
%
%
% \subsection{Automatic numbered loop}
%
% Assume we want to draw a loop of numbered arrows. In this purpose, it's possible to write a dedicated command
% |\NumberedLoop| which will do the job when used in |CodeAfter|. In the following example, we write this command
% with |\NewDocumentCommand| of \pkg{xparse} and |\foreach| of \pkg{pgffor} (both packages are loaded when
% \pkg{witharrows} is loaded).
%
% \begin{Verbatim}
% \NewDocumentCommand \NumberedLoop {}
% {\foreach \j in {2,...,\NbLines}
% { \pgfmathtruncatemacro{\i}{\j-1}
% \Arrow[rr]{\i}{\j}{\i} }
% \Arrow[rr,xoffset=1cm,tikz=<-]{1}{\NbLines}{\NbLines}}
% \end{Verbatim}
%
% The command |\NbLines| is a command available in |CodeAfter| which gives the total number of lines (=rows) of the
% current environment (it's a command and not a counter).
%
%
% \bigskip
% \begin{Verbatim}
% $\begin{WithArrows}[~emphase#CodeAfter = {\NumberedLoop}@]
% a.\;& f \text{ est continuous on } E \\
% b.\;& f \text{ est continuous in } 0 \\
% c.\;& f \text{ is bounded on the unit sphere} \\
% d.\;& \exists K > 0\quad \forall x \in E\quad \|f(x)\| \le K \|x\| \\
% e.\;& f \text{ is lipschitzian}
% \end{WithArrows}$
% \end{Verbatim}
%
% \bigskip
% \begin{scope}
% \NewDocumentCommand \NumberedLoop {}
% {\foreach \j in {2,...,\NbLines}
% { \pgfmathtruncatemacro{\i}{\j-1}
% \Arrow[rr]{\i}{\j}{\i} }
% \Arrow[rr,xoffset=1cm,tikz=<-]{1}{\NbLines}{\NbLines}}
%
%
% $\begin{WithArrows}[CodeAfter = {\NumberedLoop}]
% a.\;& f \text{ est continuous on } E \\
% b.\;& f \text{ est continuous in } 0 \\
% c.\;& f \text{ is bounded on the unit sphere} \\
% d.\;& \exists K > 0\quad \forall x \in E\quad \|f(x)\| \le K \|x\| \\
% e.\;& f \text{ is lipschitzian}
% \end{WithArrows}$
%
%
% \bigskip
% As usual, it's possible to change the characteristic of both arrows and nodes with the option |tikz|. However, if
% we want to change the style to have, for example, numbers in parenthesis, the best way is to change the value
% of |TikzCode|:
%
% \begin{Verbatim}
% TikzCode = {\draw (~#1) to node {\footnotesize (~#3)} (~#2) ;}
% \end{Verbatim}
%
% \WithArrowsOptions{TikzCode = {\draw (#1) to node {\footnotesize (#3)} (#2) ;}}
%
% $\begin{WithArrows}[CodeAfter = {\NumberedLoop}]
% a.\;& f \text{ est continuous on } E \\
% b.\;& f \text{ est continuous in } 0 \\
% c.\;& f \text{ is bounded on the unit sphere} \\
% d.\;& \exists K > 0\quad \forall x \in E\quad \|f(x)\| \le K \|x\| \\
% e.\;& f \text{ is lipschitzian} \\
% \end{WithArrows}$
%
% \end{scope}
%
% \section{Implementation}
%
% \subsection{Declaration of the package and extensions loaded}
%
%
% First, \pkg{tikz} and some Tikz libraries are loaded before the |\ProvidesExplPackage|.
% They are loaded this way because |\usetikzlibrary| in |expl3| code fails.\footnote{cf.
% |tex.stackexchange.com/questions/57424/using-of-usetikzlibrary-in-an-expl3-package-fails|}
%
% \begin{macrocode}
\RequirePackage{tikz}
\usetikzlibrary{arrows.meta,bending}
% \end{macrocode}
%
% \bigskip
% Then, we can give the traditional declaration of a package written with |expl3|:
% \begin{macrocode}
\RequirePackage{l3keys2e}
\ProvidesExplPackage
{witharrows}
{\myfiledate}
{\myfileversion}
{Draws arrows for explanations on the right}
% \end{macrocode}
%
% \bigskip
% The package \pkg{xparse} will be used to define the environments |{WithArrows}|, |{DispWithArrows}|,
% |{DispWithArrows*}| and the document-level commands |\Arrow| and |\WithArrowsOptions|.
% \begin{macrocode}
\RequirePackage{xparse}
% \end{macrocode}
%
% \bigskip
% \subsection{The packages footnote and footnotehyper}
%
% A few options can be given to the package \pkg{witharrows} when it is loaded (with |\usepackage|,
% |\RequirePackage| or |\PassOptionsToPackage|). Currently (version \myfileversion), there are two such options:
% |footnote| and |footnotehyper|. With the option |footnote|, \pkg{witharrows} loads \pkg{footnote} and uses it to
% extract the footnotes from the environments |{WithArrows}|. Idem for the option |footnotehyper|.
%
% \medskip
% The boolean |\g_@@_footnotehyper_bool| will indicate if the option |footnotehyper| is used.
% \begin{macrocode}
\bool_new:N \g_@@_footnotehyper_bool
% \end{macrocode}
%
% \medskip
% The boolean |\g_@@_footnote_bool| will indicate if the option |footnote| is used, but quicky, it will also be set
% to |true| if the option |footnotehyper| is used.
% \begin{macrocode}
\bool_new:N \g_@@_footnote_bool
% \end{macrocode}
%
% \medskip
% We define a set of keys |WithArrows/package| for these options. However, first, we define a ``level of options''
% |\l_@@_level_int| even if, in the version \myfileversion{} of \pkg{witharrows}, this integer is not used by the
% options of the set |WithArrows/package|.
% \begin{macrocode}
\int_new:N \l_@@_level_int
% \end{macrocode}
%
% \begin{macrocode}
\keys_define:nn {WithArrows/package}
{footnote .bool_gset:N = \g_@@_footnote_bool,
footnotehyper .bool_gset:N = \g_@@_footnotehyper_bool}
% \end{macrocode}
%
% \bigskip
% We process the options when the package is loaded (with |\usepackage|).
% \begin{macrocode}
\ProcessKeysOptions {WithArrows/package}
% \end{macrocode}
%
% \medskip
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Option~incompatible~with~Beamer}
{The~option~"\tl_use:N \l_keys_key_tl"\ is~incompatible~
with~Beamer~because~Beamer~has~its~own~system~to~extract~footnotes.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{footnote~with~footnotehyper~package}
{You~can't~use~the~option~footnote~because~the~package~
footnotehyper~has~already~been~loaded.~
If~you~want,~you~can~use~the~option~"footnotehyper"~and~the~footnotes~
within~the~environments~{WithArrows}~will~be~extracted~with~the~tools~
of~the~package~footnotehyper.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{footnotehyper~with~footnote~package}
{You~can't~use~the~option~"footnotehyper"~because~the~package~
footnote~has~already~been~loaded.~
If~you~want,~you~can~use~the~option~"footnote"~and~the~footnotes~
within~the~environments~{WithArrows}~will~be~extracted~with~the~tools~
of~the~package~footnote.}
% \end{macrocode}
%
% \medskip
% \begin{macrocode}
\bool_if:NT \g_@@_footnote_bool
{\@ifclassloaded {beamer}
{\msg_fatal:nn {witharrows}
{Option~incompatible~with~Beamer}}
{}
\@ifpackageloaded{footnotehyper}
{\msg_fatal:nn {witharrows}
{footnote~with~footnotehyper~package}}
{}
\usepackage{footnote}}
% \end{macrocode}
%
% \begin{macrocode}
\bool_if:NT \g_@@_footnotehyper_bool
{\@ifclassloaded {beamer}
{\msg_fatal:nn {witharrows}
{Option~incompatible~with~Beamer}}
{}
\@ifpackageloaded{footnote}
{\msg_fatal:nn {witharrows}
{footnotehyper~with~footnote~package}}
{}
\usepackage{footnotehyper}
\bool_gset_true:N \g_@@_footnote_bool}
% \end{macrocode}
% The flag |\g_@@_footnote_bool| is raised and so, we will only have to test |\g_@@_footnote_bool| in order to
% known if we have to insert an environnement |{savenotes}| (the |\begin{savenotes}| is in |\@@_pre_environment:n|
% and |\end{savenotes}| in |\@@_post_environment:| which are executed at the beginning and at the end of the
% environments |{WithArrows}| and |{DispWithArrows}|).
%
% \bigskip
% \subsection{Some technical definitions}
%
% We create booleans in order to known if some packages are loaded. For example, for the package \pkg{amsmath},
% the boolean is called |\c_@@_amsmath_loaded_bool|.\footnote{It's not possible to use |\@ifpackageloaded| in the
% core of the functions because |\@ifpackageloaded| is available only in the preamble.}
% \begin{macrocode}
\AtBeginDocument{\clist_map_inline:nn
{amsmath,mathtools,autonum,cleveref,hyperref,typedref}
{\bool_new:c {c_@@_#1_loaded_bool}
\@ifpackageloaded {#1}
{\bool_set_true:c {c_@@_#1_loaded_bool}}
{}}}
% \end{macrocode}
%
% We define a Tikz style |@@_node_style| for the nodes that will be created in the |\halign|. The nodes are Tikz
% nodes of shape ``rectangle'' but with zero width. An arrow between two nodes starts from the \emph{south} anchor
% of the first node and arrives at the \emph{north} anchor of the second node.
% \begin{macrocode}
\tikzset{@@_node_style/.style= {
above = \l_@@_ystart_dim,
inner~sep = 0 pt,
minimum~width = 0pt,
minimum~height = \l_@@_ygap_dim,
red,
\bool_if:NT \l_@@_shownodes_bool {draw} }}
% \end{macrocode}
% The color of the nodes is red, but in fact, the nodes will be drawn only when the option |shownodes| is used
% (this option is useful for debugging).
%
%
% \bigskip
% The style |@@_standard| is load in standard in the |{tikzpicture}| we need. The names of the nodes are prefixed by
% |wa| (by security) but also by a prefix which is the position-in-the-tree of the nested environments.
% \begin{macrocode}
\tikzset{@@_standard/.style= { remember~picture,
overlay,
name~prefix = wa-\l_@@_prefix_str- }}
% \end{macrocode}
%
% \bigskip
% We also define a style for the tips of arrow. The final user of the extension \pkg{witharrows} will use this
% style if he wants to draw an arrow directly with a Tikz command in his document (probably using the Tikz nodes
% created by |{WithArrows}| in the |\halign|).
% \begin{macrocode}
\tikzset{WithArrows/arrow/tips/.style = { > = {Straight~Barb[scale=1.2,bend]} }}
% \end{macrocode}
%
% \bigskip
% \begin{macrocode}
\tikzset{WithArrows/arrow/.style = { align = left,
auto = left,
font = {\small\itshape},
WithArrows/arrow/tips,
bend~left = 45,
-> }}
% \end{macrocode}
%
% \bigskip
% In order to increase the interline in the environments |{WithArrows}|, we will use the command |\spread@equation|
% of \pkg{amsmath}. When used, this command becomes no-op (in the current TeX group). Therefore, it will be
% possible to use the environments of \pkg{amsmath} (e.g. |{aligned}|) in an environment |{WithArrows}|.
%
% Nevertheless, we want the extension \pkg{witharrows} available without \pkg{amsmath}. That's why we give a
% definition of |\spread@equation| if \pkg{amsmath} is not loaded (you put the code in a |\AtBeginDocument| because
% the flag |\c_@@_amsmath_loaded_bool| is itself set in a |\AtBeginDocument|).
% \begin{macrocode}
\AtBeginDocument
{\bool_if:NF \c_@@_amsmath_loaded_bool
{\cs_set_protected:Npn \spread@equation
{\openup\jot
\cs_set_protected:Npn \spread@equation {}}}}
% \end{macrocode}
% Don't put |\cs_set_eq:NN \spread@equation \prog_do_nothing:| in the last line because this would raise errors
% with nested environments.
%
%
% \bigskip
% \subsection{Variables}
%
%
% The boolean |\l_@@_in_witharrows_bool| will be raised if (and only if) we are in an environment |{WithArrows}|
% (and not in an environment |{DispWithArrows}| or |{DispWithArrows*}|).
% \begin{macrocode}
\bool_new:N \l_@@_in_witharrows_bool
% \end{macrocode}
%
% The following sequence is the position of the last environment |{WithArrows}| in the tree of the nested
% environments |{WithArrows}|.
% \begin{macrocode}
\seq_new:N \g_@@_position_in_the_tree_seq
\seq_gput_right:Nn \g_@@_position_in_the_tree_seq 1
% \end{macrocode}
%
% \bigskip
% The following counter will give the number of the last environment |{WithArrows}| of level~$0$. This
% counter will be used only in the definition of |\WithArrowsLastEnv|.
% \begin{macrocode}
\int_new:N \g_@@_last_env_int
% \end{macrocode}
%
% \bigskip
% The following skip (=glue) is the vertical space inserted between two lines (=rows) of the |\halign|.
% \begin{macrocode}
\skip_new:N \l_@@_interline_skip
% \end{macrocode}
%
% \bigskip
% The following integer indicates the position of the box that will be created: 0 (=|t|=|\vtop|), 1~(=|c|=|\vcenter|) or 2 (=|b|=|\vbox|).
% \begin{macrocode}
\int_new:N \l_@@_pos_env_int
% \end{macrocode}
%
% \bigskip
% \begin{macrocode}
\dim_new:N \l_@@_xoffset_dim
\dim_set:Nn \l_@@_xoffset_dim {3mm}
% \end{macrocode}
%
% \bigskip
% The integer |\l_@@_pos_arrows_int| indicates the position of the arrows with the following code (the option |v|
% is accessible only for the arrows in |CodeAfter| where the options |i|, |group| et |groups| are not available).
%
% \begin{center}
% \begin{tabular}{l}
% \begin{tabular}{@{}l*8c@{}}
% \toprule
% option & |rr| & |ll| & |rl| & |lr| & |v| & |i| & |group| & |groups| \\
% \midrule
% |\l_@@_pos_arrows_int| & $0$ & $1$ & $2$ & $3$ & $4$ & $5$ & $6$ & $7$ \\
% \bottomrule
% \end{tabular} \\
% \footnotesize The option |v| can be used only in |\Arrow| in |CodeAfter| (see below).
% \end{tabular}
% \end{center}
%
% \begin{macrocode}
\int_new:N \l_@@_pos_arrows_int
% \end{macrocode}
%
% \medskip
% When we scan a list of options, we want to be able to raise an error if two options of position of the arrows
% are present. That's why we keep the code of the first option of position in a variable called
% |\l_@@_previous_pos_arrows_int|. This variable will be set to $-1$ each time we start the scanning of a list of options.
%
% \begin{macrocode}
\int_new:N \l_@@_previous_pos_arrows_int
% \end{macrocode}
%
% \bigskip
%
% At each possible level for the options (\emph{global}, \emph{environment} or \emph{local}: see below), the new
% values will be appended on the right of this token list.
%
% \bigskip
% The dimension |\g_@@_x_dim| will be used to compute the $x$-value for some vertical arrows when one of the
% options |i|, |group| and |groups| (values 5, 6 and 7 of |\l_@@_pos_arrows_int|) is used.
% \begin{macrocode}
\dim_new:N \g_@@_x_dim
% \end{macrocode}
%
% \bigskip
% In the |\halign| of an environment |{WithArrows}|, we will have to use three counters:
% \begin{itemize}
% \item |\g_@@_arrow_int| to count the arrows created in the environment ;
% \item |\g_@@_line_int| to count the lines of the |\halign| ;
% \item |\g_@@_line_bis_int| to count the lines of the |\halign| which have a second column.\footnote{This counter
% is used in order to raise an error if there is a line without the second column (such an situation could raise a
% \textsc{pgf} error for an undefined node).}
% \end{itemize}
%
% These three counters will be incremented in a cell of the |\halign| and, therefore, the incrementation must be
% global. However, we want to be able to include a |{WithArrows}| in another |{WithArrows}|. To do so, we must
% restore the previous value of these counters at the end of an environment |{WithArrows}| and we decide to manage
% a stack for each of these counters.
% \begin{macrocode}
\seq_new:N \g_@@_arrow_int_seq
\int_new:N \g_@@_arrow_int
\seq_new:N \g_@@_line_int_seq
\int_new:N \g_@@_line_int
\seq_new:N \g_@@_line_bis_int_seq
\int_new:N \g_@@_line_bis_int
% \end{macrocode}
%
% \bigskip
% The token list |\l_@@_name_tl| will contain the name of the environment (given with the option |name|). This name
% will be used to create aliases for the names of the nodes.
% \begin{macrocode}
\tl_new:N \l_@@_name_tl
% \end{macrocode}
%
% \bigskip
% The boolean |\l_@@_notag_bool| will be used in |{DispWithArrows}|. In particular, it will be raised when the
% command |\notag| is used.
% \begin{macrocode}
\bool_new:N \l_@@_notag_bool
% \end{macrocode}
%
% \bigskip
% The token list |\l_@@_tag_tl| will contain the argument of the command |\tag|.
% \begin{macrocode}
\tl_new:N \l_@@_tag_tl
% \end{macrocode}
%
% \bigskip
% The boolean |\l_@@_tag_star_bool| will be raised if the user uses the command |\tag| with a star.
% \begin{macrocode}
\bool_new:N \l_@@_tag_star_bool
% \end{macrocode}
%
% \bigskip
% The command |\@@_label:n| will be linked to |\label| in the second column of the |\halign| of the environment
% |{DispWithArrows}|. It's possible to put several labels for the same line (it's not possible in the environments
% of \pkg{amsmath}). That's why we store the differents labels of a same line in a sequence |\l_@@_labels_seq|.
% \begin{macrocode}
\seq_new:N \l_@@_labels_seq
\cs_set:Nn \@@_label:n {\seq_if_empty:NF \l_@@_labels_seq
{\msg_error:nn {witharrows} {Multiple~labels}}
\seq_put_right:Nn \l_@@_labels_seq {#1}
% \end{macrocode}
%
% \begin{macrocode}
\bool_if:nT \c_@@_mathtools_loaded_bool
{\MH_if_boolean:nT {show_only_refs}
{\cs_if_exist:cTF {MT_r_#1}
{\bool_set_false:N \l_@@_notag_bool}
{\bool_set_true:N \l_@@_notag_bool}}}
\bool_if:nT \c_@@_autonum_loaded_bool
{\cs_if_exist:cTF {autonum@#1Referenced}
{\bool_set_false:N \l_@@_notag_bool}
{\bool_set_true:N \l_@@_notag_bool}}}
% \end{macrocode}
%
%
% \bigskip
% The boolean |\l_@@_fleqn_bool| indicates wether the environments |{DispWithArrows}| must be composed flush left or
% centered. It corresponds to the option |fleqn|.
% \begin{macrocode}
\bool_new:N \l_@@_fleqn_bool
% \end{macrocode}
%
% \bigskip
% The dimension |\l_@@_mathindent_dim| is used only by the environments |{DispWithArrows}|: it's the left margin of
% the environments |{DispWithArrows}| if the environment |{DispWithArrows}| is composed flush left (option |fleqn|).
% \begin{macrocode}
\dim_new:N \l_@@_mathindent_dim
\dim_set:Nn \l_@@_mathindent_dim {25pt}
% \end{macrocode}
%
% \bigskip
% The boolean |\l_@@_wrap_lines_bool| corresponds to the option |wrap-lines|.
% \begin{macrocode}
\bool_new:N \l_@@_wrap_lines_bool
% \end{macrocode}
%
% \bigskip
% \subsection{The definition of the options}
%
% There are four levels where options can be set:
% \begin{itemize}
% \item with |\usepackage[...]{witharrows}|: this level will be called \emph{package} level (number~$0$);
% \item with |\WithArrowsOptions{...}|: this level will be called \emph{global} level (number~$1$);
% \item with |\begin{WithArrows}[...]|: this level will be called \emph{environment} level (number~$2$);
% \item with |\Arrow[...]| (included in |CodeAfter|): this level will be called \emph{local} level (number~$3$).
% \end{itemize}
%
% \bigskip
% The level is specified in the variable |\l_@@_level_int| and the code attached to the options can use this
% information to alter its actions.
%
% \medskip
% \begin{macrocode}
\int_set:Nn \l_@@_level_int 1
% \end{macrocode}
%
% \bigskip
% We start with a submodule which will be loaded only at the global or the environment level.
%
% \medskip
% The options |t|, |c| and |b| indicate if we will create a |\vtop|, a |\vcenter| or a |\vbox|. This information is
% stored in the variable |\l_@@_pos_env_int|. Of course, they are available only in |{WithArrows}| and not in
% |{DispWithArrows}| or |{DispWithArrows*}|
% \begin{macrocode}
\keys_define:nn {WithArrows/GlobalOrEnv}
{ t .code:n = {\bool_if:NTF \l_@@_in_witharrows_bool
{\int_set:Nn \l_@@_pos_env_int 0}
{\msg_error:nn {witharrows} {Option~will~be~ignored}}},
t .value_forbidden:n = true,
c .code:n = {\bool_if:NTF \l_@@_in_witharrows_bool
{\int_set:Nn \l_@@_pos_env_int 1}
{\msg_error:nn {witharrows} {Option~will~be~ignored}}},
c .value_forbidden:n = true,
b .code:n = {\bool_if:NTF \l_@@_in_witharrows_bool
{\int_set:Nn \l_@@_pos_env_int 2}
{\msg_error:nn {witharrows} {Option~will~be~ignored}}},
b .value_forbidden:n = true,
% \end{macrocode}
%
% \bigskip
% The gap between two consecutive arrows.
% \begin{macrocode}
ygap .dim_set:N = \l_@@_ygap_dim,
ygap .value_required:n = true,
ygap .initial:n = 0.4 ex,
% \end{macrocode}
%
% \bigskip
% The vertical position of the start point of an arrow.
% \begin{macrocode}
ystart .dim_set:N = \l_@@_ystart_dim,
ystart .value_required:n = true,
ystart .initial:n = 0.4 ex,
% \end{macrocode}
%
% \bigskip
% Usually, the number of columns in a |{WithArrows}| environment is limited to 2. Nevertheless, it's possible to
% have more columns with the option |MoreColumns|.
% \begin{macrocode}
MoreColumns .code:n = { \msg_redirect_name:nnn
{witharrows}
{Third~column~in~an~environment~{WithArrows}}
{none} },
MoreColumns .value_forbidden:n = true,
% \end{macrocode}
%
%
% \bigskip
% By default, an error message is raised if there is a line without ampersand (|&|). However, it's possible to
% suppress this error with the option |AllowLineWithoutAmpersand|.
% \begin{macrocode}
AllowLineWithoutAmpersand .code:n = { \msg_redirect_name:nnn
{witharrows}
{All~lines~must~have~an~ampersand}
{none} },
AllowLineWithoutAmpersand .value_forbidden:n = true,
% \end{macrocode}
%
% \bigskip
% If the user wants to give a new name to the |\Arrow| command (and the name |\Arrow| remains free).
% \begin{macrocode}
CommandName .tl_set:N = \l_@@_CommandName_tl,
CommandName .initial:n = Arrow ,
CommandName .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% \begin{macrocode}
TikzCode .tl_set:N = \l_@@_tikz_code_tl,
TikzCode .initial:n = \draw~(#1)~to~node{#3}~(#2)~; ,
TikzCode .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% With the option |displaystyle|, the environments will be composed in |\displaystyle|.
% \begin{macrocode}
displaystyle .bool_set:N = \l_@@_displaystyle_bool,
displaystyle .initial:n = false,
% \end{macrocode}
%
% \bigskip
% With the option |shownodes|, the nodes will be drawn in red (useful only for debugging).
% \begin{macrocode}
shownodes .bool_set:N = \l_@@_shownodes_bool,
shownodes .initial:n = false,
% \end{macrocode}
%
% \bigskip
% With the option |shownodenames|, the name of the ``right nodes'' will be written in the document (useful only
% for debugging).
% \begin{macrocode}
shownodenames .bool_set:N = \l_@@_shownodenames_bool,
shownodenames .initial:n = false,
% \end{macrocode}
%
% \bigskip
% With the option |group|, \emph{all} the arrows of the environment are vertical with the same abscissa and at a
% leftmost position.
% \begin{macrocode}
group .code:n = {\int_compare:nNnT \l_@@_previous_pos_arrows_int > {-1}
{\msg_error:nn {witharrows}
{Two~options~are~incompatible}}
\int_set:Nn \l_@@_previous_pos_arrows_int 6
\int_set:Nn \l_@@_pos_arrows_int 6} ,
group .value_forbidden:n = true,
% \end{macrocode}
%
% \bigskip
% With the option |groups| (with a \emph{s}), the arrows of the environment are divided in groups by an argument of
% connexity, and, in each group, the arrows are vertical with the same abscissa and at a leftmost position. When
% the option |group| or |groups| is used, it's not possible to another option of position like |ll|, |lr|, etc.
% for a individual key.
% \begin{macrocode}
groups .code:n = {\int_compare:nNnT \l_@@_previous_pos_arrows_int > {-1}
{\msg_error:nn {witharrows}
{Two~options~are~incompatible}}
\int_set:Nn \l_@@_previous_pos_arrows_int 7
\int_set:Nn \l_@@_pos_arrows_int 7} ,
groups .value_forbidden:n = true,
% \end{macrocode}
%
% \bigskip
% The option |CodeBefore| gives a code that is executed at the beginning of the environment |{WithArrows}| (after
% the eventual |\begin{savenotes}|).
% \begin{macrocode}
CodeBefore .code:n = {\int_compare:nNnTF \l_@@_level_int = 1
{\msg_error:nn {witharrows} {Option~will~be~ignored}}
{\tl_put_right:Nn \l_@@_code_before_tl {#1}}} ,
CodeBefore .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% The option |CodeAfter| gives a code that is executed at the end of the environment |{WithArrows}| (after the
% eventual |\end{savenotes}|).
% \begin{macrocode}
CodeAfter .code:n = {\int_compare:nNnTF \l_@@_level_int = 1
{\msg_error:nn {witharrows} {Option~will~be~ignored}}
{\tl_put_right:Nn \l_@@_code_after_tl {#1}}} ,
CodeAfter .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% The option |name| is a name given to the environment. If this option is used, the nodes created in the
% environment will have aliases constructed with this name (and it will be easier to use these nodes from outside
% the environment).
% \begin{macrocode}
name .code:n = {\int_compare:nNnTF \l_@@_level_int = 1
{\msg_error:nn {witharrows} {Option~will~be~ignored}}
{\tl_set:Nn \l_@@_name_tl {#1}}} ,
name .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% The option |fleqn| indicates wether the environments |{DispWithArrows}| are composed centered or flush left.
% \begin{macrocode}
fleqn .code:n = {\bool_if:NTF \l_@@_in_witharrows_bool
{\msg_error:nn {witharrows} {Option~will~be~ignored}}
{\tl_if_eq:nnTF {#1} {true}
{\bool_set_true:N \l_@@_fleqn_bool}
{\bool_set_false:N \l_@@_fleqn_bool}}},
fleqn .default:n = true,
% \end{macrocode}
%
% \bigskip
% The option |mathindent| is the left margin of the environments |{DispWithArrows}| when the option |fleqn| is used.
% \begin{macrocode}
mathindent .code:n = {\bool_if:NTF \l_@@_in_witharrows_bool
{\msg_error:nn {witharrows} {Option~will~be~ignored}}
{\dim_set:Nn \l_@@_mathindent_dim {#1}}},
mathindent .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% The option |notag| indicates wether the environments |{DispWithArrows}| will be without tags (like |{DispWithArrows*}|).
% \begin{macrocode}
notag .code:n = {\bool_if:NTF \l_@@_in_witharrows_bool
{\msg_error:nn {witharrows} {Option~will~be~ignored}}
{\tl_if_eq:nnTF {#1} {true}
{\bool_set_true:N \l_@@_notag_bool}
{\bool_set_false:N \l_@@_notag_bool}}},
notag .default:n = true,
nonumber .meta:n = notag,
% \end{macrocode}
%
% \bigskip
% The option |AllowMultipleLabels| indicates wether multiple labels are allowed for the same line of an environment
% |{DispWithArrows}| or |{DispWithArrows*}|.
% \begin{macrocode}
AllowMultipleLabels .code:n = {\bool_if:NTF \l_@@_in_witharrows_bool
{\msg_error:nn {witharrows} {Option~will~be~ignored}}
{\msg_redirect_name:nnn {witharrows}
{Multiple~labels}
{none}}},
AllowMultipleLabels .value_forbidden:n = true,
% \begin{macrocode}
%
% \bigskip
% With the option |wrap-lines|, a special |TikzCode| is used in the environments |{DispWithArrows}| and
% |{DispWithArrows*}| and, with this |TikzCode|, the lines of the labels are automaticly wrapped on the right.
% \begin{macrocode}
wrap-lines .code:n = {\bool_if:NTF \l_@@_in_witharrows_bool
{\msg_error:nn {witharrows} {Option~will~be~ignored}}
{\tl_if_eq:nnTF {#1} {true}
{\bool_set_true:N \l_@@_wrap_lines_bool}
{\bool_set_false:N \l_@@_wrap_lines_bool}}},
wrap-lines .default:n = true,
% \end{macrocode}
% \begin{macrocode}
unknown .code:n = \msg_error:nn {witharrows} {Option~unknown}
}
% \end{macrocode}
%
%
% \bigskip
% Then we define the main module called |WithArrows/General| which will be loaded at all the levels.
%
% \medskip
% The option |tikz| gives Tikz parameters that will be given to the arrow when it is drawn (more precisely, the
% parameters will be given to the command |\path| of Tikz).
% \begin{macrocode}
\keys_define:nn {WithArrows/General}
{tikz .code:n = \tikzset {WithArrows/arrow/.append~style = {#1}},
tikz .initial:n = {},
tikz .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% The other options are for the position of the arrows. The treatment is the same for the options |ll|, |rr|, |lr|,
% |lr| and |i| and that's why a dedicated fonction |\@@_analyze_option_position:n| has been written (see below).
% \begin{macrocode}
rr .value_forbidden:n = true,
rr .code:n = \@@_analyze_option_position:n 0 ,
ll .value_forbidden:n = true,
ll .code:n = \@@_analyze_option_position:n 1 ,
rl .value_forbidden:n = true,
rl .code:n = \@@_analyze_option_position:n 2 ,
lr .value_forbidden:n = true,
lr .code:n = \@@_analyze_option_position:n 3 ,
i .value_forbidden:n = true,
i .code:n = \@@_analyze_option_position:n 5 ,
% \end{macrocode}
%
% \bigskip
% The option |xoffset| change the $x$-offset of the arrows (towards the right). It's a dimension and not a skip.
% It's not possible to change the value of this parameter for a individual arrow if the option |group| or the
% option |groups| is used. When we will treat an individual arrow, we will give it the option
% |tikz={xshift=\l_@@_xoffset_dim}| (we can't to it at the global or the environment level because the Tikz options
% |xshift| are cumulative.
%
% \begin{macrocode}
xoffset .code:n = {\bool_if:nTF {\int_compare_p:nNn \l_@@_level_int = 3 &&
\int_compare_p:nNn \l_@@_pos_arrows_int > 5}
{\msg_error:nn {witharrows}
{Option~incompatible~with~"group(s)"}}
{\dim_set:Nn \l_@@_xoffset_dim {#1}}} ,
xoffset .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% The option |jot| exists for compatibility. It changes directly the value of the parameter |\jot|, which is a
% LaTeX parameter and not a parameter specific to \pkg{witharrows}. It's allowed only at the level of the
% environment (maybe we should suppress completely this option in the future).
% \begin{macrocode}
jot .code:n = {\int_compare:nNnTF \l_@@_level_int = 2
{\dim_set:Nn \jot {#1}}
{\msg_error:nn {witharrows}
{Option~will~be~ignored}}} ,
jot .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% The option |interline| gives the vertical skip (=glue) inserted between two lines (independently of |\jot|). It's
% accepted only at the level of the environment (this last point is a kind of security). Futhermore, this option has a
% particular behaviour: it applies only to the current environment and doesn't apply to the nested environments.
% \begin{macrocode}
interline .code:n = {\int_compare:nNnTF \l_@@_level_int = 2
{\skip_set:Nn \l_@@_interline_skip {#1}}
{\msg_error:nn {witharrows}
{Option~will~be~ignored}}} ,
interline .value_required:n = true,
% \end{macrocode}
%
% \bigskip
% Eventually, a key |jump| (see below) and a key for unknown keys.
% \begin{macrocode}
jump .code:n = \msg_error:nn {witharrows} {Option~will~be~ignored} ,
unknown .code:n = \msg_error:nn {witharrows} {Option~unknown}
}
% \end{macrocode}
%
% \bigskip
% The key |jump| indicates the number of lines jumped by the arrow (1 by default). This key will be extracted when
% the command |\Arrow| will be executed. That's why there is a special module for this key. The key |jump| is
% extracted in the command |\Arrow| because we want to compute right away the final line of the arrow (this will be
% useful for the options |group| and |groups|).
% \begin{macrocode}
\keys_define:nn {WithArrows/jump}
{jump .code:n = {\int_set:Nn \l_@@_jump_int {#1}
\int_compare:nNnF \l_@@_jump_int > 0
{\msg_error:nn {witharrows}
{The~option~"jump"~must~be~non~negative}}} ,
jump .value_required:n = true}
% \end{macrocode}
%
% \bigskip
% The following command is for technical reasons. It's used for the following options of position: |ll|,
% |lr|, |rl|, |rr| and |i|. The argument is the corresponding code for the position of the arrows.
% \begin{macrocode}
\cs_new_protected:Nn \@@_analyze_option_position:n
{\int_compare:nNnT \l_@@_previous_pos_arrows_int > {-1}
{\msg_error:nn {witharrows}
{Two~options~are~incompatible}}
\int_set:Nn \l_@@_previous_pos_arrows_int {#1}
% \end{macrocode}
%
% It's not possible to use one of the considered options at the level of an arrow (level~2) when the option |group|
% or the option |groups| is used. However, if we are at the level of an environment, it's possible to override a
% previous option |group| or |groups| (this previous option |group| or |groups| would necessarily have been set at
% a global level by |\WithArrowsOptions|).
% \begin{macrocode}
\bool_if:nTF { \int_compare_p:nNn \l_@@_level_int = 3 &&
\int_compare_p:nNn \l_@@_pos_arrows_int > 5}
{\msg_error:nn {witharrows}
{Option~incompatible~with~"group(s)"}}
{\int_set:Nn \l_@@_pos_arrows_int {#1}}}
% \end{macrocode}
%
%
% \bigskip
% |\WithArrowsOptions| is the command of the \pkg{witharrows} package to fix options at the document level.
% \begin{macrocode}
\NewDocumentCommand \WithArrowsOptions {m}
{\int_set:Nn \l_@@_previous_pos_arrows_int {-1}
\keys_set_known:nnN {WithArrows/General} {#1} \l_tmpa_tl
\keys_set:nV {WithArrows/GlobalOrEnv} \l_tmpa_tl}
% \end{macrocode}
%
%
% \bigskip
% \subsection{The command Arrow}
%
% In fact, the internal command is not named |\Arrow| but |\@@_Arrow|. Usually, at the beginning of an environment
% |{WithArrows}|, |\Arrow| is set to be equivalent to |\@@_Arrow|. However, the user can change the name with the
% option |CommandName| and the user command for |\@@_Arrow| will be different. This mechanism can be useful when
% the user has already a command named |\Arrow| he wants to still be able to use in the environment |{WithArrows}|.
%
% \medskip
% \begin{macrocode}
\NewDocumentCommand \@@_Arrow {O{} m O{}}
{
% \end{macrocode}
%
% The counter |\g_@@_arrow_int| counts the arrows in the environment. The incrementation must be global (|gincr|)
% because the command |\Arrow| will be used in the cell of a |\halign|. It's recalled that we manage a stack for
% this counter.
% \begin{macrocode}
\int_gincr:N \g_@@_arrow_int
% \end{macrocode}
%
% We decide to extract immediatly the key |jump| in order to compute the end line. That's the reason why there is a
% module |WithArrows/jump| with this sole key. The remainded key-value pairs are stored in |\l_tmpa_tl| and will be
% stored further in the properly list of the arrow.
% \begin{macrocode}
\int_zero_new:N \l_@@_jump_int
\int_set:Nn \l_@@_jump_int 1
\keys_set_known:nnN {WithArrows/jump} {#1,#3} \l_tmpa_tl
% \end{macrocode}
%
% \medskip
% We will construct a global property list to store the informations of the considered arrow. The four fields of
% this property list are ``initial'', ``final'', ``options'' and ``label''.
%
% \smallskip
% \begin{enumerate}
% \item First, the line from which the arrow starts:
% \begin{macrocode}
\prop_put:NnV \l_tmpa_prop {initial} \g_@@_line_int
% \end{macrocode}
%
% \item The line where the arrow ends (that's why it was necessary to extract the key |jump|):
% \begin{macrocode}
\int_set:Nn \l_tmpa_int {\g_@@_line_int + \l_@@_jump_int}
\prop_put:NnV \l_tmpa_prop {final} \l_tmpa_int
% \end{macrocode}
%
% \item All the options of the arrow (it's a token list):
% \begin{macrocode}
\prop_put:NnV \l_tmpa_prop {options} \l_tmpa_tl
% \end{macrocode}
%
% \item The label of the arrow (it's also a token list):
% \begin{macrocode}
\prop_put:Nnn \l_tmpa_prop {label} {#2}
% \end{macrocode}
% \end{enumerate}
%
% The property list has been created in a local variable for convenience. Now, it will be stored in a global
% variable indicating both the position-in-the-tree and the number of the arrow.
%
% \begin{macrocode}
\prop_gclear_new:c
{g_@@_arrow_\l_@@_prefix_str _\int_use:N\g_@@_arrow_int _prop}
\prop_gset_eq:cN
{g_@@_arrow_\l_@@_prefix_str _\int_use:N\g_@@_arrow_int _prop}
\l_tmpa_prop
}
% \end{macrocode}
%
% \medskip
% \begin{macrocode}
\cs_new_protected:Nn \@@_Arrow_first_column:
% \end{macrocode}
% All messages of LaTeX3 must be \emph{fully expandable} and that's why we do the affectation (necessary for a
% comparison) before the |\msg_error:nn|.
% \begin{macrocode}
{\tl_set:Nn \l_tmpa_tl {Arrow}
\msg_error:nn {witharrows} {Arrow~in~first~column}
\@@_Arrow}
% \end{macrocode}
%
%
% \bigskip
% \subsection{The environment \{WithArrows\}}
%
% The command |\@@_pre_environement:| is a code common to the environments |{WithArrows}| and |{DispWithArrows}|.
% The argument is the options given to the environment.
% \begin{macrocode}
\cs_new_protected:Nn \@@_pre_environment:n
% \end{macrocode}
%
% First the initialisation of the three counters |\g_@@_arrow_int|,
% |\g_@@_line_int| and |\g_@@_line_bis_int|. However, we have to save their previous values with the three stacks
% created for this end.
% \begin{macrocode}
{ \seq_gput_right:NV \g_@@_arrow_int_seq \g_@@_arrow_int
\int_gzero:N \g_@@_arrow_int
\seq_gput_right:NV \g_@@_line_int_seq \g_@@_line_int
\int_gzero:N \g_@@_line_int
\seq_gput_right:NV \g_@@_line_bis_int_seq \g_@@_line_bis_int
\int_gzero:N \g_@@_line_bis_int
% \end{macrocode}
%
% \bigskip
% We also have to update the position on the nesting tree.
% \begin{macrocode}
\seq_gput_right:Nn \g_@@_position_in_the_tree_seq 1
% \end{macrocode}
%
% The nesting tree is used to create a prefix which will be used in the names of the Tikz nodes and in the names of
% the arrows (each arrow is a property list of four fields). If we are in the second environment |{WithArrows}|
% nested in the third environment |{WithArrows}| of the document, the prefix will be |3-2| (although the position
% in the tree is $[3,2,1]$ since such a position always ends with a~$1$). First, we do a copy of the
% position-in-the-tree and then we pop the last element of this copy (in order to drop the last~$1$).
% \begin{macrocode}
\seq_set_eq:NN \l_tmpa_seq \g_@@_position_in_the_tree_seq
\seq_pop_right:NN \l_tmpa_seq \l_tmpa_tl
\str_clear_new:N \l_@@_prefix_str
\str_set:Nx \l_@@_prefix_str {\seq_use:Nnnn \l_tmpa_seq {-} {-} {-}}
% \end{macrocode}
%
% \bigskip
% We define the command |\\| to be the command |\@@_cr:| (defined below).
% \begin{macrocode}
\cs_set_eq:NN \\ \@@_cr:
\dim_zero:N \mathsurround
% \end{macrocode}
%
% \bigskip
% These counters will be used later as variables.
% \begin{macrocode}
\int_zero_new:N \l_@@_initial_int
\int_zero_new:N \l_@@_final_int
\int_zero_new:N \l_@@_arrow_int
% \end{macrocode}
%
% \bigskip
% The value corresponding to the key |interline| is put to zero before the treatment of the options of the
% environment.\footnote{It's recalled that, by design, the option |interline| of an environment doesn't apply
% in the nested environments.}
% \begin{macrocode}
\skip_zero:N \l_@@_interline_skip
% \end{macrocode}
%
% \bigskip
% The value corresponding to the key |CodeBefore| is put to nil before the treatment of the options of the
% environment, because, of course, we don't want the code executed at the beginning of all the nested
% environments~|{WithArrows}|. Idem for |CodeAfter|.
% \begin{macrocode}
\tl_clear_new:N \l_@@_code_before_tl
\tl_clear_new:N \l_@@_code_after_tl
% \end{macrocode}
% \bigskip
% We process the options given to the |{WithArrows}| environment. The level of options is set to 1.
% \begin{macrocode}
\int_set:Nn \l_@@_previous_pos_arrows_int {-1}
\int_set:Nn \l_@@_level_int 2
\keys_set_known:nnN {WithArrows/General} {#1} \l_tmpa_tl
\keys_set:nV {WithArrows/GlobalOrEnv} \l_tmpa_tl
% \end{macrocode}
%
% \bigskip
% If the option |footnote| or the option |footnotehyper| is used, then we extract the footnotes with an environment
% |{savenotes}| (of the package \pkg{footnote} or the package \pkg{footnotehyper}).
% \begin{macrocode}
\bool_if:NT \g_@@_footnote_bool {\begin{savenotes}}
% \end{macrocode}
%
% \bigskip
% We execute the code |\l_@@_code_before_tl| of the option |CodeBefore| of the environment after the eventual
% |\begin{savenotes}| and, symetricaly, we will execute the |\l_@@_code_after_tl| before the eventual
% |\end{savenotes}| (we have a good reason for the last point : we want to extract the footnotes of the arrows
% executed in the |CodeAfter|).
% \begin{macrocode}
\l_@@_code_before_tl
% \end{macrocode}
%
% \bigskip
% If the user has given a value for the option |CommandName| (at the global or at the \emph{environment} level), a
% command with this name is defined locally in the environment with meaning |\@@_Arrow|. The default value of the
% option |CommandName| is ``|Arrow|'' and thus, by default, the name of the command will be |\Arrow|.
% \begin{macrocode}
\cs_set_eq:cN \l_@@_CommandName_tl \@@_Arrow}
% \end{macrocode}
% This is the end of |\@@_pre_environment:n|.
%
%
% \bigskip
% Now, we begin the environment |{WithArrows}|.
% \begin{macrocode}
\NewDocumentEnvironment {WithArrows} {O{}}
{ \bool_set_true:N \l_@@_in_witharrows_bool
\reverse_if:N \if_mode_math:
\msg_error:nn {witharrows}
{{WithArrows}~used~outside~math~mode}
\fi:
\cs_set:Npn \notag {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{WithArrows}}
{\notag}}
\cs_set:Npn \nonumber {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{WithArrows}}
{\nonumber}}
\cs_set:Npn \tag ##1 {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{WithArrows}}
{\tag}}
\cs_set:Npn \label ##1 {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{WithArrows}}
{\label}}
\@@_pre_environment:n {#1}
% \end{macrocode}
% \bigskip
% The environment begins with a |\vtop|, a |\vcenter| or a |\vbox|\footnote{Notice that the use of
% |\vtop| seems color-safe here...} depending of the value of |\l_@@_pos_env_int| (fixed by the options
% |t|, |c| or |b|). The environment |{WithArrows}| must be used in math mode\footnote{An error is raised if the
% environment is used outside math mode.} and therefore, we can use |\vcenter|.
% \begin{macrocode}
\int_case:nn \l_@@_pos_env_int
{0 {\vtop}
1 {\vcenter}
2 {\vbox}}
\bgroup
% \end{macrocode}
%
% \bigskip
% The command |\spread@equation| is the command used by \pkg{amsmath} in the beginning of an alignment to fix the
% interline. When used, it becomes no-op. However, it's possible to use \pkg{witharrows} without \pkg{amsmath}
% since we have redefined |\spread@equation| (if it is not defined yet).
% \begin{macrocode}
\spread@equation
% \end{macrocode}
%
% \bigskip
% We begin the |\halign| and the preamble.
% \begin{macrocode}
\ialign\bgroup
% \end{macrocode}
%
% \bigskip
% We increment the counter |\g_@@_line_int| which will be used in the names of the Tikz nodes created in the array.
% This incrementation must be global (|gincr|) because we are in the cell of a |\halign|. It's recalled that we
% manage a stack for this counter.
% \begin{macrocode}
\int_gincr:N \g_@@_line_int
\cs_set_eq:cN \l_@@_CommandName_tl \@@_Arrow_first_column:
\strut\hfil
$\bool_if:NT \l_@@_displaystyle_bool \displaystyle {##}$
&
% \end{macrocode}
%
% \bigskip
% In the second column, we increment the counter |\g_@@_line_bis_int| because we want to count the lines with a
% second column and raise an error if there is lines without a second column. Once again, the incrementation must
% be global and it's recalled that we manage a stack for this counter too.
% \begin{macrocode}
\int_gincr:N \g_@@_line_bis_int
$\bool_if:NT \l_@@_displaystyle_bool \displaystyle {{}##}$
% \end{macrocode}
%
% \bigskip
% We create the ``left node'' of the line (when using macros in Tikz node names, the macros have to be fully
% expandable: here, |\tl_use:N| and |\int_use:N| are fully expandable).
% \begin{macrocode}
\tikz [remember~picture,overlay]
\node [@@_node_style,
name = wa-\l_@@_prefix_str-\int_use:N\g_@@_line_int-l,
alias = {\tl_if_empty:NF \l_@@_name_tl
{\l_@@_name_tl-\int_use:N\g_@@_line_int-l}} ] {} ;
\hfil
% \end{macrocode}
%
% \bigskip
% Now, after the |\hfil|, we create the ``right node'' and, if the option |shownodenames| is raised, the name of
% the node is written in the document (useful for debugging).
% \begin{macrocode}
\tikz [remember~picture,overlay]
\node [@@_node_style,
name = wa-\l_@@_prefix_str-\int_use:N\g_@@_line_int-r,
alias = {\tl_if_empty:NF \l_@@_name_tl
{\l_@@_name_tl-\int_use:N\g_@@_line_int-r}} ] {} ;
\bool_if:NT \l_@@_shownodenames_bool
{\hbox_overlap_right:n {\small wa-\l_@@_prefix_str
-\int_use:N\g_@@_line_int}}
% \end{macrocode}
%
% \bigskip
% Usually, the |\halign| of an environment |{WithArrows}| will have exactly two columns. Nevertheless, if the user
% wants to use more columns (without arrows) it's possible with the option |MoreColumns|.
% \begin{macrocode}
&& \msg_error:nn {witharrows} {Third~column~in~an~environment~{WithArrows}}
$\bool_if:NT \l_@@_displaystyle_bool \displaystyle {##}$
\cr
}
% \end{macrocode}
%
% \bigskip
% We begin the second part of the environment |{WithArrows}|. We have two |\egroup|\,: one for the
% |\halign| and one for the |\vtop| (or |\vcenter| or |\vbox|).
% \begin{macrocode}
{\crcr
\egroup
\egroup
\@@_post_environment:}
% \end{macrocode}
% This is the end of the environment |{WithArrows}|.
%
%
% \bigskip
% The command |\@@_post_environment:| is a code common to the second part of the environment |{WithArrows}| and the
% environment |{DispWithArrows}|.
% \begin{macrocode}
\cs_new_protected:Nn \@@_post_environment:
% \end{macrocode}
% If there is a line without the second column, we raise an error (a line without the second column could generate
% an \textsc{pgf} error for an unknown node since the nodes are created in the second column).
% \begin{macrocode}
{\int_compare:nNnT \g_@@_line_bis_int < \g_@@_line_int
{\msg_error:nn {witharrows} {All~lines~must~have~an~ampersand}}
% \end{macrocode}
%
% \bigskip
% It there is really arrows in the environment, we draw the arrows:
% \begin{itemize}
% \item if neither option |group| or |groups| is used, we can draw directly ;
% \item if option |group| or option |groups| is used (|\l_@@_pos_arrows_int| > 5), we have to draw the
% arrows group by group ; the macro |\@@_draw_arrows:| does the work.
% \end{itemize}
%
% \begin{macrocode}
\int_compare:nNnT \g_@@_arrow_int > 0
{\int_compare:nNnTF \l_@@_pos_arrows_int > 5
\@@_draw_arrows:
{\@@_draw_arrows:nn 1 \g_@@_arrow_int}}
% \end{macrocode}
%
% \bigskip
% We will execute the code specified in the option |CodeAfter|, after some settings.
% \begin{macrocode}
\group_begin:
\tikzset{every~picture/.style = @@_standard}
% \end{macrocode}
% The command |\NbLines| is not used by \pkg{witharrows}. It's only a convenience given to the user.
% \begin{macrocode}
\cs_set:Npn \NbLines {\int_use:N \g_@@_line_int}
% \end{macrocode}
% The command |\MultiArrow| is available in |CodeAfter|, and we have a special version of |\Arrow|, called
% ``|\Arrow| in |CodeAfter|'' in the documentation.\footnote{As for now, |\MultiArrow| has no option, and that's
% why its internal name is a name of \pkg{expl3} with the signature |:nn| whereas |\Arrow| in |CodeAfter| provides
% options and has the name of a function defined with |\NewDocumentCommand|.}
% \begin{macrocode}
\cs_set_eq:NN \MultiArrow \@@_MultiArrow:nn
\cs_set_eq:cN \l_@@_CommandName_tl \@@_Arrow_code_after
\l_@@_code_after_tl
\group_end:
% \end{macrocode}
%
% \bigskip
% If the option |footnote| or the option |footnotehyper| is used, then we extract the footnotes with an environment
% |{footnote}| (of the package \pkg{footnote} or the package \pkg{footnotehyper}).
% \begin{macrocode}
\bool_if:NT \g_@@_footnote_bool {\end{savenotes}}
% \end{macrocode}
%
% \bigskip
% We update the position-in-the-tree. First, we drop the last component and then we increment the last element.
% \begin{macrocode}
\seq_gpop_right:NN \g_@@_position_in_the_tree_seq \l_tmpa_tl
\seq_gpop_right:NN \g_@@_position_in_the_tree_seq \l_tmpa_tl
\seq_gput_right:Nx \g_@@_position_in_the_tree_seq {\int_eval:n {\l_tmpa_tl+1}}
% \end{macrocode}
%
% \bigskip
% We update the value of the counter |\g_@@_last_env_int|. This counter is used only by the user function
% |\WithArrowsLastEnv|.
% \begin{macrocode}
\int_compare:nNnT {\seq_count:N \g_@@_position_in_the_tree_seq} = 1
{\int_gincr:N \g_@@_last_env_int}
% \end{macrocode}
%
% \bigskip
% Finally, we restore the previous values of the three counters |\g_@@_arrow_int|, |\g_@@_line_int| and
% |\g_@@_line_bis_int|. It is recalled that we manage three stacks in order to be able to do such a restoration.
% \begin{macrocode}
\seq_gpop_right:NN \g_@@_arrow_int_seq {\l_tmpa_tl}
\int_gset:Nn \g_@@_arrow_int {\l_tmpa_tl}
\seq_gpop_right:NN \g_@@_line_int_seq \l_tmpa_tl
\int_gset:Nn \g_@@_line_int {\l_tmpa_tl}
\seq_gpop_right:NN \g_@@_line_bis_int_seq \l_tmpa_tl
\int_gset:Nn \g_@@_line_bis_int {\l_tmpa_tl}
}
% \end{macrocode}
% That's the end of the command |\@@_post_environment:|.
%
% \bigskip
% We give now the definition of |\@@_cr:| which is the definition of |\\| in an environment |{WithArrows}|. The two
% \pkg{expl3} commands |\group_align_safe_begin:| and |\group_align_safe_end:| are specifically designed for this
% purpose: test the token that follows in a |\halign| structure.
%
% First, we remove an eventual token |*| since the commands |\\| and |\\*| are equivalent in an environment
% |{WithArrows}| (an environment |{WithArrows}|, like an environment |{aligned}| of \pkg{amsmath}, is always unbreakable).
% \begin{macrocode}
\cs_new_protected:Nn \@@_cr:
{\scan_stop:
\group_align_safe_begin:
\peek_meaning_remove:NTF * \@@_cr_i: \@@_cr_i:}
% \end{macrocode}
%
% \medskip
% Then, we peek the next token to see if it's a |[|. In this case, the command |\\| has an optional argument which
% is the vertical skip (=glue) to put.
% \begin{macrocode}
\cs_new_protected:Nn \@@_cr_i:
{\peek_meaning:NTF [ {\@@_cr_ii:} {\@@_cr_ii:[\c_zero_dim]} }
\cs_new_protected:Npn \@@_cr_ii:[#1]
{\group_align_safe_end:
% \end{macrocode}
% For the environment |{DispWithArrows}|, the behaviour of |\\| is different because we add the third column which
% is the column for the tag (number of the equation).
% \begin{macrocode}
\bool_if:NF \l_@@_in_witharrows_bool
{\bool_if:NTF \l_@@_notag_bool
% \end{macrocode}
% If there is no tag to put, we use as well the third column because you want to raise an error if the user uses
% more than two columns.
% \begin{macrocode}
{& \tikz [remember~picture,overlay]
\coordinate [name = wa-\l_@@_prefix_str-\int_use:N\g_@@_line_int-v ] ; }
{
% \end{macrocode}
% Here, we can't use |\refstepcounter{equation}| because if the user has issued a |\tag| command, we have to use
% |\l_@@_tag_tl| and not |\theequation|. That's why we have to do the job done by |\refstepcounter| manually.
%
% First, the incrementation of the counter (potentialy).
% \begin{macrocode}
\tl_if_empty:NT \l_@@_tag_tl
{\int_gincr:N \c@equation}
% \end{macrocode}
%
% We store in |\g_tmpa_tl| the tag we will have to compose at the end of the line. We use a global variable because
% we will use it in the \emph{next} cell (after the |&|).
% \begin{macrocode}
\cs_gset:Npx \g_tmpa_tl
{\tl_if_empty:NTF \l_@@_tag_tl
\theequation
\l_@@_tag_tl}
% \end{macrocode}
% It's possible to put several labels for the same line (it's not possible in the environments
% of \pkg{amsmath}). That's why the differents labels of a same line are stored in a sequence |\l_@@_labels_seq|.
% \begin{macrocode}
\seq_if_empty:NF \l_@@_labels_seq
{
% \end{macrocode}
% Now, we do the job done by |\refstepcounter| and by the redefinitions of |\refstepcounter| done by some packages
% (the incrementation of the counter has been done yet).
%
% First an action which is in the definition of |\refstepcounter| in |source2e|.
% \begin{macrocode}
\cs_set:Npx \@currentlabel {\p@equation \g_tmpa_tl}
% \end{macrocode}
% Then, an action done by \pkg{hyperref} in its redefinition of |\refstepcounter|.
% \begin{macrocode}
\bool_if:NT \c_@@_hyperref_loaded_bool
{\cs_set:Npn \This@name {equation}
\hyper@refstepcounter{equation}}
% \end{macrocode}
%
% Then, an action done by \pkg{cleveref} in its redefinition of |\refstepcounter|. The package \pkg{cleveref}
% creates in the |aux| file a command |\cref@currentlabel| similar to |\@current| but with more informations.
% \begin{macrocode}
\bool_if:NT \c_@@_cleveref_loaded_bool
{\cref@constructprefix{equation}{\cref@result}
\@ifundefined{cref@equation@alias}
{\def\@tempa{equation}}
{\def\@tempa{\csname cref@equation@alias\endcsname}}
\protected@edef\cref@currentlabel{[\@tempa][\arabic{equation}][\cref@result]
\p@equation \g_tmpa_tl}}
% \end{macrocode}
%
% Then, an action done by \pkg{typedref} in its redefinition of |\refstepcounter|. The command |\sr@name| is a
% prefix added to the name of the label by the redefinition of |\label| done by \pkg{typedref}.
% \begin{macrocode}
\bool_if:NT \c_@@_typedref_loaded_bool
{\cs_set:Npn \sr@name {equation}}
% \end{macrocode}
% Now, we can issue the command |\label| (some package may have redefined |\label|, for example \pkg{typedref}) for
% each item in the sequence of the labels (it's possible to put several labels to the same line and that's why the
% labels are in the sequence |\l_@@_labels_seq|).
% \begin{macrocode}
\seq_map_function:NN \l_@@_labels_seq \@@_old_label}
% \end{macrocode}
% We store the boolean |\l_@@_tag_star_bool| in the global variable |\g_tmpa_bool| because we will use it in the
% \emph{next} cell (after the |&|).
% \begin{macrocode}
\bool_gset_eq:NN \g_tmpa_bool \l_@@_tag_star_bool
& \cs_set_eq:NN \theequation \g_tmpa_tl
\bool_if:NT \g_tmpa_bool {\cs_set:Npn \tagform@ {}}
% \end{macrocode}
% We use |\@eqnnum| (we recall that there are two definitions of |\@eqnnum|, a standard definition and another, loaded
% if the option |\leqno| is used).
% \begin{macrocode}
\hbox_overlap_left:n
{ \tikz [@@_standard]
\coordinate [name = \int_use:N \g_@@_line_int-v ] ;
\quad
\@eqnnum}
}}
\cr\noalign{\skip_vertical:n {#1 + \l_@@_interline_skip}
\scan_stop:}}
% \end{macrocode}
% According to the documentation of \pkg{expl3}, the previous addition in ``|#1 + \l_@@_interline_skip|'' is really
% an addition of skips (=glues).
%
% \bigskip
% \subsection{The environment \{DispWithArrows\}}
%
%
% For the environment |{DispWithArrows}|, the construction is a construction of the type:
%
% |\[\vcenter{\halign to \displaywith {...}}\]|
%
% The purpose of the |\vcenter| is to have an environment unbreakable.
%
% \bigskip
% \begin{macrocode}
\NewDocumentEnvironment {DispWithArrows} {O{}}
{
% \end{macrocode}
% If \pkg{mathtools} has been loaded with the option |showonlyrefs|, we deactivate the code of \pkg{mathtools} for
% the option |showonlyrefs| with the command |\MT_showonlyrefs_false:| (it will be reactivated at the end of
% the environment).
% \begin{macrocode}
\bool_if:nT \c_@@_mathtools_loaded_bool
{\MH_if_boolean:nT {show_only_refs}
{\MT_showonlyrefs_false:
% \end{macrocode}
% However, we have to re-raise the flag |{show_only_refs}| of \pkg{mhsetup} because it has been switched off by
% |\MT_showonlyrefs_false:| and we will use it in the code of the new version of |\label|.
% \begin{macrocode}
\MH_set_boolean_T:n {show_only_refs}
\bool_set_true:N \l_@@_notag_bool}}
% \end{macrocode}
% The command |\intertext@| is a command of \pkg{amsmath} which loads the definition of |\intertext|.
% \begin{macrocode}
\bool_if:NT \c_@@_amsmath_loaded_bool \intertext@
\if_mode_math:
\msg_error:nn {witharrows}
{{DispWithArrows}~used~in~math~mode}
\fi:
\bool_set_false:N \l_@@_in_witharrows_bool
\@@_pre_environment:n {#1}
% \end{macrocode}
% We don't use |\[| of LaTeX because some extensions, like \pkg{autonum}, do a redefinition of |\[|. However, we
% put the two following lines which are in the definition of |\[|.
% \begin{macrocode}
\nointerlineskip
\makebox[.6\linewidth]{}
$$
% \end{macrocode}
% We use a |\vcenter| in order to prevent page breaks in the environment.
% \begin{macrocode}
\vcenter \bgroup
\spread@equation
\bool_if:NTF \l_@@_fleqn_bool
{\tabskip = \c_zero_skip}
{\tabskip = 0 pt plus 1000 pt minus 1000 pt}
% \end{macrocode}
% If \pkg{amsmath} is loaded, the LaTeX version of |\label| is stored in |\ltx@label|. If not, it's, of course,
% stored in |\label|. We store this definition of |\label| because we will redefine |\label| in the environment.
% \begin{macrocode}
\bool_if:NTF \c_@@_amsmath_loaded_bool
{\cs_set_eq:NN \_@@_old_label \ltx@label}
{\cs_set_eq:NN \_@@_old_label \label}
\cs_set:Npn \notag {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{DispWithArrows}}
{\notag}}
\cs_set:Npn \nonumber {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{DispWithArrows}}
{\nonumber}}
\cs_set:Npn \tag ##1 {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{DispWithArrows}}
{\tag}}
\cs_set:Npn \label ##1 {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{DispWithArrows}}
{\label}}
\halign to \displaywidth \bgroup
\int_gincr:N \g_@@_line_int
\cs_set_eq:cN \l_@@_CommandName_tl \@@_Arrow_first_column:
\strut
\bool_if:NT \l_@@_fleqn_bool
{\skip_horizontal:n \l_@@_mathindent_dim}
\hfil
$\bool_if:NT \l_@@_displaystyle_bool \displaystyle {##}$
\tabskip = \c_zero_skip
&
\cs_set:Npn \notag {\bool_set_true:N \l_@@_notag_bool}
\cs_set_eq:NN \nonumber \notag
\cs_set_eq:NN \tag \@@_tag
\cs_set_eq:NN \label \@@_label:n
$\bool_if:NT \l_@@_displaystyle_bool \displaystyle {{}##}$
\tabskip = 0 pt plus 1000 pt minus 1000 pt
\int_gincr:N \g_@@_line_bis_int
\tikz [remember~picture,overlay]
\node [_@@_node_style,
name = wa-\l_@@_prefix_str-\int_use:N\g_@@_line_int-l,
alias = {\tl_if_empty:NF \l_@@_name_tl
{\l_@@_name_tl-\int_use:N\g_@@_line_int-l}} ] {} ;
\hfil
\tikz [remember~picture,overlay]
\node [_@@_node_style,
name = wa-\l_@@_prefix_str-\int_use:N\g_@@_line_int-r,
alias = {\tl_if_empty:NF \l_@@_name_tl
{\l_@@_name_tl-\int_use:N\g_@@_line_int-r}} ] {} ;
\bool_if:NT \l_@@_shownodenames_bool
{\hbox_overlap_right:n {\small wa-\l_@@_prefix_str
-\int_use:N\g_@@_line_int}}
& ##
\tabskip = \c_zero_skip
&& \msg_error:nn {witharrows} {Third~column~in~an~environment~{DispWithArrows}}
\iffalse ## \fi
\cr}
{\\
% \end{macrocode}
% The following |\egroup| is for the |\halign|.
% \begin{macrocode}
\egroup
% \end{macrocode}
% The following |\egroup| is for the |\vcenter| (aimed to prevent page breaks).
% \begin{macrocode}
\egroup
$$
% \end{macrocode}
%
% If the option |wrap-lines| is used (only in |{DispWithArrows}| and |{DispWithArrows*}|), we compute
% |\g_@@_x_right_dim|. As a first approximation, |\g_@@_x_right_dim| is the $x$-value of the right side of the
% current composition box. In fact, we must take into account the potential labels of the equations. That's why
% we compute |\g_@@_x_right_dim| with the |v|-nodes of each row specificaly built in this goal. |\g_@@_x_right_dim|
% is the minimal value of the $x$-value of these nodes.
% \begin{macrocode}
\bool_if:NT \l_@@_wrap_lines_bool
{\dim_gzero_new:N \g_@@_x_right_dim
\dim_gset:Nn \g_@@_x_right_dim \c_max_dim
\begin{tikzpicture} [@@_standard]
\int_step_variable:nnnNn 1 1 \g_@@_line_int \l_tmpa_int
{\tikz@parse@node\pgfutil@firstofone (\l_tmpa_int-v)
\dim_set:Nn \l_tmpa_dim \pgf@x
\dim_compare:nNnT \l_tmpa_dim < \g_@@_x_right_dim
{\dim_gset:Nn \g_@@_x_right_dim \l_tmpa_dim} }
\end{tikzpicture}}
% \end{macrocode}
%
% \bigskip
% The code in |\@@_post_environment:| is common to |{WithArrows}| and |{DispWithArrows}|.
% \begin{macrocode}
\@@_post_environment:
% \end{macrocode}
% If \pkg{mathtools} has been loaded with the option |showonlyrefs|, we reactivate the code of \pkg{mathtools} for
% the option |showonlyrefs| with the command |\MT_showonlyrefs_true:| (it has been desactivated in the beginning of
% the environment).
% \begin{macrocode}
\bool_if:nT \c_@@_mathtools_loaded_bool
{\MH_if_boolean:nT {show_only_refs}
\MT_showonlyrefs_true:}
\ignorespacesafterend
}
% \end{macrocode}
%
%
% \bigskip
% The command |\@@_tag| will be linked to |\tag| in the environment |{DispWithArrows}|.
% \begin{macrocode}
\NewDocumentCommand \@@_tag {sm}
{\tl_if_empty:NF \l_@@_tag_tl
{\msg_error:nnn {witharrows} {Multiple~tags} {#2}}
\bool_set_false:N \l_@@_notag_bool
\bool_if:nT \c_@@_mathtools_loaded_bool
{\MH_if_boolean:nT {show_only_refs}
{\MH_if_boolean:nF {show_manual_tags}
{\bool_set_true:N \l_@@_notag_bool}}}
\tl_set:Nn \l_@@_tag_tl {#2}
\bool_set:Nn \l_@@_tag_star_bool {#1}
% \end{macrocode}
% The starred version |\tag*| can't be use if \pkg{amsmath} has not been loaded because this version does the job
% by desactivating the command |\tagform@| inserted by \pkg{amsmath} in the (two versions of the) command
% |\@eqnnum|.\footnote{There are two versions of |@eqnnum|, a standard version and a version for the option |leqno|.}
% \begin{macrocode}
\bool_if:nT {#1 && ! \bool_if_p:N \c_@@_amsmath_loaded_bool}
{ \msg_error:nn {witharrows} {tag*~without~amsmath} }
}
% \end{macrocode}
%
%
% \bigskip
% With the environment |{DispWithArrows*}|, the equations are not numbered. We don't put |\begin{DispWithArrows}|
% and |\end{DispWithArrows}| because there is a |\@currenvir| in an error message.
% \begin{macrocode}
\NewDocumentEnvironment {DispWithArrows*} {}
{\WithArrowsOptions{notag}
\DispWithArrows}
{\endDispWithArrows}
% \end{macrocode}
%
% \bigskip
% \subsection{We draw the arrows}
%
% \bigskip
% |\@@_draw_arrows:| draws the arrows when the option |group| or the option |groups| is used. In both cases, we have
% to compute the $x$-value of a group of arrows before actually drawing the arrows of that group. The arrows will
% actually be drawn by the macro |\@@_draw_arrows:nn|.
%
% \begin{macrocode}
\cs_new_protected:Nn \@@_draw_arrows:
{ \group_begin:
% \end{macrocode}
%
% \bigskip
% |\l_@@_first_arrow_of_group_int| will be the first arrow of the current group.
%
% |\l_@@_first_line_of_group_int| will be the first line involved in the group of arrows (equal to the initial line
% of the first arrow of the group because the option |jump| is always positive).
%
% |\l_@@_last_line_of_group_int| will be the last line involved in the group (impossible to guess in advance).
% \begin{macrocode}
\int_zero_new:N \l_@@_first_arrow_of_group_int
\int_zero_new:N \l_@@_first_line_of_group_int
\int_zero_new:N \l_@@_last_line_of_group_int
\bool_set_true:N \l_@@_new_group_bool
% \end{macrocode}
%
% \bigskip
% We begin a loop over all the arrows of the environment. Inside this loop, if a group is finished, we will draw
% the lines of that group.
% \begin{macrocode}
\int_set:Nn \l_@@_arrow_int 1
\int_until_do:nNnn \l_@@_arrow_int > \g_@@_arrow_int
{
% \end{macrocode}
%
% \bigskip
% We extract from the property list of the current arrow the fields ``initial'' and ``final'' and we store these
% values in |\l_@@_initial_int| and |\l_@@_final_int|. However, we have to do a conversion because the components
% of a property list are token lists.
% \begin{macrocode}
\prop_get:cnN {g_@@_arrow_\l_@@_prefix_str _\int_use:N\l_@@_arrow_int _prop}
{initial} \l_tmpa_tl
\int_set:Nn \l_@@_initial_int {\l_tmpa_tl}
\prop_get:cnN {g_@@_arrow_\l_@@_prefix_str _\int_use:N\l_@@_arrow_int _prop}
{final} \l_tmpa_tl
\int_set:Nn \l_@@_final_int {\l_tmpa_tl}
% \end{macrocode}
%
% \bigskip
% We test if the previous arrow was in fact the last arrow of a group. In this case, we have to draw all the arrows
% of that group (with the $x$-value computed in |\g_@@_x_dim|).
% \begin{macrocode}
\bool_if:nT { \int_compare_p:nNn \l_@@_pos_arrows_int = 7
&& \int_compare_p:nNn \l_@@_arrow_int > 1
&& \int_compare_p:nNn
\l_@@_initial_int > \l_@@_last_line_of_group_int}
{\@@_draw_arrows:nn \l_@@_first_arrow_of_group_int {\l_@@_arrow_int - 1}
\bool_set_true:N \l_@@_new_group_bool}
% \end{macrocode}
%
% \bigskip
% The flag |\l_@@_new_group_bool| indicates if we have to begin a new group of arrows. In fact, we have to begin a
% new group in two circonstancies: if we are at the first arrow of the environment (that's why the flag is raised
% before the beginning of the loop) an if we have just finished a group (that's why the flag is raised in the
% previous conditionnal). At the beginning of a group, we have to initialize four variables:
% |\l_@@_first_arrow_int|, |\l_@@_first_line_of_group_int|, |\l_@@_last_line_of_group| and |\g_@@_x_dim| (global
% for technical reasons). The last two will evolve during the construction of the group.
% \begin{macrocode}
\bool_if:nTF \l_@@_new_group_bool
{\bool_set_false:N \l_@@_new_group_bool
\int_set:Nn \l_@@_first_arrow_of_group_int \l_@@_arrow_int
\int_set:Nn \l_@@_first_line_of_group_int \l_@@_initial_int
\int_set:Nn \l_@@_last_line_of_group_int \l_@@_final_int
\begin{tikzpicture} [@@_standard]
\tikz@parse@node\pgfutil@firstofone (\int_use:N\l_@@_initial_int-l)
\dim_gset:Nn \g_@@_x_dim \pgf@x
\end{tikzpicture}
}
% \end{macrocode}
%
% \bigskip
% If we are not at the beginning of a new group, we actualize |\l_@@_last_line_of_group_int|.
% \begin{macrocode}
{\int_set:Nn \l_@@_last_line_of_group_int
{\int_max:nn \l_@@_last_line_of_group_int \l_@@_final_int}}
% \end{macrocode}
%
% \bigskip
% We update the current $x$-value (in |\g_@@_x_dim|) even if we are at the beginning of a group. Indeed, the
% previous initialisation of |\g_@@_x_dim| only considers the initial line of the arrows and now we consider all
% the lines between the initial and the final line. This is done with |\@@_update_x_value:nn|. We have written a
% command for this because it is also used with the option |i| (|\l_@@_pos_arrows_int| = 5).
% \begin{macrocode}
\@@_update_x_value:nn \l_@@_initial_int \l_@@_final_int
% \end{macrocode}
%
% \bigskip
% Incrementation of the index of the loop (and end of the loop).
% \begin{macrocode}
\int_incr:N \l_@@_arrow_int
}
% \end{macrocode}
%
% \bigskip
% After the last arrow of the environment, we have to draw the last group of arrows.
% \begin{macrocode}
\@@_draw_arrows:nn \l_@@_first_arrow_of_group_int \g_@@_arrow_int
\group_end:
}
% \end{macrocode}
%
% \bigskip
% The following code is necessary because we will have to expand an argument exactly 3 times.
% \begin{macrocode}
\cs_generate_variant:Nn \keys_set:nn {no}
\cs_new_protected:Nn \@@_keys_set: {\keys_set:no {WithArrows/General}}
% \end{macrocode}
%
%
% \bigskip
% The macro |\@@_draw_arrows:nn| draws all the arrows whose numbers are between |#1| and |#2|. |#1| and |#2|
% must be expressions that expands to an integer (they are expanded in the beginning of the macro).
% \begin{macrocode}
\cs_new_protected:Nn \@@_draw_arrows:nn
{\group_begin:
\int_zero_new:N \l_@@_first_arrow_int
\int_set:Nn \l_@@_first_arrow_int {#1}
\int_zero_new:N \l_@@_last_arrow_int
\int_set:Nn \l_@@_last_arrow_int {#2}
% \end{macrocode}
%
%
% \bigskip
% We begin a loop over the arrows we have to draw. The variable |\l_@@_arrow_int| (local in the environment
% |{WithArrows}|) will be used as index for the loop.
% \begin{macrocode}
\int_set:Nn \l_@@_arrow_int \l_@@_first_arrow_int
\int_until_do:nNnn \l_@@_arrow_int > \l_@@_last_arrow_int
{
% \end{macrocode}
%
% \bigskip
% We extract from the property list of the current arrow the fields ``initial'' and ``final'' and we store these
% values in |\l_@@_initial_int| and |\l_@@_final_int|. However, we have to do a conversion because the components
% of a property list are token lists.
%
% \begin{macrocode}
\prop_get:cnN {g_@@_arrow_\l_@@_prefix_str _\int_use:N\l_@@_arrow_int _prop}
{initial} \l_tmpa_tl
\int_set:Nn \l_@@_initial_int {\l_tmpa_tl}
\prop_get:cnN {g_@@_arrow_\l_@@_prefix_str _\int_use:N\l_@@_arrow_int _prop}
{final} \l_tmpa_tl
\int_set:Nn \l_@@_final_int {\l_tmpa_tl}
% \end{macrocode}
%
% \bigskip
% If the arrow ends after the last line of the environment, we raise an error (we recall that, after the
% construction of the |\halign|, |\g_@@_line_int| is the total number of lines of the environment). If the initial
% node or the final node doesn't exist, we also raise an error.\footnote{This case occurs if the considered line
% has no ampersand. In fact, we raise an error if there is such a line in the |\halign|, but, nonetheless, we consider
% the case where the user goes on and we try to avoid other errors.}
% \begin{macrocode}
\int_compare:nNnTF \l_@@_final_int > \g_@@_line_int
{\msg_error:nn {witharrows} {Too~few~lines~for~an~arrow}}
{\cs_if_free:cTF {pgf@sh@ns@wa-\l_@@_prefix_str-\int_use:N\l_@@_initial_int-l}
{ \msg_error:nn {witharrows} {A~PGF~node~doesn't~exist} }
{\cs_if_free:cTF {pgf@sh@ns@wa-\l_@@_prefix_str-\int_use:N\l_@@_final_int-l}
{ \msg_error:nn {witharrows} {A~PGF~node~doesn't~exist} }
{\@@_draw_arrows_i:}}}
\int_incr:N \l_@@_arrow_int
}
\group_end:
}
% \end{macrocode}
%
% \bigskip
% The macro |\@@_draw_arrows_i:| is only for the lisibility of the code. This macro will draw the current arrow
% if the arrow is not impossible (that is to say if the Tikz nodes exist). The first |\group_begin:| is for the
% options of the arrow.
% \begin{macrocode}
\cs_new:Nn \@@_draw_arrows_i:
{\group_begin:
\int_set:Nn \l_@@_previous_pos_arrows_int {-1}
\int_set:Nn \l_@@_level_int 3
% \end{macrocode}
%
% \bigskip
% We process the options of the current arrow. The second argument of |\keys_set:nn| must be expanded exactly
% three times. An x-expansion is not possible because there can be tokens like |\bfseries| in the option |font| of
% the option |tikz|. This expansion is a bit tricky.
% \begin{macrocode}
\prop_get:cnN {g_@@_arrow_\l_@@_prefix_str
_\int_use:N\l_@@_arrow_int _prop} {options} \l_tmpa_tl
\exp_args:NNo \exp_args:No
\@@_keys_set: {\l_tmpa_tl,tikz={xshift = \l_@@_xoffset_dim}}
% \end{macrocode}
%
%
% We create two booleans to indicate the position of the initial node and final node of the arrow in cases of
% options |rr|, |rl|, |lr| or |ll|:
% \begin{macrocode}
\bool_set_false:N \l_@@_initial_r_bool
\bool_set_false:N \l_@@_final_r_bool
\int_case:nn \l_@@_pos_arrows_int
{0 {\bool_set_true:N \l_@@_initial_r_bool
\bool_set_true:N \l_@@_final_r_bool}
2 {\bool_set_true:N \l_@@_initial_r_bool}
3 {\bool_set_true:N \l_@@_final_r_bool}}
% \end{macrocode}
%
% \bigskip
% \begin{center}
% \begin{tabular}{l}
% \begin{tabular}{@{}l*8c@{}}
% \toprule
% option & |rr| & |ll| & |rl| & |lr| & |v| & |i| & |group| & |groups| \\
% \midrule
% |\l_@@_pos_arrows_int| & $0$ & $1$ & $2$ & $3$ & $4$ & $5$ & $6$ & $7$ \\
% \bottomrule
% \end{tabular} \\
% \footnotesize The option |v| can be used only in |\Arrow| in |CodeAfter| (see below).
% \end{tabular}
% \end{center}
%
% \bigskip
% In case of option |i| (|\l_@@_pos_arrows_int| = 5), we have to compute the $x$-value of the arrow (which is
% vertical). The computed $x$-value is stored in |\g_@@_x_dim| (the same variable used when the option |group| or
% the option |groups| is used). This variable is global for technical reasons: we have to do assignments in a Tikz
% node.
% \begin{macrocode}
\int_compare:nNnT \l_@@_pos_arrows_int = 5
{
% \end{macrocode}
%
% \medskip
% First, we calculate the initial value for |\g_@@_x_dim|. We use a Tikz command, but, in fact, nothing is drawn.
% We use this Tikz command only to read the abscissa of a Tikz node.
% \begin{macrocode}
\begin{tikzpicture} [@@_standard]
\tikz@parse@node\pgfutil@firstofone (\int_use:N\l_@@_initial_int-l)
\dim_gset:Nn \g_@@_x_dim \pgf@x
\end{tikzpicture}
% \end{macrocode}
% A global assignment is necessary because of Tikz.
%
% Then, we will loop to determine the maximal length of the lines between the lines |\l_@@_initial_int| and
% |\l_@@_final_int|... but we have written a command dedicated to this work because it will also be used in
% |\@@_draw_arrows:|.
% \begin{macrocode}
\@@_update_x_value:nn \l_@@_initial_int \l_@@_final_int
}
% \end{macrocode}
%
% \bigskip
% |\l_@@_initial_tl| contains the name of the Tikz node from which the arrow starts (in normal cases...
% because with the option |i|, |group| and |groups|, the point will perhaps have another $x$-value --- but always the
% same $y$-value). Idem for |\l_@@_final_tl|.
% \begin{macrocode}
\tl_set:Nx \l_@@_initial_tl
{\int_use:N\l_@@_initial_int-\bool_if:NTF\l_@@_initial_r_bool rl .south}
\tl_set:Nx \l_@@_final_tl
{\int_use:N\l_@@_final_int-\bool_if:NTF\l_@@_final_r_bool rl .north}
% \end{macrocode}
% We use ``|.south|'' and ``|.north|'' because we want a small gap between two consecutive arrows (and the Tikz
% nodes created have the shape of small vertical segments: use option |shownodes| to visualize the nodes).
%
% \bigskip
% The label of the arrow will is stored in |\l_tmpa_tl|.
% \begin{macrocode}
\prop_get:cnN {g_@@_arrow_\l_@@_prefix_str _\int_use:N\l_@@_arrow_int _prop}
{label}
\l_tmpa_tl
% \end{macrocode}
%
% \bigskip
% We have to compute the coordinates of the extremities of the arrow. We retrieve the coordinates in |\g_tmpa_tl|
% and |\g_tmpb_tl|. This extraction of the coordinates is necessary because we must give coordinates and not nodes
% (even anchored) to |\@@_draw_arrow:nnn| to have the |xshift| correct.
% \begin{macrocode}
\int_compare:nNnTF \l_@@_pos_arrows_int < 5
{\begin{tikzpicture} [@@_standard]
\tikz@scan@one@point\pgfutil@firstofone(\l_@@_initial_tl)
\tl_gset:Nx \g_tmpa_tl {\dim_use:N\pgf@x,\dim_use:N\pgf@y}
\tikz@scan@one@point\pgfutil@firstofone(\l_@@_final_tl)
\tl_gset:Nx \g_tmpb_tl {\dim_use:N\pgf@x,\dim_use:N\pgf@y}
\end{tikzpicture}
}
% \end{macrocode}
%
% If we use option |i| or |group| or |groups|, we use the abscissa specially computed in |\g_@@_x_dim|.
% \begin{macrocode}
{\begin{tikzpicture} [@@_standard]
\tikz@scan@one@point\pgfutil@firstofone (\l_@@_initial_tl)
\tl_gset:Nx \g_tmpa_tl {\dim_use:N \g_@@_x_dim , \dim_use:N \pgf@y}
\tikz@scan@one@point\pgfutil@firstofone (\l_@@_final_tl)
\tl_gset:Nx \g_tmpb_tl {\dim_use:N \g_@@_x_dim , \dim_use:N \pgf@y}
\end{tikzpicture}}
% \end{macrocode}
%
% \bigskip
% Eventually, we can draw the arrow with the code in |\l_@@_tikz_code_tl|. We recall that the value by default for
% this token list is :\enskip ``\verb|\draw (#1) to node {#3} (#2) ;|''. This value can be modified
% with the option |TikzCode|. We use the variant |\@@_draw_arrow:nno| of the macro |\@@_draw_arrow:nnn| because of
% the characters \emph{underscore} in the name |\l_tmpa_tl| : if the user uses the Tikz library |babel|, the third
% argument of the command |\@@_draw_arrow:nno| will be rescanned because this third argument will be in the
% argument of a command |node| of an instruction |\draw| of Tikz... and we will have an error because of the
% characters \emph{underscore}.\footnote{There were other solutions : use another name without \emph{underscore}
% (like \Verb|\ltmpatl|) or use the package \pkg{underscore} (with this package, the characters \emph{underscore}
% will be rescanned without errors, even in text mode).}
% \begin{macrocode}
\@@_draw_arrow:nno {\g_tmpa_tl} {\g_tmpb_tl} {\l_tmpa_tl}
% \end{macrocode}
%
% \smallskip
% We close the TeX group opened for the options given to |\Arrow[...]| (local level of the options).
% \begin{macrocode}
\group_end: }
% \end{macrocode}
%
%
% \bigskip
% The function |@@_tmpa:nnn| will draw the arrow. It's merely an environment |{tikzpicture}|. However, the Tikz
% instruction in this environment must be inserted from |\l_@@_tikz_code_tl| with the markers |#1|, |#2| and |#3|.
% That's why we create a function |\@@_def_function_tmpa:n| which will create the function |\@@_tmpa:nnn|.
% \begin{macrocode}
\cs_new_protected:Nn \@@_def_function_tmpa:n
{\cs_set:Nn \@@_tmpa:nnn
{\begin{tikzpicture}[@@_standard,every~path/.style = {WithArrows/arrow}]
#1
\end{tikzpicture}}}
% \end{macrocode}
%
% \medskip
% When we draw the arrow (with |\@@_draw_arrow:nnn|), we first create the function |\@@_tmpa:nnn| and, then, we use
% the function |\@@_tmpa:nnn| :
% \begin{macrocode}
\cs_new_protected:Nn \@@_draw_arrow:nnn
{
% \end{macrocode}
% \medskip
% If the option |wrap-lines| is used, we have to use a special version of |TikzCode|. Here is the use of
% |\g_@@_x_right_dim| which has been computed previously with the |v|-nodes.
% \begin{macrocode}
\bool_if:nT {\l_@@_wrap_lines_bool && ! \l_@@_in_witharrows_bool}
{\tl_set:Nn \l_@@_tikz_code_tl
{\draw (##1) to node (@@_label) {} (##2) ;
\tikz@parse@node \pgfutil@firstofone (@@_label.west)
\path (@@_label.west)
node [anchor = west,
text~width = \dim_eval:n {\g_@@_x_right_dim - \pgf@x - 0.3333 em}]
{##3} ; }}
% \end{macrocode}
% |0.3333 em| is the default value of |inner sep| in the nodes of Tikz. Maybe we should put the exact Tikz parameter.
% \medskip
% Now, the main lines of this function |\@@_draw_arrow:nnn|.
% \begin{macrocode}
\exp_args:No \@@_def_function_tmpa:n \l_@@_tikz_code_tl
\@@_tmpa:nnn {#1} {#2} {#3} }
\cs_generate_variant:Nn \@@_draw_arrow:nnn {nno}
% \end{macrocode}
%
%
% \bigskip
% The command |\@@_update_x_value:nn| will analyze the lines\footnote{If a line has no ampersand, this line is
% ignored. In fact, we raise an error if there is a line without ampersand but, nonetheless, we consider the case
% where the user goes on and we try to avoid other errors.} between |#1| and |#2| in order to modify
% |\g_@@_x_dim| in consequence. More precisely, |\g_@@_x_dim| is increased if a line longer than the current value
% of |\g_@@_x_dim| is found. |\@@_update_x_value:nn| is used in |\@@_draw_arrows:| (for options |group| and
% |groups|) and in |\@@_draw_arrows:nn| (for option |i|).
% \begin{macrocode}
\cs_new_protected:Nn \@@_update_x_value:nn
{\int_step_inline:nnnn {#1} \c_one {#2}
{\cs_if_exist:cT {pgf@sh@ns@wa-\l_@@_prefix_str-##1-l}
{\begin{tikzpicture} [@@_standard]
\tikz@scan@one@point\pgfutil@firstofone (##1-l)
\dim_gset:Nn \g_@@_x_dim {\dim_max:nn \g_@@_x_dim \pgf@x}
\end{tikzpicture} } } }
% \end{macrocode}
%
%
% \bigskip
% The command |\WithArrowsLastEnv| is not used by the package \pkg{witharrows}. It's only a facility given to the
% final user. It gives the number of the last environment |{WithArrows}| at level~$0$ (to the sens of the nested
% environments). This macro is fully expandable and, thus, can be used directly in the name of a Tikz node.
% \begin{macrocode}
\cs_new:Npn \WithArrowsLastEnv {\int_use:N \g_@@_last_env_int}
% \end{macrocode}
%
% \bigskip
% \subsection{The command Arrow in CodeAfter}
%
% The option |CodeAfter| is an option of the environment |{WithArrows}| (this option is only available at the
% environment level). In the option |CodeAfter|, one can use the command |Arrow| but it's a special version of the
% command |Arrow|. For this special version (internally called |\@@_Arrow_code_after|), we define a special set of
% keys called |WithArrows/CodeAfter|.
%
% \begin{macrocode}
\keys_define:nn {WithArrows/CodeAfter}
{tikz .code:n = \tikzset {WithArrows/arrow/.append~style = {#1}} ,
tikz .value_required:n = true,
rr .value_forbidden:n = true,
rr .code:n = \@@_analyze_option_position:n 0 ,
ll .value_forbidden:n = true,
ll .code:n = \@@_analyze_option_position:n 1 ,
rl .value_forbidden:n = true,
rl .code:n = \@@_analyze_option_position:n 2 ,
lr .value_forbidden:n = true,
lr .code:n = \@@_analyze_option_position:n 3 ,
v .value_forbidden:n = true,
v .code:n = \@@_analyze_option_position:n 4 ,
TikzCode .tl_set:N = \l_@@_tikz_code_tl,
TikzCode .value_required:n = true,
xoffset .dim_set:N = \l_@@_xoffset_dim,
xoffset .value_required:n = true}
% \end{macrocode}
%
%
% \bigskip
% \begin{macrocode}
\NewDocumentCommand \@@_Arrow_code_after {O{} mmm O{}}
{\int_set:Nn \l_@@_pos_arrows_int 1
\int_set:Nn \l_@@_previous_pos_arrows_int {-1}
\group_begin:
% \end{macrocode}
% Even if |\Arrow| in |CodeAfter| has its own set of options (|WithArrows/CodeAfter|), we set the level of the
% options to~$3$ (as with the classical command |\Arrow|) because of the error messages.
% \begin{macrocode}
\int_set:Nn \l_@@_level_int 3
\keys_set:nn {WithArrows/CodeAfter}
{#1,#5,tikz={xshift = \l_@@_xoffset_dim}}
\bool_set_false:N \l_@@_initial_r_bool
\bool_set_false:N \l_@@_final_r_bool
\int_case:nn \l_@@_pos_arrows_int
{0 {\bool_set_true:N \l_@@_initial_r_bool
\bool_set_true:N \l_@@_final_r_bool}
2 {\bool_set_true:N \l_@@_initial_r_bool}
3 {\bool_set_true:N \l_@@_final_r_bool}}
% \end{macrocode}
% We test wether the two Tikz nodes |(#2-l)| and |(#3-l)| really exist. If not, the arrow won't be drawn.
% \begin{macrocode}
\cs_if_free:cTF {pgf@sh@ns@wa-\l_@@_prefix_str-#2-l}
{\msg_error:nnx {witharrows} {Wrong~line~specification~in~Arrow} {#2}}
{\cs_if_free:cTF {pgf@sh@ns@wa-\l_@@_prefix_str-#3-l}
{\msg_error:nnx {witharrows} {Wrong~line~specification~in~Arrow} {#3}}
{\int_compare:nNnTF \l_@@_pos_arrows_int = 4
{\begin{tikzpicture} [@@_standard]
\tikz@scan@one@point\pgfutil@firstofone(#2-l.south)
\dim_set_eq:NN \l_tmpa_dim \pgf@x
\dim_set_eq:NN \l_tmpb_dim \pgf@y
\tikz@scan@one@point\pgfutil@firstofone(#3-l.north)
\dim_set:Nn \l_tmpa_dim {\dim_max:nn \l_tmpa_dim \pgf@x}
\tl_gset:Nx \g_tmpa_tl {\dim_use:N \l_tmpa_dim , \dim_use:N \l_tmpb_dim}
\tl_gset:Nx \g_tmpb_tl {\dim_use:N \l_tmpa_dim , \dim_use:N \pgf@y}
\end{tikzpicture} }
{\begin{tikzpicture} [@@_standard]
\tikz@scan@one@point\pgfutil@firstofone
(#2-\bool_if:NTF\l_@@_initial_r_bool rl .south)
\tl_gset:Nx \g_tmpa_tl {\dim_use:N \pgf@x , \dim_use:N \pgf@y}
\tikz@scan@one@point\pgfutil@firstofone
(#3-\bool_if:NTF\l_@@_final_r_bool rl .north)
\tl_gset:Nx \g_tmpb_tl {\dim_use:N \pgf@x , \dim_use:N \pgf@y}
\end{tikzpicture}}
\@@_draw_arrow:nnn {\g_tmpa_tl} {\g_tmpb_tl} {#4} }}
\group_end:
}
% \end{macrocode}
%
%
% \bigskip
% \subsection{MultiArrow}
% The command |\@@_MultiArrow:nn| will be linked to |\MultiArrow| when the |CodeAfter| is executed.
%
% \begin{macrocode}
\cs_new_protected:Nn \@@_MultiArrow:nn
{
% \end{macrocode}
% The user of the command |\MultiArrow| (in |CodeAfter|) will be able to specify the list of lines with the same
% syntax as the loop |\foreach| of \pkg{pgffor}. That's why we construct a ``clist'' of \pkg{expl3} from the
% specification of list given by the user. The construction of the ``clist'' must be global in order to exit the
% |\foreach| and that's why we construct the list in |\g_tmpa_clist|.
% \begin{macrocode}
\foreach \x in {#1} {\cs_if_free:cTF {pgf@sh@ns@wa-\l_@@_prefix_str-\x-l}
{\msg_error:nnx {witharrows}
{Wrong~line~specification~in~MultiArrow}
{\x}}
{\clist_gput_right:Nx \g_tmpa_clist {\x}}}
% \end{macrocode}
% We sort the list |\g_tmpa_clist| because we want to extract the minimum and the maximum.
% \begin{macrocode}
\int_compare:nNnTF {\clist_count:N \g_tmpa_clist} < 2
{\msg_error:nn {witharrows} {Too~small~specification~for~MultiArrow}}
{\clist_sort:Nn \g_tmpa_clist
{\int_compare:nNnTF {##1} > {##2}
{\sort_return_swapped:}
{\sort_return_same:}}
% \end{macrocode}
% We extract the minimum in |\l_tmpa_tl| (it must be an integer but we store it in a token list of \pkg{expl3}).
% \begin{macrocode}
\clist_pop:NN \g_tmpa_clist \l_tmpa_tl
% \end{macrocode}
%
% We extract the maximum in |\l_tmpb_tl|. The remaining list (in |\g_tmpa_clist| will be sorted in decreasing order
% but never mind...).
% \begin{macrocode}
\clist_reverse:N \g_tmpa_clist
\clist_pop:NN \g_tmpa_clist \l_tmpb_tl
% \end{macrocode}
%
% We draw the teeth of the rak (except the first one and the last one) with the auxiliary function
% |\@@_MultiArrow_i:n|. This auxiliary fonction is necessary to expand the specification of the list in the
% |\foreach| loop. The first and the last teeth of the rak can't be drawn the same way as the others (think, for
% example, to the case of the option ``rounded corners'' is used).
% \begin{macrocode}
\exp_args:Nx \@@_MultiArrow_i:n {\g_tmpa_clist}
% \end{macrocode}
%
% Now, we draw the rest of the structure.
% \begin{macrocode}
\begin{tikzpicture}[@@_standard,every~path/.style={WithArrows/arrow}]
\draw [<->] ([xshift = \l_@@_xoffset_dim]\l_tmpa_tl-r.south)
-- ++(5mm,0)
-- node (@@_label) {}
([xshift = \l_@@_xoffset_dim+5mm]\l_tmpb_tl-r.south)
-- ([xshift = \l_@@_xoffset_dim]\l_tmpb_tl-r.south) ;
\tikz@parse@node \pgfutil@firstofone (@@_label.west)
\path (@@_label.west)
node [anchor = west,
text~width =
{\bool_if:nTF {\l_@@_wrap_lines_bool && ! \l_@@_in_witharrows_bool}
{\dim_eval:n {\g_@@_x_right_dim - \pgf@x - 0.3333 em}}
{20 cm}}
] {#2} ;
\end{tikzpicture} } }
\cs_new_protected:Nn \@@_MultiArrow_i:n
{\begin{tikzpicture}[@@_standard,every~path/.style={WithArrows/arrow}]
\foreach \k in {#1}
{\draw[<-] ([xshift = \l_@@_xoffset_dim]\k-r.south) -- ++(5mm,0) ;} ;
\end{tikzpicture}}
% \end{macrocode}
%
%
% \bigskip
% \subsection{The error messages of the package}
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Third~column~in~an~environment~{WithArrows}}
{By~default,~an~environment~\{WithArrows\}~can~only~have~two~columns.~
Maybe~you~have~forgotten~a~\str_use:N \c_backslash_str
\str_use:N \c_backslash_str.~If~you~really~want~more~than~two~columns,~
you~should~use~the~option~"MoreColumns"~at~a~global~level~or~for~
an~environment.~However,~you~can~go~one~for~this~time.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Third~column~in~an~environment~{DispWithArrows}}
{An~environment~\{DispWithArrows\}~or~\{DispWithArrows*\}~can~only~
have~two~columns.~If~you~go~on,~you~may~have~an~incorrect~output.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{The~option~"jump"~must~be~non~negative}
{You~can't~use~a~strictly~negative~value~for~the~option~"jump"~of~command~
\token_to_str:N\Arrow.~ You~can~create~an~arrow~going~backwards~with~
the~option~"<-"~of~Tikz.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Too~few~lines~for~an~arrow}
{An~arrow~specified~in~line~\int_use:N \l_@@_initial_int\ can't~be~drawn~
because~it~arrives~after~the~last~line~of~the~environment~(remind~that~
the~command~\token_to_str:N\Arrow\ must~be~in~the~*start*~line~
of~the~arrow).~If~you~go~on,~this~arrow~will~be~ignored.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{{WithArrows}~used~outside~math~mode}
{The~environment~\{WithArrows\}~should~be~used~only~in~math~mode.~
Nevertheless,~you~can~go~on.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{{DispWithArrows}~used~in~math~mode}
{The~environment~\{DispWithArrows\}~should~be~used~only~outside~math~mode.~
If~you~go~on,~you~will~have~other~errors.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Two~options~are~incompatible}
{You~try~to~use~the~option~"\tl_use:N\l_keys_key_tl"~but~
this~option~is~incompatible~or~redundant~with~the~option~"
\int_case:nn\l_@@_previous_pos_arrows_int
{0 {rr}
1 {ll}
2 {rl}
3 {lr}
4 {v}
5 {i}
6 {group}
7 {groups}}"~
set~in~the~same~
\int_case:nn\l_@@_level_int
{1 {command~\token_to_str:N\WithArrowsOptions}
2 {declaration~of~options~of~the~environment~
\{\@currenvir\}}
3 {command~\token_to_str:N\Arrow}}.~
If~you~go~on,~I~will~use~the~option~"\tl_use:N\l_keys_key_tl".}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnnn {witharrows}
{All~lines~must~have~an~ampersand}
{All~lines~of~an~environment~\{WithArrows\}~should~
have~an~second~column~(because~the~nodes~are~created~
in~the~second~column).~However,~you~can~go~but~you~will~
have~an~error~if~one~of~your~arrows~needs~an~PGF~
node~absent~by~lack~of~ampersand.~If~you~don't~want~to~
see~this~message~again,~you~can~use~the~option~
AllowLineWithoutAmpersand.}
{Moreover, the~ampersand~can~be~implicit~
(e.g.~if~you~use~\token_to_str:N\MoveEqLeft\ of~mathtools).}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Option~incompatible~with~"group(s)"}
{You~try~to~use~the~option~"\tl_use:N\l_keys_key_tl"~while~
you~are~using~the~option~"
\int_compare:nNnTF \l_@@_pos_arrows_int = 5
{group}
{groups}".~
It's~incompatible.~You~can~go~on~ignoring~this~option~
"\tl_use:N\l_keys_key_tl"~but~you~should~correct~your~code.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Option~will~be~ignored}
{The~option~"\tl_use:N\l_keys_key_tl"~can't~be~used~here.~
If~you~go~on,~it~will~be~ignored.}
% \end{macrocode}
%
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Option~unknown}
{The~option~"\tl_use:N\l_keys_key_tl"~is~unknown~or~
meaningless~in~the~context.~If~you~go~on,~it~will~be~ignored.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Arrow~in~first~column}
{You~should~not~use~the~command~\token_to_str:N\Arrow\
\tl_if_eq:NNF \l_@@_CommandName_tl \l_tmpa_tl
{(renamed~in~\str_use:N \c_backslash_str
\tl_use:N \l_@@_CommandName_tl)~}
~in~the~first~column~but~only~in~the~second~column.~
This~is~a~restriction~of~the~version~1.3~of~the~
package~witharrows~(in~the~aim~of~developping~further~
~a~new~functionality~with~\token_to_str:N\Arrow\ in~the~
first~column).\\
However~you~can~go~on~for~this~time.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Wrong~line~specification~in~Arrow}
{The~specification~of~line~"#1"~you~use~in~\token_to_str:N\Arrow\
~doesn't~exist.\\
If~you~go~on,~the~arrow~will~be~ignored.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Wrong~line~specification~in~MultiArrow}
{The~specification~of~line~"#1"~doesn't~exist.\\
If~you~go~on,~it~will~be~ignored~for~\token_to_str:N \MultiArrow.}
% \end{macrocode}
%
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Too~small~specification~for~MultiArrow}
{The~specification~of~lines~you~gave~to~\token_to_str:N \MultiArrow\
is~too~small:~we~need~at~least~two~lines.~If~you~go~on,~the~
command~\token_to_str:N\MultiArrow\ ~will~be~ignored.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{A~PGF~node~doesn't~exist}
{A~PGF~node~necessary~to~draw~an~arrow~doesn't~exist~
because~you~didn't~put~an~ampersand~in~the~corresponding~line.~
If~you~go~on,~the~arrow~will~be~ignored.}
% \end{macrocode}
%
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{tag*~without~amsmath}
{We~can't~use~\token_to_str:N\tag*~because~you~haven't~load~amsmath~
(or~mathtools).~If~you~go~on,~the~command~\token_to_str:N\tag\
will~be~used~instead.}
% \end{macrocode}
%
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Command~not~allowed~in~{DispWithArrows}}
{The~command~\token_to_str:N #1
is~not~allowed~in~the~first~column~of~\{DispWithArrows\}~but~
only~in~the~second~column~(and,~of~course,~in~the~
environments~of~amsmath).~If~you~go~on,~this~command~will~be~ignored.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Command~not~allowed~in~{WithArrows}}
{The~command~\token_to_str:N #1
is~not~allowed~in~\{WithArrows\}~but~is~allowed~in~the~second~
column~of~\{DispWithArrows\}~(and,~of~course,~in~the~
environments~of~amsmath).~If~you~go~on,~this~command~will~be~ignored.}
% \end{macrocode}
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Multiple~tags}
{You~can't~use~twice~the~command~\token_to_str:N\tag\
in~a~line~of~the~environment~\{\@currenvir\}.~If~you~go~on,~the~tag~
'#1'~will~be~used.}
% \end{macrocode}
%
%
% \begin{macrocode}
\msg_new:nnn {witharrows}
{Multiple~labels}
{Normaly,~we~can't~use~the~command~\token_to_str:N\label\
twice~in~a~line~of~the~environment~\{\@currenvir\}.~
However,~you~can~go~on.~
If~you~don't~want~to~see~this~message~again,~you~can~use~the~option~
"AllowMultipleLabels"~at~the~global~or~
environment~level~(this~doesn't~work~if~you~use~cleveref).}
% \end{macrocode}
%
%
% \subsection{Environment \{CasesWithArrows\}}
%
% \begin{macrocode}
\coffin_new:N \l_@@_halign_coffin
\NewDocumentEnvironment {CasesWithArrows} {m O{}}
{\hbox_set:Nn \l_tmpa_box {$\left\{\vcenter to 1cm {} \right.$}
\dim_zero_new:N \l_@@_delim_wd_dim
\dim_set:Nn \l_@@_delim_wd_dim {\box_wd:N \l_tmpa_box}
\box_clear_new:N \l_@@_left_part_box
\hbox_set:Nn \l_@@_left_part_box
{$\bool_if:NT \l_@@_displaystyle_bool \displaystyle #1 {}$}
\bool_if:nT \c_@@_mathtools_loaded_bool
{\MH_if_boolean:nT {show_only_refs}
{\MT_showonlyrefs_false:
\MH_set_boolean_T:n {show_only_refs}
\bool_set_true:N \l_@@_notag_bool}}
\bool_if:NT \c_@@_amsmath_loaded_bool \intertext@
\if_mode_math:
\msg_error:nn {witharrows}
{{DispWithArrows}~used~in~math~mode}
\fi:
\bool_set_false:N \l_@@_in_witharrows_bool
%
\_@@_pre_environment:n {#2}
\nointerlineskip
\hbox_to_wd:nn {0.6\linewidth} {}
$$
\spread@equation
\vcoffin_set:Nnw \l_@@_halign_coffin \displaywidth
\bool_if:NTF \l_@@_fleqn_bool
{\tabskip = \c_zero_skip}
{\tabskip = 0 pt plus 1000 pt minus 1000 pt}
\bool_if:NTF \c_@@_amsmath_loaded_bool
{\cs_set_eq:NN \_@@_old_label \ltx@label}
{\cs_set_eq:NN \_@@_old_label \label}
\cs_set:Npn \notag {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{DispWithArrows}}
{\notag}}
\cs_set:Npn \nonumber {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{DispWithArrows}}
{\nonumber}}
\cs_set:Npn \tag ##1 {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{DispWithArrows}}
{\tag}}
\cs_set:Npn \label ##1 {\msg_error:nnn {witharrows}
{Command~not~allowed~in~{DispWithArrows}}
{\label}}
\halign to \displaywidth \bgroup
\int_gincr:N \g_@@_line_int
\cs_set_eq:cN \l_@@_CommandName_tl \@@_Arrow_first_column:
\strut
\bool_if:NT \l_@@_fleqn_bool
{\skip_horizontal:n \l_@@_mathindent_dim}
\hfil
\skip_horizontal:n {\box_wd:N \l_@@_left_part_box + \l_@@_delim_wd_dim}
$\bool_if:NT \l_@@_displaystyle_bool \displaystyle {##}$
\tabskip = \c_zero_skip
&
\cs_set:Npn \notag {\bool_set_true:N \l_@@_notag_bool}
\cs_set_eq:NN \nonumber \notag
\cs_set_eq:NN \tag \@@_tag
\cs_set_eq:NN \label \@@_label:n
$\bool_if:NT \l_@@_displaystyle_bool \displaystyle {{}##}$
\tabskip = 0 pt plus 1000 pt minus 1000 pt
\int_gincr:N \g_@@_line_bis_int
\tikz [remember~picture,overlay]
\node [@@_node_style,
name = wa-\l_@@_prefix_str-\int_use:N\g_@@_line_int-l,
alias = {\tl_if_empty:NF \l_@@_name_tl
{\l_@@_name_tl-\int_use:N\g_@@_line_int-l}} ] {} ;
\hfil
\tikz [remember~picture,overlay]
\node [@@_node_style,
name = wa-\l_@@_prefix_str-\int_use:N\g_@@_line_int-r,
alias = {\tl_if_empty:NF \l_@@_name_tl
{\l_@@_name_tl-\int_use:N\g_@@_line_int-r}} ] {} ;
\bool_if:NT \l_@@_shownodenames_bool
{\hbox_overlap_right:n {\small wa-\l_@@_prefix_str
-\int_use:N\g_@@_line_int}}
& ##
\tabskip = \c_zero_skip
&& \msg_error:nn {witharrows} {Third~column~in~an~environment~{DispWithArrows}}
\if_false: ## \fi:
\cr}
{ \\
\egroup
\unskip\unpenalty\unskip\unpenalty
\box_set_to_last:N \l_tmpa_box
\nointerlineskip
\box_use:N \l_tmpa_box
\dim_gzero_new:N \g_@@_alignment_dim
\dim_gset:Nn \g_@@_alignment_dim {\box_wd:N \l_tmpa_box}
\box_clear_new:N \l_@@_new_box
\hbox_set:Nn \l_@@_new_box {\hbox_unpack_clear:N \l_tmpa_box}
\dim_compare:nNnT {\box_wd:N \l_@@_new_box} < \g_@@_alignment_dim
{\dim_gset:Nn \g_@@_alignment_dim {\box_wd:N \l_@@_new_box}}
\vcoffin_set_end:
\hbox_to_wd:nn \displaywidth
{
\bool_if:NTF \l_@@_fleqn_bool
{\skip_horizontal:n \l_@@_mathindent_dim}
{\hfil}
\hbox_to_wd:nn \g_@@_alignment_dim
{ \box_use_drop:N \l_@@_left_part_box
\dim_set:Nn \l_tmpa_dim { \box_ht:N \l_@@_halign_coffin
+ \box_dp:N \l_@@_halign_coffin}
$\left\{ \vcenter to \l_tmpa_dim {\vfil} \right.$}
\hfil}
\coffin_typeset:Nnnnn \l_@@_halign_coffin {l} {vc} {-\displaywidth} \c_zero_dim
$$
\_@@_post_environment:
\bool_if:nT \c_@@_mathtools_loaded_bool
{\MH_if_boolean:nT {show_only_refs}
\MT_showonlyrefs_true:}
\ignorespacesafterend
}
% \end{macrocode}
%
% \section{History}
%
% \subsection{Changes between versions 1.0 and 1.1}
%
% Option for the command |\\| and option |interline|
%
% Compatibility with |\usetikzlibrary{babel}|
%
% Possibility of nested environments |{WithArrows}|
%
% Better error messages
%
% Creation of a \textsc{dtx} file
%
% \subsection{Changes between versions 1.1 and 1.2}
%
% The package \pkg{witharrows} can now be loaded without having loaded previously \pkg{tikz} and the libraries
% |arrow.meta| and |bending| (this extension and these libraries are loaded silently by \pkg{witharrows}).
%
% New option |groups| (with a \emph{s})
%
% Better error messages
%
% \subsection{Changes between versions 1.2 and 1.3}
%
% New options |ygap| and |ystart| for fine tuning.
%
% Minor bugs.
%
% \subsection{Changes between versions 1.3 and 1.4}
%
% The package \pkg{footnote} is no longer loaded by default. Instead, two options |footnote| and |footnotehyper| have
% been added. In particular, \pkg{witharrows} becomes compatible with \cls{beamer}.
%
% \subsection{Changes between versions 1.4 and 1.5}
%
% The Tikz code used to draw the arrows can be changed with the option |TikzCode|.
%
% Two new options |CodeBefore| and |CodeAfter| have been added at the environment level.
%
% A special version of |\Arrow| is available in |CodeAfter| in order to draw arrows in nested environments.
%
% A command |\MultiArrow| is available in |CodeAfter| to draw arrows of other shapes.
%
% \subsection{Changes between versions 1.5 and 1.6}
%
% The code has been improved to be faster and the Tikz library |calc| is no longer required.
%
% A new option |name| is available for the environments |{WithArrows}|.
%
% \subsubsection{Changes between 1.6 and 1.6.1}
%
% Correction of a bug that leads to incompatibility with |\usetikzlibrary{babel}|.
%
% \subsection{Changes between 1.6.1 and 1.7}
%
% New environments |{DispWithArrows}| and |{DispWithArrows*}|.
%
% \subsection{Changes between 1.7 and 1.8}
%
% The numbers and tags of the environment |{DispWithArrows}| are now compatible with all the major LaTeX packages
% concerning references (\pkg{autonum}, \pkg{cleveref}, \pkg{fancyref}, \pkg{hyperref}, \pkg{prettyref},
% \pkg{refstyle}, \pkg{typedref} and \pkg{varioref}) and with the options |showonlyrefs| and |showmanualtags| of
% \pkg{mathtools}.
%
% \subsection{Changes between 1.8 and 1.9}
%
% New options |wrap-lines| for the environments |{DispWithArrows}| and |{DispWithArrows*}|.
% \endinput
%
% Local Variables:
% TeX-fold-mode: nil
% End:
|