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
// SPDX-License-Identifier: MPL-2.0
// SPDX-FileCopyrightText: 2026 FernTech
//! [`DockingModel`] — the shared, cloneable, serializable handle that backs a
//! [`DockingLayout`](super::DockingLayout). Mirrors the
//! [`SplitterModel`] / `SceneModel` pattern:
//! an `Rc<RefCell<…>>` with `&self` mutators that drop the borrow before
//! bumping `version`, so observers run with the model unlocked.
use std::cell::RefCell;
use std::collections::HashMap;
use std::rc::Rc;
use std::sync::atomic::{AtomicU64, Ordering};
use teksilo_canvas::Size;
use teksilo_core::signal::Signal;
use teksilo_i18n::{LocalizedString, lit};
use teksilo_settings::Versioned;
use teksilo_tokens::Orientation;
use crate::primitives::IconWidget;
use crate::splitter::{PaneDescriptor, SplitterModel};
use crate::toolbar::ToolbarItem;
pub use super::geometry::{CornerOwners, DockCorner, DockSide};
/// Builds an icon for a dock widget's tab / rail item on demand.
pub type DockIconFactory = Rc<dyn Fn() -> IconWidget>;
/// Builds a dock's inline header items on demand: a flat list of
/// [`ToolbarItem`]s — collapsible
/// [`ToolbarAction`](crate::toolbar::ToolbarAction)s (the VS Code "view actions"
/// pattern, e.g. "New File" / "Collapse All") and/or pinned custom widgets via
/// [`ToolbarItem::custom`]. Shown inside the dock header, before the framework
/// options (`⋮`) button. The framework hosts them in a
/// [`Toolbar`](crate::toolbar::Toolbar), so they gain **overflow** (excess actions
/// collapse into a `⌄` menu) and the correct **axis** for free — a horizontal row
/// on leading / trailing sides, a vertical column on the rotated top / bottom
/// strip — and an app never repeats the orientation or overflow logic.
pub type DockHeaderActionsFactory = Rc<dyn Fn(DockWidgetId) -> Vec<ToolbarItem>>;
/// Process-unique identity for a registered dock widget (the atomic unit).
#[derive(
Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, serde::Serialize, serde::Deserialize,
)]
pub struct DockWidgetId(pub u64);
impl DockWidgetId {
/// Mint a fresh, process-unique id.
pub fn fresh() -> Self {
static COUNTER: AtomicU64 = AtomicU64::new(1);
Self(COUNTER.fetch_add(1, Ordering::Relaxed))
}
pub fn from_raw(v: u64) -> Self {
Self(v)
}
pub fn raw(self) -> u64 {
self.0
}
}
/// Process-unique identity for a dock tab (a tab of a side's TabWidget).
#[derive(
Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, serde::Serialize, serde::Deserialize,
)]
pub struct DockTabId(pub u64);
impl DockTabId {
pub fn fresh() -> Self {
static COUNTER: AtomicU64 = AtomicU64::new(1);
Self(COUNTER.fetch_add(1, Ordering::Relaxed))
}
pub fn from_raw(v: u64) -> Self {
Self(v)
}
pub fn raw(self) -> u64 {
self.0
}
}
/// How a side surfaces its tabs: an in-side strip (the TabWidget's own bar) or
/// an always-visible activity rail outboard of the collapsible content.
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub enum TabPresentation {
/// In-side tab strip (hidden when a single tab is present).
Strip,
/// External always-visible activity rail; the in-side strip is suppressed.
Rail,
}
/// Placement mode for a programmatically-opened dock.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DockOpenMode {
/// Stack into the side's currently-selected tab (as a ToolBox section).
Stack,
/// Create a brand-new tab holding just this dock.
NewTab,
}
/// Target for [`DockingModel::open_dock`] / [`DockingModel::move_dock`].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DockOpenLocation {
pub side: DockSide,
pub mode: DockOpenMode,
}
impl DockOpenLocation {
/// Default placement on a side (stack into the active tab).
pub fn side(side: DockSide) -> Self {
Self {
side,
mode: DockOpenMode::Stack,
}
}
/// Stack into the side's active tab.
pub fn stack(mut self) -> Self {
self.mode = DockOpenMode::Stack;
self
}
/// Open as a fresh tab.
pub fn new_tab(mut self) -> Self {
self.mode = DockOpenMode::NewTab;
self
}
}
/// Activity-bar item size for a side's rail (context-menu "Activity bar size").
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DockRailItemSize {
/// The rail's configured size (`DockRail::size`); icon only, title on hover.
Default = 0,
/// Compact items — the standard
/// [`IconButtonSize::Default`](crate::icon_button::IconButtonSize::Default)
/// regardless of the rail's configured (larger) size; icon only, title on
/// hover. Not the extra-small `Compact` button: a rail glyph is the
/// activity's identifier and must stay legible.
Compact = 1,
/// Icon at the configured size **plus** a 90°-rotated title beneath it (the
/// vertical-accordion look). The title shows inline, so no hover tooltip.
Labeled = 2,
}
impl DockRailItemSize {
fn from_usize(v: usize) -> Self {
match v {
1 => Self::Compact,
2 => Self::Labeled,
_ => Self::Default,
}
}
/// Whether this mode paints the title inline (rotated) rather than only as a
/// hover tooltip.
pub fn shows_label(self) -> bool {
matches!(self, Self::Labeled)
}
}
/// How a side's dock tabs render (context-menu "Tab size").
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DockTabDisplay {
/// Title text only (the default).
Text = 0,
/// The dock's icon only (falls back to the title initial if it has none).
Icon = 1,
/// Icon + title.
IconText = 2,
}
impl DockTabDisplay {
fn from_usize(v: usize) -> Self {
match v {
1 => Self::Icon,
2 => Self::IconText,
_ => Self::Text,
}
}
/// Whether this mode shows the icon glyph.
pub fn shows_icon(self) -> bool {
matches!(self, Self::Icon | Self::IconText)
}
/// Whether this mode shows the title text.
pub fn shows_text(self) -> bool {
matches!(self, Self::Text | Self::IconText)
}
}
/// App-declared policy that **locks down end-user layout edits** on a
/// [`DockingLayout`](super::DockingLayout). Each flag removes a *user
/// affordance* only — the programmatic [`DockingModel`] API (a "Toggle panel"
/// button, `open_dock`, `set_tab_hidden`, …) keeps working regardless, so the
/// app can still drive the layout it has locked for the user.
///
/// App-declared each run (like `rail_thickness` / `min_size` / [`DockRail`](super::DockRail))
/// — **not** persisted in [`DockLayoutState`](super::DockLayoutState). Set it with
/// [`DockingModel::set_policy`]. Default = everything allowed; [`DockPolicy::locked`]
/// = everything forbidden.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DockPolicy {
/// The user may drag activities (rail items / tab headers) to reorder them
/// or move them between sides, and relocate them via the context-menu
/// "Move to" submenu. Default `true`.
pub allow_activity_drag: bool,
/// The user may drag a single dock out of a split pane (its accordion
/// header is a drag handle). Default `true`.
pub allow_dock_drag: bool,
/// The user may hide / collapse a whole side — via the resize handle
/// (drag-past-min snap, double-click, keyboard) or by clicking the active
/// activity-rail item. Default `true`.
pub allow_side_collapse: bool,
/// The user may hide an activity from the context menu. Default `true`.
pub allow_activity_hide: bool,
}
impl Default for DockPolicy {
fn default() -> Self {
Self {
allow_activity_drag: true,
allow_dock_drag: true,
allow_side_collapse: true,
allow_activity_hide: true,
}
}
}
impl DockPolicy {
/// A fully **locked** layout — no user drag, no collapse, no activity hide.
/// The app's programmatic API still drives it.
pub fn locked() -> Self {
Self {
allow_activity_drag: false,
allow_dock_drag: false,
allow_side_collapse: false,
allow_activity_hide: false,
}
}
}
/// Static metadata for a registered dock widget. App-declared; reconstructed
/// each run (never serialized).
pub(crate) struct DockWidgetMeta {
pub title: LocalizedString,
pub icon: Option<DockIconFactory>,
#[allow(dead_code)]
pub min_size: Option<Size>,
pub default: DockOpenLocation,
/// App-supplied inline header actions (e.g. "New File" / "Collapse All")
/// shown in the dock header before the `⋮` options button.
pub header_actions: Option<DockHeaderActionsFactory>,
/// Whether a **sole-pane** (bare) dock renders a header bar (title +
/// actions + `⋮`). The multi-pane Accordion header is always present; this
/// only governs the bare case. Default `false`.
pub show_header: bool,
}
/// One tab of a side's TabWidget: a `Splitter` arrangement of panes, each pane
/// a single dock. Stacking two docks side-by-side adds a Splitter pane (each
/// rendered as a single-item ToolBox) — there is no multi-section pane.
#[derive(Clone)]
pub(crate) struct DockTab {
pub id: DockTabId,
pub title: Option<LocalizedString>,
pub icon: Option<DockIconFactory>,
pub splitter: SplitterModel,
/// One dock per Splitter pane.
pub panes: Vec<DockWidgetId>,
/// User-hidden ("hide this activity"): kept in the model so it stays
/// listable + restorable, but not shown in the rail / tab strip.
pub hidden: bool,
}
/// Runtime state for one side.
pub(crate) struct SideState {
pub tabs: Vec<DockTab>,
pub selected_tab: usize,
pub presentation: TabPresentation,
pub rail_thickness: f32,
pub size: f32,
pub min_size: f32,
pub visible: bool,
/// App policy: a **disabled** side renders nothing, reserves no space, is
/// not a drop target, and rejects placement / moves to it (its docks stay
/// in the model and reappear when re-enabled). Default `true`.
pub enabled: bool,
pub visible_sig: Signal<bool>,
pub selected_tab_sig: Signal<usize>,
/// Activity-bar item size for this side's rail: `0` = the rail's configured
/// (default) size, `1` = compact. Reactive — the rail binds it at `Rebuild`
/// and re-reads the size when it flips.
pub rail_size_sig: Signal<usize>,
/// How this side's dock tabs render: `0` = text only, `1` = icon only,
/// `2` = icon + text. Reactive — the tab strip binds it at `Rebuild`.
pub tab_display_sig: Signal<usize>,
}
/// Where a dock currently lives. One dock per Splitter pane, so a
/// `(side, tab_idx, pane_idx)` triple addresses it exactly.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DockLoc {
pub side: DockSide,
pub tab_idx: usize,
pub pane_idx: usize,
}
/// What [`DockingModel::detach`] pruned, so a caller holding a target index in
/// the same side can correct for the resulting shift before re-inserting.
#[derive(Debug, Clone, Copy)]
struct DetachOutcome {
loc: DockLoc,
removed_pane: bool,
removed_tab: bool,
}
impl DetachOutcome {
/// Adjust a `(tab_idx, pane_idx)` drop target on `side` for the panes /
/// tabs this detach removed *before* it. (A removal *at* the target index
/// is the drop-on-self case, handled by an explicit no-op guard upstream.)
fn adjust_target(&self, side: DockSide, tab_idx: usize, pane_idx: usize) -> (usize, usize) {
if self.loc.side != side {
return (tab_idx, pane_idx);
}
if self.removed_tab {
// A whole tab vanished: indices after it shift down by one.
let tab_idx = if self.loc.tab_idx < tab_idx {
tab_idx - 1
} else {
tab_idx
};
return (tab_idx, pane_idx);
}
if self.removed_pane && self.loc.tab_idx == tab_idx && self.loc.pane_idx < pane_idx {
return (tab_idx, pane_idx - 1);
}
(tab_idx, pane_idx)
}
}
/// The splitter orientation a side uses to arrange its panes: leading /
/// trailing columns stack vertically; top / bottom strips run horizontally.
pub(crate) fn side_orientation(side: DockSide) -> Orientation {
if side.is_horizontal_axis() {
Orientation::Vertical
} else {
Orientation::Horizontal
}
}
fn default_side_state(side: DockSide) -> SideState {
let (size, rail, min) = if side.is_horizontal_axis() {
(260.0, 0.0, 120.0)
} else {
(200.0, 0.0, 80.0)
};
SideState {
tabs: Vec::new(),
selected_tab: 0,
presentation: TabPresentation::Strip,
rail_thickness: rail,
size,
min_size: min,
visible: false,
enabled: true,
visible_sig: Signal::new(false),
selected_tab_sig: Signal::new(0),
rail_size_sig: Signal::new(DockRailItemSize::Default as usize),
tab_display_sig: Signal::new(DockTabDisplay::Text as usize),
}
}
struct Inner {
sides: HashMap<DockSide, SideState>,
docks: HashMap<DockWidgetId, DockWidgetMeta>,
locations: HashMap<DockWidgetId, DockLoc>,
open_sigs: HashMap<DockWidgetId, Signal<bool>>,
/// Per-activity `hidden` reflect signals (the context-menu checklist binds
/// these so the checkmark tracks live model state). Cached per `DockTabId`,
/// kept in sync by `sync_derived`. Mirrors `open_sigs`.
tab_hidden_sigs: HashMap<DockTabId, Signal<bool>>,
corners: CornerOwners,
/// App-declared lock policy (not persisted). Read by the widgets in
/// `build()` to gate user affordances.
policy: DockPolicy,
/// Bumped on **structural** change (tab / pane / section / side
/// add-remove) — the widget binds it at `BindingLevel::Rebuild`.
version: Signal<u64>,
/// Bumped on **geometry** change (side size / visibility / corners) —
/// the widget binds it at `BindingLevel::Relayout`. Avoids a full rebuild
/// (and content teardown) for resize / show-hide / corner flips.
geometry_version: Signal<u64>,
animate_next: bool,
}
/// A read-only view of one tab, handed to the widget layer for rendering.
/// `panes` holds one dock per Splitter pane.
#[derive(Clone)]
pub(crate) struct DockTabView {
pub id: DockTabId,
pub title: Option<LocalizedString>,
pub icon: Option<DockIconFactory>,
pub splitter: SplitterModel,
pub panes: Vec<DockWidgetId>,
pub hidden: bool,
}
/// The shared docking-layout model. `Clone` = share-by-handle.
pub struct DockingModel(Rc<RefCell<Inner>>);
impl Clone for DockingModel {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}
impl std::fmt::Debug for DockingModel {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let inner = self.0.borrow();
f.debug_struct("DockingModel")
.field("docks", &inner.docks.len())
.field("open", &inner.locations.len())
.finish()
}
}
impl Default for DockingModel {
fn default() -> Self {
Self::new()
}
}
impl DockingModel {
/// A fresh model: four empty, hidden sides and the default corner owners.
pub fn new() -> Self {
let mut sides = HashMap::new();
for side in DockSide::ALL {
sides.insert(side, default_side_state(side));
}
Self(Rc::new(RefCell::new(Inner {
sides,
docks: HashMap::new(),
locations: HashMap::new(),
open_sigs: HashMap::new(),
tab_hidden_sigs: HashMap::new(),
corners: CornerOwners::default(),
policy: DockPolicy::default(),
version: Signal::new(0),
geometry_version: Signal::new(0),
animate_next: true,
})))
}
/// Structural version — bump on tab / pane / section / side add-remove.
/// The widget binds this at `BindingLevel::Rebuild`.
pub fn version(&self) -> Signal<u64> {
self.0.borrow().version.clone()
}
/// Geometry version — bump on side size / visibility / corner change.
/// The widget binds this at `BindingLevel::Relayout`.
pub fn geometry_version(&self) -> Signal<u64> {
self.0.borrow().geometry_version.clone()
}
/// Read-and-reset the "animate the next side show/hide" latch.
pub fn consume_animate_flag(&self) -> bool {
let mut inner = self.0.borrow_mut();
std::mem::replace(&mut inner.animate_next, true)
}
// ─── notify ────────────────────────────────────────────────────────
/// Re-sync all derived signals (visible / selected-tab / open) with the
/// borrow dropped first so observers may read the model.
fn sync_derived(&self) {
let mut updates_b: Vec<(Signal<bool>, bool)> = Vec::new();
let mut updates_u: Vec<(Signal<usize>, usize)> = Vec::new();
{
let inner = self.0.borrow();
for st in inner.sides.values() {
updates_b.push((st.visible_sig.clone(), st.visible));
updates_u.push((st.selected_tab_sig.clone(), st.selected_tab));
}
for (id, sig) in &inner.open_sigs {
updates_b.push((sig.clone(), inner.locations.contains_key(id)));
}
for (tab_id, sig) in &inner.tab_hidden_sigs {
let hidden = inner
.sides
.values()
.any(|st| st.tabs.iter().any(|t| t.id == *tab_id && t.hidden));
updates_b.push((sig.clone(), hidden));
}
}
for (sig, val) in updates_b {
if sig.get() != val {
sig.set(val);
}
}
for (sig, val) in updates_u {
if sig.get() != val {
sig.set(val);
}
}
}
/// Structural change: bump `version` (→ Rebuild) + re-sync derived.
fn notify(&self) {
let version = self.0.borrow().version.clone();
version.set(version.get().wrapping_add(1));
self.sync_derived();
}
/// Geometry change: bump `geometry_version` (→ Relayout) + re-sync derived.
/// Does NOT rebuild, so content subtrees are preserved.
fn relayout(&self) {
let gv = self.0.borrow().geometry_version.clone();
gv.set(gv.get().wrapping_add(1));
self.sync_derived();
}
/// Mark the next side-visibility change as non-animated (snap).
fn set_no_animate(&self) {
self.0.borrow_mut().animate_next = false;
}
// ─── registration ──────────────────────────────────────────────────
/// Register a dock widget's metadata. App-declared; idempotent (last
/// wins). Does not place the dock — use [`open_dock`](Self::open_dock).
pub(crate) fn register_meta(&self, id: DockWidgetId, meta: DockWidgetMeta) {
self.0.borrow_mut().docks.insert(id, meta);
}
/// Whether a dock id is known (its content factory + meta are registered).
pub fn is_registered(&self, id: DockWidgetId) -> bool {
self.0.borrow().docks.contains_key(&id)
}
// ─── side configuration ────────────────────────────────────────────
/// Set a side's activity-rail thickness and presentation. A non-zero rail
/// switches the side to [`TabPresentation::Rail`]; the in-side strip is
/// then suppressed.
pub fn set_side_rail(&self, side: DockSide, thickness: f32) {
{
let mut inner = self.0.borrow_mut();
if let Some(st) = inner.sides.get_mut(&side) {
st.rail_thickness = thickness.max(0.0);
st.presentation = if thickness > 0.0 {
TabPresentation::Rail
} else {
TabPresentation::Strip
};
}
}
self.notify();
}
/// Set a side's stored content size (px). Relayout only (no rebuild).
pub fn set_side_size(&self, side: DockSide, size: f32) {
{
let mut inner = self.0.borrow_mut();
if let Some(st) = inner.sides.get_mut(&side) {
st.size = size.max(0.0);
}
}
self.relayout();
}
/// Set a side's minimum content size (px).
pub fn set_side_min_size(&self, side: DockSide, min: f32) {
{
let mut inner = self.0.borrow_mut();
if let Some(st) = inner.sides.get_mut(&side) {
st.min_size = min.max(0.0);
}
}
self.relayout();
}
// ─── policy / per-side enable (app-declared lock-down) ─────────────────
/// Set the app's [`DockPolicy`] — locks down end-user layout edits (the
/// programmatic API keeps working). Structural → rebuild.
pub fn set_policy(&self, policy: DockPolicy) {
let changed = {
let mut inner = self.0.borrow_mut();
let changed = inner.policy != policy;
inner.policy = policy;
changed
};
if changed {
self.notify();
}
}
/// The app's current [`DockPolicy`] (cheap `Copy`; read by the widgets in
/// `build()` to gate their user affordances).
pub fn policy(&self) -> DockPolicy {
self.0.borrow().policy
}
/// Enable / disable a whole side. A disabled side renders nothing, reserves
/// no space, is not a drop target, and rejects placement / moves to it; its
/// docks stay in the model and reappear when re-enabled. Structural →
/// rebuild.
pub fn set_side_enabled(&self, side: DockSide, enabled: bool) {
let changed = {
let mut inner = self.0.borrow_mut();
match inner.sides.get_mut(&side) {
Some(st) if st.enabled != enabled => {
st.enabled = enabled;
true
}
_ => false,
}
};
if changed {
self.notify();
}
}
/// Whether a side is enabled (default `true`).
pub fn is_side_enabled(&self, side: DockSide) -> bool {
self.0.borrow().sides.get(&side).is_none_or(|s| s.enabled)
}
/// Show / hide a whole side (animated).
pub fn set_side_visible(&self, side: DockSide, visible: bool) {
self.set_side_visible_inner(side, visible, true);
}
/// Show / hide a side immediately (no animation — drag-driven).
pub fn set_side_visible_immediate(&self, side: DockSide, visible: bool) {
self.set_side_visible_inner(side, visible, false);
}
fn set_side_visible_inner(&self, side: DockSide, visible: bool, animate: bool) {
let changed = {
let mut inner = self.0.borrow_mut();
match inner.sides.get_mut(&side) {
Some(st) if st.visible != visible => {
st.visible = visible;
true
}
_ => false,
}
};
if changed {
if !animate {
self.set_no_animate();
}
// Relayout only: the side's content is pre-built and parked
// dormant when hidden, so showing / hiding animates without a
// rebuild (content preserved).
self.relayout();
}
}
/// Toggle a side's visibility (animated).
pub fn toggle_side_visible(&self, side: DockSide) {
let cur = self.is_side_visible(side);
self.set_side_visible(side, !cur);
}
/// Select the active tab of a side. Repaint only (the Switcher swaps via
/// its bound `selected_tab` signal — no rebuild, no relayout).
pub fn select_tab(&self, side: DockSide, tab_idx: usize) {
{
let mut inner = self.0.borrow_mut();
if let Some(st) = inner.sides.get_mut(&side)
&& tab_idx < st.tabs.len()
{
st.selected_tab = tab_idx;
}
}
self.sync_derived();
}
/// Select a side's active tab by id (position-independent — used by the
/// rail / strip, whose visible order may skip hidden tabs).
pub fn select_tab_by_id(&self, side: DockSide, tab_id: DockTabId) {
let idx = {
let inner = self.0.borrow();
inner
.sides
.get(&side)
.and_then(|st| st.tabs.iter().position(|t| t.id == tab_id))
};
if let Some(i) = idx {
self.select_tab(side, i);
}
}
// ─── per-activity hide (context-menu "Hide" + checkable list) ──────────
/// Hide / show one activity (tab). A hidden activity stays registered (so
/// it remains listable + restorable) but is dropped from the rail and tab
/// strip. Hiding the selected tab moves the selection to the nearest still-
/// visible tab. Structural → rebuild.
pub fn set_tab_hidden(&self, tab_id: DockTabId, hidden: bool) {
let mut changed = false;
{
let mut inner = self.0.borrow_mut();
'outer: for st in inner.sides.values_mut() {
if let Some(ti) = st.tabs.iter().position(|t| t.id == tab_id) {
if st.tabs[ti].hidden == hidden {
break 'outer;
}
st.tabs[ti].hidden = hidden;
changed = true;
// If we just hid the selected tab, move selection to the
// nearest non-hidden tab (forward first, then backward).
// When *no* tab is left visible (we hid the last one), reset
// to a coherent `0` rather than leaving `selected_tab` on the
// now-hidden index — otherwise the derived `selected_tab`
// signal points at an absent tab and the strip's
// `tw_selected` holds a `TabId` not in its visible list.
if hidden && st.selected_tab == ti {
st.selected_tab = Self::nearest_visible_tab(&st.tabs, ti + 1).unwrap_or(0);
}
break 'outer;
}
}
}
if changed {
self.notify();
}
}
/// Whether an activity (tab) is currently hidden.
pub fn is_tab_hidden(&self, tab_id: DockTabId) -> bool {
let inner = self.0.borrow();
inner
.sides
.values()
.any(|st| st.tabs.iter().any(|t| t.id == tab_id && t.hidden))
}
/// Count of a side's non-hidden tabs (the rail / strip item count).
pub(crate) fn side_visible_tab_count(&self, side: DockSide) -> usize {
let inner = self.0.borrow();
inner
.sides
.get(&side)
.map(|st| st.tabs.iter().filter(|t| !t.hidden).count())
.unwrap_or(0)
}
// ─── per-side display prefs (rail item size / tab display) ─────────────
/// The reactive rail-size selector for a side (`0` = configured size, `1` =
/// compact). The rail binds it at `Rebuild`; the context-menu radio writes
/// it.
pub(crate) fn rail_size_signal(&self, side: DockSide) -> Signal<usize> {
self.0
.borrow()
.sides
.get(&side)
.map(|st| st.rail_size_sig.clone())
.unwrap_or_else(|| Signal::new(0))
}
/// Current activity-bar item size for a side.
pub fn side_rail_size(&self, side: DockSide) -> DockRailItemSize {
DockRailItemSize::from_usize(self.rail_size_signal(side).get())
}
/// Set a side's activity-bar item size (reactive → the rail rebuilds).
pub fn set_side_rail_size(&self, side: DockSide, size: DockRailItemSize) {
self.rail_size_signal(side).set(size as usize);
}
/// Reactive activity-bar **size mode** for a side — fires whenever the user
/// switches Default / Compact / Icon + Label (via the context menu or
/// [`set_side_rail_size`](Self::set_side_rail_size)). Bind it to adapt any
/// external widget — a rail's slotted controls, an app toolbar — to the
/// rail's current item size. (The rail rebuilds its slots on every change,
/// so a slot factory that reads this signal stays in step.)
pub fn rail_size_mode_signal(&self, side: DockSide) -> Signal<DockRailItemSize> {
self.rail_size_signal(side)
.map(|v| DockRailItemSize::from_usize(*v))
}
/// The reactive tab-display mode for a side (`0`/`1`/`2`). The tab strip
/// binds it at `Rebuild`; the context-menu radio writes it.
pub(crate) fn tab_display_signal(&self, side: DockSide) -> Signal<usize> {
self.0
.borrow()
.sides
.get(&side)
.map(|st| st.tab_display_sig.clone())
.unwrap_or_else(|| Signal::new(0))
}
/// Current dock-tab display mode for a side.
pub fn side_tab_display(&self, side: DockSide) -> DockTabDisplay {
DockTabDisplay::from_usize(self.tab_display_signal(side).get())
}
/// Set a side's dock-tab display mode (reactive → the strip rebuilds).
pub fn set_side_tab_display(&self, side: DockSide, display: DockTabDisplay) {
self.tab_display_signal(side).set(display as usize);
}
/// Set the owner of a corner (must be one of its two adjacent sides).
pub fn set_corner(&self, corner: DockCorner, owner: DockSide) {
{
let mut inner = self.0.borrow_mut();
inner.corners.set(corner, owner);
}
self.relayout();
}
// ─── placement / movement ──────────────────────────────────────────
/// Detach a dock from wherever it currently lives, pruning the emptied
/// pane (and the tab, if that was its last pane). Returns a
/// [`DetachOutcome`] describing the dock's prior location and whether the
/// prune removed the enclosing pane / tab (so callers holding a target
/// index in the same side can adjust for the shift). Caller must
/// `notify()` afterwards.
fn detach(inner: &mut Inner, id: DockWidgetId) -> Option<DetachOutcome> {
let loc = inner.locations.remove(&id)?;
let mut removed_pane = false;
let mut removed_tab = false;
if let Some(st) = inner.sides.get_mut(&loc.side)
&& let Some(tab) = st.tabs.get_mut(loc.tab_idx)
&& loc.pane_idx < tab.panes.len()
{
// One dock per pane → detaching always removes the pane.
removed_pane = true;
tab.panes.remove(loc.pane_idx);
tab.splitter.remove_pane(loc.pane_idx);
if tab.panes.is_empty() {
removed_tab = true;
st.tabs.remove(loc.tab_idx);
Self::fix_selection_after_remove(st, loc.tab_idx);
}
}
// Rebuild every location for the affected side (indices shifted).
Self::reindex_side(inner, loc.side);
Some(DetachOutcome {
loc,
removed_pane,
removed_tab,
})
}
/// Fix up `selected_tab` after the tab at `removed_idx` was removed from
/// `st.tabs`. Three cases: the active tab sat *after* the removed one (it
/// shifts down by one, so follow it); the active tab ran off the end (clamp
/// to the new last); the side is now empty (reset + hide). Removing the
/// active tab from the middle deliberately advances selection to the tab
/// that shifted into its slot. Keeping this in one place avoids the
/// off-by-one that an inlined copy missed (the `removed_idx < selected`
/// branch). Caller must `notify()` afterwards.
fn fix_selection_after_remove(st: &mut SideState, removed_idx: usize) {
if removed_idx < st.selected_tab {
st.selected_tab -= 1;
} else if st.selected_tab >= st.tabs.len() && !st.tabs.is_empty() {
st.selected_tab = st.tabs.len() - 1;
}
if st.tabs.is_empty() {
st.selected_tab = 0;
st.visible = false;
}
}
/// The nearest non-hidden tab index, searching forward from `from` and then
/// backward before it. `None` when every tab is hidden. Shared by
/// `set_tab_hidden` (re-home the selection off a just-hidden tab) and
/// `import_state` (clamp a persisted selection that landed on a hidden tab).
fn nearest_visible_tab(tabs: &[DockTab], from: usize) -> Option<usize> {
let n = tabs.len();
(from..n)
.find(|&j| !tabs[j].hidden)
.or_else(|| (0..from.min(n)).rev().find(|&j| !tabs[j].hidden))
}
/// Recompute `locations` for every dock on a side after structural edits.
fn reindex_side(inner: &mut Inner, side: DockSide) {
let entries: Vec<(DockWidgetId, DockLoc)> = {
let Some(st) = inner.sides.get(&side) else {
return;
};
let mut out = Vec::new();
for (ti, tab) in st.tabs.iter().enumerate() {
for (pi, dock) in tab.panes.iter().enumerate() {
out.push((
*dock,
DockLoc {
side,
tab_idx: ti,
pane_idx: pi,
},
));
}
}
out
};
// Drop stale entries for this side, then re-insert.
inner.locations.retain(|_, l| l.side != side);
for (id, loc) in entries {
inner.locations.insert(id, loc);
}
}
fn new_tab(side: DockSide, dock: DockWidgetId) -> DockTab {
DockTab {
id: DockTabId::fresh(),
title: None,
icon: None,
splitter: SplitterModel::new(1, side_orientation(side)),
panes: vec![dock],
hidden: false,
}
}
/// Open (or move) a dock onto a side. Already-open docks are relocated
/// (never duplicated).
pub fn open_dock(&self, id: DockWidgetId, loc: DockOpenLocation) {
{
let mut inner = self.0.borrow_mut();
if !inner.docks.contains_key(&id) {
debug_assert!(false, "open_dock on unregistered dock {id:?}");
return;
}
if !Self::side_accepts(&inner, loc.side) {
return; // disabled side rejects placement
}
// Ensure-open semantics: re-opening a dock already on the target
// side is a no-op (no version churn). Moving across sides, and the
// explicit promote/split/move mutators, still re-place it.
if inner.locations.get(&id).map(|l| l.side) == Some(loc.side) {
return;
}
Self::detach(&mut inner, id);
Self::place(&mut inner, id, loc);
}
self.notify();
}
/// Whether `side` accepts placement (disabled sides reject it). Read from
/// an already-borrowed `Inner` by the placement mutators.
fn side_accepts(inner: &Inner, side: DockSide) -> bool {
inner.sides.get(&side).is_none_or(|s| s.enabled)
}
fn place(inner: &mut Inner, id: DockWidgetId, loc: DockOpenLocation) {
let side = loc.side;
let orientation = side_orientation(side);
if let Some(st) = inner.sides.get_mut(&side) {
st.visible = true;
match loc.mode {
DockOpenMode::NewTab => {
st.tabs.push(DockTab {
id: DockTabId::fresh(),
title: None,
icon: None,
splitter: SplitterModel::new(1, orientation),
panes: vec![id],
hidden: false,
});
st.selected_tab = st.tabs.len() - 1;
}
DockOpenMode::Stack => {
if st.tabs.is_empty() {
st.tabs.push(DockTab {
id: DockTabId::fresh(),
title: None,
icon: None,
splitter: SplitterModel::new(1, orientation),
panes: vec![id],
hidden: false,
});
st.selected_tab = 0;
} else {
// Stacking adds a Splitter pane to the selected tab
// (each pane is its own single-item ToolBox), not a
// multi-section pane.
let ti = st.selected_tab.min(st.tabs.len() - 1);
let tab = &mut st.tabs[ti];
let at = tab.panes.len();
tab.panes.push(id);
tab.splitter
.insert_pane(at, PaneDescriptor::new().stretch(1.0));
st.selected_tab = ti;
}
}
}
}
Self::reindex_side(inner, side);
}
/// Drag a dock out into its own new tab on `side`, inserted at `at_tab`.
pub fn promote_to_tab(&self, id: DockWidgetId, side: DockSide, at_tab: usize) {
{
let mut inner = self.0.borrow_mut();
if !inner.docks.contains_key(&id) || !Self::side_accepts(&inner, side) {
return;
}
// Already its own sole tab on this side at this index → no-op.
if let Some(loc) = inner.locations.get(&id)
&& loc.side == side
&& loc.tab_idx == at_tab
&& inner
.sides
.get(&side)
.and_then(|st| st.tabs.get(at_tab))
.map(|t| t.panes.len() == 1)
.unwrap_or(false)
{
return;
}
let mut at_tab = at_tab;
if let Some(outcome) = Self::detach(&mut inner, id) {
(at_tab, _) = outcome.adjust_target(side, at_tab, 0);
}
let tab = Self::new_tab(side, id);
if let Some(st) = inner.sides.get_mut(&side) {
let at = at_tab.min(st.tabs.len());
st.tabs.insert(at, tab);
st.selected_tab = at;
st.visible = true;
}
Self::reindex_side(&mut inner, side);
}
self.notify();
}
/// Drop a dock into an existing tab's Splitter as a new `Single` pane,
/// before (`before = true`) or after the pane at `pane_idx`.
pub fn split_into_tab(
&self,
id: DockWidgetId,
side: DockSide,
tab_idx: usize,
pane_idx: usize,
before: bool,
) {
{
let mut inner = self.0.borrow_mut();
if !inner.docks.contains_key(&id) || !Self::side_accepts(&inner, side) {
return;
}
// Drop-on-self: splitting the pane a dock already solely occupies
// with that same dock changes nothing. No-op (no churn).
if let Some(loc) = inner.locations.get(&id)
&& loc.side == side
&& loc.tab_idx == tab_idx
&& loc.pane_idx == pane_idx
{
return;
}
// Detach first, then correct the target for any pane / tab the
// detach pruned at an earlier index in this side.
let (mut tab_idx, mut pane_idx) = (tab_idx, pane_idx);
if let Some(outcome) = Self::detach(&mut inner, id) {
(tab_idx, pane_idx) = outcome.adjust_target(side, tab_idx, pane_idx);
}
if let Some(st) = inner.sides.get_mut(&side)
&& let Some(tab) = st.tabs.get_mut(tab_idx)
{
let at = if before { pane_idx } else { pane_idx + 1 };
let at = at.min(tab.panes.len());
tab.panes.insert(at, id);
tab.splitter
.insert_pane(at, PaneDescriptor::new().stretch(1.0));
st.visible = true;
st.selected_tab = tab_idx;
}
Self::reindex_side(&mut inner, side);
}
self.notify();
}
/// Drop a dock into a tab as a new Splitter pane appended after its
/// existing panes (the "centre" drop — join this group without choosing a
/// split direction). Each pane is its own single-item ToolBox.
pub fn stack_into_tab(&self, id: DockWidgetId, side: DockSide, tab_idx: usize) {
{
let mut inner = self.0.borrow_mut();
if !inner.docks.contains_key(&id) || !Self::side_accepts(&inner, side) {
return;
}
// Drop-on-self: a dock that is already the sole pane of this tab.
if let Some(loc) = inner.locations.get(&id)
&& loc.side == side
&& loc.tab_idx == tab_idx
&& inner
.sides
.get(&side)
.and_then(|st| st.tabs.get(tab_idx))
.map(|t| t.panes.len() == 1)
.unwrap_or(false)
{
return;
}
let mut tab_idx = tab_idx;
if let Some(outcome) = Self::detach(&mut inner, id) {
(tab_idx, _) = outcome.adjust_target(side, tab_idx, 0);
}
if let Some(st) = inner.sides.get_mut(&side)
&& let Some(tab) = st.tabs.get_mut(tab_idx)
{
let at = tab.panes.len();
tab.panes.push(id);
tab.splitter
.insert_pane(at, PaneDescriptor::new().stretch(1.0));
st.visible = true;
st.selected_tab = tab_idx;
}
Self::reindex_side(&mut inner, side);
}
self.notify();
}
/// Move a dock to another location (close + open in one notify).
pub fn move_dock(&self, id: DockWidgetId, loc: DockOpenLocation) {
self.open_dock(id, loc);
}
/// Close a whole tab (and every dock it holds).
pub fn close_tab(&self, tab_id: DockTabId) {
{
let mut inner = self.0.borrow_mut();
let mut found: Option<(DockSide, usize)> = None;
for side in DockSide::ALL {
if let Some(st) = inner.sides.get(&side)
&& let Some(ti) = st.tabs.iter().position(|t| t.id == tab_id)
{
found = Some((side, ti));
break;
}
}
let Some((side, ti)) = found else {
return;
};
if let Some(st) = inner.sides.get_mut(&side) {
st.tabs.remove(ti);
Self::fix_selection_after_remove(st, ti);
}
Self::reindex_side(&mut inner, side);
}
self.notify();
}
/// Move a whole tab (its arrangement + every dock + selection) to another
/// side, re-deriving the Splitter orientation. Inserted at `at_tab`.
pub fn move_tab(&self, tab_id: DockTabId, target_side: DockSide, at_tab: usize) {
{
let mut inner = self.0.borrow_mut();
if !Self::side_accepts(&inner, target_side) {
return; // disabled side rejects moves
}
// Find + remove the tab from its current side.
let mut found: Option<(DockSide, usize)> = None;
for side in DockSide::ALL {
if let Some(st) = inner.sides.get(&side)
&& let Some(ti) = st.tabs.iter().position(|t| t.id == tab_id)
{
found = Some((side, ti));
break;
}
}
let Some((src_side, src_ti)) = found else {
return;
};
if src_side == target_side {
// Same-side reorder.
if let Some(st) = inner.sides.get_mut(&src_side) {
let tab = st.tabs.remove(src_ti);
let at = at_tab.min(st.tabs.len());
st.tabs.insert(at, tab);
st.selected_tab = at;
}
Self::reindex_side(&mut inner, src_side);
} else {
let tab = {
let st = inner.sides.get_mut(&src_side).unwrap();
let tab = st.tabs.remove(src_ti);
Self::fix_selection_after_remove(st, src_ti);
tab
};
// Re-derive orientation for the destination side.
tab.splitter.set_orientation(side_orientation(target_side));
if let Some(dst) = inner.sides.get_mut(&target_side) {
let at = at_tab.min(dst.tabs.len());
dst.tabs.insert(at, tab);
dst.selected_tab = at;
dst.visible = true;
}
Self::reindex_side(&mut inner, src_side);
Self::reindex_side(&mut inner, target_side);
}
}
self.notify();
}
/// Close (remove) a dock from the layout.
pub fn close_dock(&self, id: DockWidgetId) {
{
let mut inner = self.0.borrow_mut();
Self::detach(&mut inner, id);
}
self.notify();
}
/// Toggle a dock: close it if open, else open it on its default location.
pub fn toggle_dock(&self, id: DockWidgetId) {
if self.is_dock_open(id) {
self.close_dock(id);
} else {
let default = self.0.borrow().docks.get(&id).map(|m| m.default);
if let Some(loc) = default {
self.open_dock(id, loc);
}
}
}
/// Reveal a dock: ensure it is open, show + select its side / tab.
pub fn reveal_dock(&self, id: DockWidgetId) {
let loc = self.0.borrow().locations.get(&id).copied();
match loc {
Some(loc) => {
// **Silent when there is nothing to reveal.** Notifying anyway
// rebuilds every dock's content, and a dock's content is where a
// view's own state lives -- a list's scroll position, a tree's.
// Revealing an already-revealed dock is the common case, not the
// rare one: it is what every "show me this result" does on the
// second and every subsequent result, and each one was sending the
// panel back to the top.
let changed = {
let mut inner = self.0.borrow_mut();
let tabs = inner
.sides
.get(&loc.side)
.map_or(0, |st| st.tabs.len())
.saturating_sub(1);
match inner.sides.get_mut(&loc.side) {
Some(st) => {
let tab = loc.tab_idx.min(tabs);
let changed = !st.visible || st.selected_tab != tab;
st.visible = true;
st.selected_tab = tab;
changed
}
None => false,
}
};
if changed {
self.notify();
}
}
None => {
let default = self.0.borrow().docks.get(&id).map(|m| m.default);
if let Some(loc) = default {
self.open_dock(id, loc);
}
}
}
}
// ─── queries ───────────────────────────────────────────────────────
pub fn is_dock_open(&self, id: DockWidgetId) -> bool {
self.0.borrow().locations.contains_key(&id)
}
/// Every currently-open dock id (used by the layout to materialize
/// content).
pub(crate) fn open_dock_ids(&self) -> Vec<DockWidgetId> {
self.0.borrow().locations.keys().copied().collect()
}
pub fn dock_location(&self, id: DockWidgetId) -> Option<DockLoc> {
self.0.borrow().locations.get(&id).copied()
}
/// A reactive `true`-while-open signal for an external rail / toolbar.
pub fn dock_open_signal(&self, id: DockWidgetId) -> Signal<bool> {
let mut inner = self.0.borrow_mut();
let open = inner.locations.contains_key(&id);
inner
.open_sigs
.entry(id)
.or_insert_with(|| Signal::new(open))
.clone()
}
pub fn is_side_visible(&self, side: DockSide) -> bool {
self.0.borrow().sides.get(&side).is_some_and(|s| s.visible)
}
pub fn side_visible_signal(&self, side: DockSide) -> Signal<bool> {
self.0
.borrow()
.sides
.get(&side)
.map(|s| s.visible_sig.clone())
.unwrap_or_else(|| Signal::new(false))
}
pub fn side_selected_tab_signal(&self, side: DockSide) -> Signal<usize> {
self.0
.borrow()
.sides
.get(&side)
.map(|s| s.selected_tab_sig.clone())
.unwrap_or_else(|| Signal::new(0))
}
pub fn side_selected_tab(&self, side: DockSide) -> usize {
self.0
.borrow()
.sides
.get(&side)
.map(|s| s.selected_tab)
.unwrap_or(0)
}
pub fn side_presentation(&self, side: DockSide) -> TabPresentation {
self.0
.borrow()
.sides
.get(&side)
.map(|s| s.presentation)
.unwrap_or(TabPresentation::Strip)
}
pub fn side_size(&self, side: DockSide) -> f32 {
self.0
.borrow()
.sides
.get(&side)
.map(|s| s.size)
.unwrap_or(0.0)
}
pub fn side_min_size(&self, side: DockSide) -> f32 {
self.0
.borrow()
.sides
.get(&side)
.map(|s| s.min_size)
.unwrap_or(0.0)
}
pub fn side_rail_thickness(&self, side: DockSide) -> f32 {
self.0
.borrow()
.sides
.get(&side)
.map(|s| {
if matches!(s.presentation, TabPresentation::Rail) {
s.rail_thickness
} else {
0.0
}
})
.unwrap_or(0.0)
}
pub fn side_has_rail(&self, side: DockSide) -> bool {
self.side_rail_thickness(side) > 0.0
}
pub fn corner_owner(&self, corner: DockCorner) -> DockSide {
self.0.borrow().corners.owner(corner)
}
pub(crate) fn corners(&self) -> CornerOwners {
self.0.borrow().corners
}
pub fn tab_count(&self, side: DockSide) -> usize {
self.0
.borrow()
.sides
.get(&side)
.map(|s| s.tabs.len())
.unwrap_or(0)
}
/// The model index at which a whole-tab "append to this side" should insert:
/// just **after the last non-hidden tab**, so the appended tab reappears in
/// the right relative order even when hidden tabs trail in the model. Equal
/// to `tab_count` when no tab is hidden. Used by the whole-tab drop paths
/// (rail / strip / pane / empty-side) instead of a blind `tab_count`.
pub(crate) fn side_append_index(&self, side: DockSide) -> usize {
let inner = self.0.borrow();
match inner.sides.get(&side) {
Some(st) => st
.tabs
.iter()
.rposition(|t| !t.hidden)
.map(|i| i + 1)
.unwrap_or(st.tabs.len()),
None => 0,
}
}
/// Title + icon for a registered dock (for tab / rail rendering).
pub(crate) fn dock_title(&self, id: DockWidgetId) -> Option<LocalizedString> {
self.0.borrow().docks.get(&id).map(|m| m.title.clone())
}
pub(crate) fn dock_icon(&self, id: DockWidgetId) -> Option<DockIconFactory> {
self.0.borrow().docks.get(&id).and_then(|m| m.icon.clone())
}
/// Snapshot a side's tabs for rendering.
pub(crate) fn side_tabs(&self, side: DockSide) -> Vec<DockTabView> {
let inner = self.0.borrow();
let Some(st) = inner.sides.get(&side) else {
return Vec::new();
};
st.tabs
.iter()
.map(|tab| DockTabView {
id: tab.id,
title: tab.title.clone(),
icon: tab.icon.clone(),
splitter: tab.splitter.clone(),
panes: tab.panes.clone(),
hidden: tab.hidden,
})
.collect()
}
/// All docks held by a tab (one per pane).
pub(crate) fn tab_docks(&self, tab_id: DockTabId) -> Vec<DockWidgetId> {
let inner = self.0.borrow();
for st in inner.sides.values() {
if let Some(tab) = st.tabs.iter().find(|t| t.id == tab_id) {
return tab.panes.clone();
}
}
Vec::new()
}
/// Find a tab anywhere by id, returning its current side + a render view.
pub(crate) fn tab_view_by_id(&self, tab_id: DockTabId) -> Option<(DockSide, DockTabView)> {
for side in DockSide::ALL {
if let Some(view) = self.side_tabs(side).into_iter().find(|t| t.id == tab_id) {
return Some((side, view));
}
}
None
}
/// The id of the tab at `idx` in a side's full tab list. The live inverse
/// of [`select_tab_by_id`](Self::select_tab_by_id) — the strip's
/// index → id selection sync uses it so both directions resolve against the
/// *current* order and agree across a reorder (a build-time snapshot would
/// disagree and feed back unboundedly).
pub fn tab_id_at(&self, side: DockSide, idx: usize) -> Option<DockTabId> {
let inner = self.0.borrow();
inner
.sides
.get(&side)
.and_then(|st| st.tabs.get(idx).map(|t| t.id))
}
// ─── activity naming + label/icon derivation ───────────────────────────
/// The dock whose title + icon represent an activity in the rail / strip:
/// the first **non-collapsed** pane (so the label follows the panel the user
/// actually sees), falling back to the first pane.
pub(crate) fn primary_dock_of(view: &DockTabView) -> Option<DockWidgetId> {
view.panes
.iter()
.enumerate()
.find(|(i, _)| !view.splitter.is_collapsed(*i))
.map(|(_, d)| *d)
.or_else(|| view.panes.first().copied())
}
/// The displayed name for an activity: an explicit [`set_tab_title`](Self::set_tab_title)
/// override, else the primary pane's dock title, else the `"Panel"` fallback.
pub(crate) fn activity_label(&self, view: &DockTabView) -> LocalizedString {
view.title
.clone()
.or_else(|| Self::primary_dock_of(view).and_then(|d| self.dock_title(d)))
.unwrap_or_else(|| lit!("Panel"))
}
/// The icon for an activity: an explicit tab icon, else the primary pane's
/// dock icon, else `None` (rail / strip then fall back to the title initial).
pub(crate) fn activity_icon(&self, view: &DockTabView) -> Option<DockIconFactory> {
view.icon
.clone()
.or_else(|| Self::primary_dock_of(view).and_then(|d| self.dock_icon(d)))
}
/// Give an activity (tab) a stable, explicit name, independent of which dock
/// occupies pane 0 (e.g. a grouped "Source Control" activity holding a file
/// tree and a git pane). Pass `None` to clear it (the label then derives from
/// the primary dock again). App-config — reconstructed each run, like dock
/// titles; not persisted. Structural → rebuild.
pub fn set_tab_title(&self, tab_id: DockTabId, title: Option<LocalizedString>) {
let mut changed = false;
{
let mut inner = self.0.borrow_mut();
'outer: for st in inner.sides.values_mut() {
if let Some(tab) = st.tabs.iter_mut().find(|t| t.id == tab_id) {
tab.title = title;
changed = true;
break 'outer;
}
}
}
if changed {
self.notify();
}
}
/// The explicit title set on an activity (`None` when it derives from its
/// primary dock).
pub fn tab_title(&self, tab_id: DockTabId) -> Option<LocalizedString> {
let inner = self.0.borrow();
inner
.sides
.values()
.flat_map(|st| st.tabs.iter())
.find(|t| t.id == tab_id)
.and_then(|t| t.title.clone())
}
/// The activity (tab) currently holding a dock — apps hold stable
/// [`DockWidgetId`]s, so this is the bridge to address the enclosing tab.
pub fn activity_of(&self, dock_id: DockWidgetId) -> Option<DockTabId> {
let inner = self.0.borrow();
let loc = inner.locations.get(&dock_id)?;
inner
.sides
.get(&loc.side)
.and_then(|st| st.tabs.get(loc.tab_idx))
.map(|t| t.id)
}
/// Sugar: name the activity that currently holds `dock_id`. The natural way
/// to title a grouped activity from app code that holds the dock id.
pub fn set_dock_activity_title(
&self,
dock_id: DockWidgetId,
title: impl Into<LocalizedString>,
) {
if let Some(tab_id) = self.activity_of(dock_id) {
self.set_tab_title(tab_id, Some(title.into()));
}
}
/// The enabled sides a tab / dock on `from` can be relocated to (every side
/// except `from`, keeping only [`is_side_enabled`](Self::is_side_enabled)).
/// The "Move to" menus iterate this so a disabled side is never offered as a
/// silently-rejected target.
pub fn enabled_move_targets(&self, from: DockSide) -> Vec<DockSide> {
DockSide::ALL
.into_iter()
.filter(|&s| s != from && self.is_side_enabled(s))
.collect()
}
/// A reactive `true`-while-hidden signal for an activity, cached per id —
/// the context-menu checklist binds it so its checkmark tracks live model
/// state (`set_tab_hidden` from any source updates it via `sync_derived`).
/// Mirrors [`dock_open_signal`](Self::dock_open_signal).
pub(crate) fn tab_hidden_signal(&self, tab_id: DockTabId) -> Signal<bool> {
let mut inner = self.0.borrow_mut();
let hidden = inner
.sides
.values()
.any(|st| st.tabs.iter().any(|t| t.id == tab_id && t.hidden));
inner
.tab_hidden_sigs
.entry(tab_id)
.or_insert_with(|| Signal::new(hidden))
.clone()
}
/// App-supplied inline header-action factory for a dock, if declared.
pub(crate) fn dock_header_actions(&self, id: DockWidgetId) -> Option<DockHeaderActionsFactory> {
self.0
.borrow()
.docks
.get(&id)
.and_then(|m| m.header_actions.clone())
}
/// Whether a sole-pane (bare) dock should render its own header bar.
pub(crate) fn dock_show_header(&self, id: DockWidgetId) -> bool {
self.0
.borrow()
.docks
.get(&id)
.map(|m| m.show_header)
.unwrap_or(false)
}
// ─── persistence ───────────────────────────────────────────────────
/// Serialize the user-controllable layout state (sizes / visibility /
/// selections / arrangement structure / corners). App-config (rail
/// thickness, mins, content factories) is reconstructed each run.
pub fn export_state(&self) -> super::state::DockLayoutState {
use super::state::*;
let inner = self.0.borrow();
let side_state = |side: DockSide| -> DockSideState {
let Some(st) = inner.sides.get(&side) else {
return DockSideState::default();
};
DockSideState {
presentation: st.presentation,
size_px: st.size,
visible: st.visible,
selected_tab: st.selected_tab,
tabs: st
.tabs
.iter()
.map(|tab| DockTabState {
id: tab.id.raw(),
splitter: tab.splitter.export_state(),
panes: tab.panes.iter().map(|d| d.raw()).collect(),
hidden: tab.hidden,
})
.collect(),
rail_size: st
.rail_size_sig
.get()
.min(DockRailItemSize::Labeled as usize),
tab_display: st.tab_display_sig.get(),
}
};
DockLayoutState {
version: DockLayoutState::CURRENT_VERSION,
leading: side_state(DockSide::Leading),
trailing: side_state(DockSide::Trailing),
top: side_state(DockSide::Top),
bottom: side_state(DockSide::Bottom),
corners: inner.corners,
}
}
/// Restore a previously-exported state. Unknown dock ids are dropped,
/// emptied panes / tabs pruned, selections clamped. Bumps `version`.
pub fn import_state(&self, state: &super::state::DockLayoutState) {
use super::state::*;
{
let mut inner = self.0.borrow_mut();
inner.corners = state.corners;
let known: std::collections::HashSet<u64> =
inner.docks.keys().map(|k| k.raw()).collect();
let restore = |inner: &mut Inner, side: DockSide, dto: &DockSideState| {
let orientation = side_orientation(side);
let mut tabs: Vec<DockTab> = Vec::new();
for tab_dto in &dto.tabs {
let mut panes: Vec<DockWidgetId> = Vec::new();
for dock in &tab_dto.panes {
if known.contains(dock) {
panes.push(DockWidgetId::from_raw(*dock));
}
}
if !panes.is_empty() {
let splitter = SplitterModel::new(panes.len(), orientation);
// Best-effort: import sizes only when the pane count
// matches the surviving panes.
if splitter.pane_count() == tab_dto.panes.len() {
splitter.import_state(&tab_dto.splitter);
}
tabs.push(DockTab {
id: DockTabId::from_raw(tab_dto.id),
title: None,
icon: None,
splitter,
panes,
hidden: tab_dto.hidden,
});
}
}
// Clamp the persisted selection into range, then re-home it off
// a hidden tab onto the nearest visible one. A session that was
// closed with a hidden tab selected would otherwise restore with
// `selected_tab` pointing at a hidden tab — no active highlight
// in the rail, a wrong roving tab-stop — until the first click.
let selected_tab = if tabs.is_empty() {
0
} else {
let clamped = dto.selected_tab.min(tabs.len() - 1);
Self::nearest_visible_tab(&tabs, clamped).unwrap_or(clamped)
};
if let Some(st) = inner.sides.get_mut(&side) {
st.presentation = dto.presentation;
st.size = dto.size_px;
st.visible = dto.visible && !tabs.is_empty();
st.selected_tab = selected_tab;
st.tabs = tabs;
st.rail_size_sig
.set(dto.rail_size.min(DockRailItemSize::Labeled as usize));
st.tab_display_sig.set(dto.tab_display.min(2));
}
};
restore(&mut inner, DockSide::Leading, &state.leading);
restore(&mut inner, DockSide::Trailing, &state.trailing);
restore(&mut inner, DockSide::Top, &state.top);
restore(&mut inner, DockSide::Bottom, &state.bottom);
inner.locations.clear();
for side in DockSide::ALL {
Self::reindex_side(&mut inner, side);
}
}
self.notify();
}
}
#[cfg(test)]
mod tests {
use super::*;
use teksilo_i18n::lit;
fn model() -> DockingModel {
DockingModel::new()
}
fn reg(m: &DockingModel, side: DockSide) -> DockWidgetId {
let id = DockWidgetId::fresh();
m.register_meta(
id,
DockWidgetMeta {
title: lit!("Dock"),
icon: None,
min_size: None,
default: DockOpenLocation::side(side),
header_actions: None,
show_header: false,
},
);
id
}
#[test]
fn open_dock_places_and_shows_side() {
let m = model();
let id = reg(&m, DockSide::Leading);
assert!(!m.is_side_visible(DockSide::Leading));
m.open_dock(id, DockOpenLocation::side(DockSide::Leading));
assert!(m.is_dock_open(id));
assert!(m.is_side_visible(DockSide::Leading));
assert_eq!(m.dock_location(id).unwrap().side, DockSide::Leading);
}
#[test]
fn stack_adds_a_splitter_pane_to_one_tab() {
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).stack());
let tabs = m.side_tabs(DockSide::Leading);
assert_eq!(tabs.len(), 1, "stacking shares one tab");
assert_eq!(tabs[0].panes, vec![a, b], "stacking splits into two panes");
assert_eq!(tabs[0].splitter.pane_count(), 2);
}
#[test]
fn new_tab_creates_a_second_tab() {
let m = model();
let a = reg(&m, DockSide::Bottom);
let b = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Bottom));
m.open_dock(b, DockOpenLocation::side(DockSide::Bottom).new_tab());
assert_eq!(m.tab_count(DockSide::Bottom), 2);
}
#[test]
fn single_location_invariant_no_duplicate() {
let m = model();
let id = reg(&m, DockSide::Leading);
m.open_dock(id, DockOpenLocation::side(DockSide::Leading));
m.open_dock(id, DockOpenLocation::side(DockSide::Trailing));
// Only one location; it moved to trailing.
assert_eq!(m.dock_location(id).unwrap().side, DockSide::Trailing);
assert!(
!m.is_side_visible(DockSide::Leading),
"leading emptied → hidden"
);
}
#[test]
fn close_last_dock_hides_side() {
let m = model();
let id = reg(&m, DockSide::Trailing);
m.open_dock(id, DockOpenLocation::side(DockSide::Trailing));
m.close_dock(id);
assert!(!m.is_dock_open(id));
assert!(!m.is_side_visible(DockSide::Trailing));
assert_eq!(m.tab_count(DockSide::Trailing), 0);
}
#[test]
fn close_one_of_two_stacked_panes_leaves_the_other() {
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).stack());
m.close_dock(b);
// The tab collapses back to a single pane holding `a`.
let tabs = m.side_tabs(DockSide::Leading);
assert_eq!(tabs[0].panes, vec![a]);
assert_eq!(tabs[0].splitter.pane_count(), 1);
}
#[test]
fn toggle_dock_round_trips() {
let m = model();
let id = reg(&m, DockSide::Leading);
m.toggle_dock(id);
assert!(m.is_dock_open(id));
m.toggle_dock(id);
assert!(!m.is_dock_open(id));
}
#[test]
fn reveal_closed_dock_opens_on_default_side() {
let m = model();
let id = reg(&m, DockSide::Bottom);
m.reveal_dock(id);
assert!(m.is_dock_open(id));
assert_eq!(m.dock_location(id).unwrap().side, DockSide::Bottom);
}
/// **Revealing an already-revealed dock changes nothing, and says so.**
///
/// The version drives every dock's content rebuild, and a view's own state —
/// a list's scroll position, a tree's — lives in that content. A "show me
/// this" that reveals an already-visible dock is the common case, not the rare
/// one: it is what every result activation after the first one does, and each
/// gratuitous notify sent the panel it came from back to the top.
#[test]
fn revealing_an_already_revealed_dock_does_not_notify() {
let m = model();
let id = reg(&m, DockSide::Bottom);
m.reveal_dock(id);
assert!(m.is_dock_open(id));
let settled = m.version().get();
m.reveal_dock(id);
assert_eq!(
m.version().get(),
settled,
"nothing changed, so nothing downstream should be rebuilt"
);
}
/// It still notifies when it really does reveal something.
#[test]
fn revealing_a_hidden_dock_notifies() {
let m = model();
let id = reg(&m, DockSide::Bottom);
m.reveal_dock(id);
m.set_side_visible(DockSide::Bottom, false);
let settled = m.version().get();
m.reveal_dock(id);
assert_ne!(
m.version().get(),
settled,
"it was hidden, so this is a change"
);
}
#[test]
fn split_into_tab_adds_a_splitter_pane() {
let m = model();
let a = reg(&m, DockSide::Bottom);
let b = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Bottom));
m.split_into_tab(b, DockSide::Bottom, 0, 0, false);
let tabs = m.side_tabs(DockSide::Bottom);
assert_eq!(tabs[0].panes.len(), 2, "split added a second pane");
assert_eq!(tabs[0].splitter.pane_count(), 2);
}
#[test]
fn promote_to_tab_makes_its_own_tab() {
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).stack());
// a + b share one tab; promote b into its own.
m.promote_to_tab(b, DockSide::Leading, 1);
assert_eq!(m.tab_count(DockSide::Leading), 2);
assert_eq!(m.dock_location(b).unwrap().tab_idx, 1);
}
#[test]
fn move_tab_relocates_whole_tab_and_reorients() {
let m = model();
let a = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
let tab_id = m.side_tabs(DockSide::Leading)[0].id;
// Leading uses a vertical splitter; bottom a horizontal one.
let splitter = m.side_tabs(DockSide::Leading)[0].splitter.clone();
assert_eq!(splitter.orientation(), Orientation::Vertical);
m.move_tab(tab_id, DockSide::Bottom, 0);
assert_eq!(m.dock_location(a).unwrap().side, DockSide::Bottom);
assert!(!m.is_side_visible(DockSide::Leading));
assert_eq!(
splitter.orientation(),
Orientation::Horizontal,
"re-derived"
);
}
#[test]
fn closing_a_tab_before_the_active_one_keeps_the_active_tab() {
// [A, B, C] with B (index 1) selected; close A (index 0). B and C
// shift down to fill the gap, so selection must follow B to index 0
// — not stay at index 1 (which now holds C).
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
let c = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).new_tab());
m.open_dock(c, DockOpenLocation::side(DockSide::Leading).new_tab());
let tab_a = m.side_tabs(DockSide::Leading)[0].id;
let tab_b = m.side_tabs(DockSide::Leading)[1].id;
m.select_tab(DockSide::Leading, 1);
assert_eq!(m.side_selected_tab(DockSide::Leading), 1);
m.close_tab(tab_a);
assert_eq!(m.tab_count(DockSide::Leading), 2);
assert_eq!(m.side_selected_tab(DockSide::Leading), 0, "B followed down");
assert_eq!(
m.side_tabs(DockSide::Leading)[0].id,
tab_b,
"the selected tab is still B, not C",
);
}
#[test]
fn moving_a_tab_before_the_active_one_away_keeps_the_active_tab() {
// Same off-by-one, reached through move_tab's cross-side removal: B is
// selected, A (before it) is moved to another side, so selection must
// follow B down to index 0.
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
let c = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).new_tab());
m.open_dock(c, DockOpenLocation::side(DockSide::Leading).new_tab());
let tab_a = m.side_tabs(DockSide::Leading)[0].id;
let tab_b = m.side_tabs(DockSide::Leading)[1].id;
m.select_tab(DockSide::Leading, 1);
m.move_tab(tab_a, DockSide::Trailing, 0);
assert_eq!(m.tab_count(DockSide::Leading), 2);
assert_eq!(m.side_selected_tab(DockSide::Leading), 0, "B followed down");
assert_eq!(m.side_tabs(DockSide::Leading)[0].id, tab_b);
}
#[test]
fn closing_the_last_active_tab_clamps_selection() {
// [A, B] with B (last) selected; close B. Selection clamps to A.
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).new_tab());
let tab_b = m.side_tabs(DockSide::Leading)[1].id;
m.select_tab(DockSide::Leading, 1);
m.close_tab(tab_b);
assert_eq!(m.tab_count(DockSide::Leading), 1);
assert_eq!(m.side_selected_tab(DockSide::Leading), 0);
}
#[test]
fn version_bumps_on_mutation() {
let m = model();
let id = reg(&m, DockSide::Leading);
let v = m.version();
let before = v.get();
m.open_dock(id, DockOpenLocation::side(DockSide::Leading));
assert!(v.get() > before);
}
#[test]
fn dock_open_signal_and_side_visible_signal_track() {
let m = model();
let id = reg(&m, DockSide::Leading);
let open = m.dock_open_signal(id);
let vis = m.side_visible_signal(DockSide::Leading);
assert!(!open.get());
assert!(!vis.get());
m.open_dock(id, DockOpenLocation::side(DockSide::Leading));
assert!(open.get());
assert!(vis.get());
m.close_dock(id);
assert!(!open.get());
assert!(!vis.get());
}
#[test]
fn export_import_round_trips() {
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
m.open_dock(b, DockOpenLocation::side(DockSide::Bottom));
let state = m.export_state();
// Fresh model with the same registry restores the same shape.
let m2 = DockingModel::new();
m2.register_meta(
a,
DockWidgetMeta {
title: lit!("A"),
icon: None,
min_size: None,
default: DockOpenLocation::side(DockSide::Leading),
header_actions: None,
show_header: false,
},
);
m2.register_meta(
b,
DockWidgetMeta {
title: lit!("B"),
icon: None,
min_size: None,
default: DockOpenLocation::side(DockSide::Bottom),
header_actions: None,
show_header: false,
},
);
m2.import_state(&state);
assert!(m2.is_dock_open(a));
assert!(m2.is_dock_open(b));
assert_eq!(m2.dock_location(a).unwrap().side, DockSide::Leading);
}
#[test]
fn import_drops_unknown_dock_ids() {
let m = model();
let a = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
let state = m.export_state();
// Fresh model that does NOT know `a`.
let m2 = DockingModel::new();
m2.import_state(&state);
assert!(!m2.is_dock_open(a), "unknown dock id dropped on import");
assert!(!m2.is_side_visible(DockSide::Leading));
}
// ─── drop edge cases ────────────────────────────────────────────────
#[test]
fn split_a_dock_onto_its_own_pane_is_a_noop() {
// Drop a dock onto the very `Single` pane it solely occupies → nothing
// changes, no version churn (the classic "drop on itself").
let m = model();
let a = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Bottom));
let loc_before = m.dock_location(a).unwrap();
let v = m.version().get();
m.split_into_tab(a, DockSide::Bottom, 0, 0, true);
assert_eq!(m.version().get(), v, "no-op must not bump the version");
assert_eq!(
m.dock_location(a).unwrap(),
loc_before,
"location unchanged"
);
assert_eq!(
m.side_tabs(DockSide::Bottom)[0].panes.len(),
1,
"still one pane"
);
m.split_into_tab(a, DockSide::Bottom, 0, 0, false);
assert_eq!(m.version().get(), v, "after-split self-drop also a no-op");
assert_eq!(m.side_tabs(DockSide::Bottom)[0].panes.len(), 1);
}
#[test]
fn stack_a_dock_onto_its_own_sole_tab_is_a_noop() {
let m = model();
let a = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
let v = m.version().get();
m.stack_into_tab(a, DockSide::Leading, 0);
assert_eq!(m.version().get(), v, "stacking a dock on itself is a no-op");
let tabs = m.side_tabs(DockSide::Leading);
assert_eq!(tabs[0].panes, vec![a], "still a single pane");
}
#[test]
fn stack_into_tab_appends_a_splitter_pane() {
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
m.stack_into_tab(b, DockSide::Leading, 0);
let tabs = m.side_tabs(DockSide::Leading);
assert_eq!(tabs.len(), 1, "stacked into the same tab");
assert_eq!(tabs[0].panes, vec![a, b], "appended as a second pane");
assert_eq!(tabs[0].splitter.pane_count(), 2);
}
#[test]
fn promote_a_dock_already_its_own_sole_tab_is_a_noop() {
let m = model();
let a = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Bottom).new_tab());
let v = m.version().get();
m.promote_to_tab(a, DockSide::Bottom, 0);
assert_eq!(
m.version().get(),
v,
"promoting an already-sole tab is a no-op"
);
assert_eq!(m.tab_count(DockSide::Bottom), 1);
}
#[test]
fn split_targets_the_right_pane_after_an_earlier_pane_is_pruned() {
// Tab = [A(0), B(1), C(2)]; drop A *after* B. Detaching A removes pane 0
// and shifts B/C down, so the naive index would land A after C. The
// adjustment keeps it where the user aimed: [B, A, C].
let m = model();
let a = reg(&m, DockSide::Bottom);
let b = reg(&m, DockSide::Bottom);
let c = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Bottom).new_tab());
m.split_into_tab(b, DockSide::Bottom, 0, 0, false); // [A, B]
m.split_into_tab(c, DockSide::Bottom, 0, 1, false); // [A, B, C]
m.split_into_tab(a, DockSide::Bottom, 0, 1, false); // drop A after B
assert_eq!(
m.side_tabs(DockSide::Bottom)[0].panes.len(),
3,
"still 3 panes"
);
assert_eq!(m.dock_location(b).unwrap().pane_idx, 0, "B leads");
assert_eq!(m.dock_location(a).unwrap().pane_idx, 1, "A lands after B");
assert_eq!(m.dock_location(c).unwrap().pane_idx, 2, "C trails");
}
#[test]
fn stack_into_a_later_tab_after_an_earlier_tab_is_pruned_keeps_the_dock() {
// Side = [tab0 = Single(A)], [tab1 = Single(B)]; stack A into tab1.
// Detaching A removes tab0 (tab1 shifts to index 0); without the index
// fix the stale tab index misses and the dock is lost.
let m = model();
let a = reg(&m, DockSide::Bottom);
let b = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Bottom).new_tab());
m.open_dock(b, DockOpenLocation::side(DockSide::Bottom).new_tab());
assert_eq!(m.tab_count(DockSide::Bottom), 2);
m.stack_into_tab(a, DockSide::Bottom, 1); // drop A into B's tab
assert!(m.is_dock_open(a), "A must not be lost");
assert_eq!(m.tab_count(DockSide::Bottom), 1, "A's old tab was pruned");
assert_eq!(
m.side_tabs(DockSide::Bottom)[0].panes,
vec![b, a],
"A appended to B's tab"
);
}
// ─── context-menu state: hide / select-by-id / rail size / tab display ──
#[test]
fn set_tab_hidden_hides_and_restores_an_activity() {
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading).new_tab());
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).new_tab());
let tabs = m.side_tabs(DockSide::Leading);
let (ta, tb) = (tabs[0].id, tabs[1].id);
assert_eq!(m.side_visible_tab_count(DockSide::Leading), 2);
m.set_tab_hidden(ta, true);
assert!(m.is_tab_hidden(ta));
assert_eq!(
m.side_visible_tab_count(DockSide::Leading),
1,
"hidden activity drops out of the visible count"
);
// The tab still exists in the model (restorable).
assert_eq!(m.tab_count(DockSide::Leading), 2);
// Restore.
m.set_tab_hidden(ta, false);
assert!(!m.is_tab_hidden(ta));
assert_eq!(m.side_visible_tab_count(DockSide::Leading), 2);
let _ = tb;
}
#[test]
fn hiding_the_selected_tab_moves_selection_to_a_visible_one() {
let m = model();
let a = reg(&m, DockSide::Bottom);
let b = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Bottom).new_tab());
m.open_dock(b, DockOpenLocation::side(DockSide::Bottom).new_tab());
let tabs = m.side_tabs(DockSide::Bottom);
let (ta, tb) = (tabs[0].id, tabs[1].id);
m.select_tab_by_id(DockSide::Bottom, tb);
assert_eq!(m.side_selected_tab(DockSide::Bottom), 1);
// Hide the selected tab → selection must move to the other visible one.
m.set_tab_hidden(tb, true);
assert_eq!(
m.side_selected_tab(DockSide::Bottom),
0,
"selection moved off the hidden tab"
);
let _ = ta;
}
#[test]
fn select_tab_by_id_is_position_independent() {
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading).new_tab());
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).new_tab());
let id_b = m.side_tabs(DockSide::Leading)[1].id;
m.select_tab_by_id(DockSide::Leading, id_b);
assert_eq!(m.side_selected_tab(DockSide::Leading), 1);
}
#[test]
fn rail_size_and_tab_display_round_trip_reactively() {
use crate::docking::{DockRailItemSize, DockTabDisplay};
let m = model();
// Defaults.
assert_eq!(
m.side_rail_size(DockSide::Leading),
DockRailItemSize::Default
);
assert_eq!(m.side_tab_display(DockSide::Leading), DockTabDisplay::Text);
// The reactive signals the rail / strip bind to.
let rail_sig = m.rail_size_signal(DockSide::Leading);
let disp_sig = m.tab_display_signal(DockSide::Leading);
m.set_side_rail_size(DockSide::Leading, DockRailItemSize::Compact);
assert_eq!(
m.side_rail_size(DockSide::Leading),
DockRailItemSize::Compact
);
assert_eq!(
rail_sig.get(),
1,
"signal reflects the change (drives rebuild)"
);
assert!(!DockRailItemSize::Compact.shows_label());
// The third "icon + 90° label" rail mode.
m.set_side_rail_size(DockSide::Leading, DockRailItemSize::Labeled);
assert_eq!(
m.side_rail_size(DockSide::Leading),
DockRailItemSize::Labeled
);
assert_eq!(rail_sig.get(), 2, "labeled mode drives a rebuild too");
assert!(DockRailItemSize::Labeled.shows_label());
assert!(!DockRailItemSize::Default.shows_label());
m.set_side_tab_display(DockSide::Leading, DockTabDisplay::IconText);
assert_eq!(
m.side_tab_display(DockSide::Leading),
DockTabDisplay::IconText
);
assert_eq!(disp_sig.get(), 2);
}
#[test]
fn rail_size_mode_signal_tracks_the_mode() {
use crate::docking::DockRailItemSize;
let m = model();
// The public signal external widgets (rail slots, toolbars) bind to.
let sig = m.rail_size_mode_signal(DockSide::Leading);
assert_eq!(sig.get(), DockRailItemSize::Default);
m.set_side_rail_size(DockSide::Leading, DockRailItemSize::Compact);
assert_eq!(sig.get(), DockRailItemSize::Compact, "mode signal fires");
m.set_side_rail_size(DockSide::Leading, DockRailItemSize::Labeled);
assert_eq!(sig.get(), DockRailItemSize::Labeled);
}
#[test]
fn export_import_round_trips_hidden_and_display_prefs() {
use crate::docking::{DockRailItemSize, DockTabDisplay};
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading).new_tab());
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).new_tab());
let tb = m.side_tabs(DockSide::Leading)[1].id;
m.set_tab_hidden(tb, true);
m.set_side_rail_size(DockSide::Leading, DockRailItemSize::Labeled);
m.set_side_tab_display(DockSide::Leading, DockTabDisplay::Icon);
let state = m.export_state();
// Restore into a fresh model with the *same* dock ids registered (import
// matches by id, dropping unknowns).
let m2 = model();
for id in [a, b] {
m2.register_meta(
id,
DockWidgetMeta {
title: lit!("Dock"),
icon: None,
min_size: None,
default: DockOpenLocation::side(DockSide::Leading),
header_actions: None,
show_header: false,
},
);
}
m2.import_state(&state);
assert!(m2.is_tab_hidden(tb), "hidden activity restored");
assert_eq!(
m2.side_rail_size(DockSide::Leading),
DockRailItemSize::Labeled
);
assert_eq!(m2.side_tab_display(DockSide::Leading), DockTabDisplay::Icon);
}
// ─── selection coherence: hiding / importing onto a hidden tab ─────────
#[test]
fn hiding_the_only_visible_tab_resets_selection_to_zero() {
// Bug #1: hiding the last visible activity used to leave `selected_tab`
// pointing at the now-hidden tab, so the strip's `tw_selected` held a
// TabId absent from its (empty) list. Selection must land on a coherent
// value (0) instead.
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading).new_tab());
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).new_tab());
let (ta, tb) = {
let t = m.side_tabs(DockSide::Leading);
(t[0].id, t[1].id)
};
// Hide both — the second hide makes the side have zero visible tabs.
m.set_tab_hidden(ta, true);
m.select_tab_by_id(DockSide::Leading, tb);
assert_eq!(m.side_selected_tab(DockSide::Leading), 1);
m.set_tab_hidden(tb, true);
assert_eq!(m.side_visible_tab_count(DockSide::Leading), 0);
assert_eq!(
m.side_selected_tab(DockSide::Leading),
0,
"selection resets to a coherent index when no tab is visible"
);
}
#[test]
fn import_state_clamps_selection_off_a_hidden_tab() {
// Bug #5: a session persisted with a hidden tab selected used to restore
// with `selected_tab` on the hidden tab. import must re-home it onto a
// visible tab.
let m = model();
let a = reg(&m, DockSide::Bottom);
let b = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Bottom).new_tab());
m.open_dock(b, DockOpenLocation::side(DockSide::Bottom).new_tab());
// Select tab 1 (b), then hide it: selection moves to a (0) and b stays
// hidden. Forge a state that *says* selected = 1 (the hidden tab).
let tb = m.side_tabs(DockSide::Bottom)[1].id;
m.set_tab_hidden(tb, true);
let mut state = m.export_state();
state.bottom.selected_tab = 1; // hidden tab b
let m2 = model();
for id in [a, b] {
m2.register_meta(
id,
DockWidgetMeta {
title: lit!("Dock"),
icon: None,
min_size: None,
default: DockOpenLocation::side(DockSide::Bottom),
header_actions: None,
show_header: false,
},
);
}
m2.import_state(&state);
assert_eq!(
m2.side_selected_tab(DockSide::Bottom),
0,
"selection clamped onto the visible tab, not the hidden one"
);
}
// ─── #6: append after the last *visible* tab (not past hidden ones) ────
#[test]
fn side_append_index_lands_after_last_visible_tab() {
let m = model();
let a = reg(&m, DockSide::Bottom);
let b = reg(&m, DockSide::Bottom);
let c = reg(&m, DockSide::Bottom);
m.open_dock(a, DockOpenLocation::side(DockSide::Bottom).new_tab());
m.open_dock(b, DockOpenLocation::side(DockSide::Bottom).new_tab());
m.open_dock(c, DockOpenLocation::side(DockSide::Bottom).new_tab());
// Hide the trailing two (b, c) → only a visible at model index 0.
let (tb, tc) = {
let t = m.side_tabs(DockSide::Bottom);
(t[1].id, t[2].id)
};
m.set_tab_hidden(tb, true);
m.set_tab_hidden(tc, true);
// Appending must land at index 1 (right after the last visible tab a),
// NOT at 3 (past the trailing hidden b, c).
assert_eq!(m.side_append_index(DockSide::Bottom), 1);
}
#[test]
fn move_tab_appends_before_trailing_hidden_tabs() {
// A whole-tab move that "appends to the side" must land before any
// trailing hidden tabs, so order is preserved when they are restored.
let m = model();
let a = reg(&m, DockSide::Leading);
let b = reg(&m, DockSide::Leading);
let mover = reg(&m, DockSide::Trailing);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading).new_tab());
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).new_tab());
m.open_dock(mover, DockOpenLocation::side(DockSide::Trailing).new_tab());
// Hide b on the leading side (it trails a in the model).
let tb = m.side_tabs(DockSide::Leading)[1].id;
m.set_tab_hidden(tb, true);
// Move `mover` to leading, appending after the last visible tab (a).
let mover_tab = m.side_tabs(DockSide::Trailing)[0].id;
m.move_tab(
mover_tab,
DockSide::Leading,
m.side_append_index(DockSide::Leading),
);
// Restore b and verify order: [a, mover, b] — mover before the hidden b.
m.set_tab_hidden(tb, false);
let order: Vec<_> = m
.side_tabs(DockSide::Leading)
.iter()
.map(|t| t.panes[0])
.collect();
assert_eq!(order, vec![a, mover, b], "moved tab sits before hidden b");
}
// ─── naming + primary-pane label derivation ────────────────────────────
#[test]
fn set_tab_title_overrides_the_derived_label() {
let m = model();
let a = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
let tab = m.side_tabs(DockSide::Leading)[0].id;
assert_eq!(m.activity_of(a), Some(tab));
assert!(m.tab_title(tab).is_none());
m.set_dock_activity_title(a, lit!("Source Control"));
assert_eq!(
m.tab_title(tab).unwrap().resolve_now(),
"Source Control",
"explicit activity title set via the dock id"
);
let view = m.side_tabs(DockSide::Leading)[0].clone();
assert_eq!(m.activity_label(&view).resolve_now(), "Source Control");
}
#[test]
fn activity_label_follows_first_non_collapsed_pane() {
// A grouped activity's label tracks the first *non-collapsed* pane, so
// collapsing the lead pane surfaces the next pane's title.
let m = model();
let a = DockWidgetId::fresh();
let b = DockWidgetId::fresh();
m.register_meta(
a,
DockWidgetMeta {
title: lit!("Alpha"),
icon: None,
min_size: None,
default: DockOpenLocation::side(DockSide::Leading),
header_actions: None,
show_header: false,
},
);
m.register_meta(
b,
DockWidgetMeta {
title: lit!("Beta"),
icon: None,
min_size: None,
default: DockOpenLocation::side(DockSide::Leading),
header_actions: None,
show_header: false,
},
);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
m.open_dock(b, DockOpenLocation::side(DockSide::Leading).stack());
let view = m.side_tabs(DockSide::Leading)[0].clone();
assert_eq!(m.activity_label(&view).resolve_now(), "Alpha");
// Collapse pane 0 → the label follows pane 1 (Beta).
view.splitter.set_collapsed(0, true);
let view = m.side_tabs(DockSide::Leading)[0].clone();
assert_eq!(
m.activity_label(&view).resolve_now(),
"Beta",
"label follows the first non-collapsed pane"
);
}
// ─── side availability ─────────────────────────────────────────────────
#[test]
fn enabled_move_targets_excludes_self_and_disabled() {
let m = model();
assert_eq!(
m.enabled_move_targets(DockSide::Leading),
vec![DockSide::Trailing, DockSide::Top, DockSide::Bottom]
);
m.set_side_enabled(DockSide::Bottom, false);
assert_eq!(
m.enabled_move_targets(DockSide::Leading),
vec![DockSide::Trailing, DockSide::Top],
"a disabled side is never a move target"
);
m.set_side_enabled(DockSide::Top, false);
m.set_side_enabled(DockSide::Trailing, false);
assert!(
m.enabled_move_targets(DockSide::Leading).is_empty(),
"no enabled target → empty (the Move-to entry is then omitted)"
);
}
#[test]
fn tab_hidden_signal_tracks_live_state() {
let m = model();
let a = reg(&m, DockSide::Leading);
m.open_dock(a, DockOpenLocation::side(DockSide::Leading));
let tab = m.side_tabs(DockSide::Leading)[0].id;
let sig = m.tab_hidden_signal(tab);
assert!(!sig.get());
m.set_tab_hidden(tab, true);
assert!(sig.get(), "signal follows an external set_tab_hidden");
m.set_tab_hidden(tab, false);
assert!(!sig.get());
}
}