/* $OpenBSD: cmd-list-panes.c,v 1.42 2026/10/09 13:12:14 nicm Exp $ */

/*

 * Copyright (c) 2009 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.

 */

#include <sys/types.h>

#include <stdlib.h>

#include "tmux.h"

/*

 * List panes on given window.

 */

static enum cmd_retval  cmd_list_panes_exec(struct cmd *, struct cmdq_item *);

static void cmd_list_panes_server(struct cmd *, struct cmdq_item *);

static void cmd_list_panes_session(struct cmd *, struct session *,

        struct cmdq_item *, int);

static void cmd_list_panes_window(struct cmd *, struct session *,

        struct winlink *, struct cmdq_item *, int);

const struct cmd_entry cmd_list_panes_entry = {

  .name = "list-panes",

  .description = "List panes and their state.",

  .alias = "lsp",

  .args = { "aF:f:O:rst:", 0, 0, NULL },

  .usage = "[-asr] [-F format] [-f filter] [-O order]"

     CMD_TARGET_WINDOW_USAGE,

  .target = { 't', CMD_FIND_WINDOW, 0 },

  .flags = CMD_AFTERHOOK,

  .exec = cmd_list_panes_exec

};

static enum cmd_retval

cmd_list_panes_exec(struct cmd *self, struct cmdq_item *item)

{

  struct args   *args = cmd_get_args(self);

  struct cmd_find_state *target = cmdq_get_target(item);

  struct session    *s = target->s;

  struct winlink    *wl = target->wl;

  enum sort_order    order;

  order = sort_order_from_string(args_get(args, 'O'));

  if (order == SORT_END && args_has(args, 'O')) {

    cmdq_error(item, "invalid sort order");

    return (CMD_RETURN_ERROR);

  }

  if (args_has(args, 'a'))

    cmd_list_panes_server(self, item);

  else if (args_has(args, 's'))

    cmd_list_panes_session(self, s, item, 1);

  else

    cmd_list_panes_window(self, s, wl, item, 0);

  return (CMD_RETURN_NORMAL);

}

static void

cmd_list_panes_server(struct cmd *self, struct cmdq_item *item)

{

  struct session  *s;

  RB_FOREACH(s, sessions, &sessions)

    cmd_list_panes_session(self, s, item, 2);

}

static void

cmd_list_panes_session(struct cmd *self, struct session *s,

    struct cmdq_item *item, int type)

{

  struct winlink  *wl;

  RB_FOREACH(wl, winlinks, &s->windows)

    cmd_list_panes_window(self, s, wl, item, type);

}

static void

cmd_list_panes_window(struct cmd *self, struct session *s, struct winlink *wl,

    struct cmdq_item *item, int type)

{

  struct args   *args = cmd_get_args(self);

  struct client   *c = cmdq_get_client(item);

  struct window_pane  *wp, **l;

  u_int      i, n;

  struct format_tree  *ft;

  const char    *template, *filter;

  char      *line, *expanded;

  int      flag;

  struct sort_criteria   sort_crit;

  template = args_get(args, 'F');

  if (template == NULL) {

    switch (type) {

    case 0:

      template = "#{pane_index}: "

          "[#{pane_width}x#{pane_height}"

          "#{?pane_floating_flag, "

          "#{pane_x}#,#{pane_y}#,#{pane_z}}] [history "

          "#{history_size}/#{history_limit}, "

          "#{history_bytes} bytes] #{pane_id}"

          "#{?pane_active, (active),}#{?pane_dead, (dead),}";

      break;

    case 1:

      template = "#{window_index}.#{pane_index}: "

          "[#{pane_width}x#{pane_height}"

          "#{?pane_floating_flag, "

          "#{pane_x}#,#{pane_y}#,#{pane_z}}] [history "

          "#{history_size}/#{history_limit}, "

          "#{history_bytes} bytes] #{pane_id}"

          "#{?pane_active, (active),}#{?pane_dead, (dead),}";

      break;

    case 2:

      template = "#{session_name}:#{window_index}."

          "#{pane_index}: [#{pane_width}x#{pane_height}"

          "#{?pane_floating_flag, "

          "#{pane_x}#,#{pane_y}#,#{pane_z}}] [history "

          "#{history_size}/#{history_limit}, "

          "#{history_bytes} bytes] #{pane_id}"

          "#{?pane_active, (active),}#{?pane_dead, (dead),}";

      break;

    }

  }

  filter = args_get(args, 'f');

  sort_crit.order = sort_order_from_string(args_get(args, 'O'));

  sort_crit.reversed = args_has(args, 'r');

  l = sort_get_panes_window(wl->window, &n, &sort_crit);

  for (i = 0; i < n; i++) {

    wp = l[i];

    ft = format_create(cmdq_get_client(item), item, FORMAT_NONE, 0);

    format_add(ft, "line", "%u", n);

    format_defaults(ft, c, s, wl, wp);

    if (filter != NULL) {

      expanded = format_expand(ft, filter);

      flag = format_true(expanded);

      free(expanded);

    } else

      flag = 1;

    if (flag) {

      line = format_expand(ft, template);

      cmdq_print(item, "%s", line);

      free(line);

    }

    format_free(ft);

  }

}