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
|
//! Simple graphviz dot file format output.
use AttributeText::*;
use indexmap::IndexMap;
use std;
use std::borrow::{Cow};
use std::collections::HashMap;
use std::io;
use std::io::prelude::*;
static INDENT: &str = " ";
// TODO: support adding edge based on index of nodes?
// TODO: handle render options
// TODO: explicit attribute methods with type safety and enforce constraints
// i'm thinking we have NodeTraits/GraphTraits/EdgeTraits (what about none? is that a graph trait?)
// which will have default methods that use an associated type field called "state" or "attributes" etc
// TODO: implement Clone for Graph
// TODO: Node port and compass
// TODO: see if we can get any insights from Haskell implementation
// https://hackage.haskell.org/package/graphviz-2999.20.1.0/docs/Data-GraphViz-Attributes-Complete.html#t:Point
// - I like this: A summary of known current constraints/limitations/differences:
impl<'a> From<u32> for AttributeText<'a> {
fn from(v: u32) -> Self {
AttributeText::attr(v.to_string())
}
}
impl<'a> From<f32> for AttributeText<'a> {
fn from(v: f32) -> Self {
AttributeText::attr(v.to_string())
}
}
impl<'a> From<bool> for AttributeText<'a> {
fn from(v: bool) -> Self {
AttributeText::attr(v.to_string())
}
}
/// Most of this comes from core rust. Where to provide attribution?
/// The text for a graphviz label on a node or edge.
#[derive(Clone, PartialEq, Eq, Debug)]
pub enum AttributeText<'a> {
/// Preserves the text directly as is.
AttrStr(Cow<'a, str>),
/// This kind of label uses the graphviz label escString type:
/// <http://www.graphviz.org/doc/info/attrs.html#k:escString>
///
/// Occurrences of backslashes (`\`) are not escaped; instead they
/// are interpreted as initiating an escString escape sequence.
///
/// Escape sequences of particular interest: in addition to `\n`
/// to break a line (centering the line preceding the `\n`), there
/// are also the escape sequences `\l` which left-justifies the
/// preceding line and `\r` which right-justifies it.
EscStr(Cow<'a, str>),
/// This uses a graphviz [HTML string label][html].
/// The string is printed exactly as given, but between `<` and `>`.
/// **No escaping is performed.**
///
/// [html]: https://graphviz.org/doc/info/shapes.html#html
HtmlStr(Cow<'a, str>),
/// Preserves the text directly as is but wrapped in quotes.
///
/// Occurrences of backslashes (`\`) are escaped, and thus appear
/// as backslashes in the rendered label.
QuotedStr(Cow<'a, str>),
}
impl<'a> AttributeText<'a> {
pub fn attr<S: Into<Cow<'a, str>>>(s: S) -> AttributeText<'a> {
AttrStr(s.into())
}
pub fn escaped<S: Into<Cow<'a, str>>>(s: S) -> AttributeText<'a> {
EscStr(s.into())
}
pub fn html<S: Into<Cow<'a, str>>>(s: S) -> AttributeText<'a> {
HtmlStr(s.into())
}
pub fn quoted<S: Into<Cow<'a, str>>>(s: S) -> AttributeText<'a> {
QuotedStr(s.into())
}
fn escape_char<F>(c: char, mut f: F)
where
F: FnMut(char),
{
match c {
// not escaping \\, since Graphviz escString needs to
// interpret backslashes; see EscStr above.
'\\' => f(c),
_ => {
for c in c.escape_default() {
f(c)
}
}
}
}
fn escape_str(s: &str) -> String {
let mut out = String::with_capacity(s.len());
for c in s.chars() {
AttributeText::escape_char(c, |c| out.push(c));
}
out
}
/// Renders text as string suitable for a attribute in a .dot file.
/// This includes quotes or suitable delimiters.
pub fn to_dot_string(&self) -> String {
match *self {
AttrStr(ref s) => format!("{}", s),
EscStr(ref s) => format!("\"{}\"", AttributeText::escape_str(&s)),
HtmlStr(ref s) => format!("<{}>", s),
QuotedStr(ref s) => format!("\"{}\"", s.escape_default()),
}
}
/// Decomposes content into string suitable for making EscStr that
/// yields same content as self. The result obeys the law
/// render(`lt`) == render(`EscStr(lt.pre_escaped_content())`) for
/// all `lt: LabelText`.
fn pre_escaped_content(self) -> Cow<'a, str> {
match self {
AttrStr(s) => s,
EscStr(s) => s,
HtmlStr(s) => s,
QuotedStr(s) => {
if s.contains('\\') {
(&*s).escape_default().to_string().into()
} else {
s
}
}
}
}
/// Puts `prefix` on a line above this label, with a blank line separator.
pub fn prefix_line(self, prefix: AttributeText<'_>) -> AttributeText<'static> {
prefix.suffix_line(self)
}
/// Puts `suffix` on a line below this label, with a blank line separator.
pub fn suffix_line(self, suffix: AttributeText<'_>) -> AttributeText<'static> {
let mut prefix = self.pre_escaped_content().into_owned();
let suffix = suffix.pre_escaped_content();
prefix.push_str(r"\n\n");
prefix.push_str(&suffix);
EscStr(prefix.into())
}
}
// TODO: not sure we need this enum but should support setting nodeport either via
// headport / tailport attributes e.g. a -> b [tailport=se]
// or via edge declaration using the syntax node name:port_name e.g. a -> b:se
// aka compass
pub enum Compass {
N,
NE,
E,
SE,
S,
SW,
W,
NW,
None
}
impl<'a> From<Compass> for AttributeText<'a> {
fn from(compass: Compass) -> Self {
AttributeText::quoted(compass.dot_string())
}
}
impl<'a> DotString<'a> for Compass {
fn dot_string(&self) -> Cow<'a, str> {
match self {
Compass::N => "n".into(),
Compass::NE => "ne".into(),
Compass::E => "e".into(),
Compass::SE => "se".into(),
Compass::S => "s".into(),
Compass::SW => "sw".into(),
Compass::W => "w".into(),
Compass::NW => "nw".into(),
Compass::None => "".into(),
}
}
}
// TODO: probably dont need this struct and can move impl methods into lib module
pub struct Dot<'a> {
graph: Graph<'a>
//config: Config,
}
impl<'a> Dot<'a> {
/// Renders directed graph `g` into the writer `w` in DOT syntax.
/// (Simple wrapper around `render_opts` that passes a default set of options.)
//pub fn render<W>(self, g: Graph, w: &mut W) -> io::Result<()>
pub fn render<W>(self, w: &mut W) -> io::Result<()>
where
W: Write,
{
// TODO: use default_options?
self.render_opts(w, &[])
}
// io::Result<()> vs Result<(), Box<dyn Error>>
// https://doc.rust-lang.org/book/ch09-02-recoverable-errors-with-result.html#the--operator-can-be-used-in-functions-that-return-result
/// Renders directed graph `g` into the writer `w` in DOT syntax.
/// (Main entry point for the library.)
// pub fn render_opts<W>(self, graph: Graph, w: &mut W, options: &[RenderOption]) -> io::Result<()>
pub fn render_opts<W>(self, w: &mut W, options: &[RenderOption]) -> io::Result<()>
where
W: Write,
{
if let Some(comment) = &self.graph.comment {
// TODO: split comment into lines of 80 or so characters
writeln!(w, "// {}", comment)?;
}
let edge_op = &self.graph.edge_op();
let strict = if self.graph.strict { "strict " } else { "" };
write!(w, "{}{}", strict, &self.graph.graph_type())?;
if let Some(id) = &self.graph.id {
write!(w, " {}", id)?;
}
writeln!(w, " {{")?;
if let Some(graph_attributes) = self.graph.graph_attributes {
write!(w, "{}{}\n", INDENT, graph_attributes.to_dot_string())?;
}
if let Some(node_attributes) = self.graph.node_attributes {
write!(w, "{}{}\n", INDENT, node_attributes.to_dot_string())?;
}
if let Some(edge_attributes) = self.graph.edge_attributes {
write!(w, "{}{}\n", INDENT, edge_attributes.to_dot_string())?;
}
for n in self.graph.nodes {
// TODO: handle render options
// Are render options something we need?
// we could clone the node or and remove the attributes based on render options
// or maybe we keep a set of attributes to ignore based on the options
writeln!(w, "{}", n.to_dot_string())?;
}
for e in self.graph.edges {
write!(w, "{}", INDENT)?;
write!(w, "{} {} {}", e.source, edge_op, e.target)?;
// TODO: render ops
if !e.attributes.is_empty() {
write!(w, " [")?;
let mut iter = e.attributes.iter();
let first = iter.next().unwrap();
write!(w, "{}={}", first.0, first.1.to_dot_string())?;
for (key, value) in iter {
write!(w, ", ")?;
write!(w, "{}={}", key, value.to_dot_string())?;
}
write!(w, "]")?;
}
writeln!(w, ";")?;
}
writeln!(w, "}}")
}
}
/// `Dot` configuration.
///
/// This enum does not have an exhaustive definition (will be expanded)
#[derive(Debug, PartialEq, Eq)]
pub enum Config {
/// Use indices for node labels.
NodeIndexLabel,
/// Use indices for edge labels.
EdgeIndexLabel,
/// Use no edge labels.
EdgeNoLabel,
/// Use no node labels.
NodeNoLabel,
/// Do not print the graph/digraph string.
GraphContentOnly,
#[doc(hidden)]
_Incomplete(()),
}
#[derive(Hash, Eq, PartialEq, PartialOrd, Ord, Debug, Clone)]
pub enum AttributeType {
Graph,
Node,
Edge,
}
pub struct Graph<'a> {
pub id: Option<String>,
pub is_directed: bool,
pub strict: bool,
/// Comment added to the first line of the source.
pub comment: Option<String>,
pub graph_attributes: Option<GraphAttributeStatement<'a>>,
pub node_attributes: Option<NodeAttributeStatement<'a>>,
pub edge_attributes: Option<EdgeAttributeStatement<'a>>,
pub nodes: Vec<Node<'a>>,
pub edges: Vec<Edge<'a>>,
}
impl<'a> Graph<'a> {
pub fn new(
id: Option<String>,
is_directed: bool,
strict: bool,
comment: Option<String>,
graph_attributes: Option<GraphAttributeStatement<'a>>,
node_attributes: Option<NodeAttributeStatement<'a>>,
edge_attributes: Option<EdgeAttributeStatement<'a>>,
nodes: Vec<Node<'a>>,
edges: Vec<Edge<'a>>,
) -> Self {
Self {
id,
is_directed,
strict,
comment,
graph_attributes,
node_attributes,
edge_attributes,
nodes,
edges,
}
}
pub fn graph_type(&self) -> &'static str {
if self.is_directed {
"digraph"
} else {
"graph"
}
}
pub fn edge_op(&self) -> &'static str {
if self.is_directed {
"->"
} else {
"--"
}
}
}
pub struct GraphBuilder<'a> {
id: Option<String>,
is_directed: bool,
strict: bool,
graph_attributes: Option<GraphAttributeStatement<'a>>,
node_attributes: Option<NodeAttributeStatement<'a>>,
edge_attributes: Option<EdgeAttributeStatement<'a>>,
nodes: Vec<Node<'a>>,
edges: Vec<Edge<'a>>,
comment: Option<String>,
}
// TODO: id should be an escString
impl<'a> GraphBuilder<'a> {
pub fn new_directed(id: Option<String>) -> Self {
Self {
id,
is_directed: true,
strict: false,
graph_attributes: None,
node_attributes: None,
edge_attributes: None,
nodes: Vec::new(),
edges: Vec::new(),
comment: None,
}
}
pub fn new_undirected(id: Option<String>) -> Self {
Self {
id,
is_directed: false,
strict: false,
graph_attributes: None,
node_attributes: None,
edge_attributes: None,
nodes: Vec::new(),
edges: Vec::new(),
comment: None,
}
}
pub fn comment<S: Into<String>>(&mut self, comment: S) -> &mut Self {
self.comment = Some(comment.into());
self
}
pub fn add_graph_attributes(&mut self, graph_attributes: GraphAttributeStatement<'a>) -> &mut Self {
self.graph_attributes = Some(graph_attributes);
self
}
pub fn add_node_attributes(&mut self, node_attributes: NodeAttributeStatement<'a>) -> &mut Self {
self.node_attributes = Some(node_attributes);
self
}
pub fn add_edge_attributes(&mut self, edge_attributes: EdgeAttributeStatement<'a>) -> &mut Self {
self.edge_attributes = Some(edge_attributes);
self
}
// TODO: update to insert into appropriate statement or remove?
// pub fn add_attribute(
// &mut self,
// attribute_type: AttributeType,
// key: String, value: AttributeText<'a>
// ) -> &mut Self {
// self.get_attributes(attribute_type).insert(key, value);
// self
// }
//
// pub fn add_attributes(
// &mut self,
// attribute_type: AttributeType,
// attributes: HashMap<String, AttributeText<'a>>
// ) -> &mut Self {
// self.get_attributes(attribute_type).extend(attributes);
// self
// }
pub fn add_attribute(
&mut self,
attribute_type: AttributeType,
key: String,
value: AttributeText<'a>
) -> &mut Self {
match attribute_type {
AttributeType::Graph => {
if self.graph_attributes.is_none() {
self.graph_attributes = Some(GraphAttributeStatement::new());
}
self.graph_attributes.as_mut().unwrap().add_attribute(key, value);
},
AttributeType::Edge => {
if self.edge_attributes.is_none() {
self.edge_attributes = Some(EdgeAttributeStatement::new());
}
self.edge_attributes.as_mut().unwrap().add_attribute(key, value);
},
AttributeType::Node => {
if self.node_attributes.is_none() {
self.node_attributes = Some(NodeAttributeStatement::new());
}
self.node_attributes.as_mut().unwrap().add_attribute(key, value);
},
}
self
}
pub fn add_node(&mut self, node: Node<'a>) -> &mut Self {
self.nodes.push(node);
self
}
pub fn add_edge(&mut self, edge: Edge<'a>) -> &mut Self {
self.edges.push(edge);
self
}
pub fn strict(&mut self) -> &mut Self {
self.strict = true;
self
}
pub fn build(&self) -> Graph<'a> {
Graph {
id: self.id.to_owned(),
is_directed: self.is_directed,
strict: self.strict,
comment: self.comment.clone(), // TODO: is clone the only option here?
graph_attributes: self.graph_attributes.clone(),
node_attributes: self.node_attributes.clone(),
edge_attributes: self.edge_attributes.clone(),
nodes: self.nodes.clone(), // TODO: is clone the only option here?
edges: self.edges.clone(), // TODO: is clone the only option here?
}
}
}
pub trait GraphAttributes<'a> {
fn background(&mut self, background: String) -> &mut Self {
self.add_attribute("_background", AttributeText::attr(background))
}
/// The color used as the background for entire canvas.
fn background_color(&mut self, background_color: Color) -> &mut Self {
self.add_attribute("bgcolor", AttributeText::quoted(background_color.to_dot_string()))
}
// TODO: constrain
/// The color used as the background for entire canvas with a gradient fill.
/// A colon-separated list of weighted color values: WC(:WC)* where each WC has the form C(;F)?
/// with C a color value and the optional F a floating-point number, 0 ≤ F ≤ 1.
/// The sum of the floating-point numbers in a colorList must sum to at most 1.
fn background_colorlist(&mut self, background_colors: ColorList<'a>) -> &mut Self {
self.add_attribute("bgcolor", AttributeText::from(background_colors))
}
/// Type: rect which is "%f,%f,%f,%f"
/// The rectangle llx,lly,urx,ury gives the coordinates, in points, of the lower-left corner (llx,lly)
/// and the upper-right corner (urx,ury).
fn bounding_box(&mut self, bounding_box: String) -> &mut Self {
self.add_attribute("bb", AttributeText::quoted(bounding_box))
}
/// If true, the drawing is centered in the output canvas.
fn center(&mut self, center: bool) -> &mut Self {
self.add_attribute("center", AttributeText::from(center))
}
/// Specifies the character encoding used when interpreting string input as a text label.
fn charset(&mut self, charset: String) -> &mut Self {
self.add_attribute("charset", AttributeText::quoted(charset))
}
/// Classnames to attach to the node, edge, graph, or cluster’s SVG element.
/// Combine with stylesheet for styling SVG output using CSS classnames.
/// Multiple space-separated classes are supported.
fn class(&mut self, class: String) -> &mut Self {
Attributes::class(self.get_attributes_mut(), class);
self
}
/// Mode used for handling clusters.
/// If clusterrank=local, a subgraph whose name begins with cluster is given special treatment.
/// The subgraph is laid out separately, and then integrated as a unit into its parent graph,
/// with a bounding rectangle drawn about it.
/// If the cluster has a label parameter, this label is displayed within the rectangle.
/// Note also that there can be clusters within clusters.
/// The modes clusterrank=global and clusterrank=none appear to be identical, both turning off the special cluster processing.
fn cluster_rank(&mut self, cluster_rank: ClusterMode) -> &mut Self {
self.add_attribute("clusterrank", AttributeText::from(cluster_rank))
}
/// This attribute specifies a color scheme namespace: the context for interpreting color names.
/// In particular, if a color value has form "xxx" or "//xxx", then the color xxx will be evaluated
/// according to the current color scheme. If no color scheme is set, the standard X11 naming is used.
/// For example, if colorscheme=bugn9, then color=7 is interpreted as color="/bugn9/7".
fn color_scheme(&mut self, color_scheme: String) -> &mut Self {
Attributes::color_scheme(self.get_attributes_mut(), color_scheme);
self
}
/// Comments are inserted into output. Device-dependent
fn comment(&mut self, comment: String) -> &mut Self {
Attributes::comment(self.get_attributes_mut(), comment);
self
}
fn compound(&mut self, compound: String) -> &mut Self {
self.add_attribute("compound", AttributeText::quoted(compound))
}
fn concentrate(&mut self, concentrate: String) -> &mut Self {
self.add_attribute("concentrate", AttributeText::quoted(concentrate))
}
/// Specifies the expected number of pixels per inch on a display device.
/// Also known as resolution
fn dpi(&mut self, dpi: f32) -> &mut Self {
self.add_attribute("dpi", AttributeText::from(dpi))
}
/// Color used to fill the background of a node or cluster assuming style=filled, or a filled arrowhead.
fn fill_color(&mut self, fill_color: Color<'a>) -> &mut Self {
Attributes::fill_color(self.get_attributes_mut(), fill_color);
self
}
/// Color used to fill the background, with a gradient, of a node or cluster assuming
/// style=filled, or a filled arrowhead.
fn fill_color_with_colorlist(&mut self, fill_colors: ColorList<'a>) -> &mut Self {
Attributes::fill_color_with_colorlist(self.get_attributes_mut(), fill_colors);
self
}
/// Color used to fill the background, with a gradient, of a node or cluster assuming
/// style=filled, or a filled arrowhead.
/// TODO: example
/// [crate::GraphAttributes::dpi]
fn fill_color_with_iter<I>(&mut self, fill_colors: I) -> &mut Self
where
I: IntoIterator,
I::Item: IntoWeightedColor<'a>,
{
Attributes::fill_color_with_iter(self.get_attributes_mut(), fill_colors);
self
}
/// Color used for text.
fn font_color(&mut self, font_color: Color<'a>) -> &mut Self {
Attributes::font_color(self.get_attributes_mut(), font_color);
self
}
/// Font used for text.
fn font_name(&mut self, font_name: String) -> &mut Self {
Attributes::font_name(self.get_attributes_mut(), font_name);
self
}
fn font_names(&mut self, font_names: String) -> &mut Self {
self.add_attribute("fontnames", AttributeText::quoted(font_names))
}
fn font_path(&mut self, font_path: String) -> &mut Self {
self.add_attribute("fontpath", AttributeText::quoted(font_path))
}
// TODO: constrain
/// Font size, in points, used for text.
/// default: 14.0, minimum: 1.0
fn font_size(&mut self, font_size: f32) -> &mut Self {
Attributes::font_size(self.get_attributes_mut(), font_size);
self
}
fn force_label(&mut self, force_label: bool) -> &mut Self {
self.add_attribute("forcelabel", AttributeText::from(force_label))
}
/// If a gradient fill is being used, this determines the angle of the fill.
fn gradient_angle(&mut self, gradient_angle: u32) -> &mut Self {
Attributes::gradient_angle(self.get_attributes_mut(), gradient_angle);
self
}
fn image_path(&mut self, image_path: String) -> &mut Self {
self.add_attribute("imagepath", AttributeText::escaped(image_path))
}
/// An escString or an HTML label.
fn label(&mut self, label: String) -> &mut Self {
Attributes::label(self.get_attributes_mut(), label);
self
}
/// If labeljust=r, the label is right-justified within bounding rectangle
/// If labeljust=l, left-justified
/// Else the label is centered.
fn label_justification(&mut self, label_justification: LabelJustification) -> &mut Self {
self.add_attribute("labeljust", AttributeText::from(label_justification))
}
// Vertical placement of labels for nodes, root graphs and clusters.
// For graphs and clusters, only labelloc=t and labelloc=b are allowed, corresponding to
// placement at the top and bottom, respectively.
// By default, root graph labels go on the bottom and cluster labels go on the top.
// Note that a subgraph inherits attributes from its parent. Thus, if the root graph sets
// labelloc=b, the subgraph inherits this value.
// For nodes, this attribute is used only when the height of the node is larger than the height
// of its label.
// If labelloc=t, labelloc=c, labelloc=b, the label is aligned with the top, centered, or
// aligned with the bottom of the node, respectively.
// By default, the label is vertically centered.
fn label_location(&mut self, label_location: LabelLocation) -> &mut Self {
Attributes::label_location(self.get_attributes_mut(), label_location);
self
}
fn landscape(&mut self, landscape: bool) -> &mut Self {
self.add_attribute("landscape", AttributeText::from(landscape))
}
/// Specifies the separator characters used to split an attribute of type layerRange into a list of ranges.
fn layer_list_sep(&mut self, layer_list_sep: String) -> &mut Self {
self.add_attribute("layerlistsep", AttributeText::attr(layer_list_sep))
}
/// Specifies a linearly ordered list of layer names attached to the graph
/// The graph is then output in separate layers.
/// Only those components belonging to the current output layer appear.
fn layers(&mut self, layers: String) -> &mut Self {
Attributes::layer(self.get_attributes_mut(), layers);
self
}
/// Selects a list of layers to be emitted.
fn layer_select(&mut self, layer_select: String) -> &mut Self {
self.add_attribute("layerselect", AttributeText::attr(layer_select))
}
/// Specifies the separator characters used to split the layers attribute into a list of layer names.
/// default: ":\t "
fn layer_sep(&mut self, layer_sep: String) -> &mut Self {
self.add_attribute("layersep", AttributeText::attr(layer_sep))
}
/// Height of graph or cluster label, in inches.
fn lheight(&mut self, lheight: f32) -> &mut Self {
self.add_attribute("lheight", AttributeText::from(lheight))
}
// TODO: I dont understand this...
/// "%f,%f('!')?" representing the point (x,y). The optional '!' indicates the node position should not change (input-only).
/// If dim=3, point may also have the format "%f,%f,%f('!')?" to represent the point (x,y,z).
fn lp(&mut self, lp: String) -> &mut Self {
Attributes::lp(self.get_attributes_mut(), lp);
self
}
/// Width of graph or cluster label, in inches.
fn lwidth(&mut self, lwidth: f32) -> &mut Self {
self.add_attribute("lwidth", AttributeText::from(lwidth))
}
/// For graphs, this sets x and y margins of canvas, in inches.
/// If the margin is a single double, both margins are set equal to the given value.
/// Note that the margin is not part of the drawing but just empty space left around the drawing.
/// The margin basically corresponds to a translation of drawing, as would be necessary to
/// center a drawing on a page.
/// Nothing is actually drawn in the margin. To actually extend the background of a drawing,
/// see the pad attribute.
/// For clusters, margin specifies the space between the nodes in the cluster and the cluster
/// bounding box. By default, this is 8 points.
/// For nodes, this attribute specifies space left around the node’s label.
/// By default, the value is 0.11,0.055.
fn margin(&mut self, margin: f32) -> &mut Self {
Attributes::margin(self.get_attributes_mut(), margin);
self
}
fn margin_point(&mut self, margin: Point) -> &mut Self {
Attributes::margin_point(self.get_attributes_mut(), margin);
self
}
/// Multiplicative scale factor used to alter the MinQuit (default = 8) and
/// MaxIter (default = 24) parameters used during crossing minimization.
/// These correspond to the number of tries without improvement before quitting and the
/// maximum number of iterations in each pass.
fn mclimit(&mut self, mclimit: f32) -> &mut Self {
self.add_attribute("mclimit", AttributeText::from(mclimit))
}
/// Specifies the minimum separation between all nodes.
fn mindist(&mut self, mindist: u32) -> &mut Self {
self.add_attribute("mindist", AttributeText::from(mindist))
}
/// Whether to use a single global ranking, ignoring clusters.
/// The original ranking algorithm in dot is recursive on clusters.
/// This can produce fewer ranks and a more compact layout, but sometimes at the cost of a
/// head node being place on a higher rank than the tail node.
/// It also assumes that a node is not constrained in separate, incompatible subgraphs.
/// For example, a node cannot be in a cluster and also be constrained by rank=same with
/// a node not in the cluster.
/// This allows nodes to be subject to multiple constraints.
/// Rank constraints will usually take precedence over edge constraints.
fn newrank(&mut self, newrank: bool) -> &mut Self {
self.add_attribute("newrank", AttributeText::from(newrank))
}
// TODO: add constraint
/// specifies the minimum space between two adjacent nodes in the same rank, in inches.
/// default: 0.25, minimum: 0.02
fn nodesep(&mut self, nodesep: f32) -> &mut Self {
self.add_attribute("nodesep", AttributeText::from(nodesep))
}
/// By default, the justification of multi-line labels is done within the largest context that makes sense.
/// Thus, in the label of a polygonal node, a left-justified line will align with the left side
/// of the node (shifted by the prescribed margin).
/// In record nodes, left-justified line will line up with the left side of the enclosing column
/// of fields.
/// If nojustify=true, multi-line labels will be justified in the context of itself.
/// For example, if nojustify is set, the first label line is long, and the second is shorter
/// and left-justified,
/// the second will align with the left-most character in the first line, regardless of how
/// large the node might be.
fn no_justify(&mut self, no_justify: bool) -> &mut Self {
Attributes::no_justify(self.get_attributes_mut(), no_justify);
self
}
/// Sets number of iterations in network simplex applications.
/// nslimit is used in computing node x coordinates.
/// If defined, # iterations = nslimit * # nodes; otherwise, # iterations = MAXINT.
fn nslimit(&mut self, nslimit: f32) -> &mut Self {
self.add_attribute("nslimit", AttributeText::from(nslimit))
}
/// If ordering="out", then the outedges of a node, that is, edges with the node as its tail
/// node, must appear left-to-right in the same order in which they are defined in the input.
///
/// If ordering="in", then the inedges of a node must appear left-to-right in the same order in
/// which they are defined in the input.
///
/// If defined as a graph or subgraph attribute, the value is applied to all nodes in the graph
/// or subgraph.
///
/// Note that the graph attribute takes precedence over the node attribute.
fn ordering(&mut self, ordering: Ordering) -> &mut Self {
Attributes::ordering(self.get_attributes_mut(), ordering);
self
}
// TODO: constrain to 0 - 360. Docs say min is 360 which should be max right?
/// When used on nodes: Angle, in degrees, to rotate polygon node shapes.
/// For any number of polygon sides, 0 degrees rotation results in a flat base.
/// When used on graphs: If "[lL]*", sets graph orientation to landscape.
/// Used only if rotate is not defined.
/// Default: 0.0 and minimum: 360.0
fn orientation(&mut self, orientation: f32) -> &mut Self {
Attributes::orientation(self.get_attributes_mut(), orientation);
self
}
/// Specify order in which nodes and edges are drawn.
/// default: breadthfirst
fn output_order(&mut self, output_order: OutputMode) -> &mut Self {
self.add_attribute("outputorder", AttributeText::from(output_order))
}
/// Whether each connected component of the graph should be laid out separately, and then the
/// graphs packed together.
/// If false, the entire graph is laid out together.
/// The granularity and method of packing is influenced by the packmode attribute.
fn pack(&mut self, pack: bool) -> &mut Self {
self.add_attribute("pack", AttributeText::from(pack))
}
// TODO: constrain to non-negative integer.
/// Whether each connected component of the graph should be laid out separately, and then
/// the graphs packed together.
/// This is used as the size, in points,of a margin around each part; otherwise, a default
/// margin of 8 is used.
/// pack is treated as true if the value of pack iso a non-negative integer.
fn pack_int(&mut self, pack: u32) -> &mut Self {
self.add_attribute("pack", AttributeText::from(pack))
}
/// This indicates how connected components should be packed (cf. packMode).
/// Note that defining packmode will automatically turn on packing as though one had set pack=true.
fn pack_mode(&mut self, pack_mode: PackMode) -> &mut Self {
self.add_attribute("packmode", AttributeText::from(pack_mode))
}
/// Specifies how much, in inches, to extend the drawing area around the minimal area needed
/// to draw the graph.
/// Both the x and y pad values are set equal to the given value.
/// This area is part of the drawing and will be filled with the background color, if appropriate.
/// default: 0.0555
fn pad(&mut self, pad: f32) -> &mut Self {
self.add_attribute("pad", AttributeText::from(pad))
}
/// Specifies how much, in inches, to extend the drawing area around the minimal area needed to
/// draw the graph.
fn pad_point(&mut self, pad: Point) -> &mut Self {
self.add_attribute("pad", AttributeText::from(pad))
}
/// Width and height of output pages, in inches.
/// Value given is used for both the width and height.
fn page(&mut self, page: f32) -> &mut Self {
self.add_attribute("page", AttributeText::from(page))
}
/// Width and height of output pages, in inches.
fn page_point(&mut self, page: Point) -> &mut Self {
self.add_attribute("page", AttributeText::from(page))
}
/// The order in which pages are emitted.
/// Used only if page is set and applicable.
/// Limited to one of the 8 row or column major orders.
fn page_dir(&mut self, page_dir: PageDirection) -> &mut Self {
self.add_attribute("pagedir", AttributeText::from(page_dir))
}
// TODO: constrain
/// If quantum > 0.0, node label dimensions will be rounded to integral multiples of the quantum.
/// default: 0.0, minimum: 0.0
fn quantum(&mut self, quantum: f32) -> &mut Self {
self.add_attribute("quantum", AttributeText::from(quantum))
}
/// Sets direction of graph layout.
/// For example, if rankdir="LR", and barring cycles, an edge T -> H; will go from left to right.
/// By default, graphs are laid out from top to bottom.
/// This attribute also has a side-effect in determining how record nodes are interpreted.
/// See record shapes.
fn rank_dir(&mut self, rank_dir: RankDir) -> &mut Self {
self.add_attribute("rankdir", AttributeText::from(rank_dir))
}
/// sets the desired rank separation, in inches.
/// This is the minimum vertical distance between the bottom of the nodes in one rank
/// and the tops of nodes in the next. If the value contains equally,
/// the centers of all ranks are spaced equally apart.
/// Note that both settings are possible, e.g., ranksep="1.2 equally".
fn rank_sep(&mut self, rank_sep: String) -> &mut Self {
self.add_attribute("ranksep", AttributeText::attr(rank_sep))
}
/// Sets the aspect ratio (drawing height/drawing width) for the drawing.
/// Note that this is adjusted before the size attribute constraints are enforced.
fn ratio(&mut self, ratio: Ratio) -> &mut Self {
self.add_attribute("ratio", AttributeText::from(ratio))
}
/// If true and there are multiple clusters, run crossing minimization a second time.
fn remincross(&mut self, remincross: bool) -> &mut Self {
self.add_attribute("remincross", AttributeText::from(remincross))
}
/// If rotate=90, sets drawing orientation to landscape.
fn rotate(&mut self, rotate: u32) -> &mut Self {
self.add_attribute("rotate", AttributeText::from(rotate))
}
// TODO: constrain
/// Print guide boxes in PostScript at the beginning of routesplines if showboxes=1, or at
/// the end if showboxes=2.
/// (Debugging, TB mode only!)
/// default: 0, minimum: 0
fn show_boxes(&mut self, show_boxes: u32) -> &mut Self {
Attributes::show_boxes(self.get_attributes_mut(), show_boxes);
self
}
/// Maximum width and height of drawing, in inches.
/// Value used for both the width and the height.
/// If defined and the drawing is larger than the given size, the drawing
/// is uniformly scaled down so that it fits within the given size.
/// If desired_min is true, and both both dimensions of the drawing
/// are less than size, the drawing is scaled up uniformly until at
/// least one dimension equals its dimension in size.
fn size(&mut self, size: u32, desired_min: bool) -> &mut Self {
let mut text = format!("{}", size);
if desired_min {
text.push_str("!");
}
self.add_attribute("size", AttributeText::attr(text))
}
// TODO: both point and desired_min have an '!' which doesnt seem correct.
// I think point should be the thing that drives it and dont need desired_min
/// Maximum width and height of drawing, in inches.
/// If defined and the drawing is larger than the given size, the drawing
/// is uniformly scaled down so that it fits within the given size.
/// If desired_min is true, and both both dimensions of the drawing
/// are less than size, the drawing is scaled up uniformly until at
/// least one dimension equals its dimension in size.
fn size_point(&mut self, size: Point, desired_min: bool) -> &mut Self {
let mut text = format!("{}", size.dot_string());
if desired_min {
text.push_str("!");
}
self.add_attribute("size", AttributeText::attr(text))
}
/// If packmode indicates an array packing, sortv specifies an insertion order
/// among the components, with smaller values inserted first.
/// default: 0, minimum: 0
fn sortv(&mut self, sortv: u32) -> &mut Self {
Attributes::sortv(self.get_attributes_mut(), sortv);
self
}
/// Controls how, and if, edges are represented.
fn splines(&mut self, splines: Splines) -> &mut Self {
self.add_attribute("splines", AttributeText::from(splines))
}
/// Set style information for components of the graph.
fn style(&mut self, style: GraphStyle) -> &mut Self {
Attributes::style(self.get_attributes_mut(), Styles::Graph(style));
self
}
/// A URL or pathname specifying an XML style sheet, used in SVG output.
/// Combine with class to style elements using CSS selectors.
fn stylesheet(&mut self, stylesheet: String) -> &mut Self {
self.add_attribute("stylesheet", AttributeText::attr(stylesheet))
}
/// If the object has a URL, this attribute determines which window of the browser is used for the URL.
fn target(&mut self, target: String) -> &mut Self {
Attributes::target(self.get_attributes_mut(), target);
self
}
/// Whether internal bitmap rendering relies on a truecolor color model or uses a color palette.
/// If truecolor is unset, truecolor is not used unless there is a shapefile property for some node in the graph. The output model will use the input model when possible.
fn true_color(&mut self, true_color: bool) -> &mut Self {
self.add_attribute("truecolor", AttributeText::from(true_color))
}
/// Hyperlinks incorporated into device-dependent output.
fn url(&mut self, url: String) -> &mut Self {
Attributes::url(self.get_attributes_mut(), url);
self
}
// TODO: add a ViewPort Struct?
/// Clipping window on final drawing.
/// viewport supersedes any size attribute.
/// The width and height of the viewport specify precisely the final size of the output.
/// The viewPort W,H,Z,x,y or W,H,Z,N specifies a viewport for the final image.
/// The pair (W,H) gives the dimensions (width and height) of the final image, in points.
/// The optional Z is the zoom factor, i.e., the image in the original layout will be W/Z by H/Z points in size. By default, Z is 1.
/// The optional last part is either a pair (x,y) giving a position in the original layout of the graph,
/// in points, of the center of the viewport, or the name N of a node whose center should used as the focus.
fn viewport(&mut self, viewport: String) -> &mut Self {
self.add_attribute("viewport", AttributeText::attr(viewport))
}
/// Add an attribute to the node.
fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self;
/// Add multiple attributes to the node.
fn add_attributes(&'a mut self, attributes: HashMap<String, AttributeText<'a>>) -> &mut Self;
fn get_attributes_mut(&mut self) -> &mut IndexMap<String, AttributeText<'a>>;
}
impl<'a> GraphAttributes<'a> for GraphAttributeStatementBuilder<'a> {
fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self {
self.attributes.insert(key.into(), value);
self
}
/// Add multiple attributes to the node.
fn add_attributes(&'a mut self, attributes: HashMap<String, AttributeText<'a>>) -> &mut Self {
self.attributes.extend(attributes);
self
}
fn get_attributes_mut(&mut self) -> &mut IndexMap<String, AttributeText<'a>> {
&mut self.attributes
}
}
// I'm not a huge fan of needing this builder but having a hard time getting around &mut without it
pub struct GraphAttributeStatementBuilder<'a> {
pub attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> GraphAttributeStatementBuilder<'a> {
pub fn new() -> Self {
Self {
attributes: IndexMap::new(),
}
}
pub fn build(&self) -> GraphAttributeStatement<'a> {
GraphAttributeStatement {
attributes: self.attributes.clone(),
}
}
}
#[derive(Clone, Debug)]
pub struct GraphAttributeStatement<'a> {
pub attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> GraphAttributeStatement<'a> {
pub fn new() -> Self {
Self {
attributes: IndexMap::new(),
}
}
pub fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self {
self.attributes.insert(key.into(), value);
self
}
}
impl<'a> AttributeStatement<'a> for GraphAttributeStatement<'a> {
fn get_attribute_statement_type(&self) -> &'static str {
"graph"
}
fn get_attributes(&self) -> &IndexMap<String, AttributeText<'a>> {
&self.attributes
}
}
pub enum ClusterMode {
Local,
Global,
None
}
impl<'a> From<ClusterMode> for AttributeText<'a> {
fn from(mode: ClusterMode) -> Self {
AttributeText::quoted(mode.dot_string())
}
}
impl<'a> DotString<'a> for ClusterMode {
fn dot_string(&self) -> Cow<'a, str> {
match self {
ClusterMode::Local => "local".into(),
ClusterMode::Global => "global".into(),
ClusterMode::None => "none".into(),
}
}
}
pub enum Ratio {
Aspect(f32),
Fill,
Compress,
Expand,
Auto,
}
impl<'a> From<Ratio> for AttributeText<'a> {
fn from(ratio: Ratio) -> Self {
match ratio {
Ratio::Aspect(_aspect) => AttributeText::attr(ratio.dot_string()),
_ => AttributeText::quoted(ratio.dot_string()),
}
}
}
impl<'a> DotString<'a> for Ratio {
fn dot_string(&self) -> Cow<'a, str> {
match self {
Ratio::Aspect(aspect) => aspect.to_string().into(),
Ratio::Fill => "fill".into(),
Ratio::Compress => "compress".into(),
Ratio::Expand => "expand".into(),
Ratio::Auto => "auto".into(),
}
}
}
trait DotString<'a> {
fn dot_string(&self) -> Cow<'a, str>;
}
pub enum LabelJustification {
Left,
Right,
Center
}
impl<'a> From<LabelJustification> for AttributeText<'a> {
fn from(label_justification: LabelJustification) -> Self {
AttributeText::attr(label_justification.dot_string())
}
}
impl<'a> DotString<'a> for LabelJustification {
fn dot_string(&self) -> Cow<'a, str> {
match self {
LabelJustification::Left => "l".into(),
LabelJustification::Right => "r".into(),
LabelJustification::Center => "c".into(),
}
}
}
pub enum LabelLocation {
Top,
Center,
Bottom
}
impl<'a> From<LabelLocation> for AttributeText<'a> {
fn from(label_location: LabelLocation) -> Self {
AttributeText::attr(label_location.dot_string())
}
}
impl<'a> DotString<'a> for LabelLocation {
fn dot_string(&self) -> Cow<'a, str> {
match self {
LabelLocation::Top => "t".into(),
LabelLocation::Center => "c".into(),
LabelLocation::Bottom => "b".into(),
}
}
}
pub enum Ordering {
In,
Out,
}
impl<'a> From<Ordering> for AttributeText<'a> {
fn from(ordering: Ordering) -> Self {
AttributeText::quoted(ordering.dot_string())
}
}
impl<'a> DotString<'a> for Ordering {
fn dot_string(&self) -> Cow<'a, str> {
match self {
Ordering::In => "in".into(),
Ordering::Out => "out".into(),
}
}
}
/// These specify the order in which nodes and edges are drawn in concrete output.
///
/// The default "breadthfirst" is the simplest, but when the graph layout does not avoid edge-node
/// overlap, this mode will sometimes have edges drawn over nodes and sometimes on top of nodes.
///
/// If the mode "nodesfirst" is chosen, all nodes are drawn first, followed by the edges.
/// This guarantees an edge-node overlap will not be mistaken for an edge ending at a node.
///
/// On the other hand, usually for aesthetic reasons, it may be desirable that all edges appear
/// beneath nodes, even if the resulting drawing is ambiguous.
/// This can be achieved by choosing "edgesfirst".
pub enum OutputMode {
BreadthFirst,
NodesFirst,
EdgesFirst,
}
impl<'a> From<OutputMode> for AttributeText<'a> {
fn from(mode: OutputMode) -> Self {
AttributeText::quoted(mode.dot_string())
}
}
impl<'a> DotString<'a> for OutputMode {
fn dot_string(&self) -> Cow<'a, str> {
match self {
OutputMode::BreadthFirst => "breadthfirst".into(),
OutputMode::NodesFirst => "nodesfirst".into(),
OutputMode::EdgesFirst => "edgesfirst".into(),
}
}
}
/// The modes "node", "clust" or "graph" specify that the components should be packed together
/// tightly, using the specified granularity.
pub enum PackMode {
/// causes packing at the node and edge level, with no overlapping of these objects.
/// This produces a layout with the least area, but it also allows interleaving,
/// where a node of one component may lie between two nodes in another component.
Node,
/// guarantees that top-level clusters are kept intact.
/// What effect a value has also depends on the layout algorithm.
Cluster,
/// does a packing using the bounding box of the component.
/// Thus, there will be a rectangular region around a component free of elements of any other component.
Graph,
// TODO: array - "array(_flags)?(%d)?"
}
impl<'a> From<PackMode> for AttributeText<'a> {
fn from(mode: PackMode) -> Self {
AttributeText::quoted(mode.dot_string())
}
}
impl<'a> DotString<'a> for PackMode {
fn dot_string(&self) -> Cow<'a, str> {
match self {
PackMode::Node => "node".into(),
PackMode::Cluster => "clust".into(),
PackMode::Graph => "graph".into(),
}
}
}
// The optional '!' indicates the node position should not change (input-only).
pub struct Point {
pub x: f32,
pub y: f32,
pub z: Option<f32>,
/// specify that the node position should not change.
pub force_pos: bool,
}
impl Point {
pub fn new_2d(x: f32, y: f32, force_pos: bool) -> Self {
Self {
x,
y,
z: None,
force_pos,
}
}
pub fn new_3d(x: f32, y: f32, z: f32, force_pos: bool) -> Self {
Self {
x,
y,
z: Some(z),
force_pos,
}
}
}
impl<'a> From<Point> for AttributeText<'a> {
fn from(point: Point) -> Self {
AttributeText::quoted(point.dot_string())
}
}
impl<'a> DotString<'a> for Point {
fn dot_string(&self) -> Cow<'a, str> {
let mut slice = format!("{:.1},{:.1}", self.x, self.y);
if self.z.is_some() {
slice.push_str(format!(",{:.1}", self.z.unwrap()).as_str());
}
if self.force_pos {
slice.push_str("!")
}
slice.into()
}
}
/// These specify the 8 row or column major orders for traversing a rectangular array,
/// the first character corresponding to the major order and the second to the minor order.
/// Thus, for “BL”, the major order is from bottom to top, and the minor order is from left to right.
/// This means the bottom row is traversed first, from left to right, then the next row up,
/// from left to right, and so on, until the topmost row is traversed
pub enum PageDirection {
BottomLeft,
BottomRight,
TopLeft,
TopRight,
RightBottom,
RightTop,
LeftBottom,
LeftTop,
}
impl<'a> From<PageDirection> for AttributeText<'a> {
fn from(page_direction: PageDirection) -> Self {
AttributeText::attr(page_direction.dot_string())
}
}
impl<'a> DotString<'a> for PageDirection {
fn dot_string(&self) -> Cow<'a, str> {
match self {
PageDirection::BottomLeft => "BL".into(),
PageDirection::BottomRight => "BR".into(),
PageDirection::TopLeft => "TL".into(),
PageDirection::TopRight => "TR".into(),
PageDirection::RightBottom => "RB".into(),
PageDirection::RightTop => "RT".into(),
PageDirection::LeftBottom => "LB".into(),
PageDirection::LeftTop => "LT".into(),
}
}
}
/// Corresponding to directed graphs drawn from top to bottom, from left to right,
/// from bottom to top, and from right to left, respectively.
pub enum RankDir {
TopBottom,
LeftRight,
BottomTop,
RightLeft,
}
impl<'a> From<RankDir> for AttributeText<'a> {
fn from(rank_dir: RankDir) -> Self {
AttributeText::attr(rank_dir.dot_string())
}
}
impl<'a> DotString<'a> for RankDir {
fn dot_string(&self) -> Cow<'a, str> {
match self {
RankDir::TopBottom => "TB".into(),
RankDir::LeftRight => "LR".into(),
RankDir::BottomTop => "BT".into(),
RankDir::RightLeft => "RL".into(),
}
}
}
/// Spline, edges are drawn as splines routed around nodes
/// Line, edges are drawn as line segments
/// Polygon, specifies that edges should be drawn as polylines.
/// Ortho, specifies edges should be routed as polylines of axis-aligned segments.
/// Curved, specifies edges should be drawn as curved arcs.
/// splines=line and splines=spline can be used as synonyms for
/// splines=false and splines=true, respectively.
pub enum Splines {
Line,
Spline,
None,
Curved,
Polyline,
Ortho,
}
impl<'a> From<Splines> for AttributeText<'a> {
fn from(splines: Splines) -> Self {
AttributeText::quoted(splines.dot_string())
}
}
impl<'a> DotString<'a> for Splines {
fn dot_string(&self) -> Cow<'a, str> {
match self {
Splines::Line => "line".into(),
Splines::Spline => "spline".into(),
Splines::None => "none".into(),
Splines::Curved => "curved".into(),
Splines::Polyline => "polyline".into(),
Splines::Ortho => "ortho".into(),
}
}
}
/// The number of points in the list must be equivalent to 1 mod 3; note that this is not checked.
/// TODO: should we check?
pub struct SplineType {
start: Option<Point>,
end: Option<Point>,
spline_points: Vec<Point>,
}
impl<'a> From<SplineType> for AttributeText<'a> {
fn from(spline_type: SplineType) -> Self {
AttributeText::quoted(spline_type.dot_string())
}
}
impl<'a> DotString<'a> for SplineType {
fn dot_string(&self) -> Cow<'a, str> {
let mut dot_string = String::from("");
if let Some(end) = &self.end {
dot_string.push_str(format!("e,{:.1},{:.1} ", end.x, end.y).as_str());
}
if let Some(start) = &self.start {
dot_string.push_str(format!("s,{:.1},{:.1} ", start.x, start.y).as_str());
}
let mut iter = self.spline_points.iter();
let first = iter.next().unwrap();
dot_string.push_str(format!("{}", first.dot_string()).as_str());
for point in iter {
dot_string.push_str(" ");
dot_string.push_str(format!("{}", point.dot_string()).as_str());
}
dot_string.into()
}
}
// TODO: add node builder using "with" convention
#[derive(Clone, Debug)]
pub struct Node<'a> {
pub id: String,
pub port: Option<String>,
// pub compass: Option<Compass>,
pub attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> Node<'a> {
pub fn new(id: String) -> Node<'a> {
// TODO: constrain id
Node {
id,
port: None,
attributes: IndexMap::new(),
}
}
/// Set the port for the node.
pub fn port(mut self, port: String) -> Self {
self.port = Some(port);
self
}
// pub fn compass<'a>(&'a mut self, compass: Compass) -> &'a mut Node {
// self.compass = Some(compass);
// self
// }
pub fn to_dot_string(&self) -> String {
let mut dot_string = format!("{}{}", INDENT, &self.id);
// TODO: I dont love this logic. I would like to find away to not have a special case.
// I think we introduce a AttributeText enum which encodes how to write out the attribute value
if !self.attributes.is_empty() {
dot_string.push_str(" [");
let mut iter = self.attributes.iter();
let first = iter.next().unwrap();
dot_string.push_str(format!("{}={}", first.0, first.1.to_dot_string()).as_str());
for (key, value) in iter {
dot_string.push_str(", ");
dot_string.push_str(format!("{}={}", key, value.to_dot_string()).as_str());
}
dot_string.push_str("]");
}
dot_string.push_str(";");
return dot_string.to_string();
}
}
pub struct NodeBuilder<'a> {
id: String,
port: Option<String>,
attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> NodeAttributes<'a> for NodeBuilder<'a> {
fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self {
self.attributes.insert(key.into(), value);
self
}
/// Add multiple attribures to the edge.
fn add_attributes(&'a mut self, attributes: HashMap<String, AttributeText<'a>>) -> &mut Self {
self.attributes.extend(attributes);
self
}
fn get_attributes_mut(&mut self) -> &mut IndexMap<String, AttributeText<'a>> {
&mut self.attributes
}
}
impl<'a> NodeBuilder<'a> {
pub fn new(id: String) -> Self {
Self {
id,
port: None,
attributes: IndexMap::new(),
}
}
/// Set the port for the node.
pub fn port<S: Into<String>>(&mut self, port: S) -> &mut Self {
self.port = Some(port.into());
self
}
pub fn build(&self) -> Node<'a> {
Node {
// TODO: are these to_owned and clones necessary?
id: self.id.to_owned(),
port: self.port.to_owned(),
attributes: self.attributes.clone()
}
}
}
pub enum ImagePosition {
TopLeft,
TopCentered,
TopRight,
MiddleLeft,
MiddleCentered,
MiddleRight,
BottomLeft,
BottomCentered,
BottomRight,
}
impl ImagePosition {
pub fn as_slice(&self) -> &'static str {
match self {
ImagePosition::TopLeft => "tl",
ImagePosition::TopCentered => "tc",
ImagePosition::TopRight => "tr",
ImagePosition::MiddleLeft => "ml",
ImagePosition::MiddleCentered => "mc",
ImagePosition::MiddleRight => "mr",
ImagePosition::BottomLeft => "bl",
ImagePosition::BottomCentered => "bc",
ImagePosition::BottomRight => "br",
}
}
}
pub enum ImageScale {
Width,
Height,
Both,
}
impl ImageScale {
pub fn as_slice(&self) -> &'static str {
match self {
ImageScale::Width => "width",
ImageScale::Height => "height",
ImageScale::Both => "both",
}
}
}
#[derive(Clone, Debug)]
pub struct Edge<'a> {
pub source: String,
pub target: String,
pub attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> Edge<'a> {
pub fn new(source: String, target: String) -> Edge<'a> {
Edge {
source,
target,
attributes: IndexMap::new(),
}
}
}
pub struct EdgeBuilder<'a> {
pub source: String,
pub target: String,
attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> EdgeAttributes<'a> for EdgeBuilder<'a> {
fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self {
self.attributes.insert(key.into(), value);
self
}
fn get_attributes_mut(&mut self) -> &mut IndexMap<String, AttributeText<'a>> {
&mut self.attributes
}
// /// Add multiple attributes to the edge.
// fn add_attributes(&'a mut self, attributes: HashMap<String, AttributeText<'a>>) -> &mut Self {
// self.attributes.extend(attributes);
// self
// }
}
impl<'a> EdgeBuilder<'a> {
pub fn new(source: String, target: String) -> EdgeBuilder<'a> {
EdgeBuilder {
source,
target,
attributes: IndexMap::new(),
}
}
/// Add an attribute to the edge.
pub fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self {
self.attributes.insert(key.into(), value);
self
}
/// Add multiple attributes to the edge.
pub fn add_attributes(&'a mut self, attributes: HashMap<String, AttributeText<'a>>) -> &mut Self {
self.attributes.extend(attributes);
self
}
pub fn build(&self) -> Edge<'a> {
Edge {
// TODO: are these to_owned and clones necessary?
source: self.source.to_owned(),
target: self.target.to_owned(),
attributes: self.attributes.clone()
}
}
}
trait AttributeStatement<'a> {
fn get_attribute_statement_type(&self) -> &'static str;
fn get_attributes(&self) -> &IndexMap<String, AttributeText<'a>>;
fn to_dot_string(&self) -> String {
if self.get_attributes().is_empty() {
return String::from("");
}
let mut dot_string = format!("{} [", self.get_attribute_statement_type());
let attributes = &self.get_attributes();
let mut iter = attributes.iter();
let first = iter.next().unwrap();
dot_string.push_str(format!("{}={}", first.0, first.1.to_dot_string()).as_str());
for (key, value) in iter {
dot_string.push_str(", ");
dot_string.push_str(format!("{}={}", key, value.to_dot_string()).as_str());
}
dot_string.push_str("];");
dot_string.to_string()
}
}
trait NodeAttributes<'a> {
// TODO: constrain
/// Indicates the preferred area for a node or empty cluster when laid out by patchwork.
/// default: 1.0, minimum: >0
fn area(&mut self, area: f32) -> &mut Self {
self.add_attribute("area", AttributeText::attr(area.to_string()))
}
/// Classnames to attach to the node’s SVG element.
/// Combine with stylesheet for styling SVG output using CSS classnames.
/// Multiple space-separated classes are supported.
fn class(&mut self, class: String) -> &mut Self {
Attributes::class(self.get_attributes_mut(), class);
self
}
/// Basic drawing color for graphics, not text. For the latter, use the fontcolor attribute.
fn color(&mut self, color: Color<'a>) -> &mut Self {
Attributes::color(self.get_attributes_mut(), color);
self
}
fn color_with_colorlist(&mut self, color: ColorList<'a>) -> &mut Self {
Attributes::color_with_colorlist(self.get_attributes_mut(), color);
self
}
/// This attribute specifies a color scheme namespace: the context for interpreting color names.
/// In particular, if a color value has form "xxx" or "//xxx", then the color xxx will be evaluated
/// according to the current color scheme. If no color scheme is set, the standard X11 naming is used.
/// For example, if colorscheme=bugn9, then color=7 is interpreted as color="/bugn9/7".
fn color_scheme(&mut self, color_scheme: String) -> &mut Self {
Attributes::color_scheme(self.get_attributes_mut(), color_scheme);
self
}
/// Comments are inserted into output. Device-dependent
fn comment(&mut self, comment: String) -> &mut Self {
Attributes::comment(self.get_attributes_mut(), comment);
self
}
/// Distortion factor for shape=polygon.
/// Positive values cause top part to be larger than bottom; negative values do the opposite.
fn distortion(&mut self, distortion: f32) -> &mut Self {
self.add_attribute("distortion", AttributeText::attr(distortion.to_string()))
}
/// Color used to fill the background of a node or cluster assuming style=filled, or a filled arrowhead.
fn fill_color(&mut self, fill_color: Color<'a>) -> &mut Self {
Attributes::fill_color(self.get_attributes_mut(), fill_color);
self
}
/// Color used to fill the background, with a gradient, of a node or cluster assuming
/// style=filled, or a filled arrowhead.
fn fill_color_with_colorlist(&mut self, fill_colors: ColorList<'a>) -> &mut Self {
Attributes::fill_color_with_colorlist(self.get_attributes_mut(), fill_colors);
self
}
/// Color used to fill the background, with a gradient, of a node or cluster assuming
/// style=filled, or a filled arrowhead.
/// TODO: example
fn fill_color_with_iter<I>(&mut self, fill_colors: I) -> &mut Self
where
I: IntoIterator,
I::Item: IntoWeightedColor<'a>,
{
Attributes::fill_color_with_iter(self.get_attributes_mut(), fill_colors);
self
}
/// If true, the node size is specified by the values of the width and height attributes only and
/// is not expanded to contain the text label.
/// There will be a warning if the label (with margin) cannot fit within these limits.
/// If false, the size of a node is determined by smallest width and height needed to contain its label
/// and image, if any, with a margin specified by the margin attribute.
fn fixed_size(&mut self, fixed_size: bool) -> &mut Self {
self.add_attribute("fixedsize", AttributeText::quoted(fixed_size.to_string()))
}
/// Color used for text.
fn font_color(&mut self, font_color: Color<'a>) -> &mut Self {
Attributes::font_color(self.get_attributes_mut(), font_color);
self
}
/// Font used for text.
fn font_name(&mut self, font_name: String) -> &mut Self {
Attributes::font_name(self.get_attributes_mut(), font_name);
self
}
/// Font size, in points, used for text.
/// default: 14.0, minimum: 1.0
fn font_size(&mut self, font_size: f32) -> &mut Self {
Attributes::font_size(self.get_attributes_mut(), font_size);
self
}
/// If a gradient fill is being used, this determines the angle of the fill.
fn gradient_angle(&mut self, gradient_angle: u32) -> &mut Self {
Attributes::gradient_angle(self.get_attributes_mut(), gradient_angle);
self
}
/// If the end points of an edge belong to the same group, i.e., have the same group attribute,
/// parameters are set to avoid crossings and keep the edges straight.
fn group(&mut self, group: String) -> &mut Self {
self.add_attribute("group", AttributeText::attr(group))
}
// TODO: constrain
/// Height of node, in inches.
/// default: 0.5, minimum: 0.02
fn height(&mut self, height: f32) -> &mut Self {
self.add_attribute("height", AttributeText::attr(height.to_string()))
}
/// Gives the name of a file containing an image to be displayed inside a node.
/// The image file must be in one of the recognized formats,
/// typically JPEG, PNG, GIF, BMP, SVG, or Postscript, and be able to be converted
/// into the desired output format.
fn image(&mut self, image: String) -> &mut Self {
self.add_attribute("image", AttributeText::quoted(image))
}
/// Controls how an image is positioned within its containing node.
/// Only has an effect when the image is smaller than the containing node.
fn image_pos(&mut self, image_pos: ImagePosition) -> &mut Self {
self.add_attribute("imagepos", AttributeText::quoted(image_pos.as_slice()))
}
/// Controls how an image fills its containing node.
fn image_scale_bool(&mut self, image_scale: bool) -> &mut Self {
self.add_attribute("imagescale", AttributeText::quoted(image_scale.to_string()))
}
/// Controls how an image fills its containing node.
fn image_scale(&mut self, image_scale: ImageScale) -> &mut Self {
self.add_attribute("imagescale", AttributeText::quoted(image_scale.as_slice()))
}
/// Text label attached to objects.
fn label<S: Into<Cow<'a, str>>>(&mut self, text: S) -> &mut Self {
self.add_attribute("label", AttributeText::quoted(text))
}
// Vertical placement of labels for nodes, root graphs and clusters.
// For graphs and clusters, only labelloc=t and labelloc=b are allowed, corresponding to placement at the top and bottom, respectively.
// By default, root graph labels go on the bottom and cluster labels go on the top.
// Note that a subgraph inherits attributes from its parent. Thus, if the root graph sets labelloc=b, the subgraph inherits this value.
// For nodes, this attribute is used only when the height of the node is larger than the height of its label.
// If labelloc=t, labelloc=c, labelloc=b, the label is aligned with the top, centered, or aligned with the bottom of the node, respectively.
// By default, the label is vertically centered.
fn label_location(&mut self, label_location: LabelLocation) -> &mut Self {
Attributes::label_location(self.get_attributes_mut(), label_location);
self
}
/// Specifies layers in which the node, edge or cluster is present.
fn layer(&mut self, layer: String) -> &mut Self {
Attributes::layer(self.get_attributes_mut(), layer);
self
}
/// For nodes, this attribute specifies space left around the node’s label.
/// If the margin is a single double, both margins are set equal to the given value.
/// Note that the margin is not part of the drawing but just empty space left around the drawing.
/// The margin basically corresponds to a translation of drawing, as would be necessary to center a drawing on a page.
/// Nothing is actually drawn in the margin. To actually extend the background of a drawing, see the pad attribute.
/// By default, the value is 0.11,0.055.
fn margin(&mut self, margin: f32) -> &mut Self {
Attributes::margin(self.get_attributes_mut(), margin);
self
}
fn margin_point(&mut self, margin: Point) -> &mut Self {
Attributes::margin_point(self.get_attributes_mut(), margin);
self
}
/// By default, the justification of multi-line labels is done within the largest context that makes sense.
/// Thus, in the label of a polygonal node, a left-justified line will align with the left side of the node (shifted by the prescribed margin).
/// In record nodes, left-justified line will line up with the left side of the enclosing column of fields.
/// If nojustify=true, multi-line labels will be justified in the context of itself.
/// For example, if nojustify is set, the first label line is long, and the second is shorter and left-justified,
/// the second will align with the left-most character in the first line, regardless of how large the node might be.
fn no_justify(&mut self, no_justify: bool) -> &mut Self {
Attributes::no_justify(self.get_attributes_mut(), no_justify);
self
}
/// If ordering="out", then the outedges of a node, that is, edges with the node as its tail
/// node, must appear left-to-right in the same order in which they are defined in the input.
///
/// If ordering="in", then the inedges of a node must appear left-to-right in the same order in
/// which they are defined in the input.
///
/// If defined as a graph or subgraph attribute, the value is applied to all nodes in the graph
/// or subgraph.
///
/// Note that the graph attribute takes precedence over the node attribute.
fn ordering(&mut self, ordering: Ordering) -> &mut Self {
Attributes::ordering(self.get_attributes_mut(), ordering);
self
}
// TODO: constrain to 0 - 360. Docs say min is 360 which should be max right?
/// When used on nodes: Angle, in degrees, to rotate polygon node shapes.
/// For any number of polygon sides, 0 degrees rotation results in a flat base.
/// When used on graphs: If "[lL]*", sets graph orientation to landscape.
/// Used only if rotate is not defined.
/// Default: 0.0 and minimum: 360.0
fn orientation(&mut self, orientation: f32) -> &mut Self {
Attributes::orientation(self.get_attributes_mut(), orientation);
self
}
/// Specifies the width of the pen, in points, used to draw lines and curves,
/// including the boundaries of edges and clusters.
/// default: 1.0, minimum: 0.0
fn pen_width(&mut self, pen_width: f32) -> &mut Self {
Attributes::pen_width(self.get_attributes_mut(), pen_width);
self
}
/// Set number of peripheries used in polygonal shapes and cluster boundaries.
fn peripheries(&mut self, peripheries: u32) -> &mut Self {
self.add_attribute("penwidth", AttributeText::from(peripheries))
}
/// Position of node, or spline control points.
/// the position indicates the center of the node. On output, the coordinates are in points.
fn pos(&mut self, pos: Point) -> &mut Self {
Attributes::pos(self.get_attributes_mut(), pos);
self
}
// TODO: add post_spline
// TODO: add rect type?
// "%f,%f,%f,%f"
/// Rectangles for fields of records, in points.
fn rects(&mut self, rects: String) -> &mut Self {
self.add_attribute("rects", AttributeText::attr(rects))
}
/// If true, force polygon to be regular, i.e., the vertices of the polygon will
/// lie on a circle whose center is the center of the node.
fn regular(&mut self, regular: bool) -> &mut Self {
self.add_attribute("regular", AttributeText::from(regular))
}
/// Gives the number of points used for a circle/ellipse node.
fn sample_points(&mut self, sample_points: u32) -> &mut Self {
self.add_attribute("samplepoints", AttributeText::from(sample_points))
}
/// Sets the shape of a node.
fn shape(&mut self, shape: Shape) -> &mut Self {
self.add_attribute("shape", AttributeText::from(shape))
}
// TODO: constrain
/// Print guide boxes in PostScript at the beginning of routesplines if showboxes=1, or at the end if showboxes=2.
/// (Debugging, TB mode only!)
/// default: 0, minimum: 0
fn show_boxes(&mut self, show_boxes: u32) -> &mut Self {
Attributes::show_boxes(self.get_attributes_mut(), show_boxes);
self
}
/// Number of sides when shape=polygon.
fn sides(&mut self, sides: u32) -> &mut Self {
self.add_attribute("sides", AttributeText::attr(sides.to_string()))
}
// TODO: constrain
/// Skew factor for shape=polygon.
/// Positive values skew top of polygon to right; negative to left.
/// default: 0.0, minimum: -100.0
fn skew(&mut self, skew: f32) -> &mut Self {
self.add_attribute("skew", AttributeText::attr(skew.to_string()))
}
/// If packmode indicates an array packing, sortv specifies an insertion order
/// among the components, with smaller values inserted first.
/// default: 0, minimum: 0
fn sortv(&mut self, sortv: u32) -> &mut Self {
Attributes::sortv(self.get_attributes_mut(), sortv);
self
}
/// Set style information for components of the graph.
fn style(&mut self, style: NodeStyle) -> &mut Self {
Attributes::style(self.get_attributes_mut(), Styles::Node(style));
self
}
/// If the object has a URL, this attribute determines which window of the browser is used for the URL.
fn target(&mut self, target: String) -> &mut Self {
Attributes::target(self.get_attributes_mut(), target);
self
}
/// Tooltip annotation attached to the node or edge.
/// If unset, Graphviz will use the object’s label if defined.
/// Note that if the label is a record specification or an HTML-like label,
/// the resulting tooltip may be unhelpful.
/// In this case, if tooltips will be generated, the user should set a tooltip attribute explicitly.
fn tooltip(&mut self, tooltip: String) -> &mut Self {
Attributes::tooltip(self.get_attributes_mut(), tooltip);
self
}
/// Hyperlinks incorporated into device-dependent output.
fn url(&mut self, url: String) -> &mut Self {
Attributes::url(self.get_attributes_mut(), url);
self
}
/// Sets the coordinates of the vertices of the node’s polygon, in inches.
/// A list of points, separated by spaces.
fn vertices(&mut self, vertices: String) -> &mut Self {
self.add_attribute("vertices", AttributeText::quoted(vertices))
}
/// Width of node, in inches.
/// This is taken as the initial, minimum width of the node.
/// If fixedsize is true, this will be the final width of the node.
/// Otherwise, if the node label requires more width to fit, the node’s
/// width will be increased to contain the label.
fn width(&mut self, width: f32) -> &mut Self {
self.add_attribute("width", AttributeText::from(width))
}
/// External label for a node or edge.
/// The label will be placed outside of the node but near it.
/// These labels are added after all nodes and edges have been placed.
/// The labels will be placed so that they do not overlap any node or label.
/// This means it may not be possible to place all of them.
/// To force placing all of them, set forcelabels=true.
fn xlabel(&mut self, xlabel: String) -> &mut Self {
Attributes::xlabel(self.get_attributes_mut(), xlabel);
self
}
/// Position of an exterior label, in points.
/// The position indicates the center of the label.
fn xlp(&mut self, xlp: Point) -> &mut Self {
Attributes::xlp(self.get_attributes_mut(), xlp);
self
}
/// Add an attribute to the node.
fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self;
/// Add multiple attribures to the node.
fn add_attributes(&'a mut self, attributes: HashMap<String, AttributeText<'a>>) -> &mut Self;
fn get_attributes_mut(&mut self) -> &mut IndexMap<String, AttributeText<'a>>;
}
impl<'a> NodeAttributes<'a> for NodeAttributeStatementBuilder<'a> {
fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self {
self.attributes.insert(key.into(), value);
self
}
/// Add multiple attributes to the node.
fn add_attributes(&'a mut self, attributes: HashMap<String, AttributeText<'a>>) -> &mut Self {
self.attributes.extend(attributes);
self
}
fn get_attributes_mut(&mut self) -> &mut IndexMap<String, AttributeText<'a>> {
&mut self.attributes
}
}
// I'm not a huge fan of needing this builder but having a hard time getting around &mut without it
pub struct NodeAttributeStatementBuilder<'a> {
pub attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> NodeAttributeStatementBuilder<'a> {
pub fn new() -> Self {
Self {
attributes: IndexMap::new(),
}
}
pub fn build(&self) -> NodeAttributeStatement<'a> {
NodeAttributeStatement {
attributes: self.attributes.clone(),
}
}
}
#[derive(Clone, Debug)]
pub struct NodeAttributeStatement<'a> {
pub attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> NodeAttributeStatement<'a> {
pub fn new() -> Self {
Self {
attributes: IndexMap::new(),
}
}
pub fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self {
self.attributes.insert(key.into(), value);
self
}
}
impl<'a> AttributeStatement<'a> for NodeAttributeStatement<'a> {
fn get_attribute_statement_type(&self) -> &'static str {
"node"
}
fn get_attributes(&self) -> &IndexMap<String, AttributeText<'a>> {
&self.attributes
}
}
trait EdgeAttributes<'a> {
/// Style of arrowhead on the head node of an edge.
/// This will only appear if the dir attribute is forward or both.
fn arrow_head(&mut self, arrowhead: ArrowType) -> &mut Self {
self.add_attribute("arrowhead", AttributeText::from(arrowhead))
}
// TODO: constrain
/// Multiplicative scale factor for arrowheads.
/// default: 1.0, minimum: 0.0
fn arrow_size(&mut self, arrow_size: f32) -> &mut Self {
self.add_attribute("arrowsize", AttributeText::from(arrow_size))
}
/// Style of arrowhead on the tail node of an edge.
/// This will only appear if the dir attribute is back or both.
fn arrowtail(&mut self, arrowtail: ArrowType) -> &mut Self {
self.add_attribute("arrowtail", AttributeText::from(arrowtail))
}
/// Classnames to attach to the edge’s SVG element.
/// Combine with stylesheet for styling SVG output using CSS classnames.
/// Multiple space-separated classes are supported.
fn class(&mut self, class: String) -> &mut Self {
Attributes::class(self.get_attributes_mut(), class);
self
}
/// Basic drawing color for graphics, not text. For the latter, use the fontcolor attribute.
fn color(&mut self, color: Color<'a>) -> &mut Self {
Attributes::color(self.get_attributes_mut(), color);
self
}
fn color_with_colorlist(&mut self, color: ColorList<'a>) -> &mut Self {
Attributes::color_with_colorlist(self.get_attributes_mut(), color);
self
}
/// This attribute specifies a color scheme namespace: the context for interpreting color names.
/// In particular, if a color value has form "xxx" or "//xxx", then the color xxx will be evaluated
/// according to the current color scheme. If no color scheme is set, the standard X11 naming is used.
/// For example, if colorscheme=bugn9, then color=7 is interpreted as color="/bugn9/7".
fn color_scheme(&mut self, color_scheme: String) -> &mut Self {
Attributes::color_scheme(self.get_attributes_mut(), color_scheme);
self
}
/// Comments are inserted into output. Device-dependent
fn comment(&mut self, comment: String) -> &mut Self {
self.add_attribute("comment", AttributeText::attr(comment));
self
}
/// If false, the edge is not used in ranking the nodes.
fn constriant(&mut self, constriant: bool) -> &mut Self {
self.add_attribute("constriant", AttributeText::from(constriant))
}
/// If true, attach edge label to edge by a 2-segment polyline, underlining the label,
/// then going to the closest point of spline.
fn decorate(&mut self, decorate: bool) -> &mut Self {
self.add_attribute("decorate", AttributeText::from(decorate))
}
/// Edge type for drawing arrowheads.
/// Indicates which ends of the edge should be decorated with an arrowhead.
/// The actual style of the arrowhead can be specified using the arrowhead and arrowtail attributes.
fn dir(&mut self, dir: Direction) -> &mut Self {
self.add_attribute("dir", AttributeText::from(dir))
}
/// If the edge has a URL or edgeURL attribute, edgetarget determines which window
/// of the browser is used for the URL attached to the non-label part of the edge.
/// Setting edgetarget=_graphviz will open a new window if it doesn’t already exist, or reuse it if it does.
fn edge_target(&mut self, edge_target: String) -> &mut Self {
self.add_attribute("edgetarget", AttributeText::escaped(edge_target))
}
/// Tooltip annotation attached to the non-label part of an edge.
/// Used only if the edge has a URL or edgeURL attribute.
fn edge_tooltip(&mut self, edge_tooltip: String) -> &mut Self {
self.add_attribute("edgetooltip", AttributeText::escaped(edge_tooltip))
}
/// The link for the non-label parts of an edge.
/// edgeURL overrides any URL defined for the edge.
/// Also, edgeURL is used near the head or tail node unless overridden by headURL or tailURL, respectively.
fn edge_url(&mut self, edge_url: String) -> &mut Self {
self.add_attribute("edgeurl", AttributeText::escaped(edge_url))
}
// TODO: color list
/// Color used to fill the background of a node or cluster assuming style=filled, or a filled arrowhead.
fn fill_color(&mut self, fill_color: Color<'a>) -> &mut Self {
Attributes::fill_color(self.get_attributes_mut(), fill_color);
self
}
// TODO: color list
/// Color used for text.
fn font_color(&mut self, font_color: Color<'a>) -> &mut Self {
Attributes::font_color(self.get_attributes_mut(), font_color);
self
}
/// Font used for text.
fn font_name(&mut self, font_name: String) -> &mut Self {
Attributes::font_name(self.get_attributes_mut(), font_name);
self
}
/// Font size, in points, used for text.
/// default: 14.0, minimum: 1.0
fn font_size(&mut self, font_size: f32) -> &mut Self {
Attributes::font_size(self.get_attributes_mut(), font_size);
self
}
/// Position of an edge’s head label, in points. The position indicates the center of the label.
fn head_lp(&mut self, head_lp: Point) -> &mut Self {
self.add_attribute("head_lp", AttributeText::from(head_lp))
}
/// If true, the head of an edge is clipped to the boundary of the head node;
/// otherwise, the end of the edge goes to the center of the node, or the center
/// of a port, if applicable.
fn head_clip(&mut self, head_clip: bool) -> &mut Self {
self.add_attribute("headclip", AttributeText::from(head_clip))
}
/// Text label to be placed near head of edge.
fn head_label(&mut self, head_label: String) -> &mut Self {
self.add_attribute("headlabel", AttributeText::quoted(head_label))
}
// TODO: portPos struct?
/// Indicates where on the head node to attach the head of the edge.
/// In the default case, the edge is aimed towards the center of the node,
/// and then clipped at the node boundary.
fn head_port(&mut self, head_port: String) -> &mut Self {
self.add_attribute("headport", AttributeText::quoted(head_port))
}
/// If the edge has a headURL, headtarget determines which window of the browser is used for the URL.
/// Setting headURL=_graphviz will open a new window if the window doesn’t already exist,
/// or reuse the window if it does.
/// If undefined, the value of the target is used.
fn head_target(&mut self, head_target: String) -> &mut Self {
self.add_attribute("headtarget", AttributeText::escaped(head_target))
}
/// Tooltip annotation attached to the head of an edge.
/// Used only if the edge has a headURL attribute.
fn head_tooltip(&mut self, head_tooltip: String) -> &mut Self {
self.add_attribute("headtooltip", AttributeText::escaped(head_tooltip))
}
/// If defined, headURL is output as part of the head label of the edge.
/// Also, this value is used near the head node, overriding any URL value.
fn head_url(&mut self, head_url: String) -> &mut Self {
self.add_attribute("headURL", AttributeText::escaped(head_url))
}
/// An escString or an HTML label.
fn label(&mut self, label: String) -> &mut Self {
Attributes::label(self.get_attributes_mut(), label);
self
}
// TODO: constrain
/// Determines, along with labeldistance, where the headlabel / taillabel are
/// placed with respect to the head / tail in polar coordinates.
/// The origin in the coordinate system is the point where the edge touches the node.
/// The ray of 0 degrees goes from the origin back along the edge, parallel to the edge at the origin.
/// The angle, in degrees, specifies the rotation from the 0 degree ray,
/// with positive angles moving counterclockwise and negative angles moving clockwise.
/// default: -25.0, minimum: -180.0
fn label_angle(&mut self, label_angle: f32) -> &mut Self {
self.add_attribute("labelangle", AttributeText::from(label_angle))
}
/// Multiplicative scaling factor adjusting the distance that the headlabel / taillabel is from the head / tail node.
/// default: 1.0, minimum: 0.0
fn label_distance(&mut self, label_distance: f32) -> &mut Self {
self.add_attribute("labeldistance", AttributeText::from(label_distance))
}
/// If true, allows edge labels to be less constrained in position.
/// In particular, it may appear on top of other edges.
fn label_float(&mut self, label_float: bool) -> &mut Self {
self.add_attribute("labelfloat", AttributeText::from(label_float))
}
/// Color used for headlabel and taillabel.
fn label_font_color(&mut self, label_font_color: Color<'a>) -> &mut Self {
self.add_attribute("labelfontcolor", AttributeText::from(label_font_color))
}
/// Font used for headlabel and taillabel.
/// If not set, defaults to edge’s fontname.
fn label_font_name(&mut self, label_font_name: String) -> &mut Self {
self.add_attribute("labelfontname", AttributeText::attr(label_font_name))
}
// TODO: constrains
/// Font size, in points, used for headlabel and taillabel.
/// If not set, defaults to edge’s fontsize.
/// default: 14.0, minimum: 1.0
fn label_font_size(&mut self, label_font_size: f32) -> &mut Self {
self.add_attribute("labelfontsize", AttributeText::from(label_font_size))
}
/// If the edge has a URL or labelURL attribute, this attribute determines
/// which window of the browser is used for the URL attached to the label.
fn label_target(&mut self, label_target: String) -> &mut Self {
self.add_attribute("labeltarget", AttributeText::escaped(label_target))
}
/// Tooltip annotation attached to label of an edge.
/// Used only if the edge has a URL or labelURL attribute.
fn label_tooltip(&mut self, label_tooltip: String) -> &mut Self {
self.add_attribute("labeltooltip", AttributeText::escaped(label_tooltip))
}
/// If defined, labelURL is the link used for the label of an edge.
/// labelURL overrides any URL defined for the edge.
fn label_url(&mut self, label_url: String) -> &mut Self {
self.add_attribute("labelurl", AttributeText::escaped(label_url))
}
fn layer(&mut self, layer: String) -> &mut Self {
Attributes::layer(self.get_attributes_mut(), layer);
self
}
fn lhead(&mut self, lhead: String) -> &mut Self {
self.add_attribute("lhead", AttributeText::quoted(lhead))
}
fn lp(&mut self, lp: String) -> &mut Self {
Attributes::lp(self.get_attributes_mut(), lp);
self
}
/// Logical tail of an edge.
/// When compound=true, if ltail is defined and is the name of a cluster
/// containing the real tail, the edge is clipped to the boundary of the cluster.
fn ltail(&mut self, ltail: String) -> &mut Self {
self.add_attribute("ltail", AttributeText::quoted(ltail))
}
/// Minimum edge length (rank difference between head and tail).
fn min_len(&mut self, min_len: u32) -> &mut Self {
self.add_attribute("minlen", AttributeText::from(min_len))
}
fn no_justify(&mut self, no_justify: bool) -> &mut Self {
self.add_attribute("nojustify", AttributeText::from(no_justify))
}
fn pen_width(&mut self, pen_width: f32) -> &mut Self {
Attributes::pen_width(self.get_attributes_mut(), pen_width);
self
}
/// Position of node, or spline control points.
/// the position indicates the center of the node. On output, the coordinates are in points.
fn pos(&mut self, pos: Point) -> &mut Self {
Attributes::pos(self.get_attributes_mut(), pos);
self
}
/// Edges with the same head and the same samehead value are aimed at the same point on the head.
fn same_head(&mut self, same_head: String) -> &mut Self {
self.add_attribute("samehead", AttributeText::quoted(same_head))
}
/// Edges with the same tail and the same sametail value are aimed at the same point on the tail.
fn same_tail(&mut self, same_tail: String) -> &mut Self {
self.add_attribute("sametail", AttributeText::quoted(same_tail))
}
// TODO: constrain
/// Print guide boxes in PostScript at the beginning of routesplines if showboxes=1, or at the end if showboxes=2.
/// (Debugging, TB mode only!)
/// default: 0, minimum: 0
fn show_boxes(&mut self, show_boxes: u32) -> &mut Self {
Attributes::show_boxes(self.get_attributes_mut(), show_boxes);
self
}
/// Set style information for components of the graph.
fn style(&mut self, style: EdgeStyle) -> &mut Self {
Attributes::style(self.get_attributes_mut(), Styles::Edge(style));
self
}
/// Position of an edge’s tail label, in points.
/// The position indicates the center of the label.
fn tail_lp(&mut self, tail_lp: Point) -> &mut Self {
self.add_attribute("tail_lp", AttributeText::from(tail_lp))
}
/// If true, the tail of an edge is clipped to the boundary of the tail node; otherwise,
/// the end of the edge goes to the center of the node, or the center of a port, if applicable.
fn tail_clip(&mut self, tail_clip: bool) -> &mut Self {
self.add_attribute("tailclip", AttributeText::from(tail_clip))
}
/// Text label to be placed near tail of edge.
fn tail_label(&mut self, tail_label: String) -> &mut Self {
self.add_attribute("taillabel", AttributeText::quoted(tail_label))
}
// TODO: portPos struct?
/// Indicates where on the tail node to attach the tail of the edge.
fn tail_port(&mut self, tail_port: String) -> &mut Self {
self.add_attribute("tailport", AttributeText::quoted(tail_port))
}
/// If the edge has a tailURL, tailtarget determines which window of the browser is used for the URL.
fn tail_target(&mut self, tail_target: String) -> &mut Self {
self.add_attribute("tailtarget", AttributeText::escaped(tail_target))
}
/// Tooltip annotation attached to the tail of an edge.
fn tail_tooltip(&mut self, tail_tooltip: String) -> &mut Self {
self.add_attribute("tailtooltip", AttributeText::escaped(tail_tooltip))
}
/// If defined, tailURL is output as part of the tail label of the edge.
/// Also, this value is used near the tail node, overriding any URL value.
fn tail_url(&mut self, tail_url: String) -> &mut Self {
self.add_attribute("tailURL", AttributeText::escaped(tail_url))
}
/// If the object has a URL, this attribute determines which window of the browser is used for the URL.
fn target(&mut self, target: String) -> &mut Self {
self.add_attribute("target", AttributeText::escaped(target))
}
/// Tooltip annotation attached to the node or edge.
/// If unset, Graphviz will use the object’s label if defined.
/// Note that if the label is a record specification or an HTML-like label,
/// the resulting tooltip may be unhelpful.
/// In this case, if tooltips will be generated, the user should set a tooltip attribute explicitly.
fn tooltip(&mut self, tooltip: String) -> &mut Self {
Attributes::tooltip(self.get_attributes_mut(), tooltip);
self
}
/// Hyperlinks incorporated into device-dependent output.
fn url(&mut self, url: String) -> &mut Self {
Attributes::url(self.get_attributes_mut(), url);
self
}
// TODO: contrain
/// Weight of edge.
/// The heavier the weight, the shorter, straighter and more vertical the edge is.
/// default: 1, minimum: 0
fn weight(&mut self, weight: u32) -> &mut Self {
self.add_attribute("weight", AttributeText::attr(weight.to_string()))
}
/// External label for a node or edge.
/// The label will be placed outside of the node but near it.
/// These labels are added after all nodes and edges have been placed.
/// The labels will be placed so that they do not overlap any node or label.
/// This means it may not be possible to place all of them.
/// To force placing all of them, set forcelabels=true.
fn xlabel(&mut self, xlabel: String) -> &mut Self {
Attributes::xlabel(self.get_attributes_mut(), xlabel);
self
}
/// Position of an exterior label, in points.
/// The position indicates the center of the label.
fn xlp(&mut self, xlp: Point) -> &mut Self {
Attributes::xlp(self.get_attributes_mut(), xlp);
self
}
fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self;
fn get_attributes_mut(&mut self) -> &mut IndexMap<String, AttributeText<'a>>;
// fn add_attribute<S: Into<String>>(
// &self,
// key: S,
// value: AttributeText<'a>
// ) {
// self.get_attributes().insert(key.into(), value);
// }
// fn get_attributes(&self) -> IndexMap<String, AttributeText<'a>>;
// fn get_attributes_mut(&self) -> &mut IndexMap<String, AttributeText<'a>>;
// fn to_dot_string(&self) -> String;
}
impl<'a> EdgeAttributes<'a> for EdgeAttributeStatementBuilder<'a> {
fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self {
self.attributes.insert(key.into(), value);
self
}
fn get_attributes_mut(&mut self) -> &mut IndexMap<String, AttributeText<'a>> {
&mut self.attributes
}
}
impl<'a> AttributeStatement<'a> for EdgeAttributeStatement<'a> {
fn get_attribute_statement_type(&self) -> &'static str {
"edge"
}
fn get_attributes(&self) -> &IndexMap<String, AttributeText<'a>> {
&self.attributes
}
}
// I'm not a huge fan of needing this builder but having a hard time getting around &mut without it
pub struct EdgeAttributeStatementBuilder<'a> {
pub attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> EdgeAttributeStatementBuilder<'a> {
pub fn new() -> Self {
Self {
attributes: IndexMap::new(),
}
}
pub fn build(&self) -> EdgeAttributeStatement<'a> {
EdgeAttributeStatement {
attributes: self.attributes.clone(),
}
}
}
#[derive(Clone, Debug)]
pub struct EdgeAttributeStatement<'a> {
pub attributes: IndexMap<String, AttributeText<'a>>,
}
impl<'a> EdgeAttributeStatement<'a> {
pub fn new() -> Self {
Self {
attributes: IndexMap::new(),
}
}
pub fn add_attribute<S: Into<String>>(&mut self, key: S, value: AttributeText<'a>) -> &mut Self {
self.attributes.insert(key.into(), value);
self
}
}
pub enum Shape {
Box,
Polygon,
Ellipse,
Oval,
Circle,
Point,
Egg,
Triangle,
Plaintext,
Plain,
Diamond,
Trapezium,
Parallelogram,
House,
Pentagon,
Hexagon,
Septagon,
Octagon,
DoubleCircle,
DoubleOctagon,
TripleOctagon,
Invtriangle,
Invtrapezium,
Invhouse,
Mdiamond,
Msquare,
Mcircle,
Record,
Rect,
Rectangle,
Square,
Star,
None,
Underline,
Cylinder,
Note,
Tab,
Folder,
Box3D,
Component,
Promoter,
Cds,
Terminator,
Utr,
Primersite,
Restrictionsite,
FivePoverHang,
ThreePoverHang,
NoverHang,
Assemply,
Signature,
Insulator,
Ribosite,
Rnastab,
Proteasesite,
Proteinstab,
Rpromotor,
Rarrow,
Larrow,
Lpromotor,
}
impl<'a> From<Shape> for AttributeText<'a> {
fn from(shape: Shape) -> Self {
AttributeText::attr(shape.dot_string())
}
}
impl<'a> DotString<'a> for Shape {
fn dot_string(&self) -> Cow<'a, str> {
match self {
Shape::Box => "box".into(),
Shape::Polygon => "polygon".into(),
Shape::Ellipse => "ellipse".into(),
Shape::Oval => "oval".into(),
Shape::Circle => "circle".into(),
Shape::Point => "point".into(),
Shape::Egg => "egg".into(),
Shape::Triangle => "triangle".into(),
Shape::Plaintext => "plaintext".into(),
Shape::Plain => "plain".into(),
Shape::Diamond => "diamond".into(),
Shape::Trapezium => "trapezium".into(),
Shape::Parallelogram => "parallelogram".into(),
Shape::House => "house".into(),
Shape::Pentagon => "pentagon".into(),
Shape::Hexagon => "hexagon".into(),
Shape::Septagon => "septagon".into(),
Shape::Octagon => "octagon".into(),
Shape::DoubleCircle => "doublecircle".into(),
Shape::DoubleOctagon => "doubleoctagon".into(),
Shape::TripleOctagon => "tripleocctagon".into(),
Shape::Invtriangle => "invtriangle".into(),
Shape::Invtrapezium => "invtrapezium".into(),
Shape::Invhouse => "invhouse".into(),
Shape::Mdiamond => "mdiamond".into(),
Shape::Msquare => "msquare".into(),
Shape::Mcircle => "mcircle".into(),
Shape::Record => "record".into(),
Shape::Rect => "rect".into(),
Shape::Rectangle => "rectangle".into(),
Shape::Square => "square".into(),
Shape::Star => "star".into(),
Shape::None => "none".into(),
Shape::Underline => "underline".into(),
Shape::Cylinder => "cylinder".into(),
Shape::Note => "note".into(),
Shape::Tab => "tab".into(),
Shape::Folder => "folder".into(),
Shape::Box3D => "box3d".into(),
Shape::Component => "component".into(),
Shape::Promoter => "promoter".into(),
Shape::Cds => "cds".into(),
Shape::Terminator => "terminator".into(),
Shape::Utr => "utr".into(),
Shape::Primersite => "primersite".into(),
Shape::Restrictionsite => "restrictionsite".into(),
Shape::FivePoverHang => "fivepoverhang".into(),
Shape::ThreePoverHang => "threepoverhang".into(),
Shape::NoverHang => "noverhang".into(),
Shape::Assemply => "assemply".into(),
Shape::Signature => "signature".into(),
Shape::Insulator => "insulator".into(),
Shape::Ribosite => "ribosite".into(),
Shape::Rnastab => "rnastab".into(),
Shape::Proteasesite => "proteasesite".into(),
Shape::Proteinstab => "proteinstab".into(),
Shape::Rpromotor => "rpromotor".into(),
Shape::Rarrow => "rarrow".into(),
Shape::Larrow => "larrow".into(),
Shape::Lpromotor => "lpromotor".into(),
}
}
}
pub enum ArrowType {
Normal,
Dot,
Odot,
None,
Empty,
Diamond,
Ediamond,
Box,
Open,
Vee,
Inv,
Invdot,
Invodot,
Tee,
Invempty,
Odiamond,
Crow,
Obox,
Halfopen,
}
impl<'a> From<ArrowType> for AttributeText<'a> {
fn from(arrow_type: ArrowType) -> Self {
AttributeText::attr(arrow_type.dot_string())
}
}
impl<'a> DotString<'a> for ArrowType {
fn dot_string(&self) -> Cow<'a, str> {
match self {
ArrowType::Normal => "normal".into(),
ArrowType::Dot => "dot".into(),
ArrowType::Odot => "odot".into(),
ArrowType::None => "none".into(),
ArrowType::Empty => "empty".into(),
ArrowType::Diamond => "diamond".into(),
ArrowType::Ediamond => "ediamond".into(),
ArrowType::Box => "box".into(),
ArrowType::Open => "open".into(),
ArrowType::Vee => "vee".into(),
ArrowType::Inv => "inv".into(),
ArrowType::Invdot => "invdot".into(),
ArrowType::Invodot => "invodot".into(),
ArrowType::Tee => "tee".into(),
ArrowType::Invempty => "invempty".into(),
ArrowType::Odiamond => "odiamond".into(),
ArrowType::Crow => "crow".into(),
ArrowType::Obox => "obox".into(),
ArrowType::Halfopen => "halfopen".into(),
}
}
}
pub enum Direction {
Forward,
Back,
Both,
None,
}
impl<'a> From<Direction> for AttributeText<'a> {
fn from(direction: Direction) -> Self {
AttributeText::attr(direction.dot_string())
}
}
impl<'a> DotString<'a> for Direction {
fn dot_string(&self) -> Cow<'a, str> {
match self {
Direction::Forward => "forward".into(),
Direction::Back => "back".into(),
Direction::Both => "both".into(),
Direction::None => "none".into(),
}
}
}
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub enum RenderOption {
NoEdgeLabels,
NoNodeLabels,
NoEdgeStyles,
NoNodeStyles,
// TODO: replace with Fontname(String),
Monospace,
}
/// Returns vec holding all the default render options.
pub fn default_options() -> Vec<RenderOption> {
vec![]
}
// TODO: is this a good representation of color?
#[derive(Copy, Clone, PartialEq, Debug)]
pub enum Color<'a> {
RGB {
red: u8,
green: u8,
blue: u8
},
RGBA {
red: u8,
green: u8,
blue: u8,
alpha: u8,
},
// TODO: constrain?
// Hue-Saturation-Value (HSV) 0.0 <= H,S,V <= 1.0
HSV {
hue: f32,
saturation: f32,
value: f32
},
Named(&'a str),
}
impl<'a> Color<'a> {
pub fn to_dot_string(&self) -> String {
match self {
Color::RGB { red, green, blue } => {
format!("#{:02x?}{:02x?}{:02x?}", red, green, blue)
},
Color::RGBA { red, green, blue, alpha } => {
format!("#{:02x?}{:02x?}{:02x?}{:02x?}", red, green, blue, alpha)
},
Color::HSV { hue, saturation, value } => {
format!("{} {} {}", hue, saturation, value)
},
Color::Named(color) => {
(*color).to_string()
}
}
}
}
impl<'a> From<Color<'a>> for AttributeText<'a> {
fn from(color: Color<'a>) -> Self {
AttributeText::quoted(color.dot_string())
}
}
impl<'a> DotString<'a> for Color<'a> {
fn dot_string(&self) -> Cow<'a, str> {
match self {
Color::RGB { red, green, blue } => {
format!("#{}{}{}", red, green, blue).into()
},
Color::RGBA { red, green, blue, alpha } => {
format!("#{}{}{}{}", red, green, blue, alpha).into()
},
Color::HSV { hue, saturation, value } => {
format!("{} {} {}", hue, saturation, value).into()
},
Color::Named(color) => {
(*color).into()
}
}
}
}
// The sum of the optional weightings must sum to at most 1.
pub struct WeightedColor<'a> {
color: Color<'a>,
// TODO: constrain
/// Must be in range 0 <= W <= 1.
weight: Option<f32>
}
impl<'a> WeightedColor<'a> {
pub fn to_dot_string(&self) -> String {
let mut dot_string = self.color.to_dot_string();
if let Some(weight) = &self.weight {
dot_string.push_str(format!(";{}", weight).as_str());
}
dot_string
}
}
pub struct ColorList<'a> {
colors: Vec<WeightedColor<'a>>,
}
impl<'a> From<ColorList<'a>> for AttributeText<'a> {
fn from(color_list: ColorList<'a>) -> Self {
AttributeText::quoted(color_list.dot_string())
}
}
impl<'a> DotString<'a> for ColorList<'a> {
/// A colon-separated list of weighted color values: WC(:WC)* where each WC has the form C(;F)?
/// Ex: fillcolor=yellow;0.3:blue
fn dot_string(&self) -> Cow<'a, str> {
let mut dot_string = String::new();
let mut iter = self.colors.iter();
let first = iter.next();
if first.is_none() {
return dot_string.into();
}
dot_string.push_str(first.unwrap().to_dot_string().as_str());
for weighted_color in iter {
dot_string.push_str(":");
dot_string.push_str(weighted_color.to_dot_string().as_str())
}
dot_string.into()
}
}
/// Convert an element like `(i, j)` into a WeightedColor
pub trait IntoWeightedColor<'a> {
fn into_weighted_color(self) -> WeightedColor<'a>;
}
impl<'a> IntoWeightedColor<'a> for &'a (Color<'a>, Option<f32>) {
fn into_weighted_color(self) -> WeightedColor<'a> {
let (s, t) = *self;
WeightedColor {
color: s,
weight: t
}
}
}
pub enum NodeStyle {
Bold,
Dashed,
Diagonals,
Dotted,
Filled,
Invisible,
Rounded,
Solid,
Stripped,
Radical,
Wedged,
}
impl<'a> From<NodeStyle> for AttributeText<'a> {
fn from(style: NodeStyle) -> Self {
AttributeText::attr(style.dot_string())
}
}
impl<'a> DotString<'a> for NodeStyle {
fn dot_string(&self) -> Cow<'a, str> {
match self {
NodeStyle::Bold => "bold".into(),
NodeStyle::Dashed => "dashed".into(),
NodeStyle::Diagonals => "diagonals".into(),
NodeStyle::Dotted => "dotted".into(),
NodeStyle::Filled => "filled".into(),
NodeStyle::Invisible => "invisible".into(),
NodeStyle::Rounded => "rounded".into(),
NodeStyle::Solid => "solid".into(),
NodeStyle::Stripped => "stripped".into(),
NodeStyle::Radical => "radical".into(),
NodeStyle::Wedged => "wedged".into(),
}
}
}
// TODO: this might be a bit much to in order to avoid some duplication
// probably not worth it but is pattern is cool nonetheless
pub enum Styles {
Edge(EdgeStyle),
Node(NodeStyle),
Graph(GraphStyle)
}
impl<'a> From<Styles> for AttributeText<'a> {
fn from(styles: Styles) -> Self {
match styles {
Styles::Edge(s) => AttributeText::from(s),
Styles::Node(s) => AttributeText::from(s),
Styles::Graph(s) => AttributeText::from(s),
}
}
}
impl<'a> DotString<'a> for Styles {
fn dot_string(&self) -> Cow<'a, str> {
match self {
Styles::Edge(s) => s.dot_string(),
Styles::Node(s) => s.dot_string(),
Styles::Graph(s) => s.dot_string(),
}
}
}
pub enum EdgeStyle {
Bold,
Dashed,
Dotted,
Invisible,
Solid,
Tapered,
}
impl<'a> From<EdgeStyle> for AttributeText<'a> {
fn from(style: EdgeStyle) -> Self {
AttributeText::attr(style.dot_string())
}
}
impl<'a> DotString<'a> for EdgeStyle {
fn dot_string(&self) -> Cow<'a, str> {
match self {
EdgeStyle::Bold => "bold".into(),
EdgeStyle::Dashed => "dashed".into(),
EdgeStyle::Dotted => "dotted".into(),
EdgeStyle::Invisible => "invisible".into(),
EdgeStyle::Solid => "solid".into(),
EdgeStyle::Tapered => "tapered".into(),
}
}
}
pub enum GraphStyle {
Filled,
Radical,
Rounded,
Striped,
}
impl<'a> From<GraphStyle> for AttributeText<'a> {
fn from(style: GraphStyle) -> Self {
AttributeText::attr(style.dot_string())
}
}
impl<'a> DotString<'a> for GraphStyle {
fn dot_string(&self) -> Cow<'a, str> {
match self {
GraphStyle::Filled => "filled".into(),
GraphStyle::Radical => "radical".into(),
GraphStyle::Rounded => "rounded".into(),
GraphStyle::Striped => "striped".into(),
}
}
}
struct Attributes;
impl Attributes {
fn class(attributes: &mut IndexMap<String, AttributeText>, class: String) {
Self::add_attribute(attributes, "class", AttributeText::quoted(class))
}
fn color<'a>(attributes: &mut IndexMap<String, AttributeText<'a>>, color: Color<'a>) {
Self::add_attribute(attributes,"color", AttributeText::from(color))
}
fn color_with_colorlist<'a>(attributes: &mut IndexMap<String, AttributeText<'a>>, color: ColorList<'a>) {
Self::add_attribute(attributes,"color", AttributeText::from(color))
}
fn color_scheme(attributes: &mut IndexMap<String, AttributeText>, color_scheme: String) {
Self::add_attribute(attributes, "colorscheme", AttributeText::quoted(color_scheme))
}
fn comment(attributes: &mut IndexMap<String, AttributeText>, comment: String) {
Self::add_attribute(attributes, "comment", AttributeText::quoted(comment))
}
fn fill_color<'a>(attributes: &mut IndexMap<String, AttributeText<'a>>, fill_color: Color<'a>) {
Self::add_attribute(attributes, "fillcolor", AttributeText::from(fill_color))
}
fn fill_color_with_colorlist<'a>(attributes: &mut IndexMap<String, AttributeText<'a>>, fill_colors: ColorList<'a>) {
Self::add_attribute(attributes, "fillcolor", AttributeText::from(fill_colors))
}
fn fill_color_with_iter<'a, I>(attributes: &mut IndexMap<String, AttributeText<'a>>, fill_colors: I)
where
I: IntoIterator,
I::Item: IntoWeightedColor<'a>,
{
let colors:Vec<WeightedColor> = fill_colors.into_iter()
.map(|e| e.into_weighted_color())
.collect();
let color_list = ColorList {
colors
};
Self::add_attribute(attributes, "fillcolor", AttributeText::from(color_list))
}
fn font_color<'a>(attributes: &mut IndexMap<String, AttributeText<'a>>, font_color: Color<'a>) {
Self::add_attribute(attributes, "fontcolor", AttributeText::from(font_color))
}
fn font_name(attributes: &mut IndexMap<String, AttributeText>, font_name: String) {
Self::add_attribute(attributes, "fontname", AttributeText::quoted(font_name))
}
fn font_size(attributes: &mut IndexMap<String, AttributeText>, font_size: f32) {
Self::add_attribute(attributes, "fontsize", AttributeText::from(font_size))
}
fn gradient_angle(attributes: &mut IndexMap<String, AttributeText>, gradient_angle: u32) {
Self::add_attribute(attributes, "gradientangle", AttributeText::from(gradient_angle))
}
fn label(attributes: &mut IndexMap<String, AttributeText>, text: String) {
Self::add_attribute(attributes, "label", AttributeText::quoted(text));
}
fn label_location(attributes: &mut IndexMap<String, AttributeText>, label_location: LabelLocation) {
Self::add_attribute(attributes, "labelloc", AttributeText::from(label_location))
}
// TODO: layer struct
fn layer(attributes: &mut IndexMap<String, AttributeText>, layer: String) {
Self::add_attribute(attributes, "layer", AttributeText::attr(layer))
}
fn lp(attributes: &mut IndexMap<String, AttributeText>, lp: String) {
Self::add_attribute(attributes, "lp", AttributeText::attr(lp))
}
fn margin(attributes: &mut IndexMap<String, AttributeText>, margin: f32) {
Self::add_attribute(attributes, "margin", AttributeText::from(margin))
}
fn margin_point(attributes: &mut IndexMap<String, AttributeText>, margin: Point) {
Self::add_attribute(attributes, "margin", AttributeText::from(margin))
}
fn no_justify(attributes: &mut IndexMap<String, AttributeText>, no_justify: bool) {
Self::add_attribute(attributes, "nojustify", AttributeText::from(no_justify))
}
fn ordering(attributes: &mut IndexMap<String, AttributeText>, ordering: Ordering) {
Self::add_attribute(attributes, "ordering", AttributeText::from(ordering))
}
fn orientation(attributes: &mut IndexMap<String, AttributeText>, orientation: f32) {
Self::add_attribute(attributes, "orientation", AttributeText::from(orientation))
}
fn pen_width(attributes: &mut IndexMap<String, AttributeText>, pen_width: f32) {
Self::add_attribute(attributes, "penwidth", AttributeText::from(pen_width))
}
// TODO: splinetype
fn pos(attributes: &mut IndexMap<String, AttributeText>, pos: Point) {
Self::add_attribute(attributes, "pos", AttributeText::from(pos))
}
fn show_boxes(attributes: &mut IndexMap<String, AttributeText>, show_boxes: u32) {
Self::add_attribute(attributes, "showboxes", AttributeText::from(show_boxes))
}
fn sortv(attributes: &mut IndexMap<String, AttributeText>, sortv: u32) {
Self::add_attribute(attributes, "sortv", AttributeText::from(sortv))
}
fn style(attributes: &mut IndexMap<String, AttributeText>, style: Styles) {
Self::add_attribute(attributes, "style", AttributeText::from(style))
}
fn target(attributes: &mut IndexMap<String, AttributeText>, target: String) {
Self::add_attribute(attributes, "target", AttributeText::escaped(target))
}
fn tooltip(attributes: &mut IndexMap<String, AttributeText>, tooltip: String) {
Self::add_attribute(attributes, "tooltip", AttributeText::escaped(tooltip))
}
fn url(attributes: &mut IndexMap<String, AttributeText>, url: String) {
Self::add_attribute(attributes, "url", AttributeText::escaped(url))
}
fn xlabel(attributes: &mut IndexMap<String, AttributeText>, width: String) {
Self::add_attribute(attributes, "xlabel", AttributeText::escaped(width))
}
fn xlp(attributes: &mut IndexMap<String, AttributeText>, xlp: Point) {
Self::add_attribute(attributes, "xlp", AttributeText::from(xlp))
}
fn add_attribute<'a, S: Into<String>>(
attributes: &mut IndexMap<String, AttributeText<'a>>,
key: S,
value: AttributeText<'a>)
{
attributes.insert(key.into(), value);
}
}
fn test_input(g: Graph) -> io::Result<String>
{
let mut writer = Vec::new();
let dot = Dot {
graph: g
};
dot.render(&mut writer).unwrap();
let mut s = String::new();
Read::read_to_string(&mut &*writer, &mut s)?;
Ok(s)
}
#[test]
fn empty_digraph_without_id() {
// TODO: support both String and &str
let g = GraphBuilder::new_directed(None).build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"digraph {
}
"#
);
}
#[test]
fn graph_comment() {
// TODO: support both String and &str
let g = GraphBuilder::new_directed(None).comment("Comment goes here").build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"// Comment goes here
digraph {
}
"#
);
}
#[test]
fn empty_digraph() {
// TODO: support both String and &str
let g = GraphBuilder::new_directed(Some("empty_graph".to_string())).build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"digraph empty_graph {
}
"#
);
}
#[test]
fn empty_undirected_graph() {
// TODO: support both String and &str
let g = GraphBuilder::new_undirected(Some("empty_graph".to_string())).build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"graph empty_graph {
}
"#
);
}
#[test]
fn single_node() {
let g = GraphBuilder::new_directed(Some("single_node".to_string()))
.add_node(Node::new("N0".to_string()))
.build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"digraph single_node {
N0;
}
"#
);
}
#[test]
fn single_node_with_style() {
let node = NodeBuilder::new("N0".to_string())
.add_attribute("style", AttributeText::quoted("dashed"))
.build();
let g = GraphBuilder::new_directed(Some("single_node".to_string()))
.add_node(node)
.build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"digraph single_node {
N0 [style="dashed"];
}
"#
);
}
#[test]
fn support_non_inline_builder() {
let mut g = GraphBuilder::new_directed(Some("single_node".to_string()));
// TODO: having to split this is stupid. am i doing something wrong?
let mut node_builder = NodeBuilder::new("N0".to_string());
node_builder.add_attribute("style", AttributeText::quoted("dashed"));
if true {
node_builder.add_attribute("foo", AttributeText::quoted("baz"));
}
let node = node_builder.build();
g.add_node(node);
let r = test_input(g.build());
assert_eq!(
r.unwrap(),
r#"digraph single_node {
N0 [style="dashed", foo="baz"];
}
"#
);
}
#[test]
fn builder_support_shape() {
let node = NodeBuilder::new("N0".to_string())
.shape(Shape::Note)
.build();
let g = GraphBuilder::new_directed(Some("node_shape".to_string()))
.add_node(node)
.build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"digraph node_shape {
N0 [shape=note];
}
"#
);
}
#[test]
fn single_edge() {
let g = GraphBuilder::new_directed(Some("single_edge".to_string()))
.add_node(Node::new("N0".to_string()))
.add_node(Node::new("N1".to_string()))
.add_edge(Edge::new("N0".to_string(), "N1".to_string()))
.build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"digraph single_edge {
N0;
N1;
N0 -> N1;
}
"#
);
}
#[test]
fn single_edge_with_style() {
let edge = EdgeBuilder::new("N0".to_string(), "N1".to_string())
.add_attribute("style", AttributeText::quoted("bold"))
.build();
let g = GraphBuilder::new_directed(Some("single_edge".to_string()))
.add_node(Node::new("N0".to_string()))
.add_node(Node::new("N1".to_string()))
.add_edge(edge)
.build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"digraph single_edge {
N0;
N1;
N0 -> N1 [style="bold"];
}
"#
);
}
// yellow;0.3:blue
#[test]
fn colorlist_dot_string() {
let yellow = WeightedColor {
color: Color::Named("yellow"),
weight: Some(0.3)
};
let blue = WeightedColor {
color: Color::Named("blue"),
weight: None
};
let color_list = ColorList {
colors: vec![yellow, blue]
};
let dot_string = color_list.dot_string();
assert_eq!("yellow;0.3:blue", dot_string);
}
#[test]
fn color_rbg_dot_string() {
let color = Color::RGB {
red: 160,
green: 82,
blue: 45
};
assert_eq!("#a0522d", color.to_dot_string());
}
#[test]
fn color_rbga_dot_string() {
let color = Color::RGBA {
red: 160,
green: 82,
blue: 45,
alpha: 10
};
assert_eq!("#a0522d0a", color.to_dot_string());
}
#[test]
fn color_hsv_dot_string() {
let color = Color::HSV {
hue: 0.051,
saturation: 0.718,
value: 0.627,
};
assert_eq!("0.051 0.718 0.627", color.to_dot_string());
}
#[test]
fn spline_type() {
let spline_type = SplineType {
end: None,
start: None,
spline_points: vec![
Point::new_2d(0.0, 0.0, false),
Point::new_2d(1.0, 1.0, false),
Point::new_2d(1.0, -1.0, false)
],
};
assert_eq!("0.0,0.0 1.0,1.0 1.0,-1.0", spline_type.dot_string());
}
#[test]
fn spline_type_end() {
let spline_type = SplineType {
end: Some(Point::new_2d(2.0, 0.0, false)),
start: None,
spline_points: vec![
Point::new_2d(0.0, 0.0, false),
Point::new_2d(1.0, 1.0, false),
Point::new_2d(1.0, -1.0, false)
],
};
assert_eq!("e,2.0,0.0 0.0,0.0 1.0,1.0 1.0,-1.0", spline_type.dot_string());
}
#[test]
fn spline_type_start() {
let spline_type = SplineType {
end: None,
start: Some(Point::new_2d(-1.0, 0.0, false)),
spline_points: vec![
Point::new_2d(0.0, 0.0, false),
Point::new_2d(1.0, 1.0, false),
Point::new_2d(1.0, -1.0, false)
],
};
assert_eq!("s,-1.0,0.0 0.0,0.0 1.0,1.0 1.0,-1.0", spline_type.dot_string());
}
#[test]
fn spline_type_complete() {
let spline_type = SplineType {
end: Some(Point::new_2d(2.0, 0.0, false)),
start: Some(Point::new_2d(-1.0, 0.0, false)),
spline_points: vec![
Point::new_2d(0.0, 0.0, false),
Point::new_2d(1.0, 1.0, false),
Point::new_2d(1.0, -1.0, false)
],
};
assert_eq!("e,2.0,0.0 s,-1.0,0.0 0.0,0.0 1.0,1.0 1.0,-1.0", spline_type.dot_string());
}
#[test]
fn point_string() {
assert_eq!("1.0,2.0", Point::new_2d(1.0, 2.0, false).dot_string());
assert_eq!("1.0,2.0!", Point::new_2d(1.0, 2.0, true).dot_string());
assert_eq!("1.0,2.0,0.0", Point::new_3d(1.0, 2.0, 0.0, false).dot_string());
assert_eq!("1.0,2.0,0.0!", Point::new_3d(1.0, 2.0, 0.0, true).dot_string());
}
#[test]
fn graph_attribute_colorlist_vec_dot_string() {
let graph_attributes = GraphAttributeStatementBuilder::new()
.fill_color_with_iter(&[
(Color::Named("yellow"), Some(0.3)),
(Color::Named("blue"), None)
])
.build();
assert_eq!("graph [fillcolor=\"yellow;0.3:blue\"];", graph_attributes.to_dot_string());
}
#[test]
fn graph_attributes() {
let graph_attributes = GraphAttributeStatementBuilder::new().rank_dir(RankDir::LeftRight).build();
let node_attributes = NodeAttributeStatementBuilder::new().style(NodeStyle::Filled).build();
let edge_attributes = EdgeAttributeStatementBuilder::new().min_len(1).build();
let g = GraphBuilder::new_directed(Some("graph_attributes".to_string()))
.add_graph_attributes(graph_attributes)
.add_node_attributes(node_attributes)
.add_edge_attributes(edge_attributes)
.build();
let r = test_input(g);
assert_eq!(
r.unwrap(),
r#"digraph graph_attributes {
graph [rankdir=LR];
node [style=filled];
edge [minlen=1];
}
"#
);
}
|