ztmux 3.7.20

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
// Copyright (c) 2013 Nicholas Marriott <nicholas.marriott@gmail.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::cfg_::cfg_add_cause;
use crate::compat::queue::{
    tailq_empty, tailq_first, tailq_insert_after, tailq_insert_tail, tailq_last, tailq_next,
    tailq_remove,
};
use crate::xmalloc::xcalloc1;
use crate::*;
use crate::options_::*;

// #define cmdq_get_callback(cb, data) cmdq_get_callback1(#cb, cb, data)
macro_rules! cmdq_get_callback {
    ($cb:ident, $data:expr) => {
        $crate::cmd_::cmd_queue::cmdq_get_callback1(stringify!($cb), Some($cb), $data)
    };
}
pub(crate) use cmdq_get_callback;

use crate::libc::{getpwuid, getuid};

// Command queue flags.
pub const CMDQ_FIRED: i32 = 0x1;
pub const CMDQ_WAITING: i32 = 0x2;

// Command queue item type.
#[repr(i32)]
#[derive(Copy, Clone)]
pub enum cmdq_type {
    CMDQ_COMMAND,
    CMDQ_CALLBACK,
}

// #[derive(crate::compat::TailQEntry)]
impl_tailq_entry!(cmdq_item, entry, tailq_entry<cmdq_item>);
#[repr(C)]
pub struct cmdq_item {
    pub name: *mut u8,
    pub queue: *mut cmdq_list,
    pub next: *mut cmdq_item,

    pub client: *mut client,
    pub target_client: *mut client,

    pub type_: cmdq_type,
    pub group: u32,

    pub number: u32,
    pub time: time_t,

    pub flags: i32,

    pub state: *mut cmdq_state,
    pub source: cmd_find_state,
    pub target: cmd_find_state,

    pub cmdlist: *mut cmd_list,
    pub cmd: *mut cmd,

    pub cb: cmdq_cb,
    pub data: *mut c_void,

    // #[entry]
    pub entry: tailq_entry<cmdq_item>,
}

pub type cmdq_item_list = tailq_head<cmdq_item>;

#[repr(C)]
pub struct cmdq_state {
    pub references: i32,
    pub flags: cmdq_state_flags,

    pub formats: *mut format_tree,

    pub event: key_event,
    pub current: cmd_find_state,
}

#[repr(C)]
pub struct cmdq_list {
    pub item: *mut cmdq_item,
    pub list: cmdq_item_list,
}

/// C `vendor/tmux/cmd-queue.c:96`: `static const char *cmdq_name(struct client *c)`
pub unsafe fn cmdq_name(c: *const client) -> *const u8 {
    static mut BUF: [u8; 256] = [0; 256];
    let s = &raw mut BUF as *mut u8;

    if c.is_null() {
        return c!("<global>");
    }

    unsafe {
        if !(*c).name.is_null() {
            _ = xsnprintf_!(s, 256, "<{}>", _s((*c).name));
        } else {
            _ = xsnprintf_!(s, 256, "<{:p}>", c);
        }
    }

    s
}

/// C `vendor/tmux/cmd-queue.c:111`: `static struct cmdq_list *cmdq_get(struct client *c)`
pub unsafe fn cmdq_get(c: *mut client) -> *mut cmdq_list {
    static mut GLOBAL_QUEUE: *mut cmdq_list = null_mut();

    unsafe {
        if c.is_null() {
            if GLOBAL_QUEUE.is_null() {
                GLOBAL_QUEUE = cmdq_new().as_ptr();
            }
            return GLOBAL_QUEUE;
        }

        (*c).queue
    }
}

/// C `vendor/tmux/cmd-queue.c:125`: `struct cmdq_list *cmdq_new(void)`
pub fn cmdq_new() -> NonNull<cmdq_list> {
    let mut queue = Box::new(cmdq_list {
        item: null_mut(),
        list: tailq_head {
            tqh_first: null_mut(),
            tqh_last: null_mut(),
        },
    });
    tailq_init_(&mut queue.list);
    NonNull::new(Box::leak(queue)).unwrap()
}

/// C `vendor/tmux/cmd-queue.c:136`: `void cmdq_free(struct cmdq_list *queue)`
pub unsafe fn cmdq_free(queue: *mut cmdq_list) {
    unsafe {
        if !tailq_empty(&raw mut (*queue).list) {
            fatalx("queue not empty");
        }
        free_(queue);
    }
}

/// C `vendor/tmux/cmd-queue.c:145`: `const char *cmdq_get_name(struct cmdq_item *item)`
pub unsafe fn cmdq_get_name(item: *mut cmdq_item) -> *mut u8 {
    unsafe { (*item).name }
}

/// C `vendor/tmux/cmd-queue.c:152`: `struct client *cmdq_get_client(struct cmdq_item *item)`
pub unsafe fn cmdq_get_client(item: *mut cmdq_item) -> *mut client {
    unsafe { (*item).client }
}

/// C `vendor/tmux/cmd-queue.c:159`: `struct client *cmdq_get_target_client(struct cmdq_item *item)`
pub unsafe fn cmdq_get_target_client(item: *mut cmdq_item) -> *mut client {
    unsafe { (*item).target_client }
}

/// C `vendor/tmux/cmd-queue.c:166`: `struct cmdq_state *cmdq_get_state(struct cmdq_item *item)`
pub unsafe fn cmdq_get_state(item: *mut cmdq_item) -> *mut cmdq_state {
    unsafe { (*item).state }
}

/// C `vendor/tmux/cmd-queue.c:173`: `struct cmd_find_state *cmdq_get_target(struct cmdq_item *item)`
pub unsafe fn cmdq_get_target(item: *mut cmdq_item) -> *mut cmd_find_state {
    unsafe { &raw mut (*item).target }
}

/// C `vendor/tmux/cmd-queue.c:180`: `struct cmd_find_state *cmdq_get_source(struct cmdq_item *item)`
pub unsafe fn cmdq_get_source(item: *mut cmdq_item) -> *mut cmd_find_state {
    unsafe { &raw mut (*item).source }
}

/// C `vendor/tmux/cmd-queue.c:187`: `struct key_event *cmdq_get_event(struct cmdq_item *item)`
pub unsafe fn cmdq_get_event(item: *mut cmdq_item) -> *mut key_event {
    unsafe { &raw mut (*(*item).state).event }
}

/// C `vendor/tmux/cmd-queue.c:194`: `struct cmd_find_state *cmdq_get_current(struct cmdq_item *item)`
pub unsafe fn cmdq_get_current(item: *mut cmdq_item) -> *mut cmd_find_state {
    unsafe { &raw mut (*(*item).state).current }
}

/// C `vendor/tmux/cmd-queue.c:201`: `int cmdq_get_flags(struct cmdq_item *item)`
pub unsafe fn cmdq_get_flags(item: *const cmdq_item) -> cmdq_state_flags {
    unsafe { (*(*item).state).flags }
}

/// C `vendor/tmux/cmd-queue.c:208`: `struct cmdq_state *cmdq_new_state(struct cmd_find_state *current, struct key_event *event, int flags)`
pub unsafe fn cmdq_new_state(
    current: *const cmd_find_state,
    event: *const key_event,
    flags: cmdq_state_flags,
) -> *mut cmdq_state {
    unsafe {
        let state: *mut cmdq_state = xcalloc1::<cmdq_state>();
        (*state).references = 1;
        (*state).flags = flags;

        if !event.is_null() {
            memcpy__(&raw mut (*state).event, event);
        } else {
            (*state).event.key = KEYC_NONE;
        }
        if !current.is_null() && cmd_find_valid_state(current) {
            cmd_find_copy_state(&raw mut (*state).current, current);
        } else {
            cmd_find_clear_state(&raw mut (*state).current, cmd_find_flags::empty());
        }

        state
    }
}

/// C `vendor/tmux/cmd-queue.c:231`: `struct cmdq_state *cmdq_link_state(struct cmdq_state *state)`
pub unsafe fn cmdq_link_state(state: *mut cmdq_state) -> *mut cmdq_state {
    unsafe {
        (*state).references += 1;
    }
    state
}

/// C `vendor/tmux/cmd-queue.c:239`: `struct cmdq_state *cmdq_copy_state(struct cmdq_state *state, struct cmd_find_state *current)`
pub unsafe fn cmdq_copy_state(
    state: *mut cmdq_state,
    current: *mut cmd_find_state,
) -> *mut cmdq_state {
    unsafe {
        if !current.is_null() {
            return cmdq_new_state(current, &raw mut (*state).event, (*state).flags);
        }

        cmdq_new_state(
            &raw mut (*state).current,
            &raw mut (*state).event,
            (*state).flags,
        )
    }
}

/// C `vendor/tmux/cmd-queue.c:248`: `void cmdq_free_state(struct cmdq_state *state)`
pub unsafe fn cmdq_free_state(state: *mut cmdq_state) {
    unsafe {
        (*state).references -= 1;
        if (*state).references != 0 {
            return;
        }

        if !(*state).formats.is_null() {
            format_free((*state).formats);
        }
        free_(state);
    }
}

macro_rules! cmdq_add_format {
   ($state:expr, $key:expr, $fmt:literal $(, $args:expr)* $(,)?) => {
        crate::cmd_::cmd_queue::cmdq_add_format_($state, $key, format_args!($fmt $(, $args)*))
    };
}
pub(crate) use cmdq_add_format;

pub unsafe fn cmdq_add_format_(state: *mut cmdq_state, key: *const u8, args: std::fmt::Arguments) {
    unsafe {
        let value = args.to_string();

        if (*state).formats.is_null() {
            (*state).formats =
                format_create(null_mut(), null_mut(), FORMAT_NONE, format_flags::empty());
        }
        format_add!((*state).formats, cstr_to_str(key), "{}", value);
    }
}

/// C `vendor/tmux/cmd-queue.c:278`: `void cmdq_add_formats(struct cmdq_state *state, struct format_tree *ft)`
pub unsafe fn cmdq_add_formats(state: *mut cmdq_state, ft: *mut format_tree) {
    unsafe {
        if (*state).formats.is_null() {
            (*state).formats =
                format_create(null_mut(), null_mut(), FORMAT_NONE, format_flags::empty());
        }
        format_merge((*state).formats, ft);
    }
}

/// C `vendor/tmux/cmd-queue.c:287`: `void cmdq_merge_formats(struct cmdq_item *item, struct format_tree *ft)`
pub unsafe fn cmdq_merge_formats(item: *mut cmdq_item, ft: *mut format_tree) {
    unsafe {
        if !(*item).cmd.is_null() {
            let entry = cmd_get_entry((*item).cmd);
            format_add!(ft, "command", "{}", entry.name);
        }

        if !(*(*item).state).formats.is_null() {
            format_merge(ft, (*(*item).state).formats);
        }
    }
}

/// C `vendor/tmux/cmd-queue.c:301`: `struct cmdq_item *cmdq_append(struct client *c, struct cmdq_item *item)`
pub unsafe fn cmdq_append(c: *mut client, mut item: *mut cmdq_item) -> *mut cmdq_item {
    let __func__ = "cmdq_append";

    unsafe {
        let queue = cmdq_get(c);

        let mut next;
        loop {
            next = (*item).next;
            (*item).next = null_mut();

            if !c.is_null() {
                (*c).references += 1;
            }
            (*item).client = c;

            (*item).queue = queue;
            tailq_insert_tail::<_, ()>(&raw mut (*queue).list, item);
            log_debug!("{} {}: {}", __func__, _s(cmdq_name(c)), _s((*item).name));

            item = next;
            if item.is_null() {
                break;
            }
        }
        tailq_last(&raw mut (*queue).list)
    }
}

// TODO crashes with this one

/// C `vendor/tmux/cmd-queue.c:325`: `struct cmdq_item *cmdq_insert_after(struct cmdq_item *after, struct cmdq_item *item)`
pub unsafe fn cmdq_insert_after(
    mut after: *mut cmdq_item,
    mut item: *mut cmdq_item,
) -> *mut cmdq_item {
    unsafe {
        let c = (*after).client;
        let queue = (*after).queue;

        loop {
            let next = (*item).next;
            (*item).next = (*after).next;
            (*after).next = item;

            if !c.is_null() {
                (*c).references += 1;
            }
            (*item).client = c;

            (*item).queue = queue;
            tailq_insert_after(&raw mut (*queue).list, after, item);
            log_debug!(
                "{} {}: {} after {}",
                "cmdq_insert_after",
                _s(cmdq_name(c)),
                _s((*item).name),
                _s((*after).name),
            );

            after = item;
            item = next;
            if item.is_null() {
                break;
            }
        }
        after
    }
}

macro_rules! cmdq_insert_hook {
   ($s:expr,$item:expr,$current:expr, $fmt:literal $(, $args:expr)* $(,)?) => {
        crate::cmd_::cmd_queue::cmdq_insert_hook_($s, $item, $current, format_args!($fmt $(, $args)*))
    };
}
pub(crate) use cmdq_insert_hook;

pub unsafe fn cmdq_insert_hook_(
    s: *mut session,
    mut item: *mut cmdq_item,
    current: *mut cmd_find_state,
    format_args: std::fmt::Arguments,
) {
    unsafe {
        let state = (*item).state;
        let cmd = (*item).cmd;
        let args = cmd_get_args(cmd);
        let mut ae: *mut args_entry = null_mut();
        let mut flag: u8;
        const SIZEOF_TMP: usize = 32;
        let mut buf: [u8; 32] = zeroed();
        let tmp = &raw mut buf as *mut u8;

        if (*(*item).state)
            .flags
            .intersects(cmdq_state_flags::CMDQ_STATE_NOHOOKS)
        {
            return;
        }
        let oo = if s.is_null() {
            GLOBAL_S_OPTIONS
        } else {
            (*s).options
        };

        let name: String = format_args.to_string();

        let o = options_get(&mut *oo, &name);
        if o.is_null() {
            return;
        }
        log_debug!("running hook {} (parent {:p})", name, item);

        // The hooks get a new state because they should not update the current
        // target or formats for any subsequent commands.
        let new_state = cmdq_new_state(
            current,
            &raw mut (*state).event,
            cmdq_state_flags::CMDQ_STATE_NOHOOKS,
        );
        cmdq_add_format!(new_state, c!("hook"), "{}", name);

        let arguments = args_print(args);
        cmdq_add_format!(new_state, c!("hook_arguments"), "{}", _s(arguments),);
        free_(arguments);

        for i in 0..args_count(args) {
            _ = xsnprintf_!(tmp, SIZEOF_TMP, "hook_argument_{}", i);
            cmdq_add_format!(new_state, tmp, "{}", _s(args_string(args, i)));
        }
        flag = args_first(args, &raw mut ae);
        while flag != 0 {
            let value = args_get(args, flag);
            if value.is_null() {
                _ = xsnprintf_!(tmp, SIZEOF_TMP, "hook_flag_{}", flag as char);
                cmdq_add_format!(new_state, tmp, "1");
            } else {
                _ = xsnprintf_!(tmp, SIZEOF_TMP, "hook_flag_{}", flag as char);
                cmdq_add_format!(new_state, tmp, "{}", _s(value));
            }

            let mut i = 0;
            let mut av = args_first_value(args, flag);
            while !av.is_null() {
                _ = xsnprintf_!(tmp, SIZEOF_TMP, "hook_flag_{}_{}", flag as char, i);
                cmdq_add_format!(new_state, tmp, "{}", _s((*av).union_.string));
                i += 1;
                av = args_next_value(av);
            }

            flag = args_next(&raw mut ae);
        }

        let mut a = options_array_first(o);
        while !a.is_null() {
            let cmdlist = (*options_array_item_value(a)).cmdlist;
            if !cmdlist.is_null() {
                let new_item = cmdq_get_command(cmdlist, new_state);
                if !item.is_null() {
                    item = cmdq_insert_after(item, new_item);
                } else {
                    item = cmdq_append(null_mut(), new_item);
                }
            }
            a = options_array_next(a);
        }

        cmdq_free_state(new_state);
    }
}

/// C `vendor/tmux/cmd-queue.c:447`: `void cmdq_continue(struct cmdq_item *item)`
pub unsafe fn cmdq_continue(item: *mut cmdq_item) {
    unsafe {
        (*item).flags &= !CMDQ_WAITING;
    }
}

/// C `vendor/tmux/cmd-queue.c:454`: `static void cmdq_remove(struct cmdq_item *item)`
pub unsafe fn cmdq_remove(item: *mut cmdq_item) {
    unsafe {
        if !(*item).client.is_null() {
            server_client_unref((*item).client);
        }
        if !(*item).cmdlist.is_null() {
            cmd_list_free((*item).cmdlist);
        }
        cmdq_free_state((*item).state);

        tailq_remove(&raw mut (*(*item).queue).list, item);

        free_((*item).name);
        free_(item);
    }
}

/// C `vendor/tmux/cmd-queue.c:470`: `static void cmdq_remove_group(struct cmdq_item *item)`
pub unsafe fn cmdq_remove_group(item: *mut cmdq_item) {
    unsafe {
        if (*item).group == 0 {
            return;
        }
        let mut this = tailq_next(item);
        while !this.is_null() {
            let next = tailq_next(this);
            if (*this).group == (*item).group {
                cmdq_remove(this);
            }
            this = next;
        }
    }
}

/// C `vendor/tmux/cmd-queue.c:487`: `static enum cmd_retval cmdq_empty_command(__unused struct cmdq_item *item, __unused void *data)`
pub unsafe fn cmdq_empty_command(_item: *mut cmdq_item, _data: *mut c_void) -> cmd_retval {
    cmd_retval::CMD_RETURN_NORMAL
}

/// C `vendor/tmux/cmd-queue.c:494`: `struct cmdq_item *cmdq_get_command(struct cmd_list *cmdlist, struct cmdq_state *state)`
pub unsafe fn cmdq_get_command(
    cmdlist: *mut cmd_list,
    mut state: *mut cmdq_state,
) -> *mut cmdq_item {
    unsafe {
        let mut first: *mut cmdq_item = null_mut();
        let mut last: *mut cmdq_item = null_mut();
        let mut created = false;

        let mut cmd = cmd_list_first(cmdlist);
        if cmd.is_null() {
            return cmdq_get_callback!(cmdq_empty_command, null_mut()).as_ptr();
        }

        if state.is_null() {
            state = cmdq_new_state(null_mut(), null_mut(), cmdq_state_flags::empty());
            created = true;
        }

        while !cmd.is_null() {
            let entry = cmd_get_entry(cmd);

            let item = xcalloc1::<cmdq_item>() as *mut cmdq_item;
            (*item).name = format_nul!("[{}/{:p}]", entry.name, item,);
            (*item).type_ = cmdq_type::CMDQ_COMMAND;

            (*item).group = cmd_get_group(cmd);
            (*item).state = cmdq_link_state(state);

            (*item).cmdlist = cmdlist;
            (*item).cmd = cmd;

            (*cmdlist).references += 1;
            // log_debug_!("cmdq_get_command: {} group {}", PercentS((*item).name), (*item).group,);

            if first.is_null() {
                first = item;
            }
            if !last.is_null() {
                (*last).next = item;
            }
            last = item;

            cmd = cmd_list_next(cmd);
        }

        if created {
            cmdq_free_state(state);
        }
        first
    }
}

/// C `vendor/tmux/cmd-queue.c:541`: `static enum cmd_retval cmdq_find_flag(struct cmdq_item *item, struct cmd_find_state *fs, const struct cmd_entry_flag *flag)`
pub unsafe fn cmdq_find_flag(
    item: *mut cmdq_item,
    fs: *mut cmd_find_state,
    flag: *const cmd_entry_flag,
) -> cmd_retval {
    unsafe {
        if (*flag).flag == 0 {
            cmd_find_from_client(fs, (*item).target_client, cmd_find_flags::empty());
            return cmd_retval::CMD_RETURN_NORMAL;
        }

        let value = args_get(cmd_get_args((*item).cmd), (*flag).flag);
        if cmd_find_target(fs, item, cstr_to_str_(value), (*flag).type_, (*flag).flags) != 0 {
            cmd_find_clear_state(fs, cmd_find_flags::empty());
            return cmd_retval::CMD_RETURN_ERROR;
        }

        cmd_retval::CMD_RETURN_NORMAL
    }
}

/// C `vendor/tmux/cmd-queue.c:561`: `static void cmdq_add_message(struct cmdq_item *item)`
pub unsafe fn cmdq_add_message(item: *mut cmdq_item) {
    unsafe {
        let c = (*item).client;
        let state = (*item).state;
        let user;

        let tmp = cmd_print((*item).cmd);
        if !c.is_null() {
            let uid = proc_get_peer_uid((*c).peer);
            if uid != -1i32 as uid_t && uid != getuid() {
                let pw = getpwuid(uid);
                if !pw.is_null() {
                    user = format_nul!("[{}]", _s((*pw).pw_name));
                } else {
                    user = xstrdup(c!("[unknown]")).as_ptr();
                }
            } else {
                user = xstrdup(c!("")).as_ptr();
            }
            if !(*c).session.is_null() && (*state).event.key != KEYC_NONE {
                let key = key_string_lookup_key((*state).event.key, 0);
                server_add_message!("{}{} key {}: {}", _s((*c).name), _s(user), _s(key), _s(tmp));
            } else {
                server_add_message!("{}{} command: {}", _s((*c).name), _s(user), _s(tmp));
            }
            free_(user);
        } else {
            server_add_message!("command: {}", _s(tmp));
        }
        free_(tmp);
    }
}

/// C `vendor/tmux/cmd-queue.c:597`: `static enum cmd_retval cmdq_fire_command(struct cmdq_item *item)`
pub unsafe fn cmdq_fire_command(item: *mut cmdq_item) -> cmd_retval {
    let __func__ = "cmdq_fire_command";

    unsafe {
        let name = cmdq_name((*item).client);
        let state = (*item).state;
        let cmd = (*item).cmd;
        let args = cmd_get_args(cmd);
        let entry = cmd_get_entry(cmd);
        let tc;
        let saved = (*item).client;
        let mut retval;
        let mut fs: cmd_find_state = zeroed();
        let mut fsp: *mut cmd_find_state;
        let mut quiet = 0;
        let flags;

        'out: {
            if CFG_FINISHED.load(atomic::Ordering::Acquire) {
                cmdq_add_message(item);
            }
            if log_get_level() > 1 {
                let tmp = cmd_print(cmd);
                log_debug!("{} {}: ({}) {}", __func__, _s(name), (*item).group, _s(tmp));
                free_(tmp);
            }

            flags = (*state)
                .flags
                .intersects(cmdq_state_flags::CMDQ_STATE_CONTROL);
            cmdq_guard(item, c!("begin"), flags);

            if (*item).client.is_null() {
                (*item).client = cmd_find_client(item, None, 1);
            }

            if entry.flags.intersects(cmd_flag::CMD_CLIENT_CANFAIL) {
                quiet = 1;
            }
            if entry.flags.intersects(cmd_flag::CMD_CLIENT_CFLAG) {
                tc = cmd_find_client(item, cstr_to_str_(args_get_(args, 'c')), quiet);
                if tc.is_null() && quiet == 0 {
                    retval = cmd_retval::CMD_RETURN_ERROR;
                    break 'out;
                }
            } else if entry.flags.intersects(cmd_flag::CMD_CLIENT_TFLAG) {
                tc = cmd_find_client(item, cstr_to_str_(args_get_(args, 't')), quiet);
                if tc.is_null() && quiet == 0 {
                    retval = cmd_retval::CMD_RETURN_ERROR;
                    break 'out;
                }
            } else {
                tc = cmd_find_client(item, None, 1);
            }
            (*item).target_client = tc;

            retval = cmdq_find_flag(item, &raw mut (*item).source, &entry.source);
            if retval == cmd_retval::CMD_RETURN_ERROR {
                break 'out;
            }
            retval = cmdq_find_flag(item, &raw mut (*item).target, &entry.target);
            if retval == cmd_retval::CMD_RETURN_ERROR {
                break 'out;
            }

            // log_debug_!("entry_name: {}", PercentS((*entry).name));

            retval = (entry.exec)(cmd, item);
            if retval == cmd_retval::CMD_RETURN_ERROR {
                break 'out;
            }

            if entry.flags.intersects(cmd_flag::CMD_AFTERHOOK) {
                fsp = if cmd_find_valid_state(&raw mut (*item).target) {
                    &raw mut (*item).target
                } else if cmd_find_valid_state(&raw mut (*(*item).state).current) {
                    &raw mut (*(*item).state).current
                } else if cmd_find_from_client(&raw mut fs, (*item).client, cmd_find_flags::empty())
                    == 0
                {
                    &raw mut fs
                } else {
                    break 'out;
                };
                cmdq_insert_hook!((*fsp).s, item, fsp, "after-{}", entry.name);
            }
        }

        (*item).client = saved;
        if retval == cmd_retval::CMD_RETURN_ERROR {
            fsp = null_mut();
            if cmd_find_valid_state(&raw mut (*item).target) {
                fsp = &raw mut (*item).target;
            } else if cmd_find_valid_state(&raw mut (*(*item).state).current) {
                fsp = &raw mut (*(*item).state).current;
            } else if cmd_find_from_client(&raw mut fs, (*item).client, cmd_find_flags::empty())
                == 0
            {
                fsp = &raw mut fs;
            }
            cmdq_insert_hook!(
                if !fsp.is_null() { (*fsp).s } else { null_mut() },
                item,
                fsp,
                "command-error"
            );
            cmdq_guard(item, c!("error"), flags);
        } else {
            cmdq_guard(item, c!("end"), flags);
        }
        retval
    }
}

/// C `vendor/tmux/cmd-queue.c:685`: `struct cmdq_item *cmdq_get_callback1(const char *name, cmdq_cb cb, void *data)`
pub unsafe fn cmdq_get_callback1(name: &str, cb: cmdq_cb, data: *mut u8) -> NonNull<cmdq_item> {
    let item = xcalloc_::<cmdq_item>(1).as_ptr();

    unsafe {
        (*item).name = format_nul!("[{}/{:p}]", name, item);
        (*item).type_ = cmdq_type::CMDQ_CALLBACK;

        (*item).group = 0;
        (*item).state = cmdq_new_state(null_mut(), null_mut(), cmdq_state_flags::empty());

        (*item).cb = cb;
        (*item).data = data as _;

        NonNull::new_unchecked(item)
    }
}

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

    unsafe {
        cmdq_error!(item, "{}", _s(error));
        free_(error);
    }

    cmd_retval::CMD_RETURN_NORMAL
}

/// C `vendor/tmux/cmd-queue.c:716`: `struct cmdq_item *cmdq_get_error(const char *error)`
pub unsafe fn cmdq_get_error(error: *const u8) -> NonNull<cmdq_item> {
    unsafe { cmdq_get_callback!(cmdq_error_callback, xstrdup(error).as_ptr()) }
}

/// C `vendor/tmux/cmd-queue.c:723`: `static enum cmd_retval cmdq_fire_callback(struct cmdq_item *item)`
pub unsafe fn cmdq_fire_callback(item: *mut cmdq_item) -> cmd_retval {
    unsafe { ((*item).cb.unwrap())(item, (*item).data) }
}

/// C `vendor/tmux/cmd-queue.c:730`: `u_int cmdq_next(struct client *c)`
pub unsafe fn cmdq_next(c: *mut client) -> u32 {
    let __func__ = "cmdq_next";
    static mut NUMBER: u32 = 0;
    let mut items = 0;
    let mut retval: cmd_retval;

    unsafe {
        let queue = cmdq_get(c);
        let name = cmdq_name(c);

        'waiting: {
            if tailq_empty(&raw mut (*queue).list) {
                // log_debug!("{} {}: empty", __func__, _s(name));
                return 0;
            }
            if (*tailq_first(&raw mut (*queue).list)).flags & CMDQ_WAITING != 0 {
                // Too noisy:
                // log_debug!("{} {}: waiting", __func__, _s(name));
                return 0;
            }

            log_debug!("{} {}: enter", __func__, _s(name));
            loop {
                (*queue).item = tailq_first(&raw mut (*queue).list);
                let item = (*queue).item;
                if item.is_null() {
                    break;
                }
                log_debug!(
                    "{} {}: {} ({}), flags {}",
                    __func__,
                    _s(name),
                    _s((*item).name),
                    (*item).type_ as i32,
                    (*item).flags
                );

                if (*item).flags & CMDQ_WAITING != 0 {
                    break 'waiting;
                }

                if !(*item).flags & CMDQ_FIRED != 0 {
                    (*item).time = libc::time(null_mut());
                    NUMBER += 1;
                    (*item).number = NUMBER;

                    match (*item).type_ {
                        cmdq_type::CMDQ_COMMAND => {
                            retval = cmdq_fire_command(item);

                            if retval == cmd_retval::CMD_RETURN_ERROR {
                                cmdq_remove_group(item);
                            }
                        }
                        cmdq_type::CMDQ_CALLBACK => retval = cmdq_fire_callback(item),
                    }
                    (*item).flags |= CMDQ_FIRED;

                    if retval == cmd_retval::CMD_RETURN_WAIT {
                        (*item).flags |= CMDQ_WAITING;
                        break 'waiting;
                    }
                    items += 1;
                }
                cmdq_remove(item);
            }
            (*queue).item = null_mut();

            log_debug!("{} {}: exit (empty)", __func__, _s(name));
            return items;
        } // 'waiting
        // waiting:
        log_debug!("{} {}: exit (wait)", __func__, _s(name));
        items
    }
}

/// C `vendor/tmux/cmd-queue.c:812`: `struct cmdq_item *cmdq_running(struct client *c)`
pub unsafe fn cmdq_running(c: *mut client) -> *mut cmdq_item {
    unsafe {
        let queue = cmdq_get(c);

        if (*queue).item.is_null() {
            return null_mut();
        }
        if (*(*queue).item).flags & CMDQ_WAITING != 0 {
            return null_mut();
        }
        (*queue).item
    }
}

/// C `vendor/tmux/cmd-queue.c:825`: `void cmdq_guard(struct cmdq_item *item, const char *guard, int flags)`
pub unsafe fn cmdq_guard(item: *mut cmdq_item, guard: *const u8, flags: bool) {
    unsafe {
        let c = (*item).client;
        let t = (*item).time;
        let number = (*item).number;

        if !c.is_null() && (*c).flags.intersects(client_flag::CONTROL) {
            control_write!(c, "%{} {} {} {}", _s(guard), t, number, flags as i32);
        }
    }
}

/// C `vendor/tmux/cmd-queue.c:837`: `void cmdq_print_data(struct cmdq_item *item, struct evbuffer *evb)`
pub unsafe fn cmdq_print_data(item: *mut cmdq_item, evb: *mut evbuffer) {
    unsafe {
        server_client_print((*item).client, 1, evb);
    }
}

macro_rules! cmdq_print {
   ($item:expr, $fmt:literal $(, $args:expr)* $(,)?) => {
        crate::cmd_::cmd_queue::cmdq_print_($item, format_args!($fmt $(, $args)*))
    };
}
pub(crate) use cmdq_print;
pub unsafe fn cmdq_print_(item: *mut cmdq_item, args: std::fmt::Arguments) {
    unsafe {
        let evb = evbuffer_new();
        if evb.is_null() {
            fatalx("out of memory");
        }

        evbuffer_add_vprintf(evb, args);

        cmdq_print_data(item, evb);
        evbuffer_free(evb);
    }
}

macro_rules! cmdq_error {
   ($item:expr, $fmt:literal $(, $args:expr)* $(,)?) => {
        crate::cmd_::cmd_queue::cmdq_error_($item, format_args!($fmt $(, $args)*))
    };
}
pub(crate) use cmdq_error;
pub unsafe fn cmdq_error_(item: *mut cmdq_item, args: std::fmt::Arguments) {
    unsafe {
        let c = (*item).client;
        let cmd = (*item).cmd;
        let mut file = null();
        let line = AtomicU32::new(0);

        let mut msg = args.to_string();
        msg.push('\0');
        let mut msg = msg.leak().as_mut_ptr().cast();

        log_debug!("cmdq_error: {}", _s(msg));

        if c.is_null() {
            cmd_get_source(cmd, &raw mut file, &line);
            cfg_add_cause!("{}:{}: {}", _s(file), line.into_inner(), _s(msg));
        } else if (*c).session.is_null() || (*c).flags.intersects(client_flag::CONTROL) {
            server_add_message!("{} message: {}", _s((*c).name), _s(msg));
            if !(*c).flags.intersects(client_flag::UTF8) {
                let tmp = msg;
                msg = utf8_sanitize(tmp);
                free_(tmp);
            }
            if (*c).flags.intersects(client_flag::CONTROL) {
                control_write!(c, "{}", _s(msg));
            } else {
                file_error!(c, "{}\n", _s(msg));
            }
            (*c).retval = 1;
        } else {
            *msg = (*msg).to_ascii_uppercase();
            status_message_set!(c, -1, 1, false, 0, "{}", _s(msg));
        }

        free_(msg);
    }
}