ztmux 3.7.17

A Rust port of tmux — the full terminal multiplexer, server and client
Documentation
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
// Copyright (c) 2012 Nicholas Marriott <nicholas.marriott@gmail.com>
// Copyright (c) 2012 George Nachman <tmux@georgester.com>
//
// Permission to use, copy, modify, and distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
// IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
// OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
use crate::*;

#[repr(C)]
pub struct control_block {
    pub size: usize,
    pub line: *mut u8,
    pub t: u64,

    pub entry: tailq_entry<control_block>,
    pub all_entry: tailq_entry<control_block>,
}

impl crate::compat::queue::Entry<control_block, discr_entry> for control_block {
    unsafe fn entry(this: *mut Self) -> *mut tailq_entry<control_block> {
        unsafe { &raw mut (*this).entry }
    }
}

impl crate::compat::queue::Entry<control_block, discr_all_entry> for control_block {
    unsafe fn entry(this: *mut Self) -> *mut tailq_entry<control_block> {
        unsafe { &raw mut (*this).all_entry }
    }
}

pub const CONTROL_PANE_OFF: i32 = 1;
pub const CONTROL_PANE_PAUSED: i32 = 2;

#[repr(C)]
pub struct control_pane {
    pub pane: u32,

    pub offset: window_pane_offset,
    pub queued: window_pane_offset,

    pub flags: i32,

    pub pending_flag: i32,
    pub pending_entry: tailq_entry<control_pane>,

    pub blocks: tailq_head<control_block>,

    pub entry: rb_entry<control_pane>,
}
pub type control_panes = rb_head<control_pane>;

impl Entry<control_pane, discr_pending_entry> for control_pane {
    unsafe fn entry(this: *mut Self) -> *mut tailq_entry<control_pane> {
        unsafe { &raw mut (*this).pending_entry }
    }
}

#[repr(C)]
pub struct control_sub_pane {
    pane: u32,
    idx: u32,
    last: *mut u8,

    entry: rb_entry<control_sub_pane>,
}
pub type control_sub_panes = rb_head<control_sub_pane>;

#[repr(C)]
pub struct control_sub_window {
    window: u32,
    idx: u32,
    last: *mut u8,

    entry: rb_entry<control_sub_window>,
}
pub type control_sub_windows = rb_head<control_sub_window>;

#[repr(C)]
pub struct control_sub {
    pub name: *mut u8,
    pub format: *mut u8,
    pub type_: control_sub_type,
    pub id: u32,

    pub last: *mut u8,

    pub panes: control_sub_panes,
    pub windows: control_sub_windows,

    pub entry: rb_entry<control_sub>,
}
pub type control_subs = rb_head<control_sub>;

#[repr(C)]
pub struct control_state {
    pub panes: control_panes,

    pub pending_list: tailq_head<control_pane>,

    pub pending_count: u32,

    pub all_blocks: tailq_head<control_block>,

    pub read_event: *mut bufferevent,
    pub write_event: *mut bufferevent,

    pub subs: control_subs,
    pub subs_timer: event,
}

/// Low and high watermarks.
pub const CONTROL_BUFFER_LOW: i32 = 512;
pub const CONTROL_BUFFER_HIGH: i32 = 8192;

/// Minimum to write to each client.
pub const CONTROL_WRITE_MINIMUM: i32 = 32;

/// Maximum age for clients that are not using pause mode.
pub const CONTROL_MAXIMUM_AGE: u64 = 300000;

pub const CONTROL_IGNORE_FLAGS: client_flag =
    client_flag::CONTROL_NOOUTPUT.union(CLIENT_UNATTACHEDFLAGS);

/// C `vendor/tmux/control.c:147`: `static int control_pane_cmp(struct control_pane *cp1, struct control_pane *cp2)`
pub fn control_pane_cmp(cp1: &control_pane, cp2: &control_pane) -> cmp::Ordering {
    cp1.pane.cmp(&cp2.pane)
}
RB_GENERATE!(
    control_panes,
    control_pane,
    entry,
    discr_entry,
    control_pane_cmp
);

/// C `vendor/tmux/control.c:159`: `static int control_sub_cmp(struct control_sub *csub1, struct control_sub *csub2)`
pub fn control_sub_cmp(csub1: &control_sub, csub2: &control_sub) -> cmp::Ordering {
    unsafe { i32_to_ordering(libc::strcmp(csub1.name, csub2.name)) }
}
RB_GENERATE!(
    control_subs,
    control_sub,
    entry,
    discr_entry,
    control_sub_cmp
);

/// C `vendor/tmux/control.c:167`: `static int control_sub_pane_cmp(struct control_sub_pane *csp1, struct control_sub_pane *csp2)`
pub fn control_sub_pane_cmp(csp1: &control_sub_pane, csp2: &control_sub_pane) -> cmp::Ordering {
    csp1.pane
        .cmp(&csp2.pane)
        .then_with(|| csp1.idx.cmp(&csp2.idx))
}
RB_GENERATE!(
    control_sub_panes,
    control_sub_pane,
    entry,
    discr_entry,
    control_sub_pane_cmp
);

/// C `vendor/tmux/control.c:185`: `static int control_sub_window_cmp(struct control_sub_window *csw1, struct control_sub_window *csw2)`
pub fn control_sub_window_cmp(
    csw1: &control_sub_window,
    csw2: &control_sub_window,
) -> cmp::Ordering {
    csw1.window
        .cmp(&csw2.window)
        .then_with(|| csw1.idx.cmp(&csw2.idx))
}
RB_GENERATE!(
    control_sub_windows,
    control_sub_window,
    entry,
    discr_entry,
    control_sub_window_cmp
);

/// C `vendor/tmux/control.c:203`: `static void control_free_sub(struct control_state *cs, struct control_sub *csub)`
pub unsafe fn control_free_sub(cs: *mut control_state, csub: *mut control_sub) {
    unsafe {
        for csp in rb_foreach(&raw mut (*csub).panes).map(NonNull::as_ptr) {
            rb_remove(&raw mut (*csub).panes, csp);
            free_(csp);
        }
        for csw in rb_foreach(&raw mut (*csub).windows).map(NonNull::as_ptr) {
            rb_remove(&raw mut (*csub).windows, csw);
            free_(csw);
        }
        free_((*csub).last);

        rb_remove(&raw mut (*cs).subs, csub);
        free_((*csub).name);
        free_((*csub).format);
        free_(csub);
    }
}

/// C `vendor/tmux/control.c:228`: `static void control_free_block(struct control_state *cs, struct control_block *cb)`
pub unsafe fn control_free_block(cs: *mut control_state, cb: *mut control_block) {
    unsafe {
        free_((*cb).line);
        tailq_remove::<_, discr_all_entry>(&raw mut (*cs).all_blocks, cb);
        free_(cb);
    }
}

/// C `vendor/tmux/control.c:237`: `static struct control_pane *control_get_pane(struct client *c, struct window_pane *wp)`
pub unsafe fn control_get_pane(c: *mut client, wp: *mut window_pane) -> *mut control_pane {
    unsafe {
        let cs = (*c).control_state;
        let mut cp = MaybeUninit::<control_pane>::uninit();
        (*cp.as_mut_ptr()).pane = (*wp).id;
        rb_find(&raw mut (*cs).panes, cp.as_mut_ptr())
    }
}

/// C `vendor/tmux/control.c:247`: `static struct control_pane *control_add_pane(struct client *c, struct window_pane *wp)`
pub unsafe fn control_add_pane(c: *mut client, wp: *mut window_pane) -> NonNull<control_pane> {
    unsafe {
        let cs = (*c).control_state;

        if let Some(cp) = NonNull::new(control_get_pane(c, wp)) {
            return cp;
        }

        let cp = xcalloc_::<control_pane>(1);
        (*cp.as_ptr()).pane = (*wp).id;
        rb_insert(&raw mut (*cs).panes, cp.as_ptr());

        (*cp.as_ptr()).offset = (*wp).offset;
        (*cp.as_ptr()).queued = (*wp).offset;
        tailq_init(&raw mut (*cp.as_ptr()).blocks);

        cp
    }
}

/// C `vendor/tmux/control.c:269`: `static void control_discard_pane(struct client *c, struct control_pane *cp)`
pub unsafe fn control_discard_pane(c: *mut client, cp: *mut control_pane) {
    unsafe {
        let cs = (*c).control_state;

        for cb in tailq_foreach::<_, discr_entry>(&raw mut (*cp).blocks).map(NonNull::as_ptr) {
            tailq_remove::<_, discr_entry>(&raw mut (*cp).blocks, cb);
            control_free_block(cs, cb);
        }
    }
}

/// C `vendor/tmux/control.c:282`: `static struct window_pane *control_window_pane(struct client *c, u_int pane)`
pub unsafe fn control_window_pane(c: *mut client, pane: u32) -> Option<NonNull<window_pane>> {
    unsafe {
        if (*c).session.is_null() {
            return None;
        }
        let wp = NonNull::new(window_pane_find_by_id(pane))?;

        winlink_find_by_window(&raw mut (*(*c).session).windows, (*wp.as_ptr()).window)?;

        Some(wp)
    }
}

/// C `vendor/tmux/control.c:297`: `void control_reset_offsets(struct client *c)`
pub unsafe fn control_reset_offsets(c: *mut client) {
    unsafe {
        let cs = (*c).control_state;

        for cp in rb_foreach(&raw mut (*cs).panes).map(NonNull::as_ptr) {
            rb_remove(&raw mut (*cs).panes, cp);
            free_(cp);
        }

        tailq_init(&raw mut (*cs).pending_list);
        (*cs).pending_count = 0;
    }
}

/// C `vendor/tmux/control.c:314`: `struct window_pane_offset *control_pane_offset(struct client *c, struct window_pane *wp, int *off)`
pub unsafe fn control_pane_offset(
    c: *mut client,
    wp: *mut window_pane,
    off: *mut i32,
) -> *mut window_pane_offset {
    unsafe {
        let cs = (*c).control_state;

        if (*c).flags.intersects(client_flag::CONTROL_NOOUTPUT) {
            *off = 0;
            return null_mut();
        }

        let cp = control_get_pane(c, wp);
        if cp.is_null() || ((*cp).flags & CONTROL_PANE_PAUSED != 0) {
            *off = 0;
            return null_mut();
        }
        if (*cp).flags & CONTROL_PANE_OFF != 0 {
            *off = 1;
            return null_mut();
        }
        *off = (EVBUFFER_LENGTH((*(*cs).write_event).output) >= CONTROL_BUFFER_LOW as usize) as i32;
        &raw mut (*cp).offset
    }
}

/// C `vendor/tmux/control.c:339`: `void control_set_pane_on(struct client *c, struct window_pane *wp)`
pub unsafe fn control_set_pane_on(c: *mut client, wp: *mut window_pane) {
    unsafe {
        let cp = control_get_pane(c, wp);
        if !cp.is_null() && (*cp).flags & CONTROL_PANE_OFF != 0 {
            (*cp).flags &= !CONTROL_PANE_OFF;
            memcpy__(&raw mut (*cp).offset, &raw mut (*wp).offset);
            memcpy__(&raw mut (*cp).queued, &raw mut (*wp).offset);
        }
    }
}

/// C `vendor/tmux/control.c:353`: `void control_set_pane_off(struct client *c, struct window_pane *wp)`
pub unsafe fn control_set_pane_off(c: *mut client, wp: *mut window_pane) {
    unsafe {
        let cp = control_add_pane(c, wp);
        (*cp.as_ptr()).flags |= CONTROL_PANE_OFF;
    }
}

/// C `vendor/tmux/control.c:366`: `void control_continue_pane(struct client *c, struct window_pane *wp)`
pub unsafe fn control_continue_pane(c: *mut client, wp: *mut window_pane) {
    unsafe {
        let cp = control_get_pane(c, wp);
        if !cp.is_null() && ((*cp).flags & CONTROL_PANE_PAUSED) != 0 {
            (*cp).flags &= !CONTROL_PANE_PAUSED;
            memcpy__(&raw mut (*cp).offset, &raw const (*wp).offset);
            memcpy__(&raw mut (*cp).queued, &raw const (*wp).offset);
            control_write!(c, "%continue %{}", (*wp).id);
        }
    }
}

/// C `vendor/tmux/control.c:381`: `void control_pause_pane(struct client *c, struct window_pane *wp)`
pub unsafe fn control_pause_pane(c: *mut client, wp: *mut window_pane) {
    unsafe {
        let cp = control_add_pane(c, wp).as_ptr();
        if !(*cp).flags & CONTROL_PANE_PAUSED != 0 {
            (*cp).flags |= CONTROL_PANE_PAUSED;
            control_discard_pane(c, cp);
            control_write!(c, "%pause %{}", (*wp).id);
        }
    }
}

/// C `vendor/tmux/control.c:395`: `control_vwrite(struct client *c, const char *fmt, va_list ap)`
pub unsafe fn control_vwrite(c: *mut client, args: std::fmt::Arguments) {
    unsafe {
        let cs = (*c).control_state;

        let mut s = args.to_string();
        s.push('\0');
        let s: *mut u8 = s.as_mut_ptr().cast();

        log_debug!(
            "{}: {}: writing line: {}",
            "control_vwrite",
            _s((*c).name),
            _s(s)
        );

        bufferevent_write((*cs).write_event, s.cast(), strlen(s));
        bufferevent_write((*cs).write_event, c!("\n").cast(), 1);

        bufferevent_enable((*cs).write_event, EV_WRITE);
        free_(s);
    }
}

macro_rules! control_write {
   ($c:expr, $fmt:literal $(, $args:expr)* $(,)?) => {
        crate::control::control_write_($c, format_args!($fmt $(, $args)*))
    };
}
pub(crate) use control_write;

pub unsafe fn control_write_(c: *mut client, args: std::fmt::Arguments) {
    unsafe {
        let cs = (*c).control_state;

        if tailq_empty(&raw mut (*cs).all_blocks) {
            control_vwrite(c, args);
            return;
        }

        let cb = xcalloc_::<control_block>(1).as_ptr();
        let mut value = args.to_string();
        value.push('\0');
        (*cb).line = value.leak().as_mut_ptr().cast();
        tailq_insert_tail::<_, discr_all_entry>(&raw mut (*cs).all_blocks, cb);
        (*cb).t = get_timer();

        log_debug!(
            "{}: {}: storing line: {}",
            "control_write",
            _s((*c).name),
            _s((*cb).line)
        );
        bufferevent_enable((*cs).write_event, EV_WRITE);
    }
}

/// C `vendor/tmux/control.c:439`: `static int control_check_age(struct client *c, struct window_pane *wp, struct control_pane *cp)`
pub unsafe fn control_check_age(
    c: *mut client,
    wp: *mut window_pane,
    cp: *mut control_pane,
) -> i32 {
    let __func__ = "control_check_age";
    unsafe {
        let cb = tailq_first(&raw mut (*cp).blocks);
        if cb.is_null() {
            return 0;
        }
        let t = get_timer();
        if (*cb).t >= t {
            return 0;
        }

        let age = t - (*cb).t;
        log_debug!(
            "{}: {}: %%{} is {} behind",
            __func__,
            _s((*c).name),
            (*wp).id,
            age as c_ulonglong,
        );

        if (*c).flags.intersects(client_flag::CONTROL_PAUSEAFTER) {
            if age < (*c).pause_age as u64 {
                return 0;
            }
            (*cp).flags |= CONTROL_PANE_PAUSED;
            control_discard_pane(c, cp);
            control_write!(c, "%pause %{}", (*wp).id);
        } else {
            if age < CONTROL_MAXIMUM_AGE {
                return 0;
            }
            (*c).exit_message = Some(c"too far behind".to_owned());
            (*c).flags |= client_flag::EXIT;
            control_discard(c);
        }
    }

    1
}

/// C `vendor/tmux/control.c:474`: `void control_write_output(struct client *c, struct window_pane *wp)`
pub unsafe fn control_write_output(c: *mut client, wp: *mut window_pane) {
    let __func__ = "control_write_output";
    unsafe {
        let cs = (*c).control_state;
        let cp: *mut control_pane;
        let mut new_size = 0usize;

        'ignore: {
            if winlink_find_by_window(&raw mut (*(*c).session).windows, (*wp).window).is_none() {
                return;
            }

            if (*c).flags.intersects(CONTROL_IGNORE_FLAGS) {
                cp = control_get_pane(c, wp);
                if !cp.is_null() {
                    break 'ignore;
                }
                return;
            }
            cp = control_add_pane(c, wp).as_ptr();
            if (*cp).flags & (CONTROL_PANE_OFF | CONTROL_PANE_PAUSED) != 0 {
                break 'ignore;
            }
            if control_check_age(c, wp, cp) != 0 {
                return;
            }

            window_pane_get_new_data(wp, &raw mut (*cp).queued, &raw mut new_size);
            if new_size == 0 {
                return;
            }
            window_pane_update_used_data(wp, &raw mut (*cp).queued, new_size);

            let cb = xcalloc_::<control_block>(1).as_ptr();
            (*cb).size = new_size;
            tailq_insert_tail::<_, discr_all_entry>(&raw mut (*cs).all_blocks, cb);
            (*cb).t = get_timer();

            tailq_insert_tail::<_, discr_entry>(&raw mut (*cp).blocks, cb);
            log_debug!(
                "{}: {}: new output block of {} for %%{}",
                __func__,
                _s((*c).name),
                (*cb).size,
                (*wp).id,
            );

            if (*cp).pending_flag == 0 {
                log_debug!(
                    "{}: {}: %%{} now pending",
                    __func__,
                    _s((*c).name),
                    (*wp).id
                );
                tailq_insert_tail::<_, discr_pending_entry>(&raw mut (*cs).pending_list, cp);
                (*cp).pending_flag = 1;
                (*cs).pending_count += 1;
            }
            bufferevent_enable((*cs).write_event, EV_WRITE);
            return;
        }
        // ignore:
        log_debug!(
            "{}: {}: ignoring pane %%{}",
            __func__,
            _s((*c).name),
            (*wp).id
        );
        window_pane_update_used_data(wp, &raw mut (*cp).offset, usize::MAX);
        window_pane_update_used_data(wp, &raw mut (*cp).queued, usize::MAX);
    }
}

/// C `vendor/tmux/control.c:528`: `static enum cmd_retval control_error(struct cmdq_item *item, void *data)`
pub unsafe fn control_error(item: *mut cmdq_item, data: *mut c_void) -> cmd_retval {
    unsafe {
        let c = cmdq_get_client(item);
        let error = data as *mut u8;

        cmdq_guard(item, c!("begin"), true);
        control_write!(c, "parse error: {}", _s(error));
        cmdq_guard(item, c!("error"), true);

        free_(error);
    }
    cmd_retval::CMD_RETURN_NORMAL
}

/// C `vendor/tmux/control.c:543`: `static void control_error_callback(__unused struct bufferevent *bufev, __unused short what, void *data)`
pub unsafe extern "C-unwind" fn control_error_callback(
    _bufev: *mut bufferevent,
    _what: i16,
    data: *mut c_void,
) {
    let c: *mut client = data.cast();

    unsafe {
        (*c).flags |= client_flag::EXIT;
    }
}

/// C `vendor/tmux/control.c:553`: `static void control_read_callback(__unused struct bufferevent *bufev, void *data)`
pub unsafe extern "C-unwind" fn control_read_callback(_bufev: *mut bufferevent, data: *mut c_void) {
    let __func__ = "control_read_callback";
    let c: *mut client = data.cast();

    unsafe {
        let cs = (*c).control_state;
        let buffer = (*(*cs).read_event).input;
        let mut error = null_mut();

        loop {
            let line = evbuffer_readln(buffer, null_mut(), evbuffer_eol_style::EVBUFFER_EOL_LF);
            if line.is_null() {
                break;
            }
            log_debug!("{}: {}: {}", __func__, _s((*c).name), _s(line));
            if *line == b'\0' {
                free_(line);
                (*c).flags |= client_flag::EXIT;
                break;
            }

            let state =
                cmdq_new_state(null_mut(), null_mut(), cmdq_state_flags::CMDQ_STATE_CONTROL);
            let status = cmd_parse_and_append(cstr_to_str(line), None, c, state, &raw mut error);
            if status == cmd_parse_status::CMD_PARSE_ERROR {
                cmdq_append(c, cmdq_get_callback!(control_error, error).as_ptr());
            }
            cmdq_free_state(state);

            free_(line);
        }
    }
}

/// C `vendor/tmux/control.c:585`: `int control_all_done(struct client *c)`
pub unsafe fn control_all_done(c: *mut client) -> i32 {
    unsafe {
        let cs = (*c).control_state;

        if !tailq_empty(&raw mut (*cs).all_blocks) {
            return 0;
        }
        (EVBUFFER_LENGTH((*(*cs).write_event).output) == 0) as i32
    }
}

/// C `vendor/tmux/control.c:596`: `static void control_flush_all_blocks(struct client *c)`
pub unsafe fn control_flush_all_blocks(c: *mut client) {
    let __func__ = "control_flush_all_blocks";
    unsafe {
        let cs = (*c).control_state;

        for cb in
            tailq_foreach::<_, discr_all_entry>(&raw mut (*cs).all_blocks).map(NonNull::as_ptr)
        {
            if (*cb).size != 0 {
                break;
            }
            log_debug!(
                "{}: {}: flushing line: {}",
                __func__,
                _s((*c).name),
                _s((*cb).line)
            );

            bufferevent_write((*cs).write_event, (*cb).line.cast(), strlen((*cb).line));
            bufferevent_write((*cs).write_event, c!("\n").cast(), 1);
            control_free_block(cs, cb);
        }
    }
}

/// C `vendor/tmux/control.c:615`: `static struct evbuffer *control_append_data(struct client *c, struct control_pane *cp, uint64_t age, struct evbuffer *message, struct window_pane *wp, size_t size)`
pub unsafe fn control_append_data(
    c: *mut client,
    cp: *mut control_pane,
    age: u64,
    mut message: *mut evbuffer,
    wp: *mut window_pane,
    size: usize,
) -> *mut evbuffer {
    unsafe {
        if message.is_null() {
            message = evbuffer_new();
            if message.is_null() {
                fatalx("out of memory");
            }
            if (*c).flags.intersects(client_flag::CONTROL_PAUSEAFTER) {
                evbuffer_add_printf!(message, "%extended-output %{} {} : ", (*wp).id, age);
            } else {
                evbuffer_add_printf!(message, "%output %{} ", (*wp).id);
            }
        }

        let mut new_size = 0usize;
        let new_data: *mut c_uchar =
            window_pane_get_new_data(wp, &raw mut (*cp).offset, &raw mut new_size).cast();
        if new_size < size {
            fatalx_!("not enough data: {} < {}", new_size, size);
        }
        for i in 0..size {
            if *new_data.add(i) < b' ' || *new_data.add(i) == b'\\' {
                evbuffer_add_printf!(message, "\\{:03o}", *new_data.add(i) as i32);
            } else {
                evbuffer_add_printf!(message, "{}", *new_data.add(i) as char);
            }
        }
        window_pane_update_used_data(wp, &raw mut (*cp).offset, size);
        message
    }
}

/// C `vendor/tmux/control.c:655`: `static void control_write_data(struct client *c, struct evbuffer *message)`
pub unsafe fn control_write_data(c: *mut client, message: *mut evbuffer) {
    unsafe {
        let cs = (*c).control_state;

        log_debug!(
            "control_write_data: {0}: {2:1$}",
            _s((*c).name),
            EVBUFFER_LENGTH(message),
            _s(EVBUFFER_DATA(message).cast::<u8>()),
        );

        evbuffer_add(message, c!("\n").cast(), 1);
        bufferevent_write_buffer((*cs).write_event, message);
        evbuffer_free(message);
    }
}

/// C `vendor/tmux/control.c:669`: `static int control_write_pending(struct client *c, struct control_pane *cp, size_t limit)`
pub unsafe fn control_write_pending(c: *mut client, cp: *mut control_pane, limit: usize) -> i32 {
    unsafe {
        let cs = (*c).control_state;
        let mut message: *mut evbuffer = null_mut();
        let mut used = 0;
        let mut size;
        let mut cb;
        let t = get_timer();

        let wp = control_window_pane(c, (*cp).pane);
        if wp.is_none() || (*wp.unwrap().as_ptr()).fd == -1 {
            for cb_ in tailq_foreach::<_, discr_entry>(&raw mut (*cp).blocks).map(NonNull::as_ptr) {
                cb = cb_;
                tailq_remove::<_, discr_entry>(&raw mut (*cp).blocks, cb);
                control_free_block(cs, cb);
            }
            control_flush_all_blocks(c);
            return 0;
        }

        while used != limit && !tailq_empty(&raw mut (*cp).blocks) {
            if control_check_age(c, transmute_ptr(wp), cp) != 0 {
                if !message.is_null() {
                    evbuffer_free(message);
                }
                message = null_mut();
                break;
            }

            cb = tailq_first(&raw mut (*cp).blocks);
            let age = t.saturating_sub((*cb).t);
            log_debug!(
                "{}: {}: output block {} (age {}) for %%{} (used {}/{})",
                "control_write_pending",
                _s((*c).name),
                (*cb).size,
                age,
                (*cp).pane,
                used,
                limit,
            );

            size = (*cb).size;
            if size > limit - used {
                size = limit - used;
            }
            used += size;

            message = control_append_data(c, cp, age, message, transmute_ptr(wp), size);

            (*cb).size -= size;
            if (*cb).size == 0 {
                tailq_remove::<_, discr_entry>(&raw mut (*cp).blocks, cb);
                control_free_block(cs, cb);

                cb = tailq_first(&raw mut (*cs).all_blocks);
                if !cb.is_null() && (*cb).size == 0 {
                    if wp.is_some() && !message.is_null() {
                        control_write_data(c, message);
                        message = null_mut();
                    }
                    control_flush_all_blocks(c);
                }
            }
        }
        if !message.is_null() {
            control_write_data(c, message);
        }
        !tailq_empty(&raw mut (*cp).blocks) as i32
    }
}

/// C `vendor/tmux/control.c:734`: `static void control_write_callback(__unused struct bufferevent *bufev, void *data)`
pub unsafe extern "C-unwind" fn control_write_callback(
    _bufev: *mut bufferevent,
    data: *mut c_void,
) {
    unsafe {
        let c: *mut client = data.cast();
        let cs = (*c).control_state;
        let evb = (*(*cs).write_event).output;

        control_flush_all_blocks(c);

        while EVBUFFER_LENGTH(evb) < CONTROL_BUFFER_HIGH as usize {
            if (*cs).pending_count == 0 {
                break;
            }
            let space = CONTROL_BUFFER_HIGH as usize - EVBUFFER_LENGTH(evb);
            log_debug!(
                "{}: {}: {} bytes available, {} panes",
                "control_write_callback",
                _s((*c).name),
                space,
                (*cs).pending_count,
            );

            let mut limit: usize = space / (*cs).pending_count as usize / 3;
            if limit < CONTROL_WRITE_MINIMUM as usize {
                limit = CONTROL_WRITE_MINIMUM as usize;
            }

            for cp in tailq_foreach::<_, discr_pending_entry>(&raw mut (*cs).pending_list)
                .map(NonNull::as_ptr)
            {
                if EVBUFFER_LENGTH(evb) >= CONTROL_BUFFER_HIGH as usize {
                    break;
                }
                if control_write_pending(c, cp, limit) != 0 {
                    continue;
                }
                tailq_remove::<_, discr_pending_entry>(&raw mut (*cs).pending_list, cp);
                (*cp).pending_flag = 0;
                (*cs).pending_count -= 1;
            }
        }
        if EVBUFFER_LENGTH(evb) == 0 {
            bufferevent_disable((*cs).write_event, EV_WRITE);
        }
    }
}

/// C `vendor/tmux/control.c:771`: `void control_start(struct client *c)`
pub unsafe fn control_start(c: *mut client) {
    unsafe {
        if (*c).flags.intersects(client_flag::CONTROLCONTROL) {
            libc::close((*c).out_fd);
            (*c).out_fd = -1;
        } else {
            setblocking((*c).out_fd, 0);
        }
        setblocking((*c).fd, 0);

        (*c).control_state = xcalloc_::<control_state>(1).as_ptr();
        let cs = (*c).control_state;
        rb_init(&raw mut (*cs).panes);
        tailq_init(&raw mut (*cs).pending_list);
        tailq_init(&raw mut (*cs).all_blocks);
        rb_init(&raw mut (*cs).subs);

        (*cs).read_event = bufferevent_new(
            (*c).fd,
            Some(control_read_callback),
            Some(control_write_callback),
            Some(control_error_callback),
            c.cast(),
        );
        if (*cs).read_event.is_null() {
            fatalx("out of memory");
        }

        if (*c).flags.intersects(client_flag::CONTROLCONTROL) {
            (*cs).write_event = (*cs).read_event;
        } else {
            (*cs).write_event = bufferevent_new(
                (*c).out_fd,
                None,
                Some(control_write_callback),
                Some(control_error_callback),
                c.cast(),
            );
            if (*cs).write_event.is_null() {
                fatalx("out of memory");
            }
        }
        bufferevent_setwatermark((*cs).write_event, EV_WRITE, CONTROL_BUFFER_LOW as usize, 0);

        if (*c).flags.intersects(client_flag::CONTROLCONTROL) {
            bufferevent_write((*cs).write_event, c!("\x1bP1000p").cast(), 7);
            bufferevent_enable((*cs).write_event, EV_WRITE);
        }
    }
}

/// C `vendor/tmux/control.c:812`: `void control_ready(struct client *c)`
pub unsafe fn control_ready(c: *mut client) {
    unsafe {
        bufferevent_enable((*(*c).control_state).read_event, EV_READ);
    }
}

/// C `vendor/tmux/control.c:819`: `void control_discard(struct client *c)`
pub unsafe fn control_discard(c: *mut client) {
    unsafe {
        let cs = (*c).control_state;
        for cp in rb_foreach(&raw mut (*cs).panes) {
            control_discard_pane(c, cp.as_ptr());
        }
        bufferevent_disable((*cs).read_event, EV_READ);
    }
}

/// C `vendor/tmux/control.c:831`: `void control_stop(struct client *c)`
pub unsafe fn control_stop(c: *mut client) {
    unsafe {
        let cs = (*c).control_state;
        if !(*c).flags.intersects(client_flag::CONTROLCONTROL) {
            bufferevent_free((*cs).write_event);
        }
        bufferevent_free((*cs).read_event);

        for csub in rb_foreach(&raw mut (*cs).subs).map(NonNull::as_ptr) {
            control_free_sub(cs, csub);
        }
        if evtimer_initialized(&raw mut (*cs).subs_timer) {
            evtimer_del(&raw mut (*cs).subs_timer);
        }

        for cb in
            tailq_foreach::<_, discr_all_entry>(&raw mut (*cs).all_blocks).map(NonNull::as_ptr)
        {
            control_free_block(cs, cb);
        }
        control_reset_offsets(c);

        free_(cs);
    }
}

/// C `vendor/tmux/control.c:859`: `static void control_check_subs_session(struct client *c, struct control_sub *csub, struct format_tree *ft)`
pub unsafe fn control_check_subs_session(c: *mut client, csub: *mut control_sub) {
    unsafe {
        let s = (*c).session;

        let ft = format_create_defaults(null_mut(), c, s, null_mut(), null_mut());
        let value = format_expand(ft, (*csub).format);
        format_free(ft);

        if !(*csub).last.is_null() && libc::strcmp(value, (*csub).last) == 0 {
            free_(value);
            return;
        }
        control_write!(
            c,
            "%subscription-changed {} ${} - - - : {}",
            _s((*csub).name),
            (*s).id,
            _s(value),
        );
        free_((*csub).last);
        (*csub).last = value;
    }
}

/// C `vendor/tmux/control.c:880`: `static void control_check_subs_pane(struct client *c, struct control_sub *csub)`
pub unsafe fn control_check_subs_pane(c: *mut client, csub: *mut control_sub) {
    unsafe {
        let s = (*c).session;
        let mut find: control_sub_pane = zeroed(); //TODO uninit

        let wp = window_pane_find_by_id((*csub).id);
        if wp.is_null() || (*wp).fd == -1 {
            return;
        }
        let w = (*wp).window;

        for wl in tailq_foreach::<_, discr_wentry>(&raw mut (*w).winlinks).map(NonNull::as_ptr) {
            if (*wl).session != s {
                continue;
            }

            let ft = format_create_defaults(null_mut(), c, s, wl, wp);
            let value = format_expand(ft, (*csub).format);
            format_free(ft);

            find.pane = (*wp).id;
            find.idx = (*wl).idx as u32;

            let mut csp = rb_find(&raw mut (*csub).panes, &raw mut find);
            if csp.is_null() {
                csp = xcalloc_::<control_sub_pane>(1).as_ptr();
                (*csp).pane = (*wp).id;
                (*csp).idx = (*wl).idx as u32;
                rb_insert(&raw mut (*csub).panes, csp);
            }

            if !(*csp).last.is_null() && libc::strcmp(value, (*csp).last) == 0 {
                free_(value);
                continue;
            }
            control_write!(
                c,
                "%subscription-changed {} ${} @{} {} %{} : {}",
                _s((*csub).name),
                (*s).id,
                (*w).id,
                (*wl).idx,
                (*wp).id,
                _s(value),
            );
            free_((*csp).last);
            (*csp).last = value;
        }
    }
}

pub unsafe fn control_check_subs_all_panes(c: *mut client, csub: *mut control_sub) {
    unsafe {
        let s = (*c).session;
        let mut find: control_sub_pane = zeroed();

        for wl in rb_foreach(&raw mut (*s).windows).map(NonNull::as_ptr) {
            let w = (*wl).window;
            for wp in tailq_foreach::<_, discr_entry>(&raw mut (*w).panes).map(NonNull::as_ptr) {
                let ft = format_create_defaults(null_mut(), c, s, wl, wp);
                let value = format_expand(ft, (*csub).format);
                format_free(ft);

                find.pane = (*wp).id;
                find.idx = (*wl).idx as u32;

                let mut csp = rb_find(&raw mut (*csub).panes, &raw mut find);
                if csp.is_null() {
                    csp = xcalloc_::<control_sub_pane>(1).as_ptr();
                    (*csp).pane = (*wp).id;
                    (*csp).idx = (*wl).idx as u32;
                    rb_insert(&raw mut (*csub).panes, csp);
                }

                if !(*csp).last.is_null() && libc::strcmp(value, (*csp).last) == 0 {
                    free_(value);
                    continue;
                }
                control_write!(
                    c,
                    "%subscription-changed {} ${} @{} {} %{} : {}",
                    _s((*csub).name),
                    (*s).id,
                    (*w).id,
                    (*wl).idx,
                    (*wp).id,
                    _s(value),
                );
                free_((*csp).last);
                (*csp).last = value;
            }
        }
    }
}

/// C `vendor/tmux/control.c:962`: `static void control_check_subs_window(struct client *c, struct control_sub *csub)`
pub unsafe fn control_check_subs_window(c: *mut client, csub: *mut control_sub) {
    unsafe {
        let s = (*c).session;
        let mut find: control_sub_window = zeroed(); // TODO uninit

        let w = window_find_by_id((*csub).id);
        if w.is_null() {
            return;
        }

        for wl in
            tailq_foreach::<winlink, discr_wentry>(&raw mut (*w).winlinks).map(NonNull::as_ptr)
        {
            if (*wl).session != s {
                continue;
            }

            let ft = format_create_defaults(null_mut(), c, s, wl, null_mut());
            let value = format_expand(ft, (*csub).format);
            format_free(ft);

            find.window = (*w).id;
            find.idx = (*wl).idx as u32;

            let mut csw = rb_find(&raw mut (*csub).windows, &raw mut find);
            if csw.is_null() {
                csw = xcalloc_::<control_sub_window>(1).as_ptr();
                (*csw).window = (*w).id;
                (*csw).idx = (*wl).idx as u32;
                rb_insert(&raw mut (*csub).windows, csw);
            }

            if !(*csw).last.is_null() && libc::strcmp(value, (*csw).last) == 0 {
                free_(value);
                continue;
            }
            control_write!(
                c,
                "%subscription-changed {} ${} @{} {} - : {}",
                _s((*csub).name),
                (*s).id,
                (*w).id,
                (*wl).idx,
                _s(value),
            );
            free_((*csw).last);
            (*csw).last = value;
        }
    }
}

pub unsafe fn control_check_subs_all_windows(c: *mut client, csub: *mut control_sub) {
    unsafe {
        let s = (*c).session;
        let mut find: control_sub_window = zeroed();

        for wl in rb_foreach(&raw mut (*s).windows).map(NonNull::as_ptr) {
            let w = (*wl).window;

            let ft = format_create_defaults(null_mut(), c, s, wl, null_mut());
            let value = format_expand(ft, (*csub).format);
            format_free(ft);

            find.window = (*w).id;
            find.idx = (*wl).idx as u32;

            let mut csw = rb_find(&raw mut (*csub).windows, &raw mut find);
            if csw.is_null() {
                csw = xcalloc_::<control_sub_window>(1).as_ptr();
                (*csw).window = (*w).id;
                (*csw).idx = (*wl).idx as u32;
                rb_insert(&raw mut (*csub).windows, csw);
            }

            if !(*csw).last.is_null() && libc::strcmp(value, (*csw).last) == 0 {
                free_(value);
                continue;
            }
            control_write!(
                c,
                "%subscription-changed {} ${} @{} {} - : {}",
                _s((*csub).name),
                (*s).id,
                (*w).id,
                (*wl).idx,
                _s(value),
            );
            free_((*csw).last);
            (*csw).last = value;
        }
    }
}

/// C `vendor/tmux/control.c:1042`: `static void control_check_subs_timer(__unused int fd, __unused short events, void *data)`
pub unsafe extern "C-unwind" fn control_check_subs_timer(
    _fd: i32,
    _events: i16,
    c: NonNull<client>,
) {
    unsafe {
        let c: *mut client = c.as_ptr();
        let cs = (*c).control_state;
        let mut tv = timeval {
            tv_sec: 1,
            tv_usec: 0,
        };

        log_debug!("{}: timer fired", "control_check_subs_timer");
        evtimer_add(&raw mut (*cs).subs_timer, &raw mut tv);

        for csub in rb_foreach(&raw mut (*cs).subs).map(NonNull::as_ptr) {
            match (*csub).type_ {
                control_sub_type::CONTROL_SUB_SESSION => control_check_subs_session(c, csub),
                control_sub_type::CONTROL_SUB_PANE => control_check_subs_pane(c, csub),
                control_sub_type::CONTROL_SUB_ALL_PANES => control_check_subs_all_panes(c, csub),
                control_sub_type::CONTROL_SUB_WINDOW => control_check_subs_window(c, csub),
                control_sub_type::CONTROL_SUB_ALL_WINDOWS => {
                    control_check_subs_all_windows(c, csub);
                }
            }
        }
    }
}

/// C `vendor/tmux/control.c:1139`: `void control_add_sub(struct client *c, const char *name, enum control_sub_type type, int id, const char *format)`
pub unsafe fn control_add_sub(
    c: *mut client,
    name: *mut u8,
    type_: control_sub_type,
    id: i32,
    format: *const u8,
) {
    unsafe {
        let cs = (*c).control_state;
        let tv = timeval {
            tv_sec: 1,
            tv_usec: 0,
        };

        let mut find: control_sub = zeroed();

        find.name = name.cast();
        let mut csub = rb_find(&raw mut (*cs).subs, &raw mut find);
        if !csub.is_null() {
            control_free_sub(cs, csub);
        }

        csub = xcalloc_::<control_sub>(1).as_ptr();
        (*csub).name = xstrdup(name).as_ptr();
        (*csub).type_ = type_;
        (*csub).id = id as u32;
        (*csub).format = xstrdup(format).as_ptr();
        rb_insert(&raw mut (*cs).subs, csub);

        rb_init(&raw mut (*csub).panes);
        rb_init(&raw mut (*csub).windows);

        if !evtimer_initialized(&raw mut (*cs).subs_timer) {
            evtimer_set(
                &raw mut (*cs).subs_timer,
                control_check_subs_timer,
                NonNull::new(c).unwrap(),
            );
        }
        if evtimer_pending(&raw mut (*cs).subs_timer, null_mut()) == 0 {
            evtimer_add(&raw mut (*cs).subs_timer, &tv);
        }
    }
}

/// C `vendor/tmux/control.c:1168`: `void control_remove_sub(struct client *c, const char *name)`
pub unsafe fn control_remove_sub(c: *mut client, name: *mut u8) {
    unsafe {
        let cs = (*c).control_state;

        let mut find: control_sub = zeroed();
        find.name = name.cast();
        let csub = rb_find(&raw mut (*cs).subs, &raw mut find);
        if !csub.is_null() {
            control_free_sub(cs, csub);
        }
        if rb_empty(&raw mut (*cs).subs) {
            evtimer_del(&raw mut (*cs).subs_timer);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    // These RB-tree comparators order the control-mode trees. The structs are
    // plain C-style records with no Drop impl, so a zeroed instance with the
    // relevant fields set is a safe way to exercise the ordering.

    // control_pane_cmp orders by pane id alone.
    #[test]
    fn test_control_pane_cmp() {
        unsafe {
            let mut a: control_pane = zeroed();
            let mut b: control_pane = zeroed();
            a.pane = 1;
            b.pane = 2;
            assert_eq!(control_pane_cmp(&a, &b), cmp::Ordering::Less);
            assert_eq!(control_pane_cmp(&b, &a), cmp::Ordering::Greater);
            b.pane = 1;
            assert_eq!(control_pane_cmp(&a, &b), cmp::Ordering::Equal);
        }
    }

    // control_sub_pane_cmp orders by pane first, then breaks ties on idx.
    #[test]
    fn test_control_sub_pane_cmp_tie_breaks_on_idx() {
        unsafe {
            let mut a: control_sub_pane = zeroed();
            let mut b: control_sub_pane = zeroed();
            // Different pane dominates regardless of idx.
            a.pane = 1;
            a.idx = 99;
            b.pane = 2;
            b.idx = 0;
            assert_eq!(control_sub_pane_cmp(&a, &b), cmp::Ordering::Less);
            // Same pane -> idx decides.
            b.pane = 1;
            b.idx = 100;
            assert_eq!(control_sub_pane_cmp(&a, &b), cmp::Ordering::Less);
            b.idx = 99;
            assert_eq!(control_sub_pane_cmp(&a, &b), cmp::Ordering::Equal);
        }
    }

    // control_sub_window_cmp orders by window first, then breaks ties on idx.
    #[test]
    fn test_control_sub_window_cmp_tie_breaks_on_idx() {
        unsafe {
            let mut a: control_sub_window = zeroed();
            let mut b: control_sub_window = zeroed();
            a.window = 5;
            a.idx = 1;
            b.window = 5;
            b.idx = 2;
            assert_eq!(control_sub_window_cmp(&a, &b), cmp::Ordering::Less);
            b.window = 4;
            b.idx = 100;
            // Lower window wins even though its idx is far higher.
            assert_eq!(control_sub_window_cmp(&a, &b), cmp::Ordering::Greater);
        }
    }

    // control_sub_cmp orders by the subscription name (C strcmp semantics).
    #[test]
    fn test_control_sub_cmp_by_name() {
        unsafe {
            let mut a: control_sub = zeroed();
            let mut b: control_sub = zeroed();
            a.name = crate::c!("alpha") as *mut u8;
            b.name = crate::c!("beta") as *mut u8;
            assert_eq!(control_sub_cmp(&a, &b), cmp::Ordering::Less);
            assert_eq!(control_sub_cmp(&b, &a), cmp::Ordering::Greater);
            b.name = crate::c!("alpha") as *mut u8;
            assert_eq!(control_sub_cmp(&a, &b), cmp::Ordering::Equal);
        }
    }

    // control_sub_window_cmp is Equal only when both window and idx match
    // (control.c:185-193), otherwise idx breaks the tie within a window.
    #[test]
    fn test_control_sub_window_cmp_equal_and_idx_tiebreak() {
        unsafe {
            let mut a: control_sub_window = zeroed();
            let mut b: control_sub_window = zeroed();
            a.window = 7;
            a.idx = 3;
            b.window = 7;
            b.idx = 3;
            assert_eq!(control_sub_window_cmp(&a, &b), cmp::Ordering::Equal);
            b.idx = 4;
            assert_eq!(control_sub_window_cmp(&a, &b), cmp::Ordering::Less);
        }
    }

    // control_sub_cmp uses C strcmp (control.c:159-164): a prefix sorts before
    // the longer string that starts with it.
    #[test]
    fn test_control_sub_cmp_prefix_ordering() {
        unsafe {
            let mut a: control_sub = zeroed();
            let mut b: control_sub = zeroed();
            a.name = crate::c!("a") as *mut u8;
            b.name = crate::c!("ab") as *mut u8;
            assert_eq!(control_sub_cmp(&a, &b), cmp::Ordering::Less);
            assert_eq!(control_sub_cmp(&b, &a), cmp::Ordering::Greater);
        }
    }
}