ztmux 3.7.20

// Copyright (c) 2007 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::*;

const LIST_CLIENTS_TEMPLATE: *const u8 = c!(
    "#{client_name}: #{session_name} [#{client_width}x#{client_height} #{client_termname}] #{?#{!=:#{client_uid},#{uid}},[user #{?client_user,#{client_user},#{client_uid},}] ,}#{?client_flags,(,}#{client_flags}#{?client_flags,),}"
);

pub static CMD_LIST_CLIENTS_ENTRY: cmd_entry = cmd_entry {
    name: "list-clients",
    alias: Some("lsc"),

    args: args_parse::new("F:f:O:o:rt:", 0, 0, None),
    usage: "[-r] [-F format] [-f filter] [-O order] [-o json|jsonl|csv|tsv|table|yaml] [-t target-session]",

    target: cmd_entry_flag::new(
        b't',
        cmd_find_type::CMD_FIND_SESSION,
        cmd_find_flags::empty(),
    ),

    flags: cmd_flag::CMD_READONLY.union(cmd_flag::CMD_AFTERHOOK),
    exec: cmd_list_clients_exec,
    source: cmd_entry_flag::zeroed(),
};

use crate::structured::{Field, FieldKind, OutputFormat, Structured};
const LIST_CLIENTS_FIELDS: &[Field] = &[
    Field { key: "name", fmt: c!("#{client_name}"), kind: FieldKind::Str },
    Field { key: "tty", fmt: c!("#{client_tty}"), kind: FieldKind::Str },
    Field { key: "session", fmt: c!("#{session_name}"), kind: FieldKind::Str },
    Field { key: "width", fmt: c!("#{client_width}"), kind: FieldKind::Int },
    Field { key: "height", fmt: c!("#{client_height}"), kind: FieldKind::Int },
    Field { key: "termname", fmt: c!("#{client_termname}"), kind: FieldKind::Str },
    Field { key: "pid", fmt: c!("#{client_pid}"), kind: FieldKind::Int },
];

/// C `vendor/tmux/cmd-list-clients.c:54`: `static enum cmd_retval cmd_list_clients_exec(struct cmd *self, struct cmdq_item *item)`
unsafe fn cmd_list_clients_exec(self_: *mut cmd, item: *mut cmdq_item) -> cmd_retval {
    unsafe {
        let args = cmd_get_args(self_);
        let target = cmdq_get_target(item);

        let s = if args_has(args, 't') {
            (*target).s
        } else {
            null_mut()
        };

        let mut template = args_get(args, b'F');
        if template.is_null() {
            template = LIST_CLIENTS_TEMPLATE;
        }
        let filter = args_get(args, b'f');

        // -O sort order / -r reverse (C cmd-list-clients.c). SORT_END = natural
        // (tailq) order, so a missing -O leaves the previous ordering unchanged.
        let order = sort_order_from_string(args_get(args, b'O'));
        if order == sort_order::SORT_END && args_has(args, 'O') {
            cmdq_error!(item, "invalid sort order");
            return cmd_retval::CMD_RETURN_ERROR;
        }
        let sort_crit = sort_criteria {
            order,
            reversed: args_has(args, 'r'),
            order_seq: null_mut(),
        };

        let mut structured = match OutputFormat::parse(args_get(args, b'o')) {
            Ok(fmt) => fmt.map(|f| Structured::new(f, LIST_CLIENTS_FIELDS)),
            Err(()) => {
                cmdq_error!(item, "unknown -o format (want json, jsonl, csv or tsv)");
                return cmd_retval::CMD_RETURN_ERROR;
            }
        };

        let mut idx = 0;
        for c in sort_get_clients(sort_crit) {
            if (*c).session.is_null() || (!s.is_null() && s != (*c).session) {
                continue;
            }

            let ft = format_create(
                cmdq_get_client(item),
                item,
                FORMAT_NONE,
                format_flags::empty(),
            );
            format_add!(ft, "line", "{idx}");
            format_defaults(ft, c, None, None, None);

            let flag;
            if !filter.is_null() {
                let expanded = format_expand(ft, filter);
                flag = format_true(expanded);
                free_(expanded);
            } else {
                flag = true;
            }
            if flag {
                if let Some(out) = structured.as_mut() {
                    out.add(ft);
                } else {
                    let line = format_expand(ft, template);
                    cmdq_print!(item, "{}", _s(line));
                    free_(line);
                }
            }

            format_free(ft);

            idx += 1;
        }

        if let Some(out) = structured.as_ref() {
            cmdq_print!(item, "{}", out.render());
        }

        cmd_retval::CMD_RETURN_NORMAL
    }
}