tmux/cmd-hide-pane.c

/* $OpenBSD$ */

/*
 * Copyright (c) 2026 Michael Grant <mgrant@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 <string.h>

#include "tmux.h"

/*
 * Hide or show panes.
 */

static enum cmd_retval cmd_hide_pane_exec(struct cmd *, struct cmdq_item *);
static enum cmd_retval cmd_show_pane_exec(struct cmd *, struct cmdq_item *);

const struct cmd_entry cmd_hide_pane_entry = {
	.name = "hide-pane",
	.alias = "hidep",

	.args = { "at:", 0, 1, NULL },
	.usage = "[-a] " CMD_TARGET_PANE_USAGE,

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

	.flags = CMD_AFTERHOOK,
	.exec = cmd_hide_pane_exec
};

const struct cmd_entry cmd_show_pane_entry = {
	.name = "show-pane",
	.alias = "showp",

	.args = { "at:", 0, 1, NULL },
	.usage = "[-a] " CMD_TARGET_PANE_USAGE,

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

	.flags = CMD_AFTERHOOK,
	.exec = cmd_show_pane_exec
};

static enum cmd_retval
cmd_hide_pane_hide(struct window *w, struct window_pane *wp)
{
	struct window_pane	*wpp = NULL;
	struct layout_cell	*lc = wp->layout_cell;

	if (window_pane_is_hidden(wp))
		return (CMD_RETURN_NORMAL);

	if (wp == w->active) {
		/* Find previous active pane. */
		TAILQ_FOREACH(wpp, &w->last_panes, sentry) {
			if (wpp != wp && window_pane_is_visible(wpp))
				break;
		}
		if (wpp == NULL) {
			TAILQ_FOREACH(wpp, &w->z_index, zentry) {
				if (wpp != wp &&
				    window_pane_is_visible(wpp))
					break;
			}
		}
	}

	lc->flags |= LAYOUT_CELL_HIDDEN;

	layout_remove_tile(w, lc);
	layout_fix_offsets(w);
	layout_fix_panes(w, NULL);

	window_pane_stack_remove(&w->last_panes, wp);
	if (wpp != NULL) {
		window_set_active_pane(w, wpp, 1);
	} else if (wp == w->active) {
		/* No visible previous active pane; null active pane
		 * to show dots background. */
		w->active = NULL;
		if (options_get_number(global_options, "focus-events"))
			window_pane_update_focus(wp);
		notify_window("window-pane-changed", w);
		notify_window("window-layout-changed", w);
		server_redraw_window(w);
	} else {
		notify_window("window-layout-changed", w);
		server_redraw_window(w);
	}

	return (CMD_RETURN_NORMAL);
}

static enum cmd_retval
cmd_hide_pane_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 winlink		*wl = target->wl;
	struct window		*w = wl->window;
	struct window_pane	*wp, *active_pane = w->active;
	u_int			 id;
	char			*cause = NULL;
	enum cmd_retval		 rv;

	window_unzoom(w, 1);

	if (args_has(args, 'a')) {
		TAILQ_FOREACH(wp, &w->z_index, zentry) {
			if (!window_pane_is_visible(wp) || wp == active_pane)
				continue;
			rv = cmd_hide_pane_hide(w, wp);
			if (rv != CMD_RETURN_NORMAL)
				return (rv);
		}
		return (CMD_RETURN_NORMAL);
	} else {
		wp = target->wp;
		if (wp == NULL) {
			id = args_strtonum_and_expand(args, 't', 0, INT_MAX,
			    item, &cause);
			if (cause != NULL) {
				cmdq_error(item, "%s target pane", cause);
				return (CMD_RETURN_ERROR);
			}
			wp = window_pane_find_by_id(id);
		}
		if (wp == NULL) {
			cmdq_error(item, "No target pane to hide.");
			return (CMD_RETURN_ERROR);
		}
		return (cmd_hide_pane_hide(w, wp));
	}
}

static enum cmd_retval
cmd_hide_pane_show(struct window *w, struct window_pane *wp)
{
	struct layout_cell	*lc = wp->layout_cell;

	if (!window_pane_is_hidden(wp))
		return (CMD_RETURN_NORMAL);

	lc->flags &= ~LAYOUT_CELL_HIDDEN;

	layout_insert_tile(w, lc);
	layout_fix_offsets(w);
	layout_fix_panes(w, NULL);

	window_set_active_pane(w, wp, 1);

	notify_window("window-layout-changed", w);
	server_redraw_window(w);

	return (CMD_RETURN_NORMAL);
}

static enum cmd_retval
cmd_show_pane_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 winlink		*wl = target->wl;
	struct window		*w = wl->window;
	struct window_pane	*wp;
	u_int			 id;
	char			*cause = NULL;
	enum cmd_retval		 rv;

	window_unzoom(w, 1);

	if (args_has(args, 'a')) {
		TAILQ_FOREACH(wp, &w->z_index, zentry) {
			if (!window_pane_is_visible(wp))
				continue;
			rv = cmd_hide_pane_show(w, wp);
			if (rv != CMD_RETURN_NORMAL)
				return (rv);
		}
		return (CMD_RETURN_NORMAL);
	} else {
		wp = target->wp;
		if (wp == NULL) {
			id = args_strtonum_and_expand(args, 't', 0, INT_MAX,
			    item, &cause);
			if (cause != NULL) {
				cmdq_error(item, "%s target pane", cause);
				return (CMD_RETURN_ERROR);
			}
			wp = window_pane_find_by_id(id);
		}
		if (wp == NULL) {
			cmdq_error(item, "No target pane to show.");
			return (CMD_RETURN_ERROR);
		}
		return (cmd_hide_pane_show(w, wp));
	}
}