cmd.c - tmux - Rivoreo Source Code Repositories

 /* $OpenBSD$ */

 /*
  * 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.
  */

 #include <sys/types.h>
 #include <sys/time.h>

 #include <fnmatch.h>
 #include <paths.h>
 #include <pwd.h>
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>

 #include "tmux.h"

 extern const struct cmd_entry cmd_attach_session_entry;
 extern const struct cmd_entry cmd_bind_key_entry;
 extern const struct cmd_entry cmd_break_pane_entry;
 extern const struct cmd_entry cmd_capture_pane_entry;
 extern const struct cmd_entry cmd_choose_buffer_entry;
 extern const struct cmd_entry cmd_choose_client_entry;
 extern const struct cmd_entry cmd_choose_session_entry;
 extern const struct cmd_entry cmd_choose_tree_entry;
 extern const struct cmd_entry cmd_choose_window_entry;
 extern const struct cmd_entry cmd_clear_history_entry;
 extern const struct cmd_entry cmd_clock_mode_entry;
 extern const struct cmd_entry cmd_command_prompt_entry;
 extern const struct cmd_entry cmd_confirm_before_entry;
 extern const struct cmd_entry cmd_copy_mode_entry;
 extern const struct cmd_entry cmd_delete_buffer_entry;
 extern const struct cmd_entry cmd_detach_client_entry;
 extern const struct cmd_entry cmd_display_message_entry;
 extern const struct cmd_entry cmd_display_panes_entry;
 extern const struct cmd_entry cmd_down_pane_entry;
 extern const struct cmd_entry cmd_find_window_entry;
 extern const struct cmd_entry cmd_has_session_entry;
 extern const struct cmd_entry cmd_if_shell_entry;
 extern const struct cmd_entry cmd_join_pane_entry;
 extern const struct cmd_entry cmd_kill_pane_entry;
 extern const struct cmd_entry cmd_kill_server_entry;
 extern const struct cmd_entry cmd_kill_session_entry;
 extern const struct cmd_entry cmd_kill_window_entry;
 extern const struct cmd_entry cmd_last_pane_entry;
 extern const struct cmd_entry cmd_last_window_entry;
 extern const struct cmd_entry cmd_link_window_entry;
 extern const struct cmd_entry cmd_list_buffers_entry;
 extern const struct cmd_entry cmd_list_clients_entry;
 extern const struct cmd_entry cmd_list_commands_entry;
 extern const struct cmd_entry cmd_list_keys_entry;
 extern const struct cmd_entry cmd_list_panes_entry;
 extern const struct cmd_entry cmd_list_sessions_entry;
 extern const struct cmd_entry cmd_list_windows_entry;
 extern const struct cmd_entry cmd_load_buffer_entry;
 extern const struct cmd_entry cmd_lock_client_entry;
 extern const struct cmd_entry cmd_lock_server_entry;
 extern const struct cmd_entry cmd_lock_session_entry;
 extern const struct cmd_entry cmd_move_pane_entry;
 extern const struct cmd_entry cmd_move_window_entry;
 extern const struct cmd_entry cmd_new_session_entry;
 extern const struct cmd_entry cmd_new_window_entry;
 extern const struct cmd_entry cmd_next_layout_entry;
 extern const struct cmd_entry cmd_next_window_entry;
 extern const struct cmd_entry cmd_paste_buffer_entry;
 extern const struct cmd_entry cmd_pipe_pane_entry;
 extern const struct cmd_entry cmd_previous_layout_entry;
 extern const struct cmd_entry cmd_previous_window_entry;
 extern const struct cmd_entry cmd_refresh_client_entry;
 extern const struct cmd_entry cmd_rename_session_entry;
 extern const struct cmd_entry cmd_rename_window_entry;
 extern const struct cmd_entry cmd_resize_pane_entry;
 extern const struct cmd_entry cmd_respawn_pane_entry;
 extern const struct cmd_entry cmd_respawn_window_entry;
 extern const struct cmd_entry cmd_rotate_window_entry;
 extern const struct cmd_entry cmd_run_shell_entry;
 extern const struct cmd_entry cmd_save_buffer_entry;
 extern const struct cmd_entry cmd_select_layout_entry;
 extern const struct cmd_entry cmd_select_pane_entry;
 extern const struct cmd_entry cmd_select_window_entry;
 extern const struct cmd_entry cmd_send_keys_entry;
 extern const struct cmd_entry cmd_send_prefix_entry;
 extern const struct cmd_entry cmd_server_info_entry;
 extern const struct cmd_entry cmd_set_buffer_entry;
 extern const struct cmd_entry cmd_set_environment_entry;
 extern const struct cmd_entry cmd_set_hook_entry;
 extern const struct cmd_entry cmd_set_option_entry;
 extern const struct cmd_entry cmd_set_window_option_entry;
 extern const struct cmd_entry cmd_show_buffer_entry;
 extern const struct cmd_entry cmd_show_environment_entry;
 extern const struct cmd_entry cmd_show_hooks_entry;
 extern const struct cmd_entry cmd_show_messages_entry;
 extern const struct cmd_entry cmd_show_options_entry;
 extern const struct cmd_entry cmd_show_window_options_entry;
 extern const struct cmd_entry cmd_source_file_entry;
 extern const struct cmd_entry cmd_split_window_entry;
 extern const struct cmd_entry cmd_start_server_entry;
 extern const struct cmd_entry cmd_suspend_client_entry;
 extern const struct cmd_entry cmd_swap_pane_entry;
 extern const struct cmd_entry cmd_swap_window_entry;
 extern const struct cmd_entry cmd_switch_client_entry;
 extern const struct cmd_entry cmd_unbind_key_entry;
 extern const struct cmd_entry cmd_unlink_window_entry;
 extern const struct cmd_entry cmd_up_pane_entry;
 extern const struct cmd_entry cmd_wait_for_entry;

 const struct cmd_entry *cmd_table[] = {
 	&cmd_attach_session_entry,
 	&cmd_bind_key_entry,
 	&cmd_break_pane_entry,
 	&cmd_capture_pane_entry,
 	&cmd_choose_buffer_entry,
 	&cmd_choose_client_entry,
 	&cmd_choose_session_entry,
 	&cmd_choose_tree_entry,
 	&cmd_choose_window_entry,
 	&cmd_clear_history_entry,
 	&cmd_clock_mode_entry,
 	&cmd_command_prompt_entry,
 	&cmd_confirm_before_entry,
 	&cmd_copy_mode_entry,
 	&cmd_delete_buffer_entry,
 	&cmd_detach_client_entry,
 	&cmd_display_message_entry,
 	&cmd_display_panes_entry,
 	&cmd_find_window_entry,
 	&cmd_has_session_entry,
 	&cmd_if_shell_entry,
 	&cmd_join_pane_entry,
 	&cmd_kill_pane_entry,
 	&cmd_kill_server_entry,
 	&cmd_kill_session_entry,
 	&cmd_kill_window_entry,
 	&cmd_last_pane_entry,
 	&cmd_last_window_entry,
 	&cmd_link_window_entry,
 	&cmd_list_buffers_entry,
 	&cmd_list_clients_entry,
 	&cmd_list_commands_entry,
 	&cmd_list_keys_entry,
 	&cmd_list_panes_entry,
 	&cmd_list_sessions_entry,
 	&cmd_list_windows_entry,
 	&cmd_load_buffer_entry,
 	&cmd_lock_client_entry,
 	&cmd_lock_server_entry,
 	&cmd_lock_session_entry,
 	&cmd_move_pane_entry,
 	&cmd_move_window_entry,
 	&cmd_new_session_entry,
 	&cmd_new_window_entry,
 	&cmd_next_layout_entry,
 	&cmd_next_window_entry,
 	&cmd_paste_buffer_entry,
 	&cmd_pipe_pane_entry,
 	&cmd_previous_layout_entry,
 	&cmd_previous_window_entry,
 	&cmd_refresh_client_entry,
 	&cmd_rename_session_entry,
 	&cmd_rename_window_entry,
 	&cmd_resize_pane_entry,
 	&cmd_respawn_pane_entry,
 	&cmd_respawn_window_entry,
 	&cmd_rotate_window_entry,
 	&cmd_run_shell_entry,
 	&cmd_save_buffer_entry,
 	&cmd_select_layout_entry,
 	&cmd_select_pane_entry,
 	&cmd_select_window_entry,
 	&cmd_send_keys_entry,
 	&cmd_send_prefix_entry,
 	&cmd_server_info_entry,
 	&cmd_set_buffer_entry,
 	&cmd_set_environment_entry,
 	&cmd_set_hook_entry,
 	&cmd_set_option_entry,
 	&cmd_set_window_option_entry,
 	&cmd_show_buffer_entry,
 	&cmd_show_environment_entry,
 	&cmd_show_hooks_entry,
 	&cmd_show_messages_entry,
 	&cmd_show_options_entry,
 	&cmd_show_window_options_entry,
 	&cmd_source_file_entry,
 	&cmd_split_window_entry,
 	&cmd_start_server_entry,
 	&cmd_suspend_client_entry,
 	&cmd_swap_pane_entry,
 	&cmd_swap_window_entry,
 	&cmd_switch_client_entry,
 	&cmd_unbind_key_entry,
 	&cmd_unlink_window_entry,
 	&cmd_wait_for_entry,
 	NULL
 };

 int
 cmd_pack_argv(int argc, char **argv, char *buf, size_t len)
 {
 	size_t	arglen;
 	int	i;

 	if (argc == 0)
 		return (0);

 	*buf = '\0';
 	for (i = 0; i < argc; i++) {
 		if (strlcpy(buf, argv[i], len) >= len)
 			return (-1);
 		arglen = strlen(argv[i]) + 1;
 		buf += arglen;
 		len -= arglen;
 	}

 	return (0);
 }

 int
 cmd_unpack_argv(char *buf, size_t len, int argc, char ***argv)
 {
 	int	i;
 	size_t	arglen;

 	if (argc == 0)
 		return (0);
 	*argv = xcalloc(argc, sizeof **argv);

 	buf[len - 1] = '\0';
 	for (i = 0; i < argc; i++) {
 		if (len == 0) {
 			cmd_free_argv(argc, *argv);
 			return (-1);
 		}

 		arglen = strlen(buf) + 1;
 		(*argv)[i] = xstrdup(buf);
 		buf += arglen;
 		len -= arglen;
 	}

 	return (0);
 }

 char **
 cmd_copy_argv(int argc, char **argv)
 {
 	char	**new_argv;
 	int	  i;

 	if (argc == 0)
 		return (NULL);
 	new_argv = xcalloc(argc + 1, sizeof *new_argv);
 	for (i = 0; i < argc; i++) {
 		if (argv[i] != NULL)
 			new_argv[i] = xstrdup(argv[i]);
 	}
 	return (new_argv);
 }

 void
 cmd_free_argv(int argc, char **argv)
 {
 	int	i;

 	if (argc == 0)
 		return;
 	for (i = 0; i < argc; i++)
 		free(argv[i]);
 	free(argv);
 }

 char *
 cmd_stringify_argv(int argc, char **argv)
 {
 	char	*buf;
 	int	 i;
 	size_t	 len;

 	if (argc == 0)
 		return (xstrdup(""));

 	len = 0;
 	buf = NULL;

 	for (i = 0; i < argc; i++) {
 		len += strlen(argv[i]) + 1;
 		buf = xrealloc(buf, len);

 		if (i == 0)
 			*buf = '\0';
 		else
 			strlcat(buf, " ", len);
 		strlcat(buf, argv[i], len);
 	}
 	return (buf);
 }

 struct cmd *
 cmd_parse(int argc, char **argv, const char *file, u_int line, char **cause)
 {
 	const struct cmd_entry **entryp, *entry;
 	struct cmd		*cmd;
 	struct args		*args;
 	char			 s[BUFSIZ];
 	int			 ambiguous = 0;

 	*cause = NULL;
 	if (argc == 0) {
 		xasprintf(cause, "no command");
 		return (NULL);
 	}

 	entry = NULL;
 	for (entryp = cmd_table; *entryp != NULL; entryp++) {
 		if ((*entryp)->alias != NULL &&
 		    strcmp((*entryp)->alias, argv[0]) == 0) {
 			ambiguous = 0;
 			entry = *entryp;
 			break;
 		}

 		if (strncmp((*entryp)->name, argv[0], strlen(argv[0])) != 0)
 			continue;
 		if (entry != NULL)
 			ambiguous = 1;
 		entry = *entryp;

 		/* Bail now if an exact match. */
 		if (strcmp(entry->name, argv[0]) == 0)
 			break;
 	}
 	if (ambiguous)
 		goto ambiguous;
 	if (entry == NULL) {
 		xasprintf(cause, "unknown command: %s", argv[0]);
 		return (NULL);
 	}

 	args = args_parse(entry->args.template, argc, argv);
 	if (args == NULL)
 		goto usage;
 	if (entry->args.lower != -1 && args->argc < entry->args.lower)
 		goto usage;
 	if (entry->args.upper != -1 && args->argc > entry->args.upper)
 		goto usage;

 	cmd = xcalloc(1, sizeof *cmd);
 	cmd->entry = entry;
 	cmd->args = args;

 	if (file != NULL)
 		cmd->file = xstrdup(file);
 	cmd->line = line;

 	return (cmd);

 ambiguous:
 	*s = '\0';
 	for (entryp = cmd_table; *entryp != NULL; entryp++) {
 		if (strncmp((*entryp)->name, argv[0], strlen(argv[0])) != 0)
 			continue;
 		if (strlcat(s, (*entryp)->name, sizeof s) >= sizeof s)
 			break;
 		if (strlcat(s, ", ", sizeof s) >= sizeof s)
 			break;
 	}
 	s[strlen(s) - 2] = '\0';
 	xasprintf(cause, "ambiguous command: %s, could be: %s", argv[0], s);
 	return (NULL);

 usage:
 	if (args != NULL)
 		args_free(args);
 	xasprintf(cause, "usage: %s %s", entry->name, entry->usage);
 	return (NULL);
 }

 static int
 cmd_prepare_state_flag(char c, const char *target, enum cmd_entry_flag flag,
     struct cmd_q *cmdq, struct cmd_q *parent)
 {
 	int			 targetflags, error;
 	struct cmd_find_state	*fs = NULL;
 	struct cmd_find_state	*current = NULL;
 	struct cmd_find_state	 tmp;

 	if (flag == CMD_NONE ||
 	    flag == CMD_CLIENT ||
 	    flag == CMD_CLIENT_CANFAIL)
 		return (0);

 	if (c == 't')
 		fs = &cmdq->state.tflag;
 	else if (c == 's')
 		fs = &cmdq->state.sflag;

 	if (flag == CMD_SESSION_WITHPANE) {
 		if (target != NULL && target[strcspn(target, ":.")] != '\0')
 			flag = CMD_PANE;
 		else
 			flag = CMD_SESSION;
 	}

 	targetflags = 0;
 	switch (flag) {
 	case CMD_SESSION:
 	case CMD_SESSION_CANFAIL:
 	case CMD_SESSION_PREFERUNATTACHED:
 		if (flag == CMD_SESSION_CANFAIL)
 			targetflags |= CMD_FIND_QUIET;
 		if (flag == CMD_SESSION_PREFERUNATTACHED)
 			targetflags |= CMD_FIND_PREFER_UNATTACHED;
 		break;
 	case CMD_MOVEW_R:
 		flag = CMD_WINDOW_INDEX;
 		/* FALLTHROUGH */
 	case CMD_WINDOW:
 	case CMD_WINDOW_CANFAIL:
 	case CMD_WINDOW_MARKED:
 	case CMD_WINDOW_INDEX:
 		if (flag == CMD_WINDOW_CANFAIL)
 			targetflags |= CMD_FIND_QUIET;
 		if (flag == CMD_WINDOW_MARKED)
 			targetflags |= CMD_FIND_DEFAULT_MARKED;
 		if (flag == CMD_WINDOW_INDEX)
 			targetflags |= CMD_FIND_WINDOW_INDEX;
 		break;
 	case CMD_PANE:
 	case CMD_PANE_CANFAIL:
 	case CMD_PANE_MARKED:
 		if (flag == CMD_PANE_CANFAIL)
 			targetflags |= CMD_FIND_QUIET;
 		if (flag == CMD_PANE_MARKED)
 			targetflags |= CMD_FIND_DEFAULT_MARKED;
 		break;
 	default:
 		fatalx("unknown %cflag %d", c, flag);
 	}

 	log_debug("%s: flag %c %d %#x", __func__, c, flag, targetflags);
 	if (parent != NULL) {
 		if (c == 't')
 			current = &parent->state.tflag;
 		else if (c == 's')
 			current = &parent->state.sflag;
 	} else {
 		error = cmd_find_current(&tmp, cmdq, targetflags);
 		if (error != 0 && ~targetflags & CMD_FIND_QUIET)
 			return (-1);
 		current = &tmp;
 	}

 	switch (flag) {
 	case CMD_NONE:
 	case CMD_CLIENT:
 	case CMD_CLIENT_CANFAIL:
 		return (0);
 	case CMD_SESSION:
 	case CMD_SESSION_CANFAIL:
 	case CMD_SESSION_PREFERUNATTACHED:
 	case CMD_SESSION_WITHPANE:
 		error = cmd_find_target(fs, current, cmdq, target,
 		    CMD_FIND_SESSION, targetflags);
 		if (error != 0 && ~targetflags & CMD_FIND_QUIET)
 			return (-1);
 		break;
 	case CMD_MOVEW_R:
 		error = cmd_find_target(fs, current, cmdq, target,
 		    CMD_FIND_SESSION, CMD_FIND_QUIET);
 		if (error == 0)
 			break;
 		/* FALLTHROUGH */
 	case CMD_WINDOW:
 	case CMD_WINDOW_CANFAIL:
 	case CMD_WINDOW_MARKED:
 	case CMD_WINDOW_INDEX:
 		error = cmd_find_target(fs, current, cmdq, target,
 		    CMD_FIND_WINDOW, targetflags);
 		if (error != 0 && ~targetflags & CMD_FIND_QUIET)
 			return (-1);
 		break;
 	case CMD_PANE:
 	case CMD_PANE_CANFAIL:
 	case CMD_PANE_MARKED:
 		error = cmd_find_target(fs, current, cmdq, target,
 		    CMD_FIND_PANE, targetflags);
 		if (error != 0 && ~targetflags & CMD_FIND_QUIET)
 			return (-1);
 		break;
 	default:
 		fatalx("unknown %cflag %d", c, flag);
 	}
 	return (0);
 }

 int
 cmd_prepare_state(struct cmd *cmd, struct cmd_q *cmdq, struct cmd_q *parent)
 {
 	const struct cmd_entry		*entry = cmd->entry;
 	struct cmd_state		*state = &cmdq->state;
 	char				*tmp;
 	enum cmd_entry_flag		 flag;
 	const char			*s;
 	int				 error;

 	tmp = cmd_print(cmd);
 	log_debug("preparing state for %s (client %p)", tmp, cmdq->client);
 	free(tmp);

 	state->c = NULL;
 	cmd_find_clear_state(&state->tflag, NULL, 0);
 	cmd_find_clear_state(&state->sflag, NULL, 0);

 	flag = cmd->entry->cflag;
 	if (flag == CMD_NONE) {
 		flag = cmd->entry->tflag;
 		if (flag == CMD_CLIENT || flag == CMD_CLIENT_CANFAIL)
 			s = args_get(cmd->args, 't');
 		else
 			s = NULL;
 	} else
 		s = args_get(cmd->args, 'c');
 	switch (flag) {
 	case CMD_CLIENT:
 		state->c = cmd_find_client(cmdq, s, 0);
 		if (state->c == NULL)
 			return (-1);
 		break;
 	default:
 		state->c = cmd_find_client(cmdq, s, 1);
 		break;
 	}

 	s = args_get(cmd->args, 't');
 	log_debug("preparing -t state: target %s", s == NULL ? "none" : s);

 	error = cmd_prepare_state_flag('t', s, entry->tflag, cmdq, parent);
 	if (error != 0)
 		return (error);

 	s = args_get(cmd->args, 's');
 	log_debug("preparing -s state: target %s", s == NULL ? "none" : s);

 	error = cmd_prepare_state_flag('s', s, entry->sflag, cmdq, parent);
 	if (error != 0)
 		return (error);

 	return (0);
 }

 char *
 cmd_print(struct cmd *cmd)
 {
 	char	*out, *s;

 	s = args_print(cmd->args);
 	if (*s != '\0')
 		xasprintf(&out, "%s %s", cmd->entry->name, s);
 	else
 		out = xstrdup(cmd->entry->name);
 	free(s);

 	return (out);
 }

 /* Adjust current mouse position for a pane. */
 int
 cmd_mouse_at(struct window_pane *wp, struct mouse_event *m, u_int *xp,
     u_int *yp, int last)
 {
 	u_int	x, y;

 	if (last) {
 		x = m->lx;
 		y = m->ly;
 	} else {
 		x = m->x;
 		y = m->y;
 	}

 	if (m->statusat == 0 && y > 0)
 		y--;
 	else if (m->statusat > 0 && y >= (u_int)m->statusat)
 		y = m->statusat - 1;

 	if (x < wp->xoff || x >= wp->xoff + wp->sx)
 		return (-1);
 	if (y < wp->yoff || y >= wp->yoff + wp->sy)
 		return (-1);

 	*xp = x - wp->xoff;
 	*yp = y - wp->yoff;
 	return (0);
 }

 /* Get current mouse window if any. */
 struct winlink *
 cmd_mouse_window(struct mouse_event *m, struct session **sp)
 {
 	struct session	*s;
 	struct window	*w;

 	if (!m->valid || m->s == -1 || m->w == -1)
 		return (NULL);
 	if ((s = session_find_by_id(m->s)) == NULL)
 		return (NULL);
 	if ((w = window_find_by_id(m->w)) == NULL)
 		return (NULL);

 	if (sp != NULL)
 		*sp = s;
 	return (winlink_find_by_window(&s->windows, w));
 }

 /* Get current mouse pane if any. */
 struct window_pane *
 cmd_mouse_pane(struct mouse_event *m, struct session **sp,
     struct winlink **wlp)
 {
 	struct winlink		*wl;
 	struct window_pane     	*wp;

 	if ((wl = cmd_mouse_window(m, sp)) == NULL)
 		return (NULL);
 	if ((wp = window_pane_find_by_id(m->wp)) == NULL)
 		return (NULL);
 	if (!window_has_pane(wl->window, wp))
 		return (NULL);

 	if (wlp != NULL)
 		*wlp = wl;
 	return (wp);
 }

 /* Replace the first %% or %idx in template by s. */
 char *
 cmd_template_replace(const char *template, const char *s, int idx)
 {
 	char		 ch, *buf;
 	const char	*ptr;
 	int		 replaced;
 	size_t		 len;

 	if (strchr(template, '%') == NULL)
 		return (xstrdup(template));

 	buf = xmalloc(1);
 	*buf = '\0';
 	len = 0;
 	replaced = 0;

 	ptr = template;
 	while (*ptr != '\0') {
 		switch (ch = *ptr++) {
 		case '%':
 			if (*ptr < '1' || *ptr > '9' || *ptr - '0' != idx) {
 				if (*ptr != '%' || replaced)
 					break;
 				replaced = 1;
 			}
 			ptr++;

 			len += strlen(s);
 			buf = xrealloc(buf, len + 1);
 			strlcat(buf, s, len + 1);
 			continue;
 		}
 		buf = xrealloc(buf, len + 2);
 		buf[len++] = ch;
 		buf[len] = '\0';
 	}

 	return (buf);
 }
	/* $OpenBSD$ */

	/*
	* 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.
	*/

	#include <sys/types.h>
	#include <sys/time.h>

	#include <fnmatch.h>
	#include <paths.h>
	#include <pwd.h>
	#include <stdlib.h>
	#include <string.h>
	#include <unistd.h>

	#include "tmux.h"

	extern const struct cmd_entry cmd_attach_session_entry;
	extern const struct cmd_entry cmd_bind_key_entry;
	extern const struct cmd_entry cmd_break_pane_entry;
	extern const struct cmd_entry cmd_capture_pane_entry;
	extern const struct cmd_entry cmd_choose_buffer_entry;
	extern const struct cmd_entry cmd_choose_client_entry;
	extern const struct cmd_entry cmd_choose_session_entry;
	extern const struct cmd_entry cmd_choose_tree_entry;
	extern const struct cmd_entry cmd_choose_window_entry;
	extern const struct cmd_entry cmd_clear_history_entry;
	extern const struct cmd_entry cmd_clock_mode_entry;
	extern const struct cmd_entry cmd_command_prompt_entry;
	extern const struct cmd_entry cmd_confirm_before_entry;
	extern const struct cmd_entry cmd_copy_mode_entry;
	extern const struct cmd_entry cmd_delete_buffer_entry;
	extern const struct cmd_entry cmd_detach_client_entry;
	extern const struct cmd_entry cmd_display_message_entry;
	extern const struct cmd_entry cmd_display_panes_entry;
	extern const struct cmd_entry cmd_down_pane_entry;
	extern const struct cmd_entry cmd_find_window_entry;
	extern const struct cmd_entry cmd_has_session_entry;
	extern const struct cmd_entry cmd_if_shell_entry;
	extern const struct cmd_entry cmd_join_pane_entry;
	extern const struct cmd_entry cmd_kill_pane_entry;
	extern const struct cmd_entry cmd_kill_server_entry;
	extern const struct cmd_entry cmd_kill_session_entry;
	extern const struct cmd_entry cmd_kill_window_entry;
	extern const struct cmd_entry cmd_last_pane_entry;
	extern const struct cmd_entry cmd_last_window_entry;
	extern const struct cmd_entry cmd_link_window_entry;
	extern const struct cmd_entry cmd_list_buffers_entry;
	extern const struct cmd_entry cmd_list_clients_entry;
	extern const struct cmd_entry cmd_list_commands_entry;
	extern const struct cmd_entry cmd_list_keys_entry;
	extern const struct cmd_entry cmd_list_panes_entry;
	extern const struct cmd_entry cmd_list_sessions_entry;
	extern const struct cmd_entry cmd_list_windows_entry;
	extern const struct cmd_entry cmd_load_buffer_entry;
	extern const struct cmd_entry cmd_lock_client_entry;
	extern const struct cmd_entry cmd_lock_server_entry;
	extern const struct cmd_entry cmd_lock_session_entry;
	extern const struct cmd_entry cmd_move_pane_entry;
	extern const struct cmd_entry cmd_move_window_entry;
	extern const struct cmd_entry cmd_new_session_entry;
	extern const struct cmd_entry cmd_new_window_entry;
	extern const struct cmd_entry cmd_next_layout_entry;
	extern const struct cmd_entry cmd_next_window_entry;
	extern const struct cmd_entry cmd_paste_buffer_entry;
	extern const struct cmd_entry cmd_pipe_pane_entry;
	extern const struct cmd_entry cmd_previous_layout_entry;
	extern const struct cmd_entry cmd_previous_window_entry;
	extern const struct cmd_entry cmd_refresh_client_entry;
	extern const struct cmd_entry cmd_rename_session_entry;
	extern const struct cmd_entry cmd_rename_window_entry;
	extern const struct cmd_entry cmd_resize_pane_entry;
	extern const struct cmd_entry cmd_respawn_pane_entry;
	extern const struct cmd_entry cmd_respawn_window_entry;
	extern const struct cmd_entry cmd_rotate_window_entry;
	extern const struct cmd_entry cmd_run_shell_entry;
	extern const struct cmd_entry cmd_save_buffer_entry;
	extern const struct cmd_entry cmd_select_layout_entry;
	extern const struct cmd_entry cmd_select_pane_entry;
	extern const struct cmd_entry cmd_select_window_entry;
	extern const struct cmd_entry cmd_send_keys_entry;
	extern const struct cmd_entry cmd_send_prefix_entry;
	extern const struct cmd_entry cmd_server_info_entry;
	extern const struct cmd_entry cmd_set_buffer_entry;
	extern const struct cmd_entry cmd_set_environment_entry;
	extern const struct cmd_entry cmd_set_hook_entry;
	extern const struct cmd_entry cmd_set_option_entry;
	extern const struct cmd_entry cmd_set_window_option_entry;
	extern const struct cmd_entry cmd_show_buffer_entry;
	extern const struct cmd_entry cmd_show_environment_entry;
	extern const struct cmd_entry cmd_show_hooks_entry;
	extern const struct cmd_entry cmd_show_messages_entry;
	extern const struct cmd_entry cmd_show_options_entry;
	extern const struct cmd_entry cmd_show_window_options_entry;
	extern const struct cmd_entry cmd_source_file_entry;
	extern const struct cmd_entry cmd_split_window_entry;
	extern const struct cmd_entry cmd_start_server_entry;
	extern const struct cmd_entry cmd_suspend_client_entry;
	extern const struct cmd_entry cmd_swap_pane_entry;
	extern const struct cmd_entry cmd_swap_window_entry;
	extern const struct cmd_entry cmd_switch_client_entry;
	extern const struct cmd_entry cmd_unbind_key_entry;
	extern const struct cmd_entry cmd_unlink_window_entry;
	extern const struct cmd_entry cmd_up_pane_entry;
	extern const struct cmd_entry cmd_wait_for_entry;

	const struct cmd_entry *cmd_table[] = {
	&cmd_attach_session_entry,
	&cmd_bind_key_entry,
	&cmd_break_pane_entry,
	&cmd_capture_pane_entry,
	&cmd_choose_buffer_entry,
	&cmd_choose_client_entry,
	&cmd_choose_session_entry,
	&cmd_choose_tree_entry,
	&cmd_choose_window_entry,
	&cmd_clear_history_entry,
	&cmd_clock_mode_entry,
	&cmd_command_prompt_entry,
	&cmd_confirm_before_entry,
	&cmd_copy_mode_entry,
	&cmd_delete_buffer_entry,
	&cmd_detach_client_entry,
	&cmd_display_message_entry,
	&cmd_display_panes_entry,
	&cmd_find_window_entry,
	&cmd_has_session_entry,
	&cmd_if_shell_entry,
	&cmd_join_pane_entry,
	&cmd_kill_pane_entry,
	&cmd_kill_server_entry,
	&cmd_kill_session_entry,
	&cmd_kill_window_entry,
	&cmd_last_pane_entry,
	&cmd_last_window_entry,
	&cmd_link_window_entry,
	&cmd_list_buffers_entry,
	&cmd_list_clients_entry,
	&cmd_list_commands_entry,
	&cmd_list_keys_entry,
	&cmd_list_panes_entry,
	&cmd_list_sessions_entry,
	&cmd_list_windows_entry,
	&cmd_load_buffer_entry,
	&cmd_lock_client_entry,
	&cmd_lock_server_entry,
	&cmd_lock_session_entry,
	&cmd_move_pane_entry,
	&cmd_move_window_entry,
	&cmd_new_session_entry,
	&cmd_new_window_entry,
	&cmd_next_layout_entry,
	&cmd_next_window_entry,
	&cmd_paste_buffer_entry,
	&cmd_pipe_pane_entry,
	&cmd_previous_layout_entry,
	&cmd_previous_window_entry,
	&cmd_refresh_client_entry,
	&cmd_rename_session_entry,
	&cmd_rename_window_entry,
	&cmd_resize_pane_entry,
	&cmd_respawn_pane_entry,
	&cmd_respawn_window_entry,
	&cmd_rotate_window_entry,
	&cmd_run_shell_entry,
	&cmd_save_buffer_entry,
	&cmd_select_layout_entry,
	&cmd_select_pane_entry,
	&cmd_select_window_entry,
	&cmd_send_keys_entry,
	&cmd_send_prefix_entry,
	&cmd_server_info_entry,
	&cmd_set_buffer_entry,
	&cmd_set_environment_entry,
	&cmd_set_hook_entry,
	&cmd_set_option_entry,
	&cmd_set_window_option_entry,
	&cmd_show_buffer_entry,
	&cmd_show_environment_entry,
	&cmd_show_hooks_entry,
	&cmd_show_messages_entry,
	&cmd_show_options_entry,
	&cmd_show_window_options_entry,
	&cmd_source_file_entry,
	&cmd_split_window_entry,
	&cmd_start_server_entry,
	&cmd_suspend_client_entry,
	&cmd_swap_pane_entry,
	&cmd_swap_window_entry,
	&cmd_switch_client_entry,
	&cmd_unbind_key_entry,
	&cmd_unlink_window_entry,
	&cmd_wait_for_entry,
	NULL
	};

	int
	cmd_pack_argv(int argc, char *argv, char buf, size_t len)
	{
	size_t arglen;
	int i;

	if (argc == 0)
	return (0);

	*buf = '\0';
	for (i = 0; i < argc; i++) {
	if (strlcpy(buf, argv[i], len) >= len)
	return (-1);
	arglen = strlen(argv[i]) + 1;
	buf += arglen;
	len -= arglen;
	}

	return (0);
	}

	int
	cmd_unpack_argv(char buf, size_t len, int argc, char **argv)
	{
	int i;
	size_t arglen;

	if (argc == 0)
	return (0);
	argv = xcalloc(argc, sizeof *argv);

	buf[len - 1] = '\0';
	for (i = 0; i < argc; i++) {
	if (len == 0) {
	cmd_free_argv(argc, *argv);
	return (-1);
	}

	arglen = strlen(buf) + 1;
	(*argv)[i] = xstrdup(buf);
	buf += arglen;
	len -= arglen;
	}

	return (0);
	}

	char **
	cmd_copy_argv(int argc, char **argv)
	{
	char **new_argv;
	int i;

	if (argc == 0)
	return (NULL);
	new_argv = xcalloc(argc + 1, sizeof *new_argv);
	for (i = 0; i < argc; i++) {
	if (argv[i] != NULL)
	new_argv[i] = xstrdup(argv[i]);
	}
	return (new_argv);
	}

	void
	cmd_free_argv(int argc, char **argv)
	{
	int i;

	if (argc == 0)
	return;
	for (i = 0; i < argc; i++)
	free(argv[i]);
	free(argv);
	}

	char *
	cmd_stringify_argv(int argc, char **argv)
	{
	char *buf;
	int i;
	size_t len;

	if (argc == 0)
	return (xstrdup(""));

	len = 0;
	buf = NULL;

	for (i = 0; i < argc; i++) {
	len += strlen(argv[i]) + 1;
	buf = xrealloc(buf, len);

	if (i == 0)
	*buf = '\0';
	else
	strlcat(buf, " ", len);
	strlcat(buf, argv[i], len);
	}
	return (buf);
	}

	struct cmd *
	cmd_parse(int argc, char *argv, const char file, u_int line, char **cause)
	{
	const struct cmd_entry *entryp, entry;
	struct cmd *cmd;
	struct args *args;
	char s[BUFSIZ];
	int ambiguous = 0;

	*cause = NULL;
	if (argc == 0) {
	xasprintf(cause, "no command");
	return (NULL);
	}

	entry = NULL;
	for (entryp = cmd_table; *entryp != NULL; entryp++) {
	if ((*entryp)->alias != NULL &&
	strcmp((*entryp)->alias, argv[0]) == 0) {
	ambiguous = 0;
	entry = *entryp;
	break;
	}

	if (strncmp((*entryp)->name, argv[0], strlen(argv[0])) != 0)
	continue;
	if (entry != NULL)
	ambiguous = 1;
	entry = *entryp;

	/* Bail now if an exact match. */
	if (strcmp(entry->name, argv[0]) == 0)
	break;
	}
	if (ambiguous)
	goto ambiguous;
	if (entry == NULL) {
	xasprintf(cause, "unknown command: %s", argv[0]);
	return (NULL);
	}

	args = args_parse(entry->args.template, argc, argv);
	if (args == NULL)
	goto usage;
	if (entry->args.lower != -1 && args->argc < entry->args.lower)
	goto usage;
	if (entry->args.upper != -1 && args->argc > entry->args.upper)
	goto usage;

	cmd = xcalloc(1, sizeof *cmd);
	cmd->entry = entry;
	cmd->args = args;

	if (file != NULL)
	cmd->file = xstrdup(file);
	cmd->line = line;

	return (cmd);

	ambiguous:
	*s = '\0';
	for (entryp = cmd_table; *entryp != NULL; entryp++) {
	if (strncmp((*entryp)->name, argv[0], strlen(argv[0])) != 0)
	continue;
	if (strlcat(s, (*entryp)->name, sizeof s) >= sizeof s)
	break;
	if (strlcat(s, ", ", sizeof s) >= sizeof s)
	break;
	}
	s[strlen(s) - 2] = '\0';
	xasprintf(cause, "ambiguous command: %s, could be: %s", argv[0], s);
	return (NULL);

	usage:
	if (args != NULL)
	args_free(args);
	xasprintf(cause, "usage: %s %s", entry->name, entry->usage);
	return (NULL);
	}

	static int
	cmd_prepare_state_flag(char c, const char *target, enum cmd_entry_flag flag,
	struct cmd_q cmdq, struct cmd_q parent)
	{
	int targetflags, error;
	struct cmd_find_state *fs = NULL;
	struct cmd_find_state *current = NULL;
	struct cmd_find_state tmp;

	if (flag == CMD_NONE \|\|
	flag == CMD_CLIENT \|\|
	flag == CMD_CLIENT_CANFAIL)
	return (0);

	if (c == 't')
	fs = &cmdq->state.tflag;
	else if (c == 's')
	fs = &cmdq->state.sflag;

	if (flag == CMD_SESSION_WITHPANE) {
	if (target != NULL && target[strcspn(target, ":.")] != '\0')
	flag = CMD_PANE;
	else
	flag = CMD_SESSION;
	}

	targetflags = 0;
	switch (flag) {
	case CMD_SESSION:
	case CMD_SESSION_CANFAIL:
	case CMD_SESSION_PREFERUNATTACHED:
	if (flag == CMD_SESSION_CANFAIL)
	targetflags \|= CMD_FIND_QUIET;
	if (flag == CMD_SESSION_PREFERUNATTACHED)
	targetflags \|= CMD_FIND_PREFER_UNATTACHED;
	break;
	case CMD_MOVEW_R:
	flag = CMD_WINDOW_INDEX;
	/* FALLTHROUGH */
	case CMD_WINDOW:
	case CMD_WINDOW_CANFAIL:
	case CMD_WINDOW_MARKED:
	case CMD_WINDOW_INDEX:
	if (flag == CMD_WINDOW_CANFAIL)
	targetflags \|= CMD_FIND_QUIET;
	if (flag == CMD_WINDOW_MARKED)
	targetflags \|= CMD_FIND_DEFAULT_MARKED;
	if (flag == CMD_WINDOW_INDEX)
	targetflags \|= CMD_FIND_WINDOW_INDEX;
	break;
	case CMD_PANE:
	case CMD_PANE_CANFAIL:
	case CMD_PANE_MARKED:
	if (flag == CMD_PANE_CANFAIL)
	targetflags \|= CMD_FIND_QUIET;
	if (flag == CMD_PANE_MARKED)
	targetflags \|= CMD_FIND_DEFAULT_MARKED;
	break;
	default:
	fatalx("unknown %cflag %d", c, flag);
	}

	log_debug("%s: flag %c %d %#x", __func__, c, flag, targetflags);
	if (parent != NULL) {
	if (c == 't')
	current = &parent->state.tflag;
	else if (c == 's')
	current = &parent->state.sflag;
	} else {
	error = cmd_find_current(&tmp, cmdq, targetflags);
	if (error != 0 && ~targetflags & CMD_FIND_QUIET)
	return (-1);
	current = &tmp;
	}

	switch (flag) {
	case CMD_NONE:
	case CMD_CLIENT:
	case CMD_CLIENT_CANFAIL:
	return (0);
	case CMD_SESSION:
	case CMD_SESSION_CANFAIL:
	case CMD_SESSION_PREFERUNATTACHED:
	case CMD_SESSION_WITHPANE:
	error = cmd_find_target(fs, current, cmdq, target,
	CMD_FIND_SESSION, targetflags);
	if (error != 0 && ~targetflags & CMD_FIND_QUIET)
	return (-1);
	break;
	case CMD_MOVEW_R:
	error = cmd_find_target(fs, current, cmdq, target,
	CMD_FIND_SESSION, CMD_FIND_QUIET);
	if (error == 0)
	break;
	/* FALLTHROUGH */
	case CMD_WINDOW:
	case CMD_WINDOW_CANFAIL:
	case CMD_WINDOW_MARKED:
	case CMD_WINDOW_INDEX:
	error = cmd_find_target(fs, current, cmdq, target,
	CMD_FIND_WINDOW, targetflags);
	if (error != 0 && ~targetflags & CMD_FIND_QUIET)
	return (-1);
	break;
	case CMD_PANE:
	case CMD_PANE_CANFAIL:
	case CMD_PANE_MARKED:
	error = cmd_find_target(fs, current, cmdq, target,
	CMD_FIND_PANE, targetflags);
	if (error != 0 && ~targetflags & CMD_FIND_QUIET)
	return (-1);
	break;
	default:
	fatalx("unknown %cflag %d", c, flag);
	}
	return (0);
	}

	int
	cmd_prepare_state(struct cmd cmd, struct cmd_q cmdq, struct cmd_q *parent)
	{
	const struct cmd_entry *entry = cmd->entry;
	struct cmd_state *state = &cmdq->state;
	char *tmp;
	enum cmd_entry_flag flag;
	const char *s;
	int error;

	tmp = cmd_print(cmd);
	log_debug("preparing state for %s (client %p)", tmp, cmdq->client);
	free(tmp);

	state->c = NULL;
	cmd_find_clear_state(&state->tflag, NULL, 0);
	cmd_find_clear_state(&state->sflag, NULL, 0);

	flag = cmd->entry->cflag;
	if (flag == CMD_NONE) {
	flag = cmd->entry->tflag;
	if (flag == CMD_CLIENT \|\| flag == CMD_CLIENT_CANFAIL)
	s = args_get(cmd->args, 't');
	else
	s = NULL;
	} else
	s = args_get(cmd->args, 'c');
	switch (flag) {
	case CMD_CLIENT:
	state->c = cmd_find_client(cmdq, s, 0);
	if (state->c == NULL)
	return (-1);
	break;
	default:
	state->c = cmd_find_client(cmdq, s, 1);
	break;
	}

	s = args_get(cmd->args, 't');
	log_debug("preparing -t state: target %s", s == NULL ? "none" : s);

	error = cmd_prepare_state_flag('t', s, entry->tflag, cmdq, parent);
	if (error != 0)
	return (error);

	s = args_get(cmd->args, 's');
	log_debug("preparing -s state: target %s", s == NULL ? "none" : s);

	error = cmd_prepare_state_flag('s', s, entry->sflag, cmdq, parent);
	if (error != 0)
	return (error);

	return (0);
	}

	char *
	cmd_print(struct cmd *cmd)
	{
	char out, s;

	s = args_print(cmd->args);
	if (*s != '\0')
	xasprintf(&out, "%s %s", cmd->entry->name, s);
	else
	out = xstrdup(cmd->entry->name);
	free(s);

	return (out);
	}

	/* Adjust current mouse position for a pane. */
	int
	cmd_mouse_at(struct window_pane wp, struct mouse_event m, u_int *xp,
	u_int *yp, int last)
	{
	u_int x, y;

	if (last) {
	x = m->lx;
	y = m->ly;
	} else {
	x = m->x;
	y = m->y;
	}

	if (m->statusat == 0 && y > 0)
	y--;
	else if (m->statusat > 0 && y >= (u_int)m->statusat)
	y = m->statusat - 1;

	if (x < wp->xoff \|\| x >= wp->xoff + wp->sx)
	return (-1);
	if (y < wp->yoff \|\| y >= wp->yoff + wp->sy)
	return (-1);

	*xp = x - wp->xoff;
	*yp = y - wp->yoff;
	return (0);
	}

	/* Get current mouse window if any. */
	struct winlink *
	cmd_mouse_window(struct mouse_event m, struct session *sp)
	{
	struct session *s;
	struct window *w;

	if (!m->valid \|\| m->s == -1 \|\| m->w == -1)
	return (NULL);
	if ((s = session_find_by_id(m->s)) == NULL)
	return (NULL);
	if ((w = window_find_by_id(m->w)) == NULL)
	return (NULL);

	if (sp != NULL)
	*sp = s;
	return (winlink_find_by_window(&s->windows, w));
	}

	/* Get current mouse pane if any. */
	struct window_pane *
	cmd_mouse_pane(struct mouse_event m, struct session *sp,
	struct winlink **wlp)
	{
	struct winlink *wl;
	struct window_pane *wp;

	if ((wl = cmd_mouse_window(m, sp)) == NULL)
	return (NULL);
	if ((wp = window_pane_find_by_id(m->wp)) == NULL)
	return (NULL);
	if (!window_has_pane(wl->window, wp))
	return (NULL);

	if (wlp != NULL)
	*wlp = wl;
	return (wp);
	}

	/* Replace the first %% or %idx in template by s. */
	char *
	cmd_template_replace(const char template, const char s, int idx)
	{
	char ch, *buf;
	const char *ptr;
	int replaced;
	size_t len;

	if (strchr(template, '%') == NULL)
	return (xstrdup(template));

	buf = xmalloc(1);
	*buf = '\0';
	len = 0;
	replaced = 0;

	ptr = template;
	while (*ptr != '\0') {
	switch (ch = *ptr++) {
	case '%':
	if (ptr < '1' \|\| ptr > '9' \|\| *ptr - '0' != idx) {
	if (*ptr != '%' \|\| replaced)
	break;
	replaced = 1;
	}
	ptr++;

	len += strlen(s);
	buf = xrealloc(buf, len + 1);
	strlcat(buf, s, len + 1);
	continue;
	}
	buf = xrealloc(buf, len + 2);
	buf[len++] = ch;
	buf[len] = '\0';
	}

	return (buf);
	}